1 | %% ****** Start of file authguide.tex ****** % |
---|
2 | %% |
---|
3 | %% This file is part of the APS files in the REVTeX 4 distribution. |
---|
4 | %% Version 4.0 of REVTeX, August, 2001 |
---|
5 | %% |
---|
6 | %% Copyright (c) 2000,2001 The American Physical Society. |
---|
7 | %% |
---|
8 | %% See the REVTeX 4 README file for restrictions and more information. |
---|
9 | %% |
---|
10 | \listfiles |
---|
11 | \documentclass[% |
---|
12 | %prl% |
---|
13 | %,preprint% |
---|
14 | ,twocolumn% |
---|
15 | ,secnumarabic% |
---|
16 | %,tightenlines% |
---|
17 | ,amssymb, amsmath,nobibnotes, aps, prl]{revtex4} |
---|
18 | %\usepackage{acrofont}%NOTE: Comment out this line for the release version! |
---|
19 | \usepackage{docs}% |
---|
20 | \usepackage{bm}% |
---|
21 | %\usepackage[colorlinks=true,linkcolor=blue]{hyperref}% |
---|
22 | %\nofiles |
---|
23 | \expandafter\ifx\csname package@font\endcsname\relax\else |
---|
24 | \expandafter\expandafter |
---|
25 | \expandafter\usepackage |
---|
26 | \expandafter\expandafter |
---|
27 | \expandafter{\csname package@font\endcsname}% |
---|
28 | \fi |
---|
29 | |
---|
30 | \begin{document} |
---|
31 | |
---|
32 | \title{\revtex~4 Author's Guide}% |
---|
33 | |
---|
34 | \author{American Physical Society}% |
---|
35 | \email{revtex@aps.org} |
---|
36 | \affiliation{1 Research Road, Ridge, NY 11961} |
---|
37 | \date{August 2001}% |
---|
38 | \maketitle |
---|
39 | \tableofcontents |
---|
40 | |
---|
41 | \section{Introduction} |
---|
42 | |
---|
43 | This is the author's guide to \revtex~4, the preferred submission |
---|
44 | format for all APS journals. This guide is intended to be a concise |
---|
45 | introduction to \revtex~4. The documentation has been separated out |
---|
46 | into smaller units to make it easier to locate essential |
---|
47 | information. |
---|
48 | |
---|
49 | The following documentation is also part of the APS \revtex~4 |
---|
50 | distribution. Updated versions of these will be maintained at |
---|
51 | the \revtex~4 homepage located at \url{http://publish.aps.org/revtex4/}. |
---|
52 | \begin{itemize} |
---|
53 | \item \textit{APS Compuscript Guide for \revtex~4} |
---|
54 | \item \textit{\revtex~4 Command and Options Summary} |
---|
55 | \item \textit{\revtex~4 Bib\TeX\ Guide} |
---|
56 | \item \textit{Differences between \revtex~4 and \revtex~3} |
---|
57 | \end{itemize} |
---|
58 | This guide assumes a working \revtex~4 |
---|
59 | installation. Please see the installation guide included with the |
---|
60 | distribution. |
---|
61 | |
---|
62 | The \revtex\ system for \LaTeX\ began its development in 1986 and has |
---|
63 | gone through three major revisions since then. All versions prior to |
---|
64 | \revtex~4 were based on \LaTeX2.09 and, until now, \revtex\ did not |
---|
65 | keep pace with the advances of the \LaTeX\ community and thus became |
---|
66 | inconvenient to work with. \revtex~4 is designed to remedy this by |
---|
67 | incorporating the following design goals: |
---|
68 | |
---|
69 | \begin{itemize} |
---|
70 | \item |
---|
71 | Make \revtex\ fully compatible with \LaTeXe; it is now a \LaTeXe\ |
---|
72 | document class, similar in function to the standard |
---|
73 | \classname{article} class. |
---|
74 | |
---|
75 | \item |
---|
76 | Rely on standard \LaTeXe\ packages for common tasks, e.g, |
---|
77 | \classname{graphicx}, |
---|
78 | \classname{color}, and |
---|
79 | \classname{hyperref}. |
---|
80 | |
---|
81 | \item |
---|
82 | Add or improve macros to support translation to tagged formats such as |
---|
83 | XML and SGML. This added markup will be key to enhancing the |
---|
84 | peer-review process and lowering production costs. |
---|
85 | |
---|
86 | \item |
---|
87 | Provide a closer approximation to the typesetting style used in |
---|
88 | \emph{Physical Review}. |
---|
89 | |
---|
90 | \item |
---|
91 | Incorporate new features, such as hypertext, to make \revtex\ a |
---|
92 | convenient and desirable e-print format. |
---|
93 | |
---|
94 | \item |
---|
95 | Relax the restrictions in \revtex\ that had only been necessary for |
---|
96 | typesetting journal camera-ready copy. |
---|
97 | \end{itemize} |
---|
98 | |
---|
99 | To meet these goals, \revtex~4 is a complete rewrite with an emphasis |
---|
100 | on maintainability so that it will be easier to provide enhancements. |
---|
101 | |
---|
102 | The \revtex~4 distribution includes both a template |
---|
103 | (\file{template.aps}) and a sample document (\file{apssamp.tex}). |
---|
104 | The template is a good starting point for a manuscript. In the |
---|
105 | following sections are instructions that should be sufficient for |
---|
106 | creating a paper using \revtex~4. |
---|
107 | |
---|
108 | \subsection{Submitting to APS Journals} |
---|
109 | |
---|
110 | Authors using \revtex~4 to prepare a manuscript for submission to |
---|
111 | \textit{Physical Review} or \textit{Reviews of Modern Physics} |
---|
112 | must also read the companion document \textit{APS Compuscript Guide |
---|
113 | for \revtex~4} |
---|
114 | distributed with \revtex\ and follow the guidelines detailed there. |
---|
115 | |
---|
116 | Further information about the compuscript program of the American |
---|
117 | Physical Society may be found at \url{http://publish.aps.org/ESUB/}. |
---|
118 | |
---|
119 | \subsection{Contact Information}\label{sec:resources}% |
---|
120 | Any bugs, problems, or inconsistencies should reported to |
---|
121 | \revtex\ support at \verb+revtex@aps.org+. |
---|
122 | Reports should include information on the error and a \textit{small} |
---|
123 | sample document that manifests the problem if possible (please don't |
---|
124 | send large files!). |
---|
125 | |
---|
126 | \section{Some \LaTeXe\ Basics} |
---|
127 | A primary design goal of \revtex~4 was to make it as compatible with |
---|
128 | standard \LaTeXe\ as possible so that authors may take advantage of all |
---|
129 | that \LaTeXe\ offers. In keeping with this goal, much of the special |
---|
130 | formatting that was built in to earlier versions of \revtex\ is now |
---|
131 | accomplished through standard \LaTeXe\ macros or packages. The books |
---|
132 | in the bibliography provide extensive coverage of all topics |
---|
133 | pertaining to preparing documents under \LaTeXe. They are highly recommended. |
---|
134 | |
---|
135 | To accomplish its goals, \revtex~4 must sometimes patch the underlying |
---|
136 | \LaTeX\ kernel. This means that \revtex~4 requires a fairly recent version of |
---|
137 | \LaTeXe. Versions prior to 1996/12/01 may not work |
---|
138 | correctly. \revtex~4 will be maintained to be compatible with future |
---|
139 | versions of \LaTeXe. |
---|
140 | |
---|
141 | \subsection{Useful \LaTeXe\ Markup} |
---|
142 | \LaTeXe\ markup is the preferred way to accomplish many basic tasks. |
---|
143 | |
---|
144 | \subsubsection{Fonts} |
---|
145 | |
---|
146 | Because \revtex~4 is based upon \LaTeXe, it inherits all of the |
---|
147 | macros used for controlling fonts. Of particular importance are the |
---|
148 | \LaTeXe\ macros \cmd{\textit}, \cmd{\textbf}, \cmd{\texttt} for changing to |
---|
149 | an italic, bold, or typewriter font respectively. One should always |
---|
150 | use these macros rather than the lower-level \TeX\ macros \cmd{\it}, |
---|
151 | \cmd{\bf}, and \cmd{\tt}. The \LaTeXe\ macros offer |
---|
152 | improvements such as better italic correction and scaling in super- |
---|
153 | and subscripts for example. Table~\ref{tab:fonts} |
---|
154 | summarizes the font selection commands in \LaTeXe. |
---|
155 | |
---|
156 | \begin{table} |
---|
157 | \caption{\label{tab:fonts}\LaTeXe\ font commands} |
---|
158 | \begin{ruledtabular} |
---|
159 | \begin{tabular}{ll} |
---|
160 | \multicolumn{2}{c}{\textbf{Text Fonts}}\\ |
---|
161 | \textbf{Font command} & \textbf{Explanation} \\ |
---|
162 | \cmd\textit\marg{text} & Italics\\ |
---|
163 | \cmd\textbf\marg{text} & Boldface\\ |
---|
164 | \cmd\texttt\marg{text} & Typewriter\\ |
---|
165 | \cmd\textrm\marg{text} & Roman\\ |
---|
166 | \cmd\textsl\marg{text} & Slanted\\ |
---|
167 | \cmd\textsf\marg{text} & Sans Serif\\ |
---|
168 | \cmd\textsc\marg{text} & Small Caps\\ |
---|
169 | \cmd\textmd\marg{text} & Medium Series\\ |
---|
170 | \cmd\textnormal\marg{text} & Normal Series\\ |
---|
171 | \cmd\textup\marg{text} & Upright Series\\ |
---|
172 | &\\ |
---|
173 | \multicolumn{2}{c}{\textbf{Math Fonts}}\\ |
---|
174 | \cmd\mathit\marg{text} & Math Italics\\ |
---|
175 | \cmd\mathbf\marg{text} & Math Boldface\\ |
---|
176 | \cmd\mathtt\marg{text} & Math Typewriter\\ |
---|
177 | \cmd\mathsf\marg{text} & Math Sans Serif\\ |
---|
178 | \cmd\mathcal\marg{text} & Calligraphic\\ |
---|
179 | \cmd\mathnormal\marg{text} & Math Normal\\ |
---|
180 | \cmd\bm\marg{text}& Bold math for Greek letters\\ |
---|
181 | & and other symbols\\ |
---|
182 | \cmd\mathfrak\marg{text}\footnotemark[1] & Fraktur\\ |
---|
183 | \cmd\mathbb\marg{text}\footnotemark[1] & Blackboard Bold\\ |
---|
184 | \end{tabular} |
---|
185 | \end{ruledtabular} |
---|
186 | \footnotetext[1]{Requires \classname{amsfonts} or \classname{amssymb} class option} |
---|
187 | \end{table} |
---|
188 | |
---|
189 | \subsubsection{User-defined macros} |
---|
190 | \LaTeXe\ provides several macros that enable users to easily create new |
---|
191 | macros for use in their manuscripts: |
---|
192 | \begin{itemize} |
---|
193 | \footnotesize |
---|
194 | \item \cmd\newcommand\marg{\\command}\oarg{narg}\oarg{opt}\marg{def} |
---|
195 | \item \cmd\newcommand\verb+*+\marg{\\command}\oarg{narg}\oarg{opt}\marg{def} |
---|
196 | \item \cmd\renewcommand\marg{\\command}\oarg{narg}\oarg{opt}\marg{def} |
---|
197 | \item \cmd\renewcommand\verb+*+\marg{\\command}\oarg{narg}\oarg{opt}\marg{def} |
---|
198 | \item \cmd\providecommand\marg{\\command}\oarg{narg}\oarg{opt}\marg{def} |
---|
199 | \item \cmd\providecommand\verb+*+\marg{\\command}\oarg{narg}\oarg{opt}\marg{def} |
---|
200 | \end{itemize} |
---|
201 | Here \meta{\\command} is the name of the macro being defined, |
---|
202 | \meta{narg} is the number of arguments the macro takes, |
---|
203 | \meta{opt} are optional default values for the arguments, and |
---|
204 | \meta{def} is the actually macro definiton. \cmd\newcommand\ creates a |
---|
205 | new macro, \cmd\renewcommand\ redefines a previously defined macro, |
---|
206 | and \cmd\providecommand\ will define a macro only if it hasn't |
---|
207 | been defined previously. The *-ed versions are an optimization that |
---|
208 | indicates that the macro arguments will always be ``short'' arguments. This is |
---|
209 | almost always the case, so the *-ed versions should be used whenver |
---|
210 | possible. |
---|
211 | |
---|
212 | The use of these macros is preferred over using plain \TeX's low-level |
---|
213 | macros such as |
---|
214 | \cmd\def{},\cmd\edef{}, and \cmd\gdef{}. APS authors must follow the |
---|
215 | \textit{APS Compuscript Guide for \revtex~4} when defining macros. |
---|
216 | |
---|
217 | \subsubsection{Symbols} |
---|
218 | |
---|
219 | \LaTeXe\ has added some convenient commands for some special symbols |
---|
220 | and effects. These are summarized in Table~\ref{tab:special}. See |
---|
221 | \cite{Guide} for details. |
---|
222 | |
---|
223 | \begin{table} |
---|
224 | \caption{\label{tab:special}\LaTeXe\ commands for special symbols and effects} |
---|
225 | \begin{ruledtabular} |
---|
226 | \begin{tabular}{lc} |
---|
227 | Command & Symbol/Effect\\ |
---|
228 | \cmd\textemdash & \textemdash\\ |
---|
229 | \cmd\textendash & \textendash\\ |
---|
230 | \cmd\textexclamdown & \textexclamdown\\ |
---|
231 | \cmd\textquestiondown & \textquestiondown\\ |
---|
232 | \cmd\textquotedblleft & \textquotedblleft\\ |
---|
233 | \cmd\textquotedblright & \textquotedblright\\ |
---|
234 | \cmd\textquoteleft & \textquoteleft\\ |
---|
235 | \cmd\textquoteright & \textquoteright\\ |
---|
236 | \cmd\textbullet & \textbullet\\ |
---|
237 | \cmd\textperiodcentered & \textperiodcentered\\ |
---|
238 | \cmd\textvisiblespace & \textvisiblespace\\ |
---|
239 | \cmd\textcompworkmark & Break a ligature\\ |
---|
240 | \cmd\textcircled\marg{char} & Circle a character\\ |
---|
241 | \end{tabular} |
---|
242 | \end{ruledtabular} |
---|
243 | \end{table} |
---|
244 | |
---|
245 | \LaTeXe\ also removed some symbols that were previously automatically |
---|
246 | available in \LaTeX 2.09. These symbols are now contained in a |
---|
247 | separate package \classname{latexsym}. To use these symbols, include |
---|
248 | the package using: |
---|
249 | \begin{verbatim} |
---|
250 | \usepackage{latexsym} |
---|
251 | \end{verbatim} |
---|
252 | |
---|
253 | \subsection{Using \LaTeXe\ packages with \revtex}\label{sec:usepackage}% |
---|
254 | |
---|
255 | Many \LaTeXe\ packages are available, for instance, on CTAN at |
---|
256 | \url{ftp://ctan.tug.org/tex-archive/macros/latex/required/} |
---|
257 | and at |
---|
258 | \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/} |
---|
259 | or may be available on other distribution media, such as the \TeX\ |
---|
260 | Live CD-ROM \url{http://www.tug.org/texlive/}. Some of these packages |
---|
261 | are automatically loaded by \revtex~4 when certain class options are |
---|
262 | invoked and are, thus, ``required''. They will either be distributed |
---|
263 | with \revtex\ or are already included with a standard \LaTeXe\ |
---|
264 | distribution. |
---|
265 | |
---|
266 | Required packages are automatically loaded by \revtex\ on an as-needed |
---|
267 | basis. Other packages should be loaded using the |
---|
268 | \cmd\usepackage\ command. To load the |
---|
269 | \classname{hyperref} package, the document preamble might look like: |
---|
270 | \begin{verbatim} |
---|
271 | \documentclass{revtex} |
---|
272 | \usepackage{hyperref} |
---|
273 | \end{verbatim} |
---|
274 | |
---|
275 | Some common (and very useful) \LaTeXe\ packages are \textit{a priori} |
---|
276 | important enough that \revtex~4 has been designed to be specifically |
---|
277 | compatible with them. |
---|
278 | A bug stemming from the use of one of these packages in |
---|
279 | conjunction with any of the APS journals may be reported by contacting |
---|
280 | \revtex\ support. |
---|
281 | \begin{description} |
---|
282 | \item[\textbf{AMS packages}] \revtex~4 is compatible with and depends |
---|
283 | upon the AMS packages |
---|
284 | \classname{amsfonts}, |
---|
285 | \classname{amssymb}, and |
---|
286 | \classname{amsmath}. In fact, \revtex~4 requires use of these packages |
---|
287 | to accomplish some common tasks. See Section~\ref{sec:math} for more. |
---|
288 | \revtex~4 requires version 2.0 or higher of the AMS-\LaTeX\ package. |
---|
289 | |
---|
290 | \item[\textbf{array and dcolumn}] |
---|
291 | The \classname{array} and \classname{dcolumn} packages are part of |
---|
292 | \LaTeX's required suite of packages. \classname{dcolumn} is required |
---|
293 | to align table columns on decimal points (and it in turn depends upon |
---|
294 | the \classname{array} package). |
---|
295 | |
---|
296 | \item[\textbf{longtable}] |
---|
297 | \file{longtable.sty} may be used for large tables that will span more than one |
---|
298 | page. \revtex~4 dynamically applies patches to longtable.sty so that |
---|
299 | it will work in two-column mode. |
---|
300 | |
---|
301 | \item[\textbf{hyperref}] \file{hyperref.sty} is a package by Sebastian Rahtz that is |
---|
302 | used for putting hypertext links into \LaTeXe\ documents. |
---|
303 | \revtex~4 has hooks to allow e-mail addresses and URL's to become |
---|
304 | hyperlinks if \classname{hyperref} is loaded. |
---|
305 | \end{description} |
---|
306 | |
---|
307 | Other packages will conflict with \revtex~4 and should be |
---|
308 | avoided. Usually such a conflict arises because the package adds |
---|
309 | enhancements that \revtex~4 already includes. Here are some common |
---|
310 | packages that clash with \revtex~4: |
---|
311 | \begin{description} |
---|
312 | \item[\textbf{multicol}] \file{multicol.sty} is a package by Frank Mittelbach |
---|
313 | that adds support for multiple columns. In fact, early versions of |
---|
314 | \revtex~4 used \file{multicol.sty} for precisely this. However, to |
---|
315 | improve the handling of floats, \revtex~4 now has its own macros for |
---|
316 | two-column layout. Thus, it is not necessary to use \file{multicol.sty}. |
---|
317 | |
---|
318 | \item[\textbf{cite}] Donald Arseneau's \file{cite.sty} is often used to provide |
---|
319 | support for sorting a \cmd\cite\ command's arguments into numerical |
---|
320 | order and to collapse consecutive runs of reference numbers. \revtex~4 |
---|
321 | has this functionality built-in already via the \classname{natbib} package. |
---|
322 | |
---|
323 | \item[\textbf{endfloat}] The same functionality can be accomplished |
---|
324 | using the \classoption{endfloats} class option. |
---|
325 | |
---|
326 | \item[\textbf{float}] \revtex~4 already contains a lot of this |
---|
327 | functionality. |
---|
328 | \end{description} |
---|
329 | |
---|
330 | \section{The Document Preamble} |
---|
331 | |
---|
332 | The preamble of a \LaTeX\ document is the set of commands that precede |
---|
333 | the \envb{document} line. It contains a |
---|
334 | \cmd\documentclass\ line to load the \revtex~4 class (\textit{i.~e.}, |
---|
335 | all of the \revtex~4 macro definitions), \cmd\usepackage\ macros to |
---|
336 | load other macro packages, and other macro definitions. |
---|
337 | |
---|
338 | \subsection{The \emph{documentclass} line} |
---|
339 | The basic formatting of the manuscript is controlled by setting |
---|
340 | \emph{class options} using |
---|
341 | \cmd\documentclass\oarg{options}\aarg{\classname{revtex4}}. |
---|
342 | The macro \cmd\documentclass\ |
---|
343 | replaces the \cmd\documentstyle\ macro of \LaTeX2.09. The optional |
---|
344 | arguments that appear in the square brackets control the layout of the |
---|
345 | document. At this point, one only needs to choose a journal style |
---|
346 | (\classoption{pra}, \classoption{prb}, |
---|
347 | \classoption{prc}, \classoption{prd}, |
---|
348 | \classoption{pre}, \classoption{prl}, \classoption{prstab}, |
---|
349 | and \classoption{rmp}) and either \classoption{preprint} or |
---|
350 | \classoption{twocolumn}. Usually, one would want to use |
---|
351 | \classoption{preprint} for draft papers. \classoption{twocolumn} gives |
---|
352 | the \emph{Physical Review} look and feel. Paper size options are also |
---|
353 | available as well. In particular, \classoption{a4paper} is available |
---|
354 | as well as the rest of the standard \LaTeX\ paper sizes. A |
---|
355 | full list of class options is given in the \textit{\revtex~4 Command |
---|
356 | and Options Summary}. |
---|
357 | |
---|
358 | \subsection{Loading other packages} |
---|
359 | Other packages may be loaded into a \revtex~4 document by using the |
---|
360 | standard \LaTeXe\ \cmd\usepackage\ command. For instance, to load |
---|
361 | the \classoption{graphics} package, one would use |
---|
362 | \verb+\usepackage{graphics}+. |
---|
363 | |
---|
364 | \section{The Front Matter}\label{sec:front} |
---|
365 | |
---|
366 | After choosing the basic look and feel of the document by selecting |
---|
367 | the appropriate class options and loading in whatever other macros are |
---|
368 | needed, one is ready to move on to creating a new manuscript. After |
---|
369 | the preamble, be sure to put in a \envb{document} line (and put |
---|
370 | in an \enve{document} as well). This section describes the macros |
---|
371 | \revtex~4 provides for formatting the front matter of the |
---|
372 | article. The behavior and usage of these macros can be quite |
---|
373 | different from those provided in either \revtex~3 or \LaTeXe. See the |
---|
374 | included document \textit{Differences between \revtex~4 and \revtex~3} for an |
---|
375 | overview of these differences. |
---|
376 | |
---|
377 | \subsection{Setting the title} |
---|
378 | |
---|
379 | The title of the manuscript is simply specified by using the |
---|
380 | \cmd\title\aarg{title} macro. A \verb+\\+ may be used to put a line |
---|
381 | break in a long title. |
---|
382 | |
---|
383 | \subsection{Specifying a date}% |
---|
384 | |
---|
385 | The \cmd\date\marg{date} command outputs the date on the |
---|
386 | manuscript. Using \cmd\today\ will cause \LaTeX{} to insert the |
---|
387 | current date whenever the file is run: |
---|
388 | \begin{verbatim} |
---|
389 | \date{\today} |
---|
390 | \end{verbatim} |
---|
391 | |
---|
392 | \subsection{Specifying authors and affiliations} |
---|
393 | |
---|
394 | The macros for specifying authors and their affiliations have |
---|
395 | changed significantly for \revtex~4. They have been improved to save |
---|
396 | labor for authors and in production. Authors and affiliations are |
---|
397 | arranged into groupings called, appropriately enough, \emph{author |
---|
398 | groups}. Each author group is a set of authors who share the same set |
---|
399 | of affiliations. Author names are specified with the \cmd\author\ |
---|
400 | macro while affiliations (or addresses) are specified with the |
---|
401 | \cmd\affiliation\ macro. Author groups are specified by sequences of |
---|
402 | \cmd\author\ macros followed by \cmd\affiliation\ macros. An |
---|
403 | \cmd\affiliation\ macro applies to all previously specified |
---|
404 | \cmd\author\ macros which don't already have an affiliation supplied. |
---|
405 | |
---|
406 | For example, if Bugs Bunny and Roger Rabbit are both at Looney Tune |
---|
407 | Studios, while Mickey Mouse is at Disney World, the markup would be: |
---|
408 | \begin{verbatim} |
---|
409 | \author{Bugs Bunny} |
---|
410 | \author{Roger Rabbit} |
---|
411 | \affiliation{Looney Tune Studios} |
---|
412 | \author{Mickey Mouse} |
---|
413 | \affiliation{Disney World} |
---|
414 | \end{verbatim} |
---|
415 | The default is to display this as |
---|
416 | \begin{center} |
---|
417 | Bugs Bunny and Roger Rabbit\\ |
---|
418 | \emph{Looney Tune Studios}\\ |
---|
419 | Mickey Mouse\\ |
---|
420 | \emph{Disney World}\\ |
---|
421 | \end{center} |
---|
422 | This layout style for displaying authors and their affiliations is |
---|
423 | chosen by selecting the class option |
---|
424 | \classoption{groupedaddress}. This option is the default for all APS |
---|
425 | journal styles, so it does not need to be specified explicitly. |
---|
426 | The other major way of displaying this |
---|
427 | information is to use superscripts on the authors and |
---|
428 | affiliations. This can be accomplished by selecting the class option |
---|
429 | \classoption{superscriptaddress}. To achieve the display |
---|
430 | \begin{center} |
---|
431 | Bugs Bunny,$^{1}$ Roger Rabbit,$^{1,2}$ and Mickey Mouse$^{2}$\\ |
---|
432 | \emph{$^{1}$Looney Tune Studios}\\ |
---|
433 | \emph{$^{2}$Disney World}\\ |
---|
434 | \end{center} |
---|
435 | one would use the markup |
---|
436 | \begin{verbatim} |
---|
437 | \author{Bugs Bunny} |
---|
438 | \affiliation{Looney Tune Studios} |
---|
439 | \author{Roger Rabbit} |
---|
440 | \affiliation{Looney Tune Studios} |
---|
441 | \affiliation{Disney World} |
---|
442 | \author{Mickey Mouse} |
---|
443 | \affiliation{Disney World} |
---|
444 | \end{verbatim} |
---|
445 | |
---|
446 | Note that \revtex~4 takes care of any commas and \emph{and}'s that join |
---|
447 | the author names together and font selection, as well as any |
---|
448 | superscript numbering. Only the author names and affiliations should |
---|
449 | be given within their respective macros. |
---|
450 | |
---|
451 | There is a third class option, \classoption{unsortedaddress}, for |
---|
452 | controlling author/affiliation display. The default |
---|
453 | \classoption{groupedaddress} will actually sort authors into the |
---|
454 | approriate author groups if one chooses to specify an affiliation for |
---|
455 | each author. The markup: |
---|
456 | \begin{verbatim} |
---|
457 | \author{Bugs Bunny} |
---|
458 | \affiliation{Looney Tune Studios} |
---|
459 | \author{Mickey Mouse} |
---|
460 | \affiliation{Disney World} |
---|
461 | \author{Roger Rabbit} |
---|
462 | \affiliation{Looney Tune Studios} |
---|
463 | \end{verbatim} |
---|
464 | will result in the same display as for the first case given |
---|
465 | above even though Roger Rabbit is specified after Mickey Mouse. To |
---|
466 | avoid Roger Rabbit being moved into the same author group as Bugs |
---|
467 | Bunny, use the |
---|
468 | \classoption{unsortedaddress} option instead. In general, it is safest |
---|
469 | to list authors in the order they should appear and specify |
---|
470 | affiliations for multiple authors rather than one at a time. This will |
---|
471 | afford the most independence for choosing the display option. Finally, |
---|
472 | it should be mentioned that the affiliations for the |
---|
473 | \classoption{superscriptaddress} are presented and numbered |
---|
474 | in the order that they are encountered. These means that the order |
---|
475 | will usually follow the order of the authors. An alternative ordering |
---|
476 | can be forced by including a list of \cmd\affiliation\ commands before |
---|
477 | the first \cmd{\author} in the desired order. Then use the exact same |
---|
478 | text for each affilation when specifying them for each author. |
---|
479 | |
---|
480 | If an author doesn't have an affiliation, the \cmd\noaffiliation\ |
---|
481 | macro may be used in the place of an \cmd\affiliation\ macro. |
---|
482 | |
---|
483 | |
---|
484 | \subsubsection{Collaborations} |
---|
485 | |
---|
486 | A collaboration name can be specified with the \cmd\collaboration\ |
---|
487 | macro. This is very similar to the \cmd\author\ macro, but it can only |
---|
488 | be used with the class option \classoption{superscriptaddress}. The |
---|
489 | \cmd\collaboration\ macro should appear at the end of the list of |
---|
490 | authors. The collaboration name will be appear centered in parentheses |
---|
491 | between the list of authors and the list of |
---|
492 | affiliations. Because collaborations |
---|
493 | don't normally have affiliations, one needs to follow the |
---|
494 | \cmd\collaboration\ with \cmd\noaffiliation. |
---|
495 | |
---|
496 | \subsubsection{Footnotes for authors, collaborations, affiliations or title}\label{sec:footau} |
---|
497 | |
---|
498 | Often one wants to specify additional information associated with an |
---|
499 | author, collaboration, or affiliation such an e-mail address, an |
---|
500 | alternate affiliation, or some other anicillary information. |
---|
501 | \revtex~4 introduces several new macros just for this purpose. They |
---|
502 | are: |
---|
503 | \begin{itemize} |
---|
504 | \item\cmd\email\oarg{optional text}\aarg{e-mail address} |
---|
505 | \item\cmd\homepage\oarg{optional text}\aarg{URL} |
---|
506 | \item\cmd\altaffiliation\oarg{optional text}\aarg{affiliation} |
---|
507 | \item\cmd\thanks\aarg{miscellaneous text} |
---|
508 | \end{itemize} |
---|
509 | In the first three, the \emph{optional text} will be prepended before the |
---|
510 | actual information specified in the required argument. \cmd\email\ and |
---|
511 | \cmd\homepage\ each have a default text for their optional arguments |
---|
512 | (`Electronic address:' and `URL:' respectively). The \cmd\thanks\ |
---|
513 | macro should only be used if one of the other three do not apply. Any |
---|
514 | author name can have multiple occurences of these four macros. Note |
---|
515 | that unlike the |
---|
516 | \cmd\affiliation\ macro, these macros only apply to the \cmd\author\ |
---|
517 | that directly precedes it. Any \cmd\affiliation\ \emph{must} follow |
---|
518 | the other author-specific macros. A typical usage might be as follows: |
---|
519 | \begin{verbatim} |
---|
520 | \author{Bugs Bunny} |
---|
521 | \email[E-mail me at: ]{bugs@looney.com} |
---|
522 | \homepage[Visit: ]{http://looney.com/} |
---|
523 | \altaffiliation[Permanent address: ] |
---|
524 | {Warner Brothers} |
---|
525 | \affiliation{Looney Tunes} |
---|
526 | \end{verbatim} |
---|
527 | This would result in the footnote ``E-mail me at: \texttt{bugs@looney.com}, |
---|
528 | Visit: \texttt{http://looney.com/}, Permanent address: Warner |
---|
529 | Brothers'' being attached to Bugs Bunny. Note that: |
---|
530 | \begin{itemize} |
---|
531 | \item Only an e-mail address, URL, or affiliation should go in the |
---|
532 | required argument in the curly braces. |
---|
533 | \item The font is automatically taken care of. |
---|
534 | \item An explicit space is needed at the end of the optional text if one is |
---|
535 | desired in the output. |
---|
536 | \item Use the optional arguments to provide customized |
---|
537 | text only if there is a good reason to. |
---|
538 | \end{itemize} |
---|
539 | |
---|
540 | The \cmd\collaboration\ , \cmd\affiliation\ , or even \cmd\title\ can |
---|
541 | also have footnotes attached via these commands. If any ancillary data |
---|
542 | (\cmd\thanks, \cmd\email, \cmd\homepage, or |
---|
543 | \cmd\altaffiliation) are given in the wrong context (e.g., before any |
---|
544 | \cmd\title, \cmd\author, \cmd\collaboration, or \cmd\affiliation\ |
---|
545 | command has been given), then a warning is given in the \TeX\ log, and |
---|
546 | the command is ignored. |
---|
547 | |
---|
548 | Duplicate sets of ancillary data are merged, giving rise to a single |
---|
549 | shared footnote. However, this only applies if the ancillary data are |
---|
550 | identical: even the order of the commands specifying the data must be |
---|
551 | identical. Thus, for example, two authors can share a single footnote |
---|
552 | indicating a group e-mail address. |
---|
553 | |
---|
554 | Duplicate \cmd\affiliation\ commands may be given in the course of the |
---|
555 | front matter, without the danger of producing extraneous affiliations |
---|
556 | on the title page. However, ancillary data should be specified for |
---|
557 | only the first instance of any particular institution's |
---|
558 | \cmd\affiliation\ command; a later instance with different ancillary |
---|
559 | data will result in a warning in the \TeX\ log. |
---|
560 | |
---|
561 | It is preferable to arrange authors into |
---|
562 | sets. Within each set all the authors share the same group of |
---|
563 | affiliations. For each author, give the \cmd\author\ (and appropriate |
---|
564 | ancillary data), then follow this author group with the needed group |
---|
565 | of \cmd\affiliation\ commands. |
---|
566 | |
---|
567 | If affiliations have been listed before the first |
---|
568 | \cmd\author\ macro to ensure a particular ordering, be sure |
---|
569 | that any later \cmd\affiliation\ command for the given institution is |
---|
570 | an exact copy of the first, and also ensure that no ancillary data is |
---|
571 | given in these later instances. |
---|
572 | |
---|
573 | |
---|
574 | Each APS journal has a default behavior for the placement of these |
---|
575 | ancillary information footnotes. The \classoption{prb} option puts all |
---|
576 | such footnotes at the start of the bibliography while the other |
---|
577 | journal styles display them on the first page. One can override a |
---|
578 | journal style's default behavior by specifying explicitly the class |
---|
579 | option |
---|
580 | \classoption{bibnotes} (puts the footnotes at the start of the |
---|
581 | bibliography) or \classoption{nobibnotes} (puts them on the first page). |
---|
582 | |
---|
583 | \subsubsection{Specifying first names and surnames} |
---|
584 | |
---|
585 | Many APS authors have names in which either the surname appears first |
---|
586 | or in which the surname is made up of more than one name. To ensure |
---|
587 | that such names are accurately captured for indexing and other |
---|
588 | purposes, the \cmd\surname\ macro should be used to indicate which portion |
---|
589 | of a name is the surname. Similarly, there is a \cmd\firstname\ macro |
---|
590 | as well, although usage of \cmd\surname\ should be sufficient. If an |
---|
591 | author's surname is a single name and written last, it is not |
---|
592 | necessary to use these macros. These macros do nothing but indicate |
---|
593 | how a name should be indexed. Here are some examples; |
---|
594 | \begin{verbatim} |
---|
595 | \author{Andrew \surname{Lloyd Weber}} |
---|
596 | \author{\surname{Mao} Tse-Tung} |
---|
597 | \end{verbatim} |
---|
598 | |
---|
599 | \subsection{The abstract} |
---|
600 | An abstract for a paper is specified by using the \env{abstract} |
---|
601 | environment: |
---|
602 | \begin{verbatim} |
---|
603 | \begin{abstract} |
---|
604 | Text of abstract |
---|
605 | \end{abstract} |
---|
606 | \end{verbatim} |
---|
607 | Note that in \revtex~4 the abstract must be specified before the |
---|
608 | \cmd\maketitle\ command and there is no need to embed it in an explicit |
---|
609 | minipage environment. |
---|
610 | |
---|
611 | \subsection{PACS codes} |
---|
612 | APS authors are asked to supply suggested PACS codes with their |
---|
613 | submissions. The \cmd\pacs\ macro is provided as a way to do this: |
---|
614 | \begin{verbatim} |
---|
615 | \pacs{23.23.+x, 56.65.Dy} |
---|
616 | \end{verbatim} |
---|
617 | The actual display of the PACS numbers below the abstract is |
---|
618 | controlled by two class options: \classoption{showpacs} and |
---|
619 | \classoption{noshowpacs}. In particular, this is now independent of |
---|
620 | the \classoption{preprint} option. \classoption{showpacs} must be |
---|
621 | explicitly included in the class options to display the PACS codes. |
---|
622 | |
---|
623 | \subsection{Keywords} |
---|
624 | A \cmd\keywords\ macro may also be used to indicate keywords for the |
---|
625 | article. |
---|
626 | \begin{verbatim} |
---|
627 | \keywords{nuclear form; yrast level} |
---|
628 | \end{verbatim} |
---|
629 | This will be displayed below the abstract and PACS (if supplied). Like |
---|
630 | PACS codes, the actual display of the the keywords is controlled by |
---|
631 | two classoptions: \classoption{showkeys} and |
---|
632 | \classoption{noshowkeys}. An explicit \classoption{showkeys} must be |
---|
633 | included in the \cmd\documentclass\ line to display the keywords. |
---|
634 | |
---|
635 | \subsection{Institutional report numbers} |
---|
636 | Institutional report numbers can be specified using the \cmd\preprint\ |
---|
637 | macro. These will be displayed in the upper lefthand corner of the |
---|
638 | first page. Multiple \cmd\preprint\ macros maybe supplied (space is |
---|
639 | limited though, so only three or less may actually fit). |
---|
640 | |
---|
641 | \subsection{maketitle} |
---|
642 | After specifying the title, authors, affiliations, abstract, PACS |
---|
643 | codes, and report numbers, the final step for formatting the front |
---|
644 | matter of the manuscript is to execute the \cmd\maketitle\ macro by |
---|
645 | simply including it: |
---|
646 | \begin{verbatim} |
---|
647 | \maketitle |
---|
648 | \end{verbatim} |
---|
649 | The \cmd\maketitle\ macro must follow all of the macros listed |
---|
650 | above. The macro will format the front matter in accordance with the various |
---|
651 | class options that were specified in the |
---|
652 | \cmd\documentclass\ line (either implicitly through defaults or |
---|
653 | explicitly). |
---|
654 | |
---|
655 | \section{The body of the paper} |
---|
656 | |
---|
657 | For typesetting the body of a paper, \revtex~4 relies heavily on |
---|
658 | standard \LaTeXe\ and other packages (particulary those that are part |
---|
659 | of AMS-\LaTeX). Users unfamiliar with these packages should read the |
---|
660 | following sections carefully. |
---|
661 | |
---|
662 | \subsection{Section headings} |
---|
663 | |
---|
664 | Section headings are input as in \LaTeX. |
---|
665 | The output is similar, with a few extra features. |
---|
666 | |
---|
667 | Four levels of headings are available in \revtex{}: |
---|
668 | \begin{quote} |
---|
669 | \cmd\section\marg{title text}\\ |
---|
670 | \cmd\subsection\marg{title text}\\ |
---|
671 | \cmd\subsubsection\marg{title text}\\ |
---|
672 | \cmd\paragraph\marg{title text} |
---|
673 | \end{quote} |
---|
674 | |
---|
675 | Use the starred form of the command to suppress the automatic numbering; e.g., |
---|
676 | \begin{verbatim} |
---|
677 | \section*{Introduction} |
---|
678 | \end{verbatim} |
---|
679 | |
---|
680 | To label a section heading for cross referencing, best practice is to |
---|
681 | place the \cmd\label\marg{key} within the argument specifying the heading: |
---|
682 | \begin{verbatim} |
---|
683 | \section{\label{sec:intro}Introduction} |
---|
684 | \end{verbatim} |
---|
685 | |
---|
686 | In the some journal substyles, such as those of the APS, |
---|
687 | all text in the \cmd\section\ command is automatically set uppercase. |
---|
688 | If a lowercase letter is needed, use \cmd\lowercase\aarg{x}. |
---|
689 | For example, to use ``He'' for helium in a \cmd\section\marg{title text} command, type |
---|
690 | \verb+H+\cmd\lowercase\aarg{e} in \marg{title text}. |
---|
691 | |
---|
692 | Use \cmd\protect\verb+\\+ to force a line break in a section heading. |
---|
693 | (Fragile commands must be protected in section headings, captions, and |
---|
694 | footnotes and \verb+\\+ is a fragile command.) |
---|
695 | |
---|
696 | \subsection{Paragraphs and General Text} |
---|
697 | |
---|
698 | Paragraphs always end with a blank input line. Because \TeX\ |
---|
699 | automatically calculates linebreaks and word hyphenation in a |
---|
700 | paragraph, it is not necessary to force linebreaks or hyphenation. Of |
---|
701 | course, compound words should still be explicitly hyphenated, e.g., |
---|
702 | ``author-prepared copy.'' |
---|
703 | |
---|
704 | Use directional quotes for quotation marks around quoted text |
---|
705 | (\texttt{``xxx''}), not straight double quotes (\texttt{"xxx"}). |
---|
706 | For opening quotes, use one or two backquotes; for closing quotes, |
---|
707 | use one or two forward quotes (apostrophes). |
---|
708 | |
---|
709 | \subsection{One-column vs. two-column}\label{sec:widetext} |
---|
710 | |
---|
711 | One of the hallmarks of \textit{Physical Review} is its two-column |
---|
712 | formatting and so one of the \revtex~4 design goals is to make it easier to |
---|
713 | acheive the \textit{Physical Review} look and feel. In particular, the |
---|
714 | \classoption{twocolumn} option will take care of formatting the front matter |
---|
715 | (including the abstract) as a single column. \revtex~4 has its own |
---|
716 | built-in two-column formatting macros to provide well-balanced columns |
---|
717 | as well as reasonable control over the placement of floats in either |
---|
718 | one- or two-column modes. |
---|
719 | |
---|
720 | Occasionally it is necessary to change the formatting from two-column to |
---|
721 | one-column to better accomodate very long equations that are more |
---|
722 | easily read when typeset to the full width of the page. This is |
---|
723 | accomplished using the \env{widetext} environment: |
---|
724 | \begin{verbatim} |
---|
725 | \begin{widetext} |
---|
726 | long equation goes here |
---|
727 | \end{widetext} |
---|
728 | \end{verbatim} |
---|
729 | In two-column mode, this will temporarily return to one-column mode, |
---|
730 | balancing the text before the environment into two short columns, and |
---|
731 | returning to two-column mode after the environment has |
---|
732 | finished. \revtex~4 will also add horizontal rules to guide the |
---|
733 | reader's eye through what may otherwise be a confusing break in the |
---|
734 | flow of text. The |
---|
735 | \env{widetext} environment has no effect on the output under the |
---|
736 | \classoption{preprint} class option because this already uses |
---|
737 | one-column formatting. |
---|
738 | |
---|
739 | Use of the \env{widetext} environment should be restricted to the bare |
---|
740 | minimum of text that needs to be typeset this way. However short pieces |
---|
741 | of paragraph text and/or math between nearly contiguous wide equations |
---|
742 | should be incorporated into the surrounding wide sections. |
---|
743 | |
---|
744 | Low-level control over the column grid can be accomplished with the |
---|
745 | \cmd\onecolumngrid\ and \cmd\twocolumngrid\ commands. Using these, one |
---|
746 | can avoid the horizontal rules added by \env{widetext}. These commands |
---|
747 | should only be used if absolutely necessary. Wide figures and tables |
---|
748 | should be accomodated using the proper \verb+*+ environments. |
---|
749 | |
---|
750 | \subsection{Cross-referencing}\label{sec:xrefs} |
---|
751 | |
---|
752 | \revtex{} inherits the \LaTeXe\ features for labeling and cross-referencing |
---|
753 | section headings, equations, tables, and figures. This section |
---|
754 | contains a simplified explanation of these cross-referencing features. |
---|
755 | The proper usage in the context of section headings, equations, |
---|
756 | tables, and figures is discussed in the appropriate sections. |
---|
757 | |
---|
758 | Cross-referencing depends upon the use of ``tags,'' which are defined by |
---|
759 | the user. The \cmd\label\marg{key} command is used to identify tags for |
---|
760 | \revtex. Tags are strings of characters that serve to label section |
---|
761 | headings, equations, tables, and figures that replace explicit, |
---|
762 | by-hand numbering. |
---|
763 | |
---|
764 | Files that use cross-referencing (and almost all manuscripts do) |
---|
765 | need to be processed through \revtex\ at least twice to |
---|
766 | ensure that the tags have been properly linked to appropriate numbers. |
---|
767 | If any tags are added in subsequent editing sessions, |
---|
768 | \LaTeX{} will display a warning message in the log file that ends with |
---|
769 | \texttt{... Rerun to get cross-references right}. |
---|
770 | Running the file through \revtex\ again (possibly more than once) will |
---|
771 | resolve the cross-references. If the error message persists, check |
---|
772 | the labels; the same \marg{key} may have been used to label more than one |
---|
773 | object. |
---|
774 | |
---|
775 | Another \LaTeX\ warning is \texttt{There were undefined references}, |
---|
776 | which indicates the use of a key in a \cmd\ref\ without ever |
---|
777 | using it in a \cmd\label\ statement. |
---|
778 | |
---|
779 | \revtex{} performs autonumbering exactly as in standard \LaTeX. |
---|
780 | When the file is processed for the first time, |
---|
781 | \LaTeX\ creates an auxiliary file (with the \file{.aux} extension) that |
---|
782 | records the value of each \meta{key}. Each subsequent run retrieves |
---|
783 | the proper number from the auxiliary file and updates the auxiliary |
---|
784 | file. At the end of each run, any change in the value of a \meta{key} |
---|
785 | produces a \LaTeX\ warning message. |
---|
786 | |
---|
787 | Note that with footnotes appearing in the bibliography, extra passes |
---|
788 | of \LaTeX\ may be needed to resolve all cross-references. For |
---|
789 | instance, putting a \cmd\cite\ inside a \cmd\footnote\ will require at |
---|
790 | least three passes. |
---|
791 | |
---|
792 | Using the \classname{hyperref} package to create hyperlinked PDF files |
---|
793 | will cause reference ranges to be expanded to list every |
---|
794 | reference in the range. This behavior can be avoided by using the |
---|
795 | \classname{hypernat} package available from \url{www.ctan.org}. |
---|
796 | |
---|
797 | \subsection{Acknowledgments} |
---|
798 | Use the \env{acknowledgments} environment for an acknowledgments |
---|
799 | section. Depending on the journal substyle, this element may be |
---|
800 | formatted as an unnumbered section title \textit{Acknowledgments} or |
---|
801 | simply as a paragraph. Please note the spelling of |
---|
802 | ``acknowledgments''. |
---|
803 | \begin{verbatim} |
---|
804 | \begin{acknowlegments} |
---|
805 | The authors would like to thank... |
---|
806 | \end{acknowlegments} |
---|
807 | \end{verbatim} |
---|
808 | |
---|
809 | \subsection{Appendices} |
---|
810 | The \cmd\appendix\ command signals that all following sections are |
---|
811 | appendices, so \cmd\section\marg{title text} after \cmd\appendix\ will set |
---|
812 | \marg{title text} as an appendix heading (an empty \marg{title text} |
---|
813 | is permitted). For a single appendix, use a |
---|
814 | \cmd\appendix\verb+*+ followed by \cmd\section\marg{title text} |
---|
815 | command to suppress the appendix letter in the section heading. |
---|
816 | |
---|
817 | \section{Math and Equations}\label{sec:math} |
---|
818 | |
---|
819 | \subsection{Math in text} |
---|
820 | |
---|
821 | Not surprisingly, \revtex\ uses the \TeX\ math \verb+$+ delimiters |
---|
822 | for math embedded in text. For example, |
---|
823 | \verb|$a^{z}$| give $a^{z}$. Within math mode, use |
---|
824 | \verb+^+\marg{math} for superscripts and |
---|
825 | \verb+_+\marg{math} for subscripts. If the braces after the |
---|
826 | \verb+^+ are omitted, \TeX{} will |
---|
827 | superscript the next \emph{token} (generally a single character or |
---|
828 | command). Thus it is safest to use explicit braces \verb+{}+. |
---|
829 | |
---|
830 | As with text, math should not require extensive explicit vertical or |
---|
831 | horzontal motion commands, because \TeX\ calculates math spacing |
---|
832 | itself automatically. In particular, explicit spacing around |
---|
833 | relations (e.g., $=$) or operators (e.g., $+$) should be |
---|
834 | unnecessary. These suggestions notwithstanding, some fine-tuning of |
---|
835 | math is required in specific cases, see Chapter~18 in the \TeX |
---|
836 | book\cite{TeXbook}. |
---|
837 | |
---|
838 | \subsection{Text in math}\label{sec:textinmath} |
---|
839 | |
---|
840 | There are times when normal, non-italic text needs to be inserted |
---|
841 | into a math expression. The \cmd\text\marg{text} command is the |
---|
842 | preferred method of accomplishing this. It produces regular text |
---|
843 | \emph{and} scales correctly in superscripts: |
---|
844 | \verb+$y=x \text{ for } x_{\text{e-p}}$+ gives |
---|
845 | ``$y=x \text{ for } x_{\text{e-p}}$''. To use the \cmd\text\ command, |
---|
846 | the \classname{amsmath} package must be loaded: include a |
---|
847 | \cmd\usepackage\aarg{\classname{amsmath}} command in the document |
---|
848 | preamble or use the class option \classoption{amsmath}. Please note |
---|
849 | that \revtex~4 requires version 2.0 or higher of \classname{amsmath}. |
---|
850 | |
---|
851 | Other common alternatives may be less desirable. Using the standard |
---|
852 | \LaTeXe\ \cmd\mbox\marg{text} will give normal text, including a hyphen, |
---|
853 | but will not scale correctly in superscripts: |
---|
854 | \verb+$x_{\mbox{e-p}}$+ gives ``$x_{\mbox{e-p}}$''. |
---|
855 | The \cmd\rm\ command |
---|
856 | only switches to Roman font for math letters. It does not, for |
---|
857 | example, handle hyphens correctly: |
---|
858 | \verb+$$x_{\rm{e-p}}$+ gives ``$x_{\rm e-p}$''. But note that |
---|
859 | \cmd\textrm{}, it does work: \verb+$x_{\textrm{e-p}}$+ gives ``$x_{\textrm{e-p}}$''. |
---|
860 | |
---|
861 | \subsection{Displayed equations}\label{sec:dispmath} |
---|
862 | |
---|
863 | Equations are set centered in the column width or flush left depending |
---|
864 | on the selected journal substyle. |
---|
865 | |
---|
866 | For the simplest type of displayed equation, a numbered, one-line |
---|
867 | equation, use the \env{equation} environment. |
---|
868 | \revtex\ takes care of the equation number% |
---|
869 | ---the number will be set below the equation if necessary. |
---|
870 | Use \cmd\[\dots\cmd\] for a single, one-line unnumbered display equation. |
---|
871 | |
---|
872 | Use the \env{eqnarray} environment when more than one consecutive |
---|
873 | equation occurs, putting each equation in a separate row of the |
---|
874 | environment, and using \cmd\nonumber\ before the row end (\cmd\\) to |
---|
875 | suppress the equation number where necessary. If the equations are |
---|
876 | related to each other, align each on the respective relation operator |
---|
877 | (such as $=$). |
---|
878 | |
---|
879 | When an equation is broken over lines or is continued over multiple |
---|
880 | relation operators, it is called a multi-line or continued equation, |
---|
881 | respectively; here, too, use the \env{eqnarray} environment. |
---|
882 | |
---|
883 | For a continued equation, align each row on the relation operator just |
---|
884 | as with multiple equations, and use the \cmd\nonumber\ command to |
---|
885 | suppress auto-numbering on broken lines. Also, use the starred form |
---|
886 | of the row end (\cmd\\\verb+*+) to prevent a pagebreak at that |
---|
887 | juncture. |
---|
888 | |
---|
889 | Short displayed equations that can appear together on a single line |
---|
890 | separated by \cmd\qquad\ space may be placed in a single |
---|
891 | \env{equation} environment. |
---|
892 | |
---|
893 | As explained in Section~\ref{sec:widetext}, occasionally in two-column |
---|
894 | mode a long equation, in order to fit it in the narrow column width, |
---|
895 | would need to be broken into so many lines that it would affect |
---|
896 | readibility. Set it in a wide column using the \env{widetext} |
---|
897 | environment. Then return to the normal text width as soon as |
---|
898 | possible. |
---|
899 | |
---|
900 | The sample file \file{apssamp.tex} illustrates how to obtain each of |
---|
901 | the above effects. |
---|
902 | |
---|
903 | \subsection{Numbering displayed equations} |
---|
904 | |
---|
905 | \revtex~4 automatically numbers equations. |
---|
906 | For single-line and multi-line equations, use the |
---|
907 | \env{equation} and \env{eqnarray} environments as described above. |
---|
908 | For unnumbered single-line equations, use the \verb+\[+\dots\verb+\]+ |
---|
909 | construction. The command \cmd\nonumber\ will suppress the numbering |
---|
910 | on a single line of an |
---|
911 | \env{eqnarray}. |
---|
912 | For a multi-line equation with no equation numbers at all, |
---|
913 | use the \env{eqnarray*} environment. |
---|
914 | |
---|
915 | A series of equations can be a labeled with a lettered sequence, |
---|
916 | e.g., (3a), (3b), and (3c), by |
---|
917 | putting the respective \env{equation} or \env{eqnarray} environment within a |
---|
918 | \env{subequations} environment. |
---|
919 | The \classname{amsmath} package (can be loaded with the |
---|
920 | \classoption{amsmath} class option) is required for this. |
---|
921 | |
---|
922 | Use the command \cmd\tag\marg{number} to produce an idiosyncratic |
---|
923 | equation number: $(1')$, for example. Numbers assigned by \cmd\tag\ |
---|
924 | are completely independent of \revtex's automatic numbering. The |
---|
925 | package \classname{amsmath} is required for using the \cmd\tag\ |
---|
926 | command. |
---|
927 | |
---|
928 | To have \revtex{} reset the equation numbers at the start of each section, |
---|
929 | use the \classoption{eqsecnum} class option in the document preamble. |
---|
930 | |
---|
931 | See the sample file \file{apssamp.tex} for some examples. |
---|
932 | |
---|
933 | \subsection{Cross-referencing displayed equations} |
---|
934 | |
---|
935 | To refer to a numbered equation, use |
---|
936 | the \cmd\label\marg{key} and \cmd\ref\marg{key} commands. |
---|
937 | The \cmd\label\marg{key} command is used within the referenced equation |
---|
938 | (on the desired line of the \env{eqnarray}, if a multi-line equation): |
---|
939 | \begin{verbatim} |
---|
940 | \begin{equation} |
---|
941 | A=B \label{pauli} |
---|
942 | \end{equation} |
---|
943 | ... It follows from Eq.~(\ref{pauli}) |
---|
944 | that this is the case ... |
---|
945 | \begin{eqnarray} |
---|
946 | A & = &B,\label{pauli2}\\ |
---|
947 | A'& = &B' |
---|
948 | \end{eqnarray} |
---|
949 | \end{verbatim} |
---|
950 | gives |
---|
951 | \begin{equation} |
---|
952 | A=B \label{pauli} |
---|
953 | \end{equation} |
---|
954 | ... It follows from Eq.~(\ref{pauli}) |
---|
955 | that this is the case ... |
---|
956 | \begin{eqnarray} |
---|
957 | A & = &B,\label{pauli2}\\ |
---|
958 | A'& = &B' |
---|
959 | \end{eqnarray} |
---|
960 | |
---|
961 | Please note the parentheses surrounding the \cmd\ref\ command. |
---|
962 | These are \emph{not} provided automatically and, thus, must be |
---|
963 | explicitly incorporated. |
---|
964 | |
---|
965 | Numbers produced with \cmd\tag\ can also be cross-referenced by adding |
---|
966 | a \cmd\label\ command after the \cmd\tag\ command. |
---|
967 | |
---|
968 | Using a \cmd\label\ after \envb{subequations} to reference the |
---|
969 | \emph{general} number of the equations in the |
---|
970 | \env{subequations} environment. For example, if |
---|
971 | \begin{verbatim} |
---|
972 | \begin{subequations} |
---|
973 | \label{allequations} % notice location |
---|
974 | \begin{eqnarray} |
---|
975 | E&=&mc^2,\label{equationa} |
---|
976 | \\ |
---|
977 | E&=&mc^2,\label{equationb} |
---|
978 | \\ |
---|
979 | E&=&mc^2,\label{equationc} |
---|
980 | \end{eqnarray} |
---|
981 | \end{subequations} |
---|
982 | \end{verbatim} |
---|
983 | % |
---|
984 | gives the output |
---|
985 | \begin{subequations} |
---|
986 | \label{allequations} % notice location |
---|
987 | \begin{eqnarray} |
---|
988 | E&=&mc^2,\label{equationa} |
---|
989 | \\ |
---|
990 | E&=&mc^2,\label{equationb} |
---|
991 | \\ |
---|
992 | E&=&mc^2,\label{equationc} |
---|
993 | \end{eqnarray} |
---|
994 | \end{subequations} |
---|
995 | % |
---|
996 | then \verb+Eq.~(\ref{allequations})+ gives ``Eq.~(\ref{allequations})''. |
---|
997 | |
---|
998 | {\bf Note:} incorrect cross-referencing will result if |
---|
999 | \cmd\label\ is used in an unnumbered single-line equation |
---|
1000 | (i.e., within the \verb+\[+ and \verb+\]+ commands), |
---|
1001 | or if \cmd\label\ is used on a line of an eqnarray that is not being numbered |
---|
1002 | (i.e., a line that has a \cmd\nonumber). |
---|
1003 | |
---|
1004 | \subsection{Using the AMS packages \classoption{amsfonts}, |
---|
1005 | \classoption{amssymb}, and \classoption{amsmath}}\label{AMS} |
---|
1006 | |
---|
1007 | The American Mathematical Society's AMS-\LaTeX\ packages provided extra |
---|
1008 | fonts, symbols, and math markup that are quite convenient. \revtex~4 |
---|
1009 | supports the use of these packages directly. To use the \classoption{amsfonts}, |
---|
1010 | \classoption{amssymb}, and \classoption{amsmath} class options, |
---|
1011 | AMS-\LaTeX\ (and perhaps the additional AMS fonts) will need to be |
---|
1012 | installed. Please note the \revtex~4 requires version 2.0 or higher |
---|
1013 | of AMS-\LaTeX. These packages can be downloaded from |
---|
1014 | \url{http://www.ams.org/tex/}. |
---|
1015 | |
---|
1016 | There are two class options for accessing the AMS fonts: |
---|
1017 | \classoption{amsfonts} and \classoption{amssymb}. |
---|
1018 | The \classoption{amsfonts} option defines the \cmd\mathfrak\ and |
---|
1019 | \cmd\mathbb\ commands to switch to the Fraktur and |
---|
1020 | Blackboard Bold fonts, respectively. |
---|
1021 | These fonts are selected with the \cmd\mathfrak\ and \cmd\mathbb\ |
---|
1022 | font-switching commands: |
---|
1023 | \verb+${\mathfrak{G}}$+ gives a Fraktur ``$\mathfrak{G}$'' |
---|
1024 | and \verb+${\mathbb{Z}}$+ gives a Blackboard Bold ``$\mathbb{Z}$''. |
---|
1025 | \revtex{} does not currently support the use of the extra Euler fonts |
---|
1026 | (the AMS fonts starting with \texttt{eur} or \texttt{eus}) or the |
---|
1027 | Cyrillic fonts (the AMS fonts starting with \texttt{w}). |
---|
1028 | |
---|
1029 | The \classoption{amssymb} class option gives all the font |
---|
1030 | capabilities of the |
---|
1031 | \classoption{amsfonts} class option and further defines the commands |
---|
1032 | for many commonly used math symbols. These symbols will scale |
---|
1033 | correctly in superscripts and other places. See the AMS-\LaTeX\ |
---|
1034 | documentation for the complete list of symbols available. |
---|
1035 | |
---|
1036 | \subsection{Bold symbols in math}\label{sec:bboxamsfonts} |
---|
1037 | |
---|
1038 | \revtex~4 uses the standard \LaTeXe\ Bold Math (\classname{bm}) package as the |
---|
1039 | basis for creating bold symbols in math mode. As usual, this requires |
---|
1040 | an explicit \cmd\usepackage\aarg{\classname{bm}} in the document |
---|
1041 | preamble. The command |
---|
1042 | \cmd\bm\marg{symbol} makes \marg{symbol} bold in math mode, ensuring |
---|
1043 | that it is the correct size, even in superscripts. If the correct font |
---|
1044 | in the correct size is not available then result is the \marg{symbol} |
---|
1045 | set at the |
---|
1046 | correct size in lightface and a \LaTeXe\ warning that says |
---|
1047 | ``\texttt{No boldmath typeface in this size}\dots''. Most bold special |
---|
1048 | characters will require that the AMS fonts be installed and the |
---|
1049 | \classoption{amsfonts} class option be invoked. |
---|
1050 | |
---|
1051 | \cmd\bm\ is the proper means to get bold Greek characters---upper- and |
---|
1052 | lowercase---and other symbols. |
---|
1053 | The following will come out bold with \cmd\bm: |
---|
1054 | normal math italic letters, numbers, |
---|
1055 | Greek letters (uppercase and lowercase), |
---|
1056 | small bracketing and operators, and \cmd\mathcal. Fraktur |
---|
1057 | characters will come out bold in a \cmd\bm; however, Blackboard Bold |
---|
1058 | requires using the \cmd\mathbb command rather than \cmd{\bm}. |
---|
1059 | The \classoption{amsfonts} option adds support for bold math |
---|
1060 | letters and symbols in smaller sizes and in superscripts when a |
---|
1061 | \cmd\bm\marg{symbol} is used. |
---|
1062 | For example, \verb+$\pi^{\bm{\pi}}$+ gives a bold |
---|
1063 | lowercase pi in the superscript position: $^{\pi\bm{\pi}}$. |
---|
1064 | |
---|
1065 | Note that \cmd\bm\marg{math} is a fragile command and, thus, should be |
---|
1066 | preceded by \cmd\protect\ in commands with moving arguments. |
---|
1067 | |
---|
1068 | \section{Footnotes} |
---|
1069 | \LaTeX's standard \cmd\footnote\ command is available in |
---|
1070 | \revtex~4. The footnote text can either appear at the bottom of a page or |
---|
1071 | as part of the bibliography (in order, after the rest of the |
---|
1072 | references). This choice can be controlled by two class options: |
---|
1073 | \classoption{footinbib} and \classoption{nofootinbib}. \revtex~4 |
---|
1074 | defaults to the former. Specific journal options may select a |
---|
1075 | different value than the default. Note that in the latter case, the |
---|
1076 | argument of the |
---|
1077 | \cmd\footnote\ command is a moving argument in the sense of the \LUG, |
---|
1078 | Appendix~C.1.3: any fragile command within that argument must be |
---|
1079 | preceded by a \cmd\protect\ command. |
---|
1080 | |
---|
1081 | The \cmd\footnote\ macro \emph{should not} be used in the front |
---|
1082 | matter for indicating author/affiliation relationships or to provide |
---|
1083 | additional information about authors (such as an e-mail |
---|
1084 | address). See Section~\ref{sec:footau} for the proper way to do |
---|
1085 | this. |
---|
1086 | |
---|
1087 | Finally, footnotes that appear in tables behave differently. They |
---|
1088 | will be typeset as part of the table itself. See |
---|
1089 | Section~\ref{sec:tablenote} for details. |
---|
1090 | |
---|
1091 | \section{Citations and References}\label{sec:endnotes} |
---|
1092 | |
---|
1093 | In keeping with the \revtex~4 design goal of making it easier to |
---|
1094 | extract tagged information from a manuscript, new macros and \BibTeX\ |
---|
1095 | style files have been added to provide better markup. Furthermore, |
---|
1096 | these have been built upon some widely-used \LaTeX\ packages in line |
---|
1097 | with the design goal of making use of the existing packages where |
---|
1098 | possible. The two main external packages that are of concern here are |
---|
1099 | Patrick Daly's \classname{natbib} citation package and his |
---|
1100 | \classname{custom-bib} tool kit for building new \BibTeX\ style |
---|
1101 | files. |
---|
1102 | |
---|
1103 | From an author's point of view, all this means is that a proper |
---|
1104 | \revtex~4 installation requires having \classname{natbib} (version 7 |
---|
1105 | or higher) installed. It also means that the full set of |
---|
1106 | \classname{natbib} functionality is available from within \revtex~4 |
---|
1107 | (but see the \textit{APS Compuscript Guide for \revtex~4} for restrictions). |
---|
1108 | The \classname{natbib} documentation contains many exmaples; see in |
---|
1109 | particular the included \verb+natnotes.tex+ file for a convenient summary. |
---|
1110 | |
---|
1111 | As in standard \LaTeX, references are cited in text using the |
---|
1112 | \cmd\cite\marg{key} command and are listed in the bibliography using |
---|
1113 | the \cmd\bibitem\marg{key} command. The \cmd\cite{} macro enables |
---|
1114 | \revtex~4 to automatically number the references in the manuscript. |
---|
1115 | |
---|
1116 | A typical example might be: |
---|
1117 | \begin{verbatim} |
---|
1118 | String theory\cite{GSW} attempts to |
---|
1119 | provide a theory of everything. |
---|
1120 | \end{verbatim} |
---|
1121 | The corresponding \cmd\bibitem{} would be: |
---|
1122 | \begin{verbatim} |
---|
1123 | \bibitem{GSW} M.~Greene, J.~Schwarz, and |
---|
1124 | E.~Witten, \textit{Superstring Theory: |
---|
1125 | Introduction}, (Cambridge University |
---|
1126 | Press, London, 1985). |
---|
1127 | \end{verbatim} |
---|
1128 | |
---|
1129 | Journals differ in how the \cmd\cite\ will be displayed. Most APS journals |
---|
1130 | display the citation in-line, as a number, enclosed in square brackets, |
---|
1131 | \textit{e.~g.}, ``String theory[1] attempts\dots.'' Other journals |
---|
1132 | (most notably \textit{Physical Review B}) |
---|
1133 | instead use a number in a superscript: ``String theory$^{1}$ attempts\dots.'' |
---|
1134 | Selecting the journal substyle using a class option (such as |
---|
1135 | \classoption{prb}) will invoke the appropriate style. |
---|
1136 | In journal substyles using superscripts, |
---|
1137 | the macro the \cmd\onlinecite\marg{key} is necessary to get the number |
---|
1138 | to appear on the baseline. |
---|
1139 | For example, ``String theory (see, for example, |
---|
1140 | \verb+Ref.~\onlinecite{GSW}+)'' will give the output |
---|
1141 | ``String theory (see, for example, Ref.~1).'' |
---|
1142 | |
---|
1143 | The \cmd{\onlinecite} command has the same semantics as |
---|
1144 | \classname{natbib}'s \cmd{\citealp} command. |
---|
1145 | |
---|
1146 | A \cmd\cite\ command with multiple keys is formatted with consecutive |
---|
1147 | reference numbers collapsed; e.g., [1,2,3,5] will be output as |
---|
1148 | [1--3,5]. To split the list over more than one line, use |
---|
1149 | a \verb+%+ character immediately following a comma: |
---|
1150 | \begin{verbatim} |
---|
1151 | . . . \cite{a,b,c,d,e,f,% |
---|
1152 | g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z} |
---|
1153 | \end{verbatim} |
---|
1154 | The \verb+%+ avoids unwanted spaces. |
---|
1155 | |
---|
1156 | \subsection{Author/Year (Non-numeric) Citations} |
---|
1157 | |
---|
1158 | \textit{Reviews of Modern Physics} uses a citation style based on the |
---|
1159 | first author's last name and the year of the reference rather than a |
---|
1160 | simple number. Support for this style of citing references is the |
---|
1161 | primary reason \revtex~4 uses the \classname{natbib} |
---|
1162 | package. \classname{natbib} uses an optional argument to the |
---|
1163 | \cmd\bibitem\ macro to specify what text to use for the \cmd\cite\ |
---|
1164 | text: |
---|
1165 | \begin{quote} |
---|
1166 | \cmd\bibitem\verb+[+\meta{short-name}\verb+(+\meta{year}\verb+)+\meta{long-name}\verb+]+ |
---|
1167 | \end{quote} |
---|
1168 | where \meta{short-name} is the author name used in a parenthetical citation, |
---|
1169 | \meta{long-name} that used in a textual citation, and |
---|
1170 | \meta{year} is the year. More concretely, the \cmd\bibitem\ example |
---|
1171 | above would appear as |
---|
1172 | \begin{verbatim} |
---|
1173 | \bibitem[Greene et al.(1985)Green, |
---|
1174 | Schwarz, and Witten]{GSW} |
---|
1175 | M.~Greene, J.~Schwarz, and E.~Witten, |
---|
1176 | \textit{Superstring Theory}, |
---|
1177 | (Cambridge Press, London, 1985). |
---|
1178 | \end{verbatim} |
---|
1179 | |
---|
1180 | When the citation constitutes part of the grammar of the sentence, |
---|
1181 | the \cmd\textcite\marg{key} command may be used (analogous to the |
---|
1182 | \cmd\onlinecite\ command above). Both \cmd\textcite\ and |
---|
1183 | \cmd\onlinecite\ are built upon \classname{natbib}'s rich repertoire of |
---|
1184 | macros (\cmd\citep{}, \cmd\citet{}, etc.). These macros are available in |
---|
1185 | \revtex~4; however, APS authors must follow the |
---|
1186 | \textit{APS Compuscript Guide for \revtex~4} |
---|
1187 | guidelines regarding \classname{natbib}'s macros. |
---|
1188 | |
---|
1189 | \subsection{\label{sec:use-bib}Using Bib\TeX} |
---|
1190 | |
---|
1191 | The \cmd\bibitem{} entries can be coded by hand as above, of course, but the |
---|
1192 | use of \BibTeX\ with the new style files provided with \revtex~4 makes |
---|
1193 | it particularly simple to generate marked-up references that can, for |
---|
1194 | instance, take advantage of packages like |
---|
1195 | \classname{hyperref} for linking. They also save the trouble of having |
---|
1196 | to specify formatting like the italics for the book title in the above |
---|
1197 | example. And, for those wishing to use author/year citations, \BibTeX\ |
---|
1198 | will automatically generate the appropriate optional arguments for the |
---|
1199 | \cmd\bibitem\ commands. |
---|
1200 | |
---|
1201 | \BibTeX\ is an adjunct to \LaTeX\ that aids in the |
---|
1202 | preparation of bibliographies. \BibTeX\ allows authors to build up a |
---|
1203 | database or collection of bibliography entries that may be used for many |
---|
1204 | manuscripts. A \BibTeX\ style file then specifies how to transform the |
---|
1205 | entries into a proper \cmd\bibitem{} for a particular journal. Here we |
---|
1206 | give a brief summary of how to get started with \BibTeX. More details can be |
---|
1207 | found in the \textit{\revtex~4 \BibTeX\ Guide} included in the |
---|
1208 | distribution or in the LaTeX books listed in the references. |
---|
1209 | |
---|
1210 | Selecting a journal style by using an appropriate class option will |
---|
1211 | automatically select the correct \BibTeX\ style file. For all |
---|
1212 | of the \textit{Physical Review} journals, this is \file{apsrev.bst}, |
---|
1213 | while for \textit{Reviews of Modern Physics} this is |
---|
1214 | \file{apsrmp.bst}. The selection can be overridden by specifying an |
---|
1215 | alternative \file{.bst} file using the standard \LaTeXe |
---|
1216 | \cmd\bibliographystyle\ macro. This must appear in the preamble |
---|
1217 | before the \envb{document} line in \revtex~4 (this differs from |
---|
1218 | standard \LaTeX). |
---|
1219 | |
---|
1220 | The \BibTeX\ database files will contain entries such as: |
---|
1221 | \begin{verbatim} |
---|
1222 | @Book{GSW, |
---|
1223 | author=``M. Greene, J. Schwarz, |
---|
1224 | E. Witten'', |
---|
1225 | title=``Superstring theory: |
---|
1226 | Introduction'', |
---|
1227 | publisher=``Cambridge University |
---|
1228 | Press'', |
---|
1229 | address=``London'', |
---|
1230 | year=``1985'' |
---|
1231 | } |
---|
1232 | \end{verbatim} |
---|
1233 | There are entry formats for articles, technical reports, e-prints, |
---|
1234 | theses, books, proceedings, and articles that appear in books or |
---|
1235 | proceedings. The \file{apsrev} and \file{apsrmp} styles provided with |
---|
1236 | \revtex~4 also allows URL's and e-print identifiers to be specified |
---|
1237 | for any of the different entry types. There is also an additional |
---|
1238 | ``collaboration'' field that can be used in addition to ``author''. |
---|
1239 | |
---|
1240 | To actually create the bibliography in the manuscript, the |
---|
1241 | \cmd\bibliography\marg{bib files} macro is used. |
---|
1242 | Here \meta{bib files} is a comma-separated list of \BibTeX\ bibliography |
---|
1243 | database files, each with the \file{.bib} extension. The |
---|
1244 | \cmd\bibliography\ macro should be placed at the location where the |
---|
1245 | references are to appear (usually after the main body of the |
---|
1246 | paper). When the manuscript is processed with \LaTeX\ for the first |
---|
1247 | time, the keys corresponding for the \cmd\cite{} macros used in the |
---|
1248 | manuscript are written out to the \file{.aux} file. Then \BibTeX\ should |
---|
1249 | be run (if the manuscript is called \file{paper.tex}, the command would |
---|
1250 | be \verb+bibtex paper+. This will produce a \file{.bbl} file containing all |
---|
1251 | of the \cmd\bibitem{}'s for the manuscript. Subsequent runs of \LaTeXe\ |
---|
1252 | will call this file in to resolve the references. \LaTeXe\ should be run |
---|
1253 | repeatedly until all references are resolved. |
---|
1254 | |
---|
1255 | The \BibTeX-produced \cmd\bibitem{}'s created using the \file{apsrev} and |
---|
1256 | \file{apsrmp} appear considerably more complex than the example given |
---|
1257 | above. This is because the style files add in \cmd\bibinfo{}, |
---|
1258 | \cmd\bibnamefont{}, \cmd\eprint{}, and \cmd\url{} macros for |
---|
1259 | specifying additional formatting and tagging. The \cmd\bibinfo\ macro |
---|
1260 | is mostly a do-nothing macro that serves merely to tag the information with |
---|
1261 | the field information from the original entry in the \BibTeX\ database. |
---|
1262 | The \cmd\eprint\ and \cmd\url\ macros can be used to create the |
---|
1263 | appropriate hyperlinks in target formats such as PDF. |
---|
1264 | |
---|
1265 | For more information on using \BibTeX\ with \LaTeX, see Sections~4.3.1 |
---|
1266 | and~C.11.3 of the \LUG\cite{LaTeXman}, Section~13.2 of \cite{Compan}, |
---|
1267 | or the online \BibTeX\ manual |
---|
1268 | \url{http://ctan.tug.org/tex-archive/biblio/bibtex/distribs/doc/btxdoc.tex}. |
---|
1269 | %\url{http://ctan.tug.org/tex-archive/help/Catalogue/entries/bibtex.html}. |
---|
1270 | |
---|
1271 | \section{Figures and Artwork}\label{sec:figures} |
---|
1272 | |
---|
1273 | Figures may be included into a \revtex~4 manuscript by using the |
---|
1274 | standard \LaTeXe\ macros. It should be noted that \LaTeXe\ includes |
---|
1275 | several powerful packages for including the files in various |
---|
1276 | formats. The two main packages are \classname{graphics} and |
---|
1277 | \classname{graphicx}. Both offer a macro called |
---|
1278 | \cmd\includegraphics\oarg{args}\marg{filename}; |
---|
1279 | they mainly differ in how arguments for |
---|
1280 | controlling figure scaling, translation, and orientation |
---|
1281 | are specified. Old \LaTeX2.09 interfaces such as |
---|
1282 | \file{epsfig} have been re-implemented on top of these packages. |
---|
1283 | For more information on the enhancements of the \classname{graphicx} package, |
---|
1284 | see \cite{CompanG} or |
---|
1285 | \url{ftp://ctan.tug.org/tex-archive/macros/latex/required/graphics/grfguide.ps}. |
---|
1286 | \revtex~4 no longer has the \classoption{epsf} class option, though |
---|
1287 | the \classname{epsfig} package provides a similar interface. |
---|
1288 | |
---|
1289 | |
---|
1290 | The \env{figure} environment should be used to add a caption to the figure and |
---|
1291 | to allow \LaTeX\ to number and place the figures where they fit best. |
---|
1292 | \LaTeX\ will label and automatically number the captions FIG.~1, |
---|
1293 | FIG.~2, etc. For example: |
---|
1294 | \begin{verbatim} |
---|
1295 | \begin{figure} |
---|
1296 | \includegraphics{fig1.eps} |
---|
1297 | \caption{\label{fig1}Text of first caption.} |
---|
1298 | \end{figure} |
---|
1299 | \end{verbatim} |
---|
1300 | Note how the \cmd\label\marg{key} command is used to cross-reference |
---|
1301 | figures in text. The \cmd\label\marg{key} command should be inserted |
---|
1302 | inside the figure caption. As usual, the \cmd\ref\marg{key} macro can |
---|
1303 | then by used to refer to the label: ``As depicted in |
---|
1304 | FIG.\verb+~\ref{fig1}+\dots''. |
---|
1305 | |
---|
1306 | Figures are normally set to the width of the column in |
---|
1307 | which they are placed. This means that in two-column mode, the figure |
---|
1308 | will be placed in a single, narrow column. For wide figures, the |
---|
1309 | \cmd\figure\verb+*+ environment should be used |
---|
1310 | instead. This will place the figure across both columns (the figure |
---|
1311 | usually will |
---|
1312 | appear either at the top or the bottom of the following page). |
---|
1313 | |
---|
1314 | |
---|
1315 | Captions less than one line long are centered under the figure, |
---|
1316 | otherwise they span the width of the figure. |
---|
1317 | |
---|
1318 | Note that is unnecessary (and undesirable) to use explicit centering |
---|
1319 | commands inside the float environments. |
---|
1320 | |
---|
1321 | \section{Tables}\label{sec:tables} |
---|
1322 | |
---|
1323 | Tables are very similar to figures. They should be input using the |
---|
1324 | \env{table} environment as detailed below, and |
---|
1325 | \LaTeX\ will label and number the captions TABLE~1, TABLE~2, etc. |
---|
1326 | (or in whatever format required by the chosen journal |
---|
1327 | substyle). Tables without captions won't be numbered. |
---|
1328 | |
---|
1329 | Each table must begin with \envb{table}, end with \enve{table}. A |
---|
1330 | caption can be specified using the \cmd\caption\marg{text} command. |
---|
1331 | Captions less than one line long are centered under the figure, |
---|
1332 | otherwise they span the width of the figure. |
---|
1333 | To refer to the table via cross-referencing, a \cmd\label\marg{key} |
---|
1334 | command should appear within the \cmd{\caption}. Use the |
---|
1335 | \cmd\ref\marg{key} command to cite tables in text. The \env{table} |
---|
1336 | environment will set the table to the width of the column. Thus, in |
---|
1337 | two-column mode, the table will confined to a single column. To set a |
---|
1338 | table to the full width of the page, rather than the column, use the |
---|
1339 | \env{table*} environment. |
---|
1340 | |
---|
1341 | The heart of the table is the |
---|
1342 | \env{tabular} environment. This will behave for the most part as in |
---|
1343 | standard \LaTeXe\ (please refer to Section~3.6.3 and Appendix~C.10.2 of the |
---|
1344 | \LUG{} for more details about the \env{tabular} environment). |
---|
1345 | Note that \revtex~4 no longer automatically adds double (Scotch) rules |
---|
1346 | around tables. Nor does the \env{tabular} environment set various |
---|
1347 | table parameters for column spacing as before. Instead, a new |
---|
1348 | environment \env{ruledtabular} provides this functionality. This |
---|
1349 | environment should surround the \env{tabular} environment: |
---|
1350 | \begin{verbatim} |
---|
1351 | \begin{table} |
---|
1352 | \caption{\label{<key>}....} |
---|
1353 | \begin{ruledtabular} |
---|
1354 | \begin{tabular} |
---|
1355 | ... |
---|
1356 | \end{tabular} |
---|
1357 | \end{ruledtabular} |
---|
1358 | \end{table} |
---|
1359 | \end{verbatim} |
---|
1360 | |
---|
1361 | A basic table looks as follows: |
---|
1362 | \begin{verbatim} |
---|
1363 | \begin{table} |
---|
1364 | \caption{\label{tab:example}Text of table caption.} |
---|
1365 | \begin{ruledtabular} |
---|
1366 | \begin{tabular}{ll} |
---|
1367 | Heading 1 & Heading 2\\ |
---|
1368 | Cell 1 & Cell 2\\ |
---|
1369 | \end{tabular} |
---|
1370 | \end{ruledtabular} |
---|
1371 | \end{table} |
---|
1372 | \end{verbatim} |
---|
1373 | |
---|
1374 | The \env{quasitable} environment is no longer in \revtex~4. The |
---|
1375 | standard \env{tabular} environment can be used instead because it |
---|
1376 | no longer puts in the double rules. |
---|
1377 | |
---|
1378 | \subsection{Aligning on a decimal point} |
---|
1379 | Numerical columns should align on the decimal point (or |
---|
1380 | decimal points if more than one is is present). This is accomplished |
---|
1381 | by again using a standard \LaTeXe\ package, \classname{dcolumn} which |
---|
1382 | must be loaded in the manuscript's preamble: |
---|
1383 | \begin{verbatim} |
---|
1384 | \usepackage{dcolumn} |
---|
1385 | \end{verbatim} |
---|
1386 | Once this package is loaded, the column specifier `\texttt{d}' can be |
---|
1387 | used in the table's \env{tabular}\marg{preamble} enviroment preamble. |
---|
1388 | The `\texttt{d}' should be used for simple numeric data with a single |
---|
1389 | decimal point. |
---|
1390 | % |
---|
1391 | The entry of a \texttt{d} column is typeset in math mode; do not |
---|
1392 | insert any \verb+$+ math delimiters into a `\texttt{d}' column. Items |
---|
1393 | without a decimal point are simply set in math mode, centered. If |
---|
1394 | text is required in the column, use \cmd\text\ or \cmd\mbox\ as |
---|
1395 | appropriate. If multiple decimal points are present then the last is |
---|
1396 | used for alignment. To escape from the `\texttt{d}' column use |
---|
1397 | \cmd\multicolumn\ as usual. See the sample file \file{apssamp.tex} for examples. |
---|
1398 | |
---|
1399 | \subsection{Footnotes in Tables}\label{sec:tablenote} |
---|
1400 | |
---|
1401 | Footnotes in a table are labeled \emph{a}, \emph{b}, \emph{c}, |
---|
1402 | etc. They can be specified by using the \LaTeX\ \cmd\footnote\ |
---|
1403 | command. Furthermore, |
---|
1404 | \cmd\footnotemark\ and \cmd\footnotetext\ can be used so that multiple entries |
---|
1405 | can to refer to the same footnote. The footnotes for a table are typeset |
---|
1406 | at the bottom of the table, rather than at the bottom of the page or |
---|
1407 | at the end of the references. The arguments for \cmd\footnotemark\ and |
---|
1408 | \cmd\footnotetext\ should be numbers 1, 2, \dots. The journal style |
---|
1409 | will convert these to letters. See sample file \file{apssamp.tex} for |
---|
1410 | examples and explanations of use. |
---|
1411 | |
---|
1412 | \subsection{Dealing with Long Tables} |
---|
1413 | By default, tables are set in a smaller size than the text body |
---|
1414 | (\cmd\small). The \cmd\squeezetable\ declaration makes the table font |
---|
1415 | smaller still (\cmd\scriptsize). Thus, putting the |
---|
1416 | \cmd\squeezetable\ command before the \envb{table} line in a table |
---|
1417 | will reduce the font size. If this isn't sufficient to fit |
---|
1418 | the table on a page, the standard \LaTeXe\ \classname{longtable} |
---|
1419 | package may be used. The scope of the |
---|
1420 | \cmd\squeezetable\ command must be limited by enclosing it with a group: |
---|
1421 | \begin{verbatim} |
---|
1422 | \begingroup |
---|
1423 | \squeezetable |
---|
1424 | \begin{table} |
---|
1425 | [...] |
---|
1426 | \end{table} |
---|
1427 | \endgroup |
---|
1428 | \end{verbatim} |
---|
1429 | |
---|
1430 | Tables are normally set to the width of the column in |
---|
1431 | which they are placed. This means that in two-column mode, the table |
---|
1432 | will be placed in a single, narrow column. For wide tables, the |
---|
1433 | \cmd\table\verb+*+ environment should be used |
---|
1434 | instead. This will place the table across both columns (the table |
---|
1435 | usually will |
---|
1436 | appear either at the top or the bottom of the following page). |
---|
1437 | |
---|
1438 | |
---|
1439 | Under \revtex~3, tables automatically break across pages; \revtex~4 |
---|
1440 | provides some of this functionality. However, this requires adding to the |
---|
1441 | table a float placement option of [H] (meaning put the table ``here'' |
---|
1442 | and effectively ``unfloating'' the table) to the \envb{table} |
---|
1443 | command. The commands \verb+\\*+ and \cmd{\samepage} can be used to |
---|
1444 | control where the page breaks occur (these are the same as for the |
---|
1445 | \env{eqnarray} environment). |
---|
1446 | |
---|
1447 | Long tables are more robustly handled by using the |
---|
1448 | \classname{longtable.sty} package included with the standard \LaTeXe\ |
---|
1449 | distribution (put \verb+\usepackage{longtable}+ in the preamble). This |
---|
1450 | package gives precise control over the layout of the table. |
---|
1451 | The \revtex~4 package contains patches that enable the |
---|
1452 | \classname{longtable} package to work in two-column mode. Of course, a |
---|
1453 | table set in two-column mode needs to be narrow enough to fit within |
---|
1454 | the column. Otherwise, the columns may overlap. \revtex~4 provides |
---|
1455 | an additional environment \env{longtable*} which allows a longtable to |
---|
1456 | span the whole page width. Currently, the \env{longtable*} and |
---|
1457 | \env{ruledtabular} environments are incompatible. In order to get the |
---|
1458 | double (Scotch) rule, it is necessary to add the \verb+\hline\hline+ |
---|
1459 | manually (or define \verb+\endfirsthead+ and \verb+\endlastfoot+ |
---|
1460 | appropriately). For more documentation on the \env{longtable} |
---|
1461 | environment and on the package options of the |
---|
1462 | \classname{longtable} package, please see the documentation available at |
---|
1463 | \url{ftp://ctan.tug.org/macros/latex/required/tools/longtable.dtx} or |
---|
1464 | refer to \cite{Compan}. |
---|
1465 | |
---|
1466 | \section{Placement of Figures, Tables, and Other Floats} |
---|
1467 | \label{sec:place} |
---|
1468 | |
---|
1469 | By default, figures and tables (and any other ``floating'' environments |
---|
1470 | defined by other packages) float to the top or bottom of the page |
---|
1471 | using the standard \LaTeX\ float placement mechanism. Initially, each |
---|
1472 | \env{figure} or \env{table} environment should be put immediately |
---|
1473 | following its first reference in the text; this will usually result in |
---|
1474 | satisfactory placement on the page. An optional argument for either |
---|
1475 | environment adjusts the float placement. For example: |
---|
1476 | \begin{quote} |
---|
1477 | \envb{figure}\oarg{placement}\\ |
---|
1478 | \dots\\ |
---|
1479 | \enve{figure} |
---|
1480 | \end{quote} |
---|
1481 | where \meta{placement} can be any combination of \verb|htbp!|, signifying |
---|
1482 | ``here'', ``top'', ``bottom'', ``page'', and ``as soon as possible'', |
---|
1483 | respectively. The same placement argument may be added to a |
---|
1484 | \envb{table}. For more details about float placement, |
---|
1485 | see the instructions in the \LUG, Appendix~C.9.1. |
---|
1486 | |
---|
1487 | In two-column mode, a page may contain both a \env{widetext} |
---|
1488 | environment and a float. \revtex~4 may not always be able to |
---|
1489 | automatically put the float in the optimal place. For instance, a |
---|
1490 | float may be placed at the bottom of a column just before the |
---|
1491 | \env{widetext} begins. To workaround this, try moving the float |
---|
1492 | environment below the \env{widetext} environment. Alternative |
---|
1493 | \meta{placements} may also alleviate the problem. |
---|
1494 | |
---|
1495 | \env{figure} and \env{table} environments should not |
---|
1496 | be enclosed in a \env{widetext} environment to make them span |
---|
1497 | the page to accomodate wide figures or tables. Rather, the |
---|
1498 | \env{figure*} or \env{table*} environments should be used instead. |
---|
1499 | |
---|
1500 | Sometimes in \LaTeX\ the float placement mechanism breaks down and a |
---|
1501 | float can't be placed. Such a ``stuck'' float may mean that it and all |
---|
1502 | floats that follow are moved to the end of the job (and if there are |
---|
1503 | too many of floats, the fatal error \texttt{Too many unprocessed floats} |
---|
1504 | will occur). \revtex~4 provides the class option |
---|
1505 | \classoption{floatfix} which attempts to invoke emergency float |
---|
1506 | processing to avoid creating a ``stuck'' float. \revtex~4 will provide |
---|
1507 | a message suggesting the use of |
---|
1508 | \classoption{floatfix}. If \classoption{floatfix} doesn't work or if |
---|
1509 | the resulting positioning of the float is poor, the float should be |
---|
1510 | repositioned by hand. |
---|
1511 | |
---|
1512 | \revtex~4 offers an additional possibility for placing the floats. By |
---|
1513 | using the either the \classoption{endfloats} or the |
---|
1514 | \classoption{endfloats*} class option all floats may be held |
---|
1515 | back (using an external file) and then set elsewhere in the document |
---|
1516 | using the the commands \cmd\printtables\ and \cmd\printfigures{}, |
---|
1517 | placed where the tables and figures are to be printed (usually at the |
---|
1518 | end of the document). (This is similar to the standard |
---|
1519 | \cmd\printindex\ command). Using a \texttt{*}-form of the commands |
---|
1520 | (\cmd\printfigures\verb+*+ and |
---|
1521 | \cmd\printtables\verb+*+) will begin the figures |
---|
1522 | or tables on a new page. Alternatively, the option |
---|
1523 | \classoption{endfloats*} may be used to change the behavior of the |
---|
1524 | non-\texttt{*}-forms so that every float will appear on a separate |
---|
1525 | page at the end. |
---|
1526 | |
---|
1527 | Without one of the \classoption{endfloats} class options, these float |
---|
1528 | placement commands are silently ignored, so it is always safe to use |
---|
1529 | them. If one of the \classoption{endfloats} class options is given, |
---|
1530 | but the \cmd\printtables\ command is missing, the tables will be |
---|
1531 | printed at the end of the document. Likewise, if \cmd\printfigures\ is |
---|
1532 | missing, the figures will be printed at the end of the document. |
---|
1533 | Therefore it is also safe to omit these commands as long as \revtex's |
---|
1534 | default choices for ordering figures and tables are satisfactory. |
---|
1535 | |
---|
1536 | The \classoption{endfloats} option (or perhaps some journal substyle |
---|
1537 | that invokes it), requires explicit \envb{figure}, \enve{figure}, |
---|
1538 | \envb{table}, and \enve{table} lines. In particular, do \emph{not} |
---|
1539 | define typing shortcuts for table and figure environments, such as |
---|
1540 | \begin{verbatim} |
---|
1541 | \def\bt{\begin{table}}% Incompatible! |
---|
1542 | \def\et{\end{table}}% |
---|
1543 | \end{verbatim} |
---|
1544 | |
---|
1545 | Please note that it is generally undesirable to have all floats moved |
---|
1546 | to the end of the manuscript. APS no longer requires this for |
---|
1547 | submissions. In fact, the editors and referees will have an easier time |
---|
1548 | reading the paper if the floats are set in their normal positions. |
---|
1549 | |
---|
1550 | \section{Rotating Floats} |
---|
1551 | |
---|
1552 | Often a figure or table is too wide to be typeset in the standard |
---|
1553 | orientation and it is necessary to rotate the float 90 |
---|
1554 | degrees. \revtex~4 provides a new environment \env{turnpage} as an |
---|
1555 | easy means to accomplish this. The \env{turnpage} environment depends |
---|
1556 | on one of the packages \classname{graphics} or \classname{graphicx} |
---|
1557 | being loaded. To use the \env{turnpage} environment, simply enclose |
---|
1558 | the \env{figure} or \env{table} environment with the \env{turnpage} |
---|
1559 | environment: |
---|
1560 | \begin{verbatim} |
---|
1561 | \documentclass[...]{revtex4} |
---|
1562 | \usepackage{graphicx} |
---|
1563 | [...] |
---|
1564 | \begin{turnpage} |
---|
1565 | \begin{figure} or \begin{table} |
---|
1566 | [...] |
---|
1567 | \end{figure} or \end{table} |
---|
1568 | \end{turnpage} |
---|
1569 | \end{verbatim} |
---|
1570 | A turnpage float will be typeset on a page by itself. Currently, there |
---|
1571 | is no mechanism for breaking such a float across multiple pages. |
---|
1572 | |
---|
1573 | \section{\revtex~4 symbols and the \classname{revsymb} package} |
---|
1574 | |
---|
1575 | Symbols made available in earlier versions of \revtex\ are |
---|
1576 | defined in a separate package, \classname{revsymb}, |
---|
1577 | so that they may be used with other classes. |
---|
1578 | This might be useful if, say, copying text from a \revtex\ document to |
---|
1579 | a non-\revtex\ document. \revtex~4 automatically includes these |
---|
1580 | symbols so it is not necessary to explicitly call them in with a |
---|
1581 | \cmd\usepackage\ statement. |
---|
1582 | |
---|
1583 | Table~\ref{tab:revsymb} summarizes the symbols defined in this package. |
---|
1584 | Note that \cmd{\overcirc}, \cmd{\overdots}, and \cmd{\corresponds} are |
---|
1585 | no longer in \revtex~4. Use \cmd{\mathring} (standard in \LaTeXe), |
---|
1586 | \cmd{\dddot} (with the \classoption{amsmath} package loaded), and |
---|
1587 | \cmd\triangleq\ (with the \classoption{amssymb} class option) respectively. |
---|
1588 | \cmd{\succsim}, \cmd{\precsim}, \cmd{\lesssim}, and \cmd{\gtrsim} are |
---|
1589 | also defined either in \classname{amsmath} or \classname{amssymb}. The |
---|
1590 | AMS versions of these commands will be used if the appropriate AMS |
---|
1591 | package is loaded. |
---|
1592 | |
---|
1593 | \begin{table} |
---|
1594 | \caption{\label{tab:revsymb}Special \revtex~4 symbols, accents, and |
---|
1595 | boldfaced parentheses defined in \file{revsymb.sty}} |
---|
1596 | \begin{ruledtabular} |
---|
1597 | \begin{tabular}{ll|ll} |
---|
1598 | \cmd\lambdabar & $\lambdabar$ &\cmd\openone & $\openone$\\ |
---|
1599 | \cmd\altsuccsim & $\altsuccsim$ & \cmd\altprecsim & $\altprecsim$ \\ |
---|
1600 | \cmd\alt & $\alt$ & \cmd\agt & $\agt$ \\ |
---|
1601 | \cmd\tensor\ x & $\tensor x$ & \cmd\overstar\ x & $\overstar x$ \\ |
---|
1602 | \cmd\loarrow\ x & $\loarrow x$ & \cmd\roarrow\ x & $\roarrow x$ \\ |
---|
1603 | \cmd\biglb\ ( \cmd\bigrb ) & $\biglb( \bigrb)$ & |
---|
1604 | \cmd\Biglb\ ( \cmd\Bigrb )& $\Biglb( \Bigrb)$ \\ |
---|
1605 | & & \\ |
---|
1606 | \cmd\bigglb\ ( \cmd\biggrb ) & $\bigglb( \biggrb)$ & |
---|
1607 | \cmd\Bigglb\ ( \cmd\Biggrb\ ) & $\Bigglb( \Biggrb)$ \\ |
---|
1608 | \end{tabular} |
---|
1609 | \end{ruledtabular} |
---|
1610 | \end{table} |
---|
1611 | |
---|
1612 | \section{Other \revtex~4 Features} |
---|
1613 | %\subsection{Hooks} |
---|
1614 | %To be written.... |
---|
1615 | |
---|
1616 | \subsection{Job-specific Override Files} |
---|
1617 | \revtex~4 allows manuscript-specific macro definitions to be put |
---|
1618 | in a file separate from the main \TeX\ file. One merely creates a file |
---|
1619 | with the same basename as the \TeX\ file, but with the extension |
---|
1620 | `.rty'. Thus, if the \TeX\ file is names man.tex, the macro |
---|
1621 | definitions would go in man.rty. Note that the .rty file should be in |
---|
1622 | the same directory as the \TeX\ file. APS authors should follow the |
---|
1623 | guidelines in the \textit{APS Compuscript Guide for \revtex~4} when |
---|
1624 | submitting. |
---|
1625 | |
---|
1626 | \begin{thebibliography}{}\label{sec:TeXbooks} |
---|
1627 | \bibitem[Knuth(1986)]{TeXbook} D.E. Knuth, \emph{The \TeX book}, |
---|
1628 | (Addison-Wesley, Reading, MA, 1986). |
---|
1629 | \bibitem[Lamport(1996)]{LaTeXman} L. Lamport, \emph{\LaTeX, a Document |
---|
1630 | Preparation System}, (Addison-Wesley, Reading, MA, 1996). |
---|
1631 | \bibitem[Kopka(1995)]{Guide} H. Kopka and P. Daly, \emph{A Guide to |
---|
1632 | \LaTeXe}, (Addison-Wesley, Reading, MA, 1995). |
---|
1633 | \bibitem[Goossens(1994)]{Compan} M. Goosens, F. Mittelbach, and |
---|
1634 | A. Samarin, \emph{The \LaTeX\ |
---|
1635 | Companion}, (Addison-Wesley, Reading, MA, 1994). |
---|
1636 | \bibitem[Goossens(1997)]{CompanG} M. Goossens, S. Rahtz, and |
---|
1637 | F. Mittelbach, \emph{The |
---|
1638 | \LaTeX\ Graphics Companion}, (Addison-Wesley, Reading, MA, 1997). |
---|
1639 | \bibitem[Rahtz(1999)]{CompanW} S. Rahtz, M. Goossens, \emph{et |
---|
1640 | al.},\emph{The \LaTeX\ Web Companion}, (Addison-Wesley, Reading, MA, 1999). |
---|
1641 | \end{thebibliography} |
---|
1642 | |
---|
1643 | \end{document} |
---|
1644 | |
---|