diff options
Diffstat (limited to 'Master/texmf-dist/tex/plain/siam/docuptex.tex')
-rw-r--r-- | Master/texmf-dist/tex/plain/siam/docuptex.tex | 456 |
1 files changed, 456 insertions, 0 deletions
diff --git a/Master/texmf-dist/tex/plain/siam/docuptex.tex b/Master/texmf-dist/tex/plain/siam/docuptex.tex new file mode 100644 index 00000000000..2f673f9b7bf --- /dev/null +++ b/Master/texmf-dist/tex/plain/siam/docuptex.tex @@ -0,0 +1,456 @@ +%% +%% SIAM Plain TeX macro documentation. +%% Paul Duggan +%% 9-15-94 + +\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} +\SIMAC +\date{October 1994} +\copyyear{1994} +\code{000} + +\title Using SIAM's \TeX\ Macros\endtitle + +\shorttitle{USING SIAM'S \TeX\ MACROS} + +\recdate{*}{August 9, 1994. +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 duggan@siam.org}). Questions, comments, +or corrections to this document may be directed to that e-mail address} + +\abstract{Documentation is given for use of the SIAM \TeX\ macros. +Instructions and suggestions for compliance with SIAM style +standards are also included.} +\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. However, +it is still necessary to proofread the galley proofs 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. + +When submitting electronic files (electronic submissions) +(to {\tt tex@siam.org}) write the journal, issue, and author's +name in the subject line of the message. +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, +information on how it differs 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. + +SIAM uses MS-DOS-based computers for \TeX\ processing. Therefore +all filenames should be restricted to eight characters or less, +plus a three character extension. + +Once the files are corrected here at SIAM, we will mail the revised +proofs to be read against the original edited hardcopy +manuscript. We are not +set up to shuttle back and forth varying electronic versions of each +paper, so we must rely on hard copy of the galleys. 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, because electronic transmission +can introduce errors. + + +This 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. This font along with other +AMS-\TeX\ fonts can be retrieved from the American Mathematical +Society via anonymous FTP to {\tt e-math.ams.com}. + +\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: +\input siamptex.sty +\overfullrule=0pt + +: + +The \verbatim:\overfullrule: should be set wider than zero points +while still being edited by the author to assist in locating +lines that extend beyond the margins. + + +The ``slugline,'' which contains the journal and copyright information, is +created by special commands following the \verbatim:\topmatter:. + +\verbatim: +\SIMAX +\vol{0} +\no{0, pp.~000--000} +\date{April 1995} +\copyyear{1995} +\code{000} + +: +Because authors will probably not know exact +volume, number, date, or code, insert zeros in their place as +above. SIAM will place the appropriate information in +the commands in production; however, the commands must be used. +\verbatim:\SIMAX:, \verbatim:\SIAP:, \verbatim:\SICOMP:, +\verbatim:\SICON:, \verbatim:\SIDMA:, \verbatim:\SIMA:, +\verbatim:\SIMAX:, \verbatim:\SINUM:, \verbatim:\SIOPT:, +\verbatim:\SISC:, and \verbatim:\SIREV: are the commands provided +to include the journal title in the heading. + +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} + +: + +If more than two authors are included, each should be separated +by a comma after the \verbatim:\fnmark{}: command. If more than one +author shares common footnote information, then a common footnote +and footnote mark should be used. + +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:\break commands are used to include the +abstract, key words, and AMS subject classification 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 telnet e-math.ams.com}; login +and password are both {\tt e-math}). +Complete the topmatter section by including \verbatim:\endtopmatter:. + + + +\heading{3}{Equations and mathematics} +Equations and mathematics +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. + +Clear equation formatting using \TeX\ can be challenging. Aside from +the regular \TeX\ documentation, authors will find Nicholas +J. Higham's book {\it Handbook of Writing for the Mathematical +Sciences\/} [1] useful for guidelines and tips on formatting with +\TeX. The book covers many other topics related to article +writing as well. + +Authors commonly make mistakes by using + \verbatim:<:, \verbatim:>:, \verbatim:\mid:, and +\verbatim:\parallel: as delimiters, instead of +\verbatim:\langle:, \verbatim:\rangle:, \verbatim:|:, +and \verbatim:\|:. The incorrect symbols have particular +meanings distinct from the correct ones and should not be confused. + +\bigskip +\eightpoint +\halign{#\hfil\quad&&#\hfil\quad\cr +&{\bf Wrong} &&&& {\bf Right}&\cr +&\verbatim:<x, y>: & $<x, y>$ &&& + \verbatim:\langle x, y\rangle: & $\langle x, y\rangle$ \cr +&\verbatim:5 < \mid A \mid: & $5 < \mid A \mid$ &&& + \verbatim:5 < |A|: & $5 < |A|$ \cr +& \verbatim:6x = \parallel x: \cr +&\verbatim: - 1\parallel_{i}: & $6x = \parallel x - 1\parallel_{i}$ &&& + \verbatim:6x = \|x - 1\|_{i}: & $6x = \| x - 1\|_{i}$\cr} + \tenpoint\rm +\bigskip + +Another common author error is to put large (and even medium sized) +matrices in-line with the text, rather than displaying them. This +creates unattractive line spacing problems, and should be assiduously +avoided. Text-sized matrices (like $({a \atop b} {b \atop c})$) might +be used but anything much more complex than the example cited will +not be easy to read and should be displayed. + +More information on the formatting of equations and aligned +equations is found in Knuth [2]. Authors bear primary responsibility +for formatting their equations within margins and in an aesthetically +pleasing and informative manner. + +The SIAM macros include additional roman math words, or ``log-like" +functions, to those provided in standard \TeX. The following +commands are added: \verbatim:\const:, \verbatim:\diag:, \verbatim:\grad:, +\verbatim:\Range:, \verbatim:\rank:, and \verbatim:\supp:. +These commands produce the same word as the command name +in math mode, in roman type. + + +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 [3] 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 argument 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 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 [3]. + +\heading{4.1}{Punctuation} +All standard punctuation and all numerals should be set in roman type +(upright) even within italic text. +The only exceptions are periods and commas. They may +be set to match the surrounding text. + +References to sections should use the symbol \S, generated by +\verbatim:\S:. (If the reference begins a sentence, the term ``Section'' +should be spelled out in full.) Authors should not redefine +\verbatim:\S:, say, to be a calligraphic S, because \verbatim:\S: +must be reserved for use as the section symbol. + +Authors sometimes confuse the use of various types of dashes. +Hyphens (\verbatim:-:, -) are used for some compound words (many +such words should have no hyphen but must be run together, +like ``nonzero,'' or split apart, like ``well defined.'' +Minus signs (\verbatim:$-$:, $-$) +should be used in math to represent subtraction or negative numbers. +En dashes (\verbatim:--:, --) are used for ranges (like 3--5, +June--August), or for joined names (like Runge--Kutta). Em dashes +(\verbatim:---:, ---) are used to set off a clause---such as this +one---from the rest of the sentence. + +\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 4.1} +Sample theorem included for illustration. +Numbers and parentheses, like equation $(3.2)$, should be set +in roman type. 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 sample produces Theorem 4.1 below. + +\thm{Theorem 4.1} +Sample theorem included for illustration. +Numbers and parentheses, like equation $(3.2)$, should be set +in roman type. 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 + + +The \verbatim:\cor:, \verbatim:\dfn:, \verbatim:\lem:, and +\verbatim:\prop: 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 two ems (\verbatim:\qquad:) +from the end of the equation on line with it horizontally. + +\heading{5}{Figures and tables} +Figures and tables are best handled in \TeX\ by putting them within a +\verbatim:\topinsert \endinsert: or \verbatim:\midinsert \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. A sample follows. + +\verbatim: +\midinsert +\vskip 22pc +\centerline{\eightpoint{\smc Fig.~5.1}. \it Italic caption text.} +\endinsert + +: + +SIAM tables should be formatted in eight-point type, with enough +space left between entries and surrounding lines so that they do not +touch. Take particular care with super- and subscript characters. +See Knuth [2] or Seroul and Levy [3] for more information on +the formatting of tables in \TeX. Table captions are similar to +figure captions, but the word ``Table'' and the number appear on +a separate line from the caption text. + +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 (from wherever you acquired +{\tt psfig}) for more details on the use +of this style option. It is a good idea to submit high-quality +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 high-quality +hardcopy when the manuscript is submitted. + +\heading{6}{Bibliographies} +References are handled using the \verbatim:\Refs: command. +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. +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 W. Riter}, +{\it Title of another paper appearing in a book}, in The Book +Title, E.~D. One, E.~D. Two, and A.~N. Othereditor, eds., +Publisher, Location, 1992, pp.~000--000.\endref + +\ref 4\\ {\smc A.~U. Thorone, A.~U. Thortwo, and A.~U. Thorthree}, +{\it Title of Book{\rm III:} Note Initial Caps}, +Publisher, Location, pp.~000--000, 1994.\endref + +\ref 5\\ {\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 for SIAM to process +but it is possible that errors may be introduced 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. This method is acceptable +but not encouraged. + +\heading{7}{Conclusion} Many other style suggestions and tips +could be given to help authors but are beyond the scope of this +document. Simple mistakes can be avoided by increasing your familiarity +with how \TeX\ functions. The books referred to throughout this document +are also useful to the author who wants clear, beautiful typography +with minimal mistakes. + +\Refs + +\ref 1\\ {\smc N.~J. Higham}, {\it Handbook of Writing for +the Mathematical Sciences}, Society for Industrial and Applied +Mathematics, Philadelphia, PA, 1993.\endref + +\ref 2\\ {\smc D.~E. Knuth}, {\it The \TeX book}, Addison Wesley, +Reading, MA, 1986.\endref + +\ref 3\\ {\smc R. Seroul and S. Levy}, {\it A Beginner's Book of +{\rm \TeX}}, Springer-Verlag, Berlin, New York, 1991.\endref + + +\bye |