\input siamptex.sty
% The definitions are to provide a verbatim text environment
\def\uncatcodespecials{\def\do##1{\catcode`##1=12 }\dospecials}
\def\setupverbatim{\tt%
\def\par{\leavevmode\endgraf}%
\obeylines\uncatcodespecials\obeyspaces}
{\obeyspaces\global\let =\ }
\def\doverbatim#1{\def\next##1#1{##1\endgroup}\next}
\def\verbatim{\begingroup\setupverbatim\doverbatim}
\overfullrule=0pt
\topmatter
\vol{1}
\no{1, pp.~000--000}
\journal{SIAM J. E{\smc XAMPLE} F{\smc ILES}}
\date{October 1992}
\copyyear{1992}
\code{000}
\title Using SIAM's \TeX\ Macros\endtitle
\shorttitle{USING SIAM'S \TeX\ MACROS}
\recdate{*}{October 8, 1992.
This work was supported by the Society for Industrial
and Applied Mathematics}
\author Paul Duggan\fnmark{$^{\dag}$}\endauthor
\address{$^{\dag}$}{Society for Industrial and Applied Mathematics,
Philadelphia, Pennsylvania ({\tt
[email protected]}). Questions, comments,
or corrections to this document may be directed to that email address}
\abstract{}
\subjclass\endsubjclass
\keywords\endkeywords
\endtopmatter
\heading{1}{Introduction}
This file is documentation for the SIAM \TeX\ macros, and provides
instruction for submission of files formatted in \TeX.
To accommodate authors who electronically typeset their manuscripts,
SIAM supports the use of \TeX. To ensure quality typesetting according
to SIAM style standards, SIAM provides a \TeX\ macro style file.
Using \TeX\ to format a manuscript should simplify the editorial process
and lessen the author's proofreading burden. It is still necessary to
proofread with care.
Electronic files should not be submitted until the paper has been
accepted, and then not until requested to do so by someone in the SIAM
office. Once an article is slated for an issue,
someone from the SIAM office will contact the author about any or all
of the following: editorial and stylistic queries;
supplying the source files (and any supplementary macros)
for the properly formatted article; and handling figures.
Electronic submissions (to {\tt
[email protected]}) should be clearly
designated as to the journal and author. Authors are responsible for ensuring
that the paper generated from the source files exactly matches the paper that
was accepted for publication by the review editor. If it does not,
that should be indicated in the transmission of the file.
When submitting a file, please be sure to include any additional
macros (other than those provided by SIAM) that will be needed to run
the paper.
Once the files are corrected here at SIAM, we will send back the revised
proofs to be read against the original edited manuscript. We are not
set up to shuttle back and forth varying electronic versions of each
paper, so we must rely on hard copy. The author's proofreading
is an important but easily overlooked step. Even if SIAM were not
to introduce a single editorial change into your manuscript, there
would still be a need to check line and page breaks as the encoding
of Times Roman fonts would change the page makeup of a Computer
Modern file.
A sample file is included with this distribution to demonstrate the
standard use of SIAM's macro package. To provide an incentive for
the use of \TeX\ in paper preparation, SIAM provides 100 free reprints
of the author's journal article but only to those who have made use of
the SIAM macro in proper fashion. To qualify for free reprints the
following criteria must be met:
\meti{1.} The appropriate document style line must appear at
the beginning of the source file.
\meti{2.} All top matter information (key words, affiliation, etc.) must
be present and correctly tagged. The only exception to the rule will be
the AMS subject classification.
\meti{3.} All tagging conventions, as described in this documentation
and used in the example file, must be followed.
\meti{4.} The format of the bibliography must strictly adhere to SIAM
guidelines. The appropriate tags must be used for all entries. All names
are to be keyed initial upper case cap and small caps. Only the first
and middle initials, followed by the last name, are to be used.
Last names should never be listed first. There will be no exceptions
to this requirement. An improperly prepared bibliography will,
in all cases, prevent an author from receiving free reprints
The distribution contains the following items: {\tt siamptex.sty}, the
main macro package; this documentation file; and a sample file, {\tt
pexample.tex}. The sample file is representative of the standard way
to apply the macros. The rest of this paper emphasizes some aspects
of applying the macros, points out options and special cases, and
describes the SIAM style standards.
The SIAM macros make use of the small caps font, {\tt cmcsc}, which
is not installed in some systems. Contact the American Mathematical
Society for information about the availability of this font.
\heading{2}{Headings}
The top matter of a journal is in a standard format. The macro
and initial definitions should be included as follows
\verbatim:
\def\smc{\tensmc}
\input siamptex.sty
\overfullrule=0pt
:
The \verbatim:\overfullrule: should be set wider while still
being edited by the author, to assist in locating lines that extend
beyond the margins.
The ``slugline,'' containing the journal and copyright information, is
created by special commands following the\verbatim:\topmatter:
\verbatim:
\vol{0}
\no{0, pp.~000--000}
\journal{SIAM J. A{\smc PPL}. M{\smc ATH}.}
\date{May 1992}
\copyyear{1992}
\code{000}
:
The information for volume, number, date, and code will likely be unknown,
or zeros should be
put in where required. SIAM will place the appropriate information in
the commands in production, however, the commands must be used.
The title and author(s) of the paper are indicated by the
\verbatim:\title\endtitle: and \verbatim:\author\endauthor: commands.
Author support and address information is indicated as follows:
\verbatim:
\author A.~U. Thorone\fnmark{$^{\dag}$}
\and A.~U. Thortwo\fnmark{$^{\ddag}$}\endauthor
\address{$^{\dag}$}{Address of the first author and support}
\address{$^{\ddag}$}{Address of the second author and support}
:
The commands \verbatim:\shorttitle{}: and \verbatim:\shortauthor{}:
are used to designate the running heads for the paper.
The \verbatim:\abstract{}:, \verbatim:\keywords\endkeywords:, and
\verbatim:\subjclass\endsubjclass: commands are used to include the
abstract, keywords, and AMS subject class numbers, respectively.
If there is to be only one subject classification number, the
\verbatim:\subjclass: command should be preceded by
\verbatim:\oneclass:. If the AMS numbers are unknown, leave that
information blank. Authors are responsible for providing AMS numbers.
They can be found in the Annual Index of Math Reviews, or
through {\tt e-Math} ({\tt
[email protected]}; login
and password are both {\tt e-math}).
This section initial information is ended by \verbatim:\endtopmatter:.
\heading{3}{Equations}
Equations and are handled by standard \TeX\ commands. SIAM style is
for numbered equations to appear flush with the left margin. The
\verbatim:\leqno: and \verbatim:\leqalignno{}: commands are used for
this purpose. If any letters indicating subequations are to be used
with the numbers, they should be set in roman type.
More information on the formatting of equations and aligned
equations are found in Knuth [1]. Authors bear primary responsibility
for formatting their equations within margins and in an aestheticly
pleasing and informative manner.
Groups of equations that are not directly related to each other
should normally be centered independently. This may be done through
the \TeX\ math command \verbatim:\displaylines{}:. Numbering
independently centered equations can be difficult, so Seroul and Levy's [2]
macro \verbatim:\ldisplaylinesno{}: has been included in {\tt siamptex.sty}.
\verbatim:\ldisplaylinesno{}: works just like \verbatim:\leqalignno:, except
no ampersand is used to align the equations, since they are to be centered.
\heading{4}{Text formatting}
Section and subsection headings are both included using the
\verbatim:\heading{}{}: command, which requires two arguments. The first is
for the number, and the second is the title of the section or
subsection.
No extra spacing should be placed between paragraphs. The
\verbatim:\heading: command inserts the required spacing between sections.
SIAM style does not normally make use of the plain \TeX's \verbatim:\item:
command. The \verbatim:\meti: command is preferred for
lists of items beginning with, for instance, bullets ($\bullet$) or
roman numerals (iv). The\verbatim:\meti: command retains normal
paragraph shape, but places all labels aligned flush right. For
example:
\verbatim:
\meti{(i)} This is the first item.
\meti{(ii)} This is the second item of the series.
:
produces
\meti{(i)} This is the first item.
\meti{(ii)} This is the second item of the series.
\medskip
The \verbatim:\meti: macro was adapted from Seroul and Levy [2].
\heading{4.1}{Punctuation}
All standard punctuation and all numerals should be set in Roman type
(upright). The only exceptions are periods and commas. They may
be set to match the surrounding text.
\heading{4.2}{Theorems, lemmas, and proofs}
Theorems, lemmas, propositions, and so forth, have macros included
for correct formatting. Below is an example.
\verbatim:
\thm{Theorem 3.1}
Sample theorem included for illustration. Words in all caps, like
{\rm SIAM} should be set in roman type, as should all numbers and
parentheses. Note that words in displayed equations, such as
$$ x^2 = Y^2 \sin z^2 \hbox{ for all } x $$
will appear in italic type in a theorem, though normally
they should appear in roman.\endthm
:
This produces:
\thm{Theorem 3.1}
Sample theorem included for illustration. Words in all caps, like {\rm
SIAM} should be set in roman type, as should all numbers and
parentheses. Note that words in displayed equations, such as
$$ x^2 = Y^2 \sin z^2 \hbox{ for all } x $$
will appear in italic type in a theorem, though normally
text they should appear in roman.\endthm
The \verbatim:\lem:, \verbatim:\prop:, and \verbatim:\cor: commands
all work similarly. Named theorems should be designated with the
title in roman type, enclosed in parentheses.
\verbatim:
\thm{Theorem 3.2 {\rm (sample theorem with title)}}
:
Proofs are illustrated in the following example:
\verbatim:
\prf{Proof}
The body of the proof.
\qquad\endproof
:
If the proof ends with a displayed equation, the \verbatim:\endproof:
box \endproof\ should appear flush right with the margin, on line with the
equation. The \verbatim:\eqno:
command will place this in the correct position. If the equation is
already numbered, this method will not work, so just include the
\verbatim:\endproof: box and SIAM will handle making the box flush
right in production.
\heading{5}{Figures and tables}
Figures and tables are best handled in \TeX\ by putting them within a
\verbatim:\topinsert \endinsert: environment. The appropriate amount
of space should be left for the figure, and the caption should be
formatted to be centered or as a paragraph if more than one line. Text
should be italic, eight-point type, with the words ``Fig.~\#'' in small
caps.
SIAM tables should be formatted in eight-point type, with enough
space left between entries and surrounding lines so that they do not
touch. See Knuth [1] or Seroul and Levy [2] for more information on
the formatting of tables in \TeX. Table captions are similar to
figure captions, but the words ``Table'' and the number appear on one
line.
SIAM supports the use of {\tt psfig} for including {\smc PostScript}
figures. All {\smc Post\-Script} figures should be sent in separate
files. See the {\tt psfig} documentation for more details on the use
of this style option. It is a good idea to submit hardcopy of all
{\smc Post\-Script} figures just in case there is difficulty in the
reproduction of the figure. Figures produced by other non-\TeX\
methods should be included as hardcopy when the manuscript is submitted.
\heading{6}{Bibliographies}
References are handled using the \verbatim:\Refs: command. Some
representative sample entries are illustrated below:
\verbatim|
\Refs
\ref 1\\ {\smc A.~U Thorone}, {\it Title of paper with lower case
letters}, SIAM J. Abbrev. Correctly, 2 (1992), pp.~000--000.\endref
\ref 2\\ \sameauthor, % generates a 3-em rule
{\it Title of paper appearing in book}, in Book Title:
With All Initial Caps, Publisher, Location, 1992.\endref
\ref 3\\ {\smc A.~U. Thorone, A.~U. Thortwo, and A.~U. Thorthree},
{\it Title of Book{\rm :} Note Initial Caps and {\rm ROMAN TYPE}
for Punctuation and Acronyms}, Publisher, Location, pp.~000--000.
1992.\endref
\ref 4\\ {\smc A. Notherauth}, {\it Title of paper that's not yet
published}, SIAM J. Abbrev. Correctly, to appear.\endref
|
Other types of references fall into the same general pattern. See the
sample file or any SIAM journal for other examples. Authors must
correctly format their bibliography to be considered as having used
the macros correctly. An incorrectly formatted bibliography is not
only time-consuming but very likely to have errors introduced into it by
keyboarders/copy editors.
As an alternative to the above style of reference, an alphanumeric
code may be used in place of the number (e.g., [AUTh90]). The same
\verbatim:\Refs: and \verbatim:\ref: commands are used, but the
command \verbatim:\resetrefindent{}: must be used before the
\verbatim:\Refs: command, with the widest expected alphanumeric code
as an argument.
Another alternative is no number, simply the authors' names and
the year of publication following in parentheses. The rest of the
format is identical. To get an entry with no number in brackets
before it, use the \verbatim:\xref: command.
\Refs
\ref 1\\ {\smc D.~E. Knuth}, {\it The {\rm \TeX} book}, Addison Wesley,
Reading, MA, 1986.\endref
\ref 2\\ {\smc R. Seroul and S. Levy}, {\it A Beginner's Book of
{\rm \TeX}}, Springer-Verlag, Berlin, New York, 1991.\endref
\bye