diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog | 777 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile | 33 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS | 11 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/README | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/aspell.en.pws | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk | 4950 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html | 5845 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf | bin | 696267 -> 784210 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi | 5077 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt | 7297 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml | 7877 |
11 files changed, 22141 insertions, 9732 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog index 8631bf40d6f..fcf49d6c6f3 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog @@ -1,10 +1,783 @@ +2015-10-25 Jim Hefferon <jhefferon@smcvt.edu> + + * Correct errors reported by CTAN, including my lack + of a SVN $Id tag for the README. + +2015-10-24 Jim Hefferon <jhefferon@smcvt.edu> + + * New version for CTAN, since there were lots of updates over the + summer. Just English for the moment; we need to smooth the process + for other languages. + + * Makefile (distzip): the phony target was not doing the recipies; + changed name of a variable to distzip. + +2015-10-12 Karl Berry <karl@freefriends.org> + + * Makefile (dist): remove spanish stuff, just do english. + +2015-10-12 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Footnotes): Add remark that getting biblio + references in footnotes depends on the bibliographic style. + +2015-10-11 Vincent Belaïche <vincentb1@users.sourceforge.net> + + * latex2e-fr.texi (Page breaking): Translate menu entries + (\cleardoublepage, \clearpage, \newpage, \enlargethispage) + (\pagebreak & \nopagebreak): Translate these nodes + (Footnotes, \footnote, \footnotemark, \footnotetext) + (Footnotes in a table, Footnotes in section headings): Take into + account Jim's edits of 2015-10-09, 2015-10-04, 2015-10-03, & + 2015-09-29. + + * latex2e.texi (\cleardoublepage, \clearpage): Clarify that only + pending floating tables & figures are cleared. + (\newpage): `see @code{\clearpage} above' -> `@pxref{\clearpage}' + (Footnotes): Make the exact quotation of Noël Coward, and correct + his first name spelling. + +2015-10-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Multiple references to a footnote): Add this node. + Adjust related nodes. + +2015-10-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Footnotes of footnotes): Add this node. + +2015-10-10 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\makelabels): Add more on how to customize + label sizes, etc. + +2015-10-09 Vincent Belaïche <vincentb1@users.sourceforge.net> + + * latex2e-fr.texi (Environments): Merge menu entries for nodes + quote & quotations after Jim's edits of 2015-09-28 + (quotation and quote): Merge nodes quote & quotations after Jim's + edits of 2015-09-28 + (tabbing): Translate this node. + +2015-10-09 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Footnotes in a section heading): Add node, + provide examples. + +2015-10-08 Vincent Belaïche <vincentb1@users.sourceforge.net> + + * latex2e.texi (\makelabels): @var{...}-ify argument 'to addess', + and @code{...}-ify class name. + (\signature): Improve wording. Remove spurious space before '\\' + in the \signature example with picture. + + * latex2e-fr.texi (Low-level font commands): typo. + (\item): typo. + (Letters): Translate from Jim's updates. + (Letters): Remove menu entries for \startbreaks & stopbreaks, as + per Jim's update. + (\makelabels): Translate from Jim's updates and improve text + significantly. + (\name): Translate this node. + (\opening): Translate this node. + (\ps): Add synopsis, as per Jim's update. + (\signature): Translate this node. + (\startbreaks, \stopbreaks): Remove nodes \startbreaks & + stopbreaks, as per Jim's update. + (\telephone): Take into account Jim's updates. + +2015-10-04 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Footnotes in a table): Provide examples. + Fold minipage discussion into opening. + +2015-10-03 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Footnotes, Footnotes in a table): Provide examples. + This is a confusing topic. + +2015-09-29 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Footnotes): Provide examples. + +2015-09-28 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\quotation and \quote): Combine the two, + contrast them, provide example. + +2015-09-27 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Letters): \opening is required. + +2015-09-26 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\makelabel): Reword, add examples. Omit \stopbreaks + and \startbreaks as those are not user-directed commands. + +2015-09-25 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\signature): Reword, add examples. + +2015-09-23 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Letters \address, \closing, \location): Add examples. + The intent of \location is hard to understand; for Willy the Mailboy? + +2015-09-23 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Letters): Add synopsis, examples. + +2015-09-22 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-fr.texi (filecontents): Add Jim's 2015-09-18 (r439) edits. + (\addvspace): Add Jim's 2015-09-13 (r432) edits. + (\vspace): Translate this node. + + * latex2e.texi (filecontents): Use `write' instead of `create' also in concept index. Improve wording + + + * latex2e{,-es,-fr}.texi: Improve Emacs cookie to force LF eol + + * latex2e{,-es,-fr}.{dbk,html,info,txt,xml}: Set svn property svn:eol-style to LF + + * latex2e-{es,fr}.{dbk,html,info,txt,xml}: Compile these files + again, because of eol problem. + +2015-09-21 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-{es,fr}.{dbk,dvi,html,info,pdf,txt,xml}: Compile these files + + * latex2e-fr.texi (\addvspace): typo. + +2015-09-18 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (filecontents): Corrections suggested by JB. + +2015-09-17 Vincent Belaïche <vincent.belaiche@gmail.com> + + * ChangeLog: Correct typo on Jim's surname Hefferson->Hefferon. + + * latex2e.texi (Subscripts & superscripts): typo sub->super. Improve wording. + (\hrulefill \dotfill): Use `@dmn{...}' rather than + `@tie{}...' for the spacing to unit. + + * latex2e-fr.texi (\newline): Translate this node. + (figure): place \label after caption, following Jim's 2015-09-11 + change. + (Subscripts & superscripts): translate Jim's 2015-09-15 update. + (\hrulefill \dotfill) Merge nodes \hrulefill and \dotfill, and + take Jim's 2015-09-13 additions + +2015-09-15 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Subscripts & superscripts): Add examples. + +2015-09-15 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e.texi (Starting and ending): Add @cindex environment + (Spaces, \(SPACE) and \@@, \(SPACE) after CS): Move text how to + control space gobbling after a control sequence from node + `\(SPACE) and \@@' to a new node `\(SPACE) after CS', and add more + tricks to do that. + + * latex2e-fr.texi (Starting and ending) + (Spaces, \(SPACE) and \@@, \(SPACE) after CS)(Spaces): Same + changes as for latex2e.texi. + (Overview): add @: after some abbrev ending periods. + (Font styles): Follow Karl's changes of + 2015-04-26, "deux choses très différentes"->"deux constructions + sans relation l'une avec l'autre" + (Starting and ending): Follows Karl's change of 2015-04-26 + (\- (hyphenation)): Translate this node. + (\noindent): Follow Jim's changes of 2015-09-14: example + how to + suppress indentation in a whole document. + (Spaces, \@@, \(SPACE)): rename node \AT->\@@ following Karl's + change of 2015-05-05, and \SPACE->(SPACE) following Jim's change + of 2015-09-08. + (\frenchspacing) Add new nodes, following Jim's edits of 2015-09-12. + (beamer template, book template): Follow Karl's changes of + 2015-04-26: transpose to make alphabetical. + (beamer template, tugboat template, beamer template): Translate + these nodes. + (Command line): Follow Karl's changes of 2015-04-26: xref TeX + engines, --help, etc. + (eqnarray): Follows Karl's change 2015-04-26 `much + like'->`similar', plus typo. + + +2015-09-14 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\noindent): Add example. + +2015-09-14 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e.texi (Spacing in math mode): Add missing @findex entries + for \thickspace, \medspace & \thinspace. Typo tht->that. + + * latex2e-fr.texi (Units of length, Spacing in math mode): + Translate these nodes, move the math spacing to the `Spacing in + math mode' node, following the Jim's 2015-09-06 change. + +2015-09-13 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\hrulefill \dotfill): Add example, merge the + two nodes. + +2015-09-13 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\addvspace): Add explanation, and link to + Lengths. + +2015-09-12 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\vspace, \vfill): Add wording and example to + each node. + +2015-09-12 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\frenchspacing): Move node to Spacing. + +2015-09-12 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\frenchspacing): Add this node. + +2015-09-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newline): Add description of what happens in + a table. Add example. + +2015-09-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\\): Split \\ from \\*. Mention + \newline. Add example. + +2015-09-09 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\(SPACE) and \@): Combine the two nodes. Include + description of \@ both before and after a period. + +2015-09-08 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\(SPACE)): Extend explanation. Change name to + include the parens (possible a newbie would type \SPACE?) + +2015-09-07 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Lengths, \hspace): Give a definition of rigid + and rubber lengths, and of infinite stretchability. Adjust + definition of \hspace to not use square braces as metacharacter. + +2015-09-06 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Spacing in math mode): Move math mode lengths + to here and add whether they work also in text mode. + +2015-09-04 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-fr.texi: Add macroes BES & BESU to support compilation of math symbols with texi2pdf. + (Symbolic footnotes): Complete translation of this node + (Making paragraphs): typo ligne->lignes. + (Marginal notes): Translate this node. + (Math formulas): Translate this node. + (Subscripts & superscripts): Translate this node. + (Math symbols): Initiate translation of this node (not yet complete...). + (Spacing in math mode): Translate section title. + (\thispagestyle): Translate this node. + (Spaces): typo, change gender of word `espace' (feminine instead + of masculine as far as spacing is concerned). + + * latex2e.texi: Add macroes BES & BESU to support compilation of math symbols with texi2pdf. + (Math symbols): typo succceeds-> succeeds, (symbols \succ & \succeq). + (Marginal notes): Add reference to Document class options as far + as one-sided, two-sided and two-column layouts are concerned. + (Subscripts & superscripts): Use @var{...} instead of @i{...} for argument `exp'. + (Math symbols): Use macros BES and BESU in roder to fix broken texi2pdf compilation. + (Math symbols): typo operatior->operator (symbols \cap, \circ, \cup, \bigodot, \oplus, \otimes + (Math symbols): symbol \varsigma : variant \pi->\sigma ; symbol \vartheta : variant \pi->\vartheta. + (\makebox): reword is specified->can be overriden, because width is optional. + (\makebox): @code{...}-ify environment name picture. + +2015-08-29 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-fr.texi (\linethickness): Typo. + (\thicklines, \thinlines, \shortstack, \/, \hrulefill) + (\bigskip \medskip \smallskip, tabular, Lengths, \dotfill, \addvspace): Translate this node. + (table): Typo. + (Units of length): Add this node from Jim's 2015-08-26 edits. + + * latex2e.texi (Lengths): Make `length' a @dfn{...} rather than a @code{...}. + (Units of length): add concept index entries `ex' and `m-width' + (\addvspace): @var{...}-ify word `length'. + + +2015-08-27 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e.texi (Units of length): Use `@dmn{...}' rather than + `@tie{}...' in new node added by Jim. + +2015-08-26 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Units of length): Add new node in Lengths. + +2015-08-25 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e.texi (tabular): typo : horozontal->horizontal. + +2015-08-24 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e.texi (picture): (width,height)(x offset,y offset)->(@var{width},@var{height})(@var{xoffset},@var{yoffset}) + (picture): make position a concept index entry, and @dfn{...}-ize it. + (picture): Improve wording as far as the two arguments of picture environment are concerned. + + * latex2e-fr.texi (minipage): complete translation of this node. + (picture): Translate this node. + (\framebox (picture)): @var{width}->@var{largeur} + +2015-08-23 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-fr.texi (file preamble): Add comment about glossary + resources useful for French translation + (file preamble) improve wording. + (Layout): add Float menu entry, as per Jim Hefferon's 2015-08-22 and 2015-08-21 changes. + (Floats, figure, table) Translate Jim Hefferon's 2015-08-22 and + 2015-08-21 changes to French. + (\centering): typo + (flushleft, \raggedright): Improve wording. + (flushright, \raggedleft): Translate these nodes. + (quotation, Making paragraphs): ligne blanche->ligne à blanc + + * latex2e.texi (Floats): typo insert comma. + (Floats): figure->float + (Floats): make "float page" a concept index entry, and @dfn{...} it. + (Floats): restrict the word "specifier" to one letter element of + parameter, use word "argument" for the full string of specifiers. + (Floats): typo acceptible->acceptable + (figure): text->title, improve @var name + (flushright): string->control sequence + (table): make title a @var, and add missing optional loftitle argument. + +2015-08-22 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Floats): Change some wording, move description of + how float body is typeset to figure and table nodes. + +2015-08-22 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (various): Corrected Subversion mistake overwriting + changes in other spots. + +2015-08-21 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Floats, figure, table): Break the float material + common out to a separate node. Add descriptions of how to deal + with issues. Shrink the figure and table nodes by the common + material. + +2015-08-20 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-fr.texi (Output files, @TeX{} engines, \line) + (Glossaries): Remove @acronym on Karl's request + (\raggedright): Translate this node to French. + + * latex2e.texi (Output files, @TeX{} engines): Remove @acronym on Karl's request + + * latex2e-es.texi (Glosarios): Remove @acronym on Karl's request + +2015-08-19 Karl Berry <karl@freefriends.org> + + * latex2e.texi (\parbox): reword. + (flushleft): missing period. + + * Makefile (xref_suffixes): no auxs or tocs. + +2015-08-19 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e.texi (flushleft): string->control sequence. + + * latex2e-fr.texi (flushleft): Translate this node. Reword string->control sequence. + + * Makefile (xref_suffixes): New variable usable for realclean target doing a *real* clean. + + * latex2e.texi (\oval): Reword 'portion' to 'half' and also add + optional arguments 'tr', 'br', 'bl' and 'tl'. + + * latex2e-fr.texi (Top, Starting and ending): Starting & + ending->Starting and ending, node renaming. + (Overview): typo in chapter title + (Overview): Translates 2015-08-14/18 changes by Jim Hefferon, + this implies making node 'Starting and ending' a subnode of node + 'Top', and creating new nodes 'Output files', '@TeX{} engines' and + '@LaTeX{} command syntax' + (Environment, Declaration): new nodes, sbubnodes of '@LaTeX{} + command syntax', translated from 2015-08-14 change by Jim + Hefferon. + (description, enumerate): Translate 2015-08-17 changes by Jim + Hefferon. + (list, \item): Translate 2015-08-13 changes by Jim Hefferon: add + \item node, and subordiante it to list node. + (\multiput): Finalize translation of this node. + (\oval): Translate this node, with rewording portion->half. Add + also optional arguments 'tr', 'br', 'bl' and 'tl'. + + * latex2e.texi (Overview): file-> input file, for sake of clarity. + (Overview): Programs that implementation @LaTeX{}->Programs that + can compile @LaTeX{} source. + (Output files, @TeX{} engines): Use @acronym{...} for DVI and PDF. + (@TeX{} engines): command->system command, for sake of clarity. + (@LaTeX{} command syntax): command->command names, for sake of clarity. + +2015-08-18 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (eqnarray, equation): Add more description. Add + example to eqnarray. Add note about amsmath to equation. + +2015-08-17 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (enumerate): Add more description. Combine best + parts of this and description description. + +2015-08-17 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (description): Add error message if \item is + left out. + +2015-08-14 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Environment, Declaration): Create these two nodes + subordinate to LaTeX command syntax. Refer node item to LaTeX + command syntax. + +2015-08-13 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (list, \item): Add node for this command, subordinate to + the list node. + +2015-08-13 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (array): Fix description of optional position + argument for array. + +2015-08-12 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (displaymath): Integral wrong. Couple of other + typos. + +2015-08-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (document): Add nodes for \AtBeginDocument and + \AtEndDocument. + +2015-08-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (displaymath): Add detail and an example. Include + note on why $$ is not recommended. + +2015-08-09 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (description): Add detail and an example. + +2015-08-08 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (center, \centering): Add detail, including + distinguishing the two and examples. + +2015-08-05 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e.texi (\indent): remove "width of" concering concerning + \parindent length. + + * latex2e-es.texi (Acentos): Change "sobre" to "debajo de" for \b + (\indent): change "al ancho de la longitud" to "la longitud" + concerning \parindent length. + + * latex2e-fr.texi (Tables of contents): Translation of this node. + (\alph \Alph \arabic \roman \Roman \fnsymbol, Boxes): Typoes. + +2015-08-03 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (array): Adjust wording. + +2015-08-02 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (array): Refer to tabular for details. Add suggestion + to use amsmath to get fences, and change example to make + justification vaguely defensible. + +2015-08-02 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (multicolumn): Adjust description of how intercolumn + material is placed. I shall get this right eventually, I suppose. + +2015-08-01 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (multicolumn, vline, cline, hline): Adjust + wording. + +2015-07-31 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (vline, cline, hline): Add examples. Also describe + how columns are counted. + +2015-07-30 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-fr.texi (Top): Correct menu item French translation for "Making paragraphs" + (itemize): typo, remove left-over English word "dash" + (Making paragraphs): typoes. + (\indent, \noindent, \parskip, \parbox): Translate to French these nodes. + + * latex2e.texi (Text symbols): Correct -- for --- for en-dash + +2015-07-29 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-es.texi (Acentos): Make references between \underbar and \b. + + * latex2e.texi (Accents): Make references between \underbar and \b. + + * latex2e-fr.texi (Accents, quote): Translate these nodes. + (Accents): Make references between \underbar and \b. + +2015-07-22 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (tabular, multicolumn): Add more content, + and examples. + +2015-07-22 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Page layout parameters): Add marginal notes + parameters; correct some default values and adjust wording + for uniformity. + +2015-07-15 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Page layout parameters): Add paperheight + and paperwidth; also list those sizes in Document class options. + +2015-07-13 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Done all symbols. + +2015-07-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Through the S's. + +2015-07-10 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Through the P's. + +2015-07-09 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Into the P's. Move + the unicode glyph to the start of each entry to make + easier scanning for the desired symbol. + +2015-07-08 Vincent Belaïche <vincent.belaiche@gmail.com> + + * latex2e-fr.texi (Line breaking, \savebox): Translation to French. + (Sectioning): Typo. + +2015-07-08 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Through the N's. + +2015-07-07 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Through the M's. + +2015-07-06 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): More L's. + +2015-07-05 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Unicode code points into L's. + +2015-07-03 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Unicode code points through G. + +2015-07-02 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Unicode code points through D. + +2015-07-02 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Unicode code points through B. + +2015-07-01 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Math symbols): Add unicode code points to a few; + experiment with relevant info. + +2015-06-23 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\flushbottom, \raggedbottom): Expand definition. + Change word from `declaration' to `command'. + +2015-06-22 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\twocolumn): Expand definition of the two-column + parameters. + +2015-06-21 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\twocolumn): Expand definition of the double + float parameters. + +202015-06-20 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\twocolumn): Add example. + +2015-06-20 Karl Berry <karl@freefriends.org> + + * latex2e.texi (\value, \newlength): wording. + +2015-06-19 Karl Berry <karl@freefriends.org> + + * latex2e.texi (Document class options): mention the geometry package. + (@TeX{} engines) <xelatex>: mention xdv files. + (\newcommand & \renewcommand): reorder examples; still in process. + +2015-06-18 Karl Berry <karl@freefriends.org> + + * latex2e.texi (\newsavebox): wording. + +2015-06-17 Karl Berry <karl@freefriends.org> + + * latex2e.texi (\newfont): put obsolete note earlier. + (\newtheorem): wording. + +2015-06-16 Karl Berry <karl@freefriends.org> + + * latex2e.texi (Low-level font commands): reformat the tables. + +2015-06-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Low-level font commands): More about options. + +2015-06-11 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Low-level font commands): Add some information about + options. + +2015-06-09 Karl Berry <karl@freefriends.org> + + * latex2e.texi: Let's consistently have one blank line + between the sectioning command and the following index entries, + one blank line above @example, and two blank lines above @node. + It's a theory ... + (\newfont): wording. Typos. + +2015-06-09 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newfont): Couple of minor wording changes. + +2015-06-06 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newfont): Expand definition. Add example. + Warn that it is obsolete. + +2015-06-06 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newtheorem): Expand definition. Add examples + covering both optional arguments. + +2015-06-05 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newsavebox): Expand definition. + +2015-06-04 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Document class options): To a4paper, etc., + add note that pdflatex, xelatex, lualatex do not set physical + page size. + +2015-06-03 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\value): Expand description, put in warning about + \protect, add examples. + +2015-06-02 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\protect): Expand description, add examples. + +2015-05-30 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newlength): Add details, including that the name + must begin with a backslash. + +2015-05-29 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\providecommand): Add node. + +2015-05-28 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newcommand & \renewcommand): Realized environments + do delimit scope. + +2015-05-27 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newcommand & \renewcommand): Copy recent edits to + \newcommand over to \newenvironment; make needed adjustments. + +2015-05-26 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newcommand & \renewcommand): Add two fine points + about \newcommand. + +2015-05-25 Karl Berry <karl@freefriends.org> + + * Makefile (texi2html_top): New variable. + (texi2html): use it. + + * latex2e.texi (\label), + (Font styles), + (\newcounter, \stepcounter, \refstepcounter), + (\newcommand & \renewcommand): + tweak new and old examples and text. + (Math formulas): Consistently use "xx" with "not in plain". + +2015-05-25 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newcommand & \renewcommand): Add examples. Drop + square brackets around * since square brackets are significant. + +2015-05-22 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\label): Add example of \label picking up + numbering in two places. + +2015-05-19 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Font styles): Add that \mathxx commands do not + nest. Move them to make a different, third, area. Break \emph out of + non-semantic command list. + +2015-05-17 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (many nodes): Corrections to typos reported by + Justin Gassner. + +2015-05-16 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\newcounter, \stepcounter, \refstepcounter): Expand + definitions, particularly of the definition of one counter numbered + within the other. + +2015-05-15 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (\usecounter): Expand definition; give example. + +2015-05-13 Jim Hefferon <jhefferon@smcvt.edu> + + * latex2e.texi (Counters): reword to clarify backslash. + 2015-05-12 Karl Berry <karl@freefriends.org> * latex2e.texi (@settitle): unofficial. (About this document): reword a bit. (UPDATED): now it's May. More indexing. - + * Makefile (check-dw): new target. * latex2e.texi: remove doubled words. @@ -84,7 +857,7 @@ 2015-04-08 Karl Berry <karl@freefriends.org> * latex2e.texi (\bigskip \medskip \smallskip): add defaults, - other tweaks. From Jim Hefferson, 7 Apr 2015 23:45:50. + other tweaks. From Jim Hefferon, 7 Apr 2015 23:45:50. 2015-04-07 Karl Berry <karl@freefriends.org> diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile index 8ccecf34c77..04277eb0274 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile @@ -1,4 +1,4 @@ -# $Id: Makefile 333 2015-05-12 17:12:37Z karl $ +# $Id: Makefile 462 2015-10-24 20:37:02Z jhefferon $ # Public domain. Originally written 2006, Karl Berry. # Makefile for latexrefman. @@ -6,6 +6,9 @@ en_tex_output = latex2e.dvi latex2e.pdf es_tex_output = latex2e-es.dvi latex2e-es.pdf fr_tex_output = latex2e-fr.dvi latex2e-fr.pdf # +xref_suffixes := ky cp vr fn cp pg tp +xref_suffixes := $(xref_suffixes) $(addsuffix s,$(xref_suffixes)) +xref_suffixes := aux log toc $(xref_suffixes) mi_suffixes = dbk html info txt xml en_mi_output = $(addprefix latex2e., $(mi_suffixes)) es_mi_output = $(addprefix latex2e-es., $(mi_suffixes)) @@ -21,10 +24,13 @@ texi2pdf = texi2pdf --batch --tidy --build-dir=$*.t2pdf # makeinfo = makeinfo texi2docbook = $(makeinfo) --docbook -texi2html = $(makeinfo) --html --no-split +texi2html = $(makeinfo) --html --no-split $(texi2html_top) texi2info = $(makeinfo) --no-split texi2txt = $(makeinfo) --plaintext --no-split texi2xml = $(makeinfo) --xml +# +# Go somewhere useful from Top. +texi2html_top = -c TOP_NODE_UP_URL=http://tug.org/texinfohtml/ %.pdf: %.texi $(texi2pdf) $< @@ -69,28 +75,21 @@ distclean clean mostlyclean: rm -rf latex2e*.t2* realclean maintainer-clean: distclean - rm -f $(addprefix latex2e*., pdf dvi $(mi_suffixes)) + rm -f $(addprefix latex2e*., pdf dvi $(mi_suffixes) $(xref_suffixes)) -# dist. -# -# We combine languages into one zip for upload. Will change if the -# translations ever become separately uploaded. -# Don't bother including .dvi files. +# dist for CTAN. Also update NEWS # txt_files = ChangeLog Makefile NEWS README aspell.en.pws ltx-help.el -dist = latex2e-help-texinfo.zip +distzip = latex2e-help-texinfo.zip # -dist: all - rm -f spanish; ln -s . spanish +dist: en mkdir latex2e-help-texinfo && cd latex2e-help-texinfo && ln -s ../* . - zip -q $(dist) \ + zip -q $(distzip) \ $(addprefix latex2e-help-texinfo/, $(txt_files) \ - latex2e.texi $(en_mi_output) latex2e.pdf) \ -$(addprefix latex2e-help-texinfo/spanish/, \ - latex2e-es.texi $(es_mi_output) latex2e-es.pdf) - rm -rf latex2e-help-texinfo spanish - @ls -l $(dist); unzip -t $(dist) + latex2e.texi $(en_mi_output) latex2e.pdf) + rm -rf latex2e-help-texinfo + @ls -l $(distzip); unzip -t $(distzip) # A hacky spell check target. # Remove \commandnames to reduce exception list, but not {args} or diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS index 894c9334f10..1ee74e2cd97 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS @@ -1,10 +1,19 @@ -$Id: NEWS 333 2015-05-12 17:12:37Z karl $ +$Id: NEWS 462 2015-10-24 20:37:02Z jhefferon $ NEWS for latex2e.texi, aka the latex2e-help-texinfo package. Public domain. Originally written 1995, Torsten Martinsen. Spanish translation originally from Nacho Pacheco. French translation originally from Vincent Belaiche. ---------------------------------------------------------------- +Changes in Oct 2015 release: + +Many examples added, often using typical constructs. +Extend many entries to include points frequently asked. +Show list of math characters using Unicode glyphs. +Translations not yet part of update; needs to be worked out. +Thanks to Vincent Belaiche for many contributions. + +---------------------------------------------------------------- Changes in May 2015 release: Usual bug fixes, more indexing, template updates. diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/README b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/README index 45d1a5d5abf..6a87140bfaf 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/README +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/README @@ -1,4 +1,4 @@ -$Id: README 328 2015-05-07 18:33:27Z karl $ +$Id: README 463 2015-10-25 18:16:55Z jhefferon $ README for latex2e.texi, aka the latex2e-help-texinfo package. Public domain. This file originally written 2008, Karl Berry. diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/aspell.en.pws b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/aspell.en.pws index d7b7e81f524..36cd313760a 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/aspell.en.pws +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/aspell.en.pws @@ -59,3 +59,7 @@ xyz zet ptr usrguide +Avant +Garde +fd +xdv diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk index 960c331c619..dd1f9b3d58a 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk @@ -4,7 +4,7 @@ <!ENTITY latex "LaTeX"> ]> <book id="latex2e.dbk" lang="en"> -<title>&latex;2e unofficial reference manual (May 2015)</title> +<title>&latex;2e unofficial reference manual (October 2015)</title> <!-- %**end of header (This is for running Texinfo on a region.) --> <!-- latex 2.09 commands should all be present now, --> @@ -19,6 +19,8 @@ <!-- xx merge http://mirror.ctan.org/latex2e-reference.tar.gz --> <!-- xx merge permuted-index --> <!-- xx merge latex-manual from savannah --> +<!-- xx merge display style math --> +<!-- xx vertical mode, horizontal mode --> <!-- --> <!-- xx The typeset source2e has an index with all kernel --> <!-- xx commands, though some are internal and shouldn't be included. --> @@ -26,7 +28,7 @@ <!-- xx See also http://ctan.org/pkg/macros2e. --> <bookinfo><legalnotice><para>This document is an unofficial reference manual for &latex;, a -document preparation system, version of May 2015. +document preparation system, version of October 2015. </para> <para>This manual was originally translated from <filename>LATEX.HLP</filename> v1.0a in the VMS Help Library. The pre-translation version was written by @@ -63,7 +65,7 @@ into another language, under the above conditions for modified versions. <para>This document is an unofficial reference manual for &latex;, a -document preparation system, version of May 2015. +document preparation system, version of October 2015. </para> <para>This manual was originally translated from <filename>LATEX.HLP</filename> v1.0a in the VMS Help Library. The pre-translation version was written by @@ -99,11 +101,13 @@ into another language, under the above conditions for modified versions. </para> +<!-- Best Effort Symbol --> + <chapter label="" id="Top"> <title>&latex;2e: An unofficial reference manual</title> <para>This document is an unofficial reference manual (version of -May 2015) for &latex;2e, a document preparation system. +October 2015) for &latex;2e, a document preparation system. </para> @@ -186,7 +190,7 @@ should be formatted. It is implemented as a set of related commands that interface with Donald E. Knuth’s &tex; typesetting program (the technical term is that &latex; is a <firstterm>macro package</firstterm> for the &tex; engine). The user produces the output document by giving that -file to the &tex; engine. +input file to the &tex; engine. </para> <para>The term &latex; is also sometimes used to mean the language in which the document is marked up, that is, to mean the set of commands @@ -205,12 +209,12 @@ sensible, such as in plain text, write it as ‘<literal>LaTeX</literal>R <title>Starting and ending</title> <anchor id="Starting-_0026-ending"/><!-- old name --> -<indexterm role="cp"><primary>starting & ending</primary></indexterm> -<indexterm role="cp"><primary>ending & starting</primary></indexterm> +<indexterm role="cp"><primary>starting and ending</primary></indexterm> +<indexterm role="cp"><primary>ending and starting</primary></indexterm> <indexterm role="cp"><primary>hello, world</primary></indexterm> -<para>&latex; files have a simple global structure, with a standard -starting and ending. Here is a “hello, world” example: +<para>&latex; files have a simple global structure, with a standard beginning +and ending. Here is a “hello, world” example: </para> <screen>\documentclass{article} \begin{document} @@ -229,9 +233,10 @@ array of others are widely available. See <link linkend="Document-classes">Docu This area is called the <firstterm>preamble</firstterm>. </para> <para>The <literal>\begin{document} ... \end{document}</literal> is a so-called +<indexterm role="cp"><primary>environment</primary></indexterm> <firstterm>environment</firstterm>; the ‘<literal>document</literal>’ environment (and no others) is -required in all &latex; documents. &latex; provides many -environments itself, and many more are defined separately. +required in all &latex; documents (see <link linkend="document">document</link>). &latex; +provides many environments itself, and many more are defined separately. See <link linkend="Environments">Environments</link>. </para> <para>The following sections discuss how to produce PDF or other output from @@ -333,7 +338,7 @@ overview of the main programs. </term><listitem><indexterm role="cp"><primary>pdf&tex; engine</primary></indexterm> <indexterm role="fn"><primary>etex command</primary></indexterm> <indexterm role="cp"><primary>e-&tex;</primary></indexterm> -<para>In &tex; Live (<ulink url="http://tug.org/texlive">http://tug.org/texlive</ulink>, if &latex; is invoked +<para>In &tex; Live (<ulink url="http://tug.org/texlive">http://tug.org/texlive</ulink>), if &latex; is invoked via either the system command <command>latex</command> or <command>pdflatex</command>, then the pdf&tex; engine is run (<ulink url="http://ctan.org/pkg/pdftex">http://ctan.org/pkg/pdftex</ulink>). When invoked as <command>latex</command>, the main output is a <filename>.dvi</filename> @@ -342,9 +347,9 @@ file; as <command>pdflatex</command>, the main output is a <filename>.pdf</filen <para>pdf&tex; incorporates the e-&tex; extensions to Knuth’s original program (<ulink url="http://ctan.org/pkg/etex">http://ctan.org/pkg/etex</ulink>), including additional programming features and bi-directional typesetting, and has plenty of -extensions of its own. e-&tex; is available on its own as the +extensions of its own. e-&tex; is available on its own as the system command <command>etex</command>, but this is plain &tex; (and produces -<filename>.dvi</filename>). +<filename>.dvi</filename>). </para> <para>In other &tex; distributions, <command>latex</command> may invoke e-&tex; rather than pdf&tex;. In any case, the e-&tex; extensions can be @@ -365,12 +370,19 @@ but this is rarely used. </listitem></varlistentry><varlistentry><term><literal>xelatex</literal> </term><listitem><indexterm role="fn"><primary>xelatex command</primary></indexterm> <indexterm role="cp"><primary>Xe&tex;</primary></indexterm> +<indexterm role="fn"><primary>.xdv file</primary></indexterm> +<indexterm role="fn"><primary>xdvipdfmx</primary></indexterm> <para>If &latex; is invoked with the system command <command>xelatex</command>, the Xe&tex; engine is run (<ulink url="http://tug.org/xetex">http://tug.org/xetex</ulink>). Like Lua&tex;, -Xe&tex; also natively supports UTF-8 Unicode and TrueType and -OpenType fonts, though the implementation is completely different, -mainly using external libraries instead of internal code. Xe&tex; -produces a <filename>.pdf</filename> file as output; it does not support DVI output. +Xe&tex; natively supports UTF-8 Unicode and TrueType and OpenType +fonts, though the implementation is completely different, mainly using +external libraries instead of internal code. Xe&tex; produces a +<filename>.pdf</filename> file as output; it does not support DVI output. +</para> +<para>Internally, Xe&tex; creates an <literal>.xdv</literal> file, a variant of DVI, +and translates that to PDF using the (<literal>x</literal>)<literal>dvipdfmx</literal> +program, but this process is automatic. The <literal>.xdv</literal> file is only +useful for debugging. </para> </listitem></varlistentry></variablelist> <para>Other variants of &latex; and &tex; exist, e.g., to provide @@ -386,27 +398,76 @@ additional support for Japanese and other languages ([u]p&tex;, <indexterm role="fn"><primary>\ character starting commands</primary></indexterm> <indexterm role="fn"><primary>[...] for optional arguments</primary></indexterm> <indexterm role="fn"><primary>{...} for required arguments</primary></indexterm> -<para>In the &latex; input file, a command name starts with a <literal>\</literal>; the -name itself then consists of either (a) a string of letters or -(b) a single non-letter. +<para>In the &latex; input file, a command name starts with a backslash +character, <literal>\</literal>. The name itself then consists of either +(a) a string of letters or (b) a single non-letter. +</para> +<para>&latex; commands names are case sensitive so that <literal>\pagebreak</literal> +differs from <literal>\Pagebreak</literal> (the latter is not a standard command). +Most commands are lowercase, but in any event you must enter all +commands in the same case as they are defined. +</para> +<para>A command may be followed by zero, one, or more arguments. These +arguments may be either required or optional. Required arguments are +contained in curly braces, <literal>{...}</literal>. Optional arguments are +contained in square brackets, <literal>[...]</literal>. Generally, but not +universally, if the command accepts an optional argument, it comes +first, before any required arguments. +</para> +<para>Inside of an optional argument, to use the character close square +bracket (<literal>]</literal>) hide it inside curly braces, as +in <literal>\item[closing bracket {]}]</literal>. Similarly, if an optional +argument comes last, with no required argument after it, then to make +the first character of the following text be an open square bracket, +hide it inside curly braces. +</para> +<para>&latex; has the convention that some commands have a <literal>*</literal> form that +is related to the form without a <literal>*</literal>, such as <literal>\chapter</literal> and +<literal>\chapter*</literal>. The exact difference in behavior varies from command +to command. </para> -<para>A command may be followed by zero, one, or more arguments, either -required or optional. Required arguments are contained in curly -braces, <literal>{...}</literal>. Optional arguments are contained in square -brackets, <literal>[...]</literal>. Generally, but not universally, if the -command accepts an optional argument, it comes first, before any -required arguments. +<para>This manual describes all accepted options and <literal>*</literal>-forms for the +commands it covers (barring unintentional omissions, a.k.a. bugs). </para> -<para>Some commands have a <literal>*</literal> form that is related to the form without -a <literal>*</literal>, such as <literal>\chapter</literal> and <literal>\chapter*</literal>. + + +<anchor id="Environment"/> + +<para>Synopsis: </para> -<para>&latex; commands are case sensitive; neither <literal>\Begin{document}</literal> -nor <literal>\begin{Document}</literal> will work. Most commands are lowercase, -but in any event you must enter all commands in the same case as they -are defined. +<screen>\begin{<replaceable>environment name</replaceable>} + .. +\end{<replaceable>environment name</replaceable>} +</screen> +<para>An area of &latex; source, inside of which there is a distinct +behavior. For instance, for poetry in &latex; put the lines between +<literal>\begin{verse}</literal> and <literal>\end{verse}</literal>. </para> -<para>This manual describes all accepted options and <literal>*</literal>-forms for the -commands it covers (barring unintentional omissions, a.k.a. bugs). +<screen>\begin{verse} + There once was a man from Nantucket \\ + .. +\end{verse} +</screen> +<para>The <replaceable>environment name</replaceable> at the beginning must exactly match that at +the end. This includes the case where <replaceable>environment name</replaceable> ends in a +star (<literal>*</literal>); both the <literal>\begin</literal> and <literal>\end</literal> texts must +include the star. +</para> +<para>Environments may have arguments, including optional arguments. This +example produces a table. The first argument is optional (and causes +the table to be aligned on its top row) while the second argument is +required (it specifies the formatting of columns). +</para> +<screen>\begin{tabular}[t]{r|l} + .. rows of table .. +\end{tabular} +</screen> + +<anchor id="Declaration"/> + +<para>A command that changes the value, or changes the meaning, of some other +command or parameter. For instance, the <literal>\mainmatter</literal> command +changes the setting of page numbers from roman numerals to arabic. </para> </sect1> @@ -440,6 +501,10 @@ see <link linkend="Overview">Overview</link>.) matter, such as a preface, and back matter, such as an appendix (see <link linkend="Front_002fback-matter">Front/back matter</link>). </para> +</listitem></varlistentry><varlistentry><term><literal>letter</literal> +</term><listitem><para>Mail, optionally including mailing labels +(see <link linkend="Letters">Letters</link>). +</para> </listitem></varlistentry><varlistentry><term><literal>report</literal> </term><listitem><para>For documents of length between an <literal>article</literal> and a <literal>book</literal>, such as technical reports or theses, which may contain several chapters. @@ -485,10 +550,34 @@ options for selecting the typeface size (default is <literal>10pt</literal>): <indexterm role="fn"><primary>legalpaper option</primary></indexterm> <indexterm role="fn"><primary>letterpaper option</primary></indexterm> <para>All of the standard classes accept these options for selecting the paper -size (default is <literal>letterpaper</literal>): +size (these show height by width): +</para> +<variablelist><varlistentry><term><literal>a4paper</literal> +</term><listitem><para>210 by 297 mm (about 8.25 by 11.75 inches) +</para> +</listitem></varlistentry><varlistentry><term><literal>b5paper</literal> +</term><listitem><para>176 by 250 mm (about 7 by 9.875 inches) +</para> +</listitem></varlistentry><varlistentry><term><literal>executivepaper</literal> +</term><listitem><para>7.25 by 10.5 inches +</para> +</listitem></varlistentry><varlistentry><term><literal>legalpaper</literal> +</term><listitem><para>8.5 by 14 inches +</para> +</listitem></varlistentry><varlistentry><term><literal>letterpaper</literal> +</term><listitem><para>8.5 by 11 inches (the default) +</para></listitem></varlistentry></variablelist> +<indexterm role="fn"><primary>\pdfpagewidth</primary></indexterm> +<indexterm role="fn"><primary>\pdfpageheight</primary></indexterm> +<indexterm role="cp"><primary><literal>geometry</literal> package</primary></indexterm> +<para>When using one of the engines pdf&latex;, Lua&latex;, or Xe&latex; +(see <link linkend="TeX-engines">&tex; engines</link>), options other than <literal>letterpaper</literal> set +the print area but you must also set the physical paper size. One way +to do that is to put <literal>\pdfpagewidth=\paperwidth</literal> and +<literal>\pdfpageheight=\paperheight</literal> in your document’s preamble. The +<literal>geometry</literal> package provides flexible ways of setting the print +area and physical page size. </para> -<screen>a4paper a5paper b5paper executivepaper legalpaper letterpaper -</screen> <indexterm role="fn"><primary>draft option</primary></indexterm> <indexterm role="fn"><primary>final option</primary></indexterm> <indexterm role="fn"><primary>fleqn option</primary></indexterm> @@ -603,16 +692,17 @@ and a style. The &latex; commands for doing this are described here. <title>Font styles</title> <indexterm role="cp"><primary>font styles</primary></indexterm> -<indexterm role="cp"><primary>typeface styles</primary></indexterm> +<indexterm role="cp"><primary>type styles</primary></indexterm> <indexterm role="cp"><primary>styles of text</primary></indexterm> <para>The following type style commands are supported by &latex;. </para> <para>This first group of commands is typically used with an argument, as in -<literal>\textit{italic text}</literal>. In the table below, the corresponding +<literal>\textit{<replaceable>text</replaceable>}</literal>. In the table below, the corresponding command in parenthesis is the “declaration form”, which takes no -arguments. The scope of the declaration form lasts until the next type -style command or the end of the current group. +arguments, as in <literal>{\itshape <replaceable>text</replaceable>}</literal>. The scope of the +declaration form lasts until the next type style command or the end of +the current group. </para> <para>These commands, in both the argument form and the declaration form, are cumulative; e.g., you can say either <literal>\sffamily\bfseries</literal> or @@ -642,11 +732,6 @@ command argument, such as <literal>\textit{\nocorr text}</literal> or <indexterm role="fn"><primary>\itshape</primary></indexterm> <para>Italics. </para> -</listitem></varlistentry><varlistentry><term><literal>\emph</literal> -</term><listitem><indexterm role="fn"><primary>\emph</primary></indexterm> -<indexterm role="cp"><primary>emphasis</primary></indexterm> -<para>Emphasis (switches between <literal>\textit</literal> and <literal>\textrm</literal>). -</para> </listitem></varlistentry><varlistentry><term><literal>\textmd (\mdseries)</literal> </term><listitem><indexterm role="fn"><primary>\textmd</primary></indexterm> <indexterm role="fn"><primary>\mdseries</primary></indexterm> @@ -660,7 +745,7 @@ command argument, such as <literal>\textit{\nocorr text}</literal> or </listitem></varlistentry><varlistentry><term><literal>\textup (\upshape)</literal> </term><listitem><indexterm role="fn"><primary>\textup</primary></indexterm> <indexterm role="fn"><primary>\upshape</primary></indexterm> -<para>Upright (default). The opposite of slanted. +<para>Upright (default). </para> </listitem></varlistentry><varlistentry><term><literal>\textsl (\slshape)</literal> </term><listitem><indexterm role="fn"><primary>\textsl</primary></indexterm> @@ -687,76 +772,31 @@ command argument, such as <literal>\textit{\nocorr text}</literal> or <indexterm role="fn"><primary>\normalfont</primary></indexterm> <para>Main document font. </para> -</listitem></varlistentry><varlistentry><term><literal>\mathrm</literal> -</term><listitem><indexterm role="fn"><primary>\mathrm</primary></indexterm> -<para>Roman, for use in math mode. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathbf</literal> -</term><listitem><indexterm role="fn"><primary>\mathbf</primary></indexterm> -<para>Boldface, for use in math mode. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathsf</literal> -</term><listitem><indexterm role="fn"><primary>\mathsf</primary></indexterm> -<para>Sans serif, for use in math mode. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathtt</literal> -</term><listitem><indexterm role="fn"><primary>\mathtt</primary></indexterm> -<para>Typewriter, for use in math mode. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathit</literal> -</term><term><literal>(\mit)</literal> -</term><listitem><para>Italics, for use in math mode. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathnormal</literal> -</term><listitem><indexterm role="fn"><primary>\mathnormal</primary></indexterm> -<para>For use in math mode, e.g. inside another type style declaration. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathcal</literal> -</term><listitem><indexterm role="fn"><primary>\mathcal</primary></indexterm> -<para>‘Calligraphic’ letters, for use in math mode. -</para> </listitem></varlistentry></variablelist> -<indexterm role="fn"><primary>\mathversion</primary></indexterm> -<indexterm role="cp"><primary>math, bold</primary></indexterm> -<indexterm role="cp"><primary>bold math</primary></indexterm> -<para>In addition, the command <literal>\mathversion{bold}</literal> can be used for -switching to bold letters and symbols in -formulas. <literal>\mathversion{normal}</literal> restores the default. -</para> -<indexterm role="fn"><primary>\oldstylenums</primary></indexterm> -<indexterm role="cp"><primary>numerals, old-style</primary></indexterm> -<indexterm role="cp"><primary>old-style numerals</primary></indexterm> -<indexterm role="cp"><primary>lining numerals</primary></indexterm> -<indexterm role="cp"><primary><literal>textcomp</literal> package</primary></indexterm> -<para>Finally, the command <literal>\oldstylenums{<replaceable>numerals</replaceable>}</literal> will -typeset so-called “old-style” numerals, which have differing heights -and depths (and sometimes widths) from the standard “lining” -numerals. &latex;’s default fonts support this, and will respect -<literal>\textbf</literal> (but not other styles; there are no italic old-style -numerals in Computer Modern). Many other fonts have old-style -numerals also; sometimes the <literal>textcomp</literal> package must be loaded, -and sometimes package options are provided to make them the default. -FAQ entry: <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</ulink>. +<indexterm role="cp"><primary>emphasis</primary></indexterm> +<indexterm role="fn"><primary>\emph</primary></indexterm> +<para>Although it also changes fonts, the <literal>\emph{<replaceable>text</replaceable>}</literal> command +is semantic, for text to be emphasized, and should not be used as a +substitute for <literal>\textit</literal>. For example, <literal>\emph{<replaceable>start +text</replaceable> \emph{<replaceable>middle text</replaceable>} <replaceable>end text</replaceable>}</literal> will result in the +<replaceable>start text</replaceable> and <replaceable>end text</replaceable> in italics, but <replaceable>middle text</replaceable> +will be in roman. </para> <para>&latex; also provides the following commands, which unconditionally switch to the given style, that is, are <emphasis>not</emphasis> cumulative. Also, -they are used differently than the above commands: <literal>{\<replaceable>cmd</replaceable> -...}</literal> instead of <literal>\<replaceable>cmd</replaceable>{...}</literal>. These are two unrelated -constructs. +they are used differently than the above commands: +<literal>{\<replaceable>cmd</replaceable>...}</literal> instead of <literal>\<replaceable>cmd</replaceable>{...}</literal>. These +are two unrelated constructs. </para> <variablelist><varlistentry><term><indexterm role="fn"><primary>\bf</primary></indexterm><literal>\bf</literal> </term><listitem><indexterm role="cp"><primary>bold font</primary></indexterm> -<para>Switch to <emphasis role="bold">bold face</emphasis>. +<para>Switch to bold face. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cal</primary></indexterm><literal>\cal</literal> </term><listitem><indexterm role="cp"><primary>script letters for math</primary></indexterm> <indexterm role="cp"><primary>calligraphic letters for math</primary></indexterm> <para>Switch to calligraphic letters for math. </para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\em</primary></indexterm><literal>\em</literal> -</term><listitem><indexterm role="cp"><primary>emphasis</primary></indexterm> -<para>Emphasis (italics within roman, roman within italics). -</para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\it</primary></indexterm><literal>\it</literal> </term><listitem><indexterm role="cp"><primary>italic font</primary></indexterm> <para>Italics. @@ -785,18 +825,78 @@ constructs. <para>Typewriter (monospace, fixed-width). </para> </listitem></varlistentry></variablelist> -<para>Some people consider the unconditional font-switching commands, such -as <literal>\tt</literal>, obsolete and <emphasis>only</emphasis> the cumulative commands -(<literal>\texttt</literal>) should be used. I (Karl) do not agree. There are -perfectly reasonable situations when an unconditional font switch is -precisely what you need to get the desired output; for one example, -see <link linkend="description"><literal>description</literal></link>. Both sets of commands have -their place. +<para>The <literal>\em</literal> command is the unconditional version of <literal>\emph</literal>. +</para> +<para>(Some people consider the unconditional font-switching commands, such +as <literal>\tt</literal>, obsolete and that only the cumulative commands +(<literal>\texttt</literal>) should be used. Others think that both sets of +commands have their place and sometimes an unconditional font switch +is precisely what you want; for one example, +see <link linkend="description"><literal>description</literal></link>.) +</para> +<para>The following commands are for use in math mode. They are not +cumulative, so <literal>\mathbf{\mathit{<replaceable>symbol</replaceable>}}</literal> does not +create a boldface and italic <replaceable>symbol</replaceable>; instead, it will just be in +italics. This is because typically math symbols need consistent +typographic treatment, regardless of the surrounding environment. +</para> +<variablelist><varlistentry><term><literal>\mathrm</literal> +</term><listitem><indexterm role="fn"><primary>\mathrm</primary></indexterm> +<para>Roman, for use in math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathbf</literal> +</term><listitem><indexterm role="fn"><primary>\mathbf</primary></indexterm> +<para>Boldface, for use in math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathsf</literal> +</term><listitem><indexterm role="fn"><primary>\mathsf</primary></indexterm> +<para>Sans serif, for use in math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathtt</literal> +</term><listitem><indexterm role="fn"><primary>\mathtt</primary></indexterm> +<para>Typewriter, for use in math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathit</literal> +</term><term><literal>(\mit)</literal> +</term><listitem><para>Italics, for use in math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathnormal</literal> +</term><listitem><indexterm role="fn"><primary>\mathnormal</primary></indexterm> +<para>For use in math mode, e.g., inside another type style declaration. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathcal</literal> +</term><listitem><indexterm role="fn"><primary>\mathcal</primary></indexterm> +<para>Calligraphic letters, for use in math mode. +</para> +</listitem></varlistentry></variablelist> +<indexterm role="fn"><primary>\mathversion</primary></indexterm> +<indexterm role="cp"><primary>math, bold</primary></indexterm> +<indexterm role="cp"><primary>bold math</primary></indexterm> +<para>In addition, the command <literal>\mathversion{bold}</literal> can be used for +switching to bold letters and symbols in +formulas. <literal>\mathversion{normal}</literal> restores the default. +</para> +<indexterm role="fn"><primary>\oldstylenums</primary></indexterm> +<indexterm role="cp"><primary>numerals, old-style</primary></indexterm> +<indexterm role="cp"><primary>old-style numerals</primary></indexterm> +<indexterm role="cp"><primary>lining numerals</primary></indexterm> +<indexterm role="cp"><primary><literal>textcomp</literal> package</primary></indexterm> +<para>Finally, the command <literal>\oldstylenums{<replaceable>numerals</replaceable>}</literal> will typeset +so-called “old-style” numerals, which have differing heights and +depths (and sometimes widths) from the standard “lining” numerals, +which all have the same height as upper-case letters. &latex;’s +default fonts support this, and will respect <literal>\textbf</literal> (but not +other styles; there are no italic old-style numerals in Computer +Modern). Many other fonts have old-style numerals also; sometimes the +<literal>textcomp</literal> package must be loaded, and sometimes package options +are provided to make them the default. FAQ entry: +<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</ulink>. </para> </sect1> <sect1 label="4.2" id="Font-sizes"> <title>Font sizes</title> + <indexterm role="cp"><primary>font sizes</primary></indexterm> <indexterm role="cp"><primary>typeface sizes</primary></indexterm> <indexterm role="cp"><primary>sizes of text</primary></indexterm> @@ -849,160 +949,316 @@ these commands; for instance, <literal>\begin{tiny}...\end{tiny}</literal>. </sect1> <sect1 label="4.3" id="Low_002dlevel-font-commands"> <title>Low-level font commands</title> + <indexterm role="cp"><primary>low-level font commands</primary></indexterm> <indexterm role="cp"><primary>font commands, low-level</primary></indexterm> <para>These commands are primarily intended for writers of macros and packages. The commands listed here are only a subset of the available ones. +<!-- xx but it should be complete --> +<!-- xx something about ultimately reading ENCFAM.fd? --> </para> -<variablelist><varlistentry><term><literal>\fontencoding{enc}</literal> +<variablelist><varlistentry><term><literal>\fontencoding{<replaceable>encoding</replaceable>}</literal> </term><listitem><indexterm role="fn"><primary>\fontencoding</primary></indexterm> -<para>Select font encoding. Valid encodings include <literal>OT1</literal> and <literal>T1</literal>. -</para> -</listitem></varlistentry><varlistentry><term><literal>\fontfamily{family}</literal> +<para>Select the font encoding, the encoding of the output font. There are a +large number of valid encodings. The most common are <literal>OT1</literal>, +Knuth’s original encoding for Computer Modern (the default), and +<literal>T1</literal>, also known as the Cork encoding, which has support for the +accented characters used by the most widespread European languages +(German, French, Italian, Polish and others), which allows &tex; to +hyphenate words containing accented letters. +</para> +</listitem></varlistentry><varlistentry><term><literal>\fontfamily{<replaceable>family</replaceable>}</literal> </term><listitem><indexterm role="fn"><primary>\fontfamily</primary></indexterm> -<para>Select font family. Valid families include: -</para> -<itemizedlist><listitem><para><literal>cmr</literal> for Computer Modern Roman -</para></listitem><listitem><para><literal>cmss</literal> for Computer Modern Sans Serif -</para></listitem><listitem><para><literal>cmtt</literal> for Computer Modern Typewriter +<indexterm role="cp"><primary>families, of fonts</primary></indexterm> +<indexterm role="cp"><primary>font catalogue</primary></indexterm> +<para>Select the font family. The web page +<ulink url="http://www.tug.dk/FontCatalogue/">http://www.tug.dk/FontCatalogue/</ulink> provides one way to browse +through many of the fonts easily used with &latex;. Here are +examples of some common families: +</para> +<!-- Sorry about the ugly @t{@ }. The idea is to make the lists line up --> +<!-- in Info. Since the items are so short, it seems nice to have them --> +<!-- on the same line instead of using @table. --> + +<itemizedlist><listitem><para><!-- /@w --> <literal>pag</literal><literal> </literal> Avant Garde +</para></listitem><listitem><para><!-- /@w --> <literal>fvs</literal><literal> </literal> Bitstream Vera Sans +</para></listitem><listitem><para><!-- /@w --> <literal>pbk</literal><literal> </literal> Bookman +</para></listitem><listitem><para><!-- /@w --> <literal>bch</literal><literal> </literal> Charter +</para></listitem><listitem><para><!-- /@w --> <literal>ccr</literal><literal> </literal> Computer Concrete +</para></listitem><listitem><para><!-- /@w --> <literal>cmr</literal><literal> </literal> Computer Modern +</para></listitem><listitem><para><!-- /@w --> <literal>pcr</literal><literal> </literal> Courier +</para></listitem><listitem><para><!-- /@w --> <literal>phv</literal><literal> </literal> Helvetica +</para></listitem><listitem><para><!-- /@w --> <literal>fi4</literal><literal> </literal> Inconsolata +</para></listitem><listitem><para><!-- /@w --> <literal>lmr</literal><literal> </literal> Latin Modern +</para></listitem><listitem><para><!-- /@w --> <literal>lmss</literal> Latin Modern Sans +</para></listitem><listitem><para><!-- /@w --> <literal>lmtt</literal> Latin Modern Typewriter +</para></listitem><listitem><para><!-- /@w --> <literal>pnc</literal><literal> </literal> New Century Schoolbook +</para></listitem><listitem><para><!-- /@w --> <literal>ppl</literal><literal> </literal> Palatino +</para></listitem><listitem><para><!-- /@w --> <literal>ptm</literal><literal> </literal> Times +</para></listitem><listitem><para><!-- /@w --> <literal>uncl</literal> Uncial +</para></listitem><listitem><para><!-- /@w --> <literal>put</literal><literal> </literal> Utopia +</para></listitem><listitem><para><!-- /@w --> <literal>pzc</literal><literal> </literal> Zapf Chancery </para></listitem></itemizedlist> -<para>and numerous others. -</para> -</listitem></varlistentry><varlistentry><term><literal>\fontseries{series}</literal> +</listitem></varlistentry><varlistentry><term><literal>\fontseries{<replaceable>series</replaceable>}</literal> </term><listitem><indexterm role="fn"><primary>\fontseries</primary></indexterm> -<para>Select font series. Valid series include: -</para> -<itemizedlist><listitem><para><literal>m</literal> Medium (normal) -</para></listitem><listitem><para><literal>b</literal> Bold -</para></listitem><listitem><para><literal>c</literal> Condensed -</para></listitem><listitem><para><literal>bc</literal> Bold condensed -</para></listitem><listitem><para><literal>bx</literal> Bold extended +<indexterm role="cp"><primary>series, of fonts</primary></indexterm> +<para>Select the font series. A <firstterm>series</firstterm> combines a <firstterm>weight</firstterm> and a +<firstterm>width</firstterm>. Typically, a font supports only a few of the possible +combinations. Some common combined series values include: +</para> +<itemizedlist><listitem><para><!-- /@w --> <literal>m</literal><literal> </literal> Medium (normal) +</para></listitem><listitem><para><!-- /@w --> <literal>b</literal><literal> </literal> Bold +</para></listitem><listitem><para><!-- /@w --> <literal>c</literal><literal> </literal> Condensed +</para></listitem><listitem><para><!-- /@w --> <literal>bc</literal> Bold condensed +</para></listitem><listitem><para><!-- /@w --> <literal>bx</literal> Bold extended </para></listitem></itemizedlist> -<para>and various other combinations. -</para> -</listitem></varlistentry><varlistentry><term><literal>\fontshape{shape}</literal> +<indexterm role="cp"><primary>weights, of fonts</primary></indexterm> +<para>The possible values for weight, individually, are: +</para> +<itemizedlist><listitem><para><!-- /@w --> <literal>ul</literal> Ultra light +</para></listitem><listitem><para><!-- /@w --> <literal>el</literal> Extra light +</para></listitem><listitem><para><!-- /@w --> <literal>l</literal><literal> </literal> Light +</para></listitem><listitem><para><!-- /@w --> <literal>sl</literal> Semi light +</para></listitem><listitem><para><!-- /@w --> <literal>m</literal><literal> </literal> Medium (normal) +</para></listitem><listitem><para><!-- /@w --> <literal>sb</literal> Semi bold +</para></listitem><listitem><para><!-- /@w --> <literal>b</literal><literal> </literal> Bold +</para></listitem><listitem><para><!-- /@w --> <literal>eb</literal> Extra bold +</para></listitem><listitem><para><!-- /@w --> <literal>ub</literal> Ultra bold +</para></listitem></itemizedlist> +<indexterm role="cp"><primary>widths, of fonts</primary></indexterm> +<para>The possible values for width, individually, are (the percentages +are just guides and are not followed precisely by all fonts): +</para> +<itemizedlist><listitem><para><!-- /@w --> <literal>uc</literal> Ultra condensed, 50% +</para></listitem><listitem><para><!-- /@w --> <literal>ec</literal> Extra condensed, 62.5% +</para></listitem><listitem><para><!-- /@w --> <literal>c</literal><literal> </literal> Condensed, 75% +</para></listitem><listitem><para><!-- /@w --> <literal>sc</literal> Semi condensed, 87.5% +</para></listitem><listitem><para><!-- /@w --> <literal>m</literal><literal> </literal> Medium, 100% +</para></listitem><listitem><para><!-- /@w --> <literal>sx</literal> Semi expanded, 112.5% +</para></listitem><listitem><para><!-- /@w --> <literal>x</literal><literal> </literal> Expanded, 125% +</para></listitem><listitem><para><!-- /@w --> <literal>ex</literal> Extra expanded, 150% +</para></listitem><listitem><para><!-- /@w --> <literal>ux</literal> Ultra expanded, 200% +</para></listitem></itemizedlist> +<para>When forming the <replaceable>series</replaceable> string from the weight and width, drop the +<literal>m</literal> that stands for medium weight or medium width, unless both +weight and width are <literal>m</literal>, in which case use just one +(‘<literal><literal>m</literal></literal>’). +</para> +</listitem></varlistentry><varlistentry><term><literal>\fontshape{<replaceable>shape</replaceable>}</literal> </term><listitem><indexterm role="fn"><primary>\fontshape</primary></indexterm> +<indexterm role="cp"><primary>shapes, of fonts</primary></indexterm> <para>Select font shape. Valid shapes are: </para> -<itemizedlist><listitem><para><literal>n</literal> Upright (normal) -</para></listitem><listitem><para><literal>it</literal> Italic -</para></listitem><listitem><para><literal>sl</literal> Slanted (oblique) -</para></listitem><listitem><para><literal>sc</literal> Small caps -</para></listitem><listitem><para><literal>ui</literal> Upright italics -</para></listitem><listitem><para><literal>ol</literal> Outline +<itemizedlist><listitem><para><!-- /@w --> <literal>n</literal><literal> </literal> Upright (normal) +</para></listitem><listitem><para><!-- /@w --> <literal>it</literal> Italic +</para></listitem><listitem><para><!-- /@w --> <literal>sl</literal> Slanted (oblique) +</para></listitem><listitem><para><!-- /@w --> <literal>sc</literal> Small caps +</para></listitem><listitem><para><!-- /@w --> <literal>ui</literal> Upright italics +</para></listitem><listitem><para><!-- /@w --> <literal>ol</literal> Outline </para></listitem></itemizedlist> -<para>The two last shapes are not available for most font families. +<para>The two last shapes are not available for most font families, and +small caps are often missing as well. </para> -</listitem></varlistentry><varlistentry><term><literal>\fontsize{size}{skip}</literal> +</listitem></varlistentry><varlistentry><term><literal>\fontsize{<replaceable>size</replaceable>}{<replaceable>skip</replaceable>}</literal> </term><listitem><indexterm role="fn"><primary>\fontsize</primary></indexterm> +<indexterm role="cp"><primary>font size</primary></indexterm> <indexterm role="fn"><primary>\baselineskip</primary></indexterm> -<para>Set font size. The first parameter is the font size to switch to and -the second is the line spacing to use; this is stored in a parameter -named <literal>\baselineskip</literal>. The unit of both parameters defaults to -pt. The default <literal>\baselineskip</literal> for the Computer Modern typeface -is 1.2 times the <literal>\fontsize</literal>. +<para>Set the font size and the line spacing. The unit of both parameters +defaults to points (<literal>pt</literal>). The line spacing is the nominal +vertical space between lines, baseline to baseline. It is stored in the +parameter <literal>\baselineskip</literal>. The default <literal>\baselineskip</literal> for +the Computer Modern typeface is 1.2 times the <literal>\fontsize</literal>. +Changing <literal>\baselineskip</literal> directly is inadvisable since its value is +reset every time a size change happens; see <literal>\baselinestretch</literal>, next. +</para> +</listitem></varlistentry><varlistentry><term><literal>\baselinestretch</literal> +</term><listitem><indexterm role="fn"><primary>\baselinestretch</primary></indexterm> +<para>&latex; multiplies the line spacing by the value of the +<literal>\baselinestretch</literal> parameter; the default factor is 1. A change +takes effect when <literal>\selectfont</literal> (see below) is called. You can +make line skip changes happen for the entire document by doing +<literal>\renewcommand{\baselinestretch}{2.0}</literal> in the preamble. </para> -<indexterm role="fn"><primary>\baselinestretch</primary></indexterm> <indexterm role="cp"><primary><literal>setspace</literal> package</primary></indexterm> <indexterm role="cp"><primary>double spacing</primary></indexterm> -<para>The line spacing is also multiplied by the value of the -<literal>\baselinestretch</literal> parameter when the type size changes; the -default is 1. However, the best way to “double space” a document, -if you should be unlucky enough to have to produce such, is to use the -<literal>setspace</literal> package; see -<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</ulink>. -</para> -<indexterm role="fn"><primary>\linespread</primary></indexterm> +<para>However, the best way to double-space a document is to use the +<filename>setspace</filename> package. In addition to offering a number of spacing +options, this package keeps the line spacing single-spaced in places +where that is typically desirable, such as footnotes and figure +captions. See the package documentation. +</para> </listitem></varlistentry><varlistentry><term><literal>\linespread{<replaceable>factor</replaceable>}</literal> -</term><listitem><para>Equivalent to +</term><listitem><indexterm role="fn"><primary>\linespread</primary></indexterm> +<para>Equivalent to <literal>\renewcommand{\baselinestretch}{<replaceable>factor</replaceable>}</literal>, and therefore must be followed by <literal>\selectfont</literal> to have any effect. Best specified in the preamble, or use the <literal>setspace</literal> package, as -described just above. +just described. </para> -<indexterm role="fn"><primary>\selectfont</primary></indexterm> -<para>The changes made by calling the font commands described above do -not come into effect until <literal>\selectfont</literal> is called. +</listitem></varlistentry><varlistentry><term><literal>\selectfont</literal> +</term><listitem><indexterm role="fn"><primary>\selectfont</primary></indexterm> +<para>The effects of the font commands described above do not happen until +<literal>\selectfont</literal> is called, as in +<literal>\fontfamily{<replaceable>familyname</replaceable>}\selectfont</literal>. It is often useful +to put this in a macro: + +<literal>\newcommand*{\myfont}{\fontfamily{<replaceable>familyname</replaceable>}\selectfont}</literal> + +(see <link linkend="_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</link>). </para> -</listitem></varlistentry><varlistentry><term><literal>\usefont{enc}{family}{series}{shape}</literal> +</listitem></varlistentry><varlistentry><term><literal>\usefont{<replaceable>enc</replaceable>}{<replaceable>family</replaceable>}{<replaceable>series</replaceable>}{<replaceable>shape</replaceable>}</literal> </term><listitem><indexterm role="fn"><primary>\usefont</primary></indexterm> <para>The same as invoking <literal>\fontencoding</literal>, <literal>\fontfamily</literal>, <literal>\fontseries</literal> and <literal>\fontshape</literal> with the given parameters, -followed by <literal>\selectfont</literal>. +followed by <literal>\selectfont</literal>. For example: </para> +<screen>\usefont{ot1}{cmr}{m}{n} +</screen> </listitem></varlistentry></variablelist> </sect1> </chapter> <chapter label="5" id="Layout"> <title>Layout</title> + <indexterm role="cp"><primary>layout commands</primary></indexterm> -<para>Miscellaneous commands for controlling the general layout of the page. +<para>Commands for controlling the general page layout. </para> <sect1 label="5.1" id="_005conecolumn"> <title><literal>\onecolumn</literal></title> + <indexterm role="fn"><primary>\onecolumn</primary></indexterm> <indexterm role="cp"><primary>one-column output</primary></indexterm> <para>The <literal>\onecolumn</literal> declaration starts a new page and produces -single-column output. This is the default. +single-column output. If the document is given the class option +<literal>onecolumn</literal> then this is the default behavior (see <link linkend="Document-class-options">Document +class options</link>). +</para> +<para>This command is fragile (see <link linkend="_005cprotect">\protect</link>). </para> </sect1> <sect1 label="5.2" id="_005ctwocolumn"> <title><literal>\twocolumn</literal></title> + <indexterm role="fn"><primary>\twocolumn</primary></indexterm> <indexterm role="cp"><primary>multicolumn text</primary></indexterm> <indexterm role="cp"><primary>two-column output</primary></indexterm> <para>Synopsis: </para> -<screen>\twocolumn[<replaceable>text1col</replaceable>] +<screen>\twocolumn[<replaceable>prelim one column text</replaceable>] </screen> <para>The <literal>\twocolumn</literal> declaration starts a new page and produces -two-column output. If the optional <replaceable>text1col</replaceable> argument is present, -it is typeset in one-column mode before the two-column typesetting -starts. +two-column output. If the document is given the class option +<literal>twocolumn</literal> then this is the default (see <link linkend="Document-class-options">Document class +options</link>). +</para> +<para>If the optional <replaceable>prelim one column text</replaceable> argument +is present, it is typeset in one-column mode before the two-column +typesetting starts. +</para> +<para>This command is fragile (see <link linkend="_005cprotect">\protect</link>). </para> <para>These parameters control typesetting in two-column output: </para> <variablelist><varlistentry><term><indexterm role="fn"><primary>\columnsep</primary></indexterm><literal>\columnsep</literal> -</term><listitem><para>The distance between columns (35pt by default). +</term><listitem><para>The distance between columns. The default is 35pt. Change it with a +command such as <literal>\setlength{\columnsep}{40pt}</literal> You must change +it before the two column environment starts; in the preamble is a good +place. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\columnseprule</primary></indexterm><literal>\columnseprule</literal> -</term><listitem><para>The width of the rule between columns; the default is 0pt, so there is no rule. +</term><listitem><para>The width of the rule between columns. The rule appears halfway between +the two columns. The default is 0pt, meaning that there is no rule. +Change it with a command such as +<literal>\setlength{\columnseprule}{0.4pt}</literal>, before the two-column +environment starts. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\columnwidth</primary></indexterm><literal>\columnwidth</literal> -</term><listitem><para>The width of the current column; this is equal to <literal>\textwidth</literal> in -single-column text. +</term><listitem><para>The width of a single column. In one-column mode this is equal to +<literal>\textwidth</literal>. In two-column mode by default &latex; sets the +width of each of the two columns to be half of <literal>\textwidth</literal> minus +<literal>\columnsep</literal>. </para> </listitem></varlistentry></variablelist> -<para>These parameters control float behavior in two-column output: +<para>In a two-column document, the starred environments <literal>table*</literal> and +<literal>figure*</literal> are two columns wide, whereas the unstarred environments +<literal>table</literal> and <literal>figure</literal> take up only one column (see <link linkend="figure">figure</link> +and see <link linkend="table">table</link>). &latex; places starred floats at the top of a page. +The following parameters control float behavior of two-column output. </para> <variablelist><varlistentry><term><indexterm role="fn"><primary>\dbltopfraction</primary></indexterm><literal>\dbltopfraction</literal> -</term><listitem><para>Maximum fraction at the top of a two-column page that may be occupied -by floats. Default ‘<literal>.7</literal>’, can be usefully redefined to (say) -‘<literal>.9</literal>’ to avoid going to float pages so soon. +</term><listitem><para>The maximum fraction at the top of a two-column page that may be +occupied by two-column wide floats. The default is 0.7, meaning that +the height of a <literal>table*</literal> or <literal>figure*</literal> environment must not +exceed <literal>0.7\textheight</literal> . If the height of your starred float +environment exceeeds this then you can take one of the following actions +to prevent it from floating all the way to the back of the document: +</para> +<itemizedlist><listitem><para>Use the <literal>[tp]</literal> location specifier to tell LaTeX to try to put +the bulky float on a page by itself, as well as at the top of a page. +</para> +</listitem><listitem><para>Use the <literal>[t!]</literal> location specifier to override the effect of +<literal>\dbltopfraction</literal> for this particular float. +</para> +</listitem><listitem><para>Increase the value of <literal>\dbltopfraction</literal> to a suitably large number, +to avoid going to float pages so soon. +</para></listitem></itemizedlist> +<para>You can redefine it, for instance with +<literal>\renewcommand{\dbltopfraction}{0.9}</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dblfloatpagefraction</primary></indexterm><literal>\dblfloatpagefraction</literal> -</term><listitem><para>The minimum fraction of a float page that must be occupied by floats, -for a two-column float page. Default ‘<literal>.5</literal>’. +</term><listitem><para>For a float page of two-column wide floats, this is the minimum fraction +that must be occupied by floats, limiting the amount of blank space. +&latex;’s default is <literal>0.5</literal>. Change it with <literal>\renewcommand</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dblfloatsep</primary></indexterm><literal>\dblfloatsep</literal> -</term><listitem><para>Distance between floats at the top or bottom of a two-column float -page. Default ‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and -‘<literal>11pt</literal>’ documents, ‘<literal>14pt plus2pt minus4pt</literal>’ for ‘<literal>12pt</literal>’. +</term><listitem><para>On a float page of two-column wide floats, this length is the distance +between floats, at both the top and bottom of the page. The default is +<literal>12pt plus2pt minus2pt</literal> for a document set at <literal>10pt</literal> or +<literal>11pt</literal>, and <literal>14pt plus2pt minus4pt</literal> for a document set at +<literal>12pt</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dbltextfloatsep</primary></indexterm><literal>\dbltextfloatsep</literal> -</term><listitem><para>Distance between a multi-column float at the top or bottom of a page -and the main text. Default ‘<literal>20pt plus2pt minus4pt</literal>’. +</term><listitem><para>This length is the distance between a multi-column float at the top or +bottom of a page and the main text. The default is <literal>20pt plus2pt +minus4pt</literal>. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dbltopnumber</primary></indexterm><literal>\dbltopnumber</literal> +</term><listitem><para>On a float page of two-column wide floats, this counter gives the +maximum number of floats allowed at the top of the page. The &latex; +default is <literal>2</literal>. </para> </listitem></varlistentry></variablelist> +<!-- From egreg at http://tex.stackexchange.com/a/142232/339 --> +<para>This example shows the use of the optional argument of <literal>\twocolumn</literal> +to create a title that spans the two-column article: +</para> +<screen>\documentclass[twocolumn]{article} +\newcommand{\authormark}[1]{\textsuperscript{#1}} +\begin{document} +\twocolumn[{% inside this optional argument goes one-column text + \centering + \LARGE The Title \\[1.5em] + \large Author One\authormark{1}, + Author Two\authormark{2}, + Author Three\authormark{1} \\[1em] + \normalsize + \begin{tabular}{p{.2\textwidth}@{\hspace{2em}}p{.2\textwidth}} + \authormark{1}Department one &\authormark{2}Department two \\ + School one &School two + \end{tabular}\\[3em] % space below title part +}] + +Two column text here. +</screen> </sect1> <sect1 label="5.3" id="_005cflushbottom"> @@ -1010,23 +1266,39 @@ and the main text. Default ‘<literal>20pt plus2pt minus4pt</literal>̵ <indexterm role="fn"><primary>\flushbottom</primary></indexterm> -<para>The <literal>\flushbottom</literal> declaration makes all text pages the same -height, adding extra vertical space where necessary to fill out the -page. +<para>The <literal>\flushbottom</literal> command can go at any point in the document +body. It makes all later pages the same height, stretching the vertical +space where necessary to fill out the page. +</para> +<para>If &tex; cannot satisfactorily stretch the vertical space in a page +then you get a message like ‘<literal>Underfull \vbox (badness 10000) has +occurred while \output is active</literal>’. You can change to +<literal>\raggedbottom</literal> (see below). Alternatively, you can try to adjust +the <literal>textheight</literal> to be compatible, or you can add some vertical +stretch glue between lines or between paragraphs, as in +<literal>\setlength{\parskip}{0ex plus0.1ex}</literal>. In a final editing +stage you can adjust the height of individual pages +(see <link linkend="_005cenlargethispage">\enlargethispage</link>). </para> -<para>This is the default if <literal>twocolumn</literal> mode is selected -(see <link linkend="Document-class-options">Document class options</link>). +<para>This is the default only if you select the <literal>twoside</literal> document class +option (see <link linkend="Document-class-options">Document class options</link>). </para> </sect1> <sect1 label="5.4" id="_005craggedbottom"> <title><literal>\raggedbottom</literal></title> + <indexterm role="fn"><primary>\raggedbottom</primary></indexterm> <indexterm role="cp"><primary>stretch, omitting vertical</primary></indexterm> -<para>The <literal>\raggedbottom</literal> declaration makes all pages the natural -height of the material on that page. No rubber lengths will be -stretched. +<para>The <literal>\raggedbottom</literal> command can go at any point in the document +body. It makes all later pages the natural height of the material on +that page; no rubber lengths will be stretched. Thus, in a two-sided +document the facing pages may be different heights. See also +<literal>\flushbottom</literal> above. +</para> +<para>This is the default unless you select the <literal>twoside</literal> document class +option (see <link linkend="Document-class-options">Document class options</link>). </para> </sect1> @@ -1040,45 +1312,125 @@ stretched. <indexterm role="cp"><primary>footer, parameters for</primary></indexterm> <indexterm role="cp"><primary>running header and footer</primary></indexterm> -<variablelist><varlistentry><term><indexterm role="fn"><primary>\headheight</primary></indexterm><literal>\headheight</literal> -</term><listitem><para>Height of the box that contains the running head. Default is -‘<literal>30pt</literal>’, except in the <literal>book</literal> class, where it varies with the -type size. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\columnsep</primary></indexterm><literal>\columnsep</literal> +</term><term><indexterm role="fn"><primary>\columnseprule</primary></indexterm><literal>\columnseprule</literal> +</term><term><indexterm role="fn"><primary>\columnwidth</primary></indexterm><literal>\columnwidth</literal> +</term><listitem><indexterm role="fn"><primary>\columnsep</primary></indexterm> +<indexterm role="fn"><primary>\columnseprule</primary></indexterm> +<indexterm role="fn"><primary>\columnwidth</primary></indexterm> +<para>The distance between the two columns, the width of a rule between the +columns, and the width of the columns, when the document class option +<literal>twocolumn</literal> is in effect (see <link linkend="Document-class-options">Document class options</link>). +See <link linkend="_005ctwocolumn">\twocolumn</link>. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\headheight</primary></indexterm><literal>\headheight</literal> +</term><listitem><indexterm role="fn"><primary>\headheight</primary></indexterm> +<para>Height of the box that contains the running head. The default in the +<literal>article</literal>, <literal>report</literal>, and <literal>book</literal> classes is ‘<literal>12pt</literal>’, +at all type sizes. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\headsep</primary></indexterm><literal>\headsep</literal> -</term><listitem><para>Vertical distance between the bottom of the header line and the top of -the main text. Default is ‘<literal>25pt</literal>’, except in the <literal>book</literal> -class, where it varies with the type size. +</term><listitem><indexterm role="fn"><primary>\headsep</primary></indexterm> +<para>Vertical distance between the bottom of the header line and the top of +the main text. The default in the <literal>article</literal> and <literal>report</literal> +classes is ‘<literal>25pt</literal>’. In the <literal>book</literal> class the default is: if the +document is set at 10pt then it is ‘<literal>0.25in</literal>’, and at 11pt and 12pt +it is ‘<literal>0.275in</literal>’. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\footskip</primary></indexterm><literal>\footskip</literal> -</term><listitem><para>Distance from the baseline of the last line of text to the baseline of -the page footer. Default is ‘<literal>30pt</literal>’, except in the <literal>book</literal> -class, where it varies with the type size. +</term><listitem><indexterm role="fn"><primary>\footskip</primary></indexterm> +<para>Distance from the baseline of the last line of text to the baseline of +the page footer. The default in the <literal>article</literal> and <literal>report</literal> +classes is ‘<literal>30pt</literal>’. In the <literal>book</literal> class the default is: when +the type size is 10pt the default is ‘<literal>0.35in</literal>’, while at 11pt it is +‘<literal>0.38in</literal>’, and at 12pt it is ‘<literal>30pt</literal>’. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\linewidth</primary></indexterm><literal>\linewidth</literal> -</term><listitem><para>Width of the current line, decreased for each nested <literal>list</literal> -(see <link linkend="list">list</link>). Specifically, it is smaller than <literal>\textwidth</literal> by -the sum of <literal>\leftmargin</literal> and <literal>\rightmargin</literal> -(see <link linkend="itemize">itemize</link>). The default varies with the font size, paper -width, two-column mode, etc. For an <literal>article</literal> document in -‘<literal>10pt</literal>’, it’s set to ‘<literal>345pt</literal>’; in two-column mode, that -becomes ‘<literal>229.5pt</literal>’. +</term><listitem><indexterm role="fn"><primary>\linewidth</primary></indexterm> +<para>Width of the current line, decreased for each nested <literal>list</literal> +(see <link linkend="list">list</link>). That is, the nominal value for <literal>\linewidth</literal> is to +equal <literal>\textwidth</literal> but for each nested list the <literal>\linewidth</literal> +is decreased by the sum of that list’s <literal>\leftmargin</literal> and +<literal>\rightmargin</literal> (see <link linkend="itemize">itemize</link>). +<!-- The default varies with the font size, paper width, two-column mode, --> +<!-- etc. For an @code{article} document set in 10pt, the default is --> +<!-- @samp{345pt}, while in two-column mode that becomes @samp{229.5pt}. --> +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\marginparpush</primary></indexterm><literal>\marginparpush</literal> +</term><term><indexterm role="fn"><primary>\marginsep</primary></indexterm><literal>\marginsep</literal> +</term><term><indexterm role="fn"><primary>\marginparwidth</primary></indexterm><literal>\marginparwidth</literal> +</term><listitem><indexterm role="fn"><primary>\marginparpush</primary></indexterm> +<indexterm role="fn"><primary>\marginsep</primary></indexterm> +<indexterm role="fn"><primary>\marginparwidth</primary></indexterm> +<para>The minimum vertical space between two marginal notes, the horizontal +space between the text body and the marginal notes, and the horizontal +width of the notes. +</para> +<para>Normally marginal notes appear on the outside of the page, but the +declaration <literal>\reversemarginpar</literal> changes that (and +<literal>\normalmarginpar</literal> changes it back). +</para> +<para>The defaults for <literal>\marginparpush</literal> in both <literal>book</literal> and +<literal>article</literal> classes are: ‘<literal>7pt</literal>’ if the document is set at 12pt, +and ‘<literal>5pt</literal>’ if the document is set at 11pt or 10pt. +</para> +<para>For <literal>\marginsep</literal>, in <literal>article</literal> class the default is +‘<literal>10pt</literal>’ except if the document is set at 10pt and in two-column mode +where the default is ‘<literal>11pt</literal>’. +</para> +<para>For <literal>\marginsep</literal> in <literal>book</literal> class the default is ‘<literal>10pt</literal>’ in +two-column mode and ‘<literal>7pt</literal>’ in one-column mode. +</para> +<para>For <literal>\marginparwidth</literal> in both <literal>book</literal> and <literal>article</literal> +classes, in two-column mode the default is 60% of <literal>\paperwidth +− \textwidth</literal>, while in one-column mode it is 50% of that +distance. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\oddsidemargin</primary></indexterm><literal>\oddsidemargin</literal> +</term><term><indexterm role="fn"><primary>\evensidemargin</primary></indexterm><literal>\evensidemargin</literal> +</term><listitem><indexterm role="fn"><primary>\oddsidemargin</primary></indexterm> +<indexterm role="fn"><primary>\evensidemargin</primary></indexterm> +<para>The <literal>\oddsidemargin</literal> is the extra distance between the left side of +the page and the text’s left margin, on odd-numbered pages when the +document class option <literal>twoside</literal> is chosen and on all pages when +<literal>oneside</literal> is in effect. When <literal>twoside</literal> is in effect, on +even-numbered pages the extra distance on the left is +<literal>evensidemargin</literal>. +</para> +<para>&latex;’s default is that <literal>\oddsidemargin</literal> is 40% of the +difference between <literal>\paperwidth</literal> and <literal>\textwidth</literal>, and +<literal>\evensidemargin</literal> is the remainder. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\paperheight</primary></indexterm><literal>\paperheight</literal> +</term><listitem><indexterm role="fn"><primary>\paperheight</primary></indexterm> +<para>The height of the paper, as distinct from the height of the print area. +It is normally set with a document class option, as in +<literal>\documentclass[a4paper]{article}</literal> (see <link linkend="Document-class-options">Document class +options</link>). +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\paperwidth</primary></indexterm><literal>\paperwidth</literal> +</term><listitem><indexterm role="fn"><primary>\paperwidth</primary></indexterm> +<para>The width of the paper, as distinct from the width of the print area. +It is normally set with a document class option, as in +<literal>\documentclass[a4paper]{article}</literal> (see <link linkend="Document-class-options">Document class +options</link>). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textheight</primary></indexterm><literal>\textheight</literal> -</term><listitem><para>The normal vertical height of the page body; the default varies with -the font size, document class, etc. For an <literal>article</literal> or -<literal>report</literal> document in ‘<literal>10pt</literal>’, it’s set to -‘<literal>43\baselineskip</literal>’; for <literal>book</literal>, it’s ‘<literal>41\baselineskip</literal>’. -For ‘<literal>11pt</literal>’, it’s ‘<literal>38\baselineskip</literal>’ and for ‘<literal>12pt</literal>’, -‘<literal>36\baselineskip</literal>’. +</term><listitem><indexterm role="fn"><primary>\textheight</primary></indexterm> +<para>The normal vertical height of the page body. If the document is set at +a nominal type size of 10pt then for an <literal>article</literal> or <literal>report</literal> +the default is ‘<literal>43\baselineskip</literal>’, while for a <literal>book</literal> it is +‘<literal>41\baselineskip</literal>’. At a type size of 11pt the default is +‘<literal>38\baselineskip</literal>’ for all document classes. At 12pt it is +‘<literal>36\baselineskip</literal>’ for all classes. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textwidth</primary></indexterm><literal>\textwidth</literal> -</term><listitem><para>The full horizontal width of the entire page body; the default varies -as usual. For an <literal>article</literal> or <literal>report</literal> document, it’s -‘<literal>345pt</literal>’ at ‘<literal>10pt</literal>’, ‘<literal>360pt</literal>’ at ‘<literal>11pt</literal>’, and -‘<literal>390pt</literal>’ at ‘<literal>12pt</literal>’. For a <literal>book</literal> document, it’s -‘<literal>4.5in</literal>’ at ‘<literal>10pt</literal>’, and ‘<literal>5in</literal>’ at ‘<literal>11pt</literal>’ or -‘<literal>12pt</literal>’. +</term><listitem><indexterm role="fn"><primary>\textwidth</primary></indexterm> +<para>The full horizontal width of the entire page body. For an +<literal>article</literal> or <literal>report</literal> document, the default is ‘<literal>345pt</literal>’ +when the chosen type size is 10pt, the default is ‘<literal>360pt</literal>’ at 11pt, +and it is ‘<literal>390pt</literal>’ at 12pt. For a <literal>book</literal> document, the default +is ‘<literal>4.5in</literal>’ at a type size of 10pt, and ‘<literal>5in</literal>’ at 11pt or 12pt. </para> <para>In multi-column output, <literal>\textwidth</literal> remains the width of the entire page body, while <literal>\columnwidth</literal> is the width of one column @@ -1094,29 +1446,205 @@ specified width, and revert to their normal values at the end of the <literal>minipage</literal> or <literal>\parbox</literal>. </para> <indexterm role="fn"><primary>\hsize</primary></indexterm> -<para>For completeness: <literal>\hsize</literal> is the &tex; primitive parameter used -when text is broken into lines. It should not be used in normal -&latex; documents. +<indexterm role="fn"><primary>\hsize</primary></indexterm> +<para>This entry is included for completeness: <literal>\hsize</literal> is the &tex; +primitive parameter used when text is broken into lines. It should not +be used in normal &latex; documents. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topmargin</primary></indexterm><literal>\topmargin</literal> -</term><listitem><para>Space between the top of the &tex; page (one inch from the top of the -paper, by default) and the top of the header. The default is computed +</term><listitem><indexterm role="fn"><primary>topmargin</primary></indexterm> +<para>Space between the top of the &tex; page (one inch from the top of the +paper, by default) and the top of the header. The value is computed based on many other parameters: <literal>\paperheight − 2in − -\headheight − \headsep − \textheight − \footskip</literal>, and -then divided by two. +\headheight − \headsep − \textheight − \footskip</literal>, +and then divided by two. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topskip</primary></indexterm><literal>\topskip</literal> -</term><listitem><para>Minimum distance between the top of the page body and the baseline of +</term><listitem><indexterm role="fn"><primary>\topskip</primary></indexterm> +<para>Minimum distance between the top of the page body and the baseline of the first line of text. For the standard classes, the default is the -same as the font size, e.g., ‘<literal>10pt</literal>’ at ‘<literal>10pt</literal>’. +same as the font size, e.g., ‘<literal>10pt</literal>’ at a type size of 10pt. </para> </listitem></varlistentry></variablelist> </sect1> +<sect1 label="5.6" id="Floats"> +<title>Floats</title> + +<para>Some typographic elements, such as figures and tables, cannot be broken +across pages. They must be typeset outside of the normal flow of text, +for instance floating to the top of a later page. +</para> +<para>&latex; can have a number of different classes of floating material. +The default is the two classes, <literal>figure</literal> (see <link linkend="figure">figure</link>) and +<literal>table</literal> (see <link linkend="table">table</link>), but you can create a new class with the +package <filename>float</filename>. +</para> +<para>Within any one float class &latex; always respects the order, so that +the first figure in a document source must be typeset before the second +figure. However, &latex; may mix the classes, so it can happen that +while the first table appears in the source before the first figure, it +appears in the output after it. +</para> +<para>The placement of floats is subject to parameters, given below, that +limit the number of floats that can appear at the top of a page, and the +bottom, etc. If so many floats are queued up that the limits prevent +them all from fitting on a page then &latex; places what it can and +defers the rest to the next page. In this way, floats may be typset far +from their place in the source. In particular, a float that is big can +migrate to the end of the document. But then because all floats in a +class must appear in sequential order, every subsequent float in that +class also appears at the end. +</para> +<indexterm role="cp"><primary>placement of floats</primary></indexterm> +<indexterm role="cp"><primary>specifier, float placement</primary></indexterm> +<para>In addition to changing the parameters, for each float you can tweak +where the float placement algorithm tries to place it by using its +<replaceable>placement</replaceable> argument. The possible values are a sequence of the +letters below. The default for both <literal>figure</literal> and <literal>table</literal>, in +both <literal>article</literal> and <literal>book</literal> classes, is <literal>tbp</literal>. +</para> +<variablelist><varlistentry><term><literal>t</literal> +</term><listitem><para>(Top)—at the top of a text page. +</para> +</listitem></varlistentry><varlistentry><term><literal>b</literal> +</term><listitem><para>(Bottom)—at the bottom of a text page. (However, <literal>b</literal> is not +allowed for full-width floats (<literal>figure*</literal>) with double-column +output. To ameliorate this, use the <filename>stfloats</filename> or +<filename>dblfloatfix</filename> package, but see the discussion at caveats in the +FAQ: <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</ulink>. +</para> +</listitem></varlistentry><varlistentry><term><literal>h</literal> +</term><listitem><para>(Here)—at the position in the text where the <literal>figure</literal> environment +appears. However, <literal>h</literal> is not allowed by itself; <literal>t</literal> is +automatically added. +</para> +<indexterm role="cp"><primary>here, putting floats</primary></indexterm> +<indexterm role="cp"><primary><literal>float</literal> package</primary></indexterm> +<para>To absolutely force a float to appear “here”, you can +<literal>\usepackage{float}</literal> and use the <literal>H</literal> specifier which it +defines. For further discussion, see the FAQ entry at +<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</ulink>. +</para> +</listitem></varlistentry><varlistentry><term><literal>p</literal> +</term><listitem><indexterm role="cp"><primary>float page</primary></indexterm> +<para>(Page of floats)—on a separate <firstterm>float page</firstterm>, which is a page +containing no text, only floats. +</para> +</listitem></varlistentry><varlistentry><term><literal>!</literal> +</term><listitem><para>Used in addition to one of the above; for this float only, &latex; +ignores the restrictions on both the number of floats that can appear +and the relative amounts of float and non-float text on the page. +The <literal>!</literal> specifier does <emphasis>not</emphasis> mean “put the float here”; +see above. +</para> +</listitem></varlistentry></variablelist> +<para>Note: the order in which letters appear in the <replaceable>placement</replaceable> argument +does not change the order in which &latex; tries to place the float; +for instance, <literal>btp</literal> has the same effect as <literal>tbp</literal>. All that +<replaceable>placement</replaceable> does is that if a letter is not present then the +algorithm does not try that location. Thus, &latex;’s default of +<literal>tbp</literal> is to try every location except placing the float where it +occurs in the source. +</para> +<para>To prevent &latex; from moving floats to the end of the document or a +chapter you can use a <literal>\clearpage</literal> command to start a new page and +insert all pending floats. If a pagebreak is undesirable then you can +use the <filename>afterpage</filename> package and issue +<literal>\afterpage{\clearpage}</literal>. This will wait until the current page +is finished and then flush all outstanding floats. +</para> +<para>&latex; can typeset a float before where it appears in the source +(although on the same output page) if there is a <literal>t</literal> specifier in the +<replaceable>placement</replaceable> paramater. If this is not desired, and deleting the +<literal>t</literal> is not acceptable as it keeps the float from being placed at +the top of the next page, then you can prevent it by either using the +<filename>flafter</filename> package or using the command +<indexterm role="fn"><primary>\suppressfloats</primary></indexterm> +<literal>\suppressfloats[t]</literal>, which causes floats for the top position on +this page to moved to the next page. +</para> +<para>Parameters relating to fractions of pages occupied by float and +non-float text (change them with +<literal>\renewcommand{<replaceable>parameter</replaceable>}{<replaceable>decimal between 0 and 1</replaceable>}</literal>): +</para> +<variablelist><varlistentry><term><indexterm role="fn"><primary>\bottomfraction</primary></indexterm><literal>\bottomfraction</literal> +</term><listitem><indexterm role="fn"><primary>\bottomfraction</primary></indexterm> +<para>The maximum fraction of the page allowed to be occupied by floats at +the bottom; default ‘<literal>.3</literal>’. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\floatpagefraction</primary></indexterm><literal>\floatpagefraction</literal> +</term><listitem><indexterm role="fn"><primary>\floatpagefraction</primary></indexterm> +<para>The minimum fraction of a float page that must be occupied by floats; +default ‘<literal>.5</literal>’. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textfraction</primary></indexterm><literal>\textfraction</literal> +</term><listitem><indexterm role="fn"><primary>\textfraction</primary></indexterm> +<para>Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is ‘<literal>.2</literal>’. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topfraction</primary></indexterm><literal>\topfraction</literal> +</term><listitem><indexterm role="fn"><primary>\topfraction</primary></indexterm> +<para>Maximum fraction at the top of a page that may be occupied before +floats; default ‘<literal>.7</literal>’. +</para></listitem></varlistentry></variablelist> +<para>Parameters relating to vertical space around floats (change them with +<literal>\setlength{<replaceable>parameter</replaceable>}{<replaceable>length expression</replaceable>}</literal>): +</para> +<variablelist><varlistentry><term><indexterm role="fn"><primary>\floatsep</primary></indexterm><literal>\floatsep</literal> +</term><listitem><indexterm role="fn"><primary>\floatsep</primary></indexterm> +<para>Space between floats at the top or bottom of a page; default +‘<literal>12pt plus2pt minus2pt</literal>’. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\intextsep</primary></indexterm><literal>\intextsep</literal> +</term><listitem><indexterm role="fn"><primary>\intextsep</primary></indexterm> +<para>Space above and below a float in the middle of the main text; default +‘<literal>12pt plus2pt minus2pt</literal>’ for 10 point and 11 point documents, +and ‘<literal>14pt plus4pt minus4pt</literal>’ for 12 point documents. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textfloatsep</primary></indexterm><literal>\textfloatsep</literal> +</term><listitem><indexterm role="fn"><primary>\textfloatsep</primary></indexterm> +<para>Space between the last (first) float at the top (bottom) of a page; +default ‘<literal>20pt plus2pt minus4pt</literal>’. +</para></listitem></varlistentry></variablelist> +<para>Counters relating to the number of floats on a page (change them with +<literal>\setcounter{<replaceable>ctrname</replaceable>}{<replaceable>natural number</replaceable>}</literal>): +</para> +<variablelist><varlistentry><term><indexterm role="fn"><primary>bottomnumber</primary></indexterm><literal>bottomnumber</literal> +</term><listitem><indexterm role="fn"><primary>bottomnumber</primary></indexterm> +<para>Maximum number of floats that can appear at the bottom of a text page; +default 1. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>dbltopnumber</primary></indexterm><literal>dbltopnumber</literal> +</term><listitem><indexterm role="fn"><primary>dbltopnumber</primary></indexterm> +<para>Maximum number of full-sized floats that can appear at the top of a +two-column page; default 2. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>topnumber</primary></indexterm><literal>topnumber</literal> +</term><listitem><indexterm role="fn"><primary>topnumber</primary></indexterm> +<para>Maximum number of floats that can appear at the top of a text page; +default 2. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>totalnumber</primary></indexterm><literal>totalnumber</literal> +</term><listitem><indexterm role="fn"><primary>totalnumber</primary></indexterm> +<para>Maximum number of floats that can appear on a text page; default 3. +</para></listitem></varlistentry></variablelist> +<para>The principal &tex; FAQ entry relating to floats +<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</ulink> contains +suggestions for relaxing &latex;’s default parameters to reduce the +problem of floats being pushed to the end. A full explaination of the +float placement algorithm is Frank Mittelbach’s article “How to +infuence the position of float environments like figure and table in +&latex;?” <ulink url="http://latex-project.org/papers/tb111mitt-float.pdf">http://latex-project.org/papers/tb111mitt-float.pdf</ulink>. +</para> + +</sect1> </chapter> <chapter label="6" id="Sectioning"> <title>Sectioning</title> -<indexterm role="cp"><primary>sectioning</primary></indexterm> + +<indexterm role="cp"><primary>sectioning commands</primary></indexterm> <para>Sectioning commands provide the means to structure your text into units: </para> @@ -1144,7 +1672,7 @@ To handle this, the sectioning commands have an optional argument <replaceable>toctitle</replaceable> that, when given, specifies the text for these other places. </para> -<indexterm role="cp"><primary>*-form of sectioning commands</primary></indexterm> +<indexterm role="cp"><primary><literal>*</literal>-form of sectioning commands</primary></indexterm> <para>Also, all sectioning commands have <literal>*</literal>-forms that print <replaceable>title</replaceable> as usual, but do not include a number and do not make an entry in the table of contents. For instance: @@ -1177,6 +1705,7 @@ The setting </chapter> <chapter label="7" id="Cross-references"> <title>Cross references</title> + <indexterm role="cp"><primary>cross references</primary></indexterm> <para>One reason for numbering things like figures and equations is to refer @@ -1186,6 +1715,7 @@ the reader to them, as in “See Figure 3 for more details.” <sect1 label="7.1" id="_005clabel"> <title><literal>\label</literal></title> + <indexterm role="fn"><primary>\label</primary></indexterm> <para>Synopsis: @@ -1194,15 +1724,33 @@ the reader to them, as in “See Figure 3 for more details.” </screen> <para>A <literal>\label</literal> command appearing in ordinary text assigns to <replaceable>key</replaceable> the number of the current sectional unit; one appearing -inside a numbered environment assigns that number to <replaceable>key</replaceable>. -</para> -<para>A <replaceable>key</replaceable> name can consist of any sequence of letters, digits, or +inside a numbered environment assigns that number to <replaceable>key</replaceable>. The +assigned number can be retrieved with the <literal>\ref{<replaceable>key</replaceable>}</literal> +command (see <link linkend="_005cref">\ref</link>). +</para> +<para>Thus, in the example below the key <literal>sec:test</literal> holds the number of +the current section and the key <literal>fig:test</literal> that of the figure. +(Incidentally, labels must appear after captions in figures and +tables.) +</para> +<screen>\section{section name} +\label{sec:test} +This is Section~\ref{sec:test}. +\begin{figure} + ... + \caption{caption text} + \label{fig:test} +\end{figure} +See Figure~\ref{fig:test}. +</screen> +<para>A key name can consist of any sequence of letters, digits, or common punctuation characters. Upper and lowercase letters are distinguished, as usual. </para> -<para>To avoid accidentally creating two labels with the same name, it is -common to use labels consisting of a prefix and a suffix separated by -a colon or period. Some conventionally-used prefixes: +<para>Although the name can be more or less anything, a common convention is +to use labels consisting of a prefix and a suffix separated by a colon +or period. This helps to avoid accidentally creating two labels with +the same name. Some commonly-used prefixes: </para> <variablelist><varlistentry><term><literal>ch</literal> </term><listitem><para>for chapters @@ -1215,13 +1763,14 @@ a colon or period. Some conventionally-used prefixes: </para></listitem></varlistentry><varlistentry><term><literal>eq</literal> </term><listitem><para>for equations </para></listitem></varlistentry></variablelist> -<para>Thus, a label for a figure would look like <literal>fig:snark</literal> or -<literal>fig.snark</literal>. +<para>Thus, a label for a figure would look like <literal>fig:test</literal> or +<literal>fig.test</literal>. </para> </sect1> <sect1 label="7.2" id="_005cpageref"> <title><literal>\pageref{<replaceable>key</replaceable>}</literal></title> + <indexterm role="fn"><primary>\pageref</primary></indexterm> <indexterm role="cp"><primary>cross referencing with page number</primary></indexterm> <indexterm role="cp"><primary>page number, cross referencing</primary></indexterm> @@ -1238,6 +1787,7 @@ the place in the text where the corresponding </sect1> <sect1 label="7.3" id="_005cref"> <title><literal>\ref{<replaceable>key</replaceable>}</literal></title> + <indexterm role="fn"><primary>\ref</primary></indexterm> <indexterm role="cp"><primary>cross referencing, symbolic</primary></indexterm> <indexterm role="cp"><primary>section number, cross referencing</primary></indexterm> @@ -1259,8 +1809,8 @@ such as the word ‘Section’ or ‘Figure’, just the bare nu </chapter> <chapter label="8" id="Environments"> <title>Environments</title> -<indexterm role="cp"><primary>environments</primary></indexterm> +<indexterm role="cp"><primary>environments</primary></indexterm> <indexterm role="fn"><primary>\begin</primary></indexterm> <indexterm role="fn"><primary>\end</primary></indexterm> @@ -1280,7 +1830,8 @@ Each environment begins and ends in the same manner: <indexterm role="cp"><primary>abstracts</primary></indexterm> <para>Synopsis: -</para><screen>\begin{abstract} +</para> +<screen>\begin{abstract} ... \end{abstract} </screen> @@ -1290,56 +1841,65 @@ Each environment begins and ends in the same manner: </sect1> <sect1 label="8.2" id="array"> <title><literal>array</literal></title> + <indexterm role="fn"><primary>array environment</primary></indexterm> <indexterm role="cp"><primary>arrays, math</primary></indexterm> <para>Synopsis: </para> -<screen>\begin{array}{<replaceable>template</replaceable>} -<replaceable>col1 text</replaceable>&<replaceable>col1 text</replaceable>&<replaceable>coln</replaceable>}\\ +<screen>\begin{array}{<replaceable>cols</replaceable>} +<replaceable>column 1 entry</replaceable> &<replaceable>column 2 entry</replaceable> ... &<replaceable>column n entry</replaceable> \\ ... \end{array} </screen> -<para>Math arrays are produced with the <literal>array</literal> environment, normally -within an <literal>equation</literal> environment (see <link linkend="equation">equation</link>). It has a -single mandatory <replaceable>template</replaceable> argument describing the number of -columns and the alignment within them. Each column <replaceable>col</replaceable> is -specified by a single letter that tells how items in each row of that -column should be formatted, as follows: +<para>or </para> -<variablelist><varlistentry><term><literal>c</literal> -</term><listitem><para>centered -</para></listitem></varlistentry><varlistentry><term><literal>l</literal> -</term><listitem><para>flush left -</para></listitem></varlistentry><varlistentry><term><literal>r</literal> -</term><listitem><para>flush right -</para></listitem></varlistentry></variablelist> -<indexterm role="fn"><primary>\\ (for <literal>array</literal>)</primary></indexterm> -<para>Column entries are separated by <literal>&</literal>. Column entries may include -other &latex; commands. Each row of the array is terminated with -<literal>\\</literal>. +<screen>\begin{array}[<replaceable>pos</replaceable>]{<replaceable>cols</replaceable>} +<replaceable>column 1 entry</replaceable> &<replaceable>column 2 entry</replaceable> ... &<replaceable>column n entry</replaceable> \\ +... +\end{array} +</screen> +<para>Produce a mathematical array. This environment can only be used in math +mode, and normally appears within a displayed mathematics environment +such as <literal>equation</literal> (see <link linkend="equation">equation</link>). Column entries are +separated by an ampersand (<literal>&</literal>). Rows are terminated with +double-backslashes (<literal>\\</literal>) (see <link linkend="_005c_005c">\\</link>). +</para> +<para>The required argument <replaceable>cols</replaceable> describes the number of columns, their +alignment, and the formatting of the intercolumn regions. See +<link linkend="tabular">tabular</link> for the complete description of <replaceable>cols</replaceable>, and of the +other common features of the two environments, including the optional +<replaceable>pos</replaceable> argument. +</para> +<para>There are two ways that <literal>array</literal> diverges from <literal>tabular</literal>. The +first is that <literal>array</literal> entries are typeset in mathematics mode, in +textstyle (except if the <replaceable>cols</replaceable> definition specifies the column with +<literal>@p{..}</literal>, which causes the entry to be typeset in text mode). +The second is that, instead of <literal>tabular</literal>’s parameter +<literal>\tabcolsep</literal>, &latex;’s intercolumn space in an array is governed +by +<indexterm role="fn"><primary>\arraycolsep</primary></indexterm> +<literal>\arraycolsep</literal> which gives half the width between columns. The +default for this is ‘<literal>5pt</literal>’. </para> -<indexterm role="fn"><primary>@{...}</primary></indexterm> -<para>In the template, the construct <literal>@{<replaceable>text</replaceable>}</literal> puts <replaceable>text</replaceable> -between columns in each row. +<para>To obtain arrays with braces the standard is to use the <filename>amsmath</filename> +package. It comes with environments <literal>pmatrix</literal> for an array +surrounded by parentheses <literal>(..)</literal>, <literal>bmatrix</literal> for an array +surrounded by square brackets <literal>[..]</literal>, <literal>Bmatrix</literal> for an +array surrounded by curly braces <literal>{..}</literal>, <literal>vmatrix</literal> for +an array surrounded by vertical bars <literal>|..|</literal>, and +<literal>Vmatrix</literal> for an array surrounded by double vertical +bars <literal>||..||</literal>, along with a number of other array constructs. </para> -<para>Here’s an example: +<para>Here is an example of an array: </para> <screen>\begin{equation} - \begin{array}{lrc} - left1 & right1 & centered1 \\ - left2 & right2 & centered2 \\ + \begin{array}{cr} + \sqrt{y} &12.3 \\ + x^2 &3.4 \end{array} \end{equation} </screen> -<indexterm role="fn"><primary>\arraycolsep</primary></indexterm> -<para>The <literal>\arraycolsep</literal> parameter defines half the width of the space -separating columns; the default is ‘<literal>5pt</literal>’. See <link linkend="tabular">tabular</link>, for other -parameters which affect formatting in <literal>array</literal> environments, -namely <literal>\arrayrulewidth</literal> and <literal>\arraystretch</literal>. -</para> -<para>The <literal>array</literal> environment can only be used in math mode. -</para> </sect1> <sect1 label="8.3" id="center"> @@ -1351,15 +1911,32 @@ namely <literal>\arrayrulewidth</literal> and <literal>\arraystretch</literal>. <para>Synopsis: </para> <screen>\begin{center} -<replaceable>line1</replaceable> \\ -<replaceable>line2</replaceable> \\ + .. text .. \end{center} </screen> +<para>Environment to create a sequence of lines that are centered within the +left and right margins on the current page. If the text in the +environment body is too long to fit on a line, &latex; will insert line +breaks that avoid hyphenation and avoid stretching or shrinking any +interword space. To force a line break at a particular spot use +double-backslash <literal>\\</literal> (see <link linkend="_005c_005c">\\</link>). <indexterm role="fn"><primary>\\ (for <literal>center</literal>)</primary></indexterm> -<para>The <literal>center</literal> environment allows you to create a paragraph -consisting of lines that are centered within the left and right -margins on the current page. Each line is terminated with the -string <literal>\\</literal>. +</para> +<para>This environment inserts space above and below the text body. See +<link linkend="_005ccentering">\centering</link> to avoid such space, for example inside a <literal>figure</literal> +environment. +</para> +<para>In this example, depending on the line width, &latex; may choose a break +for the part before the double backslash, will center the line or two, +then will break at the double backslash, and will center the ending. +</para> +<screen>\begin{center} + My father considered that anyone who went to chapel and didn't drink + alcohol was not to be tolerated.\\ + I grew up in that belief. --Richard Burton +\end{center} +</screen> +<para>A double backslash after the final line is optional. </para> @@ -1369,26 +1946,36 @@ string <literal>\\</literal>. <indexterm role="fn"><primary>\centering</primary></indexterm> <indexterm role="cp"><primary>centering text, declaration for</primary></indexterm> -<para>The <literal>\centering</literal> declaration corresponds to the <literal>center</literal> -environment. This declaration can be used inside an environment such -as <literal>quote</literal> or in a <literal>parbox</literal>. Thus, the text of a figure or -table can be centered on the page by putting a <literal>\centering</literal> -command at the beginning of the figure or table environment. -</para> -<para>Unlike the <literal>center</literal> environment, the <literal>\centering</literal> command -does not start a new paragraph; it simply changes how &latex; formats -paragraph units. To affect a paragraph unit’s format, the scope of -the declaration must contain the blank line or <literal>\end</literal> command (of -an environment such as quote) that ends the paragraph unit. -</para> -<para>Here’s an example: -</para> -<screen>\begin{quote} -\centering -first line \\ -second line \\ -\end{quote} +<para>Declaration that causes material in its scope to be centered. It is +most often used inside an environment such as <literal>figure</literal>, or in a +<literal>parbox</literal>. +</para> +<para>Unlike the <literal>center</literal> environment, the <literal>\centering</literal> command does +not add vertical space above and below the text. +</para> +<para>It also does not start a new paragraph; it simply changes how &latex; +formats paragraph units. If <literal>ww {\centering xx \\ yy} zz</literal> is +surrounded by blank lines then &latex; will create a paragraph whose +first line ‘<literal>ww xx</literal>’ is centered and whose second line, not centered, +contains ‘<literal>yy zz</literal>’. Usually what is desired is for the scope of the +declaration to contain a blank line or the <literal>\end</literal> command of an +environment such as <literal>figure</literal> or <literal>table</literal> that ends the +paragraph unit. Thus, if <literal>{\centering xx \\ yy\par} zz</literal> is +surrounded by blank lines then it makes a new paragraph with two +centered lines ‘<literal>xx</literal>’ and ‘<literal>yy</literal>’, followed by a new paragraph with +‘<literal>zz</literal>’ that is formatted as usual. See also the following example. +</para> +<para>This example’s <literal>\centering</literal> causes the graphic to be horizontally +centered. +</para> +<screen>\begin{figure} + \centering + \includegraphics[width=0.6\textwidth]{ctan_lion.png} + \caption{CTAN Lion} \label{fig:CTANLion} +\end{figure} </screen> +<para>The scope of the <literal>\centering</literal> ends with the <literal>\end{figure}</literal>. +</para> </sect2> </sect1> @@ -1402,51 +1989,91 @@ second line \\ <para>Synopsis: </para> <screen>\begin{description} -\item [<replaceable>label1</replaceable>] <replaceable>item1</replaceable> -\item [<replaceable>label2</replaceable>] <replaceable>item2</replaceable> -... +\item [<replaceable>first label</replaceable>] text of first item +\item [<replaceable>second label</replaceable>] text of second item + ... \end{description} </screen> <indexterm role="fn"><primary>\item</primary></indexterm> -<para>The <literal>description</literal> environment is used to make labelled lists. Each -<replaceable>label</replaceable> is typeset in bold, flush right. The <replaceable>item</replaceable> text may -contain multiple paragraphs. +<para>Environment to make a labelled list of items. Each item’s <replaceable>label</replaceable> +is typeset in bold, flush-left. Each item’s text may contain multiple +paragraphs. Although the labels on the items are optional there is no +sensible default, so all items should have labels. +</para> +<indexterm role="fn"><primary>\item</primary></indexterm> +<para>The list consists of at least one item; see <link linkend="_005citem">\item</link> (having no +items causes the &latex; error ‘<literal>Something's wrong--perhaps a +missing \item</literal>’). Each item is produced with an <literal>\item</literal> command. </para> <indexterm role="cp"><primary>bold typewriter, avoiding</primary></indexterm> <indexterm role="cp"><primary>typewriter labels in lists</primary></indexterm> -<para>Another variation: since the bold style is applied to the labels, if -you typeset a label in typewriter using <literal>\texttt</literal>, you’ll get -bold typewriter: <literal>\item[\texttt{bold and typewriter}]</literal>. This -may be too bold, among other issues. To get just typewriter, use -<literal>\tt</literal>, which resets all other style variations: <literal>\item[{\tt -plain typewriter}]</literal>. -</para> -<para>For details about list spacing, see <link linkend="itemize">itemize</link>. -</para> +<para>Since the labels are in bold style, if the label text calls for a font +change given in argument style (see <link linkend="Font-styles">Font styles</link>) then it will come +out bold. For instance, if the label text calls for typewriter with +<literal>\item[\texttt{label text}]</literal> then it will appear in bold +typewriter, if that is available. The simplest way to get non-bolded +typewriter is to use declaritive style <literal>\item[{\tt label text}]</literal>. +Similarly, get normal text use <literal>\item[{\rm label text}]</literal>. +</para> +<para>For other major &latex; labelled list environments, see <link linkend="itemize">itemize</link> +and <link linkend="enumerate">enumerate</link>. For information about customizing list layout, see +<link linkend="list">list</link>; also, the package <filename>enumitem</filename> is useful for this. +</para> +<para>This example shows the environment used for a sequence of definitions. +</para> +<screen>\begin{definition} + \item[lama] A priest. + \item[llama] A beast. +\end{definition} +</screen> </sect1> <sect1 label="8.5" id="displaymath"> <title><literal>displaymath</literal></title> +<!-- http://tex.stackexchange.com/questions/40492/what-are-the-differences-between-align-equation-and-displaymath --> <indexterm role="fn"><primary>displaymath environment</primary></indexterm> <para>Synopsis: </para> <screen>\begin{displaymath} -<replaceable>math</replaceable> + .. math text .. \end{displaymath} </screen> -<para>or -</para> -<screen>\[<replaceable>math</replaceable>\] -</screen> -<para>The <literal>displaymath</literal> environment (<literal>\[...\]</literal> is a synonym) -typesets the <replaceable>math</replaceable> text on its own line, centered by default. -The global <literal>fleqn</literal> option makes equations flush left; see -<link linkend="Document-class-options">Document class options</link>. -</para> -<para>No equation number is added to <literal>displaymath</literal> text; to get an -equation number, use the <literal>equation</literal> environment (see <link linkend="equation">equation</link>). +<para>Environment to typeset the math text on its own line, in display style +and centered. To make the text be flush-left use the global option +<literal>fleqn</literal>; see <link linkend="Document-class-options">Document class options</link>. +</para> +<para>&latex; will not break the math text across lines. +</para> +<para>In the <literal>displaymath</literal> environment no equation number is added to the +math text. One way to get an equation number is to use the +<literal>equation</literal> environment (see <link linkend="equation">equation</link>). +</para> +<para>Note that the <filename>amsmath</filename> package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. For example, there are a number of options in that +package for having math text broken across lines. +</para> +<para>The construct <literal>\[..math text..\]</literal> is essentially a synonym for +<literal>\begin{displaymath}..math text..\end{displaymath}</literal> but the +latter is easier to work with in the source file; for instance, +searching for a square bracket may get false positives but the word +<literal>displaymath</literal> will likely be unique. (The construct <literal>$$..math +text..$$</literal> from Plain &tex; is sometimes mistakenly used as a +synonym for <literal>displaymath</literal>. It is not a synonym, because the +<literal>displaymath</literal> environment checks that it isn’t started in math mode +and that it ends in math mode begun by the matching environment start, +because the <literal>displaymath</literal> environment has different vertical +spacing, and because the <literal>displaymath</literal> environment honors the +<literal>fleqn</literal> option.) +</para> +<para>The output from this example is centered and alone on its line. +</para><screen>\begin{displaymath} + \int_1^2 x^2\,dx=7/3 +\end{displaymath} +</screen><para>Also, the integral sign is larger than the inline version +<literal>\( \int_1^2 x^2\,dx=7/3 \)</literal> produces. </para> </sect1> @@ -1455,10 +2082,50 @@ equation number, use the <literal>equation</literal> environment (see <link link <indexterm role="fn"><primary>document environment</primary></indexterm> -<para>The <literal>document</literal> environment encloses the body of a document. +<para>The <literal>document</literal> environment encloses the entire body of a document. It is required in every &latex; document. See <link linkend="Starting-and-ending">Starting and ending</link>. </para> + +<anchor id="_005cAtBeginDocument"/> + +<indexterm role="fn"><primary>\AtBeginDocument</primary></indexterm> +<indexterm role="cp"><primary>beginning of document hook</primary></indexterm> + +<para>Synopsis: +</para> +<screen>\AtBeginDocument{<replaceable>code</replaceable>} +</screen> +<para>Save <replaceable>code</replaceable> and execute it when <literal>\begin{document}</literal> is +executed, at the very end of the preamble. The code is executed after +the font selection tables have been set up, so the normal font for the +document is the current font. However, the code is executed as part of +the preamble so you cannot do any typesetting with it. +</para> +<para>You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. +</para> + +<anchor id="_005cAtEndDocument"/> + +<indexterm role="fn"><primary>\AtEndDocument</primary></indexterm> +<indexterm role="cp"><primary>end of document hook</primary></indexterm> + +<para>Synopsis: +</para> +<screen>\AtEndDocument{<replaceable>code</replaceable>} +</screen> +<para>Save <replaceable>code</replaceable> and execute it near the end of the document. +Specifically, it is executed when <literal>\end{document}</literal> is executed, +before the final page is finished and before any leftover floating +environments are processed. If you want some of the code to be executed +after these two processes then include a <literal>\clearpage</literal> at the +appropriate point in <replaceable>code</replaceable>. +</para> +<para>You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. +</para> + </sect1> <sect1 label="8.7" id="enumerate"> <title><literal>enumerate</literal></title> @@ -1469,50 +2136,72 @@ It is required in every &latex; document. See <link linkend="Starting-and-endin <para>Synopsis: </para> <screen>\begin{enumerate} -\item <replaceable>item1</replaceable> -\item <replaceable>item2</replaceable> +\item [<replaceable>first label</replaceable>] text of first item +\item [<replaceable>second label</replaceable>] text of second item ... \end{enumerate} </screen> -<para>The <literal>enumerate</literal> environment produces a numbered list. Enumerations -can be nested within one another, up to four levels deep. They can also -be nested within other paragraph-making environments, such as -<literal>itemize</literal> (see <link linkend="itemize">itemize</link>) and <literal>description</literal> -(see <link linkend="description">description</link>). +<para>Environment to produce a numbered list of items. The format of the +label numbering depends on whether this environment is nested within +another; see below. </para> <indexterm role="fn"><primary>\item</primary></indexterm> -<para>Each item of an enumerated list begins with an <literal>\item</literal> command. -There must be at least one <literal>\item</literal> command within the environment. +<para>The list consists of at least one item. Having no items causes the +&latex; error ‘<literal>Something's wrong--perhaps a missing \item</literal>’. Each +item is produced with an <literal>\item</literal> command. </para> -<para>By default, the numbering at each level is done like this: +<para>This example lists the top two finishers in the 1908 Olympic marathon. </para> -<orderedlist numeration="arabic"><listitem><para>1., 2., … -</para></listitem><listitem><para>(a), (b), … -</para></listitem><listitem><para>i., ii., … -</para></listitem><listitem><para>A., B., … +<screen>\begin{enumerate} + \item Johnny Hayes (USA) + \item Charles Hefferon (RSA) +\end{enumerate} +</screen> +<para>Enumerations may be nested within a paragraph-making environment, +including <literal>itemize</literal> (see <link linkend="itemize">itemize</link>), <literal>description</literal> +(see <link linkend="description">description</link>) and <literal>enumeration</literal>, up to four levels deep. +The format of the label produced depends on the place in the nesting. +This gives &latex;’s default for the format at each nesting level +(where 1 is the outermost level): +</para> +<orderedlist numeration="arabic"><listitem><para>arabic number followed by a period: ‘<literal>1.</literal>’, ‘<literal>2.</literal>’, … +</para></listitem><listitem><para>lower case letter inside parentheses: ‘<literal>(a)</literal>’, ‘<literal>(b)</literal>’ … +</para></listitem><listitem><para>lower case roman numeral followed by a period: ‘<literal>i.</literal>’, ‘<literal>ii.</literal>’, … +</para></listitem><listitem><para>upper case letter followed by a period: ‘<literal>A.</literal>’, ‘<literal>B.</literal>’, … </para></listitem></orderedlist> <indexterm role="fn"><primary>\enumi</primary></indexterm> <indexterm role="fn"><primary>\enumii</primary></indexterm> <indexterm role="fn"><primary>\enumiii</primary></indexterm> <indexterm role="fn"><primary>\enumiv</primary></indexterm> -<para>The <literal>enumerate</literal> environment uses the counters <literal>\enumi</literal> -through <literal>\enumiv</literal> counters (see <link linkend="Counters">Counters</link>). If the optional -argument to <literal>\item</literal> is given, the counter is not incremented for -that item. +<para>The <literal>enumerate</literal> environment uses the counters <literal>\enumi</literal> through +<literal>\enumiv</literal> counters (see <link linkend="Counters">Counters</link>). If you use the optional +argument to <literal>\item</literal> then the counter is not incremented for that +item (see <link linkend="_005citem">\item</link>). </para> <indexterm role="fn"><primary>\labelenumi</primary></indexterm> <indexterm role="fn"><primary>\labelenumii</primary></indexterm> <indexterm role="fn"><primary>\labelenumiii</primary></indexterm> <indexterm role="fn"><primary>\labelenumiv</primary></indexterm> -<para>The <literal>enumerate</literal> environment uses the commands <literal>\labelenumi</literal> -through <literal>\labelenumiv</literal> to produce the default label. So, you can -use <literal>\renewcommand</literal> to change the labels (see <link linkend="_005cnewcommand-_0026-_005crenewcommand">\newcommand & -\renewcommand</link>). For instance, to have the first level use uppercase -letters: +<para>To change the format of the label use <literal>\renewcommand</literal> +(see <link linkend="_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</link>) on the commands <literal>\labelenumi</literal> +through <literal>\labelenumiv</literal>. For instance, this first level list will be +labelled with uppercase letters, in boldface, and without a trailing +period: </para> <indexterm role="fn"><primary>\Alph example</primary></indexterm> -<screen>\renewcommand{\labelenumi}{\Alph{enumi}} +<screen>\renewcommand{\labelenumi}{\textbf{\Alph{enumi}}} +\begin{enumerate} + \item eI + \item bi: + \item si: +\end{enumerate} </screen> +<para>For a list of counter-labelling commands like <literal>\Alph</literal> see +<link linkend="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</link>. +</para> +<para>For more on customizing the layout see <link linkend="list">list</link>. Also, the package +<filename>enumitem</filename> is useful for this. +</para> </sect1> @@ -1526,44 +2215,63 @@ letters: <indexterm role="cp"><primary>align environment, from <literal>amsmath</literal></primary></indexterm> <indexterm role="cp"><primary>amsmath package, replacing <literal>eqnarray</literal></primary></indexterm> <indexterm role="cp"><primary>Madsen, Lars</primary></indexterm> -<para>First, a caveat: the <literal>eqnarray</literal> environment has some infelicities -which cannot be overcome; the article “Avoid eqnarray!” by Lars -Madsen describes them in detail -(<ulink url="http://tug.org/TUGboat/tb33-1/tb103madsen.pdf">http://tug.org/TUGboat/tb33-1/tb103madsen.pdf</ulink>). The bottom -line is that it is better to use the <literal>align</literal> environment (and -others) from the <literal>amsmath</literal> package. -</para> -<para>Nevertheless, here is a description of <literal>eqnarray</literal>: -</para> -<screen>\begin{eqnarray} (or <literal>eqnarray*</literal>) -<replaceable>formula1</replaceable> \\ -<replaceable>formula2</replaceable> \\ -... +<para>First, a caveat: the <literal>eqnarray</literal> environment is depreciated. It has +infelicities that cannot be overcome, including spacing that is +inconsistent with other mathematics elements (see the article “Avoid +eqnarray!” by Lars Madsen +<ulink url="http://tug.org/TUGboat/tb33-1/tb103madsen.pdf">http://tug.org/TUGboat/tb33-1/tb103madsen.pdf</ulink>). New documents +should include the <filename>amsmath</filename> package and use the displayed +mathematics environments provided there, such as the <literal>align</literal> +environment. +</para> +<para>Nevertheless, for completeness and for a reference when working with old +documents, a synopsis: +</para> +<screen>\begin{eqnarray} + <replaceable>first formula left</replaceable> &<replaceable>first formula middle</replaceable> &<replaceable>first formula right</replaceable> \\ + ... \end{eqnarray} </screen> +<para>or +</para> +<screen>\begin{eqnarray*} + <replaceable>first formula left</replaceable> &<replaceable>first formula middle</replaceable> &<replaceable>first formula right</replaceable> \\ + ... +\end{eqnarray*} +</screen> <indexterm role="fn"><primary>\\ (for <literal>eqnarray</literal>)</primary></indexterm> -<para>The <literal>eqnarray</literal> environment is used to display a sequence of -equations or inequalities. It is similar to a three-column -<literal>array</literal> environment, with consecutive rows separated by <literal>\\</literal> -and consecutive items within a row separated by an <literal>&</literal>. +<para>Display a sequence of equations or inequalities. The left and right +sides are typeset in display mode, while the middle is typeset in text +mode. </para> +<para>It is similar to a three-column <literal>array</literal> environment, with items +within a row separated by an ampersand (<literal>&</literal>), and with rows +separated by double backslash  <literal>\\</literal>). <indexterm role="fn"><primary>\\* (for <literal>eqnarray</literal>)</primary></indexterm> -<para><literal>\\*</literal> can also be used to separate equations, with its normal -meaning of not allowing a page break at that line. +The starred form of line break (<literal>\\*</literal>) can also be used to separate +equations, and will disallow a page break there (see <link linkend="_005c_005c">\\</link>). </para> <indexterm role="fn"><primary>\nonumber</primary></indexterm> <indexterm role="cp"><primary>equation numbers, omitting</primary></indexterm> -<para>An equation number is placed on every line unless that line has a -<literal>\nonumber</literal> command. Alternatively, The <literal>*</literal>-form of the -environment (<literal>\begin{eqnarray*} ... \end{eqnarray*}</literal>) will -omit equation numbering entirely, while otherwise being the same as -<literal>eqnarray</literal>. +<para>The unstarred form <literal>eqnarray</literal> places an equation number on every +line (using the <literal>equation</literal> counter), unless that line contains a +<literal>\nonumber</literal> command. The starred form <literal>eqnarray*</literal> omits +equation numbering, while otherwise being the same. </para> <indexterm role="fn"><primary>\lefteqn</primary></indexterm> <para>The command <literal>\lefteqn</literal> is used for splitting long formulas across lines. It typesets its argument in display style flush left in a box of zero width. </para> +<para>This example shows three lines. The first two lines make an inequality, +while the third line has not entry on the left side. +</para> +<screen>\begin{eqnarray*} + \lefteqn{x_1+x_2+\cdots+x_n} \\ + &\leq &y_1+y_2+\cdots+y_n \\ + &= &z+y_3+\cdots+y_n +\end{eqnarray*} +</screen> </sect1> <sect1 label="8.9" id="equation"> @@ -1576,196 +2284,141 @@ zero width. <para>Synopsis: </para> <screen>\begin{equation} -<replaceable>math</replaceable> + math text \end{equation} </screen> -<para>The <literal>equation</literal> environment starts a <literal>displaymath</literal> -environment (see <link linkend="displaymath">displaymath</link>), e.g., centering the <replaceable>math</replaceable> text -on the page, and also places an equation number in the right margin. +<para>Make a <literal>displaymath</literal> environment (see <link linkend="displaymath">displaymath</link>) with an +equation number in the right margin. +</para> +<para>The equation number is generated using the <literal>equation</literal> counter. +</para> +<para>Note that the <filename>amsmath</filename> package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. </para> </sect1> <sect1 label="8.10" id="figure"> <title><literal>figure</literal></title> + <indexterm role="fn"><primary>figure</primary></indexterm> <indexterm role="cp"><primary>inserting figures</primary></indexterm> <indexterm role="cp"><primary>figures, inserting</primary></indexterm> -<screen>\begin{figure[*]}[<replaceable>placement</replaceable>] -<replaceable>figbody</replaceable> +<para>Synopsis: +</para> +<screen>\begin{figure}[<replaceable>placement</replaceable>] + figure body +\caption[<replaceable>loftitle</replaceable>]{<replaceable>title</replaceable>} \label{<replaceable>label}</replaceable> -\caption[<replaceable>loftitle</replaceable>]{<replaceable>text</replaceable>} \end{figure} </screen> -<para>Figures are objects that are not part of the normal text, and are -instead “floated” to a convenient place, such as the top of a page. -Figures will not be split between two pages. -</para> -<para>When typesetting in double-columns, the starred form produces a -full-width figure (across both columns). -</para> -<indexterm role="cp"><primary>placement of floats</primary></indexterm> -<indexterm role="cp"><primary>specifier, float placement</primary></indexterm> -<para>The optional argument <literal>[placement]</literal> determines where &latex; will try -to place your figure. There are four places where &latex; can possibly -put a float: -</para> -<variablelist><varlistentry><term><literal>t</literal> -</term><listitem><para>(Top)—at the top of a text page. -</para> -</listitem></varlistentry><varlistentry><term><literal>b</literal> -</term><listitem><para>(Bottom)—at the bottom of a text page. However, <literal>b</literal> is not -allowed for full-width floats (<literal>figure*</literal>) with double-column -output. To ameliorate this, use the <literal>stfloats</literal> or -<literal>dblfloatfix</literal> package, but see the discussion at caveats in the -FAQ: <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</ulink>. -</para> -</listitem></varlistentry><varlistentry><term><literal>h</literal> -</term><listitem><para>(Here)—at the position in the text where the <literal>figure</literal> environment -appears. However, <literal>t</literal> is not allowed by itself; <literal>t</literal> is -automatically added. -</para> -<indexterm role="cp"><primary>here, putting floats</primary></indexterm> -<indexterm role="cp"><primary><literal>float</literal> package</primary></indexterm> -<para>To absolutely force a figure to appear “here”, you can -<literal>\usepackage{float}</literal> and use the <literal>H</literal> specifier which it -defines. For further discussion, see the FAQ entry at -<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</ulink>. +<para>or </para> -</listitem></varlistentry><varlistentry><term><literal>p</literal> -</term><listitem><para>(Page of floats)—on a separate float page, which is a page -containing no text, only floats. +<screen>\begin{figure*}[<replaceable>placement</replaceable>] + figure body +\caption[<replaceable>loftitle</replaceable>]{<replaceable>title</replaceable>} +\label{<replaceable>label}</replaceable> +\end{figure*} +</screen> +<para>A class of floats (see <link linkend="Floats">Floats</link>). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are “floated” to a convenient place, such as the top of a following +page. </para> -</listitem></varlistentry><varlistentry><term><literal>!</literal> -</term><listitem><para>Used in addition to one of the above; for this float only, &latex; -ignores the restrictions on both the number of floats that can appear -and the relative amounts of float and non-float text on the page. -The <literal>!</literal> specifier does <emphasis>not</emphasis> mean “put the float here”; -see above. +<para>For the possible values of <replaceable>placement</replaceable> and their effect on the +float placement algorithm, see <link linkend="Floats">Floats</link>. </para> -</listitem></varlistentry></variablelist> -<para>The standard <literal>report</literal> and <literal>article</literal> classes use the default placement -<literal>tbp</literal>. +<para>The starred form <literal>figure*</literal> is used when a document is in +double-column mode (see <link linkend="_005ctwocolumn">\twocolumn</link>). It produces a figure that +spans both columns, at the top of the page. To add the possibility of +placing at a page bottom see the discussion of <replaceable>placement</replaceable> <literal>b</literal> +in <link linkend="Floats">Floats</link>. </para> -<para>The body of the figure is made up of whatever text, &latex; commands, -etc. you wish. +<para>The figure body is typeset in a <literal>parbox</literal> of width <literal>\textwidth</literal> +and so it can contain text, commands, etc. </para> +<para>The label is optional; it is used for cross-references (see <link linkend="Cross-references">Cross +references</link>). <indexterm role="fn"><primary>\caption</primary></indexterm> -<para>The <literal>\caption</literal> command specifies caption <replaceable>text</replaceable> for the -figure. The caption is numbered by default. If <replaceable>loftitle</replaceable> is -present, it is used in the list of figures instead of <replaceable>text</replaceable> -(see <link linkend="Tables-of-contents">Tables of contents</link>). -</para> -<para>Parameters relating to fractions of pages occupied by float and -non-float text: -</para> -<variablelist><indexterm role="fn"><primary>\bottomfraction</primary></indexterm> -<para>The maximum fraction of the page allowed to be occupied by floats at -the bottom; default ‘<literal>.3</literal>’. -</para> -<varlistentry><term><indexterm role="fn"><primary>\floatpagefraction</primary></indexterm><literal>\floatpagefraction</literal> -</term><listitem><para>The minimum fraction of a float page that must be occupied by floats; -default ‘<literal>.5</literal>’. -</para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textfraction</primary></indexterm><literal>\textfraction</literal> -</term><listitem><para>Minimum fraction of a page that must be text; if floats take up too -much space to preserve this much text, floats will be moved to a -different page. The default is ‘<literal>.2</literal>’. -</para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topfraction</primary></indexterm><literal>\topfraction</literal> -</term><listitem><para>Maximum fraction at the top of a page that may be occupied before -floats; default ‘<literal>.7</literal>’. -</para></listitem></varlistentry></variablelist> -<para>Parameters relating to vertical space around floats: -</para> -<variablelist><varlistentry><term><indexterm role="fn"><primary>\floatsep</primary></indexterm><literal>\floatsep</literal> -</term><listitem><para>Space between floats at the top or bottom of a page; default -‘<literal>12pt plus2pt minus2pt</literal>’. -</para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\intextsep</primary></indexterm><literal>\intextsep</literal> -</term><listitem><para>Space above and below a float in the middle of the main text; default -‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and ‘<literal>11pt</literal>’ styles, -‘<literal>14pt plus4pt minus4pt</literal>’ for ‘<literal>12pt</literal>’. -</para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textfloatsep</primary></indexterm><literal>\textfloatsep</literal> -</term><listitem><para>Space between the last (first) float at the top (bottom) of a page; -default ‘<literal>20pt plus2pt minus4pt</literal>’. -</para></listitem></varlistentry></variablelist> -<para>Counters relating to the number of floats on a page: -</para> -<variablelist><varlistentry><term><indexterm role="fn"><primary>bottomnumber</primary></indexterm><literal>bottomnumber</literal> -</term><listitem><para>Maximum number of floats that can appear at the bottom of a text page; -default 1. -</para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>dbltopnumber</primary></indexterm><literal>dbltopnumber</literal> -</term><listitem><para>Maximum number of full-sized floats that can appear at the top of a -two-column page; default 2. -</para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>topnumber</primary></indexterm><literal>topnumber</literal> -</term><listitem><para>Maximum number of floats that can appear at the top of a text page; -default 2. -</para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>totalnumber</primary></indexterm><literal>totalnumber</literal> -</term><listitem><para>Maximum number of floats that can appear on a text page; default 3. -</para></listitem></varlistentry></variablelist> -<para>The principal &tex; FAQ entry relating to floats: -<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</ulink>. -</para> +The optional <literal>\caption</literal> command specifies caption text for the +figure. By default it is numbered. If <replaceable>loftitle</replaceable> is present, it is +used in the list of figures instead of <replaceable>title</replaceable> (see <link linkend="Tables-of-contents">Tables of +contents</link>). +</para> +<para>This example makes a figure out of a graphic. It requires one of the +packages <filename>graphics</filename> or <filename>graphicx</filename>. The graphic, with its +caption, will be placed at the top of a page or, if it is pushed to the +end of the document, on a page of floats. +</para> +<screen>\begin{figure}[t] + \centering + \includegraphics[width=0.5\textwidth]{CTANlion.png} + \caption{The CTAN lion, by Duane Bibby} +\end{figure} +</screen> </sect1> <sect1 label="8.11" id="filecontents"> -<title><literal>filecontents</literal>: Create external files</title> +<title><literal>filecontents</literal>: Write an external file</title> + <indexterm role="fn"><primary>filecontents</primary></indexterm> -<indexterm role="cp"><primary>external files, creating</primary></indexterm> +<indexterm role="cp"><primary>external files, writing</primary></indexterm> <indexterm role="cp"><primary>writing external files</primary></indexterm> <para>Synopsis: </para> <screen>\begin{filecontents}{<replaceable>filename</replaceable>} -<replaceable>contents-of-file</replaceable> + <replaceable>text</replaceable> \end{filecontents} -... -\documentclass{<replaceable>my-document-class</replaceable>} </screen> -<indexterm role="cp"><primary>initial command</primary></indexterm> -<indexterm role="fn"><primary>\documentclass, commands before</primary></indexterm> -<para>The <literal>filecontents</literal> environment is an <firstterm>initial command</firstterm>, -meaning that it can be used only before the <literal>\documentclass</literal> -command, as in the synopsis above. -</para> -<para>&latex; will create a file named <replaceable>filename</replaceable> with the content -<replaceable>contents-of-file</replaceable> preceded by a header comment indicating how and -when the file was generated. If the file already exists then nothing will -happen. -</para> -<para>You can also use the <literal>filecontents</literal> package, which has the -following advantages: +<para>or </para> -<itemizedlist><listitem><para>If the file already exists, then it will be overwritten. +<screen>\begin{filecontents*}{<replaceable>filename</replaceable>} + <replaceable>text</replaceable> +\end{filecontents*} +</screen> +<para>Create a file named <replaceable>filename</replaceable> and fill it with <replaceable>text</replaceable>. The +unstarred version of the environment <literal>filecontents</literal> prefixes the +content of the created file with a header; see the example below. The +starred version <literal>filecontents*</literal> does not include the header. </para> -</listitem><listitem><para>You can use the <literal>filecontents</literal> environment at any point after the -declaration <literal>\usepackage{filecontents}</literal>, not just before -<literal>\documentclass</literal>. +<para>This environment can be used anywhere in the preamble, although it often +appears before the <literal>\documentclass</literal> command. It is typically used +when a source file requires a nonstandard style or class file. The +environment will write that file to the directory containing the source +and thus make the source file self-contained. Another use is to include +<literal>bib</literal> references in the file, again to make it self-contained. </para> -</listitem><listitem><para>The <literal>filecontents</literal> package also provides a <literal>filecontents*</literal> -environment which is used in the same way as the <literal>filecontents</literal> -environment except that it won’t insert any leading comment, so it is -better suited to create files which aren’t in &latex; format. +<para>The environment checks whether a file of that name already exists and if +so, does not do anything. There is a <filename>filecontents</filename> package that +redefines the <literal>filecontents</literal> environment so that instead of doing +nothing in that case, it will overwrite the existing file. </para> -</listitem></itemizedlist> -<para>The <literal>filecontents</literal> environment only creates the file, and is -unrelated to using the created file. So you need to use, for -instance, <literal>\input</literal> or <literal>\usepackage</literal> or <literal>\bibliography</literal> -or whatever is applicable, to use the created file. +<para>For example, this document </para> -<para>This environment is also useful to make a document in a self-contained -file, for example, for a bug report, or to keep the content of a -<filename>.bib</filename> file in the same file as the main document. +<screen>\documentclass{article} +\begin{filecontents}{JH.sty} +\newcommand{\myname}{Jim Hef{}feron} +\end{filecontents} +\usepackage{JH} +\begin{document} +Article by \myname. +\end{document} +</screen> +<para>produces this file <filename>JH.sty</filename>. </para> +<screen>%% LaTeX2e file `JH.sty' +%% generated by the `filecontents' environment +%% from source `test' on 2015/10/12. +%% +\newcommand{\myname}{Jim Hef{}feron} +</screen> </sect1> <sect1 label="8.12" id="flushleft"> <title><literal>flushleft</literal></title> + <indexterm role="fn"><primary>flushleft environment</primary></indexterm> <indexterm role="cp"><primary>left-justifying text, environment for</primary></indexterm> <indexterm role="cp"><primary>ragged right text, environment for</primary></indexterm> @@ -1779,12 +2432,13 @@ file, for example, for a bug report, or to keep the content of a <indexterm role="fn"><primary>\\ for <literal>flushleft</literal></primary></indexterm> <para>The <literal>flushleft</literal> environment allows you to create a paragraph consisting of lines that are flush to the left-hand margin and ragged -right Each line must be terminated with the string <literal>\\</literal>. +right. Each line must be terminated with the string <literal>\\</literal>. </para> <sect2 label="8.12.1" id="_005craggedright"> <title><literal>\raggedright</literal></title> + <indexterm role="fn"><primary>\raggedright</primary></indexterm> <indexterm role="cp"><primary>ragged right text</primary></indexterm> <indexterm role="cp"><primary>left-justifying text</primary></indexterm> @@ -1805,6 +2459,7 @@ command that ends the paragraph unit. </sect1> <sect1 label="8.13" id="flushright"> <title><literal>flushright</literal></title> + <indexterm role="fn"><primary>flushright environment</primary></indexterm> <indexterm role="cp"><primary>ragged left text, environment for</primary></indexterm> <indexterm role="cp"><primary>right-justifying text, environment for</primary></indexterm> @@ -1818,12 +2473,13 @@ command that ends the paragraph unit. <indexterm role="fn"><primary>\\ (for <literal>flushright</literal>)</primary></indexterm> <para>The <literal>flushright</literal> environment allows you to create a paragraph consisting of lines that are flush to the right-hand margin and ragged -left. Each line must be terminated with the string <literal>\\</literal>. +left. Each line must be terminated with the control sequence <literal>\\</literal>. </para> <sect2 label="8.13.1" id="_005craggedleft"> <title><literal>\raggedleft</literal></title> + <indexterm role="fn"><primary>\raggedleft</primary></indexterm> <indexterm role="cp"><primary>ragged left text</primary></indexterm> <indexterm role="cp"><primary>justification, ragged left</primary></indexterm> @@ -1844,6 +2500,7 @@ command that ends the paragraph unit. </sect1> <sect1 label="8.14" id="itemize"> <title><literal>itemize</literal></title> + <indexterm role="fn"><primary>itemize environment</primary></indexterm> <indexterm role="fn"><primary>\item</primary></indexterm> <indexterm role="cp"><primary>lists of items</primary></indexterm> @@ -1970,7 +2627,8 @@ see <link linkend="_005cparskip">\parskip</link>): </sect1> <sect1 label="8.15" id="letter"> <title><literal>letter</literal> environment: writing letters</title> -<indexterm role="fn"><primary>letter</primary></indexterm> + +<indexterm role="fn"><primary>letter environment</primary></indexterm> <para>This environment is used for creating letters. See <link linkend="Letters">Letters</link>. </para> @@ -1978,6 +2636,7 @@ see <link linkend="_005cparskip">\parskip</link>): </sect1> <sect1 label="8.16" id="list"> <title><literal>list</literal></title> + <indexterm role="fn"><primary>list</primary></indexterm> <indexterm role="cp"><primary>lists of items, generic</primary></indexterm> @@ -2004,6 +2663,42 @@ empty, i.e., <literal>{}</literal>, which leaves the default spacing. <literal>\linewidth</literal> (see <link linkend="Page-layout-parameters">Page layout parameters</link>). </para> + +<anchor id="_005citem"/> + +<para>Synopsis: +</para> +<screen>\item text of item +</screen> +<para>or +</para><screen>\item[<replaceable>optional label</replaceable>] text of item +</screen> +<para>An entry in a list. The entries are prefixed by a label, whose default +depends on the list type. +</para> +<para>Because the optional argument <replaceable>optional label</replaceable> is surrounded by +square brackets (<literal>[</literal> and <literal>]</literal>), to use square brackets +inside the optional argument you must hide them inside curly braces, as +in <literal>\item[Close square bracket, {]}]</literal>. Similarly, to use an open +square bracket as first character in the text of the item, also hide it +inside curly braces. See <link linkend="LaTeX-command-syntax">&latex; command syntax</link>. +</para> +<para>In this example the <literal>enumerate</literal> list has two items that use the +default label and one that uses the optional label. +</para> +<screen>\begin{enumerate} + \item Moe + \item[sometimes] Shemp + \item Larry +\end{enumerate} +</screen> +<para>The first item is labelled ‘<literal>1.</literal>’, the second item is labelled +‘<literal>sometimes</literal>’, and the third item is labelled ‘<literal>2.</literal>’ (note that, +because of the optional label in the second item, the third item does +not get a ‘<literal>3.</literal>’). +</para> + + </sect1> <sect1 label="8.17" id="math"> <title><literal>math</literal></title> @@ -2018,7 +2713,7 @@ empty, i.e., <literal>{}</literal>, which leaves the default spacing. \end{math} </screen> <para>The <literal>math</literal> environment inserts the given <replaceable>math</replaceable> within the -running text. <literal>\(...\))</literal> and <literal>$...$</literal> are synonyms. +running text. <literal>\(...\)</literal> and <literal>$...$</literal> are synonyms. See <link linkend="Math-formulas">Math formulas</link>. </para> @@ -2069,7 +2764,7 @@ footnotes; they may wind up at the bottom of the wrong minipage. <indexterm role="cp"><primary>creating pictures</primary></indexterm> <indexterm role="cp"><primary>pictures, creating</primary></indexterm> -<screen>\begin{picture}(width,height)(x offset,y offset) +<screen>\begin{picture}(<replaceable>width</replaceable>,<replaceable>height</replaceable>)(<replaceable>xoffset</replaceable>,<replaceable>yoffset</replaceable>) … <replaceable>picture commands</replaceable> … \end{picture} </screen> @@ -2088,22 +2783,23 @@ centimeters. <literal>\setlength</literal> command, outside of a <literal>picture</literal> environment. The default value is <literal>1pt</literal>. </para> -<para>A position is a pair of coordinates, such as <literal>(2.4,-5)</literal>, specifying +<indexterm role="cp"><primary>position, in picture</primary></indexterm> +<para>A <firstterm>position</firstterm> is a pair of coordinates, such as <literal>(2.4,-5)</literal>, specifying the point with x-coordinate <literal>2.4</literal> and y-coordinate <literal>-5</literal>. Coordinates are specified in the usual way with respect to an origin, which is normally at the lower-left corner of the picture. Note that when a position appears as an argument, it is not enclosed in braces; the parentheses serve to delimit the argument. </para> -<para>The <literal>picture</literal> environment has one mandatory argument, which is a -<literal>position</literal>. It specifies the size of the picture. The environment -produces a rectangular box with width and height determined by this -argument’s x- and y-coordinates. +<para>The <literal>picture</literal> environment has one mandatory argument which is a +position (<replaceable>width</replaceable>,<replaceable>height</replaceable>), which specifies the size of the +picture. The environment produces a rectangular box with these +<replaceable>width</replaceable> and <replaceable>height</replaceable>. </para> -<para>The <literal>picture</literal> environment also has an optional <literal>position</literal> -argument, following the <literal>size</literal> argument, that can change the -origin. (Unlike ordinary optional arguments, this argument is not -contained in square brackets.) The optional argument gives the +<para>The <literal>picture</literal> environment also has an optional position argument +(<replaceable>xoffset</replaceable>,<replaceable>yoffset</replaceable>), following the size argument, that can +change the origin. (Unlike ordinary optional arguments, this argument +is not contained in square brackets.) The optional argument gives the coordinates of the point at the lower-left corner of the picture (thereby determining the origin). For example, if <literal>\unitlength</literal> has been set to <literal>1mm</literal>, the command @@ -2145,10 +2841,12 @@ be the lower left corner of the box. <sect2 label="8.19.1" id="_005ccircle"> <title><literal>\circle</literal></title> + <indexterm role="fn"><primary>\circle</primary></indexterm> <para>Synopsis: -</para><screen>\circle[*]{<replaceable>diameter</replaceable>} +</para> +<screen>\circle[*]{<replaceable>diameter</replaceable>} </screen> <para>The <literal>\circle</literal> command produces a circle with a diameter as close to the specified one as possible. The <literal>*</literal>-form of the command @@ -2160,10 +2858,12 @@ draws a solid circle. </sect2> <sect2 label="8.19.2" id="_005cmakebox-_0028picture_0029"> <title><literal>\makebox</literal></title> + <indexterm role="fn"><primary>\makebox (for <literal>picture</literal>)</primary></indexterm> <para>Synopsis: -</para><screen>\makebox(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>position</replaceable>]{<replaceable>text</replaceable>} +</para> +<screen>\makebox(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>position</replaceable>]{<replaceable>text</replaceable>} </screen> <para>The <literal>\makebox</literal> command for the picture environment is similar to the normal <literal>\makebox</literal> command except that you must specify a @@ -2191,6 +2891,7 @@ your <replaceable>text</replaceable> appears in. You may select up to two of th </sect2> <sect2 label="8.19.3" id="_005cframebox-_0028picture_0029"> <title><literal>\framebox</literal></title> + <indexterm role="fn"><primary>\framebox</primary></indexterm> <para>Synopsis: @@ -2230,6 +2931,7 @@ multiples of the <replaceable>dlen</replaceable>. </sect2> <sect2 label="8.19.5" id="_005cframe"> <title><literal>\frame</literal></title> + <indexterm role="fn"><primary>\frame</primary></indexterm> <para>Synopsis: @@ -2244,6 +2946,7 @@ space is put between the frame and the object. </sect2> <sect2 label="8.19.6" id="_005cline"> <title><literal>\line</literal></title> + <indexterm role="fn"><primary>\line</primary></indexterm> <para>Synopsis: @@ -2264,6 +2967,7 @@ see <literal>pict2e</literal> and many other packages on CTAN. </sect2> <sect2 label="8.19.7" id="_005clinethickness"> <title><literal>\linethickness</literal></title> + <indexterm role="fn"><primary>\linethickness</primary></indexterm> <para>The <literal>\linethickness{<replaceable>dim</replaceable>}</literal> command declares the thickness @@ -2277,6 +2981,7 @@ circles, or the quarter circles drawn by <literal>\oval</literal>. </sect2> <sect2 label="8.19.8" id="_005cthicklines"> <title><literal>\thicklines</literal></title> + <indexterm role="fn"><primary>\thicklines</primary></indexterm> <para>The <literal>\thicklines</literal> command is an alternate line thickness for @@ -2287,6 +2992,7 @@ cf. <link linkend="_005clinethickness">\linethickness</link> and <link link </sect2> <sect2 label="8.19.9" id="_005cthinlines"> <title><literal>\thinlines</literal></title> + <indexterm role="fn"><primary>\thinlines</primary></indexterm> <para>The <literal>\thinlines</literal> command is the default line thickness for @@ -2297,10 +3003,12 @@ cf. <link linkend="_005clinethickness">\linethickness</link> and <link link </sect2> <sect2 label="8.19.10" id="_005cmultiput"> <title><literal>\multiput</literal></title> + <indexterm role="fn"><primary>\multiput</primary></indexterm> <para>Synopsis: -</para><screen>\multiput(<replaceable>x</replaceable>,<replaceable>y</replaceable>)(<replaceable>delta_x</replaceable>,<replaceable>delta_y</replaceable>){<replaceable>n</replaceable>}{<replaceable>obj</replaceable>} +</para> +<screen>\multiput(<replaceable>x</replaceable>,<replaceable>y</replaceable>)(<replaceable>delta_x</replaceable>,<replaceable>delta_y</replaceable>){<replaceable>n</replaceable>}{<replaceable>obj</replaceable>} </screen> <para>The <literal>\multiput</literal> command copies the object <replaceable>obj</replaceable> in a regular pattern across a picture. <replaceable>obj</replaceable> is first placed at position @@ -2311,25 +3019,29 @@ pattern across a picture. <replaceable>obj</replaceable> is first placed at pos </sect2> <sect2 label="8.19.11" id="_005coval"> <title><literal>\oval</literal></title> + <indexterm role="fn"><primary>\oval</primary></indexterm> <para>Synopsis: </para> <screen>\oval(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>portion</replaceable>] </screen> -<para>The <literal>\oval</literal> command produces a rectangle with rounded corners. -The optional argument <replaceable>portion</replaceable> allows you to select part of the +<para>The <literal>\oval</literal> command produces a rectangle with rounded corners. The +optional argument <replaceable>portion</replaceable> allows you to produce only half of the oval via the following: </para> <variablelist><varlistentry><term><literal>t</literal> -</term><listitem><para>selects the top portion; +</term><listitem><para>selects the top half; </para></listitem></varlistentry><varlistentry><term><literal>b</literal> -</term><listitem><para>selects the bottom portion; +</term><listitem><para>selects the bottom half; </para></listitem></varlistentry><varlistentry><term><literal>r</literal> -</term><listitem><para>selects the right portion; +</term><listitem><para>selects the right half; </para></listitem></varlistentry><varlistentry><term><literal>l</literal> -</term><listitem><para>selects the left portion. +</term><listitem><para>selects the left half. </para></listitem></varlistentry></variablelist> +<para>It is also possible to produce only one quarter of the oval by setting +<replaceable>portion</replaceable> to <literal>tr</literal>, <literal>br</literal>, <literal>bl</literal>, or <literal>tl</literal>. +</para> <para>The “corners” of the oval are made with quarter circles with a maximum radius of 20pt, so large “ovals” will look more like boxes with rounded corners. @@ -2338,6 +3050,7 @@ boxes with rounded corners. </sect2> <sect2 label="8.19.12" id="_005cput"> <title><literal>\put</literal></title> + <indexterm role="fn"><primary>\put</primary></indexterm> <para>Synopsis: @@ -2352,6 +3065,7 @@ boxes with rounded corners. </sect2> <sect2 label="8.19.13" id="_005cshortstack"> <title><literal>\shortstack</literal></title> + <indexterm role="fn"><primary>\shortstack</primary></indexterm> <para>Synopsis: @@ -2375,6 +3089,7 @@ positions are: </sect2> <sect2 label="8.19.14" id="_005cvector"> <title><literal>\vector</literal></title> + <indexterm role="fn"><primary>\vector</primary></indexterm> <para>Synopsis: @@ -2388,13 +3103,17 @@ values must lie between −4 and +4, inclusive. </sect2> </sect1> -<sect1 label="8.20" id="quotation"> -<title><literal>quotation</literal></title> +<sect1 label="8.20" id="quotation-and-quote"> +<title><literal>quotation</literal> and <literal>quote</literal></title> <indexterm role="fn"><primary>quotation</primary></indexterm> <indexterm role="cp"><primary>quoted text with paragraph indentation, displaying</primary></indexterm> <indexterm role="cp"><primary>displaying quoted text with paragraph indentation</primary></indexterm> <indexterm role="cp"><primary>paragraph indentations in quoted text</primary></indexterm> +<indexterm role="fn"><primary>quote</primary></indexterm> +<indexterm role="cp"><primary>quoted text without paragraph indentation, displaying</primary></indexterm> +<indexterm role="cp"><primary>displaying quoted text without paragraph indentation</primary></indexterm> +<indexterm role="cp"><primary>paragraph indentations in quoted text, omitting</primary></indexterm> <para>Synopsis: </para> @@ -2402,38 +3121,37 @@ values must lie between −4 and +4, inclusive. <replaceable>text</replaceable> \end{quotation} </screen> -<para>The margins of the <literal>quotation</literal> environment are indented on both -the left and the right. The text is justified at both margins. -Leaving a blank line between text produces a new paragraph. -</para> -<para>Unlike the <literal>quote</literal> environment, each paragraph is indented -normally. -</para> - -</sect1> -<sect1 label="8.21" id="quote"> -<title><literal>quote</literal></title> - -<indexterm role="fn"><primary>quote</primary></indexterm> -<indexterm role="cp"><primary>quoted text without paragraph indentation, displaying</primary></indexterm> -<indexterm role="cp"><primary>displaying quoted text without paragraph indentation</primary></indexterm> -<indexterm role="cp"><primary>paragraph indentations in quoted text, omitting</primary></indexterm> - -<para>Synopsis: +<para>or </para> <screen>\begin{quote} <replaceable>text</replaceable> \end{quote} </screen> -<para>The margins of the <literal>quote</literal> environment are indented on both the -left and the right. The text is justified at both margins. Leaving a -blank line between text produces a new paragraph. -</para> -<para>Unlike the <literal>quotation</literal> environment, paragraphs are not indented. +<para>Include a quotation. +</para> +<para>In both environments, margins are indented on both sides by +<literal>\leftmargin</literal> and the text is justified at both. As with the main +text, leaving a blank line produces a new paragraph. +</para> +<para>To compare the two: in the <literal>quotation</literal> environment, paragraphs are +indented by 1.5em and the space between paragraphs is small, +<literal>0pt plus 1pt</literal>. In the <literal>quote</literal> environment, paragraphs are +not indented and there is vertical space between paragraphs (it is the +rubber length <literal>\parsep</literal>). Thus, the <literal>quotation</literal> environment +may be more suitable for documents where new paragraphs are marked by an +indent rather than by a vertical separation. In addition, <literal>quote</literal> +may be more suitable for a short quotation or a sequence of short +quotations. </para> +<screen>\begin{quotation} +\it Four score and seven years ago + .. shall not perish from the earth. +\hspace{1em plus 1fill}---Abraham Lincoln +\end{quotation} +</screen> </sect1> -<sect1 label="8.22" id="tabbing"> +<sect1 label="8.21" id="tabbing"> <title><literal>tabbing</literal></title> <indexterm role="fn"><primary>tabbing environment</primary></indexterm> @@ -2485,7 +3203,7 @@ necessary. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\’ (tabbing)</primary></indexterm><literal>\' (tabbing)</literal> </term><listitem><para>Moves everything that you have typed so far in the -current column, i.e. everything from the most recent <literal>\></literal>, +current column, i.e., everything from the most recent <literal>\></literal>, <literal>\<</literal>, <literal>\'</literal>, <literal>\\</literal>, or <literal>\kill</literal> command, to the right of the previous column, flush against the current column’s tab stop. </para> @@ -2538,7 +3256,7 @@ function \= fact(n : integer) : integer;\\ </screen> </sect1> -<sect1 label="8.23" id="table"> +<sect1 label="8.22" id="table"> <title><literal>table</literal></title> <indexterm role="fn"><primary>table</primary></indexterm> @@ -2547,79 +3265,114 @@ function \= fact(n : integer) : integer;\\ <para>Synopsis: </para> -<screen> \begin{table}[placement] - - body of the table - - \caption{table title} - \end{table} +<screen>\begin{table}[<replaceable>placement</replaceable>] + table body +\caption[<replaceable>loftitle</replaceable>]{<replaceable>title</replaceable>} +\label{<replaceable>label}</replaceable> +\end{table} </screen> -<para>Tables are objects that are not part of the normal text, and are -usually “floated” to a convenient place, like the top of a page. -Tables will not be split between two pages. -</para> -<para>The optional argument <literal>[placement]</literal> determines where &latex; will try -to place your table. There are four places where &latex; can possibly put -a float; these are the same as that used with the <literal>figure</literal> -environment, and described there (see <link linkend="figure">figure</link>). +<para>A class of floats (see <link linkend="Floats">Floats</link>). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are “floated” to a convenient place, such as the top of a following +page. </para> -<para>The standard <literal>report</literal> and <literal>article</literal> classes use the default -placement <literal>[tbp]</literal>. +<para>For the possible values of <replaceable>placement</replaceable> and their effect on the +float placement algorithm, see <link linkend="Floats">Floats</link>. </para> -<para>The body of the table is made up of whatever text, &latex; commands, etc., -you wish. The <literal>\caption</literal> command allows you to title your table. +<para>The table body is typeset in a <literal>parbox</literal> of width <literal>\textwidth</literal> +and so it can contain text, commands, etc. </para> +<para>The label is optional; it is used for cross-references (see <link linkend="Cross-references">Cross +references</link>). +<indexterm role="fn"><primary>\caption</primary></indexterm> +The optional <literal>\caption</literal> command specifies caption text for the +table. By default it is numbered. If <replaceable>lottitle</replaceable> is present, it is +used in the list of tables instead of <replaceable>title</replaceable> (see <link linkend="Tables-of-contents">Tables of +contents</link>). +</para> +<para>In this example the table and caption will float to the bottom of a page, +unless it is pushed to a float page at the end. +</para> +<screen>\begin{table}[b] + \centering + \begin{tabular}{r|p{2in}} \hline + One &The loneliest number \\ + Two &Can be as sad as one. + It's the loneliest number since the number one. + \end{tabular} + \caption{Cardinal virtues} + \label{tab:CardinalVirtues} +\end{table} +</screen> </sect1> -<sect1 label="8.24" id="tabular"> +<sect1 label="8.23" id="tabular"> <title><literal>tabular</literal></title> + <indexterm role="fn"><primary>tabular environment</primary></indexterm> <indexterm role="cp"><primary>lines in tables</primary></indexterm> <indexterm role="cp"><primary>lining text up in tables</primary></indexterm> <para>Synopsis: </para> -<screen>\begin{tabular}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ -... +<screen>\begin{tabular}[<replaceable>pos</replaceable>]{<replaceable>cols</replaceable>} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular} </screen> <para>or </para> -<screen>\begin{tabular*}{width}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ -... +<screen>\begin{tabular*}{<replaceable>width</replaceable>}[<replaceable>pos</replaceable>]{<replaceable>cols</replaceable>} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular*} </screen> -<para>These environments produce a box consisting of a sequence of rows of -items, aligned vertically in columns. -</para> +<para>These environments produce a table, a box consisting of a sequence of +horizontal rows. Each row consists of items that are aligned vertically +in columns. This illustrates many of the features. +</para> +<screen>\begin{tabular}{l|l} + \textit{Player name} &\textit{Career home runs} \\ + \hline + Hank Aaron &755 \\ + Babe Ruth &714 +\end{tabular} +</screen> +<para>The vertical format of two left-aligned columns, with a vertical bar +between them, is specified in <literal>tabular</literal>’s argument <literal>{l|l}</literal>. +<indexterm role="fn"><primary>&</primary></indexterm> +Columns are separated with an ampersand <literal>&</literal>. A horizontal rule +between two rows is created with <literal>\hline</literal>. <indexterm role="fn"><primary>\\ for <literal>tabular</literal></primary></indexterm> -<para><literal>\\</literal> must be used to specify the end of each row of the table, -except for the last, where it is optional—unless an <literal>\hline</literal> -command (to put a rule below the table) follows. -</para> -<para>The mandatory and optional arguments consist of: +The end of each row is marked with a double backslash <literal>\\</literal>. +This <literal>\\</literal> is optional after the last row unless an <literal>\hline</literal> +command follows, to put a rule below the table. </para> -<variablelist><varlistentry><term><literal>width</literal> -</term><listitem><para>Specifies the width of the <literal>tabular*</literal> environment. There must be -rubber space between columns that can stretch to fill out the specified -width. +<para>The required and optional arguments to <literal>tabular</literal> consist of: </para> -</listitem></varlistentry><varlistentry><term><literal>pos</literal> -</term><listitem><para>Specifies the vertical position; default is alignment on the centre of -the environment. -</para> -<variablelist><varlistentry><term><literal>t</literal> -</term><listitem><para>align on top row -</para> -</listitem></varlistentry><varlistentry><term><literal>b</literal> -</term><listitem><para>align on bottom row -</para></listitem></varlistentry></variablelist> -</listitem></varlistentry><varlistentry><term><literal>cols</literal> -</term><listitem><para>Specifies the column formatting. It consists of a sequence of the -following specifiers, corresponding to the sequence of columns and -intercolumn material. +<variablelist><varlistentry><term><replaceable>width</replaceable> +</term><listitem><para>Required for <literal>tabular*</literal>, not allowed for <literal>tabular</literal>. Specifies +the width of the <literal>tabular*</literal> environment. The space between columns +should be rubber, as with <literal>@{\extracolsep{\fill}}</literal>, to allow +the table to stretch or shrink to make the specified width, or else you +are likely to get the <literal>Underfull \hbox (badness 10000) in alignment +..</literal> warning. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>pos</replaceable> +</term><listitem><para>Optional. Specifies the table’s vertical position. The default is to +align the table so its vertical center matches the baseline of the +surrounding text. There are two other possible alignments: <literal>t</literal> +aligns the table so its top row matches the baseline of the surrounding +text, and <literal>b</literal> aligns on the bottom row. +</para> +<para>This only has an effect if there is other text. In the common case of a +<literal>tabular</literal> alone in a <literal>center</literal> environment this option makes +no difference. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>cols</replaceable> +</term><listitem><para>Required. Specifies the formatting of columns. It consists of a +sequence of the following specifiers, corresponding to the types of +column and intercolumn material. </para> <variablelist><varlistentry><term><literal>l</literal> </term><listitem><para>A column of left-aligned items. @@ -2633,134 +3386,284 @@ intercolumn material. </listitem></varlistentry><varlistentry><term><literal>|</literal> </term><listitem><para>A vertical line the full height and depth of the environment. </para> -</listitem></varlistentry><varlistentry><term><literal>@{<replaceable>text</replaceable>}</literal> -</term><listitem><para>This inserts <replaceable>text</replaceable> in every row. An @-expression suppresses the -intercolumn space normally inserted between columns; any desired space -before the adjacent item must be included in <replaceable>text</replaceable>. +</listitem></varlistentry><varlistentry><term><literal>@{<replaceable>text or space</replaceable>}</literal> +</term><listitem><para>This inserts <replaceable>text or space</replaceable> at this location in every row. The +<replaceable>text or space</replaceable> material is typeset in LR mode. This text is +fragile (see <link linkend="_005cprotect">\protect</link>). </para> -<para>To insert commands that are automatically executed before a given -column, you have to load the <literal>array</literal> package and use the -<literal>>{...}</literal> specifier. -<!-- xx should fully explain array, tabularx, and all other base packages... --> +<para>This specifier is optional: unless you put in your own @-expression +then &latex;’s book, article, and report classes will put on either +side of each column a space of length <literal>\tabcolsep</literal>, which by +default is ‘<literal>6pt</literal>’. That is, by default adjacent columns are +separated by 12pt (so <literal>\tabcolsep</literal> is misleadingly-named since it +is not the separation between tabular columns). Also by default a space +of 6pt comes before the first column as well as after the final column, +unless you put a <literal>@{..}</literal> or <literal>|</literal> there. +</para> +<para>If you override the default and use an @-expression then you must +insert any desired space yourself, as in <literal>@{\hspace{1em}}</literal>. +</para> +<para>An empty expression <literal>@{}</literal> will eliminate the space, including +the space at the start or end, as in the example below where the tabular +lines need to lie on the left margin. +</para> +<screen>\begin{flushleft} + \begin{tabular}{@{}l} + .. + \end{tabular} +\end{flushleft} +</screen> +<para>This example shows text, a decimal point, between the columns, arranged +so the numbers in the table are aligned on that decimal point. </para> +<screen>\begin{tabular}{r@{$.$}l} + $3$ &$14$ \\ + $9$ &$80665$ +\end{tabular} +</screen> <indexterm role="fn"><primary>\extracolsep</primary></indexterm> -<para>An <literal>\extracolsep{wd}</literal> command in an @-expression causes an -extra space of width <literal>wd</literal> to appear to the left of all subsequent +<para>An <literal>\extracolsep{<replaceable>wd</replaceable>}</literal> command in an @-expression causes an +extra space of width <replaceable>wd</replaceable> to appear to the left of all subsequent columns, until countermanded by another <literal>\extracolsep</literal> command. -Unlike ordinary intercolumn space, this extra space is not suppressed -by an @-expression. An <literal>\extracolsep</literal> command can be used only -in an @-expression in the <literal>cols</literal> argument. +Unlike ordinary intercolumn space, this extra space is not suppressed by +an @-expression. An <literal>\extracolsep</literal> command can be used only in an +@-expression in the <literal>cols</literal> argument. Below, &latex; inserts the +right amount of intercolumn space to make the entire table 4 inches +wide. +</para> +<screen>\begin{center} + \begin{tabular*}{4in}{l@{\ \ldots\extracolsep{\fill}}l} + Seven times down, eight times up + &such is life! + \end{tabular*} +\end{center} +</screen> +<para>To insert commands that are automatically executed before a given +column, load the <literal>array</literal> package and use the <literal>>{...}</literal> +specifier. +<!-- xx should fully explain array, tabularx, and all other base packages... --> </para> </listitem></varlistentry><varlistentry><term><literal>p{<replaceable>wd</replaceable>}</literal> -</term><listitem><para>Produces a column with each item typeset in a parbox of width -<replaceable>wd</replaceable>, as if it were the argument of a -<literal>\parbox[t]{<replaceable>wd</replaceable>}</literal> command. However, a <literal>\\</literal> may not -appear in the item, except in the following situations: -</para> -<orderedlist numeration="arabic"><listitem><para>inside an environment like <literal>minipage</literal>, <literal>array</literal>, or <literal>tabular</literal>. -</para></listitem><listitem><para>inside an explicit <literal>\parbox</literal>. -</para></listitem><listitem><para>in the scope of a <literal>\centering</literal>, <literal>\raggedright</literal>, or <literal>\raggedleft</literal> -declaration. The latter declarations must appear inside braces or an -environment when used in a <literal>p</literal>-column element. -</para></listitem></orderedlist> +</term><listitem><para>Each item in the column is typeset in a parbox of width <replaceable>wd</replaceable>. +</para> +<para>Note that a line break double backslash <literal>\\</literal> may not appear in the +item, except inside an environment like <literal>minipage</literal>, <literal>array</literal>, +or <literal>tabular</literal>, or inside an explicit <literal>\parbox</literal>, or in the scope +of a <literal>\centering</literal>, <literal>\raggedright</literal>, or <literal>\raggedleft</literal> +declaration (when used in a <literal>p</literal>-column element these declarations +must appear inside braces, as with <literal>{\centering .. \\ +..}</literal>). Otherwise &latex; will misinterpret the double backslash as +ending the row. +</para> </listitem></varlistentry><varlistentry><term><literal>*{<replaceable>num</replaceable>}{<replaceable>cols</replaceable>}</literal> </term><listitem><para>Equivalent to <replaceable>num</replaceable> copies of <replaceable>cols</replaceable>, where <replaceable>num</replaceable> is a -positive integer and <replaceable>cols</replaceable> is any list of column-specifiers, -which may contain another <literal>*-expression</literal>. -</para> +positive integer and <replaceable>cols</replaceable> is a list of specifiers. Thus +<literal>\begin{tabular}{|*{3}{l|r}|}</literal> is equivalent to +<literal>\begin{tabular}{|l|rl|rl|r|}</literal>. Note that <replaceable>cols</replaceable> may +contain another <literal>*-expression</literal>. +</para> </listitem></varlistentry></variablelist></listitem></varlistentry></variablelist> <para>Parameters that control formatting: <!-- xx defaults, own node (xref from array)? --> </para> <variablelist><varlistentry><term><indexterm role="fn"><primary>\arrayrulewidth</primary></indexterm><literal>\arrayrulewidth</literal> -</term><listitem><para>Thickness of the rule created by <literal>|</literal>, <literal>\hline</literal>, and -<literal>\vline</literal> in the <literal>tabular</literal> and <literal>array</literal> environments; the -default is ‘<literal>.4pt</literal>’. +</term><listitem><para>A length that is the thickness of the rule created by <literal>|</literal>, +<literal>\hline</literal>, and <literal>\vline</literal> in the <literal>tabular</literal> and <literal>array</literal> +environments. The default is ‘<literal>.4pt</literal>’. Change it as in +<literal>\setlength{\arrayrulewidth}{0.8pt}</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\arraystretch</primary></indexterm><literal>\arraystretch</literal> -</term><listitem><para>Scaling of spacing between rows in the <literal>tabular</literal> and <literal>array</literal> -environments; default is ‘<literal>1</literal>’, for no scaling. +</term><listitem><para>A factor by which the spacing between rows in the <literal>tabular</literal> and +<literal>array</literal> environments is multiplied. The default is ‘<literal>1</literal>’, for +no scaling. Change it as <literal>\renewcommand{\arraystretch}{1.2}</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\doublerulesep</primary></indexterm><literal>\doublerulesep</literal> -</term><listitem><para>Horizontal distance between the vertical rules produced by <literal>||</literal> -in the <literal>tabular</literal> and <literal>array</literal> environments; default is ‘<literal>2pt</literal>’. +</term><listitem><para>A length that is the distance between the vertical rules produced by the +<literal>||</literal> specifier. The default is ‘<literal>2pt</literal>’. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tabcolsep</primary></indexterm><literal>\tabcolsep</literal> -</term><listitem><para>Half the width of the space between columns; default is ‘<literal>6pt</literal>’. +</term><listitem><para>A length that is half of the space between columns. The default is +‘<literal>6pt</literal>’. Change it with <literal>\setlength</literal>. </para> </listitem></varlistentry></variablelist> -<para>The following commands can be used inside a <literal>tabular</literal> -environment: +<para>The following commands can be used inside the body of a <literal>tabular</literal> +environment, the first two inside an entry and the second two between +lines: </para> -<sect2 label="8.24.1" id="_005cmulticolumn"> +<sect2 label="8.23.1" id="_005cmulticolumn"> <title><literal>\multicolumn</literal></title> + <indexterm role="fn"><primary>\multicolumn</primary></indexterm> <para>Synopsis: -</para><screen>\multicolumn{<replaceable>cols</replaceable>}{<replaceable>pos</replaceable>}{<replaceable>text</replaceable>} -</screen> -<para>The <literal>\multicolumn</literal> command makes an entry that spans several -columns. The first mandatory argument, <replaceable>cols</replaceable>, specifies the -number of columns to span. The second mandatory argument, <replaceable>pos</replaceable>, -specifies the formatting of the entry; <literal>c</literal> for centered, <literal>l</literal> -for flushleft, <literal>r</literal> for flushright. The third mandatory argument, -<replaceable>text</replaceable>, specifies what text to put in the entry. -</para> -<para>Here’s an example showing two columns separated by an en-dash; -<literal>\multicolumn</literal> is used for the heading: -</para> -<screen>\begin{tabular}{r@{--}l} -\multicolumn{2}{c}{\bf Unicode}\cr - 0x80&0x7FF \cr - 0x800&0xFFFF \cr -0x10000&0x1FFFF \cr +</para> +<screen>\multicolumn{<replaceable>numcols</replaceable>}{<replaceable>cols</replaceable>}{<replaceable>text</replaceable>} +</screen> +<para>Make an <literal>array</literal> or <literal>tabular</literal> entry that spans several columns. +The first argument <replaceable>numcols</replaceable> gives the number of columns to span. +The second argument <replaceable>cols</replaceable> specifies the formatting of the entry, +with <literal>c</literal> for centered, <literal>l</literal> for flush left, or <literal>r</literal> for +flush right. The third argument <replaceable>text</replaceable> gives the contents of that +entry. +</para> +<para>In this example, in the first row, the second and third columns are +spanned by the single heading ‘<literal>Name</literal>’. +</para> +<screen>\begin{tabular}{lccl} + \textit{ID} &\multicolumn{2}{c}{\textit{Name}} &\textit{Age} \\ \hline % row one + 978-0-393-03701-2 &O'Brian &Patrick &55 \\ % row two + .. +\end{tabular} +</screen> +<para>What counts as a column is: the column format specifier for the +<literal>array</literal> or <literal>tabular</literal> environment is broken into parts, where +each part (except the first) begins with <literal>l</literal>, <literal>c</literal>, <literal>r</literal>, +or <literal>p</literal>. So from <literal>\begin{tabular}{|r|ccp{1.5in}|}</literal> +the parts are <literal>|r|</literal>, <literal>c</literal>, <literal>c</literal>, +and <literal>p{1.5in}|</literal>. +</para> +<para>The <replaceable>cols</replaceable> argument overrides the <literal>array</literal> or <literal>tabular</literal> +environment’s intercolumn area default adjoining this multicolumn +entry. To affect that area, this argument can contain vertical bars +<literal>|</literal> indicating the placement of vertical rules, and <literal>@{..}</literal> +expressions. Thus if <replaceable>cols</replaceable> is ‘<literal>|c|</literal>’ then this multicolumn +entry will be centered and a vertical rule will come in the intercolumn +area before it and after it. This table details the exact behavior. +</para> +<screen>\begin{tabular}{|cc|c|c|} + \multicolumn{1}{r}{w} % entry one + &\multicolumn{1}{|r|}{x} % entry two + &\multicolumn{1}{|r}{y} % entry three + &z % entry four +\end{tabular} +</screen><para>Before the first entry the output will not have a vertical rule because +the <literal>\multicolumn</literal> has the <replaceable>cols</replaceable> specifier ‘<literal>r</literal>’ with no +initial vertical bar. Between entry one and entry two there will be a +vertical rule; although the first <replaceable>cols</replaceable> does not have an ending +vertical bar, the second <replaceable>cols</replaceable> does have a starting one. Between +entry two and entry three there is a single vertical rule; despite that +the <replaceable>cols</replaceable> in both of the surrounding <literal>multicolumn</literal>’s call for +a vertical rule, you only get one rule. Between entry three and entry +four there is no vertical rule; the default calls for one but the +<replaceable>cols</replaceable> in the entry three <literal>\multicolumn</literal> leaves it out, and +that takes precedence. Finally, following entry four there is a +vertical rule because of the default. +</para> +<para>The number of spanned columns <replaceable>numcols</replaceable> can be 1. Besides giving +the ability to change the horizontal alignment, this also is useful to +override for one row the <literal>tabular</literal> definition’s default intercolumn +area specification, including the placement of vertical rules. +</para> +<para>In the example below, in the <literal>tabular</literal> definition the first column +is specified to default to left justified but in the first row the entry +is centered with <literal>\multicolumn{1}{c}{\textsc{Period}}</literal>. +Also in the first row, the second and third columns are spanned by a +single entry with <literal>\multicolumn{2}{c}{\textsc{Span}}</literal>, +overriding the specification to center those two columns on the page +range en-dash. +</para> +<screen>\begin{tabular}{l|r@{--}l} + \multicolumn{1}{c}{\textsc{Period}} + &multicolumn{2}{c}{\textsc{Span}} \\ \hline + Baroque &1600 &1760 \\ + Classical &1730 &1820 \\ + Romantic &1780 &1910 \\ + Impressionistic &1875 &1925 +\end{tabular} +</screen> +<para>Note that although the <literal>tabular</literal> specification by default puts a +vertical rule between the first and second columns, because there is no +vertical bar in the <replaceable>cols</replaceable> of either of the first row’s +<literal>\multicolumn</literal> commands, no rule appears in the first row. +</para> + +</sect2> +<sect2 label="8.23.2" id="_005cvline"> +<title><literal>\vline</literal></title> + +<indexterm role="fn"><primary>\vline</primary></indexterm> + +<para>Draw a vertical line in a <literal>tabular</literal> or <literal>array</literal> environment +extending the full height and depth of an entry’s row. Can also be used +in an @-expression, although its synonym vertical bar <literal>|</literal> is +more common. This command is rarely used; typically a table’s vertical +lines are specified in <literal>tabular</literal>’s <replaceable>cols</replaceable> argument and +overriden as needed with <literal>\multicolumn</literal>. +</para> +<para>This example illustrates some pitfalls. In the first line’s second +entry the <literal>\hfill</literal> moves the <literal>\vline</literal> to the left edge of the +cell. But that is different than putting it halfway between the two +columns, so in that row between the first and second columns there are +two vertical rules, with the one from the <literal>{c|cc}</literal> specifier +coming before the one produced by the <literal>\vline\hfill</literal>. In contrast, +the first line’s third entry shows the usual way to put a vertical bar +between two columns. In the second line, the <literal>ghi</literal> is the widest +entry in its column so in the <literal>\vline\hfill</literal> the <literal>\hfill</literal> has +no effect and the vertical line in that entry appears immediately next +to the <literal>g</literal>, with no whitespace. +</para> +<screen>\begin{tabular}{c|cc} + x &\vline\hfill y &\multicolumn{1}{|r}{z} \\ + abc &def &\vline\hfill ghi \end{tabular} </screen> </sect2> -<sect2 label="8.24.2" id="_005ccline"> +<sect2 label="8.23.3" id="_005ccline"> <title><literal>\cline</literal></title> + <indexterm role="fn"><primary>\cline</primary></indexterm> <para>Synopsis: </para> <screen>\cline{<replaceable>i</replaceable>-<replaceable>j</replaceable>} </screen> -<para>The <literal>\cline</literal> command draws horizontal lines across the columns -specified, beginning in column <replaceable>i</replaceable> and ending in column <replaceable>j</replaceable>, -which are specified in the mandatory argument. -</para> +<para>Draw a horizontal rule in an <literal>array</literal> or <literal>tabular</literal> environment +beginning in column <replaceable>i</replaceable> and ending in column <replaceable>j</replaceable>. The +dash <literal>-</literal> must appear in the mandatory argument. To span a +single column use the number twice. +</para> +<para>This example puts two horizontal lines between the first and second +rows, one line in the first column only, and the other spanning the +third and fourth columns. The two lines are side-by-side, at the same +height. +</para> +<screen>\begin{tabular}{llrr} + a &b &c &d \\ \cline{1-1} \cline{3-4} + e &f &g &h +\end{tabular} +</screen> </sect2> -<sect2 label="8.24.3" id="_005chline"> +<sect2 label="8.23.4" id="_005chline"> <title><literal>\hline</literal></title> + <indexterm role="fn"><primary>\hline</primary></indexterm> -<para>The <literal>\hline</literal> command draws a horizontal line the width of the -enclosing <literal>tabular</literal> or <literal>array</literal> environment. It’s most -commonly used to draw a line at the top, bottom, and between the rows -of a table. +<para>Draws a horizontal line the width of the enclosing <literal>tabular</literal> or +<literal>array</literal> environment. It’s most commonly used to draw a line at the +top, bottom, and between the rows of a table. </para> - -</sect2> -<sect2 label="8.24.4" id="_005cvline"> -<title><literal>\vline</literal></title> -<indexterm role="fn"><primary>\vline</primary></indexterm> - -<para>The <literal>\vline</literal> command will draw a vertical line extending the full -height and depth of its row. An <literal>\hfill</literal> command can be used to -move the line to the edge of the column. It can also be used in an -@-expression. +<para>In this example the top of the table has two horizontal rules, one above +the other, that span both columns. The bottom of the table has a single +rule spanning both columns. Because of the <literal>\hline</literal>, the +<literal>tabular</literal> second row’s line ending double backslash <literal>\\</literal> +is required. </para> +<screen>\begin{tabular}{ll} \hline\hline + Baseball &Red Sox \\ + Basketball &Celtics \\ \hline +\end{tabular} +</screen> </sect2> </sect1> -<sect1 label="8.25" id="thebibliography"> +<sect1 label="8.24" id="thebibliography"> <title><literal>thebibliography</literal></title> -<indexterm role="fn"><primary>thebibliography</primary></indexterm> +<indexterm role="fn"><primary>thebibliography environment</primary></indexterm> <indexterm role="cp"><primary>bibliography, creating (manually)</primary></indexterm> <para>Synopsis: @@ -2788,13 +3691,14 @@ less than 10 references, <literal>99</literal> for ones with less than 100, etc. </para> -<sect2 label="8.25.1" id="_005cbibitem"> +<sect2 label="8.24.1" id="_005cbibitem"> <title><literal>\bibitem</literal></title> <indexterm role="fn"><primary>\bibitem</primary></indexterm> <para>Synopsis: -</para><screen>\bibitem[<replaceable>label</replaceable>]{<replaceable>cite_key</replaceable>} +</para> +<screen>\bibitem[<replaceable>label</replaceable>]{<replaceable>cite_key</replaceable>} </screen> <para>The <literal>\bibitem</literal> command generates an entry labelled by <replaceable>label</replaceable>. If the <replaceable>label</replaceable> argument is missing, a number is @@ -2811,14 +3715,14 @@ associated label. </para> </sect2> -<sect2 label="8.25.2" id="_005ccite"> +<sect2 label="8.24.2" id="_005ccite"> <title><literal>\cite</literal></title> <indexterm role="fn"><primary>\cite</primary></indexterm> <para>Synopsis: </para> -<screen>\cite[<replaceable>subcite</replaceable>]{<replaceable>keys</replaceable> +<screen>\cite[<replaceable>subcite</replaceable>]{<replaceable>keys</replaceable>} </screen> <para>The <replaceable>keys</replaceable> argument is a list of one or more citation keys, separated by commas. This command generates an in-text citation to @@ -2831,18 +3735,19 @@ citation. For example, <literal>\cite[p.~314]{knuth}</literal> might produce </para> </sect2> -<sect2 label="8.25.3" id="_005cnocite"> +<sect2 label="8.24.3" id="_005cnocite"> <title><literal>\nocite</literal></title> + <indexterm role="fn"><primary>\nocite</primary></indexterm> -<para><literal>\nocite{key_list}</literal> +<para><literal>\nocite{<replaceable>keys</replaceable>}</literal> </para> -<para>The <literal>\nocite</literal> command produces no text, but writes <literal>key_list</literal>, -which is a list of one or more citation keys, on the <filename>.aux</filename> file. +<para>The <literal>\nocite</literal> command produces no text, but writes <replaceable>keys</replaceable>, +which is a list of one or more citation keys, to the <filename>.aux</filename> file. </para> </sect2> -<sect2 label="8.25.4" id="Using-BibTeX"> +<sect2 label="8.24.4" id="Using-BibTeX"> <title>Using Bib&tex;</title> <indexterm role="cp"><primary>using Bib&tex;</primary></indexterm> @@ -2889,7 +3794,7 @@ Bib&tex; format. Only the entries referred to via <literal>\cite</literal> and </sect2> </sect1> -<sect1 label="8.26" id="theorem"> +<sect1 label="8.25" id="theorem"> <title><literal>theorem</literal></title> <indexterm role="fn"><primary>theorem environment</primary></indexterm> @@ -2908,7 +3813,7 @@ possibilities for <replaceable>n</replaceable> are described under <literal>\new </para> </sect1> -<sect1 label="8.27" id="titlepage"> +<sect1 label="8.26" id="titlepage"> <title><literal>titlepage</literal></title> <indexterm role="fn"><primary>titlepage environment</primary></indexterm> @@ -2932,7 +3837,7 @@ produce a standard title page without a <literal>titlepage</literal> environment </para> </sect1> -<sect1 label="8.28" id="verbatim"> +<sect1 label="8.27" id="verbatim"> <title><literal>verbatim</literal></title> <indexterm role="fn"><primary>verbatim environment</primary></indexterm> @@ -2957,7 +3862,7 @@ effect that they would on a typewriter. <para>The <literal>verbatim</literal> uses a monospaced typewriter-like font (<literal>\tt</literal>). </para> -<sect2 label="8.28.1" id="_005cverb"> +<sect2 label="8.27.1" id="_005cverb"> <title><literal>\verb</literal></title> <indexterm role="fn"><primary>\verb</primary></indexterm> @@ -2981,7 +3886,7 @@ verbatim text. The delimiter must not appear in <replaceable>literal-text</repl </sect2> </sect1> -<sect1 label="8.29" id="verse"> +<sect1 label="8.28" id="verse"> <title><literal>verse</literal></title> <indexterm role="fn"><primary>verse environment</primary></indexterm> @@ -3009,6 +3914,7 @@ stanzas. </chapter> <chapter label="9" id="Line-breaking"> <title>Line breaking</title> + <indexterm role="cp"><primary>line breaking</primary></indexterm> <indexterm role="cp"><primary>breaking lines</primary></indexterm> @@ -3017,30 +3923,52 @@ translate your input file into a sequence of glyphs and spaces. To produce a printed document, this sequence must be broken into lines (and these lines must be broken into pages). </para> -<para>&latex; usually does the line (and page) breaking for you, but in -some environments, you do the line breaking yourself with the -<literal>\\</literal> command, and you can always manually force breaks. +<para>&latex; usually does the line (and page) breaking in the text body for +you but in some environments you manually force line breaks. </para> <sect1 label="9.1" id="_005c_005c"> -<title><literal>\\</literal>[*][<replaceable>morespace</replaceable>]</title> +<title><literal>\\</literal></title> + <indexterm role="fn"><primary>\\ force line break</primary></indexterm> <indexterm role="cp"><primary>new line, starting</primary></indexterm> <indexterm role="cp"><primary>line break, forcing</primary></indexterm> -<para>The <literal>\\</literal> command tells &latex; to start a new line. It has an -optional argument, <replaceable>morespace</replaceable>, that specifies how much extra -vertical space is to be inserted before the next line. This can be a -negative amount. +<para>Synopsis: </para> -<para>The <literal>\\*</literal> command is the same as the ordinary <literal>\\</literal> command -except that it tells &latex; not to start a new page after the line. +<screen>\\[<replaceable>morespace</replaceable>] +</screen> +<para>or </para> +<screen>\\*[<replaceable>morespace</replaceable>] +</screen> +<para>Start a new line. The optional argument <replaceable>morespace</replaceable> specifies extra +vertical space to be insert before the next line. This can be a +negative length. The text before the break is set at its normal length, +that is, it is not stretched to fill out the line width. +</para> +<para>Explicit line breaks in the text body are unusual in &latex;. In +particular, to start a new paragraph instead leave a blank line. This +command is mostly used outside of the main flow of text such as in +a <literal>tabular</literal> or <literal>array</literal> environment. +</para> +<para>Under ordinary circumstances (e.g., outside of a <literal>p{..}</literal> column +in a <literal>tabular</literal> environment) the <literal>\newline</literal> command is a synonym for +<literal>\\</literal> (see <link linkend="_005cnewline">\newline</link>). +</para> +<para>In addition to starting a new line, the starred form <literal>\\*</literal> tells +&latex; not to start a new page between the two lines, by issuing a +<literal>\nobreak</literal>. +</para> +<screen>\title{My story: \\[0.25in] + a tale of woe} +</screen> </sect1> <sect1 label="9.2" id="_005cobeycr-_0026-_005crestorecr"> <title><literal>\obeycr</literal> & <literal>\restorecr</literal></title> + <indexterm role="fn"><primary>\obeycr</primary></indexterm> <indexterm role="fn"><primary>\restorecr</primary></indexterm> <indexterm role="cp"><primary>new line, output as input</primary></indexterm> @@ -3056,17 +3984,33 @@ in the output. </sect1> <sect1 label="9.3" id="_005cnewline"> <title><literal>\newline</literal></title> + <indexterm role="fn"><primary>\newline</primary></indexterm> <indexterm role="cp"><primary>new line, starting (paragraph mode)</primary></indexterm> -<para>The <literal>\newline</literal> command breaks the line at the present point, with -no stretching of the text before it. It can only be used in paragraph -mode. +<para>In ordinary text this is equivalent to double-backslash (see <link linkend="_005c_005c">\\</link>); it +breaks a line, with no stretching of the text before it. +</para> +<para>Inside a <literal>tabular</literal> or <literal>array</literal> environment, in a column with a +specifier producing a paragraph box, like typically <literal>p{..}</literal>, +<literal>\newline</literal> will insert a line break inside of the column, that is, +it does not break the entire row. To break the entire row use <literal>\\</literal> +or its equivalent <literal>\tabularnewline</literal>. +</para> +<para>This will print ‘<literal>Name:</literal>’ and ‘<literal>Address:</literal>’ as two lines in a +single cell of the table. +</para> +<screen>\begin{tabular}{p{1in}{\hspace{2in}}p{1in}} + Name: \newline Address: &Date: \\ \hline +\end{tabular} +</screen> +<para>The ‘<literal>Date:</literal>’ will be baseline-aligned with ‘<literal>Name:</literal>’. </para> </sect1> <sect1 label="9.4" id="_005c_002d-_0028hyphenation_0029"> <title><literal>\-</literal> (discretionary hyphen)</title> + <indexterm role="fn"><primary>\- (hyphenation)</primary></indexterm> <indexterm role="cp"><primary>hyphenation, forcing</primary></indexterm> @@ -3081,10 +4025,10 @@ hyphenated at those points and not at any of the hyphenation points that &latex; might otherwise have chosen. </para> - </sect1> <sect1 label="9.5" id="_005cfussy"> <title><literal>\fussy</literal></title> + <indexterm role="fn"><primary>\fussy</primary></indexterm> <para>The declaration <literal>\fussy</literal> (which is the default) makes &tex; @@ -3099,6 +4043,8 @@ words, at the cost of an occasional overfull box. <sect1 label="9.6" id="_005csloppy"> <title><literal>\sloppy</literal></title> +<indexterm role="fn"><primary>\sloppy</primary></indexterm> + <para>The declaration <literal>\sloppy</literal> makes &tex; less fussy about line breaking. This will avoid overfull boxes, at the cost of loose interword spacing. @@ -3109,6 +4055,7 @@ interword spacing. </sect1> <sect1 label="9.7" id="_005chyphenation"> <title><literal>\hyphenation</literal></title> + <indexterm role="fn"><primary>\hyphenation</primary></indexterm> <indexterm role="cp"><primary>hyphenation, defining</primary></indexterm> @@ -3129,6 +4076,7 @@ misses the hyphenations in these words): </sect1> <sect1 label="9.8" id="_005clinebreak-_0026-_005cnolinebreak"> <title><literal>\linebreak</literal> & <literal>\nolinebreak</literal></title> + <indexterm role="fn"><primary>\linebreak</primary></indexterm> <indexterm role="fn"><primary>\nolinebreak</primary></indexterm> <indexterm role="cp"><primary>line breaks, forcing</primary></indexterm> @@ -3153,6 +4101,7 @@ from a demand to a request. The <replaceable>priority</replaceable> must be a n </chapter> <chapter label="10" id="Page-breaking"> <title>Page breaking</title> + <indexterm role="cp"><primary>page breaking</primary></indexterm> <indexterm role="cp"><primary>breaking pages</primary></indexterm> @@ -3169,36 +4118,41 @@ but sometimes you may want to influence the breaks. <indexterm role="cp"><primary>starting on a right-hand page</primary></indexterm> <para>The <literal>\cleardoublepage</literal> command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. -In a two-sided printing style, it also makes the next page a right-hand -(odd-numbered) page, producing a blank page if necessary. +the pending floating figures and tables that have so far appeared in the +input to be printed. In a two-sided printing style, it also makes the +next page a right-hand (odd-numbered) page, producing a blank page if +necessary. </para> </sect1> <sect1 label="10.2" id="_005cclearpage"> <title><literal>\clearpage</literal></title> + <indexterm role="fn"><primary>\clearpage</primary></indexterm> <indexterm role="cp"><primary>flushing floats and starting a page</primary></indexterm> <indexterm role="cp"><primary>starting a new page and clearing floats</primary></indexterm> -<para>The <literal>\clearpage</literal> command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. +<para>The <literal>\clearpage</literal> command ends the current page and causes all the +pending floating figures and tables that have so far appeared in the +input to be printed. </para> </sect1> <sect1 label="10.3" id="_005cnewpage"> <title><literal>\newpage</literal></title> + <indexterm role="fn"><primary>\newpage</primary></indexterm> <indexterm role="cp"><primary>new page, starting</primary></indexterm> <indexterm role="cp"><primary>starting a new page</primary></indexterm> <para>The <literal>\newpage</literal> command ends the current page, but does not clear -floats (see <literal>\clearpage</literal> above). +floats (see <link linkend="_005cclearpage">\clearpage</link>). </para> </sect1> <sect1 label="10.4" id="_005cenlargethispage"> <title><literal>\enlargethispage</literal></title> + <indexterm role="fn"><primary>\enlargethispage</primary></indexterm> <indexterm role="cp"><primary>enlarge current page</primary></indexterm> @@ -3207,7 +4161,7 @@ floats (see <literal>\clearpage</literal> above). <para><literal>\enlargethispage*{size}</literal> </para> <para>Enlarge the <literal>\textheight</literal> for the current page by the specified -amount; e.g. <literal>\enlargethispage{\baselineskip}</literal> will allow one +amount; e.g., <literal>\enlargethispage{\baselineskip}</literal> will allow one additional line. </para> <para>The starred form tries to squeeze the material together on the page as @@ -3218,6 +4172,7 @@ much as possible. This is normally used together with an explicit </sect1> <sect1 label="10.5" id="_005cpagebreak-_0026-_005cnopagebreak"> <title><literal>\pagebreak</literal> & <literal>\nopagebreak</literal></title> + <indexterm role="fn"><primary>\pagebreak</primary></indexterm> <indexterm role="fn"><primary>\nopagebreak</primary></indexterm> <indexterm role="cp"><primary>page break, forcing</primary></indexterm> @@ -3243,88 +4198,246 @@ insistent the request is. </chapter> <chapter label="11" id="Footnotes"> <title>Footnotes</title> + <indexterm role="cp"><primary>footnotes, creating</primary></indexterm> -<para>Footnotes can be produced in one of two ways. They can be produced -with one command, the <literal>\footnote</literal> command. They can also be -produced with two commands, the <literal>\footnotemark</literal> and the -<literal>\footnotetext</literal> commands. +<para>Place a numbered footnote at the bottom of the current page, as here. +</para> +<screen>Noël Coward quipped that having to read a footnote is like having +to go downstairs to answer the door, while in the midst of making +love.\footnote{I wouldn't know, I don't read footnotes.} +</screen> +<para>You can place multiple footnotes on a page. If the text becomes too long +it will flow to the next page. +</para> +<para>You can also produce footnotes by combining the <literal>\footnotemark</literal> and +the <literal>\footnotetext</literal> commands, which is useful in special +circumstances. +</para> +<para>To make bibliographic references come out as footnotes you need to +include a bibliographic style with that behavior. </para> <sect1 label="11.1" id="_005cfootnote"> <title><literal>\footnote</literal></title> + <indexterm role="fn"><primary>\footnote</primary></indexterm> <para>Synopsis: </para> <screen>\footnote[<replaceable>number</replaceable>]{<replaceable>text</replaceable>} </screen> -<para>The <literal>\footnote</literal> command places the numbered footnote <replaceable>text</replaceable> -at the bottom of the current page. The optional argument <replaceable>number</replaceable> -changes the default footnote number. +<para>Place a numbered footnote <replaceable>text</replaceable> at the bottom of the current page. +</para> +<screen>There are over a thousand footnotes in Gibbon's +\textit{Decline and Fall of the Roman Empire}.\footnote{After +reading an early version with endnotes David Hume complained, +``One is also plagued with his Notes, according to the present Method +of printing the Book'' and suggested that they ``only to be printed +at the Margin or the Bottom of the Page.''} +</screen> +<para>The optional argument <replaceable>number</replaceable> allows you to specify the footnote +number. If you use this option then the footnote number counter is not +incremented, and if you do not use it then the counter is incremented. </para> -<para>This command can only be used in outer paragraph mode; i.e., you -cannot use it in sectioning commands like <literal>\chapter</literal>, in figures, -tables or in a <literal>tabular</literal> environment. (See following sections.) +<indexterm role="cp"><primary>footnotes, symbols instead of numbers</primary></indexterm> +<indexterm role="fn"><primary>\fnsymbol, and footnotes</primary></indexterm> +<indexterm role="fn"><primary>\@fnsymbol</primary></indexterm> +<para>Change how &latex; shows the footnote counter with something like +<literal>\renewcommand{\thefootnote}{\fnsymbol{footnote}}</literal>, which +uses a sequence of symbols (see <link linkend="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman +\fnsymbol</link>). To make this change global put that in the preamble. If +you make the change local then you may want to reset the counter with +<literal>\setcounter{footnote}{0}</literal>. By default &latex; uses arabic +numbers. +</para> +<para>&latex;’s default puts many restrictions on where you can use a +<literal>\footnote</literal>; for instance, you cannot use it in an argument to a +sectioning command such as <literal>\chapter</literal> (it can only be used in outer +paragraph mode). There are some workarounds; see following sections. <!-- xx mention packages that fix this --> </para> +<indexterm role="cp"><primary>Footnotes, in a minipage</primary></indexterm> +<indexterm role="cp"><primary>mpfootnote counter</primary></indexterm> +<para>In a <literal>minipage</literal> environment the <literal>\footnote</literal> +command uses the <literal>mpfootnote</literal> counter instead of the +<literal>footnote</literal> counter, so they are numbered independently. They are +shown at the bottom of the environment, not at the bottom of the page. +And by default they are shown alphabetically. See <link linkend="minipage">minipage</link>. +</para> </sect1> <sect1 label="11.2" id="_005cfootnotemark"> <title><literal>\footnotemark</literal></title> + <indexterm role="fn"><primary>\footnotemark</primary></indexterm> -<para>With no optional argument, the <literal>\footnotemark</literal> command puts the -current footnote number in the text. This command can be used in -inner paragraph mode. You give the text of the footnote separately, -with the <literal>\footnotetext</literal> command. +<para>Synopsis, one of: </para> -<para>This command can be used to produce several consecutive footnote -markers referring to the same footnote with -</para> -<screen>\footnotemark[\value{footnote}] +<screen>\footnotemark +\footnotemark[<replaceable>number</replaceable>] +</screen> +<para>Put the current footnote number in the +text. (See <link linkend="_005cfootnotetext">\footnotetext</link> for giving the text of the footnote +separately.) The version with the optional argument <replaceable>number</replaceable> uses +that number to determine the mark printed. This command can be used in +inner paragraph mode. +</para> +<para>This example gives the same institutional affiliation to both the first +and third authors (<literal>\thanks</literal> is a version of <literal>footnote</literal>). +</para> +<screen>\title{A Treatise on the Binomial Theorem} +\author{J Moriarty\thanks{University of Leeds} + \and A C Doyle\thanks{Durham University} + \and S Holmes\footnotemark[1]} +\begin{document} +\maketitle +</screen> +<para>If you use <literal>\footnotemark</literal> without the optional argument then it +increments the footnote counter but if you use the optional <replaceable>number</replaceable> +then it does not. This produces several consecutive footnote markers +referring to the same footnote. +</para> +<screen>The first theorem\footnote{Due to Gauss.} +and the second theorem\footnotemark[\value{footnote}] +and the third theorem.\footnotemark[\value{footnote}] </screen> -<para>after the first <literal>\footnote</literal> command. -</para> </sect1> <sect1 label="11.3" id="_005cfootnotetext"> <title><literal>\footnotetext</literal></title> + <indexterm role="fn"><primary>\footnotetext</primary></indexterm> -<para>Synopsis: +<para>Synopsis, one of: </para> -<screen>\footnotetext[<replaceable>number</replaceable>]{<replaceable>text</replaceable>} +<screen>\footnotetext{<replaceable>text</replaceable>} +\footnotetext[<replaceable>number</replaceable>]{<replaceable>text</replaceable>} </screen> -<para>The <literal>\footnotetext</literal> command places <replaceable>text</replaceable> at the bottom of -the page as a footnote. This command can come anywhere after the -<literal>\footnotemark</literal> command. The <literal>\footnotetext</literal> command must -appear in outer paragraph mode. +<para>Place <replaceable>text</replaceable> at the bottom of the page as a footnote. This command +can come anywhere after the <literal>\footnotemark</literal> command. The optional +argument <replaceable>number</replaceable> changes the displayed footnote number. The +<literal>\footnotetext</literal> command must appear in outer paragraph mode. </para> -<para>The optional argument <replaceable>number</replaceable> changes the default footnote number. + +</sect1> +<sect1 label="11.4" id="Footnotes-in-a-table"> +<title>Footnotes in a table</title> + +<indexterm role="cp"><primary>Footnotes, in a table</primary></indexterm> + +<para>Inside a <literal>table</literal> environment the <literal>\footnote</literal> command does not +work. For instance, if the code below appears on its own then the +footnote simply disappears; there is a footnote mark in the table cell +but nothing is set at the bottom of the page. </para> +<screen>\begin{center} + \begin{tabular}{l|l} + \textsc{Ship} &\textsc{Book} \\ \hline + \textit{HMS Sophie} &Master and Commander \\ + \textit{HMS Polychrest} &Post Captain \\ + \textit{HMS Lively} &Post Captain \\ + \textit{HMS Surprise} &A number of books\footnote{Starting with HMS Surprise.} + \end{tabular} +\end{center} +</screen> +<para>The solution is to surround the <literal>tabular</literal> environment with a +<literal>minipage</literal> environment, as here (see <link linkend="minipage">minipage</link>). +</para> +<screen>\begin{center} + \begin{minipage}{.5\textwidth} + .. tabular material .. + \end{minipage} +\end{center} +</screen> +<para>The same technique will work inside a floating <literal>table</literal> environment +(see <link linkend="table">table</link>). To get the footnote at the bottom of the page use the +<filename>tablefootnote</filename> package, as illustrated in this example. If you +put <literal>\usepackage{tablefootnote}</literal> in the preamble and use the code +shown then the footnote appears at the bottom and is numbered in +sequence with other footnotes. +</para> +<screen>\begin{table} + \centering + \begin{tabular}{l|l} + \textsc{Date} &\textsc{Campaign} \\ \hline + 1862 &Fort Donelson \\ + 1863 &Vicksburg \\ + 1865 &Army of Northern Virginia\footnote{Ending the war.} + \end{tabular} + \caption{Forces captured by US Grant} +\end{table} +</screen> </sect1> -<sect1 label="11.4" id="Symbolic-footnotes"> -<title>Symbolic footnotes</title> +<sect1 label="11.5" id="Footnotes-in-section-headings"> +<title>Footnotes in section headings</title> -<indexterm role="cp"><primary>footnotes, symbolic instead of numbered</primary></indexterm> -<para>If you want to use symbols for footnotes, rather than increasing -numbers, redefine <literal>\thefootnote</literal> like this: +<para>Putting a footnote in a section heading </para> -<screen>\renewcommand{\thefootnote}{\fnsymbol{footnote}} +<screen>\section{Full sets\protect\footnote{This material is due to R~Jones.}} </screen> -<indexterm role="fn"><primary>\fnsymbol, and footnotes</primary></indexterm> -<indexterm role="fn"><primary>\@fnsymbol</primary></indexterm> -<para>The <literal>\fnsymbol</literal> command produces a predefined series of symbols -(see <link linkend="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</link>). If you want to -use a different symbol as your footnote mark, you’ll need to also -redefine <literal>\@fnsymbol</literal>. +<para>causes the footnote to appear both at the bottom of the page where the +section starts and at the bottom of the table of contents page. To have +it not appear on the table of contents use the package <filename>footmisc</filename> +with the <literal>stable</literal> option. +</para> +<screen>\usepackage[stable]{footmisc} + .. +\begin{document} + .. +\section{Full sets\footnote{This material is due to R~Jones.}} +</screen> +<para>Note that the <literal>\protect</literal> is gone; putting it in causes the +footnote to reappear on the table of contents. </para> </sect1> -<sect1 label="11.5" id="Footnote-parameters"> +<sect1 label="11.6" id="Footnotes-of-footnotes"> +<title>Footnotes of footnotes</title> + +<para>Particularly in the humanities, authors can have multiple classes of +footnotes, including having footnotes of footnotes. The package +<filename>bigfoot</filename> extends &latex;’s default footnote mechanism in many +ways, including allow these two, as in this example. +</para> +<screen>\usepackage{bigfoot} +\DeclareNewFootnote{Default} +\DeclareNewFootnote{from}[alph] % create class \footnotefrom{} + .. +\begin{document} + .. +The third theorem is a partial converse of the +second.\footnotefrom{First noted in Wilson.\footnote{Second edition only.}} + .. +</screen> + +</sect1> +<sect1 label="11.7" id="Multiple-reference-to-footnotes"> +<title>Multiple references to footnotes</title> + +<para>You can refer to a single footnote more than once. This example +uses the package <filename>cleverref</filename>. +</para> +<!-- from SE user Jake http://tex.stackexchange.com/a/10116/339 --> +<screen>\usepackage{cleveref}[2012/02/15] % this version of package or later +\crefformat{footnote}{#2\footnotemark[#1]#3} + .. +\begin{document} + .. +The theorem is from Evers.\footnote{\label{fn:TE}Tinker and Evers, 1994.} +The corollary is from Chance.\footnote{Evers and Chance, 1990.} +But the key lemma is from Tinker.\cref{fn:TE} + .. +</screen> +<para>This solution will work with the package <filename>hyperref</filename>. +See <link linkend="_005cfootnotemark">\footnotemark</link> for a simpler solution in the common case +of multiple authors with the same affiliation. +</para> + +</sect1> +<sect1 label="11.8" id="Footnote-parameters"> <title>Footnote parameters</title> <indexterm role="cp"><primary>footnote parameters</primary></indexterm> @@ -3349,6 +4462,7 @@ footnotes. This is ‘<literal>6.65pt</literal>’ for ‘<literal> </chapter> <chapter label="12" id="Definitions"> <title>Definitions</title> + <indexterm role="cp"><primary>definitions</primary></indexterm> <para>&latex; has support for making new commands of many different kinds. @@ -3359,40 +4473,55 @@ footnotes. This is ‘<literal>6.65pt</literal>’ for ‘<literal> <sect1 label="12.1" id="_005cnewcommand-_0026-_005crenewcommand"> <title><literal>\newcommand</literal> & <literal>\renewcommand</literal></title> + <indexterm role="fn"><primary>\newcommand</primary></indexterm> <indexterm role="cp"><primary>commands, defining new ones</primary></indexterm> +<indexterm role="cp"><primary>commands, redefining</primary></indexterm> <indexterm role="cp"><primary>defining a new command</primary></indexterm> <indexterm role="cp"><primary>new commands, defining</primary></indexterm> <para><literal>\newcommand</literal> and <literal>\renewcommand</literal> define and redefine a command, respectively. Synopses: </para> -<screen> \newcommand[*]{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargval</replaceable>]{<replaceable>defn</replaceable>} -\renewcommand[*]{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargval</replaceable>]{<replaceable>defn</replaceable>} +<screen> \newcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>defn</replaceable>} + \newcommand*{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>defn</replaceable>} +\renewcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>defn</replaceable>} +\renewcommand*{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>defn</replaceable>} </screen> -<variablelist><varlistentry><term><replaceable><literal>*</literal></replaceable> -</term><listitem><indexterm role="cp"><primary>*-form of defining new commands</primary></indexterm> -<para>The *-form of these commands requires that the arguments not contain -multiple paragraphs of text (not <literal>\long</literal>, in plain &tex; terms). +<para>The <literal>*</literal>-form of these two commands requires that the arguments +not contain multiple paragraphs of text (not <literal>\long</literal>, in plain +&tex; terms). </para> -</listitem></varlistentry><varlistentry><term><replaceable>cmd</replaceable> -</term><listitem><para>The command name, beginning with <literal>\</literal>. For <literal>\newcommand</literal>, it -must not be already defined and must not begin with <literal>\end</literal>; for -<literal>\renewcommand</literal>, it must already be defined. +<variablelist><varlistentry><term><replaceable>cmd</replaceable> +</term><listitem><para>Required; the command name. It must begin with <literal>\</literal>. For +<literal>\newcommand</literal>, it must not be already defined and must not begin +with <literal>\end</literal>. For <literal>\renewcommand</literal>, it must already be +defined. </para> </listitem></varlistentry><varlistentry><term><replaceable>nargs</replaceable> -</term><listitem><para>An optional integer from 1 to 9 specifying the number of arguments -that the command will take. The default is for the command to have no -arguments. -</para> -</listitem></varlistentry><varlistentry><term><replaceable>optargval</replaceable> -</term><listitem><para>If this optional parameter is present, it means that the first -argument of command <replaceable>cmd</replaceable> is optional and its default value (i.e., -if it is not specified in the call) is <replaceable>optarg</replaceable>. In otherwise, -when calling the macro, if no <literal>[<replaceable>value</replaceable>]</literal> is given after -<literal><replaceable>cmd</replaceable></literal>—which is different from having <literal>[]</literal> for an -empty <replaceable>value</replaceable>—then string ‘<literal><replaceable>optargval</replaceable></literal>’ becomes the -value of <literal>#1</literal> within <replaceable>defn</replaceable> when the macro is expanded. +</term><listitem><para>Optional; an integer from 0 to 9, specifying the number of arguments +that the command will take. If this argument is not present, the +default is for the command to have no arguments. When redefining a +command, the new version can have a different number of arguments than +the old version. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>optargdefault</replaceable> +</term><listitem><para>Optional; if this argument is present then the first argument of defined +command <replaceable>\cmd</replaceable> is optional, with default value <replaceable>optargdefault</replaceable> +(which may be the empty string). If this argument is not present then +<replaceable>\cmd</replaceable> does not take an optional argument. +</para> +<para>That is, if <replaceable>\cmd</replaceable> is used with square brackets following, as in +<literal>\<replaceable>cmd</replaceable>[<replaceable>myval</replaceable>]</literal>, then within <replaceable>defn</replaceable> <literal>#1</literal> expands +<replaceable>myval</replaceable>. While if <replaceable>\cmd</replaceable> is called without square brackets +following, then within <replaceable>defn</replaceable> the <literal>#1</literal> expands to the default +<replaceable>optargdefault</replaceable>. In either case, any required arguments will be +referred to starting with <literal>#2</literal>. +</para> +<para>Omitting <literal>[<replaceable>myval</replaceable>]</literal> in the call is different from having the +square brackets with no contents, as in <literal>[]</literal>. The former results +in <literal>#1</literal> expanding to <replaceable>optargdefault</replaceable>; the latter results in +<literal>#1</literal> expanding to the empty string. </para> </listitem></varlistentry><varlistentry><term><replaceable>defn</replaceable> </term><listitem><para>The text to be substituted for every occurrence of <literal>cmd</literal>; a @@ -3400,11 +4529,73 @@ construct of the form <literal>#<replaceable>n</replaceable></literal> in <repla text of the <replaceable>n</replaceable>th argument. </para> </listitem></varlistentry></variablelist> -<!-- xx \providecommand, * form (non-\long) --> +<para>A command with no arguments that is followed in the source by a space +will swallow that space. The solution is to type <literal>{}</literal> after the +command and before the space. +</para> +<para>A simple example of defining a new command: +<literal>\newcommand{\JH}{Jim Hef{}feron}</literal> causes the abbreviation +<literal>\JH</literal> to be replaced by the longer text. +</para> +<para>Redefining a command is basically the same: +<literal>\renewcommand{\qedsymbol}{{\small QED}}</literal>. +</para> +<para>Here’s a command definition that uses arguments: +</para> +<screen>\newcommand{\defreference}[1]{Definition~\ref{#1}} +</screen> +<para>Then, <literal>\defreference{def:basis}</literal> will expand to +something like ‘<literal>Definition~3.14</literal>’. +</para> +<para>An example with two arguments: +<literal>\newcommand{\nbym}[2]{#1\!\times\!#2}</literal> is invoked as +<literal>\nbym{2}{k}</literal>. +</para> +<para>An example with optional arguments: +</para> +<screen>\newcommand{\salutation}[1][Sir or Madam]{Dear #1:} +</screen> +<para>Then, <literal>\salutation</literal> gives ‘<literal>Dear Sir or Madam:</literal>’ while +<literal>\salutation[John]</literal> gives ‘<literal>Dear John:</literal>’. And +<literal>\salutation[]</literal> gives ‘<literal>Dear :</literal>’. +</para> +<para>The braces around <replaceable>defn</replaceable> do not delimit the scope of the result of +expanding <replaceable>defn</replaceable>. So <literal>\newcommand{\shipname}[1]{\it #1}</literal> +is wrong since in the sentence +</para> +<screen>The \shipname{Monitor} met the \shipname{Virginia}. +</screen> +<para>the words ‘<literal>met the</literal>’ will incorrectly be in italics. An +extra pair of braces <literal>\newcommand{\shipname}[1]{{\it #1}}</literal> +fixes it. +</para> + +</sect1> +<sect1 label="12.2" id="_005cprovidecommand"> +<title><literal>\providecommand</literal></title> + +<indexterm role="fn"><primary>\providecommand</primary></indexterm> +<indexterm role="cp"><primary>commands, defining new ones</primary></indexterm> +<indexterm role="cp"><primary>defining a new command</primary></indexterm> +<indexterm role="cp"><primary>new commands, defining</primary></indexterm> + +<para>Defines a command, as long as no command of this name already exists. +Synopses: +</para> +<screen>\providecommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>defn</replaceable>} +\providecommand*{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>defn</replaceable>} +</screen> +<para>If no command of this name already exists then this has the same effect +as <literal>\newcommand</literal> (see <link linkend="_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</link>). If a +command of this name already exists then this definition does nothing. +This is particularly useful in a style file, or other file that may be +loaded more than once. +</para> </sect1> -<sect1 label="12.2" id="_005cnewcounter"> -<title><literal>\newcounter</literal></title> +<sect1 label="12.3" id="_005cnewcounter"> +<title><literal>\newcounter</literal>: Allocating a counter</title> + <indexterm role="fn"><primary>\newcounter</primary></indexterm> <indexterm role="cp"><primary>counters, defining new</primary></indexterm> @@ -3412,190 +4603,424 @@ text of the <replaceable>n</replaceable>th argument. </para> <screen>\newcounter{<replaceable>countername</replaceable>}[<replaceable>supercounter</replaceable>] </screen> -<para>The <literal>\newcounter</literal> command defines a new counter named <replaceable>countername</replaceable>. -The new counter is initialized to zero. -</para> -<para>Given the optional argument <literal>[<replaceable>super</replaceable>]</literal>, <replaceable>countername</replaceable> -will be reset whenever the counter named <replaceable>supercounter</replaceable> is incremented. +<para>The <literal>\newcounter</literal> command globally defines a new counter named +<replaceable>countername</replaceable>. The name consists of letters only and does not begin +with a backslash (‘<literal>\</literal>’). The name must not already be used by +another counter. The new counter is initialized to zero. +</para> +<para>If the optional argument <literal>[<replaceable>supercounter</replaceable>]</literal> appears, then +<replaceable>countername</replaceable> will be numbered within, or subsidiary to, the +existing counter <replaceable>supercounter</replaceable>. For example, ordinarily +<literal>subsection</literal> is numbered within <literal>section</literal>. Any time +<replaceable>supercounter</replaceable> is incremented with <literal>\stepcounter</literal> +(see <link linkend="_005cstepcounter">\stepcounter</link>) or <literal>\refstepcounter</literal> +(see <link linkend="_005crefstepcounter">\refstepcounter</link>) then <replaceable>countername</replaceable> is reset to zero. </para> <para>See <link linkend="Counters">Counters</link>, for more information about counters. </para> </sect1> -<sect1 label="12.3" id="_005cnewlength"> -<title><literal>\newlength</literal></title> +<sect1 label="12.4" id="_005cnewlength"> +<title><literal>\newlength</literal>: Allocating a length</title> + <indexterm role="fn"><primary>\newlength</primary></indexterm> -<indexterm role="cp"><primary>lengths, defining new</primary></indexterm> +<indexterm role="cp"><primary>lengths, allocating new</primary></indexterm> +<indexterm role="cp"><primary>rubber lengths, defining new</primary></indexterm> +<indexterm role="cp"><primary>skip register, plain &tex;</primary></indexterm> +<indexterm role="cp"><primary>glue register, plain &tex;</primary></indexterm> -<para>Synopsis: +<para>Allocate a new <firstterm>length</firstterm> register. Synopsis: </para> <screen>\newlength{\<replaceable>arg</replaceable>} </screen> -<para>The <literal>\newlength</literal> command defines the mandatory argument as a -<firstterm>length</firstterm> command with a value of zero. The argument must -be a control sequence, as in <literal>\newlength{\foo}</literal>. An error -occurs if <literal>\foo</literal> is already defined. +<para>This command takes one required argument, which must begin with a +backslash (‘<literal>\</literal>’). It creates a new length register named +<literal>\<replaceable>arg</replaceable></literal>, which is a place to hold (rubber) lengths such as +<literal>1in plus.2in minus.1in</literal> (what plain &tex; calls a <literal>skip</literal> +register). The register gets an initial value of zero. The control +sequence <literal>\<replaceable>arg</replaceable></literal> must not already be defined. </para> -<para>See <link linkend="Lengths">Lengths</link>, for how to set the new length to a nonzero value, and -for more information about lengths in general. +<para>See <link linkend="Lengths">Lengths</link>, for more about lengths. </para> </sect1> -<sect1 label="12.4" id="_005cnewsavebox"> -<title><literal>\newsavebox</literal></title> +<sect1 label="12.5" id="_005cnewsavebox"> +<title><literal>\newsavebox</literal>: Allocating a box</title> + <indexterm role="fn"><primary>\newsavebox</primary></indexterm> +<indexterm role="cp"><primary>box, allocating new</primary></indexterm> -<para>Synopsis: +<para>Allocate a “bin” for holding a box. Synopsis: </para> -<screen>\newsavebox{<replaceable>cmd</replaceable>} +<screen>\newsavebox{\<replaceable>cmd</replaceable>} </screen> -<para>Defines <literal>\<replaceable>cmd</replaceable></literal>, which must be a command name not already -defined, to refer to a new bin for storing boxes. +<para>Defines <literal>\<replaceable>cmd</replaceable></literal> to refer to a new bin for storing boxes. +Such a box is for holding typeset material, to use multiple times +(see <link linkend="Boxes">Boxes</link>) or to measure or manipulate. The name +<literal>\<replaceable>cmd</replaceable></literal> must start with a backslash (‘<literal>\</literal>’), and must not +be already defined. +</para> +<para>The allocation of a box is global. This command is fragile +(see <link linkend="_005cprotect">\protect</link>). </para> </sect1> -<sect1 label="12.5" id="_005cnewenvironment-_0026-_005crenewenvironment"> +<sect1 label="12.6" id="_005cnewenvironment-_0026-_005crenewenvironment"> <title><literal>\newenvironment</literal> & <literal>\renewenvironment</literal></title> + <indexterm role="fn"><primary>\newenvironment</primary></indexterm> <indexterm role="fn"><primary>\renewenvironment</primary></indexterm> <indexterm role="cp"><primary>environments, defining</primary></indexterm> <indexterm role="cp"><primary>defining new environments</primary></indexterm> <indexterm role="cp"><primary>redefining environments</primary></indexterm> -<para>Synopses: -</para> -<screen> \newenvironment[*]{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>} -\renewenvironment[*]{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>} -</screen> <para>These commands define or redefine an environment <replaceable>env</replaceable>, that is, -<literal>\begin{<replaceable>env</replaceable>} … \end{<replaceable>env</replaceable>}</literal>. -</para> -<variablelist><varlistentry><term><replaceable><literal>*</literal></replaceable> -</term><listitem><indexterm role="cp"><primary>*-form of environment commands</primary></indexterm> -<para>The *-form of these commands requires that the arguments (not the -contents of the environment) not contain multiple paragraphs of text. +<literal>\begin{<replaceable>env</replaceable>} … \end{<replaceable>env</replaceable>}</literal>. Synopses: </para> -</listitem></varlistentry><varlistentry><term><replaceable>env</replaceable> -</term><listitem><para>The name of the environment. For <literal>\newenvironment</literal>, <replaceable>env</replaceable> -must not be an existing environment, and the command <literal>\<replaceable>env</replaceable></literal> -must be undefined. For <literal>\renewenvironment</literal>, <replaceable>env</replaceable> must be -the name of an existing environment. +<screen> \newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>begdefn</replaceable>}{<replaceable>enddefn</replaceable>} + \newenvironment*{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>begdefn</replaceable>}{<replaceable>enddefn</replaceable>} +\renewenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>begdefn</replaceable>}{<replaceable>enddefn</replaceable>} +\renewenvironment*{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>optargdefault</replaceable>]{<replaceable>begdefn</replaceable>}{<replaceable>enddefn</replaceable>} +</screen> +<para>Unlike <literal>\newcommand</literal> and <literal>\renewcommand</literal>, the <literal>*</literal>-forms +<literal>\newenvironment*</literal> and <literal>\renewcommand*</literal> have the same effect +as the forms with no <literal>*</literal>. +</para> +<variablelist><varlistentry><term><replaceable>env</replaceable> +</term><listitem><para>Required; the environment name. It does not begin with backslash +(<literal>\</literal>). It must not begin with the string <literal>end</literal>. For +<literal>\newenvironment</literal>, the name <replaceable>env</replaceable> must not be the name of an +already existing environment, and also the command <literal>\<replaceable>env</replaceable></literal> +must be undefined. For <literal>\renewenvironment</literal>, <replaceable>env</replaceable> must be the +name of an existing environment. </para> </listitem></varlistentry><varlistentry><term><replaceable>nargs</replaceable> -</term><listitem><para>An integer from 1 to 9 denoting the number of arguments of -the newly-defined environment. The default is no arguments. -</para> -</listitem></varlistentry><varlistentry><term><replaceable>default</replaceable> -</term><listitem><para>If this is specified, the first argument is optional, and <replaceable>default</replaceable> -gives the default value for that argument. -</para> -</listitem></varlistentry><varlistentry><term><replaceable>begdef</replaceable> -</term><listitem><para>The text expanded at every occurrence of <literal>\begin{<replaceable>env</replaceable>}</literal>; a -construct of the form <literal>#<replaceable>n</replaceable></literal> in <replaceable>begdef</replaceable> is replaced by -the text of the <replaceable>n</replaceable>th argument. -</para> -</listitem></varlistentry><varlistentry><term><replaceable>enddef</replaceable> -</term><listitem><para>The text expanded at every occurrence of <literal>\end{<replaceable>env</replaceable>}</literal>. It -may not contain any argument parameters. +</term><listitem><para>Optional; an integer from 0 to 9 denoting the number of arguments of +that the environment will take. These arguments appear after the +<literal>\begin</literal>, as in +<literal>\begin{<replaceable>env</replaceable>}{<replaceable>arg1</replaceable>}…{<replaceable>argn</replaceable>}</literal>. If this +argument is not present then the default is for the environment to have +no arguments. When redefining an environment, the new version can have +a different number of arguments than the old version. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>optargdefault</replaceable> +</term><listitem><para>Optional; if this argument is present then the first argument of the +defined environment is optional, with default value <replaceable>optargdefault</replaceable> +(which may be the empty string). If this argument is not present then +the environment does not take an optional argument. +</para> +<para>That is, when <literal>[<replaceable>optargdefault</replaceable>]</literal> is present in the environment +definition, if <literal>\begin{<replaceable>env</replaceable>}</literal> is used with square brackets +following, as in <literal>\begin{<replaceable>env</replaceable>}[<replaceable>myval</replaceable>]</literal>, then within +the environment <literal>#1</literal> expands <replaceable>myval</replaceable>. If +<literal>\begin{<replaceable>env</replaceable>}</literal> is called without square brackets following, +then within the environment the <literal>#1</literal> expands to the default +<replaceable>optargdefault</replaceable>. In either case, any required arguments will be +referred to starting with <literal>#2</literal>. +</para> + +<para>Omitting <literal>[<replaceable>myval</replaceable>]</literal> in the call is different from having the +square brackets with no contents, as in <literal>[]</literal>. The former results +in <literal>#1</literal> expanding to <replaceable>optargdefault</replaceable>; the latter results in +<literal>#1</literal> expanding to the empty string. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>begdefn</replaceable> +</term><listitem><para>Required; the text expanded at every occurrence of +<literal>\begin{<replaceable>env</replaceable>}</literal>; a construct of the form <literal>#<replaceable>n</replaceable></literal> in +<replaceable>begdef</replaceable> is replaced by the text of the <replaceable>n</replaceable>th argument. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>enddefn</replaceable> +</term><listitem><para>Required; the text expanded at every occurrence of +<literal>\end{<replaceable>env</replaceable>}</literal>. Note that it may not contain any argument +parameters, so <literal>#<replaceable>n</replaceable></literal> cannot be used here. </para> </listitem></varlistentry></variablelist> +<para>The environment <replaceable>env</replaceable> delimits the scope of the result of expanding +<replaceable>begdefn</replaceable> and <replaceable>enddefn</replaceable>. Thus, in the first example below, the +effect of the <literal>\small</literal> is limited to the quote and does not extend +to material following the environment. +</para> +<para>This example gives an environment like &latex;’s <literal>quotation</literal> except that +it will be set in smaller type. +</para> +<screen>\newenvironment{smallquote}{% + \small\begin{quotation} +}{% + \end{quotation} +} +</screen> +<para>This shows the use of arguments; it gives a quotation environment that +cites the author. +</para> +<screen>\newenvironment{citequote}[1][Shakespeare]{% + \begin{quotation} + \noindent\textit{#1}: +}{% + \end{quotation} +} +</screen> +<para>The author’s name is optional, and defaults to Shakespeare. +In the document, use the environment as here: +</para> +<screen>\begin{citequote}[Lincoln] + .. +\end{citequote} +</screen> +<para>The final example shows how to save the value of an argument to use in +<replaceable>enddefn</replaceable>. +</para> +<screen>\newsavebox{\quoteauthor} +\newenvironment{citequote}[1][Shakespeare]{% + \sbox\quoteauthor{#1}% + \begin{quotation} +}{% + \hspace{1em plus 1fill}---\usebox{\quoteauthor} + \end{quotation} +} +</screen> </sect1> -<sect1 label="12.6" id="_005cnewtheorem"> +<sect1 label="12.7" id="_005cnewtheorem"> <title><literal>\newtheorem</literal></title> + <indexterm role="fn"><primary>\newtheorem</primary></indexterm> <indexterm role="cp"><primary>theorems, defining</primary></indexterm> <indexterm role="cp"><primary>defining new theorems</primary></indexterm> -<screen>\newtheorem{<replaceable>newenv</replaceable>}{<replaceable>label</replaceable>}[<replaceable>within</replaceable>] -\newtheorem{<replaceable>newenv</replaceable>}[<replaceable>numbered_like</replaceable>]{<replaceable>label</replaceable>} +<indexterm role="cp"><primary>theorem-like environment</primary></indexterm> +<indexterm role="cp"><primary>environment, theorem-like</primary></indexterm> +<para>Define a new <firstterm>theorem-like environment</firstterm>. Synopses: +</para> +<screen>\newtheorem{<replaceable>name</replaceable>}{<replaceable>title</replaceable>}[<replaceable>numbered_within</replaceable>] +\newtheorem{<replaceable>name</replaceable>}[<replaceable>numbered_like</replaceable>]{<replaceable>title</replaceable>} +</screen> +<para>Both create a theorem-like environment <replaceable>name</replaceable>. Using the first +form, +</para> +<screen>\newtheorem{<replaceable>name</replaceable>}{<replaceable>title</replaceable>}[<replaceable>numbered_within</replaceable>] </screen> -<para>This command defines a theorem-like environment. Arguments: +<para>with the optional argument after the second required argument, +creates an environment whose counter is subordinate to the existing +counter <replaceable>numbered_within</replaceable>: it will be reset when +<replaceable>numbered_within</replaceable> is reset). +</para> +<para>Using the second form, +</para> +<screen>\newtheorem{<replaceable>name</replaceable>}[<replaceable>numbered_like</replaceable>]{<replaceable>title</replaceable>} +</screen> +<para>with the optional argument between the two required +arguments, will create an environment whose counter will share the +previously defined counter <replaceable>numbered_like</replaceable>. +</para> +<para>You can specify one of <replaceable>numbered_within</replaceable> and <replaceable>numbered_like</replaceable>, +or neither, but not both. </para> -<variablelist><varlistentry><term><replaceable>newenv</replaceable> -</term><listitem><para>The name of the environment to be defined; must not be the name of an -existing environment or otherwise defined. +<para>This command creates a counter named <replaceable>name</replaceable>. In addition, unless +the optional argument <replaceable>numbered_like</replaceable> is used, the current +<literal>\ref</literal> value will be that of <literal>\the<replaceable>numbered_within</replaceable></literal> +(see <link linkend="_005cref">\ref</link>). </para> -</listitem></varlistentry><varlistentry><term><replaceable>label</replaceable> +<para>This declaration is global. It is fragile (see <link linkend="_005cprotect">\protect</link>). +</para> +<para>Arguments: +</para> +<variablelist><varlistentry><term><replaceable>name</replaceable> +</term><listitem><para>The name of the environment. It must not begin with a backslash +(‘<literal>\</literal>’). It must not be the name of an existing environment; indeed, +the command name <literal>\<replaceable>name</replaceable></literal> must not already be defined as anything. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>title</replaceable> </term><listitem><para>The text printed at the beginning of the environment, before the number. For example, ‘<literal>Theorem</literal>’. </para> -</listitem></varlistentry><varlistentry><term><replaceable>numbered_like</replaceable> -</term><listitem><para>(Optional.) The name of an already defined theorem-like environment; -the new environment will be numbered just like <replaceable>numbered_like</replaceable>. +</listitem></varlistentry><varlistentry><term><replaceable>numbered_within</replaceable> +</term><listitem><para>Optional; the name of an already defined counter, usually a sectional +unit such as <literal>chapter</literal> or <literal>section</literal>. When the +<replaceable>numbered_within</replaceable> counter is reset then the <replaceable>name</replaceable> environment’s +counter will also be reset. </para> -</listitem></varlistentry><varlistentry><term><replaceable>within</replaceable> -</term><listitem><para>(Optional.) The name of an already defined counter, a sectional unit. -The new theorem counter will be reset at the same time as the -<replaceable>within</replaceable> counter. +<para>If this optional argument is not used then the command +<literal>\the<replaceable>name</replaceable></literal> is set to <literal>\arabic{<replaceable>name</replaceable>}</literal>. +</para> +</listitem></varlistentry><varlistentry><term><replaceable>numbered_like</replaceable> +</term><listitem><para>Optional; the name of an already defined theorem-like environment. The +new environment will be numbered in sequence with <replaceable>numbered_like</replaceable>. </para> </listitem></varlistentry></variablelist> -<para>At most one of <replaceable>numbered_like</replaceable> and <replaceable>within</replaceable> can be specified, -not both. +<para>Without any optional arguments the environments are numbered +sequentially. This example has a declaration in the preamble that +results in ‘<literal>Definition 1</literal>’ and ‘<literal>Definition 2</literal>’ in the output. +</para> +<screen>\newtheorem{defn}{Definition} +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{defn} + Second def +\end{defn} +</screen> +<para>Because this example specifies the optional argument +<replaceable>numbered_within</replaceable> to <literal>\newtheorem</literal> as <literal>section</literal>, the +example, with the same document body, gives ‘<literal>Definition 1.1</literal>’ +and ‘<literal>Definition 2.1</literal>’. </para> +<screen>\newtheorem{defn}{Definition}[section] +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{defn} + Second def +\end{defn} +</screen> +<para>In this example there are two declarations in the preamble, the second +of which calls for the new <literal>thm</literal> environment to use the same +counter as <literal>defn</literal>. It gives ‘<literal>Definition 1.1</literal>’, followed +by ‘<literal>Theorem 2.1</literal>’ and ‘<literal>Definition 2.2</literal>’. +</para> +<screen>\newtheorem{defn}{Definition}[section] +\newtheorem{thm}[defn]{Theorem} +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{thm} + First thm +\end{thm} + +\begin{defn} + Second def +\end{defn} +</screen> </sect1> -<sect1 label="12.7" id="_005cnewfont"> -<title><literal>\newfont</literal></title> +<sect1 label="12.8" id="_005cnewfont"> +<title><literal>\newfont</literal>: Define a new font (obsolete)</title> + <indexterm role="fn"><primary>\newfont</primary></indexterm> <indexterm role="cp"><primary>fonts, new commands for</primary></indexterm> <indexterm role="cp"><primary>defining new fonts</primary></indexterm> -<para>Synopsis: +<para><literal>\newfont</literal>, now obsolete, defines a command that will switch fonts. +Synopsis: </para> -<screen>\newfont{<replaceable>cmd</replaceable>}{<replaceable>fontname</replaceable>} +<screen>\newfont{\<replaceable>cmd</replaceable>}{<replaceable>font description</replaceable>} +</screen> +<para>This defines a control sequence <literal>\<replaceable>cmd</replaceable></literal> that will change the +current font. &latex; will look on your system for a file named +<filename><replaceable>fontname</replaceable>.tfm</filename>. The control sequence must must not already +be defined. It must begin with a backslash (‘<literal>\</literal>’). +</para> +<indexterm role="fn"><primary>.fd file</primary></indexterm> +<para>This command is obsolete. It is a low-level command for setting up an +individual font. Today fonts are almost always defined in families +(which allows you to, for example, associate a boldface with a roman) +through the so-called “New Font Selection Scheme”, either by using +<filename>.fd</filename> files or through the use of an engine that can access +system fonts such as Xe&latex; (see <link linkend="TeX-engines">&tex; engines</link>). +<!-- xx explain nfss somewhere --> +</para> +<indexterm role="cp"><primary>at clause, in font definitions</primary></indexterm> +<indexterm role="cp"><primary>design size, in font definitions</primary></indexterm> +<para>But since it is part of &latex;, here is an explanation: the +<replaceable>font description</replaceable> consists of a <replaceable>fontname</replaceable> and an optional +<firstterm>at clause</firstterm>; this can have the form either <literal>at <replaceable>dimen</replaceable></literal> +or <literal>scaled <replaceable>factor</replaceable></literal>, where a <replaceable>factor</replaceable> of ‘<literal>1000</literal>’ +means no scaling. For &latex;’s purposes, all this does is scale all +the character and other font dimensions relative to the font’s design +size, which is a value defined in the <filename>.tfm</filename> file. +</para> +<para>This example defines two equivalent fonts and typesets a few +characters in each: +</para> +<screen>\newfont{\testfontat}{cmb10 at 11pt} +\newfont{\testfontscaled}{cmb10 scaled 11pt} +\testfontat abc +\testfontscaled abc </screen> -<para>Defines a control sequence <literal>\<replaceable>cmd</replaceable></literal>, which must not already -be defined, to make <replaceable>fontname</replaceable> be the current font. The file -looked for on the system is named <filename><replaceable>fontname</replaceable>.tfm</filename>. -</para> -<para>This is a low-level command for setting up to use an individual font. -More commonly, fonts are defined in families through <filename>.fd</filename> files. -</para> </sect1> -<sect1 label="12.8" id="_005cprotect"> +<sect1 label="12.9" id="_005cprotect"> <title><literal>\protect</literal></title> -<indexterm role="fn"><primary>\protect</primary></indexterm> +<indexterm role="fn"><primary>\protect</primary></indexterm> <indexterm role="cp"><primary>fragile commands</primary></indexterm> -<indexterm role="cp"><primary>moving arguments</primary></indexterm> -<para>Footnotes, line breaks, any command that has an optional argument, and -many more are so-called <firstterm>fragile</firstterm> commands. When a fragile -command is used in certain contexts, called <firstterm>moving arguments</firstterm>, it -must be preceded by <literal>\protect</literal>. In addition, any fragile -commands within the arguments must have their own <literal>\protect</literal>. -</para> -<para>Some examples of moving arguments are <literal>\caption</literal> -(see <link linkend="figure">figure</link>), <literal>\thanks</literal> (see <link linkend="_005cmaketitle">\maketitle</link>), and -expressions in <literal>tabular</literal> and <literal>array</literal> environments -(see <link linkend="tabular">tabular</link>). -</para> <indexterm role="cp"><primary>robust commands</primary></indexterm> -<para>Commands which are not fragile are called <firstterm>robust</firstterm>. They must not -be preceded by <literal>\protect</literal>. -</para> -<para>See also: -</para> -<simpara><ulink url="http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html">http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</ulink></simpara> -<simpara><ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</ulink></simpara> - -<!-- xx really need examples. --> +<indexterm role="cp"><primary>moving arguments</primary></indexterm> +<para>All &latex; commands are either <firstterm>fragile</firstterm> or <firstterm>robust</firstterm>. +Footnotes, line breaks, any command that has an optional argument, and +many more, are fragile. A fragile command can break when it is used in +the argument to certain commands. To prevent such commands from +breaking they must be preceded by the command <literal>\protect</literal>. +</para> +<para>For example, when &latex; runs the <literal>\section{<replaceable>section +name</replaceable>}</literal> command it writes the <replaceable>section name</replaceable> text to the +<filename>.aux</filename> auxiliary file, moving it there for use elsewhere in the +document such as in the table of contents. Any argument that is +internally expanded by &latex; without typesetting it directly is +referred to as a <firstterm>moving argument</firstterm>. A command is fragile if it can +expand during this process into invalid &tex; code. Some examples of +moving arguments are those that appear in the <literal>\caption{..}</literal> +command (see <link linkend="figure">figure</link>), in the <literal>\thanks{..}</literal> command +(see <link linkend="_005cmaketitle">\maketitle</link>), and in @-expressions in the <literal>tabular</literal> and +<literal>array</literal> environments (see <link linkend="tabular">tabular</link>). +</para> +<para>If you get strange errors from commands used in moving arguments, try +preceding it with <literal>\protect</literal>. Every fragile commands must be +protected with their own <literal>\protect</literal>. +</para> +<para>Although usually a <literal>\protect</literal> command doesn’t hurt, length +commands are robust and should not be preceded by a <literal>\protect</literal> +command. Nor can a <literal>\protect</literal> command be used in the argument to +<literal>\addtocounter</literal> or <literal>\setcounter</literal> command. +</para> +<para>In this example the <literal>caption</literal> command gives a mysterious error +about an extra curly brace. Fix the problem by preceding each +<literal>\raisebox</literal> command with <literal>\protect</literal>. +</para> +<screen>\begin{figure} + .. + \caption{Company headquarters of A\raisebox{1pt}{B}\raisebox{-1pt}{C}} +\end{figure} +</screen> +<para>In the next example the <literal>\tableofcontents</literal> command gives an error +because the <literal>\(..\)</literal> in the section title expands to illegal &tex; +in the <filename>.toc</filename> file. You can solve this by changing <literal>\(..\)</literal> +to <literal>\protect\(..\protect\)</literal>. +</para> +<screen>\begin{document} +\tableofcontents + .. +\section{Einstein's \( e=mc^2 \)} + .. +</screen> </sect1> </chapter> <chapter label="13" id="Counters"> <title>Counters</title> + <indexterm role="cp"><primary>counters, a list of</primary></indexterm> <indexterm role="cp"><primary>variables, a list of</primary></indexterm> <para>Everything &latex; numbers for you has a counter associated with -it. The name of the counter is the same as the name of the environment -or command that produces the number, except with no <literal>\</literal>. -(<literal>enumi</literal>–<literal>enumiv</literal> are used for the nested enumerate -environment.) Below is a list of the counters used in &latex;’s -standard document classes to control numbering. +it. The name of the counter is often the same as the name of the +environment or command associated with the number, except with no +backslash (<literal>\</literal>). Thus the <literal>\chapter</literal> command starts a +chapter and the <literal>chapter</literal> counter keeps track of the chapter +number. Below is a list of the counters used in &latex;’s standard +document classes to control numbering. </para> <screen>part paragraph figure enumi chapter subparagraph table enumii @@ -3603,13 +5028,26 @@ section page footnote enumiii subsection equation mpfootnote enumiv subsubsection </screen> +<para>The <literal>mpfootnote</literal> counter is used by the <literal>\footnote</literal> command +inside of a minipage (see <link linkend="minipage">minipage</link>). +</para> +<para>The <literal>enumi</literal> through <literal>enumiv</literal> counters are used in the +<literal>enumerate</literal> environment, for up to four nested levels +(see <link linkend="enumerate">enumerate</link>). +</para> +<para>New counters are created with <literal>\newcounter</literal>. See <link linkend="_005cnewcounter">\newcounter</link>. +</para> + <sect1 label="13.1" id="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol"> <title><literal>\alph \Alph \arabic \roman \Roman \fnsymbol</literal>: Printing counters</title> +<indexterm role="cp"><primary>counters, printing</primary></indexterm> + <para>All of these commands take a single counter as an argument, for -instance, <literal>\alph{enumi}</literal>. +instance, <literal>\alph{enumi}</literal>. Note that the counter name does not +start with a backslash. </para> <variablelist><varlistentry><term><indexterm role="fn"><primary>\alph</primary></indexterm><literal>\alph</literal> </term><listitem><para>prints <replaceable>counter</replaceable> using lowercase letters: ‘a’, ‘b’, ... @@ -3635,13 +5073,14 @@ symbols (conventionally used for labeling footnotes). The value of </para> <literallayout>asterisk(*) dagger(‡) ddagger(‡) section-sign(§) paragraph-sign(¶) parallel(∥) -double-asterisk(**) double-dagger(‡‡) double-ddagger(‡‡) +double-asterisk(**) double-dagger(††) double-ddagger(‡‡) </literallayout> </listitem></varlistentry></variablelist> </sect1> <sect1 label="13.2" id="_005cusecounter"> <title><literal>\usecounter{<replaceable>counter</replaceable>}</literal></title> + <indexterm role="fn"><primary>\usecounter</primary></indexterm> <indexterm role="cp"><primary>list items, specifying counter</primary></indexterm> <indexterm role="cp"><primary>numbered items, specifying counter</primary></indexterm> @@ -3650,14 +5089,30 @@ double-asterisk(**) double-dagger(‡‡) double-ddagger(‡  </para> <screen>\usecounter{<replaceable>counter</replaceable>} </screen> -<para>The <literal>\usecounter</literal> command is used in the second argument of the -<literal>list</literal> environment to specify <replaceable>counter</replaceable> to be used to number -the list items. -</para> +<para>In the <literal>list</literal> environment, when used in the second argument, this +command sets up <replaceable>counter</replaceable> to number the list items. It initializes +<replaceable>counter</replaceable> to zero, and arranges that when <literal>\item</literal> is called +without its optional argument then <replaceable>counter</replaceable> is incremented by +<literal>\refstepcounter</literal>, making its value be the current <literal>ref</literal> +value. This command is fragile (see <link linkend="_005cprotect">\protect</link>). +</para> +<para>Put in the preamble, this makes a new list environment enumerated with +<replaceable>testcounter</replaceable>: +</para> +<screen>\newcounter{testcounter} +\newenvironment{test}{% + \begin{list}{}{% + \usecounter{testcounter} + } +}{% + \end{list} +} +</screen> </sect1> <sect1 label="13.3" id="_005cvalue"> <title><literal>\value{<replaceable>counter</replaceable>}</literal></title> + <indexterm role="fn"><primary>\value</primary></indexterm> <indexterm role="cp"><primary>counters, getting value of</primary></indexterm> @@ -3665,17 +5120,34 @@ the list items. </para> <screen>\value{<replaceable>counter</replaceable>} </screen> -<para>The <literal>\value</literal> command produces the value of <replaceable>counter</replaceable>. It can -be used anywhere &latex; expects a number, for example: +<para>This command expands to the value of <replaceable>counter</replaceable>. It is often used +in <literal>\setcounter</literal> or <literal>\addtocounter</literal>, but <literal>\value</literal> can +be used anywhere that &latex; expects a number. It must not be +preceded by <literal>\protect</literal> (see <link linkend="_005cprotect">\protect</link>). +</para> +<para>The <literal>\value</literal> command is not used for typesetting the value of the +counter. See <link linkend="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</link>. +</para> +<para>This example outputs ‘<literal>Test counter is 6. Other counter +is 5.</literal>’. </para> -<screen>\setcounter{myctr}{3} -\addtocounter{myctr}{1} +<screen>\newcounter{test} \setcounter{test}{5} +\newcounter{other} \setcounter{other}{\value{test}} +\addtocounter{test}{1} + +Test counter is \arabic{test}. +Other counter is \arabic{other}. +</screen> +<para>This example inserts <literal>\hspace{4\parindent}</literal>. +</para> +<screen>\setcounter{myctr}{3} \addtocounter{myctr}{1} \hspace{\value{myctr}\parindent} </screen> </sect1> <sect1 label="13.4" id="_005csetcounter"> <title><literal>\setcounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title> + <indexterm role="fn"><primary>\setcounter</primary></indexterm> <indexterm role="cp"><primary>counters, setting</primary></indexterm> <indexterm role="cp"><primary>setting counters</primary></indexterm> @@ -3684,41 +5156,55 @@ be used anywhere &latex; expects a number, for example: </para> <screen>\setcounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>} </screen> -<para>The <literal>\setcounter</literal> command sets the value of <replaceable>counter</replaceable> to the -<replaceable>value</replaceable> argument. +<para>The <literal>\setcounter</literal> command globally sets the value of <replaceable>counter</replaceable> +to the <replaceable>value</replaceable> argument. Note that the counter name does not start +with a backslash. </para> </sect1> <sect1 label="13.5" id="_005caddtocounter"> <title><literal>\addtocounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title> + <indexterm role="fn"><primary>\addtocounter</primary></indexterm> -<para>The <literal>\addtocounter</literal> command increments <replaceable>counter</replaceable> by the -amount specified by the <replaceable>value</replaceable> argument, which may be negative. +<para>The <literal>\addtocounter</literal> command globally increments <replaceable>counter</replaceable> by +the amount specified by the <replaceable>value</replaceable> argument, which may be negative. </para> </sect1> <sect1 label="13.6" id="_005crefstepcounter"> <title><literal>\refstepcounter{<replaceable>counter</replaceable>}</literal></title> + <indexterm role="fn"><primary>\refstepcounter</primary></indexterm> <para>The <literal>\refstepcounter</literal> command works in the same way as -<literal>\stepcounter</literal> See <link linkend="_005cstepcounter">\stepcounter</link>, except it also defines the -current <literal>\ref</literal> value to be the result of <literal>\thecounter</literal>. +<literal>\stepcounter</literal> (see <link linkend="_005cstepcounter">\stepcounter</link>): it globally increments the +value of <replaceable>counter</replaceable> by one and resets the value of any counter +numbered within it. (For the definition of “counters numbered +within”, see <link linkend="_005cnewcounter">\newcounter</link>.) +</para> +<para>In addition, this command also defines the current <literal>\ref</literal> value +to be the result of <literal>\thecounter</literal>. +</para> +<para>While the counter value is set globally, the <literal>\ref</literal> value is set +locally, i.e., inside the current group. </para> </sect1> <sect1 label="13.7" id="_005cstepcounter"> <title><literal>\stepcounter{<replaceable>counter</replaceable>}</literal></title> + <indexterm role="fn"><primary>\stepcounter</primary></indexterm> -<para>The <literal>\stepcounter</literal> command adds one to <replaceable>counter</replaceable> and -resets all subsidiary counters. +<para>The <literal>\stepcounter</literal> command globally adds one to <replaceable>counter</replaceable> and +resets all counters numbered within it. (For the definition of +“counters numbered within”, see <link linkend="_005cnewcounter">\newcounter</link>.) </para> </sect1> <sect1 label="13.8" id="_005cday-_005cmonth-_005cyear"> <title><literal>\day \month \year</literal>: Predefined counters</title> + <indexterm role="fn"><primary>\day</primary></indexterm> <indexterm role="fn"><primary>\month</primary></indexterm> <indexterm role="fn"><primary>\year</primary></indexterm> @@ -3737,15 +5223,123 @@ current day (see <link linkend="_005ctoday">\today</link>). </chapter> <chapter label="14" id="Lengths"> <title>Lengths</title> + <indexterm role="cp"><primary>lengths, defining and using</primary></indexterm> -<para>A <literal>length</literal> is a measure of distance. Many &latex; commands take a +<para>A <firstterm>length</firstterm> is a measure of distance. Many &latex; commands take a length as an argument. </para> - - -<sect1 label="14.1" id="_005csetlength"> +<para>Lengths come in two types. A <firstterm>rigid length</firstterm> (what Plain &tex; +calls a <firstterm>dimen</firstterm>) such as <literal>10pt</literal> cannot contain a <literal>plus</literal> or +<literal>minus</literal> component. A <firstterm>rubber length</firstterm> (what Plain &tex; calls +a <firstterm>skip</firstterm>) can contain those, as with <literal>1cm plus0.05cm +minus0.01cm</literal>. These give the ability to stretch or shrink; the length +in the prior sentence could appear in the output as long as 1.05 cm +or as short as 0.99 cm, depending on what &tex;’s typesetting +algorithm finds optimum. +</para> +<para>The <literal>plus</literal> or <literal>minus</literal> component of a rubber length can contain +a <firstterm>fill</firstterm> component, as in <literal>1in plus2fill</literal>. This gives the +length infinite stretchability or shrinkability, so that the length in +the prior sentence can be set by &tex; to any distance greater than or +equal to 1 inch. &tex; actually provides three infinite glue +components <literal>fil</literal>, <literal>fill</literal>, and <literal>filll</literal>, such that the +later ones overcome the earlier ones, but only the middle value is +ordinarily used. See <link linkend="_005chfill">\hfill</link>, See <link linkend="_005cvfill">\vfill</link>. +</para> +<para>Multiplying an entire rubber length by a number turns it into a rigid +length, so that after <literal>\setlength{\ylength}{1in plus 0.2in}</literal> +and <literal>\setlength{\zlength}{3\ylength}</literal> then the value of +<literal>\zlength</literal> is <literal>3in</literal>. +</para> + + + +<sect1 label="14.1" id="Units-of-length"> +<title>Units of length</title> + +<indexterm role="cp"><primary>units, of length</primary></indexterm> + +<para>&tex; and &latex; know about these units both inside and outside of +math mode. +</para> +<variablelist><varlistentry><term><literal>pt</literal> +</term><listitem><indexterm role="fn"><primary>pt</primary></indexterm> +<indexterm role="cp"><primary>Point</primary></indexterm> +<para>Point 1/72.27 inch. The conversion to metric units, to two decimal +places, is 1point = 2.85mm = 28.45cm. +</para> +</listitem></varlistentry><varlistentry><term><literal>pc</literal> +</term><listitem><indexterm role="cp"><primary>pica</primary></indexterm> +<indexterm role="fn"><primary>pc</primary></indexterm> +<para>Pica, 12 pt +</para> +</listitem></varlistentry><varlistentry><term><literal>in</literal> +</term><listitem><indexterm role="fn"><primary>in</primary></indexterm> +<indexterm role="fn"><primary>inch</primary></indexterm> +<para>Inch, 72.27 pt +</para> +</listitem></varlistentry><varlistentry><term><literal>bp</literal> +</term><listitem><indexterm role="fn"><primary>bp</primary></indexterm> +<indexterm role="cp"><primary>Big point</primary></indexterm> +<para>Big point, 1/72 inch. This length is the definition of a point in +PostScript and many desktop publishing systems. +</para> +</listitem></varlistentry><varlistentry><term><literal>cm</literal> +</term><listitem><indexterm role="cp"><primary>Centimeter</primary></indexterm> +<indexterm role="fn"><primary>cm</primary></indexterm> +<para>Centimeter +</para> +</listitem></varlistentry><varlistentry><term><literal>mm</literal> +</term><listitem><indexterm role="cp"><primary>Millimeter</primary></indexterm> +<indexterm role="fn"><primary>mm</primary></indexterm> +<para>Millimeter +</para> +</listitem></varlistentry><varlistentry><term><literal>dd</literal> +</term><listitem><indexterm role="cp"><primary>Didot point</primary></indexterm> +<indexterm role="fn"><primary>dd</primary></indexterm> +<para>Didot point, 1.07 pt +</para> +</listitem></varlistentry><varlistentry><term><literal>cc</literal> +</term><listitem><indexterm role="cp"><primary>Cicero</primary></indexterm> +<indexterm role="fn"><primary>cc</primary></indexterm> +<para>Cicero, 12 dd +</para> +</listitem></varlistentry><varlistentry><term><literal>sp</literal> +</term><listitem><indexterm role="cp"><primary>Scaled point</primary></indexterm> +<indexterm role="fn"><primary>sp</primary></indexterm> +<para>Scaled point, 1/65536 pt +</para> +</listitem></varlistentry></variablelist> +<indexterm role="cp"><primary>ex</primary></indexterm> +<indexterm role="cp"><primary>x-height</primary></indexterm> +<indexterm role="fn"><primary>ex</primary></indexterm> +<indexterm role="cp"><primary>m-width</primary></indexterm> +<indexterm role="cp"><primary>em</primary></indexterm> +<indexterm role="fn"><primary>em</primary></indexterm> +<para>Two other lengths that are often used are values set by the designer of +the font. The x-height of the current font <firstterm>ex</firstterm>, traditionally the +height of the lower case letter x, is often used for vertical +lengths. Similarly <firstterm>em</firstterm>, traditionally the width of the capital +letter M, is often used for horizontal lengths (there is also +<literal>\enspace</literal>, which is <literal>0.5em</literal>). Use of these can help make a +definition work better across font changes. For example, a definition +of the vertical space between list items given as +<literal>\setlength{\itemsep}{1ex plus 0.05ex minus 0.01ex}</literal> is more +likely to still be reasonable if the font is changed than a definition +given in points. +</para> +<indexterm role="cp"><primary>mu, math unit</primary></indexterm> +<indexterm role="fn"><primary>mu</primary></indexterm> +<para>In math mode, many definitions are expressed in terms of the math unit +<firstterm>mu</firstterm> given by 1 em = 18 mu, where the em is taken from the current +math symbols family. See <link linkend="Spacing-in-math-mode">Spacing in math mode</link>. +</para> + +</sect1> +<sect1 label="14.2" id="_005csetlength"> <title><literal>\setlength{\<replaceable>len</replaceable>}{<replaceable>value</replaceable>}</literal></title> + <indexterm role="fn"><primary>\setlength</primary></indexterm> <indexterm role="cp"><primary>lengths, setting</primary></indexterm> @@ -3756,8 +5350,9 @@ understands, i.e., inches (<literal>in</literal>), millimeters (<literal>mm</lit </para> </sect1> -<sect1 label="14.2" id="_005caddtolength"> -<title>\addtolength{<replaceable>\len</replaceable>}{<replaceable>amount</replaceable>}</title> +<sect1 label="14.3" id="_005caddtolength"> +<title><literal>\addtolength{<replaceable>\len</replaceable>}{<replaceable>amount</replaceable>}</literal></title> + <indexterm role="fn"><primary>\addtolength</primary></indexterm> <indexterm role="cp"><primary>lengths, adding to</primary></indexterm> @@ -3767,8 +5362,9 @@ may be negative. </para> </sect1> -<sect1 label="14.3" id="_005csettodepth"> +<sect1 label="14.4" id="_005csettodepth"> <title><literal>\settodepth</literal></title> + <indexterm role="fn"><primary>\settodepth</primary></indexterm> <para><literal>\settodepth{\gnat}{text}</literal> @@ -3778,8 +5374,9 @@ equal to the depth of the <literal>text</literal> argument. </para> </sect1> -<sect1 label="14.4" id="_005csettoheight"> +<sect1 label="14.5" id="_005csettoheight"> <title><literal>\settoheight</literal></title> + <indexterm role="fn"><primary>\settoheight</primary></indexterm> <para><literal>\settoheight{\gnat}{text}</literal> @@ -3790,8 +5387,9 @@ equal to the height of the <literal>text</literal> argument. </sect1> -<sect1 label="14.5" id="_005csettowidth"> +<sect1 label="14.6" id="_005csettowidth"> <title><literal>\settowidth{\<replaceable>len</replaceable>}{<replaceable>text</replaceable>}</literal></title> + <indexterm role="fn"><primary>\settowidth</primary></indexterm> <para>The <literal>\settowidth</literal> command sets the value of the command <replaceable>\len</replaceable> @@ -3799,8 +5397,9 @@ to the width of the <replaceable>text</replaceable> argument. </para> </sect1> -<sect1 label="14.6" id="Predefined-lengths"> +<sect1 label="14.7" id="Predefined-lengths"> <title>Predefined lengths</title> + <indexterm role="cp"><primary>lengths, predefined</primary></indexterm> <indexterm role="cp"><primary>predefined lengths</primary></indexterm> @@ -3829,6 +5428,7 @@ natural size, e.g., say </chapter> <chapter label="15" id="Making-paragraphs"> <title>Making paragraphs</title> + <indexterm role="cp"><primary>making paragraphs</primary></indexterm> <indexterm role="cp"><primary>paragraphs</primary></indexterm> @@ -3841,14 +5441,14 @@ a sectioning command. <sect1 label="15.1" id="_005cindent"> <title><literal>\indent</literal></title> + <indexterm role="fn"><primary>\indent</primary></indexterm> <indexterm role="fn"><primary>\parindent</primary></indexterm> <indexterm role="cp"><primary>indent, forcing</primary></indexterm> -<para><literal>\indent</literal> produces a horizontal space whose width equals the -width of the <literal>\parindent</literal> length, the normal paragraph -indentation. It is used to add paragraph indentation where it would -otherwise be suppressed. +<para><literal>\indent</literal> produces a horizontal space whose width equals to the +<literal>\parindent</literal> length, the normal paragraph indentation. It is used +to add paragraph indentation where it would otherwise be suppressed. </para> <para>The default value for <literal>\parindent</literal> is <literal>1em</literal> in two-column mode, otherwise <literal>15pt</literal> for <literal>10pt</literal> documents, <literal>17pt</literal> for @@ -3858,17 +5458,27 @@ mode, otherwise <literal>15pt</literal> for <literal>10pt</literal> documents, < </sect1> <sect1 label="15.2" id="_005cnoindent"> <title><literal>\noindent</literal></title> + <indexterm role="fn"><primary>\noindent</primary></indexterm> <indexterm role="cp"><primary>indent, suppressing</primary></indexterm> -<para>When used at the beginning of the paragraph, <literal>\noindent</literal> -suppresses any paragraph indentation. It has no effect when used in -the middle of a paragraph. +<para>When used at the beginning of the paragraph, this command suppresses any +paragraph indentation, as in this example. +</para> +<screen>.. end of the prior paragraph. + +\noindent This paragraph is not indented. +</screen> +<para>It has no effect when used in the middle of a paragraph. +</para> +<para>To eliminate paragraph indentation in an entire document, put +<literal>\setlength{\parindent}{0pt}</literal> in the preamble. </para> </sect1> <sect1 label="15.3" id="_005cparskip"> <title><literal>\parskip</literal></title> + <indexterm role="fn"><primary>\parskip</primary></indexterm> <indexterm role="cp"><primary>vertical space before paragraphs</primary></indexterm> @@ -3879,6 +5489,7 @@ before each paragraph. The default is <literal>0pt plus1pt</literal>. </sect1> <sect1 label="15.4" id="Marginal-notes"> <title>Marginal notes</title> + <indexterm role="cp"><primary>marginal notes</primary></indexterm> <indexterm role="cp"><primary>notes in the margin</primary></indexterm> <indexterm role="cp"><primary>remarks in the margin</primary></indexterm> @@ -3895,9 +5506,9 @@ where the <literal>\marginpar</literal> occurs. <para>When you only specify the mandatory argument <replaceable>right</replaceable>, the text will be placed </para> -<itemizedlist><listitem><para>in the right margin for one-sided layout; -</para></listitem><listitem><para>in the outside margin for two-sided layout; -</para></listitem><listitem><para>in the nearest margin for two-column layout. +<itemizedlist><listitem><para>in the right margin for one-sided layout (option <literal>oneside</literal>, see <link linkend="Document-class-options">Document class options</link>); +</para></listitem><listitem><para>in the outside margin for two-sided layout (option <literal>twoside</literal>, see <link linkend="Document-class-options">Document class options</link>); +</para></listitem><listitem><para>in the nearest margin for two-column layout (option <literal>twocolumn</literal>, see <link linkend="Document-class-options">Document class options</link>). </para></listitem></itemizedlist> <indexterm role="fn"><primary>\reversemarginpar</primary></indexterm> <indexterm role="fn"><primary>\normalmarginpar</primary></indexterm> @@ -3939,13 +5550,14 @@ notes from falling off the bottom of the page. </chapter> <chapter label="16" id="Math-formulas"> <title>Math formulas</title> + <indexterm role="cp"><primary>math formulas</primary></indexterm> <indexterm role="cp"><primary>formulas, math</primary></indexterm> <indexterm role="cp"><primary>math mode, entering</primary></indexterm> - <indexterm role="fn"><primary>math environment</primary></indexterm> <indexterm role="fn"><primary>displaymath environment</primary></indexterm> <indexterm role="fn"><primary>equation environment</primary></indexterm> + <para>There are three environments that put &latex; in math mode: </para> <variablelist><varlistentry><term><literal>math</literal> @@ -3985,8 +5597,9 @@ it too is used <emphasis>outside</emphasis> of math mode. <indexterm role="fn"><primary>\displaystyle</primary></indexterm> <para>The <literal>\displaystyle</literal> declaration forces the size and style of the formula to be that of <literal>displaymath</literal>, e.g., with limits above and -below summations. For example -</para><screen>$\displaystyle \sum_{n=0}^\infty x_n $ +below summations. For example: +</para> +<screen>$\displaystyle \sum_{n=0}^\infty x_n $ </screen> <!-- xx see also \cal, \mathcal --> @@ -3994,668 +5607,925 @@ below summations. For example <sect1 label="16.1" id="Subscripts-_0026-superscripts"> <title>Subscripts & superscripts</title> + <indexterm role="cp"><primary>superscript</primary></indexterm> <indexterm role="cp"><primary>subscript</primary></indexterm> <indexterm role="cp"><primary>exponent</primary></indexterm> <indexterm role="fn"><primary>_</primary></indexterm> <indexterm role="fn"><primary>^</primary></indexterm> -<para>To get an expression <emphasis>exp</emphasis> to appear as a subscript, you just type -<literal>_{</literal><emphasis>exp</emphasis><literal>}</literal>. To get <emphasis>exp</emphasis> to appear as a -superscript, you type <literal>^{</literal><emphasis>exp</emphasis><literal>}</literal>. &latex; handles -superscripted superscripts and all of that stuff in the natural way. -It even does the right thing when something has both a subscript and a -superscript. +<para>In math mode, use the caret character <literal>^</literal> to make the +<replaceable>exp</replaceable> appear as a superscript, ie. type <literal>^{<replaceable>exp</replaceable>}</literal>. +Similarly, in math mode, underscore <literal>_{<replaceable>exp</replaceable>}</literal> makes a +subscript out of <replaceable>exp</replaceable>. +</para> +<para>In this example the <literal>0</literal> and <literal>1</literal> appear as subscripts while the +<literal>2</literal> is a superscript. +</para> +<screen>\( (x_0+x_1)^2 \) +</screen> +<para>To have more than one character in <replaceable>exp</replaceable> use curly braces as in +<literal>e^{-2x}</literal>. +</para> +<para>&latex; handles superscripts on superscripts, and all of that stuff, in +the natural way, so expressions such as <literal>e^{x^2}</literal> and +<literal>x_{a_0}</literal> will look right. It also does the right thing when +something has both a subscript and a superscript. In this example the +<literal>0</literal> appears at the bottom of the integral sign while the <literal>10</literal> +appears at the top. +</para> +<screen>\int_0^{10} x^2 \,dx +</screen> +<para>You can put a superscript or subscript before a symbol with a construct +such as <literal>{}_t K^2</literal> in math mode (the initial <literal>{}</literal> prevents +the prefixed subscript from being attached to any prior symbols in the +expression). +</para> +<para>Outside of math mode, a construct like <literal>A +test$_\textnormal{subscript}$</literal> will produce a subscript typeset in +text mode, not math mode. Note that there are packages specialized for +writing Chemical formulas such as <filename>mhchem</filename>. +<!-- xx display mode --> </para> </sect1> <sect1 label="16.2" id="Math-symbols"> <title>Math symbols</title> + <indexterm role="cp"><primary>math symbols</primary></indexterm> <indexterm role="cp"><primary>symbols, math</primary></indexterm> <indexterm role="cp"><primary>greek letters</primary></indexterm> -<para>&latex; provides almost any mathematical symbol you’re likely to -need. The commands for generating them can be used only in math mode. +<para>&latex; provides almost any mathematical symbol you’re likely to need. For example, if you include <literal>$\pi$</literal> in your source, you will get -the pi symbol (<inlineequation><mathphrase>\pi</mathphrase></inlineequation>) in your output. +the pi symbol π. +</para> +<para>Below is a list of commonly-available symbols. It is by no means an +exhaustive list. Each symbol here is described with a short phrase, and +its symbol class (which determines the spacing around it) is given in +parenthesis. The commands for these symbols can be used only in math +mode. </para> +<!-- xx Add Negation: @code{} for negations of relevant symbols --> +<!-- Useful: http://www.w3.org/TR/WD-math-970515/section6.html --> + <variablelist><varlistentry><term><indexterm role="fn"><primary>\|</primary></indexterm><literal>\|</literal> -</term><listitem><para><inlineequation><mathphrase>\|</mathphrase></inlineequation> +</term><listitem><para>∥ Parallel (relation). Synonym: <literal>\parallel</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\aleph</primary></indexterm><literal>\aleph</literal> -</term><listitem><para><inlineequation><mathphrase>\aleph</mathphrase></inlineequation> +</term><listitem><para>ℵ Aleph, transfinite cardinal (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\alpha</primary></indexterm><literal>\alpha</literal> -</term><listitem><para><inlineequation><mathphrase>\alpha</mathphrase></inlineequation> +</term><listitem><para>α Lower case Greek letter alpha (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\amalg</primary></indexterm><literal>\amalg</literal> -</term><listitem><para><inlineequation><mathphrase>\amalg</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⨿ Disjoint union (binary) </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\angle</primary></indexterm><literal>\angle</literal> -</term><listitem><para><inlineequation><mathphrase>\angle</mathphrase></inlineequation> +</term><listitem><para>∠ Geometric angle (ordinary). Similar: less-than +sign <literal><</literal> and angle bracket <literal>\langle</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\approx</primary></indexterm><literal>\approx</literal> -</term><listitem><para><inlineequation><mathphrase>\approx</mathphrase></inlineequation> (relation) +</term><listitem><para>≈ Almost equal to (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ast</primary></indexterm><literal>\ast</literal> -</term><listitem><para><inlineequation><mathphrase>\ast</mathphrase></inlineequation> (binary operation) +</term><listitem><para>∗ Asterisk operator, convolution, six-pointed +(binary). Synonym: <literal>*</literal>, which is often a superscript or +subscript, as in the Kleene star. Similar: <literal>\star</literal>, which is +five-pointed, and is sometimes used as a general binary operation, and +sometimes reserved for cross-correlation. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\asymp</primary></indexterm><literal>\asymp</literal> -</term><listitem><para><inlineequation><mathphrase>\asymp</mathphrase></inlineequation> (relation) +</term><listitem><para>≍ Asymptomatically equivalent (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\backslash</primary></indexterm><literal>\backslash</literal> -</term><listitem><para>\ (delimiter) +</term><listitem><para>\ Backslash (ordinary). Similar: set minus <literal>\setminus</literal>, and +<literal>\textbackslash</literal> for backslash outside of math mode. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\beta</primary></indexterm><literal>\beta</literal> -</term><listitem><para><inlineequation><mathphrase>\beta</mathphrase></inlineequation> +</term><listitem><para>β Lower case Greek letter beta (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcap</primary></indexterm><literal>\bigcap</literal> -</term><listitem><para><inlineequation><mathphrase>\bigcap</mathphrase></inlineequation> +</term><listitem><para>⋂ Variable-sized, or n-ary, intersection (operator). Similar: +binary intersection <literal>\cap</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcirc</primary></indexterm><literal>\bigcirc</literal> -</term><listitem><para><inlineequation><mathphrase>\bigcirc</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⚪ Circle, larger (binary). Similar: function +composition <literal>\circ</literal>. +<!-- bb Best unicode symbol for this? --> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcup</primary></indexterm><literal>\bigcup</literal> -</term><listitem><para><inlineequation><mathphrase>\bigcup</mathphrase></inlineequation> +</term><listitem><para>⋃ Variable-sized, or n-ary, union (operator). Similar: binary +union <literal>\cup</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigodot</primary></indexterm><literal>\bigodot</literal> -</term><listitem><para><inlineequation><mathphrase>\bigodot</mathphrase></inlineequation> +</term><listitem><para>⨀ Variable-sized, or n-ary, circled dot operator (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigoplus</primary></indexterm><literal>\bigoplus</literal> -</term><listitem><para><inlineequation><mathphrase>\bigoplus</mathphrase></inlineequation> +</term><listitem><para>⨁ Variable-sized, or n-ary, circled plus operator (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigotimes</primary></indexterm><literal>\bigotimes</literal> -</term><listitem><para><inlineequation><mathphrase>\bigotimes</mathphrase></inlineequation> +</term><listitem><para>⨂ Variable-sized, or n-ary, circled times operator (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigtriangledown</primary></indexterm><literal>\bigtriangledown</literal> -</term><listitem><para><inlineequation><mathphrase>\bigtriangledown</mathphrase></inlineequation> (binary operation) +</term><listitem><para>▽ Variable-sized, or n-ary, open triangle pointing down +(operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigtriangleup</primary></indexterm><literal>\bigtriangleup</literal> -</term><listitem><para><inlineequation><mathphrase>\bigtriangleup</mathphrase></inlineequation> (binary operation) +</term><listitem><para>△ Variable-sized, or n-ary, open triangle pointing up (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigsqcup</primary></indexterm><literal>\bigsqcup</literal> -</term><listitem><para><inlineequation><mathphrase>\bigsqcup</mathphrase></inlineequation> +</term><listitem><para>⨆ Variable-sized, or n-ary, square union (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\biguplus</primary></indexterm><literal>\biguplus</literal> -</term><listitem><para><inlineequation><mathphrase>\biguplus</mathphrase></inlineequation> +</term><listitem><para>⨄ Variable-sized, or n-ary, union operator with a plus +(operator). (Note that the name has only one p.) </para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcap</primary></indexterm><literal>\bigcap</literal> -</term><listitem><para><inlineequation><mathphrase>\bigvee</mathphrase></inlineequation> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigvee</primary></indexterm><literal>\bigvee</literal> +</term><listitem><para>⋁ Variable-sized, or n-ary, logical-and (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigwedge</primary></indexterm><literal>\bigwedge</literal> -</term><listitem><para><inlineequation><mathphrase>\bigwedge</mathphrase></inlineequation> +</term><listitem><para>⋀ Variable-sized, or n-ary, logical-or (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bot</primary></indexterm><literal>\bot</literal> -</term><listitem><para><inlineequation><mathphrase>\bot</mathphrase></inlineequation> +</term><listitem><para>⊥ Up tack, bottom, least element of a poset, or a contradiction +(ordinary). See also <literal>\top</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bowtie</primary></indexterm><literal>\bowtie</literal> -</term><listitem><para><inlineequation><mathphrase>\bowtie</mathphrase></inlineequation> (relation) +</term><listitem><para>⋈ Natural join of two relations (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Box</primary></indexterm><literal>\Box</literal> -</term><listitem><para>(square open box symbol) <!-- xx not in plain --> +</term><listitem><para>□ Modal operator for necessity; square open box (ordinary). This +is not available in Plain &tex;. In &latex; you need to load the +<filename>amssymb</filename> package. +<!-- bb Best Unicode equivalent? --> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bullet</primary></indexterm><literal>\bullet</literal> </term><listitem><indexterm role="cp"><primary>bullet symbol</primary></indexterm> -<para><inlineequation><mathphrase>\bullet</mathphrase></inlineequation> (binary operation) +<para>• Bullet (binary). Similar: multiplication +dot <literal>\cdot</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cap</primary></indexterm><literal>\cap</literal> -</term><listitem><para><inlineequation><mathphrase>\cap</mathphrase></inlineequation> (binary operation) +</term><listitem><para>∩ Intersection of two sets (binary). Similar: variable-sized +operator <literal>\bigcap</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cdot</primary></indexterm><literal>\cdot</literal> -</term><listitem><para><inlineequation><mathphrase>\cdot</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⋅ Multiplication (binary). Similar: Bullet +dot <literal>\bullet</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\chi</primary></indexterm><literal>\chi</literal> -</term><listitem><para><inlineequation><mathphrase>\chi</mathphrase></inlineequation> +</term><listitem><para>χ Lower case Greek chi (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\circ</primary></indexterm><literal>\circ</literal> -</term><listitem><para><inlineequation><mathphrase>\circ</mathphrase></inlineequation> (binary operation) +</term><listitem><para>∘ Function composition, ring operator (binary). Similar: +variable-sized operator <literal>\bigcirc</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\clubsuit</primary></indexterm><literal>\clubsuit</literal> -</term><listitem><para><inlineequation><mathphrase>\clubsuit</mathphrase></inlineequation> +</term><listitem><para>♣ Club card suit (ordinary). +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\complement</primary></indexterm><literal>\complement</literal> +</term><listitem><para>∁ Set complement, used as a superscript as in +<literal>$S^\complement$</literal> (ordinary). This is not available in Plain +&tex;. In &latex; you should load the <filename>amssymb</filename> package. Also +used: <literal>$S^{\mathsf{c}}$</literal> or <literal>$\bar{S}$</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cong</primary></indexterm><literal>\cong</literal> -</term><listitem><para><inlineequation><mathphrase>\cong</mathphrase></inlineequation> (relation) +</term><listitem><para>≅ Congruent (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\coprod</primary></indexterm><literal>\coprod</literal> -</term><listitem><para><inlineequation><mathphrase>\coprod</mathphrase></inlineequation> +</term><listitem><para>∐ Coproduct (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cup</primary></indexterm><literal>\cup</literal> -</term><listitem><para><inlineequation><mathphrase>\cup</mathphrase></inlineequation> (binary operation) +</term><listitem><para>∪ Union of two sets (binary). Similar: variable-sized +operator <literal>\bigcup</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dagger</primary></indexterm><literal>\dagger</literal> -</term><listitem><para><inlineequation><mathphrase>\dagger</mathphrase></inlineequation> (binary operation) +</term><listitem><para>† Dagger relation (binary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dashv</primary></indexterm><literal>\dashv</literal> -</term><listitem><para><inlineequation><mathphrase>\dashv</mathphrase></inlineequation> (relation) +</term><listitem><para>⊣ Dash with vertical, reversed turnstile (relation). Similar: +turnstile <literal>\vdash</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ddagger</primary></indexterm><literal>\ddagger</literal> -</term><listitem><para><inlineequation><mathphrase>\dagger</mathphrase></inlineequation> (binary operation) +</term><listitem><para>‡ Double dagger relation (binary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Delta</primary></indexterm><literal>\Delta</literal> -</term><listitem><para><inlineequation><mathphrase>\Delta</mathphrase></inlineequation> +</term><listitem><para>Δ Greek upper case delta, used for increment (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\delta</primary></indexterm><literal>\delta</literal> -</term><listitem><para><inlineequation><mathphrase>\delta</mathphrase></inlineequation> +</term><listitem><para>δ Greek lower case delta (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Diamond</primary></indexterm><literal>\Diamond</literal> -</term><listitem><para>bigger <inlineequation><mathphrase>\diamond</mathphrase></inlineequation> <!-- xx not in plain --> +</term><listitem><para>◇ Large diamond operator (ordinary). This is not available in +Plain &tex;. In &latex; you must load the <filename>amssymb</filename> package. +<!-- bb Best Unicode equivalent? --> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\diamond</primary></indexterm><literal>\diamond</literal> -</term><listitem><para><inlineequation><mathphrase>\diamond</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⋄ Diamond operator, or diamond bullet (binary). Similar: large +diamond <literal>\Diamond</literal>, circle bullet <literal>\bullet</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\diamondsuit</primary></indexterm><literal>\diamondsuit</literal> -</term><listitem><para><inlineequation><mathphrase>\diamondsuit</mathphrase></inlineequation> +</term><listitem><para>♢ Diamond card suit (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\div</primary></indexterm><literal>\div</literal> -</term><listitem><para><inlineequation><mathphrase>\div</mathphrase></inlineequation> (binary operation) +</term><listitem><para>÷ Division sign (binary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\doteq</primary></indexterm><literal>\doteq</literal> -</term><listitem><para><inlineequation><mathphrase>\doteq</mathphrase></inlineequation> (relation) +</term><listitem><para>≐ Approaches the limit (relation). Similar: geometrically equal +to <literal>\Doteq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\downarrow</primary></indexterm><literal>\downarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\downarrow</mathphrase></inlineequation> (delimiter) +</term><listitem><para>↓ Down arrow, converges (relation). Similar: double line down +arrow <literal>\Downarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Downarrow</primary></indexterm><literal>\Downarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\Downarrow</mathphrase></inlineequation> (delimiter) +</term><listitem><para>⇓ Double line down arrow (relation). Similar: single line down +arrow <literal>\downarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ell</primary></indexterm><literal>\ell</literal> -</term><listitem><para><inlineequation><mathphrase>\ell</mathphrase></inlineequation> +</term><listitem><para>ℓ Lower-case cursive letter l (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\emptyset</primary></indexterm><literal>\emptyset</literal> -</term><listitem><para><inlineequation><mathphrase>\emptyset</mathphrase></inlineequation> +</term><listitem><para>∅ Empty set symbol (ordinary). Similar: reversed empty +set <literal>\varnothing</literal>. +<!-- bb Why Unicode has \revemptyset but no \emptyset? --> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\epsilon</primary></indexterm><literal>\epsilon</literal> -</term><listitem><para><inlineequation><mathphrase>\epsilon</mathphrase></inlineequation> +</term><listitem><para>ϵ Lower case Greek-text letter (ordinary). More widely used in +mathematics is the curly epsilon +<literal>\varepsilon</literal> ε. Related: the set membership relation +<literal>\in</literal> ∈. +<!-- src: David Carlisle http://tex.stackexchange.com/a/98018/339 and --> +<!-- Unicode referenced there asserts varepsilon is much more widely used. --> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\equiv</primary></indexterm><literal>\equiv</literal> -</term><listitem><para><inlineequation><mathphrase>\equiv</mathphrase></inlineequation> (relation) +</term><listitem><para>≡ Equivalence (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\eta</primary></indexterm><literal>\eta</literal> -</term><listitem><para><inlineequation><mathphrase>\eta</mathphrase></inlineequation> +</term><listitem><para>η Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\exists</primary></indexterm><literal>\exists</literal> -</term><listitem><para><inlineequation><mathphrase>\exists</mathphrase></inlineequation> +</term><listitem><para>∃ Existential quantifier (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\flat</primary></indexterm><literal>\flat</literal> -</term><listitem><para><inlineequation><mathphrase>\flat</mathphrase></inlineequation> +</term><listitem><para>♭ Musical flat (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\forall</primary></indexterm><literal>\forall</literal> -</term><listitem><para><inlineequation><mathphrase>\forall</mathphrase></inlineequation> +</term><listitem><para>∀ Universal quantifier (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\frown</primary></indexterm><literal>\frown</literal> -</term><listitem><para><inlineequation><mathphrase>\frown</mathphrase></inlineequation> (relation) +</term><listitem><para>⌢ Downward curving arc (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Gamma</primary></indexterm><literal>\Gamma</literal> -</term><listitem><para><inlineequation><mathphrase>\Gamma</mathphrase></inlineequation> +</term><listitem><para>Γ Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\gamma</primary></indexterm><literal>\gamma</literal> -</term><listitem><para><inlineequation><mathphrase>\gamma</mathphrase></inlineequation> +</term><listitem><para>γ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ge</primary></indexterm><literal>\ge</literal> -</term><listitem><para><inlineequation><mathphrase>\ge</mathphrase></inlineequation> +</term><listitem><para>≥ Greater than or equal to (relation). This is a synonym +for <literal>\geq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\geq</primary></indexterm><literal>\geq</literal> -</term><listitem><para><inlineequation><mathphrase>\geq</mathphrase></inlineequation> (relation) +</term><listitem><para>≥ Greater than or equal to (relation). This is a synonym +for <literal>\ge</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\gets</primary></indexterm><literal>\gets</literal> -</term><listitem><para><inlineequation><mathphrase>\gets</mathphrase></inlineequation> +</term><listitem><para>← Is assigned the value (relation). +Synonym: <literal>\leftarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\gg</primary></indexterm><literal>\gg</literal> -</term><listitem><para><inlineequation><mathphrase>\gg</mathphrase></inlineequation> (relation) +</term><listitem><para>≫ Much greater than (relation). Similar: much less +than <literal>\ll</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hbar</primary></indexterm><literal>\hbar</literal> -</term><listitem><para><inlineequation><mathphrase>\hbar</mathphrase></inlineequation> +</term><listitem><para>ℏ Planck constant over two pi (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\heartsuit</primary></indexterm><literal>\heartsuit</literal> -</term><listitem><para><inlineequation><mathphrase>\heartsuit</mathphrase></inlineequation> +</term><listitem><para>♡ Heart card suit (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hookleftarrow</primary></indexterm><literal>\hookleftarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\hookleftarrow</mathphrase></inlineequation> +</term><listitem><para>↩ Hooked left arrow (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hookrightarrow</primary></indexterm><literal>\hookrightarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\hookrightarrow</mathphrase></inlineequation> +</term><listitem><para>↪ Hooked right arrow (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\iff</primary></indexterm><literal>\iff</literal> -</term><listitem><para><inlineequation><mathphrase>\iff</mathphrase></inlineequation> +</term><listitem><para>⟷ If and only if (relation). It is <literal>\Longleftrightarrow</literal> +with a <literal>\thickmuskip</literal> on either side. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Im</primary></indexterm><literal>\Im</literal> -</term><listitem><para><inlineequation><mathphrase>\Im</mathphrase></inlineequation> +</term><listitem><para>ℑ Imaginary part (ordinary). See: real part <literal>\Re</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\in</primary></indexterm><literal>\in</literal> -</term><listitem><para><inlineequation><mathphrase>\in</mathphrase></inlineequation> (relation) +</term><listitem><para>∈ Set element (relation). See also: lower case Greek letter +epsilon <literal>\epsilon</literal>ϵ and rounded small +epsilon <literal>\varepsilon</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\infty</primary></indexterm><literal>\infty</literal> -</term><listitem><para><inlineequation><mathphrase>\infty</mathphrase></inlineequation> +</term><listitem><para>∞ Infinity (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\int</primary></indexterm><literal>\int</literal> -</term><listitem><para><inlineequation><mathphrase>\int</mathphrase></inlineequation> +</term><listitem><para>∫ Integral (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\iota</primary></indexterm><literal>\iota</literal> -</term><listitem><para><inlineequation><mathphrase>\iota</mathphrase></inlineequation> +</term><listitem><para>ι Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Join</primary></indexterm><literal>\Join</literal> -</term><listitem><para>condensed bowtie symbol (relation) <!-- xx not in plain --> +</term><listitem><para>⨝ Condensed bowtie symbol (relation). Not available in Plain +&tex;. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\kappa</primary></indexterm><literal>\kappa</literal> -</term><listitem><para><inlineequation><mathphrase>\kappa</mathphrase></inlineequation> +</term><listitem><para>κ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Lambda</primary></indexterm><literal>\Lambda</literal> -</term><listitem><para><inlineequation><mathphrase>\Lambda</mathphrase></inlineequation> +</term><listitem><para>Λ Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lambda</primary></indexterm><literal>\lambda</literal> -</term><listitem><para><inlineequation><mathphrase>\lambda</mathphrase></inlineequation> +</term><listitem><para>λ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\land</primary></indexterm><literal>\land</literal> -</term><listitem><para><inlineequation><mathphrase>\land</mathphrase></inlineequation> +</term><listitem><para>∧ Logical and (binary). This is a synonym for <literal>\wedge</literal>. +See also logical or <literal>\lor</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\langle</primary></indexterm><literal>\langle</literal> -</term><listitem><para><inlineequation><mathphrase>\langle</mathphrase></inlineequation> (delimiter) +</term><listitem><para>⟨ Left angle, or sequence, bracket (opening). Similar: +less-than <literal><</literal>. Matches <literal>\rangle</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lbrace</primary></indexterm><literal>\lbrace</literal> -</term><listitem><para><inlineequation><mathphrase>\lbrace</mathphrase></inlineequation> (delimiter) +</term><listitem><para>{ Left curly brace +(opening). Synonym: <literal>\{</literal>. Matches <literal>\rbrace</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lbrack</primary></indexterm><literal>\lbrack</literal> -</term><listitem><para><inlineequation><mathphrase>\lbrack</mathphrase></inlineequation> (delimiter) +</term><listitem><para>[ Left square bracket (opening). +Synonym: <literal>[</literal>. Matches <literal>\rbrack</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lceil</primary></indexterm><literal>\lceil</literal> -</term><listitem><para><inlineequation><mathphrase>\lceil</mathphrase></inlineequation> (delimiter) +</term><listitem><para>⌈ Left ceiling bracket, like a square bracket but with the bottom +shaved off (opening). Matches <literal>\rceil</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\le</primary></indexterm><literal>\le</literal> -</term><listitem><para><inlineequation><mathphrase>\le</mathphrase></inlineequation> +</term><listitem><para>≤ Less than or equal to (relation). This is a synonym +for <literal>\leq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leadsto</primary></indexterm><literal>\leadsto</literal> -</term><listitem><!-- xx missing from plain --> - +</term><listitem><para>⇝ Squiggly right arrow (relation). This is not available in +Plain &tex;. In &latex; you should load the <filename>amssymb</filename> package. +To get this symbol outside of math mode you can put +<literal>\newcommand*{\Leadsto}{\ensuremath{\leadsto}}</literal> in the +preamble and then use <literal>\Leadsto</literal> instead. +<!-- bb Best Unicode equivalent? --> +</para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Leftarrow</primary></indexterm><literal>\Leftarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\Leftarrow</mathphrase></inlineequation> +</term><listitem><para>⇐ Is implied by, double-line left arrow (relation). Similar: +single-line left arrow <literal>\leftarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftarrow</primary></indexterm><literal>\leftarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\leftarrow</mathphrase></inlineequation> +</term><listitem><para>← Single-line left arrow (relation). +Synonym: <literal>\gets</literal>. Similar: double-line left +arrow <literal>\Leftarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftharpoondown</primary></indexterm><literal>\leftharpoondown</literal> -</term><listitem><para><inlineequation><mathphrase>\leftharpoondown</mathphrase></inlineequation> +</term><listitem><para>↽ Single-line left harpoon, barb under bar (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftharpoonup</primary></indexterm><literal>\leftharpoonup</literal> -</term><listitem><para><inlineequation><mathphrase>\leftharpoonup</mathphrase></inlineequation> +</term><listitem><para>↼ Single-line left harpoon, barb over bar (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Leftrightarrow</primary></indexterm><literal>\Leftrightarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\Leftrightarrow</mathphrase></inlineequation> +</term><listitem><para>⇔ Bi-implication; double-line double-headed arrow (relation). +Similar: single-line double headed arrow <literal>\leftrightarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftrightarrow</primary></indexterm><literal>\leftrightarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\leftrightarrow</mathphrase></inlineequation> +</term><listitem><para>↔ Single-line double-headed arrow (relation). Similar: +double-line double headed arrow <literal>\Leftrightarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leq</primary></indexterm><literal>\leq</literal> -</term><listitem><para><inlineequation><mathphrase>\leq</mathphrase></inlineequation> (relation) +</term><listitem><para>≤ Less than or equal to (relation). This is a synonym +for <literal>\le</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lfloor</primary></indexterm><literal>\lfloor</literal> -</term><listitem><para><inlineequation><mathphrase>\lfloor</mathphrase></inlineequation> (delimiter) +</term><listitem><para>⌊ Left floor bracket (opening). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lhd</primary></indexterm><literal>\lhd</literal> -</term><listitem><para>(left-pointing arrow head) <!-- xx not in plain --> +</term><listitem><para>◁ Arrowhead, that is, triangle, pointing left (binary). This is +not available in Plain &tex;. In &latex; you should load the +<filename>amssymb</filename> package. For the normal subgroup symbol you should load +<filename>amssymb</filename> and use <literal>\vartriangleleft</literal> (which is a relation +and so gives better spacing). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ll</primary></indexterm><literal>\ll</literal> -</term><listitem><para><inlineequation><mathphrase>\ll</mathphrase></inlineequation> (relation) +</term><listitem><para>≪ Much less than (relation). Similar: much greater +than <literal>\gg</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lnot</primary></indexterm><literal>\lnot</literal> -</term><listitem><para><inlineequation><mathphrase>\lnot</mathphrase></inlineequation> +</term><listitem><para>¬ Logical negation (ordinary). Synonym: <literal>\neg</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longleftarrow</primary></indexterm><literal>\longleftarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\longleftarrow</mathphrase></inlineequation> +</term><listitem><para>⟵ Long single-line left arrow (relation). Similar: long +double-line left arrow <literal>\Longleftarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longleftrightarrow</primary></indexterm><literal>\longleftrightarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\longleftrightarrow</mathphrase></inlineequation> +</term><listitem><para>⟷ Long single-line double-headed arrow (relation). Similar: long +double-line double-headed arrow <literal>\Longleftrightarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longmapsto</primary></indexterm><literal>\longmapsto</literal> -</term><listitem><para><inlineequation><mathphrase>\longmapsto</mathphrase></inlineequation> +</term><listitem><para>⟼ Long single-line left arrow starting with vertical bar +(relation). Similar: shorter version <literal>\mapsto</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longrightarrow</primary></indexterm><literal>\longrightarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\longrightarrow</mathphrase></inlineequation> +</term><listitem><para>⟶ Long single-line right arrow (relation). Similar: long +double-line right arrow <literal>\Longrightarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lor</primary></indexterm><literal>\lor</literal> -</term><listitem><para><inlineequation><mathphrase>\lor</mathphrase></inlineequation> +</term><listitem><para>∨ Logical or (binary). Synonym: wedge <literal>\wedge</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mapsto</primary></indexterm><literal>\mapsto</literal> -</term><listitem><para><inlineequation><mathphrase>\mapsto</mathphrase></inlineequation> +</term><listitem><para>↦ Single-line left arrow starting with vertical bar (relation). +Similar: longer version <literal>\longmapsto</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mho</primary></indexterm><literal>\mho</literal> -</term><listitem><!-- xx not in plain --> - +</term><listitem><para>℧ Conductance, half-circle rotated capital omega (ordinary). +This is not available in Plain &tex;. In &latex; you should load the +<filename>amssymb</filename> package. +</para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mid</primary></indexterm><literal>\mid</literal> -</term><listitem><para><inlineequation><mathphrase>\mid</mathphrase></inlineequation> (relation) +</term><listitem><para>∣ Single-line vertical bar (relation). A typical use of +<literal>\mid</literal> is for a set <literal>\{\, x \mid x\geq 5 \,\}</literal>. +</para> +<para>Similar: <literal>\vert</literal> and <literal>|</literal> produce the same single-line +vertical bar symbol but without any spacing (they fall in class +ordinary) and you should not use them as relations but instead only as +ordinals, i.e., footnote symbols. For absolute value, see the entry +for <literal>\vert</literal> and for norm see the entry for <literal>\Vert</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\models</primary></indexterm><literal>\models</literal> -</term><listitem><para><inlineequation><mathphrase>\models</mathphrase></inlineequation> (relation) +</term><listitem><para>⊨ Entails, or satisfies; double turnstile, short double dash +(relation). Similar: long double dash <literal>\vDash</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mp</primary></indexterm><literal>\mp</literal> -</term><listitem><para><inlineequation><mathphrase>\mp</mathphrase></inlineequation> (binary operation) +</term><listitem><para>∓ Minus or plus (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mu</primary></indexterm><literal>\mu</literal> -</term><listitem><para><inlineequation><mathphrase>\mu</mathphrase></inlineequation> +</term><listitem><para>μ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nabla</primary></indexterm><literal>\nabla</literal> -</term><listitem><para><inlineequation><mathphrase>\nabla</mathphrase></inlineequation> +</term><listitem><para>∇ Hamilton’s del, or differential, operator (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\natural</primary></indexterm><literal>\natural</literal> -</term><listitem><para><inlineequation><mathphrase>\natural</mathphrase></inlineequation> +</term><listitem><para>♮ Musical natural notation (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ne</primary></indexterm><literal>\ne</literal> -</term><listitem><para><inlineequation><mathphrase>\ne</mathphrase></inlineequation> +</term><listitem><para>≠ Not equal (relation). Synonym: <literal>\neq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nearrow</primary></indexterm><literal>\nearrow</literal> -</term><listitem><para><inlineequation><mathphrase>\nearrow</mathphrase></inlineequation> +</term><listitem><para>↗ North-east arrow (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\neg</primary></indexterm><literal>\neg</literal> -</term><listitem><para><inlineequation><mathphrase>\neg</mathphrase></inlineequation> +</term><listitem><para>¬ Logical negation (ordinary). +Synonym: <literal>\lnot</literal>. Sometimes instead used for +negation: <literal>\sim</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\neq</primary></indexterm><literal>\neq</literal> -</term><listitem><para><inlineequation><mathphrase>\neq</mathphrase></inlineequation> (relation) +</term><listitem><para>≠ Not equal (relation). Synonym: <literal>\ne</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ni</primary></indexterm><literal>\ni</literal> -</term><listitem><para><inlineequation><mathphrase>\ni</mathphrase></inlineequation> (relation) +</term><listitem><para>∋ Reflected membership epsilon; has the member +(relation). Synonym: <literal>\owns</literal>. Similar: is a member +of <literal>\in</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\not</primary></indexterm><literal>\not</literal> -</term><listitem><para>Overstrike a following operator with a /, as in <inlineequation><mathphrase>\not=</mathphrase></inlineequation>. +</term><listitem><para>  ̸ Long solidus, or slash, used to overstrike a +following operator (relation). +<!-- Need blank space for it to overstrike --> +</para> +<para>Many negated operators that don’t require <literal>\not</literal> are available, +particularly with the <filename>amssymb</filename> package. For example, <literal>\notin</literal> +is probably typographically preferable to <literal>\not\in</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\notin</primary></indexterm><literal>\notin</literal> -</term><listitem><para><inlineequation><mathphrase>\ni</mathphrase></inlineequation> +</term><listitem><para>∉ Not an element of (relation). Similar: not subset +of <literal>\nsubseteq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nu</primary></indexterm><literal>\nu</literal> -</term><listitem><para><inlineequation><mathphrase>\nu</mathphrase></inlineequation> +</term><listitem><para>ν Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nwarrow</primary></indexterm><literal>\nwarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\nwarrow</mathphrase></inlineequation> +</term><listitem><para>↖ North-west arrow (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\odot</primary></indexterm><literal>\odot</literal> -</term><listitem><para><inlineequation><mathphrase>\odot</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊙ Dot inside a circle (binary). Similar: variable-sized +operator <literal>\bigodot</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\oint</primary></indexterm><literal>\oint</literal> -</term><listitem><para><inlineequation><mathphrase>\oint</mathphrase></inlineequation> +</term><listitem><para>∮ Contour integral, integral with circle in the middle (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Omega</primary></indexterm><literal>\Omega</literal> -</term><listitem><para><inlineequation><mathphrase>\Omega</mathphrase></inlineequation> +</term><listitem><para>Ω Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\omega</primary></indexterm><literal>\omega</literal> -</term><listitem><para><inlineequation><mathphrase>\omega</mathphrase></inlineequation> +</term><listitem><para>ω Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ominus</primary></indexterm><literal>\ominus</literal> -</term><listitem><para><inlineequation><mathphrase>\ominus</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊖ Minus sign, or dash, inside a circle (binary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\oplus</primary></indexterm><literal>\oplus</literal> -</term><listitem><para><inlineequation><mathphrase>\oplus</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊕ Plus sign inside a circle (binary). Similar: variable-sized +operator <literal>\bigoplus</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\oslash</primary></indexterm><literal>\oslash</literal> -</term><listitem><para><inlineequation><mathphrase>\oslash</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊘ Solidus, or slash, inside a circle (binary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\otimes</primary></indexterm><literal>\otimes</literal> -</term><listitem><para><inlineequation><mathphrase>\otimes</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊗ Times sign, or cross, inside a circle (binary). Similar: +variable-sized operator <literal>\bigotimes</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\owns</primary></indexterm><literal>\owns</literal> -</term><listitem><para><inlineequation><mathphrase>\owns</mathphrase></inlineequation> +</term><listitem><para>∋ Reflected membership epsilon; has the member +(relation). Synonym: <literal>\ni</literal>. Similar: is a member +of <literal>\in</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\parallel</primary></indexterm><literal>\parallel</literal> -</term><listitem><para><inlineequation><mathphrase>\parallel</mathphrase></inlineequation> (relation) +</term><listitem><para>∥ Parallel (relation). Synonym: <literal>\|</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\partial</primary></indexterm><literal>\partial</literal> -</term><listitem><para><inlineequation><mathphrase>\partial</mathphrase></inlineequation> +</term><listitem><para>∂ Partial differential (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\perp</primary></indexterm><literal>\perp</literal> -</term><listitem><para><inlineequation><mathphrase>\perp</mathphrase></inlineequation> (relation) +</term><listitem><para>⟂ Perpendicular (relation). Similar: <literal>\bot</literal> uses the +same glyph but the spacing is different because it is in the class +ordinary. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\phi</primary></indexterm><literal>\phi</literal> -</term><listitem><para><inlineequation><mathphrase>\phi</mathphrase></inlineequation> +</term><listitem><para>ϕ Lower case Greek letter (ordinary). The variant form is +<literal>\varphi</literal> φ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Pi</primary></indexterm><literal>\Pi</literal> -</term><listitem><para><inlineequation><mathphrase>\Pi</mathphrase></inlineequation> +</term><listitem><para>Π Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\pi</primary></indexterm><literal>\pi</literal> -</term><listitem><para><inlineequation><mathphrase>\pi</mathphrase></inlineequation> +</term><listitem><para>π Lower case Greek letter (ordinary). The variant form is +<literal>\varpi</literal> ϖ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\pm</primary></indexterm><literal>\pm</literal> -</term><listitem><para><inlineequation><mathphrase>\pm</mathphrase></inlineequation> (binary operation) +</term><listitem><para>± Plus or minus (binary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\prec</primary></indexterm><literal>\prec</literal> -</term><listitem><para><inlineequation><mathphrase>\prec</mathphrase></inlineequation> (relation) +</term><listitem><para>≺ Preceeds (relation). Similar: less than <literal><</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\preceq</primary></indexterm><literal>\preceq</literal> -</term><listitem><para><inlineequation><mathphrase>\preceq</mathphrase></inlineequation> (relation) +</term><listitem><para>⪯ Preceeds or equals (relation). Similar: less than or +equals <literal>\leq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\prime</primary></indexterm><literal>\prime</literal> -</term><listitem><para><inlineequation><mathphrase>\prime</mathphrase></inlineequation> +</term><listitem><para>′ Prime, or minute in a time expression (ordinary). Typically +used as a superscript <literal>$A^\prime$</literal>. Note that <literal>$f^\prime$</literal> +and <literal>$f'$</literal> produce the same result. An advantage of the second is +that <literal>$f'''$</literal> produces the the desired symbol, that is, the same +result as <literal>$f^{\prime\prime\prime}$</literal>, but uses somewhat less +typing. Note that you can only use <literal>\prime</literal> in math mode but you +can type right single quote <literal>'</literal> in text mode also, although it +resuts in a different look than in math mode. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\prod</primary></indexterm><literal>\prod</literal> -</term><listitem><para><inlineequation><mathphrase>\prod</mathphrase></inlineequation> +</term><listitem><para>∏ Product (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\propto</primary></indexterm><literal>\propto</literal> -</term><listitem><para><inlineequation><mathphrase>\propto</mathphrase></inlineequation> (relation) +</term><listitem><para>∝ Is proportional to (relation) </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Psi</primary></indexterm><literal>\Psi</literal> -</term><listitem><para><inlineequation><mathphrase>\Psi</mathphrase></inlineequation> +</term><listitem><para>Ψ Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\psi</primary></indexterm><literal>\psi</literal> -</term><listitem><para><inlineequation><mathphrase>\psi</mathphrase></inlineequation> +</term><listitem><para>ψ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rangle</primary></indexterm><literal>\rangle</literal> -</term><listitem><para><inlineequation><mathphrase>\rangle</mathphrase></inlineequation> (delimiter) +</term><listitem><para>➹ Right angle, or sequence, bracket (closing). Similar: greater +than <literal>></literal>. Matches:<literal>\langle</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rbrace</primary></indexterm><literal>\rbrace</literal> -</term><listitem><para><inlineequation><mathphrase>\rbrace</mathphrase></inlineequation> (delimiter) +</term><listitem><para>} Right curly brace +(closing). Synonym: <literal>\}</literal>. Matches <literal>\lbrace</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rbrack</primary></indexterm><literal>\rbrack</literal> -</term><listitem><para><inlineequation><mathphrase>\rbrack</mathphrase></inlineequation> (delimiter) +</term><listitem><para>] Right square bracket +(closing). Synonym: <literal>]</literal>. Matches <literal>\lbrack</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rceil</primary></indexterm><literal>\rceil</literal> -</term><listitem><para><inlineequation><mathphrase>\rceil</mathphrase></inlineequation> (delimiter) +</term><listitem><para>⌉ Right ceiling bracket (closing). Matches <literal>\lceil</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Re</primary></indexterm><literal>\Re</literal> -</term><listitem><para><inlineequation><mathphrase>\Re</mathphrase></inlineequation> +</term><listitem><para>ℜ Real part, real numbers, cursive capital R (ordinary). Related: +double-line, or blackboard bold, R <literal>\mathbb{R}</literal>; to access +this, load the <filename>amsfonts</filename> package. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\restriction</primary></indexterm><literal>\restriction</literal> +</term><listitem><para>↾ Restriction of a function +(relation). Synonym: <literal>\upharpoonright</literal>. Not available in +Plain &tex;. In &latex; you should load the <filename>amssymb</filename> package. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rfloor</primary></indexterm><literal>\rfloor</literal> -</term><listitem><para><inlineequation><mathphrase>\rfloor</mathphrase></inlineequation> +</term><listitem><para>⌋ Right floor bracket, a right square bracket with the top cut +off (closing). Matches <literal>\lfloor</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rhd</primary></indexterm><literal>\rhd</literal> -</term><listitem><para>(binary operation) <!-- xx not in plain @math{\rhd} --> +</term><listitem><para>◁ Arrowhead, that is, triangle, pointing right (binary). This is +not available in Plain &tex;. In &latex; you should load the +<filename>amssymb</filename> package. For the normal subgroup symbol you should +instead load <filename>amssymb</filename> and use <literal>\vartriangleright</literal> (which +is a relation and so gives better spacing). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rho</primary></indexterm><literal>\rho</literal> -</term><listitem><para><inlineequation><mathphrase>\rho</mathphrase></inlineequation> +</term><listitem><para>ρ Lower case Greek letter (ordinary). The variant form is +<literal>\varrho</literal> ϱ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Rightarrow</primary></indexterm><literal>\Rightarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\Rightarrow</mathphrase></inlineequation> +</term><listitem><para>⇒ Implies, right-pointing double line arrow (relation). Similar: +right single-line arrow <literal>\rightarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightarrow</primary></indexterm><literal>\rightarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\rightarrow</mathphrase></inlineequation> +</term><listitem><para>→ Right-pointing single line arrow (relation). Synonym: <literal>\to</literal>. Similar: right double line arrow <literal>\Rightarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightharpoondown</primary></indexterm><literal>\rightharpoondown</literal> -</term><listitem><para><inlineequation><mathphrase>\rightharpoondown</mathphrase></inlineequation> +</term><listitem><para>⇁ Right-pointing harpoon with barb below the line (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightharpoonup</primary></indexterm><literal>\rightharpoonup</literal> -</term><listitem><para><inlineequation><mathphrase>\rightharpoonup</mathphrase></inlineequation> +</term><listitem><para>⇀ Right-pointing harpoon with barb above the line (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightleftharpoons</primary></indexterm><literal>\rightleftharpoons</literal> -</term><listitem><para><inlineequation><mathphrase>\rightleftharpoons</mathphrase></inlineequation> +</term><listitem><para>⇌ Right harpoon up above left harpoon down (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\searrow</primary></indexterm><literal>\searrow</literal> -</term><listitem><para><inlineequation><mathphrase>\searrow</mathphrase></inlineequation> +</term><listitem><para>↘ Arrow pointing southeast (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\setminus</primary></indexterm><literal>\setminus</literal> -</term><listitem><para><inlineequation><mathphrase>\setminus</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⧵ Set difference, reverse solidus or slash, like \ +(binary). Similar: backslash <literal>\backslash</literal> and also +<literal>\textbackslash</literal> outside of math mode. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sharp</primary></indexterm><literal>\sharp</literal> -</term><listitem><para><inlineequation><mathphrase>\sharp</mathphrase></inlineequation> +</term><listitem><para>♯ Musical sharp (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Sigma</primary></indexterm><literal>\Sigma</literal> -</term><listitem><para><inlineequation><mathphrase>\Sigma</mathphrase></inlineequation> +</term><listitem><para>Σ Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sigma</primary></indexterm><literal>\sigma</literal> -</term><listitem><para><inlineequation><mathphrase>\sigma</mathphrase></inlineequation> +</term><listitem><para>σ Lower case Greek letter (ordinary). The variant form is +<literal>\varsigma</literal> ς. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sim</primary></indexterm><literal>\sim</literal> -</term><listitem><para><inlineequation><mathphrase>\sim</mathphrase></inlineequation> (relation) +</term><listitem><para>∼ Similar, in a relation (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\simeq</primary></indexterm><literal>\simeq</literal> -</term><listitem><para><inlineequation><mathphrase>\simeq</mathphrase></inlineequation> (relation) +</term><listitem><para>≃ Similar or equal to, in a relation (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\smallint</primary></indexterm><literal>\smallint</literal> -</term><listitem><para><inlineequation><mathphrase>\smallint</mathphrase></inlineequation> +</term><listitem><para>∫ Integral sign that does not change to a larger size in a +display (operator). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\smile</primary></indexterm><literal>\smile</literal> -</term><listitem><para><inlineequation><mathphrase>\smile</mathphrase></inlineequation> (relation) +</term><listitem><para>⌣ Upward curving arc (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\spadesuit</primary></indexterm><literal>\spadesuit</literal> -</term><listitem><para><inlineequation><mathphrase>\spadesuit</mathphrase></inlineequation> +</term><listitem><para>♠ Spade card suit (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqcap</primary></indexterm><literal>\sqcap</literal> -</term><listitem><para><inlineequation><mathphrase>\sqcap</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊓ Square intersection symbol (binary). Similar: +intersection <literal>cap</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqcup</primary></indexterm><literal>\sqcup</literal> -</term><listitem><para><inlineequation><mathphrase>\sqcup</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊔ Square union symbol (binary). Similar: +union <literal>cup</literal>. Related: variable-sized +operator <literal>\bigsqcup</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsubset</primary></indexterm><literal>\sqsubset</literal> -</term><listitem><para>(relation) <!-- not in plain (@math{\sqsubset}) --> +</term><listitem><para>⊏ Square subset symbol (relation). Similar: +subset <literal>\subset</literal>. This is not available in Plain &tex;. In +&latex; you should load the <filename>amssymb</filename> package. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsubseteq</primary></indexterm><literal>\sqsubseteq</literal> -</term><listitem><para><inlineequation><mathphrase>\sqsubseteq</mathphrase></inlineequation> (relation) +</term><listitem><para>⊑ Square subset or equal symbol (binary). Similar: subset or +equal to <literal>\subseteq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsupset</primary></indexterm><literal>\sqsupset</literal> -</term><listitem><para>(relation) <!-- not in plain (@math{\sqsupset}) --> +</term><listitem><para>⊐ Square superset symbol (relation). Similar: +superset <literal>\supset</literal>. This is not available in Plain &tex;. In +&latex; you should load the <filename>amssymb</filename> package. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsupseteq</primary></indexterm><literal>\sqsupseteq</literal> -</term><listitem><para><inlineequation><mathphrase>\sqsupseteq</mathphrase></inlineequation> (relation) +</term><listitem><para>⊒ Square superset or equal symbol (binary). Similar: superset or +equal <literal>\supseteq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\star</primary></indexterm><literal>\star</literal> -</term><listitem><para><inlineequation><mathphrase>\star</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⋆ Five-pointed star, sometimes used as a general binary operation +but sometimes reserved for cross-correlation (binary). Similar: the +synonyms asterisk <literal>*</literal> and <literal>\ast</literal>, which are six-pointed, +and more often appear as a superscript or subscript, as with the Kleene +star. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\subset</primary></indexterm><literal>\subset</literal> -</term><listitem><para><inlineequation><mathphrase>\subset</mathphrase></inlineequation> (relation) +</term><listitem><para>⊂ Subset (occasionally, is implied by) (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\subseteq</primary></indexterm><literal>\subseteq</literal> -</term><listitem><para><inlineequation><mathphrase>\subseteq</mathphrase></inlineequation> (relation) +</term><listitem><para>⊆ Subset or equal to (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\succ</primary></indexterm><literal>\succ</literal> -</term><listitem><para><inlineequation><mathphrase>\succ</mathphrase></inlineequation> (relation) +</term><listitem><para>≻ Comes after, succeeds (relation). Similar: is less +than <literal>></literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\succeq</primary></indexterm><literal>\succeq</literal> -</term><listitem><para><inlineequation><mathphrase>\succeq</mathphrase></inlineequation> (relation) +</term><listitem><para>⪰ Succeeds or is equal to (relation). Similar: less +than or equal to <literal>\leq</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sum</primary></indexterm><literal>\sum</literal> -</term><listitem><para><inlineequation><mathphrase>\sum</mathphrase></inlineequation> +</term><listitem><para>∑ Summation (operator). Similar: Greek capital +sigma <literal>\Sigma</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\supset</primary></indexterm><literal>\supset</literal> -</term><listitem><para><inlineequation><mathphrase>\supset</mathphrase></inlineequation> (relation) +</term><listitem><para>⊃ Superset (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\supseteq</primary></indexterm><literal>\supseteq</literal> -</term><listitem><para><inlineequation><mathphrase>\supseteq</mathphrase></inlineequation> (relation) +</term><listitem><para>⊇ Superset or equal to (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\surd</primary></indexterm><literal>\surd</literal> -</term><listitem><para><inlineequation><mathphrase>\surd</mathphrase></inlineequation> +</term><listitem><para>√ Radical symbol (ordinary). The &latex; command +<literal>\sqrt{..}</literal> typesets the square root of the argument, with a bar +that extends to cover the argument. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\swarrow</primary></indexterm><literal>\swarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\swarrow</mathphrase></inlineequation> +</term><listitem><para>↙ Southwest-pointing arrow (relation). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tau</primary></indexterm><literal>\tau</literal> -</term><listitem><para><inlineequation><mathphrase>\tau</mathphrase></inlineequation> +</term><listitem><para>τ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\theta</primary></indexterm><literal>\theta</literal> -</term><listitem><para><inlineequation><mathphrase>\theta</mathphrase></inlineequation> +</term><listitem><para>θ Lower case Greek letter (ordinary). The variant form is +<literal>\vartheta</literal> ϑ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\times</primary></indexterm><literal>\times</literal> -</term><listitem><para><inlineequation><mathphrase>\times</mathphrase></inlineequation> (binary operation) +</term><listitem><para>× Primary school multiplication sign (binary). See +also <literal>\cdot</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\to</primary></indexterm><literal>\to</literal> -</term><listitem><para><inlineequation><mathphrase>\to</mathphrase></inlineequation> +</term><listitem><para>→ Right-pointing single line arrow (relation). +Synonym: <literal>\rightarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\top</primary></indexterm><literal>\top</literal> -</term><listitem><para><inlineequation><mathphrase>\top</mathphrase></inlineequation> +</term><listitem><para>⊤ Top, greatest element of a poset (ordinary). See +also <literal>\bot</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\triangle</primary></indexterm><literal>\triangle</literal> -</term><listitem><para><inlineequation><mathphrase>\triangle</mathphrase></inlineequation> +</term><listitem><para>△ Triangle (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\triangleleft</primary></indexterm><literal>\triangleleft</literal> -</term><listitem><para><inlineequation><mathphrase>\triangleleft</mathphrase></inlineequation> (binary operation) +</term><listitem><para>◁ Not-filled triangle pointing left +(binary). Similar: <literal>\lhd</literal>. For the normal subgroup symbol you +should load <filename>amssymb</filename> and use <literal>\vartriangleleft</literal> (which +is a relation and so gives better spacing). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\triangleright</primary></indexterm><literal>\triangleright</literal> -</term><listitem><para><inlineequation><mathphrase>\triangleright</mathphrase></inlineequation> (binary operation) +</term><listitem><para>▷ Not-filled triangle pointing right (binary). For the normal +subgroup symbol you should instead load <filename>amssymb</filename> and +use <literal>\vartriangleright</literal> (which is a relation and so gives +better spacing). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\unlhd</primary></indexterm><literal>\unlhd</literal> -</term><listitem><para>left-pointing arrowhead with line under (binary operation) <!-- not in plain --> +</term><listitem><para>⊴ Left-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain &tex;. In &latex; +you should load the <filename>amssymb</filename> package. For the normal subgroup +symbol load <filename>amssymb</filename> and use <literal>\vartrianglelefteq</literal> (which +is a relation and so gives better spacing). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\unrhd</primary></indexterm><literal>\unrhd</literal> -</term><listitem><para>right-pointing arrowhead with line under (binary operation) <!-- not in plain --> +</term><listitem><para>⊵ Right-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain &tex;. In &latex; +you should load the <filename>amssymb</filename> package. For the normal subgroup +symbol load <filename>amssymb</filename> and use <literal>\vartrianglerighteq</literal> +(which is a relation and so gives better spacing). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Uparrow</primary></indexterm><literal>\Uparrow</literal> -</term><listitem><para><inlineequation><mathphrase>\Uparrow</mathphrase></inlineequation> (delimiter) +</term><listitem><para>⇑ Double-line upward-pointing arrow (relation). Similar: +single-line up-pointing arrow <literal>\uparrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\uparrow</primary></indexterm><literal>\uparrow</literal> -</term><listitem><para><inlineequation><mathphrase>\uparrow</mathphrase></inlineequation> (delimiter) +</term><listitem><para>↑ Single-line upward-pointing arrow, diverges (relation). Similar: +double-line up-pointing arrow <literal>\Uparrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Updownarrow</primary></indexterm><literal>\Updownarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\Updownarrow</mathphrase></inlineequation> (delimiter) +</term><listitem><para>⇕ Double-line upward-and-downward-pointing arrow (relation). Similar: +single-line upward-and-downward-pointing arrow <literal>\updownarrow</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\updownarrow</primary></indexterm><literal>\updownarrow</literal> -</term><listitem><para><inlineequation><mathphrase>\updownarrow</mathphrase></inlineequation> (delimiter) +</term><listitem><para>↕ Single-line upward-and-downward-pointing arrow (relation). Similar: +double-line upward-and-downward-pointing arrow <literal>\Updownarrow</literal>. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\upharpoonright</primary></indexterm><literal>\upharpoonright</literal> +</term><listitem><para>↾ Up harpoon, with barb on right side +(relation). Synonym: <literal>\restriction</literal>. Not available in Plain +&tex;. In &latex; you should load the <filename>amssymb</filename> package. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\uplus</primary></indexterm><literal>\uplus</literal> -</term><listitem><para><inlineequation><mathphrase>\uplus</mathphrase></inlineequation> (binary operation) +</term><listitem><para>⊎ Multiset union, a union symbol with a plus symbol in the middle +(binary). Similar: union <literal>\cup</literal>. Related: variable-sized +operator <literal>\biguplus</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Upsilon</primary></indexterm><literal>\Upsilon</literal> -</term><listitem><para><inlineequation><mathphrase>\Upsilon</mathphrase></inlineequation> +</term><listitem><para>Υ Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\upsilon</primary></indexterm><literal>\upsilon</literal> -</term><listitem><para><inlineequation><mathphrase>\upsilon</mathphrase></inlineequation> +</term><listitem><para>υ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varepsilon</primary></indexterm><literal>\varepsilon</literal> -</term><listitem><para><inlineequation><mathphrase>\varepsilon</mathphrase></inlineequation> +</term><listitem><para>ε Rounded small epsilon (ordinary). This is more widely used in +mathematics than the non-variant lower case Greek-text letter form +<literal>\epsilon</literal> ϵ. Related: set membership <literal>\in</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varphi</primary></indexterm><literal>\varphi</literal> -</term><listitem><para><inlineequation><mathphrase>\varphi</mathphrase></inlineequation> +</term><listitem><para>φ Variant on the lower case Greek letter (ordinary). The +non-variant form is <literal>\phi</literal> ϕ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varpi</primary></indexterm><literal>\varpi</literal> -</term><listitem><para><inlineequation><mathphrase>\varpi</mathphrase></inlineequation> +</term><listitem><para>ϖ Variant on the lower case Greek letter (ordinary). The +non-variant form is <literal>\pi</literal> π. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varrho</primary></indexterm><literal>\varrho</literal> -</term><listitem><para><inlineequation><mathphrase>\varrho</mathphrase></inlineequation> +</term><listitem><para>ϱ Variant on the lower case Greek letter (ordinary). The +non-variant form is <literal>\rho</literal> ρ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varsigma</primary></indexterm><literal>\varsigma</literal> -</term><listitem><para><inlineequation><mathphrase>\varsigma</mathphrase></inlineequation> +</term><listitem><para>ς Variant on the lower case Greek letter (ordinary). The +non-variant form is <literal>\sigma</literal> σ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vartheta</primary></indexterm><literal>\vartheta</literal> -</term><listitem><para><inlineequation><mathphrase>\vartheta</mathphrase></inlineequation> +</term><listitem><para>ϑ Variant on the lower case Greek letter (ordinary). The +non-variant form is <literal>\theta</literal> θ. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vdash</primary></indexterm><literal>\vdash</literal> -</term><listitem><para><inlineequation><mathphrase>\vdash</mathphrase></inlineequation> (relation) +</term><listitem><para>⊢ Provable; turnstile, vertical and a dash (relation). Similar: +turnstile rotated a half-circle <literal>\dashv</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vee</primary></indexterm><literal>\vee</literal> -</term><listitem><para><inlineequation><mathphrase>\vee</mathphrase></inlineequation> (binary operation) +</term><listitem><para>∨ Logical or; a downwards v shape (binary). Related: logical +and <literal>\wedge</literal>. Similar: variable-sized +operator <literal>\bigvee</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Vert</primary></indexterm><literal>\Vert</literal> -</term><listitem><para><inlineequation><mathphrase>\Vert</mathphrase></inlineequation> (delimiter) +</term><listitem><para>‖ Vertical double bar (ordinary). Similar: vertical single +bar <literal>\vert</literal>. +</para> +<para>For a norm you can use the <filename>mathtools</filename> package and add +<literal>\DeclarePairedDelimiter\norm{\lVert}{\rVert}</literal> to your +preamble. This gives you three command variants for double-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version <literal>$\norm*{M^\perp}$</literal> then the height of +the vertical bars will match the height of the argument, whereas with +<literal>\norm{M^\perp}</literal> the bars do not grow with the height of the +argument but instead are the default height, and <literal>\norm[<replaceable>size +command</replaceable>]{M^\perp}</literal> also gives bars that do not grow but are set to +the size given in the <replaceable>size command</replaceable>, e.g., <literal>\Bigg</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vert</primary></indexterm><literal>\vert</literal> -</term><listitem><para><inlineequation><mathphrase>\vert</mathphrase></inlineequation> (delimiter) +</term><listitem><para>| Single line vertical bar (ordinary). Similar: double-line +vertical bar <literal>\Vert</literal>. For such that, as in the definition of a +set, use <literal>\mid</literal> because it is a relation. +</para> +<para>For absolute value you can use the <filename>mathtools</filename> package and add +<literal>\DeclarePairedDelimiter\abs{\lvert}{\rvert}</literal> to your +preamble. This gives you three command variants for single-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version <literal>$\abs*{\frac{22}{7}}$</literal> then the +height of the vertical bars will match the height of the argument, +whereas with <literal>\abs{\frac{22}{7}}</literal> the bars do not grow with +the height of the argument but instead are the default height, and +<literal>\abs[<replaceable>size command</replaceable>]{\frac{22}{7}}</literal> also gives bars +that do not grow but are set to the size given in the <replaceable>size +command</replaceable>, e.g., <literal>\Bigg</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\wedge</primary></indexterm><literal>\wedge</literal> -</term><listitem><para><inlineequation><mathphrase>\wedge</mathphrase></inlineequation> (binary operation) +</term><listitem><para>∧ Logical and (binary). Synonym: <literal>\land</literal>. See also +logical or <literal>\vee</literal>. Similar: variable-sized +operator <literal>\bigwedge</literal>. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\wp</primary></indexterm><literal>\wp</literal> -</term><listitem><para><inlineequation><mathphrase>\wp</mathphrase></inlineequation> +</term><listitem><para>℘ Weierstrass p (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\wr</primary></indexterm><literal>\wr</literal> -</term><listitem><para><inlineequation><mathphrase>\wr</mathphrase></inlineequation> (binary operation) +</term><listitem><para>≀ Wreath product (binary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Xi</primary></indexterm><literal>\Xi</literal> -</term><listitem><para><inlineequation><mathphrase>\Xi</mathphrase></inlineequation> +</term><listitem><para>Ξ Upper case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\xi</primary></indexterm><literal>\xi</literal> -</term><listitem><para><inlineequation><mathphrase>\xi</mathphrase></inlineequation> +</term><listitem><para>ξ Lower case Greek letter (ordinary). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\zeta</primary></indexterm><literal>\zeta</literal> -</term><listitem><para><inlineequation><mathphrase>\zeta</mathphrase></inlineequation> +</term><listitem><para>ζ Lower case Greek letter (ordinary). </para> </listitem></varlistentry></variablelist> </sect1> <sect1 label="16.3" id="Math-functions"> <title>Math functions</title> + <indexterm role="cp"><primary>math functions</primary></indexterm> <indexterm role="cp"><primary>functions, math</primary></indexterm> @@ -4684,10 +6554,10 @@ spacing. </term><listitem><para><inlineequation><mathphrase>\cosh</mathphrase></inlineequation> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cot</primary></indexterm><literal>\cot</literal> -</term><listitem><para><inlineequation><mathphrase>\cos</mathphrase></inlineequation> +</term><listitem><para><inlineequation><mathphrase>\cot</mathphrase></inlineequation> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\coth</primary></indexterm><literal>\coth</literal> -</term><listitem><para><inlineequation><mathphrase>\cosh</mathphrase></inlineequation> +</term><listitem><para><inlineequation><mathphrase>\coth</mathphrase></inlineequation> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\csc</primary></indexterm><literal>\csc</literal> </term><listitem><para><inlineequation><mathphrase>\csc</mathphrase></inlineequation> @@ -4696,7 +6566,7 @@ spacing. </term><listitem><para><inlineequation><mathphrase>\deg</mathphrase></inlineequation> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\det</primary></indexterm><literal>\det</literal> -</term><listitem><para><inlineequation><mathphrase>\deg</mathphrase></inlineequation> +</term><listitem><para><inlineequation><mathphrase>\det</mathphrase></inlineequation> </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dim</primary></indexterm><literal>\dim</literal> </term><listitem><para><inlineequation><mathphrase>\dim</mathphrase></inlineequation> @@ -4772,6 +6642,7 @@ spacing. </sect1> <sect1 label="16.4" id="Math-accents"> <title>Math accents</title> + <indexterm role="cp"><primary>math accents</primary></indexterm> <indexterm role="cp"><primary>accents, mathematical</primary></indexterm> @@ -4839,8 +6710,8 @@ in math. These are different from accents in normal text </term><listitem><indexterm role="cp"><primary>wide hat accent, math</primary></indexterm> <para>Math wide hat accent: <inlineequation><mathphrase>\widehat{x+y}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\widehat</primary></indexterm><literal>\widehat</literal> -</term><listitem><indexterm role="cp"><primary>wide tile accent, math</primary></indexterm> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\widetilde</primary></indexterm><literal>\widetilde</literal> +</term><listitem><indexterm role="cp"><primary>wide tilde accent, math</primary></indexterm> <para>Math wide tilde accent: <inlineequation><mathphrase>\widetilde{x+y}</mathphrase></inlineequation>. </para> </listitem></varlistentry></variablelist> @@ -4848,36 +6719,69 @@ in math. These are different from accents in normal text </sect1> <sect1 label="16.5" id="Spacing-in-math-mode"> <title>Spacing in math mode</title> + <indexterm role="cp"><primary>spacing within math mode</primary></indexterm> <indexterm role="cp"><primary>math mode, spacing</primary></indexterm> -<para>In a <literal>math</literal> environment, &latex; ignores the spaces you type and -puts in the spacing according to the normal rules for mathematics -texts. If you want different spacing, &latex; provides the following -commands for use in math mode: +<para>In a <literal>math</literal> environment, &latex; ignores the spaces that you use +in the source, and instead puts in the spacing according to the normal +rules for mathematics texts. +</para> +<para>Many math mode spacing definitions are expressed in terms of the math unit +<firstterm>mu</firstterm> given by 1 em = 18 mu, where the em is taken from the current +math symbols family (see <link linkend="Units-of-length">Units of length</link>). +&latex; provides the following commands for use in math mode: </para> <variablelist><varlistentry><term><literal>\;</literal> </term><listitem><indexterm role="fn"><primary>\;</primary></indexterm> -<para>A thick space (<inlineequation><mathphrase>5\over18\,</mathphrase></inlineequation>quad). -</para></listitem></varlistentry><varlistentry><term><literal>\:</literal> +<indexterm role="fn"><primary>\thickspace</primary></indexterm> +<para>Normally <literal>5.0mu plus 5.0mu</literal>. The longer name is +<literal>\thickspace</literal>. Math mode only. +</para> +</listitem></varlistentry><varlistentry><term><literal>\:</literal> </term><term><literal>\></literal> </term><listitem><indexterm role="fn"><primary>\:</primary></indexterm> <indexterm role="fn"><primary>\></primary></indexterm> -<para>Both of these produce a medium space (<inlineequation><mathphrase>2\over9\,</mathphrase></inlineequation>quad). -</para></listitem></varlistentry><varlistentry><term><literal>\,</literal> +<indexterm role="fn"><primary>\medspace</primary></indexterm> +<para>Normally <literal>4.0mu plus 2.0mu minus 4.0mu</literal>. The longer name is +<literal>\medspace</literal>. Math mode only. +</para> +</listitem></varlistentry><varlistentry><term><literal>\,</literal> </term><listitem><indexterm role="fn"><primary>\,</primary></indexterm> -<para>A thin space (<inlineequation><mathphrase>1\over6\,</mathphrase></inlineequation>quad); not restricted to math mode. -</para></listitem></varlistentry><varlistentry><term><literal>\!</literal> -</term><listitem><para>A negative thin space (<inlineequation><mathphrase>-{1\over6}\,</mathphrase></inlineequation>quad). +<indexterm role="fn"><primary>\thinspace</primary></indexterm> +<para>Normally <literal>3mu</literal>. The longer name is <literal>\thinspace</literal>. This can +be used in both math mode and text mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\!</literal> +</term><listitem><indexterm role="fn"><primary>\!</primary></indexterm> +<para>A negative thin space. Normally <literal>-3mu</literal>. Math mode only. +</para> +</listitem></varlistentry><varlistentry><term><literal>\quad</literal> +</term><listitem><indexterm role="cp"><primary>quad</primary></indexterm> +<indexterm role="fn"><primary>\quad</primary></indexterm> +<para>This is 18mu, that is, 1em. This is often used for space +surrounding equations or expressions, for instance for the space between +two equations inside a <literal>displaymath</literal> environment. It is available +in both text and math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\qquad</literal> +</term><listitem><indexterm role="fn"><primary>\qquad</primary></indexterm> +<para>A length of 2 quads, that is, 36mu = 2em. It is available in +both text and math mode. </para></listitem></varlistentry></variablelist> +<para>In this example a thinspace separates the function from the +infinitesimal. +</para> +<screen>\int_0^1 f(x)\,dx +</screen> </sect1> <sect1 label="16.6" id="Math-miscellany"> <title>Math miscellany</title> + <indexterm role="cp"><primary>math miscellany</primary></indexterm> -<variablelist> -<varlistentry><term><indexterm role="fn"><primary>\*</primary></indexterm><literal>\*</literal> +<variablelist><varlistentry><term><indexterm role="fn"><primary>\*</primary></indexterm><literal>\*</literal> </term><listitem><indexterm role="cp"><primary>discretionary multiplication</primary></indexterm> <indexterm role="cp"><primary>multiplication symbol, discretionary line break</primary></indexterm> <para>A “discretionary” multiplication symbol, at which a line break is @@ -4937,6 +6841,7 @@ descenders. </chapter> <chapter label="17" id="Modes"> <title>Modes</title> + <indexterm role="cp"><primary>modes</primary></indexterm> <indexterm role="cp"><primary>paragraph mode</primary></indexterm> <indexterm role="cp"><primary>math mode</primary></indexterm> @@ -4984,6 +6889,7 @@ mode, which it starts out in, is called “outer paragraph mode”. </chapter> <chapter label="18" id="Page-styles"> <title>Page styles</title> + <indexterm role="cp"><primary>styles, page</primary></indexterm> <indexterm role="cp"><primary>page styles</primary></indexterm> @@ -4994,6 +6900,7 @@ the page’s head and foot. The page style determines what goes in them. <sect1 label="18.1" id="_005cmaketitle"> <title><literal>\maketitle</literal></title> + <indexterm role="cp"><primary>titles, making</primary></indexterm> <indexterm role="fn"><primary>\maketitle</primary></indexterm> @@ -5034,6 +6941,7 @@ document. Use <literal>\\</literal> to force a line break, as usual. </sect1> <sect1 label="18.2" id="_005cpagenumbering"> <title><literal>\pagenumbering</literal></title> + <indexterm role="fn"><primary>\pagenumbering</primary></indexterm> <indexterm role="cp"><primary>page numbering style</primary></indexterm> @@ -5064,6 +6972,7 @@ the following: </sect1> <sect1 label="18.3" id="_005cpagestyle"> <title><literal>\pagestyle</literal></title> + <indexterm role="fn"><primary>\pagestyle</primary></indexterm> <indexterm role="cp"><primary>header style</primary></indexterm> <indexterm role="cp"><primary>footer style</primary></indexterm> @@ -5109,6 +7018,7 @@ the page. </sect1> <sect1 label="18.4" id="_005cthispagestyle"> <title><literal>\thispagestyle{<replaceable>style</replaceable>}</literal></title> + <indexterm role="fn"><primary>\thispagestyle</primary></indexterm> <para>The <literal>\thispagestyle</literal> command works in the same manner as the @@ -5120,94 +7030,169 @@ changes to <replaceable>style</replaceable> for the current page only. </chapter> <chapter label="19" id="Spaces"> <title>Spaces</title> + <indexterm role="cp"><primary>spaces</primary></indexterm> +<indexterm role="cp"><primary>white space</primary></indexterm> <para>&latex; has many ways to produce white (or filled) space. </para> -<para>Another space-producing command is <literal>\,</literal> to produce a “thin” -space (usually 1/6quad). It can be used in text mode, but is -more often useful in math mode (see <link linkend="Spacing-in-math-mode">Spacing in math mode</link>). -</para> <sect1 label="19.1" id="_005chspace"> <title><literal>\hspace</literal></title> + <indexterm role="fn"><primary>\hspace</primary></indexterm> <para>Synopsis: </para> -<screen>\hspace[*]{<replaceable>length</replaceable>} +<screen>\hspace{<replaceable>length</replaceable>} +\hspace*{<replaceable>length</replaceable>} </screen> -<para>The <literal>\hspace</literal> command adds horizontal space. The <replaceable>length</replaceable> -argument can be expressed in any terms that &latex; understands: -points, inches, etc. It is a rubber length. You can add both -negative and positive space with an <literal>\hspace</literal> command; adding -negative space is like backspacing. +<para>Add the horizontal space given by <replaceable>length</replaceable>. The <replaceable>length</replaceable> is a +rubber length, that is, it may contain a <literal>plus</literal> or <literal>minus</literal> +component, in any unit that &latex; understands (see <link linkend="Lengths">Lengths</link>). +</para> +<para>This command can add both positive and negative space; adding negative +space is like backspacing. </para> -<para>&latex; normally removes horizontal space that comes at the beginning -or end of a line. To preserve this space, use the optional <literal>*</literal> -form. +<para>Normally when &tex; breaks a paragraph into lines it discards white +space (glues and kerns) that would come at the start of a line, so you +get an inter-word space or a line break between words but not both. This +command’s starred version <literal>\hspace*{..}</literal> puts a non-discardable +invisible item in front of the space, so the space appears in the +output. </para> +<para>This example make a one-line paragraph that puts ‘<literal>Name:</literal>’ an inch +from the right margin. +</para> +<screen>\noindent\makebox[\linewidth]{\hspace{\fill}Name:\hspace{1in}} +</screen> </sect1> <sect1 label="19.2" id="_005chfill"> <title><literal>\hfill</literal></title> + <indexterm role="fn"><primary>\hfill</primary></indexterm> <indexterm role="cp"><primary>stretch, infinite horizontal</primary></indexterm> <indexterm role="cp"><primary>infinite horizontal stretch</primary></indexterm> -<para>The <literal>\hfill</literal> fill command produces a “rubber length” which has -no natural space but can stretch or shrink horizontally as far as -needed. +<para>Produce a rubber length which has +no natural space but can stretch horizontally as far as +needed (see <link linkend="Lengths">Lengths</link>). </para> <indexterm role="fn"><primary>\fill</primary></indexterm> -<para>The <literal>\fill</literal> parameter is the rubber length itself (technically, -the glue value ‘<literal>0pt plus1fill</literal>’); thus, <literal>\hspace\fill</literal> is -equivalent to <literal>\hfill</literal>. +<para>The command <literal>\hfill</literal> is equivalent to <literal>\hspace{\fill}</literal>. For +space that does not disappear at line breaks use +<literal>\hspace*{\fill}</literal> instead (see <link linkend="_005chspace">\hspace</link>). </para> </sect1> -<sect1 label="19.3" id="_005cSPACE"> -<title><literal>\SPACE</literal>: Normal interword space</title> -<indexterm role="fn"><primary>\SPACE</primary></indexterm> +<sect1 label="19.3" id="_005c_0028SPACE_0029-and-_005c_0040"> +<title><literal>\(SPACE)</literal> and \@</title> + +<indexterm role="fn"><primary>\(SPACE)</primary></indexterm> <indexterm role="fn"><primary>\TAB</primary></indexterm> <indexterm role="fn"><primary>\NEWLINE</primary></indexterm> +<indexterm role="fn"><primary>\@</primary></indexterm> +<anchor id="_005cAT"/><!-- old name --> -<para>The <literal>\ </literal> (space) command produces a normal interword space. It’s -useful after punctuation which shouldn’t end a sentence. For example, -<literal>the article in Proc.\ Amer.\ Math\. Soc.\ is fundamental</literal>. It -is also often used after control sequences, as in <literal>\TeX\ is a -nice system.</literal> +<para>Mark a punctuation character, typically a period, as either ending a +sentence or as ending an abbreviation. </para> -<para>In normal circumstances, <literal>\</literal><keycap>tab</keycap> and <literal>\</literal><keycap>newline</keycap> -are equivalent to <literal>\ </literal>. +<para>By default, in justifying a line &latex; adjusts the space after a +sentence-ending period (or a question mark, exclamation point, comma, or +colon) more than the space between words +(see <link linkend="_005cfrenchspacing">\frenchspacing</link>). &latex; assumes that the period ends a +sentence unless it is preceded by a capital letter, in which case it +takes that period for part of an abbreviation. Note that if a +sentence-ending period is immediately followed by a right parenthesis or +bracket, or right single or double quote, then the intersentence space +follows that parenthesis or quote. +</para> +<para>If you have a period ending an abbreviation whose last letter is not a +capital letter, and that abbreviation is not the last word in the +sentence, then follow that period with a backslash-space (<literal>\ </literal>) or +a tie (<literal>~</literal>). Examples are <literal>Nat.\ Acad.\ Science</literal>, and +<literal>Mr.~Bean</literal>, and <literal>(manure, etc.)\ for sale</literal>. +</para> +<para>For other use of <literal>\ </literal>, see also <link linkend="_005c_0028SPACE_0029-after-CS">\(SPACE) after CS</link>. +</para> +<para>In the opposite situation, if you have a capital letter followed by a +period that ends the sentence, then put <literal>\@</literal> on the left of that +period. For example, <literal>book by the MAA\@.</literal> will have intersentence +spacing after the period. +</para> +<para>In contrast, putting <literal>\@</literal> on the right of a period tells &tex; +that the period does not end the sentence. In the example +<literal>reserved words (if, then, etc.\@) are different</literal>, &tex; will put +interword space after the closing parenthesis (note that <literal>\@</literal> is +before the parenthesis). </para> - </sect1> -<sect1 label="19.4" id="_005c_0040"> -<title><literal>\@</literal>: Force sentence-ending punctuation</title> -<indexterm role="fn"><primary>\@</primary></indexterm> -<anchor id="_005cAT"/><!-- old name --> +<sect1 label="19.4" id="_005c_0028SPACE_0029-after-CS"> +<title><literal>\ </literal> after a control sequence</title> -<para>The <literal>\@</literal> command makes the following punctuation character end a -sentence even if it normally would not. This is typically used after -a capital letter. Here are side-by-side examples with and without -<literal>\@</literal>: +<para>The <literal>\ </literal> command is often used after control sequences to keep them +from gobbling the space that follows, as in <literal>\TeX\ is a nice +system.</literal> And, under normal circumstances <literal>\</literal><keycap>tab</keycap> and +<literal>\</literal><keycap>newline</keycap> are equivalent to <literal>\ </literal>. For other use of +<literal>\ </literal>, see also <link linkend="_005c_0028SPACE_0029-and-_005c_0040">\(SPACE) and \@</link>. </para> -<screen>… in C\@. Pascal, though … -… in C. Pascal, though … -</screen> -<para>produces +<para>Some people prefer to use <literal>{}</literal> for the same purpose, as in +<literal>\TeX{} is a nice system.</literal> This has the advantage that you can +always write it the same way, like <literal>\TeX{}</literal>, whether it is +followed by a space or by a punctuation mark. Please compare: </para> -<!-- Texinfo has different commands, but the result is the same. --> -<blockquote><para>… in C. Pascal, though … +<screen>\TeX\ is a nice system. \TeX, a nice system. -… in C. Pascal, though … -</para></blockquote> +\TeX{} is a nice system. \TeX{}, a nice system. +</screen> + +<para>When you define user commands (see <link linkend="_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</link>) you +can prevent the space gobbling after the command by using the package +<literal>xspace</literal> and inserting <literal>\xspace</literal> at the end of the definition +For instance: +</para><screen>\documentclass{minimal} +\usepackage{xspace} +\newcommand*{\Loup}{Grand Cric\xspace} +\begin{document} +Que le \Loup me croque ! +\end{document} +</screen> +<para>A quick hack to use <literal>\xspace</literal> for existing command is as follows: +</para><screen>\documentclass{minimal} +\usepackage{xspace} +\newcommand*{\SansXspaceTeX}{} +\let\SansXspaceTeX\TeX +\renewcommand{\TeX}{\SansXspaceTeX\xspace} +\begin{document} +\TeX is a nice system. +\end{document} +</screen> + +</sect1> +<sect1 label="19.5" id="_005cfrenchspacing"> +<title><literal>\frenchspacing</literal></title> + +<indexterm role="fn"><primary>\frenchspacing</primary></indexterm> +<indexterm role="fn"><primary>\nonfrenchspacing</primary></indexterm> +<indexterm role="cp"><primary>spacing, intersentence</primary></indexterm> + +<para>This declaration (from Plain &tex;) causes &latex; to treat +intersentence spacing in the same way as interword spacing. +</para> +<para>In justifying the text in a line, some typographic traditions, including +English, prefer to adjust the space between sentences (or after other +punctuation marks) more than the space between words. Following this +declaration, all spaces are instead treated equally. +</para> +<para>Revert to the default behavior by declaring <literal>\nonfrenchspacing</literal>. +</para> </sect1> -<sect1 label="19.5" id="_005cthinspace"> +<sect1 label="19.6" id="_005cthinspace"> <title><literal>\thinspace</literal>: Insert 1/6em</title> + <indexterm role="fn"><primary>\thinspace</primary></indexterm> <para><literal>\thinspace</literal> produces an unbreakable and unstretchable space that @@ -5216,8 +7201,9 @@ quotes, as in ’”.<!-- Abuse @dmn, which is a thin space in Texinfo. </para> </sect1> -<sect1 label="19.6" id="_005c_002f"> +<sect1 label="19.7" id="_005c_002f"> <title><literal>\/</literal>: Insert italic correction</title> + <indexterm role="fn"><primary>\/</primary></indexterm> <indexterm role="cp"><primary>italic correction</primary></indexterm> @@ -5248,40 +7234,61 @@ in a different way. </para> </sect1> -<sect1 label="19.7" id="_005chrulefill"> -<title><literal>\hrulefill</literal></title> -<indexterm role="fn"><primary>\hrulefill</primary></indexterm> - -<para>The <literal>\hrulefill</literal> fill command produces a “rubber length” which can -stretch or shrink horizontally. It will be filled with a horizontal -rule. -</para> - -</sect1> -<sect1 label="19.8" id="_005cdotfill"> -<title><literal>\dotfill</literal></title> +<sect1 label="19.8" id="_005chrulefill-_005cdotfill"> +<title><literal>\hrulefill \dotfill</literal></title> +<indexterm role="fn"><primary>\hrulefill</primary></indexterm> <indexterm role="fn"><primary>\dotfill</primary></indexterm> -<para>The <literal>\dotfill</literal> command produces a “rubber length” that fills -with dots instead of just white space. +<para>Produce an infinite rubber length (see <link linkend="Lengths">Lengths</link>) filled with a +horizontal rule (that is, a line) or with dots, instead of just white +space. +</para> +<para>When placed between blank lines this example creates a paragraph that is +left and right justified, where the space in the middle is filled with +evenly spaced dots. +</para> +<screen>\noindent Jack Aubrey\dotfill Melbury Lodge +</screen> +<para>To make the rule or dots go to the line’s end use <literal>\null</literal> at the +start or end. +</para> +<para>To change the rule’s thickness, copy the definition and adjust it, as +with <literal>\renewcommand{\hrulefill}{\leavevmode\leaders\hrule height +1pt\hfill\kern\z@}</literal>, which changes the default thickness of +0.4pt to 1pt. Similarly, adjust the dot spacing as with +<literal>\renewcommand{\dotfill}{\leavevmode\cleaders\hb@xt@ +1.00em{\hss .\hss }\hfill\kern\z@}</literal>, which changes the default +length of 0.33em to 1.00em. </para> -<!-- xx undone --> </sect1> <sect1 label="19.9" id="_005caddvspace"> <title><literal>\addvspace</literal></title> + <indexterm role="fn"><primary>\addvspace</primary></indexterm> <indexterm role="cp"><primary>vertical space</primary></indexterm> <indexterm role="cp"><primary>space, inserting vertical</primary></indexterm> -<para><literal>\addvspace{length}</literal> +<para><literal>\addvspace{<replaceable>length</replaceable>}</literal> </para> -<para>The <literal>\addvspace</literal> command normally adds a vertical space of height -length. However, if vertical space has already been added to the same -point in the output by a previous <literal>\addvspace</literal> command, then this -command will not add more space than is needed to make the natural -length of the total vertical space equal to <literal>length</literal>. +<para>Add a vertical space of height <replaceable>length</replaceable>, which is a rubber length +(see <link linkend="Lengths">Lengths</link>). However, if vertical space has already been added to +the same point in the output by a previous <literal>\addvspace</literal> command +then this command will not add more space than what is needed to make +the natural length of the total vertical space equal to <replaceable>length</replaceable>. +</para> +<para>Use this command to adjust the vertical space above or below an +environment that starts a new paragraph. (For instance, a Theorem +environment is defined to begin and end in <literal>\addvspace{..}</literal> so +that two consecutive Theorem’s are separated by one vertical space, not +two.) +</para> +<para>This command is fragile (see <link linkend="_005cprotect">\protect</link>). +</para> +<para>The error ‘<literal>Something's wrong--perhaps a missing \item</literal>’ means that +you were not in vertical mode when you invoked this command; one way to +change that is to precede this command with a <literal>\par</literal> command. </para> </sect1> @@ -5318,32 +7325,66 @@ quarter of a line space, with stretch and shrink (the default for the </sect1> <sect1 label="19.11" id="_005cvfill"> <title><literal>\vfill</literal></title> + <indexterm role="fn"><primary>\vfill</primary></indexterm> <indexterm role="cp"><primary>stretch, infinite vertical</primary></indexterm> <indexterm role="cp"><primary>infinite vertical stretch</primary></indexterm> -<para>The <literal>\vfill</literal> fill command produces a rubber length (glue) which -can stretch or shrink vertically as far as needed. It’s equivalent to -<literal>\vspace{\fill}</literal> (see <link linkend="_005chfill">\hfill</link>). -</para> +<para>End the current paragraph and insert a vertical rubber length +(see <link linkend="Lengths">Lengths</link>) that is infinite, so it can stretch or shrink as far +as needed. +</para> +<para>It is often used in the same way as <literal>\vspace{\fill}</literal>, except that +<literal>\vfill</literal> ends the current paragraph, whereas +<literal>\vspace{\fill}</literal> adds the infinite vertical space below its line +irrespective of the paragraph structure. In both cases that space will +disappear at a page boundary; to circumvent this see <link linkend="_005cvspace">\vspace</link>. +</para> +<para>In this example the page is filled, so the top and bottom lines contain +the text ‘<literal>Lost Dog!</literal>’ and the third ‘<literal>Lost Dog!</literal>’ is exactly +halfway between them. +</para> +<screen>\begin{document} +Lost Dog! +\vfill +Lost Dog! +\vfill +Lost Dog! +\end{document} +</screen> </sect1> <sect1 label="19.12" id="_005cvspace"> -<title><literal>\vspace[*]{<replaceable>length</replaceable>}</literal></title> +<title><literal>\vspace{<replaceable>length</replaceable>}</literal></title> + <indexterm role="fn"><primary>\vspace</primary></indexterm> +<indexterm role="cp"><primary>vertical space</primary></indexterm> +<indexterm role="cp"><primary>space, vertical</primary></indexterm> -<para>Synopsis: +<para>Synopsis, one of these two: </para> -<screen>\vspace[*]{<replaceable>length</replaceable>} +<screen>\vspace{<replaceable>length</replaceable>} +\vspace*{<replaceable>length</replaceable>} </screen> -<para>The <literal>\vspace</literal> command adds the vertical space <replaceable>length</replaceable>, i.e., -a rubber length. <replaceable>length</replaceable> can be negative or positive. +<para>Add the vertical space <replaceable>length</replaceable>. This can be negative or positive, +and is a rubber length (see <link linkend="Lengths">Lengths</link>). +</para> +<para>&latex; removes the vertical space from <literal>\vfill</literal> at a page break, +that is, at the top or bottom of a page. The starred version +<literal>\vspace*{..}</literal> causes the space to stay. </para> -<para>Ordinarily, &latex; removes vertical space added by <literal>\vspace</literal> at -the top or bottom of a page. With the optional <literal>*</literal> argument, the -space is not removed. +<para>In this example the two questions will be evenly spaced vertically on +the page, with at least one inch of space below each. </para> +<screen>\begin{document} +1) Who put the bomp in the bomp bah bomp bah bomp? +\vspace{1in plus 1fill} + +2) Who put the ram in the rama lama ding dong? +\vspace{1in plus 1fill} +\end{document} +</screen> </sect1> </chapter> @@ -5359,6 +7400,7 @@ used in the arguments of the box-making commands. <sect1 label="20.1" id="_005cmbox"> <title><literal>\mbox{<replaceable>text}</replaceable></literal></title> + <indexterm role="fn"><primary>\mbox</primary></indexterm> <indexterm role="cp"><primary>hyphenation, preventing</primary></indexterm> @@ -5400,6 +7442,7 @@ argument. <!-- xxref --> </sect1> <sect1 label="20.3" id="lrbox"> <title><literal>lrbox</literal></title> + <indexterm role="fn"><primary>lrbox</primary></indexterm> <para><literal>\begin{lrbox}{cmd} text \end{lrbox}</literal> @@ -5413,6 +7456,7 @@ must have been declared with <literal>\newsavebox</literal>. </sect1> <sect1 label="20.4" id="_005cmakebox"> <title><literal>\makebox</literal></title> + <indexterm role="fn"><primary>\makebox</primary></indexterm> <para>Synopsis: @@ -5420,7 +7464,7 @@ must have been declared with <literal>\newsavebox</literal>. <screen>\makebox[<replaceable>width</replaceable>][<replaceable>position</replaceable>]{<replaceable>text</replaceable>} </screen> <para>The <literal>\makebox</literal> command creates a box just wide enough to contain -the <replaceable>text</replaceable> specified. The width of the box is specified by the +the <replaceable>text</replaceable> specified. The width of the box can be overridden by the optional <replaceable>width</replaceable> argument. The position of the text within the box is determined by the optional <replaceable>position</replaceable> argument, which may take the following values: @@ -5435,13 +7479,14 @@ the following values: </term><listitem><para>Stretch (justify) across entire <replaceable>width</replaceable>; <replaceable>text</replaceable> must contain stretchable space for this to work. </para></listitem></varlistentry></variablelist> -<para><literal>\makebox</literal> is also used within the picture environment +<para><literal>\makebox</literal> is also used within the <literal>picture</literal> environment see <link linkend="_005cmakebox-_0028picture_0029">\makebox (picture)</link>. </para> </sect1> <sect1 label="20.5" id="_005cparbox"> <title><literal>\parbox</literal></title> + <indexterm role="fn"><primary>\parbox</primary></indexterm> <para>Synopsis: @@ -5486,6 +7531,7 @@ for this to work. </sect1> <sect1 label="20.6" id="_005craisebox"> <title><literal>\raisebox</literal></title> + <indexterm role="fn"><primary>\raisebox</primary></indexterm> <para>Synopsis: @@ -5506,6 +7552,7 @@ ignoring its natural height and depth. </sect1> <sect1 label="20.7" id="_005csavebox"> <title><literal>\savebox</literal></title> + <indexterm role="fn"><primary>\savebox</primary></indexterm> <para>Synopsis: @@ -5521,6 +7568,7 @@ declared with <literal>\newsavebox</literal> (see <link linkend="_005cnewsavebox </sect1> <sect1 label="20.8" id="_005csbox"> <title><literal>\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>}</literal></title> + <indexterm role="fn"><primary>\sbox</primary></indexterm> <para>Synopsis: @@ -5537,6 +7585,7 @@ included in the normal output, it is saved in the box labeled </sect1> <sect1 label="20.9" id="_005cusebox"> <title><literal>\usebox{<replaceable>\boxcmd</replaceable>}</literal></title> + <indexterm role="fn"><primary>\usebox</primary></indexterm> <para>Synopsis: @@ -5552,6 +7601,9 @@ included in the normal output, it is saved in the box labeled <chapter label="21" id="Special-insertions"> <title>Special insertions</title> +<indexterm role="cp"><primary>special insertions</primary></indexterm> +<indexterm role="cp"><primary>insertions of special characters</primary></indexterm> + <para>&latex; provides commands for inserting characters that have a special meaning do not correspond to simple characters you can type. </para> @@ -5559,6 +7611,7 @@ special meaning do not correspond to simple characters you can type. <sect1 label="21.1" id="Reserved-characters"> <title>Reserved characters</title> + <indexterm role="cp"><primary>reserved characters</primary></indexterm> <indexterm role="cp"><primary>characters, reserved</primary></indexterm> @@ -5610,13 +7663,14 @@ with <literal>"</literal>, so the previous example could also be written as <title>Text symbols</title> <indexterm role="cp"><primary>text symbols</primary></indexterm> +<indexterm role="cp"><primary>symbols, text</primary></indexterm> + <indexterm role="fn"><primary>textcomp package</primary></indexterm> <para>&latex; provides commands to generate a number of non-letter symbols in running text. Some of these, especially the more obscure ones, are not available in OT1; you may need to load the <literal>textcomp</literal> package. </para> -<variablelist> -<varlistentry><term><indexterm role="fn"><primary>\copyright</primary></indexterm><literal>\copyright</literal> +<variablelist><varlistentry><term><indexterm role="fn"><primary>\copyright</primary></indexterm><literal>\copyright</literal> </term><term><indexterm role="fn"><primary>\textcopyright</primary></indexterm><literal>\textcopyright</literal> </term><listitem><indexterm role="cp"><primary>copyright symbol</primary></indexterm> <para>The copyright symbol, ©. @@ -5783,7 +7837,7 @@ has the ascender height. </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textendash (or <literal>--</literal>)</primary></indexterm><literal>\textendash (or <literal>--</literal>)</literal> </term><listitem><indexterm role="cp"><primary>e-dash</primary></indexterm> -<para>En-dash: — (for ranges). +<para>En-dash: – (for ranges). </para> </listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\texteuro</primary></indexterm><literal>\texteuro</literal> </term><listitem><indexterm role="cp"><primary>euro symbol</primary></indexterm> @@ -5962,7 +8016,8 @@ environment, pushes current column to the right of the previous column </listitem></varlistentry><varlistentry><term><literal>\b</literal> </term><listitem><indexterm role="fn"><primary>\b (bar-under accent)</primary></indexterm> <indexterm role="cp"><primary>bar-under accent</primary></indexterm> -<para>Produces a bar accent under the following, as in o_. +<para>Produces a bar accent under the following, as in o_. See +also <literal>\underbar</literal> hereinafter. </para> </listitem></varlistentry><varlistentry><term><literal>\c</literal> </term><term><literal>\capitalcedilla</literal> @@ -6036,6 +8091,7 @@ the OT1 encoding. The argument is always processed in horizontal mode. The bar is always a fixed position under the baseline, thus crossing through descenders. See also <literal>\underline</literal> in <link linkend="Math-miscellany">Math miscellany</link>. +See also <literal>\b</literal> above. </para> </listitem></varlistentry><varlistentry><term><literal>\v</literal> </term><term><literal>\capitalcaron</literal> @@ -6060,8 +8116,7 @@ descenders. See also <literal>\underline</literal> in <link linkend="Math-misce <para>Here are the basic &latex; commands for inserting characters commonly used in languages other than English. </para> -<variablelist> -<varlistentry><term><literal>\aa</literal> +<variablelist><varlistentry><term><literal>\aa</literal> </term><term><literal>\AA</literal> </term><listitem><indexterm role="fn"><primary>\aa (å)</primary></indexterm> <indexterm role="fn"><primary>\AA (Å)</primary></indexterm> @@ -6144,6 +8199,7 @@ used in languages other than English. </sect1> <sect1 label="21.5" id="_005crule"> <title><literal>\rule</literal></title> + <indexterm role="fn"><primary>\rule</primary></indexterm> <para>Synopsis: @@ -6166,7 +8222,9 @@ rectangles. The arguments are: </sect1> <sect1 label="21.6" id="_005ctoday"> <title><literal>\today</literal></title> + <indexterm role="fn"><primary>\today</primary></indexterm> +<indexterm role="cp"><primary>date, today’s</primary></indexterm> <para>The <literal>\today</literal> command produces today’s date, in the format ‘<literal><replaceable>month</replaceable> <replaceable>dd</replaceable>, <replaceable>yyyy</replaceable></literal>’; for example, ‘July 4, 1976’. @@ -6183,6 +8241,7 @@ of other date formats. </chapter> <chapter label="22" id="Splitting-the-input"> <title>Splitting the input</title> + <indexterm role="cp"><primary>splitting the input file</primary></indexterm> <indexterm role="cp"><primary>input file</primary></indexterm> @@ -6199,6 +8258,7 @@ external file to be created with the main document. <sect1 label="22.1" id="_005cinclude"> <title><literal>\include</literal></title> + <indexterm role="fn"><primary>\include</primary></indexterm> <para>Synopsis: @@ -6222,6 +8282,7 @@ read by another <literal>\include</literal> command. </sect1> <sect1 label="22.2" id="_005cincludeonly"> <title>\<literal>includeonly</literal></title> + <indexterm role="fn"><primary>\includeonly</primary></indexterm> <para>Synopsis: @@ -6239,7 +8300,8 @@ effective. </sect1> <sect1 label="22.3" id="_005cinput"> -<title>\input</title> +<title><literal>\input</literal></title> + <indexterm role="fn"><primary>\input</primary></indexterm> <para>Synopsis: @@ -6255,6 +8317,7 @@ file at that point. or ‘<literal>foo.bar.tex</literal>’). If that is not found, the original <replaceable>file</replaceable> is tried (‘<literal>foo</literal>’ or ‘<literal>foo.bar</literal>’). </para> + </sect1> </chapter> <chapter label="23" id="Front_002fback-matter"> @@ -6295,7 +8358,8 @@ as for the table of contents. <sect2 label="23.1.1" id="_005caddcontentsline"> -<title>\addcontentsline</title> +<title><literal>\addcontentsline</literal></title> + <indexterm role="fn"><primary>\addcontentsline{<replaceable>ext</replaceable>}{<replaceable>unit</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm> <indexterm role="cp"><primary>table of contents entry, manually adding</primary></indexterm> @@ -6331,7 +8395,8 @@ command <literal>\contentsline{<replaceable>unit</replaceable>}{<replaceable>nam </sect2> <sect2 label="23.1.2" id="_005caddtocontents"> -<title>\addtocontents</title> +<title><literal>\addtocontents</literal></title> + <indexterm role="fn"><primary>\addtocontents{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm> <para>The <literal>\addtocontents</literal>{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>} command adds text @@ -6351,6 +8416,7 @@ figures), or <filename>lot</filename> (list of tables). </sect1> <sect1 label="23.2" id="Glossaries"> <title>Glossaries</title> + <indexterm role="cp"><primary>glossaries</primary></indexterm> <indexterm role="fn"><primary>\makeglossary</primary></indexterm> @@ -6374,6 +8440,7 @@ glossaries. </sect1> <sect1 label="23.3" id="Indexes"> <title>Indexes</title> + <indexterm role="cp"><primary>indexes</primary></indexterm> <indexterm role="fn"><primary>\makeindex</primary></indexterm> @@ -6438,59 +8505,119 @@ preparing the index. </chapter> <chapter label="24" id="Letters"> <title>Letters</title> -<indexterm role="cp"><primary>letters</primary></indexterm> -<indexterm role="cp"><primary>creating letters</primary></indexterm> -<para>You can use &latex; to typeset letters, both personal and business. The -<literal>letter</literal> document class is designed to make a number of letters at -once, although you can make just one if you so desire. -</para> -<para>Your <filename>.tex</filename> source file has the same minimum commands as the other -document classes, i.e., you must have the following commands as a -minimum: +<indexterm role="cp"><primary>letters, writing</primary></indexterm> +<indexterm role="cp"><primary>writing letters</primary></indexterm> + +<para>Synopsis: </para> -<screen> \documentclass{letter} - \begin{document} - ... letters ... - \end{document} +<screen>\documentclass{letter} +\address{<replaceable>sender address</replaceable>} +\signature{<replaceable>sender name</replaceable>} +\begin{document} +\begin{letter}{<replaceable>recipient address</replaceable>} +\opening{<replaceable>salutation</replaceable>} + <replaceable>letter body</replaceable> +\closing{<replaceable>closing text</replaceable>} +\end{letter} + ... more letters ... +\end{document} </screen> -<para>Each letter is a <literal>letter</literal> environment, whose argument is the name -and address of the recipient. For example, you might have: +<para>Produce one or more letters. +</para> +<para>Each letter is in a separate <literal>letter</literal> environment, whose argument +<replaceable>recipient address</replaceable> often contains multiple lines separated with a +double backslash (<literal>\\</literal>). For example, you might have: </para> -<screen> \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. - \\ Edinburgh, EH1 1AA} +<screen> \begin{letter}{Mr. Joe Smith \\ + 2345 Princess St. \\ + Edinburgh, EH1 1AA} ... \end{letter} </screen> -<para>The letter itself begins with the <literal>\opening</literal> command. The text of -the letter follows. It is typed as ordinary &latex; input. Commands that -make no sense in a letter, like <literal>\chapter</literal>, do not work. The letter -closes with a <literal>\closing</literal> command. +<para>The start of the <literal>letter</literal> environment resets the page number to 1, +and the footnote number to 1 also. +</para> +<para>The <replaceable>sender address</replaceable> and <replaceable>sender name</replaceable> are common to all of the +letters, whether there is one or more, so these are best put in the +preamble. As with the recipient address, often <replaceable>sender address</replaceable> +contains multiple lines separated by a double +backslash (<literal>\\</literal>). &latex; will put the <replaceable>sender name</replaceable> +under the closing, after a vertical space for the traditional +hand-written signature; it also can contain multiple lines. +</para> +<para>Each letter environment begins with a required <literal>\opening</literal> command +such as <literal>\opening{Dear Madam or Sir:}</literal>. The <replaceable>letter body</replaceable> +text is ordinary &latex; so it can contain everything from from +enumerated lists to displayed math, except that commands such as +<literal>\chapter</literal> that make no sense in a letter are turned off. Each +letter environment typically ends with a <literal>\closing</literal> command such as +<literal>\closing{Yours,}</literal>. </para> <indexterm role="fn"><primary>\\ for letters</primary></indexterm> -<para>After the <literal>closing</literal>, you can have additional material. The -<literal>\cc</literal> command produces the usual “cc: …”. There’s also a -similar <literal>\encl</literal> command for a list of enclosures. With both these -commands, use <literal>\\</literal> to separate the items. -</para> +<para>Additional material may come after the <literal>\closing</literal>. You can say who +is receiving a copy of the letter with a command like <literal>\cc{the +Boss \\ the Boss's Boss}</literal>. There’s a similar <literal>\encl</literal> command for +a list of enclosures. And, you can add a postscript with <literal>\ps</literal>. +</para> +<para>&latex;’s default is to indent the signature and the <literal>\closing</literal> +above it by a length of <literal>\longindentation</literal>. By default this is +<literal>0.5\textwidth</literal>. To make them flush left, put +<literal>\setlength{\longindentation}{0em}</literal> in your preamble. +</para> +<para>To set a fixed date use something like +<literal>\renewcommand{\today}{2015-Oct-12}</literal>. If put in your preamble +then it will apply to all the letters. +</para> +<para>This example shows only one <literal>letter</literal> environment. The three lines +marked as optional are typically omitted. +</para> +<screen>\documentclass{letter} +\address{Sender's street \\ Sender's town} +\signature{Sender's name \\ Sender's title} +% optional: \location{Mailbox 13} +% optional: \telephone{(102) 555-0101} +\begin{document} +\begin{letter}{Recipient's name \\ Recipient's address} +\opening{Sir:} +% optional: \thispagestyle{firstpage} +I am not interested in entering a business arrangement with you. +\closing{Your most humble, etc.,} +\end{letter} +\end{document} +</screen> <para>These commands are used with the <literal>letter</literal> class. </para> <sect1 label="24.1" id="_005caddress"> -<title>\address{<replaceable>return-address}</replaceable></title> +<title><literal>\address</literal></title> + <indexterm role="fn"><primary>\address</primary></indexterm> -<para>The <literal>\address</literal> specifies the return address of a letter, as it -should appear on the letter and the envelope. Separate lines of the -address should be separated by <literal>\\</literal> commands. +<para>Synopsis: +</para> +<screen>\address{<replaceable>senders address</replaceable>} +</screen> +<para>Specifies the return address as it appears on the letter and on the +envelope. Separate multiple lines in <replaceable>senders address</replaceable> with a +double backslash <literal>\\</literal>. +</para> +<para>Because it can apply to multiple letters this declaration is often put +in the preamble. However, it can go anywhere, including inside an +individual <literal>letter</literal> environment. </para> -<para>If you do not make an <literal>\address</literal> declaration, then the letter -will be formatted for copying onto your organization’s standard -letterhead. (See <link linkend="Overview">Overview</link>, for details on your local -implementation). If you give an <literal>\address</literal> declaration, then the -letter will be formatted as a personal letter. +<para>This command is optional: without the <literal>\address</literal> declaration the +letter is formatted with some blank space on top, for copying onto +pre-printed letterhead paper. (See <link linkend="Overview">Overview</link>, for details on your +local implementation.) With the <literal>\address</literal> declaration, it is +formatted as a personal letter. </para> +<para>Here is an example. +</para> +<screen>\address{Stephen Maturin \\ + The Grapes of the Savoy} +</screen> </sect1> <sect1 label="24.2" id="_005ccc"> @@ -6501,11 +8628,17 @@ letter will be formatted as a personal letter. <para>Synopsis: </para> -<screen>\cc{<replaceable>name1</replaceable>\\<replaceable>name2</replaceable>} +<screen>\cc{<replaceable>first name</replaceable> \\ + .. } </screen> -<para>Produce a list of <replaceable>name</replaceable>s the letter was copied to. Each name is -printed on a separate line. +<para>Produce a list of names to which copies of the letter were sent. This +command is optional. If it appears then typically it comes after +<literal>\closing</literal>. Separate multiple lines with a double +backslash <literal>\\</literal>. </para> +<screen>\cc{President \\ + Vice President} +</screen> </sect1> <sect1 label="24.3" id="_005cclosing"> @@ -6519,8 +8652,10 @@ printed on a separate line. </para> <screen>\closing{text} </screen> -<para>A letter closes with a <literal>\closing</literal> command, for example, -</para><screen>\closing{Best Regards,} +<para>Usually at the end of a letter, above the handwritten signature, there +is a <literal>\closing</literal> (although this command is optional). For example, +</para> +<screen>\closing{Regards,} </screen> </sect1> @@ -6532,48 +8667,75 @@ printed on a separate line. <para>Synopsis: </para> -<screen>\encl{<replaceable>line1</replaceable>\\<replaceable>line2</replaceable>} +<screen>\encl{<replaceable>first enclosed object</replaceable> \\ + .. } </screen> -<para>Declare a list of one more enclosures. +<para>Produce a list of things included with the letter. This command is +optional; when it is used, it typically is put after <literal>\closing</literal>. +Separate multiple lines with a double backslash <literal>\\</literal>. </para> +<screen>\encl{License \\ + Passport } +</screen> </sect1> <sect1 label="24.5" id="_005clocation"> <title><literal>\location</literal></title> + <indexterm role="fn"><primary>\location</primary></indexterm> -<para><literal>\location{address}</literal> +<para>Synopsis: </para> -<para>This modifies your organization’s standard address. This only appears -if the <literal>firstpage</literal> pagestyle is selected. +<screen>\location{<replaceable>text</replaceable>} +</screen> +<para>The <replaceable>text</replaceable> appears centered at the bottom of the each page. It only +appears if the page style is <literal>firstpage</literal>. </para> </sect1> <sect1 label="24.6" id="_005cmakelabels"> <title><literal>\makelabels</literal></title> + <indexterm role="fn"><primary>\makelabels</primary></indexterm> -<para><literal>\makelabels{number}</literal> +<para>Synopsis: </para> -<para>If you issue this command in the preamble, &latex; will create a sheet of -address labels. This sheet will be output before the letters. +<screen>\makelabels +</screen> +<para>Create a sheet of address labels from the recipient addresses, one for +each letter. This sheet will be output before the letters, with the idea +that you can copy it to a sheet of peel-off labels. This command goes +in the preamble. +</para> +<para>Customize the labels by redefining the commands <literal>\startlabels</literal>, +<literal>\mlabel</literal>, and <literal>\returnaddress</literal> in the preamble. The command +<literal>\startlabels</literal> sets the width, height, number of columns, etc., of +the page onto which the labels are printed. The command +<literal>\mlabel{<replaceable>sender address</replaceable>}{<replaceable>recipient address</replaceable>}</literal> +produces the two labels (or one, if you choose to ignore the <replaceable>sender +address</replaceable>). The <replaceable>sender address</replaceable> is the value returned by the macro +<literal>\returnaddress</literal> while <replaceable>recipient address</replaceable> is the value passed +in the argument to the <literal>letter</literal> environment. By default +<literal>\mlabel</literal> ignores the first argument, the <replaceable>sender address</replaceable>. </para> - - </sect1> <sect1 label="24.7" id="_005cname"> <title><literal>\name</literal></title> + <indexterm role="fn"><primary>\name</primary></indexterm> -<para><literal>\name{June Davenport}</literal> +<para>Synopsis: </para> -<para>Your name, used for printing on the envelope together with the return -address. +<screen>\name{<replaceable>name</replaceable>} +</screen> +<para>Sender’s name, used for printing on the envelope together with the +return address. </para> </sect1> <sect1 label="24.8" id="_005copening"> -<title><literal>\opening{<replaceable>text</replaceable>}</literal></title> +<title><literal>\opening</literal></title> + <indexterm role="fn"><primary>\opening</primary></indexterm> <indexterm role="cp"><primary>letters, starting</primary></indexterm> @@ -6581,11 +8743,11 @@ address. </para> <screen>\opening{<replaceable>text</replaceable>} </screen> -<para>A letter begins with the <literal>\opening</literal> command. The mandatory -argument, <replaceable>text</replaceable>, is whatever text you wish to start your letter. -For instance: +<para>This command is required. It starts a letter, following the +<literal>\begin{letter}{..}</literal>. The mandatory argument <replaceable>text</replaceable> is the +text that starts your letter. For instance: </para> -<screen>\opening{Dear Joe,} +<screen>\opening{Dear John:} </screen> </sect1> @@ -6594,62 +8756,99 @@ For instance: <indexterm role="fn"><primary>\ps</primary></indexterm> <indexterm role="cp"><primary>postscript, in letters</primary></indexterm> -<para>Use the <literal>\ps</literal> command to start a postscript in a letter, after +<para>Synopsis: +</para> +<screen>\ps{<replaceable>text</replaceable>} +</screen> +<para>Add a postscript. This command is optional and usually is used after <literal>\closing</literal>. </para> +<screen>\ps{P.S. After you have read this letter, burn it. Or eat it.} +</screen> </sect1> <sect1 label="24.10" id="_005csignature"> -<title><literal>\signature{<replaceable>text</replaceable>}</literal></title> -<indexterm role="fn"><primary>\signature</primary></indexterm> +<title><literal>\signature</literal></title> -<para>Your name, as it should appear at the end of the letter underneath the -space for your signature. <literal>\\</literal> starts a new line within -<replaceable>text</replaceable> as usual. +<para>Synopsis: </para> +<screen>\signature{<replaceable>first line</replaceable> \\ + .. } +</screen> +<indexterm role="fn"><primary>\signature</primary></indexterm> -</sect1> -<sect1 label="24.11" id="_005cstartbreaks"> -<title><literal>\startbreaks</literal></title> -<indexterm role="fn"><primary>\startbreaks</primary></indexterm> - -<para><literal>\startbreaks</literal> +<para>The sender’s name. This command is optional, although its inclusion is +usual. </para> -<para>Used after a <literal>\stopbreaks</literal> command to allow page breaks again. +<para>The argument text appears at the end of the letter, after the closing +and after a vertical space for the traditional hand-written +signature. Separate multiple lines with a double +backslash <literal>\\</literal>. For example: </para> - -</sect1> -<sect1 label="24.12" id="_005cstopbreaks"> -<title><literal>\stopbreaks</literal></title> -<indexterm role="fn"><primary>\stopbreaks</primary></indexterm> - -<para><literal>\stopbreaks</literal> +<screen>\signature{J Fred Muggs \\ + White House} +</screen> +<para>&latex;’s default for the vertical space from the <literal>\closing</literal> text +down to the <literal>\signature</literal> text is <literal>6\medskipamount</literal>, which is +six times 0.7em. </para> -<para>Inhibit page breaks until a <literal>\startbreaks</literal> command occurs. +<para>This command is usually in the preamble, to apply to all the letters in +the document. To have it apply to one letter only, put it inside a +<literal>letter</literal> environment and before the <literal>\closing</literal>. </para> +<para>You can include a graphic in the signature, for instance with +<literal>\signature{\vspace{-6\medskipamount}\includegraphics{sig.png}\\ +My name}</literal> (this requires writing <literal>\usepackage{graphicx}</literal> in the +preamble). +</para> + +<!-- I think this is not a user-level command; it is used to keep from breaking --> +<!-- the page between the closing and the signature --> +<!-- @node \stopbreaks and \startbreaks --> +<!-- @section @code{\stopbreaks} and @code{\startbreaks} --> + +<!-- @findex \startbreak --> +<!-- @findex \stopbreaks --> +<!-- @example --> +<!-- @code{\stopbreaks} --> +<!-- text --> +<!-- @code{\startbreaks} --> +<!-- @end example --> + +<!-- The @code{\stopbreaks} inhibits page breaking. The @code{\startbreaks} resumes --> +<!-- normal page breaking. --> +<!-- --> +<!-- --> </sect1> -<sect1 label="24.13" id="_005ctelephone"> +<sect1 label="24.11" id="_005ctelephone"> <title><literal>\telephone</literal></title> + <indexterm role="fn"><primary>\telephone</primary></indexterm> -<para><literal>\telephone{number}</literal> +<para>Synopsis: </para> -<para>This is your telephone number. This only appears if the -<literal>firstpage</literal> pagestyle is selected. +<screen>\telephone{<replaceable>number</replaceable>} +</screen> +<para>The sender’s telephone number. This is typically in the preamble, where +it applies to all letters. This only appears if the <literal>firstpage</literal> +pagestyle is selected. If so, it appears on the lower right of the +page. </para> </sect1> </chapter> <chapter label="25" id="Terminal-input_002foutput"> <title>Terminal input/output</title> -<indexterm role="cp"><primary>input/output</primary></indexterm> + +<indexterm role="cp"><primary>input/output, to terminal</primary></indexterm> <indexterm role="cp"><primary>terminal input/output</primary></indexterm> <sect1 label="25.1" id="_005ctypein"> <title><literal>\typein[<replaceable>cmd</replaceable>]{<replaceable>msg</replaceable>}</literal></title> + <indexterm role="fn"><primary>\typein</primary></indexterm> <para>Synopsis: @@ -6668,6 +8867,7 @@ redefined to be the typed input. </sect1> <sect1 label="25.2" id="_005ctypeout"> <title><literal>\typeout{<replaceable>msg</replaceable>}</literal></title> + <indexterm role="fn"><primary>\typeout</primary></indexterm> <para>Synopsis: @@ -6690,6 +8890,7 @@ printed, independent of surrounding spaces. A <literal>^^J</literal> in </chapter> <chapter label="26" id="Command-line"> <title>Command line</title> + <indexterm role="cp"><primary>command line</primary></indexterm> <indexterm role="fn"><primary>.tex, default extension</primary></indexterm> @@ -6720,7 +8921,9 @@ be specified in the usual Unix way, starting with ‘<literal>-</literal> </chapter> <appendix label="A" id="Document-templates"> <title>Document templates</title> + <indexterm role="cp"><primary>document templates</primary></indexterm> +<indexterm role="cp"><primary>templates, document</primary></indexterm> <para>Although not reference material, perhaps these document templates will be useful. Additional template resources are listed at @@ -6732,6 +8935,8 @@ be useful. Additional template resources are listed at <title><literal>beamer</literal> template</title> <indexterm role="cp"><primary><literal>beamer</literal> template and class</primary></indexterm> +<indexterm role="cp"><primary>template, <literal>beamer</literal></primary></indexterm> + <para>The <literal>beamer</literal> class creates presentation slides. It has a vast array of features, but here is a basic template: </para> @@ -6765,6 +8970,8 @@ array of features, but here is a basic template: <sect1 label="A.2" id="book-template"> <title><literal>book</literal> template</title> +<indexterm role="cp"><primary>template, <literal>book</literal></primary></indexterm> + <screen>\documentclass{book} \title{Book Class Template} \author{Alex Author} @@ -6787,6 +8994,7 @@ The end. <sect1 label="A.3" id="tugboat-template"> <title><literal>tugboat</literal> template</title> +<indexterm role="cp"><primary>template, TUGboat</primary></indexterm> <indexterm role="cp"><primary>TUGboat template</primary></indexterm> <indexterm role="cp"><primary><literal>ltugboat</literal> class</primary></indexterm> diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html index 6d6fb8eed5f..5606ddbb59b 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html @@ -1,7 +1,7 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- This document is an unofficial reference manual for LaTeX, a -document preparation system, version of May 2015. +document preparation system, version of October 2015. This manual was originally translated from LATEX.HLP v1.0a in the VMS Help Library. The pre-translation version was written by @@ -34,20 +34,20 @@ notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions. --> -<!-- Created by Texinfo 5.9.91+dev, http://www.gnu.org/software/texinfo/ --> +<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ --> <head> -<title>LaTeX2e unofficial reference manual (May 2015)</title> +<title>LaTeX2e unofficial reference manual (October 2015)</title> -<meta name="description" content="LaTeX2e unofficial reference manual (May 2015)"> -<meta name="keywords" content="LaTeX2e unofficial reference manual (May 2015)"> +<meta name="description" content="LaTeX2e unofficial reference manual (October 2015)"> +<meta name="keywords" content="LaTeX2e unofficial reference manual (October 2015)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> -<meta name="Generator" content="texi2any"> +<meta name="Generator" content="makeinfo"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <link href="#Top" rel="start" title="Top"> <link href="#Concept-Index" rel="index" title="Concept Index"> <link href="#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="dir.html#Top" rel="up" title="(dir)"> +<link href="http://tug.org/texinfohtml/" rel="up" title="(dir)"> <style type="text/css"> <!-- a.summary-letter {text-decoration: none} @@ -81,7 +81,7 @@ ul.no-bullet {list-style: none} </head> <body lang="en"> -<h1 class="settitle" align="center">LaTeX2e unofficial reference manual (May 2015)</h1> +<h1 class="settitle" align="center">LaTeX2e unofficial reference manual (October 2015)</h1> @@ -156,6 +156,7 @@ ul.no-bullet {list-style: none} <li><a name="toc-_005cflushbottom-1" href="#g_t_005cflushbottom">5.3 <code>\flushbottom</code></a></li> <li><a name="toc-_005craggedbottom-1" href="#g_t_005craggedbottom">5.4 <code>\raggedbottom</code></a></li> <li><a name="toc-Page-layout-parameters-1" href="#Page-layout-parameters">5.5 Page layout parameters</a></li> + <li><a name="toc-Floats-1" href="#Floats">5.6 Floats</a></li> </ul></li> <li><a name="toc-Sectioning-1" href="#Sectioning">6 Sectioning</a></li> <li><a name="toc-Cross-references-1" href="#Cross-references">7 Cross references</a> @@ -179,7 +180,7 @@ ul.no-bullet {list-style: none} <li><a name="toc-eqnarray-1" href="#eqnarray">8.8 <code>eqnarray</code></a></li> <li><a name="toc-equation-1" href="#equation">8.9 <code>equation</code></a></li> <li><a name="toc-figure-1" href="#figure">8.10 <code>figure</code></a></li> - <li><a name="toc-filecontents_003a-Create-external-files" href="#filecontents">8.11 <code>filecontents</code>: Create external files</a></li> + <li><a name="toc-filecontents_003a-Write-an-external-file" href="#filecontents">8.11 <code>filecontents</code>: Write an external file</a></li> <li><a name="toc-flushleft-1" href="#flushleft">8.12 <code>flushleft</code></a> <ul class="no-bullet"> <li><a name="toc-_005craggedright-1" href="#g_t_005craggedright">8.12.1 <code>\raggedright</code></a></li> @@ -210,35 +211,34 @@ ul.no-bullet {list-style: none} <li><a name="toc-_005cshortstack-1" href="#g_t_005cshortstack">8.19.13 <code>\shortstack</code></a></li> <li><a name="toc-_005cvector-1" href="#g_t_005cvector">8.19.14 <code>\vector</code></a></li> </ul></li> - <li><a name="toc-quotation-1" href="#quotation">8.20 <code>quotation</code></a></li> - <li><a name="toc-quote-1" href="#quote">8.21 <code>quote</code></a></li> - <li><a name="toc-tabbing-1" href="#tabbing">8.22 <code>tabbing</code></a></li> - <li><a name="toc-table-1" href="#table">8.23 <code>table</code></a></li> - <li><a name="toc-tabular-1" href="#tabular">8.24 <code>tabular</code></a> + <li><a name="toc-quotation-and-quote-1" href="#quotation-and-quote">8.20 <code>quotation</code> and <code>quote</code></a></li> + <li><a name="toc-tabbing-1" href="#tabbing">8.21 <code>tabbing</code></a></li> + <li><a name="toc-table-1" href="#table">8.22 <code>table</code></a></li> + <li><a name="toc-tabular-1" href="#tabular">8.23 <code>tabular</code></a> <ul class="no-bullet"> - <li><a name="toc-_005cmulticolumn-1" href="#g_t_005cmulticolumn">8.24.1 <code>\multicolumn</code></a></li> - <li><a name="toc-_005ccline-1" href="#g_t_005ccline">8.24.2 <code>\cline</code></a></li> - <li><a name="toc-_005chline-1" href="#g_t_005chline">8.24.3 <code>\hline</code></a></li> - <li><a name="toc-_005cvline-1" href="#g_t_005cvline">8.24.4 <code>\vline</code></a></li> + <li><a name="toc-_005cmulticolumn-1" href="#g_t_005cmulticolumn">8.23.1 <code>\multicolumn</code></a></li> + <li><a name="toc-_005cvline-1" href="#g_t_005cvline">8.23.2 <code>\vline</code></a></li> + <li><a name="toc-_005ccline-1" href="#g_t_005ccline">8.23.3 <code>\cline</code></a></li> + <li><a name="toc-_005chline-1" href="#g_t_005chline">8.23.4 <code>\hline</code></a></li> </ul></li> - <li><a name="toc-thebibliography-1" href="#thebibliography">8.25 <code>thebibliography</code></a> + <li><a name="toc-thebibliography-1" href="#thebibliography">8.24 <code>thebibliography</code></a> <ul class="no-bullet"> - <li><a name="toc-_005cbibitem-1" href="#g_t_005cbibitem">8.25.1 <code>\bibitem</code></a></li> - <li><a name="toc-_005ccite-1" href="#g_t_005ccite">8.25.2 <code>\cite</code></a></li> - <li><a name="toc-_005cnocite-1" href="#g_t_005cnocite">8.25.3 <code>\nocite</code></a></li> - <li><a name="toc-Using-BibTeX-1" href="#Using-BibTeX">8.25.4 Using BibTeX</a></li> + <li><a name="toc-_005cbibitem-1" href="#g_t_005cbibitem">8.24.1 <code>\bibitem</code></a></li> + <li><a name="toc-_005ccite-1" href="#g_t_005ccite">8.24.2 <code>\cite</code></a></li> + <li><a name="toc-_005cnocite-1" href="#g_t_005cnocite">8.24.3 <code>\nocite</code></a></li> + <li><a name="toc-Using-BibTeX-1" href="#Using-BibTeX">8.24.4 Using BibTeX</a></li> </ul></li> - <li><a name="toc-theorem-1" href="#theorem">8.26 <code>theorem</code></a></li> - <li><a name="toc-titlepage-1" href="#titlepage">8.27 <code>titlepage</code></a></li> - <li><a name="toc-verbatim-1" href="#verbatim">8.28 <code>verbatim</code></a> + <li><a name="toc-theorem-1" href="#theorem">8.25 <code>theorem</code></a></li> + <li><a name="toc-titlepage-1" href="#titlepage">8.26 <code>titlepage</code></a></li> + <li><a name="toc-verbatim-1" href="#verbatim">8.27 <code>verbatim</code></a> <ul class="no-bullet"> - <li><a name="toc-_005cverb-1" href="#g_t_005cverb">8.28.1 <code>\verb</code></a></li> + <li><a name="toc-_005cverb-1" href="#g_t_005cverb">8.27.1 <code>\verb</code></a></li> </ul></li> - <li><a name="toc-verse-1" href="#verse">8.29 <code>verse</code></a></li> + <li><a name="toc-verse-1" href="#verse">8.28 <code>verse</code></a></li> </ul></li> <li><a name="toc-Line-breaking-1" href="#Line-breaking">9 Line breaking</a> <ul class="no-bullet"> - <li><a name="toc-_005c_005c_005b_002a_005d_005bmorespace_005d" href="#g_t_005c_005c">9.1 <code>\\</code>[*][<var>morespace</var>]</a></li> + <li><a name="toc-_005c_005c-1" href="#g_t_005c_005c">9.1 <code>\\</code></a></li> <li><a name="toc-_005cobeycr-_0026-_005crestorecr-1" href="#g_t_005cobeycr-_0026-_005crestorecr">9.2 <code>\obeycr</code> & <code>\restorecr</code></a></li> <li><a name="toc-_005cnewline-1" href="#g_t_005cnewline">9.3 <code>\newline</code></a></li> <li><a name="toc-_005c_002d-_0028discretionary-hyphen_0029" href="#g_t_005c_002d-_0028hyphenation_0029">9.4 <code>\-</code> (discretionary hyphen)</a></li> @@ -260,19 +260,23 @@ ul.no-bullet {list-style: none} <li><a name="toc-_005cfootnote-1" href="#g_t_005cfootnote">11.1 <code>\footnote</code></a></li> <li><a name="toc-_005cfootnotemark-1" href="#g_t_005cfootnotemark">11.2 <code>\footnotemark</code></a></li> <li><a name="toc-_005cfootnotetext-1" href="#g_t_005cfootnotetext">11.3 <code>\footnotetext</code></a></li> - <li><a name="toc-Symbolic-footnotes-1" href="#Symbolic-footnotes">11.4 Symbolic footnotes</a></li> - <li><a name="toc-Footnote-parameters-1" href="#Footnote-parameters">11.5 Footnote parameters</a></li> + <li><a name="toc-Footnotes-in-a-table-1" href="#Footnotes-in-a-table">11.4 Footnotes in a table</a></li> + <li><a name="toc-Footnotes-in-section-headings-1" href="#Footnotes-in-section-headings">11.5 Footnotes in section headings</a></li> + <li><a name="toc-Footnotes-of-footnotes-1" href="#Footnotes-of-footnotes">11.6 Footnotes of footnotes</a></li> + <li><a name="toc-Multiple-references-to-footnotes" href="#Multiple-reference-to-footnotes">11.7 Multiple references to footnotes</a></li> + <li><a name="toc-Footnote-parameters-1" href="#Footnote-parameters">11.8 Footnote parameters</a></li> </ul></li> <li><a name="toc-Definitions-1" href="#Definitions">12 Definitions</a> <ul class="no-bullet"> <li><a name="toc-_005cnewcommand-_0026-_005crenewcommand-1" href="#g_t_005cnewcommand-_0026-_005crenewcommand">12.1 <code>\newcommand</code> & <code>\renewcommand</code></a></li> - <li><a name="toc-_005cnewcounter-1" href="#g_t_005cnewcounter">12.2 <code>\newcounter</code></a></li> - <li><a name="toc-_005cnewlength-1" href="#g_t_005cnewlength">12.3 <code>\newlength</code></a></li> - <li><a name="toc-_005cnewsavebox-1" href="#g_t_005cnewsavebox">12.4 <code>\newsavebox</code></a></li> - <li><a name="toc-_005cnewenvironment-_0026-_005crenewenvironment-1" href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">12.5 <code>\newenvironment</code> & <code>\renewenvironment</code></a></li> - <li><a name="toc-_005cnewtheorem-1" href="#g_t_005cnewtheorem">12.6 <code>\newtheorem</code></a></li> - <li><a name="toc-_005cnewfont-1" href="#g_t_005cnewfont">12.7 <code>\newfont</code></a></li> - <li><a name="toc-_005cprotect-1" href="#g_t_005cprotect">12.8 <code>\protect</code></a></li> + <li><a name="toc-_005cprovidecommand-1" href="#g_t_005cprovidecommand">12.2 <code>\providecommand</code></a></li> + <li><a name="toc-_005cnewcounter_003a-Allocating-a-counter" href="#g_t_005cnewcounter">12.3 <code>\newcounter</code>: Allocating a counter</a></li> + <li><a name="toc-_005cnewlength_003a-Allocating-a-length" href="#g_t_005cnewlength">12.4 <code>\newlength</code>: Allocating a length</a></li> + <li><a name="toc-_005cnewsavebox_003a-Allocating-a-box" href="#g_t_005cnewsavebox">12.5 <code>\newsavebox</code>: Allocating a box</a></li> + <li><a name="toc-_005cnewenvironment-_0026-_005crenewenvironment-1" href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">12.6 <code>\newenvironment</code> & <code>\renewenvironment</code></a></li> + <li><a name="toc-_005cnewtheorem-1" href="#g_t_005cnewtheorem">12.7 <code>\newtheorem</code></a></li> + <li><a name="toc-_005cnewfont_003a-Define-a-new-font-_0028obsolete_0029" href="#g_t_005cnewfont">12.8 <code>\newfont</code>: Define a new font (obsolete)</a></li> + <li><a name="toc-_005cprotect-1" href="#g_t_005cprotect">12.9 <code>\protect</code></a></li> </ul></li> <li><a name="toc-Counters-1" href="#Counters">13 Counters</a> <ul class="no-bullet"> @@ -287,12 +291,13 @@ ul.no-bullet {list-style: none} </ul></li> <li><a name="toc-Lengths-1" href="#Lengths">14 Lengths</a> <ul class="no-bullet"> - <li><a name="toc-_005csetlength_007b_005clen_007d_007bvalue_007d" href="#g_t_005csetlength">14.1 <code>\setlength{\<var>len</var>}{<var>value</var>}</code></a></li> - <li><a name="toc-_005caddtolength_007b_005clen_007d_007bamount_007d" href="#g_t_005caddtolength">14.2 \addtolength{<var>\len</var>}{<var>amount</var>}</a></li> - <li><a name="toc-_005csettodepth-1" href="#g_t_005csettodepth">14.3 <code>\settodepth</code></a></li> - <li><a name="toc-_005csettoheight-1" href="#g_t_005csettoheight">14.4 <code>\settoheight</code></a></li> - <li><a name="toc-_005csettowidth_007b_005clen_007d_007btext_007d" href="#g_t_005csettowidth">14.5 <code>\settowidth{\<var>len</var>}{<var>text</var>}</code></a></li> - <li><a name="toc-Predefined-lengths-1" href="#Predefined-lengths">14.6 Predefined lengths</a></li> + <li><a name="toc-Units-of-length-1" href="#Units-of-length">14.1 Units of length</a></li> + <li><a name="toc-_005csetlength_007b_005clen_007d_007bvalue_007d" href="#g_t_005csetlength">14.2 <code>\setlength{\<var>len</var>}{<var>value</var>}</code></a></li> + <li><a name="toc-_005caddtolength_007b_005clen_007d_007bamount_007d" href="#g_t_005caddtolength">14.3 <code>\addtolength{<var>\len</var>}{<var>amount</var>}</code></a></li> + <li><a name="toc-_005csettodepth-1" href="#g_t_005csettodepth">14.4 <code>\settodepth</code></a></li> + <li><a name="toc-_005csettoheight-1" href="#g_t_005csettoheight">14.5 <code>\settoheight</code></a></li> + <li><a name="toc-_005csettowidth_007b_005clen_007d_007btext_007d" href="#g_t_005csettowidth">14.6 <code>\settowidth{\<var>len</var>}{<var>text</var>}</code></a></li> + <li><a name="toc-Predefined-lengths-1" href="#Predefined-lengths">14.7 Predefined lengths</a></li> </ul></li> <li><a name="toc-Making-paragraphs-1" href="#Making-paragraphs">15 Making paragraphs</a> <ul class="no-bullet"> @@ -322,16 +327,16 @@ ul.no-bullet {list-style: none} <ul class="no-bullet"> <li><a name="toc-_005chspace-1" href="#g_t_005chspace">19.1 <code>\hspace</code></a></li> <li><a name="toc-_005chfill-1" href="#g_t_005chfill">19.2 <code>\hfill</code></a></li> - <li><a name="toc-_005cSPACE_003a-Normal-interword-space" href="#g_t_005cSPACE">19.3 <code>\SPACE</code>: Normal interword space</a></li> - <li><a name="toc-_005c_0040_003a-Force-sentence_002dending-punctuation" href="#g_t_005c_0040">19.4 <code>\@</code>: Force sentence-ending punctuation</a></li> - <li><a name="toc-_005cthinspace_003a-Insert-1_002f6em" href="#g_t_005cthinspace">19.5 <code>\thinspace</code>: Insert 1/6em</a></li> - <li><a name="toc-_005c_002f_003a-Insert-italic-correction" href="#g_t_005c_002f">19.6 <code>\/</code>: Insert italic correction</a></li> - <li><a name="toc-_005chrulefill-1" href="#g_t_005chrulefill">19.7 <code>\hrulefill</code></a></li> - <li><a name="toc-_005cdotfill-1" href="#g_t_005cdotfill">19.8 <code>\dotfill</code></a></li> + <li><a name="toc-_005c_0028SPACE_0029-and-_005c_0040-1" href="#g_t_005c_0028SPACE_0029-and-_005c_0040">19.3 <code>\(SPACE)</code> and \@</a></li> + <li><a name="toc-_005c--after-a-control-sequence" href="#g_t_005c_0028SPACE_0029-after-CS">19.4 <code>\ </code> after a control sequence</a></li> + <li><a name="toc-_005cfrenchspacing-1" href="#g_t_005cfrenchspacing">19.5 <code>\frenchspacing</code></a></li> + <li><a name="toc-_005cthinspace_003a-Insert-1_002f6em" href="#g_t_005cthinspace">19.6 <code>\thinspace</code>: Insert 1/6em</a></li> + <li><a name="toc-_005c_002f_003a-Insert-italic-correction" href="#g_t_005c_002f">19.7 <code>\/</code>: Insert italic correction</a></li> + <li><a name="toc-_005chrulefill-_005cdotfill-1" href="#g_t_005chrulefill-_005cdotfill">19.8 <code>\hrulefill \dotfill</code></a></li> <li><a name="toc-_005caddvspace-1" href="#g_t_005caddvspace">19.9 <code>\addvspace</code></a></li> <li><a name="toc-_005cbigskip-_005cmedskip-_005csmallskip-1" href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">19.10 <code>\bigskip \medskip \smallskip</code></a></li> <li><a name="toc-_005cvfill-1" href="#g_t_005cvfill">19.11 <code>\vfill</code></a></li> - <li><a name="toc-_005cvspace_005b_002a_005d_007blength_007d" href="#g_t_005cvspace">19.12 <code>\vspace[*]{<var>length</var>}</code></a></li> + <li><a name="toc-_005cvspace_007blength_007d" href="#g_t_005cvspace">19.12 <code>\vspace{<var>length</var>}</code></a></li> </ul></li> <li><a name="toc-Boxes-1" href="#Boxes">20 Boxes</a> <ul class="no-bullet"> @@ -358,33 +363,31 @@ ul.no-bullet {list-style: none} <ul class="no-bullet"> <li><a name="toc-_005cinclude-1" href="#g_t_005cinclude">22.1 <code>\include</code></a></li> <li><a name="toc-_005cincludeonly-1" href="#g_t_005cincludeonly">22.2 \<code>includeonly</code></a></li> - <li><a name="toc-_005cinput-1" href="#g_t_005cinput">22.3 \input</a></li> + <li><a name="toc-_005cinput-1" href="#g_t_005cinput">22.3 <code>\input</code></a></li> </ul></li> <li><a name="toc-Front_002fback-matter-1" href="#Front_002fback-matter">23 Front/back matter</a> <ul class="no-bullet"> <li><a name="toc-Tables-of-contents-1" href="#Tables-of-contents">23.1 Tables of contents</a> <ul class="no-bullet"> - <li><a name="toc-_005caddcontentsline-1" href="#g_t_005caddcontentsline">23.1.1 \addcontentsline</a></li> - <li><a name="toc-_005caddtocontents-1" href="#g_t_005caddtocontents">23.1.2 \addtocontents</a></li> + <li><a name="toc-_005caddcontentsline-1" href="#g_t_005caddcontentsline">23.1.1 <code>\addcontentsline</code></a></li> + <li><a name="toc-_005caddtocontents-1" href="#g_t_005caddtocontents">23.1.2 <code>\addtocontents</code></a></li> </ul></li> <li><a name="toc-Glossaries-1" href="#Glossaries">23.2 Glossaries</a></li> <li><a name="toc-Indexes-1" href="#Indexes">23.3 Indexes</a></li> </ul></li> <li><a name="toc-Letters-1" href="#Letters">24 Letters</a> <ul class="no-bullet"> - <li><a name="toc-_005caddress_007breturn_002daddress_007d" href="#g_t_005caddress">24.1 \address{<var>return-address}</var></a></li> + <li><a name="toc-_005caddress-1" href="#g_t_005caddress">24.1 <code>\address</code></a></li> <li><a name="toc-_005ccc-1" href="#g_t_005ccc">24.2 <code>\cc</code></a></li> <li><a name="toc-_005cclosing-1" href="#g_t_005cclosing">24.3 <code>\closing</code></a></li> <li><a name="toc-_005cencl-1" href="#g_t_005cencl">24.4 <code>\encl</code></a></li> <li><a name="toc-_005clocation-1" href="#g_t_005clocation">24.5 <code>\location</code></a></li> <li><a name="toc-_005cmakelabels-1" href="#g_t_005cmakelabels">24.6 <code>\makelabels</code></a></li> <li><a name="toc-_005cname-1" href="#g_t_005cname">24.7 <code>\name</code></a></li> - <li><a name="toc-_005copening_007btext_007d" href="#g_t_005copening">24.8 <code>\opening{<var>text</var>}</code></a></li> + <li><a name="toc-_005copening-1" href="#g_t_005copening">24.8 <code>\opening</code></a></li> <li><a name="toc-_005cps-1" href="#g_t_005cps">24.9 <code>\ps</code></a></li> - <li><a name="toc-_005csignature_007btext_007d" href="#g_t_005csignature">24.10 <code>\signature{<var>text</var>}</code></a></li> - <li><a name="toc-_005cstartbreaks-1" href="#g_t_005cstartbreaks">24.11 <code>\startbreaks</code></a></li> - <li><a name="toc-_005cstopbreaks-1" href="#g_t_005cstopbreaks">24.12 <code>\stopbreaks</code></a></li> - <li><a name="toc-_005ctelephone-1" href="#g_t_005ctelephone">24.13 <code>\telephone</code></a></li> + <li><a name="toc-_005csignature-1" href="#g_t_005csignature">24.10 <code>\signature</code></a></li> + <li><a name="toc-_005ctelephone-1" href="#g_t_005ctelephone">24.11 <code>\telephone</code></a></li> </ul></li> <li><a name="toc-Terminal-input_002foutput-1" href="#Terminal-input_002foutput">25 Terminal input/output</a> <ul class="no-bullet"> @@ -404,16 +407,17 @@ ul.no-bullet {list-style: none} </div> + <a name="Top"></a> <div class="header"> <p> -Next: <a href="#About-this-document" accesskey="n" rel="next">About this document</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#About-this-document" accesskey="n" rel="next">About this document</a>, Up: <a href="http://tug.org/texinfohtml/" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="LaTeX2e_003a-An-unofficial-reference-manual"></a> <h1 class="top">LaTeX2e: An unofficial reference manual</h1> <p>This document is an unofficial reference manual (version of -May 2015) for LaTeX2e, a document preparation system. +October 2015) for LaTeX2e, a document preparation system. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#About-this-document" accesskey="1">About this document</a>:</td><td> </td><td align="left" valign="top">Bug reporting, etc. @@ -573,7 +577,7 @@ should be formatted. It is implemented as a set of related commands that interface with Donald E. Knuth’s TeX typesetting program (the technical term is that LaTeX is a <em>macro package</em> for the TeX engine). The user produces the output document by giving that -file to the TeX engine. +input file to the TeX engine. </p> <p>The term LaTeX is also sometimes used to mean the language in which the document is marked up, that is, to mean the set of commands @@ -591,7 +595,7 @@ sensible, such as in plain text, write it as ‘<samp>LaTeX</samp>’. </td></tr> <tr><td align="left" valign="top">• <a href="#Output-files" accesskey="2">Output files</a>:</td><td> </td><td align="left" valign="top">Files produced. </td></tr> -<tr><td align="left" valign="top">• <a href="#TeX-engines" accesskey="3">TeX engines</a>:</td><td> </td><td align="left" valign="top">Programs that implementation LaTeX. +<tr><td align="left" valign="top">• <a href="#TeX-engines" accesskey="3">TeX engines</a>:</td><td> </td><td align="left" valign="top">Programs that can compile TeX and LaTeX. </td></tr> <tr><td align="left" valign="top">• <a href="#LaTeX-command-syntax" accesskey="4">LaTeX command syntax</a>:</td><td> </td><td align="left" valign="top">General syntax of LaTeX commands. </td></tr> @@ -607,12 +611,12 @@ Next: <a href="#Output-files" accesskey="n" rel="next">Output files</a>, Up: <a <a name="Starting-and-ending-1"></a> <h3 class="section">2.1 Starting and ending</h3> -<a name="Starting-_0026-ending"></a><a name="index-starting-_0026-ending"></a> -<a name="index-ending-_0026-starting"></a> +<a name="Starting-_0026-ending"></a><a name="index-starting-and-ending"></a> +<a name="index-ending-and-starting"></a> <a name="index-hello_002c-world"></a> -<p>LaTeX files have a simple global structure, with a standard -starting and ending. Here is a “hello, world” example: +<p>LaTeX files have a simple global structure, with a standard beginning +and ending. Here is a “hello, world” example: </p> <div class="example"> <pre class="example">\documentclass{article} @@ -633,9 +637,10 @@ array of others are widely available. See <a href="#Document-classes">Document This area is called the <em>preamble</em>. </p> <p>The <code>\begin{document} ... \end{document}</code> is a so-called +<a name="index-environment"></a> <em>environment</em>; the ‘<samp>document</samp>’ environment (and no others) is -required in all LaTeX documents. LaTeX provides many -environments itself, and many more are defined separately. +required in all LaTeX documents (see <a href="#document">document</a>). LaTeX +provides many environments itself, and many more are defined separately. See <a href="#Environments">Environments</a>. </p> <p>The following sections discuss how to produce PDF or other output from @@ -756,7 +761,7 @@ overview of the main programs. <dd><a name="index-pdfTeX-engine"></a> <a name="index-etex-command"></a> <a name="index-e_002dTeX"></a> -<p>In TeX Live (<a href="http://tug.org/texlive">http://tug.org/texlive</a>, if LaTeX is invoked +<p>In TeX Live (<a href="http://tug.org/texlive">http://tug.org/texlive</a>), if LaTeX is invoked via either the system command <code>latex</code> or <code>pdflatex</code>, then the pdfTeX engine is run (<a href="http://ctan.org/pkg/pdftex">http://ctan.org/pkg/pdftex</a>). When invoked as <code>latex</code>, the main output is a <samp>.dvi</samp> @@ -765,9 +770,9 @@ file; as <code>pdflatex</code>, the main output is a <samp>.pdf</samp> file. <p>pdfTeX incorporates the e-TeX extensions to Knuth’s original program (<a href="http://ctan.org/pkg/etex">http://ctan.org/pkg/etex</a>), including additional programming features and bi-directional typesetting, and has plenty of -extensions of its own. e-TeX is available on its own as the +extensions of its own. e-TeX is available on its own as the system command <code>etex</code>, but this is plain TeX (and produces -<samp>.dvi</samp>). +<samp>.dvi</samp>). </p> <p>In other TeX distributions, <code>latex</code> may invoke e-TeX rather than pdfTeX. In any case, the e-TeX extensions can be @@ -790,12 +795,19 @@ but this is rarely used. <dt><code>xelatex</code></dt> <dd><a name="index-xelatex-command"></a> <a name="index-XeTeX"></a> +<a name="index-_002exdv-file"></a> +<a name="index-xdvipdfmx"></a> <p>If LaTeX is invoked with the system command <code>xelatex</code>, the XeTeX engine is run (<a href="http://tug.org/xetex">http://tug.org/xetex</a>). Like LuaTeX, -XeTeX also natively supports UTF-8 Unicode and TrueType and -OpenType fonts, though the implementation is completely different, -mainly using external libraries instead of internal code. XeTeX -produces a <samp>.pdf</samp> file as output; it does not support DVI output. +XeTeX natively supports UTF-8 Unicode and TrueType and OpenType +fonts, though the implementation is completely different, mainly using +external libraries instead of internal code. XeTeX produces a +<samp>.pdf</samp> file as output; it does not support DVI output. +</p> +<p>Internally, XeTeX creates an <code>.xdv</code> file, a variant of DVI, +and translates that to PDF using the (<code>x</code>)<code>dvipdfmx</code> +program, but this process is automatic. The <code>.xdv</code> file is only +useful for debugging. </p> </dd> </dl> @@ -818,27 +830,100 @@ Previous: <a href="#TeX-engines" accesskey="p" rel="prev">TeX engines</a>, Up: < <a name="index-_005c-character-starting-commands"></a> <a name="index-_005b_002e_002e_002e_005d-for-optional-arguments"></a> <a name="index-_007b_002e_002e_002e_007d-for-required-arguments"></a> -<p>In the LaTeX input file, a command name starts with a <code>\</code>; the -name itself then consists of either (a) a string of letters or -(b) a single non-letter. +<p>In the LaTeX input file, a command name starts with a backslash +character, <code>\</code>. The name itself then consists of either +(a) a string of letters or (b) a single non-letter. +</p> +<p>LaTeX commands names are case sensitive so that <code>\pagebreak</code> +differs from <code>\Pagebreak</code> (the latter is not a standard command). +Most commands are lowercase, but in any event you must enter all +commands in the same case as they are defined. +</p> +<p>A command may be followed by zero, one, or more arguments. These +arguments may be either required or optional. Required arguments are +contained in curly braces, <code>{...}</code>. Optional arguments are +contained in square brackets, <code>[...]</code>. Generally, but not +universally, if the command accepts an optional argument, it comes +first, before any required arguments. +</p> +<p>Inside of an optional argument, to use the character close square +bracket (<code>]</code>) hide it inside curly braces, as +in <code>\item[closing bracket {]}]</code>. Similarly, if an optional +argument comes last, with no required argument after it, then to make +the first character of the following text be an open square bracket, +hide it inside curly braces. +</p> +<p>LaTeX has the convention that some commands have a <code>*</code> form that +is related to the form without a <code>*</code>, such as <code>\chapter</code> and +<code>\chapter*</code>. The exact difference in behavior varies from command +to command. </p> -<p>A command may be followed by zero, one, or more arguments, either -required or optional. Required arguments are contained in curly -braces, <code>{...}</code>. Optional arguments are contained in square -brackets, <code>[...]</code>. Generally, but not universally, if the -command accepts an optional argument, it comes first, before any -required arguments. +<p>This manual describes all accepted options and <code>*</code>-forms for the +commands it covers (barring unintentional omissions, a.k.a. bugs). </p> -<p>Some commands have a <code>*</code> form that is related to the form without -a <code>*</code>, such as <code>\chapter</code> and <code>\chapter*</code>. +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#Environment" accesskey="1">Environment</a>:</td><td> </td><td align="left" valign="top">Area of the source with distinct behavior. +</td></tr> +<tr><td align="left" valign="top">• <a href="#Declaration" accesskey="2">Declaration</a>:</td><td> </td><td align="left" valign="top">Change the value or meaning of a command. +</td></tr> +</table> + + +<hr> +<a name="Environment"></a> +<div class="header"> +<p> +Next: <a href="#Declaration" accesskey="n" rel="next">Declaration</a>, Up: <a href="#LaTeX-command-syntax" accesskey="u" rel="up">LaTeX command syntax</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<h4 class="node-heading">Environment</h4> + +<p>Synopsis: </p> -<p>LaTeX commands are case sensitive; neither <code>\Begin{document}</code> -nor <code>\begin{Document}</code> will work. Most commands are lowercase, -but in any event you must enter all commands in the same case as they -are defined. +<div class="example"> +<pre class="example">\begin{<var>environment name</var>} + .. +\end{<var>environment name</var>} +</pre></div> + +<p>An area of LaTeX source, inside of which there is a distinct +behavior. For instance, for poetry in LaTeX put the lines between +<code>\begin{verse}</code> and <code>\end{verse}</code>. </p> -<p>This manual describes all accepted options and <code>*</code>-forms for the -commands it covers (barring unintentional omissions, a.k.a. bugs). +<div class="example"> +<pre class="example">\begin{verse} + There once was a man from Nantucket \\ + .. +\end{verse} +</pre></div> + +<p>The <var>environment name</var> at the beginning must exactly match that at +the end. This includes the case where <var>environment name</var> ends in a +star (<code>*</code>); both the <code>\begin</code> and <code>\end</code> texts must +include the star. +</p> +<p>Environments may have arguments, including optional arguments. This +example produces a table. The first argument is optional (and causes +the table to be aligned on its top row) while the second argument is +required (it specifies the formatting of columns). +</p> +<div class="example"> +<pre class="example">\begin{tabular}[t]{r|l} + .. rows of table .. +\end{tabular} +</pre></div> + + +<hr> +<a name="Declaration"></a> +<div class="header"> +<p> +Previous: <a href="#Environment" accesskey="p" rel="prev">Environment</a>, Up: <a href="#LaTeX-command-syntax" accesskey="u" rel="up">LaTeX command syntax</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<h4 class="node-heading">Declaration</h4> + +<p>A command that changes the value, or changes the meaning, of some other +command or parameter. For instance, the <code>\mainmatter</code> command +changes the setting of page numbers from roman numerals to arabic. </p> <hr> @@ -881,6 +966,11 @@ matter, such as a preface, and back matter, such as an appendix (see <a href="#Front_002fback-matter">Front/back matter</a>). </p> </dd> +<dt><code>letter</code></dt> +<dd><p>Mail, optionally including mailing labels +(see <a href="#Letters">Letters</a>). +</p> +</dd> <dt><code>report</code></dt> <dd><p>For documents of length between an <code>article</code> and a <code>book</code>, such as technical reports or theses, which may contain several chapters. @@ -942,12 +1032,41 @@ options for selecting the typeface size (default is <code>10pt</code>): <a name="index-legalpaper-option"></a> <a name="index-letterpaper-option"></a> <p>All of the standard classes accept these options for selecting the paper -size (default is <code>letterpaper</code>): +size (these show height by width): </p> -<div class="example"> -<pre class="example">a4paper a5paper b5paper executivepaper legalpaper letterpaper -</pre></div> +<dl compact="compact"> +<dt><code>a4paper</code></dt> +<dd><p>210 by 297 mm (about 8.25 by 11.75 inches) +</p> +</dd> +<dt><code>b5paper</code></dt> +<dd><p>176 by 250 mm (about 7 by 9.875 inches) +</p> +</dd> +<dt><code>executivepaper</code></dt> +<dd><p>7.25 by 10.5 inches +</p> +</dd> +<dt><code>legalpaper</code></dt> +<dd><p>8.5 by 14 inches +</p> +</dd> +<dt><code>letterpaper</code></dt> +<dd><p>8.5 by 11 inches (the default) +</p></dd> +</dl> +<a name="index-_005cpdfpagewidth"></a> +<a name="index-_005cpdfpageheight"></a> +<a name="index-geometry-package"></a> +<p>When using one of the engines pdfLaTeX, LuaLaTeX, or XeLaTeX +(see <a href="#TeX-engines">TeX engines</a>), options other than <code>letterpaper</code> set +the print area but you must also set the physical paper size. One way +to do that is to put <code>\pdfpagewidth=\paperwidth</code> and +<code>\pdfpageheight=\paperheight</code> in your document’s preamble. The +<code>geometry</code> package provides flexible ways of setting the print +area and physical page size. +</p> <a name="index-draft-option"></a> <a name="index-final-option"></a> <a name="index-fleqn-option"></a> @@ -1094,16 +1213,17 @@ Next: <a href="#Font-sizes" accesskey="n" rel="next">Font sizes</a>, Up: <a href <h3 class="section">4.1 Font styles</h3> <a name="index-font-styles"></a> -<a name="index-typeface-styles"></a> +<a name="index-type-styles"></a> <a name="index-styles-of-text"></a> <p>The following type style commands are supported by LaTeX. </p> <p>This first group of commands is typically used with an argument, as in -<code>\textit{italic text}</code>. In the table below, the corresponding +<code>\textit{<var>text</var>}</code>. In the table below, the corresponding command in parenthesis is the “declaration form”, which takes no -arguments. The scope of the declaration form lasts until the next type -style command or the end of the current group. +arguments, as in <code>{\itshape <var>text</var>}</code>. The scope of the +declaration form lasts until the next type style command or the end of +the current group. </p> <p>These commands, in both the argument form and the declaration form, are cumulative; e.g., you can say either <code>\sffamily\bfseries</code> or @@ -1136,12 +1256,6 @@ command argument, such as <code>\textit{\nocorr text}</code> or <p>Italics. </p> </dd> -<dt><code>\emph</code></dt> -<dd><a name="index-_005cemph"></a> -<a name="index-emphasis"></a> -<p>Emphasis (switches between <code>\textit</code> and <code>\textrm</code>). -</p> -</dd> <dt><code>\textmd (\mdseries)</code></dt> <dd><a name="index-_005ctextmd"></a> <a name="index-_005cmdseries"></a> @@ -1157,7 +1271,7 @@ command argument, such as <code>\textit{\nocorr text}</code> or <dt><code>\textup (\upshape)</code></dt> <dd><a name="index-_005ctextup"></a> <a name="index-_005cupshape"></a> -<p>Upright (default). The opposite of slanted. +<p>Upright (default). </p> </dd> <dt><code>\textsl (\slshape)</code></dt> @@ -1190,77 +1304,29 @@ command argument, such as <code>\textit{\nocorr text}</code> or <p>Main document font. </p> </dd> -<dt><code>\mathrm</code></dt> -<dd><a name="index-_005cmathrm"></a> -<p>Roman, for use in math mode. -</p> -</dd> -<dt><code>\mathbf</code></dt> -<dd><a name="index-_005cmathbf"></a> -<p>Boldface, for use in math mode. -</p> -</dd> -<dt><code>\mathsf</code></dt> -<dd><a name="index-_005cmathsf"></a> -<p>Sans serif, for use in math mode. -</p> -</dd> -<dt><code>\mathtt</code></dt> -<dd><a name="index-_005cmathtt"></a> -<p>Typewriter, for use in math mode. -</p> -</dd> -<dt><code>\mathit</code></dt> -<dt><code>(\mit)</code></dt> -<dd><p>Italics, for use in math mode. -</p> -</dd> -<dt><code>\mathnormal</code></dt> -<dd><a name="index-_005cmathnormal"></a> -<p>For use in math mode, e.g. inside another type style declaration. -</p> -</dd> -<dt><code>\mathcal</code></dt> -<dd><a name="index-_005cmathcal"></a> -<p>‘Calligraphic’ letters, for use in math mode. -</p> -</dd> </dl> -<a name="index-_005cmathversion"></a> -<a name="index-math_002c-bold"></a> -<a name="index-bold-math"></a> -<p>In addition, the command <code>\mathversion{bold}</code> can be used for -switching to bold letters and symbols in -formulas. <code>\mathversion{normal}</code> restores the default. -</p> -<a name="index-_005coldstylenums"></a> -<a name="index-numerals_002c-old_002dstyle"></a> -<a name="index-old_002dstyle-numerals"></a> -<a name="index-lining-numerals"></a> -<a name="index-textcomp-package"></a> -<p>Finally, the command <code>\oldstylenums{<var>numerals</var>}</code> will -typeset so-called “old-style” numerals, which have differing heights -and depths (and sometimes widths) from the standard “lining” -numerals. LaTeX’s default fonts support this, and will respect -<code>\textbf</code> (but not other styles; there are no italic old-style -numerals in Computer Modern). Many other fonts have old-style -numerals also; sometimes the <code>textcomp</code> package must be loaded, -and sometimes package options are provided to make them the default. -FAQ entry: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</a>. +<a name="index-emphasis"></a> +<a name="index-_005cemph"></a> +<p>Although it also changes fonts, the <code>\emph{<var>text</var>}</code> command +is semantic, for text to be emphasized, and should not be used as a +substitute for <code>\textit</code>. For example, <code>\emph{<var>start +text</var> \emph{<var>middle text</var>} <var>end text</var>}</code> will result in the +<var>start text</var> and <var>end text</var> in italics, but <var>middle text</var> +will be in roman. </p> <p>LaTeX also provides the following commands, which unconditionally switch to the given style, that is, are <em>not</em> cumulative. Also, -they are used differently than the above commands: <code>{\<var>cmd</var> -...}</code> instead of <code>\<var>cmd</var>{...}</code>. These are two unrelated -constructs. +they are used differently than the above commands: +<code>{\<var>cmd</var>...}</code> instead of <code>\<var>cmd</var>{...}</code>. These +are two unrelated constructs. </p> <dl compact="compact"> <dt><code>\bf</code> <a name="index-_005cbf"></a> </dt> <dd><a name="index-bold-font"></a> -<p>Switch to <b>bold face</b>. +<p>Switch to bold face. </p> </dd> <dt><code>\cal</code> @@ -1271,13 +1337,6 @@ constructs. <p>Switch to calligraphic letters for math. </p> </dd> -<dt><code>\em</code> -<a name="index-_005cem"></a> -</dt> -<dd><a name="index-emphasis-1"></a> -<p>Emphasis (italics within roman, roman within italics). -</p> -</dd> <dt><code>\it</code> <a name="index-_005cit"></a> </dt> @@ -1325,13 +1384,81 @@ constructs. </dd> </dl> -<p>Some people consider the unconditional font-switching commands, such -as <code>\tt</code>, obsolete and <em>only</em> the cumulative commands -(<code>\texttt</code>) should be used. I (Karl) do not agree. There are -perfectly reasonable situations when an unconditional font switch is -precisely what you need to get the desired output; for one example, -see <a href="#description"><code>description</code></a>. Both sets of commands have -their place. +<p>The <code>\em</code> command is the unconditional version of <code>\emph</code>. +</p> +<p>(Some people consider the unconditional font-switching commands, such +as <code>\tt</code>, obsolete and that only the cumulative commands +(<code>\texttt</code>) should be used. Others think that both sets of +commands have their place and sometimes an unconditional font switch +is precisely what you want; for one example, +see <a href="#description"><code>description</code></a>.) +</p> +<p>The following commands are for use in math mode. They are not +cumulative, so <code>\mathbf{\mathit{<var>symbol</var>}}</code> does not +create a boldface and italic <var>symbol</var>; instead, it will just be in +italics. This is because typically math symbols need consistent +typographic treatment, regardless of the surrounding environment. +</p> +<dl compact="compact"> +<dt><code>\mathrm</code></dt> +<dd><a name="index-_005cmathrm"></a> +<p>Roman, for use in math mode. +</p> +</dd> +<dt><code>\mathbf</code></dt> +<dd><a name="index-_005cmathbf"></a> +<p>Boldface, for use in math mode. +</p> +</dd> +<dt><code>\mathsf</code></dt> +<dd><a name="index-_005cmathsf"></a> +<p>Sans serif, for use in math mode. +</p> +</dd> +<dt><code>\mathtt</code></dt> +<dd><a name="index-_005cmathtt"></a> +<p>Typewriter, for use in math mode. +</p> +</dd> +<dt><code>\mathit</code></dt> +<dt><code>(\mit)</code></dt> +<dd><p>Italics, for use in math mode. +</p> +</dd> +<dt><code>\mathnormal</code></dt> +<dd><a name="index-_005cmathnormal"></a> +<p>For use in math mode, e.g., inside another type style declaration. +</p> +</dd> +<dt><code>\mathcal</code></dt> +<dd><a name="index-_005cmathcal"></a> +<p>Calligraphic letters, for use in math mode. +</p> +</dd> +</dl> + +<a name="index-_005cmathversion"></a> +<a name="index-math_002c-bold"></a> +<a name="index-bold-math"></a> +<p>In addition, the command <code>\mathversion{bold}</code> can be used for +switching to bold letters and symbols in +formulas. <code>\mathversion{normal}</code> restores the default. +</p> +<a name="index-_005coldstylenums"></a> +<a name="index-numerals_002c-old_002dstyle"></a> +<a name="index-old_002dstyle-numerals"></a> +<a name="index-lining-numerals"></a> +<a name="index-textcomp-package"></a> +<p>Finally, the command <code>\oldstylenums{<var>numerals</var>}</code> will typeset +so-called “old-style” numerals, which have differing heights and +depths (and sometimes widths) from the standard “lining” numerals, +which all have the same height as upper-case letters. LaTeX’s +default fonts support this, and will respect <code>\textbf</code> (but not +other styles; there are no italic old-style numerals in Computer +Modern). Many other fonts have old-style numerals also; sometimes the +<code>textcomp</code> package must be loaded, and sometimes package options +are provided to make them the default. FAQ entry: +<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</a>. </p> <hr> @@ -1342,6 +1469,7 @@ Next: <a href="#Low_002dlevel-font-commands" accesskey="n" rel="next">Low-level </div> <a name="Font-sizes-1"></a> <h3 class="section">4.2 Font sizes</h3> + <a name="index-font-sizes"></a> <a name="index-typeface-sizes"></a> <a name="index-sizes-of-text"></a> @@ -1390,6 +1518,7 @@ Previous: <a href="#Font-sizes" accesskey="p" rel="prev">Font sizes</a>, Up: <a </div> <a name="Low_002dlevel-font-commands-1"></a> <h3 class="section">4.3 Low-level font commands</h3> + <a name="index-low_002dlevel-font-commands"></a> <a name="index-font-commands_002c-low_002dlevel"></a> @@ -1398,94 +1527,178 @@ packages. The commands listed here are only a subset of the available ones. </p> <dl compact="compact"> -<dt><code>\fontencoding{enc}</code></dt> +<dt><code>\fontencoding{<var>encoding</var>}</code></dt> <dd><a name="index-_005cfontencoding"></a> -<p>Select font encoding. Valid encodings include <code>OT1</code> and <code>T1</code>. +<p>Select the font encoding, the encoding of the output font. There are a +large number of valid encodings. The most common are <code>OT1</code>, +Knuth’s original encoding for Computer Modern (the default), and +<code>T1</code>, also known as the Cork encoding, which has support for the +accented characters used by the most widespread European languages +(German, French, Italian, Polish and others), which allows TeX to +hyphenate words containing accented letters. </p> </dd> -<dt><code>\fontfamily{family}</code></dt> +<dt><code>\fontfamily{<var>family</var>}</code></dt> <dd><a name="index-_005cfontfamily"></a> -<p>Select font family. Valid families include: +<a name="index-families_002c-of-fonts"></a> +<a name="index-font-catalogue"></a> +<p>Select the font family. The web page +<a href="http://www.tug.dk/FontCatalogue/">http://www.tug.dk/FontCatalogue/</a> provides one way to browse +through many of the fonts easily used with LaTeX. Here are +examples of some common families: </p> -<ul> -<li> <code>cmr</code> for Computer Modern Roman -</li><li> <code>cmss</code> for Computer Modern Sans Serif -</li><li> <code>cmtt</code> for Computer Modern Typewriter + +<ul class="no-bullet"> +<li><!-- /@w --> <code>pag</code><tt> </tt> Avant Garde +</li><li><!-- /@w --> <code>fvs</code><tt> </tt> Bitstream Vera Sans +</li><li><!-- /@w --> <code>pbk</code><tt> </tt> Bookman +</li><li><!-- /@w --> <code>bch</code><tt> </tt> Charter +</li><li><!-- /@w --> <code>ccr</code><tt> </tt> Computer Concrete +</li><li><!-- /@w --> <code>cmr</code><tt> </tt> Computer Modern +</li><li><!-- /@w --> <code>pcr</code><tt> </tt> Courier +</li><li><!-- /@w --> <code>phv</code><tt> </tt> Helvetica +</li><li><!-- /@w --> <code>fi4</code><tt> </tt> Inconsolata +</li><li><!-- /@w --> <code>lmr</code><tt> </tt> Latin Modern +</li><li><!-- /@w --> <code>lmss</code> Latin Modern Sans +</li><li><!-- /@w --> <code>lmtt</code> Latin Modern Typewriter +</li><li><!-- /@w --> <code>pnc</code><tt> </tt> New Century Schoolbook +</li><li><!-- /@w --> <code>ppl</code><tt> </tt> Palatino +</li><li><!-- /@w --> <code>ptm</code><tt> </tt> Times +</li><li><!-- /@w --> <code>uncl</code> Uncial +</li><li><!-- /@w --> <code>put</code><tt> </tt> Utopia +</li><li><!-- /@w --> <code>pzc</code><tt> </tt> Zapf Chancery </li></ul> -<p>and numerous others. -</p> </dd> -<dt><code>\fontseries{series}</code></dt> +<dt><code>\fontseries{<var>series</var>}</code></dt> <dd><a name="index-_005cfontseries"></a> -<p>Select font series. Valid series include: +<a name="index-series_002c-of-fonts"></a> +<p>Select the font series. A <em>series</em> combines a <em>weight</em> and a +<em>width</em>. Typically, a font supports only a few of the possible +combinations. Some common combined series values include: </p> -<ul> -<li> <code>m</code> Medium (normal) -</li><li> <code>b</code> Bold -</li><li> <code>c</code> Condensed -</li><li> <code>bc</code> Bold condensed -</li><li> <code>bx</code> Bold extended +<ul class="no-bullet"> +<li><!-- /@w --> <code>m</code><tt> </tt> Medium (normal) +</li><li><!-- /@w --> <code>b</code><tt> </tt> Bold +</li><li><!-- /@w --> <code>c</code><tt> </tt> Condensed +</li><li><!-- /@w --> <code>bc</code> Bold condensed +</li><li><!-- /@w --> <code>bx</code> Bold extended </li></ul> -<p>and various other combinations. +<a name="index-weights_002c-of-fonts"></a> +<p>The possible values for weight, individually, are: </p> +<ul class="no-bullet"> +<li><!-- /@w --> <code>ul</code> Ultra light +</li><li><!-- /@w --> <code>el</code> Extra light +</li><li><!-- /@w --> <code>l</code><tt> </tt> Light +</li><li><!-- /@w --> <code>sl</code> Semi light +</li><li><!-- /@w --> <code>m</code><tt> </tt> Medium (normal) +</li><li><!-- /@w --> <code>sb</code> Semi bold +</li><li><!-- /@w --> <code>b</code><tt> </tt> Bold +</li><li><!-- /@w --> <code>eb</code> Extra bold +</li><li><!-- /@w --> <code>ub</code> Ultra bold +</li></ul> + +<a name="index-widths_002c-of-fonts"></a> +<p>The possible values for width, individually, are (the percentages +are just guides and are not followed precisely by all fonts): +</p> +<ul class="no-bullet"> +<li><!-- /@w --> <code>uc</code> Ultra condensed, 50% +</li><li><!-- /@w --> <code>ec</code> Extra condensed, 62.5% +</li><li><!-- /@w --> <code>c</code><tt> </tt> Condensed, 75% +</li><li><!-- /@w --> <code>sc</code> Semi condensed, 87.5% +</li><li><!-- /@w --> <code>m</code><tt> </tt> Medium, 100% +</li><li><!-- /@w --> <code>sx</code> Semi expanded, 112.5% +</li><li><!-- /@w --> <code>x</code><tt> </tt> Expanded, 125% +</li><li><!-- /@w --> <code>ex</code> Extra expanded, 150% +</li><li><!-- /@w --> <code>ux</code> Ultra expanded, 200% +</li></ul> + +<p>When forming the <var>series</var> string from the weight and width, drop the +<code>m</code> that stands for medium weight or medium width, unless both +weight and width are <code>m</code>, in which case use just one +(‘<samp><code>m</code></samp>’). +</p> </dd> -<dt><code>\fontshape{shape}</code></dt> +<dt><code>\fontshape{<var>shape</var>}</code></dt> <dd><a name="index-_005cfontshape"></a> +<a name="index-shapes_002c-of-fonts"></a> <p>Select font shape. Valid shapes are: </p> -<ul> -<li> <code>n</code> Upright (normal) -</li><li> <code>it</code> Italic -</li><li> <code>sl</code> Slanted (oblique) -</li><li> <code>sc</code> Small caps -</li><li> <code>ui</code> Upright italics -</li><li> <code>ol</code> Outline +<ul class="no-bullet"> +<li><!-- /@w --> <code>n</code><tt> </tt> Upright (normal) +</li><li><!-- /@w --> <code>it</code> Italic +</li><li><!-- /@w --> <code>sl</code> Slanted (oblique) +</li><li><!-- /@w --> <code>sc</code> Small caps +</li><li><!-- /@w --> <code>ui</code> Upright italics +</li><li><!-- /@w --> <code>ol</code> Outline </li></ul> -<p>The two last shapes are not available for most font families. +<p>The two last shapes are not available for most font families, and +small caps are often missing as well. </p> </dd> -<dt><code>\fontsize{size}{skip}</code></dt> +<dt><code>\fontsize{<var>size</var>}{<var>skip</var>}</code></dt> <dd><a name="index-_005cfontsize"></a> +<a name="index-font-size"></a> <a name="index-_005cbaselineskip"></a> -<p>Set font size. The first parameter is the font size to switch to and -the second is the line spacing to use; this is stored in a parameter -named <code>\baselineskip</code>. The unit of both parameters defaults to -pt. The default <code>\baselineskip</code> for the Computer Modern typeface -is 1.2 times the <code>\fontsize</code>. +<p>Set the font size and the line spacing. The unit of both parameters +defaults to points (<code>pt</code>). The line spacing is the nominal +vertical space between lines, baseline to baseline. It is stored in the +parameter <code>\baselineskip</code>. The default <code>\baselineskip</code> for +the Computer Modern typeface is 1.2 times the <code>\fontsize</code>. +Changing <code>\baselineskip</code> directly is inadvisable since its value is +reset every time a size change happens; see <code>\baselinestretch</code>, next. +</p> +</dd> +<dt><code>\baselinestretch</code></dt> +<dd><a name="index-_005cbaselinestretch"></a> +<p>LaTeX multiplies the line spacing by the value of the +<code>\baselinestretch</code> parameter; the default factor is 1. A change +takes effect when <code>\selectfont</code> (see below) is called. You can +make line skip changes happen for the entire document by doing +<code>\renewcommand{\baselinestretch}{2.0}</code> in the preamble. </p> -<a name="index-_005cbaselinestretch"></a> <a name="index-setspace-package"></a> <a name="index-double-spacing"></a> -<p>The line spacing is also multiplied by the value of the -<code>\baselinestretch</code> parameter when the type size changes; the -default is 1. However, the best way to “double space” a document, -if you should be unlucky enough to have to produce such, is to use the -<code>setspace</code> package; see -<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</a>. +<p>However, the best way to double-space a document is to use the +<samp>setspace</samp> package. In addition to offering a number of spacing +options, this package keeps the line spacing single-spaced in places +where that is typically desirable, such as footnotes and figure +captions. See the package documentation. </p> -<a name="index-_005clinespread"></a> </dd> <dt><code>\linespread{<var>factor</var>}</code></dt> -<dd><p>Equivalent to +<dd><a name="index-_005clinespread"></a> +<p>Equivalent to <code>\renewcommand{\baselinestretch}{<var>factor</var>}</code>, and therefore must be followed by <code>\selectfont</code> to have any effect. Best specified in the preamble, or use the <code>setspace</code> package, as -described just above. +just described. </p> -<a name="index-_005cselectfont"></a> -<p>The changes made by calling the font commands described above do -not come into effect until <code>\selectfont</code> is called. +</dd> +<dt><code>\selectfont</code></dt> +<dd><a name="index-_005cselectfont"></a> +<p>The effects of the font commands described above do not happen until +<code>\selectfont</code> is called, as in +<code>\fontfamily{<var>familyname</var>}\selectfont</code>. It is often useful +to put this in a macro:<br> +<code>\newcommand*{\myfont}{\fontfamily{<var>familyname</var>}\selectfont}</code><br> +(see <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>). </p> </dd> -<dt><code>\usefont{enc}{family}{series}{shape}</code></dt> +<dt><code>\usefont{<var>enc</var>}{<var>family</var>}{<var>series</var>}{<var>shape</var>}</code></dt> <dd><a name="index-_005cusefont"></a> <p>The same as invoking <code>\fontencoding</code>, <code>\fontfamily</code>, <code>\fontseries</code> and <code>\fontshape</code> with the given parameters, -followed by <code>\selectfont</code>. +followed by <code>\selectfont</code>. For example: </p> +<div class="example"> +<pre class="example">\usefont{ot1}{cmr}{m}{n} +</pre></div> + </dd> </dl> @@ -1498,9 +1711,10 @@ Next: <a href="#Sectioning" accesskey="n" rel="next">Sectioning</a>, Previous: < </div> <a name="Layout-1"></a> <h2 class="chapter">5 Layout</h2> + <a name="index-layout-commands"></a> -<p>Miscellaneous commands for controlling the general layout of the page. +<p>Commands for controlling the general page layout. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005conecolumn" accesskey="1">\onecolumn</a>:</td><td> </td><td align="left" valign="top">Use one-column layout. @@ -1513,6 +1727,8 @@ Next: <a href="#Sectioning" accesskey="n" rel="next">Sectioning</a>, Previous: < </td></tr> <tr><td align="left" valign="top">• <a href="#Page-layout-parameters" accesskey="5">Page layout parameters</a>:</td><td> </td><td align="left" valign="top"><code>\headheight</code> <code>\footskip</code>. </td></tr> +<tr><td align="left" valign="top">• <a href="#Floats" accesskey="6">Floats</a>:</td><td> </td><td align="left" valign="top">Figures, tables, etc. +</td></tr> </table> @@ -1524,11 +1740,15 @@ Next: <a href="#g_t_005ctwocolumn" accesskey="n" rel="next">\twocolumn</a>, Up: </div> <a name="g_t_005conecolumn-1"></a> <h3 class="section">5.1 <code>\onecolumn</code></h3> + <a name="index-_005conecolumn"></a> <a name="index-one_002dcolumn-output"></a> <p>The <code>\onecolumn</code> declaration starts a new page and produces -single-column output. This is the default. +single-column output. If the document is given the class option +<code>onecolumn</code> then this is the default behavior (see <a href="#Document-class-options">Document class options</a>). +</p> +<p>This command is fragile (see <a href="#g_t_005cprotect">\protect</a>). </p> <hr> @@ -1539,6 +1759,7 @@ Next: <a href="#g_t_005cflushbottom" accesskey="n" rel="next">\flushbottom</a>, </div> <a name="g_t_005ctwocolumn-1"></a> <h3 class="section">5.2 <code>\twocolumn</code></h3> + <a name="index-_005ctwocolumn"></a> <a name="index-multicolumn-text"></a> <a name="index-two_002dcolumn-output"></a> @@ -1546,13 +1767,18 @@ Next: <a href="#g_t_005cflushbottom" accesskey="n" rel="next">\flushbottom</a>, <p>Synopsis: </p> <div class="example"> -<pre class="example">\twocolumn[<var>text1col</var>] +<pre class="example">\twocolumn[<var>prelim one column text</var>] </pre></div> <p>The <code>\twocolumn</code> declaration starts a new page and produces -two-column output. If the optional <var>text1col</var> argument is present, -it is typeset in one-column mode before the two-column typesetting -starts. +two-column output. If the document is given the class option +<code>twocolumn</code> then this is the default (see <a href="#Document-class-options">Document class options</a>). +</p> +<p>If the optional <var>prelim one column text</var> argument +is present, it is typeset in one-column mode before the two-column +typesetting starts. +</p> +<p>This command is fragile (see <a href="#g_t_005cprotect">\protect</a>). </p> <p>These parameters control typesetting in two-column output: </p> @@ -1560,59 +1786,124 @@ starts. <dt><code>\columnsep</code> <a name="index-_005ccolumnsep"></a> </dt> -<dd><p>The distance between columns (35pt by default). +<dd><p>The distance between columns. The default is 35pt. Change it with a +command such as <code>\setlength{\columnsep}{40pt}</code> You must change +it before the two column environment starts; in the preamble is a good +place. </p> </dd> <dt><code>\columnseprule</code> <a name="index-_005ccolumnseprule"></a> </dt> -<dd><p>The width of the rule between columns; the default is 0pt, so there is no rule. +<dd><p>The width of the rule between columns. The rule appears halfway between +the two columns. The default is 0pt, meaning that there is no rule. +Change it with a command such as +<code>\setlength{\columnseprule}{0.4pt}</code>, before the two-column +environment starts. </p> </dd> <dt><code>\columnwidth</code> <a name="index-_005ccolumnwidth"></a> </dt> -<dd><p>The width of the current column; this is equal to <code>\textwidth</code> in -single-column text. +<dd><p>The width of a single column. In one-column mode this is equal to +<code>\textwidth</code>. In two-column mode by default LaTeX sets the +width of each of the two columns to be half of <code>\textwidth</code> minus +<code>\columnsep</code>. </p> </dd> </dl> -<p>These parameters control float behavior in two-column output: +<p>In a two-column document, the starred environments <code>table*</code> and +<code>figure*</code> are two columns wide, whereas the unstarred environments +<code>table</code> and <code>figure</code> take up only one column (see <a href="#figure">figure</a> +and see <a href="#table">table</a>). LaTeX places starred floats at the top of a page. +The following parameters control float behavior of two-column output. </p> <dl compact="compact"> <dt><code>\dbltopfraction</code> <a name="index-_005cdbltopfraction"></a> </dt> -<dd><p>Maximum fraction at the top of a two-column page that may be occupied -by floats. Default ‘<samp>.7</samp>’, can be usefully redefined to (say) -‘<samp>.9</samp>’ to avoid going to float pages so soon. +<dd><p>The maximum fraction at the top of a two-column page that may be +occupied by two-column wide floats. The default is 0.7, meaning that +the height of a <code>table*</code> or <code>figure*</code> environment must not +exceed <code>0.7\textheight</code> . If the height of your starred float +environment exceeeds this then you can take one of the following actions +to prevent it from floating all the way to the back of the document: +</p> +<ul> +<li> Use the <code>[tp]</code> location specifier to tell LaTeX to try to put +the bulky float on a page by itself, as well as at the top of a page. + +</li><li> Use the <code>[t!]</code> location specifier to override the effect of +<code>\dbltopfraction</code> for this particular float. + +</li><li> Increase the value of <code>\dbltopfraction</code> to a suitably large number, +to avoid going to float pages so soon. +</li></ul> + +<p>You can redefine it, for instance with +<code>\renewcommand{\dbltopfraction}{0.9}</code>. </p> </dd> <dt><code>\dblfloatpagefraction</code> <a name="index-_005cdblfloatpagefraction"></a> </dt> -<dd><p>The minimum fraction of a float page that must be occupied by floats, -for a two-column float page. Default ‘<samp>.5</samp>’. +<dd><p>For a float page of two-column wide floats, this is the minimum fraction +that must be occupied by floats, limiting the amount of blank space. +LaTeX’s default is <code>0.5</code>. Change it with <code>\renewcommand</code>. </p> </dd> <dt><code>\dblfloatsep</code> <a name="index-_005cdblfloatsep"></a> </dt> -<dd><p>Distance between floats at the top or bottom of a two-column float -page. Default ‘<samp>12pt plus2pt minus2pt</samp>’ for ‘<samp>10pt</samp>’ and -‘<samp>11pt</samp>’ documents, ‘<samp>14pt plus2pt minus4pt</samp>’ for ‘<samp>12pt</samp>’. +<dd><p>On a float page of two-column wide floats, this length is the distance +between floats, at both the top and bottom of the page. The default is +<code>12pt plus2pt minus2pt</code> for a document set at <code>10pt</code> or +<code>11pt</code>, and <code>14pt plus2pt minus4pt</code> for a document set at +<code>12pt</code>. </p> </dd> <dt><code>\dbltextfloatsep</code> <a name="index-_005cdbltextfloatsep"></a> </dt> -<dd><p>Distance between a multi-column float at the top or bottom of a page -and the main text. Default ‘<samp>20pt plus2pt minus4pt</samp>’. +<dd><p>This length is the distance between a multi-column float at the top or +bottom of a page and the main text. The default is <code>20pt plus2pt +minus4pt</code>. +</p> +</dd> +<dt><code>\dbltopnumber</code> +<a name="index-_005cdbltopnumber"></a> +</dt> +<dd><p>On a float page of two-column wide floats, this counter gives the +maximum number of floats allowed at the top of the page. The LaTeX +default is <code>2</code>. </p> </dd> </dl> +<p>This example shows the use of the optional argument of <code>\twocolumn</code> +to create a title that spans the two-column article: +</p> +<div class="example"> +<pre class="example">\documentclass[twocolumn]{article} +\newcommand{\authormark}[1]{\textsuperscript{#1}} +\begin{document} +\twocolumn[{% inside this optional argument goes one-column text + \centering + \LARGE The Title \\[1.5em] + \large Author One\authormark{1}, + Author Two\authormark{2}, + Author Three\authormark{1} \\[1em] + \normalsize + \begin{tabular}{p{.2\textwidth}@{\hspace{2em}}p{.2\textwidth}} + \authormark{1}Department one &\authormark{2}Department two \\ + School one &School two + \end{tabular}\\[3em] % space below title part +}] + +Two column text here. +</pre></div> + <hr> <a name="g_t_005cflushbottom"></a> @@ -1625,12 +1916,22 @@ Next: <a href="#g_t_005craggedbottom" accesskey="n" rel="next">\raggedbottom</a> <a name="index-_005cflushbottom"></a> -<p>The <code>\flushbottom</code> declaration makes all text pages the same -height, adding extra vertical space where necessary to fill out the -page. +<p>The <code>\flushbottom</code> command can go at any point in the document +body. It makes all later pages the same height, stretching the vertical +space where necessary to fill out the page. +</p> +<p>If TeX cannot satisfactorily stretch the vertical space in a page +then you get a message like ‘<samp>Underfull \vbox (badness 10000) has +occurred while \output is active</samp>’. You can change to +<code>\raggedbottom</code> (see below). Alternatively, you can try to adjust +the <code>textheight</code> to be compatible, or you can add some vertical +stretch glue between lines or between paragraphs, as in +<code>\setlength{\parskip}{0ex plus0.1ex}</code>. In a final editing +stage you can adjust the height of individual pages +(see <a href="#g_t_005cenlargethispage">\enlargethispage</a>). </p> -<p>This is the default if <code>twocolumn</code> mode is selected -(see <a href="#Document-class-options">Document class options</a>). +<p>This is the default only if you select the <code>twoside</code> document class +option (see <a href="#Document-class-options">Document class options</a>). </p> <hr> @@ -1641,19 +1942,25 @@ Next: <a href="#Page-layout-parameters" accesskey="n" rel="next">Page layout par </div> <a name="g_t_005craggedbottom-1"></a> <h3 class="section">5.4 <code>\raggedbottom</code></h3> + <a name="index-_005craggedbottom"></a> <a name="index-stretch_002c-omitting-vertical"></a> -<p>The <code>\raggedbottom</code> declaration makes all pages the natural -height of the material on that page. No rubber lengths will be -stretched. +<p>The <code>\raggedbottom</code> command can go at any point in the document +body. It makes all later pages the natural height of the material on +that page; no rubber lengths will be stretched. Thus, in a two-sided +document the facing pages may be different heights. See also +<code>\flushbottom</code> above. +</p> +<p>This is the default unless you select the <code>twoside</code> document class +option (see <a href="#Document-class-options">Document class options</a>). </p> <hr> <a name="Page-layout-parameters"></a> <div class="header"> <p> -Previous: <a href="#g_t_005craggedbottom" accesskey="p" rel="prev">\raggedbottom</a>, Up: <a href="#Layout" accesskey="u" rel="up">Layout</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#Floats" accesskey="n" rel="next">Floats</a>, Previous: <a href="#g_t_005craggedbottom" accesskey="p" rel="prev">\raggedbottom</a>, Up: <a href="#Layout" accesskey="u" rel="up">Layout</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="Page-layout-parameters-1"></a> <h3 class="section">5.5 Page layout parameters</h3> @@ -1666,62 +1973,162 @@ Previous: <a href="#g_t_005craggedbottom" accesskey="p" rel="prev">\raggedbottom <a name="index-running-header-and-footer"></a> <dl compact="compact"> +<dt><code>\columnsep</code> +<a name="index-_005ccolumnsep-1"></a> +</dt> +<dt><code>\columnseprule</code> +<a name="index-_005ccolumnseprule-1"></a> +</dt> +<dt><code>\columnwidth</code> +<a name="index-_005ccolumnwidth-1"></a> +</dt> +<dd><a name="index-_005ccolumnsep-2"></a> +<a name="index-_005ccolumnseprule-2"></a> +<a name="index-_005ccolumnwidth-2"></a> +<p>The distance between the two columns, the width of a rule between the +columns, and the width of the columns, when the document class option +<code>twocolumn</code> is in effect (see <a href="#Document-class-options">Document class options</a>). +See <a href="#g_t_005ctwocolumn">\twocolumn</a>. +</p> +</dd> <dt><code>\headheight</code> <a name="index-_005cheadheight"></a> </dt> -<dd><p>Height of the box that contains the running head. Default is -‘<samp>30pt</samp>’, except in the <code>book</code> class, where it varies with the -type size. +<dd><a name="index-_005cheadheight-1"></a> +<p>Height of the box that contains the running head. The default in the +<code>article</code>, <code>report</code>, and <code>book</code> classes is ‘<samp>12pt</samp>’, +at all type sizes. </p> </dd> <dt><code>\headsep</code> <a name="index-_005cheadsep"></a> </dt> -<dd><p>Vertical distance between the bottom of the header line and the top of -the main text. Default is ‘<samp>25pt</samp>’, except in the <code>book</code> -class, where it varies with the type size. +<dd><a name="index-_005cheadsep-1"></a> +<p>Vertical distance between the bottom of the header line and the top of +the main text. The default in the <code>article</code> and <code>report</code> +classes is ‘<samp>25pt</samp>’. In the <code>book</code> class the default is: if the +document is set at 10pt then it is ‘<samp>0.25in</samp>’, and at 11pt and 12pt +it is ‘<samp>0.275in</samp>’. </p> </dd> <dt><code>\footskip</code> <a name="index-_005cfootskip"></a> </dt> -<dd><p>Distance from the baseline of the last line of text to the baseline of -the page footer. Default is ‘<samp>30pt</samp>’, except in the <code>book</code> -class, where it varies with the type size. +<dd><a name="index-_005cfootskip-1"></a> +<p>Distance from the baseline of the last line of text to the baseline of +the page footer. The default in the <code>article</code> and <code>report</code> +classes is ‘<samp>30pt</samp>’. In the <code>book</code> class the default is: when +the type size is 10pt the default is ‘<samp>0.35in</samp>’, while at 11pt it is +‘<samp>0.38in</samp>’, and at 12pt it is ‘<samp>30pt</samp>’. </p> </dd> <dt><code>\linewidth</code> <a name="index-_005clinewidth"></a> </dt> -<dd><p>Width of the current line, decreased for each nested <code>list</code> -(see <a href="#list">list</a>). Specifically, it is smaller than <code>\textwidth</code> by -the sum of <code>\leftmargin</code> and <code>\rightmargin</code> -(see <a href="#itemize">itemize</a>). The default varies with the font size, paper -width, two-column mode, etc. For an <code>article</code> document in -‘<samp>10pt</samp>’, it’s set to ‘<samp>345pt</samp>’; in two-column mode, that -becomes ‘<samp>229.5pt</samp>’. +<dd><a name="index-_005clinewidth-1"></a> +<p>Width of the current line, decreased for each nested <code>list</code> +(see <a href="#list">list</a>). That is, the nominal value for <code>\linewidth</code> is to +equal <code>\textwidth</code> but for each nested list the <code>\linewidth</code> +is decreased by the sum of that list’s <code>\leftmargin</code> and +<code>\rightmargin</code> (see <a href="#itemize">itemize</a>). +</p> +</dd> +<dt><code>\marginparpush</code> +<a name="index-_005cmarginparpush"></a> +</dt> +<dt><code>\marginsep</code> +<a name="index-_005cmarginsep"></a> +</dt> +<dt><code>\marginparwidth</code> +<a name="index-_005cmarginparwidth"></a> +</dt> +<dd><a name="index-_005cmarginparpush-1"></a> +<a name="index-_005cmarginsep-1"></a> +<a name="index-_005cmarginparwidth-1"></a> +<p>The minimum vertical space between two marginal notes, the horizontal +space between the text body and the marginal notes, and the horizontal +width of the notes. +</p> +<p>Normally marginal notes appear on the outside of the page, but the +declaration <code>\reversemarginpar</code> changes that (and +<code>\normalmarginpar</code> changes it back). +</p> +<p>The defaults for <code>\marginparpush</code> in both <code>book</code> and +<code>article</code> classes are: ‘<samp>7pt</samp>’ if the document is set at 12pt, +and ‘<samp>5pt</samp>’ if the document is set at 11pt or 10pt. +</p> +<p>For <code>\marginsep</code>, in <code>article</code> class the default is +‘<samp>10pt</samp>’ except if the document is set at 10pt and in two-column mode +where the default is ‘<samp>11pt</samp>’. +</p> +<p>For <code>\marginsep</code> in <code>book</code> class the default is ‘<samp>10pt</samp>’ in +two-column mode and ‘<samp>7pt</samp>’ in one-column mode. +</p> +<p>For <code>\marginparwidth</code> in both <code>book</code> and <code>article</code> +classes, in two-column mode the default is 60% of <code>\paperwidth +- \textwidth</code>, while in one-column mode it is 50% of that +distance. +</p> +</dd> +<dt><code>\oddsidemargin</code> +<a name="index-_005coddsidemargin-1"></a> +</dt> +<dt><code>\evensidemargin</code> +<a name="index-_005cevensidemargin-1"></a> +</dt> +<dd><a name="index-_005coddsidemargin-2"></a> +<a name="index-_005cevensidemargin-2"></a> +<p>The <code>\oddsidemargin</code> is the extra distance between the left side of +the page and the text’s left margin, on odd-numbered pages when the +document class option <code>twoside</code> is chosen and on all pages when +<code>oneside</code> is in effect. When <code>twoside</code> is in effect, on +even-numbered pages the extra distance on the left is +<code>evensidemargin</code>. +</p> +<p>LaTeX’s default is that <code>\oddsidemargin</code> is 40% of the +difference between <code>\paperwidth</code> and <code>\textwidth</code>, and +<code>\evensidemargin</code> is the remainder. +</p> +</dd> +<dt><code>\paperheight</code> +<a name="index-_005cpaperheight"></a> +</dt> +<dd><a name="index-_005cpaperheight-1"></a> +<p>The height of the paper, as distinct from the height of the print area. +It is normally set with a document class option, as in +<code>\documentclass[a4paper]{article}</code> (see <a href="#Document-class-options">Document class options</a>). +</p> +</dd> +<dt><code>\paperwidth</code> +<a name="index-_005cpaperwidth"></a> +</dt> +<dd><a name="index-_005cpaperwidth-1"></a> +<p>The width of the paper, as distinct from the width of the print area. +It is normally set with a document class option, as in +<code>\documentclass[a4paper]{article}</code> (see <a href="#Document-class-options">Document class options</a>). </p> </dd> <dt><code>\textheight</code> <a name="index-_005ctextheight"></a> </dt> -<dd><p>The normal vertical height of the page body; the default varies with -the font size, document class, etc. For an <code>article</code> or -<code>report</code> document in ‘<samp>10pt</samp>’, it’s set to -‘<samp>43\baselineskip</samp>’; for <code>book</code>, it’s ‘<samp>41\baselineskip</samp>’. -For ‘<samp>11pt</samp>’, it’s ‘<samp>38\baselineskip</samp>’ and for ‘<samp>12pt</samp>’, -‘<samp>36\baselineskip</samp>’. +<dd><a name="index-_005ctextheight-1"></a> +<p>The normal vertical height of the page body. If the document is set at +a nominal type size of 10pt then for an <code>article</code> or <code>report</code> +the default is ‘<samp>43\baselineskip</samp>’, while for a <code>book</code> it is +‘<samp>41\baselineskip</samp>’. At a type size of 11pt the default is +‘<samp>38\baselineskip</samp>’ for all document classes. At 12pt it is +‘<samp>36\baselineskip</samp>’ for all classes. </p> </dd> <dt><code>\textwidth</code> <a name="index-_005ctextwidth"></a> </dt> -<dd><p>The full horizontal width of the entire page body; the default varies -as usual. For an <code>article</code> or <code>report</code> document, it’s -‘<samp>345pt</samp>’ at ‘<samp>10pt</samp>’, ‘<samp>360pt</samp>’ at ‘<samp>11pt</samp>’, and -‘<samp>390pt</samp>’ at ‘<samp>12pt</samp>’. For a <code>book</code> document, it’s -‘<samp>4.5in</samp>’ at ‘<samp>10pt</samp>’, and ‘<samp>5in</samp>’ at ‘<samp>11pt</samp>’ or -‘<samp>12pt</samp>’. +<dd><a name="index-_005ctextwidth-1"></a> +<p>The full horizontal width of the entire page body. For an +<code>article</code> or <code>report</code> document, the default is ‘<samp>345pt</samp>’ +when the chosen type size is 10pt, the default is ‘<samp>360pt</samp>’ at 11pt, +and it is ‘<samp>390pt</samp>’ at 12pt. For a <code>book</code> document, the default +is ‘<samp>4.5in</samp>’ at a type size of 10pt, and ‘<samp>5in</samp>’ at 11pt or 12pt. </p> <p>In multi-column output, <code>\textwidth</code> remains the width of the entire page body, while <code>\columnwidth</code> is the width of one column @@ -1737,31 +2144,257 @@ specified width, and revert to their normal values at the end of the <code>minipage</code> or <code>\parbox</code>. </p> <a name="index-_005chsize"></a> -<p>For completeness: <code>\hsize</code> is the TeX primitive parameter used -when text is broken into lines. It should not be used in normal -LaTeX documents. +<a name="index-_005chsize-1"></a> +<p>This entry is included for completeness: <code>\hsize</code> is the TeX +primitive parameter used when text is broken into lines. It should not +be used in normal LaTeX documents. </p> </dd> <dt><code>\topmargin</code> <a name="index-_005ctopmargin"></a> </dt> -<dd><p>Space between the top of the TeX page (one inch from the top of the -paper, by default) and the top of the header. The default is computed +<dd><a name="index-topmargin"></a> +<p>Space between the top of the TeX page (one inch from the top of the +paper, by default) and the top of the header. The value is computed based on many other parameters: <code>\paperheight - 2in - -\headheight - \headsep - \textheight - \footskip</code>, and -then divided by two. +\headheight - \headsep - \textheight - \footskip</code>, +and then divided by two. </p> </dd> <dt><code>\topskip</code> <a name="index-_005ctopskip"></a> </dt> -<dd><p>Minimum distance between the top of the page body and the baseline of +<dd><a name="index-_005ctopskip-1"></a> +<p>Minimum distance between the top of the page body and the baseline of the first line of text. For the standard classes, the default is the -same as the font size, e.g., ‘<samp>10pt</samp>’ at ‘<samp>10pt</samp>’. +same as the font size, e.g., ‘<samp>10pt</samp>’ at a type size of 10pt. +</p> +</dd> +</dl> + + +<hr> +<a name="Floats"></a> +<div class="header"> +<p> +Previous: <a href="#Page-layout-parameters" accesskey="p" rel="prev">Page layout parameters</a>, Up: <a href="#Layout" accesskey="u" rel="up">Layout</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="Floats-1"></a> +<h3 class="section">5.6 Floats</h3> + +<p>Some typographic elements, such as figures and tables, cannot be broken +across pages. They must be typeset outside of the normal flow of text, +for instance floating to the top of a later page. +</p> +<p>LaTeX can have a number of different classes of floating material. +The default is the two classes, <code>figure</code> (see <a href="#figure">figure</a>) and +<code>table</code> (see <a href="#table">table</a>), but you can create a new class with the +package <samp>float</samp>. +</p> +<p>Within any one float class LaTeX always respects the order, so that +the first figure in a document source must be typeset before the second +figure. However, LaTeX may mix the classes, so it can happen that +while the first table appears in the source before the first figure, it +appears in the output after it. +</p> +<p>The placement of floats is subject to parameters, given below, that +limit the number of floats that can appear at the top of a page, and the +bottom, etc. If so many floats are queued up that the limits prevent +them all from fitting on a page then LaTeX places what it can and +defers the rest to the next page. In this way, floats may be typset far +from their place in the source. In particular, a float that is big can +migrate to the end of the document. But then because all floats in a +class must appear in sequential order, every subsequent float in that +class also appears at the end. +</p> +<a name="index-placement-of-floats"></a> +<a name="index-specifier_002c-float-placement"></a> +<p>In addition to changing the parameters, for each float you can tweak +where the float placement algorithm tries to place it by using its +<var>placement</var> argument. The possible values are a sequence of the +letters below. The default for both <code>figure</code> and <code>table</code>, in +both <code>article</code> and <code>book</code> classes, is <code>tbp</code>. +</p> +<dl compact="compact"> +<dt><code>t</code></dt> +<dd><p>(Top)—at the top of a text page. +</p> +</dd> +<dt><code>b</code></dt> +<dd><p>(Bottom)—at the bottom of a text page. (However, <code>b</code> is not +allowed for full-width floats (<code>figure*</code>) with double-column +output. To ameliorate this, use the <samp>stfloats</samp> or +<samp>dblfloatfix</samp> package, but see the discussion at caveats in the +FAQ: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</a>. +</p> +</dd> +<dt><code>h</code></dt> +<dd><p>(Here)—at the position in the text where the <code>figure</code> environment +appears. However, <code>h</code> is not allowed by itself; <code>t</code> is +automatically added. +</p> +<a name="index-here_002c-putting-floats"></a> +<a name="index-float-package"></a> +<p>To absolutely force a float to appear “here”, you can +<code>\usepackage{float}</code> and use the <code>H</code> specifier which it +defines. For further discussion, see the FAQ entry at +<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</a>. +</p> +</dd> +<dt><code>p</code></dt> +<dd><a name="index-float-page"></a> +<p>(Page of floats)—on a separate <em>float page</em>, which is a page +containing no text, only floats. +</p> +</dd> +<dt><code>!</code></dt> +<dd><p>Used in addition to one of the above; for this float only, LaTeX +ignores the restrictions on both the number of floats that can appear +and the relative amounts of float and non-float text on the page. +The <code>!</code> specifier does <em>not</em> mean “put the float here”; +see above. +</p> +</dd> +</dl> + +<p>Note: the order in which letters appear in the <var>placement</var> argument +does not change the order in which LaTeX tries to place the float; +for instance, <code>btp</code> has the same effect as <code>tbp</code>. All that +<var>placement</var> does is that if a letter is not present then the +algorithm does not try that location. Thus, LaTeX’s default of +<code>tbp</code> is to try every location except placing the float where it +occurs in the source. +</p> +<p>To prevent LaTeX from moving floats to the end of the document or a +chapter you can use a <code>\clearpage</code> command to start a new page and +insert all pending floats. If a pagebreak is undesirable then you can +use the <samp>afterpage</samp> package and issue +<code>\afterpage{\clearpage}</code>. This will wait until the current page +is finished and then flush all outstanding floats. +</p> +<p>LaTeX can typeset a float before where it appears in the source +(although on the same output page) if there is a <code>t</code> specifier in the +<var>placement</var> paramater. If this is not desired, and deleting the +<code>t</code> is not acceptable as it keeps the float from being placed at +the top of the next page, then you can prevent it by either using the +<samp>flafter</samp> package or using the command +<a name="index-_005csuppressfloats"></a> +<code>\suppressfloats[t]</code>, which causes floats for the top position on +this page to moved to the next page. +</p> +<p>Parameters relating to fractions of pages occupied by float and +non-float text (change them with +<code>\renewcommand{<var>parameter</var>}{<var>decimal between 0 and 1</var>}</code>): +</p> +<dl compact="compact"> +<dt><code>\bottomfraction</code> +<a name="index-_005cbottomfraction"></a> +</dt> +<dd><a name="index-_005cbottomfraction-1"></a> +<p>The maximum fraction of the page allowed to be occupied by floats at +the bottom; default ‘<samp>.3</samp>’. +</p> +</dd> +<dt><code>\floatpagefraction</code> +<a name="index-_005cfloatpagefraction"></a> +</dt> +<dd><a name="index-_005cfloatpagefraction-1"></a> +<p>The minimum fraction of a float page that must be occupied by floats; +default ‘<samp>.5</samp>’. +</p> +</dd> +<dt><code>\textfraction</code> +<a name="index-_005ctextfraction"></a> +</dt> +<dd><a name="index-_005ctextfraction-1"></a> +<p>Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is ‘<samp>.2</samp>’. +</p> +</dd> +<dt><code>\topfraction</code> +<a name="index-_005ctopfraction"></a> +</dt> +<dd><a name="index-_005ctopfraction-1"></a> +<p>Maximum fraction at the top of a page that may be occupied before +floats; default ‘<samp>.7</samp>’. +</p></dd> +</dl> + +<p>Parameters relating to vertical space around floats (change them with +<code>\setlength{<var>parameter</var>}{<var>length expression</var>}</code>): +</p> +<dl compact="compact"> +<dt><code>\floatsep</code> +<a name="index-_005cfloatsep"></a> +</dt> +<dd><a name="index-_005cfloatsep-1"></a> +<p>Space between floats at the top or bottom of a page; default +‘<samp>12pt plus2pt minus2pt</samp>’. +</p> +</dd> +<dt><code>\intextsep</code> +<a name="index-_005cintextsep"></a> +</dt> +<dd><a name="index-_005cintextsep-1"></a> +<p>Space above and below a float in the middle of the main text; default +‘<samp>12pt plus2pt minus2pt</samp>’ for 10 point and 11 point documents, +and ‘<samp>14pt plus4pt minus4pt</samp>’ for 12 point documents. +</p> +</dd> +<dt><code>\textfloatsep</code> +<a name="index-_005ctextfloatsep"></a> +</dt> +<dd><a name="index-_005ctextfloatsep-1"></a> +<p>Space between the last (first) float at the top (bottom) of a page; +default ‘<samp>20pt plus2pt minus4pt</samp>’. +</p></dd> +</dl> + +<p>Counters relating to the number of floats on a page (change them with +<code>\setcounter{<var>ctrname</var>}{<var>natural number</var>}</code>): +</p> +<dl compact="compact"> +<dt><code>bottomnumber</code> +<a name="index-bottomnumber"></a> +</dt> +<dd><a name="index-bottomnumber-1"></a> +<p>Maximum number of floats that can appear at the bottom of a text page; +default 1. +</p> +</dd> +<dt><code>dbltopnumber</code> +<a name="index-dbltopnumber"></a> +</dt> +<dd><a name="index-dbltopnumber-1"></a> +<p>Maximum number of full-sized floats that can appear at the top of a +two-column page; default 2. </p> </dd> +<dt><code>topnumber</code> +<a name="index-topnumber"></a> +</dt> +<dd><a name="index-topnumber-1"></a> +<p>Maximum number of floats that can appear at the top of a text page; +default 2. +</p> +</dd> +<dt><code>totalnumber</code> +<a name="index-totalnumber"></a> +</dt> +<dd><a name="index-totalnumber-1"></a> +<p>Maximum number of floats that can appear on a text page; default 3. +</p></dd> </dl> +<p>The principal TeX FAQ entry relating to floats +<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</a> contains +suggestions for relaxing LaTeX’s default parameters to reduce the +problem of floats being pushed to the end. A full explaination of the +float placement algorithm is Frank Mittelbach’s article “How to +infuence the position of float environments like figure and table in +LaTeX?” <a href="http://latex-project.org/papers/tb111mitt-float.pdf">http://latex-project.org/papers/tb111mitt-float.pdf</a>. +</p> <hr> <a name="Sectioning"></a> @@ -1771,7 +2404,8 @@ Next: <a href="#Cross-references" accesskey="n" rel="next">Cross references</a>, </div> <a name="Sectioning-1"></a> <h2 class="chapter">6 Sectioning</h2> -<a name="index-sectioning"></a> + +<a name="index-sectioning-commands"></a> <p>Sectioning commands provide the means to structure your text into units: </p> @@ -1864,6 +2498,7 @@ Next: <a href="#Environments" accesskey="n" rel="next">Environments</a>, Previou </div> <a name="Cross-references-1"></a> <h2 class="chapter">7 Cross references</h2> + <a name="index-cross-references"></a> <p>One reason for numbering things like figures and equations is to refer @@ -1887,6 +2522,7 @@ Next: <a href="#g_t_005cpageref" accesskey="n" rel="next">\pageref</a>, Up: <a h </div> <a name="g_t_005clabel-1"></a> <h3 class="section">7.1 <code>\label</code></h3> + <a name="index-_005clabel"></a> <p>Synopsis: @@ -1897,15 +2533,35 @@ Next: <a href="#g_t_005cpageref" accesskey="n" rel="next">\pageref</a>, Up: <a h <p>A <code>\label</code> command appearing in ordinary text assigns to <var>key</var> the number of the current sectional unit; one appearing -inside a numbered environment assigns that number to <var>key</var>. +inside a numbered environment assigns that number to <var>key</var>. The +assigned number can be retrieved with the <code>\ref{<var>key</var>}</code> +command (see <a href="#g_t_005cref">\ref</a>). </p> -<p>A <var>key</var> name can consist of any sequence of letters, digits, or +<p>Thus, in the example below the key <code>sec:test</code> holds the number of +the current section and the key <code>fig:test</code> that of the figure. +(Incidentally, labels must appear after captions in figures and +tables.) +</p> +<div class="example"> +<pre class="example">\section{section name} +\label{sec:test} +This is Section~\ref{sec:test}. +\begin{figure} + ... + \caption{caption text} + \label{fig:test} +\end{figure} +See Figure~\ref{fig:test}. +</pre></div> + +<p>A key name can consist of any sequence of letters, digits, or common punctuation characters. Upper and lowercase letters are distinguished, as usual. </p> -<p>To avoid accidentally creating two labels with the same name, it is -common to use labels consisting of a prefix and a suffix separated by -a colon or period. Some conventionally-used prefixes: +<p>Although the name can be more or less anything, a common convention is +to use labels consisting of a prefix and a suffix separated by a colon +or period. This helps to avoid accidentally creating two labels with +the same name. Some commonly-used prefixes: </p> <dl compact="compact"> <dt><code>ch</code></dt> @@ -1925,8 +2581,8 @@ a colon or period. Some conventionally-used prefixes: </p></dd> </dl> -<p>Thus, a label for a figure would look like <code>fig:snark</code> or -<code>fig.snark</code>. +<p>Thus, a label for a figure would look like <code>fig:test</code> or +<code>fig.test</code>. </p> <hr> @@ -1937,6 +2593,7 @@ Next: <a href="#g_t_005cref" accesskey="n" rel="next">\ref</a>, Previous: <a hre </div> <a name="g_t_005cpageref_007bkey_007d"></a> <h3 class="section">7.2 <code>\pageref{<var>key</var>}</code></h3> + <a name="index-_005cpageref"></a> <a name="index-cross-referencing-with-page-number"></a> <a name="index-page-number_002c-cross-referencing"></a> @@ -1960,6 +2617,7 @@ Previous: <a href="#g_t_005cpageref" accesskey="p" rel="prev">\pageref</a>, Up: </div> <a name="g_t_005cref_007bkey_007d"></a> <h3 class="section">7.3 <code>\ref{<var>key</var>}</code></h3> + <a name="index-_005cref"></a> <a name="index-cross-referencing_002c-symbolic"></a> <a name="index-section-number_002c-cross-referencing"></a> @@ -1987,8 +2645,8 @@ Next: <a href="#Line-breaking" accesskey="n" rel="next">Line breaking</a>, Previ </div> <a name="Environments-1"></a> <h2 class="chapter">8 Environments</h2> -<a name="index-environments"></a> +<a name="index-environments"></a> <a name="index-_005cbegin"></a> <a name="index-_005cend"></a> @@ -2040,9 +2698,7 @@ Each environment begins and ends in the same manner: </td></tr> <tr><td align="left" valign="top">• <a href="#picture">picture</a>:</td><td> </td><td align="left" valign="top">Picture with text, arrows, lines and circles. </td></tr> -<tr><td align="left" valign="top">• <a href="#quotation">quotation</a>:</td><td> </td><td align="left" valign="top">Indented environment with paragraph indentation. -</td></tr> -<tr><td align="left" valign="top">• <a href="#quote">quote</a>:</td><td> </td><td align="left" valign="top">Indented environment with no paragraph indentation. +<tr><td align="left" valign="top">• <a href="#quotation-and-quote">quotation and quote</a>:</td><td> </td><td align="left" valign="top">Include a quotation. </td></tr> <tr><td align="left" valign="top">• <a href="#tabbing">tabbing</a>:</td><td> </td><td align="left" valign="top">Align text arbitrarily. </td></tr> @@ -2076,7 +2732,8 @@ Next: <a href="#array" accesskey="n" rel="next">array</a>, Up: <a href="#Environ <a name="index-abstracts"></a> <p>Synopsis: -</p><div class="example"> +</p> +<div class="example"> <pre class="example">\begin{abstract} ... \end{abstract} @@ -2093,65 +2750,71 @@ Next: <a href="#center" accesskey="n" rel="next">center</a>, Previous: <a href=" </div> <a name="array-1"></a> <h3 class="section">8.2 <code>array</code></h3> + <a name="index-array-environment"></a> <a name="index-arrays_002c-math"></a> <p>Synopsis: </p> <div class="example"> -<pre class="example">\begin{array}{<var>template</var>} -<var>col1 text</var>&<var>col1 text</var>&<var>coln</var>}\\ +<pre class="example">\begin{array}{<var>cols</var>} +<var>column 1 entry</var> &<var>column 2 entry</var> ... &<var>column n entry</var> \\ ... \end{array} </pre></div> -<p>Math arrays are produced with the <code>array</code> environment, normally -within an <code>equation</code> environment (see <a href="#equation">equation</a>). It has a -single mandatory <var>template</var> argument describing the number of -columns and the alignment within them. Each column <var>col</var> is -specified by a single letter that tells how items in each row of that -column should be formatted, as follows: +<p>or </p> -<dl compact="compact"> -<dt><code>c</code></dt> -<dd><p>centered -</p></dd> -<dt><code>l</code></dt> -<dd><p>flush left -</p></dd> -<dt><code>r</code></dt> -<dd><p>flush right -</p></dd> -</dl> +<div class="example"> +<pre class="example">\begin{array}[<var>pos</var>]{<var>cols</var>} +<var>column 1 entry</var> &<var>column 2 entry</var> ... &<var>column n entry</var> \\ +... +\end{array} +</pre></div> -<a name="index-_005c_005c-_0028for-array_0029"></a> -<p>Column entries are separated by <code>&</code>. Column entries may include -other LaTeX commands. Each row of the array is terminated with -<code>\\</code>. +<p>Produce a mathematical array. This environment can only be used in math +mode, and normally appears within a displayed mathematics environment +such as <code>equation</code> (see <a href="#equation">equation</a>). Column entries are +separated by an ampersand (<code>&</code>). Rows are terminated with +double-backslashes (<code>\\</code>) (see <a href="#g_t_005c_005c">\\</a>). +</p> +<p>The required argument <var>cols</var> describes the number of columns, their +alignment, and the formatting of the intercolumn regions. See +<a href="#tabular">tabular</a> for the complete description of <var>cols</var>, and of the +other common features of the two environments, including the optional +<var>pos</var> argument. +</p> +<p>There are two ways that <code>array</code> diverges from <code>tabular</code>. The +first is that <code>array</code> entries are typeset in mathematics mode, in +textstyle (except if the <var>cols</var> definition specifies the column with +<code>@p{..}</code>, which causes the entry to be typeset in text mode). +The second is that, instead of <code>tabular</code>’s parameter +<code>\tabcolsep</code>, LaTeX’s intercolumn space in an array is governed +by +<a name="index-_005carraycolsep"></a> +<code>\arraycolsep</code> which gives half the width between columns. The +default for this is ‘<samp>5pt</samp>’. </p> -<a name="index-_0040_007b_002e_002e_002e_007d"></a> -<p>In the template, the construct <code>@{<var>text</var>}</code> puts <var>text</var> -between columns in each row. +<p>To obtain arrays with braces the standard is to use the <samp>amsmath</samp> +package. It comes with environments <code>pmatrix</code> for an array +surrounded by parentheses <code>(..)</code>, <code>bmatrix</code> for an array +surrounded by square brackets <code>[..]</code>, <code>Bmatrix</code> for an +array surrounded by curly braces <code>{..}</code>, <code>vmatrix</code> for +an array surrounded by vertical bars <code>|..|</code>, and +<code>Vmatrix</code> for an array surrounded by double vertical +bars <code>||..||</code>, along with a number of other array constructs. </p> -<p>Here’s an example: +<p>Here is an example of an array: </p> <div class="example"> <pre class="example">\begin{equation} - \begin{array}{lrc} - left1 & right1 & centered1 \\ - left2 & right2 & centered2 \\ + \begin{array}{cr} + \sqrt{y} &12.3 \\ + x^2 &3.4 \end{array} \end{equation} </pre></div> -<a name="index-_005carraycolsep"></a> -<p>The <code>\arraycolsep</code> parameter defines half the width of the space -separating columns; the default is ‘<samp>5pt</samp>’. See <a href="#tabular">tabular</a>, for other -parameters which affect formatting in <code>array</code> environments, -namely <code>\arrayrulewidth</code> and <code>\arraystretch</code>. -</p> -<p>The <code>array</code> environment can only be used in math mode. -</p> <hr> <a name="center"></a> @@ -2169,16 +2832,35 @@ Next: <a href="#description" accesskey="n" rel="next">description</a>, Previous: </p> <div class="example"> <pre class="example">\begin{center} -<var>line1</var> \\ -<var>line2</var> \\ + .. text .. \end{center} </pre></div> +<p>Environment to create a sequence of lines that are centered within the +left and right margins on the current page. If the text in the +environment body is too long to fit on a line, LaTeX will insert line +breaks that avoid hyphenation and avoid stretching or shrinking any +interword space. To force a line break at a particular spot use +double-backslash <code>\\</code> (see <a href="#g_t_005c_005c">\\</a>). <a name="index-_005c_005c-_0028for-center_0029"></a> -<p>The <code>center</code> environment allows you to create a paragraph -consisting of lines that are centered within the left and right -margins on the current page. Each line is terminated with the -string <code>\\</code>. +</p> +<p>This environment inserts space above and below the text body. See +<a href="#g_t_005ccentering">\centering</a> to avoid such space, for example inside a <code>figure</code> +environment. +</p> +<p>In this example, depending on the line width, LaTeX may choose a break +for the part before the double backslash, will center the line or two, +then will break at the double backslash, and will center the ending. +</p> +<div class="example"> +<pre class="example">\begin{center} + My father considered that anyone who went to chapel and didn't drink + alcohol was not to be tolerated.\\ + I grew up in that belief. --Richard Burton +\end{center} +</pre></div> + +<p>A double backslash after the final line is optional. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005ccentering" accesskey="1">\centering</a>:</td><td> </td><td align="left" valign="top">Declaration form of the <code>center</code> environment. @@ -2198,28 +2880,38 @@ Up: <a href="#center" accesskey="u" rel="up">center</a> [<a href="#SEC_Co <a name="index-_005ccentering"></a> <a name="index-centering-text_002c-declaration-for"></a> -<p>The <code>\centering</code> declaration corresponds to the <code>center</code> -environment. This declaration can be used inside an environment such -as <code>quote</code> or in a <code>parbox</code>. Thus, the text of a figure or -table can be centered on the page by putting a <code>\centering</code> -command at the beginning of the figure or table environment. +<p>Declaration that causes material in its scope to be centered. It is +most often used inside an environment such as <code>figure</code>, or in a +<code>parbox</code>. </p> -<p>Unlike the <code>center</code> environment, the <code>\centering</code> command -does not start a new paragraph; it simply changes how LaTeX formats -paragraph units. To affect a paragraph unit’s format, the scope of -the declaration must contain the blank line or <code>\end</code> command (of -an environment such as quote) that ends the paragraph unit. +<p>Unlike the <code>center</code> environment, the <code>\centering</code> command does +not add vertical space above and below the text. </p> -<p>Here’s an example: +<p>It also does not start a new paragraph; it simply changes how LaTeX +formats paragraph units. If <code>ww {\centering xx \\ yy} zz</code> is +surrounded by blank lines then LaTeX will create a paragraph whose +first line ‘<samp>ww xx</samp>’ is centered and whose second line, not centered, +contains ‘<samp>yy zz</samp>’. Usually what is desired is for the scope of the +declaration to contain a blank line or the <code>\end</code> command of an +environment such as <code>figure</code> or <code>table</code> that ends the +paragraph unit. Thus, if <code>{\centering xx \\ yy\par} zz</code> is +surrounded by blank lines then it makes a new paragraph with two +centered lines ‘<samp>xx</samp>’ and ‘<samp>yy</samp>’, followed by a new paragraph with +‘<samp>zz</samp>’ that is formatted as usual. See also the following example. +</p> +<p>This example’s <code>\centering</code> causes the graphic to be horizontally +centered. </p> <div class="example"> -<pre class="example">\begin{quote} -\centering -first line \\ -second line \\ -\end{quote} +<pre class="example">\begin{figure} + \centering + \includegraphics[width=0.6\textwidth]{ctan_lion.png} + \caption{CTAN Lion} \label{fig:CTANLion} +\end{figure} </pre></div> +<p>The scope of the <code>\centering</code> ends with the <code>\end{figure}</code>. +</p> <hr> <a name="description"></a> @@ -2238,28 +2930,46 @@ Next: <a href="#displaymath" accesskey="n" rel="next">displaymath</a>, Previous: </p> <div class="example"> <pre class="example">\begin{description} -\item [<var>label1</var>] <var>item1</var> -\item [<var>label2</var>] <var>item2</var> -... +\item [<var>first label</var>] text of first item +\item [<var>second label</var>] text of second item + ... \end{description} </pre></div> <a name="index-_005citem"></a> -<p>The <code>description</code> environment is used to make labelled lists. Each -<var>label</var> is typeset in bold, flush right. The <var>item</var> text may -contain multiple paragraphs. +<p>Environment to make a labelled list of items. Each item’s <var>label</var> +is typeset in bold, flush-left. Each item’s text may contain multiple +paragraphs. Although the labels on the items are optional there is no +sensible default, so all items should have labels. +</p> +<a name="index-_005citem-1"></a> +<p>The list consists of at least one item; see <a href="#g_t_005citem">\item</a> (having no +items causes the LaTeX error ‘<samp>Something's wrong--perhaps a +missing \item</samp>’). Each item is produced with an <code>\item</code> command. </p> <a name="index-bold-typewriter_002c-avoiding"></a> <a name="index-typewriter-labels-in-lists"></a> -<p>Another variation: since the bold style is applied to the labels, if -you typeset a label in typewriter using <code>\texttt</code>, you’ll get -bold typewriter: <code>\item[\texttt{bold and typewriter}]</code>. This -may be too bold, among other issues. To get just typewriter, use -<code>\tt</code>, which resets all other style variations: <code>\item[{\tt -plain typewriter}]</code>. +<p>Since the labels are in bold style, if the label text calls for a font +change given in argument style (see <a href="#Font-styles">Font styles</a>) then it will come +out bold. For instance, if the label text calls for typewriter with +<code>\item[\texttt{label text}]</code> then it will appear in bold +typewriter, if that is available. The simplest way to get non-bolded +typewriter is to use declaritive style <code>\item[{\tt label text}]</code>. +Similarly, get normal text use <code>\item[{\rm label text}]</code>. </p> -<p>For details about list spacing, see <a href="#itemize">itemize</a>. +<p>For other major LaTeX labelled list environments, see <a href="#itemize">itemize</a> +and <a href="#enumerate">enumerate</a>. For information about customizing list layout, see +<a href="#list">list</a>; also, the package <samp>enumitem</samp> is useful for this. </p> +<p>This example shows the environment used for a sequence of definitions. +</p> +<div class="example"> +<pre class="example">\begin{definition} + \item[lama] A priest. + \item[llama] A beast. +\end{definition} +</pre></div> + <hr> <a name="displaymath"></a> @@ -2276,23 +2986,46 @@ Next: <a href="#document" accesskey="n" rel="next">document</a>, Previous: <a hr </p> <div class="example"> <pre class="example">\begin{displaymath} -<var>math</var> + .. math text .. \end{displaymath} </pre></div> -<p>or -</p> -<div class="example"> -<pre class="example">\[<var>math</var>\] +<p>Environment to typeset the math text on its own line, in display style +and centered. To make the text be flush-left use the global option +<code>fleqn</code>; see <a href="#Document-class-options">Document class options</a>. +</p> +<p>LaTeX will not break the math text across lines. +</p> +<p>In the <code>displaymath</code> environment no equation number is added to the +math text. One way to get an equation number is to use the +<code>equation</code> environment (see <a href="#equation">equation</a>). +</p> +<p>Note that the <samp>amsmath</samp> package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. For example, there are a number of options in that +package for having math text broken across lines. +</p> +<p>The construct <code>\[..math text..\]</code> is essentially a synonym for +<code>\begin{displaymath}..math text..\end{displaymath}</code> but the +latter is easier to work with in the source file; for instance, +searching for a square bracket may get false positives but the word +<code>displaymath</code> will likely be unique. (The construct <code>$$..math +text..$$</code> from Plain TeX is sometimes mistakenly used as a +synonym for <code>displaymath</code>. It is not a synonym, because the +<code>displaymath</code> environment checks that it isn’t started in math mode +and that it ends in math mode begun by the matching environment start, +because the <code>displaymath</code> environment has different vertical +spacing, and because the <code>displaymath</code> environment honors the +<code>fleqn</code> option.) +</p> +<p>The output from this example is centered and alone on its line. +</p><div class="example"> +<pre class="example">\begin{displaymath} + \int_1^2 x^2\,dx=7/3 +\end{displaymath} </pre></div> - -<p>The <code>displaymath</code> environment (<code>\[...\]</code> is a synonym) -typesets the <var>math</var> text on its own line, centered by default. -The global <code>fleqn</code> option makes equations flush left; see -<a href="#Document-class-options">Document class options</a>. -</p> -<p>No equation number is added to <code>displaymath</code> text; to get an -equation number, use the <code>equation</code> environment (see <a href="#equation">equation</a>). +<p>Also, the integral sign is larger than the inline version +<code>\( \int_1^2 x^2\,dx=7/3 \)</code> produces. </p> <hr> @@ -2306,9 +3039,71 @@ Next: <a href="#enumerate" accesskey="n" rel="next">enumerate</a>, Previous: <a <a name="index-document-environment"></a> -<p>The <code>document</code> environment encloses the body of a document. +<p>The <code>document</code> environment encloses the entire body of a document. It is required in every LaTeX document. See <a href="#Starting-and-ending">Starting and ending</a>. </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#g_t_005cAtBeginDocument" accesskey="1">\AtBeginDocument</a>:</td><td> </td><td align="left" valign="top">Hook for commands at the start of the document. +</td></tr> +<tr><td align="left" valign="top">• <a href="#g_t_005cAtEndDocument" accesskey="2">\AtEndDocument</a>:</td><td> </td><td align="left" valign="top">Hook for commands at the end of the document. +</td></tr> +</table> + + +<hr> +<a name="g_t_005cAtBeginDocument"></a> +<div class="header"> +<p> +Next: <a href="#g_t_005cAtEndDocument" accesskey="n" rel="next">\AtEndDocument</a>, Up: <a href="#document" accesskey="u" rel="up">document</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<h4 class="node-heading">\AtBeginDocument</h4> + +<a name="index-_005cAtBeginDocument"></a> +<a name="index-beginning-of-document-hook"></a> + +<p>Synopsis: +</p> +<div class="example"> +<pre class="example">\AtBeginDocument{<var>code</var>} +</pre></div> + +<p>Save <var>code</var> and execute it when <code>\begin{document}</code> is +executed, at the very end of the preamble. The code is executed after +the font selection tables have been set up, so the normal font for the +document is the current font. However, the code is executed as part of +the preamble so you cannot do any typesetting with it. +</p> +<p>You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. +</p> + +<hr> +<a name="g_t_005cAtEndDocument"></a> +<div class="header"> +<p> +Previous: <a href="#g_t_005cAtBeginDocument" accesskey="p" rel="prev">\AtBeginDocument</a>, Up: <a href="#document" accesskey="u" rel="up">document</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<h4 class="node-heading">\AtEndDocument</h4> + +<a name="index-_005cAtEndDocument"></a> +<a name="index-end-of-document-hook"></a> + +<p>Synopsis: +</p> +<div class="example"> +<pre class="example">\AtEndDocument{<var>code</var>} +</pre></div> + +<p>Save <var>code</var> and execute it near the end of the document. +Specifically, it is executed when <code>\end{document}</code> is executed, +before the final page is finished and before any leftover floating +environments are processed. If you want some of the code to be executed +after these two processes then include a <code>\clearpage</code> at the +appropriate point in <var>code</var>. +</p> +<p>You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. +</p> <hr> <a name="enumerate"></a> @@ -2326,54 +3121,79 @@ Next: <a href="#eqnarray" accesskey="n" rel="next">eqnarray</a>, Previous: <a hr </p> <div class="example"> <pre class="example">\begin{enumerate} -\item <var>item1</var> -\item <var>item2</var> +\item [<var>first label</var>] text of first item +\item [<var>second label</var>] text of second item ... \end{enumerate} </pre></div> -<p>The <code>enumerate</code> environment produces a numbered list. Enumerations -can be nested within one another, up to four levels deep. They can also -be nested within other paragraph-making environments, such as -<code>itemize</code> (see <a href="#itemize">itemize</a>) and <code>description</code> -(see <a href="#description">description</a>). +<p>Environment to produce a numbered list of items. The format of the +label numbering depends on whether this environment is nested within +another; see below. </p> -<a name="index-_005citem-1"></a> -<p>Each item of an enumerated list begins with an <code>\item</code> command. -There must be at least one <code>\item</code> command within the environment. +<a name="index-_005citem-2"></a> +<p>The list consists of at least one item. Having no items causes the +LaTeX error ‘<samp>Something's wrong--perhaps a missing \item</samp>’. Each +item is produced with an <code>\item</code> command. +</p> +<p>This example lists the top two finishers in the 1908 Olympic marathon. </p> -<p>By default, the numbering at each level is done like this: +<div class="example"> +<pre class="example">\begin{enumerate} + \item Johnny Hayes (USA) + \item Charles Hefferon (RSA) +\end{enumerate} +</pre></div> + +<p>Enumerations may be nested within a paragraph-making environment, +including <code>itemize</code> (see <a href="#itemize">itemize</a>), <code>description</code> +(see <a href="#description">description</a>) and <code>enumeration</code>, up to four levels deep. +The format of the label produced depends on the place in the nesting. +This gives LaTeX’s default for the format at each nesting level +(where 1 is the outermost level): </p> <ol> -<li> 1., 2., … -</li><li> (a), (b), … -</li><li> i., ii., … -</li><li> A., B., … +<li> arabic number followed by a period: ‘<samp>1.</samp>’, ‘<samp>2.</samp>’, … +</li><li> lower case letter inside parentheses: ‘<samp>(a)</samp>’, ‘<samp>(b)</samp>’ … +</li><li> lower case roman numeral followed by a period: ‘<samp>i.</samp>’, ‘<samp>ii.</samp>’, … +</li><li> upper case letter followed by a period: ‘<samp>A.</samp>’, ‘<samp>B.</samp>’, … </li></ol> <a name="index-_005cenumi"></a> <a name="index-_005cenumii"></a> <a name="index-_005cenumiii"></a> <a name="index-_005cenumiv"></a> -<p>The <code>enumerate</code> environment uses the counters <code>\enumi</code> -through <code>\enumiv</code> counters (see <a href="#Counters">Counters</a>). If the optional -argument to <code>\item</code> is given, the counter is not incremented for -that item. +<p>The <code>enumerate</code> environment uses the counters <code>\enumi</code> through +<code>\enumiv</code> counters (see <a href="#Counters">Counters</a>). If you use the optional +argument to <code>\item</code> then the counter is not incremented for that +item (see <a href="#g_t_005citem">\item</a>). </p> <a name="index-_005clabelenumi"></a> <a name="index-_005clabelenumii"></a> <a name="index-_005clabelenumiii"></a> <a name="index-_005clabelenumiv"></a> -<p>The <code>enumerate</code> environment uses the commands <code>\labelenumi</code> -through <code>\labelenumiv</code> to produce the default label. So, you can -use <code>\renewcommand</code> to change the labels (see <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>). For instance, to have the first level use uppercase -letters: +<p>To change the format of the label use <code>\renewcommand</code> +(see <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>) on the commands <code>\labelenumi</code> +through <code>\labelenumiv</code>. For instance, this first level list will be +labelled with uppercase letters, in boldface, and without a trailing +period: </p> <a name="index-_005cAlph-example"></a> <div class="example"> -<pre class="example">\renewcommand{\labelenumi}{\Alph{enumi}} +<pre class="example">\renewcommand{\labelenumi}{\textbf{\Alph{enumi}}} +\begin{enumerate} + \item eI + \item bi: + \item si: +\end{enumerate} </pre></div> +<p>For a list of counter-labelling commands like <code>\Alph</code> see +<a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a>. +</p> +<p>For more on customizing the layout see <a href="#list">list</a>. Also, the package +<samp>enumitem</samp> is useful for this. +</p> <hr> @@ -2392,46 +3212,69 @@ Next: <a href="#equation" accesskey="n" rel="next">equation</a>, Previous: <a hr <a name="index-align-environment_002c-from-amsmath"></a> <a name="index-amsmath-package_002c-replacing-eqnarray"></a> <a name="index-Madsen_002c-Lars"></a> -<p>First, a caveat: the <code>eqnarray</code> environment has some infelicities -which cannot be overcome; the article “Avoid eqnarray!” by Lars -Madsen describes them in detail -(<a href="http://tug.org/TUGboat/tb33-1/tb103madsen.pdf">http://tug.org/TUGboat/tb33-1/tb103madsen.pdf</a>). The bottom -line is that it is better to use the <code>align</code> environment (and -others) from the <code>amsmath</code> package. +<p>First, a caveat: the <code>eqnarray</code> environment is depreciated. It has +infelicities that cannot be overcome, including spacing that is +inconsistent with other mathematics elements (see the article “Avoid +eqnarray!” by Lars Madsen +<a href="http://tug.org/TUGboat/tb33-1/tb103madsen.pdf">http://tug.org/TUGboat/tb33-1/tb103madsen.pdf</a>). New documents +should include the <samp>amsmath</samp> package and use the displayed +mathematics environments provided there, such as the <code>align</code> +environment. </p> -<p>Nevertheless, here is a description of <code>eqnarray</code>: +<p>Nevertheless, for completeness and for a reference when working with old +documents, a synopsis: </p> <div class="example"> -<pre class="example">\begin{eqnarray} <span class="roman">(or <code>eqnarray*</code>)</span> -<var>formula1</var> \\ -<var>formula2</var> \\ -... +<pre class="example">\begin{eqnarray} + <var>first formula left</var> &<var>first formula middle</var> &<var>first formula right</var> \\ + ... \end{eqnarray} </pre></div> +<p>or +</p> +<div class="example"> +<pre class="example">\begin{eqnarray*} + <var>first formula left</var> &<var>first formula middle</var> &<var>first formula right</var> \\ + ... +\end{eqnarray*} +</pre></div> + <a name="index-_005c_005c-_0028for-eqnarray_0029"></a> -<p>The <code>eqnarray</code> environment is used to display a sequence of -equations or inequalities. It is similar to a three-column -<code>array</code> environment, with consecutive rows separated by <code>\\</code> -and consecutive items within a row separated by an <code>&</code>. +<p>Display a sequence of equations or inequalities. The left and right +sides are typeset in display mode, while the middle is typeset in text +mode. </p> +<p>It is similar to a three-column <code>array</code> environment, with items +within a row separated by an ampersand (<code>&</code>), and with rows +separated by double backslash <code>\\</code>). <a name="index-_005c_005c_002a-_0028for-eqnarray_0029"></a> -<p><code>\\*</code> can also be used to separate equations, with its normal -meaning of not allowing a page break at that line. +The starred form of line break (<code>\\*</code>) can also be used to separate +equations, and will disallow a page break there (see <a href="#g_t_005c_005c">\\</a>). </p> <a name="index-_005cnonumber"></a> <a name="index-equation-numbers_002c-omitting"></a> -<p>An equation number is placed on every line unless that line has a -<code>\nonumber</code> command. Alternatively, The <code>*</code>-form of the -environment (<code>\begin{eqnarray*} ... \end{eqnarray*}</code>) will -omit equation numbering entirely, while otherwise being the same as -<code>eqnarray</code>. +<p>The unstarred form <code>eqnarray</code> places an equation number on every +line (using the <code>equation</code> counter), unless that line contains a +<code>\nonumber</code> command. The starred form <code>eqnarray*</code> omits +equation numbering, while otherwise being the same. </p> <a name="index-_005clefteqn"></a> <p>The command <code>\lefteqn</code> is used for splitting long formulas across lines. It typesets its argument in display style flush left in a box of zero width. </p> +<p>This example shows three lines. The first two lines make an inequality, +while the third line has not entry on the left side. +</p> +<div class="example"> +<pre class="example">\begin{eqnarray*} + \lefteqn{x_1+x_2+\cdots+x_n} \\ + &\leq &y_1+y_2+\cdots+y_n \\ + &= &z+y_3+\cdots+y_n +\end{eqnarray*} +</pre></div> + <hr> <a name="equation"></a> @@ -2450,13 +3293,18 @@ Next: <a href="#figure" accesskey="n" rel="next">figure</a>, Previous: <a href=" </p> <div class="example"> <pre class="example">\begin{equation} -<var>math</var> + math text \end{equation} </pre></div> -<p>The <code>equation</code> environment starts a <code>displaymath</code> -environment (see <a href="#displaymath">displaymath</a>), e.g., centering the <var>math</var> text -on the page, and also places an equation number in the right margin. +<p>Make a <code>displaymath</code> environment (see <a href="#displaymath">displaymath</a>) with an +equation number in the right margin. +</p> +<p>The equation number is generated using the <code>equation</code> counter. +</p> +<p>Note that the <samp>amsmath</samp> package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. </p> <hr> @@ -2467,176 +3315,67 @@ Next: <a href="#filecontents" accesskey="n" rel="next">filecontents</a>, Previou </div> <a name="figure-1"></a> <h3 class="section">8.10 <code>figure</code></h3> + <a name="index-figure"></a> <a name="index-inserting-figures"></a> <a name="index-figures_002c-inserting"></a> +<p>Synopsis: +</p> <div class="example"> -<pre class="example">\begin{figure[*]}[<var>placement</var>] -<var>figbody</var> +<pre class="example">\begin{figure}[<var>placement</var>] + figure body +\caption[<var>loftitle</var>]{<var>title</var>} \label{<var>label}</var> -\caption[<var>loftitle</var>]{<var>text</var>} \end{figure} </pre></div> -<p>Figures are objects that are not part of the normal text, and are -instead “floated” to a convenient place, such as the top of a page. -Figures will not be split between two pages. -</p> -<p>When typesetting in double-columns, the starred form produces a -full-width figure (across both columns). -</p> -<a name="index-placement-of-floats"></a> -<a name="index-specifier_002c-float-placement"></a> -<p>The optional argument <code>[placement]</code> determines where LaTeX will try -to place your figure. There are four places where LaTeX can possibly -put a float: -</p> -<dl compact="compact"> -<dt><code>t</code></dt> -<dd><p>(Top)—at the top of a text page. -</p> -</dd> -<dt><code>b</code></dt> -<dd><p>(Bottom)—at the bottom of a text page. However, <code>b</code> is not -allowed for full-width floats (<code>figure*</code>) with double-column -output. To ameliorate this, use the <code>stfloats</code> or -<code>dblfloatfix</code> package, but see the discussion at caveats in the -FAQ: <a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</a>. -</p> -</dd> -<dt><code>h</code></dt> -<dd><p>(Here)—at the position in the text where the <code>figure</code> environment -appears. However, <code>t</code> is not allowed by itself; <code>t</code> is -automatically added. -</p> -<a name="index-here_002c-putting-floats"></a> -<a name="index-float-package"></a> -<p>To absolutely force a figure to appear “here”, you can -<code>\usepackage{float}</code> and use the <code>H</code> specifier which it -defines. For further discussion, see the FAQ entry at -<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</a>. -</p> -</dd> -<dt><code>p</code></dt> -<dd><p>(Page of floats)—on a separate float page, which is a page -containing no text, only floats. -</p> -</dd> -<dt><code>!</code></dt> -<dd><p>Used in addition to one of the above; for this float only, LaTeX -ignores the restrictions on both the number of floats that can appear -and the relative amounts of float and non-float text on the page. -The <code>!</code> specifier does <em>not</em> mean “put the float here”; -see above. -</p> -</dd> -</dl> - -<p>The standard <code>report</code> and <code>article</code> classes use the default placement -<code>tbp</code>. -</p> -<p>The body of the figure is made up of whatever text, LaTeX commands, -etc. you wish. -</p> -<a name="index-_005ccaption"></a> -<p>The <code>\caption</code> command specifies caption <var>text</var> for the -figure. The caption is numbered by default. If <var>loftitle</var> is -present, it is used in the list of figures instead of <var>text</var> -(see <a href="#Tables-of-contents">Tables of contents</a>). -</p> -<p>Parameters relating to fractions of pages occupied by float and -non-float text: -</p> -<dl compact="compact"> -<dd><a name="index-_005cbottomfraction"></a> -<p>The maximum fraction of the page allowed to be occupied by floats at -the bottom; default ‘<samp>.3</samp>’. -</p> -</dd> -<dt><code>\floatpagefraction</code> -<a name="index-_005cfloatpagefraction"></a> -</dt> -<dd><p>The minimum fraction of a float page that must be occupied by floats; -default ‘<samp>.5</samp>’. -</p> -</dd> -<dt><code>\textfraction</code> -<a name="index-_005ctextfraction"></a> -</dt> -<dd><p>Minimum fraction of a page that must be text; if floats take up too -much space to preserve this much text, floats will be moved to a -different page. The default is ‘<samp>.2</samp>’. +<p>or </p> -</dd> -<dt><code>\topfraction</code> -<a name="index-_005ctopfraction"></a> -</dt> -<dd><p>Maximum fraction at the top of a page that may be occupied before -floats; default ‘<samp>.7</samp>’. -</p></dd> -</dl> +<div class="example"> +<pre class="example">\begin{figure*}[<var>placement</var>] + figure body +\caption[<var>loftitle</var>]{<var>title</var>} +\label{<var>label}</var> +\end{figure*} +</pre></div> -<p>Parameters relating to vertical space around floats: -</p> -<dl compact="compact"> -<dt><code>\floatsep</code> -<a name="index-_005cfloatsep"></a> -</dt> -<dd><p>Space between floats at the top or bottom of a page; default -‘<samp>12pt plus2pt minus2pt</samp>’. +<p>A class of floats (see <a href="#Floats">Floats</a>). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are “floated” to a convenient place, such as the top of a following +page. </p> -</dd> -<dt><code>\intextsep</code> -<a name="index-_005cintextsep"></a> -</dt> -<dd><p>Space above and below a float in the middle of the main text; default -‘<samp>12pt plus2pt minus2pt</samp>’ for ‘<samp>10pt</samp>’ and ‘<samp>11pt</samp>’ styles, -‘<samp>14pt plus4pt minus4pt</samp>’ for ‘<samp>12pt</samp>’. +<p>For the possible values of <var>placement</var> and their effect on the +float placement algorithm, see <a href="#Floats">Floats</a>. </p> -</dd> -<dt><code>\textfloatsep</code> -<a name="index-_005ctextfloatsep"></a> -</dt> -<dd><p>Space between the last (first) float at the top (bottom) of a page; -default ‘<samp>20pt plus2pt minus4pt</samp>’. -</p></dd> -</dl> - -<p>Counters relating to the number of floats on a page: +<p>The starred form <code>figure*</code> is used when a document is in +double-column mode (see <a href="#g_t_005ctwocolumn">\twocolumn</a>). It produces a figure that +spans both columns, at the top of the page. To add the possibility of +placing at a page bottom see the discussion of <var>placement</var> <code>b</code> +in <a href="#Floats">Floats</a>. </p> -<dl compact="compact"> -<dt><code>bottomnumber</code> -<a name="index-bottomnumber"></a> -</dt> -<dd><p>Maximum number of floats that can appear at the bottom of a text page; -default 1. +<p>The figure body is typeset in a <code>parbox</code> of width <code>\textwidth</code> +and so it can contain text, commands, etc. </p> -</dd> -<dt><code>dbltopnumber</code> -<a name="index-dbltopnumber"></a> -</dt> -<dd><p>Maximum number of full-sized floats that can appear at the top of a -two-column page; default 2. +<p>The label is optional; it is used for cross-references (see <a href="#Cross-references">Cross references</a>). +<a name="index-_005ccaption"></a> +The optional <code>\caption</code> command specifies caption text for the +figure. By default it is numbered. If <var>loftitle</var> is present, it is +used in the list of figures instead of <var>title</var> (see <a href="#Tables-of-contents">Tables of contents</a>). </p> -</dd> -<dt><code>topnumber</code> -<a name="index-topnumber"></a> -</dt> -<dd><p>Maximum number of floats that can appear at the top of a text page; -default 2. +<p>This example makes a figure out of a graphic. It requires one of the +packages <samp>graphics</samp> or <samp>graphicx</samp>. The graphic, with its +caption, will be placed at the top of a page or, if it is pushed to the +end of the document, on a page of floats. </p> -</dd> -<dt><code>totalnumber</code> -<a name="index-totalnumber"></a> -</dt> -<dd><p>Maximum number of floats that can appear on a text page; default 3. -</p></dd> -</dl> +<div class="example"> +<pre class="example">\begin{figure}[t] + \centering + \includegraphics[width=0.5\textwidth]{CTANlion.png} + \caption{The CTAN lion, by Duane Bibby} +\end{figure} +</pre></div> -<p>The principal TeX FAQ entry relating to floats: -<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</a>. -</p> <hr> <a name="filecontents"></a> @@ -2644,59 +3383,69 @@ default 2. <p> Next: <a href="#flushleft" accesskey="n" rel="next">flushleft</a>, Previous: <a href="#figure" accesskey="p" rel="prev">figure</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="filecontents_003a-Create-external-files"></a> -<h3 class="section">8.11 <code>filecontents</code>: Create external files</h3> +<a name="filecontents_003a-Write-an-external-file"></a> +<h3 class="section">8.11 <code>filecontents</code>: Write an external file</h3> + <a name="index-filecontents"></a> -<a name="index-external-files_002c-creating"></a> +<a name="index-external-files_002c-writing"></a> <a name="index-writing-external-files"></a> <p>Synopsis: </p> <div class="example"> <pre class="example">\begin{filecontents}{<var>filename</var>} -<var>contents-of-file</var> + <var>text</var> \end{filecontents} -... -\documentclass{<var>my-document-class</var>} </pre></div> -<a name="index-initial-command"></a> -<a name="index-_005cdocumentclass_002c-commands-before"></a> -<p>The <code>filecontents</code> environment is an <em>initial command</em>, -meaning that it can be used only before the <code>\documentclass</code> -command, as in the synopsis above. +<p>or +</p> +<div class="example"> +<pre class="example">\begin{filecontents*}{<var>filename</var>} + <var>text</var> +\end{filecontents*} +</pre></div> + +<p>Create a file named <var>filename</var> and fill it with <var>text</var>. The +unstarred version of the environment <code>filecontents</code> prefixes the +content of the created file with a header; see the example below. The +starred version <code>filecontents*</code> does not include the header. </p> -<p>LaTeX will create a file named <var>filename</var> with the content -<var>contents-of-file</var> preceded by a header comment indicating how and -when the file was generated. If the file already exists then nothing will -happen. +<p>This environment can be used anywhere in the preamble, although it often +appears before the <code>\documentclass</code> command. It is typically used +when a source file requires a nonstandard style or class file. The +environment will write that file to the directory containing the source +and thus make the source file self-contained. Another use is to include +<code>bib</code> references in the file, again to make it self-contained. </p> -<p>You can also use the <code>filecontents</code> package, which has the -following advantages: +<p>The environment checks whether a file of that name already exists and if +so, does not do anything. There is a <samp>filecontents</samp> package that +redefines the <code>filecontents</code> environment so that instead of doing +nothing in that case, it will overwrite the existing file. </p> -<ul> -<li> If the file already exists, then it will be overwritten. - -</li><li> You can use the <code>filecontents</code> environment at any point after the -declaration <code>\usepackage{filecontents}</code>, not just before -<code>\documentclass</code>. - -</li><li> The <code>filecontents</code> package also provides a <code>filecontents*</code> -environment which is used in the same way as the <code>filecontents</code> -environment except that it won’t insert any leading comment, so it is -better suited to create files which aren’t in LaTeX format. - -</li></ul> - -<p>The <code>filecontents</code> environment only creates the file, and is -unrelated to using the created file. So you need to use, for -instance, <code>\input</code> or <code>\usepackage</code> or <code>\bibliography</code> -or whatever is applicable, to use the created file. +<p>For example, this document </p> -<p>This environment is also useful to make a document in a self-contained -file, for example, for a bug report, or to keep the content of a -<samp>.bib</samp> file in the same file as the main document. +<div class="example"> +<pre class="example">\documentclass{article} +\begin{filecontents}{JH.sty} +\newcommand{\myname}{Jim Hef{}feron} +\end{filecontents} +\usepackage{JH} +\begin{document} +Article by \myname. +\end{document} +</pre></div> + +<p>produces this file <samp>JH.sty</samp>. </p> +<div class="example"> +<pre class="example">%% LaTeX2e file `JH.sty' +%% generated by the `filecontents' environment +%% from source `test' on 2015/10/12. +%% +\newcommand{\myname}{Jim Hef{}feron} +</pre></div> + <hr> <a name="flushleft"></a> @@ -2706,6 +3455,7 @@ Next: <a href="#flushright" accesskey="n" rel="next">flushright</a>, Previous: < </div> <a name="flushleft-1"></a> <h3 class="section">8.12 <code>flushleft</code></h3> + <a name="index-flushleft-environment"></a> <a name="index-left_002djustifying-text_002c-environment-for"></a> <a name="index-ragged-right-text_002c-environment-for"></a> @@ -2721,7 +3471,7 @@ Next: <a href="#flushright" accesskey="n" rel="next">flushright</a>, Previous: < <a name="index-_005c_005c-for-flushleft"></a> <p>The <code>flushleft</code> environment allows you to create a paragraph consisting of lines that are flush to the left-hand margin and ragged -right Each line must be terminated with the string <code>\\</code>. +right. Each line must be terminated with the string <code>\\</code>. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005craggedright" accesskey="1">\raggedright</a>:</td><td> </td><td align="left" valign="top">Declaration form of the <code>flushleft</code> environment. @@ -2737,6 +3487,7 @@ Up: <a href="#flushleft" accesskey="u" rel="up">flushleft</a> [<a href="# </div> <a name="g_t_005craggedright-1"></a> <h4 class="subsection">8.12.1 <code>\raggedright</code></h4> + <a name="index-_005craggedright"></a> <a name="index-ragged-right-text"></a> <a name="index-left_002djustifying-text"></a> @@ -2761,6 +3512,7 @@ Next: <a href="#itemize" accesskey="n" rel="next">itemize</a>, Previous: <a href </div> <a name="flushright-1"></a> <h3 class="section">8.13 <code>flushright</code></h3> + <a name="index-flushright-environment"></a> <a name="index-ragged-left-text_002c-environment-for"></a> <a name="index-right_002djustifying-text_002c-environment-for"></a> @@ -2776,7 +3528,7 @@ Next: <a href="#itemize" accesskey="n" rel="next">itemize</a>, Previous: <a href <a name="index-_005c_005c-_0028for-flushright_0029"></a> <p>The <code>flushright</code> environment allows you to create a paragraph consisting of lines that are flush to the right-hand margin and ragged -left. Each line must be terminated with the string <code>\\</code>. +left. Each line must be terminated with the control sequence <code>\\</code>. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005craggedleft" accesskey="1">\raggedleft</a>:</td><td> </td><td align="left" valign="top">Declaration form of the <code>flushright</code> environment. @@ -2792,6 +3544,7 @@ Up: <a href="#flushright" accesskey="u" rel="up">flushright</a> [<a href= </div> <a name="g_t_005craggedleft-1"></a> <h4 class="subsection">8.13.1 <code>\raggedleft</code></h4> + <a name="index-_005craggedleft"></a> <a name="index-ragged-left-text"></a> <a name="index-justification_002c-ragged-left"></a> @@ -2816,8 +3569,9 @@ Next: <a href="#letter" accesskey="n" rel="next">letter</a>, Previous: <a href=" </div> <a name="itemize-1"></a> <h3 class="section">8.14 <code>itemize</code></h3> + <a name="index-itemize-environment"></a> -<a name="index-_005citem-2"></a> +<a name="index-_005citem-3"></a> <a name="index-lists-of-items"></a> <a name="index-unordered-lists"></a> <a name="index-bulleted-lists"></a> @@ -2987,7 +3741,8 @@ Next: <a href="#list" accesskey="n" rel="next">list</a>, Previous: <a href="#ite </div> <a name="letter-environment_003a-writing-letters"></a> <h3 class="section">8.15 <code>letter</code> environment: writing letters</h3> -<a name="index-letter"></a> + +<a name="index-letter-environment"></a> <p>This environment is used for creating letters. See <a href="#Letters">Letters</a>. </p> @@ -3000,6 +3755,7 @@ Next: <a href="#math" accesskey="n" rel="next">math</a>, Previous: <a href="#let </div> <a name="list-1"></a> <h3 class="section">8.16 <code>list</code></h3> + <a name="index-list"></a> <a name="index-lists-of-items_002c-generic"></a> @@ -3027,6 +3783,58 @@ empty, i.e., <code>{}</code>, which leaves the default spacing. <p>The width used for typesetting the list items is specified by <code>\linewidth</code> (see <a href="#Page-layout-parameters">Page layout parameters</a>). </p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="#g_t_005citem" accesskey="1">\item</a>:</td><td> </td><td align="left" valign="top">An entry in a list. +</td></tr> +</table> + + +<hr> +<a name="g_t_005citem"></a> +<div class="header"> +<p> +Up: <a href="#list" accesskey="u" rel="up">list</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<h4 class="node-heading">\item</h4> + +<p>Synopsis: +</p> +<div class="example"> +<pre class="example">\item text of item +</pre></div> + +<p>or +</p><div class="example"> +<pre class="example">\item[<var>optional label</var>] text of item +</pre></div> + +<p>An entry in a list. The entries are prefixed by a label, whose default +depends on the list type. +</p> +<p>Because the optional argument <var>optional label</var> is surrounded by +square brackets (<code>[</code> and <code>]</code>), to use square brackets +inside the optional argument you must hide them inside curly braces, as +in <code>\item[Close square bracket, {]}]</code>. Similarly, to use an open +square bracket as first character in the text of the item, also hide it +inside curly braces. See <a href="#LaTeX-command-syntax">LaTeX command syntax</a>. +</p> +<p>In this example the <code>enumerate</code> list has two items that use the +default label and one that uses the optional label. +</p> +<div class="example"> +<pre class="example">\begin{enumerate} + \item Moe + \item[sometimes] Shemp + \item Larry +\end{enumerate} +</pre></div> + +<p>The first item is labelled ‘<samp>1.</samp>’, the second item is labelled +‘<samp>sometimes</samp>’, and the third item is labelled ‘<samp>2.</samp>’ (note that, +because of the optional label in the second item, the third item does +not get a ‘<samp>3.</samp>’). +</p> + <hr> <a name="math"></a> @@ -3049,7 +3857,7 @@ Next: <a href="#minipage" accesskey="n" rel="next">minipage</a>, Previous: <a hr </pre></div> <p>The <code>math</code> environment inserts the given <var>math</var> within the -running text. <code>\(...\))</code> and <code>$...$</code> are synonyms. +running text. <code>\(...\)</code> and <code>$...$</code> are synonyms. See <a href="#Math-formulas">Math formulas</a>. </p> @@ -3102,7 +3910,7 @@ footnotes; they may wind up at the bottom of the wrong minipage. <a name="picture"></a> <div class="header"> <p> -Next: <a href="#quotation" accesskey="n" rel="next">quotation</a>, Previous: <a href="#minipage" accesskey="p" rel="prev">minipage</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#quotation-and-quote" accesskey="n" rel="next">quotation and quote</a>, Previous: <a href="#minipage" accesskey="p" rel="prev">minipage</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="picture-1"></a> <h3 class="section">8.19 <code>picture</code></h3> @@ -3112,7 +3920,7 @@ Next: <a href="#quotation" accesskey="n" rel="next">quotation</a>, Previous: <a <a name="index-pictures_002c-creating"></a> <div class="example"> -<pre class="example">\begin{picture}(width,height)(x offset,y offset) +<pre class="example">\begin{picture}(<var>width</var>,<var>height</var>)(<var>xoffset</var>,<var>yoffset</var>) … <var>picture commands</var> … \end{picture} </pre></div> @@ -3132,22 +3940,23 @@ centimeters. <code>\setlength</code> command, outside of a <code>picture</code> environment. The default value is <code>1pt</code>. </p> -<p>A position is a pair of coordinates, such as <code>(2.4,-5)</code>, specifying +<a name="index-position_002c-in-picture"></a> +<p>A <em>position</em> is a pair of coordinates, such as <code>(2.4,-5)</code>, specifying the point with x-coordinate <code>2.4</code> and y-coordinate <code>-5</code>. Coordinates are specified in the usual way with respect to an origin, which is normally at the lower-left corner of the picture. Note that when a position appears as an argument, it is not enclosed in braces; the parentheses serve to delimit the argument. </p> -<p>The <code>picture</code> environment has one mandatory argument, which is a -<code>position</code>. It specifies the size of the picture. The environment -produces a rectangular box with width and height determined by this -argument’s x- and y-coordinates. +<p>The <code>picture</code> environment has one mandatory argument which is a +position (<var>width</var>,<var>height</var>), which specifies the size of the +picture. The environment produces a rectangular box with these +<var>width</var> and <var>height</var>. </p> -<p>The <code>picture</code> environment also has an optional <code>position</code> -argument, following the <code>size</code> argument, that can change the -origin. (Unlike ordinary optional arguments, this argument is not -contained in square brackets.) The optional argument gives the +<p>The <code>picture</code> environment also has an optional position argument +(<var>xoffset</var>,<var>yoffset</var>), following the size argument, that can +change the origin. (Unlike ordinary optional arguments, this argument +is not contained in square brackets.) The optional argument gives the coordinates of the point at the lower-left corner of the picture (thereby determining the origin). For example, if <code>\unitlength</code> has been set to <code>1mm</code>, the command @@ -3229,10 +4038,12 @@ Next: <a href="#g_t_005cmakebox-_0028picture_0029" accesskey="n" rel="next">\mak </div> <a name="g_t_005ccircle-1"></a> <h4 class="subsection">8.19.1 <code>\circle</code></h4> + <a name="index-_005ccircle"></a> <p>Synopsis: -</p><div class="example"> +</p> +<div class="example"> <pre class="example">\circle[*]{<var>diameter</var>} </pre></div> @@ -3251,10 +4062,12 @@ Next: <a href="#g_t_005cframebox-_0028picture_0029" accesskey="n" rel="next">\fr </div> <a name="g_t_005cmakebox-1"></a> <h4 class="subsection">8.19.2 <code>\makebox</code></h4> + <a name="index-_005cmakebox-_0028for-picture_0029"></a> <p>Synopsis: -</p><div class="example"> +</p> +<div class="example"> <pre class="example">\makebox(<var>width</var>,<var>height</var>)[<var>position</var>]{<var>text</var>} </pre></div> @@ -3295,6 +4108,7 @@ Next: <a href="#g_t_005cdashbox" accesskey="n" rel="next">\dashbox</a>, Previous </div> <a name="g_t_005cframebox"></a> <h4 class="subsection">8.19.3 <code>\framebox</code></h4> + <a name="index-_005cframebox"></a> <p>Synopsis: @@ -3347,6 +4161,7 @@ Next: <a href="#g_t_005cline" accesskey="n" rel="next">\line</a>, Previous: <a h </div> <a name="g_t_005cframe-1"></a> <h4 class="subsection">8.19.5 <code>\frame</code></h4> + <a name="index-_005cframe"></a> <p>Synopsis: @@ -3368,6 +4183,7 @@ Next: <a href="#g_t_005clinethickness" accesskey="n" rel="next">\linethickness</ </div> <a name="g_t_005cline-1"></a> <h4 class="subsection">8.19.6 <code>\line</code></h4> + <a name="index-_005cline"></a> <p>Synopsis: @@ -3395,6 +4211,7 @@ Next: <a href="#g_t_005cthicklines" accesskey="n" rel="next">\thicklines</a>, Pr </div> <a name="g_t_005clinethickness-1"></a> <h4 class="subsection">8.19.7 <code>\linethickness</code></h4> + <a name="index-_005clinethickness"></a> <p>The <code>\linethickness{<var>dim</var>}</code> command declares the thickness @@ -3413,6 +4230,7 @@ Next: <a href="#g_t_005cthinlines" accesskey="n" rel="next">\thinlines</a>, Prev </div> <a name="g_t_005cthicklines-1"></a> <h4 class="subsection">8.19.8 <code>\thicklines</code></h4> + <a name="index-_005cthicklines"></a> <p>The <code>\thicklines</code> command is an alternate line thickness for @@ -3428,6 +4246,7 @@ Next: <a href="#g_t_005cmultiput" accesskey="n" rel="next">\multiput</a>, Previo </div> <a name="g_t_005cthinlines-1"></a> <h4 class="subsection">8.19.9 <code>\thinlines</code></h4> + <a name="index-_005cthinlines"></a> <p>The <code>\thinlines</code> command is the default line thickness for @@ -3443,10 +4262,12 @@ Next: <a href="#g_t_005coval" accesskey="n" rel="next">\oval</a>, Previous: <a h </div> <a name="g_t_005cmultiput-1"></a> <h4 class="subsection">8.19.10 <code>\multiput</code></h4> + <a name="index-_005cmultiput"></a> <p>Synopsis: -</p><div class="example"> +</p> +<div class="example"> <pre class="example">\multiput(<var>x</var>,<var>y</var>)(<var>delta_x</var>,<var>delta_y</var>){<var>n</var>}{<var>obj</var>} </pre></div> @@ -3464,6 +4285,7 @@ Next: <a href="#g_t_005cput" accesskey="n" rel="next">\put</a>, Previous: <a hre </div> <a name="g_t_005coval-1"></a> <h4 class="subsection">8.19.11 <code>\oval</code></h4> + <a name="index-_005coval"></a> <p>Synopsis: @@ -3472,25 +4294,28 @@ Next: <a href="#g_t_005cput" accesskey="n" rel="next">\put</a>, Previous: <a hre <pre class="example">\oval(<var>width</var>,<var>height</var>)[<var>portion</var>] </pre></div> -<p>The <code>\oval</code> command produces a rectangle with rounded corners. -The optional argument <var>portion</var> allows you to select part of the +<p>The <code>\oval</code> command produces a rectangle with rounded corners. The +optional argument <var>portion</var> allows you to produce only half of the oval via the following: </p> <dl compact="compact"> <dt><code>t</code></dt> -<dd><p>selects the top portion; +<dd><p>selects the top half; </p></dd> <dt><code>b</code></dt> -<dd><p>selects the bottom portion; +<dd><p>selects the bottom half; </p></dd> <dt><code>r</code></dt> -<dd><p>selects the right portion; +<dd><p>selects the right half; </p></dd> <dt><code>l</code></dt> -<dd><p>selects the left portion. +<dd><p>selects the left half. </p></dd> </dl> +<p>It is also possible to produce only one quarter of the oval by setting +<var>portion</var> to <code>tr</code>, <code>br</code>, <code>bl</code>, or <code>tl</code>. +</p> <p>The “corners” of the oval are made with quarter circles with a maximum radius of 20pt, so large “ovals” will look more like boxes with rounded corners. @@ -3504,6 +4329,7 @@ Next: <a href="#g_t_005cshortstack" accesskey="n" rel="next">\shortstack</a>, Pr </div> <a name="g_t_005cput-1"></a> <h4 class="subsection">8.19.12 <code>\put</code></h4> + <a name="index-_005cput"></a> <p>Synopsis: @@ -3525,6 +4351,7 @@ Next: <a href="#g_t_005cvector" accesskey="n" rel="next">\vector</a>, Previous: </div> <a name="g_t_005cshortstack-1"></a> <h4 class="subsection">8.19.13 <code>\shortstack</code></h4> + <a name="index-_005cshortstack"></a> <p>Synopsis: @@ -3560,6 +4387,7 @@ Previous: <a href="#g_t_005cshortstack" accesskey="p" rel="prev">\shortstack</a> </div> <a name="g_t_005cvector-1"></a> <h4 class="subsection">8.19.14 <code>\vector</code></h4> + <a name="index-_005cvector"></a> <p>Synopsis: @@ -3574,18 +4402,22 @@ values must lie between -4 and +4, inclusive. </p> <hr> -<a name="quotation"></a> +<a name="quotation-and-quote"></a> <div class="header"> <p> -Next: <a href="#quote" accesskey="n" rel="next">quote</a>, Previous: <a href="#picture" accesskey="p" rel="prev">picture</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#tabbing" accesskey="n" rel="next">tabbing</a>, Previous: <a href="#picture" accesskey="p" rel="prev">picture</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="quotation-1"></a> -<h3 class="section">8.20 <code>quotation</code></h3> +<a name="quotation-and-quote-1"></a> +<h3 class="section">8.20 <code>quotation</code> and <code>quote</code></h3> <a name="index-quotation"></a> <a name="index-quoted-text-with-paragraph-indentation_002c-displaying"></a> <a name="index-displaying-quoted-text-with-paragraph-indentation"></a> <a name="index-paragraph-indentations-in-quoted-text"></a> +<a name="index-quote"></a> +<a name="index-quoted-text-without-paragraph-indentation_002c-displaying"></a> +<a name="index-displaying-quoted-text-without-paragraph-indentation"></a> +<a name="index-paragraph-indentations-in-quoted-text_002c-omitting"></a> <p>Synopsis: </p> @@ -3595,29 +4427,7 @@ Next: <a href="#quote" accesskey="n" rel="next">quote</a>, Previous: <a href="#p \end{quotation} </pre></div> -<p>The margins of the <code>quotation</code> environment are indented on both -the left and the right. The text is justified at both margins. -Leaving a blank line between text produces a new paragraph. -</p> -<p>Unlike the <code>quote</code> environment, each paragraph is indented -normally. -</p> - -<hr> -<a name="quote"></a> -<div class="header"> -<p> -Next: <a href="#tabbing" accesskey="n" rel="next">tabbing</a>, Previous: <a href="#quotation" accesskey="p" rel="prev">quotation</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> -</div> -<a name="quote-1"></a> -<h3 class="section">8.21 <code>quote</code></h3> - -<a name="index-quote"></a> -<a name="index-quoted-text-without-paragraph-indentation_002c-displaying"></a> -<a name="index-displaying-quoted-text-without-paragraph-indentation"></a> -<a name="index-paragraph-indentations-in-quoted-text_002c-omitting"></a> - -<p>Synopsis: +<p>or </p> <div class="example"> <pre class="example">\begin{quote} @@ -3625,21 +4435,39 @@ Next: <a href="#tabbing" accesskey="n" rel="next">tabbing</a>, Previous: <a href \end{quote} </pre></div> -<p>The margins of the <code>quote</code> environment are indented on both the -left and the right. The text is justified at both margins. Leaving a -blank line between text produces a new paragraph. +<p>Include a quotation. </p> -<p>Unlike the <code>quotation</code> environment, paragraphs are not indented. +<p>In both environments, margins are indented on both sides by +<code>\leftmargin</code> and the text is justified at both. As with the main +text, leaving a blank line produces a new paragraph. </p> +<p>To compare the two: in the <code>quotation</code> environment, paragraphs are +indented by 1.5em and the space between paragraphs is small, +<code>0pt plus 1pt</code>. In the <code>quote</code> environment, paragraphs are +not indented and there is vertical space between paragraphs (it is the +rubber length <code>\parsep</code>). Thus, the <code>quotation</code> environment +may be more suitable for documents where new paragraphs are marked by an +indent rather than by a vertical separation. In addition, <code>quote</code> +may be more suitable for a short quotation or a sequence of short +quotations. +</p> +<div class="example"> +<pre class="example">\begin{quotation} +\it Four score and seven years ago + .. shall not perish from the earth. +\hspace{1em plus 1fill}---Abraham Lincoln +\end{quotation} +</pre></div> + <hr> <a name="tabbing"></a> <div class="header"> <p> -Next: <a href="#table" accesskey="n" rel="next">table</a>, Previous: <a href="#quote" accesskey="p" rel="prev">quote</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#table" accesskey="n" rel="next">table</a>, Previous: <a href="#quotation-and-quote" accesskey="p" rel="prev">quotation and quote</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="tabbing-1"></a> -<h3 class="section">8.22 <code>tabbing</code></h3> +<h3 class="section">8.21 <code>tabbing</code></h3> <a name="index-tabbing-environment"></a> <a name="index-tab-stops_002c-using"></a> @@ -3713,7 +4541,7 @@ necessary. <a name="index-_005c_0027-_0028tabbing_0029"></a> </dt> <dd><p>Moves everything that you have typed so far in the -current column, i.e. everything from the most recent <code>\></code>, +current column, i.e., everything from the most recent <code>\></code>, <code>\<</code>, <code>\'</code>, <code>\\</code>, or <code>\kill</code> command, to the right of the previous column, flush against the current column’s tab stop. </p> @@ -3794,7 +4622,7 @@ function \= fact(n : integer) : integer;\\ Next: <a href="#tabular" accesskey="n" rel="next">tabular</a>, Previous: <a href="#tabbing" accesskey="p" rel="prev">tabbing</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="table-1"></a> -<h3 class="section">8.23 <code>table</code></h3> +<h3 class="section">8.22 <code>table</code></h3> <a name="index-table"></a> <a name="index-tables_002c-creating"></a> @@ -3803,29 +4631,46 @@ Next: <a href="#tabular" accesskey="n" rel="next">tabular</a>, Previous: <a href <p>Synopsis: </p> <div class="example"> -<pre class="example"> \begin{table}[placement] - - body of the table - - \caption{table title} - \end{table} +<pre class="example">\begin{table}[<var>placement</var>] + table body +\caption[<var>loftitle</var>]{<var>title</var>} +\label{<var>label}</var> +\end{table} </pre></div> -<p>Tables are objects that are not part of the normal text, and are -usually “floated” to a convenient place, like the top of a page. -Tables will not be split between two pages. +<p>A class of floats (see <a href="#Floats">Floats</a>). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are “floated” to a convenient place, such as the top of a following +page. +</p> +<p>For the possible values of <var>placement</var> and their effect on the +float placement algorithm, see <a href="#Floats">Floats</a>. </p> -<p>The optional argument <code>[placement]</code> determines where LaTeX will try -to place your table. There are four places where LaTeX can possibly put -a float; these are the same as that used with the <code>figure</code> -environment, and described there (see <a href="#figure">figure</a>). +<p>The table body is typeset in a <code>parbox</code> of width <code>\textwidth</code> +and so it can contain text, commands, etc. </p> -<p>The standard <code>report</code> and <code>article</code> classes use the default -placement <code>[tbp]</code>. +<p>The label is optional; it is used for cross-references (see <a href="#Cross-references">Cross references</a>). +<a name="index-_005ccaption-1"></a> +The optional <code>\caption</code> command specifies caption text for the +table. By default it is numbered. If <var>lottitle</var> is present, it is +used in the list of tables instead of <var>title</var> (see <a href="#Tables-of-contents">Tables of contents</a>). </p> -<p>The body of the table is made up of whatever text, LaTeX commands, etc., -you wish. The <code>\caption</code> command allows you to title your table. +<p>In this example the table and caption will float to the bottom of a page, +unless it is pushed to a float page at the end. </p> +<div class="example"> +<pre class="example">\begin{table}[b] + \centering + \begin{tabular}{r|p{2in}} \hline + One &The loneliest number \\ + Two &Can be as sad as one. + It's the loneliest number since the number one. + \end{tabular} + \caption{Cardinal virtues} + \label{tab:CardinalVirtues} +\end{table} +</pre></div> + <hr> <a name="tabular"></a> @@ -3834,7 +4679,8 @@ you wish. The <code>\caption</code> command allows you to title your table. Next: <a href="#thebibliography" accesskey="n" rel="next">thebibliography</a>, Previous: <a href="#table" accesskey="p" rel="prev">table</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="tabular-1"></a> -<h3 class="section">8.24 <code>tabular</code></h3> +<h3 class="section">8.23 <code>tabular</code></h3> + <a name="index-tabular-environment"></a> <a name="index-lines-in-tables"></a> <a name="index-lining-text-up-in-tables"></a> @@ -3842,57 +4688,72 @@ Next: <a href="#thebibliography" accesskey="n" rel="next">thebibliography</a>, P <p>Synopsis: </p> <div class="example"> -<pre class="example">\begin{tabular}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ -... +<pre class="example">\begin{tabular}[<var>pos</var>]{<var>cols</var>} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular} </pre></div> <p>or </p> <div class="example"> -<pre class="example">\begin{tabular*}{width}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ -... +<pre class="example">\begin{tabular*}{<var>width</var>}[<var>pos</var>]{<var>cols</var>} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular*} </pre></div> -<p>These environments produce a box consisting of a sequence of rows of -items, aligned vertically in columns. +<p>These environments produce a table, a box consisting of a sequence of +horizontal rows. Each row consists of items that are aligned vertically +in columns. This illustrates many of the features. </p> +<div class="example"> +<pre class="example">\begin{tabular}{l|l} + \textit{Player name} &\textit{Career home runs} \\ + \hline + Hank Aaron &755 \\ + Babe Ruth &714 +\end{tabular} +</pre></div> + +<p>The vertical format of two left-aligned columns, with a vertical bar +between them, is specified in <code>tabular</code>’s argument <code>{l|l}</code>. +<a name="index-_0026"></a> +Columns are separated with an ampersand <code>&</code>. A horizontal rule +between two rows is created with <code>\hline</code>. <a name="index-_005c_005c-for-tabular"></a> -<p><code>\\</code> must be used to specify the end of each row of the table, -except for the last, where it is optional—unless an <code>\hline</code> -command (to put a rule below the table) follows. +The end of each row is marked with a double backslash <code>\\</code>. +This <code>\\</code> is optional after the last row unless an <code>\hline</code> +command follows, to put a rule below the table. </p> -<p>The mandatory and optional arguments consist of: +<p>The required and optional arguments to <code>tabular</code> consist of: </p> <dl compact="compact"> -<dt><code>width</code></dt> -<dd><p>Specifies the width of the <code>tabular*</code> environment. There must be -rubber space between columns that can stretch to fill out the specified -width. +<dt><var>width</var></dt> +<dd><p>Required for <code>tabular*</code>, not allowed for <code>tabular</code>. Specifies +the width of the <code>tabular*</code> environment. The space between columns +should be rubber, as with <code>@{\extracolsep{\fill}}</code>, to allow +the table to stretch or shrink to make the specified width, or else you +are likely to get the <code>Underfull \hbox (badness 10000) in alignment +..</code> warning. </p> </dd> -<dt><code>pos</code></dt> -<dd><p>Specifies the vertical position; default is alignment on the centre of -the environment. +<dt><var>pos</var></dt> +<dd><p>Optional. Specifies the table’s vertical position. The default is to +align the table so its vertical center matches the baseline of the +surrounding text. There are two other possible alignments: <code>t</code> +aligns the table so its top row matches the baseline of the surrounding +text, and <code>b</code> aligns on the bottom row. </p> -<dl compact="compact"> -<dt><code>t</code></dt> -<dd><p>align on top row +<p>This only has an effect if there is other text. In the common case of a +<code>tabular</code> alone in a <code>center</code> environment this option makes +no difference. </p> </dd> -<dt><code>b</code></dt> -<dd><p>align on bottom row -</p></dd> -</dl> - -</dd> -<dt><code>cols</code></dt> -<dd><p>Specifies the column formatting. It consists of a sequence of the -following specifiers, corresponding to the sequence of columns and -intercolumn material. +<dt><var>cols</var></dt> +<dd><p>Required. Specifies the formatting of columns. It consists of a +sequence of the following specifiers, corresponding to the types of +column and intercolumn material. </p> <dl compact="compact"> <dt><code>l</code></dt> @@ -3911,44 +4772,89 @@ intercolumn material. <dd><p>A vertical line the full height and depth of the environment. </p> </dd> -<dt><code>@{<var>text</var>}</code></dt> -<dd><p>This inserts <var>text</var> in every row. An @-expression suppresses the -intercolumn space normally inserted between columns; any desired space -before the adjacent item must be included in <var>text</var>. +<dt><code>@{<var>text or space</var>}</code></dt> +<dd><p>This inserts <var>text or space</var> at this location in every row. The +<var>text or space</var> material is typeset in LR mode. This text is +fragile (see <a href="#g_t_005cprotect">\protect</a>). </p> -<p>To insert commands that are automatically executed before a given -column, you have to load the <code>array</code> package and use the -<code>>{...}</code> specifier. +<p>This specifier is optional: unless you put in your own @-expression +then LaTeX’s book, article, and report classes will put on either +side of each column a space of length <code>\tabcolsep</code>, which by +default is ‘<samp>6pt</samp>’. That is, by default adjacent columns are +separated by 12pt (so <code>\tabcolsep</code> is misleadingly-named since it +is not the separation between tabular columns). Also by default a space +of 6pt comes before the first column as well as after the final column, +unless you put a <code>@{..}</code> or <code>|</code> there. +</p> +<p>If you override the default and use an @-expression then you must +insert any desired space yourself, as in <code>@{\hspace{1em}}</code>. +</p> +<p>An empty expression <code>@{}</code> will eliminate the space, including +the space at the start or end, as in the example below where the tabular +lines need to lie on the left margin. +</p> +<div class="example"> +<pre class="example">\begin{flushleft} + \begin{tabular}{@{}l} + .. + \end{tabular} +\end{flushleft} +</pre></div> + +<p>This example shows text, a decimal point, between the columns, arranged +so the numbers in the table are aligned on that decimal point. </p> +<div class="example"> +<pre class="example">\begin{tabular}{r@{$.$}l} + $3$ &$14$ \\ + $9$ &$80665$ +\end{tabular} +</pre></div> + <a name="index-_005cextracolsep"></a> -<p>An <code>\extracolsep{wd}</code> command in an @-expression causes an -extra space of width <code>wd</code> to appear to the left of all subsequent +<p>An <code>\extracolsep{<var>wd</var>}</code> command in an @-expression causes an +extra space of width <var>wd</var> to appear to the left of all subsequent columns, until countermanded by another <code>\extracolsep</code> command. -Unlike ordinary intercolumn space, this extra space is not suppressed -by an @-expression. An <code>\extracolsep</code> command can be used only -in an @-expression in the <code>cols</code> argument. +Unlike ordinary intercolumn space, this extra space is not suppressed by +an @-expression. An <code>\extracolsep</code> command can be used only in an +@-expression in the <code>cols</code> argument. Below, LaTeX inserts the +right amount of intercolumn space to make the entire table 4 inches +wide. +</p> +<div class="example"> +<pre class="example">\begin{center} + \begin{tabular*}{4in}{l@{\ \ldots\extracolsep{\fill}}l} + Seven times down, eight times up + &such is life! + \end{tabular*} +\end{center} +</pre></div> + +<p>To insert commands that are automatically executed before a given +column, load the <code>array</code> package and use the <code>>{...}</code> +specifier. </p> </dd> <dt><code>p{<var>wd</var>}</code></dt> -<dd><p>Produces a column with each item typeset in a parbox of width -<var>wd</var>, as if it were the argument of a -<code>\parbox[t]{<var>wd</var>}</code> command. However, a <code>\\</code> may not -appear in the item, except in the following situations: +<dd><p>Each item in the column is typeset in a parbox of width <var>wd</var>. +</p> +<p>Note that a line break double backslash <code>\\</code> may not appear in the +item, except inside an environment like <code>minipage</code>, <code>array</code>, +or <code>tabular</code>, or inside an explicit <code>\parbox</code>, or in the scope +of a <code>\centering</code>, <code>\raggedright</code>, or <code>\raggedleft</code> +declaration (when used in a <code>p</code>-column element these declarations +must appear inside braces, as with <code>{\centering .. \\ +..}</code>). Otherwise LaTeX will misinterpret the double backslash as +ending the row. </p> -<ol> -<li> inside an environment like <code>minipage</code>, <code>array</code>, or <code>tabular</code>. -</li><li> inside an explicit <code>\parbox</code>. -</li><li> in the scope of a <code>\centering</code>, <code>\raggedright</code>, or <code>\raggedleft</code> -declaration. The latter declarations must appear inside braces or an -environment when used in a <code>p</code>-column element. -</li></ol> - </dd> <dt><code>*{<var>num</var>}{<var>cols</var>}</code></dt> <dd><p>Equivalent to <var>num</var> copies of <var>cols</var>, where <var>num</var> is a -positive integer and <var>cols</var> is any list of column-specifiers, -which may contain another <code>*-expression</code>. -</p> +positive integer and <var>cols</var> is a list of specifiers. Thus +<code>\begin{tabular}{|*{3}{l|r}|}</code> is equivalent to +<code>\begin{tabular}{|l|rl|rl|r|}</code>. Note that <var>cols</var> may +contain another <code>*-expression</code>. +</p> </dd> </dl> </dd> @@ -3960,44 +4866,48 @@ which may contain another <code>*-expression</code>. <dt><code>\arrayrulewidth</code> <a name="index-_005carrayrulewidth"></a> </dt> -<dd><p>Thickness of the rule created by <code>|</code>, <code>\hline</code>, and -<code>\vline</code> in the <code>tabular</code> and <code>array</code> environments; the -default is ‘<samp>.4pt</samp>’. +<dd><p>A length that is the thickness of the rule created by <code>|</code>, +<code>\hline</code>, and <code>\vline</code> in the <code>tabular</code> and <code>array</code> +environments. The default is ‘<samp>.4pt</samp>’. Change it as in +<code>\setlength{\arrayrulewidth}{0.8pt}</code>. </p> </dd> <dt><code>\arraystretch</code> <a name="index-_005carraystretch"></a> </dt> -<dd><p>Scaling of spacing between rows in the <code>tabular</code> and <code>array</code> -environments; default is ‘<samp>1</samp>’, for no scaling. +<dd><p>A factor by which the spacing between rows in the <code>tabular</code> and +<code>array</code> environments is multiplied. The default is ‘<samp>1</samp>’, for +no scaling. Change it as <code>\renewcommand{\arraystretch}{1.2}</code>. </p> </dd> <dt><code>\doublerulesep</code> <a name="index-_005cdoublerulesep"></a> </dt> -<dd><p>Horizontal distance between the vertical rules produced by <code>||</code> -in the <code>tabular</code> and <code>array</code> environments; default is ‘<samp>2pt</samp>’. +<dd><p>A length that is the distance between the vertical rules produced by the +<code>||</code> specifier. The default is ‘<samp>2pt</samp>’. </p> </dd> <dt><code>\tabcolsep</code> <a name="index-_005ctabcolsep"></a> </dt> -<dd><p>Half the width of the space between columns; default is ‘<samp>6pt</samp>’. +<dd><p>A length that is half of the space between columns. The default is +‘<samp>6pt</samp>’. Change it with <code>\setlength</code>. </p> </dd> </dl> -<p>The following commands can be used inside a <code>tabular</code> -environment: +<p>The following commands can be used inside the body of a <code>tabular</code> +environment, the first two inside an entry and the second two between +lines: </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005cmulticolumn" accesskey="1">\multicolumn</a>:</td><td> </td><td align="left" valign="top">Make an item spanning several columns. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005ccline" accesskey="2">\cline</a>:</td><td> </td><td align="left" valign="top">Draw a horizontal line spanning some columns. +<tr><td align="left" valign="top">• <a href="#g_t_005cvline" accesskey="2">\vline</a>:</td><td> </td><td align="left" valign="top">Draw a vertical line. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005chline" accesskey="3">\hline</a>:</td><td> </td><td align="left" valign="top">Draw a horizontal line spanning all columns. +<tr><td align="left" valign="top">• <a href="#g_t_005ccline" accesskey="3">\cline</a>:</td><td> </td><td align="left" valign="top">Draw a horizontal line spanning some columns. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cvline" accesskey="4">\vline</a>:</td><td> </td><td align="left" valign="top">Draw a vertical line. +<tr><td align="left" valign="top">• <a href="#g_t_005chline" accesskey="4">\hline</a>:</td><td> </td><td align="left" valign="top">Draw a horizontal line spanning all columns. </td></tr> </table> @@ -4006,33 +4916,137 @@ environment: <a name="g_t_005cmulticolumn"></a> <div class="header"> <p> -Next: <a href="#g_t_005ccline" accesskey="n" rel="next">\cline</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005cvline" accesskey="n" rel="next">\vline</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cmulticolumn-1"></a> -<h4 class="subsection">8.24.1 <code>\multicolumn</code></h4> +<h4 class="subsection">8.23.1 <code>\multicolumn</code></h4> + <a name="index-_005cmulticolumn"></a> <p>Synopsis: -</p><div class="example"> -<pre class="example">\multicolumn{<var>cols</var>}{<var>pos</var>}{<var>text</var>} +</p> +<div class="example"> +<pre class="example">\multicolumn{<var>numcols</var>}{<var>cols</var>}{<var>text</var>} +</pre></div> + +<p>Make an <code>array</code> or <code>tabular</code> entry that spans several columns. +The first argument <var>numcols</var> gives the number of columns to span. +The second argument <var>cols</var> specifies the formatting of the entry, +with <code>c</code> for centered, <code>l</code> for flush left, or <code>r</code> for +flush right. The third argument <var>text</var> gives the contents of that +entry. +</p> +<p>In this example, in the first row, the second and third columns are +spanned by the single heading ‘<samp>Name</samp>’. +</p> +<div class="example"> +<pre class="example">\begin{tabular}{lccl} + \textit{ID} &\multicolumn{2}{c}{\textit{Name}} &\textit{Age} \\ \hline % row one + 978-0-393-03701-2 &O'Brian &Patrick &55 \\ % row two + .. +\end{tabular} +</pre></div> + +<p>What counts as a column is: the column format specifier for the +<code>array</code> or <code>tabular</code> environment is broken into parts, where +each part (except the first) begins with <code>l</code>, <code>c</code>, <code>r</code>, +or <code>p</code>. So from <code>\begin{tabular}{|r|ccp{1.5in}|}</code> +the parts are <code>|r|</code>, <code>c</code>, <code>c</code>, +and <code>p{1.5in}|</code>. +</p> +<p>The <var>cols</var> argument overrides the <code>array</code> or <code>tabular</code> +environment’s intercolumn area default adjoining this multicolumn +entry. To affect that area, this argument can contain vertical bars +<code>|</code> indicating the placement of vertical rules, and <code>@{..}</code> +expressions. Thus if <var>cols</var> is ‘<samp>|c|</samp>’ then this multicolumn +entry will be centered and a vertical rule will come in the intercolumn +area before it and after it. This table details the exact behavior. +</p> +<div class="example"> +<pre class="example">\begin{tabular}{|cc|c|c|} + \multicolumn{1}{r}{w} % entry one + &\multicolumn{1}{|r|}{x} % entry two + &\multicolumn{1}{|r}{y} % entry three + &z % entry four +\end{tabular} +</pre></div> +<p>Before the first entry the output will not have a vertical rule because +the <code>\multicolumn</code> has the <var>cols</var> specifier ‘<samp>r</samp>’ with no +initial vertical bar. Between entry one and entry two there will be a +vertical rule; although the first <var>cols</var> does not have an ending +vertical bar, the second <var>cols</var> does have a starting one. Between +entry two and entry three there is a single vertical rule; despite that +the <var>cols</var> in both of the surrounding <code>multicolumn</code>’s call for +a vertical rule, you only get one rule. Between entry three and entry +four there is no vertical rule; the default calls for one but the +<var>cols</var> in the entry three <code>\multicolumn</code> leaves it out, and +that takes precedence. Finally, following entry four there is a +vertical rule because of the default. +</p> +<p>The number of spanned columns <var>numcols</var> can be 1. Besides giving +the ability to change the horizontal alignment, this also is useful to +override for one row the <code>tabular</code> definition’s default intercolumn +area specification, including the placement of vertical rules. +</p> +<p>In the example below, in the <code>tabular</code> definition the first column +is specified to default to left justified but in the first row the entry +is centered with <code>\multicolumn{1}{c}{\textsc{Period}}</code>. +Also in the first row, the second and third columns are spanned by a +single entry with <code>\multicolumn{2}{c}{\textsc{Span}}</code>, +overriding the specification to center those two columns on the page +range en-dash. +</p> +<div class="example"> +<pre class="example">\begin{tabular}{l|r@{--}l} + \multicolumn{1}{c}{\textsc{Period}} + &multicolumn{2}{c}{\textsc{Span}} \\ \hline + Baroque &1600 &1760 \\ + Classical &1730 &1820 \\ + Romantic &1780 &1910 \\ + Impressionistic &1875 &1925 +\end{tabular} </pre></div> -<p>The <code>\multicolumn</code> command makes an entry that spans several -columns. The first mandatory argument, <var>cols</var>, specifies the -number of columns to span. The second mandatory argument, <var>pos</var>, -specifies the formatting of the entry; <code>c</code> for centered, <code>l</code> -for flushleft, <code>r</code> for flushright. The third mandatory argument, -<var>text</var>, specifies what text to put in the entry. +<p>Note that although the <code>tabular</code> specification by default puts a +vertical rule between the first and second columns, because there is no +vertical bar in the <var>cols</var> of either of the first row’s +<code>\multicolumn</code> commands, no rule appears in the first row. </p> -<p>Here’s an example showing two columns separated by an en-dash; -<code>\multicolumn</code> is used for the heading: + +<hr> +<a name="g_t_005cvline"></a> +<div class="header"> +<p> +Next: <a href="#g_t_005ccline" accesskey="n" rel="next">\cline</a>, Previous: <a href="#g_t_005cmulticolumn" accesskey="p" rel="prev">\multicolumn</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="g_t_005cvline-1"></a> +<h4 class="subsection">8.23.2 <code>\vline</code></h4> + +<a name="index-_005cvline"></a> + +<p>Draw a vertical line in a <code>tabular</code> or <code>array</code> environment +extending the full height and depth of an entry’s row. Can also be used +in an @-expression, although its synonym vertical bar <code>|</code> is +more common. This command is rarely used; typically a table’s vertical +lines are specified in <code>tabular</code>’s <var>cols</var> argument and +overriden as needed with <code>\multicolumn</code>. +</p> +<p>This example illustrates some pitfalls. In the first line’s second +entry the <code>\hfill</code> moves the <code>\vline</code> to the left edge of the +cell. But that is different than putting it halfway between the two +columns, so in that row between the first and second columns there are +two vertical rules, with the one from the <code>{c|cc}</code> specifier +coming before the one produced by the <code>\vline\hfill</code>. In contrast, +the first line’s third entry shows the usual way to put a vertical bar +between two columns. In the second line, the <code>ghi</code> is the widest +entry in its column so in the <code>\vline\hfill</code> the <code>\hfill</code> has +no effect and the vertical line in that entry appears immediately next +to the <code>g</code>, with no whitespace. </p> <div class="example"> -<pre class="example">\begin{tabular}{r@{--}l} -\multicolumn{2}{c}{\bf Unicode}\cr - 0x80&0x7FF \cr - 0x800&0xFFFF \cr -0x10000&0x1FFFF \cr +<pre class="example">\begin{tabular}{c|cc} + x &\vline\hfill y &\multicolumn{1}{|r}{z} \\ + abc &def &\vline\hfill ghi \end{tabular} </pre></div> @@ -4041,10 +5055,11 @@ for flushleft, <code>r</code> for flushright. The third mandatory argument, <a name="g_t_005ccline"></a> <div class="header"> <p> -Next: <a href="#g_t_005chline" accesskey="n" rel="next">\hline</a>, Previous: <a href="#g_t_005cmulticolumn" accesskey="p" rel="prev">\multicolumn</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005chline" accesskey="n" rel="next">\hline</a>, Previous: <a href="#g_t_005cvline" accesskey="p" rel="prev">\vline</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005ccline-1"></a> -<h4 class="subsection">8.24.2 <code>\cline</code></h4> +<h4 class="subsection">8.23.3 <code>\cline</code></h4> + <a name="index-_005ccline"></a> <p>Synopsis: @@ -4053,42 +5068,52 @@ Next: <a href="#g_t_005chline" accesskey="n" rel="next">\hline</a>, Previous: <a <pre class="example">\cline{<var>i</var>-<var>j</var>} </pre></div> -<p>The <code>\cline</code> command draws horizontal lines across the columns -specified, beginning in column <var>i</var> and ending in column <var>j</var>, -which are specified in the mandatory argument. +<p>Draw a horizontal rule in an <code>array</code> or <code>tabular</code> environment +beginning in column <var>i</var> and ending in column <var>j</var>. The +dash <code>-</code> must appear in the mandatory argument. To span a +single column use the number twice. +</p> +<p>This example puts two horizontal lines between the first and second +rows, one line in the first column only, and the other spanning the +third and fourth columns. The two lines are side-by-side, at the same +height. </p> +<div class="example"> +<pre class="example">\begin{tabular}{llrr} + a &b &c &d \\ \cline{1-1} \cline{3-4} + e &f &g &h +\end{tabular} +</pre></div> + <hr> <a name="g_t_005chline"></a> <div class="header"> <p> -Next: <a href="#g_t_005cvline" accesskey="n" rel="next">\vline</a>, Previous: <a href="#g_t_005ccline" accesskey="p" rel="prev">\cline</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Previous: <a href="#g_t_005ccline" accesskey="p" rel="prev">\cline</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005chline-1"></a> -<h4 class="subsection">8.24.3 <code>\hline</code></h4> +<h4 class="subsection">8.23.4 <code>\hline</code></h4> + <a name="index-_005chline"></a> -<p>The <code>\hline</code> command draws a horizontal line the width of the -enclosing <code>tabular</code> or <code>array</code> environment. It’s most -commonly used to draw a line at the top, bottom, and between the rows -of a table. +<p>Draws a horizontal line the width of the enclosing <code>tabular</code> or +<code>array</code> environment. It’s most commonly used to draw a line at the +top, bottom, and between the rows of a table. </p> - -<hr> -<a name="g_t_005cvline"></a> -<div class="header"> -<p> -Previous: <a href="#g_t_005chline" accesskey="p" rel="prev">\hline</a>, Up: <a href="#tabular" accesskey="u" rel="up">tabular</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> -</div> -<a name="g_t_005cvline-1"></a> -<h4 class="subsection">8.24.4 <code>\vline</code></h4> -<a name="index-_005cvline"></a> - -<p>The <code>\vline</code> command will draw a vertical line extending the full -height and depth of its row. An <code>\hfill</code> command can be used to -move the line to the edge of the column. It can also be used in an -@-expression. +<p>In this example the top of the table has two horizontal rules, one above +the other, that span both columns. The bottom of the table has a single +rule spanning both columns. Because of the <code>\hline</code>, the +<code>tabular</code> second row’s line ending double backslash <code>\\</code> +is required. </p> +<div class="example"> +<pre class="example">\begin{tabular}{ll} \hline\hline + Baseball &Red Sox \\ + Basketball &Celtics \\ \hline +\end{tabular} +</pre></div> + <hr> <a name="thebibliography"></a> @@ -4097,9 +5122,9 @@ move the line to the edge of the column. It can also be used in an Next: <a href="#theorem" accesskey="n" rel="next">theorem</a>, Previous: <a href="#tabular" accesskey="p" rel="prev">tabular</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="thebibliography-1"></a> -<h3 class="section">8.25 <code>thebibliography</code></h3> +<h3 class="section">8.24 <code>thebibliography</code></h3> -<a name="index-thebibliography"></a> +<a name="index-thebibliography-environment"></a> <a name="index-bibliography_002c-creating-_0028manually_0029"></a> <p>Synopsis: @@ -4148,12 +5173,13 @@ less than 10 references, <code>99</code> for ones with less than 100, etc. Next: <a href="#g_t_005ccite" accesskey="n" rel="next">\cite</a>, Up: <a href="#thebibliography" accesskey="u" rel="up">thebibliography</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cbibitem-1"></a> -<h4 class="subsection">8.25.1 <code>\bibitem</code></h4> +<h4 class="subsection">8.24.1 <code>\bibitem</code></h4> <a name="index-_005cbibitem"></a> <p>Synopsis: -</p><div class="example"> +</p> +<div class="example"> <pre class="example">\bibitem[<var>label</var>]{<var>cite_key</var>} </pre></div> @@ -4178,14 +5204,14 @@ associated label. Next: <a href="#g_t_005cnocite" accesskey="n" rel="next">\nocite</a>, Previous: <a href="#g_t_005cbibitem" accesskey="p" rel="prev">\bibitem</a>, Up: <a href="#thebibliography" accesskey="u" rel="up">thebibliography</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005ccite-1"></a> -<h4 class="subsection">8.25.2 <code>\cite</code></h4> +<h4 class="subsection">8.24.2 <code>\cite</code></h4> <a name="index-_005ccite"></a> <p>Synopsis: </p> <div class="example"> -<pre class="example">\cite[<var>subcite</var>]{<var>keys</var> +<pre class="example">\cite[<var>subcite</var>]{<var>keys</var>} </pre></div> <p>The <var>keys</var> argument is a list of one or more citation keys, @@ -4205,13 +5231,14 @@ citation. For example, <code>\cite[p.~314]{knuth}</code> might produce Next: <a href="#Using-BibTeX" accesskey="n" rel="next">Using BibTeX</a>, Previous: <a href="#g_t_005ccite" accesskey="p" rel="prev">\cite</a>, Up: <a href="#thebibliography" accesskey="u" rel="up">thebibliography</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cnocite-1"></a> -<h4 class="subsection">8.25.3 <code>\nocite</code></h4> +<h4 class="subsection">8.24.3 <code>\nocite</code></h4> + <a name="index-_005cnocite"></a> -<p><code>\nocite{key_list}</code> +<p><code>\nocite{<var>keys</var>}</code> </p> -<p>The <code>\nocite</code> command produces no text, but writes <code>key_list</code>, -which is a list of one or more citation keys, on the <samp>.aux</samp> file. +<p>The <code>\nocite</code> command produces no text, but writes <var>keys</var>, +which is a list of one or more citation keys, to the <samp>.aux</samp> file. </p> <hr> @@ -4221,7 +5248,7 @@ which is a list of one or more citation keys, on the <samp>.aux</samp> file. Previous: <a href="#g_t_005cnocite" accesskey="p" rel="prev">\nocite</a>, Up: <a href="#thebibliography" accesskey="u" rel="up">thebibliography</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="Using-BibTeX-1"></a> -<h4 class="subsection">8.25.4 Using BibTeX</h4> +<h4 class="subsection">8.24.4 Using BibTeX</h4> <a name="index-using-BibTeX"></a> <a name="index-bibTeX_002c-using"></a> @@ -4280,7 +5307,7 @@ BibTeX format. Only the entries referred to via <code>\cite</code> and Next: <a href="#titlepage" accesskey="n" rel="next">titlepage</a>, Previous: <a href="#thebibliography" accesskey="p" rel="prev">thebibliography</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="theorem-1"></a> -<h3 class="section">8.26 <code>theorem</code></h3> +<h3 class="section">8.25 <code>theorem</code></h3> <a name="index-theorem-environment"></a> <a name="index-theorems_002c-typesetting"></a> @@ -4306,7 +5333,7 @@ possibilities for <var>n</var> are described under <code>\newtheorem</code> Next: <a href="#verbatim" accesskey="n" rel="next">verbatim</a>, Previous: <a href="#theorem" accesskey="p" rel="prev">theorem</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="titlepage-1"></a> -<h3 class="section">8.27 <code>titlepage</code></h3> +<h3 class="section">8.26 <code>titlepage</code></h3> <a name="index-titlepage-environment"></a> <a name="index-making-a-title-page"></a> @@ -4337,7 +5364,7 @@ produce a standard title page without a <code>titlepage</code> environment. Next: <a href="#verse" accesskey="n" rel="next">verse</a>, Previous: <a href="#titlepage" accesskey="p" rel="prev">titlepage</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="verbatim-1"></a> -<h3 class="section">8.28 <code>verbatim</code></h3> +<h3 class="section">8.27 <code>verbatim</code></h3> <a name="index-verbatim-environment"></a> <a name="index-verbatim-text"></a> @@ -4374,7 +5401,7 @@ effect that they would on a typewriter. Up: <a href="#verbatim" accesskey="u" rel="up">verbatim</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cverb-1"></a> -<h4 class="subsection">8.28.1 <code>\verb</code></h4> +<h4 class="subsection">8.27.1 <code>\verb</code></h4> <a name="index-_005cverb"></a> <a name="index-verbatim-text_002c-inline"></a> @@ -4404,7 +5431,7 @@ verbatim text. The delimiter must not appear in <var>literal-text</var>. Previous: <a href="#verbatim" accesskey="p" rel="prev">verbatim</a>, Up: <a href="#Environments" accesskey="u" rel="up">Environments</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="verse-1"></a> -<h3 class="section">8.29 <code>verse</code></h3> +<h3 class="section">8.28 <code>verse</code></h3> <a name="index-verse-environment"></a> <a name="index-poetry_002c-an-environment-for"></a> @@ -4437,6 +5464,7 @@ Next: <a href="#Page-breaking" accesskey="n" rel="next">Page breaking</a>, Previ </div> <a name="Line-breaking-1"></a> <h2 class="chapter">9 Line breaking</h2> + <a name="index-line-breaking"></a> <a name="index-breaking-lines"></a> @@ -4445,9 +5473,8 @@ translate your input file into a sequence of glyphs and spaces. To produce a printed document, this sequence must be broken into lines (and these lines must be broken into pages). </p> -<p>LaTeX usually does the line (and page) breaking for you, but in -some environments, you do the line breaking yourself with the -<code>\\</code> command, and you can always manually force breaks. +<p>LaTeX usually does the line (and page) breaking in the text body for +you but in some environments you manually force line breaks. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005c_005c" accesskey="1">\\</a>:</td><td> </td><td align="left" valign="top">Start a new line. @@ -4475,20 +5502,48 @@ some environments, you do the line breaking yourself with the <p> Next: <a href="#g_t_005cobeycr-_0026-_005crestorecr" accesskey="n" rel="next">\obeycr & \restorecr</a>, Up: <a href="#Line-breaking" accesskey="u" rel="up">Line breaking</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005c_005c_005b_002a_005d_005bmorespace_005d"></a> -<h3 class="section">9.1 <code>\\</code>[*][<var>morespace</var>]</h3> +<a name="g_t_005c_005c-1"></a> +<h3 class="section">9.1 <code>\\</code></h3> + <a name="index-_005c_005c-force-line-break"></a> <a name="index-new-line_002c-starting"></a> <a name="index-line-break_002c-forcing"></a> -<p>The <code>\\</code> command tells LaTeX to start a new line. It has an -optional argument, <var>morespace</var>, that specifies how much extra -vertical space is to be inserted before the next line. This can be a -negative amount. +<p>Synopsis: +</p> +<div class="example"> +<pre class="example">\\[<var>morespace</var>] +</pre></div> + +<p>or +</p> +<div class="example"> +<pre class="example">\\*[<var>morespace</var>] +</pre></div> + +<p>Start a new line. The optional argument <var>morespace</var> specifies extra +vertical space to be insert before the next line. This can be a +negative length. The text before the break is set at its normal length, +that is, it is not stretched to fill out the line width. +</p> +<p>Explicit line breaks in the text body are unusual in LaTeX. In +particular, to start a new paragraph instead leave a blank line. This +command is mostly used outside of the main flow of text such as in +a <code>tabular</code> or <code>array</code> environment. </p> -<p>The <code>\\*</code> command is the same as the ordinary <code>\\</code> command -except that it tells LaTeX not to start a new page after the line. +<p>Under ordinary circumstances (e.g., outside of a <code>p{..}</code> column +in a <code>tabular</code> environment) the <code>\newline</code> command is a synonym for +<code>\\</code> (see <a href="#g_t_005cnewline">\newline</a>). </p> +<p>In addition to starting a new line, the starred form <code>\\*</code> tells +LaTeX not to start a new page between the two lines, by issuing a +<code>\nobreak</code>. +</p> +<div class="example"> +<pre class="example">\title{My story: \\[0.25in] + a tale of woe} +</pre></div> + <hr> <a name="g_t_005cobeycr-_0026-_005crestorecr"></a> @@ -4498,6 +5553,7 @@ Next: <a href="#g_t_005cnewline" accesskey="n" rel="next">\newline</a>, Previous </div> <a name="g_t_005cobeycr-_0026-_005crestorecr-1"></a> <h3 class="section">9.2 <code>\obeycr</code> & <code>\restorecr</code></h3> + <a name="index-_005cobeycr"></a> <a name="index-_005crestorecr"></a> <a name="index-new-line_002c-output-as-input"></a> @@ -4518,12 +5574,29 @@ Next: <a href="#g_t_005c_002d-_0028hyphenation_0029" accesskey="n" rel="next">\- </div> <a name="g_t_005cnewline-1"></a> <h3 class="section">9.3 <code>\newline</code></h3> + <a name="index-_005cnewline"></a> <a name="index-new-line_002c-starting-_0028paragraph-mode_0029"></a> -<p>The <code>\newline</code> command breaks the line at the present point, with -no stretching of the text before it. It can only be used in paragraph -mode. +<p>In ordinary text this is equivalent to double-backslash (see <a href="#g_t_005c_005c">\\</a>); it +breaks a line, with no stretching of the text before it. +</p> +<p>Inside a <code>tabular</code> or <code>array</code> environment, in a column with a +specifier producing a paragraph box, like typically <code>p{..}</code>, +<code>\newline</code> will insert a line break inside of the column, that is, +it does not break the entire row. To break the entire row use <code>\\</code> +or its equivalent <code>\tabularnewline</code>. +</p> +<p>This will print ‘<samp>Name:</samp>’ and ‘<samp>Address:</samp>’ as two lines in a +single cell of the table. +</p> +<div class="example"> +<pre class="example">\begin{tabular}{p{1in}{\hspace{2in}}p{1in}} + Name: \newline Address: &Date: \\ \hline +\end{tabular} +</pre></div> + +<p>The ‘<samp>Date:</samp>’ will be baseline-aligned with ‘<samp>Name:</samp>’. </p> <hr> @@ -4534,6 +5607,7 @@ Next: <a href="#g_t_005cfussy" accesskey="n" rel="next">\fussy</a>, Previous: <a </div> <a name="g_t_005c_002d-_0028discretionary-hyphen_0029"></a> <h3 class="section">9.4 <code>\-</code> (discretionary hyphen)</h3> + <a name="index-_005c_002d-_0028hyphenation_0029"></a> <a name="index-hyphenation_002c-forcing"></a> @@ -4548,7 +5622,6 @@ hyphenated at those points and not at any of the hyphenation points that LaTeX might otherwise have chosen. </p> - <hr> <a name="g_t_005cfussy"></a> <div class="header"> @@ -4557,6 +5630,7 @@ Next: <a href="#g_t_005csloppy" accesskey="n" rel="next">\sloppy</a>, Previous: </div> <a name="g_t_005cfussy-1"></a> <h3 class="section">9.5 <code>\fussy</code></h3> + <a name="index-_005cfussy"></a> <p>The declaration <code>\fussy</code> (which is the default) makes TeX @@ -4576,6 +5650,8 @@ Next: <a href="#g_t_005chyphenation" accesskey="n" rel="next">\hyphenation</a>, <a name="g_t_005csloppy-1"></a> <h3 class="section">9.6 <code>\sloppy</code></h3> +<a name="index-_005csloppy"></a> + <p>The declaration <code>\sloppy</code> makes TeX less fussy about line breaking. This will avoid overfull boxes, at the cost of loose interword spacing. @@ -4591,6 +5667,7 @@ Next: <a href="#g_t_005clinebreak-_0026-_005cnolinebreak" accesskey="n" rel="nex </div> <a name="g_t_005chyphenation-1"></a> <h3 class="section">9.7 <code>\hyphenation</code></h3> + <a name="index-_005chyphenation"></a> <a name="index-hyphenation_002c-defining"></a> @@ -4620,6 +5697,7 @@ Previous: <a href="#g_t_005chyphenation" accesskey="p" rel="prev">\hyphenation</ </div> <a name="g_t_005clinebreak-_0026-_005cnolinebreak-1"></a> <h3 class="section">9.8 <code>\linebreak</code> & <code>\nolinebreak</code></h3> + <a name="index-_005clinebreak"></a> <a name="index-_005cnolinebreak"></a> <a name="index-line-breaks_002c-forcing"></a> @@ -4650,6 +5728,7 @@ Next: <a href="#Footnotes" accesskey="n" rel="next">Footnotes</a>, Previous: <a </div> <a name="Page-breaking-1"></a> <h2 class="chapter">10 Page breaking</h2> + <a name="index-page-breaking"></a> <a name="index-breaking-pages"></a> @@ -4684,9 +5763,10 @@ Next: <a href="#g_t_005cclearpage" accesskey="n" rel="next">\clearpage</a>, Up: <a name="index-starting-on-a-right_002dhand-page"></a> <p>The <code>\cleardoublepage</code> command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. -In a two-sided printing style, it also makes the next page a right-hand -(odd-numbered) page, producing a blank page if necessary. +the pending floating figures and tables that have so far appeared in the +input to be printed. In a two-sided printing style, it also makes the +next page a right-hand (odd-numbered) page, producing a blank page if +necessary. </p> <hr> @@ -4697,12 +5777,14 @@ Next: <a href="#g_t_005cnewpage" accesskey="n" rel="next">\newpage</a>, Previous </div> <a name="g_t_005cclearpage-1"></a> <h3 class="section">10.2 <code>\clearpage</code></h3> + <a name="index-_005cclearpage"></a> <a name="index-flushing-floats-and-starting-a-page"></a> <a name="index-starting-a-new-page-and-clearing-floats"></a> -<p>The <code>\clearpage</code> command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. +<p>The <code>\clearpage</code> command ends the current page and causes all the +pending floating figures and tables that have so far appeared in the +input to be printed. </p> <hr> @@ -4713,12 +5795,13 @@ Next: <a href="#g_t_005cenlargethispage" accesskey="n" rel="next">\enlargethispa </div> <a name="g_t_005cnewpage-1"></a> <h3 class="section">10.3 <code>\newpage</code></h3> + <a name="index-_005cnewpage"></a> <a name="index-new-page_002c-starting"></a> <a name="index-starting-a-new-page"></a> <p>The <code>\newpage</code> command ends the current page, but does not clear -floats (see <code>\clearpage</code> above). +floats (see <a href="#g_t_005cclearpage">\clearpage</a>). </p> <hr> @@ -4729,6 +5812,7 @@ Next: <a href="#g_t_005cpagebreak-_0026-_005cnopagebreak" accesskey="n" rel="nex </div> <a name="g_t_005cenlargethispage-1"></a> <h3 class="section">10.4 <code>\enlargethispage</code></h3> + <a name="index-_005cenlargethispage"></a> <a name="index-enlarge-current-page"></a> @@ -4737,7 +5821,7 @@ Next: <a href="#g_t_005cpagebreak-_0026-_005cnopagebreak" accesskey="n" rel="nex <p><code>\enlargethispage*{size}</code> </p> <p>Enlarge the <code>\textheight</code> for the current page by the specified -amount; e.g. <code>\enlargethispage{\baselineskip}</code> will allow one +amount; e.g., <code>\enlargethispage{\baselineskip}</code> will allow one additional line. </p> <p>The starred form tries to squeeze the material together on the page as @@ -4753,6 +5837,7 @@ Previous: <a href="#g_t_005cenlargethispage" accesskey="p" rel="prev">\enlargeth </div> <a name="g_t_005cpagebreak-_0026-_005cnopagebreak-1"></a> <h3 class="section">10.5 <code>\pagebreak</code> & <code>\nopagebreak</code></h3> + <a name="index-_005cpagebreak"></a> <a name="index-_005cnopagebreak"></a> <a name="index-page-break_002c-forcing"></a> @@ -4784,12 +5869,26 @@ Next: <a href="#Definitions" accesskey="n" rel="next">Definitions</a>, Previous: </div> <a name="Footnotes-1"></a> <h2 class="chapter">11 Footnotes</h2> + <a name="index-footnotes_002c-creating"></a> -<p>Footnotes can be produced in one of two ways. They can be produced -with one command, the <code>\footnote</code> command. They can also be -produced with two commands, the <code>\footnotemark</code> and the -<code>\footnotetext</code> commands. +<p>Place a numbered footnote at the bottom of the current page, as here. +</p> +<div class="example"> +<pre class="example">Noël Coward quipped that having to read a footnote is like having +to go downstairs to answer the door, while in the midst of making +love.\footnote{I wouldn't know, I don't read footnotes.} +</pre></div> + +<p>You can place multiple footnotes on a page. If the text becomes too long +it will flow to the next page. +</p> +<p>You can also produce footnotes by combining the <code>\footnotemark</code> and +the <code>\footnotetext</code> commands, which is useful in special +circumstances. +</p> +<p>To make bibliographic references come out as footnotes you need to +include a bibliographic style with that behavior. </p> <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005cfootnote" accesskey="1">\footnote</a>:</td><td> </td><td align="left" valign="top">Insert a footnote. @@ -4798,9 +5897,15 @@ produced with two commands, the <code>\footnotemark</code> and the </td></tr> <tr><td align="left" valign="top">• <a href="#g_t_005cfootnotetext" accesskey="3">\footnotetext</a>:</td><td> </td><td align="left" valign="top">Insert footnote text only. </td></tr> -<tr><td align="left" valign="top">• <a href="#Symbolic-footnotes" accesskey="4">Symbolic footnotes</a>:</td><td> </td><td align="left" valign="top">Using symbols instead of numbers for footnotes. +<tr><td align="left" valign="top">• <a href="#Footnotes-in-a-table" accesskey="4">Footnotes in a table</a>:</td><td> </td><td align="left" valign="top">Table footnotes. </td></tr> -<tr><td align="left" valign="top">• <a href="#Footnote-parameters" accesskey="5">Footnote parameters</a>:</td><td> </td><td align="left" valign="top">Parameters for footnote formatting. +<tr><td align="left" valign="top">• <a href="#Footnotes-in-section-headings" accesskey="5">Footnotes in section headings</a>:</td><td> </td><td align="left" valign="top">Chapter or section titles. +</td></tr> +<tr><td align="left" valign="top">• <a href="#Footnotes-of-footnotes" accesskey="6">Footnotes of footnotes</a>:</td><td> </td><td align="left" valign="top">Multiple classes of footnotes. +</td></tr> +<tr><td align="left" valign="top">• <a href="#Multiple-reference-to-footnotes" accesskey="7">Multiple reference to footnotes</a>:</td><td> </td><td align="left" valign="top">Referring to a footnote more than once. +</td></tr> +<tr><td align="left" valign="top">• <a href="#Footnote-parameters" accesskey="8">Footnote parameters</a>:</td><td> </td><td align="left" valign="top">Parameters for footnote formatting. </td></tr> </table> @@ -4813,6 +5918,7 @@ Next: <a href="#g_t_005cfootnotemark" accesskey="n" rel="next">\footnotemark</a> </div> <a name="g_t_005cfootnote-1"></a> <h3 class="section">11.1 <code>\footnote</code></h3> + <a name="index-_005cfootnote"></a> <p>Synopsis: @@ -4821,13 +5927,43 @@ Next: <a href="#g_t_005cfootnotemark" accesskey="n" rel="next">\footnotemark</a> <pre class="example">\footnote[<var>number</var>]{<var>text</var>} </pre></div> -<p>The <code>\footnote</code> command places the numbered footnote <var>text</var> -at the bottom of the current page. The optional argument <var>number</var> -changes the default footnote number. +<p>Place a numbered footnote <var>text</var> at the bottom of the current page. +</p> +<div class="example"> +<pre class="example">There are over a thousand footnotes in Gibbon's +\textit{Decline and Fall of the Roman Empire}.\footnote{After +reading an early version with endnotes David Hume complained, +``One is also plagued with his Notes, according to the present Method +of printing the Book'' and suggested that they ``only to be printed +at the Margin or the Bottom of the Page.''} +</pre></div> + +<p>The optional argument <var>number</var> allows you to specify the footnote +number. If you use this option then the footnote number counter is not +incremented, and if you do not use it then the counter is incremented. +</p> +<a name="index-footnotes_002c-symbols-instead-of-numbers"></a> +<a name="index-_005cfnsymbol_002c-and-footnotes"></a> +<a name="index-_005c_0040fnsymbol"></a> +<p>Change how LaTeX shows the footnote counter with something like +<code>\renewcommand{\thefootnote}{\fnsymbol{footnote}}</code>, which +uses a sequence of symbols (see <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a>). To make this change global put that in the preamble. If +you make the change local then you may want to reset the counter with +<code>\setcounter{footnote}{0}</code>. By default LaTeX uses arabic +numbers. </p> -<p>This command can only be used in outer paragraph mode; i.e., you -cannot use it in sectioning commands like <code>\chapter</code>, in figures, -tables or in a <code>tabular</code> environment. (See following sections.) +<p>LaTeX’s default puts many restrictions on where you can use a +<code>\footnote</code>; for instance, you cannot use it in an argument to a +sectioning command such as <code>\chapter</code> (it can only be used in outer +paragraph mode). There are some workarounds; see following sections. +</p> +<a name="index-Footnotes_002c-in-a-minipage"></a> +<a name="index-mpfootnote-counter"></a> +<p>In a <code>minipage</code> environment the <code>\footnote</code> +command uses the <code>mpfootnote</code> counter instead of the +<code>footnote</code> counter, so they are numbered independently. They are +shown at the bottom of the environment, not at the bottom of the page. +And by default they are shown alphabetically. See <a href="#minipage">minipage</a>. </p> <hr> @@ -4838,80 +5974,226 @@ Next: <a href="#g_t_005cfootnotetext" accesskey="n" rel="next">\footnotetext</a> </div> <a name="g_t_005cfootnotemark-1"></a> <h3 class="section">11.2 <code>\footnotemark</code></h3> + <a name="index-_005cfootnotemark"></a> -<p>With no optional argument, the <code>\footnotemark</code> command puts the -current footnote number in the text. This command can be used in -inner paragraph mode. You give the text of the footnote separately, -with the <code>\footnotetext</code> command. +<p>Synopsis, one of: +</p> +<div class="example"> +<pre class="example">\footnotemark +\footnotemark[<var>number</var>] +</pre></div> + +<p>Put the current footnote number in the +text. (See <a href="#g_t_005cfootnotetext">\footnotetext</a> for giving the text of the footnote +separately.) The version with the optional argument <var>number</var> uses +that number to determine the mark printed. This command can be used in +inner paragraph mode. </p> -<p>This command can be used to produce several consecutive footnote -markers referring to the same footnote with +<p>This example gives the same institutional affiliation to both the first +and third authors (<code>\thanks</code> is a version of <code>footnote</code>). </p> <div class="example"> -<pre class="example">\footnotemark[\value{footnote}] +<pre class="example">\title{A Treatise on the Binomial Theorem} +\author{J Moriarty\thanks{University of Leeds} + \and A C Doyle\thanks{Durham University} + \and S Holmes\footnotemark[1]} +\begin{document} +\maketitle </pre></div> -<p>after the first <code>\footnote</code> command. +<p>If you use <code>\footnotemark</code> without the optional argument then it +increments the footnote counter but if you use the optional <var>number</var> +then it does not. This produces several consecutive footnote markers +referring to the same footnote. </p> +<div class="example"> +<pre class="example">The first theorem\footnote{Due to Gauss.} +and the second theorem\footnotemark[\value{footnote}] +and the third theorem.\footnotemark[\value{footnote}] +</pre></div> + <hr> <a name="g_t_005cfootnotetext"></a> <div class="header"> <p> -Next: <a href="#Symbolic-footnotes" accesskey="n" rel="next">Symbolic footnotes</a>, Previous: <a href="#g_t_005cfootnotemark" accesskey="p" rel="prev">\footnotemark</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#Footnotes-in-a-table" accesskey="n" rel="next">Footnotes in a table</a>, Previous: <a href="#g_t_005cfootnotemark" accesskey="p" rel="prev">\footnotemark</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cfootnotetext-1"></a> <h3 class="section">11.3 <code>\footnotetext</code></h3> + <a name="index-_005cfootnotetext"></a> -<p>Synopsis: +<p>Synopsis, one of: </p> <div class="example"> -<pre class="example">\footnotetext[<var>number</var>]{<var>text</var>} +<pre class="example">\footnotetext{<var>text</var>} +\footnotetext[<var>number</var>]{<var>text</var>} </pre></div> -<p>The <code>\footnotetext</code> command places <var>text</var> at the bottom of -the page as a footnote. This command can come anywhere after the -<code>\footnotemark</code> command. The <code>\footnotetext</code> command must -appear in outer paragraph mode. +<p>Place <var>text</var> at the bottom of the page as a footnote. This command +can come anywhere after the <code>\footnotemark</code> command. The optional +argument <var>number</var> changes the displayed footnote number. The +<code>\footnotetext</code> command must appear in outer paragraph mode. </p> -<p>The optional argument <var>number</var> changes the default footnote number. + +<hr> +<a name="Footnotes-in-a-table"></a> +<div class="header"> +<p> +Next: <a href="#Footnotes-in-section-headings" accesskey="n" rel="next">Footnotes in section headings</a>, Previous: <a href="#g_t_005cfootnotetext" accesskey="p" rel="prev">\footnotetext</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="Footnotes-in-a-table-1"></a> +<h3 class="section">11.4 Footnotes in a table</h3> + +<a name="index-Footnotes_002c-in-a-table"></a> + +<p>Inside a <code>table</code> environment the <code>\footnote</code> command does not +work. For instance, if the code below appears on its own then the +footnote simply disappears; there is a footnote mark in the table cell +but nothing is set at the bottom of the page. +</p> +<div class="example"> +<pre class="example">\begin{center} + \begin{tabular}{l|l} + \textsc{Ship} &\textsc{Book} \\ \hline + \textit{HMS Sophie} &Master and Commander \\ + \textit{HMS Polychrest} &Post Captain \\ + \textit{HMS Lively} &Post Captain \\ + \textit{HMS Surprise} &A number of books\footnote{Starting with HMS Surprise.} + \end{tabular} +\end{center} +</pre></div> + +<p>The solution is to surround the <code>tabular</code> environment with a +<code>minipage</code> environment, as here (see <a href="#minipage">minipage</a>). +</p> +<div class="example"> +<pre class="example">\begin{center} + \begin{minipage}{.5\textwidth} + .. tabular material .. + \end{minipage} +\end{center} +</pre></div> + +<p>The same technique will work inside a floating <code>table</code> environment +(see <a href="#table">table</a>). To get the footnote at the bottom of the page use the +<samp>tablefootnote</samp> package, as illustrated in this example. If you +put <code>\usepackage{tablefootnote}</code> in the preamble and use the code +shown then the footnote appears at the bottom and is numbered in +sequence with other footnotes. </p> +<div class="example"> +<pre class="example">\begin{table} + \centering + \begin{tabular}{l|l} + \textsc{Date} &\textsc{Campaign} \\ \hline + 1862 &Fort Donelson \\ + 1863 &Vicksburg \\ + 1865 &Army of Northern Virginia\footnote{Ending the war.} + \end{tabular} + \caption{Forces captured by US Grant} +\end{table} +</pre></div> + <hr> -<a name="Symbolic-footnotes"></a> +<a name="Footnotes-in-section-headings"></a> <div class="header"> <p> -Next: <a href="#Footnote-parameters" accesskey="n" rel="next">Footnote parameters</a>, Previous: <a href="#g_t_005cfootnotetext" accesskey="p" rel="prev">\footnotetext</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#Footnotes-of-footnotes" accesskey="n" rel="next">Footnotes of footnotes</a>, Previous: <a href="#Footnotes-in-a-table" accesskey="p" rel="prev">Footnotes in a table</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="Symbolic-footnotes-1"></a> -<h3 class="section">11.4 Symbolic footnotes</h3> +<a name="Footnotes-in-section-headings-1"></a> +<h3 class="section">11.5 Footnotes in section headings</h3> -<a name="index-footnotes_002c-symbolic-instead-of-numbered"></a> -<p>If you want to use symbols for footnotes, rather than increasing -numbers, redefine <code>\thefootnote</code> like this: +<p>Putting a footnote in a section heading </p> <div class="example"> -<pre class="example">\renewcommand{\thefootnote}{\fnsymbol{footnote}} +<pre class="example">\section{Full sets\protect\footnote{This material is due to R~Jones.}} </pre></div> -<a name="index-_005cfnsymbol_002c-and-footnotes"></a> -<a name="index-_005c_0040fnsymbol"></a> -<p>The <code>\fnsymbol</code> command produces a predefined series of symbols -(see <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a>). If you want to -use a different symbol as your footnote mark, you’ll need to also -redefine <code>\@fnsymbol</code>. +<p>causes the footnote to appear both at the bottom of the page where the +section starts and at the bottom of the table of contents page. To have +it not appear on the table of contents use the package <samp>footmisc</samp> +with the <code>stable</code> option. +</p> +<div class="example"> +<pre class="example">\usepackage[stable]{footmisc} + .. +\begin{document} + .. +\section{Full sets\footnote{This material is due to R~Jones.}} +</pre></div> + +<p>Note that the <code>\protect</code> is gone; putting it in causes the +footnote to reappear on the table of contents. +</p> + +<hr> +<a name="Footnotes-of-footnotes"></a> +<div class="header"> +<p> +Next: <a href="#Multiple-reference-to-footnotes" accesskey="n" rel="next">Multiple reference to footnotes</a>, Previous: <a href="#Footnotes-in-section-headings" accesskey="p" rel="prev">Footnotes in section headings</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="Footnotes-of-footnotes-1"></a> +<h3 class="section">11.6 Footnotes of footnotes</h3> + +<p>Particularly in the humanities, authors can have multiple classes of +footnotes, including having footnotes of footnotes. The package +<samp>bigfoot</samp> extends LaTeX’s default footnote mechanism in many +ways, including allow these two, as in this example. +</p> +<div class="example"> +<pre class="example">\usepackage{bigfoot} +\DeclareNewFootnote{Default} +\DeclareNewFootnote{from}[alph] % create class \footnotefrom{} + .. +\begin{document} + .. +The third theorem is a partial converse of the +second.\footnotefrom{First noted in Wilson.\footnote{Second edition only.}} + .. +</pre></div> + + +<hr> +<a name="Multiple-reference-to-footnotes"></a> +<div class="header"> +<p> +Next: <a href="#Footnote-parameters" accesskey="n" rel="next">Footnote parameters</a>, Previous: <a href="#Footnotes-of-footnotes" accesskey="p" rel="prev">Footnotes of footnotes</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="Multiple-references-to-footnotes"></a> +<h3 class="section">11.7 Multiple references to footnotes</h3> + +<p>You can refer to a single footnote more than once. This example +uses the package <samp>cleverref</samp>. +</p> +<div class="example"> +<pre class="example">\usepackage{cleveref}[2012/02/15] % this version of package or later +\crefformat{footnote}{#2\footnotemark[#1]#3} + .. +\begin{document} + .. +The theorem is from Evers.\footnote{\label{fn:TE}Tinker and Evers, 1994.} +The corollary is from Chance.\footnote{Evers and Chance, 1990.} +But the key lemma is from Tinker.\cref{fn:TE} + .. +</pre></div> + +<p>This solution will work with the package <samp>hyperref</samp>. +See <a href="#g_t_005cfootnotemark">\footnotemark</a> for a simpler solution in the common case +of multiple authors with the same affiliation. </p> <hr> <a name="Footnote-parameters"></a> <div class="header"> <p> -Previous: <a href="#Symbolic-footnotes" accesskey="p" rel="prev">Symbolic footnotes</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Previous: <a href="#Multiple-reference-to-footnotes" accesskey="p" rel="prev">Multiple reference to footnotes</a>, Up: <a href="#Footnotes" accesskey="u" rel="up">Footnotes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="Footnote-parameters-1"></a> -<h3 class="section">11.5 Footnote parameters</h3> +<h3 class="section">11.8 Footnote parameters</h3> <a name="index-footnote-parameters"></a> <a name="index-parameters_002c-for-footnotes"></a> @@ -4947,6 +6229,7 @@ Next: <a href="#Counters" accesskey="n" rel="next">Counters</a>, Previous: <a hr </div> <a name="Definitions-1"></a> <h2 class="chapter">12 Definitions</h2> + <a name="index-definitions"></a> <p>LaTeX has support for making new commands of many different kinds. @@ -4955,19 +6238,21 @@ Next: <a href="#Counters" accesskey="n" rel="next">Counters</a>, Previous: <a hr <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005cnewcommand-_0026-_005crenewcommand" accesskey="1">\newcommand & \renewcommand</a>:</td><td> </td><td align="left" valign="top">(Re)define a new command. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cnewcounter" accesskey="2">\newcounter</a>:</td><td> </td><td align="left" valign="top">Define a new counter. +<tr><td align="left" valign="top">• <a href="#g_t_005cprovidecommand" accesskey="2">\providecommand</a>:</td><td> </td><td align="left" valign="top">Define a new command, if name not used. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cnewlength" accesskey="3">\newlength</a>:</td><td> </td><td align="left" valign="top">Define a new length. +<tr><td align="left" valign="top">• <a href="#g_t_005cnewcounter" accesskey="3">\newcounter</a>:</td><td> </td><td align="left" valign="top">Define a new counter. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cnewsavebox" accesskey="4">\newsavebox</a>:</td><td> </td><td align="left" valign="top">Define a new box. +<tr><td align="left" valign="top">• <a href="#g_t_005cnewlength" accesskey="4">\newlength</a>:</td><td> </td><td align="left" valign="top">Define a new length. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment" accesskey="5">\newenvironment & \renewenvironment</a>:</td><td> </td><td align="left" valign="top">Define a new environment. +<tr><td align="left" valign="top">• <a href="#g_t_005cnewsavebox" accesskey="5">\newsavebox</a>:</td><td> </td><td align="left" valign="top">Define a new box. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cnewtheorem" accesskey="6">\newtheorem</a>:</td><td> </td><td align="left" valign="top">Define a new <code>theorem</code>-like environment. +<tr><td align="left" valign="top">• <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment" accesskey="6">\newenvironment & \renewenvironment</a>:</td><td> </td><td align="left" valign="top">Define a new environment. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cnewfont" accesskey="7">\newfont</a>:</td><td> </td><td align="left" valign="top">Define a new font name. +<tr><td align="left" valign="top">• <a href="#g_t_005cnewtheorem" accesskey="7">\newtheorem</a>:</td><td> </td><td align="left" valign="top">Define a new theorem-like environment. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cprotect" accesskey="8">\protect</a>:</td><td> </td><td align="left" valign="top">Using tricky commands. +<tr><td align="left" valign="top">• <a href="#g_t_005cnewfont" accesskey="8">\newfont</a>:</td><td> </td><td align="left" valign="top">Define a new font name. +</td></tr> +<tr><td align="left" valign="top">• <a href="#g_t_005cprotect" accesskey="9">\protect</a>:</td><td> </td><td align="left" valign="top">Using tricky commands. </td></tr> </table> @@ -4976,12 +6261,14 @@ Next: <a href="#Counters" accesskey="n" rel="next">Counters</a>, Previous: <a hr <a name="g_t_005cnewcommand-_0026-_005crenewcommand"></a> <div class="header"> <p> -Next: <a href="#g_t_005cnewcounter" accesskey="n" rel="next">\newcounter</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005cprovidecommand" accesskey="n" rel="next">\providecommand</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cnewcommand-_0026-_005crenewcommand-1"></a> <h3 class="section">12.1 <code>\newcommand</code> & <code>\renewcommand</code></h3> + <a name="index-_005cnewcommand"></a> <a name="index-commands_002c-defining-new-ones"></a> +<a name="index-commands_002c-redefining"></a> <a name="index-defining-a-new-command"></a> <a name="index-new-commands_002c-defining"></a> @@ -4989,37 +6276,49 @@ Next: <a href="#g_t_005cnewcounter" accesskey="n" rel="next">\newcounter</a>, Up command, respectively. Synopses: </p> <div class="example"> -<pre class="example"> \newcommand[*]{<var>cmd</var>}[<var>nargs</var>][<var>optargval</var>]{<var>defn</var>} -\renewcommand[*]{<var>cmd</var>}[<var>nargs</var>][<var>optargval</var>]{<var>defn</var>} +<pre class="example"> \newcommand{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} + \newcommand*{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +\renewcommand{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +\renewcommand*{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} </pre></div> -<dl compact="compact"> -<dt><var><code>*</code></var></dt> -<dd><a name="index-_002a_002dform-of-defining-new-commands"></a> -<p>The *-form of these commands requires that the arguments not contain -multiple paragraphs of text (not <code>\long</code>, in plain TeX terms). +<p>The <code>*</code>-form of these two commands requires that the arguments +not contain multiple paragraphs of text (not <code>\long</code>, in plain +TeX terms). </p> -</dd> +<dl compact="compact"> <dt><var>cmd</var></dt> -<dd><p>The command name, beginning with <code>\</code>. For <code>\newcommand</code>, it -must not be already defined and must not begin with <code>\end</code>; for -<code>\renewcommand</code>, it must already be defined. +<dd><p>Required; the command name. It must begin with <code>\</code>. For +<code>\newcommand</code>, it must not be already defined and must not begin +with <code>\end</code>. For <code>\renewcommand</code>, it must already be +defined. </p> </dd> <dt><var>nargs</var></dt> -<dd><p>An optional integer from 1 to 9 specifying the number of arguments -that the command will take. The default is for the command to have no -arguments. +<dd><p>Optional; an integer from 0 to 9, specifying the number of arguments +that the command will take. If this argument is not present, the +default is for the command to have no arguments. When redefining a +command, the new version can have a different number of arguments than +the old version. </p> </dd> -<dt><var>optargval</var></dt> -<dd><p>If this optional parameter is present, it means that the first -argument of command <var>cmd</var> is optional and its default value (i.e., -if it is not specified in the call) is <var>optarg</var>. In otherwise, -when calling the macro, if no <code>[<var>value</var>]</code> is given after -<code><var>cmd</var></code>—which is different from having <code>[]</code> for an -empty <var>value</var>—then string ‘<samp><var>optargval</var></samp>’ becomes the -value of <code>#1</code> within <var>defn</var> when the macro is expanded. +<dt><var>optargdefault</var></dt> +<dd><p>Optional; if this argument is present then the first argument of defined +command <var>\cmd</var> is optional, with default value <var>optargdefault</var> +(which may be the empty string). If this argument is not present then +<var>\cmd</var> does not take an optional argument. +</p> +<p>That is, if <var>\cmd</var> is used with square brackets following, as in +<code>\<var>cmd</var>[<var>myval</var>]</code>, then within <var>defn</var> <code>#1</code> expands +<var>myval</var>. While if <var>\cmd</var> is called without square brackets +following, then within <var>defn</var> the <code>#1</code> expands to the default +<var>optargdefault</var>. In either case, any required arguments will be +referred to starting with <code>#2</code>. +</p> +<p>Omitting <code>[<var>myval</var>]</code> in the call is different from having the +square brackets with no contents, as in <code>[]</code>. The former results +in <code>#1</code> expanding to <var>optargdefault</var>; the latter results in +<code>#1</code> expanding to the empty string. </p> </dd> <dt><var>defn</var></dt> @@ -5030,15 +6329,91 @@ text of the <var>n</var>th argument. </dd> </dl> +<p>A command with no arguments that is followed in the source by a space +will swallow that space. The solution is to type <code>{}</code> after the +command and before the space. +</p> +<p>A simple example of defining a new command: +<code>\newcommand{\JH}{Jim Hef{}feron}</code> causes the abbreviation +<code>\JH</code> to be replaced by the longer text. +</p> +<p>Redefining a command is basically the same: +<code>\renewcommand{\qedsymbol}{{\small QED}}</code>. +</p> +<p>Here’s a command definition that uses arguments: +</p> +<div class="example"> +<pre class="example">\newcommand{\defreference}[1]{Definition~\ref{#1}} +</pre></div> + +<p>Then, <code>\defreference{def:basis}</code> will expand to +something like ‘<samp>Definition~3.14</samp>’. +</p> +<p>An example with two arguments: +<code>\newcommand{\nbym}[2]{#1\!\times\!#2}</code> is invoked as +<code>\nbym{2}{k}</code>. +</p> +<p>An example with optional arguments: +</p> +<div class="example"> +<pre class="example">\newcommand{\salutation}[1][Sir or Madam]{Dear #1:} +</pre></div> + +<p>Then, <code>\salutation</code> gives ‘<samp>Dear Sir or Madam:</samp>’ while +<code>\salutation[John]</code> gives ‘<samp>Dear John:</samp>’. And +<code>\salutation[]</code> gives ‘<samp>Dear :</samp>’. +</p> +<p>The braces around <var>defn</var> do not delimit the scope of the result of +expanding <var>defn</var>. So <code>\newcommand{\shipname}[1]{\it #1}</code> +is wrong since in the sentence +</p> +<div class="example"> +<pre class="example">The \shipname{Monitor} met the \shipname{Virginia}. +</pre></div> + +<p>the words ‘<samp>met the</samp>’ will incorrectly be in italics. An +extra pair of braces <code>\newcommand{\shipname}[1]{{\it #1}}</code> +fixes it. +</p> + +<hr> +<a name="g_t_005cprovidecommand"></a> +<div class="header"> +<p> +Next: <a href="#g_t_005cnewcounter" accesskey="n" rel="next">\newcounter</a>, Previous: <a href="#g_t_005cnewcommand-_0026-_005crenewcommand" accesskey="p" rel="prev">\newcommand & \renewcommand</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="g_t_005cprovidecommand-1"></a> +<h3 class="section">12.2 <code>\providecommand</code></h3> + +<a name="index-_005cprovidecommand"></a> +<a name="index-commands_002c-defining-new-ones-1"></a> +<a name="index-defining-a-new-command-1"></a> +<a name="index-new-commands_002c-defining-1"></a> + +<p>Defines a command, as long as no command of this name already exists. +Synopses: +</p> +<div class="example"> +<pre class="example">\providecommand{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +\providecommand*{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +</pre></div> + +<p>If no command of this name already exists then this has the same effect +as <code>\newcommand</code> (see <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>). If a +command of this name already exists then this definition does nothing. +This is particularly useful in a style file, or other file that may be +loaded more than once. +</p> <hr> <a name="g_t_005cnewcounter"></a> <div class="header"> <p> -Next: <a href="#g_t_005cnewlength" accesskey="n" rel="next">\newlength</a>, Previous: <a href="#g_t_005cnewcommand-_0026-_005crenewcommand" accesskey="p" rel="prev">\newcommand & \renewcommand</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005cnewlength" accesskey="n" rel="next">\newlength</a>, Previous: <a href="#g_t_005cprovidecommand" accesskey="p" rel="prev">\providecommand</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005cnewcounter-1"></a> -<h3 class="section">12.2 <code>\newcounter</code></h3> +<a name="g_t_005cnewcounter_003a-Allocating-a-counter"></a> +<h3 class="section">12.3 <code>\newcounter</code>: Allocating a counter</h3> + <a name="index-_005cnewcounter"></a> <a name="index-counters_002c-defining-new"></a> @@ -5048,11 +6423,18 @@ Next: <a href="#g_t_005cnewlength" accesskey="n" rel="next">\newlength</a>, Prev <pre class="example">\newcounter{<var>countername</var>}[<var>supercounter</var>] </pre></div> -<p>The <code>\newcounter</code> command defines a new counter named <var>countername</var>. -The new counter is initialized to zero. +<p>The <code>\newcounter</code> command globally defines a new counter named +<var>countername</var>. The name consists of letters only and does not begin +with a backslash (‘<samp>\</samp>’). The name must not already be used by +another counter. The new counter is initialized to zero. </p> -<p>Given the optional argument <code>[<var>super</var>]</code>, <var>countername</var> -will be reset whenever the counter named <var>supercounter</var> is incremented. +<p>If the optional argument <code>[<var>supercounter</var>]</code> appears, then +<var>countername</var> will be numbered within, or subsidiary to, the +existing counter <var>supercounter</var>. For example, ordinarily +<code>subsection</code> is numbered within <code>section</code>. Any time +<var>supercounter</var> is incremented with <code>\stepcounter</code> +(see <a href="#g_t_005cstepcounter">\stepcounter</a>) or <code>\refstepcounter</code> +(see <a href="#g_t_005crefstepcounter">\refstepcounter</a>) then <var>countername</var> is reset to zero. </p> <p>See <a href="#Counters">Counters</a>, for more information about counters. </p> @@ -5063,24 +6445,29 @@ will be reset whenever the counter named <var>supercounter</var> is incremented. <p> Next: <a href="#g_t_005cnewsavebox" accesskey="n" rel="next">\newsavebox</a>, Previous: <a href="#g_t_005cnewcounter" accesskey="p" rel="prev">\newcounter</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005cnewlength-1"></a> -<h3 class="section">12.3 <code>\newlength</code></h3> +<a name="g_t_005cnewlength_003a-Allocating-a-length"></a> +<h3 class="section">12.4 <code>\newlength</code>: Allocating a length</h3> + <a name="index-_005cnewlength"></a> -<a name="index-lengths_002c-defining-new"></a> +<a name="index-lengths_002c-allocating-new"></a> +<a name="index-rubber-lengths_002c-defining-new"></a> +<a name="index-skip-register_002c-plain-TeX"></a> +<a name="index-glue-register_002c-plain-TeX"></a> -<p>Synopsis: +<p>Allocate a new <em>length</em> register. Synopsis: </p> <div class="example"> <pre class="example">\newlength{\<var>arg</var>} </pre></div> -<p>The <code>\newlength</code> command defines the mandatory argument as a -<em>length</em> command with a value of zero. The argument must -be a control sequence, as in <code>\newlength{\foo}</code>. An error -occurs if <code>\foo</code> is already defined. +<p>This command takes one required argument, which must begin with a +backslash (‘<samp>\</samp>’). It creates a new length register named +<code>\<var>arg</var></code>, which is a place to hold (rubber) lengths such as +<code>1in plus.2in minus.1in</code> (what plain TeX calls a <code>skip</code> +register). The register gets an initial value of zero. The control +sequence <code>\<var>arg</var></code> must not already be defined. </p> -<p>See <a href="#Lengths">Lengths</a>, for how to set the new length to a nonzero value, and -for more information about lengths in general. +<p>See <a href="#Lengths">Lengths</a>, for more about lengths. </p> <hr> @@ -5089,18 +6476,26 @@ for more information about lengths in general. <p> Next: <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment" accesskey="n" rel="next">\newenvironment & \renewenvironment</a>, Previous: <a href="#g_t_005cnewlength" accesskey="p" rel="prev">\newlength</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005cnewsavebox-1"></a> -<h3 class="section">12.4 <code>\newsavebox</code></h3> +<a name="g_t_005cnewsavebox_003a-Allocating-a-box"></a> +<h3 class="section">12.5 <code>\newsavebox</code>: Allocating a box</h3> + <a name="index-_005cnewsavebox"></a> +<a name="index-box_002c-allocating-new"></a> -<p>Synopsis: +<p>Allocate a “bin” for holding a box. Synopsis: </p> <div class="example"> -<pre class="example">\newsavebox{<var>cmd</var>} +<pre class="example">\newsavebox{\<var>cmd</var>} </pre></div> -<p>Defines <code>\<var>cmd</var></code>, which must be a command name not already -defined, to refer to a new bin for storing boxes. +<p>Defines <code>\<var>cmd</var></code> to refer to a new bin for storing boxes. +Such a box is for holding typeset material, to use multiple times +(see <a href="#Boxes">Boxes</a>) or to measure or manipulate. The name +<code>\<var>cmd</var></code> must start with a backslash (‘<samp>\</samp>’), and must not +be already defined. +</p> +<p>The allocation of a box is global. This command is fragile +(see <a href="#g_t_005cprotect">\protect</a>). </p> <hr> @@ -5110,60 +6505,135 @@ defined, to refer to a new bin for storing boxes. Next: <a href="#g_t_005cnewtheorem" accesskey="n" rel="next">\newtheorem</a>, Previous: <a href="#g_t_005cnewsavebox" accesskey="p" rel="prev">\newsavebox</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cnewenvironment-_0026-_005crenewenvironment-1"></a> -<h3 class="section">12.5 <code>\newenvironment</code> & <code>\renewenvironment</code></h3> +<h3 class="section">12.6 <code>\newenvironment</code> & <code>\renewenvironment</code></h3> + <a name="index-_005cnewenvironment"></a> <a name="index-_005crenewenvironment"></a> <a name="index-environments_002c-defining"></a> <a name="index-defining-new-environments"></a> <a name="index-redefining-environments"></a> -<p>Synopses: +<p>These commands define or redefine an environment <var>env</var>, that is, +<code>\begin{<var>env</var>} … \end{<var>env</var>}</code>. Synopses: </p> <div class="example"> -<pre class="example"> \newenvironment[*]{<var>env</var>}[<var>nargs</var>][<var>default</var>]{<var>begdef</var>}{<var>enddef</var>} -\renewenvironment[*]{<var>env</var>}[<var>nargs</var>]{<var>begdef</var>}{<var>enddef</var>} +<pre class="example"> \newenvironment{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} + \newenvironment*{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} +\renewenvironment{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} +\renewenvironment*{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} </pre></div> -<p>These commands define or redefine an environment <var>env</var>, that is, -<code>\begin{<var>env</var>} … \end{<var>env</var>}</code>. +<p>Unlike <code>\newcommand</code> and <code>\renewcommand</code>, the <code>*</code>-forms +<code>\newenvironment*</code> and <code>\renewcommand*</code> have the same effect +as the forms with no <code>*</code>. </p> <dl compact="compact"> -<dt><var><code>*</code></var></dt> -<dd><a name="index-_002a_002dform-of-environment-commands"></a> -<p>The *-form of these commands requires that the arguments (not the -contents of the environment) not contain multiple paragraphs of text. -</p> -</dd> <dt><var>env</var></dt> -<dd><p>The name of the environment. For <code>\newenvironment</code>, <var>env</var> -must not be an existing environment, and the command <code>\<var>env</var></code> -must be undefined. For <code>\renewenvironment</code>, <var>env</var> must be -the name of an existing environment. +<dd><p>Required; the environment name. It does not begin with backslash +(<code>\</code>). It must not begin with the string <code>end</code>. For +<code>\newenvironment</code>, the name <var>env</var> must not be the name of an +already existing environment, and also the command <code>\<var>env</var></code> +must be undefined. For <code>\renewenvironment</code>, <var>env</var> must be the +name of an existing environment. </p> </dd> <dt><var>nargs</var></dt> -<dd><p>An integer from 1 to 9 denoting the number of arguments of -the newly-defined environment. The default is no arguments. +<dd><p>Optional; an integer from 0 to 9 denoting the number of arguments of +that the environment will take. These arguments appear after the +<code>\begin</code>, as in +<code>\begin{<var>env</var>}{<var>arg1</var>}…{<var>argn</var>}</code>. If this +argument is not present then the default is for the environment to have +no arguments. When redefining an environment, the new version can have +a different number of arguments than the old version. </p> </dd> -<dt><var>default</var></dt> -<dd><p>If this is specified, the first argument is optional, and <var>default</var> -gives the default value for that argument. +<dt><var>optargdefault</var></dt> +<dd><p>Optional; if this argument is present then the first argument of the +defined environment is optional, with default value <var>optargdefault</var> +(which may be the empty string). If this argument is not present then +the environment does not take an optional argument. +</p> +<p>That is, when <code>[<var>optargdefault</var>]</code> is present in the environment +definition, if <code>\begin{<var>env</var>}</code> is used with square brackets +following, as in <code>\begin{<var>env</var>}[<var>myval</var>]</code>, then within +the environment <code>#1</code> expands <var>myval</var>. If +<code>\begin{<var>env</var>}</code> is called without square brackets following, +then within the environment the <code>#1</code> expands to the default +<var>optargdefault</var>. In either case, any required arguments will be +referred to starting with <code>#2</code>. +</p> + +<p>Omitting <code>[<var>myval</var>]</code> in the call is different from having the +square brackets with no contents, as in <code>[]</code>. The former results +in <code>#1</code> expanding to <var>optargdefault</var>; the latter results in +<code>#1</code> expanding to the empty string. </p> </dd> -<dt><var>begdef</var></dt> -<dd><p>The text expanded at every occurrence of <code>\begin{<var>env</var>}</code>; a -construct of the form <code>#<var>n</var></code> in <var>begdef</var> is replaced by -the text of the <var>n</var>th argument. +<dt><var>begdefn</var></dt> +<dd><p>Required; the text expanded at every occurrence of +<code>\begin{<var>env</var>}</code>; a construct of the form <code>#<var>n</var></code> in +<var>begdef</var> is replaced by the text of the <var>n</var>th argument. </p> </dd> -<dt><var>enddef</var></dt> -<dd><p>The text expanded at every occurrence of <code>\end{<var>env</var>}</code>. It -may not contain any argument parameters. +<dt><var>enddefn</var></dt> +<dd><p>Required; the text expanded at every occurrence of +<code>\end{<var>env</var>}</code>. Note that it may not contain any argument +parameters, so <code>#<var>n</var></code> cannot be used here. </p> </dd> </dl> +<p>The environment <var>env</var> delimits the scope of the result of expanding +<var>begdefn</var> and <var>enddefn</var>. Thus, in the first example below, the +effect of the <code>\small</code> is limited to the quote and does not extend +to material following the environment. +</p> +<p>This example gives an environment like LaTeX’s <code>quotation</code> except that +it will be set in smaller type. +</p> +<div class="example"> +<pre class="example">\newenvironment{smallquote}{% + \small\begin{quotation} +}{% + \end{quotation} +} +</pre></div> + +<p>This shows the use of arguments; it gives a quotation environment that +cites the author. +</p> +<div class="example"> +<pre class="example">\newenvironment{citequote}[1][Shakespeare]{% + \begin{quotation} + \noindent\textit{#1}: +}{% + \end{quotation} +} +</pre></div> + +<p>The author’s name is optional, and defaults to Shakespeare. +In the document, use the environment as here: +</p> +<div class="example"> +<pre class="example">\begin{citequote}[Lincoln] + .. +\end{citequote} +</pre></div> + +<p>The final example shows how to save the value of an argument to use in +<var>enddefn</var>. +</p> +<div class="example"> +<pre class="example">\newsavebox{\quoteauthor} +\newenvironment{citequote}[1][Shakespeare]{% + \sbox\quoteauthor{#1}% + \begin{quotation} +}{% + \hspace{1em plus 1fill}---\usebox{\quoteauthor} + \end{quotation} +} +</pre></div> + <hr> <a name="g_t_005cnewtheorem"></a> @@ -5172,45 +6642,145 @@ may not contain any argument parameters. Next: <a href="#g_t_005cnewfont" accesskey="n" rel="next">\newfont</a>, Previous: <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment" accesskey="p" rel="prev">\newenvironment & \renewenvironment</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cnewtheorem-1"></a> -<h3 class="section">12.6 <code>\newtheorem</code></h3> +<h3 class="section">12.7 <code>\newtheorem</code></h3> + <a name="index-_005cnewtheorem"></a> <a name="index-theorems_002c-defining"></a> <a name="index-defining-new-theorems"></a> +<a name="index-theorem_002dlike-environment"></a> +<a name="index-environment_002c-theorem_002dlike"></a> +<p>Define a new <em>theorem-like environment</em>. Synopses: +</p> +<div class="example"> +<pre class="example">\newtheorem{<var>name</var>}{<var>title</var>}[<var>numbered_within</var>] +\newtheorem{<var>name</var>}[<var>numbered_like</var>]{<var>title</var>} +</pre></div> + +<p>Both create a theorem-like environment <var>name</var>. Using the first +form, +</p> <div class="example"> -<pre class="example">\newtheorem{<var>newenv</var>}{<var>label</var>}[<var>within</var>] -\newtheorem{<var>newenv</var>}[<var>numbered_like</var>]{<var>label</var>} +<pre class="example">\newtheorem{<var>name</var>}{<var>title</var>}[<var>numbered_within</var>] </pre></div> -<p>This command defines a theorem-like environment. Arguments: +<p>with the optional argument after the second required argument, +creates an environment whose counter is subordinate to the existing +counter <var>numbered_within</var>: it will be reset when +<var>numbered_within</var> is reset). +</p> +<p>Using the second form, +</p> +<div class="example"> +<pre class="example">\newtheorem{<var>name</var>}[<var>numbered_like</var>]{<var>title</var>} +</pre></div> + +<p>with the optional argument between the two required +arguments, will create an environment whose counter will share the +previously defined counter <var>numbered_like</var>. +</p> +<p>You can specify one of <var>numbered_within</var> and <var>numbered_like</var>, +or neither, but not both. +</p> +<p>This command creates a counter named <var>name</var>. In addition, unless +the optional argument <var>numbered_like</var> is used, the current +<code>\ref</code> value will be that of <code>\the<var>numbered_within</var></code> +(see <a href="#g_t_005cref">\ref</a>). +</p> +<p>This declaration is global. It is fragile (see <a href="#g_t_005cprotect">\protect</a>). +</p> +<p>Arguments: </p> <dl compact="compact"> -<dt><var>newenv</var></dt> -<dd><p>The name of the environment to be defined; must not be the name of an -existing environment or otherwise defined. +<dt><var>name</var></dt> +<dd><p>The name of the environment. It must not begin with a backslash +(‘<samp>\</samp>’). It must not be the name of an existing environment; indeed, +the command name <code>\<var>name</var></code> must not already be defined as anything. </p> </dd> -<dt><var>label</var></dt> +<dt><var>title</var></dt> <dd><p>The text printed at the beginning of the environment, before the number. For example, ‘<samp>Theorem</samp>’. </p> </dd> -<dt><var>numbered_like</var></dt> -<dd><p>(Optional.) The name of an already defined theorem-like environment; -the new environment will be numbered just like <var>numbered_like</var>. +<dt><var>numbered_within</var></dt> +<dd><p>Optional; the name of an already defined counter, usually a sectional +unit such as <code>chapter</code> or <code>section</code>. When the +<var>numbered_within</var> counter is reset then the <var>name</var> environment’s +counter will also be reset. +</p> +<p>If this optional argument is not used then the command +<code>\the<var>name</var></code> is set to <code>\arabic{<var>name</var>}</code>. </p> </dd> -<dt><var>within</var></dt> -<dd><p>(Optional.) The name of an already defined counter, a sectional unit. -The new theorem counter will be reset at the same time as the -<var>within</var> counter. +<dt><var>numbered_like</var></dt> +<dd><p>Optional; the name of an already defined theorem-like environment. The +new environment will be numbered in sequence with <var>numbered_like</var>. </p> </dd> </dl> -<p>At most one of <var>numbered_like</var> and <var>within</var> can be specified, -not both. +<p>Without any optional arguments the environments are numbered +sequentially. This example has a declaration in the preamble that +results in ‘<samp>Definition 1</samp>’ and ‘<samp>Definition 2</samp>’ in the output. +</p> +<div class="example"> +<pre class="example">\newtheorem{defn}{Definition} +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{defn} + Second def +\end{defn} +</pre></div> + +<p>Because this example specifies the optional argument +<var>numbered_within</var> to <code>\newtheorem</code> as <code>section</code>, the +example, with the same document body, gives ‘<samp>Definition 1.1</samp>’ +and ‘<samp>Definition 2.1</samp>’. </p> +<div class="example"> +<pre class="example">\newtheorem{defn}{Definition}[section] +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{defn} + Second def +\end{defn} +</pre></div> + +<p>In this example there are two declarations in the preamble, the second +of which calls for the new <code>thm</code> environment to use the same +counter as <code>defn</code>. It gives ‘<samp>Definition 1.1</samp>’, followed +by ‘<samp>Theorem 2.1</samp>’ and ‘<samp>Definition 2.2</samp>’. +</p> +<div class="example"> +<pre class="example">\newtheorem{defn}{Definition}[section] +\newtheorem{thm}[defn]{Theorem} +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{thm} + First thm +\end{thm} + +\begin{defn} + Second def +\end{defn} +</pre></div> + <hr> <a name="g_t_005cnewfont"></a> @@ -5218,25 +6788,53 @@ not both. <p> Next: <a href="#g_t_005cprotect" accesskey="n" rel="next">\protect</a>, Previous: <a href="#g_t_005cnewtheorem" accesskey="p" rel="prev">\newtheorem</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005cnewfont-1"></a> -<h3 class="section">12.7 <code>\newfont</code></h3> +<a name="g_t_005cnewfont_003a-Define-a-new-font-_0028obsolete_0029"></a> +<h3 class="section">12.8 <code>\newfont</code>: Define a new font (obsolete)</h3> + <a name="index-_005cnewfont"></a> <a name="index-fonts_002c-new-commands-for"></a> <a name="index-defining-new-fonts"></a> -<p>Synopsis: +<p><code>\newfont</code>, now obsolete, defines a command that will switch fonts. +Synopsis: </p> <div class="example"> -<pre class="example">\newfont{<var>cmd</var>}{<var>fontname</var>} +<pre class="example">\newfont{\<var>cmd</var>}{<var>font description</var>} </pre></div> -<p>Defines a control sequence <code>\<var>cmd</var></code>, which must not already -be defined, to make <var>fontname</var> be the current font. The file -looked for on the system is named <samp><var>fontname</var>.tfm</samp>. -</p> -<p>This is a low-level command for setting up to use an individual font. -More commonly, fonts are defined in families through <samp>.fd</samp> files. +<p>This defines a control sequence <code>\<var>cmd</var></code> that will change the +current font. LaTeX will look on your system for a file named +<samp><var>fontname</var>.tfm</samp>. The control sequence must must not already +be defined. It must begin with a backslash (‘<samp>\</samp>’). +</p> +<a name="index-_002efd-file"></a> +<p>This command is obsolete. It is a low-level command for setting up an +individual font. Today fonts are almost always defined in families +(which allows you to, for example, associate a boldface with a roman) +through the so-called “New Font Selection Scheme”, either by using +<samp>.fd</samp> files or through the use of an engine that can access +system fonts such as XeLaTeX (see <a href="#TeX-engines">TeX engines</a>). +</p> +<a name="index-at-clause_002c-in-font-definitions"></a> +<a name="index-design-size_002c-in-font-definitions"></a> +<p>But since it is part of LaTeX, here is an explanation: the +<var>font description</var> consists of a <var>fontname</var> and an optional +<em>at clause</em>; this can have the form either <code>at <var>dimen</var></code> +or <code>scaled <var>factor</var></code>, where a <var>factor</var> of ‘<samp>1000</samp>’ +means no scaling. For LaTeX’s purposes, all this does is scale all +the character and other font dimensions relative to the font’s design +size, which is a value defined in the <samp>.tfm</samp> file. +</p> +<p>This example defines two equivalent fonts and typesets a few +characters in each: </p> +<div class="example"> +<pre class="example">\newfont{\testfontat}{cmb10 at 11pt} +\newfont{\testfontscaled}{cmb10 scaled 11pt} +\testfontat abc +\testfontscaled abc +</pre></div> + <hr> <a name="g_t_005cprotect"></a> @@ -5245,33 +6843,63 @@ More commonly, fonts are defined in families through <samp>.fd</samp> files. Previous: <a href="#g_t_005cnewfont" accesskey="p" rel="prev">\newfont</a>, Up: <a href="#Definitions" accesskey="u" rel="up">Definitions</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cprotect-1"></a> -<h3 class="section">12.8 <code>\protect</code></h3> -<a name="index-_005cprotect"></a> +<h3 class="section">12.9 <code>\protect</code></h3> +<a name="index-_005cprotect"></a> <a name="index-fragile-commands"></a> -<a name="index-moving-arguments"></a> -<p>Footnotes, line breaks, any command that has an optional argument, and -many more are so-called <em>fragile</em> commands. When a fragile -command is used in certain contexts, called <em>moving arguments</em>, it -must be preceded by <code>\protect</code>. In addition, any fragile -commands within the arguments must have their own <code>\protect</code>. -</p> -<p>Some examples of moving arguments are <code>\caption</code> -(see <a href="#figure">figure</a>), <code>\thanks</code> (see <a href="#g_t_005cmaketitle">\maketitle</a>), and -expressions in <code>tabular</code> and <code>array</code> environments -(see <a href="#tabular">tabular</a>). -</p> <a name="index-robust-commands"></a> -<p>Commands which are not fragile are called <em>robust</em>. They must not -be preceded by <code>\protect</code>. -</p> -<p>See also: +<a name="index-moving-arguments"></a> + +<p>All LaTeX commands are either <em>fragile</em> or <em>robust</em>. +Footnotes, line breaks, any command that has an optional argument, and +many more, are fragile. A fragile command can break when it is used in +the argument to certain commands. To prevent such commands from +breaking they must be preceded by the command <code>\protect</code>. +</p> +<p>For example, when LaTeX runs the <code>\section{<var>section +name</var>}</code> command it writes the <var>section name</var> text to the +<samp>.aux</samp> auxiliary file, moving it there for use elsewhere in the +document such as in the table of contents. Any argument that is +internally expanded by LaTeX without typesetting it directly is +referred to as a <em>moving argument</em>. A command is fragile if it can +expand during this process into invalid TeX code. Some examples of +moving arguments are those that appear in the <code>\caption{..}</code> +command (see <a href="#figure">figure</a>), in the <code>\thanks{..}</code> command +(see <a href="#g_t_005cmaketitle">\maketitle</a>), and in @-expressions in the <code>tabular</code> and +<code>array</code> environments (see <a href="#tabular">tabular</a>). +</p> +<p>If you get strange errors from commands used in moving arguments, try +preceding it with <code>\protect</code>. Every fragile commands must be +protected with their own <code>\protect</code>. +</p> +<p>Although usually a <code>\protect</code> command doesn’t hurt, length +commands are robust and should not be preceded by a <code>\protect</code> +command. Nor can a <code>\protect</code> command be used in the argument to +<code>\addtocounter</code> or <code>\setcounter</code> command. +</p> +<p>In this example the <code>caption</code> command gives a mysterious error +about an extra curly brace. Fix the problem by preceding each +<code>\raisebox</code> command with <code>\protect</code>. </p> -<div class="smallexample"> -<pre class="smallexample"><a href="http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html">http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</a> -</pre><pre class="smallexample"><a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</a> +<div class="example"> +<pre class="example">\begin{figure} + .. + \caption{Company headquarters of A\raisebox{1pt}{B}\raisebox{-1pt}{C}} +\end{figure} </pre></div> +<p>In the next example the <code>\tableofcontents</code> command gives an error +because the <code>\(..\)</code> in the section title expands to illegal TeX +in the <samp>.toc</samp> file. You can solve this by changing <code>\(..\)</code> +to <code>\protect\(..\protect\)</code>. +</p> +<div class="example"> +<pre class="example">\begin{document} +\tableofcontents + .. +\section{Einstein's \( e=mc^2 \)} + .. +</pre></div> <hr> @@ -5282,15 +6910,17 @@ Next: <a href="#Lengths" accesskey="n" rel="next">Lengths</a>, Previous: <a href </div> <a name="Counters-1"></a> <h2 class="chapter">13 Counters</h2> + <a name="index-counters_002c-a-list-of"></a> <a name="index-variables_002c-a-list-of"></a> <p>Everything LaTeX numbers for you has a counter associated with -it. The name of the counter is the same as the name of the environment -or command that produces the number, except with no <code>\</code>. -(<code>enumi</code>–<code>enumiv</code> are used for the nested enumerate -environment.) Below is a list of the counters used in LaTeX’s -standard document classes to control numbering. +it. The name of the counter is often the same as the name of the +environment or command associated with the number, except with no +backslash (<code>\</code>). Thus the <code>\chapter</code> command starts a +chapter and the <code>chapter</code> counter keeps track of the chapter +number. Below is a list of the counters used in LaTeX’s standard +document classes to control numbering. </p> <div class="example"> <pre class="example">part paragraph figure enumi @@ -5300,6 +6930,16 @@ subsection equation mpfootnote enumiv subsubsection </pre></div> +<p>The <code>mpfootnote</code> counter is used by the <code>\footnote</code> command +inside of a minipage (see <a href="#minipage">minipage</a>). +</p> +<p>The <code>enumi</code> through <code>enumiv</code> counters are used in the +<code>enumerate</code> environment, for up to four nested levels +(see <a href="#enumerate">enumerate</a>). +</p> +<p>New counters are created with <code>\newcounter</code>. See <a href="#g_t_005cnewcounter">\newcounter</a>. +</p> + <table class="menu" border="0" cellspacing="0"> <tr><td align="left" valign="top">• <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol" accesskey="1">\alph \Alph \arabic \roman \Roman \fnsymbol</a>:</td><td> </td><td align="left" valign="top">Print value of a counter. </td></tr> @@ -5329,8 +6969,11 @@ Next: <a href="#g_t_005cusecounter" accesskey="n" rel="next">\usecounter</a>, Up <a name="g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol_003a-Printing-counters"></a> <h3 class="section">13.1 <code>\alph \Alph \arabic \roman \Roman \fnsymbol</code>: Printing counters</h3> +<a name="index-counters_002c-printing"></a> + <p>All of these commands take a single counter as an argument, for -instance, <code>\alph{enumi}</code>. +instance, <code>\alph{enumi}</code>. Note that the counter name does not +start with a backslash. </p> <dl compact="compact"> <dt><code>\alph</code> @@ -5375,7 +7018,7 @@ symbols (conventionally used for labeling footnotes). The value of <div class="display"> <pre class="display">asterisk(*) dagger(‡) ddagger(‡) section-sign(§) paragraph-sign(¶) parallel(∥) -double-asterisk(**) double-dagger(‡‡) double-ddagger(‡‡) +double-asterisk(**) double-dagger(††) double-ddagger(‡‡) </pre></div> </dd> @@ -5390,6 +7033,7 @@ Next: <a href="#g_t_005cvalue" accesskey="n" rel="next">\value</a>, Previous: <a </div> <a name="g_t_005cusecounter_007bcounter_007d"></a> <h3 class="section">13.2 <code>\usecounter{<var>counter</var>}</code></h3> + <a name="index-_005cusecounter"></a> <a name="index-list-items_002c-specifying-counter"></a> <a name="index-numbered-items_002c-specifying-counter"></a> @@ -5400,10 +7044,27 @@ Next: <a href="#g_t_005cvalue" accesskey="n" rel="next">\value</a>, Previous: <a <pre class="example">\usecounter{<var>counter</var>} </pre></div> -<p>The <code>\usecounter</code> command is used in the second argument of the -<code>list</code> environment to specify <var>counter</var> to be used to number -the list items. +<p>In the <code>list</code> environment, when used in the second argument, this +command sets up <var>counter</var> to number the list items. It initializes +<var>counter</var> to zero, and arranges that when <code>\item</code> is called +without its optional argument then <var>counter</var> is incremented by +<code>\refstepcounter</code>, making its value be the current <code>ref</code> +value. This command is fragile (see <a href="#g_t_005cprotect">\protect</a>). +</p> +<p>Put in the preamble, this makes a new list environment enumerated with +<var>testcounter</var>: </p> +<div class="example"> +<pre class="example">\newcounter{testcounter} +\newenvironment{test}{% + \begin{list}{}{% + \usecounter{testcounter} + } +}{% + \end{list} +} +</pre></div> + <hr> <a name="g_t_005cvalue"></a> @@ -5413,6 +7074,7 @@ Next: <a href="#g_t_005csetcounter" accesskey="n" rel="next">\setcounter</a>, Pr </div> <a name="g_t_005cvalue_007bcounter_007d"></a> <h3 class="section">13.3 <code>\value{<var>counter</var>}</code></h3> + <a name="index-_005cvalue"></a> <a name="index-counters_002c-getting-value-of"></a> @@ -5422,12 +7084,30 @@ Next: <a href="#g_t_005csetcounter" accesskey="n" rel="next">\setcounter</a>, Pr <pre class="example">\value{<var>counter</var>} </pre></div> -<p>The <code>\value</code> command produces the value of <var>counter</var>. It can -be used anywhere LaTeX expects a number, for example: +<p>This command expands to the value of <var>counter</var>. It is often used +in <code>\setcounter</code> or <code>\addtocounter</code>, but <code>\value</code> can +be used anywhere that LaTeX expects a number. It must not be +preceded by <code>\protect</code> (see <a href="#g_t_005cprotect">\protect</a>). +</p> +<p>The <code>\value</code> command is not used for typesetting the value of the +counter. See <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a>. +</p> +<p>This example outputs ‘<samp>Test counter is 6. Other counter +is 5.</samp>’. +</p> +<div class="example"> +<pre class="example">\newcounter{test} \setcounter{test}{5} +\newcounter{other} \setcounter{other}{\value{test}} +\addtocounter{test}{1} + +Test counter is \arabic{test}. +Other counter is \arabic{other}. +</pre></div> + +<p>This example inserts <code>\hspace{4\parindent}</code>. </p> <div class="example"> -<pre class="example">\setcounter{myctr}{3} -\addtocounter{myctr}{1} +<pre class="example">\setcounter{myctr}{3} \addtocounter{myctr}{1} \hspace{\value{myctr}\parindent} </pre></div> @@ -5440,6 +7120,7 @@ Next: <a href="#g_t_005caddtocounter" accesskey="n" rel="next">\addtocounter</a> </div> <a name="g_t_005csetcounter_007bcounter_007d_007bvalue_007d"></a> <h3 class="section">13.4 <code>\setcounter{<var>counter</var>}{<var>value</var>}</code></h3> + <a name="index-_005csetcounter"></a> <a name="index-counters_002c-setting"></a> <a name="index-setting-counters"></a> @@ -5450,8 +7131,9 @@ Next: <a href="#g_t_005caddtocounter" accesskey="n" rel="next">\addtocounter</a> <pre class="example">\setcounter{<var>counter</var>}{<var>value</var>} </pre></div> -<p>The <code>\setcounter</code> command sets the value of <var>counter</var> to the -<var>value</var> argument. +<p>The <code>\setcounter</code> command globally sets the value of <var>counter</var> +to the <var>value</var> argument. Note that the counter name does not start +with a backslash. </p> <hr> @@ -5462,10 +7144,11 @@ Next: <a href="#g_t_005crefstepcounter" accesskey="n" rel="next">\refstepcounter </div> <a name="g_t_005caddtocounter_007bcounter_007d_007bvalue_007d"></a> <h3 class="section">13.5 <code>\addtocounter{<var>counter</var>}{<var>value</var>}</code></h3> + <a name="index-_005caddtocounter"></a> -<p>The <code>\addtocounter</code> command increments <var>counter</var> by the -amount specified by the <var>value</var> argument, which may be negative. +<p>The <code>\addtocounter</code> command globally increments <var>counter</var> by +the amount specified by the <var>value</var> argument, which may be negative. </p> <hr> @@ -5476,11 +7159,20 @@ Next: <a href="#g_t_005cstepcounter" accesskey="n" rel="next">\stepcounter</a>, </div> <a name="g_t_005crefstepcounter_007bcounter_007d"></a> <h3 class="section">13.6 <code>\refstepcounter{<var>counter</var>}</code></h3> + <a name="index-_005crefstepcounter"></a> <p>The <code>\refstepcounter</code> command works in the same way as -<code>\stepcounter</code> See <a href="#g_t_005cstepcounter">\stepcounter</a>, except it also defines the -current <code>\ref</code> value to be the result of <code>\thecounter</code>. +<code>\stepcounter</code> (see <a href="#g_t_005cstepcounter">\stepcounter</a>): it globally increments the +value of <var>counter</var> by one and resets the value of any counter +numbered within it. (For the definition of “counters numbered +within”, see <a href="#g_t_005cnewcounter">\newcounter</a>.) +</p> +<p>In addition, this command also defines the current <code>\ref</code> value +to be the result of <code>\thecounter</code>. +</p> +<p>While the counter value is set globally, the <code>\ref</code> value is set +locally, i.e., inside the current group. </p> <hr> @@ -5491,10 +7183,12 @@ Next: <a href="#g_t_005cday-_005cmonth-_005cyear" accesskey="n" rel="next">\day </div> <a name="g_t_005cstepcounter_007bcounter_007d"></a> <h3 class="section">13.7 <code>\stepcounter{<var>counter</var>}</code></h3> + <a name="index-_005cstepcounter"></a> -<p>The <code>\stepcounter</code> command adds one to <var>counter</var> and -resets all subsidiary counters. +<p>The <code>\stepcounter</code> command globally adds one to <var>counter</var> and +resets all counters numbered within it. (For the definition of +“counters numbered within”, see <a href="#g_t_005cnewcounter">\newcounter</a>.) </p> <hr> @@ -5505,6 +7199,7 @@ Previous: <a href="#g_t_005cstepcounter" accesskey="p" rel="prev">\stepcounter</ </div> <a name="g_t_005cday-_005cmonth-_005cyear_003a-Predefined-counters"></a> <h3 class="section">13.8 <code>\day \month \year</code>: Predefined counters</h3> + <a name="index-_005cday"></a> <a name="index-_005cmonth"></a> <a name="index-_005cyear"></a> @@ -5527,35 +7222,161 @@ Next: <a href="#Making-paragraphs" accesskey="n" rel="next">Making paragraphs</a </div> <a name="Lengths-1"></a> <h2 class="chapter">14 Lengths</h2> + <a name="index-lengths_002c-defining-and-using"></a> -<p>A <code>length</code> is a measure of distance. Many LaTeX commands take a +<p>A <em>length</em> is a measure of distance. Many LaTeX commands take a length as an argument. </p> +<p>Lengths come in two types. A <em>rigid length</em> (what Plain TeX +calls a <em>dimen</em>) such as <code>10pt</code> cannot contain a <code>plus</code> or +<code>minus</code> component. A <em>rubber length</em> (what Plain TeX calls +a <em>skip</em>) can contain those, as with <code>1cm plus0.05cm +minus0.01cm</code>. These give the ability to stretch or shrink; the length +in the prior sentence could appear in the output as long as 1.05 cm +or as short as 0.99 cm, depending on what TeX’s typesetting +algorithm finds optimum. +</p> +<p>The <code>plus</code> or <code>minus</code> component of a rubber length can contain +a <em>fill</em> component, as in <code>1in plus2fill</code>. This gives the +length infinite stretchability or shrinkability, so that the length in +the prior sentence can be set by TeX to any distance greater than or +equal to 1 inch. TeX actually provides three infinite glue +components <code>fil</code>, <code>fill</code>, and <code>filll</code>, such that the +later ones overcome the earlier ones, but only the middle value is +ordinarily used. See <a href="#g_t_005chfill">\hfill</a>, See <a href="#g_t_005cvfill">\vfill</a>. +</p> +<p>Multiplying an entire rubber length by a number turns it into a rigid +length, so that after <code>\setlength{\ylength}{1in plus 0.2in}</code> +and <code>\setlength{\zlength}{3\ylength}</code> then the value of +<code>\zlength</code> is <code>3in</code>. +</p> + <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="#g_t_005csetlength" accesskey="1">\setlength</a>:</td><td> </td><td align="left" valign="top">Set the value of a length. +<tr><td align="left" valign="top">• <a href="#Units-of-length" accesskey="1">Units of length</a>:</td><td> </td><td align="left" valign="top">The units that LaTeX knows. +</td></tr> +<tr><td align="left" valign="top">• <a href="#g_t_005csetlength" accesskey="2">\setlength</a>:</td><td> </td><td align="left" valign="top">Set the value of a length. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005caddtolength" accesskey="2">\addtolength</a>:</td><td> </td><td align="left" valign="top">Add a quantity to a length. +<tr><td align="left" valign="top">• <a href="#g_t_005caddtolength" accesskey="3">\addtolength</a>:</td><td> </td><td align="left" valign="top">Add a quantity to a length. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005csettodepth" accesskey="3">\settodepth</a>:</td><td> </td><td align="left" valign="top">Set a length to the depth of something. +<tr><td align="left" valign="top">• <a href="#g_t_005csettodepth" accesskey="4">\settodepth</a>:</td><td> </td><td align="left" valign="top">Set a length to the depth of something. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005csettoheight" accesskey="4">\settoheight</a>:</td><td> </td><td align="left" valign="top">Set a length to the height of something. +<tr><td align="left" valign="top">• <a href="#g_t_005csettoheight" accesskey="5">\settoheight</a>:</td><td> </td><td align="left" valign="top">Set a length to the height of something. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005csettowidth" accesskey="5">\settowidth</a>:</td><td> </td><td align="left" valign="top">Set a length to the width of something. +<tr><td align="left" valign="top">• <a href="#g_t_005csettowidth" accesskey="6">\settowidth</a>:</td><td> </td><td align="left" valign="top">Set a length to the width of something. </td></tr> -<tr><td align="left" valign="top">• <a href="#Predefined-lengths" accesskey="6">Predefined lengths</a>:</td><td> </td><td align="left" valign="top">Lengths that are, like, predefined. +<tr><td align="left" valign="top">• <a href="#Predefined-lengths" accesskey="7">Predefined lengths</a>:</td><td> </td><td align="left" valign="top">Lengths that are, like, predefined. </td></tr> </table> <hr> +<a name="Units-of-length"></a> +<div class="header"> +<p> +Next: <a href="#g_t_005csetlength" accesskey="n" rel="next">\setlength</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="Units-of-length-1"></a> +<h3 class="section">14.1 Units of length</h3> + +<a name="index-units_002c-of-length"></a> + +<p>TeX and LaTeX know about these units both inside and outside of +math mode. +</p> +<dl compact="compact"> +<dt><code>pt</code></dt> +<dd><a name="index-pt"></a> +<a name="index-Point"></a> +<p>Point 1/72.27 inch. The conversion to metric units, to two decimal +places, is 1point = 2.85mm = 28.45cm. +</p> +</dd> +<dt><code>pc</code></dt> +<dd><a name="index-pica"></a> +<a name="index-pc"></a> +<p>Pica, 12 pt +</p> +</dd> +<dt><code>in</code></dt> +<dd><a name="index-in"></a> +<a name="index-inch"></a> +<p>Inch, 72.27 pt +</p> +</dd> +<dt><code>bp</code></dt> +<dd><a name="index-bp"></a> +<a name="index-Big-point"></a> +<p>Big point, 1/72 inch. This length is the definition of a point in +PostScript and many desktop publishing systems. +</p> +</dd> +<dt><code>cm</code></dt> +<dd><a name="index-Centimeter"></a> +<a name="index-cm"></a> +<p>Centimeter +</p> +</dd> +<dt><code>mm</code></dt> +<dd><a name="index-Millimeter"></a> +<a name="index-mm"></a> +<p>Millimeter +</p> +</dd> +<dt><code>dd</code></dt> +<dd><a name="index-Didot-point"></a> +<a name="index-dd"></a> +<p>Didot point, 1.07 pt +</p> +</dd> +<dt><code>cc</code></dt> +<dd><a name="index-Cicero"></a> +<a name="index-cc"></a> +<p>Cicero, 12 dd +</p> +</dd> +<dt><code>sp</code></dt> +<dd><a name="index-Scaled-point"></a> +<a name="index-sp"></a> +<p>Scaled point, 1/65536 pt +</p> +</dd> +</dl> + +<a name="index-ex"></a> +<a name="index-x_002dheight"></a> +<a name="index-ex-1"></a> +<a name="index-m_002dwidth"></a> +<a name="index-em"></a> +<a name="index-em-1"></a> +<p>Two other lengths that are often used are values set by the designer of +the font. The x-height of the current font <em>ex</em>, traditionally the +height of the lower case letter x, is often used for vertical +lengths. Similarly <em>em</em>, traditionally the width of the capital +letter M, is often used for horizontal lengths (there is also +<code>\enspace</code>, which is <code>0.5em</code>). Use of these can help make a +definition work better across font changes. For example, a definition +of the vertical space between list items given as +<code>\setlength{\itemsep}{1ex plus 0.05ex minus 0.01ex}</code> is more +likely to still be reasonable if the font is changed than a definition +given in points. +</p> +<a name="index-mu_002c-math-unit"></a> +<a name="index-mu"></a> +<p>In math mode, many definitions are expressed in terms of the math unit +<em>mu</em> given by 1 em = 18 mu, where the em is taken from the current +math symbols family. See <a href="#Spacing-in-math-mode">Spacing in math mode</a>. +</p> + +<hr> <a name="g_t_005csetlength"></a> <div class="header"> <p> -Next: <a href="#g_t_005caddtolength" accesskey="n" rel="next">\addtolength</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005caddtolength" accesskey="n" rel="next">\addtolength</a>, Previous: <a href="#Units-of-length" accesskey="p" rel="prev">Units of length</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005csetlength_007b_005clen_007d_007bvalue_007d"></a> -<h3 class="section">14.1 <code>\setlength{\<var>len</var>}{<var>value</var>}</code></h3> +<h3 class="section">14.2 <code>\setlength{\<var>len</var>}{<var>value</var>}</code></h3> + <a name="index-_005csetlength"></a> <a name="index-lengths_002c-setting"></a> @@ -5572,7 +7393,8 @@ understands, i.e., inches (<code>in</code>), millimeters (<code>mm</code>), poin Next: <a href="#g_t_005csettodepth" accesskey="n" rel="next">\settodepth</a>, Previous: <a href="#g_t_005csetlength" accesskey="p" rel="prev">\setlength</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005caddtolength_007b_005clen_007d_007bamount_007d"></a> -<h3 class="section">14.2 \addtolength{<var>\len</var>}{<var>amount</var>}</h3> +<h3 class="section">14.3 <code>\addtolength{<var>\len</var>}{<var>amount</var>}</code></h3> + <a name="index-_005caddtolength"></a> <a name="index-lengths_002c-adding-to"></a> @@ -5588,7 +7410,8 @@ may be negative. Next: <a href="#g_t_005csettoheight" accesskey="n" rel="next">\settoheight</a>, Previous: <a href="#g_t_005caddtolength" accesskey="p" rel="prev">\addtolength</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005csettodepth-1"></a> -<h3 class="section">14.3 <code>\settodepth</code></h3> +<h3 class="section">14.4 <code>\settodepth</code></h3> + <a name="index-_005csettodepth"></a> <p><code>\settodepth{\gnat}{text}</code> @@ -5604,7 +7427,8 @@ equal to the depth of the <code>text</code> argument. Next: <a href="#g_t_005csettowidth" accesskey="n" rel="next">\settowidth</a>, Previous: <a href="#g_t_005csettodepth" accesskey="p" rel="prev">\settodepth</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005csettoheight-1"></a> -<h3 class="section">14.4 <code>\settoheight</code></h3> +<h3 class="section">14.5 <code>\settoheight</code></h3> + <a name="index-_005csettoheight"></a> <p><code>\settoheight{\gnat}{text}</code> @@ -5621,7 +7445,8 @@ equal to the height of the <code>text</code> argument. Next: <a href="#Predefined-lengths" accesskey="n" rel="next">Predefined lengths</a>, Previous: <a href="#g_t_005csettoheight" accesskey="p" rel="prev">\settoheight</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005csettowidth_007b_005clen_007d_007btext_007d"></a> -<h3 class="section">14.5 <code>\settowidth{\<var>len</var>}{<var>text</var>}</code></h3> +<h3 class="section">14.6 <code>\settowidth{\<var>len</var>}{<var>text</var>}</code></h3> + <a name="index-_005csettowidth"></a> <p>The <code>\settowidth</code> command sets the value of the command <var>\len</var> @@ -5635,7 +7460,8 @@ to the width of the <var>text</var> argument. Previous: <a href="#g_t_005csettowidth" accesskey="p" rel="prev">\settowidth</a>, Up: <a href="#Lengths" accesskey="u" rel="up">Lengths</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="Predefined-lengths-1"></a> -<h3 class="section">14.6 Predefined lengths</h3> +<h3 class="section">14.7 Predefined lengths</h3> + <a name="index-lengths_002c-predefined"></a> <a name="index-predefined-lengths"></a> @@ -5668,6 +7494,7 @@ Next: <a href="#Math-formulas" accesskey="n" rel="next">Math formulas</a>, Previ </div> <a name="Making-paragraphs-1"></a> <h2 class="chapter">15 Making paragraphs</h2> + <a name="index-making-paragraphs"></a> <a name="index-paragraphs"></a> @@ -5696,14 +7523,14 @@ Next: <a href="#g_t_005cnoindent" accesskey="n" rel="next">\noindent</a>, Up: <a </div> <a name="g_t_005cindent-1"></a> <h3 class="section">15.1 <code>\indent</code></h3> + <a name="index-_005cindent"></a> <a name="index-_005cparindent-1"></a> <a name="index-indent_002c-forcing"></a> -<p><code>\indent</code> produces a horizontal space whose width equals the -width of the <code>\parindent</code> length, the normal paragraph -indentation. It is used to add paragraph indentation where it would -otherwise be suppressed. +<p><code>\indent</code> produces a horizontal space whose width equals to the +<code>\parindent</code> length, the normal paragraph indentation. It is used +to add paragraph indentation where it would otherwise be suppressed. </p> <p>The default value for <code>\parindent</code> is <code>1em</code> in two-column mode, otherwise <code>15pt</code> for <code>10pt</code> documents, <code>17pt</code> for @@ -5718,12 +7545,23 @@ Next: <a href="#g_t_005cparskip" accesskey="n" rel="next">\parskip</a>, Previous </div> <a name="g_t_005cnoindent-1"></a> <h3 class="section">15.2 <code>\noindent</code></h3> + <a name="index-_005cnoindent"></a> <a name="index-indent_002c-suppressing"></a> -<p>When used at the beginning of the paragraph, <code>\noindent</code> -suppresses any paragraph indentation. It has no effect when used in -the middle of a paragraph. +<p>When used at the beginning of the paragraph, this command suppresses any +paragraph indentation, as in this example. +</p> +<div class="example"> +<pre class="example">.. end of the prior paragraph. + +\noindent This paragraph is not indented. +</pre></div> + +<p>It has no effect when used in the middle of a paragraph. +</p> +<p>To eliminate paragraph indentation in an entire document, put +<code>\setlength{\parindent}{0pt}</code> in the preamble. </p> <hr> @@ -5734,6 +7572,7 @@ Next: <a href="#Marginal-notes" accesskey="n" rel="next">Marginal notes</a>, Pre </div> <a name="g_t_005cparskip-1"></a> <h3 class="section">15.3 <code>\parskip</code></h3> + <a name="index-_005cparskip"></a> <a name="index-vertical-space-before-paragraphs"></a> @@ -5749,6 +7588,7 @@ Previous: <a href="#g_t_005cparskip" accesskey="p" rel="prev">\parskip</a>, Up: </div> <a name="Marginal-notes-1"></a> <h3 class="section">15.4 Marginal notes</h3> + <a name="index-marginal-notes"></a> <a name="index-notes-in-the-margin"></a> <a name="index-remarks-in-the-margin"></a> @@ -5768,9 +7608,9 @@ where the <code>\marginpar</code> occurs. will be placed </p> <ul> -<li> in the right margin for one-sided layout; -</li><li> in the outside margin for two-sided layout; -</li><li> in the nearest margin for two-column layout. +<li> in the right margin for one-sided layout (option <code>oneside</code>, see <a href="#Document-class-options">Document class options</a>); +</li><li> in the outside margin for two-sided layout (option <code>twoside</code>, see <a href="#Document-class-options">Document class options</a>); +</li><li> in the nearest margin for two-column layout (option <code>twocolumn</code>, see <a href="#Document-class-options">Document class options</a>). </li></ul> <a name="index-_005creversemarginpar"></a> @@ -5789,7 +7629,7 @@ hyphenation there by beginning the node with <code>\hspace{0pt}</code>. </p> <dl compact="compact"> <dt><code>\marginparpush</code> -<a name="index-_005cmarginparpush"></a> +<a name="index-_005cmarginparpush-2"></a> </dt> <dd><p>Minimum vertical space between notes; default ‘<samp>7pt</samp>’ for ‘<samp>12pt</samp>’ documents, ‘<samp>5pt</samp>’ else. @@ -5803,7 +7643,7 @@ hyphenation there by beginning the node with <code>\hspace{0pt}</code>. </p> </dd> <dt><code>\marginparwidth</code> -<a name="index-_005cmarginparwidth"></a> +<a name="index-_005cmarginparwidth-2"></a> </dt> <dd><p>Width of the note itself; default for a one-sided ‘<samp>10pt</samp>’ document is ‘<samp>90pt</samp>’, ‘<samp>83pt</samp>’ for ‘<samp>11pt</samp>’, and ‘<samp>68pt</samp>’ for @@ -5825,13 +7665,14 @@ Next: <a href="#Modes" accesskey="n" rel="next">Modes</a>, Previous: <a href="#M </div> <a name="Math-formulas-1"></a> <h2 class="chapter">16 Math formulas</h2> + <a name="index-math-formulas"></a> <a name="index-formulas_002c-math"></a> <a name="index-math-mode_002c-entering"></a> - <a name="index-math-environment-1"></a> <a name="index-displaymath-environment-1"></a> <a name="index-equation-environment-1"></a> + <p>There are three environments that put LaTeX in math mode: </p> <dl compact="compact"> @@ -5879,8 +7720,9 @@ it too is used <em>outside</em> of math mode. <a name="index-_005cdisplaystyle"></a> <p>The <code>\displaystyle</code> declaration forces the size and style of the formula to be that of <code>displaymath</code>, e.g., with limits above and -below summations. For example -</p><div class="example"> +below summations. For example: +</p> +<div class="example"> <pre class="example">$\displaystyle \sum_{n=0}^\infty x_n $ </pre></div> @@ -5909,18 +7751,48 @@ Next: <a href="#Math-symbols" accesskey="n" rel="next">Math symbols</a>, Up: <a </div> <a name="Subscripts-_0026-superscripts-1"></a> <h3 class="section">16.1 Subscripts & superscripts</h3> + <a name="index-superscript"></a> <a name="index-subscript"></a> <a name="index-exponent"></a> <a name="index-_005f"></a> <a name="index-_005e"></a> -<p>To get an expression <i>exp</i> to appear as a subscript, you just type -<code>_{</code><i>exp</i><code>}</code>. To get <i>exp</i> to appear as a -superscript, you type <code>^{</code><i>exp</i><code>}</code>. LaTeX handles -superscripted superscripts and all of that stuff in the natural way. -It even does the right thing when something has both a subscript and a -superscript. +<p>In math mode, use the caret character <code>^</code> to make the +<var>exp</var> appear as a superscript, ie. type <code>^{<var>exp</var>}</code>. +Similarly, in math mode, underscore <code>_{<var>exp</var>}</code> makes a +subscript out of <var>exp</var>. +</p> +<p>In this example the <code>0</code> and <code>1</code> appear as subscripts while the +<code>2</code> is a superscript. +</p> +<div class="example"> +<pre class="example">\( (x_0+x_1)^2 \) +</pre></div> + +<p>To have more than one character in <var>exp</var> use curly braces as in +<code>e^{-2x}</code>. +</p> +<p>LaTeX handles superscripts on superscripts, and all of that stuff, in +the natural way, so expressions such as <code>e^{x^2}</code> and +<code>x_{a_0}</code> will look right. It also does the right thing when +something has both a subscript and a superscript. In this example the +<code>0</code> appears at the bottom of the integral sign while the <code>10</code> +appears at the top. +</p> +<div class="example"> +<pre class="example">\int_0^{10} x^2 \,dx +</pre></div> + +<p>You can put a superscript or subscript before a symbol with a construct +such as <code>{}_t K^2</code> in math mode (the initial <code>{}</code> prevents +the prefixed subscript from being attached to any prior symbols in the +expression). +</p> +<p>Outside of math mode, a construct like <code>A +test$_\textnormal{subscript}$</code> will produce a subscript typeset in +text mode, not math mode. Note that there are packages specialized for +writing Chemical formulas such as <samp>mhchem</samp>. </p> <hr> @@ -5931,1260 +7803,1503 @@ Next: <a href="#Math-functions" accesskey="n" rel="next">Math functions</a>, Pre </div> <a name="Math-symbols-1"></a> <h3 class="section">16.2 Math symbols</h3> + <a name="index-math-symbols"></a> <a name="index-symbols_002c-math"></a> <a name="index-greek-letters"></a> -<p>LaTeX provides almost any mathematical symbol you’re likely to -need. The commands for generating them can be used only in math mode. +<p>LaTeX provides almost any mathematical symbol you’re likely to need. For example, if you include <code>$\pi$</code> in your source, you will get -the pi symbol (<em>\pi</em>) in your output. +the pi symbol π. +</p> +<p>Below is a list of commonly-available symbols. It is by no means an +exhaustive list. Each symbol here is described with a short phrase, and +its symbol class (which determines the spacing around it) is given in +parenthesis. The commands for these symbols can be used only in math +mode. </p> + <dl compact="compact"> <dt><code>\|</code> <a name="index-_005c_007c"></a> </dt> -<dd><p><em>\|</em> +<dd><p>∥ Parallel (relation). Synonym: <code>\parallel</code>. </p> </dd> <dt><code>\aleph</code> <a name="index-_005caleph"></a> </dt> -<dd><p><em>\aleph</em> +<dd><p>ℵ Aleph, transfinite cardinal (ordinary). </p> </dd> <dt><code>\alpha</code> <a name="index-_005calpha"></a> </dt> -<dd><p><em>\alpha</em> +<dd><p>α Lower case Greek letter alpha (ordinary). </p> </dd> <dt><code>\amalg</code> <a name="index-_005camalg"></a> </dt> -<dd><p><em>\amalg</em> (binary operation) +<dd><p>⨿ Disjoint union (binary) </p> </dd> <dt><code>\angle</code> <a name="index-_005cangle"></a> </dt> -<dd><p><em>\angle</em> +<dd><p>∠ Geometric angle (ordinary). Similar: less-than +sign <code><</code> and angle bracket <code>\langle</code>. </p> </dd> <dt><code>\approx</code> <a name="index-_005capprox"></a> </dt> -<dd><p><em>\approx</em> (relation) +<dd><p>≈ Almost equal to (relation). </p> </dd> <dt><code>\ast</code> <a name="index-_005cast"></a> </dt> -<dd><p><em>\ast</em> (binary operation) +<dd><p>∗ Asterisk operator, convolution, six-pointed +(binary). Synonym: <code>*</code>, which is often a superscript or +subscript, as in the Kleene star. Similar: <code>\star</code>, which is +five-pointed, and is sometimes used as a general binary operation, and +sometimes reserved for cross-correlation. </p> </dd> <dt><code>\asymp</code> <a name="index-_005casymp"></a> </dt> -<dd><p><em>\asymp</em> (relation) +<dd><p>≍ Asymptomatically equivalent (relation). </p> </dd> <dt><code>\backslash</code> <a name="index-_005cbackslash"></a> </dt> -<dd><p>\ (delimiter) +<dd><p>\ Backslash (ordinary). Similar: set minus <code>\setminus</code>, and +<code>\textbackslash</code> for backslash outside of math mode. </p> </dd> <dt><code>\beta</code> <a name="index-_005cbeta"></a> </dt> -<dd><p><em>\beta</em> +<dd><p>β Lower case Greek letter beta (ordinary). </p> </dd> <dt><code>\bigcap</code> <a name="index-_005cbigcap"></a> </dt> -<dd><p><em>\bigcap</em> +<dd><p>⋂ Variable-sized, or n-ary, intersection (operator). Similar: +binary intersection <code>\cap</code>. </p> </dd> <dt><code>\bigcirc</code> <a name="index-_005cbigcirc"></a> </dt> -<dd><p><em>\bigcirc</em> (binary operation) +<dd><p>⚪ Circle, larger (binary). Similar: function +composition <code>\circ</code>. </p> </dd> <dt><code>\bigcup</code> <a name="index-_005cbigcup"></a> </dt> -<dd><p><em>\bigcup</em> +<dd><p>⋃ Variable-sized, or n-ary, union (operator). Similar: binary +union <code>\cup</code>. </p> </dd> <dt><code>\bigodot</code> <a name="index-_005cbigodot"></a> </dt> -<dd><p><em>\bigodot</em> +<dd><p>⨀ Variable-sized, or n-ary, circled dot operator (operator). </p> </dd> <dt><code>\bigoplus</code> <a name="index-_005cbigoplus"></a> </dt> -<dd><p><em>\bigoplus</em> +<dd><p>⨁ Variable-sized, or n-ary, circled plus operator (operator). </p> </dd> <dt><code>\bigotimes</code> <a name="index-_005cbigotimes"></a> </dt> -<dd><p><em>\bigotimes</em> +<dd><p>⨂ Variable-sized, or n-ary, circled times operator (operator). </p> </dd> <dt><code>\bigtriangledown</code> <a name="index-_005cbigtriangledown"></a> </dt> -<dd><p><em>\bigtriangledown</em> (binary operation) +<dd><p>▽ Variable-sized, or n-ary, open triangle pointing down +(operator). </p> </dd> <dt><code>\bigtriangleup</code> <a name="index-_005cbigtriangleup"></a> </dt> -<dd><p><em>\bigtriangleup</em> (binary operation) +<dd><p>△ Variable-sized, or n-ary, open triangle pointing up (operator). </p> </dd> <dt><code>\bigsqcup</code> <a name="index-_005cbigsqcup"></a> </dt> -<dd><p><em>\bigsqcup</em> +<dd><p>⨆ Variable-sized, or n-ary, square union (operator). </p> </dd> <dt><code>\biguplus</code> <a name="index-_005cbiguplus"></a> </dt> -<dd><p><em>\biguplus</em> +<dd><p>⨄ Variable-sized, or n-ary, union operator with a plus +(operator). (Note that the name has only one p.) </p> </dd> -<dt><code>\bigcap</code> -<a name="index-_005cbigcap-1"></a> +<dt><code>\bigvee</code> +<a name="index-_005cbigvee"></a> </dt> -<dd><p><em>\bigvee</em> +<dd><p>⋁ Variable-sized, or n-ary, logical-and (operator). </p> </dd> <dt><code>\bigwedge</code> <a name="index-_005cbigwedge"></a> </dt> -<dd><p><em>\bigwedge</em> +<dd><p>⋀ Variable-sized, or n-ary, logical-or (operator). </p> </dd> <dt><code>\bot</code> <a name="index-_005cbot"></a> </dt> -<dd><p><em>\bot</em> +<dd><p>⊥ Up tack, bottom, least element of a poset, or a contradiction +(ordinary). See also <code>\top</code>. </p> </dd> <dt><code>\bowtie</code> <a name="index-_005cbowtie"></a> </dt> -<dd><p><em>\bowtie</em> (relation) +<dd><p>⋈ Natural join of two relations (relation). </p> </dd> <dt><code>\Box</code> <a name="index-_005cBox"></a> </dt> -<dd><p>(square open box symbol) </p> +<dd><p>□ Modal operator for necessity; square open box (ordinary). This +is not available in Plain TeX. In LaTeX you need to load the +<samp>amssymb</samp> package. +</p> </dd> <dt><code>\bullet</code> <a name="index-_005cbullet"></a> </dt> <dd><a name="index-bullet-symbol"></a> -<p><em>\bullet</em> (binary operation) +<p>• Bullet (binary). Similar: multiplication +dot <code>\cdot</code>. </p> </dd> <dt><code>\cap</code> <a name="index-_005ccap"></a> </dt> -<dd><p><em>\cap</em> (binary operation) +<dd><p>∩ Intersection of two sets (binary). Similar: variable-sized +operator <code>\bigcap</code>. </p> </dd> <dt><code>\cdot</code> <a name="index-_005ccdot"></a> </dt> -<dd><p><em>\cdot</em> (binary operation) +<dd><p>⋅ Multiplication (binary). Similar: Bullet +dot <code>\bullet</code>. </p> </dd> <dt><code>\chi</code> <a name="index-_005cchi"></a> </dt> -<dd><p><em>\chi</em> +<dd><p>χ Lower case Greek chi (ordinary). </p> </dd> <dt><code>\circ</code> <a name="index-_005ccirc"></a> </dt> -<dd><p><em>\circ</em> (binary operation) +<dd><p>∘ Function composition, ring operator (binary). Similar: +variable-sized operator <code>\bigcirc</code>. </p> </dd> <dt><code>\clubsuit</code> <a name="index-_005cclubsuit"></a> </dt> -<dd><p><em>\clubsuit</em> +<dd><p>♣ Club card suit (ordinary). +</p> +</dd> +<dt><code>\complement</code> +<a name="index-_005ccomplement"></a> +</dt> +<dd><p>∁ Set complement, used as a superscript as in +<code>$S^\complement$</code> (ordinary). This is not available in Plain +TeX. In LaTeX you should load the <samp>amssymb</samp> package. Also +used: <code>$S^{\mathsf{c}}$</code> or <code>$\bar{S}$</code>. </p> </dd> <dt><code>\cong</code> <a name="index-_005ccong"></a> </dt> -<dd><p><em>\cong</em> (relation) +<dd><p>≅ Congruent (relation). </p> </dd> <dt><code>\coprod</code> <a name="index-_005ccoprod"></a> </dt> -<dd><p><em>\coprod</em> +<dd><p>∐ Coproduct (operator). </p> </dd> <dt><code>\cup</code> <a name="index-_005ccup"></a> </dt> -<dd><p><em>\cup</em> (binary operation) +<dd><p>∪ Union of two sets (binary). Similar: variable-sized +operator <code>\bigcup</code>. </p> </dd> <dt><code>\dagger</code> <a name="index-_005cdagger"></a> </dt> -<dd><p><em>\dagger</em> (binary operation) +<dd><p>† Dagger relation (binary). </p> </dd> <dt><code>\dashv</code> <a name="index-_005cdashv"></a> </dt> -<dd><p><em>\dashv</em> (relation) +<dd><p>⊣ Dash with vertical, reversed turnstile (relation). Similar: +turnstile <code>\vdash</code>. </p> </dd> <dt><code>\ddagger</code> <a name="index-_005cddagger"></a> </dt> -<dd><p><em>\dagger</em> (binary operation) +<dd><p>‡ Double dagger relation (binary). </p> </dd> <dt><code>\Delta</code> <a name="index-_005cDelta"></a> </dt> -<dd><p><em>\Delta</em> +<dd><p>Δ Greek upper case delta, used for increment (ordinary). </p> </dd> <dt><code>\delta</code> <a name="index-_005cdelta"></a> </dt> -<dd><p><em>\delta</em> +<dd><p>δ Greek lower case delta (ordinary). </p> </dd> <dt><code>\Diamond</code> <a name="index-_005cDiamond"></a> </dt> -<dd><p>bigger <em>\diamond</em> </p> +<dd><p>◇ Large diamond operator (ordinary). This is not available in +Plain TeX. In LaTeX you must load the <samp>amssymb</samp> package. +</p> </dd> <dt><code>\diamond</code> <a name="index-_005cdiamond"></a> </dt> -<dd><p><em>\diamond</em> (binary operation) +<dd><p>⋄ Diamond operator, or diamond bullet (binary). Similar: large +diamond <code>\Diamond</code>, circle bullet <code>\bullet</code>. </p> </dd> <dt><code>\diamondsuit</code> <a name="index-_005cdiamondsuit"></a> </dt> -<dd><p><em>\diamondsuit</em> +<dd><p>♢ Diamond card suit (ordinary). </p> </dd> <dt><code>\div</code> <a name="index-_005cdiv"></a> </dt> -<dd><p><em>\div</em> (binary operation) +<dd><p>÷ Division sign (binary). </p> </dd> <dt><code>\doteq</code> <a name="index-_005cdoteq"></a> </dt> -<dd><p><em>\doteq</em> (relation) +<dd><p>≐ Approaches the limit (relation). Similar: geometrically equal +to <code>\Doteq</code>. </p> </dd> <dt><code>\downarrow</code> <a name="index-_005cdownarrow"></a> </dt> -<dd><p><em>\downarrow</em> (delimiter) +<dd><p>↓ Down arrow, converges (relation). Similar: double line down +arrow <code>\Downarrow</code>. </p> </dd> <dt><code>\Downarrow</code> <a name="index-_005cDownarrow"></a> </dt> -<dd><p><em>\Downarrow</em> (delimiter) +<dd><p>⇓ Double line down arrow (relation). Similar: single line down +arrow <code>\downarrow</code>. </p> </dd> <dt><code>\ell</code> <a name="index-_005cell"></a> </dt> -<dd><p><em>\ell</em> +<dd><p>ℓ Lower-case cursive letter l (ordinary). </p> </dd> <dt><code>\emptyset</code> <a name="index-_005cemptyset"></a> </dt> -<dd><p><em>\emptyset</em> +<dd><p>∅ Empty set symbol (ordinary). Similar: reversed empty +set <code>\varnothing</code>. </p> </dd> <dt><code>\epsilon</code> <a name="index-_005cepsilon"></a> </dt> -<dd><p><em>\epsilon</em> +<dd><p>ϵ Lower case Greek-text letter (ordinary). More widely used in +mathematics is the curly epsilon +<code>\varepsilon</code> ε. Related: the set membership relation +<code>\in</code> ∈. </p> </dd> <dt><code>\equiv</code> <a name="index-_005cequiv"></a> </dt> -<dd><p><em>\equiv</em> (relation) +<dd><p>≡ Equivalence (relation). </p> </dd> <dt><code>\eta</code> <a name="index-_005ceta"></a> </dt> -<dd><p><em>\eta</em> +<dd><p>η Lower case Greek letter (ordinary). </p> </dd> <dt><code>\exists</code> <a name="index-_005cexists"></a> </dt> -<dd><p><em>\exists</em> +<dd><p>∃ Existential quantifier (ordinary). </p> </dd> <dt><code>\flat</code> <a name="index-_005cflat"></a> </dt> -<dd><p><em>\flat</em> +<dd><p>♭ Musical flat (ordinary). </p> </dd> <dt><code>\forall</code> <a name="index-_005cforall"></a> </dt> -<dd><p><em>\forall</em> +<dd><p>∀ Universal quantifier (ordinary). </p> </dd> <dt><code>\frown</code> <a name="index-_005cfrown"></a> </dt> -<dd><p><em>\frown</em> (relation) +<dd><p>⌢ Downward curving arc (ordinary). </p> </dd> <dt><code>\Gamma</code> <a name="index-_005cGamma"></a> </dt> -<dd><p><em>\Gamma</em> +<dd><p>Γ Upper case Greek letter (ordinary). </p> </dd> <dt><code>\gamma</code> <a name="index-_005cgamma"></a> </dt> -<dd><p><em>\gamma</em> +<dd><p>γ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\ge</code> <a name="index-_005cge"></a> </dt> -<dd><p><em>\ge</em> +<dd><p>≥ Greater than or equal to (relation). This is a synonym +for <code>\geq</code>. </p> </dd> <dt><code>\geq</code> <a name="index-_005cgeq"></a> </dt> -<dd><p><em>\geq</em> (relation) +<dd><p>≥ Greater than or equal to (relation). This is a synonym +for <code>\ge</code>. </p> </dd> <dt><code>\gets</code> <a name="index-_005cgets"></a> </dt> -<dd><p><em>\gets</em> +<dd><p>← Is assigned the value (relation). +Synonym: <code>\leftarrow</code>. </p> </dd> <dt><code>\gg</code> <a name="index-_005cgg"></a> </dt> -<dd><p><em>\gg</em> (relation) +<dd><p>≫ Much greater than (relation). Similar: much less +than <code>\ll</code>. </p> </dd> <dt><code>\hbar</code> <a name="index-_005chbar"></a> </dt> -<dd><p><em>\hbar</em> +<dd><p>ℏ Planck constant over two pi (ordinary). </p> </dd> <dt><code>\heartsuit</code> <a name="index-_005cheartsuit"></a> </dt> -<dd><p><em>\heartsuit</em> +<dd><p>♡ Heart card suit (ordinary). </p> </dd> <dt><code>\hookleftarrow</code> <a name="index-_005chookleftarrow"></a> </dt> -<dd><p><em>\hookleftarrow</em> +<dd><p>↩ Hooked left arrow (relation). </p> </dd> <dt><code>\hookrightarrow</code> <a name="index-_005chookrightarrow"></a> </dt> -<dd><p><em>\hookrightarrow</em> +<dd><p>↪ Hooked right arrow (relation). </p> </dd> <dt><code>\iff</code> <a name="index-_005ciff"></a> </dt> -<dd><p><em>\iff</em> +<dd><p>⟷ If and only if (relation). It is <code>\Longleftrightarrow</code> +with a <code>\thickmuskip</code> on either side. </p> </dd> <dt><code>\Im</code> <a name="index-_005cIm"></a> </dt> -<dd><p><em>\Im</em> +<dd><p>ℑ Imaginary part (ordinary). See: real part <code>\Re</code>. </p> </dd> <dt><code>\in</code> <a name="index-_005cin"></a> </dt> -<dd><p><em>\in</em> (relation) +<dd><p>∈ Set element (relation). See also: lower case Greek letter +epsilon <code>\epsilon</code>ϵ and rounded small +epsilon <code>\varepsilon</code>. </p> </dd> <dt><code>\infty</code> <a name="index-_005cinfty"></a> </dt> -<dd><p><em>\infty</em> +<dd><p>∞ Infinity (ordinary). </p> </dd> <dt><code>\int</code> <a name="index-_005cint"></a> </dt> -<dd><p><em>\int</em> +<dd><p>∫ Integral (operator). </p> </dd> <dt><code>\iota</code> <a name="index-_005ciota"></a> </dt> -<dd><p><em>\iota</em> +<dd><p>ι Lower case Greek letter (ordinary). </p> </dd> <dt><code>\Join</code> <a name="index-_005cJoin"></a> </dt> -<dd><p>condensed bowtie symbol (relation) </p> +<dd><p>⨝ Condensed bowtie symbol (relation). Not available in Plain +TeX. +</p> </dd> <dt><code>\kappa</code> <a name="index-_005ckappa"></a> </dt> -<dd><p><em>\kappa</em> +<dd><p>κ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\Lambda</code> <a name="index-_005cLambda"></a> </dt> -<dd><p><em>\Lambda</em> +<dd><p>Λ Upper case Greek letter (ordinary). </p> </dd> <dt><code>\lambda</code> <a name="index-_005clambda"></a> </dt> -<dd><p><em>\lambda</em> +<dd><p>λ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\land</code> <a name="index-_005cland"></a> </dt> -<dd><p><em>\land</em> +<dd><p>∧ Logical and (binary). This is a synonym for <code>\wedge</code>. +See also logical or <code>\lor</code>. </p> </dd> <dt><code>\langle</code> <a name="index-_005clangle"></a> </dt> -<dd><p><em>\langle</em> (delimiter) +<dd><p>⟨ Left angle, or sequence, bracket (opening). Similar: +less-than <code><</code>. Matches <code>\rangle</code>. </p> </dd> <dt><code>\lbrace</code> <a name="index-_005clbrace"></a> </dt> -<dd><p><em>\lbrace</em> (delimiter) +<dd><p>{ Left curly brace +(opening). Synonym: <code>\{</code>. Matches <code>\rbrace</code>. </p> </dd> <dt><code>\lbrack</code> <a name="index-_005clbrack"></a> </dt> -<dd><p><em>\lbrack</em> (delimiter) +<dd><p>[ Left square bracket (opening). +Synonym: <code>[</code>. Matches <code>\rbrack</code>. </p> </dd> <dt><code>\lceil</code> <a name="index-_005clceil"></a> </dt> -<dd><p><em>\lceil</em> (delimiter) +<dd><p>⌈ Left ceiling bracket, like a square bracket but with the bottom +shaved off (opening). Matches <code>\rceil</code>. </p> </dd> <dt><code>\le</code> <a name="index-_005cle"></a> </dt> -<dd><p><em>\le</em> +<dd><p>≤ Less than or equal to (relation). This is a synonym +for <code>\leq</code>. </p> </dd> <dt><code>\leadsto</code> <a name="index-_005cleadsto"></a> </dt> +<dd><p>⇝ Squiggly right arrow (relation). This is not available in +Plain TeX. In LaTeX you should load the <samp>amssymb</samp> package. +To get this symbol outside of math mode you can put +<code>\newcommand*{\Leadsto}{\ensuremath{\leadsto}}</code> in the +preamble and then use <code>\Leadsto</code> instead. +</p> +</dd> <dt><code>\Leftarrow</code> <a name="index-_005cLeftarrow"></a> </dt> -<dd><p><em>\Leftarrow</em> +<dd><p>⇐ Is implied by, double-line left arrow (relation). Similar: +single-line left arrow <code>\leftarrow</code>. </p> </dd> <dt><code>\leftarrow</code> <a name="index-_005cleftarrow"></a> </dt> -<dd><p><em>\leftarrow</em> +<dd><p>← Single-line left arrow (relation). +Synonym: <code>\gets</code>. Similar: double-line left +arrow <code>\Leftarrow</code>. </p> </dd> <dt><code>\leftharpoondown</code> <a name="index-_005cleftharpoondown"></a> </dt> -<dd><p><em>\leftharpoondown</em> +<dd><p>↽ Single-line left harpoon, barb under bar (relation). </p> </dd> <dt><code>\leftharpoonup</code> <a name="index-_005cleftharpoonup"></a> </dt> -<dd><p><em>\leftharpoonup</em> +<dd><p>↼ Single-line left harpoon, barb over bar (relation). </p> </dd> <dt><code>\Leftrightarrow</code> <a name="index-_005cLeftrightarrow"></a> </dt> -<dd><p><em>\Leftrightarrow</em> +<dd><p>⇔ Bi-implication; double-line double-headed arrow (relation). +Similar: single-line double headed arrow <code>\leftrightarrow</code>. </p> </dd> <dt><code>\leftrightarrow</code> <a name="index-_005cleftrightarrow"></a> </dt> -<dd><p><em>\leftrightarrow</em> +<dd><p>↔ Single-line double-headed arrow (relation). Similar: +double-line double headed arrow <code>\Leftrightarrow</code>. </p> </dd> <dt><code>\leq</code> <a name="index-_005cleq"></a> </dt> -<dd><p><em>\leq</em> (relation) +<dd><p>≤ Less than or equal to (relation). This is a synonym +for <code>\le</code>. </p> </dd> <dt><code>\lfloor</code> <a name="index-_005clfloor"></a> </dt> -<dd><p><em>\lfloor</em> (delimiter) +<dd><p>⌊ Left floor bracket (opening). </p> </dd> <dt><code>\lhd</code> <a name="index-_005clhd"></a> </dt> -<dd><p>(left-pointing arrow head) </p> +<dd><p>◁ Arrowhead, that is, triangle, pointing left (binary). This is +not available in Plain TeX. In LaTeX you should load the +<samp>amssymb</samp> package. For the normal subgroup symbol you should load +<samp>amssymb</samp> and use <code>\vartriangleleft</code> (which is a relation +and so gives better spacing). +</p> </dd> <dt><code>\ll</code> <a name="index-_005cll"></a> </dt> -<dd><p><em>\ll</em> (relation) +<dd><p>≪ Much less than (relation). Similar: much greater +than <code>\gg</code>. </p> </dd> <dt><code>\lnot</code> <a name="index-_005clnot"></a> </dt> -<dd><p><em>\lnot</em> +<dd><p>¬ Logical negation (ordinary). Synonym: <code>\neg</code>. </p> </dd> <dt><code>\longleftarrow</code> <a name="index-_005clongleftarrow"></a> </dt> -<dd><p><em>\longleftarrow</em> +<dd><p>⟵ Long single-line left arrow (relation). Similar: long +double-line left arrow <code>\Longleftarrow</code>. </p> </dd> <dt><code>\longleftrightarrow</code> <a name="index-_005clongleftrightarrow"></a> </dt> -<dd><p><em>\longleftrightarrow</em> +<dd><p>⟷ Long single-line double-headed arrow (relation). Similar: long +double-line double-headed arrow <code>\Longleftrightarrow</code>. </p> </dd> <dt><code>\longmapsto</code> <a name="index-_005clongmapsto"></a> </dt> -<dd><p><em>\longmapsto</em> +<dd><p>⟼ Long single-line left arrow starting with vertical bar +(relation). Similar: shorter version <code>\mapsto</code>. </p> </dd> <dt><code>\longrightarrow</code> <a name="index-_005clongrightarrow"></a> </dt> -<dd><p><em>\longrightarrow</em> +<dd><p>⟶ Long single-line right arrow (relation). Similar: long +double-line right arrow <code>\Longrightarrow</code>. </p> </dd> <dt><code>\lor</code> <a name="index-_005clor"></a> </dt> -<dd><p><em>\lor</em> +<dd><p>∨ Logical or (binary). Synonym: wedge <code>\wedge</code>. </p> </dd> <dt><code>\mapsto</code> <a name="index-_005cmapsto"></a> </dt> -<dd><p><em>\mapsto</em> +<dd><p>↦ Single-line left arrow starting with vertical bar (relation). +Similar: longer version <code>\longmapsto</code>. </p> </dd> <dt><code>\mho</code> <a name="index-_005cmho"></a> </dt> +<dd><p>℧ Conductance, half-circle rotated capital omega (ordinary). +This is not available in Plain TeX. In LaTeX you should load the +<samp>amssymb</samp> package. +</p> +</dd> <dt><code>\mid</code> <a name="index-_005cmid"></a> </dt> -<dd><p><em>\mid</em> (relation) +<dd><p>∣ Single-line vertical bar (relation). A typical use of +<code>\mid</code> is for a set <code>\{\, x \mid x\geq 5 \,\}</code>. +</p> +<p>Similar: <code>\vert</code> and <code>|</code> produce the same single-line +vertical bar symbol but without any spacing (they fall in class +ordinary) and you should not use them as relations but instead only as +ordinals, i.e., footnote symbols. For absolute value, see the entry +for <code>\vert</code> and for norm see the entry for <code>\Vert</code>. </p> </dd> <dt><code>\models</code> <a name="index-_005cmodels"></a> </dt> -<dd><p><em>\models</em> (relation) +<dd><p>⊨ Entails, or satisfies; double turnstile, short double dash +(relation). Similar: long double dash <code>\vDash</code>. </p> </dd> <dt><code>\mp</code> <a name="index-_005cmp"></a> </dt> -<dd><p><em>\mp</em> (binary operation) +<dd><p>∓ Minus or plus (relation). </p> </dd> <dt><code>\mu</code> <a name="index-_005cmu"></a> </dt> -<dd><p><em>\mu</em> +<dd><p>μ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\nabla</code> <a name="index-_005cnabla"></a> </dt> -<dd><p><em>\nabla</em> +<dd><p>∇ Hamilton’s del, or differential, operator (ordinary). </p> </dd> <dt><code>\natural</code> <a name="index-_005cnatural"></a> </dt> -<dd><p><em>\natural</em> +<dd><p>♮ Musical natural notation (ordinary). </p> </dd> <dt><code>\ne</code> <a name="index-_005cne"></a> </dt> -<dd><p><em>\ne</em> +<dd><p>≠ Not equal (relation). Synonym: <code>\neq</code>. </p> </dd> <dt><code>\nearrow</code> <a name="index-_005cnearrow"></a> </dt> -<dd><p><em>\nearrow</em> +<dd><p>↗ North-east arrow (relation). </p> </dd> <dt><code>\neg</code> <a name="index-_005cneg"></a> </dt> -<dd><p><em>\neg</em> +<dd><p>¬ Logical negation (ordinary). +Synonym: <code>\lnot</code>. Sometimes instead used for +negation: <code>\sim</code>. </p> </dd> <dt><code>\neq</code> <a name="index-_005cneq"></a> </dt> -<dd><p><em>\neq</em> (relation) +<dd><p>≠ Not equal (relation). Synonym: <code>\ne</code>. </p> </dd> <dt><code>\ni</code> <a name="index-_005cni"></a> </dt> -<dd><p><em>\ni</em> (relation) +<dd><p>∋ Reflected membership epsilon; has the member +(relation). Synonym: <code>\owns</code>. Similar: is a member +of <code>\in</code>. </p> </dd> <dt><code>\not</code> <a name="index-_005cnot"></a> </dt> -<dd><p>Overstrike a following operator with a /, as in <em>\not=</em>. +<dd><p>  ̸ Long solidus, or slash, used to overstrike a +following operator (relation). +</p> +<p>Many negated operators that don’t require <code>\not</code> are available, +particularly with the <samp>amssymb</samp> package. For example, <code>\notin</code> +is probably typographically preferable to <code>\not\in</code>. </p> </dd> <dt><code>\notin</code> <a name="index-_005cnotin"></a> </dt> -<dd><p><em>\ni</em> +<dd><p>∉ Not an element of (relation). Similar: not subset +of <code>\nsubseteq</code>. </p> </dd> <dt><code>\nu</code> <a name="index-_005cnu"></a> </dt> -<dd><p><em>\nu</em> +<dd><p>ν Lower case Greek letter (ordinary). </p> </dd> <dt><code>\nwarrow</code> <a name="index-_005cnwarrow"></a> </dt> -<dd><p><em>\nwarrow</em> +<dd><p>↖ North-west arrow (relation). </p> </dd> <dt><code>\odot</code> <a name="index-_005codot"></a> </dt> -<dd><p><em>\odot</em> (binary operation) +<dd><p>⊙ Dot inside a circle (binary). Similar: variable-sized +operator <code>\bigodot</code>. </p> </dd> <dt><code>\oint</code> <a name="index-_005coint"></a> </dt> -<dd><p><em>\oint</em> +<dd><p>∮ Contour integral, integral with circle in the middle (operator). </p> </dd> <dt><code>\Omega</code> <a name="index-_005cOmega"></a> </dt> -<dd><p><em>\Omega</em> +<dd><p>Ω Upper case Greek letter (ordinary). </p> </dd> <dt><code>\omega</code> <a name="index-_005comega"></a> </dt> -<dd><p><em>\omega</em> +<dd><p>ω Lower case Greek letter (ordinary). </p> </dd> <dt><code>\ominus</code> <a name="index-_005cominus"></a> </dt> -<dd><p><em>\ominus</em> (binary operation) +<dd><p>⊖ Minus sign, or dash, inside a circle (binary). </p> </dd> <dt><code>\oplus</code> <a name="index-_005coplus"></a> </dt> -<dd><p><em>\oplus</em> (binary operation) +<dd><p>⊕ Plus sign inside a circle (binary). Similar: variable-sized +operator <code>\bigoplus</code>. </p> </dd> <dt><code>\oslash</code> <a name="index-_005coslash"></a> </dt> -<dd><p><em>\oslash</em> (binary operation) +<dd><p>⊘ Solidus, or slash, inside a circle (binary). </p> </dd> <dt><code>\otimes</code> <a name="index-_005cotimes"></a> </dt> -<dd><p><em>\otimes</em> (binary operation) +<dd><p>⊗ Times sign, or cross, inside a circle (binary). Similar: +variable-sized operator <code>\bigotimes</code>. </p> </dd> <dt><code>\owns</code> <a name="index-_005cowns"></a> </dt> -<dd><p><em>\owns</em> +<dd><p>∋ Reflected membership epsilon; has the member +(relation). Synonym: <code>\ni</code>. Similar: is a member +of <code>\in</code>. </p> </dd> <dt><code>\parallel</code> <a name="index-_005cparallel"></a> </dt> -<dd><p><em>\parallel</em> (relation) +<dd><p>∥ Parallel (relation). Synonym: <code>\|</code>. </p> </dd> <dt><code>\partial</code> <a name="index-_005cpartial"></a> </dt> -<dd><p><em>\partial</em> +<dd><p>∂ Partial differential (ordinary). </p> </dd> <dt><code>\perp</code> <a name="index-_005cperp"></a> </dt> -<dd><p><em>\perp</em> (relation) +<dd><p>⟂ Perpendicular (relation). Similar: <code>\bot</code> uses the +same glyph but the spacing is different because it is in the class +ordinary. </p> </dd> <dt><code>\phi</code> <a name="index-_005cphi"></a> </dt> -<dd><p><em>\phi</em> +<dd><p>ϕ Lower case Greek letter (ordinary). The variant form is +<code>\varphi</code> φ. </p> </dd> <dt><code>\Pi</code> <a name="index-_005cPi"></a> </dt> -<dd><p><em>\Pi</em> +<dd><p>Π Upper case Greek letter (ordinary). </p> </dd> <dt><code>\pi</code> <a name="index-_005cpi"></a> </dt> -<dd><p><em>\pi</em> +<dd><p>π Lower case Greek letter (ordinary). The variant form is +<code>\varpi</code> ϖ. </p> </dd> <dt><code>\pm</code> <a name="index-_005cpm"></a> </dt> -<dd><p><em>\pm</em> (binary operation) +<dd><p>± Plus or minus (binary). </p> </dd> <dt><code>\prec</code> <a name="index-_005cprec"></a> </dt> -<dd><p><em>\prec</em> (relation) +<dd><p>≺ Preceeds (relation). Similar: less than <code><</code>. </p> </dd> <dt><code>\preceq</code> <a name="index-_005cpreceq"></a> </dt> -<dd><p><em>\preceq</em> (relation) +<dd><p>⪯ Preceeds or equals (relation). Similar: less than or +equals <code>\leq</code>. </p> </dd> <dt><code>\prime</code> <a name="index-_005cprime"></a> </dt> -<dd><p><em>\prime</em> +<dd><p>′ Prime, or minute in a time expression (ordinary). Typically +used as a superscript <code>$A^\prime$</code>. Note that <code>$f^\prime$</code> +and <code>$f'$</code> produce the same result. An advantage of the second is +that <code>$f'''$</code> produces the the desired symbol, that is, the same +result as <code>$f^{\prime\prime\prime}$</code>, but uses somewhat less +typing. Note that you can only use <code>\prime</code> in math mode but you +can type right single quote <code>'</code> in text mode also, although it +resuts in a different look than in math mode. </p> </dd> <dt><code>\prod</code> <a name="index-_005cprod"></a> </dt> -<dd><p><em>\prod</em> +<dd><p>∏ Product (operator). </p> </dd> <dt><code>\propto</code> <a name="index-_005cpropto"></a> </dt> -<dd><p><em>\propto</em> (relation) +<dd><p>∝ Is proportional to (relation) </p> </dd> <dt><code>\Psi</code> <a name="index-_005cPsi"></a> </dt> -<dd><p><em>\Psi</em> +<dd><p>Ψ Upper case Greek letter (ordinary). </p> </dd> <dt><code>\psi</code> <a name="index-_005cpsi"></a> </dt> -<dd><p><em>\psi</em> +<dd><p>ψ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\rangle</code> <a name="index-_005crangle"></a> </dt> -<dd><p><em>\rangle</em> (delimiter) +<dd><p>➹ Right angle, or sequence, bracket (closing). Similar: greater +than <code>></code>. Matches:<code>\langle</code>. </p> </dd> <dt><code>\rbrace</code> <a name="index-_005crbrace"></a> </dt> -<dd><p><em>\rbrace</em> (delimiter) +<dd><p>} Right curly brace +(closing). Synonym: <code>\}</code>. Matches <code>\lbrace</code>. </p> </dd> <dt><code>\rbrack</code> <a name="index-_005crbrack"></a> </dt> -<dd><p><em>\rbrack</em> (delimiter) +<dd><p>] Right square bracket +(closing). Synonym: <code>]</code>. Matches <code>\lbrack</code>. </p> </dd> <dt><code>\rceil</code> <a name="index-_005crceil"></a> </dt> -<dd><p><em>\rceil</em> (delimiter) +<dd><p>⌉ Right ceiling bracket (closing). Matches <code>\lceil</code>. </p> </dd> <dt><code>\Re</code> <a name="index-_005cRe"></a> </dt> -<dd><p><em>\Re</em> +<dd><p>ℜ Real part, real numbers, cursive capital R (ordinary). Related: +double-line, or blackboard bold, R <code>\mathbb{R}</code>; to access +this, load the <samp>amsfonts</samp> package. +</p> +</dd> +<dt><code>\restriction</code> +<a name="index-_005crestriction"></a> +</dt> +<dd><p>↾ Restriction of a function +(relation). Synonym: <code>\upharpoonright</code>. Not available in +Plain TeX. In LaTeX you should load the <samp>amssymb</samp> package. </p> </dd> <dt><code>\rfloor</code> <a name="index-_005crfloor"></a> </dt> -<dd><p><em>\rfloor</em> +<dd><p>⌋ Right floor bracket, a right square bracket with the top cut +off (closing). Matches <code>\lfloor</code>. </p> </dd> <dt><code>\rhd</code> <a name="index-_005crhd"></a> </dt> -<dd><p>(binary operation) </p> +<dd><p>◁ Arrowhead, that is, triangle, pointing right (binary). This is +not available in Plain TeX. In LaTeX you should load the +<samp>amssymb</samp> package. For the normal subgroup symbol you should +instead load <samp>amssymb</samp> and use <code>\vartriangleright</code> (which +is a relation and so gives better spacing). +</p> </dd> <dt><code>\rho</code> <a name="index-_005crho"></a> </dt> -<dd><p><em>\rho</em> +<dd><p>ρ Lower case Greek letter (ordinary). The variant form is +<code>\varrho</code> ϱ. </p> </dd> <dt><code>\Rightarrow</code> <a name="index-_005cRightarrow"></a> </dt> -<dd><p><em>\Rightarrow</em> +<dd><p>⇒ Implies, right-pointing double line arrow (relation). Similar: +right single-line arrow <code>\rightarrow</code>. </p> </dd> <dt><code>\rightarrow</code> <a name="index-_005crightarrow"></a> </dt> -<dd><p><em>\rightarrow</em> +<dd><p>→ Right-pointing single line arrow (relation). Synonym: <code>\to</code>. Similar: right double line arrow <code>\Rightarrow</code>. </p> </dd> <dt><code>\rightharpoondown</code> <a name="index-_005crightharpoondown"></a> </dt> -<dd><p><em>\rightharpoondown</em> +<dd><p>⇁ Right-pointing harpoon with barb below the line (relation). </p> </dd> <dt><code>\rightharpoonup</code> <a name="index-_005crightharpoonup"></a> </dt> -<dd><p><em>\rightharpoonup</em> +<dd><p>⇀ Right-pointing harpoon with barb above the line (relation). </p> </dd> <dt><code>\rightleftharpoons</code> <a name="index-_005crightleftharpoons"></a> </dt> -<dd><p><em>\rightleftharpoons</em> +<dd><p>⇌ Right harpoon up above left harpoon down (relation). </p> </dd> <dt><code>\searrow</code> <a name="index-_005csearrow"></a> </dt> -<dd><p><em>\searrow</em> +<dd><p>↘ Arrow pointing southeast (relation). </p> </dd> <dt><code>\setminus</code> <a name="index-_005csetminus"></a> </dt> -<dd><p><em>\setminus</em> (binary operation) +<dd><p>⧵ Set difference, reverse solidus or slash, like \ +(binary). Similar: backslash <code>\backslash</code> and also +<code>\textbackslash</code> outside of math mode. </p> </dd> <dt><code>\sharp</code> <a name="index-_005csharp"></a> </dt> -<dd><p><em>\sharp</em> +<dd><p>♯ Musical sharp (ordinary). </p> </dd> <dt><code>\Sigma</code> <a name="index-_005cSigma"></a> </dt> -<dd><p><em>\Sigma</em> +<dd><p>Σ Upper case Greek letter (ordinary). </p> </dd> <dt><code>\sigma</code> <a name="index-_005csigma"></a> </dt> -<dd><p><em>\sigma</em> +<dd><p>σ Lower case Greek letter (ordinary). The variant form is +<code>\varsigma</code> ς. </p> </dd> <dt><code>\sim</code> <a name="index-_005csim"></a> </dt> -<dd><p><em>\sim</em> (relation) +<dd><p>∼ Similar, in a relation (relation). </p> </dd> <dt><code>\simeq</code> <a name="index-_005csimeq"></a> </dt> -<dd><p><em>\simeq</em> (relation) +<dd><p>≃ Similar or equal to, in a relation (relation). </p> </dd> <dt><code>\smallint</code> <a name="index-_005csmallint"></a> </dt> -<dd><p><em>\smallint</em> +<dd><p>∫ Integral sign that does not change to a larger size in a +display (operator). </p> </dd> <dt><code>\smile</code> <a name="index-_005csmile"></a> </dt> -<dd><p><em>\smile</em> (relation) +<dd><p>⌣ Upward curving arc (ordinary). </p> </dd> <dt><code>\spadesuit</code> <a name="index-_005cspadesuit"></a> </dt> -<dd><p><em>\spadesuit</em> +<dd><p>♠ Spade card suit (ordinary). </p> </dd> <dt><code>\sqcap</code> <a name="index-_005csqcap"></a> </dt> -<dd><p><em>\sqcap</em> (binary operation) +<dd><p>⊓ Square intersection symbol (binary). Similar: +intersection <code>cap</code>. </p> </dd> <dt><code>\sqcup</code> <a name="index-_005csqcup"></a> </dt> -<dd><p><em>\sqcup</em> (binary operation) +<dd><p>⊔ Square union symbol (binary). Similar: +union <code>cup</code>. Related: variable-sized +operator <code>\bigsqcup</code>. </p> </dd> <dt><code>\sqsubset</code> <a name="index-_005csqsubset"></a> </dt> -<dd><p>(relation) </p> +<dd><p>⊏ Square subset symbol (relation). Similar: +subset <code>\subset</code>. This is not available in Plain TeX. In +LaTeX you should load the <samp>amssymb</samp> package. +</p> </dd> <dt><code>\sqsubseteq</code> <a name="index-_005csqsubseteq"></a> </dt> -<dd><p><em>\sqsubseteq</em> (relation) +<dd><p>⊑ Square subset or equal symbol (binary). Similar: subset or +equal to <code>\subseteq</code>. </p> </dd> <dt><code>\sqsupset</code> <a name="index-_005csqsupset"></a> </dt> -<dd><p>(relation) </p> +<dd><p>⊐ Square superset symbol (relation). Similar: +superset <code>\supset</code>. This is not available in Plain TeX. In +LaTeX you should load the <samp>amssymb</samp> package. +</p> </dd> <dt><code>\sqsupseteq</code> <a name="index-_005csqsupseteq"></a> </dt> -<dd><p><em>\sqsupseteq</em> (relation) +<dd><p>⊒ Square superset or equal symbol (binary). Similar: superset or +equal <code>\supseteq</code>. </p> </dd> <dt><code>\star</code> <a name="index-_005cstar"></a> </dt> -<dd><p><em>\star</em> (binary operation) +<dd><p>⋆ Five-pointed star, sometimes used as a general binary operation +but sometimes reserved for cross-correlation (binary). Similar: the +synonyms asterisk <code>*</code> and <code>\ast</code>, which are six-pointed, +and more often appear as a superscript or subscript, as with the Kleene +star. </p> </dd> <dt><code>\subset</code> <a name="index-_005csubset"></a> </dt> -<dd><p><em>\subset</em> (relation) +<dd><p>⊂ Subset (occasionally, is implied by) (relation). </p> </dd> <dt><code>\subseteq</code> <a name="index-_005csubseteq"></a> </dt> -<dd><p><em>\subseteq</em> (relation) +<dd><p>⊆ Subset or equal to (relation). </p> </dd> <dt><code>\succ</code> <a name="index-_005csucc"></a> </dt> -<dd><p><em>\succ</em> (relation) +<dd><p>≻ Comes after, succeeds (relation). Similar: is less +than <code>></code>. </p> </dd> <dt><code>\succeq</code> <a name="index-_005csucceq"></a> </dt> -<dd><p><em>\succeq</em> (relation) +<dd><p>⪰ Succeeds or is equal to (relation). Similar: less +than or equal to <code>\leq</code>. </p> </dd> <dt><code>\sum</code> <a name="index-_005csum"></a> </dt> -<dd><p><em>\sum</em> +<dd><p>∑ Summation (operator). Similar: Greek capital +sigma <code>\Sigma</code>. </p> </dd> <dt><code>\supset</code> <a name="index-_005csupset"></a> </dt> -<dd><p><em>\supset</em> (relation) +<dd><p>⊃ Superset (relation). </p> </dd> <dt><code>\supseteq</code> <a name="index-_005csupseteq"></a> </dt> -<dd><p><em>\supseteq</em> (relation) +<dd><p>⊇ Superset or equal to (relation). </p> </dd> <dt><code>\surd</code> <a name="index-_005csurd"></a> </dt> -<dd><p><em>\surd</em> +<dd><p>√ Radical symbol (ordinary). The LaTeX command +<code>\sqrt{..}</code> typesets the square root of the argument, with a bar +that extends to cover the argument. </p> </dd> <dt><code>\swarrow</code> <a name="index-_005cswarrow"></a> </dt> -<dd><p><em>\swarrow</em> +<dd><p>↙ Southwest-pointing arrow (relation). </p> </dd> <dt><code>\tau</code> <a name="index-_005ctau"></a> </dt> -<dd><p><em>\tau</em> +<dd><p>τ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\theta</code> <a name="index-_005ctheta"></a> </dt> -<dd><p><em>\theta</em> +<dd><p>θ Lower case Greek letter (ordinary). The variant form is +<code>\vartheta</code> ϑ. </p> </dd> <dt><code>\times</code> <a name="index-_005ctimes"></a> </dt> -<dd><p><em>\times</em> (binary operation) +<dd><p>× Primary school multiplication sign (binary). See +also <code>\cdot</code>. </p> </dd> <dt><code>\to</code> <a name="index-_005cto"></a> </dt> -<dd><p><em>\to</em> +<dd><p>→ Right-pointing single line arrow (relation). +Synonym: <code>\rightarrow</code>. </p> </dd> <dt><code>\top</code> <a name="index-_005ctop"></a> </dt> -<dd><p><em>\top</em> +<dd><p>⊤ Top, greatest element of a poset (ordinary). See +also <code>\bot</code>. </p> </dd> <dt><code>\triangle</code> <a name="index-_005ctriangle"></a> </dt> -<dd><p><em>\triangle</em> +<dd><p>△ Triangle (ordinary). </p> </dd> <dt><code>\triangleleft</code> <a name="index-_005ctriangleleft"></a> </dt> -<dd><p><em>\triangleleft</em> (binary operation) +<dd><p>◁ Not-filled triangle pointing left +(binary). Similar: <code>\lhd</code>. For the normal subgroup symbol you +should load <samp>amssymb</samp> and use <code>\vartriangleleft</code> (which +is a relation and so gives better spacing). </p> </dd> <dt><code>\triangleright</code> <a name="index-_005ctriangleright"></a> </dt> -<dd><p><em>\triangleright</em> (binary operation) +<dd><p>▷ Not-filled triangle pointing right (binary). For the normal +subgroup symbol you should instead load <samp>amssymb</samp> and +use <code>\vartriangleright</code> (which is a relation and so gives +better spacing). </p> </dd> <dt><code>\unlhd</code> <a name="index-_005cunlhd"></a> </dt> -<dd><p>left-pointing arrowhead with line under (binary operation) </p> +<dd><p>⊴ Left-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain TeX. In LaTeX +you should load the <samp>amssymb</samp> package. For the normal subgroup +symbol load <samp>amssymb</samp> and use <code>\vartrianglelefteq</code> (which +is a relation and so gives better spacing). +</p> </dd> <dt><code>\unrhd</code> <a name="index-_005cunrhd"></a> </dt> -<dd><p>right-pointing arrowhead with line under (binary operation) </p> +<dd><p>⊵ Right-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain TeX. In LaTeX +you should load the <samp>amssymb</samp> package. For the normal subgroup +symbol load <samp>amssymb</samp> and use <code>\vartrianglerighteq</code> +(which is a relation and so gives better spacing). +</p> </dd> <dt><code>\Uparrow</code> <a name="index-_005cUparrow"></a> </dt> -<dd><p><em>\Uparrow</em> (delimiter) +<dd><p>⇑ Double-line upward-pointing arrow (relation). Similar: +single-line up-pointing arrow <code>\uparrow</code>. </p> </dd> <dt><code>\uparrow</code> <a name="index-_005cuparrow"></a> </dt> -<dd><p><em>\uparrow</em> (delimiter) +<dd><p>↑ Single-line upward-pointing arrow, diverges (relation). Similar: +double-line up-pointing arrow <code>\Uparrow</code>. </p> </dd> <dt><code>\Updownarrow</code> <a name="index-_005cUpdownarrow"></a> </dt> -<dd><p><em>\Updownarrow</em> (delimiter) +<dd><p>⇕ Double-line upward-and-downward-pointing arrow (relation). Similar: +single-line upward-and-downward-pointing arrow <code>\updownarrow</code>. </p> </dd> <dt><code>\updownarrow</code> <a name="index-_005cupdownarrow"></a> </dt> -<dd><p><em>\updownarrow</em> (delimiter) +<dd><p>↕ Single-line upward-and-downward-pointing arrow (relation). Similar: +double-line upward-and-downward-pointing arrow <code>\Updownarrow</code>. +</p> +</dd> +<dt><code>\upharpoonright</code> +<a name="index-_005cupharpoonright"></a> +</dt> +<dd><p>↾ Up harpoon, with barb on right side +(relation). Synonym: <code>\restriction</code>. Not available in Plain +TeX. In LaTeX you should load the <samp>amssymb</samp> package. </p> </dd> <dt><code>\uplus</code> <a name="index-_005cuplus"></a> </dt> -<dd><p><em>\uplus</em> (binary operation) +<dd><p>⊎ Multiset union, a union symbol with a plus symbol in the middle +(binary). Similar: union <code>\cup</code>. Related: variable-sized +operator <code>\biguplus</code>. </p> </dd> <dt><code>\Upsilon</code> <a name="index-_005cUpsilon"></a> </dt> -<dd><p><em>\Upsilon</em> +<dd><p>Υ Upper case Greek letter (ordinary). </p> </dd> <dt><code>\upsilon</code> <a name="index-_005cupsilon"></a> </dt> -<dd><p><em>\upsilon</em> +<dd><p>υ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\varepsilon</code> <a name="index-_005cvarepsilon"></a> </dt> -<dd><p><em>\varepsilon</em> +<dd><p>ε Rounded small epsilon (ordinary). This is more widely used in +mathematics than the non-variant lower case Greek-text letter form +<code>\epsilon</code> ϵ. Related: set membership <code>\in</code>. </p> </dd> <dt><code>\varphi</code> <a name="index-_005cvarphi"></a> </dt> -<dd><p><em>\varphi</em> +<dd><p>φ Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\phi</code> ϕ. </p> </dd> <dt><code>\varpi</code> <a name="index-_005cvarpi"></a> </dt> -<dd><p><em>\varpi</em> +<dd><p>ϖ Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\pi</code> π. </p> </dd> <dt><code>\varrho</code> <a name="index-_005cvarrho"></a> </dt> -<dd><p><em>\varrho</em> +<dd><p>ϱ Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\rho</code> ρ. </p> </dd> <dt><code>\varsigma</code> <a name="index-_005cvarsigma"></a> </dt> -<dd><p><em>\varsigma</em> +<dd><p>ς Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\sigma</code> σ. </p> </dd> <dt><code>\vartheta</code> <a name="index-_005cvartheta"></a> </dt> -<dd><p><em>\vartheta</em> +<dd><p>ϑ Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\theta</code> θ. </p> </dd> <dt><code>\vdash</code> <a name="index-_005cvdash"></a> </dt> -<dd><p><em>\vdash</em> (relation) +<dd><p>⊢ Provable; turnstile, vertical and a dash (relation). Similar: +turnstile rotated a half-circle <code>\dashv</code>. </p> </dd> <dt><code>\vee</code> <a name="index-_005cvee"></a> </dt> -<dd><p><em>\vee</em> (binary operation) +<dd><p>∨ Logical or; a downwards v shape (binary). Related: logical +and <code>\wedge</code>. Similar: variable-sized +operator <code>\bigvee</code>. </p> </dd> <dt><code>\Vert</code> <a name="index-_005cVert"></a> </dt> -<dd><p><em>\Vert</em> (delimiter) +<dd><p>‖ Vertical double bar (ordinary). Similar: vertical single +bar <code>\vert</code>. +</p> +<p>For a norm you can use the <samp>mathtools</samp> package and add +<code>\DeclarePairedDelimiter\norm{\lVert}{\rVert}</code> to your +preamble. This gives you three command variants for double-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version <code>$\norm*{M^\perp}$</code> then the height of +the vertical bars will match the height of the argument, whereas with +<code>\norm{M^\perp}</code> the bars do not grow with the height of the +argument but instead are the default height, and <code>\norm[<var>size +command</var>]{M^\perp}</code> also gives bars that do not grow but are set to +the size given in the <var>size command</var>, e.g., <code>\Bigg</code>. </p> </dd> <dt><code>\vert</code> <a name="index-_005cvert"></a> </dt> -<dd><p><em>\vert</em> (delimiter) +<dd><p>| Single line vertical bar (ordinary). Similar: double-line +vertical bar <code>\Vert</code>. For such that, as in the definition of a +set, use <code>\mid</code> because it is a relation. +</p> +<p>For absolute value you can use the <samp>mathtools</samp> package and add +<code>\DeclarePairedDelimiter\abs{\lvert}{\rvert}</code> to your +preamble. This gives you three command variants for single-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version <code>$\abs*{\frac{22}{7}}$</code> then the +height of the vertical bars will match the height of the argument, +whereas with <code>\abs{\frac{22}{7}}</code> the bars do not grow with +the height of the argument but instead are the default height, and +<code>\abs[<var>size command</var>]{\frac{22}{7}}</code> also gives bars +that do not grow but are set to the size given in the <var>size +command</var>, e.g., <code>\Bigg</code>. </p> </dd> <dt><code>\wedge</code> <a name="index-_005cwedge"></a> </dt> -<dd><p><em>\wedge</em> (binary operation) +<dd><p>∧ Logical and (binary). Synonym: <code>\land</code>. See also +logical or <code>\vee</code>. Similar: variable-sized +operator <code>\bigwedge</code>. </p> </dd> <dt><code>\wp</code> <a name="index-_005cwp"></a> </dt> -<dd><p><em>\wp</em> +<dd><p>℘ Weierstrass p (ordinary). </p> </dd> <dt><code>\wr</code> <a name="index-_005cwr"></a> </dt> -<dd><p><em>\wr</em> (binary operation) +<dd><p>≀ Wreath product (binary). </p> </dd> <dt><code>\Xi</code> <a name="index-_005cXi"></a> </dt> -<dd><p><em>\Xi</em> +<dd><p>Ξ Upper case Greek letter (ordinary). </p> </dd> <dt><code>\xi</code> <a name="index-_005cxi"></a> </dt> -<dd><p><em>\xi</em> +<dd><p>ξ Lower case Greek letter (ordinary). </p> </dd> <dt><code>\zeta</code> <a name="index-_005czeta"></a> </dt> -<dd><p><em>\zeta</em> +<dd><p>ζ Lower case Greek letter (ordinary). </p> </dd> </dl> @@ -7198,6 +9313,7 @@ Next: <a href="#Math-accents" accesskey="n" rel="next">Math accents</a>, Previou </div> <a name="Math-functions-1"></a> <h3 class="section">16.3 Math functions</h3> + <a name="index-math-functions"></a> <a name="index-functions_002c-math"></a> @@ -7250,13 +9366,13 @@ spacing. <dt><code>\cot</code> <a name="index-_005ccot"></a> </dt> -<dd><p><em>\cos</em> +<dd><p><em>\cot</em> </p> </dd> <dt><code>\coth</code> <a name="index-_005ccoth"></a> </dt> -<dd><p><em>\cosh</em> +<dd><p><em>\coth</em> </p> </dd> <dt><code>\csc</code> @@ -7274,7 +9390,7 @@ spacing. <dt><code>\det</code> <a name="index-_005cdet"></a> </dt> -<dd><p><em>\deg</em> +<dd><p><em>\det</em> </p> </dd> <dt><code>\dim</code> @@ -7420,6 +9536,7 @@ Next: <a href="#Spacing-in-math-mode" accesskey="n" rel="next">Spacing in math m </div> <a name="Math-accents-1"></a> <h3 class="section">16.4 Math accents</h3> + <a name="index-math-accents"></a> <a name="index-accents_002c-mathematical"></a> @@ -7529,10 +9646,10 @@ in math. These are different from accents in normal text <p>Math wide hat accent: <em>\widehat{x+y}</em>. </p> </dd> -<dt><code>\widehat</code> -<a name="index-_005cwidehat-1"></a> +<dt><code>\widetilde</code> +<a name="index-_005cwidetilde"></a> </dt> -<dd><a name="index-wide-tile-accent_002c-math"></a> +<dd><a name="index-wide-tilde-accent_002c-math"></a> <p>Math wide tilde accent: <em>\widetilde{x+y}</em>. </p> </dd> @@ -7547,34 +9664,71 @@ Next: <a href="#Math-miscellany" accesskey="n" rel="next">Math miscellany</a>, P </div> <a name="Spacing-in-math-mode-1"></a> <h3 class="section">16.5 Spacing in math mode</h3> + <a name="index-spacing-within-math-mode"></a> <a name="index-math-mode_002c-spacing"></a> -<p>In a <code>math</code> environment, LaTeX ignores the spaces you type and -puts in the spacing according to the normal rules for mathematics -texts. If you want different spacing, LaTeX provides the following -commands for use in math mode: +<p>In a <code>math</code> environment, LaTeX ignores the spaces that you use +in the source, and instead puts in the spacing according to the normal +rules for mathematics texts. +</p> +<p>Many math mode spacing definitions are expressed in terms of the math unit +<em>mu</em> given by 1 em = 18 mu, where the em is taken from the current +math symbols family (see <a href="#Units-of-length">Units of length</a>). +LaTeX provides the following commands for use in math mode: </p> <dl compact="compact"> <dt><code>\;</code></dt> <dd><a name="index-_005c_003b"></a> -<p>A thick space (<em>5\over18\,</em>quad). -</p></dd> +<a name="index-_005cthickspace"></a> +<p>Normally <code>5.0mu plus 5.0mu</code>. The longer name is +<code>\thickspace</code>. Math mode only. +</p> +</dd> <dt><code>\:</code></dt> <dt><code>\></code></dt> <dd><a name="index-_005c_003a"></a> <a name="index-_005c_003e-1"></a> -<p>Both of these produce a medium space (<em>2\over9\,</em>quad). -</p></dd> +<a name="index-_005cmedspace"></a> +<p>Normally <code>4.0mu plus 2.0mu minus 4.0mu</code>. The longer name is +<code>\medspace</code>. Math mode only. +</p> +</dd> <dt><code>\,</code></dt> <dd><a name="index-_005c_002c"></a> -<p>A thin space (<em>1\over6\,</em>quad); not restricted to math mode. -</p></dd> +<a name="index-_005cthinspace"></a> +<p>Normally <code>3mu</code>. The longer name is <code>\thinspace</code>. This can +be used in both math mode and text mode. +</p> +</dd> <dt><code>\!</code></dt> -<dd><p>A negative thin space (<em>-{1\over6}\,</em>quad). +<dd><a name="index-_005c_0021"></a> +<p>A negative thin space. Normally <code>-3mu</code>. Math mode only. +</p> +</dd> +<dt><code>\quad</code></dt> +<dd><a name="index-quad"></a> +<a name="index-_005cquad"></a> +<p>This is 18mu, that is, 1em. This is often used for space +surrounding equations or expressions, for instance for the space between +two equations inside a <code>displaymath</code> environment. It is available +in both text and math mode. +</p> +</dd> +<dt><code>\qquad</code></dt> +<dd><a name="index-_005cqquad"></a> +<p>A length of 2 quads, that is, 36mu = 2em. It is available in +both text and math mode. </p></dd> </dl> +<p>In this example a thinspace separates the function from the +infinitesimal. +</p> +<div class="example"> +<pre class="example">\int_0^1 f(x)\,dx +</pre></div> + <hr> <a name="Math-miscellany"></a> @@ -7584,6 +9738,7 @@ Previous: <a href="#Spacing-in-math-mode" accesskey="p" rel="prev">Spacing in ma </div> <a name="Math-miscellany-1"></a> <h3 class="section">16.6 Math miscellany</h3> + <a name="index-math-miscellany"></a> <dl compact="compact"> @@ -7688,6 +9843,7 @@ Next: <a href="#Page-styles" accesskey="n" rel="next">Page styles</a>, Previous: </div> <a name="Modes-1"></a> <h2 class="chapter">17 Modes</h2> + <a name="index-modes"></a> <a name="index-paragraph-mode"></a> <a name="index-math-mode"></a> @@ -7742,6 +9898,7 @@ Next: <a href="#Spaces" accesskey="n" rel="next">Spaces</a>, Previous: <a href=" </div> <a name="Page-styles-1"></a> <h2 class="chapter">18 Page styles</h2> + <a name="index-styles_002c-page"></a> <a name="index-page-styles"></a> @@ -7768,6 +9925,7 @@ Next: <a href="#g_t_005cpagenumbering" accesskey="n" rel="next">\pagenumbering</ </div> <a name="g_t_005cmaketitle-1"></a> <h3 class="section">18.1 <code>\maketitle</code></h3> + <a name="index-titles_002c-making"></a> <a name="index-_005cmaketitle"></a> @@ -7827,6 +9985,7 @@ Next: <a href="#g_t_005cpagestyle" accesskey="n" rel="next">\pagestyle</a>, Prev </div> <a name="g_t_005cpagenumbering-1"></a> <h3 class="section">18.2 <code>\pagenumbering</code></h3> + <a name="index-_005cpagenumbering"></a> <a name="index-page-numbering-style"></a> @@ -7871,6 +10030,7 @@ Next: <a href="#g_t_005cthispagestyle" accesskey="n" rel="next">\thispagestyle</ </div> <a name="g_t_005cpagestyle-1"></a> <h3 class="section">18.3 <code>\pagestyle</code></h3> + <a name="index-_005cpagestyle"></a> <a name="index-header-style"></a> <a name="index-footer-style"></a> @@ -7937,6 +10097,7 @@ Previous: <a href="#g_t_005cpagestyle" accesskey="p" rel="prev">\pagestyle</a>, </div> <a name="g_t_005cthispagestyle_007bstyle_007d"></a> <h3 class="section">18.4 <code>\thispagestyle{<var>style</var>}</code></h3> + <a name="index-_005cthispagestyle"></a> <p>The <code>\thispagestyle</code> command works in the same manner as the @@ -7952,31 +10113,29 @@ Next: <a href="#Boxes" accesskey="n" rel="next">Boxes</a>, Previous: <a href="#P </div> <a name="Spaces-1"></a> <h2 class="chapter">19 Spaces</h2> + <a name="index-spaces"></a> +<a name="index-white-space"></a> <p>LaTeX has many ways to produce white (or filled) space. </p> -<p>Another space-producing command is <code>\,</code> to produce a “thin” -space (usually 1/6quad). It can be used in text mode, but is -more often useful in math mode (see <a href="#Spacing-in-math-mode">Spacing in math mode</a>). -</p> <table class="menu" border="0" cellspacing="0"> -<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">Horizontal space -</pre></th></tr><tr><td align="left" valign="top">• <a href="#g_t_005chspace" accesskey="1">\hspace</a>:</td><td> </td><td align="left" valign="top">Fixed horizontal space. +<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">Horizontal space +</pre></th></tr><tr><td align="left" valign="top">• <a href="#g_t_005chspace" accesskey="1">\hspace</a>:</td><td> </td><td align="left" valign="top">Fixed horizontal space. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005chfill" accesskey="2">\hfill</a>:</td><td> </td><td align="left" valign="top">Stretchable horizontal space. +<tr><td align="left" valign="top">• <a href="#g_t_005chfill" accesskey="2">\hfill</a>:</td><td> </td><td align="left" valign="top">Stretchable horizontal space. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cSPACE" accesskey="3">\SPACE</a>:</td><td> </td><td align="left" valign="top">Normal interword space. +<tr><td align="left" valign="top">• <a href="#g_t_005c_0028SPACE_0029-and-_005c_0040" accesskey="3">\(SPACE) and \@</a>:</td><td> </td><td align="left" valign="top">Space after a period. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005c_0040" accesskey="4">\@</a>:</td><td> </td><td align="left" valign="top">Ending a sentence. +<tr><td align="left" valign="top">• <a href="#g_t_005c_0028SPACE_0029-after-CS" accesskey="4">\(SPACE) after CS</a>:</td><td> </td><td align="left" valign="top">Controlling space gobbling after a control sequence. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cthinspace" accesskey="5">\thinspace</a>:</td><td> </td><td align="left" valign="top">One-sixth of an em. +<tr><td align="left" valign="top">• <a href="#g_t_005cfrenchspacing" accesskey="5">\frenchspacing</a>:</td><td> </td><td align="left" valign="top">Make interword and intersentence space equal. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005c_002f" accesskey="6">\/</a>:</td><td> </td><td align="left" valign="top">Insert italic correction. +<tr><td align="left" valign="top">• <a href="#g_t_005cthinspace" accesskey="6">\thinspace</a>:</td><td> </td><td align="left" valign="top">One-sixth of an em. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005chrulefill" accesskey="7">\hrulefill</a>:</td><td> </td><td align="left" valign="top">Stretchable horizontal rule. +<tr><td align="left" valign="top">• <a href="#g_t_005c_002f" accesskey="7">\/</a>:</td><td> </td><td align="left" valign="top">Insert italic correction. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cdotfill" accesskey="8">\dotfill</a>:</td><td> </td><td align="left" valign="top">Stretchable horizontal dots. +<tr><td align="left" valign="top">• <a href="#g_t_005chrulefill-_005cdotfill" accesskey="8">\hrulefill \dotfill</a>:</td><td> </td><td align="left" valign="top">Stretchable horizontal rule or dots. </td></tr> <tr><th colspan="3" align="left" valign="top"><pre class="menu-comment"> Vertical space @@ -7999,106 +10158,194 @@ Next: <a href="#g_t_005chfill" accesskey="n" rel="next">\hfill</a>, Up: <a href= </div> <a name="g_t_005chspace-1"></a> <h3 class="section">19.1 <code>\hspace</code></h3> + <a name="index-_005chspace"></a> <p>Synopsis: </p> <div class="example"> -<pre class="example">\hspace[*]{<var>length</var>} +<pre class="example">\hspace{<var>length</var>} +\hspace*{<var>length</var>} </pre></div> -<p>The <code>\hspace</code> command adds horizontal space. The <var>length</var> -argument can be expressed in any terms that LaTeX understands: -points, inches, etc. It is a rubber length. You can add both -negative and positive space with an <code>\hspace</code> command; adding -negative space is like backspacing. +<p>Add the horizontal space given by <var>length</var>. The <var>length</var> is a +rubber length, that is, it may contain a <code>plus</code> or <code>minus</code> +component, in any unit that LaTeX understands (see <a href="#Lengths">Lengths</a>). </p> -<p>LaTeX normally removes horizontal space that comes at the beginning -or end of a line. To preserve this space, use the optional <code>*</code> -form. +<p>This command can add both positive and negative space; adding negative +space is like backspacing. </p> +<p>Normally when TeX breaks a paragraph into lines it discards white +space (glues and kerns) that would come at the start of a line, so you +get an inter-word space or a line break between words but not both. This +command’s starred version <code>\hspace*{..}</code> puts a non-discardable +invisible item in front of the space, so the space appears in the +output. +</p> +<p>This example make a one-line paragraph that puts ‘<samp>Name:</samp>’ an inch +from the right margin. +</p> +<div class="example"> +<pre class="example">\noindent\makebox[\linewidth]{\hspace{\fill}Name:\hspace{1in}} +</pre></div> + <hr> <a name="g_t_005chfill"></a> <div class="header"> <p> -Next: <a href="#g_t_005cSPACE" accesskey="n" rel="next">\SPACE</a>, Previous: <a href="#g_t_005chspace" accesskey="p" rel="prev">\hspace</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005c_0028SPACE_0029-and-_005c_0040" accesskey="n" rel="next">\(SPACE) and \@</a>, Previous: <a href="#g_t_005chspace" accesskey="p" rel="prev">\hspace</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005chfill-1"></a> <h3 class="section">19.2 <code>\hfill</code></h3> + <a name="index-_005chfill"></a> <a name="index-stretch_002c-infinite-horizontal"></a> <a name="index-infinite-horizontal-stretch"></a> -<p>The <code>\hfill</code> fill command produces a “rubber length” which has -no natural space but can stretch or shrink horizontally as far as -needed. +<p>Produce a rubber length which has +no natural space but can stretch horizontally as far as +needed (see <a href="#Lengths">Lengths</a>). </p> <a name="index-_005cfill"></a> -<p>The <code>\fill</code> parameter is the rubber length itself (technically, -the glue value ‘<samp>0pt plus1fill</samp>’); thus, <code>\hspace\fill</code> is -equivalent to <code>\hfill</code>. +<p>The command <code>\hfill</code> is equivalent to <code>\hspace{\fill}</code>. For +space that does not disappear at line breaks use +<code>\hspace*{\fill}</code> instead (see <a href="#g_t_005chspace">\hspace</a>). </p> <hr> -<a name="g_t_005cSPACE"></a> +<a name="g_t_005c_0028SPACE_0029-and-_005c_0040"></a> <div class="header"> <p> -Next: <a href="#g_t_005c_0040" accesskey="n" rel="next">\@</a>, Previous: <a href="#g_t_005chfill" accesskey="p" rel="prev">\hfill</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005c_0028SPACE_0029-after-CS" accesskey="n" rel="next">\(SPACE) after CS</a>, Previous: <a href="#g_t_005chfill" accesskey="p" rel="prev">\hfill</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005cSPACE_003a-Normal-interword-space"></a> -<h3 class="section">19.3 <code>\SPACE</code>: Normal interword space</h3> -<a name="index-_005cSPACE"></a> +<a name="g_t_005c_0028SPACE_0029-and-_005c_0040-1"></a> +<h3 class="section">19.3 <code>\(SPACE)</code> and \@</h3> + +<a name="index-_005c_0028SPACE_0029"></a> <a name="index-_005cTAB"></a> <a name="index-_005cNEWLINE"></a> - -<p>The <code>\ </code> (space) command produces a normal interword space. It’s -useful after punctuation which shouldn’t end a sentence. For example, -<code>the article in Proc.\ Amer.\ Math\. Soc.\ is fundamental</code>. It -is also often used after control sequences, as in <code>\TeX\ is a -nice system.</code> +<a name="index-_005c_0040"></a> +<a name="g_t_005cAT"></a> +<p>Mark a punctuation character, typically a period, as either ending a +sentence or as ending an abbreviation. </p> -<p>In normal circumstances, <code>\</code><tt class="key">tab</tt> and <code>\</code><tt class="key">newline</tt> -are equivalent to <code>\ </code>. +<p>By default, in justifying a line LaTeX adjusts the space after a +sentence-ending period (or a question mark, exclamation point, comma, or +colon) more than the space between words +(see <a href="#g_t_005cfrenchspacing">\frenchspacing</a>). LaTeX assumes that the period ends a +sentence unless it is preceded by a capital letter, in which case it +takes that period for part of an abbreviation. Note that if a +sentence-ending period is immediately followed by a right parenthesis or +bracket, or right single or double quote, then the intersentence space +follows that parenthesis or quote. +</p> +<p>If you have a period ending an abbreviation whose last letter is not a +capital letter, and that abbreviation is not the last word in the +sentence, then follow that period with a backslash-space (<code>\ </code>) or +a tie (<code>~</code>). Examples are <code>Nat.\ Acad.\ Science</code>, and +<code>Mr.~Bean</code>, and <code>(manure, etc.)\ for sale</code>. +</p> +<p>For other use of <code>\ </code>, see also <a href="#g_t_005c_0028SPACE_0029-after-CS">\(SPACE) after CS</a>. +</p> +<p>In the opposite situation, if you have a capital letter followed by a +period that ends the sentence, then put <code>\@</code> on the left of that +period. For example, <code>book by the MAA\@.</code> will have intersentence +spacing after the period. +</p> +<p>In contrast, putting <code>\@</code> on the right of a period tells TeX +that the period does not end the sentence. In the example +<code>reserved words (if, then, etc.\@) are different</code>, TeX will put +interword space after the closing parenthesis (note that <code>\@</code> is +before the parenthesis). </p> - <hr> -<a name="g_t_005c_0040"></a> +<a name="g_t_005c_0028SPACE_0029-after-CS"></a> <div class="header"> <p> -Next: <a href="#g_t_005cthinspace" accesskey="n" rel="next">\thinspace</a>, Previous: <a href="#g_t_005cSPACE" accesskey="p" rel="prev">\SPACE</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005cfrenchspacing" accesskey="n" rel="next">\frenchspacing</a>, Previous: <a href="#g_t_005c_0028SPACE_0029-and-_005c_0040" accesskey="p" rel="prev">\(SPACE) and \@</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005c_0040_003a-Force-sentence_002dending-punctuation"></a> -<h3 class="section">19.4 <code>\@</code>: Force sentence-ending punctuation</h3> -<a name="index-_005c_0040"></a> -<a name="g_t_005cAT"></a> -<p>The <code>\@</code> command makes the following punctuation character end a -sentence even if it normally would not. This is typically used after -a capital letter. Here are side-by-side examples with and without -<code>\@</code>: +<a name="g_t_005c--after-a-control-sequence"></a> +<h3 class="section">19.4 <code>\ </code> after a control sequence</h3> + +<p>The <code>\ </code> command is often used after control sequences to keep them +from gobbling the space that follows, as in <code>\TeX\ is a nice +system.</code> And, under normal circumstances <code>\</code><tt class="key">tab</tt> and +<code>\</code><tt class="key">newline</tt> are equivalent to <code>\ </code>. For other use of +<code>\ </code>, see also <a href="#g_t_005c_0028SPACE_0029-and-_005c_0040">\(SPACE) and \@</a>. +</p> +<p>Some people prefer to use <code>{}</code> for the same purpose, as in +<code>\TeX{} is a nice system.</code> This has the advantage that you can +always write it the same way, like <code>\TeX{}</code>, whether it is +followed by a space or by a punctuation mark. Please compare: </p> <div class="example"> -<pre class="example">… in C\@. Pascal, though … -… in C. Pascal, though … +<pre class="example">\TeX\ is a nice system. \TeX, a nice system. + +\TeX{} is a nice system. \TeX{}, a nice system. +</pre></div> + + +<p>When you define user commands (see <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>) you +can prevent the space gobbling after the command by using the package +<code>xspace</code> and inserting <code>\xspace</code> at the end of the definition +For instance: +</p><div class="example"> +<pre class="example">\documentclass{minimal} +\usepackage{xspace} +\newcommand*{\Loup}{Grand Cric\xspace} +\begin{document} +Que le \Loup me croque ! +\end{document} +</pre></div> + +<p>A quick hack to use <code>\xspace</code> for existing command is as follows: +</p><div class="example"> +<pre class="example">\documentclass{minimal} +\usepackage{xspace} +\newcommand*{\SansXspaceTeX}{} +\let\SansXspaceTeX\TeX +\renewcommand{\TeX}{\SansXspaceTeX\xspace} +\begin{document} +\TeX is a nice system. +\end{document} </pre></div> -<p>produces -</p> -<blockquote> -<p>… in C. Pascal, though …<br> -… in C. Pascal, though … -</p></blockquote> +<hr> +<a name="g_t_005cfrenchspacing"></a> +<div class="header"> +<p> +Next: <a href="#g_t_005cthinspace" accesskey="n" rel="next">\thinspace</a>, Previous: <a href="#g_t_005c_0028SPACE_0029-after-CS" accesskey="p" rel="prev">\(SPACE) after CS</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +</div> +<a name="g_t_005cfrenchspacing-1"></a> +<h3 class="section">19.5 <code>\frenchspacing</code></h3> + +<a name="index-_005cfrenchspacing"></a> +<a name="index-_005cnonfrenchspacing"></a> +<a name="index-spacing_002c-intersentence"></a> + +<p>This declaration (from Plain TeX) causes LaTeX to treat +intersentence spacing in the same way as interword spacing. +</p> +<p>In justifying the text in a line, some typographic traditions, including +English, prefer to adjust the space between sentences (or after other +punctuation marks) more than the space between words. Following this +declaration, all spaces are instead treated equally. +</p> +<p>Revert to the default behavior by declaring <code>\nonfrenchspacing</code>. +</p> <hr> <a name="g_t_005cthinspace"></a> <div class="header"> <p> -Next: <a href="#g_t_005c_002f" accesskey="n" rel="next">\/</a>, Previous: <a href="#g_t_005c_0040" accesskey="p" rel="prev">\@</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005c_002f" accesskey="n" rel="next">\/</a>, Previous: <a href="#g_t_005cfrenchspacing" accesskey="p" rel="prev">\frenchspacing</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cthinspace_003a-Insert-1_002f6em"></a> -<h3 class="section">19.5 <code>\thinspace</code>: Insert 1/6em</h3> -<a name="index-_005cthinspace"></a> +<h3 class="section">19.6 <code>\thinspace</code>: Insert 1/6em</h3> + +<a name="index-_005cthinspace-1"></a> <p><code>\thinspace</code> produces an unbreakable and unstretchable space that is 1/6 of an em. This is the proper space to use between nested @@ -8108,10 +10355,11 @@ quotes, as in ’”.</p> <a name="g_t_005c_002f"></a> <div class="header"> <p> -Next: <a href="#g_t_005chrulefill" accesskey="n" rel="next">\hrulefill</a>, Previous: <a href="#g_t_005cthinspace" accesskey="p" rel="prev">\thinspace</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005chrulefill-_005cdotfill" accesskey="n" rel="next">\hrulefill \dotfill</a>, Previous: <a href="#g_t_005cthinspace" accesskey="p" rel="prev">\thinspace</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005c_002f_003a-Insert-italic-correction"></a> -<h3 class="section">19.6 <code>\/</code>: Insert italic correction</h3> +<h3 class="section">19.7 <code>\/</code>: Insert italic correction</h3> + <a name="index-_005c_002f"></a> <a name="index-italic-correction"></a> @@ -8141,54 +10389,73 @@ in a different way. </p> <hr> -<a name="g_t_005chrulefill"></a> +<a name="g_t_005chrulefill-_005cdotfill"></a> <div class="header"> <p> -Next: <a href="#g_t_005cdotfill" accesskey="n" rel="next">\dotfill</a>, Previous: <a href="#g_t_005c_002f" accesskey="p" rel="prev">\/</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005caddvspace" accesskey="n" rel="next">\addvspace</a>, Previous: <a href="#g_t_005c_002f" accesskey="p" rel="prev">\/</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005chrulefill-1"></a> -<h3 class="section">19.7 <code>\hrulefill</code></h3> +<a name="g_t_005chrulefill-_005cdotfill-1"></a> +<h3 class="section">19.8 <code>\hrulefill \dotfill</code></h3> + <a name="index-_005chrulefill"></a> +<a name="index-_005cdotfill"></a> -<p>The <code>\hrulefill</code> fill command produces a “rubber length” which can -stretch or shrink horizontally. It will be filled with a horizontal -rule. +<p>Produce an infinite rubber length (see <a href="#Lengths">Lengths</a>) filled with a +horizontal rule (that is, a line) or with dots, instead of just white +space. </p> +<p>When placed between blank lines this example creates a paragraph that is +left and right justified, where the space in the middle is filled with +evenly spaced dots. +</p> +<div class="example"> +<pre class="example">\noindent Jack Aubrey\dotfill Melbury Lodge +</pre></div> -<hr> -<a name="g_t_005cdotfill"></a> -<div class="header"> -<p> -Next: <a href="#g_t_005caddvspace" accesskey="n" rel="next">\addvspace</a>, Previous: <a href="#g_t_005chrulefill" accesskey="p" rel="prev">\hrulefill</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> -</div> -<a name="g_t_005cdotfill-1"></a> -<h3 class="section">19.8 <code>\dotfill</code></h3> - -<a name="index-_005cdotfill"></a> - -<p>The <code>\dotfill</code> command produces a “rubber length” that fills -with dots instead of just white space. +<p>To make the rule or dots go to the line’s end use <code>\null</code> at the +start or end. +</p> +<p>To change the rule’s thickness, copy the definition and adjust it, as +with <code>\renewcommand{\hrulefill}{\leavevmode\leaders\hrule height +1pt\hfill\kern\z@}</code>, which changes the default thickness of +0.4pt to 1pt. Similarly, adjust the dot spacing as with +<code>\renewcommand{\dotfill}{\leavevmode\cleaders\hb@xt@ +1.00em{\hss .\hss }\hfill\kern\z@}</code>, which changes the default +length of 0.33em to 1.00em. </p> <hr> <a name="g_t_005caddvspace"></a> <div class="header"> <p> -Next: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip" accesskey="n" rel="next">\bigskip \medskip \smallskip</a>, Previous: <a href="#g_t_005cdotfill" accesskey="p" rel="prev">\dotfill</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip" accesskey="n" rel="next">\bigskip \medskip \smallskip</a>, Previous: <a href="#g_t_005chrulefill-_005cdotfill" accesskey="p" rel="prev">\hrulefill \dotfill</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005caddvspace-1"></a> <h3 class="section">19.9 <code>\addvspace</code></h3> + <a name="index-_005caddvspace"></a> <a name="index-vertical-space"></a> <a name="index-space_002c-inserting-vertical"></a> -<p><code>\addvspace{length}</code> +<p><code>\addvspace{<var>length</var>}</code> +</p> +<p>Add a vertical space of height <var>length</var>, which is a rubber length +(see <a href="#Lengths">Lengths</a>). However, if vertical space has already been added to +the same point in the output by a previous <code>\addvspace</code> command +then this command will not add more space than what is needed to make +the natural length of the total vertical space equal to <var>length</var>. +</p> +<p>Use this command to adjust the vertical space above or below an +environment that starts a new paragraph. (For instance, a Theorem +environment is defined to begin and end in <code>\addvspace{..}</code> so +that two consecutive Theorem’s are separated by one vertical space, not +two.) </p> -<p>The <code>\addvspace</code> command normally adds a vertical space of height -length. However, if vertical space has already been added to the same -point in the output by a previous <code>\addvspace</code> command, then this -command will not add more space than is needed to make the natural -length of the total vertical space equal to <code>length</code>. +<p>This command is fragile (see <a href="#g_t_005cprotect">\protect</a>). +</p> +<p>The error ‘<samp>Something's wrong--perhaps a missing \item</samp>’ means that +you were not in vertical mode when you invoked this command; one way to +change that is to precede this command with a <code>\par</code> command. </p> <hr> @@ -8240,15 +10507,36 @@ Next: <a href="#g_t_005cvspace" accesskey="n" rel="next">\vspace</a>, Previous: </div> <a name="g_t_005cvfill-1"></a> <h3 class="section">19.11 <code>\vfill</code></h3> + <a name="index-_005cvfill"></a> <a name="index-stretch_002c-infinite-vertical"></a> <a name="index-infinite-vertical-stretch"></a> -<p>The <code>\vfill</code> fill command produces a rubber length (glue) which -can stretch or shrink vertically as far as needed. It’s equivalent to -<code>\vspace{\fill}</code> (see <a href="#g_t_005chfill">\hfill</a>). +<p>End the current paragraph and insert a vertical rubber length +(see <a href="#Lengths">Lengths</a>) that is infinite, so it can stretch or shrink as far +as needed. </p> +<p>It is often used in the same way as <code>\vspace{\fill}</code>, except that +<code>\vfill</code> ends the current paragraph, whereas +<code>\vspace{\fill}</code> adds the infinite vertical space below its line +irrespective of the paragraph structure. In both cases that space will +disappear at a page boundary; to circumvent this see <a href="#g_t_005cvspace">\vspace</a>. +</p> +<p>In this example the page is filled, so the top and bottom lines contain +the text ‘<samp>Lost Dog!</samp>’ and the third ‘<samp>Lost Dog!</samp>’ is exactly +halfway between them. +</p> +<div class="example"> +<pre class="example">\begin{document} +Lost Dog! +\vfill +Lost Dog! +\vfill +Lost Dog! +\end{document} +</pre></div> + <hr> <a name="g_t_005cvspace"></a> @@ -8256,23 +10544,40 @@ can stretch or shrink vertically as far as needed. It’s equivalent to <p> Previous: <a href="#g_t_005cvfill" accesskey="p" rel="prev">\vfill</a>, Up: <a href="#Spaces" accesskey="u" rel="up">Spaces</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005cvspace_005b_002a_005d_007blength_007d"></a> -<h3 class="section">19.12 <code>\vspace[*]{<var>length</var>}</code></h3> +<a name="g_t_005cvspace_007blength_007d"></a> +<h3 class="section">19.12 <code>\vspace{<var>length</var>}</code></h3> + <a name="index-_005cvspace"></a> +<a name="index-vertical-space-1"></a> +<a name="index-space_002c-vertical"></a> -<p>Synopsis: +<p>Synopsis, one of these two: </p> <div class="example"> -<pre class="example">\vspace[*]{<var>length</var>} +<pre class="example">\vspace{<var>length</var>} +\vspace*{<var>length</var>} </pre></div> -<p>The <code>\vspace</code> command adds the vertical space <var>length</var>, i.e., -a rubber length. <var>length</var> can be negative or positive. +<p>Add the vertical space <var>length</var>. This can be negative or positive, +and is a rubber length (see <a href="#Lengths">Lengths</a>). +</p> +<p>LaTeX removes the vertical space from <code>\vfill</code> at a page break, +that is, at the top or bottom of a page. The starred version +<code>\vspace*{..}</code> causes the space to stay. </p> -<p>Ordinarily, LaTeX removes vertical space added by <code>\vspace</code> at -the top or bottom of a page. With the optional <code>*</code> argument, the -space is not removed. +<p>In this example the two questions will be evenly spaced vertically on +the page, with at least one inch of space below each. </p> +<div class="example"> +<pre class="example">\begin{document} +1) Who put the bomp in the bomp bah bomp bah bomp? +\vspace{1in plus 1fill} + +2) Who put the ram in the rama lama ding dong? +\vspace{1in plus 1fill} +\end{document} +</pre></div> + <hr> <a name="Boxes"></a> @@ -8318,6 +10623,7 @@ Next: <a href="#g_t_005cfbox-and-_005cframebox" accesskey="n" rel="next">\fbox a </div> <a name="g_t_005cmbox_007btext_007d"></a> <h3 class="section">20.1 <code>\mbox{<var>text}</var></code></h3> + <a name="index-_005cmbox"></a> <a name="index-hyphenation_002c-preventing"></a> @@ -8370,6 +10676,7 @@ Next: <a href="#g_t_005cmakebox" accesskey="n" rel="next">\makebox</a>, Previous </div> <a name="lrbox-1"></a> <h3 class="section">20.3 <code>lrbox</code></h3> + <a name="index-lrbox"></a> <p><code>\begin{lrbox}{cmd} text \end{lrbox}</code> @@ -8388,6 +10695,7 @@ Next: <a href="#g_t_005cparbox" accesskey="n" rel="next">\parbox</a>, Previous: </div> <a name="g_t_005cmakebox-2"></a> <h3 class="section">20.4 <code>\makebox</code></h3> + <a name="index-_005cmakebox"></a> <p>Synopsis: @@ -8397,7 +10705,7 @@ Next: <a href="#g_t_005cparbox" accesskey="n" rel="next">\parbox</a>, Previous: </pre></div> <p>The <code>\makebox</code> command creates a box just wide enough to contain -the <var>text</var> specified. The width of the box is specified by the +the <var>text</var> specified. The width of the box can be overridden by the optional <var>width</var> argument. The position of the text within the box is determined by the optional <var>position</var> argument, which may take the following values: @@ -8418,7 +10726,7 @@ stretchable space for this to work. </p></dd> </dl> -<p><code>\makebox</code> is also used within the picture environment +<p><code>\makebox</code> is also used within the <code>picture</code> environment see <a href="#g_t_005cmakebox-_0028picture_0029">\makebox (picture)</a>. </p> @@ -8430,6 +10738,7 @@ Next: <a href="#g_t_005craisebox" accesskey="n" rel="next">\raisebox</a>, Previo </div> <a name="g_t_005cparbox-1"></a> <h3 class="section">20.5 <code>\parbox</code></h3> + <a name="index-_005cparbox"></a> <p>Synopsis: @@ -8491,6 +10800,7 @@ Next: <a href="#g_t_005csavebox" accesskey="n" rel="next">\savebox</a>, Previous </div> <a name="g_t_005craisebox-1"></a> <h3 class="section">20.6 <code>\raisebox</code></h3> + <a name="index-_005craisebox"></a> <p>Synopsis: @@ -8518,6 +10828,7 @@ Next: <a href="#g_t_005csbox" accesskey="n" rel="next">\sbox</a>, Previous: <a h </div> <a name="g_t_005csavebox-1"></a> <h3 class="section">20.7 <code>\savebox</code></h3> + <a name="index-_005csavebox"></a> <p>Synopsis: @@ -8540,6 +10851,7 @@ Next: <a href="#g_t_005cusebox" accesskey="n" rel="next">\usebox</a>, Previous: </div> <a name="g_t_005csbox_007b_005cboxcmd_007d_007btext_007d"></a> <h3 class="section">20.8 <code>\sbox{<var>\boxcmd</var>}{<var>text</var>}</code></h3> + <a name="index-_005csbox"></a> <p>Synopsis: @@ -8563,6 +10875,7 @@ Previous: <a href="#g_t_005csbox" accesskey="p" rel="prev">\sbox</a>, Up: <a hre </div> <a name="g_t_005cusebox_007b_005cboxcmd_007d"></a> <h3 class="section">20.9 <code>\usebox{<var>\boxcmd</var>}</code></h3> + <a name="index-_005cusebox"></a> <p>Synopsis: @@ -8584,6 +10897,9 @@ Next: <a href="#Splitting-the-input" accesskey="n" rel="next">Splitting the inpu <a name="Special-insertions-1"></a> <h2 class="chapter">21 Special insertions</h2> +<a name="index-special-insertions"></a> +<a name="index-insertions-of-special-characters"></a> + <p>LaTeX provides commands for inserting characters that have a special meaning do not correspond to simple characters you can type. </p> @@ -8611,6 +10927,7 @@ Next: <a href="#Text-symbols" accesskey="n" rel="next">Text symbols</a>, Up: <a </div> <a name="Reserved-characters-1"></a> <h3 class="section">21.1 Reserved characters</h3> + <a name="index-reserved-characters"></a> <a name="index-characters_002c-reserved"></a> @@ -8669,6 +10986,8 @@ Next: <a href="#Accents" accesskey="n" rel="next">Accents</a>, Previous: <a href <h3 class="section">21.2 Text symbols</h3> <a name="index-text-symbols"></a> +<a name="index-symbols_002c-text"></a> + <a name="index-textcomp-package-1"></a> <p>LaTeX provides commands to generate a number of non-letter symbols in running text. Some of these, especially the more obscure ones, are @@ -8956,7 +11275,7 @@ has the ascender height. <a name="index-_005ctextendash-_0028or-_002d_002d_0029"></a> </dt> <dd><a name="index-e_002ddash"></a> -<p>En-dash: — (for ranges). +<p>En-dash: – (for ranges). </p> </dd> <dt><code>\texteuro</code> @@ -9214,7 +11533,8 @@ environment, pushes current column to the right of the previous column <dt><code>\b</code></dt> <dd><a name="index-_005cb-_0028bar_002dunder-accent_0029"></a> <a name="index-bar_002dunder-accent"></a> -<p>Produces a bar accent under the following, as in o_. +<p>Produces a bar accent under the following, as in o_. See +also <code>\underbar</code> hereinafter. </p> </dd> <dt><code>\c</code></dt> @@ -9298,6 +11618,7 @@ the OT1 encoding. The argument is always processed in horizontal mode. The bar is always a fixed position under the baseline, thus crossing through descenders. See also <code>\underline</code> in <a href="#Math-miscellany">Math miscellany</a>. +See also <code>\b</code> above. </p> </dd> <dt><code>\v</code></dt> @@ -9431,6 +11752,7 @@ Next: <a href="#g_t_005ctoday" accesskey="n" rel="next">\today</a>, Previous: <a </div> <a name="g_t_005crule-1"></a> <h3 class="section">21.5 <code>\rule</code></h3> + <a name="index-_005crule"></a> <p>Synopsis: @@ -9465,7 +11787,9 @@ Previous: <a href="#g_t_005crule" accesskey="p" rel="prev">\rule</a>, Up: <a hre </div> <a name="g_t_005ctoday-1"></a> <h3 class="section">21.6 <code>\today</code></h3> + <a name="index-_005ctoday"></a> +<a name="index-date_002c-today_0027s"></a> <p>The <code>\today</code> command produces today’s date, in the format ‘<samp><var>month</var> <var>dd</var>, <var>yyyy</var></samp>’; for example, ‘July 4, 1976’. @@ -9486,6 +11810,7 @@ Next: <a href="#Front_002fback-matter" accesskey="n" rel="next">Front/back matte </div> <a name="Splitting-the-input-1"></a> <h2 class="chapter">22 Splitting the input</h2> + <a name="index-splitting-the-input-file"></a> <a name="index-input-file"></a> @@ -9516,6 +11841,7 @@ Next: <a href="#g_t_005cincludeonly" accesskey="n" rel="next">\includeonly</a>, </div> <a name="g_t_005cinclude-1"></a> <h3 class="section">22.1 <code>\include</code></h3> + <a name="index-_005cinclude"></a> <p>Synopsis: @@ -9546,6 +11872,7 @@ Next: <a href="#g_t_005cinput" accesskey="n" rel="next">\input</a>, Previous: <a </div> <a name="g_t_005cincludeonly-1"></a> <h3 class="section">22.2 \<code>includeonly</code></h3> + <a name="index-_005cincludeonly"></a> <p>Synopsis: @@ -9570,7 +11897,8 @@ effective. Previous: <a href="#g_t_005cincludeonly" accesskey="p" rel="prev">\includeonly</a>, Up: <a href="#Splitting-the-input" accesskey="u" rel="up">Splitting the input</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005cinput-1"></a> -<h3 class="section">22.3 \input</h3> +<h3 class="section">22.3 <code>\input</code></h3> + <a name="index-_005cinput"></a> <p>Synopsis: @@ -9588,6 +11916,7 @@ file at that point. or ‘<samp>foo.bar.tex</samp>’). If that is not found, the original <var>file</var> is tried (‘<samp>foo</samp>’ or ‘<samp>foo.bar</samp>’). </p> + <hr> <a name="Front_002fback-matter"></a> <div class="header"> @@ -9658,7 +11987,8 @@ as for the table of contents. Next: <a href="#g_t_005caddtocontents" accesskey="n" rel="next">\addtocontents</a>, Up: <a href="#Tables-of-contents" accesskey="u" rel="up">Tables of contents</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005caddcontentsline-1"></a> -<h4 class="subsection">23.1.1 \addcontentsline</h4> +<h4 class="subsection">23.1.1 <code>\addcontentsline</code></h4> + <a name="index-_005caddcontentsline_007bext_007d_007bunit_007d_007btext_007d"></a> <a name="index-table-of-contents-entry_002c-manually-adding"></a> @@ -9708,7 +12038,8 @@ command <code>\contentsline{<var>unit</var>}{<var>name</var>}</code>. Previous: <a href="#g_t_005caddcontentsline" accesskey="p" rel="prev">\addcontentsline</a>, Up: <a href="#Tables-of-contents" accesskey="u" rel="up">Tables of contents</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005caddtocontents-1"></a> -<h4 class="subsection">23.1.2 \addtocontents</h4> +<h4 class="subsection">23.1.2 <code>\addtocontents</code></h4> + <a name="index-_005caddtocontents_007bext_007d_007btext_007d"></a> <p>The <code>\addtocontents</code>{<var>ext</var>}{<var>text</var>} command adds text @@ -9736,6 +12067,7 @@ Next: <a href="#Indexes" accesskey="n" rel="next">Indexes</a>, Previous: <a href </div> <a name="Glossaries-1"></a> <h3 class="section">23.2 Glossaries</h3> + <a name="index-glossaries"></a> <a name="index-_005cmakeglossary"></a> @@ -9764,6 +12096,7 @@ Previous: <a href="#Glossaries" accesskey="p" rel="prev">Glossaries</a>, Up: <a </div> <a name="Indexes-1"></a> <h3 class="section">23.3 Indexes</h3> + <a name="index-indexes"></a> <a name="index-_005cmakeindex"></a> @@ -9832,73 +12165,117 @@ Next: <a href="#Terminal-input_002foutput" accesskey="n" rel="next">Terminal inp </div> <a name="Letters-1"></a> <h2 class="chapter">24 Letters</h2> -<a name="index-letters"></a> -<a name="index-creating-letters"></a> -<p>You can use LaTeX to typeset letters, both personal and business. The -<code>letter</code> document class is designed to make a number of letters at -once, although you can make just one if you so desire. -</p> -<p>Your <samp>.tex</samp> source file has the same minimum commands as the other -document classes, i.e., you must have the following commands as a -minimum: +<a name="index-letters_002c-writing"></a> +<a name="index-writing-letters"></a> + +<p>Synopsis: </p> <div class="example"> -<pre class="example"> \documentclass{letter} - \begin{document} - ... letters ... - \end{document} +<pre class="example">\documentclass{letter} +\address{<var>sender address</var>} +\signature{<var>sender name</var>} +\begin{document} +\begin{letter}{<var>recipient address</var>} +\opening{<var>salutation</var>} + <var>letter body</var> +\closing{<var>closing text</var>} +\end{letter} + ... more letters ... +\end{document} </pre></div> -<p>Each letter is a <code>letter</code> environment, whose argument is the name -and address of the recipient. For example, you might have: +<p>Produce one or more letters. +</p> +<p>Each letter is in a separate <code>letter</code> environment, whose argument +<var>recipient address</var> often contains multiple lines separated with a +double backslash (<code>\\</code>). For example, you might have: </p> <div class="example"> -<pre class="example"> \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. - \\ Edinburgh, EH1 1AA} +<pre class="example"> \begin{letter}{Mr. Joe Smith \\ + 2345 Princess St. \\ + Edinburgh, EH1 1AA} ... \end{letter} </pre></div> -<p>The letter itself begins with the <code>\opening</code> command. The text of -the letter follows. It is typed as ordinary LaTeX input. Commands that -make no sense in a letter, like <code>\chapter</code>, do not work. The letter -closes with a <code>\closing</code> command. +<p>The start of the <code>letter</code> environment resets the page number to 1, +and the footnote number to 1 also. +</p> +<p>The <var>sender address</var> and <var>sender name</var> are common to all of the +letters, whether there is one or more, so these are best put in the +preamble. As with the recipient address, often <var>sender address</var> +contains multiple lines separated by a double +backslash (<code>\\</code>). LaTeX will put the <var>sender name</var> +under the closing, after a vertical space for the traditional +hand-written signature; it also can contain multiple lines. +</p> +<p>Each letter environment begins with a required <code>\opening</code> command +such as <code>\opening{Dear Madam or Sir:}</code>. The <var>letter body</var> +text is ordinary LaTeX so it can contain everything from from +enumerated lists to displayed math, except that commands such as +<code>\chapter</code> that make no sense in a letter are turned off. Each +letter environment typically ends with a <code>\closing</code> command such as +<code>\closing{Yours,}</code>. </p> <a name="index-_005c_005c-for-letters"></a> -<p>After the <code>closing</code>, you can have additional material. The -<code>\cc</code> command produces the usual “cc: …”. There’s also a -similar <code>\encl</code> command for a list of enclosures. With both these -commands, use <code>\\</code> to separate the items. +<p>Additional material may come after the <code>\closing</code>. You can say who +is receiving a copy of the letter with a command like <code>\cc{the +Boss \\ the Boss's Boss}</code>. There’s a similar <code>\encl</code> command for +a list of enclosures. And, you can add a postscript with <code>\ps</code>. +</p> +<p>LaTeX’s default is to indent the signature and the <code>\closing</code> +above it by a length of <code>\longindentation</code>. By default this is +<code>0.5\textwidth</code>. To make them flush left, put +<code>\setlength{\longindentation}{0em}</code> in your preamble. +</p> +<p>To set a fixed date use something like +<code>\renewcommand{\today}{2015-Oct-12}</code>. If put in your preamble +then it will apply to all the letters. </p> +<p>This example shows only one <code>letter</code> environment. The three lines +marked as optional are typically omitted. +</p> +<div class="example"> +<pre class="example">\documentclass{letter} +\address{Sender's street \\ Sender's town} +\signature{Sender's name \\ Sender's title} +% optional: \location{Mailbox 13} +% optional: \telephone{(102) 555-0101} +\begin{document} +\begin{letter}{Recipient's name \\ Recipient's address} +\opening{Sir:} +% optional: \thispagestyle{firstpage} +I am not interested in entering a business arrangement with you. +\closing{Your most humble, etc.,} +\end{letter} +\end{document} +</pre></div> + <p>These commands are used with the <code>letter</code> class. </p> <table class="menu" border="0" cellspacing="0"> -<tr><td align="left" valign="top">• <a href="#g_t_005caddress" accesskey="1">\address</a>:</td><td> </td><td align="left" valign="top">Your return address. +<tr><td align="left" valign="top">• <a href="#g_t_005caddress" accesskey="1">\address</a>:</td><td> </td><td align="left" valign="top">Sender’s return address. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005ccc" accesskey="2">\cc</a>:</td><td> </td><td align="left" valign="top">Cc list. +<tr><td align="left" valign="top">• <a href="#g_t_005ccc" accesskey="2">\cc</a>:</td><td> </td><td align="left" valign="top">Carbon copy list. </td></tr> <tr><td align="left" valign="top">• <a href="#g_t_005cclosing" accesskey="3">\closing</a>:</td><td> </td><td align="left" valign="top">Saying goodbye. </td></tr> <tr><td align="left" valign="top">• <a href="#g_t_005cencl" accesskey="4">\encl</a>:</td><td> </td><td align="left" valign="top">List of enclosed material. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005clocation" accesskey="5">\location</a>:</td><td> </td><td align="left" valign="top">Your organization’s address. +<tr><td align="left" valign="top">• <a href="#g_t_005clocation" accesskey="5">\location</a>:</td><td> </td><td align="left" valign="top">Sender’s organizational location. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cmakelabels" accesskey="6">\makelabels</a>:</td><td> </td><td align="left" valign="top">Making address labels. +<tr><td align="left" valign="top">• <a href="#g_t_005cmakelabels" accesskey="6">\makelabels</a>:</td><td> </td><td align="left" valign="top">Make address labels. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cname" accesskey="7">\name</a>:</td><td> </td><td align="left" valign="top">Your name, for the return address. +<tr><td align="left" valign="top">• <a href="#g_t_005cname" accesskey="7">\name</a>:</td><td> </td><td align="left" valign="top">Sender’s name, for the return address. </td></tr> <tr><td align="left" valign="top">• <a href="#g_t_005copening" accesskey="8">\opening</a>:</td><td> </td><td align="left" valign="top">Saying hello. </td></tr> <tr><td align="left" valign="top">• <a href="#g_t_005cps" accesskey="9">\ps</a>:</td><td> </td><td align="left" valign="top">Adding a postscript. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005csignature">\signature</a>:</td><td> </td><td align="left" valign="top">Your signature. -</td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cstartbreaks">\startbreaks</a>:</td><td> </td><td align="left" valign="top">Allow page breaks. -</td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005cstopbreaks">\stopbreaks</a>:</td><td> </td><td align="left" valign="top">Disallow page breaks. +<tr><td align="left" valign="top">• <a href="#g_t_005csignature">\signature</a>:</td><td> </td><td align="left" valign="top">Sender’s signature. </td></tr> -<tr><td align="left" valign="top">• <a href="#g_t_005ctelephone">\telephone</a>:</td><td> </td><td align="left" valign="top">Your phone number. +<tr><td align="left" valign="top">• <a href="#g_t_005ctelephone">\telephone</a>:</td><td> </td><td align="left" valign="top">Sender’s phone number. </td></tr> </table> @@ -9909,20 +12286,38 @@ commands, use <code>\\</code> to separate the items. <p> Next: <a href="#g_t_005ccc" accesskey="n" rel="next">\cc</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005caddress_007breturn_002daddress_007d"></a> -<h3 class="section">24.1 \address{<var>return-address}</var></h3> +<a name="g_t_005caddress-1"></a> +<h3 class="section">24.1 <code>\address</code></h3> + <a name="index-_005caddress"></a> -<p>The <code>\address</code> specifies the return address of a letter, as it -should appear on the letter and the envelope. Separate lines of the -address should be separated by <code>\\</code> commands. +<p>Synopsis: +</p> +<div class="example"> +<pre class="example">\address{<var>senders address</var>} +</pre></div> + +<p>Specifies the return address as it appears on the letter and on the +envelope. Separate multiple lines in <var>senders address</var> with a +double backslash <code>\\</code>. </p> -<p>If you do not make an <code>\address</code> declaration, then the letter -will be formatted for copying onto your organization’s standard -letterhead. (See <a href="#Overview">Overview</a>, for details on your local -implementation). If you give an <code>\address</code> declaration, then the -letter will be formatted as a personal letter. +<p>Because it can apply to multiple letters this declaration is often put +in the preamble. However, it can go anywhere, including inside an +individual <code>letter</code> environment. </p> +<p>This command is optional: without the <code>\address</code> declaration the +letter is formatted with some blank space on top, for copying onto +pre-printed letterhead paper. (See <a href="#Overview">Overview</a>, for details on your +local implementation.) With the <code>\address</code> declaration, it is +formatted as a personal letter. +</p> +<p>Here is an example. +</p> +<div class="example"> +<pre class="example">\address{Stephen Maturin \\ + The Grapes of the Savoy} +</pre></div> + <hr> <a name="g_t_005ccc"></a> @@ -9939,12 +12334,20 @@ Next: <a href="#g_t_005cclosing" accesskey="n" rel="next">\closing</a>, Previous <p>Synopsis: </p> <div class="example"> -<pre class="example">\cc{<var>name1</var>\\<var>name2</var>} +<pre class="example">\cc{<var>first name</var> \\ + .. } </pre></div> -<p>Produce a list of <var>name</var>s the letter was copied to. Each name is -printed on a separate line. +<p>Produce a list of names to which copies of the letter were sent. This +command is optional. If it appears then typically it comes after +<code>\closing</code>. Separate multiple lines with a double +backslash <code>\\</code>. </p> +<div class="example"> +<pre class="example">\cc{President \\ + Vice President} +</pre></div> + <hr> <a name="g_t_005cclosing"></a> @@ -9965,9 +12368,11 @@ Next: <a href="#g_t_005cencl" accesskey="n" rel="next">\encl</a>, Previous: <a h <pre class="example">\closing{text} </pre></div> -<p>A letter closes with a <code>\closing</code> command, for example, -</p><div class="example"> -<pre class="example">\closing{Best Regards,} +<p>Usually at the end of a letter, above the handwritten signature, there +is a <code>\closing</code> (although this command is optional). For example, +</p> +<div class="example"> +<pre class="example">\closing{Regards,} </pre></div> @@ -9986,11 +12391,19 @@ Next: <a href="#g_t_005clocation" accesskey="n" rel="next">\location</a>, Previo <p>Synopsis: </p> <div class="example"> -<pre class="example">\encl{<var>line1</var>\\<var>line2</var>} +<pre class="example">\encl{<var>first enclosed object</var> \\ + .. } </pre></div> -<p>Declare a list of one more enclosures. +<p>Produce a list of things included with the letter. This command is +optional; when it is used, it typically is put after <code>\closing</code>. +Separate multiple lines with a double backslash <code>\\</code>. </p> +<div class="example"> +<pre class="example">\encl{License \\ + Passport } +</pre></div> + <hr> <a name="g_t_005clocation"></a> @@ -10000,12 +12413,17 @@ Next: <a href="#g_t_005cmakelabels" accesskey="n" rel="next">\makelabels</a>, Pr </div> <a name="g_t_005clocation-1"></a> <h3 class="section">24.5 <code>\location</code></h3> + <a name="index-_005clocation"></a> -<p><code>\location{address}</code> +<p>Synopsis: </p> -<p>This modifies your organization’s standard address. This only appears -if the <code>firstpage</code> pagestyle is selected. +<div class="example"> +<pre class="example">\location{<var>text</var>} +</pre></div> + +<p>The <var>text</var> appears centered at the bottom of the each page. It only +appears if the page style is <code>firstpage</code>. </p> <hr> @@ -10016,15 +12434,31 @@ Next: <a href="#g_t_005cname" accesskey="n" rel="next">\name</a>, Previous: <a h </div> <a name="g_t_005cmakelabels-1"></a> <h3 class="section">24.6 <code>\makelabels</code></h3> + <a name="index-_005cmakelabels"></a> -<p><code>\makelabels{number}</code> -</p> -<p>If you issue this command in the preamble, LaTeX will create a sheet of -address labels. This sheet will be output before the letters. +<p>Synopsis: </p> +<div class="example"> +<pre class="example">\makelabels +</pre></div> - +<p>Create a sheet of address labels from the recipient addresses, one for +each letter. This sheet will be output before the letters, with the idea +that you can copy it to a sheet of peel-off labels. This command goes +in the preamble. +</p> +<p>Customize the labels by redefining the commands <code>\startlabels</code>, +<code>\mlabel</code>, and <code>\returnaddress</code> in the preamble. The command +<code>\startlabels</code> sets the width, height, number of columns, etc., of +the page onto which the labels are printed. The command +<code>\mlabel{<var>sender address</var>}{<var>recipient address</var>}</code> +produces the two labels (or one, if you choose to ignore the <var>sender +address</var>). The <var>sender address</var> is the value returned by the macro +<code>\returnaddress</code> while <var>recipient address</var> is the value passed +in the argument to the <code>letter</code> environment. By default +<code>\mlabel</code> ignores the first argument, the <var>sender address</var>. +</p> <hr> <a name="g_t_005cname"></a> <div class="header"> @@ -10033,12 +12467,17 @@ Next: <a href="#g_t_005copening" accesskey="n" rel="next">\opening</a>, Previous </div> <a name="g_t_005cname-1"></a> <h3 class="section">24.7 <code>\name</code></h3> + <a name="index-_005cname"></a> -<p><code>\name{June Davenport}</code> +<p>Synopsis: </p> -<p>Your name, used for printing on the envelope together with the return -address. +<div class="example"> +<pre class="example">\name{<var>name</var>} +</pre></div> + +<p>Sender’s name, used for printing on the envelope together with the +return address. </p> <hr> @@ -10047,8 +12486,9 @@ address. <p> Next: <a href="#g_t_005cps" accesskey="n" rel="next">\ps</a>, Previous: <a href="#g_t_005cname" accesskey="p" rel="prev">\name</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005copening_007btext_007d"></a> -<h3 class="section">24.8 <code>\opening{<var>text</var>}</code></h3> +<a name="g_t_005copening-1"></a> +<h3 class="section">24.8 <code>\opening</code></h3> + <a name="index-_005copening"></a> <a name="index-letters_002c-starting"></a> @@ -10058,12 +12498,12 @@ Next: <a href="#g_t_005cps" accesskey="n" rel="next">\ps</a>, Previous: <a href= <pre class="example">\opening{<var>text</var>} </pre></div> -<p>A letter begins with the <code>\opening</code> command. The mandatory -argument, <var>text</var>, is whatever text you wish to start your letter. -For instance: +<p>This command is required. It starts a letter, following the +<code>\begin{letter}{..}</code>. The mandatory argument <var>text</var> is the +text that starts your letter. For instance: </p> <div class="example"> -<pre class="example">\opening{Dear Joe,} +<pre class="example">\opening{Dear John:} </pre></div> @@ -10078,69 +12518,89 @@ Next: <a href="#g_t_005csignature" accesskey="n" rel="next">\signature</a>, Prev <a name="index-_005cps"></a> <a name="index-postscript_002c-in-letters"></a> -<p>Use the <code>\ps</code> command to start a postscript in a letter, after +<p>Synopsis: +</p> +<div class="example"> +<pre class="example">\ps{<var>text</var>} +</pre></div> + +<p>Add a postscript. This command is optional and usually is used after <code>\closing</code>. </p> +<div class="example"> +<pre class="example">\ps{P.S. After you have read this letter, burn it. Or eat it.} +</pre></div> + <hr> <a name="g_t_005csignature"></a> <div class="header"> <p> -Next: <a href="#g_t_005cstartbreaks" accesskey="n" rel="next">\startbreaks</a>, Previous: <a href="#g_t_005cps" accesskey="p" rel="prev">\ps</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Next: <a href="#g_t_005ctelephone" accesskey="n" rel="next">\telephone</a>, Previous: <a href="#g_t_005cps" accesskey="p" rel="prev">\ps</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> -<a name="g_t_005csignature_007btext_007d"></a> -<h3 class="section">24.10 <code>\signature{<var>text</var>}</code></h3> -<a name="index-_005csignature"></a> +<a name="g_t_005csignature-1"></a> +<h3 class="section">24.10 <code>\signature</code></h3> -<p>Your name, as it should appear at the end of the letter underneath the -space for your signature. <code>\\</code> starts a new line within -<var>text</var> as usual. +<p>Synopsis: </p> +<div class="example"> +<pre class="example">\signature{<var>first line</var> \\ + .. } +</pre></div> -<hr> -<a name="g_t_005cstartbreaks"></a> -<div class="header"> -<p> -Next: <a href="#g_t_005cstopbreaks" accesskey="n" rel="next">\stopbreaks</a>, Previous: <a href="#g_t_005csignature" accesskey="p" rel="prev">\signature</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> -</div> -<a name="g_t_005cstartbreaks-1"></a> -<h3 class="section">24.11 <code>\startbreaks</code></h3> -<a name="index-_005cstartbreaks"></a> +<a name="index-_005csignature"></a> -<p><code>\startbreaks</code> +<p>The sender’s name. This command is optional, although its inclusion is +usual. </p> -<p>Used after a <code>\stopbreaks</code> command to allow page breaks again. +<p>The argument text appears at the end of the letter, after the closing +and after a vertical space for the traditional hand-written +signature. Separate multiple lines with a double +backslash <code>\\</code>. For example: </p> +<div class="example"> +<pre class="example">\signature{J Fred Muggs \\ + White House} +</pre></div> -<hr> -<a name="g_t_005cstopbreaks"></a> -<div class="header"> -<p> -Next: <a href="#g_t_005ctelephone" accesskey="n" rel="next">\telephone</a>, Previous: <a href="#g_t_005cstartbreaks" accesskey="p" rel="prev">\startbreaks</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> -</div> -<a name="g_t_005cstopbreaks-1"></a> -<h3 class="section">24.12 <code>\stopbreaks</code></h3> -<a name="index-_005cstopbreaks"></a> - -<p><code>\stopbreaks</code> +<p>LaTeX’s default for the vertical space from the <code>\closing</code> text +down to the <code>\signature</code> text is <code>6\medskipamount</code>, which is +six times 0.7em. </p> -<p>Inhibit page breaks until a <code>\startbreaks</code> command occurs. +<p>This command is usually in the preamble, to apply to all the letters in +the document. To have it apply to one letter only, put it inside a +<code>letter</code> environment and before the <code>\closing</code>. </p> +<p>You can include a graphic in the signature, for instance with +<code>\signature{\vspace{-6\medskipamount}\includegraphics{sig.png}\\ +My name}</code> (this requires writing <code>\usepackage{graphicx}</code> in the +preamble). +</p> + + + <hr> <a name="g_t_005ctelephone"></a> <div class="header"> <p> -Previous: <a href="#g_t_005cstopbreaks" accesskey="p" rel="prev">\stopbreaks</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> +Previous: <a href="#g_t_005csignature" accesskey="p" rel="prev">\signature</a>, Up: <a href="#Letters" accesskey="u" rel="up">Letters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p> </div> <a name="g_t_005ctelephone-1"></a> -<h3 class="section">24.13 <code>\telephone</code></h3> +<h3 class="section">24.11 <code>\telephone</code></h3> + <a name="index-_005ctelephone"></a> -<p><code>\telephone{number}</code> +<p>Synopsis: </p> -<p>This is your telephone number. This only appears if the -<code>firstpage</code> pagestyle is selected. +<div class="example"> +<pre class="example">\telephone{<var>number</var>} +</pre></div> + +<p>The sender’s telephone number. This is typically in the preamble, where +it applies to all letters. This only appears if the <code>firstpage</code> +pagestyle is selected. If so, it appears on the lower right of the +page. </p> <hr> @@ -10151,7 +12611,8 @@ Next: <a href="#Command-line" accesskey="n" rel="next">Command line</a>, Previou </div> <a name="Terminal-input_002foutput-1"></a> <h2 class="chapter">25 Terminal input/output</h2> -<a name="index-input_002foutput"></a> + +<a name="index-input_002foutput_002c-to-terminal"></a> <a name="index-terminal-input_002foutput"></a> <table class="menu" border="0" cellspacing="0"> @@ -10170,6 +12631,7 @@ Next: <a href="#g_t_005ctypeout" accesskey="n" rel="next">\typeout</a>, Up: <a h </div> <a name="g_t_005ctypein_005bcmd_005d_007bmsg_007d"></a> <h3 class="section">25.1 <code>\typein[<var>cmd</var>]{<var>msg</var>}</code></h3> + <a name="index-_005ctypein"></a> <p>Synopsis: @@ -10195,6 +12657,7 @@ Previous: <a href="#g_t_005ctypein" accesskey="p" rel="prev">\typein</a>, Up: <a </div> <a name="g_t_005ctypeout_007bmsg_007d"></a> <h3 class="section">25.2 <code>\typeout{<var>msg</var>}</code></h3> + <a name="index-_005ctypeout"></a> <p>Synopsis: @@ -10223,6 +12686,7 @@ Next: <a href="#Document-templates" accesskey="n" rel="next">Document templates< </div> <a name="Command-line-1"></a> <h2 class="chapter">26 Command line</h2> + <a name="index-command-line"></a> <a name="index-_002etex_002c-default-extension"></a> @@ -10260,7 +12724,9 @@ Next: <a href="#Concept-Index" accesskey="n" rel="next">Concept Index</a>, Previ </div> <a name="Document-templates-1"></a> <h2 class="appendix">Appendix A Document templates</h2> + <a name="index-document-templates"></a> +<a name="index-templates_002c-document"></a> <p>Although not reference material, perhaps these document templates will be useful. Additional template resources are listed at @@ -10286,6 +12752,8 @@ Next: <a href="#book-template" accesskey="n" rel="next">book template</a>, Up: < <h3 class="section">A.1 <code>beamer</code> template</h3> <a name="index-beamer-template-and-class"></a> +<a name="index-template_002c-beamer"></a> + <p>The <code>beamer</code> class creates presentation slides. It has a vast array of features, but here is a basic template: </p> @@ -10324,6 +12792,8 @@ Next: <a href="#tugboat-template" accesskey="n" rel="next">tugboat template</a>, <a name="book-template-1"></a> <h3 class="section">A.2 <code>book</code> template</h3> +<a name="index-template_002c-book"></a> + <pre class="verbatim">\documentclass{book} \title{Book Class Template} \author{Alex Author} @@ -10351,6 +12821,7 @@ Previous: <a href="#book-template" accesskey="p" rel="prev">book template</a>, U <a name="tugboat-template-1"></a> <h3 class="section">A.3 <code>tugboat</code> template</h3> +<a name="index-template_002c-TUGboat"></a> <a name="index-TUGboat-template"></a> <a name="index-ltugboat-class"></a> @@ -10500,9 +12971,7 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_symbol-1">*</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-_002a-prompt">‘<samp>*</samp>’ prompt</a>:</td><td> </td><td valign="top"><a href="#Command-line">Command line</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_002a_002dform-of-defining-new-commands">*-form of defining new commands</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_002a_002dform-of-environment-commands">*-form of environment commands</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_002a_002dform-of-sectioning-commands">*-form of sectioning commands</a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_002a_002dform-of-sectioning-commands"><code>*</code>-form of sectioning commands</a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_symbol-2">.</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-_002eglo-file"><samp>.glo</samp> file</a>:</td><td> </td><td valign="top"><a href="#Glossaries">Glossaries</a></td></tr> @@ -10534,6 +13003,7 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-ASCII-circumflex_002c-in-text">ASCII circumflex, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-ASCII-tilde_002c-in-text">ASCII tilde, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-asterisk_002c-centered_002c-in-text">asterisk, centered, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-at-clause_002c-in-font-definitions">at clause, in font definitions</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewfont">\newfont</a></td></tr> <tr><td></td><td valign="top"><a href="#index-author_002c-for-titlepage">author, for titlepage</a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-auxiliary-file">auxiliary file</a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td colspan="4"> <hr></td></tr> @@ -10547,15 +13017,18 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-bar_002dunder-accent">bar-under accent</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-basics-of-LaTeX">basics of LaTeX</a>:</td><td> </td><td valign="top"><a href="#Overview">Overview</a></td></tr> <tr><td></td><td valign="top"><a href="#index-beamer-template-and-class"><code>beamer</code> template and class</a>:</td><td> </td><td valign="top"><a href="#beamer-template">beamer template</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-beginning-of-document-hook">beginning of document hook</a>:</td><td> </td><td valign="top"><a href="#g_t_005cAtBeginDocument">\AtBeginDocument</a></td></tr> <tr><td></td><td valign="top"><a href="#index-bibliography-format_002c-open">bibliography format, open</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-bibliography_002c-creating-_0028automatically_0029">bibliography, creating (automatically)</a>:</td><td> </td><td valign="top"><a href="#Using-BibTeX">Using BibTeX</a></td></tr> <tr><td></td><td valign="top"><a href="#index-bibliography_002c-creating-_0028manually_0029">bibliography, creating (manually)</a>:</td><td> </td><td valign="top"><a href="#thebibliography">thebibliography</a></td></tr> <tr><td></td><td valign="top"><a href="#index-bibTeX_002c-using">bibTeX, using</a>:</td><td> </td><td valign="top"><a href="#Using-BibTeX">Using BibTeX</a></td></tr> <tr><td></td><td valign="top"><a href="#index-big-circle-symbols_002c-in-text">big circle symbols, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Big-point">Big point</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-black-boxes_002c-omitting">black boxes, omitting</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-bold-font">bold font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-bold-math">bold math</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-bold-typewriter_002c-avoiding">bold typewriter, avoiding</a>:</td><td> </td><td valign="top"><a href="#description">description</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-box_002c-allocating-new">box, allocating new</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewsavebox">\newsavebox</a></td></tr> <tr><td></td><td valign="top"><a href="#index-boxes">boxes</a>:</td><td> </td><td valign="top"><a href="#Boxes">Boxes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-brace_002c-left_002c-in-text">brace, left, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-brace_002c-right_002c-in-text">brace, right, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> @@ -10579,11 +13052,13 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-centered-period_002c-in-text">centered period, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-centering-text_002c-declaration-for">centering text, declaration for</a>:</td><td> </td><td valign="top"><a href="#g_t_005ccentering">\centering</a></td></tr> <tr><td></td><td valign="top"><a href="#index-centering-text_002c-environment-for">centering text, environment for</a>:</td><td> </td><td valign="top"><a href="#center">center</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Centimeter">Centimeter</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-characters_002c-accented">characters, accented</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-characters_002c-non_002dEnglish">characters, non-English</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-characters_002c-reserved">characters, reserved</a>:</td><td> </td><td valign="top"><a href="#Reserved-characters">Reserved characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-check-accent">check accent</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-check-accent_002c-math">check accent, math</a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Cicero">Cicero</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-circle-symbol_002c-big_002c-in-text">circle symbol, big, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-circled-letter_002c-in-text">circled letter, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-circumflex-accent">circumflex accent</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> @@ -10597,6 +13072,8 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-command-line">command line</a>:</td><td> </td><td valign="top"><a href="#Command-line">Command line</a></td></tr> <tr><td></td><td valign="top"><a href="#index-command-syntax">command syntax</a>:</td><td> </td><td valign="top"><a href="#LaTeX-command-syntax">LaTeX command syntax</a></td></tr> <tr><td></td><td valign="top"><a href="#index-commands_002c-defining-new-ones">commands, defining new ones</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-commands_002c-defining-new-ones-1">commands, defining new ones</a>:</td><td> </td><td valign="top"><a href="#g_t_005cprovidecommand">\providecommand</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-commands_002c-redefining">commands, redefining</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></td></tr> <tr><td></td><td valign="top"><a href="#index-composite-word-mark_002c-in-text">composite word mark, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-computer-programs_002c-typesetting">computer programs, typesetting</a>:</td><td> </td><td valign="top"><a href="#verbatim">verbatim</a></td></tr> <tr><td></td><td valign="top"><a href="#index-contents-file">contents file</a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> @@ -10604,8 +13081,8 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-counters_002c-a-list-of">counters, a list of</a>:</td><td> </td><td valign="top"><a href="#Counters">Counters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-counters_002c-defining-new">counters, defining new</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewcounter">\newcounter</a></td></tr> <tr><td></td><td valign="top"><a href="#index-counters_002c-getting-value-of">counters, getting value of</a>:</td><td> </td><td valign="top"><a href="#g_t_005cvalue">\value</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-counters_002c-printing">counters, printing</a>:</td><td> </td><td valign="top"><a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a></td></tr> <tr><td></td><td valign="top"><a href="#index-counters_002c-setting">counters, setting</a>:</td><td> </td><td valign="top"><a href="#g_t_005csetcounter">\setcounter</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-creating-letters">creating letters</a>:</td><td> </td><td valign="top"><a href="#Letters">Letters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-creating-pictures">creating pictures</a>:</td><td> </td><td valign="top"><a href="#picture">picture</a></td></tr> <tr><td></td><td valign="top"><a href="#index-creating-tables">creating tables</a>:</td><td> </td><td valign="top"><a href="#table">table</a></td></tr> <tr><td></td><td valign="top"><a href="#index-credit-footnote">credit footnote</a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr> @@ -10621,17 +13098,21 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-dagger_002c-in-text">dagger, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-dagger_002c-in-text-1">dagger, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-date_002c-for-titlepage">date, for titlepage</a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-date_002c-today_0027s">date, today’s</a>:</td><td> </td><td valign="top"><a href="#g_t_005ctoday">\today</a></td></tr> <tr><td></td><td valign="top"><a href="#index-datetime-package"><code>datetime</code> package</a>:</td><td> </td><td valign="top"><a href="#g_t_005ctoday">\today</a></td></tr> <tr><td></td><td valign="top"><a href="#index-defining-a-new-command">defining a new command</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-defining-a-new-command-1">defining a new command</a>:</td><td> </td><td valign="top"><a href="#g_t_005cprovidecommand">\providecommand</a></td></tr> <tr><td></td><td valign="top"><a href="#index-defining-new-environments">defining new environments</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></td></tr> <tr><td></td><td valign="top"><a href="#index-defining-new-fonts">defining new fonts</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewfont">\newfont</a></td></tr> <tr><td></td><td valign="top"><a href="#index-defining-new-theorems">defining new theorems</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewtheorem">\newtheorem</a></td></tr> <tr><td></td><td valign="top"><a href="#index-definitions">definitions</a>:</td><td> </td><td valign="top"><a href="#Definitions">Definitions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-description-lists_002c-creating">description lists, creating</a>:</td><td> </td><td valign="top"><a href="#description">description</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-design-size_002c-in-font-definitions">design size, in font definitions</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewfont">\newfont</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Didot-point">Didot point</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-dieresis-accent">dieresis accent</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-discretionary-multiplication">discretionary multiplication</a>:</td><td> </td><td valign="top"><a href="#Math-miscellany">Math miscellany</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-displaying-quoted-text-with-paragraph-indentation">displaying quoted text with paragraph indentation</a>:</td><td> </td><td valign="top"><a href="#quotation">quotation</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-displaying-quoted-text-without-paragraph-indentation">displaying quoted text without paragraph indentation</a>:</td><td> </td><td valign="top"><a href="#quote">quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-displaying-quoted-text-with-paragraph-indentation">displaying quoted text with paragraph indentation</a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-displaying-quoted-text-without-paragraph-indentation">displaying quoted text without paragraph indentation</a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> <tr><td></td><td valign="top"><a href="#index-document-class-options">document class options</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-document-class_002c-defined">document class, defined</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> <tr><td></td><td valign="top"><a href="#index-document-classes">document classes</a>:</td><td> </td><td valign="top"><a href="#Document-classes">Document classes</a></td></tr> @@ -10661,15 +13142,18 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-e_002ddash">e-dash</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-e_002dTeX">e-TeX</a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td></td><td valign="top"><a href="#index-ellipsis">ellipsis</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-em">em</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-em_002ddash">em-dash</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-em_002ddash_002c-three_002dquarters">em-dash, three-quarters</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-em_002ddash_002c-two_002dthirds">em-dash, two-thirds</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-emphasis">emphasis</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-emphasis-1">emphasis</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-enclosure-list">enclosure list</a>:</td><td> </td><td valign="top"><a href="#g_t_005cencl">\encl</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-ending-_0026-starting">ending & starting</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-end-of-document-hook">end of document hook</a>:</td><td> </td><td valign="top"><a href="#g_t_005cAtEndDocument">\AtEndDocument</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-ending-and-starting">ending and starting</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> <tr><td></td><td valign="top"><a href="#index-engines_002c-TeX">engines, TeX</a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td></td><td valign="top"><a href="#index-enlarge-current-page">enlarge current page</a>:</td><td> </td><td valign="top"><a href="#g_t_005cenlargethispage">\enlargethispage</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-environment">environment</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-environment_002c-theorem_002dlike">environment, theorem-like</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewtheorem">\newtheorem</a></td></tr> <tr><td></td><td valign="top"><a href="#index-environments">environments</a>:</td><td> </td><td valign="top"><a href="#Environments">Environments</a></td></tr> <tr><td></td><td valign="top"><a href="#index-environments_002c-defining">environments, defining</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></td></tr> <tr><td></td><td valign="top"><a href="#index-equation-number_002c-cross-referencing">equation number, cross referencing</a>:</td><td> </td><td valign="top"><a href="#g_t_005cref">\ref</a></td></tr> @@ -10681,20 +13165,25 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-es_002dzet-German-letter">es-zet German letter</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-eth_002c-Icelandic-letter">eth, Icelandic letter</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-euro-symbol">euro symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-ex">ex</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-exclamation-point_002c-upside_002ddown">exclamation point, upside-down</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-exponent">exponent</a>:</td><td> </td><td valign="top"><a href="#Subscripts-_0026-superscripts">Subscripts & superscripts</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-external-files_002c-creating">external files, creating</a>:</td><td> </td><td valign="top"><a href="#filecontents">filecontents</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-external-files_002c-writing">external files, writing</a>:</td><td> </td><td valign="top"><a href="#filecontents">filecontents</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-F">F</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-families_002c-of-fonts">families, of fonts</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-feminine-ordinal-symbol">feminine ordinal symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-figure-number_002c-cross-referencing">figure number, cross referencing</a>:</td><td> </td><td valign="top"><a href="#g_t_005cref">\ref</a></td></tr> <tr><td></td><td valign="top"><a href="#index-figures_002c-footnotes-in">figures, footnotes in</a>:</td><td> </td><td valign="top"><a href="#minipage">minipage</a></td></tr> <tr><td></td><td valign="top"><a href="#index-figures_002c-inserting">figures, inserting</a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> <tr><td></td><td valign="top"><a href="#index-fixed_002dwidth-font">fixed-width font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-float-package"><code>float</code> package</a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-float-package"><code>float</code> package</a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-float-page">float page</a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-flush-left-equations">flush left equations</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-flushing-floats-and-starting-a-page">flushing floats and starting a page</a>:</td><td> </td><td valign="top"><a href="#g_t_005cclearpage">\clearpage</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-font-catalogue">font catalogue</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-font-commands_002c-low_002dlevel">font commands, low-level</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-font-size">font size</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-font-sizes">font sizes</a>:</td><td> </td><td valign="top"><a href="#Font-sizes">Font sizes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-font-styles">font styles</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-fonts">fonts</a>:</td><td> </td><td valign="top"><a href="#Fonts">Fonts</a></td></tr> @@ -10705,7 +13194,9 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-footnote-parameters">footnote parameters</a>:</td><td> </td><td valign="top"><a href="#Footnote-parameters">Footnote parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-footnotes-in-figures">footnotes in figures</a>:</td><td> </td><td valign="top"><a href="#minipage">minipage</a></td></tr> <tr><td></td><td valign="top"><a href="#index-footnotes_002c-creating">footnotes, creating</a>:</td><td> </td><td valign="top"><a href="#Footnotes">Footnotes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-footnotes_002c-symbolic-instead-of-numbered">footnotes, symbolic instead of numbered</a>:</td><td> </td><td valign="top"><a href="#Symbolic-footnotes">Symbolic footnotes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Footnotes_002c-in-a-minipage">Footnotes, in a minipage</a>:</td><td> </td><td valign="top"><a href="#g_t_005cfootnote">\footnote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Footnotes_002c-in-a-table">Footnotes, in a table</a>:</td><td> </td><td valign="top"><a href="#Footnotes-in-a-table">Footnotes in a table</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-footnotes_002c-symbols-instead-of-numbers">footnotes, symbols instead of numbers</a>:</td><td> </td><td valign="top"><a href="#g_t_005cfootnote">\footnote</a></td></tr> <tr><td></td><td valign="top"><a href="#index-formulas_002c-environment-for">formulas, environment for</a>:</td><td> </td><td valign="top"><a href="#equation">equation</a></td></tr> <tr><td></td><td valign="top"><a href="#index-formulas_002c-math">formulas, math</a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> <tr><td></td><td valign="top"><a href="#index-forward-references_002c-resolving">forward references, resolving</a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> @@ -10714,10 +13205,12 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-functions_002c-math">functions, math</a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-G">G</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-geometry-package"><code>geometry</code> package</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-global-options">global options</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-global-options-1">global options</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-glossaries">glossaries</a>:</td><td> </td><td valign="top"><a href="#Glossaries">Glossaries</a></td></tr> <tr><td></td><td valign="top"><a href="#index-glossary-package">glossary <span class="roman">package</span></a>:</td><td> </td><td valign="top"><a href="#Glossaries">Glossaries</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-glue-register_002c-plain-TeX">glue register, plain TeX</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewlength">\newlength</a></td></tr> <tr><td></td><td valign="top"><a href="#index-graphics-packages">graphics packages</a>:</td><td> </td><td valign="top"><a href="#g_t_005cline">\line</a></td></tr> <tr><td></td><td valign="top"><a href="#index-grave-accent">grave accent</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-grave-accent_002c-math">grave accent, math</a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> @@ -10732,7 +13225,7 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-header-style">header style</a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagestyle">\pagestyle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-header_002c-parameters-for">header, parameters for</a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-hello_002c-world">hello, world</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-here_002c-putting-floats">here, putting floats</a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-here_002c-putting-floats">here, putting floats</a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-hungarian-umlaut-accent">hungarian umlaut accent</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-hyphenation_002c-defining">hyphenation, defining</a>:</td><td> </td><td valign="top"><a href="#g_t_005chyphenation">\hyphenation</a></td></tr> <tr><td></td><td valign="top"><a href="#index-hyphenation_002c-forcing">hyphenation, forcing</a>:</td><td> </td><td valign="top"><a href="#g_t_005c_002d-_0028hyphenation_0029">\- (hyphenation)</a></td></tr> @@ -10751,10 +13244,10 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-indexes">indexes</a>:</td><td> </td><td valign="top"><a href="#Indexes">Indexes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-infinite-horizontal-stretch">infinite horizontal stretch</a>:</td><td> </td><td valign="top"><a href="#g_t_005chfill">\hfill</a></td></tr> <tr><td></td><td valign="top"><a href="#index-infinite-vertical-stretch">infinite vertical stretch</a>:</td><td> </td><td valign="top"><a href="#g_t_005cvfill">\vfill</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-initial-command">initial command</a>:</td><td> </td><td valign="top"><a href="#filecontents">filecontents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-input-file">input file</a>:</td><td> </td><td valign="top"><a href="#Splitting-the-input">Splitting the input</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-input_002foutput">input/output</a>:</td><td> </td><td valign="top"><a href="#Terminal-input_002foutput">Terminal input/output</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-input_002foutput_002c-to-terminal">input/output, to terminal</a>:</td><td> </td><td valign="top"><a href="#Terminal-input_002foutput">Terminal input/output</a></td></tr> <tr><td></td><td valign="top"><a href="#index-inserting-figures">inserting figures</a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-insertions-of-special-characters">insertions of special characters</a>:</td><td> </td><td valign="top"><a href="#Special-insertions">Special insertions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-italic-correction">italic correction</a>:</td><td> </td><td valign="top"><a href="#g_t_005c_002f">\/</a></td></tr> <tr><td></td><td valign="top"><a href="#index-italic-font">italic font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td colspan="4"> <hr></td></tr> @@ -10788,16 +13281,16 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-left_002djustifying-text_002c-environment-for">left-justifying text, environment for</a>:</td><td> </td><td valign="top"><a href="#flushleft">flushleft</a></td></tr> <tr><td></td><td valign="top"><a href="#index-left_002dto_002dright-mode">left-to-right mode</a>:</td><td> </td><td valign="top"><a href="#Modes">Modes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-lengths_002c-adding-to">lengths, adding to</a>:</td><td> </td><td valign="top"><a href="#g_t_005caddtolength">\addtolength</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-lengths_002c-allocating-new">lengths, allocating new</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewlength">\newlength</a></td></tr> <tr><td></td><td valign="top"><a href="#index-lengths_002c-defining-and-using">lengths, defining and using</a>:</td><td> </td><td valign="top"><a href="#Lengths">Lengths</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-lengths_002c-defining-new">lengths, defining new</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewlength">\newlength</a></td></tr> <tr><td></td><td valign="top"><a href="#index-lengths_002c-predefined">lengths, predefined</a>:</td><td> </td><td valign="top"><a href="#Predefined-lengths">Predefined lengths</a></td></tr> <tr><td></td><td valign="top"><a href="#index-lengths_002c-setting">lengths, setting</a>:</td><td> </td><td valign="top"><a href="#g_t_005csetlength">\setlength</a></td></tr> <tr><td></td><td valign="top"><a href="#index-less-than-symbol_002c-in-text">less than symbol, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-letters">letters</a>:</td><td> </td><td valign="top"><a href="#Letters">Letters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-letters_002c-accented">letters, accented</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-letters_002c-ending">letters, ending</a>:</td><td> </td><td valign="top"><a href="#g_t_005cclosing">\closing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-letters_002c-non_002dEnglish">letters, non-English</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-letters_002c-starting">letters, starting</a>:</td><td> </td><td valign="top"><a href="#g_t_005copening">\opening</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-letters_002c-writing">letters, writing</a>:</td><td> </td><td valign="top"><a href="#Letters">Letters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-line-break_002c-forcing">line break, forcing</a>:</td><td> </td><td valign="top"><a href="#g_t_005c_005c">\\</a></td></tr> <tr><td></td><td valign="top"><a href="#index-line-breaking">line breaking</a>:</td><td> </td><td valign="top"><a href="#Line-breaking">Line breaking</a></td></tr> <tr><td></td><td valign="top"><a href="#index-line-breaks_002c-forcing">line breaks, forcing</a>:</td><td> </td><td valign="top"><a href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a></td></tr> @@ -10824,6 +13317,7 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-LuaTeX">LuaTeX</a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-M">M</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-m_002dwidth">m-width</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-macro-package_002c-LaTeX-as">macro package, LaTeX as</a>:</td><td> </td><td valign="top"><a href="#Overview">Overview</a></td></tr> <tr><td></td><td valign="top"><a href="#index-macron-accent">macron accent</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-macron-accent_002c-math">macron accent, math</a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> @@ -10843,10 +13337,13 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-math-mode_002c-spacing">math mode, spacing</a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> <tr><td></td><td valign="top"><a href="#index-math-symbols">math symbols</a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-math_002c-bold">math, bold</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Millimeter">Millimeter</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-minipage_002c-creating-a">minipage, creating a</a>:</td><td> </td><td valign="top"><a href="#minipage">minipage</a></td></tr> <tr><td></td><td valign="top"><a href="#index-modes">modes</a>:</td><td> </td><td valign="top"><a href="#Modes">Modes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-monospace-font">monospace font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-moving-arguments">moving arguments</a>:</td><td> </td><td valign="top"><a href="#g_t_005cprotect">\protect</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-mpfootnote-counter">mpfootnote counter</a>:</td><td> </td><td valign="top"><a href="#g_t_005cfootnote">\footnote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-mu_002c-math-unit">mu, math unit</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-multicolumn-text">multicolumn text</a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> <tr><td></td><td valign="top"><a href="#index-multilingual-support">multilingual support</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-multind-package"><code>multind</code> package</a>:</td><td> </td><td valign="top"><a href="#Indexes">Indexes</a></td></tr> @@ -10855,6 +13352,7 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><th><a name="Concept-Index_cp_letter-N">N</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-nested-_005cinclude_002c-not-allowed">nested <code>\include</code>, not allowed</a>:</td><td> </td><td valign="top"><a href="#g_t_005cinclude">\include</a></td></tr> <tr><td></td><td valign="top"><a href="#index-new-commands_002c-defining">new commands, defining</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-new-commands_002c-defining-1">new commands, defining</a>:</td><td> </td><td valign="top"><a href="#g_t_005cprovidecommand">\providecommand</a></td></tr> <tr><td></td><td valign="top"><a href="#index-new-line_002c-output-as-input">new line, output as input</a>:</td><td> </td><td valign="top"><a href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a></td></tr> <tr><td></td><td valign="top"><a href="#index-new-line_002c-starting">new line, starting</a>:</td><td> </td><td valign="top"><a href="#g_t_005c_005c">\\</a></td></tr> <tr><td></td><td valign="top"><a href="#index-new-line_002c-starting-_0028paragraph-mode_0029">new line, starting (paragraph mode)</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewline">\newline</a></td></tr> @@ -10891,8 +13389,8 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-page-numbering-style">page numbering style</a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagenumbering">\pagenumbering</a></td></tr> <tr><td></td><td valign="top"><a href="#index-page-styles">page styles</a>:</td><td> </td><td valign="top"><a href="#Page-styles">Page styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-paragraph-indentation_002c-in-minipage">paragraph indentation, in minipage</a>:</td><td> </td><td valign="top"><a href="#minipage">minipage</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-paragraph-indentations-in-quoted-text">paragraph indentations in quoted text</a>:</td><td> </td><td valign="top"><a href="#quotation">quotation</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-paragraph-indentations-in-quoted-text_002c-omitting">paragraph indentations in quoted text, omitting</a>:</td><td> </td><td valign="top"><a href="#quote">quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-paragraph-indentations-in-quoted-text">paragraph indentations in quoted text</a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-paragraph-indentations-in-quoted-text_002c-omitting">paragraph indentations in quoted text, omitting</a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> <tr><td></td><td valign="top"><a href="#index-paragraph-mode">paragraph mode</a>:</td><td> </td><td valign="top"><a href="#Modes">Modes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-paragraph-symbol">paragraph symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-paragraphs">paragraphs</a>:</td><td> </td><td valign="top"><a href="#Making-paragraphs">Making paragraphs</a></td></tr> @@ -10901,13 +13399,16 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-pdfTeX">pdfTeX</a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td></td><td valign="top"><a href="#index-pdfTeX-engine">pdfTeX engine</a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td></td><td valign="top"><a href="#index-period_002c-centered_002c-in-text">period, centered, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-pica">pica</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-pict2e-package"><code>pict2e</code> package</a>:</td><td> </td><td valign="top"><a href="#g_t_005cline">\line</a></td></tr> <tr><td></td><td valign="top"><a href="#index-pictures_002c-creating">pictures, creating</a>:</td><td> </td><td valign="top"><a href="#picture">picture</a></td></tr> <tr><td></td><td valign="top"><a href="#index-pilcrow">pilcrow</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-placement-of-floats">placement of floats</a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-placement-of-floats">placement of floats</a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-poetry_002c-an-environment-for">poetry, an environment for</a>:</td><td> </td><td valign="top"><a href="#verse">verse</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Point">Point</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-polish-l">polish l</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-portrait-orientation">portrait orientation</a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-position_002c-in-picture">position, in picture</a>:</td><td> </td><td valign="top"><a href="#picture">picture</a></td></tr> <tr><td></td><td valign="top"><a href="#index-postscript_002c-in-letters">postscript, in letters</a>:</td><td> </td><td valign="top"><a href="#g_t_005cps">\ps</a></td></tr> <tr><td></td><td valign="top"><a href="#index-pounds-symbol">pounds symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-preamble_002c-defined">preamble, defined</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> @@ -10916,11 +13417,12 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-pronunciation">pronunciation</a>:</td><td> </td><td valign="top"><a href="#Overview">Overview</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-Q">Q</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-quad">quad</a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> <tr><td></td><td valign="top"><a href="#index-question-mark_002c-upside_002ddown">question mark, upside-down</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-quotation-marks_002c-French">quotation marks, French</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-quote_002c-straight-base">quote, straight base</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-quoted-text-with-paragraph-indentation_002c-displaying">quoted text with paragraph indentation, displaying</a>:</td><td> </td><td valign="top"><a href="#quotation">quotation</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-quoted-text-without-paragraph-indentation_002c-displaying">quoted text without paragraph indentation, displaying</a>:</td><td> </td><td valign="top"><a href="#quote">quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-quoted-text-with-paragraph-indentation_002c-displaying">quoted text with paragraph indentation, displaying</a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-quoted-text-without-paragraph-indentation_002c-displaying">quoted text without paragraph indentation, displaying</a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-R">R</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-ragged-left-text">ragged left text</a>:</td><td> </td><td valign="top"><a href="#g_t_005craggedleft">\raggedleft</a></td></tr> @@ -10946,18 +13448,22 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-ring-accent_002c-math">ring accent, math</a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-robust-commands">robust commands</a>:</td><td> </td><td valign="top"><a href="#g_t_005cprotect">\protect</a></td></tr> <tr><td></td><td valign="top"><a href="#index-roman-font">roman font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-rubber-lengths_002c-defining-new">rubber lengths, defining new</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewlength">\newlength</a></td></tr> <tr><td></td><td valign="top"><a href="#index-running-header-and-footer">running header and footer</a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-running-header-and-footer-style">running header and footer style</a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagestyle">\pagestyle</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-S">S</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-sans-serif-font">sans serif font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-Scaled-point">Scaled point</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-script-letters-for-math">script letters for math</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-section-number_002c-cross-referencing">section number, cross referencing</a>:</td><td> </td><td valign="top"><a href="#g_t_005cref">\ref</a></td></tr> <tr><td></td><td valign="top"><a href="#index-section-numbers_002c-printing">section numbers, printing</a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> <tr><td></td><td valign="top"><a href="#index-section-symbol">section symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-sectioning">sectioning</a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-sectioning-commands">sectioning commands</a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-series_002c-of-fonts">series, of fonts</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-setspace-package"><code>setspace</code> package</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-setting-counters">setting counters</a>:</td><td> </td><td valign="top"><a href="#g_t_005csetcounter">\setcounter</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-shapes_002c-of-fonts">shapes, of fonts</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-sharp-S-letters">sharp S letters</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-showidx-package"><code>showidx</code> package</a>:</td><td> </td><td valign="top"><a href="#Indexes">Indexes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-simulating-typed-text">simulating typed text</a>:</td><td> </td><td valign="top"><a href="#verbatim">verbatim</a></td></tr> @@ -10967,18 +13473,22 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-single-low_002d9-quotation-mark">single low-9 quotation mark</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-single-right-quote">single right quote</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-sizes-of-text">sizes of text</a>:</td><td> </td><td valign="top"><a href="#Font-sizes">Font sizes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-skip-register_002c-plain-TeX">skip register, plain TeX</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewlength">\newlength</a></td></tr> <tr><td></td><td valign="top"><a href="#index-slanted-font">slanted font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-small-caps-font">small caps font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-space_002c-inserting-vertical">space, inserting vertical</a>:</td><td> </td><td valign="top"><a href="#g_t_005caddvspace">\addvspace</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-space_002c-vertical">space, vertical</a>:</td><td> </td><td valign="top"><a href="#g_t_005cvspace">\vspace</a></td></tr> <tr><td></td><td valign="top"><a href="#index-spaces">spaces</a>:</td><td> </td><td valign="top"><a href="#Spaces">Spaces</a></td></tr> <tr><td></td><td valign="top"><a href="#index-spacing-within-math-mode">spacing within math mode</a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-spacing_002c-intersentence">spacing, intersentence</a>:</td><td> </td><td valign="top"><a href="#g_t_005cfrenchspacing">\frenchspacing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-Spanish-ordinals_002c-feminine-and-masculine">Spanish ordinals, feminine and masculine</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-special-characters">special characters</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-specifier_002c-float-placement">specifier, float placement</a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-special-insertions">special insertions</a>:</td><td> </td><td valign="top"><a href="#Special-insertions">Special insertions</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-specifier_002c-float-placement">specifier, float placement</a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-splitting-the-input-file">splitting the input file</a>:</td><td> </td><td valign="top"><a href="#Splitting-the-input">Splitting the input</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-starting-_0026-ending">starting & ending</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> <tr><td></td><td valign="top"><a href="#index-starting-a-new-page">starting a new page</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewpage">\newpage</a></td></tr> <tr><td></td><td valign="top"><a href="#index-starting-a-new-page-and-clearing-floats">starting a new page and clearing floats</a>:</td><td> </td><td valign="top"><a href="#g_t_005cclearpage">\clearpage</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-starting-and-ending">starting and ending</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr> <tr><td></td><td valign="top"><a href="#index-starting-on-a-right_002dhand-page">starting on a right-hand page</a>:</td><td> </td><td valign="top"><a href="#g_t_005ccleardoublepage">\cleardoublepage</a></td></tr> <tr><td></td><td valign="top"><a href="#index-sterling-symbol">sterling symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-straight-double-quote_002c-base">straight double quote, base</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> @@ -10991,6 +13501,7 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-subscript">subscript</a>:</td><td> </td><td valign="top"><a href="#Subscripts-_0026-superscripts">Subscripts & superscripts</a></td></tr> <tr><td></td><td valign="top"><a href="#index-superscript">superscript</a>:</td><td> </td><td valign="top"><a href="#Subscripts-_0026-superscripts">Subscripts & superscripts</a></td></tr> <tr><td></td><td valign="top"><a href="#index-symbols_002c-math">symbols, math</a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-symbols_002c-text">symbols, text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-T">T</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-tab-stops_002c-using">tab stops, using</a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> @@ -10998,11 +13509,16 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-table-of-contents-file">table of contents file</a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td></td><td valign="top"><a href="#index-table-of-contents_002c-creating">table of contents, creating</a>:</td><td> </td><td valign="top"><a href="#Tables-of-contents">Tables of contents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-tables_002c-creating">tables, creating</a>:</td><td> </td><td valign="top"><a href="#table">table</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-template_002c-beamer">template, <code>beamer</code></a>:</td><td> </td><td valign="top"><a href="#beamer-template">beamer template</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-template_002c-book">template, <code>book</code></a>:</td><td> </td><td valign="top"><a href="#book-template">book template</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-template_002c-TUGboat">template, TUGboat</a>:</td><td> </td><td valign="top"><a href="#tugboat-template">tugboat template</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-templates_002c-document">templates, document</a>:</td><td> </td><td valign="top"><a href="#Document-templates">Document templates</a></td></tr> <tr><td></td><td valign="top"><a href="#index-terminal-input_002foutput">terminal input/output</a>:</td><td> </td><td valign="top"><a href="#Terminal-input_002foutput">Terminal input/output</a></td></tr> <tr><td></td><td valign="top"><a href="#index-TeX-logo">TeX logo</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-text-symbols">text symbols</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-textcomp-package"><code>textcomp</code> package</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-thanks_002c-for-titlepage">thanks, for titlepage</a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-theorem_002dlike-environment">theorem-like environment</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewtheorem">\newtheorem</a></td></tr> <tr><td></td><td valign="top"><a href="#index-theorems_002c-defining">theorems, defining</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewtheorem">\newtheorem</a></td></tr> <tr><td></td><td valign="top"><a href="#index-theorems_002c-typesetting">theorems, typesetting</a>:</td><td> </td><td valign="top"><a href="#theorem">theorem</a></td></tr> <tr><td></td><td valign="top"><a href="#index-thorn_002c-Icelandic-letter">thorn, Icelandic letter</a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> @@ -11021,9 +13537,9 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-TUGboat-template">TUGboat template</a>:</td><td> </td><td valign="top"><a href="#tugboat-template">tugboat template</a></td></tr> <tr><td></td><td valign="top"><a href="#index-two_002dcolumn-output">two-column output</a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> <tr><td></td><td valign="top"><a href="#index-two_002dthirds-em_002ddash">two-thirds em-dash</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-type-styles">type styles</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-typed-text_002c-simulating">typed text, simulating</a>:</td><td> </td><td valign="top"><a href="#verbatim">verbatim</a></td></tr> <tr><td></td><td valign="top"><a href="#index-typeface-sizes">typeface sizes</a>:</td><td> </td><td valign="top"><a href="#Font-sizes">Font sizes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-typeface-styles">typeface styles</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-typefaces">typefaces</a>:</td><td> </td><td valign="top"><a href="#Fonts">Fonts</a></td></tr> <tr><td></td><td valign="top"><a href="#index-typewriter-font">typewriter font</a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-typewriter-labels-in-lists">typewriter labels in lists</a>:</td><td> </td><td valign="top"><a href="#description">description</a></td></tr> @@ -11033,6 +13549,7 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-underbar">underbar</a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-underscore_002c-in-text">underscore, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-Unicode-input_002c-native">Unicode input, native</a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-units_002c-of-length">units, of length</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-unofficial-nature-of-this-manual">unofficial nature of this manual</a>:</td><td> </td><td valign="top"><a href="#About-this-document">About this document</a></td></tr> <tr><td></td><td valign="top"><a href="#index-unordered-lists">unordered lists</a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> <tr><td></td><td valign="top"><a href="#index-using-BibTeX">using BibTeX</a>:</td><td> </td><td valign="top"><a href="#Using-BibTeX">Using BibTeX</a></td></tr> @@ -11046,16 +13563,22 @@ Next: <a href="#Command-Index" accesskey="n" rel="next">Command Index</a>, Previ <tr><td></td><td valign="top"><a href="#index-vertical-bar_002c-double_002c-in-text">vertical bar, double, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-vertical-bar_002c-in-text">vertical bar, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-vertical-space">vertical space</a>:</td><td> </td><td valign="top"><a href="#g_t_005caddvspace">\addvspace</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-vertical-space-1">vertical space</a>:</td><td> </td><td valign="top"><a href="#g_t_005cvspace">\vspace</a></td></tr> <tr><td></td><td valign="top"><a href="#index-vertical-space-before-paragraphs">vertical space before paragraphs</a>:</td><td> </td><td valign="top"><a href="#g_t_005cparskip">\parskip</a></td></tr> <tr><td></td><td valign="top"><a href="#index-visible-space">visible space</a>:</td><td> </td><td valign="top"><a href="#g_t_005cverb">\verb</a></td></tr> <tr><td></td><td valign="top"><a href="#index-visible-space-symbol_002c-in-text">visible space symbol, in text</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-W">W</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-weights_002c-of-fonts">weights, of fonts</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-white-space">white space</a>:</td><td> </td><td valign="top"><a href="#Spaces">Spaces</a></td></tr> <tr><td></td><td valign="top"><a href="#index-wide-hat-accent_002c-math">wide hat accent, math</a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-wide-tile-accent_002c-math">wide tile accent, math</a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-wide-tilde-accent_002c-math">wide tilde accent, math</a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-widths_002c-of-fonts">widths, of fonts</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-writing-external-files">writing external files</a>:</td><td> </td><td valign="top"><a href="#filecontents">filecontents</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-writing-letters">writing letters</a>:</td><td> </td><td valign="top"><a href="#Letters">Letters</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Concept-Index_cp_letter-X">X</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-x_002dheight">x-height</a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-XeTeX">XeTeX</a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td></td><td valign="top"><a href="#index-xindy-program"><code>xindy</code> program</a>:</td><td> </td><td valign="top"><a href="#Indexes">Indexes</a></td></tr> <tr><td colspan="4"> <hr></td></tr> @@ -11128,13 +13651,13 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Command-Index_fn_symbol-1"><b>$</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-2"><b>-</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-2"><b>&</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-3"><b>.</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-3"><b>-</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-4"><b>1</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-4"><b>.</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-5"><b>@</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-5"><b>1</b></a> <a class="summary-letter" href="#Command-Index_fn_symbol-6"><b>[</b></a> @@ -11194,12 +13717,16 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><th><a name="Command-Index_fn_symbol-1">$</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-_0024"><code>$</code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Command-Index_fn_symbol-2">-</a></th><td></td><td></td></tr> +<tr><th><a name="Command-Index_fn_symbol-2">&</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-_0026"><code>&</code></a>:</td><td> </td><td valign="top"><a href="#tabular">tabular</a></td></tr> +<tr><td colspan="4"> <hr></td></tr> +<tr><th><a name="Command-Index_fn_symbol-3">-</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-_002d_002dhelp-command_002dline-option"><code>--help <span class="roman">command-line option</span></code></a>:</td><td> </td><td valign="top"><a href="#Command-line">Command line</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Command-Index_fn_symbol-3">.</a></th><td></td><td></td></tr> +<tr><th><a name="Command-Index_fn_symbol-4">.</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-_002eaux-file"><code>.aux <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002edvi-file"><code>.dvi <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_002efd-file"><code>.fd <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewfont">\newfont</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002elof-file"><code>.lof <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002elof-file-1"><code>.lof <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#Tables-of-contents">Tables of contents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002elog-file"><code>.log <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> @@ -11209,20 +13736,19 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_002etex_002c-default-extension"><code>.tex, <span class="roman">default extension</span></code></a>:</td><td> </td><td valign="top"><a href="#Command-line">Command line</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002etoc-file"><code>.toc <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_002etoc-file-1"><code>.toc <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#Tables-of-contents">Tables of contents</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_002exdv-file"><code>.xdv <span class="roman">file</span></code></a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Command-Index_fn_symbol-4">1</a></th><td></td><td></td></tr> +<tr><th><a name="Command-Index_fn_symbol-5">1</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-10pt-option"><code>10pt <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-11pt-option"><code>11pt <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-12pt-option"><code>12pt <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td colspan="4"> <hr></td></tr> -<tr><th><a name="Command-Index_fn_symbol-5">@</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-_0040_007b_002e_002e_002e_007d"><code>@{...}</code></a>:</td><td> </td><td valign="top"><a href="#array">array</a></td></tr> -<tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_symbol-6">[</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-_005b_002e_002e_002e_005d-for-optional-arguments"><code>[...] <span class="roman">for optional arguments</span></code></a>:</td><td> </td><td valign="top"><a href="#LaTeX-command-syntax">LaTeX command syntax</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_symbol-7">\</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c-character-starting-commands"><code>\ <span class="roman">character starting commands</span></code></a>:</td><td> </td><td valign="top"><a href="#LaTeX-command-syntax">LaTeX command syntax</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005c_0021"><code>\!</code></a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_0022-_0028umlaut-accent_0029"><code>\" <span class="roman">(umlaut accent)</span></code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_0023"><code>\#</code></a>:</td><td> </td><td valign="top"><a href="#Reserved-characters">Reserved characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_0024"><code>\$</code></a>:</td><td> </td><td valign="top"><a href="#Reserved-characters">Reserved characters</a></td></tr> @@ -11231,6 +13757,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005c_0027-_0028acute-accent_0029"><code>\' <span class="roman">(acute accent)</span></code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_0027-_0028tabbing_0029"><code>\' <span class="roman">(tabbing)</span></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_0028"><code>\(</code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005c_0028SPACE_0029"><code>\(SPACE)</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005c_0028SPACE_0029-and-_005c_0040">\(SPACE) and \@</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_0029"><code>\)</code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_002a"><code>\*</code></a>:</td><td> </td><td valign="top"><a href="#Math-miscellany">Math miscellany</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_002b"><code>\+</code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> @@ -11247,8 +13774,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005c_003e"><code>\></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_003e-1"><code>\></code></a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_003e-_0028tabbing_0029"><code>\> <span class="roman">(tabbing)</span></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005c_0040"><code>\@</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005c_0040">\@</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005c_0040fnsymbol"><code>\@fnsymbol</code></a>:</td><td> </td><td valign="top"><a href="#Symbolic-footnotes">Symbolic footnotes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005c_0040"><code>\@</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005c_0028SPACE_0029-and-_005c_0040">\(SPACE) and \@</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005c_0040fnsymbol"><code>\@fnsymbol</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfootnote">\footnote</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ca-_0028tabbing_0029"><code>\a <span class="roman">(tabbing)</span></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ca_0027-_0028acute-accent-in-tabbing_0029"><code>\a' <span class="roman">(acute accent in tabbing)</span></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ca_003d-_0028macron-accent-in-tabbing_0029"><code>\a= <span class="roman">(macron accent in tabbing)</span></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> @@ -11284,6 +13811,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005carraystretch"><code>\arraystretch</code></a>:</td><td> </td><td valign="top"><a href="#tabular">tabular</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cast"><code>\ast</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005casymp"><code>\asymp</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cAtBeginDocument"><code>\AtBeginDocument</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cAtBeginDocument">\AtBeginDocument</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cAtEndDocument"><code>\AtEndDocument</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cAtEndDocument">\AtEndDocument</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cauthor_007bname-_005cand-name2_007d"><code>\author{<var>name</var> \and <var>name2</var>}</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ca_0060-_0028grave-accent-in-tabbing_0029"><code>\a` <span class="roman">(grave accent in tabbing)</span></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cb-_0028bar_002dunder-accent_0029"><code>\b <span class="roman">(bar-under accent)</span></code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> @@ -11300,7 +13829,6 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cbibliography"><code>\bibliography</code></a>:</td><td> </td><td valign="top"><a href="#Using-BibTeX">Using BibTeX</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbibliographystyle"><code>\bibliographystyle</code></a>:</td><td> </td><td valign="top"><a href="#Using-BibTeX">Using BibTeX</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbigcap"><code>\bigcap</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cbigcap-1"><code>\bigcap</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbigcirc"><code>\bigcirc</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbigcup"><code>\bigcup</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbigodot"><code>\bigodot</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11312,11 +13840,13 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cbigtriangledown"><code>\bigtriangledown</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbigtriangleup"><code>\bigtriangleup</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbiguplus"><code>\biguplus</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cbigvee"><code>\bigvee</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbigwedge"><code>\bigwedge</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbmod"><code>\bmod</code></a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cboldmath"><code>\boldmath</code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbot"><code>\bot</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cbottomfraction"><code>\bottomfraction</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cbottomfraction"><code>\bottomfraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cbottomfraction-1"><code>\bottomfraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbowtie"><code>\bowtie</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cBox"><code>\Box</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cbreve"><code>\breve</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> @@ -11340,6 +13870,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005ccapitaltie"><code>\capitaltie</code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccapitaltilde"><code>\capitaltilde</code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccaption"><code>\caption</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccaption-1"><code>\caption</code></a>:</td><td> </td><td valign="top"><a href="#table">table</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccc"><code>\cc</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ccc">\cc</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccdot"><code>\cdot</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccdots"><code>\cdots</code></a>:</td><td> </td><td valign="top"><a href="#Math-miscellany">Math miscellany</a></td></tr> @@ -11356,8 +13887,15 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cclosing"><code>\closing</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cclosing">\closing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cclubsuit"><code>\clubsuit</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccolumnsep"><code>\columnsep</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccolumnsep-1"><code>\columnsep</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccolumnsep-2"><code>\columnsep</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccolumnseprule"><code>\columnseprule</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccolumnseprule-1"><code>\columnseprule</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccolumnseprule-2"><code>\columnseprule</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccolumnwidth"><code>\columnwidth</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccolumnwidth-1"><code>\columnwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccolumnwidth-2"><code>\columnwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ccomplement"><code>\complement</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccong"><code>\cong</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccontentsline"><code>\contentsline</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005caddcontentsline">\addcontentsline</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ccoprod"><code>\coprod</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11379,6 +13917,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cdblfloatsep"><code>\dblfloatsep</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdbltextfloatsep"><code>\dbltextfloatsep</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdbltopfraction"><code>\dbltopfraction</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cdbltopnumber"><code>\dbltopnumber</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctwocolumn">\twocolumn</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cddag"><code>\ddag</code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cddagger"><code>\ddagger</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cddot"><code>\ddot</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> @@ -11399,16 +13938,14 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cdj"><code>\dj</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cDJ"><code>\DJ</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdocumentclass"><code>\documentclass</code></a>:</td><td> </td><td valign="top"><a href="#Document-classes">Document classes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cdocumentclass_002c-commands-before"><code>\documentclass, commands before</code></a>:</td><td> </td><td valign="top"><a href="#filecontents">filecontents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdot"><code>\dot</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdoteq"><code>\doteq</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cdotfill"><code>\dotfill</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cdotfill">\dotfill</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cdotfill"><code>\dotfill</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005chrulefill-_005cdotfill">\hrulefill \dotfill</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdots"><code>\dots</code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdoublerulesep"><code>\doublerulesep</code></a>:</td><td> </td><td valign="top"><a href="#tabular">tabular</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cdownarrow"><code>\downarrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cDownarrow"><code>\Downarrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cell"><code>\ell</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cem"><code>\em</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cemph"><code>\emph</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cemptyset"><code>\emptyset</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cencl"><code>\encl</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cencl">\encl</a></td></tr> @@ -11422,6 +13959,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cequiv"><code>\equiv</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ceta"><code>\eta</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cevensidemargin"><code>\evensidemargin</code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cevensidemargin-1"><code>\evensidemargin</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cevensidemargin-2"><code>\evensidemargin</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cexists"><code>\exists</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cexp"><code>\exp</code></a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cextracolsep"><code>\extracolsep</code></a>:</td><td> </td><td valign="top"><a href="#tabular">tabular</a></td></tr> @@ -11432,11 +13971,13 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cfboxsep-1"><code>\fboxsep</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfill"><code>\fill</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005chfill">\hfill</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cflat"><code>\flat</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cfloatpagefraction"><code>\floatpagefraction</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cfloatsep"><code>\floatsep</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cfloatpagefraction"><code>\floatpagefraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cfloatpagefraction-1"><code>\floatpagefraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cfloatsep"><code>\floatsep</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cfloatsep-1"><code>\floatsep</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cflushbottom"><code>\flushbottom</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cflushbottom">\flushbottom</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfnsymbol"><code>\fnsymbol</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cfnsymbol_002c-and-footnotes"><code>\fnsymbol<span class="roman">, and footnotes</span></code></a>:</td><td> </td><td valign="top"><a href="#Symbolic-footnotes">Symbolic footnotes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cfnsymbol_002c-and-footnotes"><code>\fnsymbol<span class="roman">, and footnotes</span></code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfootnote">\footnote</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfontencoding"><code>\fontencoding</code></a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfontfamily"><code>\fontfamily</code></a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfontseries"><code>\fontseries</code></a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> @@ -11449,12 +13990,14 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cfootnotesize"><code>\footnotesize</code></a>:</td><td> </td><td valign="top"><a href="#Font-sizes">Font sizes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfootnotetext"><code>\footnotetext</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfootnotetext">\footnotetext</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfootskip"><code>\footskip</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cfootskip-1"><code>\footskip</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cforall"><code>\forall</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfrac"><code>\frac</code></a>:</td><td> </td><td valign="top"><a href="#Math-miscellany">Math miscellany</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfrac_007bnum_007d_007bden_007d"><code>\frac{num}{den}</code></a>:</td><td> </td><td valign="top"><a href="#Math-miscellany">Math miscellany</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cframe"><code>\frame</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cframe">\frame</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cframebox"><code>\framebox</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cframebox-1"><code>\framebox</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cfrenchspacing"><code>\frenchspacing</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfrenchspacing">\frenchspacing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfrown"><code>\frown</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cfussy"><code>\fussy</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfussy">\fussy</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cGamma"><code>\Gamma</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11475,7 +14018,9 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005chat"><code>\hat</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005chbar"><code>\hbar</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cheadheight"><code>\headheight</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cheadheight-1"><code>\headheight</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cheadsep"><code>\headsep</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cheadsep-1"><code>\headsep</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cheartsuit"><code>\heartsuit</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cheight"><code>\height</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-lengths">Predefined lengths</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005chfill"><code>\hfill</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005chfill">\hfill</a></td></tr> @@ -11483,8 +14028,9 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005chom"><code>\hom</code></a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005chookleftarrow"><code>\hookleftarrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005chookrightarrow"><code>\hookrightarrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005chrulefill"><code>\hrulefill</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005chrulefill">\hrulefill</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005chrulefill"><code>\hrulefill</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005chrulefill-_005cdotfill">\hrulefill \dotfill</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005chsize"><code>\hsize</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005chsize-1"><code>\hsize</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005chspace"><code>\hspace</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005chspace">\hspace</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005chuge"><code>\huge</code></a>:</td><td> </td><td valign="top"><a href="#Font-sizes">Font sizes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cHuge"><code>\Huge</code></a>:</td><td> </td><td valign="top"><a href="#Font-sizes">Font sizes</a></td></tr> @@ -11505,12 +14051,14 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cinfty"><code>\infty</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cinput"><code>\input</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cinput">\input</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cint"><code>\int</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cintextsep"><code>\intextsep</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cintextsep"><code>\intextsep</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cintextsep-1"><code>\intextsep</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ciota"><code>\iota</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cit"><code>\it</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005citem"><code>\item</code></a>:</td><td> </td><td valign="top"><a href="#description">description</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005citem-1"><code>\item</code></a>:</td><td> </td><td valign="top"><a href="#enumerate">enumerate</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005citem-2"><code>\item</code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005citem-1"><code>\item</code></a>:</td><td> </td><td valign="top"><a href="#description">description</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005citem-2"><code>\item</code></a>:</td><td> </td><td valign="top"><a href="#enumerate">enumerate</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005citem-3"><code>\item</code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005citemindent"><code>\itemindent</code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005citemsep"><code>\itemsep</code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005citshape"><code>\itshape</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> @@ -11576,6 +14124,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005clinespread"><code>\linespread</code></a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005clinethickness"><code>\linethickness</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005clinethickness">\linethickness</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005clinewidth"><code>\linewidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005clinewidth-1"><code>\linewidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005clistoffigures"><code>\listoffigures</code></a>:</td><td> </td><td valign="top"><a href="#Tables-of-contents">Tables of contents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005clistoftables"><code>\listoftables</code></a>:</td><td> </td><td valign="top"><a href="#Tables-of-contents">Tables of contents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005clistparindent"><code>\listparindent</code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> @@ -11598,9 +14147,15 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cmaketitle"><code>\maketitle</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmapsto"><code>\mapsto</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmarginpar"><code>\marginpar</code></a>:</td><td> </td><td valign="top"><a href="#Marginal-notes">Marginal notes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cmarginparpush"><code>\marginparpush</code></a>:</td><td> </td><td valign="top"><a href="#Marginal-notes">Marginal notes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginparpush"><code>\marginparpush</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginparpush-1"><code>\marginparpush</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginparpush-2"><code>\marginparpush</code></a>:</td><td> </td><td valign="top"><a href="#Marginal-notes">Marginal notes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmarginparsep"><code>\marginparsep</code></a>:</td><td> </td><td valign="top"><a href="#Marginal-notes">Marginal notes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cmarginparwidth"><code>\marginparwidth</code></a>:</td><td> </td><td valign="top"><a href="#Marginal-notes">Marginal notes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginparwidth"><code>\marginparwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginparwidth-1"><code>\marginparwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginparwidth-2"><code>\marginparwidth</code></a>:</td><td> </td><td valign="top"><a href="#Marginal-notes">Marginal notes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginsep"><code>\marginsep</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmarginsep-1"><code>\marginsep</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmarkboth_007bleft_007d_007bright_007d"><code>\markboth{<var>left</var>}{<var>right</var>}</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagestyle">\pagestyle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmarkright_007bright_007d"><code>\markright{<var>right</var>}</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagestyle">\pagestyle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmathbf"><code>\mathbf</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> @@ -11617,6 +14172,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cmdseries"><code>\mdseries</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmedskip"><code>\medskip</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmedskipamount"><code>\medskipamount</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cmedspace"><code>\medspace</code></a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmho"><code>\mho</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmid"><code>\mid</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cmin"><code>\min</code></a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> @@ -11639,7 +14195,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cnewfont"><code>\newfont</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewfont">\newfont</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnewlength"><code>\newlength</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewlength">\newlength</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnewline"><code>\newline</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewline">\newline</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cNEWLINE"><code>\NEWLINE</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cSPACE">\SPACE</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cNEWLINE"><code>\NEWLINE</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005c_0028SPACE_0029-and-_005c_0040">\(SPACE) and \@</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnewpage"><code>\newpage</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewpage">\newpage</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnewsavebox"><code>\newsavebox</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewsavebox">\newsavebox</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnewtheorem"><code>\newtheorem</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewtheorem">\newtheorem</a></td></tr> @@ -11653,6 +14209,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cnofiles"><code>\nofiles</code></a>:</td><td> </td><td valign="top"><a href="#Tables-of-contents">Tables of contents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnoindent"><code>\noindent</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnoindent">\noindent</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnolinebreak"><code>\nolinebreak</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cnonfrenchspacing"><code>\nonfrenchspacing</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cfrenchspacing">\frenchspacing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnonumber"><code>\nonumber</code></a>:</td><td> </td><td valign="top"><a href="#eqnarray">eqnarray</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnopagebreak"><code>\nopagebreak</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagebreak-_0026-_005cnopagebreak">\pagebreak & \nopagebreak</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cnormalfont"><code>\normalfont</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> @@ -11666,6 +14223,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cO-_0028O_0029"><code>\O (Ø)</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cobeycr"><code>\obeycr</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005coddsidemargin"><code>\oddsidemargin</code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005coddsidemargin-1"><code>\oddsidemargin</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005coddsidemargin-2"><code>\oddsidemargin</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005codot"><code>\odot</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005coe-_0028oe_0029"><code>\oe (œ)</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cOE-_0028OE_0029"><code>\OE (Œ)</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> @@ -11688,6 +14247,10 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cpagenumbering"><code>\pagenumbering</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagenumbering">\pagenumbering</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cpageref"><code>\pageref</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cpageref">\pageref</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cpagestyle"><code>\pagestyle</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cpagestyle">\pagestyle</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cpaperheight"><code>\paperheight</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cpaperheight-1"><code>\paperheight</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cpaperwidth"><code>\paperwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cpaperwidth-1"><code>\paperwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cparagraph"><code>\paragraph</code></a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cparallel"><code>\parallel</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cparbox"><code>\parbox</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cparbox">\parbox</a></td></tr> @@ -11699,6 +14262,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cpart"><code>\part</code></a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cpartial"><code>\partial</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cpartopsep"><code>\partopsep</code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cpdfpageheight"><code>\pdfpageheight</code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cpdfpagewidth"><code>\pdfpagewidth</code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cperp"><code>\perp</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cphi"><code>\phi</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cPi"><code>\Pi</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11715,11 +14280,14 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cprod"><code>\prod</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cpropto"><code>\propto</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cprotect"><code>\protect</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cprotect">\protect</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cprovidecommand"><code>\providecommand</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cprovidecommand">\providecommand</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cps"><code>\ps</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cps">\ps</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cPsi"><code>\Psi</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cpsi"><code>\psi</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cpushtabs"><code>\pushtabs</code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cput"><code>\put</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cput">\put</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cqquad"><code>\qquad</code></a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cquad"><code>\quad</code></a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cquotedblbase-_0028_201e_0029"><code>\quotedblbase <span class="roman">(„)</span></code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cquotesinglbase-_0028_201a_0029"><code>\quotesinglbase <span class="roman">(‚)</span></code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cr-_0028ring-accent_0029"><code>\r <span class="roman">(ring accent)</span></code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> @@ -11736,6 +14304,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005crefstepcounter"><code>\refstepcounter</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005crefstepcounter">\refstepcounter</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005crenewenvironment"><code>\renewenvironment</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005crestorecr"><code>\restorecr</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005crestriction"><code>\restriction</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005creversemarginpar"><code>\reversemarginpar</code></a>:</td><td> </td><td valign="top"><a href="#Marginal-notes">Marginal notes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005crfloor"><code>\rfloor</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005crhd"><code>\rhd</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11782,13 +14351,13 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005csin"><code>\sin</code></a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csinh"><code>\sinh</code></a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csl"><code>\sl</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005csloppy"><code>\sloppy</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005csloppy">\sloppy</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cslshape"><code>\slshape</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csmall"><code>\small</code></a>:</td><td> </td><td valign="top"><a href="#Font-sizes">Font sizes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csmallint"><code>\smallint</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csmallskip"><code>\smallskip</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csmallskipamount"><code>\smallskipamount</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csmile"><code>\smile</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cSPACE"><code>\SPACE</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cSPACE">\SPACE</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cspadesuit"><code>\spadesuit</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csqcap"><code>\sqcap</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csqcup"><code>\sqcup</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11801,10 +14370,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cSS-_0028SS_0029"><code>\SS (SS)</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cstackrel_007btext_007d_007brelation_007d"><code>\stackrel{<var>text</var>}{<var>relation</var>}</code></a>:</td><td> </td><td valign="top"><a href="#Math-miscellany">Math miscellany</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cstar"><code>\star</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cstartbreaks"><code>\startbreaks</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cstartbreaks">\startbreaks</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cstepcounter"><code>\stepcounter</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cstepcounter">\stepcounter</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cstop"><code>\stop</code></a>:</td><td> </td><td valign="top"><a href="#Command-line">Command line</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cstopbreaks"><code>\stopbreaks</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cstopbreaks">\stopbreaks</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csubparagraph"><code>\subparagraph</code></a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csubsection"><code>\subsection</code></a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csubset"><code>\subset</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11814,13 +14381,14 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005csucceq"><code>\succeq</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csum"><code>\sum</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csup"><code>\sup</code></a>:</td><td> </td><td valign="top"><a href="#Math-functions">Math functions</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005csuppressfloats"><code>\suppressfloats</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csupset"><code>\supset</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csupseteq"><code>\supseteq</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csurd"><code>\surd</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cswarrow"><code>\swarrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005csymbol"><code>\symbol</code></a>:</td><td> </td><td valign="top"><a href="#Reserved-characters">Reserved characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ct-_0028tie_002dafter-accent_0029"><code>\t <span class="roman">(tie-after accent)</span></code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cTAB"><code>\TAB</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cSPACE">\SPACE</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cTAB"><code>\TAB</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005c_0028SPACE_0029-and-_005c_0040">\(SPACE) and \@</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctabbingsep"><code>\tabbingsep</code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctabcolsep"><code>\tabcolsep</code></a>:</td><td> </td><td valign="top"><a href="#tabular">tabular</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctableofcontents"><code>\tableofcontents</code></a>:</td><td> </td><td valign="top"><a href="#Tables-of-contents">Tables of contents</a></td></tr> @@ -11853,10 +14421,13 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005ctextendash-_0028or-_002d_002d_0029"><code>\textendash <span class="roman">(or <code>--</code>)</span></code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctexteuro"><code>\texteuro</code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextexclamdown-_0028or-_0021_0060_0029"><code>\textexclamdown <span class="roman">(or <code>!`</code>)</span></code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005ctextfloatsep"><code>\textfloatsep</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005ctextfraction"><code>\textfraction</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctextfloatsep"><code>\textfloatsep</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctextfloatsep-1"><code>\textfloatsep</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctextfraction"><code>\textfraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctextfraction-1"><code>\textfraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextgreater"><code>\textgreater</code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextheight"><code>\textheight</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctextheight-1"><code>\textheight</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextit"><code>\textit</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextleftarrow"><code>\textleftarrow</code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextless"><code>\textless</code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> @@ -11888,13 +14459,16 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005ctextup"><code>\textup</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextvisiblespace"><code>\textvisiblespace</code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctextwidth"><code>\textwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctextwidth-1"><code>\textwidth</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cth-_0028th_0029"><code>\th (þ)</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cTH-_0028TH_0029"><code>\TH (Þ)</code></a>:</td><td> </td><td valign="top"><a href="#Non_002dEnglish-characters">Non-English characters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cthanks_007btext_007d"><code>\thanks{<var>text</var>}</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctheta"><code>\theta</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cthicklines"><code>\thicklines</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cthicklines">\thicklines</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cthickspace"><code>\thickspace</code></a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cthinlines"><code>\thinlines</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cthinlines">\thinlines</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cthinspace"><code>\thinspace</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cthinspace">\thinspace</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cthinspace"><code>\thinspace</code></a>:</td><td> </td><td valign="top"><a href="#Spacing-in-math-mode">Spacing in math mode</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cthinspace-1"><code>\thinspace</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cthinspace">\thinspace</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cthispagestyle"><code>\thispagestyle</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cthispagestyle">\thispagestyle</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctilde"><code>\tilde</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctimes"><code>\times</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11903,10 +14477,12 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cto"><code>\to</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctoday"><code>\today</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctoday">\today</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctop"><code>\top</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005ctopfraction"><code>\topfraction</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctopfraction"><code>\topfraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctopfraction-1"><code>\topfraction</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctopmargin"><code>\topmargin</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctopsep"><code>\topsep</code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctopskip"><code>\topskip</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005ctopskip-1"><code>\topskip</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctotalheight"><code>\totalheight</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-lengths">Predefined lengths</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctriangle"><code>\triangle</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005ctriangleleft"><code>\triangleleft</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11928,6 +14504,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cuparrow"><code>\uparrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cUpdownarrow"><code>\Updownarrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cupdownarrow"><code>\updownarrow</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cupharpoonright"><code>\upharpoonright</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cuplus"><code>\uplus</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cupshape"><code>\upshape</code></a>:</td><td> </td><td valign="top"><a href="#Font-styles">Font styles</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cUpsilon"><code>\Upsilon</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11958,7 +14535,7 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cvspace"><code>\vspace</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cvspace">\vspace</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cwedge"><code>\wedge</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cwidehat"><code>\widehat</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005cwidehat-1"><code>\widehat</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-_005cwidetilde"><code>\widetilde</code></a>:</td><td> </td><td valign="top"><a href="#Math-accents">Math accents</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cwidth"><code>\width</code></a>:</td><td> </td><td valign="top"><a href="#Predefined-lengths">Predefined lengths</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cwp"><code>\wp</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005cwr"><code>\wr</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> @@ -11967,7 +14544,6 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-_005cyear"><code>\year</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cday-_005cmonth-_005cyear">\day \month \year</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005czeta"><code>\zeta</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_005b"><code>\[</code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-_005c_005c-_0028for-array_0029"><code>\\ <span class="roman">(for <code>array</code>)</span></code></a>:</td><td> </td><td valign="top"><a href="#array">array</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_005c-_0028for-center_0029"><code>\\ <span class="roman">(for <code>center</code>)</span></code></a>:</td><td> </td><td valign="top"><a href="#center">center</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_005c-_0028for-eqnarray_0029"><code>\\ <span class="roman">(for <code>eqnarray</code>)</span></code></a>:</td><td> </td><td valign="top"><a href="#eqnarray">eqnarray</a></td></tr> <tr><td></td><td valign="top"><a href="#index-_005c_005c-_0028for-flushright_0029"><code>\\ (for <code>flushright</code>)</code></a>:</td><td> </td><td valign="top"><a href="#flushright">flushright</a></td></tr> @@ -12012,14 +14588,20 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><th><a name="Command-Index_fn_letter-B">B</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-b5paper-option"><code>b5paper <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-book-class"><code>book <span class="roman">class</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-classes">Document classes</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-bottomnumber"><code>bottomnumber</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-bottomnumber"><code>bottomnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-bottomnumber-1"><code>bottomnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-bp"><code>bp</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-C">C</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-cc"><code>cc</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-center-environment"><code>center <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#center">center</a></td></tr> <tr><td></td><td valign="top"><a href="#index-clock-option-to-slides-class"><code>clock <span class="roman">option to <code>slides</code> class</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-cm"><code>cm</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-D">D</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-dbltopnumber"><code>dbltopnumber</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-dbltopnumber"><code>dbltopnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-dbltopnumber-1"><code>dbltopnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-dd"><code>dd</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-description-environment"><code>description <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#description">description</a></td></tr> <tr><td></td><td valign="top"><a href="#index-displaymath-environment"><code>displaymath <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#displaymath">displaymath</a></td></tr> <tr><td></td><td valign="top"><a href="#index-displaymath-environment-1"><code>displaymath <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> @@ -12030,11 +14612,13 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-dvitype-command"><code>dvitype <span class="roman">command</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-E">E</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-em-1"><code>em</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-enumerate-environment"><code>enumerate <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#enumerate">enumerate</a></td></tr> <tr><td></td><td valign="top"><a href="#index-eqnarray-environment"><code>eqnarray <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#eqnarray">eqnarray</a></td></tr> <tr><td></td><td valign="top"><a href="#index-equation-environment"><code>equation <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#equation">equation</a></td></tr> <tr><td></td><td valign="top"><a href="#index-equation-environment-1"><code>equation <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> <tr><td></td><td valign="top"><a href="#index-etex-command"><code>etex <span class="roman">command</span></code></a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-ex-1"><code>ex</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-executivepaper-option"><code>executivepaper <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-F">F</a></th><td></td><td></td></tr> @@ -12050,6 +14634,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-http_003a_002f_002fhome_002egna_002eorg_002flatexrefman-home-page"><code><a href="http://home.gna.org/latexrefman">http://home.gna.org/latexrefman</a> <span class="roman">home page</span></code></a>:</td><td> </td><td valign="top"><a href="#About-this-document">About this document</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-I">I</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-in"><code>in</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-inch"><code>inch</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-indexspace"><code>indexspace</code></a>:</td><td> </td><td valign="top"><a href="#Indexes">Indexes</a></td></tr> <tr><td></td><td valign="top"><a href="#index-itemize-environment"><code>itemize <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#itemize">itemize</a></td></tr> <tr><td colspan="4"> <hr></td></tr> @@ -12060,8 +14646,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-latexrefman_002ddiscuss_0040gna_002eorg-email-address"><code><a href="mailto:latexrefman-discuss@gna.org">latexrefman-discuss@gna.org</a> <span class="roman">email address</span></code></a>:</td><td> </td><td valign="top"><a href="#About-this-document">About this document</a></td></tr> <tr><td></td><td valign="top"><a href="#index-legalpaper-option"><code>legalpaper <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-leqno-option"><code>leqno <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-letter"><code>letter</code></a>:</td><td> </td><td valign="top"><a href="#letter">letter</a></td></tr> <tr><td></td><td valign="top"><a href="#index-letter-class"><code>letter <span class="roman">class</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-classes">Document classes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-letter-environment"><code>letter <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#letter">letter</a></td></tr> <tr><td></td><td valign="top"><a href="#index-letterpaper-option"><code>letterpaper <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-list"><code>list</code></a>:</td><td> </td><td valign="top"><a href="#list">list</a></td></tr> <tr><td></td><td valign="top"><a href="#index-lR-box"><code>lR box</code></a>:</td><td> </td><td valign="top"><a href="#picture">picture</a></td></tr> @@ -12073,6 +14659,8 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-math-environment"><code>math <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#math">math</a></td></tr> <tr><td></td><td valign="top"><a href="#index-math-environment-1"><code>math <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#Math-formulas">Math formulas</a></td></tr> <tr><td></td><td valign="top"><a href="#index-minipage-environment"><code>minipage <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#minipage">minipage</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-mm"><code>mm</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-mu"><code>mu</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-N">N</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-notitlepage-option"><code>notitlepage <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> @@ -12085,13 +14673,15 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td></td><td valign="top"><a href="#index-openright-option"><code>openright <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-P">P</a></th><td></td><td></td></tr> +<tr><td></td><td valign="top"><a href="#index-pc"><code>pc</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td></td><td valign="top"><a href="#index-pdflatex-command"><code>pdflatex <span class="roman">command</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> <tr><td></td><td valign="top"><a href="#index-picture"><code>picture</code></a>:</td><td> </td><td valign="top"><a href="#picture">picture</a></td></tr> <tr><td></td><td valign="top"><a href="#index-printindex"><code>printindex</code></a>:</td><td> </td><td valign="top"><a href="#Indexes">Indexes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-pt"><code>pt</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-Q">Q</a></th><td></td><td></td></tr> -<tr><td></td><td valign="top"><a href="#index-quotation"><code>quotation</code></a>:</td><td> </td><td valign="top"><a href="#quotation">quotation</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-quote"><code>quote</code></a>:</td><td> </td><td valign="top"><a href="#quote">quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-quotation"><code>quotation</code></a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-quote"><code>quote</code></a>:</td><td> </td><td valign="top"><a href="#quotation-and-quote">quotation and quote</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-R">R</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-report-class"><code>report <span class="roman">class</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-classes">Document classes</a></td></tr> @@ -12099,18 +14689,22 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><th><a name="Command-Index_fn_letter-S">S</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-secnumdepth-counter"><code>secnumdepth <span class="roman">counter</span></code></a>:</td><td> </td><td valign="top"><a href="#Sectioning">Sectioning</a></td></tr> <tr><td></td><td valign="top"><a href="#index-slides-class"><code>slides <span class="roman">class</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-classes">Document classes</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-sp"><code>sp</code></a>:</td><td> </td><td valign="top"><a href="#Units-of-length">Units of length</a></td></tr> <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-T">T</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-tabbing-environment"><code>tabbing <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr> <tr><td></td><td valign="top"><a href="#index-table"><code>table</code></a>:</td><td> </td><td valign="top"><a href="#table">table</a></td></tr> <tr><td></td><td valign="top"><a href="#index-tabular-environment"><code>tabular <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#tabular">tabular</a></td></tr> <tr><td></td><td valign="top"><a href="#index-textcomp-package-1"><code>textcomp <span class="roman">package</span></code></a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-thebibliography"><code>thebibliography</code></a>:</td><td> </td><td valign="top"><a href="#thebibliography">thebibliography</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-thebibliography-environment"><code>thebibliography <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#thebibliography">thebibliography</a></td></tr> <tr><td></td><td valign="top"><a href="#index-theorem-environment"><code>theorem <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#theorem">theorem</a></td></tr> <tr><td></td><td valign="top"><a href="#index-titlepage-environment"><code>titlepage <span class="roman">environment</span></code></a>:</td><td> </td><td valign="top"><a href="#titlepage">titlepage</a></td></tr> <tr><td></td><td valign="top"><a href="#index-titlepage-option"><code>titlepage <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-topnumber"><code>topnumber</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> -<tr><td></td><td valign="top"><a href="#index-totalnumber"><code>totalnumber</code></a>:</td><td> </td><td valign="top"><a href="#figure">figure</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-topmargin"><code>topmargin</code></a>:</td><td> </td><td valign="top"><a href="#Page-layout-parameters">Page layout parameters</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-topnumber"><code>topnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-topnumber-1"><code>topnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-totalnumber"><code>totalnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-totalnumber-1"><code>totalnumber</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr> <tr><td></td><td valign="top"><a href="#index-twocolumn-option"><code>twocolumn <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td></td><td valign="top"><a href="#index-twoside-option"><code>twoside <span class="roman">option</span></code></a>:</td><td> </td><td valign="top"><a href="#Document-class-options">Document class options</a></td></tr> <tr><td colspan="4"> <hr></td></tr> @@ -12123,18 +14717,19 @@ Previous: <a href="#Concept-Index" accesskey="p" rel="prev">Concept Index</a>, U <tr><td colspan="4"> <hr></td></tr> <tr><th><a name="Command-Index_fn_letter-X">X</a></th><td></td><td></td></tr> <tr><td></td><td valign="top"><a href="#index-xdvi-command"><code>xdvi <span class="roman">command</span></code></a>:</td><td> </td><td valign="top"><a href="#Output-files">Output files</a></td></tr> +<tr><td></td><td valign="top"><a href="#index-xdvipdfmx"><code>xdvipdfmx</code></a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td></td><td valign="top"><a href="#index-xelatex-command"><code>xelatex <span class="roman">command</span></code></a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr> <tr><td colspan="4"> <hr></td></tr> </table> <table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Command-Index_fn_symbol-1"><b>$</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-2"><b>-</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-2"><b>&</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-3"><b>.</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-3"><b>-</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-4"><b>1</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-4"><b>.</b></a> -<a class="summary-letter" href="#Command-Index_fn_symbol-5"><b>@</b></a> +<a class="summary-letter" href="#Command-Index_fn_symbol-5"><b>1</b></a> <a class="summary-letter" href="#Command-Index_fn_symbol-6"><b>[</b></a> diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf Binary files differindex c197c59c6ee..ab2b1ee03c6 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi index 7ce2d93da39..d4c8da471e9 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi @@ -1,8 +1,8 @@ \input texinfo -@c $Id: latex2e.texi 333 2015-05-12 17:12:37Z karl $ +@c $Id: latex2e.texi 459 2015-10-12 11:33:10Z jhefferon $ @comment %**start of header (This is for running Texinfo on a region.) @setfilename latex2e.info -@set UPDATED May 2015 +@set UPDATED October 2015 @settitle @LaTeX{}2e unofficial reference manual (@value{UPDATED}) @comment %**end of header (This is for running Texinfo on a region.) @@ -18,6 +18,8 @@ @c xx merge http://mirror.ctan.org/latex2e-reference.tar.gz @c xx merge permuted-index @c xx merge latex-manual from savannah +@c xx merge display style math +@c xx vertical mode, horizontal mode @c @c xx The typeset source2e has an index with all kernel @c xx commands, though some are internal and shouldn't be included. @@ -86,6 +88,24 @@ into another language, under the above conditions for modified versions. @shortcontents @contents +@c Best Effort Symbol +@iftex +@macro BES {utf8,math} +@math{\math\} +@end macro +@macro BESU {utf8,math} +@code{@backslashchar{}\math\} +@end macro +@end iftex +@ifnottex +@macro BES {utf8,math} +@U{\utf8\} +@end macro +@macro BESU {utf8,math} +@U{\utf8\} +@end macro +@end ifnottex + @node Top @top @LaTeX{}2e: An unofficial reference manual @@ -204,7 +224,7 @@ should be formatted. It is implemented as a set of related commands that interface with Donald@tie{}E. Knuth's @TeX{} typesetting program (the technical term is that @LaTeX{} is a @dfn{macro package} for the @TeX{} engine). The user produces the output document by giving that -file to the @TeX{} engine. +input file to the @TeX{} engine. The term @LaTeX{} is also sometimes used to mean the language in which the document is marked up, that is, to mean the set of commands @@ -220,7 +240,7 @@ sensible, such as in plain text, write it as @samp{LaTeX}. @menu * Starting and ending:: The standard beginning and end of a document. * Output files:: Files produced. -* @TeX{} engines:: Programs that implementation @LaTeX{}. +* @TeX{} engines:: Programs that can compile @TeX{} and @LaTeX{}. * @LaTeX{} command syntax:: General syntax of @LaTeX{} commands. @end menu @@ -229,12 +249,12 @@ sensible, such as in plain text, write it as @samp{LaTeX}. @section Starting and ending @anchor{Starting & ending}@c old name -@cindex starting & ending -@cindex ending & starting +@cindex starting and ending +@cindex ending and starting @cindex hello, world -@LaTeX{} files have a simple global structure, with a standard -starting and ending. Here is a ``hello, world'' example: +@LaTeX{} files have a simple global structure, with a standard beginning +and ending. Here is a ``hello, world'' example: @example \documentclass@{article@} @@ -256,9 +276,10 @@ You can include other @LaTeX{} commands between the This area is called the @dfn{preamble}. The @code{\begin@{document@} ... \end@{document@}} is a so-called +@cindex environment @dfn{environment}; the @samp{document} environment (and no others) is -required in all @LaTeX{} documents. @LaTeX{} provides many -environments itself, and many more are defined separately. +required in all @LaTeX{} documents (@pxref{document}). @LaTeX{} +provides many environments itself, and many more are defined separately. @xref{Environments}. The following sections discuss how to produce PDF or other output from @@ -363,7 +384,7 @@ overview of the main programs. @cindex pdf@TeX{} engine @findex etex @r{command} @cindex e-@TeX{} -In @TeX{} Live (@url{http://tug.org/texlive}, if @LaTeX{} is invoked +In @TeX{} Live (@url{http://tug.org/texlive}), if @LaTeX{} is invoked via either the system command @command{latex} or @command{pdflatex}, then the pdf@TeX{} engine is run (@url{http://ctan.org/pkg/pdftex}). When invoked as @command{latex}, the main output is a @file{.dvi} @@ -372,9 +393,9 @@ file; as @command{pdflatex}, the main output is a @file{.pdf} file. pdf@TeX{} incorporates the e-@TeX{} extensions to Knuth's original program (@url{http://ctan.org/pkg/etex}), including additional programming features and bi-directional typesetting, and has plenty of -extensions of its own. e-@TeX{} is available on its own as the +extensions of its own. e-@TeX{} is available on its own as the system command @command{etex}, but this is plain @TeX{} (and produces -@file{.dvi}). +@file{.dvi}). In other @TeX{} distributions, @command{latex} may invoke e-@TeX{} rather than pdf@TeX{}. In any case, the e-@TeX{} extensions can be @@ -395,12 +416,19 @@ but this is rarely used. @item xelatex @findex xelatex @r{command} @cindex Xe@TeX{} +@findex .xdv @r{file} +@findex xdvipdfmx If @LaTeX{} is invoked with the system command @command{xelatex}, the Xe@TeX{} engine is run (@url{http://tug.org/xetex}). Like Lua@TeX{}, -Xe@TeX{} also natively supports UTF-8 Unicode and TrueType and -OpenType fonts, though the implementation is completely different, -mainly using external libraries instead of internal code. Xe@TeX{} -produces a @file{.pdf} file as output; it does not support DVI output. +Xe@TeX{} natively supports UTF-8 Unicode and TrueType and OpenType +fonts, though the implementation is completely different, mainly using +external libraries instead of internal code. Xe@TeX{} produces a +@file{.pdf} file as output; it does not support DVI output. + +Internally, Xe@TeX{} creates an @code{.xdv} file, a variant of DVI, +and translates that to PDF using the (@code{x})@code{dvipdfmx} +program, but this process is automatic. The @code{.xdv} file is only +useful for debugging. @end table @@ -416,27 +444,86 @@ additional support for Japanese and other languages ([u]p@TeX{}, @findex \ @r{character starting commands} @findex [...] @r{for optional arguments} @findex @{...@} @r{for required arguments} -In the @LaTeX{} input file, a command name starts with a @code{\}; the -name itself then consists of either (a)@tie{}a string of letters or -(b)@tie{}a single non-letter. +In the @LaTeX{} input file, a command name starts with a backslash +character, @code{\}. The name itself then consists of either +(a)@tie{}a string of letters or (b)@tie{}a single non-letter. + +@LaTeX{} commands names are case sensitive so that @code{\pagebreak} +differs from @code{\Pagebreak} (the latter is not a standard command). +Most commands are lowercase, but in any event you must enter all +commands in the same case as they are defined. + +A command may be followed by zero, one, or more arguments. These +arguments may be either required or optional. Required arguments are +contained in curly braces, @code{@{...@}}. Optional arguments are +contained in square brackets, @code{[...]}. Generally, but not +universally, if the command accepts an optional argument, it comes +first, before any required arguments. + +Inside of an optional argument, to use the character close square +bracket@tie{}(@code{]}) hide it inside curly braces, as +in@tie{}@code{\item[closing bracket @{]@}]}. Similarly, if an optional +argument comes last, with no required argument after it, then to make +the first character of the following text be an open square bracket, +hide it inside curly braces. + +@LaTeX{} has the convention that some commands have a @code{*} form that +is related to the form without a @code{*}, such as @code{\chapter} and +@code{\chapter*}. The exact difference in behavior varies from command +to command. + +This manual describes all accepted options and @code{*}-forms for the +commands it covers (barring unintentional omissions, a.k.a.@: bugs). -A command may be followed by zero, one, or more arguments, either -required or optional. Required arguments are contained in curly -braces, @code{@{...@}}. Optional arguments are contained in square -brackets, @code{[...]}. Generally, but not universally, if the -command accepts an optional argument, it comes first, before any -required arguments. +@menu +* Environment:: Area of the source with distinct behavior. +* Declaration:: Change the value or meaning of a command. +@end menu -Some commands have a @code{*} form that is related to the form without -a @code{*}, such as @code{\chapter} and @code{\chapter*}. -@LaTeX{} commands are case sensitive; neither @code{\Begin@{document@}} -nor @code{\begin@{Document@}} will work. Most commands are lowercase, -but in any event you must enter all commands in the same case as they -are defined. +@node Environment -This manual describes all accepted options and @code{*}-forms for the -commands it covers (barring unintentional omissions, a.k.a.@: bugs). +Synopsis: + +@example +\begin@{@var{environment name}@} + .. +\end@{@var{environment name}@} +@end example + +An area of @LaTeX{} source, inside of which there is a distinct +behavior. For instance, for poetry in @LaTeX{} put the lines between +@code{\begin@{verse@}} and @code{\end@{verse@}}. + +@example +\begin@{verse@} + There once was a man from Nantucket \\ + .. +\end@{verse@} +@end example + +The @var{environment name} at the beginning must exactly match that at +the end. This includes the case where @var{environment name} ends in a +star@tie{}(@code{*}); both the @code{\begin} and @code{\end} texts must +include the star. + +Environments may have arguments, including optional arguments. This +example produces a table. The first argument is optional (and causes +the table to be aligned on its top row) while the second argument is +required (it specifies the formatting of columns). + +@example +\begin@{tabular@}[t]@{r|l@} + .. rows of table .. +\end@{tabular@} +@end example + + +@node Declaration + +A command that changes the value, or changes the meaning, of some other +command or parameter. For instance, the @code{\mainmatter} command +changes the setting of page numbers from roman numerals to arabic. @node Document classes @@ -471,6 +558,10 @@ Full-length books, including chapters and possibly including front matter, such as a preface, and back matter, such as an appendix (@pxref{Front/back matter}). +@item letter +Mail, optionally including mailing labels +(@pxref{Letters}). + @item report For documents of length between an @code{article} and a @code{book}, such as technical reports or theses, which may contain several chapters. @@ -524,11 +615,35 @@ options for selecting the typeface size (default is @code{10pt}): @findex legalpaper @r{option} @findex letterpaper @r{option} All of the standard classes accept these options for selecting the paper -size (default is @code{letterpaper}): +size (these show height by width): + +@table @code +@item a4paper +210 by 297 mm (about 8.25 by 11.75 inches) + +@item b5paper +176 by 250 mm (about 7 by 9.875 inches) + +@item executivepaper +7.25 by 10.5 inches + +@item legalpaper +8.5 by 14 inches + +@item letterpaper +8.5 by 11 inches (the default) +@end table -@example -a4paper a5paper b5paper executivepaper legalpaper letterpaper -@end example +@findex \pdfpagewidth +@findex \pdfpageheight +@cindex @code{geometry} package +When using one of the engines pdf@LaTeX{}, Lua@LaTeX{}, or Xe@LaTeX{} +(@pxref{@TeX{} engines}), options other than @code{letterpaper} set +the print area but you must also set the physical paper size. One way +to do that is to put @code{\pdfpagewidth=\paperwidth} and +@code{\pdfpageheight=\paperheight} in your document's preamble. The +@code{geometry} package provides flexible ways of setting the print +area and physical page size. @findex draft @r{option} @findex final @r{option} @@ -653,16 +768,17 @@ and a style. The @LaTeX{} commands for doing this are described here. @section Font styles @cindex font styles -@cindex typeface styles +@cindex type styles @cindex styles of text The following type style commands are supported by @LaTeX{}. This first group of commands is typically used with an argument, as in -@code{\textit@{italic text@}}. In the table below, the corresponding +@code{\textit@{@var{text}@}}. In the table below, the corresponding command in parenthesis is the ``declaration form'', which takes no -arguments. The scope of the declaration form lasts until the next type -style command or the end of the current group. +arguments, as in @code{@{\itshape @var{text}@}}. The scope of the +declaration form lasts until the next type style command or the end of +the current group. These commands, in both the argument form and the declaration form, are cumulative; e.g., you can say either @code{\sffamily\bfseries} or @@ -693,11 +809,6 @@ Roman. @findex \itshape Italics. -@item \emph -@findex \emph -@cindex emphasis -Emphasis (switches between @code{\textit} and @code{\textrm}). - @item \textmd (\mdseries) @findex \textmd @findex \mdseries @@ -711,7 +822,7 @@ Boldface. @item \textup (\upshape) @findex \textup @findex \upshape -Upright (default). The opposite of slanted. +Upright (default). @item \textsl (\slshape) @findex \textsl @@ -738,78 +849,33 @@ Typewriter. @findex \normalfont Main document font. -@item \mathrm -@findex \mathrm -Roman, for use in math mode. - -@item \mathbf -@findex \mathbf -Boldface, for use in math mode. - -@item \mathsf -@findex \mathsf -Sans serif, for use in math mode. - -@item \mathtt -@findex \mathtt -Typewriter, for use in math mode. - -@item \mathit -@itemx (\mit) -Italics, for use in math mode. - -@item \mathnormal -@findex \mathnormal -For use in math mode, e.g. inside another type style declaration. - -@item \mathcal -@findex \mathcal -`Calligraphic' letters, for use in math mode. - @end table -@findex \mathversion -@cindex math, bold -@cindex bold math -In addition, the command @code{\mathversion@{bold@}} can be used for -switching to bold letters and symbols in -formulas. @code{\mathversion@{normal@}} restores the default. - -@findex \oldstylenums -@cindex numerals, old-style -@cindex old-style numerals -@cindex lining numerals -@cindex @code{textcomp} package -Finally, the command @code{\oldstylenums@{@var{numerals}@}} will -typeset so-called ``old-style'' numerals, which have differing heights -and depths (and sometimes widths) from the standard ``lining'' -numerals. @LaTeX{}'s default fonts support this, and will respect -@code{\textbf} (but not other styles; there are no italic old-style -numerals in Computer Modern). Many other fonts have old-style -numerals also; sometimes the @code{textcomp} package must be loaded, -and sometimes package options are provided to make them the default. -FAQ entry: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf}. +@cindex emphasis +@findex \emph +Although it also changes fonts, the @code{\emph@{@var{text}@}} command +is semantic, for text to be emphasized, and should not be used as a +substitute for @code{\textit}. For example, @code{\emph@{@var{start +text} \emph@{@var{middle text}@} @var{end text}@}} will result in the +@var{start text} and @var{end text} in italics, but @var{middle text} +will be in roman. @LaTeX{} also provides the following commands, which unconditionally switch to the given style, that is, are @emph{not} cumulative. Also, -they are used differently than the above commands: @code{@{\@var{cmd} -...@}} instead of @code{\@var{cmd}@{...@}}. These are two unrelated -constructs. +they are used differently than the above commands: +@code{@{\@var{cmd}...@}} instead of @code{\@var{cmd}@{...@}}. These +are two unrelated constructs. @ftable @code @item \bf @cindex bold font -Switch to @b{bold face}. +Switch to bold face. @item \cal @cindex script letters for math @cindex calligraphic letters for math Switch to calligraphic letters for math. -@item \em -@cindex emphasis -Emphasis (italics within roman, roman within italics). - @item \it @cindex italic font Italics. @@ -839,17 +905,79 @@ Typewriter (monospace, fixed-width). @end ftable -Some people consider the unconditional font-switching commands, such -as @code{\tt}, obsolete and @emph{only} the cumulative commands -(@code{\texttt}) should be used. I (Karl) do not agree. There are -perfectly reasonable situations when an unconditional font switch is -precisely what you need to get the desired output; for one example, -@pxref{description,,@code{description}}. Both sets of commands have -their place. +The @code{\em} command is the unconditional version of @code{\emph}. + +(Some people consider the unconditional font-switching commands, such +as @code{\tt}, obsolete and that only the cumulative commands +(@code{\texttt}) should be used. Others think that both sets of +commands have their place and sometimes an unconditional font switch +is precisely what you want; for one example, +@pxref{description,,@code{description}}.) + +The following commands are for use in math mode. They are not +cumulative, so @code{\mathbf@{\mathit@{@var{symbol}@}@}} does not +create a boldface and italic @var{symbol}; instead, it will just be in +italics. This is because typically math symbols need consistent +typographic treatment, regardless of the surrounding environment. + +@table @code +@item \mathrm +@findex \mathrm +Roman, for use in math mode. + +@item \mathbf +@findex \mathbf +Boldface, for use in math mode. + +@item \mathsf +@findex \mathsf +Sans serif, for use in math mode. + +@item \mathtt +@findex \mathtt +Typewriter, for use in math mode. + +@item \mathit +@itemx (\mit) +Italics, for use in math mode. + +@item \mathnormal +@findex \mathnormal +For use in math mode, e.g., inside another type style declaration. + +@item \mathcal +@findex \mathcal +Calligraphic letters, for use in math mode. + +@end table + +@findex \mathversion +@cindex math, bold +@cindex bold math +In addition, the command @code{\mathversion@{bold@}} can be used for +switching to bold letters and symbols in +formulas. @code{\mathversion@{normal@}} restores the default. + +@findex \oldstylenums +@cindex numerals, old-style +@cindex old-style numerals +@cindex lining numerals +@cindex @code{textcomp} package +Finally, the command @code{\oldstylenums@{@var{numerals}@}} will typeset +so-called ``old-style'' numerals, which have differing heights and +depths (and sometimes widths) from the standard ``lining'' numerals, +which all have the same height as upper-case letters. @LaTeX{}'s +default fonts support this, and will respect @code{\textbf} (but not +other styles; there are no italic old-style numerals in Computer +Modern). Many other fonts have old-style numerals also; sometimes the +@code{textcomp} package must be loaded, and sometimes package options +are provided to make them the default. FAQ entry: +@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf}. @node Font sizes @section Font sizes + @cindex font sizes @cindex typeface sizes @cindex sizes of text @@ -903,50 +1031,119 @@ these commands; for instance, @code{\begin@{tiny@}...\end@{tiny@}}. @node Low-level font commands @section Low-level font commands + @cindex low-level font commands @cindex font commands, low-level These commands are primarily intended for writers of macros and packages. The commands listed here are only a subset of the available ones. +@c xx but it should be complete +@c xx something about ultimately reading ENCFAM.fd? @table @code -@item \fontencoding@{enc@} +@item \fontencoding@{@var{encoding}@} @findex \fontencoding -Select font encoding. Valid encodings include @code{OT1} and @code{T1}. - -@item \fontfamily@{family@} +Select the font encoding, the encoding of the output font. There are a +large number of valid encodings. The most common are @code{OT1}, +Knuth's original encoding for Computer Modern (the default), and +@code{T1}, also known as the Cork encoding, which has support for the +accented characters used by the most widespread European languages +(German, French, Italian, Polish and others), which allows @TeX{} to +hyphenate words containing accented letters. + +@item \fontfamily@{@var{family}@} @findex \fontfamily -Select font family. Valid families include: - -@itemize @bullet -@item @code{cmr} for Computer Modern Roman -@item @code{cmss} for Computer Modern Sans Serif -@item @code{cmtt} for Computer Modern Typewriter +@cindex families, of fonts +@cindex font catalogue +Select the font family. The web page +@url{http://www.tug.dk/FontCatalogue/} provides one way to browse +through many of the fonts easily used with @LaTeX{}. Here are +examples of some common families: + +@c Sorry about the ugly @t{@ }. The idea is to make the lists line up +@c in Info. Since the items are so short, it seems nice to have them +@c on the same line instead of using @table. + +@itemize @w{} +@item @code{pag}@t{@ } Avant Garde +@item @code{fvs}@t{@ } Bitstream Vera Sans +@item @code{pbk}@t{@ } Bookman +@item @code{bch}@t{@ } Charter +@item @code{ccr}@t{@ } Computer Concrete +@item @code{cmr}@t{@ } Computer Modern +@item @code{pcr}@t{@ } Courier +@item @code{phv}@t{@ } Helvetica +@item @code{fi4}@t{@ } Inconsolata +@item @code{lmr}@t{@ } Latin Modern +@item @code{lmss} Latin Modern Sans +@item @code{lmtt} Latin Modern Typewriter +@item @code{pnc}@t{@ } New Century Schoolbook +@item @code{ppl}@t{@ } Palatino +@item @code{ptm}@t{@ } Times +@item @code{uncl} Uncial +@item @code{put}@t{@ } Utopia +@item @code{pzc}@t{@ } Zapf Chancery @end itemize -and numerous others. - -@item \fontseries@{series@} +@item \fontseries@{@var{series}@} @findex \fontseries -Select font series. Valid series include: - -@itemize @bullet -@item @code{m} Medium (normal) -@item @code{b} Bold -@item @code{c} Condensed +@cindex series, of fonts +Select the font series. A @dfn{series} combines a @dfn{weight} and a +@dfn{width}. Typically, a font supports only a few of the possible +combinations. Some common combined series values include: + +@itemize @w{} +@item @code{m}@t{@ } Medium (normal) +@item @code{b}@t{@ } Bold +@item @code{c}@t{@ } Condensed @item @code{bc} Bold condensed @item @code{bx} Bold extended @end itemize -and various other combinations. +@cindex weights, of fonts +The possible values for weight, individually, are: + +@itemize @w{} +@item @code{ul} Ultra light +@item @code{el} Extra light +@item @code{l}@t{@ } Light +@item @code{sl} Semi light +@item @code{m}@t{@ } Medium (normal) +@item @code{sb} Semi bold +@item @code{b}@t{@ } Bold +@item @code{eb} Extra bold +@item @code{ub} Ultra bold +@end itemize + +@cindex widths, of fonts +The possible values for width, individually, are (the percentages +are just guides and are not followed precisely by all fonts): + +@itemize @w{} +@item @code{uc} Ultra condensed, 50% +@item @code{ec} Extra condensed, 62.5% +@item @code{c}@t{@ } Condensed, 75% +@item @code{sc} Semi condensed, 87.5% +@item @code{m}@t{@ } Medium, 100% +@item @code{sx} Semi expanded, 112.5% +@item @code{x}@t{@ } Expanded, 125% +@item @code{ex} Extra expanded, 150% +@item @code{ux} Ultra expanded, 200% +@end itemize -@item \fontshape@{shape@} +When forming the @var{series} string from the weight and width, drop the +@code{m} that stands for medium weight or medium width, unless both +weight and width are @code{m}, in which case use just one +(@samp{@code{m}}). + +@item \fontshape@{@var{shape}@} @findex \fontshape +@cindex shapes, of fonts Select font shape. Valid shapes are: -@itemize @bullet -@item @code{n} Upright (normal) +@itemize @w{} +@item @code{n}@t{@ } Upright (normal) @item @code{it} Italic @item @code{sl} Slanted (oblique) @item @code{sc} Small caps @@ -954,53 +1151,73 @@ Select font shape. Valid shapes are: @item @code{ol} Outline @end itemize -The two last shapes are not available for most font families. +The two last shapes are not available for most font families, and +small caps are often missing as well. -@item \fontsize@{size@}@{skip@} +@item \fontsize@{@var{size}@}@{@var{skip}@} @findex \fontsize +@cindex font size @findex \baselineskip -Set font size. The first parameter is the font size to switch to and -the second is the line spacing to use; this is stored in a parameter -named @code{\baselineskip}. The unit of both parameters defaults to -pt. The default @code{\baselineskip} for the Computer Modern typeface -is 1.2 times the @code{\fontsize}. - +Set the font size and the line spacing. The unit of both parameters +defaults to points (@code{pt}). The line spacing is the nominal +vertical space between lines, baseline to baseline. It is stored in the +parameter @code{\baselineskip}. The default @code{\baselineskip} for +the Computer Modern typeface is 1.2 times the @code{\fontsize}. +Changing @code{\baselineskip} directly is inadvisable since its value is +reset every time a size change happens; see @code{\baselinestretch}, next. + +@item \baselinestretch @findex \baselinestretch +@LaTeX{} multiplies the line spacing by the value of the +@code{\baselinestretch} parameter; the default factor is 1. A change +takes effect when @code{\selectfont} (see below) is called. You can +make line skip changes happen for the entire document by doing +@code{\renewcommand@{\baselinestretch@}@{2.0@}} in the preamble. + @cindex @code{setspace} package @cindex double spacing -The line spacing is also multiplied by the value of the -@code{\baselinestretch} parameter when the type size changes; the -default is 1. However, the best way to ``double space'' a document, -if you should be unlucky enough to have to produce such, is to use the -@code{setspace} package; see -@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace}. +However, the best way to double-space a document is to use the +@file{setspace} package. In addition to offering a number of spacing +options, this package keeps the line spacing single-spaced in places +where that is typically desirable, such as footnotes and figure +captions. See the package documentation. -@findex \linespread @item \linespread@{@var{factor}@} +@findex \linespread Equivalent to @code{\renewcommand@{\baselinestretch@}@{@var{factor}@}}, and therefore must be followed by @code{\selectfont} to have any effect. Best specified in the preamble, or use the @code{setspace} package, as -described just above. +just described. +@item \selectfont @findex \selectfont -The changes made by calling the font commands described above do -not come into effect until @code{\selectfont} is called. - -@item \usefont@{enc@}@{family@}@{series@}@{shape@} +The effects of the font commands described above do not happen until +@code{\selectfont} is called, as in +@code{\fontfamily@{@var{familyname}@}\selectfont}. It is often useful +to put this in a macro:@* +@code{\newcommand*@{\myfont@}@{\fontfamily@{@var{familyname}@}\selectfont@}}@* +(@pxref{\newcommand & \renewcommand}). + +@item \usefont@{@var{enc}@}@{@var{family}@}@{@var{series}@}@{@var{shape}@} @findex \usefont The same as invoking @code{\fontencoding}, @code{\fontfamily}, @code{\fontseries} and @code{\fontshape} with the given parameters, -followed by @code{\selectfont}. +followed by @code{\selectfont}. For example: + +@example +\usefont@{ot1@}@{cmr@}@{m@}@{n@} +@end example @end table @node Layout @chapter Layout + @cindex layout commands -Miscellaneous commands for controlling the general layout of the page. +Commands for controlling the general page layout. @menu * \onecolumn:: Use one-column layout. @@ -1008,20 +1225,27 @@ Miscellaneous commands for controlling the general layout of the page. * \flushbottom:: Make all text pages the same height. * \raggedbottom:: Allow text pages of differing height. * Page layout parameters:: @code{\headheight} @code{\footskip}. +* Floats:: Figures, tables, etc. @end menu @node \onecolumn @section @code{\onecolumn} + @findex \onecolumn @cindex one-column output The @code{\onecolumn} declaration starts a new page and produces -single-column output. This is the default. +single-column output. If the document is given the class option +@code{onecolumn} then this is the default behavior (@pxref{Document +class options}). + +This command is fragile (@pxref{\protect}). @node \twocolumn @section @code{\twocolumn} + @findex \twocolumn @cindex multicolumn text @cindex two-column output @@ -1029,74 +1253,162 @@ single-column output. This is the default. Synopsis: @example -\twocolumn[@var{text1col}] +\twocolumn[@var{prelim one column text}] @end example The @code{\twocolumn} declaration starts a new page and produces -two-column output. If the optional @var{text1col} argument is present, -it is typeset in one-column mode before the two-column typesetting -starts. +two-column output. If the document is given the class option +@code{twocolumn} then this is the default (@pxref{Document class +options}). + +If the optional @var{prelim one column text} argument +is present, it is typeset in one-column mode before the two-column +typesetting starts. + +This command is fragile (@pxref{\protect}). These parameters control typesetting in two-column output: @ftable @code @item \columnsep -The distance between columns (35pt by default). +The distance between columns. The default is 35pt. Change it with a +command such as @code{\setlength@{\columnsep@}@{40pt@}} You must change +it before the two column environment starts; in the preamble is a good +place. @item \columnseprule -The width of the rule between columns; the default is 0pt, so there is no rule. +The width of the rule between columns. The rule appears halfway between +the two columns. The default is 0pt, meaning that there is no rule. +Change it with a command such as +@code{\setlength@{\columnseprule@}@{0.4pt@}}, before the two-column +environment starts. @item \columnwidth -The width of the current column; this is equal to @code{\textwidth} in -single-column text. +The width of a single column. In one-column mode this is equal to +@code{\textwidth}. In two-column mode by default @LaTeX{} sets the +width of each of the two columns to be half of @code{\textwidth} minus +@code{\columnsep}. @end ftable -These parameters control float behavior in two-column output: +In a two-column document, the starred environments @code{table*} and +@code{figure*} are two columns wide, whereas the unstarred environments +@code{table} and @code{figure} take up only one column (@pxref{figure} +and @pxref{table}). @LaTeX{} places starred floats at the top of a page. +The following parameters control float behavior of two-column output. @ftable @code @item \dbltopfraction -Maximum fraction at the top of a two-column page that may be occupied -by floats. Default @samp{.7}, can be usefully redefined to (say) -@samp{.9} to avoid going to float pages so soon. +The maximum fraction at the top of a two-column page that may be +occupied by two-column wide floats. The default is 0.7, meaning that +the height of a @code{table*} or @code{figure*} environment must not +exceed @code{0.7\textheight} . If the height of your starred float +environment exceeeds this then you can take one of the following actions +to prevent it from floating all the way to the back of the document: + +@itemize @bullet +@item +Use the @code{[tp]} location specifier to tell LaTeX to try to put +the bulky float on a page by itself, as well as at the top of a page. + +@item +Use the @code{[t!]} location specifier to override the effect of +@code{\dbltopfraction} for this particular float. + +@item +Increase the value of @code{\dbltopfraction} to a suitably large number, +to avoid going to float pages so soon. +@end itemize + +You can redefine it, for instance with +@code{\renewcommand@{\dbltopfraction@}@{0.9@}}. @item \dblfloatpagefraction -The minimum fraction of a float page that must be occupied by floats, -for a two-column float page. Default @samp{.5}. +For a float page of two-column wide floats, this is the minimum fraction +that must be occupied by floats, limiting the amount of blank space. +@LaTeX{}'s default is @code{0.5}. Change it with @code{\renewcommand}. @item \dblfloatsep -Distance between floats at the top or bottom of a two-column float -page. Default @samp{12pt plus2pt minus2pt} for @samp{10pt} and -@samp{11pt} documents, @samp{14pt plus2pt minus4pt} for @samp{12pt}. +On a float page of two-column wide floats, this length is the distance +between floats, at both the top and bottom of the page. The default is +@code{12pt plus2pt minus2pt} for a document set at @code{10pt} or +@code{11pt}, and @code{14pt plus2pt minus4pt} for a document set at +@code{12pt}. @item \dbltextfloatsep -Distance between a multi-column float at the top or bottom of a page -and the main text. Default @samp{20pt plus2pt minus4pt}. +This length is the distance between a multi-column float at the top or +bottom of a page and the main text. The default is @code{20pt plus2pt +minus4pt}. + +@item \dbltopnumber +On a float page of two-column wide floats, this counter gives the +maximum number of floats allowed at the top of the page. The @LaTeX{} +default is @code{2}. @end ftable +@c From egreg at http://tex.stackexchange.com/a/142232/339 +This example shows the use of the optional argument of @code{\twocolumn} +to create a title that spans the two-column article: + +@example +\documentclass[twocolumn]@{article@} +\newcommand@{\authormark@}[1]@{\textsuperscript@{#1@}@} +\begin@{document@} +\twocolumn[@{% inside this optional argument goes one-column text + \centering + \LARGE The Title \\[1.5em] + \large Author One\authormark@{1@}, + Author Two\authormark@{2@}, + Author Three\authormark@{1@} \\[1em] + \normalsize + \begin@{tabular@}@{p@{.2\textwidth@}@@@{\hspace@{2em@}@}p@{.2\textwidth@}@} + \authormark@{1@}Department one &\authormark@{2@}Department two \\ + School one &School two + \end@{tabular@}\\[3em] % space below title part +@}] + +Two column text here. +@end example + @node \flushbottom @section @code{\flushbottom} @findex \flushbottom -The @code{\flushbottom} declaration makes all text pages the same -height, adding extra vertical space where necessary to fill out the -page. +The @code{\flushbottom} command can go at any point in the document +body. It makes all later pages the same height, stretching the vertical +space where necessary to fill out the page. + +If @TeX{} cannot satisfactorily stretch the vertical space in a page +then you get a message like @samp{Underfull \vbox (badness 10000) has +occurred while \output is active}. You can change to +@code{\raggedbottom} (see below). Alternatively, you can try to adjust +the @code{textheight} to be compatible, or you can add some vertical +stretch glue between lines or between paragraphs, as in +@code{\setlength@{\parskip@}@{0ex plus0.1ex@}}. In a final editing +stage you can adjust the height of individual pages +(@pxref{\enlargethispage}). -This is the default if @code{twocolumn} mode is selected -(@pxref{Document class options}). +This is the default only if you select the @code{twoside} document class +option (@pxref{Document class options}). @node \raggedbottom @section @code{\raggedbottom} + @findex \raggedbottom @cindex stretch, omitting vertical -The @code{\raggedbottom} declaration makes all pages the natural -height of the material on that page. No rubber lengths will be -stretched. +The @code{\raggedbottom} command can go at any point in the document +body. It makes all later pages the natural height of the material on +that page; no rubber lengths will be stretched. Thus, in a two-sided +document the facing pages may be different heights. See also +@code{\flushbottom} above. + +This is the default unless you select the @code{twoside} document class +option (@pxref{Document class options}). @node Page layout parameters @@ -1110,45 +1422,125 @@ stretched. @cindex running header and footer @ftable @code +@item \columnsep +@itemx \columnseprule +@itemx \columnwidth +@findex \columnsep +@findex \columnseprule +@findex \columnwidth +The distance between the two columns, the width of a rule between the +columns, and the width of the columns, when the document class option +@code{twocolumn} is in effect (@pxref{Document class options}). +@xref{\twocolumn}. + @item \headheight -Height of the box that contains the running head. Default is -@samp{30pt}, except in the @code{book} class, where it varies with the -type size. +@findex \headheight +Height of the box that contains the running head. The default in the +@code{article}, @code{report}, and @code{book} classes is @samp{12pt}, +at all type sizes. @item \headsep +@findex \headsep Vertical distance between the bottom of the header line and the top of -the main text. Default is @samp{25pt}, except in the @code{book} -class, where it varies with the type size. +the main text. The default in the @code{article} and @code{report} +classes is @samp{25pt}. In the @code{book} class the default is: if the +document is set at 10pt then it is @samp{0.25in}, and at 11pt and 12pt +it is @samp{0.275in}. @item \footskip +@findex \footskip Distance from the baseline of the last line of text to the baseline of -the page footer. Default is @samp{30pt}, except in the @code{book} -class, where it varies with the type size. +the page footer. The default in the @code{article} and @code{report} +classes is @samp{30pt}. In the @code{book} class the default is: when +the type size is 10pt the default is @samp{0.35in}, while at 11pt it is +@samp{0.38in}, and at 12pt it is @samp{30pt}. @item \linewidth +@findex \linewidth Width of the current line, decreased for each nested @code{list} -(@pxref{list}). Specifically, it is smaller than @code{\textwidth} by -the sum of @code{\leftmargin} and @code{\rightmargin} -(@pxref{itemize}). The default varies with the font size, paper -width, two-column mode, etc. For an @code{article} document in -@samp{10pt}, it's set to @samp{345pt}; in two-column mode, that -becomes @samp{229.5pt}. +(@pxref{list}). That is, the nominal value for @code{\linewidth} is to +equal @code{\textwidth} but for each nested list the @code{\linewidth} +is decreased by the sum of that list's @code{\leftmargin} and +@code{\rightmargin} (@pxref{itemize}). +@c The default varies with the font size, paper width, two-column mode, +@c etc. For an @code{article} document set in 10pt, the default is +@c @samp{345pt}, while in two-column mode that becomes @samp{229.5pt}. + +@item \marginparpush +@itemx \marginsep +@itemx \marginparwidth +@findex \marginparpush +@findex \marginsep +@findex \marginparwidth +The minimum vertical space between two marginal notes, the horizontal +space between the text body and the marginal notes, and the horizontal +width of the notes. + +Normally marginal notes appear on the outside of the page, but the +declaration @code{\reversemarginpar} changes that (and +@code{\normalmarginpar} changes it back). + +The defaults for @code{\marginparpush} in both @code{book} and +@code{article} classes are: @samp{7pt} if the document is set at 12pt, +and @samp{5pt} if the document is set at 11pt or 10pt. + +For @code{\marginsep}, in @code{article} class the default is +@samp{10pt} except if the document is set at 10pt and in two-column mode +where the default is @samp{11pt}. + +For @code{\marginsep} in @code{book} class the default is @samp{10pt} in +two-column mode and @samp{7pt} in one-column mode. + +For @code{\marginparwidth} in both @code{book} and @code{article} +classes, in two-column mode the default is 60% of @code{\paperwidth +@minus{} \textwidth}, while in one-column mode it is 50% of that +distance. + +@item \oddsidemargin +@itemx \evensidemargin +@findex \oddsidemargin +@findex \evensidemargin +The @code{\oddsidemargin} is the extra distance between the left side of +the page and the text's left margin, on odd-numbered pages when the +document class option @code{twoside} is chosen and on all pages when +@code{oneside} is in effect. When @code{twoside} is in effect, on +even-numbered pages the extra distance on the left is +@code{evensidemargin}. + +@LaTeX{}'s default is that @code{\oddsidemargin} is 40% of the +difference between @code{\paperwidth} and @code{\textwidth}, and +@code{\evensidemargin} is the remainder. + +@item \paperheight +@findex \paperheight +The height of the paper, as distinct from the height of the print area. +It is normally set with a document class option, as in +@code{\documentclass[a4paper]@{article@}} (@pxref{Document class +options}). + +@item \paperwidth +@findex \paperwidth +The width of the paper, as distinct from the width of the print area. +It is normally set with a document class option, as in +@code{\documentclass[a4paper]@{article@}} (@pxref{Document class +options}). @item \textheight -The normal vertical height of the page body; the default varies with -the font size, document class, etc. For an @code{article} or -@code{report} document in @samp{10pt}, it's set to -@samp{43\baselineskip}; for @code{book}, it's @samp{41\baselineskip}. -For @samp{11pt}, it's @samp{38\baselineskip} and for @samp{12pt}, -@samp{36\baselineskip}. +@findex \textheight +The normal vertical height of the page body. If the document is set at +a nominal type size of 10pt then for an @code{article} or @code{report} +the default is @samp{43\baselineskip}, while for a @code{book} it is +@samp{41\baselineskip}. At a type size of 11pt the default is +@samp{38\baselineskip} for all document classes. At 12pt it is +@samp{36\baselineskip} for all classes. @item \textwidth -The full horizontal width of the entire page body; the default varies -as usual. For an @code{article} or @code{report} document, it's -@samp{345pt} at @samp{10pt}, @samp{360pt} at @samp{11pt}, and -@samp{390pt} at @samp{12pt}. For a @code{book} document, it's -@samp{4.5in} at @samp{10pt}, and @samp{5in} at @samp{11pt} or -@samp{12pt}. +@findex \textwidth +The full horizontal width of the entire page body. For an +@code{article} or @code{report} document, the default is @samp{345pt} +when the chosen type size is 10pt, the default is @samp{360pt} at 11pt, +and it is @samp{390pt} at 12pt. For a @code{book} document, the default +is @samp{4.5in} at a type size of 10pt, and @samp{5in} at 11pt or 12pt. In multi-column output, @code{\textwidth} remains the width of the entire page body, while @code{\columnwidth} is the width of one column @@ -1164,28 +1556,211 @@ specified width, and revert to their normal values at the end of the @code{minipage} or @code{\parbox}. @findex \hsize -For completeness: @code{\hsize} is the @TeX{} primitive parameter used -when text is broken into lines. It should not be used in normal -@LaTeX{} documents. +@findex \hsize +This entry is included for completeness: @code{\hsize} is the @TeX{} +primitive parameter used when text is broken into lines. It should not +be used in normal @LaTeX{} documents. @item \topmargin +@findex topmargin Space between the top of the @TeX{} page (one inch from the top of the -paper, by default) and the top of the header. The default is computed +paper, by default) and the top of the header. The value is computed based on many other parameters: @code{\paperheight @minus{} 2in @minus{} -\headheight @minus{} \headsep @minus{} \textheight @minus{} \footskip}, and -then divided by two. +\headheight @minus{} \headsep @minus{} \textheight @minus{} \footskip}, +and then divided by two. @item \topskip +@findex \topskip Minimum distance between the top of the page body and the baseline of the first line of text. For the standard classes, the default is the -same as the font size, e.g., @samp{10pt} at @samp{10pt}. +same as the font size, e.g., @samp{10pt} at a type size of 10pt. @end ftable +@node Floats +@section Floats + +Some typographic elements, such as figures and tables, cannot be broken +across pages. They must be typeset outside of the normal flow of text, +for instance floating to the top of a later page. + +@LaTeX{} can have a number of different classes of floating material. +The default is the two classes, @code{figure} (@pxref{figure}) and +@code{table} (@pxref{table}), but you can create a new class with the +package @file{float}. + +Within any one float class @LaTeX{} always respects the order, so that +the first figure in a document source must be typeset before the second +figure. However, @LaTeX{} may mix the classes, so it can happen that +while the first table appears in the source before the first figure, it +appears in the output after it. + +The placement of floats is subject to parameters, given below, that +limit the number of floats that can appear at the top of a page, and the +bottom, etc. If so many floats are queued up that the limits prevent +them all from fitting on a page then @LaTeX{} places what it can and +defers the rest to the next page. In this way, floats may be typset far +from their place in the source. In particular, a float that is big can +migrate to the end of the document. But then because all floats in a +class must appear in sequential order, every subsequent float in that +class also appears at the end. + +@cindex placement of floats +@cindex specifier, float placement +In addition to changing the parameters, for each float you can tweak +where the float placement algorithm tries to place it by using its +@var{placement} argument. The possible values are a sequence of the +letters below. The default for both @code{figure} and @code{table}, in +both @code{article} and @code{book} classes, is @code{tbp}. + +@table @code +@item t +(Top)---at the top of a text page. + +@item b +(Bottom)---at the bottom of a text page. (However, @code{b} is not +allowed for full-width floats (@code{figure*}) with double-column +output. To ameliorate this, use the @file{stfloats} or +@file{dblfloatfix} package, but see the discussion at caveats in the +FAQ: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat}. + +@item h +(Here)---at the position in the text where the @code{figure} environment +appears. However, @code{h} is not allowed by itself; @code{t} is +automatically added. + +@cindex here, putting floats +@cindex @code{float} package +To absolutely force a float to appear ``here'', you can +@code{\usepackage@{float@}} and use the @code{H} specifier which it +defines. For further discussion, see the FAQ entry at +@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere}. + +@item p +@cindex float page +(Page of floats)---on a separate @dfn{float page}, which is a page +containing no text, only floats. + +@item ! +Used in addition to one of the above; for this float only, @LaTeX{} +ignores the restrictions on both the number of floats that can appear +and the relative amounts of float and non-float text on the page. +The @code{!} specifier does @emph{not} mean ``put the float here''; +see above. + +@end table + +Note: the order in which letters appear in the @var{placement} argument +does not change the order in which @LaTeX{} tries to place the float; +for instance, @code{btp} has the same effect as @code{tbp}. All that +@var{placement} does is that if a letter is not present then the +algorithm does not try that location. Thus, @LaTeX{}'s default of +@code{tbp} is to try every location except placing the float where it +occurs in the source. + +To prevent @LaTeX{} from moving floats to the end of the document or a +chapter you can use a @code{\clearpage} command to start a new page and +insert all pending floats. If a pagebreak is undesirable then you can +use the @file{afterpage} package and issue +@code{\afterpage@{\clearpage@}}. This will wait until the current page +is finished and then flush all outstanding floats. + +@LaTeX{} can typeset a float before where it appears in the source +(although on the same output page) if there is a @code{t} specifier in the +@var{placement} paramater. If this is not desired, and deleting the +@code{t} is not acceptable as it keeps the float from being placed at +the top of the next page, then you can prevent it by either using the +@file{flafter} package or using the command +@findex \suppressfloats +@code{\suppressfloats[t]}, which causes floats for the top position on +this page to moved to the next page. + +Parameters relating to fractions of pages occupied by float and +non-float text (change them with +@code{\renewcommand@{@var{parameter}@}@{@var{decimal between 0 and 1}@}}): + +@ftable @code +@item \bottomfraction +@findex \bottomfraction +The maximum fraction of the page allowed to be occupied by floats at +the bottom; default @samp{.3}. + +@item \floatpagefraction +@findex \floatpagefraction +The minimum fraction of a float page that must be occupied by floats; +default @samp{.5}. + +@item \textfraction +@findex \textfraction +Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is @samp{.2}. + +@item \topfraction +@findex \topfraction +Maximum fraction at the top of a page that may be occupied before +floats; default @samp{.7}. +@end ftable + +Parameters relating to vertical space around floats (change them with +@code{\setlength@{@var{parameter}@}@{@var{length expression}@}}): + +@ftable @code +@item \floatsep +@findex \floatsep +Space between floats at the top or bottom of a page; default +@samp{12pt plus2pt minus2pt}. + +@item \intextsep +@findex \intextsep +Space above and below a float in the middle of the main text; default +@samp{12pt plus2pt minus2pt} for 10 point and 11 point documents, +and @samp{14pt plus4pt minus4pt} for 12 point documents. + +@item \textfloatsep +@findex \textfloatsep +Space between the last (first) float at the top (bottom) of a page; +default @samp{20pt plus2pt minus4pt}. +@end ftable + +Counters relating to the number of floats on a page (change them with +@code{\setcounter@{@var{ctrname}@}@{@var{natural number}@}}): + +@ftable @code +@item bottomnumber +@findex bottomnumber +Maximum number of floats that can appear at the bottom of a text page; +default 1. + +@item dbltopnumber +@findex dbltopnumber +Maximum number of full-sized floats that can appear at the top of a +two-column page; default 2. + +@item topnumber +@findex topnumber +Maximum number of floats that can appear at the top of a text page; +default 2. + +@item totalnumber +@findex totalnumber +Maximum number of floats that can appear on a text page; default 3. +@end ftable + +The principal @TeX{}@tie{}FAQ entry relating to floats +@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats} contains +suggestions for relaxing @LaTeX{}'s default parameters to reduce the +problem of floats being pushed to the end. A full explaination of the +float placement algorithm is Frank Mittelbach's article ``How to +infuence the position of float environments like figure and table in +@LaTeX{}?'' @url{http://latex-project.org/papers/tb111mitt-float.pdf}. + + @node Sectioning @chapter Sectioning -@cindex sectioning + +@cindex sectioning commands Sectioning commands provide the means to structure your text into units: @@ -1221,7 +1796,7 @@ To handle this, the sectioning commands have an optional argument @var{toctitle} that, when given, specifies the text for these other places. -@cindex *-form of sectioning commands +@cindex @code{*}-form of sectioning commands Also, all sectioning commands have @code{*}-forms that print @var{title} as usual, but do not include a number and do not make an entry in the table of contents. For instance: @@ -1260,6 +1835,7 @@ suppresses heading numbers at any depth @math{> @var{level}}, where @node Cross references @chapter Cross references + @cindex cross references One reason for numbering things like figures and equations is to refer @@ -1274,6 +1850,7 @@ the reader to them, as in ``See Figure 3 for more details.'' @node \label @section @code{\label} + @findex \label Synopsis: @@ -1284,15 +1861,35 @@ Synopsis: A @code{\label} command appearing in ordinary text assigns to @var{key} the number of the current sectional unit; one appearing -inside a numbered environment assigns that number to @var{key}. +inside a numbered environment assigns that number to @var{key}. The +assigned number can be retrieved with the @code{\ref@{@var{key}@}} +command (@pxref{\ref}). + +Thus, in the example below the key @code{sec:test} holds the number of +the current section and the key @code{fig:test} that of the figure. +(Incidentally, labels must appear after captions in figures and +tables.) -A @var{key} name can consist of any sequence of letters, digits, or +@example +\section@{section name@} +\label@{sec:test@} +This is Section~\ref@{sec:test@}. +\begin@{figure@} + ... + \caption@{caption text@} + \label@{fig:test@} +\end@{figure@} +See Figure~\ref@{fig:test@}. +@end example + +A key name can consist of any sequence of letters, digits, or common punctuation characters. Upper and lowercase letters are distinguished, as usual. -To avoid accidentally creating two labels with the same name, it is -common to use labels consisting of a prefix and a suffix separated by -a colon or period. Some conventionally-used prefixes: +Although the name can be more or less anything, a common convention is +to use labels consisting of a prefix and a suffix separated by a colon +or period. This helps to avoid accidentally creating two labels with +the same name. Some commonly-used prefixes: @table @code @item ch @@ -1307,12 +1904,13 @@ for tables for equations @end table -Thus, a label for a figure would look like @code{fig:snark} or -@code{fig.snark}. +Thus, a label for a figure would look like @code{fig:test} or +@code{fig.test}. @node \pageref @section @code{\pageref@{@var{key}@}} + @findex \pageref @cindex cross referencing with page number @cindex page number, cross referencing @@ -1330,6 +1928,7 @@ the place in the text where the corresponding @node \ref @section @code{\ref@{@var{key}@}} + @findex \ref @cindex cross referencing, symbolic @cindex section number, cross referencing @@ -1351,8 +1950,8 @@ such as the word `Section' or `Figure', just the bare number itself. @node Environments @chapter Environments -@cindex environments +@cindex environments @findex \begin @findex \end @@ -1366,35 +1965,34 @@ Each environment begins and ends in the same manner: @end example @menu -* abstract:: Produce an abstract. -* array:: Math arrays. -* center:: Centered lines. -* description:: Labelled lists. -* displaymath:: Formulas that appear on their own line. -* document:: Enclose the whole document. -* enumerate:: Numbered lists. -* eqnarray:: Sequences of aligned equations. -* equation:: Displayed equation. -* figure:: Floating figures. -* filecontents:: Writing multiple files from the source. -* flushleft:: Flushed left lines. -* flushright:: Flushed right lines. -* itemize:: Bulleted lists. -* letter:: Letters. -* list:: Generic list environment. -* math:: In-line math. -* minipage:: Miniature page. -* picture:: Picture with text, arrows, lines and circles. -* quotation:: Indented environment with paragraph indentation. -* quote:: Indented environment with no paragraph indentation. -* tabbing:: Align text arbitrarily. -* table:: Floating tables. -* tabular:: Align text in columns. -* thebibliography:: Bibliography or reference list. -* theorem:: Theorems, lemmas, etc. -* titlepage:: For hand crafted title pages. -* verbatim:: Simulating typed input. -* verse:: For poetry and other things. +* abstract:: Produce an abstract. +* array:: Math arrays. +* center:: Centered lines. +* description:: Labelled lists. +* displaymath:: Formulas that appear on their own line. +* document:: Enclose the whole document. +* enumerate:: Numbered lists. +* eqnarray:: Sequences of aligned equations. +* equation:: Displayed equation. +* figure:: Floating figures. +* filecontents:: Writing multiple files from the source. +* flushleft:: Flushed left lines. +* flushright:: Flushed right lines. +* itemize:: Bulleted lists. +* letter:: Letters. +* list:: Generic list environment. +* math:: In-line math. +* minipage:: Miniature page. +* picture:: Picture with text, arrows, lines and circles. +* quotation and quote:: Include a quotation. +* tabbing:: Align text arbitrarily. +* table:: Floating tables. +* tabular:: Align text in columns. +* thebibliography:: Bibliography or reference list. +* theorem:: Theorems, lemmas, etc. +* titlepage:: For hand crafted title pages. +* verbatim:: Simulating typed input. +* verse:: For poetry and other things. @end menu @@ -1405,6 +2003,7 @@ Each environment begins and ends in the same manner: @cindex abstracts Synopsis: + @example \begin@{abstract@} ... @@ -1416,62 +2015,71 @@ Environment for producing an abstract, possibly of multiple paragraphs. @node array @section @code{array} + @findex array @r{environment} @cindex arrays, math Synopsis: @example -\begin@{array@}@{@var{template}@} -@var{col1 text}&@var{col1 text}&@var{coln}@}\\ +\begin@{array@}@{@var{cols}@} +@var{column 1 entry} &@var{column 2 entry} ... &@var{column n entry} \\ ... \end@{array@} @end example -Math arrays are produced with the @code{array} environment, normally -within an @code{equation} environment (@pxref{equation}). It has a -single mandatory @var{template} argument describing the number of -columns and the alignment within them. Each column @var{col} is -specified by a single letter that tells how items in each row of that -column should be formatted, as follows: +or -@table @code -@item c -centered -@item l -flush left -@item r -flush right -@end table +@example +\begin@{array@}[@var{pos}]@{@var{cols}@} +@var{column 1 entry} &@var{column 2 entry} ... &@var{column n entry} \\ +... +\end@{array@} +@end example -@findex \\ @r{(for @code{array})} -Column entries are separated by @code{&}. Column entries may include -other @LaTeX{} commands. Each row of the array is terminated with -@code{\\}. +Produce a mathematical array. This environment can only be used in math +mode, and normally appears within a displayed mathematics environment +such as @code{equation} (@pxref{equation}). Column entries are +separated by an ampersand@tie{}(@code{&}). Rows are terminated with +double-backslashes@tie{}(@code{\\}) (@pxref{\\}). + +The required argument @var{cols} describes the number of columns, their +alignment, and the formatting of the intercolumn regions. See +@ref{tabular} for the complete description of @var{cols}, and of the +other common features of the two environments, including the optional +@var{pos} argument. + +There are two ways that @code{array} diverges from @code{tabular}. The +first is that @code{array} entries are typeset in mathematics mode, in +textstyle (except if the @var{cols} definition specifies the column with +@code{@@p@{..@}}, which causes the entry to be typeset in text mode). +The second is that, instead of @code{tabular}'s parameter +@code{\tabcolsep}, @LaTeX{}'s intercolumn space in an array is governed +by +@findex \arraycolsep +@code{\arraycolsep} which gives half the width between columns. The +default for this is @samp{5pt}. -@findex @@@{...@} -In the template, the construct @code{@@@{@var{text}@}} puts @var{text} -between columns in each row. +To obtain arrays with braces the standard is to use the @file{amsmath} +package. It comes with environments @code{pmatrix} for an array +surrounded by parentheses@tie{}@code{(..)}, @code{bmatrix} for an array +surrounded by square brackets@tie{}@code{[..]}, @code{Bmatrix} for an +array surrounded by curly braces@tie{}@code{@{..@}}, @code{vmatrix} for +an array surrounded by vertical bars@tie{}@code{|..|}, and +@code{Vmatrix} for an array surrounded by double vertical +bars@tie{}@code{||..||}, along with a number of other array constructs. -Here's an example: +Here is an example of an array: @example \begin@{equation@} - \begin@{array@}@{lrc@} - left1 & right1 & centered1 \\ - left2 & right2 & centered2 \\ + \begin@{array@}@{cr@} + \sqrt@{y@} &12.3 \\ + x^2 &3.4 \end@{array@} \end@{equation@} @end example -@findex \arraycolsep -The @code{\arraycolsep} parameter defines half the width of the space -separating columns; the default is @samp{5pt}. @xref{tabular}, for other -parameters which affect formatting in @code{array} environments, -namely @code{\arrayrulewidth} and @code{\arraystretch}. - -The @code{array} environment can only be used in math mode. - @node center @section @code{center} @@ -1483,16 +2091,35 @@ Synopsis: @example \begin@{center@} -@var{line1} \\ -@var{line2} \\ + .. text .. \end@{center@} @end example +Environment to create a sequence of lines that are centered within the +left and right margins on the current page. If the text in the +environment body is too long to fit on a line, @LaTeX{} will insert line +breaks that avoid hyphenation and avoid stretching or shrinking any +interword space. To force a line break at a particular spot use +double-backslash@tie{}@code{\\} (@pxref{\\}). @findex \\ @r{(for @code{center})} -The @code{center} environment allows you to create a paragraph -consisting of lines that are centered within the left and right -margins on the current page. Each line is terminated with the -string @code{\\}. + +This environment inserts space above and below the text body. See +@ref{\centering} to avoid such space, for example inside a @code{figure} +environment. + +In this example, depending on the line width, @LaTeX{} may choose a break +for the part before the double backslash, will center the line or two, +then will break at the double backslash, and will center the ending. + +@example +\begin@{center@} + My father considered that anyone who went to chapel and didn't drink + alcohol was not to be tolerated.\\ + I grew up in that belief. --Richard Burton +\end@{center@} +@end example + +A double backslash after the final line is optional. @menu * \centering:: Declaration form of the @code{center} environment. @@ -1505,28 +2132,38 @@ string @code{\\}. @findex \centering @cindex centering text, declaration for -The @code{\centering} declaration corresponds to the @code{center} -environment. This declaration can be used inside an environment such -as @code{quote} or in a @code{parbox}. Thus, the text of a figure or -table can be centered on the page by putting a @code{\centering} -command at the beginning of the figure or table environment. +Declaration that causes material in its scope to be centered. It is +most often used inside an environment such as @code{figure}, or in a +@code{parbox}. -Unlike the @code{center} environment, the @code{\centering} command -does not start a new paragraph; it simply changes how @LaTeX{} formats -paragraph units. To affect a paragraph unit's format, the scope of -the declaration must contain the blank line or @code{\end} command (of -an environment such as quote) that ends the paragraph unit. +Unlike the @code{center} environment, the @code{\centering} command does +not add vertical space above and below the text. -Here's an example: +It also does not start a new paragraph; it simply changes how @LaTeX{} +formats paragraph units. If @code{ww @{\centering xx \\ yy@} zz} is +surrounded by blank lines then @LaTeX{} will create a paragraph whose +first line @samp{ww xx} is centered and whose second line, not centered, +contains @samp{yy zz}. Usually what is desired is for the scope of the +declaration to contain a blank line or the @code{\end} command of an +environment such as @code{figure} or @code{table} that ends the +paragraph unit. Thus, if @code{@{\centering xx \\ yy\par@} zz} is +surrounded by blank lines then it makes a new paragraph with two +centered lines @samp{xx} and @samp{yy}, followed by a new paragraph with +@samp{zz} that is formatted as usual. See also the following example. + +This example's @code{\centering} causes the graphic to be horizontally +centered. @example -\begin@{quote@} -\centering -first line \\ -second line \\ -\end@{quote@} +\begin@{figure@} + \centering + \includegraphics[width=0.6\textwidth]@{ctan_lion.png@} + \caption@{CTAN Lion@} \label@{fig:CTANLion@} +\end@{figure@} @end example +The scope of the @code{\centering} ends with the @code{\end@{figure@}}. + @node description @section @code{description} @@ -1539,31 +2176,50 @@ Synopsis: @example \begin@{description@} -\item [@var{label1}] @var{item1} -\item [@var{label2}] @var{item2} -... +\item [@var{first label}] text of first item +\item [@var{second label}] text of second item + ... \end@{description@} @end example @findex \item -The @code{description} environment is used to make labelled lists. Each -@var{label} is typeset in bold, flush right. The @var{item} text may -contain multiple paragraphs. +Environment to make a labelled list of items. Each item's @var{label} +is typeset in bold, flush-left. Each item's text may contain multiple +paragraphs. Although the labels on the items are optional there is no +sensible default, so all items should have labels. + +@findex \item +The list consists of at least one item; see@tie{}@ref{\item} (having no +items causes the @LaTeX{} error @samp{Something's wrong--perhaps a +missing \item}). Each item is produced with an @code{\item} command. @cindex bold typewriter, avoiding @cindex typewriter labels in lists -Another variation: since the bold style is applied to the labels, if -you typeset a label in typewriter using @code{\texttt}, you'll get -bold typewriter: @code{\item[\texttt@{bold and typewriter@}]}. This -may be too bold, among other issues. To get just typewriter, use -@code{\tt}, which resets all other style variations: @code{\item[@{\tt -plain typewriter@}]}. +Since the labels are in bold style, if the label text calls for a font +change given in argument style (see @ref{Font styles}) then it will come +out bold. For instance, if the label text calls for typewriter with +@code{\item[\texttt@{label text@}]} then it will appear in bold +typewriter, if that is available. The simplest way to get non-bolded +typewriter is to use declaritive style @code{\item[@{\tt label text@}]}. +Similarly, get normal text use @code{\item[@{\rm label text@}]}. + +For other major @LaTeX{} labelled list environments, see @ref{itemize} +and @ref{enumerate}. For information about customizing list layout, see +@ref{list}; also, the package @file{enumitem} is useful for this. -For details about list spacing, see @ref{itemize}. +This example shows the environment used for a sequence of definitions. + +@example +\begin@{definition@} + \item[lama] A priest. + \item[llama] A beast. +\end@{definition@} +@end example @node displaymath @section @code{displaymath} +@c http://tex.stackexchange.com/questions/40492/what-are-the-differences-between-align-equation-and-displaymath @findex displaymath @r{environment} @@ -1571,23 +2227,46 @@ Synopsis: @example \begin@{displaymath@} -@var{math} + .. math text .. \end@{displaymath@} @end example -@noindent or - +Environment to typeset the math text on its own line, in display style +and centered. To make the text be flush-left use the global option +@code{fleqn}; see @ref{Document class options}. + +@LaTeX{} will not break the math text across lines. + +In the @code{displaymath} environment no equation number is added to the +math text. One way to get an equation number is to use the +@code{equation} environment (@pxref{equation}). + +Note that the @file{amsmath} package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. For example, there are a number of options in that +package for having math text broken across lines. + +The construct @code{\[..math text..\]} is essentially a synonym for +@code{\begin@{displaymath@}..math text..\end@{displaymath@}} but the +latter is easier to work with in the source file; for instance, +searching for a square bracket may get false positives but the word +@code{displaymath} will likely be unique. (The construct @code{$$..math +text..$$} from Plain@tie{}@TeX{} is sometimes mistakenly used as a +synonym for @code{displaymath}. It is not a synonym, because the +@code{displaymath} environment checks that it isn't started in math mode +and that it ends in math mode begun by the matching environment start, +because the @code{displaymath} environment has different vertical +spacing, and because the @code{displaymath} environment honors the +@code{fleqn} option.) + +The output from this example is centered and alone on its line. @example -\[@var{math}\] +\begin@{displaymath@} + \int_1^2 x^2\,dx=7/3 +\end@{displaymath@} @end example - -The @code{displaymath} environment (@code{\[...\]} is a synonym) -typesets the @var{math} text on its own line, centered by default. -The global @code{fleqn} option makes equations flush left; see -@ref{Document class options}. - -No equation number is added to @code{displaymath} text; to get an -equation number, use the @code{equation} environment (@pxref{equation}). +Also, the integral sign is larger than the inline version +@code{\( \int_1^2 x^2\,dx=7/3 \)} produces. @node document @@ -1595,9 +2274,57 @@ equation number, use the @code{equation} environment (@pxref{equation}). @findex document @r{environment} -The @code{document} environment encloses the body of a document. +The @code{document} environment encloses the entire body of a document. It is required in every @LaTeX{} document. @xref{Starting and ending}. +@menu +* \AtBeginDocument:: Hook for commands at the start of the document. +* \AtEndDocument:: Hook for commands at the end of the document. +@end menu + + +@node \AtBeginDocument + +@findex \AtBeginDocument +@cindex beginning of document hook + +Synopsis: + +@example +\AtBeginDocument@{@var{code}@} +@end example + +Save @var{code} and execute it when @code{\begin@{document@}} is +executed, at the very end of the preamble. The code is executed after +the font selection tables have been set up, so the normal font for the +document is the current font. However, the code is executed as part of +the preamble so you cannot do any typesetting with it. + +You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. + + +@node \AtEndDocument + +@findex \AtEndDocument +@cindex end of document hook + +Synopsis: + +@example +\AtEndDocument@{@var{code}@} +@end example + +Save @var{code} and execute it near the end of the document. +Specifically, it is executed when @code{\end@{document@}} is executed, +before the final page is finished and before any leftover floating +environments are processed. If you want some of the code to be executed +after these two processes then include a @code{\clearpage} at the +appropriate point in @var{code}. + +You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. + @node enumerate @section @code{enumerate} @@ -1609,55 +2336,79 @@ Synopsis: @example \begin@{enumerate@} -\item @var{item1} -\item @var{item2} +\item [@var{first label}] text of first item +\item [@var{second label}] text of second item ... \end@{enumerate@} @end example -The @code{enumerate} environment produces a numbered list. Enumerations -can be nested within one another, up to four levels deep. They can also -be nested within other paragraph-making environments, such as -@code{itemize} (@pxref{itemize}) and @code{description} -(@pxref{description}). +Environment to produce a numbered list of items. The format of the +label numbering depends on whether this environment is nested within +another; see below. @findex \item -Each item of an enumerated list begins with an @code{\item} command. -There must be at least one @code{\item} command within the environment. +The list consists of at least one item. Having no items causes the +@LaTeX{} error @samp{Something's wrong--perhaps a missing \item}. Each +item is produced with an @code{\item} command. + +This example lists the top two finishers in the 1908 Olympic marathon. + +@example +\begin@{enumerate@} + \item Johnny Hayes (USA) + \item Charles Hefferon (RSA) +\end@{enumerate@} +@end example -By default, the numbering at each level is done like this: +Enumerations may be nested within a paragraph-making environment, +including @code{itemize} (@pxref{itemize}), @code{description} +(@pxref{description}) and @code{enumeration}, up to four levels deep. +The format of the label produced depends on the place in the nesting. +This gives @LaTeX{}'s default for the format at each nesting level +(where 1 is the outermost level): @enumerate -@item 1., 2., @dots{} -@item (a), (b), @dots{} -@item i., ii., @dots{} -@item A., B., @dots{} +@item arabic number followed by a period: @samp{1.}, @samp{2.},@tie{}@dots{} +@item lower case letter inside parentheses: @samp{(a)}, @samp{(b)}@tie{}@dots{} +@item lower case roman numeral followed by a period: @samp{i.}, @samp{ii.},@tie{}@dots{} +@item upper case letter followed by a period: @samp{A.}, @samp{B.},@tie{}@dots{} @end enumerate @findex \enumi @findex \enumii @findex \enumiii @findex \enumiv -The @code{enumerate} environment uses the counters @code{\enumi} -through @code{\enumiv} counters (@pxref{Counters}). If the optional -argument to @code{\item} is given, the counter is not incremented for -that item. +The @code{enumerate} environment uses the counters @code{\enumi} through +@code{\enumiv} counters (@pxref{Counters}). If you use the optional +argument to @code{\item} then the counter is not incremented for that +item (@pxref{\item}). @findex \labelenumi @findex \labelenumii @findex \labelenumiii @findex \labelenumiv -The @code{enumerate} environment uses the commands @code{\labelenumi} -through @code{\labelenumiv} to produce the default label. So, you can -use @code{\renewcommand} to change the labels (@pxref{\newcommand & -\renewcommand}). For instance, to have the first level use uppercase -letters: +To change the format of the label use @code{\renewcommand} +(@pxref{\newcommand & \renewcommand}) on the commands @code{\labelenumi} +through @code{\labelenumiv}. For instance, this first level list will be +labelled with uppercase letters, in boldface, and without a trailing +period: @findex \Alph @r{example} @example -\renewcommand@{\labelenumi@}@{\Alph@{enumi@}@} +\renewcommand@{\labelenumi@}@{\textbf@{\Alph@{enumi@}@}@} +\begin@{enumerate@} + \item eI + \item bi: + \item si: +\end@{enumerate@} @end example +For a list of counter-labelling commands like @code{\Alph} see +@ref{\alph \Alph \arabic \roman \Roman \fnsymbol}. + +For more on customizing the layout see @ref{list}. Also, the package +@file{enumitem} is useful for this. + @node eqnarray @@ -1670,46 +2421,69 @@ letters: @cindex align @r{environment, from @code{amsmath}} @cindex amsmath @r{package, replacing @code{eqnarray}} @cindex Madsen, Lars -First, a caveat: the @code{eqnarray} environment has some infelicities -which cannot be overcome; the article ``Avoid eqnarray!''@: by Lars -Madsen describes them in detail -(@url{http://tug.org/TUGboat/tb33-1/tb103madsen.pdf}). The bottom -line is that it is better to use the @code{align} environment (and -others) from the @code{amsmath} package. +First, a caveat: the @code{eqnarray} environment is depreciated. It has +infelicities that cannot be overcome, including spacing that is +inconsistent with other mathematics elements (see the article ``Avoid +eqnarray!''@: by Lars Madsen +@url{http://tug.org/TUGboat/tb33-1/tb103madsen.pdf}). New documents +should include the @file{amsmath} package and use the displayed +mathematics environments provided there, such as the @code{align} +environment. -Nevertheless, here is a description of @code{eqnarray}: +Nevertheless, for completeness and for a reference when working with old +documents, a synopsis: @example -\begin@{eqnarray@} @r{(or @code{eqnarray*})} -@var{formula1} \\ -@var{formula2} \\ -... +\begin@{eqnarray@} + @var{first formula left} &@var{first formula middle} &@var{first formula right} \\ + ... \end@{eqnarray@} @end example +or + +@example +\begin@{eqnarray*@} + @var{first formula left} &@var{first formula middle} &@var{first formula right} \\ + ... +\end@{eqnarray*@} +@end example + @findex \\ @r{(for @code{eqnarray})} -The @code{eqnarray} environment is used to display a sequence of -equations or inequalities. It is similar to a three-column -@code{array} environment, with consecutive rows separated by @code{\\} -and consecutive items within a row separated by an @code{&}. +Display a sequence of equations or inequalities. The left and right +sides are typeset in display mode, while the middle is typeset in text +mode. +It is similar to a three-column @code{array} environment, with items +within a row separated by an ampersand@tie{}(@code{&}), and with rows +separated by double backslash@tie{} @code{\\}). @findex \\* @r{(for @code{eqnarray})} -@code{\\*} can also be used to separate equations, with its normal -meaning of not allowing a page break at that line. +The starred form of line break (@code{\\*}) can also be used to separate +equations, and will disallow a page break there (@pxref{\\}). @findex \nonumber @cindex equation numbers, omitting -An equation number is placed on every line unless that line has a -@code{\nonumber} command. Alternatively, The @code{*}-form of the -environment (@code{\begin@{eqnarray*@} ... \end@{eqnarray*@}}) will -omit equation numbering entirely, while otherwise being the same as -@code{eqnarray}. +The unstarred form @code{eqnarray} places an equation number on every +line (using the @code{equation} counter), unless that line contains a +@code{\nonumber} command. The starred form @code{eqnarray*} omits +equation numbering, while otherwise being the same. @findex \lefteqn The command @code{\lefteqn} is used for splitting long formulas across lines. It typesets its argument in display style flush left in a box of zero width. +This example shows three lines. The first two lines make an inequality, +while the third line has not entry on the left side. + +@example +\begin@{eqnarray*@} + \lefteqn@{x_1+x_2+\cdots+x_n@} \\ + &\leq &y_1+y_2+\cdots+y_n \\ + &= &z+y_3+\cdots+y_n +\end@{eqnarray*@} +@end example + @node equation @section @code{equation} @@ -1722,211 +2496,153 @@ Synopsis: @example \begin@{equation@} -@var{math} + math text \end@{equation@} @end example -The @code{equation} environment starts a @code{displaymath} -environment (@pxref{displaymath}), e.g., centering the @var{math} text -on the page, and also places an equation number in the right margin. +Make a @code{displaymath} environment (@pxref{displaymath}) with an +equation number in the right margin. + +The equation number is generated using the @code{equation} counter. + +Note that the @file{amsmath} package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. @node figure @section @code{figure} + @findex figure @cindex inserting figures @cindex figures, inserting +Synopsis: + @example -\begin@{figure[*]@}[@var{placement}] -@var{figbody} +\begin@{figure@}[@var{placement}] + figure body +\caption[@var{loftitle}]@{@var{title}@} \label@{@var{label@}} -\caption[@var{loftitle}]@{@var{text}@} \end@{figure@} @end example -Figures are objects that are not part of the normal text, and are -instead ``floated'' to a convenient place, such as the top of a page. -Figures will not be split between two pages. - -When typesetting in double-columns, the starred form produces a -full-width figure (across both columns). - -@cindex placement of floats -@cindex specifier, float placement -The optional argument @code{[placement]} determines where @LaTeX{} will try -to place your figure. There are four places where @LaTeX{} can possibly -put a float: - -@table @code -@item t -(Top)---at the top of a text page. - -@item b -(Bottom)---at the bottom of a text page. However, @code{b} is not -allowed for full-width floats (@code{figure*}) with double-column -output. To ameliorate this, use the @code{stfloats} or -@code{dblfloatfix} package, but see the discussion at caveats in the -FAQ: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat}. - -@item h -(Here)---at the position in the text where the @code{figure} environment -appears. However, @code{t} is not allowed by itself; @code{t} is -automatically added. - -@cindex here, putting floats -@cindex @code{float} package -To absolutely force a figure to appear ``here'', you can -@code{\usepackage@{float@}} and use the @code{H} specifier which it -defines. For further discussion, see the FAQ entry at -@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere}. +or -@item p -(Page of floats)---on a separate float page, which is a page -containing no text, only floats. +@example +\begin@{figure*@}[@var{placement}] + figure body +\caption[@var{loftitle}]@{@var{title}@} +\label@{@var{label@}} +\end@{figure*@} +@end example -@item ! -Used in addition to one of the above; for this float only, @LaTeX{} -ignores the restrictions on both the number of floats that can appear -and the relative amounts of float and non-float text on the page. -The @code{!} specifier does @emph{not} mean ``put the float here''; -see above. +A class of floats (@pxref{Floats}). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are ``floated'' to a convenient place, such as the top of a following +page. -@end table +For the possible values of @var{placement} and their effect on the +float placement algorithm, see @ref{Floats}. -The standard @code{report} and @code{article} classes use the default placement -@code{tbp}. +The starred form @code{figure*} is used when a document is in +double-column mode (@pxref{\twocolumn}). It produces a figure that +spans both columns, at the top of the page. To add the possibility of +placing at a page bottom see the discussion of @var{placement} @code{b} +in @ref{Floats}. -The body of the figure is made up of whatever text, @LaTeX{} commands, -etc.@: you wish. +The figure body is typeset in a @code{parbox} of width @code{\textwidth} +and so it can contain text, commands, etc. +The label is optional; it is used for cross-references (@pxref{Cross +references}). @findex \caption -The @code{\caption} command specifies caption @var{text} for the -figure. The caption is numbered by default. If @var{loftitle} is -present, it is used in the list of figures instead of @var{text} -(@pxref{Tables of contents}). +The optional @code{\caption} command specifies caption text for the +figure. By default it is numbered. If @var{loftitle} is present, it is +used in the list of figures instead of @var{title} (@pxref{Tables of +contents}). -Parameters relating to fractions of pages occupied by float and -non-float text: - -@ftable @code -@findex \bottomfraction -The maximum fraction of the page allowed to be occupied by floats at -the bottom; default @samp{.3}. - -@item \floatpagefraction -The minimum fraction of a float page that must be occupied by floats; -default @samp{.5}. - -@item \textfraction -Minimum fraction of a page that must be text; if floats take up too -much space to preserve this much text, floats will be moved to a -different page. The default is @samp{.2}. - -@item \topfraction -Maximum fraction at the top of a page that may be occupied before -floats; default @samp{.7}. -@end ftable - -Parameters relating to vertical space around floats: - -@ftable @code -@item \floatsep -Space between floats at the top or bottom of a page; default -@samp{12pt plus2pt minus2pt}. - -@item \intextsep -Space above and below a float in the middle of the main text; default -@samp{12pt plus2pt minus2pt} for @samp{10pt} and @samp{11pt} styles, -@samp{14pt plus4pt minus4pt} for @samp{12pt}. - -@item \textfloatsep -Space between the last (first) float at the top (bottom) of a page; -default @samp{20pt plus2pt minus4pt}. -@end ftable - -Counters relating to the number of floats on a page: +This example makes a figure out of a graphic. It requires one of the +packages @file{graphics} or @file{graphicx}. The graphic, with its +caption, will be placed at the top of a page or, if it is pushed to the +end of the document, on a page of floats. -@ftable @code -@item bottomnumber -Maximum number of floats that can appear at the bottom of a text page; -default 1. - -@item dbltopnumber -Maximum number of full-sized floats that can appear at the top of a -two-column page; default 2. - -@item topnumber -Maximum number of floats that can appear at the top of a text page; -default 2. - -@item totalnumber -Maximum number of floats that can appear on a text page; default 3. -@end ftable - -The principal @TeX{} FAQ entry relating to floats: -@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats}. +@example +\begin@{figure@}[t] + \centering + \includegraphics[width=0.5\textwidth]@{CTANlion.png@} + \caption@{The CTAN lion, by Duane Bibby@} +\end@{figure@} +@end example @node filecontents -@section @code{filecontents}: Create external files +@section @code{filecontents}: Write an external file + @findex filecontents -@cindex external files, creating +@cindex external files, writing @cindex writing external files Synopsis: @example \begin@{filecontents@}@{@var{filename}@} -@var{contents-of-file} + @var{text} \end@{filecontents@} -... -\documentclass@{@var{my-document-class}@} @end example -@cindex initial command -@findex \documentclass, commands before -The @code{filecontents} environment is an @dfn{initial command}, -meaning that it can be used only before the @code{\documentclass} -command, as in the synopsis above. +or -@LaTeX{} will create a file named @var{filename} with the content -@var{contents-of-file} preceded by a header comment indicating how and -when the file was generated. If the file already exists then nothing will -happen. +@example +\begin@{filecontents*@}@{@var{filename}@} + @var{text} +\end@{filecontents*@} +@end example -You can also use the @code{filecontents} package, which has the -following advantages: +Create a file named @var{filename} and fill it with @var{text}. The +unstarred version of the environment @code{filecontents} prefixes the +content of the created file with a header; see the example below. The +starred version @code{filecontents*} does not include the header. -@itemize -@item -If the file already exists, then it will be overwritten. +This environment can be used anywhere in the preamble, although it often +appears before the @code{\documentclass} command. It is typically used +when a source file requires a nonstandard style or class file. The +environment will write that file to the directory containing the source +and thus make the source file self-contained. Another use is to include +@code{bib} references in the file, again to make it self-contained. -@item -You can use the @code{filecontents} environment at any point after the -declaration @code{\usepackage@{filecontents@}}, not just before -@code{\documentclass}. +The environment checks whether a file of that name already exists and if +so, does not do anything. There is a @file{filecontents} package that +redefines the @code{filecontents} environment so that instead of doing +nothing in that case, it will overwrite the existing file. -@item -The @code{filecontents} package also provides a @code{filecontents*} -environment which is used in the same way as the @code{filecontents} -environment except that it won't insert any leading comment, so it is -better suited to create files which aren't in @LaTeX{} format. +For example, this document -@end itemize +@example +\documentclass@{article@} +\begin@{filecontents@}@{JH.sty@} +\newcommand@{\myname@}@{Jim Hef@{@}feron@} +\end@{filecontents@} +\usepackage@{JH@} +\begin@{document@} +Article by \myname. +\end@{document@} +@end example -The @code{filecontents} environment only creates the file, and is -unrelated to using the created file. So you need to use, for -instance, @code{\input} or @code{\usepackage} or @code{\bibliography} -or whatever is applicable, to use the created file. +produces this file @file{JH.sty}. -This environment is also useful to make a document in a self-contained -file, for example, for a bug report, or to keep the content of a -@file{.bib} file in the same file as the main document. +@example +%% LaTeX2e file `JH.sty' +%% generated by the `filecontents' environment +%% from source `test' on 2015/10/12. +%% +\newcommand@{\myname@}@{Jim Hef@{@}feron@} +@end example @node flushleft @section @code{flushleft} + @findex flushleft @r{environment} @cindex left-justifying text, environment for @cindex ragged right text, environment for @@ -1942,7 +2658,7 @@ file, for example, for a bug report, or to keep the content of a @findex \\ @r{for @code{flushleft}} The @code{flushleft} environment allows you to create a paragraph consisting of lines that are flush to the left-hand margin and ragged -right Each line must be terminated with the string @code{\\}. +right. Each line must be terminated with the string @code{\\}. @menu * \raggedright:: Declaration form of the @code{flushleft} environment. @@ -1951,6 +2667,7 @@ right Each line must be terminated with the string @code{\\}. @node \raggedright @subsection @code{\raggedright} + @findex \raggedright @cindex ragged right text @cindex left-justifying text @@ -1969,6 +2686,7 @@ command that ends the paragraph unit. @node flushright @section @code{flushright} + @findex flushright @r{environment} @cindex ragged left text, environment for @cindex right-justifying text, environment for @@ -1984,7 +2702,7 @@ command that ends the paragraph unit. @findex \\ (for @code{flushright}) The @code{flushright} environment allows you to create a paragraph consisting of lines that are flush to the right-hand margin and ragged -left. Each line must be terminated with the string @code{\\}. +left. Each line must be terminated with the control sequence @code{\\}. @menu * \raggedleft:: Declaration form of the @code{flushright} environment. @@ -1993,6 +2711,7 @@ left. Each line must be terminated with the string @code{\\}. @node \raggedleft @subsection @code{\raggedleft} + @findex \raggedleft @cindex ragged left text @cindex justification, ragged left @@ -2011,6 +2730,7 @@ command that ends the paragraph unit. @node itemize @section @code{itemize} + @findex itemize @r{environment} @findex \item @cindex lists of items @@ -2155,13 +2875,15 @@ within a single item (@code{\parskip} is not list-specific, @node letter @section @code{letter} environment: writing letters -@findex letter + +@findex letter @r{environment} This environment is used for creating letters. @xref{Letters}. @node list @section @code{list} + @findex list @cindex lists of items, generic @@ -2189,6 +2911,51 @@ empty, i.e., @code{@{@}}, which leaves the default spacing. The width used for typesetting the list items is specified by @code{\linewidth} (@pxref{Page layout parameters}). +@menu +* \item:: An entry in a list. +@end menu + + +@node \item + +Synopsis: + +@example +\item text of item +@end example + +or +@example +\item[@var{optional label}] text of item +@end example + +An entry in a list. The entries are prefixed by a label, whose default +depends on the list type. + +Because the optional argument @var{optional label} is surrounded by +square brackets@tie{}(@code{[} and @code{]}), to use square brackets +inside the optional argument you must hide them inside curly braces, as +in @code{\item[Close square bracket, @{]@}]}. Similarly, to use an open +square bracket as first character in the text of the item, also hide it +inside curly braces. @xref{@LaTeX{} command syntax}. + +In this example the @code{enumerate} list has two items that use the +default label and one that uses the optional label. + +@example +\begin@{enumerate@} + \item Moe + \item[sometimes] Shemp + \item Larry +\end@{enumerate@} +@end example + +The first item is labelled @samp{1.}, the second item is labelled +@samp{sometimes}, and the third item is labelled @samp{2.} (note that, +because of the optional label in the second item, the third item does +not get a @samp{3.}). + + @node math @section @code{math} @@ -2205,7 +2972,7 @@ Synopsis: @end example The @code{math} environment inserts the given @var{math} within the -running text. @code{\(...\))} and @code{$...$} are synonyms. +running text. @code{\(...\)} and @code{$...$} are synonyms. @xref{Math formulas}. @@ -2257,7 +3024,7 @@ footnotes; they may wind up at the bottom of the wrong minipage. @cindex pictures, creating @example -\begin@{picture@}(width,height)(x offset,y offset) +\begin@{picture@}(@var{width},@var{height})(@var{xoffset},@var{yoffset}) @dots{} @var{picture commands} @dots{} \end@{picture@} @end example @@ -2277,22 +3044,23 @@ You should only change the value of @code{\unitlength}, using the @code{\setlength} command, outside of a @code{picture} environment. The default value is @code{1pt}. -A position is a pair of coordinates, such as @code{(2.4,-5)}, specifying +@cindex position, in picture +A @dfn{position} is a pair of coordinates, such as @code{(2.4,-5)}, specifying the point with x-coordinate @code{2.4} and y-coordinate @code{-5}. Coordinates are specified in the usual way with respect to an origin, which is normally at the lower-left corner of the picture. Note that when a position appears as an argument, it is not enclosed in braces; the parentheses serve to delimit the argument. -The @code{picture} environment has one mandatory argument, which is a -@code{position}. It specifies the size of the picture. The environment -produces a rectangular box with width and height determined by this -argument's x- and y-coordinates. +The @code{picture} environment has one mandatory argument which is a +position (@var{width},@var{height}), which specifies the size of the +picture. The environment produces a rectangular box with these +@var{width} and @var{height}. -The @code{picture} environment also has an optional @code{position} -argument, following the @code{size} argument, that can change the -origin. (Unlike ordinary optional arguments, this argument is not -contained in square brackets.) The optional argument gives the +The @code{picture} environment also has an optional position argument +(@var{xoffset},@var{yoffset}), following the size argument, that can +change the origin. (Unlike ordinary optional arguments, this argument +is not contained in square brackets.) The optional argument gives the coordinates of the point at the lower-left corner of the picture (thereby determining the origin). For example, if @code{\unitlength} has been set to @code{1mm}, the command @@ -2354,9 +3122,11 @@ The @code{picture} commands are described in the following sections. @node \circle @subsection @code{\circle} + @findex \circle Synopsis: + @example \circle[*]@{@var{diameter}@} @end example @@ -2370,9 +3140,11 @@ Circles up to 40@dmn{pt} can be drawn. @node \makebox (picture) @subsection @code{\makebox} + @findex \makebox @r{(for @code{picture})} Synopsis: + @example \makebox(@var{width},@var{height})[@var{position}]@{@var{text}@} @end example @@ -2404,6 +3176,7 @@ Moves the item to the right. @node \framebox (picture) @subsection @code{\framebox} + @findex \framebox Synopsis: @@ -2445,6 +3218,7 @@ multiples of the @var{dlen}. @node \frame @subsection @code{\frame} + @findex \frame Synopsis: @@ -2460,6 +3234,7 @@ space is put between the frame and the object. @node \line @subsection @code{\line} + @findex \line Synopsis: @@ -2481,6 +3256,7 @@ see @code{pict2e} and many other packages on CTAN. @node \linethickness @subsection @code{\linethickness} + @findex \linethickness The @code{\linethickness@{@var{dim}@}} command declares the thickness @@ -2493,6 +3269,7 @@ circles, or the quarter circles drawn by @code{\oval}. @node \thicklines @subsection @code{\thicklines} + @findex \thicklines The @code{\thicklines} command is an alternate line thickness for @@ -2502,6 +3279,7 @@ cf.@tie{}@ref{\linethickness} and @ref{\thinlines}. @node \thinlines @subsection @code{\thinlines} + @findex \thinlines The @code{\thinlines} command is the default line thickness for @@ -2511,9 +3289,11 @@ cf.@tie{}@ref{\linethickness} and @ref{\thicklines}. @node \multiput @subsection @code{\multiput} + @findex \multiput Synopsis: + @example \multiput(@var{x},@var{y})(@var{delta_x},@var{delta_y})@{@var{n}@}@{@var{obj}@} @end example @@ -2526,6 +3306,7 @@ pattern across a picture. @var{obj} is first placed at position @node \oval @subsection @code{\oval} + @findex \oval Synopsis: @@ -2534,21 +3315,24 @@ Synopsis: \oval(@var{width},@var{height})[@var{portion}] @end example -The @code{\oval} command produces a rectangle with rounded corners. -The optional argument @var{portion} allows you to select part of the +The @code{\oval} command produces a rectangle with rounded corners. The +optional argument @var{portion} allows you to produce only half of the oval via the following: @table @code @item t -selects the top portion; +selects the top half; @item b -selects the bottom portion; +selects the bottom half; @item r -selects the right portion; +selects the right half; @item l -selects the left portion. +selects the left half. @end table +It is also possible to produce only one quarter of the oval by setting +@var{portion} to @code{tr}, @code{br}, @code{bl}, or @code{tl}. + The ``corners'' of the oval are made with quarter circles with a maximum radius of 20@dmn{pt}, so large ``ovals'' will look more like boxes with rounded corners. @@ -2556,6 +3340,7 @@ boxes with rounded corners. @node \put @subsection @code{\put} + @findex \put Synopsis: @@ -2571,6 +3356,7 @@ The @code{\put} command places the material specified by the @node \shortstack @subsection @code{\shortstack} + @findex \shortstack Synopsis: @@ -2597,6 +3383,7 @@ Objects are separated with @code{\\}. @node \vector @subsection @code{\vector} + @findex \vector Synopsis: @@ -2610,13 +3397,17 @@ length and slope. The @math{@var{xslope}} and @math{@var{yslope}} values must lie between @minus{}4 and +4, inclusive. -@node quotation -@section @code{quotation} +@node quotation and quote +@section @code{quotation} and @code{quote} @findex quotation @cindex quoted text with paragraph indentation, displaying @cindex displaying quoted text with paragraph indentation @cindex paragraph indentations in quoted text +@findex quote +@cindex quoted text without paragraph indentation, displaying +@cindex displaying quoted text without paragraph indentation +@cindex paragraph indentations in quoted text, omitting Synopsis: @@ -2626,23 +3417,7 @@ Synopsis: \end@{quotation@} @end example -The margins of the @code{quotation} environment are indented on both -the left and the right. The text is justified at both margins. -Leaving a blank line between text produces a new paragraph. - -Unlike the @code{quote} environment, each paragraph is indented -normally. - - -@node quote -@section @code{quote} - -@findex quote -@cindex quoted text without paragraph indentation, displaying -@cindex displaying quoted text without paragraph indentation -@cindex paragraph indentations in quoted text, omitting - -Synopsis: +or @example \begin@{quote@} @@ -2650,11 +3425,29 @@ Synopsis: \end@{quote@} @end example -The margins of the @code{quote} environment are indented on both the -left and the right. The text is justified at both margins. Leaving a -blank line between text produces a new paragraph. +Include a quotation. + +In both environments, margins are indented on both sides by +@code{\leftmargin} and the text is justified at both. As with the main +text, leaving a blank line produces a new paragraph. + +To compare the two: in the @code{quotation} environment, paragraphs are +indented by 1.5@dmn{em} and the space between paragraphs is small, +@code{0pt plus 1pt}. In the @code{quote} environment, paragraphs are +not indented and there is vertical space between paragraphs (it is the +rubber length @code{\parsep}). Thus, the @code{quotation} environment +may be more suitable for documents where new paragraphs are marked by an +indent rather than by a vertical separation. In addition, @code{quote} +may be more suitable for a short quotation or a sequence of short +quotations. -Unlike the @code{quotation} environment, paragraphs are not indented. +@example +\begin@{quotation@} +\it Four score and seven years ago + .. shall not perish from the earth. +\hspace@{1em plus 1fill@}---Abraham Lincoln +\end@{quotation@} +@end example @node tabbing @@ -2712,7 +3505,7 @@ necessary. @item \' @r{(tabbing)} Moves everything that you have typed so far in the -current column, i.e. everything from the most recent @code{\>}, +current column, i.e., everything from the most recent @code{\>}, @code{\<}, @code{\'}, @code{\\}, or @code{\kill} command, to the right of the previous column, flush against the current column's tab stop. @@ -2777,32 +3570,52 @@ function \= fact(n : integer) : integer;\\ Synopsis: @example - \begin@{table@}[placement] +\begin@{table@}[@var{placement}] + table body +\caption[@var{loftitle}]@{@var{title}@} +\label@{@var{label@}} +\end@{table@} +@end example - body of the table +A class of floats (@pxref{Floats}). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are ``floated'' to a convenient place, such as the top of a following +page. - \caption@{table title@} - \end@{table@} -@end example +For the possible values of @var{placement} and their effect on the +float placement algorithm, see @ref{Floats}. -Tables are objects that are not part of the normal text, and are -usually ``floated'' to a convenient place, like the top of a page. -Tables will not be split between two pages. +The table body is typeset in a @code{parbox} of width @code{\textwidth} +and so it can contain text, commands, etc. -The optional argument @code{[placement]} determines where @LaTeX{} will try -to place your table. There are four places where @LaTeX{} can possibly put -a float; these are the same as that used with the @code{figure} -environment, and described there (@pxref{figure}). +The label is optional; it is used for cross-references (@pxref{Cross +references}). +@findex \caption +The optional @code{\caption} command specifies caption text for the +table. By default it is numbered. If @var{lottitle} is present, it is +used in the list of tables instead of @var{title} (@pxref{Tables of +contents}). -The standard @code{report} and @code{article} classes use the default -placement @code{[tbp]}. +In this example the table and caption will float to the bottom of a page, +unless it is pushed to a float page at the end. -The body of the table is made up of whatever text, @LaTeX{} commands, etc., -you wish. The @code{\caption} command allows you to title your table. +@example +\begin@{table@}[b] + \centering + \begin@{tabular@}@{r|p@{2in@}@} \hline + One &The loneliest number \\ + Two &Can be as sad as one. + It's the loneliest number since the number one. + \end@{tabular@} + \caption@{Cardinal virtues@} + \label@{tab:CardinalVirtues@} +\end@{table@} +@end example @node tabular @section @code{tabular} + @findex tabular @r{environment} @cindex lines in tables @cindex lining text up in tables @@ -2810,9 +3623,9 @@ you wish. The @code{\caption} command allows you to title your table. Synopsis: @example -\begin@{tabular@}[pos]@{cols@} -column 1 entry & column 2 entry ... & column n entry \\ -... +\begin@{tabular@}[@var{pos}]@{@var{cols}@} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end@{tabular@} @end example @@ -2820,44 +3633,61 @@ column 1 entry & column 2 entry ... & column n entry \\ or @example -\begin@{tabular*@}@{width@}[pos]@{cols@} -column 1 entry & column 2 entry ... & column n entry \\ -... +\begin@{tabular*@}@{@var{width}@}[@var{pos}]@{@var{cols}@} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end@{tabular*@} @end example -These environments produce a box consisting of a sequence of rows of -items, aligned vertically in columns. +These environments produce a table, a box consisting of a sequence of +horizontal rows. Each row consists of items that are aligned vertically +in columns. This illustrates many of the features. +@example +\begin@{tabular@}@{l|l@} + \textit@{Player name@} &\textit@{Career home runs@} \\ + \hline + Hank Aaron &755 \\ + Babe Ruth &714 +\end@{tabular@} +@end example + +The vertical format of two left-aligned columns, with a vertical bar +between them, is specified in @code{tabular}'s argument @code{@{l|l@}}. +@findex & +Columns are separated with an ampersand @code{&}. A horizontal rule +between two rows is created with @code{\hline}. @findex \\ @r{for @code{tabular}} -@code{\\} must be used to specify the end of each row of the table, -except for the last, where it is optional---unless an @code{\hline} -command (to put a rule below the table) follows. +The end of each row is marked with a double backslash@tie{}@code{\\}. +This @code{\\} is optional after the last row unless an @code{\hline} +command follows, to put a rule below the table. -The mandatory and optional arguments consist of: +The required and optional arguments to @code{tabular} consist of: -@table @code +@table @var @item width -Specifies the width of the @code{tabular*} environment. There must be -rubber space between columns that can stretch to fill out the specified -width. +Required for @code{tabular*}, not allowed for @code{tabular}. Specifies +the width of the @code{tabular*} environment. The space between columns +should be rubber, as with @code{@@@{\extracolsep@{\fill@}@}}, to allow +the table to stretch or shrink to make the specified width, or else you +are likely to get the @code{Underfull \hbox (badness 10000) in alignment +..} warning. @item pos -Specifies the vertical position; default is alignment on the centre of -the environment. +Optional. Specifies the table's vertical position. The default is to +align the table so its vertical center matches the baseline of the +surrounding text. There are two other possible alignments: @code{t} +aligns the table so its top row matches the baseline of the surrounding +text, and @code{b} aligns on the bottom row. -@table @code -@item t -align on top row - -@item b -align on bottom row -@end table +This only has an effect if there is other text. In the common case of a +@code{tabular} alone in a @code{center} environment this option makes +no difference. @item cols -Specifies the column formatting. It consists of a sequence of the -following specifiers, corresponding to the sequence of columns and -intercolumn material. +Required. Specifies the formatting of columns. It consists of a +sequence of the following specifiers, corresponding to the types of +column and intercolumn material. @table @code @item l @@ -2872,46 +3702,88 @@ A column of centered items. @item | A vertical line the full height and depth of the environment. -@item @@@{@var{text}@} -This inserts @var{text} in every row. An @@-expression suppresses the -intercolumn space normally inserted between columns; any desired space -before the adjacent item must be included in @var{text}. +@item @@@{@var{text or space}@} +This inserts @var{text or space} at this location in every row. The +@var{text or space} material is typeset in LR mode. This text is +fragile (@pxref{\protect}). -To insert commands that are automatically executed before a given -column, you have to load the @code{array} package and use the -@code{>@{...@}} specifier. -@c xx should fully explain array, tabularx, and all other base packages... +This specifier is optional: unless you put in your own @@-expression +then @LaTeX{}'s book, article, and report classes will put on either +side of each column a space of length @code{\tabcolsep}, which by +default is @samp{6pt}. That is, by default adjacent columns are +separated by 12pt (so @code{\tabcolsep} is misleadingly-named since it +is not the separation between tabular columns). Also by default a space +of 6pt comes before the first column as well as after the final column, +unless you put a @code{@@@{..@}} or @code{|} there. + +If you override the default and use an @@-expression then you must +insert any desired space yourself, as in @code{@@@{\hspace@{1em@}@}}. + +An empty expression @code{@@@{@}} will eliminate the space, including +the space at the start or end, as in the example below where the tabular +lines need to lie on the left margin. + +@example +\begin@{flushleft@} + \begin@{tabular@}@{@@@{@}l@} + .. + \end@{tabular@} +\end@{flushleft@} +@end example + +This example shows text, a decimal point, between the columns, arranged +so the numbers in the table are aligned on that decimal point. + +@example +\begin@{tabular@}@{r@@@{$.$@}l@} + $3$ &$14$ \\ + $9$ &$80665$ +\end@{tabular@} +@end example @findex \extracolsep -An @code{\extracolsep@{wd@}} command in an @@-expression causes an -extra space of width @code{wd} to appear to the left of all subsequent +An @code{\extracolsep@{@var{wd}@}} command in an @@-expression causes an +extra space of width @var{wd} to appear to the left of all subsequent columns, until countermanded by another @code{\extracolsep} command. -Unlike ordinary intercolumn space, this extra space is not suppressed -by an @@-expression. An @code{\extracolsep} command can be used only -in an @@-expression in the @code{cols} argument. +Unlike ordinary intercolumn space, this extra space is not suppressed by +an @@-expression. An @code{\extracolsep} command can be used only in an +@@-expression in the @code{cols} argument. Below, @LaTeX{} inserts the +right amount of intercolumn space to make the entire table 4 inches +wide. + +@example +\begin@{center@} + \begin@{tabular*@}@{4in@}@{l@@@{\ \ldots\extracolsep@{\fill@}@}l@} + Seven times down, eight times up + &such is life! + \end@{tabular*@} +\end@{center@} +@end example + +To insert commands that are automatically executed before a given +column, load the @code{array} package and use the @code{>@{...@}} +specifier. +@c xx should fully explain array, tabularx, and all other base packages... @item p@{@var{wd}@} -Produces a column with each item typeset in a parbox of width -@var{wd}, as if it were the argument of a -@code{\parbox[t]@{@var{wd}@}} command. However, a @code{\\} may not -appear in the item, except in the following situations: +Each item in the column is typeset in a parbox of width @var{wd}. -@enumerate -@item -inside an environment like @code{minipage}, @code{array}, or @code{tabular}. -@item -inside an explicit @code{\parbox}. -@item -in the scope of a @code{\centering}, @code{\raggedright}, or @code{\raggedleft} -declaration. The latter declarations must appear inside braces or an -environment when used in a @code{p}-column element. -@end enumerate +Note that a line break double backslash @code{\\} may not appear in the +item, except inside an environment like @code{minipage}, @code{array}, +or @code{tabular}, or inside an explicit @code{\parbox}, or in the scope +of a @code{\centering}, @code{\raggedright}, or @code{\raggedleft} +declaration (when used in a @code{p}-column element these declarations +must appear inside braces, as with @code{@{\centering .. \\ +..@}}). Otherwise @LaTeX{} will misinterpret the double backslash as +ending the row. @item *@{@var{num}@}@{@var{cols}@} Equivalent to @var{num} copies of @var{cols}, where @var{num} is a -positive integer and @var{cols} is any list of column-specifiers, -which may contain another @code{*-expression}. - +positive integer and @var{cols} is a list of specifiers. Thus +@code{\begin@{tabular@}@{|*@{3@}@{l|r@}|@}} is equivalent to +@code{\begin@{tabular@}@{|l|rl|rl|r|@}}. Note that @var{cols} may +contain another @code{*-expression}. + @end table @end table @@ -2920,65 +3792,168 @@ Parameters that control formatting: @ftable @code @item \arrayrulewidth -Thickness of the rule created by @code{|}, @code{\hline}, and -@code{\vline} in the @code{tabular} and @code{array} environments; the -default is @samp{.4pt}. +A length that is the thickness of the rule created by @code{|}, +@code{\hline}, and @code{\vline} in the @code{tabular} and @code{array} +environments. The default is @samp{.4pt}. Change it as in +@code{\setlength@{\arrayrulewidth@}@{0.8pt@}}. @item \arraystretch -Scaling of spacing between rows in the @code{tabular} and @code{array} -environments; default is @samp{1}, for no scaling. +A factor by which the spacing between rows in the @code{tabular} and +@code{array} environments is multiplied. The default is @samp{1}, for +no scaling. Change it as @code{\renewcommand@{\arraystretch@}@{1.2@}}. @item \doublerulesep -Horizontal distance between the vertical rules produced by @code{||} -in the @code{tabular} and @code{array} environments; default is @samp{2pt}. +A length that is the distance between the vertical rules produced by the +@code{||} specifier. The default is @samp{2pt}. @item \tabcolsep -Half the width of the space between columns; default is @samp{6pt}. +A length that is half of the space between columns. The default is +@samp{6pt}. Change it with @code{\setlength}. @end ftable -The following commands can be used inside a @code{tabular} -environment: +The following commands can be used inside the body of a @code{tabular} +environment, the first two inside an entry and the second two between +lines: @menu * \multicolumn:: Make an item spanning several columns. +* \vline:: Draw a vertical line. * \cline:: Draw a horizontal line spanning some columns. * \hline:: Draw a horizontal line spanning all columns. -* \vline:: Draw a vertical line. @end menu @node \multicolumn @subsection @code{\multicolumn} + @findex \multicolumn Synopsis: + @example -\multicolumn@{@var{cols}@}@{@var{pos}@}@{@var{text}@} +\multicolumn@{@var{numcols}@}@{@var{cols}@}@{@var{text}@} @end example -The @code{\multicolumn} command makes an entry that spans several -columns. The first mandatory argument, @var{cols}, specifies the -number of columns to span. The second mandatory argument, @var{pos}, -specifies the formatting of the entry; @code{c} for centered, @code{l} -for flushleft, @code{r} for flushright. The third mandatory argument, -@var{text}, specifies what text to put in the entry. +Make an @code{array} or @code{tabular} entry that spans several columns. +The first argument @var{numcols} gives the number of columns to span. +The second argument @var{cols} specifies the formatting of the entry, +with @code{c} for centered, @code{l} for flush left, or @code{r} for +flush right. The third argument @var{text} gives the contents of that +entry. -Here's an example showing two columns separated by an en-dash; -@code{\multicolumn} is used for the heading: +In this example, in the first row, the second and third columns are +spanned by the single heading @samp{Name}. @example -\begin@{tabular@}@{r@@@{--@}l@} -\multicolumn@{2@}@{c@}@{\bf Unicode@}\cr - 0x80&0x7FF \cr - 0x800&0xFFFF \cr -0x10000&0x1FFFF \cr +\begin@{tabular@}@{lccl@} + \textit@{ID@} &\multicolumn@{2@}@{c@}@{\textit@{Name@}@} &\textit@{Age@} \\ \hline % row one + 978-0-393-03701-2 &O'Brian &Patrick &55 \\ % row two + .. +\end@{tabular@} +@end example + +What counts as a column is:@tie{}the column format specifier for the +@code{array} or @code{tabular} environment is broken into parts, where +each part (except the first) begins with @code{l}, @code{c}, @code{r}, +or@tie{}@code{p}. So from @code{\begin@{tabular@}@{|r|ccp@{1.5in@}|@}} +the parts are @code{|r|}, @code{c}, @code{c}, +and@tie{}@code{p@{1.5in@}|}. + +The @var{cols} argument overrides the @code{array} or @code{tabular} +environment's intercolumn area default adjoining this multicolumn +entry. To affect that area, this argument can contain vertical bars +@code{|} indicating the placement of vertical rules, and @code{@@@{..@}} +expressions. Thus if @var{cols} is @samp{|c|} then this multicolumn +entry will be centered and a vertical rule will come in the intercolumn +area before it and after it. This table details the exact behavior. + +@example +\begin@{tabular@}@{|cc|c|c|@} + \multicolumn@{1@}@{r@}@{w@} % entry one + &\multicolumn@{1@}@{|r|@}@{x@} % entry two + &\multicolumn@{1@}@{|r@}@{y@} % entry three + &z % entry four +\end@{tabular@} +@end example +Before the first entry the output will not have a vertical rule because +the @code{\multicolumn} has the @var{cols} specifier @samp{r} with no +initial vertical bar. Between entry one and entry two there will be a +vertical rule; although the first @var{cols} does not have an ending +vertical bar, the second @var{cols} does have a starting one. Between +entry two and entry three there is a single vertical rule; despite that +the @var{cols} in both of the surrounding @code{multicolumn}'s call for +a vertical rule, you only get one rule. Between entry three and entry +four there is no vertical rule; the default calls for one but the +@var{cols} in the entry three @code{\multicolumn} leaves it out, and +that takes precedence. Finally, following entry four there is a +vertical rule because of the default. + +The number of spanned columns @var{numcols} can be 1. Besides giving +the ability to change the horizontal alignment, this also is useful to +override for one row the @code{tabular} definition's default intercolumn +area specification, including the placement of vertical rules. + +In the example below, in the @code{tabular} definition the first column +is specified to default to left justified but in the first row the entry +is centered with @code{\multicolumn@{1@}@{c@}@{\textsc@{Period@}@}}. +Also in the first row, the second and third columns are spanned by a +single entry with @code{\multicolumn@{2@}@{c@}@{\textsc@{Span@}@}}, +overriding the specification to center those two columns on the page +range en-dash. + +@example +\begin@{tabular@}@{l|r@@@{--@}l@} + \multicolumn@{1@}@{c@}@{\textsc@{Period@}@} + &multicolumn@{2@}@{c@}@{\textsc@{Span@}@} \\ \hline + Baroque &1600 &1760 \\ + Classical &1730 &1820 \\ + Romantic &1780 &1910 \\ + Impressionistic &1875 &1925 +\end@{tabular@} +@end example + +Note that although the @code{tabular} specification by default puts a +vertical rule between the first and second columns, because there is no +vertical bar in the @var{cols} of either of the first row's +@code{\multicolumn} commands, no rule appears in the first row. + + +@node \vline +@subsection @code{\vline} + +@findex \vline + +Draw a vertical line in a @code{tabular} or @code{array} environment +extending the full height and depth of an entry's row. Can also be used +in an @@-expression, although its synonym vertical bar@tie{}@code{|} is +more common. This command is rarely used; typically a table's vertical +lines are specified in @code{tabular}'s @var{cols} argument and +overriden as needed with @code{\multicolumn}. + +This example illustrates some pitfalls. In the first line's second +entry the @code{\hfill} moves the @code{\vline} to the left edge of the +cell. But that is different than putting it halfway between the two +columns, so in that row between the first and second columns there are +two vertical rules, with the one from the @code{@{c|cc@}} specifier +coming before the one produced by the @code{\vline\hfill}. In contrast, +the first line's third entry shows the usual way to put a vertical bar +between two columns. In the second line, the @code{ghi} is the widest +entry in its column so in the @code{\vline\hfill} the @code{\hfill} has +no effect and the vertical line in that entry appears immediately next +to the @code{g}, with no whitespace. + +@example +\begin@{tabular@}@{c|cc@} + x &\vline\hfill y &\multicolumn@{1@}@{|r@}@{z@} \\ + abc &def &\vline\hfill ghi \end@{tabular@} @end example @node \cline @subsection @code{\cline} + @findex \cline Synopsis: @@ -2987,35 +3962,51 @@ Synopsis: \cline@{@var{i}-@var{j}@} @end example -The @code{\cline} command draws horizontal lines across the columns -specified, beginning in column @var{i} and ending in column @var{j}, -which are specified in the mandatory argument. +Draw a horizontal rule in an @code{array} or @code{tabular} environment +beginning in column @var{i} and ending in column @var{j}. The +dash@tie{}@code{-} must appear in the mandatory argument. To span a +single column use the number twice. + +This example puts two horizontal lines between the first and second +rows, one line in the first column only, and the other spanning the +third and fourth columns. The two lines are side-by-side, at the same +height. + +@example +\begin@{tabular@}@{llrr@} + a &b &c &d \\ \cline@{1-1@} \cline@{3-4@} + e &f &g &h +\end@{tabular@} +@end example @node \hline @subsection @code{\hline} -@findex \hline -The @code{\hline} command draws a horizontal line the width of the -enclosing @code{tabular} or @code{array} environment. It's most -commonly used to draw a line at the top, bottom, and between the rows -of a table. +@findex \hline +Draws a horizontal line the width of the enclosing @code{tabular} or +@code{array} environment. It's most commonly used to draw a line at the +top, bottom, and between the rows of a table. -@node \vline -@subsection @code{\vline} -@findex \vline +In this example the top of the table has two horizontal rules, one above +the other, that span both columns. The bottom of the table has a single +rule spanning both columns. Because of the @code{\hline}, the +@code{tabular} second row's line ending double backslash@tie{}@code{\\} +is required. -The @code{\vline} command will draw a vertical line extending the full -height and depth of its row. An @code{\hfill} command can be used to -move the line to the edge of the column. It can also be used in an -@@-expression. +@example +\begin@{tabular@}@{ll@} \hline\hline + Baseball &Red Sox \\ + Basketball &Celtics \\ \hline +\end@{tabular@} +@end example @node thebibliography @section @code{thebibliography} -@findex thebibliography +@findex thebibliography @r{environment} @cindex bibliography, creating (manually) Synopsis: @@ -3059,6 +4050,7 @@ less than 10 references, @code{99} for ones with less than 100, etc. @findex \bibitem Synopsis: + @example \bibitem[@var{label}]@{@var{cite_key}@} @end example @@ -3085,7 +4077,7 @@ associated label. Synopsis: @example -\cite[@var{subcite}]@{@var{keys} +\cite[@var{subcite}]@{@var{keys}@} @end example The @var{keys} argument is a list of one or more citation keys, @@ -3100,12 +4092,13 @@ citation. For example, @code{\cite[p.~314]@{knuth@}} might produce @node \nocite @subsection @code{\nocite} + @findex \nocite -@code{\nocite@{key_list@}} +@code{\nocite@{@var{keys}@}} -The @code{\nocite} command produces no text, but writes @code{key_list}, -which is a list of one or more citation keys, on the @file{.aux} file. +The @code{\nocite} command produces no text, but writes @var{keys}, +which is a list of one or more citation keys, to the @file{.aux} file. @node Using BibTeX @@ -3287,6 +4280,7 @@ stanzas. @node Line breaking @chapter Line breaking + @cindex line breaking @cindex breaking lines @@ -3295,9 +4289,8 @@ translate your input file into a sequence of glyphs and spaces. To produce a printed document, this sequence must be broken into lines (and these lines must be broken into pages). -@LaTeX{} usually does the line (and page) breaking for you, but in -some environments, you do the line breaking yourself with the -@code{\\} command, and you can always manually force breaks. +@LaTeX{} usually does the line (and page) breaking in the text body for +you but in some environments you manually force line breaks. @menu * \\:: Start a new line. @@ -3312,22 +4305,51 @@ some environments, you do the line breaking yourself with the @node \\ -@section @code{\\}[*][@var{morespace}] +@section @code{\\} + @findex \\ @r{force line break} @cindex new line, starting @cindex line break, forcing -The @code{\\} command tells @LaTeX{} to start a new line. It has an -optional argument, @var{morespace}, that specifies how much extra -vertical space is to be inserted before the next line. This can be a -negative amount. +Synopsis: -The @code{\\*} command is the same as the ordinary @code{\\} command -except that it tells @LaTeX{} not to start a new page after the line. +@example +\\[@var{morespace}] +@end example + +or + +@example +\\*[@var{morespace}] +@end example + +Start a new line. The optional argument @var{morespace} specifies extra +vertical space to be insert before the next line. This can be a +negative length. The text before the break is set at its normal length, +that is, it is not stretched to fill out the line width. + +Explicit line breaks in the text body are unusual in @LaTeX{}. In +particular, to start a new paragraph instead leave a blank line. This +command is mostly used outside of the main flow of text such as in +a @code{tabular} or @code{array} environment. + +Under ordinary circumstances (e.g., outside of a @code{p@{..@}} column +in a @code{tabular} environment) the @code{\newline} command is a synonym for +@code{\\} (@pxref{\newline}). + +In addition to starting a new line, the starred form @code{\\*} tells +@LaTeX{} not to start a new page between the two lines, by issuing a +@code{\nobreak}. + +@example +\title@{My story: \\[0.25in] + a tale of woe@} +@end example @node \obeycr & \restorecr @section @code{\obeycr} & @code{\restorecr} + @findex \obeycr @findex \restorecr @cindex new line, output as input @@ -3342,16 +4364,34 @@ in the output. @node \newline @section @code{\newline} + @findex \newline @cindex new line, starting (paragraph mode) -The @code{\newline} command breaks the line at the present point, with -no stretching of the text before it. It can only be used in paragraph -mode. +In ordinary text this is equivalent to double-backslash (@pxref{\\}); it +breaks a line, with no stretching of the text before it. + +Inside a @code{tabular} or @code{array} environment, in a column with a +specifier producing a paragraph box, like typically @code{p@{..@}}, +@code{\newline} will insert a line break inside of the column, that is, +it does not break the entire row. To break the entire row use @code{\\} +or its equivalent @code{\tabularnewline}. + +This will print @samp{Name:} and @samp{Address:} as two lines in a +single cell of the table. + +@example +\begin@{tabular@}@{p@{1in@}@{\hspace@{2in@}@}p@{1in@}@} + Name: \newline Address: &Date: \\ \hline +\end@{tabular@} +@end example + +The @samp{Date:} will be baseline-aligned with @samp{Name:}. @node \- (hyphenation) @section @code{\-} (discretionary hyphen) + @findex \- @r{(hyphenation)} @cindex hyphenation, forcing @@ -3366,9 +4406,9 @@ hyphenated at those points and not at any of the hyphenation points that @LaTeX{} might otherwise have chosen. - @node \fussy @section @code{\fussy} + @findex \fussy The declaration @code{\fussy} (which is the default) makes @TeX{} @@ -3382,6 +4422,8 @@ This command cancels the effect of a previous @code{\sloppy} command @node \sloppy @section @code{\sloppy} +@findex \sloppy + The declaration @code{\sloppy} makes @TeX{} less fussy about line breaking. This will avoid overfull boxes, at the cost of loose interword spacing. @@ -3391,6 +4433,7 @@ Lasts until a @code{\fussy} command is issued (@pxref{\fussy}). @node \hyphenation @section @code{\hyphenation} + @findex \hyphenation @cindex hyphenation, defining @@ -3414,6 +4457,7 @@ misses the hyphenations in these words): @node \linebreak & \nolinebreak @section @code{\linebreak} & @code{\nolinebreak} + @findex \linebreak @findex \nolinebreak @cindex line breaks, forcing @@ -3438,6 +4482,7 @@ from a demand to a request. The @var{priority} must be a number from @node Page breaking @chapter Page breaking + @cindex page breaking @cindex breaking pages @@ -3461,33 +4506,38 @@ but sometimes you may want to influence the breaks. @cindex starting on a right-hand page The @code{\cleardoublepage} command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. -In a two-sided printing style, it also makes the next page a right-hand -(odd-numbered) page, producing a blank page if necessary. +the pending floating figures and tables that have so far appeared in the +input to be printed. In a two-sided printing style, it also makes the +next page a right-hand (odd-numbered) page, producing a blank page if +necessary. @node \clearpage @section @code{\clearpage} + @findex \clearpage @cindex flushing floats and starting a page @cindex starting a new page and clearing floats -The @code{\clearpage} command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. +The @code{\clearpage} command ends the current page and causes all the +pending floating figures and tables that have so far appeared in the +input to be printed. @node \newpage @section @code{\newpage} + @findex \newpage @cindex new page, starting @cindex starting a new page The @code{\newpage} command ends the current page, but does not clear -floats (see @code{\clearpage} above). +floats (@pxref{\clearpage}). @node \enlargethispage @section @code{\enlargethispage} + @findex \enlargethispage @cindex enlarge current page @@ -3496,7 +4546,7 @@ floats (see @code{\clearpage} above). @code{\enlargethispage*@{size@}} Enlarge the @code{\textheight} for the current page by the specified -amount; e.g. @code{\enlargethispage@{\baselineskip@}} will allow one +amount; e.g., @code{\enlargethispage@{\baselineskip@}} will allow one additional line. The starred form tries to squeeze the material together on the page as @@ -3506,6 +4556,7 @@ much as possible. This is normally used together with an explicit @node \pagebreak & \nopagebreak @section @code{\pagebreak} & @code{\nopagebreak} + @findex \pagebreak @findex \nopagebreak @cindex page break, forcing @@ -3531,24 +4582,42 @@ insistent the request is. @node Footnotes @chapter Footnotes + @cindex footnotes, creating -Footnotes can be produced in one of two ways. They can be produced -with one command, the @code{\footnote} command. They can also be -produced with two commands, the @code{\footnotemark} and the -@code{\footnotetext} commands. +Place a numbered footnote at the bottom of the current page, as here. + +@example +No@"{e}l Coward quipped that having to read a footnote is like having +to go downstairs to answer the door, while in the midst of making +love.\footnote@{I wouldn't know, I don't read footnotes.@} +@end example + +You can place multiple footnotes on a page. If the text becomes too long +it will flow to the next page. + +You can also produce footnotes by combining the @code{\footnotemark} and +the @code{\footnotetext} commands, which is useful in special +circumstances. + +To make bibliographic references come out as footnotes you need to +include a bibliographic style with that behavior. @menu -* \footnote:: Insert a footnote. -* \footnotemark:: Insert footnote mark only. -* \footnotetext:: Insert footnote text only. -* Symbolic footnotes:: Using symbols instead of numbers for footnotes. -* Footnote parameters:: Parameters for footnote formatting. +* \footnote:: Insert a footnote. +* \footnotemark:: Insert footnote mark only. +* \footnotetext:: Insert footnote text only. +* Footnotes in a table:: Table footnotes. +* Footnotes in section headings:: Chapter or section titles. +* Footnotes of footnotes:: Multiple classes of footnotes. +* Multiple reference to footnotes:: Referring to a footnote more than once. +* Footnote parameters:: Parameters for footnote formatting. @end menu @node \footnote @section @code{\footnote} + @findex \footnote Synopsis: @@ -3557,71 +4626,230 @@ Synopsis: \footnote[@var{number}]@{@var{text}@} @end example -The @code{\footnote} command places the numbered footnote @var{text} -at the bottom of the current page. The optional argument @var{number} -changes the default footnote number. +Place a numbered footnote @var{text} at the bottom of the current page. + +@example +There are over a thousand footnotes in Gibbon's +\textit@{Decline and Fall of the Roman Empire@}.\footnote@{After +reading an early version with endnotes David Hume complained, +``One is also plagued with his Notes, according to the present Method +of printing the Book'' and suggested that they ``only to be printed +at the Margin or the Bottom of the Page.''@} +@end example + +The optional argument @var{number} allows you to specify the footnote +number. If you use this option then the footnote number counter is not +incremented, and if you do not use it then the counter is incremented. -This command can only be used in outer paragraph mode; i.e., you -cannot use it in sectioning commands like @code{\chapter}, in figures, -tables or in a @code{tabular} environment. (See following sections.) +@cindex footnotes, symbols instead of numbers +@findex \fnsymbol@r{, and footnotes} +@findex \@@fnsymbol +Change how @LaTeX{} shows the footnote counter with something like +@code{\renewcommand@{\thefootnote@}@{\fnsymbol@{footnote@}@}}, which +uses a sequence of symbols (@pxref{\alph \Alph \arabic \roman \Roman +\fnsymbol}). To make this change global put that in the preamble. If +you make the change local then you may want to reset the counter with +@code{\setcounter@{footnote@}@{0@}}. By default @LaTeX{} uses arabic +numbers. + +@LaTeX{}'s default puts many restrictions on where you can use a +@code{\footnote}; for instance, you cannot use it in an argument to a +sectioning command such as @code{\chapter} (it can only be used in outer +paragraph mode). There are some workarounds; see following sections. @c xx mention packages that fix this +@cindex Footnotes, in a minipage +@cindex mpfootnote counter +In a @code{minipage} environment the @code{\footnote} +command uses the @code{mpfootnote} counter instead of the +@code{footnote} counter, so they are numbered independently. They are +shown at the bottom of the environment, not at the bottom of the page. +And by default they are shown alphabetically. @xref{minipage}. + @node \footnotemark @section @code{\footnotemark} -@findex \footnotemark -With no optional argument, the @code{\footnotemark} command puts the -current footnote number in the text. This command can be used in -inner paragraph mode. You give the text of the footnote separately, -with the @code{\footnotetext} command. +@findex \footnotemark -This command can be used to produce several consecutive footnote -markers referring to the same footnote with +Synopsis, one of: @example -\footnotemark[\value@{footnote@}] +\footnotemark +\footnotemark[@var{number}] @end example -@noindent -after the first @code{\footnote} command. +Put the current footnote number in the +text. (See@tie{}@ref{\footnotetext} for giving the text of the footnote +separately.) The version with the optional argument @var{number} uses +that number to determine the mark printed. This command can be used in +inner paragraph mode. + +This example gives the same institutional affiliation to both the first +and third authors (@code{\thanks} is a version of @code{footnote}). + +@example +\title@{A Treatise on the Binomial Theorem@} +\author@{J Moriarty\thanks@{University of Leeds@} + \and A C Doyle\thanks@{Durham University@} + \and S Holmes\footnotemark[1]@} +\begin@{document@} +\maketitle +@end example + +If you use @code{\footnotemark} without the optional argument then it +increments the footnote counter but if you use the optional @var{number} +then it does not. This produces several consecutive footnote markers +referring to the same footnote. + +@example +The first theorem\footnote@{Due to Gauss.@} +and the second theorem\footnotemark[\value@{footnote@}] +and the third theorem.\footnotemark[\value@{footnote@}] +@end example @node \footnotetext @section @code{\footnotetext} + @findex \footnotetext -Synopsis: +Synopsis, one of: @example +\footnotetext@{@var{text}@} \footnotetext[@var{number}]@{@var{text}@} @end example -The @code{\footnotetext} command places @var{text} at the bottom of -the page as a footnote. This command can come anywhere after the -@code{\footnotemark} command. The @code{\footnotetext} command must -appear in outer paragraph mode. +Place @var{text} at the bottom of the page as a footnote. This command +can come anywhere after the @code{\footnotemark} command. The optional +argument @var{number} changes the displayed footnote number. The +@code{\footnotetext} command must appear in outer paragraph mode. -The optional argument @var{number} changes the default footnote number. +@node Footnotes in a table +@section Footnotes in a table -@node Symbolic footnotes -@section Symbolic footnotes +@cindex Footnotes, in a table -@cindex footnotes, symbolic instead of numbered -If you want to use symbols for footnotes, rather than increasing -numbers, redefine @code{\thefootnote} like this: +Inside a @code{table} environment the @code{\footnote} command does not +work. For instance, if the code below appears on its own then the +footnote simply disappears; there is a footnote mark in the table cell +but nothing is set at the bottom of the page. @example -\renewcommand@{\thefootnote@}@{\fnsymbol@{footnote@}@} +\begin@{center@} + \begin@{tabular@}@{l|l@} + \textsc@{Ship@} &\textsc@{Book@} \\ \hline + \textit@{HMS Sophie@} &Master and Commander \\ + \textit@{HMS Polychrest@} &Post Captain \\ + \textit@{HMS Lively@} &Post Captain \\ + \textit@{HMS Surprise@} &A number of books\footnote@{Starting with HMS Surprise.@} + \end@{tabular@} +\end@{center@} @end example -@findex \fnsymbol@r{, and footnotes} -@findex \@@fnsymbol -The @code{\fnsymbol} command produces a predefined series of symbols -(@pxref{\alph \Alph \arabic \roman \Roman \fnsymbol}). If you want to -use a different symbol as your footnote mark, you'll need to also -redefine @code{\@@fnsymbol}. +The solution is to surround the @code{tabular} environment with a +@code{minipage} environment, as here (@pxref{minipage}). + +@example +\begin@{center@} + \begin@{minipage@}@{.5\textwidth@} + .. tabular material .. + \end@{minipage@} +\end@{center@} +@end example + +The same technique will work inside a floating @code{table} environment +(@pxref{table}). To get the footnote at the bottom of the page use the +@file{tablefootnote} package, as illustrated in this example. If you +put @code{\usepackage@{tablefootnote@}} in the preamble and use the code +shown then the footnote appears at the bottom and is numbered in +sequence with other footnotes. + +@example +\begin@{table@} + \centering + \begin@{tabular@}@{l|l@} + \textsc@{Date@} &\textsc@{Campaign@} \\ \hline + 1862 &Fort Donelson \\ + 1863 &Vicksburg \\ + 1865 &Army of Northern Virginia\footnote@{Ending the war.@} + \end@{tabular@} + \caption@{Forces captured by US Grant@} +\end@{table@} +@end example + + +@node Footnotes in section headings +@section Footnotes in section headings + +Putting a footnote in a section heading + +@example +\section@{Full sets\protect\footnote@{This material is due to R~Jones.@}@} +@end example + +causes the footnote to appear both at the bottom of the page where the +section starts and at the bottom of the table of contents page. To have +it not appear on the table of contents use the package @file{footmisc} +with the @code{stable} option. + +@example +\usepackage[stable]@{footmisc@} + .. +\begin@{document@} + .. +\section@{Full sets\footnote@{This material is due to R~Jones.@}@} +@end example + +Note that the @code{\protect} is gone; putting it in causes the +footnote to reappear on the table of contents. + + +@node Footnotes of footnotes +@section Footnotes of footnotes + +Particularly in the humanities, authors can have multiple classes of +footnotes, including having footnotes of footnotes. The package +@file{bigfoot} extends @LaTeX{}'s default footnote mechanism in many +ways, including allow these two, as in this example. + +@example +\usepackage@{bigfoot@} +\DeclareNewFootnote@{Default@} +\DeclareNewFootnote@{from@}[alph] % create class \footnotefrom@{@} + .. +\begin@{document@} + .. +The third theorem is a partial converse of the +second.\footnotefrom@{First noted in Wilson.\footnote@{Second edition only.@}@} + .. +@end example + + +@node Multiple reference to footnotes +@section Multiple references to footnotes + +You can refer to a single footnote more than once. This example +uses the package @file{cleverref}. + +@c from SE user Jake http://tex.stackexchange.com/a/10116/339 +@example +\usepackage@{cleveref@}[2012/02/15] % this version of package or later +\crefformat@{footnote@}@{#2\footnotemark[#1]#3@} + .. +\begin@{document@} + .. +The theorem is from Evers.\footnote@{\label@{fn:TE@}Tinker and Evers, 1994.@} +The corollary is from Chance.\footnote@{Evers and Chance, 1990.@} +But the key lemma is from Tinker.\cref@{fn:TE@} + .. +@end example + +This solution will work with the package @file{hyperref}. +See@tie{}@ref{\footnotemark} for a simpler solution in the common case +of multiple authors with the same affiliation. @node Footnote parameters @@ -3649,6 +4877,7 @@ footnotes. This is @samp{6.65pt} for @samp{10pt}, @samp{7.7pt} for @node Definitions @chapter Definitions + @cindex definitions @LaTeX{} has support for making new commands of many different kinds. @@ -3656,21 +4885,24 @@ footnotes. This is @samp{6.65pt} for @samp{10pt}, @samp{7.7pt} for @c xx everything in this chapter needs examples. @menu -* \newcommand & \renewcommand:: (Re)define a new command. -* \newcounter:: Define a new counter. -* \newlength:: Define a new length. -* \newsavebox:: Define a new box. -* \newenvironment & \renewenvironment:: Define a new environment. -* \newtheorem:: Define a new @code{theorem}-like environment. -* \newfont:: Define a new font name. -* \protect:: Using tricky commands. +* \newcommand & \renewcommand:: (Re)define a new command. +* \providecommand:: Define a new command, if name not used. +* \newcounter:: Define a new counter. +* \newlength:: Define a new length. +* \newsavebox:: Define a new box. +* \newenvironment & \renewenvironment:: Define a new environment. +* \newtheorem:: Define a new theorem-like environment. +* \newfont:: Define a new font name. +* \protect:: Using tricky commands. @end menu @node \newcommand & \renewcommand @section @code{\newcommand} & @code{\renewcommand} + @findex \newcommand @cindex commands, defining new ones +@cindex commands, redefining @cindex defining a new command @cindex new commands, defining @@ -3678,34 +4910,47 @@ footnotes. This is @samp{6.65pt} for @samp{10pt}, @samp{7.7pt} for command, respectively. Synopses: @example - \newcommand[*]@{@var{cmd}@}[@var{nargs}][@var{optargval}]@{@var{defn}@} -\renewcommand[*]@{@var{cmd}@}[@var{nargs}][@var{optargval}]@{@var{defn}@} + \newcommand@{@var{cmd}@}[@var{nargs}][@var{optargdefault}]@{@var{defn}@} + \newcommand*@{@var{cmd}@}[@var{nargs}][@var{optargdefault}]@{@var{defn}@} +\renewcommand@{@var{cmd}@}[@var{nargs}][@var{optargdefault}]@{@var{defn}@} +\renewcommand*@{@var{cmd}@}[@var{nargs}][@var{optargdefault}]@{@var{defn}@} @end example -@table @var -@item @code{*} -@cindex *-form of defining new commands -The *-form of these commands requires that the arguments not contain -multiple paragraphs of text (not @code{\long}, in plain @TeX{} terms). +The @code{*}-form of these two commands requires that the arguments +not contain multiple paragraphs of text (not @code{\long}, in plain +@TeX{} terms). +@table @var @item cmd -The command name, beginning with @code{\}. For @code{\newcommand}, it -must not be already defined and must not begin with @code{\end}; for -@code{\renewcommand}, it must already be defined. +Required; the command name. It must begin with @code{\}. For +@code{\newcommand}, it must not be already defined and must not begin +with @code{\end}. For @code{\renewcommand}, it must already be +defined. @item nargs -An optional integer from 1 to 9 specifying the number of arguments -that the command will take. The default is for the command to have no -arguments. - -@item optargval -If this optional parameter is present, it means that the first -argument of command @var{cmd} is optional and its default value (i.e., -if it is not specified in the call) is @var{optarg}. In otherwise, -when calling the macro, if no @code{[@var{value}]} is given after -@code{@var{cmd}}---which is different from having @code{[]} for an -empty @var{value}---then string @samp{@var{optargval}} becomes the -value of @code{#1} within @var{defn} when the macro is expanded. +Optional; an integer from 0 to 9, specifying the number of arguments +that the command will take. If this argument is not present, the +default is for the command to have no arguments. When redefining a +command, the new version can have a different number of arguments than +the old version. + +@item optargdefault +Optional; if this argument is present then the first argument of defined +command @var{\cmd} is optional, with default value @var{optargdefault} +(which may be the empty string). If this argument is not present then +@var{\cmd} does not take an optional argument. + +That is, if @var{\cmd} is used with square brackets following, as in +@code{\@var{cmd}[@var{myval}]}, then within @var{defn} @code{#1} expands +@var{myval}. While if @var{\cmd} is called without square brackets +following, then within @var{defn} the @code{#1} expands to the default +@var{optargdefault}. In either case, any required arguments will be +referred to starting with @code{#2}. + +Omitting @code{[@var{myval}]} in the call is different from having the +square brackets with no contents, as in @code{[]}. The former results +in @code{#1} expanding to @var{optargdefault}; the latter results in +@code{#1} expanding to the empty string. @item defn The text to be substituted for every occurrence of @code{cmd}; a @@ -3714,10 +4959,79 @@ text of the @var{n}th argument. @end table -@c xx \providecommand, * form (non-\long) +A command with no arguments that is followed in the source by a space +will swallow that space. The solution is to type @code{@{@}} after the +command and before the space. + +A simple example of defining a new command: +@code{\newcommand@{\JH@}@{Jim Hef@{@}feron@}} causes the abbreviation +@code{\JH} to be replaced by the longer text. + +Redefining a command is basically the same: +@code{\renewcommand@{\qedsymbol@}@{@{\small QED@}@}}. + +Here's a command definition that uses arguments: + +@example +\newcommand@{\defreference@}[1]@{Definition~\ref@{#1@}@} +@end example + +@noindent Then, @code{\defreference@{def:basis@}} will expand to +something like @samp{Definition~3.14}. + +An example with two arguments: +@code{\newcommand@{\nbym@}[2]@{#1\!\times\!#2@}} is invoked as +@code{\nbym@{2@}@{k@}}. + +An example with optional arguments: + +@example +\newcommand@{\salutation@}[1][Sir or Madam]@{Dear #1:@} +@end example + +@noindent Then, @code{\salutation} gives @samp{Dear Sir or Madam:} while +@code{\salutation[John]} gives @samp{Dear John:}. And +@code{\salutation[]} gives @samp{Dear :}. + +The braces around @var{defn} do not delimit the scope of the result of +expanding @var{defn}. So @code{\newcommand@{\shipname@}[1]@{\it #1@}} +is wrong since in the sentence + +@example +The \shipname@{Monitor@} met the \shipname@{Virginia@}. +@end example + +@noindent the words @samp{met the} will incorrectly be in italics. An +extra pair of braces @code{\newcommand@{\shipname@}[1]@{@{\it #1@}@}} +fixes it. + + +@node \providecommand +@section @code{\providecommand} + +@findex \providecommand +@cindex commands, defining new ones +@cindex defining a new command +@cindex new commands, defining + +Defines a command, as long as no command of this name already exists. +Synopses: + +@example +\providecommand@{@var{cmd}@}[@var{nargs}][@var{optargdefault}]@{@var{defn}@} +\providecommand*@{@var{cmd}@}[@var{nargs}][@var{optargdefault}]@{@var{defn}@} +@end example + +If no command of this name already exists then this has the same effect +as @code{\newcommand} (@pxref{\newcommand & \renewcommand}). If a +command of this name already exists then this definition does nothing. +This is particularly useful in a style file, or other file that may be +loaded more than once. + @node \newcounter -@section @code{\newcounter} +@section @code{\newcounter}: Allocating a counter + @findex \newcounter @cindex counters, defining new @@ -3727,198 +5041,454 @@ Synopsis: \newcounter@{@var{countername}@}[@var{supercounter}] @end example -The @code{\newcounter} command defines a new counter named @var{countername}. -The new counter is initialized to zero. +The @code{\newcounter} command globally defines a new counter named +@var{countername}. The name consists of letters only and does not begin +with a backslash (@samp{\}). The name must not already be used by +another counter. The new counter is initialized to zero. -Given the optional argument @code{[@var{super}]}, @var{countername} -will be reset whenever the counter named @var{supercounter} is incremented. +If the optional argument @code{[@var{supercounter}]} appears, then +@var{countername} will be numbered within, or subsidiary to, the +existing counter @var{supercounter}. For example, ordinarily +@code{subsection} is numbered within @code{section}. Any time +@var{supercounter} is incremented with @code{\stepcounter} +(@pxref{\stepcounter}) or @code{\refstepcounter} +(@pxref{\refstepcounter}) then @var{countername} is reset to zero. @xref{Counters}, for more information about counters. @node \newlength -@section @code{\newlength} +@section @code{\newlength}: Allocating a length + @findex \newlength -@cindex lengths, defining new +@cindex lengths, allocating new +@cindex rubber lengths, defining new +@cindex skip register, plain @TeX{} +@cindex glue register, plain @TeX{} -Synopsis: +Allocate a new @dfn{length} register. Synopsis: @example \newlength@{\@var{arg}@} @end example -The @code{\newlength} command defines the mandatory argument as a -@dfn{length} command with a value of zero. The argument must -be a control sequence, as in @code{\newlength@{\foo@}}. An error -occurs if @code{\foo} is already defined. +This command takes one required argument, which must begin with a +backslash (@samp{\}). It creates a new length register named +@code{\@var{arg}}, which is a place to hold (rubber) lengths such as +@code{1in plus.2in minus.1in} (what plain @TeX{} calls a @code{skip} +register). The register gets an initial value of zero. The control +sequence @code{\@var{arg}} must not already be defined. -@xref{Lengths}, for how to set the new length to a nonzero value, and -for more information about lengths in general. +@xref{Lengths}, for more about lengths. @node \newsavebox -@section @code{\newsavebox} +@section @code{\newsavebox}: Allocating a box + @findex \newsavebox +@cindex box, allocating new -Synopsis: +Allocate a ``bin'' for holding a box. Synopsis: @example -\newsavebox@{@var{cmd}@} +\newsavebox@{\@var{cmd}@} @end example -Defines @code{\@var{cmd}}, which must be a command name not already -defined, to refer to a new bin for storing boxes. +Defines @code{\@var{cmd}} to refer to a new bin for storing boxes. +Such a box is for holding typeset material, to use multiple times +(@pxref{Boxes}) or to measure or manipulate. The name +@code{\@var{cmd}} must start with a backslash (@samp{\}), and must not +be already defined. + +The allocation of a box is global. This command is fragile +(@pxref{\protect}). @node \newenvironment & \renewenvironment @section @code{\newenvironment} & @code{\renewenvironment} + @findex \newenvironment @findex \renewenvironment @cindex environments, defining @cindex defining new environments @cindex redefining environments -Synopses: +These commands define or redefine an environment @var{env}, that is, +@code{\begin@{@var{env}@} @dots{} \end@{@var{env}@}}. Synopses: @example - \newenvironment[*]@{@var{env}@}[@var{nargs}][@var{default}]@{@var{begdef}@}@{@var{enddef}@} -\renewenvironment[*]@{@var{env}@}[@var{nargs}]@{@var{begdef}@}@{@var{enddef}@} + \newenvironment@{@var{env}@}[@var{nargs}][@var{optargdefault}]@{@var{begdefn}@}@{@var{enddefn}@} + \newenvironment*@{@var{env}@}[@var{nargs}][@var{optargdefault}]@{@var{begdefn}@}@{@var{enddefn}@} +\renewenvironment@{@var{env}@}[@var{nargs}][@var{optargdefault}]@{@var{begdefn}@}@{@var{enddefn}@} +\renewenvironment*@{@var{env}@}[@var{nargs}][@var{optargdefault}]@{@var{begdefn}@}@{@var{enddefn}@} @end example -These commands define or redefine an environment @var{env}, that is, -@code{\begin@{@var{env}@} @dots{} \end@{@var{env}@}}. +Unlike @code{\newcommand} and @code{\renewcommand}, the @code{*}-forms +@code{\newenvironment*} and @code{\renewcommand*} have the same effect +as the forms with no @code{*}. @table @var -@item @code{*} -@cindex *-form of environment commands -The *-form of these commands requires that the arguments (not the -contents of the environment) not contain multiple paragraphs of text. - @item env -The name of the environment. For @code{\newenvironment}, @var{env} -must not be an existing environment, and the command @code{\@var{env}} -must be undefined. For @code{\renewenvironment}, @var{env} must be -the name of an existing environment. +Required; the environment name. It does not begin with backslash +(@code{\}). It must not begin with the string @code{end}. For +@code{\newenvironment}, the name @var{env} must not be the name of an +already existing environment, and also the command @code{\@var{env}} +must be undefined. For @code{\renewenvironment}, @var{env} must be the +name of an existing environment. @item nargs -An integer from 1 to 9 denoting the number of arguments of -the newly-defined environment. The default is no arguments. +Optional; an integer from 0 to 9 denoting the number of arguments of +that the environment will take. These arguments appear after the +@code{\begin}, as in +@code{\begin@{@var{env}@}@{@var{arg1}@}@dots{}@{@var{argn}@}}. If this +argument is not present then the default is for the environment to have +no arguments. When redefining an environment, the new version can have +a different number of arguments than the old version. + +@item optargdefault +Optional; if this argument is present then the first argument of the +defined environment is optional, with default value @var{optargdefault} +(which may be the empty string). If this argument is not present then +the environment does not take an optional argument. + +That is, when @code{[@var{optargdefault}]} is present in the environment +definition, if @code{\begin@{@var{env}@}} is used with square brackets +following, as in @code{\begin@{@var{env}@}[@var{myval}]}, then within +the environment @code{#1} expands @var{myval}. If +@code{\begin@{@var{env}@}} is called without square brackets following, +then within the environment the @code{#1} expands to the default +@var{optargdefault}. In either case, any required arguments will be +referred to starting with @code{#2}. + + +Omitting @code{[@var{myval}]} in the call is different from having the +square brackets with no contents, as in @code{[]}. The former results +in @code{#1} expanding to @var{optargdefault}; the latter results in +@code{#1} expanding to the empty string. + +@item begdefn +Required; the text expanded at every occurrence of +@code{\begin@{@var{env}@}}; a construct of the form @code{#@var{n}} in +@var{begdef} is replaced by the text of the @var{n}th argument. + +@item enddefn +Required; the text expanded at every occurrence of +@code{\end@{@var{env}@}}. Note that it may not contain any argument +parameters, so @code{#@var{n}} cannot be used here. -@item default -If this is specified, the first argument is optional, and @var{default} -gives the default value for that argument. +@end table -@item begdef -The text expanded at every occurrence of @code{\begin@{@var{env}@}}; a -construct of the form @code{#@var{n}} in @var{begdef} is replaced by -the text of the @var{n}th argument. +The environment @var{env} delimits the scope of the result of expanding +@var{begdefn} and @var{enddefn}. Thus, in the first example below, the +effect of the @code{\small} is limited to the quote and does not extend +to material following the environment. -@item enddef -The text expanded at every occurrence of @code{\end@{@var{env}@}}. It -may not contain any argument parameters. +This example gives an environment like @LaTeX{}'s @code{quotation} except that +it will be set in smaller type. -@end table +@example +\newenvironment@{smallquote@}@{% + \small\begin@{quotation@} +@}@{% + \end@{quotation@} +@} +@end example + +This shows the use of arguments; it gives a quotation environment that +cites the author. + +@example +\newenvironment@{citequote@}[1][Shakespeare]@{% + \begin@{quotation@} + \noindent\textit@{#1@}: +@}@{% + \end@{quotation@} +@} +@end example + +@noindent The author's name is optional, and defaults to Shakespeare. +In the document, use the environment as here: + +@example +\begin@{citequote@}[Lincoln] + .. +\end@{citequote@} +@end example + +The final example shows how to save the value of an argument to use in +@var{enddefn}. + +@example +\newsavebox@{\quoteauthor@} +\newenvironment@{citequote@}[1][Shakespeare]@{% + \sbox\quoteauthor@{#1@}% + \begin@{quotation@} +@}@{% + \hspace@{1em plus 1fill@}---\usebox@{\quoteauthor@} + \end@{quotation@} +@} +@end example @node \newtheorem @section @code{\newtheorem} + @findex \newtheorem @cindex theorems, defining @cindex defining new theorems +@cindex theorem-like environment +@cindex environment, theorem-like +Define a new @dfn{theorem-like environment}. Synopses: + +@example +\newtheorem@{@var{name}@}@{@var{title}@}[@var{numbered_within}] +\newtheorem@{@var{name}@}[@var{numbered_like}]@{@var{title}@} +@end example + +Both create a theorem-like environment @var{name}. Using the first +form, + @example -\newtheorem@{@var{newenv}@}@{@var{label}@}[@var{within}] -\newtheorem@{@var{newenv}@}[@var{numbered_like}]@{@var{label}@} +\newtheorem@{@var{name}@}@{@var{title}@}[@var{numbered_within}] @end example -This command defines a theorem-like environment. Arguments: +@noindent with the optional argument after the second required argument, +creates an environment whose counter is subordinate to the existing +counter @var{numbered_within}: it will be reset when +@var{numbered_within} is reset). + +Using the second form, + +@example +\newtheorem@{@var{name}@}[@var{numbered_like}]@{@var{title}@} +@end example + +@noindent with the optional argument between the two required +arguments, will create an environment whose counter will share the +previously defined counter @var{numbered_like}. + +You can specify one of @var{numbered_within} and @var{numbered_like}, +or neither, but not both. + +This command creates a counter named @var{name}. In addition, unless +the optional argument @var{numbered_like} is used, the current +@code{\ref} value will be that of @code{\the@var{numbered_within}} +(@pxref{\ref}). + +This declaration is global. It is fragile (@pxref{\protect}). + +Arguments: @table @var -@item newenv -The name of the environment to be defined; must not be the name of an -existing environment or otherwise defined. +@item name +The name of the environment. It must not begin with a backslash +(@samp{\}). It must not be the name of an existing environment; indeed, +the command name @code{\@var{name}} must not already be defined as anything. -@item label +@item title The text printed at the beginning of the environment, before the number. For example, @samp{Theorem}. -@item numbered_like -(Optional.) The name of an already defined theorem-like environment; -the new environment will be numbered just like @var{numbered_like}. +@item numbered_within +Optional; the name of an already defined counter, usually a sectional +unit such as @code{chapter} or @code{section}. When the +@var{numbered_within} counter is reset then the @var{name} environment's +counter will also be reset. + +If this optional argument is not used then the command +@code{\the@var{name}} is set to @code{\arabic@{@var{name}@}}. -@item within -(Optional.) The name of an already defined counter, a sectional unit. -The new theorem counter will be reset at the same time as the -@var{within} counter. +@item numbered_like +Optional; the name of an already defined theorem-like environment. The +new environment will be numbered in sequence with @var{numbered_like}. @end table -At most one of @var{numbered_like} and @var{within} can be specified, -not both. +Without any optional arguments the environments are numbered +sequentially. This example has a declaration in the preamble that +results in @samp{Definition@tie{}1} and @samp{Definition@tie{}2} in the output. + +@example +\newtheorem@{defn@}@{Definition@} +\begin@{document@} +\section@{...@} +\begin@{defn@} + First def +\end@{defn@} + +\section@{...@} +\begin@{defn@} + Second def +\end@{defn@} +@end example + +Because this example specifies the optional argument +@var{numbered_within} to @code{\newtheorem} as @code{section}, the +example, with the same document body, gives @samp{Definition@tie{}1.1} +and @samp{Definition@tie{}2.1}. + +@example +\newtheorem@{defn@}@{Definition@}[section] +\begin@{document@} +\section@{...@} +\begin@{defn@} + First def +\end@{defn@} + +\section@{...@} +\begin@{defn@} + Second def +\end@{defn@} +@end example + +In this example there are two declarations in the preamble, the second +of which calls for the new @code{thm} environment to use the same +counter as @code{defn}. It gives @samp{Definition@tie{}1.1}, followed +by @samp{Theorem@tie{}2.1} and @samp{Definition@tie{}2.2}. + +@example +\newtheorem@{defn@}@{Definition@}[section] +\newtheorem@{thm@}[defn]@{Theorem@} +\begin@{document@} +\section@{...@} +\begin@{defn@} + First def +\end@{defn@} + +\section@{...@} +\begin@{thm@} + First thm +\end@{thm@} + +\begin@{defn@} + Second def +\end@{defn@} +@end example @node \newfont -@section @code{\newfont} +@section @code{\newfont}: Define a new font (obsolete) + @findex \newfont @cindex fonts, new commands for @cindex defining new fonts +@code{\newfont}, now obsolete, defines a command that will switch fonts. Synopsis: @example -\newfont@{@var{cmd}@}@{@var{fontname}@} +\newfont@{\@var{cmd}@}@{@var{font description}@} @end example -Defines a control sequence @code{\@var{cmd}}, which must not already -be defined, to make @var{fontname} be the current font. The file -looked for on the system is named @file{@var{fontname}.tfm}. +This defines a control sequence @code{\@var{cmd}} that will change the +current font. @LaTeX{} will look on your system for a file named +@file{@var{fontname}.tfm}. The control sequence must must not already +be defined. It must begin with a backslash (@samp{\}). + +@findex .fd @r{file} +This command is obsolete. It is a low-level command for setting up an +individual font. Today fonts are almost always defined in families +(which allows you to, for example, associate a boldface with a roman) +through the so-called ``New Font Selection Scheme'', either by using +@file{.fd} files or through the use of an engine that can access +system fonts such as Xe@LaTeX{} (@pxref{@TeX{} engines}). +@c xx explain nfss somewhere + +@cindex at clause, in font definitions +@cindex design size, in font definitions +But since it is part of @LaTeX{}, here is an explanation: the +@var{font description} consists of a @var{fontname} and an optional +@dfn{at clause}; this can have the form either @code{at @var{dimen}} +or @code{scaled @var{factor}}, where a @var{factor} of @samp{1000} +means no scaling. For @LaTeX{}'s purposes, all this does is scale all +the character and other font dimensions relative to the font's design +size, which is a value defined in the @file{.tfm} file. + +This example defines two equivalent fonts and typesets a few +characters in each: -This is a low-level command for setting up to use an individual font. -More commonly, fonts are defined in families through @file{.fd} files. +@example +\newfont@{\testfontat@}@{cmb10 at 11pt@} +\newfont@{\testfontscaled@}@{cmb10 scaled 11pt@} +\testfontat abc +\testfontscaled abc +@end example @node \protect @section @code{\protect} -@findex \protect +@findex \protect @cindex fragile commands +@cindex robust commands @cindex moving arguments -Footnotes, line breaks, any command that has an optional argument, and -many more are so-called @dfn{fragile} commands. When a fragile -command is used in certain contexts, called @dfn{moving arguments}, it -must be preceded by @code{\protect}. In addition, any fragile -commands within the arguments must have their own @code{\protect}. -Some examples of moving arguments are @code{\caption} -(@pxref{figure}), @code{\thanks} (@pxref{\maketitle}), and -@-expressions in @code{tabular} and @code{array} environments -(@pxref{tabular}). - -@cindex robust commands -Commands which are not fragile are called @dfn{robust}. They must not -be preceded by @code{\protect}. +All @LaTeX{} commands are either @dfn{fragile} or @dfn{robust}. +Footnotes, line breaks, any command that has an optional argument, and +many more, are fragile. A fragile command can break when it is used in +the argument to certain commands. To prevent such commands from +breaking they must be preceded by the command @code{\protect}. + +For example, when @LaTeX{} runs the @code{\section@{@var{section +name}@}} command it writes the @var{section name} text to the +@file{.aux} auxiliary file, moving it there for use elsewhere in the +document such as in the table of contents. Any argument that is +internally expanded by @LaTeX{} without typesetting it directly is +referred to as a @dfn{moving argument}. A command is fragile if it can +expand during this process into invalid @TeX{} code. Some examples of +moving arguments are those that appear in the @code{\caption@{..@}} +command (@pxref{figure}), in the @code{\thanks@{..@}} command +(@pxref{\maketitle}), and in @@-expressions in the @code{tabular} and +@code{array} environments (@pxref{tabular}). + +If you get strange errors from commands used in moving arguments, try +preceding it with @code{\protect}. Every fragile commands must be +protected with their own @code{\protect}. + +Although usually a @code{\protect} command doesn't hurt, length +commands are robust and should not be preceded by a @code{\protect} +command. Nor can a @code{\protect} command be used in the argument to +@code{\addtocounter} or @code{\setcounter} command. + +In this example the @code{caption} command gives a mysterious error +about an extra curly brace. Fix the problem by preceding each +@code{\raisebox} command with @code{\protect}. -See also: +@example +\begin@{figure@} + .. + \caption@{Company headquarters of A\raisebox@{1pt@}@{B@}\raisebox@{-1pt@}@{C@}@} +\end@{figure@} +@end example -@smallexample -@exdent @url{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html} -@exdent @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect} -@end smallexample +In the next example the @code{\tableofcontents} command gives an error +because the @code{\(..\)} in the section title expands to illegal @TeX{} +in the @file{.toc} file. You can solve this by changing @code{\(..\)} +to @code{\protect\(..\protect\)}. -@c xx really need examples. +@example +\begin@{document@} +\tableofcontents + .. +\section@{Einstein's \( e=mc^2 \)@} + .. +@end example @node Counters @chapter Counters + @cindex counters, a list of @cindex variables, a list of Everything @LaTeX{} numbers for you has a counter associated with -it. The name of the counter is the same as the name of the environment -or command that produces the number, except with no @code{\}. -(@code{enumi}--@code{enumiv} are used for the nested enumerate -environment.) Below is a list of the counters used in @LaTeX{}'s -standard document classes to control numbering. +it. The name of the counter is often the same as the name of the +environment or command associated with the number, except with no +backslash (@code{\}). Thus the @code{\chapter} command starts a +chapter and the @code{chapter} counter keeps track of the chapter +number. Below is a list of the counters used in @LaTeX{}'s standard +document classes to control numbering. @example part paragraph figure enumi @@ -3928,6 +5498,16 @@ subsection equation mpfootnote enumiv subsubsection @end example +The @code{mpfootnote} counter is used by the @code{\footnote} command +inside of a minipage (@pxref{minipage}). + +The @code{enumi} through @code{enumiv} counters are used in the +@code{enumerate} environment, for up to four nested levels +(@pxref{enumerate}). + +New counters are created with @code{\newcounter}. @xref{\newcounter}. + + @menu * \alph \Alph \arabic \roman \Roman \fnsymbol:: Print value of a counter. * \usecounter:: Use a specified counter in a list environment. @@ -3943,8 +5523,11 @@ subsubsection @node \alph \Alph \arabic \roman \Roman \fnsymbol @section @code{\alph \Alph \arabic \roman \Roman \fnsymbol}: Printing counters +@cindex counters, printing + All of these commands take a single counter as an argument, for -instance, @code{\alph@{enumi@}}. +instance, @code{\alph@{enumi@}}. Note that the counter name does not +start with a backslash. @ftable @code @item \alph @@ -3972,7 +5555,7 @@ Here are the symbols (as Unicode code points in ASCII output): @display asterisk(*) dagger(@U{2021}) ddagger(@U{2021}) section-sign(@U{00A7}) paragraph-sign(@U{00B6}) parallel(@U{2225}) -double-asterisk(**) double-dagger(@U{2021}@U{2021}) double-ddagger(@U{2021}@U{2021}) +double-asterisk(**) double-dagger(@U{2020}@U{2020}) double-ddagger(@U{2021}@U{2021}) @end display @end ftable @@ -3980,6 +5563,7 @@ double-asterisk(**) double-dagger(@U{2021}@U{2021}) double-ddagger(@U{2021}@U{20 @node \usecounter @section @code{\usecounter@{@var{counter}@}} + @findex \usecounter @cindex list items, specifying counter @cindex numbered items, specifying counter @@ -3990,13 +5574,31 @@ Synopsis: \usecounter@{@var{counter}@} @end example -The @code{\usecounter} command is used in the second argument of the -@code{list} environment to specify @var{counter} to be used to number -the list items. +In the @code{list} environment, when used in the second argument, this +command sets up @var{counter} to number the list items. It initializes +@var{counter} to zero, and arranges that when @code{\item} is called +without its optional argument then @var{counter} is incremented by +@code{\refstepcounter}, making its value be the current @code{ref} +value. This command is fragile (@pxref{\protect}). + +Put in the preamble, this makes a new list environment enumerated with +@var{testcounter}: + +@example +\newcounter@{testcounter@} +\newenvironment@{test@}@{% + \begin@{list@}@{@}@{% + \usecounter@{testcounter@} + @} +@}@{% + \end@{list@} +@} +@end example @node \value @section @code{\value@{@var{counter}@}} + @findex \value @cindex counters, getting value of @@ -4006,18 +5608,37 @@ Synopsis: \value@{@var{counter}@} @end example -The @code{\value} command produces the value of @var{counter}. It can -be used anywhere @LaTeX{} expects a number, for example: +This command expands to the value of @var{counter}. It is often used +in @code{\setcounter} or @code{\addtocounter}, but @code{\value} can +be used anywhere that @LaTeX{} expects a number. It must not be +preceded by @code{\protect} (@pxref{\protect}). + +The @code{\value} command is not used for typesetting the value of the +counter. @xref{\alph \Alph \arabic \roman \Roman \fnsymbol}. + +This example outputs @samp{Test counter is@tie{}6. Other counter +is@tie{}5.}. + +@example +\newcounter@{test@} \setcounter@{test@}@{5@} +\newcounter@{other@} \setcounter@{other@}@{\value@{test@}@} +\addtocounter@{test@}@{1@} + +Test counter is \arabic@{test@}. +Other counter is \arabic@{other@}. +@end example + +This example inserts @code{\hspace@{4\parindent@}}. @example -\setcounter@{myctr@}@{3@} -\addtocounter@{myctr@}@{1@} +\setcounter@{myctr@}@{3@} \addtocounter@{myctr@}@{1@} \hspace@{\value@{myctr@}\parindent@} @end example @node \setcounter @section @code{\setcounter@{@var{counter}@}@{@var{value}@}} + @findex \setcounter @cindex counters, setting @cindex setting counters @@ -4028,37 +5649,51 @@ Synopsis: \setcounter@{@var{counter}@}@{@var{value}@} @end example -The @code{\setcounter} command sets the value of @var{counter} to the -@var{value} argument. +The @code{\setcounter} command globally sets the value of @var{counter} +to the @var{value} argument. Note that the counter name does not start +with a backslash. @node \addtocounter @section @code{\addtocounter@{@var{counter}@}@{@var{value}@}} + @findex \addtocounter -The @code{\addtocounter} command increments @var{counter} by the -amount specified by the @var{value} argument, which may be negative. +The @code{\addtocounter} command globally increments @var{counter} by +the amount specified by the @var{value} argument, which may be negative. @node \refstepcounter @section @code{\refstepcounter@{@var{counter}@}} + @findex \refstepcounter The @code{\refstepcounter} command works in the same way as -@code{\stepcounter} @xref{\stepcounter}, except it also defines the -current @code{\ref} value to be the result of @code{\thecounter}. +@code{\stepcounter} (@pxref{\stepcounter}): it globally increments the +value of @var{counter} by one and resets the value of any counter +numbered within it. (For the definition of ``counters numbered +within'', @pxref{\newcounter}.) + +In addition, this command also defines the current @code{\ref} value +to be the result of @code{\thecounter}. + +While the counter value is set globally, the @code{\ref} value is set +locally, i.e., inside the current group. @node \stepcounter @section @code{\stepcounter@{@var{counter}@}} + @findex \stepcounter -The @code{\stepcounter} command adds one to @var{counter} and -resets all subsidiary counters. +The @code{\stepcounter} command globally adds one to @var{counter} and +resets all counters numbered within it. (For the definition of +``counters numbered within'', @pxref{\newcounter}.) @node \day \month \year @section @code{\day \month \year}: Predefined counters + @findex \day @findex \month @findex \year @@ -4075,12 +5710,38 @@ current day (@pxref{\today}). @node Lengths @chapter Lengths + @cindex lengths, defining and using -A @code{length} is a measure of distance. Many @LaTeX{} commands take a +A @dfn{length} is a measure of distance. Many @LaTeX{} commands take a length as an argument. +Lengths come in two types. A @dfn{rigid length} (what Plain @TeX{} +calls a @dfn{dimen}) such as @code{10pt} cannot contain a @code{plus} or +@code{minus} component. A @dfn{rubber length} (what Plain @TeX{} calls +a @dfn{skip}) can contain those, as with @code{1cm plus0.05cm +minus0.01cm}. These give the ability to stretch or shrink; the length +in the prior sentence could appear in the output as long as 1.05@tie{}cm +or as short as 0.99@tie{}cm, depending on what @TeX{}'s typesetting +algorithm finds optimum. + +The @code{plus} or @code{minus} component of a rubber length can contain +a @dfn{fill} component, as in @code{1in plus2fill}. This gives the +length infinite stretchability or shrinkability, so that the length in +the prior sentence can be set by @TeX{} to any distance greater than or +equal to 1@tie{}inch. @TeX{} actually provides three infinite glue +components @code{fil}, @code{fill}, and @code{filll}, such that the +later ones overcome the earlier ones, but only the middle value is +ordinarily used. @xref{\hfill}, @xref{\vfill}. + +Multiplying an entire rubber length by a number turns it into a rigid +length, so that after @code{\setlength@{\ylength@}@{1in plus 0.2in@}} +and @code{\setlength@{\zlength@}@{3\ylength@}} then the value of +@code{\zlength} is @code{3in}. + + @menu +* Units of length:: The units that @LaTeX{} knows. * \setlength:: Set the value of a length. * \addtolength:: Add a quantity to a length. * \settodepth:: Set a length to the depth of something. @@ -4090,8 +5751,92 @@ length as an argument. @end menu +@node Units of length +@section Units of length + +@cindex units, of length + +@TeX{} and @LaTeX{} know about these units both inside and outside of +math mode. + +@table @code +@item pt +@findex pt +@cindex Point +Point 1/72.27 inch. The conversion to metric units, to two decimal +places, is 1@dmn{point} = 2.85@dmn{mm} = 28.45@dmn{cm}. + +@item pc +@cindex pica +@findex pc +Pica, 12 pt + +@item in +@findex in +@findex inch +Inch, 72.27 pt + +@item bp +@findex bp +@cindex Big point +Big point, 1/72 inch. This length is the definition of a point in +PostScript and many desktop publishing systems. + +@item cm +@cindex Centimeter +@findex cm +Centimeter + +@item mm +@cindex Millimeter +@findex mm +Millimeter + +@item dd +@cindex Didot point +@findex dd +Didot point, 1.07 pt + +@item cc +@cindex Cicero +@findex cc +Cicero, 12 dd + +@item sp +@cindex Scaled point +@findex sp +Scaled point, 1/65536 pt + +@end table + +@cindex ex +@cindex x-height +@findex ex +@cindex m-width +@cindex em +@findex em +Two other lengths that are often used are values set by the designer of +the font. The x-height of the current font @dfn{ex}, traditionally the +height of the lower case letter x, is often used for vertical +lengths. Similarly @dfn{em}, traditionally the width of the capital +letter M, is often used for horizontal lengths (there is also +@code{\enspace}, which is @code{0.5em}). Use of these can help make a +definition work better across font changes. For example, a definition +of the vertical space between list items given as +@code{\setlength@{\itemsep@}@{1ex plus 0.05ex minus 0.01ex@}} is more +likely to still be reasonable if the font is changed than a definition +given in points. + +@cindex mu, math unit +@findex mu +In math mode, many definitions are expressed in terms of the math unit +@dfn{mu} given by 1 em = 18 mu, where the em is taken from the current +math symbols family. @xref{Spacing in math mode}. + + @node \setlength @section @code{\setlength@{\@var{len}@}@{@var{value}@}} + @findex \setlength @cindex lengths, setting @@ -4102,7 +5847,8 @@ understands, i.e., inches (@code{in}), millimeters (@code{mm}), points @node \addtolength -@section \addtolength@{@var{\len}@}@{@var{amount}@} +@section @code{\addtolength@{@var{\len}@}@{@var{amount}@}} + @findex \addtolength @cindex lengths, adding to @@ -4113,6 +5859,7 @@ may be negative. @node \settodepth @section @code{\settodepth} + @findex \settodepth @code{\settodepth@{\gnat@}@{text@}} @@ -4123,6 +5870,7 @@ equal to the depth of the @code{text} argument. @node \settoheight @section @code{\settoheight} + @findex \settoheight @code{\settoheight@{\gnat@}@{text@}} @@ -4134,6 +5882,7 @@ equal to the height of the @code{text} argument. @node \settowidth @section @code{\settowidth@{\@var{len}@}@{@var{text}@}} + @findex \settowidth The @code{\settowidth} command sets the value of the command @var{\len} @@ -4142,6 +5891,7 @@ to the width of the @var{text} argument. @node Predefined lengths @section Predefined lengths + @cindex lengths, predefined @cindex predefined lengths @@ -4168,6 +5918,7 @@ natural size, e.g., say @node Making paragraphs @chapter Making paragraphs + @cindex making paragraphs @cindex paragraphs @@ -4186,14 +5937,14 @@ a sectioning command. @node \indent @section @code{\indent} + @findex \indent @findex \parindent @cindex indent, forcing -@code{\indent} produces a horizontal space whose width equals the -width of the @code{\parindent} length, the normal paragraph -indentation. It is used to add paragraph indentation where it would -otherwise be suppressed. +@code{\indent} produces a horizontal space whose width equals to the +@code{\parindent} length, the normal paragraph indentation. It is used +to add paragraph indentation where it would otherwise be suppressed. The default value for @code{\parindent} is @code{1em} in two-column mode, otherwise @code{15pt} for @code{10pt} documents, @code{17pt} for @@ -4202,16 +5953,28 @@ mode, otherwise @code{15pt} for @code{10pt} documents, @code{17pt} for @node \noindent @section @code{\noindent} + @findex \noindent @cindex indent, suppressing -When used at the beginning of the paragraph, @code{\noindent} -suppresses any paragraph indentation. It has no effect when used in -the middle of a paragraph. +When used at the beginning of the paragraph, this command suppresses any +paragraph indentation, as in this example. + +@example +.. end of the prior paragraph. + +\noindent This paragraph is not indented. +@end example + +It has no effect when used in the middle of a paragraph. + +To eliminate paragraph indentation in an entire document, put +@code{\setlength@{\parindent@}@{0pt@}} in the preamble. @node \parskip @section @code{\parskip} + @findex \parskip @cindex vertical space before paragraphs @@ -4221,6 +5984,7 @@ before each paragraph. The default is @code{0pt plus1pt}. @node Marginal notes @section Marginal notes + @cindex marginal notes @cindex notes in the margin @cindex remarks in the margin @@ -4241,11 +6005,11 @@ will be placed @itemize @bullet @item -in the right margin for one-sided layout; +in the right margin for one-sided layout (option @code{oneside}, see @ref{Document class options}); @item -in the outside margin for two-sided layout; +in the outside margin for two-sided layout (option @code{twoside}, see @ref{Document class options}); @item -in the nearest margin for two-column layout. +in the nearest margin for two-column layout (option @code{twocolumn}, see @ref{Document class options}). @end itemize @findex \reversemarginpar @@ -4288,13 +6052,14 @@ notes from falling off the bottom of the page. @node Math formulas @chapter Math formulas + @cindex math formulas @cindex formulas, math @cindex math mode, entering - @findex math @r{environment} @findex displaymath @r{environment} @findex equation @r{environment} + There are three environments that put @LaTeX{} in math mode: @table @code @@ -4340,7 +6105,8 @@ it too is used @emph{outside} of math mode. @findex \displaystyle The @code{\displaystyle} declaration forces the size and style of the formula to be that of @code{displaymath}, e.g., with limits above and -below summations. For example +below summations. For example: + @example $\displaystyle \sum_@{n=0@}^\infty x_n $ @end example @@ -4359,668 +6125,929 @@ $\displaystyle \sum_@{n=0@}^\infty x_n $ @node Subscripts & superscripts @section Subscripts & superscripts + @cindex superscript @cindex subscript @cindex exponent @findex _ @findex ^ -To get an expression @i{exp} to appear as a subscript, you just type -@code{_@{}@i{exp}@code{@}}. To get @i{exp} to appear as a -superscript, you type @code{^@{}@i{exp}@code{@}}. @LaTeX{} handles -superscripted superscripts and all of that stuff in the natural way. -It even does the right thing when something has both a subscript and a -superscript. +In math mode, use the caret character@tie{}@code{^} to make the +@var{exp} appear as a superscript, ie.@: type @code{^@{@var{exp}@}}. +Similarly, in math mode, underscore@tie{}@code{_@{@var{exp}@}} makes a +subscript out of @var{exp}. + +In this example the @code{0} and @code{1} appear as subscripts while the +@code{2} is a superscript. + +@example +\( (x_0+x_1)^2 \) +@end example + +To have more than one character in @var{exp} use curly braces as in +@code{e^@{-2x@}}. + +@LaTeX{} handles superscripts on superscripts, and all of that stuff, in +the natural way, so expressions such as @code{e^@{x^2@}} and +@code{x_@{a_0@}} will look right. It also does the right thing when +something has both a subscript and a superscript. In this example the +@code{0} appears at the bottom of the integral sign while the @code{10} +appears at the top. + +@example +\int_0^@{10@} x^2 \,dx +@end example + +You can put a superscript or subscript before a symbol with a construct +such as @code{@{@}_t K^2} in math mode (the initial @code{@{@}} prevents +the prefixed subscript from being attached to any prior symbols in the +expression). + +Outside of math mode, a construct like @code{A +test$_\textnormal@{subscript@}$} will produce a subscript typeset in +text mode, not math mode. Note that there are packages specialized for +writing Chemical formulas such as @file{mhchem}. +@c xx display mode @node Math symbols @section Math symbols + @cindex math symbols @cindex symbols, math @cindex greek letters -@LaTeX{} provides almost any mathematical symbol you're likely to -need. The commands for generating them can be used only in math mode. +@LaTeX{} provides almost any mathematical symbol you're likely to need. For example, if you include @code{$\pi$} in your source, you will get -the pi symbol (@math{\pi}) in your output. +the pi symbol @BES{03C0,\pi}. + +Below is a list of commonly-available symbols. It is by no means an +exhaustive list. Each symbol here is described with a short phrase, and +its symbol class (which determines the spacing around it) is given in +parenthesis. The commands for these symbols can be used only in math +mode. + +@c xx Add Negation: @code{} for negations of relevant symbols +@c Useful: http://www.w3.org/TR/WD-math-970515/section6.html @ftable @code @item \| -@math{\|} +@BES{2225,\|} Parallel (relation). Synonym:@tie{}@code{\parallel}. @item \aleph -@math{\aleph} +@BES{2135,\aleph} Aleph, transfinite cardinal (ordinary). @item \alpha -@math{\alpha} +@BES{03B1,\alpha} Lower case Greek letter alpha (ordinary). @item \amalg -@math{\amalg} (binary operation) +@BES{2A3F,\amalg} Disjoint union (binary) @item \angle -@math{\angle} +@BES{2220,\angle} Geometric angle (ordinary). Similar: less-than +sign@tie{}@code{<} and angle bracket@tie{}@code{\langle}. @item \approx -@math{\approx} (relation) +@BES{2248,\approx} Almost equal to (relation). @item \ast -@math{\ast} (binary operation) +@BES{2217,\ast} Asterisk operator, convolution, six-pointed +(binary). Synonym:@tie{}@code{*}, which is often a superscript or +subscript, as in the Kleene star. Similar:@tie{}@code{\star}, which is +five-pointed, and is sometimes used as a general binary operation, and +sometimes reserved for cross-correlation. @item \asymp -@math{\asymp} (relation) +@BES{224D,\asymp} Asymptomatically equivalent (relation). @item \backslash -\ (delimiter) +\ Backslash (ordinary). Similar: set minus@tie{}@code{\setminus}, and +@code{\textbackslash} for backslash outside of math mode. @item \beta -@math{\beta} +@BES{03B2,\beta} Lower case Greek letter beta (ordinary). @item \bigcap -@math{\bigcap} +@BES{22C2,\bigcap} Variable-sized, or n-ary, intersection (operator). Similar: +binary intersection@tie{}@code{\cap}. @item \bigcirc -@math{\bigcirc} (binary operation) +@BES{26AA,\bigcirc} Circle, larger (binary). Similar: function +composition@tie{}@code{\circ}. +@c bb Best unicode symbol for this? @item \bigcup -@math{\bigcup} +@BES{22C3,\bigcup} Variable-sized, or n-ary, union (operator). Similar: binary +union@tie{}@code{\cup}. @item \bigodot -@math{\bigodot} +@BES{2A00,\bigodot} Variable-sized, or n-ary, circled dot operator (operator). @item \bigoplus -@math{\bigoplus} +@BES{2A01,\bigoplus} Variable-sized, or n-ary, circled plus operator (operator). @item \bigotimes -@math{\bigotimes} +@BES{2A02,\bigotimes} Variable-sized, or n-ary, circled times operator (operator). @item \bigtriangledown -@math{\bigtriangledown} (binary operation) +@BES{25BD,\bigtriangledown} Variable-sized, or n-ary, open triangle pointing down +(operator). @item \bigtriangleup -@math{\bigtriangleup} (binary operation) +@BES{25B3,\bigtriangleup} Variable-sized, or n-ary, open triangle pointing up (operator). @item \bigsqcup -@math{\bigsqcup} +@BES{2A06,\bigsqcup} Variable-sized, or n-ary, square union (operator). @item \biguplus -@math{\biguplus} +@BES{2A04,\biguplus} Variable-sized, or n-ary, union operator with a plus +(operator). (Note that the name has only one p.) -@item \bigcap -@math{\bigvee} +@item \bigvee +@BES{22C1,\bigvee} Variable-sized, or n-ary, logical-and (operator). @item \bigwedge -@math{\bigwedge} +@BES{22C0,\bigwedge} Variable-sized, or n-ary, logical-or (operator). @item \bot -@math{\bot} +@BESU{22A5,bot} Up tack, bottom, least element of a poset, or a contradiction +(ordinary). See also@tie{}@code{\top}. @item \bowtie -@math{\bowtie} (relation) +@BES{22C8,\bowtie} Natural join of two relations (relation). @item \Box -(square open box symbol) @c xx not in plain +@BESU{25A1,Box} Modal operator for necessity; square open box (ordinary). This +is not available in Plain @TeX{}. In @LaTeX{} you need to load the +@file{amssymb} package. +@c bb Best Unicode equivalent? @item \bullet @cindex bullet symbol -@math{\bullet} (binary operation) +@BES{2022,\bullet} Bullet (binary). Similar: multiplication +dot@tie{}@code{\cdot}. @item \cap -@math{\cap} (binary operation) +@BES{2229,\cap} Intersection of two sets (binary). Similar: variable-sized +operator@tie{}@code{\bigcap}. @item \cdot -@math{\cdot} (binary operation) +@BES{22C5,\cdot} Multiplication (binary). Similar: Bullet +dot@tie{}@code{\bullet}. @item \chi -@math{\chi} +@BES{03C7,\chi} Lower case Greek chi (ordinary). @item \circ -@math{\circ} (binary operation) +@BES{2218,\circ} Function composition, ring operator (binary). Similar: +variable-sized operator@tie{}@code{\bigcirc}. @item \clubsuit -@math{\clubsuit} +@BES{2663,\clubsuit} Club card suit (ordinary). + +@item \complement +@BESU{2201,complement} Set complement, used as a superscript as in +@code{$S^\complement$} (ordinary). This is not available in Plain +@TeX{}. In @LaTeX{} you should load the @file{amssymb} package. Also +used: @code{$S^@{\mathsf@{c@}@}$} or@tie{}@code{$\bar@{S@}$}. @item \cong -@math{\cong} (relation) +@BES{2245,\cong} Congruent (relation). @item \coprod -@math{\coprod} +@BES{2210,\coprod} Coproduct (operator). @item \cup -@math{\cup} (binary operation) +@BES{222A,\cup} Union of two sets (binary). Similar: variable-sized +operator@tie{}@code{\bigcup}. @item \dagger -@math{\dagger} (binary operation) +@BES{2020,\dagger} Dagger relation (binary). @item \dashv -@math{\dashv} (relation) +@BES{22A3,\dashv} Dash with vertical, reversed turnstile (relation). Similar: +turnstile@tie{}@code{\vdash}. @item \ddagger -@math{\dagger} (binary operation) +@BES{2021,\ddagger} Double dagger relation (binary). @item \Delta -@math{\Delta} +@BES{0394,\Delta} Greek upper case delta, used for increment (ordinary). @item \delta -@math{\delta} +@BES{03B4,\delta} Greek lower case delta (ordinary). @item \Diamond -bigger @math{\diamond} @c xx not in plain +@BESU{25C7,Diamond} Large diamond operator (ordinary). This is not available in +Plain @TeX{}. In @LaTeX{} you must load the @file{amssymb} package. +@c bb Best Unicode equivalent? @item \diamond -@math{\diamond} (binary operation) +@BES{22C4,\diamond} Diamond operator, or diamond bullet (binary). Similar: large +diamond@tie{}@code{\Diamond}, circle bullet@tie{}@code{\bullet}. @item \diamondsuit -@math{\diamondsuit} +@BES{2662,\diamondsuit} Diamond card suit (ordinary). @item \div -@math{\div} (binary operation) +@BES{00F7,\div} Division sign (binary). @item \doteq -@math{\doteq} (relation) +@BES{2250,\doteq} Approaches the limit (relation). Similar: geometrically equal +to@tie{}@code{\Doteq}. @item \downarrow -@math{\downarrow} (delimiter) +@BES{2193,\downarrow} Down arrow, converges (relation). Similar: double line down +arrow@tie{}@code{\Downarrow}. @item \Downarrow -@math{\Downarrow} (delimiter) +@BES{21D3,\Downarrow} Double line down arrow (relation). Similar: single line down +arrow@tie{}@code{\downarrow}. @item \ell -@math{\ell} +@BES{2113,\ell} Lower-case cursive letter l (ordinary). @item \emptyset -@math{\emptyset} +@BES{2205,\emptyset} Empty set symbol (ordinary). Similar: reversed empty +set@tie{}@code{\varnothing}. +@c bb Why Unicode has \revemptyset but no \emptyset? @item \epsilon -@math{\epsilon} +@BES{03F5,\epsilon} Lower case Greek-text letter (ordinary). More widely used in +mathematics is the curly epsilon +@code{\varepsilon}@tie{}@BES{03B5,\varepsilon}. Related: the set membership relation +@code{\in}@tie{}@BES{2208,\in}. +@c src: David Carlisle http://tex.stackexchange.com/a/98018/339 and +@c Unicode referenced there asserts varepsilon is much more widely used. @item \equiv -@math{\equiv} (relation) +@BES{2261,\equiv} Equivalence (relation). @item \eta -@math{\eta} +@BES{03B7,\eta} Lower case Greek letter (ordinary). @item \exists -@math{\exists} +@BES{2203,\exists} Existential quantifier (ordinary). @item \flat -@math{\flat} +@BES{266D,\flat} Musical flat (ordinary). @item \forall -@math{\forall} +@BES{2200,\forall} Universal quantifier (ordinary). @item \frown -@math{\frown} (relation) +@BES{2322,\frown} Downward curving arc (ordinary). @item \Gamma -@math{\Gamma} +@BES{0393,\Gamma} Upper case Greek letter (ordinary). @item \gamma -@math{\gamma} +@BES{03B3,\gamma} Lower case Greek letter (ordinary). @item \ge -@math{\ge} +@BES{2265,\ge} Greater than or equal to (relation). This is a synonym +for@tie{}@code{\geq}. @item \geq -@math{\geq} (relation) +@BES{2265,\geq} Greater than or equal to (relation). This is a synonym +for@tie{}@code{\ge}. @item \gets -@math{\gets} +@BES{2190,\gets} Is assigned the value (relation). +Synonym:@tie{}@code{\leftarrow}. @item \gg -@math{\gg} (relation) +@BES{226B,\gg} Much greater than (relation). Similar: much less +than@tie{}@code{\ll}. @item \hbar -@math{\hbar} +@BES{210F,\hbar} Planck constant over two pi (ordinary). @item \heartsuit -@math{\heartsuit} +@BES{2661,\heartsuit} Heart card suit (ordinary). @item \hookleftarrow -@math{\hookleftarrow} +@BES{21A9,\hookleftarrow} Hooked left arrow (relation). @item \hookrightarrow -@math{\hookrightarrow} +@BES{21AA,\hookrightarrow} Hooked right arrow (relation). @item \iff -@math{\iff} +@BES{27F7,\iff} If and only if (relation). It is @code{\Longleftrightarrow} +with a @code{\thickmuskip} on either side. @item \Im -@math{\Im} +@BES{2111,\Im} Imaginary part (ordinary). See: real part@tie{}@code{\Re}. @item \in -@math{\in} (relation) +@BES{2208,\in} Set element (relation). See also: lower case Greek letter +epsilon@tie{}@code{\epsilon}@BES{03F5,\epsilon} and rounded small +epsilon@tie{}@code{\varepsilon}. @item \infty -@math{\infty} +@BES{221E,\infty} Infinity (ordinary). @item \int -@math{\int} +@BES{222B,\int} Integral (operator). @item \iota -@math{\iota} +@BES{03B9,\iota} Lower case Greek letter (ordinary). @item \Join -condensed bowtie symbol (relation) @c xx not in plain +@BESU{2A1D,Join} Condensed bowtie symbol (relation). Not available in Plain +@TeX{}. @item \kappa -@math{\kappa} +@BES{03BA,\kappa} Lower case Greek letter (ordinary). @item \Lambda -@math{\Lambda} +@BES{039B,\Lambda} Upper case Greek letter (ordinary). @item \lambda -@math{\lambda} +@BES{03BB,\lambda} Lower case Greek letter (ordinary). @item \land -@math{\land} +@BES{2227,\land} Logical and (binary). This is a synonym for @code{\wedge}. +See also logical or@tie{}@code{\lor}. @item \langle -@math{\langle} (delimiter) +@BES{27E8,\langle} Left angle, or sequence, bracket (opening). Similar: +less-than@tie{}@code{<}. Matches@tie{}@code{\rangle}. @item \lbrace -@math{\lbrace} (delimiter) +@BES{007B,\lbrace} Left curly brace +(opening). Synonym:@tie{}@code{\@{}. Matches@tie{}@code{\rbrace}. @item \lbrack -@math{\lbrack} (delimiter) +@BES{005B,\lbrack} Left square bracket (opening). +Synonym:@tie{}@code{[}. Matches@tie{}@code{\rbrack}. @item \lceil -@math{\lceil} (delimiter) +@BES{2308,\lceil} Left ceiling bracket, like a square bracket but with the bottom +shaved off (opening). Matches@tie{}@code{\rceil}. @item \le -@math{\le} +@BES{2264,\le} Less than or equal to (relation). This is a synonym +for@tie{}@code{\leq}. @item \leadsto -@c xx missing from plain +@BESU{21DD,leadsto} Squiggly right arrow (relation). This is not available in +Plain @TeX{}. In @LaTeX{} you should load the @file{amssymb} package. +To get this symbol outside of math mode you can put +@code{\newcommand*@{\Leadsto@}@{\ensuremath@{\leadsto@}@}} in the +preamble and then use @code{\Leadsto} instead. +@c bb Best Unicode equivalent? @item \Leftarrow -@math{\Leftarrow} +@BES{21D0,\Leftarrow} Is implied by, double-line left arrow (relation). Similar: +single-line left arrow@tie{}@code{\leftarrow}. @item \leftarrow -@math{\leftarrow} +@BES{2190,\leftarrow} Single-line left arrow (relation). +Synonym:@tie{}@code{\gets}. Similar: double-line left +arrow@tie{}@code{\Leftarrow}. @item \leftharpoondown -@math{\leftharpoondown} +@BES{21BD,\leftharpoondown} Single-line left harpoon, barb under bar (relation). @item \leftharpoonup -@math{\leftharpoonup} +@BES{21BC,\leftharpoonup} Single-line left harpoon, barb over bar (relation). @item \Leftrightarrow -@math{\Leftrightarrow} +@BES{21D4,\Leftrightarrow} Bi-implication; double-line double-headed arrow (relation). +Similar: single-line double headed arrow@tie{}@code{\leftrightarrow}. @item \leftrightarrow -@math{\leftrightarrow} +@BES{2194,\leftrightarrow} Single-line double-headed arrow (relation). Similar: +double-line double headed arrow@tie{}@code{\Leftrightarrow}. @item \leq -@math{\leq} (relation) +@BES{2264,\leq} Less than or equal to (relation). This is a synonym +for@tie{}@code{\le}. @item \lfloor -@math{\lfloor} (delimiter) +@BES{230A,\lfloor} Left floor bracket (opening). @item \lhd -(left-pointing arrow head) @c xx not in plain +@BESU{25C1,lhd} Arrowhead, that is, triangle, pointing left (binary). This is +not available in Plain @TeX{}. In @LaTeX{} you should load the +@file{amssymb} package. For the normal subgroup symbol you should load +@file{amssymb} and use@tie{}@code{\vartriangleleft} (which is a relation +and so gives better spacing). @item \ll -@math{\ll} (relation) +@BES{226A,\ll} Much less than (relation). Similar: much greater +than@tie{}@code{\gg}. @item \lnot -@math{\lnot} +@BES{00AC,\lnot} Logical negation (ordinary). Synonym:@tie{}@code{\neg}. @item \longleftarrow -@math{\longleftarrow} +@BES{27F5,\longleftarrow} Long single-line left arrow (relation). Similar: long +double-line left arrow@tie{}@code{\Longleftarrow}. @item \longleftrightarrow -@math{\longleftrightarrow} +@BES{27F7,\longleftrightarrow} Long single-line double-headed arrow (relation). Similar: long +double-line double-headed arrow@tie{}@code{\Longleftrightarrow}. @item \longmapsto -@math{\longmapsto} +@BES{27FC,\longmapsto} Long single-line left arrow starting with vertical bar +(relation). Similar: shorter version@tie{}@code{\mapsto}. @item \longrightarrow -@math{\longrightarrow} +@BES{27F6,\longrightarrow} Long single-line right arrow (relation). Similar: long +double-line right arrow@tie{}@code{\Longrightarrow}. @item \lor -@math{\lor} +@BES{2228,\lor} Logical or (binary). Synonym: wedge@tie{}@code{\wedge}. @item \mapsto -@math{\mapsto} +@BES{21A6,\mapsto} Single-line left arrow starting with vertical bar (relation). +Similar: longer version@tie{}@code{\longmapsto}. @item \mho -@c xx not in plain +@BESU{2127,mho} Conductance, half-circle rotated capital omega (ordinary). +This is not available in Plain @TeX{}. In @LaTeX{} you should load the +@file{amssymb} package. @item \mid -@math{\mid} (relation) +@BES{2223,\mid} Single-line vertical bar (relation). A typical use of +@code{\mid} is for a set @code{\@{\, x \mid x\geq 5 \,\@}}. + +Similar: @code{\vert} and@tie{}@code{|} produce the same single-line +vertical bar symbol but without any spacing (they fall in class +ordinary) and you should not use them as relations but instead only as +ordinals, i.e., footnote symbols. For absolute value, see the entry +for@tie{}@code{\vert} and for norm see the entry for@tie{}@code{\Vert}. @item \models -@math{\models} (relation) +@BES{22A8,\models} Entails, or satisfies; double turnstile, short double dash +(relation). Similar: long double dash@tie{}@code{\vDash}. @item \mp -@math{\mp} (binary operation) +@BES{2213,\mp} Minus or plus (relation). @item \mu -@math{\mu} +@BES{03BC,\mu} Lower case Greek letter (ordinary). @item \nabla -@math{\nabla} +@BES{2207,\nabla} Hamilton's del, or differential, operator (ordinary). @item \natural -@math{\natural} +@BES{266E,\natural} Musical natural notation (ordinary). @item \ne -@math{\ne} +@BES{2260,\ne} Not equal (relation). Synonym:@tie{}@code{\neq}. @item \nearrow -@math{\nearrow} +@BES{2197,\nearrow} North-east arrow (relation). @item \neg -@math{\neg} +@BES{00AC,\neg} Logical negation (ordinary). +Synonym:@tie{}@code{\lnot}. Sometimes instead used for +negation:@tie{}@code{\sim}. @item \neq -@math{\neq} (relation) +@BES{2260,\neq} Not equal (relation). Synonym:@tie{}@code{\ne}. @item \ni -@math{\ni} (relation) +@BES{220B,\ni} Reflected membership epsilon; has the member +(relation). Synonym:@tie{}@code{\owns}. Similar: is a member +of@tie{}@code{\in}. @item \not -Overstrike a following operator with a /, as in @math{\not=}. +@BES{0020,\not}@BES{00A0,}@BES{0338,} Long solidus, or slash, used to overstrike a +following operator (relation). +@c Need blank space for it to overstrike + +Many negated operators that don't require @code{\not} are available, +particularly with the @file{amssymb} package. For example, @code{\notin} +is probably typographically preferable to @code{\not\in}. @item \notin -@math{\ni} +@BES{2209,\notin} Not an element of (relation). Similar: not subset +of@tie{}@code{\nsubseteq}. @item \nu -@math{\nu} +@BES{03BD,\nu} Lower case Greek letter (ordinary). @item \nwarrow -@math{\nwarrow} +@BES{2196,\nwarrow} North-west arrow (relation). @item \odot -@math{\odot} (binary operation) +@BES{2299,\odot} Dot inside a circle (binary). Similar: variable-sized +operator@tie{}@code{\bigodot}. @item \oint -@math{\oint} +@BES{222E,\oint} Contour integral, integral with circle in the middle (operator). @item \Omega -@math{\Omega} +@BES{03A9,\Omega} Upper case Greek letter (ordinary). @item \omega -@math{\omega} +@BES{03C9,\omega} Lower case Greek letter (ordinary). @item \ominus -@math{\ominus} (binary operation) +@BES{2296,\ominus} Minus sign, or dash, inside a circle (binary). @item \oplus -@math{\oplus} (binary operation) +@BES{2295,\oplus} Plus sign inside a circle (binary). Similar: variable-sized +operator@tie{}@code{\bigoplus}. @item \oslash -@math{\oslash} (binary operation) +@BES{2298,\oslash} Solidus, or slash, inside a circle (binary). @item \otimes -@math{\otimes} (binary operation) +@BES{2297,\otimes} Times sign, or cross, inside a circle (binary). Similar: +variable-sized operator@tie{}@code{\bigotimes}. @item \owns -@math{\owns} +@BES{220B,\owns} Reflected membership epsilon; has the member +(relation). Synonym:@tie{}@code{\ni}. Similar: is a member +of@tie{}@code{\in}. @item \parallel -@math{\parallel} (relation) +@BES{2225,\parallel} Parallel (relation). Synonym:@tie{}@code{\|}. @item \partial -@math{\partial} +@BES{2202,\partial} Partial differential (ordinary). @item \perp -@math{\perp} (relation) +@BES{27C2,\perp} Perpendicular (relation). Similar:@tie{}@code{\bot} uses the +same glyph but the spacing is different because it is in the class +ordinary. @item \phi -@math{\phi} +@BES{03D5,\phi} Lower case Greek letter (ordinary). The variant form is +@code{\varphi}@tie{}@BES{03C6,\varphi}. @item \Pi -@math{\Pi} +@BES{03A0,\Pi} Upper case Greek letter (ordinary). @item \pi -@math{\pi} +@BES{03C0,\pi} Lower case Greek letter (ordinary). The variant form is +@code{\varpi}@tie{}@BES{03D6,\varpi}. @item \pm -@math{\pm} (binary operation) +@BES{00B1,\pm} Plus or minus (binary). @item \prec -@math{\prec} (relation) +@BES{227A,\prec} Preceeds (relation). Similar: less than@tie{}@code{<}. @item \preceq -@math{\preceq} (relation) +@BES{2AAF,\preceq} Preceeds or equals (relation). Similar: less than or +equals@tie{}@code{\leq}. @item \prime -@math{\prime} +@BES{2032,\prime} Prime, or minute in a time expression (ordinary). Typically +used as a superscript @code{$A^\prime$}. Note that @code{$f^\prime$} +and @code{$f'$} produce the same result. An advantage of the second is +that @code{$f'''$} produces the the desired symbol, that is, the same +result as @code{$f^@{\prime\prime\prime@}$}, but uses somewhat less +typing. Note that you can only use @code{\prime} in math mode but you +can type right single quote@tie{}@code{'} in text mode also, although it +resuts in a different look than in math mode. @item \prod -@math{\prod} +@BES{220F,\prod} Product (operator). @item \propto -@math{\propto} (relation) +@BES{221D,\propto} Is proportional to (relation) @item \Psi -@math{\Psi} +@BES{03A8,\Psi} Upper case Greek letter (ordinary). @item \psi -@math{\psi} +@BES{03C8,\psi} Lower case Greek letter (ordinary). @item \rangle -@math{\rangle} (delimiter) +@BES{27B9,\rangle} Right angle, or sequence, bracket (closing). Similar: greater +than@tie{}@code{>}. Matches:@code{\langle}. @item \rbrace -@math{\rbrace} (delimiter) +@BES{007D,\rbrace} Right curly brace +(closing). Synonym:@tie{}@code{\@}}. Matches@tie{}@code{\lbrace}. @item \rbrack -@math{\rbrack} (delimiter) +@BES{005D,\rbrack} Right square bracket +(closing). Synonym:@tie{}@code{]}. Matches@tie{}@code{\lbrack}. @item \rceil -@math{\rceil} (delimiter) +@BES{2309,\rceil} Right ceiling bracket (closing). Matches@tie{}@code{\lceil}. @item \Re -@math{\Re} +@BES{211C,\Re} Real part, real numbers, cursive capital R (ordinary). Related: +double-line, or blackboard bold, R@tie{}@code{\mathbb@{R@}}; to access +this, load the @file{amsfonts} package. + +@item \restriction +@BESU{21BE,restriction} Restriction of a function +(relation). Synonym:@tie{}@code{\upharpoonright}. Not available in +Plain @TeX{}. In @LaTeX{} you should load the @file{amssymb} package. @item \rfloor -@math{\rfloor} +@BES{230B,\rfloor} Right floor bracket, a right square bracket with the top cut +off (closing). Matches@tie{}@code{\lfloor}. @item \rhd -(binary operation) @c xx not in plain @math{\rhd} +@BESU{25C1,rhd} Arrowhead, that is, triangle, pointing right (binary). This is +not available in Plain @TeX{}. In @LaTeX{} you should load the +@file{amssymb} package. For the normal subgroup symbol you should +instead load @file{amssymb} and use@tie{}@code{\vartriangleright} (which +is a relation and so gives better spacing). @item \rho -@math{\rho} +@BES{03C1,\rho} Lower case Greek letter (ordinary). The variant form is +@code{\varrho}@tie{}@BES{03F1,\varrho}. @item \Rightarrow -@math{\Rightarrow} +@BES{21D2,\Rightarrow} Implies, right-pointing double line arrow (relation). Similar: +right single-line arrow@tie{}@code{\rightarrow}. @item \rightarrow -@math{\rightarrow} +@BES{2192,\rightarrow} Right-pointing single line arrow (relation). Synonym:@tie{}@code{\to}. Similar: right double line arrow@tie{}@code{\Rightarrow}. @item \rightharpoondown -@math{\rightharpoondown} +@BES{21C1,\rightharpoondown} Right-pointing harpoon with barb below the line (relation). @item \rightharpoonup -@math{\rightharpoonup} +@BES{21C0,\rightharpoonup} Right-pointing harpoon with barb above the line (relation). @item \rightleftharpoons -@math{\rightleftharpoons} +@BES{21CC,\rightleftharpoons} Right harpoon up above left harpoon down (relation). @item \searrow -@math{\searrow} +@BES{2198,\searrow} Arrow pointing southeast (relation). @item \setminus -@math{\setminus} (binary operation) +@BES{29F5,\setminus} Set difference, reverse solidus or slash, like \ +(binary). Similar: backslash@tie{}@code{\backslash} and also +@code{\textbackslash} outside of math mode. @item \sharp -@math{\sharp} +@BES{266F,\sharp} Musical sharp (ordinary). @item \Sigma -@math{\Sigma} +@BES{03A3,\Sigma} Upper case Greek letter (ordinary). @item \sigma -@math{\sigma} +@BES{03C3,\sigma} Lower case Greek letter (ordinary). The variant form is +@code{\varsigma}@tie{}@BES{03C2,\varsigma}. @item \sim -@math{\sim} (relation) +@BES{223C,\sim} Similar, in a relation (relation). @item \simeq -@math{\simeq} (relation) +@BES{2243,\simeq} Similar or equal to, in a relation (relation). @item \smallint -@math{\smallint} +@BES{222B,\smallint} Integral sign that does not change to a larger size in a +display (operator). @item \smile -@math{\smile} (relation) +@BES{2323,\smile} Upward curving arc (ordinary). @item \spadesuit -@math{\spadesuit} +@BES{2660,\spadesuit} Spade card suit (ordinary). @item \sqcap -@math{\sqcap} (binary operation) +@BES{2293,\sqcap} Square intersection symbol (binary). Similar: +intersection@tie{}@code{cap}. @item \sqcup -@math{\sqcup} (binary operation) +@BES{2294,\sqcup} Square union symbol (binary). Similar: +union@tie{}@code{cup}. Related: variable-sized +operator@tie{}@code{\bigsqcup}. @item \sqsubset -(relation) @c not in plain (@math{\sqsubset}) +@BESU{228F,sqsubset} Square subset symbol (relation). Similar: +subset@tie{}@code{\subset}. This is not available in Plain @TeX{}. In +@LaTeX{} you should load the @file{amssymb} package. @item \sqsubseteq -@math{\sqsubseteq} (relation) +@BES{2291,\sqsubseteq} Square subset or equal symbol (binary). Similar: subset or +equal to@tie{}@code{\subseteq}. @item \sqsupset -(relation) @c not in plain (@math{\sqsupset}) +@BESU{2290,sqsupset} Square superset symbol (relation). Similar: +superset@tie{}@code{\supset}. This is not available in Plain @TeX{}. In +@LaTeX{} you should load the @file{amssymb} package. @item \sqsupseteq -@math{\sqsupseteq} (relation) +@BES{2292,\sqsupseteq} Square superset or equal symbol (binary). Similar: superset or +equal@tie{}@code{\supseteq}. @item \star -@math{\star} (binary operation) +@BES{22C6,\star} Five-pointed star, sometimes used as a general binary operation +but sometimes reserved for cross-correlation (binary). Similar: the +synonyms asterisk@tie{}@code{*} and @code{\ast}, which are six-pointed, +and more often appear as a superscript or subscript, as with the Kleene +star. @item \subset -@math{\subset} (relation) +@BES{2282,\subset} Subset (occasionally, is implied by) (relation). @item \subseteq -@math{\subseteq} (relation) +@BES{2286,\subseteq} Subset or equal to (relation). @item \succ -@math{\succ} (relation) +@BES{227B,\succ} Comes after, succeeds (relation). Similar: is less +than@tie{}@code{>}. @item \succeq -@math{\succeq} (relation) +@BES{2AB0,\succeq} Succeeds or is equal to (relation). Similar: less +than or equal to@tie{}@code{\leq}. @item \sum -@math{\sum} +@BES{2211,\sum} Summation (operator). Similar: Greek capital +sigma@tie{}@code{\Sigma}. @item \supset -@math{\supset} (relation) +@BES{2283,\supset} Superset (relation). @item \supseteq -@math{\supseteq} (relation) +@BES{2287,\supseteq} Superset or equal to (relation). @item \surd -@math{\surd} +@BES{221A,\surd} Radical symbol (ordinary). The @LaTeX{} command +@code{\sqrt@{..@}} typesets the square root of the argument, with a bar +that extends to cover the argument. @item \swarrow -@math{\swarrow} +@BES{2199,\swarrow} Southwest-pointing arrow (relation). @item \tau -@math{\tau} +@BES{03C4,\tau} Lower case Greek letter (ordinary). @item \theta -@math{\theta} +@BES{03B8,\theta} Lower case Greek letter (ordinary). The variant form is +@code{\vartheta}@tie{}@BES{03D1,\vartheta}. @item \times -@math{\times} (binary operation) +@BES{00D7,\times} Primary school multiplication sign (binary). See +also@tie{}@code{\cdot}. @item \to -@math{\to} +@BES{2192,\to} Right-pointing single line arrow (relation). +Synonym:@tie{}@code{\rightarrow}. @item \top -@math{\top} +@BESU{22A4,top} Top, greatest element of a poset (ordinary). See +also@tie{}@code{\bot}. @item \triangle -@math{\triangle} +@BES{25B3,\triangle} Triangle (ordinary). @item \triangleleft -@math{\triangleleft} (binary operation) +@BES{25C1,\triangleleft} Not-filled triangle pointing left +(binary). Similar:@tie{}@code{\lhd}. For the normal subgroup symbol you +should load @file{amssymb} and use@tie{}@code{\vartriangleleft} (which +is a relation and so gives better spacing). @item \triangleright -@math{\triangleright} (binary operation) +@BES{25B7,\triangleright} Not-filled triangle pointing right (binary). For the normal +subgroup symbol you should instead load @file{amssymb} and +use@tie{}@code{\vartriangleright} (which is a relation and so gives +better spacing). @item \unlhd -left-pointing arrowhead with line under (binary operation) @c not in plain +@BESU{22B4,unlhd} Left-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain @TeX{}. In @LaTeX{} +you should load the @file{amssymb} package. For the normal subgroup +symbol load @file{amssymb} and use@tie{}@code{\vartrianglelefteq} (which +is a relation and so gives better spacing). @item \unrhd -right-pointing arrowhead with line under (binary operation) @c not in plain +@BESU{22B5,unrhd} Right-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain @TeX{}. In @LaTeX{} +you should load the @file{amssymb} package. For the normal subgroup +symbol load @file{amssymb} and use@tie{}@code{\vartrianglerighteq} +(which is a relation and so gives better spacing). @item \Uparrow -@math{\Uparrow} (delimiter) +@BES{21D1,\Uparrow} Double-line upward-pointing arrow (relation). Similar: +single-line up-pointing arrow@tie{}@code{\uparrow}. @item \uparrow -@math{\uparrow} (delimiter) +@BES{2191,\uparrow} Single-line upward-pointing arrow, diverges (relation). Similar: +double-line up-pointing arrow@tie{}@code{\Uparrow}. @item \Updownarrow -@math{\Updownarrow} (delimiter) +@BES{21D5,\Updownarrow} Double-line upward-and-downward-pointing arrow (relation). Similar: +single-line upward-and-downward-pointing arrow@tie{}@code{\updownarrow}. @item \updownarrow -@math{\updownarrow} (delimiter) +@BES{2195,\updownarrow} Single-line upward-and-downward-pointing arrow (relation). Similar: +double-line upward-and-downward-pointing arrow@tie{}@code{\Updownarrow}. + +@item \upharpoonright +@BESU{21BE,upharpoonright} Up harpoon, with barb on right side +(relation). Synonym:@tie{}@code{@backslashchar{}restriction}. Not available in Plain +@TeX{}. In @LaTeX{} you should load the @file{amssymb} package. @item \uplus -@math{\uplus} (binary operation) +@BES{228E,\uplus} Multiset union, a union symbol with a plus symbol in the middle +(binary). Similar: union@tie{}@code{\cup}. Related: variable-sized +operator@tie{}@code{\biguplus}. @item \Upsilon -@math{\Upsilon} +@BES{03A5,\Upsilon} Upper case Greek letter (ordinary). @item \upsilon -@math{\upsilon} +@BES{03C5,\upsilon} Lower case Greek letter (ordinary). @item \varepsilon -@math{\varepsilon} +@BES{03B5,\varepsilon} Rounded small epsilon (ordinary). This is more widely used in +mathematics than the non-variant lower case Greek-text letter form +@code{\epsilon}@tie{}@BES{03F5,\epsilon}. Related: set membership@tie{}@code{\in}. @item \varphi -@math{\varphi} +@BES{03C6,\varphi} Variant on the lower case Greek letter (ordinary). The +non-variant form is @code{\phi}@tie{}@BES{03D5,\phi}. @item \varpi -@math{\varpi} +@BES{03D6,\varpi} Variant on the lower case Greek letter (ordinary). The +non-variant form is @code{\pi}@tie{}@BES{03C0,\pi}. @item \varrho -@math{\varrho} +@BES{03F1,\varrho} Variant on the lower case Greek letter (ordinary). The +non-variant form is @code{\rho}@tie{}@BES{03C1,\rho}. @item \varsigma -@math{\varsigma} +@BES{03C2,\varsigma} Variant on the lower case Greek letter (ordinary). The +non-variant form is @code{\sigma}@tie{}@BES{03C3,\sigma}. @item \vartheta -@math{\vartheta} +@BES{03D1,\vartheta} Variant on the lower case Greek letter (ordinary). The +non-variant form is @code{\theta}@tie{}@BES{03B8,\theta}. @item \vdash -@math{\vdash} (relation) +@BES{22A2,\vdash} Provable; turnstile, vertical and a dash (relation). Similar: +turnstile rotated a half-circle@tie{}@code{\dashv}. @item \vee -@math{\vee} (binary operation) +@BES{2228,\vee} Logical or; a downwards v shape (binary). Related: logical +and@tie{}@code{\wedge}. Similar: variable-sized +operator@tie{}@code{\bigvee}. @item \Vert -@math{\Vert} (delimiter) +@BES{2016,\Vert} Vertical double bar (ordinary). Similar: vertical single +bar@tie{}@code{\vert}. + +For a norm you can use the @file{mathtools} package and add +@code{\DeclarePairedDelimiter\norm@{\lVert@}@{\rVert@}} to your +preamble. This gives you three command variants for double-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version @code{$\norm*@{M^\perp@}$} then the height of +the vertical bars will match the height of the argument, whereas with +@code{\norm@{M^\perp@}} the bars do not grow with the height of the +argument but instead are the default height, and @code{\norm[@var{size +command}]@{M^\perp@}} also gives bars that do not grow but are set to +the size given in the @var{size command}, e.g., @code{\Bigg}. @item \vert -@math{\vert} (delimiter) +@BES{007C,\vert} Single line vertical bar (ordinary). Similar: double-line +vertical bar@tie{}@code{\Vert}. For such that, as in the definition of a +set, use@tie{}@code{\mid} because it is a relation. + +For absolute value you can use the @file{mathtools} package and add +@code{\DeclarePairedDelimiter\abs@{\lvert@}@{\rvert@}} to your +preamble. This gives you three command variants for single-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version @code{$\abs*@{\frac@{22@}@{7@}@}$} then the +height of the vertical bars will match the height of the argument, +whereas with @code{\abs@{\frac@{22@}@{7@}@}} the bars do not grow with +the height of the argument but instead are the default height, and +@code{\abs[@var{size command}]@{\frac@{22@}@{7@}@}} also gives bars +that do not grow but are set to the size given in the @var{size +command}, e.g., @code{\Bigg}. @item \wedge -@math{\wedge} (binary operation) +@BES{2227,\wedge} Logical and (binary). Synonym:@tie{}@code{\land}. See also +logical or @code{\vee}. Similar: variable-sized +operator@tie{}@code{\bigwedge}. @item \wp -@math{\wp} +@BES{2118,\wp} Weierstrass p (ordinary). @item \wr -@math{\wr} (binary operation) +@BES{2240,\wr} Wreath product (binary). @item \Xi -@math{\Xi} +@BES{039E,\Xi} Upper case Greek letter (ordinary). @item \xi -@math{\xi} +@BES{03BE,\xi} Lower case Greek letter (ordinary). @item \zeta -@math{\zeta} +@BES{03B6,\zeta} Lower case Greek letter (ordinary). @end ftable @node Math functions @section Math functions + @cindex math functions @cindex functions, math @@ -5050,10 +7077,10 @@ Binary modulo operator (@math{x \bmod y}) @math{\cosh} @item \cot -@math{\cos} +@math{\cot} @item \coth -@math{\cosh} +@math{\coth} @item \csc @math{\csc} @@ -5062,7 +7089,7 @@ Binary modulo operator (@math{x \bmod y}) @math{\deg} @item \det -@math{\deg} +@math{\det} @item \dim @math{\dim} @@ -5138,6 +7165,7 @@ sup @node Math accents @section Math accents + @cindex math accents @cindex accents, mathematical @@ -5206,8 +7234,8 @@ Math vector symbol: @math{\vec{x}}. @cindex wide hat accent, math Math wide hat accent: @math{\widehat{x+y}}. -@item \widehat -@cindex wide tile accent, math +@item \widetilde +@cindex wide tilde accent, math Math wide tilde accent: @math{\widetilde{x+y}}. @end ftable @@ -5215,37 +7243,72 @@ Math wide tilde accent: @math{\widetilde{x+y}}. @node Spacing in math mode @section Spacing in math mode + @cindex spacing within math mode @cindex math mode, spacing -In a @code{math} environment, @LaTeX{} ignores the spaces you type and -puts in the spacing according to the normal rules for mathematics -texts. If you want different spacing, @LaTeX{} provides the following -commands for use in math mode: +In a @code{math} environment, @LaTeX{} ignores the spaces that you use +in the source, and instead puts in the spacing according to the normal +rules for mathematics texts. + +Many math mode spacing definitions are expressed in terms of the math unit +@dfn{mu} given by 1 em = 18 mu, where the em is taken from the current +math symbols family (@pxref{Units of length}). +@LaTeX{} provides the following commands for use in math mode: @table @code @item \; @findex \; -A thick space (@math{5\over18\,}quad). +@findex \thickspace +Normally @code{5.0mu plus 5.0mu}. The longer name is +@code{\thickspace}. Math mode only. + @item \: @itemx \> @findex \: @findex \> -Both of these produce a medium space (@math{2\over9\,}quad). +@findex \medspace +Normally @code{4.0mu plus 2.0mu minus 4.0mu}. The longer name is +@code{\medspace}. Math mode only. + @item \, @findex \, -A thin space (@math{1\over6\,}quad); not restricted to math mode. +@findex \thinspace +Normally @code{3mu}. The longer name is @code{\thinspace}. This can +be used in both math mode and text mode. + @item \! -A negative thin space (@math{-{1\over6}\,}quad). +@findex \! +A negative thin space. Normally @code{-3mu}. Math mode only. + +@item \quad +@cindex quad +@findex \quad +This is 18@dmn{mu}, that is, 1@dmn{em}. This is often used for space +surrounding equations or expressions, for instance for the space between +two equations inside a @code{displaymath} environment. It is available +in both text and math mode. + +@item \qquad +@findex \qquad +A length of 2 quads, that is, 36@dmn{mu} = 2@dmn{em}. It is available in +both text and math mode. @end table +In this example a thinspace separates the function from the +infinitesimal. + +@example +\int_0^1 f(x)\,dx +@end example + @node Math miscellany @section Math miscellany + @cindex math miscellany @ftable @code - @item \* @cindex discretionary multiplication @cindex multiplication symbol, discretionary line break @@ -5334,6 +7397,7 @@ $\vdots$. @node Modes @chapter Modes + @cindex modes @cindex paragraph mode @cindex math mode @@ -5385,6 +7449,7 @@ mode, which it starts out in, is called ``outer paragraph mode''. @node Page styles @chapter Page styles + @cindex styles, page @cindex page styles @@ -5401,6 +7466,7 @@ the page's head and foot. The page style determines what goes in them. @node \maketitle @section @code{\maketitle} + @cindex titles, making @findex \maketitle @@ -5442,6 +7508,7 @@ document. Use @code{\\} to force a line break, as usual. @node \pagenumbering @section @code{\pagenumbering} + @findex \pagenumbering @cindex page numbering style @@ -5475,6 +7542,7 @@ uppercase letters @node \pagestyle @section @code{\pagestyle} + @findex \pagestyle @cindex header style @cindex footer style @@ -5525,6 +7593,7 @@ Sets the right heading, leaving the left heading unchanged. @node \thispagestyle @section @code{\thispagestyle@{@var{style}@}} + @findex \thispagestyle The @code{\thispagestyle} command works in the same manner as the @@ -5534,24 +7603,22 @@ changes to @var{style} for the current page only. @node Spaces @chapter Spaces + @cindex spaces +@cindex white space @LaTeX{} has many ways to produce white (or filled) space. -Another space-producing command is @code{\,} to produce a ``thin'' -space (usually 1/6@dmn{quad}). It can be used in text mode, but is -more often useful in math mode (@pxref{Spacing in math mode}). - @menu -Horizontal space -* \hspace:: Fixed horizontal space. -* \hfill:: Stretchable horizontal space. -* \SPACE:: Normal interword space. -* \@@:: Ending a sentence. -* \thinspace:: One-sixth of an em. -* \/:: Insert italic correction. -* \hrulefill:: Stretchable horizontal rule. -* \dotfill:: Stretchable horizontal dots. +Horizontal space +* \hspace:: Fixed horizontal space. +* \hfill:: Stretchable horizontal space. +* \(SPACE) and \@@:: Space after a period. +* \(SPACE) after CS:: Controlling space gobbling after a control sequence. +* \frenchspacing:: Make interword and intersentence space equal. +* \thinspace:: One-sixth of an em. +* \/:: Insert italic correction. +* \hrulefill \dotfill:: Stretchable horizontal rule or dots. Vertical space * \addvspace:: Add arbitrary vertical space if needed. @@ -5563,83 +7630,163 @@ Vertical space @node \hspace @section @code{\hspace} + @findex \hspace Synopsis: @example -\hspace[*]@{@var{length}@} +\hspace@{@var{length}@} +\hspace*@{@var{length}@} @end example -The @code{\hspace} command adds horizontal space. The @var{length} -argument can be expressed in any terms that @LaTeX{} understands: -points, inches, etc. It is a rubber length. You can add both -negative and positive space with an @code{\hspace} command; adding -negative space is like backspacing. +Add the horizontal space given by @var{length}. The @var{length} is a +rubber length, that is, it may contain a @code{plus} or @code{minus} +component, in any unit that @LaTeX{} understands (@pxref{Lengths}). -@LaTeX{} normally removes horizontal space that comes at the beginning -or end of a line. To preserve this space, use the optional @code{*} -form. +This command can add both positive and negative space; adding negative +space is like backspacing. + +Normally when @TeX{} breaks a paragraph into lines it discards white +space (glues and kerns) that would come at the start of a line, so you +get an inter-word space or a line break between words but not both. This +command's starred version @code{\hspace*@{..@}} puts a non-discardable +invisible item in front of the space, so the space appears in the +output. + +This example make a one-line paragraph that puts @samp{Name:} an inch +from the right margin. + +@example +\noindent\makebox[\linewidth]@{\hspace@{\fill@}Name:\hspace@{1in@}@} +@end example @node \hfill @section @code{\hfill} + @findex \hfill @cindex stretch, infinite horizontal @cindex infinite horizontal stretch -The @code{\hfill} fill command produces a ``rubber length'' which has -no natural space but can stretch or shrink horizontally as far as -needed. +Produce a rubber length which has +no natural space but can stretch horizontally as far as +needed (@pxref{Lengths}). @findex \fill -The @code{\fill} parameter is the rubber length itself (technically, -the glue value @samp{0pt plus1fill}); thus, @code{\hspace\fill} is -equivalent to @code{\hfill}. +The command @code{\hfill} is equivalent to @code{\hspace@{\fill@}}. For +space that does not disappear at line breaks use +@code{\hspace*@{\fill@}} instead (@pxref{\hspace}). -@node \SPACE -@section @code{\SPACE}: Normal interword space -@findex \SPACE +@node \(SPACE) and \@@ +@section @code{\(SPACE)} and \@@ + +@findex \(SPACE) @findex \TAB @findex \NEWLINE +@findex \@@ +@anchor{\AT}@c old name -The @code{\ } (space) command produces a normal interword space. It's -useful after punctuation which shouldn't end a sentence. For example, -@code{the article in Proc.\ Amer.\ Math\. Soc.\ is fundamental}. It -is also often used after control sequences, as in @code{\TeX\ is a -nice system.} - -In normal circumstances, @code{\}@key{tab} and @code{\}@key{newline} -are equivalent to @code{\ }. +Mark a punctuation character, typically a period, as either ending a +sentence or as ending an abbreviation. + +By default, in justifying a line @LaTeX{} adjusts the space after a +sentence-ending period (or a question mark, exclamation point, comma, or +colon) more than the space between words +(@pxref{\frenchspacing}). @LaTeX{} assumes that the period ends a +sentence unless it is preceded by a capital letter, in which case it +takes that period for part of an abbreviation. Note that if a +sentence-ending period is immediately followed by a right parenthesis or +bracket, or right single or double quote, then the intersentence space +follows that parenthesis or quote. + +If you have a period ending an abbreviation whose last letter is not a +capital letter, and that abbreviation is not the last word in the +sentence, then follow that period with a backslash-space (@code{\ }) or +a tie (@code{~}). Examples are @code{Nat.\ Acad.\ Science}, and +@code{Mr.~Bean}, and @code{(manure, etc.)\ for sale}. + +For other use of @code{\ }, see also @ref{\(SPACE) after CS}. + +In the opposite situation, if you have a capital letter followed by a +period that ends the sentence, then put @code{\@@} on the left of that +period. For example, @code{book by the MAA\@@.} will have intersentence +spacing after the period. + +In contrast, putting @code{\@@} on the right of a period tells @TeX{} +that the period does not end the sentence. In the example +@code{reserved words (if, then, etc.\@@) are different}, @TeX{} will put +interword space after the closing parenthesis (note that @code{\@@} is +before the parenthesis). + +@node \(SPACE) after CS +@section @code{\ } after a control sequence + +The @code{\ } command is often used after control sequences to keep them +from gobbling the space that follows, as in @code{\TeX\ is a nice +system.} And, under normal circumstances @code{\}@key{tab} and +@code{\}@key{newline} are equivalent to @code{\ }. For other use of +@code{\ }, see also @ref{\(SPACE) and \@@}. + +Some people prefer to use @code{@{@}} for the same purpose, as in +@code{\TeX@{@} is a nice system.} This has the advantage that you can +always write it the same way, like @code{\TeX@{@}}, whether it is +followed by a space or by a punctuation mark. Please compare: +@example +\TeX\ is a nice system. \TeX, a nice system.@* +\TeX@{@} is a nice system. \TeX@{@}, a nice system. +@end example -@node \@@ -@section @code{\@@}: Force sentence-ending punctuation -@findex \@@ -@anchor{\AT}@c old name -The @code{\@@} command makes the following punctuation character end a -sentence even if it normally would not. This is typically used after -a capital letter. Here are side-by-side examples with and without -@code{\@@}: +When you define user commands (@pxref{\newcommand & \renewcommand}) you +can prevent the space gobbling after the command by using the package +@code{xspace} and inserting @code{\xspace} at the end of the definition +For instance: +@example +\documentclass@{minimal@} +\usepackage@{xspace@} +\newcommand*@{\Loup@}@{Grand Cric\xspace@} +\begin@{document@} +Que le \Loup me croque ! +\end@{document@} +@end example +A quick hack to use @code{\xspace} for existing command is as follows: @example -@dots{} in C\@@. Pascal, though @dots{} -@dots{} in C. Pascal, though @dots{} +\documentclass@{minimal@} +\usepackage@{xspace@} +\newcommand*@{\SansXspaceTeX@}@{@} +\let\SansXspaceTeX\TeX +\renewcommand@{\TeX@}@{\SansXspaceTeX\xspace@} +\begin@{document@} +\TeX is a nice system. +\end@{document@} @end example -@noindent produces -@c Texinfo has different commands, but the result is the same. -@quotation -@dots{} in C@. Pascal, though @dots{}@* -@dots{} in C. Pascal, though @dots{} -@end quotation +@node \frenchspacing +@section @code{\frenchspacing} + +@findex \frenchspacing +@findex \nonfrenchspacing +@cindex spacing, intersentence + +This declaration (from Plain @TeX{}) causes @LaTeX{} to treat +intersentence spacing in the same way as interword spacing. + +In justifying the text in a line, some typographic traditions, including +English, prefer to adjust the space between sentences (or after other +punctuation marks) more than the space between words. Following this +declaration, all spaces are instead treated equally. + +Revert to the default behavior by declaring @code{\nonfrenchspacing}. @node \thinspace @section @code{\thinspace}: Insert 1/6@dmn{em} + @findex \thinspace @code{\thinspace} produces an unbreakable and unstretchable space that @@ -5649,6 +7796,7 @@ quotes, as in '@dmn{}''.@c Abuse @dmn, which is a thin space in Texinfo. @node \/ @section @code{\/}: Insert italic correction + @findex \/ @cindex italic correction @@ -5688,38 +7836,62 @@ There is no concept of italic correction in math mode; spacing is done in a different way. -@node \hrulefill -@section @code{\hrulefill} +@node \hrulefill \dotfill +@section @code{\hrulefill \dotfill} + @findex \hrulefill +@findex \dotfill -The @code{\hrulefill} fill command produces a ``rubber length'' which can -stretch or shrink horizontally. It will be filled with a horizontal -rule. +Produce an infinite rubber length (@pxref{Lengths}) filled with a +horizontal rule (that is, a line) or with dots, instead of just white +space. +When placed between blank lines this example creates a paragraph that is +left and right justified, where the space in the middle is filled with +evenly spaced dots. -@node \dotfill -@section @code{\dotfill} +@example +\noindent Jack Aubrey\dotfill Melbury Lodge +@end example -@findex \dotfill +To make the rule or dots go to the line's end use @code{\null} at the +start or end. -The @code{\dotfill} command produces a ``rubber length'' that fills -with dots instead of just white space. +To change the rule's thickness, copy the definition and adjust it, as +with @code{\renewcommand@{\hrulefill@}@{\leavevmode\leaders\hrule height +1pt\hfill\kern\z@@@}}, which changes the default thickness of +0.4@dmn{pt} to 1@dmn{pt}. Similarly, adjust the dot spacing as with +@code{\renewcommand@{\dotfill@}@{\leavevmode\cleaders\hb@@xt@@ +1.00em@{\hss .\hss @}\hfill\kern\z@@@}}, which changes the default +length of 0.33@dmn{em} to 1.00@dmn{em}. -@c xx undone @node \addvspace @section @code{\addvspace} + @findex \addvspace @cindex vertical space @cindex space, inserting vertical -@code{\addvspace@{length@}} +@code{\addvspace@{@var{length}@}} + +Add a vertical space of height @var{length}, which is a rubber length +(@pxref{Lengths}). However, if vertical space has already been added to +the same point in the output by a previous @code{\addvspace} command +then this command will not add more space than what is needed to make +the natural length of the total vertical space equal to @var{length}. + +Use this command to adjust the vertical space above or below an +environment that starts a new paragraph. (For instance, a Theorem +environment is defined to begin and end in @code{\addvspace@{..@}} so +that two consecutive Theorem's are separated by one vertical space, not +two.) -The @code{\addvspace} command normally adds a vertical space of height -length. However, if vertical space has already been added to the same -point in the output by a previous @code{\addvspace} command, then this -command will not add more space than is needed to make the natural -length of the total vertical space equal to @code{length}. +This command is fragile (@pxref{\protect}). + +The error @samp{Something's wrong--perhaps a missing \item} means that +you were not in vertical mode when you invoked this command; one way to +change that is to precede this command with a @code{\par} command. @node \bigskip \medskip \smallskip @@ -5756,32 +7928,70 @@ quarter of a line space, with stretch and shrink (the default for the @node \vfill @section @code{\vfill} + @findex \vfill @cindex stretch, infinite vertical @cindex infinite vertical stretch -The @code{\vfill} fill command produces a rubber length (glue) which -can stretch or shrink vertically as far as needed. It's equivalent to -@code{\vspace@{\fill@}} (@pxref{\hfill}). +End the current paragraph and insert a vertical rubber length +(@pxref{Lengths}) that is infinite, so it can stretch or shrink as far +as needed. + +It is often used in the same way as @code{\vspace@{\fill@}}, except that +@code{\vfill} ends the current paragraph, whereas +@code{\vspace@{\fill@}} adds the infinite vertical space below its line +irrespective of the paragraph structure. In both cases that space will +disappear at a page boundary; to circumvent this see@tie{}@ref{\vspace}. + +In this example the page is filled, so the top and bottom lines contain +the text @samp{Lost Dog!} and the third @samp{Lost Dog!} is exactly +halfway between them. + +@example +\begin@{document@} +Lost Dog! +\vfill +Lost Dog! +\vfill +Lost Dog! +\end@{document@} +@end example @node \vspace -@section @code{\vspace[*]@{@var{length}@}} +@section @code{\vspace@{@var{length}@}} + @findex \vspace +@cindex vertical space +@cindex space, vertical -Synopsis: +Synopsis, one of these two: @example -\vspace[*]@{@var{length}@} +\vspace@{@var{length}@} +\vspace*@{@var{length}@} @end example -The @code{\vspace} command adds the vertical space @var{length}, i.e., -a rubber length. @var{length} can be negative or positive. +Add the vertical space @var{length}. This can be negative or positive, +and is a rubber length (@pxref{Lengths}). + +@LaTeX{} removes the vertical space from @code{\vfill} at a page break, +that is, at the top or bottom of a page. The starred version +@code{\vspace*@{..@}} causes the space to stay. -Ordinarily, @LaTeX{} removes vertical space added by @code{\vspace} at -the top or bottom of a page. With the optional @code{*} argument, the -space is not removed. +In this example the two questions will be evenly spaced vertically on +the page, with at least one inch of space below each. + +@example +\begin@{document@} +1) Who put the bomp in the bomp bah bomp bah bomp? +\vspace@{1in plus 1fill@} + +2) Who put the ram in the rama lama ding dong? +\vspace@{1in plus 1fill@} +\end@{document@} +@end example @node Boxes @@ -5807,6 +8017,7 @@ used in the arguments of the box-making commands. @node \mbox @section @code{\mbox@{@var{text@}}} + @findex \mbox @cindex hyphenation, preventing @@ -5848,6 +8059,7 @@ Both commands produce a rule of thickness @code{\fboxrule} (default @node lrbox @section @code{lrbox} + @findex lrbox @code{\begin@{lrbox@}@{cmd@} text \end@{lrbox@}} @@ -5860,6 +8072,7 @@ must have been declared with @code{\newsavebox}. @node \makebox @section @code{\makebox} + @findex \makebox Synopsis: @@ -5869,7 +8082,7 @@ Synopsis: @end example The @code{\makebox} command creates a box just wide enough to contain -the @var{text} specified. The width of the box is specified by the +the @var{text} specified. The width of the box can be overridden by the optional @var{width} argument. The position of the text within the box is determined by the optional @var{position} argument, which may take the following values: @@ -5886,12 +8099,13 @@ Stretch (justify) across entire @var{width}; @var{text} must contain stretchable space for this to work. @end table -@code{\makebox} is also used within the picture environment +@code{\makebox} is also used within the @code{picture} environment @pxref{\makebox (picture)}. @node \parbox @section @code{\parbox} + @findex \parbox Synopsis: @@ -5941,6 +8155,7 @@ for this to work. @node \raisebox @section @code{\raisebox} + @findex \raisebox Synopsis: @@ -5962,6 +8177,7 @@ ignoring its natural height and depth. @node \savebox @section @code{\savebox} + @findex \savebox Synopsis: @@ -5978,6 +8194,7 @@ declared with @code{\newsavebox} (@pxref{\newsavebox}). @node \sbox @section @code{\sbox@{@var{\boxcmd}@}@{@var{text}@}} + @findex \sbox Synopsis: @@ -5995,6 +8212,7 @@ included in the normal output, it is saved in the box labeled @node \usebox @section @code{\usebox@{@var{\boxcmd}@}} + @findex \usebox Synopsis: @@ -6010,6 +8228,9 @@ Synopsis: @node Special insertions @chapter Special insertions +@cindex special insertions +@cindex insertions of special characters + @LaTeX{} provides commands for inserting characters that have a special meaning do not correspond to simple characters you can type. @@ -6025,6 +8246,7 @@ special meaning do not correspond to simple characters you can type. @node Reserved characters @section Reserved characters + @cindex reserved characters @cindex characters, reserved @@ -6077,13 +8299,14 @@ with @code{"}, so the previous example could also be written as @section Text symbols @cindex text symbols +@cindex symbols, text + @findex textcomp @r{package} @LaTeX{} provides commands to generate a number of non-letter symbols in running text. Some of these, especially the more obscure ones, are not available in OT1; you may need to load the @code{textcomp} package. @ftable @code - @item \copyright @itemx \textcopyright @cindex copyright symbol @@ -6251,7 +8474,7 @@ Em-dash: --- (for punctuation). @item \textendash @r{(or @code{--})} @cindex e-dash -En-dash: --- (for ranges). +En-dash: -- (for ranges). @item \texteuro @cindex euro symbol @@ -6431,7 +8654,8 @@ Produces a tilde accent over the following, as in @~{n}. @item \b @findex \b @r{(bar-under accent)} @cindex bar-under accent -Produces a bar accent under the following, as in @ubaraccent{o}. +Produces a bar accent under the following, as in @ubaraccent{o}. See +also @code{\underbar} hereinafter. @item \c @itemx \capitalcedilla @@ -6505,6 +8729,7 @@ Not exactly an accent, this produces a bar under the argument text. The argument is always processed in horizontal mode. The bar is always a fixed position under the baseline, thus crossing through descenders. See also @code{\underline} in @ref{Math miscellany}. +See also @code{\b} above. @item \v @itemx \capitalcaron @@ -6530,7 +8755,6 @@ Here are the basic @LaTeX{} commands for inserting characters commonly used in languages other than English. @table @code - @item \aa @itemx \AA @findex \aa (@aa{}) @@ -6614,6 +8838,7 @@ Icelandic letter thorn: @th{} and @TH{}. @node \rule @section @code{\rule} + @findex \rule Synopsis: @@ -6639,7 +8864,9 @@ The thickness of the rule (mandatory). @node \today @section @code{\today} + @findex \today +@cindex date, today's The @code{\today} command produces today's date, in the format @samp{@var{month} @var{dd}, @var{yyyy}}; for example, `July 4, 1976'. @@ -6654,6 +8881,7 @@ of other date formats. @node Splitting the input @chapter Splitting the input + @cindex splitting the input file @cindex input file @@ -6675,6 +8903,7 @@ external file to be created with the main document. @node \include @section @code{\include} + @findex \include Synopsis: @@ -6699,6 +8928,7 @@ read by another @code{\include} command. @node \includeonly @section \@code{includeonly} + @findex \includeonly Synopsis: @@ -6717,7 +8947,8 @@ This command can only appear in the preamble. @node \input -@section \input +@section @code{\input} + @findex \input Synopsis: @@ -6735,6 +8966,7 @@ If @var{file} does not end in @samp{.tex} (e.g., @samp{foo} or or @samp{foo.bar.tex}). If that is not found, the original @var{file} is tried (@samp{foo} or @samp{foo.bar}). + @node Front/back matter @chapter Front/back matter @@ -6782,7 +9014,8 @@ The command @code{\nofiles} overrides these commands, and @node \addcontentsline -@subsection \addcontentsline +@subsection @code{\addcontentsline} + @findex \addcontentsline@{@var{ext}@}@{@var{unit}@}@{@var{text}@} @cindex table of contents entry, manually adding @@ -6821,7 +9054,8 @@ command @code{\contentsline@{@var{unit}@}@{@var{name}@}}. @node \addtocontents -@subsection \addtocontents +@subsection @code{\addtocontents} + @findex \addtocontents@{@var{ext}@}@{@var{text}@} The @code{\addtocontents}@{@var{ext}@}@{@var{text}@} command adds text @@ -6841,6 +9075,7 @@ The text to be written. @node Glossaries @section Glossaries + @cindex glossaries @findex \makeglossary @@ -6863,6 +9098,7 @@ glossaries. @node Indexes @section Indexes + @cindex indexes @findex \makeindex @@ -6925,77 +9161,142 @@ The @code{multind} package supports multiple indexes. See also the @node Letters @chapter Letters -@cindex letters -@cindex creating letters -You can use @LaTeX{} to typeset letters, both personal and business. The -@code{letter} document class is designed to make a number of letters at -once, although you can make just one if you so desire. +@cindex letters, writing +@cindex writing letters -Your @file{.tex} source file has the same minimum commands as the other -document classes, i.e., you must have the following commands as a -minimum: +Synopsis: @example - \documentclass@{letter@} - \begin@{document@} - ... letters ... - \end@{document@} +\documentclass@{letter@} +\address@{@var{sender address}@} +\signature@{@var{sender name}@} +\begin@{document@} +\begin@{letter@}@{@var{recipient address}@} +\opening@{@var{salutation}@} + @var{letter body} +\closing@{@var{closing text}@} +\end@{letter@} + ... more letters ... +\end@{document@} @end example -Each letter is a @code{letter} environment, whose argument is the name -and address of the recipient. For example, you might have: +Produce one or more letters. + +Each letter is in a separate @code{letter} environment, whose argument +@var{recipient address} often contains multiple lines separated with a +double backslash@tie{}(@code{\\}). For example, you might have: @example - \begin@{letter@}@{Mr. Joe Smith\\ 2345 Princess St. - \\ Edinburgh, EH1 1AA@} + \begin@{letter@}@{Mr. Joe Smith \\ + 2345 Princess St. \\ + Edinburgh, EH1 1AA@} ... \end@{letter@} @end example -The letter itself begins with the @code{\opening} command. The text of -the letter follows. It is typed as ordinary @LaTeX{} input. Commands that -make no sense in a letter, like @code{\chapter}, do not work. The letter -closes with a @code{\closing} command. +The start of the @code{letter} environment resets the page number to 1, +and the footnote number to 1 also. + +The @var{sender address} and @var{sender name} are common to all of the +letters, whether there is one or more, so these are best put in the +preamble. As with the recipient address, often @var{sender address} +contains multiple lines separated by a double +backslash@tie{}(@code{\\}). @LaTeX{} will put the @var{sender name} +under the closing, after a vertical space for the traditional +hand-written signature; it also can contain multiple lines. + +Each letter environment begins with a required @code{\opening} command +such as @code{\opening@{Dear Madam or Sir:@}}. The @var{letter body} +text is ordinary @LaTeX{} so it can contain everything from from +enumerated lists to displayed math, except that commands such as +@code{\chapter} that make no sense in a letter are turned off. Each +letter environment typically ends with a @code{\closing} command such as +@code{\closing@{Yours,@}}. @findex \\ @r{for letters} -After the @code{closing}, you can have additional material. The -@code{\cc} command produces the usual ``cc: @dots{}''. There's also a -similar @code{\encl} command for a list of enclosures. With both these -commands, use @code{\\} to separate the items. +Additional material may come after the @code{\closing}. You can say who +is receiving a copy of the letter with a command like @code{\cc@{the +Boss \\ the Boss's Boss@}}. There's a similar @code{\encl} command for +a list of enclosures. And, you can add a postscript with @code{\ps}. + +@LaTeX{}'s default is to indent the signature and the @code{\closing} +above it by a length of @code{\longindentation}. By default this is +@code{0.5\textwidth}. To make them flush left, put +@code{\setlength@{\longindentation@}@{0em@}} in your preamble. + +To set a fixed date use something like +@code{\renewcommand@{\today@}@{2015-Oct-12@}}. If put in your preamble +then it will apply to all the letters. + +This example shows only one @code{letter} environment. The three lines +marked as optional are typically omitted. + +@example +\documentclass@{letter@} +\address@{Sender's street \\ Sender's town@} +\signature@{Sender's name \\ Sender's title@} +% optional: \location@{Mailbox 13@} +% optional: \telephone@{(102) 555-0101@} +\begin@{document@} +\begin@{letter@}@{Recipient's name \\ Recipient's address@} +\opening@{Sir:@} +% optional: \thispagestyle@{firstpage@} +I am not interested in entering a business arrangement with you. +\closing@{Your most humble, etc.,@} +\end@{letter@} +\end@{document@} +@end example These commands are used with the @code{letter} class. @menu -* \address:: Your return address. -* \cc:: Cc list. -* \closing:: Saying goodbye. -* \encl:: List of enclosed material. -* \location:: Your organization's address. -* \makelabels:: Making address labels. -* \name:: Your name, for the return address. -* \opening:: Saying hello. -* \ps:: Adding a postscript. -* \signature:: Your signature. -* \startbreaks:: Allow page breaks. -* \stopbreaks:: Disallow page breaks. -* \telephone:: Your phone number. +* \address:: Sender's return address. +* \cc:: Carbon copy list. +* \closing:: Saying goodbye. +* \encl:: List of enclosed material. +* \location:: Sender's organizational location. +* \makelabels:: Make address labels. +* \name:: Sender's name, for the return address. +* \opening:: Saying hello. +* \ps:: Adding a postscript. +* \signature:: Sender's signature. +@c ?Not user-level? * \stopbreaks and \startbreaks:: Disallow and allow page breaks. +* \telephone:: Sender's phone number. @end menu @node \address -@section \address@{@var{return-address@}} +@section @code{\address} + @findex \address -The @code{\address} specifies the return address of a letter, as it -should appear on the letter and the envelope. Separate lines of the -address should be separated by @code{\\} commands. +Synopsis: + +@example +\address@{@var{senders address}@} +@end example + +Specifies the return address as it appears on the letter and on the +envelope. Separate multiple lines in @var{senders address} with a +double backslash@tie{}@code{\\}. + +Because it can apply to multiple letters this declaration is often put +in the preamble. However, it can go anywhere, including inside an +individual @code{letter} environment. -If you do not make an @code{\address} declaration, then the letter -will be formatted for copying onto your organization's standard -letterhead. (@xref{Overview}, for details on your local -implementation). If you give an @code{\address} declaration, then the -letter will be formatted as a personal letter. +This command is optional: without the @code{\address} declaration the +letter is formatted with some blank space on top, for copying onto +pre-printed letterhead paper. (@xref{Overview}, for details on your +local implementation.) With the @code{\address} declaration, it is +formatted as a personal letter. + +Here is an example. + +@example +\address@{Stephen Maturin \\ + The Grapes of the Savoy@} +@end example @node \cc @@ -7007,11 +9308,19 @@ letter will be formatted as a personal letter. Synopsis: @example -\cc@{@var{name1}\\@var{name2}@} +\cc@{@var{first name} \\ + .. @} @end example -Produce a list of @var{name}s the letter was copied to. Each name is -printed on a separate line. +Produce a list of names to which copies of the letter were sent. This +command is optional. If it appears then typically it comes after +@code{\closing}. Separate multiple lines with a double +backslash@tie{}@code{\\}. + +@example +\cc@{President \\ + Vice President@} +@end example @node \closing @@ -7027,9 +9336,11 @@ Synopsis: \closing@{text@} @end example -A letter closes with a @code{\closing} command, for example, +Usually at the end of a letter, above the handwritten signature, there +is a @code{\closing} (although this command is optional). For example, + @example -\closing@{Best Regards,@} +\closing@{Regards,@} @end example @@ -7042,45 +9353,80 @@ A letter closes with a @code{\closing} command, for example, Synopsis: @example -\encl@{@var{line1}\\@var{line2}@} +\encl@{@var{first enclosed object} \\ + .. @} @end example -Declare a list of one more enclosures. +Produce a list of things included with the letter. This command is +optional; when it is used, it typically is put after @code{\closing}. +Separate multiple lines with a double backslash@tie{}@code{\\}. + +@example +\encl@{License \\ + Passport @} +@end example @node \location @section @code{\location} + @findex \location -@code{\location@{address@}} +Synopsis: -This modifies your organization's standard address. This only appears -if the @code{firstpage} pagestyle is selected. +@example +\location@{@var{text}@} +@end example + +The @var{text} appears centered at the bottom of the each page. It only +appears if the page style is @code{firstpage}. @node \makelabels @section @code{\makelabels} -@findex \makelabels -@code{\makelabels@{number@}} +@findex \makelabels -If you issue this command in the preamble, @LaTeX{} will create a sheet of -address labels. This sheet will be output before the letters. +Synopsis: +@example +\makelabels +@end example +Create a sheet of address labels from the recipient addresses, one for +each letter. This sheet will be output before the letters, with the idea +that you can copy it to a sheet of peel-off labels. This command goes +in the preamble. + +Customize the labels by redefining the commands @code{\startlabels}, +@code{\mlabel}, and @code{\returnaddress} in the preamble. The command +@code{\startlabels} sets the width, height, number of columns, etc., of +the page onto which the labels are printed. The command +@code{\mlabel@{@var{sender address}@}@{@var{recipient address}@}} +produces the two labels (or one, if you choose to ignore the @var{sender +address}). The @var{sender address} is the value returned by the macro +@code{\returnaddress} while @var{recipient address} is the value passed +in the argument to the @code{letter} environment. By default +@code{\mlabel} ignores the first argument, the @var{sender address}. @node \name @section @code{\name} + @findex \name -@code{\name@{June Davenport@}} +Synopsis: -Your name, used for printing on the envelope together with the return -address. +@example +\name@{@var{name}@} +@end example + +Sender's name, used for printing on the envelope together with the +return address. @node \opening -@section @code{\opening@{@var{text}@}} +@section @code{\opening} + @findex \opening @cindex letters, starting @@ -7090,12 +9436,12 @@ Synopsis: \opening@{@var{text}@} @end example -A letter begins with the @code{\opening} command. The mandatory -argument, @var{text}, is whatever text you wish to start your letter. -For instance: +This command is required. It starts a letter, following the +@code{\begin@{letter@}@{..@}}. The mandatory argument @var{text} is the +text that starts your letter. For instance: @example -\opening@{Dear Joe,@} +\opening@{Dear John:@} @end example @@ -7104,50 +9450,98 @@ For instance: @findex \ps @cindex postscript, in letters -Use the @code{\ps} command to start a postscript in a letter, after +Synopsis: + +@example +\ps@{@var{text}@} +@end example + +Add a postscript. This command is optional and usually is used after @code{\closing}. +@example +\ps@{P.S. After you have read this letter, burn it. Or eat it.@} +@end example + @node \signature -@section @code{\signature@{@var{text}@}} +@section @code{\signature} + +Synopsis: + +@example +\signature@{@var{first line} \\ + .. @} +@end example + @findex \signature -Your name, as it should appear at the end of the letter underneath the -space for your signature. @code{\\} starts a new line within -@var{text} as usual. +The sender's name. This command is optional, although its inclusion is +usual. +The argument text appears at the end of the letter, after the closing +and after a vertical space for the traditional hand-written +signature. Separate multiple lines with a double +backslash@tie{}@code{\\}. For example: -@node \startbreaks -@section @code{\startbreaks} -@findex \startbreaks +@example +\signature@{J Fred Muggs \\ + White House@} +@end example -@code{\startbreaks} +@LaTeX{}'s default for the vertical space from the @code{\closing} text +down to the @code{\signature} text is @code{6\medskipamount}, which is +six times 0.7@dmn{em}. -Used after a @code{\stopbreaks} command to allow page breaks again. +This command is usually in the preamble, to apply to all the letters in +the document. To have it apply to one letter only, put it inside a +@code{letter} environment and before the @code{\closing}. +You can include a graphic in the signature, for instance with +@code{\signature@{\vspace@{-6\medskipamount@}\includegraphics@{sig.png@}\\ +My name@}} (this requires writing @code{\usepackage@{graphicx@}} in the +preamble). -@node \stopbreaks -@section @code{\stopbreaks} -@findex \stopbreaks -@code{\stopbreaks} +@c I think this is not a user-level command; it is used to keep from breaking +@c the page between the closing and the signature +@c @node \stopbreaks and \startbreaks +@c @section @code{\stopbreaks} and @code{\startbreaks} -Inhibit page breaks until a @code{\startbreaks} command occurs. +@c @findex \startbreak +@c @findex \stopbreaks +@c @example +@c @code{\stopbreaks} +@c text +@c @code{\startbreaks} +@c @end example +@c The @code{\stopbreaks} inhibits page breaking. The @code{\startbreaks} resumes +@c normal page breaking. +@c +@c @node \telephone @section @code{\telephone} + @findex \telephone -@code{\telephone@{number@}} +Synopsis: -This is your telephone number. This only appears if the -@code{firstpage} pagestyle is selected. +@example +\telephone@{@var{number}@} +@end example + +The sender's telephone number. This is typically in the preamble, where +it applies to all letters. This only appears if the @code{firstpage} +pagestyle is selected. If so, it appears on the lower right of the +page. @node Terminal input/output @chapter Terminal input/output -@cindex input/output + +@cindex input/output, to terminal @cindex terminal input/output @menu @@ -7158,6 +9552,7 @@ This is your telephone number. This only appears if the @node \typein @section @code{\typein[@var{cmd}]@{@var{msg}@}} + @findex \typein Synopsis: @@ -7177,6 +9572,7 @@ redefined to be the typed input. @node \typeout @section @code{\typeout@{@var{msg}@}} + @findex \typeout Synopsis: @@ -7199,6 +9595,7 @@ printed, independent of surrounding spaces. A @code{^^J} in @node Command line @chapter Command line + @cindex command line @findex .tex, @r{default extension} @@ -7230,7 +9627,9 @@ If @LaTeX{} stops in the middle of the document and gives you a @node Document templates @appendix Document templates + @cindex document templates +@cindex templates, document Although not reference material, perhaps these document templates will be useful. Additional template resources are listed at @@ -7247,6 +9646,8 @@ be useful. Additional template resources are listed at @section @code{beamer} template @cindex @code{beamer} template and class +@cindex template, @code{beamer} + The @code{beamer} class creates presentation slides. It has a vast array of features, but here is a basic template: @@ -7281,6 +9682,8 @@ One web resource for this: @node book template @section @code{book} template +@cindex template, @code{book} + @verbatim \documentclass{book} \title{Book Class Template} @@ -7304,6 +9707,7 @@ The end. @node tugboat template @section @code{tugboat} template +@cindex template, TUGboat @cindex TUGboat template @cindex @code{ltugboat} class @@ -7420,4 +9824,5 @@ Email \verb|tugboat@tug.org| if problems or questions. @c Local Variables: @c ispell-dictionary: "english" +@c coding: latin-1-unix @c End: diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt index e502e516666..a2966568b6d 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt @@ -47,6 +47,7 @@ LaTeX2e: An unofficial reference manual 5.3 '\flushbottom' 5.4 '\raggedbottom' 5.5 Page layout parameters + 5.6 Floats 6 Sectioning 7 Cross references 7.1 '\label' @@ -64,7 +65,7 @@ LaTeX2e: An unofficial reference manual 8.8 'eqnarray' 8.9 'equation' 8.10 'figure' - 8.11 'filecontents': Create external files + 8.11 'filecontents': Write an external file 8.12 'flushleft' 8.12.1 '\raggedright' 8.13 'flushright' @@ -89,27 +90,26 @@ LaTeX2e: An unofficial reference manual 8.19.12 '\put' 8.19.13 '\shortstack' 8.19.14 '\vector' - 8.20 'quotation' - 8.21 'quote' - 8.22 'tabbing' - 8.23 'table' - 8.24 'tabular' - 8.24.1 '\multicolumn' - 8.24.2 '\cline' - 8.24.3 '\hline' - 8.24.4 '\vline' - 8.25 'thebibliography' - 8.25.1 '\bibitem' - 8.25.2 '\cite' - 8.25.3 '\nocite' - 8.25.4 Using BibTeX - 8.26 'theorem' - 8.27 'titlepage' - 8.28 'verbatim' - 8.28.1 '\verb' - 8.29 'verse' + 8.20 'quotation' and 'quote' + 8.21 'tabbing' + 8.22 'table' + 8.23 'tabular' + 8.23.1 '\multicolumn' + 8.23.2 '\vline' + 8.23.3 '\cline' + 8.23.4 '\hline' + 8.24 'thebibliography' + 8.24.1 '\bibitem' + 8.24.2 '\cite' + 8.24.3 '\nocite' + 8.24.4 Using BibTeX + 8.25 'theorem' + 8.26 'titlepage' + 8.27 'verbatim' + 8.27.1 '\verb' + 8.28 'verse' 9 Line breaking - 9.1 '\\'[*][MORESPACE] + 9.1 '\\' 9.2 '\obeycr' & '\restorecr' 9.3 '\newline' 9.4 '\-' (discretionary hyphen) @@ -127,17 +127,21 @@ LaTeX2e: An unofficial reference manual 11.1 '\footnote' 11.2 '\footnotemark' 11.3 '\footnotetext' - 11.4 Symbolic footnotes - 11.5 Footnote parameters + 11.4 Footnotes in a table + 11.5 Footnotes in section headings + 11.6 Footnotes of footnotes + 11.7 Multiple references to footnotes + 11.8 Footnote parameters 12 Definitions 12.1 '\newcommand' & '\renewcommand' - 12.2 '\newcounter' - 12.3 '\newlength' - 12.4 '\newsavebox' - 12.5 '\newenvironment' & '\renewenvironment' - 12.6 '\newtheorem' - 12.7 '\newfont' - 12.8 '\protect' + 12.2 '\providecommand' + 12.3 '\newcounter': Allocating a counter + 12.4 '\newlength': Allocating a length + 12.5 '\newsavebox': Allocating a box + 12.6 '\newenvironment' & '\renewenvironment' + 12.7 '\newtheorem' + 12.8 '\newfont': Define a new font (obsolete) + 12.9 '\protect' 13 Counters 13.1 '\alph \Alph \arabic \roman \Roman \fnsymbol': Printing counters 13.2 '\usecounter{COUNTER}' @@ -148,12 +152,13 @@ LaTeX2e: An unofficial reference manual 13.7 '\stepcounter{COUNTER}' 13.8 '\day \month \year': Predefined counters 14 Lengths - 14.1 '\setlength{\LEN}{VALUE}' - 14.2 \addtolength{\LEN}{AMOUNT} - 14.3 '\settodepth' - 14.4 '\settoheight' - 14.5 '\settowidth{\LEN}{TEXT}' - 14.6 Predefined lengths + 14.1 Units of length + 14.2 '\setlength{\LEN}{VALUE}' + 14.3 '\addtolength{\LEN}{AMOUNT}' + 14.4 '\settodepth' + 14.5 '\settoheight' + 14.6 '\settowidth{\LEN}{TEXT}' + 14.7 Predefined lengths 15 Making paragraphs 15.1 '\indent' 15.2 '\noindent' @@ -175,16 +180,16 @@ LaTeX2e: An unofficial reference manual 19 Spaces 19.1 '\hspace' 19.2 '\hfill' - 19.3 '\SPACE': Normal interword space - 19.4 '\@': Force sentence-ending punctuation - 19.5 '\thinspace': Insert 1/6em - 19.6 '\/': Insert italic correction - 19.7 '\hrulefill' - 19.8 '\dotfill' + 19.3 '\(SPACE)' and \@ + 19.4 '\ ' after a control sequence + 19.5 '\frenchspacing' + 19.6 '\thinspace': Insert 1/6em + 19.7 '\/': Insert italic correction + 19.8 '\hrulefill \dotfill' 19.9 '\addvspace' 19.10 '\bigskip \medskip \smallskip' 19.11 '\vfill' - 19.12 '\vspace[*]{LENGTH}' + 19.12 '\vspace{LENGTH}' 20 Boxes 20.1 '\mbox{TEXT}' 20.2 '\fbox' and '\framebox' @@ -205,27 +210,25 @@ LaTeX2e: An unofficial reference manual 22 Splitting the input 22.1 '\include' 22.2 \'includeonly' - 22.3 \input + 22.3 '\input' 23 Front/back matter 23.1 Tables of contents - 23.1.1 \addcontentsline - 23.1.2 \addtocontents + 23.1.1 '\addcontentsline' + 23.1.2 '\addtocontents' 23.2 Glossaries 23.3 Indexes 24 Letters - 24.1 \address{RETURN-ADDRESS} + 24.1 '\address' 24.2 '\cc' 24.3 '\closing' 24.4 '\encl' 24.5 '\location' 24.6 '\makelabels' 24.7 '\name' - 24.8 '\opening{TEXT}' + 24.8 '\opening' 24.9 '\ps' - 24.10 '\signature{TEXT}' - 24.11 '\startbreaks' - 24.12 '\stopbreaks' - 24.13 '\telephone' + 24.10 '\signature' + 24.11 '\telephone' 25 Terminal input/output 25.1 '\typein[CMD]{MSG}' 25.2 '\typeout{MSG}' @@ -239,8 +242,8 @@ Command Index LaTeX2e: An unofficial reference manual *************************************** -This document is an unofficial reference manual (version of May 2015) -for LaTeX2e, a document preparation system. +This document is an unofficial reference manual (version of October +2015) for LaTeX2e, a document preparation system. 1 About this document ********************* @@ -298,8 +301,8 @@ interspersed commands, for instance commands describing how the text should be formatted. It is implemented as a set of related commands that interface with Donald E. Knuth's TeX typesetting program (the technical term is that LaTeX is a "macro package" for the TeX engine). -The user produces the output document by giving that file to the TeX -engine. +The user produces the output document by giving that input file to the +TeX engine. The term LaTeX is also sometimes used to mean the language in which the document is marked up, that is, to mean the set of commands @@ -313,8 +316,8 @@ plain text, write it as 'LaTeX'. 2.1 Starting and ending ======================= -LaTeX files have a simple global structure, with a standard starting and -ending. Here is a "hello, world" example: +LaTeX files have a simple global structure, with a standard beginning +and ending. Here is a "hello, world" example: \documentclass{article} \begin{document} @@ -331,8 +334,9 @@ the '\begin{document}' commands. This area is called the "preamble". The '\begin{document} ... \end{document}' is a so-called "environment"; the 'document' environment (and no others) is required in -all LaTeX documents. LaTeX provides many environments itself, and many -more are defined separately. *Note Environments::. +all LaTeX documents (*note document::). LaTeX provides many +environments itself, and many more are defined separately. *Note +Environments::. The following sections discuss how to produce PDF or other output from a LaTeX input file. @@ -392,7 +396,7 @@ of the main programs. 'latex' 'pdflatex' - In TeX Live (<http://tug.org/texlive>, if LaTeX is invoked via + In TeX Live (<http://tug.org/texlive>), if LaTeX is invoked via either the system command 'latex' or 'pdflatex', then the pdfTeX engine is run (<http://ctan.org/pkg/pdftex>). When invoked as 'latex', the main output is a '.dvi' file; as 'pdflatex', the main @@ -402,7 +406,7 @@ of the main programs. program (<http://ctan.org/pkg/etex>), including additional programming features and bi-directional typesetting, and has plenty of extensions of its own. e-TeX is available on its own as the - command 'etex', but this is plain TeX (and produces '.dvi'). + system command 'etex', but this is plain TeX (and produces '.dvi'). In other TeX distributions, 'latex' may invoke e-TeX rather than pdfTeX. In any case, the e-TeX extensions can be assumed to be @@ -419,12 +423,17 @@ of the main programs. 'xelatex' If LaTeX is invoked with the system command 'xelatex', the XeTeX - engine is run (<http://tug.org/xetex>). Like LuaTeX, XeTeX also + engine is run (<http://tug.org/xetex>). Like LuaTeX, XeTeX natively supports UTF-8 Unicode and TrueType and OpenType fonts, though the implementation is completely different, mainly using external libraries instead of internal code. XeTeX produces a '.pdf' file as output; it does not support DVI output. + Internally, XeTeX creates an '.xdv' file, a variant of DVI, and + translates that to PDF using the ('x')'dvipdfmx' program, but this + process is automatic. The '.xdv' file is only useful for + debugging. + Other variants of LaTeX and TeX exist, e.g., to provide additional support for Japanese and other languages ([u]pTeX, <http://ctan.org/pkg/ptex>, <http://ctan.org/pkg/uptex>). @@ -432,26 +441,67 @@ support for Japanese and other languages ([u]pTeX, 2.4 LaTeX command syntax ======================== -In the LaTeX input file, a command name starts with a '\'; the name -itself then consists of either (a) a string of letters or (b) a single -non-letter. +In the LaTeX input file, a command name starts with a backslash +character, '\'. The name itself then consists of either (a) a string of +letters or (b) a single non-letter. + + LaTeX commands names are case sensitive so that '\pagebreak' differs +from '\Pagebreak' (the latter is not a standard command). Most commands +are lowercase, but in any event you must enter all commands in the same +case as they are defined. - A command may be followed by zero, one, or more arguments, either -required or optional. Required arguments are contained in curly braces, -'{...}'. Optional arguments are contained in square brackets, '[...]'. -Generally, but not universally, if the command accepts an optional -argument, it comes first, before any required arguments. + A command may be followed by zero, one, or more arguments. These +arguments may be either required or optional. Required arguments are +contained in curly braces, '{...}'. Optional arguments are contained in +square brackets, '[...]'. Generally, but not universally, if the +command accepts an optional argument, it comes first, before any +required arguments. - Some commands have a '*' form that is related to the form without a -'*', such as '\chapter' and '\chapter*'. + Inside of an optional argument, to use the character close square +bracket (']') hide it inside curly braces, as in '\item[closing bracket +{]}]'. Similarly, if an optional argument comes last, with no required +argument after it, then to make the first character of the following +text be an open square bracket, hide it inside curly braces. - LaTeX commands are case sensitive; neither '\Begin{document}' nor -'\begin{Document}' will work. Most commands are lowercase, but in any -event you must enter all commands in the same case as they are defined. + LaTeX has the convention that some commands have a '*' form that is +related to the form without a '*', such as '\chapter' and '\chapter*'. +The exact difference in behavior varies from command to command. This manual describes all accepted options and '*'-forms for the commands it covers (barring unintentional omissions, a.k.a. bugs). +Synopsis: + + \begin{ENVIRONMENT NAME} + .. + \end{ENVIRONMENT NAME} + + An area of LaTeX source, inside of which there is a distinct +behavior. For instance, for poetry in LaTeX put the lines between +'\begin{verse}' and '\end{verse}'. + + \begin{verse} + There once was a man from Nantucket \\ + .. + \end{verse} + + The ENVIRONMENT NAME at the beginning must exactly match that at the +end. This includes the case where ENVIRONMENT NAME ends in a +star ('*'); both the '\begin' and '\end' texts must include the star. + + Environments may have arguments, including optional arguments. This +example produces a table. The first argument is optional (and causes +the table to be aligned on its top row) while the second argument is +required (it specifies the formatting of columns). + + \begin{tabular}[t]{r|l} + .. rows of table .. + \end{tabular} + +A command that changes the value, or changes the meaning, of some other +command or parameter. For instance, the '\mainmatter' command changes +the setting of page numbers from roman numerals to arabic. + 3 Document classes ****************** @@ -472,6 +522,9 @@ document classes are available as separate packages; *note Overview::.) matter, such as a preface, and back matter, such as an appendix (*note Front/back matter::). +'letter' + Mail, optionally including mailing labels (*note Letters::). + 'report' For documents of length between an 'article' and a 'book', such as technical reports or theses, which may contain several chapters. @@ -500,9 +553,29 @@ options for selecting the typeface size (default is '10pt'): 10pt 11pt 12pt All of the standard classes accept these options for selecting the -paper size (default is 'letterpaper'): +paper size (these show height by width): + +'a4paper' + 210 by 297 mm (about 8.25 by 11.75 inches) - a4paper a5paper b5paper executivepaper legalpaper letterpaper +'b5paper' + 176 by 250 mm (about 7 by 9.875 inches) + +'executivepaper' + 7.25 by 10.5 inches + +'legalpaper' + 8.5 by 14 inches + +'letterpaper' + 8.5 by 11 inches (the default) + + When using one of the engines pdfLaTeX, LuaLaTeX, or XeLaTeX (*note +TeX engines::), options other than 'letterpaper' set the print area but +you must also set the physical paper size. One way to do that is to put +'\pdfpagewidth=\paperwidth' and '\pdfpageheight=\paperheight' in your +document's preamble. The 'geometry' package provides flexible ways of +setting the print area and physical page size. Miscellaneous other options: @@ -579,10 +652,10 @@ style. The LaTeX commands for doing this are described here. The following type style commands are supported by LaTeX. This first group of commands is typically used with an argument, as -in '\textit{italic text}'. In the table below, the corresponding -command in parenthesis is the "declaration form", which takes no -arguments. The scope of the declaration form lasts until the next type -style command or the end of the current group. +in '\textit{TEXT}'. In the table below, the corresponding command in +parenthesis is the "declaration form", which takes no arguments, as in +'{\itshape TEXT}'. The scope of the declaration form lasts until the +next type style command or the end of the current group. These commands, in both the argument form and the declaration form, are cumulative; e.g., you can say either '\sffamily\bfseries' or @@ -605,9 +678,6 @@ such as '\textit{\nocorr text}' or '\textsc{text \nocorr}'. '\textit (\itshape)' Italics. -'\emph' - Emphasis (switches between '\textit' and '\textrm'). - '\textmd (\mdseries)' Medium weight (default). @@ -615,7 +685,7 @@ such as '\textit{\nocorr text}' or '\textsc{text \nocorr}'. Boldface. '\textup (\upshape)' - Upright (default). The opposite of slanted. + Upright (default). '\textsl (\slshape)' Slanted. @@ -632,45 +702,15 @@ such as '\textit{\nocorr text}' or '\textsc{text \nocorr}'. '\textnormal (\normalfont)' Main document font. -'\mathrm' - Roman, for use in math mode. - -'\mathbf' - Boldface, for use in math mode. - -'\mathsf' - Sans serif, for use in math mode. - -'\mathtt' - Typewriter, for use in math mode. - -'\mathit' -'(\mit)' - Italics, for use in math mode. - -'\mathnormal' - For use in math mode, e.g. inside another type style declaration. - -'\mathcal' - 'Calligraphic' letters, for use in math mode. - - In addition, the command '\mathversion{bold}' can be used for -switching to bold letters and symbols in formulas. -'\mathversion{normal}' restores the default. - - Finally, the command '\oldstylenums{NUMERALS}' will typeset so-called -"old-style" numerals, which have differing heights and depths (and -sometimes widths) from the standard "lining" numerals. LaTeX's default -fonts support this, and will respect '\textbf' (but not other styles; -there are no italic old-style numerals in Computer Modern). Many other -fonts have old-style numerals also; sometimes the 'textcomp' package -must be loaded, and sometimes package options are provided to make them -the default. FAQ entry: -<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf>. + Although it also changes fonts, the '\emph{TEXT}' command is +semantic, for text to be emphasized, and should not be used as a +substitute for '\textit'. For example, '\emph{START TEXT \emph{MIDDLE +TEXT} END TEXT}' will result in the START TEXT and END TEXT in italics, +but MIDDLE TEXT will be in roman. LaTeX also provides the following commands, which unconditionally switch to the given style, that is, are _not_ cumulative. Also, they -are used differently than the above commands: '{\CMD ...}' instead of +are used differently than the above commands: '{\CMD...}' instead of '\CMD{...}'. These are two unrelated constructs. '\bf' @@ -679,9 +719,6 @@ are used differently than the above commands: '{\CMD ...}' instead of '\cal' Switch to calligraphic letters for math. -'\em' - Emphasis (italics within roman, roman within italics). - '\it' Italics. @@ -700,12 +737,56 @@ are used differently than the above commands: '{\CMD ...}' instead of '\tt' Typewriter (monospace, fixed-width). - Some people consider the unconditional font-switching commands, such -as '\tt', obsolete and _only_ the cumulative commands ('\texttt') should -be used. I (Karl) do not agree. There are perfectly reasonable -situations when an unconditional font switch is precisely what you need -to get the desired output; for one example, *note 'description': -description. Both sets of commands have their place. + The '\em' command is the unconditional version of '\emph'. + + (Some people consider the unconditional font-switching commands, such +as '\tt', obsolete and that only the cumulative commands ('\texttt') +should be used. Others think that both sets of commands have their +place and sometimes an unconditional font switch is precisely what you +want; for one example, *note 'description': description.) + + The following commands are for use in math mode. They are not +cumulative, so '\mathbf{\mathit{SYMBOL}}' does not create a boldface and +italic SYMBOL; instead, it will just be in italics. This is because +typically math symbols need consistent typographic treatment, regardless +of the surrounding environment. + +'\mathrm' + Roman, for use in math mode. + +'\mathbf' + Boldface, for use in math mode. + +'\mathsf' + Sans serif, for use in math mode. + +'\mathtt' + Typewriter, for use in math mode. + +'\mathit' +'(\mit)' + Italics, for use in math mode. + +'\mathnormal' + For use in math mode, e.g., inside another type style declaration. + +'\mathcal' + Calligraphic letters, for use in math mode. + + In addition, the command '\mathversion{bold}' can be used for +switching to bold letters and symbols in formulas. +'\mathversion{normal}' restores the default. + + Finally, the command '\oldstylenums{NUMERALS}' will typeset so-called +"old-style" numerals, which have differing heights and depths (and +sometimes widths) from the standard "lining" numerals, which all have +the same height as upper-case letters. LaTeX's default fonts support +this, and will respect '\textbf' (but not other styles; there are no +italic old-style numerals in Computer Modern). Many other fonts have +old-style numerals also; sometimes the 'textcomp' package must be +loaded, and sometimes package options are provided to make them the +default. FAQ entry: +<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf>. 4.2 Font sizes ============== @@ -740,178 +821,394 @@ These commands are primarily intended for writers of macros and packages. The commands listed here are only a subset of the available ones. -'\fontencoding{enc}' - Select font encoding. Valid encodings include 'OT1' and 'T1'. - -'\fontfamily{family}' - Select font family. Valid families include: - - * 'cmr' for Computer Modern Roman - * 'cmss' for Computer Modern Sans Serif - * 'cmtt' for Computer Modern Typewriter - - and numerous others. - -'\fontseries{series}' - Select font series. Valid series include: - - * 'm' Medium (normal) - * 'b' Bold - * 'c' Condensed - * 'bc' Bold condensed - * 'bx' Bold extended - - and various other combinations. - -'\fontshape{shape}' +'\fontencoding{ENCODING}' + Select the font encoding, the encoding of the output font. There + are a large number of valid encodings. The most common are 'OT1', + Knuth's original encoding for Computer Modern (the default), and + 'T1', also known as the Cork encoding, which has support for the + accented characters used by the most widespread European languages + (German, French, Italian, Polish and others), which allows TeX to + hyphenate words containing accented letters. + +'\fontfamily{FAMILY}' + Select the font family. The web page + <http://www.tug.dk/FontCatalogue/> provides one way to browse + through many of the fonts easily used with LaTeX. Here are + examples of some common families: + + 'pag' Avant Garde + 'fvs' Bitstream Vera Sans + 'pbk' Bookman + 'bch' Charter + 'ccr' Computer Concrete + 'cmr' Computer Modern + 'pcr' Courier + 'phv' Helvetica + 'fi4' Inconsolata + 'lmr' Latin Modern + 'lmss' Latin Modern Sans + 'lmtt' Latin Modern Typewriter + 'pnc' New Century Schoolbook + 'ppl' Palatino + 'ptm' Times + 'uncl' Uncial + 'put' Utopia + 'pzc' Zapf Chancery + +'\fontseries{SERIES}' + Select the font series. A "series" combines a "weight" and a + "width". Typically, a font supports only a few of the possible + combinations. Some common combined series values include: + + 'm' Medium (normal) + 'b' Bold + 'c' Condensed + 'bc' Bold condensed + 'bx' Bold extended + + The possible values for weight, individually, are: + + 'ul' Ultra light + 'el' Extra light + 'l' Light + 'sl' Semi light + 'm' Medium (normal) + 'sb' Semi bold + 'b' Bold + 'eb' Extra bold + 'ub' Ultra bold + + The possible values for width, individually, are (the percentages + are just guides and are not followed precisely by all fonts): + + 'uc' Ultra condensed, 50% + 'ec' Extra condensed, 62.5% + 'c' Condensed, 75% + 'sc' Semi condensed, 87.5% + 'm' Medium, 100% + 'sx' Semi expanded, 112.5% + 'x' Expanded, 125% + 'ex' Extra expanded, 150% + 'ux' Ultra expanded, 200% + + When forming the SERIES string from the weight and width, drop the + 'm' that stands for medium weight or medium width, unless both + weight and width are 'm', in which case use just one (''m''). + +'\fontshape{SHAPE}' Select font shape. Valid shapes are: - * 'n' Upright (normal) - * 'it' Italic - * 'sl' Slanted (oblique) - * 'sc' Small caps - * 'ui' Upright italics - * 'ol' Outline - - The two last shapes are not available for most font families. - -'\fontsize{size}{skip}' - Set font size. The first parameter is the font size to switch to - and the second is the line spacing to use; this is stored in a - parameter named '\baselineskip'. The unit of both parameters - defaults to pt. The default '\baselineskip' for the Computer - Modern typeface is 1.2 times the '\fontsize'. - - The line spacing is also multiplied by the value of the - '\baselinestretch' parameter when the type size changes; the - default is 1. However, the best way to "double space" a document, - if you should be unlucky enough to have to produce such, is to use - the 'setspace' package; see - <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace>. + 'n' Upright (normal) + 'it' Italic + 'sl' Slanted (oblique) + 'sc' Small caps + 'ui' Upright italics + 'ol' Outline + + The two last shapes are not available for most font families, and + small caps are often missing as well. + +'\fontsize{SIZE}{SKIP}' + Set the font size and the line spacing. The unit of both + parameters defaults to points ('pt'). The line spacing is the + nominal vertical space between lines, baseline to baseline. It is + stored in the parameter '\baselineskip'. The default + '\baselineskip' for the Computer Modern typeface is 1.2 times the + '\fontsize'. Changing '\baselineskip' directly is inadvisable + since its value is reset every time a size change happens; see + '\baselinestretch', next. + +'\baselinestretch' + LaTeX multiplies the line spacing by the value of the + '\baselinestretch' parameter; the default factor is 1. A change + takes effect when '\selectfont' (see below) is called. You can + make line skip changes happen for the entire document by doing + '\renewcommand{\baselinestretch}{2.0}' in the preamble. + + However, the best way to double-space a document is to use the + 'setspace' package. In addition to offering a number of spacing + options, this package keeps the line spacing single-spaced in + places where that is typically desirable, such as footnotes and + figure captions. See the package documentation. '\linespread{FACTOR}' Equivalent to '\renewcommand{\baselinestretch}{FACTOR}', and therefore must be followed by '\selectfont' to have any effect. Best specified in the preamble, or use the 'setspace' package, as - described just above. + just described. - The changes made by calling the font commands described above do - not come into effect until '\selectfont' is called. +'\selectfont' + The effects of the font commands described above do not happen + until '\selectfont' is called, as in + '\fontfamily{FAMILYNAME}\selectfont'. It is often useful to put + this in a macro: + '\newcommand*{\myfont}{\fontfamily{FAMILYNAME}\selectfont}' + (*note \newcommand & \renewcommand::). -'\usefont{enc}{family}{series}{shape}' +'\usefont{ENC}{FAMILY}{SERIES}{SHAPE}' The same as invoking '\fontencoding', '\fontfamily', '\fontseries' and '\fontshape' with the given parameters, followed by - '\selectfont'. + '\selectfont'. For example: + + \usefont{ot1}{cmr}{m}{n} 5 Layout ******** -Miscellaneous commands for controlling the general layout of the page. +Commands for controlling the general page layout. 5.1 '\onecolumn' ================ The '\onecolumn' declaration starts a new page and produces -single-column output. This is the default. +single-column output. If the document is given the class option +'onecolumn' then this is the default behavior (*note Document class +options::). + + This command is fragile (*note \protect::). 5.2 '\twocolumn' ================ Synopsis: - \twocolumn[TEXT1COL] + \twocolumn[PRELIM ONE COLUMN TEXT] The '\twocolumn' declaration starts a new page and produces -two-column output. If the optional TEXT1COL argument is present, it is +two-column output. If the document is given the class option +'twocolumn' then this is the default (*note Document class options::). + + If the optional PRELIM ONE COLUMN TEXT argument is present, it is typeset in one-column mode before the two-column typesetting starts. + This command is fragile (*note \protect::). + These parameters control typesetting in two-column output: '\columnsep' - The distance between columns (35pt by default). + The distance between columns. The default is 35pt. Change it with + a command such as '\setlength{\columnsep}{40pt}' You must change it + before the two column environment starts; in the preamble is a good + place. '\columnseprule' - The width of the rule between columns; the default is 0pt, so there - is no rule. + The width of the rule between columns. The rule appears halfway + between the two columns. The default is 0pt, meaning that there is + no rule. Change it with a command such as + '\setlength{\columnseprule}{0.4pt}', before the two-column + environment starts. '\columnwidth' - The width of the current column; this is equal to '\textwidth' in - single-column text. + The width of a single column. In one-column mode this is equal to + '\textwidth'. In two-column mode by default LaTeX sets the width + of each of the two columns to be half of '\textwidth' minus + '\columnsep'. - These parameters control float behavior in two-column output: + In a two-column document, the starred environments 'table*' and +'figure*' are two columns wide, whereas the unstarred environments +'table' and 'figure' take up only one column (*note figure:: and *note +table::). LaTeX places starred floats at the top of a page. The +following parameters control float behavior of two-column output. '\dbltopfraction' - Maximum fraction at the top of a two-column page that may be - occupied by floats. Default '.7', can be usefully redefined to - (say) '.9' to avoid going to float pages so soon. + The maximum fraction at the top of a two-column page that may be + occupied by two-column wide floats. The default is 0.7, meaning + that the height of a 'table*' or 'figure*' environment must not + exceed '0.7\textheight' . If the height of your starred float + environment exceeeds this then you can take one of the following + actions to prevent it from floating all the way to the back of the + document: + + * Use the '[tp]' location specifier to tell LaTeX to try to put + the bulky float on a page by itself, as well as at the top of + a page. + + * Use the '[t!]' location specifier to override the effect of + '\dbltopfraction' for this particular float. + + * Increase the value of '\dbltopfraction' to a suitably large + number, to avoid going to float pages so soon. + + You can redefine it, for instance with + '\renewcommand{\dbltopfraction}{0.9}'. '\dblfloatpagefraction' - The minimum fraction of a float page that must be occupied by - floats, for a two-column float page. Default '.5'. + For a float page of two-column wide floats, this is the minimum + fraction that must be occupied by floats, limiting the amount of + blank space. LaTeX's default is '0.5'. Change it with + '\renewcommand'. '\dblfloatsep' - Distance between floats at the top or bottom of a two-column float - page. Default '12pt plus2pt minus2pt' for '10pt' and '11pt' - documents, '14pt plus2pt minus4pt' for '12pt'. + On a float page of two-column wide floats, this length is the + distance between floats, at both the top and bottom of the page. + The default is '12pt plus2pt minus2pt' for a document set at '10pt' + or '11pt', and '14pt plus2pt minus4pt' for a document set at + '12pt'. '\dbltextfloatsep' - Distance between a multi-column float at the top or bottom of a - page and the main text. Default '20pt plus2pt minus4pt'. + This length is the distance between a multi-column float at the top + or bottom of a page and the main text. The default is '20pt + plus2pt minus4pt'. + +'\dbltopnumber' + On a float page of two-column wide floats, this counter gives the + maximum number of floats allowed at the top of the page. The LaTeX + default is '2'. + + This example shows the use of the optional argument of '\twocolumn' +to create a title that spans the two-column article: + + \documentclass[twocolumn]{article} + \newcommand{\authormark}[1]{\textsuperscript{#1}} + \begin{document} + \twocolumn[{% inside this optional argument goes one-column text + \centering + \LARGE The Title \\[1.5em] + \large Author One\authormark{1}, + Author Two\authormark{2}, + Author Three\authormark{1} \\[1em] + \normalsize + \begin{tabular}{p{.2\textwidth}@{\hspace{2em}}p{.2\textwidth}} + \authormark{1}Department one &\authormark{2}Department two \\ + School one &School two + \end{tabular}\\[3em] % space below title part + }] + + Two column text here. 5.3 '\flushbottom' ================== -The '\flushbottom' declaration makes all text pages the same height, -adding extra vertical space where necessary to fill out the page. +The '\flushbottom' command can go at any point in the document body. It +makes all later pages the same height, stretching the vertical space +where necessary to fill out the page. - This is the default if 'twocolumn' mode is selected (*note Document -class options::). + If TeX cannot satisfactorily stretch the vertical space in a page +then you get a message like 'Underfull \vbox (badness 10000) has +occurred while \output is active'. You can change to '\raggedbottom' +(see below). Alternatively, you can try to adjust the 'textheight' to +be compatible, or you can add some vertical stretch glue between lines +or between paragraphs, as in '\setlength{\parskip}{0ex plus0.1ex}'. In +a final editing stage you can adjust the height of individual pages +(*note \enlargethispage::). + + This is the default only if you select the 'twoside' document class +option (*note Document class options::). 5.4 '\raggedbottom' =================== -The '\raggedbottom' declaration makes all pages the natural height of -the material on that page. No rubber lengths will be stretched. +The '\raggedbottom' command can go at any point in the document body. +It makes all later pages the natural height of the material on that +page; no rubber lengths will be stretched. Thus, in a two-sided +document the facing pages may be different heights. See also +'\flushbottom' above. + + This is the default unless you select the 'twoside' document class +option (*note Document class options::). 5.5 Page layout parameters ========================== +'\columnsep' +'\columnseprule' +'\columnwidth' + The distance between the two columns, the width of a rule between + the columns, and the width of the columns, when the document class + option 'twocolumn' is in effect (*note Document class options::). + *Note \twocolumn::. + '\headheight' - Height of the box that contains the running head. Default is - '30pt', except in the 'book' class, where it varies with the type - size. + Height of the box that contains the running head. The default in + the 'article', 'report', and 'book' classes is '12pt', at all type + sizes. '\headsep' Vertical distance between the bottom of the header line and the top - of the main text. Default is '25pt', except in the 'book' class, - where it varies with the type size. + of the main text. The default in the 'article' and 'report' + classes is '25pt'. In the 'book' class the default is: if the + document is set at 10pt then it is '0.25in', and at 11pt and 12pt + it is '0.275in'. '\footskip' Distance from the baseline of the last line of text to the baseline - of the page footer. Default is '30pt', except in the 'book' class, - where it varies with the type size. + of the page footer. The default in the 'article' and 'report' + classes is '30pt'. In the 'book' class the default is: when the + type size is 10pt the default is '0.35in', while at 11pt it is + '0.38in', and at 12pt it is '30pt'. '\linewidth' Width of the current line, decreased for each nested 'list' (*note - list::). Specifically, it is smaller than '\textwidth' by the sum - of '\leftmargin' and '\rightmargin' (*note itemize::). The default - varies with the font size, paper width, two-column mode, etc. For - an 'article' document in '10pt', it's set to '345pt'; in two-column - mode, that becomes '229.5pt'. + list::). That is, the nominal value for '\linewidth' is to equal + '\textwidth' but for each nested list the '\linewidth' is decreased + by the sum of that list's '\leftmargin' and '\rightmargin' (*note + itemize::). + +'\marginparpush' +'\marginsep' +'\marginparwidth' + The minimum vertical space between two marginal notes, the + horizontal space between the text body and the marginal notes, and + the horizontal width of the notes. + + Normally marginal notes appear on the outside of the page, but the + declaration '\reversemarginpar' changes that (and + '\normalmarginpar' changes it back). + + The defaults for '\marginparpush' in both 'book' and 'article' + classes are: '7pt' if the document is set at 12pt, and '5pt' if the + document is set at 11pt or 10pt. + + For '\marginsep', in 'article' class the default is '10pt' except + if the document is set at 10pt and in two-column mode where the + default is '11pt'. + + For '\marginsep' in 'book' class the default is '10pt' in + two-column mode and '7pt' in one-column mode. + + For '\marginparwidth' in both 'book' and 'article' classes, in + two-column mode the default is 60% of '\paperwidth - \textwidth', + while in one-column mode it is 50% of that distance. + +'\oddsidemargin' +'\evensidemargin' + The '\oddsidemargin' is the extra distance between the left side of + the page and the text's left margin, on odd-numbered pages when the + document class option 'twoside' is chosen and on all pages when + 'oneside' is in effect. When 'twoside' is in effect, on + even-numbered pages the extra distance on the left is + 'evensidemargin'. + + LaTeX's default is that '\oddsidemargin' is 40% of the difference + between '\paperwidth' and '\textwidth', and '\evensidemargin' is + the remainder. + +'\paperheight' + The height of the paper, as distinct from the height of the print + area. It is normally set with a document class option, as in + '\documentclass[a4paper]{article}' (*note Document class + options::). + +'\paperwidth' + The width of the paper, as distinct from the width of the print + area. It is normally set with a document class option, as in + '\documentclass[a4paper]{article}' (*note Document class + options::). '\textheight' - The normal vertical height of the page body; the default varies - with the font size, document class, etc. For an 'article' or - 'report' document in '10pt', it's set to '43\baselineskip'; for - 'book', it's '41\baselineskip'. For '11pt', it's '38\baselineskip' - and for '12pt', '36\baselineskip'. + The normal vertical height of the page body. If the document is + set at a nominal type size of 10pt then for an 'article' or + 'report' the default is '43\baselineskip', while for a 'book' it is + '41\baselineskip'. At a type size of 11pt the default is + '38\baselineskip' for all document classes. At 12pt it is + '36\baselineskip' for all classes. '\textwidth' - The full horizontal width of the entire page body; the default - varies as usual. For an 'article' or 'report' document, it's - '345pt' at '10pt', '360pt' at '11pt', and '390pt' at '12pt'. For a - 'book' document, it's '4.5in' at '10pt', and '5in' at '11pt' or - '12pt'. + The full horizontal width of the entire page body. For an + 'article' or 'report' document, the default is '345pt' when the + chosen type size is 10pt, the default is '360pt' at 11pt, and it is + '390pt' at 12pt. For a 'book' document, the default is '4.5in' at + a type size of 10pt, and '5in' at 11pt or 12pt. In multi-column output, '\textwidth' remains the width of the entire page body, while '\columnwidth' is the width of one column @@ -926,13 +1223,13 @@ the material on that page. No rubber lengths will be stretched. specified width, and revert to their normal values at the end of the 'minipage' or '\parbox'. - For completeness: '\hsize' is the TeX primitive parameter used when - text is broken into lines. It should not be used in normal LaTeX - documents. + This entry is included for completeness: '\hsize' is the TeX + primitive parameter used when text is broken into lines. It should + not be used in normal LaTeX documents. '\topmargin' Space between the top of the TeX page (one inch from the top of the - paper, by default) and the top of the header. The default is + paper, by default) and the top of the header. The value is computed based on many other parameters: '\paperheight - 2in - \headheight - \headsep - \textheight - \footskip', and then divided by two. @@ -940,7 +1237,157 @@ the material on that page. No rubber lengths will be stretched. '\topskip' Minimum distance between the top of the page body and the baseline of the first line of text. For the standard classes, the default - is the same as the font size, e.g., '10pt' at '10pt'. + is the same as the font size, e.g., '10pt' at a type size of 10pt. + +5.6 Floats +========== + +Some typographic elements, such as figures and tables, cannot be broken +across pages. They must be typeset outside of the normal flow of text, +for instance floating to the top of a later page. + + LaTeX can have a number of different classes of floating material. +The default is the two classes, 'figure' (*note figure::) and 'table' +(*note table::), but you can create a new class with the package +'float'. + + Within any one float class LaTeX always respects the order, so that +the first figure in a document source must be typeset before the second +figure. However, LaTeX may mix the classes, so it can happen that while +the first table appears in the source before the first figure, it +appears in the output after it. + + The placement of floats is subject to parameters, given below, that +limit the number of floats that can appear at the top of a page, and the +bottom, etc. If so many floats are queued up that the limits prevent +them all from fitting on a page then LaTeX places what it can and defers +the rest to the next page. In this way, floats may be typset far from +their place in the source. In particular, a float that is big can +migrate to the end of the document. But then because all floats in a +class must appear in sequential order, every subsequent float in that +class also appears at the end. + + In addition to changing the parameters, for each float you can tweak +where the float placement algorithm tries to place it by using its +PLACEMENT argument. The possible values are a sequence of the letters +below. The default for both 'figure' and 'table', in both 'article' and +'book' classes, is 'tbp'. + +'t' + (Top)--at the top of a text page. + +'b' + (Bottom)--at the bottom of a text page. (However, 'b' is not + allowed for full-width floats ('figure*') with double-column + output. To ameliorate this, use the 'stfloats' or 'dblfloatfix' + package, but see the discussion at caveats in the FAQ: + <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat>. + +'h' + (Here)--at the position in the text where the 'figure' environment + appears. However, 'h' is not allowed by itself; 't' is + automatically added. + + To absolutely force a float to appear "here", you can + '\usepackage{float}' and use the 'H' specifier which it defines. + For further discussion, see the FAQ entry at + <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere>. + +'p' + (Page of floats)--on a separate "float page", which is a page + containing no text, only floats. + +'!' + Used in addition to one of the above; for this float only, LaTeX + ignores the restrictions on both the number of floats that can + appear and the relative amounts of float and non-float text on the + page. The '!' specifier does _not_ mean "put the float here"; see + above. + + Note: the order in which letters appear in the PLACEMENT argument +does not change the order in which LaTeX tries to place the float; for +instance, 'btp' has the same effect as 'tbp'. All that PLACEMENT does +is that if a letter is not present then the algorithm does not try that +location. Thus, LaTeX's default of 'tbp' is to try every location +except placing the float where it occurs in the source. + + To prevent LaTeX from moving floats to the end of the document or a +chapter you can use a '\clearpage' command to start a new page and +insert all pending floats. If a pagebreak is undesirable then you can +use the 'afterpage' package and issue '\afterpage{\clearpage}'. This +will wait until the current page is finished and then flush all +outstanding floats. + + LaTeX can typeset a float before where it appears in the source +(although on the same output page) if there is a 't' specifier in the +PLACEMENT paramater. If this is not desired, and deleting the 't' is +not acceptable as it keeps the float from being placed at the top of the +next page, then you can prevent it by either using the 'flafter' package +or using the command '\suppressfloats[t]', which causes floats for the +top position on this page to moved to the next page. + + Parameters relating to fractions of pages occupied by float and +non-float text (change them with '\renewcommand{PARAMETER}{DECIMAL +BETWEEN 0 AND 1}'): + +'\bottomfraction' + The maximum fraction of the page allowed to be occupied by floats + at the bottom; default '.3'. + +'\floatpagefraction' + The minimum fraction of a float page that must be occupied by + floats; default '.5'. + +'\textfraction' + Minimum fraction of a page that must be text; if floats take up too + much space to preserve this much text, floats will be moved to a + different page. The default is '.2'. + +'\topfraction' + Maximum fraction at the top of a page that may be occupied before + floats; default '.7'. + + Parameters relating to vertical space around floats (change them with +'\setlength{PARAMETER}{LENGTH EXPRESSION}'): + +'\floatsep' + Space between floats at the top or bottom of a page; default '12pt + plus2pt minus2pt'. + +'\intextsep' + Space above and below a float in the middle of the main text; + default '12pt plus2pt minus2pt' for 10 point and 11 point + documents, and '14pt plus4pt minus4pt' for 12 point documents. + +'\textfloatsep' + Space between the last (first) float at the top (bottom) of a page; + default '20pt plus2pt minus4pt'. + + Counters relating to the number of floats on a page (change them with +'\setcounter{CTRNAME}{NATURAL NUMBER}'): + +'bottomnumber' + Maximum number of floats that can appear at the bottom of a text + page; default 1. + +'dbltopnumber' + Maximum number of full-sized floats that can appear at the top of a + two-column page; default 2. + +'topnumber' + Maximum number of floats that can appear at the top of a text page; + default 2. + +'totalnumber' + Maximum number of floats that can appear on a text page; default 3. + + The principal TeX FAQ entry relating to floats +<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats> contains +suggestions for relaxing LaTeX's default parameters to reduce the +problem of floats being pushed to the end. A full explaination of the +float placement algorithm is Frank Mittelbach's article "How to infuence +the position of float environments like figure and table in LaTeX?" +<http://latex-project.org/papers/tb111mitt-float.pdf>. 6 Sectioning ************ @@ -1009,15 +1456,31 @@ Synopsis: A '\label' command appearing in ordinary text assigns to KEY the number of the current sectional unit; one appearing inside a numbered -environment assigns that number to KEY. +environment assigns that number to KEY. The assigned number can be +retrieved with the '\ref{KEY}' command (*note \ref::). + + Thus, in the example below the key 'sec:test' holds the number of the +current section and the key 'fig:test' that of the figure. +(Incidentally, labels must appear after captions in figures and tables.) + + \section{section name} + \label{sec:test} + This is Section~\ref{sec:test}. + \begin{figure} + ... + \caption{caption text} + \label{fig:test} + \end{figure} + See Figure~\ref{fig:test}. - A KEY name can consist of any sequence of letters, digits, or + A key name can consist of any sequence of letters, digits, or common punctuation characters. Upper and lowercase letters are distinguished, as usual. - To avoid accidentally creating two labels with the same name, it is -common to use labels consisting of a prefix and a suffix separated by a -colon or period. Some conventionally-used prefixes: + Although the name can be more or less anything, a common convention +is to use labels consisting of a prefix and a suffix separated by a +colon or period. This helps to avoid accidentally creating two labels +with the same name. Some commonly-used prefixes: 'ch' for chapters @@ -1030,8 +1493,7 @@ colon or period. Some conventionally-used prefixes: 'eq' for equations - Thus, a label for a figure would look like 'fig:snark' or -'fig.snark'. + Thus, a label for a figure would look like 'fig:test' or 'fig.test'. 7.2 '\pageref{KEY}' =================== @@ -1069,6 +1531,7 @@ environment begins and ends in the same manner: ============== Synopsis: + \begin{abstract} ... \end{abstract} @@ -1081,83 +1544,118 @@ paragraphs. Synopsis: - \begin{array}{TEMPLATE} - COL1 TEXT&COL1 TEXT&COLN}\\ + \begin{array}{COLS} + COLUMN 1 ENTRY &COLUMN 2 ENTRY ... &COLUMN N ENTRY \\ ... \end{array} - Math arrays are produced with the 'array' environment, normally -within an 'equation' environment (*note equation::). It has a single -mandatory TEMPLATE argument describing the number of columns and the -alignment within them. Each column COL is specified by a single letter -that tells how items in each row of that column should be formatted, as -follows: - -'c' - centered -'l' - flush left -'r' - flush right + or - Column entries are separated by '&'. Column entries may include -other LaTeX commands. Each row of the array is terminated with '\\'. - - In the template, the construct '@{TEXT}' puts TEXT between columns in -each row. + \begin{array}[POS]{COLS} + COLUMN 1 ENTRY &COLUMN 2 ENTRY ... &COLUMN N ENTRY \\ + ... + \end{array} - Here's an example: + Produce a mathematical array. This environment can only be used in +math mode, and normally appears within a displayed mathematics +environment such as 'equation' (*note equation::). Column entries are +separated by an ampersand ('&'). Rows are terminated with +double-backslashes ('\\') (*note \\::). + + The required argument COLS describes the number of columns, their +alignment, and the formatting of the intercolumn regions. See *note +tabular:: for the complete description of COLS, and of the other common +features of the two environments, including the optional POS argument. + + There are two ways that 'array' diverges from 'tabular'. The first +is that 'array' entries are typeset in mathematics mode, in textstyle +(except if the COLS definition specifies the column with '@p{..}', which +causes the entry to be typeset in text mode). The second is that, +instead of 'tabular''s parameter '\tabcolsep', LaTeX's intercolumn space +in an array is governed by '\arraycolsep' which gives half the width +between columns. The default for this is '5pt'. + + To obtain arrays with braces the standard is to use the 'amsmath' +package. It comes with environments 'pmatrix' for an array surrounded +by parentheses '(..)', 'bmatrix' for an array surrounded by square +brackets '[..]', 'Bmatrix' for an array surrounded by curly +braces '{..}', 'vmatrix' for an array surrounded by vertical +bars '|..|', and 'Vmatrix' for an array surrounded by double vertical +bars '||..||', along with a number of other array constructs. + + Here is an example of an array: \begin{equation} - \begin{array}{lrc} - left1 & right1 & centered1 \\ - left2 & right2 & centered2 \\ + \begin{array}{cr} + \sqrt{y} &12.3 \\ + x^2 &3.4 \end{array} \end{equation} - The '\arraycolsep' parameter defines half the width of the space -separating columns; the default is '5pt'. *Note tabular::, for other -parameters which affect formatting in 'array' environments, namely -'\arrayrulewidth' and '\arraystretch'. - - The 'array' environment can only be used in math mode. - 8.3 'center' ============ Synopsis: \begin{center} - LINE1 \\ - LINE2 \\ + .. text .. + \end{center} + + Environment to create a sequence of lines that are centered within +the left and right margins on the current page. If the text in the +environment body is too long to fit on a line, LaTeX will insert line +breaks that avoid hyphenation and avoid stretching or shrinking any +interword space. To force a line break at a particular spot use +double-backslash '\\' (*note \\::). + + This environment inserts space above and below the text body. See +*note \centering:: to avoid such space, for example inside a 'figure' +environment. + + In this example, depending on the line width, LaTeX may choose a +break for the part before the double backslash, will center the line or +two, then will break at the double backslash, and will center the +ending. + + \begin{center} + My father considered that anyone who went to chapel and didn't drink + alcohol was not to be tolerated.\\ + I grew up in that belief. --Richard Burton \end{center} - The 'center' environment allows you to create a paragraph consisting -of lines that are centered within the left and right margins on the -current page. Each line is terminated with the string '\\'. + A double backslash after the final line is optional. 8.3.1 '\centering' ------------------ -The '\centering' declaration corresponds to the 'center' environment. -This declaration can be used inside an environment such as 'quote' or in -a 'parbox'. Thus, the text of a figure or table can be centered on the -page by putting a '\centering' command at the beginning of the figure or -table environment. +Declaration that causes material in its scope to be centered. It is +most often used inside an environment such as 'figure', or in a +'parbox'. Unlike the 'center' environment, the '\centering' command does not -start a new paragraph; it simply changes how LaTeX formats paragraph -units. To affect a paragraph unit's format, the scope of the -declaration must contain the blank line or '\end' command (of an -environment such as quote) that ends the paragraph unit. - - Here's an example: +add vertical space above and below the text. + + It also does not start a new paragraph; it simply changes how LaTeX +formats paragraph units. If 'ww {\centering xx \\ yy} zz' is surrounded +by blank lines then LaTeX will create a paragraph whose first line 'ww +xx' is centered and whose second line, not centered, contains 'yy zz'. +Usually what is desired is for the scope of the declaration to contain a +blank line or the '\end' command of an environment such as 'figure' or +'table' that ends the paragraph unit. Thus, if '{\centering xx \\ +yy\par} zz' is surrounded by blank lines then it makes a new paragraph +with two centered lines 'xx' and 'yy', followed by a new paragraph with +'zz' that is formatted as usual. See also the following example. + + This example's '\centering' causes the graphic to be horizontally +centered. + + \begin{figure} + \centering + \includegraphics[width=0.6\textwidth]{ctan_lion.png} + \caption{CTAN Lion} \label{fig:CTANLion} + \end{figure} - \begin{quote} - \centering - first line \\ - second line \\ - \end{quote} + The scope of the '\centering' ends with the '\end{figure}'. 8.4 'description' ================= @@ -1165,22 +1663,39 @@ environment such as quote) that ends the paragraph unit. Synopsis: \begin{description} - \item [LABEL1] ITEM1 - \item [LABEL2] ITEM2 - ... + \item [FIRST LABEL] text of first item + \item [SECOND LABEL] text of second item + ... \end{description} - The 'description' environment is used to make labelled lists. Each -LABEL is typeset in bold, flush right. The ITEM text may contain -multiple paragraphs. + Environment to make a labelled list of items. Each item's LABEL is +typeset in bold, flush-left. Each item's text may contain multiple +paragraphs. Although the labels on the items are optional there is no +sensible default, so all items should have labels. + + The list consists of at least one item; see *note \item:: (having no +items causes the LaTeX error 'Something's wrong--perhaps a missing +\item'). Each item is produced with an '\item' command. - Another variation: since the bold style is applied to the labels, if -you typeset a label in typewriter using '\texttt', you'll get bold -typewriter: '\item[\texttt{bold and typewriter}]'. This may be too -bold, among other issues. To get just typewriter, use '\tt', which -resets all other style variations: '\item[{\tt plain typewriter}]'. + Since the labels are in bold style, if the label text calls for a +font change given in argument style (see *note Font styles::) then it +will come out bold. For instance, if the label text calls for +typewriter with '\item[\texttt{label text}]' then it will appear in bold +typewriter, if that is available. The simplest way to get non-bolded +typewriter is to use declaritive style '\item[{\tt label text}]'. +Similarly, get normal text use '\item[{\rm label text}]'. - For details about list spacing, see *note itemize::. + For other major LaTeX labelled list environments, see *note itemize:: +and *note enumerate::. For information about customizing list layout, +see *note list::; also, the package 'enumitem' is useful for this. + + This example shows the environment used for a sequence of +definitions. + + \begin{definition} + \item[lama] A priest. + \item[llama] A beast. + \end{definition} 8.5 'displaymath' ================= @@ -1188,25 +1703,74 @@ resets all other style variations: '\item[{\tt plain typewriter}]'. Synopsis: \begin{displaymath} - MATH + .. math text .. \end{displaymath} -or + Environment to typeset the math text on its own line, in display +style and centered. To make the text be flush-left use the global +option 'fleqn'; see *note Document class options::. + + LaTeX will not break the math text across lines. + + In the 'displaymath' environment no equation number is added to the +math text. One way to get an equation number is to use the 'equation' +environment (*note equation::). + + Note that the 'amsmath' package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. For example, there are a number of options in that +package for having math text broken across lines. + + The construct '\[..math text..\]' is essentially a synonym for +'\begin{displaymath}..math text..\end{displaymath}' but the latter is +easier to work with in the source file; for instance, searching for a +square bracket may get false positives but the word 'displaymath' will +likely be unique. (The construct '$$..math text..$$' from Plain TeX is +sometimes mistakenly used as a synonym for 'displaymath'. It is not a +synonym, because the 'displaymath' environment checks that it isn't +started in math mode and that it ends in math mode begun by the matching +environment start, because the 'displaymath' environment has different +vertical spacing, and because the 'displaymath' environment honors the +'fleqn' option.) + + The output from this example is centered and alone on its line. + \begin{displaymath} + \int_1^2 x^2\,dx=7/3 + \end{displaymath} + Also, the integral sign is larger than the inline version '\( +\int_1^2 x^2\,dx=7/3 \)' produces. - \[MATH\] +8.6 'document' +============== - The 'displaymath' environment ('\[...\]' is a synonym) typesets the -MATH text on its own line, centered by default. The global 'fleqn' -option makes equations flush left; see *note Document class options::. +The 'document' environment encloses the entire body of a document. It +is required in every LaTeX document. *Note Starting and ending::. - No equation number is added to 'displaymath' text; to get an equation -number, use the 'equation' environment (*note equation::). +Synopsis: -8.6 'document' -============== + \AtBeginDocument{CODE} + + Save CODE and execute it when '\begin{document}' is executed, at the +very end of the preamble. The code is executed after the font selection +tables have been set up, so the normal font for the document is the +current font. However, the code is executed as part of the preamble so +you cannot do any typesetting with it. + + You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. + +Synopsis: -The 'document' environment encloses the body of a document. It is -required in every LaTeX document. *Note Starting and ending::. + \AtEndDocument{CODE} + + Save CODE and execute it near the end of the document. Specifically, +it is executed when '\end{document}' is executed, before the final page +is finished and before any leftover floating environments are processed. +If you want some of the code to be executed after these two processes +then include a '\clearpage' at the appropriate point in CODE. + + You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. 8.7 'enumerate' =============== @@ -1214,243 +1778,237 @@ required in every LaTeX document. *Note Starting and ending::. Synopsis: \begin{enumerate} - \item ITEM1 - \item ITEM2 + \item [FIRST LABEL] text of first item + \item [SECOND LABEL] text of second item ... \end{enumerate} - The 'enumerate' environment produces a numbered list. Enumerations -can be nested within one another, up to four levels deep. They can also -be nested within other paragraph-making environments, such as 'itemize' -(*note itemize::) and 'description' (*note description::). + Environment to produce a numbered list of items. The format of the +label numbering depends on whether this environment is nested within +another; see below. + + The list consists of at least one item. Having no items causes the +LaTeX error 'Something's wrong--perhaps a missing \item'. Each item is +produced with an '\item' command. - Each item of an enumerated list begins with an '\item' command. -There must be at least one '\item' command within the environment. + This example lists the top two finishers in the 1908 Olympic +marathon. - By default, the numbering at each level is done like this: + \begin{enumerate} + \item Johnny Hayes (USA) + \item Charles Hefferon (RSA) + \end{enumerate} + + Enumerations may be nested within a paragraph-making environment, +including 'itemize' (*note itemize::), 'description' (*note +description::) and 'enumeration', up to four levels deep. The format of +the label produced depends on the place in the nesting. This gives +LaTeX's default for the format at each nesting level (where 1 is the +outermost level): - 1. 1., 2., ... - 2. (a), (b), ... - 3. i., ii., ... - 4. A., B., ... + 1. arabic number followed by a period: '1.', '2.', ... + 2. lower case letter inside parentheses: '(a)', '(b)' ... + 3. lower case roman numeral followed by a period: 'i.', 'ii.', ... + 4. upper case letter followed by a period: 'A.', 'B.', ... The 'enumerate' environment uses the counters '\enumi' through -'\enumiv' counters (*note Counters::). If the optional argument to -'\item' is given, the counter is not incremented for that item. +'\enumiv' counters (*note Counters::). If you use the optional argument +to '\item' then the counter is not incremented for that item (*note +\item::). + + To change the format of the label use '\renewcommand' (*note +\newcommand & \renewcommand::) on the commands '\labelenumi' through +'\labelenumiv'. For instance, this first level list will be labelled +with uppercase letters, in boldface, and without a trailing period: + + \renewcommand{\labelenumi}{\textbf{\Alph{enumi}}} + \begin{enumerate} + \item eI + \item bi: + \item si: + \end{enumerate} - The 'enumerate' environment uses the commands '\labelenumi' through -'\labelenumiv' to produce the default label. So, you can use -'\renewcommand' to change the labels (*note \newcommand & -\renewcommand::). For instance, to have the first level use uppercase -letters: + For a list of counter-labelling commands like '\Alph' see *note \alph +\Alph \arabic \roman \Roman \fnsymbol::. - \renewcommand{\labelenumi}{\Alph{enumi}} + For more on customizing the layout see *note list::. Also, the +package 'enumitem' is useful for this. 8.8 'eqnarray' ============== -First, a caveat: the 'eqnarray' environment has some infelicities which -cannot be overcome; the article "Avoid eqnarray!" by Lars Madsen -describes them in detail -(<http://tug.org/TUGboat/tb33-1/tb103madsen.pdf>). The bottom line is -that it is better to use the 'align' environment (and others) from the -'amsmath' package. +First, a caveat: the 'eqnarray' environment is depreciated. It has +infelicities that cannot be overcome, including spacing that is +inconsistent with other mathematics elements (see the article "Avoid +eqnarray!" by Lars Madsen +<http://tug.org/TUGboat/tb33-1/tb103madsen.pdf>). New documents should +include the 'amsmath' package and use the displayed mathematics +environments provided there, such as the 'align' environment. - Nevertheless, here is a description of 'eqnarray': + Nevertheless, for completeness and for a reference when working with +old documents, a synopsis: - \begin{eqnarray} (or 'eqnarray*') - FORMULA1 \\ - FORMULA2 \\ - ... + \begin{eqnarray} + FIRST FORMULA LEFT &FIRST FORMULA MIDDLE &FIRST FORMULA RIGHT \\ + ... \end{eqnarray} - The 'eqnarray' environment is used to display a sequence of equations -or inequalities. It is similar to a three-column 'array' environment, -with consecutive rows separated by '\\' and consecutive items within a -row separated by an '&'. + or + + \begin{eqnarray*} + FIRST FORMULA LEFT &FIRST FORMULA MIDDLE &FIRST FORMULA RIGHT \\ + ... + \end{eqnarray*} + + Display a sequence of equations or inequalities. The left and right +sides are typeset in display mode, while the middle is typeset in text +mode. - '\\*' can also be used to separate equations, with its normal meaning -of not allowing a page break at that line. + It is similar to a three-column 'array' environment, with items +within a row separated by an ampersand ('&'), and with rows separated by +double backslash '\\'). The starred form of line break ('\\*') can +also be used to separate equations, and will disallow a page break there +(*note \\::). - An equation number is placed on every line unless that line has a -'\nonumber' command. Alternatively, The '*'-form of the environment -('\begin{eqnarray*} ... \end{eqnarray*}') will omit equation numbering -entirely, while otherwise being the same as 'eqnarray'. + The unstarred form 'eqnarray' places an equation number on every line +(using the 'equation' counter), unless that line contains a '\nonumber' +command. The starred form 'eqnarray*' omits equation numbering, while +otherwise being the same. The command '\lefteqn' is used for splitting long formulas across lines. It typesets its argument in display style flush left in a box of zero width. + This example shows three lines. The first two lines make an +inequality, while the third line has not entry on the left side. + + \begin{eqnarray*} + \lefteqn{x_1+x_2+\cdots+x_n} \\ + &\leq &y_1+y_2+\cdots+y_n \\ + &= &z+y_3+\cdots+y_n + \end{eqnarray*} + 8.9 'equation' ============== Synopsis: \begin{equation} - MATH + math text \end{equation} - The 'equation' environment starts a 'displaymath' environment (*note -displaymath::), e.g., centering the MATH text on the page, and also -places an equation number in the right margin. + Make a 'displaymath' environment (*note displaymath::) with an +equation number in the right margin. + + The equation number is generated using the 'equation' counter. + + Note that the 'amsmath' package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. 8.10 'figure' ============= - \begin{figure[*]}[PLACEMENT] - FIGBODY +Synopsis: + + \begin{figure}[PLACEMENT] + figure body + \caption[LOFTITLE]{TITLE} \label{LABEL} - \caption[LOFTITLE]{TEXT} \end{figure} - Figures are objects that are not part of the normal text, and are -instead "floated" to a convenient place, such as the top of a page. -Figures will not be split between two pages. - - When typesetting in double-columns, the starred form produces a -full-width figure (across both columns). - - The optional argument '[placement]' determines where LaTeX will try -to place your figure. There are four places where LaTeX can possibly -put a float: - -'t' - (Top)--at the top of a text page. - -'b' - (Bottom)--at the bottom of a text page. However, 'b' is not - allowed for full-width floats ('figure*') with double-column - output. To ameliorate this, use the 'stfloats' or 'dblfloatfix' - package, but see the discussion at caveats in the FAQ: - <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat>. - -'h' - (Here)--at the position in the text where the 'figure' environment - appears. However, 't' is not allowed by itself; 't' is - automatically added. - - To absolutely force a figure to appear "here", you can - '\usepackage{float}' and use the 'H' specifier which it defines. - For further discussion, see the FAQ entry at - <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere>. - -'p' - (Page of floats)--on a separate float page, which is a page - containing no text, only floats. - -'!' - Used in addition to one of the above; for this float only, LaTeX - ignores the restrictions on both the number of floats that can - appear and the relative amounts of float and non-float text on the - page. The '!' specifier does _not_ mean "put the float here"; see - above. + or - The standard 'report' and 'article' classes use the default placement -'tbp'. - - The body of the figure is made up of whatever text, LaTeX commands, -etc. you wish. - - The '\caption' command specifies caption TEXT for the figure. The -caption is numbered by default. If LOFTITLE is present, it is used in -the list of figures instead of TEXT (*note Tables of contents::). - - Parameters relating to fractions of pages occupied by float and -non-float text: - - The maximum fraction of the page allowed to be occupied by floats - at the bottom; default '.3'. - -'\floatpagefraction' - The minimum fraction of a float page that must be occupied by - floats; default '.5'. - -'\textfraction' - Minimum fraction of a page that must be text; if floats take up too - much space to preserve this much text, floats will be moved to a - different page. The default is '.2'. - -'\topfraction' - Maximum fraction at the top of a page that may be occupied before - floats; default '.7'. - - Parameters relating to vertical space around floats: - -'\floatsep' - Space between floats at the top or bottom of a page; default '12pt - plus2pt minus2pt'. - -'\intextsep' - Space above and below a float in the middle of the main text; - default '12pt plus2pt minus2pt' for '10pt' and '11pt' styles, '14pt - plus4pt minus4pt' for '12pt'. - -'\textfloatsep' - Space between the last (first) float at the top (bottom) of a page; - default '20pt plus2pt minus4pt'. - - Counters relating to the number of floats on a page: - -'bottomnumber' - Maximum number of floats that can appear at the bottom of a text - page; default 1. - -'dbltopnumber' - Maximum number of full-sized floats that can appear at the top of a - two-column page; default 2. - -'topnumber' - Maximum number of floats that can appear at the top of a text page; - default 2. - -'totalnumber' - Maximum number of floats that can appear on a text page; default 3. + \begin{figure*}[PLACEMENT] + figure body + \caption[LOFTITLE]{TITLE} + \label{LABEL} + \end{figure*} + + A class of floats (*note Floats::). Because they cannot be split +across pages, they are not typeset in sequence with the normal text but +instead are "floated" to a convenient place, such as the top of a +following page. + + For the possible values of PLACEMENT and their effect on the float +placement algorithm, see *note Floats::. + + The starred form 'figure*' is used when a document is in +double-column mode (*note \twocolumn::). It produces a figure that +spans both columns, at the top of the page. To add the possibility of +placing at a page bottom see the discussion of PLACEMENT 'b' in *note +Floats::. + + The figure body is typeset in a 'parbox' of width '\textwidth' and so +it can contain text, commands, etc. + + The label is optional; it is used for cross-references (*note Cross +references::). The optional '\caption' command specifies caption text +for the figure. By default it is numbered. If LOFTITLE is present, it +is used in the list of figures instead of TITLE (*note Tables of +contents::). + + This example makes a figure out of a graphic. It requires one of the +packages 'graphics' or 'graphicx'. The graphic, with its caption, will +be placed at the top of a page or, if it is pushed to the end of the +document, on a page of floats. + + \begin{figure}[t] + \centering + \includegraphics[width=0.5\textwidth]{CTANlion.png} + \caption{The CTAN lion, by Duane Bibby} + \end{figure} - The principal TeX FAQ entry relating to floats: -<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats>. - -8.11 'filecontents': Create external files -========================================== +8.11 'filecontents': Write an external file +=========================================== Synopsis: \begin{filecontents}{FILENAME} - CONTENTS-OF-FILE + TEXT \end{filecontents} - ... - \documentclass{MY-DOCUMENT-CLASS} - The 'filecontents' environment is an "initial command", meaning that -it can be used only before the '\documentclass' command, as in the -synopsis above. + or - LaTeX will create a file named FILENAME with the content -CONTENTS-OF-FILE preceded by a header comment indicating how and when -the file was generated. If the file already exists then nothing will -happen. + \begin{filecontents*}{FILENAME} + TEXT + \end{filecontents*} - You can also use the 'filecontents' package, which has the following -advantages: + Create a file named FILENAME and fill it with TEXT. The unstarred +version of the environment 'filecontents' prefixes the content of the +created file with a header; see the example below. The starred version +'filecontents*' does not include the header. - * If the file already exists, then it will be overwritten. + This environment can be used anywhere in the preamble, although it +often appears before the '\documentclass' command. It is typically used +when a source file requires a nonstandard style or class file. The +environment will write that file to the directory containing the source +and thus make the source file self-contained. Another use is to include +'bib' references in the file, again to make it self-contained. - * You can use the 'filecontents' environment at any point after the - declaration '\usepackage{filecontents}', not just before - '\documentclass'. + The environment checks whether a file of that name already exists and +if so, does not do anything. There is a 'filecontents' package that +redefines the 'filecontents' environment so that instead of doing +nothing in that case, it will overwrite the existing file. - * The 'filecontents' package also provides a 'filecontents*' - environment which is used in the same way as the 'filecontents' - environment except that it won't insert any leading comment, so it - is better suited to create files which aren't in LaTeX format. + For example, this document - The 'filecontents' environment only creates the file, and is -unrelated to using the created file. So you need to use, for instance, -'\input' or '\usepackage' or '\bibliography' or whatever is applicable, -to use the created file. + \documentclass{article} + \begin{filecontents}{JH.sty} + \newcommand{\myname}{Jim Hef{}feron} + \end{filecontents} + \usepackage{JH} + \begin{document} + Article by \myname. + \end{document} - This environment is also useful to make a document in a -self-contained file, for example, for a bug report, or to keep the -content of a '.bib' file in the same file as the main document. + produces this file 'JH.sty'. + + %% LaTeX2e file `JH.sty' + %% generated by the `filecontents' environment + %% from source `test' on 2015/10/12. + %% + \newcommand{\myname}{Jim Hef{}feron} 8.12 'flushleft' ================ @@ -1463,7 +2021,7 @@ content of a '.bib' file in the same file as the main document. The 'flushleft' environment allows you to create a paragraph consisting of lines that are flush to the left-hand margin and ragged -right Each line must be terminated with the string '\\'. +right. Each line must be terminated with the string '\\'. 8.12.1 '\raggedright' --------------------- @@ -1489,7 +2047,7 @@ paragraph unit. The 'flushright' environment allows you to create a paragraph consisting of lines that are flush to the right-hand margin and ragged -left. Each line must be terminated with the string '\\'. +left. Each line must be terminated with the control sequence '\\'. 8.13.1 '\raggedleft' -------------------- @@ -1636,6 +2194,37 @@ empty, i.e., '{}', which leaves the default spacing. The width used for typesetting the list items is specified by '\linewidth' (*note Page layout parameters::). +Synopsis: + + \item text of item + + or + \item[OPTIONAL LABEL] text of item + + An entry in a list. The entries are prefixed by a label, whose +default depends on the list type. + + Because the optional argument OPTIONAL LABEL is surrounded by square +brackets ('[' and ']'), to use square brackets inside the optional +argument you must hide them inside curly braces, as in '\item[Close +square bracket, {]}]'. Similarly, to use an open square bracket as +first character in the text of the item, also hide it inside curly +braces. *Note LaTeX command syntax::. + + In this example the 'enumerate' list has two items that use the +default label and one that uses the optional label. + + \begin{enumerate} + \item Moe + \item[sometimes] Shemp + \item Larry + \end{enumerate} + + The first item is labelled '1.', the second item is labelled +'sometimes', and the third item is labelled '2.' (note that, because of +the optional label in the second item, the third item does not get a +'3.'). + 8.17 'math' =========== @@ -1646,7 +2235,7 @@ Synopsis: \end{math} The 'math' environment inserts the given MATH within the running -text. '\(...\))' and '$...$' are synonyms. *Note Math formulas::. +text. '\(...\)' and '$...$' are synonyms. *Note Math formulas::. 8.18 'minipage' =============== @@ -1679,7 +2268,7 @@ footnotes; they may wind up at the bottom of the wrong minipage. 8.19 'picture' ============== - \begin{picture}(width,height)(x offset,y offset) + \begin{picture}(WIDTH,HEIGHT)(XOFFSET,YOFFSET) ... PICTURE COMMANDS ... \end{picture} @@ -1696,24 +2285,24 @@ a length of 2.54 centimeters. '\setlength' command, outside of a 'picture' environment. The default value is '1pt'. - A position is a pair of coordinates, such as '(2.4,-5)', specifying + A "position" is a pair of coordinates, such as '(2.4,-5)', specifying the point with x-coordinate '2.4' and y-coordinate '-5'. Coordinates are specified in the usual way with respect to an origin, which is normally at the lower-left corner of the picture. Note that when a position appears as an argument, it is not enclosed in braces; the parentheses serve to delimit the argument. - The 'picture' environment has one mandatory argument, which is a -'position'. It specifies the size of the picture. The environment -produces a rectangular box with width and height determined by this -argument's x- and y-coordinates. + The 'picture' environment has one mandatory argument which is a +position (WIDTH,HEIGHT), which specifies the size of the picture. The +environment produces a rectangular box with these WIDTH and HEIGHT. - The 'picture' environment also has an optional 'position' argument, -following the 'size' argument, that can change the origin. (Unlike -ordinary optional arguments, this argument is not contained in square -brackets.) The optional argument gives the coordinates of the point at -the lower-left corner of the picture (thereby determining the origin). -For example, if '\unitlength' has been set to '1mm', the command + The 'picture' environment also has an optional position argument +(XOFFSET,YOFFSET), following the size argument, that can change the +origin. (Unlike ordinary optional arguments, this argument is not +contained in square brackets.) The optional argument gives the +coordinates of the point at the lower-left corner of the picture +(thereby determining the origin). For example, if '\unitlength' has +been set to '1mm', the command \begin{picture}(100,200)(10,20) @@ -1750,6 +2339,7 @@ corner of the box. ---------------- Synopsis: + \circle[*]{DIAMETER} The '\circle' command produces a circle with a diameter as close to @@ -1762,6 +2352,7 @@ solid circle. ----------------- Synopsis: + \makebox(WIDTH,HEIGHT)[POSITION]{TEXT} The '\makebox' command for the picture environment is similar to the @@ -1867,6 +2458,7 @@ and *note \thicklines::. ------------------- Synopsis: + \multiput(X,Y)(DELTA_X,DELTA_Y){N}{OBJ} The '\multiput' command copies the object OBJ in a regular pattern @@ -1881,17 +2473,20 @@ Synopsis: \oval(WIDTH,HEIGHT)[PORTION] The '\oval' command produces a rectangle with rounded corners. The -optional argument PORTION allows you to select part of the oval via the -following: +optional argument PORTION allows you to produce only half of the oval +via the following: 't' - selects the top portion; + selects the top half; 'b' - selects the bottom portion; + selects the bottom half; 'r' - selects the right portion; + selects the right half; 'l' - selects the left portion. + selects the left half. + + It is also possible to produce only one quarter of the oval by +setting PORTION to 'tr', 'br', 'bl', or 'tl'. The "corners" of the oval are made with quarter circles with a maximum radius of 20pt, so large "ovals" will look more like boxes with @@ -1937,8 +2532,8 @@ Synopsis: length and slope. The XSLOPE and YSLOPE values must lie between -4 and +4, inclusive. -8.20 'quotation' -================ +8.20 'quotation' and 'quote' +============================ Synopsis: @@ -1946,28 +2541,34 @@ Synopsis: TEXT \end{quotation} - The margins of the 'quotation' environment are indented on both the -left and the right. The text is justified at both margins. Leaving a -blank line between text produces a new paragraph. - - Unlike the 'quote' environment, each paragraph is indented normally. - -8.21 'quote' -============ - -Synopsis: + or \begin{quote} TEXT \end{quote} - The margins of the 'quote' environment are indented on both the left -and the right. The text is justified at both margins. Leaving a blank -line between text produces a new paragraph. + Include a quotation. + + In both environments, margins are indented on both sides by +'\leftmargin' and the text is justified at both. As with the main text, +leaving a blank line produces a new paragraph. - Unlike the 'quotation' environment, paragraphs are not indented. + To compare the two: in the 'quotation' environment, paragraphs are +indented by 1.5em and the space between paragraphs is small, '0pt plus +1pt'. In the 'quote' environment, paragraphs are not indented and there +is vertical space between paragraphs (it is the rubber length +'\parsep'). Thus, the 'quotation' environment may be more suitable for +documents where new paragraphs are marked by an indent rather than by a +vertical separation. In addition, 'quote' may be more suitable for a +short quotation or a sequence of short quotations. -8.22 'tabbing' + \begin{quotation} + \it Four score and seven years ago + .. shall not perish from the earth. + \hspace{1em plus 1fill}---Abraham Lincoln + \end{quotation} + +8.21 'tabbing' ============== Synopsis: @@ -2011,7 +2612,7 @@ environment. '\' (tabbing)' Moves everything that you have typed so far in the current column, - i.e. everything from the most recent '\>', '\<', '\'', '\\', or + i.e., everything from the most recent '\>', '\<', '\'', '\\', or '\kill' command, to the right of the previous column, flush against the current column's tab stop. @@ -2058,78 +2659,108 @@ environment. end;\\ \end{tabbing} -8.23 'table' +8.22 'table' ============ Synopsis: - \begin{table}[placement] - - body of the table - - \caption{table title} - \end{table} - - Tables are objects that are not part of the normal text, and are -usually "floated" to a convenient place, like the top of a page. Tables -will not be split between two pages. - - The optional argument '[placement]' determines where LaTeX will try -to place your table. There are four places where LaTeX can possibly put -a float; these are the same as that used with the 'figure' environment, -and described there (*note figure::). - - The standard 'report' and 'article' classes use the default placement -'[tbp]'. - - The body of the table is made up of whatever text, LaTeX commands, -etc., you wish. The '\caption' command allows you to title your table. - -8.24 'tabular' + \begin{table}[PLACEMENT] + table body + \caption[LOFTITLE]{TITLE} + \label{LABEL} + \end{table} + + A class of floats (*note Floats::). Because they cannot be split +across pages, they are not typeset in sequence with the normal text but +instead are "floated" to a convenient place, such as the top of a +following page. + + For the possible values of PLACEMENT and their effect on the float +placement algorithm, see *note Floats::. + + The table body is typeset in a 'parbox' of width '\textwidth' and so +it can contain text, commands, etc. + + The label is optional; it is used for cross-references (*note Cross +references::). The optional '\caption' command specifies caption text +for the table. By default it is numbered. If LOTTITLE is present, it +is used in the list of tables instead of TITLE (*note Tables of +contents::). + + In this example the table and caption will float to the bottom of a +page, unless it is pushed to a float page at the end. + + \begin{table}[b] + \centering + \begin{tabular}{r|p{2in}} \hline + One &The loneliest number \\ + Two &Can be as sad as one. + It's the loneliest number since the number one. + \end{tabular} + \caption{Cardinal virtues} + \label{tab:CardinalVirtues} + \end{table} + +8.23 'tabular' ============== Synopsis: - \begin{tabular}[pos]{cols} - column 1 entry & column 2 entry ... & column n entry \\ - ... + \begin{tabular}[POS]{COLS} + column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular} or - \begin{tabular*}{width}[pos]{cols} - column 1 entry & column 2 entry ... & column n entry \\ - ... + \begin{tabular*}{WIDTH}[POS]{COLS} + column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular*} - These environments produce a box consisting of a sequence of rows of -items, aligned vertically in columns. - - '\\' must be used to specify the end of each row of the table, except -for the last, where it is optional--unless an '\hline' command (to put a -rule below the table) follows. - - The mandatory and optional arguments consist of: + These environments produce a table, a box consisting of a sequence of +horizontal rows. Each row consists of items that are aligned vertically +in columns. This illustrates many of the features. -'width' - Specifies the width of the 'tabular*' environment. There must be - rubber space between columns that can stretch to fill out the - specified width. - -'pos' - Specifies the vertical position; default is alignment on the centre - of the environment. + \begin{tabular}{l|l} + \textit{Player name} &\textit{Career home runs} \\ + \hline + Hank Aaron &755 \\ + Babe Ruth &714 + \end{tabular} - 't' - align on top row + The vertical format of two left-aligned columns, with a vertical bar +between them, is specified in 'tabular''s argument '{l|l}'. Columns are +separated with an ampersand '&'. A horizontal rule between two rows is +created with '\hline'. The end of each row is marked with a double +backslash '\\'. This '\\' is optional after the last row unless an +'\hline' command follows, to put a rule below the table. - 'b' - align on bottom row + The required and optional arguments to 'tabular' consist of: -'cols' - Specifies the column formatting. It consists of a sequence of the - following specifiers, corresponding to the sequence of columns and - intercolumn material. +WIDTH + Required for 'tabular*', not allowed for 'tabular'. Specifies the + width of the 'tabular*' environment. The space between columns + should be rubber, as with '@{\extracolsep{\fill}}', to allow the + table to stretch or shrink to make the specified width, or else you + are likely to get the 'Underfull \hbox (badness 10000) in alignment + ..' warning. + +POS + Optional. Specifies the table's vertical position. The default is + to align the table so its vertical center matches the baseline of + the surrounding text. There are two other possible alignments: 't' + aligns the table so its top row matches the baseline of the + surrounding text, and 'b' aligns on the bottom row. + + This only has an effect if there is other text. In the common case + of a 'tabular' alone in a 'center' environment this option makes no + difference. + +COLS + Required. Specifies the formatting of columns. It consists of a + sequence of the following specifiers, corresponding to the types of + column and intercolumn material. 'l' A column of left-aligned items. @@ -2143,110 +2774,254 @@ rule below the table) follows. '|' A vertical line the full height and depth of the environment. - '@{TEXT}' - This inserts TEXT in every row. An @-expression suppresses - the intercolumn space normally inserted between columns; any - desired space before the adjacent item must be included in - TEXT. - - To insert commands that are automatically executed before a - given column, you have to load the 'array' package and use the - '>{...}' specifier. - - An '\extracolsep{wd}' command in an @-expression causes an - extra space of width 'wd' to appear to the left of all + '@{TEXT OR SPACE}' + This inserts TEXT OR SPACE at this location in every row. The + TEXT OR SPACE material is typeset in LR mode. This text is + fragile (*note \protect::). + + This specifier is optional: unless you put in your own + @-expression then LaTeX's book, article, and report classes + will put on either side of each column a space of length + '\tabcolsep', which by default is '6pt'. That is, by default + adjacent columns are separated by 12pt (so '\tabcolsep' is + misleadingly-named since it is not the separation between + tabular columns). Also by default a space of 6pt comes before + the first column as well as after the final column, unless you + put a '@{..}' or '|' there. + + If you override the default and use an @-expression then you + must insert any desired space yourself, as in + '@{\hspace{1em}}'. + + An empty expression '@{}' will eliminate the space, including + the space at the start or end, as in the example below where + the tabular lines need to lie on the left margin. + + \begin{flushleft} + \begin{tabular}{@{}l} + .. + \end{tabular} + \end{flushleft} + + This example shows text, a decimal point, between the columns, + arranged so the numbers in the table are aligned on that + decimal point. + + \begin{tabular}{r@{$.$}l} + $3$ &$14$ \\ + $9$ &$80665$ + \end{tabular} + + An '\extracolsep{WD}' command in an @-expression causes an + extra space of width WD to appear to the left of all subsequent columns, until countermanded by another '\extracolsep' command. Unlike ordinary intercolumn space, this extra space is not suppressed by an @-expression. An '\extracolsep' command can be used only in an @-expression in - the 'cols' argument. + the 'cols' argument. Below, LaTeX inserts the right amount of + intercolumn space to make the entire table 4 inches wide. + + \begin{center} + \begin{tabular*}{4in}{l@{\ \ldots\extracolsep{\fill}}l} + Seven times down, eight times up + &such is life! + \end{tabular*} + \end{center} + + To insert commands that are automatically executed before a + given column, load the 'array' package and use the '>{...}' + specifier. 'p{WD}' - Produces a column with each item typeset in a parbox of width - WD, as if it were the argument of a '\parbox[t]{WD}' command. - However, a '\\' may not appear in the item, except in the - following situations: - - 1. inside an environment like 'minipage', 'array', or - 'tabular'. - 2. inside an explicit '\parbox'. - 3. in the scope of a '\centering', '\raggedright', or - '\raggedleft' declaration. The latter declarations must - appear inside braces or an environment when used in a - 'p'-column element. + Each item in the column is typeset in a parbox of width WD. + + Note that a line break double backslash '\\' may not appear in + the item, except inside an environment like 'minipage', + 'array', or 'tabular', or inside an explicit '\parbox', or in + the scope of a '\centering', '\raggedright', or '\raggedleft' + declaration (when used in a 'p'-column element these + declarations must appear inside braces, as with '{\centering + .. \\ ..}'). Otherwise LaTeX will misinterpret the double + backslash as ending the row. '*{NUM}{COLS}' Equivalent to NUM copies of COLS, where NUM is a positive - integer and COLS is any list of column-specifiers, which may - contain another '*-expression'. + integer and COLS is a list of specifiers. Thus + '\begin{tabular}{|*{3}{l|r}|}' is equivalent to + '\begin{tabular}{|l|rl|rl|r|}'. Note that COLS may contain + another '*-expression'. Parameters that control formatting: '\arrayrulewidth' - Thickness of the rule created by '|', '\hline', and '\vline' in the - 'tabular' and 'array' environments; the default is '.4pt'. + A length that is the thickness of the rule created by '|', + '\hline', and '\vline' in the 'tabular' and 'array' environments. + The default is '.4pt'. Change it as in + '\setlength{\arrayrulewidth}{0.8pt}'. '\arraystretch' - Scaling of spacing between rows in the 'tabular' and 'array' - environments; default is '1', for no scaling. + A factor by which the spacing between rows in the 'tabular' and + 'array' environments is multiplied. The default is '1', for no + scaling. Change it as '\renewcommand{\arraystretch}{1.2}'. '\doublerulesep' - Horizontal distance between the vertical rules produced by '||' in - the 'tabular' and 'array' environments; default is '2pt'. + A length that is the distance between the vertical rules produced + by the '||' specifier. The default is '2pt'. '\tabcolsep' - Half the width of the space between columns; default is '6pt'. + A length that is half of the space between columns. The default is + '6pt'. Change it with '\setlength'. - The following commands can be used inside a 'tabular' environment: + The following commands can be used inside the body of a 'tabular' +environment, the first two inside an entry and the second two between +lines: -8.24.1 '\multicolumn' +8.23.1 '\multicolumn' --------------------- Synopsis: - \multicolumn{COLS}{POS}{TEXT} - - The '\multicolumn' command makes an entry that spans several columns. -The first mandatory argument, COLS, specifies the number of columns to -span. The second mandatory argument, POS, specifies the formatting of -the entry; 'c' for centered, 'l' for flushleft, 'r' for flushright. The -third mandatory argument, TEXT, specifies what text to put in the entry. - - Here's an example showing two columns separated by an en-dash; -'\multicolumn' is used for the heading: - - \begin{tabular}{r@{--}l} - \multicolumn{2}{c}{\bf Unicode}\cr - 0x80&0x7FF \cr - 0x800&0xFFFF \cr - 0x10000&0x1FFFF \cr + + \multicolumn{NUMCOLS}{COLS}{TEXT} + + Make an 'array' or 'tabular' entry that spans several columns. The +first argument NUMCOLS gives the number of columns to span. The second +argument COLS specifies the formatting of the entry, with 'c' for +centered, 'l' for flush left, or 'r' for flush right. The third +argument TEXT gives the contents of that entry. + + In this example, in the first row, the second and third columns are +spanned by the single heading 'Name'. + + \begin{tabular}{lccl} + \textit{ID} &\multicolumn{2}{c}{\textit{Name}} &\textit{Age} \\ \hline % row one + 978-0-393-03701-2 &O'Brian &Patrick &55 \\ % row two + .. + \end{tabular} + + What counts as a column is: the column format specifier for the +'array' or 'tabular' environment is broken into parts, where each part +(except the first) begins with 'l', 'c', 'r', or 'p'. So from +'\begin{tabular}{|r|ccp{1.5in}|}' the parts are '|r|', 'c', 'c', +and 'p{1.5in}|'. + + The COLS argument overrides the 'array' or 'tabular' environment's +intercolumn area default adjoining this multicolumn entry. To affect +that area, this argument can contain vertical bars '|' indicating the +placement of vertical rules, and '@{..}' expressions. Thus if COLS is +'|c|' then this multicolumn entry will be centered and a vertical rule +will come in the intercolumn area before it and after it. This table +details the exact behavior. + + \begin{tabular}{|cc|c|c|} + \multicolumn{1}{r}{w} % entry one + &\multicolumn{1}{|r|}{x} % entry two + &\multicolumn{1}{|r}{y} % entry three + &z % entry four \end{tabular} + Before the first entry the output will not have a vertical rule +because the '\multicolumn' has the COLS specifier 'r' with no initial +vertical bar. Between entry one and entry two there will be a vertical +rule; although the first COLS does not have an ending vertical bar, the +second COLS does have a starting one. Between entry two and entry three +there is a single vertical rule; despite that the COLS in both of the +surrounding 'multicolumn''s call for a vertical rule, you only get one +rule. Between entry three and entry four there is no vertical rule; the +default calls for one but the COLS in the entry three '\multicolumn' +leaves it out, and that takes precedence. Finally, following entry four +there is a vertical rule because of the default. + + The number of spanned columns NUMCOLS can be 1. Besides giving the +ability to change the horizontal alignment, this also is useful to +override for one row the 'tabular' definition's default intercolumn area +specification, including the placement of vertical rules. + + In the example below, in the 'tabular' definition the first column is +specified to default to left justified but in the first row the entry is +centered with '\multicolumn{1}{c}{\textsc{Period}}'. Also in the first +row, the second and third columns are spanned by a single entry with +'\multicolumn{2}{c}{\textsc{Span}}', overriding the specification to +center those two columns on the page range en-dash. + + \begin{tabular}{l|r@{--}l} + \multicolumn{1}{c}{\textsc{Period}} + &multicolumn{2}{c}{\textsc{Span}} \\ \hline + Baroque &1600 &1760 \\ + Classical &1730 &1820 \\ + Romantic &1780 &1910 \\ + Impressionistic &1875 &1925 + \end{tabular} + + Note that although the 'tabular' specification by default puts a +vertical rule between the first and second columns, because there is no +vertical bar in the COLS of either of the first row's '\multicolumn' +commands, no rule appears in the first row. -8.24.2 '\cline' +8.23.2 '\vline' +--------------- + +Draw a vertical line in a 'tabular' or 'array' environment extending the +full height and depth of an entry's row. Can also be used in an +@-expression, although its synonym vertical bar '|' is more common. +This command is rarely used; typically a table's vertical lines are +specified in 'tabular''s COLS argument and overriden as needed with +'\multicolumn'. + + This example illustrates some pitfalls. In the first line's second +entry the '\hfill' moves the '\vline' to the left edge of the cell. But +that is different than putting it halfway between the two columns, so in +that row between the first and second columns there are two vertical +rules, with the one from the '{c|cc}' specifier coming before the one +produced by the '\vline\hfill'. In contrast, the first line's third +entry shows the usual way to put a vertical bar between two columns. In +the second line, the 'ghi' is the widest entry in its column so in the +'\vline\hfill' the '\hfill' has no effect and the vertical line in that +entry appears immediately next to the 'g', with no whitespace. + + \begin{tabular}{c|cc} + x &\vline\hfill y &\multicolumn{1}{|r}{z} \\ + abc &def &\vline\hfill ghi + \end{tabular} + +8.23.3 '\cline' --------------- Synopsis: \cline{I-J} - The '\cline' command draws horizontal lines across the columns -specified, beginning in column I and ending in column J, which are -specified in the mandatory argument. + Draw a horizontal rule in an 'array' or 'tabular' environment +beginning in column I and ending in column J. The dash '-' must appear +in the mandatory argument. To span a single column use the number +twice. -8.24.3 '\hline' ---------------- + This example puts two horizontal lines between the first and second +rows, one line in the first column only, and the other spanning the +third and fourth columns. The two lines are side-by-side, at the same +height. -The '\hline' command draws a horizontal line the width of the enclosing -'tabular' or 'array' environment. It's most commonly used to draw a -line at the top, bottom, and between the rows of a table. + \begin{tabular}{llrr} + a &b &c &d \\ \cline{1-1} \cline{3-4} + e &f &g &h + \end{tabular} -8.24.4 '\vline' +8.23.4 '\hline' --------------- -The '\vline' command will draw a vertical line extending the full height -and depth of its row. An '\hfill' command can be used to move the line -to the edge of the column. It can also be used in an @-expression. +Draws a horizontal line the width of the enclosing 'tabular' or 'array' +environment. It's most commonly used to draw a line at the top, bottom, +and between the rows of a table. + + In this example the top of the table has two horizontal rules, one +above the other, that span both columns. The bottom of the table has a +single rule spanning both columns. Because of the '\hline', the +'tabular' second row's line ending double backslash '\\' is required. -8.25 'thebibliography' + \begin{tabular}{ll} \hline\hline + Baseball &Red Sox \\ + Basketball &Celtics \\ \hline + \end{tabular} + +8.24 'thebibliography' ====================== Synopsis: @@ -2271,10 +3046,11 @@ wide as the widest item label produced by the '\bibitem' commands. It is typically given as '9' for bibliographies with less than 10 references, '99' for ones with less than 100, etc. -8.25.1 '\bibitem' +8.24.1 '\bibitem' ----------------- Synopsis: + \bibitem[LABEL]{CITE_KEY} The '\bibitem' command generates an entry labelled by LABEL. If the @@ -2288,12 +3064,12 @@ CITE_KEY and label. When the '.aux' file is read by the 'cite_key', causing references to CITE_KEY with a '\cite' command (see next section) to produce the associated label. -8.25.2 '\cite' +8.24.2 '\cite' -------------- Synopsis: - \cite[SUBCITE]{KEYS + \cite[SUBCITE]{KEYS} The KEYS argument is a list of one or more citation keys, separated by commas. This command generates an in-text citation to the references @@ -2302,15 +3078,15 @@ associated with KEYS by entries in the '.aux' file. The text of the optional SUBCITE argument appears after the citation. For example, '\cite[p.~314]{knuth}' might produce '[Knuth, p. 314]'. -8.25.3 '\nocite' +8.24.3 '\nocite' ---------------- -'\nocite{key_list}' +'\nocite{KEYS}' - The '\nocite' command produces no text, but writes 'key_list', which -is a list of one or more citation keys, on the '.aux' file. + The '\nocite' command produces no text, but writes KEYS, which is a +list of one or more citation keys, to the '.aux' file. -8.25.4 Using BibTeX +8.24.4 Using BibTeX ------------------- If you use the BibTeX program by Oren Patashnik (highly recommended if @@ -2347,7 +3123,7 @@ bibliography. The argument to '\bibliography' refers to files named Only the entries referred to via '\cite' and '\nocite' will be listed in the bibliography. -8.26 'theorem' +8.25 'theorem' ============== Synopsis: @@ -2360,7 +3136,7 @@ Synopsis: by THEOREM-TEXT, where the numbering possibilities for N are described under '\newtheorem' (*note \newtheorem::). -8.27 'titlepage' +8.26 'titlepage' ================ Synopsis: @@ -2377,7 +3153,7 @@ be numbered page one. Formatting the title page is left to you. The You can use the '\maketitle' command (*note \maketitle::) to produce a standard title page without a 'titlepage' environment. -8.28 'verbatim' +8.27 'verbatim' =============== Synopsis: @@ -2394,7 +3170,7 @@ typewriter. The 'verbatim' uses a monospaced typewriter-like font ('\tt'). -8.28.1 '\verb' +8.27.1 '\verb' -------------- Synopsis: @@ -2411,7 +3187,7 @@ in LITERAL-TEXT. The '*'-form differs only in that spaces are printed with a "visible space" character. -8.29 'verse' +8.28 'verse' ============ Synopsis: @@ -2438,19 +3214,40 @@ your input file into a sequence of glyphs and spaces. To produce a printed document, this sequence must be broken into lines (and these lines must be broken into pages). - LaTeX usually does the line (and page) breaking for you, but in some -environments, you do the line breaking yourself with the '\\' command, -and you can always manually force breaks. + LaTeX usually does the line (and page) breaking in the text body for +you but in some environments you manually force line breaks. -9.1 '\\'[*][MORESPACE] -====================== +9.1 '\\' +======== + +Synopsis: + + \\[MORESPACE] + + or -The '\\' command tells LaTeX to start a new line. It has an optional -argument, MORESPACE, that specifies how much extra vertical space is to -be inserted before the next line. This can be a negative amount. + \\*[MORESPACE] - The '\\*' command is the same as the ordinary '\\' command except -that it tells LaTeX not to start a new page after the line. + Start a new line. The optional argument MORESPACE specifies extra +vertical space to be insert before the next line. This can be a +negative length. The text before the break is set at its normal length, +that is, it is not stretched to fill out the line width. + + Explicit line breaks in the text body are unusual in LaTeX. In +particular, to start a new paragraph instead leave a blank line. This +command is mostly used outside of the main flow of text such as in a +'tabular' or 'array' environment. + + Under ordinary circumstances (e.g., outside of a 'p{..}' column in a +'tabular' environment) the '\newline' command is a synonym for '\\' +(*note \newline::). + + In addition to starting a new line, the starred form '\\*' tells +LaTeX not to start a new page between the two lines, by issuing a +'\nobreak'. + + \title{My story: \\[0.25in] + a tale of woe} 9.2 '\obeycr' & '\restorecr' ============================ @@ -2464,9 +3261,23 @@ in the input will also be a new line in the output. 9.3 '\newline' ============== -The '\newline' command breaks the line at the present point, with no -stretching of the text before it. It can only be used in paragraph -mode. +In ordinary text this is equivalent to double-backslash (*note \\::); it +breaks a line, with no stretching of the text before it. + + Inside a 'tabular' or 'array' environment, in a column with a +specifier producing a paragraph box, like typically 'p{..}', '\newline' +will insert a line break inside of the column, that is, it does not +break the entire row. To break the entire row use '\\' or its +equivalent '\tabularnewline'. + + This will print 'Name:' and 'Address:' as two lines in a single cell +of the table. + + \begin{tabular}{p{1in}{\hspace{2in}}p{1in}} + Name: \newline Address: &Date: \\ \hline + \end{tabular} + + The 'Date:' will be baseline-aligned with 'Name:'. 9.4 '\-' (discretionary hyphen) =============================== @@ -2541,22 +3352,24 @@ sometimes you may want to influence the breaks. 10.1 '\cleardoublepage' ======================= -The '\cleardoublepage' command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. -In a two-sided printing style, it also makes the next page a right-hand -(odd-numbered) page, producing a blank page if necessary. +The '\cleardoublepage' command ends the current page and causes all the +pending floating figures and tables that have so far appeared in the +input to be printed. In a two-sided printing style, it also makes the +next page a right-hand (odd-numbered) page, producing a blank page if +necessary. 10.2 '\clearpage' ================= -The '\clearpage' command ends the current page and causes all figures -and tables that have so far appeared in the input to be printed. +The '\clearpage' command ends the current page and causes all the +pending floating figures and tables that have so far appeared in the +input to be printed. 10.3 '\newpage' =============== The '\newpage' command ends the current page, but does not clear floats -(see '\clearpage' above). +(*note \clearpage::). 10.4 '\enlargethispage' ======================= @@ -2566,7 +3379,7 @@ The '\newpage' command ends the current page, but does not clear floats '\enlargethispage*{size}' Enlarge the '\textheight' for the current page by the specified -amount; e.g. '\enlargethispage{\baselineskip}' will allow one +amount; e.g., '\enlargethispage{\baselineskip}' will allow one additional line. The starred form tries to squeeze the material together on the page @@ -2593,9 +3406,20 @@ to 4. The higher the number, the more insistent the request is. 11 Footnotes ************ -Footnotes can be produced in one of two ways. They can be produced with -one command, the '\footnote' command. They can also be produced with -two commands, the '\footnotemark' and the '\footnotetext' commands. +Place a numbered footnote at the bottom of the current page, as here. + + Noe"l Coward quipped that having to read a footnote is like having + to go downstairs to answer the door, while in the midst of making + love.\footnote{I wouldn't know, I don't read footnotes.} + + You can place multiple footnotes on a page. If the text becomes too +long it will flow to the next page. + + You can also produce footnotes by combining the '\footnotemark' and +the '\footnotetext' commands, which is useful in special circumstances. + + To make bibliographic references come out as footnotes you need to +include a bibliographic style with that behavior. 11.1 '\footnote' ================ @@ -2604,57 +3428,187 @@ Synopsis: \footnote[NUMBER]{TEXT} - The '\footnote' command places the numbered footnote TEXT at the -bottom of the current page. The optional argument NUMBER changes the -default footnote number. - - This command can only be used in outer paragraph mode; i.e., you -cannot use it in sectioning commands like '\chapter', in figures, tables -or in a 'tabular' environment. (See following sections.) + Place a numbered footnote TEXT at the bottom of the current page. + + There are over a thousand footnotes in Gibbon's + \textit{Decline and Fall of the Roman Empire}.\footnote{After + reading an early version with endnotes David Hume complained, + ``One is also plagued with his Notes, according to the present Method + of printing the Book'' and suggested that they ``only to be printed + at the Margin or the Bottom of the Page.''} + + The optional argument NUMBER allows you to specify the footnote +number. If you use this option then the footnote number counter is not +incremented, and if you do not use it then the counter is incremented. + + Change how LaTeX shows the footnote counter with something like +'\renewcommand{\thefootnote}{\fnsymbol{footnote}}', which uses a +sequence of symbols (*note \alph \Alph \arabic \roman \Roman +\fnsymbol::). To make this change global put that in the preamble. If +you make the change local then you may want to reset the counter with +'\setcounter{footnote}{0}'. By default LaTeX uses arabic numbers. + + LaTeX's default puts many restrictions on where you can use a +'\footnote'; for instance, you cannot use it in an argument to a +sectioning command such as '\chapter' (it can only be used in outer +paragraph mode). There are some workarounds; see following sections. + + In a 'minipage' environment the '\footnote' command uses the +'mpfootnote' counter instead of the 'footnote' counter, so they are +numbered independently. They are shown at the bottom of the +environment, not at the bottom of the page. And by default they are +shown alphabetically. *Note minipage::. 11.2 '\footnotemark' ==================== -With no optional argument, the '\footnotemark' command puts the current -footnote number in the text. This command can be used in inner -paragraph mode. You give the text of the footnote separately, with the -'\footnotetext' command. +Synopsis, one of: - This command can be used to produce several consecutive footnote -markers referring to the same footnote with + \footnotemark + \footnotemark[NUMBER] - \footnotemark[\value{footnote}] + Put the current footnote number in the text. (See *note +\footnotetext:: for giving the text of the footnote separately.) The +version with the optional argument NUMBER uses that number to determine +the mark printed. This command can be used in inner paragraph mode. -after the first '\footnote' command. + This example gives the same institutional affiliation to both the +first and third authors ('\thanks' is a version of 'footnote'). + + \title{A Treatise on the Binomial Theorem} + \author{J Moriarty\thanks{University of Leeds} + \and A C Doyle\thanks{Durham University} + \and S Holmes\footnotemark[1]} + \begin{document} + \maketitle + + If you use '\footnotemark' without the optional argument then it +increments the footnote counter but if you use the optional NUMBER then +it does not. This produces several consecutive footnote markers +referring to the same footnote. + + The first theorem\footnote{Due to Gauss.} + and the second theorem\footnotemark[\value{footnote}] + and the third theorem.\footnotemark[\value{footnote}] 11.3 '\footnotetext' ==================== -Synopsis: +Synopsis, one of: + \footnotetext{TEXT} \footnotetext[NUMBER]{TEXT} - The '\footnotetext' command places TEXT at the bottom of the page as -a footnote. This command can come anywhere after the '\footnotemark' -command. The '\footnotetext' command must appear in outer paragraph -mode. + Place TEXT at the bottom of the page as a footnote. This command can +come anywhere after the '\footnotemark' command. The optional argument +NUMBER changes the displayed footnote number. The '\footnotetext' +command must appear in outer paragraph mode. - The optional argument NUMBER changes the default footnote number. +11.4 Footnotes in a table +========================= -11.4 Symbolic footnotes -======================= +Inside a 'table' environment the '\footnote' command does not work. For +instance, if the code below appears on its own then the footnote simply +disappears; there is a footnote mark in the table cell but nothing is +set at the bottom of the page. + + \begin{center} + \begin{tabular}{l|l} + \textsc{Ship} &\textsc{Book} \\ \hline + \textit{HMS Sophie} &Master and Commander \\ + \textit{HMS Polychrest} &Post Captain \\ + \textit{HMS Lively} &Post Captain \\ + \textit{HMS Surprise} &A number of books\footnote{Starting with HMS Surprise.} + \end{tabular} + \end{center} -If you want to use symbols for footnotes, rather than increasing -numbers, redefine '\thefootnote' like this: + The solution is to surround the 'tabular' environment with a +'minipage' environment, as here (*note minipage::). - \renewcommand{\thefootnote}{\fnsymbol{footnote}} + \begin{center} + \begin{minipage}{.5\textwidth} + .. tabular material .. + \end{minipage} + \end{center} + + The same technique will work inside a floating 'table' environment +(*note table::). To get the footnote at the bottom of the page use the +'tablefootnote' package, as illustrated in this example. If you put +'\usepackage{tablefootnote}' in the preamble and use the code shown then +the footnote appears at the bottom and is numbered in sequence with +other footnotes. + + \begin{table} + \centering + \begin{tabular}{l|l} + \textsc{Date} &\textsc{Campaign} \\ \hline + 1862 &Fort Donelson \\ + 1863 &Vicksburg \\ + 1865 &Army of Northern Virginia\footnote{Ending the war.} + \end{tabular} + \caption{Forces captured by US Grant} + \end{table} + +11.5 Footnotes in section headings +================================== + +Putting a footnote in a section heading + + \section{Full sets\protect\footnote{This material is due to R~Jones.}} - The '\fnsymbol' command produces a predefined series of symbols -(*note \alph \Alph \arabic \roman \Roman \fnsymbol::). If you want to -use a different symbol as your footnote mark, you'll need to also -redefine '\@fnsymbol'. + causes the footnote to appear both at the bottom of the page where +the section starts and at the bottom of the table of contents page. To +have it not appear on the table of contents use the package 'footmisc' +with the 'stable' option. + + \usepackage[stable]{footmisc} + .. + \begin{document} + .. + \section{Full sets\footnote{This material is due to R~Jones.}} + + Note that the '\protect' is gone; putting it in causes the footnote +to reappear on the table of contents. + +11.6 Footnotes of footnotes +=========================== -11.5 Footnote parameters +Particularly in the humanities, authors can have multiple classes of +footnotes, including having footnotes of footnotes. The package +'bigfoot' extends LaTeX's default footnote mechanism in many ways, +including allow these two, as in this example. + + \usepackage{bigfoot} + \DeclareNewFootnote{Default} + \DeclareNewFootnote{from}[alph] % create class \footnotefrom{} + .. + \begin{document} + .. + The third theorem is a partial converse of the + second.\footnotefrom{First noted in Wilson.\footnote{Second edition only.}} + .. + +11.7 Multiple references to footnotes +===================================== + +You can refer to a single footnote more than once. This example uses +the package 'cleverref'. + + \usepackage{cleveref}[2012/02/15] % this version of package or later + \crefformat{footnote}{#2\footnotemark[#1]#3} + .. + \begin{document} + .. + The theorem is from Evers.\footnote{\label{fn:TE}Tinker and Evers, 1994.} + The corollary is from Chance.\footnote{Evers and Chance, 1990.} + But the key lemma is from Tinker.\cref{fn:TE} + .. + + This solution will work with the package 'hyperref'. See *note +\footnotemark:: for a simpler solution in the common case of multiple +authors with the same affiliation. + +11.8 Footnote parameters ======================== '\footnoterule' @@ -2681,187 +3635,460 @@ LaTeX has support for making new commands of many different kinds. '\newcommand' and '\renewcommand' define and redefine a command, respectively. Synopses: - \newcommand[*]{CMD}[NARGS][OPTARGVAL]{DEFN} - \renewcommand[*]{CMD}[NARGS][OPTARGVAL]{DEFN} + \newcommand{CMD}[NARGS][OPTARGDEFAULT]{DEFN} + \newcommand*{CMD}[NARGS][OPTARGDEFAULT]{DEFN} + \renewcommand{CMD}[NARGS][OPTARGDEFAULT]{DEFN} + \renewcommand*{CMD}[NARGS][OPTARGDEFAULT]{DEFN} -'*' - The *-form of these commands requires that the arguments not - contain multiple paragraphs of text (not '\long', in plain TeX - terms). + The '*'-form of these two commands requires that the arguments not +contain multiple paragraphs of text (not '\long', in plain TeX terms). CMD - The command name, beginning with '\'. For '\newcommand', it must - not be already defined and must not begin with '\end'; for - '\renewcommand', it must already be defined. + Required; the command name. It must begin with '\'. For + '\newcommand', it must not be already defined and must not begin + with '\end'. For '\renewcommand', it must already be defined. NARGS - An optional integer from 1 to 9 specifying the number of arguments - that the command will take. The default is for the command to have - no arguments. - -OPTARGVAL - If this optional parameter is present, it means that the first - argument of command CMD is optional and its default value (i.e., if - it is not specified in the call) is OPTARG. In otherwise, when - calling the macro, if no '[VALUE]' is given after 'CMD'--which is - different from having '[]' for an empty VALUE--then string - 'OPTARGVAL' becomes the value of '#1' within DEFN when the macro is - expanded. + Optional; an integer from 0 to 9, specifying the number of + arguments that the command will take. If this argument is not + present, the default is for the command to have no arguments. When + redefining a command, the new version can have a different number + of arguments than the old version. + +OPTARGDEFAULT + Optional; if this argument is present then the first argument of + defined command \CMD is optional, with default value OPTARGDEFAULT + (which may be the empty string). If this argument is not present + then \CMD does not take an optional argument. + + That is, if \CMD is used with square brackets following, as in + '\CMD[MYVAL]', then within DEFN '#1' expands MYVAL. While if \CMD + is called without square brackets following, then within DEFN the + '#1' expands to the default OPTARGDEFAULT. In either case, any + required arguments will be referred to starting with '#2'. + + Omitting '[MYVAL]' in the call is different from having the square + brackets with no contents, as in '[]'. The former results in '#1' + expanding to OPTARGDEFAULT; the latter results in '#1' expanding to + the empty string. DEFN The text to be substituted for every occurrence of 'cmd'; a construct of the form '#N' in DEFN is replaced by the text of the Nth argument. -12.2 '\newcounter' -================== + A command with no arguments that is followed in the source by a space +will swallow that space. The solution is to type '{}' after the command +and before the space. + + A simple example of defining a new command: '\newcommand{\JH}{Jim +Hef{}feron}' causes the abbreviation '\JH' to be replaced by the longer +text. + + Redefining a command is basically the same: +'\renewcommand{\qedsymbol}{{\small QED}}'. + + Here's a command definition that uses arguments: + + \newcommand{\defreference}[1]{Definition~\ref{#1}} + +Then, '\defreference{def:basis}' will expand to something like +'Definition~3.14'. + + An example with two arguments: +'\newcommand{\nbym}[2]{#1\!\times\!#2}' is invoked as '\nbym{2}{k}'. + + An example with optional arguments: + + \newcommand{\salutation}[1][Sir or Madam]{Dear #1:} + +Then, '\salutation' gives 'Dear Sir or Madam:' while '\salutation[John]' +gives 'Dear John:'. And '\salutation[]' gives 'Dear :'. + + The braces around DEFN do not delimit the scope of the result of +expanding DEFN. So '\newcommand{\shipname}[1]{\it #1}' is wrong since +in the sentence + + The \shipname{Monitor} met the \shipname{Virginia}. + +the words 'met the' will incorrectly be in italics. An extra pair of +braces '\newcommand{\shipname}[1]{{\it #1}}' fixes it. + +12.2 '\providecommand' +====================== + +Defines a command, as long as no command of this name already exists. +Synopses: + + \providecommand{CMD}[NARGS][OPTARGDEFAULT]{DEFN} + \providecommand*{CMD}[NARGS][OPTARGDEFAULT]{DEFN} + + If no command of this name already exists then this has the same +effect as '\newcommand' (*note \newcommand & \renewcommand::). If a +command of this name already exists then this definition does nothing. +This is particularly useful in a style file, or other file that may be +loaded more than once. + +12.3 '\newcounter': Allocating a counter +======================================== Synopsis: \newcounter{COUNTERNAME}[SUPERCOUNTER] - The '\newcounter' command defines a new counter named COUNTERNAME. -The new counter is initialized to zero. + The '\newcounter' command globally defines a new counter named +COUNTERNAME. The name consists of letters only and does not begin with +a backslash ('\'). The name must not already be used by another +counter. The new counter is initialized to zero. - Given the optional argument '[SUPER]', COUNTERNAME will be reset -whenever the counter named SUPERCOUNTER is incremented. + If the optional argument '[SUPERCOUNTER]' appears, then COUNTERNAME +will be numbered within, or subsidiary to, the existing counter +SUPERCOUNTER. For example, ordinarily 'subsection' is numbered within +'section'. Any time SUPERCOUNTER is incremented with '\stepcounter' +(*note \stepcounter::) or '\refstepcounter' (*note \refstepcounter::) +then COUNTERNAME is reset to zero. *Note Counters::, for more information about counters. -12.3 '\newlength' -================= +12.4 '\newlength': Allocating a length +====================================== -Synopsis: +Allocate a new "length" register. Synopsis: \newlength{\ARG} - The '\newlength' command defines the mandatory argument as a "length" -command with a value of zero. The argument must be a control sequence, -as in '\newlength{\foo}'. An error occurs if '\foo' is already defined. + This command takes one required argument, which must begin with a +backslash ('\'). It creates a new length register named '\ARG', which +is a place to hold (rubber) lengths such as '1in plus.2in minus.1in' +(what plain TeX calls a 'skip' register). The register gets an initial +value of zero. The control sequence '\ARG' must not already be defined. - *Note Lengths::, for how to set the new length to a nonzero value, -and for more information about lengths in general. + *Note Lengths::, for more about lengths. -12.4 '\newsavebox' -================== +12.5 '\newsavebox': Allocating a box +==================================== -Synopsis: +Allocate a "bin" for holding a box. Synopsis: - \newsavebox{CMD} + \newsavebox{\CMD} - Defines '\CMD', which must be a command name not already defined, to -refer to a new bin for storing boxes. + Defines '\CMD' to refer to a new bin for storing boxes. Such a box +is for holding typeset material, to use multiple times (*note Boxes::) +or to measure or manipulate. The name '\CMD' must start with a +backslash ('\'), and must not be already defined. -12.5 '\newenvironment' & '\renewenvironment' -============================================ + The allocation of a box is global. This command is fragile (*note +\protect::). -Synopses: +12.6 '\newenvironment' & '\renewenvironment' +============================================ - \newenvironment[*]{ENV}[NARGS][DEFAULT]{BEGDEF}{ENDDEF} - \renewenvironment[*]{ENV}[NARGS]{BEGDEF}{ENDDEF} +These commands define or redefine an environment ENV, that is, +'\begin{ENV} ... \end{ENV}'. Synopses: - These commands define or redefine an environment ENV, that is, -'\begin{ENV} ... \end{ENV}'. + \newenvironment{ENV}[NARGS][OPTARGDEFAULT]{BEGDEFN}{ENDDEFN} + \newenvironment*{ENV}[NARGS][OPTARGDEFAULT]{BEGDEFN}{ENDDEFN} + \renewenvironment{ENV}[NARGS][OPTARGDEFAULT]{BEGDEFN}{ENDDEFN} + \renewenvironment*{ENV}[NARGS][OPTARGDEFAULT]{BEGDEFN}{ENDDEFN} -'*' - The *-form of these commands requires that the arguments (not the - contents of the environment) not contain multiple paragraphs of - text. + Unlike '\newcommand' and '\renewcommand', the '*'-forms +'\newenvironment*' and '\renewcommand*' have the same effect as the +forms with no '*'. ENV - The name of the environment. For '\newenvironment', ENV must not - be an existing environment, and the command '\ENV' must be + Required; the environment name. It does not begin with backslash + ('\'). It must not begin with the string 'end'. For + '\newenvironment', the name ENV must not be the name of an already + existing environment, and also the command '\ENV' must be undefined. For '\renewenvironment', ENV must be the name of an existing environment. NARGS - An integer from 1 to 9 denoting the number of arguments of the - newly-defined environment. The default is no arguments. - -DEFAULT - If this is specified, the first argument is optional, and DEFAULT - gives the default value for that argument. - -BEGDEF - The text expanded at every occurrence of '\begin{ENV}'; a construct - of the form '#N' in BEGDEF is replaced by the text of the Nth + Optional; an integer from 0 to 9 denoting the number of arguments + of that the environment will take. These arguments appear after + the '\begin', as in '\begin{ENV}{ARG1}...{ARGN}'. If this argument + is not present then the default is for the environment to have no + arguments. When redefining an environment, the new version can + have a different number of arguments than the old version. + +OPTARGDEFAULT + Optional; if this argument is present then the first argument of + the defined environment is optional, with default value + OPTARGDEFAULT (which may be the empty string). If this argument is + not present then the environment does not take an optional argument. -ENDDEF - The text expanded at every occurrence of '\end{ENV}'. It may not - contain any argument parameters. + That is, when '[OPTARGDEFAULT]' is present in the environment + definition, if '\begin{ENV}' is used with square brackets + following, as in '\begin{ENV}[MYVAL]', then within the environment + '#1' expands MYVAL. If '\begin{ENV}' is called without square + brackets following, then within the environment the '#1' expands to + the default OPTARGDEFAULT. In either case, any required arguments + will be referred to starting with '#2'. + + Omitting '[MYVAL]' in the call is different from having the square + brackets with no contents, as in '[]'. The former results in '#1' + expanding to OPTARGDEFAULT; the latter results in '#1' expanding to + the empty string. + +BEGDEFN + Required; the text expanded at every occurrence of '\begin{ENV}'; a + construct of the form '#N' in BEGDEF is replaced by the text of the + Nth argument. -12.6 '\newtheorem' +ENDDEFN + Required; the text expanded at every occurrence of '\end{ENV}'. + Note that it may not contain any argument parameters, so '#N' + cannot be used here. + + The environment ENV delimits the scope of the result of expanding +BEGDEFN and ENDDEFN. Thus, in the first example below, the effect of +the '\small' is limited to the quote and does not extend to material +following the environment. + + This example gives an environment like LaTeX's 'quotation' except +that it will be set in smaller type. + + \newenvironment{smallquote}{% + \small\begin{quotation} + }{% + \end{quotation} + } + + This shows the use of arguments; it gives a quotation environment +that cites the author. + + \newenvironment{citequote}[1][Shakespeare]{% + \begin{quotation} + \noindent\textit{#1}: + }{% + \end{quotation} + } + +The author's name is optional, and defaults to Shakespeare. In the +document, use the environment as here: + + \begin{citequote}[Lincoln] + .. + \end{citequote} + + The final example shows how to save the value of an argument to use +in ENDDEFN. + + \newsavebox{\quoteauthor} + \newenvironment{citequote}[1][Shakespeare]{% + \sbox\quoteauthor{#1}% + \begin{quotation} + }{% + \hspace{1em plus 1fill}---\usebox{\quoteauthor} + \end{quotation} + } + +12.7 '\newtheorem' ================== - \newtheorem{NEWENV}{LABEL}[WITHIN] - \newtheorem{NEWENV}[NUMBERED_LIKE]{LABEL} +Define a new "theorem-like environment". Synopses: + + \newtheorem{NAME}{TITLE}[NUMBERED_WITHIN] + \newtheorem{NAME}[NUMBERED_LIKE]{TITLE} - This command defines a theorem-like environment. Arguments: + Both create a theorem-like environment NAME. Using the first form, -NEWENV - The name of the environment to be defined; must not be the name of - an existing environment or otherwise defined. + \newtheorem{NAME}{TITLE}[NUMBERED_WITHIN] -LABEL +with the optional argument after the second required argument, creates +an environment whose counter is subordinate to the existing counter +NUMBERED_WITHIN: it will be reset when NUMBERED_WITHIN is reset). + + Using the second form, + + \newtheorem{NAME}[NUMBERED_LIKE]{TITLE} + +with the optional argument between the two required arguments, will +create an environment whose counter will share the previously defined +counter NUMBERED_LIKE. + + You can specify one of NUMBERED_WITHIN and NUMBERED_LIKE, or neither, +but not both. + + This command creates a counter named NAME. In addition, unless the +optional argument NUMBERED_LIKE is used, the current '\ref' value will +be that of '\theNUMBERED_WITHIN' (*note \ref::). + + This declaration is global. It is fragile (*note \protect::). + + Arguments: + +NAME + The name of the environment. It must not begin with a backslash + ('\'). It must not be the name of an existing environment; indeed, + the command name '\NAME' must not already be defined as anything. + +TITLE The text printed at the beginning of the environment, before the number. For example, 'Theorem'. +NUMBERED_WITHIN + Optional; the name of an already defined counter, usually a + sectional unit such as 'chapter' or 'section'. When the + NUMBERED_WITHIN counter is reset then the NAME environment's + counter will also be reset. + + If this optional argument is not used then the command '\theNAME' + is set to '\arabic{NAME}'. + NUMBERED_LIKE - (Optional.) The name of an already defined theorem-like - environment; the new environment will be numbered just like + Optional; the name of an already defined theorem-like environment. + The new environment will be numbered in sequence with NUMBERED_LIKE. -WITHIN - (Optional.) The name of an already defined counter, a sectional - unit. The new theorem counter will be reset at the same time as - the WITHIN counter. + Without any optional arguments the environments are numbered +sequentially. This example has a declaration in the preamble that +results in 'Definition 1' and 'Definition 2' in the output. - At most one of NUMBERED_LIKE and WITHIN can be specified, not both. + \newtheorem{defn}{Definition} + \begin{document} + \section{...} + \begin{defn} + First def + \end{defn} -12.7 '\newfont' -=============== + \section{...} + \begin{defn} + Second def + \end{defn} + + Because this example specifies the optional argument NUMBERED_WITHIN +to '\newtheorem' as 'section', the example, with the same document body, +gives 'Definition 1.1' and 'Definition 2.1'. + + \newtheorem{defn}{Definition}[section] + \begin{document} + \section{...} + \begin{defn} + First def + \end{defn} + + \section{...} + \begin{defn} + Second def + \end{defn} + + In this example there are two declarations in the preamble, the +second of which calls for the new 'thm' environment to use the same +counter as 'defn'. It gives 'Definition 1.1', followed by 'Theorem 2.1' +and 'Definition 2.2'. + + \newtheorem{defn}{Definition}[section] + \newtheorem{thm}[defn]{Theorem} + \begin{document} + \section{...} + \begin{defn} + First def + \end{defn} + + \section{...} + \begin{thm} + First thm + \end{thm} + + \begin{defn} + Second def + \end{defn} + +12.8 '\newfont': Define a new font (obsolete) +============================================= +'\newfont', now obsolete, defines a command that will switch fonts. Synopsis: - \newfont{CMD}{FONTNAME} + \newfont{\CMD}{FONT DESCRIPTION} - Defines a control sequence '\CMD', which must not already be defined, -to make FONTNAME be the current font. The file looked for on the system -is named 'FONTNAME.tfm'. + This defines a control sequence '\CMD' that will change the current +font. LaTeX will look on your system for a file named 'FONTNAME.tfm'. +The control sequence must must not already be defined. It must begin +with a backslash ('\'). - This is a low-level command for setting up to use an individual font. -More commonly, fonts are defined in families through '.fd' files. + This command is obsolete. It is a low-level command for setting up +an individual font. Today fonts are almost always defined in families +(which allows you to, for example, associate a boldface with a roman) +through the so-called "New Font Selection Scheme", either by using '.fd' +files or through the use of an engine that can access system fonts such +as XeLaTeX (*note TeX engines::). -12.8 '\protect' -=============== + But since it is part of LaTeX, here is an explanation: the FONT +DESCRIPTION consists of a FONTNAME and an optional "at clause"; this can +have the form either 'at DIMEN' or 'scaled FACTOR', where a FACTOR of +'1000' means no scaling. For LaTeX's purposes, all this does is scale +all the character and other font dimensions relative to the font's +design size, which is a value defined in the '.tfm' file. + + This example defines two equivalent fonts and typesets a few +characters in each: -Footnotes, line breaks, any command that has an optional argument, and -many more are so-called "fragile" commands. When a fragile command is -used in certain contexts, called "moving arguments", it must be preceded -by '\protect'. In addition, any fragile commands within the arguments -must have their own '\protect'. + \newfont{\testfontat}{cmb10 at 11pt} + \newfont{\testfontscaled}{cmb10 scaled 11pt} + \testfontat abc + \testfontscaled abc - Some examples of moving arguments are '\caption' (*note figure::), -'\thanks' (*note \maketitle::), and expressions in 'tabular' and 'array' +12.9 '\protect' +=============== + +All LaTeX commands are either "fragile" or "robust". Footnotes, line +breaks, any command that has an optional argument, and many more, are +fragile. A fragile command can break when it is used in the argument to +certain commands. To prevent such commands from breaking they must be +preceded by the command '\protect'. + + For example, when LaTeX runs the '\section{SECTION NAME}' command it +writes the SECTION NAME text to the '.aux' auxiliary file, moving it +there for use elsewhere in the document such as in the table of +contents. Any argument that is internally expanded by LaTeX without +typesetting it directly is referred to as a "moving argument". A +command is fragile if it can expand during this process into invalid TeX +code. Some examples of moving arguments are those that appear in the +'\caption{..}' command (*note figure::), in the '\thanks{..}' command +(*note \maketitle::), and in @-expressions in the 'tabular' and 'array' environments (*note tabular::). - Commands which are not fragile are called "robust". They must not be -preceded by '\protect'. + If you get strange errors from commands used in moving arguments, try +preceding it with '\protect'. Every fragile commands must be protected +with their own '\protect'. + + Although usually a '\protect' command doesn't hurt, length commands +are robust and should not be preceded by a '\protect' command. Nor can +a '\protect' command be used in the argument to '\addtocounter' or +'\setcounter' command. - See also: + In this example the 'caption' command gives a mysterious error about +an extra curly brace. Fix the problem by preceding each '\raisebox' +command with '\protect'. -<http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html> -<http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect> + \begin{figure} + .. + \caption{Company headquarters of A\raisebox{1pt}{B}\raisebox{-1pt}{C}} + \end{figure} + + In the next example the '\tableofcontents' command gives an error +because the '\(..\)' in the section title expands to illegal TeX in the +'.toc' file. You can solve this by changing '\(..\)' to +'\protect\(..\protect\)'. + + \begin{document} + \tableofcontents + .. + \section{Einstein's \( e=mc^2 \)} + .. 13 Counters *********** Everything LaTeX numbers for you has a counter associated with it. The -name of the counter is the same as the name of the environment or -command that produces the number, except with no '\'. ('enumi'-'enumiv' -are used for the nested enumerate environment.) Below is a list of the -counters used in LaTeX's standard document classes to control numbering. +name of the counter is often the same as the name of the environment or +command associated with the number, except with no backslash ('\'). +Thus the '\chapter' command starts a chapter and the 'chapter' counter +keeps track of the chapter number. Below is a list of the counters used +in LaTeX's standard document classes to control numbering. part paragraph figure enumi chapter subparagraph table enumii @@ -2869,11 +4096,20 @@ counters used in LaTeX's standard document classes to control numbering. subsection equation mpfootnote enumiv subsubsection + The 'mpfootnote' counter is used by the '\footnote' command inside of +a minipage (*note minipage::). + + The 'enumi' through 'enumiv' counters are used in the 'enumerate' +environment, for up to four nested levels (*note enumerate::). + + New counters are created with '\newcounter'. *Note \newcounter::. + 13.1 '\alph \Alph \arabic \roman \Roman \fnsymbol': Printing counters ===================================================================== All of these commands take a single counter as an argument, for -instance, '\alph{enumi}'. +instance, '\alph{enumi}'. Note that the counter name does not start +with a backslash. '\alph' prints COUNTER using lowercase letters: 'a', 'b', ... @@ -2899,7 +4135,7 @@ instance, '\alph{enumi}'. asterisk(*) dagger(U+2021) ddagger(U+2021) section-sign(U+00A7) paragraph-sign(U+00B6) parallel(U+2225) - double-asterisk(**) double-dagger(U+2021U+2021) double-ddagger(U+2021U+2021) + double-asterisk(**) double-dagger(U+2020U+2020) double-ddagger(U+2021U+2021) 13.2 '\usecounter{COUNTER}' =========================== @@ -2908,9 +4144,24 @@ Synopsis: \usecounter{COUNTER} - The '\usecounter' command is used in the second argument of the -'list' environment to specify COUNTER to be used to number the list -items. + In the 'list' environment, when used in the second argument, this +command sets up COUNTER to number the list items. It initializes +COUNTER to zero, and arranges that when '\item' is called without its +optional argument then COUNTER is incremented by '\refstepcounter', +making its value be the current 'ref' value. This command is fragile +(*note \protect::). + + Put in the preamble, this makes a new list environment enumerated +with TESTCOUNTER: + + \newcounter{testcounter} + \newenvironment{test}{% + \begin{list}{}{% + \usecounter{testcounter} + } + }{% + \end{list} + } 13.3 '\value{COUNTER}' ====================== @@ -2919,11 +4170,26 @@ Synopsis: \value{COUNTER} - The '\value' command produces the value of COUNTER. It can be used -anywhere LaTeX expects a number, for example: + This command expands to the value of COUNTER. It is often used in +'\setcounter' or '\addtocounter', but '\value' can be used anywhere that +LaTeX expects a number. It must not be preceded by '\protect' (*note +\protect::). + + The '\value' command is not used for typesetting the value of the +counter. *Note \alph \Alph \arabic \roman \Roman \fnsymbol::. + + This example outputs 'Test counter is 6. Other counter is 5.'. + + \newcounter{test} \setcounter{test}{5} + \newcounter{other} \setcounter{other}{\value{test}} + \addtocounter{test}{1} + + Test counter is \arabic{test}. + Other counter is \arabic{other}. - \setcounter{myctr}{3} - \addtocounter{myctr}{1} + This example inserts '\hspace{4\parindent}'. + + \setcounter{myctr}{3} \addtocounter{myctr}{1} \hspace{\value{myctr}\parindent} 13.4 '\setcounter{COUNTER}{VALUE}' @@ -2933,27 +4199,36 @@ Synopsis: \setcounter{COUNTER}{VALUE} - The '\setcounter' command sets the value of COUNTER to the VALUE -argument. + The '\setcounter' command globally sets the value of COUNTER to the +VALUE argument. Note that the counter name does not start with a +backslash. 13.5 '\addtocounter{COUNTER}{VALUE}' ==================================== -The '\addtocounter' command increments COUNTER by the amount specified -by the VALUE argument, which may be negative. +The '\addtocounter' command globally increments COUNTER by the amount +specified by the VALUE argument, which may be negative. 13.6 '\refstepcounter{COUNTER}' =============================== The '\refstepcounter' command works in the same way as '\stepcounter' -*Note \stepcounter::, except it also defines the current '\ref' value to -be the result of '\thecounter'. +(*note \stepcounter::): it globally increments the value of COUNTER by +one and resets the value of any counter numbered within it. (For the +definition of "counters numbered within", *note \newcounter::.) + + In addition, this command also defines the current '\ref' value to be +the result of '\thecounter'. + + While the counter value is set globally, the '\ref' value is set +locally, i.e., inside the current group. 13.7 '\stepcounter{COUNTER}' ============================ -The '\stepcounter' command adds one to COUNTER and resets all subsidiary -counters. +The '\stepcounter' command globally adds one to COUNTER and resets all +counters numbered within it. (For the definition of "counters numbered +within", *note \newcounter::.) 13.8 '\day \month \year': Predefined counters ============================================= @@ -2969,23 +4244,94 @@ current day (*note \today::). 14 Lengths ********** -A 'length' is a measure of distance. Many LaTeX commands take a length +A "length" is a measure of distance. Many LaTeX commands take a length as an argument. -14.1 '\setlength{\LEN}{VALUE}' + Lengths come in two types. A "rigid length" (what Plain TeX calls a +"dimen") such as '10pt' cannot contain a 'plus' or 'minus' component. A +"rubber length" (what Plain TeX calls a "skip") can contain those, as +with '1cm plus0.05cm minus0.01cm'. These give the ability to stretch or +shrink; the length in the prior sentence could appear in the output as +long as 1.05 cm or as short as 0.99 cm, depending on what TeX's +typesetting algorithm finds optimum. + + The 'plus' or 'minus' component of a rubber length can contain a +"fill" component, as in '1in plus2fill'. This gives the length infinite +stretchability or shrinkability, so that the length in the prior +sentence can be set by TeX to any distance greater than or equal to +1 inch. TeX actually provides three infinite glue components 'fil', +'fill', and 'filll', such that the later ones overcome the earlier ones, +but only the middle value is ordinarily used. *Note \hfill::, *Note +\vfill::. + + Multiplying an entire rubber length by a number turns it into a rigid +length, so that after '\setlength{\ylength}{1in plus 0.2in}' and +'\setlength{\zlength}{3\ylength}' then the value of '\zlength' is '3in'. + +14.1 Units of length +==================== + +TeX and LaTeX know about these units both inside and outside of math +mode. + +'pt' + Point 1/72.27 inch. The conversion to metric units, to two decimal + places, is 1point = 2.85mm = 28.45cm. + +'pc' + Pica, 12 pt + +'in' + Inch, 72.27 pt + +'bp' + Big point, 1/72 inch. This length is the definition of a point in + PostScript and many desktop publishing systems. + +'cm' + Centimeter + +'mm' + Millimeter + +'dd' + Didot point, 1.07 pt + +'cc' + Cicero, 12 dd + +'sp' + Scaled point, 1/65536 pt + + Two other lengths that are often used are values set by the designer +of the font. The x-height of the current font "ex", traditionally the +height of the lower case letter x, is often used for vertical lengths. +Similarly "em", traditionally the width of the capital letter M, is +often used for horizontal lengths (there is also '\enspace', which is +'0.5em'). Use of these can help make a definition work better across +font changes. For example, a definition of the vertical space between +list items given as '\setlength{\itemsep}{1ex plus 0.05ex minus 0.01ex}' +is more likely to still be reasonable if the font is changed than a +definition given in points. + + In math mode, many definitions are expressed in terms of the math +unit "mu" given by 1 em = 18 mu, where the em is taken from the current +math symbols family. *Note Spacing in math mode::. + +14.2 '\setlength{\LEN}{VALUE}' ============================== The '\setlength' sets the value of \LEN to the VALUE argument, which can be expressed in any units that LaTeX understands, i.e., inches ('in'), millimeters ('mm'), points ('pt'), big points ('bp', etc. -14.2 \addtolength{\LEN}{AMOUNT} -=============================== +14.3 '\addtolength{\LEN}{AMOUNT}' +================================= The '\addtolength' command increments a "length command" \LEN by the amount specified in the AMOUNT argument, which may be negative. -14.3 '\settodepth' +14.4 '\settodepth' ================== '\settodepth{\gnat}{text}' @@ -2993,7 +4339,7 @@ amount specified in the AMOUNT argument, which may be negative. The '\settodepth' command sets the value of a 'length' command equal to the depth of the 'text' argument. -14.4 '\settoheight' +14.5 '\settoheight' =================== '\settoheight{\gnat}{text}' @@ -3001,13 +4347,13 @@ to the depth of the 'text' argument. The '\settoheight' command sets the value of a 'length' command equal to the height of the 'text' argument. -14.5 '\settowidth{\LEN}{TEXT}' +14.6 '\settowidth{\LEN}{TEXT}' ============================== The '\settowidth' command sets the value of the command \LEN to the width of the TEXT argument. -14.6 Predefined lengths +14.7 Predefined lengths ======================= '\width' @@ -3037,9 +4383,9 @@ a sectioning command. 15.1 '\indent' ============== -'\indent' produces a horizontal space whose width equals the width of -the '\parindent' length, the normal paragraph indentation. It is used -to add paragraph indentation where it would otherwise be suppressed. +'\indent' produces a horizontal space whose width equals to the +'\parindent' length, the normal paragraph indentation. It is used to +add paragraph indentation where it would otherwise be suppressed. The default value for '\parindent' is '1em' in two-column mode, otherwise '15pt' for '10pt' documents, '17pt' for '11pt', and '1.5em' @@ -3048,9 +4394,17 @@ for '12pt'. 15.2 '\noindent' ================ -When used at the beginning of the paragraph, '\noindent' suppresses any -paragraph indentation. It has no effect when used in the middle of a -paragraph. +When used at the beginning of the paragraph, this command suppresses any +paragraph indentation, as in this example. + + .. end of the prior paragraph. + + \noindent This paragraph is not indented. + + It has no effect when used in the middle of a paragraph. + + To eliminate paragraph indentation in an entire document, put +'\setlength{\parindent}{0pt}' in the preamble. 15.3 '\parskip' =============== @@ -3072,9 +4426,12 @@ where the '\marginpar' occurs. When you only specify the mandatory argument RIGHT, the text will be placed - * in the right margin for one-sided layout; - * in the outside margin for two-sided layout; - * in the nearest margin for two-column layout. + * in the right margin for one-sided layout (option 'oneside', see + *note Document class options::); + * in the outside margin for two-sided layout (option 'twoside', see + *note Document class options::); + * in the nearest margin for two-column layout (option 'twocolumn', + see *note Document class options::). The command '\reversemarginpar' places subsequent marginal notes in the opposite (inside) margin. '\normalmarginpar' places them in the @@ -3138,653 +4495,889 @@ is used _outside_ of math mode. The '\displaystyle' declaration forces the size and style of the formula to be that of 'displaymath', e.g., with limits above and below -summations. For example +summations. For example: + $\displaystyle \sum_{n=0}^\infty x_n $ 16.1 Subscripts & superscripts ============================== -To get an expression exp to appear as a subscript, you just type -'_{'exp'}'. To get exp to appear as a superscript, you type '^{'exp'}'. -LaTeX handles superscripted superscripts and all of that stuff in the -natural way. It even does the right thing when something has both a -subscript and a superscript. +In math mode, use the caret character '^' to make the EXP appear as a +superscript, ie. type '^{EXP}'. Similarly, in math mode, +underscore '_{EXP}' makes a subscript out of EXP. + + In this example the '0' and '1' appear as subscripts while the '2' is +a superscript. + + \( (x_0+x_1)^2 \) + + To have more than one character in EXP use curly braces as in +'e^{-2x}'. + + LaTeX handles superscripts on superscripts, and all of that stuff, in +the natural way, so expressions such as 'e^{x^2}' and 'x_{a_0}' will +look right. It also does the right thing when something has both a +subscript and a superscript. In this example the '0' appears at the +bottom of the integral sign while the '10' appears at the top. + + \int_0^{10} x^2 \,dx + + You can put a superscript or subscript before a symbol with a +construct such as '{}_t K^2' in math mode (the initial '{}' prevents the +prefixed subscript from being attached to any prior symbols in the +expression). + + Outside of math mode, a construct like 'A +test$_\textnormal{subscript}$' will produce a subscript typeset in text +mode, not math mode. Note that there are packages specialized for +writing Chemical formulas such as 'mhchem'. 16.2 Math symbols ================= LaTeX provides almost any mathematical symbol you're likely to need. -The commands for generating them can be used only in math mode. For -example, if you include '$\pi$' in your source, you will get the pi -symbol (\pi) in your output. +For example, if you include '$\pi$' in your source, you will get the pi +symbol U+03C0. + + Below is a list of commonly-available symbols. It is by no means an +exhaustive list. Each symbol here is described with a short phrase, and +its symbol class (which determines the spacing around it) is given in +parenthesis. The commands for these symbols can be used only in math +mode. '\|' - \| + U+2225 Parallel (relation). Synonym: '\parallel'. '\aleph' - \aleph + U+2135 Aleph, transfinite cardinal (ordinary). '\alpha' - \alpha + U+03B1 Lower case Greek letter alpha (ordinary). '\amalg' - \amalg (binary operation) + U+2A3F Disjoint union (binary) '\angle' - \angle + U+2220 Geometric angle (ordinary). Similar: less-than sign '<' and + angle bracket '\langle'. '\approx' - \approx (relation) + U+2248 Almost equal to (relation). '\ast' - \ast (binary operation) + U+2217 Asterisk operator, convolution, six-pointed (binary). + Synonym: '*', which is often a superscript or subscript, as in the + Kleene star. Similar: '\star', which is five-pointed, and is + sometimes used as a general binary operation, and sometimes + reserved for cross-correlation. '\asymp' - \asymp (relation) + U+224D Asymptomatically equivalent (relation). '\backslash' - \ (delimiter) + \ Backslash (ordinary). Similar: set minus '\setminus', and + '\textbackslash' for backslash outside of math mode. '\beta' - \beta + U+03B2 Lower case Greek letter beta (ordinary). '\bigcap' - \bigcap + U+22C2 Variable-sized, or n-ary, intersection (operator). Similar: + binary intersection '\cap'. '\bigcirc' - \bigcirc (binary operation) + U+26AA Circle, larger (binary). Similar: function + composition '\circ'. '\bigcup' - \bigcup + U+22C3 Variable-sized, or n-ary, union (operator). Similar: binary + union '\cup'. '\bigodot' - \bigodot + U+2A00 Variable-sized, or n-ary, circled dot operator (operator). '\bigoplus' - \bigoplus + U+2A01 Variable-sized, or n-ary, circled plus operator (operator). '\bigotimes' - \bigotimes + U+2A02 Variable-sized, or n-ary, circled times operator (operator). '\bigtriangledown' - \bigtriangledown (binary operation) + U+25BD Variable-sized, or n-ary, open triangle pointing down + (operator). '\bigtriangleup' - \bigtriangleup (binary operation) + U+25B3 Variable-sized, or n-ary, open triangle pointing up + (operator). '\bigsqcup' - \bigsqcup + U+2A06 Variable-sized, or n-ary, square union (operator). '\biguplus' - \biguplus + U+2A04 Variable-sized, or n-ary, union operator with a plus + (operator). (Note that the name has only one p.) -'\bigcap' - \bigvee +'\bigvee' + U+22C1 Variable-sized, or n-ary, logical-and (operator). '\bigwedge' - \bigwedge + U+22C0 Variable-sized, or n-ary, logical-or (operator). '\bot' - \bot + U+22A5 Up tack, bottom, least element of a poset, or a + contradiction (ordinary). See also '\top'. '\bowtie' - \bowtie (relation) + U+22C8 Natural join of two relations (relation). '\Box' - (square open box symbol) + U+25A1 Modal operator for necessity; square open box (ordinary). + This is not available in Plain TeX. In LaTeX you need to load the + 'amssymb' package. '\bullet' - \bullet (binary operation) + U+2022 Bullet (binary). Similar: multiplication dot '\cdot'. '\cap' - \cap (binary operation) + U+2229 Intersection of two sets (binary). Similar: variable-sized + operator '\bigcap'. '\cdot' - \cdot (binary operation) + U+22C5 Multiplication (binary). Similar: Bullet dot '\bullet'. '\chi' - \chi + U+03C7 Lower case Greek chi (ordinary). '\circ' - \circ (binary operation) + U+2218 Function composition, ring operator (binary). Similar: + variable-sized operator '\bigcirc'. '\clubsuit' - \clubsuit + U+2663 Club card suit (ordinary). + +'\complement' + U+2201 Set complement, used as a superscript as in + '$S^\complement$' (ordinary). This is not available in Plain TeX. + In LaTeX you should load the 'amssymb' package. Also used: + '$S^{\mathsf{c}}$' or '$\bar{S}$'. '\cong' - \cong (relation) + U+2245 Congruent (relation). '\coprod' - \coprod + U+2210 Coproduct (operator). '\cup' - \cup (binary operation) + U+222A Union of two sets (binary). Similar: variable-sized + operator '\bigcup'. '\dagger' - \dagger (binary operation) + U+2020 Dagger relation (binary). '\dashv' - \dashv (relation) + U+22A3 Dash with vertical, reversed turnstile (relation). Similar: + turnstile '\vdash'. '\ddagger' - \dagger (binary operation) + U+2021 Double dagger relation (binary). '\Delta' - \Delta + U+0394 Greek upper case delta, used for increment (ordinary). '\delta' - \delta + U+03B4 Greek lower case delta (ordinary). '\Diamond' - bigger \diamond + U+25C7 Large diamond operator (ordinary). This is not available in + Plain TeX. In LaTeX you must load the 'amssymb' package. '\diamond' - \diamond (binary operation) + U+22C4 Diamond operator, or diamond bullet (binary). Similar: + large diamond '\Diamond', circle bullet '\bullet'. '\diamondsuit' - \diamondsuit + U+2662 Diamond card suit (ordinary). '\div' - \div (binary operation) + U+00F7 Division sign (binary). '\doteq' - \doteq (relation) + U+2250 Approaches the limit (relation). Similar: geometrically + equal to '\Doteq'. '\downarrow' - \downarrow (delimiter) + U+2193 Down arrow, converges (relation). Similar: double line down + arrow '\Downarrow'. '\Downarrow' - \Downarrow (delimiter) + U+21D3 Double line down arrow (relation). Similar: single line + down arrow '\downarrow'. '\ell' - \ell + U+2113 Lower-case cursive letter l (ordinary). '\emptyset' - \emptyset + U+2205 Empty set symbol (ordinary). Similar: reversed empty + set '\varnothing'. '\epsilon' - \epsilon + U+03F5 Lower case Greek-text letter (ordinary). More widely used + in mathematics is the curly epsilon '\varepsilon' U+03B5. Related: + the set membership relation '\in' U+2208. '\equiv' - \equiv (relation) + U+2261 Equivalence (relation). '\eta' - \eta + U+03B7 Lower case Greek letter (ordinary). '\exists' - \exists + U+2203 Existential quantifier (ordinary). '\flat' - \flat + U+266D Musical flat (ordinary). '\forall' - \forall + U+2200 Universal quantifier (ordinary). '\frown' - \frown (relation) + U+2322 Downward curving arc (ordinary). '\Gamma' - \Gamma + U+0393 Upper case Greek letter (ordinary). '\gamma' - \gamma + U+03B3 Lower case Greek letter (ordinary). '\ge' - \ge + U+2265 Greater than or equal to (relation). This is a synonym + for '\geq'. '\geq' - \geq (relation) + U+2265 Greater than or equal to (relation). This is a synonym + for '\ge'. '\gets' - \gets + U+2190 Is assigned the value (relation). Synonym: '\leftarrow'. '\gg' - \gg (relation) + U+226B Much greater than (relation). Similar: much less + than '\ll'. '\hbar' - \hbar + U+210F Planck constant over two pi (ordinary). '\heartsuit' - \heartsuit + U+2661 Heart card suit (ordinary). '\hookleftarrow' - \hookleftarrow + U+21A9 Hooked left arrow (relation). '\hookrightarrow' - \hookrightarrow + U+21AA Hooked right arrow (relation). '\iff' - \iff + U+27F7 If and only if (relation). It is '\Longleftrightarrow' with + a '\thickmuskip' on either side. '\Im' - \Im + U+2111 Imaginary part (ordinary). See: real part '\Re'. '\in' - \in (relation) + U+2208 Set element (relation). See also: lower case Greek letter + epsilon '\epsilon'U+03F5 and rounded small epsilon '\varepsilon'. '\infty' - \infty + U+221E Infinity (ordinary). '\int' - \int + U+222B Integral (operator). '\iota' - \iota + U+03B9 Lower case Greek letter (ordinary). '\Join' - condensed bowtie symbol (relation) + U+2A1D Condensed bowtie symbol (relation). Not available in Plain + TeX. '\kappa' - \kappa + U+03BA Lower case Greek letter (ordinary). '\Lambda' - \Lambda + U+039B Upper case Greek letter (ordinary). '\lambda' - \lambda + U+03BB Lower case Greek letter (ordinary). '\land' - \land + U+2227 Logical and (binary). This is a synonym for '\wedge'. See + also logical or '\lor'. '\langle' - \langle (delimiter) + U+27E8 Left angle, or sequence, bracket (opening). Similar: + less-than '<'. Matches '\rangle'. '\lbrace' - \lbrace (delimiter) + U+007B Left curly brace (opening). Synonym: '\{'. + Matches '\rbrace'. '\lbrack' - \lbrack (delimiter) + U+005B Left square bracket (opening). Synonym: '['. + Matches '\rbrack'. '\lceil' - \lceil (delimiter) + U+2308 Left ceiling bracket, like a square bracket but with the + bottom shaved off (opening). Matches '\rceil'. '\le' - \le + U+2264 Less than or equal to (relation). This is a synonym + for '\leq'. '\leadsto' + U+21DD Squiggly right arrow (relation). This is not available in + Plain TeX. In LaTeX you should load the 'amssymb' package. To get + this symbol outside of math mode you can put + '\newcommand*{\Leadsto}{\ensuremath{\leadsto}}' in the preamble and + then use '\Leadsto' instead. '\Leftarrow' - \Leftarrow + U+21D0 Is implied by, double-line left arrow (relation). Similar: + single-line left arrow '\leftarrow'. '\leftarrow' - \leftarrow + U+2190 Single-line left arrow (relation). Synonym: '\gets'. + Similar: double-line left arrow '\Leftarrow'. '\leftharpoondown' - \leftharpoondown + U+21BD Single-line left harpoon, barb under bar (relation). '\leftharpoonup' - \leftharpoonup + U+21BC Single-line left harpoon, barb over bar (relation). '\Leftrightarrow' - \Leftrightarrow + U+21D4 Bi-implication; double-line double-headed arrow (relation). + Similar: single-line double headed arrow '\leftrightarrow'. '\leftrightarrow' - \leftrightarrow + U+2194 Single-line double-headed arrow (relation). Similar: + double-line double headed arrow '\Leftrightarrow'. '\leq' - \leq (relation) + U+2264 Less than or equal to (relation). This is a synonym + for '\le'. '\lfloor' - \lfloor (delimiter) + U+230A Left floor bracket (opening). '\lhd' - (left-pointing arrow head) + U+25C1 Arrowhead, that is, triangle, pointing left (binary). This + is not available in Plain TeX. In LaTeX you should load the + 'amssymb' package. For the normal subgroup symbol you should load + 'amssymb' and use '\vartriangleleft' (which is a relation and so + gives better spacing). '\ll' - \ll (relation) + U+226A Much less than (relation). Similar: much greater + than '\gg'. '\lnot' - \lnot + U+00AC Logical negation (ordinary). Synonym: '\neg'. '\longleftarrow' - \longleftarrow + U+27F5 Long single-line left arrow (relation). Similar: long + double-line left arrow '\Longleftarrow'. '\longleftrightarrow' - \longleftrightarrow + U+27F7 Long single-line double-headed arrow (relation). Similar: + long double-line double-headed arrow '\Longleftrightarrow'. '\longmapsto' - \longmapsto + U+27FC Long single-line left arrow starting with vertical bar + (relation). Similar: shorter version '\mapsto'. '\longrightarrow' - \longrightarrow + U+27F6 Long single-line right arrow (relation). Similar: long + double-line right arrow '\Longrightarrow'. '\lor' - \lor + U+2228 Logical or (binary). Synonym: wedge '\wedge'. '\mapsto' - \mapsto + U+21A6 Single-line left arrow starting with vertical bar + (relation). Similar: longer version '\longmapsto'. '\mho' + U+2127 Conductance, half-circle rotated capital omega (ordinary). + This is not available in Plain TeX. In LaTeX you should load the + 'amssymb' package. '\mid' - \mid (relation) + U+2223 Single-line vertical bar (relation). A typical use of + '\mid' is for a set '\{\, x \mid x\geq 5 \,\}'. + + Similar: '\vert' and '|' produce the same single-line vertical bar + symbol but without any spacing (they fall in class ordinary) and + you should not use them as relations but instead only as ordinals, + i.e., footnote symbols. For absolute value, see the entry + for '\vert' and for norm see the entry for '\Vert'. '\models' - \models (relation) + U+22A8 Entails, or satisfies; double turnstile, short double dash + (relation). Similar: long double dash '\vDash'. '\mp' - \mp (binary operation) + U+2213 Minus or plus (relation). '\mu' - \mu + U+03BC Lower case Greek letter (ordinary). '\nabla' - \nabla + U+2207 Hamilton's del, or differential, operator (ordinary). '\natural' - \natural + U+266E Musical natural notation (ordinary). '\ne' - \ne + U+2260 Not equal (relation). Synonym: '\neq'. '\nearrow' - \nearrow + U+2197 North-east arrow (relation). '\neg' - \neg + U+00AC Logical negation (ordinary). Synonym: '\lnot'. Sometimes + instead used for negation: '\sim'. '\neq' - \neq (relation) + U+2260 Not equal (relation). Synonym: '\ne'. '\ni' - \ni (relation) + U+220B Reflected membership epsilon; has the member (relation). + Synonym: '\owns'. Similar: is a member of '\in'. '\not' - Overstrike a following operator with a /, as in \not=. + U+0020U+00A0U+0338 Long solidus, or slash, used to overstrike a + following operator (relation). + + Many negated operators that don't require '\not' are available, + particularly with the 'amssymb' package. For example, '\notin' is + probably typographically preferable to '\not\in'. '\notin' - \ni + U+2209 Not an element of (relation). Similar: not subset + of '\nsubseteq'. '\nu' - \nu + U+03BD Lower case Greek letter (ordinary). '\nwarrow' - \nwarrow + U+2196 North-west arrow (relation). '\odot' - \odot (binary operation) + U+2299 Dot inside a circle (binary). Similar: variable-sized + operator '\bigodot'. '\oint' - \oint + U+222E Contour integral, integral with circle in the middle + (operator). '\Omega' - \Omega + U+03A9 Upper case Greek letter (ordinary). '\omega' - \omega + U+03C9 Lower case Greek letter (ordinary). '\ominus' - \ominus (binary operation) + U+2296 Minus sign, or dash, inside a circle (binary). '\oplus' - \oplus (binary operation) + U+2295 Plus sign inside a circle (binary). Similar: variable-sized + operator '\bigoplus'. '\oslash' - \oslash (binary operation) + U+2298 Solidus, or slash, inside a circle (binary). '\otimes' - \otimes (binary operation) + U+2297 Times sign, or cross, inside a circle (binary). Similar: + variable-sized operator '\bigotimes'. '\owns' - \owns + U+220B Reflected membership epsilon; has the member (relation). + Synonym: '\ni'. Similar: is a member of '\in'. '\parallel' - \parallel (relation) + U+2225 Parallel (relation). Synonym: '\|'. '\partial' - \partial + U+2202 Partial differential (ordinary). '\perp' - \perp (relation) + U+27C2 Perpendicular (relation). Similar: '\bot' uses the same + glyph but the spacing is different because it is in the class + ordinary. '\phi' - \phi + U+03D5 Lower case Greek letter (ordinary). The variant form is + '\varphi' U+03C6. '\Pi' - \Pi + U+03A0 Upper case Greek letter (ordinary). '\pi' - \pi + U+03C0 Lower case Greek letter (ordinary). The variant form is + '\varpi' U+03D6. '\pm' - \pm (binary operation) + U+00B1 Plus or minus (binary). '\prec' - \prec (relation) + U+227A Preceeds (relation). Similar: less than '<'. '\preceq' - \preceq (relation) + U+2AAF Preceeds or equals (relation). Similar: less than or + equals '\leq'. '\prime' - \prime + U+2032 Prime, or minute in a time expression (ordinary). Typically + used as a superscript '$A^\prime$'. Note that '$f^\prime$' and + '$f'$' produce the same result. An advantage of the second is that + '$f'''$' produces the the desired symbol, that is, the same result + as '$f^{\prime\prime\prime}$', but uses somewhat less typing. Note + that you can only use '\prime' in math mode but you can type right + single quote ''' in text mode also, although it resuts in a + different look than in math mode. '\prod' - \prod + U+220F Product (operator). '\propto' - \propto (relation) + U+221D Is proportional to (relation) '\Psi' - \Psi + U+03A8 Upper case Greek letter (ordinary). '\psi' - \psi + U+03C8 Lower case Greek letter (ordinary). '\rangle' - \rangle (delimiter) + U+27B9 Right angle, or sequence, bracket (closing). Similar: + greater than '>'. Matches:'\langle'. '\rbrace' - \rbrace (delimiter) + U+007D Right curly brace (closing). Synonym: '\}'. + Matches '\lbrace'. '\rbrack' - \rbrack (delimiter) + U+005D Right square bracket (closing). Synonym: ']'. + Matches '\lbrack'. '\rceil' - \rceil (delimiter) + U+2309 Right ceiling bracket (closing). Matches '\lceil'. '\Re' - \Re + U+211C Real part, real numbers, cursive capital R (ordinary). + Related: double-line, or blackboard bold, R '\mathbb{R}'; to access + this, load the 'amsfonts' package. + +'\restriction' + U+21BE Restriction of a function (relation). + Synonym: '\upharpoonright'. Not available in Plain TeX. In LaTeX + you should load the 'amssymb' package. '\rfloor' - \rfloor + U+230B Right floor bracket, a right square bracket with the top cut + off (closing). Matches '\lfloor'. '\rhd' - (binary operation) + U+25C1 Arrowhead, that is, triangle, pointing right (binary). This + is not available in Plain TeX. In LaTeX you should load the + 'amssymb' package. For the normal subgroup symbol you should + instead load 'amssymb' and use '\vartriangleright' (which is a + relation and so gives better spacing). '\rho' - \rho + U+03C1 Lower case Greek letter (ordinary). The variant form is + '\varrho' U+03F1. '\Rightarrow' - \Rightarrow + U+21D2 Implies, right-pointing double line arrow (relation). + Similar: right single-line arrow '\rightarrow'. '\rightarrow' - \rightarrow + U+2192 Right-pointing single line arrow (relation). + Synonym: '\to'. Similar: right double line arrow '\Rightarrow'. '\rightharpoondown' - \rightharpoondown + U+21C1 Right-pointing harpoon with barb below the line (relation). '\rightharpoonup' - \rightharpoonup + U+21C0 Right-pointing harpoon with barb above the line (relation). '\rightleftharpoons' - \rightleftharpoons + U+21CC Right harpoon up above left harpoon down (relation). '\searrow' - \searrow + U+2198 Arrow pointing southeast (relation). '\setminus' - \setminus (binary operation) + U+29F5 Set difference, reverse solidus or slash, like \ (binary). + Similar: backslash '\backslash' and also '\textbackslash' outside + of math mode. '\sharp' - \sharp + U+266F Musical sharp (ordinary). '\Sigma' - \Sigma + U+03A3 Upper case Greek letter (ordinary). '\sigma' - \sigma + U+03C3 Lower case Greek letter (ordinary). The variant form is + '\varsigma' U+03C2. '\sim' - \sim (relation) + U+223C Similar, in a relation (relation). '\simeq' - \simeq (relation) + U+2243 Similar or equal to, in a relation (relation). '\smallint' - \smallint + U+222B Integral sign that does not change to a larger size in a + display (operator). '\smile' - \smile (relation) + U+2323 Upward curving arc (ordinary). '\spadesuit' - \spadesuit + U+2660 Spade card suit (ordinary). '\sqcap' - \sqcap (binary operation) + U+2293 Square intersection symbol (binary). Similar: + intersection 'cap'. '\sqcup' - \sqcup (binary operation) + U+2294 Square union symbol (binary). Similar: union 'cup'. + Related: variable-sized operator '\bigsqcup'. '\sqsubset' - (relation) + U+228F Square subset symbol (relation). Similar: subset '\subset'. + This is not available in Plain TeX. In LaTeX you should load the + 'amssymb' package. '\sqsubseteq' - \sqsubseteq (relation) + U+2291 Square subset or equal symbol (binary). Similar: subset or + equal to '\subseteq'. '\sqsupset' - (relation) + U+2290 Square superset symbol (relation). Similar: + superset '\supset'. This is not available in Plain TeX. In LaTeX + you should load the 'amssymb' package. '\sqsupseteq' - \sqsupseteq (relation) + U+2292 Square superset or equal symbol (binary). Similar: superset + or equal '\supseteq'. '\star' - \star (binary operation) + U+22C6 Five-pointed star, sometimes used as a general binary + operation but sometimes reserved for cross-correlation (binary). + Similar: the synonyms asterisk '*' and '\ast', which are + six-pointed, and more often appear as a superscript or subscript, + as with the Kleene star. '\subset' - \subset (relation) + U+2282 Subset (occasionally, is implied by) (relation). '\subseteq' - \subseteq (relation) + U+2286 Subset or equal to (relation). '\succ' - \succ (relation) + U+227B Comes after, succeeds (relation). Similar: is less + than '>'. '\succeq' - \succeq (relation) + U+2AB0 Succeeds or is equal to (relation). Similar: less than or + equal to '\leq'. '\sum' - \sum + U+2211 Summation (operator). Similar: Greek capital + sigma '\Sigma'. '\supset' - \supset (relation) + U+2283 Superset (relation). '\supseteq' - \supseteq (relation) + U+2287 Superset or equal to (relation). '\surd' - \surd + U+221A Radical symbol (ordinary). The LaTeX command '\sqrt{..}' + typesets the square root of the argument, with a bar that extends + to cover the argument. '\swarrow' - \swarrow + U+2199 Southwest-pointing arrow (relation). '\tau' - \tau + U+03C4 Lower case Greek letter (ordinary). '\theta' - \theta + U+03B8 Lower case Greek letter (ordinary). The variant form is + '\vartheta' U+03D1. '\times' - \times (binary operation) + U+00D7 Primary school multiplication sign (binary). See + also '\cdot'. '\to' - \to + U+2192 Right-pointing single line arrow (relation). + Synonym: '\rightarrow'. '\top' - \top + U+22A4 Top, greatest element of a poset (ordinary). See + also '\bot'. '\triangle' - \triangle + U+25B3 Triangle (ordinary). '\triangleleft' - \triangleleft (binary operation) + U+25C1 Not-filled triangle pointing left (binary). + Similar: '\lhd'. For the normal subgroup symbol you should load + 'amssymb' and use '\vartriangleleft' (which is a relation and so + gives better spacing). '\triangleright' - \triangleright (binary operation) + U+25B7 Not-filled triangle pointing right (binary). For the normal + subgroup symbol you should instead load 'amssymb' and + use '\vartriangleright' (which is a relation and so gives better + spacing). '\unlhd' - left-pointing arrowhead with line under (binary operation) + U+22B4 Left-pointing not-filled arrowhead, that is, triangle, with + a line under (binary). This is not available in Plain TeX. In + LaTeX you should load the 'amssymb' package. For the normal + subgroup symbol load 'amssymb' and use '\vartrianglelefteq' (which + is a relation and so gives better spacing). '\unrhd' - right-pointing arrowhead with line under (binary operation) + U+22B5 Right-pointing not-filled arrowhead, that is, triangle, with + a line under (binary). This is not available in Plain TeX. In + LaTeX you should load the 'amssymb' package. For the normal + subgroup symbol load 'amssymb' and use '\vartrianglerighteq' (which + is a relation and so gives better spacing). '\Uparrow' - \Uparrow (delimiter) + U+21D1 Double-line upward-pointing arrow (relation). Similar: + single-line up-pointing arrow '\uparrow'. '\uparrow' - \uparrow (delimiter) + U+2191 Single-line upward-pointing arrow, diverges (relation). + Similar: double-line up-pointing arrow '\Uparrow'. '\Updownarrow' - \Updownarrow (delimiter) + U+21D5 Double-line upward-and-downward-pointing arrow (relation). + Similar: single-line upward-and-downward-pointing + arrow '\updownarrow'. '\updownarrow' - \updownarrow (delimiter) + U+2195 Single-line upward-and-downward-pointing arrow (relation). + Similar: double-line upward-and-downward-pointing + arrow '\Updownarrow'. + +'\upharpoonright' + U+21BE Up harpoon, with barb on right side (relation). + Synonym: '\restriction'. Not available in Plain TeX. In LaTeX you + should load the 'amssymb' package. '\uplus' - \uplus (binary operation) + U+228E Multiset union, a union symbol with a plus symbol in the + middle (binary). Similar: union '\cup'. Related: variable-sized + operator '\biguplus'. '\Upsilon' - \Upsilon + U+03A5 Upper case Greek letter (ordinary). '\upsilon' - \upsilon + U+03C5 Lower case Greek letter (ordinary). '\varepsilon' - \varepsilon + U+03B5 Rounded small epsilon (ordinary). This is more widely used + in mathematics than the non-variant lower case Greek-text letter + form '\epsilon' U+03F5. Related: set membership '\in'. '\varphi' - \varphi + U+03C6 Variant on the lower case Greek letter (ordinary). The + non-variant form is '\phi' U+03D5. '\varpi' - \varpi + U+03D6 Variant on the lower case Greek letter (ordinary). The + non-variant form is '\pi' U+03C0. '\varrho' - \varrho + U+03F1 Variant on the lower case Greek letter (ordinary). The + non-variant form is '\rho' U+03C1. '\varsigma' - \varsigma + U+03C2 Variant on the lower case Greek letter (ordinary). The + non-variant form is '\sigma' U+03C3. '\vartheta' - \vartheta + U+03D1 Variant on the lower case Greek letter (ordinary). The + non-variant form is '\theta' U+03B8. '\vdash' - \vdash (relation) + U+22A2 Provable; turnstile, vertical and a dash (relation). + Similar: turnstile rotated a half-circle '\dashv'. '\vee' - \vee (binary operation) + U+2228 Logical or; a downwards v shape (binary). Related: logical + and '\wedge'. Similar: variable-sized operator '\bigvee'. '\Vert' - \Vert (delimiter) + U+2016 Vertical double bar (ordinary). Similar: vertical single + bar '\vert'. + + For a norm you can use the 'mathtools' package and add + '\DeclarePairedDelimiter\norm{\lVert}{\rVert}' to your preamble. + This gives you three command variants for double-line vertical bars + that are correctly horizontally spaced: if in the document body you + write the starred version '$\norm*{M^\perp}$' then the height of + the vertical bars will match the height of the argument, whereas + with '\norm{M^\perp}' the bars do not grow with the height of the + argument but instead are the default height, and '\norm[SIZE + COMMAND]{M^\perp}' also gives bars that do not grow but are set to + the size given in the SIZE COMMAND, e.g., '\Bigg'. '\vert' - \vert (delimiter) + U+007C Single line vertical bar (ordinary). Similar: double-line + vertical bar '\Vert'. For such that, as in the definition of a + set, use '\mid' because it is a relation. + + For absolute value you can use the 'mathtools' package and add + '\DeclarePairedDelimiter\abs{\lvert}{\rvert}' to your preamble. + This gives you three command variants for single-line vertical bars + that are correctly horizontally spaced: if in the document body you + write the starred version '$\abs*{\frac{22}{7}}$' then the height + of the vertical bars will match the height of the argument, whereas + with '\abs{\frac{22}{7}}' the bars do not grow with the height of + the argument but instead are the default height, and '\abs[SIZE + COMMAND]{\frac{22}{7}}' also gives bars that do not grow but are + set to the size given in the SIZE COMMAND, e.g., '\Bigg'. '\wedge' - \wedge (binary operation) + U+2227 Logical and (binary). Synonym: '\land'. See also logical + or '\vee'. Similar: variable-sized operator '\bigwedge'. '\wp' - \wp + U+2118 Weierstrass p (ordinary). '\wr' - \wr (binary operation) + U+2240 Wreath product (binary). '\Xi' - \Xi + U+039E Upper case Greek letter (ordinary). '\xi' - \xi + U+03BE Lower case Greek letter (ordinary). '\zeta' - \zeta + U+03B6 Lower case Greek letter (ordinary). 16.3 Math functions =================== @@ -3814,10 +5407,10 @@ spacing. \cosh '\cot' - \cos + \cot '\coth' - \cosh + \coth '\csc' \csc @@ -3826,7 +5419,7 @@ spacing. \deg '\det' - \deg + \det '\dim' \dim @@ -3943,26 +5536,51 @@ Accents::). '\widehat' Math wide hat accent: \widehat{x+y}. -'\widehat' +'\widetilde' Math wide tilde accent: \widetilde{x+y}. 16.5 Spacing in math mode ========================= -In a 'math' environment, LaTeX ignores the spaces you type and puts in -the spacing according to the normal rules for mathematics texts. If you -want different spacing, LaTeX provides the following commands for use in -math mode: +In a 'math' environment, LaTeX ignores the spaces that you use in the +source, and instead puts in the spacing according to the normal rules +for mathematics texts. + + Many math mode spacing definitions are expressed in terms of the math +unit "mu" given by 1 em = 18 mu, where the em is taken from the current +math symbols family (*note Units of length::). LaTeX provides the +following commands for use in math mode: '\;' - A thick space (5\over18\,quad). + Normally '5.0mu plus 5.0mu'. The longer name is '\thickspace'. + Math mode only. + '\:' '\>' - Both of these produce a medium space (2\over9\,quad). + Normally '4.0mu plus 2.0mu minus 4.0mu'. The longer name is + '\medspace'. Math mode only. + '\,' - A thin space (1\over6\,quad); not restricted to math mode. + Normally '3mu'. The longer name is '\thinspace'. This can be used + in both math mode and text mode. + '\!' - A negative thin space (-{1\over6}\,quad). + A negative thin space. Normally '-3mu'. Math mode only. + +'\quad' + This is 18mu, that is, 1em. This is often used for space + surrounding equations or expressions, for instance for the space + between two equations inside a 'displaymath' environment. It is + available in both text and math mode. + +'\qquad' + A length of 2 quads, that is, 36mu = 2em. It is available in both + text and math mode. + + In this example a thinspace separates the function from the +infinitesimal. + + \int_0^1 f(x)\,dx 16.6 Math miscellany ==================== @@ -4158,69 +5776,135 @@ STYLE for the current page only. LaTeX has many ways to produce white (or filled) space. - Another space-producing command is '\,' to produce a "thin" space -(usually 1/6quad). It can be used in text mode, but is more often -useful in math mode (*note Spacing in math mode::). - 19.1 '\hspace' ============== Synopsis: - \hspace[*]{LENGTH} + \hspace{LENGTH} + \hspace*{LENGTH} + + Add the horizontal space given by LENGTH. The LENGTH is a rubber +length, that is, it may contain a 'plus' or 'minus' component, in any +unit that LaTeX understands (*note Lengths::). + + This command can add both positive and negative space; adding +negative space is like backspacing. + + Normally when TeX breaks a paragraph into lines it discards white +space (glues and kerns) that would come at the start of a line, so you +get an inter-word space or a line break between words but not both. +This command's starred version '\hspace*{..}' puts a non-discardable +invisible item in front of the space, so the space appears in the +output. - The '\hspace' command adds horizontal space. The LENGTH argument can -be expressed in any terms that LaTeX understands: points, inches, etc. -It is a rubber length. You can add both negative and positive space -with an '\hspace' command; adding negative space is like backspacing. + This example make a one-line paragraph that puts 'Name:' an inch from +the right margin. - LaTeX normally removes horizontal space that comes at the beginning -or end of a line. To preserve this space, use the optional '*' form. + \noindent\makebox[\linewidth]{\hspace{\fill}Name:\hspace{1in}} 19.2 '\hfill' ============= -The '\hfill' fill command produces a "rubber length" which has no -natural space but can stretch or shrink horizontally as far as needed. +Produce a rubber length which has no natural space but can stretch +horizontally as far as needed (*note Lengths::). - The '\fill' parameter is the rubber length itself (technically, the -glue value '0pt plus1fill'); thus, '\hspace\fill' is equivalent to -'\hfill'. + The command '\hfill' is equivalent to '\hspace{\fill}'. For space +that does not disappear at line breaks use '\hspace*{\fill}' instead +(*note \hspace::). -19.3 '\SPACE': Normal interword space -===================================== +19.3 '\(SPACE)' and \@ +====================== -The '\ ' (space) command produces a normal interword space. It's useful -after punctuation which shouldn't end a sentence. For example, 'the -article in Proc.\ Amer.\ Math\. Soc.\ is fundamental'. It is also often -used after control sequences, as in '\TeX\ is a nice system.' +Mark a punctuation character, typically a period, as either ending a +sentence or as ending an abbreviation. + + By default, in justifying a line LaTeX adjusts the space after a +sentence-ending period (or a question mark, exclamation point, comma, or +colon) more than the space between words (*note \frenchspacing::). +LaTeX assumes that the period ends a sentence unless it is preceded by a +capital letter, in which case it takes that period for part of an +abbreviation. Note that if a sentence-ending period is immediately +followed by a right parenthesis or bracket, or right single or double +quote, then the intersentence space follows that parenthesis or quote. + + If you have a period ending an abbreviation whose last letter is not +a capital letter, and that abbreviation is not the last word in the +sentence, then follow that period with a backslash-space ('\ ') or a tie +('~'). Examples are 'Nat.\ Acad.\ Science', and 'Mr.~Bean', and +'(manure, etc.)\ for sale'. + + For other use of '\ ', see also *note \(SPACE) after CS::. + + In the opposite situation, if you have a capital letter followed by a +period that ends the sentence, then put '\@' on the left of that period. +For example, 'book by the MAA\@.' will have intersentence spacing after +the period. + + In contrast, putting '\@' on the right of a period tells TeX that the +period does not end the sentence. In the example 'reserved words (if, +then, etc.\@) are different', TeX will put interword space after the +closing parenthesis (note that '\@' is before the parenthesis). + +19.4 '\ ' after a control sequence +================================== - In normal circumstances, '\'<tab> and '\'<newline> are equivalent to -'\ '. +The '\ ' command is often used after control sequences to keep them from +gobbling the space that follows, as in '\TeX\ is a nice system.' And, +under normal circumstances '\'<tab> and '\'<newline> are equivalent to +'\ '. For other use of '\ ', see also *note \(SPACE) and \@::. -19.4 '\@': Force sentence-ending punctuation -============================================ + Some people prefer to use '{}' for the same purpose, as in '\TeX{} is +a nice system.' This has the advantage that you can always write it the +same way, like '\TeX{}', whether it is followed by a space or by a +punctuation mark. Please compare: -The '\@' command makes the following punctuation character end a -sentence even if it normally would not. This is typically used after a -capital letter. Here are side-by-side examples with and without '\@': + \TeX\ is a nice system. \TeX, a nice system. - ... in C\@. Pascal, though ... - ... in C. Pascal, though ... + \TeX{} is a nice system. \TeX{}, a nice system. -produces + When you define user commands (*note \newcommand & \renewcommand::) +you can prevent the space gobbling after the command by using the +package 'xspace' and inserting '\xspace' at the end of the definition +For instance: + \documentclass{minimal} + \usepackage{xspace} + \newcommand*{\Loup}{Grand Cric\xspace} + \begin{document} + Que le \Loup me croque ! + \end{document} + + A quick hack to use '\xspace' for existing command is as follows: + \documentclass{minimal} + \usepackage{xspace} + \newcommand*{\SansXspaceTeX}{} + \let\SansXspaceTeX\TeX + \renewcommand{\TeX}{\SansXspaceTeX\xspace} + \begin{document} + \TeX is a nice system. + \end{document} + +19.5 '\frenchspacing' +===================== - ... in C. Pascal, though ... - ... in C. Pascal, though ... +This declaration (from Plain TeX) causes LaTeX to treat intersentence +spacing in the same way as interword spacing. -19.5 '\thinspace': Insert 1/6em + In justifying the text in a line, some typographic traditions, +including English, prefer to adjust the space between sentences (or +after other punctuation marks) more than the space between words. +Following this declaration, all spaces are instead treated equally. + + Revert to the default behavior by declaring '\nonfrenchspacing'. + +19.6 '\thinspace': Insert 1/6em =============================== '\thinspace' produces an unbreakable and unstretchable space that is 1/6 of an em. This is the proper space to use between nested quotes, as in '". -19.6 '\/': Insert italic correction +19.7 '\/': Insert italic correction =================================== The '\/' command produces an "italic correction". This is a small space @@ -4245,29 +5929,50 @@ after the 'f') with pdfTeX. There is no concept of italic correction in math mode; spacing is done in a different way. -19.7 '\hrulefill' -================= +19.8 '\hrulefill \dotfill' +========================== -The '\hrulefill' fill command produces a "rubber length" which can -stretch or shrink horizontally. It will be filled with a horizontal -rule. +Produce an infinite rubber length (*note Lengths::) filled with a +horizontal rule (that is, a line) or with dots, instead of just white +space. -19.8 '\dotfill' -=============== + When placed between blank lines this example creates a paragraph that +is left and right justified, where the space in the middle is filled +with evenly spaced dots. -The '\dotfill' command produces a "rubber length" that fills with dots -instead of just white space. + \noindent Jack Aubrey\dotfill Melbury Lodge + + To make the rule or dots go to the line's end use '\null' at the +start or end. + + To change the rule's thickness, copy the definition and adjust it, as +with '\renewcommand{\hrulefill}{\leavevmode\leaders\hrule height +1pt\hfill\kern\z@}', which changes the default thickness of 0.4pt to +1pt. Similarly, adjust the dot spacing as with +'\renewcommand{\dotfill}{\leavevmode\cleaders\hb@xt@ 1.00em{\hss .\hss +}\hfill\kern\z@}', which changes the default length of 0.33em to 1.00em. 19.9 '\addvspace' ================= -'\addvspace{length}' +'\addvspace{LENGTH}' + + Add a vertical space of height LENGTH, which is a rubber length +(*note Lengths::). However, if vertical space has already been added to +the same point in the output by a previous '\addvspace' command then +this command will not add more space than what is needed to make the +natural length of the total vertical space equal to LENGTH. + + Use this command to adjust the vertical space above or below an +environment that starts a new paragraph. (For instance, a Theorem +environment is defined to begin and end in '\addvspace{..}' so that two +consecutive Theorem's are separated by one vertical space, not two.) + + This command is fragile (*note \protect::). - The '\addvspace' command normally adds a vertical space of height -length. However, if vertical space has already been added to the same -point in the output by a previous '\addvspace' command, then this -command will not add more space than is needed to make the natural -length of the total vertical space equal to 'length'. + The error 'Something's wrong--perhaps a missing \item' means that you +were not in vertical mode when you invoked this command; one way to +change that is to precede this command with a '\par' command. 19.10 '\bigskip \medskip \smallskip' ==================================== @@ -4293,23 +5998,53 @@ document class. 19.11 '\vfill' ============== -The '\vfill' fill command produces a rubber length (glue) which can -stretch or shrink vertically as far as needed. It's equivalent to -'\vspace{\fill}' (*note \hfill::). +End the current paragraph and insert a vertical rubber length (*note +Lengths::) that is infinite, so it can stretch or shrink as far as +needed. -19.12 '\vspace[*]{LENGTH}' -========================== + It is often used in the same way as '\vspace{\fill}', except that +'\vfill' ends the current paragraph, whereas '\vspace{\fill}' adds the +infinite vertical space below its line irrespective of the paragraph +structure. In both cases that space will disappear at a page boundary; +to circumvent this see *note \vspace::. -Synopsis: + In this example the page is filled, so the top and bottom lines +contain the text 'Lost Dog!' and the third 'Lost Dog!' is exactly +halfway between them. + + \begin{document} + Lost Dog! + \vfill + Lost Dog! + \vfill + Lost Dog! + \end{document} - \vspace[*]{LENGTH} +19.12 '\vspace{LENGTH}' +======================= - The '\vspace' command adds the vertical space LENGTH, i.e., a rubber -length. LENGTH can be negative or positive. +Synopsis, one of these two: - Ordinarily, LaTeX removes vertical space added by '\vspace' at the -top or bottom of a page. With the optional '*' argument, the space is -not removed. + \vspace{LENGTH} + \vspace*{LENGTH} + + Add the vertical space LENGTH. This can be negative or positive, and +is a rubber length (*note Lengths::). + + LaTeX removes the vertical space from '\vfill' at a page break, that +is, at the top or bottom of a page. The starred version '\vspace*{..}' +causes the space to stay. + + In this example the two questions will be evenly spaced vertically on +the page, with at least one inch of space below each. + + \begin{document} + 1) Who put the bomp in the bomp bah bomp bah bomp? + \vspace{1in plus 1fill} + + 2) Who put the ram in the rama lama ding dong? + \vspace{1in plus 1fill} + \end{document} 20 Boxes ******** @@ -4364,9 +6099,9 @@ Synopsis: \makebox[WIDTH][POSITION]{TEXT} The '\makebox' command creates a box just wide enough to contain the -TEXT specified. The width of the box is specified by the optional WIDTH -argument. The position of the text within the box is determined by the -optional POSITION argument, which may take the following values: +TEXT specified. The width of the box can be overridden by the optional +WIDTH argument. The position of the text within the box is determined +by the optional POSITION argument, which may take the following values: 'c' Centered (default). @@ -4378,8 +6113,8 @@ optional POSITION argument, which may take the following values: Stretch (justify) across entire WIDTH; TEXT must contain stretchable space for this to work. - '\makebox' is also used within the picture environment *note \makebox -(picture)::. + '\makebox' is also used within the 'picture' environment *note +\makebox (picture)::. 20.5 '\parbox' ============== @@ -4621,7 +6356,7 @@ available in OT1; you may need to load the 'textcomp' package. Em-dash: -- (for punctuation). '\textendash (or '--')' - En-dash: -- (for ranges). + En-dash: - (for ranges). '\texteuro' The Euro symbol: Euro. @@ -4728,7 +6463,8 @@ capital letters. These are not available with OT1. Produces a tilde accent over the following, as in n~. '\b' - Produces a bar accent under the following, as in o_. + Produces a bar accent under the following, as in o_. See also + '\underbar' hereinafter. '\c' '\capitalcedilla' @@ -4773,7 +6509,8 @@ capital letters. These are not available with OT1. Not exactly an accent, this produces a bar under the argument text. The argument is always processed in horizontal mode. The bar is always a fixed position under the baseline, thus crossing through - descenders. See also '\underline' in *note Math miscellany::. + descenders. See also '\underline' in *note Math miscellany::. See + also '\b' above. '\v' '\capitalcaron' @@ -4903,8 +6640,8 @@ comma-separated. Each FILE must exactly match a filename specified in a This command can only appear in the preamble. -22.3 \input -=========== +22.3 '\input' +============= Synopsis: @@ -4942,8 +6679,8 @@ contents. The command '\nofiles' overrides these commands, and _prevents_ any of these lists from being generated. -23.1.1 \addcontentsline ------------------------ +23.1.1 '\addcontentsline' +------------------------- The '\addcontentsline'{EXT}{UNIT}{TEXT} command adds an entry to the specified list or table where: @@ -4971,8 +6708,8 @@ ENTRY What is written to the '.EXT' file is the command '\contentsline{UNIT}{NAME}'. -23.1.2 \addtocontents ---------------------- +23.1.2 '\addtocontents' +----------------------- The '\addtocontents'{EXT}{TEXT} command adds text (or formatting commands) directly to the '.EXT' file that generates the table of @@ -5044,61 +6781,122 @@ FAQ entry on this topic, 24 Letters ********** -You can use LaTeX to typeset letters, both personal and business. The -'letter' document class is designed to make a number of letters at once, -although you can make just one if you so desire. +Synopsis: - Your '.tex' source file has the same minimum commands as the other -document classes, i.e., you must have the following commands as a -minimum: + \documentclass{letter} + \address{SENDER ADDRESS} + \signature{SENDER NAME} + \begin{document} + \begin{letter}{RECIPIENT ADDRESS} + \opening{SALUTATION} + LETTER BODY + \closing{CLOSING TEXT} + \end{letter} + ... more letters ... + \end{document} - \documentclass{letter} - \begin{document} - ... letters ... - \end{document} + Produce one or more letters. - Each letter is a 'letter' environment, whose argument is the name and -address of the recipient. For example, you might have: + Each letter is in a separate 'letter' environment, whose argument +RECIPIENT ADDRESS often contains multiple lines separated with a double +backslash ('\\'). For example, you might have: - \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. - \\ Edinburgh, EH1 1AA} + \begin{letter}{Mr. Joe Smith \\ + 2345 Princess St. \\ + Edinburgh, EH1 1AA} ... \end{letter} - The letter itself begins with the '\opening' command. The text of -the letter follows. It is typed as ordinary LaTeX input. Commands that -make no sense in a letter, like '\chapter', do not work. The letter -closes with a '\closing' command. - - After the 'closing', you can have additional material. The '\cc' -command produces the usual "cc: ...". There's also a similar '\encl' -command for a list of enclosures. With both these commands, use '\\' to -separate the items. + The start of the 'letter' environment resets the page number to 1, +and the footnote number to 1 also. + + The SENDER ADDRESS and SENDER NAME are common to all of the letters, +whether there is one or more, so these are best put in the preamble. As +with the recipient address, often SENDER ADDRESS contains multiple lines +separated by a double backslash ('\\'). LaTeX will put the SENDER NAME +under the closing, after a vertical space for the traditional +hand-written signature; it also can contain multiple lines. + + Each letter environment begins with a required '\opening' command +such as '\opening{Dear Madam or Sir:}'. The LETTER BODY text is +ordinary LaTeX so it can contain everything from from enumerated lists +to displayed math, except that commands such as '\chapter' that make no +sense in a letter are turned off. Each letter environment typically +ends with a '\closing' command such as '\closing{Yours,}'. + + Additional material may come after the '\closing'. You can say who +is receiving a copy of the letter with a command like '\cc{the Boss \\ +the Boss's Boss}'. There's a similar '\encl' command for a list of +enclosures. And, you can add a postscript with '\ps'. + + LaTeX's default is to indent the signature and the '\closing' above +it by a length of '\longindentation'. By default this is +'0.5\textwidth'. To make them flush left, put +'\setlength{\longindentation}{0em}' in your preamble. + + To set a fixed date use something like +'\renewcommand{\today}{2015-Oct-12}'. If put in your preamble then it +will apply to all the letters. + + This example shows only one 'letter' environment. The three lines +marked as optional are typically omitted. + + \documentclass{letter} + \address{Sender's street \\ Sender's town} + \signature{Sender's name \\ Sender's title} + % optional: \location{Mailbox 13} + % optional: \telephone{(102) 555-0101} + \begin{document} + \begin{letter}{Recipient's name \\ Recipient's address} + \opening{Sir:} + % optional: \thispagestyle{firstpage} + I am not interested in entering a business arrangement with you. + \closing{Your most humble, etc.,} + \end{letter} + \end{document} These commands are used with the 'letter' class. -24.1 \address{RETURN-ADDRESS} -============================= +24.1 '\address' +=============== + +Synopsis: -The '\address' specifies the return address of a letter, as it should -appear on the letter and the envelope. Separate lines of the address -should be separated by '\\' commands. + \address{SENDERS ADDRESS} - If you do not make an '\address' declaration, then the letter will be -formatted for copying onto your organization's standard letterhead. -(*Note Overview::, for details on your local implementation). If you -give an '\address' declaration, then the letter will be formatted as a -personal letter. + Specifies the return address as it appears on the letter and on the +envelope. Separate multiple lines in SENDERS ADDRESS with a double +backslash '\\'. + + Because it can apply to multiple letters this declaration is often +put in the preamble. However, it can go anywhere, including inside an +individual 'letter' environment. + + This command is optional: without the '\address' declaration the +letter is formatted with some blank space on top, for copying onto +pre-printed letterhead paper. (*Note Overview::, for details on your +local implementation.) With the '\address' declaration, it is formatted +as a personal letter. + + Here is an example. + + \address{Stephen Maturin \\ + The Grapes of the Savoy} 24.2 '\cc' ========== Synopsis: - \cc{NAME1\\NAME2} + \cc{FIRST NAME \\ + .. } + + Produce a list of names to which copies of the letter were sent. +This command is optional. If it appears then typically it comes after +'\closing'. Separate multiple lines with a double backslash '\\'. - Produce a list of NAMEs the letter was copied to. Each name is -printed on a separate line. + \cc{President \\ + Vice President} 24.3 '\closing' =============== @@ -5107,87 +6905,133 @@ Synopsis: \closing{text} - A letter closes with a '\closing' command, for example, - \closing{Best Regards,} + Usually at the end of a letter, above the handwritten signature, +there is a '\closing' (although this command is optional). For example, + + \closing{Regards,} 24.4 '\encl' ============ Synopsis: - \encl{LINE1\\LINE2} + \encl{FIRST ENCLOSED OBJECT \\ + .. } + + Produce a list of things included with the letter. This command is +optional; when it is used, it typically is put after '\closing'. +Separate multiple lines with a double backslash '\\'. - Declare a list of one more enclosures. + \encl{License \\ + Passport } 24.5 '\location' ================ -'\location{address}' +Synopsis: - This modifies your organization's standard address. This only -appears if the 'firstpage' pagestyle is selected. + \location{TEXT} + + The TEXT appears centered at the bottom of the each page. It only +appears if the page style is 'firstpage'. 24.6 '\makelabels' ================== -'\makelabels{number}' +Synopsis: + + \makelabels + + Create a sheet of address labels from the recipient addresses, one +for each letter. This sheet will be output before the letters, with the +idea that you can copy it to a sheet of peel-off labels. This command +goes in the preamble. - If you issue this command in the preamble, LaTeX will create a sheet -of address labels. This sheet will be output before the letters. + Customize the labels by redefining the commands '\startlabels', +'\mlabel', and '\returnaddress' in the preamble. The command +'\startlabels' sets the width, height, number of columns, etc., of the +page onto which the labels are printed. The command '\mlabel{SENDER +ADDRESS}{RECIPIENT ADDRESS}' produces the two labels (or one, if you +choose to ignore the SENDER ADDRESS). The SENDER ADDRESS is the value +returned by the macro '\returnaddress' while RECIPIENT ADDRESS is the +value passed in the argument to the 'letter' environment. By default +'\mlabel' ignores the first argument, the SENDER ADDRESS. 24.7 '\name' ============ -'\name{June Davenport}' +Synopsis: - Your name, used for printing on the envelope together with the return -address. + \name{NAME} -24.8 '\opening{TEXT}' -===================== + Sender's name, used for printing on the envelope together with the +return address. + +24.8 '\opening' +=============== Synopsis: \opening{TEXT} - A letter begins with the '\opening' command. The mandatory argument, -TEXT, is whatever text you wish to start your letter. For instance: + This command is required. It starts a letter, following the +'\begin{letter}{..}'. The mandatory argument TEXT is the text that +starts your letter. For instance: - \opening{Dear Joe,} + \opening{Dear John:} 24.9 '\ps' ========== -Use the '\ps' command to start a postscript in a letter, after +Synopsis: + + \ps{TEXT} + + Add a postscript. This command is optional and usually is used after '\closing'. -24.10 '\signature{TEXT}' -======================== + \ps{P.S. After you have read this letter, burn it. Or eat it.} -Your name, as it should appear at the end of the letter underneath the -space for your signature. '\\' starts a new line within TEXT as usual. +24.10 '\signature' +================== -24.11 '\startbreaks' -==================== +Synopsis: -'\startbreaks' + \signature{FIRST LINE \\ + .. } - Used after a '\stopbreaks' command to allow page breaks again. + The sender's name. This command is optional, although its inclusion +is usual. -24.12 '\stopbreaks' -=================== + The argument text appears at the end of the letter, after the closing +and after a vertical space for the traditional hand-written signature. +Separate multiple lines with a double backslash '\\'. For example: + + \signature{J Fred Muggs \\ + White House} -'\stopbreaks' + LaTeX's default for the vertical space from the '\closing' text down +to the '\signature' text is '6\medskipamount', which is six times 0.7em. - Inhibit page breaks until a '\startbreaks' command occurs. + This command is usually in the preamble, to apply to all the letters +in the document. To have it apply to one letter only, put it inside a +'letter' environment and before the '\closing'. -24.13 '\telephone' + You can include a graphic in the signature, for instance with +'\signature{\vspace{-6\medskipamount}\includegraphics{sig.png}\\ My +name}' (this requires writing '\usepackage{graphicx}' in the preamble). + +24.11 '\telephone' ================== -'\telephone{number}' +Synopsis: + + \telephone{NUMBER} - This is your telephone number. This only appears if the 'firstpage' -pagestyle is selected. + The sender's telephone number. This is typically in the preamble, +where it applies to all letters. This only appears if the 'firstpage' +pagestyle is selected. If so, it appears on the lower right of the +page. 25 Terminal input/output ************************ @@ -5384,1606 +7228,1783 @@ Concept Index * Menu: -* '*' prompt: Command line. (line 5243) -* *-form of defining new commands: \newcommand & \renewcommand. - (line 2690) -* *-form of environment commands: \newenvironment & \renewenvironment. - (line 2769) -* *-form of sectioning commands: Sectioning. (line 974) -* '.glo' file: Glossaries. (line 4997) -* '.idx' file: Indexes. (line 5013) -* '.ind' file: Indexes. (line 5027) -* 'see' and 'see also' index entries: Indexes. (line 5020) -* abstracts: abstract. (line 1072) -* accents: Accents. (line 4694) -* accents, mathematical: Math accents. (line 3903) +* '*' prompt: Command line. (line 7136) +* '*'-form of sectioning commands: Sectioning. (line 1422) +* '.glo' file: Glossaries. (line 6780) +* '.idx' file: Indexes. (line 6796) +* '.ind' file: Indexes. (line 6810) +* 'see' and 'see also' index entries: Indexes. (line 6803) +* abstracts: abstract. (line 1535) +* accents: Accents. (line 6475) +* accents, mathematical: Math accents. (line 5541) * accessing any character of a font: Reserved characters. - (line 4505) -* acute accent: Accents. (line 4708) -* acute accent, math: Math accents. (line 3908) + (line 6286) +* acute accent: Accents. (line 6489) +* acute accent, math: Math accents. (line 5546) * additional packages, loading: Document class options. - (line 559) + (line 633) * ae ligature: Non-English characters. - (line 4797) -* align environment, from 'amsmath': eqnarray. (line 1253) -* aligning equations: eqnarray. (line 1253) -* alignment via tabbing: tabbing. (line 1974) -* amsmath package, replacing 'eqnarray': eqnarray. (line 1253) -* appendix, creating: Sectioning. (line 980) + (line 6580) +* align environment, from 'amsmath': eqnarray. (line 1848) +* aligning equations: eqnarray. (line 1848) +* alignment via tabbing: tabbing. (line 2585) +* amsmath package, replacing 'eqnarray': eqnarray. (line 1848) +* appendix, creating: Sectioning. (line 1428) * aring: Non-English characters. - (line 4793) -* arrays, math: array. (line 1083) -* arrow, left, in text: Text symbols. (line 4642) -* arrow, right, in text: Text symbols. (line 4674) -* ascender height: Text symbols. (line 4610) -* ASCII circumflex, in text: Text symbols. (line 4575) -* ASCII tilde, in text: Text symbols. (line 4578) -* asterisk, centered, in text: Text symbols. (line 4581) -* author, for titlepage: \maketitle. (line 4074) -* auxiliary file: Output files. (line 370) -* 'babel' package: Accents. (line 4694) -* backslash, in text: Text symbols. (line 4584) -* bar, double vertical, in text: Text symbols. (line 4590) -* bar, vertical, in text: Text symbols. (line 4587) -* bar-over accent: Accents. (line 4717) -* bar-over accent, math: Math accents. (line 3911) -* bar-under accent: Accents. (line 4734) -* basics of LaTeX: Overview. (line 290) -* 'beamer' template and class: beamer template. (line 5259) + (line 6576) +* arrays, math: array. (line 1547) +* arrow, left, in text: Text symbols. (line 6423) +* arrow, right, in text: Text symbols. (line 6455) +* ascender height: Text symbols. (line 6391) +* ASCII circumflex, in text: Text symbols. (line 6356) +* ASCII tilde, in text: Text symbols. (line 6359) +* asterisk, centered, in text: Text symbols. (line 6362) +* at clause, in font definitions: \newfont. (line 4033) +* author, for titlepage: \maketitle. (line 5737) +* auxiliary file: Output files. (line 374) +* 'babel' package: Accents. (line 6475) +* backslash, in text: Text symbols. (line 6365) +* bar, double vertical, in text: Text symbols. (line 6371) +* bar, vertical, in text: Text symbols. (line 6368) +* bar-over accent: Accents. (line 6498) +* bar-over accent, math: Math accents. (line 5549) +* bar-under accent: Accents. (line 6515) +* basics of LaTeX: Overview. (line 293) +* 'beamer' template and class: beamer template. (line 7152) +* beginning of document hook: \AtBeginDocument. (line 1757) * bibliography format, open: Document class options. - (line 526) -* bibliography, creating (automatically): Using BibTeX. (line 2317) -* bibliography, creating (manually): thebibliography. (line 2253) -* bibTeX, using: Using BibTeX. (line 2317) -* big circle symbols, in text: Text symbols. (line 4593) + (line 600) +* bibliography, creating (automatically): Using BibTeX. (line 3105) +* bibliography, creating (manually): thebibliography. (line 3040) +* bibTeX, using: Using BibTeX. (line 3105) +* big circle symbols, in text: Text symbols. (line 6374) +* Big point: Units of length. (line 4304) * black boxes, omitting: Document class options. - (line 512) -* bold font: Font styles. (line 678) -* bold math: Font styles. (line 658) -* bold typewriter, avoiding: description. (line 1178) -* boxes: Boxes. (line 4320) -* brace, left, in text: Text symbols. (line 4596) -* brace, right, in text: Text symbols. (line 4599) -* breaking lines: Line breaking. (line 2437) -* breaking pages: Page breaking. (line 2538) -* breve accent: Accents. (line 4773) -* breve accent, math: Math accents. (line 3914) + (line 586) +* bold font: Font styles. (line 719) +* bold math: Font styles. (line 778) +* bold typewriter, avoiding: description. (line 1688) +* box, allocating new: \newsavebox. (line 3785) +* boxes: Boxes. (line 6101) +* brace, left, in text: Text symbols. (line 6377) +* brace, right, in text: Text symbols. (line 6380) +* breaking lines: Line breaking. (line 3225) +* breaking pages: Page breaking. (line 3361) +* breve accent: Accents. (line 6555) +* breve accent, math: Math accents. (line 5552) * bug reporting: About this document. - (line 247) -* bullet symbol: Math symbols. (line 3240) -* bullet, in text: Text symbols. (line 4602) -* bulleted lists: itemize. (line 1511) -* calligraphic letters for math: Font styles. (line 681) -* cap height: Text symbols. (line 4610) -* caron accent: Accents. (line 4783) -* cc list, in letters: \cc. (line 5099) -* cedilla accent: Accents. (line 4738) -* centered asterisk, in text: Text symbols. (line 4581) + (line 250) +* bullet symbol: Math symbols. (line 4658) +* bullet, in text: Text symbols. (line 6383) +* bulleted lists: itemize. (line 2078) +* calligraphic letters for math: Font styles. (line 722) +* cap height: Text symbols. (line 6391) +* caron accent: Accents. (line 6566) +* cc list, in letters: \cc. (line 6940) +* cedilla accent: Accents. (line 6520) +* centered asterisk, in text: Text symbols. (line 6362) * centered equations: Document class options. - (line 516) -* centered period, in text: Text symbols. (line 4649) -* centering text, declaration for: \centering. (line 1143) -* centering text, environment for: center. (line 1129) -* characters, accented: Accents. (line 4694) + (line 590) +* centered period, in text: Text symbols. (line 6430) +* centering text, declaration for: \centering. (line 1639) +* centering text, environment for: center. (line 1605) +* Centimeter: Units of length. (line 4308) +* characters, accented: Accents. (line 6475) * characters, non-English: Non-English characters. - (line 4788) + (line 6571) * characters, reserved: Reserved characters. - (line 4486) -* check accent: Accents. (line 4783) -* check accent, math: Math accents. (line 3917) -* circle symbol, big, in text: Text symbols. (line 4593) -* circled letter, in text: Text symbols. (line 4605) -* circumflex accent: Accents. (line 4721) -* circumflex accent, math: Math accents. (line 3929) -* circumflex, ASCII, in text: Text symbols. (line 4575) + (line 6267) +* check accent: Accents. (line 6566) +* check accent, math: Math accents. (line 5555) +* Cicero: Units of length. (line 4317) +* circle symbol, big, in text: Text symbols. (line 6374) +* circled letter, in text: Text symbols. (line 6386) +* circumflex accent: Accents. (line 6502) +* circumflex accent, math: Math accents. (line 5567) +* circumflex, ASCII, in text: Text symbols. (line 6356) * class options: Document class options. - (line 490) -* classes of documents: Document classes. (line 459) -* closing letters: \closing. (line 5109) -* closing quote: Text symbols. (line 4566) -* code, typesetting: verbatim. (line 2384) -* command line: Command line. (line 5231) + (line 544) +* classes of documents: Document classes. (line 510) +* closing letters: \closing. (line 6955) +* closing quote: Text symbols. (line 6347) +* code, typesetting: verbatim. (line 3172) +* command line: Command line. (line 7124) * command syntax: LaTeX command syntax. - (line 435) + (line 444) * commands, defining new ones: \newcommand & \renewcommand. - (line 2683) -* composite word mark, in text: Text symbols. (line 4610) -* computer programs, typesetting: verbatim. (line 2384) -* contents file: Output files. (line 380) -* copyright symbol: Text symbols. (line 4523) -* counters, a list of: Counters. (line 2862) -* counters, defining new: \newcounter. (line 2721) -* counters, getting value of: \value. (line 2921) -* counters, setting: \setcounter. (line 2935) -* creating letters: Letters. (line 5050) -* creating pictures: picture. (line 1683) -* creating tables: table. (line 2065) -* credit footnote: \maketitle. (line 4084) -* cross references: Cross references. (line 1001) -* cross references, resolving: Output files. (line 370) -* cross referencing with page number: \pageref. (line 1040) -* cross referencing, symbolic: \ref. (line 1050) -* currency, dollar: Text symbols. (line 4621) -* currency, euro: Text symbols. (line 4630) -* dagger, double, in text: Text symbols. (line 4618) -* dagger, in text: Text symbols. (line 4526) -* dagger, in text <1>: Text symbols. (line 4615) -* date, for titlepage: \maketitle. (line 4080) -* 'datetime' package: \today. (line 4862) + (line 3649) +* commands, defining new ones <1>: \providecommand. (line 3734) +* commands, redefining: \newcommand & \renewcommand. + (line 3649) +* composite word mark, in text: Text symbols. (line 6391) +* computer programs, typesetting: verbatim. (line 3172) +* contents file: Output files. (line 384) +* copyright symbol: Text symbols. (line 6304) +* counters, a list of: Counters. (line 4100) +* counters, defining new: \newcounter. (line 3749) +* counters, getting value of: \value. (line 4184) +* counters, printing: \alph \Alph \arabic \roman \Roman \fnsymbol. + (line 4124) +* counters, setting: \setcounter. (line 4213) +* creating pictures: picture. (line 2282) +* creating tables: table. (line 2676) +* credit footnote: \maketitle. (line 5747) +* cross references: Cross references. (line 1449) +* cross references, resolving: Output files. (line 374) +* cross referencing with page number: \pageref. (line 1503) +* cross referencing, symbolic: \ref. (line 1513) +* currency, dollar: Text symbols. (line 6402) +* currency, euro: Text symbols. (line 6411) +* dagger, double, in text: Text symbols. (line 6399) +* dagger, in text: Text symbols. (line 6307) +* dagger, in text <1>: Text symbols. (line 6396) +* date, for titlepage: \maketitle. (line 5743) +* date, today's: \today. (line 6640) +* 'datetime' package: \today. (line 6645) * defining a new command: \newcommand & \renewcommand. - (line 2683) + (line 3649) +* defining a new command <1>: \providecommand. (line 3734) * defining new environments: \newenvironment & \renewenvironment. - (line 2760) -* defining new fonts: \newfont. (line 2827) -* defining new theorems: \newtheorem. (line 2799) -* definitions: Definitions. (line 2678) -* description lists, creating: description. (line 1166) -* dieresis accent: Accents. (line 4704) -* discretionary multiplication: Math miscellany. (line 3974) -* displaying quoted text with paragraph indentation: quotation. - (line 1944) -* displaying quoted text without paragraph indentation: quote. - (line 1959) + (line 3800) +* defining new fonts: \newfont. (line 4016) +* defining new theorems: \newtheorem. (line 3904) +* definitions: Definitions. (line 3644) +* description lists, creating: description. (line 1671) +* design size, in font definitions: \newfont. (line 4033) +* Didot point: Units of length. (line 4314) +* dieresis accent: Accents. (line 6485) +* discretionary multiplication: Math miscellany. (line 5637) +* displaying quoted text with paragraph indentation: quotation and quote. + (line 2549) +* displaying quoted text without paragraph indentation: quotation and quote. + (line 2549) * document class options: Document class options. - (line 490) + (line 544) * document class, defined: Starting and ending. - (line 324) -* document classes: Document classes. (line 459) -* document templates: Document templates. (line 5252) -* dollar sign: Text symbols. (line 4621) -* dot accent: Accents. (line 4713) -* dot over accent, math: Math accents. (line 3923) -* dot-over accent: Accents. (line 4713) -* dot-under accent: Accents. (line 4742) -* dotless i: Accents. (line 4750) -* dotless i, math: Math accents. (line 3932) -* dotless j: Accents. (line 4753) -* dotless j, math: Math accents. (line 3935) -* double angle quotation marks: Text symbols. (line 4541) -* double dagger, in text: Text symbols. (line 4529) -* double dagger, in text <1>: Text symbols. (line 4618) -* double dot accent, math: Math accents. (line 3920) -* double guillemets: Text symbols. (line 4541) -* double left quote: Text symbols. (line 4655) -* double low-9 quotation mark: Text symbols. (line 4563) -* double quote, straight base: Text symbols. (line 4668) -* double right quote: Text symbols. (line 4658) + (line 327) +* document classes: Document classes. (line 510) +* document templates: Document templates. (line 7145) +* dollar sign: Text symbols. (line 6402) +* dot accent: Accents. (line 6494) +* dot over accent, math: Math accents. (line 5561) +* dot-over accent: Accents. (line 6494) +* dot-under accent: Accents. (line 6524) +* dotless i: Accents. (line 6532) +* dotless i, math: Math accents. (line 5570) +* dotless j: Accents. (line 6535) +* dotless j, math: Math accents. (line 5573) +* double angle quotation marks: Text symbols. (line 6322) +* double dagger, in text: Text symbols. (line 6310) +* double dagger, in text <1>: Text symbols. (line 6399) +* double dot accent, math: Math accents. (line 5558) +* double guillemets: Text symbols. (line 6322) +* double left quote: Text symbols. (line 6436) +* double low-9 quotation mark: Text symbols. (line 6344) +* double quote, straight base: Text symbols. (line 6449) +* double right quote: Text symbols. (line 6439) * double spacing: Low-level font commands. - (line 786) -* double vertical bar, in text: Text symbols. (line 4590) -* e-dash: Text symbols. (line 4627) -* e-TeX: TeX engines. (line 395) -* ellipsis: Text symbols. (line 4547) -* em-dash: Text symbols. (line 4624) -* em-dash, three-quarters: Text symbols. (line 4677) -* em-dash, two-thirds: Text symbols. (line 4683) -* emphasis: Font styles. (line 610) -* emphasis <1>: Font styles. (line 684) -* enclosure list: \encl. (line 5119) -* ending & starting: Starting and ending. - (line 316) -* engines, TeX: TeX engines. (line 389) -* enlarge current page: \enlargethispage. (line 2565) -* environments: Environments. (line 1062) + (line 930) +* double vertical bar, in text: Text symbols. (line 6371) +* e-dash: Text symbols. (line 6408) +* e-TeX: TeX engines. (line 399) +* ellipsis: Text symbols. (line 6328) +* em: Units of length. (line 4322) +* em-dash: Text symbols. (line 6405) +* em-dash, three-quarters: Text symbols. (line 6458) +* em-dash, two-thirds: Text symbols. (line 6464) +* emphasis: Font styles. (line 707) +* enclosure list: \encl. (line 6967) +* end of document hook: \AtEndDocument. (line 1770) +* ending and starting: Starting and ending. + (line 319) +* engines, TeX: TeX engines. (line 393) +* enlarge current page: \enlargethispage. (line 3390) +* environment: Starting and ending. + (line 335) +* environment, theorem-like: \newtheorem. (line 3904) +* environments: Environments. (line 1525) * environments, defining: \newenvironment & \renewenvironment. - (line 2760) -* equation number, cross referencing: \ref. (line 1050) + (line 3800) +* equation number, cross referencing: \ref. (line 1513) * equation numbers, left vs. right: Document class options. - (line 522) -* equation numbers, omitting: eqnarray. (line 1276) -* equations, aligning: eqnarray. (line 1253) -* equations, environment for: equation. (line 1288) + (line 596) +* equation numbers, omitting: eqnarray. (line 1883) +* equations, aligning: eqnarray. (line 1848) +* equations, environment for: equation. (line 1904) * equations, flush left vs. centered: Document class options. - (line 516) + (line 590) * es-zet German letter: Non-English characters. - (line 4829) + (line 6612) * eth, Icelandic letter: Non-English characters. - (line 4801) -* euro symbol: Text symbols. (line 4630) -* exclamation point, upside-down: Text symbols. (line 4633) + (line 6584) +* euro symbol: Text symbols. (line 6411) +* ex: Units of length. (line 4322) +* exclamation point, upside-down: Text symbols. (line 6414) * exponent: Subscripts & superscripts. - (line 3150) -* external files, creating: filecontents. (line 1416) -* feminine ordinal symbol: Text symbols. (line 4646) -* figure number, cross referencing: \ref. (line 1050) -* figures, footnotes in: minipage. (line 1670) -* figures, inserting: figure. (line 1301) -* fixed-width font: Font styles. (line 702) -* 'float' package: figure. (line 1333) + (line 4521) +* external files, writing: filecontents. (line 1975) +* families, of fonts: Low-level font commands. + (line 836) +* feminine ordinal symbol: Text symbols. (line 6427) +* figure number, cross referencing: \ref. (line 1513) +* figures, footnotes in: minipage. (line 2269) +* figures, inserting: figure. (line 1922) +* fixed-width font: Font styles. (line 740) +* 'float' package: Floats. (line 1293) +* float page: Floats. (line 1299) * flush left equations: Document class options. - (line 516) -* flushing floats and starting a page: \clearpage. (line 2553) + (line 590) +* flushing floats and starting a page: \clearpage. (line 3377) +* font catalogue: Low-level font commands. + (line 836) * font commands, low-level: Low-level font commands. - (line 740) -* font sizes: Font sizes. (line 714) -* font styles: Font styles. (line 580) -* fonts: Fonts. (line 574) -* fonts, new commands for: \newfont. (line 2827) -* footer style: \pagestyle. (line 4119) + (line 822) +* font size: Low-level font commands. + (line 914) +* font sizes: Font sizes. (line 796) +* font styles: Font styles. (line 654) +* fonts: Fonts. (line 648) +* fonts, new commands for: \newfont. (line 4016) +* footer style: \pagestyle. (line 5782) * footer, parameters for: Page layout parameters. - (line 880) -* footnote number, cross referencing: \ref. (line 1050) + (line 1115) +* footnote number, cross referencing: \ref. (line 1513) * footnote parameters: Footnote parameters. - (line 2662) -* footnotes in figures: minipage. (line 1670) -* footnotes, creating: Footnotes. (line 2598) -* footnotes, symbolic instead of numbered: Symbolic footnotes. - (line 2649) -* formulas, environment for: equation. (line 1288) -* formulas, math: Math formulas. (line 3114) -* forward references, resolving: Output files. (line 370) -* fragile commands: \protect. (line 2841) -* French quotation marks: Text symbols. (line 4541) -* functions, math: Math functions. (line 3795) + (line 3628) +* footnotes in figures: minipage. (line 2269) +* footnotes, creating: Footnotes. (line 3423) +* Footnotes, in a minipage: \footnote. (line 3470) +* Footnotes, in a table: Footnotes in a table. + (line 3524) +* footnotes, symbols instead of numbers: \footnote. (line 3458) +* formulas, environment for: equation. (line 1904) +* formulas, math: Math formulas. (line 4484) +* forward references, resolving: Output files. (line 374) +* fragile commands: \protect. (line 4051) +* French quotation marks: Text symbols. (line 6322) +* functions, math: Math functions. (line 5433) +* 'geometry' package: Document class options. + (line 575) * global options: Document class options. - (line 490) + (line 544) * global options <1>: Document class options. - (line 567) -* glossaries: Glossaries. (line 4995) -* glossary package: Glossaries. (line 5004) -* graphics packages: \line. (line 1839) -* grave accent: Accents. (line 4725) -* grave accent, math: Math accents. (line 3926) -* greater than symbol, in text: Text symbols. (line 4636) -* greek letters: Math symbols. (line 3159) -* ha'c<ek accent, math: Math accents. (line 3917) -* hacek accent: Accents. (line 4783) -* hat accent: Accents. (line 4721) -* hat accent, math: Math accents. (line 3929) -* header style: \pagestyle. (line 4119) + (line 641) +* glossaries: Glossaries. (line 6778) +* glossary package: Glossaries. (line 6787) +* glue register, plain TeX: \newlength. (line 3770) +* graphics packages: \line. (line 2440) +* grave accent: Accents. (line 6506) +* grave accent, math: Math accents. (line 5564) +* greater than symbol, in text: Text symbols. (line 6417) +* greek letters: Math symbols. (line 4554) +* ha'c<ek accent, math: Math accents. (line 5555) +* hacek accent: Accents. (line 6566) +* hat accent: Accents. (line 6502) +* hat accent, math: Math accents. (line 5567) +* header style: \pagestyle. (line 5782) * header, parameters for: Page layout parameters. - (line 880) + (line 1115) * hello, world: Starting and ending. - (line 316) -* here, putting floats: figure. (line 1333) -* hungarian umlaut accent: Accents. (line 4746) -* hyphenation, defining: \hyphenation. (line 2505) -* hyphenation, forcing: \- (hyphenation). (line 2475) -* hyphenation, preventing: \mbox. (line 4326) + (line 319) +* here, putting floats: Floats. (line 1293) +* hungarian umlaut accent: Accents. (line 6528) +* hyphenation, defining: \hyphenation. (line 3328) +* hyphenation, forcing: \- (hyphenation). (line 3298) +* hyphenation, preventing: \mbox. (line 6107) * Icelandic eth: Non-English characters. - (line 4801) + (line 6584) * Icelandic thorn: Non-English characters. - (line 4833) + (line 6616) * ij letter, Dutch: Non-English characters. - (line 4809) -* implementations of TeX: TeX engines. (line 389) -* in-line formulas: math. (line 1643) -* indent, forcing: \indent. (line 3043) -* indent, suppressing: \noindent. (line 3054) -* indentation of paragraphs, in minipage: minipage. (line 1666) -* index entries, 'see' and 'see also': Indexes. (line 5020) -* indexes: Indexes. (line 5010) -* infinite horizontal stretch: \hfill. (line 4186) -* infinite vertical stretch: \vfill. (line 4299) -* initial command: filecontents. (line 1424) + (line 6592) +* implementations of TeX: TeX engines. (line 393) +* in-line formulas: math. (line 2242) +* indent, forcing: \indent. (line 4402) +* indent, suppressing: \noindent. (line 4413) +* indentation of paragraphs, in minipage: minipage. (line 2265) +* index entries, 'see' and 'see also': Indexes. (line 6803) +* indexes: Indexes. (line 6793) +* infinite horizontal stretch: \hfill. (line 5857) +* infinite vertical stretch: \vfill. (line 6049) * input file: Splitting the input. - (line 4868) -* input/output: Terminal input/output. - (line 5198) -* inserting figures: figure. (line 1301) -* italic correction: \/. (line 4229) -* italic font: Font styles. (line 687) -* justification, ragged left: \raggedleft. (line 1498) -* justification, ragged right: \raggedright. (line 1472) -* Knuth, Donald E.: Overview. (line 290) -* labelled lists, creating: description. (line 1166) -* Lamport TeX: Overview. (line 308) -* Lamport, Leslie: Overview. (line 290) + (line 6651) +* input/output, to terminal: Terminal input/output. + (line 7091) +* inserting figures: figure. (line 1922) +* insertions of special characters: Special insertions. (line 6261) +* italic correction: \/. (line 5958) +* italic font: Font styles. (line 725) +* justification, ragged left: \raggedleft. (line 2065) +* justification, ragged right: \raggedright. (line 2039) +* Knuth, Donald E.: Overview. (line 293) +* labelled lists, creating: description. (line 1671) +* Lamport TeX: Overview. (line 311) +* Lamport, Leslie: Overview. (line 293) * landscape orientation: Document class options. - (line 519) -* LaTeX logo: Text symbols. (line 4532) -* LaTeX overview: Overview. (line 290) + (line 593) +* LaTeX logo: Text symbols. (line 6313) +* LaTeX overview: Overview. (line 293) * LaTeX Project team: About this document. - (line 258) + (line 261) * LaTeX vs. LaTeX2e: About this document. - (line 254) -* LaTeX2e logo: Text symbols. (line 4535) -* layout commands: Layout. (line 810) + (line 257) +* LaTeX2e logo: Text symbols. (line 6316) +* layout commands: Layout. (line 960) * layout, page parameters for: Page layout parameters. - (line 880) -* left angle quotation marks: Text symbols. (line 4541) -* left arrow, in text: Text symbols. (line 4642) -* left brace, in text: Text symbols. (line 4596) -* left quote: Text symbols. (line 4551) -* left quote, double: Text symbols. (line 4655) -* left quote, single: Text symbols. (line 4661) + (line 1115) +* left angle quotation marks: Text symbols. (line 6322) +* left arrow, in text: Text symbols. (line 6423) +* left brace, in text: Text symbols. (line 6377) +* left quote: Text symbols. (line 6332) +* left quote, double: Text symbols. (line 6436) +* left quote, single: Text symbols. (line 6442) * left-hand equation numbers: Document class options. - (line 522) -* left-justifying text: \raggedright. (line 1472) -* left-justifying text, environment for: flushleft. (line 1459) -* left-to-right mode: Modes. (line 4023) -* lengths, adding to: \addtolength. (line 2988) -* lengths, defining and using: Lengths. (line 2975) -* lengths, defining new: \newlength. (line 2736) -* lengths, predefined: Predefined lengths. (line 3016) -* lengths, setting: \setlength. (line 2981) -* less than symbol, in text: Text symbols. (line 4639) -* letters: Letters. (line 5050) -* letters, accented: Accents. (line 4694) -* letters, ending: \closing. (line 5109) + (line 596) +* left-justifying text: \raggedright. (line 2039) +* left-justifying text, environment for: flushleft. (line 2026) +* left-to-right mode: Modes. (line 5686) +* lengths, adding to: \addtolength. (line 4347) +* lengths, allocating new: \newlength. (line 3770) +* lengths, defining and using: Lengths. (line 4262) +* lengths, predefined: Predefined lengths. (line 4375) +* lengths, setting: \setlength. (line 4340) +* less than symbol, in text: Text symbols. (line 6420) +* letters, accented: Accents. (line 6475) +* letters, ending: \closing. (line 6955) * letters, non-English: Non-English characters. - (line 4788) -* letters, starting: \opening. (line 5152) -* line break, forcing: \\. (line 2449) -* line breaking: Line breaking. (line 2437) + (line 6571) +* letters, starting: \opening. (line 7025) +* letters, writing: Letters. (line 6833) +* line break, forcing: \\. (line 3236) +* line breaking: Line breaking. (line 3225) * line breaks, forcing: \linebreak & \nolinebreak. - (line 2521) + (line 3344) * line breaks, preventing: \linebreak & \nolinebreak. - (line 2521) -* lines in tables: tabular. (line 2092) -* lining numerals: Font styles. (line 662) -* lining text up in tables: tabular. (line 2092) -* lining text up using tab stops: tabbing. (line 1974) -* list items, specifying counter: \usecounter. (line 2910) -* list of figures file: Output files. (line 380) -* list of tables file: Output files. (line 380) -* lists of items: itemize. (line 1511) -* lists of items, generic: list. (line 1618) -* lists of items, numbered: enumerate. (line 1215) + (line 3344) +* lines in tables: tabular. (line 2718) +* lining numerals: Font styles. (line 782) +* lining text up in tables: tabular. (line 2718) +* lining text up using tab stops: tabbing. (line 2585) +* list items, specifying counter: \usecounter. (line 4158) +* list of figures file: Output files. (line 384) +* list of tables file: Output files. (line 384) +* lists of items: itemize. (line 2078) +* lists of items, generic: list. (line 2185) +* lists of items, numbered: enumerate. (line 1786) * loading additional packages: Document class options. - (line 559) -* log file: Output files. (line 365) -* logo, LaTeX: Text symbols. (line 4532) -* logo, LaTeX2e: Text symbols. (line 4535) -* logo, TeX: Text symbols. (line 4572) -* low-9 quotation marks, single and double: Text symbols. (line 4563) + (line 633) +* log file: Output files. (line 369) +* logo, LaTeX: Text symbols. (line 6313) +* logo, LaTeX2e: Text symbols. (line 6316) +* logo, TeX: Text symbols. (line 6353) +* low-9 quotation marks, single and double: Text symbols. (line 6344) * low-level font commands: Low-level font commands. - (line 740) -* LR mode: Modes. (line 4023) -* 'ltugboat' class: tugboat template. (line 5310) -* LuaTeX: TeX engines. (line 412) -* macro package, LaTeX as: Overview. (line 295) -* macron accent: Accents. (line 4717) -* macron accent, math: Math accents. (line 3911) -* Madsen, Lars: eqnarray. (line 1253) -* 'makeidx' package: Indexes. (line 5032) -* 'makeindex' program: Indexes. (line 5027) -* making a title page: titlepage. (line 2367) -* making paragraphs: Making paragraphs. (line 3035) -* marginal notes: Marginal notes. (line 3067) -* masculine ordinal symbol: Text symbols. (line 4646) -* math accents: Math accents. (line 3903) -* math formulas: Math formulas. (line 3114) -* math functions: Math functions. (line 3795) -* math miscellany: Math miscellany. (line 3973) -* math mode: Modes. (line 4023) -* math mode, entering: Math formulas. (line 3114) + (line 822) +* LR mode: Modes. (line 5686) +* 'ltugboat' class: tugboat template. (line 7203) +* LuaTeX: TeX engines. (line 416) +* m-width: Units of length. (line 4322) +* macro package, LaTeX as: Overview. (line 298) +* macron accent: Accents. (line 6498) +* macron accent, math: Math accents. (line 5549) +* Madsen, Lars: eqnarray. (line 1848) +* 'makeidx' package: Indexes. (line 6815) +* 'makeindex' program: Indexes. (line 6810) +* making a title page: titlepage. (line 3155) +* making paragraphs: Making paragraphs. (line 4394) +* marginal notes: Marginal notes. (line 4434) +* masculine ordinal symbol: Text symbols. (line 6427) +* math accents: Math accents. (line 5541) +* math formulas: Math formulas. (line 4484) +* math functions: Math functions. (line 5433) +* math miscellany: Math miscellany. (line 5636) +* math mode: Modes. (line 5686) +* math mode, entering: Math formulas. (line 4484) * math mode, spacing: Spacing in math mode. - (line 3955) -* math symbols: Math symbols. (line 3159) -* math, bold: Font styles. (line 658) -* minipage, creating a: minipage. (line 1655) -* modes: Modes. (line 4023) -* monospace font: Font styles. (line 702) -* moving arguments: \protect. (line 2841) -* multicolumn text: \twocolumn. (line 821) -* multilingual support: Accents. (line 4694) -* 'multind' package: Indexes. (line 5043) + (line 5593) +* math symbols: Math symbols. (line 4554) +* math, bold: Font styles. (line 778) +* Millimeter: Units of length. (line 4311) +* minipage, creating a: minipage. (line 2254) +* modes: Modes. (line 5686) +* monospace font: Font styles. (line 740) +* moving arguments: \protect. (line 4051) +* mpfootnote counter: \footnote. (line 3470) +* mu, math unit: Units of length. (line 4333) +* multicolumn text: \twocolumn. (line 975) +* multilingual support: Accents. (line 6475) +* 'multind' package: Indexes. (line 6826) * multiplication symbol, discretionary line break: Math miscellany. - (line 3974) -* nested '\include', not allowed: \include. (line 4892) + (line 5637) +* nested '\include', not allowed: \include. (line 6675) * new commands, defining: \newcommand & \renewcommand. - (line 2683) + (line 3649) +* new commands, defining <1>: \providecommand. (line 3734) * new line, output as input: \obeycr & \restorecr. - (line 2459) -* new line, starting: \\. (line 2449) -* new line, starting (paragraph mode): \newline. (line 2468) -* new page, starting: \newpage. (line 2559) + (line 3268) +* new line, starting: \\. (line 3236) +* new line, starting (paragraph mode): \newline. (line 3277) +* new page, starting: \newpage. (line 3384) * non-English characters: Non-English characters. - (line 4788) -* notes in the margin: Marginal notes. (line 3067) -* null delimiter: Math miscellany. (line 3988) -* numbered items, specifying counter: \usecounter. (line 2910) -* numerals, old-style: Font styles. (line 662) -* oblique font: Font styles. (line 699) + (line 6571) +* notes in the margin: Marginal notes. (line 4434) +* null delimiter: Math miscellany. (line 5651) +* numbered items, specifying counter: \usecounter. (line 4158) +* numerals, old-style: Font styles. (line 782) +* oblique font: Font styles. (line 737) * oe ligature: Non-English characters. - (line 4825) -* ogonek: Accents. (line 4757) -* old-style numerals: Font styles. (line 662) -* one-column output: \onecolumn. (line 815) -* opening quote: Text symbols. (line 4551) -* OpenType fonts: TeX engines. (line 389) + (line 6608) +* ogonek: Accents. (line 6539) +* old-style numerals: Font styles. (line 782) +* one-column output: \onecolumn. (line 965) +* opening quote: Text symbols. (line 6332) +* OpenType fonts: TeX engines. (line 393) * options, document class: Document class options. - (line 490) + (line 544) * options, global: Document class options. - (line 567) -* ordinals, feminine and masculine: Text symbols. (line 4646) + (line 641) +* ordinals, feminine and masculine: Text symbols. (line 6427) * oslash: Non-English characters. - (line 4821) -* overbar accent: Accents. (line 4717) -* overdot accent, math: Math accents. (line 3923) -* overview of LaTeX: Overview. (line 290) + (line 6604) +* overbar accent: Accents. (line 6498) +* overdot accent, math: Math accents. (line 5561) +* overview of LaTeX: Overview. (line 293) * packages, loading additional: Document class options. - (line 559) + (line 633) * page break, forcing: \pagebreak & \nopagebreak. - (line 2580) + (line 3405) * page break, preventing: \pagebreak & \nopagebreak. - (line 2580) -* page breaking: Page breaking. (line 2538) + (line 3405) +* page breaking: Page breaking. (line 3361) * page layout parameters: Page layout parameters. - (line 880) -* page number, cross referencing: \pageref. (line 1040) -* page numbering style: \pagenumbering. (line 4094) -* page styles: Page styles. (line 4062) -* paragraph indentation, in minipage: minipage. (line 1666) -* paragraph indentations in quoted text: quotation. (line 1944) -* paragraph indentations in quoted text, omitting: quote. (line 1959) -* paragraph mode: Modes. (line 4023) -* paragraph symbol: Text symbols. (line 4555) -* paragraphs: Making paragraphs. (line 3035) + (line 1115) +* page number, cross referencing: \pageref. (line 1503) +* page numbering style: \pagenumbering. (line 5757) +* page styles: Page styles. (line 5725) +* paragraph indentation, in minipage: minipage. (line 2265) +* paragraph indentations in quoted text: quotation and quote. + (line 2549) +* paragraph indentations in quoted text, omitting: quotation and quote. + (line 2549) +* paragraph mode: Modes. (line 5686) +* paragraph symbol: Text symbols. (line 6336) +* paragraphs: Making paragraphs. (line 4394) * parameters, for footnotes: Footnote parameters. - (line 2662) + (line 3628) * parameters, page layout: Page layout parameters. - (line 880) -* pdfTeX: Output files. (line 357) -* pdfTeX engine: TeX engines. (line 395) -* period, centered, in text: Text symbols. (line 4649) -* 'pict2e' package: \line. (line 1839) -* pictures, creating: picture. (line 1683) -* pilcrow: Text symbols. (line 4555) -* placement of floats: figure. (line 1314) -* poetry, an environment for: verse. (line 2418) + (line 1115) +* pdfTeX: Output files. (line 361) +* pdfTeX engine: TeX engines. (line 399) +* period, centered, in text: Text symbols. (line 6430) +* pica: Units of length. (line 4298) +* 'pict2e' package: \line. (line 2440) +* pictures, creating: picture. (line 2282) +* pilcrow: Text symbols. (line 6336) +* placement of floats: Floats. (line 1272) +* poetry, an environment for: verse. (line 3206) +* Point: Units of length. (line 4294) * polish l: Non-English characters. - (line 4813) + (line 6596) * portrait orientation: Document class options. - (line 519) -* postscript, in letters: \ps. (line 5164) -* pounds symbol: Text symbols. (line 4559) + (line 593) +* position, in picture: picture. (line 2299) +* postscript, in letters: \ps. (line 7038) +* pounds symbol: Text symbols. (line 6340) * preamble, defined: Starting and ending. - (line 329) -* predefined lengths: Predefined lengths. (line 3016) -* prompt, '*': Command line. (line 5243) -* pronunciation: Overview. (line 308) -* question mark, upside-down: Text symbols. (line 4652) -* quotation marks, French: Text symbols. (line 4541) -* quote, straight base: Text symbols. (line 4668) -* quoted text with paragraph indentation, displaying: quotation. - (line 1944) -* quoted text without paragraph indentation, displaying: quote. - (line 1959) -* ragged left text: \raggedleft. (line 1498) -* ragged left text, environment for: flushright. (line 1485) -* ragged right text: \raggedright. (line 1472) -* ragged right text, environment for: flushleft. (line 1459) + (line 332) +* predefined lengths: Predefined lengths. (line 4375) +* prompt, '*': Command line. (line 7136) +* pronunciation: Overview. (line 311) +* quad: Spacing in math mode. + (line 5619) +* question mark, upside-down: Text symbols. (line 6433) +* quotation marks, French: Text symbols. (line 6322) +* quote, straight base: Text symbols. (line 6449) +* quoted text with paragraph indentation, displaying: quotation and quote. + (line 2549) +* quoted text without paragraph indentation, displaying: quotation and quote. + (line 2549) +* ragged left text: \raggedleft. (line 2065) +* ragged left text, environment for: flushright. (line 2052) +* ragged right text: \raggedright. (line 2039) +* ragged right text, environment for: flushleft. (line 2026) * redefining environments: \newenvironment & \renewenvironment. - (line 2760) -* references, resolving forward: Output files. (line 370) -* registered symbol: Text symbols. (line 4671) -* remarks in the margin: Marginal notes. (line 3067) + (line 3800) +* references, resolving forward: Output files. (line 374) +* registered symbol: Text symbols. (line 6452) +* remarks in the margin: Marginal notes. (line 4434) * reporting bugs: About this document. - (line 247) + (line 250) * reserved characters: Reserved characters. - (line 4486) -* right angle quotation marks: Text symbols. (line 4541) -* right arrow, in text: Text symbols. (line 4674) -* right brace, in text: Text symbols. (line 4599) -* right quote: Text symbols. (line 4566) -* right quote, double: Text symbols. (line 4658) -* right quote, single: Text symbols. (line 4664) + (line 6267) +* right angle quotation marks: Text symbols. (line 6322) +* right arrow, in text: Text symbols. (line 6455) +* right brace, in text: Text symbols. (line 6380) +* right quote: Text symbols. (line 6347) +* right quote, double: Text symbols. (line 6439) +* right quote, single: Text symbols. (line 6445) * right-hand equation numbers: Document class options. - (line 522) -* right-justifying text: \raggedleft. (line 1498) -* right-justifying text, environment for: flushright. (line 1485) -* ring accent: Accents. (line 4762) -* ring accent, math: Math accents. (line 3938) -* robust commands: \protect. (line 2851) -* roman font: Font styles. (line 690) + (line 596) +* right-justifying text: \raggedleft. (line 2065) +* right-justifying text, environment for: flushright. (line 2052) +* ring accent: Accents. (line 6544) +* ring accent, math: Math accents. (line 5576) +* robust commands: \protect. (line 4051) +* roman font: Font styles. (line 728) +* rubber lengths, defining new: \newlength. (line 3770) * running header and footer: Page layout parameters. - (line 880) -* running header and footer style: \pagestyle. (line 4119) -* sans serif font: Font styles. (line 696) -* script letters for math: Font styles. (line 681) -* section number, cross referencing: \ref. (line 1050) -* section numbers, printing: Sectioning. (line 990) -* section symbol: Text symbols. (line 4569) -* sectioning: Sectioning. (line 949) + (line 1115) +* running header and footer style: \pagestyle. (line 5782) +* sans serif font: Font styles. (line 734) +* Scaled point: Units of length. (line 4320) +* script letters for math: Font styles. (line 722) +* section number, cross referencing: \ref. (line 1513) +* section numbers, printing: Sectioning. (line 1438) +* section symbol: Text symbols. (line 6350) +* sectioning commands: Sectioning. (line 1397) +* series, of fonts: Low-level font commands. + (line 861) * 'setspace' package: Low-level font commands. - (line 786) -* setting counters: \setcounter. (line 2935) + (line 930) +* setting counters: \setcounter. (line 4213) +* shapes, of fonts: Low-level font commands. + (line 901) * sharp S letters: Non-English characters. - (line 4829) -* 'showidx' package: Indexes. (line 5039) -* simulating typed text: verbatim. (line 2384) -* single angle quotation marks: Text symbols. (line 4541) -* single guillemets: Text symbols. (line 4541) -* single left quote: Text symbols. (line 4661) -* single low-9 quotation mark: Text symbols. (line 4563) -* single right quote: Text symbols. (line 4664) -* sizes of text: Font sizes. (line 714) -* slanted font: Font styles. (line 699) -* small caps font: Font styles. (line 693) -* space, inserting vertical: \addvspace. (line 4267) -* spaces: Spaces. (line 4162) + (line 6612) +* 'showidx' package: Indexes. (line 6822) +* simulating typed text: verbatim. (line 3172) +* single angle quotation marks: Text symbols. (line 6322) +* single guillemets: Text symbols. (line 6322) +* single left quote: Text symbols. (line 6442) +* single low-9 quotation mark: Text symbols. (line 6344) +* single right quote: Text symbols. (line 6445) +* sizes of text: Font sizes. (line 796) +* skip register, plain TeX: \newlength. (line 3770) +* slanted font: Font styles. (line 737) +* small caps font: Font styles. (line 731) +* space, inserting vertical: \addvspace. (line 6006) +* space, vertical: \vspace. (line 6075) +* spaces: Spaces. (line 5825) * spacing within math mode: Spacing in math mode. - (line 3955) -* Spanish ordinals, feminine and masculine: Text symbols. (line 4646) + (line 5593) +* spacing, intersentence: \frenchspacing. (line 5938) +* Spanish ordinals, feminine and masculine: Text symbols. (line 6427) * special characters: Non-English characters. - (line 4788) -* specifier, float placement: figure. (line 1314) + (line 6571) +* special insertions: Special insertions. (line 6261) +* specifier, float placement: Floats. (line 1272) * splitting the input file: Splitting the input. - (line 4868) -* starting & ending: Starting and ending. - (line 316) -* starting a new page: \newpage. (line 2559) -* starting a new page and clearing floats: \clearpage. (line 2553) -* starting on a right-hand page: \cleardoublepage. (line 2545) -* sterling symbol: Text symbols. (line 4559) -* straight double quote, base: Text symbols. (line 4668) -* straight quote, base: Text symbols. (line 4668) -* stretch, infinite horizontal: \hfill. (line 4186) -* stretch, infinite vertical: \vfill. (line 4299) -* stretch, omitting vertical: \raggedbottom. (line 874) -* styles of text: Font styles. (line 580) -* styles, page: Page styles. (line 4062) + (line 6651) +* starting a new page: \newpage. (line 3384) +* starting a new page and clearing floats: \clearpage. (line 3377) +* starting and ending: Starting and ending. + (line 319) +* starting on a right-hand page: \cleardoublepage. (line 3368) +* sterling symbol: Text symbols. (line 6340) +* straight double quote, base: Text symbols. (line 6449) +* straight quote, base: Text symbols. (line 6449) +* stretch, infinite horizontal: \hfill. (line 5857) +* stretch, infinite vertical: \vfill. (line 6049) +* stretch, omitting vertical: \raggedbottom. (line 1103) +* styles of text: Font styles. (line 654) +* styles, page: Page styles. (line 5725) * subscript: Subscripts & superscripts. - (line 3150) + (line 4521) * superscript: Subscripts & superscripts. - (line 3150) -* symbols, math: Math symbols. (line 3159) -* tab stops, using: tabbing. (line 1974) + (line 4521) +* symbols, math: Math symbols. (line 4554) +* symbols, text: Text symbols. (line 6298) +* tab stops, using: tabbing. (line 2585) * table of contents entry, manually adding: \addcontentsline. - (line 4951) -* table of contents file: Output files. (line 380) -* table of contents, creating: Tables of contents. (line 4930) -* tables, creating: table. (line 2065) + (line 6734) +* table of contents file: Output files. (line 384) +* table of contents, creating: Tables of contents. (line 6713) +* tables, creating: table. (line 2676) +* template, 'beamer': beamer template. (line 7152) +* template, 'book': book template. (line 7183) +* template, TUGboat: tugboat template. (line 7203) +* templates, document: Document templates. (line 7145) * terminal input/output: Terminal input/output. - (line 5198) -* TeX logo: Text symbols. (line 4572) -* text symbols: Text symbols. (line 4517) -* 'textcomp' package: Font styles. (line 662) -* thanks, for titlepage: \maketitle. (line 4084) -* theorems, defining: \newtheorem. (line 2799) -* theorems, typesetting: theorem. (line 2354) + (line 7091) +* TeX logo: Text symbols. (line 6353) +* text symbols: Text symbols. (line 6298) +* 'textcomp' package: Font styles. (line 782) +* thanks, for titlepage: \maketitle. (line 5747) +* theorem-like environment: \newtheorem. (line 3904) +* theorems, defining: \newtheorem. (line 3904) +* theorems, typesetting: theorem. (line 3142) * thorn, Icelandic letter: Non-English characters. - (line 4833) -* three-quarters em-dash: Text symbols. (line 4677) -* tie-after accent: Accents. (line 4768) -* tilde accent: Accents. (line 4731) -* tilde accent, math: Math accents. (line 3941) -* tilde, ASCII, in text: Text symbols. (line 4578) + (line 6616) +* three-quarters em-dash: Text symbols. (line 6458) +* tie-after accent: Accents. (line 6550) +* tilde accent: Accents. (line 6512) +* tilde accent, math: Math accents. (line 5579) +* tilde, ASCII, in text: Text symbols. (line 6359) * title page, separate or run-in: Document class options. - (line 530) -* title pages, creating: titlepage. (line 2367) -* title, for titlepage: \maketitle. (line 4088) -* titles, making: \maketitle. (line 4068) -* trademark symbol: Text symbols. (line 4680) -* transcript file: Output files. (line 365) -* TrueType fonts: TeX engines. (line 389) -* TUGboat template: tugboat template. (line 5310) -* two-column output: \twocolumn. (line 821) -* two-thirds em-dash: Text symbols. (line 4683) -* typed text, simulating: verbatim. (line 2384) -* typeface sizes: Font sizes. (line 714) -* typeface styles: Font styles. (line 580) -* typefaces: Fonts. (line 574) -* typewriter font: Font styles. (line 702) -* typewriter labels in lists: description. (line 1178) -* umlaut accent: Accents. (line 4704) -* underbar: Accents. (line 4776) -* underscore, in text: Text symbols. (line 4686) -* Unicode input, native: TeX engines. (line 389) + (line 604) +* title pages, creating: titlepage. (line 3155) +* title, for titlepage: \maketitle. (line 5751) +* titles, making: \maketitle. (line 5731) +* trademark symbol: Text symbols. (line 6461) +* transcript file: Output files. (line 369) +* TrueType fonts: TeX engines. (line 393) +* TUGboat template: tugboat template. (line 7203) +* two-column output: \twocolumn. (line 975) +* two-thirds em-dash: Text symbols. (line 6464) +* type styles: Font styles. (line 654) +* typed text, simulating: verbatim. (line 3172) +* typeface sizes: Font sizes. (line 796) +* typefaces: Fonts. (line 648) +* typewriter font: Font styles. (line 740) +* typewriter labels in lists: description. (line 1688) +* umlaut accent: Accents. (line 6485) +* underbar: Accents. (line 6558) +* underscore, in text: Text symbols. (line 6467) +* Unicode input, native: TeX engines. (line 393) +* units, of length: Units of length. (line 4290) * unofficial nature of this manual: About this document. - (line 258) -* unordered lists: itemize. (line 1511) -* using BibTeX: Using BibTeX. (line 2317) -* UTF-8: TeX engines. (line 389) -* variables, a list of: Counters. (line 2862) -* vector symbol, math: Math accents. (line 3944) -* verbatim text: verbatim. (line 2384) -* verbatim text, inline: \verb. (line 2401) -* vertical bar, double, in text: Text symbols. (line 4590) -* vertical bar, in text: Text symbols. (line 4587) -* vertical space: \addvspace. (line 4267) -* vertical space before paragraphs: \parskip. (line 3061) -* visible space: \verb. (line 2412) -* visible space symbol, in text: Text symbols. (line 4689) -* wide hat accent, math: Math accents. (line 3947) -* wide tile accent, math: Math accents. (line 3950) -* writing external files: filecontents. (line 1416) -* XeTeX: TeX engines. (line 421) -* 'xindy' program: Indexes. (line 5027) + (line 261) +* unordered lists: itemize. (line 2078) +* using BibTeX: Using BibTeX. (line 3105) +* UTF-8: TeX engines. (line 393) +* variables, a list of: Counters. (line 4100) +* vector symbol, math: Math accents. (line 5582) +* verbatim text: verbatim. (line 3172) +* verbatim text, inline: \verb. (line 3189) +* vertical bar, double, in text: Text symbols. (line 6371) +* vertical bar, in text: Text symbols. (line 6368) +* vertical space: \addvspace. (line 6006) +* vertical space <1>: \vspace. (line 6075) +* vertical space before paragraphs: \parskip. (line 4428) +* visible space: \verb. (line 3200) +* visible space symbol, in text: Text symbols. (line 6470) +* weights, of fonts: Low-level font commands. + (line 871) +* white space: Spaces. (line 5825) +* wide hat accent, math: Math accents. (line 5585) +* wide tilde accent, math: Math accents. (line 5588) +* widths, of fonts: Low-level font commands. + (line 883) +* writing external files: filecontents. (line 1975) +* writing letters: Letters. (line 6833) +* x-height: Units of length. (line 4322) +* XeTeX: TeX engines. (line 425) +* 'xindy' program: Indexes. (line 6810) Command Index ************* * Menu: -* $: Math formulas. (line 3132) -* --help command-line option: Command line. (line 5239) -* .aux file: Output files. (line 370) -* .dvi file: Output files. (line 347) -* .lof file: Output files. (line 380) -* .lof file <1>: Tables of contents. (line 4940) -* .log file: Output files. (line 365) -* .lot file: Output files. (line 380) -* .lot file <1>: Tables of contents. (line 4940) -* .pdf file: Output files. (line 357) -* .tex, default extension: Command line. (line 5231) -* .toc file: Output files. (line 380) -* .toc file <1>: Tables of contents. (line 4930) +* $: Math formulas. (line 4502) +* &: tabular. (line 2744) +* --help command-line option: Command line. (line 7132) +* .aux file: Output files. (line 374) +* .dvi file: Output files. (line 351) +* .fd file: \newfont. (line 4026) +* .lof file: Output files. (line 384) +* .lof file <1>: Tables of contents. (line 6723) +* .log file: Output files. (line 369) +* .lot file: Output files. (line 384) +* .lot file <1>: Tables of contents. (line 6723) +* .pdf file: Output files. (line 361) +* .tex, default extension: Command line. (line 7124) +* .toc file: Output files. (line 384) +* .toc file <1>: Tables of contents. (line 6713) +* .xdv file: TeX engines. (line 425) * 10pt option: Document class options. - (line 498) + (line 552) * 11pt option: Document class options. - (line 498) + (line 552) * 12pt option: Document class options. - (line 498) -* @{...}: array. (line 1107) + (line 552) * [...] for optional arguments: LaTeX command syntax. - (line 435) + (line 444) * \ character starting commands: LaTeX command syntax. - (line 435) -* \" (umlaut accent): Accents. (line 4704) + (line 444) +* \!: Spacing in math mode. + (line 5616) +* \" (umlaut accent): Accents. (line 6485) * \#: Reserved characters. - (line 4491) + (line 6272) * \$: Reserved characters. - (line 4491) + (line 6272) * \%: Reserved characters. - (line 4491) + (line 6272) * \&: Reserved characters. - (line 4491) -* \' (acute accent): Accents. (line 4708) -* \' (tabbing): tabbing. (line 2013) -* \(: Math formulas. (line 3124) -* \): Math formulas. (line 3124) -* \*: Math miscellany. (line 3973) -* \+: tabbing. (line 2005) + (line 6272) +* \' (acute accent): Accents. (line 6489) +* \' (tabbing): tabbing. (line 2624) +* \(: Math formulas. (line 4494) +* \(SPACE): \(SPACE) and \@. (line 5867) +* \): Math formulas. (line 4494) +* \*: Math miscellany. (line 5636) +* \+: tabbing. (line 2616) * \,: Spacing in math mode. - (line 3966) -* \-: tabbing. (line 2009) -* \- (hyphenation): \- (hyphenation). (line 2475) -* \. (dot-over accent): Accents. (line 4713) -* \/: \/. (line 4229) + (line 5612) +* \-: tabbing. (line 2620) +* \- (hyphenation): \- (hyphenation). (line 3298) +* \. (dot-over accent): Accents. (line 6494) +* \/: \/. (line 5958) * \:: Spacing in math mode. - (line 3964) + (line 5608) * \;: Spacing in math mode. - (line 3961) -* \<: tabbing. (line 2001) -* \= (macron accent): Accents. (line 4717) -* \= (tabbing): tabbing. (line 1995) -* \>: tabbing. (line 1999) + (line 5603) +* \<: tabbing. (line 2612) +* \= (macron accent): Accents. (line 6498) +* \= (tabbing): tabbing. (line 2606) +* \>: tabbing. (line 2610) * \> <1>: Spacing in math mode. - (line 3964) -* \> (tabbing): tabbing. (line 1998) -* \@: \@. (line 4207) -* \@fnsymbol: Symbolic footnotes. (line 2654) -* \a (tabbing): tabbing. (line 2028) -* \a' (acute accent in tabbing): tabbing. (line 2029) -* \a= (macron accent in tabbing): tabbing. (line 2029) + (line 5608) +* \> (tabbing): tabbing. (line 2609) +* \@: \(SPACE) and \@. (line 5867) +* \@fnsymbol: \footnote. (line 3458) +* \a (tabbing): tabbing. (line 2639) +* \a' (acute accent in tabbing): tabbing. (line 2640) +* \a= (macron accent in tabbing): tabbing. (line 2640) * \aa (aa): Non-English characters. - (line 4793) + (line 6576) * \AA (AA): Non-English characters. - (line 4793) -* \acute: Math accents. (line 3907) -* \addcontentsline{EXT}{UNIT}{TEXT}: \addcontentsline. (line 4951) -* \address: \address. (line 5086) -* \addtocontents{EXT}{TEXT}: \addtocontents. (line 4980) -* \addtocounter: \addtocounter. (line 2945) -* \addtolength: \addtolength. (line 2988) -* \addvspace: \addvspace. (line 4267) + (line 6576) +* \acute: Math accents. (line 5545) +* \addcontentsline{EXT}{UNIT}{TEXT}: \addcontentsline. (line 6734) +* \address: \address. (line 6913) +* \addtocontents{EXT}{TEXT}: \addtocontents. (line 6763) +* \addtocounter: \addtocounter. (line 4224) +* \addtolength: \addtolength. (line 4347) +* \addvspace: \addvspace. (line 6006) * \ae (ae): Non-English characters. - (line 4797) + (line 6580) * \AE (AE): Non-English characters. - (line 4797) -* \aleph: Math symbols. (line 3167) + (line 6580) +* \aleph: Math symbols. (line 4567) * \alph: \alph \Alph \arabic \roman \Roman \fnsymbol. - (line 2880) + (line 4128) * \Alph: \alph \Alph \arabic \roman \Roman \fnsymbol. - (line 2883) -* \Alph example: enumerate. (line 1248) -* \alpha: Math symbols. (line 3170) -* \alsoname: Indexes. (line 5024) -* \amalg: Math symbols. (line 3173) -* \and for '\author': \maketitle. (line 4074) -* \angle: Math symbols. (line 3176) -* \appendix: Sectioning. (line 980) -* \approx: Math symbols. (line 3179) + (line 4131) +* \Alph example: enumerate. (line 1832) +* \alpha: Math symbols. (line 4570) +* \alsoname: Indexes. (line 6807) +* \amalg: Math symbols. (line 4573) +* \and for '\author': \maketitle. (line 5737) +* \angle: Math symbols. (line 4576) +* \appendix: Sectioning. (line 1428) +* \approx: Math symbols. (line 4581) * \arabic: \alph \Alph \arabic \roman \Roman \fnsymbol. - (line 2886) -* \arccos: Math functions. (line 3798) -* \arcsin: Math functions. (line 3801) -* \arctan: Math functions. (line 3804) -* \arg: Math functions. (line 3807) -* \arraycolsep: array. (line 1119) -* \arrayrulewidth: tabular. (line 2186) -* \arraystretch: tabular. (line 2190) -* \ast: Math symbols. (line 3182) -* \asymp: Math symbols. (line 3185) -* \author{NAME \and NAME2}: \maketitle. (line 4073) -* \a` (grave accent in tabbing): tabbing. (line 2029) -* \b (bar-under accent): Accents. (line 4734) -* \backslash: Math symbols. (line 3188) + (line 4134) +* \arccos: Math functions. (line 5436) +* \arcsin: Math functions. (line 5439) +* \arctan: Math functions. (line 5442) +* \arg: Math functions. (line 5445) +* \arraycolsep: array. (line 1579) +* \arrayrulewidth: tabular. (line 2868) +* \arraystretch: tabular. (line 2874) +* \ast: Math symbols. (line 4584) +* \asymp: Math symbols. (line 4593) +* \AtBeginDocument: \AtBeginDocument. (line 1757) +* \AtEndDocument: \AtEndDocument. (line 1770) +* \author{NAME \and NAME2}: \maketitle. (line 5736) +* \a` (grave accent in tabbing): tabbing. (line 2640) +* \b (bar-under accent): Accents. (line 6515) +* \backslash: Math symbols. (line 4596) * \backslash <1>: Reserved characters. - (line 4496) -* \bar: Math accents. (line 3910) + (line 6277) +* \bar: Math accents. (line 5548) * \baselineskip: Low-level font commands. - (line 780) + (line 914) * \baselinestretch: Low-level font commands. - (line 786) -* \begin: Environments. (line 1062) -* \beta: Math symbols. (line 3191) -* \bf: Font styles. (line 677) -* \bfseries: Font styles. (line 616) -* \bibitem: \bibitem. (line 2278) -* \bibliography: Using BibTeX. (line 2317) -* \bibliographystyle: Using BibTeX. (line 2317) -* \bigcap: Math symbols. (line 3194) -* \bigcap <1>: Math symbols. (line 3224) -* \bigcirc: Math symbols. (line 3197) -* \bigcup: Math symbols. (line 3200) -* \bigodot: Math symbols. (line 3203) -* \bigoplus: Math symbols. (line 3206) -* \bigotimes: Math symbols. (line 3209) + (line 924) +* \begin: Environments. (line 1525) +* \beta: Math symbols. (line 4600) +* \bf: Font styles. (line 718) +* \bfseries: Font styles. (line 687) +* \bibitem: \bibitem. (line 3065) +* \bibliography: Using BibTeX. (line 3105) +* \bibliographystyle: Using BibTeX. (line 3105) +* \bigcap: Math symbols. (line 4603) +* \bigcirc: Math symbols. (line 4607) +* \bigcup: Math symbols. (line 4611) +* \bigodot: Math symbols. (line 4615) +* \bigoplus: Math symbols. (line 4618) +* \bigotimes: Math symbols. (line 4621) * \bigskip: \bigskip \medskip \smallskip. - (line 4282) + (line 6032) * \bigskipamount: \bigskip \medskip \smallskip. - (line 4282) -* \bigsqcup: Math symbols. (line 3218) -* \bigtriangledown: Math symbols. (line 3212) -* \bigtriangleup: Math symbols. (line 3215) -* \biguplus: Math symbols. (line 3221) -* \bigwedge: Math symbols. (line 3227) -* \bmod: Math functions. (line 3810) -* \boldmath: Math formulas. (line 3137) -* \bot: Math symbols. (line 3230) -* \bottomfraction: figure. (line 1362) -* \bowtie: Math symbols. (line 3233) -* \Box: Math symbols. (line 3236) -* \breve: Math accents. (line 3913) -* \bullet: Math symbols. (line 3239) -* \c (cedilla accent): Accents. (line 4738) -* \cal: Font styles. (line 680) -* \cap: Math symbols. (line 3242) -* \capitalacute: Accents. (line 4708) -* \capitalbreve: Accents. (line 4773) -* \capitalcaron: Accents. (line 4783) -* \capitalcedilla: Accents. (line 4738) -* \capitalcircumflex: Accents. (line 4721) -* \capitaldieresis: Accents. (line 4704) -* \capitaldotaccent: Accents. (line 4742) -* \capitalgrave: Accents. (line 4725) -* \capitalhungarumlaut: Accents. (line 4746) -* \capitalmacron: Accents. (line 4717) -* \capitalnewtie: Accents. (line 4768) -* \capitalogonek: Accents. (line 4757) -* \capitalring: Accents. (line 4762) -* \capitaltie: Accents. (line 4768) -* \capitaltilde: Accents. (line 4731) -* \caption: figure. (line 1355) -* \cc: \cc. (line 5099) -* \cdot: Math symbols. (line 3245) -* \cdots: Math miscellany. (line 3977) -* \centering: \centering. (line 1143) -* \chapter: Sectioning. (line 952) -* \check: Math accents. (line 3916) -* \chi: Math symbols. (line 3248) -* \circ: Math symbols. (line 3251) -* \circle: \circle. (line 1753) -* \cite: \cite. (line 2295) -* \cleardoublepage: \cleardoublepage. (line 2545) -* \clearpage: \clearpage. (line 2553) -* \cline: \cline. (line 2228) -* \closing: \closing. (line 5109) -* \clubsuit: Math symbols. (line 3254) -* \columnsep: \twocolumn. (line 831) -* \columnseprule: \twocolumn. (line 834) -* \columnwidth: \twocolumn. (line 838) -* \cong: Math symbols. (line 3257) -* \contentsline: \addcontentsline. (line 4974) -* \coprod: Math symbols. (line 3260) -* \copyright: Text symbols. (line 4521) -* \cos: Math functions. (line 3813) -* \cosh: Math functions. (line 3816) -* \cot: Math functions. (line 3819) -* \coth: Math functions. (line 3822) -* \csc: Math functions. (line 3825) -* \cup: Math symbols. (line 3263) -* \d (dot-under accent): Accents. (line 4742) -* \dag: Text symbols. (line 4525) -* \dagger: Math symbols. (line 3266) -* \dashbox: \dashbox. (line 1806) -* \dashv: Math symbols. (line 3269) -* \date{TEXT}: \maketitle. (line 4079) -* \day: \day \month \year. (line 2964) -* \dblfloatpagefraction: \twocolumn. (line 849) -* \dblfloatsep: \twocolumn. (line 853) -* \dbltextfloatsep: \twocolumn. (line 858) -* \dbltopfraction: \twocolumn. (line 844) -* \ddag: Text symbols. (line 4528) -* \ddagger: Math symbols. (line 3272) -* \ddot: Math accents. (line 3919) -* \ddots: Math miscellany. (line 3981) -* \deg: Math functions. (line 3828) -* \Delta: Math symbols. (line 3275) -* \delta: Math symbols. (line 3278) -* \depth: Predefined lengths. (line 3020) -* \det: Math functions. (line 3831) + (line 6032) +* \bigsqcup: Math symbols. (line 4632) +* \bigtriangledown: Math symbols. (line 4624) +* \bigtriangleup: Math symbols. (line 4628) +* \biguplus: Math symbols. (line 4635) +* \bigvee: Math symbols. (line 4639) +* \bigwedge: Math symbols. (line 4642) +* \bmod: Math functions. (line 5448) +* \boldmath: Math formulas. (line 4507) +* \bot: Math symbols. (line 4645) +* \bottomfraction: Floats. (line 1335) +* \bottomfraction <1>: Floats. (line 1336) +* \bowtie: Math symbols. (line 4649) +* \Box: Math symbols. (line 4652) +* \breve: Math accents. (line 5551) +* \bullet: Math symbols. (line 4657) +* \c (cedilla accent): Accents. (line 6520) +* \cal: Font styles. (line 721) +* \cap: Math symbols. (line 4660) +* \capitalacute: Accents. (line 6489) +* \capitalbreve: Accents. (line 6555) +* \capitalcaron: Accents. (line 6566) +* \capitalcedilla: Accents. (line 6520) +* \capitalcircumflex: Accents. (line 6502) +* \capitaldieresis: Accents. (line 6485) +* \capitaldotaccent: Accents. (line 6524) +* \capitalgrave: Accents. (line 6506) +* \capitalhungarumlaut: Accents. (line 6528) +* \capitalmacron: Accents. (line 6498) +* \capitalnewtie: Accents. (line 6550) +* \capitalogonek: Accents. (line 6539) +* \capitalring: Accents. (line 6544) +* \capitaltie: Accents. (line 6550) +* \capitaltilde: Accents. (line 6512) +* \caption: figure. (line 1956) +* \caption <1>: table. (line 2696) +* \cc: \cc. (line 6940) +* \cdot: Math symbols. (line 4665) +* \cdots: Math miscellany. (line 5640) +* \centering: \centering. (line 1639) +* \chapter: Sectioning. (line 1400) +* \check: Math accents. (line 5554) +* \chi: Math symbols. (line 4668) +* \circ: Math symbols. (line 4671) +* \circle: \circle. (line 2352) +* \cite: \cite. (line 3083) +* \cleardoublepage: \cleardoublepage. (line 3368) +* \clearpage: \clearpage. (line 3377) +* \cline: \cline. (line 3001) +* \closing: \closing. (line 6955) +* \clubsuit: Math symbols. (line 4676) +* \columnsep: \twocolumn. (line 990) +* \columnsep <1>: Page layout parameters. + (line 1115) +* \columnsep <2>: Page layout parameters. + (line 1118) +* \columnseprule: \twocolumn. (line 996) +* \columnseprule <1>: Page layout parameters. + (line 1116) +* \columnseprule <2>: Page layout parameters. + (line 1118) +* \columnwidth: \twocolumn. (line 1003) +* \columnwidth <1>: Page layout parameters. + (line 1117) +* \columnwidth <2>: Page layout parameters. + (line 1118) +* \complement: Math symbols. (line 4679) +* \cong: Math symbols. (line 4685) +* \contentsline: \addcontentsline. (line 6757) +* \coprod: Math symbols. (line 4688) +* \copyright: Text symbols. (line 6302) +* \cos: Math functions. (line 5451) +* \cosh: Math functions. (line 5454) +* \cot: Math functions. (line 5457) +* \coth: Math functions. (line 5460) +* \csc: Math functions. (line 5463) +* \cup: Math symbols. (line 4691) +* \d (dot-under accent): Accents. (line 6524) +* \dag: Text symbols. (line 6306) +* \dagger: Math symbols. (line 4696) +* \dashbox: \dashbox. (line 2407) +* \dashv: Math symbols. (line 4699) +* \date{TEXT}: \maketitle. (line 5742) +* \day: \day \month \year. (line 4251) +* \dblfloatpagefraction: \twocolumn. (line 1037) +* \dblfloatsep: \twocolumn. (line 1043) +* \dbltextfloatsep: \twocolumn. (line 1050) +* \dbltopfraction: \twocolumn. (line 1015) +* \dbltopnumber: \twocolumn. (line 1055) +* \ddag: Text symbols. (line 6309) +* \ddagger: Math symbols. (line 4703) +* \ddot: Math accents. (line 5557) +* \ddots: Math miscellany. (line 5644) +* \deg: Math functions. (line 5466) +* \Delta: Math symbols. (line 4706) +* \delta: Math symbols. (line 4709) +* \depth: Predefined lengths. (line 4379) +* \det: Math functions. (line 5469) * \dh (d): Non-English characters. - (line 4801) + (line 6584) * \DH (D): Non-English characters. - (line 4801) -* \Diamond: Math symbols. (line 3281) -* \diamond: Math symbols. (line 3284) -* \diamondsuit: Math symbols. (line 3287) -* \dim: Math functions. (line 3834) -* \displaystyle: Math formulas. (line 3142) -* \div: Math symbols. (line 3290) + (line 6584) +* \Diamond: Math symbols. (line 4712) +* \diamond: Math symbols. (line 4716) +* \diamondsuit: Math symbols. (line 4720) +* \dim: Math functions. (line 5472) +* \displaystyle: Math formulas. (line 4512) +* \div: Math symbols. (line 4723) * \dj: Non-English characters. - (line 4805) + (line 6588) * \DJ: Non-English characters. - (line 4805) -* \documentclass: Document classes. (line 459) -* \documentclass, commands before: filecontents. (line 1424) -* \dot: Math accents. (line 3922) -* \doteq: Math symbols. (line 3293) -* \dotfill: \dotfill. (line 4261) -* \dots: Text symbols. (line 4545) -* \doublerulesep: tabular. (line 2194) -* \downarrow: Math symbols. (line 3296) -* \Downarrow: Math symbols. (line 3299) -* \ell: Math symbols. (line 3302) -* \em: Font styles. (line 683) -* \emph: Font styles. (line 610) -* \emptyset: Math symbols. (line 3305) -* \encl: \encl. (line 5119) -* \end: Environments. (line 1062) -* \enlargethispage: \enlargethispage. (line 2565) -* \enumi: enumerate. (line 1238) -* \enumii: enumerate. (line 1238) -* \enumiii: enumerate. (line 1238) -* \enumiv: enumerate. (line 1238) -* \epsilon: Math symbols. (line 3308) -* \equiv: Math symbols. (line 3311) -* \eta: Math symbols. (line 3314) + (line 6588) +* \documentclass: Document classes. (line 510) +* \dot: Math accents. (line 5560) +* \doteq: Math symbols. (line 4726) +* \dotfill: \hrulefill \dotfill. + (line 5983) +* \dots: Text symbols. (line 6326) +* \doublerulesep: tabular. (line 2879) +* \downarrow: Math symbols. (line 4730) +* \Downarrow: Math symbols. (line 4734) +* \ell: Math symbols. (line 4738) +* \emph: Font styles. (line 707) +* \emptyset: Math symbols. (line 4741) +* \encl: \encl. (line 6967) +* \end: Environments. (line 1525) +* \enlargethispage: \enlargethispage. (line 3390) +* \enumi: enumerate. (line 1822) +* \enumii: enumerate. (line 1822) +* \enumiii: enumerate. (line 1822) +* \enumiv: enumerate. (line 1822) +* \epsilon: Math symbols. (line 4745) +* \equiv: Math symbols. (line 4750) +* \eta: Math symbols. (line 4753) * \evensidemargin: Document class options. - (line 541) -* \exists: Math symbols. (line 3317) -* \exp: Math functions. (line 3837) -* \extracolsep: tabular. (line 2157) + (line 615) +* \evensidemargin <1>: Page layout parameters. + (line 1176) +* \evensidemargin <2>: Page layout parameters. + (line 1177) +* \exists: Math symbols. (line 4756) +* \exp: Math functions. (line 5475) +* \extracolsep: tabular. (line 2827) * \fbox: \fbox and \framebox. - (line 4333) + (line 6114) * \fboxrule: \framebox (picture). - (line 1800) + (line 2401) * \fboxrule <1>: \fbox and \framebox. - (line 4345) + (line 6126) * \fboxsep: \framebox (picture). - (line 1800) + (line 2401) * \fboxsep <1>: \fbox and \framebox. - (line 4345) -* \fill: \hfill. (line 4189) -* \flat: Math symbols. (line 3320) -* \floatpagefraction: figure. (line 1365) -* \floatsep: figure. (line 1380) -* \flushbottom: \flushbottom. (line 865) + (line 6126) +* \fill: \hfill. (line 5860) +* \flat: Math symbols. (line 4759) +* \floatpagefraction: Floats. (line 1339) +* \floatpagefraction <1>: Floats. (line 1340) +* \floatsep: Floats. (line 1355) +* \floatsep <1>: Floats. (line 1356) +* \flushbottom: \flushbottom. (line 1084) * \fnsymbol: \alph \Alph \arabic \roman \Roman \fnsymbol. - (line 2895) -* \fnsymbol, and footnotes: Symbolic footnotes. (line 2654) + (line 4143) +* \fnsymbol, and footnotes: \footnote. (line 3458) * \fontencoding: Low-level font commands. - (line 745) + (line 827) * \fontfamily: Low-level font commands. - (line 748) + (line 836) * \fontseries: Low-level font commands. - (line 757) + (line 861) * \fontshape: Low-level font commands. - (line 768) + (line 901) * \fontsize: Low-level font commands. - (line 780) -* \footnote: \footnote. (line 2605) -* \footnotemark: \footnotemark. (line 2620) + (line 914) +* \footnote: \footnote. (line 3441) +* \footnotemark: \footnotemark. (line 3479) * \footnoterule: Footnote parameters. - (line 2662) + (line 3628) * \footnotesep: Footnote parameters. - (line 2668) -* \footnotesize: Font sizes. (line 719) -* \footnotetext: \footnotetext. (line 2635) + (line 3634) +* \footnotesize: Font sizes. (line 801) +* \footnotetext: \footnotetext. (line 3511) * \footskip: Page layout parameters. - (line 890) -* \forall: Math symbols. (line 3323) -* \frac: Math miscellany. (line 3985) -* \frac{num}{den}: Math miscellany. (line 3984) -* \frame: \frame. (line 1821) + (line 1135) +* \footskip <1>: Page layout parameters. + (line 1136) +* \forall: Math symbols. (line 4762) +* \frac: Math miscellany. (line 5648) +* \frac{num}{den}: Math miscellany. (line 5647) +* \frame: \frame. (line 2422) * \framebox: \framebox (picture). - (line 1792) + (line 2393) * \framebox <1>: \fbox and \framebox. - (line 4333) -* \frown: Math symbols. (line 3326) -* \fussy: \fussy. (line 2487) -* \Gamma: Math symbols. (line 3329) -* \gamma: Math symbols. (line 3332) -* \gcd: Math functions. (line 3840) -* \ge: Math symbols. (line 3335) -* \geq: Math symbols. (line 3338) -* \gets: Math symbols. (line 3341) -* \gg: Math symbols. (line 3344) -* \glossary: Glossaries. (line 4997) -* \glossaryentry: Glossaries. (line 5000) -* \grave: Math accents. (line 3925) -* \guillemotleft (<<): Text symbols. (line 4537) -* \guillemotright (>>): Text symbols. (line 4538) -* \guilsinglleft (<): Text symbols. (line 4539) -* \guilsinglright (>): Text symbols. (line 4540) -* \H (Hungarian umlaut accent): Accents. (line 4746) -* \hat: Math accents. (line 3928) -* \hbar: Math symbols. (line 3347) + (line 6114) +* \frenchspacing: \frenchspacing. (line 5938) +* \frown: Math symbols. (line 4765) +* \fussy: \fussy. (line 3310) +* \Gamma: Math symbols. (line 4768) +* \gamma: Math symbols. (line 4771) +* \gcd: Math functions. (line 5478) +* \ge: Math symbols. (line 4774) +* \geq: Math symbols. (line 4778) +* \gets: Math symbols. (line 4782) +* \gg: Math symbols. (line 4785) +* \glossary: Glossaries. (line 6780) +* \glossaryentry: Glossaries. (line 6783) +* \grave: Math accents. (line 5563) +* \guillemotleft (<<): Text symbols. (line 6318) +* \guillemotright (>>): Text symbols. (line 6319) +* \guilsinglleft (<): Text symbols. (line 6320) +* \guilsinglright (>): Text symbols. (line 6321) +* \H (Hungarian umlaut accent): Accents. (line 6528) +* \hat: Math accents. (line 5566) +* \hbar: Math symbols. (line 4789) * \headheight: Page layout parameters. - (line 880) + (line 1123) +* \headheight <1>: Page layout parameters. + (line 1124) * \headsep: Page layout parameters. - (line 885) -* \heartsuit: Math symbols. (line 3350) -* \height: Predefined lengths. (line 3018) -* \hfill: \hfill. (line 4186) -* \hline: \hline. (line 2239) -* \hom: Math functions. (line 3843) -* \hookleftarrow: Math symbols. (line 3353) -* \hookrightarrow: Math symbols. (line 3356) -* \hrulefill: \hrulefill. (line 4254) + (line 1128) +* \headsep <1>: Page layout parameters. + (line 1129) +* \heartsuit: Math symbols. (line 4792) +* \height: Predefined lengths. (line 4377) +* \hfill: \hfill. (line 5857) +* \hline: \hline. (line 3023) +* \hom: Math functions. (line 5481) +* \hookleftarrow: Math symbols. (line 4795) +* \hookrightarrow: Math symbols. (line 4798) +* \hrulefill: \hrulefill \dotfill. + (line 5983) * \hsize: Page layout parameters. - (line 930) -* \hspace: \hspace. (line 4171) -* \huge: Font sizes. (line 719) -* \Huge: Font sizes. (line 719) -* \hyphenation: \hyphenation. (line 2505) -* \i (dotless i): Accents. (line 4750) -* \iff: Math symbols. (line 3359) + (line 1228) +* \hsize <1>: Page layout parameters. + (line 1228) +* \hspace: \hspace. (line 5830) +* \huge: Font sizes. (line 801) +* \Huge: Font sizes. (line 801) +* \hyphenation: \hyphenation. (line 3328) +* \i (dotless i): Accents. (line 6532) +* \iff: Math symbols. (line 4801) * \ij (ij): Non-English characters. - (line 4809) + (line 6592) * \IJ (IJ): Non-English characters. - (line 4809) -* \Im: Math symbols. (line 3362) -* \imath: Math accents. (line 3931) -* \in: Math symbols. (line 3365) -* \include: \include. (line 4880) -* \includeonly: \includeonly. (line 4898) -* \indent: \indent. (line 3043) -* \index: Indexes. (line 5013) -* \indexentry: Indexes. (line 5016) -* \inf: Math functions. (line 3846) -* \infty: Math symbols. (line 3368) -* \input: \input. (line 4912) -* \int: Math symbols. (line 3371) -* \intextsep: figure. (line 1384) -* \iota: Math symbols. (line 3374) -* \it: Font styles. (line 686) -* \item: description. (line 1174) -* \item <1>: enumerate. (line 1228) -* \item <2>: itemize. (line 1511) -* \itemindent: itemize. (line 1554) -* \itemsep: itemize. (line 1576) -* \itshape: Font styles. (line 607) -* \j (dotless j): Accents. (line 4753) -* \jmath: Math accents. (line 3934) -* \Join: Math symbols. (line 3377) -* \k (ogonek): Accents. (line 4757) -* \kappa: Math symbols. (line 3380) -* \ker: Math functions. (line 3849) -* \kill: tabbing. (line 2033) + (line 6592) +* \Im: Math symbols. (line 4805) +* \imath: Math accents. (line 5569) +* \in: Math symbols. (line 4808) +* \include: \include. (line 6663) +* \includeonly: \includeonly. (line 6681) +* \indent: \indent. (line 4402) +* \index: Indexes. (line 6796) +* \indexentry: Indexes. (line 6799) +* \inf: Math functions. (line 5484) +* \infty: Math symbols. (line 4813) +* \input: \input. (line 6695) +* \int: Math symbols. (line 4816) +* \intextsep: Floats. (line 1359) +* \intextsep <1>: Floats. (line 1360) +* \iota: Math symbols. (line 4819) +* \it: Font styles. (line 724) +* \item: description. (line 1679) +* \item <1>: description. (line 1684) +* \item <2>: enumerate. (line 1798) +* \item <3>: itemize. (line 2078) +* \itemindent: itemize. (line 2121) +* \itemsep: itemize. (line 2143) +* \itshape: Font styles. (line 681) +* \j (dotless j): Accents. (line 6535) +* \jmath: Math accents. (line 5572) +* \Join: Math symbols. (line 4822) +* \k (ogonek): Accents. (line 6539) +* \kappa: Math symbols. (line 4826) +* \ker: Math functions. (line 5487) +* \kill: tabbing. (line 2644) * \l (/l): Non-English characters. - (line 4813) + (line 6596) * \L (/L): Non-English characters. - (line 4813) -* \label: \label. (line 1007) -* \labelenumi: enumerate. (line 1242) -* \labelenumii: enumerate. (line 1242) -* \labelenumiii: enumerate. (line 1242) -* \labelenumiv: enumerate. (line 1242) -* \labelitemi: itemize. (line 1534) -* \labelitemii: itemize. (line 1534) -* \labelitemiii: itemize. (line 1534) -* \labelitemiv: itemize. (line 1534) -* \labelsep: itemize. (line 1557) -* \labelwidth: itemize. (line 1560) -* \Lambda: Math symbols. (line 3383) -* \lambda: Math symbols. (line 3386) -* \land: Math symbols. (line 3389) -* \langle: Math symbols. (line 3392) -* \large: Font sizes. (line 719) -* \Large: Font sizes. (line 719) -* \LARGE: Font sizes. (line 719) -* \LaTeX: Text symbols. (line 4531) -* \LaTeXe: Text symbols. (line 4534) -* \lbrace: Math symbols. (line 3395) -* \lbrack: Math symbols. (line 3398) -* \lceil: Math symbols. (line 3401) -* \ldots: Text symbols. (line 4544) -* \le: Math symbols. (line 3404) -* \leadsto: Math symbols. (line 3407) -* \left DELIM1 ... \right DELIM2: Math miscellany. (line 3987) -* \Leftarrow: Math symbols. (line 3409) -* \leftarrow: Math symbols. (line 3412) -* \lefteqn: eqnarray. (line 1281) -* \leftharpoondown: Math symbols. (line 3415) -* \leftharpoonup: Math symbols. (line 3418) -* \leftmargin: itemize. (line 1541) -* \leftmargini: itemize. (line 1541) -* \leftmarginii: itemize. (line 1541) -* \leftmarginiii: itemize. (line 1541) -* \leftmarginiv: itemize. (line 1541) -* \leftmarginv: itemize. (line 1541) -* \leftmarginvi: itemize. (line 1541) -* \Leftrightarrow: Math symbols. (line 3421) -* \leftrightarrow: Math symbols. (line 3424) -* \leq: Math symbols. (line 3427) -* \lfloor: Math symbols. (line 3430) -* \lg: Math functions. (line 3852) -* \lhd: Math symbols. (line 3433) -* \lim: Math functions. (line 3855) -* \liminf: Math functions. (line 3858) -* \limsup: Math functions. (line 3861) -* \line: \line. (line 1832) + (line 6596) +* \label: \label. (line 1455) +* \labelenumi: enumerate. (line 1827) +* \labelenumii: enumerate. (line 1827) +* \labelenumiii: enumerate. (line 1827) +* \labelenumiv: enumerate. (line 1827) +* \labelitemi: itemize. (line 2101) +* \labelitemii: itemize. (line 2101) +* \labelitemiii: itemize. (line 2101) +* \labelitemiv: itemize. (line 2101) +* \labelsep: itemize. (line 2124) +* \labelwidth: itemize. (line 2127) +* \Lambda: Math symbols. (line 4829) +* \lambda: Math symbols. (line 4832) +* \land: Math symbols. (line 4835) +* \langle: Math symbols. (line 4840) +* \large: Font sizes. (line 801) +* \Large: Font sizes. (line 801) +* \LARGE: Font sizes. (line 801) +* \LaTeX: Text symbols. (line 6312) +* \LaTeXe: Text symbols. (line 6315) +* \lbrace: Math symbols. (line 4845) +* \lbrack: Math symbols. (line 4849) +* \lceil: Math symbols. (line 4853) +* \ldots: Text symbols. (line 6325) +* \le: Math symbols. (line 4857) +* \leadsto: Math symbols. (line 4861) +* \left DELIM1 ... \right DELIM2: Math miscellany. (line 5650) +* \Leftarrow: Math symbols. (line 4868) +* \leftarrow: Math symbols. (line 4873) +* \lefteqn: eqnarray. (line 1888) +* \leftharpoondown: Math symbols. (line 4877) +* \leftharpoonup: Math symbols. (line 4880) +* \leftmargin: itemize. (line 2108) +* \leftmargini: itemize. (line 2108) +* \leftmarginii: itemize. (line 2108) +* \leftmarginiii: itemize. (line 2108) +* \leftmarginiv: itemize. (line 2108) +* \leftmarginv: itemize. (line 2108) +* \leftmarginvi: itemize. (line 2108) +* \Leftrightarrow: Math symbols. (line 4883) +* \leftrightarrow: Math symbols. (line 4888) +* \leq: Math symbols. (line 4893) +* \lfloor: Math symbols. (line 4897) +* \lg: Math functions. (line 5490) +* \lhd: Math symbols. (line 4900) +* \lim: Math functions. (line 5493) +* \liminf: Math functions. (line 5496) +* \limsup: Math functions. (line 5499) +* \line: \line. (line 2433) * \linebreak: \linebreak & \nolinebreak. - (line 2521) + (line 3344) * \linespread: Low-level font commands. - (line 793) -* \linethickness: \linethickness. (line 1846) + (line 937) +* \linethickness: \linethickness. (line 2447) * \linewidth: Page layout parameters. - (line 895) -* \listoffigures: Tables of contents. (line 4940) -* \listoftables: Tables of contents. (line 4940) -* \listparindent: itemize. (line 1563) -* \ll: Math symbols. (line 3436) -* \ln: Math functions. (line 3864) -* \lnot: Math symbols. (line 3439) -* \location: \location. (line 5128) -* \log: Math functions. (line 3867) -* \longleftarrow: Math symbols. (line 3442) -* \longleftrightarrow: Math symbols. (line 3445) -* \longmapsto: Math symbols. (line 3448) -* \longrightarrow: Math symbols. (line 3451) -* \lor: Math symbols. (line 3454) -* \lq: Text symbols. (line 4550) -* \makebox: \makebox. (line 4365) -* \makebox (for 'picture'): \makebox (picture). (line 1765) -* \makeglossary: Glossaries. (line 4995) -* \makeindex: Indexes. (line 5010) -* \makelabels: \makelabels. (line 5136) -* \maketitle: \maketitle. (line 4068) -* \mapsto: Math symbols. (line 3457) -* \marginpar: Marginal notes. (line 3067) -* \marginparpush: Marginal notes. (line 3094) -* \marginparsep: Marginal notes. (line 3098) -* \marginparwidth: Marginal notes. (line 3102) -* \markboth{LEFT}{RIGHT}: \pagestyle. (line 4142) -* \markright{RIGHT}: \pagestyle. (line 4149) -* \mathbf: Font styles. (line 640) -* \mathcal: Font styles. (line 656) -* \mathnormal: Font styles. (line 653) -* \mathring: Math accents. (line 3937) -* \mathrm: Font styles. (line 637) -* \mathsf: Font styles. (line 643) -* \mathtt: Font styles. (line 646) -* \mathversion: Font styles. (line 658) -* \max: Math functions. (line 3870) -* \mbox: \mbox. (line 4326) -* \mbox, and LR mode: Modes. (line 4041) -* \mdseries: Font styles. (line 613) + (line 1142) +* \linewidth <1>: Page layout parameters. + (line 1143) +* \listoffigures: Tables of contents. (line 6723) +* \listoftables: Tables of contents. (line 6723) +* \listparindent: itemize. (line 2130) +* \ll: Math symbols. (line 4907) +* \ln: Math functions. (line 5502) +* \lnot: Math symbols. (line 4911) +* \location: \location. (line 6983) +* \log: Math functions. (line 5505) +* \longleftarrow: Math symbols. (line 4914) +* \longleftrightarrow: Math symbols. (line 4919) +* \longmapsto: Math symbols. (line 4923) +* \longrightarrow: Math symbols. (line 4928) +* \lor: Math symbols. (line 4933) +* \lq: Text symbols. (line 6331) +* \makebox: \makebox. (line 6146) +* \makebox (for 'picture'): \makebox (picture). (line 2365) +* \makeglossary: Glossaries. (line 6778) +* \makeindex: Indexes. (line 6793) +* \makelabels: \makelabels. (line 6993) +* \maketitle: \maketitle. (line 5731) +* \mapsto: Math symbols. (line 4936) +* \marginpar: Marginal notes. (line 4434) +* \marginparpush: Page layout parameters. + (line 1149) +* \marginparpush <1>: Page layout parameters. + (line 1152) +* \marginparpush <2>: Marginal notes. (line 4464) +* \marginparsep: Marginal notes. (line 4468) +* \marginparwidth: Page layout parameters. + (line 1151) +* \marginparwidth <1>: Page layout parameters. + (line 1152) +* \marginparwidth <2>: Marginal notes. (line 4472) +* \marginsep: Page layout parameters. + (line 1150) +* \marginsep <1>: Page layout parameters. + (line 1152) +* \markboth{LEFT}{RIGHT}: \pagestyle. (line 5805) +* \markright{RIGHT}: \pagestyle. (line 5812) +* \mathbf: Font styles. (line 760) +* \mathcal: Font styles. (line 776) +* \mathnormal: Font styles. (line 773) +* \mathring: Math accents. (line 5575) +* \mathrm: Font styles. (line 757) +* \mathsf: Font styles. (line 763) +* \mathtt: Font styles. (line 766) +* \mathversion: Font styles. (line 778) +* \max: Math functions. (line 5508) +* \mbox: \mbox. (line 6107) +* \mbox, and LR mode: Modes. (line 5704) +* \mdseries: Font styles. (line 684) * \medskip: \bigskip \medskip \smallskip. - (line 4287) + (line 6037) * \medskipamount: \bigskip \medskip \smallskip. - (line 4287) -* \mho: Math symbols. (line 3460) -* \mid: Math symbols. (line 3462) -* \min: Math functions. (line 3873) -* \models: Math symbols. (line 3465) -* \month: \day \month \year. (line 2964) -* \mp: Math symbols. (line 3468) -* \mu: Math symbols. (line 3471) -* \multicolumn: \multicolumn. (line 2206) -* \multiput: \multiput. (line 1870) -* \nabla: Math symbols. (line 3474) -* \name: \name. (line 5144) -* \natural: Math symbols. (line 3477) -* \ne: Math symbols. (line 3480) -* \nearrow: Math symbols. (line 3483) -* \neg: Math symbols. (line 3486) -* \neq: Math symbols. (line 3489) + (line 6037) +* \medspace: Spacing in math mode. + (line 5608) +* \mho: Math symbols. (line 4940) +* \mid: Math symbols. (line 4945) +* \min: Math functions. (line 5511) +* \models: Math symbols. (line 4955) +* \month: \day \month \year. (line 4251) +* \mp: Math symbols. (line 4960) +* \mu: Math symbols. (line 4963) +* \multicolumn: \multicolumn. (line 2894) +* \multiput: \multiput. (line 2471) +* \nabla: Math symbols. (line 4966) +* \name: \name. (line 7015) +* \natural: Math symbols. (line 4969) +* \ne: Math symbols. (line 4972) +* \nearrow: Math symbols. (line 4975) +* \neg: Math symbols. (line 4978) +* \neq: Math symbols. (line 4982) * \newcommand: \newcommand & \renewcommand. - (line 2683) -* \newcounter: \newcounter. (line 2721) + (line 3649) +* \newcounter: \newcounter. (line 3749) * \newenvironment: \newenvironment & \renewenvironment. - (line 2760) -* \newfont: \newfont. (line 2827) -* \newlength: \newlength. (line 2736) -* \newline: \newline. (line 2468) -* \NEWLINE: \SPACE. (line 4196) -* \newpage: \newpage. (line 2559) -* \newsavebox: \newsavebox. (line 2750) -* \newtheorem: \newtheorem. (line 2799) -* \newtie: Accents. (line 4768) + (line 3800) +* \newfont: \newfont. (line 4016) +* \newlength: \newlength. (line 3770) +* \newline: \newline. (line 3277) +* \NEWLINE: \(SPACE) and \@. (line 5867) +* \newpage: \newpage. (line 3384) +* \newsavebox: \newsavebox. (line 3785) +* \newtheorem: \newtheorem. (line 3904) +* \newtie: Accents. (line 6550) * \ng: Non-English characters. - (line 4817) + (line 6600) * \NG: Non-English characters. - (line 4817) -* \ni: Math symbols. (line 3492) -* \nocite: \nocite. (line 2309) -* \nocorr: Font styles. (line 595) -* \nocorrlist: Font styles. (line 595) -* \nofiles: Tables of contents. (line 4945) -* \noindent: \noindent. (line 3054) + (line 6600) +* \ni: Math symbols. (line 4985) +* \nocite: \nocite. (line 3097) +* \nocorr: Font styles. (line 669) +* \nocorrlist: Font styles. (line 669) +* \nofiles: Tables of contents. (line 6728) +* \noindent: \noindent. (line 4413) * \nolinebreak: \linebreak & \nolinebreak. - (line 2521) -* \nonumber: eqnarray. (line 1276) + (line 3344) +* \nonfrenchspacing: \frenchspacing. (line 5938) +* \nonumber: eqnarray. (line 1883) * \nopagebreak: \pagebreak & \nopagebreak. - (line 2580) -* \normalfont: Font styles. (line 634) -* \normalmarginpar: Marginal notes. (line 3082) -* \normalsize: Font sizes. (line 719) -* \not: Math symbols. (line 3495) -* \notin: Math symbols. (line 3498) -* \nu: Math symbols. (line 3501) -* \nwarrow: Math symbols. (line 3504) + (line 3405) +* \normalfont: Font styles. (line 705) +* \normalmarginpar: Marginal notes. (line 4452) +* \normalsize: Font sizes. (line 801) +* \not: Math symbols. (line 4990) +* \notin: Math symbols. (line 4998) +* \nu: Math symbols. (line 5002) +* \nwarrow: Math symbols. (line 5005) * \o (/o): Non-English characters. - (line 4821) + (line 6604) * \O (/O): Non-English characters. - (line 4821) + (line 6604) * \obeycr: \obeycr & \restorecr. - (line 2459) + (line 3268) * \oddsidemargin: Document class options. - (line 541) -* \odot: Math symbols. (line 3507) + (line 615) +* \oddsidemargin <1>: Page layout parameters. + (line 1175) +* \oddsidemargin <2>: Page layout parameters. + (line 1177) +* \odot: Math symbols. (line 5008) * \oe (oe): Non-English characters. - (line 4825) + (line 6608) * \OE (OE): Non-English characters. - (line 4825) -* \oint: Math symbols. (line 3510) -* \oldstylenums: Font styles. (line 662) -* \Omega: Math symbols. (line 3513) -* \omega: Math symbols. (line 3516) -* \ominus: Math symbols. (line 3519) -* \onecolumn: \onecolumn. (line 815) -* \opening: \opening. (line 5152) -* \oplus: Math symbols. (line 3522) -* \oslash: Math symbols. (line 3525) -* \otimes: Math symbols. (line 3528) -* \oval: \oval. (line 1880) -* \overbrace{TEXT}: Math miscellany. (line 3992) -* \overline{TEXT}: Math miscellany. (line 3996) -* \owns: Math symbols. (line 3531) -* \P: Text symbols. (line 4553) + (line 6608) +* \oint: Math symbols. (line 5013) +* \oldstylenums: Font styles. (line 782) +* \Omega: Math symbols. (line 5017) +* \omega: Math symbols. (line 5020) +* \ominus: Math symbols. (line 5023) +* \onecolumn: \onecolumn. (line 965) +* \opening: \opening. (line 7025) +* \oplus: Math symbols. (line 5026) +* \oslash: Math symbols. (line 5030) +* \otimes: Math symbols. (line 5033) +* \oval: \oval. (line 2482) +* \overbrace{TEXT}: Math miscellany. (line 5655) +* \overline{TEXT}: Math miscellany. (line 5659) +* \owns: Math symbols. (line 5038) +* \P: Text symbols. (line 6334) * \pagebreak: \pagebreak & \nopagebreak. - (line 2580) -* \pagenumbering: \pagenumbering. (line 4094) -* \pageref: \pageref. (line 1040) -* \pagestyle: \pagestyle. (line 4119) -* \paragraph: Sectioning. (line 957) -* \parallel: Math symbols. (line 3534) -* \parbox: \parbox. (line 4390) -* \parindent: minipage. (line 1666) -* \parindent <1>: \indent. (line 3043) -* \parsep: itemize. (line 1581) -* \parskip: \parskip. (line 3061) -* \parskip example: itemize. (line 1597) -* \part: Sectioning. (line 951) -* \partial: Math symbols. (line 3537) -* \partopsep: itemize. (line 1591) -* \perp: Math symbols. (line 3540) -* \phi: Math symbols. (line 3543) -* \Pi: Math symbols. (line 3546) -* \pi: Math symbols. (line 3549) -* \pm: Math symbols. (line 3552) -* \pmod: Math functions. (line 3876) -* \poptabs: tabbing. (line 2039) -* \poptabs <1>: tabbing. (line 2040) -* \pounds: Text symbols. (line 4557) -* \Pr: Math functions. (line 3879) -* \prec: Math symbols. (line 3555) -* \preceq: Math symbols. (line 3558) -* \prime: Math symbols. (line 3561) -* \prod: Math symbols. (line 3564) -* \propto: Math symbols. (line 3567) -* \protect: \protect. (line 2841) -* \ps: \ps. (line 5164) -* \Psi: Math symbols. (line 3570) -* \psi: Math symbols. (line 3573) -* \pushtabs: tabbing. (line 2042) -* \put: \put. (line 1904) -* \quotedblbase (,,): Text symbols. (line 4561) -* \quotesinglbase (,): Text symbols. (line 4562) -* \r (ring accent): Accents. (line 4762) -* \raggedbottom: \raggedbottom. (line 874) -* \raggedleft: \raggedleft. (line 1498) -* \raggedright: \raggedright. (line 1472) -* \raisebox: \raisebox. (line 4430) -* \rangle: Math symbols. (line 3576) -* \rbrace: Math symbols. (line 3579) -* \rbrack: Math symbols. (line 3582) -* \rceil: Math symbols. (line 3585) -* \Re: Math symbols. (line 3588) -* \ref: \ref. (line 1050) -* \refstepcounter: \refstepcounter. (line 2951) + (line 3405) +* \pagenumbering: \pagenumbering. (line 5757) +* \pageref: \pageref. (line 1503) +* \pagestyle: \pagestyle. (line 5782) +* \paperheight: Page layout parameters. + (line 1188) +* \paperheight <1>: Page layout parameters. + (line 1189) +* \paperwidth: Page layout parameters. + (line 1194) +* \paperwidth <1>: Page layout parameters. + (line 1195) +* \paragraph: Sectioning. (line 1405) +* \parallel: Math symbols. (line 5043) +* \parbox: \parbox. (line 6171) +* \parindent: minipage. (line 2265) +* \parindent <1>: \indent. (line 4402) +* \parsep: itemize. (line 2148) +* \parskip: \parskip. (line 4428) +* \parskip example: itemize. (line 2164) +* \part: Sectioning. (line 1399) +* \partial: Math symbols. (line 5046) +* \partopsep: itemize. (line 2158) +* \pdfpageheight: Document class options. + (line 575) +* \pdfpagewidth: Document class options. + (line 575) +* \perp: Math symbols. (line 5049) +* \phi: Math symbols. (line 5054) +* \Pi: Math symbols. (line 5058) +* \pi: Math symbols. (line 5061) +* \pm: Math symbols. (line 5065) +* \pmod: Math functions. (line 5514) +* \poptabs: tabbing. (line 2650) +* \poptabs <1>: tabbing. (line 2651) +* \pounds: Text symbols. (line 6338) +* \Pr: Math functions. (line 5517) +* \prec: Math symbols. (line 5068) +* \preceq: Math symbols. (line 5071) +* \prime: Math symbols. (line 5076) +* \prod: Math symbols. (line 5087) +* \propto: Math symbols. (line 5090) +* \protect: \protect. (line 4051) +* \providecommand: \providecommand. (line 3734) +* \ps: \ps. (line 7038) +* \Psi: Math symbols. (line 5093) +* \psi: Math symbols. (line 5096) +* \pushtabs: tabbing. (line 2653) +* \put: \put. (line 2509) +* \qquad: Spacing in math mode. + (line 5625) +* \quad: Spacing in math mode. + (line 5619) +* \quotedblbase (,,): Text symbols. (line 6342) +* \quotesinglbase (,): Text symbols. (line 6343) +* \r (ring accent): Accents. (line 6544) +* \raggedbottom: \raggedbottom. (line 1103) +* \raggedleft: \raggedleft. (line 2065) +* \raggedright: \raggedright. (line 2039) +* \raisebox: \raisebox. (line 6211) +* \rangle: Math symbols. (line 5099) +* \rbrace: Math symbols. (line 5103) +* \rbrack: Math symbols. (line 5107) +* \rceil: Math symbols. (line 5111) +* \Re: Math symbols. (line 5114) +* \ref: \ref. (line 1513) +* \refstepcounter: \refstepcounter. (line 4230) * \renewenvironment: \newenvironment & \renewenvironment. - (line 2760) + (line 3800) * \restorecr: \obeycr & \restorecr. - (line 2459) -* \reversemarginpar: Marginal notes. (line 3082) -* \rfloor: Math symbols. (line 3591) -* \rhd: Math symbols. (line 3594) -* \rho: Math symbols. (line 3597) -* \right: Math miscellany. (line 3988) -* \Rightarrow: Math symbols. (line 3600) -* \rightarrow: Math symbols. (line 3603) -* \rightharpoondown: Math symbols. (line 3606) -* \rightharpoonup: Math symbols. (line 3609) -* \rightleftharpoons: Math symbols. (line 3612) -* \rightmargin: itemize. (line 1567) -* \rm: Font styles. (line 689) -* \rmfamily: Font styles. (line 604) + (line 3268) +* \restriction: Math symbols. (line 5119) +* \reversemarginpar: Marginal notes. (line 4452) +* \rfloor: Math symbols. (line 5124) +* \rhd: Math symbols. (line 5128) +* \rho: Math symbols. (line 5135) +* \right: Math miscellany. (line 5651) +* \Rightarrow: Math symbols. (line 5139) +* \rightarrow: Math symbols. (line 5143) +* \rightharpoondown: Math symbols. (line 5148) +* \rightharpoonup: Math symbols. (line 5151) +* \rightleftharpoons: Math symbols. (line 5154) +* \rightmargin: itemize. (line 2134) +* \rm: Font styles. (line 727) +* \rmfamily: Font styles. (line 678) * \roman: \alph \Alph \arabic \roman \Roman \fnsymbol. - (line 2889) + (line 4137) * \Roman: \alph \Alph \arabic \roman \Roman \fnsymbol. - (line 2892) -* \rq: Text symbols. (line 4565) -* \rule: \rule. (line 4838) -* \S: Text symbols. (line 4568) -* \savebox: \savebox. (line 4446) -* \sbox: \sbox. (line 4458) -* \sc: Font styles. (line 692) -* \scriptsize: Font sizes. (line 719) -* \scshape: Font styles. (line 628) -* \searrow: Math symbols. (line 3615) -* \sec: Math functions. (line 3882) -* \section: Sectioning. (line 954) -* \seename: Indexes. (line 5024) + (line 4140) +* \rq: Text symbols. (line 6346) +* \rule: \rule. (line 6621) +* \S: Text symbols. (line 6349) +* \savebox: \savebox. (line 6227) +* \sbox: \sbox. (line 6239) +* \sc: Font styles. (line 730) +* \scriptsize: Font sizes. (line 801) +* \scshape: Font styles. (line 699) +* \searrow: Math symbols. (line 5157) +* \sec: Math functions. (line 5520) +* \section: Sectioning. (line 1402) +* \seename: Indexes. (line 6807) * \selectfont: Low-level font commands. - (line 799) -* \setcounter: \setcounter. (line 2935) -* \setlength: \setlength. (line 2981) -* \setminus: Math symbols. (line 3618) -* \settodepth: \settodepth. (line 2994) -* \settoheight: \settoheight. (line 3002) -* \settowidth: \settowidth. (line 3010) -* \sf: Font styles. (line 695) -* \sffamily: Font styles. (line 625) -* \sharp: Math symbols. (line 3621) -* \shortstack: \shortstack. (line 1914) -* \Sigma: Math symbols. (line 3624) -* \sigma: Math symbols. (line 3627) -* \signature: \signature. (line 5170) -* \sim: Math symbols. (line 3630) -* \simeq: Math symbols. (line 3633) -* \sin: Math functions. (line 3885) -* \sinh: Math functions. (line 3888) -* \sl: Font styles. (line 698) -* \slshape: Font styles. (line 622) -* \small: Font sizes. (line 719) -* \smallint: Math symbols. (line 3636) + (line 943) +* \setcounter: \setcounter. (line 4213) +* \setlength: \setlength. (line 4340) +* \setminus: Math symbols. (line 5160) +* \settodepth: \settodepth. (line 4353) +* \settoheight: \settoheight. (line 4361) +* \settowidth: \settowidth. (line 4369) +* \sf: Font styles. (line 733) +* \sffamily: Font styles. (line 696) +* \sharp: Math symbols. (line 5166) +* \shortstack: \shortstack. (line 2519) +* \Sigma: Math symbols. (line 5169) +* \sigma: Math symbols. (line 5172) +* \signature: \signature. (line 7055) +* \sim: Math symbols. (line 5176) +* \simeq: Math symbols. (line 5179) +* \sin: Math functions. (line 5523) +* \sinh: Math functions. (line 5526) +* \sl: Font styles. (line 736) +* \sloppy: \sloppy. (line 3320) +* \slshape: Font styles. (line 693) +* \small: Font sizes. (line 801) +* \smallint: Math symbols. (line 5182) * \smallskip: \bigskip \medskip \smallskip. - (line 4292) + (line 6042) * \smallskipamount: \bigskip \medskip \smallskip. - (line 4292) -* \smile: Math symbols. (line 3639) -* \SPACE: \SPACE. (line 4196) -* \spadesuit: Math symbols. (line 3642) -* \sqcap: Math symbols. (line 3645) -* \sqcup: Math symbols. (line 3648) -* \sqrt[ROOT]{arg}: Math miscellany. (line 3999) -* \sqsubset: Math symbols. (line 3651) -* \sqsubseteq: Math symbols. (line 3654) -* \sqsupset: Math symbols. (line 3657) -* \sqsupseteq: Math symbols. (line 3660) + (line 6042) +* \smile: Math symbols. (line 5186) +* \spadesuit: Math symbols. (line 5189) +* \sqcap: Math symbols. (line 5192) +* \sqcup: Math symbols. (line 5196) +* \sqrt[ROOT]{arg}: Math miscellany. (line 5662) +* \sqsubset: Math symbols. (line 5200) +* \sqsubseteq: Math symbols. (line 5205) +* \sqsupset: Math symbols. (line 5210) +* \sqsupseteq: Math symbols. (line 5215) * \ss (ss): Non-English characters. - (line 4829) + (line 6612) * \SS (SS): Non-English characters. - (line 4829) -* \stackrel{TEXT}{RELATION}: Math miscellany. (line 4005) -* \star: Math symbols. (line 3663) -* \startbreaks: \startbreaks. (line 5176) -* \stepcounter: \stepcounter. (line 2958) -* \stop: Command line. (line 5243) -* \stopbreaks: \stopbreaks. (line 5183) -* \subparagraph: Sectioning. (line 958) -* \subsection: Sectioning. (line 955) -* \subset: Math symbols. (line 3666) -* \subseteq: Math symbols. (line 3669) -* \subsubsection: Sectioning. (line 956) -* \succ: Math symbols. (line 3672) -* \succeq: Math symbols. (line 3675) -* \sum: Math symbols. (line 3678) -* \sup: Math functions. (line 3891) -* \supset: Math symbols. (line 3681) -* \supseteq: Math symbols. (line 3684) -* \surd: Math symbols. (line 3687) -* \swarrow: Math symbols. (line 3690) + (line 6612) +* \stackrel{TEXT}{RELATION}: Math miscellany. (line 5668) +* \star: Math symbols. (line 5219) +* \stepcounter: \stepcounter. (line 4244) +* \stop: Command line. (line 7136) +* \subparagraph: Sectioning. (line 1406) +* \subsection: Sectioning. (line 1403) +* \subset: Math symbols. (line 5226) +* \subseteq: Math symbols. (line 5229) +* \subsubsection: Sectioning. (line 1404) +* \succ: Math symbols. (line 5232) +* \succeq: Math symbols. (line 5236) +* \sum: Math symbols. (line 5241) +* \sup: Math functions. (line 5529) +* \suppressfloats: Floats. (line 1328) +* \supset: Math symbols. (line 5245) +* \supseteq: Math symbols. (line 5248) +* \surd: Math symbols. (line 5251) +* \swarrow: Math symbols. (line 5256) * \symbol: Reserved characters. - (line 4505) -* \t (tie-after accent): Accents. (line 4768) -* \TAB: \SPACE. (line 4196) -* \tabbingsep: tabbing. (line 2047) -* \tabcolsep: tabular. (line 2198) -* \tableofcontents: Tables of contents. (line 4930) -* \tan: Math functions. (line 3894) -* \tanh: Math functions. (line 3897) -* \tau: Math symbols. (line 3693) -* \telephone: \telephone. (line 5190) -* \TeX: Text symbols. (line 4571) -* \textascenderwordmark: Text symbols. (line 4609) -* \textasciicircum: Text symbols. (line 4574) -* \textasciitilde: Text symbols. (line 4577) -* \textasteriskcentered: Text symbols. (line 4580) -* \textbackslash: Text symbols. (line 4583) -* \textbar: Text symbols. (line 4586) -* \textbardbl: Text symbols. (line 4589) -* \textbf: Font styles. (line 616) -* \textbigcircle: Text symbols. (line 4592) -* \textbraceleft: Text symbols. (line 4595) -* \textbraceright: Text symbols. (line 4598) -* \textbullet: Text symbols. (line 4601) -* \textcapitalwordmark: Text symbols. (line 4608) -* \textcircled{LETTER}: Text symbols. (line 4604) -* \textcompwordmark: Text symbols. (line 4607) -* \textcopyright: Text symbols. (line 4522) -* \textdagger: Text symbols. (line 4614) -* \textdaggerdbl: Text symbols. (line 4617) -* \textdollar (or '$'): Text symbols. (line 4620) -* \textellipsis: Text symbols. (line 4546) -* \textemdash (or '---'): Text symbols. (line 4623) -* \textendash (or '--'): Text symbols. (line 4626) -* \texteuro: Text symbols. (line 4629) -* \textexclamdown (or '!`'): Text symbols. (line 4632) -* \textfloatsep: figure. (line 1389) -* \textfraction: figure. (line 1369) -* \textgreater: Text symbols. (line 4635) + (line 6286) +* \t (tie-after accent): Accents. (line 6550) +* \TAB: \(SPACE) and \@. (line 5867) +* \tabbingsep: tabbing. (line 2658) +* \tabcolsep: tabular. (line 2883) +* \tableofcontents: Tables of contents. (line 6713) +* \tan: Math functions. (line 5532) +* \tanh: Math functions. (line 5535) +* \tau: Math symbols. (line 5259) +* \telephone: \telephone. (line 7079) +* \TeX: Text symbols. (line 6352) +* \textascenderwordmark: Text symbols. (line 6390) +* \textasciicircum: Text symbols. (line 6355) +* \textasciitilde: Text symbols. (line 6358) +* \textasteriskcentered: Text symbols. (line 6361) +* \textbackslash: Text symbols. (line 6364) +* \textbar: Text symbols. (line 6367) +* \textbardbl: Text symbols. (line 6370) +* \textbf: Font styles. (line 687) +* \textbigcircle: Text symbols. (line 6373) +* \textbraceleft: Text symbols. (line 6376) +* \textbraceright: Text symbols. (line 6379) +* \textbullet: Text symbols. (line 6382) +* \textcapitalwordmark: Text symbols. (line 6389) +* \textcircled{LETTER}: Text symbols. (line 6385) +* \textcompwordmark: Text symbols. (line 6388) +* \textcopyright: Text symbols. (line 6303) +* \textdagger: Text symbols. (line 6395) +* \textdaggerdbl: Text symbols. (line 6398) +* \textdollar (or '$'): Text symbols. (line 6401) +* \textellipsis: Text symbols. (line 6327) +* \textemdash (or '---'): Text symbols. (line 6404) +* \textendash (or '--'): Text symbols. (line 6407) +* \texteuro: Text symbols. (line 6410) +* \textexclamdown (or '!`'): Text symbols. (line 6413) +* \textfloatsep: Floats. (line 1364) +* \textfloatsep <1>: Floats. (line 1365) +* \textfraction: Floats. (line 1343) +* \textfraction <1>: Floats. (line 1344) +* \textgreater: Text symbols. (line 6416) * \textheight: Page layout parameters. - (line 903) -* \textit: Font styles. (line 607) -* \textleftarrow: Text symbols. (line 4641) -* \textless: Text symbols. (line 4638) -* \textmd: Font styles. (line 613) -* \textnormal: Font styles. (line 634) -* \textordfeminine: Text symbols. (line 4644) -* \textordmasculine: Text symbols. (line 4645) -* \textparagraph: Text symbols. (line 4554) -* \textperiodcentered: Text symbols. (line 4648) -* \textquestiondown (or '?`'): Text symbols. (line 4651) -* \textquotedblleft (or '``'): Text symbols. (line 4654) -* \textquotedblright (or '''): Text symbols. (line 4657) -* \textquoteleft (or '`'): Text symbols. (line 4660) -* \textquoteright (or '''): Text symbols. (line 4663) -* \textquotestraightbase: Text symbols. (line 4666) -* \textquotestraightdblbase: Text symbols. (line 4667) -* \textregistered: Text symbols. (line 4670) -* \textrightarrow: Text symbols. (line 4673) -* \textrm: Font styles. (line 604) -* \textsc: Font styles. (line 628) -* \textsf: Font styles. (line 625) -* \textsl: Font styles. (line 622) -* \textsterling: Text symbols. (line 4558) -* \textthreequartersemdash: Text symbols. (line 4676) -* \texttrademark: Text symbols. (line 4679) -* \texttt: Font styles. (line 631) -* \texttwelveudash: Text symbols. (line 4682) -* \textunderscore: Text symbols. (line 4685) -* \textup: Font styles. (line 619) -* \textvisiblespace: Text symbols. (line 4688) + (line 1200) +* \textheight <1>: Page layout parameters. + (line 1201) +* \textit: Font styles. (line 681) +* \textleftarrow: Text symbols. (line 6422) +* \textless: Text symbols. (line 6419) +* \textmd: Font styles. (line 684) +* \textnormal: Font styles. (line 705) +* \textordfeminine: Text symbols. (line 6425) +* \textordmasculine: Text symbols. (line 6426) +* \textparagraph: Text symbols. (line 6335) +* \textperiodcentered: Text symbols. (line 6429) +* \textquestiondown (or '?`'): Text symbols. (line 6432) +* \textquotedblleft (or '``'): Text symbols. (line 6435) +* \textquotedblright (or '''): Text symbols. (line 6438) +* \textquoteleft (or '`'): Text symbols. (line 6441) +* \textquoteright (or '''): Text symbols. (line 6444) +* \textquotestraightbase: Text symbols. (line 6447) +* \textquotestraightdblbase: Text symbols. (line 6448) +* \textregistered: Text symbols. (line 6451) +* \textrightarrow: Text symbols. (line 6454) +* \textrm: Font styles. (line 678) +* \textsc: Font styles. (line 699) +* \textsf: Font styles. (line 696) +* \textsl: Font styles. (line 693) +* \textsterling: Text symbols. (line 6339) +* \textthreequartersemdash: Text symbols. (line 6457) +* \texttrademark: Text symbols. (line 6460) +* \texttt: Font styles. (line 702) +* \texttwelveudash: Text symbols. (line 6463) +* \textunderscore: Text symbols. (line 6466) +* \textup: Font styles. (line 690) +* \textvisiblespace: Text symbols. (line 6469) * \textwidth: Page layout parameters. - (line 910) + (line 1208) +* \textwidth <1>: Page layout parameters. + (line 1209) * \th (th): Non-English characters. - (line 4833) + (line 6616) * \TH (TH): Non-English characters. - (line 4833) -* \thanks{TEXT}: \maketitle. (line 4083) -* \theta: Math symbols. (line 3696) -* \thicklines: \thicklines. (line 1856) -* \thinlines: \thinlines. (line 1863) -* \thinspace: \thinspace. (line 4222) -* \thispagestyle: \thispagestyle. (line 4155) -* \tilde: Math accents. (line 3940) -* \times: Math symbols. (line 3699) -* \tiny: Font sizes. (line 719) -* \title{TEXT}: \maketitle. (line 4087) -* \to: Math symbols. (line 3702) -* \today: \today. (line 4857) -* \top: Math symbols. (line 3705) -* \topfraction: figure. (line 1374) + (line 6616) +* \thanks{TEXT}: \maketitle. (line 5746) +* \theta: Math symbols. (line 5262) +* \thicklines: \thicklines. (line 2457) +* \thickspace: Spacing in math mode. + (line 5603) +* \thinlines: \thinlines. (line 2464) +* \thinspace: Spacing in math mode. + (line 5612) +* \thinspace <1>: \thinspace. (line 5951) +* \thispagestyle: \thispagestyle. (line 5818) +* \tilde: Math accents. (line 5578) +* \times: Math symbols. (line 5266) +* \tiny: Font sizes. (line 801) +* \title{TEXT}: \maketitle. (line 5750) +* \to: Math symbols. (line 5270) +* \today: \today. (line 6640) +* \top: Math symbols. (line 5274) +* \topfraction: Floats. (line 1348) +* \topfraction <1>: Floats. (line 1349) * \topmargin: Page layout parameters. - (line 934) -* \topsep: itemize. (line 1585) + (line 1232) +* \topsep: itemize. (line 2152) * \topskip: Page layout parameters. - (line 941) -* \totalheight: Predefined lengths. (line 3022) -* \triangle: Math symbols. (line 3708) -* \triangleleft: Math symbols. (line 3711) -* \triangleright: Math symbols. (line 3714) -* \tt: Font styles. (line 701) -* \ttfamily: Font styles. (line 631) -* \twocolumn: \twocolumn. (line 821) -* \typein: \typein. (line 5201) -* \typeout: \typeout. (line 5215) -* \u (breve accent): Accents. (line 4773) -* \unboldmath: Math formulas. (line 3137) -* \underbar: Accents. (line 4776) -* \underbrace{math}: Math miscellany. (line 4009) -* \underline{text}: Math miscellany. (line 4012) -* \unitlength: picture. (line 1687) -* \unlhd: Math symbols. (line 3717) -* \unrhd: Math symbols. (line 3720) -* \Uparrow: Math symbols. (line 3723) -* \uparrow: Math symbols. (line 3726) -* \Updownarrow: Math symbols. (line 3729) -* \updownarrow: Math symbols. (line 3732) -* \uplus: Math symbols. (line 3735) -* \upshape: Font styles. (line 619) -* \Upsilon: Math symbols. (line 3738) -* \upsilon: Math symbols. (line 3741) -* \usebox: \usebox. (line 4470) -* \usecounter: \usecounter. (line 2910) + (line 1239) +* \topskip <1>: Page layout parameters. + (line 1240) +* \totalheight: Predefined lengths. (line 4381) +* \triangle: Math symbols. (line 5278) +* \triangleleft: Math symbols. (line 5281) +* \triangleright: Math symbols. (line 5287) +* \tt: Font styles. (line 739) +* \ttfamily: Font styles. (line 702) +* \twocolumn: \twocolumn. (line 975) +* \typein: \typein. (line 7094) +* \typeout: \typeout. (line 7108) +* \u (breve accent): Accents. (line 6555) +* \unboldmath: Math formulas. (line 4507) +* \underbar: Accents. (line 6558) +* \underbrace{math}: Math miscellany. (line 5672) +* \underline{text}: Math miscellany. (line 5675) +* \unitlength: picture. (line 2286) +* \unlhd: Math symbols. (line 5293) +* \unrhd: Math symbols. (line 5300) +* \Uparrow: Math symbols. (line 5307) +* \uparrow: Math symbols. (line 5312) +* \Updownarrow: Math symbols. (line 5316) +* \updownarrow: Math symbols. (line 5321) +* \upharpoonright: Math symbols. (line 5326) +* \uplus: Math symbols. (line 5331) +* \upshape: Font styles. (line 690) +* \Upsilon: Math symbols. (line 5337) +* \upsilon: Math symbols. (line 5340) +* \usebox: \usebox. (line 6251) +* \usecounter: \usecounter. (line 4158) * \usefont: Low-level font commands. - (line 803) + (line 951) * \usepackage: Document class options. - (line 559) -* \v (breve accent): Accents. (line 4783) -* \value: \value. (line 2921) -* \varepsilon: Math symbols. (line 3744) -* \varphi: Math symbols. (line 3747) -* \varpi: Math symbols. (line 3750) -* \varrho: Math symbols. (line 3753) -* \varsigma: Math symbols. (line 3756) -* \vartheta: Math symbols. (line 3759) -* \vdash: Math symbols. (line 3762) -* \vdots: Math miscellany. (line 4017) -* \vdots <1>: Math miscellany. (line 4018) -* \vec: Math accents. (line 3943) -* \vector: \vector. (line 1933) -* \vee: Math symbols. (line 3765) -* \verb: \verb. (line 2401) -* \Vert: Math symbols. (line 3768) -* \vert: Math symbols. (line 3771) -* \vfill: \vfill. (line 4299) -* \vline: \vline. (line 2246) -* \vspace: \vspace. (line 4306) -* \wedge: Math symbols. (line 3774) -* \widehat: Math accents. (line 3946) -* \widehat <1>: Math accents. (line 3949) -* \width: Predefined lengths. (line 3016) -* \wp: Math symbols. (line 3777) -* \wr: Math symbols. (line 3780) -* \Xi: Math symbols. (line 3783) -* \xi: Math symbols. (line 3786) -* \year: \day \month \year. (line 2964) -* \zeta: Math symbols. (line 3789) -* \[: Math formulas. (line 3124) -* \\ (for 'array'): array. (line 1104) -* \\ (for 'center'): center. (line 1136) -* \\ (for 'eqnarray'): eqnarray. (line 1268) -* \\ (for 'flushright'): flushright. (line 1491) -* \\ (for '\shortstack' objects): \shortstack. (line 1928) -* \\ (tabbing): tabbing. (line 1992) -* \\ for 'flushleft': flushleft. (line 1465) -* \\ for letters: Letters. (line 5076) -* \\ for 'tabular': tabular. (line 2109) -* \\ for 'verse': verse. (line 2429) -* \\ for '\author': \maketitle. (line 4074) -* \\ for '\title': \maketitle. (line 4088) -* \\ force line break: \\. (line 2449) -* \\* (for 'eqnarray'): eqnarray. (line 1273) -* \]: Math formulas. (line 3124) + (line 633) +* \v (breve accent): Accents. (line 6566) +* \value: \value. (line 4184) +* \varepsilon: Math symbols. (line 5343) +* \varphi: Math symbols. (line 5348) +* \varpi: Math symbols. (line 5352) +* \varrho: Math symbols. (line 5356) +* \varsigma: Math symbols. (line 5360) +* \vartheta: Math symbols. (line 5364) +* \vdash: Math symbols. (line 5368) +* \vdots: Math miscellany. (line 5680) +* \vdots <1>: Math miscellany. (line 5681) +* \vec: Math accents. (line 5581) +* \vector: \vector. (line 2538) +* \vee: Math symbols. (line 5372) +* \verb: \verb. (line 3189) +* \Vert: Math symbols. (line 5377) +* \vert: Math symbols. (line 5393) +* \vfill: \vfill. (line 6049) +* \vline: \vline. (line 2974) +* \vspace: \vspace. (line 6075) +* \wedge: Math symbols. (line 5411) +* \widehat: Math accents. (line 5584) +* \widetilde: Math accents. (line 5587) +* \width: Predefined lengths. (line 4375) +* \wp: Math symbols. (line 5415) +* \wr: Math symbols. (line 5418) +* \Xi: Math symbols. (line 5421) +* \xi: Math symbols. (line 5424) +* \year: \day \month \year. (line 4251) +* \zeta: Math symbols. (line 5427) +* \[: Math formulas. (line 4494) +* \\ (for 'center'): center. (line 1617) +* \\ (for 'eqnarray'): eqnarray. (line 1871) +* \\ (for 'flushright'): flushright. (line 2058) +* \\ (for '\shortstack' objects): \shortstack. (line 2533) +* \\ (tabbing): tabbing. (line 2603) +* \\ for 'flushleft': flushleft. (line 2032) +* \\ for letters: Letters. (line 6877) +* \\ for 'tabular': tabular. (line 2746) +* \\ for 'verse': verse. (line 3217) +* \\ for '\author': \maketitle. (line 5737) +* \\ for '\title': \maketitle. (line 5751) +* \\ force line break: \\. (line 3236) +* \\* (for 'eqnarray'): eqnarray. (line 1879) +* \]: Math formulas. (line 4494) * \^: Reserved characters. - (line 4501) -* \^ (circumflex accent): Accents. (line 4721) + (line 6282) +* \^ (circumflex accent): Accents. (line 6502) * \_: Reserved characters. - (line 4491) -* \` (grave accent): Accents. (line 4725) -* \` (tabbing): tabbing. (line 2019) + (line 6272) +* \` (grave accent): Accents. (line 6506) +* \` (tabbing): tabbing. (line 2630) * \{: Reserved characters. - (line 4491) -* \|: Math symbols. (line 3164) + (line 6272) +* \|: Math symbols. (line 4564) * \}: Reserved characters. - (line 4491) + (line 6272) * \~: Reserved characters. - (line 4501) -* \~ (tilde accent): Accents. (line 4731) + (line 6282) +* \~ (tilde accent): Accents. (line 6512) * ^: Subscripts & superscripts. - (line 3150) + (line 4521) * _: Subscripts & superscripts. - (line 3150) + (line 4521) * {...} for required arguments: LaTeX command syntax. - (line 435) + (line 444) * a4paper option: Document class options. - (line 503) + (line 557) * a5paper option: Document class options. - (line 503) -* abstract environment: abstract. (line 1072) -* array environment: array. (line 1083) -* article class: Document classes. (line 464) + (line 557) +* abstract environment: abstract. (line 1535) +* array environment: array. (line 1547) +* article class: Document classes. (line 515) * b5paper option: Document class options. - (line 503) -* book class: Document classes. (line 464) -* bottomnumber: figure. (line 1395) -* center environment: center. (line 1129) + (line 557) +* book class: Document classes. (line 515) +* bottomnumber: Floats. (line 1371) +* bottomnumber <1>: Floats. (line 1372) +* bp: Units of length. (line 4304) +* cc: Units of length. (line 4317) +* center environment: center. (line 1605) * clock option to 'slides' class: Document class options. - (line 556) -* dbltopnumber: figure. (line 1399) -* description environment: description. (line 1166) -* displaymath environment: displaymath. (line 1189) -* displaymath environment <1>: Math formulas. (line 3114) -* document environment: document. (line 1209) + (line 630) +* cm: Units of length. (line 4308) +* dbltopnumber: Floats. (line 1375) +* dbltopnumber <1>: Floats. (line 1376) +* dd: Units of length. (line 4314) +* description environment: description. (line 1671) +* displaymath environment: displaymath. (line 1711) +* displaymath environment <1>: Math formulas. (line 4484) +* document environment: document. (line 1754) * draft option: Document class options. - (line 508) -* dvipdfmx command: Output files. (line 347) -* dvips command: Output files. (line 347) -* dvitype command: Output files. (line 347) -* enumerate environment: enumerate. (line 1215) -* eqnarray environment: eqnarray. (line 1253) -* equation environment: equation. (line 1288) -* equation environment <1>: Math formulas. (line 3114) -* etex command: TeX engines. (line 395) + (line 582) +* dvipdfmx command: Output files. (line 351) +* dvips command: Output files. (line 351) +* dvitype command: Output files. (line 351) +* em: Units of length. (line 4322) +* enumerate environment: enumerate. (line 1786) +* eqnarray environment: eqnarray. (line 1848) +* equation environment: equation. (line 1904) +* equation environment <1>: Math formulas. (line 4484) +* etex command: TeX engines. (line 399) +* ex: Units of length. (line 4322) * executivepaper option: Document class options. - (line 503) -* figure: figure. (line 1301) -* filecontents: filecontents. (line 1416) + (line 557) +* figure: figure. (line 1922) +* filecontents: filecontents. (line 1975) * final option: Document class options. - (line 508) + (line 582) * first-latex-doc document: About this document. - (line 274) + (line 277) * fleqn option: Document class options. - (line 508) -* flushleft environment: flushleft. (line 1459) -* flushright environment: flushright. (line 1485) + (line 582) +* flushleft environment: flushleft. (line 2026) +* flushright environment: flushright. (line 2052) * <http://home.gna.org/latexrefman> home page: About this document. - (line 247) -* indexspace: Indexes. (line 5036) -* itemize environment: itemize. (line 1511) + (line 250) +* in: Units of length. (line 4301) +* inch: Units of length. (line 4301) +* indexspace: Indexes. (line 6819) +* itemize environment: itemize. (line 2078) * landscape option: Document class options. - (line 508) -* latex command: Output files. (line 347) + (line 582) +* latex command: Output files. (line 351) * latex-doc-ptr document: About this document. - (line 271) + (line 274) * <latexrefman-discuss@gna.org> email address: About this document. - (line 258) + (line 261) * legalpaper option: Document class options. - (line 503) + (line 557) * leqno option: Document class options. - (line 508) -* letter: letter. (line 1613) -* letter class: Document classes. (line 464) + (line 582) +* letter class: Document classes. (line 515) +* letter environment: letter. (line 2180) * letterpaper option: Document class options. - (line 503) -* list: list. (line 1618) -* lR box: picture. (line 1743) -* lrbox: lrbox. (line 4355) + (line 557) +* list: list. (line 2185) +* lR box: picture. (line 2342) +* lrbox: lrbox. (line 6136) * lshort document: About this document. - (line 281) -* lualatex command: TeX engines. (line 412) -* math environment: math. (line 1643) -* math environment <1>: Math formulas. (line 3114) -* minipage environment: minipage. (line 1655) + (line 284) +* lualatex command: TeX engines. (line 416) +* math environment: math. (line 2242) +* math environment <1>: Math formulas. (line 4484) +* minipage environment: minipage. (line 2254) +* mm: Units of length. (line 4311) +* mu: Units of length. (line 4333) * notitlepage option: Document class options. - (line 508) + (line 582) * onecolumn option: Document class options. - (line 535) + (line 609) * oneside option: Document class options. - (line 535) + (line 609) * openany option: Document class options. - (line 535) + (line 609) * openbib option: Document class options. - (line 508) + (line 582) * openright option: Document class options. - (line 535) -* pdflatex command: Output files. (line 357) -* picture: picture. (line 1683) -* printindex: Indexes. (line 5032) -* quotation: quotation. (line 1944) -* quote: quote. (line 1959) -* report class: Document classes. (line 464) -* secnumdepth counter: Sectioning. (line 990) -* slides class: Document classes. (line 464) -* tabbing environment: tabbing. (line 1974) -* table: table. (line 2065) -* tabular environment: tabular. (line 2092) -* textcomp package: Text symbols. (line 4517) -* thebibliography: thebibliography. (line 2253) -* theorem environment: theorem. (line 2354) -* titlepage environment: titlepage. (line 2367) + (line 609) +* pc: Units of length. (line 4298) +* pdflatex command: Output files. (line 361) +* picture: picture. (line 2282) +* printindex: Indexes. (line 6815) +* pt: Units of length. (line 4294) +* quotation: quotation and quote. + (line 2549) +* quote: quotation and quote. + (line 2549) +* report class: Document classes. (line 515) +* secnumdepth counter: Sectioning. (line 1438) +* slides class: Document classes. (line 515) +* sp: Units of length. (line 4320) +* tabbing environment: tabbing. (line 2585) +* table: table. (line 2676) +* tabular environment: tabular. (line 2718) +* textcomp package: Text symbols. (line 6298) +* thebibliography environment: thebibliography. (line 3040) +* theorem environment: theorem. (line 3142) +* titlepage environment: titlepage. (line 3155) * titlepage option: Document class options. - (line 508) -* topnumber: figure. (line 1403) -* totalnumber: figure. (line 1407) + (line 582) +* topmargin: Page layout parameters. + (line 1233) +* topnumber: Floats. (line 1379) +* topnumber <1>: Floats. (line 1380) +* totalnumber: Floats. (line 1383) +* totalnumber <1>: Floats. (line 1384) * twocolumn option: Document class options. - (line 535) + (line 609) * twoside option: Document class options. - (line 535) + (line 609) * usrguide official documentation: About this document. - (line 277) -* verbatim environment: verbatim. (line 2384) -* verse environment: verse. (line 2418) -* xdvi command: Output files. (line 347) -* xelatex command: TeX engines. (line 421) + (line 280) +* verbatim environment: verbatim. (line 3172) +* verse environment: verse. (line 3206) +* xdvi command: Output files. (line 351) +* xdvipdfmx: TeX engines. (line 425) +* xelatex command: TeX engines. (line 425) diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml index ed9dcb8d7ef..c1f519aa5dc 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml @@ -3,11 +3,11 @@ <texinfo xml:lang="en"> <filename file="latex2e.xml"></filename> <preamble>\input texinfo -</preamble><!-- c $Id: latex2e.texi 333 2015-05-12 17:12:37Z karl $ --> +</preamble><!-- c $Id: latex2e.texi 459 2015-10-12 11:33:10Z jhefferon $ --> <!-- comment %**start of header (This is for running Texinfo on a region.) --> <setfilename file="latex2e.info" spaces=" ">latex2e.info</setfilename> -<set name="UPDATED" line=" UPDATED May 2015">May 2015</set> -<settitle spaces=" ">&latex;2e unofficial reference manual (May 2015)</settitle> +<set name="UPDATED" line=" UPDATED October 2015">October 2015</set> +<settitle spaces=" ">&latex;2e unofficial reference manual (October 2015)</settitle> <!-- comment %**end of header (This is for running Texinfo on a region.) --> <!-- c latex 2.09 commands should all be present now, --> @@ -22,6 +22,8 @@ <!-- c xx merge http://mirror.ctan.org/latex2e-reference.tar.gz --> <!-- c xx merge permuted-index --> <!-- c xx merge latex-manual from savannah --> +<!-- c xx merge display style math --> +<!-- c xx vertical mode, horizontal mode --> <!-- c --> <!-- c xx The typeset source2e has an index with all kernel --> <!-- c xx commands, though some are internal and shouldn't be included. --> @@ -30,7 +32,7 @@ <copying endspaces=" "> <para>This document is an unofficial reference manual for &latex;, a -document preparation system, version of May 2015. +document preparation system, version of October 2015. </para> <para>This manual was originally translated from <file>LATEX.HLP</file> v1.0a in the VMS Help Library. The pre-translation version was written by @@ -80,7 +82,7 @@ into another language, under the above conditions for modified versions. <titlepage endspaces=" "> <title spaces=" ">&latex;2e: An unofficial reference manual</title> -<subtitle spaces=" ">May 2015</subtitle> +<subtitle spaces=" ">October 2015</subtitle> <author spaces=" "><url><urefurl>http://home.gna.org/latexrefman</urefurl></url></author> <page></page> <vskip> 0pt plus 1filll</vskip> @@ -90,11 +92,17 @@ into another language, under the above conditions for modified versions. <shortcontents></shortcontents> <contents></contents> +<!-- c Best Effort Symbol --> +<macro name="BES" line=" BES {utf8,math}"><formalarg>utf8</formalarg><formalarg>math</formalarg>@U{\utf8\} +</macro> +<macro name="BESU" line=" BESU {utf8,math}"><formalarg>utf8</formalarg><formalarg>math</formalarg>@U{\utf8\} +</macro> + <node name="Top" spaces=" "><nodename>Top</nodename><nodenext automatic="on">About this document</nodenext><nodeup automatic="on">(dir)</nodeup></node> <top spaces=" "><sectiontitle>&latex;2e: An unofficial reference manual</sectiontitle> <para>This document is an unofficial reference manual (version of -May 2015) for &latex;2e, a document preparation system. +October 2015) for &latex;2e, a document preparation system. </para> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">About this document</menunode><menudescription><pre xml:space="preserve">Bug reporting, etc. @@ -210,7 +218,7 @@ should be formatted. It is implemented as a set of related commands that interface with Donald E. Knuth&textrsquo;s &tex; typesetting program (the technical term is that &latex; is a <dfn>macro package</dfn> for the &tex; engine). The user produces the output document by giving that -file to the &tex; engine. +input file to the &tex; engine. </para> <para>The term &latex; is also sometimes used to mean the language in which the document is marked up, that is, to mean the set of commands @@ -226,7 +234,7 @@ sensible, such as in plain text, write it as <samp>LaTeX</samp>. <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">Starting and ending</menunode><menudescription><pre xml:space="preserve">The standard beginning and end of a document. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Output files</menunode><menudescription><pre xml:space="preserve">Files produced. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">&tex; engines</menunode><menudescription><pre xml:space="preserve">Programs that implementation &latex;. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">&tex; engines</menunode><menudescription><pre xml:space="preserve">Programs that can compile &tex; and &latex;. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">&latex; command syntax</menunode><menudescription><pre xml:space="preserve">General syntax of &latex; commands. </pre></menudescription></menuentry></menu> @@ -235,12 +243,12 @@ sensible, such as in plain text, write it as <samp>LaTeX</samp>. <section spaces=" "><sectiontitle>Starting and ending</sectiontitle> <anchor name="Starting-_0026-ending">Starting & ending</anchor><!-- c old name --> -<cindex index="cp" spaces=" "><indexterm index="cp" number="14">starting & ending</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="15">ending & starting</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="14">starting and ending</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="15">ending and starting</indexterm></cindex> <cindex index="cp" spaces=" "><indexterm index="cp" number="16">hello, world</indexterm></cindex> -<para>&latex; files have a simple global structure, with a standard -starting and ending. Here is a &textldquo;hello, world&textrdquo; example: +<para>&latex; files have a simple global structure, with a standard beginning +and ending. Here is a &textldquo;hello, world&textrdquo; example: </para> <example endspaces=" "> <pre xml:space="preserve">\documentclass{article} @@ -262,9 +270,10 @@ array of others are widely available. <xref label="Document-classes"><xrefnoden This area is called the <dfn>preamble</dfn>. </para> <para>The <code>\begin{document} ... \end{document}</code> is a so-called +<cindex index="cp" spaces=" "><indexterm index="cp" number="19">environment</indexterm></cindex> <dfn>environment</dfn>; the <samp>document</samp> environment (and no others) is -required in all &latex; documents. &latex; provides many -environments itself, and many more are defined separately. +required in all &latex; documents (<pxref label="document"><xrefnodename>document</xrefnodename></pxref>). &latex; +provides many environments itself, and many more are defined separately. <xref label="Environments"><xrefnodename>Environments</xrefnodename></xref>. </para> <para>The following sections discuss how to produce PDF or other output from @@ -297,7 +306,7 @@ available (<url><urefurl>http://mirror.ctan.org/tex-archive/dviware</urefurl></u </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">.pdf</itemformat></item> </tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="13">.pdf <r>file</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="19">pdf&tex;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="20">pdf&tex;</indexterm></cindex> <findex index="fn" spaces=" "><indexterm index="fn" number="14">pdflatex <r>command</r></indexterm></findex> <para>If &latex; is invoked via the system command <command>pdflatex</command>, among other commands (<pxref label="TeX-engines"><xrefnodename>&tex; engines</xrefnodename></pxref>), then the main output is @@ -310,19 +319,19 @@ self-contained file, with all fonts and images included. </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">.log</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="20">transcript file</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="21">log file</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="21">transcript file</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="22">log file</indexterm></cindex> <findex index="fn" spaces=" "><indexterm index="fn" number="15">.log <r>file</r></indexterm></findex> <para>This transcript file contains summary information such as a list of loaded packages. It also includes diagnostic messages and perhaps additional information for any errors. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">.aux</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="22">auxiliary file</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="23">auxiliary file</indexterm></cindex> <findex index="fn" spaces=" "><indexterm index="fn" number="16">.aux <r>file</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="23">cross references, resolving</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="24">forward references, resolving</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="25">references, resolving forward</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="24">cross references, resolving</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="25">forward references, resolving</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="26">references, resolving forward</indexterm></cindex> <para>Auxiliary information is used by &latex; for things such as cross references. For example, the first time that &latex; finds a forward reference&textmdash;a cross reference to something that has not yet @@ -337,12 +346,12 @@ location. </tableitem></tableentry></table> <findex index="fn" spaces=" "><indexterm index="fn" number="17">.lof <r>file</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="26">list of figures file</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="27">list of figures file</indexterm></cindex> <findex index="fn" spaces=" "><indexterm index="fn" number="18">.lot <r>file</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="27">list of tables file</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="28">list of tables file</indexterm></cindex> <findex index="fn" spaces=" "><indexterm index="fn" number="19">.toc <r>file</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="28">table of contents file</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="29">contents file</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="29">table of contents file</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="30">contents file</indexterm></cindex> <para>&latex; may produce yet more files, characterized by the filename ending. These include a <code>.lof</code> file that is used to make a list of figures, a <code>.lot</code> file used to make a list of tables, and a @@ -354,12 +363,12 @@ may create others; the list is open-ended. <node name="TeX-engines" spaces=" "><nodename>&tex; engines</nodename><nodenext automatic="on">&latex; command syntax</nodenext><nodeprev automatic="on">Output files</nodeprev><nodeup automatic="on">Overview</nodeup></node> <section spaces=" "><sectiontitle>&tex; engines</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="30">engines, &tex;</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="31">implementations of &tex;</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="32">UTF-8</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="33">Unicode input, native</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="34">TrueType fonts</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="35">OpenType fonts</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="31">engines, &tex;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="32">implementations of &tex;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="33">UTF-8</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="34">Unicode input, native</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="35">TrueType fonts</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="36">OpenType fonts</indexterm></cindex> <para>&latex; is defined to be a set of commands that are run by a &tex; implementation (<pxref label="Overview"><xrefnodename>Overview</xrefnodename></pxref>). This section gives a terse @@ -368,10 +377,10 @@ overview of the main programs. <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">latex</itemformat></item> <itemx spaces=" "><itemformat command="code">pdflatex</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="36">pdf&tex; engine</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="37">pdf&tex; engine</indexterm></cindex> <findex index="fn" spaces=" "><indexterm index="fn" number="20">etex <r>command</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="37">e-&tex;</indexterm></cindex> -<para>In &tex; Live (<url><urefurl>http://tug.org/texlive</urefurl></url>, if &latex; is invoked +<cindex index="cp" spaces=" "><indexterm index="cp" number="38">e-&tex;</indexterm></cindex> +<para>In &tex; Live (<url><urefurl>http://tug.org/texlive</urefurl></url>), if &latex; is invoked via either the system command <command>latex</command> or <command>pdflatex</command>, then the pdf&tex; engine is run (<url><urefurl>http://ctan.org/pkg/pdftex</urefurl></url>). When invoked as <command>latex</command>, the main output is a <file>.dvi</file> @@ -380,9 +389,9 @@ file; as <command>pdflatex</command>, the main output is a <file>.pdf</file> fil <para>pdf&tex; incorporates the e-&tex; extensions to Knuth&textrsquo;s original program (<url><urefurl>http://ctan.org/pkg/etex</urefurl></url>), including additional programming features and bi-directional typesetting, and has plenty of -extensions of its own. e-&tex; is available on its own as the +extensions of its own. e-&tex; is available on its own as the system command <command>etex</command>, but this is plain &tex; (and produces -<file>.dvi</file>). +<file>.dvi</file>). </para> <para>In other &tex; distributions, <command>latex</command> may invoke e-&tex; rather than pdf&tex;. In any case, the e-&tex; extensions can be @@ -390,7 +399,7 @@ assumed to be available in &latex;. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">lualatex</itemformat></item> </tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="21">lualatex <r>command</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="38">Lua&tex;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="39">Lua&tex;</indexterm></cindex> <para>If &latex; is invoked via the system command <command>lualatex</command>, the Lua&tex; engine is run (<url><urefurl>http://ctan.org/pkg/luatex</urefurl></url>). This program allows code written in the scripting language Lua @@ -402,13 +411,20 @@ but this is rarely used. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">xelatex</itemformat></item> </tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="22">xelatex <r>command</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="39">Xe&tex;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="40">Xe&tex;</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="23">.xdv <r>file</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="24">xdvipdfmx</indexterm></findex> <para>If &latex; is invoked with the system command <command>xelatex</command>, the Xe&tex; engine is run (<url><urefurl>http://tug.org/xetex</urefurl></url>). Like Lua&tex;, -Xe&tex; also natively supports UTF-8 Unicode and TrueType and -OpenType fonts, though the implementation is completely different, -mainly using external libraries instead of internal code. Xe&tex; -produces a <file>.pdf</file> file as output; it does not support DVI output. +Xe&tex; natively supports UTF-8 Unicode and TrueType and OpenType +fonts, though the implementation is completely different, mainly using +external libraries instead of internal code. Xe&tex; produces a +<file>.pdf</file> file as output; it does not support DVI output. +</para> +<para>Internally, Xe&tex; creates an <code>.xdv</code> file, a variant of DVI, +and translates that to PDF using the (<code>x</code>)<code>dvipdfmx</code> +program, but this process is automatic. The <code>.xdv</code> file is only +useful for debugging. </para> </tableitem></tableentry></table> @@ -421,41 +437,100 @@ additional support for Japanese and other languages ([u]p&tex;, <node name="LaTeX-command-syntax" spaces=" "><nodename>&latex; command syntax</nodename><nodeprev automatic="on">&tex; engines</nodeprev><nodeup automatic="on">Overview</nodeup></node> <section spaces=" "><sectiontitle>&latex; command syntax</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="40">command syntax</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="23">\ <r>character starting commands</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="24">[...] <r>for optional arguments</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="25">{...} <r>for required arguments</r></indexterm></findex> -<para>In the &latex; input file, a command name starts with a <code>\</code>; the -name itself then consists of either (a) a string of letters or -(b) a single non-letter. -</para> -<para>A command may be followed by zero, one, or more arguments, either -required or optional. Required arguments are contained in curly -braces, <code>{...}</code>. Optional arguments are contained in square -brackets, <code>[...]</code>. Generally, but not universally, if the -command accepts an optional argument, it comes first, before any -required arguments. -</para> -<para>Some commands have a <code>*</code> form that is related to the form without -a <code>*</code>, such as <code>\chapter</code> and <code>\chapter*</code>. -</para> -<para>&latex; commands are case sensitive; neither <code>\Begin{document}</code> -nor <code>\begin{Document}</code> will work. Most commands are lowercase, -but in any event you must enter all commands in the same case as they -are defined. +<cindex index="cp" spaces=" "><indexterm index="cp" number="41">command syntax</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="25">\ <r>character starting commands</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="26">[...] <r>for optional arguments</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="27">{...} <r>for required arguments</r></indexterm></findex> +<para>In the &latex; input file, a command name starts with a backslash +character, <code>\</code>. The name itself then consists of either +(a) a string of letters or (b) a single non-letter. +</para> +<para>&latex; commands names are case sensitive so that <code>\pagebreak</code> +differs from <code>\Pagebreak</code> (the latter is not a standard command). +Most commands are lowercase, but in any event you must enter all +commands in the same case as they are defined. +</para> +<para>A command may be followed by zero, one, or more arguments. These +arguments may be either required or optional. Required arguments are +contained in curly braces, <code>{...}</code>. Optional arguments are +contained in square brackets, <code>[...]</code>. Generally, but not +universally, if the command accepts an optional argument, it comes +first, before any required arguments. +</para> +<para>Inside of an optional argument, to use the character close square +bracket (<code>]</code>) hide it inside curly braces, as +in <code>\item[closing bracket {]}]</code>. Similarly, if an optional +argument comes last, with no required argument after it, then to make +the first character of the following text be an open square bracket, +hide it inside curly braces. +</para> +<para>&latex; has the convention that some commands have a <code>*</code> form that +is related to the form without a <code>*</code>, such as <code>\chapter</code> and +<code>\chapter*</code>. The exact difference in behavior varies from command +to command. </para> <para>This manual describes all accepted options and <code>*</code>-forms for the commands it covers (barring unintentional omissions, a.k.a.&noeos; bugs). </para> +<menu endspaces=" "> +<menuentry leadingtext="* "><menunode separator=":: ">Environment</menunode><menudescription><pre xml:space="preserve">Area of the source with distinct behavior. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Declaration</menunode><menudescription><pre xml:space="preserve">Change the value or meaning of a command. +</pre></menudescription></menuentry></menu> + + +<node name="Environment" spaces=" "><nodename>Environment</nodename><nodenext automatic="on">Declaration</nodenext><nodeup automatic="on">&latex; command syntax</nodeup></node> + +<para>Synopsis: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{<var>environment name</var>} + .. +\end{<var>environment name</var>} +</pre></example> + +<para>An area of &latex; source, inside of which there is a distinct +behavior. For instance, for poetry in &latex; put the lines between +<code>\begin{verse}</code> and <code>\end{verse}</code>. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{verse} + There once was a man from Nantucket \\ + .. +\end{verse} +</pre></example> + +<para>The <var>environment name</var> at the beginning must exactly match that at +the end. This includes the case where <var>environment name</var> ends in a +star (<code>*</code>); both the <code>\begin</code> and <code>\end</code> texts must +include the star. +</para> +<para>Environments may have arguments, including optional arguments. This +example produces a table. The first argument is optional (and causes +the table to be aligned on its top row) while the second argument is +required (it specifies the formatting of columns). +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}[t]{r|l} + .. rows of table .. +\end{tabular} +</pre></example> + + +<node name="Declaration" spaces=" "><nodename>Declaration</nodename><nodeprev automatic="on">Environment</nodeprev><nodeup automatic="on">&latex; command syntax</nodeup></node> + +<para>A command that changes the value, or changes the meaning, of some other +command or parameter. For instance, the <code>\mainmatter</code> command +changes the setting of page numbers from roman numerals to arabic. +</para> </section> </chapter> <node name="Document-classes" spaces=" "><nodename>Document classes</nodename><nodenext automatic="on">Fonts</nodenext><nodeprev automatic="on">Overview</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Document classes</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="41">document classes</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="42">classes of documents</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="26">\documentclass</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="42">document classes</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="43">classes of documents</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="28">\documentclass</indexterm></findex> <para>The document&textrsquo;s overall class is defined with this command, which is normally the first command in a &latex; source file. @@ -464,11 +539,11 @@ normally the first command in a &latex; source file. <pre xml:space="preserve">\documentclass[<var>options</var>]{<var>class</var>} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="27">article <r>class</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="28">report <r>class</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="29">book <r>class</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="30">letter <r>class</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="31">slides <r>class</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="29">article <r>class</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="30">report <r>class</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="31">book <r>class</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="32">letter <r>class</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="33">slides <r>class</r></indexterm></findex> <para>The following document <var>class</var> names are built into &latex;. (Many other document classes are available as separate packages; <pxref label="Overview"><xrefnodename>Overview</xrefnodename></pxref>.) @@ -482,6 +557,10 @@ normally the first command in a &latex; source file. matter, such as a preface, and back matter, such as an appendix (<pxref label="Front_002fback-matter"><xrefnodename>Front/back matter</xrefnodename></pxref>). </para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">letter</itemformat></item> +</tableterm><tableitem><para>Mail, optionally including mailing labels +(<pxref label="Letters"><xrefnodename>Letters</xrefnodename></pxref>). +</para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">report</itemformat></item> </tableterm><tableitem><para>For documents of length between an <code>article</code> and a <code>book</code>, such as technical reports or theses, which may contain several chapters. @@ -503,10 +582,10 @@ template</xrefnodename></pxref>). <node name="Document-class-options" spaces=" "><nodename>Document class options</nodename><nodeup automatic="on">Document classes</nodeup></node> <section spaces=" "><sectiontitle>Document class options</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="43">document class options</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="44">options, document class</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="45">class options</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="46">global options</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="44">document class options</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="45">options, document class</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="46">class options</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="47">global options</indexterm></cindex> <para>You can specify so-called <dfn>global options</dfn> or <dfn>class options</dfn> to the <code>\documentclass</code> command by enclosing them in square brackets. @@ -518,9 +597,9 @@ To specify more than one <var>option</var>, separate them with a comma, as in: <para>Here is the list of the standard class options. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="32">10pt <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="33">11pt <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="34">12pt <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="34">10pt <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="35">11pt <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="36">12pt <r>option</r></indexterm></findex> <para>All of the standard classes except <code>slides</code> accept the following options for selecting the typeface size (default is <code>10pt</code>): </para> @@ -528,71 +607,95 @@ options for selecting the typeface size (default is <code>10pt</code>): <pre xml:space="preserve">10pt 11pt 12pt </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="35">a4paper <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="36">a5paper <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="37">b5paper <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="38">executivepaper <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="39">legalpaper <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="40">letterpaper <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="37">a4paper <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="38">a5paper <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="39">b5paper <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="40">executivepaper <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="41">legalpaper <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="42">letterpaper <r>option</r></indexterm></findex> <para>All of the standard classes accept these options for selecting the paper -size (default is <code>letterpaper</code>): -</para> -<example endspaces=" "> -<pre xml:space="preserve">a4paper a5paper b5paper executivepaper legalpaper letterpaper -</pre></example> +size (these show height by width): +</para> +<table commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code">a4paper </itemformat></item> +</tableterm><tableitem><para>210 by 297 mm (about 8.25 by 11.75 inches) +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">b5paper</itemformat></item> +</tableterm><tableitem><para>176 by 250 mm (about 7 by 9.875 inches) +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">executivepaper</itemformat></item> +</tableterm><tableitem><para>7.25 by 10.5 inches +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">legalpaper</itemformat></item> +</tableterm><tableitem><para>8.5 by 14 inches +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">letterpaper</itemformat></item> +</tableterm><tableitem><para>8.5 by 11 inches (the default) +</para></tableitem></tableentry></table> -<findex index="fn" spaces=" "><indexterm index="fn" number="41">draft <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="42">final <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="43">fleqn <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="44">landscape <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="45">leqno <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="46">openbib <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="47">titlepage <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="48">notitlepage <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="43">\pdfpagewidth</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="44">\pdfpageheight</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="48"><code>geometry</code> package</indexterm></cindex> +<para>When using one of the engines pdf&latex;, Lua&latex;, or Xe&latex; +(<pxref label="TeX-engines"><xrefnodename>&tex; engines</xrefnodename></pxref>), options other than <code>letterpaper</code> set +the print area but you must also set the physical paper size. One way +to do that is to put <code>\pdfpagewidth=\paperwidth</code> and +<code>\pdfpageheight=\paperheight</code> in your document&textrsquo;s preamble. The +<code>geometry</code> package provides flexible ways of setting the print +area and physical page size. +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="45">draft <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="46">final <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="47">fleqn <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="48">landscape <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="49">leqno <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="50">openbib <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="51">titlepage <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="52">notitlepage <r>option</r></indexterm></findex> <para>Miscellaneous other options: </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">draft</itemformat></item> <itemx spaces=" "><itemformat command="code">final</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="47">black boxes, omitting</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="49">black boxes, omitting</indexterm></cindex> <para>Mark (<code>draft</code>) or do not mark (<code>final</code>) overfull boxes with a black box in the margin; default is <code>final</code>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">fleqn</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="48">flush left equations</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="49">centered equations</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="50">equations, flush left vs.&noeos; centered</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="50">flush left equations</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="51">centered equations</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="52">equations, flush left vs.&noeos; centered</indexterm></cindex> <para>Put displayed formulas flush left; default is centered. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">landscape</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="51">landscape orientation</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="52">portrait orientation</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="53">landscape orientation</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="54">portrait orientation</indexterm></cindex> <para>Selects landscape format; default is portrait. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">leqno</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="53">left-hand equation numbers</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="54">right-hand equation numbers</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="55">equation numbers, left vs.&noeos; right</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="55">left-hand equation numbers</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="56">right-hand equation numbers</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="57">equation numbers, left vs.&noeos; right</indexterm></cindex> <para>Put equation numbers on the left side of equations; default is the right side. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">openbib</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="56">bibliography format, open</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="58">bibliography format, open</indexterm></cindex> <para>Use &textldquo;open&textrdquo; bibliography format. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">titlepage</itemformat></item> <itemx spaces=" "><itemformat command="code">notitlepage</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="57">title page, separate or run-in</indexterm></cindex> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="59">title page, separate or run-in</indexterm></cindex> <para>Specifies whether the title page is separate; default depends on the class. </para></tableitem></tableentry></table> <para>The following options are not available with the <code>slides</code> class. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="49">onecolumn <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="50">twocolumn <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="51">oneside <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="52">twoside <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="53">openright <r>option</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="54">openany <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="53">onecolumn <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="54">twocolumn <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="55">oneside <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="56">twoside <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="57">openright <r>option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="58">openany <r>option</r></indexterm></findex> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">onecolumn</itemformat></item> <itemx spaces=" "><itemformat command="code">twocolumn</itemformat></itemx> @@ -600,8 +703,8 @@ black box in the margin; default is <code>final</code>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">oneside</itemformat></item> <itemx spaces=" "><itemformat command="code">twoside</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="55">\evensidemargin</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="56">\oddsidemargin</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="59">\evensidemargin</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="60">\oddsidemargin</indexterm></findex> <para>Selects one- or two-sided layout; default is <code>oneside</code>, except that in the <code>book</code> class the default is <code>twoside</code>. </para> @@ -618,14 +721,14 @@ being 40% of the difference between <code>\paperwidth</code> and <code>openright</code> for <code>book</code>, and <code>openany</code> for <code>report</code>. </para></tableitem></tableentry></table> -<findex index="fn" spaces=" "><indexterm index="fn" number="57">clock <r>option to <code>slides</code> class</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="61">clock <r>option to <code>slides</code> class</r></indexterm></findex> <para>The <code>slides</code> class offers the option <code>clock</code> for printing the time at the bottom of each note. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="58">loading additional packages</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="59">packages, loading additional</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="60">additional packages, loading</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="58">\usepackage</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="60">loading additional packages</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="61">packages, loading additional</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="62">additional packages, loading</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="62">\usepackage</indexterm></findex> <para>Additional packages are loaded like this: </para> <example endspaces=" "> @@ -636,8 +739,8 @@ the time at the bottom of each note. as in <code>\usepackage{<var>pkg1</var>,<var>pkg2</var>,...}</code>, or use multiple <code>\usepackage</code> commands. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="61">global options</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="62">options, global</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="63">global options</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="64">options, global</indexterm></cindex> <para>Any options given in the <code>\documentclass</code> command that are unknown by the selected document class are passed on to the packages loaded with <code>\usepackage</code>. @@ -649,8 +752,8 @@ by the selected document class are passed on to the packages loaded with <chapter spaces=" "><sectiontitle>Fonts</sectiontitle> <anchor name="Typefaces">Typefaces</anchor><!-- c old name --> -<cindex index="cp" spaces=" "><indexterm index="cp" number="63">typefaces</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="64">fonts</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="65">typefaces</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="66">fonts</indexterm></cindex> <para>Two important aspects of selecting a <dfn>font</dfn> are specifying a size and a style. The &latex; commands for doing this are described here. @@ -665,17 +768,18 @@ and a style. The &latex; commands for doing this are described here. <node name="Font-styles" spaces=" "><nodename>Font styles</nodename><nodenext automatic="on">Font sizes</nodenext><nodeup automatic="on">Fonts</nodeup></node> <section spaces=" "><sectiontitle>Font styles</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="65">font styles</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="66">typeface styles</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="67">styles of text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="67">font styles</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="68">type styles</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="69">styles of text</indexterm></cindex> <para>The following type style commands are supported by &latex;. </para> <para>This first group of commands is typically used with an argument, as in -<code>\textit{italic text}</code>. In the table below, the corresponding +<code>\textit{<var>text</var>}</code>. In the table below, the corresponding command in parenthesis is the &textldquo;declaration form&textrdquo;, which takes no -arguments. The scope of the declaration form lasts until the next type -style command or the end of the current group. +arguments, as in <code>{\itshape <var>text</var>}</code>. The scope of the +declaration form lasts until the next type style command or the end of +the current group. </para> <para>These commands, in both the argument form and the declaration form, are cumulative; e.g., you can say either <code>\sffamily\bfseries</code> or @@ -684,8 +788,8 @@ are cumulative; e.g., you can say either <code>\sffamily\bfseries</code> or <para>You can alternatively use an environment form of the declarations; for instance, <code>\begin{ttfamily}...\end{ttfamily}</code>. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="59">\nocorrlist</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="60">\nocorr</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="63">\nocorrlist</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="64">\nocorr</indexterm></findex> <para>These font-switching commands automatically insert italic corrections if needed. (<xref label="_005c_002f"><xrefnodename>\/</xrefnodename></xref>, for the details of italic corrections.) Specifically, they insert the italic correction unless the following @@ -697,74 +801,141 @@ command argument, such as <code>\textit{\nocorr text}</code> or </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">\textrm (\rmfamily)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="61">\textrm</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="62">\rmfamily</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="65">\textrm</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="66">\rmfamily</indexterm></findex> <para>Roman. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textit (\itshape)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="63">\textit</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="64">\itshape</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="67">\textit</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="68">\itshape</indexterm></findex> <para>Italics. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\emph</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="65">\emph</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="68">emphasis</indexterm></cindex> -<para>Emphasis (switches between <code>\textit</code> and <code>\textrm</code>). -</para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textmd (\mdseries)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="66">\textmd</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="67">\mdseries</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="69">\textmd</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="70">\mdseries</indexterm></findex> <para>Medium weight (default). </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textbf (\bfseries)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="68">\textbf</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="69">\bfseries</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="71">\textbf</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="72">\bfseries</indexterm></findex> <para>Boldface. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textup (\upshape)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="70">\textup</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="71">\upshape</indexterm></findex> -<para>Upright (default). The opposite of slanted. +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="73">\textup</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="74">\upshape</indexterm></findex> +<para>Upright (default). </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textsl (\slshape)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="72">\textsl</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="73">\slshape</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="75">\textsl</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="76">\slshape</indexterm></findex> <para>Slanted. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textsf (\sffamily)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="74">\textsf</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="75">\sffamily</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="77">\textsf</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="78">\sffamily</indexterm></findex> <para>Sans serif. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textsc (\scshape)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="76">\textsc</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="77">\scshape</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="79">\textsc</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="80">\scshape</indexterm></findex> <para>Small caps. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\texttt (\ttfamily)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="78">\texttt</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="79">\ttfamily</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="81">\texttt</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="82">\ttfamily</indexterm></findex> <para>Typewriter. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\textnormal (\normalfont)</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="80">\textnormal</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="81">\normalfont</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="83">\textnormal</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="84">\normalfont</indexterm></findex> <para>Main document font. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\mathrm</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="82">\mathrm</indexterm></findex> +</tableitem></tableentry></table> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="70">emphasis</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="85">\emph</indexterm></findex> +<para>Although it also changes fonts, the <code>\emph{<var>text</var>}</code> command +is semantic, for text to be emphasized, and should not be used as a +substitute for <code>\textit</code>. For example, <code>\emph{<var>start +text</var> \emph{<var>middle text</var>} <var>end text</var>}</code> will result in the +<var>start text</var> and <var>end text</var> in italics, but <var>middle text</var> +will be in roman. +</para> +<para>&latex; also provides the following commands, which unconditionally +switch to the given style, that is, are <emph>not</emph> cumulative. Also, +they are used differently than the above commands: +<code>{\<var>cmd</var>...}</code> instead of <code>\<var>cmd</var>{...}</code>. These +are two unrelated constructs. +</para> +<ftable commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="86">\bf</indexterm>\bf</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="71">bold font</indexterm></cindex> +<para>Switch to bold face. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="87">\cal</indexterm>\cal</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="72">script letters for math</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="73">calligraphic letters for math</indexterm></cindex> +<para>Switch to calligraphic letters for math. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="88">\it</indexterm>\it</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="74">italic font</indexterm></cindex> +<para>Italics. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="89">\rm</indexterm>\rm</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="75">roman font</indexterm></cindex> +<para>Roman. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="90">\sc</indexterm>\sc</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="76">small caps font</indexterm></cindex> +<para>Small caps. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="91">\sf</indexterm>\sf</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="77">sans serif font</indexterm></cindex> +<para>Sans serif. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="92">\sl</indexterm>\sl</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="78">slanted font</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="79">oblique font</indexterm></cindex> +<para>Slanted (oblique). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="93">\tt</indexterm>\tt</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="80">typewriter font</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="81">monospace font</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="82">fixed-width font</indexterm></cindex> +<para>Typewriter (monospace, fixed-width). +</para> +</tableitem></tableentry></ftable> + +<para>The <code>\em</code> command is the unconditional version of <code>\emph</code>. +</para> +<para>(Some people consider the unconditional font-switching commands, such +as <code>\tt</code>, obsolete and that only the cumulative commands +(<code>\texttt</code>) should be used. Others think that both sets of +commands have their place and sometimes an unconditional font switch +is precisely what you want; for one example, +<pxref label="description"><xrefnodename>description</xrefnodename><xrefprinteddesc><code>description</code></xrefprinteddesc></pxref>.) +</para> +<para>The following commands are for use in math mode. They are not +cumulative, so <code>\mathbf{\mathit{<var>symbol</var>}}</code> does not +create a boldface and italic <var>symbol</var>; instead, it will just be in +italics. This is because typically math symbols need consistent +typographic treatment, regardless of the surrounding environment. +</para> +<table commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code">\mathrm</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="94">\mathrm</indexterm></findex> <para>Roman, for use in math mode. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\mathbf</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="83">\mathbf</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="95">\mathbf</indexterm></findex> <para>Boldface, for use in math mode. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\mathsf</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="84">\mathsf</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="96">\mathsf</indexterm></findex> <para>Sans serif, for use in math mode. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\mathtt</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="85">\mathtt</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="97">\mathtt</indexterm></findex> <para>Typewriter, for use in math mode. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\mathit</itemformat></item> @@ -772,101 +943,46 @@ command argument, such as <code>\textit{\nocorr text}</code> or </tableterm><tableitem><para>Italics, for use in math mode. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\mathnormal</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="86">\mathnormal</indexterm></findex> -<para>For use in math mode, e.g. inside another type style declaration. +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="98">\mathnormal</indexterm></findex> +<para>For use in math mode, e.g., inside another type style declaration. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\mathcal</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="87">\mathcal</indexterm></findex> -<para>&textlsquo;Calligraphic&textrsquo; letters, for use in math mode. +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="99">\mathcal</indexterm></findex> +<para>Calligraphic letters, for use in math mode. </para> </tableitem></tableentry></table> -<findex index="fn" spaces=" "><indexterm index="fn" number="88">\mathversion</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="69">math, bold</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="70">bold math</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="100">\mathversion</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="83">math, bold</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="84">bold math</indexterm></cindex> <para>In addition, the command <code>\mathversion{bold}</code> can be used for switching to bold letters and symbols in formulas. <code>\mathversion{normal}</code> restores the default. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="89">\oldstylenums</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="71">numerals, old-style</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="72">old-style numerals</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="73">lining numerals</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="74"><code>textcomp</code> package</indexterm></cindex> -<para>Finally, the command <code>\oldstylenums{<var>numerals</var>}</code> will -typeset so-called &textldquo;old-style&textrdquo; numerals, which have differing heights -and depths (and sometimes widths) from the standard &textldquo;lining&textrdquo; -numerals. &latex;&textrsquo;s default fonts support this, and will respect -<code>\textbf</code> (but not other styles; there are no italic old-style -numerals in Computer Modern). Many other fonts have old-style -numerals also; sometimes the <code>textcomp</code> package must be loaded, -and sometimes package options are provided to make them the default. -FAQ entry: <url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</urefurl></url>. -</para> -<para>&latex; also provides the following commands, which unconditionally -switch to the given style, that is, are <emph>not</emph> cumulative. Also, -they are used differently than the above commands: <code>{\<var>cmd</var> -...}</code> instead of <code>\<var>cmd</var>{...}</code>. These are two unrelated -constructs. -</para> -<ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="90">\bf</indexterm>\bf</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="75">bold font</indexterm></cindex> -<para>Switch to <b>bold face</b>. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="91">\cal</indexterm>\cal</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="76">script letters for math</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="77">calligraphic letters for math</indexterm></cindex> -<para>Switch to calligraphic letters for math. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="92">\em</indexterm>\em</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="78">emphasis</indexterm></cindex> -<para>Emphasis (italics within roman, roman within italics). -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="93">\it</indexterm>\it</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="79">italic font</indexterm></cindex> -<para>Italics. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="94">\rm</indexterm>\rm</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="80">roman font</indexterm></cindex> -<para>Roman. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="95">\sc</indexterm>\sc</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="81">small caps font</indexterm></cindex> -<para>Small caps. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="96">\sf</indexterm>\sf</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="82">sans serif font</indexterm></cindex> -<para>Sans serif. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="97">\sl</indexterm>\sl</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="83">slanted font</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="84">oblique font</indexterm></cindex> -<para>Slanted (oblique). -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="98">\tt</indexterm>\tt</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="85">typewriter font</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="86">monospace font</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="87">fixed-width font</indexterm></cindex> -<para>Typewriter (monospace, fixed-width). -</para> -</tableitem></tableentry></ftable> - -<para>Some people consider the unconditional font-switching commands, such -as <code>\tt</code>, obsolete and <emph>only</emph> the cumulative commands -(<code>\texttt</code>) should be used. I (Karl) do not agree. There are -perfectly reasonable situations when an unconditional font switch is -precisely what you need to get the desired output; for one example, -<pxref label="description"><xrefnodename>description</xrefnodename><xrefprinteddesc><code>description</code></xrefprinteddesc></pxref>. Both sets of commands have -their place. +<findex index="fn" spaces=" "><indexterm index="fn" number="101">\oldstylenums</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="85">numerals, old-style</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="86">old-style numerals</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="87">lining numerals</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="88"><code>textcomp</code> package</indexterm></cindex> +<para>Finally, the command <code>\oldstylenums{<var>numerals</var>}</code> will typeset +so-called &textldquo;old-style&textrdquo; numerals, which have differing heights and +depths (and sometimes widths) from the standard &textldquo;lining&textrdquo; numerals, +which all have the same height as upper-case letters. &latex;&textrsquo;s +default fonts support this, and will respect <code>\textbf</code> (but not +other styles; there are no italic old-style numerals in Computer +Modern). Many other fonts have old-style numerals also; sometimes the +<code>textcomp</code> package must be loaded, and sometimes package options +are provided to make them the default. FAQ entry: +<url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf</urefurl></url>. </para> </section> <node name="Font-sizes" spaces=" "><nodename>Font sizes</nodename><nodenext automatic="on">Low-level font commands</nodenext><nodeprev automatic="on">Font styles</nodeprev><nodeup automatic="on">Fonts</nodeup></node> <section spaces=" "><sectiontitle>Font sizes</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="88">font sizes</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="89">typeface sizes</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="90">sizes of text</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="89">font sizes</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="90">typeface sizes</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="91">sizes of text</indexterm></cindex> <para>The following standard type size commands are supported by &latex;. The table shows the command name and the corresponding actual font @@ -874,16 +990,16 @@ size used (in points) with the <samp>10pt</samp>, <samp>11pt</samp>, and <samp>12pt</samp> document size options, respectively (<pxref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></pxref>). </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="99">\tiny</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="100">\scriptsize</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="101">\footnotesize</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="102">\small</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="103">\normalsize</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="104">\large</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="105">\Large</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="106">\LARGE</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="107">\huge</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="108">\Huge</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="102">\tiny</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="103">\scriptsize</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="104">\footnotesize</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="105">\small</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="106">\normalsize</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="107">\large</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="108">\Large</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="109">\LARGE</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="110">\huge</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="111">\Huge</indexterm></findex> <multitable spaces=" " endspaces=" "><columnprototypes><columnprototype bracketed="on"><code>\normalsize</code> (default)</columnprototype> <columnprototype bracketed="on">24.88</columnprototype> <columnprototype bracketed="on">24.88</columnprototype> <columnprototype bracketed="on">24.88</columnprototype></columnprototypes> <thead><row><entry command="headitem" spaces=" "><para>Command </para></entry><entry command="tab" spaces=" "><para><code>10pt</code> </para></entry><entry command="tab" spaces=" "><para><code>11pt</code> </para></entry><entry command="tab" spaces=" "><para><code>12pt</code> @@ -918,96 +1034,184 @@ these commands; for instance, <code>\begin{tiny}...\end{tin </section> <node name="Low_002dlevel-font-commands" spaces=" "><nodename>Low-level font commands</nodename><nodeprev automatic="on">Font sizes</nodeprev><nodeup automatic="on">Fonts</nodeup></node> <section spaces=" "><sectiontitle>Low-level font commands</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="91">low-level font commands</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="92">font commands, low-level</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="92">low-level font commands</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="93">font commands, low-level</indexterm></cindex> <para>These commands are primarily intended for writers of macros and packages. The commands listed here are only a subset of the available ones. +<!-- c xx but it should be complete --> +<!-- c xx something about ultimately reading ENCFAM.fd? --> </para> <table commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code">\fontencoding{enc}</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="109">\fontencoding</indexterm></findex> -<para>Select font encoding. Valid encodings include <code>OT1</code> and <code>T1</code>. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontfamily{family}</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="110">\fontfamily</indexterm></findex> -<para>Select font family. Valid families include: -</para> -<itemize commandarg="bullet" spaces=" " endspaces=" "><itemprepend><formattingcommand command="bullet"/></itemprepend> -<listitem spaces=" "><prepend>•</prepend><para><code>cmr</code> for Computer Modern Roman -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>cmss</code> for Computer Modern Sans Serif -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>cmtt</code> for Computer Modern Typewriter +<tableentry><tableterm><item spaces=" "><itemformat command="code">\fontencoding{<var>encoding</var>}</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="112">\fontencoding</indexterm></findex> +<para>Select the font encoding, the encoding of the output font. There are a +large number of valid encodings. The most common are <code>OT1</code>, +Knuth&textrsquo;s original encoding for Computer Modern (the default), and +<code>T1</code>, also known as the Cork encoding, which has support for the +accented characters used by the most widespread European languages +(German, French, Italian, Polish and others), which allows &tex; to +hyphenate words containing accented letters. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontfamily{<var>family</var>}</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="113">\fontfamily</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="94">families, of fonts</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="95">font catalogue</indexterm></cindex> +<para>Select the font family. The web page +<url><urefurl>http://www.tug.dk/FontCatalogue/</urefurl></url> provides one way to browse +through many of the fonts easily used with &latex;. Here are +examples of some common families: +</para> +<!-- c Sorry about the ugly @t{@ }. The idea is to make the lists line up --> +<!-- c in Info. Since the items are so short, it seems nice to have them --> +<!-- c on the same line instead of using @table. --> + +<itemize commandarg="w" spaces=" " endspaces=" "><itemprepend><w></w></itemprepend> +<listitem spaces=" "><prepend><w></w></prepend><para><code>pag</code><t><spacecmd type="spc"/></t> Avant Garde +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>fvs</code><t><spacecmd type="spc"/></t> Bitstream Vera Sans +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>pbk</code><t><spacecmd type="spc"/></t> Bookman +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>bch</code><t><spacecmd type="spc"/></t> Charter +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ccr</code><t><spacecmd type="spc"/></t> Computer Concrete +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>cmr</code><t><spacecmd type="spc"/></t> Computer Modern +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>pcr</code><t><spacecmd type="spc"/></t> Courier +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>phv</code><t><spacecmd type="spc"/></t> Helvetica +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>fi4</code><t><spacecmd type="spc"/></t> Inconsolata +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>lmr</code><t><spacecmd type="spc"/></t> Latin Modern +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>lmss</code> Latin Modern Sans +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>lmtt</code> Latin Modern Typewriter +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>pnc</code><t><spacecmd type="spc"/></t> New Century Schoolbook +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ppl</code><t><spacecmd type="spc"/></t> Palatino +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ptm</code><t><spacecmd type="spc"/></t> Times +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>uncl</code> Uncial +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>put</code><t><spacecmd type="spc"/></t> Utopia +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>pzc</code><t><spacecmd type="spc"/></t> Zapf Chancery </para></listitem></itemize> -<para>and numerous others. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontseries{series}</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="111">\fontseries</indexterm></findex> -<para>Select font series. Valid series include: -</para> -<itemize commandarg="bullet" spaces=" " endspaces=" "><itemprepend><formattingcommand command="bullet"/></itemprepend> -<listitem spaces=" "><prepend>•</prepend><para><code>m</code> Medium (normal) -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>b</code> Bold -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>c</code> Condensed -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>bc</code> Bold condensed -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>bx</code> Bold extended +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontseries{<var>series</var>}</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="114">\fontseries</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="96">series, of fonts</indexterm></cindex> +<para>Select the font series. A <dfn>series</dfn> combines a <dfn>weight</dfn> and a +<dfn>width</dfn>. Typically, a font supports only a few of the possible +combinations. Some common combined series values include: +</para> +<itemize commandarg="w" spaces=" " endspaces=" "><itemprepend><w></w></itemprepend> +<listitem spaces=" "><prepend><w></w></prepend><para><code>m</code><t><spacecmd type="spc"/></t> Medium (normal) +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>b</code><t><spacecmd type="spc"/></t> Bold +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>c</code><t><spacecmd type="spc"/></t> Condensed +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>bc</code> Bold condensed +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>bx</code> Bold extended </para></listitem></itemize> -<para>and various other combinations. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontshape{shape}</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="112">\fontshape</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="97">weights, of fonts</indexterm></cindex> +<para>The possible values for weight, individually, are: +</para> +<itemize commandarg="w" spaces=" " endspaces=" "><itemprepend><w></w></itemprepend> +<listitem spaces=" "><prepend><w></w></prepend><para><code>ul</code> Ultra light +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>el</code> Extra light +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>l</code><t><spacecmd type="spc"/></t> Light +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>sl</code> Semi light +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>m</code><t><spacecmd type="spc"/></t> Medium (normal) +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>sb</code> Semi bold +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>b</code><t><spacecmd type="spc"/></t> Bold +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>eb</code> Extra bold +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ub</code> Ultra bold +</para></listitem></itemize> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="98">widths, of fonts</indexterm></cindex> +<para>The possible values for width, individually, are (the percentages +are just guides and are not followed precisely by all fonts): +</para> +<itemize commandarg="w" spaces=" " endspaces=" "><itemprepend><w></w></itemprepend> +<listitem spaces=" "><prepend><w></w></prepend><para><code>uc</code> Ultra condensed, 50% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ec</code> Extra condensed, 62.5% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>c</code><t><spacecmd type="spc"/></t> Condensed, 75% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>sc</code> Semi condensed, 87.5% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>m</code><t><spacecmd type="spc"/></t> Medium, 100% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>sx</code> Semi expanded, 112.5% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>x</code><t><spacecmd type="spc"/></t> Expanded, 125% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ex</code> Extra expanded, 150% +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ux</code> Ultra expanded, 200% +</para></listitem></itemize> + +<para>When forming the <var>series</var> string from the weight and width, drop the +<code>m</code> that stands for medium weight or medium width, unless both +weight and width are <code>m</code>, in which case use just one +(<samp><code>m</code></samp>). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontshape{<var>shape</var>}</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="115">\fontshape</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="99">shapes, of fonts</indexterm></cindex> <para>Select font shape. Valid shapes are: </para> -<itemize commandarg="bullet" spaces=" " endspaces=" "><itemprepend><formattingcommand command="bullet"/></itemprepend> -<listitem spaces=" "><prepend>•</prepend><para><code>n</code> Upright (normal) -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>it</code> Italic -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>sl</code> Slanted (oblique) -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>sc</code> Small caps -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>ui</code> Upright italics -</para></listitem><listitem spaces=" "><prepend>•</prepend><para><code>ol</code> Outline +<itemize commandarg="w" spaces=" " endspaces=" "><itemprepend><w></w></itemprepend> +<listitem spaces=" "><prepend><w></w></prepend><para><code>n</code><t><spacecmd type="spc"/></t> Upright (normal) +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>it</code> Italic +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>sl</code> Slanted (oblique) +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>sc</code> Small caps +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ui</code> Upright italics +</para></listitem><listitem spaces=" "><prepend><w></w></prepend><para><code>ol</code> Outline </para></listitem></itemize> -<para>The two last shapes are not available for most font families. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontsize{size}{skip}</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="113">\fontsize</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="114">\baselineskip</indexterm></findex> -<para>Set font size. The first parameter is the font size to switch to and -the second is the line spacing to use; this is stored in a parameter -named <code>\baselineskip</code>. The unit of both parameters defaults to -pt. The default <code>\baselineskip</code> for the Computer Modern typeface -is 1.2 times the <code>\fontsize</code>. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="115">\baselinestretch</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="93"><code>setspace</code> package</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="94">double spacing</indexterm></cindex> -<para>The line spacing is also multiplied by the value of the -<code>\baselinestretch</code> parameter when the type size changes; the -default is 1. However, the best way to &textldquo;double space&textrdquo; a document, -if you should be unlucky enough to have to produce such, is to use the -<code>setspace</code> package; see -<url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</urefurl></url>. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="116">\linespread</indexterm></findex> +<para>The two last shapes are not available for most font families, and +small caps are often missing as well. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\fontsize{<var>size</var>}{<var>skip</var>}</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="116">\fontsize</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="100">font size</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="117">\baselineskip</indexterm></findex> +<para>Set the font size and the line spacing. The unit of both parameters +defaults to points (<code>pt</code>). The line spacing is the nominal +vertical space between lines, baseline to baseline. It is stored in the +parameter <code>\baselineskip</code>. The default <code>\baselineskip</code> for +the Computer Modern typeface is 1.2 times the <code>\fontsize</code>. +Changing <code>\baselineskip</code> directly is inadvisable since its value is +reset every time a size change happens; see <code>\baselinestretch</code>, next. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\baselinestretch</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="118">\baselinestretch</indexterm></findex> +<para>&latex; multiplies the line spacing by the value of the +<code>\baselinestretch</code> parameter; the default factor is 1. A change +takes effect when <code>\selectfont</code> (see below) is called. You can +make line skip changes happen for the entire document by doing +<code>\renewcommand{\baselinestretch}{2.0}</code> in the preamble. +</para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="101"><code>setspace</code> package</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="102">double spacing</indexterm></cindex> +<para>However, the best way to double-space a document is to use the +<file>setspace</file> package. In addition to offering a number of spacing +options, this package keeps the line spacing single-spaced in places +where that is typically desirable, such as footnotes and figure +captions. See the package documentation. +</para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\linespread{<var>factor</var>}</itemformat></item> -</tableterm><tableitem><para>Equivalent to +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="119">\linespread</indexterm></findex> +<para>Equivalent to <code>\renewcommand{\baselinestretch}{<var>factor</var>}</code>, and therefore must be followed by <code>\selectfont</code> to have any effect. Best specified in the preamble, or use the <code>setspace</code> package, as -described just above. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="117">\selectfont</indexterm></findex> -<para>The changes made by calling the font commands described above do -not come into effect until <code>\selectfont</code> is called. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\usefont{enc}{family}{series}{shape}</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="118">\usefont</indexterm></findex> +just described. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\selectfont</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="120">\selectfont</indexterm></findex> +<para>The effects of the font commands described above do not happen until +<code>\selectfont</code> is called, as in +<code>\fontfamily{<var>familyname</var>}\selectfont</code>. It is often useful +to put this in a macro:&linebreak; +<code>\newcommand*{\myfont}{\fontfamily{<var>familyname</var>}\selectfont}</code>&linebreak; +(<pxref label="_005cnewcommand-_0026-_005crenewcommand"><xrefnodename>\newcommand & \renewcommand</xrefnodename></pxref>). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\usefont{<var>enc</var>}{<var>family</var>}{<var>series</var>}{<var>shape</var>}</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="121">\usefont</indexterm></findex> <para>The same as invoking <code>\fontencoding</code>, <code>\fontfamily</code>, <code>\fontseries</code> and <code>\fontshape</code> with the given parameters, -followed by <code>\selectfont</code>. +followed by <code>\selectfont</code>. For example: </para> +<example endspaces=" "> +<pre xml:space="preserve">\usefont{ot1}{cmr}{m}{n} +</pre></example> + </tableitem></tableentry></table> @@ -1015,9 +1219,10 @@ followed by <code>\selectfont</code>. </chapter> <node name="Layout" spaces=" "><nodename>Layout</nodename><nodenext automatic="on">Sectioning</nodenext><nodeprev automatic="on">Fonts</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Layout</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="95">layout commands</indexterm></cindex> -<para>Miscellaneous commands for controlling the general layout of the page. +<cindex index="cp" spaces=" "><indexterm index="cp" number="103">layout commands</indexterm></cindex> + +<para>Commands for controlling the general page layout. </para> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\onecolumn</menunode><menudescription><pre xml:space="preserve">Use one-column layout. @@ -1025,151 +1230,326 @@ followed by <code>\selectfont</code>. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\flushbottom</menunode><menudescription><pre xml:space="preserve">Make all text pages the same height. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\raggedbottom</menunode><menudescription><pre xml:space="preserve">Allow text pages of differing height. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Page layout parameters</menunode><menudescription><pre xml:space="preserve"><code>\headheight</code> <code>\footskip</code>. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Floats</menunode><menudescription><pre xml:space="preserve">Figures, tables, etc. </pre></menudescription></menuentry></menu> <node name="_005conecolumn" spaces=" "><nodename>\onecolumn</nodename><nodenext automatic="on">\twocolumn</nodenext><nodeup automatic="on">Layout</nodeup></node> <section spaces=" "><sectiontitle><code>\onecolumn</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="119">\onecolumn</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="96">one-column output</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="122">\onecolumn</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="104">one-column output</indexterm></cindex> <para>The <code>\onecolumn</code> declaration starts a new page and produces -single-column output. This is the default. +single-column output. If the document is given the class option +<code>onecolumn</code> then this is the default behavior (<pxref label="Document-class-options"><xrefnodename>Document +class options</xrefnodename></pxref>). +</para> +<para>This command is fragile (<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). </para> </section> <node name="_005ctwocolumn" spaces=" "><nodename>\twocolumn</nodename><nodenext automatic="on">\flushbottom</nodenext><nodeprev automatic="on">\onecolumn</nodeprev><nodeup automatic="on">Layout</nodeup></node> <section spaces=" "><sectiontitle><code>\twocolumn</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="120">\twocolumn</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="97">multicolumn text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="98">two-column output</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="123">\twocolumn</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="105">multicolumn text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="106">two-column output</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\twocolumn[<var>text1col</var>] +<pre xml:space="preserve">\twocolumn[<var>prelim one column text</var>] </pre></example> <para>The <code>\twocolumn</code> declaration starts a new page and produces -two-column output. If the optional <var>text1col</var> argument is present, -it is typeset in one-column mode before the two-column typesetting -starts. +two-column output. If the document is given the class option +<code>twocolumn</code> then this is the default (<pxref label="Document-class-options"><xrefnodename>Document class +options</xrefnodename></pxref>). </para> -<para>These parameters control typesetting in two-column output: +<para>If the optional <var>prelim one column text</var> argument +is present, it is typeset in one-column mode before the two-column +typesetting starts. </para> -<ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="121">\columnsep</indexterm>\columnsep</itemformat></item> -</tableterm><tableitem><para>The distance between columns (35pt by default). +<para>This command is fragile (<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="122">\columnseprule</indexterm>\columnseprule</itemformat></item> -</tableterm><tableitem><para>The width of the rule between columns; the default is 0pt, so there is no rule. +<para>These parameters control typesetting in two-column output: </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="123">\columnwidth</indexterm>\columnwidth</itemformat></item> -</tableterm><tableitem><para>The width of the current column; this is equal to <code>\textwidth</code> in -single-column text. +<ftable commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="124">\columnsep</indexterm>\columnsep</itemformat></item> +</tableterm><tableitem><para>The distance between columns. The default is 35pt. Change it with a +command such as <code>\setlength{\columnsep}{40pt}</code> You must change +it before the two column environment starts; in the preamble is a good +place. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="125">\columnseprule</indexterm>\columnseprule</itemformat></item> +</tableterm><tableitem><para>The width of the rule between columns. The rule appears halfway between +the two columns. The default is 0pt, meaning that there is no rule. +Change it with a command such as +<code>\setlength{\columnseprule}{0.4pt}</code>, before the two-column +environment starts. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="126">\columnwidth</indexterm>\columnwidth</itemformat></item> +</tableterm><tableitem><para>The width of a single column. In one-column mode this is equal to +<code>\textwidth</code>. In two-column mode by default &latex; sets the +width of each of the two columns to be half of <code>\textwidth</code> minus +<code>\columnsep</code>. </para> </tableitem></tableentry></ftable> -<para>These parameters control float behavior in two-column output: +<para>In a two-column document, the starred environments <code>table*</code> and +<code>figure*</code> are two columns wide, whereas the unstarred environments +<code>table</code> and <code>figure</code> take up only one column (<pxref label="figure"><xrefnodename>figure</xrefnodename></pxref> +and <pxref label="table"><xrefnodename>table</xrefnodename></pxref>). &latex; places starred floats at the top of a page. +The following parameters control float behavior of two-column output. </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="124">\dbltopfraction</indexterm>\dbltopfraction</itemformat></item> -</tableterm><tableitem><para>Maximum fraction at the top of a two-column page that may be occupied -by floats. Default <samp>.7</samp>, can be usefully redefined to (say) -<samp>.9</samp> to avoid going to float pages so soon. +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="127">\dbltopfraction</indexterm>\dbltopfraction</itemformat></item> +</tableterm><tableitem><para>The maximum fraction at the top of a two-column page that may be +occupied by two-column wide floats. The default is 0.7, meaning that +the height of a <code>table*</code> or <code>figure*</code> environment must not +exceed <code>0.7\textheight</code> . If the height of your starred float +environment exceeeds this then you can take one of the following actions +to prevent it from floating all the way to the back of the document: </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="125">\dblfloatpagefraction</indexterm>\dblfloatpagefraction</itemformat></item> -</tableterm><tableitem><para>The minimum fraction of a float page that must be occupied by floats, -for a two-column float page. Default <samp>.5</samp>. +<itemize commandarg="bullet" spaces=" " endspaces=" "><itemprepend><formattingcommand command="bullet"/></itemprepend> +<listitem><prepend>•</prepend> +<para>Use the <code>[tp]</code> location specifier to tell LaTeX to try to put +the bulky float on a page by itself, as well as at the top of a page. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="126">\dblfloatsep</indexterm>\dblfloatsep</itemformat></item> -</tableterm><tableitem><para>Distance between floats at the top or bottom of a two-column float -page. Default <samp>12pt plus2pt minus2pt</samp> for <samp>10pt</samp> and -<samp>11pt</samp> documents, <samp>14pt plus2pt minus4pt</samp> for <samp>12pt</samp>. +</listitem><listitem><prepend>•</prepend> +<para>Use the <code>[t!]</code> location specifier to override the effect of +<code>\dbltopfraction</code> for this particular float. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="127">\dbltextfloatsep</indexterm>\dbltextfloatsep</itemformat></item> -</tableterm><tableitem><para>Distance between a multi-column float at the top or bottom of a page -and the main text. Default <samp>20pt plus2pt minus4pt</samp>. +</listitem><listitem><prepend>•</prepend> +<para>Increase the value of <code>\dbltopfraction</code> to a suitably large number, +to avoid going to float pages so soon. +</para></listitem></itemize> + +<para>You can redefine it, for instance with +<code>\renewcommand{\dbltopfraction}{0.9}</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="128">\dblfloatpagefraction</indexterm>\dblfloatpagefraction</itemformat></item> +</tableterm><tableitem><para>For a float page of two-column wide floats, this is the minimum fraction +that must be occupied by floats, limiting the amount of blank space. +&latex;&textrsquo;s default is <code>0.5</code>. Change it with <code>\renewcommand</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="129">\dblfloatsep</indexterm>\dblfloatsep</itemformat></item> +</tableterm><tableitem><para>On a float page of two-column wide floats, this length is the distance +between floats, at both the top and bottom of the page. The default is +<code>12pt plus2pt minus2pt</code> for a document set at <code>10pt</code> or +<code>11pt</code>, and <code>14pt plus2pt minus4pt</code> for a document set at +<code>12pt</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="130">\dbltextfloatsep</indexterm>\dbltextfloatsep</itemformat></item> +</tableterm><tableitem><para>This length is the distance between a multi-column float at the top or +bottom of a page and the main text. The default is <code>20pt plus2pt +minus4pt</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="131">\dbltopnumber</indexterm>\dbltopnumber</itemformat></item> +</tableterm><tableitem><para>On a float page of two-column wide floats, this counter gives the +maximum number of floats allowed at the top of the page. The &latex; +default is <code>2</code>. </para> </tableitem></tableentry></ftable> +<!-- c From egreg at http://tex.stackexchange.com/a/142232/339 --> +<para>This example shows the use of the optional argument of <code>\twocolumn</code> +to create a title that spans the two-column article: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\documentclass[twocolumn]{article} +\newcommand{\authormark}[1]{\textsuperscript{#1}} +\begin{document} +\twocolumn[{% inside this optional argument goes one-column text + \centering + \LARGE The Title \\[1.5em] + \large Author One\authormark{1}, + Author Two\authormark{2}, + Author Three\authormark{1} \\[1em] + \normalsize + \begin{tabular}{p{.2\textwidth}&arobase;{\hspace{2em}}p{.2\textwidth}} + \authormark{1}Department one &\authormark{2}Department two \\ + School one &School two + \end{tabular}\\[3em] % space below title part +}] + +Two column text here. +</pre></example> + </section> <node name="_005cflushbottom" spaces=" "><nodename>\flushbottom</nodename><nodenext automatic="on">\raggedbottom</nodenext><nodeprev automatic="on">\twocolumn</nodeprev><nodeup automatic="on">Layout</nodeup></node> <section spaces=" "><sectiontitle><code>\flushbottom</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="128">\flushbottom</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="132">\flushbottom</indexterm></findex> -<para>The <code>\flushbottom</code> declaration makes all text pages the same -height, adding extra vertical space where necessary to fill out the -page. +<para>The <code>\flushbottom</code> command can go at any point in the document +body. It makes all later pages the same height, stretching the vertical +space where necessary to fill out the page. </para> -<para>This is the default if <code>twocolumn</code> mode is selected -(<pxref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></pxref>). +<para>If &tex; cannot satisfactorily stretch the vertical space in a page +then you get a message like <samp>Underfull \vbox (badness 10000) has +occurred while \output is active</samp>. You can change to +<code>\raggedbottom</code> (see below). Alternatively, you can try to adjust +the <code>textheight</code> to be compatible, or you can add some vertical +stretch glue between lines or between paragraphs, as in +<code>\setlength{\parskip}{0ex plus0.1ex}</code>. In a final editing +stage you can adjust the height of individual pages +(<pxref label="_005cenlargethispage"><xrefnodename>\enlargethispage</xrefnodename></pxref>). +</para> +<para>This is the default only if you select the <code>twoside</code> document class +option (<pxref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></pxref>). </para> </section> <node name="_005craggedbottom" spaces=" "><nodename>\raggedbottom</nodename><nodenext automatic="on">Page layout parameters</nodenext><nodeprev automatic="on">\flushbottom</nodeprev><nodeup automatic="on">Layout</nodeup></node> <section spaces=" "><sectiontitle><code>\raggedbottom</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="129">\raggedbottom</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="99">stretch, omitting vertical</indexterm></cindex> -<para>The <code>\raggedbottom</code> declaration makes all pages the natural -height of the material on that page. No rubber lengths will be -stretched. +<findex index="fn" spaces=" "><indexterm index="fn" number="133">\raggedbottom</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="107">stretch, omitting vertical</indexterm></cindex> + +<para>The <code>\raggedbottom</code> command can go at any point in the document +body. It makes all later pages the natural height of the material on +that page; no rubber lengths will be stretched. Thus, in a two-sided +document the facing pages may be different heights. See also +<code>\flushbottom</code> above. +</para> +<para>This is the default unless you select the <code>twoside</code> document class +option (<pxref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></pxref>). </para> </section> -<node name="Page-layout-parameters" spaces=" "><nodename>Page layout parameters</nodename><nodeprev automatic="on">\raggedbottom</nodeprev><nodeup automatic="on">Layout</nodeup></node> +<node name="Page-layout-parameters" spaces=" "><nodename>Page layout parameters</nodename><nodenext automatic="on">Floats</nodenext><nodeprev automatic="on">\raggedbottom</nodeprev><nodeup automatic="on">Layout</nodeup></node> <section spaces=" "><sectiontitle>Page layout parameters</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="100">page layout parameters</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="101">parameters, page layout</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="102">layout, page parameters for</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="103">header, parameters for</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="104">footer, parameters for</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="105">running header and footer</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="108">page layout parameters</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="109">parameters, page layout</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="110">layout, page parameters for</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="111">header, parameters for</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="112">footer, parameters for</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="113">running header and footer</indexterm></cindex> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="130">\headheight</indexterm>\headheight</itemformat></item> -</tableterm><tableitem><para>Height of the box that contains the running head. Default is -<samp>30pt</samp>, except in the <code>book</code> class, where it varies with the -type size. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="131">\headsep</indexterm>\headsep</itemformat></item> -</tableterm><tableitem><para>Vertical distance between the bottom of the header line and the top of -the main text. Default is <samp>25pt</samp>, except in the <code>book</code> -class, where it varies with the type size. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="132">\footskip</indexterm>\footskip</itemformat></item> -</tableterm><tableitem><para>Distance from the baseline of the last line of text to the baseline of -the page footer. Default is <samp>30pt</samp>, except in the <code>book</code> -class, where it varies with the type size. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="133">\linewidth</indexterm>\linewidth</itemformat></item> -</tableterm><tableitem><para>Width of the current line, decreased for each nested <code>list</code> -(<pxref label="list"><xrefnodename>list</xrefnodename></pxref>). Specifically, it is smaller than <code>\textwidth</code> by -the sum of <code>\leftmargin</code> and <code>\rightmargin</code> -(<pxref label="itemize"><xrefnodename>itemize</xrefnodename></pxref>). The default varies with the font size, paper -width, two-column mode, etc. For an <code>article</code> document in -<samp>10pt</samp>, it&textrsquo;s set to <samp>345pt</samp>; in two-column mode, that -becomes <samp>229.5pt</samp>. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="134">\textheight</indexterm>\textheight</itemformat></item> -</tableterm><tableitem><para>The normal vertical height of the page body; the default varies with -the font size, document class, etc. For an <code>article</code> or -<code>report</code> document in <samp>10pt</samp>, it&textrsquo;s set to -<samp>43\baselineskip</samp>; for <code>book</code>, it&textrsquo;s <samp>41\baselineskip</samp>. -For <samp>11pt</samp>, it&textrsquo;s <samp>38\baselineskip</samp> and for <samp>12pt</samp>, -<samp>36\baselineskip</samp>. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="135">\textwidth</indexterm>\textwidth</itemformat></item> -</tableterm><tableitem><para>The full horizontal width of the entire page body; the default varies -as usual. For an <code>article</code> or <code>report</code> document, it&textrsquo;s -<samp>345pt</samp> at <samp>10pt</samp>, <samp>360pt</samp> at <samp>11pt</samp>, and -<samp>390pt</samp> at <samp>12pt</samp>. For a <code>book</code> document, it&textrsquo;s -<samp>4.5in</samp> at <samp>10pt</samp>, and <samp>5in</samp> at <samp>11pt</samp> or -<samp>12pt</samp>. +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="134">\columnsep</indexterm>\columnsep</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="135">\columnseprule</indexterm>\columnseprule</itemformat></itemx> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="136">\columnwidth</indexterm>\columnwidth</itemformat></itemx> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="137">\columnsep</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="138">\columnseprule</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="139">\columnwidth</indexterm></findex> +<para>The distance between the two columns, the width of a rule between the +columns, and the width of the columns, when the document class option +<code>twocolumn</code> is in effect (<pxref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></pxref>). +<xref label="_005ctwocolumn"><xrefnodename>\twocolumn</xrefnodename></xref>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="140">\headheight</indexterm>\headheight</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="141">\headheight</indexterm></findex> +<para>Height of the box that contains the running head. The default in the +<code>article</code>, <code>report</code>, and <code>book</code> classes is <samp>12pt</samp>, +at all type sizes. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="142">\headsep</indexterm>\headsep</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="143">\headsep</indexterm></findex> +<para>Vertical distance between the bottom of the header line and the top of +the main text. The default in the <code>article</code> and <code>report</code> +classes is <samp>25pt</samp>. In the <code>book</code> class the default is: if the +document is set at 10pt then it is <samp>0.25in</samp>, and at 11pt and 12pt +it is <samp>0.275in</samp>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="144">\footskip</indexterm>\footskip</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="145">\footskip</indexterm></findex> +<para>Distance from the baseline of the last line of text to the baseline of +the page footer. The default in the <code>article</code> and <code>report</code> +classes is <samp>30pt</samp>. In the <code>book</code> class the default is: when +the type size is 10pt the default is <samp>0.35in</samp>, while at 11pt it is +<samp>0.38in</samp>, and at 12pt it is <samp>30pt</samp>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="146">\linewidth</indexterm>\linewidth</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="147">\linewidth</indexterm></findex> +<para>Width of the current line, decreased for each nested <code>list</code> +(<pxref label="list"><xrefnodename>list</xrefnodename></pxref>). That is, the nominal value for <code>\linewidth</code> is to +equal <code>\textwidth</code> but for each nested list the <code>\linewidth</code> +is decreased by the sum of that list&textrsquo;s <code>\leftmargin</code> and +<code>\rightmargin</code> (<pxref label="itemize"><xrefnodename>itemize</xrefnodename></pxref>). +<!-- c The default varies with the font size, paper width, two-column mode, --> +<!-- c etc. For an @code{article} document set in 10pt, the default is --> +<!-- c @samp{345pt}, while in two-column mode that becomes @samp{229.5pt}. --> +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="148">\marginparpush</indexterm>\marginparpush</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="149">\marginsep</indexterm>\marginsep</itemformat></itemx> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="150">\marginparwidth</indexterm>\marginparwidth</itemformat></itemx> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="151">\marginparpush</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="152">\marginsep</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="153">\marginparwidth</indexterm></findex> +<para>The minimum vertical space between two marginal notes, the horizontal +space between the text body and the marginal notes, and the horizontal +width of the notes. +</para> +<para>Normally marginal notes appear on the outside of the page, but the +declaration <code>\reversemarginpar</code> changes that (and +<code>\normalmarginpar</code> changes it back). +</para> +<para>The defaults for <code>\marginparpush</code> in both <code>book</code> and +<code>article</code> classes are: <samp>7pt</samp> if the document is set at 12pt, +and <samp>5pt</samp> if the document is set at 11pt or 10pt. +</para> +<para>For <code>\marginsep</code>, in <code>article</code> class the default is +<samp>10pt</samp> except if the document is set at 10pt and in two-column mode +where the default is <samp>11pt</samp>. +</para> +<para>For <code>\marginsep</code> in <code>book</code> class the default is <samp>10pt</samp> in +two-column mode and <samp>7pt</samp> in one-column mode. +</para> +<para>For <code>\marginparwidth</code> in both <code>book</code> and <code>article</code> +classes, in two-column mode the default is 60% of <code>\paperwidth +− \textwidth</code>, while in one-column mode it is 50% of that +distance. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="154">\oddsidemargin</indexterm>\oddsidemargin</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="155">\evensidemargin</indexterm>\evensidemargin</itemformat></itemx> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="156">\oddsidemargin</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="157">\evensidemargin</indexterm></findex> +<para>The <code>\oddsidemargin</code> is the extra distance between the left side of +the page and the text&textrsquo;s left margin, on odd-numbered pages when the +document class option <code>twoside</code> is chosen and on all pages when +<code>oneside</code> is in effect. When <code>twoside</code> is in effect, on +even-numbered pages the extra distance on the left is +<code>evensidemargin</code>. +</para> +<para>&latex;&textrsquo;s default is that <code>\oddsidemargin</code> is 40% of the +difference between <code>\paperwidth</code> and <code>\textwidth</code>, and +<code>\evensidemargin</code> is the remainder. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="158">\paperheight</indexterm>\paperheight</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="159">\paperheight</indexterm></findex> +<para>The height of the paper, as distinct from the height of the print area. +It is normally set with a document class option, as in +<code>\documentclass[a4paper]{article}</code> (<pxref label="Document-class-options"><xrefnodename>Document class +options</xrefnodename></pxref>). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="160">\paperwidth</indexterm>\paperwidth</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="161">\paperwidth</indexterm></findex> +<para>The width of the paper, as distinct from the width of the print area. +It is normally set with a document class option, as in +<code>\documentclass[a4paper]{article}</code> (<pxref label="Document-class-options"><xrefnodename>Document class +options</xrefnodename></pxref>). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="162">\textheight</indexterm>\textheight</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="163">\textheight</indexterm></findex> +<para>The normal vertical height of the page body. If the document is set at +a nominal type size of 10pt then for an <code>article</code> or <code>report</code> +the default is <samp>43\baselineskip</samp>, while for a <code>book</code> it is +<samp>41\baselineskip</samp>. At a type size of 11pt the default is +<samp>38\baselineskip</samp> for all document classes. At 12pt it is +<samp>36\baselineskip</samp> for all classes. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="164">\textwidth</indexterm>\textwidth</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="165">\textwidth</indexterm></findex> +<para>The full horizontal width of the entire page body. For an +<code>article</code> or <code>report</code> document, the default is <samp>345pt</samp> +when the chosen type size is 10pt, the default is <samp>360pt</samp> at 11pt, +and it is <samp>390pt</samp> at 12pt. For a <code>book</code> document, the default +is <samp>4.5in</samp> at a type size of 10pt, and <samp>5in</samp> at 11pt or 12pt. </para> <para>In multi-column output, <code>\textwidth</code> remains the width of the entire page body, while <code>\columnwidth</code> is the width of one column @@ -1184,43 +1564,227 @@ column), while <code>\linewidth</code> may decrease for nested lists. specified width, and revert to their normal values at the end of the <code>minipage</code> or <code>\parbox</code>. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="136">\hsize</indexterm></findex> -<para>For completeness: <code>\hsize</code> is the &tex; primitive parameter used -when text is broken into lines. It should not be used in normal -&latex; documents. +<findex index="fn" spaces=" "><indexterm index="fn" number="166">\hsize</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="167">\hsize</indexterm></findex> +<para>This entry is included for completeness: <code>\hsize</code> is the &tex; +primitive parameter used when text is broken into lines. It should not +be used in normal &latex; documents. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="137">\topmargin</indexterm>\topmargin</itemformat></item> -</tableterm><tableitem><para>Space between the top of the &tex; page (one inch from the top of the -paper, by default) and the top of the header. The default is computed +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="168">\topmargin</indexterm>\topmargin</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="169">topmargin</indexterm></findex> +<para>Space between the top of the &tex; page (one inch from the top of the +paper, by default) and the top of the header. The value is computed based on many other parameters: <code>\paperheight − 2in − -\headheight − \headsep − \textheight − \footskip</code>, and -then divided by two. +\headheight − \headsep − \textheight − \footskip</code>, +and then divided by two. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="138">\topskip</indexterm>\topskip</itemformat></item> -</tableterm><tableitem><para>Minimum distance between the top of the page body and the baseline of +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="170">\topskip</indexterm>\topskip</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="171">\topskip</indexterm></findex> +<para>Minimum distance between the top of the page body and the baseline of the first line of text. For the standard classes, the default is the -same as the font size, e.g., <samp>10pt</samp> at <samp>10pt</samp>. +same as the font size, e.g., <samp>10pt</samp> at a type size of 10pt. </para> </tableitem></tableentry></ftable> </section> +<node name="Floats" spaces=" "><nodename>Floats</nodename><nodeprev automatic="on">Page layout parameters</nodeprev><nodeup automatic="on">Layout</nodeup></node> +<section spaces=" "><sectiontitle>Floats</sectiontitle> + +<para>Some typographic elements, such as figures and tables, cannot be broken +across pages. They must be typeset outside of the normal flow of text, +for instance floating to the top of a later page. +</para> +<para>&latex; can have a number of different classes of floating material. +The default is the two classes, <code>figure</code> (<pxref label="figure"><xrefnodename>figure</xrefnodename></pxref>) and +<code>table</code> (<pxref label="table"><xrefnodename>table</xrefnodename></pxref>), but you can create a new class with the +package <file>float</file>. +</para> +<para>Within any one float class &latex; always respects the order, so that +the first figure in a document source must be typeset before the second +figure. However, &latex; may mix the classes, so it can happen that +while the first table appears in the source before the first figure, it +appears in the output after it. +</para> +<para>The placement of floats is subject to parameters, given below, that +limit the number of floats that can appear at the top of a page, and the +bottom, etc. If so many floats are queued up that the limits prevent +them all from fitting on a page then &latex; places what it can and +defers the rest to the next page. In this way, floats may be typset far +from their place in the source. In particular, a float that is big can +migrate to the end of the document. But then because all floats in a +class must appear in sequential order, every subsequent float in that +class also appears at the end. +</para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="114">placement of floats</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="115">specifier, float placement</indexterm></cindex> +<para>In addition to changing the parameters, for each float you can tweak +where the float placement algorithm tries to place it by using its +<var>placement</var> argument. The possible values are a sequence of the +letters below. The default for both <code>figure</code> and <code>table</code>, in +both <code>article</code> and <code>book</code> classes, is <code>tbp</code>. +</para> +<table commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code">t</itemformat></item> +</tableterm><tableitem><para>(Top)&textmdash;at the top of a text page. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">b</itemformat></item> +</tableterm><tableitem><para>(Bottom)&textmdash;at the bottom of a text page. (However, <code>b</code> is not +allowed for full-width floats (<code>figure*</code>) with double-column +output. To ameliorate this, use the <file>stfloats</file> or +<file>dblfloatfix</file> package, but see the discussion at caveats in the +FAQ: <url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</urefurl></url>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">h</itemformat></item> +</tableterm><tableitem><para>(Here)&textmdash;at the position in the text where the <code>figure</code> environment +appears. However, <code>h</code> is not allowed by itself; <code>t</code> is +automatically added. +</para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="116">here, putting floats</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="117"><code>float</code> package</indexterm></cindex> +<para>To absolutely force a float to appear &textldquo;here&textrdquo;, you can +<code>\usepackage{float}</code> and use the <code>H</code> specifier which it +defines. For further discussion, see the FAQ entry at +<url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</urefurl></url>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">p</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="118">float page</indexterm></cindex> +<para>(Page of floats)&textmdash;on a separate <dfn>float page</dfn>, which is a page +containing no text, only floats. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">!</itemformat></item> +</tableterm><tableitem><para>Used in addition to one of the above; for this float only, &latex; +ignores the restrictions on both the number of floats that can appear +and the relative amounts of float and non-float text on the page. +The <code>!</code> specifier does <emph>not</emph> mean &textldquo;put the float here&textrdquo;; +see above. +</para> +</tableitem></tableentry></table> + +<para>Note: the order in which letters appear in the <var>placement</var> argument +does not change the order in which &latex; tries to place the float; +for instance, <code>btp</code> has the same effect as <code>tbp</code>. All that +<var>placement</var> does is that if a letter is not present then the +algorithm does not try that location. Thus, &latex;&textrsquo;s default of +<code>tbp</code> is to try every location except placing the float where it +occurs in the source. +</para> +<para>To prevent &latex; from moving floats to the end of the document or a +chapter you can use a <code>\clearpage</code> command to start a new page and +insert all pending floats. If a pagebreak is undesirable then you can +use the <file>afterpage</file> package and issue +<code>\afterpage{\clearpage}</code>. This will wait until the current page +is finished and then flush all outstanding floats. +</para> +<para>&latex; can typeset a float before where it appears in the source +(although on the same output page) if there is a <code>t</code> specifier in the +<var>placement</var> paramater. If this is not desired, and deleting the +<code>t</code> is not acceptable as it keeps the float from being placed at +the top of the next page, then you can prevent it by either using the +<file>flafter</file> package or using the command +<findex index="fn" spaces=" "><indexterm index="fn" number="172">\suppressfloats</indexterm></findex> +<code>\suppressfloats[t]</code>, which causes floats for the top position on +this page to moved to the next page. +</para> +<para>Parameters relating to fractions of pages occupied by float and +non-float text (change them with +<code>\renewcommand{<var>parameter</var>}{<var>decimal between 0 and 1</var>}</code>): +</para> +<ftable commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="173">\bottomfraction</indexterm>\bottomfraction</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="174">\bottomfraction</indexterm></findex> +<para>The maximum fraction of the page allowed to be occupied by floats at +the bottom; default <samp>.3</samp>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="175">\floatpagefraction</indexterm>\floatpagefraction</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="176">\floatpagefraction</indexterm></findex> +<para>The minimum fraction of a float page that must be occupied by floats; +default <samp>.5</samp>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="177">\textfraction</indexterm>\textfraction</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="178">\textfraction</indexterm></findex> +<para>Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is <samp>.2</samp>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="179">\topfraction</indexterm>\topfraction</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="180">\topfraction</indexterm></findex> +<para>Maximum fraction at the top of a page that may be occupied before +floats; default <samp>.7</samp>. +</para></tableitem></tableentry></ftable> + +<para>Parameters relating to vertical space around floats (change them with +<code>\setlength{<var>parameter</var>}{<var>length expression</var>}</code>): +</para> +<ftable commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="181">\floatsep</indexterm>\floatsep</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="182">\floatsep</indexterm></findex> +<para>Space between floats at the top or bottom of a page; default +<samp>12pt plus2pt minus2pt</samp>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="183">\intextsep</indexterm>\intextsep</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="184">\intextsep</indexterm></findex> +<para>Space above and below a float in the middle of the main text; default +<samp>12pt plus2pt minus2pt</samp> for 10 point and 11 point documents, +and <samp>14pt plus4pt minus4pt</samp> for 12 point documents. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="185">\textfloatsep</indexterm>\textfloatsep</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="186">\textfloatsep</indexterm></findex> +<para>Space between the last (first) float at the top (bottom) of a page; +default <samp>20pt plus2pt minus4pt</samp>. +</para></tableitem></tableentry></ftable> + +<para>Counters relating to the number of floats on a page (change them with +<code>\setcounter{<var>ctrname</var>}{<var>natural number</var>}</code>): +</para> +<ftable commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="187">bottomnumber</indexterm>bottomnumber</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="188">bottomnumber</indexterm></findex> +<para>Maximum number of floats that can appear at the bottom of a text page; +default 1. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="189">dbltopnumber</indexterm>dbltopnumber</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="190">dbltopnumber</indexterm></findex> +<para>Maximum number of full-sized floats that can appear at the top of a +two-column page; default 2. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="191">topnumber</indexterm>topnumber</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="192">topnumber</indexterm></findex> +<para>Maximum number of floats that can appear at the top of a text page; +default 2. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="193">totalnumber</indexterm>totalnumber</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="194">totalnumber</indexterm></findex> +<para>Maximum number of floats that can appear on a text page; default 3. +</para></tableitem></tableentry></ftable> + +<para>The principal &tex; FAQ entry relating to floats +<url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</urefurl></url> contains +suggestions for relaxing &latex;&textrsquo;s default parameters to reduce the +problem of floats being pushed to the end. A full explaination of the +float placement algorithm is Frank Mittelbach&textrsquo;s article &textldquo;How to +infuence the position of float environments like figure and table in +&latex;?&textrdquo; <url><urefurl>http://latex-project.org/papers/tb111mitt-float.pdf</urefurl></url>. +</para> + +</section> </chapter> <node name="Sectioning" spaces=" "><nodename>Sectioning</nodename><nodenext automatic="on">Cross references</nodenext><nodeprev automatic="on">Layout</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Sectioning</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="106">sectioning</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="119">sectioning commands</indexterm></cindex> <para>Sectioning commands provide the means to structure your text into units: </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="139">\part</indexterm>\part</itemformat></item> -</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="140">\chapter</indexterm>\chapter</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="195">\part</indexterm>\part</itemformat></item> +</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="196">\chapter</indexterm>\chapter</itemformat></item> </tableterm><tableitem><para>(<code>report</code> and <code>book</code> class only) -</para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="141">\section</indexterm>\section</itemformat></item> -</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="142">\subsection</indexterm>\subsection</itemformat></item> -</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="143">\subsubsection</indexterm>\subsubsection</itemformat></item> -</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="144">\paragraph</indexterm>\paragraph</itemformat></item> -</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="145">\subparagraph</indexterm>\subparagraph</itemformat></item> +</para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="197">\section</indexterm>\section</itemformat></item> +</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="198">\subsection</indexterm>\subsection</itemformat></item> +</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="199">\subsubsection</indexterm>\subsubsection</itemformat></item> +</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="200">\paragraph</indexterm>\paragraph</itemformat></item> +</tableterm></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="201">\subparagraph</indexterm>\subparagraph</itemformat></item> </tableterm></tableentry></ftable> <para>All sectioning commands take the same general form, e.g., @@ -1244,7 +1808,7 @@ To handle this, the sectioning commands have an optional argument <var>toctitle</var> that, when given, specifies the text for these other places. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="107">*-form of sectioning commands</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="120"><code>*</code>-form of sectioning commands</indexterm></cindex> <para>Also, all sectioning commands have <code>*</code>-forms that print <var>title</var> as usual, but do not include a number and do not make an entry in the table of contents. For instance: @@ -1253,8 +1817,8 @@ entry in the table of contents. For instance: <pre xml:space="preserve">\section*{Preamble} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="146">\appendix</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="108">appendix, creating</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="202">\appendix</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="121">appendix, creating</indexterm></cindex> <para>The <code>\appendix</code> command changes the way following sectional units are numbered. The <code>\appendix</code> command itself generates no text and does not affect the numbering of parts. The normal use of this @@ -1267,8 +1831,8 @@ command is something like \chapter{The First Appendix} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="147">secnumdepth <r>counter</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="109">section numbers, printing</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="203">secnumdepth <r>counter</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="122">section numbers, printing</indexterm></cindex> <para>The <code>secnumdepth</code> counter controls printing of section numbers. The setting </para> @@ -1284,7 +1848,8 @@ The setting </chapter> <node name="Cross-references" spaces=" "><nodename>Cross references</nodename><nodenext automatic="on">Environments</nodenext><nodeprev automatic="on">Sectioning</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Cross references</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="110">cross references</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="123">cross references</indexterm></cindex> <para>One reason for numbering things like figures and equations is to refer the reader to them, as in &textldquo;See Figure 3 for more details.&textrdquo; @@ -1298,7 +1863,8 @@ the reader to them, as in &textldquo;See Figure 3 for more details.&textrdquo; <node name="_005clabel" spaces=" "><nodename>\label</nodename><nodenext automatic="on">\pageref</nodenext><nodeup automatic="on">Cross references</nodeup></node> <section spaces=" "><sectiontitle><code>\label</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="148">\label</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="204">\label</indexterm></findex> <para>Synopsis: </para> @@ -1308,15 +1874,35 @@ the reader to them, as in &textldquo;See Figure 3 for more details.&textrdquo; <para>A <code>\label</code> command appearing in ordinary text assigns to <var>key</var> the number of the current sectional unit; one appearing -inside a numbered environment assigns that number to <var>key</var>. +inside a numbered environment assigns that number to <var>key</var>. The +assigned number can be retrieved with the <code>\ref{<var>key</var>}</code> +command (<pxref label="_005cref"><xrefnodename>\ref</xrefnodename></pxref>). </para> -<para>A <var>key</var> name can consist of any sequence of letters, digits, or +<para>Thus, in the example below the key <code>sec:test</code> holds the number of +the current section and the key <code>fig:test</code> that of the figure. +(Incidentally, labels must appear after captions in figures and +tables.) +</para> +<example endspaces=" "> +<pre xml:space="preserve">\section{section name} +\label{sec:test} +This is Section~\ref{sec:test}. +\begin{figure} + ... + \caption{caption text} + \label{fig:test} +\end{figure} +See Figure~\ref{fig:test}. +</pre></example> + +<para>A key name can consist of any sequence of letters, digits, or common punctuation characters. Upper and lowercase letters are distinguished, as usual. </para> -<para>To avoid accidentally creating two labels with the same name, it is -common to use labels consisting of a prefix and a suffix separated by -a colon or period. Some conventionally-used prefixes: +<para>Although the name can be more or less anything, a common convention is +to use labels consisting of a prefix and a suffix separated by a colon +or period. This helps to avoid accidentally creating two labels with +the same name. Some commonly-used prefixes: </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">ch</itemformat></item> @@ -1331,16 +1917,17 @@ a colon or period. Some conventionally-used prefixes: </tableterm><tableitem><para>for equations </para></tableitem></tableentry></table> -<para>Thus, a label for a figure would look like <code>fig:snark</code> or -<code>fig.snark</code>. +<para>Thus, a label for a figure would look like <code>fig:test</code> or +<code>fig.test</code>. </para> </section> <node name="_005cpageref" spaces=" "><nodename>\pageref</nodename><nodenext automatic="on">\ref</nodenext><nodeprev automatic="on">\label</nodeprev><nodeup automatic="on">Cross references</nodeup></node> <section spaces=" "><sectiontitle><code>\pageref{<var>key</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="149">\pageref</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="111">cross referencing with page number</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="112">page number, cross referencing</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="205">\pageref</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="124">cross referencing with page number</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="125">page number, cross referencing</indexterm></cindex> <para>Synopsis: </para> @@ -1356,12 +1943,13 @@ the place in the text where the corresponding </section> <node name="_005cref" spaces=" "><nodename>\ref</nodename><nodeprev automatic="on">\pageref</nodeprev><nodeup automatic="on">Cross references</nodeup></node> <section spaces=" "><sectiontitle><code>\ref{<var>key</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="150">\ref</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="113">cross referencing, symbolic</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="114">section number, cross referencing</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="115">equation number, cross referencing</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="116">figure number, cross referencing</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="117">footnote number, cross referencing</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="206">\ref</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="126">cross referencing, symbolic</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="127">section number, cross referencing</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="128">equation number, cross referencing</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="129">figure number, cross referencing</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="130">footnote number, cross referencing</indexterm></cindex> <para>Synopsis: </para> @@ -1379,10 +1967,10 @@ such as the word &textlsquo;Section&textrsquo; or &textlsquo;Figure&textrsquo;, </chapter> <node name="Environments" spaces=" "><nodename>Environments</nodename><nodenext automatic="on">Line breaking</nodenext><nodeprev automatic="on">Cross references</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Environments</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="118">environments</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="151">\begin</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="152">\end</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="131">environments</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="207">\begin</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="208">\end</indexterm></findex> <para>&latex; provides many environments for marking off certain text. Each environment begins and ends in the same manner: @@ -1394,46 +1982,46 @@ Each environment begins and ends in the same manner: </pre></example> <menu endspaces=" "> -<menuentry leadingtext="* "><menunode separator=":: ">abstract</menunode><menudescription><pre xml:space="preserve">Produce an abstract. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">array</menunode><menudescription><pre xml:space="preserve">Math arrays. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">center</menunode><menudescription><pre xml:space="preserve">Centered lines. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">description</menunode><menudescription><pre xml:space="preserve">Labelled lists. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">displaymath</menunode><menudescription><pre xml:space="preserve">Formulas that appear on their own line. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">document</menunode><menudescription><pre xml:space="preserve">Enclose the whole document. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">enumerate</menunode><menudescription><pre xml:space="preserve">Numbered lists. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">eqnarray</menunode><menudescription><pre xml:space="preserve">Sequences of aligned equations. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">equation</menunode><menudescription><pre xml:space="preserve">Displayed equation. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">figure</menunode><menudescription><pre xml:space="preserve">Floating figures. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">filecontents</menunode><menudescription><pre xml:space="preserve">Writing multiple files from the source. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">flushleft</menunode><menudescription><pre xml:space="preserve">Flushed left lines. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">flushright</menunode><menudescription><pre xml:space="preserve">Flushed right lines. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">itemize</menunode><menudescription><pre xml:space="preserve">Bulleted lists. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">letter</menunode><menudescription><pre xml:space="preserve">Letters. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">list</menunode><menudescription><pre xml:space="preserve">Generic list environment. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">math</menunode><menudescription><pre xml:space="preserve">In-line math. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">minipage</menunode><menudescription><pre xml:space="preserve">Miniature page. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">picture</menunode><menudescription><pre xml:space="preserve">Picture with text, arrows, lines and circles. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">quotation</menunode><menudescription><pre xml:space="preserve">Indented environment with paragraph indentation. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">quote</menunode><menudescription><pre xml:space="preserve">Indented environment with no paragraph indentation. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">tabbing</menunode><menudescription><pre xml:space="preserve">Align text arbitrarily. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">table</menunode><menudescription><pre xml:space="preserve">Floating tables. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">tabular</menunode><menudescription><pre xml:space="preserve">Align text in columns. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">thebibliography</menunode><menudescription><pre xml:space="preserve">Bibliography or reference list. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">theorem</menunode><menudescription><pre xml:space="preserve">Theorems, lemmas, etc. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">titlepage</menunode><menudescription><pre xml:space="preserve">For hand crafted title pages. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">verbatim</menunode><menudescription><pre xml:space="preserve">Simulating typed input. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">verse</menunode><menudescription><pre xml:space="preserve">For poetry and other things. +<menuentry leadingtext="* "><menunode separator=":: ">abstract</menunode><menudescription><pre xml:space="preserve">Produce an abstract. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">array</menunode><menudescription><pre xml:space="preserve">Math arrays. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">center</menunode><menudescription><pre xml:space="preserve">Centered lines. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">description</menunode><menudescription><pre xml:space="preserve">Labelled lists. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">displaymath</menunode><menudescription><pre xml:space="preserve">Formulas that appear on their own line. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">document</menunode><menudescription><pre xml:space="preserve">Enclose the whole document. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">enumerate</menunode><menudescription><pre xml:space="preserve">Numbered lists. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">eqnarray</menunode><menudescription><pre xml:space="preserve">Sequences of aligned equations. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">equation</menunode><menudescription><pre xml:space="preserve">Displayed equation. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">figure</menunode><menudescription><pre xml:space="preserve">Floating figures. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">filecontents</menunode><menudescription><pre xml:space="preserve">Writing multiple files from the source. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">flushleft</menunode><menudescription><pre xml:space="preserve">Flushed left lines. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">flushright</menunode><menudescription><pre xml:space="preserve">Flushed right lines. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">itemize</menunode><menudescription><pre xml:space="preserve">Bulleted lists. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">letter</menunode><menudescription><pre xml:space="preserve">Letters. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">list</menunode><menudescription><pre xml:space="preserve">Generic list environment. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">math</menunode><menudescription><pre xml:space="preserve">In-line math. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">minipage</menunode><menudescription><pre xml:space="preserve">Miniature page. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">picture</menunode><menudescription><pre xml:space="preserve">Picture with text, arrows, lines and circles. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">quotation and quote</menunode><menudescription><pre xml:space="preserve">Include a quotation. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">tabbing</menunode><menudescription><pre xml:space="preserve">Align text arbitrarily. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">table</menunode><menudescription><pre xml:space="preserve">Floating tables. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">tabular</menunode><menudescription><pre xml:space="preserve">Align text in columns. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">thebibliography</menunode><menudescription><pre xml:space="preserve">Bibliography or reference list. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">theorem</menunode><menudescription><pre xml:space="preserve">Theorems, lemmas, etc. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">titlepage</menunode><menudescription><pre xml:space="preserve">For hand crafted title pages. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">verbatim</menunode><menudescription><pre xml:space="preserve">Simulating typed input. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">verse</menunode><menudescription><pre xml:space="preserve">For poetry and other things. </pre></menudescription></menuentry></menu> <node name="abstract" spaces=" "><nodename>abstract</nodename><nodenext automatic="on">array</nodenext><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>abstract</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="153">abstract <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="119">abstracts</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="209">abstract <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="132">abstracts</indexterm></cindex> <para>Synopsis: -</para><example endspaces=" "> +</para> +<example endspaces=" "> <pre xml:space="preserve">\begin{abstract} ... \end{abstract} @@ -1445,84 +2033,112 @@ Each environment begins and ends in the same manner: </section> <node name="array" spaces=" "><nodename>array</nodename><nodenext automatic="on">center</nodenext><nodeprev automatic="on">abstract</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>array</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="154">array <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="120">arrays, math</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="210">array <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="133">arrays, math</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\begin{array}{<var>template</var>} -<var>col1 text</var>&<var>col1 text</var>&<var>coln</var>}\\ +<pre xml:space="preserve">\begin{array}{<var>cols</var>} +<var>column 1 entry</var> &<var>column 2 entry</var> ... &<var>column n entry</var> \\ ... \end{array} </pre></example> -<para>Math arrays are produced with the <code>array</code> environment, normally -within an <code>equation</code> environment (<pxref label="equation"><xrefnodename>equation</xrefnodename></pxref>). It has a -single mandatory <var>template</var> argument describing the number of -columns and the alignment within them. Each column <var>col</var> is -specified by a single letter that tells how items in each row of that -column should be formatted, as follows: +<para>or </para> -<table commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code">c</itemformat></item> -</tableterm><tableitem><para>centered -</para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">l</itemformat></item> -</tableterm><tableitem><para>flush left -</para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">r</itemformat></item> -</tableterm><tableitem><para>flush right -</para></tableitem></tableentry></table> +<example endspaces=" "> +<pre xml:space="preserve">\begin{array}[<var>pos</var>]{<var>cols</var>} +<var>column 1 entry</var> &<var>column 2 entry</var> ... &<var>column n entry</var> \\ +... +\end{array} +</pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="155">\\ <r>(for <code>array</code>)</r></indexterm></findex> -<para>Column entries are separated by <code>&</code>. Column entries may include -other &latex; commands. Each row of the array is terminated with -<code>\\</code>. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="156">&arobase;{...}</indexterm></findex> -<para>In the template, the construct <code>&arobase;{<var>text</var>}</code> puts <var>text</var> -between columns in each row. -</para> -<para>Here&textrsquo;s an example: +<para>Produce a mathematical array. This environment can only be used in math +mode, and normally appears within a displayed mathematics environment +such as <code>equation</code> (<pxref label="equation"><xrefnodename>equation</xrefnodename></pxref>). Column entries are +separated by an ampersand (<code>&</code>). Rows are terminated with +double-backslashes (<code>\\</code>) (<pxref label="_005c_005c"><xrefnodename>\\</xrefnodename></pxref>). +</para> +<para>The required argument <var>cols</var> describes the number of columns, their +alignment, and the formatting of the intercolumn regions. See +<ref label="tabular"><xrefnodename>tabular</xrefnodename></ref> for the complete description of <var>cols</var>, and of the +other common features of the two environments, including the optional +<var>pos</var> argument. +</para> +<para>There are two ways that <code>array</code> diverges from <code>tabular</code>. The +first is that <code>array</code> entries are typeset in mathematics mode, in +textstyle (except if the <var>cols</var> definition specifies the column with +<code>&arobase;p{..}</code>, which causes the entry to be typeset in text mode). +The second is that, instead of <code>tabular</code>&textrsquo;s parameter +<code>\tabcolsep</code>, &latex;&textrsquo;s intercolumn space in an array is governed +by +<findex index="fn" spaces=" "><indexterm index="fn" number="211">\arraycolsep</indexterm></findex> +<code>\arraycolsep</code> which gives half the width between columns. The +default for this is <samp>5pt</samp>. +</para> +<para>To obtain arrays with braces the standard is to use the <file>amsmath</file> +package. It comes with environments <code>pmatrix</code> for an array +surrounded by parentheses <code>(..)</code>, <code>bmatrix</code> for an array +surrounded by square brackets <code>[..]</code>, <code>Bmatrix</code> for an +array surrounded by curly braces <code>{..}</code>, <code>vmatrix</code> for +an array surrounded by vertical bars <code>|..|</code>, and +<code>Vmatrix</code> for an array surrounded by double vertical +bars <code>||..||</code>, along with a number of other array constructs. +</para> +<para>Here is an example of an array: </para> <example endspaces=" "> <pre xml:space="preserve">\begin{equation} - \begin{array}{lrc} - left1 & right1 & centered1 \\ - left2 & right2 & centered2 \\ + \begin{array}{cr} + \sqrt{y} &12.3 \\ + x^2 &3.4 \end{array} \end{equation} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="157">\arraycolsep</indexterm></findex> -<para>The <code>\arraycolsep</code> parameter defines half the width of the space -separating columns; the default is <samp>5pt</samp>. <xref label="tabular"><xrefnodename>tabular</xrefnodename></xref>, for other -parameters which affect formatting in <code>array</code> environments, -namely <code>\arrayrulewidth</code> and <code>\arraystretch</code>. -</para> -<para>The <code>array</code> environment can only be used in math mode. -</para> </section> <node name="center" spaces=" "><nodename>center</nodename><nodenext automatic="on">description</nodenext><nodeprev automatic="on">array</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>center</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="158">center <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="121">centering text, environment for</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="212">center <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="134">centering text, environment for</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> <pre xml:space="preserve">\begin{center} -<var>line1</var> \\ -<var>line2</var> \\ + .. text .. \end{center} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="159">\\ <r>(for <code>center</code>)</r></indexterm></findex> -<para>The <code>center</code> environment allows you to create a paragraph -consisting of lines that are centered within the left and right -margins on the current page. Each line is terminated with the -string <code>\\</code>. +<para>Environment to create a sequence of lines that are centered within the +left and right margins on the current page. If the text in the +environment body is too long to fit on a line, &latex; will insert line +breaks that avoid hyphenation and avoid stretching or shrinking any +interword space. To force a line break at a particular spot use +double-backslash <code>\\</code> (<pxref label="_005c_005c"><xrefnodename>\\</xrefnodename></pxref>). +<findex index="fn" spaces=" "><indexterm index="fn" number="213">\\ <r>(for <code>center</code>)</r></indexterm></findex> +</para> +<para>This environment inserts space above and below the text body. See +<ref label="_005ccentering"><xrefnodename>\centering</xrefnodename></ref> to avoid such space, for example inside a <code>figure</code> +environment. +</para> +<para>In this example, depending on the line width, &latex; may choose a break +for the part before the double backslash, will center the line or two, +then will break at the double backslash, and will center the ending. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{center} + My father considered that anyone who went to chapel and didn't drink + alcohol was not to be tolerated.\\ + I grew up in that belief. --Richard Burton +\end{center} +</pre></example> + +<para>A double backslash after the final line is optional. </para> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\centering</menunode><menudescription><pre xml:space="preserve">Declaration form of the <code>center</code> environment. @@ -1532,444 +2148,533 @@ string <code>\\</code>. <node name="_005ccentering" spaces=" "><nodename>\centering</nodename><nodeup automatic="on">center</nodeup></node> <subsection spaces=" "><sectiontitle><code>\centering</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="160">\centering</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="122">centering text, declaration for</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="214">\centering</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="135">centering text, declaration for</indexterm></cindex> -<para>The <code>\centering</code> declaration corresponds to the <code>center</code> -environment. This declaration can be used inside an environment such -as <code>quote</code> or in a <code>parbox</code>. Thus, the text of a figure or -table can be centered on the page by putting a <code>\centering</code> -command at the beginning of the figure or table environment. +<para>Declaration that causes material in its scope to be centered. It is +most often used inside an environment such as <code>figure</code>, or in a +<code>parbox</code>. +</para> +<para>Unlike the <code>center</code> environment, the <code>\centering</code> command does +not add vertical space above and below the text. </para> -<para>Unlike the <code>center</code> environment, the <code>\centering</code> command -does not start a new paragraph; it simply changes how &latex; formats -paragraph units. To affect a paragraph unit&textrsquo;s format, the scope of -the declaration must contain the blank line or <code>\end</code> command (of -an environment such as quote) that ends the paragraph unit. +<para>It also does not start a new paragraph; it simply changes how &latex; +formats paragraph units. If <code>ww {\centering xx \\ yy} zz</code> is +surrounded by blank lines then &latex; will create a paragraph whose +first line <samp>ww xx</samp> is centered and whose second line, not centered, +contains <samp>yy zz</samp>. Usually what is desired is for the scope of the +declaration to contain a blank line or the <code>\end</code> command of an +environment such as <code>figure</code> or <code>table</code> that ends the +paragraph unit. Thus, if <code>{\centering xx \\ yy\par} zz</code> is +surrounded by blank lines then it makes a new paragraph with two +centered lines <samp>xx</samp> and <samp>yy</samp>, followed by a new paragraph with +<samp>zz</samp> that is formatted as usual. See also the following example. </para> -<para>Here&textrsquo;s an example: +<para>This example&textrsquo;s <code>\centering</code> causes the graphic to be horizontally +centered. </para> <example endspaces=" "> -<pre xml:space="preserve">\begin{quote} -\centering -first line \\ -second line \\ -\end{quote} +<pre xml:space="preserve">\begin{figure} + \centering + \includegraphics[width=0.6\textwidth]{ctan_lion.png} + \caption{CTAN Lion} \label{fig:CTANLion} +\end{figure} </pre></example> +<para>The scope of the <code>\centering</code> ends with the <code>\end{figure}</code>. +</para> </subsection> </section> <node name="description" spaces=" "><nodename>description</nodename><nodenext automatic="on">displaymath</nodenext><nodeprev automatic="on">center</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>description</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="161">description <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="123">labelled lists, creating</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="124">description lists, creating</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="215">description <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="136">labelled lists, creating</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="137">description lists, creating</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> <pre xml:space="preserve">\begin{description} -\item [<var>label1</var>] <var>item1</var> -\item [<var>label2</var>] <var>item2</var> -... +\item [<var>first label</var>] text of first item +\item [<var>second label</var>] text of second item + ... \end{description} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="162">\item</indexterm></findex> -<para>The <code>description</code> environment is used to make labelled lists. Each -<var>label</var> is typeset in bold, flush right. The <var>item</var> text may -contain multiple paragraphs. -</para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="125">bold typewriter, avoiding</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="126">typewriter labels in lists</indexterm></cindex> -<para>Another variation: since the bold style is applied to the labels, if -you typeset a label in typewriter using <code>\texttt</code>, you&textrsquo;ll get -bold typewriter: <code>\item[\texttt{bold and typewriter}]</code>. This -may be too bold, among other issues. To get just typewriter, use -<code>\tt</code>, which resets all other style variations: <code>\item[{\tt -plain typewriter}]</code>. -</para> -<para>For details about list spacing, see <ref label="itemize"><xrefnodename>itemize</xrefnodename></ref>. +<findex index="fn" spaces=" "><indexterm index="fn" number="216">\item</indexterm></findex> +<para>Environment to make a labelled list of items. Each item&textrsquo;s <var>label</var> +is typeset in bold, flush-left. Each item&textrsquo;s text may contain multiple +paragraphs. Although the labels on the items are optional there is no +sensible default, so all items should have labels. +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="217">\item</indexterm></findex> +<para>The list consists of at least one item; see <ref label="_005citem"><xrefnodename>\item</xrefnodename></ref> (having no +items causes the &latex; error <samp>Something's wrong--perhaps a +missing \item</samp>). Each item is produced with an <code>\item</code> command. +</para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="138">bold typewriter, avoiding</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="139">typewriter labels in lists</indexterm></cindex> +<para>Since the labels are in bold style, if the label text calls for a font +change given in argument style (see <ref label="Font-styles"><xrefnodename>Font styles</xrefnodename></ref>) then it will come +out bold. For instance, if the label text calls for typewriter with +<code>\item[\texttt{label text}]</code> then it will appear in bold +typewriter, if that is available. The simplest way to get non-bolded +typewriter is to use declaritive style <code>\item[{\tt label text}]</code>. +Similarly, get normal text use <code>\item[{\rm label text}]</code>. +</para> +<para>For other major &latex; labelled list environments, see <ref label="itemize"><xrefnodename>itemize</xrefnodename></ref> +and <ref label="enumerate"><xrefnodename>enumerate</xrefnodename></ref>. For information about customizing list layout, see +<ref label="list"><xrefnodename>list</xrefnodename></ref>; also, the package <file>enumitem</file> is useful for this. +</para> +<para>This example shows the environment used for a sequence of definitions. </para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{definition} + \item[lama] A priest. + \item[llama] A beast. +\end{definition} +</pre></example> + </section> <node name="displaymath" spaces=" "><nodename>displaymath</nodename><nodenext automatic="on">document</nodenext><nodeprev automatic="on">description</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>displaymath</code></sectiontitle> +<!-- c http://tex.stackexchange.com/questions/40492/what-are-the-differences-between-align-equation-and-displaymath --> -<findex index="fn" spaces=" "><indexterm index="fn" number="163">displaymath <r>environment</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="218">displaymath <r>environment</r></indexterm></findex> <para>Synopsis: </para> <example endspaces=" "> <pre xml:space="preserve">\begin{displaymath} -<var>math</var> + .. math text .. \end{displaymath} </pre></example> -<noindent></noindent> <para>or -</para> -<example endspaces=" "> -<pre xml:space="preserve">\[<var>math</var>\] +<para>Environment to typeset the math text on its own line, in display style +and centered. To make the text be flush-left use the global option +<code>fleqn</code>; see <ref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></ref>. +</para> +<para>&latex; will not break the math text across lines. +</para> +<para>In the <code>displaymath</code> environment no equation number is added to the +math text. One way to get an equation number is to use the +<code>equation</code> environment (<pxref label="equation"><xrefnodename>equation</xrefnodename></pxref>). +</para> +<para>Note that the <file>amsmath</file> package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. For example, there are a number of options in that +package for having math text broken across lines. +</para> +<para>The construct <code>\[..math text..\]</code> is essentially a synonym for +<code>\begin{displaymath}..math text..\end{displaymath}</code> but the +latter is easier to work with in the source file; for instance, +searching for a square bracket may get false positives but the word +<code>displaymath</code> will likely be unique. (The construct <code>$$..math +text..$$</code> from Plain &tex; is sometimes mistakenly used as a +synonym for <code>displaymath</code>. It is not a synonym, because the +<code>displaymath</code> environment checks that it isn&textrsquo;t started in math mode +and that it ends in math mode begun by the matching environment start, +because the <code>displaymath</code> environment has different vertical +spacing, and because the <code>displaymath</code> environment honors the +<code>fleqn</code> option.) +</para> +<para>The output from this example is centered and alone on its line. +</para><example endspaces=" "> +<pre xml:space="preserve">\begin{displaymath} + \int_1^2 x^2\,dx=7/3 +\end{displaymath} </pre></example> - -<para>The <code>displaymath</code> environment (<code>\[...\]</code> is a synonym) -typesets the <var>math</var> text on its own line, centered by default. -The global <code>fleqn</code> option makes equations flush left; see -<ref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></ref>. -</para> -<para>No equation number is added to <code>displaymath</code> text; to get an -equation number, use the <code>equation</code> environment (<pxref label="equation"><xrefnodename>equation</xrefnodename></pxref>). +<para>Also, the integral sign is larger than the inline version +<code>\( \int_1^2 x^2\,dx=7/3 \)</code> produces. </para> </section> <node name="document" spaces=" "><nodename>document</nodename><nodenext automatic="on">enumerate</nodenext><nodeprev automatic="on">displaymath</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>document</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="164">document <r>environment</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="219">document <r>environment</r></indexterm></findex> -<para>The <code>document</code> environment encloses the body of a document. +<para>The <code>document</code> environment encloses the entire body of a document. It is required in every &latex; document. <xref label="Starting-and-ending"><xrefnodename>Starting and ending</xrefnodename></xref>. </para> +<menu endspaces=" "> +<menuentry leadingtext="* "><menunode separator=":: ">\AtBeginDocument</menunode><menudescription><pre xml:space="preserve">Hook for commands at the start of the document. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\AtEndDocument</menunode><menudescription><pre xml:space="preserve">Hook for commands at the end of the document. +</pre></menudescription></menuentry></menu> + + +<node name="_005cAtBeginDocument" spaces=" "><nodename>\AtBeginDocument</nodename><nodenext automatic="on">\AtEndDocument</nodenext><nodeup automatic="on">document</nodeup></node> + +<findex index="fn" spaces=" "><indexterm index="fn" number="220">\AtBeginDocument</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="140">beginning of document hook</indexterm></cindex> + +<para>Synopsis: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\AtBeginDocument{<var>code</var>} +</pre></example> + +<para>Save <var>code</var> and execute it when <code>\begin{document}</code> is +executed, at the very end of the preamble. The code is executed after +the font selection tables have been set up, so the normal font for the +document is the current font. However, the code is executed as part of +the preamble so you cannot do any typesetting with it. +</para> +<para>You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. +</para> + +<node name="_005cAtEndDocument" spaces=" "><nodename>\AtEndDocument</nodename><nodeprev automatic="on">\AtBeginDocument</nodeprev><nodeup automatic="on">document</nodeup></node> + +<findex index="fn" spaces=" "><indexterm index="fn" number="221">\AtEndDocument</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="141">end of document hook</indexterm></cindex> + +<para>Synopsis: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\AtEndDocument{<var>code</var>} +</pre></example> + +<para>Save <var>code</var> and execute it near the end of the document. +Specifically, it is executed when <code>\end{document}</code> is executed, +before the final page is finished and before any leftover floating +environments are processed. If you want some of the code to be executed +after these two processes then include a <code>\clearpage</code> at the +appropriate point in <var>code</var>. +</para> +<para>You can issue this command more than once; the successive code lines +will be executed in the order that you gave them. +</para> </section> <node name="enumerate" spaces=" "><nodename>enumerate</nodename><nodenext automatic="on">eqnarray</nodenext><nodeprev automatic="on">document</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>enumerate</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="165">enumerate <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="127">lists of items, numbered</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="222">enumerate <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="142">lists of items, numbered</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> <pre xml:space="preserve">\begin{enumerate} -\item <var>item1</var> -\item <var>item2</var> +\item [<var>first label</var>] text of first item +\item [<var>second label</var>] text of second item ... \end{enumerate} </pre></example> -<para>The <code>enumerate</code> environment produces a numbered list. Enumerations -can be nested within one another, up to four levels deep. They can also -be nested within other paragraph-making environments, such as -<code>itemize</code> (<pxref label="itemize"><xrefnodename>itemize</xrefnodename></pxref>) and <code>description</code> -(<pxref label="description"><xrefnodename>description</xrefnodename></pxref>). +<para>Environment to produce a numbered list of items. The format of the +label numbering depends on whether this environment is nested within +another; see below. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="166">\item</indexterm></findex> -<para>Each item of an enumerated list begins with an <code>\item</code> command. -There must be at least one <code>\item</code> command within the environment. +<findex index="fn" spaces=" "><indexterm index="fn" number="223">\item</indexterm></findex> +<para>The list consists of at least one item. Having no items causes the +&latex; error <samp>Something's wrong--perhaps a missing \item</samp>. Each +item is produced with an <code>\item</code> command. </para> -<para>By default, the numbering at each level is done like this: +<para>This example lists the top two finishers in the 1908 Olympic marathon. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{enumerate} + \item Johnny Hayes (USA) + \item Charles Hefferon (RSA) +\end{enumerate} +</pre></example> + +<para>Enumerations may be nested within a paragraph-making environment, +including <code>itemize</code> (<pxref label="itemize"><xrefnodename>itemize</xrefnodename></pxref>), <code>description</code> +(<pxref label="description"><xrefnodename>description</xrefnodename></pxref>) and <code>enumeration</code>, up to four levels deep. +The format of the label produced depends on the place in the nesting. +This gives &latex;&textrsquo;s default for the format at each nesting level +(where 1 is the outermost level): </para> <enumerate first="1" endspaces=" "> -<listitem spaces=" "><para>1., 2., &dots; -</para></listitem><listitem spaces=" "><para>(a), (b), &dots; -</para></listitem><listitem spaces=" "><para>i., ii., &dots; -</para></listitem><listitem spaces=" "><para>A., B., &dots; +<listitem spaces=" "><para>arabic number followed by a period: <samp>1.</samp>, <samp>2.</samp>, &dots; +</para></listitem><listitem spaces=" "><para>lower case letter inside parentheses: <samp>(a)</samp>, <samp>(b)</samp> &dots; +</para></listitem><listitem spaces=" "><para>lower case roman numeral followed by a period: <samp>i.</samp>, <samp>ii.</samp>, &dots; +</para></listitem><listitem spaces=" "><para>upper case letter followed by a period: <samp>A.</samp>, <samp>B.</samp>, &dots; </para></listitem></enumerate> -<findex index="fn" spaces=" "><indexterm index="fn" number="167">\enumi</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="168">\enumii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="169">\enumiii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="170">\enumiv</indexterm></findex> -<para>The <code>enumerate</code> environment uses the counters <code>\enumi</code> -through <code>\enumiv</code> counters (<pxref label="Counters"><xrefnodename>Counters</xrefnodename></pxref>). If the optional -argument to <code>\item</code> is given, the counter is not incremented for -that item. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="171">\labelenumi</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="172">\labelenumii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="173">\labelenumiii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="174">\labelenumiv</indexterm></findex> -<para>The <code>enumerate</code> environment uses the commands <code>\labelenumi</code> -through <code>\labelenumiv</code> to produce the default label. So, you can -use <code>\renewcommand</code> to change the labels (<pxref label="_005cnewcommand-_0026-_005crenewcommand"><xrefnodename>\newcommand & -\renewcommand</xrefnodename></pxref>). For instance, to have the first level use uppercase -letters: -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="175">\Alph <r>example</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="224">\enumi</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="225">\enumii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="226">\enumiii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="227">\enumiv</indexterm></findex> +<para>The <code>enumerate</code> environment uses the counters <code>\enumi</code> through +<code>\enumiv</code> counters (<pxref label="Counters"><xrefnodename>Counters</xrefnodename></pxref>). If you use the optional +argument to <code>\item</code> then the counter is not incremented for that +item (<pxref label="_005citem"><xrefnodename>\item</xrefnodename></pxref>). +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="228">\labelenumi</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="229">\labelenumii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="230">\labelenumiii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="231">\labelenumiv</indexterm></findex> +<para>To change the format of the label use <code>\renewcommand</code> +(<pxref label="_005cnewcommand-_0026-_005crenewcommand"><xrefnodename>\newcommand & \renewcommand</xrefnodename></pxref>) on the commands <code>\labelenumi</code> +through <code>\labelenumiv</code>. For instance, this first level list will be +labelled with uppercase letters, in boldface, and without a trailing +period: +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="232">\Alph <r>example</r></indexterm></findex> <example endspaces=" "> -<pre xml:space="preserve">\renewcommand{\labelenumi}{\Alph{enumi}} +<pre xml:space="preserve">\renewcommand{\labelenumi}{\textbf{\Alph{enumi}}} +\begin{enumerate} + \item eI + \item bi: + \item si: +\end{enumerate} </pre></example> +<para>For a list of counter-labelling commands like <code>\Alph</code> see +<ref label="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol"><xrefnodename>\alph \Alph \arabic \roman \Roman \fnsymbol</xrefnodename></ref>. +</para> +<para>For more on customizing the layout see <ref label="list"><xrefnodename>list</xrefnodename></ref>. Also, the package +<file>enumitem</file> is useful for this. +</para> </section> <node name="eqnarray" spaces=" "><nodename>eqnarray</nodename><nodenext automatic="on">equation</nodenext><nodeprev automatic="on">enumerate</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>eqnarray</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="176">eqnarray <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="128">equations, aligning</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="129">aligning equations</indexterm></cindex> - -<cindex index="cp" spaces=" "><indexterm index="cp" number="130">align <r>environment, from <code>amsmath</code></r></indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="131">amsmath <r>package, replacing <code>eqnarray</code></r></indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="132">Madsen, Lars</indexterm></cindex> -<para>First, a caveat: the <code>eqnarray</code> environment has some infelicities -which cannot be overcome; the article &textldquo;Avoid eqnarray!&textrdquo;&noeos; by Lars -Madsen describes them in detail -(<url><urefurl>http://tug.org/TUGboat/tb33-1/tb103madsen.pdf</urefurl></url>). The bottom -line is that it is better to use the <code>align</code> environment (and -others) from the <code>amsmath</code> package. +<findex index="fn" spaces=" "><indexterm index="fn" number="233">eqnarray <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="143">equations, aligning</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="144">aligning equations</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="145">align <r>environment, from <code>amsmath</code></r></indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="146">amsmath <r>package, replacing <code>eqnarray</code></r></indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="147">Madsen, Lars</indexterm></cindex> +<para>First, a caveat: the <code>eqnarray</code> environment is depreciated. It has +infelicities that cannot be overcome, including spacing that is +inconsistent with other mathematics elements (see the article &textldquo;Avoid +eqnarray!&textrdquo;&noeos; by Lars Madsen +<url><urefurl>http://tug.org/TUGboat/tb33-1/tb103madsen.pdf</urefurl></url>). New documents +should include the <file>amsmath</file> package and use the displayed +mathematics environments provided there, such as the <code>align</code> +environment. </para> -<para>Nevertheless, here is a description of <code>eqnarray</code>: +<para>Nevertheless, for completeness and for a reference when working with old +documents, a synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\begin{eqnarray} <r>(or <code>eqnarray*</code>)</r> -<var>formula1</var> \\ -<var>formula2</var> \\ -... +<pre xml:space="preserve">\begin{eqnarray} + <var>first formula left</var> &<var>first formula middle</var> &<var>first formula right</var> \\ + ... \end{eqnarray} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="177">\\ <r>(for <code>eqnarray</code>)</r></indexterm></findex> -<para>The <code>eqnarray</code> environment is used to display a sequence of -equations or inequalities. It is similar to a three-column -<code>array</code> environment, with consecutive rows separated by <code>\\</code> -and consecutive items within a row separated by an <code>&</code>. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="178">\\* <r>(for <code>eqnarray</code>)</r></indexterm></findex> -<para><code>\\*</code> can also be used to separate equations, with its normal -meaning of not allowing a page break at that line. +<para>or </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="179">\nonumber</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="133">equation numbers, omitting</indexterm></cindex> -<para>An equation number is placed on every line unless that line has a -<code>\nonumber</code> command. Alternatively, The <code>*</code>-form of the -environment (<code>\begin{eqnarray*} ... \end{eqnarray*}</code>) will -omit equation numbering entirely, while otherwise being the same as -<code>eqnarray</code>. +<example endspaces=" "> +<pre xml:space="preserve">\begin{eqnarray*} + <var>first formula left</var> &<var>first formula middle</var> &<var>first formula right</var> \\ + ... +\end{eqnarray*} +</pre></example> + +<findex index="fn" spaces=" "><indexterm index="fn" number="234">\\ <r>(for <code>eqnarray</code>)</r></indexterm></findex> +<para>Display a sequence of equations or inequalities. The left and right +sides are typeset in display mode, while the middle is typeset in text +mode. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="180">\lefteqn</indexterm></findex> +<para>It is similar to a three-column <code>array</code> environment, with items +within a row separated by an ampersand (<code>&</code>), and with rows +separated by double backslash <code>\\</code>). +<findex index="fn" spaces=" "><indexterm index="fn" number="235">\\* <r>(for <code>eqnarray</code>)</r></indexterm></findex> +The starred form of line break (<code>\\*</code>) can also be used to separate +equations, and will disallow a page break there (<pxref label="_005c_005c"><xrefnodename>\\</xrefnodename></pxref>). +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="236">\nonumber</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="148">equation numbers, omitting</indexterm></cindex> +<para>The unstarred form <code>eqnarray</code> places an equation number on every +line (using the <code>equation</code> counter), unless that line contains a +<code>\nonumber</code> command. The starred form <code>eqnarray*</code> omits +equation numbering, while otherwise being the same. +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="237">\lefteqn</indexterm></findex> <para>The command <code>\lefteqn</code> is used for splitting long formulas across lines. It typesets its argument in display style flush left in a box of zero width. </para> +<para>This example shows three lines. The first two lines make an inequality, +while the third line has not entry on the left side. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{eqnarray*} + \lefteqn{x_1+x_2+\cdots+x_n} \\ + &\leq &y_1+y_2+\cdots+y_n \\ + &= &z+y_3+\cdots+y_n +\end{eqnarray*} +</pre></example> + </section> <node name="equation" spaces=" "><nodename>equation</nodename><nodenext automatic="on">figure</nodenext><nodeprev automatic="on">eqnarray</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>equation</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="181">equation <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="134">equations, environment for</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="135">formulas, environment for</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="238">equation <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="149">equations, environment for</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="150">formulas, environment for</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> <pre xml:space="preserve">\begin{equation} -<var>math</var> + math text \end{equation} </pre></example> -<para>The <code>equation</code> environment starts a <code>displaymath</code> -environment (<pxref label="displaymath"><xrefnodename>displaymath</xrefnodename></pxref>), e.g., centering the <var>math</var> text -on the page, and also places an equation number in the right margin. +<para>Make a <code>displaymath</code> environment (<pxref label="displaymath"><xrefnodename>displaymath</xrefnodename></pxref>) with an +equation number in the right margin. +</para> +<para>The equation number is generated using the <code>equation</code> counter. +</para> +<para>Note that the <file>amsmath</file> package has extensive displayed equation +facilities. Those facilities are the best approach for such output in +new documents. </para> </section> <node name="figure" spaces=" "><nodename>figure</nodename><nodenext automatic="on">filecontents</nodenext><nodeprev automatic="on">equation</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>figure</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="182">figure</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="136">inserting figures</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="137">figures, inserting</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="239">figure</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="151">inserting figures</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="152">figures, inserting</indexterm></cindex> + +<para>Synopsis: +</para> <example endspaces=" "> -<pre xml:space="preserve">\begin{figure[*]}[<var>placement</var>] -<var>figbody</var> +<pre xml:space="preserve">\begin{figure}[<var>placement</var>] + figure body +\caption[<var>loftitle</var>]{<var>title</var>} \label{<var>label}</var> -\caption[<var>loftitle</var>]{<var>text</var>} \end{figure} </pre></example> -<para>Figures are objects that are not part of the normal text, and are -instead &textldquo;floated&textrdquo; to a convenient place, such as the top of a page. -Figures will not be split between two pages. -</para> -<para>When typesetting in double-columns, the starred form produces a -full-width figure (across both columns). -</para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="138">placement of floats</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="139">specifier, float placement</indexterm></cindex> -<para>The optional argument <code>[placement]</code> determines where &latex; will try -to place your figure. There are four places where &latex; can possibly -put a float: -</para> -<table commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code">t</itemformat></item> -</tableterm><tableitem><para>(Top)&textmdash;at the top of a text page. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">b</itemformat></item> -</tableterm><tableitem><para>(Bottom)&textmdash;at the bottom of a text page. However, <code>b</code> is not -allowed for full-width floats (<code>figure*</code>) with double-column -output. To ameliorate this, use the <code>stfloats</code> or -<code>dblfloatfix</code> package, but see the discussion at caveats in the -FAQ: <url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</urefurl></url>. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">h</itemformat></item> -</tableterm><tableitem><para>(Here)&textmdash;at the position in the text where the <code>figure</code> environment -appears. However, <code>t</code> is not allowed by itself; <code>t</code> is -automatically added. -</para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="140">here, putting floats</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="141"><code>float</code> package</indexterm></cindex> -<para>To absolutely force a figure to appear &textldquo;here&textrdquo;, you can -<code>\usepackage{float}</code> and use the <code>H</code> specifier which it -defines. For further discussion, see the FAQ entry at -<url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</urefurl></url>. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">p</itemformat></item> -</tableterm><tableitem><para>(Page of floats)&textmdash;on a separate float page, which is a page -containing no text, only floats. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">!</itemformat></item> -</tableterm><tableitem><para>Used in addition to one of the above; for this float only, &latex; -ignores the restrictions on both the number of floats that can appear -and the relative amounts of float and non-float text on the page. -The <code>!</code> specifier does <emph>not</emph> mean &textldquo;put the float here&textrdquo;; -see above. -</para> -</tableitem></tableentry></table> - -<para>The standard <code>report</code> and <code>article</code> classes use the default placement -<code>tbp</code>. -</para> -<para>The body of the figure is made up of whatever text, &latex; commands, -etc.&noeos; you wish. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="183">\caption</indexterm></findex> -<para>The <code>\caption</code> command specifies caption <var>text</var> for the -figure. The caption is numbered by default. If <var>loftitle</var> is -present, it is used in the list of figures instead of <var>text</var> -(<pxref label="Tables-of-contents"><xrefnodename>Tables of contents</xrefnodename></pxref>). -</para> -<para>Parameters relating to fractions of pages occupied by float and -non-float text: -</para> -<ftable commandarg="code" spaces=" " endspaces=" "> -<beforefirstitem><findex index="fn" spaces=" "><indexterm index="fn" number="184">\bottomfraction</indexterm></findex> -<para>The maximum fraction of the page allowed to be occupied by floats at -the bottom; default <samp>.3</samp>. -</para> -</beforefirstitem><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="185">\floatpagefraction</indexterm>\floatpagefraction</itemformat></item> -</tableterm><tableitem><para>The minimum fraction of a float page that must be occupied by floats; -default <samp>.5</samp>. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="186">\textfraction</indexterm>\textfraction</itemformat></item> -</tableterm><tableitem><para>Minimum fraction of a page that must be text; if floats take up too -much space to preserve this much text, floats will be moved to a -different page. The default is <samp>.2</samp>. +<para>or </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="187">\topfraction</indexterm>\topfraction</itemformat></item> -</tableterm><tableitem><para>Maximum fraction at the top of a page that may be occupied before -floats; default <samp>.7</samp>. -</para></tableitem></tableentry></ftable> +<example endspaces=" "> +<pre xml:space="preserve">\begin{figure*}[<var>placement</var>] + figure body +\caption[<var>loftitle</var>]{<var>title</var>} +\label{<var>label}</var> +\end{figure*} +</pre></example> -<para>Parameters relating to vertical space around floats: +<para>A class of floats (<pxref label="Floats"><xrefnodename>Floats</xrefnodename></pxref>). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are &textldquo;floated&textrdquo; to a convenient place, such as the top of a following +page. </para> -<ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="188">\floatsep</indexterm>\floatsep</itemformat></item> -</tableterm><tableitem><para>Space between floats at the top or bottom of a page; default -<samp>12pt plus2pt minus2pt</samp>. +<para>For the possible values of <var>placement</var> and their effect on the +float placement algorithm, see <ref label="Floats"><xrefnodename>Floats</xrefnodename></ref>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="189">\intextsep</indexterm>\intextsep</itemformat></item> -</tableterm><tableitem><para>Space above and below a float in the middle of the main text; default -<samp>12pt plus2pt minus2pt</samp> for <samp>10pt</samp> and <samp>11pt</samp> styles, -<samp>14pt plus4pt minus4pt</samp> for <samp>12pt</samp>. +<para>The starred form <code>figure*</code> is used when a document is in +double-column mode (<pxref label="_005ctwocolumn"><xrefnodename>\twocolumn</xrefnodename></pxref>). It produces a figure that +spans both columns, at the top of the page. To add the possibility of +placing at a page bottom see the discussion of <var>placement</var> <code>b</code> +in <ref label="Floats"><xrefnodename>Floats</xrefnodename></ref>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="190">\textfloatsep</indexterm>\textfloatsep</itemformat></item> -</tableterm><tableitem><para>Space between the last (first) float at the top (bottom) of a page; -default <samp>20pt plus2pt minus4pt</samp>. -</para></tableitem></tableentry></ftable> - -<para>Counters relating to the number of floats on a page: +<para>The figure body is typeset in a <code>parbox</code> of width <code>\textwidth</code> +and so it can contain text, commands, etc. </para> -<ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="191">bottomnumber</indexterm>bottomnumber</itemformat></item> -</tableterm><tableitem><para>Maximum number of floats that can appear at the bottom of a text page; -default 1. +<para>The label is optional; it is used for cross-references (<pxref label="Cross-references"><xrefnodename>Cross +references</xrefnodename></pxref>). +<findex index="fn" spaces=" "><indexterm index="fn" number="240">\caption</indexterm></findex> +The optional <code>\caption</code> command specifies caption text for the +figure. By default it is numbered. If <var>loftitle</var> is present, it is +used in the list of figures instead of <var>title</var> (<pxref label="Tables-of-contents"><xrefnodename>Tables of +contents</xrefnodename></pxref>). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="192">dbltopnumber</indexterm>dbltopnumber</itemformat></item> -</tableterm><tableitem><para>Maximum number of full-sized floats that can appear at the top of a -two-column page; default 2. +<para>This example makes a figure out of a graphic. It requires one of the +packages <file>graphics</file> or <file>graphicx</file>. The graphic, with its +caption, will be placed at the top of a page or, if it is pushed to the +end of the document, on a page of floats. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="193">topnumber</indexterm>topnumber</itemformat></item> -</tableterm><tableitem><para>Maximum number of floats that can appear at the top of a text page; -default 2. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="194">totalnumber</indexterm>totalnumber</itemformat></item> -</tableterm><tableitem><para>Maximum number of floats that can appear on a text page; default 3. -</para></tableitem></tableentry></ftable> +<example endspaces=" "> +<pre xml:space="preserve">\begin{figure}[t] + \centering + \includegraphics[width=0.5\textwidth]{CTANlion.png} + \caption{The CTAN lion, by Duane Bibby} +\end{figure} +</pre></example> -<para>The principal &tex; FAQ entry relating to floats: -<url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</urefurl></url>. -</para> </section> <node name="filecontents" spaces=" "><nodename>filecontents</nodename><nodenext automatic="on">flushleft</nodenext><nodeprev automatic="on">figure</nodeprev><nodeup automatic="on">Environments</nodeup></node> -<section spaces=" "><sectiontitle><code>filecontents</code>: Create external files</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="195">filecontents</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="142">external files, creating</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="143">writing external files</indexterm></cindex> +<section spaces=" "><sectiontitle><code>filecontents</code>: Write an external file</sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="241">filecontents</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="153">external files, writing</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="154">writing external files</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> <pre xml:space="preserve">\begin{filecontents}{<var>filename</var>} -<var>contents-of-file</var> + <var>text</var> \end{filecontents} -... -\documentclass{<var>my-document-class</var>} </pre></example> -<cindex index="cp" spaces=" "><indexterm index="cp" number="144">initial command</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="196">\documentclass, commands before</indexterm></findex> -<para>The <code>filecontents</code> environment is an <dfn>initial command</dfn>, -meaning that it can be used only before the <code>\documentclass</code> -command, as in the synopsis above. -</para> -<para>&latex; will create a file named <var>filename</var> with the content -<var>contents-of-file</var> preceded by a header comment indicating how and -when the file was generated. If the file already exists then nothing will -happen. +<para>or </para> -<para>You can also use the <code>filecontents</code> package, which has the -following advantages: +<example endspaces=" "> +<pre xml:space="preserve">\begin{filecontents*}{<var>filename</var>} + <var>text</var> +\end{filecontents*} +</pre></example> + +<para>Create a file named <var>filename</var> and fill it with <var>text</var>. The +unstarred version of the environment <code>filecontents</code> prefixes the +content of the created file with a header; see the example below. The +starred version <code>filecontents*</code> does not include the header. </para> -<itemize commandarg="bullet" endspaces=" "> -<listitem><prepend>•</prepend> -<para>If the file already exists, then it will be overwritten. +<para>This environment can be used anywhere in the preamble, although it often +appears before the <code>\documentclass</code> command. It is typically used +when a source file requires a nonstandard style or class file. The +environment will write that file to the directory containing the source +and thus make the source file self-contained. Another use is to include +<code>bib</code> references in the file, again to make it self-contained. </para> -</listitem><listitem><prepend>•</prepend> -<para>You can use the <code>filecontents</code> environment at any point after the -declaration <code>\usepackage{filecontents}</code>, not just before -<code>\documentclass</code>. +<para>The environment checks whether a file of that name already exists and if +so, does not do anything. There is a <file>filecontents</file> package that +redefines the <code>filecontents</code> environment so that instead of doing +nothing in that case, it will overwrite the existing file. </para> -</listitem><listitem><prepend>•</prepend> -<para>The <code>filecontents</code> package also provides a <code>filecontents*</code> -environment which is used in the same way as the <code>filecontents</code> -environment except that it won&textrsquo;t insert any leading comment, so it is -better suited to create files which aren&textrsquo;t in &latex; format. +<para>For example, this document </para> -</listitem></itemize> +<example endspaces=" "> +<pre xml:space="preserve">\documentclass{article} +\begin{filecontents}{JH.sty} +\newcommand{\myname}{Jim Hef{}feron} +\end{filecontents} +\usepackage{JH} +\begin{document} +Article by \myname. +\end{document} +</pre></example> -<para>The <code>filecontents</code> environment only creates the file, and is -unrelated to using the created file. So you need to use, for -instance, <code>\input</code> or <code>\usepackage</code> or <code>\bibliography</code> -or whatever is applicable, to use the created file. -</para> -<para>This environment is also useful to make a document in a self-contained -file, for example, for a bug report, or to keep the content of a -<file>.bib</file> file in the same file as the main document. +<para>produces this file <file>JH.sty</file>. </para> +<example endspaces=" "> +<pre xml:space="preserve">%% LaTeX2e file `JH.sty' +%% generated by the `filecontents' environment +%% from source `test' on 2015/10/12. +%% +\newcommand{\myname}{Jim Hef{}feron} +</pre></example> + </section> <node name="flushleft" spaces=" "><nodename>flushleft</nodename><nodenext automatic="on">flushright</nodenext><nodeprev automatic="on">filecontents</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>flushleft</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="197">flushleft <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="145">left-justifying text, environment for</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="146">ragged right text, environment for</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="242">flushleft <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="155">left-justifying text, environment for</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="156">ragged right text, environment for</indexterm></cindex> <example endspaces=" "> <pre xml:space="preserve">\begin{flushleft} @@ -1979,10 +2684,10 @@ file, for example, for a bug report, or to keep the content of a \end{flushleft} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="198">\\ <r>for <code>flushleft</code></r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="243">\\ <r>for <code>flushleft</code></r></indexterm></findex> <para>The <code>flushleft</code> environment allows you to create a paragraph consisting of lines that are flush to the left-hand margin and ragged -right Each line must be terminated with the string <code>\\</code>. +right. Each line must be terminated with the string <code>\\</code>. </para> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\raggedright</menunode><menudescription><pre xml:space="preserve">Declaration form of the <code>flushleft</code> environment. @@ -1991,10 +2696,11 @@ right Each line must be terminated with the string <code>\\</code>. <node name="_005craggedright" spaces=" "><nodename>\raggedright</nodename><nodeup automatic="on">flushleft</nodeup></node> <subsection spaces=" "><sectiontitle><code>\raggedright</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="199">\raggedright</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="147">ragged right text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="148">left-justifying text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="149">justification, ragged right</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="244">\raggedright</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="157">ragged right text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="158">left-justifying text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="159">justification, ragged right</indexterm></cindex> <para>The <code>\raggedright</code> declaration corresponds to the <code>flushleft</code> environment. This declaration can be used inside an @@ -2011,9 +2717,10 @@ command that ends the paragraph unit. </section> <node name="flushright" spaces=" "><nodename>flushright</nodename><nodenext automatic="on">itemize</nodenext><nodeprev automatic="on">flushleft</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>flushright</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="200">flushright <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="150">ragged left text, environment for</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="151">right-justifying text, environment for</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="245">flushright <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="160">ragged left text, environment for</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="161">right-justifying text, environment for</indexterm></cindex> <example endspaces=" "> <pre xml:space="preserve">\begin{flushright} @@ -2023,10 +2730,10 @@ command that ends the paragraph unit. \end{flushright} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="201">\\ (for <code>flushright</code>)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="246">\\ (for <code>flushright</code>)</indexterm></findex> <para>The <code>flushright</code> environment allows you to create a paragraph consisting of lines that are flush to the right-hand margin and ragged -left. Each line must be terminated with the string <code>\\</code>. +left. Each line must be terminated with the control sequence <code>\\</code>. </para> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\raggedleft</menunode><menudescription><pre xml:space="preserve">Declaration form of the <code>flushright</code> environment. @@ -2035,10 +2742,11 @@ left. Each line must be terminated with the string <code>\\</code>. <node name="_005craggedleft" spaces=" "><nodename>\raggedleft</nodename><nodeup automatic="on">flushright</nodeup></node> <subsection spaces=" "><sectiontitle><code>\raggedleft</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="202">\raggedleft</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="152">ragged left text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="153">justification, ragged left</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="154">right-justifying text</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="247">\raggedleft</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="162">ragged left text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="163">justification, ragged left</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="164">right-justifying text</indexterm></cindex> <para>The <code>\raggedleft</code> declaration corresponds to the <code>flushright</code> environment. This declaration can be used inside an @@ -2055,11 +2763,12 @@ command that ends the paragraph unit. </section> <node name="itemize" spaces=" "><nodename>itemize</nodename><nodenext automatic="on">letter</nodenext><nodeprev automatic="on">flushright</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>itemize</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="203">itemize <r>environment</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="204">\item</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="155">lists of items</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="156">unordered lists</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="157">bulleted lists</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="248">itemize <r>environment</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="249">\item</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="165">lists of items</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="166">unordered lists</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="167">bulleted lists</indexterm></cindex> <para>Synopsis: </para> @@ -2088,10 +2797,10 @@ There must be at least one <code>\item</code> command within the environment. </para></listitem><listitem spaces=" "><para>. (centered dot, rendered here as a period) </para></listitem></enumerate> -<findex index="fn" spaces=" "><indexterm index="fn" number="205">\labelitemi</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="206">\labelitemii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="207">\labelitemiii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="208">\labelitemiv</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="250">\labelitemi</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="251">\labelitemii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="252">\labelitemiii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="253">\labelitemiv</indexterm></findex> <para>The <code>itemize</code> environment uses the commands <code>\labelitemi</code> through <code>\labelitemiv</code> to produce the default label. So, you can use <code>\renewcommand</code> to change the labels. For instance, to have @@ -2101,13 +2810,13 @@ the first level use diamonds: <pre xml:space="preserve">\renewcommand{\labelitemi}{$\diamond$} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="209">\leftmargin</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="210">\leftmargini</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="211">\leftmarginii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="212">\leftmarginiii</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="213">\leftmarginiv</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="214">\leftmarginv</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="215">\leftmarginvi</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="254">\leftmargin</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="255">\leftmargini</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="256">\leftmarginii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="257">\leftmarginiii</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="258">\leftmarginiv</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="259">\leftmarginv</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="260">\leftmarginvi</indexterm></findex> <para>The <code>\leftmargini</code> through <code>\leftmarginvi</code> parameters define the distance between the left margin of the enclosing environment and the left margin of the list. By convention, <code>\leftmargin</code> is set @@ -2126,20 +2835,20 @@ This example greatly reduces the margin space for outermost lists: <para>Some parameters that affect list formatting: </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="216">\itemindent</indexterm>\itemindent</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="261">\itemindent</indexterm>\itemindent</itemformat></item> </tableterm><tableitem><para>Extra indentation before each item in a list; default zero. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="217">\labelsep</indexterm>\labelsep</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="262">\labelsep</indexterm>\labelsep</itemformat></item> </tableterm><tableitem><para>Space between the label and text of an item; default <samp>.5em</samp>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="218">\labelwidth</indexterm>\labelwidth</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="263">\labelwidth</indexterm>\labelwidth</itemformat></item> </tableterm><tableitem><para>Width of the label; default <samp>2em</samp>, or <samp>1.5em</samp> in two-column mode. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="219">\listparindent</indexterm>\listparindent</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="264">\listparindent</indexterm>\listparindent</itemformat></item> </tableterm><tableitem><para>Extra indentation added to second and subsequent paragraphs within a list item; default <samp>0pt</samp>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="220">\rightmargin</indexterm>\rightmargin</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="265">\rightmargin</indexterm>\rightmargin</itemformat></item> </tableterm><tableitem><para>Horizontal distance between the right margin of the list and the enclosing environment; default <samp>0pt</samp>, except in the <code>quote</code>, <code>quotation</code>, and <code>verse</code> environments, where it is set equal @@ -2151,23 +2860,23 @@ to <code>\leftmargin</code>. loose, by default). </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="221">\itemsep</indexterm>\itemsep</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="266">\itemsep</indexterm>\itemsep</itemformat></item> </tableterm><tableitem><para>Vertical space between items. The default is <code>2pt plus1pt minus1pt</code> for <code>10pt</code> documents, <code>3pt plus2pt minus1pt</code> for <code>11pt</code>, and <code>4.5pt plus2pt minus1pt</code> for <code>12pt</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="222">\parsep</indexterm>\parsep</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="267">\parsep</indexterm>\parsep</itemformat></item> </tableterm><tableitem><para>Extra vertical space between paragraphs within a list item. Defaults are the same as <code>\itemsep</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="223">\topsep</indexterm>\topsep</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="268">\topsep</indexterm>\topsep</itemformat></item> </tableterm><tableitem><para>Vertical space between the first item and the preceding paragraph. For top-level lists, the default is <code>8pt plus2pt minus4pt</code> for <code>10pt</code> documents, <code>9pt plus3pt minus5pt</code> for <code>11pt</code>, and <code>10pt plus4pt minus6pt</code> for <code>12pt</code>. These are reduced for nested lists. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="224">\partopsep</indexterm>\partopsep</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="269">\partopsep</indexterm>\partopsep</itemformat></item> </tableterm><tableitem><para>Extra space added to <code>\topsep</code> when the list environment starts a paragraph. The default is <code>2pt plus1pt minus1pt</code> for <code>10pt</code> documents, <code>3pt plus1pt minus1pt</code> for <code>11pt</code>, and <code>3pt @@ -2175,7 +2884,7 @@ plus2pt minus2pt</code> for <code>12pt</code>. </para> </tableitem></tableentry></ftable> -<findex index="fn" spaces=" "><indexterm index="fn" number="225">\parskip <r>example</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="270">\parskip <r>example</r></indexterm></findex> <para>Especially for lists with short items, it may be desirable to elide space between items. Here is an example defining an <code>itemize*</code> environment with no extra spacing between items, or between paragraphs @@ -2195,7 +2904,8 @@ within a single item (<code>\parskip</code> is not list-specific, </section> <node name="letter" spaces=" "><nodename>letter</nodename><nodenext automatic="on">list</nodenext><nodeprev automatic="on">itemize</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>letter</code> environment: writing letters</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="226">letter</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="271">letter <r>environment</r></indexterm></findex> <para>This environment is used for creating letters. <xref label="Letters"><xrefnodename>Letters</xrefnodename></xref>. </para> @@ -2203,8 +2913,9 @@ within a single item (<code>\parskip</code> is not list-specific, </section> <node name="list" spaces=" "><nodename>list</nodename><nodenext automatic="on">math</nodenext><nodeprev automatic="on">letter</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>list</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="227">list</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="158">lists of items, generic</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="272">list</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="168">lists of items, generic</indexterm></cindex> <para>The <code>list</code> environment is a generic environment which is used for defining many of the more specific environments. It is seldom used in @@ -2230,13 +2941,58 @@ empty, i.e., <code>{}</code>, which leaves the default spacing. <para>The width used for typesetting the list items is specified by <code>\linewidth</code> (<pxref label="Page-layout-parameters"><xrefnodename>Page layout parameters</xrefnodename></pxref>). </para> +<menu endspaces=" "> +<menuentry leadingtext="* "><menunode separator=":: ">\item</menunode><menudescription><pre xml:space="preserve">An entry in a list. +</pre></menudescription></menuentry></menu> + + +<node name="_005citem" spaces=" "><nodename>\item</nodename><nodeup automatic="on">list</nodeup></node> + +<para>Synopsis: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\item text of item +</pre></example> + +<para>or +</para><example endspaces=" "> +<pre xml:space="preserve">\item[<var>optional label</var>] text of item +</pre></example> + +<para>An entry in a list. The entries are prefixed by a label, whose default +depends on the list type. +</para> +<para>Because the optional argument <var>optional label</var> is surrounded by +square brackets (<code>[</code> and <code>]</code>), to use square brackets +inside the optional argument you must hide them inside curly braces, as +in <code>\item[Close square bracket, {]}]</code>. Similarly, to use an open +square bracket as first character in the text of the item, also hide it +inside curly braces. <xref label="LaTeX-command-syntax"><xrefnodename>&latex; command syntax</xrefnodename></xref>. +</para> +<para>In this example the <code>enumerate</code> list has two items that use the +default label and one that uses the optional label. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{enumerate} + \item Moe + \item[sometimes] Shemp + \item Larry +\end{enumerate} +</pre></example> + +<para>The first item is labelled <samp>1.</samp>, the second item is labelled +<samp>sometimes</samp>, and the third item is labelled <samp>2.</samp> (note that, +because of the optional label in the second item, the third item does +not get a <samp>3.</samp>). +</para> + </section> <node name="math" spaces=" "><nodename>math</nodename><nodenext automatic="on">minipage</nodenext><nodeprev automatic="on">list</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>math</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="228">math <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="159">in-line formulas</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="273">math <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="169">in-line formulas</indexterm></cindex> <para>Synopsis: </para> @@ -2247,7 +3003,7 @@ empty, i.e., <code>{}</code>, which leaves the default spacing. </pre></example> <para>The <code>math</code> environment inserts the given <var>math</var> within the -running text. <code>\(...\))</code> and <code>$...$</code> are synonyms. +running text. <code>\(...\)</code> and <code>$...$</code> are synonyms. <xref label="Math-formulas"><xrefnodename>Math formulas</xrefnodename></xref>. </para> @@ -2255,8 +3011,8 @@ running text. <code>\(...\))</code> and <code>$...$</code> are synonyms. <node name="minipage" spaces=" "><nodename>minipage</nodename><nodenext automatic="on">picture</nodenext><nodeprev automatic="on">math</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>minipage</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="229">minipage <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="160">minipage, creating a</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="274">minipage <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="170">minipage, creating a</indexterm></cindex> <example endspaces=" "> <pre xml:space="preserve">\begin{minipage}[<var>position</var>][<var>height</var>][<var>inner-pos</var>]{<var>width</var>} @@ -2272,15 +3028,15 @@ other paragraph-making environments can be used inside a minipage. <!-- c (xxref positions) --> <para>The arguments are the same as for <code>\parbox</code> (<pxref label="_005cparbox"><xrefnodename>\parbox</xrefnodename></pxref>). </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="161">indentation of paragraphs, in minipage</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="162">paragraph indentation, in minipage</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="230">\parindent</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="171">indentation of paragraphs, in minipage</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="172">paragraph indentation, in minipage</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="275">\parindent</indexterm></findex> <para>By default, paragraphs are not indented in the <code>minipage</code> environment. You can restore indentation with a command such as <code>\setlength{\parindent}{1pc}</code> command. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="163">footnotes in figures</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="164">figures, footnotes in</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="173">footnotes in figures</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="174">figures, footnotes in</indexterm></cindex> <para>Footnotes in a <code>minipage</code> environment are handled in a way that is particularly useful for putting footnotes in figures or tables. A <code>\footnote</code> or <code>\footnotetext</code> command puts the footnote at @@ -2293,20 +3049,20 @@ footnotes; they may wind up at the bottom of the wrong minipage. </para> </section> -<node name="picture" spaces=" "><nodename>picture</nodename><nodenext automatic="on">quotation</nodenext><nodeprev automatic="on">minipage</nodeprev><nodeup automatic="on">Environments</nodeup></node> +<node name="picture" spaces=" "><nodename>picture</nodename><nodenext automatic="on">quotation and quote</nodenext><nodeprev automatic="on">minipage</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>picture</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="231">picture</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="165">creating pictures</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="166">pictures, creating</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="276">picture</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="175">creating pictures</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="176">pictures, creating</indexterm></cindex> <example endspaces=" "> -<pre xml:space="preserve">\begin{picture}(width,height)(x offset,y offset) +<pre xml:space="preserve">\begin{picture}(<var>width</var>,<var>height</var>)(<var>xoffset</var>,<var>yoffset</var>) &dots; <var>picture commands</var> &dots; \end{picture} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="232">\unitlength</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="277">\unitlength</indexterm></findex> <para>The <code>picture</code> environment allows you to create just about any kind of picture you want containing text, lines, arrows and circles. You tell &latex; where to put things in the picture by specifying @@ -2321,22 +3077,23 @@ centimeters. <code>\setlength</code> command, outside of a <code>picture</code> environment. The default value is <code>1pt</code>. </para> -<para>A position is a pair of coordinates, such as <code>(2.4,-5)</code>, specifying +<cindex index="cp" spaces=" "><indexterm index="cp" number="177">position, in picture</indexterm></cindex> +<para>A <dfn>position</dfn> is a pair of coordinates, such as <code>(2.4,-5)</code>, specifying the point with x-coordinate <code>2.4</code> and y-coordinate <code>-5</code>. Coordinates are specified in the usual way with respect to an origin, which is normally at the lower-left corner of the picture. Note that when a position appears as an argument, it is not enclosed in braces; the parentheses serve to delimit the argument. </para> -<para>The <code>picture</code> environment has one mandatory argument, which is a -<code>position</code>. It specifies the size of the picture. The environment -produces a rectangular box with width and height determined by this -argument&textrsquo;s x- and y-coordinates. +<para>The <code>picture</code> environment has one mandatory argument which is a +position (<var>width</var>,<var>height</var>), which specifies the size of the +picture. The environment produces a rectangular box with these +<var>width</var> and <var>height</var>. </para> -<para>The <code>picture</code> environment also has an optional <code>position</code> -argument, following the <code>size</code> argument, that can change the -origin. (Unlike ordinary optional arguments, this argument is not -contained in square brackets.) The optional argument gives the +<para>The <code>picture</code> environment also has an optional position argument +(<var>xoffset</var>,<var>yoffset</var>), following the size argument, that can +change the origin. (Unlike ordinary optional arguments, this argument +is not contained in square brackets.) The optional argument gives the coordinates of the point at the lower-left corner of the picture (thereby determining the origin). For example, if <code>\unitlength</code> has been set to <code>1mm</code>, the command @@ -2370,7 +3127,7 @@ command. The command picture, with its reference point at coordinates <math>(11.3,-.3)</math>. The reference points for various objects will be described below. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="233">lR box</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="278">lR box</indexterm></findex> <para>The <code>\put</code> command creates an <dfn>LR box</dfn>. You can put anything that can go in an <code>\mbox</code> (<pxref label="_005cmbox"><xrefnodename>\mbox</xrefnodename></pxref>) in the text argument of the <code>\put</code> command. When you do this, the reference point will @@ -2398,10 +3155,12 @@ be the lower left corner of the box. <node name="_005ccircle" spaces=" "><nodename>\circle</nodename><nodenext automatic="on">\makebox (picture)</nodenext><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\circle</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="234">\circle</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="279">\circle</indexterm></findex> <para>Synopsis: -</para><example endspaces=" "> +</para> +<example endspaces=" "> <pre xml:space="preserve">\circle[*]{<var>diameter</var>} </pre></example> @@ -2415,10 +3174,12 @@ draws a solid circle. </subsection> <node name="_005cmakebox-_0028picture_0029" spaces=" "><nodename>\makebox (picture)</nodename><nodenext automatic="on">\framebox (picture)</nodenext><nodeprev automatic="on">\circle</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\makebox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="235">\makebox <r>(for <code>picture</code>)</r></indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="280">\makebox <r>(for <code>picture</code>)</r></indexterm></findex> <para>Synopsis: -</para><example endspaces=" "> +</para> +<example endspaces=" "> <pre xml:space="preserve">\makebox(<var>width</var>,<var>height</var>)[<var>position</var>]{<var>text</var>} </pre></example> @@ -2450,7 +3211,8 @@ your <var>text</var> appears in. You may select up to two of the following: </subsection> <node name="_005cframebox-_0028picture_0029" spaces=" "><nodename>\framebox (picture)</nodename><nodenext automatic="on">\dashbox</nodenext><nodeprev automatic="on">\makebox (picture)</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\framebox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="236">\framebox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="281">\framebox</indexterm></findex> <para>Synopsis: </para> @@ -2462,8 +3224,8 @@ your <var>text</var> appears in. You may select up to two of the following: section), except that it puts a frame around the outside of the box that it creates. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="237">\fboxrule</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="238">\fboxsep</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="282">\fboxrule</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="283">\fboxsep</indexterm></findex> <para>The <code>\framebox</code> command produces a rule of thickness <code>\fboxrule</code>, and leaves a space <code>\fboxsep</code> between the rule and the contents of the box. @@ -2473,7 +3235,7 @@ and the contents of the box. <node name="_005cdashbox" spaces=" "><nodename>\dashbox</nodename><nodenext automatic="on">\frame</nodenext><nodeprev automatic="on">\framebox (picture)</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\dashbox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="239">\dashbox</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="284">\dashbox</indexterm></findex> <para>Draws a box with a dashed line. Synopsis: </para> @@ -2493,7 +3255,8 @@ multiples of the <var>dlen</var>. </subsection> <node name="_005cframe" spaces=" "><nodename>\frame</nodename><nodenext automatic="on">\line</nodenext><nodeprev automatic="on">\dashbox</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\frame</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="240">\frame</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="285">\frame</indexterm></findex> <para>Synopsis: </para> @@ -2509,7 +3272,8 @@ space is put between the frame and the object. </subsection> <node name="_005cline" spaces=" "><nodename>\line</nodename><nodenext automatic="on">\linethickness</nodenext><nodeprev automatic="on">\frame</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\line</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="241">\line</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="286">\line</indexterm></findex> <para>Synopsis: </para> @@ -2520,8 +3284,8 @@ space is put between the frame and the object. <para>The <code>\line</code> command draws a line with the given <var>length</var> and slope <var>xslope</var>/<var>yslope</var>. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="167"><code>pict2e</code> package</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="168">graphics packages</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="178"><code>pict2e</code> package</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="179">graphics packages</indexterm></cindex> <para>Standard &latex; can only draw lines with <math><var>slope</var> = x/y</math>, where <math>x</math> and <math>y</math> have integer values from −6 through 6. For lines of any slope, and plenty of other shapes, @@ -2531,7 +3295,8 @@ see <code>pict2e</code> and many other packages on CTAN. </subsection> <node name="_005clinethickness" spaces=" "><nodename>\linethickness</nodename><nodenext automatic="on">\thicklines</nodenext><nodeprev automatic="on">\line</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\linethickness</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="242">\linethickness</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="287">\linethickness</indexterm></findex> <para>The <code>\linethickness{<var>dim</var>}</code> command declares the thickness of horizontal and vertical lines in a picture environment to be @@ -2544,7 +3309,8 @@ circles, or the quarter circles drawn by <code>\oval</code>. </subsection> <node name="_005cthicklines" spaces=" "><nodename>\thicklines</nodename><nodenext automatic="on">\thinlines</nodenext><nodeprev automatic="on">\linethickness</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\thicklines</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="243">\thicklines</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="288">\thicklines</indexterm></findex> <para>The <code>\thicklines</code> command is an alternate line thickness for horizontal and vertical lines in a picture environment; @@ -2554,7 +3320,8 @@ cf. <ref label="_005clinethickness"><xrefnodename>\linethickness</xrefnoden </subsection> <node name="_005cthinlines" spaces=" "><nodename>\thinlines</nodename><nodenext automatic="on">\multiput</nodenext><nodeprev automatic="on">\thicklines</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\thinlines</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="244">\thinlines</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="289">\thinlines</indexterm></findex> <para>The <code>\thinlines</code> command is the default line thickness for horizontal and vertical lines in a picture environment; @@ -2564,10 +3331,12 @@ cf. <ref label="_005clinethickness"><xrefnodename>\linethickness</xrefnoden </subsection> <node name="_005cmultiput" spaces=" "><nodename>\multiput</nodename><nodenext automatic="on">\oval</nodenext><nodeprev automatic="on">\thinlines</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\multiput</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="245">\multiput</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="290">\multiput</indexterm></findex> <para>Synopsis: -</para><example endspaces=" "> +</para> +<example endspaces=" "> <pre xml:space="preserve">\multiput(<var>x</var>,<var>y</var>)(<var>delta_x</var>,<var>delta_y</var>){<var>n</var>}{<var>obj</var>} </pre></example> @@ -2580,7 +3349,8 @@ pattern across a picture. <var>obj</var> is first placed at position </subsection> <node name="_005coval" spaces=" "><nodename>\oval</nodename><nodenext automatic="on">\put</nodenext><nodeprev automatic="on">\multiput</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\oval</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="246">\oval</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="291">\oval</indexterm></findex> <para>Synopsis: </para> @@ -2588,21 +3358,24 @@ pattern across a picture. <var>obj</var> is first placed at position <pre xml:space="preserve">\oval(<var>width</var>,<var>height</var>)[<var>portion</var>] </pre></example> -<para>The <code>\oval</code> command produces a rectangle with rounded corners. -The optional argument <var>portion</var> allows you to select part of the +<para>The <code>\oval</code> command produces a rectangle with rounded corners. The +optional argument <var>portion</var> allows you to produce only half of the oval via the following: </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">t</itemformat></item> -</tableterm><tableitem><para>selects the top portion; +</tableterm><tableitem><para>selects the top half; </para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">b</itemformat></item> -</tableterm><tableitem><para>selects the bottom portion; +</tableterm><tableitem><para>selects the bottom half; </para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">r</itemformat></item> -</tableterm><tableitem><para>selects the right portion; +</tableterm><tableitem><para>selects the right half; </para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">l</itemformat></item> -</tableterm><tableitem><para>selects the left portion. +</tableterm><tableitem><para>selects the left half. </para></tableitem></tableentry></table> +<para>It is also possible to produce only one quarter of the oval by setting +<var>portion</var> to <code>tr</code>, <code>br</code>, <code>bl</code>, or <code>tl</code>. +</para> <para>The &textldquo;corners&textrdquo; of the oval are made with quarter circles with a maximum radius of 20<dmn>pt</dmn>, so large &textldquo;ovals&textrdquo; will look more like boxes with rounded corners. @@ -2611,7 +3384,8 @@ boxes with rounded corners. </subsection> <node name="_005cput" spaces=" "><nodename>\put</nodename><nodenext automatic="on">\shortstack</nodenext><nodeprev automatic="on">\oval</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\put</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="247">\put</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="292">\put</indexterm></findex> <para>Synopsis: </para> @@ -2627,7 +3401,8 @@ boxes with rounded corners. </subsection> <node name="_005cshortstack" spaces=" "><nodename>\shortstack</nodename><nodenext automatic="on">\vector</nodenext><nodeprev automatic="on">\put</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\shortstack</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="248">\shortstack</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="293">\shortstack</indexterm></findex> <para>Synopsis: </para> @@ -2647,14 +3422,15 @@ positions are: </tableterm><tableitem><para>Move the objects to the centre of the stack (default) </para></tableitem></tableentry></table> -<findex index="fn" spaces=" "><indexterm index="fn" number="249">\\ <r>(for <code>\shortstack</code> objects)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="294">\\ <r>(for <code>\shortstack</code> objects)</r></indexterm></findex> <para>Objects are separated with <code>\\</code>. </para> </subsection> <node name="_005cvector" spaces=" "><nodename>\vector</nodename><nodeprev automatic="on">\shortstack</nodeprev><nodeup automatic="on">picture</nodeup></node> <subsection spaces=" "><sectiontitle><code>\vector</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="250">\vector</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="295">\vector</indexterm></findex> <para>Synopsis: </para> @@ -2669,13 +3445,17 @@ values must lie between −4 and +4, inclusive. </subsection> </section> -<node name="quotation" spaces=" "><nodename>quotation</nodename><nodenext automatic="on">quote</nodenext><nodeprev automatic="on">picture</nodeprev><nodeup automatic="on">Environments</nodeup></node> -<section spaces=" "><sectiontitle><code>quotation</code></sectiontitle> +<node name="quotation-and-quote" spaces=" "><nodename>quotation and quote</nodename><nodenext automatic="on">tabbing</nodenext><nodeprev automatic="on">picture</nodeprev><nodeup automatic="on">Environments</nodeup></node> +<section spaces=" "><sectiontitle><code>quotation</code> and <code>quote</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="251">quotation</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="169">quoted text with paragraph indentation, displaying</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="170">displaying quoted text with paragraph indentation</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="171">paragraph indentations in quoted text</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="296">quotation</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="180">quoted text with paragraph indentation, displaying</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="181">displaying quoted text with paragraph indentation</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="182">paragraph indentations in quoted text</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="297">quote</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="183">quoted text without paragraph indentation, displaying</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="184">displaying quoted text without paragraph indentation</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="185">paragraph indentations in quoted text, omitting</indexterm></cindex> <para>Synopsis: </para> @@ -2685,24 +3465,7 @@ values must lie between −4 and +4, inclusive. \end{quotation} </pre></example> -<para>The margins of the <code>quotation</code> environment are indented on both -the left and the right. The text is justified at both margins. -Leaving a blank line between text produces a new paragraph. -</para> -<para>Unlike the <code>quote</code> environment, each paragraph is indented -normally. -</para> - -</section> -<node name="quote" spaces=" "><nodename>quote</nodename><nodenext automatic="on">tabbing</nodenext><nodeprev automatic="on">quotation</nodeprev><nodeup automatic="on">Environments</nodeup></node> -<section spaces=" "><sectiontitle><code>quote</code></sectiontitle> - -<findex index="fn" spaces=" "><indexterm index="fn" number="252">quote</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="172">quoted text without paragraph indentation, displaying</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="173">displaying quoted text without paragraph indentation</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="174">paragraph indentations in quoted text, omitting</indexterm></cindex> - -<para>Synopsis: +<para>or </para> <example endspaces=" "> <pre xml:space="preserve">\begin{quote} @@ -2710,21 +3473,39 @@ normally. \end{quote} </pre></example> -<para>The margins of the <code>quote</code> environment are indented on both the -left and the right. The text is justified at both margins. Leaving a -blank line between text produces a new paragraph. +<para>Include a quotation. +</para> +<para>In both environments, margins are indented on both sides by +<code>\leftmargin</code> and the text is justified at both. As with the main +text, leaving a blank line produces a new paragraph. </para> -<para>Unlike the <code>quotation</code> environment, paragraphs are not indented. +<para>To compare the two: in the <code>quotation</code> environment, paragraphs are +indented by 1.5<dmn>em</dmn> and the space between paragraphs is small, +<code>0pt plus 1pt</code>. In the <code>quote</code> environment, paragraphs are +not indented and there is vertical space between paragraphs (it is the +rubber length <code>\parsep</code>). Thus, the <code>quotation</code> environment +may be more suitable for documents where new paragraphs are marked by an +indent rather than by a vertical separation. In addition, <code>quote</code> +may be more suitable for a short quotation or a sequence of short +quotations. </para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{quotation} +\it Four score and seven years ago + .. shall not perish from the earth. +\hspace{1em plus 1fill}---Abraham Lincoln +\end{quotation} +</pre></example> + </section> -<node name="tabbing" spaces=" "><nodename>tabbing</nodename><nodenext automatic="on">table</nodenext><nodeprev automatic="on">quote</nodeprev><nodeup automatic="on">Environments</nodeup></node> +<node name="tabbing" spaces=" "><nodename>tabbing</nodename><nodenext automatic="on">table</nodenext><nodeprev automatic="on">quotation and quote</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>tabbing</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="253">tabbing <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="175">tab stops, using</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="176">lining text up using tab stops</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="177">alignment via tabbing</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="298">tabbing <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="186">tab stops, using</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="187">lining text up using tab stops</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="188">alignment via tabbing</indexterm></cindex> <para>Synopsis: </para> @@ -2747,37 +3528,37 @@ environment. <para>The following commands can be used inside a <code>tabbing</code> environment: </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="254">\\ <r>(tabbing)</r></indexterm>\\ <r>(tabbing)</r></itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="299">\\ <r>(tabbing)</r></indexterm>\\ <r>(tabbing)</r></itemformat></item> </tableterm><tableitem><para>End a line. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="255">\= <r>(tabbing)</r></indexterm>\= <r>(tabbing)</r></itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="300">\= <r>(tabbing)</r></indexterm>\= <r>(tabbing)</r></itemformat></item> </tableterm><tableitem><para>Sets a tab stop at the current position. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="256">\> <r>(tabbing)</r></indexterm>\> <r>(tabbing)</r></itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="257">\></indexterm></findex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="301">\> <r>(tabbing)</r></indexterm>\> <r>(tabbing)</r></itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="302">\></indexterm></findex> <para>Advances to the next tab stop. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="258">\<</indexterm>\<</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="303">\<</indexterm>\<</itemformat></item> </tableterm><tableitem><para>Put following text to the left of the local margin (without changing the margin). Can only be used at the start of the line. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="259">\+</indexterm>\+</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="304">\+</indexterm>\+</itemformat></item> </tableterm><tableitem><para>Moves the left margin of the next and all the following commands one tab stop to the right, beginning tabbed line if necessary. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="260">\-</indexterm>\-</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="305">\-</indexterm>\-</itemformat></item> </tableterm><tableitem><para>Moves the left margin of the next and all the following commands one tab stop to the left, beginning tabbed line if necessary. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="261">\&textrsquo; <r>(tabbing)</r></indexterm>\' <r>(tabbing)</r></itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="306">\&textrsquo; <r>(tabbing)</r></indexterm>\' <r>(tabbing)</r></itemformat></item> </tableterm><tableitem><para>Moves everything that you have typed so far in the -current column, i.e. everything from the most recent <code>\></code>, +current column, i.e., everything from the most recent <code>\></code>, <code>\<</code>, <code>\'</code>, <code>\\</code>, or <code>\kill</code> command, to the right of the previous column, flush against the current column&textrsquo;s tab stop. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="262">\&textlsquo; <r>(tabbing)</r></indexterm>\` <r>(tabbing)</r></itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="307">\&textlsquo; <r>(tabbing)</r></indexterm>\` <r>(tabbing)</r></itemformat></item> </tableterm><tableitem><para>Allows you to put text flush right against any tab stop, including tab stop 0. However, it can&textrsquo;t move text to the right of the last column because there&textrsquo;s no tab stop there. The <code>\`</code> command moves all the @@ -2786,29 +3567,29 @@ command that ends the line, to the right margin of the tabbing environment. There must be no <code>\></code> or <code>\'</code> command between the <code>\`</code> and the command that ends the line. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="263">\a <r>(tabbing)</r></indexterm>\a <r>(tabbing)</r></itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="264">\a&textrsquo; <r>(acute accent in tabbing)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="265">\a&textlsquo; <r>(grave accent in tabbing)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="266">\a= <r>(macron accent in tabbing)</r></indexterm></findex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="308">\a <r>(tabbing)</r></indexterm>\a <r>(tabbing)</r></itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="309">\a&textrsquo; <r>(acute accent in tabbing)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="310">\a&textlsquo; <r>(grave accent in tabbing)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="311">\a= <r>(macron accent in tabbing)</r></indexterm></findex> <para>In a <code>tabbing</code> environment, the commands <code>\=</code>, <code>\'</code> and <code>\`</code> do not produce accents as usual (<pxref label="Accents"><xrefnodename>Accents</xrefnodename></pxref>). Instead, the commands <code>\a=</code>, <code>\a'</code> and <code>\a`</code> are used. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="267">\kill</indexterm>\kill</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="312">\kill</indexterm>\kill</itemformat></item> </tableterm><tableitem><para>Sets tab stops without producing text. Works just like <code>\\</code> except that it throws away the current line instead of producing output for it. The effect of any <code>\=</code>, <code>\+</code> or <code>\-</code> commands in that line remain in effect. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="268">\poptabs</indexterm>\poptabs</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="269">\poptabs</indexterm></findex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="313">\poptabs</indexterm>\poptabs</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="314">\poptabs</indexterm></findex> <para>Restores the tab stop positions saved by the last <code>\pushtabs</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="270">\pushtabs</indexterm>\pushtabs</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="315">\pushtabs</indexterm>\pushtabs</itemformat></item> </tableterm><tableitem><para>Saves all current tab stop positions. Useful for temporarily changing tab stop positions in the middle of a <code>tabbing</code> environment. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="271">\tabbingsep</indexterm>\tabbingsep</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="316">\tabbingsep</indexterm>\tabbingsep</itemformat></item> </tableterm><tableitem><para>Distance to left of tab stop moved by <code>\'</code>. </para> </tableitem></tableentry></ftable> @@ -2832,50 +3613,70 @@ function \= fact(n : integer) : integer;\\ <node name="table" spaces=" "><nodename>table</nodename><nodenext automatic="on">tabular</nodenext><nodeprev automatic="on">tabbing</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>table</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="272">table</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="178">tables, creating</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="179">creating tables</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="317">table</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="189">tables, creating</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="190">creating tables</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve"> \begin{table}[placement] - - body of the table - - \caption{table title} - \end{table} +<pre xml:space="preserve">\begin{table}[<var>placement</var>] + table body +\caption[<var>loftitle</var>]{<var>title</var>} +\label{<var>label}</var> +\end{table} </pre></example> -<para>Tables are objects that are not part of the normal text, and are -usually &textldquo;floated&textrdquo; to a convenient place, like the top of a page. -Tables will not be split between two pages. +<para>A class of floats (<pxref label="Floats"><xrefnodename>Floats</xrefnodename></pxref>). Because they cannot be split across +pages, they are not typeset in sequence with the normal text but instead +are &textldquo;floated&textrdquo; to a convenient place, such as the top of a following +page. </para> -<para>The optional argument <code>[placement]</code> determines where &latex; will try -to place your table. There are four places where &latex; can possibly put -a float; these are the same as that used with the <code>figure</code> -environment, and described there (<pxref label="figure"><xrefnodename>figure</xrefnodename></pxref>). +<para>For the possible values of <var>placement</var> and their effect on the +float placement algorithm, see <ref label="Floats"><xrefnodename>Floats</xrefnodename></ref>. </para> -<para>The standard <code>report</code> and <code>article</code> classes use the default -placement <code>[tbp]</code>. +<para>The table body is typeset in a <code>parbox</code> of width <code>\textwidth</code> +and so it can contain text, commands, etc. </para> -<para>The body of the table is made up of whatever text, &latex; commands, etc., -you wish. The <code>\caption</code> command allows you to title your table. +<para>The label is optional; it is used for cross-references (<pxref label="Cross-references"><xrefnodename>Cross +references</xrefnodename></pxref>). +<findex index="fn" spaces=" "><indexterm index="fn" number="318">\caption</indexterm></findex> +The optional <code>\caption</code> command specifies caption text for the +table. By default it is numbered. If <var>lottitle</var> is present, it is +used in the list of tables instead of <var>title</var> (<pxref label="Tables-of-contents"><xrefnodename>Tables of +contents</xrefnodename></pxref>). </para> +<para>In this example the table and caption will float to the bottom of a page, +unless it is pushed to a float page at the end. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{table}[b] + \centering + \begin{tabular}{r|p{2in}} \hline + One &The loneliest number \\ + Two &Can be as sad as one. + It's the loneliest number since the number one. + \end{tabular} + \caption{Cardinal virtues} + \label{tab:CardinalVirtues} +\end{table} +</pre></example> + </section> <node name="tabular" spaces=" "><nodename>tabular</nodename><nodenext automatic="on">thebibliography</nodenext><nodeprev automatic="on">table</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>tabular</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="273">tabular <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="180">lines in tables</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="181">lining text up in tables</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="319">tabular <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="191">lines in tables</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="192">lining text up in tables</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\begin{tabular}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ -... +<pre xml:space="preserve">\begin{tabular}[<var>pos</var>]{<var>cols</var>} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular} </pre></example> @@ -2883,44 +3684,61 @@ column 1 entry & column 2 entry ... & column n entry \\ <para>or </para> <example endspaces=" "> -<pre xml:space="preserve">\begin{tabular*}{width}[pos]{cols} -column 1 entry & column 2 entry ... & column n entry \\ -... +<pre xml:space="preserve">\begin{tabular*}{<var>width</var>}[<var>pos</var>]{<var>cols</var>} +column 1 entry &column 2 entry ... &column n entry \\ + ... \end{tabular*} </pre></example> -<para>These environments produce a box consisting of a sequence of rows of -items, aligned vertically in columns. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="274">\\ <r>for <code>tabular</code></r></indexterm></findex> -<para><code>\\</code> must be used to specify the end of each row of the table, -except for the last, where it is optional&textmdash;unless an <code>\hline</code> -command (to put a rule below the table) follows. -</para> -<para>The mandatory and optional arguments consist of: -</para> -<table commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code">width</itemformat></item> -</tableterm><tableitem><para>Specifies the width of the <code>tabular*</code> environment. There must be -rubber space between columns that can stretch to fill out the specified -width. +<para>These environments produce a table, a box consisting of a sequence of +horizontal rows. Each row consists of items that are aligned vertically +in columns. This illustrates many of the features. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">pos</itemformat></item> -</tableterm><tableitem><para>Specifies the vertical position; default is alignment on the centre of -the environment. +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{l|l} + \textit{Player name} &\textit{Career home runs} \\ + \hline + Hank Aaron &755 \\ + Babe Ruth &714 +\end{tabular} +</pre></example> + +<para>The vertical format of two left-aligned columns, with a vertical bar +between them, is specified in <code>tabular</code>&textrsquo;s argument <code>{l|l}</code>. +<findex index="fn" spaces=" "><indexterm index="fn" number="320">&</indexterm></findex> +Columns are separated with an ampersand <code>&</code>. A horizontal rule +between two rows is created with <code>\hline</code>. +<findex index="fn" spaces=" "><indexterm index="fn" number="321">\\ <r>for <code>tabular</code></r></indexterm></findex> +The end of each row is marked with a double backslash <code>\\</code>. +This <code>\\</code> is optional after the last row unless an <code>\hline</code> +command follows, to put a rule below the table. </para> -<table commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code">t</itemformat></item> -</tableterm><tableitem><para>align on top row +<para>The required and optional arguments to <code>tabular</code> consist of: </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">b</itemformat></item> -</tableterm><tableitem><para>align on bottom row -</para></tableitem></tableentry></table> - -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">cols</itemformat></item> -</tableterm><tableitem><para>Specifies the column formatting. It consists of a sequence of the -following specifiers, corresponding to the sequence of columns and -intercolumn material. +<table commandarg="var" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="var">width</itemformat></item> +</tableterm><tableitem><para>Required for <code>tabular*</code>, not allowed for <code>tabular</code>. Specifies +the width of the <code>tabular*</code> environment. The space between columns +should be rubber, as with <code>&arobase;{\extracolsep{\fill}}</code>, to allow +the table to stretch or shrink to make the specified width, or else you +are likely to get the <code>Underfull \hbox (badness 10000) in alignment +..</code> warning. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">pos</itemformat></item> +</tableterm><tableitem><para>Optional. Specifies the table&textrsquo;s vertical position. The default is to +align the table so its vertical center matches the baseline of the +surrounding text. There are two other possible alignments: <code>t</code> +aligns the table so its top row matches the baseline of the surrounding +text, and <code>b</code> aligns on the bottom row. +</para> +<para>This only has an effect if there is other text. In the common case of a +<code>tabular</code> alone in a <code>center</code> environment this option makes +no difference. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">cols</itemformat></item> +</tableterm><tableitem><para>Required. Specifies the formatting of columns. It consists of a +sequence of the following specifiers, corresponding to the types of +column and intercolumn material. </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">l</itemformat></item> @@ -2935,46 +3753,88 @@ intercolumn material. </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">|</itemformat></item> </tableterm><tableitem><para>A vertical line the full height and depth of the environment. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">&arobase;{<var>text</var>}</itemformat></item> -</tableterm><tableitem><para>This inserts <var>text</var> in every row. An &arobase;-expression suppresses the -intercolumn space normally inserted between columns; any desired space -before the adjacent item must be included in <var>text</var>. +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">&arobase;{<var>text or space</var>}</itemformat></item> +</tableterm><tableitem><para>This inserts <var>text or space</var> at this location in every row. The +<var>text or space</var> material is typeset in LR mode. This text is +fragile (<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). </para> -<para>To insert commands that are automatically executed before a given -column, you have to load the <code>array</code> package and use the -<code>>{...}</code> specifier. -<!-- c xx should fully explain array, tabularx, and all other base packages... --> +<para>This specifier is optional: unless you put in your own &arobase;-expression +then &latex;&textrsquo;s book, article, and report classes will put on either +side of each column a space of length <code>\tabcolsep</code>, which by +default is <samp>6pt</samp>. That is, by default adjacent columns are +separated by 12pt (so <code>\tabcolsep</code> is misleadingly-named since it +is not the separation between tabular columns). Also by default a space +of 6pt comes before the first column as well as after the final column, +unless you put a <code>&arobase;{..}</code> or <code>|</code> there. +</para> +<para>If you override the default and use an &arobase;-expression then you must +insert any desired space yourself, as in <code>&arobase;{\hspace{1em}}</code>. +</para> +<para>An empty expression <code>&arobase;{}</code> will eliminate the space, including +the space at the start or end, as in the example below where the tabular +lines need to lie on the left margin. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{flushleft} + \begin{tabular}{&arobase;{}l} + .. + \end{tabular} +\end{flushleft} +</pre></example> + +<para>This example shows text, a decimal point, between the columns, arranged +so the numbers in the table are aligned on that decimal point. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="275">\extracolsep</indexterm></findex> -<para>An <code>\extracolsep{wd}</code> command in an &arobase;-expression causes an -extra space of width <code>wd</code> to appear to the left of all subsequent +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{r&arobase;{$.$}l} + $3$ &$14$ \\ + $9$ &$80665$ +\end{tabular} +</pre></example> + +<findex index="fn" spaces=" "><indexterm index="fn" number="322">\extracolsep</indexterm></findex> +<para>An <code>\extracolsep{<var>wd</var>}</code> command in an &arobase;-expression causes an +extra space of width <var>wd</var> to appear to the left of all subsequent columns, until countermanded by another <code>\extracolsep</code> command. -Unlike ordinary intercolumn space, this extra space is not suppressed -by an &arobase;-expression. An <code>\extracolsep</code> command can be used only -in an &arobase;-expression in the <code>cols</code> argument. +Unlike ordinary intercolumn space, this extra space is not suppressed by +an &arobase;-expression. An <code>\extracolsep</code> command can be used only in an +&arobase;-expression in the <code>cols</code> argument. Below, &latex; inserts the +right amount of intercolumn space to make the entire table 4 inches +wide. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{center} + \begin{tabular*}{4in}{l&arobase;{\ \ldots\extracolsep{\fill}}l} + Seven times down, eight times up + &such is life! + \end{tabular*} +\end{center} +</pre></example> + +<para>To insert commands that are automatically executed before a given +column, load the <code>array</code> package and use the <code>>{...}</code> +specifier. +<!-- c xx should fully explain array, tabularx, and all other base packages... --> </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">p{<var>wd</var>}</itemformat></item> -</tableterm><tableitem><para>Produces a column with each item typeset in a parbox of width -<var>wd</var>, as if it were the argument of a -<code>\parbox[t]{<var>wd</var>}</code> command. However, a <code>\\</code> may not -appear in the item, except in the following situations: +</tableterm><tableitem><para>Each item in the column is typeset in a parbox of width <var>wd</var>. +</para> +<para>Note that a line break double backslash <code>\\</code> may not appear in the +item, except inside an environment like <code>minipage</code>, <code>array</code>, +or <code>tabular</code>, or inside an explicit <code>\parbox</code>, or in the scope +of a <code>\centering</code>, <code>\raggedright</code>, or <code>\raggedleft</code> +declaration (when used in a <code>p</code>-column element these declarations +must appear inside braces, as with <code>{\centering .. \\ +..}</code>). Otherwise &latex; will misinterpret the double backslash as +ending the row. </para> -<enumerate first="1" endspaces=" "> -<listitem> -<para>inside an environment like <code>minipage</code>, <code>array</code>, or <code>tabular</code>. -</para></listitem><listitem> -<para>inside an explicit <code>\parbox</code>. -</para></listitem><listitem> -<para>in the scope of a <code>\centering</code>, <code>\raggedright</code>, or <code>\raggedleft</code> -declaration. The latter declarations must appear inside braces or an -environment when used in a <code>p</code>-column element. -</para></listitem></enumerate> - </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">*{<var>num</var>}{<var>cols</var>}</itemformat></item> </tableterm><tableitem><para>Equivalent to <var>num</var> copies of <var>cols</var>, where <var>num</var> is a -positive integer and <var>cols</var> is any list of column-specifiers, -which may contain another <code>*-expression</code>. -</para> +positive integer and <var>cols</var> is a list of specifiers. Thus +<code>\begin{tabular}{|*{3}{l|r}|}</code> is equivalent to +<code>\begin{tabular}{|l|rl|rl|r|}</code>. Note that <var>cols</var> may +contain another <code>*-expression</code>. +</para> </tableitem></tableentry></table> </tableitem></tableentry></table> @@ -2982,68 +3842,172 @@ which may contain another <code>*-expression</code>. <!-- c xx defaults, own node (xref from array)? --> </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="276">\arrayrulewidth</indexterm>\arrayrulewidth</itemformat></item> -</tableterm><tableitem><para>Thickness of the rule created by <code>|</code>, <code>\hline</code>, and -<code>\vline</code> in the <code>tabular</code> and <code>array</code> environments; the -default is <samp>.4pt</samp>. +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="323">\arrayrulewidth</indexterm>\arrayrulewidth</itemformat></item> +</tableterm><tableitem><para>A length that is the thickness of the rule created by <code>|</code>, +<code>\hline</code>, and <code>\vline</code> in the <code>tabular</code> and <code>array</code> +environments. The default is <samp>.4pt</samp>. Change it as in +<code>\setlength{\arrayrulewidth}{0.8pt}</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="277">\arraystretch</indexterm>\arraystretch</itemformat></item> -</tableterm><tableitem><para>Scaling of spacing between rows in the <code>tabular</code> and <code>array</code> -environments; default is <samp>1</samp>, for no scaling. +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="324">\arraystretch</indexterm>\arraystretch</itemformat></item> +</tableterm><tableitem><para>A factor by which the spacing between rows in the <code>tabular</code> and +<code>array</code> environments is multiplied. The default is <samp>1</samp>, for +no scaling. Change it as <code>\renewcommand{\arraystretch}{1.2}</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="278">\doublerulesep</indexterm>\doublerulesep</itemformat></item> -</tableterm><tableitem><para>Horizontal distance between the vertical rules produced by <code>||</code> -in the <code>tabular</code> and <code>array</code> environments; default is <samp>2pt</samp>. +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="325">\doublerulesep</indexterm>\doublerulesep</itemformat></item> +</tableterm><tableitem><para>A length that is the distance between the vertical rules produced by the +<code>||</code> specifier. The default is <samp>2pt</samp>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="279">\tabcolsep</indexterm>\tabcolsep</itemformat></item> -</tableterm><tableitem><para>Half the width of the space between columns; default is <samp>6pt</samp>. +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="326">\tabcolsep</indexterm>\tabcolsep</itemformat></item> +</tableterm><tableitem><para>A length that is half of the space between columns. The default is +<samp>6pt</samp>. Change it with <code>\setlength</code>. </para> </tableitem></tableentry></ftable> -<para>The following commands can be used inside a <code>tabular</code> -environment: +<para>The following commands can be used inside the body of a <code>tabular</code> +environment, the first two inside an entry and the second two between +lines: </para> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\multicolumn</menunode><menudescription><pre xml:space="preserve">Make an item spanning several columns. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\vline</menunode><menudescription><pre xml:space="preserve">Draw a vertical line. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\cline</menunode><menudescription><pre xml:space="preserve">Draw a horizontal line spanning some columns. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\hline</menunode><menudescription><pre xml:space="preserve">Draw a horizontal line spanning all columns. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\vline</menunode><menudescription><pre xml:space="preserve">Draw a vertical line. </pre></menudescription></menuentry></menu> -<node name="_005cmulticolumn" spaces=" "><nodename>\multicolumn</nodename><nodenext automatic="on">\cline</nodenext><nodeup automatic="on">tabular</nodeup></node> +<node name="_005cmulticolumn" spaces=" "><nodename>\multicolumn</nodename><nodenext automatic="on">\vline</nodenext><nodeup automatic="on">tabular</nodeup></node> <subsection spaces=" "><sectiontitle><code>\multicolumn</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="280">\multicolumn</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="327">\multicolumn</indexterm></findex> <para>Synopsis: -</para><example endspaces=" "> -<pre xml:space="preserve">\multicolumn{<var>cols</var>}{<var>pos</var>}{<var>text</var>} +</para> +<example endspaces=" "> +<pre xml:space="preserve">\multicolumn{<var>numcols</var>}{<var>cols</var>}{<var>text</var>} </pre></example> -<para>The <code>\multicolumn</code> command makes an entry that spans several -columns. The first mandatory argument, <var>cols</var>, specifies the -number of columns to span. The second mandatory argument, <var>pos</var>, -specifies the formatting of the entry; <code>c</code> for centered, <code>l</code> -for flushleft, <code>r</code> for flushright. The third mandatory argument, -<var>text</var>, specifies what text to put in the entry. +<para>Make an <code>array</code> or <code>tabular</code> entry that spans several columns. +The first argument <var>numcols</var> gives the number of columns to span. +The second argument <var>cols</var> specifies the formatting of the entry, +with <code>c</code> for centered, <code>l</code> for flush left, or <code>r</code> for +flush right. The third argument <var>text</var> gives the contents of that +entry. </para> -<para>Here&textrsquo;s an example showing two columns separated by an en-dash; -<code>\multicolumn</code> is used for the heading: +<para>In this example, in the first row, the second and third columns are +spanned by the single heading <samp>Name</samp>. </para> <example endspaces=" "> -<pre xml:space="preserve">\begin{tabular}{r&arobase;{--}l} -\multicolumn{2}{c}{\bf Unicode}\cr - 0x80&0x7FF \cr - 0x800&0xFFFF \cr -0x10000&0x1FFFF \cr +<pre xml:space="preserve">\begin{tabular}{lccl} + \textit{ID} &\multicolumn{2}{c}{\textit{Name}} &\textit{Age} \\ \hline % row one + 978-0-393-03701-2 &O'Brian &Patrick &55 \\ % row two + .. \end{tabular} </pre></example> +<para>What counts as a column is: the column format specifier for the +<code>array</code> or <code>tabular</code> environment is broken into parts, where +each part (except the first) begins with <code>l</code>, <code>c</code>, <code>r</code>, +or <code>p</code>. So from <code>\begin{tabular}{|r|ccp{1.5in}|}</code> +the parts are <code>|r|</code>, <code>c</code>, <code>c</code>, +and <code>p{1.5in}|</code>. +</para> +<para>The <var>cols</var> argument overrides the <code>array</code> or <code>tabular</code> +environment&textrsquo;s intercolumn area default adjoining this multicolumn +entry. To affect that area, this argument can contain vertical bars +<code>|</code> indicating the placement of vertical rules, and <code>&arobase;{..}</code> +expressions. Thus if <var>cols</var> is <samp>|c|</samp> then this multicolumn +entry will be centered and a vertical rule will come in the intercolumn +area before it and after it. This table details the exact behavior. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{|cc|c|c|} + \multicolumn{1}{r}{w} % entry one + &\multicolumn{1}{|r|}{x} % entry two + &\multicolumn{1}{|r}{y} % entry three + &z % entry four +\end{tabular} +</pre></example> +<para>Before the first entry the output will not have a vertical rule because +the <code>\multicolumn</code> has the <var>cols</var> specifier <samp>r</samp> with no +initial vertical bar. Between entry one and entry two there will be a +vertical rule; although the first <var>cols</var> does not have an ending +vertical bar, the second <var>cols</var> does have a starting one. Between +entry two and entry three there is a single vertical rule; despite that +the <var>cols</var> in both of the surrounding <code>multicolumn</code>&textrsquo;s call for +a vertical rule, you only get one rule. Between entry three and entry +four there is no vertical rule; the default calls for one but the +<var>cols</var> in the entry three <code>\multicolumn</code> leaves it out, and +that takes precedence. Finally, following entry four there is a +vertical rule because of the default. +</para> +<para>The number of spanned columns <var>numcols</var> can be 1. Besides giving +the ability to change the horizontal alignment, this also is useful to +override for one row the <code>tabular</code> definition&textrsquo;s default intercolumn +area specification, including the placement of vertical rules. +</para> +<para>In the example below, in the <code>tabular</code> definition the first column +is specified to default to left justified but in the first row the entry +is centered with <code>\multicolumn{1}{c}{\textsc{Period}}</code>. +Also in the first row, the second and third columns are spanned by a +single entry with <code>\multicolumn{2}{c}{\textsc{Span}}</code>, +overriding the specification to center those two columns on the page +range en-dash. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{l|r&arobase;{--}l} + \multicolumn{1}{c}{\textsc{Period}} + &multicolumn{2}{c}{\textsc{Span}} \\ \hline + Baroque &1600 &1760 \\ + Classical &1730 &1820 \\ + Romantic &1780 &1910 \\ + Impressionistic &1875 &1925 +\end{tabular} +</pre></example> + +<para>Note that although the <code>tabular</code> specification by default puts a +vertical rule between the first and second columns, because there is no +vertical bar in the <var>cols</var> of either of the first row&textrsquo;s +<code>\multicolumn</code> commands, no rule appears in the first row. +</para> </subsection> -<node name="_005ccline" spaces=" "><nodename>\cline</nodename><nodenext automatic="on">\hline</nodenext><nodeprev automatic="on">\multicolumn</nodeprev><nodeup automatic="on">tabular</nodeup></node> +<node name="_005cvline" spaces=" "><nodename>\vline</nodename><nodenext automatic="on">\cline</nodenext><nodeprev automatic="on">\multicolumn</nodeprev><nodeup automatic="on">tabular</nodeup></node> +<subsection spaces=" "><sectiontitle><code>\vline</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="328">\vline</indexterm></findex> + +<para>Draw a vertical line in a <code>tabular</code> or <code>array</code> environment +extending the full height and depth of an entry&textrsquo;s row. Can also be used +in an &arobase;-expression, although its synonym vertical bar <code>|</code> is +more common. This command is rarely used; typically a table&textrsquo;s vertical +lines are specified in <code>tabular</code>&textrsquo;s <var>cols</var> argument and +overriden as needed with <code>\multicolumn</code>. +</para> +<para>This example illustrates some pitfalls. In the first line&textrsquo;s second +entry the <code>\hfill</code> moves the <code>\vline</code> to the left edge of the +cell. But that is different than putting it halfway between the two +columns, so in that row between the first and second columns there are +two vertical rules, with the one from the <code>{c|cc}</code> specifier +coming before the one produced by the <code>\vline\hfill</code>. In contrast, +the first line&textrsquo;s third entry shows the usual way to put a vertical bar +between two columns. In the second line, the <code>ghi</code> is the widest +entry in its column so in the <code>\vline\hfill</code> the <code>\hfill</code> has +no effect and the vertical line in that entry appears immediately next +to the <code>g</code>, with no whitespace. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{c|cc} + x &\vline\hfill y &\multicolumn{1}{|r}{z} \\ + abc &def &\vline\hfill ghi +\end{tabular} +</pre></example> + + +</subsection> +<node name="_005ccline" spaces=" "><nodename>\cline</nodename><nodenext automatic="on">\hline</nodenext><nodeprev automatic="on">\vline</nodeprev><nodeup automatic="on">tabular</nodeup></node> <subsection spaces=" "><sectiontitle><code>\cline</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="281">\cline</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="329">\cline</indexterm></findex> <para>Synopsis: </para> @@ -3051,40 +4015,55 @@ for flushleft, <code>r</code> for flushright. The third mandatory argument, <pre xml:space="preserve">\cline{<var>i</var>-<var>j</var>} </pre></example> -<para>The <code>\cline</code> command draws horizontal lines across the columns -specified, beginning in column <var>i</var> and ending in column <var>j</var>, -which are specified in the mandatory argument. +<para>Draw a horizontal rule in an <code>array</code> or <code>tabular</code> environment +beginning in column <var>i</var> and ending in column <var>j</var>. The +dash <code>-</code> must appear in the mandatory argument. To span a +single column use the number twice. </para> +<para>This example puts two horizontal lines between the first and second +rows, one line in the first column only, and the other spanning the +third and fourth columns. The two lines are side-by-side, at the same +height. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{llrr} + a &b &c &d \\ \cline{1-1} \cline{3-4} + e &f &g &h +\end{tabular} +</pre></example> + </subsection> -<node name="_005chline" spaces=" "><nodename>\hline</nodename><nodenext automatic="on">\vline</nodenext><nodeprev automatic="on">\cline</nodeprev><nodeup automatic="on">tabular</nodeup></node> +<node name="_005chline" spaces=" "><nodename>\hline</nodename><nodeprev automatic="on">\cline</nodeprev><nodeup automatic="on">tabular</nodeup></node> <subsection spaces=" "><sectiontitle><code>\hline</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="282">\hline</indexterm></findex> -<para>The <code>\hline</code> command draws a horizontal line the width of the -enclosing <code>tabular</code> or <code>array</code> environment. It&textrsquo;s most -commonly used to draw a line at the top, bottom, and between the rows -of a table. -</para> - -</subsection> -<node name="_005cvline" spaces=" "><nodename>\vline</nodename><nodeprev automatic="on">\hline</nodeprev><nodeup automatic="on">tabular</nodeup></node> -<subsection spaces=" "><sectiontitle><code>\vline</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="283">\vline</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="330">\hline</indexterm></findex> -<para>The <code>\vline</code> command will draw a vertical line extending the full -height and depth of its row. An <code>\hfill</code> command can be used to -move the line to the edge of the column. It can also be used in an -&arobase;-expression. +<para>Draws a horizontal line the width of the enclosing <code>tabular</code> or +<code>array</code> environment. It&textrsquo;s most commonly used to draw a line at the +top, bottom, and between the rows of a table. </para> +<para>In this example the top of the table has two horizontal rules, one above +the other, that span both columns. The bottom of the table has a single +rule spanning both columns. Because of the <code>\hline</code>, the +<code>tabular</code> second row&textrsquo;s line ending double backslash <code>\\</code> +is required. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{ll} \hline\hline + Baseball &Red Sox \\ + Basketball &Celtics \\ \hline +\end{tabular} +</pre></example> + </subsection> </section> <node name="thebibliography" spaces=" "><nodename>thebibliography</nodename><nodenext automatic="on">theorem</nodenext><nodeprev automatic="on">tabular</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>thebibliography</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="284">thebibliography</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="182">bibliography, creating (manually)</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="331">thebibliography <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="193">bibliography, creating (manually)</indexterm></cindex> <para>Synopsis: </para> @@ -3124,10 +4103,11 @@ less than 10 references, <code>99</code> for ones with less than 100, etc. <node name="_005cbibitem" spaces=" "><nodename>\bibitem</nodename><nodenext automatic="on">\cite</nodenext><nodeup automatic="on">thebibliography</nodeup></node> <subsection spaces=" "><sectiontitle><code>\bibitem</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="285">\bibitem</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="332">\bibitem</indexterm></findex> <para>Synopsis: -</para><example endspaces=" "> +</para> +<example endspaces=" "> <pre xml:space="preserve">\bibitem[<var>label</var>]{<var>cite_key</var>} </pre></example> @@ -3149,12 +4129,12 @@ associated label. <node name="_005ccite" spaces=" "><nodename>\cite</nodename><nodenext automatic="on">\nocite</nodenext><nodeprev automatic="on">\bibitem</nodeprev><nodeup automatic="on">thebibliography</nodeup></node> <subsection spaces=" "><sectiontitle><code>\cite</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="286">\cite</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="333">\cite</indexterm></findex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\cite[<var>subcite</var>]{<var>keys</var> +<pre xml:space="preserve">\cite[<var>subcite</var>]{<var>keys</var>} </pre></example> <para>The <var>keys</var> argument is a list of one or more citation keys, @@ -3170,23 +4150,24 @@ citation. For example, <code>\cite[p.~314]{knuth}</code> might pr </subsection> <node name="_005cnocite" spaces=" "><nodename>\nocite</nodename><nodenext automatic="on">Using BibTeX</nodenext><nodeprev automatic="on">\cite</nodeprev><nodeup automatic="on">thebibliography</nodeup></node> <subsection spaces=" "><sectiontitle><code>\nocite</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="287">\nocite</indexterm></findex> -<para><code>\nocite{key_list}</code> +<findex index="fn" spaces=" "><indexterm index="fn" number="334">\nocite</indexterm></findex> + +<para><code>\nocite{<var>keys</var>}</code> </para> -<para>The <code>\nocite</code> command produces no text, but writes <code>key_list</code>, -which is a list of one or more citation keys, on the <file>.aux</file> file. +<para>The <code>\nocite</code> command produces no text, but writes <var>keys</var>, +which is a list of one or more citation keys, to the <file>.aux</file> file. </para> </subsection> <node name="Using-BibTeX" spaces=" "><nodename>Using BibTeX</nodename><nodeprev automatic="on">\nocite</nodeprev><nodeup automatic="on">thebibliography</nodeup></node> <subsection spaces=" "><sectiontitle>Using Bib&tex;</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="183">using Bib&tex;</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="184">bib&tex;, using</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="185">bibliography, creating (automatically)</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="288">\bibliographystyle</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="289">\bibliography</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="194">using Bib&tex;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="195">bib&tex;, using</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="196">bibliography, creating (automatically)</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="335">\bibliographystyle</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="336">\bibliography</indexterm></findex> <para>If you use the Bib&tex; program by Oren Patashnik (highly recommended if you need a bibliography of more than a couple of @@ -3233,8 +4214,8 @@ Bib&tex; format. Only the entries referred to via <code>\cite</code> and <node name="theorem" spaces=" "><nodename>theorem</nodename><nodenext automatic="on">titlepage</nodenext><nodeprev automatic="on">thebibliography</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>theorem</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="290">theorem <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="186">theorems, typesetting</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="337">theorem <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="197">theorems, typesetting</indexterm></cindex> <para>Synopsis: </para> @@ -3254,9 +4235,9 @@ possibilities for <var>n</var> are described under <code>\newtheorem</code> <node name="titlepage" spaces=" "><nodename>titlepage</nodename><nodenext automatic="on">verbatim</nodenext><nodeprev automatic="on">theorem</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>titlepage</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="291">titlepage <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="187">making a title page</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="188">title pages, creating</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="338">titlepage <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="198">making a title page</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="199">title pages, creating</indexterm></cindex> <para>Synopsis: </para> @@ -3280,12 +4261,12 @@ produce a standard title page without a <code>titlepage</code> environment. <node name="verbatim" spaces=" "><nodename>verbatim</nodename><nodenext automatic="on">verse</nodenext><nodeprev automatic="on">titlepage</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>verbatim</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="292">verbatim <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="189">verbatim text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="190">simulating typed text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="191">typed text, simulating</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="192">code, typesetting</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="193">computer programs, typesetting</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="339">verbatim <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="200">verbatim text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="201">simulating typed text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="202">typed text, simulating</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="203">code, typesetting</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="204">computer programs, typesetting</indexterm></cindex> <para>Synopsis: </para> @@ -3310,8 +4291,8 @@ effect that they would on a typewriter. <node name="_005cverb" spaces=" "><nodename>\verb</nodename><nodeup automatic="on">verbatim</nodeup></node> <subsection spaces=" "><sectiontitle><code>\verb</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="293">\verb</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="194">verbatim text, inline</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="340">\verb</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="205">verbatim text, inline</indexterm></cindex> <para>Synopsis: </para> @@ -3326,7 +4307,7 @@ including special characters and spaces, using the typewriter <code>\verb*</code> and the delimiter <var>char</var>, which begins and ends the verbatim text. The delimiter must not appear in <var>literal-text</var>. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="195">visible space</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="206">visible space</indexterm></cindex> <para>The <code>*</code>-form differs only in that spaces are printed with a &textldquo;visible space&textrdquo; character. <tex endspaces=" "> @@ -3339,8 +4320,8 @@ verbatim text. The delimiter must not appear in <var>literal-text</var>. <node name="verse" spaces=" "><nodename>verse</nodename><nodeprev automatic="on">verbatim</nodeprev><nodeup automatic="on">Environments</nodeup></node> <section spaces=" "><sectiontitle><code>verse</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="294">verse <r>environment</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="196">poetry, an environment for</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="341">verse <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="207">poetry, an environment for</indexterm></cindex> <para>Synopsis: </para> @@ -3355,7 +4336,7 @@ verbatim text. The delimiter must not appear in <var>literal-text</var>. <para>The <code>verse</code> environment is designed for poetry, though you may find other uses for it. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="295">\\ <r>for <code>verse</code></r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="342">\\ <r>for <code>verse</code></r></indexterm></findex> <para>The margins are indented on the left and the right, paragraphs are not indented, and the text is not justified. Separate the lines of each stanza with <code>\\</code>, and use one or more blank lines to separate the @@ -3366,17 +4347,17 @@ stanzas. </chapter> <node name="Line-breaking" spaces=" "><nodename>Line breaking</nodename><nodenext automatic="on">Page breaking</nodenext><nodeprev automatic="on">Environments</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Line breaking</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="197">line breaking</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="198">breaking lines</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="208">line breaking</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="209">breaking lines</indexterm></cindex> <para>The first thing &latex; does when processing ordinary text is to translate your input file into a sequence of glyphs and spaces. To produce a printed document, this sequence must be broken into lines (and these lines must be broken into pages). </para> -<para>&latex; usually does the line (and page) breaking for you, but in -some environments, you do the line breaking yourself with the -<code>\\</code> command, and you can always manually force breaks. +<para>&latex; usually does the line (and page) breaking in the text body for +you but in some environments you manually force line breaks. </para> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\\</menunode><menudescription><pre xml:space="preserve">Start a new line. @@ -3391,26 +4372,55 @@ some environments, you do the line breaking yourself with the <node name="_005c_005c" spaces=" "><nodename>\\</nodename><nodenext automatic="on">\obeycr & \restorecr</nodenext><nodeup automatic="on">Line breaking</nodeup></node> -<section spaces=" "><sectiontitle><code>\\</code>[*][<var>morespace</var>]</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="296">\\ <r>force line break</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="199">new line, starting</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="200">line break, forcing</indexterm></cindex> +<section spaces=" "><sectiontitle><code>\\</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="343">\\ <r>force line break</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="210">new line, starting</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="211">line break, forcing</indexterm></cindex> -<para>The <code>\\</code> command tells &latex; to start a new line. It has an -optional argument, <var>morespace</var>, that specifies how much extra -vertical space is to be inserted before the next line. This can be a -negative amount. +<para>Synopsis: </para> -<para>The <code>\\*</code> command is the same as the ordinary <code>\\</code> command -except that it tells &latex; not to start a new page after the line. +<example endspaces=" "> +<pre xml:space="preserve">\\[<var>morespace</var>] +</pre></example> + +<para>or </para> +<example endspaces=" "> +<pre xml:space="preserve">\\*[<var>morespace</var>] +</pre></example> + +<para>Start a new line. The optional argument <var>morespace</var> specifies extra +vertical space to be insert before the next line. This can be a +negative length. The text before the break is set at its normal length, +that is, it is not stretched to fill out the line width. +</para> +<para>Explicit line breaks in the text body are unusual in &latex;. In +particular, to start a new paragraph instead leave a blank line. This +command is mostly used outside of the main flow of text such as in +a <code>tabular</code> or <code>array</code> environment. +</para> +<para>Under ordinary circumstances (e.g., outside of a <code>p{..}</code> column +in a <code>tabular</code> environment) the <code>\newline</code> command is a synonym for +<code>\\</code> (<pxref label="_005cnewline"><xrefnodename>\newline</xrefnodename></pxref>). +</para> +<para>In addition to starting a new line, the starred form <code>\\*</code> tells +&latex; not to start a new page between the two lines, by issuing a +<code>\nobreak</code>. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\title{My story: \\[0.25in] + a tale of woe} +</pre></example> + </section> <node name="_005cobeycr-_0026-_005crestorecr" spaces=" "><nodename>\obeycr & \restorecr</nodename><nodenext automatic="on">\newline</nodenext><nodeprev automatic="on">\\</nodeprev><nodeup automatic="on">Line breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\obeycr</code> & <code>\restorecr</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="297">\obeycr</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="298">\restorecr</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="201">new line, output as input</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="344">\obeycr</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="345">\restorecr</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="212">new line, output as input</indexterm></cindex> <para>The <code>\obeycr</code> command makes a return in the input file (<samp>^^M</samp>, internally) the same as <code>\\</code> (followed by @@ -3423,19 +4433,37 @@ in the output. </section> <node name="_005cnewline" spaces=" "><nodename>\newline</nodename><nodenext automatic="on">\- (hyphenation)</nodenext><nodeprev automatic="on">\obeycr & \restorecr</nodeprev><nodeup automatic="on">Line breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\newline</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="299">\newline</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="202">new line, starting (paragraph mode)</indexterm></cindex> -<para>The <code>\newline</code> command breaks the line at the present point, with -no stretching of the text before it. It can only be used in paragraph -mode. +<findex index="fn" spaces=" "><indexterm index="fn" number="346">\newline</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="213">new line, starting (paragraph mode)</indexterm></cindex> + +<para>In ordinary text this is equivalent to double-backslash (<pxref label="_005c_005c"><xrefnodename>\\</xrefnodename></pxref>); it +breaks a line, with no stretching of the text before it. +</para> +<para>Inside a <code>tabular</code> or <code>array</code> environment, in a column with a +specifier producing a paragraph box, like typically <code>p{..}</code>, +<code>\newline</code> will insert a line break inside of the column, that is, +it does not break the entire row. To break the entire row use <code>\\</code> +or its equivalent <code>\tabularnewline</code>. +</para> +<para>This will print <samp>Name:</samp> and <samp>Address:</samp> as two lines in a +single cell of the table. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{tabular}{p{1in}{\hspace{2in}}p{1in}} + Name: \newline Address: &Date: \\ \hline +\end{tabular} +</pre></example> + +<para>The <samp>Date:</samp> will be baseline-aligned with <samp>Name:</samp>. </para> </section> <node name="_005c_002d-_0028hyphenation_0029" spaces=" "><nodename>\- (hyphenation)</nodename><nodenext automatic="on">\fussy</nodenext><nodeprev automatic="on">\newline</nodeprev><nodeup automatic="on">Line breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\-</code> (discretionary hyphen)</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="300">\- <r>(hyphenation)</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="203">hyphenation, forcing</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="347">\- <r>(hyphenation)</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="214">hyphenation, forcing</indexterm></cindex> <para>The <code>\-</code> command tells &latex; that it may hyphenate the word at that point. &latex; is pretty good at hyphenating, and usually finds @@ -3448,11 +4476,11 @@ hyphenated at those points and not at any of the hyphenation points that &latex; might otherwise have chosen. </para> - </section> <node name="_005cfussy" spaces=" "><nodename>\fussy</nodename><nodenext automatic="on">\sloppy</nodenext><nodeprev automatic="on">\- (hyphenation)</nodeprev><nodeup automatic="on">Line breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\fussy</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="301">\fussy</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="348">\fussy</indexterm></findex> <para>The declaration <code>\fussy</code> (which is the default) makes &tex; picky about line breaking. This usually avoids too much space between @@ -3466,6 +4494,8 @@ words, at the cost of an occasional overfull box. <node name="_005csloppy" spaces=" "><nodename>\sloppy</nodename><nodenext automatic="on">\hyphenation</nodenext><nodeprev automatic="on">\fussy</nodeprev><nodeup automatic="on">Line breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\sloppy</code></sectiontitle> +<findex index="fn" spaces=" "><indexterm index="fn" number="349">\sloppy</indexterm></findex> + <para>The declaration <code>\sloppy</code> makes &tex; less fussy about line breaking. This will avoid overfull boxes, at the cost of loose interword spacing. @@ -3476,8 +4506,9 @@ interword spacing. </section> <node name="_005chyphenation" spaces=" "><nodename>\hyphenation</nodename><nodenext automatic="on">\linebreak & \nolinebreak</nodenext><nodeprev automatic="on">\sloppy</nodeprev><nodeup automatic="on">Line breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\hyphenation</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="302">\hyphenation</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="204">hyphenation, defining</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="350">\hyphenation</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="215">hyphenation, defining</indexterm></cindex> <para>Synopsis: </para> @@ -3500,10 +4531,11 @@ misses the hyphenations in these words): </section> <node name="_005clinebreak-_0026-_005cnolinebreak" spaces=" "><nodename>\linebreak & \nolinebreak</nodename><nodeprev automatic="on">\hyphenation</nodeprev><nodeup automatic="on">Line breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\linebreak</code> & <code>\nolinebreak</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="303">\linebreak</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="304">\nolinebreak</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="205">line breaks, forcing</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="206">line breaks, preventing</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="351">\linebreak</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="352">\nolinebreak</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="216">line breaks, forcing</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="217">line breaks, preventing</indexterm></cindex> <para>Synopses: </para> @@ -3526,8 +4558,9 @@ from a demand to a request. The <var>priority</var> must be a number from </chapter> <node name="Page-breaking" spaces=" "><nodename>Page breaking</nodename><nodenext automatic="on">Footnotes</nodenext><nodeprev automatic="on">Line breaking</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Page breaking</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="207">page breaking</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="208">breaking pages</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="218">page breaking</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="219">breaking pages</indexterm></cindex> <para>&latex; starts new pages asynchronously, when enough material has accumulated to fill up a page. Usually this happens automatically, @@ -3545,49 +4578,54 @@ but sometimes you may want to influence the breaks. <node name="_005ccleardoublepage" spaces=" "><nodename>\cleardoublepage</nodename><nodenext automatic="on">\clearpage</nodenext><nodeup automatic="on">Page breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\cleardoublepage</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="305">\cleardoublepage</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="209">starting on a right-hand page</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="353">\cleardoublepage</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="220">starting on a right-hand page</indexterm></cindex> <para>The <code>\cleardoublepage</code> command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. -In a two-sided printing style, it also makes the next page a right-hand -(odd-numbered) page, producing a blank page if necessary. +the pending floating figures and tables that have so far appeared in the +input to be printed. In a two-sided printing style, it also makes the +next page a right-hand (odd-numbered) page, producing a blank page if +necessary. </para> </section> <node name="_005cclearpage" spaces=" "><nodename>\clearpage</nodename><nodenext automatic="on">\newpage</nodenext><nodeprev automatic="on">\cleardoublepage</nodeprev><nodeup automatic="on">Page breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\clearpage</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="306">\clearpage</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="210">flushing floats and starting a page</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="211">starting a new page and clearing floats</indexterm></cindex> -<para>The <code>\clearpage</code> command ends the current page and causes all -figures and tables that have so far appeared in the input to be printed. +<findex index="fn" spaces=" "><indexterm index="fn" number="354">\clearpage</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="221">flushing floats and starting a page</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="222">starting a new page and clearing floats</indexterm></cindex> + +<para>The <code>\clearpage</code> command ends the current page and causes all the +pending floating figures and tables that have so far appeared in the +input to be printed. </para> </section> <node name="_005cnewpage" spaces=" "><nodename>\newpage</nodename><nodenext automatic="on">\enlargethispage</nodenext><nodeprev automatic="on">\clearpage</nodeprev><nodeup automatic="on">Page breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\newpage</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="307">\newpage</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="212">new page, starting</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="213">starting a new page</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="355">\newpage</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="223">new page, starting</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="224">starting a new page</indexterm></cindex> <para>The <code>\newpage</code> command ends the current page, but does not clear -floats (see <code>\clearpage</code> above). +floats (<pxref label="_005cclearpage"><xrefnodename>\clearpage</xrefnodename></pxref>). </para> </section> <node name="_005cenlargethispage" spaces=" "><nodename>\enlargethispage</nodename><nodenext automatic="on">\pagebreak & \nopagebreak</nodenext><nodeprev automatic="on">\newpage</nodeprev><nodeup automatic="on">Page breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\enlargethispage</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="308">\enlargethispage</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="214">enlarge current page</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="356">\enlargethispage</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="225">enlarge current page</indexterm></cindex> <para><code>\enlargethispage{size}</code> </para> <para><code>\enlargethispage*{size}</code> </para> <para>Enlarge the <code>\textheight</code> for the current page by the specified -amount; e.g. <code>\enlargethispage{\baselineskip}</code> will allow one +amount; e.g., <code>\enlargethispage{\baselineskip}</code> will allow one additional line. </para> <para>The starred form tries to squeeze the material together on the page as @@ -3598,10 +4636,11 @@ much as possible. This is normally used together with an explicit </section> <node name="_005cpagebreak-_0026-_005cnopagebreak" spaces=" "><nodename>\pagebreak & \nopagebreak</nodename><nodeprev automatic="on">\enlargethispage</nodeprev><nodeup automatic="on">Page breaking</nodeup></node> <section spaces=" "><sectiontitle><code>\pagebreak</code> & <code>\nopagebreak</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="309">\pagebreak</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="310">\nopagebreak</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="215">page break, forcing</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="216">page break, preventing</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="357">\pagebreak</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="358">\nopagebreak</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="226">page break, forcing</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="227">page break, preventing</indexterm></cindex> <para>Synopses: </para> @@ -3625,25 +4664,43 @@ insistent the request is. </chapter> <node name="Footnotes" spaces=" "><nodename>Footnotes</nodename><nodenext automatic="on">Definitions</nodenext><nodeprev automatic="on">Page breaking</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Footnotes</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="217">footnotes, creating</indexterm></cindex> -<para>Footnotes can be produced in one of two ways. They can be produced -with one command, the <code>\footnote</code> command. They can also be -produced with two commands, the <code>\footnotemark</code> and the -<code>\footnotetext</code> commands. +<cindex index="cp" spaces=" "><indexterm index="cp" number="228">footnotes, creating</indexterm></cindex> + +<para>Place a numbered footnote at the bottom of the current page, as here. +</para> +<example endspaces=" "> +<pre xml:space="preserve">No<accent type="uml">e</accent>l Coward quipped that having to read a footnote is like having +to go downstairs to answer the door, while in the midst of making +love.\footnote{I wouldn't know, I don't read footnotes.} +</pre></example> + +<para>You can place multiple footnotes on a page. If the text becomes too long +it will flow to the next page. +</para> +<para>You can also produce footnotes by combining the <code>\footnotemark</code> and +the <code>\footnotetext</code> commands, which is useful in special +circumstances. +</para> +<para>To make bibliographic references come out as footnotes you need to +include a bibliographic style with that behavior. </para> <menu endspaces=" "> -<menuentry leadingtext="* "><menunode separator=":: ">\footnote</menunode><menudescription><pre xml:space="preserve">Insert a footnote. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\footnotemark</menunode><menudescription><pre xml:space="preserve">Insert footnote mark only. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\footnotetext</menunode><menudescription><pre xml:space="preserve">Insert footnote text only. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Symbolic footnotes</menunode><menudescription><pre xml:space="preserve">Using symbols instead of numbers for footnotes. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Footnote parameters</menunode><menudescription><pre xml:space="preserve">Parameters for footnote formatting. +<menuentry leadingtext="* "><menunode separator=":: ">\footnote</menunode><menudescription><pre xml:space="preserve">Insert a footnote. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\footnotemark</menunode><menudescription><pre xml:space="preserve">Insert footnote mark only. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\footnotetext</menunode><menudescription><pre xml:space="preserve">Insert footnote text only. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Footnotes in a table</menunode><menudescription><pre xml:space="preserve">Table footnotes. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Footnotes in section headings</menunode><menudescription><pre xml:space="preserve">Chapter or section titles. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Footnotes of footnotes</menunode><menudescription><pre xml:space="preserve">Multiple classes of footnotes. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Multiple reference to footnotes</menunode><menudescription><pre xml:space="preserve">Referring to a footnote more than once. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">Footnote parameters</menunode><menudescription><pre xml:space="preserve">Parameters for footnote formatting. </pre></menudescription></menuentry></menu> <node name="_005cfootnote" spaces=" "><nodename>\footnote</nodename><nodenext automatic="on">\footnotemark</nodenext><nodeup automatic="on">Footnotes</nodeup></node> <section spaces=" "><sectiontitle><code>\footnote</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="311">\footnote</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="359">\footnote</indexterm></findex> <para>Synopsis: </para> @@ -3651,91 +4708,253 @@ produced with two commands, the <code>\footnotemark</code> and the <pre xml:space="preserve">\footnote[<var>number</var>]{<var>text</var>} </pre></example> -<para>The <code>\footnote</code> command places the numbered footnote <var>text</var> -at the bottom of the current page. The optional argument <var>number</var> -changes the default footnote number. +<para>Place a numbered footnote <var>text</var> at the bottom of the current page. </para> -<para>This command can only be used in outer paragraph mode; i.e., you -cannot use it in sectioning commands like <code>\chapter</code>, in figures, -tables or in a <code>tabular</code> environment. (See following sections.) +<example endspaces=" "> +<pre xml:space="preserve">There are over a thousand footnotes in Gibbon's +\textit{Decline and Fall of the Roman Empire}.\footnote{After +reading an early version with endnotes David Hume complained, +``One is also plagued with his Notes, according to the present Method +of printing the Book'' and suggested that they ``only to be printed +at the Margin or the Bottom of the Page.''} +</pre></example> + +<para>The optional argument <var>number</var> allows you to specify the footnote +number. If you use this option then the footnote number counter is not +incremented, and if you do not use it then the counter is incremented. +</para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="229">footnotes, symbols instead of numbers</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="360">\fnsymbol<r>, and footnotes</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="361">\&arobase;fnsymbol</indexterm></findex> +<para>Change how &latex; shows the footnote counter with something like +<code>\renewcommand{\thefootnote}{\fnsymbol{footnote}}</code>, which +uses a sequence of symbols (<pxref label="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol"><xrefnodename>\alph \Alph \arabic \roman \Roman +\fnsymbol</xrefnodename></pxref>). To make this change global put that in the preamble. If +you make the change local then you may want to reset the counter with +<code>\setcounter{footnote}{0}</code>. By default &latex; uses arabic +numbers. +</para> +<para>&latex;&textrsquo;s default puts many restrictions on where you can use a +<code>\footnote</code>; for instance, you cannot use it in an argument to a +sectioning command such as <code>\chapter</code> (it can only be used in outer +paragraph mode). There are some workarounds; see following sections. <!-- c xx mention packages that fix this --> </para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="230">Footnotes, in a minipage</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="231">mpfootnote counter</indexterm></cindex> +<para>In a <code>minipage</code> environment the <code>\footnote</code> +command uses the <code>mpfootnote</code> counter instead of the +<code>footnote</code> counter, so they are numbered independently. They are +shown at the bottom of the environment, not at the bottom of the page. +And by default they are shown alphabetically. <xref label="minipage"><xrefnodename>minipage</xrefnodename></xref>. +</para> </section> <node name="_005cfootnotemark" spaces=" "><nodename>\footnotemark</nodename><nodenext automatic="on">\footnotetext</nodenext><nodeprev automatic="on">\footnote</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> <section spaces=" "><sectiontitle><code>\footnotemark</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="312">\footnotemark</indexterm></findex> -<para>With no optional argument, the <code>\footnotemark</code> command puts the -current footnote number in the text. This command can be used in -inner paragraph mode. You give the text of the footnote separately, -with the <code>\footnotetext</code> command. -</para> -<para>This command can be used to produce several consecutive footnote -markers referring to the same footnote with +<findex index="fn" spaces=" "><indexterm index="fn" number="362">\footnotemark</indexterm></findex> + +<para>Synopsis, one of: </para> <example endspaces=" "> -<pre xml:space="preserve">\footnotemark[\value{footnote}] +<pre xml:space="preserve">\footnotemark +\footnotemark[<var>number</var>] </pre></example> -<noindent></noindent> -<para>after the first <code>\footnote</code> command. +<para>Put the current footnote number in the +text. (See <ref label="_005cfootnotetext"><xrefnodename>\footnotetext</xrefnodename></ref> for giving the text of the footnote +separately.) The version with the optional argument <var>number</var> uses +that number to determine the mark printed. This command can be used in +inner paragraph mode. +</para> +<para>This example gives the same institutional affiliation to both the first +and third authors (<code>\thanks</code> is a version of <code>footnote</code>). +</para> +<example endspaces=" "> +<pre xml:space="preserve">\title{A Treatise on the Binomial Theorem} +\author{J Moriarty\thanks{University of Leeds} + \and A C Doyle\thanks{Durham University} + \and S Holmes\footnotemark[1]} +\begin{document} +\maketitle +</pre></example> + +<para>If you use <code>\footnotemark</code> without the optional argument then it +increments the footnote counter but if you use the optional <var>number</var> +then it does not. This produces several consecutive footnote markers +referring to the same footnote. </para> +<example endspaces=" "> +<pre xml:space="preserve">The first theorem\footnote{Due to Gauss.} +and the second theorem\footnotemark[\value{footnote}] +and the third theorem.\footnotemark[\value{footnote}] +</pre></example> + </section> -<node name="_005cfootnotetext" spaces=" "><nodename>\footnotetext</nodename><nodenext automatic="on">Symbolic footnotes</nodenext><nodeprev automatic="on">\footnotemark</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> +<node name="_005cfootnotetext" spaces=" "><nodename>\footnotetext</nodename><nodenext automatic="on">Footnotes in a table</nodenext><nodeprev automatic="on">\footnotemark</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> <section spaces=" "><sectiontitle><code>\footnotetext</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="313">\footnotetext</indexterm></findex> -<para>Synopsis: +<findex index="fn" spaces=" "><indexterm index="fn" number="363">\footnotetext</indexterm></findex> + +<para>Synopsis, one of: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\footnotetext{<var>text</var>} +\footnotetext[<var>number</var>]{<var>text</var>} +</pre></example> + +<para>Place <var>text</var> at the bottom of the page as a footnote. This command +can come anywhere after the <code>\footnotemark</code> command. The optional +argument <var>number</var> changes the displayed footnote number. The +<code>\footnotetext</code> command must appear in outer paragraph mode. +</para> + +</section> +<node name="Footnotes-in-a-table" spaces=" "><nodename>Footnotes in a table</nodename><nodenext automatic="on">Footnotes in section headings</nodenext><nodeprev automatic="on">\footnotetext</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> +<section spaces=" "><sectiontitle>Footnotes in a table</sectiontitle> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="232">Footnotes, in a table</indexterm></cindex> + +<para>Inside a <code>table</code> environment the <code>\footnote</code> command does not +work. For instance, if the code below appears on its own then the +footnote simply disappears; there is a footnote mark in the table cell +but nothing is set at the bottom of the page. </para> <example endspaces=" "> -<pre xml:space="preserve">\footnotetext[<var>number</var>]{<var>text</var>} +<pre xml:space="preserve">\begin{center} + \begin{tabular}{l|l} + \textsc{Ship} &\textsc{Book} \\ \hline + \textit{HMS Sophie} &Master and Commander \\ + \textit{HMS Polychrest} &Post Captain \\ + \textit{HMS Lively} &Post Captain \\ + \textit{HMS Surprise} &A number of books\footnote{Starting with HMS Surprise.} + \end{tabular} +\end{center} </pre></example> -<para>The <code>\footnotetext</code> command places <var>text</var> at the bottom of -the page as a footnote. This command can come anywhere after the -<code>\footnotemark</code> command. The <code>\footnotetext</code> command must -appear in outer paragraph mode. +<para>The solution is to surround the <code>tabular</code> environment with a +<code>minipage</code> environment, as here (<pxref label="minipage"><xrefnodename>minipage</xrefnodename></pxref>). </para> -<para>The optional argument <var>number</var> changes the default footnote number. +<example endspaces=" "> +<pre xml:space="preserve">\begin{center} + \begin{minipage}{.5\textwidth} + .. tabular material .. + \end{minipage} +\end{center} +</pre></example> + +<para>The same technique will work inside a floating <code>table</code> environment +(<pxref label="table"><xrefnodename>table</xrefnodename></pxref>). To get the footnote at the bottom of the page use the +<file>tablefootnote</file> package, as illustrated in this example. If you +put <code>\usepackage{tablefootnote}</code> in the preamble and use the code +shown then the footnote appears at the bottom and is numbered in +sequence with other footnotes. </para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{table} + \centering + \begin{tabular}{l|l} + \textsc{Date} &\textsc{Campaign} \\ \hline + 1862 &Fort Donelson \\ + 1863 &Vicksburg \\ + 1865 &Army of Northern Virginia\footnote{Ending the war.} + \end{tabular} + \caption{Forces captured by US Grant} +\end{table} +</pre></example> + </section> -<node name="Symbolic-footnotes" spaces=" "><nodename>Symbolic footnotes</nodename><nodenext automatic="on">Footnote parameters</nodenext><nodeprev automatic="on">\footnotetext</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> -<section spaces=" "><sectiontitle>Symbolic footnotes</sectiontitle> +<node name="Footnotes-in-section-headings" spaces=" "><nodename>Footnotes in section headings</nodename><nodenext automatic="on">Footnotes of footnotes</nodenext><nodeprev automatic="on">Footnotes in a table</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> +<section spaces=" "><sectiontitle>Footnotes in section headings</sectiontitle> + +<para>Putting a footnote in a section heading +</para> +<example endspaces=" "> +<pre xml:space="preserve">\section{Full sets\protect\footnote{This material is due to R~Jones.}} +</pre></example> -<cindex index="cp" spaces=" "><indexterm index="cp" number="218">footnotes, symbolic instead of numbered</indexterm></cindex> -<para>If you want to use symbols for footnotes, rather than increasing -numbers, redefine <code>\thefootnote</code> like this: +<para>causes the footnote to appear both at the bottom of the page where the +section starts and at the bottom of the table of contents page. To have +it not appear on the table of contents use the package <file>footmisc</file> +with the <code>stable</code> option. </para> <example endspaces=" "> -<pre xml:space="preserve">\renewcommand{\thefootnote}{\fnsymbol{footnote}} +<pre xml:space="preserve">\usepackage[stable]{footmisc} + .. +\begin{document} + .. +\section{Full sets\footnote{This material is due to R~Jones.}} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="314">\fnsymbol<r>, and footnotes</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="315">\&arobase;fnsymbol</indexterm></findex> -<para>The <code>\fnsymbol</code> command produces a predefined series of symbols -(<pxref label="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol"><xrefnodename>\alph \Alph \arabic \roman \Roman \fnsymbol</xrefnodename></pxref>). If you want to -use a different symbol as your footnote mark, you&textrsquo;ll need to also -redefine <code>\&arobase;fnsymbol</code>. +<para>Note that the <code>\protect</code> is gone; putting it in causes the +footnote to reappear on the table of contents. +</para> + +</section> +<node name="Footnotes-of-footnotes" spaces=" "><nodename>Footnotes of footnotes</nodename><nodenext automatic="on">Multiple reference to footnotes</nodenext><nodeprev automatic="on">Footnotes in section headings</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> +<section spaces=" "><sectiontitle>Footnotes of footnotes</sectiontitle> + +<para>Particularly in the humanities, authors can have multiple classes of +footnotes, including having footnotes of footnotes. The package +<file>bigfoot</file> extends &latex;&textrsquo;s default footnote mechanism in many +ways, including allow these two, as in this example. </para> +<example endspaces=" "> +<pre xml:space="preserve">\usepackage{bigfoot} +\DeclareNewFootnote{Default} +\DeclareNewFootnote{from}[alph] % create class \footnotefrom{} + .. +\begin{document} + .. +The third theorem is a partial converse of the +second.\footnotefrom{First noted in Wilson.\footnote{Second edition only.}} + .. +</pre></example> + </section> -<node name="Footnote-parameters" spaces=" "><nodename>Footnote parameters</nodename><nodeprev automatic="on">Symbolic footnotes</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> +<node name="Multiple-reference-to-footnotes" spaces=" "><nodename>Multiple reference to footnotes</nodename><nodenext automatic="on">Footnote parameters</nodenext><nodeprev automatic="on">Footnotes of footnotes</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> +<section spaces=" "><sectiontitle>Multiple references to footnotes</sectiontitle> + +<para>You can refer to a single footnote more than once. This example +uses the package <file>cleverref</file>. +</para> +<!-- c from SE user Jake http://tex.stackexchange.com/a/10116/339 --> +<example endspaces=" "> +<pre xml:space="preserve">\usepackage{cleveref}[2012/02/15] % this version of package or later +\crefformat{footnote}{#2\footnotemark[#1]#3} + .. +\begin{document} + .. +The theorem is from Evers.\footnote{\label{fn:TE}Tinker and Evers, 1994.} +The corollary is from Chance.\footnote{Evers and Chance, 1990.} +But the key lemma is from Tinker.\cref{fn:TE} + .. +</pre></example> + +<para>This solution will work with the package <file>hyperref</file>. +See <ref label="_005cfootnotemark"><xrefnodename>\footnotemark</xrefnodename></ref> for a simpler solution in the common case +of multiple authors with the same affiliation. +</para> + +</section> +<node name="Footnote-parameters" spaces=" "><nodename>Footnote parameters</nodename><nodeprev automatic="on">Multiple reference to footnotes</nodeprev><nodeup automatic="on">Footnotes</nodeup></node> <section spaces=" "><sectiontitle>Footnote parameters</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="219">footnote parameters</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="220">parameters, for footnotes</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="233">footnote parameters</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="234">parameters, for footnotes</indexterm></cindex> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="316">\footnoterule</indexterm>\footnoterule</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="364">\footnoterule</indexterm>\footnoterule</itemformat></item> </tableterm><tableitem><para>Produces the rule separating the main text on a page from the page&textrsquo;s footnotes. Default dimensions: <code>0.4pt</code> thick (or wide), and <code>0.4\columnwidth</code> long in the standard document classes (except <code>slides</code>, where it does not appear). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="317">\footnotesep</indexterm>\footnotesep</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="365">\footnotesep</indexterm>\footnotesep</itemformat></item> </tableterm><tableitem><para>The height of the strut placed at the beginning of the footnote. By default, this is set to the normal strut for <code>\footnotesize</code> fonts (<pxref label="Font-sizes"><xrefnodename>Font sizes</xrefnodename></pxref>), therefore there is no extra space between @@ -3749,63 +4968,80 @@ footnotes. This is <samp>6.65pt</samp> for <samp>10pt</samp>, <samp>7.7pt</samp </chapter> <node name="Definitions" spaces=" "><nodename>Definitions</nodename><nodenext automatic="on">Counters</nodenext><nodeprev automatic="on">Footnotes</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Definitions</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="221">definitions</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="235">definitions</indexterm></cindex> <para>&latex; has support for making new commands of many different kinds. </para> <!-- c xx everything in this chapter needs examples. --> <menu endspaces=" "> -<menuentry leadingtext="* "><menunode separator=":: ">\newcommand & \renewcommand</menunode><menudescription><pre xml:space="preserve">(Re)define a new command. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newcounter</menunode><menudescription><pre xml:space="preserve">Define a new counter. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newlength</menunode><menudescription><pre xml:space="preserve">Define a new length. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newsavebox</menunode><menudescription><pre xml:space="preserve">Define a new box. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newenvironment & \renewenvironment</menunode><menudescription><pre xml:space="preserve">Define a new environment. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newtheorem</menunode><menudescription><pre xml:space="preserve">Define a new <code>theorem</code>-like environment. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newfont</menunode><menudescription><pre xml:space="preserve">Define a new font name. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\protect</menunode><menudescription><pre xml:space="preserve">Using tricky commands. +<menuentry leadingtext="* "><menunode separator=":: ">\newcommand & \renewcommand</menunode><menudescription><pre xml:space="preserve">(Re)define a new command. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\providecommand</menunode><menudescription><pre xml:space="preserve">Define a new command, if name not used. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newcounter</menunode><menudescription><pre xml:space="preserve">Define a new counter. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newlength</menunode><menudescription><pre xml:space="preserve">Define a new length. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newsavebox</menunode><menudescription><pre xml:space="preserve">Define a new box. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newenvironment & \renewenvironment</menunode><menudescription><pre xml:space="preserve">Define a new environment. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newtheorem</menunode><menudescription><pre xml:space="preserve">Define a new theorem-like environment. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\newfont</menunode><menudescription><pre xml:space="preserve">Define a new font name. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\protect</menunode><menudescription><pre xml:space="preserve">Using tricky commands. </pre></menudescription></menuentry></menu> -<node name="_005cnewcommand-_0026-_005crenewcommand" spaces=" "><nodename>\newcommand & \renewcommand</nodename><nodenext automatic="on">\newcounter</nodenext><nodeup automatic="on">Definitions</nodeup></node> +<node name="_005cnewcommand-_0026-_005crenewcommand" spaces=" "><nodename>\newcommand & \renewcommand</nodename><nodenext automatic="on">\providecommand</nodenext><nodeup automatic="on">Definitions</nodeup></node> <section spaces=" "><sectiontitle><code>\newcommand</code> & <code>\renewcommand</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="318">\newcommand</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="222">commands, defining new ones</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="223">defining a new command</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="224">new commands, defining</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="366">\newcommand</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="236">commands, defining new ones</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="237">commands, redefining</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="238">defining a new command</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="239">new commands, defining</indexterm></cindex> <para><code>\newcommand</code> and <code>\renewcommand</code> define and redefine a command, respectively. Synopses: </para> <example endspaces=" "> -<pre xml:space="preserve"> \newcommand[*]{<var>cmd</var>}[<var>nargs</var>][<var>optargval</var>]{<var>defn</var>} -\renewcommand[*]{<var>cmd</var>}[<var>nargs</var>][<var>optargval</var>]{<var>defn</var>} +<pre xml:space="preserve"> \newcommand{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} + \newcommand*{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +\renewcommand{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +\renewcommand*{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} </pre></example> -<table commandarg="var" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="var"><code>*</code></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="225">*-form of defining new commands</indexterm></cindex> -<para>The *-form of these commands requires that the arguments not contain -multiple paragraphs of text (not <code>\long</code>, in plain &tex; terms). +<para>The <code>*</code>-form of these two commands requires that the arguments +not contain multiple paragraphs of text (not <code>\long</code>, in plain +&tex; terms). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">cmd</itemformat></item> -</tableterm><tableitem><para>The command name, beginning with <code>\</code>. For <code>\newcommand</code>, it -must not be already defined and must not begin with <code>\end</code>; for -<code>\renewcommand</code>, it must already be defined. +<table commandarg="var" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="var">cmd</itemformat></item> +</tableterm><tableitem><para>Required; the command name. It must begin with <code>\</code>. For +<code>\newcommand</code>, it must not be already defined and must not begin +with <code>\end</code>. For <code>\renewcommand</code>, it must already be +defined. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">nargs</itemformat></item> -</tableterm><tableitem><para>An optional integer from 1 to 9 specifying the number of arguments -that the command will take. The default is for the command to have no -arguments. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">optargval</itemformat></item> -</tableterm><tableitem><para>If this optional parameter is present, it means that the first -argument of command <var>cmd</var> is optional and its default value (i.e., -if it is not specified in the call) is <var>optarg</var>. In otherwise, -when calling the macro, if no <code>[<var>value</var>]</code> is given after -<code><var>cmd</var></code>&textmdash;which is different from having <code>[]</code> for an -empty <var>value</var>&textmdash;then string <samp><var>optargval</var></samp> becomes the -value of <code>#1</code> within <var>defn</var> when the macro is expanded. +</tableterm><tableitem><para>Optional; an integer from 0 to 9, specifying the number of arguments +that the command will take. If this argument is not present, the +default is for the command to have no arguments. When redefining a +command, the new version can have a different number of arguments than +the old version. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">optargdefault</itemformat></item> +</tableterm><tableitem><para>Optional; if this argument is present then the first argument of defined +command <var>\cmd</var> is optional, with default value <var>optargdefault</var> +(which may be the empty string). If this argument is not present then +<var>\cmd</var> does not take an optional argument. +</para> +<para>That is, if <var>\cmd</var> is used with square brackets following, as in +<code>\<var>cmd</var>[<var>myval</var>]</code>, then within <var>defn</var> <code>#1</code> expands +<var>myval</var>. While if <var>\cmd</var> is called without square brackets +following, then within <var>defn</var> the <code>#1</code> expands to the default +<var>optargdefault</var>. In either case, any required arguments will be +referred to starting with <code>#2</code>. +</para> +<para>Omitting <code>[<var>myval</var>]</code> in the call is different from having the +square brackets with no contents, as in <code>[]</code>. The former results +in <code>#1</code> expanding to <var>optargdefault</var>; the latter results in +<code>#1</code> expanding to the empty string. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">defn</itemformat></item> </tableterm><tableitem><para>The text to be substituted for every occurrence of <code>cmd</code>; a @@ -3814,13 +5050,83 @@ text of the <var>n</var>th argument. </para> </tableitem></tableentry></table> -<!-- c xx \providecommand, * form (non-\long) --> +<para>A command with no arguments that is followed in the source by a space +will swallow that space. The solution is to type <code>{}</code> after the +command and before the space. +</para> +<para>A simple example of defining a new command: +<code>\newcommand{\JH}{Jim Hef{}feron}</code> causes the abbreviation +<code>\JH</code> to be replaced by the longer text. +</para> +<para>Redefining a command is basically the same: +<code>\renewcommand{\qedsymbol}{{\small QED}}</code>. +</para> +<para>Here&textrsquo;s a command definition that uses arguments: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newcommand{\defreference}[1]{Definition~\ref{#1}} +</pre></example> + +<noindent></noindent> <para>Then, <code>\defreference{def:basis}</code> will expand to +something like <samp>Definition~3.14</samp>. +</para> +<para>An example with two arguments: +<code>\newcommand{\nbym}[2]{#1\!\times\!#2}</code> is invoked as +<code>\nbym{2}{k}</code>. +</para> +<para>An example with optional arguments: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newcommand{\salutation}[1][Sir or Madam]{Dear #1:} +</pre></example> + +<noindent></noindent> <para>Then, <code>\salutation</code> gives <samp>Dear Sir or Madam:</samp> while +<code>\salutation[John]</code> gives <samp>Dear John:</samp>. And +<code>\salutation[]</code> gives <samp>Dear :</samp>. +</para> +<para>The braces around <var>defn</var> do not delimit the scope of the result of +expanding <var>defn</var>. So <code>\newcommand{\shipname}[1]{\it #1}</code> +is wrong since in the sentence +</para> +<example endspaces=" "> +<pre xml:space="preserve">The \shipname{Monitor} met the \shipname{Virginia}. +</pre></example> + +<noindent></noindent> <para>the words <samp>met the</samp> will incorrectly be in italics. An +extra pair of braces <code>\newcommand{\shipname}[1]{{\it #1}}</code> +fixes it. +</para> + +</section> +<node name="_005cprovidecommand" spaces=" "><nodename trailingspaces=" ">\providecommand</nodename><nodenext automatic="on">\newcounter</nodenext><nodeprev automatic="on">\newcommand & \renewcommand</nodeprev><nodeup automatic="on">Definitions</nodeup></node> +<section spaces=" "><sectiontitle><code>\providecommand</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="367">\providecommand</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="240">commands, defining new ones</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="241">defining a new command</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="242">new commands, defining</indexterm></cindex> + +<para>Defines a command, as long as no command of this name already exists. +Synopses: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\providecommand{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +\providecommand*{<var>cmd</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>defn</var>} +</pre></example> + +<para>If no command of this name already exists then this has the same effect +as <code>\newcommand</code> (<pxref label="_005cnewcommand-_0026-_005crenewcommand"><xrefnodename>\newcommand & \renewcommand</xrefnodename></pxref>). If a +command of this name already exists then this definition does nothing. +This is particularly useful in a style file, or other file that may be +loaded more than once. +</para> </section> -<node name="_005cnewcounter" spaces=" "><nodename>\newcounter</nodename><nodenext automatic="on">\newlength</nodenext><nodeprev automatic="on">\newcommand & \renewcommand</nodeprev><nodeup automatic="on">Definitions</nodeup></node> -<section spaces=" "><sectiontitle><code>\newcounter</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="319">\newcounter</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="226">counters, defining new</indexterm></cindex> +<node name="_005cnewcounter" spaces=" "><nodename>\newcounter</nodename><nodenext automatic="on">\newlength</nodenext><nodeprev automatic="on">\providecommand</nodeprev><nodeup automatic="on">Definitions</nodeup></node> +<section spaces=" "><sectiontitle><code>\newcounter</code>: Allocating a counter</sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="368">\newcounter</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="243">counters, defining new</indexterm></cindex> <para>Synopsis: </para> @@ -3828,206 +5134,462 @@ text of the <var>n</var>th argument. <pre xml:space="preserve">\newcounter{<var>countername</var>}[<var>supercounter</var>] </pre></example> -<para>The <code>\newcounter</code> command defines a new counter named <var>countername</var>. -The new counter is initialized to zero. +<para>The <code>\newcounter</code> command globally defines a new counter named +<var>countername</var>. The name consists of letters only and does not begin +with a backslash (<samp>\</samp>). The name must not already be used by +another counter. The new counter is initialized to zero. </para> -<para>Given the optional argument <code>[<var>super</var>]</code>, <var>countername</var> -will be reset whenever the counter named <var>supercounter</var> is incremented. +<para>If the optional argument <code>[<var>supercounter</var>]</code> appears, then +<var>countername</var> will be numbered within, or subsidiary to, the +existing counter <var>supercounter</var>. For example, ordinarily +<code>subsection</code> is numbered within <code>section</code>. Any time +<var>supercounter</var> is incremented with <code>\stepcounter</code> +(<pxref label="_005cstepcounter"><xrefnodename>\stepcounter</xrefnodename></pxref>) or <code>\refstepcounter</code> +(<pxref label="_005crefstepcounter"><xrefnodename>\refstepcounter</xrefnodename></pxref>) then <var>countername</var> is reset to zero. </para> <para><xref label="Counters"><xrefnodename>Counters</xrefnodename></xref>, for more information about counters. </para> </section> <node name="_005cnewlength" spaces=" "><nodename>\newlength</nodename><nodenext automatic="on">\newsavebox</nodenext><nodeprev automatic="on">\newcounter</nodeprev><nodeup automatic="on">Definitions</nodeup></node> -<section spaces=" "><sectiontitle><code>\newlength</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="320">\newlength</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="227">lengths, defining new</indexterm></cindex> +<section spaces=" "><sectiontitle><code>\newlength</code>: Allocating a length</sectiontitle> -<para>Synopsis: +<findex index="fn" spaces=" "><indexterm index="fn" number="369">\newlength</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="244">lengths, allocating new</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="245">rubber lengths, defining new</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="246">skip register, plain &tex;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="247">glue register, plain &tex;</indexterm></cindex> + +<para>Allocate a new <dfn>length</dfn> register. Synopsis: </para> <example endspaces=" "> <pre xml:space="preserve">\newlength{\<var>arg</var>} </pre></example> -<para>The <code>\newlength</code> command defines the mandatory argument as a -<dfn>length</dfn> command with a value of zero. The argument must -be a control sequence, as in <code>\newlength{\foo}</code>. An error -occurs if <code>\foo</code> is already defined. +<para>This command takes one required argument, which must begin with a +backslash (<samp>\</samp>). It creates a new length register named +<code>\<var>arg</var></code>, which is a place to hold (rubber) lengths such as +<code>1in plus.2in minus.1in</code> (what plain &tex; calls a <code>skip</code> +register). The register gets an initial value of zero. The control +sequence <code>\<var>arg</var></code> must not already be defined. </para> -<para><xref label="Lengths"><xrefnodename>Lengths</xrefnodename></xref>, for how to set the new length to a nonzero value, and -for more information about lengths in general. +<para><xref label="Lengths"><xrefnodename>Lengths</xrefnodename></xref>, for more about lengths. </para> </section> <node name="_005cnewsavebox" spaces=" "><nodename>\newsavebox</nodename><nodenext automatic="on">\newenvironment & \renewenvironment</nodenext><nodeprev automatic="on">\newlength</nodeprev><nodeup automatic="on">Definitions</nodeup></node> -<section spaces=" "><sectiontitle><code>\newsavebox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="321">\newsavebox</indexterm></findex> +<section spaces=" "><sectiontitle><code>\newsavebox</code>: Allocating a box</sectiontitle> -<para>Synopsis: +<findex index="fn" spaces=" "><indexterm index="fn" number="370">\newsavebox</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="248">box, allocating new</indexterm></cindex> + +<para>Allocate a &textldquo;bin&textrdquo; for holding a box. Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\newsavebox{<var>cmd</var>} +<pre xml:space="preserve">\newsavebox{\<var>cmd</var>} </pre></example> -<para>Defines <code>\<var>cmd</var></code>, which must be a command name not already -defined, to refer to a new bin for storing boxes. +<para>Defines <code>\<var>cmd</var></code> to refer to a new bin for storing boxes. +Such a box is for holding typeset material, to use multiple times +(<pxref label="Boxes"><xrefnodename>Boxes</xrefnodename></pxref>) or to measure or manipulate. The name +<code>\<var>cmd</var></code> must start with a backslash (<samp>\</samp>), and must not +be already defined. +</para> +<para>The allocation of a box is global. This command is fragile +(<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). </para> </section> <node name="_005cnewenvironment-_0026-_005crenewenvironment" spaces=" "><nodename>\newenvironment & \renewenvironment</nodename><nodenext automatic="on">\newtheorem</nodenext><nodeprev automatic="on">\newsavebox</nodeprev><nodeup automatic="on">Definitions</nodeup></node> <section spaces=" "><sectiontitle><code>\newenvironment</code> & <code>\renewenvironment</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="322">\newenvironment</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="323">\renewenvironment</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="228">environments, defining</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="229">defining new environments</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="230">redefining environments</indexterm></cindex> -<para>Synopses: +<findex index="fn" spaces=" "><indexterm index="fn" number="371">\newenvironment</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="372">\renewenvironment</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="249">environments, defining</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="250">defining new environments</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="251">redefining environments</indexterm></cindex> + +<para>These commands define or redefine an environment <var>env</var>, that is, +<code>\begin{<var>env</var>} &dots; \end{<var>env</var>}</code>. Synopses: </para> <example endspaces=" "> -<pre xml:space="preserve"> \newenvironment[*]{<var>env</var>}[<var>nargs</var>][<var>default</var>]{<var>begdef</var>}{<var>enddef</var>} -\renewenvironment[*]{<var>env</var>}[<var>nargs</var>]{<var>begdef</var>}{<var>enddef</var>} +<pre xml:space="preserve"> \newenvironment{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} + \newenvironment*{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} +\renewenvironment{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} +\renewenvironment*{<var>env</var>}[<var>nargs</var>][<var>optargdefault</var>]{<var>begdefn</var>}{<var>enddefn</var>} </pre></example> -<para>These commands define or redefine an environment <var>env</var>, that is, -<code>\begin{<var>env</var>} &dots; \end{<var>env</var>}</code>. +<para>Unlike <code>\newcommand</code> and <code>\renewcommand</code>, the <code>*</code>-forms +<code>\newenvironment*</code> and <code>\renewcommand*</code> have the same effect +as the forms with no <code>*</code>. </para> <table commandarg="var" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="var"><code>*</code></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="231">*-form of environment commands</indexterm></cindex> -<para>The *-form of these commands requires that the arguments (not the -contents of the environment) not contain multiple paragraphs of text. -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">env</itemformat></item> -</tableterm><tableitem><para>The name of the environment. For <code>\newenvironment</code>, <var>env</var> -must not be an existing environment, and the command <code>\<var>env</var></code> -must be undefined. For <code>\renewenvironment</code>, <var>env</var> must be -the name of an existing environment. +<tableentry><tableterm><item spaces=" "><itemformat command="var">env</itemformat></item> +</tableterm><tableitem><para>Required; the environment name. It does not begin with backslash +(<code>\</code>). It must not begin with the string <code>end</code>. For +<code>\newenvironment</code>, the name <var>env</var> must not be the name of an +already existing environment, and also the command <code>\<var>env</var></code> +must be undefined. For <code>\renewenvironment</code>, <var>env</var> must be the +name of an existing environment. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">nargs</itemformat></item> -</tableterm><tableitem><para>An integer from 1 to 9 denoting the number of arguments of -the newly-defined environment. The default is no arguments. +</tableterm><tableitem><para>Optional; an integer from 0 to 9 denoting the number of arguments of +that the environment will take. These arguments appear after the +<code>\begin</code>, as in +<code>\begin{<var>env</var>}{<var>arg1</var>}&dots;{<var>argn</var>}</code>. If this +argument is not present then the default is for the environment to have +no arguments. When redefining an environment, the new version can have +a different number of arguments than the old version. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">optargdefault</itemformat></item> +</tableterm><tableitem><para>Optional; if this argument is present then the first argument of the +defined environment is optional, with default value <var>optargdefault</var> +(which may be the empty string). If this argument is not present then +the environment does not take an optional argument. +</para> +<para>That is, when <code>[<var>optargdefault</var>]</code> is present in the environment +definition, if <code>\begin{<var>env</var>}</code> is used with square brackets +following, as in <code>\begin{<var>env</var>}[<var>myval</var>]</code>, then within +the environment <code>#1</code> expands <var>myval</var>. If +<code>\begin{<var>env</var>}</code> is called without square brackets following, +then within the environment the <code>#1</code> expands to the default +<var>optargdefault</var>. In either case, any required arguments will be +referred to starting with <code>#2</code>. +</para> + +<para>Omitting <code>[<var>myval</var>]</code> in the call is different from having the +square brackets with no contents, as in <code>[]</code>. The former results +in <code>#1</code> expanding to <var>optargdefault</var>; the latter results in +<code>#1</code> expanding to the empty string. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">begdefn</itemformat></item> +</tableterm><tableitem><para>Required; the text expanded at every occurrence of +<code>\begin{<var>env</var>}</code>; a construct of the form <code>#<var>n</var></code> in +<var>begdef</var> is replaced by the text of the <var>n</var>th argument. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">enddefn</itemformat></item> +</tableterm><tableitem><para>Required; the text expanded at every occurrence of +<code>\end{<var>env</var>}</code>. Note that it may not contain any argument +parameters, so <code>#<var>n</var></code> cannot be used here. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">default</itemformat></item> -</tableterm><tableitem><para>If this is specified, the first argument is optional, and <var>default</var> -gives the default value for that argument. +</tableitem></tableentry></table> + +<para>The environment <var>env</var> delimits the scope of the result of expanding +<var>begdefn</var> and <var>enddefn</var>. Thus, in the first example below, the +effect of the <code>\small</code> is limited to the quote and does not extend +to material following the environment. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">begdef</itemformat></item> -</tableterm><tableitem><para>The text expanded at every occurrence of <code>\begin{<var>env</var>}</code>; a -construct of the form <code>#<var>n</var></code> in <var>begdef</var> is replaced by -the text of the <var>n</var>th argument. +<para>This example gives an environment like &latex;&textrsquo;s <code>quotation</code> except that +it will be set in smaller type. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">enddef</itemformat></item> -</tableterm><tableitem><para>The text expanded at every occurrence of <code>\end{<var>env</var>}</code>. It -may not contain any argument parameters. +<example endspaces=" "> +<pre xml:space="preserve">\newenvironment{smallquote}{% + \small\begin{quotation} +}{% + \end{quotation} +} +</pre></example> + +<para>This shows the use of arguments; it gives a quotation environment that +cites the author. </para> -</tableitem></tableentry></table> +<example endspaces=" "> +<pre xml:space="preserve">\newenvironment{citequote}[1][Shakespeare]{% + \begin{quotation} + \noindent\textit{#1}: +}{% + \end{quotation} +} +</pre></example> + +<noindent></noindent> <para>The author&textrsquo;s name is optional, and defaults to Shakespeare. +In the document, use the environment as here: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{citequote}[Lincoln] + .. +\end{citequote} +</pre></example> + +<para>The final example shows how to save the value of an argument to use in +<var>enddefn</var>. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newsavebox{\quoteauthor} +\newenvironment{citequote}[1][Shakespeare]{% + \sbox\quoteauthor{#1}% + \begin{quotation} +}{% + \hspace{1em plus 1fill}---\usebox{\quoteauthor} + \end{quotation} +} +</pre></example> </section> <node name="_005cnewtheorem" spaces=" "><nodename>\newtheorem</nodename><nodenext automatic="on">\newfont</nodenext><nodeprev automatic="on">\newenvironment & \renewenvironment</nodeprev><nodeup automatic="on">Definitions</nodeup></node> <section spaces=" "><sectiontitle><code>\newtheorem</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="324">\newtheorem</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="232">theorems, defining</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="233">defining new theorems</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="373">\newtheorem</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="252">theorems, defining</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="253">defining new theorems</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="254">theorem-like environment</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="255">environment, theorem-like</indexterm></cindex> +<para>Define a new <dfn>theorem-like environment</dfn>. Synopses: +</para> <example endspaces=" "> -<pre xml:space="preserve">\newtheorem{<var>newenv</var>}{<var>label</var>}[<var>within</var>] -\newtheorem{<var>newenv</var>}[<var>numbered_like</var>]{<var>label</var>} +<pre xml:space="preserve">\newtheorem{<var>name</var>}{<var>title</var>}[<var>numbered_within</var>] +\newtheorem{<var>name</var>}[<var>numbered_like</var>]{<var>title</var>} </pre></example> -<para>This command defines a theorem-like environment. Arguments: +<para>Both create a theorem-like environment <var>name</var>. Using the first +form, +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newtheorem{<var>name</var>}{<var>title</var>}[<var>numbered_within</var>] +</pre></example> + +<noindent></noindent> <para>with the optional argument after the second required argument, +creates an environment whose counter is subordinate to the existing +counter <var>numbered_within</var>: it will be reset when +<var>numbered_within</var> is reset). +</para> +<para>Using the second form, +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newtheorem{<var>name</var>}[<var>numbered_like</var>]{<var>title</var>} +</pre></example> + +<noindent></noindent> <para>with the optional argument between the two required +arguments, will create an environment whose counter will share the +previously defined counter <var>numbered_like</var>. +</para> +<para>You can specify one of <var>numbered_within</var> and <var>numbered_like</var>, +or neither, but not both. +</para> +<para>This command creates a counter named <var>name</var>. In addition, unless +the optional argument <var>numbered_like</var> is used, the current +<code>\ref</code> value will be that of <code>\the<var>numbered_within</var></code> +(<pxref label="_005cref"><xrefnodename>\ref</xrefnodename></pxref>). +</para> +<para>This declaration is global. It is fragile (<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). +</para> +<para>Arguments: </para> <table commandarg="var" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="var">newenv</itemformat></item> -</tableterm><tableitem><para>The name of the environment to be defined; must not be the name of an -existing environment or otherwise defined. +<tableentry><tableterm><item spaces=" "><itemformat command="var">name</itemformat></item> +</tableterm><tableitem><para>The name of the environment. It must not begin with a backslash +(<samp>\</samp>). It must not be the name of an existing environment; indeed, +the command name <code>\<var>name</var></code> must not already be defined as anything. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">label</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">title</itemformat></item> </tableterm><tableitem><para>The text printed at the beginning of the environment, before the number. For example, <samp>Theorem</samp>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">numbered_like</itemformat></item> -</tableterm><tableitem><para>(Optional.) The name of an already defined theorem-like environment; -the new environment will be numbered just like <var>numbered_like</var>. +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">numbered_within</itemformat></item> +</tableterm><tableitem><para>Optional; the name of an already defined counter, usually a sectional +unit such as <code>chapter</code> or <code>section</code>. When the +<var>numbered_within</var> counter is reset then the <var>name</var> environment&textrsquo;s +counter will also be reset. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">within</itemformat></item> -</tableterm><tableitem><para>(Optional.) The name of an already defined counter, a sectional unit. -The new theorem counter will be reset at the same time as the -<var>within</var> counter. +<para>If this optional argument is not used then the command +<code>\the<var>name</var></code> is set to <code>\arabic{<var>name</var>}</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="var">numbered_like</itemformat></item> +</tableterm><tableitem><para>Optional; the name of an already defined theorem-like environment. The +new environment will be numbered in sequence with <var>numbered_like</var>. </para> </tableitem></tableentry></table> -<para>At most one of <var>numbered_like</var> and <var>within</var> can be specified, -not both. +<para>Without any optional arguments the environments are numbered +sequentially. This example has a declaration in the preamble that +results in <samp>Definition 1</samp> and <samp>Definition 2</samp> in the output. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newtheorem{defn}{Definition} +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{defn} + Second def +\end{defn} +</pre></example> + +<para>Because this example specifies the optional argument +<var>numbered_within</var> to <code>\newtheorem</code> as <code>section</code>, the +example, with the same document body, gives <samp>Definition 1.1</samp> +and <samp>Definition 2.1</samp>. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newtheorem{defn}{Definition}[section] +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{defn} + Second def +\end{defn} +</pre></example> + +<para>In this example there are two declarations in the preamble, the second +of which calls for the new <code>thm</code> environment to use the same +counter as <code>defn</code>. It gives <samp>Definition 1.1</samp>, followed +by <samp>Theorem 2.1</samp> and <samp>Definition 2.2</samp>. </para> +<example endspaces=" "> +<pre xml:space="preserve">\newtheorem{defn}{Definition}[section] +\newtheorem{thm}[defn]{Theorem} +\begin{document} +\section{...} +\begin{defn} + First def +\end{defn} + +\section{...} +\begin{thm} + First thm +\end{thm} + +\begin{defn} + Second def +\end{defn} +</pre></example> + </section> <node name="_005cnewfont" spaces=" "><nodename>\newfont</nodename><nodenext automatic="on">\protect</nodenext><nodeprev automatic="on">\newtheorem</nodeprev><nodeup automatic="on">Definitions</nodeup></node> -<section spaces=" "><sectiontitle><code>\newfont</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="325">\newfont</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="234">fonts, new commands for</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="235">defining new fonts</indexterm></cindex> +<section spaces=" "><sectiontitle><code>\newfont</code>: Define a new font (obsolete)</sectiontitle> -<para>Synopsis: +<findex index="fn" spaces=" "><indexterm index="fn" number="374">\newfont</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="256">fonts, new commands for</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="257">defining new fonts</indexterm></cindex> + +<para><code>\newfont</code>, now obsolete, defines a command that will switch fonts. +Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\newfont{<var>cmd</var>}{<var>fontname</var>} +<pre xml:space="preserve">\newfont{\<var>cmd</var>}{<var>font description</var>} </pre></example> -<para>Defines a control sequence <code>\<var>cmd</var></code>, which must not already -be defined, to make <var>fontname</var> be the current font. The file -looked for on the system is named <file><var>fontname</var>.tfm</file>. -</para> -<para>This is a low-level command for setting up to use an individual font. -More commonly, fonts are defined in families through <file>.fd</file> files. +<para>This defines a control sequence <code>\<var>cmd</var></code> that will change the +current font. &latex; will look on your system for a file named +<file><var>fontname</var>.tfm</file>. The control sequence must must not already +be defined. It must begin with a backslash (<samp>\</samp>). +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="375">.fd <r>file</r></indexterm></findex> +<para>This command is obsolete. It is a low-level command for setting up an +individual font. Today fonts are almost always defined in families +(which allows you to, for example, associate a boldface with a roman) +through the so-called &textldquo;New Font Selection Scheme&textrdquo;, either by using +<file>.fd</file> files or through the use of an engine that can access +system fonts such as Xe&latex; (<pxref label="TeX-engines"><xrefnodename>&tex; engines</xrefnodename></pxref>). +<!-- c xx explain nfss somewhere --> +</para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="258">at clause, in font definitions</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="259">design size, in font definitions</indexterm></cindex> +<para>But since it is part of &latex;, here is an explanation: the +<var>font description</var> consists of a <var>fontname</var> and an optional +<dfn>at clause</dfn>; this can have the form either <code>at <var>dimen</var></code> +or <code>scaled <var>factor</var></code>, where a <var>factor</var> of <samp>1000</samp> +means no scaling. For &latex;&textrsquo;s purposes, all this does is scale all +the character and other font dimensions relative to the font&textrsquo;s design +size, which is a value defined in the <file>.tfm</file> file. +</para> +<para>This example defines two equivalent fonts and typesets a few +characters in each: </para> +<example endspaces=" "> +<pre xml:space="preserve">\newfont{\testfontat}{cmb10 at 11pt} +\newfont{\testfontscaled}{cmb10 scaled 11pt} +\testfontat abc +\testfontscaled abc +</pre></example> + </section> <node name="_005cprotect" spaces=" "><nodename>\protect</nodename><nodeprev automatic="on">\newfont</nodeprev><nodeup automatic="on">Definitions</nodeup></node> <section spaces=" "><sectiontitle><code>\protect</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="326">\protect</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="236">fragile commands</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="237">moving arguments</indexterm></cindex> -<para>Footnotes, line breaks, any command that has an optional argument, and -many more are so-called <dfn>fragile</dfn> commands. When a fragile -command is used in certain contexts, called <dfn>moving arguments</dfn>, it -must be preceded by <code>\protect</code>. In addition, any fragile -commands within the arguments must have their own <code>\protect</code>. +<findex index="fn" spaces=" "><indexterm index="fn" number="376">\protect</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="260">fragile commands</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="261">robust commands</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="262">moving arguments</indexterm></cindex> + +<para>All &latex; commands are either <dfn>fragile</dfn> or <dfn>robust</dfn>. +Footnotes, line breaks, any command that has an optional argument, and +many more, are fragile. A fragile command can break when it is used in +the argument to certain commands. To prevent such commands from +breaking they must be preceded by the command <code>\protect</code>. +</para> +<para>For example, when &latex; runs the <code>\section{<var>section +name</var>}</code> command it writes the <var>section name</var> text to the +<file>.aux</file> auxiliary file, moving it there for use elsewhere in the +document such as in the table of contents. Any argument that is +internally expanded by &latex; without typesetting it directly is +referred to as a <dfn>moving argument</dfn>. A command is fragile if it can +expand during this process into invalid &tex; code. Some examples of +moving arguments are those that appear in the <code>\caption{..}</code> +command (<pxref label="figure"><xrefnodename>figure</xrefnodename></pxref>), in the <code>\thanks{..}</code> command +(<pxref label="_005cmaketitle"><xrefnodename>\maketitle</xrefnodename></pxref>), and in &arobase;-expressions in the <code>tabular</code> and +<code>array</code> environments (<pxref label="tabular"><xrefnodename>tabular</xrefnodename></pxref>). +</para> +<para>If you get strange errors from commands used in moving arguments, try +preceding it with <code>\protect</code>. Every fragile commands must be +protected with their own <code>\protect</code>. +</para> +<para>Although usually a <code>\protect</code> command doesn&textrsquo;t hurt, length +commands are robust and should not be preceded by a <code>\protect</code> +command. Nor can a <code>\protect</code> command be used in the argument to +<code>\addtocounter</code> or <code>\setcounter</code> command. +</para> +<para>In this example the <code>caption</code> command gives a mysterious error +about an extra curly brace. Fix the problem by preceding each +<code>\raisebox</code> command with <code>\protect</code>. </para> -<para>Some examples of moving arguments are <code>\caption</code> -(<pxref label="figure"><xrefnodename>figure</xrefnodename></pxref>), <code>\thanks</code> (<pxref label="_005cmaketitle"><xrefnodename>\maketitle</xrefnodename></pxref>), and -&hyphenbreak;expressions in <code>tabular</code> and <code>array</code> environments -(<pxref label="tabular"><xrefnodename>tabular</xrefnodename></pxref>). -</para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="238">robust commands</indexterm></cindex> -<para>Commands which are not fragile are called <dfn>robust</dfn>. They must not -be preceded by <code>\protect</code>. -</para> -<para>See also: -</para> -<smallexample endspaces=" "> -<exdent spaces=" "><url><urefurl>http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</urefurl></url></exdent> -<exdent spaces=" "><url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</urefurl></url></exdent> -</smallexample> +<example endspaces=" "> +<pre xml:space="preserve">\begin{figure} + .. + \caption{Company headquarters of A\raisebox{1pt}{B}\raisebox{-1pt}{C}} +\end{figure} +</pre></example> -<!-- c xx really need examples. --> +<para>In the next example the <code>\tableofcontents</code> command gives an error +because the <code>\(..\)</code> in the section title expands to illegal &tex; +in the <file>.toc</file> file. You can solve this by changing <code>\(..\)</code> +to <code>\protect\(..\protect\)</code>. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{document} +\tableofcontents + .. +\section{Einstein's \( e=mc^2 \)} + .. +</pre></example> </section> </chapter> <node name="Counters" spaces=" "><nodename>Counters</nodename><nodenext automatic="on">Lengths</nodenext><nodeprev automatic="on">Definitions</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Counters</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="239">counters, a list of</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="240">variables, a list of</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="263">counters, a list of</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="264">variables, a list of</indexterm></cindex> <para>Everything &latex; numbers for you has a counter associated with -it. The name of the counter is the same as the name of the environment -or command that produces the number, except with no <code>\</code>. -(<code>enumi</code>&textndash;<code>enumiv</code> are used for the nested enumerate -environment.) Below is a list of the counters used in &latex;&textrsquo;s -standard document classes to control numbering. +it. The name of the counter is often the same as the name of the +environment or command associated with the number, except with no +backslash (<code>\</code>). Thus the <code>\chapter</code> command starts a +chapter and the <code>chapter</code> counter keeps track of the chapter +number. Below is a list of the counters used in &latex;&textrsquo;s standard +document classes to control numbering. </para> <example endspaces=" "> <pre xml:space="preserve">part paragraph figure enumi @@ -4037,6 +5599,16 @@ subsection equation mpfootnote enumiv subsubsection </pre></example> +<para>The <code>mpfootnote</code> counter is used by the <code>\footnote</code> command +inside of a minipage (<pxref label="minipage"><xrefnodename>minipage</xrefnodename></pxref>). +</para> +<para>The <code>enumi</code> through <code>enumiv</code> counters are used in the +<code>enumerate</code> environment, for up to four nested levels +(<pxref label="enumerate"><xrefnodename>enumerate</xrefnodename></pxref>). +</para> +<para>New counters are created with <code>\newcounter</code>. <xref label="_005cnewcounter"><xrefnodename>\newcounter</xrefnodename></xref>. +</para> + <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\alph \Alph \arabic \roman \Roman \fnsymbol</menunode><menudescription><pre xml:space="preserve">Print value of a counter. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\usecounter</menunode><menudescription><pre xml:space="preserve">Use a specified counter in a list environment. @@ -4052,26 +5624,29 @@ subsubsection <node name="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol" spaces=" "><nodename>\alph \Alph \arabic \roman \Roman \fnsymbol</nodename><nodenext automatic="on">\usecounter</nodenext><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\alph \Alph \arabic \roman \Roman \fnsymbol</code>: Printing counters</sectiontitle> +<cindex index="cp" spaces=" "><indexterm index="cp" number="265">counters, printing</indexterm></cindex> + <para>All of these commands take a single counter as an argument, for -instance, <code>\alph{enumi}</code>. +instance, <code>\alph{enumi}</code>. Note that the counter name does not +start with a backslash. </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="327">\alph</indexterm>\alph</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="377">\alph</indexterm>\alph</itemformat></item> </tableterm><tableitem><para>prints <var>counter</var> using lowercase letters: &textlsquo;a&textrsquo;, &textlsquo;b&textrsquo;, &enddots; </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="328">\Alph</indexterm>\Alph</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="378">\Alph</indexterm>\Alph</itemformat></item> </tableterm><tableitem><para>uses uppercase letters: &textlsquo;A&textrsquo;, &textlsquo;B&textrsquo;, &enddots; </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="329">\arabic</indexterm>\arabic</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="379">\arabic</indexterm>\arabic</itemformat></item> </tableterm><tableitem><para>uses Arabic numbers: &textlsquo;1&textrsquo;, &textlsquo;2&textrsquo;, &enddots; </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="330">\roman</indexterm>\roman</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="380">\roman</indexterm>\roman</itemformat></item> </tableterm><tableitem><para>uses lowercase roman numerals: &textlsquo;i&textrsquo;, &textlsquo;ii&textrsquo;, &enddots; </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="331">\Roman</indexterm>\Roman</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="381">\Roman</indexterm>\Roman</itemformat></item> </tableterm><tableitem><para>uses uppercase roman numerals: &textlsquo;I&textrsquo;, &textlsquo;II&textrsquo;, &enddots; </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="332">\fnsymbol</indexterm>\fnsymbol</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="382">\fnsymbol</indexterm>\fnsymbol</itemformat></item> </tableterm><tableitem><para>prints the value of <var>counter</var> in a specific sequence of nine symbols (conventionally used for labeling footnotes). The value of <var>counter</var> must be between 1 and 9, inclusive. @@ -4081,7 +5656,7 @@ symbols (conventionally used for labeling footnotes). The value of <display endspaces=" "> <pre xml:space="preserve">asterisk(*) dagger(<U>2021</U>) ddagger(<U>2021</U>) section-sign(<U>00A7</U>) paragraph-sign(<U>00B6</U>) parallel(<U>2225</U>) -double-asterisk(**) double-dagger(<U>2021</U><U>2021</U>) double-ddagger(<U>2021</U><U>2021</U>) +double-asterisk(**) double-dagger(<U>2020</U><U>2020</U>) double-ddagger(<U>2021</U><U>2021</U>) </pre></display> </tableitem></tableentry></ftable> @@ -4090,9 +5665,10 @@ double-asterisk(**) double-dagger(<U>2021</U><U>2021</U>) double-ddagger(<U>2021 </section> <node name="_005cusecounter" spaces=" "><nodename>\usecounter</nodename><nodenext automatic="on">\value</nodenext><nodeprev automatic="on">\alph \Alph \arabic \roman \Roman \fnsymbol</nodeprev><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\usecounter{<var>counter</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="333">\usecounter</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="241">list items, specifying counter</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="242">numbered items, specifying counter</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="383">\usecounter</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="266">list items, specifying counter</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="267">numbered items, specifying counter</indexterm></cindex> <para>Synopsis: </para> @@ -4100,16 +5676,34 @@ double-asterisk(**) double-dagger(<U>2021</U><U>2021</U>) double-ddagger(<U>2021 <pre xml:space="preserve">\usecounter{<var>counter</var>} </pre></example> -<para>The <code>\usecounter</code> command is used in the second argument of the -<code>list</code> environment to specify <var>counter</var> to be used to number -the list items. +<para>In the <code>list</code> environment, when used in the second argument, this +command sets up <var>counter</var> to number the list items. It initializes +<var>counter</var> to zero, and arranges that when <code>\item</code> is called +without its optional argument then <var>counter</var> is incremented by +<code>\refstepcounter</code>, making its value be the current <code>ref</code> +value. This command is fragile (<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). </para> +<para>Put in the preamble, this makes a new list environment enumerated with +<var>testcounter</var>: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newcounter{testcounter} +\newenvironment{test}{% + \begin{list}{}{% + \usecounter{testcounter} + } +}{% + \end{list} +} +</pre></example> + </section> <node name="_005cvalue" spaces=" "><nodename>\value</nodename><nodenext automatic="on">\setcounter</nodenext><nodeprev automatic="on">\usecounter</nodeprev><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\value{<var>counter</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="334">\value</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="243">counters, getting value of</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="384">\value</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="268">counters, getting value of</indexterm></cindex> <para>Synopsis: </para> @@ -4117,12 +5711,30 @@ the list items. <pre xml:space="preserve">\value{<var>counter</var>} </pre></example> -<para>The <code>\value</code> command produces the value of <var>counter</var>. It can -be used anywhere &latex; expects a number, for example: +<para>This command expands to the value of <var>counter</var>. It is often used +in <code>\setcounter</code> or <code>\addtocounter</code>, but <code>\value</code> can +be used anywhere that &latex; expects a number. It must not be +preceded by <code>\protect</code> (<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). +</para> +<para>The <code>\value</code> command is not used for typesetting the value of the +counter. <xref label="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol"><xrefnodename>\alph \Alph \arabic \roman \Roman \fnsymbol</xrefnodename></xref>. +</para> +<para>This example outputs <samp>Test counter is 6. Other counter +is 5.</samp>. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\newcounter{test} \setcounter{test}{5} +\newcounter{other} \setcounter{other}{\value{test}} +\addtocounter{test}{1} + +Test counter is \arabic{test}. +Other counter is \arabic{other}. +</pre></example> + +<para>This example inserts <code>\hspace{4\parindent}</code>. </para> <example endspaces=" "> -<pre xml:space="preserve">\setcounter{myctr}{3} -\addtocounter{myctr}{1} +<pre xml:space="preserve">\setcounter{myctr}{3} \addtocounter{myctr}{1} \hspace{\value{myctr}\parindent} </pre></example> @@ -4130,9 +5742,10 @@ be used anywhere &latex; expects a number, for example: </section> <node name="_005csetcounter" spaces=" "><nodename>\setcounter</nodename><nodenext automatic="on">\addtocounter</nodenext><nodeprev automatic="on">\value</nodeprev><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\setcounter{<var>counter</var>}{<var>value</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="335">\setcounter</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="244">counters, setting</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="245">setting counters</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="385">\setcounter</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="269">counters, setting</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="270">setting counters</indexterm></cindex> <para>Synopsis: </para> @@ -4140,44 +5753,58 @@ be used anywhere &latex; expects a number, for example: <pre xml:space="preserve">\setcounter{<var>counter</var>}{<var>value</var>} </pre></example> -<para>The <code>\setcounter</code> command sets the value of <var>counter</var> to the -<var>value</var> argument. +<para>The <code>\setcounter</code> command globally sets the value of <var>counter</var> +to the <var>value</var> argument. Note that the counter name does not start +with a backslash. </para> </section> <node name="_005caddtocounter" spaces=" "><nodename>\addtocounter</nodename><nodenext automatic="on">\refstepcounter</nodenext><nodeprev automatic="on">\setcounter</nodeprev><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\addtocounter{<var>counter</var>}{<var>value</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="336">\addtocounter</indexterm></findex> -<para>The <code>\addtocounter</code> command increments <var>counter</var> by the -amount specified by the <var>value</var> argument, which may be negative. +<findex index="fn" spaces=" "><indexterm index="fn" number="386">\addtocounter</indexterm></findex> + +<para>The <code>\addtocounter</code> command globally increments <var>counter</var> by +the amount specified by the <var>value</var> argument, which may be negative. </para> </section> <node name="_005crefstepcounter" spaces=" "><nodename>\refstepcounter</nodename><nodenext automatic="on">\stepcounter</nodenext><nodeprev automatic="on">\addtocounter</nodeprev><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\refstepcounter{<var>counter</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="337">\refstepcounter</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="387">\refstepcounter</indexterm></findex> <para>The <code>\refstepcounter</code> command works in the same way as -<code>\stepcounter</code> <xref label="_005cstepcounter"><xrefnodename>\stepcounter</xrefnodename></xref>, except it also defines the -current <code>\ref</code> value to be the result of <code>\thecounter</code>. +<code>\stepcounter</code> (<pxref label="_005cstepcounter"><xrefnodename>\stepcounter</xrefnodename></pxref>): it globally increments the +value of <var>counter</var> by one and resets the value of any counter +numbered within it. (For the definition of &textldquo;counters numbered +within&textrdquo;, <pxref label="_005cnewcounter"><xrefnodename>\newcounter</xrefnodename></pxref>.) +</para> +<para>In addition, this command also defines the current <code>\ref</code> value +to be the result of <code>\thecounter</code>. +</para> +<para>While the counter value is set globally, the <code>\ref</code> value is set +locally, i.e., inside the current group. </para> </section> <node name="_005cstepcounter" spaces=" "><nodename>\stepcounter</nodename><nodenext automatic="on">\day \month \year</nodenext><nodeprev automatic="on">\refstepcounter</nodeprev><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\stepcounter{<var>counter</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="338">\stepcounter</indexterm></findex> -<para>The <code>\stepcounter</code> command adds one to <var>counter</var> and -resets all subsidiary counters. +<findex index="fn" spaces=" "><indexterm index="fn" number="388">\stepcounter</indexterm></findex> + +<para>The <code>\stepcounter</code> command globally adds one to <var>counter</var> and +resets all counters numbered within it. (For the definition of +&textldquo;counters numbered within&textrdquo;, <pxref label="_005cnewcounter"><xrefnodename>\newcounter</xrefnodename></pxref>.) </para> </section> <node name="_005cday-_005cmonth-_005cyear" spaces=" "><nodename>\day \month \year</nodename><nodeprev automatic="on">\stepcounter</nodeprev><nodeup automatic="on">Counters</nodeup></node> <section spaces=" "><sectiontitle><code>\day \month \year</code>: Predefined counters</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="339">\day</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="340">\month</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="341">\year</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="389">\day</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="390">\month</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="391">\year</indexterm></findex> <para>&latex; defines counters for the day of the month (<code>\day</code>, 1&textndash;31), month of the year (<code>\month</code>, 1&textndash;12), and year @@ -4193,13 +5820,39 @@ current day (<pxref label="_005ctoday"><xrefnodename>\today</xrefnodename></pxre </chapter> <node name="Lengths" spaces=" "><nodename>Lengths</nodename><nodenext automatic="on">Making paragraphs</nodenext><nodeprev automatic="on">Counters</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Lengths</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="246">lengths, defining and using</indexterm></cindex> -<para>A <code>length</code> is a measure of distance. Many &latex; commands take a +<cindex index="cp" spaces=" "><indexterm index="cp" number="271">lengths, defining and using</indexterm></cindex> + +<para>A <dfn>length</dfn> is a measure of distance. Many &latex; commands take a length as an argument. </para> +<para>Lengths come in two types. A <dfn>rigid length</dfn> (what Plain &tex; +calls a <dfn>dimen</dfn>) such as <code>10pt</code> cannot contain a <code>plus</code> or +<code>minus</code> component. A <dfn>rubber length</dfn> (what Plain &tex; calls +a <dfn>skip</dfn>) can contain those, as with <code>1cm plus0.05cm +minus0.01cm</code>. These give the ability to stretch or shrink; the length +in the prior sentence could appear in the output as long as 1.05 cm +or as short as 0.99 cm, depending on what &tex;&textrsquo;s typesetting +algorithm finds optimum. +</para> +<para>The <code>plus</code> or <code>minus</code> component of a rubber length can contain +a <dfn>fill</dfn> component, as in <code>1in plus2fill</code>. This gives the +length infinite stretchability or shrinkability, so that the length in +the prior sentence can be set by &tex; to any distance greater than or +equal to 1 inch. &tex; actually provides three infinite glue +components <code>fil</code>, <code>fill</code>, and <code>filll</code>, such that the +later ones overcome the earlier ones, but only the middle value is +ordinarily used. <xref label="_005chfill"><xrefnodename>\hfill</xrefnodename></xref>, <xref label="_005cvfill"><xrefnodename>\vfill</xrefnodename></xref>. +</para> +<para>Multiplying an entire rubber length by a number turns it into a rigid +length, so that after <code>\setlength{\ylength}{1in plus 0.2in}</code> +and <code>\setlength{\zlength}{3\ylength}</code> then the value of +<code>\zlength</code> is <code>3in</code>. +</para> + <menu endspaces=" "> -<menuentry leadingtext="* "><menunode separator=":: ">\setlength</menunode><menudescription><pre xml:space="preserve">Set the value of a length. +<menuentry leadingtext="* "><menunode separator=":: ">Units of length</menunode><menudescription><pre xml:space="preserve">The units that &latex; knows. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\setlength</menunode><menudescription><pre xml:space="preserve">Set the value of a length. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\addtolength</menunode><menudescription><pre xml:space="preserve">Add a quantity to a length. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\settodepth</menunode><menudescription><pre xml:space="preserve">Set a length to the depth of something. </pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\settoheight</menunode><menudescription><pre xml:space="preserve">Set a length to the height of something. @@ -4208,10 +5861,95 @@ length as an argument. </pre></menudescription></menuentry></menu> -<node name="_005csetlength" spaces=" "><nodename>\setlength</nodename><nodenext automatic="on">\addtolength</nodenext><nodeup automatic="on">Lengths</nodeup></node> +<node name="Units-of-length" spaces=" "><nodename>Units of length</nodename><nodenext automatic="on">\setlength</nodenext><nodeup automatic="on">Lengths</nodeup></node> +<section spaces=" "><sectiontitle>Units of length</sectiontitle> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="272">units, of length</indexterm></cindex> + +<para>&tex; and &latex; know about these units both inside and outside of +math mode. +</para> +<table commandarg="code" spaces=" " endspaces=" "> +<tableentry><tableterm><item spaces=" "><itemformat command="code">pt </itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="392">pt</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="273">Point</indexterm></cindex> +<para>Point 1/72.27 inch. The conversion to metric units, to two decimal +places, is 1<dmn>point</dmn> = 2.85<dmn>mm</dmn> = 28.45<dmn>cm</dmn>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">pc</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="274">pica</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="393">pc</indexterm></findex> +<para>Pica, 12 pt +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">in </itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="394">in</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="395">inch</indexterm></findex> +<para>Inch, 72.27 pt +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">bp </itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="396">bp</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="275">Big point</indexterm></cindex> +<para>Big point, 1/72 inch. This length is the definition of a point in +PostScript and many desktop publishing systems. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">cm </itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="276">Centimeter</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="397">cm</indexterm></findex> +<para>Centimeter +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">mm </itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="277">Millimeter</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="398">mm</indexterm></findex> +<para>Millimeter +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">dd </itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="278">Didot point</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="399">dd</indexterm></findex> +<para>Didot point, 1.07 pt +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">cc </itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="279">Cicero</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="400">cc</indexterm></findex> +<para>Cicero, 12 dd +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">sp </itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="280">Scaled point</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="401">sp</indexterm></findex> +<para>Scaled point, 1/65536 pt +</para> +</tableitem></tableentry></table> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="281">ex</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="282">x-height</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="402">ex</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="283">m-width</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="284">em</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="403">em</indexterm></findex> +<para>Two other lengths that are often used are values set by the designer of +the font. The x-height of the current font <dfn>ex</dfn>, traditionally the +height of the lower case letter x, is often used for vertical +lengths. Similarly <dfn>em</dfn>, traditionally the width of the capital +letter M, is often used for horizontal lengths (there is also +<code>\enspace</code>, which is <code>0.5em</code>). Use of these can help make a +definition work better across font changes. For example, a definition +of the vertical space between list items given as +<code>\setlength{\itemsep}{1ex plus 0.05ex minus 0.01ex}</code> is more +likely to still be reasonable if the font is changed than a definition +given in points. +</para> +<cindex index="cp" spaces=" "><indexterm index="cp" number="285">mu, math unit</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="404">mu</indexterm></findex> +<para>In math mode, many definitions are expressed in terms of the math unit +<dfn>mu</dfn> given by 1 em = 18 mu, where the em is taken from the current +math symbols family. <xref label="Spacing-in-math-mode"><xrefnodename>Spacing in math mode</xrefnodename></xref>. +</para> + +</section> +<node name="_005csetlength" spaces=" "><nodename>\setlength</nodename><nodenext automatic="on">\addtolength</nodenext><nodeprev automatic="on">Units of length</nodeprev><nodeup automatic="on">Lengths</nodeup></node> <section spaces=" "><sectiontitle><code>\setlength{\<var>len</var>}{<var>value</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="342">\setlength</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="247">lengths, setting</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="405">\setlength</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="286">lengths, setting</indexterm></cindex> <para>The <code>\setlength</code> sets the value of <var>\len</var> to the <var>value</var> argument, which can be expressed in any units that &latex; @@ -4221,9 +5959,10 @@ understands, i.e., inches (<code>in</code>), millimeters (<code>mm</code>), poin </section> <node name="_005caddtolength" spaces=" "><nodename>\addtolength</nodename><nodenext automatic="on">\settodepth</nodenext><nodeprev automatic="on">\setlength</nodeprev><nodeup automatic="on">Lengths</nodeup></node> -<section spaces=" "><sectiontitle>\addtolength{<var>\len</var>}{<var>amount</var>}</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="343">\addtolength</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="248">lengths, adding to</indexterm></cindex> +<section spaces=" "><sectiontitle><code>\addtolength{<var>\len</var>}{<var>amount</var>}</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="406">\addtolength</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="287">lengths, adding to</indexterm></cindex> <para>The <code>\addtolength</code> command increments a &textldquo;length command&textrdquo; <var>\len</var> by the amount specified in the <var>amount</var> argument, which @@ -4233,7 +5972,8 @@ may be negative. </section> <node name="_005csettodepth" spaces=" "><nodename>\settodepth</nodename><nodenext automatic="on">\settoheight</nodenext><nodeprev automatic="on">\addtolength</nodeprev><nodeup automatic="on">Lengths</nodeup></node> <section spaces=" "><sectiontitle><code>\settodepth</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="344">\settodepth</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="407">\settodepth</indexterm></findex> <para><code>\settodepth{\gnat}{text}</code> </para> @@ -4244,7 +5984,8 @@ equal to the depth of the <code>text</code> argument. </section> <node name="_005csettoheight" spaces=" "><nodename>\settoheight</nodename><nodenext automatic="on">\settowidth</nodenext><nodeprev automatic="on">\settodepth</nodeprev><nodeup automatic="on">Lengths</nodeup></node> <section spaces=" "><sectiontitle><code>\settoheight</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="345">\settoheight</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="408">\settoheight</indexterm></findex> <para><code>\settoheight{\gnat}{text}</code> </para> @@ -4256,7 +5997,8 @@ equal to the height of the <code>text</code> argument. </section> <node name="_005csettowidth" spaces=" "><nodename>\settowidth</nodename><nodenext automatic="on">Predefined lengths</nodenext><nodeprev automatic="on">\settoheight</nodeprev><nodeup automatic="on">Lengths</nodeup></node> <section spaces=" "><sectiontitle><code>\settowidth{\<var>len</var>}{<var>text</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="346">\settowidth</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="409">\settowidth</indexterm></findex> <para>The <code>\settowidth</code> command sets the value of the command <var>\len</var> to the width of the <var>text</var> argument. @@ -4265,20 +6007,21 @@ to the width of the <var>text</var> argument. </section> <node name="Predefined-lengths" spaces=" "><nodename>Predefined lengths</nodename><nodeprev automatic="on">\settowidth</nodeprev><nodeup automatic="on">Lengths</nodeup></node> <section spaces=" "><sectiontitle>Predefined lengths</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="249">lengths, predefined</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="250">predefined lengths</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="288">lengths, predefined</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="289">predefined lengths</indexterm></cindex> <para><code>\width</code> -<findex index="fn" spaces=" "><indexterm index="fn" number="347">\width</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="410">\width</indexterm></findex> </para> <para><code>\height</code> -<findex index="fn" spaces=" "><indexterm index="fn" number="348">\height</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="411">\height</indexterm></findex> </para> <para><code>\depth</code> -<findex index="fn" spaces=" "><indexterm index="fn" number="349">\depth</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="412">\depth</indexterm></findex> </para> <para><code>\totalheight</code> -<findex index="fn" spaces=" "><indexterm index="fn" number="350">\totalheight</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="413">\totalheight</indexterm></findex> </para> <para>These length parameters can be used in the arguments of the box-making commands (<pxref label="Boxes"><xrefnodename>Boxes</xrefnodename></pxref>). They specify the natural width, etc., of @@ -4293,8 +6036,9 @@ natural size, e.g., say </chapter> <node name="Making-paragraphs" spaces=" "><nodename>Making paragraphs</nodename><nodenext automatic="on">Math formulas</nodenext><nodeprev automatic="on">Lengths</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Making paragraphs</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="251">making paragraphs</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="252">paragraphs</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="290">making paragraphs</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="291">paragraphs</indexterm></cindex> <para>A paragraph is ended by one or more completely blank lines&textmdash;lines not containing even a <code>%</code>. A blank line should not appear where a new @@ -4311,14 +6055,14 @@ a sectioning command. <node name="_005cindent" spaces=" "><nodename>\indent</nodename><nodenext automatic="on">\noindent</nodenext><nodeup automatic="on">Making paragraphs</nodeup></node> <section spaces=" "><sectiontitle><code>\indent</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="351">\indent</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="352">\parindent</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="253">indent, forcing</indexterm></cindex> -<para><code>\indent</code> produces a horizontal space whose width equals the -width of the <code>\parindent</code> length, the normal paragraph -indentation. It is used to add paragraph indentation where it would -otherwise be suppressed. +<findex index="fn" spaces=" "><indexterm index="fn" number="414">\indent</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="415">\parindent</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="292">indent, forcing</indexterm></cindex> + +<para><code>\indent</code> produces a horizontal space whose width equals to the +<code>\parindent</code> length, the normal paragraph indentation. It is used +to add paragraph indentation where it would otherwise be suppressed. </para> <para>The default value for <code>\parindent</code> is <code>1em</code> in two-column mode, otherwise <code>15pt</code> for <code>10pt</code> documents, <code>17pt</code> for @@ -4328,19 +6072,31 @@ mode, otherwise <code>15pt</code> for <code>10pt</code> documents, <code>17pt</c </section> <node name="_005cnoindent" spaces=" "><nodename>\noindent</nodename><nodenext automatic="on">\parskip</nodenext><nodeprev automatic="on">\indent</nodeprev><nodeup automatic="on">Making paragraphs</nodeup></node> <section spaces=" "><sectiontitle><code>\noindent</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="353">\noindent</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="254">indent, suppressing</indexterm></cindex> -<para>When used at the beginning of the paragraph, <code>\noindent</code> -suppresses any paragraph indentation. It has no effect when used in -the middle of a paragraph. +<findex index="fn" spaces=" "><indexterm index="fn" number="416">\noindent</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="293">indent, suppressing</indexterm></cindex> + +<para>When used at the beginning of the paragraph, this command suppresses any +paragraph indentation, as in this example. +</para> +<example endspaces=" "> +<pre xml:space="preserve">.. end of the prior paragraph. + +\noindent This paragraph is not indented. +</pre></example> + +<para>It has no effect when used in the middle of a paragraph. +</para> +<para>To eliminate paragraph indentation in an entire document, put +<code>\setlength{\parindent}{0pt}</code> in the preamble. </para> </section> <node name="_005cparskip" spaces=" "><nodename>\parskip</nodename><nodenext automatic="on">Marginal notes</nodenext><nodeprev automatic="on">\noindent</nodeprev><nodeup automatic="on">Making paragraphs</nodeup></node> <section spaces=" "><sectiontitle><code>\parskip</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="354">\parskip</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="255">vertical space before paragraphs</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="417">\parskip</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="294">vertical space before paragraphs</indexterm></cindex> <para><code>\parskip</code> is a rubber length defining extra vertical space added before each paragraph. The default is <code>0pt plus1pt</code>. @@ -4349,10 +6105,11 @@ before each paragraph. The default is <code>0pt plus1pt</code>. </section> <node name="Marginal-notes" spaces=" "><nodename>Marginal notes</nodename><nodeprev automatic="on">\parskip</nodeprev><nodeup automatic="on">Making paragraphs</nodeup></node> <section spaces=" "><sectiontitle>Marginal notes</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="256">marginal notes</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="257">notes in the margin</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="258">remarks in the margin</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="355">\marginpar</indexterm></findex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="295">marginal notes</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="296">notes in the margin</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="297">remarks in the margin</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="418">\marginpar</indexterm></findex> <para>Synopsis: </para> @@ -4369,15 +6126,15 @@ will be placed </para> <itemize commandarg="bullet" spaces=" " endspaces=" "><itemprepend><formattingcommand command="bullet"/></itemprepend> <listitem><prepend>•</prepend> -<para>in the right margin for one-sided layout; +<para>in the right margin for one-sided layout (option <code>oneside</code>, see <ref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></ref>); </para></listitem><listitem><prepend>•</prepend> -<para>in the outside margin for two-sided layout; +<para>in the outside margin for two-sided layout (option <code>twoside</code>, see <ref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></ref>); </para></listitem><listitem><prepend>•</prepend> -<para>in the nearest margin for two-column layout. +<para>in the nearest margin for two-column layout (option <code>twocolumn</code>, see <ref label="Document-class-options"><xrefnodename>Document class options</xrefnodename></ref>). </para></listitem></itemize> -<findex index="fn" spaces=" "><indexterm index="fn" number="356">\reversemarginpar</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="357">\normalmarginpar</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="419">\reversemarginpar</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="420">\normalmarginpar</indexterm></findex> <para>The command <code>\reversemarginpar</code> places subsequent marginal notes in the opposite (inside) margin. <code>\normalmarginpar</code> places them in the default position. @@ -4391,15 +6148,15 @@ hyphenation there by beginning the node with <code>\hspace{0pt}</c <para>These parameters affect the formatting of the note: </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="358">\marginparpush</indexterm>\marginparpush</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="421">\marginparpush</indexterm>\marginparpush</itemformat></item> </tableterm><tableitem><para>Minimum vertical space between notes; default <samp>7pt</samp> for <samp>12pt</samp> documents, <samp>5pt</samp> else. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="359">\marginparsep</indexterm>\marginparsep</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="422">\marginparsep</indexterm>\marginparsep</itemformat></item> </tableterm><tableitem><para>Horizontal space between the main text and the note; default <samp>11pt</samp> for <samp>10pt</samp> documents, <samp>10pt</samp> else. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="360">\marginparwidth</indexterm>\marginparwidth</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="423">\marginparwidth</indexterm>\marginparwidth</itemformat></item> </tableterm><tableitem><para>Width of the note itself; default for a one-sided <samp>10pt</samp> document is <samp>90pt</samp>, <samp>83pt</samp> for <samp>11pt</samp>, and <samp>68pt</samp> for <samp>12pt</samp>; <samp>17pt</samp> more in each case for a two-sided document. @@ -4418,13 +6175,14 @@ notes from falling off the bottom of the page. </chapter> <node name="Math-formulas" spaces=" "><nodename>Math formulas</nodename><nodenext automatic="on">Modes</nodenext><nodeprev automatic="on">Making paragraphs</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Math formulas</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="259">math formulas</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="260">formulas, math</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="261">math mode, entering</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="361">math <r>environment</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="362">displaymath <r>environment</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="363">equation <r>environment</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="298">math formulas</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="299">formulas, math</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="300">math mode, entering</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="424">math <r>environment</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="425">displaymath <r>environment</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="426">equation <r>environment</r></indexterm></findex> + <para>There are three environments that put &latex; in math mode: </para> <table commandarg="code" spaces=" " endspaces=" "> @@ -4437,10 +6195,10 @@ notes from falling off the bottom of the page. number in the right margin. </para></tableitem></tableentry></table> -<findex index="fn" spaces=" "><indexterm index="fn" number="364">\(</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="365">\)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="366">\[</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="367">\]</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="427">\(</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="428">\)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="429">\[</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="430">\]</indexterm></findex> <para>The <code>math</code> environment can be used in both paragraph and LR mode, but the <code>displaymath</code> and <code>equation</code> environments can be used only in paragraph mode. The <code>math</code> and <code>displaymath</code> @@ -4451,7 +6209,7 @@ environments are used so often that they have the following short forms: \[...\] <r>instead of</r> \begin{displaymath}...\end{displaymath} </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="368">$</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="431">$</indexterm></findex> <para>In fact, the <code>math</code> environment is so common that it has an even shorter form: </para> @@ -4459,19 +6217,20 @@ shorter form: <pre xml:space="preserve">$ ... $ <r>instead of</r> \(...\) </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="369">\boldmath</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="370">\unboldmath</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="432">\boldmath</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="433">\unboldmath</indexterm></findex> <para>The <code>\boldmath</code> command changes math letters and symbols to be in a bold font. It is used <emph>outside</emph> of math mode. Conversely, the <code>\unboldmath</code> command changes math glyphs to be in a normal font; it too is used <emph>outside</emph> of math mode. </para> <!-- c xx own section? Math fonts? --> -<findex index="fn" spaces=" "><indexterm index="fn" number="371">\displaystyle</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="434">\displaystyle</indexterm></findex> <para>The <code>\displaystyle</code> declaration forces the size and style of the formula to be that of <code>displaymath</code>, e.g., with limits above and -below summations. For example -</para><example endspaces=" "> +below summations. For example: +</para> +<example endspaces=" "> <pre xml:space="preserve">$\displaystyle \sum_{n=0}^\infty x_n $ </pre></example> @@ -4489,663 +6248,923 @@ below summations. For example <node name="Subscripts-_0026-superscripts" spaces=" "><nodename>Subscripts & superscripts</nodename><nodenext automatic="on">Math symbols</nodenext><nodeup automatic="on">Math formulas</nodeup></node> <section spaces=" "><sectiontitle>Subscripts & superscripts</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="262">superscript</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="263">subscript</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="264">exponent</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="372">_</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="373">^</indexterm></findex> -<para>To get an expression <i>exp</i> to appear as a subscript, you just type -<code>_{</code><i>exp</i><code>}</code>. To get <i>exp</i> to appear as a -superscript, you type <code>^{</code><i>exp</i><code>}</code>. &latex; handles -superscripted superscripts and all of that stuff in the natural way. -It even does the right thing when something has both a subscript and a -superscript. +<cindex index="cp" spaces=" "><indexterm index="cp" number="301">superscript</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="302">subscript</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="303">exponent</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="435">_</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="436">^</indexterm></findex> + +<para>In math mode, use the caret character <code>^</code> to make the +<var>exp</var> appear as a superscript, ie.&noeos; type <code>^{<var>exp</var>}</code>. +Similarly, in math mode, underscore <code>_{<var>exp</var>}</code> makes a +subscript out of <var>exp</var>. +</para> +<para>In this example the <code>0</code> and <code>1</code> appear as subscripts while the +<code>2</code> is a superscript. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\( (x_0+x_1)^2 \) +</pre></example> + +<para>To have more than one character in <var>exp</var> use curly braces as in +<code>e^{-2x}</code>. +</para> +<para>&latex; handles superscripts on superscripts, and all of that stuff, in +the natural way, so expressions such as <code>e^{x^2}</code> and +<code>x_{a_0}</code> will look right. It also does the right thing when +something has both a subscript and a superscript. In this example the +<code>0</code> appears at the bottom of the integral sign while the <code>10</code> +appears at the top. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\int_0^{10} x^2 \,dx +</pre></example> + +<para>You can put a superscript or subscript before a symbol with a construct +such as <code>{}_t K^2</code> in math mode (the initial <code>{}</code> prevents +the prefixed subscript from being attached to any prior symbols in the +expression). +</para> +<para>Outside of math mode, a construct like <code>A +test$_\textnormal{subscript}$</code> will produce a subscript typeset in +text mode, not math mode. Note that there are packages specialized for +writing Chemical formulas such as <file>mhchem</file>. +<!-- c xx display mode --> </para> </section> <node name="Math-symbols" spaces=" "><nodename>Math symbols</nodename><nodenext automatic="on">Math functions</nodenext><nodeprev automatic="on">Subscripts & superscripts</nodeprev><nodeup automatic="on">Math formulas</nodeup></node> <section spaces=" "><sectiontitle>Math symbols</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="265">math symbols</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="266">symbols, math</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="267">greek letters</indexterm></cindex> -<para>&latex; provides almost any mathematical symbol you&textrsquo;re likely to -need. The commands for generating them can be used only in math mode. +<cindex index="cp" spaces=" "><indexterm index="cp" number="304">math symbols</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="305">symbols, math</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="306">greek letters</indexterm></cindex> + +<para>&latex; provides almost any mathematical symbol you&textrsquo;re likely to need. For example, if you include <code>$\pi$</code> in your source, you will get -the pi symbol (<math>\pi</math>) in your output. +the pi symbol <U>03C0</U>. +</para> +<para>Below is a list of commonly-available symbols. It is by no means an +exhaustive list. Each symbol here is described with a short phrase, and +its symbol class (which determines the spacing around it) is given in +parenthesis. The commands for these symbols can be used only in math +mode. </para> +<!-- c xx Add Negation: @code{} for negations of relevant symbols --> +<!-- c Useful: http://www.w3.org/TR/WD-math-970515/section6.html --> + <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="374">\|</indexterm>\|</itemformat></item> -</tableterm><tableitem><para><math>\|</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="375">\aleph</indexterm>\aleph</itemformat></item> -</tableterm><tableitem><para><math>\aleph</math> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="437">\|</indexterm>\|</itemformat></item> +</tableterm><tableitem><para><U>2225</U> Parallel (relation). Synonym: <code>\parallel</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="376">\alpha</indexterm>\alpha</itemformat></item> -</tableterm><tableitem><para><math>\alpha</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="438">\aleph</indexterm>\aleph</itemformat></item> +</tableterm><tableitem><para><U>2135</U> Aleph, transfinite cardinal (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="377">\amalg</indexterm>\amalg</itemformat></item> -</tableterm><tableitem><para><math>\amalg</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="439">\alpha</indexterm>\alpha</itemformat></item> +</tableterm><tableitem><para><U>03B1</U> Lower case Greek letter alpha (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="378">\angle</indexterm>\angle</itemformat></item> -</tableterm><tableitem><para><math>\angle</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="440">\amalg</indexterm>\amalg</itemformat></item> +</tableterm><tableitem><para><U>2A3F</U> Disjoint union (binary) </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="379">\approx</indexterm>\approx</itemformat></item> -</tableterm><tableitem><para><math>\approx</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="441">\angle</indexterm>\angle</itemformat></item> +</tableterm><tableitem><para><U>2220</U> Geometric angle (ordinary). Similar: less-than +sign <code><</code> and angle bracket <code>\langle</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="380">\ast</indexterm>\ast</itemformat></item> -</tableterm><tableitem><para><math>\ast</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="442">\approx</indexterm>\approx</itemformat></item> +</tableterm><tableitem><para><U>2248</U> Almost equal to (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="381">\asymp</indexterm>\asymp</itemformat></item> -</tableterm><tableitem><para><math>\asymp</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="443">\ast</indexterm>\ast</itemformat></item> +</tableterm><tableitem><para><U>2217</U> Asterisk operator, convolution, six-pointed +(binary). Synonym: <code>*</code>, which is often a superscript or +subscript, as in the Kleene star. Similar: <code>\star</code>, which is +five-pointed, and is sometimes used as a general binary operation, and +sometimes reserved for cross-correlation. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="382">\backslash</indexterm>\backslash</itemformat></item> -</tableterm><tableitem><para>\ (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="444">\asymp</indexterm>\asymp</itemformat></item> +</tableterm><tableitem><para><U>224D</U> Asymptomatically equivalent (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="383">\beta</indexterm>\beta</itemformat></item> -</tableterm><tableitem><para><math>\beta</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="445">\backslash</indexterm>\backslash</itemformat></item> +</tableterm><tableitem><para>\ Backslash (ordinary). Similar: set minus <code>\setminus</code>, and +<code>\textbackslash</code> for backslash outside of math mode. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="384">\bigcap</indexterm>\bigcap</itemformat></item> -</tableterm><tableitem><para><math>\bigcap</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="446">\beta</indexterm>\beta</itemformat></item> +</tableterm><tableitem><para><U>03B2</U> Lower case Greek letter beta (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="385">\bigcirc</indexterm>\bigcirc</itemformat></item> -</tableterm><tableitem><para><math>\bigcirc</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="447">\bigcap</indexterm>\bigcap</itemformat></item> +</tableterm><tableitem><para><U>22C2</U> Variable-sized, or n-ary, intersection (operator). Similar: +binary intersection <code>\cap</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="386">\bigcup</indexterm>\bigcup</itemformat></item> -</tableterm><tableitem><para><math>\bigcup</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="448">\bigcirc</indexterm>\bigcirc</itemformat></item> +</tableterm><tableitem><para><U>26AA</U> Circle, larger (binary). Similar: function +composition <code>\circ</code>. +<!-- c bb Best unicode symbol for this? --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="387">\bigodot</indexterm>\bigodot</itemformat></item> -</tableterm><tableitem><para><math>\bigodot</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="449">\bigcup</indexterm>\bigcup</itemformat></item> +</tableterm><tableitem><para><U>22C3</U> Variable-sized, or n-ary, union (operator). Similar: binary +union <code>\cup</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="388">\bigoplus</indexterm>\bigoplus</itemformat></item> -</tableterm><tableitem><para><math>\bigoplus</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="450">\bigodot</indexterm>\bigodot</itemformat></item> +</tableterm><tableitem><para><U>2A00</U> Variable-sized, or n-ary, circled dot operator (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="389">\bigotimes</indexterm>\bigotimes</itemformat></item> -</tableterm><tableitem><para><math>\bigotimes</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="451">\bigoplus</indexterm>\bigoplus</itemformat></item> +</tableterm><tableitem><para><U>2A01</U> Variable-sized, or n-ary, circled plus operator (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="390">\bigtriangledown</indexterm>\bigtriangledown</itemformat></item> -</tableterm><tableitem><para><math>\bigtriangledown</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="452">\bigotimes</indexterm>\bigotimes</itemformat></item> +</tableterm><tableitem><para><U>2A02</U> Variable-sized, or n-ary, circled times operator (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="391">\bigtriangleup</indexterm>\bigtriangleup</itemformat></item> -</tableterm><tableitem><para><math>\bigtriangleup</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="453">\bigtriangledown</indexterm>\bigtriangledown</itemformat></item> +</tableterm><tableitem><para><U>25BD</U> Variable-sized, or n-ary, open triangle pointing down +(operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="392">\bigsqcup</indexterm>\bigsqcup</itemformat></item> -</tableterm><tableitem><para><math>\bigsqcup</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="454">\bigtriangleup</indexterm>\bigtriangleup</itemformat></item> +</tableterm><tableitem><para><U>25B3</U> Variable-sized, or n-ary, open triangle pointing up (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="393">\biguplus</indexterm>\biguplus</itemformat></item> -</tableterm><tableitem><para><math>\biguplus</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="455">\bigsqcup</indexterm>\bigsqcup</itemformat></item> +</tableterm><tableitem><para><U>2A06</U> Variable-sized, or n-ary, square union (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="394">\bigcap</indexterm>\bigcap</itemformat></item> -</tableterm><tableitem><para><math>\bigvee</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="456">\biguplus</indexterm>\biguplus</itemformat></item> +</tableterm><tableitem><para><U>2A04</U> Variable-sized, or n-ary, union operator with a plus +(operator). (Note that the name has only one p.) </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="395">\bigwedge</indexterm>\bigwedge</itemformat></item> -</tableterm><tableitem><para><math>\bigwedge</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="457">\bigvee</indexterm>\bigvee</itemformat></item> +</tableterm><tableitem><para><U>22C1</U> Variable-sized, or n-ary, logical-and (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="396">\bot</indexterm>\bot</itemformat></item> -</tableterm><tableitem><para><math>\bot</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="458">\bigwedge</indexterm>\bigwedge</itemformat></item> +</tableterm><tableitem><para><U>22C0</U> Variable-sized, or n-ary, logical-or (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="397">\bowtie</indexterm>\bowtie</itemformat></item> -</tableterm><tableitem><para><math>\bowtie</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="459">\bot</indexterm>\bot</itemformat></item> +</tableterm><tableitem><para><U>22A5</U> Up tack, bottom, least element of a poset, or a contradiction +(ordinary). See also <code>\top</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="398">\Box</indexterm>\Box</itemformat></item> -</tableterm><tableitem><para>(square open box symbol) <!-- c xx not in plain --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="460">\bowtie</indexterm>\bowtie</itemformat></item> +</tableterm><tableitem><para><U>22C8</U> Natural join of two relations (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="399">\bullet</indexterm>\bullet</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="268">bullet symbol</indexterm></cindex> -<para><math>\bullet</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="461">\Box</indexterm>\Box</itemformat></item> +</tableterm><tableitem><para><U>25A1</U> Modal operator for necessity; square open box (ordinary). This +is not available in Plain &tex;. In &latex; you need to load the +<file>amssymb</file> package. +<!-- c bb Best Unicode equivalent? --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="400">\cap</indexterm>\cap</itemformat></item> -</tableterm><tableitem><para><math>\cap</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="462">\bullet</indexterm>\bullet</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="307">bullet symbol</indexterm></cindex> +<para><U>2022</U> Bullet (binary). Similar: multiplication +dot <code>\cdot</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="401">\cdot</indexterm>\cdot</itemformat></item> -</tableterm><tableitem><para><math>\cdot</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="463">\cap</indexterm>\cap</itemformat></item> +</tableterm><tableitem><para><U>2229</U> Intersection of two sets (binary). Similar: variable-sized +operator <code>\bigcap</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="402">\chi</indexterm>\chi</itemformat></item> -</tableterm><tableitem><para><math>\chi</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="464">\cdot</indexterm>\cdot</itemformat></item> +</tableterm><tableitem><para><U>22C5</U> Multiplication (binary). Similar: Bullet +dot <code>\bullet</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="403">\circ</indexterm>\circ</itemformat></item> -</tableterm><tableitem><para><math>\circ</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="465">\chi</indexterm>\chi</itemformat></item> +</tableterm><tableitem><para><U>03C7</U> Lower case Greek chi (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="404">\clubsuit</indexterm>\clubsuit</itemformat></item> -</tableterm><tableitem><para><math>\clubsuit</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="466">\circ</indexterm>\circ</itemformat></item> +</tableterm><tableitem><para><U>2218</U> Function composition, ring operator (binary). Similar: +variable-sized operator <code>\bigcirc</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="405">\cong</indexterm>\cong</itemformat></item> -</tableterm><tableitem><para><math>\cong</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="467">\clubsuit</indexterm>\clubsuit</itemformat></item> +</tableterm><tableitem><para><U>2663</U> Club card suit (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="406">\coprod</indexterm>\coprod</itemformat></item> -</tableterm><tableitem><para><math>\coprod</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="468">\complement</indexterm>\complement</itemformat></item> +</tableterm><tableitem><para><U>2201</U> Set complement, used as a superscript as in +<code>$S^\complement$</code> (ordinary). This is not available in Plain +&tex;. In &latex; you should load the <file>amssymb</file> package. Also +used: <code>$S^{\mathsf{c}}$</code> or <code>$\bar{S}$</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="407">\cup</indexterm>\cup</itemformat></item> -</tableterm><tableitem><para><math>\cup</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="469">\cong</indexterm>\cong</itemformat></item> +</tableterm><tableitem><para><U>2245</U> Congruent (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="408">\dagger</indexterm>\dagger</itemformat></item> -</tableterm><tableitem><para><math>\dagger</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="470">\coprod</indexterm>\coprod</itemformat></item> +</tableterm><tableitem><para><U>2210</U> Coproduct (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="409">\dashv</indexterm>\dashv</itemformat></item> -</tableterm><tableitem><para><math>\dashv</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="471">\cup</indexterm>\cup</itemformat></item> +</tableterm><tableitem><para><U>222A</U> Union of two sets (binary). Similar: variable-sized +operator <code>\bigcup</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="410">\ddagger</indexterm>\ddagger</itemformat></item> -</tableterm><tableitem><para><math>\dagger</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="472">\dagger</indexterm>\dagger</itemformat></item> +</tableterm><tableitem><para><U>2020</U> Dagger relation (binary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="411">\Delta</indexterm>\Delta</itemformat></item> -</tableterm><tableitem><para><math>\Delta</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="473">\dashv</indexterm>\dashv</itemformat></item> +</tableterm><tableitem><para><U>22A3</U> Dash with vertical, reversed turnstile (relation). Similar: +turnstile <code>\vdash</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="412">\delta</indexterm>\delta</itemformat></item> -</tableterm><tableitem><para><math>\delta</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="474">\ddagger</indexterm>\ddagger</itemformat></item> +</tableterm><tableitem><para><U>2021</U> Double dagger relation (binary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="413">\Diamond</indexterm>\Diamond</itemformat></item> -</tableterm><tableitem><para>bigger <math>\diamond</math> <!-- c xx not in plain --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="475">\Delta</indexterm>\Delta</itemformat></item> +</tableterm><tableitem><para><U>0394</U> Greek upper case delta, used for increment (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="414">\diamond</indexterm>\diamond</itemformat></item> -</tableterm><tableitem><para><math>\diamond</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="476">\delta</indexterm>\delta</itemformat></item> +</tableterm><tableitem><para><U>03B4</U> Greek lower case delta (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="415">\diamondsuit</indexterm>\diamondsuit</itemformat></item> -</tableterm><tableitem><para><math>\diamondsuit</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="477">\Diamond</indexterm>\Diamond</itemformat></item> +</tableterm><tableitem><para><U>25C7</U> Large diamond operator (ordinary). This is not available in +Plain &tex;. In &latex; you must load the <file>amssymb</file> package. +<!-- c bb Best Unicode equivalent? --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="416">\div</indexterm>\div</itemformat></item> -</tableterm><tableitem><para><math>\div</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="478">\diamond</indexterm>\diamond</itemformat></item> +</tableterm><tableitem><para><U>22C4</U> Diamond operator, or diamond bullet (binary). Similar: large +diamond <code>\Diamond</code>, circle bullet <code>\bullet</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="417">\doteq</indexterm>\doteq</itemformat></item> -</tableterm><tableitem><para><math>\doteq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="479">\diamondsuit</indexterm>\diamondsuit</itemformat></item> +</tableterm><tableitem><para><U>2662</U> Diamond card suit (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="418">\downarrow</indexterm>\downarrow</itemformat></item> -</tableterm><tableitem><para><math>\downarrow</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="480">\div</indexterm>\div</itemformat></item> +</tableterm><tableitem><para><U>00F7</U> Division sign (binary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="419">\Downarrow</indexterm>\Downarrow</itemformat></item> -</tableterm><tableitem><para><math>\Downarrow</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="481">\doteq</indexterm>\doteq</itemformat></item> +</tableterm><tableitem><para><U>2250</U> Approaches the limit (relation). Similar: geometrically equal +to <code>\Doteq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="420">\ell</indexterm>\ell</itemformat></item> -</tableterm><tableitem><para><math>\ell</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="482">\downarrow</indexterm>\downarrow</itemformat></item> +</tableterm><tableitem><para><U>2193</U> Down arrow, converges (relation). Similar: double line down +arrow <code>\Downarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="421">\emptyset</indexterm>\emptyset</itemformat></item> -</tableterm><tableitem><para><math>\emptyset</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="483">\Downarrow</indexterm>\Downarrow</itemformat></item> +</tableterm><tableitem><para><U>21D3</U> Double line down arrow (relation). Similar: single line down +arrow <code>\downarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="422">\epsilon</indexterm>\epsilon</itemformat></item> -</tableterm><tableitem><para><math>\epsilon</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="484">\ell</indexterm>\ell</itemformat></item> +</tableterm><tableitem><para><U>2113</U> Lower-case cursive letter l (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="423">\equiv</indexterm>\equiv</itemformat></item> -</tableterm><tableitem><para><math>\equiv</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="485">\emptyset</indexterm>\emptyset</itemformat></item> +</tableterm><tableitem><para><U>2205</U> Empty set symbol (ordinary). Similar: reversed empty +set <code>\varnothing</code>. +<!-- c bb Why Unicode has \revemptyset but no \emptyset? --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="424">\eta</indexterm>\eta</itemformat></item> -</tableterm><tableitem><para><math>\eta</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="486">\epsilon</indexterm>\epsilon</itemformat></item> +</tableterm><tableitem><para><U>03F5</U> Lower case Greek-text letter (ordinary). More widely used in +mathematics is the curly epsilon +<code>\varepsilon</code> <U>03B5</U>. Related: the set membership relation +<code>\in</code> <U>2208</U>. +<!-- c src: David Carlisle http://tex.stackexchange.com/a/98018/339 and --> +<!-- c Unicode referenced there asserts varepsilon is much more widely used. --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="425">\exists</indexterm>\exists</itemformat></item> -</tableterm><tableitem><para><math>\exists</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="487">\equiv</indexterm>\equiv</itemformat></item> +</tableterm><tableitem><para><U>2261</U> Equivalence (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="426">\flat</indexterm>\flat</itemformat></item> -</tableterm><tableitem><para><math>\flat</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="488">\eta</indexterm>\eta</itemformat></item> +</tableterm><tableitem><para><U>03B7</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="427">\forall</indexterm>\forall</itemformat></item> -</tableterm><tableitem><para><math>\forall</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="489">\exists</indexterm>\exists</itemformat></item> +</tableterm><tableitem><para><U>2203</U> Existential quantifier (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="428">\frown</indexterm>\frown</itemformat></item> -</tableterm><tableitem><para><math>\frown</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="490">\flat</indexterm>\flat</itemformat></item> +</tableterm><tableitem><para><U>266D</U> Musical flat (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="429">\Gamma</indexterm>\Gamma</itemformat></item> -</tableterm><tableitem><para><math>\Gamma</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="491">\forall</indexterm>\forall</itemformat></item> +</tableterm><tableitem><para><U>2200</U> Universal quantifier (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="430">\gamma</indexterm>\gamma</itemformat></item> -</tableterm><tableitem><para><math>\gamma</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="492">\frown</indexterm>\frown</itemformat></item> +</tableterm><tableitem><para><U>2322</U> Downward curving arc (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="431">\ge</indexterm>\ge</itemformat></item> -</tableterm><tableitem><para><math>\ge</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="493">\Gamma</indexterm>\Gamma</itemformat></item> +</tableterm><tableitem><para><U>0393</U> Upper case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="432">\geq</indexterm>\geq</itemformat></item> -</tableterm><tableitem><para><math>\geq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="494">\gamma</indexterm>\gamma</itemformat></item> +</tableterm><tableitem><para><U>03B3</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="433">\gets</indexterm>\gets</itemformat></item> -</tableterm><tableitem><para><math>\gets</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="495">\ge</indexterm>\ge</itemformat></item> +</tableterm><tableitem><para><U>2265</U> Greater than or equal to (relation). This is a synonym +for <code>\geq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="434">\gg</indexterm>\gg</itemformat></item> -</tableterm><tableitem><para><math>\gg</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="496">\geq</indexterm>\geq</itemformat></item> +</tableterm><tableitem><para><U>2265</U> Greater than or equal to (relation). This is a synonym +for <code>\ge</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="435">\hbar</indexterm>\hbar</itemformat></item> -</tableterm><tableitem><para><math>\hbar</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="497">\gets</indexterm>\gets</itemformat></item> +</tableterm><tableitem><para><U>2190</U> Is assigned the value (relation). +Synonym: <code>\leftarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="436">\heartsuit</indexterm>\heartsuit</itemformat></item> -</tableterm><tableitem><para><math>\heartsuit</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="498">\gg</indexterm>\gg</itemformat></item> +</tableterm><tableitem><para><U>226B</U> Much greater than (relation). Similar: much less +than <code>\ll</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="437">\hookleftarrow</indexterm>\hookleftarrow</itemformat></item> -</tableterm><tableitem><para><math>\hookleftarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="499">\hbar</indexterm>\hbar</itemformat></item> +</tableterm><tableitem><para><U>210F</U> Planck constant over two pi (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="438">\hookrightarrow</indexterm>\hookrightarrow</itemformat></item> -</tableterm><tableitem><para><math>\hookrightarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="500">\heartsuit</indexterm>\heartsuit</itemformat></item> +</tableterm><tableitem><para><U>2661</U> Heart card suit (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="439">\iff</indexterm>\iff</itemformat></item> -</tableterm><tableitem><para><math>\iff</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="501">\hookleftarrow</indexterm>\hookleftarrow</itemformat></item> +</tableterm><tableitem><para><U>21A9</U> Hooked left arrow (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="440">\Im</indexterm>\Im</itemformat></item> -</tableterm><tableitem><para><math>\Im</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="502">\hookrightarrow</indexterm>\hookrightarrow</itemformat></item> +</tableterm><tableitem><para><U>21AA</U> Hooked right arrow (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="441">\in</indexterm>\in</itemformat></item> -</tableterm><tableitem><para><math>\in</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="503">\iff</indexterm>\iff</itemformat></item> +</tableterm><tableitem><para><U>27F7</U> If and only if (relation). It is <code>\Longleftrightarrow</code> +with a <code>\thickmuskip</code> on either side. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="442">\infty</indexterm>\infty</itemformat></item> -</tableterm><tableitem><para><math>\infty</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="504">\Im</indexterm>\Im</itemformat></item> +</tableterm><tableitem><para><U>2111</U> Imaginary part (ordinary). See: real part <code>\Re</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="443">\int</indexterm>\int</itemformat></item> -</tableterm><tableitem><para><math>\int</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="505">\in</indexterm>\in</itemformat></item> +</tableterm><tableitem><para><U>2208</U> Set element (relation). See also: lower case Greek letter +epsilon <code>\epsilon</code><U>03F5</U> and rounded small +epsilon <code>\varepsilon</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="444">\iota</indexterm>\iota</itemformat></item> -</tableterm><tableitem><para><math>\iota</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="506">\infty</indexterm>\infty</itemformat></item> +</tableterm><tableitem><para><U>221E</U> Infinity (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="445">\Join</indexterm>\Join</itemformat></item> -</tableterm><tableitem><para>condensed bowtie symbol (relation) <!-- c xx not in plain --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="507">\int</indexterm>\int</itemformat></item> +</tableterm><tableitem><para><U>222B</U> Integral (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="446">\kappa</indexterm>\kappa</itemformat></item> -</tableterm><tableitem><para><math>\kappa</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="508">\iota</indexterm>\iota</itemformat></item> +</tableterm><tableitem><para><U>03B9</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="447">\Lambda</indexterm>\Lambda</itemformat></item> -</tableterm><tableitem><para><math>\Lambda</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="509">\Join</indexterm>\Join</itemformat></item> +</tableterm><tableitem><para><U>2A1D</U> Condensed bowtie symbol (relation). Not available in Plain +&tex;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="448">\lambda</indexterm>\lambda</itemformat></item> -</tableterm><tableitem><para><math>\lambda</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="510">\kappa</indexterm>\kappa</itemformat></item> +</tableterm><tableitem><para><U>03BA</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="449">\land</indexterm>\land</itemformat></item> -</tableterm><tableitem><para><math>\land</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="511">\Lambda</indexterm>\Lambda</itemformat></item> +</tableterm><tableitem><para><U>039B</U> Upper case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="450">\langle</indexterm>\langle</itemformat></item> -</tableterm><tableitem><para><math>\langle</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="512">\lambda</indexterm>\lambda</itemformat></item> +</tableterm><tableitem><para><U>03BB</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="451">\lbrace</indexterm>\lbrace</itemformat></item> -</tableterm><tableitem><para><math>\lbrace</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="513">\land</indexterm>\land</itemformat></item> +</tableterm><tableitem><para><U>2227</U> Logical and (binary). This is a synonym for <code>\wedge</code>. +See also logical or <code>\lor</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="452">\lbrack</indexterm>\lbrack</itemformat></item> -</tableterm><tableitem><para><math>\lbrack</math> (delimiter) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="453">\lceil</indexterm>\lceil</itemformat></item> -</tableterm><tableitem><para><math>\lceil</math> (delimiter) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="454">\le</indexterm>\le</itemformat></item> -</tableterm><tableitem><para><math>\le</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="455">\leadsto</indexterm>\leadsto</itemformat></item> -</tableterm><tableitem><!-- c xx missing from plain --> - -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="456">\Leftarrow</indexterm>\Leftarrow</itemformat></item> -</tableterm><tableitem><para><math>\Leftarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="514">\langle</indexterm>\langle</itemformat></item> +</tableterm><tableitem><para><U>27E8</U> Left angle, or sequence, bracket (opening). Similar: +less-than <code><</code>. Matches <code>\rangle</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="457">\leftarrow</indexterm>\leftarrow</itemformat></item> -</tableterm><tableitem><para><math>\leftarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="515">\lbrace</indexterm>\lbrace</itemformat></item> +</tableterm><tableitem><para><U>007B</U> Left curly brace +(opening). Synonym: <code>\{</code>. Matches <code>\rbrace</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="458">\leftharpoondown</indexterm>\leftharpoondown</itemformat></item> -</tableterm><tableitem><para><math>\leftharpoondown</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="459">\leftharpoonup</indexterm>\leftharpoonup</itemformat></item> -</tableterm><tableitem><para><math>\leftharpoonup</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="460">\Leftrightarrow</indexterm>\Leftrightarrow</itemformat></item> -</tableterm><tableitem><para><math>\Leftrightarrow</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="461">\leftrightarrow</indexterm>\leftrightarrow</itemformat></item> -</tableterm><tableitem><para><math>\leftrightarrow</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="462">\leq</indexterm>\leq</itemformat></item> -</tableterm><tableitem><para><math>\leq</math> (relation) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="463">\lfloor</indexterm>\lfloor</itemformat></item> -</tableterm><tableitem><para><math>\lfloor</math> (delimiter) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="464">\lhd</indexterm>\lhd</itemformat></item> -</tableterm><tableitem><para>(left-pointing arrow head) <!-- c xx not in plain --> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="465">\ll</indexterm>\ll</itemformat></item> -</tableterm><tableitem><para><math>\ll</math> (relation) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="466">\lnot</indexterm>\lnot</itemformat></item> -</tableterm><tableitem><para><math>\lnot</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="467">\longleftarrow</indexterm>\longleftarrow</itemformat></item> -</tableterm><tableitem><para><math>\longleftarrow</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="468">\longleftrightarrow</indexterm>\longleftrightarrow</itemformat></item> -</tableterm><tableitem><para><math>\longleftrightarrow</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="469">\longmapsto</indexterm>\longmapsto</itemformat></item> -</tableterm><tableitem><para><math>\longmapsto</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="470">\longrightarrow</indexterm>\longrightarrow</itemformat></item> -</tableterm><tableitem><para><math>\longrightarrow</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="471">\lor</indexterm>\lor</itemformat></item> -</tableterm><tableitem><para><math>\lor</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="472">\mapsto</indexterm>\mapsto</itemformat></item> -</tableterm><tableitem><para><math>\mapsto</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="473">\mho</indexterm>\mho</itemformat></item> -</tableterm><tableitem><!-- c xx not in plain --> - -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="474">\mid</indexterm>\mid</itemformat></item> -</tableterm><tableitem><para><math>\mid</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="516">\lbrack</indexterm>\lbrack</itemformat></item> +</tableterm><tableitem><para><U>005B</U> Left square bracket (opening). +Synonym: <code>[</code>. Matches <code>\rbrack</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="475">\models</indexterm>\models</itemformat></item> -</tableterm><tableitem><para><math>\models</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="517">\lceil</indexterm>\lceil</itemformat></item> +</tableterm><tableitem><para><U>2308</U> Left ceiling bracket, like a square bracket but with the bottom +shaved off (opening). Matches <code>\rceil</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="476">\mp</indexterm>\mp</itemformat></item> -</tableterm><tableitem><para><math>\mp</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="518">\le</indexterm>\le</itemformat></item> +</tableterm><tableitem><para><U>2264</U> Less than or equal to (relation). This is a synonym +for <code>\leq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="477">\mu</indexterm>\mu</itemformat></item> -</tableterm><tableitem><para><math>\mu</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="519">\leadsto</indexterm>\leadsto</itemformat></item> +</tableterm><tableitem><para><U>21DD</U> Squiggly right arrow (relation). This is not available in +Plain &tex;. In &latex; you should load the <file>amssymb</file> package. +To get this symbol outside of math mode you can put +<code>\newcommand*{\Leadsto}{\ensuremath{\leadsto}}</code> in the +preamble and then use <code>\Leadsto</code> instead. +<!-- c bb Best Unicode equivalent? --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="478">\nabla</indexterm>\nabla</itemformat></item> -</tableterm><tableitem><para><math>\nabla</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="520">\Leftarrow</indexterm>\Leftarrow</itemformat></item> +</tableterm><tableitem><para><U>21D0</U> Is implied by, double-line left arrow (relation). Similar: +single-line left arrow <code>\leftarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="479">\natural</indexterm>\natural</itemformat></item> -</tableterm><tableitem><para><math>\natural</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="521">\leftarrow</indexterm>\leftarrow</itemformat></item> +</tableterm><tableitem><para><U>2190</U> Single-line left arrow (relation). +Synonym: <code>\gets</code>. Similar: double-line left +arrow <code>\Leftarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="480">\ne</indexterm>\ne</itemformat></item> -</tableterm><tableitem><para><math>\ne</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="522">\leftharpoondown</indexterm>\leftharpoondown</itemformat></item> +</tableterm><tableitem><para><U>21BD</U> Single-line left harpoon, barb under bar (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="481">\nearrow</indexterm>\nearrow</itemformat></item> -</tableterm><tableitem><para><math>\nearrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="523">\leftharpoonup</indexterm>\leftharpoonup</itemformat></item> +</tableterm><tableitem><para><U>21BC</U> Single-line left harpoon, barb over bar (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="482">\neg</indexterm>\neg</itemformat></item> -</tableterm><tableitem><para><math>\neg</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="524">\Leftrightarrow</indexterm>\Leftrightarrow</itemformat></item> +</tableterm><tableitem><para><U>21D4</U> Bi-implication; double-line double-headed arrow (relation). +Similar: single-line double headed arrow <code>\leftrightarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="483">\neq</indexterm>\neq</itemformat></item> -</tableterm><tableitem><para><math>\neq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="525">\leftrightarrow</indexterm>\leftrightarrow</itemformat></item> +</tableterm><tableitem><para><U>2194</U> Single-line double-headed arrow (relation). Similar: +double-line double headed arrow <code>\Leftrightarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="484">\ni</indexterm>\ni</itemformat></item> -</tableterm><tableitem><para><math>\ni</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="526">\leq</indexterm>\leq</itemformat></item> +</tableterm><tableitem><para><U>2264</U> Less than or equal to (relation). This is a synonym +for <code>\le</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="485">\not</indexterm>\not</itemformat></item> -</tableterm><tableitem><para>Overstrike a following operator with a /, as in <math>\not=</math>. +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="527">\lfloor</indexterm>\lfloor</itemformat></item> +</tableterm><tableitem><para><U>230A</U> Left floor bracket (opening). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="486">\notin</indexterm>\notin</itemformat></item> -</tableterm><tableitem><para><math>\ni</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="528">\lhd</indexterm>\lhd</itemformat></item> +</tableterm><tableitem><para><U>25C1</U> Arrowhead, that is, triangle, pointing left (binary). This is +not available in Plain &tex;. In &latex; you should load the +<file>amssymb</file> package. For the normal subgroup symbol you should load +<file>amssymb</file> and use <code>\vartriangleleft</code> (which is a relation +and so gives better spacing). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="487">\nu</indexterm>\nu</itemformat></item> -</tableterm><tableitem><para><math>\nu</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="529">\ll</indexterm>\ll</itemformat></item> +</tableterm><tableitem><para><U>226A</U> Much less than (relation). Similar: much greater +than <code>\gg</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="488">\nwarrow</indexterm>\nwarrow</itemformat></item> -</tableterm><tableitem><para><math>\nwarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="530">\lnot</indexterm>\lnot</itemformat></item> +</tableterm><tableitem><para><U>00AC</U> Logical negation (ordinary). Synonym: <code>\neg</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="489">\odot</indexterm>\odot</itemformat></item> -</tableterm><tableitem><para><math>\odot</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="531">\longleftarrow</indexterm>\longleftarrow</itemformat></item> +</tableterm><tableitem><para><U>27F5</U> Long single-line left arrow (relation). Similar: long +double-line left arrow <code>\Longleftarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="490">\oint</indexterm>\oint</itemformat></item> -</tableterm><tableitem><para><math>\oint</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="532">\longleftrightarrow</indexterm>\longleftrightarrow</itemformat></item> +</tableterm><tableitem><para><U>27F7</U> Long single-line double-headed arrow (relation). Similar: long +double-line double-headed arrow <code>\Longleftrightarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="491">\Omega</indexterm>\Omega</itemformat></item> -</tableterm><tableitem><para><math>\Omega</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="533">\longmapsto</indexterm>\longmapsto</itemformat></item> +</tableterm><tableitem><para><U>27FC</U> Long single-line left arrow starting with vertical bar +(relation). Similar: shorter version <code>\mapsto</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="492">\omega</indexterm>\omega</itemformat></item> -</tableterm><tableitem><para><math>\omega</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="534">\longrightarrow</indexterm>\longrightarrow</itemformat></item> +</tableterm><tableitem><para><U>27F6</U> Long single-line right arrow (relation). Similar: long +double-line right arrow <code>\Longrightarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="493">\ominus</indexterm>\ominus</itemformat></item> -</tableterm><tableitem><para><math>\ominus</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="535">\lor</indexterm>\lor</itemformat></item> +</tableterm><tableitem><para><U>2228</U> Logical or (binary). Synonym: wedge <code>\wedge</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="494">\oplus</indexterm>\oplus</itemformat></item> -</tableterm><tableitem><para><math>\oplus</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="536">\mapsto</indexterm>\mapsto</itemformat></item> +</tableterm><tableitem><para><U>21A6</U> Single-line left arrow starting with vertical bar (relation). +Similar: longer version <code>\longmapsto</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="495">\oslash</indexterm>\oslash</itemformat></item> -</tableterm><tableitem><para><math>\oslash</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="537">\mho</indexterm>\mho</itemformat></item> +</tableterm><tableitem><para><U>2127</U> Conductance, half-circle rotated capital omega (ordinary). +This is not available in Plain &tex;. In &latex; you should load the +<file>amssymb</file> package. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="496">\otimes</indexterm>\otimes</itemformat></item> -</tableterm><tableitem><para><math>\otimes</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="538">\mid</indexterm>\mid</itemformat></item> +</tableterm><tableitem><para><U>2223</U> Single-line vertical bar (relation). A typical use of +<code>\mid</code> is for a set <code>\{\, x \mid x\geq 5 \,\}</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="497">\owns</indexterm>\owns</itemformat></item> -</tableterm><tableitem><para><math>\owns</math> +<para>Similar: <code>\vert</code> and <code>|</code> produce the same single-line +vertical bar symbol but without any spacing (they fall in class +ordinary) and you should not use them as relations but instead only as +ordinals, i.e., footnote symbols. For absolute value, see the entry +for <code>\vert</code> and for norm see the entry for <code>\Vert</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="498">\parallel</indexterm>\parallel</itemformat></item> -</tableterm><tableitem><para><math>\parallel</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="539">\models</indexterm>\models</itemformat></item> +</tableterm><tableitem><para><U>22A8</U> Entails, or satisfies; double turnstile, short double dash +(relation). Similar: long double dash <code>\vDash</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="499">\partial</indexterm>\partial</itemformat></item> -</tableterm><tableitem><para><math>\partial</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="540">\mp</indexterm>\mp</itemformat></item> +</tableterm><tableitem><para><U>2213</U> Minus or plus (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="500">\perp</indexterm>\perp</itemformat></item> -</tableterm><tableitem><para><math>\perp</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="541">\mu</indexterm>\mu</itemformat></item> +</tableterm><tableitem><para><U>03BC</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="501">\phi</indexterm>\phi</itemformat></item> -</tableterm><tableitem><para><math>\phi</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="542">\nabla</indexterm>\nabla</itemformat></item> +</tableterm><tableitem><para><U>2207</U> Hamilton&textrsquo;s del, or differential, operator (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="502">\Pi</indexterm>\Pi</itemformat></item> -</tableterm><tableitem><para><math>\Pi</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="543">\natural</indexterm>\natural</itemformat></item> +</tableterm><tableitem><para><U>266E</U> Musical natural notation (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="503">\pi</indexterm>\pi</itemformat></item> -</tableterm><tableitem><para><math>\pi</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="544">\ne</indexterm>\ne</itemformat></item> +</tableterm><tableitem><para><U>2260</U> Not equal (relation). Synonym: <code>\neq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="504">\pm</indexterm>\pm</itemformat></item> -</tableterm><tableitem><para><math>\pm</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="545">\nearrow</indexterm>\nearrow</itemformat></item> +</tableterm><tableitem><para><U>2197</U> North-east arrow (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="505">\prec</indexterm>\prec</itemformat></item> -</tableterm><tableitem><para><math>\prec</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="546">\neg</indexterm>\neg</itemformat></item> +</tableterm><tableitem><para><U>00AC</U> Logical negation (ordinary). +Synonym: <code>\lnot</code>. Sometimes instead used for +negation: <code>\sim</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="506">\preceq</indexterm>\preceq</itemformat></item> -</tableterm><tableitem><para><math>\preceq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="547">\neq</indexterm>\neq</itemformat></item> +</tableterm><tableitem><para><U>2260</U> Not equal (relation). Synonym: <code>\ne</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="507">\prime</indexterm>\prime</itemformat></item> -</tableterm><tableitem><para><math>\prime</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="548">\ni</indexterm>\ni</itemformat></item> +</tableterm><tableitem><para><U>220B</U> Reflected membership epsilon; has the member +(relation). Synonym: <code>\owns</code>. Similar: is a member +of <code>\in</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="508">\prod</indexterm>\prod</itemformat></item> -</tableterm><tableitem><para><math>\prod</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="549">\not</indexterm>\not</itemformat></item> +</tableterm><tableitem><para><U>0020</U><U>00A0</U><U>0338</U> Long solidus, or slash, used to overstrike a +following operator (relation). +<!-- c Need blank space for it to overstrike --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="509">\propto</indexterm>\propto</itemformat></item> -</tableterm><tableitem><para><math>\propto</math> (relation) +<para>Many negated operators that don&textrsquo;t require <code>\not</code> are available, +particularly with the <file>amssymb</file> package. For example, <code>\notin</code> +is probably typographically preferable to <code>\not\in</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="510">\Psi</indexterm>\Psi</itemformat></item> -</tableterm><tableitem><para><math>\Psi</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="550">\notin</indexterm>\notin</itemformat></item> +</tableterm><tableitem><para><U>2209</U> Not an element of (relation). Similar: not subset +of <code>\nsubseteq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="511">\psi</indexterm>\psi</itemformat></item> -</tableterm><tableitem><para><math>\psi</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="551">\nu</indexterm>\nu</itemformat></item> +</tableterm><tableitem><para><U>03BD</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="512">\rangle</indexterm>\rangle</itemformat></item> -</tableterm><tableitem><para><math>\rangle</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="552">\nwarrow</indexterm>\nwarrow</itemformat></item> +</tableterm><tableitem><para><U>2196</U> North-west arrow (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="513">\rbrace</indexterm>\rbrace</itemformat></item> -</tableterm><tableitem><para><math>\rbrace</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="553">\odot</indexterm>\odot</itemformat></item> +</tableterm><tableitem><para><U>2299</U> Dot inside a circle (binary). Similar: variable-sized +operator <code>\bigodot</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="514">\rbrack</indexterm>\rbrack</itemformat></item> -</tableterm><tableitem><para><math>\rbrack</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="554">\oint</indexterm>\oint</itemformat></item> +</tableterm><tableitem><para><U>222E</U> Contour integral, integral with circle in the middle (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="515">\rceil</indexterm>\rceil</itemformat></item> -</tableterm><tableitem><para><math>\rceil</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="555">\Omega</indexterm>\Omega</itemformat></item> +</tableterm><tableitem><para><U>03A9</U> Upper case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="516">\Re</indexterm>\Re</itemformat></item> -</tableterm><tableitem><para><math>\Re</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="556">\omega</indexterm>\omega</itemformat></item> +</tableterm><tableitem><para><U>03C9</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="517">\rfloor</indexterm>\rfloor</itemformat></item> -</tableterm><tableitem><para><math>\rfloor</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="557">\ominus</indexterm>\ominus</itemformat></item> +</tableterm><tableitem><para><U>2296</U> Minus sign, or dash, inside a circle (binary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="518">\rhd</indexterm>\rhd</itemformat></item> -</tableterm><tableitem><para>(binary operation) <!-- c xx not in plain @math{\rhd} --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="558">\oplus</indexterm>\oplus</itemformat></item> +</tableterm><tableitem><para><U>2295</U> Plus sign inside a circle (binary). Similar: variable-sized +operator <code>\bigoplus</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="519">\rho</indexterm>\rho</itemformat></item> -</tableterm><tableitem><para><math>\rho</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="559">\oslash</indexterm>\oslash</itemformat></item> +</tableterm><tableitem><para><U>2298</U> Solidus, or slash, inside a circle (binary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="520">\Rightarrow</indexterm>\Rightarrow</itemformat></item> -</tableterm><tableitem><para><math>\Rightarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="560">\otimes</indexterm>\otimes</itemformat></item> +</tableterm><tableitem><para><U>2297</U> Times sign, or cross, inside a circle (binary). Similar: +variable-sized operator <code>\bigotimes</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="521">\rightarrow</indexterm>\rightarrow</itemformat></item> -</tableterm><tableitem><para><math>\rightarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="561">\owns</indexterm>\owns</itemformat></item> +</tableterm><tableitem><para><U>220B</U> Reflected membership epsilon; has the member +(relation). Synonym: <code>\ni</code>. Similar: is a member +of <code>\in</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="522">\rightharpoondown</indexterm>\rightharpoondown</itemformat></item> -</tableterm><tableitem><para><math>\rightharpoondown</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="562">\parallel</indexterm>\parallel</itemformat></item> +</tableterm><tableitem><para><U>2225</U> Parallel (relation). Synonym: <code>\|</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="523">\rightharpoonup</indexterm>\rightharpoonup</itemformat></item> -</tableterm><tableitem><para><math>\rightharpoonup</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="563">\partial</indexterm>\partial</itemformat></item> +</tableterm><tableitem><para><U>2202</U> Partial differential (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="524">\rightleftharpoons</indexterm>\rightleftharpoons</itemformat></item> -</tableterm><tableitem><para><math>\rightleftharpoons</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="564">\perp</indexterm>\perp</itemformat></item> +</tableterm><tableitem><para><U>27C2</U> Perpendicular (relation). Similar: <code>\bot</code> uses the +same glyph but the spacing is different because it is in the class +ordinary. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="525">\searrow</indexterm>\searrow</itemformat></item> -</tableterm><tableitem><para><math>\searrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="565">\phi</indexterm>\phi</itemformat></item> +</tableterm><tableitem><para><U>03D5</U> Lower case Greek letter (ordinary). The variant form is +<code>\varphi</code> <U>03C6</U>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="526">\setminus</indexterm>\setminus</itemformat></item> -</tableterm><tableitem><para><math>\setminus</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="566">\Pi</indexterm>\Pi</itemformat></item> +</tableterm><tableitem><para><U>03A0</U> Upper case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="527">\sharp</indexterm>\sharp</itemformat></item> -</tableterm><tableitem><para><math>\sharp</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="567">\pi</indexterm>\pi</itemformat></item> +</tableterm><tableitem><para><U>03C0</U> Lower case Greek letter (ordinary). The variant form is +<code>\varpi</code> <U>03D6</U>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="528">\Sigma</indexterm>\Sigma</itemformat></item> -</tableterm><tableitem><para><math>\Sigma</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="568">\pm</indexterm>\pm</itemformat></item> +</tableterm><tableitem><para><U>00B1</U> Plus or minus (binary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="529">\sigma</indexterm>\sigma</itemformat></item> -</tableterm><tableitem><para><math>\sigma</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="569">\prec</indexterm>\prec</itemformat></item> +</tableterm><tableitem><para><U>227A</U> Preceeds (relation). Similar: less than <code><</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="530">\sim</indexterm>\sim</itemformat></item> -</tableterm><tableitem><para><math>\sim</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="570">\preceq</indexterm>\preceq</itemformat></item> +</tableterm><tableitem><para><U>2AAF</U> Preceeds or equals (relation). Similar: less than or +equals <code>\leq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="531">\simeq</indexterm>\simeq</itemformat></item> -</tableterm><tableitem><para><math>\simeq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="571">\prime</indexterm>\prime</itemformat></item> +</tableterm><tableitem><para><U>2032</U> Prime, or minute in a time expression (ordinary). Typically +used as a superscript <code>$A^\prime$</code>. Note that <code>$f^\prime$</code> +and <code>$f'$</code> produce the same result. An advantage of the second is +that <code>$f'''$</code> produces the the desired symbol, that is, the same +result as <code>$f^{\prime\prime\prime}$</code>, but uses somewhat less +typing. Note that you can only use <code>\prime</code> in math mode but you +can type right single quote <code>'</code> in text mode also, although it +resuts in a different look than in math mode. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="532">\smallint</indexterm>\smallint</itemformat></item> -</tableterm><tableitem><para><math>\smallint</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="572">\prod</indexterm>\prod</itemformat></item> +</tableterm><tableitem><para><U>220F</U> Product (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="533">\smile</indexterm>\smile</itemformat></item> -</tableterm><tableitem><para><math>\smile</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="573">\propto</indexterm>\propto</itemformat></item> +</tableterm><tableitem><para><U>221D</U> Is proportional to (relation) </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="534">\spadesuit</indexterm>\spadesuit</itemformat></item> -</tableterm><tableitem><para><math>\spadesuit</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="574">\Psi</indexterm>\Psi</itemformat></item> +</tableterm><tableitem><para><U>03A8</U> Upper case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="535">\sqcap</indexterm>\sqcap</itemformat></item> -</tableterm><tableitem><para><math>\sqcap</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="575">\psi</indexterm>\psi</itemformat></item> +</tableterm><tableitem><para><U>03C8</U> Lower case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="536">\sqcup</indexterm>\sqcup</itemformat></item> -</tableterm><tableitem><para><math>\sqcup</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="576">\rangle</indexterm>\rangle</itemformat></item> +</tableterm><tableitem><para><U>27B9</U> Right angle, or sequence, bracket (closing). Similar: greater +than <code>></code>. Matches:<code>\langle</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="537">\sqsubset</indexterm>\sqsubset</itemformat></item> -</tableterm><tableitem><para>(relation) <!-- c not in plain (@math{\sqsubset}) --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="577">\rbrace</indexterm>\rbrace</itemformat></item> +</tableterm><tableitem><para><U>007D</U> Right curly brace +(closing). Synonym: <code>\}</code>. Matches <code>\lbrace</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="538">\sqsubseteq</indexterm>\sqsubseteq</itemformat></item> -</tableterm><tableitem><para><math>\sqsubseteq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="578">\rbrack</indexterm>\rbrack</itemformat></item> +</tableterm><tableitem><para><U>005D</U> Right square bracket +(closing). Synonym: <code>]</code>. Matches <code>\lbrack</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="539">\sqsupset</indexterm>\sqsupset</itemformat></item> -</tableterm><tableitem><para>(relation) <!-- c not in plain (@math{\sqsupset}) --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="579">\rceil</indexterm>\rceil</itemformat></item> +</tableterm><tableitem><para><U>2309</U> Right ceiling bracket (closing). Matches <code>\lceil</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="540">\sqsupseteq</indexterm>\sqsupseteq</itemformat></item> -</tableterm><tableitem><para><math>\sqsupseteq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="580">\Re</indexterm>\Re</itemformat></item> +</tableterm><tableitem><para><U>211C</U> Real part, real numbers, cursive capital R (ordinary). Related: +double-line, or blackboard bold, R <code>\mathbb{R}</code>; to access +this, load the <file>amsfonts</file> package. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="541">\star</indexterm>\star</itemformat></item> -</tableterm><tableitem><para><math>\star</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="581">\restriction</indexterm>\restriction</itemformat></item> +</tableterm><tableitem><para><U>21BE</U> Restriction of a function +(relation). Synonym: <code>\upharpoonright</code>. Not available in +Plain &tex;. In &latex; you should load the <file>amssymb</file> package. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="542">\subset</indexterm>\subset</itemformat></item> -</tableterm><tableitem><para><math>\subset</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="582">\rfloor</indexterm>\rfloor</itemformat></item> +</tableterm><tableitem><para><U>230B</U> Right floor bracket, a right square bracket with the top cut +off (closing). Matches <code>\lfloor</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="543">\subseteq</indexterm>\subseteq</itemformat></item> -</tableterm><tableitem><para><math>\subseteq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="583">\rhd</indexterm>\rhd</itemformat></item> +</tableterm><tableitem><para><U>25C1</U> Arrowhead, that is, triangle, pointing right (binary). This is +not available in Plain &tex;. In &latex; you should load the +<file>amssymb</file> package. For the normal subgroup symbol you should +instead load <file>amssymb</file> and use <code>\vartriangleright</code> (which +is a relation and so gives better spacing). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="544">\succ</indexterm>\succ</itemformat></item> -</tableterm><tableitem><para><math>\succ</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="584">\rho</indexterm>\rho</itemformat></item> +</tableterm><tableitem><para><U>03C1</U> Lower case Greek letter (ordinary). The variant form is +<code>\varrho</code> <U>03F1</U>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="545">\succeq</indexterm>\succeq</itemformat></item> -</tableterm><tableitem><para><math>\succeq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="585">\Rightarrow</indexterm>\Rightarrow</itemformat></item> +</tableterm><tableitem><para><U>21D2</U> Implies, right-pointing double line arrow (relation). Similar: +right single-line arrow <code>\rightarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="546">\sum</indexterm>\sum</itemformat></item> -</tableterm><tableitem><para><math>\sum</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="586">\rightarrow</indexterm>\rightarrow</itemformat></item> +</tableterm><tableitem><para><U>2192</U> Right-pointing single line arrow (relation). Synonym: <code>\to</code>. Similar: right double line arrow <code>\Rightarrow</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="547">\supset</indexterm>\supset</itemformat></item> -</tableterm><tableitem><para><math>\supset</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="587">\rightharpoondown</indexterm>\rightharpoondown</itemformat></item> +</tableterm><tableitem><para><U>21C1</U> Right-pointing harpoon with barb below the line (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="548">\supseteq</indexterm>\supseteq</itemformat></item> -</tableterm><tableitem><para><math>\supseteq</math> (relation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="588">\rightharpoonup</indexterm>\rightharpoonup</itemformat></item> +</tableterm><tableitem><para><U>21C0</U> Right-pointing harpoon with barb above the line (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="549">\surd</indexterm>\surd</itemformat></item> -</tableterm><tableitem><para><math>\surd</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="589">\rightleftharpoons</indexterm>\rightleftharpoons</itemformat></item> +</tableterm><tableitem><para><U>21CC</U> Right harpoon up above left harpoon down (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="550">\swarrow</indexterm>\swarrow</itemformat></item> -</tableterm><tableitem><para><math>\swarrow</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="590">\searrow</indexterm>\searrow</itemformat></item> +</tableterm><tableitem><para><U>2198</U> Arrow pointing southeast (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="551">\tau</indexterm>\tau</itemformat></item> -</tableterm><tableitem><para><math>\tau</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="591">\setminus</indexterm>\setminus</itemformat></item> +</tableterm><tableitem><para><U>29F5</U> Set difference, reverse solidus or slash, like \ +(binary). Similar: backslash <code>\backslash</code> and also +<code>\textbackslash</code> outside of math mode. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="552">\theta</indexterm>\theta</itemformat></item> -</tableterm><tableitem><para><math>\theta</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="592">\sharp</indexterm>\sharp</itemformat></item> +</tableterm><tableitem><para><U>266F</U> Musical sharp (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="553">\times</indexterm>\times</itemformat></item> -</tableterm><tableitem><para><math>\times</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="593">\Sigma</indexterm>\Sigma</itemformat></item> +</tableterm><tableitem><para><U>03A3</U> Upper case Greek letter (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="554">\to</indexterm>\to</itemformat></item> -</tableterm><tableitem><para><math>\to</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="594">\sigma</indexterm>\sigma</itemformat></item> +</tableterm><tableitem><para><U>03C3</U> Lower case Greek letter (ordinary). The variant form is +<code>\varsigma</code> <U>03C2</U>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="555">\top</indexterm>\top</itemformat></item> -</tableterm><tableitem><para><math>\top</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="595">\sim</indexterm>\sim</itemformat></item> +</tableterm><tableitem><para><U>223C</U> Similar, in a relation (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="556">\triangle</indexterm>\triangle</itemformat></item> -</tableterm><tableitem><para><math>\triangle</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="596">\simeq</indexterm>\simeq</itemformat></item> +</tableterm><tableitem><para><U>2243</U> Similar or equal to, in a relation (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="557">\triangleleft</indexterm>\triangleleft</itemformat></item> -</tableterm><tableitem><para><math>\triangleleft</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="597">\smallint</indexterm>\smallint</itemformat></item> +</tableterm><tableitem><para><U>222B</U> Integral sign that does not change to a larger size in a +display (operator). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="558">\triangleright</indexterm>\triangleright</itemformat></item> -</tableterm><tableitem><para><math>\triangleright</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="598">\smile</indexterm>\smile</itemformat></item> +</tableterm><tableitem><para><U>2323</U> Upward curving arc (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="559">\unlhd</indexterm>\unlhd</itemformat></item> -</tableterm><tableitem><para>left-pointing arrowhead with line under (binary operation) <!-- c not in plain --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="599">\spadesuit</indexterm>\spadesuit</itemformat></item> +</tableterm><tableitem><para><U>2660</U> Spade card suit (ordinary). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="560">\unrhd</indexterm>\unrhd</itemformat></item> -</tableterm><tableitem><para>right-pointing arrowhead with line under (binary operation) <!-- c not in plain --> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="600">\sqcap</indexterm>\sqcap</itemformat></item> +</tableterm><tableitem><para><U>2293</U> Square intersection symbol (binary). Similar: +intersection <code>cap</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="561">\Uparrow</indexterm>\Uparrow</itemformat></item> -</tableterm><tableitem><para><math>\Uparrow</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="601">\sqcup</indexterm>\sqcup</itemformat></item> +</tableterm><tableitem><para><U>2294</U> Square union symbol (binary). Similar: +union <code>cup</code>. Related: variable-sized +operator <code>\bigsqcup</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="562">\uparrow</indexterm>\uparrow</itemformat></item> -</tableterm><tableitem><para><math>\uparrow</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="602">\sqsubset</indexterm>\sqsubset</itemformat></item> +</tableterm><tableitem><para><U>228F</U> Square subset symbol (relation). Similar: +subset <code>\subset</code>. This is not available in Plain &tex;. In +&latex; you should load the <file>amssymb</file> package. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="563">\Updownarrow</indexterm>\Updownarrow</itemformat></item> -</tableterm><tableitem><para><math>\Updownarrow</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="603">\sqsubseteq</indexterm>\sqsubseteq</itemformat></item> +</tableterm><tableitem><para><U>2291</U> Square subset or equal symbol (binary). Similar: subset or +equal to <code>\subseteq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="564">\updownarrow</indexterm>\updownarrow</itemformat></item> -</tableterm><tableitem><para><math>\updownarrow</math> (delimiter) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="604">\sqsupset</indexterm>\sqsupset</itemformat></item> +</tableterm><tableitem><para><U>2290</U> Square superset symbol (relation). Similar: +superset <code>\supset</code>. This is not available in Plain &tex;. In +&latex; you should load the <file>amssymb</file> package. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="605">\sqsupseteq</indexterm>\sqsupseteq</itemformat></item> +</tableterm><tableitem><para><U>2292</U> Square superset or equal symbol (binary). Similar: superset or +equal <code>\supseteq</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="606">\star</indexterm>\star</itemformat></item> +</tableterm><tableitem><para><U>22C6</U> Five-pointed star, sometimes used as a general binary operation +but sometimes reserved for cross-correlation (binary). Similar: the +synonyms asterisk <code>*</code> and <code>\ast</code>, which are six-pointed, +and more often appear as a superscript or subscript, as with the Kleene +star. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="607">\subset</indexterm>\subset</itemformat></item> +</tableterm><tableitem><para><U>2282</U> Subset (occasionally, is implied by) (relation). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="608">\subseteq</indexterm>\subseteq</itemformat></item> +</tableterm><tableitem><para><U>2286</U> Subset or equal to (relation). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="609">\succ</indexterm>\succ</itemformat></item> +</tableterm><tableitem><para><U>227B</U> Comes after, succeeds (relation). Similar: is less +than <code>></code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="565">\uplus</indexterm>\uplus</itemformat></item> -</tableterm><tableitem><para><math>\uplus</math> (binary operation) +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="610">\succeq</indexterm>\succeq</itemformat></item> +</tableterm><tableitem><para><U>2AB0</U> Succeeds or is equal to (relation). Similar: less +than or equal to <code>\leq</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="566">\Upsilon</indexterm>\Upsilon</itemformat></item> -</tableterm><tableitem><para><math>\Upsilon</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="611">\sum</indexterm>\sum</itemformat></item> +</tableterm><tableitem><para><U>2211</U> Summation (operator). Similar: Greek capital +sigma <code>\Sigma</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="567">\upsilon</indexterm>\upsilon</itemformat></item> -</tableterm><tableitem><para><math>\upsilon</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="612">\supset</indexterm>\supset</itemformat></item> +</tableterm><tableitem><para><U>2283</U> Superset (relation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="568">\varepsilon</indexterm>\varepsilon</itemformat></item> -</tableterm><tableitem><para><math>\varepsilon</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="613">\supseteq</indexterm>\supseteq</itemformat></item> +</tableterm><tableitem><para><U>2287</U> Superset or equal to (relation). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="614">\surd</indexterm>\surd</itemformat></item> +</tableterm><tableitem><para><U>221A</U> Radical symbol (ordinary). The &latex; command +<code>\sqrt{..}</code> typesets the square root of the argument, with a bar +that extends to cover the argument. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="569">\varphi</indexterm>\varphi</itemformat></item> -</tableterm><tableitem><para><math>\varphi</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="570">\varpi</indexterm>\varpi</itemformat></item> -</tableterm><tableitem><para><math>\varpi</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="571">\varrho</indexterm>\varrho</itemformat></item> -</tableterm><tableitem><para><math>\varrho</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="572">\varsigma</indexterm>\varsigma</itemformat></item> -</tableterm><tableitem><para><math>\varsigma</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="573">\vartheta</indexterm>\vartheta</itemformat></item> -</tableterm><tableitem><para><math>\vartheta</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="574">\vdash</indexterm>\vdash</itemformat></item> -</tableterm><tableitem><para><math>\vdash</math> (relation) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="575">\vee</indexterm>\vee</itemformat></item> -</tableterm><tableitem><para><math>\vee</math> (binary operation) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="576">\Vert</indexterm>\Vert</itemformat></item> -</tableterm><tableitem><para><math>\Vert</math> (delimiter) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="577">\vert</indexterm>\vert</itemformat></item> -</tableterm><tableitem><para><math>\vert</math> (delimiter) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="578">\wedge</indexterm>\wedge</itemformat></item> -</tableterm><tableitem><para><math>\wedge</math> (binary operation) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="579">\wp</indexterm>\wp</itemformat></item> -</tableterm><tableitem><para><math>\wp</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="580">\wr</indexterm>\wr</itemformat></item> -</tableterm><tableitem><para><math>\wr</math> (binary operation) -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="581">\Xi</indexterm>\Xi</itemformat></item> -</tableterm><tableitem><para><math>\Xi</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="582">\xi</indexterm>\xi</itemformat></item> -</tableterm><tableitem><para><math>\xi</math> -</para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="583">\zeta</indexterm>\zeta</itemformat></item> -</tableterm><tableitem><para><math>\zeta</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="615">\swarrow</indexterm>\swarrow</itemformat></item> +</tableterm><tableitem><para><U>2199</U> Southwest-pointing arrow (relation). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="616">\tau</indexterm>\tau</itemformat></item> +</tableterm><tableitem><para><U>03C4</U> Lower case Greek letter (ordinary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="617">\theta</indexterm>\theta</itemformat></item> +</tableterm><tableitem><para><U>03B8</U> Lower case Greek letter (ordinary). The variant form is +<code>\vartheta</code> <U>03D1</U>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="618">\times</indexterm>\times</itemformat></item> +</tableterm><tableitem><para><U>00D7</U> Primary school multiplication sign (binary). See +also <code>\cdot</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="619">\to</indexterm>\to</itemformat></item> +</tableterm><tableitem><para><U>2192</U> Right-pointing single line arrow (relation). +Synonym: <code>\rightarrow</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="620">\top</indexterm>\top</itemformat></item> +</tableterm><tableitem><para><U>22A4</U> Top, greatest element of a poset (ordinary). See +also <code>\bot</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="621">\triangle</indexterm>\triangle</itemformat></item> +</tableterm><tableitem><para><U>25B3</U> Triangle (ordinary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="622">\triangleleft</indexterm>\triangleleft</itemformat></item> +</tableterm><tableitem><para><U>25C1</U> Not-filled triangle pointing left +(binary). Similar: <code>\lhd</code>. For the normal subgroup symbol you +should load <file>amssymb</file> and use <code>\vartriangleleft</code> (which +is a relation and so gives better spacing). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="623">\triangleright</indexterm>\triangleright</itemformat></item> +</tableterm><tableitem><para><U>25B7</U> Not-filled triangle pointing right (binary). For the normal +subgroup symbol you should instead load <file>amssymb</file> and +use <code>\vartriangleright</code> (which is a relation and so gives +better spacing). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="624">\unlhd</indexterm>\unlhd</itemformat></item> +</tableterm><tableitem><para><U>22B4</U> Left-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain &tex;. In &latex; +you should load the <file>amssymb</file> package. For the normal subgroup +symbol load <file>amssymb</file> and use <code>\vartrianglelefteq</code> (which +is a relation and so gives better spacing). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="625">\unrhd</indexterm>\unrhd</itemformat></item> +</tableterm><tableitem><para><U>22B5</U> Right-pointing not-filled arrowhead, that is, triangle, with a +line under (binary). This is not available in Plain &tex;. In &latex; +you should load the <file>amssymb</file> package. For the normal subgroup +symbol load <file>amssymb</file> and use <code>\vartrianglerighteq</code> +(which is a relation and so gives better spacing). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="626">\Uparrow</indexterm>\Uparrow</itemformat></item> +</tableterm><tableitem><para><U>21D1</U> Double-line upward-pointing arrow (relation). Similar: +single-line up-pointing arrow <code>\uparrow</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="627">\uparrow</indexterm>\uparrow</itemformat></item> +</tableterm><tableitem><para><U>2191</U> Single-line upward-pointing arrow, diverges (relation). Similar: +double-line up-pointing arrow <code>\Uparrow</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="628">\Updownarrow</indexterm>\Updownarrow</itemformat></item> +</tableterm><tableitem><para><U>21D5</U> Double-line upward-and-downward-pointing arrow (relation). Similar: +single-line upward-and-downward-pointing arrow <code>\updownarrow</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="629">\updownarrow</indexterm>\updownarrow</itemformat></item> +</tableterm><tableitem><para><U>2195</U> Single-line upward-and-downward-pointing arrow (relation). Similar: +double-line upward-and-downward-pointing arrow <code>\Updownarrow</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="630">\upharpoonright</indexterm>\upharpoonright</itemformat></item> +</tableterm><tableitem><para><U>21BE</U> Up harpoon, with barb on right side +(relation). Synonym: <code>&backslashchar;restriction</code>. Not available in Plain +&tex;. In &latex; you should load the <file>amssymb</file> package. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="631">\uplus</indexterm>\uplus</itemformat></item> +</tableterm><tableitem><para><U>228E</U> Multiset union, a union symbol with a plus symbol in the middle +(binary). Similar: union <code>\cup</code>. Related: variable-sized +operator <code>\biguplus</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="632">\Upsilon</indexterm>\Upsilon</itemformat></item> +</tableterm><tableitem><para><U>03A5</U> Upper case Greek letter (ordinary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="633">\upsilon</indexterm>\upsilon</itemformat></item> +</tableterm><tableitem><para><U>03C5</U> Lower case Greek letter (ordinary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="634">\varepsilon</indexterm>\varepsilon</itemformat></item> +</tableterm><tableitem><para><U>03B5</U> Rounded small epsilon (ordinary). This is more widely used in +mathematics than the non-variant lower case Greek-text letter form +<code>\epsilon</code> <U>03F5</U>. Related: set membership <code>\in</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="635">\varphi</indexterm>\varphi</itemformat></item> +</tableterm><tableitem><para><U>03C6</U> Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\phi</code> <U>03D5</U>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="636">\varpi</indexterm>\varpi</itemformat></item> +</tableterm><tableitem><para><U>03D6</U> Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\pi</code> <U>03C0</U>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="637">\varrho</indexterm>\varrho</itemformat></item> +</tableterm><tableitem><para><U>03F1</U> Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\rho</code> <U>03C1</U>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="638">\varsigma</indexterm>\varsigma</itemformat></item> +</tableterm><tableitem><para><U>03C2</U> Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\sigma</code> <U>03C3</U>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="639">\vartheta</indexterm>\vartheta</itemformat></item> +</tableterm><tableitem><para><U>03D1</U> Variant on the lower case Greek letter (ordinary). The +non-variant form is <code>\theta</code> <U>03B8</U>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="640">\vdash</indexterm>\vdash</itemformat></item> +</tableterm><tableitem><para><U>22A2</U> Provable; turnstile, vertical and a dash (relation). Similar: +turnstile rotated a half-circle <code>\dashv</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="641">\vee</indexterm>\vee</itemformat></item> +</tableterm><tableitem><para><U>2228</U> Logical or; a downwards v shape (binary). Related: logical +and <code>\wedge</code>. Similar: variable-sized +operator <code>\bigvee</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="642">\Vert</indexterm>\Vert</itemformat></item> +</tableterm><tableitem><para><U>2016</U> Vertical double bar (ordinary). Similar: vertical single +bar <code>\vert</code>. +</para> +<para>For a norm you can use the <file>mathtools</file> package and add +<code>\DeclarePairedDelimiter\norm{\lVert}{\rVert}</code> to your +preamble. This gives you three command variants for double-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version <code>$\norm*{M^\perp}$</code> then the height of +the vertical bars will match the height of the argument, whereas with +<code>\norm{M^\perp}</code> the bars do not grow with the height of the +argument but instead are the default height, and <code>\norm[<var>size +command</var>]{M^\perp}</code> also gives bars that do not grow but are set to +the size given in the <var>size command</var>, e.g., <code>\Bigg</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="643">\vert</indexterm>\vert</itemformat></item> +</tableterm><tableitem><para><U>007C</U> Single line vertical bar (ordinary). Similar: double-line +vertical bar <code>\Vert</code>. For such that, as in the definition of a +set, use <code>\mid</code> because it is a relation. +</para> +<para>For absolute value you can use the <file>mathtools</file> package and add +<code>\DeclarePairedDelimiter\abs{\lvert}{\rvert}</code> to your +preamble. This gives you three command variants for single-line vertical +bars that are correctly horizontally spaced: if in the document body you +write the starred version <code>$\abs*{\frac{22}{7}}$</code> then the +height of the vertical bars will match the height of the argument, +whereas with <code>\abs{\frac{22}{7}}</code> the bars do not grow with +the height of the argument but instead are the default height, and +<code>\abs[<var>size command</var>]{\frac{22}{7}}</code> also gives bars +that do not grow but are set to the size given in the <var>size +command</var>, e.g., <code>\Bigg</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="644">\wedge</indexterm>\wedge</itemformat></item> +</tableterm><tableitem><para><U>2227</U> Logical and (binary). Synonym: <code>\land</code>. See also +logical or <code>\vee</code>. Similar: variable-sized +operator <code>\bigwedge</code>. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="645">\wp</indexterm>\wp</itemformat></item> +</tableterm><tableitem><para><U>2118</U> Weierstrass p (ordinary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="646">\wr</indexterm>\wr</itemformat></item> +</tableterm><tableitem><para><U>2240</U> Wreath product (binary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="647">\Xi</indexterm>\Xi</itemformat></item> +</tableterm><tableitem><para><U>039E</U> Upper case Greek letter (ordinary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="648">\xi</indexterm>\xi</itemformat></item> +</tableterm><tableitem><para><U>03BE</U> Lower case Greek letter (ordinary). +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="649">\zeta</indexterm>\zeta</itemformat></item> +</tableterm><tableitem><para><U>03B6</U> Lower case Greek letter (ordinary). </para> </tableitem></tableentry></ftable> @@ -5153,116 +7172,117 @@ the pi symbol (<math>\pi</math>) in your output. </section> <node name="Math-functions" spaces=" "><nodename>Math functions</nodename><nodenext automatic="on">Math accents</nodenext><nodeprev automatic="on">Math symbols</nodeprev><nodeup automatic="on">Math formulas</nodeup></node> <section spaces=" "><sectiontitle>Math functions</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="269">math functions</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="270">functions, math</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="308">math functions</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="309">functions, math</indexterm></cindex> <para>These commands produce roman function names in math mode with proper spacing. </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="584">\arccos</indexterm>\arccos</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="650">\arccos</indexterm>\arccos</itemformat></item> </tableterm><tableitem><para><math>\arccos</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="585">\arcsin</indexterm>\arcsin</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="651">\arcsin</indexterm>\arcsin</itemformat></item> </tableterm><tableitem><para><math>\arcsin</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="586">\arctan</indexterm>\arctan</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="652">\arctan</indexterm>\arctan</itemformat></item> </tableterm><tableitem><para><math>\arctan</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="587">\arg</indexterm>\arg</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="653">\arg</indexterm>\arg</itemformat></item> </tableterm><tableitem><para><math>\arg</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="588">\bmod</indexterm>\bmod</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="654">\bmod</indexterm>\bmod</itemformat></item> </tableterm><tableitem><para>Binary modulo operator (<math>x \bmod y</math>) </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="589">\cos</indexterm>\cos</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="655">\cos</indexterm>\cos</itemformat></item> </tableterm><tableitem><para><math>\cos</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="590">\cosh</indexterm>\cosh</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="656">\cosh</indexterm>\cosh</itemformat></item> </tableterm><tableitem><para><math>\cosh</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="591">\cot</indexterm>\cot</itemformat></item> -</tableterm><tableitem><para><math>\cos</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="657">\cot</indexterm>\cot</itemformat></item> +</tableterm><tableitem><para><math>\cot</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="592">\coth</indexterm>\coth</itemformat></item> -</tableterm><tableitem><para><math>\cosh</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="658">\coth</indexterm>\coth</itemformat></item> +</tableterm><tableitem><para><math>\coth</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="593">\csc</indexterm>\csc</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="659">\csc</indexterm>\csc</itemformat></item> </tableterm><tableitem><para><math>\csc</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="594">\deg</indexterm>\deg</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="660">\deg</indexterm>\deg</itemformat></item> </tableterm><tableitem><para><math>\deg</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="595">\det</indexterm>\det</itemformat></item> -</tableterm><tableitem><para><math>\deg</math> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="661">\det</indexterm>\det</itemformat></item> +</tableterm><tableitem><para><math>\det</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="596">\dim</indexterm>\dim</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="662">\dim</indexterm>\dim</itemformat></item> </tableterm><tableitem><para><math>\dim</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="597">\exp</indexterm>\exp</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="663">\exp</indexterm>\exp</itemformat></item> </tableterm><tableitem><para><math>\exp</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="598">\gcd</indexterm>\gcd</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="664">\gcd</indexterm>\gcd</itemformat></item> </tableterm><tableitem><para><math>\gcd</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="599">\hom</indexterm>\hom</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="665">\hom</indexterm>\hom</itemformat></item> </tableterm><tableitem><para><math>\hom</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="600">\inf</indexterm>\inf</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="666">\inf</indexterm>\inf</itemformat></item> </tableterm><tableitem><para><math>\inf</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="601">\ker</indexterm>\ker</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="667">\ker</indexterm>\ker</itemformat></item> </tableterm><tableitem><para><math>\ker</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="602">\lg</indexterm>\lg</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="668">\lg</indexterm>\lg</itemformat></item> </tableterm><tableitem><para><math>\lg</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="603">\lim</indexterm>\lim</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="669">\lim</indexterm>\lim</itemformat></item> </tableterm><tableitem><para><math>\lim</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="604">\liminf</indexterm>\liminf</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="670">\liminf</indexterm>\liminf</itemformat></item> </tableterm><tableitem><para><math>\liminf</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="605">\limsup</indexterm>\limsup</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="671">\limsup</indexterm>\limsup</itemformat></item> </tableterm><tableitem><para><math>\limsup</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="606">\ln</indexterm>\ln</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="672">\ln</indexterm>\ln</itemformat></item> </tableterm><tableitem><para><math>\ln</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="607">\log</indexterm>\log</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="673">\log</indexterm>\log</itemformat></item> </tableterm><tableitem><para><math>\log</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="608">\max</indexterm>\max</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="674">\max</indexterm>\max</itemformat></item> </tableterm><tableitem><para><math>\max</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="609">\min</indexterm>\min</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="675">\min</indexterm>\min</itemformat></item> </tableterm><tableitem><para><math>\min</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="610">\pmod</indexterm>\pmod</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="676">\pmod</indexterm>\pmod</itemformat></item> </tableterm><tableitem><para>parenthesized modulus, as in (<math>\pmod 2^n - 1</math>) </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="611">\Pr</indexterm>\Pr</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="677">\Pr</indexterm>\Pr</itemformat></item> </tableterm><tableitem><para><math>\Pr</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="612">\sec</indexterm>\sec</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="678">\sec</indexterm>\sec</itemformat></item> </tableterm><tableitem><para><math>\sec</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="613">\sin</indexterm>\sin</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="679">\sin</indexterm>\sin</itemformat></item> </tableterm><tableitem><para><math>\sin</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="614">\sinh</indexterm>\sinh</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="680">\sinh</indexterm>\sinh</itemformat></item> </tableterm><tableitem><para><math>\sinh</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="615">\sup</indexterm>\sup</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="681">\sup</indexterm>\sup</itemformat></item> </tableterm><tableitem><para>sup <!-- c don't try to use \sup since that turned into a Texinfo command --> <!-- c and it's not worth hassling with different versions when it's --> <!-- c just three roman letters anyway. --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="616">\tan</indexterm>\tan</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="682">\tan</indexterm>\tan</itemformat></item> </tableterm><tableitem><para><math>\tan</math> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="617">\tanh</indexterm>\tanh</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="683">\tanh</indexterm>\tanh</itemformat></item> </tableterm><tableitem><para><math>\tanh</math> </para> </tableitem></tableentry></ftable> @@ -5271,76 +7291,77 @@ spacing. </section> <node name="Math-accents" spaces=" "><nodename>Math accents</nodename><nodenext automatic="on">Spacing in math mode</nodenext><nodeprev automatic="on">Math functions</nodeprev><nodeup automatic="on">Math formulas</nodeup></node> <section spaces=" "><sectiontitle>Math accents</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="271">math accents</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="272">accents, mathematical</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="310">math accents</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="311">accents, mathematical</indexterm></cindex> <para>&latex; provides a variety of commands for producing accented letters in math. These are different from accents in normal text (<pxref label="Accents"><xrefnodename>Accents</xrefnodename></pxref>). </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="618">\acute</indexterm>\acute</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="273">acute accent, math</indexterm></cindex> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="684">\acute</indexterm>\acute</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="312">acute accent, math</indexterm></cindex> <para>Math acute accent: <math>\acute{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="619">\bar</indexterm>\bar</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="274">bar-over accent, math</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="275">macron accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="685">\bar</indexterm>\bar</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="313">bar-over accent, math</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="314">macron accent, math</indexterm></cindex> <para>Math bar-over accent: <math>\bar{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="620">\breve</indexterm>\breve</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="276">breve accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="686">\breve</indexterm>\breve</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="315">breve accent, math</indexterm></cindex> <para>Math breve accent: <math>\breve{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="621">\check</indexterm>\check</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="277">check accent, math</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="278">h<accent type="acute" bracketed="off">a</accent><accent type="caron">c</accent>ek accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="687">\check</indexterm>\check</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="316">check accent, math</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="317">h<accent type="acute" bracketed="off">a</accent><accent type="caron">c</accent>ek accent, math</indexterm></cindex> <para>Math h<accent type="acute" bracketed="off">a</accent><accent type="caron">c</accent>ek (check) accent: <math>\check{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="622">\ddot</indexterm>\ddot</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="279">double dot accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="688">\ddot</indexterm>\ddot</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="318">double dot accent, math</indexterm></cindex> <para>Math dieresis accent: <math>\ddot{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="623">\dot</indexterm>\dot</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="280">overdot accent, math</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="281">dot over accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="689">\dot</indexterm>\dot</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="319">overdot accent, math</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="320">dot over accent, math</indexterm></cindex> <para>Math dot accent: <math>\dot{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="624">\grave</indexterm>\grave</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="282">grave accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="690">\grave</indexterm>\grave</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="321">grave accent, math</indexterm></cindex> <para>Math grave accent: <math>\grave{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="625">\hat</indexterm>\hat</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="283">hat accent, math</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="284">circumflex accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="691">\hat</indexterm>\hat</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="322">hat accent, math</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="323">circumflex accent, math</indexterm></cindex> <para>Math hat (circumflex) accent: <math>\hat{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="626">\imath</indexterm>\imath</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="285">dotless i, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="692">\imath</indexterm>\imath</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="324">dotless i, math</indexterm></cindex> <para>Math dotless i. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="627">\jmath</indexterm>\jmath</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="286">dotless j, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="693">\jmath</indexterm>\jmath</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="325">dotless j, math</indexterm></cindex> <para>Math dotless j. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="628">\mathring</indexterm>\mathring</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="287">ring accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="694">\mathring</indexterm>\mathring</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="326">ring accent, math</indexterm></cindex> <para>Math ring accent: <accent type="ring">x</accent>. <!-- c don't bother implementing in texinfo --> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="629">\tilde</indexterm>\tilde</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="288">tilde accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="695">\tilde</indexterm>\tilde</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="327">tilde accent, math</indexterm></cindex> <para>Math tilde accent: <math>\tilde{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="630">\vec</indexterm>\vec</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="289">vector symbol, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="696">\vec</indexterm>\vec</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="328">vector symbol, math</indexterm></cindex> <para>Math vector symbol: <math>\vec{x}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="631">\widehat</indexterm>\widehat</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="290">wide hat accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="697">\widehat</indexterm>\widehat</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="329">wide hat accent, math</indexterm></cindex> <para>Math wide hat accent: <math>\widehat{x+y}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="632">\widehat</indexterm>\widehat</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="291">wide tile accent, math</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="698">\widetilde</indexterm>\widetilde</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="330">wide tilde accent, math</indexterm></cindex> <para>Math wide tilde accent: <math>\widetilde{x+y}</math>. </para> </tableitem></tableentry></ftable> @@ -5349,74 +7370,109 @@ in math. These are different from accents in normal text </section> <node name="Spacing-in-math-mode" spaces=" "><nodename>Spacing in math mode</nodename><nodenext automatic="on">Math miscellany</nodenext><nodeprev automatic="on">Math accents</nodeprev><nodeup automatic="on">Math formulas</nodeup></node> <section spaces=" "><sectiontitle>Spacing in math mode</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="292">spacing within math mode</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="293">math mode, spacing</indexterm></cindex> -<para>In a <code>math</code> environment, &latex; ignores the spaces you type and -puts in the spacing according to the normal rules for mathematics -texts. If you want different spacing, &latex; provides the following -commands for use in math mode: +<cindex index="cp" spaces=" "><indexterm index="cp" number="331">spacing within math mode</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="332">math mode, spacing</indexterm></cindex> + +<para>In a <code>math</code> environment, &latex; ignores the spaces that you use +in the source, and instead puts in the spacing according to the normal +rules for mathematics texts. +</para> +<para>Many math mode spacing definitions are expressed in terms of the math unit +<dfn>mu</dfn> given by 1 em = 18 mu, where the em is taken from the current +math symbols family (<pxref label="Units-of-length"><xrefnodename>Units of length</xrefnodename></pxref>). +&latex; provides the following commands for use in math mode: </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">\;</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="633">\;</indexterm></findex> -<para>A thick space (<math>5\over18\,</math>quad). -</para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\:</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="699">\;</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="700">\thickspace</indexterm></findex> +<para>Normally <code>5.0mu plus 5.0mu</code>. The longer name is +<code>\thickspace</code>. Math mode only. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\:</itemformat></item> <itemx spaces=" "><itemformat command="code">\></itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="634">\:</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="635">\></indexterm></findex> -<para>Both of these produce a medium space (<math>2\over9\,</math>quad). -</para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\,</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="636">\,</indexterm></findex> -<para>A thin space (<math>1\over6\,</math>quad); not restricted to math mode. -</para></tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\!</itemformat></item> -</tableterm><tableitem><para>A negative thin space (<math>-{1\over6}\,</math>quad). +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="701">\:</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="702">\></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="703">\medspace</indexterm></findex> +<para>Normally <code>4.0mu plus 2.0mu minus 4.0mu</code>. The longer name is +<code>\medspace</code>. Math mode only. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\,</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="704">\,</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="705">\thinspace</indexterm></findex> +<para>Normally <code>3mu</code>. The longer name is <code>\thinspace</code>. This can +be used in both math mode and text mode. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\!</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="706">\!</indexterm></findex> +<para>A negative thin space. Normally <code>-3mu</code>. Math mode only. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\quad</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="333">quad</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="707">\quad</indexterm></findex> +<para>This is 18<dmn>mu</dmn>, that is, 1<dmn>em</dmn>. This is often used for space +surrounding equations or expressions, for instance for the space between +two equations inside a <code>displaymath</code> environment. It is available +in both text and math mode. +</para> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\qquad</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="708">\qquad</indexterm></findex> +<para>A length of 2 quads, that is, 36<dmn>mu</dmn> = 2<dmn>em</dmn>. It is available in +both text and math mode. </para></tableitem></tableentry></table> +<para>In this example a thinspace separates the function from the +infinitesimal. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\int_0^1 f(x)\,dx +</pre></example> + </section> <node name="Math-miscellany" spaces=" "><nodename>Math miscellany</nodename><nodeprev automatic="on">Spacing in math mode</nodeprev><nodeup automatic="on">Math formulas</nodeup></node> <section spaces=" "><sectiontitle>Math miscellany</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="294">math miscellany</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="334">math miscellany</indexterm></cindex> <ftable commandarg="code" spaces=" " endspaces=" "> -<beforefirstitem> -</beforefirstitem><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="637">\*</indexterm>\*</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="295">discretionary multiplication</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="296">multiplication symbol, discretionary line break</indexterm></cindex> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="709">\*</indexterm>\*</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="335">discretionary multiplication</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="336">multiplication symbol, discretionary line break</indexterm></cindex> <para>A &textldquo;discretionary&textrdquo; multiplication symbol, at which a line break is allowed. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="638">\cdots</indexterm>\cdots</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="710">\cdots</indexterm>\cdots</itemformat></item> </tableterm><tableitem><para>A horizontal ellipsis with the dots raised to the center of the line. <tex endspaces=" "> As in: &textlsquo;$\cdots$&textrsquo;. </tex> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="639">\ddots</indexterm>\ddots</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="711">\ddots</indexterm>\ddots</itemformat></item> </tableterm><tableitem><para>A diagonal ellipsis: <math>\ddots</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="640">\frac{num}{den}</indexterm>\frac{num}{den}</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="641">\frac</indexterm></findex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="712">\frac{num}{den}</indexterm>\frac{num}{den}</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="713">\frac</indexterm></findex> <para>Produces the fraction <code>num</code> divided by <code>den</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="642">\left <var>delim1</var> ... \right <var>delim2</var></indexterm>\left <var>delim1</var> ... \right <var>delim2</var></itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="643">\right</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="297">null delimiter</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="714">\left <var>delim1</var> ... \right <var>delim2</var></indexterm>\left <var>delim1</var> ... \right <var>delim2</var></itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="715">\right</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="337">null delimiter</indexterm></cindex> <para>The two delimiters need not match; <samp>.</samp> acts as a null delimiter, producing no output. The delimiters are sized according to the math in between. Example: <code>\left( \sum_i=1^10 a_i \right]</code>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="644">\overbrace{<var>text</var>}</indexterm>\overbrace{<var>text</var>}</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="716">\overbrace{<var>text</var>}</indexterm>\overbrace{<var>text</var>}</itemformat></item> </tableterm><tableitem><para>Generates a brace over <var>text</var>. For example, <math>\overbrace{x+\cdots+x}^{k \rm\;times}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="645">\overline{<var>text</var>}</indexterm>\overline{<var>text</var>}</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="717">\overline{<var>text</var>}</indexterm>\overline{<var>text</var>}</itemformat></item> </tableterm><tableitem><para>Generates a horizontal line over <var>tex</var>. For example, <math>\overline{x+y}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="646">\sqrt[<var>root</var>]{arg}</indexterm>\sqrt[<var>root</var>]{arg}</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="718">\sqrt[<var>root</var>]{arg}</indexterm>\sqrt[<var>root</var>]{arg}</itemformat></item> </tableterm><tableitem><para>Produces the representation of the square root of <var>arg</var>. The optional argument <var>root</var> determines what root to produce. For example, the cube root of <code>x+y</code> would be typed as @@ -5426,7 +7482,7 @@ In &tex;, the result looks like this: $\root 3 \of x+y$. </tex> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="647">\stackrel{<var>text</var>}{<var>relation</var>}</indexterm>\stackrel{<var>text</var>}{<var>relation</var>}</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="719">\stackrel{<var>text</var>}{<var>relation</var>}</indexterm>\stackrel{<var>text</var>}{<var>relation</var>}</itemformat></item> </tableterm><tableitem><para>Puts <var>text</var> above <var>relation</var>. For example, <code>\stackrel{f}{\longrightarrow}</code>. <tex endspaces=" "> @@ -5434,14 +7490,14 @@ In &tex;, the result looks like this: $\buildrel f \over \longrightarrow$. </tex> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="648">\underbrace{math}</indexterm>\underbrace{math}</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="720">\underbrace{math}</indexterm>\underbrace{math}</itemformat></item> </tableterm><tableitem><para>Generates <var>math</var> with a brace underneath. <tex endspaces=" "> In &tex;, the result looks like this: $\underbrace{x+y+z}_{>\,0}$. </tex> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="649">\underline{text}</indexterm>\underline{text}</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="721">\underline{text}</indexterm>\underline{text}</itemformat></item> </tableterm><tableitem><para>Causes <var>text</var>, which may be either math mode or not, to be underlined. The line is always below the text, taking account of descenders. @@ -5450,8 +7506,8 @@ In &tex;, the result looks like this: $\underline{xyz}$ </tex> </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="650">\vdots</indexterm>\vdots</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="651">\vdots</indexterm></findex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="722">\vdots</indexterm>\vdots</itemformat></item> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="723">\vdots</indexterm></findex> <para>Produces a vertical ellipsis. <tex endspaces=" "> In &tex;, the result looks like this: @@ -5465,11 +7521,12 @@ $\vdots$. </chapter> <node name="Modes" spaces=" "><nodename>Modes</nodename><nodenext automatic="on">Page styles</nodenext><nodeprev automatic="on">Math formulas</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Modes</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="298">modes</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="299">paragraph mode</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="300">math mode</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="301">left-to-right mode</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="302">LR mode</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="338">modes</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="339">paragraph mode</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="340">math mode</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="341">left-to-right mode</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="342">LR mode</indexterm></cindex> <para>When &latex; is processing your input text, it is always in one of three modes: @@ -5493,7 +7550,7 @@ input text into lines and breaks the lines into pages. <para>&latex; is in <dfn>math mode</dfn> when it&textrsquo;s generating a mathematical formula, either displayed math or within a line. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="652">\mbox<r>, and LR mode</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="724">\mbox<r>, and LR mode</r></indexterm></findex> <para>In <dfn>LR mode</dfn>, as in paragraph mode, &latex; considers the output that it produces to be a string of words with spaces between them. However, unlike paragraph mode, &latex; keeps going from left to @@ -5517,8 +7574,9 @@ mode, which it starts out in, is called &textldquo;outer paragraph mode&textrdqu </chapter> <node name="Page-styles" spaces=" "><nodename>Page styles</nodename><nodenext automatic="on">Spaces</nodenext><nodeprev automatic="on">Modes</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Page styles</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="303">styles, page</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="304">page styles</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="343">styles, page</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="344">page styles</indexterm></cindex> <para>The <code>\documentclass</code> command determines the size and position of the page&textrsquo;s head and foot. The page style determines what goes in them. @@ -5533,8 +7591,9 @@ the page&textrsquo;s head and foot. The page style determines what goes in them <node name="_005cmaketitle" spaces=" "><nodename>\maketitle</nodename><nodenext automatic="on">\pagenumbering</nodenext><nodeup automatic="on">Page styles</nodeup></node> <section spaces=" "><sectiontitle><code>\maketitle</code></sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="305">titles, making</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="653">\maketitle</indexterm></findex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="345">titles, making</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="725">\maketitle</indexterm></findex> <para>The <code>\maketitle</code> command generates a title on a separate title page&textmdash;except in the <code>article</code> class, where the title is placed @@ -5542,30 +7601,30 @@ at the top of the first page. Information used to produce the title is obtained from the following declarations: </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="654">\author{<var>name</var> \and <var>name2</var>}</indexterm>\author{<var>name</var> \and <var>name2</var>}</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="306">author, for titlepage</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="655">\\ <r>for <code>\author</code></r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="656">\and <r>for <code>\author</code></r></indexterm></findex> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="726">\author{<var>name</var> \and <var>name2</var>}</indexterm>\author{<var>name</var> \and <var>name2</var>}</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="346">author, for titlepage</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="727">\\ <r>for <code>\author</code></r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="728">\and <r>for <code>\author</code></r></indexterm></findex> <para>The <code>\author</code> command declares the document author(s), where the argument is a list of authors separated by <code>\and</code> commands. Use <code>\\</code> to separate lines within a single author&textrsquo;s entry&textmdash;for example, to give the author&textrsquo;s institution or address. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="657">\date{<var>text</var>}</indexterm>\date{<var>text</var>}</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="307">date, for titlepage</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="729">\date{<var>text</var>}</indexterm>\date{<var>text</var>}</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="347">date, for titlepage</indexterm></cindex> <para>The <code>\date</code> command declares <var>text</var> to be the document&textrsquo;s date. With no <code>\date</code> command, the current date (<pxref label="_005ctoday"><xrefnodename>\today</xrefnodename></pxref>) is used. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="658">\thanks{<var>text</var>}</indexterm>\thanks{<var>text</var>}</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="308">thanks, for titlepage</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="309">credit footnote</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="730">\thanks{<var>text</var>}</indexterm>\thanks{<var>text</var>}</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="348">thanks, for titlepage</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="349">credit footnote</indexterm></cindex> <para>The <code>\thanks</code> command produces a <code>\footnote</code> to the title, usually used for credit acknowledgements. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="659">\title{<var>text</var>}</indexterm>\title{<var>text</var>}</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="310">title, for titlepage</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="660">\\ <r>for <code>\title</code></r></indexterm></findex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="731">\title{<var>text</var>}</indexterm>\title{<var>text</var>}</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="350">title, for titlepage</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="732">\\ <r>for <code>\title</code></r></indexterm></findex> <para>The <code>\title</code> command declares <var>text</var> to be the title of the document. Use <code>\\</code> to force a line break, as usual. </para> @@ -5575,8 +7634,9 @@ document. Use <code>\\</code> to force a line break, as usual. </section> <node name="_005cpagenumbering" spaces=" "><nodename>\pagenumbering</nodename><nodenext automatic="on">\pagestyle</nodenext><nodeprev automatic="on">\maketitle</nodeprev><nodeup automatic="on">Page styles</nodeup></node> <section spaces=" "><sectiontitle><code>\pagenumbering</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="661">\pagenumbering</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="311">page numbering style</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="733">\pagenumbering</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="351">page numbering style</indexterm></cindex> <para>Synopsis: </para> @@ -5609,10 +7669,11 @@ the following: </section> <node name="_005cpagestyle" spaces=" "><nodename>\pagestyle</nodename><nodenext automatic="on">\thispagestyle</nodenext><nodeprev automatic="on">\pagenumbering</nodeprev><nodeup automatic="on">Page styles</nodeup></node> <section spaces=" "><sectiontitle><code>\pagestyle</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="662">\pagestyle</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="312">header style</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="313">footer style</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="314">running header and footer style</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="734">\pagestyle</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="352">header style</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="353">footer style</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="354">running header and footer style</indexterm></cindex> <para>Synopsis: </para> @@ -5643,7 +7704,7 @@ goes in the headers. <para>Here are the descriptions of <code>\markboth</code> and <code>\markright</code>: </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="663">\markboth{<var>left</var>}{<var>right</var>}</indexterm>\markboth{<var>left</var>}{<var>right</var>}</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="735">\markboth{<var>left</var>}{<var>right</var>}</indexterm>\markboth{<var>left</var>}{<var>right</var>}</itemformat></item> </tableterm><tableitem><para>Sets both the left and the right heading. A &textldquo;left-hand heading&textrdquo; (<var>left</var>) is generated by the last <code>\markboth</code> command before the end of the page, while a &textldquo;right-hand heading&textrdquo; (<var>right</var>) is @@ -5651,7 +7712,7 @@ generated by the first <code>\markboth</code> or <code>\markright</code> that comes on the page if there is one, otherwise by the last one before the page. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="664">\markright{<var>right</var>}</indexterm>\markright{<var>right</var>}</itemformat></item> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="736">\markright{<var>right</var>}</indexterm>\markright{<var>right</var>}</itemformat></item> </tableterm><tableitem><para>Sets the right heading, leaving the left heading unchanged. </para> </tableitem></tableentry></ftable> @@ -5660,7 +7721,8 @@ the page. </section> <node name="_005cthispagestyle" spaces=" "><nodename>\thispagestyle</nodename><nodeprev automatic="on">\pagestyle</nodeprev><nodeup automatic="on">Page styles</nodeup></node> <section spaces=" "><sectiontitle><code>\thispagestyle{<var>style</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="665">\thispagestyle</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="737">\thispagestyle</indexterm></findex> <para>The <code>\thispagestyle</code> command works in the same manner as the <code>\pagestyle</code> command (see previous section) except that it @@ -5671,24 +7733,22 @@ changes to <var>style</var> for the current page only. </chapter> <node name="Spaces" spaces=" "><nodename>Spaces</nodename><nodenext automatic="on">Boxes</nodenext><nodeprev automatic="on">Page styles</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Spaces</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="315">spaces</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="355">spaces</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="356">white space</indexterm></cindex> <para>&latex; has many ways to produce white (or filled) space. </para> -<para>Another space-producing command is <code>\,</code> to produce a &textldquo;thin&textrdquo; -space (usually 1/6<dmn>quad</dmn>). It can be used in text mode, but is -more often useful in math mode (<pxref label="Spacing-in-math-mode"><xrefnodename>Spacing in math mode</xrefnodename></pxref>). -</para> <menu endspaces=" "> -<menucomment><pre xml:space="preserve">Horizontal space -</pre></menucomment><menuentry leadingtext="* "><menunode separator=":: ">\hspace</menunode><menudescription><pre xml:space="preserve">Fixed horizontal space. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\hfill</menunode><menudescription><pre xml:space="preserve">Stretchable horizontal space. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\SPACE</menunode><menudescription><pre xml:space="preserve">Normal interword space. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\&arobase;</menunode><menudescription><pre xml:space="preserve">Ending a sentence. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\thinspace</menunode><menudescription><pre xml:space="preserve">One-sixth of an em. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\/</menunode><menudescription><pre xml:space="preserve">Insert italic correction. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\hrulefill</menunode><menudescription><pre xml:space="preserve">Stretchable horizontal rule. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\dotfill</menunode><menudescription><pre xml:space="preserve">Stretchable horizontal dots. +<menucomment><pre xml:space="preserve">Horizontal space +</pre></menucomment><menuentry leadingtext="* "><menunode separator=":: ">\hspace</menunode><menudescription><pre xml:space="preserve">Fixed horizontal space. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\hfill</menunode><menudescription><pre xml:space="preserve">Stretchable horizontal space. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\(SPACE) and \&arobase;</menunode><menudescription><pre xml:space="preserve">Space after a period. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\(SPACE) after CS</menunode><menudescription><pre xml:space="preserve">Controlling space gobbling after a control sequence. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\frenchspacing</menunode><menudescription><pre xml:space="preserve">Make interword and intersentence space equal. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\thinspace</menunode><menudescription><pre xml:space="preserve">One-sixth of an em. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\/</menunode><menudescription><pre xml:space="preserve">Insert italic correction. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\hrulefill \dotfill</menunode><menudescription><pre xml:space="preserve">Stretchable horizontal rule or dots. </pre></menudescription></menuentry><menucomment><pre xml:space="preserve"> Vertical space </pre></menucomment><menuentry leadingtext="* "><menunode separator=":: ">\addvspace</menunode><menudescription><pre xml:space="preserve">Add arbitrary vertical space if needed. @@ -5700,88 +7760,169 @@ Vertical space <node name="_005chspace" spaces=" "><nodename>\hspace</nodename><nodenext automatic="on">\hfill</nodenext><nodeup automatic="on">Spaces</nodeup></node> <section spaces=" "><sectiontitle><code>\hspace</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="666">\hspace</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="738">\hspace</indexterm></findex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\hspace[*]{<var>length</var>} +<pre xml:space="preserve">\hspace{<var>length</var>} +\hspace*{<var>length</var>} </pre></example> -<para>The <code>\hspace</code> command adds horizontal space. The <var>length</var> -argument can be expressed in any terms that &latex; understands: -points, inches, etc. It is a rubber length. You can add both -negative and positive space with an <code>\hspace</code> command; adding -negative space is like backspacing. +<para>Add the horizontal space given by <var>length</var>. The <var>length</var> is a +rubber length, that is, it may contain a <code>plus</code> or <code>minus</code> +component, in any unit that &latex; understands (<pxref label="Lengths"><xrefnodename>Lengths</xrefnodename></pxref>). </para> -<para>&latex; normally removes horizontal space that comes at the beginning -or end of a line. To preserve this space, use the optional <code>*</code> -form. +<para>This command can add both positive and negative space; adding negative +space is like backspacing. </para> - -</section> -<node name="_005chfill" spaces=" "><nodename>\hfill</nodename><nodenext automatic="on">\SPACE</nodenext><nodeprev automatic="on">\hspace</nodeprev><nodeup automatic="on">Spaces</nodeup></node> -<section spaces=" "><sectiontitle><code>\hfill</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="667">\hfill</indexterm></findex> - -<cindex index="cp" spaces=" "><indexterm index="cp" number="316">stretch, infinite horizontal</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="317">infinite horizontal stretch</indexterm></cindex> -<para>The <code>\hfill</code> fill command produces a &textldquo;rubber length&textrdquo; which has -no natural space but can stretch or shrink horizontally as far as -needed. +<para>Normally when &tex; breaks a paragraph into lines it discards white +space (glues and kerns) that would come at the start of a line, so you +get an inter-word space or a line break between words but not both. This +command&textrsquo;s starred version <code>\hspace*{..}</code> puts a non-discardable +invisible item in front of the space, so the space appears in the +output. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="668">\fill</indexterm></findex> -<para>The <code>\fill</code> parameter is the rubber length itself (technically, -the glue value <samp>0pt plus1fill</samp>); thus, <code>\hspace\fill</code> is -equivalent to <code>\hfill</code>. +<para>This example make a one-line paragraph that puts <samp>Name:</samp> an inch +from the right margin. </para> +<example endspaces=" "> +<pre xml:space="preserve">\noindent\makebox[\linewidth]{\hspace{\fill}Name:\hspace{1in}} +</pre></example> + </section> -<node name="_005cSPACE" spaces=" "><nodename>\SPACE</nodename><nodenext automatic="on">\&arobase;</nodenext><nodeprev automatic="on">\hfill</nodeprev><nodeup automatic="on">Spaces</nodeup></node> -<section spaces=" "><sectiontitle><code>\SPACE</code>: Normal interword space</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="669">\SPACE</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="670">\TAB</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="671">\NEWLINE</indexterm></findex> +<node name="_005chfill" spaces=" "><nodename>\hfill</nodename><nodenext automatic="on">\(SPACE) and \&arobase;</nodenext><nodeprev automatic="on">\hspace</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<section spaces=" "><sectiontitle><code>\hfill</code></sectiontitle> -<para>The <code>\ </code> (space) command produces a normal interword space. It&textrsquo;s -useful after punctuation which shouldn&textrsquo;t end a sentence. For example, -<code>the article in Proc.\ Amer.\ Math\. Soc.\ is fundamental</code>. It -is also often used after control sequences, as in <code>\TeX\ is a -nice system.</code> +<findex index="fn" spaces=" "><indexterm index="fn" number="739">\hfill</indexterm></findex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="357">stretch, infinite horizontal</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="358">infinite horizontal stretch</indexterm></cindex> +<para>Produce a rubber length which has +no natural space but can stretch horizontally as far as +needed (<pxref label="Lengths"><xrefnodename>Lengths</xrefnodename></pxref>). </para> -<para>In normal circumstances, <code>\</code><key>tab</key> and <code>\</code><key>newline</key> -are equivalent to <code>\ </code>. +<findex index="fn" spaces=" "><indexterm index="fn" number="740">\fill</indexterm></findex> +<para>The command <code>\hfill</code> is equivalent to <code>\hspace{\fill}</code>. For +space that does not disappear at line breaks use +<code>\hspace*{\fill}</code> instead (<pxref label="_005chspace"><xrefnodename>\hspace</xrefnodename></pxref>). </para> </section> -<node name="_005c_0040" spaces=" "><nodename>\&arobase;</nodename><nodenext automatic="on">\thinspace</nodenext><nodeprev automatic="on">\SPACE</nodeprev><nodeup automatic="on">Spaces</nodeup></node> -<section spaces=" "><sectiontitle><code>\&arobase;</code>: Force sentence-ending punctuation</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="672">\&arobase;</indexterm></findex> +<node name="_005c_0028SPACE_0029-and-_005c_0040" spaces=" "><nodename>\(SPACE) and \&arobase;</nodename><nodenext automatic="on">\(SPACE) after CS</nodenext><nodeprev automatic="on">\hfill</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<section spaces=" "><sectiontitle><code>\(SPACE)</code> and \&arobase;</sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="741">\(SPACE)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="742">\TAB</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="743">\NEWLINE</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="744">\&arobase;</indexterm></findex> <anchor name="_005cAT">\AT</anchor><!-- c old name --> -<para>The <code>\&arobase;</code> command makes the following punctuation character end a -sentence even if it normally would not. This is typically used after -a capital letter. Here are side-by-side examples with and without -<code>\&arobase;</code>: +<para>Mark a punctuation character, typically a period, as either ending a +sentence or as ending an abbreviation. +</para> +<para>By default, in justifying a line &latex; adjusts the space after a +sentence-ending period (or a question mark, exclamation point, comma, or +colon) more than the space between words +(<pxref label="_005cfrenchspacing"><xrefnodename>\frenchspacing</xrefnodename></pxref>). &latex; assumes that the period ends a +sentence unless it is preceded by a capital letter, in which case it +takes that period for part of an abbreviation. Note that if a +sentence-ending period is immediately followed by a right parenthesis or +bracket, or right single or double quote, then the intersentence space +follows that parenthesis or quote. +</para> +<para>If you have a period ending an abbreviation whose last letter is not a +capital letter, and that abbreviation is not the last word in the +sentence, then follow that period with a backslash-space (<code>\ </code>) or +a tie (<code>~</code>). Examples are <code>Nat.\ Acad.\ Science</code>, and +<code>Mr.~Bean</code>, and <code>(manure, etc.)\ for sale</code>. +</para> +<para>For other use of <code>\ </code>, see also <ref label="_005c_0028SPACE_0029-after-CS"><xrefnodename>\(SPACE) after CS</xrefnodename></ref>. +</para> +<para>In the opposite situation, if you have a capital letter followed by a +period that ends the sentence, then put <code>\&arobase;</code> on the left of that +period. For example, <code>book by the MAA\&arobase;.</code> will have intersentence +spacing after the period. +</para> +<para>In contrast, putting <code>\&arobase;</code> on the right of a period tells &tex; +that the period does not end the sentence. In the example +<code>reserved words (if, then, etc.\&arobase;) are different</code>, &tex; will put +interword space after the closing parenthesis (note that <code>\&arobase;</code> is +before the parenthesis). +</para> +</section> +<node name="_005c_0028SPACE_0029-after-CS" spaces=" "><nodename>\(SPACE) after CS</nodename><nodenext automatic="on">\frenchspacing</nodenext><nodeprev automatic="on">\(SPACE) and \&arobase;</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<section spaces=" "><sectiontitle><code>\ </code> after a control sequence</sectiontitle> + +<para>The <code>\ </code> command is often used after control sequences to keep them +from gobbling the space that follows, as in <code>\TeX\ is a nice +system.</code> And, under normal circumstances <code>\</code><key>tab</key> and +<code>\</code><key>newline</key> are equivalent to <code>\ </code>. For other use of +<code>\ </code>, see also <ref label="_005c_0028SPACE_0029-and-_005c_0040"><xrefnodename>\(SPACE) and \&arobase;</xrefnodename></ref>. +</para> +<para>Some people prefer to use <code>{}</code> for the same purpose, as in +<code>\TeX{} is a nice system.</code> This has the advantage that you can +always write it the same way, like <code>\TeX{}</code>, whether it is +followed by a space or by a punctuation mark. Please compare: </para> <example endspaces=" "> -<pre xml:space="preserve">&dots; in C\&arobase;. Pascal, though &dots; -&dots; in C. Pascal, though &dots; +<pre xml:space="preserve">\TeX\ is a nice system. \TeX, a nice system.&linebreak; +\TeX{} is a nice system. \TeX{}, a nice system. </pre></example> -<noindent></noindent> <para>produces -</para> -<!-- c Texinfo has different commands, but the result is the same. --> -<quotation endspaces=" "> -<para>&dots; in C&eosperiod; Pascal, though &dots;&linebreak; -&dots; in C. Pascal, though &dots; -</para></quotation> + +<para>When you define user commands (<pxref label="_005cnewcommand-_0026-_005crenewcommand"><xrefnodename>\newcommand & \renewcommand</xrefnodename></pxref>) you +can prevent the space gobbling after the command by using the package +<code>xspace</code> and inserting <code>\xspace</code> at the end of the definition +For instance: +</para><example endspaces=" "> +<pre xml:space="preserve">\documentclass{minimal} +\usepackage{xspace} +\newcommand*{\Loup}{Grand Cric\xspace} +\begin{document} +Que le \Loup me croque ! +\end{document} +</pre></example> + +<para>A quick hack to use <code>\xspace</code> for existing command is as follows: +</para><example endspaces=" "> +<pre xml:space="preserve">\documentclass{minimal} +\usepackage{xspace} +\newcommand*{\SansXspaceTeX}{} +\let\SansXspaceTeX\TeX +\renewcommand{\TeX}{\SansXspaceTeX\xspace} +\begin{document} +\TeX is a nice system. +\end{document} +</pre></example> </section> -<node name="_005cthinspace" spaces=" "><nodename>\thinspace</nodename><nodenext automatic="on">\/</nodenext><nodeprev automatic="on">\&arobase;</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<node name="_005cfrenchspacing" spaces=" "><nodename>\frenchspacing</nodename><nodenext automatic="on">\thinspace</nodenext><nodeprev automatic="on">\(SPACE) after CS</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<section spaces=" "><sectiontitle><code>\frenchspacing</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="745">\frenchspacing</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="746">\nonfrenchspacing</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="359">spacing, intersentence</indexterm></cindex> + +<para>This declaration (from Plain &tex;) causes &latex; to treat +intersentence spacing in the same way as interword spacing. +</para> +<para>In justifying the text in a line, some typographic traditions, including +English, prefer to adjust the space between sentences (or after other +punctuation marks) more than the space between words. Following this +declaration, all spaces are instead treated equally. +</para> +<para>Revert to the default behavior by declaring <code>\nonfrenchspacing</code>. +</para> + +</section> +<node name="_005cthinspace" spaces=" "><nodename>\thinspace</nodename><nodenext automatic="on">\/</nodenext><nodeprev automatic="on">\frenchspacing</nodeprev><nodeup automatic="on">Spaces</nodeup></node> <section spaces=" "><sectiontitle><code>\thinspace</code>: Insert 1/6<dmn>em</dmn></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="673">\thinspace</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="747">\thinspace</indexterm></findex> <para><code>\thinspace</code> produces an unbreakable and unstretchable space that is 1/6 of an em. This is the proper space to use between nested @@ -5789,10 +7930,11 @@ quotes, as in &textrsquo;<dmn></dmn>&textrdquo;.<!-- c Abuse @dmn, which is a th </para> </section> -<node name="_005c_002f" spaces=" "><nodename>\/</nodename><nodenext automatic="on">\hrulefill</nodenext><nodeprev automatic="on">\thinspace</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<node name="_005c_002f" spaces=" "><nodename>\/</nodename><nodenext automatic="on">\hrulefill \dotfill</nodenext><nodeprev automatic="on">\thinspace</nodeprev><nodeup automatic="on">Spaces</nodeup></node> <section spaces=" "><sectiontitle><code>\/</code>: Insert italic correction</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="674">\/</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="318">italic correction</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="748">\/</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="360">italic correction</indexterm></cindex> <para>The <code>\/</code> command produces an <dfn>italic correction</dfn>. This is a small space defined by the font designer for a given character, @@ -5827,40 +7969,63 @@ in a different way. </para> </section> -<node name="_005chrulefill" spaces=" "><nodename>\hrulefill</nodename><nodenext automatic="on">\dotfill</nodenext><nodeprev automatic="on">\/</nodeprev><nodeup automatic="on">Spaces</nodeup></node> -<section spaces=" "><sectiontitle><code>\hrulefill</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="675">\hrulefill</indexterm></findex> +<node name="_005chrulefill-_005cdotfill" spaces=" "><nodename>\hrulefill \dotfill</nodename><nodenext automatic="on">\addvspace</nodenext><nodeprev automatic="on">\/</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<section spaces=" "><sectiontitle><code>\hrulefill \dotfill</code></sectiontitle> -<para>The <code>\hrulefill</code> fill command produces a &textldquo;rubber length&textrdquo; which can -stretch or shrink horizontally. It will be filled with a horizontal -rule. -</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="749">\hrulefill</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="750">\dotfill</indexterm></findex> -</section> -<node name="_005cdotfill" spaces=" "><nodename>\dotfill</nodename><nodenext automatic="on">\addvspace</nodenext><nodeprev automatic="on">\hrulefill</nodeprev><nodeup automatic="on">Spaces</nodeup></node> -<section spaces=" "><sectiontitle><code>\dotfill</code></sectiontitle> - -<findex index="fn" spaces=" "><indexterm index="fn" number="676">\dotfill</indexterm></findex> +<para>Produce an infinite rubber length (<pxref label="Lengths"><xrefnodename>Lengths</xrefnodename></pxref>) filled with a +horizontal rule (that is, a line) or with dots, instead of just white +space. +</para> +<para>When placed between blank lines this example creates a paragraph that is +left and right justified, where the space in the middle is filled with +evenly spaced dots. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\noindent Jack Aubrey\dotfill Melbury Lodge +</pre></example> -<para>The <code>\dotfill</code> command produces a &textldquo;rubber length&textrdquo; that fills -with dots instead of just white space. +<para>To make the rule or dots go to the line&textrsquo;s end use <code>\null</code> at the +start or end. +</para> +<para>To change the rule&textrsquo;s thickness, copy the definition and adjust it, as +with <code>\renewcommand{\hrulefill}{\leavevmode\leaders\hrule height +1pt\hfill\kern\z&arobase;}</code>, which changes the default thickness of +0.4<dmn>pt</dmn> to 1<dmn>pt</dmn>. Similarly, adjust the dot spacing as with +<code>\renewcommand{\dotfill}{\leavevmode\cleaders\hb&arobase;xt&arobase; +1.00em{\hss .\hss }\hfill\kern\z&arobase;}</code>, which changes the default +length of 0.33<dmn>em</dmn> to 1.00<dmn>em</dmn>. </para> -<!-- c xx undone --> </section> -<node name="_005caddvspace" spaces=" "><nodename>\addvspace</nodename><nodenext automatic="on">\bigskip \medskip \smallskip</nodenext><nodeprev automatic="on">\dotfill</nodeprev><nodeup automatic="on">Spaces</nodeup></node> +<node name="_005caddvspace" spaces=" "><nodename>\addvspace</nodename><nodenext automatic="on">\bigskip \medskip \smallskip</nodenext><nodeprev automatic="on">\hrulefill \dotfill</nodeprev><nodeup automatic="on">Spaces</nodeup></node> <section spaces=" "><sectiontitle><code>\addvspace</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="677">\addvspace</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="319">vertical space</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="320">space, inserting vertical</indexterm></cindex> -<para><code>\addvspace{length}</code> +<findex index="fn" spaces=" "><indexterm index="fn" number="751">\addvspace</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="361">vertical space</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="362">space, inserting vertical</indexterm></cindex> + +<para><code>\addvspace{<var>length</var>}</code> +</para> +<para>Add a vertical space of height <var>length</var>, which is a rubber length +(<pxref label="Lengths"><xrefnodename>Lengths</xrefnodename></pxref>). However, if vertical space has already been added to +the same point in the output by a previous <code>\addvspace</code> command +then this command will not add more space than what is needed to make +the natural length of the total vertical space equal to <var>length</var>. +</para> +<para>Use this command to adjust the vertical space above or below an +environment that starts a new paragraph. (For instance, a Theorem +environment is defined to begin and end in <code>\addvspace{..}</code> so +that two consecutive Theorem&textrsquo;s are separated by one vertical space, not +two.) +</para> +<para>This command is fragile (<pxref label="_005cprotect"><xrefnodename>\protect</xrefnodename></pxref>). </para> -<para>The <code>\addvspace</code> command normally adds a vertical space of height -length. However, if vertical space has already been added to the same -point in the output by a previous <code>\addvspace</code> command, then this -command will not add more space than is needed to make the natural -length of the total vertical space equal to <code>length</code>. +<para>The error <samp>Something's wrong--perhaps a missing \item</samp> means that +you were not in vertical mode when you invoked this command; one way to +change that is to precede this command with a <code>\par</code> command. </para> </section> @@ -5872,22 +8037,22 @@ document class. </para> <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">\bigskip</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="678">\bigskip</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="679">\bigskipamount</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="752">\bigskip</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="753">\bigskipamount</indexterm></findex> <para>The same as <code>\vspace{\bigskipamount}</code>, ordinarily about one line space, with stretch and shrink (the default for the <code>book</code> and <code>article</code> classes is <code>12pt plus 4pt minus 4pt</code>). </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\medskip</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="680">\medskip</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="681">\medskipamount</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="754">\medskip</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="755">\medskipamount</indexterm></findex> <para>The same as <code>\vspace{\medskipamount}</code>, ordinarily about half of a line space, with stretch and shrink (the default for the <code>book</code> and <code>article</code> classes is <code>6pt plus 2pt minus 2pt</code>). </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\smallskip</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="682">\smallskip</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="683">\smallskipamount</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="756">\smallskip</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="757">\smallskipamount</indexterm></findex> <para>The same as <code>\vspace{\smallskipamount}</code>, ordinarily about a quarter of a line space, with stretch and shrink (the default for the <code>book</code> and <code>article</code> classes is <code>3pt plus 1pt minus @@ -5899,41 +8064,79 @@ quarter of a line space, with stretch and shrink (the default for the </section> <node name="_005cvfill" spaces=" "><nodename>\vfill</nodename><nodenext automatic="on">\vspace</nodenext><nodeprev automatic="on">\bigskip \medskip \smallskip</nodeprev><nodeup automatic="on">Spaces</nodeup></node> <section spaces=" "><sectiontitle><code>\vfill</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="684">\vfill</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="321">stretch, infinite vertical</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="322">infinite vertical stretch</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="758">\vfill</indexterm></findex> -<para>The <code>\vfill</code> fill command produces a rubber length (glue) which -can stretch or shrink vertically as far as needed. It&textrsquo;s equivalent to -<code>\vspace{\fill}</code> (<pxref label="_005chfill"><xrefnodename>\hfill</xrefnodename></pxref>). +<cindex index="cp" spaces=" "><indexterm index="cp" number="363">stretch, infinite vertical</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="364">infinite vertical stretch</indexterm></cindex> + +<para>End the current paragraph and insert a vertical rubber length +(<pxref label="Lengths"><xrefnodename>Lengths</xrefnodename></pxref>) that is infinite, so it can stretch or shrink as far +as needed. +</para> +<para>It is often used in the same way as <code>\vspace{\fill}</code>, except that +<code>\vfill</code> ends the current paragraph, whereas +<code>\vspace{\fill}</code> adds the infinite vertical space below its line +irrespective of the paragraph structure. In both cases that space will +disappear at a page boundary; to circumvent this see <ref label="_005cvspace"><xrefnodename>\vspace</xrefnodename></ref>. </para> +<para>In this example the page is filled, so the top and bottom lines contain +the text <samp>Lost Dog!</samp> and the third <samp>Lost Dog!</samp> is exactly +halfway between them. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{document} +Lost Dog! +\vfill +Lost Dog! +\vfill +Lost Dog! +\end{document} +</pre></example> + </section> <node name="_005cvspace" spaces=" "><nodename>\vspace</nodename><nodeprev automatic="on">\vfill</nodeprev><nodeup automatic="on">Spaces</nodeup></node> -<section spaces=" "><sectiontitle><code>\vspace[*]{<var>length</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="685">\vspace</indexterm></findex> +<section spaces=" "><sectiontitle><code>\vspace{<var>length</var>}</code></sectiontitle> -<para>Synopsis: +<findex index="fn" spaces=" "><indexterm index="fn" number="759">\vspace</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="365">vertical space</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="366">space, vertical</indexterm></cindex> + +<para>Synopsis, one of these two: </para> <example endspaces=" "> -<pre xml:space="preserve">\vspace[*]{<var>length</var>} +<pre xml:space="preserve">\vspace{<var>length</var>} +\vspace*{<var>length</var>} </pre></example> -<para>The <code>\vspace</code> command adds the vertical space <var>length</var>, i.e., -a rubber length. <var>length</var> can be negative or positive. +<para>Add the vertical space <var>length</var>. This can be negative or positive, +and is a rubber length (<pxref label="Lengths"><xrefnodename>Lengths</xrefnodename></pxref>). </para> -<para>Ordinarily, &latex; removes vertical space added by <code>\vspace</code> at -the top or bottom of a page. With the optional <code>*</code> argument, the -space is not removed. +<para>&latex; removes the vertical space from <code>\vfill</code> at a page break, +that is, at the top or bottom of a page. The starred version +<code>\vspace*{..}</code> causes the space to stay. </para> +<para>In this example the two questions will be evenly spaced vertically on +the page, with at least one inch of space below each. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\begin{document} +1) Who put the bomp in the bomp bah bomp bah bomp? +\vspace{1in plus 1fill} + +2) Who put the ram in the rama lama ding dong? +\vspace{1in plus 1fill} +\end{document} +</pre></example> + </section> </chapter> <node name="Boxes" spaces=" "><nodename>Boxes</nodename><nodenext automatic="on">Special insertions</nodenext><nodeprev automatic="on">Spaces</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Boxes</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="323">boxes</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="367">boxes</indexterm></cindex> <para>All the predefined length parameters (<pxref label="Predefined-lengths"><xrefnodename>Predefined lengths</xrefnodename></pxref>) can be used in the arguments of the box-making commands. @@ -5953,9 +8156,10 @@ used in the arguments of the box-making commands. <node name="_005cmbox" spaces=" "><nodename>\mbox</nodename><nodenext automatic="on">\fbox and \framebox</nodenext><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\mbox{<var>text}</var></code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="686">\mbox</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="324">hyphenation, preventing</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="760">\mbox</indexterm></findex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="368">hyphenation, preventing</indexterm></cindex> <para>The <code>\mbox</code> command creates a box just wide enough to hold the text created by its argument. The <var>text</var> is not broken into lines, so it can be used to prevent hyphenation. @@ -5965,8 +8169,8 @@ lines, so it can be used to prevent hyphenation. <node name="_005cfbox-and-_005cframebox" spaces=" "><nodename>\fbox and \framebox</nodename><nodenext automatic="on">lrbox</nodenext><nodeprev automatic="on">\mbox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\fbox</code> and <code>\framebox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="687">\fbox</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="688">\framebox</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="761">\fbox</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="762">\framebox</indexterm></findex> <para>Synopses: </para> @@ -5983,8 +8187,8 @@ specification of the box width with the optional <var>width</var> argument (a dimension), and positioning with the optional <var>position</var> argument. <!-- c xxref --> </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="689">\fboxrule</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="690">\fboxsep</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="763">\fboxrule</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="764">\fboxsep</indexterm></findex> <para>Both commands produce a rule of thickness <code>\fboxrule</code> (default <samp>.4pt</samp>), and leave a space of <code>\fboxsep</code> (default <samp>3pt</samp>) between the rule and the contents of the box. @@ -5996,7 +8200,8 @@ argument. <!-- c xxref --> </section> <node name="lrbox" spaces=" "><nodename>lrbox</nodename><nodenext automatic="on">\makebox</nodenext><nodeprev automatic="on">\fbox and \framebox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>lrbox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="691">lrbox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="765">lrbox</indexterm></findex> <para><code>\begin{lrbox}{cmd} text \end{lrbox}</code> </para> @@ -6009,7 +8214,8 @@ must have been declared with <code>\newsavebox</code>. </section> <node name="_005cmakebox" spaces=" "><nodename>\makebox</nodename><nodenext automatic="on">\parbox</nodenext><nodeprev automatic="on">lrbox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\makebox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="692">\makebox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="766">\makebox</indexterm></findex> <para>Synopsis: </para> @@ -6018,7 +8224,7 @@ must have been declared with <code>\newsavebox</code>. </pre></example> <para>The <code>\makebox</code> command creates a box just wide enough to contain -the <var>text</var> specified. The width of the box is specified by the +the <var>text</var> specified. The width of the box can be overridden by the optional <var>width</var> argument. The position of the text within the box is determined by the optional <var>position</var> argument, which may take the following values: @@ -6035,14 +8241,15 @@ the following values: stretchable space for this to work. </para></tableitem></tableentry></table> -<para><code>\makebox</code> is also used within the picture environment +<para><code>\makebox</code> is also used within the <code>picture</code> environment <pxref label="_005cmakebox-_0028picture_0029"><xrefnodename>\makebox (picture)</xrefnodename></pxref>. </para> </section> <node name="_005cparbox" spaces=" "><nodename>\parbox</nodename><nodenext automatic="on">\raisebox</nodenext><nodeprev automatic="on">\makebox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\parbox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="693">\parbox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="767">\parbox</indexterm></findex> <para>Synopsis: </para> @@ -6092,7 +8299,8 @@ for this to work. </section> <node name="_005craisebox" spaces=" "><nodename>\raisebox</nodename><nodenext automatic="on">\savebox</nodenext><nodeprev automatic="on">\parbox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\raisebox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="694">\raisebox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="768">\raisebox</indexterm></findex> <para>Synopsis: </para> @@ -6114,7 +8322,8 @@ ignoring its natural height and depth. </section> <node name="_005csavebox" spaces=" "><nodename>\savebox</nodename><nodenext automatic="on">\sbox</nodenext><nodeprev automatic="on">\raisebox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\savebox</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="695">\savebox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="769">\savebox</indexterm></findex> <para>Synopsis: </para> @@ -6131,7 +8340,8 @@ declared with <code>\newsavebox</code> (<pxref label="_005cnewsavebox"><xrefnode </section> <node name="_005csbox" spaces=" "><nodename>\sbox</nodename><nodenext automatic="on">\usebox</nodenext><nodeprev automatic="on">\savebox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\sbox{<var>\boxcmd</var>}{<var>text</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="696">\sbox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="770">\sbox</indexterm></findex> <para>Synopsis: </para> @@ -6149,7 +8359,8 @@ included in the normal output, it is saved in the box labeled </section> <node name="_005cusebox" spaces=" "><nodename>\usebox</nodename><nodeprev automatic="on">\sbox</nodeprev><nodeup automatic="on">Boxes</nodeup></node> <section spaces=" "><sectiontitle><code>\usebox{<var>\boxcmd</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="697">\usebox</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="771">\usebox</indexterm></findex> <para>Synopsis: </para> @@ -6166,6 +8377,9 @@ included in the normal output, it is saved in the box labeled <node name="Special-insertions" spaces=" "><nodename>Special insertions</nodename><nodenext automatic="on">Splitting the input</nodenext><nodeprev automatic="on">Boxes</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Special insertions</sectiontitle> +<cindex index="cp" spaces=" "><indexterm index="cp" number="369">special insertions</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="370">insertions of special characters</indexterm></cindex> + <para>&latex; provides commands for inserting characters that have a special meaning do not correspond to simple characters you can type. </para> @@ -6181,8 +8395,9 @@ special meaning do not correspond to simple characters you can type. <node name="Reserved-characters" spaces=" "><nodename>Reserved characters</nodename><nodenext automatic="on">Text symbols</nodenext><nodeup automatic="on">Special insertions</nodeup></node> <section spaces=" "><sectiontitle>Reserved characters</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="325">reserved characters</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="326">characters, reserved</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="371">reserved characters</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="372">characters, reserved</indexterm></cindex> <para>The following characters play a special role in &latex; and are called &textldquo;reserved characters&textrdquo; or &textldquo;special characters&textrdquo;. @@ -6191,33 +8406,33 @@ special meaning do not correspond to simple characters you can type. <pre xml:space="preserve"># $ % & ~ _ ^ \ { } </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="698">\#</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="699">\$</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="700">\%</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="701">\&</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="702">\_</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="703">\{</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="704">\}</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="772">\#</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="773">\$</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="774">\%</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="775">\&</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="776">\_</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="777">\{</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="778">\}</indexterm></findex> <para>Whenever you write one of these characters into your file, &latex; will do something special. If you simply want the character to be printed as itself, include a <code>\</code> in front of the character. For example, <code>\$</code> will produce <code>$</code> in your output. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="705">\backslash</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="779">\backslash</indexterm></findex> <para>One exception to this rule is <code>\</code> itself, because <code>\\</code> has its own special (context-dependent) meaning. A roman \ is produced by typing <code>$\backslash$</code> in your file, and a typewriter <code>\</code> is produced by using <samp>\</samp> in a verbatim command (<pxref label="verbatim"><xrefnodename>verbatim</xrefnodename></pxref>). </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="706">\~</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="707">\^</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="780">\~</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="781">\^</indexterm></findex> <para>Also, <code>\~</code> and <code>\^</code> place tilde and circumflex accents over the following letter, as in <accent type="tilde">o</accent> and <accent type="circ">o</accent> (<pxref label="Accents"><xrefnodename>Accents</xrefnodename></pxref>); to get a standalone <code>~</code> or <code>^</code>, you can again use a verbatim command. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="708">\symbol</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="327">accessing any character of a font</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="782">\symbol</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="373">accessing any character of a font</indexterm></cindex> <para>Finally, you can access any character of the current font once you know its number by using the <code>\symbol</code> command. For example, the @@ -6233,279 +8448,280 @@ with <code>"</code>, so the previous example could also be written as <node name="Text-symbols" spaces=" "><nodename>Text symbols</nodename><nodenext automatic="on">Accents</nodenext><nodeprev automatic="on">Reserved characters</nodeprev><nodeup automatic="on">Special insertions</nodeup></node> <section spaces=" "><sectiontitle>Text symbols</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="328">text symbols</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="709">textcomp <r>package</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="374">text symbols</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="375">symbols, text</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="783">textcomp <r>package</r></indexterm></findex> <para>&latex; provides commands to generate a number of non-letter symbols in running text. Some of these, especially the more obscure ones, are not available in OT1; you may need to load the <code>textcomp</code> package. </para> <ftable commandarg="code" spaces=" " endspaces=" "> -<beforefirstitem> -</beforefirstitem><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="710">\copyright</indexterm>\copyright</itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="711">\textcopyright</indexterm>\textcopyright</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="329">copyright symbol</indexterm></cindex> +<tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="784">\copyright</indexterm>\copyright</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="785">\textcopyright</indexterm>\textcopyright</itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="376">copyright symbol</indexterm></cindex> <para>The copyright symbol, ©right;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="712">\dag</indexterm>\dag</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="330">dagger, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="786">\dag</indexterm>\dag</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="377">dagger, in text</indexterm></cindex> <para>The dagger symbol (in text). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="713">\ddag</indexterm>\ddag</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="331">double dagger, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="787">\ddag</indexterm>\ddag</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="378">double dagger, in text</indexterm></cindex> <para>The double dagger symbol (in text). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="714">\LaTeX</indexterm>\LaTeX</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="332">&latex; logo</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="333">logo, &latex;</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="788">\LaTeX</indexterm>\LaTeX</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="379">&latex; logo</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="380">logo, &latex;</indexterm></cindex> <para>The &latex; logo. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="715">\LaTeXe</indexterm>\LaTeXe</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="334">&latex;2e logo</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="335">logo, &latex;2e</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="789">\LaTeXe</indexterm>\LaTeXe</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="381">&latex;2e logo</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="382">logo, &latex;2e</indexterm></cindex> <para>The &latex;2e logo. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="716">\guillemotleft <r>(«)</r></indexterm>\guillemotleft <r>(«)</r></itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="717">\guillemotright <r>(»)</r></indexterm>\guillemotright <r>(»)</r></itemformat></itemx> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="718">\guilsinglleft <r>(‹)</r></indexterm>\guilsinglleft <r>(‹)</r></itemformat></itemx> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="719">\guilsinglright <r>(›)</r></indexterm>\guilsinglright <r>(›)</r></itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="336">double guillemets</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="337">single guillemets</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="338">left angle quotation marks</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="339">right angle quotation marks</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="340">double angle quotation marks</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="341">single angle quotation marks</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="342">French quotation marks</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="343">quotation marks, French</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="790">\guillemotleft <r>(«)</r></indexterm>\guillemotleft <r>(«)</r></itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="791">\guillemotright <r>(»)</r></indexterm>\guillemotright <r>(»)</r></itemformat></itemx> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="792">\guilsinglleft <r>(‹)</r></indexterm>\guilsinglleft <r>(‹)</r></itemformat></itemx> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="793">\guilsinglright <r>(›)</r></indexterm>\guilsinglright <r>(›)</r></itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="383">double guillemets</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="384">single guillemets</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="385">left angle quotation marks</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="386">right angle quotation marks</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="387">double angle quotation marks</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="388">single angle quotation marks</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="389">French quotation marks</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="390">quotation marks, French</indexterm></cindex> <para>Double and single angle quotation marks, commonly used in French: «, », ‹, ›. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="720">\ldots</indexterm>\ldots</itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="721">\dots</indexterm>\dots</itemformat></itemx> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="722">\textellipsis</indexterm>\textellipsis</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="344">ellipsis</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="794">\ldots</indexterm>\ldots</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="795">\dots</indexterm>\dots</itemformat></itemx> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="796">\textellipsis</indexterm>\textellipsis</itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="391">ellipsis</indexterm></cindex> <para>An ellipsis (three dots at the baseline): &textlsquo;&dots;&textrsquo;. <code>\ldots</code> and <code>\dots</code> also work in math mode. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="723">\lq</indexterm>\lq</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="345">left quote</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="346">opening quote</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="797">\lq</indexterm>\lq</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="392">left quote</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="393">opening quote</indexterm></cindex> <para>Left (opening) quote: &textlsquo;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="724">\P</indexterm>\P</itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="725">\textparagraph</indexterm>\textparagraph</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="347">paragraph symbol</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="348">pilcrow</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="798">\P</indexterm>\P</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="799">\textparagraph</indexterm>\textparagraph</itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="394">paragraph symbol</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="395">pilcrow</indexterm></cindex> <para>Paragraph sign (pilcrow). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="726">\pounds</indexterm>\pounds</itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="727">\textsterling</indexterm>\textsterling</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="349">pounds symbol</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="350">sterling symbol</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="800">\pounds</indexterm>\pounds</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="801">\textsterling</indexterm>\textsterling</itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="396">pounds symbol</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="397">sterling symbol</indexterm></cindex> <para>English pounds sterling: £. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="728">\quotedblbase <r>(„)</r></indexterm>\quotedblbase <r>(„)</r></itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="729">\quotesinglbase <r>(‚)</r></indexterm>\quotesinglbase <r>(‚)</r></itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="351">double low-9 quotation mark</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="352">single low-9 quotation mark</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="353">low-9 quotation marks, single and double</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="802">\quotedblbase <r>(„)</r></indexterm>\quotedblbase <r>(„)</r></itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="803">\quotesinglbase <r>(‚)</r></indexterm>\quotesinglbase <r>(‚)</r></itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="398">double low-9 quotation mark</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="399">single low-9 quotation mark</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="400">low-9 quotation marks, single and double</indexterm></cindex> <para>Double and single quotation marks on the baseline: „ and ‚. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="730">\rq</indexterm>\rq</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="354">right quote</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="355">closing quote</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="804">\rq</indexterm>\rq</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="401">right quote</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="402">closing quote</indexterm></cindex> <para>Right (closing) quote: &textrsquo;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="731">\S</indexterm>\S</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="356">section symbol</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="805">\S</indexterm>\S</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="403">section symbol</indexterm></cindex> <para>Section symbol. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="732">\TeX</indexterm>\TeX</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="357">&tex; logo</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="358">logo, &tex;</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="806">\TeX</indexterm>\TeX</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="404">&tex; logo</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="405">logo, &tex;</indexterm></cindex> <para>The &tex; logo. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="733">\textasciicircum</indexterm>\textasciicircum</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="359">circumflex, ASCII, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="360">ASCII circumflex, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="807">\textasciicircum</indexterm>\textasciicircum</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="406">circumflex, ASCII, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="407">ASCII circumflex, in text</indexterm></cindex> <para>ASCII circumflex: ^. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="734">\textasciitilde</indexterm>\textasciitilde</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="361">tilde, ASCII, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="362">ASCII tilde, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="808">\textasciitilde</indexterm>\textasciitilde</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="408">tilde, ASCII, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="409">ASCII tilde, in text</indexterm></cindex> <para>ASCII tilde: ~. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="735">\textasteriskcentered</indexterm>\textasteriskcentered</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="363">asterisk, centered, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="364">centered asterisk, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="809">\textasteriskcentered</indexterm>\textasteriskcentered</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="410">asterisk, centered, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="411">centered asterisk, in text</indexterm></cindex> <para>Centered asterisk: *. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="736">\textbackslash</indexterm>\textbackslash</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="365">backslash, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="810">\textbackslash</indexterm>\textbackslash</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="412">backslash, in text</indexterm></cindex> <para>Backslash: \. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="737">\textbar</indexterm>\textbar</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="366">vertical bar, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="367">bar, vertical, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="811">\textbar</indexterm>\textbar</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="413">vertical bar, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="414">bar, vertical, in text</indexterm></cindex> <para>Vertical bar: |. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="738">\textbardbl</indexterm>\textbardbl</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="368">vertical bar, double, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="369">bar, double vertical, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="370">double vertical bar, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="812">\textbardbl</indexterm>\textbardbl</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="415">vertical bar, double, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="416">bar, double vertical, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="417">double vertical bar, in text</indexterm></cindex> <para>Double vertical bar. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="739">\textbigcircle</indexterm>\textbigcircle</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="371">big circle symbols, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="372">circle symbol, big, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="813">\textbigcircle</indexterm>\textbigcircle</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="418">big circle symbols, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="419">circle symbol, big, in text</indexterm></cindex> <para>Big circle symbol. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="740">\textbraceleft</indexterm>\textbraceleft</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="373">left brace, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="374">brace, left, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="814">\textbraceleft</indexterm>\textbraceleft</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="420">left brace, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="421">brace, left, in text</indexterm></cindex> <para>Left brace: {. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="741">\textbraceright</indexterm>\textbraceright</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="375">right brace, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="376">brace, right, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="815">\textbraceright</indexterm>\textbraceright</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="422">right brace, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="423">brace, right, in text</indexterm></cindex> <para>Right brace: }. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="742">\textbullet</indexterm>\textbullet</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="377">bullet, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="816">\textbullet</indexterm>\textbullet</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="424">bullet, in text</indexterm></cindex> <para>Bullet: •. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="743">\textcircled{<var>letter</var>}</indexterm>\textcircled{<var>letter</var>}</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="378">circled letter, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="817">\textcircled{<var>letter</var>}</indexterm>\textcircled{<var>letter</var>}</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="425">circled letter, in text</indexterm></cindex> <para><var>letter</var> in a circle, as in ®istered;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="744">\textcompwordmark</indexterm>\textcompwordmark</itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="745">\textcapitalwordmark</indexterm>\textcapitalwordmark</itemformat></itemx> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="746">\textascenderwordmark</indexterm>\textascenderwordmark</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="379">composite word mark, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="380">cap height</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="381">ascender height</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="818">\textcompwordmark</indexterm>\textcompwordmark</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="819">\textcapitalwordmark</indexterm>\textcapitalwordmark</itemformat></itemx> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="820">\textascenderwordmark</indexterm>\textascenderwordmark</itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="426">composite word mark, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="427">cap height</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="428">ascender height</indexterm></cindex> <para>Composite word mark (invisible). The <code>\textcapital...</code> form has the cap height of the font, while the <code>\textascender...</code> form has the ascender height. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="747">\textdagger</indexterm>\textdagger</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="382">dagger, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="821">\textdagger</indexterm>\textdagger</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="429">dagger, in text</indexterm></cindex> <para>Dagger: <math>\dag</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="748">\textdaggerdbl</indexterm>\textdaggerdbl</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="383">dagger, double, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="384">double dagger, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="822">\textdaggerdbl</indexterm>\textdaggerdbl</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="430">dagger, double, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="431">double dagger, in text</indexterm></cindex> <para>Double dagger: <math>\ddag</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="749">\textdollar <r>(or <code>$</code>)</r></indexterm>\textdollar <r>(or <code>$</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="385">dollar sign</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="386">currency, dollar</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="823">\textdollar <r>(or <code>$</code>)</r></indexterm>\textdollar <r>(or <code>$</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="432">dollar sign</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="433">currency, dollar</indexterm></cindex> <para>Dollar sign: $. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="750">\textemdash <r>(or <code>---</code>)</r></indexterm>\textemdash <r>(or <code>---</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="387">em-dash</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="824">\textemdash <r>(or <code>---</code>)</r></indexterm>\textemdash <r>(or <code>---</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="434">em-dash</indexterm></cindex> <para>Em-dash: &textmdash; (for punctuation). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="751">\textendash <r>(or <code>--</code>)</r></indexterm>\textendash <r>(or <code>--</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="388">e-dash</indexterm></cindex> -<para>En-dash: &textmdash; (for ranges). +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="825">\textendash <r>(or <code>--</code>)</r></indexterm>\textendash <r>(or <code>--</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="435">e-dash</indexterm></cindex> +<para>En-dash: &textndash; (for ranges). </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="752">\texteuro</indexterm>\texteuro</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="389">euro symbol</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="390">currency, euro</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="826">\texteuro</indexterm>\texteuro</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="436">euro symbol</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="437">currency, euro</indexterm></cindex> <para>The Euro symbol: €. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="753">\textexclamdown <r>(or <code>!`</code>)</r></indexterm>\textexclamdown <r>(or <code>!`</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="391">exclamation point, upside-down</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="827">\textexclamdown <r>(or <code>!`</code>)</r></indexterm>\textexclamdown <r>(or <code>!`</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="438">exclamation point, upside-down</indexterm></cindex> <para>Upside down exclamation point: ¡. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="754">\textgreater</indexterm>\textgreater</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="392">greater than symbol, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="828">\textgreater</indexterm>\textgreater</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="439">greater than symbol, in text</indexterm></cindex> <para>Greater than: >. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="755">\textless</indexterm>\textless</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="393">less than symbol, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="829">\textless</indexterm>\textless</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="440">less than symbol, in text</indexterm></cindex> <para>Less than: <. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="756">\textleftarrow</indexterm>\textleftarrow</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="394">arrow, left, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="395">left arrow, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="830">\textleftarrow</indexterm>\textleftarrow</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="441">arrow, left, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="442">left arrow, in text</indexterm></cindex> <para>Left arrow. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="757">\textordfeminine</indexterm>\textordfeminine</itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="758">\textordmasculine</indexterm>\textordmasculine</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="396">feminine ordinal symbol</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="397">masculine ordinal symbol</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="398">ordinals, feminine and masculine</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="399">Spanish ordinals, feminine and masculine</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="831">\textordfeminine</indexterm>\textordfeminine</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="832">\textordmasculine</indexterm>\textordmasculine</itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="443">feminine ordinal symbol</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="444">masculine ordinal symbol</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="445">ordinals, feminine and masculine</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="446">Spanish ordinals, feminine and masculine</indexterm></cindex> <para>Feminine and masculine ordinal symbols: ª, º. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="759">\textperiodcentered</indexterm>\textperiodcentered</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="400">period, centered, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="401">centered period, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="833">\textperiodcentered</indexterm>\textperiodcentered</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="447">period, centered, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="448">centered period, in text</indexterm></cindex> <para>Centered period: <math>\cdot</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="760">\textquestiondown <r>(or <code>?`</code>)</r></indexterm>\textquestiondown <r>(or <code>?`</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="402">question mark, upside-down</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="834">\textquestiondown <r>(or <code>?`</code>)</r></indexterm>\textquestiondown <r>(or <code>?`</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="449">question mark, upside-down</indexterm></cindex> <para>Upside down question mark: ¿. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="761">\textquotedblleft <r>(or <code>``</code>)</r></indexterm>\textquotedblleft <r>(or <code>``</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="403">left quote, double</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="404">double left quote</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="835">\textquotedblleft <r>(or <code>``</code>)</r></indexterm>\textquotedblleft <r>(or <code>``</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="450">left quote, double</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="451">double left quote</indexterm></cindex> <para>Double left quote: &textldquo;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="762">\textquotedblright <r>(or <code>'</code>)</r></indexterm>\textquotedblright <r>(or <code>'</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="405">right quote, double</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="406">double right quote</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="836">\textquotedblright <r>(or <code>'</code>)</r></indexterm>\textquotedblright <r>(or <code>'</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="452">right quote, double</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="453">double right quote</indexterm></cindex> <para>Double right quote: &textrdquo;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="763">\textquoteleft <r>(or <code>`</code>)</r></indexterm>\textquoteleft <r>(or <code>`</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="407">left quote, single</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="408">single left quote</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="837">\textquoteleft <r>(or <code>`</code>)</r></indexterm>\textquoteleft <r>(or <code>`</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="454">left quote, single</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="455">single left quote</indexterm></cindex> <para>Single left quote: &textlsquo;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="764">\textquoteright <r>(or <code>'</code>)</r></indexterm>\textquoteright <r>(or <code>'</code>)</r></itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="409">right quote, single</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="410">single right quote</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="838">\textquoteright <r>(or <code>'</code>)</r></indexterm>\textquoteright <r>(or <code>'</code>)</r></itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="456">right quote, single</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="457">single right quote</indexterm></cindex> <para>Single right quote: &textrsquo;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="765">\textquotestraightbase</indexterm>\textquotestraightbase</itemformat></item> -<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="766">\textquotestraightdblbase</indexterm>\textquotestraightdblbase</itemformat></itemx> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="411">quote, straight base</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="412">straight quote, base</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="413">double quote, straight base</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="414">straight double quote, base</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="839">\textquotestraightbase</indexterm>\textquotestraightbase</itemformat></item> +<itemx spaces=" "><itemformat command="code"><indexterm index="fn" number="840">\textquotestraightdblbase</indexterm>\textquotestraightdblbase</itemformat></itemx> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="458">quote, straight base</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="459">straight quote, base</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="460">double quote, straight base</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="461">straight double quote, base</indexterm></cindex> <para>Single and double straight quotes on the baseline. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="767">\textregistered</indexterm>\textregistered</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="415">registered symbol</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="841">\textregistered</indexterm>\textregistered</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="462">registered symbol</indexterm></cindex> <para>Registered symbol: ®istered;. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="768">\textrightarrow</indexterm>\textrightarrow</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="416">arrow, right, in text</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="417">right arrow, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="842">\textrightarrow</indexterm>\textrightarrow</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="463">arrow, right, in text</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="464">right arrow, in text</indexterm></cindex> <para>Right arrow. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="769">\textthreequartersemdash</indexterm>\textthreequartersemdash</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="418">three-quarters em-dash</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="419">em-dash, three-quarters</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="843">\textthreequartersemdash</indexterm>\textthreequartersemdash</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="465">three-quarters em-dash</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="466">em-dash, three-quarters</indexterm></cindex> <para>&textldquo;Three-quarters&textrdquo; em-dash, between en-dash and em-dash. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="770">\texttrademark</indexterm>\texttrademark</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="420">trademark symbol</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="844">\texttrademark</indexterm>\texttrademark</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="467">trademark symbol</indexterm></cindex> <para>Trademark symbol: <math>^{\hbox{TM}}</math>. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="771">\texttwelveudash</indexterm>\texttwelveudash</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="421">two-thirds em-dash</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="422">em-dash, two-thirds</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="845">\texttwelveudash</indexterm>\texttwelveudash</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="468">two-thirds em-dash</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="469">em-dash, two-thirds</indexterm></cindex> <para>&textldquo;Two-thirds&textrdquo; em-dash, between en-dash and em-dash. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="772">\textunderscore</indexterm>\textunderscore</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="423">underscore, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="846">\textunderscore</indexterm>\textunderscore</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="470">underscore, in text</indexterm></cindex> <para>Underscore: _. </para> -</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="773">\textvisiblespace</indexterm>\textvisiblespace</itemformat></item> -</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="424">visible space symbol, in text</indexterm></cindex> +</tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code"><indexterm index="fn" number="847">\textvisiblespace</indexterm>\textvisiblespace</itemformat></item> +</tableterm><tableitem><cindex index="cp" spaces=" "><indexterm index="cp" number="471">visible space symbol, in text</indexterm></cindex> <para>Visible space symbol. </para> </tableitem></tableentry></ftable> @@ -6515,12 +8731,12 @@ has the ascender height. <node name="Accents" spaces=" "><nodename>Accents</nodename><nodenext automatic="on">Non-English characters</nodenext><nodeprev automatic="on">Text symbols</nodeprev><nodeup automatic="on">Special insertions</nodeup></node> <section spaces=" "><sectiontitle>Accents</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="425">accents</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="426">characters, accented</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="427">letters, accented</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="472">accents</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="473">characters, accented</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="474">letters, accented</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="428"><code>babel</code> package</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="429">multilingual support</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="475"><code>babel</code> package</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="476">multilingual support</indexterm></cindex> <para>&latex; has wide support for many of the world&textrsquo;s scripts and languages, through the <code>babel</code> package and related support. This section does not attempt to cover all that support. It merely lists @@ -6532,145 +8748,147 @@ capital letters. These are not available with OT1. <table commandarg="code" spaces=" " endspaces=" "> <tableentry><tableterm><item spaces=" "><itemformat command="code">\"</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitaldieresis</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="774">\" <r>(umlaut accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="775">\capitaldieresis</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="430">umlaut accent</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="431">dieresis accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="848">\" <r>(umlaut accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="849">\capitaldieresis</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="477">umlaut accent</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="478">dieresis accent</indexterm></cindex> <para>Produces an umlaut (dieresis), as in <accent type="uml">o</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\'</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalacute</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="776">\&textrsquo; <r>(acute accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="777">\capitalacute</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="432">acute accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="850">\&textrsquo; <r>(acute accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="851">\capitalacute</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="479">acute accent</indexterm></cindex> <para>Produces an acute accent, as in <accent type="acute">o</accent>. In the <code>tabbing</code> environment, pushes current column to the right of the previous column (<pxref label="tabbing"><xrefnodename>tabbing</xrefnodename></pxref>). </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\.</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="778">\. <r>(dot-over accent)</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="433">dot accent</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="434">dot-over accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="852">\. <r>(dot-over accent)</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="480">dot accent</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="481">dot-over accent</indexterm></cindex> <para>Produces a dot accent over the following, as in <accent type="dotaccent">o</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\=</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalmacron</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="779">\= <r>(macron accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="780">\capitalmacron</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="435">macron accent</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="436">overbar accent</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="437">bar-over accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="853">\= <r>(macron accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="854">\capitalmacron</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="482">macron accent</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="483">overbar accent</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="484">bar-over accent</indexterm></cindex> <para>Produces a macron (overbar) accent over the following, as in <accent type="macr">o</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\^</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalcircumflex</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="781">\^ <r>(circumflex accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="782">\capitalcircumflex</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="438">circumflex accent</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="439">hat accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="855">\^ <r>(circumflex accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="856">\capitalcircumflex</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="485">circumflex accent</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="486">hat accent</indexterm></cindex> <para>Produces a circumflex (hat) accent over the following, as in <accent type="circ">o</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\`</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalgrave</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="783">\&textlsquo; <r>(grave accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="784">\capitalgrave</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="440">grave accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="857">\&textlsquo; <r>(grave accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="858">\capitalgrave</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="487">grave accent</indexterm></cindex> <para>Produces a grave accent over the following, as in <accent type="grave">o</accent>. In the <code>tabbing</code> environment, move following text to the right margin (<pxref label="tabbing"><xrefnodename>tabbing</xrefnodename></pxref>). </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\~</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitaltilde</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="785">\~ <r>(tilde accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="786">\capitaltilde</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="441">tilde accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="859">\~ <r>(tilde accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="860">\capitaltilde</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="488">tilde accent</indexterm></cindex> <para>Produces a tilde accent over the following, as in <accent type="tilde">n</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\b</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="787">\b <r>(bar-under accent)</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="442">bar-under accent</indexterm></cindex> -<para>Produces a bar accent under the following, as in <accent type="ubaraccent">o</accent>. +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="861">\b <r>(bar-under accent)</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="489">bar-under accent</indexterm></cindex> +<para>Produces a bar accent under the following, as in <accent type="ubaraccent">o</accent>. See +also <code>\underbar</code> hereinafter. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\c</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalcedilla</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="788">\c <r>(cedilla accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="789">\capitalcedilla</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="443">cedilla accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="862">\c <r>(cedilla accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="863">\capitalcedilla</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="490">cedilla accent</indexterm></cindex> <para>Produces a cedilla accent under the following, as in <accent type="cedil">c</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\d</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitaldotaccent</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="790">\d <r>(dot-under accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="791">\capitaldotaccent</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="444">dot-under accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="864">\d <r>(dot-under accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="865">\capitaldotaccent</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="491">dot-under accent</indexterm></cindex> <para>Produces a dot accent under the following, as in <accent type="udotaccent">o</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\H</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalhungarumlaut</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="792">\H <r>(Hungarian umlaut accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="793">\capitalhungarumlaut</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="445">hungarian umlaut accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="866">\H <r>(Hungarian umlaut accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="867">\capitalhungarumlaut</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="492">hungarian umlaut accent</indexterm></cindex> <para>Produces a long Hungarian umlaut accent over the following, as in <accent type="doubleacute">o</accent>. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\i</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="794">\i <r>(dotless i)</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="446">dotless i</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="868">\i <r>(dotless i)</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="493">dotless i</indexterm></cindex> <para>Produces a dotless i, as in &textlsquo;<dotless>i</dotless>&textrsquo;. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\j</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="795">\j <r>(dotless j)</r></indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="447">dotless j</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="869">\j <r>(dotless j)</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="494">dotless j</indexterm></cindex> <para>Produces a dotless j, as in &textlsquo;<dotless>j</dotless>&textrsquo;. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\k</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalogonek</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="796">\k <r>(ogonek)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="797">\capitalogonek</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="448">ogonek</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="870">\k <r>(ogonek)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="871">\capitalogonek</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="495">ogonek</indexterm></cindex> <para>Produces a letter with ogonek, as in &textlsquo;<accent type="ogon">o</accent>&textrsquo;. Not available in the OT1 encoding. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\r</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalring</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="798">\r <r>(ring accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="799">\capitalring</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="449">ring accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="872">\r <r>(ring accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="873">\capitalring</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="496">ring accent</indexterm></cindex> <para>Produces a ring accent, as in &textlsquo;<accent type="ring">o</accent>&textrsquo;. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\t</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitaltie</itemformat></itemx> <itemx spaces=" "><itemformat command="code">\newtie</itemformat></itemx> <itemx spaces=" "><itemformat command="code">\capitalnewtie</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="800">\t <r>(tie-after accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="801">\capitaltie</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="802">\newtie</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="803">\capitalnewtie</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="450">tie-after accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="874">\t <r>(tie-after accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="875">\capitaltie</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="876">\newtie</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="877">\capitalnewtie</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="497">tie-after accent</indexterm></cindex> <para>Produces a tie-after accent, as in &textlsquo;<accent type="tieaccent">oo</accent>&textrsquo;. The <code>\newtie</code> form is centered in its box. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\u</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalbreve</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="804">\u <r>(breve accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="805">\capitalbreve</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="451">breve accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="878">\u <r>(breve accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="879">\capitalbreve</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="498">breve accent</indexterm></cindex> <para>Produces a breve accent, as in &textlsquo;<accent type="breve">o</accent>&textrsquo;. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\underbar</itemformat></item> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="806">\underbar</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="452">underbar</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="880">\underbar</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="499">underbar</indexterm></cindex> <para>Not exactly an accent, this produces a bar under the argument text. The argument is always processed in horizontal mode. The bar is always a fixed position under the baseline, thus crossing through descenders. See also <code>\underline</code> in <ref label="Math-miscellany"><xrefnodename>Math miscellany</xrefnodename></ref>. +See also <code>\b</code> above. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\v</itemformat></item> <itemx spaces=" "><itemformat command="code">\capitalcaron</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="807">\v <r>(breve accent)</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="808">\capitalcaron</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="453">hacek accent</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="454">check accent</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="455">caron accent</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="881">\v <r>(breve accent)</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="882">\capitalcaron</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="500">hacek accent</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="501">check accent</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="502">caron accent</indexterm></cindex> <para>Produces a h<accent type="acute" bracketed="off">a</accent><accent type="caron">c</accent>ek (check, caron) accent, as in &textlsquo;<accent type="caron">o</accent>&textrsquo;. </para> </tableitem></tableentry></table> @@ -6680,92 +8898,91 @@ descenders. See also <code>\underline</code> in <ref label="Math-miscellany"><x <node name="Non_002dEnglish-characters" spaces=" "><nodename>Non-English characters</nodename><nodenext automatic="on">\rule</nodenext><nodeprev automatic="on">Accents</nodeprev><nodeup automatic="on">Special insertions</nodeup></node> <section spaces=" "><sectiontitle>Non-English characters</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="456">special characters</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="457">non-English characters</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="458">characters, non-English</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="459">letters, non-English</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="503">special characters</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="504">non-English characters</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="505">characters, non-English</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="506">letters, non-English</indexterm></cindex> <para>Here are the basic &latex; commands for inserting characters commonly used in languages other than English. </para> <table commandarg="code" spaces=" " endspaces=" "> -<beforefirstitem> -</beforefirstitem><tableentry><tableterm><item spaces=" "><itemformat command="code">\aa</itemformat></item> +<tableentry><tableterm><item spaces=" "><itemformat command="code">\aa</itemformat></item> <itemx spaces=" "><itemformat command="code">\AA</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="809">\aa (å)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="810">\AA (Å)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="460">aring</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="883">\aa (å)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="884">\AA (Å)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="507">aring</indexterm></cindex> <para>å and Å. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\ae</itemformat></item> <itemx spaces=" "><itemformat command="code">\AE</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="811">\ae (æ)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="812">\AE (Æ)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="461">ae ligature</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="885">\ae (æ)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="886">\AE (Æ)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="508">ae ligature</indexterm></cindex> <para>æ and Æ. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\dh</itemformat></item> <itemx spaces=" "><itemformat command="code">\DH</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="813">\dh (ð)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="814">\DH (Ð)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="462">Icelandic eth</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="463">eth, Icelandic letter</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="887">\dh (ð)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="888">\DH (Ð)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="509">Icelandic eth</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="510">eth, Icelandic letter</indexterm></cindex> <para>Icelandic letter eth: ð and Ð. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\dj</itemformat></item> <itemx spaces=" "><itemformat command="code">\DJ</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="815">\dj</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="816">\DJ</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="889">\dj</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="890">\DJ</indexterm></findex> <para>Crossed d and D, a.k.a.&noeos; capital and small letter d with stroke. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\ij</itemformat></item> <itemx spaces=" "><itemformat command="code">\IJ</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="817">\ij (ij)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="818">\IJ (IJ)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="464">ij letter, Dutch</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="891">\ij (ij)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="892">\IJ (IJ)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="511">ij letter, Dutch</indexterm></cindex> <para>ij and IJ (except somewhat closer together than appears here). </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\l</itemformat></item> <itemx spaces=" "><itemformat command="code">\L</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="819">\l (&lslash;)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="820">\L (&Lslash;)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="465">polish l</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="893">\l (&lslash;)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="894">\L (&Lslash;)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="512">polish l</indexterm></cindex> <para>&lslash; and &Lslash;. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\ng</itemformat></item> <itemx spaces=" "><itemformat command="code">\NG</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="821">\ng</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="822">\NG</indexterm></findex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="895">\ng</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="896">\NG</indexterm></findex> <para>Latin letter eng, also used in phonetics. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\o</itemformat></item> <itemx spaces=" "><itemformat command="code">\O</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="823">\o (ø)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="824">\O (Ø)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="466">oslash</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="897">\o (ø)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="898">\O (Ø)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="513">oslash</indexterm></cindex> <para>ø and Ø. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\oe</itemformat></item> <itemx spaces=" "><itemformat command="code">\OE</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="825">\oe (œ)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="826">\OE (Œ)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="467">oe ligature</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="899">\oe (œ)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="900">\OE (Œ)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="514">oe ligature</indexterm></cindex> <para>œ and Œ. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\ss</itemformat></item> <itemx spaces=" "><itemformat command="code">\SS</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="827">\ss (ß)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="828">\SS (SS)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="468">es-zet German letter</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="469">sharp S letters</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="901">\ss (ß)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="902">\SS (SS)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="515">es-zet German letter</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="516">sharp S letters</indexterm></cindex> <para>ß and SS. </para> </tableitem></tableentry><tableentry><tableterm><item spaces=" "><itemformat command="code">\th</itemformat></item> <itemx spaces=" "><itemformat command="code">\TH</itemformat></itemx> -</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="829">\th (þ)</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="830">\TH (Þ)</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="470">Icelandic thorn</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="471">thorn, Icelandic letter</indexterm></cindex> +</tableterm><tableitem><findex index="fn" spaces=" "><indexterm index="fn" number="903">\th (þ)</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="904">\TH (Þ)</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="517">Icelandic thorn</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="518">thorn, Icelandic letter</indexterm></cindex> <para>Icelandic letter thorn: þ and Þ. </para> </tableitem></tableentry></table> @@ -6774,7 +8991,8 @@ used in languages other than English. </section> <node name="_005crule" spaces=" "><nodename>\rule</nodename><nodenext automatic="on">\today</nodenext><nodeprev automatic="on">Non-English characters</nodeprev><nodeup automatic="on">Special insertions</nodeup></node> <section spaces=" "><sectiontitle><code>\rule</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="831">\rule</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="905">\rule</indexterm></findex> <para>Synopsis: </para> @@ -6800,7 +9018,9 @@ rectangles. The arguments are: </section> <node name="_005ctoday" spaces=" "><nodename>\today</nodename><nodeprev automatic="on">\rule</nodeprev><nodeup automatic="on">Special insertions</nodeup></node> <section spaces=" "><sectiontitle><code>\today</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="832">\today</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="906">\today</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="519">date, today&textrsquo;s</indexterm></cindex> <para>The <code>\today</code> command produces today&textrsquo;s date, in the format <samp><var>month</var> <var>dd</var>, <var>yyyy</var></samp>; for example, &textlsquo;July 4, 1976&textrsquo;. @@ -6808,7 +9028,7 @@ It uses the predefined counters <code>\day</code>, <code>\month</code>, and <code>\year</code> (<pxref label="_005cday-_005cmonth-_005cyear"><xrefnodename>\day \month \year</xrefnodename></pxref>) to do this. It is not updated as the program runs. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="472"><code>datetime</code> package</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="520"><code>datetime</code> package</indexterm></cindex> <para>The <code>datetime</code> package, among others, can produce a wide variety of other date formats. </para> @@ -6817,8 +9037,9 @@ of other date formats. </chapter> <node name="Splitting-the-input" spaces=" "><nodename>Splitting the input</nodename><nodenext automatic="on">Front/back matter</nodenext><nodeprev automatic="on">Special insertions</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Splitting the input</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="473">splitting the input file</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="474">input file</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="521">splitting the input file</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="522">input file</indexterm></cindex> <para>A large document requires a lot of input. Rather than putting the whole input in a single large file, it&textrsquo;s more efficient to split it into @@ -6838,7 +9059,8 @@ external file to be created with the main document. <node name="_005cinclude" spaces=" "><nodename>\include</nodename><nodenext automatic="on">\includeonly</nodenext><nodeup automatic="on">Splitting the input</nodeup></node> <section spaces=" "><sectiontitle><code>\include</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="833">\include</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="907">\include</indexterm></findex> <para>Synopsis: </para> @@ -6855,7 +9077,7 @@ command executes <code>\clearpage</code> to start a new page only run if <var>file</var> is listed as an argument to <code>\includeonly</code>. See the next section. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="475">nested <code>\include</code>, not allowed</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="523">nested <code>\include</code>, not allowed</indexterm></cindex> <para>The <code>\include</code> command may not appear in the preamble or in a file read by another <code>\include</code> command. </para> @@ -6863,7 +9085,8 @@ read by another <code>\include</code> command. </section> <node name="_005cincludeonly" spaces=" "><nodename>\includeonly</nodename><nodenext automatic="on">\input</nodenext><nodeprev automatic="on">\include</nodeprev><nodeup automatic="on">Splitting the input</nodeup></node> <section spaces=" "><sectiontitle>\<code>includeonly</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="834">\includeonly</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="908">\includeonly</indexterm></findex> <para>Synopsis: </para> @@ -6882,8 +9105,9 @@ effective. </section> <node name="_005cinput" spaces=" "><nodename>\input</nodename><nodeprev automatic="on">\includeonly</nodeprev><nodeup automatic="on">Splitting the input</nodeup></node> -<section spaces=" "><sectiontitle>\input</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="835">\input</indexterm></findex> +<section spaces=" "><sectiontitle><code>\input</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="909">\input</indexterm></findex> <para>Synopsis: </para> @@ -6900,6 +9124,7 @@ file at that point. or <samp>foo.bar.tex</samp>). If that is not found, the original <var>file</var> is tried (<samp>foo</samp> or <samp>foo.bar</samp>). </para> + </section> </chapter> <node name="Front_002fback-matter" spaces=" "><nodename>Front/back matter</nodename><nodenext automatic="on">Letters</nodenext><nodeprev automatic="on">Splitting the input</nodeprev><nodeup automatic="on">Top</nodeup></node> @@ -6915,10 +9140,10 @@ is tried (<samp>foo</samp> or <samp>foo.bar</samp>). <node name="Tables-of-contents" spaces=" "><nodename>Tables of contents</nodename><nodenext automatic="on">Glossaries</nodenext><nodeup automatic="on">Front/back matter</nodeup></node> <section spaces=" "><sectiontitle>Tables of contents</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="476">table of contents, creating</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="524">table of contents, creating</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="836">\tableofcontents</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="837">.toc <r>file</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="910">\tableofcontents</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="911">.toc <r>file</r></indexterm></findex> <para>A table of contents is produced with the <code>\tableofcontents</code> command. You put the command right where you want the table of contents to go; &latex; does the rest for you. A previous run must @@ -6929,16 +9154,16 @@ not automatically start a new page. If you want a new page after the table of contents, write a <code>\newpage</code> command after the <code>\tableofcontents</code> command. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="838">\listoffigures</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="839">\listoftables</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="840">.lof <r>file</r></indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="841">.lot <r>file</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="912">\listoffigures</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="913">\listoftables</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="914">.lof <r>file</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="915">.lot <r>file</r></indexterm></findex> <para>The analogous commands <code>\listoffigures</code> and <code>\listoftables</code> produce a list of figures and a list of tables (from <file>.lof</file> and <file>.lot</file> files), respectively. Everything works exactly the same as for the table of contents. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="842">\nofiles</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="916">\nofiles</indexterm></findex> <para>The command <code>\nofiles</code> overrides these commands, and <emph>prevents</emph> any of these lists from being generated. </para> @@ -6949,9 +9174,10 @@ as for the table of contents. <node name="_005caddcontentsline" spaces=" "><nodename>\addcontentsline</nodename><nodenext automatic="on">\addtocontents</nodenext><nodeup automatic="on">Tables of contents</nodeup></node> -<subsection spaces=" "><sectiontitle>\addcontentsline</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="843">\addcontentsline{<var>ext</var>}{<var>unit</var>}{<var>text</var>}</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="477">table of contents entry, manually adding</indexterm></cindex> +<subsection spaces=" "><sectiontitle><code>\addcontentsline</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="917">\addcontentsline{<var>ext</var>}{<var>unit</var>}{<var>text</var>}</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="525">table of contents entry, manually adding</indexterm></cindex> <para>The <code>\addcontentsline</code>{<var>ext</var>}{<var>unit</var>}{<var>text</var>} command adds an entry to the specified list or table where: @@ -6980,7 +9206,7 @@ following, matching the value of the <var>ext</var> argument: </tableterm><tableitem><para>The text of the entry. </para></tableitem></tableentry></table> -<findex index="fn" spaces=" "><indexterm index="fn" number="844">\contentsline</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="918">\contentsline</indexterm></findex> <para>What is written to the <file>.<var>ext</var></file> file is the command <code>\contentsline{<var>unit</var>}{<var>name</var>}</code>. </para> @@ -6989,8 +9215,9 @@ command <code>\contentsline{<var>unit</var>}{<var>name</var </subsection> <node name="_005caddtocontents" spaces=" "><nodename>\addtocontents</nodename><nodeprev automatic="on">\addcontentsline</nodeprev><nodeup automatic="on">Tables of contents</nodeup></node> -<subsection spaces=" "><sectiontitle>\addtocontents</sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="845">\addtocontents{<var>ext</var>}{<var>text</var>}</indexterm></findex> +<subsection spaces=" "><sectiontitle><code>\addtocontents</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="919">\addtocontents{<var>ext</var>}{<var>text</var>}</indexterm></findex> <para>The <code>\addtocontents</code>{<var>ext</var>}{<var>text</var>} command adds text (or formatting commands) directly to the <file>.<var>ext</var></file> file that @@ -7011,22 +9238,23 @@ figures), or <file>lot</file> (list of tables). </section> <node name="Glossaries" spaces=" "><nodename>Glossaries</nodename><nodenext automatic="on">Indexes</nodenext><nodeprev automatic="on">Tables of contents</nodeprev><nodeup automatic="on">Front/back matter</nodeup></node> <section spaces=" "><sectiontitle>Glossaries</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="478">glossaries</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="846">\makeglossary</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="526">glossaries</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="920">\makeglossary</indexterm></findex> <para>The command <code>\makeglossary</code> enables creating glossaries. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="847">\glossary</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="479"><file>.glo</file> file</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="921">\glossary</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="527"><file>.glo</file> file</indexterm></cindex> <para>The command <code>\glossary{<var>text</var>}</code> writes a glossary entry for <var>text</var> to an auxiliary file with the <file>.glo</file> extension. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="848">\glossaryentry</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="922">\glossaryentry</indexterm></findex> <para>Specifically, what gets written is the command <code>\glossaryentry{<var>text</var>}{<var>pageno</var>}</code>, where <var>pageno</var> is the current <code>\thepage</code> value. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="480">glossary <r>package</r></indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="528">glossary <r>package</r></indexterm></cindex> <para>The <code>glossary</code> package on CTAN provides support for fancier glossaries. </para> @@ -7034,37 +9262,38 @@ glossaries. </section> <node name="Indexes" spaces=" "><nodename>Indexes</nodename><nodeprev automatic="on">Glossaries</nodeprev><nodeup automatic="on">Front/back matter</nodeup></node> <section spaces=" "><sectiontitle>Indexes</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="481">indexes</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="849">\makeindex</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="529">indexes</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="923">\makeindex</indexterm></findex> <para>The command <code>\makeindex</code> enables creating indexes. Put this in the preamble. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="850">\index</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="482"><file>.idx</file> file</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="924">\index</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="530"><file>.idx</file> file</indexterm></cindex> <para>The command <code>\index{<var>text</var>}</code> writes an index entry for <var>text</var> to an auxiliary file with the <file>.idx</file> extension. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="851">\indexentry</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="925">\indexentry</indexterm></findex> <para>Specifically, what gets written is the command <code>\indexentry{<var>text</var>}{<var>pageno</var>}</code>, where <var>pageno</var> is the current <code>\thepage</code> value. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="483">&textlsquo;see&textrsquo; and &textlsquo;see also&textrsquo; index entries</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="484">index entries, &textlsquo;see&textrsquo; and &textlsquo;see also&textrsquo;</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="531">&textlsquo;see&textrsquo; and &textlsquo;see also&textrsquo; index entries</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="532">index entries, &textlsquo;see&textrsquo; and &textlsquo;see also&textrsquo;</indexterm></cindex> <para>To generate a index entry for &textlsquo;bar&textrsquo; that says &textlsquo;See foo&textrsquo;, use a vertical bar: <code>\index{bar|see{foo}}</code>. Use <code>seealso</code> instead of <code>see</code> to make a &textlsquo;See also&textrsquo; entry. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="852">\seename</indexterm></findex> -<findex index="fn" spaces=" "><indexterm index="fn" number="853">\alsoname</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="926">\seename</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="927">\alsoname</indexterm></findex> <para>The text &textlsquo;See&textrsquo; is defined by the macro <code>\seename</code>, and &textlsquo;See also&textrsquo; by the macro <code>\alsoname</code>. These can be redefined for other languages. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="485"><command>makeindex</command> program</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="486"><command>xindy</command> program</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="487"><file>.ind</file> file</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="533"><command>makeindex</command> program</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="534"><command>xindy</command> program</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="535"><file>.ind</file> file</indexterm></cindex> <para>The generated <file>.idx</file> file is then sorted with an external command, usually either <command>makeindex</command> (<url><urefurl>http://mirror.ctan.org/indexing/makeindex</urefurl></url>) or (the @@ -7072,23 +9301,23 @@ multi-lingual) <command>xindy</command> (<url><urefurl>http://xindy.sourceforge. This results in a <file>.ind</file> file, which can then be read to typeset the index. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="854">printindex</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="488"><code>makeidx</code> package</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="928">printindex</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="536"><code>makeidx</code> package</indexterm></cindex> <para>The index is usually generated with the <code>\printindex</code> command. This is defined in the <code>makeidx</code> package, so <code>\usepackage{makeidx}</code> needs to be in the preamble. </para> -<findex index="fn" spaces=" "><indexterm index="fn" number="855">indexspace</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="929">indexspace</indexterm></findex> <para>The rubber length <code>\indexspace</code> is inserted before each new letter in the printed index; its default value is <samp>10pt plus5pt minus3pt</samp>. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="489"><code>showidx</code> package</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="537"><code>showidx</code> package</indexterm></cindex> <para>The <code>showidx</code> package causes each index entries to be shown in the margin on the page where the entry appears. This can help in preparing the index. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="490"><code>multind</code> package</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="538"><code>multind</code> package</indexterm></cindex> <para>The <code>multind</code> package supports multiple indexes. See also the &tex; FAQ entry on this topic, <url><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind</urefurl></url>. @@ -7098,103 +9327,176 @@ preparing the index. </chapter> <node name="Letters" spaces=" "><nodename>Letters</nodename><nodenext automatic="on">Terminal input/output</nodenext><nodeprev automatic="on">Front/back matter</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Letters</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="491">letters</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="492">creating letters</indexterm></cindex> -<para>You can use &latex; to typeset letters, both personal and business. The -<code>letter</code> document class is designed to make a number of letters at -once, although you can make just one if you so desire. -</para> -<para>Your <file>.tex</file> source file has the same minimum commands as the other -document classes, i.e., you must have the following commands as a -minimum: +<cindex index="cp" spaces=" "><indexterm index="cp" number="539">letters, writing</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="540">writing letters</indexterm></cindex> + +<para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve"> \documentclass{letter} - \begin{document} - ... letters ... - \end{document} +<pre xml:space="preserve">\documentclass{letter} +\address{<var>sender address</var>} +\signature{<var>sender name</var>} +\begin{document} +\begin{letter}{<var>recipient address</var>} +\opening{<var>salutation</var>} + <var>letter body</var> +\closing{<var>closing text</var>} +\end{letter} + ... more letters ... +\end{document} </pre></example> -<para>Each letter is a <code>letter</code> environment, whose argument is the name -and address of the recipient. For example, you might have: +<para>Produce one or more letters. +</para> +<para>Each letter is in a separate <code>letter</code> environment, whose argument +<var>recipient address</var> often contains multiple lines separated with a +double backslash (<code>\\</code>). For example, you might have: </para> <example endspaces=" "> -<pre xml:space="preserve"> \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. - \\ Edinburgh, EH1 1AA} +<pre xml:space="preserve"> \begin{letter}{Mr. Joe Smith \\ + 2345 Princess St. \\ + Edinburgh, EH1 1AA} ... \end{letter} </pre></example> -<para>The letter itself begins with the <code>\opening</code> command. The text of -the letter follows. It is typed as ordinary &latex; input. Commands that -make no sense in a letter, like <code>\chapter</code>, do not work. The letter -closes with a <code>\closing</code> command. -</para> -<findex index="fn" spaces=" "><indexterm index="fn" number="856">\\ <r>for letters</r></indexterm></findex> -<para>After the <code>closing</code>, you can have additional material. The -<code>\cc</code> command produces the usual &textldquo;cc: &dots;&textrdquo;. There&textrsquo;s also a -similar <code>\encl</code> command for a list of enclosures. With both these -commands, use <code>\\</code> to separate the items. +<para>The start of the <code>letter</code> environment resets the page number to 1, +and the footnote number to 1 also. +</para> +<para>The <var>sender address</var> and <var>sender name</var> are common to all of the +letters, whether there is one or more, so these are best put in the +preamble. As with the recipient address, often <var>sender address</var> +contains multiple lines separated by a double +backslash (<code>\\</code>). &latex; will put the <var>sender name</var> +under the closing, after a vertical space for the traditional +hand-written signature; it also can contain multiple lines. +</para> +<para>Each letter environment begins with a required <code>\opening</code> command +such as <code>\opening{Dear Madam or Sir:}</code>. The <var>letter body</var> +text is ordinary &latex; so it can contain everything from from +enumerated lists to displayed math, except that commands such as +<code>\chapter</code> that make no sense in a letter are turned off. Each +letter environment typically ends with a <code>\closing</code> command such as +<code>\closing{Yours,}</code>. +</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="930">\\ <r>for letters</r></indexterm></findex> +<para>Additional material may come after the <code>\closing</code>. You can say who +is receiving a copy of the letter with a command like <code>\cc{the +Boss \\ the Boss's Boss}</code>. There&textrsquo;s a similar <code>\encl</code> command for +a list of enclosures. And, you can add a postscript with <code>\ps</code>. +</para> +<para>&latex;&textrsquo;s default is to indent the signature and the <code>\closing</code> +above it by a length of <code>\longindentation</code>. By default this is +<code>0.5\textwidth</code>. To make them flush left, put +<code>\setlength{\longindentation}{0em}</code> in your preamble. +</para> +<para>To set a fixed date use something like +<code>\renewcommand{\today}{2015-Oct-12}</code>. If put in your preamble +then it will apply to all the letters. +</para> +<para>This example shows only one <code>letter</code> environment. The three lines +marked as optional are typically omitted. </para> +<example endspaces=" "> +<pre xml:space="preserve">\documentclass{letter} +\address{Sender's street \\ Sender's town} +\signature{Sender's name \\ Sender's title} +% optional: \location{Mailbox 13} +% optional: \telephone{(102) 555-0101} +\begin{document} +\begin{letter}{Recipient's name \\ Recipient's address} +\opening{Sir:} +% optional: \thispagestyle{firstpage} +I am not interested in entering a business arrangement with you. +\closing{Your most humble, etc.,} +\end{letter} +\end{document} +</pre></example> + <para>These commands are used with the <code>letter</code> class. </para> <menu endspaces=" "> -<menuentry leadingtext="* "><menunode separator=":: ">\address</menunode><menudescription><pre xml:space="preserve">Your return address. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\cc</menunode><menudescription><pre xml:space="preserve">Cc list. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\closing</menunode><menudescription><pre xml:space="preserve">Saying goodbye. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\encl</menunode><menudescription><pre xml:space="preserve">List of enclosed material. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\location</menunode><menudescription><pre xml:space="preserve">Your organization&textrsquo;s address. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\makelabels</menunode><menudescription><pre xml:space="preserve">Making address labels. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\name</menunode><menudescription><pre xml:space="preserve">Your name, for the return address. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\opening</menunode><menudescription><pre xml:space="preserve">Saying hello. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\ps</menunode><menudescription><pre xml:space="preserve">Adding a postscript. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\signature</menunode><menudescription><pre xml:space="preserve">Your signature. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\startbreaks</menunode><menudescription><pre xml:space="preserve">Allow page breaks. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\stopbreaks</menunode><menudescription><pre xml:space="preserve">Disallow page breaks. -</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\telephone</menunode><menudescription><pre xml:space="preserve">Your phone number. +<menuentry leadingtext="* "><menunode separator=":: ">\address</menunode><menudescription><pre xml:space="preserve">Sender&textrsquo;s return address. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\cc</menunode><menudescription><pre xml:space="preserve">Carbon copy list. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\closing</menunode><menudescription><pre xml:space="preserve">Saying goodbye. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\encl</menunode><menudescription><pre xml:space="preserve">List of enclosed material. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\location</menunode><menudescription><pre xml:space="preserve">Sender&textrsquo;s organizational location. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\makelabels</menunode><menudescription><pre xml:space="preserve">Make address labels. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\name</menunode><menudescription><pre xml:space="preserve">Sender&textrsquo;s name, for the return address. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\opening</menunode><menudescription><pre xml:space="preserve">Saying hello. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\ps</menunode><menudescription><pre xml:space="preserve">Adding a postscript. +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\signature</menunode><menudescription><pre xml:space="preserve">Sender&textrsquo;s signature. +<!-- c ?Not user-level? * \stopbreaks and \startbreaks:: Disallow and allow page breaks. --> +</pre></menudescription></menuentry><menuentry leadingtext="* "><menunode separator=":: ">\telephone</menunode><menudescription><pre xml:space="preserve">Sender&textrsquo;s phone number. </pre></menudescription></menuentry></menu> <node name="_005caddress" spaces=" "><nodename>\address</nodename><nodenext automatic="on">\cc</nodenext><nodeup automatic="on">Letters</nodeup></node> -<section spaces=" "><sectiontitle>\address{<var>return-address}</var></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="857">\address</indexterm></findex> +<section spaces=" "><sectiontitle><code>\address</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="931">\address</indexterm></findex> + +<para>Synopsis: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\address{<var>senders address</var>} +</pre></example> -<para>The <code>\address</code> specifies the return address of a letter, as it -should appear on the letter and the envelope. Separate lines of the -address should be separated by <code>\\</code> commands. +<para>Specifies the return address as it appears on the letter and on the +envelope. Separate multiple lines in <var>senders address</var> with a +double backslash <code>\\</code>. +</para> +<para>Because it can apply to multiple letters this declaration is often put +in the preamble. However, it can go anywhere, including inside an +individual <code>letter</code> environment. </para> -<para>If you do not make an <code>\address</code> declaration, then the letter -will be formatted for copying onto your organization&textrsquo;s standard -letterhead. (<xref label="Overview"><xrefnodename>Overview</xrefnodename></xref>, for details on your local -implementation). If you give an <code>\address</code> declaration, then the -letter will be formatted as a personal letter. +<para>This command is optional: without the <code>\address</code> declaration the +letter is formatted with some blank space on top, for copying onto +pre-printed letterhead paper. (<xref label="Overview"><xrefnodename>Overview</xrefnodename></xref>, for details on your +local implementation.) With the <code>\address</code> declaration, it is +formatted as a personal letter. </para> +<para>Here is an example. +</para> +<example endspaces=" "> +<pre xml:space="preserve">\address{Stephen Maturin \\ + The Grapes of the Savoy} +</pre></example> + </section> <node name="_005ccc" spaces=" "><nodename>\cc</nodename><nodenext automatic="on">\closing</nodenext><nodeprev automatic="on">\address</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\cc</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="858">\cc</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="493">cc list, in letters</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="932">\cc</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="541">cc list, in letters</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\cc{<var>name1</var>\\<var>name2</var>} +<pre xml:space="preserve">\cc{<var>first name</var> \\ + .. } </pre></example> -<para>Produce a list of <var>name</var>s the letter was copied to. Each name is -printed on a separate line. +<para>Produce a list of names to which copies of the letter were sent. This +command is optional. If it appears then typically it comes after +<code>\closing</code>. Separate multiple lines with a double +backslash <code>\\</code>. </para> +<example endspaces=" "> +<pre xml:space="preserve">\cc{President \\ + Vice President} +</pre></example> + </section> <node name="_005cclosing" spaces=" "><nodename>\closing</nodename><nodenext automatic="on">\encl</nodenext><nodeprev automatic="on">\cc</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\closing</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="859">\closing</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="494">letters, ending</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="495">closing letters</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="933">\closing</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="542">letters, ending</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="543">closing letters</indexterm></cindex> <para>Synopsis: </para> @@ -7202,9 +9504,11 @@ printed on a separate line. <pre xml:space="preserve">\closing{text} </pre></example> -<para>A letter closes with a <code>\closing</code> command, for example, -</para><example endspaces=" "> -<pre xml:space="preserve">\closing{Best Regards,} +<para>Usually at the end of a letter, above the handwritten signature, there +is a <code>\closing</code> (although this command is optional). For example, +</para> +<example endspaces=" "> +<pre xml:space="preserve">\closing{Regards,} </pre></example> @@ -7212,57 +9516,92 @@ printed on a separate line. <node name="_005cencl" spaces=" "><nodename>\encl</nodename><nodenext automatic="on">\location</nodenext><nodeprev automatic="on">\closing</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\encl</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="860">\encl</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="496">enclosure list</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="934">\encl</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="544">enclosure list</indexterm></cindex> <para>Synopsis: </para> <example endspaces=" "> -<pre xml:space="preserve">\encl{<var>line1</var>\\<var>line2</var>} +<pre xml:space="preserve">\encl{<var>first enclosed object</var> \\ + .. } </pre></example> -<para>Declare a list of one more enclosures. +<para>Produce a list of things included with the letter. This command is +optional; when it is used, it typically is put after <code>\closing</code>. +Separate multiple lines with a double backslash <code>\\</code>. </para> +<example endspaces=" "> +<pre xml:space="preserve">\encl{License \\ + Passport } +</pre></example> + </section> <node name="_005clocation" spaces=" "><nodename>\location</nodename><nodenext automatic="on">\makelabels</nodenext><nodeprev automatic="on">\encl</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\location</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="861">\location</indexterm></findex> -<para><code>\location{address}</code> +<findex index="fn" spaces=" "><indexterm index="fn" number="935">\location</indexterm></findex> + +<para>Synopsis: </para> -<para>This modifies your organization&textrsquo;s standard address. This only appears -if the <code>firstpage</code> pagestyle is selected. +<example endspaces=" "> +<pre xml:space="preserve">\location{<var>text</var>} +</pre></example> + +<para>The <var>text</var> appears centered at the bottom of the each page. It only +appears if the page style is <code>firstpage</code>. </para> </section> <node name="_005cmakelabels" spaces=" "><nodename>\makelabels</nodename><nodenext automatic="on">\name</nodenext><nodeprev automatic="on">\location</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\makelabels</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="862">\makelabels</indexterm></findex> -<para><code>\makelabels{number}</code> -</para> -<para>If you issue this command in the preamble, &latex; will create a sheet of -address labels. This sheet will be output before the letters. -</para> +<findex index="fn" spaces=" "><indexterm index="fn" number="936">\makelabels</indexterm></findex> +<para>Synopsis: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\makelabels +</pre></example> +<para>Create a sheet of address labels from the recipient addresses, one for +each letter. This sheet will be output before the letters, with the idea +that you can copy it to a sheet of peel-off labels. This command goes +in the preamble. +</para> +<para>Customize the labels by redefining the commands <code>\startlabels</code>, +<code>\mlabel</code>, and <code>\returnaddress</code> in the preamble. The command +<code>\startlabels</code> sets the width, height, number of columns, etc., of +the page onto which the labels are printed. The command +<code>\mlabel{<var>sender address</var>}{<var>recipient address</var>}</code> +produces the two labels (or one, if you choose to ignore the <var>sender +address</var>). The <var>sender address</var> is the value returned by the macro +<code>\returnaddress</code> while <var>recipient address</var> is the value passed +in the argument to the <code>letter</code> environment. By default +<code>\mlabel</code> ignores the first argument, the <var>sender address</var>. +</para> </section> <node name="_005cname" spaces=" "><nodename>\name</nodename><nodenext automatic="on">\opening</nodenext><nodeprev automatic="on">\makelabels</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\name</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="863">\name</indexterm></findex> -<para><code>\name{June Davenport}</code> +<findex index="fn" spaces=" "><indexterm index="fn" number="937">\name</indexterm></findex> + +<para>Synopsis: </para> -<para>Your name, used for printing on the envelope together with the return -address. +<example endspaces=" "> +<pre xml:space="preserve">\name{<var>name</var>} +</pre></example> + +<para>Sender&textrsquo;s name, used for printing on the envelope together with the +return address. </para> </section> <node name="_005copening" spaces=" "><nodename>\opening</nodename><nodenext automatic="on">\ps</nodenext><nodeprev automatic="on">\name</nodeprev><nodeup automatic="on">Letters</nodeup></node> -<section spaces=" "><sectiontitle><code>\opening{<var>text</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="864">\opening</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="497">letters, starting</indexterm></cindex> +<section spaces=" "><sectiontitle><code>\opening</code></sectiontitle> + +<findex index="fn" spaces=" "><indexterm index="fn" number="938">\opening</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="545">letters, starting</indexterm></cindex> <para>Synopsis: </para> @@ -7270,72 +9609,118 @@ address. <pre xml:space="preserve">\opening{<var>text</var>} </pre></example> -<para>A letter begins with the <code>\opening</code> command. The mandatory -argument, <var>text</var>, is whatever text you wish to start your letter. -For instance: +<para>This command is required. It starts a letter, following the +<code>\begin{letter}{..}</code>. The mandatory argument <var>text</var> is the +text that starts your letter. For instance: </para> <example endspaces=" "> -<pre xml:space="preserve">\opening{Dear Joe,} +<pre xml:space="preserve">\opening{Dear John:} </pre></example> </section> <node name="_005cps" spaces=" "><nodename>\ps</nodename><nodenext automatic="on">\signature</nodenext><nodeprev automatic="on">\opening</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\ps</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="865">\ps</indexterm></findex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="498">postscript, in letters</indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="939">\ps</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="546">postscript, in letters</indexterm></cindex> -<para>Use the <code>\ps</code> command to start a postscript in a letter, after +<para>Synopsis: +</para> +<example endspaces=" "> +<pre xml:space="preserve">\ps{<var>text</var>} +</pre></example> + +<para>Add a postscript. This command is optional and usually is used after <code>\closing</code>. </para> +<example endspaces=" "> +<pre xml:space="preserve">\ps{P.S. After you have read this letter, burn it. Or eat it.} +</pre></example> + </section> -<node name="_005csignature" spaces=" "><nodename>\signature</nodename><nodenext automatic="on">\startbreaks</nodenext><nodeprev automatic="on">\ps</nodeprev><nodeup automatic="on">Letters</nodeup></node> -<section spaces=" "><sectiontitle><code>\signature{<var>text</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="866">\signature</indexterm></findex> +<node name="_005csignature" spaces=" "><nodename>\signature</nodename><nodenext automatic="on">\telephone</nodenext><nodeprev automatic="on">\ps</nodeprev><nodeup automatic="on">Letters</nodeup></node> +<section spaces=" "><sectiontitle><code>\signature</code></sectiontitle> -<para>Your name, as it should appear at the end of the letter underneath the -space for your signature. <code>\\</code> starts a new line within -<var>text</var> as usual. +<para>Synopsis: </para> +<example endspaces=" "> +<pre xml:space="preserve">\signature{<var>first line</var> \\ + .. } +</pre></example> -</section> -<node name="_005cstartbreaks" spaces=" "><nodename>\startbreaks</nodename><nodenext automatic="on">\stopbreaks</nodenext><nodeprev automatic="on">\signature</nodeprev><nodeup automatic="on">Letters</nodeup></node> -<section spaces=" "><sectiontitle><code>\startbreaks</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="867">\startbreaks</indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="940">\signature</indexterm></findex> -<para><code>\startbreaks</code> +<para>The sender&textrsquo;s name. This command is optional, although its inclusion is +usual. </para> -<para>Used after a <code>\stopbreaks</code> command to allow page breaks again. +<para>The argument text appears at the end of the letter, after the closing +and after a vertical space for the traditional hand-written +signature. Separate multiple lines with a double +backslash <code>\\</code>. For example: </para> +<example endspaces=" "> +<pre xml:space="preserve">\signature{J Fred Muggs \\ + White House} +</pre></example> -</section> -<node name="_005cstopbreaks" spaces=" "><nodename>\stopbreaks</nodename><nodenext automatic="on">\telephone</nodenext><nodeprev automatic="on">\startbreaks</nodeprev><nodeup automatic="on">Letters</nodeup></node> -<section spaces=" "><sectiontitle><code>\stopbreaks</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="868">\stopbreaks</indexterm></findex> - -<para><code>\stopbreaks</code> +<para>&latex;&textrsquo;s default for the vertical space from the <code>\closing</code> text +down to the <code>\signature</code> text is <code>6\medskipamount</code>, which is +six times 0.7<dmn>em</dmn>. +</para> +<para>This command is usually in the preamble, to apply to all the letters in +the document. To have it apply to one letter only, put it inside a +<code>letter</code> environment and before the <code>\closing</code>. </para> -<para>Inhibit page breaks until a <code>\startbreaks</code> command occurs. +<para>You can include a graphic in the signature, for instance with +<code>\signature{\vspace{-6\medskipamount}\includegraphics{sig.png}\\ +My name}</code> (this requires writing <code>\usepackage{graphicx}</code> in the +preamble). </para> +<!-- c I think this is not a user-level command; it is used to keep from breaking --> +<!-- c the page between the closing and the signature --> +<!-- c @node \stopbreaks and \startbreaks --> +<!-- c @section @code{\stopbreaks} and @code{\startbreaks} --> + +<!-- c @findex \startbreak --> +<!-- c @findex \stopbreaks --> + +<!-- c @example --> +<!-- c @code{\stopbreaks} --> +<!-- c text --> +<!-- c @code{\startbreaks} --> +<!-- c @end example --> + +<!-- c The @code{\stopbreaks} inhibits page breaking. The @code{\startbreaks} resumes --> +<!-- c normal page breaking. --> +<!-- c --> +<!-- c --> </section> -<node name="_005ctelephone" spaces=" "><nodename>\telephone</nodename><nodeprev automatic="on">\stopbreaks</nodeprev><nodeup automatic="on">Letters</nodeup></node> +<node name="_005ctelephone" spaces=" "><nodename>\telephone</nodename><nodeprev automatic="on">\signature</nodeprev><nodeup automatic="on">Letters</nodeup></node> <section spaces=" "><sectiontitle><code>\telephone</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="869">\telephone</indexterm></findex> -<para><code>\telephone{number}</code> +<findex index="fn" spaces=" "><indexterm index="fn" number="941">\telephone</indexterm></findex> + +<para>Synopsis: </para> -<para>This is your telephone number. This only appears if the -<code>firstpage</code> pagestyle is selected. +<example endspaces=" "> +<pre xml:space="preserve">\telephone{<var>number</var>} +</pre></example> + +<para>The sender&textrsquo;s telephone number. This is typically in the preamble, where +it applies to all letters. This only appears if the <code>firstpage</code> +pagestyle is selected. If so, it appears on the lower right of the +page. </para> </section> </chapter> <node name="Terminal-input_002foutput" spaces=" "><nodename>Terminal input/output</nodename><nodenext automatic="on">Command line</nodenext><nodeprev automatic="on">Letters</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Terminal input/output</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="499">input/output</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="500">terminal input/output</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="547">input/output, to terminal</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="548">terminal input/output</indexterm></cindex> <menu endspaces=" "> <menuentry leadingtext="* "><menunode separator=":: ">\typein</menunode><menudescription><pre xml:space="preserve">Read text from the terminal. @@ -7345,7 +9730,8 @@ space for your signature. <code>\\</code> starts a new line within <node name="_005ctypein" spaces=" "><nodename>\typein</nodename><nodenext automatic="on">\typeout</nodenext><nodeup automatic="on">Terminal input/output</nodeup></node> <section spaces=" "><sectiontitle><code>\typein[<var>cmd</var>]{<var>msg</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="870">\typein</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="942">\typein</indexterm></findex> <para>Synopsis: </para> @@ -7365,7 +9751,8 @@ redefined to be the typed input. </section> <node name="_005ctypeout" spaces=" "><nodename>\typeout</nodename><nodeprev automatic="on">\typein</nodeprev><nodeup automatic="on">Terminal input/output</nodeup></node> <section spaces=" "><sectiontitle><code>\typeout{<var>msg</var>}</code></sectiontitle> -<findex index="fn" spaces=" "><indexterm index="fn" number="871">\typeout</indexterm></findex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="943">\typeout</indexterm></findex> <para>Synopsis: </para> @@ -7389,9 +9776,10 @@ printed, independent of surrounding spaces. A <code>^^J</code> in </chapter> <node name="Command-line" spaces=" "><nodename>Command line</nodename><nodenext automatic="on">Document templates</nodenext><nodeprev automatic="on">Terminal input/output</nodeprev><nodeup automatic="on">Top</nodeup></node> <chapter spaces=" "><sectiontitle>Command line</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="501">command line</indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="872">.tex, <r>default extension</r></indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="549">command line</indexterm></cindex> + +<findex index="fn" spaces=" "><indexterm index="fn" number="944">.tex, <r>default extension</r></indexterm></findex> <para>The input file specification indicates the file to be formatted; &tex; uses <file>.tex</file> as a default file extension. If you omit the input file entirely, &tex; accepts input from the terminal. You can @@ -7403,14 +9791,14 @@ error: <pre xml:space="preserve">latex '\nonstopmode\input foo.tex' </pre></example> -<findex index="fn" spaces=" "><indexterm index="fn" number="873">&textndash;help <r>command-line option</r></indexterm></findex> +<findex index="fn" spaces=" "><indexterm index="fn" number="945">&textndash;help <r>command-line option</r></indexterm></findex> <para>With many, but not all, implementations, command-line options can also be specified in the usual Unix way, starting with <samp>-</samp> or <samp>--</samp>. For a list of those options, try <samp>latex --help</samp>. </para> -<cindex index="cp" spaces=" "><indexterm index="cp" number="502"><samp>*</samp> prompt</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="503">prompt, <samp>*</samp></indexterm></cindex> -<findex index="fn" spaces=" "><indexterm index="fn" number="874">\stop</indexterm></findex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="550"><samp>*</samp> prompt</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="551">prompt, <samp>*</samp></indexterm></cindex> +<findex index="fn" spaces=" "><indexterm index="fn" number="946">\stop</indexterm></findex> <para>If &latex; stops in the middle of the document and gives you a <samp>*</samp> prompt, it is waiting for input. You can type <code>\stop</code> (and return) and it will prematurely end the document. @@ -7421,7 +9809,9 @@ be specified in the usual Unix way, starting with <samp>-</samp> or </chapter> <node name="Document-templates" spaces=" "><nodename>Document templates</nodename><nodenext automatic="on">Concept Index</nodenext><nodeprev automatic="on">Command line</nodeprev><nodeup automatic="on">Top</nodeup></node> <appendix spaces=" "><sectiontitle>Document templates</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="504">document templates</indexterm></cindex> + +<cindex index="cp" spaces=" "><indexterm index="cp" number="552">document templates</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="553">templates, document</indexterm></cindex> <para>Although not reference material, perhaps these document templates will be useful. Additional template resources are listed at @@ -7437,7 +9827,9 @@ be useful. Additional template resources are listed at <node name="beamer-template" spaces=" "><nodename>beamer template</nodename><nodenext automatic="on">book template</nodenext><nodeup automatic="on">Document templates</nodeup></node> <section spaces=" "><sectiontitle><code>beamer</code> template</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="505"><code>beamer</code> template and class</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="554"><code>beamer</code> template and class</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="555">template, <code>beamer</code></indexterm></cindex> + <para>The <code>beamer</code> class creates presentation slides. It has a vast array of features, but here is a basic template: </para> @@ -7473,6 +9865,8 @@ array of features, but here is a basic template: <node name="book-template" spaces=" "><nodename>book template</nodename><nodenext automatic="on">tugboat template</nodenext><nodeprev automatic="on">beamer template</nodeprev><nodeup automatic="on">Document templates</nodeup></node> <section spaces=" "><sectiontitle><code>book</code> template</sectiontitle> +<cindex index="cp" spaces=" "><indexterm index="cp" number="556">template, <code>book</code></indexterm></cindex> + <verbatim xml:space="preserve"> \documentclass{book} \title{Book Class Template} @@ -7497,8 +9891,9 @@ The end. <node name="tugboat-template" spaces=" "><nodename>tugboat template</nodename><nodeprev automatic="on">book template</nodeprev><nodeup automatic="on">Document templates</nodeup></node> <section spaces=" "><sectiontitle><code>tugboat</code> template</sectiontitle> -<cindex index="cp" spaces=" "><indexterm index="cp" number="506">TUGboat template</indexterm></cindex> -<cindex index="cp" spaces=" "><indexterm index="cp" number="507"><code>ltugboat</code> class</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="557">template, TUGboat</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="558">TUGboat template</indexterm></cindex> +<cindex index="cp" spaces=" "><indexterm index="cp" number="559"><code>ltugboat</code> class</indexterm></cindex> <para><cite>TUGboat</cite> is the journal of the &tex; Users Group, <url><urefurl>http://tug.org/TUGboat</urefurl></url>. |