← Back to branch summary

~chris-rogers/maus/emr_mc_digitization

« back to all changes in this revision

Viewing changes to doc/doc_src/detectors/tracker/01-Current/99-Styles/revtex4-1/revtex4-1-tds/doc/latex/revtex/aip/aipguide4-1.tex

  • Committer: Chris Rogers
  • Date: 2014-04-16 11:48:45 UTC
  • mfrom: (707 merge)
  • mto: This revision was merged to the branch mainline in revision 711.
  • Revision ID: chris.rogers@stfc.ac.uk-20140416114845-h3u3q7pdcxkxvovs
Update to trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/doc_src/detectors/tracker/01-Current/99-Styles/revtex4-1/revtex4-1-tds/doc/latex/revtex/aip/aipguide4-1.tex
1
 
%% ****** Start of file auguide.tex ****** %
2
 
%%
3
 
%%   This file is part of the AIP distribution of substyles for REVTeX 4.1
4
 
%%   For version 4.1r of REVTeX, August 2010
5
 
%%
6
 
%%   Copyright (c) 2009,2010 American Institute of Physics
7
 
%%
8
 
\listfiles
9
 
\documentclass[%
10
 
 reprint,%
11
 
%secnumarabic,%
12
 
 amssymb, amsmath,%
13
 
 aip,cha,%
14
 
%groupedaddress,%
15
 
%frontmatterverbose,
16
 
]{revtex4-1}
17
 
 
18
 
\usepackage{docs}%
19
 
\usepackage{bm}%
20
 
\usepackage[colorlinks=true,linkcolor=blue]{hyperref}%
21
 
%\nofiles
22
 
\expandafter\ifx\csname package@font\endcsname\relax\else
23
 
 \expandafter\expandafter
24
 
 \expandafter\usepackage
25
 
 \expandafter\expandafter
26
 
 \expandafter{\csname package@font\endcsname}%
27
 
\fi
28
 
\hyphenation{title}
29
 
 
30
 
\begin{document}
31
 
 
32
 
\title{Author's Guide to AIP Substyles for \revtex~4.1}%
33
 
 
34
 
\author{AIP Journal Program}%
35
 
\email{tex@aip.org}
36
 
\affiliation{American Institute of Physics\\Suite 1NO1, 2 Huntington Quadrangle\\Melville, New York 11747-4502, USA}%
37
 
 
38
 
\date{March 2010}%
39
 
\revised{August 2010}%
40
 
 
41
 
\maketitle
42
 
 
43
 
\tableofcontents
44
 
 
45
 
\section{Introduction}
46
 
 
47
 
This is the author's guide to the AIP substyles for \revtex~4.1, 
48
 
providing a useful formatting tool 
49
 
for \LaTeX\ users submitting papers to journals 
50
 
published by the American Institute of Physics.
51
 
This guide is intended as an adjunct to the documentation for \revtex\ itself 
52
 
(published by the American Physical Society), 
53
 
so information contained therein is not repeated here, 
54
 
except as it bears on the specific features of the AIP substyles.
55
 
 
56
 
 
57
 
\subsection{Prerequisite Documentation}
58
 
 
59
 
The following documentation should be considered your first source of information 
60
 
on how to prepare your document for use with this format; 
61
 
they are to be found within the APS \revtex~4.1 distribution. 
62
 
Updated versions of these are maintained at
63
 
the \revtex~4.1 homepage located at \url{http://authors.aps.org/revtex4/},
64
 
are also available at the Comprehensive \TeX\ Archive Network (CTAN, see \url{http://www.ctan.org/}), 
65
 
and form part of the \TeX Live distribution of \TeX.
66
 
\begin{itemize}
67
 
\item \textit{Author's Guide to \revtex~4.1}
68
 
\item \textit{\revtex~4.1 Command and Options Summary}
69
 
\item \textit{What's New in \revtex~4.1}
70
 
\end{itemize}
71
 
The present guide builds upon these documents, with which you should already be familiar.
72
 
 
73
 
The AIP substyles distribution for \revtex~4.1 includes 
74
 
a sample document (\file{aipsamp.tex}), 
75
 
a good starting point for 
76
 
the manuscript you are preparing for submission to an AIP journal.
77
 
 
78
 
By using \revtex's \textit{Author's Guide to \revtex~4.1}, you can develop your
79
 
document until it contains all of the content you desire.
80
 
This guide informs you on document class options, commands, and 
81
 
markup guidelines specific to AIP journals. 
82
 
 
83
 
\subsection{Software Requirements}
84
 
 
85
 
This guide assumes a working \revtex~4.1 installation including the AIP substyles. 
86
 
Please see the installation guide included with the distribution.\cite{Note1}
87
 
 
88
 
Please note that the AIP substyles work {\it only} with \revtex~4.1: 
89
 
the original \revtex~4.0 release does {\it not} make the AIP substyle available, nor is it compatible with them. 
90
 
 
91
 
For your computer to run \revtex~4.1 with the AIP substyles, the following are required:
92
 
\begin{itemize}
93
 
\item
94
 
a working installation of \LaTeX\,
95
 
\item
96
 
\revtex~4.1 and all packages it requires,
97
 
\item
98
 
the AIP substyles for \revtex~4.1, and
99
 
\item
100
 
any further \LaTeX\ packages used in your document. 
101
 
\end{itemize}
102
 
 
103
 
The easiest way to obtain all of the needed software is to install an up-to-date distribution of \TeX,
104
 
like \TeX Live, available on CTAN.
105
 
 
106
 
To obtain the most up-to-date version of this software, please see \url{http://www.aip.org/pubservs/compuscript.html}.
107
 
 
108
 
 
109
 
\subsection{Submitting to AIP Journals}
110
 
 
111
 
Authors preparing a manuscript for submission to
112
 
AIP journals should consult the Information for Contributors for the applicable journal,
113
 
available through links at \url{http://journals.aip.org/}. 
114
 
These requirements are not covered systematically in this author's guide; 
115
 
you are responsible for understanding the requirements of the particular journal to which
116
 
you will submit your article.
117
 
 
118
 
For further information about journal requirements, contact the Editorial
119
 
Office of the appropriate journal. (Follow links at \url{http://journals.aip.org/}.)
120
 
 
121
 
\subsection{Contact Information}\label{sec:resources}%
122
 
Any bugs, problems, or inconsistencies concerning the AIP journal substyles
123
 
should be reported to AIP support at \href{mailto:tex@aip.org}{tex@aip.org}. 
124
 
Reports should include information on the error and a 
125
 
\textit{small} sample document that manifests the problem, if possible. 
126
 
(Please don't send large files!) 
127
 
 
128
 
Feedback concerning \revtex~4.1 itself should be sent, as usual, 
129
 
to the American Physical Society at\\ \href{mailto:revtex@aps.org}{revtex@aps.org}. 
130
 
 
131
 
To determine if the problem you are experiencing belongs to \revtex\ or is specific to the
132
 
AIP substyles, simply remove \texttt{aip} from your document class options and rerun 
133
 
your document. If the problem goes away, you may assume that it is due to the AIP substyles;
134
 
if not, it belongs to \revtex.
135
 
 
136
 
\section{Sample \LaTeXe\ Document}
137
 
As the \revtex\ documentation makes clear, your document employs a \LaTeXe\ document class
138
 
(specifically \texttt{revtex4-1.cls}), so you should use 
139
 
the \LaTeXe\ commands and environments familiar to you with, say, the
140
 
standard article class \texttt{revtex4-1.cls}, and you will be able to 
141
 
employ many of the packages you are used to using with \LaTeXe.
142
 
 
143
 
Using \texttt{aipsamp.tex} as an example, 
144
 
your document will start with the usual \revtex\ \cmd\documentclass\ statement, but with
145
 
a particular document class option \texttt{aip} that specifies the AIP substyle:
146
 
\begin{verbatim}
147
 
\documentclass[aip]{revtex4-1}
148
 
\end{verbatim}
149
 
You will then invoke the \LaTeXe\-compatible packages your document requires, say:
150
 
\begin{verbatim}
151
 
\usepackage{graphicx}%
152
 
\usepackage{dcolumn}%
153
 
\usepackage{bm}%
154
 
\end{verbatim}
155
 
follow up with your document content:
156
 
\begin{verbatim}
157
 
\begin{document}
158
 
...
159
 
\end{verbatim}
160
 
and finish with a statement specifying your Bib\TeX\ database:
161
 
\begin{verbatim}
162
 
\bibliography{aipsamp}
163
 
\end{document}
164
 
\end{verbatim}
165
 
 
166
 
The books
167
 
in the bibliography of this guide provide extensive coverage of all topics
168
 
pertaining to preparing documents under \LaTeXe\; they are highly recommended. 
169
 
 
170
 
\section{\revtex\ Class Options Specific to AIP}
171
 
 
172
 
\subsection{Journal Substyle}
173
 
To access particular features of the AIP substyle, you will specify an additional document class option: the journal substyle, e.g.,
174
 
\begin{verbatim}
175
 
\documentclass[aip,jcp]{revtex4-1}
176
 
\end{verbatim}
177
 
in this case, \textit{J. Chem. Phys.}, the default. 
178
 
A complete list of AIP journals with the corresponding journal substyle appears in Table~\ref{tab:journals}.
179
 
\begin{table}
180
 
\caption{\label{tab:journals}AIP journal substyles}
181
 
\begin{ruledtabular}
182
 
\begin{tabular}{ll}
183
 
\textbf{Journal} & \textbf{class option} \\
184
 
\itshape Appl. Phys. Lett. &\texttt{apl}\\
185
 
\itshape Biomicrofluidics  &\texttt{bmf}\\
186
 
\itshape Chaos             &\texttt{cha}\\
187
 
\itshape J. Appl. Phys.    &\texttt{jap}\\
188
 
\itshape J. Chem. Phys.    &\texttt{jcp}\footnotemark[1]\\
189
 
\itshape J. Math. Phys.    &\texttt{jmp}\\
190
 
\itshape J. Renewable Sustainable Energy&\texttt{rse}\\
191
 
\itshape Phys. Fluids      &\texttt{pof}\\
192
 
\itshape Phys. Plasmas     &\texttt{pop}\\
193
 
\itshape Rev. Sci. Instrum.&\texttt{rsi}\\
194
 
\end{tabular}
195
 
\end{ruledtabular}
196
 
\footnotetext[1]{Default journal substyle.}
197
 
\end{table}
198
 
 
199
 
\subsection{Options for Citations and Bibliography}
200
 
The citation style for AIP journals is:
201
 
\begin{itemize}
202
 
\item 
203
 
numerical (default style), 
204
 
\item
205
 
author-year, and
206
 
\item
207
 
numerical author-year,
208
 
\end{itemize}
209
 
the latter two styles being only allowed for \textit{Chaos} or \textit{J. Math. Phys.}
210
 
 
211
 
The familiar numerical citations and numbered bibliography are the default for most journals: 
212
 
citations are superscript numbers, and the (numbered) bibliographic entries appear in the order cited. 
213
 
 
214
 
Author-year citations are only allowed for 
215
 
\textit{Chaos} or \textit{J. Math. Phys.}, with citations given in author-and-year format. 
216
 
Bibliographic entries are sorted by alphabetical order of first author's surname, then by year. 
217
 
 
218
 
Numerical author-year citations 
219
 
(only allowed for \textit{Chaos} or \textit{J. Math. Phys.}) 
220
 
are superscript numbers, just like numerical citations, 
221
 
but the bibliographic entries are sorted like the author-year entries and are numbered. 
222
 
This means that the first citation will not necessarily be~1.
223
 
 
224
 
To obtain the numerical style, simply accept the default, or supply a class option of \texttt{numerical}:
225
 
\begin{verbatim}
226
 
\documentclass[aip,numerical]{revtex4-1}
227
 
\end{verbatim}
228
 
For author-year citations for \textit{Chaos} or \textit{J. Math. Phys.}, 
229
 
you may specify the \texttt{author-year} option:
230
 
\begin{verbatim}
231
 
\documentclass[aip,author-year]{revtex4-1}
232
 
\end{verbatim}
233
 
Each of the above two options are part of standard \revtex.
234
 
 
235
 
To obtain numerical author-year citations 
236
 
for \textit{Chaos} or \textit{J. Math. Phys.}, 
237
 
give the author-numerical option:
238
 
\begin{verbatim}
239
 
\documentclass[aip,author-numerical]{revtex4-1}
240
 
\end{verbatim}
241
 
Note that the \texttt{author-numerical} option is not part of standard \revtex\, so use of it
242
 
outside of the AIP substyles may not have any effect. 
243
 
 
244
 
\subsection{Formatting Options}
245
 
There are two commonly used formats for an article you may write. 
246
 
One will comply with the manuscript submission formatting requirements of the editorial office of the journal you are submitting to.
247
 
The other will emulate the format of your article in the published journal itself. 
248
 
 
249
 
For journal submission, accept the default, or you may specify the \texttt{preprint} option:
250
 
\begin{verbatim}
251
 
\documentclass[aip,preprint]{revtex4-1}
252
 
\end{verbatim}
253
 
To emulate the formatting of the journal, specify the \texttt{reprint} option:
254
 
\begin{verbatim}
255
 
\documentclass[aip,reprint]{revtex4-1}
256
 
\end{verbatim}
257
 
Note that emulation is not by any means complete: the fonts used will differ, and therefore
258
 
the length of the article will not represent an accurate estimate. 
259
 
Other details may also differ. 
260
 
 
261
 
A summary of class options of interest to AIP authors appears in Table~\ref{tab:options}.
262
 
\begin{table}
263
 
\caption{\label{tab:options}Other class options}
264
 
\begin{ruledtabular}
265
 
\begin{tabular}{ll}
266
 
\textbf{Function} & \textbf{class option} \\
267
 
\multicolumn{2}{l}{\textit{Citation and References}}\\
268
 
superscript numbered&\texttt{numerical}\footnotemark[1]\textsuperscript{,}\footnotemark[2]\\
269
 
author-year&\texttt{author-year}\footnotemark[3]\\
270
 
numbered author-year&\texttt{author-numerical}\footnotemark[3]\\
271
 
%
272
 
\multicolumn{2}{l}{\textit{Format}}\\
273
 
journal submission&\texttt{preprint}\footnotemark[1]\\
274
 
journal emulation&\texttt{reprint}\\
275
 
\end{tabular}
276
 
\end{ruledtabular}
277
 
\footnotetext[1]{Default option.}%
278
 
\footnotetext[2]{Standard}%
279
 
\footnotetext[3]{Only allowed for \textit{Chaos} or \textit{J. Math. Phys.}}%
280
 
\end{table}
281
 
 
282
 
\section{Useful \LaTeXe\ Markup}
283
 
\LaTeXe\ markup is the preferred way to structure your file. 
284
 
In general, the use of low-level commands like \TeX\ primitives or Plain \TeX\ macros 
285
 
is less preferable. 
286
 
Please see the \revtex\ User's Guide,\cite{Note2} 
287
 
the \LaTeX\ manual,\cite{LaTeXman} 
288
 
and the \LaTeXe\ book\cite{Compan} 
289
 
for further details. 
290
 
 
291
 
\subsection{Title and Front Matter}\label{sec:front}
292
 
 
293
 
The \revtex\ User's Guide has complete information on using \revtex's special markup for your
294
 
article's title, author list, abstract, and other front matter elements. 
295
 
Note that class option \texttt{superscriptaddress} is the default for the AIP substyles, 
296
 
as required by all AIP journals. 
297
 
 
298
 
\subsection{Lead Paragraph}
299
 
One AIP journal, \textit{Chaos}, requires a paragraph of text to precede the first
300
 
\cmd\section\ of the article; 
301
 
this is known as a lead paragraph and is formatted boldface. 
302
 
To give your article a lead paragraph, 
303
 
include a quotation environment ahead of the first \cmd\section\ command:
304
 
\begin{verbatim}
305
 
\documentclass[aip]{revtex4-1}
306
 
\begin{document}
307
 
 \begin{quotation}
308
 
  Here is my lead paragraph!
309
 
 \end{quotation}
310
 
 \section{Introduction}
311
 
...
312
 
\end{verbatim}
313
 
 
314
 
The \texttt{quotation} environment functions normally after the first \cmd\section\ command in the document.
315
 
 
316
 
\section{Body}
317
 
 
318
 
For general information on commands used in the body of the document, see the \revtex\ User's Guide.
319
 
Herein are some features specific to the AIP author.
320
 
 
321
 
\subsection{Footnotes}
322
 
 
323
 
If you are using numbered citations (numerical or numbered author-year), 
324
 
footnotes are by default incorporated into the reference section 
325
 
along with your bibliographic entries. 
326
 
This automated feature is only effective if you use Bib\TeX\ to prepare your
327
 
bibliography. 
328
 
 
329
 
Author-year style bibliography does not lend itself to such a treatment, 
330
 
so by default footnotes appear in text as is usual. 
331
 
However, be advised that, if your article is accepted for publication,
332
 
footnotes may be incorporated into text during the production process.
333
 
 
334
 
\section{Citations and References}\label{sec:endnotes}
335
 
 
336
 
The preparation of your bibliography ``by hand'' is possible; 
337
 
however, if you do so, 
338
 
you will be entirely responsible 
339
 
for compliance with submission requirements for your bibliographic entries, 
340
 
for incorporating any text footnotes into the references, 
341
 
and for checking bibliographic entries. 
342
 
(In this connection, you may find useful the file \texttt{reftest.tex}, distributed with \revtex.)
343
 
 
344
 
There are numerous reasons to use Bib\TeX, not least because it automates the first and second of the above checks. 
345
 
 
346
 
\subsection{\label{sec:use-bib}Using Bib\protect\TeX}
347
 
 
348
 
Refer to the \revtex\ User's Guide, the \LaTeX\ manual, and the Bib\TeX\ manual
349
 
for full information about using Bib\TeX. 
350
 
 
351
 
When using Bib\TeX\, keep in mind that changing your bibliography style or citation style
352
 
(via the document class options described above) will require you to rerun Bib\TeX.
353
 
The standard litany (using \texttt{aipsamp.tex} as an example) for this is:
354
 
\begin{verbatim}
355
 
> latex aipsamp
356
 
> bibtex aipsamp
357
 
> latex aipsamp
358
 
> latex aipsamp
359
 
\end{verbatim}
360
 
Here, the first invocation of \texttt{latex} has the effect of rewriting the
361
 
\texttt{aipsamp.aux} file,
362
 
and the invocation of \texttt{bibtex} creates a new \texttt{aipsamp.bbl} file. 
363
 
The next two runs of \texttt{latex} are then required: 
364
 
the first to update the \texttt{aipsamp.aux} file reflecting the new values of your citations
365
 
and the second to employ those citations correctly. 
366
 
Be sure to check the end of the \texttt{aipsamp.log} file for any message advising you to 
367
 
rerun \texttt{latex}. 
368
 
 
369
 
\subsection{Multiple References per Citation}
370
 
In an article using numerical citations, 
371
 
it is not uncommon to encounter the need for a citation 
372
 
that refers to more than one article or other reference. 
373
 
To accommodate such a case, \revtex~4.1 implements markup similar to that of the 
374
 
\texttt{mcite} package for \LaTeXe. 
375
 
 
376
 
Let's say that two citation keys \texttt{able} and \texttt{baker} 
377
 
need to be combined into a single reference.
378
 
The syntax for the \cmd\cite\ command is:
379
 
\begin{verbatim}
380
 
word\cite{able,*baker} further text
381
 
\end{verbatim}
382
 
When you run Bib\TeX\, the resulting bibliography will contain the two entries, but run together
383
 
as a single numbered reference.
384
 
In the \cmd\cite\ command argument, any cite key that starts with the * character
385
 
signifies that its bibliographic entry is to be joined together with the one preceding it;
386
 
the \texttt{*} may join together any number of entries into a single reference.
387
 
 
388
 
\begin{thebibliography}{9}\label{sec:TeXbooks}%
389
 
\bibitem{Note1}
390
 
For help regarding the installation of this software and its use, please send email to \href{mailto:tex@aip.org}{tex@aip.org}.
391
 
%
392
 
\bibitem{Note2}
393
 
Available with the \revtex\ distribution, see \url{http://authors.aps.org/revtex4/}.
394
 
%
395
 
\bibitem[Lamport(1996)]{LaTeXman} 
396
 
L. Lamport, 
397
 
\emph{\LaTeX\, a Document Preparation System} 
398
 
(Addison-Wesley, Reading, MA, 1996).
399
 
%
400
 
\bibitem[Goossens(1994)]{Compan} 
401
 
M. Goosens, F. Mittelbach, and A. Samarin, 
402
 
\emph{The \LaTeX\ Companion} 
403
 
(Addison-Wesley, Reading, MA, 1994).
404
 
%
405
 
\bibitem[Knuth(1986)]{TeXbook} 
406
 
D. E. Knuth, 
407
 
\emph{The \TeX book} 
408
 
(Addison-Wesley, Reading, MA, 1986). 
409
 
%
410
 
\bibitem[Kopka(1995)]{Guide} 
411
 
H. Kopka and P. Daly, 
412
 
\emph{A Guide to \LaTeXe} 
413
 
(Addison-Wesley, Reading, MA, 1995).
414
 
%
415
 
\bibitem[Goossens(1997)]{CompanG} 
416
 
M. Goossens, S. Rahtz, and F. Mittelbach, 
417
 
\emph{The \LaTeX\ Graphics Companion} 
418
 
(Addison-Wesley, Reading, MA, 1997).
419
 
%
420
 
\bibitem[Rahtz(1999)]{CompanW} 
421
 
S. Rahtz, M. Goossens \emph{et al.},
422
 
\emph{The \LaTeX\ Web Companion} 
423
 
(Addison-Wesley, Reading, MA, 1999).
424
 
%
425
 
\end{thebibliography}
426
 
 
427
 
\end{document}
428