Debian Codegraph @

texmf-dist/source/latex/revtex4-1/revtex4-1.dtx

raw
1 % \iffalse meta-comment balanced on line 122
2 % revtex4-1.dtx: package to typeset APS, AIP, OSA, ASA, etc. journal articles
3 % Copyright (c) 2009 The American Physical Society.
4 % http://publish.aps.org/revtex4/
5 % mailto:[email protected]
6 %
7 % Disclaimer
8 % This file is distributed WITHOUT ANY WARRANTY;
9 % without even the implied warranty of
10 % MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11 % License
12 % You may distribute this file under the conditions of the
13 % LaTeX Project Public License 1.3 or later
14 % (http://www.latex-project.org/lppl.txt).
15 % ReadMe
16 % For the documentation and more detailed instructions for
17 % installation, typeset this document with \LaTeX.
18 % Maintenance Status
19 % This work has the LPPL maintenance status "maintained";
20 % Current Maintainer of this work is Arthur Ogawa.
21 %
22 % This work consists of the main source file revtex4-1.dtx
23 % and the derived files
24 % revtex4.cls, revtex4.pdf
25 % Distribution:
26 % CTAN:macros/latex/contrib/revtex/
27 %
28 % Unpacking:
29 % tex revtex4-1.dtx
30 %
31 % Documentation:
32 % latex revtex4-1.dtx; ...
33 %
34 % Programm calls to get the documentation (example):
35 % pdflatex revtex4-1.dtx
36 % makeindex -s gind.ist revtex4-1.idx
37 % makeindex -s gglo.ist -o revtex4-1.gls revtex4-1.glo
38 % pdflatex revtex4-1.dtx
39 % makeindex -s gind.ist revtex4-1.idx
40 % pdflatex revtex4-1.dtx
41 %
42 % Installation:
43 % TDS:bibtex/bst/revtex/
44 % TDS:doc/latex/revtex/
45 % TDS:tex/latex/revtex/
46 % TDS:source/latex/revtex/
47 %
48 % Thanks, Heiko!
49 % This method of letting a single .dtx file serve as both
50 % documentation (via latex) and installer (via tex) follows
51 % the example of Heiko Oberdiek. Thanks!
52 %<*ignore>
53 \begingroup
54 \def\x{LaTeX2e}%
55 \expandafter\endgroup
56 \ifcase
57 0\expandafter\ifx\csname processbatchFile\endcsname\relax\else1\fi\ifx\fmtname\x\else 1\fi
58 \relax
59 \else
60 \csname fi\endcsname
61 %</ignore>
62 %<*install>
63 %% This file will generate documentation and runtime files
64 %% from revtex4-1.dtx when run through TeX.
65 \input docstrip
66 \preamble
67
68 This file is part of the APS files in the REVTeX 4 distribution.
69 For the version number, search on the string %FileInfo
70
71 Original version by David Carlisle
72 Modified by Arthur Ogawa (mailto:arthur_ogawa at sbcglobal dot net)
73
74 Copyright (c) 2009 The American Physical Society.
75 http://publish.aps.org/revtex4/
76 mailto:[email protected]
77
78 See the REVTeX 4 README file for restrictions and more information.
79
80 \endpreamble
81 \askforoverwritefalse
82 \keepsilent
83 \generate{%
84 \file{revtex4-1.cls}{%
85 \from{revtex4-1.dtx}{kernel}%
86 \from{ltxutil.dtx}{kernel}%
87 \from{ltxfront.dtx}{kernel}%
88 \from{ltxgrid.dtx}{kernel}%
89 \from{revtex4-1.dtx}{options}%
90 \from{ltxutil.dtx}{options}%
91 \from{ltxfront.dtx}{options}%
92 \from{ltxgrid.dtx}{options}%
93 \from{revtex4-1.dtx}{package}%
94 }%
95 \file{aps4-1.rtx}{\from{revtex4-1.dtx}{aps}}%
96 \file{apsrmp4-1.rtx}{\from{revtex4-1.dtx}{rmp}}%
97 \file{aps10pt4-1.rtx}{\from{revtex4-1.dtx}{10pt}}%
98 \file{aps11pt4-1.rtx}{\from{revtex4-1.dtx}{11pt}}%
99 \file{aps12pt4-1.rtx}{\from{revtex4-1.dtx}{12pt}}%
100 \file{revsymb4-1.sty}{\from{revtex4-1.dtx}{revsymb}}%
101 }%
102 \ifToplevel{
103 \Msg{***********************************************************}
104 \Msg{*}
105 \Msg{* To finish the installation, please move}
106 \Msg{* *.cls, *.rtx, and *.sty }
107 \Msg{* into a directory searched by TeX;}
108 \Msg{* in a TDS-compliant installation:}
109 \Msg{* texmf/tex/macros/latex/revtex/.}
110 \Msg{*}
111 \Msg{* To produce the documentation,
112 run revtex4-1.dtx through LaTeX.}
113 \Msg{*}
114 \Msg{* Happy TeXing}
115 \Msg{***********************************************************}
116 }
117 \endbatchfile
118 %</install>
119 %<*ignore>
120 \fi
121 %</ignore>
122 % \fi
123 %
124 % \GetFileInfo{revtex4-1.dtx}
125 %
126 % \iffalse ltxdoc klootch
127 %<*package>
128 %%% @LaTeX-file{
129 %%% filename = "revtex4-1.dtx",
130 %%% version = "4.1s",
131 %%% date = "2020/09/30",
132 %%% author = "Arthur Ogawa (mailto:arthur_ogawa at sbcglobal.net),
133 %%% commissioned by the American Physical Society.
134 %%% ",
135 %%% copyright = "Copyright (C) 1999, 2009 Arthur Ogawa,
136 %%% distributed under the terms of the
137 %%% LaTeX Project Public License, see
138 %%% ftp://ctan.tug.org/macros/latex/base/lppl.txt
139 %%% ",
140 %%% address = "Arthur Ogawa,
141 %%% USA",
142 %%% telephone = "",
143 %%% FAX = "",
144 %%% email = "mailto colon arthur_ogawa at sbcglobal.net",
145 %%% codetable = "ISO/ASCII",
146 %%% keywords = "latex, page grid, main vertical list",
147 %%% supported = "yes",
148 %%% abstract = "package to change page grid, MVL",
149 %%% }
150 %</package>
151 % \fi
152 %
153 % \iffalse ltxdoc klootch
154 % The following references the \file{00readme.tex} file,
155 % which contains the frontmatter for the programmer's docs.
156 % The contents of this file are generated when
157 % you typeset this file with LaTeX.
158 % Search on "{filecontents*}{00readme.tex}" to locate it.
159 % \fi\input{00readme.tex}%
160 %
161 % \subsection{Bill of Materials}
162 %
163 % Following is a list of the files in this distribution arranged
164 % according to provenance.
165 %
166 % \subsubsection{Primary Source}%
167 % One single file generates all.
168 %\begin{verbatim}
169 %revtex4-1.dtx
170 %\end{verbatim}
171 %
172 % \subsubsection{Generated by \texttt{tex revtex4-1.dtx}}%
173 % Typesetting ths file under \TeX\ itself runs the installer,
174 % which generates the package files.
175 %\begin{verbatim}
176 %revtex4-1.cls, revtex4.ins, revtex4.drv, aps4-1.rtx,
177 %aps10pt4-1.rtx, aps11pt4-1.rtx, aps12pt4-1.rtx, revsymp.sty
178 %\end{verbatim}
179 %
180 % \subsubsection{Generated by \texttt{pdflatex revtex4-1.dtx}}%
181 % Typesetting the source file under \LaTeX\
182 % generates the documentation.
183 %\begin{verbatim}
184 %revtex4.pdf,
185 %\end{verbatim}
186 %
187 % \subsubsection{Auxiliary}%
188 % The following are auxiliary files generated
189 % in the course of running \LaTeX:
190 % \begin{verbatim}
191 %revtex4.aux revtex4.idx revtex4.ind revtex4.log revtex4.toc
192 % \end{verbatim}
193 %
194 % \section{Code common to all modules}%
195 %
196 % The following may look a bit klootchy, but we
197 % want to require only one place in this file
198 % where the version number is stated,
199 % and we also want to ensure that the version
200 % number is embedded into every generated file.
201 %
202 % Now we declare that
203 % these files can only be used with \LaTeXe.
204 % An appropriate message is displayed if
205 % a different \TeX{} format is used.
206 % \begin{macrocode}
207 %<*doc|kernel|aps|rmp|revsymb>
208 \NeedsTeXFormat{LaTeX2e}[1996/12/01]%
209 %</doc|kernel|aps|rmp|revsymb>
210 %<kernel>\ProvidesClass{revtex4-1}
211 %<aps>\ProvidesFile{aps4-1}
212 %<rmp>\ProvidesFile{apsrmp4-1}
213 %<10pt>\ProvidesFile{aps10pt4-1}
214 %<11pt>\ProvidesFile{aps11pt4-1}
215 %<12pt>\ProvidesFile{aps12pt4-1}
216 %<revsymb>\ProvidesPackage{revsymb4-1}
217 %<*doc>
218 \ProvidesFile{revtex4-1.dtx}
219 %</doc>
220 %<*!package&!options>
221 %<version>
222 [2020/09/30 4.1s (http://publish.aps.org/revtex4/ for documentation)]% \fileversion
223 %</!package&!options>
224 % \end{macrocode}
225 % The current class name is remembered in \cmd\class@name.
226 % This is something of a klootch, relying as it does on knowledge of the implementation of \cmd\ProvidesPackage.
227 % \begin{macrocode}
228 %<kernel>\let\class@name\@gtempa
229 % \end{macrocode}
230 %
231 % \section{The driver module \texttt{driver}}
232 %
233 % This module, consisting of the present section,
234 % typesets the programmer's documentation,
235 % generating the \file{00readme.txt} and sample document as needed.
236 %
237 % Because the only uncommented-out lines of code at the beginning of
238 % this file constitute the \file{driver} module itself,
239 % we can simply typeset the \file{.dtx} file directly,
240 % and there is thus rarely any need to
241 % generate the ``driver'' {\sc docstrip} module.
242 % Module delimiters are nonetheless required so that
243 % this code does not find its way into the other modules.
244 %
245 % The \enve{document} command concludes the typesetting run.
246 %
247 % \begin{macrocode}
248 %<*doc>
249 % \end{macrocode}
250 % The driver uses packages \file{ltxdoc.sty}, \file{ltxdocext.sty},
251 % \file{hyperref.sty}, and whatever font package has been selected.
252 % \begin{macrocode}
253 \documentclass{ltxdoc}
254 \RequirePackage{ltxdocext}%
255 \let\url\undefined
256 \RequirePackage[colorlinks=true,linkcolor=blue]{hyperref}%
257 \makeatletter
258 \@ifundefined{package@font}{}%
259 {\expandafter\RequirePackage\expandafter{\csname package@font\endcsname}}
260 \makeatother
261 % \end{macrocode}
262 % We ask for the usual indices and glossaries.
263 % \begin{macrocode}
264 \CodelineIndex\EnableCrossrefs % makeindex -s gind.ist revtex4
265 \RecordChanges % makeindex -s gglo.ist -o revtex4.gls revtex4.glo
266 % \end{macrocode}
267 %
268 % \subsubsection{Docstrip and info directives}
269 % We use so many {\sc docstrip} modules that we set the
270 % \texttt{StandardModuleDepth} counter to 1.
271 % \begin{macrocode}
272 \setcounter{StandardModuleDepth}{1}
273 % \end{macrocode}
274 % The following command retrieves the date and version information
275 % from this file.
276 % \begin{macrocode}
277 \expandafter\GetFileInfo\expandafter{\jobname.dtx}%
278 % \end{macrocode}
279 %
280 % \subsection{The Frontmatter File}
281 % As promised above, here is the contents of the frontmatter file.
282 % \begin{macrocode}
283 \begin{filecontents*}[overwrite]{00readme.tex}
284 \title{%
285 The \classname{revtex4-1} document class of the American Physical Society%
286 \protect\thanks{Work under hire to The American Physical Society.}%
287 }%
288 \author{Arthur Ogawa%
289 \protect\thanks{First revision of REV\TeX4.0 (unreleased) by David Carlisle}%
290 }%
291 \date{Version \fileversion, dated \filedate}%
292 \newcommand\revtex{REV\TeX}
293
294 \maketitle
295
296 This file embodies the implementation of the APS \revtex\ 4.1 document class
297 for electronic submissions to journals.
298
299 The distribution point for this work is
300 \url{http://publish.aps.org/revtex4/},
301 which contains fully unpacked, prebuilt runtime files and documentation.
302
303 \tableofcontents
304
305 \section{Using \protect\revtex}
306
307 The file \file{README} has retrieval and installation information.
308
309 User documentation is presented separately in \file{auguide.tex}.
310
311 The file \file{template.aps} is a boilerplate file.
312
313 \changes{4.0a}{1998/01/16}{Initial version}
314 \changes{4.0a}{1998/01/31}{Move after process options, so \cs{clearpage} not in scope of twocolumn}
315 \changes{4.0a}{1998/01/31}{Rearrange the ordering so numerical ones come first. AO: David, what does this mean?}
316 \changes{4.0a}{1998/01/31}{use font-dependent spacing}
317 \changes{4.0a}{1998/01/31}{4.0d had twoside option setting twoside switch to false}
318 \changes{4.0a}{1998/01/31}{Move after process options, so the following test works}
319 \changes{4.0a}{1998/01/31}{print homepage}
320 \changes{4.0a}{1998/01/31}{protect against hyperref revtex kludges which are not needed now}
321 \changes{4.0a}{1998/06/10}{multiple preprint commands}
322 \changes{4.0a}{1998/06/10}{comma not space between email and homepage}
323 \changes{4.0a}{1998/06/10}{single space footnotes}
324 \changes{4.0b}{1999/06/20}{First modifications by Arthur Ogawa (mailto:arthur\_ogawa at sbcglobal dot net)}
325 \changes{4.0b}{1999/06/20}{Added localization of \cs{figuresname}}
326 \changes{4.0b}{1999/06/20}{Added localization of \cs{tablesname}}
327 \changes{4.0b}{1999/06/20}{AO: all code for \protect\classoption{10pt} is in this module.}
328 \changes{4.0b}{1999/06/20}{AO: all code for \protect\classoption{11pt} is in this module.}
329 \changes{4.0b}{1999/06/20}{AO: all code for \protect\classoption{12pt} is in this module.}
330 \changes{4.0b}{1999/06/20}{AO: made aps.rtx part of revtex4.dtx}
331 \changes{4.0b}{1999/06/20}{AO: remove duplicates}
332 \changes{4.0b}{1999/06/20}{call \cs{print@floats}}
333 \changes{4.0b}{1999/06/20}{Defer assignment until \cs{AtBeginDocument} time.}
334 \changes{4.0b}{1999/06/20}{Defer decision until \cs{AtBeginDocument} time}
335 \changes{4.0b}{1999/06/20}{Define three separate environments, defer assignment to \cs{AtBeginDocument} time.}
336 \changes{4.0b}{1999/06/20}{Frank Mittelbach, has stated in \protect\classname{multicol}: ``The kernel command \cs{@footnotetext} should not be modified.'' Thus, I have removed David Carlisle's redefinition of that command. Note, however, that later versions of \protect\classname{multicol} do not require this workaround. Belt and suspenders.}%
337 \changes{4.0b}{1999/06/20}{Move this ``complex'' option to the front, where it can be overridden by ``simple'' options.}
338 \changes{4.0b}{1999/06/20}{New option}
339 \changes{4.0b}{1999/06/20}{One-line caption sets flush left.}
340 \changes{4.0b}{1999/06/20}{only execute if appropriate}
341 \changes{4.0b}{1999/06/20}{Processing delayed to \cs{AtBeginDocument} time}
342 \changes{4.0b}{1999/06/20}{Removed invocation of nonexistent class option \protect\classoption{groupauthors} and all other class options that should only be invoked by the document. (Otherwise precedence of class options does not work.)}
343 \changes{4.0b}{1999/06/20}{Restore all media size class option of \protect\file{classes.dtx}}
344 \changes{4.0b}{1999/06/20}{Stack \cs{preprint} args flush right at right margin.}
345 \changes{4.0c}{1999/11/13}{(AO, 115) If three or more preprints specified, set on single line, with commas.}
346 \changes{4.0c}{1999/11/13}{(AO, 129) section* within appendix was producing appendixname}
347 \changes{4.0c}{1999/11/13}{*-form mandates pagebreak}
348 \changes{4.0c}{1999/11/13}{also spelled ``acknowledgements''.}
349 \changes{4.0c}{1999/11/13}{Do not put by REVTeX in every page foot}
350 \changes{4.0c}{1999/11/13}{grid changes via ltxgrid procedures}
351 \changes{4.0c}{1999/11/13}{grid changes with ltxgrid}
352 \changes{4.0c}{1999/11/13}{Insert procedure \cs{checkindate}}
353 \changes{4.0c}{1999/11/13}{Lose compatability mode.}
354 \changes{4.0c}{1999/11/13}{New ltxgrid-based code, other bug fixes}
355 \changes{4.0c}{1999/11/13}{New option ``checkin''}
356 \changes{4.0c}{1999/11/13}{Prevent an inner footnote from performing twice}
357 \changes{4.0d}{2000/04/10}{Also alter how lists get indented.}
358 \changes{4.0d}{2000/04/10}{eprint takes an optional argument, syntactical only in this case.}
359 \changes{4.0d}{2000/04/10}{New option}
360 \changes{4.0d}{2000/05/10}{More features and bug fixes: compatability with longtable and array packages. Now certainly incompatible with multicol.}
361 \changes{4.0d}{2000/05/17}{make longtable trigger the head, too}
362 \changes{4.0d}{2000/05/18}{But alternative spelling is deprecated.}
363 \changes{4.0e}{2000/09/20}{New option showkeys}
364 \changes{4.0e}{2000/11/14}{Bug fixes and minor new features: title block affiliations can have ancillary data, just like authors; clearpage processing revamped, with floats staying in order; widetext ornaments.}
365 \changes{4.0e}{2000/11/21}{adornments above and below.}
366 \changes{4.0f}{2001/02/13}{Last bug fixes before release.}
367 \changes{4.0rc1}{2001/06/17}{Running headers always as if two-sided}
368 \changes{4.0rc1}{2001/06/18}{grid changes with push and pop}
369 \changes{4.0rc1}{2001/06/18}{grid changes with push and pop}
370 \changes{4.0rc4}{2001/07/23}{hyperref is no longer loaded via class option: use a usepackage statement instead}
371 \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
372 \changes{4.1a}{2008/01/18}{(AO, 451) ``Cannot have more than 256 cites in a document''}%
373 \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
374 \changes{4.1a}{2008/01/18}{(AO, 460) ``Proper style is "FIG. 1. ..." (no colon)''}%
375 \changes{4.1a}{2008/01/18}{(AO, 478) \cs{ds@letterpaper}, so that ``letterpaper really is the default''}%
376 \changes{4.1a}{2008/01/18}{(AO, 488) Change processing of options to allow an unused option to specify society and journal}%
377 \changes{4.1a}{2008/01/19}{(AO, 461) Change the csname revtex uses from @dotsep to ltxu@dotsep. The former is understood in mu. (What we wanted was a dimension.)}%
378 \changes{4.1a}{2008/01/19}{For natbib versions before 8.21, \cs{NAT@sort} was consulted only as natbib was being read in. Now it is fully dynamic.}
379 \changes{4.1b}{2008/05/29}{The csname substyle@ext is now defined without a dot (.), to be compatible with \LaTeX usage (see @clsextension and @pkgextension).}
380 \changes{4.1b}{2008/06/01}{(AO) Implement bibnotes through \cs{frontmatter@footnote@produce} instead of \cs{bibnotes@sw}}%
381 \changes{4.1b}{2008/06/01}{Add option reprint, opposite of preprint, and preferred alternative to twocolumn}
382 \changes{4.1b}{2008/06/29}{(AO, 455) Be nice to a list within the abstract (assign \cs{@totalleftmargin}).}
383 \changes{4.1b}{2008/06/30}{(AO) Structure the Abstract using the \texttt{bibliography} environment}
384 \changes{4.1b}{2008/07/01}{(AO) coordinate \cs{if@twoside} with \cs{twoside@sw}}
385 \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
386 \changes{4.1b}{2008/07/01}{(AO) No longer need to test \cs{chapter} as of \texttt{natbib} version 8.2}
387 \changes{4.1b}{2008/07/01}{(AO) No longer use \cs{secnumarabic@sw}, instead use \cs{setup@secnums}}
388 \changes{4.1b}{2008/07/01}{(AO) Provide more diagnostics when \cs{@society} is assigned.}
389 \changes{4.1b}{2008/07/01}{(AO) provide option longbibliography}
390 \changes{4.1b}{2008/07/01}{Add \cs{@hangfroms@section}}
391 \changes{4.1b}{2008/07/01}{Break out \cs{@caption@fignum@sep}}
392 \changes{4.1b}{2008/07/01}{Class option galley sets \cs{preprintsty@sw} to false}
393 \changes{4.1b}{2008/07/01}{Code relating to new syntax for frontmatter has been placed in \file{ltxfront.dtx}}
394 \changes{4.1b}{2008/07/01}{Package textcase is now simply a required package}
395 \changes{4.1b}{2008/07/01}{Procedures \cs{@parse@class@options@society} and \cs{@parse@class@options@journal} and friends}
396 \changes{4.1b}{2008/07/01}{Read in all required packages together}
397 \changes{4.1b}{2008/07/01}{Remove options newabstract and oldabstract}
398 \changes{4.1b}{2008/08/01}{Section numbering via procedures \cs{secnums@rtx} and \cs{secnums@arabic}.}
399 \changes{4.1b}{2008/08/04}{As with author formatting, rag the right more, and assign \cs{@totalleftmargin}. Also neutralize \cs{def@after@address}.}%
400 \changes{4.1b}{2008/08/04}{Rag the right even more: .8\cs{hsize}. Also, assign \cs{@totalleftmargin}.}%
401 \changes{4.1b}{2008/08/04}{The \texttt{rmp} journal substyle selects \texttt{groupedaddress} by default.}%
402 \changes{4.1b}{2008/08/04}{Use \cs{setup@hook} to initialize all.}
403 \changes{4.1c}{2008/08/15}{Document class option longbibliography via \cs{substyle@post}}
404 \changes{4.1d}{2009/03/27}{Definition of \cs{ @fnsymbol} follows fixltx2e.sty}
405 \changes{4.1e}{2008/06/29}{(AO, 455) be nice to a list within the abstract}
406 \changes{4.1f}{2009/07/07}{(AO, 513) Add class option linenumbers: number the lines a la \classname{lineno}}
407 \changes{4.1f}{2009/07/07}{(AO, 516) Merged references are separated with a semicolon}
408 \changes{4.1f}{2009/07/10}{(AO, 520) Automatically produce \cs{bibliography} command when needed}%
409 \changes{4.1f}{2009/07/11}{(AO, 521) Lonely bibliography head}%
410 \changes{4.1f}{2009/07/11}{(AO, 522) Warn if software is expired}%
411 \changes{4.1f}{2009/07/15}{(AO, 523) Add class option nomerge, to turn off new natbib 8.3 syntax}
412 \changes{4.1f}{2009/07/20}{(AO, 524) Makes no sense if citations are superscript numbers and so are footnotes}
413 \changes{4.1f}{2009/10/05}{(AO, 530) \cs{@fnsymbol}: Failed to import fixltx2e.sty technology. Return to LaTeX core.}
414 \changes{4.1g}{2009/10/07}{(AO, 525) Remove phantom paragraph above display math that is given in vertical mode}%
415 \changes{4.1g}{2009/10/07}{(AO, 538) \cs{MakeTextUppercase} inappropriately expands the double backslash}
416 \changes{4.1h}{2009/10/09}{(AO) Remove expiry code in the release software}%
417 \changes{4.1i}{2009/10/23}{(AO, 541) Defer assignment of \cs{cite} until after natbib loads}
418 \changes{4.1j}{2009/10/24}{(AO, 549) Repairing natbib's \cs{BibitemShut} and \cs{bibAnnote}}
419 \changes{4.1j}{2009/10/25}{(AO, 545) hypertext capabilities off by default; enable with \classoption{hypertext}}
420 \changes{4.1j}{2009/10/25}{(AO, 552) Repair spacing in \cs{onlinecite}}
421 \changes{4.1k}{2009/11/06}{(AO, 554) give the \cs{newlabel} command syntax appropriate to the hyperref package}
422 \changes{4.1n}{2009/11/06}{(AO, 565) restore 4.0 behavior: invoking class option preprint implies class option preprintnumbers}
423 \changes{4.1n}{2009/11/30}{(AO, 566) restore 4.0 behavior: flush column bottoms}
424 \changes{4.1n}{2009/12/05}{(AO, 569) Use of \classname{hyperref} interferes with column balancing of last page}%
425 \changes{4.1n}{2009/12/09}{(AO, 569) execute the after-last-shipout procedures from within the safety of the output routine}%
426 \changes{4.1n}{2010/01/02}{(AO, 571) Interface \cs{set@footnotewidth} for determining the set width of footnotes}%
427 \changes{4.1n}{2010/01/02}{(AO, 572) Independent footnote counter for title block. Abstract footnote counter shared with body.}%
428 \changes{4.1n}{2009/12/13}{(AO, 573) arrange to load \classname{lineno} after any other packages.}%
429 \changes{4.1n}{2010/01/04}{(AO, 575) the default for journal prstper is longbibliography}%
430 \changes{4.1n}{2010/01/04}{(AO, 576) In .bst files, remove support for the annote field}%
431 \changes{4.1n}{2010/01/02}{(AO) fine-tune spacing above and below widetext}%
432 \changes{4.1n}{2010/01/02}{(AO, 571) class file must set \cs{splittopskip}; fine tune \cs{skip}\cs{footins}; \cs{footnoterule} defined in terms of \cs{skip}\cs{footins}}%
433 \changes{4.1n}{2010/01/02}{(AO, 572) \cs{@makefntext} and \cs{frontmatter@makefntext} must be defined harmoniously}%
434 \changes{4.1o}{2010/02/02}{(AO, 575) Automatically incorporate the (Bib\TeX-generated) .bbl into an explicit \env{thebibliography}}%
435 \changes{4.1o}{2010/02/05}{(AO, 549) Remove patch to natbib, which is now at version 8.31a}
436 \changes{4.1o}{2010/02/07}{(AO, 578) accommodate the possible space character preceding \cs{BibitemShut}.}
437 \changes{4.1o}{2010/02/05}{(AO, 579) Endnote shall comprise their own Bib\TeX\ entry type: @FOOTNOTE.}
438 \changes{4.1o}{2010/02/10}{(AO, 580) Provide a document class option to turn off production of eprint field in bibliography.}
439 \changes{4.1o}{2010/02/12}{(AO, 580) Control .bst at run time.}%
440 \changes{4.1o}{2010/02/09}{(AO, 581) Handle case: merged references, with first ending in a stop character.}
441 \changes{4.1p}{2010/02/24}{(AO, 583) Provide interface to \classname{ltxgrid} \cs{onecolumn@grid@setup} and \cs{twocolumn@grid@setup}}
442 \changes{4.1p}{2010/02/24}{(AO, 584) Per MD, remove trailing space character from each journal abbreviation: it had caused an extraneous space in the .bbl}
443 \changes{4.1q}{2010/04/01}{(AO, 586) When .bbl is pasted into the document, prevent automatic bibliography inclusion.}%
444 \changes{4.1q}{2010/04/13}{(AO, 588) Only write \revtex-specific BibTeX .bib data if the .bst style is set by REVTeX.}%
445 \changes{4.1r}{2010/06/22}{(AO, 595) Provide \cs{lovname} along with other List of Videos definitions.}%
446 \changes{4.1s}{2020/09/19}{(PHO) Adapt patches to \cs{document} and \cs{enddocument} to the 2020-10-01 \LaTeX{} release.}%
447
448 \end{filecontents*}
449 % \end{macrocode}
450 %
451 % \subsection{The Document Body}
452 %
453 % Here is the document body, containing only a
454 % \cmd\DocInput\ directive---referring to this very file.
455 % This very cute self-reference is a common \classname{ltxdoc} idiom.
456 % \begin{macrocode}
457 \begin{document}%
458 \expandafter\DocInput\expandafter{\jobname.dtx}%
459 \PrintChanges
460 \end{document}
461 % \end{macrocode}
462 % And that is the end of the driver for the programmer's documentation.
463 % \begin{macrocode}
464 %</doc>
465 % \end{macrocode}
466 %
467 % \section{Overview}%
468 % \revtex\ is a \LaTeXe\ document class, somewhat like a hybrid of
469 % the standard \LaTeX\ \classname{book} and \classname{article} classes.
470 %
471 % Certain packages are (should be) loaded by this class in any case:
472 % \classname{amssymb}, \classname{amsmath}, \classname{bm}, \classname{natbib}.
473 %
474 % Certain packages are automatically loaded by this class
475 % when a corresponding class option has been invoked:
476 %
477 % \begin{tabular}{ll}
478 % \textbf{\revtex\ option}&\textbf{package}\\
479 % \classoption{amsfonts}&\classname{amsfonts}\\
480 % \classoption{amssymb}&\classname{amssymb}\\
481 % \classoption{aps}&\classname{overcite}\\
482 % \end{tabular}
483 %
484 % Certain other packages are to be loaded by the
485 % document through explicit use of \cmd\usepackage.
486 % Some mentioned in the user documentation are
487 % \classname{graphicx}, \classname{longtable}, \classname{hyperref},
488 % and \classname{bm}.
489 %
490 % Certain commonly used packages are known to be incompatible with
491 % \revtex, among them \classname{multicol} and \classname{cite}.
492 % If such a package is found to be loaded, \revtex\ issues an error message
493 % and halts the job.
494 % Halting might be considered severe punishment for loading an incompatible
495 % package, but if we were to proceed, an even weirder error might be encountered
496 % further down the road.
497 %
498 % This document class implements the substyle: a set of mutually
499 % exclusive class options that, in this case, allow the
500 % document class to address multiple societies.
501 % It also implements a sub-substyle, giving the
502 % journal of the given society.
503 % Any society may create a substyle;
504 % this file generates one for \classoption{aps}.
505 %
506 % FIXME: should always load the \classname{graphicx} package. No, allow user to load whichever graphics package is desired.
507 %
508 % QUERY: since \classname{amsfonts} and \classname{amssymb} extend
509 % syntax, why not load them in any case?
510 %
511 % Certain processing occurs at the endgame for reading in \revtex, thereby establishing
512 % precedence for assignments to \LaTeX's (and \revtex's) parameters:
513 % \begin{enumerate}
514 % \item
515 % Figure out which society is operative and read in the indicated \file{.rtx} file.
516 % \item
517 % Figure out which journal option is operative and execute the indicated journal command. This may lead to reading in a journal substyle \file{.rtx} file.
518 % \item
519 % Figure out which pointsize is operative and execute the indicateded pointsize command. This may lead to reading in a pointsize \file{.rtx} file.
520 % \item
521 % Execute all of the document's options, in the order declared within the document.
522 % \item
523 % Read in all required packages (like \classname{natbib}, \classname{amsfonts}, \classname{amssymb}), that were determined by class, society, and journal.
524 % \item
525 % The last required package, if existing, is the document's style file, the \file{.rty} file.
526 % Note that the \file{.rty} file can override the assignments of \revtex, society, journal, and required packages, and even load its own packages.
527 % It can also, via appendations to \cmd\setup@hook, override the setup code itself.
528 % \item
529 % Execute all of the setup code accumulated. Such code can be queued by \revtex\ itself, by the society, by the journal, or by the pointsize.
530 % \item
531 % At this point, \revtex\ has completed the process of inputting itself,
532 % and \LaTeX\ will now execute the \cmd\AtEndOfClass\ procedures.
533 % \end{enumerate}
534 %
535 % \revtex\ will have enqueued code to execute at \cmd\AtBeginDocument\ time,
536 % in two different queues.
537 % \cmd\document@inithook\ executes immediately upon encountering the \cmd\begin\env{document} statement,
538 % \cmd\class@documenthook\ at the end of all the code enqueued via \cmd\AtBeginDocument.
539 % \begin{enumerate}
540 % \item
541 % Install procedures to execute at the very end of the class's
542 % \cmd\AtBeginDocument\ processing, such as
543 % \begin{enumerate}
544 % \item
545 % closing out the page grid
546 % \item
547 % putting out the LastPage label.
548 % \item
549 % issuing a \cmd\bibliographystyle\ command, based on the value set
550 % by the society substyle.
551 % \item
552 % setting default values for parameters used in the document.
553 %FIXME: differentiate between class's parameters that can wait until
554 % they are used in the document, and parameters that are used at \cmd\AtBeginDocument\ time.
555 % \end{enumerate}
556 % \item
557 % Install procedures to execute the very last at \cmd\AtEndDocument\ time,
558 % such as the \cmd\clearpage\ processing.
559 % \end{enumerate}
560 %
561 % Certain events are optionally scheduled for \cmd\AtBeginDocument\ time:
562 % \begin{enumerate}
563 % \item
564 % Setting default values for the Booleans and for other procedures used in formatting.
565 % \item
566 % In response to class options options, adjusting parameters and procedures used in formatting.
567 % \item
568 % Implementing the \classoption{eqsecnum} option, if required.
569 % \item
570 % Setting the state engine for data commands.
571 % \item
572 % Memorizing procedures for later use.
573 % \item
574 % Setting type size and area, for use by later calculations.
575 % \end{enumerate}
576 %
577 % Certain events are scheduled for \cmd\class@enddocumenthook\ time:
578 % \begin{enumerate}
579 % \item
580 % Print out the migrated floats or the end notes, if needed.
581 % \item
582 % Close out the page grid.
583 % \item
584 % Label the last page of the document
585 % \item
586 % (\classname{natbib}) prepare to read in the \file{.aux} file.
587 % \end{enumerate}
588 %
589 % \section{Writing journal-specifc extensions to \revtex}
590 %
591 % With this version of \revtex, we introduce a somewhat different
592 % scheme for adapting \revtex\ to the needs of a specific journal.
593 %
594 % To create a journal substyle, you create new class options in
595 % \revtex\ for the society, say \classoption{osa}, and any of that society's journals,
596 % one of which is, say, \classoption{josaa},
597 % using the code for the APS as a guide.
598 % In particular, each of your new options should separately define \cmd\@society\
599 % and \cmd\@journal. That for the former will be the same for
600 % all options relating to a particular society.
601 %
602 % Then, for the society, you create a corresponding \file{.rtx}
603 % file, in our case \file{osa.rtx}.
604 % Within that file, you override procedures and parameter assignments as you see fit.
605 % Ideally they will be generally applicable to all of that society's
606 % journals (see the file \file{aps.rtx} for a realization of this scheme).
607 % Also within that file, you include a
608 % section of code for each journal, that for josaa looks like:
609 % \begin{verbatim}
610 % \@ifx{\@journal\journal@josaa}{%
611 % <code specific to the josaa>
612 % }{}%
613 % \end{verbatim}
614 %
615 % Thus far, the scheme is similar to that used in \revtex\ 3.1.
616 % However, the new scheme does differ from the old in that
617 % the \file{.rtx} file should define no syntactical extensions
618 % to \revtex.
619 %
620 % \section{The \classname{revtex4} Document Class}
621 % Above, we took
622 % advantage of 1) the \LaTeX\ definition of \cmd\ProvidesPackage\ and
623 % 2) that the line of code immediately afterwards follows the \cmd\ProvidesClass\ statement above.
624 % \begin{macrocode}
625 %<*kernel>
626 % \end{macrocode}
627 %
628 % Print a banner in the log:
629 % \begin{macrocode}
630 \GenericInfo{}{\space
631 Copyright (c) 2009 The American Physical Society.^^J
632 mailto:[email protected]^^J
633 Licensed under the LPPL:^^Jhttp://www.ctan.org/tex-archive/macros/latex/base/lppl.txt^^J
634 Arthur Ogawa <arthur_ogawa at sbcglobal dot net>^^J
635 Based on work by David Carlisle <david at dcarlisle.demon.co.uk>%
636 \@gobble
637 }%
638 % \end{macrocode}
639 %
640 % \subsection{Compatibility Processing}
641 %
642 % If the document has \cmd\documentstyle|{revtex4}|,
643 % then, instead of attempting to run in compatability mode,
644 % just complain and exit.
645 % \changes{4.0c}{1999/11/13}{Lose compatability mode.}
646 % \begin{macrocode}
647 \if@compatibility
648 \edef\reserved@a{\errhelp{%
649 Change your \string\documentstyle\space statement to
650 \string\documentclass\space and rerun.
651 }}\reserved@a
652 \errmessage{You cannot run \class@name\space in compatability mode}%
653 \expandafter\@@end
654 \fi
655 % \end{macrocode}
656 %
657 %
658 % \section{Extensions to the \LaTeX\ Kernel}
659 %
660 % \begin{macrocode}
661 %</kernel>
662 % \end{macrocode}
663 %
664 % Here, we incorporate the utility, frontmatter, and page grid packages.
665 % The \classname{ltxutil}, \classname{ltxfront}, and \classname{ltxgrid} source are distributed with
666 % \revtex.
667 %
668 % Here begins the \file{options} \textsc{docstrip} module.
669 % \begin{macrocode}
670 %<*options>
671 % \end{macrocode}
672 %
673 % \subsection{Hooks}
674 %
675 % \begin{macro}{\setup@hook}
676 % The procedure
677 % \cmd\setup@hook\
678 % serves as the vehicle for all code that
679 % gives values to the class's parameters once all the
680 % society, journal, options, and packages have been processed.
681 %
682 % Arrange for journal substyles to set their own default values.
683 % \begin{macrocode}
684 \let\setup@hook\@empty
685 % \end{macrocode}
686 % \end{macro}
687 %
688 % After preamble processing is complete,
689 % detect whether package \classname{longtable} has been loaded and patch it.
690 % \begin{macrocode}
691 \appdef\document@inithook{%
692 \switch@longtable
693 \let\LT@makecaption\LT@makecaption@rtx
694 }%
695 % \end{macrocode}
696 %
697 % \begin{macro}{\LT@makecaption}
698 % We override the caption processing method of the \classname{longtable} package:
699 % space below the caption is created via strut instead of whitespace.
700 % \begin{macrocode}
701 \def\LT@makecaption@rtx#1#2#3{%
702 \LT@mcol\LT@cols c{%
703 \hbox to\z@{%
704 \hss
705 \parbox[t]\LTcapwidth{%
706 \sbox\@tempboxa{#1{#2: }#3\unskip\nobreak\vrule\@width\z@\@height\z@\@depth .5\baselineskip}%
707 \ifdim\wd\@tempboxa>\hsize
708 #1{#2: }#3\unskip\nobreak\vrule\@width\z@\@height\z@\@depth .5\baselineskip
709 \else
710 \hbox to\hsize{\hfil\box\@tempboxa\hfil}%
711 \fi
712 \endgraf
713 }%
714 \hss
715 }%
716 }%
717 }%
718 % \end{macrocode}
719 % \end{macro}
720 %
721 % \begin{macro}{\robust@boldmath}
722 % Robustify the \cmd\boldmath command.
723 % If Team \LaTeX\ (or any package) ever gets around to fixing this problem,
724 % we will bow out. (This fix relates to bug \#394.)
725 % \begin{macrocode}
726 \def\protectdef@boldmath{%
727 \expandafter\@ifnotrelax\csname boldmath \endcsname{}{%
728 \class@info{Robustifying \string\LaTeX's \string\boldmath\space command}%
729 \expandafter\let\csname boldmath \endcsname\boldmath
730 \expandafter\def\expandafter\boldmath\expandafter{\expandafter\protect\csname boldmath \endcsname}%
731 }%
732 }%
733 \appdef\document@inithook{%
734 \protectdef@boldmath
735 }%
736 % \end{macrocode}
737 % \end{macro}
738 %
739 % \section{Compatability with the geometry package}
740 %
741 % The \classname{geometry} package of Hideo Umeki provides a way to
742 % specify the metrics of the media and page layout.
743 % We want to ensure that \revtex\ does not foreclose on the use of
744 % this or any other such package, nor to interfere with
745 % explicit assignments of such metric parameters within the
746 % document preamble.
747 %
748 % The \LaTeX\ parameters (resp. \TeX\ primitives) set by \classname{geometry} are:
749 % \cmd\paperwidth, \cmd\paperheight,
750 % \cmd\textwidth, \cmd\textheight,
751 % \cmd\topmargin, \cmd\headheight, \cmd\headsep,
752 % \cmd\footskip, \cmd\skip\cmd\footins,
753 % \cmd\marginparwidth, \cmd\marginparsep,
754 % \cmd\oddsidemargin, \cmd\evensidemargin,
755 % \cmd\columnsep,
756 % \cmd\hoffset, \cmd\voffset, \cmd\mag,
757 % \cmd\if@twocolumn, \cmd\if@twoside, \cmd\if@mparswitch, \cmd\if@reversemargin,
758 %
759 % \revtex's assignments can be overridden by
760 % any package or other statement in the document preamble,
761 % so it should be compatible.
762 %
763 %FIXME: one parameter is rendered semantically void (by \file{ltxgrid.dtx}):
764 % \cmd\if@twocolumn.
765 %
766 % \section{Options}\label{sec:options}%
767 %
768 % \subsection{Define Booleans Used in Options}%
769 % The following Booleans are used within the document class to
770 % allow the document or the substyle to make selections
771 % of formatting.
772 % An explicit document class option overrides an assignment made by a substyle.
773 %
774 % \subsection{Declare Options}%
775 %
776 % \subsubsection{Checkin: for Editorial Use}%
777 % A document class option declaring that the document is being processed by the
778 % editorial staff.
779 %
780 % This option should:
781 % \begin{itemize}
782 % \item
783 % put date in footer along with folio
784 % \item
785 % Have the effect of selecting the \classoption{preprint} class option.
786 % \item
787 % Have the effect of selecting the \classoption{showpacs} class option.
788 % \item
789 % specify that when a float is placed h or H, it will be allowed to break over pages.
790 % (Note: be sure that if the enclosed \env{tabular} has an optional argument, you change it to [v], or remove it entirely.)
791 % \end{itemize}
792 % \changes{4.0c}{1999/11/13}{New option ``checkin''}
793 % \begin{macrocode}
794 \DeclareOption{checkin}{%
795 \@booleantrue\dateinRH@sw
796 \@booleantrue\preprintsty@sw
797 \def\@pointsize{12}%
798 \@booleantrue\showPACS@sw
799 \@booleantrue\showKEYS@sw
800 \def\fp@proc@h{\allow@breaking@tables}%
801 \def\fp@proc@H{\allow@breaking@tables}%
802 }%
803 \@booleanfalse\dateinRH@sw
804 \def\checkindate{\dateinRH@sw{{\tiny(\today)}}{}}%
805 \def\allow@breaking@tables{%
806 \def\array@default{v}% tabular can break over pages
807 \@booleanfalse\floats@sw % table can break over pages
808 }%
809 % \end{macrocode}
810 %
811 % \subsubsection{Preprint Style}%
812 %
813 % \begin{macro}{\preprintsty@sw}
814 % The boolean \cmd\preprintsty@sw\ signifies that
815 % the document is to be formatted in preprint style.
816 % \changes{4.0a}{1998/01/31}{Rearrange the ordering so numerical ones come first. AO: David, what does this mean?}
817 % \changes{4.0a}{1998/06/10}{comma not space between email and homepage}
818 % \changes{4.0b}{1999/06/20}{Move this ``complex'' option to the front, where it can be overridden by ``simple'' options.}
819 % \changes{4.1b}{2008/06/01}{Add option reprint, opposite of preprint, and preferred alternative to twocolumn}
820 % \begin{macrocode}
821 \DeclareOption{preprint}{%
822 \@booleantrue\preprintsty@sw
823 \ExecuteOptions{12pt}%
824 }%
825 \DeclareOption{reprint}{%
826 \@booleanfalse\preprintsty@sw
827 \@booleantrue\twocolumn@sw
828 \ExecuteOptions{10pt}%
829 }%
830 \DeclareOption{manuscript}{%
831 \class@warn{Document class option manuscript is obsolete; use preprint instead}%
832 \ExecuteOptions{preprint}%
833 }%
834 \@booleanfalse\preprintsty@sw
835 % \end{macrocode}
836 % \end{macro}
837 %
838 % \begin{macro}{\showPACS@sw}
839 % \begin{macro}{\showKEYS@sw}
840 % If \cmd\showPACS@sw\ is true, print the PACS information in the title block,
841 % otherwise not.
842 % Similarly for \cmd\showKEYS@sw\ and the keywords.
843 % \subsubsection{Showing PACS and keywords}%
844 % \changes{4.0b}{1999/06/20}{New option}
845 % \changes{4.0e}{2000/09/20}{New option showkeys}
846 % \begin{macrocode}
847 \DeclareOption{showpacs}{%
848 \@booleantrue\showPACS@sw
849 }%
850 \DeclareOption{noshowpacs}{%
851 \@booleanfalse\showPACS@sw
852 }%
853 \DeclareOption{showkeys}{%
854 \@booleantrue\showKEYS@sw
855 }%
856 \DeclareOption{noshowkeys}{%
857 \@booleanfalse\showKEYS@sw
858 }%
859 \@booleanfalse\showPACS@sw
860 \@booleanfalse\showKEYS@sw
861 % \end{macrocode}
862 % \end{macro}
863 % \end{macro}
864 %
865 % \subsubsection{Balance the last page when in two-column page grid}%
866 %
867 % \begin{macro}{\balancelastpage@sw}
868 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
869 % If we are in a two-column page grid, we may wish to balance the columns
870 % of the last page. This will be done automatically if the
871 % \classoption{twocolumn} document class option is chosen.
872 % This action will be turned off by the \classoption{nobalancelastpage}.
873 % A complementary class option, \classoption{balancelastpage} is also provided.
874 % \begin{macrocode}
875 \DeclareOption{balancelastpage}{%
876 \@booleantrue\balancelastpage@sw
877 }%
878 \DeclareOption{nobalancelastpage}{%
879 \@booleanfalse\balancelastpage@sw
880 }%
881 \@booleantrue\balancelastpage@sw
882 % \end{macrocode}
883 % \end{macro}
884 %
885 % \subsubsection{Showing preprint numbers}%
886 %
887 % \begin{macro}{\preprint@sw}
888 % \changes{4.0d}{2000/04/10}{New option}
889 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
890 % \changes{4.1n}{2009/11/06}{(AO, 565) restore 4.0 behavior: default value of \cs{preprint@sw} follows \cs{preprintsty@sw}}
891 % The boolean \cmd\preprint@sw\ signifies that
892 % the preprints (cf. \cmd\preprint) are to be formatted (usually on the title page).
893 % The option \classoption{preprintnumbers} declares to do so,
894 % \classoption{nopreprintnumbers} declares not to;
895 % the default is to follow \cmd\preprintsty@sw.
896 % \begin{macrocode}
897 \DeclareOption{nopreprintnumbers}{\@booleanfalse\preprint@sw}%
898 \DeclareOption{preprintnumbers}{\@booleantrue\preprint@sw}%
899 \appdef\setup@hook{%
900 \@ifxundefined\preprint@sw{\let\preprint@sw\preprintsty@sw}{}%
901 }%
902 % \end{macrocode}
903 % \end{macro}
904 %
905 % \subsubsection{Hypertext Option}%
906 %
907 % \changes{4.0a}{1998/01/31}{protect against hyperref revtex kludges which are not needed now}
908 % \changes{4.0b}{1999/06/20}{Move this ``complex'' option to the front, where it can be overridden by ``simple'' options.}
909 % \changes{4.0rc4}{2001/07/23}{hyperref is no longer loaded via class option: use a usepackage statement instead}
910 % \begin{macrocode}
911 \DeclareOption{hyperref}{%
912 % \end{macrocode}
913 % The following code had been commented out, it is now truly a comment:
914 % \begin{verbatim}
915 %\AtEndOfClass{%
916 % \begingroup
917 % \edef\@tempa{%
918 % \let
919 % \noexpand\@clsextension
920 % \noexpand\@empty
921 % \noexpand\RequirePackage{hyperref}%
922 % \def\noexpand
923 % \@clsextension{\@clsextension}%
924 % }%
925 % \expandafter
926 % \endgroup
927 % \@tempa
928 %}%
929 % \def\@pointsize{10}%
930 % \end{verbatim}
931 %
932 % If you have a hyper-foo enabled browser you may prefer this format
933 % which does not print the URL for the home page, but just makes the
934 % name a link, but by default print it so it works on paper.
935 % \changes{4.0a}{1998/01/31}{print homepage}
936 %
937 % \begin{macrocode}
938 \class@warn{Class option "hyperref" is no longer supported.^^JEmploy \string\usepackage{hyperref} instead}%
939 }%
940 % \end{macrocode}
941 %
942 % \subsubsection{Type Size}%
943 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
944 % Use \cmd\@pointsize|=10| rather than \cmd\@ptsize|=0| to allow easy extensions
945 % to 9pt or whatever.
946 % Note: the three alternatives are mutually exclusive.
947 %
948 % At this point, the parameter \cmd\@pointsize\ is set to \cmd\undefined:
949 % a society \emph{must} give it a definition.
950 % \begin{macrocode}
951 \DeclareOption{10pt}{\def\@pointsize{10}}%
952 \DeclareOption{11pt}{\def\@pointsize{11}}%
953 \DeclareOption{12pt}{\def\@pointsize{12}}%
954 \let\@pointsize\@undefined
955 % \end{macrocode}
956 %
957 % \subsubsection{Media Size}%
958 %
959 % \begin{macro}{\paperheight}
960 % \begin{macro}{\paperwidth}
961 % \changes{4.0b}{1999/06/20}{Restore all media size class option of \protect\file{classes.dtx}}
962 % \begin{macrocode}
963 \DeclareOption{a4paper}{%
964 \setlength\paperheight {297mm}%
965 \setlength\paperwidth {210mm}%
966 }%
967 \DeclareOption{a5paper}{%
968 \setlength\paperheight {210mm}%
969 \setlength\paperwidth {148mm}%
970 }%
971 \DeclareOption{b5paper}{%
972 \setlength\paperheight {250mm}%
973 \setlength\paperwidth {176mm}%
974 }%
975 \DeclareOption{letterpaper}{%
976 \setlength\paperheight {11in}%
977 \setlength\paperwidth {8.5in}%
978 }%
979 \DeclareOption{legalpaper}{%
980 \setlength\paperheight {14in}%
981 \setlength\paperwidth {8.5in}%
982 }%
983 \DeclareOption{executivepaper}{%
984 \setlength\paperheight {10.5in}%
985 \setlength\paperwidth {7.25in}%
986 }%
987 \DeclareOption{landscape}{%
988 \setlength\@tempdima {\paperheight}%
989 \setlength\paperheight {\paperwidth}%
990 \setlength\paperwidth {\@tempdima}%
991 }%
992 % \end{macrocode}
993 %
994 % \changes{4.1a}{2008/01/18}{(AO, 478) \cs{ds@letterpaper}, so that ``letterpaper really is the default''}%
995 % Effectively select \classoption{letterpaper}.
996 % \begin{macrocode}
997 \ds@letterpaper
998 % \end{macrocode}
999 % \end{macro}
1000 % \end{macro}
1001 %
1002 % \subsubsection{Bibnotes}%
1003 %
1004 % \begin{macro}{\frontmatter@footnote@produce}
1005 % Frontmatter footnotes result from frontmatter commands like
1006 % \cmd\email, \cmd\homepage, \cmd\altaffiliation, and \cmd\thanks.
1007 % The default for \cmd\frontmatter@footnote@produce\ is
1008 % \cmd\frontmatter@footnote@produce@footnote, which formats the frontmatter footnotes
1009 % at the foot of the title page. The \classoption{bibnotes} class option
1010 % defers them to the bibliography.
1011 % \changes{4.1b}{2008/06/01}{(AO) Implement bibnotes through \cs{frontmatter@footnote@produce} instead of \cs{bibnotes@sw}}%
1012 % \begin{macrocode}
1013 \DeclareOption{bibnotes}{\let\frontmatter@footnote@produce\frontmatter@footnote@produce@endnote}%
1014 \DeclareOption{nobibnotes}{\let\frontmatter@footnote@produce\frontmatter@footnote@produce@footnote}%
1015 \let\frontmatter@footnote@produce\frontmatter@footnote@produce@footnote
1016 \appdef\class@enddocumenthook{\auto@bib}%
1017 % \end{macrocode}
1018 % \end{macro}
1019 %
1020 % \subsubsection{Footinbib}%
1021 %
1022 % \begin{macro}{\footinbib@sw}
1023 % The boolean \cmd\footinbib@sw\ signifies that
1024 % text footnotes are to be set in the bibliography, as endnotes.
1025 %
1026 % The document may set the value one way or the other via
1027 % the following two class options.
1028 % \begin{macrocode}
1029 \DeclareOption{footinbib}{\@booleantrue\footinbib@sw}
1030 \DeclareOption{nofootinbib}{\@booleanfalse\footinbib@sw}
1031 % \end{macrocode}
1032 % The default value is \cmd\false@sw, and the society or journal
1033 % may override the default.
1034 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1035 % \begin{macrocode}
1036 \@booleanfalse\footinbib@sw
1037 % \end{macrocode}
1038 % \end{macro}
1039 %
1040 % \subsubsection{altaffilletter}%
1041 %
1042 % \begin{macro}{\altaffilletter@sw}
1043 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1044 % Determine the procedure \cmd\thefootnote\ used in frontmatter:
1045 % the footnote symbol used in titlepage footnotes.
1046 % \begin{macrocode}
1047 \DeclareOption{altaffilletter}{\@booleantrue\altaffilletter@sw}%
1048 \DeclareOption{altaffilsymbol}{\@booleanfalse\altaffilletter@sw}%
1049 \@booleanfalse\altaffilletter@sw
1050 % \end{macrocode}
1051 % \end{macro}
1052 %
1053 % \subsubsection{superbib}%
1054 %
1055 % \begin{macro}{\place@bibnumber}
1056 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1057 % The procedure \cmd\place@bibnumber\ produces the number
1058 % at the head of the \cmd\bibitem, in the bibliography.
1059 % By default, it has the \cmd\bibnumfmt\ meaning assigned by the \classname{natbib} package.
1060 % It may be overridden by society, journal, or by the document options.
1061 %
1062 % \begin{macrocode}
1063 \DeclareOption{superbib}{%
1064 \let\place@bibnumber\place@bibnumber@sup
1065 }%
1066 \def\place@bibnumber{\NATx@bibnumfmt}%
1067 % \end{macrocode}
1068 % \end{macro}
1069 %
1070 % \begin{macro}{\place@bibnumber@sup}
1071 % \begin{macro}{\place@bibnumber@inl}
1072 % For producing the \cmd\bibitem\ device,
1073 % we define two procedures to select from.
1074 %
1075 % Note that we could have used \classname{natbib}'s \cmd\ifNAT@super\
1076 % switch, but it does not allow for altering the meaning of \cmd\bibnumfmt.
1077 % \begin{macrocode}
1078 \def\place@bibnumber@sup#1{\textsuperscript{#1}}%
1079 \def\place@bibnumber@inl#1{[#1]}%
1080 % \end{macrocode}
1081 % \end{macro}
1082 % \end{macro}
1083 %
1084 % \subsubsection{citeautoscript}%
1085 % \begin{macro}{\citeautoscript@sw}
1086 % This class option allows you to automatically accomodate a change from non-superscripted, numbered references
1087 % to superscripted, bunmbered references.
1088 %
1089 % Note: you should always mark up your document with the assumption that references are \emph{not} going to be superscripted.
1090 % Otherwise this option has no hope of working properly.
1091 %
1092 % \begin{macrocode}
1093 \DeclareOption{citeautoscript}{\@booleantrue\citeautoscript@sw}%
1094 \@booleanfalse\citeautoscript@sw
1095 % \end{macrocode}
1096 % \end{macro}
1097 %
1098 % \subsubsection{Variants on the Bibliography Style}%
1099 % \changes{4.1b}{2008/07/01}{(AO) provide option longbibliography}
1100 %
1101 % \revtex\ anticipates that a society or journal will provide two related Bib\TeX bibliography style variants,
1102 % designating one as the default.
1103 % A pair of document class options \classoption{longbibliography} and \classoption{nolongbibliography}
1104 % allows the user to explicitly select between them.
1105 % \begin{macro}{\longbibliography@sw}
1106 %
1107 % \revtex's default for \cmd\longbibliography@sw\ is \cmd\false@sw.
1108 %
1109 % \begin{macrocode}
1110 \DeclareOption{longbibliography}{\@booleantrue\longbibliography@sw}%
1111 \DeclareOption{nolongbibliography}{\@booleanfalse\longbibliography@sw}%
1112 \@booleanfalse\longbibliography@sw
1113 % \end{macrocode}
1114 % \end{macro}
1115 %
1116 % \begin{macro}{\eprint@enable@sw}
1117 % \changes{4.1o}{2010/02/10}{(AO, 580) Provide a document class option to turn off production of eprint field in bibliography.}
1118 %
1119 % The document class options \classoption{eprint} and \classoption{noeprint}
1120 % give the user the ability to turn off production of the \texttt{eprint} field in the bibliography.
1121 % \begin{macrocode}
1122 \DeclareOption{eprint}{\@booleantrue\eprint@enable@sw}%
1123 \DeclareOption{noeprint}{\@booleanfalse\eprint@enable@sw}%
1124 \@booleantrue\eprint@enable@sw
1125 % \end{macrocode}
1126 % \end{macro}
1127 %
1128 % \subsubsection{Simplex/Duplex Pages}%
1129 %
1130 % \begin{macro}{\twoside@sw}
1131 % \changes{4.1b}{2008/07/01}{(AO) coordinate \cs{if@twoside} with \cs{twoside@sw}}
1132 % The flag \cmd\twoside@sw\ signifies that the document is to be
1133 % formatted for duplex printing.
1134 % After the preamble is processed, we align the value
1135 % of the kernel \cmd\newif\ switch \cmd\if@twoside\
1136 % to that of \cmd\twoside@sw.
1137 % \cmd\if@twoside\ itself is used in the kernel's
1138 % \cmd\cleardoublepage\ and \cmd\@outputpage\ procedures.
1139 % \begin{macrocode}
1140 \@booleanfalse\twoside@sw
1141 \appdef\document@inithook{%
1142 \twoside@sw{\@twosidetrue}{\@twosidefalse}%
1143 }%
1144 % \end{macrocode}
1145 % \changes{4.0a}{1998/01/31}{4.d had twoside option setting twoside switch to false}
1146 % The complementary options \classoption{twoside} and \classoption{oneside}
1147 % assert formatting for duplex or simplex printing, respectively.
1148 % At the same time, we arrange for the selection of the page grid
1149 % with respect to the marginal column:
1150 % Because \cmd\if@reversemargin\ remains default (false),
1151 % if duplex printing, this column will always be on the (right),
1152 % if simplex printing, it will always be on the (outside).
1153 % QUERY: correct choice?
1154 %FIXME: assign \cmd\if@mparswitch\ later (and protect the assignment, too).
1155 % \begin{macrocode}
1156 \DeclareOption{twoside}{\@booleantrue \twoside@sw\@mparswitchfalse}%
1157 \DeclareOption{oneside}{\@booleanfalse\twoside@sw\@mparswitchtrue}%
1158 % \end{macrocode}
1159 % \end{macro}
1160 %
1161 % \subsubsection{Two-Column Page Grid}%
1162 %
1163 % \begin{macro}{\twocolumn@sw}
1164 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1165 % \changes{4.1p}{2010/02/24}{(AO, 583) Provide interface to \classname{ltxgrid} \cs{onecolumn@grid@setup} and \cs{twocolumn@grid@setup}}
1166 % The flag \cmd\twocolumn@sw\ signifies that the document is to be
1167 % formatted in the two-column page grid.
1168 %
1169 % If no options relating to page grid are invoked by
1170 % \cmd\AtBeginDcoument\ time, we set default values.
1171 % Up to that point, the class can check if \cmd\twocolumn@sw\
1172 % is \cmd\undefined\ to see if any related options have been invoked.
1173 %
1174 % \classoption{onecolumn} specifies one-column page grid.
1175 % The \classoption{twocolumn} class option employs the standard mechanism for
1176 % changing the column grid: the \classname{ltxgrid} package.
1177 % \begin{macrocode}
1178 \DeclareOption{onecolumn}{\@booleanfalse\twocolumn@sw}%
1179 \DeclareOption{twocolumn}{\@booleantrue \twocolumn@sw}%
1180 \@booleanfalse\twocolumn@sw
1181 % \end{macrocode}
1182 % The column grid is determined by the state of the switch \cmd\twocolumn@sw
1183 % and is effected at \cmd\class@documenthook\ time.
1184 % The society or journal file may re-define \cmd\select@column@grid\
1185 % to accomodate, e.g., more than two choices for the page grid.
1186 %
1187 % Note that \cmd\open@column@two\ adds items to the Main Vertical List,
1188 % so constitutes the true beginning of the document.
1189 %
1190 % Note also that if the selected column grid is a one-column grid,
1191 % there is nothing to do, because \classname{ltxgrid} has already
1192 % set that up via \cmd\@begindocumenthook.
1193 % \begin{macrocode}
1194 \def\select@column@grid{%
1195 \twocolumn@sw{%
1196 \twocolumn@grid@setup
1197 \open@twocolumn
1198 }{%
1199 \onecolumn@grid@setup
1200 % \end{macrocode}
1201 % \begin{verbatim}
1202 % \open@onecolumn
1203 % \end{verbatim}
1204 % \begin{macrocode}
1205 }%
1206 }%
1207 \appdef\class@documenthook{%
1208 \select@column@grid
1209 }%
1210 % \end{macrocode}
1211 %
1212 % \end{macro}
1213 %
1214 % \begin{macro}{\clear@document}
1215 % \changes{4.1n}{2009/12/05}{(AO, 569) Use of \classname{hyperref} interferes with column balancing of last page}%
1216 %
1217 % We install into \cmd\class@enddocumenthook\
1218 % a trap for the procedure \cmd\clearpage\ that attempts to end the current page.
1219 % This procedure needs to be headpatched with \cmd\close@column\ to end the current page grid.
1220 %
1221 % This procedure is executed after all typesetting is complete
1222 % i.e., after items like \cmd\printtables, as well as all commands queued up by \cmd\AtEndDocument.
1223 %
1224 % \begin{macrocode}
1225 \appdef\setup@hook{%
1226 \let\clearpage@ltx\clearpage
1227 \prepdef\clear@document{\let\clearpage\clearpage@ltx\let\clear@document\@empty\close@column}%
1228 \appdef\class@documenthook{%
1229 \appdef\class@enddocumenthook{%
1230 \let\clearpage\clear@document
1231 }%
1232 }%
1233 }%
1234 % \end{macrocode}
1235 %
1236 % \end{macro}
1237 %
1238 % \begin{macro}{\authoryear@sw}
1239 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
1240 % The boolean \cmd\authoryear@sw\ signifies that we are to use author-year citations rather than numerical citations.
1241 %
1242 % The \classoption{author-year} class option selects ``'author-year'' citations;
1243 % \classoption{numerical} selectes ``numerical'' citations.
1244 % The former is the default.
1245 % \begin{macrocode}
1246 \DeclareOption{author-year}{\@booleantrue\authoryear@sw}%
1247 \DeclareOption{numerical}{\@booleanfalse\authoryear@sw}%
1248 \@booleanfalse\authoryear@sw
1249 % \end{macrocode}
1250 % \end{macro}
1251 %
1252 % \begin{macro}{\galley@sw}
1253 % The boolean \cmd\galley@sw\ signifies that
1254 % the document is to be formatted in galley style.
1255 %
1256 % Asserting both \cmd\galley@sw\ and \cmd\preprintsty@sw\
1257 % may produce strange formatting results, but it is not illegal.
1258 % However, it \emph{is} illegal to assert galley and any
1259 % twocolumn option.
1260 % \begin{macrocode}
1261 % \end{macrocode}
1262 % \classoption{galley} emulates setting the galleys of
1263 % a two-column journal.
1264 % CHANGED: this option should effectively set \cmd\preprintsty@sw\ false.
1265 % NOTE: it makes no sense to assert both galley and twocolumn.
1266 % \changes{4.1b}{2008/07/01}{Class option galley sets \cs{preprintsty@sw} to false}
1267 %
1268 % \begin{macrocode}
1269 \DeclareOption{galley}{%
1270 \ExecuteOptions{onecolumn}%
1271 \@booleantrue\galley@sw
1272 \@booleanfalse\preprintsty@sw
1273 \appdef\setup@hook{%
1274 \advance\textwidth-\columnsep
1275 \textwidth.5\textwidth
1276 }%
1277 }%
1278 \@booleanfalse\galley@sw
1279 % \end{macrocode}
1280 % \end{macro}
1281 %
1282 % \subsubsection{raggedbottom or flushbottom}%
1283 % \begin{macro}{\raggedcolumn@sw}
1284 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1285 % The class options \classoption{raggedbottom} and \classoption{flushbottom} determine whether the columns (page)
1286 % are ragged bottom or flush bottom.
1287 % Note that we do not select a default here; that is done by the journal substyle.
1288 % \begin{macrocode}
1289 \DeclareOption{raggedbottom}{\@booleantrue\raggedcolumn@sw}
1290 \DeclareOption{flushbottom}{\@booleanfalse\raggedcolumn@sw}
1291 \@booleanfalse\raggedcolumn@sw
1292 \appdef\setup@hook{%
1293 \raggedcolumn@sw{\raggedbottom}{\flushbottom}%
1294 }%
1295 % \end{macrocode}
1296 % \end{macro}
1297 %
1298 % \subsubsection{tightenlines}%
1299 %
1300 % This class option specifies that standard leading
1301 % is to be used to set the type.
1302 % If lacking, the leading will be loose.
1303 %
1304 % \begin{macro}{\tightenlines@sw}
1305 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1306 % The boolean \cmd\tightenlines@sw\ signifies that
1307 % the leading is to be made standard amount.
1308 % If false, it means that the leading is to be set extra open.
1309 % Has no effect on 10pt size option.
1310 %
1311 % \begin{macrocode}
1312 \DeclareOption{tightenlines}{\@booleantrue\tightenlines@sw}
1313 \@booleanfalse\tightenlines@sw
1314 % \end{macrocode}
1315 % \end{macro}
1316 %
1317 % \subsubsection{lengthcheck}%
1318 %
1319 % \begin{macro}{\lengthcheck@sw}
1320 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1321 % The flag \cmd\lengthcheck@sw\ signifies that
1322 % the length checking is in effect.
1323 % It is up to the individual journal substyle
1324 % to alter its formatting accordingly.
1325 % \begin{macrocode}
1326 \@booleanfalse\lengthcheck@sw
1327 % \end{macrocode}
1328 % This class option specifies that the formatted document
1329 % should approach as closely as possible the
1330 % formatting of an actual journal article
1331 % to facilitate the author's performance of a length check.
1332 %
1333 %FIXME: society or journal may have its own definition of this option.
1334 % \begin{macrocode}
1335 \DeclareOption{lengthcheck}{%
1336 \@booleantrue\lengthcheck@sw
1337 \ExecuteOptions{reprint}%
1338 }%
1339 % \end{macrocode}
1340 % In addition, if length checking is in effect, we will enable
1341 % the tally of text length.
1342 % \begin{macrocode}
1343 \appdef\setup@hook{%
1344 \lengthcheck@sw{\@booleantrue\tally@box@size@sw}{}%
1345 }%
1346 % \end{macrocode}
1347 % \end{macro}
1348 %
1349 % \subsubsection{Draft and Final}%
1350 %
1351 % \begin{macro}{\draft@sw}
1352 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1353 % The flag \cmd\draft@sw\ signifies that the document is to be
1354 % formatted in draft mode.
1355 %
1356 % \begin{macrocode}
1357 \appdef\setup@hook{%
1358 \draft@sw{\overfullrule 5\p@}{\overfullrule\z@}%
1359 }%
1360 % \end{macrocode}
1361 %
1362 % Certain packages may pay attention to the
1363 % class option \classoption{draft} that sets this Boolean.
1364 % \begin{macrocode}
1365 \DeclareOption{draft}{\@booleantrue\draft@sw}%
1366 \DeclareOption{final}{\@booleanfalse\draft@sw}%
1367 \@booleanfalse\draft@sw
1368 % \end{macrocode}
1369 %
1370 % \end{macro}
1371 %
1372 % \subsubsection{eqsecnum}%
1373 %
1374 % \begin{macro}{\eqsecnum@sw}
1375 % The flag \cmd\eqsecnum@sw\ signifies that equations are to be
1376 % numbered with the section, e.g., ``Eq. (2.13)''.
1377 % \begin{macrocode}
1378 \appdef\setup@hook{%
1379 \eqsecnum@sw{%
1380 \@addtoreset{equation}{section}%
1381 \def\theequation@prefix{\arabic{section}.}%
1382 }{}%
1383 }%
1384 % \end{macrocode}
1385 %
1386 % The \classoption{eqsecnum} class option signifies that equations are
1387 % to be numbered within sections.
1388 % \begin{macrocode}
1389 \DeclareOption{eqsecnum}{\@booleantrue\eqsecnum@sw}%
1390 \@booleanfalse\eqsecnum@sw
1391 % \end{macrocode}
1392 % \end{macro}
1393 %
1394 % \subsubsection{secnumarabic}%
1395 % \changes{4.1b}{2008/07/01}{(AO) No longer use \cs{secnumarabic@sw}, instead use \cs{setup@secnums}}
1396 % The \classoption{secnumarabic} class option signifies that sectioning commands are
1397 % to be numbered arabic:
1398 % the procedure \cmd\secnums@arabic\ is executed as the default.
1399 % Otherwise, the procedure \cmd\secnums@rtx\ determines things.
1400 % The society or journal may redefine either procedure,
1401 % and may change the definition of \cmd\setup@secnums\ itself,
1402 % thereby establishing a different default.
1403 % \begin{macrocode}
1404 \appdef\setup@hook{%
1405 \setup@secnums
1406 }%
1407 \DeclareOption{secnumarabic}{%
1408 \def\setup@secnums{\secnums@arabic}%
1409 }%
1410 \def\setup@secnums{\secnums@rtx}%
1411 % \end{macrocode}
1412 % The code that defines \cmd\secnums@rtx\ and \cmd\secnums@arabic\ appears
1413 % in Section~\ref{sec:secnumarabic}.
1414 %
1415 % \begin{macro}{fleqn}
1416 % FIXME: model fleqn after amsfonts. I no longer understand why I said this.
1417 % \file{fleqn.clo} is not a package, so it can simply be \cmd\input.
1418 % \begin{macrocode}
1419 \DeclareOption{fleqn}{%
1420 \input{fleqn.clo}%
1421 }%
1422 % \end{macrocode}
1423 % \end{macro}
1424 %
1425 % \subsubsection{floats/endfloats}%
1426 %
1427 % \begin{macro}{\floats@sw}
1428 % \begin{macro}{\floatp@sw}
1429 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1430 % The Boolean \cmd\floats@sw\ signifies that floats are to be floated;
1431 % if false, that floats are to be deferred to the end of the document.
1432 % By default, the former.
1433 % Note that the state of this Boolean is to be changed by
1434 % the document class in response to user-selected options.
1435 %
1436 % This boolean and the assignment of its default value is done by
1437 % the \classname{ltxutil} package.
1438 %
1439 % The Boolean \cmd\floatp@sw\ signifies that endfloats are to be set one per page;
1440 % if false, that endfloats are to be set with multiple floats per page permitted.
1441 % By default, the latter.
1442 % Note that the state of this Boolean is to be changed by
1443 % the document class in response to user-selected options.
1444 % The default is established here.
1445 %
1446 % These options control, via the Boolean \cmd\floats@sw,
1447 % whether floats are to be migrated to the end of the document.
1448 % \begin{macrocode}
1449 \DeclareOption{floats}{\@booleantrue\floats@sw\@booleanfalse\floatp@sw}
1450 \DeclareOption{endfloats}{\@booleanfalse\floats@sw\@booleanfalse\floatp@sw}
1451 \DeclareOption{endfloats*}{\@booleanfalse\floats@sw\@booleantrue\floatp@sw}
1452 \@booleantrue\floats@sw
1453 \@booleantrue\floatp@sw
1454 % \end{macrocode}
1455 % \end{macro}
1456 % \end{macro}
1457 %
1458 % \subsubsection{titlepage/notitlepage}%
1459 % These options control, via \cmd\titlepage@sw,
1460 % whether the title block is to be set on a separate page.
1461 %
1462 % \begin{macro}{\titlepage@sw}
1463 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1464 % The flag \cmd\titlepage@sw\ signifies that a forced
1465 % page break is to follow the title page: the article
1466 % title appears on a page by itself.
1467 %
1468 % \begin{macrocode}
1469 \DeclareOption{titlepage}{\@booleantrue\titlepage@sw}
1470 \DeclareOption{notitlepage}{\@booleanfalse\titlepage@sw}
1471 \@booleanfalse\titlepage@sw
1472 % \end{macrocode}
1473 % \end{macro}
1474 %
1475 % \subsubsection{Substyle and Sub-substyle}%
1476 %
1477 % \begin{macro}{\change@society}
1478 % \begin{macro}{\change@journal}
1479 % \changes{4.1b}{2008/07/01}{(AO) Provide more diagnostics when \cs{@society} is assigned.}
1480 % If the society or, resp., journal has already been assigned,
1481 % notify user whether it is being overridden.
1482 %
1483 % \begin{macrocode}
1484 \def\change@society#1{%
1485 \def\@tempa{#1}%
1486 \@ifxundefined\@society{%
1487 \class@info{Selecting society \@tempa}%
1488 \let\@society\@tempa
1489 }{%
1490 \@ifx{\@tempa\@society}{}{%
1491 \class@warn{Conflicting society \@tempa<>\@society; not selected}%
1492 }%
1493 }%
1494 }%
1495 \def\change@journal#1{%
1496 \def\@tempa{#1}%
1497 \@ifxundefined\@journal{%
1498 \class@info{Selecting journal \@tempa}%
1499 \let\@journal\@tempa
1500 }{%
1501 \@ifx{\@tempa\@journal}{}{%
1502 \class@warn{Conflicting journal \@tempa<>\@journal; not selected}%
1503 }%
1504 }%
1505 }%
1506 % \end{macrocode}
1507 % \end{macro}
1508 % \end{macro}
1509 %
1510 % Here had been the class options relating to the APS.
1511 % Now that all societies are on an equal footing, this code is in the
1512 % respective \file{.rtx} file.
1513 % \begin{macrocode}
1514 % \end{macrocode}
1515 %
1516 % \subsubsection{Optical Society of America}%
1517 % Here are the class options relating to the Optical Society of America.
1518 %
1519 % Note: as of 2008, the only OSA module being distributed by ctan is \file{osajnl.rtx}.
1520 % The class options declared here are, I think, unused.
1521 % \begin{macrocode}
1522 \DeclareOption{osa}{\change@society{osa}\let\@journal\@undefined}%
1523 \DeclareOption{osameet}{\change@society{osa}\def\@journal{osameet}}%
1524 \DeclareOption{opex}{\change@society{osa}\def\@journal{opex}}%
1525 \DeclareOption{tops}{\change@society{osa}\def\@journal{tops}}%
1526 \DeclareOption{josa}{\change@society{osa}\def\@journal{josa}}%
1527 % \end{macrocode}
1528 %
1529 % \begin{macro}{\rtx@require@packages}
1530 % \changes{4.1b}{2008/07/01}{Read in all required packages together}
1531 % The procedure \cmd\rtx@require@packages\ accumulates all \cmd\RequirePackage\ statements
1532 % in the course of loading the document class.
1533 % Carrying out these operations at that time is needed:
1534 % \cmd\ProcessOptions\ must be executed first.
1535 % \begin{macrocode}
1536 \let\rtx@require@packages\@empty
1537 % \end{macrocode}
1538 % \end{macro}
1539 %
1540 % \begin{macro}{\MakeUppercase}
1541 % \begin{macro}{\MakeLowercase}
1542 % \changes{4.1b}{2008/07/01}{Package textcase is now simply a required package}
1543 % \changes{4.1b}{2008/07/01}{Read in all required packages together}
1544 % \changes{4.1g}{2009/10/07}{(AO, 538) \cs{MakeTextUppercase} inappropriately expands the double backslash}
1545 % We load the \classname{textcase} package of David Carlisle.
1546 % Now that its bug of long standing has been repaired, we no longer need to doctor it up.
1547 % And, because its loading has been deferred until \cmd\rtx@require@packages\ time,
1548 % we no longer override \LaTeX\ here. Instead, the \classname{textcase} package
1549 % will be asked to do that.
1550 % \begin{macrocode}
1551 \appdef\rtx@require@packages{%
1552 \RequirePackage[overload]{textcase}%
1553 }%
1554 % \end{macrocode}
1555 % The following code used to
1556 % let the \classname{textcase} commands override those of \LaTeX:
1557 % \begin{verbatim}
1558 %\appdef\setup@hook{%
1559 % \expandafter
1560 % \let\csname MakeUppercase \expandafter\endcsname
1561 % \csname MakeTextUppercase \endcsname
1562 % \expandafter
1563 % \let\csname MakeLowercase \expandafter\endcsname
1564 % \csname MakeTextLowercase \endcsname
1565 % }%
1566 % \end{verbatim}
1567 % \end{macro}
1568 % \end{macro}
1569 %
1570 % \begin{macro}{amsfonts}
1571 % \changes{4.1b}{2008/07/01}{Read in all required packages together}
1572 % The class option \classoption{amsfonts} has the
1573 % same effect as if the document preamble contained
1574 % a \cmd\usepackage\verb${amsfonts}$ statement.
1575 % \begin{macrocode}
1576 \DeclareOption{amsfonts}{%
1577 \def\class@amsfonts{\RequirePackage{amsfonts}}%
1578 }%
1579 \DeclareOption{noamsfonts}{%
1580 \let\class@amsfonts\@empty
1581 }%
1582 \appdef\rtx@require@packages{%
1583 \@ifxundefined\class@amsfonts{}{\class@amsfonts}%
1584 }%
1585 % \end{macrocode}
1586 % \end{macro}
1587 %
1588 % \begin{macro}{amssymb}
1589 % \changes{4.1b}{2008/07/01}{Read in all required packages together}
1590 % The class option \classoption{amssymb} has the
1591 % same effect as if the document preamble contained
1592 % a \cmd\usepackage\verb${amssymb}$ statement.
1593 % \begin{macrocode}
1594 \DeclareOption{amssymb}{%
1595 \def\class@amssymb{\RequirePackage{amssymb}}%
1596 }%
1597 \DeclareOption{noamssymb}{%
1598 \let\class@amssymb\@empty
1599 }%
1600 \appdef\rtx@require@packages{%
1601 \@ifxundefined\class@amssymb{}{\class@amssymb}%
1602 }%
1603 % \end{macrocode}
1604 % \end{macro}
1605 %
1606 % \begin{macro}{amsmath}
1607 % \changes{4.1b}{2008/07/01}{Read in all required packages together}
1608 % The class option \classoption{amsmath} has the
1609 % same effect as if the document preamble contained
1610 % a \cmd\usepackage\verb${amsmath}$ statement.
1611 %
1612 % We require version 1.2 (datestamped 1997/03/20) or later.
1613 % The \expandafter\cmd\csname [email protected]\endcsname, will
1614 %
1615 % \LaTeX\ note:
1616 % Certain \LaTeX\ procedures have an arbitrary and pointless restriction that they may be used only within the preamble.
1617 % We get around this by preserving the procedures in private \cmd\csname s.
1618 %
1619 % FIXME note: it is difficult to ensure that an error summary will be printed on the console at the very end,
1620 % but \classname{ltxgrid} allows accomplishing this via an interrupt, put down at \cmd\AtEndDocument\ time.
1621 %
1622 % \begin{macrocode}
1623 \DeclareOption{amsmath}{%
1624 \def\class@amsmath{\RequirePackage{amsmath}[\ver@amsmath@prefer]}%
1625 }%
1626 \DeclareOption{noamsmath}{%
1627 \let\class@amsmath\@empty
1628 }%
1629 \appdef\rtx@require@packages{%
1630 \preserve@LaTeX
1631 \@ifxundefined\class@amsmath{}{\class@amsmath}%
1632 \appdef\class@enddocumenthook{\test@amsmath@ver}%
1633 }%
1634 \appdef\preserve@LaTeX{%
1635 \let\@ifl@aded@LaTeX\@ifl@aded
1636 \let\@ifpackageloaded@LaTeX\@ifpackageloaded
1637 \let\@pkgextension@LaTeX\@pkgextension
1638 \let\@ifpackagelater@LaTeX\@ifpackagelater
1639 \let\@ifl@ter@LaTeX\@ifl@ter
1640 \let\@ifl@t@r@LaTeX\@ifl@t@r
1641 \let\@parse@version@LaTeX\@parse@version
1642 }%
1643 \appdef\restore@LaTeX{%
1644 \let\@ifl@aded\@ifl@aded@LaTeX
1645 \let\@ifpackageloaded\@ifpackageloaded@LaTeX
1646 \let\@pkgextension\@pkgextension@LaTeX
1647 \let\@ifpackagelater\@ifpackagelater@LaTeX
1648 \let\@ifl@ter\@ifl@ter@LaTeX
1649 \let\@ifl@t@r\@ifl@t@r@LaTeX
1650 \let\@parse@version\@parse@version@LaTeX
1651 }%
1652 \def\test@amsmath@ver{%
1653 \begingroup
1654 \restore@LaTeX
1655 \@ifpackageloaded{amsmath}{%
1656 \@ifpackagelater{amsmath}{\ver@amsmath@prefer}{}{%
1657 \class@warn{%
1658 You have loaded amsmath, version "\csname [email protected]\endcsname",\MessageBreak
1659 but this class requires version "\ver@amsmath@prefer", or later.\MessageBreak
1660 Please update your LaTeX installation.
1661 }%
1662 }%
1663 }{%
1664 }%
1665 \endgroup
1666 }%
1667 \def\ver@amsmath@prefer{2000/01/15 v2.05 AMS math features}%
1668 % \end{macrocode}
1669 % \end{macro}
1670 %
1671 % \subsubsection{Presenting Authors and Their Affiliations}%
1672 % \changes{4.1b}{2008/07/01}{Code relating to new syntax for frontmatter has been placed in \file{ltxfront.dtx}}
1673 % Class options for presenting authors and their affiliations are now defined in
1674 % \file{ltxfront.dtx}.
1675 %
1676 % \begin{macrocode}
1677 % \end{macrocode}
1678 %
1679 % \subsubsection{Typeset by \revtex}%
1680 %
1681 % \begin{macro}{\byrevtex@sw}
1682 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1683 % The flag \cmd\byrevtex@sw\ signifies that the document should
1684 % bear an imprint to the effect that it was formatted by this document class.
1685 %
1686 % The class option \classoption{byrevtex} signifies that you want the
1687 % ``Typeset by \revtex'' byline to appear on your formatted output.
1688 % By default, no such byline appears.
1689 % \begin{macrocode}
1690 \DeclareOption{byrevtex}{\@booleantrue\byrevtex@sw}%
1691 \@booleanfalse\byrevtex@sw
1692 % \end{macrocode}
1693 % \end{macro}
1694 %
1695 % \subsection{Attempt to fix float placement failure}%
1696 %
1697 % \begin{macro}{\force@deferlist@sw}
1698 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
1699 % \revtex\ uses the \classname{ltxgrid} package, which provides the ability to attempt repairs when
1700 % \LaTeX's float placement mechanism is about to fail, but that facility is turned off by default.
1701 % Users should invoke the \classoption{floatfix} document class option to enable this \LaTeX\ extension.
1702 % If not, a helpful message is printed in the log, indicating how to work around the difficulty.
1703 % \begin{macrocode}
1704 \DeclareOption{floatfix}{\@booleantrue\force@deferlist@sw}%
1705 \DeclareOption{nofloatfix}{\@booleanfalse\force@deferlist@sw}%
1706 \@booleanfalse\force@deferlist@sw
1707 % \end{macrocode}
1708 % \end{macro}
1709 %
1710 % \begin{macro}{\@fltovf}
1711 % \begin{macro}{\@fltstk}
1712 % The \LaTeX\ kernel error message \cmd\@fltovf\ may now be a bit more helpful to the user;
1713 % likewise for the \cmd\@fltstk\ message of \classname{ltxgrid}.
1714 % \begin{macrocode}
1715 \gdef\@fltovf{%
1716 \@latex@error{%
1717 Too many unprocessed floats%
1718 \force@deferlist@sw{}{; try class option [floatfix]}%
1719 }\@ehb
1720 }%
1721 \def\@fltstk{%
1722 \@latex@warning{%
1723 A float is stuck (cannot be placed)%
1724 \force@deferlist@sw{}{; try class option [floatfix]}%
1725 }%
1726 }%
1727 % \end{macrocode}
1728 % \end{macro}
1729 % \end{macro}
1730 %
1731 % \begin{macro}{\ltxgrid@info@sw}
1732 % \begin{macro}{\outputdebug@sw}
1733 % The two options \classoption{ltxgridinfo} and \classoption{outputdebug} turn on informative diagnostics within the
1734 % package \classname{ltxgrid}. Only people who really want to see this output will select these class options.
1735 % Consult documentation for the \classname{ltxgrid} package to see what output the related switches enable.
1736 % \begin{macrocode}
1737 \DeclareOption{ltxgridinfo}{%
1738 \@booleantrue\ltxgrid@info@sw
1739 %\@booleantrue\ltxgrid@foot@info@sw
1740 }%
1741 \DeclareOption{outputdebug}{%
1742 \@booleantrue\outputdebug@sw
1743 \@booleantrue\ltxgrid@info@sw
1744 \@booleantrue\ltxgrid@foot@info@sw
1745 \traceoutput
1746 }%
1747 % \end{macrocode}
1748 % \end{macro}
1749 % \end{macro}
1750 %
1751 % \subsection{Option to relax page height}%
1752 %
1753 % \begin{macro}{\textheight@sw}
1754 % The \classname{ltxgrid} package can set text pages to their natural height or force them to the full
1755 % text height; the latter is the default.
1756 % If setting the pages with a variable length,
1757 % the running foot will move up or down with the natural length of the text column.
1758 % While I recommend against doing so, this option will turn that switch to the latter setting.
1759 % \begin{macrocode}
1760 \DeclareOption{raggedfooter}{\@booleanfalse\textheight@sw}%
1761 \DeclareOption{noraggedfooter}{\@booleantrue\textheight@sw}%
1762 % \end{macrocode}
1763 % \end{macro}
1764 %
1765 % \subsection{Selecting procedure for processing abstract}%
1766 % \changes{4.1b}{2008/07/01}{Remove options newabstract and oldabstract}
1767 % Code defining options \classoption{newabstract} and \classoption{oldabstract} has been removed.
1768 %
1769 % \subsection{Option to turn on diagnostics in the frontmatter}%
1770 %
1771 % \begin{macro}{\frontmatterverbose@sw}
1772 % \changes{4.1b}{2008/07/01}{Code relating to new syntax for frontmatter has been placed in \file{ltxfront.dtx}}
1773 % A diagnostic option, not for the average enduser, which reveals
1774 % the workings of the frontmatter.
1775 % This code interfaces to that of \file{ltxfront.dtx}.
1776 % \begin{macrocode}
1777 \DeclareOption{frontmatterverbose}{\@booleantrue\frontmatterverbose@sw}%
1778 \@booleanfalse\frontmatterverbose@sw
1779 % \end{macrocode}
1780 % \end{macro}
1781 %
1782 % \begin{macro}{\linenumbers@sw}
1783 % \changes{4.1f}{2009/07/07}{(AO, 513) Add class option linenumbers: number the lines a la \classname{lineno}}
1784 % \changes{4.1n}{2009/12/13}{(AO, 573) arrange to load \classname{lineno} after any other packages.}%
1785 % An option to number the lines of type in the output in the manner of \classname{lineno}.
1786 %
1787 % At present, we use that very package to implement this functionality.
1788 % This means that users may modify the workings of that package per its documentation (which see).
1789 %
1790 % However, compatibility with \classname{amsmath} requires that \classname{lineno} be loaded afterwards.
1791 % Therefore, we defer loading of this package until after the preamble is completed.
1792 % \begin{macrocode}
1793 \DeclareOption{linenumbers}{%
1794 \appdef
1795 \class@documenthook{%
1796 \RequirePackage{lineno}[2005/11/02 v4.41]%
1797 \linenumbersep4pt\relax
1798 \linenumbers\relax
1799 }%
1800 }%
1801 % \end{macrocode}
1802 % By default, line numbering is off.
1803 % \end{macro}
1804 %
1805 % \begin{macro}{\NAT@merge}
1806 % \changes{4.1f}{2009/07/15}{(AO, 523) Add class option nomerge, to turn off new natbib 8.3 syntax}
1807 % Add class option nomerge, to turn off natbib 8.3 syntax for citation key.
1808 % The default value of REVTeX 4.1 for \cmd\NAT@merge is \cmd\thr@@, which turns on
1809 % the new syntax along with its semantics.
1810 % Legacy documents that would be incompatible with the new syntax can be successfully processed
1811 % with class option \classoption{nomerge}.
1812 % \begin{macrocode}
1813 \DeclareOption{nomerge}{%
1814 \appdef\setup@hook{%
1815 \@ifnum{\NAT@merge>\z@}{\let\NAT@merge\z@}{}%
1816 }%
1817 }%
1818 % \end{macrocode}
1819 % \end{macro}
1820 %
1821 % \subsection{Default Option, Society, Journal, and pointsize}%
1822 %
1823 % \changes{4.1a}{2008/01/18}{(AO, 488) Change processing of options to allow an unused option to specify society and journal}%
1824 % This change will not break OSA documents because that society is still built in to revtex4.
1825 %
1826 % \begin{macro}{\@parse@class@options@society}
1827 % \begin{macro}{\@parse@class@options@}
1828 % \changes{4.1b}{2008/07/01}{Procedures \cs{@parse@class@options@society} and \cs{@parse@class@options@journal} and friends}
1829 % The procedure \cmd\@parse@class@options@society\ parses the options passed to this document class
1830 % for the \cmd\@society.
1831 % It is like \cmd\ProcessOptions*\ in that it accesses
1832 % \cmd\@ptionlist\{\cmd\@currname.\cmd\@currext\}.
1833 % Any undefined option is considered: if there is a corresponding \file{.rtx} file,
1834 % it will change the society accordingly
1835 % and define a placeholder class option for the society thus found
1836 % (thus preventing a spurious "option not found" message).
1837 %
1838 % The procedure \cmd\@parse@class@options@\ parses the document's options
1839 % for any that set the \cmd\csname\ provided.
1840 % \begin{macrocode}
1841 \def\@parse@class@options@society{%
1842 \edef\@tempa{\@ptionlist{\@currname.\@currext}}%
1843 \expandafter\@for\expandafter\CurrentOption\expandafter:\expandafter=\@tempa\do{%
1844 \expandafter\@ifnotrelax\csname ds@\CurrentOption\endcsname{}{%
1845 \IfFileExists{\CurrentOption\substyle@post.\substyle@ext}{%
1846 \expandafter\change@society\expandafter{\CurrentOption}%
1847 \expandafter\let\csname ds@\CurrentOption\endcsname\@empty
1848 }{}%
1849 }%
1850 }%
1851 }%
1852 \def\@parse@class@options@#1{%
1853 \edef\@tempa{\@ptionlist{\@currname.\@currext}}%
1854 \expandafter\@for\expandafter\CurrentOption\expandafter:\expandafter=\@tempa\do{%
1855 \expandafter\@ifnotrelax\csname ds@\CurrentOption\endcsname{%
1856 \begingroup\csname ds@\CurrentOption\endcsname
1857 \@ifxundefined#1{%
1858 \endgroup
1859 }{%
1860 \expandafter\endgroup\expandafter\def\expandafter#1\expandafter{#1}%
1861 }%
1862 }{}%
1863 }%
1864 }%
1865 \def\@parse@class@options@journal{%
1866 \edef\@tempa{\@ptionlist{\@currname.\@currext}}%
1867 \expandafter\@for\expandafter\CurrentOption\expandafter:\expandafter=\@tempa\do{%
1868 \expandafter\@ifnotrelax\csname ds@\CurrentOption\endcsname{%
1869 \begingroup
1870 \csname ds@\CurrentOption\endcsname
1871 \@ifxundefined\@journal{%
1872 \endgroup
1873 }{%
1874 \expandafter\endgroup\expandafter\def\expandafter\@journal\expandafter{\@journal}%
1875 }%
1876 }{}%
1877 }%
1878 }%
1879 \def\@parse@class@options{%
1880 \edef\@tempa{\@ptionlist{\@currname.\@currext}}%
1881 \expandafter\@for\expandafter\CurrentOption\expandafter:\expandafter=\@tempa\do{%
1882 \expandafter\@ifnotrelax\csname ds@\CurrentOption\endcsname{%
1883 \begingroup
1884 \csname ds@\CurrentOption\endcsname
1885 \@ifxundefined\@pointsize{%
1886 \endgroup
1887 }{%
1888 \expandafter\endgroup\expandafter\def\expandafter\@pointsize\expandafter{\@pointsize}%
1889 }%
1890 }{%
1891 \IfFileExists{\CurrentOption\substyle@post.\substyle@ext}{%
1892 \expandafter\change@society\expandafter{\CurrentOption}%
1893 \expandafter\let\csname ds@\CurrentOption\endcsname\@empty
1894 }{}%
1895 }%
1896 }%
1897 }%
1898 % \end{macrocode}
1899 % \end{macro}
1900 % \end{macro}
1901 %
1902 % \changes{4.1j}{2009/10/25}{(AO, 545) hypertext capabilities off by default; enable with \classoption{hypertext}}
1903 % The class option \classoption{hypertext} enables the built-in hypertext capabilities,
1904 % which coincide with those of \classname{custom-bib}-generated BIBTeX styles
1905 % using the guard code \texttt{hypertext}.
1906 %
1907 % Note that APS has these capabilities turned off by default;
1908 % Loading the hyperref package turns them on.
1909 % \begin{macrocode}
1910 \DeclareOption{hypertext}{\hypertext@enable@ltx}%
1911 \appdef\document@inithook{\@ifpackageloaded{hyperref}{\hypertext@enable@ltx}{}}%
1912 % \end{macrocode}
1913 %
1914 % The default handling for a document class option depends upon whether the \cmd\@society\ is
1915 % defined.
1916 %
1917 % If not, then hunt for a \file{.rtx} file with that name.
1918 % If it exists, then we will take this option as the name of the society,
1919 % otherwise, declare the option as not used.
1920 %
1921 % (This behavior is similar to the \LaTeX2.09 handling, where
1922 % one looked for a \file{.sty} file, except that
1923 % in this case, we must provide for journal substyles that may be
1924 % defined in the society file, or have their own journal substyle file.)
1925 %
1926 % At the point where the class file is finished loading,
1927 % we then read in the society file.
1928 % That file can define further class options, such as the journal substyle.
1929 %
1930 % For users, this will mean that they can specify the society and journal simply
1931 % by specifying first the former and then the latter among their document class options.
1932 % The society \emph{must} have a corresponding \file{.rtx}.
1933 %
1934 % \changes{4.1b}{2008/05/29}{The csname substyle@ext is now defined without a dot (.), to be compatible with \LaTeX usage (see @clsextension and @pkgextension).}
1935 %
1936 % \begin{macrocode}
1937 %</options>
1938 % \end{macrocode}
1939 %
1940 % \begin{macrocode}
1941 %<*package>
1942 % \end{macrocode}
1943 %
1944 % \begin{macro}{\@process@society}
1945 % \begin{macro}{\@process@journal}
1946 % \begin{macro}{\@process@pointsize}
1947 % \begin{macrocode}
1948 \def\substyle@post{4-1}%
1949 \def\substyle@ext{rtx}%
1950 \DeclareOption*{\OptionNotUsed}%
1951 % \end{macrocode}
1952 % A society substyle may define its own options, via \cmd\DeclareOption.
1953 %
1954 % At the end of this document class, we process the society file,
1955 % using \file{aps.rtx} if none has been specified in the document.
1956 % \begin{macrocode}
1957 \def\@process@society#1{%
1958 \@ifxundefined\@society{%
1959 \class@warn{No Society specified, using default society #1}%
1960 \def\@society{#1}\let\@journal\@undefined
1961 }{}%
1962 \expandafter\input\expandafter{\@society\substyle@post.\substyle@ext}%
1963 }%
1964 % \end{macrocode}
1965 %
1966 % A society substyle can encompass any number of journal substyles;
1967 % we use the following procedure to invoke the proper one.
1968 % \begin{macrocode}
1969 \def\@process@journal#1{%
1970 \@ifxundefined\@journal{%
1971 \class@warn{No journal specified, using default #1}%
1972 \def\@journal{#1}%
1973 }{}%
1974 \expandafter\expandafter
1975 \expandafter\rtx@do@substyle
1976 \expandafter\expandafter
1977 \expandafter{\expandafter\@society\@journal}%
1978 }%
1979 \def\rtx@do@substyle#1{%
1980 \InputIfFileExists{#1\substyle@post.\substyle@ext}{}{\csname rtx@#1\endcsname}%
1981 }%
1982 % \end{macrocode}
1983 %
1984 % Document class options \classoption{10pt}, \classoption{11pt}, and \classoption{12pt}
1985 % are implemented by \revtex\ itself and determine \cmd\@pointsize.
1986 % These provide formatting settings appropriate to the society's journals.
1987 %
1988 % If not specified by the document, a value \cmd\@pointsize@default\ is used.
1989 % This default can be set by the journal. Here, the society sets its default.
1990 % \begin{macrocode}
1991 \def\@process@pointsize#1{%
1992 \@ifxundefined\@pointsize{%
1993 \def\@pointsize{#1}%
1994 \class@warn{No type size specified, using default \@pointsize}%
1995 }{}%
1996 \expandafter\expandafter
1997 \expandafter\rtx@do@substyle
1998 \expandafter\expandafter
1999 \expandafter{\expandafter\@society\@pointsize pt}%
2000 }%
2001 % \end{macrocode}
2002 % \end{macro}
2003 % \end{macro}
2004 % \end{macro}
2005 %
2006 % \subsection{Class-Asserted Options}%
2007 % \changes{4.0b}{1999/06/20}{Removed invocation of nonexistent class option \protect\classoption{groupauthors} and all other class options that should only be invoked by the document. (Otherwise precedence of class options does not work.)}
2008 % Here we establish the default document class options.
2009 % Those of the document itself will override these.
2010 %
2011 % \section{Procedures Dependent Upon Options}
2012 %
2013 % Here we introduce \classname{classes.dtx} definitions for
2014 % the page styles that people will expect to be able to use.
2015 % \begin{macro}{\ps@headings}
2016 % \begin{macro}{\ps@myheadings}
2017 % \begin{macrocode}
2018 \def\ps@headings{%
2019 \let\@oddfoot\@empty\let\@evenfoot\@empty
2020 \def\@evenhead{\thepage\hfil\slshape\leftmark}%
2021 \def\@oddhead{{\slshape\rightmark}\hfil\thepage}%
2022 \let\@mkboth\markboth
2023 \def\sectionmark##1{%
2024 \markboth {\MakeUppercase{%
2025 \ifnum \c@secnumdepth >\z@
2026 \thesection\quad
2027 \fi
2028 ##1}}{}}%
2029 \def\subsectionmark##1{%
2030 \markright {%
2031 \ifnum \c@secnumdepth >\@ne
2032 \thesubsection\quad
2033 \fi
2034 ##1}}}%
2035 \def\ps@myheadings{%
2036 \let\@oddfoot\@empty\let\@evenfoot\@empty
2037 \def\@evenhead{\thepage\hfil\slshape\leftmark}%
2038 \def\@oddhead{{\slshape\rightmark}\hfil\thepage}%
2039 \let\@mkboth\@gobbletwo
2040 \let\sectionmark\@gobble
2041 \let\subsectionmark\@gobble
2042 }%
2043 % \end{macrocode}
2044 % \end{macro}
2045 % \end{macro}
2046 %
2047 % \begin{macro}{\ps@article}
2048 % \begin{macro}{\ps@article@final}
2049 % \begin{macro}{\ps@preprint}
2050 % \changes{4.0a}{1998/01/31}{Move after process options, so the following test works}
2051 % \changes{4.0b}{1999/06/20}{Defer decision until \cs{AtBeginDocument} time}
2052 % \changes{4.0c}{1999/11/13}{Insert procedure \cs{checkindate}}
2053 % \changes{4.0rc1}{2001/06/17}{Running headers always as if two-sided}
2054 % \begin{macrocode}
2055 \def\ps@article{%
2056 \def\@evenhead{\let\\\heading@cr\thepage\quad\checkindate\hfil{\leftmark}}%
2057 \def\@oddhead{\let\\\heading@cr{\rightmark}\hfil\checkindate\quad\thepage}%
2058 \def\@oddfoot{}%
2059 \def\@evenfoot{}%
2060 \let\@mkboth\markboth
2061 \let\sectionmark\@gobble
2062 \let\subsectionmark\@gobble
2063 }%
2064 \def\ps@article@final{%
2065 \def\@evenhead{\let\\\heading@cr\thepage\quad\checkindate\hfil{\leftmark}}%
2066 \def\@oddhead{\let\\\heading@cr{\rightmark}\hfil\checkindate\quad\thepage}%
2067 \def\@oddfoot{}%
2068 \def\@evenfoot{}%
2069 \let\@mkboth\markboth
2070 \def\sectionmark##1{%
2071 \markboth{%
2072 \MakeTextUppercase{%
2073 \@ifnum{\c@secnumdepth >\z@}{\thesection\hskip 1em\relax}{}%
2074 ##1%
2075 }%
2076 }{}%
2077 }%
2078 \def\subsectionmark##1{%
2079 \markright {%
2080 \@ifnum{\c@secnumdepth >\@ne}{\thesubsection\hskip 1em\relax}{}%
2081 ##1%
2082 }%
2083 }%
2084 }%
2085 % \end{macrocode}
2086 %
2087 % \begin{macrocode}
2088 \def\heading@cr{\unskip\space\ignorespaces}%
2089 % \end{macrocode}
2090 %
2091 % \changes{4.0c}{1999/11/13}{Do not put by REVTeX in every page foot}
2092 % \changes{4.0c}{1999/11/13}{Insert procedure \cs{checkindate}}
2093 % \begin{macrocode}
2094 \def\ps@preprint{%
2095 \def\@oddfoot{\hfil\thepage\quad\checkindate\hfil}%
2096 \def\@evenfoot{\hfil\thepage\quad\checkindate\hfil}%
2097 \def\@oddhead{}%
2098 \def\@evenhead{}%
2099 \let\@mkboth\@gobbletwo
2100 \let\sectionmark\@gobble
2101 \let\subsectionmark\@gobble
2102 }%
2103 % \end{macrocode}
2104 %
2105 % \begin{macrocode}
2106 \let\@oddhead\@empty
2107 \let\@evenhead\@empty
2108 \let\@oddfoot\@empty
2109 \let\@evenfoot\@empty
2110 % \end{macrocode}
2111 % \end{macro}
2112 % \end{macro}
2113 % \end{macro}
2114 %
2115 % \begin{macro}{\lastpage@putlabel}
2116 % Support the default meaning of \cmd\@endpage.
2117 % \changes{4.0a}{1998/01/31}{Move after process options, so \cs{clearpage} not in scope of twocolumn}
2118 % \changes{4.1k}{2009/11/06}{(AO, 554) give the \cs{newlabel} command syntax appropriate to the hyperref package}
2119 % Name of this macro (and the \cmd\label\ key) taken from
2120 % \url{CTAN:/macros/latex/contrib/other/lastpage}%
2121 % with code optimised slightly.
2122 % \begin{macrocode}
2123 \def\lastpage@putlabel{%
2124 \if@filesw
2125 \begingroup
2126 \advance\c@page\m@ne
2127 \immediate\write\@auxout{\string\newlabel{LastPage}{{}{\thepage}{}{}{}}}%
2128 \endgroup
2129 \fi
2130 }%
2131 % \end{macrocode}
2132 % Install a procedure into document endgame processing that
2133 % labels the last page of the document.
2134 % This is done just before the \file{.aux} file
2135 % is closed, and does not require a \cmd\shipout, because it writes
2136 % directly to the \file{.aux} file.
2137 % Note that we assume no further \cmd\shipout s will be done past this point.
2138 % \changes{4.1n}{2009/12/09}{(AO, 569) execute the after-last-shipout procedures from within the safety of the output routine}%
2139 % \begin{macrocode}
2140 \appdef\clear@document{%
2141 \do@output@cclv{%
2142 \lastpage@putlabel
2143 \tally@box@size@sw{\total@text}{}%
2144 }%
2145 }%
2146 \providecommand\write@column@totals{}%
2147 % \end{macrocode}
2148 % \end{macro}
2149 %
2150 %
2151 % \section{Required Packages}
2152 % \url{CTAN:macros/latex/contrib/other/misc/url.sty}%
2153 % \begin{macrocode}
2154 \appdef\rtx@require@packages{%
2155 \RequirePackage{url}%
2156 }%
2157 % \end{macrocode}
2158 %
2159 % \section{Incompatible Packages}
2160 %
2161 % We wait until after the preamble is processed, then check for any packages
2162 % that might have been loaded which we know to be incompatible with \revtex.
2163 %
2164 % The \classname{multicol} package is incompatible with \classname{ltxgrid}, which replaces it.
2165 % The \classname{cite} package is incompatible with \classname{natbib}, which replaces its functionality.
2166 % The functionality of the \classname{mcite} package is provided by \classname{natbib}.
2167 % \begin{macrocode}
2168 \appdef\document@inithook{%
2169 \incompatible@package{cite}%
2170 \incompatible@package{mcite}%
2171 \incompatible@package{multicol}%
2172 }%
2173 % \end{macrocode}
2174 %
2175 % \section{Society- and Journal-Specific Code}
2176 %
2177 % \begin{macro}{\@journal}
2178 % Journal test helper, used as
2179 % \begin{verbatim}
2180 %\@ifx{\@journal\journal@pra}{%
2181 % <journal-specific setup>
2182 %\fi
2183 % \end{verbatim}
2184 % Journal code might like to further specify (if as yet undefined) or distinguish on
2185 % the following Booleans.
2186 %
2187 % Note: the journal substyle code should only alter the value of one of these Booleans if
2188 % the Boolean is \cmd\undefined. This convention is what makes the document's
2189 % options take precedence over the values set by the journal.
2190 %
2191 % FIXME: make this table an exhaustive listing of all the parameters set by
2192 % the class options.
2193 %
2194 % \begin{tabular}{ll}
2195 % \cmd\@pointsize &(10|11|12), depending on the type size\\
2196 % \cmd\footinbib@sw &true if footnotes are to be formatted in the bibliography\\
2197 % \cmd\preprintsty@sw &true for preprint and hyperpreprint\\
2198 % \cmd\eqsecnum@sw &true means that equations are numbered within sections\\
2199 % \cmd\groupauthors@sw &true means authors listed separately for each address\\
2200 % \cmd\preprint@sw &true means to produce the preprint numbers as part of the title block\\
2201 % \cmd\showPACS@sw &true means to produce the PACS as part of the title block\\
2202 % \cmd\showKEYS@sw &true means to produce the keywords as part of the title block\\
2203 % \cmd\@affils@sw &true means each affiliation is printed, for each author\\
2204 % \cmd\runinaddress@sw &true means author addresses are printed run-in\\
2205 % \cmd\draft@sw &true implies that PACS will be printed\\
2206 % \cmd\tightenlines@sw &true if preprint single spaced\\
2207 % \cmd\lengthcheck@sw &true if length checking is in effect\\
2208 % \cmd\byrevtex@sw &true means to announce ``typeset by \revtex''\\
2209 % \cmd\titlepage@sw &true for title is to be set on a separate page\\
2210 % \cmd\twocolumn@sw &true if two-column page grid\\
2211 % \cmd\twocolumn@sw &true if we are to automatically balance the columns of the last page\\
2212 % \cmd\twoside@sw &true means to format pages for duplex printing\\
2213 % \cmd\floats@sw &false means floats are migrated to end of document\\
2214 % \cmd\floatp@sw &true means endfloats are set one to a page\\
2215 % \cmd\class@amsfonts &if \cmd\@empty, means that \classname{amsfonts} will \emph{not} be loaded\\
2216 % \cmd\class@amssymb &if \cmd\@empty, means that \classname{amssymb} will \emph{not} be loaded\\
2217 % \cmd\frontmatter@footnote &if \cmd\undefined, means that the default (\cmd\footnote) will be used\\
2218 % \cmd\place@bibnumber &if \cmd\undefined, means that the default (inline) will be used\\
2219 % \end{tabular}
2220 %
2221 % Note: if \cmd\twocolumn@sw\ and \cmd\preprintsty@sw\ are both false,
2222 % then `galley' style is in effect. The \classoption{galley} option invokes
2223 % \classoption{onecolumn}, but does not affect the \cmd\preprintsty@sw.
2224 %
2225 % Note: \cmd\paperwidth\ and \cmd\paperheight\ are not integrated into this scheme,
2226 % and should be selected by the document alone.
2227 % \end{macro}
2228 %
2229 % \section{Body}
2230 %
2231 % \subsection{counters}
2232 % The following definitions are probably identical to those in
2233 % \file{classes.dtx}%
2234 % \begin{macrocode}
2235 \def\labelenumi{\theenumi.}
2236 \def\theenumi{\arabic{enumi}}
2237 % \end{macrocode}
2238 %
2239 % \begin{macrocode}
2240 \def\labelenumii{(\theenumii)}
2241 \def\theenumii{\alph{enumii}}
2242 \def\p@enumii{\theenumi}
2243 % \end{macrocode}
2244 %
2245 % \begin{macrocode}
2246 \def\labelenumiii{\theenumiii.}
2247 \def\theenumiii{\roman{enumiii}}
2248 \def\p@enumiii{\theenumi(\theenumii)}
2249 % \end{macrocode}
2250 %
2251 % \begin{macrocode}
2252 \def\labelenumiv{\theenumiv.}
2253 \def\theenumiv{\Alph{enumiv}}
2254 \def\p@enumiv{\p@enumiii\theenumiii}
2255 % \end{macrocode}
2256 %
2257 % \begin{macrocode}
2258 \def\labelitemi{\textbullet}
2259 \def\labelitemii{\normalfont\bfseries\textendash}
2260 \def\labelitemiii{\textasteriskcentered}
2261 \def\labelitemiv{\textperiodcentered}
2262 % \end{macrocode}
2263 %
2264 % \begin{macrocode}
2265 \pagenumbering{arabic}
2266 % \end{macrocode}
2267 %
2268 % \subsection{float parameters}
2269 %
2270 % from the old aps.sty. (DPC: same as article I think)
2271 % AO: here, \LaTeX's standard classes fail very poorly
2272 % (the price of backward compatability): the values for
2273 % \cmd\floatpagefraction\ and \cmd\dblfloatpagefraction\
2274 % need to be raised to avoid creating extremely short
2275 % float pages.
2276 % \begin{macrocode}
2277 \setcounter{topnumber}{2}
2278 \def\topfraction{.9}
2279 \setcounter{bottomnumber}{1}
2280 \def\bottomfraction{.9}
2281 \setcounter{totalnumber}{3}
2282 \def\textfraction{.1}
2283 \def\floatpagefraction{.9}
2284 \setcounter{dbltopnumber}{2}
2285 \def\dbltopfraction{.9}
2286 \def\dblfloatpagefraction{.9}
2287 % \end{macrocode}
2288 %
2289 % \subsection{List Environments}
2290 %
2291 % \begin{macrocode}
2292 \newenvironment{verse}{%
2293 \let\\=\@centercr
2294 \list{}{%
2295 \itemsep\z@ \itemindent -1.5em\listparindent \itemindent
2296 \rightmargin\leftmargin\advance\leftmargin 1.5em}\item[]%
2297 }{%
2298 \endlist
2299 }%
2300 % \end{macrocode}
2301 %
2302 % \begin{macrocode}
2303 \newenvironment{quotation}{%
2304 \list{}{%
2305 \listparindent 1.5em
2306 \itemindent\listparindent
2307 \rightmargin\leftmargin \parsep \z@ \@plus\p@}\item[]%
2308 }{%
2309 \endlist
2310 }%
2311 % \end{macrocode}
2312 %
2313 % \begin{macrocode}
2314 \newenvironment{quote}{%
2315 \list{}{%
2316 \rightmargin\leftmargin}\item[]%
2317 }{%
2318 \endlist
2319 }%
2320 % \end{macrocode}
2321 %
2322 % \changes{4.1b}{2008/06/30}{(AO) Structure the Abstract using the \texttt{bibliography} environment}
2323 % \begin{macrocode}
2324 \def\descriptionlabel#1{%
2325 \hspace\labelsep \normalfont\bfseries #1\unskip:%
2326 }%
2327 % \end{macrocode}
2328 %
2329 % \begin{macrocode}
2330 \newenvironment{description}{%
2331 \list{}{%
2332 \labelwidth\z@ \itemindent-\leftmargin
2333 \let\makelabel\descriptionlabel
2334 }%
2335 }{%
2336 \endlist
2337 }%
2338 % \end{macrocode}
2339 %
2340 % \subsection{Sectioning Commands\label{sec:secnumarabic}}
2341 %
2342 % \subsubsection{Sectioning Commands and Their Productions}%
2343 % The following counters are defined by LaTeX's standard document classes.
2344 % We do likewise, then assign flag values to the productions, awaiting
2345 % overrides.
2346 % \begin{macrocode}
2347 \newcounter{part}%
2348 \let\thepart\@undefined
2349 \newcounter{section}%
2350 \let\thesection\@undefined
2351 \newcounter{subsection}[section]%
2352 \let\thesubsection\@undefined
2353 \newcounter{subsubsection}[subsection]%
2354 \let\thesubsubsection\@undefined
2355 \newcounter{paragraph}[subsubsection]%
2356 \let\theparagraph\@undefined
2357 \newcounter{subparagraph}[paragraph]%
2358 \let\thesubparagraph\@undefined
2359 % \end{macrocode}
2360 % The procedure invoked by \cmd\setup@secnums\ provides meanings for these productions.
2361 %
2362 % \begin{macro}{\secnums@rtx}
2363 % \begin{macro}{\secnums@arabic}
2364 % These two procedures define the meanings of each of the productions
2365 % of the counters of the sectioning commands,
2366 % but only if nothing else has defined it.
2367 % \begin{macrocode}
2368 \def\secnums@rtx{%
2369 \@ifxundefined\thepart{%
2370 \def\thepart{\Roman{part}}%
2371 }{}%
2372 \@ifxundefined\thesection{%
2373 \def\thesection {\Roman{section}}%
2374 \def\p@section {}%
2375 }{}%
2376 \@ifxundefined\thesubsection{%
2377 \def\thesubsection {\Alph{subsection}}%
2378 \def\p@subsection {\thesection\,}%
2379 }{}%
2380 \@ifxundefined\thesubsubsection{%
2381 \def\thesubsubsection {\arabic{subsubsection}}%
2382 \def\p@subsubsection {\thesection\,\thesubsection\,}%
2383 }{}%
2384 \@ifxundefined\theparagraph{%
2385 \def\theparagraph {\alph{paragraph}}%
2386 \def\p@paragraph {\thesection\,\thesubsection\,\thesubsubsection\,}%
2387 }{}%
2388 \@ifxundefined\thesubparagraph{%
2389 \def\thesubparagraph {\arabic{subparagraph}}%
2390 \def\p@subparagraph {\thesection\,\thesubsection\,\thesubsubsection\,\theparagraph\,}%
2391 }{}%
2392 }%
2393 \def\secnums@arabic{%
2394 \@ifxundefined\thepart{%
2395 \def\thepart {\Roman{part}}%
2396 }{}%
2397 \@ifxundefined\thesection{%
2398 \def\thesection {\Roman{section}}%
2399 \def\p@section {}%
2400 }{}%
2401 \@ifxundefined\thesubsection{%
2402 \def\thesubsection {\thesection.\arabic{subsection}}%
2403 \def\p@subsection {}%
2404 }{}%
2405 \@ifxundefined\thesubsubsection{%
2406 \def\thesubsubsection {\thesubsection.\arabic{subsubsection}}%
2407 \def\p@subsubsection {}%
2408 }{}%
2409 \@ifxundefined\theparagraph{%
2410 \def\theparagraph {\thesubsubsection.\arabic{paragraph}}%
2411 \def\p@paragraph {}%
2412 }{}%
2413 \@ifxundefined\thesubparagraph{%
2414 \def\thesubparagraph {\theparagraph.\arabic{subparagraph}}%
2415 \def\p@subparagraph {}%
2416 }{}%
2417 }%
2418 % \end{macrocode}
2419 % \end{macro}
2420 % \end{macro}
2421 %
2422 % \subsubsection{The Acknowledgments Environment}%
2423 % This user-level markup produces a head introducing
2424 % the acknowledgments, and acts as a wrapper for the text.
2425 % In this implementation, it is an unnumbered section,
2426 % but appears within the toc.
2427 %
2428 % For compatiability's sake, we implement it under the alternative
2429 % spelling \env{acknowledgements}.
2430 % \changes{4.0c}{1999/11/13}{also spelled ``acknowledgements''.}
2431 % \changes{4.0d}{2000/05/18}{But alternative spelling is deprecated.}
2432 % \begin{macrocode}
2433 \newenvironment{acknowledgments}{%
2434 \acknowledgments@sw{%
2435 \expandafter\section\expandafter*\expandafter{\acknowledgmentsname}%
2436 }{%
2437 \par
2438 \phantomsection
2439 \addcontentsline{toc}{section}{\protect\numberline{}\acknowledgmentsname}%
2440 }%
2441 }{%
2442 \par
2443 }%
2444 \@booleantrue\acknowledgments@sw
2445 \newenvironment{acknowledgements}{%
2446 \replace@environment{acknowledgements}{acknowledgments}%
2447 }{%
2448 \endacknowledgments
2449 }%
2450 % \end{macrocode}
2451 %
2452 % \subsubsection{Part Opener}%
2453 % section setup copied verbatim from revtex3 aps/osa.
2454 % Does not explicitly depend on pointsize options.
2455 % \begin{macrocode}
2456 \def\part{\par
2457 \addvspace{4ex}%
2458 \@afterindentfalse
2459 \secdef\@part\@spart}%
2460 % \end{macrocode}
2461 %
2462 % \begin{macrocode}
2463 \def\@part[#1]#2{%
2464 \@ifnum{\c@secnumdepth >\m@ne}{%
2465 \refstepcounter{part}%
2466 \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}%
2467 }{%
2468 \addcontentsline{toc}{part}{#1}%
2469 }%
2470 \begingroup
2471 \parindent \z@ \raggedright
2472 \interlinepenalty\@M
2473 \@ifnum{\c@secnumdepth >\m@ne}{%
2474 \Large \bf \partname~\thepart%
2475 \par\nobreak
2476 }{}%
2477 \huge \bf
2478 #2%
2479 \markboth{}{}\par
2480 \endgroup
2481 \nobreak
2482 \vskip 3ex
2483 \@afterheading
2484 }%
2485 % \end{macrocode}
2486 %
2487 % \begin{macrocode}
2488 \def\@spart#1{{\parindent \z@ \raggedright
2489 \interlinepenalty\@M
2490 \huge \bf
2491 #1\par}
2492 \nobreak
2493 \vskip 3ex
2494 \@afterheading}
2495 % \end{macrocode}
2496 %
2497 % \subsubsection{Stacked Heads}%
2498 % Here are the class default definitions for sectioning commands.
2499 % A society or a journal substyle will likely override these definitions.
2500 %
2501 % In doing so, you can customize the formatting for a particular level by defining,
2502 % e.g., \cmd\@hangfrom@section\ or \cmd\@subsectioncntformat.
2503 % \begin{macrocode}
2504 \def\section{%
2505 \@startsection
2506 {section}%
2507 {1}%
2508 {\z@}%
2509 {0.8cm \@plus1ex \@minus .2ex}%
2510 {0.5cm}%
2511 {\normalfont\small\bfseries}%
2512 }%
2513 % \end{macrocode}
2514 %
2515 % \begin{macrocode}
2516 \def\subsection{%
2517 \@startsection
2518 {subsection}%
2519 {2}%
2520 {\z@}%
2521 {.8cm \@plus1ex \@minus .2ex}%
2522 {.5cm}%
2523 {\normalfont\small\bfseries}%
2524 }%
2525 % \end{macrocode}
2526 %
2527 % \begin{macrocode}
2528 \def\subsubsection{%
2529 \@startsection
2530 {subsubsection}%
2531 {3}%
2532 {\z@}%
2533 {.8cm \@plus1ex \@minus .2ex}%
2534 {.5cm}%
2535 {\normalfont\small\itshape}%
2536 }%
2537 % \end{macrocode}
2538 %
2539 % \subsubsection{Runin Heads}%
2540 % \begin{macrocode}
2541 \def\paragraph{%
2542 \@startsection
2543 {paragraph}%
2544 {4}%
2545 {\parindent}%
2546 {\z@}%
2547 {-1em}%
2548 {\normalfont\normalsize\itshape}%
2549 }%
2550 % \end{macrocode}
2551 %
2552 % \begin{macrocode}
2553 \def\subparagraph{%
2554 \@startsection
2555 {subparagraph}%
2556 {5}%
2557 {\parindent}%
2558 {3.25ex \@plus1ex \@minus .2ex}%
2559 {-1em}%
2560 {\normalfont\normalsize\bfseries}%
2561 }%
2562 % \end{macrocode}
2563 %
2564 %
2565 % \subsection{Math}
2566 %
2567 % \begin{macro}{\theequation}
2568 % We change the production of the equation counter so that
2569 % we can accomodate the \classoption{eqsecnum} option.
2570 % \begin{macrocode}
2571 \def\theequation{%
2572 \theequation@prefix\arabic{equation}%
2573 }%
2574 \def\theequation@prefix{}%
2575 % \end{macrocode}
2576 % \end{macro}
2577 %
2578 %
2579 % \subsection{Type Size-Dependent Settings}
2580 %
2581 % \subsection{All Point Sizes}
2582 % \begin{macrocode}
2583 \setcounter{secnumdepth}{4}
2584 % \end{macrocode}
2585 %
2586 % \begin{macrocode}
2587 \lineskip 1pt
2588 \normallineskip 1pt
2589 \def\baselinestretch{1}%
2590 % \end{macrocode}
2591 %
2592 % \begin{macrocode}
2593 \@lowpenalty 51
2594 \@medpenalty 151
2595 \@highpenalty 301
2596 % \end{macrocode}
2597 %
2598 % \begin{macrocode}
2599 \@beginparpenalty -\@lowpenalty
2600 \@endparpenalty -\@lowpenalty
2601 \@itempenalty -\@lowpenalty
2602 % \end{macrocode}
2603 %
2604 % \begin{macrocode}
2605 \arraycolsep 3pt
2606 \tabcolsep 2pt
2607 \arrayrulewidth .4pt
2608 \doublerulesep 2pt
2609 % \end{macrocode}
2610 %
2611 % \begin{macrocode}
2612 \skip\@mpfootins = 0pt
2613 % \end{macrocode}
2614 %
2615 % \begin{macrocode}
2616 \fboxsep = 3.0pt
2617 \fboxrule = 0.4pt
2618 % \end{macrocode}
2619 %
2620 % \subsection{Figures}
2621 % \changes{4.0b}{1999/06/20}{Processing delayed to \cs{AtBeginDocument} time}
2622 %
2623 % \begin{environment}{figure}
2624 % We define the \env{figure} environment.
2625 % Later, we will horse around with its meaning
2626 % in order to accomodate \cmd\floats@sw.
2627 % \begin{macrocode}
2628 \newenvironment{figure}
2629 {\@float{figure}}
2630 {\end@float}
2631 \newenvironment{figure*}
2632 {\@dblfloat{figure}}
2633 {\end@dblfloat}
2634 % \end{macrocode}
2635 % \end{environment}
2636 %
2637 % \begin{macrocode}
2638 \def\listoffigures{\print@toc{lof}}%
2639 \def\l@figure{\@dottedtocline{1}{1.5em}{2.3em}}%
2640 % \end{macrocode}
2641 %
2642 % \begin{macro}{\@makecaption}
2643 % If caption is one line long, to be centered; if lines turn, then set justified.
2644 % \begin{macrocode}
2645 \newlength\abovecaptionskip
2646 \newlength\belowcaptionskip
2647 \setlength\abovecaptionskip{10\p@}
2648 \setlength\belowcaptionskip{2\p@}
2649 % \end{macrocode}
2650 %
2651 % \changes{4.0b}{1999/06/20}{One-line caption sets flush left.}
2652 % \changes{4.0c}{1999/11/13}{Prevent an inner footnote from performing twice}
2653 % \changes{4.1a}{2008/01/18}{(AO, 460) ``Proper style is "FIG. 1. ..." (no colon)''}%
2654 % There is a hook \cmd\@caption@fignum@sep\ for determining
2655 % the separator following the float number, e.g., ``Fig.1''.
2656 % Formerly, we had defined it to be ``: '', now the colon has been replace by a period (full stop).
2657 % \begin{macrocode}
2658 \long\def\@makecaption#1#2{%
2659 \par
2660 % \nobreak
2661 \vskip\abovecaptionskip
2662 \begingroup
2663 \small\rmfamily
2664 \sbox\@tempboxa{%
2665 \let\\\heading@cr
2666 \@make@capt@title{#1}{#2}%
2667 }%
2668 \@ifdim{\wd\@tempboxa >\hsize}{%
2669 \begingroup
2670 \samepage
2671 \flushing
2672 \let\footnote\@footnotemark@gobble
2673 \@make@capt@title{#1}{#2}\par
2674 \endgroup
2675 }{%
2676 \global \@minipagefalse
2677 \hb@xt@\hsize{\hfil\unhbox\@tempboxa\hfil}%
2678 }%
2679 \endgroup
2680 \vskip\belowcaptionskip
2681 }%
2682 \def\@make@capt@title#1#2{%
2683 \@ifx@empty\float@link{\@firstofone}{\expandafter\href\expandafter{\float@link}}%
2684 {#1}\@caption@fignum@sep#2%
2685 }%
2686 \def\@footnotemark@gobble{%
2687 \@footnotemark
2688 \@ifnextchar[{\@gobble@opt@i}{\@gobble}%
2689 }%
2690 \def\@gobble@opt@i[#1]#2{}%
2691 \def\@mpmakefntext#1{%
2692 \flushing
2693 \parindent=1em
2694 \noindent
2695 \hb@xt@1em{\hss\@makefnmark}%
2696 #1%
2697 }%
2698 \def\@caption@fignum@sep{. }%
2699 \def\setfloatlink{\def\float@link}%
2700 \let\float@link\@empty
2701 % \end{macrocode}
2702 % \end{macro}
2703 %
2704 % \begin{macro}{\thefigure}
2705 % The figure counter and float placement defaults.
2706 % \begin{macrocode}
2707 \newcounter{figure}
2708 \renewcommand \thefigure {\@arabic\c@figure}
2709 % \end{macrocode}
2710 % Note that we give the `!' modifier by default.
2711 % This is an effort to avoid the syndrome wherein
2712 % a deferred float finds itself unqualified for
2713 % placement, thereby getting carried until \cmd\clearpage.
2714 % \begin{macrocode}
2715 \def\fps@figure{tbp}
2716 \def\ftype@figure{1}
2717 \def\ext@figure{lof}
2718 \def\fnum@figure{\figurename~\thefigure}
2719 % \end{macrocode}
2720 % We allocate a box register for use in tallying the column inches of floats of this type.
2721 % \begin{macrocode}
2722 \expandafter\newbox\csname fbox@\ftype@figure\endcsname
2723 \expandafter\setbox\csname fbox@\ftype@figure\endcsname\hbox{}%
2724 % \end{macrocode}
2725 % \end{macro}
2726 %
2727 % \subsubsection{Deferring \env{figure} Floats}%
2728 %
2729 % We determine if figures are to float or be deferred until \cmd\printfigures\ time.
2730 % If so, we open the stream that will receive the deferred document portions.
2731 % \begin{macrocode}
2732 \appdef\class@documenthook{%
2733 \do@if@floats{figure}{.fgx}%
2734 }%
2735 \appdef\class@enddocumenthook{%
2736 \printfigures\relax
2737 }%
2738 % \end{macrocode}
2739 %
2740 % \begin{macro}{\printfigures}
2741 % The user-level command \cmd\printfigures\ determines
2742 % where the figures are to appear in a document in which
2743 % \cmd\floats@sw\ is false.
2744 % If the user invokes the \classoption{endfloats} class option and fails to
2745 % insert a \cmd\printfigures\ command,
2746 % the figures will be printed at the end of the document.
2747 % If the command is given, but floats are not being deferred,
2748 % it amounts to a no-op.
2749 % \changes{4.0b}{1999/06/20}{call \cs{print@floats}}
2750 % \changes{4.0c}{1999/11/13}{*-form mandates pagebreak}
2751 % \begin{macrocode}
2752 \newcommand\printfigures{%
2753 \@ifstar{\true@sw}{\floatp@sw{\true@sw}{\false@sw}}%
2754 {%
2755 \print@float{figure}{\oneapage}%
2756 }{%
2757 \print@float{figure}{}%
2758 }%
2759 }%
2760 % \end{macrocode}
2761 % \end{macro}
2762 %
2763 %
2764 % \begin{macro}{\@xfloat@prep}
2765 % We patch into the procedure \cmd\@xfloat@prep.
2766 % This patch applies to all floats (not \env{figure} alone)
2767 % and makes the type center.
2768 % \begin{macrocode}
2769 \appdef\@xfloat@prep{%
2770 \appdef\@parboxrestore{\centering}%
2771 %\let\@makefnmark\@makefnmark@latex
2772 }%
2773 % \end{macrocode}
2774 % \end{macro}
2775 %
2776 %
2777 % \subsection{Tables}
2778 % \changes{4.0b}{1999/06/20}{Processing delayed to \cs{AtBeginDocument} time}
2779 %
2780 % DPC: More or less taken from \file{revtex2} \file{aps.sty},
2781 % but using dcolumn for decimal alignment.
2782 % \begin{environment}{table}
2783 % We define the \env{table} environment.
2784 % Later, we will horse around with its meaning
2785 % in order to accomodate \cmd\floats@sw.
2786 % \begin{macrocode}
2787 \newenvironment{table}
2788 {\@float{table}}
2789 {\end@float}
2790 \newenvironment{table*}
2791 {\@dblfloat{table}}
2792 {\end@dblfloat}
2793 % \end{macrocode}
2794 % \end{environment}
2795 %
2796 % \begin{macro}{\thetable}
2797 % Table counter and default float placement declarations.
2798 % \begin{macrocode}
2799 \newcounter{table}
2800 \renewcommand\thetable{\@Roman\c@table}
2801 % \end{macrocode}
2802 % Note that we give the `!' modifier by default.
2803 % This is an effort to avoid the syndrome wherein
2804 % a deferred float finds itself unqualified for
2805 % placement, thereby getting carried until \cmd\clearpage.
2806 % \begin{macrocode}
2807 \def\fps@table{tbp}
2808 \def\ftype@table{2}
2809 \def\ext@table{lot}
2810 \def\fnum@table{\tablename~\thetable}
2811 % \end{macrocode}
2812 % We allocate a box register for use in tallying the column inches of floats of this type.
2813 % \begin{macrocode}
2814 \expandafter\newbox\csname fbox@\ftype@table\endcsname
2815 \expandafter\setbox\csname fbox@\ftype@table\endcsname\hbox{}%
2816 % \end{macrocode}
2817 % \end{macro}
2818 %
2819 % \begin{macrocode}
2820 \def\listoftables{\print@toc{lot}}%
2821 \let\l@table\l@figure
2822 % \end{macrocode}
2823 %
2824 % \begin{macro}{\table@hook}
2825 % \begin{macro}{\squeezetable}
2826 % Assign a meaning to the hook installed into float processing.
2827 %
2828 % By default floats are \cmd\small. The \cmd\squeezetable\ declaration
2829 % makes them smaller (\cmd\scriptsize). In general you can locally
2830 % redefine \cmd\table@hook\ to be whatever you like.
2831 % (DPC: |\Huge\color{magenta}|\ldots?)
2832 % \begin{macrocode}
2833 \def\table@hook{\small}%
2834 \def\squeezetable{\def\table@hook{\scriptsize}}%
2835 \appdef\@floatboxreset{\table@hook}%
2836 % \end{macrocode}
2837 % \end{macro}
2838 % \end{macro}
2839 %
2840 % \subsubsection{Deferring \env{table} Floats}%
2841 %
2842 % After all packages are loaded, we decide
2843 % if tables will float or will be deferred until \cmd\printtables\ time.
2844 %
2845 % We also deal with the possibility of \env{longtable} environments.
2846 %
2847 % \begin{macrocode}
2848 \def\set@table@environments{%
2849 \floats@sw{}{%
2850 \let@environment{longtable@float}{longtable}%
2851 \let@environment{longtable}{longtable@write}%
2852 \let@environment{longtable*@float}{longtable*}%
2853 \let@environment{longtable*}{longtable*@write}%
2854 \let@environment{turnpage@float}{turnpage}%
2855 \let@environment{turnpage}{turnpage@write}%
2856 }%
2857 \do@if@floats{table}{.tbx}%
2858 }%
2859 \appdef\document@inithook{%
2860 \set@table@environments
2861 }%
2862 \appdef\class@enddocumenthook{%
2863 \printtables\relax
2864 }%
2865 \newenvironment{longtable@write}{%
2866 \write@@float{longtable}{table}%
2867 }{%
2868 \endwrite@float
2869 }%
2870 \newenvironment{longtable*@write}{%
2871 \write@@float{longtable*}{table}%
2872 }{%
2873 \endwrite@float
2874 }%
2875 \newenvironment{turnpage@write}{%
2876 \immediate\write\tablewrite{\string\begin{turnpage}}%
2877 }{%
2878 \immediate\write\tablewrite{\string\end{turnpage}}%
2879 }%
2880 % \end{macrocode}
2881 %
2882 % \begin{macro}{\printtables}
2883 % The user-level command \cmd\printtables\ determines
2884 % where the tables are to appear in a document in which
2885 % \cmd\floats@sw\ is false.
2886 % If the user invokes the \classoption{nofloats} and fails to
2887 % insert a \cmd\printtables\ command,
2888 % the tables will be printed at the end of the document.
2889 % If the command is given, but floats are not being deferred,
2890 % it amounts to a no-op.
2891 % \changes{4.0b}{1999/06/20}{only execute if appropriate}
2892 % \changes{4.0c}{1999/11/13}{*-form mandates pagebreak}
2893 % \changes{4.0d}{2000/05/17}{make longtable trigger the head, too}
2894 % \begin{macrocode}
2895 \newcommand\printtables{%
2896 \begingroup
2897 \let@environment{longtable}{longtable@float}%
2898 \let@environment{longtable*}{longtable*@float}%
2899 \let@environment{turnpage}{turnpage@anchored}%
2900 \prepdef\longtable{\trigger@float@par}%
2901 \expandafter\prepdef\csname longtable*\endcsname{\trigger@float@par}%
2902 \expandafter\prepdef\csname table@floats\endcsname{%
2903 \onecolumngrid@push
2904 }%
2905 \expandafter\appdef\csname endtable@floats\endcsname{%
2906 \onecolumngrid@pop
2907 }%
2908 \@ifstar{\true@sw}{\floatp@sw{\true@sw}{\false@sw}}%
2909 {%
2910 \print@float{table}{\oneapage}%
2911 }{%
2912 \print@float{table}{}%
2913 }%
2914 \endgroup
2915 }%
2916 \newenvironment{turnpage@anchored}{%
2917 \onecolumngrid@push
2918 \setbox\z@\vbox to\textwidth\bgroup
2919 \columnwidth\textheight
2920 }{%
2921 \vfil
2922 \egroup
2923 \rotatebox{90}{\box\z@}%
2924 \onecolumngrid@pop
2925 }%
2926 % \end{macrocode}
2927 % \end{macro}
2928 %
2929 %
2930 % \subsection{Videos}
2931 %\changes{4.1r}{2010/06/22}{(AO, 595) Provide \cs{lovname} along with other List of Videos definitions.}%
2932 %
2933 % \begin{environment}{video}
2934 % We define the \env{video} environment analogously to the
2935 % \env{figure} and \env{table} environments; it is intended to contain a video.
2936 %
2937 % \begin{macrocode}
2938 \newenvironment{video}
2939 {\@float{video}}
2940 {\end@float}%
2941 \newenvironment{video*}
2942 {\@dblfloat{video}}
2943 {\end@dblfloat}%
2944 % \end{macrocode}
2945 % \end{environment}
2946 %
2947 % \begin{macro}{\thevideo}
2948 % The video counter, float placement defaults, strings.
2949 % \begin{macrocode}
2950 \newcounter{video}
2951 \renewcommand \thevideo {\@arabic\c@video}
2952 % \end{macrocode}
2953 %
2954 % File extension and localizable strings.
2955 % \begin{macrocode}
2956 \def\ext@video{lov}%
2957 \def\fname@video{Video}%
2958 \def\lovname{List of Videos}%
2959 % \end{macrocode}
2960 %
2961 % Float type and default placement.
2962 % \begin{macrocode}
2963 \def\fps@video{tbp}%
2964 \def\ftype@video{4}%
2965 \def\fnum@video{\fname@video~\thevideo}%
2966 \appdef\document@inithook{%
2967 \@ifxundefined\c@float@type{}{%
2968 \global\setcounter{float@type}{8}%
2969 }%
2970 }%
2971 % \end{macrocode}
2972 % We allocate a box register for use in tallying the column inches of floats of this type.
2973 % \begin{macrocode}
2974 \expandafter\newbox\csname fbox@\ftype@video\endcsname
2975 \expandafter\setbox\csname fbox@\ftype@video\endcsname\hbox{}%
2976 % \end{macrocode}
2977 % The documentation for the \classname{hyperref} package, \file{hyperref.dtx} states:
2978 % ``classes or package which introduce new elements need to define
2979 % an equivalent \verb+\theH<name>+ for every \verb+\the<name>+''
2980 % We do accordingly here.
2981 % \begin{macrocode}
2982 \let\theHvideo\thevideo
2983 % \end{macrocode}
2984 % But \file{hyperref.dtx} goes on to say,
2985 % ``We do make a trap to make \verb+\theH<name>+ be the same as \verb+\arabic{<name>}+,
2986 % if \verb+\theH<name>+ is not defined\ldots''
2987 % However, it's not doing that right now (as of 6.77u),
2988 % and I cannot find any such code in there anymore.
2989 % \end{macro}
2990 %
2991 % \begin{macrocode}
2992 \def\listofvideos{\print@toc{lov}}%
2993 \let\l@video\l@figure
2994 % \end{macrocode}
2995 %
2996 % \subsubsection{Deferring \env{video} Floats}%
2997 %
2998 % We determine if videos are to float or be deferred until \cmd\printvideos\ time.
2999 % If so, we open the stream that will receive the deferred document portions.
3000 % \begin{macrocode}
3001 \appdef\class@documenthook{%
3002 \do@if@floats{video}{.vdx}%
3003 }%
3004 \appdef\class@enddocumenthook{%
3005 \printvideos\relax
3006 }%
3007 % \end{macrocode}
3008 %
3009 % \begin{macro}{\printvideos}
3010 % The user-level command \cmd\printvideos\ determines
3011 % where the videos are to appear in a document in which
3012 % \cmd\floats@sw\ is false.
3013 % If the user invokes the \classoption{endfloats} class option and fails to
3014 % insert a \cmd\printvideos\ command,
3015 % the videos will be printed at the end of the document.
3016 % If the command is given, but floats are not being deferred,
3017 % it amounts to a no-op.
3018 % \begin{macrocode}
3019 \newcommand\printvideos{%
3020 \@ifstar{\true@sw}{\floatp@sw{\true@sw}{\false@sw}}%
3021 {%
3022 \print@float{video}{\oneapage}%
3023 }{%
3024 \print@float{video}{}%
3025 }%
3026 }%
3027 % \end{macrocode}
3028 % \end{macro}
3029 %
3030 %
3031 % \section{Tabular}
3032 % Every APS tabular has a double (Scotch) rule above and below.
3033 % The column specifier ``d'' is implemented using the \classname{dcolumn}
3034 % package, if available.
3035 % FIXME: always load dcolumn!
3036 % \begin{macro}{\tabular@hook}
3037 % \begin{macro}{\endtabular@hook}
3038 % \begin{environment}{ruledtabular}
3039 % \begin{macrocode}
3040 \def\endtabular@hook{}%
3041 % \end{macrocode}
3042 % \begin{verbatim}
3043 %\RequirePackage{dcolumn}%
3044 % \end{verbatim}
3045 % \begin{macrocode}
3046 \appdef\document@inithook{%
3047 \@ifpackageloaded{dcolumn}{%
3048 \expandafter\@ifnotrelax\csname NC@find@d\endcsname{}{%
3049 \newcolumntype{d}{D{.}{.}{-1}}%
3050 }%
3051 }{}%
3052 }%
3053 \def\toprule{\hline\hline}%
3054 \def\colrule{\hline}%
3055 \def\botrule{\hline\hline}%
3056 \newenvironment{ruledtabular}{%
3057 \def\array@default{v}%
3058 \appdef\tabular@hook{\def\@halignto{to\hsize}}%
3059 \let\tableft@skip@default\tableft@skip
3060 \let\tableft@skip\tableft@skip@float
3061 \let\tabmid@skip@default\tabmid@skip
3062 \let\tabmid@skip\tabmid@skip@float
3063 \let\tabright@skip@default\tabright@skip
3064 \let\tabright@skip\tabright@skip@float
3065 \let\array@row@pre@default\array@row@pre
3066 \let\array@row@pre\array@row@pre@float
3067 \let\array@row@pst@default\array@row@pst
3068 \let\array@row@pst\array@row@pst@float
3069 \appdef\array@row@rst{%
3070 \let\array@row@pre\array@row@pre@default
3071 \let\array@row@pst\array@row@pst@default
3072 \let\tableft@skip\tableft@skip@default
3073 \let\tabmid@skip\tabmid@skip@default
3074 \let\tabright@skip\tabright@skip@default
3075 \appdef\tabular@hook{\let\@halignto\@empty}%
3076 }%
3077 }{%
3078 }%
3079 % \end{macrocode}
3080 % \end{environment}
3081 % \end{macro}
3082 % \end{macro}
3083 %
3084 % \section{Footnote Text}
3085 %
3086 % \changes{4.0a}{1998/06/10}{single space footnotes}
3087 % \changes{4.0b}{1999/06/20}{Frank Mittelbach, has stated in \protect\classname{multicol}: ``The kernel command \cs{@footnotetext} should not be modified.'' Thus, I have removed David Carlisle's redefinition of that command. Note, however, that later versions of \protect\classname{multicol} do not require this workaround. Belt and suspenders.}%
3088 %
3089 % \begin{macro}{\@makefntext}
3090 % \begin{macro}{\@makefnmark}
3091 % We customize the presentation of the footnote mark: it will not be italic.
3092 % \begin{macrocode}
3093 \def\@makefntext#1{%
3094 \def\baselinestretch{1}%
3095 \parindent1em%
3096 \noindent
3097 \hb@[email protected]{%
3098 \hss\@makefnmark
3099 }%
3100 #1%
3101 \par
3102 }%
3103 \def\@makefnmark{%
3104 \hbox{%
3105 \@textsuperscript{%
3106 \normalfont\@thefnmark
3107 }%
3108 }%
3109 }%
3110 % \end{macrocode}
3111 % \end{macro}
3112 % \end{macro}
3113 %
3114 %
3115 % \subsection{Citations, Bibliography, Endnotes}
3116 %
3117 % \subsubsection{Bibliography}
3118 %
3119 % Load Patrick Daly's \classname{natbib} package,
3120 % \url{ftp://ctan.tug.org/macros/latex/contrib/supported/natbib}
3121 %
3122 % Note that \classname{natbib} assumes that it loads
3123 % over a document class, such as the \classname{article} class,
3124 % that has already defined \env{thebibliography} and \cmd\@listi.
3125 %
3126 % Note also that \classname{natbib} also installs a command
3127 % \cmd\NAT@set@cites\ into \cmd\AtBeginDocument\ which presumes
3128 % that the proper \cmd\bibpunct\ command has been issued.
3129 %
3130 % Note that the macro \cmd\NAT@sort\ controls
3131 % whether citations are left alone (\cmd\NAT@sort=0), sorted (\cmd\NAT@sort=1), or sorted and compressed (\cmd\NAT@sort=2).
3132 % Since we give \classname{natbib} the \classoption{sort\&compress} option,
3133 % if you prefer \classoption{sort}, you need only \cmd\let \cmd\NAT@sort\ to be \cmd\@ne.
3134 % However, if you prefer the effect of having neither \classoption{sort} nor \classoption{sort\&compress},
3135 % you must \cmd\let \cmd\NAT@sort\ to be \cmd\z@ and you must also define
3136 % \cmd\let\cmd\NAT@cmprs\ to be \cmd\z@.
3137 %
3138 % As of version 8.2, \classname{natbib} now no longer binds at the point where it is read in.
3139 % This means that we can freely change \cmd\NAT@sort, \cmd\NAT@cmprs, and the new
3140 % \cmd\NAT@merge. Henceforth, we require that this later version be used.
3141 %
3142 % For other \classname{natbib} customizations, you may proceed as if you were going to use
3143 % the \file{natbib.cfg} file: anything that you can modify by this means is fair game.
3144 % Once \revtex\ is finished loading, you can assert any definitions for \classname{natbib} that you wish.
3145 %
3146 % \begin{macro}{\rev@citet}
3147 % \begin{macro}{\rev@citealp}
3148 % \begin{macro}{\rev@citealpnum}
3149 % We define variants on \classname{natbib}'s commands \cmd\citet, \cmd\citealp, and \cmd\citealpnum.
3150 % \cmd\rev@citealpnum\ uses a numerical citation.
3151 % \cmd\rev@citealp\ and \cmd\rev@citealpnum\ are the aliases of \cmd\onlinecite,
3152 % \cmd\rev@citet\ that of \cmd\textcite.
3153 %
3154 % In each case, we invoke \cmd\rtx@swap@citea\ to effect different productions between
3155 % multiple arguments to the \cmd\cite\ command.
3156 %
3157 % \cmd\rev@citealpnum\ provides textual citations where superscript citations are the default.
3158 % These should be accessible via the \cmd\citet\ command.
3159 %
3160 % Therefore we remember how to do a numerical citation
3161 % even when the superscript citation has been selected.
3162 % \begin{macrocode}
3163 \expandafter\DeclareRobustCommand
3164 \expandafter\rev@citet
3165 \expandafter{%
3166 \expandafter\begingroup
3167 \expandafter\rtx@swap@citea
3168 \expandafter\g@bblefirsttoken
3169 \csname citet \endcsname
3170 }%
3171 \expandafter\DeclareRobustCommand
3172 \expandafter\rev@citealp
3173 \expandafter{%
3174 \expandafter\begingroup
3175 \expandafter\rtx@swap@citea
3176 \expandafter\g@bblefirsttoken
3177 \csname citealp \endcsname
3178 }%
3179 \expandafter\DeclareRobustCommand
3180 \expandafter\rev@citealpnum
3181 \expandafter{%
3182 \expandafter\begingroup
3183 \expandafter\rtx@swap@citenum
3184 \expandafter\g@bblefirsttoken
3185 \csname citealp \endcsname
3186 }%
3187 \def\rtx@swap@citenum{%
3188 \rtx@swap@citea
3189 \let\@cite\NAT@citenum
3190 \let\NAT@mbox\mbox
3191 \let\citeyear\NAT@citeyear
3192 \let\NAT@space\NAT@spacechar
3193 }%
3194 \def\g@bblefirsttoken{%
3195 \expandafter\true@sw
3196 \expandafter\@empty
3197 }%
3198 % \end{macrocode}
3199 % \end{macro}
3200 % \end{macro}
3201 % \end{macro}
3202 %
3203 % \begin{macro}{\rtx@citesuper}
3204 % We prepare to redefine \classname{natbib}'s procedure \cmd\NAT@citesuper,
3205 % which is executed when setting a superscript citation.
3206 % The \cmd\hspace\ is removed: in any case, it
3207 % should really be \cmd\hspace*, to prevent an unwanted pagebreak.
3208 % \begin{macrocode}
3209 \newcommand\rtx@citesuper[3]{%
3210 \ifNAT@swa
3211 \leavevmode
3212 \unskip
3213 % \hspace{1\p@}%
3214 \textsuperscript{\normalfont#1}%
3215 \if*#3*\else\ (#3)\fi
3216 \else
3217 #1%
3218 \fi
3219 \endgroup
3220 }%
3221 % \end{macrocode}
3222 % \end{macro}
3223 %
3224 % \begin{macro}{\@makefnmark@cite}
3225 % We define a procedure that will set a footnote mark the same way that
3226 % a citation is set. If footnotes are put in the bibliography with
3227 % \cmd\footinbib@sw, then the corresponding mark should look the same
3228 % as the result of a \cmd\cite. This is how we do it.
3229 % \begin{macrocode}
3230 \def\@makefnmark@cite{\begingroup\NAT@swatrue\@cite{{\@thefnmark}}{}{}}%
3231 % \end{macrocode}
3232 % \end{macro}
3233 %
3234 % \begin{macro}{\rtx@bibsection}
3235 % Prepare to override \classname{natbib}'s definition of \cmd\bibsection.
3236 % \begin{macrocode}
3237 \def\rtx@bibsection{%
3238 \@ifx@empty\refname{%
3239 \par
3240 }{%
3241 % \let\@hangfroms@section\@hang@froms
3242 \expandafter\section\expandafter*\expandafter{\refname}%
3243 \@nobreaktrue
3244 }%
3245 }%
3246 % \end{macrocode}
3247 % \end{macro}
3248 %
3249 % \begin{macro}{\rtx@swap@citea}
3250 % \begin{macro}{\rtx@def@citea}
3251 % \begin{macro}{\rtx@def@citea@close}
3252 % \begin{macro}{\rtx@def@citea@box}
3253 % The procedures |\rtx@def@citea|, |\rtx@def@citea@close|, and |\rtx@def@citea@box|
3254 % can take over the management of \classname{natbib}'s |\@citea| macro to effect more sophisticated
3255 % behavior of the punctuation between textual citations. The switch is performed by \cmd\rtx@swap@citea.
3256 %
3257 % \changes{4.1j}{2009/10/25}{(AO, 552) Repair spacing in \cs{onlinecite}}
3258 % In these procedures, we use \cmd\count@\ to count the number of arguments of the \cmd\cite\ command,
3259 % and we use \cmd\c@NAT@ctr\ to keep track of which argument we are processing.
3260 % The latter counter is created by \classname{natbib} and used there solely in bibliography processing,
3261 % where it keeps track of the reference number.
3262 % We take over its use in these macros, but only locally; therefore these procedures should work properly, even within the bibliography.
3263 %FIXME: check whether this is true!
3264 %
3265 % Because we are using a scratch counter \cmd\count@, we are vulnerable to other \TeX\ programmers
3266 % who patch in to \classname{natbib}'s processing and who might use that counter at the same time we are doing so.
3267 % This is a potential source of trouble for us.
3268 %FIXME: store the value of \cmd\count@\ in a private \cmd\csname!
3269 %
3270 % Note that \cmd\rtx@def@citea\ begins the same as \cmd\NAT@def@citea, which it replaces,
3271 % then makes further decisions based on the values of the counters.
3272 %
3273 % Note also that, in \classname{natbib}, the replacement part of \cmd\NAT@def@citea@close\ could be rewritten as
3274 % \cmd\NAT@def@citea\cmd\prepdef\cmd\@citea\verb+{+\cmd\NAT@@close\verb+}+, which
3275 % would them obviate the need for us to override its meaning.
3276 %
3277 % Note, too, the effect of \cmd\rtx@def@citea@box, which replaces \cmd\NAT@def@citea@box,
3278 % is almost the same as the latter, except the entire \cmd\@citea\ is given as the argument
3279 % of \cmd\NAT@mbox.
3280 %
3281 % Finally, bear in mind that the English (and some American editors) do not place a comma
3282 % before the ``and''; our procedures do (but they could be rewritten with that convention).
3283 % \begin{macrocode}
3284 \def\rtx@swap@citea{%
3285 \let\NAT@def@citea\rtx@def@citea
3286 \let\NAT@def@citea@close\rtx@def@citea@close
3287 \let\NAT@def@citea@box\rtx@def@citea@box
3288 }%
3289 \def\rtx@def@citea{%
3290 \def\@citea{\NAT@separator\NAT@space}%
3291 \advance\c@NAT@ctr\@ne
3292 \@ifnum{\count@>\tw@}{%
3293 \@ifnum{\c@NAT@ctr=\count@}{\appdef\@citea{\NAT@conj\NAT@space}}{}%
3294 }{%
3295 \def\@citea{\NAT@space\NAT@conj\NAT@space}%
3296 }%
3297 }%
3298 \def\rtx@def@citea@close{%
3299 \rtx@def@citea
3300 \prepdef\@citea{\NAT@@close}%
3301 }%
3302 \def\rtx@def@citea@box{%
3303 \rtx@def@citea@close
3304 \expandafter\def\expandafter\@citea\expandafter{\expandafter\NAT@mbox\expandafter{\@citea}}%
3305 }%
3306 \def\NAT@conj{and}%
3307 % \end{macrocode}
3308 %
3309 % \end{macro}
3310 % \end{macro}
3311 % \end{macro}
3312 % \end{macro}
3313 %
3314 % \begin{macro}{\BibitemShut}
3315 % \begin{macro}{\bibAnnote}
3316 % \changes{4.1j}{2009/10/24}{(AO, 549) Repairing natbib's \cs{BibitemShut} and \cs{bibAnnote}}
3317 % \changes{4.1o}{2010/02/05}{(AO, 549) Remove patch to natbib, which is now at version 8.31a}
3318 % \changes{4.1o}{2010/02/07}{(AO, 578) accommodate the possible space character preceding \cs{BibitemShut}.}
3319 % We remember a temporary patch to \classname{natbib}'s definition of \cmd\BibitemShut.
3320 % \begin{macrocode}
3321 \def\NAT@BibitemShut#1{%
3322 \def\@bibstop{#1}%
3323 \let\bibitem@Stop\bibitemStop
3324 \let\bibitem@NoStop\bibitemNoStop
3325 \@ifx{\bibitemShut\relax}{\let\@bibitemShut\@empty}{%
3326 \expandafter\def\expandafter\@bibitemShut\expandafter{\bibitemShut}%
3327 }%
3328 }%
3329 % \end{macrocode}
3330 % The following is a bug fix to \classname{natbib} version 8.31b.
3331 % \begin{macrocode}
3332 \def\BibitemShut@ltx#1{%
3333 \unskip
3334 \def\@bibstop{#1}%
3335 \let\bibitem@Stop\bibitemStop
3336 \let\bibitem@NoStop\bibitemNoStop
3337 \@ifx{\bibitemShut\relax}{\let\@bibitemShut\@empty}{%
3338 \expandafter\def\expandafter\@bibitemShut\expandafter{\bibitemShut}%
3339 }%
3340 }%
3341 % \end{macrocode}
3342 %
3343 % \begin{verbatim}
3344 %\providecommand{\bibAnnote}[3]{%
3345 % \BibitemShut{#1}%
3346 % \def\@tempa{#3}\@ifx{\@tempa\@empty}{}{%
3347 % \begin{quotation}\noindent
3348 % \textsc{Key:}\ #2\\\textsc{Annotation:}\ \@tempa
3349 % \end{quotation}%
3350 % }%
3351 % \ignorespaces
3352 %}%
3353 %\def\@bibitemShut{}%
3354 % \end{verbatim}
3355 % \end{macro}
3356 % \end{macro}
3357 %
3358 %
3359 % \begin{macrocode}
3360 \newenvironment{thebibliography}{}{}%
3361 \let\@listi\@empty
3362 \appdef\rtx@require@packages{%
3363 \RequirePackage[sort&compress]{natbib}[2009/11/07 8.31a (PWD, AO)]%
3364 \let@environment{NAT@thebibliography}{thebibliography}%
3365 \let@environment{thebibliography}{rtx@thebibliography}%
3366 \let\bibliographystyle@latex\bibliographystyle
3367 \let\NAT@citesuper\rtx@citesuper
3368 % \end{macrocode}
3369 %
3370 % \begin{macro}{\NAT@bibsetnum}
3371 % \begin{macro}{\NAT@bibsetup}
3372 % \begin{macro}{\bibpreamble}
3373 % \begin{macro}{\newblock}
3374 % \begin{macro}{\bibnumfmt}
3375 % \begin{macro}{\NAT@merge}
3376 % We define the sectioning command to use when starting the bibliography
3377 % and gently coax \classname{natbib} into using
3378 % the formatting procedures that \emph{we} want it to use.
3379 %
3380 % This way of setting up \env{thebibliography}
3381 % automatically sets the label width based on
3382 % the largest number used within the bibliography.
3383 % This scheme will not work properly using the
3384 % author/year style of bib entry, though.
3385 %
3386 % We define \cmd\bibnumfmt\ to be \cmd\place@bibnumber, which is a macro
3387 % managed by \revtex. If the document defines \cmd\bibnumfmt, then that
3388 % definition will be used instead, which is what the \classname{natbib}
3389 % package gives as its programming interface.
3390 %
3391 % We set \cmd\NAT@merge\ to \cmd\tw@, which turns on \classname{natbib}'s
3392 % \classname{mcite} capabilities. This is the default setting.
3393 % If numerical citations are not to be used, then \cmd\NAT@merge\
3394 % should be set to \cmd\@ne\ (syntax is still enabled, but semantics are turned off).
3395 % \begin{macrocode}
3396 \let\bibsection\rtx@bibsection
3397 \let\NATx@bibsetnum\NAT@bibsetnum
3398 \def\NAT@bibsetnum#1{%
3399 \setlength{\topsep}{\z@}%
3400 \NATx@bibsetnum{\ref{LastBibItem}}%
3401 }%
3402 \let\NATx@bibsetup\NAT@bibsetup
3403 \def\NAT@bibsetup{%
3404 \setlength{\labelwidth}{\z@}%
3405 \setlength{\labelsep}{\z@}%
3406 \setlength{\itemindent}{\z@}%
3407 \setlength{\listparindent}{\z@}%
3408 \setlength{\topsep}{\z@}%
3409 \setlength{\parsep}{\z@}%
3410 \NATx@bibsetup
3411 }%
3412 \let\bibpreamble\@empty
3413 \def\newblock{\ }%
3414 \let\NATx@bibnumfmt\bibnumfmt
3415 \def\bibnumfmt{\place@bibnumber}%
3416 \let\NAT@merge\thr@@
3417 \let\NAT@citeyear\citeyear
3418 \let\onlinecite\rev@citealp
3419 \let\textcite\rev@citet
3420 % \end{macrocode}
3421 % The following is needed until \classname{natbib} is at 8.31b.
3422 % \begin{macrocode}
3423 \@ifx{\BibitemShut\NAT@BibitemShut}{%
3424 \class@info{Repairing natbib's \string\BibitemShut}%
3425 \let\BibitemShut\BibitemShut@ltx
3426 }{}%
3427 % \end{macrocode}
3428 % \end{macro}
3429 % \end{macro}
3430 % \end{macro}
3431 % \end{macro}
3432 % \end{macro}
3433 % \end{macro}
3434 %
3435 % \begin{macro}{\bibliographystyle}
3436 % \changes{4.1q}{2010/04/01}{(AO, 586) When .bbl is pasted into the document, prevent automatic bibliography inclusion.}%
3437 % \changes{4.1q}{2010/04/13}{(AO, 588) Only write \revtex-specific BibTeX .bib data if the .bst style is set by REVTeX.}%
3438 % We arrange for the selection of bibliography style
3439 % to occur either due to the document's explicit
3440 % \cmd\bibliographystyle\ statement or
3441 % via the journal substyle.
3442 %
3443 % Note that \revtex\ is incompatible with
3444 % any package that patches \cmd\bibliographystyle.
3445 % Since \classname{natbib} does this, we need a fix.
3446 %
3447 % The Boolean \cmd\bibliographystyle@sw\ signifies that the document contains explicit
3448 % \cmd\bibliographystyle\ markup. If, on the contrary, the bibliography style is set by
3449 % the the society or the journal, then no explicit \cmd\bibliographystyle\ command appears in the document instance.
3450 % In this case \cmd\bibliographystyle@sw\ will be \cmd\false@sw.
3451 % \begin{macrocode}
3452 \let\bibliographystyle@latex\bibliographystyle
3453 \def\bibliographystyle{\@booleantrue\bibliographystyle@sw\def\@bibstyle}%
3454 \@booleanfalse\bibliographystyle@sw
3455 % \end{macrocode}
3456 % \end{macro}
3457 %
3458 % \changes{4.1j}{2009/11/03}{(AO, 551) Punctuation at end of reference when optional arguments to the cite key are given.}
3459 % The following had been bug fixes to \classname{natbib} version 8.31a.
3460 % \begin{verbatim}
3461 %\def\bibitemStop{\@bibitemShut}%
3462 %\def\NAT@bibitem@cont{%
3463 % \let\bibitem@Stop\bibitemContinue
3464 % \let\bibitem@NoStop\bibitemContinue
3465 %}%
3466 % \end{verbatim}
3467 % The following are alterations to \classname{natbib} version 8.31a to
3468 % accommodate the possible space character preceding \cmd\BibitemShut,
3469 % and to handle the case of merged references, where the first ends with a stop character.
3470 % \changes{4.1o}{2010/02/07}{(AO, 578) accommodate the possible space character preceding \cs{BibitemShut}.}
3471 % \changes{4.1o}{2010/02/09}{(AO, 581) Handle case: merged references, with first ending in a stop character.}
3472 % \begin{macrocode}
3473 \def\NAT@bibitem@cont{%
3474 \let\bibitem@Stop\bibitemContinue@Stop
3475 \let\bibitem@NoStop\bibitemContinue
3476 }%
3477 % \end{macrocode}
3478 % \begin{macrocode}
3479 \def\bibitemNoStop{%
3480 \@ifx@empty\@bibitemShut{.\spacefactor\@mmm\space}{\@bibitemShut}%
3481 }%
3482 % \end{macrocode}
3483 % \begin{macrocode}
3484 \def\bibitemContinue{%
3485 \@ifx@empty\@bibitemShut{;\spacefactor\@mmm\space}{\@bibitemShut}%
3486 }%
3487 % \end{macrocode}
3488 % \begin{macrocode}
3489 \def\bibitemContinue@Stop{%
3490 \@ifx@empty\@bibitemShut{\spacefactor\@mmm\space}{\@bibitemShut}%
3491 }%
3492 % \end{macrocode}
3493 %
3494 % \changes{4.1k}{2009/11/11}{(AO, 561) remove dead code relating to \cs{bibitemContinue}}
3495 % We used to customize one of the productions of \classname{natbib}, but no longer.
3496 % \begin{verbatim}
3497 %\let\bibitemContinue\bibitemContinue@rtx
3498 % \end{verbatim}
3499 %
3500 % Here ends the code to be executed at \cmd\rtx@require@packages\ time.
3501 % \begin{macrocode}
3502 }%
3503 % \end{macrocode}
3504 % \changes{4.1f}{2009/07/07}{(AO, 516) Merged references are separated with a semicolon}
3505 % Redefine a macro of \classname{natbib} so that merged references are separated with a semicolon.
3506 % \changes{4.1k}{2009/11/11}{(AO, 561) remove dead code relating to \cs{bibitemContinue}}
3507 % \begin{verbatim}
3508 % \def\bibitemContinue@rtx{;\spacefactor\@mmm\space}%
3509 % \end{verbatim}
3510 %
3511 % \begin{macro}{\onlinecite}
3512 % \begin{macro}{\textcite}
3513 % We extend \classname{natbib}'s syntax with two commands to set a citation
3514 % on the baseline (as opposed to superscripted) and as text (rather than parenthetical), respectively.
3515 % A journal substyle that makes citations be superscripted or parenthetical as the case may be, should ensure
3516 % that the author has continued access to these two styles.
3517 %
3518 % Note that the society or journal substyle override the meanings of \cmd\@onlinecite\ or
3519 % \cmd\@textcite\ given here.
3520 %
3521 % \begin{macrocode}
3522 \DeclareRobustCommand\onlinecite{\@onlinecite}%
3523 \DeclareRobustCommand\textcite{\@textcite}%
3524 % \end{macrocode}
3525 % \end{macro}
3526 % \end{macro}
3527 %
3528 % \begin{macro}{\bibliography}
3529 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
3530 % Provide a hook for supplying Bib\TeX\ a bibliographic database that may contain, say,
3531 % footnotes.
3532 %
3533 % Note that Bib\TeX\ chokes if the argument of the \cmd\bibdata\ command has null fields,
3534 % hence these tests.
3535 % \begin{macrocode}
3536 \let\bibliography@latex\bibliography
3537 \def\bibliography#1{%
3538 \auto@bib@empty
3539 \begingroup
3540 \let\auto@bib@innerbib\@empty
3541 \@ifx@empty{\pre@bibdata}{%
3542 \bibliography@latex{#1}%
3543 }{%
3544 \@if@empty{#1}{%
3545 \expandafter\bibliography@latex\expandafter{\pre@bibdata}%
3546 }{%
3547 \expandafter\bibliography@latex\expandafter{\pre@bibdata,#1}%
3548 }%
3549 }%
3550 \endgroup
3551 }%
3552 \let\pre@bibdata\@empty
3553 % \end{macrocode}
3554 % \end{macro}
3555 %
3556 % \begin{environment}{rtx@thebibliography}%
3557 % \begin{macro}{\present@bibnote}%
3558 % \changes{4.1f}{2009/07/11}{(AO, 521) Lonely bibliography head}%
3559 % \changes{4.1n}{2010/01/02}{(AO, 572) Independent footnote counter for title block. Abstract footnote counter shared with body.}%
3560 % \changes{4.1o}{2010/02/02}{(AO, 575) Automatically incorporate the (Bib\TeX-generated) .bbl into an explicit \env{thebibliography}}%
3561 % \changes{4.1q}{2010/04/01}{(AO, 586) When .bbl is pasted into the document, prevent automatic bibliography inclusion.}%
3562 % We put a tail patch into \cmd\thebibliogrphy\ and
3563 % a headpatch into \cmd\endthebibliography.
3564 %
3565 % Here we provide a default treatment for frontmatter notes
3566 % deferred to the bibliography; a journal substyle
3567 % might want to override the definition of \cmd\present@bibnote.
3568 %
3569 % We make provisions for the case where there are no \cmd\bibitem s
3570 % for the bibliography: we produce no bibliography head at all.
3571 %
3572 % \begin{macrocode}
3573 \newenvironment{rtx@thebibliography}[1]{%
3574 \NAT@thebibliography{#1}%
3575 \let\@TBN@opr\present@bibnote
3576 \@FMN@list
3577 }{%
3578 % \end{macrocode}
3579 % The following line was commented out:
3580 % \begin{verbatim}
3581 %\@endnotesinbib
3582 % \end{verbatim}
3583 % The \cmd\auto@bib@innerbib\ directive has been moved from the begin processing to the end processing.
3584 % This means that the content of the \env{thebibliography} environment can itself prevent the
3585 % automatic reading in of the .bbl file. This would be needed when the user has pasted in the
3586 % content of the .bbl file into the document itself, something required by APS and AIP editorial direction.
3587 % \begin{macrocode}
3588 \auto@bib@innerbib
3589 \edef\@currentlabel{\arabic{NAT@ctr}}%
3590 \label{LastBibItem}%
3591 \endNAT@thebibliography
3592 \aftergroup\auto@bib@empty
3593 }%
3594 \def\present@bibnote#1#2{%
3595 \item[%
3596 \textsuperscript{%
3597 \normalfont
3598 \Hy@raisedlink{\hyper@anchorstart{frontmatter.#1}\hyper@anchorend}%
3599 \begingroup
3600 \csname c@\@mpfn\endcsname#1\relax
3601 \frontmatter@thefootnote
3602 \endgroup
3603 }%
3604 ]#2\par
3605 % \end{macrocode}
3606 % The following line was commented out:
3607 % \begin{verbatim}
3608 %\global\let\NAT@bibitem@first@sw\@secondoftwo
3609 % \end{verbatim}
3610 % \begin{macrocode}
3611 }%
3612 % \end{macrocode}
3613 % \end{macro}
3614 % \end{environment}
3615 %
3616 % \begin{macro}{write@bibliographystyle}
3617 % \changes{4.1q}{2010/04/13}{(AO, 588) Only write \revtex-specific BibTeX .bib data if the .bst style is set by REVTeX.}%
3618 % We wish to delay committing the \cmd\bibliographystyle\ until as late as possible.
3619 % The journal substyle will define a default bibliography style, and
3620 % the document's explicit \cmd\bibliographystyle\ command, if any, will override that default.
3621 %
3622 % The \cmd\bibstyle\ command is allowed appear quite late in the \file{.aux} file.
3623 % We now delay the automatic writing of the \cmd\bibstyle\ command to the end of the job.
3624 %
3625 % The procedure \cmd\write@bibliographystyle\ tests whether a \cmd\bibliographystyle\ command has
3626 % already been given.
3627 % If not, it effectively executes the needed \cmd\bibliographystyle\ command, then neutralizes itself
3628 % (we only need to do this once per job).
3629 %
3630 % If the document lacks explicit \cmd\bibliographystyle\ markup, we execute
3631 % \cmd\@bibdataout@rev, a hook for \revtex-aware processing.
3632 % \begin{macrocode}
3633 \def\write@bibliographystyle{%
3634 \@ifxundefined\@bibstyle{}{%
3635 \expandafter\bibliographystyle@latex\expandafter{\@bibstyle}%
3636 \bibliographystyle@sw{}{\@bibdataout@rev}%
3637 }%
3638 \global\let\write@bibliographystyle\relax
3639 }%
3640 \AtEndDocument{\write@bibliographystyle}%
3641 % \end{macrocode}
3642 % \end{macro}
3643 %
3644 % \begin{macro}{\rtx@@citetp}
3645 % \begin{macro}{\rtx@citex}
3646 % \begin{macro}{\super@cite@let}
3647 % \begin{macro}{\super@cite@end}
3648 % \begin{macro}{\super@cite@swap}
3649 % We wish to extend \classname{natbib} to move spaces and citations around
3650 % a superscript-style citation, imitating Donald Arseneau's \classname{cite} package
3651 % with the \classoption{super}.
3652 %
3653 % The \cmd\rtx@@citetp\ procedure is substituted for \cmd\NAT@@citetp;
3654 % it then calls the \cmd\rtx@citex\ procedure and implements the features of the
3655 % \classoption{citeautoscript} class option.
3656 % In the end, \cmd\@citex\ is called with its customary parameters.
3657 %
3658 % The document should be marked up as if citations were \emph{not} superscripted,
3659 % and then if you select a journal substyle that has superscripted citations, \revtex\ will do its best
3660 % to alter the formatting of the \cmd\cite s to accomodate superscript style.
3661 %
3662 % Only citations set as superscript are affected by this procedure,
3663 % because we check \cmd\@cite\ against \cmd\NAT@citesuper.
3664 %
3665 % Here's a subtle point: when is the argument of \cmd\super@cite@swap\ not the same as the token \cmd\@let@token?
3666 % Answer: when the latter is \cmd\@sptoken! This case has to be handled separately.
3667 %
3668 % Note that whether a punctuation is movable is determined by the definition
3669 % of a particular control sequence name.
3670 % A society or journal can alter things: to remove a character from the set,
3671 % do, say, \cmd\expandafter \cmd\let \cmd\csname \texttt{rtx@automove;} \cmd\endcsname \cmd\relax.
3672 % To add a character to the set, do, say, \cmd\expandafter \cmd\let \cmd\csname \texttt{rtx@automove;} \cmd\endcsname \cmd\@empty.
3673 %
3674 % Implementation note: due to a \TeX\ peculiarity, we have to check for the case
3675 % where \cmd\@let@token\ is a space token \emph{before} we parse forward.
3676 % At issue is the corner case where an end of file is at hand. If we
3677 % were to let \cmd\super@cite@swap\ parse forward, we would encounter a \TeX\ end-of-file
3678 % error. Note that the test will be true in many distinct cases:
3679 % the file ends, the next character is a line terminator, the next character is a space.
3680 % \begin{macrocode}
3681 \def\rtx@@citetp[#1]{\@ifnextchar[{\rtx@citex[#1]}{\rtx@citex[][#1]}}%
3682 \def\rtx@citex[#1][#2]#3{%
3683 \begingroup
3684 \def\@tempa{[#1][#2]{#3}}%
3685 \@ifx{\@cite\NAT@citesuper}{%
3686 \leavevmode
3687 \skip@\lastskip
3688 \unskip
3689 \super@cite@let
3690 }{%
3691 \super@cite@end
3692 }%
3693 }%
3694 \def\super@cite@let{%
3695 \futurelet\@let@token\super@cite@check
3696 }%
3697 \def\super@cite@end{%
3698 \aftergroup\@citex\expandafter\endgroup\@tempa
3699 }%
3700 \def\super@cite@check{%
3701 \@ifx{\@let@token\@sptoken}{%
3702 \super@cite@end
3703 }{%
3704 \super@cite@swap
3705 }%
3706 }%
3707 \long\def\super@cite@swap#1{%
3708 \expandafter\@ifx\expandafter{\csname rtx@automove#1\endcsname\@empty}{%
3709 #1%
3710 \super@cite@let
3711 }{%
3712 \super@cite@end
3713 #1%
3714 }%
3715 }%
3716 \expandafter\let\csname rtx@automove.\endcsname\@empty
3717 \expandafter\let\csname rtx@automove,\endcsname\@empty
3718 \expandafter\let\csname rtx@automove:\endcsname\@empty
3719 \expandafter\let\csname rtx@automove;\endcsname\@empty
3720 % \end{macrocode}
3721 % \end{macro}
3722 % \end{macro}
3723 % \end{macro}
3724 % \end{macro}
3725 % \end{macro}
3726 %
3727 % The following must execute only after \classname{natbib} is loaded and has set
3728 % up its parameters (which it does at \cmd\AtBeginDocument\ time).
3729 % If superscript citations have been selected, and
3730 % if the \classoption{citeautoscript} class option has been selected,
3731 % we patch into \classname{natbib}'s mechanism to migrate punctuation around the
3732 % citation, as in class \classname{cite} with the \classoption{superscript} option.
3733 % \begin{macrocode}
3734 \appdef\class@documenthook{%
3735 \citeautoscript@sw{%
3736 \@ifx{\@cite\NAT@citesuper}{%
3737 \let\NAT@@citetp\rtx@@citetp
3738 }{}%
3739 }{}%
3740 }%
3741 % \end{macrocode}
3742 %
3743 % Resolve an incompatability between \classname{natbib} and \classname{listings}.
3744 % The latter package tests \cmd\chapter (which has now been \cmd\let\ to \cmd\relax\ as a side effect \classname{natbib}'s use of \LaTeX's \cmd\@ifundefined).
3745 %
3746 % We couch our fix in such terms that will not be disruptive if \cmd\chapter\ is actually defined at this point.
3747 %
3748 % \changes{4.1b}{2008/07/01}{(AO) No longer need to test \cs{chapter} as of \texttt{natbib} version 8.2}
3749 % \begin{verbatim}
3750 %\@ifx{\chapter\relax}{\let\chapter\@undefined}{}%
3751 % \end{verbatim}
3752 %
3753 %
3754 % \subsubsection{\cs{endnote}s and \cs{rtx@bibnote}s}
3755 %
3756 % \begin{macro}{\mini@note}
3757 % \begin{macro}{\save@note}
3758 % \changes{4.1n}{2010/01/02}{(AO, 572) Independent footnote counter for title block. Abstract footnote counter shared with body.}%
3759 % QUERY: how do footnotes get thrown to the bibliography. \cmd\footinbib@sw\ appears to be irrelevant.
3760 % \begin{macrocode}
3761 \def\mini@note{\save@note\mini@notes}%Implicit #2
3762 \def\save@note#1#2{%
3763 \stepcounter\@mpfn
3764 \protected@xdef\@thefnmark{\thempfn}%
3765 \@footnotemark
3766 \expandafter\g@addto@macro
3767 \expandafter#1%
3768 \expandafter{%
3769 \expandafter \@@footnotetext
3770 \expandafter {\@thefnmark}{#2}%
3771 }%
3772 }%
3773 \long\def\@@footnotetext#1{\def\@thefnmark{#1}\@footnotetext}%
3774 \let\mini@notes\@empty
3775 % \end{macrocode}
3776 % \end{macro}
3777 % \end{macro}
3778 %
3779 % \begin{macro}{\endnote}
3780 % A version of footnote that appears in the bibliography, or where \cmd\printendnotes\ appears.
3781 % \begin{verbatim}
3782 %\def\@endnote{%
3783 % \begingroup
3784 % \aftergroup\@footnotemark
3785 % \aftergroup\@endnotetext
3786 % \@ifnextchar[{%
3787 % \@xendnote
3788 % }{%
3789 % \stepcounter{footnote}%
3790 % \protected@xdef\@tempa{\thefootnote}%
3791 % \expandafter\@xendnote\expandafter[\the\c@footnote]%
3792 % }%
3793 %}%
3794 % \end{verbatim}
3795 % \end{macro}
3796 %
3797 % \begin{macro}{\@xendnote}
3798 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
3799 % \begin{verbatim}
3800 %\def\unused@xendnote[#1]{%
3801 % \begingroup
3802 % \c@footnote#1\relax
3803 % \end{macrocode}
3804 % New for 4.1
3805 % \begin{macrocode}
3806 % \unrestored@protected@xdef\@endnotelabel{Note\thefootnote}%
3807 % \authoryear@sw{%
3808 % \unrestored@protected@xdef\@thefnmark{\noexpand\ref{\@endnotelabel}}%
3809 % }{%
3810 % \unrestored@protected@xdef\@thefnmark{\@endnotelabel}%
3811 % }%
3812 % \end{macrocode}
3813 % Was:
3814 % \unrestored@protected@xdef\@thefnmark{endnote\thefootnote}%
3815 % End 4.1 changes
3816 % \begin{macrocode}
3817 % \endgroup
3818 % \endgroup
3819 %}%
3820 %\def\@endnotemark{%
3821 % \expandafter\cite\expandafter{\@thefnmark}%
3822 %}%
3823 % \end{verbatim}
3824 % \begin{macrocode}
3825 \def\rev@citemark#1{%
3826 \expandafter\cite\expandafter{\@thefnmark}%
3827 }%
3828 \def\rev@endtext#1{%
3829 \let\@endnotelabel\@thefnmark
3830 \@endnotetext
3831 }%
3832 % \end{macrocode}
3833 % \end{macro}
3834 %
3835 % \begin{macro}{\endnote@ext}
3836 % \begin{macro}{\bibdata@app}
3837 % \begin{macro}{\bibdata@ext}
3838 % The macro \cmd\endnote@ext\ is the file extension for the auxiliary file holding footnotes.
3839 % The \cmd\bibdata@app\ and \cmd\bibdata@ext\ macros are used to form the name of a
3840 % Bib\TeX\ database file holding footnotes.
3841 % \begin{macrocode}
3842 \def\endnote@ext{.end}%
3843 \def\bibdata@app{Notes}%
3844 \def\bibdata@ext{bib}%
3845 % \end{macrocode}
3846 % \end{macro}
3847 % \end{macro}
3848 % \end{macro}
3849 %
3850 % \begin{macro}{\@endnotetext}
3851 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
3852 % The procedure \cmd\@endnotetext\ writes a Bib\TeX\ .bib file for the purpose
3853 % of insering a footnote into the (numbered, unsorted) bibliography.
3854 %
3855 % We need to define \cmd\pre@bibdata\ to be
3856 % \cmd\jobname\cmd\endnote@ext, and we probably should define \cmd\endnote@ext\ to
3857 % be something like ``Notes.bib''.
3858 %
3859 % In each case, the material to be written out requires robustification, provided by \cmd\endnote@relax.
3860 % The commands \cmd\label, \cmd\index, and \cmd\glossary,
3861 % which are robustified for \cmd\markright\ and \cmd\addcontentsline,
3862 % are likewise robustified here.
3863 %
3864 % Procedure \cmd\@endnotetext@note\ is the alias for \cmd\@endnotetext\ when the endnotes are to be
3865 % processed separately from the bibliography (generally true when citations are not sorted).
3866 % \begin{verbatim}
3867 %\long\def\unused@endnotetext@note#1{%
3868 % \@ifxundefined\@endnoteout{%
3869 % \newwrite\@endnoteout
3870 % \gdef\endnote@stream{\jobname\endnote@ext}%
3871 % \immediate\openout\@endnoteout\endnote@stream\relax
3872 % }{}%
3873 % \begingroup
3874 % \endnote@relax
3875 % \immediate\write\@endnoteout{\string\@doendnote{\@endnotelabel}{#1}}%
3876 % \endgroup
3877 %}%
3878 % \end{verbatim}
3879 %
3880 % \cmd\@doendnote\ is obsolete.
3881 % \begin{verbatim}
3882 %\def\@doendnote#1#2{\bibitem{#1}#2}%
3883 % \end{verbatim}
3884 %
3885 % \changes{4.1o}{2010/02/05}{(AO, 579) Endnote shall comprise their own Bib\TeX\ entry type: @FOOTNOTE.}
3886 % Procedure \cmd\@endnotetext\ is the operative procedure\ when the endnotes are to be
3887 % collated in with the other references, typically true when numerical citations are being used.
3888 % The technique involves writing a .bib file (\cmd\@bibdataout) with each endnote typed as
3889 % a \texttt{@FOOTNOTE} entry.
3890 %
3891 % Timing note: doing \cmd\openout\ should be deferred until the beginning of the document,
3892 % as is done here. This allows one to make a format (\filename{.fmt}) file out of this class.
3893 % \begin{macrocode}
3894 \long\def\@endnotetext#1{%
3895 \begingroup
3896 \endnote@relax
3897 \immediate\write\@bibdataout{%
3898 @FOOTNOTE{%
3899 \@endnotelabel,%
3900 % \end{macrocode}
3901 % The \texttt{key} field is recommended in cases where there is no author (see \filename{btxdoc}).
3902 % \begin{macrocode}
3903 key="\@endnotelabel",%
3904 % \end{macrocode}
3905 % The \texttt{note} field is simply the content of the footnote.
3906 % \begin{macrocode}
3907 note="#1"%
3908 }%
3909 }%
3910 \endgroup
3911 }%
3912 \newwrite\@bibdataout
3913 % \end{macrocode}
3914 % \end{macro}
3915 %
3916 % \begin{macro}{\endnote@relax}
3917 % At \cmd\AtBeginDocument\ time, we open the job's \filename{.bib} file.
3918 %
3919 % Procedure \cmd\endnote@relax\ robustifies commands that ought not to be expanded when
3920 % the endnote is written out.
3921 % Note the similarity between \cmd\endnote@relax\ and \cmd\protected@write.
3922 % \begin{macrocode}
3923 \def\endnote@relax{%
3924 \let\label\relax \let\index\relax \let\glossary\relax
3925 \let\cite \relax \let\ref \relax \let\pageref \relax
3926 \let\( \relax \let\) \relax \let\\ \relax
3927 \let~\relax
3928 % \end{macrocode}
3929 % \begin{verbatim}
3930 %\let\protect\noexpand
3931 % \end{verbatim}
3932 % \begin{macrocode}
3933 \let \protect \@unexpandable@protect
3934 \newlinechar`\^^M%
3935 % \end{macrocode}
3936 % \begin{verbatim}
3937 %\newlinechar`\ %
3938 % \end{verbatim}
3939 % \begin{macrocode}
3940 \let\begin\relax \let\end\relax
3941 }%
3942 % \end{macrocode}
3943 % \end{macro}
3944 %
3945 % \begin{macro}{\@bibdataout@init}
3946 % \begin{macro}{\@bibdataout@aps}
3947 % \changes{4.1o}{2010/02/10}{(AO, 580) Provide a document class option to turn off production of eprint field in bibliography.}
3948 % \changes{4.1o}{2010/02/12}{(AO, 580) Control .bst at run time.}%
3949 % \changes{4.1q}{2010/04/13}{(AO, 588) Only write \revtex-specific BibTeX .bib data if the .bst style is set by REVTeX.}%
3950 % At \cmd\AtBeginDocument\ time, we open the job's \filename{.bib} file.
3951 % The hook is available for use by a society to place its own @CONTROL record in the \cmd\@bibdataout\ stream.
3952 % \begin{macrocode}
3953 \appdef\class@documenthook{\@bibdataout@init}%
3954 \def\@bibdataout@init{%
3955 \immediate\openout\@bibdataout\pre@bibdata.\bibdata@ext\relax
3956 }%
3957 \def\@bibdataout@rev{%
3958 \immediate\write\@bibdataout{%
3959 % \end{macrocode}
3960 % The entry that controls processing of the \filename{.bst} file has entry type \texttt{@CONTROL}.
3961 % The citation key (REVTEX41Control) is effectively a version number,
3962 % which the \filename{.bst} can use to interpret the bib entry.
3963 % \begin{macrocode}
3964 @CONTROL{%
3965 REVTEX41Control%
3966 % \end{macrocode}
3967 % Say if we want the \texttt{eprint} field disabled. Otherwise accept the default of the \filename{.bst}.
3968 % \begin{macrocode}
3969 \eprint@enable@sw{}{,eprint=""}%
3970 }%
3971 }%
3972 % \end{macrocode}
3973 % Place a \cmd\citation\ into the auxiliary file corresponding to this entry.
3974 % \begin{macrocode}
3975 \if@filesw
3976 \immediate\write\@auxout{\string\citation{REVTEX41Control}}%
3977 \fi
3978 }%
3979 % \end{macrocode}
3980 % \end{macro}
3981 % \end{macro}
3982 %
3983 % \begin{macro}{\printendnotes}
3984 % \changes{4.1f}{2009/07/10}{(AO, 520) Automatically produce \cs{bibliography} command when needed}%
3985 % We have removed the endnotes facility from REVTeX, so the \cmd\printendnotes\ command now does nothing.
3986 %
3987 % Moving footnotes to the bibliogrphy is now accomplished through
3988 % the automatic generation of a job BiB\TeX\ database (called \cmd\pre@bibdata) containing the footnotes.
3989 % \begin{macrocode}
3990 \def\printendnotes{%
3991 \class@warn{The \string\printendnotes\space command no longer serves any function. Please remove it from your document.}%
3992 }%
3993 % \end{macrocode}
3994 % \end{macro}
3995 %
3996 % \begin{macro}{\@endnotesinbib}
3997 % \begin{macro}{\@endnotesinbibliography}
3998 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
3999 % We define a function \cmd\@endnotesinbib,
4000 % and a variant \cmd\@endnotesinbibliography.
4001 % The former is invoked at the start of
4002 % the end processing for \enve{thebibliography};
4003 % the latter is a synonym.
4004 %
4005 % The procedure typesets the footnotes that are to
4006 % appear in the bibliography; the default is to
4007 % simply arrange for the footnote counter to be
4008 % reset at the start of the document.
4009 %
4010 % Note that this code make the assumption that
4011 % the counter used in \env{thebibliography} is \cmd\c@NAT@ctr.
4012 % \changes{4.1f}{2009/07/10}{(AO, 520) Automatically produce \cs{bibliography} command when needed}%
4013 %
4014 % Here is the sole place where \cmd\footinbib@sw\ has an effect, other code simple assigning its value.
4015 % If it is false, or \cmd\authoryear@sw\ is true, then footnotes are handled by the default mechanism.
4016 % \begin{macrocode}
4017 \def\make@footnote@endnote{%
4018 \footinbib@sw{%
4019 \authoryear@sw{}{%
4020 \ltx@footnote@push
4021 \def\thempfn{Note\thefootnote}%
4022 \let\ltx@footmark\rev@citemark
4023 \let\ltx@foottext\rev@endtext
4024 % \end{macrocode}
4025 % The endnotes facility has been removed.
4026 % Also, there is no need to queue up \cmd\auto@bib\ here, since it is always queued up elsewhere.
4027 % \changes{4.1f}{2009/07/10}{(AO, 520) Automatically produce \cs{bibliography} command when needed}%
4028 % \begin{verbatim}
4029 % \appdef\class@enddocumenthook{\auto@bib}%
4030 % \let\printendnotes\relax
4031 % \end{verbatim}
4032 % \begin{macrocode}
4033 }%
4034 }{}%
4035 }%
4036 % \end{macrocode}
4037 %
4038 % \begin{macrocode}
4039 \def\ltx@footnote@push{%
4040 \let\ltx@footmark@latex\ltx@footmark
4041 \let\ltx@foottext@latex\ltx@foottext
4042 \let\thempfn@latex\thempfn
4043 \def\ltx@footnote@pop{%
4044 \let\ltx@footmark\ltx@footmark@latex
4045 \let\ltx@foottext\ltx@foottext@latex
4046 \let\thempfn\thempfn@latex
4047 }%
4048 }%
4049 % \end{macrocode}
4050 %
4051 % The switchover to setting footnotes in the bibliography
4052 % changes the meaning of \cmd\footnote\ and
4053 % substitutes the synonym for \cmd\@endnotesinbib.
4054 %
4055 % We arrange for the procedure \cmd\make@footnote@endnote\ to be executed
4056 % at \cmd\class@documenthook\ time (we mustn't do this earlier because
4057 % the meaning of \cmd\@footnotemark\ must not be changed before then,
4058 % for the sake of \file{ltxutil.dtx}).
4059 % \begin{macrocode}
4060 \appdef\class@documenthook{%
4061 \make@footnote@endnote
4062 }%
4063 % \end{macrocode}
4064 % \end{macro}
4065 % \end{macro}
4066 %
4067 % \begin{macro}{\auto@bib}
4068 % \begin{macro}{\auto@bib@empty}
4069 % \begin{macro}{\test@bbl@sw}
4070 % \begin{macro}{\bibitem@set}
4071 % \begin{macro}{\auto@bib@innerbib}
4072 % \begin{macro}{\thebibliography@nogroup}
4073 % \changes{4.1f}{2009/07/10}{(AO, 520) Automatically produce \cs{bibliography} command when needed}%
4074 % \changes{4.1n}{2010/01/02}{(AO, 572) Independent footnote counter for title block. Abstract footnote counter shared with body.}%
4075 % \changes{4.1o}{2010/02/02}{(AO, 575) Automatically incorporate the (Bib\TeX-generated) .bbl into an explicit \env{thebibliography}}%
4076 % Under some circumstances, we must typeset the bibliography automatically.
4077 % If the document requires footnotes to be set in the bibliography (effectively, class option \texttt{footinbib}),
4078 % or that frontmatter footnotes be set in the bibliography (effectively, class option \texttt{bibnotes}),
4079 % but contains no explicit \cmd\bibliography\ statement.
4080 %
4081 % Note that this facility is not able to work more than once per document.
4082 % If multiple bibliographys are required (e.g., per article), it will be the responsibility of the journal style
4083 % to restore \cmd\auto@bib\ to its original meaning so it can be re-invoked.
4084 %
4085 % In procedure \cmd\auto@bib, we first test for the presence of frontmatter footnotes deferred to the bibliography.
4086 % If none, we further test for the presence of \cmd\bibitem\ commands in the job's \filename{.bbl} file.
4087 % If either condition is met, we ask for a bibliography.
4088 % We know that the document itself lacks a \cmd\bibliography\ statement,
4089 % so we know the argument of the \cmd\bibliography\ that we will issue.
4090 % \begin{macrocode}
4091 \def\auto@bib{%
4092 \@ifx@empty\@FMN@list{%
4093 \footinbib@sw{%
4094 \@ifnum{\csname c@\@mpfn\endcsname>\z@}{%
4095 \true@sw
4096 }{%
4097 \test@bbl@sw
4098 }%
4099 }{%
4100 \test@bbl@sw
4101 }%
4102 }{%
4103 \true@sw
4104 }%
4105 {%
4106 \bibliography{}%
4107 }{}%
4108 }%
4109 \def\auto@bib@empty{%
4110 \let\auto@bib\@empty
4111 }%
4112 % \end{macrocode}
4113 % Testing the \filename{.bbl} file involves defanging all expected commands
4114 % and processing that file inside a box register (that will be simply discarded).
4115 % We provide a new meaning for the \cmd\bibitem\ command: it queues a Boolean.
4116 % \begin{macrocode}
4117 \def\test@bbl@sw{%
4118 \setbox\z@\vbox\bgroup
4119 \let\providecommand\providecommand@j@nk
4120 \let\bibfield\@gobbletwo
4121 \let\bibinfo\@gobbletwo
4122 \let\translation\@gobble
4123 \let\BibitemOpen\@empty
4124 \let\bibitemStop\@empty
4125 \let\bibitemNoStop\@empty
4126 \let\EOS\@empty
4127 \let\BibitemShut\@gobble
4128 \let\bibAnnoteFile\@gobbletwo
4129 \let\bibAnnote\@gobblethree
4130 \let\textbf\@gobble
4131 \let\emph\@gobble
4132 \@booleanfalse\bibitem@sw
4133 \let\bibitem\bibitem@set
4134 \auto@bib@innerbib
4135 \bibitem@sw{\aftergroup\true@sw}{\aftergroup\false@sw}%
4136 \egroup
4137 }%
4138 % \end{macrocode}
4139 % The \cmd\bibitem@set\ is an alias for \cmd\bibitem\ for the purpose of detecting a non-trivial bibliography.
4140 % \begin{macrocode}
4141 \newcommand\bibitem@set[1][]{%
4142 \bibitem@sw{}{%
4143 \@booleantrue\bibitem@sw
4144 \aftergroup\@booleantrue\aftergroup\bibitem@sw
4145 }%
4146 }%
4147 % \end{macrocode}
4148 % The \cmd\auto@bib@innerbib\ procedure reads in the \filename{.bbl} file (if it exists)
4149 % within a context where its \env{thebibliography} environment does nothing, not even establishing a group.
4150 % \begin{macrocode}
4151 \def\auto@bib@innerbib{%
4152 \begingroup
4153 \let@environment{thebibliography}{thebibliography@nogroup}%
4154 \bibliography{}%
4155 \endgroup
4156 }%
4157 % \end{macrocode}
4158 % Environment \env{thebibliography@nogroup} is an alias of the \env{thebibliography} environment that cancels itself.
4159 % It assumes that it is called within a \env{thebibliography} environment.
4160 % \begin{macrocode}
4161 \def\thebibliography@nogroup#1{%
4162 \endgroup
4163 \def\@currenvir{thebibliography}%
4164 }%
4165 \def\endthebibliography@nogroup{\begingroup}%
4166 % \end{macrocode}
4167 % The following should be part of \filename{ltxutil}.
4168 % \begin{macrocode}
4169 \long\def \@gobblethree #1#2#3{}%
4170 \def\providecommand@j@nk#1[#2]{%
4171 \@ifnum{#2=\z@}{\def\j@nk}{%
4172 \@ifnum{#2=\@ne}{\def\j@nk##1}{%
4173 \@ifnum{#2=\tw@}{\def\j@nk##1##2}{%
4174 \@ifnum{#2=\thr@@}{\def\j@nk##1##2##3}{%
4175 }%
4176 }%
4177 }%
4178 }%
4179 }%
4180 % \end{macrocode}
4181 % \end{macro}
4182 % \end{macro}
4183 % \end{macro}
4184 % \end{macro}
4185 % \end{macro}
4186 % \end{macro}
4187 %
4188 % \section{Initial setup}
4189 %
4190 % The standard LaTeX document classes execute certain commands
4191 % that are best deferred until \cmd\class@documenthook\ time.
4192 % Here, we effectively split \cmd\pagenumbering\ into two halves,
4193 % with a default definition for \cmd\thepage
4194 % and an initialization of \cmd\c@page\ at \cmd\class@documenthook\ time.
4195 %
4196 % The meaning of \cmd\thepage\ can be overridden by society, journal, or
4197 % anywhere within the document pramble, and the counter itself will be
4198 % preset at the beginning of the document.
4199 % \begin{macrocode}
4200 \def\thepage{\@arabic\c@page}%
4201 % \end{macrocode}
4202 % \changes{4.0b}{1999/06/20}{Defer assignment until \cs{AtBeginDocument} time.}
4203 % Note that this code is executed at \cmd\setup@hook\ time
4204 % to allow for the possibility of overrides by packages like \classname{geometry}.
4205 % \begin{macrocode}
4206 \appdef\setup@hook{%
4207 \tabbingsep \labelsep
4208 \leftmargin\leftmargini
4209 \labelwidth\leftmargin\advance\labelwidth-\labelsep
4210 \let\@listi\@listI
4211 \@listi
4212 }%
4213 % \begin{macrocode}
4214 %
4215 % We ensure that the ``environment'' component mark (implemented by \file{ltxgrid.dtx})
4216 % is initialized properly (via a hook, itself defined via \file{ltxutil.dtx}).
4217 % \begin{macrocode}
4218 \appdef\class@documenthook{%
4219 \global\c@page\@ne
4220 \def\curr@envir{document}%
4221 \mark@envir{\curr@envir}%
4222 }%
4223 % \end{macrocode}
4224 %
4225 % \begin{macro}{\open@onecolumn}%
4226 % \begin{macro}{\open@column@two}%
4227 % \changes{4.0c}{1999/11/13}{Grid changes with ltxgrid}
4228 % \changes{4.0d}{2000/04/10}{Also alter how lists get indented.}
4229 % When setting the column grid, we have to override the procedure
4230 % for formatting lists.
4231 % Because \cmd\twocolumngrid\ requires rebalancing columns at some points,
4232 % typesetting must employ only the manipulation of
4233 % \cmd\leftskip\ and \cmd\rightskip, and must avoid the use of
4234 % \cmd\moveleft, \cmd\moveright, and \cmd\parshape.
4235 %
4236 % It is one of the stranger features of \TeX\ that these two separate
4237 % mechanisms exist. The latter three have the effect of adding things to the
4238 % Main Vertical List that cannot be removed and later added back with all their
4239 % properties intact.
4240 %
4241 % In detail, \cmd\moveleft, say, adds a box to the MVL with
4242 % its reference point shifted horizontally by some amount relative to the
4243 % reference point of the enclosing list. If that box is removed from the
4244 % MVL (via a \cmd\lastbox\ operation in the output routine), and later
4245 % thrown back to the MVL, the shift of the box will have been ``forgotten'' by \TeX.
4246 % This is a bug, but not one ``acceptible to D. E. Knuth'', so it will never be fixed.
4247 %
4248 % \begin{macrocode}
4249 \def\open@onecolumn{%
4250 \open@column@one\@ne
4251 \set@colht
4252 \@floatplacement
4253 \@dblfloatplacement
4254 }%
4255 \def\open@twocolumn{%
4256 \open@column@mlt\tw@
4257 \set@colht
4258 \@floatplacement
4259 \@dblfloatplacement
4260 \sloppy
4261 \let\set@listindent\set@listindent@
4262 }%
4263 % \end{macrocode}
4264 % \end{macro}
4265 % \end{macro}
4266 %
4267 % \section{\cs{appendix}}
4268 %
4269 % \begin{macrocode}
4270 %\newif\ifappendixon
4271 % \end{macrocode}
4272 % Note that, within appendices,
4273 % equations are numbered within sections (appendices).
4274 % \begin{macrocode}
4275 \def\appendix{%
4276 \par
4277 %\appendixontrue
4278 \setcounter{section}\z@
4279 \setcounter{subsection}\z@
4280 \setcounter{subsubsection}\z@
4281 \def\thesubsection{\arabic{subsection}}%
4282 \def\thesubsubsection{\alph{subsubsection}}%
4283 \@addtoreset{equation}{section}%
4284 \def\theequation@prefix{\thesection}%
4285 \addtocontents{toc}{\protect\appendix}%
4286 \@ifstar{%
4287 \def\thesection{\unskip}%
4288 \def\theequation@prefix{A.}%
4289 }{%
4290 \def\thesection{\Alph{section}}%
4291 }%
4292 }%
4293 % \end{macrocode}
4294 %
4295 % \section{Changing the page grid}
4296 % \changes{4.0b}{1999/06/20}{Define three separate environments, defer assignment to \cs{AtBeginDocument} time.}
4297 %
4298 % \subsection{Avoiding Grid Changes}%
4299 %
4300 % In preprint styles, ``wide text'' is a no-op, and the title page
4301 % processing involves no grid change.
4302 %
4303 % \begin{macro}{\title@column}%
4304 % \begin{macro}{\close@column}%
4305 % Provide default meanings for \cmd\title@column\ and \cmd\close@column,
4306 % in case they were never defined.
4307 % Note that the society or journal substyle may define
4308 % \cmd\title@column\ or \cmd\close@column: this code will not override.
4309 % \begin{macrocode}
4310 \def\title@column#1{%
4311 \minipagefootnote@init
4312 #1%
4313 \minipagefootnote@foot
4314 }%
4315 \def\close@column{%
4316 \newpage
4317 }%
4318 % \end{macrocode}
4319 % \end{macro}
4320 % \end{macro}
4321 %
4322 %
4323 % \subsection{Galley Style: Margin Changes}%
4324 % A variant of preprint processing. Emulate journal appearance somewhat.
4325 %
4326 % \begin{environment}{widetext@galley}
4327 % DPC: We're in galley style so do a lob sided display environment.
4328 %
4329 % QUERY: How can we be sure that we are in galley style?
4330 % ANSWER: as noted elsewhere, require that both \cmd\twocolumn@sw\ and \cmd\preprintsty@sw\ be false.
4331 % \begin{macrocode}
4332 \def\galley@outdent{\rightmargin-\columnwidth\advance\rightmargin-\columnsep}%
4333 \let\widetext@outdent\@empty
4334 \newenvironment{widetext@galley}{%
4335 \list{}{%
4336 \topsep \z@skip
4337 \listparindent \parindent
4338 \itemindent \parindent
4339 \leftmargin \z@
4340 \parsep \z@\@plus\p@
4341 \widetext@outdent
4342 \relax
4343 }%
4344 \item\relax
4345 }{
4346 \endlist
4347 }%
4348 % \end{macrocode}
4349 % \end{environment}
4350 %
4351 %
4352 % \subsection{Grid Changing Via \classname{ltxgrid}}%
4353 %
4354 % In case \classoption{twocolumngrid} has been invoked,
4355 % switch column grid using the column grid-changing commands.
4356 % Supply stub definitions of those commands here.
4357 % \changes{4.0c}{1999/11/13}{grid changes with ltxgrid}
4358 %
4359 % \begin{macro}{\title@column@grid}%
4360 % \begin{macro}{\close@column@grid}%
4361 % The title block always starts at the top of a new page.
4362 % \changes{4.0c}{1999/11/13}{grid changes with ltxgrid}
4363 %
4364 % Note that, for the procedure \cmd\close@column@grid,
4365 % we balance columns by switching to the one-column page grid.
4366 % \begin{macrocode}
4367 \def\title@column@grid#1{%
4368 \minipagefootnote@init
4369 \onecolumngrid
4370 \begingroup
4371 \let\@footnotetext\frontmatter@footnotetext
4372 %<ignore> \let\set@footnotewidth\set@footnotewidth@two
4373 \ltx@no@footnote
4374 #1%
4375 \endgroup
4376 \twocolumngrid
4377 \minipagefootnote@foot
4378 }%
4379 \def\close@column@grid{%
4380 \balancelastpage@sw{%
4381 \onecolumngrid
4382 %<ignore> \twocolumngrid
4383 }{}%
4384 }%
4385 % \end{macrocode}
4386 % \end{macro}
4387 % \end{macro}
4388 %
4389 % \begin{environment}{widetext@grid}
4390 % \changes{4.0c}{1999/11/13}{grid changes via ltxgrid procedures}
4391 % \changes{4.0e}{2000/11/21}{adornments above and below.}
4392 % \changes{4.1g}{2009/10/07}{(AO, 525) Remove phantom paragraph above display math that is given in vertical mode}%
4393 % We slip into the one-column page grid
4394 % within the scope of this environment.
4395 %
4396 % Note that we set adornments above and below the \env{widettext}.
4397 % These are set as leaders, so they will disappear at a page break.
4398 % \changes{4.1n}{2010/01/02}{(AO) fine-tune spacing above and below widetext}%
4399 % \begin{macrocode}
4400 \newenvironment{widetext@grid}{%
4401 \par\ignorespaces
4402 \setbox\widetext@top\vbox{%
4403 %<ignore> \vskip15\p@
4404 \hb@xt@\hsize{%
4405 \leaders\hrule\hfil
4406 \vrule\@height6\p@
4407 }%
4408 %<ignore> \vskip6\p@
4409 }%
4410 \setbox\widetext@bot\hb@xt@\hsize{%
4411 \vrule\@depth6\p@
4412 \leaders\hrule\hfil
4413 }%
4414 \onecolumngrid
4415 \vskip10\p@
4416 \dimen@\ht\widetext@top\advance\dimen@\dp\widetext@top
4417 \cleaders\box\widetext@top\vskip\dimen@
4418 %<ignore> \let\set@footnotewidth\set@footnotewidth@two
4419 \vskip6\p@
4420 \prep@math@patch
4421 }{%
4422 \par
4423 \vskip6\p@
4424 \setbox\widetext@bot\vbox{%
4425 \hb@xt@\hsize{\hfil\box\widetext@bot}%
4426 %<ignore> \vskip14\p@
4427 }%
4428 \dimen@\ht\widetext@bot\advance\dimen@\dp\widetext@bot
4429 \cleaders\box\widetext@bot\vskip\dimen@
4430 \vskip8.5\p@
4431 \twocolumngrid\global\@ignoretrue
4432 \@endpetrue
4433 }%
4434 \newbox\widetext@top
4435 \newbox\widetext@bot
4436 % \end{macrocode}
4437 % \end{environment}
4438 %
4439 %
4440 % Decide, finally, how the page grid is to be manipulated.
4441 % \begin{macrocode}
4442 \def\set@page@grid{%
4443 \twocolumn@sw{%
4444 % \end{macrocode}
4445 % The following two assignments determine what procedures are to be executed when
4446 % the footnote set width is calculated, and how footnotes are to be composed at the bottom of the page.
4447 % A society or journal wishing to do otherwise will override this code.
4448 % \begin{macrocode}
4449 \let\set@footnotewidth\set@footnotewidth@two
4450 \let\compose@footnotes\compose@footnotes@two
4451 \let@environment{widetext}{widetext@grid}%
4452 \let\title@column\title@column@grid
4453 \let\close@column\close@column@grid
4454 }{%
4455 \let@environment{widetext}{widetext@galley}%
4456 \preprintsty@sw{%
4457 % \end{macrocode}
4458 % Change the page grid not at all.
4459 % \begin{macrocode}
4460 }{%
4461 % \end{macrocode}
4462 % If we are galley style, change the page margin only.
4463 % \begin{macrocode}
4464 \galley@sw{%
4465 \let\widetext@outdent\galley@outdent
4466 }{}%
4467 }%
4468 }%
4469 }%
4470 \appdef\setup@hook{\set@page@grid}%
4471 % \end{macrocode}
4472 %
4473 % \section{Old font commands}
4474 %
4475 % \begin{macrocode}
4476 \DeclareOldFontCommand{\rm}{\normalfont\rmfamily}{\mathrm}
4477 \DeclareOldFontCommand{\sf}{\normalfont\sffamily}{\mathsf}
4478 \DeclareOldFontCommand{\tt}{\normalfont\ttfamily}{\mathtt}
4479 \DeclareOldFontCommand{\bf}{\normalfont\bfseries}{\mathbf}
4480 \DeclareOldFontCommand{\it}{\normalfont\itshape}{\mathit}
4481 \DeclareOldFontCommand{\sl}{\normalfont\slshape}{\@nomath\sl}
4482 \DeclareOldFontCommand{\sc}{\normalfont\scshape}{\@nomath\sc}
4483 \DeclareRobustCommand*\cal{\@fontswitch\relax\mathcal}
4484 \DeclareRobustCommand*\mit{\@fontswitch\relax\mathnormal}
4485 % \end{macrocode}
4486 %
4487 % \section{English-Language Texts}
4488 % As this class is just for English language journals, we
4489 % could hardwire these texts,
4490 % but to make it easier to use this as a
4491 % basis for the code for similar journal styles, separate out all the
4492 % fixed text strings into babel-style macros of the form
4493 % |\|\ldots|name|
4494 %
4495 % Note: for babel compatability, use version 1999/05/05 v3.6x or later.
4496 %
4497 % Some of these might need changing in the society-specific code.
4498 %
4499 % \begin{macro}{\today}
4500 % Procedure \cmd\today\ is used in the article class, but not in
4501 % this document class.
4502 % \begin{macrocode}
4503 \def\today{\ifcase\month\or
4504 January\or February\or March\or April\or May\or June\or
4505 July\or August\or September\or October\or November\or December\fi
4506 \space\number\day, \number\year}
4507 % \end{macrocode}
4508 % \end{macro}
4509 %
4510 % \begin{macro}{\notesname}
4511 % Text entity \cmd\notesname\ had been used in \cmd\printendnotes.
4512 % \changes{4.1f}{2009/07/10}{(AO, 520) Automatically produce \cs{bibliography} command when needed}%
4513 % However, we have removed the endnotes facility from REVTeX.
4514 %
4515 % \begin{verbatim}
4516 %\def\notesname{Notes}
4517 % \end{verbatim}
4518 % \end{macro}
4519 %
4520 % \begin{macro}{\partname}
4521 % Text entity \cmd\partname\ is used in \cmd\@part.
4522 % \begin{macrocode}
4523 \def\partname{Part}
4524 % \end{macrocode}
4525 % \end{macro}
4526 %
4527 % \begin{macro}{\tocname}
4528 % Text entity \cmd\tocname\ is used in \cmd\tableofcontents,
4529 % as defined in the standard \LaTeX\ book class.
4530 % \begin{macrocode}
4531 \def\tocname{Contents}
4532 % \end{macrocode}
4533 % \end{macro}
4534 %
4535 % \begin{macro}{\lofname}
4536 % Text entity \cmd\lofname\ is used in \cmd\listoffigures,
4537 % as defined in the standard \LaTeX\ book class.
4538 % \begin{macrocode}
4539 \def\lofname{List of Figures}
4540 % \end{macrocode}
4541 % \end{macro}
4542 %
4543 % \begin{macro}{\lotname}
4544 % Text entity \cmd\lotname\ is used in \cmd\listoftables,
4545 % as defined in the standard \LaTeX\ book class.
4546 % \begin{macrocode}
4547 \def\lotname{List of Tables}
4548 % \end{macrocode}
4549 % \end{macro}
4550 %
4551 % \begin{macro}{\refname}
4552 % Text entity \cmd\refname\ is used in \env{thebibliography}.
4553 % \begin{macrocode}
4554 \def\refname{References}
4555 % \end{macrocode}
4556 % \end{macro}
4557 %
4558 % \begin{macro}{\indexname}
4559 % Text entity \cmd\indexname\ is used in \env{theindex},
4560 % as defined in the standard \LaTeX\ book class.
4561 % \begin{macrocode}
4562 \def\indexname{Index}
4563 % \end{macrocode}
4564 % \end{macro}
4565 %
4566 % \begin{macro}{\figurename}
4567 % \changes{4.0b}{1999/06/20}{Added localization of \cs{figuresname}}
4568 % Text entity \cmd\figurename\ is used in \env{figure},
4569 % \cmd\figuresname\ in \cmd\printfigures.
4570 % \begin{macrocode}
4571 \def\figurename{FIG.}
4572 \def\figuresname{Figures}%
4573 % \end{macrocode}
4574 % \end{macro}
4575 %
4576 % \begin{macro}{\tablename}
4577 % \changes{4.0b}{1999/06/20}{Added localization of \cs{tablesname}}
4578 % Text entity \cmd\tablename\ is used in \env{table},
4579 % \cmd\tablesname\ in \cmd\printtables.
4580 % \begin{macrocode}
4581 \def\tablename{TABLE}
4582 \def\tablesname{Tables}%
4583 % \end{macrocode}
4584 % \end{macro}
4585 %
4586 % \begin{macro}{\abstractname}
4587 % Text entity \cmd\abstractname\ is used in \env{abstract}.
4588 % \begin{macrocode}
4589 \def\abstractname{Abstract}
4590 % \end{macrocode}
4591 % \end{macro}
4592 %
4593 % \begin{macro}{\appendixesname}
4594 % \begin{macro}{\appendixname}
4595 % Text entity \cmd\appendixesname\ is used in TOC.
4596 % \begin{macrocode}
4597 \def\appendixesname{Appendixes}%
4598 \def\appendixname{Appendix}%
4599 % \end{macrocode}
4600 % \end{macro}
4601 % \end{macro}
4602 %
4603 % \begin{macro}{\acknowledgmentsname}
4604 % Text entity \cmd\acknowledgmentsname\ is used in \env{acknowledgments}.
4605 % \begin{macrocode}
4606 \def\acknowledgmentsname{Acknowledgments}
4607 % \end{macrocode}
4608 % \end{macro}
4609 %
4610 % \begin{macro}{\journalname}
4611 % This should be set by the society journal options, eg `pra'.
4612 % \begin{macrocode}
4613 \def\journalname{??}
4614 % \end{macrocode}
4615 % \end{macro}
4616 %
4617 % \begin{macro}{\copyrightname}
4618 % Default layout does not assign copyright, but a journal that wants
4619 % to might use this.
4620 % \begin{macrocode}
4621 \def\copyrightname{??}
4622 % \end{macrocode}
4623 % \end{macro}
4624 %
4625 % \begin{macro}{\andname}
4626 % The text string ``and'' for use in author lists.
4627 % \begin{macrocode}
4628 \def\andname{and}
4629 % \end{macrocode}
4630 % \end{macro}
4631 %
4632 % \begin{macro}{\@pacs@name}
4633 % \begin{macro}{\@keys@name}
4634 % The text string prepended to PACS numbers, resp. to keywords.
4635 % \begin{macrocode}
4636 \def\@pacs@name{PACS numbers: }%
4637 \def\@keys@name{Keywords: }%
4638 % \end{macrocode}
4639 % \end{macro}
4640 % \end{macro}
4641 %
4642 % \begin{macro}{\ppname}
4643 % The text string ``pp'' for use in page ranges.
4644 % \begin{macrocode}
4645 \def\ppname{pp}
4646 % \end{macrocode}
4647 % \end{macro}
4648 %
4649 % \begin{macro}{\numbername}
4650 % The text string ``number'' for use in article reference.
4651 % \begin{macrocode}
4652 \def\numbername{number}
4653 % \end{macrocode}
4654 % \end{macro}
4655 %
4656 % \begin{macro}{\volumename}
4657 % The text string ``volume'' for use in article reference.
4658 % \begin{macrocode}
4659 \def\volumename{volume}
4660 % \end{macrocode}
4661 % \end{macro}
4662 %
4663 % \begin{macro}{\Dated@name}
4664 % \begin{macro}{\Received@name}
4665 % \begin{macro}{\Revised@name}
4666 % \begin{macro}{\Accepted@name}
4667 % \begin{macro}{\Published@name}
4668 % These texts are used in the \cmd\date, et al. commands.
4669 % \begin{macrocode}
4670 \def\Dated@name{Dated: }%
4671 \def\Received@name{Received }%
4672 \def\Revised@name{Revised }%
4673 \def\Accepted@name{Accepted }%
4674 \def\Published@name{Published }%
4675 % \end{macrocode}
4676 % \end{macro}
4677 % \end{macro}
4678 % \end{macro}
4679 % \end{macro}
4680 % \end{macro}
4681 %
4682 % \section{Legacy Commands}
4683 % We define some commands left over from version 3.1, or give default meanings.
4684 % Some definitions can be overridden
4685 % in the document preamble or in included packages.
4686 %
4687 % Note on the namespace: command names like \cmd\REV@\emph{name} are used here,
4688 % because it is not clear that any of this code is generally useful.
4689 % \begin{macrocode}
4690 \def\address{\replace@command\address\affiliation}%
4691 \def\altaddress{\replace@command\altaddress\altaffiliation}%
4692 \newenvironment{references}{%
4693 \class@warn@end{The references environment is not supported; use thebibliography instead.}
4694 \gdef\references{\thebibliography{}}\references
4695 }{%
4696 \endthebibliography
4697 }%
4698 \def\draft{%
4699 \class@warn@end{Command \string\draft\space is obsolete;^^JInvoke option draft instead.}%
4700 \@booleantrue\draft@sw
4701 }%
4702 \def\tighten{%
4703 \class@warn@end{Command \string\tighten\space is obsolete;^^JInvoke option tightenlines instead.}%
4704 \@booleantrue\tightenlines@sw
4705 }%
4706 \def\tableline{%
4707 \noalign{%
4708 \class@warn@end{Command \string\tableline\space is obsolete;^^JUse \string\colrule\space instead.}%
4709 \global\let\tableline\colrule
4710 }%
4711 \tableline
4712 }%
4713 \def\case{\replace@command\case\frac}%
4714 \def\slantfrac{\replace@command\slantfrac\frac}%
4715 \def\tablenote{\replace@command\tablenote\footnote}%
4716 \def\tablenotemark{\replace@command\tablenotemark\footnotemark}%
4717 \def\tablenotetext{\replace@command\tablenotetext\footnotetext}%
4718 % Lose the following definition:
4719 \DeclareRobustCommand\REV@text[1]{%
4720 \relax
4721 \ifmmode
4722 \mathchoice
4723 {\hbox{{\everymath{\displaystyle }#1}}}%
4724 {\hbox{{\everymath{\textstyle }#1}}}%
4725 {\hbox{{\everymath{\scriptstyle }\let\f@size\sf@size\selectfont#1}}}%
4726 {\hbox{{\everymath{\scriptscriptstyle}\let\f@size\ssf@size\selectfont#1}}}%
4727 \glb@settings
4728 \else
4729 \mbox{#1}%
4730 \fi
4731 }%
4732 % Lose the following definition:
4733 \DeclareRobustCommand\REV@bbox[1]{%
4734 \relax
4735 \ifmmode
4736 \mathchoice
4737 {\hbox{{\everymath{\displaystyle }\boldmath$#1$}}}%
4738 {\hbox{{\everymath{\textstyle }\boldmath$#1$}}}%
4739 {\hbox{{\everymath{\scriptstyle }\boldmath$#1$}}}%
4740 {\hbox{{\everymath{\scriptscriptstyle}\boldmath$#1$}}}%
4741 \glb@settings
4742 \else
4743 \mbox{#1}%
4744 \fi
4745 }%
4746 \DeclareRobustCommand\REV@bm[1]{%
4747 \class@warn@end{To use \string\bm, please load the bm package!}%
4748 \global\let\bm\relax
4749 }%
4750 \def\FL{\obsolete@command\FL}%
4751 \def\FR{\obsolete@command\FR}%
4752 \def\narrowtext{\obsolete@command\narrowtext}%
4753 \def\mediumtext{\obsolete@command\mediumtext}%
4754 \newenvironment{quasitable}{%
4755 \let@environment{tabular}{longtable}%
4756 }{%
4757 }%
4758 % \end{macrocode}
4759 %
4760 % \begin{macro}{\text}
4761 % \begin{macro}{\bm}
4762 % \begin{macro}{\bibinfo}
4763 % \begin{macro}{\eprint}
4764 % \begin{macro}{\url}
4765 %
4766 % If not otherwise defined, give default meanings to certain commands.
4767 % \changes{4.0d}{2000/04/10}{eprint takes an optional argument, syntactical only in this case.}
4768 %FIXME: \cmd\bibinfo?
4769 % \begin{macrocode}
4770 \let\text\REV@text
4771 \let\bm\REV@bm
4772 \appdef\setup@hook{%
4773 \providecommand\bibinfo[2]{#2}%
4774 \providecommand\eprint[2][]{#2}%
4775 %\providecommand\url[1]{#1}%
4776 }%
4777 % \end{macrocode}
4778 % \end{macro}
4779 % \end{macro}
4780 % \end{macro}
4781 % \end{macro}
4782 % \end{macro}
4783 %
4784 % \begin{macro}{\bbox}
4785 %
4786 % \begin{macrocode}
4787 \def\bbox#1{%
4788 \class@warn@end{\string\bbox\space is obsolete,^^Jload the bm package and use \string\bm\space instead.}%
4789 \global\let\bbox\relax
4790 }%
4791 % \end{macrocode}
4792 % \end{macro}
4793 %
4794 % \begin{macro}{\mathletters}
4795 %
4796 % \begin{macrocode}
4797 \newenvironment{mathletters}{%
4798 \class@warn@end{Environment {mathletters} is obsolete;^^Jload the amsmath package and use {subequations}!}%
4799 \global\let\mathletters\@empty
4800 }{%
4801 }%
4802 % \end{macrocode}
4803 % \end{macro}
4804 %
4805 % \begin{macro}{\eqnum}
4806 %
4807 % \begin{macrocode}
4808 \def\eqnum#1{%
4809 \class@warn@end{\string\eqnum\space is obsolete, load the amsmath package and use \string\tag!}%
4810 \global\let\eqnum\@gobble
4811 }%
4812 % \end{macrocode}
4813 % \end{macro}
4814 %
4815 % We read in the symbol definitions.
4816 % \begin{macrocode}
4817 \appdef\rtx@require@packages{%
4818 \RequirePackage{revsymb4-1}%
4819 }%
4820 \appdef\class@documenthook{\revsymb@inithook}%
4821 % \end{macrocode}
4822 %
4823 % \section{Patches for lineno.sty}
4824 %
4825 % The \classname{lineno} package detects the case where the package has been loaded
4826 % and the document invokes \cmd\linelabel, but the \cmd\linenumbers\ command has not been
4827 % issued: it treats this case as an error.
4828 %
4829 % It is wrong for validity of document syntax to be dependent upon package semantics:
4830 % we make the condition a warning rather than an error.
4831 %
4832 % \begin{macrocode}
4833 \def\@LN@LLerror@org{%
4834 \PackageError{lineno}{%
4835 \string\linelabel\space without \string\linenumbers
4836 }{%
4837 Just see documentation. (New feature v4.11)%
4838 }%
4839 \@gobble
4840 }%
4841 \def\@LN@LLerror@ltx{%
4842 \PackageWarning{lineno}{%
4843 To make the \string\linelabel\space command work, you must issue the \string\linenumbers\ command
4844 }%
4845 \@gobble
4846 }%
4847 % \end{macrocode}
4848 %
4849 % If appropriate, enable line numbering within the abstract.
4850 %
4851 % This mechanism applies generally:
4852 % Create the box in a context in which the meaning of \cmd\par\ has been patched by \classname{lineno},
4853 % then \cmd\unvbox\ the box in a context where \cmd\set@linepenalties\ has been executed, and
4854 % follow up with \cmd\@linenumberpar, which forces a visit to the output routine just there.
4855 % Note that here, we have to de-fang \cmd\@LN@parpgbrk, which would otherwise causes the appearance
4856 % of a box with depth -1000 points. Go figure.
4857 % \begin{macrocode}
4858 \appdef\class@documenthook{%
4859 \@ifx{\@LN@LLerror\@LN@LLerror@org}{%
4860 \class@info{Overriding \string\@LN@LLerror}%
4861 \let\@LN@LLerror\@LN@LLerror@ltx
4862 }{}%
4863 \@ifpackageloaded{lineno}{%
4864 \@ifxundefined{\set@linepenalties}{}{%
4865 \def\prep@absbox{\set@linepenalties}%
4866 \def\post@absbox{\let\@LN@parpgbrk\@empty\@linenumberpar}%
4867 }%
4868 }{}%
4869 }%
4870 % \end{macrocode}
4871 %
4872 % One may well ask: how to obtain line numbering within an alignment in a float?
4873 % This objective, along with line numbering within footnotes, would require extraordinary measures.
4874 % The float would have to be thrown onto the MVL in order to acquire its line numbers, but
4875 % that fragment of MVL would then have to be protected from being shipped out.
4876 % The question of how to coordinate those lines' numbers with those of lines in the MVL would
4877 % also require dealing with.
4878 %
4879 % \section{Endgame for the Document Class}
4880 %
4881 % We provide for a ``job macro package'' that can override
4882 % definitions and assignments made by the class or any other packages it loads.
4883 %
4884 % \subsection{Job Macro Package}
4885 % You can create a ``job macro package'' for your document
4886 % that will be read in automatically every time
4887 % your document is processed.
4888 % Thus, if your job is a file called \file{myarticle.tex},
4889 % then the file \file{myarticle.rty} will be read in
4890 % just the same as if you had placed a
4891 % \cmd\usepackage|{myarticle.rty}| statement
4892 % immediately following your \cmd\documentclass\ statement.
4893 %
4894 % Within your \file{.rty} file,
4895 % you can define and use control sequence names that use the |@| character
4896 % and you can override any of the definitions or assignments made
4897 % by the \revtex\ document class or the selected journal substyle.
4898 % That is, you have the power to really mess things up badly.
4899 %
4900 % If you choose to have a job macro package, you are well
4901 % advised to read the \LaTeX\ guide to document classes,
4902 % \file{clsguide.tex} or read up on the subject
4903 % in a book like the \LaTeX\ Companion.
4904 %
4905 % The file \file{template.rty} contains a template for
4906 % creating your own job macro package.
4907 %
4908 % \begin{macrocode}
4909 \appdef\rtx@require@packages{%
4910 \InputIfFileExists{\jobname.rty}{}{}%
4911 }%
4912 % \end{macrocode}
4913 %
4914 % \subsection{Endgame Processing for the Document Class}
4915 %
4916 % The remaining steps in processing the document class involve
4917 % determining the needed society, journal, and pointsize from
4918 % the document's class options and inputting the needed files or
4919 % executing the indicated procedures.
4920 %
4921 % Note that the society file is expected to declare options that will
4922 % allow us to determine the journal involved, and the society and journal
4923 % themselves determine the which pointsize options are declared, along with
4924 % their meanings.
4925 %
4926 % Note also that required packages are read in only after the document options
4927 % have been processed, because the latter can affect the former.
4928 %
4929 % Finally, the setup code is executed: this is code that depends on the
4930 % meanings of the switches we define and on the code within the packages we load.
4931 %
4932 % Note that there are other hooks in use: \cmd\document@inithook, which is
4933 % executed right at the beginning of the document, and \cmd\class@documenthook,
4934 % which serves as a vehicle for any \cmd\AtBeginDocument\ code we might wish to
4935 % execute.
4936 %
4937 %FIXME: use \cmd\class@documenthook\ only for things that bear on the MVL;
4938 % use \cmd\document@inithook\ for all patches to procedures defined within the preamble.
4939 %
4940 % Remember that \classname{natbib} changes its state at \cmd\AtBeginDocument\ time,
4941 % so we have to install our own code at a later point in the processing.
4942 %
4943 % We determine the proper \cmd\@society\ by examining the document's class options.
4944 % \begin{macrocode}
4945 \@parse@class@options@society
4946 % \end{macrocode}
4947 %
4948 % Then, we input the society's substyle
4949 % (which may in turn lead to loading a journal substyle or a pointsize substyle).
4950 % The substyle should not assume the value of any class option:
4951 % instead, it should install code into \cmd\setup@hook.
4952 % \begin{macrocode}
4953 \@process@society{aps}%
4954 % \end{macrocode}
4955 %
4956 % Now that the society has defined the class options relating to journals,
4957 % and has defined \cmd\@journal@default, we can process the journal substyle.
4958 % We parse the options for one that sets \cmd\@journal.
4959 % \begin{macrocode}
4960 \@parse@class@options@\@journal
4961 % \end{macrocode}
4962 % And we process the journal.
4963 % Note that \emph{it is an error} for a society file to fail to define
4964 % \cmd\@journal@default.
4965 %
4966 % \begin{macrocode}
4967 \expandafter\@process@journal\expandafter{\@journal@default}%
4968 % \end{macrocode}
4969 %
4970 % Now that the society and journal have finished defining any options relating to
4971 % point size, we process the class options for any that set \cmd\@pointsize.
4972 % \begin{macrocode}
4973 \@parse@class@options@\@pointsize
4974 % \end{macrocode}
4975 % And we process the pointsize.
4976 % Note that it is an error for the society and journal to leave \cmd\@pointsize@default\
4977 % undefined at this point, however, the journal may have overriden the assignment of the society.
4978 %
4979 % \begin{macrocode}
4980 \expandafter\@process@pointsize\expandafter{\@pointsize@default}%
4981 % \end{macrocode}
4982 %
4983 % Next, we process the class options for once and all.
4984 % Doing so sets values for some of the Booleans that were introduced along with
4985 % the \cmd\DeclareOption\ statements above.
4986 %
4987 %CHANGE: We process the options in the order declared in the document; this
4988 % gives the document greater control.
4989 %
4990 % \begin{macrocode}
4991 \@options
4992 % \end{macrocode}
4993 %
4994 % Now that the class options have been processed, we can load all the
4995 % packages that we know need loading.
4996 % \begin{macrocode}
4997 \rtx@require@packages
4998 % \end{macrocode}
4999 %
5000 % At this point, the society substyle, the journal substyle, and the
5001 % pointsize have all been processed, along with the document class options.
5002 % Some of these have left things for later; we do these now.
5003 %
5004 % \begin{macro}{\setup@hook}
5005 %
5006 % This portion of the code for this class file
5007 % \emph{must} appear at the very end:
5008 % The procedure
5009 % \cmd\setup@hook\
5010 % should be executed at the very end of the class file.
5011 % Any code that relies on the value of any of the \texttt{@sw} switches
5012 % or will patch the code of one of the required packages
5013 % should be executed here.
5014 %
5015 % \begin{macrocode}
5016 \setup@hook
5017 % \end{macrocode}
5018 % \end{macro}
5019 %
5020 %
5021 % Warn if past maturation date. This code to be enabled only in beta software.
5022 % \changes{4.1f}{2009/07/11}{(AO, 522) Warn if software is expired}%
5023 % \changes{4.1h}{2009/10/09}{(AO) Remove expiry code in the release software}%
5024 % \begin{macrocode}
5025 %<*ignore>
5026 \def\rtx@fin@year{2010}%
5027 \def\rtx@fin@month{01}%
5028 \def\rtx@fin@day{01}%
5029 \def\rtx@fin@warn{%
5030 \@ifnum{\rtx@fin@year>\the\year\relax}{\true@sw}{%
5031 \@ifnum{\rtx@fin@month>\the\month\relax}{\true@sw}{%
5032 \@ifnum{\rtx@fin@day>\the\day\relax}{\true@sw}{%
5033 \false@sw
5034 }%
5035 }%
5036 }%
5037 {%
5038 \class@info{Beta software expires \rtx@fin@year-\rtx@fin@month-\rtx@fin@day; updates available at http://publish.aps.org/revtex4/}%
5039 }{%
5040 \class@warn{Outdated software expired \rtx@fin@year-\rtx@fin@month-\rtx@fin@day; please retrieve an update at http://publish.aps.org/revtex4/}%
5041 }%
5042 }%
5043 %</ignore>
5044 % \end{macrocode}
5045 % In shipping (non-beta) software, the following line should be commented out.
5046 % \changes{4.1f}{2009/07/11}{(AO, 522) Warn if software is expired}%
5047 % \begin{verbatim}
5048 %\appdef\class@enddocumenthook{\rtx@fin@warn}%
5049 % \end{verbatim}
5050 %
5051 % End of the class file.
5052 % \begin{macrocode}
5053 %</package>
5054 % \end{macrocode}
5055 %
5056 %
5057 % \section{Symbols: the \texttt{revsymb} module}
5058 % We immediately define a utility command: this module's warning.
5059 % \begin{macrocode}
5060 %<*revsymb>
5061 \def\REVSYMB@warn#1{\PackageWarningNoLine{revsymb}{#1}}%
5062 % \end{macrocode}
5063 %
5064 % \begin{macro}{\lambdabar}
5065 % \begin{macrocode}
5066 \DeclareRobustCommand\lambdabar{%
5067 \bgroup
5068 \def\@tempa{%
5069 \hbox{%
5070 \raise.73\ht\z@
5071 \hb@xt@\z@{%
5072 \kern.25\wd\z@
5073 \vrule \@width.5\wd\z@\@height.1\p@\@depth.1\p@
5074 \hss
5075 }%
5076 \box\z@
5077 }%
5078 }%
5079 \mathchoice
5080 {\setbox\z@\hbox{$\displaystyle \lambda$}\@tempa}%
5081 {\setbox\z@\hbox{$\textstyle \lambda$}\@tempa}%
5082 {\setbox\z@\hbox{$\scriptstyle \lambda$}\@tempa}%
5083 {\setbox\z@\hbox{$\scriptscriptstyle\lambda$}\@tempa}%
5084 \egroup
5085 }%
5086 % \end{macrocode}
5087 % \end{macro}
5088 %
5089 % \begin{macro}{\openone}
5090 % DPC: Really should use a font that includes this glyph.
5091 % Unfortunately not in AMS ones, but is in bbold, cmbb.
5092 % (I think, must check),
5093 % \changes{4.0a}{1998/01/31}{use font-dependent spacing}
5094 % FIXME: check for bbold.
5095 % \begin{macrocode}
5096 \DeclareRobustCommand\openone{\leavevmode\hbox{\small1\normalsize\kern-.33em1}}%
5097 % \end{macrocode}
5098 % \end{macro}
5099 %
5100 % \begin{macro}{\corresponds}
5101 % \begin{macro}{\overdots}
5102 % \begin{macro}{\overcirc}
5103 % J\"org Knappen suggests the replacements:
5104 % replace \cmd\corresponds\ with \cmd\triangleq, source \classname{amssymb};
5105 % replace \cmd\overcirc\ with \cmd\mathring, source \classname{latex2e};
5106 % replace \cmd\overdots\ with \cmd\dddot, source \classname{amsmath}.
5107 %
5108 % Any use of any of these commands will result in a warning message at the end
5109 % of the log file. If the corresponding package is not loaded, a
5110 % definition will quietly be provided.
5111 % \begin{macrocode}
5112 \DeclareRobustCommand\corresponds{\replace@command\corresponds\triangleq}%
5113 \DeclareRobustCommand\overcirc{\replace@command\overcirc\mathring}%
5114 \DeclareRobustCommand\overdots{\replace@command\overdots\dddot}%
5115 \DeclareRobustCommand\REV@triangleq{%
5116 {\lower.2ex\hbox{=}}{\kern-.75em^\triangle}%
5117 }%
5118 \DeclareRobustCommand\REV@dddot[1]{%
5119 \@ontopof{#1}{\cdots}{1.0}\mathord{\box2}%
5120 }%
5121 % \end{macrocode}
5122 % \end{macro}
5123 % \end{macro}
5124 % \end{macro}
5125 %
5126 % \begin{macro}{\succsim}
5127 % \begin{macro}{\precsim}
5128 % \begin{macro}{\lesssim}
5129 % \begin{macro}{\gtrsim}
5130 % \begin{macro}{\alt}
5131 % \begin{macro}{\agt}
5132 % These version 3.1 commands are always supplied,
5133 % but the definitions in \classname{amssymb} are preferred.
5134 % \begin{macrocode}
5135 \DeclareRobustCommand\altsuccsim{\succ\kern-.9em_\sim\kern.3em}%
5136 \DeclareRobustCommand\altprecsim{\prec\kern-1em_\sim\kern.3em}%
5137 \let\REV@succsim\altsuccsim
5138 \let\REV@precsim\altprecsim
5139 \DeclareRobustCommand\REV@lesssim{\mathrel{\mathpalette\vereq{<}}}%
5140 \DeclareRobustCommand\REV@gtrsim{\mathrel{\mathpalette\vereq{>}}}%
5141 \DeclareRobustCommand\alt{\lesssim}
5142 \DeclareRobustCommand\agt{\gtrsim}
5143 \def\vereq#1#2{%
5144 \lower3\p@\vbox{%
5145 \baselineskip1.5\p@
5146 \lineskip1.5\p@
5147 \ialign{$\m@th#1\hfill##\hfil$\crcr#2\crcr\sim\crcr}%
5148 }%
5149 }%
5150 % \end{macrocode}
5151 % \end{macro}
5152 % \end{macro}
5153 % \end{macro}
5154 % \end{macro}
5155 % \end{macro}
5156 % \end{macro}
5157 %
5158 % \begin{macro}{\tensor}
5159 % \begin{macro}{\overstar}
5160 % \begin{macro}{\loarrow}
5161 % \begin{macro}{\roarrow}
5162 % \changes{4.0b}{1999/06/20}{AO: remove duplicates}
5163 % \begin{macrocode}
5164 \DeclareRobustCommand\tensor[1]{\@ontopof{#1}{\leftrightarrow}{1.15}\mathord{\box2}}
5165 \DeclareRobustCommand\overstar[1]{\@ontopof{#1}{\ast}{1.15}\mathord{\box2}}
5166 \DeclareRobustCommand\loarrow[1]{\@ontopof{#1}{\leftarrow}{1.15}\mathord{\box2}}
5167 \DeclareRobustCommand\roarrow[1]{\@ontopof{#1}{\rightarrow}{1.15}\mathord{\box2}}
5168 % \end{macrocode}
5169 % \end{macro}
5170 % \end{macro}
5171 % \end{macro}
5172 % \end{macro}
5173 %
5174 % \begin{macro}{\@ontopof}
5175 % \begin{macrocode}
5176 \def\@ontopof#1#2#3{%
5177 {%
5178 \mathchoice
5179 {\@@ontopof{#1}{#2}{#3}\displaystyle \scriptstyle }%
5180 {\@@ontopof{#1}{#2}{#3}\textstyle \scriptstyle }%
5181 {\@@ontopof{#1}{#2}{#3}\scriptstyle \scriptscriptstyle}%
5182 {\@@ontopof{#1}{#2}{#3}\scriptscriptstyle\scriptscriptstyle}%
5183 }%
5184 }%
5185 % \end{macrocode}
5186 % \end{macro}
5187 %
5188 % \begin{macro}{\@@ontopof}
5189 % Same as \revtex3, more or less.
5190 % \begin{macrocode}
5191 \def\@@ontopof#1#2#3#4#5{%
5192 \setbox\z@\hbox{$#4#1$}%
5193 \setbox\f@ur\hbox{$#5#2$}%
5194 \setbox\tw@\null\ht\tw@\ht\z@ \dp\tw@\dp\z@
5195 \@ifdim{\wd\z@>\wd\f@ur}{%
5196 \setbox\f@ur\hb@xt@\wd\z@{\hss\box\f@ur\hss}%
5197 \mathord{\rlap{\raise#3\ht\z@\box\f@ur}\box\z@}%
5198 }{%
5199 \setbox\f@ur\hb@[email protected]\wd\f@ur{\hss\box\f@ur\hss}%
5200 \setbox\z@\hb@xt@\wd\f@ur{\hss$#4\relax#1$\hss}%
5201 \mathord{\rlap{\copy\z@}\raise#3\ht\z@\box\f@ur}%
5202 }%
5203 }%
5204 % \end{macrocode}
5205 % \end{macro}
5206 %
5207 % \begin{macro}{\frak}
5208 % Deal with legacy \cmd\frak:
5209 % if \classname{amsfonts} not loaded, defined in such a way as to ask for that package.
5210 % Also, says to use \cmd\mathfrak\ instead.
5211 % \begin{macrocode}
5212 \DeclareRobustCommand\frak{%
5213 \REVSYMB@warn{%
5214 Command \string\frak\space unsupported:^^J%
5215 please use \string\mathfrak\space instead.%
5216 }%
5217 \global\let\frak\mathfrak
5218 \frak
5219 }%
5220 \DeclareRobustCommand\REV@mathfrak{%
5221 \REVSYMB@warn{%
5222 Command \string\mathfrak\space undefined:^^J%
5223 please specify the amsfonts or amssymb option!%
5224 }%
5225 \global\let\mathfrak\@firstofone
5226 \mathfrak
5227 }%
5228 % \end{macrocode}
5229 % \end{macro}
5230 %
5231 % \begin{macro}{\Bbb}
5232 % Deal with legacy \cmd\Bbb:
5233 % if \classname{amsfonts} not loaded, defined in such a way as to ask for that package.
5234 % Also, says to use \cmd\mathbb\ instead.
5235 % \begin{macrocode}
5236 \DeclareRobustCommand\Bbb{%
5237 \REVSYMB@warn{%
5238 Command \string\Bbb\space unsupported:^^J%
5239 please use \string\mathbb\space instead.%
5240 }%
5241 \global\let\Bbb\mathbb
5242 \Bbb
5243 }%
5244 \DeclareRobustCommand\REV@mathfrak{%
5245 \REVSYMB@warn{%
5246 Command \string\mathbb\space undefined:^^J%
5247 please specify the amsfonts or amssymb option!%
5248 }%
5249 \global\let\mathbb\@firstofone
5250 \mathbb
5251 }%
5252 % \end{macrocode}
5253 % \end{macro}
5254 %
5255 % \begin{macro}{\Bigglb}
5256 % Deal with legacy bold delimiters.
5257 % Each of the following takes an implicit argument consisting of
5258 % the delimiter to be made big and bold.
5259 % FIXME: \cmd\DeclareBoldMathCommand\ is not the right tool!
5260 % \begin{macrocode}
5261 \def\Bigglb{\REV@boldopen \Bigg}%
5262 \def\Biglb {\REV@boldopen \Big }%
5263 \def\bigglb{\REV@boldopen \bigg}%
5264 \def\biglb {\REV@boldopen \big }%
5265 \def\Biggrb{\REV@boldclose\Bigg}%
5266 \def\Bigrb {\REV@boldclose\Big }%
5267 \def\biggrb{\REV@boldclose\bigg}%
5268 \def\bigrb {\REV@boldclose\big }%
5269 \def\REV@pmb#1{%
5270 \hbox{%
5271 \setbox\z@=\hbox{#1}%
5272 \kern-.02em\copy\z@\kern-\wd\z@
5273 \kern .04em\copy\z@\kern-\wd\z@
5274 \kern-.02em
5275 \raise.04em\copy\z@
5276 }%
5277 }%
5278 \def\REV@boldopen #1#2{\mathopen {\REV@pmb{$#1#2$}}}%
5279 \def\REV@boldclose#1#2{\mathclose{\REV@pmb{$#1#2$}}}%
5280 % \end{macrocode}
5281 % \end{macro}
5282 %
5283 % \begin{macro}{\revsymb@inithook}
5284 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
5285 % Package dependencies are taken care of at \cmd\setup@hook\ time.
5286 % \begin{macrocode}
5287 \def\revsymb@inithook{%
5288 \@ifxundefined\dddot{\let\dddot\REV@dddot}{}%
5289 \@ifxundefined\triangleq{\let\triangleq\REV@triangleq}{}%
5290 \@ifxundefined\succsim{\let\succsim\altsuccsim}{}%
5291 \@ifxundefined\precsim{\let\precsim\altprecsim}{}%
5292 \@ifxundefined\lesssim{\let\lesssim\REV@lesssim}{}%
5293 \@ifxundefined\gtrsim {\let\gtrsim \REV@gtrsim }{}%
5294 \@ifxundefined\mathfrak{\let\mathfrak\REV@mathfrak}{}%
5295 \@ifxundefined\mathbb{\let\mathbb\REV@mathbb}{}%
5296 }%
5297 % \end{macrocode}
5298 % \end{macro}
5299 %
5300 % \begin{macrocode}
5301 %</revsymb>
5302 % \end{macrocode}
5303 %
5304 % \section{The \classoption{10pt} class option: the \texttt{10pt} module}
5305 % \changes{4.0b}{1999/06/20}{AO: all code for \protect\classoption{10pt} is in this module.}
5306 % The file \file{aps10pt.rtx} is read in by the \classname{revtex4} document class
5307 % if \cmd\@pointsize\ has the value 10.
5308 %
5309 % \begin{macrocode}
5310 %<*10pt>
5311 % \end{macrocode}
5312 %
5313 % \subsection{Defend Against Forseeable Errors}%
5314 % Protect this file from being read in by anything but \revtex.
5315 % \begin{macrocode}
5316 \ifx\undefined\substyle@ext
5317 \def\@tempa{%
5318 \endinput
5319 \GenericWarning{I must be read in by REVTeX! (Bailing out)}%
5320 }%
5321 \expandafter\else
5322 \def\@tempa{}%
5323 \expandafter\fi\@tempa
5324 \class@info{RevTeX pointsize 10pt selected}%
5325 % \end{macrocode}
5326 %
5327 % \begin{macrocode}
5328 \def\normalsize{%
5329 \@setfontsize\normalsize\@xpt{11.5}%
5330 \abovedisplayskip 10\p@ \@plus2\p@ \@minus5\p@
5331 \belowdisplayskip \abovedisplayskip
5332 \abovedisplayshortskip \abovedisplayskip
5333 \belowdisplayshortskip \abovedisplayskip
5334 \let\@listi\@listI
5335 }%
5336 % \end{macrocode}
5337 %
5338 % \begin{macrocode}
5339 \def\small{%
5340 \@setfontsize\small\@ixpt{10.5}%
5341 \abovedisplayskip 8.5\p@ \@plus3\p@ \@minus4\p@
5342 \belowdisplayskip \abovedisplayskip
5343 \abovedisplayshortskip \z@ \@plus2\p@
5344 \belowdisplayshortskip 4\p@ \@plus2\p@ \@minus2\p@
5345 \def\@listi{%
5346 \leftmargin\leftmargini
5347 \topsep 4\p@ \@plus2\p@ \@minus2\p@
5348 \parsep 2\p@ \@plus\p@ \@minus\p@
5349 \itemsep \parsep
5350 }%
5351 }%
5352 % \end{macrocode}
5353 %
5354 % \begin{macrocode}
5355 \def\footnotesize{%
5356 \@setfontsize\footnotesize\@viiipt{9.5pt}%
5357 \abovedisplayskip 6\p@ \@plus2\p@ \@minus4\p@
5358 \belowdisplayskip \abovedisplayskip
5359 \abovedisplayshortskip \z@ \@plus\p@
5360 \belowdisplayshortskip 3\p@ \@plus\p@ \@minus2\p@
5361 \def\@listi{%
5362 \leftmargin\leftmargini
5363 \topsep 3\p@ \@plus\p@ \@minus\p@
5364 \parsep 2\p@ \@plus\p@ \@minus\p@
5365 \itemsep \parsep
5366 }%
5367 }%
5368 % \end{macrocode}
5369 %
5370 % \begin{macrocode}
5371 \def\scriptsize{%
5372 \@setfontsize\scriptsize\@viipt\@viiipt
5373 }%
5374 \def\tiny{%
5375 \@setfontsize\tiny\@vpt\@vipt
5376 }%
5377 \def\large{%
5378 \@setfontsize\large\@xiipt{14pt}%
5379 }%
5380 \def\Large{%
5381 \@setfontsize\Large\@xivpt{18pt}%
5382 }%
5383 \def\LARGE{%
5384 \@setfontsize\LARGE\@xviipt{22pt}%
5385 }%
5386 \def\huge{%
5387 \@setfontsize\huge\@xxpt{25pt}%
5388 }%
5389 \def\Huge{%
5390 \@setfontsize\Huge\@xxvpt{30pt}%
5391 }%
5392 % \end{macrocode}
5393 %
5394 % The values of these margin parameters are dependent upon
5395 % \cmd\twoside@sw; any society or journal that
5396 % has its own preferences should override these assignments
5397 % by doing \cmd\appdef\cmd\setup@hook.
5398 % \begin{macrocode}
5399 \appdef\setup@hook{%
5400 \twoside@sw{%
5401 % \oddsidemargin -.1in
5402 % \evensidemargin -.4in
5403 \oddsidemargin -20pt
5404 \evensidemargin -20pt
5405 \marginparwidth 107pt
5406 }{%
5407 \oddsidemargin -.25in
5408 \evensidemargin -.25in
5409 \marginparwidth 30pt
5410 }%
5411 }%
5412 % \end{macrocode}
5413 %
5414 % \begin{macrocode}
5415 \marginparsep 6pt
5416 % \end{macrocode}
5417 %
5418 % \begin{macrocode}
5419 \topmargin -61pt
5420 % \end{macrocode}
5421 %
5422 % \begin{macrocode}
5423 \headheight 25pt
5424 \headsep 16pt
5425 % \end{macrocode}
5426 %
5427 % \changes{4.1n}{2010/01/02}{(AO, 571) class file must set \cs{splittopskip}; fine tune \cs{skip}\cs{footins}; \cs{footnoterule} defined in terms of \cs{skip}\cs{footins}}%
5428 % \begin{macrocode}
5429 \topskip 10pt
5430 \splittopskip\topskip
5431 % \end{macrocode}
5432 %
5433 % \begin{macrocode}
5434 \footskip 30pt
5435 % \end{macrocode}
5436 %
5437 % \begin{macrocode}
5438 \textheight = 56pc
5439 % \end{macrocode}
5440 %
5441 % \begin{macrocode}
5442 \textwidth42.5pc
5443 % \end{macrocode}
5444 %
5445 % \begin{macrocode}
5446 \columnsep 1.5pc
5447 \columnseprule 0pt
5448 % \end{macrocode}
5449 %
5450 % \changes{4.1n}{2010/01/02}{(AO, 571) class file must set \cs{splittopskip}; fine tune \cs{skip}\cs{footins}; \cs{footnoterule} defined in terms of \cs{skip}\cs{footins}}%
5451 % \begin{macrocode}
5452 \footnotesep 1pt
5453 \skip\footins 39pt plus 4pt minus 12pt
5454 \def\footnoterule{%
5455 \dimen@\skip\footins\divide\dimen@\tw@
5456 \kern-\dimen@\hrule width.5in\kern\dimen@
5457 }%
5458 % \end{macrocode}
5459 %
5460 % \begin{macrocode}
5461 \floatsep 12pt plus 2pt minus 2pt
5462 \textfloatsep 20pt plus 2pt minus 4pt
5463 \intextsep 12pt plus 2pt minus 2pt
5464 % \end{macrocode}
5465 %
5466 % \begin{macrocode}
5467 \dblfloatsep 12pt plus 2pt minus 2pt
5468 \dbltextfloatsep 20pt plus 2pt minus 4pt
5469 % \end{macrocode}
5470 %
5471 % \begin{macrocode}
5472 \@fptop 0pt plus 1fil
5473 \@fpsep 8pt plus 2fil
5474 \@fpbot 0pt plus 1fil
5475 \@dblfptop 0pt plus 1fil
5476 \@dblfpsep 8pt plus 2fil
5477 \@dblfpbot 0pt plus 1fil
5478 % \end{macrocode}
5479 %
5480 % \begin{macrocode}
5481 \marginparpush 5pt
5482 % \end{macrocode}
5483 %
5484 % \begin{macrocode}
5485 \parskip 0pt plus 1pt
5486 \parindent 10pt
5487 \emergencystretch8\p@
5488 % \end{macrocode}
5489 %
5490 % \begin{macrocode}
5491 \partopsep 2pt plus 1pt minus 1pt
5492 % \end{macrocode}
5493 %
5494 % \begin{macrocode}
5495 \leftmargini 25pt
5496 \leftmarginii 22pt
5497 \leftmarginiii 18.7pt
5498 \leftmarginiv 17pt
5499 \leftmarginv 10pt
5500 \leftmarginvi 10pt
5501 % \end{macrocode}
5502 %
5503 % \begin{macrocode}
5504 \def\@listI{%
5505 \leftmargin\leftmargini
5506 \parsep 4\p@ plus2\p@ minus\p@
5507 \topsep 8\p@ plus2\p@ minus4\p@
5508 \itemsep 4\p@ plus2\p@ minus\p@
5509 }%
5510 % \end{macrocode}
5511 %
5512 % \begin{macrocode}
5513 \labelsep 4pt
5514 % \end{macrocode}
5515 %
5516 % \begin{macrocode}
5517 \def\@listii{%
5518 \leftmargin\leftmarginii
5519 \labelwidth\leftmarginii
5520 \advance\labelwidth-\labelsep
5521 \topsep 4\p@ plus2\p@ minus\p@
5522 \parsep 2\p@ plus\p@ minus\p@
5523 \itemsep \parsep
5524 }%
5525 % \end{macrocode}
5526 %
5527 % \begin{macrocode}
5528 \def\@listiii{%
5529 \leftmargin\leftmarginiii
5530 \labelwidth\leftmarginiii
5531 \advance\labelwidth-\labelsep
5532 \topsep 2\p@ plus\p@ minus\p@
5533 \parsep \z@
5534 \partopsep \p@ plus\z@ minus\p@
5535 \itemsep \topsep
5536 }%
5537 % \end{macrocode}
5538 %
5539 % \begin{macrocode}
5540 \def\@listiv{%
5541 \leftmargin\leftmarginiv
5542 \labelwidth\leftmarginiv
5543 \advance\labelwidth-\labelsep
5544 }%
5545 % \end{macrocode}
5546 %
5547 % \begin{macrocode}
5548 \def\@listv{%
5549 \leftmargin\leftmarginv
5550 \labelwidth\leftmarginv
5551 \advance\labelwidth-\labelsep
5552 }%
5553 % \end{macrocode}
5554 %
5555 % \begin{macrocode}
5556 \def\@listvi{%
5557 \leftmargin\leftmarginvi
5558 \labelwidth\leftmarginvi
5559 \advance\labelwidth-\labelsep
5560 }%
5561 % \end{macrocode}
5562 %
5563 % \begin{macrocode}
5564 %</10pt>
5565 % \end{macrocode}
5566 %
5567 % \section{The \classoption{11pt} class option: the \texttt{11pt} module}
5568 % \changes{4.0b}{1999/06/20}{AO: all code for \protect\classoption{11pt} is in this module.}
5569 % The file \file{11pt.rtx} is read in by the \classname{revtex4} document class
5570 % if \cmd\@pointsize\ has the value 11.
5571 %
5572 % \begin{macrocode}
5573 %<*11pt>
5574 % \end{macrocode}
5575 %
5576 % \subsection{Defend Against Forseeable Errors}%
5577 % Protect this file from being read in by anything but \revtex.
5578 % \begin{macrocode}
5579 \ifx\undefined\substyle@ext
5580 \def\@tempa{%
5581 \endinput
5582 \GenericWarning{I must be read in by REVTeX! (Bailing out)}%
5583 }%
5584 \expandafter\else
5585 \def\@tempa{}%
5586 \expandafter\fi\@tempa
5587 \class@info{RevTeX pointsize 11pt selected}%
5588 % \end{macrocode}
5589 %
5590 % \begin{macrocode}
5591 \def\normalsize{%
5592 \@setfontsize\normalsize\@xipt{13.6}%
5593 \abovedisplayskip 11\p@ \@plus3\p@ \@minus6\p@
5594 \belowdisplayskip \abovedisplayskip
5595 \abovedisplayshortskip \abovedisplayskip
5596 \belowdisplayshortskip \abovedisplayskip
5597 \let\@listi\@listI
5598 }%
5599 % \end{macrocode}
5600 %
5601 % \begin{macrocode}
5602 \def\small{%
5603 \@setfontsize\small\@xpt\@xiipt
5604 \abovedisplayskip 10\p@ \@plus2\p@ \@minus5\p@
5605 \abovedisplayshortskip \z@ \@plus3\p@
5606 \belowdisplayshortskip 6\p@ \@plus3\p@ \@minus3\p@
5607 \def\@listi{\leftmargin\leftmargini
5608 \topsep 6\p@ \@plus2\p@ \@minus2\p@
5609 \parsep 3\p@ \@plus2\p@ \@minus\p@
5610 \itemsep \parsep
5611 }%
5612 \belowdisplayskip \abovedisplayskip
5613 }%
5614 % \end{macrocode}
5615 %
5616 % \begin{macrocode}
5617 \def\footnotesize{%
5618 \@setfontsize\footnotesize\@ixpt{11}%
5619 \abovedisplayskip 8\p@ \@plus2\p@ \@minus4\p@
5620 \abovedisplayshortskip \z@ \@plus\p@
5621 \belowdisplayshortskip 4\p@ \@plus2\p@ \@minus2\p@
5622 \def\@listi{\leftmargin\leftmargini
5623 \topsep 4\p@ \@plus2\p@ \@minus2\p@
5624 \parsep 2\p@ \@plus\p@ \@minus\p@
5625 \itemsep \parsep
5626 }%
5627 \belowdisplayskip \abovedisplayskip
5628 }%
5629 % \end{macrocode}
5630 %
5631 % \begin{macrocode}
5632 \def\scriptsize{%
5633 \@setfontsize\scriptsize\@viiipt{9.5}%
5634 }%
5635 \def\tiny{%
5636 \@setfontsize\tiny\@vipt\@viipt
5637 }%
5638 \def\large{%
5639 \@setfontsize\large\@xiipt{14}%
5640 }%
5641 \def\Large{%
5642 \@setfontsize\Large\@xivpt{18}%
5643 }%
5644 \def\LARGE{%
5645 \@setfontsize\LARGE\@xviipt{22}%
5646 }%
5647 \def\huge{%
5648 \@setfontsize\huge\@xxpt{25pt}%
5649 }%
5650 \def\Huge{%
5651 \@setfontsize\Huge\@xxvpt{30pt}%
5652 }%
5653 % \end{macrocode}
5654 %
5655 % \begin{macrocode}
5656 %</11pt>
5657 % \end{macrocode}
5658 %
5659 % \section{The \classoption{12pt} class option: the \texttt{12pt} module}
5660 % \changes{4.0b}{1999/06/20}{AO: all code for \protect\classoption{12pt} is in this module.}
5661 % The file \file{12pt.rtx} is read in by the \classname{revtex4} document class
5662 % if \cmd\@pointsize\ has the value 12.
5663 %
5664 % \begin{macrocode}
5665 %<*12pt>
5666 % \end{macrocode}
5667 %
5668 % \subsection{Defend Against Forseeable Errors}%
5669 % Protect this file from being read in by anything but \revtex.
5670 % \begin{macrocode}
5671 \ifx\undefined\substyle@ext
5672 \def\@tempa{%
5673 \endinput
5674 \GenericWarning{I must be read in by REVTeX! (Bailing out)}%
5675 }%
5676 \expandafter\else
5677 \def\@tempa{}%
5678 \expandafter\fi\@tempa
5679 \class@info{RevTeX pointsize 12pt selected}%
5680 % \end{macrocode}
5681 %
5682 % \begin{macrocode}
5683 \def\normalsize{%
5684 \@setfontsize\normalsize\@xiipt{14pt}%
5685 \abovedisplayskip 12\p@ \@plus3\p@ \@minus7\p@
5686 \belowdisplayskip \abovedisplayskip
5687 \abovedisplayshortskip \z@ plus3\p@
5688 \belowdisplayshortskip 6.5\p@ \@plus3.5\p@ \@minus3\p@
5689 \let\@listi\@listI
5690 }%
5691 % \end{macrocode}
5692 %
5693 % \begin{macrocode}
5694 \def\small{%
5695 \@setfontsize\small\@xipt{14.5pt}%
5696 \abovedisplayskip 8\p@ \@plus3\p@ \@minus6\p@
5697 \belowdisplayskip \abovedisplayskip
5698 \abovedisplayshortskip \z@ \@plus3\p@
5699 \belowdisplayshortskip 6.5\p@ \@plus3.5\p@ \@minus3\p@
5700 \def\@listi{%
5701 \leftmargin\leftmargini
5702 \topsep 9\p@ \@plus3\p@ \@minus5\p@
5703 \parsep 4.5\p@ \@plus2\p@ \@minus\p@
5704 \itemsep \parsep
5705 }%
5706 }%
5707 % \end{macrocode}
5708 %
5709 % Same baselineskip as \cmd\small\ ?
5710 % \begin{macrocode}
5711 \def\footnotesize{%
5712 \@setfontsize\footnotesize\@xpt{14.5pt}%
5713 \abovedisplayskip 10\p@ \@plus2\p@ \@minus5\p@
5714 \belowdisplayskip \abovedisplayskip
5715 \abovedisplayshortskip \z@ \@plus3\p@
5716 \belowdisplayshortskip 6\p@ \@plus3\p@ \@minus3\p@
5717 \def\@listi{%
5718 \leftmargin\leftmargini
5719 \topsep 6\p@ \@plus2\p@ \@minus2\p@
5720 \parsep 3\p@ \@plus2\p@ \@minus\p@
5721 \itemsep \parsep
5722 }%
5723 }%
5724 % \end{macrocode}
5725 %
5726 % \begin{macrocode}
5727 \def\scriptsize{%
5728 \@setfontsize\scriptsize\@viiipt{9.5pt}%
5729 }%
5730 \def\tiny{%
5731 \@setfontsize\tiny\@vipt{7pt}%
5732 }%
5733 \def\large{%
5734 \@setfontsize\large\@xivpt{18pt}%
5735 }%
5736 \def\Large{%
5737 \@setfontsize\Large\@xviipt{22pt}%
5738 }%
5739 \def\LARGE{%
5740 \@setfontsize\LARGE\@xxpt{25pt}%
5741 }%
5742 \def\huge{%
5743 \@setfontsize\huge\@xxvpt{30pt}%
5744 }%
5745 \let\Huge=\huge
5746 % \end{macrocode}
5747 %
5748 % \begin{macrocode}
5749 %</12pt>
5750 % \end{macrocode}
5751 %
5752 % \section{Page parameters}%
5753 % This code is common to both \classoption{11pt} and \classoption{12pt}.
5754 %
5755 % \begin{macrocode}
5756 %<*11pt|12pt>
5757 % \end{macrocode}
5758 %
5759 % \begin{macrocode}
5760 \appdef\setup@hook{%
5761 \twoside@sw{%
5762 \oddsidemargin 0pt
5763 \evensidemargin 0pt
5764 \marginparwidth 60pt
5765 }{%
5766 \oddsidemargin 0pt
5767 \evensidemargin 0pt
5768 \marginparwidth 44pt
5769 }%
5770 }%
5771 % \end{macrocode}
5772 %
5773 % \begin{macrocode}
5774 \marginparsep 10pt
5775 % \end{macrocode}
5776 %
5777 % \begin{macrocode}
5778 \topmargin -37pt
5779 % \end{macrocode}
5780 %
5781 % \begin{macrocode}
5782 \headheight 12pt
5783 \headsep 25pt
5784 % \end{macrocode}
5785 %
5786 % \changes{4.1n}{2010/01/02}{(AO, 571) class file must set \cs{splittopskip}; fine tune \cs{skip}\cs{footins}; \cs{footnoterule} defined in terms of \cs{skip}\cs{footins}}%
5787 % \begin{macrocode}
5788 \topskip 10pt
5789 \splittopskip\topskip
5790 % \end{macrocode}
5791 %
5792 % \begin{macrocode}
5793 \footskip 30pt
5794 % \end{macrocode}
5795 %
5796 % \begin{macrocode}
5797 \textheight=665.5\p@
5798 % \end{macrocode}
5799 %
5800 % \begin{macrocode}
5801 \appdef\setup@hook{%
5802 \tightenlines@sw{%
5803 \def\baselinestretch{1}%
5804 }{%
5805 \def\baselinestretch{1.5}%
5806 }%
5807 }%
5808 % \end{macrocode}
5809 %
5810 % \begin{macrocode}
5811 \textwidth 468pt
5812 % \end{macrocode}
5813 %
5814 % \begin{macrocode}
5815 \columnsep 10pt
5816 \columnseprule 0pt
5817 % \end{macrocode}
5818 %
5819 % \changes{4.1n}{2010/01/02}{(AO, 571) class file must set \cs{splittopskip}; fine tune \cs{skip}\cs{footins}; \cs{footnoterule} defined in terms of \cs{skip}\cs{footins}}%
5820 % \begin{macrocode}
5821 \footnotesep 1pt
5822 \skip\footins 25.25pt plus 4pt minus 12pt
5823 \def\footnoterule{%
5824 \dimen@\skip\footins\divide\dimen@\f@ur
5825 \kern-\dimen@\hrule width.5in\kern\dimen@
5826 }%
5827 % \end{macrocode}
5828 %
5829 % \begin{macrocode}
5830 \floatsep 14pt plus 2pt minus 4pt
5831 \textfloatsep 20pt plus 2pt minus 4pt
5832 \intextsep 14pt plus 4pt minus 4pt
5833 % \end{macrocode}
5834 %
5835 % \begin{macrocode}
5836 \dblfloatsep 14pt plus 2pt minus 4pt
5837 \dbltextfloatsep 20pt plus 2pt minus 4pt
5838 % \end{macrocode}
5839 %
5840 % \begin{macrocode}
5841 \@fptop 0pt plus 1fil
5842 \@fpsep 10pt plus 2fil
5843 \@fpbot 0pt plus 1fil
5844 \@dblfptop 0pt plus 1fil
5845 \@dblfpsep 10pt plus 2fil%
5846 \@dblfpbot 0pt plus 1fil
5847 % \end{macrocode}
5848 %
5849 % \begin{macrocode}
5850 \marginparpush 7pt
5851 % \end{macrocode}
5852 %
5853 % \begin{macrocode}
5854 \parskip 0pt plus 1pt
5855 \parindent 15pt
5856 \emergencystretch8\p@
5857 \partopsep 3pt plus 2pt minus 2pt
5858 % \end{macrocode}
5859 %
5860 % \begin{macrocode}
5861 \leftmargini 30pt
5862 \leftmarginii 26pt
5863 \leftmarginiii 22pt
5864 \leftmarginiv 20pt
5865 \leftmarginv 12pt
5866 \leftmarginvi 12pt
5867 % \end{macrocode}
5868 %
5869 % \begin{macrocode}
5870 \def\@listI{\leftmargin\leftmargini \parsep 5\p@ plus2.5\p@ minus\p@
5871 \topsep 10\p@ plus4\p@ minus6\p@
5872 \itemsep 5\p@ plus2.5\p@ minus\p@
5873 }%
5874 % \end{macrocode}
5875 %
5876 % \begin{macrocode}
5877 \labelsep 6pt
5878 % \end{macrocode}
5879 %
5880 % \begin{macrocode}
5881 \def\@listii{\leftmargin\leftmarginii
5882 \labelwidth\leftmarginii\advance\labelwidth-\labelsep
5883 \topsep 5\p@ plus2.5\p@ minus\p@
5884 \parsep 2.5\p@ plus\p@ minus\p@
5885 \itemsep \parsep
5886 }%
5887 % \end{macrocode}
5888 %
5889 % \begin{macrocode}
5890 \def\@listiii{\leftmargin\leftmarginiii
5891 \labelwidth\leftmarginiii\advance\labelwidth-\labelsep
5892 \topsep 2.5\p@ plus\p@ minus\p@
5893 \parsep \z@ \partopsep \p@ plus\z@ minus\p@
5894 \itemsep \topsep
5895 }%
5896 % \end{macrocode}
5897 %
5898 % \begin{macrocode}
5899 \def\@listiv{\leftmargin\leftmarginiv
5900 \labelwidth\leftmarginiv\advance\labelwidth-\labelsep
5901 }%
5902 % \end{macrocode}
5903 %
5904 % \begin{macrocode}
5905 \def\@listv{\leftmargin\leftmarginv
5906 \labelwidth\leftmarginv\advance\labelwidth-\labelsep
5907 }%
5908 % \end{macrocode}
5909 %
5910 % \begin{macrocode}
5911 \def\@listvi{\leftmargin\leftmarginvi
5912 \labelwidth\leftmarginvi\advance\labelwidth-\labelsep
5913 }%
5914 % \end{macrocode}
5915 %
5916 % \begin{macrocode}
5917 %</11pt|12pt>
5918 % \end{macrocode}
5919 %
5920 % \section{The \classoption{aps} class extension: the \texttt{aps} module}
5921 % \changes{4.0b}{1999/06/20}{AO: made aps.rtx part of revtex4.dtx}
5922 % The file \file{aps.rtx} is read in by the \classname{revtex4} document class
5923 % if \cmd\@society\ has the value \classoption{aps}.
5924 %
5925 % Here, code specific to APS journals is separated out from the \revtex\ document class.
5926 % (Other societies can customize \revtex\ by supplying their own \file{.rtx} file.)
5927 %
5928 % This class extension file is a model for a class extension you might write yourself.
5929 %
5930 % First, incorporate a \cmd\ProvidesFile\ command with an optional argument giving
5931 % the version information, e.g.,
5932 % \begin{verbatim}
5933 % \ProvidesFile{foo}[2001/09/11 v1.1 Docinfo]%
5934 % \end{verbatim}
5935 %
5936 % Within the society substyle, there are two things we must do as well:
5937 % define the default journal,
5938 % \begin{verbatim}
5939 % \def\@journal@default{pra}%
5940 % \end{verbatim}
5941 % And do likewise for the point size:
5942 % \begin{verbatim}
5943 % \def\@pointsize@default{10}%
5944 % \end{verbatim}
5945 %
5946 % We first define some text entities (amounting to journal abbreviations),
5947 % then some APS-specific initialisations,
5948 % then code for particular APS journals.
5949 % In the latter case, the choice is
5950 % keyed off the macro \cmd\@journal.
5951 %
5952 % \begin{macrocode}
5953 %<*aps>
5954 % \end{macrocode}
5955 %
5956 % \subsection{Defend Against Forseeable Errors}%
5957 % Protect this file from being read in by anything but \revtex.
5958 % \begin{macrocode}
5959 \ifx\undefined\substyle@ext
5960 \def\@tempa{%
5961 \endinput
5962 \GenericWarning{I must be read in by REVTeX! (Bailing out)}%
5963 }%
5964 \expandafter\else
5965 \def\@tempa{}%
5966 \expandafter\fi\@tempa
5967 \class@info{RevTeX society APS selected}%
5968 % \end{macrocode}
5969 %
5970 % Here are the class options relating to the APS:
5971 % \begin{macrocode}
5972 \DeclareOption{pra}{\change@journal{pra}}%
5973 \DeclareOption{prb}{\change@journal{prb}}%
5974 \DeclareOption{prc}{\change@journal{prc}}%
5975 \DeclareOption{prd}{\change@journal{prd}}%
5976 \DeclareOption{pre}{\change@journal{pre}}%
5977 \DeclareOption{prl}{\change@journal{prl}}%
5978 \DeclareOption{prstab}{\change@journal{prstab}}%
5979 \DeclareOption{prstper}{\change@journal{prstper}}%
5980 \DeclareOption{rmp}{\change@journal{rmp}}%
5981 % \end{macrocode}
5982 %
5983 % \subsection{Abbreviations}%
5984 % \changes{4.1p}{2010/02/24}{(AO, 584) Per MD, remove trailing space character from each journal abbreviation: it had caused an extraneous space in the .bbl}
5985 % The following macros constitute typing shortcuts for
5986 % certain journal names.
5987 % \begin{macrocode}
5988 \def\ao{Appl.\ Opt.}%
5989 \def\ap{Appl.\ Phys.}%
5990 \def\apl{Appl.\ Phys.\ Lett.}%
5991 \def\apj{Astrophys.\ J.}%
5992 \def\bell{Bell Syst.\ Tech.\ J.}%
5993 \def\jqe{IEEE J.\ Quantum Electron.}%
5994 \def\assp{IEEE Trans.\ Acoust.\ Speech Signal Process.}%
5995 \def\aprop{IEEE Trans.\ Antennas Propag.}%
5996 \def\mtt{IEEE Trans.\ Microwave Theory Tech.}%
5997 \def\iovs{Invest.\ Ophthalmol.\ Vis.\ Sci.}%
5998 \def\jcp{J.\ Chem.\ Phys.}%
5999 \def\jmo{J.\ Mod.\ Opt.}%
6000 \def\josa{J.\ Opt.\ Soc.\ Am.}%
6001 \def\josaa{J.\ Opt.\ Soc.\ Am.\ A}%
6002 \def\josab{J.\ Opt.\ Soc.\ Am.\ B}%
6003 \def\jpp{J.\ Phys.\ (Paris)}%
6004 \def\nat{Nature (London)}%
6005 \def\oc{Opt.\ Commun.}%
6006 \def\ol{Opt.\ Lett.}%
6007 \def\pl{Phys.\ Lett.}%
6008 \def\pra{Phys.\ Rev.\ A}%
6009 \def\prb{Phys.\ Rev.\ B}%
6010 \def\prc{Phys.\ Rev.\ C}%
6011 \def\prd{Phys.\ Rev.\ D}%
6012 \def\pre{Phys.\ Rev.\ E}%
6013 \def\prl{Phys.\ Rev.\ Lett.}%
6014 \def\rmp{Rev.\ Mod.\ Phys.}%
6015 \def\pspie{Proc.\ Soc.\ Photo-Opt.\ Instrum.\ Eng.}%
6016 \def\sjqe{Sov.\ J.\ Quantum Electron.}%
6017 \def\vr{Vision Res.}%
6018 % \end{macrocode}
6019 %
6020 % \subsection{APS Setup}%
6021 % Here we define the default procedures for APS journals.
6022 % Individual APS journals may override these definitions.
6023 %
6024 % \subsubsection{Title block}%
6025 %
6026 % The specifics of the title block.
6027 % Apply to all APS journals; individual journals may override these settings.
6028 %
6029 % \begin{macro}{\@fnsymbol}
6030 % The \LaTeX\ kernel definition of \cmd\@fnsymbol\ is overridden.
6031 % The definition in \filename{fixltx2e.sty} serves as a guide to the new way to symbol,
6032 % working in both text- and math modes.
6033 %
6034 % \filename{fixltx2e.sty} duplicates some features of \filename{ltxgrid} and \filename{ltxutil},
6035 % however, so it may be incompatible with \revtex.
6036 % In case it is not loaded, we must provide a meaning for \cmd\TextOrMath,
6037 % which that package makes robust.
6038 % I believe that it is \cmd\@fnsymbol\ itself that ought to be robustified.
6039 % e\TeX\ further complicates matters; we do not especially accomodate it.
6040 %
6041 % \changes{4.1d}{2009/03/27}{Definition of \cs{ @fnsymbol} follows fixltx2e.sty}
6042 %
6043 % Not! \cmd\TextOrMath\ must be made robust in any case (Bug 530). I return things to follow
6044 % core \LaTeXe\ (\filename{latex.ltx}).
6045 % \changes{4.1f}{2009/10/05}{(AO, 530) \cs{@fnsymbol}: Failed to import fixltx2e.sty technology. Return to LaTeX core.}
6046 % \begin{macrocode}
6047 \def\@fnsymbol#1{%
6048 \ensuremath{%
6049 \ifcase#1\or
6050 *\or
6051 \dagger\or
6052 \ddagger\or
6053 \mathsection\or
6054 \mathparagraph\or
6055 % \|\or
6056 **\or
6057 \dagger\dagger\or
6058 \ddagger\ddagger\else
6059 \mathsection\mathsection\or
6060 \mathparagraph\mathparagraph\or
6061 ***\or
6062 \dagger\dagger\dagger\or
6063 \ddagger\ddagger\ddagger\else
6064 \mathsection\mathsection\mathsection\or
6065 \mathparagraph\mathparagraph\mathparagraph\or
6066 %
6067 \@ctrerr
6068 \fi
6069 }%
6070 }%
6071 \appdef\document@inithook{%
6072 \@ifxundefined\TextOrMath{%
6073 \DeclareRobustCommand\TextOrMath{\@ifmmode{\false@sw}{\true@sw}}%
6074 }{}%
6075 }%
6076 \let\thefootnote@latex\thefootnote
6077 % \end{macrocode}
6078 % \end{macro}
6079 %
6080 % We assign the default titlepage style for APS; a journal or document instance
6081 % may override by invoking one of the other \cmd\clo@... procedures defined in \revtex.
6082 % \begin{macrocode}
6083 \clo@groupedaddress
6084 % \end{macrocode}
6085 %
6086 % \begin{macro}{\titlepage}
6087 % \begin{macrocode}
6088 \renewenvironment{titlepage}{%
6089 \let\wastwocol@sw\twocolumn@sw
6090 \onecolumngrid
6091 \newpage
6092 \thispagestyle{titlepage}%
6093 \c@page\z@
6094 % \end{macrocode}
6095 % A comment: ``article.cls sets this to one not zero?''
6096 % \begin{macrocode}
6097 }{%
6098 \wastwocol@sw{\twocolumngrid}{\newpage}%
6099 }%
6100 % \end{macrocode}
6101 % \end{macro}
6102 %
6103 % \begin{macro}{\frontmatter@abstractheading}
6104 % APS Journals all set the abstract head the same way, with no head.
6105 % However, if the user has specified the \classoption{preprint} class option,
6106 % then the abstract will have a head.
6107 % \begin{macrocode}
6108 \def\frontmatter@abstractheading{%
6109 \preprintsty@sw{%
6110 \begingroup
6111 \centering\large
6112 \abstractname
6113 \par
6114 \endgroup
6115 }{}%
6116 }%
6117 % \end{macrocode}
6118 % \end{macro}
6119 %
6120 % \begin{macro}{\frontmatter@abstractwidth}
6121 % All APS journals set the abstract to the same width.
6122 % \begin{macrocode}
6123 \def\frontmatter@abstractwidth{400\p@}%
6124 % \end{macrocode}
6125 % \end{macro}
6126 %
6127 % \begin{macro}{\frontmatter@abstractfont}
6128 % All APS journals set the abstract body the same way.
6129 % \changes{4.0c}{1999/11/13}{(AO, 123) add parskip to the abstract.}
6130 % \changes{4.1e}{2008/06/29}{(AO, 455) be nice to a list within the abstract}
6131 % \begin{macrocode}
6132 \def\frontmatter@abstractfont{%
6133 \small
6134 \parindent1em\relax
6135 \adjust@abstractwidth
6136 }%
6137 \def\adjust@abstractwidth{%
6138 \dimen@\textwidth\advance\dimen@-\frontmatter@abstractwidth
6139 \divide\dimen@\tw@
6140 \galley@sw{%
6141 \advance\rightskip\tw@\dimen@
6142 }{%
6143 \advance\leftskip\dimen@
6144 \advance\rightskip\dimen@
6145 }%
6146 \@totalleftmargin\leftskip
6147 }%
6148 % \end{macrocode}
6149 % \end{macro}
6150 %
6151 % All APS journal preprints use separate titlepage and full-width abstract.
6152 %
6153 % In effect, we establish a society default value for \cmd\preprintsty@sw,
6154 % and for \cmd\titlepage@sw.
6155 % \begin{macrocode}
6156 \@booleanfalse\preprintsty@sw
6157 \@booleantrue\titlepage@sw
6158 % \end{macrocode}
6159 %
6160 % We choose the page style for all APS journals.
6161 % The journal may override by inserting its own code in \cmd\setup@hook.
6162 % Users wishing to customize their documents will be able to invoke a \cmd\pagestyle\
6163 % command anywhere in the preamble; it will override the assignments here.
6164 %
6165 % Here is the big switch for APS preprints. Note that \cmd\preprintsty@sw
6166 % is also consulted in various procedures, but we assume its value does
6167 % not change after \cmd\setup@hook\ time.
6168 % \begin{macrocode}
6169 \appdef\setup@hook{%
6170 \preprintsty@sw{%
6171 \ps@preprint
6172 \def\frontmatter@abstractwidth{\textwidth}%
6173 \def\frontmatter@affiliationfont{\it}%
6174 \let\section\section@preprintsty
6175 % \end{macrocode}
6176 % The following line of code had been commented out at this point.
6177 % \begin{verbatim}
6178 % \let\@hangfrom@section\@hangfrom@section@preprintsty
6179 % \end{verbatim}
6180 % \begin{macrocode}
6181 \let\subsection\subsection@preprintsty
6182 \let\subsubsection\subsubsection@preprintsty
6183 }{%
6184 \ps@article
6185 }%
6186 }%
6187 % \end{macrocode}
6188 %
6189 % \begin{macro}{\frontmatter@authorformat}
6190 % All APS journals set the author list the same.
6191 % The leading is 11.5 points, and
6192 % there is 11.5 points of extra space above the first author line
6193 % (which amounts to the same thing as 11.5 points extra below the title)
6194 % for a total of 23 points base-to-base.
6195 %
6196 % \begin{macrocode}
6197 \def\frontmatter@authorformat{%
6198 \skip@\@flushglue
6199 \@flushglue\z@ plus.3\hsize\relax
6200 \centering
6201 \advance\baselineskip\p@
6202 \parskip11.5\p@\relax
6203 \@flushglue\skip@
6204 % \end{macrocode}
6205 % The following line of code had been commented out at this point.
6206 % \begin{verbatim}
6207 %\preprintsty@sw{}{%
6208 % \addvspace{0\p@}%
6209 %}%
6210 % \end{verbatim}
6211 % \begin{macrocode}
6212 }%
6213 % \end{macrocode}
6214 % \end{macro}
6215 %
6216 % \begin{macro}{\frontmatter@above@affilgroup}
6217 % The default amount of space above affiliation.
6218 % APS Journals have 24 points b-b above an affiliation group.
6219 % \begin{macrocode}
6220 \def\frontmatter@above@affilgroup{%
6221 % \end{macrocode}
6222 % The following line of code had been commented out at this point.
6223 % \begin{verbatim}
6224 %\preprintsty@sw{}{%
6225 % \addvspace{11\p@}%
6226 %}%
6227 % \end{verbatim}
6228 % \begin{macrocode}
6229 }%
6230 % \end{macrocode}
6231 % \end{macro}
6232 %
6233 % \begin{macro}{\frontmatter@above@affiliation}
6234 % \begin{macro}{\frontmatter@above@affiliation@script}
6235 % The default amount of space above affiliation.
6236 % APS Journals have no extra space between author group down to common affiliation.
6237 % \begin{macrocode}
6238 \def\frontmatter@above@affiliation@script{%
6239 \skip@\@flushglue
6240 \@flushglue\z@ plus.3\hsize\relax
6241 \centering
6242 \@flushglue\skip@
6243 \addvspace{3.5\p@}%
6244 }%
6245 \def\frontmatter@above@affiliation{%
6246 \preprintsty@sw{}{%
6247 % \end{macrocode}
6248 % The following line of code had been commented out at this point.
6249 % \begin{verbatim}
6250 % \addvspace{12\p@}%
6251 % \end{verbatim}
6252 % \begin{macrocode}
6253 }%
6254 }%
6255 % \end{macrocode}
6256 % \end{macro}
6257 % \end{macro}
6258 %
6259 % \begin{macro}{\frontmatter@affiliationfont}
6260 % All APS journals set the affiliation the same.
6261 % \begin{macrocode}
6262 \def\frontmatter@affiliationfont{%
6263 \small\it
6264 }%
6265 % \end{macrocode}
6266 % \end{macro}
6267 %
6268 % \begin{macro}{\frontmatter@collaboration@above}
6269 % PRL: 1.5 points extra: 13 points base-to-base above.
6270 % \begin{macrocode}
6271 \def\frontmatter@collaboration@above{%
6272 \preprintsty@sw{%
6273 }{%
6274 \parskip1.5\p@\relax
6275 }%
6276 }%
6277 % \end{macrocode}
6278 % \end{macro}
6279 %
6280 % \begin{macro}{\frontmatter@setup}
6281 % All APS journals set the title page using the same font and size.
6282 % However, justification varies for the title block elements, so
6283 % we assert none here.
6284 % \begin{macrocode}
6285 \def\frontmatter@setup{%
6286 \normalfont
6287 }%
6288 % \end{macrocode}
6289 % \end{macro}
6290 %
6291 % \begin{macro}{\frontmatter@title@above}
6292 % \begin{macro}{\frontmatter@title@format}
6293 % \begin{macro}{\frontmatter@title@below}
6294 % All APS journals set the article title the same.
6295 %
6296 % Note: Spacing from title to author is 23 points base-to-base.
6297 % \begin{macrocode}
6298 \def\frontmatter@title@above{\addvspace{6\p@}}%
6299 \def\frontmatter@title@format{\large\bfseries\centering\parskip\z@skip}%
6300 \def\frontmatter@title@below{}%
6301 % \end{macrocode}
6302 % \end{macro}
6303 % \end{macro}
6304 % \end{macro}
6305 %
6306 % \begin{macro}{\frontmatter@makefnmark}
6307 % All APS journals share this procedure for setting the titlepage footnote text.
6308 % \begin{macrocode}
6309 \def\@author@parskip{3\p@}%
6310 \def\frontmatter@makefnmark{%
6311 \@textsuperscript{%
6312 \normalfont\@thefnmark
6313 }%
6314 }%
6315 \def\frontmatter@authorbelow{%
6316 \addvspace{3\p@}%
6317 }%
6318 % \end{macrocode}
6319 % \end{macro}
6320 %
6321 % \begin{macro}{\frontmatter@RRAP@format}
6322 % All APS journals use the same format for the ``Received, Revised, etc.'' block on the title page.
6323 %
6324 % Change note: 11.5 points b-b from author/affiliation down to date.
6325 % \begin{macrocode}
6326 \def\frontmatter@RRAP@format{%
6327 \small
6328 \centering
6329 % \end{macrocode}
6330 % The following line of code had been commented out at this point.
6331 % \begin{verbatim}
6332 % \preprintsty@sw{}{\parskip.5ex\relax}%
6333 % \end{verbatim}
6334 % \begin{macrocode}
6335 \everypar{\hbox\bgroup(\@gobble@leavemode@uppercase}%
6336 \def\par{\@ifvmode{}{\unskip)\egroup\@@par}}%
6337 }%
6338 \def\punct@RRAP{;\egroup\ \hbox\bgroup}%
6339 \def\@gobble@leavemode@uppercase#1#2{\expandafter\MakeTextUppercase}%
6340 % \end{macrocode}
6341 % \end{macro}
6342 %
6343 % \begin{macro}{\frontmatter@PACS@format}
6344 %
6345 % \begin{macrocode}
6346 \def\frontmatter@PACS@format{%
6347 \addvspace{11\p@}%
6348 \footnotesize
6349 \adjust@abstractwidth
6350 \parindent\z@
6351 \parskip\z@skip
6352 \samepage
6353 }%
6354 % \end{macrocode}
6355 % \end{macro}
6356 %
6357 % \begin{macro}{\frontmatter@keys@format}
6358 %
6359 % \begin{macrocode}
6360 \def\frontmatter@keys@format{%
6361 \footnotesize
6362 \adjust@abstractwidth
6363 \parindent\z@
6364 \samepage
6365 }%
6366 % \end{macrocode}
6367 % \end{macro}
6368 %
6369 % \begin{macro}{\ps@titlepage}
6370 % \changes{4.0a}{1998/06/10}{multiple preprint commands}
6371 % \changes{4.0b}{1999/06/20}{Stack \cs{preprint} args flush right at right margin.}
6372 % Title page style. Currently empty except for preprint header,
6373 % which consists of all the \cmd\preprint\ arguments,
6374 % stacked flush right at the right margin.
6375 % \changes{4.0c}{1999/11/13}{Insert procedure \cs{checkindate}}
6376 % \begin{macrocode}
6377 \def\ps@titlepage{%
6378 \def\@oddhead{%
6379 \hfill
6380 \preprint@sw{%
6381 \expandafter\produce@preprints\expandafter{\@preprint}%
6382 }{}%
6383 }%
6384 \let\@evenhead\@oddhead
6385 \def\@oddfoot{%
6386 \hb@xt@\z@{\byrevtex\hss}%
6387 \hfil
6388 \preprintsty@sw{\thepage}{}%
6389 \quad\checkindate
6390 \hfil
6391 }%
6392 \let\@evenfoot\@oddfoot
6393 }%
6394 \def\byrevtex{\byrevtex@sw{Typeset by REV\TeX}{}}%
6395 % \end{macrocode}
6396 % \end{macro}
6397 %
6398 % \begin{macro}{\produce@preprints}
6399 % \changes{4.0c}{1999/11/13}{(AO, 115) If three or more preprints specified, set on single line, with commas.}
6400 % \begin{macrocode}
6401 \def\produce@preprints#1{%
6402 \vtop to \z@{%
6403 \def\baselinestretch{1}%
6404 \small
6405 \let\preprint\preprint@count
6406 \count@\z@
6407 #1%
6408 \@ifnum{\count@>\tw@}{%
6409 \hbox{%
6410 \let\preprint\preprint@hlist
6411 #1%
6412 \setbox\z@\lastbox
6413 }%
6414 }{%
6415 \let\preprint\preprint@cr
6416 \halign{\hfil##\cr#1\crcr}%
6417 \par
6418 \vss
6419 }%
6420 }%
6421 }%
6422 \def\preprint@cr#1{#1\cr}%
6423 \def\preprint@count#1{\advance\count@\@ne}%
6424 \def\preprint@hlist#1{#1\hbox{, }}%
6425 % \end{macrocode}
6426 % \end{macro}
6427 %
6428 % \subsubsection{Stacked Heads}%
6429 % All APS journals put a period (.), followed by quad space, after the section number.
6430 % Also, no hanging section number.
6431 % \begin{macrocode}
6432 \def\@seccntformat#1{\csname the#1\endcsname.\quad}%
6433 \def\@hang@from#1#2#3{#1#2#3}%
6434 % \end{macrocode}
6435 %
6436 % Note that in the following, we wish to set the section head uppercase, so we use
6437 % David Carlisle's \cmd\MakeTextUppercase. However, because this procedure effectively
6438 % parses its argument (looking for things to \emph{not} translate), it has to be invoked
6439 % in such a way that the argument of the \cmd\section\ command is passed to it as its
6440 % own argument.
6441 %
6442 % To accomplish this, we use the \cmd\@hangfrom@\ hook, which was developed for this
6443 % purpose.
6444 %
6445 % \begin{macrocode}
6446 \def\section{%
6447 \@startsection
6448 {section}%
6449 {1}%
6450 {\z@}%
6451 {0.8cm \@plus1ex \@minus .2ex}%
6452 {0.5cm}%
6453 {%
6454 \normalfont\small\bfseries
6455 \centering
6456 }%
6457 }%
6458 \def\@hangfrom@section#1#2#3{\@hangfrom{#1#2}\MakeTextUppercase{#3}}%
6459 \def\@hangfroms@section#1#2{#1\MakeTextUppercase{#2}}%
6460 % \end{macrocode}
6461 %
6462 % \begin{macrocode}
6463 \def\subsection{%
6464 \@startsection
6465 {subsection}%
6466 {2}%
6467 {\z@}%
6468 {.8cm \@plus1ex \@minus .2ex}%
6469 {.5cm}%
6470 {%
6471 \normalfont\small\bfseries
6472 \centering
6473 }%
6474 }%
6475 % \end{macrocode}
6476 %
6477 % \begin{macrocode}
6478 \def\subsubsection{%
6479 \@startsection
6480 {subsubsection}%
6481 {3}%
6482 {\z@}%
6483 {.8cm \@plus1ex \@minus .2ex}%
6484 {.5cm}%
6485 {%
6486 \normalfont\small\itshape
6487 \centering
6488 }%
6489 }%
6490 % \end{macrocode}
6491 %
6492 % \subsubsection{Runin Heads}%
6493 % \begin{macrocode}
6494 \def\paragraph{%
6495 \@startsection
6496 {paragraph}%
6497 {4}%
6498 {\parindent}%
6499 {\z@}%
6500 {-1em}%
6501 {\normalfont\normalsize\itshape}%
6502 }%
6503 % \end{macrocode}
6504 %
6505 % \begin{macrocode}
6506 \def\subparagraph{%
6507 \@startsection
6508 {subparagraph}%
6509 {5}%
6510 {\parindent}%
6511 {3.25ex \@plus1ex \@minus .2ex}%
6512 {-1em}%
6513 {\normalfont\normalsize\bfseries}%
6514 }%
6515 % \end{macrocode}
6516 %
6517 %
6518 %
6519 % \begin{macro}{\section@preprintsty}
6520 % \begin{macro}{\subsection@preprintsty}
6521 % \begin{macro}{\subsubsection@preprintsty}
6522 % Here are the formatting procedures specific to the preprint style;
6523 % the only difference is that the heads are flush left instead of centered.
6524 %
6525 % \begin{macrocode}
6526 \def\section@preprintsty{%
6527 \@startsection
6528 {section}%
6529 {1}%
6530 {\z@}%
6531 {0.8cm \@plus1ex \@minus .2ex}%
6532 {0.5cm}%
6533 {%
6534 \normalfont\small\bfseries
6535 % \centering
6536 }%
6537 }%
6538 %\def\@hangfrom@section@preprintsty#1#2#3{\@hangfrom{#1#2}\MakeTextUppercase{#3}}%
6539 % \end{macrocode}
6540 % \begin{macrocode}
6541 \def\subsection@preprintsty{%
6542 \@startsection
6543 {subsection}%
6544 {2}%
6545 {\z@}%
6546 {.8cm \@plus1ex \@minus .2ex}%
6547 {.5cm}%
6548 {%
6549 \normalfont\small\bfseries
6550 % \centering
6551 }%
6552 }%
6553 % \end{macrocode}
6554 % \begin{macrocode}
6555 \def\subsubsection@preprintsty{%
6556 \@startsection
6557 {subsubsection}%
6558 {3}%
6559 {\z@}%
6560 {.8cm \@plus1ex \@minus .2ex}%
6561 {.5cm}%
6562 {%
6563 \normalfont\small\itshape
6564 % \centering
6565 }%
6566 }%
6567 % \end{macrocode}
6568 % \end{macro}
6569 % \end{macro}
6570 % \end{macro}
6571 %
6572 % By default, APS journals set titlepage notes as footnotes.
6573 % \begin{verbatim}
6574 \let\frontmatter@footnote@produce\frontmatter@footnote@produce@footnote
6575 % \end{verbatim}
6576 %
6577 % \subsubsection{Table of Contents}%
6578 % The toc will itself make an entry in the toc,
6579 % but we temporarily turn off toc formatting for the duration.
6580 % \changes{4.1a}{2008/01/19}{(AO, 461) Change the csname revtex uses from @dotsep to ltxu@dotsep. The former is understood in mu. (What we wanted was a dimension.)}%
6581 % \begin{macrocode}
6582 \def\@pnumwidth{1.55em}%
6583 \def\@tocrmarg {2.55em}%
6584 \def\@dotsep{2}%
6585 \def\ltxu@dotsep{4.5pt}%
6586 \setcounter{tocdepth}{3}%
6587 % \end{macrocode}
6588 %
6589 % \begin{macrocode}
6590 \def\tableofcontents{%
6591 \addtocontents{toc}{\string\tocdepth@munge}%
6592 \print@toc{toc}%
6593 \addtocontents{toc}{\string\tocdepth@restore}%
6594 }%
6595 % \end{macrocode}
6596 %
6597 % \begin{macrocode}
6598 \def\tocdepth@munge{%
6599 \let\l@section@saved\l@section
6600 \let\l@section\@gobble@tw@
6601 }%
6602 \def\@gobble@tw@#1#2{}%
6603 % \end{macrocode}
6604 %
6605 % \begin{macrocode}
6606 \def\tocdepth@restore{%
6607 \let\l@section\l@section@saved
6608 }%
6609 % \end{macrocode}
6610 %
6611 % The following definition of \cmd\l@part\ is a variant on
6612 % the definition of \cmd\l@@sections\ in \file{ltxutil.dtx}.
6613 % \begin{macrocode}
6614 \def\l@part#1#2{\addpenalty{\@secpenalty}%
6615 \begingroup
6616 \set@tocdim@pagenum\@tempboxa{#2}%
6617 % \@tempdima 3em %
6618 \parindent \z@
6619 \rightskip\tocleft@pagenum plus 1fil\relax
6620 \skip@\parfillskip\parfillskip\z@
6621 \addvspace{2.25em plus\p@}%
6622 \large \bf %
6623 \leavevmode\ignorespaces#1\unskip\nobreak\hskip\skip@
6624 \hb@xt@\rightskip{\hfil\unhbox\@tempboxa}\hskip-\rightskip\hskip\z@skip
6625 \par
6626 \nobreak %
6627 \endgroup
6628 }%
6629 % \end{macrocode}
6630 %
6631 % \begin{macro}{\l@section}
6632 % Determine which TOC elements are automatically indented.
6633 %
6634 % We set the TOC to the standard of RMP.
6635 % If APS has its own specification, we will code it, and RMP must override.
6636 % \begin{macrocode}
6637 \def\tocleft@{\z@}%
6638 \def\tocdim@min{5\p@}%
6639 \def\l@section{%
6640 \l@@sections{}{section}% Implicit #3#4
6641 }%
6642 \def\l@f@section{%
6643 \addpenalty{\@secpenalty}%
6644 \addvspace{1.0em plus\p@}%
6645 %\bf
6646 }%
6647 \def\l@subsection{%
6648 \l@@sections{section}{subsection}% Implicit #3#4
6649 }%
6650 \def\l@subsubsection{%
6651 \l@@sections{subsection}{subsubsection}% Implicit #3#4
6652 }%
6653 \def\l@paragraph#1#2{}%
6654 \def\l@subparagraph#1#2{}%
6655 % \end{macrocode}
6656 % \end{macro}
6657 %
6658 % Activate the auto TOC processing.
6659 % \begin{macrocode}
6660 \let\toc@pre\toc@pre@auto
6661 \let\toc@post\toc@post@auto
6662 % \end{macrocode}
6663 %
6664 % \subsubsection{Default column bottom}%
6665 % All APS journal styles have flush bottoms.
6666 %\changes{4.1n}{2009/11/30}{(AO, 566) restore 4.0 behavior: flush column bottoms}
6667 % \begin{macrocode}
6668 \@booleanfalse\raggedcolumn@sw
6669 % \end{macrocode}
6670 %
6671 %
6672 % \subsubsection{Table alignment style}%
6673 %
6674 % \begin{macro}{\tableft@skip@float}
6675 % \begin{macro}{\tabmid@skip@float}
6676 % \begin{macro}{\tabright@skip@float}
6677 % \begin{macro}{\array@row@pre@float}
6678 % \begin{macro}{\array@row@pst@float}
6679 % All APS publications have the same table specification:
6680 % Scotch rules above and below, centered in column.
6681 % \begin{macrocode}
6682 \def\tableft@skip@float{\z@ plus\hsize}%
6683 \def\tabmid@skip@float{\@flushglue}%
6684 \def\tabright@skip@float{\z@ plus\hsize}%
6685 \def\array@row@pre@float{\hline\hline\noalign{\vskip\doublerulesep}}%
6686 \def\array@row@pst@float{\noalign{\vskip\doublerulesep}\hline\hline}%
6687 % \end{macrocode}
6688 % \end{macro}
6689 % \end{macro}
6690 % \end{macro}
6691 % \end{macro}
6692 % \end{macro}
6693 %
6694 %
6695 % \subsubsection{Footnote formatting}%
6696 % \changes{4.1n}{2010/01/02}{(AO, 572) \cs{@makefntext} and \cs{frontmatter@makefntext} must be defined harmoniously}%
6697 % We customize the formatting of footnotes for all APS journals.
6698 % \begin{macro}{\@makefntext}
6699 % \begin{macrocode}
6700 \long\def\@makefntext#1{%
6701 \def\baselinestretch{1}%
6702 \leftskip1em%
6703 \parindent1em%
6704 \noindent
6705 \nobreak\hskip-\leftskip
6706 \hb@xt@\leftskip{%
6707 \hss\@makefnmark\ %
6708 }%
6709 #1%
6710 \par
6711 }%
6712 % \end{macrocode}
6713 % \end{macro}
6714 % \begin{macro}{\frontmatter@makefntext}
6715 % We ensure that frontmatter footnotes format similarly to body footnotes.
6716 % But we provide our own hypertext anchor, otherwise not provided.
6717 % \changes{4.1n}{2010/01/02}{(AO, 572) Independent footnote counter for title block. Abstract footnote counter shared with body.}%
6718 % \begin{macrocode}
6719 \long\def\frontmatter@makefntext#1{%
6720 \def\baselinestretch{1}%
6721 \leftskip1em%
6722 \parindent1em%
6723 \noindent
6724 \nobreak\hskip-\leftskip
6725 \Hy@raisedlink{\hyper@anchorstart{frontmatter.\expandafter\the\csname c@\@mpfn\endcsname}\hyper@anchorend}%
6726 \hb@xt@\leftskip{%
6727 \hss\@makefnmark\ %
6728 }%
6729 #1%
6730 \par
6731 }%
6732 % \end{macrocode}
6733 % \end{macro}
6734 %
6735 %
6736 % \subsubsection{Appendix}%
6737 % \begin{macro}{\appendix}
6738 % \begin{macro}{\@hangfrom@appendix}
6739 % \begin{macro}{\@hangfroms@appendix}
6740 % \begin{macro}{\@appendixcntformat}
6741 % \changes{4.0c}{1999/11/13}{(AO, 129) section* within appendix was producing appendixname}
6742 % \begin{macrocode}
6743 \prepdef\appendix{%
6744 \par
6745 \let\@hangfrom@section\@hangfrom@appendix
6746 %\let\@hangfroms@section\@hangfroms@appendix
6747 \let\@sectioncntformat\@appendixcntformat
6748 }%
6749 \def\@hangfrom@appendix#1#2#3{%
6750 #1%
6751 \@if@empty{#2}{%
6752 #3%
6753 }{%
6754 #2\@if@empty{#3}{}{:\ #3}%
6755 }%
6756 }%
6757 \def\@hangfroms@appendix#1#2{%
6758 #1#2%
6759 }%
6760 \def\@appendixcntformat#1{\appendixname\ \csname the#1\endcsname}%
6761 % \end{macrocode}
6762 % \end{macro}
6763 % \end{macro}
6764 % \end{macro}
6765 % \end{macro}
6766 %
6767 % \subsubsection{Bibliography}%
6768 % \changes{4.1n}{2010/01/04}{(AO, 576) In .bst files, remove support for the annote field}%
6769 %
6770 % Customize \revtex\ for the journal substyle;
6771 % this task requires three components:
6772 % the \BibTeX\ \file{apsrev.bst} and \file{apsrmp.bst} style files, and
6773 % customizations of the \env{thebibliography} environment.
6774 %
6775 % \begin{macro}{\@bibstyle}
6776 % Define the argument of the \cmd\bibliographystyle\ command
6777 % (if the document does not do so).
6778 % The user must have installed a \file{.bst} file of the corresponding name.
6779 % This file will then be used by \BibTeX\ when compiling the document's \file{.bbl} file.
6780 %
6781 % To generate \file{apsrev.bst}, use \classname{custom-bib} version 4.21 or later.
6782 % Run the \file{.bst} generator, \file{makebst.tex}, and
6783 % accept all defaults, with the following exceptions:
6784 %
6785 % \def\QandA#1#2#3{\item#1: \textbf{#2}: \texttt{#3}---}%
6786 % \def\CandE#1{\item\relax\texttt{#1}---}%
6787 % \begin{enumerate}
6788 % \QandA{LANGUAGE FIELD}{l}{lang}Use language field to switch hyphenation patterns for title
6789 % \QandA{PRESENTATIONS}{b}{pres,pres-bf}Presentation, speaker bold face
6790 % \QandA{ORDERING OF REFERENCES}{c}{seq-no}Citation order (unsorted, like unsrt.bst)
6791 % \QandA{ORDER ON VON PART}{x}{vonx}Sort without von part (de la Maire after Mahone)
6792 % \QandA{AUTHOR NAMES}{i}{nm-init,ed-au}Initials + surname (J. F. Smith)
6793 % \QandA{POSITION OF JUNIOR}{*}{jnrlst}Junior comes last as Smith, John, Jr.
6794 % \QandA{TYPEFACE FOR AUTHORS IN LIST OF REFERENCES}{u}{nmft,nmft-def}User defined author font (\cmd\bibnamefont)
6795 % \QandA{FONT FOR FIRST NAMES}{u}{fnm-def}First names in user defined font (\cmd\bibfnamefont)
6796 % \QandA{EDITOR NAMES IN INCOLLECTION ETC}{a}{nmfted}Editors incollection like authors font
6797 % \QandA{FONT FOR `AND' IN LIST}{r}{nmand-rm}`And' in normal font (JONES and JAMES)
6798 % \QandA{FONT OF CITATION LABELS IN TEXT}{u}{lab,lab-def}User defined citation font (\cmd\citenamefont)
6799 % \QandA{FONT FOR `AND' IN CITATIONS}{r}{and-rm}Cited `and' in normal font
6800 % \QandA{DATE FORMAT}{*}{yr-par}Date in parentheses as (May 1993)
6801 % \QandA{DATE EMPTY}{-}{date-nil-x}If date is empty, then do not produce the surrounding punctuation (parens, brackets, colon, comma)
6802 % \QandA{TITLE OF ARTICLE}{d}{tit-qq}Title and punctuation in double quotes (``Title,'' ..)
6803 % \QandA{INPROCEEDINGS CHAPTER AND PAGES, LIKE INBOOK}{-}{inproceedings-chapter}produce pages after chapter, just as in InBook
6804 % \QandA{TITLE PRESENT IN ARTICLE, INCOLLECTION, AND INPROCEEDINGS}{x}{jtit-x}Title is ignored
6805 % \QandA{INPROCEEDINGS CHAPTER AND PAGES, LIKE INBOOK}{y}{inproceedings-chapter}produce pages after chapter, just as in InBook
6806 % \QandA{ARTICLE BOOKTITLE PRESENT}{}{article-booktitle}format booktitle
6807 % \QandA{ARTICLE SERIES PRESENT}{}{article-series}article can has series
6808 % \QandA{JOURNAL NAME FONT}{r}{jttl-rm}Journal name normal font
6809 % \QandA{JOURNAL NAME WITH ADDRESS}{y}{journal-address}Include address field (in parentheses) along with journal name
6810 % \QandA{BOOK TITLE FIELDS}{y}{book-bt}Field `booktitle', or if absent field `title', is book title
6811 % \QandA{THESIS TITLE OPTIONAL}{}{thesis-title-o}Title is optional: no warning issued if empty
6812 % \QandA{TECHNICAL REPORT TITLE}{b}{trtit-b}Tech. report title like books
6813 % \QandA{TECHNICAL REPORT INSTITUTION}{}{techreport-institution-par}format tech report institution like book publisher
6814 % \QandA{JOURNAL VOLUME}{b}{vol-bf}Volume bold as {\bf vol}(num)
6815 % \QandA{JOURNAL VOL AND NUMBER}{x}{vnum-x}Journal vol, without number as 34
6816 % \QandA{VOLUME PUNCTUATION}{c}{volp-com}Volume with comma as vol(num), ppp
6817 % \QandA{PAGE NUMBERS}{f}{jpg-1}Only start page number
6818 % \QandA{BOOK EDITOR W/O AUTHOR}{}{book-editor-booktitle}Book permits empty author, produces title before editor in this case
6819 % \QandA{INBOOK PERMITS TITLE, BOOKTITLE, AUTHOR, EDITOR}{a}{inbook-editor-booktitle}Allow using both title/booktitle, both author/editor
6820 % \QandA{CONFERENCE ADDRESS FOR BOOK, INBOOK, INCOLLECTION, INPROCEEDINGS, PROCEEDINGS}{a}{bookaddress}Italic booktitle followed by bookaddress in roman
6821 % \QandA{NUMBER AND SERIES FOR BOOK, INBOOK, INCOLLECTION, INPROCEEDINGS, PROCEEDINGS}{*}{num-xser}Allows number without series and suppresses word "number"
6822 % \QandA{WORD NUMBER CAPITALIZED FOR NUMBER AND SERIES}{c}{number-cap}Capitalize word `number' as: "Number 123"
6823 % \QandA{WORD CHAPTER CAPITALIZED}{c}{chapter-cap}Capitalize word `chapter' as: `Chapter 42'
6824 % \QandA{COMBINING NUMBER AND SERIES}{x}{series-number}Series number as: `Springer Lecture Notes No. 125'
6825 % \QandA{POSITION OF NUMBER AND SERIES}{b}{numser-booktitle}After book title and conference address, and before editors
6826 % \QandA{VOLUME AND SERIES FOR BOOKS/COLLECTIONS}{s}{ser-vol}Series, vol. 23
6827 % \QandA{VOLUME AND SERIES FORMATTING}{y}{ser-rm}format series roman , even when used with volume
6828 % \QandA{WORD VOLUME CAPITALIZED FOR VOLUME AND SERIES}{y}{volume-cap}Capitalize word `volume', as: `Volume 7 in Lecture Series'
6829 % \QandA{POSITION OF VOLUME AND SERIES FOR INCOLLECTION, INBOOK, AND INPROCEEDINGS}{e}{ser-ed}Series and volume after booktitle and before editors
6830 % \QandA{JOURNAL NAME PUNCTUATION}{x}{jnm-x}Space after journal name
6831 % \QandA{PAGES IN BOOK}{*}{pg-bk,book-chapter-pages}As chapter and page: chapter 42, page 345
6832 % \QandA{PUBLISHER IN PARENTHESES}{d}{pub-date}Publisher with address and date in parentheses (Oxford, 1994)
6833 % \QandA{EMPTY PUBLISHER PARENTHESES}{y}{ay-empty-pub-parens-x}eliminate parentheses altogether if nothing inside
6834 % \QandA{PUBLISHER POSITION}{}{pre-pub}Publisher before volume, chapter, pages
6835 % \QandA{}{}{pre-edn}Edition before publisher
6836 % \QandA{}{p}{pre-pub,pre-edn}Edition, publisher, volume, chapter, pages
6837 % \QandA{ISBN NUMBER}{*}{isbn}Include ISBN for books, booklets, etc.
6838 % \QandA{ISSN NUMBER}{*}{issn}Include ISSN for periodicals
6839 % \QandA{DOI NUMBER}{a}{doi-link,doi}Doi forms a link to the publication, anchored to the volume or title
6840 % \QandA{EDITOR IN COLLECTIONS}{b}{edby}In booktitle, edited by .. (where .. is names)
6841 % \QandA{PUNCTUATION BETWEEN SECTIONS (BLOCKS)}{c}{blk-com}Comma between blocks
6842 % \QandA{FINAL PUNCTUATION}{c}{fin-endbibitem}Command at end instead of period
6843 % \QandA{ABBREVIATE WORD `PAGES'}{a}{pp}`Page' abbreviated as p. or pp.
6844 % \QandA{ABBREVIATE WORD `EDITORS'}{a}{ed}`Editor' abbreviated as ed. or eds.
6845 % \QandA{OTHER ABBREVIATIONS}{a}{abr}Abbreviations of such words
6846 % \QandA{ABBREVIATION FOR `EDITION'}{a}{ednx}`Edition' abbreviated as `ed'
6847 % \QandA{EDITION NUMBERS}{n}{ord}Numerical editions as 1st, 2nd, 3rd, etc
6848 % \QandA{STORED JOURNAL NAMES}{a}{jabr}Abbreviated journal names
6849 % \QandA{FONT OF `ET AL'}{i}{etal-it}Italic et al
6850 % \QandA{ADDITIONAL REVTeX DATA FIELDS}{r}{revdata,eprint,url,url-blk,translation}Include REVTeX data fields collaboration, eid, eprint, archive, url, translation
6851 % \QandA{SLACcitation FIELD}{}{SLACcitation}Produce SLACcitation field
6852 % \QandA{NUMPAGES DATA FIELD}{*}{numpages-x}Do not include numpages field
6853 % \QandA{URL ADDRESS}{*}{url,url-prefix-x}URL without prefix (default: `URL ')
6854 % \QandA{REFERENCE COMPONENT TAGS}{b}{bibinfo}Reference component tags like \cmd\bibinfo in the content of \cmd\bibitem
6855 % \QandA{ELEMENT TAGS}{b}{bibfield}Element tags like \cmd\bibfield in the content of \cmd\bibitem
6856 % \QandA{COMPATIBILITY WITH PLAIN TEX}{*}{nfss}Use LaTeX commands which may not work with Plain TeX
6857 % \end{enumerate}
6858 %
6859 % A file \file{apsrev.dbj} file equivalent to the following should result:
6860 % \begin{verbatim}
6861 %\input docstrip
6862 %\preamble
6863 %----------------------------------------
6864 %*** REVTeX-compatible Phys Rev 2010-02-12 ***
6865 %\endpreamble
6866 %\postamble
6867 %End of customized bst file
6868 %\endpostamble
6869 %\keepsilent
6870 %\askforoverwritefalse
6871 %\def\MBopts{\from{merlin.mbs}{%
6872 % head,\MBopta}
6873 %\from{physjour.mbs}{\MBopta}
6874 %\from{geojour.mbs}{\MBopta}
6875 %\from{photjour.mbs}{\MBopta}
6876 %\from{merlin.mbs}{tail,\MBopta}}
6877 %\def\MBopta{%
6878 % ay,%: Author-year with some non-standard interface
6879 % nat,%: Natbib for use with natbib v5.3 or later
6880 % lang,%: Use language field to switch hyphenation patterns for title
6881 % pres,pres-bf,%: Presentation, speaker bold face
6882 % seq-no,%: Citation order (unsorted, only meaningful for numericals)
6883 % vonx,%: Sort without von part (de la Maire after Mahone)
6884 % nm-init,ed-au,%: Initials + surname (J. F. Smith)
6885 % jnrlst,%: Junior comes last as Smith, John, Jr.
6886 % nmft,nmft-def,%: User defined author font (\bibnamefont)
6887 % fnm-def,%: First names in user defined font (\bibfnamefont)
6888 % nmfted,%: Editors incollection like authors font
6889 % nmand-rm,%: `And' in normal font (JONES and JAMES)
6890 % lab,lab-def,%: User defined citation font (\citenamefont)
6891 % and-rm,%: Cited `and' in normal font
6892 % keyxyr,%: Year blank when KEY replaces missing author (for natbib 7.0)
6893 % blkyear,%: Missing date left blank
6894 % yr-par,%: Year in parentheses as (1993)
6895 % dtrev,%: Date as year month
6896 % date-nil-x,%: If date is empty, then do not produce the surrounding punctuation (parens, brackets, colon, comma)
6897 % tit-qq,%: Title and punctuation in double quotes (``Title,'' ..)
6898 % inproceedings-chapter,%: produce pages after chapter, just as in InBook
6899 % jtit-x,%: Title is ignored
6900 % inproceedings-chapter,%: produce pages after chapter just as in InBook
6901 % article-booktitle,%: format booktitle
6902 % article-series,%: article can has series
6903 % jttl-rm,%: Journal name normal font
6904 % journal-address,%: Include address field (in parentheses) along with journal name
6905 % book-bt,%: Field `booktitle', or if absent field `title', is book title
6906 % thesis-title-o,%: Title is optional: no warning issued if empty
6907 % trtit-b,%: Tech. report title like books
6908 % techreport-institution-par,%: format tech report institution like book publisher
6909 % vol-bf,%: Volume bold as {\bf vol}(num)
6910 % vnum-x,%: Journal vol, without number as 34
6911 % volp-com,%: Volume with comma as vol(num), ppp
6912 % jpg-1,%: Only start page number
6913 % book-editor-booktitle,%: Book permits empty author, produces title before editor in this case
6914 % inbook-editor-booktitle,%: Allow using both title/booktitle, both author/editor
6915 % bookaddress,%: Italic booktitle followed by bookaddress in roman
6916 % num-xser,%: Allows number without series and suppresses word "number"
6917 % number-cap,%: Capitalize word `number' as: "Number 123"
6918 % chapter-cap,%: Capitalize word `chapter' as: `Chapter 42'
6919 % series-number,%: Series number as: `Springer Lecture Notes No. 125'
6920 % numser-booktitle,%: After book title and conference address, and before editors
6921 % ser-vol,%: Series, vol. 23
6922 % ser-rm,%: format series roman , even when used with volume
6923 % volume-cap,%: Capitalize word `volume', as: `Volume 7 in Lecture Series'
6924 % ser-ed,%: Series and volume after booktitle and before editors
6925 % jnm-x,%: Space after journal name
6926 % pg-bk,book-chapter-pages,%: As chapter and page: chapter 42, page 345
6927 % pub-date,%: Publisher with address and date in parentheses (Oxford, 1994)
6928 % ay-empty-pub-parens-x,%: eliminate parentheses altogether if nothing inside
6929 % pre-pub,pre-edn,%: Edition, publisher, volume, chapter, pages
6930 % isbn,%: Include ISBN for books, booklets, etc.
6931 % issn,%: Include ISSN for periodicals
6932 % doi-link,doi,%: Doi forms a link to the publication, anchored to the volume or title
6933 % edby,%: In booktitle, edited by .. (where .. is names)
6934 % blk-com,%: Comma between blocks
6935 % fin-endbibitem,%: Command at end instead of period
6936 % pp,%: `Page' abbreviated as p. or pp.
6937 % ed,%: `Editor' abbreviated as ed. or eds.
6938 % abr,%: Abbreviations of such words
6939 % ednx,%: `Edition' abbreviated as `ed'
6940 % ord,%: Numerical editions as 1st, 2nd, 3rd, etc
6941 % jabr,%: Abbreviated journal names
6942 % etal-it,%: Italic et al
6943 % revdata,eprint,url,url-blk,translation,%: Include REVTeX data fields collaboration, eid, eprint, archive, url, translation
6944 % SLACcitation,%: Produce SLACcitation field
6945 % numpages-x,%: Do not include numpages field
6946 % url,url-prefix-x,%: URL without prefix (default: `URL ')
6947 % bibinfo,%: Reference component tags like \bibinfo in the content of \bibitem
6948 % bibfield,%: Element tags like \bibfield in the content of \bibitem
6949 % nfss,%: Use LaTeX commands which may not work with Plain TeX
6950 %,{%
6951 % }}
6952 %\generate{\file{apsrev4-1.bst}{\MBopts}}
6953 %\endbatchfile
6954 % \end{verbatim}
6955 %
6956 % \subsubsection{Comparing apsrev.bst and apsrmp.bst}\label{sec:CompRevRmp}
6957 % These two bibliographic styles differ as follows:
6958 % \file{apsrev.dbj} has the following guard codes, which \file{apsrmp.dbj} does not:
6959 % \begin{itemize}
6960 % \CandE{seq-no}%
6961 % Citation order (unsorted, like unsrt.bst)
6962 % \CandE{nm-init,ed-au}%
6963 % Initials + surname (J. F. Smith)
6964 % \CandE{blkyear}%
6965 % Missing date left blank
6966 % \CandE{date-nil-x}%
6967 % If date is empty, then do not produce the surrounding punctuation (parens, brackets, colon, comma)
6968 % \CandE{inproceedings-chapter}%
6969 % produce pages after chapter, just as in InBook
6970 % \CandE{techreport-institution-par}%
6971 % format tech report institution like book publisher
6972 % \CandE{vnum-x}%
6973 % Journal vol, without number as `34'
6974 % \CandE{pub-date}%
6975 % Publisher with address and date in parentheses (Oxford, 1994)
6976 % \CandE{pre-pub}%
6977 % Edition, publisher, volume, chapter, pages. Note that both use guard code pre-edn.
6978 % \end{itemize}
6979 %
6980 % \file{apsrmp.dbj} has the following guard codes, which \file{apsrev.dbj} does not:
6981 % \begin{itemize}
6982 % \CandE{nm-rev1}%
6983 % Only first name reversed, initials (AGU style: Smith, J. F., H. K. Jones)
6984 % \CandE{dt-beg}%
6985 % Date after authors
6986 % \CandE{vnum-sp}%
6987 % Journal vol (num) as `34 (2)'
6988 % \CandE{pp-last}%
6989 % Pages at end, but before any notes
6990 % \CandE{pub-par}%
6991 % Publisher in parentheses
6992 % \CandE{school-par}%
6993 % School/address in parens: `(school, address)'
6994 % \CandE{bkedcap}%
6995 % `Name Editor,' as above, editor upper case
6996 % \CandE{and-com}%
6997 % Comma even with 2 authors as `Tom, and Harry'
6998 %
6999 % \end{itemize}
7000 %
7001 % We ensure that the journal substyle has the first word
7002 % in the matter by installing the (default) APS code
7003 % later on (see Section~\ref{sec:aps-defaults}).
7004 % \end{macro}
7005 %
7006 % \begin{macro}{\authoryear@sw}
7007 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
7008 % Numerical citations: default value of \cmd\authoryear@sw\ is false.
7009 % \begin{macrocode}
7010 \@booleanfalse\authoryear@sw
7011 % \end{macrocode}
7012 % \end{macro}
7013 %
7014 % \begin{macro}{\bibpunct}
7015 % The following commands effectively establish the style in which \cmd\cite\ commands are
7016 % formatted.
7017 % You can think of them as the second needed component for the bibliography.
7018 %
7019 % Set up for APS numerical citations (once the packages are loaded).
7020 % The journal substyle can override these choices.
7021 %
7022 % Note that, prior to \classname{natbib} version 8.21, changing \cmd\NAT@sort\ at this late hour would not be totally effective;
7023 % you would have to give \classname{natbib} the relevant options at load time.
7024 % From version 8.21 on, \cmd\NAT@sort\ and \cmd\NAT@cmprs\ are not bound at all.
7025 % \changes{4.1a}{2008/01/19}{For natbib versions before 8.21, \cs{NAT@sort} was consulted only as natbib was being read in. Now it is fully dynamic.}
7026 % \begin{macrocode}
7027 \appdef\setup@hook{%
7028 \bibpunct{[}{]}{,}{n}{}{,}%
7029 }%
7030 % \end{macrocode}
7031 % \end{macro}
7032 %
7033 % \begin{macro}{\pre@bibdata}
7034 %
7035 % Set up to write endnotes to a .bib file; its data will be incorporated into the bibliography.
7036 % \begin{macrocode}
7037 \def\pre@bibdata{\jobname\bibdata@app}%
7038 % \end{macrocode}
7039 % \end{macro}
7040 %
7041 % \begin{macro}{\bibsection}
7042 % We define the sectioning command to use when starting the bibliography.
7043 %
7044 % \changes{4.0rc1}{2001/06/18}{grid changes with push and pop}
7045 % \begin{macrocode}
7046 \appdef\setup@hook{%
7047 \def\bibsection{%
7048 \par
7049 \onecolumngrid@push
7050 \begingroup
7051 \baselineskip26\p@
7052 \bib@device{\textwidth}{245.5\p@}%
7053 \endgroup
7054 \nobreak\@nobreaktrue
7055 \addvspace{19\p@}%
7056 \par
7057 \onecolumngrid@pop
7058 }%
7059 }%
7060 % \end{macrocode}
7061 % \end{macro}
7062 %
7063 % \begin{macro}{\bib@device}
7064 % \begin{macro}{\bibpreamble}
7065 % \begin{macro}{\bibsep}
7066 % \begin{macro}{\newblock}
7067 % We define the sectioning command to use when starting the bibliography.
7068 % \begin{macrocode}
7069 \def\bib@device#1#2{%
7070 \hb@xt@\z@{%
7071 \hb@xt@#1{%
7072 \hfil
7073 \phantomsection
7074 \addcontentsline {toc}{section}{\protect\numberline{}\refname}%
7075 % \hyper@anchorstart {\@currentHref }%
7076 \hb@xt@#2{%
7077 \skip@\z@\@plus-1fil\relax
7078 \leaders\hrule height.25 \p@ depth.25 \p@ \hskip\z@\@plus1fil
7079 \hskip\skip@
7080 \hskip\z@\@plus0.125fil\leaders\hrule height.375\p@ depth.375\p@ \hskip\z@\@plus0.75fil \hskip\z@\@plus0.125fil
7081 \hskip\skip@
7082 \hskip\z@\@plus0.25 fil\leaders\hrule height.5 \p@ depth.5 \p@ \hskip\z@\@plus0.5 fil \hskip\z@\@plus0.25 fil
7083 \hskip\skip@
7084 \hskip\z@\@plus0.375fil\leaders\hrule height.625\p@ depth.625\p@ \hskip\z@\@plus0.25fil \hskip\z@\@plus0.375fil
7085 % \hskip\skip@
7086 % \hfil
7087 }%
7088 % \hyper@anchorend
7089 \hfil
7090 }%
7091 \hss
7092 }%
7093 }%
7094 \appdef\setup@hook{%
7095 \let\bibpreamble\@empty
7096 \bibsep\z@\relax
7097 \def\newblock{\ }%
7098 }%
7099 % \end{macrocode}
7100 % \end{macro}
7101 % \end{macro}
7102 % \end{macro}
7103 % \end{macro}
7104 %
7105 % \begin{macro}{\bibfont}
7106 % We define the font switch that applies to the body of the bibliography.
7107 %
7108 % \begin{macrocode}
7109 \appdef\setup@hook{%
7110 \def\bibfont{%
7111 \small
7112 \@clubpenalty\clubpenalty
7113 }%
7114 }%
7115 % \end{macrocode}
7116 % \end{macro}
7117 %
7118 %
7119 % \subsubsection{Index}%
7120 % FIXME: the following call to \cmd\twocolumn\ appears wrong if we were in two-column grid.
7121 % \changes{4.0c}{1999/11/13}{grid changes with ltxgrid}
7122 % \changes{4.0rc1}{2001/06/18}{grid changes with push and pop}
7123 % \begin{macrocode}
7124 \newenvironment{theindex}{%
7125 \columnseprule \z@
7126 \columnsep 35\p@
7127 \c@secnumdepth-\maxdimen
7128 \onecolumngrid@push
7129 \section{\indexname}%
7130 \thispagestyle{plain}%
7131 \parindent\z@
7132 \parskip\z@ plus.3\p@\relax
7133 \let\item\@idxitem
7134 \onecolumngrid@pop
7135 }{%
7136 %\onecolumngrid@pop
7137 }%
7138 %
7139 \def\@idxitem{\par\hangindent 40\p@}%
7140 %
7141 \def\subitem{\par\hangindent 40\p@ \hspace*{20\p@}}%
7142 %
7143 \def\subsubitem{\par\hangindent 40\p@ \hspace*{30\p@}}%
7144 %
7145 \def\indexspace{\par \vskip 10\p@ plus5\p@ minus3\p@\relax}%
7146 % \end{macrocode}
7147 %
7148 %
7149 % \subsection{Journal- and Pointsize-Specific Code}%
7150 %
7151 % After this substyle is read in, we will execute the code specific to the selected
7152 % journal: execute the society/journal \file{.rtx} file if it exists, or
7153 % execute the society/journal macro (if the latter is not defined, it will \cmd\relax\ out).
7154 % Here we define the default journal.
7155 % \begin{macrocode}
7156 \def\@journal@default{pra}%
7157 % \end{macrocode}
7158 %
7159 % \subsection{Typesize-Specific Code}%
7160 %
7161 % After this society file is read in, we will process the \cmd\@pointsize-specific
7162 % code. Here we define the default.
7163 % \begin{macrocode}
7164 \def\@pointsize@default{10}%
7165 % \end{macrocode}
7166 %
7167 % Note: the convention in \revtex\ and its substyles is that
7168 % the substyle must not override any explicit class options
7169 % declared by the document.
7170 % This means that the various Booleans of Section~\ref{sec:options}
7171 % may be assigned here only if they are still undefined at this point.
7172 %
7173 % For the APS, we supply code specific to journals PRA, PRB, PRC, PRD, PRE, PRL, and RMP.
7174 % At present, they are identical,
7175 % with the exception of PRB and RMP.
7176 %
7177 % For most all of the APS journals, the journal-dependent
7178 % code is relatively meager and is therefore embedded in this file.
7179 % However, the RMP code is sufficiently extensive that
7180 % splitting it out into a separate file is more convenient.
7181 %
7182 % \subsubsection{\classoption{pra}}%
7183 % There is no code specific to \classoption{pra}.
7184 % \begin{macrocode}
7185 \def\rtx@apspra{%
7186 \class@info{APS journal PRA selected}%
7187 }%
7188 % \end{macrocode}
7189 %
7190 % \subsubsection{\classoption{prb}}%
7191 % We define a \cmd\citealp-like procedure that uses a numerical citation; it is for use in
7192 % the PRB journal.
7193 % \begin{macrocode}
7194 \def\rtx@apsprb{%
7195 \class@info{APS journal PRB selected}%
7196 % \end{macrocode}
7197 % PRB requires superscript citations.
7198 % We use Patrick Daly's \classname{natbib} package,
7199 % and hyperref and other packages are already set up to cope with this.
7200 %
7201 % \begin{macro}{\bibpunct}
7202 % By default, PRB selects the \classoption{bibnotes} option.
7203 % We also set up for numerical citations.
7204 % \begin{macrocode}
7205 \let\frontmatter@footnote@produce\frontmatter@footnote@produce@endnote
7206 \appdef\setup@hook{%
7207 \bibpunct{}{}{,}{s}{}{\textsuperscript{,}}%
7208 \let\onlinecite\rev@citealpnum
7209 }%
7210 % \end{macrocode}
7211 % \end{macro}
7212 %
7213 % \begin{macro}{\pre@bibdata}
7214 % \begin{macro}{\@endnotetext}
7215 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
7216 %
7217 % Set up to write endnotes to a .bib file; its data will be incorporated into the bibliography.
7218 % \begin{macrocode}
7219 \def\pre@bibdata{\jobname\bibdata@app}%
7220 % \end{macrocode}
7221 % \end{macro}
7222 % \end{macro}
7223 %
7224 % Invoke \classoption{superbib} option.
7225 % If the document makes a selection of its own, it will override this assignment.
7226 % \begin{macrocode}
7227 \let\place@bibnumber\place@bibnumber@sup
7228 % \end{macrocode}
7229 %
7230 % End of \classoption{prb} code.
7231 % \begin{macrocode}
7232 }%
7233 % \end{macrocode}
7234 %
7235 % \subsubsection{\classoption{prc}}%
7236 % There is no code specific to \classoption{prc}.
7237 % \begin{macrocode}
7238 \def\rtx@apsprc{%
7239 \class@info{APS journal PRC selected}%
7240 }%
7241 % \end{macrocode}
7242 %
7243 % \subsubsection{\classoption{prd}}%
7244 % There is no code specific to \classoption{prd}.
7245 % \begin{macrocode}
7246 \def\rtx@apsprd{%
7247 \class@info{APS journal PRD selected}%
7248 }%
7249 % \end{macrocode}
7250 %
7251 % \subsubsection{\classoption{pre}}%
7252 % There is no code specific to \classoption{pre}.
7253 % \begin{macrocode}
7254 \def\rtx@apspre{%
7255 \class@info{APS journal PRE selected}%
7256 }%
7257 % \end{macrocode}
7258 %
7259 % \subsubsection{\classoption{prl}}%
7260 % \begin{macrocode}
7261 \def\rtx@apsprl{%
7262 \class@info{APS journal PRL selected}%
7263 % \end{macrocode}
7264 % In PRL, the default is the \classoption{bibnotes} option,
7265 % and the Acknowledgments section has no head.
7266 %
7267 % The References head is a device that may be described as a lozenge centered on the baseline,
7268 % 71 points wide by 2 points thick, with the ends tapering to a half point in thickness.
7269 % Space above 26 points base to base, below 31 base to base.
7270 %FIXME: this code may confound \classname{geometry}
7271 % \begin{macrocode}
7272 \let\frontmatter@footnote@produce\frontmatter@footnote@produce@endnote
7273 \@booleanfalse\acknowledgments@sw
7274 \appdef\setup@hook{%
7275 \def\bibsection{%
7276 \par
7277 \begingroup
7278 \baselineskip26\p@
7279 \bib@device{\hsize}{72\p@}%
7280 \endgroup
7281 \nobreak\@nobreaktrue
7282 \addvspace{19\p@}%
7283 }%
7284 }%
7285 % \end{macrocode}
7286 % Implement length checking.
7287 % Use the \classname{times} and \classname{mathtime} packages,
7288 % plus whatever other processing is required
7289 % to make the formatted output be true
7290 % to the metrics of the journal.
7291 %
7292 % \begin{macrocode}
7293 \appdef\setup@hook{%
7294 \lengthcheck@sw{%
7295 \RequirePackage{times}%
7296 % \end{macrocode}
7297 % Wait. Do not use mathtime after all. APS has their own way of doing math pi, involving
7298 % Adobe Mathematical Pi and other fonts.
7299 % \begin{verbatim}
7300 % \RequirePackage{mathtime}%
7301 % \end{verbatim}
7302 % \begin{macrocode}
7303 }{}%
7304 }%
7305 % \end{macrocode}
7306 % A PRL does not have numbered sections.
7307 % \begin{macrocode}
7308 \c@secnumdepth=-\maxdimen
7309 % \end{macrocode}
7310 % Note: we defer this code until after type size file is read in.
7311 % \begin{macrocode}
7312 \appdef\setup@hook{%
7313 \@ifnum{\@pointsize=10\relax}{%
7314 \lengthcheck@sw{%
7315 \def\large{%
7316 \@setfontsize\large{12.5}{14\p@}%
7317 }%
7318 \def\normalsize{%
7319 \@setfontsize\normalsize{10.5}\@xiipt
7320 \abovedisplayskip 6\p@ \@plus6\p@ \@minus5\p@
7321 \belowdisplayskip \abovedisplayskip
7322 \abovedisplayshortskip \abovedisplayskip
7323 \belowdisplayshortskip \abovedisplayskip
7324 \let\@listi\@listI
7325 }%
7326 \def\small{%
7327 \@setfontsize\small{9.5}\@xipt
7328 \abovedisplayskip 5\p@ \@plus5\p@ \@minus4\p@
7329 \belowdisplayskip \abovedisplayskip
7330 \abovedisplayshortskip \abovedisplayskip
7331 \belowdisplayshortskip \abovedisplayskip
7332 \let\@listi\@listI
7333 }%
7334 \DeclareMathSizes{12.5}{12.5}{9}{6}%
7335 \DeclareMathSizes{10.5}{10.5}{7.5}{5}%
7336 \DeclareMathSizes{9.5}{9.5}{7.0}{5}%
7337 }{%
7338 \def\normalsize{%
7339 \@setfontsize\normalsize\@xpt\@xiipt
7340 \abovedisplayskip 10\p@ \@plus2\p@ \@minus5\p@
7341 \belowdisplayskip \abovedisplayskip
7342 \abovedisplayshortskip \abovedisplayskip
7343 \belowdisplayshortskip \abovedisplayskip
7344 \let\@listi\@listI
7345 }%
7346 }%
7347 }{}%
7348 }%
7349 \textheight = 694.0\p@
7350 % \end{macrocode}
7351 %
7352 % End of \classoption{prl} code.
7353 % \begin{macrocode}
7354 }%
7355 % \end{macrocode}
7356 %
7357 % \subsubsection{\classoption{per}}%
7358 % Here is code specific to \classoption{per}.
7359 % \begin{macrocode}
7360 \def\rtx@apsprstper{%
7361 \class@info{APS journal PRST-PER selected}%
7362 % \end{macrocode}
7363 % To first order, PER is the same as PRB, with superscript citations.
7364 %
7365 % \begin{macrocode}
7366 \rtx@apsprb
7367 % \end{macrocode}
7368 % Per Mark Doyle (2009-12-22), the default is longbibliography.
7369 % \changes{4.1n}{2010/01/04}{(AO, 575) the default for journal prstper is longbibliography}%
7370 % \begin{macrocode}
7371 \@booleantrue\longbibliography@sw
7372 % \end{macrocode}
7373 %
7374 % ``Section heads are bold, centered (Roman numeral, Latin letter)''
7375 %
7376 % Article titles do not have surrounding double-quotes!
7377 %
7378 % End of \classoption{prb} code.
7379 % \begin{macrocode}
7380 }%
7381 % \end{macrocode}
7382 %
7383 % \subsubsection{\classoption{prstab}}%
7384 % There is no code specific to \classoption{prstab}.
7385 % \begin{macrocode}
7386 \def\rtx@apsprstab{%
7387 \class@info{APS journal PRSTAB selected}%
7388 }%
7389 % \end{macrocode}
7390 %
7391 % \subsubsection{\classoption{rmp}}%
7392 % If this option has been selected, we will read in the needed code from the file \file{apsrmp.rtx}.
7393 %
7394 % \subsection{Establish APS Defaults}\label{sec:aps-defaults}
7395 %
7396 % \begin{macro}{\footinbib@sw}
7397 % All APS journals except RMP effectively invoke the \classoption{footinbib} option.
7398 % We rely on the RMP-specific code to override this assignment.
7399 % \begin{macrocode}
7400 \@booleantrue\footinbib@sw
7401 % \end{macrocode}
7402 % \end{macro}
7403 %
7404 % \begin{macro}{\@bibdataout@init}
7405 % \begin{macro}{\@bibdataout@aps}
7406 % \changes{4.1o}{2010/02/12}{(AO, 580) Control .bst at run time.}%
7407 % Procedure \cmd\@bibdataout@aps\ has the job of writing the control record into the
7408 % job's \cmd\jobname\filename{.bib} file, where it will adjust the options to \filename{.bst} processing.
7409 % It is installed into the initialization procedure \cmd\@bibdataout@init, and its meaning
7410 % is set by the society (APS) and journal.
7411 % For all but RMP, we select the Physical Review style.
7412 % For the latter case, we change the meaning, per the code in \file{apsrmp.rtx}.
7413 %
7414 % \begin{macrocode}
7415 \appdef\@bibdataout@rev{\@bibdataout@aps}%
7416 \def\@bibdataout@aps{%
7417 \immediate\write\@bibdataout{%
7418 % \end{macrocode}
7419 % An entry that controls processing of the \filename{.bst} file has entry type \texttt{@CONTROL}.
7420 % \begin{macrocode}
7421 @CONTROL{%
7422 apsrev41Control%
7423 % \end{macrocode}
7424 % Say whether we want long bibliography style (the default), or the abbreviated style.
7425 % \begin{macrocode}
7426 \longbibliography@sw{%
7427 ,author="00",editor="1",pages="1",title="0",year="0"%
7428 }{%
7429 ,author="08",editor="1",pages="0",title="",year="1"%
7430 }%
7431 }%
7432 }%
7433 % \end{macrocode}
7434 % Place a \cmd\citation\ into the auxiliary file corresponding to this entry.
7435 % \begin{macrocode}
7436 \if@filesw
7437 \immediate\write\@auxout{\string\citation{apsrev41Control}}%
7438 \fi
7439 }%
7440 % \end{macrocode}
7441 % \end{macro}
7442 % \end{macro}
7443 %
7444 % \begin{macro}{\place@bibnumber}
7445 % \begin{macro}{\@bibstyle}
7446 % We install code that will select the presentation for \cmd\bibitem s
7447 % and govern the \BibTeX\ processing.
7448 % \begin{macrocode}
7449 \let\place@bibnumber\place@bibnumber@inl
7450 \def\@bibstyle{apsrev\substyle@post}%
7451 % \end{macrocode}
7452 % \begin{verbatim}
7453 %\appdef\setup@hook{%
7454 % \longbibliography@sw{%
7455 % \appdef\@bibstyle{long}%
7456 % }{}%
7457 %}%
7458 % \end{verbatim}
7459 % \end{macro}
7460 % \end{macro}
7461 %
7462 % \subsection{APS Sanity Checking}\label{sec:aps-sanity}
7463 % \changes{4.1f}{2009/07/20}{(AO, 524) Makes no sense if citations are superscript numbers and so are footnotes}
7464 %
7465 % Rule: if \cmd\place@bibnumber\ is \cmd\place@bibnumber@sup\
7466 % (citations are numbered and set superscript),
7467 % then it makes no sense for \cmd\footinbib@sw\ to be \cmd\false@sw\
7468 % (footnotes set in the bibliography, as endnotes).
7469 % If both conditions prevailed, then the document would have footnotes
7470 % and citations both as superscript arabic numbers, but independently numbered,
7471 % which would be confusing.
7472 %
7473 % Any society that provides for both superscript numbered citations as well as for
7474 % numbered footnotes should check for this same condition, and deal with it.
7475 %
7476 % Note: an alternative would be for footnotes to use the same sequence of footnote devices
7477 % that are used by the frontmatter footnotes
7478 % (\cmd\frontmatter@thefootnote\ instead of arabic numbers).
7479 %
7480 % In this case, we would want to refrain from resetting \cmd\c@footnote\ at the end of
7481 % the title page formatting.
7482 % We would also want to treat body footnotes identically to frontmatter footnotes:
7483 % the assignments in \cmd\titleblock@produce\ would persist throughout the document.
7484 %
7485 % But APS do not choose to go that route.
7486 % \begin{macrocode}
7487 \appdef\setup@hook{%
7488 \@ifx{\place@bibnumber\place@bibnumber@sup}{%
7489 \footinbib@sw{}{%
7490 \class@warn{Citations are superscript numbers: footnotes must be endnotes; changing to that configuration}%
7491 \@booleantrue\footinbib@sw
7492 }%
7493 }{}%
7494 }%
7495 % \end{macrocode}
7496 %
7497 % Here ends the substyle for society APS.
7498 % \begin{macrocode}
7499 %</aps>
7500 % \end{macrocode}
7501 %
7502 %
7503 % \section{The \classoption{rmp} journal substyle: the \texttt{rmp} module}
7504 %
7505 % The file \file{apsrmp.rtx} is read in by the \classname{revtex4} document class
7506 % if \cmd\@society\ has the value \classoption{aps}
7507 % and \cmd\@journal\ has the value \classoption{rmp}.
7508 %
7509 % It is read at the end of the \file{aps.rtx}, so all definitions
7510 % and assignments in that file are operative unless overridden here.
7511 %
7512 %
7513 % \begin{macrocode}
7514 %<*rmp>
7515 % \end{macrocode}
7516 %
7517 % Protect this file from being read in by anything but \revtex.
7518 % \begin{macrocode}
7519 \ifx\undefined\substyle@ext
7520 \def\@tempa{%
7521 \endinput
7522 \GenericWarning{I must be read in by REVTeX! (Bailing out)}%
7523 }%
7524 \expandafter\else
7525 \def\@tempa{}%
7526 \expandafter\fi\@tempa
7527 % \end{macrocode}
7528 %
7529 % Protect this file from being read in as a society instead of a journal.
7530 % In such a case, \cmd\@journal\ will be undefined.
7531 % \begin{macrocode}
7532 \@ifxundefined\@journal{%
7533 % \end{macrocode}
7534 % One alternative: abort the document.
7535 % Another alternative: try to recover: force load the aps society file
7536 % \begin{macrocode}
7537 \class@warn{Please specify the REVTeX options [aps,rmp]!}%
7538 \@@end
7539 }{}%
7540 % \end{macrocode}
7541 % Log the journal substyle.
7542 % \begin{macrocode}
7543 \class@info{APS journal RMP selected}%
7544 % \end{macrocode}
7545 %
7546 % \subsection{Frontmatter}%
7547 %
7548 % We assign the titlepage style for RMP; a document instance
7549 % may override by invoking one of the class options of \revtex.
7550 % \begin{macrocode}
7551 \clo@groupedaddress
7552 % \end{macrocode}
7553 %
7554 % \begin{macro}{\frontmatter@setup}
7555 %
7556 % \begin{macrocode}
7557 \def\frontmatter@setup{%
7558 \normalfont\sffamily\raggedright
7559 }%
7560 % \end{macrocode}
7561 % \end{macro}
7562 %
7563 % \begin{macro}{\PACS@warn}
7564 % Per Mark Doyle, RMP never displays the PACS, so they don't want the `use showpacs' warning spit out.
7565 % \begin{macrocode}
7566 \def\PACS@warn{RMP documents do not display PACS. Your \string\pacs\space will be ignored}%
7567 % \end{macrocode}
7568 % \end{macro}
7569 %
7570 % \begin{macro}{\frontmatter@title@above}
7571 % \begin{macro}{\frontmatter@title@format}
7572 % \begin{macro}{\frontmatter@title@below}
7573 %
7574 % \begin{macrocode}
7575 \def\frontmatter@title@above{}%
7576 \def\frontmatter@title@format{\Large\bfseries\raggedright}% HelveticaNeue-Medium(Italic) 14pt.
7577 \def\frontmatter@title@below{\addvspace{12\p@}}% 24pt b-b down to first author
7578 % \end{macrocode}
7579 % \end{macro}
7580 % \end{macro}
7581 % \end{macro}
7582 %
7583 % \begin{macro}{\frontmatter@authorformat}
7584 % \changes{4.1b}{2008/08/04}{Rag the right even more: .8\cs{hsize}. Also, assign \cs{@totalleftmargin}.}%
7585 % \changes{4.1b}{2008/06/29}{(AO, 455) Be nice to a list within the abstract (assign \cs{@totalleftmargin}).}
7586 % Set the rag to a milder value, because we want to do true ragged right
7587 % typesetting, as opposed to the \LaTeX\ default, which gives very poor results.
7588 %
7589 % Note: author font is 9.8bp. 19.2bp/14.3bp above/below.
7590 % \begin{macrocode}
7591 \def\frontmatter@authorformat{%
7592 \preprintsty@sw{\vskip0.5pc\relax}{}%
7593 \@tempskipa\@flushglue
7594 \@flushglue\z@ plus.8\hsize
7595 \raggedright\advance\leftskip.5in\relax
7596 \@flushglue\@tempskipa
7597 \parskip\z@skip
7598 \@totalleftmargin\leftskip
7599 }%
7600 % \end{macrocode}
7601 % \end{macro}
7602 %
7603 % \begin{macro}{\frontmatter@affiliationfont}
7604 % \changes{4.1b}{2008/08/04}{As with author formatting, rag the right more, and assign \cs{@totalleftmargin}. Also neutralize \cs{def@after@address}.}%
7605 % \changes{4.1b}{2008/06/29}{(AO, 455) Be nice to a list within the abstract (assign \cs{@totalleftmargin}).}
7606 % The hook \cmd\frontmatter@affiliationfont\ controls the formatting of affiliations and affiliation groups.
7607 % The hook \cmd\frontmatter@above@affilgroup\ is invoked just before proceeding with author/affiliation processing.
7608 % The \cmd\frontmatter@above@affiliation\ is the amount of space above affiliations in the \classoption{groupedaddress} style,
7609 % and \cmd\frontmatter@above@affiliation@script\ is that for \classoption{superscriptaddress}.
7610 %
7611 % Note: affiliation font is 9.03/10.4bp, 14.3bp/19.2bp b-b above/below
7612 % \begin{macrocode}
7613 \def\frontmatter@affiliationfont{% Helvetica 9/10.2
7614 \small\slshape\selectfont\baselineskip10.5\p@\relax
7615 \@tempskipa\@flushglue
7616 \@flushglue\z@ plus.8\hsize
7617 \raggedright\advance\leftskip.5in\relax
7618 \@flushglue\@tempskipa
7619 \@totalleftmargin\leftskip
7620 \let\def@after@address\def@after@address@empty
7621 }%
7622 \def\frontmatter@above@affilgroup{\addvspace{7.2\p@}}% additional leading above an author
7623 \def\frontmatter@above@affiliation{\addvspace{5.3\p@}}%
7624 \def\frontmatter@above@affiliation@script{}%
7625 % \end{macrocode}
7626 % \end{macro}
7627 %
7628 % Set up the default RMP style for title block authors and affiliations.
7629 % We assign the titlepage style for RMP; a document instance
7630 % may override by invoking one of the class options of \revtex.
7631 % \changes{4.1b}{2008/08/04}{The \texttt{rmp} journal substyle selects \texttt{groupedaddress} by default.}%
7632 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
7633 %
7634 % This command should override the effect of the
7635 % corresponding command in the society substyle,
7636 % and any document class option bearing on same will in turn override.
7637 % \begin{macrocode}
7638 \clo@groupedaddress
7639 % \end{macrocode}
7640 %
7641 % \begin{macro}{\frontmatter@RRAP@format}
7642 % \changes{4.1b}{2008/06/29}{(AO, 455) Be nice to a list within the abstract (assign \cs{@totalleftmargin}).}
7643 % Note: in RMP, if we are not in preprint mode, the date will not be produced.
7644 %
7645 % Note: Helvetica C/lc, 8.98bp, space above: 16.3bp b-b.
7646 % \begin{macrocode}
7647 \def\frontmatter@RRAP@format{%
7648 \addvspace{7.3\p@}%
7649 \small
7650 \raggedright\advance\leftskip.5in\relax
7651 \@totalleftmargin\leftskip
7652 }%
7653 \def\produce@RRAP#1{%
7654 \@if@empty{#1}{}{%
7655 \@ifvmode{\leavevmode}{}%
7656 \unskip(\ignorespaces#1\unskip)\quad
7657 }%
7658 }%
7659 % \end{macrocode}
7660 % \end{macro}
7661 %
7662 % \begin{macro}{\frontmatter@abstractheading}
7663 % Space above 21.8bp b-b.
7664 % \begin{macrocode}
7665 \def\frontmatter@abstractheading{%
7666 \preprintsty@sw{%
7667 \begingroup
7668 \centering\large
7669 \abstractname
7670 \par
7671 \endgroup
7672 \vspace{.5pc}%
7673 }{}%
7674 }%
7675 % \end{macrocode}
7676 % \end{macro}
7677 %
7678 % \begin{macro}{\frontmatter@abstractfont}
7679 % TimesTen 8.93bp/9.6bp X 360bp, indented 36bp, with 21.9/37.6bp b-b above/below
7680 % \changes{4.1b}{2008/06/29}{(AO, 455) Be nice to a list within the abstract (assign \cs{@totalleftmargin}).}
7681 % \begin{macrocode}
7682 \def\frontmatter@abstractfont{%
7683 \footnotesize
7684 \hsize360\p@
7685 \leftskip=0.5in
7686 \parindent\z@
7687 \@totalleftmargin\leftskip
7688 }%
7689 % \end{macrocode}
7690 % \end{macro}
7691 %
7692 % \begin{macro}{\frontmatter@preabstractspace}
7693 % \begin{macro}{\frontmatter@postabstractspace}
7694 % Space above and space below abstract in title block.
7695 % Should be 22/36 points base-to-base.
7696 % \begin{macrocode}
7697 \def\frontmatter@preabstractspace{7.7\p@}%
7698 \def\frontmatter@postabstractspace{24.6\p@}%
7699 % \end{macrocode}
7700 % \end{macro}
7701 % \end{macro}
7702 %
7703 % FIXME: Not done: PACS.
7704 % FIXME: TOC: Head is same as \section: HelveticaNeue 8.98. 32/22bp b-b above/below,
7705 % Body: TimesTen 8/10.5.
7706 %
7707 % \subsection{General Text}%
7708 %
7709 % \changes{4.1b}{2008/07/01}{(AO) make settings at class time instead of deferring them to later.}
7710 % If not in preprint mode, RMP sets the type size to 10/12 point. Note: s/b 11.6bp leading
7711 %FIXME: define \cmd\normalsize\ only if nobody else has done so.
7712 % \begin{macrocode}
7713 \appdef\setup@hook{%
7714 \preprintsty@sw{}{%
7715 \def\normalsize{%
7716 \@setsize\normalsize{12pt}\xpt\@xpt
7717 \abovedisplayskip 10\p@ plus2\p@ minus5\p@
7718 \belowdisplayskip \abovedisplayskip
7719 \abovedisplayshortskip \abovedisplayskip
7720 \belowdisplayshortskip \abovedisplayskip
7721 \let\@listi\@listI
7722 }%
7723 }%
7724 }%
7725 % \end{macrocode}
7726 %
7727 % Footnote mods:
7728 % \changes{4.1n}{2010/01/02}{(AO, 571) class file must set \cs{splittopskip}; fine tune \cs{skip}\cs{footins}; \cs{footnoterule} defined in terms of \cs{skip}\cs{footins}}%
7729 % \begin{macrocode}
7730 \footnotesep 9.25pt
7731 \skip\footins 36pt plus 4pt minus 12pt
7732 \def\footnoterule{%
7733 \dimen@\skip\footins\divide\dimen@\thr@@
7734 \kern-\dimen@\hrule width.5in\kern\dimen@
7735 }%
7736 % \end{macrocode}
7737 %
7738 %
7739 % \subsection{Sectioning}
7740 % \changes{4.1b}{2008/08/04}{Use \cs{setup@hook} to initialize all.}
7741 % \changes{4.1b}{2008/08/01}{Section numbering via procedures \cs{secnums@rtx} and \cs{secnums@arabic}.}
7742 %
7743 % We override the meaning of \cmd\secnums@rtx.
7744 % The class option \classoption{secnumarabic} will continue to work.
7745 % \begin{macrocode}
7746 \def\secnums@rtx{%
7747 \@ifxundefined\thepart{%
7748 \def\thepart{\Roman{part}}%
7749 }{}%
7750 \@ifxundefined\thesection{%
7751 \def\thesection {\Roman{section}}%
7752 \def\p@section {}%
7753 }{}%
7754 \@ifxundefined\thesubsection{%
7755 \def\thesubsection {\Alph{subsection}}%
7756 \def\p@subsection {\thesection.}%
7757 }{}%
7758 \@ifxundefined\thesubsubsection{%
7759 \def\thesubsubsection {\arabic{subsubsection}}%
7760 \def\p@subsubsection {\thesection.\thesubsection.}%
7761 }{}%
7762 \@ifxundefined\theparagraph{%
7763 \def\theparagraph {\alph{paragraph}}%
7764 \def\p@paragraph {\thesection.\thesubsection.\thesubsubsection.}%
7765 }{}%
7766 \@ifxundefined\thesubparagraph{%
7767 \def\thesubparagraph {\arabic{subparagraph}}%
7768 \def\p@subparagraph {\thesection.\thesubsection.\thesubsubsection.\theparagraph.}%
7769 }{}%
7770 }%
7771 % \end{macrocode}
7772 %
7773 % In RMP, put a period (.), followed by `nut space', after the section number.
7774 % Also, hang the section number (the \LaTeX\ default).
7775 % \begin{macrocode}
7776 \def\@seccntformat#1{\csname the#1\endcsname.\hskip0.5em\relax}%
7777 % \end{macrocode}
7778 %
7779 % Note that we wish to set the section head uppercase, so we use
7780 % David Carlisle's \cmd\MakeTextUppercase. However, because this procedure effectively
7781 % parses its argument (looking for things to \emph{not} translate), it has to be invoked
7782 % in such a way that the argument of the \cmd\section\ command is passed to it as its
7783 % own argument.
7784 %
7785 % To accomplish this, we use the \cmd\@hangfrom@\ hook, which was developed for this
7786 % purpose.
7787 % \changes{4.1b}{2008/07/01}{Add \cs{@hangfroms@section}}
7788 % \begin{macrocode}
7789 \def\section{%
7790 \@startsection{section}{1}{\z@}{0.8cm plus1ex minus.2ex}{0.4cm}%
7791 {%
7792 \small\sffamily\bfseries\selectfont
7793 \raggedright
7794 \parindent\z@
7795 }%
7796 }%
7797 \def\@hangfrom@section#1#2#3{\@hangfrom{#1#2}\MakeTextUppercase{#3}}%
7798 \def\@hangfroms@section#1#2{#1\MakeTextUppercase{#2}}%
7799 \def\subsection{%
7800 \@startsection{subsection}{2}{\z@}{0.8cm plus1ex minus.2ex}{0.4cm}%
7801 {%
7802 \small\sffamily\bfseries
7803 \raggedright
7804 \parindent\z@
7805 }%
7806 }%
7807 \def\subsubsection{%
7808 \@startsection{subsubsection}{3}{\z@}{.8cm plus1ex minus.2ex}{0.4cm}%
7809 {%
7810 \small\sffamily\selectfont
7811 \raggedright
7812 \parindent\z@
7813 }%
7814 }%
7815 \def\paragraph{%
7816 \@startsection{paragraph}{4}{\z@}{.8cm plus1ex minus.2ex}{-1em}%
7817 {%
7818 \small\slshape\selectfont
7819 \raggedright
7820 \parindent\z@
7821 }%
7822 }%
7823 \def\subparagraph{%
7824 \@startsection{subparagraph}{4}{\parindent}{3.25ex plus1ex minus.2ex}{-1em}%
7825 {\normalsize\bfseries\selectfont}%
7826 }%
7827 %
7828 \setcounter{tocdepth}{4}% FIXME: has no effect
7829 % \end{macrocode}
7830 %
7831 % \begin{macro}{\appendix}
7832 % \begin{macro}{\@hangfrom@appendix}
7833 % \begin{macro}{\@hangfroms@appendix}
7834 % \begin{macro}{\@appendixcntformat}
7835 % \changes{4.1b}{2008/07/01}{Add \cs{@hangfroms@section}}
7836 % \begin{macrocode}
7837 \appdef\appendix{%
7838 \let\@hangfrom@section\@hangfrom@appendix
7839 \let\@sectioncntformat\@appendixcntformat
7840 }%
7841 \def\@hangfrom@appendix#1#2#3{%
7842 #1%
7843 \@if@empty{#2}{%
7844 #3%
7845 }{%
7846 #2\@if@empty{#3}{}{:\ #3}%
7847 }%
7848 }%
7849 \def\@hangfroms@appendix#1#2{%
7850 #1\appendixname\@if@empty{#2}{}{:\ #2}%
7851 }%
7852 \def\@appendixcntformat#1{\appendixname\ \csname the#1\endcsname}%
7853 % \end{macrocode}
7854 % \end{macro}
7855 % \end{macro}
7856 % \end{macro}
7857 % \end{macro}
7858 %
7859 %
7860 % \subsection{Figure and Table Caption Formatting}
7861 % \begin{macro}{\@makecaption}
7862 % \changes{4.1b}{2008/07/01}{Break out \cs{@caption@fignum@sep}}
7863 %
7864 % \begin{macrocode}
7865 \setlength\belowcaptionskip{2\p@}
7866 \long\def\@makecaption#1#2{%
7867 \vskip\abovecaptionskip
7868 \vbox{%
7869 \flushing
7870 \small\rmfamily
7871 \noindent
7872 #1\@caption@fignum@sep#2\par
7873 }%
7874 \vskip\belowcaptionskip
7875 }%
7876 \def\@caption@fignum@sep{\nobreak\hskip.5em plus.2em\ignorespaces}%
7877 % \end{macrocode}
7878 % \end{macro}
7879 %
7880 % \subsection{Citations and Bibliography}%
7881 %
7882 % Customize \revtex\ for the journal substyle;
7883 % this task requires three components:
7884 % a \BibTeX\ \file{.bst} style file,
7885 % customizing code for \file{natbib}, and
7886 % customizations of the \env{thebibliography} environment.
7887 %
7888 % \begin{macro}{\@bibstyle}
7889 % Define the argument of the \cmd\bibliographystyle\ command
7890 % (if the document does not do so).
7891 %
7892 % The user must have installed a \file{.bst} file of the corresponding name.
7893 % This file will then be used by \BibTeX\ when compiling the document's \file{.bbl} file.
7894 %
7895 % To generate \file{apsrmp.bst}, use \classname{custom-bib} version 3.89d1 or later.
7896 % Run the \file{.bst} generator, \file{makebst.tex}, with the following options:
7897 %
7898 % \def\QandA#1#2#3{\item#1: \textbf{#2}: \texttt{#3}---}%
7899 % \def\CandE#1{\item\relax\texttt{#1}---}%
7900 % \begin{enumerate}
7901 % \QandA{STYLE OF CITATIONS}{a}{ay}Author-year with some non-standard interface
7902 % \QandA{AUTHOR}{*}{nat}Natbib for use with natbib v5.3 or later
7903 % \QandA{LANGUAGE FIELD}{l}{lang}Use language field to switch hyphenation patterns for title
7904 % \QandA{PRESENTATIONS}{b}{pres,pres-bf}Presentation, speaker bold face
7905 % \QandA{ORDER ON VON PART }{x}{vonx}Sort without von part (de la Maire after Mahone)
7906 % \QandA{AUTHOR NAMES}{a}{nm-rev1}Only first name reversed, initials (AGU style: Smith, J. F., H. K. Jones)
7907 % \QandA{POSITION OF JUNIOR }{*}{jnrlst}Junior comes last as Smith, John, Jr.
7908 % \QandA{TYPEFACE FOR AUTHORS IN LIST OF REFERENCES}{u}{nmft,nmft-def}User defined author font (\cmd\bibnamefont)
7909 % \QandA{FONT FOR FIRST NAMES }{u}{fnm-def}First names in user defined font (\cmd\bibfnamefont)
7910 % \QandA{EDITOR NAMES IN INCOLLECTION ETC}{a}{nmfted}Editors incollection like authors font
7911 % \QandA{FONT FOR `AND' IN LIST}{r}{nmand-rm}`And' in normal font (JONES and JAMES)
7912 % \QandA{FONT OF CITATION LABELS IN TEXT }{u}{lab,lab-def}User defined citation font (\cmd\citenamefont)
7913 % \QandA{FONT FOR `AND' IN CITATIONS }{r}{and-rm}Cited `and' in normal font
7914 % \QandA{LABEL WHEN AUTHORS MISSING }{*}{keyxyr}Year blank when KEY replaces missing author (for natbib 7.0)
7915 % \QandA{DATE POSITION}{b}{dt-beg}Date after authors
7916 % \QandA{DATE FORMAT }{m}{yr-com}Date preceded by comma as `, 1993'
7917 % \QandA{INCLUDE MONTHS}{m}{aymth}Include month in date
7918 % \QandA{REVERSED DATE }{r}{dtrev}Date as year month
7919 % \QandA{TRUNCATE YEAR }{*}{note-yr}Year text full as 1990--1993 or `in press'
7920 % \QandA{TITLE OF ARTICLE}{d}{tit-qq}Title and punctuation in double quotes (``Title,'' ..)
7921 % \QandA{TITLE PRESENT IN ARTICLE, INCOLLECTION, AND INPROCEEDINGS}{x}{jtit-x}Title is ignored
7922 % \QandA{INPROCEEDINGS CHAPTER AND PAGES, LIKE INBOOK}{y}{inproceedings-chapter}produce pages after chapter just as in InBook
7923 % \QandA{ARTICLE BOOKTITLE PRESENT}{?}{article-booktitle}format booktitle
7924 % \QandA{ARTICLE SERIES PRESENT}{?}{article-series}article can has series
7925 % \QandA{JOURNAL NAME FONT}{r}{jttl-rm}Journal name normal font
7926 % \QandA{JOURNAL NAME WITH ADDRESS}{y}{journal-address}Include address field (in parentheses) along with journal name
7927 % \QandA{BOOK TITLE FIELDS}{y}{book-bt}Field `booktitle', or if absent field `title', is book title
7928 % \QandA{THESIS TITLE OPTIONAL}{?}{thesis-title-o}Title is optional: no warning issued if empty
7929 % \QandA{TECHNICAL REPORT TITLE}{b}{trtit-b}Tech. report title like books
7930 % \QandA{JOURNAL VOLUME}{b}{vol-bf}Volume bold as {\bf vol}(num)
7931 % \QandA{JOURNAL VOL AND NUMBER}{s}{vnum-sp}Journal vol (num) as 34 (2)
7932 % \QandA{VOLUME PUNCTUATION}{c}{volp-com}Volume with comma as vol(num), ppp
7933 % \QandA{PAGE NUMBERS}{f}{jpg-1}Only start page number
7934 % \QandA{POSITION OF PAGES}{e}{pp-last}Pages at end but before any notes
7935 % \QandA{BOOK EDITOR W/O AUTHOR}{}{book-editor-booktitle}Book permits empty author, produces title before editor in this case
7936 % \QandA{INBOOK PERMITS TITLE, BOOKTITLE, AUTHOR, EDITOR}{a}{inbook-editor-booktitle}Allow using both title/booktitle, both author/editor
7937 % \QandA{CONFERENCE ADDRESS FOR BOOK, INBOOK, INCOLLECTION, INPROCEEDINGS, PROCEEDINGS}{a}{bookaddress}Italic booktitle followed by bookaddress in roman
7938 % \QandA{NUMBER AND SERIES FOR BOOK, INBOOK, INCOLLECTION, INPROCEEDINGS, PROCEEDINGS}{*}{num-xser}Allows number without series and suppresses word "number"
7939 % \QandA{WORD NUMBER CAPITALIZED FOR NUMBER AND SERIES}{c}{number-cap}Capitalize word `number' as: "Number 123"
7940 % \QandA{WORD CHAPTER CAPITALIZED}{c}{chapter-cap}Capitalize word `chapter' as: `Chapter 42'
7941 % \QandA{COMBINING NUMBER AND SERIES}{x}{series-number}Series number as: `Springer Lecture Notes No. 125'
7942 % \QandA{POSITION OF NUMBER AND SERIES}{b}{numser-booktitle}After book title and conference address, and before editors
7943 % \QandA{VOLUME AND SERIES FOR BOOKS}{s}{ser-vol}Series, vol. 23
7944 % \QandA{VOLUME AND SERIES FORMATTING}{y}{ser-rm}format series roman , even when used with volume
7945 % \QandA{WORD VOLUME CAPITALIZED FOR VOLUME AND SERIES}{y}{volume-cap}Capitalize word `volume', as: `Volume 7 in Lecture Series'
7946 % \QandA{POSITION OF VOLUME AND SERIES FOR INCOLLECTION, INBOOK, AND INPROCEEDINGS}{e}{ser-ed}Series and volume after booktitle and before editors
7947 % \QandA{JOURNAL NAME PUNCTUATION}{x}{jnm-x}Space after journal name
7948 % \QandA{PAGES IN BOOK}{*}{pg-bk,book-chapter-pages}As chapter and page: chapter 42, page 345
7949 % \QandA{PUBLISHER IN PARENTHESES}{p}{pub-par}Publisher in parentheses
7950 % \QandA{EMPTY PUBLISHER PARENTHESES}{y}{ay-empty-pub-parens-x}eliminate parentheses altogether if nothing inside
7951 % \QandA{PUBLISHER POSITION}{e}{pre-edn}Edition before publisher
7952 % \QandA{SCHOOL}{p}{school-par}school/address in parens: `(school, address)'
7953 % \QandA{ISBN NUMBER}{*}{isbn}Include ISBN for books, booklets, etc.
7954 % \QandA{ISSN NUMBER}{*}{issn}Include ISSN for periodicals
7955 % \QandA{DOI NUMBER}{a}{doi-link,doi}Doi forms a link to the publication, anchored to the volume or title
7956 % \QandA{`EDITOR' AFTER NAMES}{a}{bkedcap}`Name Editor,' as above, editor upper case
7957 % \QandA{EDITOR IN COLLECTIONS}{b}{edby}In booktitle, edited by .. (where .. is names)
7958 % \QandA{PUNCTUATION BETWEEN SECTIONS }{c}{blk-com}Comma between blocks
7959 % \QandA{FINAL PUNCTUATION}{c}{fin-endbibitem}Command at end instead of period
7960 % \QandA{ABBREVIATE WORD `PAGES' }{a}{pp}`Page' abbreviated as p. or pp.
7961 % \QandA{ABBREVIATE WORD `EDITORS'}{a}{ed}`Editor' abbreviated as ed. or eds.
7962 % \QandA{OTHER ABBREVIATIONS}{a}{abr}Abbreviations of such words
7963 % \QandA{ABBREVIATION FOR `EDITION' }{a}{ednx}`Edition' abbreviated as `ed'
7964 % \QandA{EDITION NUMBERS}{n}{ord}Numerical editions as 1st, 2nd, 3rd, etc
7965 % \QandA{STORED JOURNAL NAMES}{a}{jabr}Abbreviated journal names
7966 % \QandA{COMMA BEFORE `AND'}{c}{and-com}Comma even with 2 authors as `Tom, and Harry'
7967 % \QandA{FONT OF `ET AL'}{i}{etal-it}Italic et al
7968 % \QandA{ADDITIONAL REVTeX DATA FIELDS}{r}{revdata,eprint,url,url-blk,translation}Include REVTeX data fields collaboration, eid, eprint, archive, url, translation
7969 % \QandA{SLACcitation FIELD}{?}{SLACcitation}Produce SLACcitation field
7970 % \QandA{NUMPAGES DATA FIELD}{*}{numpages-x}Do not include numpages field
7971 % \QandA{REFERENCE COMPONENT TAGS}{b}{bibinfo}Reference component tags like \cmd\bibinfo\ in the content of \cmd\bibitem
7972 % \QandA{ELEMENT TAGS}{b}{bibfield}Element tags like \cmd\bibfield\ in the content of \cmd\bibitem
7973 % \QandA{COMPATIBILITY WITH PLAIN TEX}{*}{nfss}Use LaTeX commands which may not work with Plain TeX
7974 % \end{enumerate}
7975 %
7976 % A file \file{apsrmp.dbj} file equivalent to the following should result:
7977 % \begin{verbatim}
7978 %\input docstrip
7979 %\preamble
7980 %----------------------------------------
7981 %*** REVTeX-compatible RMP 2010-02-12 ***
7982 %\endpreamble
7983 %\postamble
7984 %End of customized bst file
7985 %\endpostamble
7986 %\keepsilent
7987 %\askforoverwritefalse
7988 %\def\MBopts{\from{merlin.mbs}{%
7989 % head,\MBopta}
7990 %\from{physjour.mbs}{\MBopta}
7991 %\from{geojour.mbs}{\MBopta}
7992 %\from{photjour.mbs}{\MBopta}
7993 %\from{merlin.mbs}{tail,\MBopta}}
7994 %\def\MBopta{%
7995 % ay,%: Author-year with some non-standard interface
7996 % nat,%: Natbib for use with natbib v5.3 or later
7997 % lang,%: Use language field to switch hyphenation patterns for title
7998 % pres,pres-bf,%: Presentation, speaker bold face
7999 % vonx,%: Sort without von part (de la Maire after Mahone)
8000 % nm-rev1,%: Only first name reversed, initials (AGU style: Smith, J. F., H. K. Jones)
8001 % jnrlst,%: Junior comes last as Smith, John, Jr.
8002 % nmft,nmft-def,%: User defined author font (\bibnamefont)
8003 % fnm-def,%: First names in user defined font (\bibfnamefont)
8004 % nmfted,%: Editors incollection like authors font
8005 % nmand-rm,%: `And' in normal font (JONES and JAMES)
8006 % lab,lab-def,%: User defined citation font (\citenamefont)
8007 % and-rm,%: Cited `and' in normal font
8008 % keyxyr,%: Year blank when KEY replaces missing author (for natbib 7.0)
8009 % dt-beg,%: Date after authors
8010 % yr-par,%: Year in parentheses as (1993)
8011 % dtrev,%: Date as year month
8012 % date-nil-x,%: If date is empty, then do not produce the surrounding punctuation (parens, brackets, colon, comma)
8013 % tit-qq,%: Title and punctuation in double quotes (``Title,'' ..)
8014 % inproceedings-chapter,%: produce pages after chapter, just as in InBook
8015 % jtit-x,%: Title is ignored
8016 % inproceedings-chapter,%: produce pages after chapter just as in InBook
8017 % article-booktitle,%: format booktitle
8018 % article-series,%: article can has series
8019 % jttl-rm,%: Journal name normal font
8020 % journal-address,%: Include address field (in parentheses) along with journal name
8021 % book-bt,%: Field `booktitle', or if absent field `title', is book title
8022 % thesis-title-o,%: Title is optional: no warning issued if empty
8023 % trtit-b,%: Tech. report title like books
8024 % techreport-institution-par,%: format tech report institution like book publisher
8025 % vol-bf,%: Volume bold as {\bf vol}(num)
8026 % vnum-sp,%: Journal vol (num) as 34 (2)
8027 % volp-com,%: Volume with comma as vol(num), ppp
8028 % jpg-1,%: Only start page number
8029 % pp-last,%: Pages at end but before any notes
8030 % book-editor-booktitle,%: Book permits empty author, produces title before editor in this case
8031 % inbook-editor-booktitle,%: Allow using both title/booktitle, both author/editor
8032 % bookaddress,%: Italic booktitle followed by bookaddress in roman
8033 % num-xser,%: Allows number without series and suppresses word "number"
8034 % number-cap,%: Capitalize word `number' as: "Number 123"
8035 % chapter-cap,%: Capitalize word `chapter' as: `Chapter 42'
8036 % series-number,%: Series number as: `Springer Lecture Notes No. 125'
8037 % numser-booktitle,%: After book title and conference address, and before editors
8038 % ser-vol,%: Series, vol. 23
8039 % ser-rm,%: format series roman , even when used with volume
8040 % volume-cap,%: Capitalize word `volume', as: `Volume 7 in Lecture Series'
8041 % ser-ed,%: Series and volume after booktitle and before editors
8042 % jnm-x,%: Space after journal name
8043 % pg-bk,book-chapter-pages,%: As chapter and page: chapter 42, page 345
8044 % pub-par,%: Publisher in parentheses
8045 % ay-empty-pub-parens-x,%: eliminate parentheses altogether if nothing inside
8046 % pre-edn,%: Edition before publisher
8047 % school-par,%: school/address in parens: `(school, address)'
8048 % isbn,%: Include ISBN for books, booklets, etc.
8049 % issn,%: Include ISSN for periodicals
8050 % doi-link,doi,%: Doi forms a link to the publication, anchored to the volume or title
8051 % bkedcap,%: `Name Editor,' as above, editor upper case
8052 % edby,%: In booktitle, edited by .. (where .. is names)
8053 % blk-com,%: Comma between blocks
8054 % fin-endbibitem,%: Command at end instead of period
8055 % pp,%: `Page' abbreviated as p. or pp.
8056 % ed,%: `Editor' abbreviated as ed. or eds.
8057 % abr,%: Abbreviations of such words
8058 % ednx,%: `Edition' abbreviated as `ed'
8059 % ord,%: Numerical editions as 1st, 2nd, 3rd, etc
8060 % jabr,%: Abbreviated journal names
8061 % and-com,%: Comma even with 2 authors as `Tom, and Harry'
8062 % etal-it,%: Italic et al
8063 % revdata,eprint,url,url-blk,translation,%: Include REVTeX data fields collaboration, eid, eprint, archive, url, translation
8064 % SLACcitation,%: Produce SLACcitation field
8065 % numpages-x,%: Do not include numpages field
8066 % url,url-prefix-x,%: URL without prefix (default: `URL ')
8067 % bibinfo,%: Reference component tags like \bibinfo in the content of \bibitem
8068 % bibfield,%: Element tags like \bibfield in the content of \bibitem
8069 % nfss,%: Use LaTeX commands which may not work with Plain TeX
8070 %,{%
8071 % }}
8072 %\generate{\file{apsrmp4-1.bst}{\MBopts}}
8073 %\endbatchfile
8074 % \end{verbatim}
8075 %
8076 % For a comparison between apsrmp.bst and apsrev.bst, see Section~\ref{sec:CompRevRmp}.
8077 %
8078 % \changes{4.1c}{2008/08/15}{Document class option longbibliography via \cs{substyle@post}}
8079 % \begin{macrocode}
8080 \def\@bibstyle{apsrmp\substyle@post}%
8081 % \end{macrocode}
8082 % \end{macro}
8083 %
8084 % \begin{macro}{\authoryear@sw}
8085 % \changes{4.1a}{2008/01/18}{(AO, 457) Endnotes to be sorted in with numerical citations.}%
8086 % Author-year citations: default value of \cmd\authoryear@sw\ is true.
8087 % \begin{macrocode}
8088 \@booleantrue\authoryear@sw
8089 % \end{macrocode}
8090 % \end{macro}
8091 %
8092 % \begin{macro}{\@bibdataout@rmp}
8093 % \changes{4.1o}{2010/02/12}{(AO, 580) Control .bst at run time.}%
8094 % When the journal is RMP, the meaning of the procedure \cmd\@bibdataout@aps\ needs to be different
8095 % because of the way the author names are formatted. In other respects, it is the same.
8096 % \begin{macrocode}
8097 \def\@bibdataout@aps{%
8098 \immediate\write\@bibdataout{%
8099 % \end{macrocode}
8100 % An entry that controls processing of the \filename{.bst} file has entry type \texttt{@CONTROL}.
8101 % This entry's cite key is \texttt{apsrmp41Control}, which serves as a version number.
8102 % \begin{macrocode}
8103 @CONTROL{%
8104 apsrmp41Control%
8105 % \end{macrocode}
8106 % Say whether we want long bibliography style (the default), or the abbreviated style.
8107 % \begin{macrocode}
8108 \longbibliography@sw{%
8109 ,author="03",editor="0",pages="1",title="0",year="0"%
8110 }{%
8111 ,author="0B",editor="0",pages="0",title="",year="1"%
8112 }%
8113 }%
8114 }%
8115 % \end{macrocode}
8116 % Place a \cmd\citation\ into the auxiliary file corresponding to this entry.
8117 % \begin{macrocode}
8118 \if@filesw
8119 \immediate\write\@auxout{\string\citation{apsrmp41Control}}%
8120 \fi
8121 }%
8122 % \end{macrocode}
8123 % \end{macro}
8124 %
8125 % \begin{macro}{\bibpunct}
8126 % \begin{macro}{\bibsection}
8127 % \begin{macro}{\bibpreamble}
8128 % \begin{macro}{\newblock}
8129 % \begin{macro}{\bibhang}
8130 % \begin{macro}{\bibsep}
8131 % \begin{macro}{\cite}
8132 % The following commands effectively establish the style in which \cmd\cite\ commands are
8133 % formatted.
8134 % You can think of them as the second needed component for the bibliography.
8135 %
8136 % Set up for author-year citations:
8137 % when \cmd\NAT@set@cites\ executes (at \envb{document} time), the \cmd\@biblabel\ will
8138 % be set to \cmd\NAT@biblabel.
8139 %
8140 % Per Karie Friedman ([email protected]), multiple citations are separated by semicolons, e.g.,
8141 % (Jones, 1999; Abbott and Smith, 2000; Wortley, 2001a),
8142 % and
8143 % multiple citations by the same author by commas, e.g.,
8144 % Abela et al. (1995, 1997a, 1997b).
8145 % The third argument of \cmd\bibpunct\ handles the former.
8146 %
8147 % The fifth argument puts a comma after the author when the year is not in parens:
8148 % (Lee et al., 1996).
8149 %
8150 % Incidently, this \cmd\bibpunct\ command specifies the \classname{natbib} default values.
8151 %
8152 % We define the sectioning command to use when starting the bibliography.
8153 %
8154 % We change \classname{natbib}'s \cmd\NAT@def@citea\ procedure to effect more elaborate
8155 % punctuation for RMP: see item 473:
8156 % \cmd\cite\ order punctuation: ``If possible, \cmd\textcite should put the word 'and' between two citations and before the last citation in a list of 3 or more.''
8157 %
8158 % \begin{macrocode}
8159 \appdef\setup@hook{%
8160 % \end{macrocode}
8161 %
8162 % We define the punctuation to use in the \cmd\cite\ command's production.
8163 %
8164 % \begin{macrocode}
8165 \bibpunct{(%)
8166 }{%(
8167 )}{;}{a}{,}{,}%
8168 % \end{macrocode}
8169 %
8170 % We define the sectioning command to use when starting the bibliography.
8171 %
8172 % \begin{macrocode}
8173 \def\bibsection{%
8174 \expandafter\section\expandafter*\expandafter{\refname}%
8175 \@nobreaktrue
8176 }%
8177 \let\bibpreamble\@empty
8178 \def\newblock{\ }%
8179 \bibhang10\p@
8180 \bibsep\z@
8181 % \end{macrocode}
8182 %
8183 % Per Mark Doyle, \cmd\cite\ is mapped to \cmd\citep\ in RMP.
8184 % \changes{4.1i}{2009/10/23}{(AO, 541) Defer assignment of \cs{cite} until after natbib loads}
8185 % \begin{macrocode}
8186 \let\cite\citep
8187 % \end{macrocode}
8188 %
8189 % End of code to be delayed until after \classname{natbib} loads.
8190 % \begin{macrocode}
8191 }%
8192 % \end{macrocode}
8193 % \end{macro}
8194 % \end{macro}
8195 % \end{macro}
8196 % \end{macro}
8197 % \end{macro}
8198 % \end{macro}
8199 % \end{macro}
8200 %
8201 % \begin{macro}{\footinbib@sw}
8202 % Footnotes in bibliography are consistent only with numbered citations,
8203 % and are particularly nasty under \classname{natbib}:
8204 % the packcage will automatically change to numbered references if
8205 % any \cmd\bibitem\ commands lack the optional argument.
8206 % Therefore, we must uninvoke it now, even if invoked by the document.
8207 % The same is quietly done with
8208 % \classname{natbib}'s \classoption{mcite} and \classoption{compress} options.
8209 %
8210 % \changes{4.1f}{2009/07/15}{(AO, 523) Add class option nomerge, to turn off new natbib 8.3 syntax}
8211 % (AO 523) I changed the code that alters \cmd\NAT@merge\ so that it will not override
8212 % when \cmd\NAT@merge\ has been set to \cmd\z@.
8213 % \begin{macrocode}
8214 \@booleanfalse\footinbib@sw
8215 \appdef\setup@hook{%
8216 \footinbib@sw{%
8217 \class@warn{%
8218 Footnotes in bibliography are incompatible with RMP.^^J%
8219 Undoing the footinbib option.
8220 }%
8221 \@booleanfalse\footinbib@sw
8222 }{}%
8223 \@ifnum{\NAT@merge>\@ne}{\let\NAT@merge\@ne}{}%
8224 \def\NAT@cmprs{\z@}%
8225 }%
8226 % \end{macrocode}
8227 % \end{macro}
8228 %
8229 % \begin{macro}{\eprint}
8230 % RMP requires the \cmd\eprint\ field in the bib entry to be set off with the word ``eprint''.
8231 % \begin{macrocode}
8232 \def\eprint#1{eprint #1}%
8233 % \end{macrocode}
8234 % \end{macro}
8235 %
8236 % \subsection{Table of Contents}
8237 %
8238 % We set up for auto-sizing of certain TOC elements.
8239 %
8240 % To do this, we override the definitions for
8241 % the default TOC font (\cmd\toc@@font),
8242 % and define
8243 % formatting for the needed elements (\cmd\l@\dots).
8244 % Finally, we activate the autosizing by
8245 % assigning \cmd\toc@pre\ and \cmd\toc@post.
8246 %
8247 % \begin{macro}{\toc@@font}
8248 % \changes{4.1a}{2008/01/19}{(AO, 461) Change the csname revtex uses from @dotsep to ltxu@dotsep. The former is understood in mu. (What we wanted was a dimension.)}%
8249 % Set the formatting characteristics of the auto-indenting part
8250 % of the TOC.
8251 % \begin{macrocode}
8252 \def\toc@@font{%
8253 \footnotesize\rmfamily
8254 \def\\{\space\ignorespaces}%
8255 }%
8256 \def\ltxu@dotsep{5.5pt}%
8257 % \end{macrocode}
8258 % \end{macro}
8259 %
8260 % \begin{macro}{\l@section}
8261 % Determine which TOC elements are automatically indented.
8262 % \begin{macrocode}
8263 \def\tocleft@{\z@}%
8264 \def\tocdim@min{5\p@}%
8265 \def\l@section{%
8266 \l@@sections{}{section}% Implicit #3#4
8267 }%
8268 \def\l@subsection{%
8269 \l@@sections{section}{subsection}% Implicit #3#4
8270 }%
8271 \def\l@subsubsection{%
8272 \l@@sections{subsection}{subsubsection}% Implicit #3#4
8273 }%
8274 %\def\l@subsubsection#1#2{}%
8275 \def\l@paragraph#1#2{}%
8276 \def\l@subparagraph#1#2{}%
8277 % \end{macrocode}
8278 % \end{macro}
8279 %
8280 % Activate the TOC processing.
8281 % \begin{macrocode}
8282 \let\toc@pre\toc@pre@auto
8283 \let\toc@post\toc@post@auto
8284 % \end{macrocode}
8285 %
8286 %
8287 % \begin{macrocode}
8288 %</rmp>
8289 % \end{macrocode}
8290 %
8291 %
8292 % \Finale
8293 % %Here ends the programmer's documentation.
8294 % \endinput
8295 %
8296 \endinput