%% ****** Start of file authguide.tex ****** %
%%
%%   This file is part of the APS files in the REVTeX 4 distribution.
%%   Version 4.0 of REVTeX, July, 2001.
%%
%%   Copyright (c) 2001 The American Physical Society.
%%
%%   See the REVTeX 4 README file for restrictions and more information.
%%
\documentclass[twocolumn,secnumarabic,amssymb, nobibnotes, aps, prd]{revtex4}
%\usepackage{acrofont}%NOTE: Comment out this line for the release version!
\newcommand{\revtex}{REV\TeX\ }
\newcommand{\classoption}[1]{\texttt{#1}}
\newcommand{\macro}[1]{\texttt{\textbackslash#1}}
\newcommand{\m}[1]{\macro{#1}}
\newcommand{\env}[1]{\texttt{#1}}

\begin{document}

\title{APS Compuscript Guide for \revtex\ 4\\(Version 1.0)}%

\author{The American Physical Society}%
\email[REVTeX Support: ]{revtex@aps.org}
\affiliation{1 Research Road, Ridge, NY 11961}
\date{July 16, 2001}%
\maketitle
\tableofcontents

\section{Introduction}
The American Physical Society journals receive over 24,000 unsolicited
manuscripts each year of which over 14,000 are published after peer
review. The goal of the APS compuscript program is to expedite the
handling of these manuscripts while reducing costs and avoiding
unnecessary duplication of effort. A \textit{compuscript} is an
author-prepared electronic file that adheres to specific guidelines
designed to maximize the likelihood that the manuscript will go
through our editorial and production processes in as automated a way
as possible. This document sets forth the current guidelines. At this
time, only files prepared with \revtex\ 3 or \revtex\ 4 can be
considered as compuscripts. Please note that using \revtex\ 3 or 4 is
a necessary, but not sufficient, condition for a manuscript to be a
compuscript. Over the next year, \revtex\ 3 will be phased out. Thus,
authors should switchover to \revtex\ 4 as soon as possible.

In addition to the obvious goal of publishing journals containing
significant new physics with high-quality typesetting, the APS also
strives to create true long-term archival versions of all that we
publish. In particular, we currently produce richly tagged SGML/XML
files that can be used to create online journals with robust features
such as linked references and fielded searching. These SGML/XML files
ultimately will be used to create online readable versions of the
article with flexible formatting.

Even before journal production, the APS editorial process can make use
of the information in a properly prepared manuscript. Information such
as title, authors, affiliations, PACS codes, etc. can be automatically
extracted and used to populate our manuscript database. References can
also be culled, cross-checked for accuracy, and used to create a
linked version for referees and editors. Moreover, time can be saved
as referrals can be made electronically rather than by conventional
mail. Thus, a well-prepared electronic manuscript can enhance the
entire peer review process from author to reader while making the
whole process less expensive.

One of the main design goals of \revtex~4 was to simplify the way
data is marked up in maunscripts. This means that new macros (or new
ways of using old macros) have been introduced in \revtex\ 4 in order
to better make use of author keystrokes throughout the editorial and
journal production processes. A proper compuscript should be able to
go through automated processes to create richly tagged data. APS has
worked with our vendors to develop tools to screen manuscripts at
submission time to ensure that they are likely to convert cleanly
during production. Manuscripts which fail to pass the screening
process will not qualify as compuscripts. They will require rekeying
during production which can result in errors and may result in a delay
in publication. Furthermore, increased page charges (or other future
charges) may apply.

The following sections detail what is required for a \revtex~4
manuscript to qualify as a compuscript. As we improve our editorial
and production processes, these requirements may change. This document
will be kept up to date and the definitive version will be available
at \url{http://publish.aps.org/revtex4/}. For more complete
descriptions of how to use the \revtex\ 4 macros, please see the
\revtex~4 Author's Guide included with the \revtex~4
distribution. Questions about \revtex\ 4 and compuscripts may be
emailed to \texttt{revtex@aps.org}.

\section{Formatting}
\subsection{Preprint vs. twocolumn}
All manuscripts that are submitted to APS must format correctly under
the \classoption{preprint} class option.  \revtex\ 4 is designed to
make it straightforward to switch between two-column and single-column
formatting just by changing the class option. Authors may submit with
the \classoption{twocolumn} class option, but this will be changed to
the \classoption{preprint} class option upon submission. It is
imperative that authors check that their papers will format properly
when this change is made. Papers which don't format correctly under
\classoption{preprint} may be delayed or may not qualify as a
compuscript at all.

The \classoption{preprint} primarily does three things: It increases
the font size to 12pt, increases the line spacing, and changes the
formatting to single-column. The changes in font size and spacing can
cause problems. In particular, equations and tables may need to be
re-formatted. Please see Section \ref{sec:tables} for details in
fixing table problems.

\subsection{Paper size}
Manscripts should be submitted to APS formatted for letter size
paper. Papers will be sent to referees electronically and they may
want to print them out. Letter size formatting ensures that this will
be trouble free for all referees.

\section{Marking up front matter}
Perhaps the most important macro changes in \revtex\ 4 are those
pertaining to the markup of the front matter (title, authors,
affiliations, abstract, PACS codes, etc.). While the macros are very
similar to the \revtex\ 3 or \LaTeXe\ \texttt{article} class macros, their usage
is quite different. Authors must follow the \revtex\ 4 usage if they
want their manuscripts to qualify as compuscripts. Note that proper
use of the \revtex\ 4 macros means that explicit centering environments
in the front matter are not needed and must not be used.

\subsection{Title}
The title of the manuscript must be specified using the \m{title} macro. A
double backslash {\textbackslash\textbackslash} may be used to force a line break in a long
title.

\subsection{Authors, affiliations, and collaborations}
\label{sec:authors}
The markup of authors and affiliations is perhaps the most significant change from \revtex\ 3 and the \LaTeX\ \texttt{article} class. To qualify as a compuscript, the following rules must be followed.
\begin{itemize}
\item Each \m{author} macro must contain only one author's
name. \revtex\ 4 automatically puts in all commas and the word `and.'
\item Use the \m{surname} macro to explicitly indicate if an author's family name consists of more than one name or if the family name is not the author's last name.
\item The \m{email} macro may be used to specify an author's e-mail
address. The \m{thanks} macro must not be used for this. Only the
e-mail address itself may appear in the macro's required argument.
\item The \m{homepage} macro may be used to specify a URL associated
with an author. The \m{thanks} macro must not be used for this. Only the
URL may appear in the macro's required argument.
\item The \m{altaffiliation} macro may be used to specify an alternate
affiliation or temporary address for an author. The \m{thanks} macro
must not be used for this. Only the affiliation
may appear in the macro's required argument.
\item The \m{thanks} macro may be used only if one of the more
specific macros list above does not apply.
\item Each \m{affiliation} macro must contain only a single affiliation.
\item Superscripts linking authors to affiliations must be
accomplished using the \classoption{superscriptaddress} class option
rather than putting in explicit superscripts by hand.
\item A collaboration may be specified by using the \m{collaboration}
macro. The \m{author} macro must not be used for collaborations.
\end{itemize}
\subsection{Abstract}
The abstract must be specified using the \env{abstract}
environment. Note that in \revtex\ 4, the abstract must come before
the \m{maketitle} command.

\subsection{PACS codes}
If supplying suggested PACS codes, they must be supplied as a
comma-separated list using a single \m{pacs} macro.

\section{References and footnotes}
\revtex\ 4 comes with two Bib\TeX\ style files for formatting
references, one for the \textit{Physical Review} journals, the other
for \textit{Review of Modern Physics}. Authors are strongly encouraged
to use Bib\TeX\ when preparing their bibliographies. The new style
files add additional markup via the \m{bibinfo} macro. At this time it
is not a requirement to use these Bib\TeX\ styles, but it may become
one in the future.  If Bib\TeX\ is used, current production processes
require that the \texttt{.bbl} file be included directly into the
manuscript's main \texttt{.tex} file. The following apply whether
Bib\TeX\ is used or not.
\begin{itemize}
\item Authors must use the \m{cite} and \m{bibitem} macros to create
bibliographies and to refer to items in the bibliography. ``By hand"
numbering of references is not acceptable.
\item Footnotes must be specified using the \m{footnote}
macro. \revtex\ 4 will automatically place the footnotes at the end of
the bibliography by default for the Physical Review
journals. Footnotes giving additional information about authors (such
as e-mail addresses) must not be specified using the \m{footnote}
macro (see Section~\ref{sec:authors}).
\item Custom footnotes using \m{footnotemark} and \m{footnotetext} are
not allowed (except in the context of tables (see
Section~\ref{sec:tablenotes}))
\item References should be formatted and specified according to the
\textit{Physical Review Style Guide}. Note
that using Bib\TeX\ automatically ensures this.
\item In journal styles that use superscript citations (\textit{e.g.}, Phys.~Rev.~B), use \m{onlinecite} to create references that appear on the baseline (\textit{i.e.}, Ref.~4). For
superscript citations, use the proper journal class option  rather than creating superscripts by hand.
\item URL's should be specified using the \m{url} macro. Bib\TeX\ will automatically take
care of this if the \texttt{url} field is used.
\item E-print identifiers should be included using the \m{eprint} macro. Bib\TeX\ will automatically take care of this if the \texttt{eprint} field is used.
\end{itemize}

\section{Body of the paper}
\subsection{Sectioning and cross-referencing}
For sectioning a manuscript, the basic rule is to use the appropriate
sectioning commands (\m{section}, \m{subsection}, \m{subsubsection},
\textit{etc.}). Cross-referencing a section must be done by using the
proper \m{label} and \m{ref} commands. Cross-referencing by hand is
not allowed. \m{part}, \m{chapter}, and \m{subparagraph} should not be
used.

\subsection{Appendices}
Appendices should be specified using the \m{appendix} command which
specifies that all following sections create with the \m{section}
commands are appendices. If there is only one appendix, then the
\m{appendix*} command should be used instead.

\subsection{Acknowledgments}
Any acknowledgments should be included by using the
\env{acknowledgments} environment. Note that in \revtex~4, this is now
an environment and not a macro.

\subsection{Counters}
No counters may be created and the standard ones may not be
altered. If an exceptional label is needed for an equation, the \m{tag}
macro (requires the \classoption{amsmath} class option) should be used.

\subsection{Fonts}
It is preferable to avoid the older \TeX\ and \LaTeX\ 2.09 macros for
controlling fonts such as \m{rm}, \m{it}, \textit{etc.} Rather, it is
better to use the macros introduced in \LaTeXe.  If the older font
commands are used (they really should be avoided!), be sure to use
curly braces to properly limit the extent of the font
change. \verb+{\bf ...}+ is the correct method.
Commands for controlling text and math font changes are summarized in
Table~\ref{tab:fonts}.

\begin{table}
\caption{\label{tab:fonts}\LaTeXe\ and AMS-\LaTeX\ font summary.}
\begin{ruledtabular}
\begin{tabular}{lp{2in}}
\m{textit} & Italics. Replaces \m{it}.\\
\m{textbf} & Bold face. Replaces \m{bf}.\\
\m{textrm} & Roman. Replaces \m{rm}.\\
\m{textsl} & Slanted. Replaces \m{sl}.\\
\m{textsc} & Small caps. Replaces \m{sc}.\\
\m{textsf} & Sans serif. Replaces \m{sf}.\\
\m{texttt} & Typewriter. Replaces \m{tt}.\\
\m{textmd} & Medium series.\\
\m{textnormal} & Normal.\\
\m{textup} & Upright.\\
\m{mathbf} & Bold face.\\
\m{mathcal} & Replaces \m{cal}.\\
\m{mathit} & Italics.\\
\m{mathnormal} & Replaces \m{mit}.\\
\m{mathsf} & Sans serif.\\
\m{mathtt} & Typewriter.\\
\m{mathfrak} & Fraktur. Requires \classoption{amsfonts} or \classoption{amssymb} class option.\\
\m{mathbb} & Bold blackboard. Requires \classoption{amsfonts} or \classoption{amssymb} class option.\\
\m{bm} & Bold Greek and other math symbols. Requires
\verb+\usepackage{bm}+ and may require the \classoption{amsfonts} class
option.
\end{tabular}
\end{ruledtabular}
\end{table}

Bold Greek letters and other bold math symbols should be accomplished
with the use of \texttt{bm.sty} which is distributed as a required
tool with the latest versions of \LaTeXe\ and should be loaded via
\verb+\usepackage{bm}+. This package introduces the \m{bm}
macro. This replaces the \revtex\ 3 macro \m{bbox} which is now
disallowed.  Some bold characters may require using the
\classoption{amsfonts} class option.

New fonts may not be declared with \m{newfont}. Font attribute
commands for selecting a font family, shape, and series are all
disallowed; the standard \LaTeXe\ font selection macros list above
should be used instead.

Finally, the \m{symbol} macro is also not allowed.

\subsection{Environments}
\subsubsection{Lists}
The standard list environments \texttt{itemize}, \texttt{enumerate},
and \texttt{description} are allowed. The \m{item} macro with or without
the optional argument is also allowed. Customization of the list environments
(with macros such as \m{labelstyle}, \m{labelitemi}, \m{labelenumi},
\m{itemsep}, etc.) is allowed but may be ignored in production.
Generalized lists (\m{begin\{list\}}) and trivial lists
(\m{begin\{trivlist\}}) are not allowed.

\subsubsection{Other Environments}
Creating generalized new environments with \m{newenvironment} is not
allowed. Creating a new theorem environment with \m{newtheorem} is
allowed though.

The tabbing environment and the macros \m{=}, \m{$>$}, \m{`}, and
\m{'} are allowed but may be ignored in production. Conversion
programs used in production should recognize the escapes \m{a=},
\m{a'}, and \m{a`} for using the corresponding accents within a
tabbing environment though.

The \env{verbatim} environment is allowed.

\subsection{Boxes}
Most boxes and macros to manipulate them are not allowed. These
include \m{raisebox}, \m{parbox}, \m{minipage}, \m{rulebox},
\m{framebox}, \m{mbox}, \m{fbox}, \m{savebox}, \m{newsavebox},
\m{sbox}, \m{usebox} and the environment \m{begin\{lrbox\}}. Rules
produced with \m{rule} are not allowed.

\subsubsection{Margin Notes}
Margin notes created with \m{marginpar} are not allowed, as are the
associated style parameters \m{marginparwidth}, \m{marginparsep}, and
\m{marginparpush}.


\section{Math Markup}
In general, all math markup and the standard math environments from
\LaTeXe\ are allowed. These include \m{begin\{math\}},
\m{begin\{displaymath\}}, \m{begin\{equation\}},
\m{begin\{eqnarray\}}, and \m{begin\{eqnarray*\}}. The shortcuts \$,
\$\$, \m{[}, and \m{]} are allowed. In addition, authors may use
almost all of the additional markup introduced by AMS-\LaTeX\ by using
the \classoption{amsmath} class option. The explicit exceptions are
\m{genfrac}, \m{boxed} and \m{smash}. The markup contained in
\texttt{amsextra} and \texttt{amsthm} may not be used
though. Commutative diagrams created with the \texttt{amscd} package
are acceptable.

\section{Figures}
\subsection{Figure inclusions}
Figures should be included into a \revtex~4 manuscript by using the
standard \LaTeXe\ macros. \LaTeXe\ includes
several powerful packages for including the files in various
formats. The two main packages are \texttt{graphics} and
\texttt{graphicx}. Both offer a macro called
\m{includegraphics};
they mainly differ in how arguments for
controlling figure placement (\textit{e.~g.}, scaling and rotation)
are passed to the \m{includegraphics}. Old \LaTeX2.09 interfaces such as
\classoption{epsfig} have been re-implemented on top of these
packages. Use of one these mechanisms replaces the \revtex~3
classoption \classoption{epsf}.

The \env{figure} environment should be used to add a caption to the
figure and to allow \LaTeX\ to number and place the figures where they
fit best.  If a figure needs to be referred to in the text, then
rather than manually numbering the figures a \m{label} should be added
to the figure environment (best practice is to put the label within
the \m{caption} macro) and the \m{ref} macro should be used to
reference this label. Figures that span the page should use the
\m{figure*} environment. The \env{picture} environment must not be
used directly (one can include an Encapsulated PostScript figure that
was produced using the \env{picture} environment of course).

\subsection{\label{sec:figplace}Figure placement}
Figures should be placed as close as possible to the point where they are first
referenced. There is no need to place all figures
separately at the end of the manuscript and it is preferred that
authors leave the figures in their natural locations. Authors may
also find useful the \revtex~4 \classoption{floatfix} class option
which adds emergency float placement processing to avoid ``stuck''
floats which would otherwise be deferred to the end of the job (and
can lead to the fatal \texttt{``Too many unprocessed floats''}
message).


\section{Tables}
\label{sec:tables}
The standard \LaTeXe\ table formatting environments are supported as is
the use of the \texttt{longtable} package. Tables may be reformatted
during production to meet APS style guidelines.
\subsection{Single column formatting}
Because \classoption{preprint} formatting is used during the editorial and
production processes, authors must ensure that their tables format
correctly under the \classoption{preprint} option. Tables are
particularly sensitive to this change because the font size and line
spacing increase
making tables wider and longer. This means some tables may no longer
fit upon the page. It is the author's responsibility to fix this
before submitting the manuscript. Here are some helpful hints:
\begin{itemize}
\item Use the \texttt{longtable} package to get tables to break
across pages.
\item The macro \m{squeezetable} will reduce the font size of the
table. This macro must occur within a group outside the table
environment. The proper markup is:
\begin{verbatim}
\begingroup
\squeezetable
\begin{table}
...
\end{table}
\endgroup
\end{verbatim}
\item Try using the float placement option \texttt{H} which will
enable \LaTeX\ to break a float across pages. Long tables are more
attractively set with \env{longtable} however.
\begin{verbatim}
\begin{table}[H]
\begin{ruledtabular}
\begin{tabular}
...
\end{tabular}
\end{ruledtabular}
\end{table}
\end{verbatim}
\end{itemize}

\subsection{Doubled rules and other table formatting}
\revtex\ 4 provides the \env{ruledtabular} environment which
automatically puts the scotch rules (double lines) around tables and
formats all enclosed \env{tabular} environments to the full width of
the tables and improves intercolumn spacing. This environment should
be used whenever possible.

\subsection{Wide tables}
When typesetting using \classoption{twocolumn}, tables can either span
a single column or both columns. Using the '\verb+*+'-ed version of
the \env{table} or \env{longtable} environments produces wide tables
that span the columns. For compuscripts, the \classoption{twocolumn}
is not used at all and authors must ensure that their tables format
correctly whatever environment is used.

Tables that are very wide and that may be better typeset in a
landscape orientation (rotated 90 degrees) should be enclosed in a
\env{turnpage} environment. This will place the rotated table on its own
page. Note that some dvi previewers may not be able to show the table
properly, but \texttt{dvips} and \texttt{pdflatex} work correctly.

\subsection{Table placement}
Tables should be placed as close as possible to the point where they
are first referenced. There is no need to place all tables separately
at the end of the manuscript and this is not desirable for APS
purposes. The class option \classoption{floatfix} may be helpful for
table placement as well as figure placement (see Section~\ref{sec:figplace}).

\subsection{Aligning columns on a decimal point}
The standard \LaTeXe\ macro package \classoption{dcolumn} should be
used to accomplish this.

\subsection{Tablenotes}
\label{sec:tablenotes}
Footnotes in tables (tablenotes) should use the \m{footnote}
macro. However, if more than one reference to the same footnote is
needed, authors may use \m{footnotetext} and \m{footnotemark}. This
will produce notes (labeled by lower-case roman letters) inserted
below the table rather than in the reference section or at the bottom
of the page.


\section{Author-defined macros}
Authors may define convenience macros to save keystrokes. This means
that the macros may not invoke \TeX\ macros such as \m{if} or other
context dependent commands. Also, \LaTeXe\ provides three macros for
declaring new commands: \m{providecommand}, \m{newcommand}, and
\m{renewcommand} (as well as their `\verb+*+'-ed versions). These
should be used. Authors may not use \TeX\relax's low-level commands
\m{def}, \m{edef}, and \m{gdef}.

\section{Summary}
To ensure the best use of \TeX\ manuscripts, authors need to follow
the guidelines specified here. Use of low-level formatting commands to
finely control horizontal and vertical spacing may be ignored during
production, or even worse, make it impossible to convert the
manuscript to our typesetting sofware. Authors should try to keep
things as simple as possible and correctly use the proper \revtex\ 4
or \LaTeXe\ macros. Any questions about usage may be directed to
\texttt{revtex@aps.org}.

\end{document}