2
%% This is file `docultex.tex',
3
%% Documentation for siam macros for use with LaTeX 2e
5
%% By Paul Duggan for the Society for Industrial and Applied
12
%% You are not allowed to change this file.
14
%% You are allowed to distribute this file under the condition that
15
%% it is distributed together with all of the files in the siam macro
16
%% distribution. These are:
18
%% siamltex.cls (main LaTeX macro for SIAM)
19
%% siamltex.sty (includes siamltex.cls for compatibility mode)
20
%% siam10.clo (size option for 10pt papers)
21
%% subeqn.clo (allows equation numbners with lettered subelements)
22
%% siam.bst (bibliographic style file for BibTeX)
23
%% docultex.tex (this file)
24
%% lexample.tex (example file for latex macro)
26
%% If you receive only some of these files from someone, complain!
28
%% You are NOT ALLOWED to distribute this file alone. You are NOT
29
%% ALLOWED to take money for the distribution or use of either this
30
%% file or a changed version, except for a nominal charge for copying
33
%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
34
%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
35
%% Digits \0\1\2\3\4\5\6\7\8\9
36
%% Exclamation \! Double quote \" Hash (number) \#
37
%% Dollar \$ Percent \% Ampersand \&
38
%% Acute accent \' Left paren \( Right paren \)
39
%% Asterisk \* Plus \+ Comma \,
40
%% Minus \- Point \. Solidus \/
41
%% Colon \: Semicolon \; Less than \<
42
%% Equals \= Greater than \> Question mark \?
43
%% Commercial at \@ Left bracket \[ Backslash \\
44
%% Right bracket \] Circumflex \^ Underscore \_
45
%% Grave accent \` Left brace \{ Vertical bar \|
46
%% Right brace \} Tilde \~}
48
\documentclass[final]{siamltex}
50
\title{USING SIAM'S \LaTeX\ MACROS\thanks{This work was
51
supported by the Society for Industrial and Applied
54
\author{Paul Duggan\thanks{Society for Industrial and
55
Applied Mathematics, Philadelphia, Pennsylvania.
56
(duggan@siam. org). Questions, comments, or corrections
57
to this document may be directed to that email address.}}
64
Documentation is given for use of the SIAM \LaTeX\ macros. These
65
macros are now compatible with \LaTeX$2_{\varepsilon}$.
66
Instructions and suggestions for compliance with SIAM style
67
standards are also included. Familiarity with standard \LaTeX\ commands
71
\begin{keywords}\end{keywords}
76
\pagestyle{myheadings}
78
\markboth{PAUL DUGGAN}{USING SIAM'S \LaTeX\ MACROS}
80
\section{Introduction}
82
This file is documentation for the SIAM \LaTeX\ macros, and
83
provides instruction for submission of your files.
85
To accommodate authors who electronically typeset their manuscripts,
86
SIAM supports the use of \LaTeX. To ensure quality typesetting according
87
to SIAM style standards, SIAM provides a \LaTeX\ macro style file.
88
Using \LaTeX\ to format a manuscript should simplify the editorial process
89
and lessen the author's proofreading burden. However,
90
it is still necessary to proofread the galley proofs with care.
92
Electronic files should not be submitted until the paper has been
93
accepted, and then not until requested to do so by someone in the SIAM
94
office. Once an article is slated for an issue,
95
someone from the SIAM office will contact the author about any or all
96
of the following: editorial and stylistic queries,
97
supplying the source files (and any supplementary macros)
98
for the properly formatted article, and handling figures.
100
When submitting electronic files (electronic submissions)
101
(to {\tt tex@siam.org}) include the journal, issue, and author's
102
name in the subject line of the message.
103
Authors are responsible for ensuring that the paper generated
104
from the source files exactly matches the paper that
105
was accepted for publication by the review editor. If it does not,
106
information on how it differs should be indicated in the transmission
107
of the file. When submitting a file, please be sure to include any
108
additional macros (other than those provided by SIAM) that will be
109
needed to run the paper.
111
SIAM uses MS-DOS-based computers for \LaTeX\ processing. Therefore
112
all filenames should be restricted to eight characters or less,
113
plus a three character extension.
115
Once the files are corrected here at SIAM, we will mail the revised
116
proofs to be read against the original edited hardcopy
117
manuscript. We are not
118
set up to shuttle back and forth varying electronic versions of each
119
paper, so we must rely on hard copy of the galleys. The author's proofreading
120
is an important but easily overlooked step. Even if SIAM were not
121
to introduce a single editorial change into your manuscript, there
122
would still be a need to check, because electronic transmission
123
can introduce errors.
125
The distribution contains the following items: {\tt
126
siamltex.cls}, the main macro package based on {\tt
127
article.cls}; {\tt siam10.clo}, for the ten-point size option;\linebreak
128
{\tt subeqn.clo}, a style option for equation numbering (see \S3 for
129
an explanation); and {\tt siam.bst},
130
the style file for use with {\sc Bib}\TeX. Also included are this
131
file {\tt docultex.tex} and a sample file {\tt lexample.tex}.
132
The sample file represents a standard application of
133
the macros. The rest of this paper will highlight
134
some keys to effective macro use, as well as point out options and
135
special cases, and describe SIAM style standards to which
136
authors should conform.
140
The top matter of a journal paper falls into a standard
141
format. It begins of course with the \verb|\documentclass| command
145
\documentclass{siamltex}
149
Other class options can be included
150
in the bracketed argument of the command, separated by commas.
153
The title and author parts are formatted using the
154
\verb|\title| and \verb|\author| commands as described in Lamport
155
\cite{Lamport}. The \verb|\date|
156
command is not used. \verb|\maketitle| produces the actual
157
output of the commands.
159
The addresses and support acknowledgments are put into the
160
\verb|\author| commands via \verb|\thanks|. If support is
161
overall for the authors, the support acknowledgment should
162
be put in a \verb|\thanks| command in the \verb|\title|.
163
Specific support should go following the addresses of the
164
individual authors in the same \verb|\thanks| command.
166
Sometimes authors have support or addresses in common which
167
necessitates having multiple \verb|\thanks| commands for
168
each author. Unfortunately \LaTeX\ does not normally allow this,
169
so a special procedure must be used. An example of this procedure
170
follows. Grant information can also be run into both authors'
175
\title{TITLE OF PAPER}
177
\author{A.~U. Thorone\footnotemark[2]\ \footnotemark[5]
178
\and A.~U. Thortwo\footnotemark[3]\ \footnotemark[5]
179
\and A.~U. Thorthree\footnotemark[4]}
184
\renewcommand{\thefootnote}{\fnsymbol{footnote}}
186
\footnotetext[2]{Address of A.~U. Thorone}
187
\footnotetext[3]{Address of A.~U. Thortwo}
188
\footnotetext[4]{Address of A.~U. Thorthree}
189
\footnotetext[5]{Support in common for the first and second
192
\renewcommand{\thefootnote}{\arabic{footnote}}
196
Notice that the footnote marks begin with {\tt [2]}
197
because the first mark (the asterisk) will be used in the
198
title for date-received information by SIAM, even if not
199
already used for support data. This is just one example;
200
other situations follow a similar pattern.
202
Following the author and title is the abstract, key words
203
listing, and AMS subject classification number(s),
204
designated using the \verb|{abstract}|, \verb|{keywords}|,
205
and \verb|{AMS}| environments. If
206
there is only one AMS number, the commands
207
\verb|\begin{AM}| and \verb|\end{AM}| are used
208
instead of \verb|{AMS}|. This causes the heading to be
209
in the singular. Authors are responsible for providing AMS numbers.
210
They can be found in the Annual Index of Math Reviews, or
211
through {\tt e-Math} ({\tt telnet e-math.ams.com}; login
212
and password are both {\tt e-math}).
214
Left and right running heads should be provided in the
219
\pagestyle{myheadings}
220
\thispagestyle{plain}
221
\markboth{A.~U. THORONE AND A.~U. THORTWO}{SHORTER PAPER
226
\section{Equations and mathematics}
228
One advantage of \LaTeX\ is that it can automatically number
229
equations and refer to these equation numbers in text. While plain \TeX's
230
method of equation numbering (explicit numbering using
231
\verb|\leqno|) works in the SIAM macro, it is not preferred
232
except in certain cases. SIAM style guidelines call for
233
aligned equations in many circumstances, and \LaTeX's
234
\verb|{eqnarray}| environment is not compatible with
235
\verb|\leqno| and \LaTeX\ is not compatible with the plain
236
\TeX\ command \verb|\eqalign| and \verb|\leqalignno|. Since
237
SIAM may have to alter or realign certain groups of
238
equations, it is necessary to use the \LaTeX\ system of
241
Sometimes it is desirable to designate subequations of a larger
242
equation number. The subequations are designated with
243
(roman font) letters appended after the number. SIAM has
244
supplemented its macros with the {\tt subeqn.clo} option which
245
defines the environment \verb|{subequations}|.
249
\begin{subequations}\label{EKx}
251
y_k = B y_{k-1} + f, \qquad k=1,2,3,\ldots
253
for any initial vector $ y_0$. Then
255
y_k\rightarrow u \mbox{\quad iff\quad} \rho( B)<1.
261
All equations within the \verb|{subequations}| environment
262
will keep the same overall number, but the letter
263
designation will increase.
265
Clear equation formatting using \TeX\ can be challenging. Aside from
266
the regular \TeX\ documentation, authors will find Nicholas
267
J. Higham's book {\em Handbook of Writing for the Mathematical
268
Sciences\/} \cite{Higham} useful for guidelines and tips on
269
formatting with \TeX. The book covers many other topics related
270
to article writing as well.
272
Authors commonly make mistakes by using
273
\verb|<|, \verb|>|, \verb|\mid|, and
274
\verb|\parallel| as delimiters, instead of
275
\verb|\langle|, \verb|\rangle|, \verb:|:,
276
and \verb:\|:. The incorrect symbols have particular
277
meanings distinct from the correct ones and should not be confused.
280
\caption{Illustration of incorrect delimiter use.}
281
\begin{center}\footnotesize
282
\renewcommand{\arraystretch}{1.3}
283
\begin{tabular}{|ll|ll|}\hline
284
\multicolumn{2}{|c|}{{\bf Wrong}} & \multicolumn{2}{c|}{{\bf Right}}\\ \hline
285
\verb|<x, y>| & $<x, y>$ & \verb|\langle x, y\rangle| & $\langle x, y\rangle$\\
286
\verb|5 < \mid A \mid| & $5 < \mid A \mid$ & \verb:5 < |A|: & $5 < |A|$\\
287
\verb|6x = \parallel x|&&&\\
288
\verb| - 1\parallel_{i}| & $6x = \parallel x - 1\parallel_{i}$ &
289
\verb:6x = \|x - 1\|_{i}: & $6x = \| x - 1\|_{i}$\\ \hline
294
Another common author error is to put large (and even medium sized)
295
matrices in-line with the text, rather than displaying them. This
296
creates unattractive line spacing problems, and should be assiduously
297
avoided. Text-sized matrices (like $({a \atop b} {b \atop c})$) might
298
be used but anything much more complex than the example cited will
299
not be easy to read and should be displayed.
301
More information on the formatting of equations and aligned
302
equations is found in Lamport \cite{Lamport}. Authors bear
303
primary responsibility for formatting their equations within
304
margins and in an aesthetically pleasing and informative manner.
306
The SIAM macros include additional roman math words, or ``log-like"
307
functions, to those provided in standard \TeX. The following
308
commands are added: \verb:\const:, \verb:\diag:, \verb:\grad:,
309
\verb:\Range:, \verb:\rank:, and \verb:\supp:.
310
These commands produce the same word as the command name
311
in math mode, in upright type.
313
\section{Special fonts}
315
SIAM supports the use of the AMS-\TeX\ fonts (version 2.0
316
and later). The package \verb|amsfonts| can be included with
317
the command\linebreak \verb|\usepackage{amsfonts}|. This package
318
is part of the AMS-\LaTeX distribution, available
319
from the AMS or from the Comprehensive TeX Archive
320
Network (anonymous ftp to ftp.shsu.edu). The blackboard bold font in this
321
font package can be used for designating number sets.
322
This is preferable to other methods of combining letters
323
(such as I and R for the real numbers) to produce pseudo-bold
324
letters but this is tolerable as well. Typographically speaking,
325
number sets may simply be designated using regular bold letters;
326
the blackboard bold typeface was designed to fulfil a desire
327
to simulate the limitations of a chalk board in printed type.
330
\subsection{Punctuation}
331
All standard punctuation and all numerals should be set in roman type
332
(upright) even within italic text. The only exceptions are periods and
333
commas. They may be set to match the surrounding text.
335
References to sections should use the symbol \S, generated by
336
\verb|\S|. (If the reference begins a sentence, the term ``Section''
337
should be spelled out in full.) Authors should not redefine
338
\verb|\S|, say, to be a calligraphic S, because \verb|\S|
339
must be reserved for use as the section symbol.
341
Authors sometimes confuse the use of various types of dashes.
342
Hyphens (\verb|-|, -) are used for some compound words (many
343
such words should have no hyphen but must be run together,
344
like ``nonzero,'' or split apart, like ``well defined'').
345
Minus signs (\verb|$-$|, $-$)
346
should be used in math to represent subtraction or negative numbers.
347
En dashes (\verb|--|, --) are used for ranges (like 3--5,
348
June--August), or for joined names (like Runge--Kutta). Em dashes
349
(\verb|---|, ---) are used to set off a clause---such as this
350
one---from the rest of the sentence.
353
\subsection{Text formatting}
355
SIAM style preferences do not make regular use of the \verb|{enumerate}|
356
and \verb|{itemize}| environments. Instead,
357
{\tt siamltex.cls} includes definitions of two alternate list
358
environments, \verb|{remunerate}| and \verb|{romannum}|.
359
Unlike the standard itemized lists, these environments do
360
not indent the secondary lines of text. The labels, whether
361
defaults or the optional user-defined, are always aligned
364
The \verb|{remunerate}| environment consecutively numbers
365
each item with an arabic numeral followed by a period. This
366
number is always upright, even in slanted
367
environments. (For those wondering at the unusual
368
naming of this environment, it comes from Seroul and Levy's
369
\cite{SerLev} definition of a similar macro for plain \TeX:
371
\verb|\meti| which is
372
% {\tt \char"5C item}
373
\protect\verb|\item| spelled backwards. Thus
374
%{\tt \{remunerate\}},
381
The \verb|{romannum}| environment consecutively numbers
382
each item with a lower-case roman numeral enclosed in
383
parentheses. This number will always be upright within
384
slanted environments (as in theorems).
387
\section{Theorems and Lemmas}
388
Theorems, lemmas, corollaries, definitions, and propositions are covered
389
in the SIAM macros by the theorem-environments
390
\verb|{theorem}|, \verb|{lemma}|, \verb|{corollary}|,
391
\verb|{definition}| and \verb|{proposition}|. These are all
392
numbered in the same sequence and produce labels in small
393
caps with an italic body. Other environments may be specified by the
394
\verb|\newtheorem| command. SIAM's style is for Remarks and Examples
395
to appear with italic labels and an upright roman body.
400
Sample theorem included for illustration.
401
Numbers and parentheses, like equation $(3.2)$, should be set
402
in roman type. Note that words (as opposed to ``log-like''
403
functions) in displayed equations, such as
404
$$ x^2 = Y^2 \sin z^2 \mbox{ for all } x $$
405
will appear in italic type in a theorem, though normally
406
they should appear in roman.\end{theorem}
410
This sample produces Theorem 4.1 below.
413
Sample theorem included for illustration.
414
Numbers and parentheses, like equation $(3.2)$, should be set
415
in roman type. Note that words (as opposed to ``log-like''
416
functions) in displayed equations, such as
417
$$ x^2 = Y^2 \sin z^2 \mbox{ for all } x $$
418
will appear in italic type in a theorem, though normally
419
they should appear in roman.
423
Proofs are handled with the \verb|\begin{proof}|
424
\verb|\end{proof}| environment. A ``QED'' box \endproof\ is created
425
automatically by \verb|\end{proof}|, but this should be
426
preceded with a \verb|\qquad|.
428
Named proofs, if used, must be done independently by the
429
authors. SIAM style specifies that proofs which end with
430
displayed equations should have the QED box two ems (\verb|\qquad|)
431
from the end of the equation on line with it horizontally.
432
Below is an example of how this can be done:
436
{\em Proof}. Proof of the previous theorem
442
a^2 + b^2 = c^2 \qquad\endproof
448
\section{Figures and tables}
449
Figures and tables sometimes require special consideration.
450
Tables in SIAM style are need to be set in eight point size
451
by using the \verb|\footnotesize| command inside the
452
\verb|\begin{table}| environment. Also, they should be designed
453
so that they do not extend beyond the text margins.
455
SIAM style requires that no figures or tables appear in the
456
references section of the paper. \LaTeX\ is notorious for
457
making figure placement difficult, so it is important to
458
pay particular attention to figure placement near the
459
references in the text. All figures and tables should
460
be referred to in the text.
462
SIAM supports the use of {\tt epsfig} for including {\sc PostScript}
463
figures. All {\sc Post\-Script} figures should be sent in separate
464
files. See the {\tt epsfig} documentation (available via
465
anonymous ftp from CTAN: ftp.shsu.edu) for more details on the use
466
of this style option. It is a good idea to submit high-quality
467
hardcopy of all {\sc Post\-Script} figures just in case there
468
is difficulty in the reproduction of the figure. Figures produced
469
by other non-\TeX\ methods should be included as high-quality
470
hardcopy when the manuscript is submitted.
472
{\sc PostScript} figures that are sent should be generated with
473
sufficient line thickness. Some past figures authors have sent
474
had their line widths become very faint when SIAM set the papers
475
using a high-quality 1200dpi printer.
477
Hardcopy for non-{\sc PostScript} figures should be included in
478
the submission of the hardcopy of the manuscript. Space
479
should be left in the \verb|{figure}| command for the
480
hardcopy to be inserted in production.
482
\section{Bibliography and Bib\TeX}
484
If using {\sc Bib}\TeX, authors need not submit the {\tt .bib} file for
485
their papers. Merely submit the completed {\tt .bbl} file, having used
486
{\tt siam.bst} as their bibliographic style file. {\tt siam.bst}
487
only works with Bib\TeX\ version 99i and later. The use of
488
Bib\TeX\ and the preparation of a {\tt .bib} file is
489
described in greater detail in \cite{Lamport}.
491
If not using Bib\TeX, SIAM bibliographic references follow
492
the format of the following examples:
496
\bibitem{Ri} {\sc W. Riter},
497
{\em Title of a paper appearing in a book}, in The Book
498
Title, E.~D. One, E.~D. Two, and A.~N. Othereditor, eds.,
499
Publisher, Location, 1992, pp.~000--000.
501
\bibitem{AuTh1} {\sc A.~U. Thorone}, {\em Title of paper
502
with lower case letters}, SIAM J. Abbrev. Correctly, 2
503
(1992), pp.~000--000.
505
\bibitem{A1A2} {\sc A.~U. Thorone and A.~U. Thortwo}, {\em
506
Title of paper appearing in book}, in Book Title: With All
507
Initial Caps, Publisher, Location, 1992.
509
\bibitem{A1A22} \sameauthor, % generates the 3 em rule
510
{\em Title of Book{\rm :} Note Initial Caps and {\rm ROMAN
511
TYPE} for Punctuation and Acronyms}, Publisher,
512
Location, pp.~000--000, 1992.
514
\bibitem{AuTh3} {\sc A.~U. Thorthree}, {\em Title of paper
515
that's not published yet}, SIAM. J. Abbrev. Correctly, to appear.
519
Other types of references fall into the same general
520
pattern. See the sample file or any SIAM journal for other
521
examples. Authors must correctly format their bibliography to
522
be considered as having used the macros correctly. An incorrectly
523
formatted bibliography is not only time-consuming for SIAM to
524
process but it is possible that errors may be introduced into
525
it by keyboarders/copy editors.
527
As an alternative to the above style of reference, an alphanumeric
528
code may be used in place of the number (e.g., [AUTh90]). The same
529
commands are used, but \verb|\bibitem| takes an optional argument
530
containing the desired alphanumeric code.
532
Another alternative is no number, simply the authors' names and
533
the year of publication following in parentheses. The rest of the
534
format is identical. The macros do not support this alternative
535
directly, but modifications to the macro definition are possible
536
if this reference style is preferred.
539
\section{Conclusion} Many other style suggestions and tips
540
could be given to help authors but are beyond the scope of this
541
document. Simple mistakes can be avoided by increasing your familiarity
542
with how \LaTeX\ functions. The books referred to throughout this document
543
are also useful to the author who wants clear, beautiful typography
544
with minimal mistakes.
547
\section{The use of appendices}
548
The \verb|\appendix| command may be used before the final sections
549
of a paper to designate them as appendices. Once \verb|\appendix|
550
is called, all subsequent sections will appear as
553
\section{Title of appendix} Each one will be sequentially lettered
554
instead of numbered. Theorem-like environments, subsections,
555
and equations will also have the section number changed to a letter.
557
If there is only {\em one} appendix, however, the \verb|\Appendix|
558
(with a capital letter) should be used instead. This produces only
559
the word {\bf Appendix} in the section title, and does not add a letter.
560
Equation numbers, theorem numbers and subsections of the appendix
561
will have the letter ``A'' designating the section number.
563
If you don't want to title your appendix, and just call it
564
{\bf Appendix A.} for example, use \verb|\appendix\section*{}|
565
and don't include anything in the title field. This works
566
opposite to the way \verb|\section*| usually works, by including the
567
section number, but not using a title.
570
Appendices should appear before the bibliography section, not after,
571
and any acknowledgments should be placed after the appendices and before
574
\begin{thebibliography}{1}
575
\bibitem{GoMiSa} {\sc M. Goossens, F. Mittelbach, and A. Samarin},
576
{\em The} \LaTeX\ {\em Companion}, Addison-Wesley, Reading, MA, 1994.
578
\bibitem{Higham} {\sc N.~J. Higham}, {\em Handbook of Writing for
579
the Mathematical Sciences}, Society for Industrial and Applied
580
Mathematics, Philadelphia, PA, 1993.
582
\bibitem{Lamport} {\sc L. Lamport}, \LaTeX: {\em A Document
583
Preparation System}, Addison-Wesley, Reading, MA, 1986.
585
\bibitem{SerLev} {\sc R. Seroul and S. Levy}, {\em A
586
Beginner's Book of} \TeX, Springer-Verlag, Berlin, New
588
\end{thebibliography}
592
%% end of file `docultex.tex'
b'\\ No newline at end of file'