diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml')
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml | 7105 |
1 files changed, 7105 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml new file mode 100644 index 00000000000..2ff958c3e60 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml @@ -0,0 +1,7105 @@ +<?xml version="1.0"?> +<!DOCTYPE texinfo PUBLIC "-//GNU//DTD TexinfoML V4.12//EN" "http://www.gnu.org/software/texinfo/dtd/4.12/texinfo.dtd"> +<texinfo xml:lang="en"> + <setfilename>latex2e.xml</setfilename> + <setvalue name="UPDATED">June 2008</setvalue> + <setvalue name="VERSION">2.0</setvalue> + <settitle>&latex;2e reference manual 2.0</settitle> +<!-- %**end of header (This is for running Texinfo on a region.) --> +<!-- xx merge http://ctan.org/tex-archive/info/latex-info/ --> +<!-- xx latex 2.09 should be pretty much complete now, but --> +<!-- new stuff in latex2e is surely missing. --> + <para>This document is version 2.0 (June 2008) of an unofficial reference manual for &latex;, a document preparation system. &latex; is a macro package for &tex;.</para> + <para>This was originally translated from <file>LATEX.HLP</file> v1.0a in the VMS Help Library. The pre-translation version was written by George D. Greenwade of Sam Houston State University. The &latex; 2.09 version was written by Stephen Gilmore. The &latex;2e version was adapted from this by Torsten Martinsen. Karl Berry made further updates and additions, and gratefully acknowledges using <cite>Hypertext Help with &latex;</cite>, by Sheldon Green, and the <cite>&latex; Command Summary</cite> (for &latex; 2.09) by L. Botway and C. Biemesderfer (published by the &tex; Users Group as <cite>&tex;niques</cite> number 10), as reference material (text was not directly copied).</para> + <para>Copyright ©right; 2007, 2008 Karl Berry.&linebreak; Copyright ©right; 1988, 1994, 2007 Stephen Gilmore.&linebreak; Copyright ©right; 1994, 1995, 1996 Torsten Martinsen.</para> + <para>Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.</para> + <para>Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.</para> + <para>Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.</para> + <dircategory>TeX</dircategory> + <titlepage> + <booktitle>&latex;: Structured documents for &tex;</booktitle> + <booksubtitle>unofficial &latex; reference manual</booksubtitle> + <booksubtitle>version 2.0, June 2008</booksubtitle> + <author></author> + <para>This document is version 2.0 (June 2008) of an unofficial reference manual for &latex;, a document preparation system. &latex; is a macro package for &tex;.</para> + <para>This was originally translated from <file>LATEX.HLP</file> v1.0a in the VMS Help Library. The pre-translation version was written by George D. Greenwade of Sam Houston State University. The &latex; 2.09 version was written by Stephen Gilmore. The &latex;2e version was adapted from this by Torsten Martinsen. Karl Berry made further updates and additions, and gratefully acknowledges using <cite>Hypertext Help with &latex;</cite>, by Sheldon Green, and the <cite>&latex; Command Summary</cite> (for &latex; 2.09) by L. Botway and C. Biemesderfer (published by the &tex; Users Group as <cite>&tex;niques</cite> number 10), as reference material (text was not directly copied).</para> + <para>Copyright ©right; 2007, 2008 Karl Berry.&linebreak; Copyright ©right; 1988, 1994, 2007 Stephen Gilmore.&linebreak; Copyright ©right; 1994, 1995, 1996 Torsten Martinsen.</para> + <para>Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.</para> + <para>Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.</para> + <para>Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.</para> + </titlepage> + <shortcontents></shortcontents> + <contents></contents> + <node> + <nodename>Top</nodename> + <nodenext>Overview</nodenext> + <nodeup>(dir)</nodeup> + <unnumbered> + <title>&latex;2e</title> + <para>This document is version 2.0 (June 2008) of an unofficial reference manual for &latex;, a document preparation system. It is intended to cover &latex;2e, which has been the standard version of &latex; for many years.</para> + <para><indexterm index="cp">Knuth, Donald E.</indexterm><indexterm index="cp">Lamport, Leslie</indexterm><indexterm index="cp">&latex; Project team</indexterm>&latex; is implemented as a macro package for Donald E. Knuth's &tex; typesetting program. &latex; was originally created by Leslie Lamport; it is now maintained by a group of volunteers (<uref><urefurl>http://latex-project.org</urefurl></uref>). The official documentation written by the &latex; project is available there. Again, the present document is unofficial and has not been reviewed by the &latex; maintainers.</para> + <menu> + <menuentry> + <menunode>Overview</menunode> + <menutitle>Overview</menutitle> + <menucomment>What is &latex;?</menucomment> + </menuentry> + <menuentry> + <menunode>Starting & ending</menunode> + <menutitle>Starting & ending</menutitle> + <menucomment>The standard beginning and end of a document.</menucomment> + </menuentry> + <menuentry> + <menunode>Document classes</menunode> + <menutitle>Document classes</menutitle> + <menucomment>Some of the various classes available.</menucomment> + </menuentry> + <menuentry> + <menunode>Typefaces</menunode> + <menutitle>Typefaces</menutitle> + <menucomment>And fonts, such as bold, italics etc.</menucomment> + </menuentry> + <menuentry> + <menunode>Layout</menunode> + <menutitle>Layout</menutitle> + <menucomment>Controlling the page layout.</menucomment> + </menuentry> + <menuentry> + <menunode>Sectioning</menunode> + <menutitle>Sectioning</menutitle> + <menucomment>How to section properly.</menucomment> + </menuentry> + <menuentry> + <menunode>Cross references</menunode> + <menutitle>Cross references</menutitle> + <menucomment>Automatic referencing.</menucomment> + </menuentry> + <menuentry> + <menunode>Environments</menunode> + <menutitle>Environments</menutitle> + <menucomment>Such as enumerate & itemize.</menucomment> + </menuentry> + <menuentry> + <menunode>Line breaking</menunode> + <menutitle>Line breaking</menutitle> + <menucomment>Influencing line breaks.</menucomment> + </menuentry> + <menuentry> + <menunode>Page breaking</menunode> + <menutitle>Page breaking</menutitle> + <menucomment>Influencing page breaks.</menucomment> + </menuentry> + <menuentry> + <menunode>Footnotes</menunode> + <menutitle>Footnotes</menutitle> + <menucomment>How to produce footnotes.</menucomment> + </menuentry> + <menuentry> + <menunode>Definitions</menunode> + <menutitle>Definitions</menutitle> + <menucomment>Define your own commands etc.</menucomment> + </menuentry> + <menuentry> + <menunode>Counters</menunode> + <menutitle>Counters</menutitle> + <menucomment>Internal counters used by &latex;.</menucomment> + </menuentry> + <menuentry> + <menunode>Lengths</menunode> + <menutitle>Lengths</menutitle> + <menucomment>The length commands.</menucomment> + </menuentry> + <menuentry> + <menunode>Making paragraphs</menunode> + <menutitle>Making paragraphs</menutitle> + <menucomment>Paragraph commands.</menucomment> + </menuentry> + <menuentry> + <menunode>Math formulas</menunode> + <menutitle>Math formulas</menutitle> + <menucomment>How to create mathematical formulas.</menucomment> + </menuentry> + <menuentry> + <menunode>Modes</menunode> + <menutitle>Modes</menutitle> + <menucomment>Paragraph, Math or LR modes.</menucomment> + </menuentry> + <menuentry> + <menunode>Page Styles</menunode> + <menutitle>Page Styles</menutitle> + <menucomment>Various styles of page layout.</menucomment> + </menuentry> + <menuentry> + <menunode>Spaces</menunode> + <menutitle>Spaces</menutitle> + <menucomment>Horizontal and vertical space.</menucomment> + </menuentry> + <menuentry> + <menunode>Boxes</menunode> + <menutitle>Boxes</menutitle> + <menucomment>Making boxes.</menucomment> + </menuentry> + <menuentry> + <menunode>Special insertions</menunode> + <menutitle>Special insertions</menutitle> + <menucomment>Inserting reserved and special characters.</menucomment> + </menuentry> + <menuentry> + <menunode>Splitting the input</menunode> + <menutitle>Splitting the input</menutitle> + <menucomment>Dealing with big files by splitting.</menucomment> + </menuentry> + <menuentry> + <menunode>Front/back matter</menunode> + <menutitle>Front/back matter</menutitle> + <menucomment>Tables of contents, glossaries, indexes.</menucomment> + </menuentry> + <menuentry> + <menunode>Letters</menunode> + <menutitle>Letters</menutitle> + <menucomment>The letter class.</menucomment> + </menuentry> + <menuentry> + <menunode>Terminal Input/Output</menunode> + <menutitle>Terminal Input/Output</menutitle> + <menucomment>User interaction.</menucomment> + </menuentry> + <menuentry> + <menunode>Command Line</menunode> + <menutitle>Command Line</menutitle> + <menucomment>System-independent command-line behavior.</menucomment> + </menuentry> + <menuentry> + <menunode>Document templates</menunode> + <menutitle>Document templates</menutitle> + <menucomment>Starter templates for various document classes.</menucomment> + </menuentry> + <menuentry> + <menunode>Command Index</menunode> + <menutitle>Command Index</menutitle> + <menucomment>Alphabetical list of &latex; commands.</menucomment> + </menuentry> + <menuentry> + <menunode>Concept Index</menunode> + <menutitle>Concept Index</menutitle> + <menucomment>General index.</menucomment> + </menuentry> + </menu> + </unnumbered> + </node> + <node> + <nodename>Overview</nodename> + <nodenext>Starting & ending</nodenext> + <nodeprev>Top</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Overview of &latex;</title> + <para><indexterm index="cp">overview of &latex;</indexterm><indexterm index="cp">&latex; overview</indexterm> The &latex; command typesets a file of text using the &tex; program and the &latex; “macro package” for &tex;. To be more specific, it processes an input file containing the text of a document with interspersed commands that describe how the text should be formatted. It produces at least three files as output:</para> + <enumerate first="1"> + <item> + <para>A main output file, which is one of:</para> + <enumerate first="1"> + <item> + <para>If invoked as <command>latex</command>, a “Device Independent” (<file>.dvi</file>) file. This contains commands that can be translated into commands for a variety of output devices. You can view such <file>.dvi</file> output of &latex; by using a program such as <command>xdvi</command> (display directly) or <command>dvips</command> (convert to PostScript).</para> + </item> + <item> + <para>If invoked as <command>pdflatex</command>, a “Portable Document Format” (<file>.pdf</file>) file. Typically, this is a self-contained file, with all fonts and images embedded. This can be very useful, but it does make the output much larger than the <file>.dvi</file> produced from the same document.</para> + </item> + </enumerate> + <para>There are other less-common variants of &latex; (and &tex;) as well, which can produce HTML, XML, and other things.</para> + </item> + <item> + <para>A “transcript” or <file>.log</file> file that contains summary information and diagnostic messages for any errors discovered in the input file.</para> + </item> + <item> + <para>An “auxiliary” or <file>.aux</file> file. This is used by &latex; itself, for things such as sectioning.</para> + </item> + </enumerate> + <para>A &latex; command begins with the command name, which consists of a <code>\</code> followed by either (a) a string of letters or (b) a single non-letter. Arguments contained in square brackets, <code>[]</code>, are optional while arguments contained in braces, <code>{}</code>, are required.</para> + <para>&latex; is case sensitive. Enter all commands in lower case unless explicitly directed to do otherwise.</para> + </chapter> + </node> + <node> + <nodename>Starting & ending</nodename> + <nodenext>Document classes</nodenext> + <nodeprev>Overview</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Starting & ending</title> + <para><indexterm index="cp">starting & ending</indexterm><indexterm index="cp">ending & starting</indexterm> A minimal input file looks like the following:</para> + <example xml:space="preserve">\documentclass{<var>class</var>} +\begin{document} +<var>your text</var> +\end{document}</example> + <para role="continues">where the <var>class</var> is a valid document class for &latex;. See <xref><xrefnodename>Document classes</xrefnodename></xref>, for details of the various document classes available locally.</para> + <para><indexterm index="cp">preamble, defined</indexterm>You may include other &latex; commands between the <code>\documentclass</code> and the <code>\begin{document}</code> commands (this area is called the <dfn>preamble</dfn>).</para> + </chapter> + </node> + <node> + <nodename>Document classes</nodename> + <nodenext>Typefaces</nodenext> + <nodeprev>Starting & ending</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Document classes</title> + <para><indexterm index="cp">document classes</indexterm><indexterm index="cp">classes of documents</indexterm><indexterm index="fn">\documentclass</indexterm> The class of a given document is defined with the command:</para> + <example xml:space="preserve">\documentclass[<var>options</var>]{<var>class</var>}</example> + <para role="continues">The <code>\documentclass</code> command must be the first command in a &latex; source file.</para> + <para><indexterm index="fn">article <r>class</r></indexterm><indexterm index="fn">report <r>class</r></indexterm><indexterm index="fn">book <r>class</r></indexterm><indexterm index="fn">letter <r>class</r></indexterm><indexterm index="fn">slides <r>class</r></indexterm>Built-in &latex; document <var>class</var> names are (many other document classes are available as add-ons; see <xref><xrefnodename>Overview</xrefnodename></xref>):</para> + <example xml:space="preserve">article report book letter slides</example> +<!-- xx briefly describe each one --> + <para>Standard <var>options</var> are described below.</para> + <menu> + <menuentry> + <menunode>Document class options</menunode> + <menutitle>Document class options</menutitle> + <menucomment>Global options.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>Document class options</nodename> + <nodeup>Document classes</nodeup> + <section> + <title>Document class options</title> + <para><indexterm index="cp">document class options</indexterm><indexterm index="cp">options, document class</indexterm><indexterm index="cp">class options</indexterm><indexterm index="cp">global options</indexterm> 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 as usual. To specify more than one <var>option</var>, separate them with a comma:</para> + <example xml:space="preserve">\documentclass[<var>option1</var>,<var>option2</var>,...]{<var>class</var>}</example> + <para>Here is the list of the standard class options.</para> + <para><indexterm index="fn">10pt <r>option</r></indexterm><indexterm index="fn">11pt <r>option</r></indexterm><indexterm index="fn">12pt <r>option</r></indexterm>All of the standard classes except <code>slides</code> accept the following options for selecting the typeface size (default is <code>10pt</code>):</para> + <example xml:space="preserve">10pt 11pt 12pt</example> + <para><indexterm index="fn">a4paper <r>option</r></indexterm><indexterm index="fn">a5paper <r>option</r></indexterm><indexterm index="fn">b5paper <r>option</r></indexterm><indexterm index="fn">executivepaper <r>option</r></indexterm><indexterm index="fn">legalpaper <r>option</r></indexterm><indexterm index="fn">letterpaper <r>option</r></indexterm>All of the standard classes accept these options for selecting the paper size (default is <code>letterpaper</code>):</para> + <example xml:space="preserve">a4paper a5paper b5paper executivepaper legalpaper letterpaper</example> + <para><indexterm index="fn">draft <r>option</r></indexterm><indexterm index="fn">final <r>option</r></indexterm><indexterm index="fn">fleqn <r>option</r></indexterm><indexterm index="fn">landscape <r>option</r></indexterm><indexterm index="fn">leqno <r>option</r></indexterm><indexterm index="fn">openbib <r>option</r></indexterm><indexterm index="fn">titlepage <r>option</r></indexterm><indexterm index="fn">notitlepage <r>option</r></indexterm>Miscellaneous other options:</para> + <table> + <tableitem> + <tableterm><code>draft, final</code></tableterm><indexterm index="cp">black boxes, omitting</indexterm> + <item> + <para>mark/do not mark overfull boxes with a big black box; default is <code>final</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>fleqn</code></tableterm> + <item> + <para>Put displayed formulas flush left; default is centered.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>landscape</code></tableterm> + <item> + <para>Selects landscape format; default is portrait.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>leqno</code></tableterm> + <item> + <para>Put equation numbers on the left side of equations; default is the right side.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>openbib</code></tableterm> + <item> + <para>Use “open” bibliography format.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>titlepage, notitlepage</code></tableterm> + <item> + <para>Specifies whether the title page is separate; default depends on the class.</para> + </item> + </tableitem> + </table> + <para>These options are not available with the slides class:</para> + <para><indexterm index="fn">onecolumn <r>option</r></indexterm><indexterm index="fn">twocolumn <r>option</r></indexterm><indexterm index="fn">oneside <r>option</r></indexterm><indexterm index="fn">twoside <r>option</r></indexterm><indexterm index="fn">openright <r>option</r></indexterm><indexterm index="fn">openany <r>option</r></indexterm></para> + <table> + <tableitem> + <tableterm><code>onecolumn</code></tableterm> + <tableterm><code>twocolumn</code></tableterm> + <item> + <para>Typeset in one or two columns; default is <code>onecolumn</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>oneside</code></tableterm> + <tableterm><code>twoside</code></tableterm><indexterm index="fn">\evensidemargin</indexterm><indexterm index="fn">\oddsidemargin</indexterm> + <item> + <para>Selects one- or two-sided layout; default is <code>oneside</code>, except for the <code>book</code> class.</para> + <para>The <code>\evensidemargin</code> (<code>\oddsidemargin</code> parameter determines the distance on even (odd) numbered pages between the left side of the page and the text's left margin. The defaults vary with the paper size and whether one- or two-side layout is selected. For one-sided printing the text is centered, for two-sided, <code>\oddsidemargin</code> is 40% of the difference between <code>\paperwidth</code> and <code>\textwidth</code> with <code>\evensidemargin</code> the remainder.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>openright</code></tableterm> + <tableterm><code>openany</code></tableterm> + <item> + <para>Determines if a chapter should start on a right-hand page; default is <code>openright</code> for book.</para> + </item> + </tableitem> + </table> + <para>The <code>slides</code> class offers the option <code>clock</code> for printing the time at the bottom of each note.</para> + <para><indexterm index="cp">packages, loading</indexterm><indexterm index="cp">loading additional packages</indexterm><indexterm index="fn">\usepackage</indexterm>Additional packages are loaded like this:</para> + <example xml:space="preserve">\usepackage[<var>options</var>]{<var>pkg</var>}</example> + <para>To specify more than one <var>pkg</var>, you can separate them with a comma, or use multiple <code>\usepackage</code> commands.</para> + <para><indexterm index="cp">global options</indexterm><indexterm index="cp">options, global</indexterm>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>.</para> + </section> + </node> + <node> + <nodename>Typefaces</nodename> + <nodenext>Layout</nodenext> + <nodeprev>Document classes</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Typefaces</title> + <para><indexterm index="cp">typefaces</indexterm><indexterm index="cp">fonts</indexterm> 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.</para> + <menu> + <menuentry> + <menunode>Font styles</menunode> + <menutitle>Font styles</menutitle> + <menucomment>Select roman, italics etc.</menucomment> + </menuentry> + <menuentry> + <menunode>Font sizes</menunode> + <menutitle>Font sizes</menutitle> + <menucomment>Select point size.</menucomment> + </menuentry> + <menuentry> + <menunode>Low-level font commands</menunode> + <menutitle>Low-level font commands</menutitle> + <menucomment>Select encoding, family, series, shape.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>Font styles</nodename> + <nodenext>Font sizes</nodenext> + <nodeup>Typefaces</nodeup> + <section> + <title>Font styles</title> + <para><indexterm index="cp">font styles</indexterm><indexterm index="cp">typeface styles</indexterm><indexterm index="cp">styles of text</indexterm> The following type style commands are supported by &latex;.</para> + <para>These commands are used like <code>\textit{italic text}</code>. 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.</para> + <para>The declaration forms are cumulative; i.e., you can say either <code>\sffamily\bfseries</code> or <code>\bfseries\sffamily</code> to get bold sans serif.</para> + <para>You can also use the environment form of the declaration forms; for instance, <code>\begin{ttfamily}...\end{ttfamily}</code>.</para> + <table> + <tableitem> + <tableterm><code>\textrm (\rmfamily)</code></tableterm><indexterm index="fn">\textrm</indexterm><indexterm index="fn">\rmfamily</indexterm> + <item> + <para>Roman.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textit (\itshape)</code></tableterm><indexterm index="fn">\textit</indexterm><indexterm index="fn">\itshape</indexterm> + <item> + <para>Italics.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\emph</code></tableterm><indexterm index="fn">\emph</indexterm><indexterm index="cp">emphasis</indexterm> + <item> + <para>Emphasis (switches between <code>\textit</code> and <code>\textrm</code>).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textmd (\mdseries)</code></tableterm><indexterm index="fn">\textmd</indexterm><indexterm index="fn">\mdseries</indexterm> + <item> + <para>Medium weight (default).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textbf (\bfseries)</code></tableterm><indexterm index="fn">\textbf</indexterm><indexterm index="fn">\bfseries</indexterm> + <item> + <para>Boldface.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textup (\upshape)</code></tableterm><indexterm index="fn">\textup</indexterm><indexterm index="fn">\upshape</indexterm> + <item> + <para>Upright (default). The opposite of slanted.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textsl (\slshape)</code></tableterm><indexterm index="fn">\textsl</indexterm><indexterm index="fn">\slshape</indexterm> + <item> + <para>Slanted.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textsf (\sffamily)</code></tableterm><indexterm index="fn">\textsf</indexterm><indexterm index="fn">\sffamily</indexterm> + <item> + <para>Sans serif.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textsc (\scshape)</code></tableterm><indexterm index="fn">\textsc</indexterm><indexterm index="fn">\scshape</indexterm> + <item> + <para>Small caps.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\texttt (\ttfamily)</code></tableterm><indexterm index="fn">\texttt</indexterm><indexterm index="fn">\ttfamily</indexterm> + <item> + <para>Typewriter.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\textnormal (\normalfont)</code></tableterm><indexterm index="fn">\textnormal</indexterm><indexterm index="fn">\normalfont</indexterm> + <item> + <para>Main document font.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\mathrm</code></tableterm><indexterm index="fn">\mathrm</indexterm> + <item> + <para>Roman, for use in math mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\mathbf</code></tableterm><indexterm index="fn">\mathbf</indexterm> + <item> + <para>Boldface, for use in math mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\mathsf</code></tableterm><indexterm index="fn">\mathsf</indexterm> + <item> + <para>Sans serif, for use in math mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\mathtt</code></tableterm><indexterm index="fn">\mathtt</indexterm> + <item> + <para>Typewriter, for use in math mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\mathit</code></tableterm> + <tableterm><code>(\mit)</code></tableterm> + <item> + <para>Italics, for use in math mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\mathnormal</code></tableterm><indexterm index="fn">\mathnormal</indexterm> + <item> + <para>For use in math mode, e.g. inside another type style declaration.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\mathcal</code></tableterm><indexterm index="fn">\mathcal</indexterm> + <item> + <para>`Calligraphic' letters, for use in math mode.</para> + </item> + </tableitem> + </table> + <para>In addition, the command <code>\mathversion{bold}</code> <indexterm index="fn">\mathversion</indexterm>can be used for switching to bold letters and symbols in formulas. <code>\mathversion{normal}</code> restores the default.</para> + <para>&latex; also provides these commands, which unconditionally switch to the given style, that is, are <emph>not</emph> cumulative. They are used differently than the above commands, too: <code>{\<var>cmd</var> ...}</code> instead of <code>\<var>cmd</var>{...}</code>. These are two very different things.</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\bf</indexterm><code>\bf</code></tableterm><indexterm index="cp">bold font</indexterm> + <item> + <para>Switch to <b>bold face</b>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cal</indexterm><code>\cal</code></tableterm><indexterm index="cp">script letters for math</indexterm><indexterm index="cp">calligraphic letters for math</indexterm> + <item> + <para>Switch to calligraphic letters for math.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\em</indexterm><code>\em</code></tableterm><indexterm index="cp">emphasis</indexterm> + <item> + <para>Emphasis (italics within roman, roman within italics).</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\it</indexterm><code>\it</code></tableterm><indexterm index="cp">italic font</indexterm> + <item> + <para>Italics.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rm</indexterm><code>\rm</code></tableterm><indexterm index="cp">roman font</indexterm> + <item> + <para>Roman.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sc</indexterm><code>\sc</code></tableterm><indexterm index="cp">small caps font</indexterm> + <item> + <para>Small caps.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sf</indexterm><code>\sf</code></tableterm><indexterm index="cp">sans serif font</indexterm> + <item> + <para>Sans serif.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sl</indexterm><code>\sl</code></tableterm><indexterm index="cp">slanted font</indexterm><indexterm index="cp">oblique font</indexterm> + <item> + <para>Slanted (oblique).</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\tt</indexterm><code>\tt</code></tableterm><indexterm index="cp">typewriter font</indexterm><indexterm index="cp">monospace font</indexterm><indexterm index="cp">fixed-width font</indexterm> + <item> + <para>Typewriter (monospace, fixed-width).</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Font sizes</nodename> + <nodenext>Low-level font commands</nodenext> + <nodeprev>Font styles</nodeprev> + <nodeup>Typefaces</nodeup> + <section> + <title>Font sizes</title> + <para><indexterm index="cp">font sizes</indexterm><indexterm index="cp">typeface sizes</indexterm><indexterm index="cp">sizes of text</indexterm> The following standard type size commands are supported by &latex;. The table shows the command name and the corresponding actual font size used (in points) with the <samp>10pt</samp>, <samp>11pt</samp>, and <samp>12pt</samp> document size options, respectively (see <xref><xrefnodename>Document class options</xrefnodename></xref>).</para> + <para><indexterm index="fn">\tiny</indexterm><indexterm index="fn">\scriptsize</indexterm><indexterm index="fn">\footnotesize</indexterm><indexterm index="fn">\small</indexterm><indexterm index="fn">\normalsize</indexterm><indexterm index="fn">\large</indexterm><indexterm index="fn">\Large</indexterm><indexterm index="fn">\LARGE</indexterm><indexterm index="fn">\huge</indexterm><indexterm index="fn">\Huge</indexterm> </para> + <multitable> + <columnfraction>36</columnfraction> + <columnfraction>7</columnfraction> + <columnfraction>7</columnfraction> + <columnfraction>7</columnfraction> + <thead> + <row> + <entry>Command</entry> + <entry><code>10pt</code></entry> + <entry><code>11pt</code></entry> + <entry><code>12pt</code></entry> + </row> + </thead> + <tbody> + <row> + <entry><code>\tiny</code></entry> + <entry>5</entry> + <entry>6</entry> + <entry>6</entry> + </row> + <row> + <entry><code>\scriptsize</code></entry> + <entry>7</entry> + <entry>8</entry> + <entry>8</entry> + </row> + <row> + <entry><code>\footnotesize</code></entry> + <entry>8</entry> + <entry>9</entry> + <entry>10</entry> + </row> + <row> + <entry><code>\small</code></entry> + <entry>9</entry> + <entry>10</entry> + <entry>10.95</entry> + </row> + <row> + <entry><code>\normalsize</code> (default)</entry> + <entry>10</entry> + <entry>10.95</entry> + <entry>12</entry> + </row> + <row> + <entry><code>\large</code></entry> + <entry>12</entry> + <entry>12</entry> + <entry>14.4</entry> + </row> + <row> + <entry><code>\Large</code></entry> + <entry>14.4</entry> + <entry>14.4</entry> + <entry>17.28</entry> + </row> + <row> + <entry><code>\LARGE</code></entry> + <entry>17.28</entry> + <entry>17.28</entry> + <entry>20.74</entry> + </row> + <row> + <entry><code>\huge</code></entry> + <entry>20.74</entry> + <entry>20.74</entry> + <entry>24.88</entry> + </row> + <row> + <entry><code>\Huge</code></entry> + <entry>24.88</entry> + <entry>24.88</entry> + <entry>24.88</entry> + </row> + </tbody> + </multitable> + <para>The commands as listed here are “declaration forms”. The scope of the declaration form lasts until the next type style command or the end of the current group. You can also use the environment form of these commands; for instance, <code>\begin{tiny}...\end{tiny}</code>.</para> + </section> + </node> + <node> + <nodename>Low-level font commands</nodename> + <nodeprev>Font sizes</nodeprev> + <nodeup>Typefaces</nodeup> + <section> + <title>Low-level font commands</title> + <para><indexterm index="cp">low-level font commands</indexterm><indexterm index="cp">font commands, low-level</indexterm> These commands are primarily intended for writers of macros and packages. The commands listed here are only a subset of the available ones.</para> + <table> + <tableitem> + <tableterm><code>\fontencoding{enc}</code></tableterm><indexterm index="fn">\fontencoding</indexterm> + <item> + <para>Select font encoding. Valid encodings include <code>OT1</code> and <code>T1</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\fontfamily{family}</code></tableterm><indexterm index="fn">\fontfamily</indexterm> + <item> + <para>Select font family. Valid families include:</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para><code>cmr</code> for Computer Modern Roman</para> + </item> + <item> + <para><code>cmss</code> for Computer Modern Sans Serif</para> + </item> + <item> + <para><code>cmtt</code> for Computer Modern Typewriter</para> + </item> + </itemize> + <para>and numerous others.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\fontseries{series}</code></tableterm><indexterm index="fn">\fontseries</indexterm> + <item> + <para>Select font series. Valid series include:</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para><code>m</code> Medium (normal)</para> + </item> + <item> + <para><code>b</code> Bold</para> + </item> + <item> + <para><code>c</code> Condensed</para> + </item> + <item> + <para><code>bc</code> Bold condensed</para> + </item> + <item> + <para><code>bx</code> Bold extended</para> + </item> + </itemize> + <para>and various other combinations.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\fontshape{shape}</code></tableterm><indexterm index="fn">\fontshape</indexterm> + <item> + <para>Select font shape. Valid shapes are:</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para><code>n</code> Upright (normal)</para> + </item> + <item> + <para><code>it</code> Italic</para> + </item> + <item> + <para><code>sl</code> Slanted (oblique)</para> + </item> + <item> + <para><code>sc</code> Small caps</para> + </item> + <item> + <para><code>ui</code> Upright italics</para> + </item> + <item> + <para><code>ol</code> Outline</para> + </item> + </itemize> + <para>The two last shapes are not available for most font families.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\fontsize{size}{skip}</code></tableterm><indexterm index="fn">\fontsize</indexterm><indexterm index="fn">\baselineskip</indexterm> + <item> + <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> + <para><indexterm index="fn">\baselinestretch</indexterm><indexterm index="cp"><code>setspace</code> package</indexterm>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 <uref><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</urefurl></uref>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\selectfont</code></tableterm><indexterm index="fn">\selectfont</indexterm> + <item> + <para>The changes made by calling the four font commands described above do not come into effect until <code>\selectfont</code> is called.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\usefont{enc}{family}{series}{shape}</code></tableterm><indexterm index="fn">\usefont</indexterm> + <item> + <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>.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Layout</nodename> + <nodenext>Sectioning</nodenext> + <nodeprev>Typefaces</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Layout</title> + <para><indexterm index="cp">layout commands</indexterm> Miscellaneous commands for controlling the general layout of the page.</para> + <menu> + <menuentry> + <menunode>\onecolumn</menunode> + <menutitle>\onecolumn</menutitle> + <menucomment>Use one-column layout.</menucomment> + </menuentry> + <menuentry> + <menunode>\twocolumn</menunode> + <menutitle>\twocolumn</menutitle> + <menucomment>Use two-column layout.</menucomment> + </menuentry> + <menuentry> + <menunode>\flushbottom</menunode> + <menutitle>\flushbottom</menutitle> + <menucomment>Make all text pages the same height.</menucomment> + </menuentry> + <menuentry> + <menunode>\raggedbottom</menunode> + <menutitle>\raggedbottom</menutitle> + <menucomment>Allow text pages of differing height.</menucomment> + </menuentry> + <menuentry> + <menunode>Page layout parameters</menunode> + <menutitle>Page layout parameters</menutitle> + <menucomment>\headheight \footskip.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\onecolumn</nodename> + <nodenext>\twocolumn</nodenext> + <nodeup>Layout</nodeup> + <section> + <title><code>\onecolumn</code></title> + <para><indexterm index="fn">\onecolumn</indexterm><indexterm index="cp">one-column output</indexterm> The <code>\onecolumn</code> declaration starts a new page and produces single-column output. This is the default.</para> + </section> + </node> + <node> + <nodename>\twocolumn</nodename> + <nodenext>\flushbottom</nodenext> + <nodeprev>\onecolumn</nodeprev> + <nodeup>Layout</nodeup> + <section> + <title><code>\twocolumn</code></title> + <para><indexterm index="fn">\twocolumn</indexterm><indexterm index="cp">multicolumn text</indexterm><indexterm index="cp">two-column output</indexterm> Synopsis:</para> + <example xml:space="preserve">\twocolumn[<var>text1col</var>]</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.</para> + <para>These parameters control typesetting in two-column output:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\columnsep</indexterm><code>\columnsep</code></tableterm> + <item> + <para>The distance between columns (35pt by default).</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\columnseprule</indexterm><code>\columnseprule</code></tableterm> + <item> + <para>The width of the rule between columns; the default is 0pt, so there is no rule.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\columnwidth</indexterm><code>\columnwidth</code></tableterm> + <item> + <para>The width of the current column; this is equal to <code>\textwidth</code> in single-column text.</para> + </item> + </tableitem> + </table> + <para>These parameters control float behavior in two-column output:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\dbltopfraction</indexterm><code>\dbltopfraction</code></tableterm> + <item> + <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.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dblfloatpagefraction</indexterm><code>\dblfloatpagefraction</code></tableterm> + <item> + <para>The minimum fraction of a float page that must be occupied by floats, for a two-column float page. Default <samp>.5</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dblfloatsep</indexterm><code>\dblfloatsep</code></tableterm> + <item> + <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>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dbltextfloatsep</indexterm><code>\dbltextfloatsep</code></tableterm> + <item> + <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>.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\flushbottom</nodename> + <nodenext>\raggedbottom</nodenext> + <nodeprev>\twocolumn</nodeprev> + <nodeup>Layout</nodeup> + <section> + <title><code>\flushbottom</code></title> + <para><indexterm index="fn">\flushbottom</indexterm> The <code>\flushbottom</code> declaration makes all text pages the same height, adding extra vertical space where necessary to fill out the page.</para> + <para>This is the default if <code>twocolumn</code> mode is selected (see <xref><xrefnodename>Document class options</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>\raggedbottom</nodename> + <nodenext>Page layout parameters</nodenext> + <nodeprev>\flushbottom</nodeprev> + <nodeup>Layout</nodeup> + <section> + <title><code>\raggedbottom</code></title> + <para><indexterm index="fn">\raggedbottom</indexterm><indexterm index="cp">stretch, omitting vertical</indexterm> The <code>\raggedbottom</code> declaration makes all pages the natural height of the material on that page. No rubber lengths will be stretched.</para> + </section> + </node> + <node> + <nodename>Page layout parameters</nodename> + <nodeprev>\raggedbottom</nodeprev> + <nodeup>Layout</nodeup> + <section> + <title>Page layout parameters</title> + <para><indexterm index="cp">page layout parameters</indexterm><indexterm index="cp">parameters, page layout</indexterm><indexterm index="cp">layout, page parameters for</indexterm><indexterm index="cp">header, parameters for</indexterm><indexterm index="cp">footer, parameters for</indexterm><indexterm index="cp">running header and footer</indexterm></para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\headheight</indexterm><code>\headheight</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\headsep</indexterm><code>\headsep</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\footskip</indexterm><code>\footskip</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\linewidth</indexterm><code>\linewidth</code></tableterm> + <item> + <para>Width of the current line; 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>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\textheight</indexterm><code>\textheight</code></tableterm> + <item> + <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'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>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\textwidth</indexterm><code>\textwidth</code></tableterm> + <item> + <para>The normal horizontal width of the 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>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\topmargin</indexterm><code>\topmargin</code></tableterm> + <item> + <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 based on many other parameters: <code>\paperheight − 2in − \headheight − \headsep − \textheight − \footskip</code>, and then divided by two.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\topskip</indexterm><code>\topskip</code></tableterm> + <item> + <para>Minimum distance between the top of the page body and the baseline of the first line of text. For the standard clases, the default is the same as the font size, e.g., <samp>10pt</samp> at <samp>10pt</samp>.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Sectioning</nodename> + <nodenext>Cross references</nodenext> + <nodeprev>Layout</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Sectioning</title> + <para><indexterm index="cp">sectioning</indexterm> Sectioning commands provide the means to structure your text into units:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\part</indexterm><code>\part</code></tableterm> + <tableterm><indexterm index="fn">\chapter</indexterm><code>\chapter</code></tableterm> + <item> + <para>(report and book class only)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\section</indexterm><code>\section</code></tableterm> + <tableterm><indexterm index="fn">\subsection</indexterm><code>\subsection</code></tableterm> + <tableterm><indexterm index="fn">\subsubsection</indexterm><code>\subsubsection</code></tableterm> + <tableterm><indexterm index="fn">\paragraph</indexterm><code>\paragraph</code></tableterm> + <tableterm><indexterm index="fn">\subparagraph</indexterm><code>\subparagraph</code></tableterm> + </tableitem> + </table> + <para>All sectioning commands take the same general form, e.g.,</para> + <example xml:space="preserve">\chapter[<var>toctitle</var>]{<var>title</var>}</example> + <para>In addition to providing the heading <var>title</var> in the main text, the section title can appear in two other places:</para> + <enumerate first="1"> + <item> + <para>The table of contents.</para> + </item> + <item> + <para>The running head at the top of the page.</para> + </item> + </enumerate> + <para>You may not want the same text in these places as in the main text. To handle this, the sectioning commands have an optional argument <var>toctitle</var> that, when given, specifies the text for these other places.</para> + <para><indexterm index="cp">*-form of sectioning commands</indexterm>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:</para> + <example xml:space="preserve">\section*{Preamble}</example> + <para><indexterm index="fn">\appendix</indexterm><indexterm index="cp">appendix, creating</indexterm>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 command is something like</para> + <example xml:space="preserve">\chapter{A Chapter} +&dots; +\appendix +\chapter{The First Appendix}</example> + </chapter> + </node> + <node> + <nodename>Cross references</nodename> + <nodenext>Environments</nodenext> + <nodeprev>Sectioning</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Cross references</title> + <para><indexterm index="cp">cross references</indexterm> One reason for numbering things like figures and equations is to refer the reader to them, as in “See Figure 3 for more details.”</para> + <menu> + <menuentry> + <menunode>\label</menunode> + <menutitle>\label</menutitle> + <menucomment>Assign a symbolic name to a piece of text.</menucomment> + </menuentry> + <menuentry> + <menunode>\pageref</menunode> + <menutitle>\pageref</menutitle> + <menucomment>Refer to a page number.</menucomment> + </menuentry> + <menuentry> + <menunode>\ref</menunode> + <menutitle>\ref</menutitle> + <menucomment>Refer to a section, figure or similar.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\label</nodename> + <nodenext>\pageref</nodenext> + <nodeup>Cross references</nodeup> + <section> + <title><code>\label</code></title> + <para><indexterm index="fn">\label</indexterm> Synopsis:</para> + <example xml:space="preserve">\label{<var>key</var>}</example> + <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>.</para> + <para>A <var>key</var> name can consist of any sequence of letters, digits, or punctuation characters. Upper and lowercase letters are distinguished.</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> + <table> + <tableitem> + <tableterm><code>ch</code></tableterm> + <item> + <para>for chapters</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>sec</code></tableterm> + <item> + <para>for lower-level sectioning commands</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>fig</code></tableterm> + <item> + <para>for figures</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>tab</code></tableterm> + <item> + <para>for tables</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>eq</code></tableterm> + <item> + <para>for equations</para> + </item> + </tableitem> + </table> + <para>Thus, a label for a figure would look like <code>fig:snark</code> or <code>fig.snark</code>.</para> + </section> + </node> + <node> + <nodename>\pageref</nodename> + <nodenext>\ref</nodenext> + <nodeprev>\label</nodeprev> + <nodeup>Cross references</nodeup> + <section> + <title><code>\pageref{<var>key</var>}</code></title> + <para><indexterm index="fn">\pageref</indexterm><indexterm index="cp">cross referencing with page number</indexterm><indexterm index="cp">page number, cross referencing</indexterm> Synopsis:</para> + <example xml:space="preserve">\pageref{<var>key</var>}</example> + <para>The <code>\pageref</code>{<var>key</var>} command produces the page number of the place in the text where the corresponding <code>\label</code>{<var>key</var>} command appears.</para> + </section> + </node> + <node> + <nodename>\ref</nodename> + <nodeprev>\pageref</nodeprev> + <nodeup>Cross references</nodeup> + <section> + <title><code>\ref{<var>key</var>}</code></title> + <para><indexterm index="fn">\ref</indexterm><indexterm index="cp">cross referencing, symbolic</indexterm><indexterm index="cp">section number, cross referencing</indexterm><indexterm index="cp">equation number, cross referencing</indexterm><indexterm index="cp">figure number, cross referencing</indexterm><indexterm index="cp">footnote number, cross referencing</indexterm> Synopsis:</para> + <example xml:space="preserve">\ref{<var>key</var>}</example> + <para>The <code>\ref</code> command produces the number of the sectional unit, equation, footnote, figure, &dots;, of the corresponding <code>\label</code> command (see <xref><xrefnodename>\label</xrefnodename></xref>). It does not produce any text, such as the word `Section' or `Figure', just the bare number itself.</para> + </section> + </node> + <node> + <nodename>Environments</nodename> + <nodenext>Line breaking</nodenext> + <nodeprev>Cross references</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Environments</title> + <para><indexterm index="cp">environments</indexterm> <indexterm index="fn">\begin</indexterm><indexterm index="fn">\end</indexterm> &latex; provides many environments for marking off certain text. Each environment begins and ends in the same manner:</para> + <example xml:space="preserve">\begin{<var>envname</var>} +... +\end{<var>envname</var>}</example> + <menu> + <menuentry> + <menunode>abstract</menunode> + <menutitle>abstract</menutitle> + <menucomment>Produce an abstract.</menucomment> + </menuentry> + <menuentry> + <menunode>array</menunode> + <menutitle>array</menutitle> + <menucomment>Math arrays.</menucomment> + </menuentry> + <menuentry> + <menunode>center</menunode> + <menutitle>center</menutitle> + <menucomment>Centred lines.</menucomment> + </menuentry> + <menuentry> + <menunode>description</menunode> + <menutitle>description</menutitle> + <menucomment>Labelled lists.</menucomment> + </menuentry> + <menuentry> + <menunode>displaymath</menunode> + <menutitle>displaymath</menutitle> + <menucomment>Formulas that appear on their own line.</menucomment> + </menuentry> + <menuentry> + <menunode>document</menunode> + <menutitle>document</menutitle> + <menucomment>Enclose the whole document.</menucomment> + </menuentry> + <menuentry> + <menunode>enumerate</menunode> + <menutitle>enumerate</menutitle> + <menucomment>Numbered lists.</menucomment> + </menuentry> + <menuentry> + <menunode>eqnarray</menunode> + <menutitle>eqnarray</menutitle> + <menucomment>Sequences of aligned equations.</menucomment> + </menuentry> + <menuentry> + <menunode>equation</menunode> + <menutitle>equation</menutitle> + <menucomment>Displayed equation.</menucomment> + </menuentry> + <menuentry> + <menunode>figure</menunode> + <menutitle>figure</menutitle> + <menucomment>Floating figures.</menucomment> + </menuentry> + <menuentry> + <menunode>flushleft</menunode> + <menutitle>flushleft</menutitle> + <menucomment>Flushed left lines.</menucomment> + </menuentry> + <menuentry> + <menunode>flushright</menunode> + <menutitle>flushright</menutitle> + <menucomment>Flushed right lines.</menucomment> + </menuentry> + <menuentry> + <menunode>itemize</menunode> + <menutitle>itemize</menutitle> + <menucomment>Bulleted lists.</menucomment> + </menuentry> + <menuentry> + <menunode>letter</menunode> + <menutitle>letter</menutitle> + <menucomment>Letters.</menucomment> + </menuentry> + <menuentry> + <menunode>list</menunode> + <menutitle>list</menutitle> + <menucomment>Generic list environment.</menucomment> + </menuentry> + <menuentry> + <menunode>math</menunode> + <menutitle>math</menutitle> + <menucomment>In-line math.</menucomment> + </menuentry> + <menuentry> + <menunode>minipage</menunode> + <menutitle>minipage</menutitle> + <menucomment>Miniature page.</menucomment> + </menuentry> + <menuentry> + <menunode>picture</menunode> + <menutitle>picture</menutitle> + <menucomment>Picture with text, arrows, lines and circles.</menucomment> + </menuentry> + <menuentry> + <menunode>quotation</menunode> + <menutitle>quotation</menutitle> + <menucomment>Indented environment with paragraph indentation.</menucomment> + </menuentry> + <menuentry> + <menunode>quote</menunode> + <menutitle>quote</menutitle> + <menucomment>Indented environment with no paragraph indentation.</menucomment> + </menuentry> + <menuentry> + <menunode>tabbing</menunode> + <menutitle>tabbing</menutitle> + <menucomment>Align text arbitrarily.</menucomment> + </menuentry> + <menuentry> + <menunode>table</menunode> + <menutitle>table</menutitle> + <menucomment>Floating tables.</menucomment> + </menuentry> + <menuentry> + <menunode>tabular</menunode> + <menutitle>tabular</menutitle> + <menucomment>Align text in columns.</menucomment> + </menuentry> + <menuentry> + <menunode>thebibliography</menunode> + <menutitle>thebibliography</menutitle> + <menucomment>Bibliography or reference list.</menucomment> + </menuentry> + <menuentry> + <menunode>theorem</menunode> + <menutitle>theorem</menutitle> + <menucomment>Theorems, lemmas, etc.</menucomment> + </menuentry> + <menuentry> + <menunode>titlepage</menunode> + <menutitle>titlepage</menutitle> + <menucomment>For hand crafted title pages.</menucomment> + </menuentry> + <menuentry> + <menunode>verbatim</menunode> + <menutitle>verbatim</menutitle> + <menucomment>Simulating typed input.</menucomment> + </menuentry> + <menuentry> + <menunode>verse</menunode> + <menutitle>verse</menutitle> + <menucomment>For poetry and other things.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>abstract</nodename> + <nodenext>array</nodenext> + <nodeup>Environments</nodeup> + <section> + <title><code>abstract</code></title> + <para><indexterm index="fn">abstract <r>environment</r></indexterm><indexterm index="cp">abstracts</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{abstract} +... +\end{abstract}</example> + <para>Environment for producing an abstract, possibly of multiple paragraphs.</para> + </section> + </node> + <node> + <nodename>array</nodename> + <nodenext>center</nodenext> + <nodeprev>abstract</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>array</code></title> + <para><indexterm index="fn">array <r>environment</r></indexterm><indexterm index="cp">arrays, math</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{array}{<var>template</var>} +<var>col1 text</var>&<var>col1 text</var>&<var>coln</var>}\\ +... +\end{array}</example> + <para>Math arrays are produced with the <code>array</code> environment, normally within an <code>equation</code> environment (see <xref><xrefnodename>equation</xrefnodename></xref>). 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 that row should be formatted, as follows:</para> + <table> + <tableitem> + <tableterm><code>c</code></tableterm> + <item> + <para>centered</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>l</code></tableterm> + <item> + <para>flush left</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>r</code></tableterm> + <item> + <para>flush right</para> + </item> + </tableitem> + </table> + <para><indexterm index="fn">\\ (for <code>array</code>)</indexterm>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> + <para><indexterm index="fn">@{...}</indexterm>In the template, the construct <code>@{<var>text</var>}</code> puts <var>text</var> between columns in each row.</para> + <para>Here's an example:</para> + <example xml:space="preserve">\begin{equation} + \begin{array}{lrc} + left1 & right1 & centered1 \\ + left2 & right2 & centered2 \\ + \end{array} +\end{equation}</example> + <para><indexterm index="fn">\arraycolsep</indexterm>The <code>\arraycolsep</code> parameter defines half the width of the space separating columns; the default is <samp>5pt</samp>. See <xref><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> + <node> + <nodename>center</nodename> + <nodenext>description</nodenext> + <nodeprev>array</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>center</code></title> + <para><indexterm index="fn">center <r>environment</r></indexterm><indexterm index="cp">centering text, environment for</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{center} +<var>line1</var> \\ +<var>line2</var> \\ +\end{center}</example> + <para><indexterm index="fn">\\ (for <code>center</code>)</indexterm>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> + <menu> + <menuentry> + <menunode>\centering</menunode> + <menutitle>\centering</menutitle> + <menucomment>Declaration form of the <code>center</code> environment.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\centering</nodename> + <nodeup>center</nodeup> + <subsection> + <title><code>\centering</code></title> + <para><indexterm index="fn">\centering</indexterm><indexterm index="cp">centering text, declaration for</indexterm> 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> + <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'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> + <para>Here's an example:</para> + <example xml:space="preserve">\begin{quote} +\centering +first line \\ +second line \\ +\end{quote}</example> + </subsection> + </node> + <node> + <nodename>description</nodename> + <nodenext>displaymath</nodenext> + <nodeprev>center</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>description</code></title> + <para><indexterm index="fn">description <r>environment</r></indexterm><indexterm index="cp">labelled lists, creating</indexterm><indexterm index="cp">description lists, creating</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{description} +\item [<var>label1</var>] <var>item1</var> +\item [<var>label2</var>] <var>item2</var> +... +\end{description}</example> + <para><indexterm index="fn">\item</indexterm>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> + <para><indexterm index="cp">bold typewriter, avoiding</indexterm><indexterm index="cp">typewriter labels in lists</indexterm>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>.</para> + <para>For details about list spacing, see <xref><xrefnodename>itemize</xrefnodename></xref>.</para> + </section> + </node> + <node> + <nodename>displaymath</nodename> + <nodenext>document</nodenext> + <nodeprev>description</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>displaymath</code></title> + <para><indexterm index="fn">displaymath <r>environment</r></indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{displaymath} +<var>math</var> +\end{displaymath}</example> + <para role="continues">or</para> + <example xml:space="preserve">\[<var>math</var>\]</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 <xref><xrefnodename>Document class options</xrefnodename></xref>.</para> + <para>No equation number is added to <code>displaymath</code> text; to get an equation number, use the <code>equation</code> environment (see <xref><xrefnodename>equation</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>document</nodename> + <nodenext>enumerate</nodenext> + <nodeprev>displaymath</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>document</code></title> + <para><indexterm index="fn">document <r>environment</r></indexterm> The <code>document</code> environment encloses the body of a document. It is required in every &latex; document. See <xref><xrefnodename>Starting & ending</xrefnodename></xref>.</para> + </section> + </node> + <node> + <nodename>enumerate</nodename> + <nodenext>eqnarray</nodenext> + <nodeprev>document</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>enumerate</code></title> + <para><indexterm index="fn">enumerate <r>environment</r></indexterm><indexterm index="cp">lists of items, numbered</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{enumerate} +\item <var>item1</var> +\item <var>item2</var> +... +\end{enumerate}</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> (see <xref><xrefnodename>itemize</xrefnodename></xref>) and <code>description</code> (see <xref><xrefnodename>description</xrefnodename></xref>).</para> + <para><indexterm index="fn">\item</indexterm>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.</para> + <para>By default, the numbering at each level is done like this:</para> + <enumerate first="1"> + <item> + <para>1., 2., &dots;</para> + </item> + <item> + <para>(a), (b), &dots;</para> + </item> + <item> + <para>i., ii., &dots;</para> + </item> + <item> + <para>A., B., &dots;</para> + </item> + </enumerate> + <para><indexterm index="fn">\enumi</indexterm><indexterm index="fn">\enumii</indexterm><indexterm index="fn">\enumiii</indexterm><indexterm index="fn">\enumiv</indexterm>The <code>enumerate</code> environment uses the counters <code>\enumi</code> through <code>\enumiv</code> counters (see <xref><xrefnodename>Counters</xrefnodename></xref>). If the optional argument to <code>\item</code> is given, the counter is not incremented for that item.</para> + <para><indexterm index="fn">\labelenumi</indexterm><indexterm index="fn">\labelenumii</indexterm><indexterm index="fn">\labelenumiii</indexterm><indexterm index="fn">\labelenumiv</indexterm>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 <xref><xrefnodename>\newcommand & \renewcommand</xrefnodename></xref>). For instance, to have the first level use uppercase letters:</para> + <para><indexterm index="fn">\Alph <r>example</r></indexterm></para> + <example xml:space="preserve">\renewcommand{\labelenumi}{\Alph{enumi}}</example> + </section> + </node> + <node> + <nodename>eqnarray</nodename> + <nodenext>equation</nodenext> + <nodeprev>enumerate</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>eqnarray</code></title> + <para><indexterm index="fn">eqnarray <r>environment</r></indexterm><indexterm index="cp">equations, aligning</indexterm><indexterm index="cp">aligning Equations</indexterm></para> + <example xml:space="preserve">\begin{eqnarray} <r>(or <code>eqnarray*</code>)</r> +<var>formula1</var> \\ +<var>formula2</var> \\ +... +\end{eqnarray}</example> + <para><indexterm index="fn">\\ (for <code>eqnarray</code>)</indexterm>The <code>eqnarray</code> environment is used to display a sequence of equations or inequalities. It is very much like 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> + <para><indexterm index="fn">\\* (for <code>eqnarray</code>)</indexterm><code>\\*</code> can also be used to separate equations, with its normal meaning of not allowing a page break at that line.</para> + <para><indexterm index="fn">\nonumber</indexterm><indexterm index="cp">equation numbers, omitting</indexterm>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>.</para> + <para><indexterm index="fn">\lefteqn</indexterm>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> + </section> + </node> + <node> + <nodename>equation</nodename> + <nodenext>figure</nodenext> + <nodeprev>eqnarray</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>equation</code></title> + <para><indexterm index="fn">equation <r>environment</r></indexterm><indexterm index="cp">equations, environment for</indexterm><indexterm index="cp">formulas, environment for</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{equation} +<var>math</var> +\end{equation}</example> + <para>The <code>equation</code> environment starts a <code>displaymath</code> environment (see <xref><xrefnodename>displaymath</xrefnodename></xref>), e.g., centering the <var>math</var> text on the page, and also places an equation number in the right margin.</para> + </section> + </node> + <node> + <nodename>figure</nodename> + <nodenext>flushleft</nodenext> + <nodeprev>equation</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>figure</code></title> + <para><indexterm index="fn">figure</indexterm><indexterm index="cp">inserting figures</indexterm><indexterm index="cp">figures, inserting</indexterm></para> + <example xml:space="preserve">\begin{figure}[<var>placement</var>] +<var>figbody</var> +\label{<var>label}</var> +\caption[<var>loftitle</var>]{<var>text</var>} +\end{figure}</example> + <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>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> + <enumerate first="1"> + <item> + <para><code>h</code> (Here) - at the position in the text where the figure environment appears.</para> + </item> + <item> + <para><code>t</code> (Top) - at the top of a text page.</para> + </item> + <item> + <para><code>b</code> (Bottom) - at the bottom of a text page.</para> + </item> + <item> + <para><code>p</code> (Page of floats) - on a separate float page, which is a page containing no text, only floats.</para> + </item> + </enumerate> + <para>The standard report and article classes use the default placement <code>tbp</code>.</para> + <para>The body of the figure is made up of whatever text, &latex; commands, etc. you wish.</para> + <para><indexterm index="fn">\caption</indexterm>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 <xref><xrefnodename>Tables of contents</xrefnodename></xref>).</para> +<!-- xx float-placement, float-caption sections? --> + <table><indexterm index="fn">\bottomfraction</indexterm>The maximum fraction of the page allowed to be occuped by floats atthe bottom; default <samp>.3</samp>. + <tableitem> + <tableterm><indexterm index="fn">\floatpagefraction</indexterm><code>\floatpagefraction</code></tableterm> + <item> + <para>The minimum fraction of a float page that must be occupied by floats; default <samp>.5</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\floatsep</indexterm><code>\floatsep</code></tableterm> + <item> + <para>Space between floats at the top or bottom of a page; default <samp>12pt plus2pt minus2pt</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\intextsep</indexterm><code>\intextsep</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\textfloatsep</indexterm><code>\textfloatsep</code></tableterm> + <item> + <para>Space between the last (first) float at the top (bottom) of a page; default <samp>20pt plus2pt minus4pt</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\textfraction</indexterm><code>\textfraction</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\topfraction</indexterm><code>\topfraction</code></tableterm> + <item> + <para>Maximum fraction at the top of a page that may be occupied before floats; default is <samp>.7</samp>.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>flushleft</nodename> + <nodenext>flushright</nodenext> + <nodeprev>figure</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>flushleft</code></title> + <para><indexterm index="fn">flushleft <r>environment</r></indexterm><indexterm index="cp">left-justifying text, environment for</indexterm><indexterm index="cp">ragged right text, environment for</indexterm></para> + <example xml:space="preserve">\begin{flushleft} +<var>line1</var> \\ +<var>line2</var> \\ +... +\end{flushleft}</example> + <para><indexterm index="fn">\\ <r>for <code>flushleft</code></r></indexterm>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>.</para> + <menu> + <menuentry> + <menunode>\raggedright</menunode> + <menutitle>\raggedright</menutitle> + <menucomment>Declaration form of the <code>flushleft</code> environment.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\raggedright</nodename> + <nodeup>flushleft</nodeup> + <subsection> + <title><code>\raggedright</code></title> + <para><indexterm index="fn">\raggedright</indexterm><indexterm index="cp">ragged right text</indexterm><indexterm index="cp">left-justifying text</indexterm><indexterm index="cp">justification, ragged right</indexterm> The <code>\raggedright</code> declaration corresponds to the <code>flushleft</code> environment. This declaration can be used inside an environment such as <code>quote</code> or in a <code>parbox</code>.</para> + <para>Unlike the <code>flushleft</code> environment, the <code>\raggedright</code> command does not start a new paragraph; it only 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 that ends the paragraph unit.</para> + </subsection> + </node> + <node> + <nodename>flushright</nodename> + <nodenext>itemize</nodenext> + <nodeprev>flushleft</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>flushright</code></title> + <para><indexterm index="fn">flushright <r>environment</r></indexterm><indexterm index="cp">ragged left text, environment for</indexterm><indexterm index="cp">right-justifying text, environment for</indexterm></para> + <example xml:space="preserve">\begin{flushright} +<var>line1</var> \\ +<var>line2</var> \\ +... +\end{flushright}</example> + <para><indexterm index="fn">\\ (for <code>flushright</code>)</indexterm>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>.</para> + <menu> + <menuentry> + <menunode>\raggedleft</menunode> + <menutitle>\raggedleft</menutitle> + <menucomment>Declaration form of the <code>flushright</code> environment.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\raggedleft</nodename> + <nodeup>flushright</nodeup> + <subsection> + <title><code>\raggedleft</code></title> + <para><indexterm index="fn">\raggedleft</indexterm><indexterm index="cp">ragged left text</indexterm><indexterm index="cp">justification, ragged left</indexterm><indexterm index="cp">right-justifying text</indexterm> The <code>\raggedleft</code> declaration corresponds to the <code>flushright</code> environment. This declaration can be used inside an environment such as <code>quote</code> or in a <code>parbox</code>.</para> + <para>Unlike the <code>flushright</code> environment, the <code>\raggedleft</code> command does not start a new paragraph; it only 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 that ends the paragraph unit.</para> + </subsection> + </node> + <node> + <nodename>itemize</nodename> + <nodenext>letter</nodenext> + <nodeprev>flushright</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>itemize</code></title> + <para><indexterm index="fn">itemize <r>environment</r></indexterm><indexterm index="fn">\item</indexterm><indexterm index="cp">lists of items</indexterm><indexterm index="cp">unordered lists</indexterm><indexterm index="cp">bulleted lists</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{itemize} +\item <var>item1</var> +\item <var>item2</var> +... +\end{itemize}</example> + <para>The <code>itemize</code> environment produces an “unordered”, “bulleted” list. Itemizations can be nested within one another, up to four levels deep. They can also be nested within other paragraph-making environments, such as <code>enumerate</code> (see <xref><xrefnodename>enumerate</xrefnodename></xref>).</para> + <para>Each item of an <code>itemize</code> list begins with an <code>\item</code> command. There must be at least one <code>\item</code> command within the environment.</para> + <para>By default, the marks at each level look like this:</para> + <enumerate first="1"> + <item> + <para>•</para> + </item> + <item> + <para><b>--<!-- /@w --></b> (bold en-dash)</para> + </item> + <item> + <para>*</para> + </item> + <item> + <para>. (centered dot, rendered here as a period)</para> + </item> + </enumerate> + <para><indexterm index="fn">\labelitemi</indexterm><indexterm index="fn">\labelitemii</indexterm><indexterm index="fn">\labelitemiii</indexterm><indexterm index="fn">\labelitemiv</indexterm>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 the first level use diamonds:</para> + <example xml:space="preserve">\renewcommand{\labelitemi}{$\diamond$}</example> + <para><indexterm index="fn">\leftmargin</indexterm><indexterm index="fn">\leftmargini</indexterm><indexterm index="fn">\leftmarginii</indexterm><indexterm index="fn">\leftmarginiii</indexterm><indexterm index="fn">\leftmarginiv</indexterm><indexterm index="fn">\leftmarginv</indexterm><indexterm index="fn">\leftmarginvi</indexterm>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 to the appropriate <code>\leftmargin<var>N</var></code> when a new level of nesting is entered.</para> + <para>The defaults vary from <samp>.5em</samp> (highest levels of nesting) to <samp>2.5em</samp> (first level), and are a bit reduced in two-column mode. This example greatly reduces the margin space for outermost lists:</para> + <example xml:space="preserve">\setlength{\leftmargini}{1.25em} % default 2.5em</example> +<!-- xx should be in its own generic section --> + <para>Some parameters that affect list formatting:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\itemindent</indexterm><code>\itemindent</code></tableterm> + <item> + <para>Extra indentation before each item in a list; default zero.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\labelsep</indexterm><code>\labelsep</code></tableterm> + <item> + <para>Space between the label and text of an item; default <samp>.5em</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\labelwidth</indexterm><code>\labelwidth</code></tableterm> + <item> + <para>Width of the label; default <samp>2em</samp>, or <samp>1.5em</samp> in two-column mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\listparindent</indexterm><code>\listparindent</code></tableterm> + <item> + <para>Extra indentation added to second and subsequent paragraphs within a list item; default <samp>0pt</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rightmargin</indexterm><code>\rightmargin</code></tableterm> + <item> + <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 to <code>\leftmargin</code>.</para> + </item> + </tableitem> + </table> + <para>Parameters affecting vertical spacing between list items (rather loose, by default).</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\itemsep</indexterm><code>\itemsep</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\parsep</indexterm><code>\parsep</code></tableterm> + <item> + <para>Extra vertical space between paragraphs within a list item. Defaults are the same as <code>\itemsep</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\topsep</indexterm><code>\topsep</code></tableterm> + <item> + <para>Vertical space between the first item and the preceding paragraph. The default is <code>4pt plus2pt minus2pt</code> for <code>10pt</code> documents, <code>6pt plus2pt minus2pt</code> for <code>11pt</code>, and <code>9pt plus3pt minus5pt</code> for <code>12pt</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\partopsep</indexterm><code>\partopsep</code></tableterm> + <item> + <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 plus2pt minus2pt</code> for <code>12pt</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\topsep</indexterm><code>\topsep</code></tableterm> + <item> + <para>Extra vertical space added before an initial and after a final list item. Its value is changed with list level and font size changes; for instance, within a first-level list at <samp>10pt</samp>, it is <samp>4pt plus2pt minus2pt</samp>.</para> + </item> + </tableitem> + </table> + <para><indexterm index="fn">\parskip <r>example</r></indexterm>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 within a single item (<code>\parskip</code> is not list-specific, see <xref><xrefnodename>\parskip</xrefnodename></xref>):</para> + <example xml:space="preserve">\newenvironment{itemize*}% + {\begin{itemize}% + \setlength{\itemsep}{0pt}% + \setlength{\parsep}{0pt}}% + \setlength{\parskip}{0pt}}% + {\end{itemize}}</example> + </section> + </node> + <node> + <nodename>letter</nodename> + <nodenext>list</nodenext> + <nodeprev>itemize</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>letter</code> environment: writing letters</title> + <para><indexterm index="fn">letter</indexterm> This environment is used for creating letters. See <xref><xrefnodename>Letters</xrefnodename></xref>.</para> + </section> + </node> + <node> + <nodename>list</nodename> + <nodenext>math</nodenext> + <nodeprev>letter</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>list</code></title> + <para><indexterm index="fn">list</indexterm><indexterm index="cp">lists of items, generic</indexterm> 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 documents, but often in macros.</para> + <example xml:space="preserve">\begin{list}{<var>labeling</var>}{<var>spacing</var>} +\item <var>item1</var> +\item <var>item2</var> +... +\end{list}</example> + <para>The mandatory <var>labeling</var> argument specifies how items should be labelled (unless the optional argument is supplied to <code>\item</code>). This argument is a piece of text that is inserted in a box to form the label. It can and usually does contain other &latex; commands.</para> + <para>The mandatory <var>spacing</var> argument contains commands to change the spacing parameters for the list. This argument will most often be empty, i.e., <code>{}</code>, which leaves the default spacing.</para> + </section> + </node> + <node> + <nodename>math</nodename> + <nodenext>minipage</nodenext> + <nodeprev>list</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>math</code></title> + <para><indexterm index="fn">math <r>environment</r></indexterm><indexterm index="cp">in-line formulas</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{math} +<var>math</var> +\end{math}</example> + <para>The <code>math</code> environment inserts the given <var>math</var> within the running text. <code>\(...\))</code> and <code>$...$</code> are synonyms. See <xref><xrefnodename>Math formulas</xrefnodename></xref>.</para> + </section> + </node> + <node> + <nodename>minipage</nodename> + <nodenext>picture</nodenext> + <nodeprev>math</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>minipage</code></title> + <para><indexterm index="fn">minipage <r>environment</r></indexterm><indexterm index="cp">minipage, creating a</indexterm></para> + <example xml:space="preserve">\begin{minipage}[<var>position</var>]{<var>width</var>} +<var>text</var> +\end{minipage}</example> + <para>The <code>minipage</code> environment typesets its body <var>text</var> in a block that will not be broken across pages (similar to the <code>\parbox</code> command, see <xref><xrefnodename>\parbox</xrefnodename></xref>). You may use other paragraph-making environments inside a minipage (unlike <code>\parbox</code>).</para> +<!-- (xxref positions) --> + <para>It takes an optional <var>position</var> argument for placing <var>text</var>, and a mandatory <var>width</var> argument for specifying the line width.</para> + <para><indexterm index="cp">indentation of paragraphs, in minipage</indexterm><indexterm index="cp">paragraph indentation, in minipage</indexterm><indexterm index="fn">\parindent</indexterm>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> + <para><indexterm index="cp">footnotes in figures</indexterm><indexterm index="cp">figures, footnotes in</indexterm>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 the bottom of the minipage instead of at the bottom of the page, and it uses the <code>\mpfootnote</code> counter instead of the ordinary <code>footnote</code> counter (see <xref><xrefnodename>Counters</xrefnodename></xref>).</para> + <para>However, don't put one minipage inside another if you are using footnotes; they may wind up at the bottom of the wrong minipage.</para> + </section> + </node> + <node> + <nodename>picture</nodename> + <nodenext>quotation</nodenext> + <nodeprev>minipage</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>picture</code></title> + <para><indexterm index="fn">picture</indexterm><indexterm index="cp">creating pictures</indexterm><indexterm index="cp">pictures, creating</indexterm></para> + <example xml:space="preserve">\begin{picture}(width,height)(x offset,y offset) +&dots; <var>picture commands</var> &dots; +\end{picture}</example> + <para><indexterm index="fn">\unitlength</indexterm>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 their coordinates. A coordinate is a number that may have a decimal point and a minus sign—a number like <code>5</code>, <code>0.3</code> or <code>-3.1416</code>. A coordinate specifies a length in multiples of the unit length <code>\unitlength</code>, so if <code>\unitlength</code> has been set to <code>1cm</code>, then the coordinate 2.54 specifies a length of 2.54 centimeters. You should only change the value of <code>\unitlength</code>, using the <code>\setlength</code> command, outside of a <code>picture</code> environment.</para> + <para>A position 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's x- and y-coordinates.</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 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</para> + <example xml:space="preserve"> \begin{picture}(100,200)(10,20)</example> + <para>produces a picture of width 100 millimeters and height 200 millimeters, whose lower-left corner is the point (10,20) and whose upper-right corner is therefore the point (110,220). When you first draw a picture, you will omit the optional argument, leaving the origin at the lower-left corner. If you then want to modify your picture by shifting everything, you just add the appropriate optional argument.</para> + <para>The environment's mandatory argument determines the nominal size of the picture. This need bear no relation to how large the picture really is; &latex; will happily allow you to put things outside the picture, or even off the page. The picture's nominal size is used by &latex; in determining how much room to leave for it.</para> + <para>Everything that appears in a picture is drawn by the <code>\put</code> command. The command</para> + <example xml:space="preserve">\put (11.3,-.3){...}</example> + <para role="continues">puts the object specified by <code>...</code> in the picture, with its reference point at coordinates <math>(11.3,-.3)</math>. The reference points for various objects will be described below.</para> + <para><indexterm index="fn">lR box</indexterm>The <code>\put</code> command creates an <dfn>LR box</dfn>. You can put anything that can go in an <code>\mbox</code> (see <xref><xrefnodename>\mbox</xrefnodename></xref>) in the text argument of the <code>\put</code> command. When you do this, the reference point will be the lower left corner of the box.</para> + <para>The <code>picture</code> commands are described in the following sections.</para> + <menu> + <menuentry> + <menunode>\circle</menunode> + <menutitle>\circle</menutitle> + <menucomment>Draw a circle.</menucomment> + </menuentry> + <menuentry> + <menunode>\makebox (picture)</menunode> + <menutitle>\makebox (picture)</menutitle> + <menucomment>Draw a box of the specified size.</menucomment> + </menuentry> + <menuentry> + <menunode>\framebox (picture)</menunode> + <menutitle>\framebox (picture)</menutitle> + <menucomment>Draw a box with a frame around it.</menucomment> + </menuentry> + <menuentry> + <menunode>\dashbox</menunode> + <menutitle>\dashbox</menutitle> + <menucomment>Draw a dashed box.</menucomment> + </menuentry> + <menuentry> + <menunode>\frame</menunode> + <menutitle>\frame</menutitle> + <menucomment>Draw a frame around an object.</menucomment> + </menuentry> + <menuentry> + <menunode>\line</menunode> + <menutitle>\line</menutitle> + <menucomment>Draw a straight line.</menucomment> + </menuentry> + <menuentry> + <menunode>\linethickness</menunode> + <menutitle>\linethickness</menutitle> + <menucomment>Set the line thickness.</menucomment> + </menuentry> + <menuentry> + <menunode>\thicklines</menunode> + <menutitle>\thicklines</menutitle> + <menucomment>A heavier line thickness.</menucomment> + </menuentry> + <menuentry> + <menunode>\thinlines</menunode> + <menutitle>\thinlines</menutitle> + <menucomment>The default line thickness.</menucomment> + </menuentry> + <menuentry> + <menunode>\multiput</menunode> + <menutitle>\multiput</menutitle> + <menucomment>Draw multiple instances of an object.</menucomment> + </menuentry> + <menuentry> + <menunode>\oval</menunode> + <menutitle>\oval</menutitle> + <menucomment>Draw an ellipse.</menucomment> + </menuentry> + <menuentry> + <menunode>\put</menunode> + <menutitle>\put</menutitle> + <menucomment>Place an object at a specified place.</menucomment> + </menuentry> + <menuentry> + <menunode>\shortstack</menunode> + <menutitle>\shortstack</menutitle> + <menucomment>Make a pile of objects.</menucomment> + </menuentry> + <menuentry> + <menunode>\vector</menunode> + <menutitle>\vector</menutitle> + <menucomment>Draw a line with an arrow.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\circle</nodename> + <nodenext>\makebox (picture)</nodenext> + <nodeup>picture</nodeup> + <subsection> + <title><code>\circle</code></title> + <para><indexterm index="fn">\circle</indexterm></para> + <example xml:space="preserve">\circle[*]{<var>diameter</var>}</example> + <para>The <code>\circle</code> command produces a circle with a diameter as close to the specified one as possible. The <code>*</code>-form of the command draws a solid circle.</para> + <para>Circles up to 40 pt can be drawn.</para> + </subsection> + </node> + <node> + <nodename>\makebox (picture)</nodename> + <nodenext>\framebox (picture)</nodenext> + <nodeprev>\circle</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\makebox</code></title> + <para><indexterm index="fn">\makebox (picture)</indexterm> <code>\makebox(width,height)[position]{...}</code></para> + <para>The <code>\makebox</code> command for the picture environment is similar to the normal <code>\makebox</code> command except that you must specify a <code>width</code> and <code>height</code> in multiples of <code>\unitlength</code>.</para> + <para>The optional argument, <code>[position]</code>, specifies the quadrant that your text appears in. You may select up to two of the following:</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para><code>t</code> - Moves the item to the top of the rectangle</para> + </item> + <item> + <para><code>b</code> - Moves the item to the bottom</para> + </item> + <item> + <para><code>l</code> - Moves the item to the left</para> + </item> + <item> + <para><code>r</code> - Moves the item to the right</para> + </item> + </itemize> + <para>See <xref><xrefnodename>\makebox</xrefnodename></xref>.</para> + </subsection> + </node> + <node> + <nodename>\framebox (picture)</nodename> + <nodenext>\dashbox</nodenext> + <nodeprev>\makebox (picture)</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\framebox</code></title> + <para><indexterm index="fn">\framebox</indexterm> Synopsis:</para> + <example xml:space="preserve">\framebox(<var>width</var>,<var>height</var>)[<var>pos</var>]{...}</example> + <para>The <code>\framebox</code> command is like <code>\makebox</code> (see previous section), except that it puts a frame around the outside of the box that it creates.</para> + <para><indexterm index="fn">\fboxrule</indexterm><indexterm index="fn">\fboxsep</indexterm>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.</para> + </subsection> + </node> + <node> + <nodename>\dashbox</nodename> + <nodenext>\frame</nodenext> + <nodeprev>\framebox (picture)</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\dashbox</code></title> + <para><indexterm index="fn">\dashbox</indexterm> Draws a box with a dashed line. Synopsis:</para> + <example xml:space="preserve">\dashbox{<var>dlen</var>}(<var>rwidth</var>,<var>rheight</var>)[<var>pos</var>]{<var>text</var>}</example> + <para><code>\dashbox</code> creates a dashed rectangle around <var>text</var> in a <code>picture</code> environment. Dashes are <var>dlen</var> units long, and the rectangle has overall width <var>rwidth</var> and height <var>rheight</var>. The <var>text</var> is positioned at optional <var>pos</var>. +<!-- xxref positions. --> A dashed box looks best when the <code>rwidth</code> and <code>rheight</code> are multiples of the <code>dlen</code>.</para> + </subsection> + </node> + <node> + <nodename>\frame</nodename> + <nodenext>\line</nodenext> + <nodeprev>\dashbox</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\frame</code></title> + <para><indexterm index="fn">\frame</indexterm> Synopsis:</para> + <example xml:space="preserve">\frame{<var>text</var>}</example> + <para>The <code>\frame</code> command puts a rectangular frame around <var>text</var>. The reference point is the bottom left corner of the frame. No extra space is put between the frame and the object.</para> + </subsection> + </node> + <node> + <nodename>\line</nodename> + <nodenext>\linethickness</nodenext> + <nodeprev>\frame</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\line</code></title> + <para><indexterm index="fn">\line</indexterm> Synopsis:</para> + <example xml:space="preserve">\line(<var>xslope</var>,<var>yslope</var>){<var>length</var>}</example> + <para>The <code>\line</code> command draws a line with the given <var>length</var> and slope <var>xslope</var>/<var>yslope</var>.</para> + <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, not to mention other shapes, see the <code>curve2e</code> and many many other packages on CTAN.</para> + </subsection> + </node> + <node> + <nodename>\linethickness</nodename> + <nodenext>\thicklines</nodenext> + <nodeprev>\line</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\linethickness</code></title> + <para><indexterm index="fn">\linethickness</indexterm> The <code>\linethickness{<var>dim</var>}</code> command declares the thickness of horizontal and vertical lines in a picture environment to be <var>dim</var>, which must be a positive length.</para> + <para><code>\linethickness</code> does not affect the thickness of slanted lines, circles, or the quarter circles drawn by <code>\oval</code>.</para> + </subsection> + </node> + <node> + <nodename>\thicklines</nodename> + <nodenext>\thinlines</nodenext> + <nodeprev>\linethickness</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\thicklines</code></title> + <para><indexterm index="fn">\thicklines</indexterm> The <code>\thicklines</code> command is an alternate line thickness for horizontal and vertical lines in a picture environment; cf. <xref><xrefnodename>\linethickness</xrefnodename></xref> and <xref><xrefnodename>\thinlines</xrefnodename></xref>.</para> + </subsection> + </node> + <node> + <nodename>\thinlines</nodename> + <nodenext>\multiput</nodenext> + <nodeprev>\thicklines</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\thinlines</code></title> + <para><indexterm index="fn">\thinlines</indexterm> The <code>\thinlines</code> command is the default line thickness for horizontal and vertical lines in a picture environment; cf. <xref><xrefnodename>\linethickness</xrefnodename></xref> and <xref><xrefnodename>\thicklines</xrefnodename></xref>.</para> + </subsection> + </node> + <node> + <nodename>\multiput</nodename> + <nodenext>\oval</nodenext> + <nodeprev>\thinlines</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\multiput</code></title> + <para><indexterm index="fn">\multiput</indexterm> Synopsis:</para> + <example xml:space="preserve">\multiput(<var>x</var>,<var>y</var>)(<var>delta_x</var>,<var>delta_y</var>){<var>n</var>}{<var>obj</var>}</example> + <para>The <code>\multiput</code> command copies the object <var>obj</var> in a regular pattern across a picture. <var>obj</var> is first placed at position <math>(x,y)</math>, then at <math>(x+\delta x,y+\delta y)</math>, and so on, <var>n</var> times.</para> + </subsection> + </node> + <node> + <nodename>\oval</nodename> + <nodenext>\put</nodenext> + <nodeprev>\multiput</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\oval</code></title> + <para><indexterm index="fn">\oval</indexterm> Synopsis:</para> + <example xml:space="preserve">\oval(<var>width</var>,<var>height</var>)[<var>portion</var>]</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 oval via the following:</para> + <table> + <tableitem> + <tableterm><code>t</code></tableterm> + <item> + <para>selects the top portion;</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>b</code></tableterm> + <item> + <para>selects the bottom portion;</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>r</code></tableterm> + <item> + <para>selects the right portion;</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>l</code></tableterm> + <item> + <para>selects the left portion.</para> + </item> + </tableitem> + </table> + <para>The “corners” of the oval are made with quarter circles with a maximum radius of 20<dmn>pt</dmn>, so large “ovals” will look more like boxes with rounded corners.</para> + </subsection> + </node> + <node> + <nodename>\put</nodename> + <nodenext>\shortstack</nodenext> + <nodeprev>\oval</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\put</code></title> + <para><indexterm index="fn">\put</indexterm> <code>\put(x coord,y coord){ ... }</code></para> + <para>The <code>\put</code> command places the item specified by the mandatory argument at the given coordinates.</para> + </subsection> + </node> + <node> + <nodename>\shortstack</nodename> + <nodenext>\vector</nodenext> + <nodeprev>\put</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\shortstack</code></title> + <para><indexterm index="fn">\shortstack</indexterm> Synopsis:</para> + <example xml:space="preserve">\shortstack[<var>position</var>]{...\\...\\...}</example> + <para>The <code>\shortstack</code> command produces a stack of objects. The valid positions are:</para> + <table> + <tableitem> + <tableterm><code>r</code></tableterm> + <item> + <para>Move the objects to the right of the stack.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>l</code></tableterm> + <item> + <para>Move the objects to the left of the stack</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>c</code></tableterm> + <item> + <para>Move the objects to the centre of the stack (default)</para> + </item> + </tableitem> + </table> + <para><indexterm index="fn">\\ <r>(for <code>\shortstack</code> objects)</r></indexterm>Objects are separated with <code>\\</code>.</para> + </subsection> + </node> + <node> + <nodename>\vector</nodename> + <nodeprev>\shortstack</nodeprev> + <nodeup>picture</nodeup> + <subsection> + <title><code>\vector</code></title> + <para><indexterm index="fn">\vector</indexterm> Synopsis:</para> + <example xml:space="preserve">\vector(<var>x-slope</var>,<var>y-slope</var>){<var>length</var>}</example> + <para>The <code>\vector</code> command draws a line with an arrow of the specified length and slope. The <math>x</math> and <math>y</math> values must lie between −4 and +4, inclusive.</para> + </subsection> + </node> + <node> + <nodename>quotation</nodename> + <nodenext>quote</nodenext> + <nodeprev>picture</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>quotation</code></title> + <para><indexterm index="fn">quotation</indexterm><indexterm index="cp">quoted text with paragraph indentation, displaying</indexterm><indexterm index="cp">displaying quoted text with paragraph indentation</indexterm><indexterm index="cp">paragraph indentations in quoted text</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{quotation} +<var>text</var> +\end{quotation}</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> + <node> + <nodename>quote</nodename> + <nodenext>tabbing</nodenext> + <nodeprev>quotation</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>quote</code></title> + <para><indexterm index="fn">quote</indexterm><indexterm index="cp">quoted text without paragraph indentation, displaying</indexterm><indexterm index="cp">displaying quoted text without paragraph indentation</indexterm><indexterm index="cp">paragraph indentations in quoted text, omitting</indexterm> Snyopsis:</para> + <example xml:space="preserve">\begin{quote} +<var>text</var> +\end{quote}</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> + <para>Unlike the <code>quotation</code> environment, paragraphs are not indented.</para> + </section> + </node> + <node> + <nodename>tabbing</nodename> + <nodenext>table</nodenext> + <nodeprev>quote</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>tabbing</code></title> + <para><indexterm index="fn">tabbing <r>environment</r></indexterm><indexterm index="cp">tab stops, using</indexterm><indexterm index="cp">lining text up in columns using tab stops</indexterm><indexterm index="cp">alignment via tabbing</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{tabbing} +<var>row1col1</var> \= <var>row1col2</var> \= <var>row1col3</var> \= <var>row1col4</var> \\ +<var>row2col1</var> \> \> <var>row2col3</var> \\ +... +\end{tabbing}</example> + <para>The <code>tabbing</code> environment provides a way to align text in columns. It works by setting tab stops and tabbing to them much as was done on an ordinary typewriter. It is best suited for cases where the width of each column is constant and known in advance.</para> + <para>This environment can be broken across pages, unlike the <code>tabular</code> environment.</para> + <para>The following commands can be used inside a <code>tabbing</code> enviroment:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\\ <r>tabbing</r></indexterm><code>\\ <r>tabbing</r></code></tableterm> + <item> + <para>End a line.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\= <r>(tabbing)</r></indexterm><code>\= <r>(tabbing)</r></code></tableterm> + <item> + <para>Sets a tab stop at the current position.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\> <r>(tabbing)</r></indexterm><code>\> <r>(tabbing)</r></code></tableterm><indexterm index="fn">\></indexterm> + <item> + <para>Advances to the next tab stop.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\<</indexterm><code>\<</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\+</indexterm><code>\+</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\-</indexterm><code>\-</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\' <r>(tabbing)</r></indexterm><code>\' <r>(tabbing)</r></code></tableterm> + <item> + <para>Moves everything that you have typed so far in the 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.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\` <r>(tabbing)</r></indexterm><code>\` <r>(tabbing)</r></code></tableterm> + <item> + <para>Allows you to put text flush right against any tab stop, including tab stop 0. However, it can't move text to the right of the last column because there's no tab stop there. The <code>\`</code> command moves all the text that follows it, up to the <code>\\</code> or <code>\end{tabbing}</code> 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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\a <r>(tabbing)</r></indexterm><code>\a <r>(tabbing)</r></code></tableterm><indexterm index="fn">\a' <r>(acute accent in tabbing)</r></indexterm><indexterm index="fn">\a` <r>(grave accent in tabbing)</r></indexterm><indexterm index="fn">\a= <r>(macron accent in tabbing)</r></indexterm> + <item> + <para>In a <code>tabbing</code> environment, the commands <code>\=</code>, <code>\'</code> and <code>\`</code> do not produce accents as usual (see <xref><xrefnodename>Accents</xrefnodename></xref>). Instead, the commands <code>\a=</code>, <code>\a'</code> and <code>\a`</code> are used.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\kill</indexterm><code>\kill</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\poptabs</indexterm><code>\poptabs</code></tableterm><indexterm index="fn">\poptabs</indexterm> + <item> + <para>Restores the tab stop positions saved by the last <code>\pushtabs</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\pushtabs</indexterm><code>\pushtabs</code></tableterm> + <item> + <para>Saves all current tab stop positions. Useful for temporarily changing tab stop positions in the middle of a <code>tabbing</code> environment.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\tabbingsep</indexterm><code>\tabbingsep</code></tableterm> + <item> + <para>Distance to left of tab stop moved by <code>\'</code>.</para> + </item> + </tableitem> + </table> + <para>This example typesets a Pascal function in a traditional format:</para> + <example xml:space="preserve">\begin{tabbing} +function \= fact(n : integer) : integer;\\ + \> begin \= \+ \\ + \> if \= n $>$ 1 then \+ \\ + fact := n * fact(n-1) \- \\ + else \+ \\ + fact := 1; \-\- \\ + end;\\ +\end{tabbing}</example> + </section> + </node> + <node> + <nodename>table</nodename> + <nodenext>tabular</nodenext> + <nodeprev>tabbing</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>table</code></title> + <para><indexterm index="fn">table</indexterm><indexterm index="cp">tables, creating</indexterm><indexterm index="cp">creating tables</indexterm> Synopsis:</para> + <example xml:space="preserve"> \begin{table}[placement] + + body of the table + + \caption{table title} + \end{table}</example> + <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 <code>[placement]</code> determines where &latex; will try to place your table. There are four places where &latex; can possibly put a float:</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para><code>h</code>: Here - at the position in the text where the table environment appears.</para> + </item> + <item> + <para><code>t</code>: Top - at the top of a text page.</para> + </item> + <item> + <para><code>b</code>: Bottom - at the bottom of a text page.</para> + </item> + <item> + <para><code>p</code>: Page of floats - on a separate float page, which is a page containing no text, only floats.</para> + </item> + </itemize> + <para>The standard <code>report</code> and <code>article</code> classes use the default placement <code>[tbp]</code>.</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> + </section> + </node> + <node> + <nodename>tabular</nodename> + <nodenext>thebibliography</nodenext> + <nodeprev>table</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>tabular</code></title> + <para><indexterm index="fn">tabular <r>environment</r></indexterm><indexterm index="cp">lines in tables</indexterm><indexterm index="cp">lining text up in tables</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{tabular}[pos]{cols} +column 1 entry & column 2 entry ... & column n entry \\ +... +\end{tabular}</example> + <para>or</para> + <example xml:space="preserve">\begin{tabular*}{width}[pos]{cols} +column 1 entry & column 2 entry ... & column n entry \\ +... +\end{tabular*}</example> + <para>These environments produce a box consisting of a sequence of rows of items, aligned vertically in columns.</para> + <para><indexterm index="fn">\\ <r>for <code>tabular</code></r></indexterm><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.</para> + <para>The mandatory and optional arguments consist of:</para> + <table> + <tableitem> + <tableterm><code>width</code></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><code>pos</code></tableterm> + <item> + <para>Specifies the vertical position; default is alignment on the centre of the environment.</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para><code>t</code> - align on top row</para> + </item> + <item> + <para><code>b</code> - align on bottom row</para> + </item> + </itemize> + </item> + </tableitem> + <tableitem> + <tableterm><code>cols</code></tableterm> + <item> + <para>Specifies the column formatting. It consists of a sequence of the following specifiers, corresponding to the sequence of columns and intercolumn material.</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para><code>l</code> - A column of left-aligned items.</para> + </item> + <item> + <para><code>r</code> - A column of right-aligned items.</para> + </item> + <item> + <para><code>c</code> - A column of centred items.</para> + </item> + <item> + <para><code>|</code> - A vertical line the full height and depth of the environment.</para> + </item> + <item> + <para><code>@{text}</code> - This inserts <code>text</code> in every row. An @-expression suppresses the intercolumn space normally inserted between columns; any desired space between the inserted text and the adjacent items must be included in text. 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 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.</para> + </item> + <item> + <para><code>p{wd}</code> - Produces a column with each item typeset in a parbox of width <code>wd</code>, as if it were the argument of a <code>\parbox[t]{wd}</code> command. However, a <code>\\</code> may not appear in the item, except in the following situations:</para> + <enumerate first="1"> + <item> + <para>inside an environment like <code>minipage</code>, <code>array</code>, or <code>tabular</code>.</para> + </item> + <item> + <para>inside an explicit <code>\parbox</code>.</para> + </item> + <item> + <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> + </item> + </enumerate> + </item> + <item> + <para><code>*{num}{cols}</code> - Equivalent to <code>num</code> copies of <code>cols</code>, where <code>num</code> is any positive integer and <code>cols</code> is any list of column-specifiers, which may contain another <code>*-expression</code>.</para> + </item> + </itemize> + </item> + </tableitem> + </table> + <para>Parameters that control formatting: +<!-- xx defaults, own node (xref from array)? --></para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\arrayrulewidth</indexterm><code>\arrayrulewidth</code></tableterm> + <item> + <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>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\arraystretch</indexterm><code>\arraystretch</code></tableterm> + <item> + <para>Scaling of spacing between rows in the <code>tabular</code> and <code>array</code> environments; default is <samp>1</samp>,for no scaling.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\doublerulesep</indexterm><code>\doublerulesep</code></tableterm> + <item> + <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>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\tabcolsep</indexterm><code>\tabcolsep</code></tableterm> + <item> + <para>Half the width of the space between columns; default is <samp>6pt</samp>.</para> + </item> + </tableitem> + </table> + <para>These commands can be used inside a <code>tabular</code> environment:</para> + <menu> + <menuentry> + <menunode>\multicolumn</menunode> + <menutitle>\multicolumn</menutitle> + <menucomment>Make an item spanning several columns.</menucomment> + </menuentry> + <menuentry> + <menunode>\cline</menunode> + <menutitle>\cline</menutitle> + <menucomment>Draw a horizontal line spanning some columns.</menucomment> + </menuentry> + <menuentry> + <menunode>\hline</menunode> + <menutitle>\hline</menutitle> + <menucomment>Draw a horizontal line spanning all columns.</menucomment> + </menuentry> + <menuentry> + <menunode>\vline</menunode> + <menutitle>\vline</menutitle> + <menucomment>Draw a vertical line.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\multicolumn</nodename> + <nodenext>\cline</nodenext> + <nodeup>tabular</nodeup> + <subsection> + <title><code>\multicolumn</code></title> + <para><indexterm index="fn">\multicolumn</indexterm> Synopsis:</para> + <example xml:space="preserve">\multicolumn{<var>cols</var>}{<var>pos</var>}{<var>text</var>}</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> + <para>Here's an example showing two columns separated by an en-dash; <code>\multicolumn</code> is used for the heading:</para> + <example xml:space="preserve">\begin{tabular}{r@{--}l} +\multicolumn{2}{c}{\bf Unicode}\cr + 0x80&0x7FF \cr + 0x800&0xFFFF \cr +0x10000&0x1FFFF \cr +\end{tabular}</example> + </subsection> + </node> + <node> + <nodename>\cline</nodename> + <nodenext>\hline</nodenext> + <nodeprev>\multicolumn</nodeprev> + <nodeup>tabular</nodeup> + <subsection> + <title><code>\cline</code></title> + <para><indexterm index="fn">\cline</indexterm> Synopsis:</para> + <example xml:space="preserve">\cline{<var>i</var>-<var>j</var>}</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> + </subsection> + </node> + <node> + <nodename>\hline</nodename> + <nodenext>\vline</nodenext> + <nodeprev>\cline</nodeprev> + <nodeup>tabular</nodeup> + <subsection> + <title><code>\hline</code></title> + <para><indexterm index="fn">\hline</indexterm> 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.</para> + </subsection> + </node> + <node> + <nodename>\vline</nodename> + <nodeprev>\hline</nodeprev> + <nodeup>tabular</nodeup> + <subsection> + <title><code>\vline</code></title> + <para><indexterm index="fn">\vline</indexterm> 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.</para> + </subsection> + </node> + <node> + <nodename>thebibliography</nodename> + <nodenext>theorem</nodenext> + <nodeprev>tabular</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>thebibliography</code></title> + <para><indexterm index="fn">thebibliography</indexterm><indexterm index="cp">bibliography, creating (manually)</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{thebibliography}{<var>widest-label</var>} +\bibitem[<var>label</var>]{<var>cite_key}</var> +... +\end{thebibliography}</example> + <para>The <code>thebibliography</code> environment produces a bibliography or reference list.</para> + <para>In the <code>article</code> class, this reference list is labelled “References”; in the <code>report</code> class, it is labelled “Bibliography”. You can change the label (in the standard classes) by redefining the command <code>\refname</code>. For instance, this eliminates it entirely:</para> + <example xml:space="preserve">\renewcommand{\refname}{}</example> + <para>The mandatory <var>widest-label</var> argument is text that, when typeset, is as wide as the widest item label produced by the <code>\bibitem</code> commands. It is typically given as <code>9</code> for bibliographies with less than 10 references, <code>99</code> for ones with less than 100, etc.</para> + <menu> + <menuentry> + <menunode>\bibitem</menunode> + <menutitle>\bibitem</menutitle> + <menucomment>Specify a bibliography item.</menucomment> + </menuentry> + <menuentry> + <menunode>\cite</menunode> + <menutitle>\cite</menutitle> + <menucomment>Refer to a bibliography item.</menucomment> + </menuentry> + <menuentry> + <menunode>\nocite</menunode> + <menutitle>\nocite</menutitle> + <menucomment>Include an item in the bibliography.</menucomment> + </menuentry> + <menuentry> + <menunode>Using BibTeX</menunode> + <menutitle>Using BibTeX</menutitle> + <menucomment>Automatic generation of bibliographies.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\bibitem</nodename> + <nodenext>\cite</nodenext> + <nodeup>thebibliography</nodeup> + <subsection> + <title><code>\bibitem</code></title> + <para><indexterm index="fn">\bibitem</indexterm> Synopsis:</para> + <example xml:space="preserve">\bibitem[<var>label</var>]{<var>cite_key</var>}</example> + <para>The <code>\bibitem</code> command generates an entry labelled by <var>label</var>. If the <var>label</var> argument is missing, a number is automatically generated using the <code>enumi</code> counter. The <var>cite_key</var> is any sequence of letters, numbers, and punctuation symbols not containing a comma.</para> + <para>This command writes an entry to the <file>.aux</file> file containing the item's <var>cite_key</var> and label. When the <file>.aux</file> file is read by the <code>\begin{document}</code> command, the item's <code>label</code> is associated with <code>cite_key</code>, causing references to <var>cite_key</var> with a <code>\cite</code> command (see next section) to produce the associated label.</para> + </subsection> + </node> + <node> + <nodename>\cite</nodename> + <nodenext>\nocite</nodenext> + <nodeprev>\bibitem</nodeprev> + <nodeup>thebibliography</nodeup> + <subsection> + <title><code>\cite</code></title> + <para><indexterm index="fn">\cite</indexterm> Synopsis:</para> + <example xml:space="preserve">\cite[<var>subcite</var>]{<var>keys</var></example> + <para>The <var>keys</var> argument is a list of one or more citation keys, separated by commas. This command generates an in-text citation to the references associated with <var>keys</var> by entries in the <file>.aux</file> file.</para> + <para>The text of the optional <var>subcite</var> argument appears after the citation. For example, <code>\cite[p.~314]{knuth}</code> might produce `[Knuth, p. 314]'.</para> + </subsection> + </node> + <node> + <nodename>\nocite</nodename> + <nodenext>Using BibTeX</nodenext> + <nodeprev>\cite</nodeprev> + <nodeup>thebibliography</nodeup> + <subsection> + <title><code>\nocite</code></title> + <para><indexterm index="fn">\nocite</indexterm> <code>\nocite{key_list}</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> + </subsection> + </node> + <node> + <nodename>Using BibTeX</nodename> + <nodeprev>\nocite</nodeprev> + <nodeup>thebibliography</nodeup> + <subsection> + <title>Using Bib&tex;</title> + <para><indexterm index="cp">using Bib&tex;</indexterm><indexterm index="cp">bib&tex;, using</indexterm><indexterm index="cp">bibliography, creating (automatically)</indexterm><indexterm index="fn">\bibliographystyle</indexterm><indexterm index="fn">\bibliography</indexterm> If you use the Bib&tex; program by Oren Patashnik (highly recommended if you need a bibliography of more than a couple of titles) to maintain your bibliography, you don't use the <code>thebibliography</code> environment (see <xref><xrefnodename>thebibliography</xrefnodename></xref>). Instead, you include the lines</para> + <example xml:space="preserve">\bibliographystyle{<var>bibstyle</var>} +\bibliography{<var>bibfile1</var>,<var>bibfile2</var>}</example> + <para>The <code>\bibliographystyle</code> command does not produce any output of its own. Rather, it defines the style in which the bibliography will be produced: <var>bibstyle</var> refers to a file <var>bibstyle</var><file>.bst</file>, which defines how your citations will look. The standard <var>style</var> names distributed with Bib&tex; are:</para> + <table> + <tableitem> + <tableterm><code>alpha</code></tableterm> + <item> + <para>Sorted alphabetically. Labels are formed from name of author and year of publication.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>plain</code></tableterm> + <item> + <para>Sorted alphabetically. Labels are numeric.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>unsrt</code></tableterm> + <item> + <para>Like <code>plain</code>, but entries are in order of citation.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>abbrv</code></tableterm> + <item> + <para>Like <code>plain</code>, but more compact labels.</para> + </item> + </tableitem> + </table> + <para>In addition, numerous other Bib&tex; style files exist tailored to the demands of various publications. See <uref><urefurl>http://www.ctan.org/tex-archive/biblio/bibtex/contrib</urefurl></uref>.</para> + <para>The <code>\bibliography</code> command is what actually produces the bibliography. The argument to <code>\bibliography</code> refers to files named <file><var>bibfile</var>.bib</file>, which should contain your database in Bib&tex; format. Only the entries referred to via <code>\cite</code> and <code>\nocite</code> will be listed in the bibliography.</para> + </subsection> + </node> + <node> + <nodename>theorem</nodename> + <nodenext>titlepage</nodenext> + <nodeprev>thebibliography</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>theorem</code></title> + <para><indexterm index="fn">theorem <r>environment</r></indexterm><indexterm index="cp">theorems, typesetting</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{theorem} +<var>theorem-text</var> +\end{theorem}</example> + <para>The <code>theorem</code> environment produces “Theorem <var>n</var>” in boldface followed by <var>theorem-text</var>, where the numbering possibilities for <var>n</var> are described under <code>\newtheorem</code> (see <xref><xrefnodename>\newtheorem</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>titlepage</nodename> + <nodenext>verbatim</nodenext> + <nodeprev>theorem</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>titlepage</code></title> + <para><indexterm index="fn">titlepage <r>environment</r></indexterm><indexterm index="cp">making a title page</indexterm><indexterm index="cp">title pages, creating</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{titlepage} +<var>text</var> +\end{titlepage}</example> + <para>The <code>titlepage</code> environment creates a title page, i.e., a page with no printed page number or heading. It also causes the following page to be numbered page one. Formatting the title page is left to you. The <code>\today</code> command may be useful on title pages (see <xref><xrefnodename>\today</xrefnodename></xref>).</para> + <para>You can use the <code>\maketitle</code> command (see <xref><xrefnodename>\maketitle</xrefnodename></xref>) to produce a standard title page without a <code>titlepage</code> environment.</para> + </section> + </node> + <node> + <nodename>verbatim</nodename> + <nodenext>verse</nodenext> + <nodeprev>titlepage</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>verbatim</code></title> + <para><indexterm index="fn">verbatim <r>environment</r></indexterm><indexterm index="cp">verbatim text</indexterm><indexterm index="cp">simulating typed text</indexterm><indexterm index="cp">typed text, simulating</indexterm><indexterm index="cp">code, typesetting</indexterm><indexterm index="cp">computer programs, typesetting</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{verbatim} +<var>literal-text</var> +\end{verbatim}</example> + <para>The <code>verbatim</code> environment is a paragraph-making environment in which &latex; produces exactly what you type in; for instance the <code>\</code> character produces a printed <samp>\</samp>. It turns &latex; into a typewriter with carriage returns and blanks having the same effect that they would on a typewriter.</para> + <para>The <code>verbatim</code> uses a monospaced typewriter-like font (<code>\tt</code>).</para> + <menu> + <menuentry> + <menunode>\verb</menunode> + <menutitle>\verb</menutitle> + <menucomment>The macro form of the <code>verbatim</code> environment.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\verb</nodename> + <nodeup>verbatim</nodeup> + <subsection> + <title><code>\verb</code></title> + <para><indexterm index="fn">\verb</indexterm><indexterm index="cp">verbatim text, inline</indexterm> Synopsis:</para> + <example xml:space="preserve">\verb<var>char</var><var>literal-text</var><var>char</var> +\verb*<var>char</var><var>literal-text</var><var>char</var></example> + <para>The <code>\verb</code> command typesets <var>literal-text</var> as it is input, including special characters and spaces, using the typewriter (<code>\tt</code>) font. No spaces are allowed between <code>\verb</code> or <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> + <para><indexterm index="cp">visible space</indexterm>The <code>*</code>-form differs only in that spaces are printed with a “visible space” character.</para> + </subsection> + </node> + <node> + <nodename>verse</nodename> + <nodeprev>verbatim</nodeprev> + <nodeup>Environments</nodeup> + <section> + <title><code>verse</code></title> + <para><indexterm index="fn">verse <r>environment</r></indexterm><indexterm index="cp">poetry, an environment for</indexterm> Synopsis:</para> + <example xml:space="preserve">\begin{verse} +<var>line1</var> \\ +<var>line2</var> \\ +... +\end{verse}</example> + <para>The <code>verse</code> environment is designed for poetry, though you may find other uses for it.</para> + <para><indexterm index="fn">\\ <r>for <code>verse</code></r></indexterm>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 stanzas.</para> + </section> + </node> + <node> + <nodename>Footnotes</nodename> + <nodenext>Definitions</nodenext> + <nodeprev>Page breaking</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Footnotes</title> + <para><indexterm index="cp">footnotes, creating</indexterm> 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.</para> + <menu> + <menuentry> + <menunode>\footnote</menunode> + <menutitle>\footnote</menutitle> + <menucomment>Insert a footnote.</menucomment> + </menuentry> + <menuentry> + <menunode>\footnotemark</menunode> + <menutitle>\footnotemark</menutitle> + <menucomment>Insert footnote mark only.</menucomment> + </menuentry> + <menuentry> + <menunode>\footnotetext</menunode> + <menutitle>\footnotetext</menutitle> + <menucomment>Insert footnote text only.</menucomment> + </menuentry> + <menuentry> + <menunode>Footnote parameters</menunode> + <menutitle>Footnote parameters</menutitle> + <menucomment>Parameters for footnote formatting.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\footnote</nodename> + <nodenext>\footnotemark</nodenext> + <nodeup>Footnotes</nodeup> + <section> + <title><code>\footnote</code></title> + <para><indexterm index="fn">\footnote</indexterm> Synopsis:</para> + <example xml:space="preserve">\footnote[<var>number</var>]{<var>text</var>}</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> + <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.) +<!-- xx mention packages that fix this --></para> + </section> + </node> + <node> + <nodename>\footnotemark</nodename> + <nodenext>\footnotetext</nodenext> + <nodeprev>\footnote</nodeprev> + <nodeup>Footnotes</nodeup> + <section> + <title><code>\footnotemark</code></title> + <para><indexterm index="fn">\footnotemark</indexterm> 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</para> + <example xml:space="preserve">\footnotemark[\value{footnote}]</example> + <para>after the first <code>\footnote</code> command.</para> + </section> + </node> + <node> + <nodename>\footnotetext</nodename> + <nodenext>Footnote parameters</nodenext> + <nodeprev>\footnotemark</nodeprev> + <nodeup>Footnotes</nodeup> + <section> + <title><code>\footnotetext</code></title> + <para><indexterm index="fn">\footnotetext</indexterm> Synopsis:</para> + <example xml:space="preserve">\footnotetext[<var>number</var>]{<var>text</var>}</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> + <para>The optional argument <var>number</var> changes the default footnote number.</para> + </section> + </node> + <node> + <nodename>Footnote parameters</nodename> + <nodeprev>\footnotetext</nodeprev> + <nodeup>Footnotes</nodeup> + <section> + <title>Footnote parameters</title> + <para><indexterm index="cp">footnote parameters</indexterm></para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\footnoterule</indexterm><code>\footnoterule</code></tableterm> + <item> + <para>Produces the rule separating the main text on a page from the page's footnotes. Default dimensions: <code>0.4pt</code> thick (or wide), and <code>0.4\columnwidth</code> long in the standard document classes (except slides, where it does not appear).</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\footnotesep</indexterm><code>\footnotesep</code></tableterm> + <item> + <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 (see <xref><xrefnodename>Font sizes</xrefnodename></xref>), therefore there is no extra space between footnotes. This is <samp>6.65pt</samp> for <samp>10pt</samp>, <samp>7.7pt</samp> for <samp>11pt</samp>, and <samp>8.4pt</samp> for <samp>12pt</samp>.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Definitions</nodename> + <nodenext>Counters</nodenext> + <nodeprev>Footnotes</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Definitions</title> + <para><indexterm index="cp">definitions</indexterm> &latex; has support for making new commands of many different kinds.</para> +<!-- xx everything in this chapter needs examples. --> + <menu> + <menuentry> + <menunode>\newcommand & \renewcommand</menunode> + <menutitle>\newcommand & \renewcommand</menutitle> + <menucomment>(Re)define a new command.</menucomment> + </menuentry> + <menuentry> + <menunode>\newcounter</menunode> + <menutitle>\newcounter</menutitle> + <menucomment>Define a new counter.</menucomment> + </menuentry> + <menuentry> + <menunode>\newlength</menunode> + <menutitle>\newlength</menutitle> + <menucomment>Define a new length.</menucomment> + </menuentry> + <menuentry> + <menunode>\newsavebox</menunode> + <menutitle>\newsavebox</menutitle> + <menucomment>Define a new box.</menucomment> + </menuentry> + <menuentry> + <menunode>\newenvironment & \renewenvironment</menunode> + <menutitle>\newenvironment & \renewenvironment</menutitle> + <menucomment>Define a new environment.</menucomment> + </menuentry> + <menuentry> + <menunode>\newtheorem</menunode> + <menutitle>\newtheorem</menutitle> + <menucomment>Define a new theorem-like environment.</menucomment> + </menuentry> + <menuentry> + <menunode>\newfont</menunode> + <menutitle>\newfont</menutitle> + <menucomment>Define a new font name.</menucomment> + </menuentry> + <menuentry> + <menunode>\protect</menunode> + <menutitle>\protect</menutitle> + <menucomment>Using tricky commands.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\newcommand & \renewcommand</nodename> + <nodenext>\newcounter</nodenext> + <nodeup>Definitions</nodeup> + <section> + <title><code>\newcommand</code> & <code>\renewcommand</code></title> + <para><indexterm index="fn">\newcommand</indexterm><indexterm index="cp">commands, defining new ones</indexterm><indexterm index="cp">defining a new command</indexterm><indexterm index="cp">new commands, defining</indexterm> <code>\newcommand</code> and <code>\renewcommand</code> define and redefine a command, respectively. Synopses:</para> + <example xml:space="preserve"> \newcommand{<var>cmd</var>}[<var>nargs</var>]{<var>defn</var>} +\renewcommand{<var>cmd</var>}[<var>nargs</var>]{<var>defn</var>} + \newcommand{<var>cmd</var>}[<var>nargs</var>][<var>default</var>]{<var>defn</var>} +\renewcommand{<var>cmd</var>}[<var>nargs</var>][<var>default</var>]{<var>defn</var>}</example> + <table> + <tableitem> + <tableterm><var>cmd</var></tableterm> + <item> + <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.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>nargs</var></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><var>default</var></tableterm> + <item> + <para>If this optional parameter is present, it means that the command's first argument is optional. When the new command is called, the default value of the optional argument (i.e., if it is not specified in the call) is the string <samp>def</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>defn</var></tableterm> + <item> + <para>The text to be substituted for every occurrence of <code>cmd</code>; a construct of the form <code>#<var>n</var></code> in <var>defn</var> is replaced by the text of the <var>n</var>th argument.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\newcounter</nodename> + <nodenext>\newlength</nodenext> + <nodeprev>\newcommand & \renewcommand</nodeprev> + <nodeup>Definitions</nodeup> + <section> + <title><code>\newcounter</code></title> + <para><indexterm index="fn">\newcounter</indexterm><indexterm index="cp">counters, defining new</indexterm> Synopsis:</para> + <example xml:space="preserve">\newcounter{<var>cnt</var>}[<var>countername</var>]</example> + <para>The <code>\newcounter</code> command defines a new counter named <var>cnt</var>. The new counter is initialized to zero.</para> + <para>Given the optional argument <code>[<var>countername</var>]</code>, <var>cnt</var> will be reset whenever <var>countername</var> is incremented.</para> + <para>See <xref><xrefnodename>Counters</xrefnodename></xref>, for more information about counters.</para> + </section> + </node> + <node> + <nodename>\newlength</nodename> + <nodenext>\newsavebox</nodenext> + <nodeprev>\newcounter</nodeprev> + <nodeup>Definitions</nodeup> + <section> + <title><code>\newlength</code></title> + <para><indexterm index="fn">\newlength</indexterm><indexterm index="cp">lengths, defining new</indexterm> Synopsis:</para> + <example xml:space="preserve">\newlength{\<var>arg</var>}</example> + <para>The <code>\newlength</code> command defines the mandatory argument as a <code>length</code> command with a value of <code>0in</code>. The argument must be a control sequence, as in <code>\newlength{\foo}</code>. An error occurs if <code>\foo</code> is already defined.</para> + <para>See <xref><xrefnodename>Lengths</xrefnodename></xref>, for how to set the new length to a nonzero value, and for more information about lengths in general.</para> + </section> + </node> + <node> + <nodename>\newsavebox</nodename> + <nodenext>\newenvironment & \renewenvironment</nodenext> + <nodeprev>\newlength</nodeprev> + <nodeup>Definitions</nodeup> + <section> + <title><code>\newsavebox</code></title> + <para><indexterm index="fn">\newsavebox</indexterm> Synopsis:</para> + <example xml:space="preserve">\newsavebox{<var>cmd</var>}</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> + </section> + </node> + <node> + <nodename>\newenvironment & \renewenvironment</nodename> + <nodenext>\newtheorem</nodenext> + <nodeprev>\newsavebox</nodeprev> + <nodeup>Definitions</nodeup> + <section> + <title><code>\newenvironment</code> & <code>\renewenvironment</code></title> + <para><indexterm index="fn">\newenvironment</indexterm><indexterm index="fn">\renewenvironment</indexterm><indexterm index="cp">environments, defining</indexterm><indexterm index="cp">defining new environments</indexterm><indexterm index="cp">redefining environments</indexterm> Synopses:</para> + <example xml:space="preserve"> \newenvironment{<var>env</var>}[<var>nargs</var>]{<var>begdef</var>}{<var>enddef</var>} + \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>}</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> + <table> + <tableitem> + <tableterm><var>env</var></tableterm> + <item> + <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.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>nargs</var></tableterm> + <item> + <para>An integer from 1 to 9 denoting the number of arguments of the newly-defined environment. The default is no arguments.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>default</var></tableterm> + <item> + <para>If this is specified, the first argument is optional, and <var>default</var> gives the default value for that argument.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>begdef</var></tableterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><var>enddef</var></tableterm> + <item> + <para>The text expanded at every occurrence of <code>\end{<var>env</var>}</code>. It may not contain any argument parameters.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\newtheorem</nodename> + <nodenext>\newfont</nodenext> + <nodeprev>\newenvironment & \renewenvironment</nodeprev> + <nodeup>Definitions</nodeup> + <section> + <title><code>\newtheorem</code></title> + <para><indexterm index="fn">\newtheorem</indexterm><indexterm index="cp">theorems, defining</indexterm><indexterm index="cp">defining new theorems</indexterm></para> + <example xml:space="preserve">\newtheorem{<var>newenv</var>}{<var>label</var>}[<var>within</var>] +\newtheorem{<var>newenv</var>}[<var>numbered_like</var>]{<var>label</var>}</example> + <para>This command defines a theorem-like environment. Arguments:</para> + <table> + <tableitem> + <tableterm><var>newenv</var></tableterm> + <item> + <para>The name of the environment to be defined; must not be the name of an existing environment or otherwise defined.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>label</var></tableterm> + <item> + <para>The text printed at the beginning of the environment, before the number. For example, <samp>Theorem</samp>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>numbered_like</var></tableterm> + <item> + <para>(Optional.) The name of an already defined theorem-like environment; the new environment will be numbered just like <var>numbered_like</var>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>within</var></tableterm> + <item> + <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> + </item> + </tableitem> + </table> + <para>At most one of <var>numbered_like</var> and <var>within</var> can be specified, not both.</para> + </section> + </node> + <node> + <nodename>\newfont</nodename> + <nodenext>\protect</nodenext> + <nodeprev>\newtheorem</nodeprev> + <nodeup>Definitions</nodeup> + <section> + <title><code>\newfont</code></title> + <para><indexterm index="fn">\newfont</indexterm><indexterm index="cp">fonts, new commands for</indexterm><indexterm index="cp">defining new fonts</indexterm> Synopsis:</para> + <example xml:space="preserve">\newfont{<var>cmd</var>}{<var>fontname</var>}</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> + </section> + </node> + <node> + <nodename>\protect</nodename> + <nodeprev>\newfont</nodeprev> + <nodeup>Definitions</nodeup> + <section> + <title><code>\protect</code></title> + <para><indexterm index="fn">\protect</indexterm> <indexterm index="cp">fragile commands</indexterm><indexterm index="cp">moving arguments</indexterm>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>.</para> + <para>Some examples of moving arguments are <code>\caption</code> (see <xref><xrefnodename>figure</xrefnodename></xref>), <code>\thanks</code> (see <xref><xrefnodename>\maketitle</xrefnodename></xref>), and expressions in <code>tabular</code> and <code>array</code> environments (see <xref><xrefnodename>tabular</xrefnodename></xref>).</para> + <para><indexterm index="cp">robust commands</indexterm>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 xml:space="preserve"><exdent><uref><urefurl>http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</urefurl></uref></exdent> +<exdent><uref><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</urefurl></uref></exdent></smallexample> +<!-- xx really need examples. --> + </section> + </node> + <node> + <nodename>Counters</nodename> + <nodenext>Lengths</nodenext> + <nodeprev>Definitions</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Counters</title> + <para><indexterm index="cp">counters, a list of</indexterm><indexterm index="cp">variables, a list of</indexterm> 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.</para> + <example xml:space="preserve">part paragraph figure enumi +chapter subparagraph table enumii +section page footnote enumiii +subsection equation mpfootnote enumiv +subsubsection</example> + <menu> + <menuentry> + <menunode>\alph \Alph \arabic \roman \Roman \fnsymbol</menunode> + <menutitle>\alph \Alph \arabic \roman \Roman \fnsymbol</menutitle> + <menucomment>Print value of a counter.</menucomment> + </menuentry> + <menuentry> + <menunode>\usecounter</menunode> + <menutitle>\usecounter</menutitle> + <menucomment>Use a specified counter in a list environment.</menucomment> + </menuentry> + <menuentry> + <menunode>\value</menunode> + <menutitle>\value</menutitle> + <menucomment>Use the value of a counter in an expression.</menucomment> + </menuentry> + <menuentry> + <menunode>\setcounter</menunode> + <menutitle>\setcounter</menutitle> + <menucomment>Set the value of a counter.</menucomment> + </menuentry> + <menuentry> + <menunode>\addtocounter</menunode> + <menutitle>\addtocounter</menutitle> + <menucomment>Add a quantity to a counter.</menucomment> + </menuentry> + <menuentry> + <menunode>\refstepcounter</menunode> + <menutitle>\refstepcounter</menutitle> + <menucomment>Add to counter, resetting subsidiary counters.</menucomment> + </menuentry> + <menuentry> + <menunode>\stepcounter</menunode> + <menutitle>\stepcounter</menutitle> + <menucomment>Add to counter, resetting subsidiary counters.</menucomment> + </menuentry> + <menuentry> + <menunode>\day \month \year</menunode> + <menutitle>\day \month \year</menutitle> + <menucomment>Numeric date values.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\alph \Alph \arabic \roman \Roman \fnsymbol</nodename> + <nodenext>\usecounter</nodenext> + <nodeup>Counters</nodeup> + <section> + <title><code>\alph \Alph \arabic \roman \Roman \fnsymbol</code>: Printing counters</title> + <para>All of these commands take a single counter as an argument, for instance, <code>\alph{enumi}</code>.</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\alph</indexterm><code>\alph</code></tableterm> + <item> + <para>prints <var>counter</var> using lowercase letters: `a', `b', &enddots;</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Alph</indexterm><code>\Alph</code></tableterm> + <item> + <para>uses uppercase letters: `A', `B', &enddots;</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\arabic</indexterm><code>\arabic</code></tableterm> + <item> + <para>uses Arabic numbers: `1', `2', &enddots;</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\roman</indexterm><code>\roman</code></tableterm> + <item> + <para>uses lowercase roman numerals: `i', `ii', &enddots;</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\roman</indexterm><code>\roman</code></tableterm> + <item> + <para>uses uppercase roman numerals: `I', `II', &enddots;</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\fnsymbol</indexterm><code>\fnsymbol</code></tableterm> + <item> + <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.</para> + <para>The symbols mostly aren't supported in Info, but here are the names:</para> + <display xml:space="preserve">asterix(*) dagger ddagger section-sign paragraph-sign parallel +double-asterix(**) double-dagger double-ddagger</display> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\usecounter</nodename> + <nodenext>\value</nodenext> + <nodeprev>\alph \Alph \arabic \roman \Roman \fnsymbol</nodeprev> + <nodeup>Counters</nodeup> + <section> + <title><code>\usecounter{<var>counter</var>}</code></title> + <para><indexterm index="fn">\usecounter</indexterm><indexterm index="cp">list items, specifying counter</indexterm><indexterm index="cp">numbered items, specifying counter</indexterm> Synopsis:</para> + <example xml:space="preserve">\usecounter{<var>counter</var>}</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> + </section> + </node> + <node> + <nodename>\value</nodename> + <nodenext>\setcounter</nodenext> + <nodeprev>\usecounter</nodeprev> + <nodeup>Counters</nodeup> + <section> + <title><code>\value{<var>counter</var>}</code></title> + <para><indexterm index="fn">\value</indexterm><indexterm index="cp">counters, getting value of</indexterm> Synopsis:</para> + <example xml:space="preserve">\value{<var>counter</var>}</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> + <example xml:space="preserve">\setcounter{myctr}{3} +\addtocounter{myctr}{1} +\hspace{\value{myctr}\parindent}</example> + </section> + </node> + <node> + <nodename>\setcounter</nodename> + <nodenext>\addtocounter</nodenext> + <nodeprev>\value</nodeprev> + <nodeup>Counters</nodeup> + <section> + <title><code>\setcounter{<var>counter</var>}{<var>value</var>}</code></title> + <para><indexterm index="fn">\setcounter</indexterm><indexterm index="cp">counters, setting</indexterm><indexterm index="cp">setting counters</indexterm> Synopsis:</para> + <example xml:space="preserve">\setcounter{<var>\counter</var>}{<var>value</var>}</example> + <para>The <code>\setcounter</code> command sets the value of <var>\counter</var> to the <var>value</var> argument.</para> + </section> + </node> + <node> + <nodename>\addtocounter</nodename> + <nodenext>\refstepcounter</nodenext> + <nodeprev>\setcounter</nodeprev> + <nodeup>Counters</nodeup> + <section> + <title><code>\addtocounter{<var>counter</var>}{<var>value</var>}</code></title> + <para><indexterm index="fn">\addtocounter</indexterm> The <code>\addtocounter</code> command increments <var>counter</var> by the amount specified by the <var>value</var> argument, which may be negative.</para> + </section> + </node> + <node> + <nodename>\refstepcounter</nodename> + <nodenext>\stepcounter</nodenext> + <nodeprev>\addtocounter</nodeprev> + <nodeup>Counters</nodeup> + <section> + <title><code>\refstepcounter{<var>counter</var>}</code></title> + <para><indexterm index="fn">\refstepcounter</indexterm> The <code>\refstepcounter</code> command works in the same way as <code>\stepcounter</code> See <xref><xrefnodename>\stepcounter</xrefnodename></xref>, except it also defines the current <code>\ref</code> value to be the result of <code>\thecounter</code>.</para> + </section> + </node> + <node> + <nodename>\stepcounter</nodename> + <nodenext>\day \month \year</nodenext> + <nodeprev>\refstepcounter</nodeprev> + <nodeup>Counters</nodeup> + <section> + <title><code>\stepcounter{<var>counter</var>}</code></title> + <para><indexterm index="fn">\stepcounter</indexterm> The <code>\stepcounter</code> command adds one to <var>counter</var> and resets all subsidiary counters.</para> + </section> + </node> + <node> + <nodename>\day \month \year</nodename> + <nodeprev>\stepcounter</nodeprev> + <nodeup>Counters</nodeup> + <section> + <title><code>\day \month \year</code>: Predefined counters</title> + <para><indexterm index="fn">\day</indexterm><indexterm index="fn">\month</indexterm><indexterm index="fn">\year</indexterm> &latex; defines counters for the day of the month (<code>\day</code>, 1–31), month of the year (<code>\month</code>, 1–12), and year (<code>\year</code>, Common Era). When &tex; starts up, they are set to the current values on the system where &tex; is running. They are not updated as the job progresses.</para> + <para>The related command <code>\today</code> produces a string representing the current day (see <xref><xrefnodename>\today</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>Lengths</nodename> + <nodenext>Making paragraphs</nodenext> + <nodeprev>Counters</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Lengths</title> + <para><indexterm index="cp">lengths, defining and using</indexterm> A <code>length</code> is a measure of distance. Many &latex; commands take a length as an argument.</para> + <menu> + <menuentry> + <menunode>\setlength</menunode> + <menutitle>\setlength</menutitle> + <menucomment>Set the value of a length.</menucomment> + </menuentry> + <menuentry> + <menunode>\addtolength</menunode> + <menutitle>\addtolength</menutitle> + <menucomment>Add a quantity to a length.</menucomment> + </menuentry> + <menuentry> + <menunode>\settodepth</menunode> + <menutitle>\settodepth</menutitle> + <menucomment>Set a length to the depth of something.</menucomment> + </menuentry> + <menuentry> + <menunode>\settoheight</menunode> + <menutitle>\settoheight</menutitle> + <menucomment>Set a length to the height of something.</menucomment> + </menuentry> + <menuentry> + <menunode>\settowidth</menunode> + <menutitle>\settowidth</menutitle> + <menucomment>Set a length to the width of something.</menucomment> + </menuentry> + <menuentry> + <menunode>Predefined lengths</menunode> + <menutitle>Predefined lengths</menutitle> + <menucomment>Lengths that are, like, predefined.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\setlength</nodename> + <nodenext>\addtolength</nodenext> + <nodeup>Lengths</nodeup> + <section> + <title><code>\setlength{\<var>len</var>}{<var>value</var>}</code></title> + <para><indexterm index="fn">\setlength</indexterm><indexterm index="cp">lengths, setting</indexterm> 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; understands, i.e., inches (<code>in</code>), millimeters (<code>mm</code>), points (<code>pt</code>), big points (<code>bp</code>, etc.</para> + </section> + </node> + <node> + <nodename>\addtolength</nodename> + <nodenext>\settodepth</nodenext> + <nodeprev>\setlength</nodeprev> + <nodeup>Lengths</nodeup> + <section> + <title>\addtolength{<var>\len</var>}{<var>amount</var>}</title> + <para><indexterm index="fn">\addtolength</indexterm><indexterm index="cp">lengths, adding to</indexterm> The <code>\addtolength</code> command increments a “length command” <var>\len</var> by the amount specified in the <var>amount</var> argument, which may be negative.</para> + </section> + </node> + <node> + <nodename>\settodepth</nodename> + <nodenext>\settoheight</nodenext> + <nodeprev>\addtolength</nodeprev> + <nodeup>Lengths</nodeup> + <section> + <title><code>\settodepth</code></title> + <para><indexterm index="fn">\settodepth</indexterm> <code>\settodepth{\gnat}{text}</code></para> + <para>The <code>\settodepth</code> command sets the value of a <code>length</code> command equal to the depth of the <code>text</code> argument.</para> + </section> + </node> + <node> + <nodename>\settoheight</nodename> + <nodenext>\settowidth</nodenext> + <nodeprev>\settodepth</nodeprev> + <nodeup>Lengths</nodeup> + <section> + <title><code>\settoheight</code></title> + <para><indexterm index="fn">\settoheight</indexterm> <code>\settoheight{\gnat}{text}</code></para> + <para>The <code>\settoheight</code> command sets the value of a <code>length</code> command equal to the height of the <code>text</code> argument.</para> + </section> + </node> + <node> + <nodename>\settowidth</nodename> + <nodenext>Predefined lengths</nodenext> + <nodeprev>\settoheight</nodeprev> + <nodeup>Lengths</nodeup> + <section> + <title><code>\settowidth{\<var>len</var>}{<var>text</var>}</code></title> + <para><indexterm index="fn">\settowidth</indexterm> The <code>\settowidth</code> command sets the value of the command <var>\len</var> to the width of the <var>text</var> argument.</para> + </section> + </node> + <node> + <nodename>Predefined lengths</nodename> + <nodeprev>\settowidth</nodeprev> + <nodeup>Lengths</nodeup> + <section> + <title>Predefined lengths</title> + <para><indexterm index="cp">lengths, predefined</indexterm><indexterm index="cp">predefined lengths</indexterm> <code>\width</code> <indexterm index="fn">\width</indexterm> <code>\height</code> <indexterm index="fn">\height</indexterm> <code>\depth</code> <indexterm index="fn">\depth</indexterm> <code>\totalheight</code> <indexterm index="fn">\totalheight</indexterm> These length parameters can be used in the arguments of the box-making commands (see <xref><xrefnodename>Boxes</xrefnodename></xref>). They specify the natural width etc. of the text in the box. <code>\totalheight</code> equals <code>\height</code> + <code>\depth</code>. To make a box with the text stretched to double the natural size, e.g., say</para> + <para><code>\makebox[2\width]{Get a stretcher}</code></para> + </section> + </node> + <node> + <nodename>Line breaking</nodename> + <nodenext>Page breaking</nodenext> + <nodeprev>Environments</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Line breaking</title> + <para><indexterm index="cp">line breaking</indexterm><indexterm index="cp">breaking lines</indexterm> 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> + <menu> + <menuentry> + <menunode>\\</menunode> + <menutitle>\\</menutitle> + <menucomment>Start a new line.</menucomment> + </menuentry> + <menuentry> + <menunode>\obeycr & \restorecr</menunode> + <menutitle>\obeycr & \restorecr</menutitle> + <menucomment>Make each input line start a new output line.</menucomment> + </menuentry> + <menuentry> + <menunode>\newline</menunode> + <menutitle>\newline</menutitle> + <menucomment>Break the line</menucomment> + </menuentry> + <menuentry> + <menunode>\- (hyphenation)</menunode> + <menutitle>\- (hyphenation)</menutitle> + <menucomment>Insert explicit hyphenation.</menucomment> + </menuentry> + <menuentry> + <menunode>\fussy</menunode> + <menutitle>\fussy</menutitle> + <menucomment>Be fussy about line breaking.</menucomment> + </menuentry> + <menuentry> + <menunode>\hyphenation</menunode> + <menutitle>\hyphenation</menutitle> + <menucomment>Tell &latex; how to hyphenate a word.</menucomment> + </menuentry> + <menuentry> + <menunode>\linebreak & \nolinebreak</menunode> + <menutitle>\linebreak & \nolinebreak</menutitle> + <menucomment>Forcing & avoiding line breaks.</menucomment> + </menuentry> + <menuentry> + <menunode>\sloppy</menunode> + <menutitle>\sloppy</menutitle> + <menucomment>Be sloppy about line breaking.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\\</nodename> + <nodenext>\obeycr & \restorecr</nodenext> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\\</code>[*][<var>morespace</var>]</title> + <para><indexterm index="fn">\\ <r>force line break</r></indexterm><indexterm index="cp">new line, starting</indexterm><indexterm index="cp">line break, forcing</indexterm> 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> + <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.</para> + </section> + </node> + <node> + <nodename>\obeycr & \restorecr</nodename> + <nodenext>\newline</nodenext> + <nodeprev>\\</nodeprev> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\obeycr</code> & <code>\restorecr</code></title> + <para><indexterm index="fn">\obeycr</indexterm><indexterm index="fn">\restorecr</indexterm><indexterm index="cp">new line, output as input</indexterm> The <code>\obeycr</code> command makes a return in the input file (<samp>^^M</samp>, internally) the same as <code>\\</code> (followed by <code>\relax</code>). So each new line in the input will also be a new line in the output.</para> + <para><code>\restorecr</code> restores normal line-breaking behavior.</para> + </section> + </node> + <node> + <nodename>\newline</nodename> + <nodenext>\- (hyphenation)</nodenext> + <nodeprev>\obeycr & \restorecr</nodeprev> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\newline</code></title> + <para><indexterm index="fn">\newline</indexterm><indexterm index="cp">new line, starting (paragraph mode)</indexterm> 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.</para> + </section> + </node> + <node> + <nodename>\- (hyphenation)</nodename> + <nodenext>\fussy</nodenext> + <nodeprev>\newline</nodeprev> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\-</code> (discretionary hyphen)</title> + <para><indexterm index="fn">\- <r>(hyphenation)</r></indexterm><indexterm index="cp">hyphenation, forcing</indexterm> The <code>\-</code> command tells &latex; that it may hyphenate the word at that point. &latex; is very good at hyphenating, and it will usually find most of the correct hyphenation points, and almost never use an incorrect one. The <code>\-</code> command is used for the exceptional cases.</para> + <para>When you insert <code>\-</code> commands in a word, the word will only be hyphenated at those points and not at any of the hyphenation points that &latex; might otherwise have chosen.</para> + </section> + </node> + <node> + <nodename>\fussy</nodename> + <nodenext>\hyphenation</nodenext> + <nodeprev>\- (hyphenation)</nodeprev> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\fussy</code></title> + <para><indexterm index="fn">\fussy</indexterm> The declaration <code>\fussy</code> (which is the default) makes &tex; picky about line breaking. This usually avoids too much space between words, at the cost of an occasional overfull box.</para> + <para>This command cancels the effect of a previous <code>\sloppy</code> command (see <xref><xrefnodename>\sloppy</xrefnodename></xref>.</para> + </section> + </node> + <node> + <nodename>\sloppy</nodename> + <nodeprev>\linebreak & \nolinebreak</nodeprev> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\sloppy</code></title> + <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.</para> + <para>Lasts until a <code>\fussy</code> command is issued (see <xref><xrefnodename>\fussy</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>\hyphenation</nodename> + <nodenext>\linebreak & \nolinebreak</nodenext> + <nodeprev>\fussy</nodeprev> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\hyphenation</code></title> + <para><indexterm index="fn">\hyphenation</indexterm><indexterm index="cp">hyphenation, defining</indexterm> Synopsis:</para> + <example xml:space="preserve">\hyphenation{<var>word-one</var> <var>word-two</var>}</example> + <para>The <code>\hyphenation</code> command declares allowed hyphenation points with a <code>-</code> character in the given words. The words are separated by spaces. &tex; will only hyphenate if the word matches exactly, no inflections are tried. Multiple <code>\hyphenation</code> commands accumulate. Some examples (the default &tex; hyphenation patterns misses the hyphenations in these words):</para> + <example xml:space="preserve">\hyphenation{ap-pen-dix col-umns data-base data-bases}</example> + </section> + </node> + <node> + <nodename>\linebreak & \nolinebreak</nodename> + <nodenext>\sloppy</nodenext> + <nodeprev>\hyphenation</nodeprev> + <nodeup>Line breaking</nodeup> + <section> + <title><code>\linebreak</code> & <code>\nolinebreak</code></title> + <para><indexterm index="fn">\linebreak</indexterm><indexterm index="fn">\nolinebreak</indexterm><indexterm index="cp">line breaks, forcing</indexterm><indexterm index="cp">line breaks, preventing</indexterm> Synopses:</para> + <example xml:space="preserve">\linebreak[<var>priority</var>] +\nolinebreak[<var>priority</var>]</example> + <para>By default, the <code>\linebreak</code> (<code>\nolinebreak</code>) command forces (prevents) a line break at the current position. For <code>\linebreak</code>, the spaces in the line are stretched out so that it extends to the right margin as usual.</para> + <para>With the optional argument <var>priority</var>, you can convert the command from a demand to a request. The <var>priority</var> must be a number from 0 to 4. The higher the number, the more insistent the request.</para> + </section> + </node> + <node> + <nodename>Page breaking</nodename> + <nodenext>Footnotes</nodenext> + <nodeprev>Line breaking</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Page breaking</title> + <para><indexterm index="cp">page breaking</indexterm><indexterm index="cp">breaking pages</indexterm> &latex; starts new pages asynchronously, when enough material has accumulated to fill up a page. Usually this happens automatically, but sometimes you may want to influence the breaks.</para> + <menu> + <menuentry> + <menunode>\cleardoublepage</menunode> + <menutitle>\cleardoublepage</menutitle> + <menucomment>Start a new right-hand page.</menucomment> + </menuentry> + <menuentry> + <menunode>\clearpage</menunode> + <menutitle>\clearpage</menutitle> + <menucomment>Start a new page.</menucomment> + </menuentry> + <menuentry> + <menunode>\newpage</menunode> + <menutitle>\newpage</menutitle> + <menucomment>Start a new page.</menucomment> + </menuentry> + <menuentry> + <menunode>\enlargethispage</menunode> + <menutitle>\enlargethispage</menutitle> + <menucomment>Enlarge the current page a bit.</menucomment> + </menuentry> + <menuentry> + <menunode>\pagebreak & \nopagebreak</menunode> + <menutitle>\pagebreak & \nopagebreak</menutitle> + <menucomment>Forcing & avoiding page breaks.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\cleardoublepage</nodename> + <nodenext>\clearpage</nodenext> + <nodeup>Page breaking</nodeup> + <section> + <title><code>\cleardoublepage</code></title> + <para><indexterm index="fn">\cleardoublepage</indexterm><indexterm index="cp">starting on a right-hand page</indexterm> 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.</para> + </section> + </node> + <node> + <nodename>\clearpage</nodename> + <nodenext>\newpage</nodenext> + <nodeprev>\cleardoublepage</nodeprev> + <nodeup>Page breaking</nodeup> + <section> + <title><code>\clearpage</code></title> + <para><indexterm index="fn">\clearpage</indexterm><indexterm index="cp">flushing floats and starting a page</indexterm><indexterm index="cp">starting a new page and clearing floats</indexterm> 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.</para> + </section> + </node> + <node> + <nodename>\newpage</nodename> + <nodenext>\enlargethispage</nodenext> + <nodeprev>\clearpage</nodeprev> + <nodeup>Page breaking</nodeup> + <section> + <title><code>\newpage</code></title> + <para><indexterm index="fn">\newpage</indexterm><indexterm index="cp">new page, starting</indexterm><indexterm index="cp">starting a new page</indexterm> The <code>\newpage</code> command ends the current page, but does not clear floats (see <code>\clearpage</code> above).</para> + </section> + </node> + <node> + <nodename>\enlargethispage</nodename> + <nodenext>\pagebreak & \nopagebreak</nodenext> + <nodeprev>\newpage</nodeprev> + <nodeup>Page breaking</nodeup> + <section> + <title><code>\enlargethispage</code></title> + <para><indexterm index="fn">\enlargethispage</indexterm><indexterm index="cp">enlarge current page</indexterm> <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 additional line.</para> + <para>The starred form tries to squeeze the material together on the page as much as possible. This is normally used together with an explicit <code>\pagebreak</code>.</para> + </section> + </node> + <node> + <nodename>\pagebreak & \nopagebreak</nodename> + <nodeprev>\enlargethispage</nodeprev> + <nodeup>Page breaking</nodeup> + <section> + <title><code>\pagebreak</code> & <code>\nopagebreak</code></title> + <para><indexterm index="fn">\pagebreak</indexterm><indexterm index="fn">\nopagebreak</indexterm><indexterm index="cp">page break, forcing</indexterm><indexterm index="cp">page break, preventing</indexterm> Synopses:</para> + <example xml:space="preserve">\pagebreak[<var>priority</var>] +\nopagebreak[<var>priority</var>]</example> + <para>By default, the <code>\pagebreak</code> (<code>\nopagebreak</code>) command forces (prevents) a page break at the current position. For <code>\linebreak</code>, the vertical space on the page is stretched out where possible so that it extends to the normal bottom margin.</para> + <para>With the optional argument <var>priority</var>, you can convert the <code>\pagebreak</code> command from a demand to a request. The number must be a number from 0 to 4. The higher the number, the more insistent the request is.</para> + </section> + </node> + <node> + <nodename>Making paragraphs</nodename> + <nodenext>Math formulas</nodenext> + <nodeprev>Lengths</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Making paragraphs</title> + <para><indexterm index="cp">making paragraphs</indexterm><indexterm index="cp">paragraphs</indexterm> A paragraph is ended by one or more completely blank lines—lines not containing even a <code>%</code>. A blank line should not appear where a new paragraph cannot be started, such as in math mode or in the argument of a sectioning command.</para> + <menu> + <menuentry> + <menunode>\indent</menunode> + <menutitle>\indent</menutitle> + <menucomment>Indent this paragraph.</menucomment> + </menuentry> + <menuentry> + <menunode>\noindent</menunode> + <menutitle>\noindent</menutitle> + <menucomment>Do not indent this paragraph.</menucomment> + </menuentry> + <menuentry> + <menunode>\parskip</menunode> + <menutitle>\parskip</menutitle> + <menucomment>Space added before paragraphs.</menucomment> + </menuentry> + <menuentry> + <menunode>Marginal notes</menunode> + <menutitle>Marginal notes</menutitle> + <menucomment>Putting remarks in the margin.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\indent</nodename> + <nodenext>\noindent</nodenext> + <nodeup>Making paragraphs</nodeup> + <section> + <title><code>\indent</code></title> + <para><indexterm index="fn">\indent</indexterm><indexterm index="fn">\parindent</indexterm><indexterm index="cp">indent, forcing</indexterm> <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.</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 <code>11pt</code>, and <code>1.5em</code> for <code>12pt</code>.</para> + </section> + </node> + <node> + <nodename>\noindent</nodename> + <nodenext>\parskip</nodenext> + <nodeprev>\indent</nodeprev> + <nodeup>Making paragraphs</nodeup> + <section> + <title><code>\noindent</code></title> + <para><indexterm index="fn">\noindent</indexterm><indexterm index="cp">indent, suppressing</indexterm> 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.</para> + </section> + </node> + <node> + <nodename>\parskip</nodename> + <nodenext>Marginal notes</nodenext> + <nodeprev>\noindent</nodeprev> + <nodeup>Making paragraphs</nodeup> + <section> + <title><code>\parskip</code></title> + <para><indexterm index="fn">\parskip</indexterm><indexterm index="cp">vertical space before paragraphs</indexterm> <code>\parskip</code> is a rubber length defining extra vertical space added before each paragraph. The default is <code>0pt plus1pt</code>.</para> + </section> + </node> + <node> + <nodename>Marginal notes</nodename> + <nodeprev>\parskip</nodeprev> + <nodeup>Making paragraphs</nodeup> + <section> + <title>Marginal notes</title> + <para><indexterm index="cp">marginal notes</indexterm><indexterm index="cp">notes in the margin</indexterm><indexterm index="cp">remarks in the margin</indexterm><indexterm index="fn">\marginpar</indexterm> Synopsis:</para> + <example xml:space="preserve">\marginpar[<var>left</var>]{<var>right</var>}</example> + <para>The <code>\marginpar</code> command creates a note in the margin. The first line of the note will have the same baseline as the line in the text where the <code>\marginpar</code> occurs.</para> + <para>When you only specify the mandatory argument <var>right</var>, the text will be placed</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para>in the right margin for one-sided layout;</para> + </item> + <item> + <para>in the outside margin for two-sided layout;</para> + </item> + <item> + <para>in the nearest margin for two-column layout.</para> + </item> + </itemize> + <para><indexterm index="fn">\reversemarginpar</indexterm><indexterm index="fn">\normalmarginpar</indexterm>The command <code>\reversemarginpar</code> places subsequent marginal notes in the opposite (inside) margin. <code>\normalmarginpar</code> places them in the default position.</para> + <para>When you specify both arguments, <var>left</var> is used for the left margin, and <var>right</var> is used for the right margin.</para> + <para>The first word will normally not be hyphenated; you can enable hyphenation there by beginning the node with <code>\hspace{0pt}</code>.</para> + <para>These parameters affect the formatting of the note:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\marginparpush</indexterm><code>\marginparpush</code></tableterm> + <item> + <para>Minimum vertical space between notes; default <samp>7pt</samp> for <samp>12pt</samp> documents, <samp>5pt</samp> else.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\marginparsep</indexterm><code>\marginparsep</code></tableterm> + <item> + <para>Horizontal space between the main text and the note; default <samp>11pt</samp> for <samp>10pt</samp> documents, <samp>10pt</samp> else.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\marginparwidth</indexterm><code>\marginparwidth</code></tableterm> + <item> + <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. In two column mode, the default is <samp>48pt</samp>.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Math formulas</nodename> + <nodenext>Modes</nodenext> + <nodeprev>Making paragraphs</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Math formulas</title> + <para><indexterm index="cp">math formulas</indexterm><indexterm index="cp">formulas, math</indexterm><indexterm index="cp">math mode, entering</indexterm> <indexterm index="fn">math <r>environment</r></indexterm><indexterm index="fn">displaymath <r>environment</r></indexterm><indexterm index="fn">equation <r>environment</r></indexterm>There are three environments that put &latex; in math mode:</para> + <table> + <tableitem> + <tableterm><code>math</code></tableterm> + <item> + <para>For formulas that appear right in the text.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>displaymath</code></tableterm> + <item> + <para>For formulas that appear on their own line.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>equation</code></tableterm> + <item> + <para>The same as the displaymath environment except that it adds an equation number in the right margin.</para> + </item> + </tableitem> + </table> + <para><indexterm index="fn">\(</indexterm><indexterm index="fn">\)</indexterm><indexterm index="fn">\[</indexterm><indexterm index="fn">\]</indexterm>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> environments are used so often that they have the following short forms:</para> + <example xml:space="preserve">\(...\) <r>instead of</r> \begin{math}...\end{math} +\[...\] <r>instead of</r> \begin{displaymath}...\end{displaymath}</example> + <para><indexterm index="fn">$</indexterm>In fact, the <code>math</code> environment is so common that it has an even shorter form:</para> + <example xml:space="preserve">$ ... $ <r>instead of</r> \(...\)</example> + <para><indexterm index="fn">\boldmath</indexterm><indexterm index="fn">\unboldmath</indexterm>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> +<!-- xx own section? Math fonts? --> + <para><indexterm index="fn">\displaystyle</indexterm>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 xml:space="preserve">$\displaystyle \sum_{n=0}^\infty x_n $</example> +<!-- xx see also \cal, \mathcal --> + <menu> + <menuentry> + <menunode>Subscripts & Superscripts</menunode> + <menutitle>Subscripts & Superscripts</menutitle> + <menucomment>Also known as exponent or index.</menucomment> + </menuentry> + <menuentry> + <menunode>Math symbols</menunode> + <menutitle>Math symbols</menutitle> + <menucomment>Various mathematical squiggles.</menucomment> + </menuentry> + <menuentry> + <menunode>Math functions</menunode> + <menutitle>Math functions</menutitle> + <menucomment>Math function names like sin and exp.</menucomment> + </menuentry> + <menuentry> + <menunode>Math accents</menunode> + <menutitle>Math accents</menutitle> + <menucomment>Accents in math.</menucomment> + </menuentry> + <menuentry> + <menunode>Spacing in math mode</menunode> + <menutitle>Spacing in math mode</menutitle> + <menucomment>Thick, medium, thin and negative spaces.</menucomment> + </menuentry> + <menuentry> + <menunode>Math Miscellany</menunode> + <menutitle>Math Miscellany</menutitle> + <menucomment>Stuff that doesn't fit anywhere else.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>Subscripts & Superscripts</nodename> + <nodenext>Math symbols</nodenext> + <nodeup>Math formulas</nodeup> + <section> + <title>Subscripts & Superscripts</title> + <para><indexterm index="cp">superscript</indexterm><indexterm index="cp">subscript</indexterm><indexterm index="cp">exponent</indexterm><indexterm index="fn">_</indexterm><indexterm index="fn">^</indexterm> 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.</para> + </section> + </node> + <node> + <nodename>Math symbols</nodename> + <nodenext>Math functions</nodenext> + <nodeprev>Subscripts & Superscripts</nodeprev> + <nodeup>Math formulas</nodeup> + <section> + <title>Math symbols</title> + <para><indexterm index="cp">math symbols</indexterm><indexterm index="cp">symbols, math</indexterm><indexterm index="cp">greek letters</indexterm> &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 <code>$\pi$</code> in your source, you will get the pi symbol (<math>\pi</math>) in your output.</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\|</indexterm><code>\|</code></tableterm> + <item> + <para><math>\|</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\aleph</indexterm><code>\aleph</code></tableterm> + <item> + <para><math>\aleph</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\alpha</indexterm><code>\alpha</code></tableterm> + <item> + <para><math>\alpha</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\amalg</indexterm><code>\amalg</code></tableterm> + <item> + <para><math>\amalg</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\angle</indexterm><code>\angle</code></tableterm> + <item> + <para><math>\angle</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\approx</indexterm><code>\approx</code></tableterm> + <item> + <para><math>\approx</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ast</indexterm><code>\ast</code></tableterm> + <item> + <para><math>\ast</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\asymp</indexterm><code>\asymp</code></tableterm> + <item> + <para><math>\asymp</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\backslash</indexterm><code>\backslash</code></tableterm> + <item> + <para>\ (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\beta</indexterm><code>\beta</code></tableterm> + <item> + <para><math>\beta</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigcap</indexterm><code>\bigcap</code></tableterm> + <item> + <para><math>\bigcap</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigcirc</indexterm><code>\bigcirc</code></tableterm> + <item> + <para><math>\bigcirc</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigcup</indexterm><code>\bigcup</code></tableterm> + <item> + <para><math>\bigcup</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigodot</indexterm><code>\bigodot</code></tableterm> + <item> + <para><math>\bigodot</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigoplus</indexterm><code>\bigoplus</code></tableterm> + <item> + <para><math>\bigoplus</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigotimes</indexterm><code>\bigotimes</code></tableterm> + <item> + <para><math>\bigotimes</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigtriangledown</indexterm><code>\bigtriangledown</code></tableterm> + <item> + <para><math>\bigtriangledown</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigtriangleup</indexterm><code>\bigtriangleup</code></tableterm> + <item> + <para><math>\bigtriangleup</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigsqcup</indexterm><code>\bigsqcup</code></tableterm> + <item> + <para><math>\bigsqcup</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\biguplus</indexterm><code>\biguplus</code></tableterm> + <item> + <para><math>\biguplus</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigcap</indexterm><code>\bigcap</code></tableterm> + <item> + <para><math>\bigvee</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bigwedge</indexterm><code>\bigwedge</code></tableterm> + <item> + <para><math>\bigwedge</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bot</indexterm><code>\bot</code></tableterm> + <item> + <para><math>\bot</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bowtie</indexterm><code>\bowtie</code></tableterm> + <item> + <para><math>\bowtie</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Box</indexterm><code>\Box</code></tableterm> + <item> + <para>(square open box symbol) +<!-- xx not in plain --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bullet</indexterm><code>\bullet</code></tableterm><indexterm index="cp">bullet symbol</indexterm> + <item> + <para><math>\bullet</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cap</indexterm><code>\cap</code></tableterm> + <item> + <para><math>\cap</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cdot</indexterm><code>\cdot</code></tableterm> + <item> + <para><math>\cdot</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\chi</indexterm><code>\chi</code></tableterm> + <item> + <para><math>\chi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\circ</indexterm><code>\circ</code></tableterm> + <item> + <para><math>\circ</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\clubsuit</indexterm><code>\clubsuit</code></tableterm> + <item> + <para><math>\clubsuit</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cong</indexterm><code>\cong</code></tableterm> + <item> + <para><math>\cong</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\coprod</indexterm><code>\coprod</code></tableterm> + <item> + <para><math>\coprod</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cup</indexterm><code>\cup</code></tableterm> + <item> + <para><math>\cup</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dagger</indexterm><code>\dagger</code></tableterm> + <item> + <para><math>\dagger</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dashv</indexterm><code>\dashv</code></tableterm> + <item> + <para><math>\dashv</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ddagger</indexterm><code>\ddagger</code></tableterm> + <item> + <para><math>\dagger</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Delta</indexterm><code>\Delta</code></tableterm> + <item> + <para><math>\Delta</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\delta</indexterm><code>\delta</code></tableterm> + <item> + <para><math>\delta</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Diamond</indexterm><code>\Diamond</code></tableterm> + <item> + <para>bigger <math>\diamond</math> +<!-- xx not in plain --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\diamond</indexterm><code>\diamond</code></tableterm> + <item> + <para><math>\diamond</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\diamondsuit</indexterm><code>\diamondsuit</code></tableterm> + <item> + <para><math>\diamondsuit</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\div</indexterm><code>\div</code></tableterm> + <item> + <para><math>\div</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\doteq</indexterm><code>\doteq</code></tableterm> + <item> + <para><math>\doteq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\downarrow</indexterm><code>\downarrow</code></tableterm> + <item> + <para><math>\downarrow</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Downarrow</indexterm><code>\Downarrow</code></tableterm> + <item> + <para><math>\Downarrow</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ell</indexterm><code>\ell</code></tableterm> + <item> + <para><math>\ell</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\emptyset</indexterm><code>\emptyset</code></tableterm> + <item> + <para><math>\emptyset</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\epsilon</indexterm><code>\epsilon</code></tableterm> + <item> + <para><math>\epsilon</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\equiv</indexterm><code>\equiv</code></tableterm> + <item> + <para><math>\equiv</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\eta</indexterm><code>\eta</code></tableterm> + <item> + <para><math>\eta</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\exists</indexterm><code>\exists</code></tableterm> + <item> + <para><math>\exists</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\flat</indexterm><code>\flat</code></tableterm> + <item> + <para><math>\flat</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\forall</indexterm><code>\forall</code></tableterm> + <item> + <para><math>\forall</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\frown</indexterm><code>\frown</code></tableterm> + <item> + <para><math>\frown</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Gamma</indexterm><code>\Gamma</code></tableterm> + <item> + <para><math>\Gamma</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\gamma</indexterm><code>\gamma</code></tableterm> + <item> + <para><math>\gamma</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ge</indexterm><code>\ge</code></tableterm> + <item> + <para><math>\ge</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\geq</indexterm><code>\geq</code></tableterm> + <item> + <para><math>\geq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\gets</indexterm><code>\gets</code></tableterm> + <item> + <para><math>\gets</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\gg</indexterm><code>\gg</code></tableterm> + <item> + <para><math>\gg</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\hbar</indexterm><code>\hbar</code></tableterm> + <item> + <para><math>\hbar</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\heartsuit</indexterm><code>\heartsuit</code></tableterm> + <item> + <para><math>\heartsuit</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\hookleftarrow</indexterm><code>\hookleftarrow</code></tableterm> + <item> + <para><math>\hookleftarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\hookrightarrow</indexterm><code>\hookrightarrow</code></tableterm> + <item> + <para><math>\hookrightarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\iff</indexterm><code>\iff</code></tableterm> + <item> + <para><math>\iff</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Im</indexterm><code>\Im</code></tableterm> + <item> + <para><math>\Im</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\in</indexterm><code>\in</code></tableterm> + <item> + <para><math>\in</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\infty</indexterm><code>\infty</code></tableterm> + <item> + <para><math>\infty</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\int</indexterm><code>\int</code></tableterm> + <item> + <para><math>\int</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\iota</indexterm><code>\iota</code></tableterm> + <item> + <para><math>\iota</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Join</indexterm><code>\Join</code></tableterm> + <item> + <para>condensed bowtie symbol (relation) +<!-- xx not in plain --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\kappa</indexterm><code>\kappa</code></tableterm> + <item> + <para><math>\kappa</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Lambda</indexterm><code>\Lambda</code></tableterm> + <item> + <para><math>\Lambda</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lambda</indexterm><code>\lambda</code></tableterm> + <item> + <para><math>\lambda</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\land</indexterm><code>\land</code></tableterm> + <item> + <para><math>\land</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\langle</indexterm><code>\langle</code></tableterm> + <item> + <para><math>\langle</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lbrace</indexterm><code>\lbrace</code></tableterm> + <item> + <para><math>\lbrace</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lbrack</indexterm><code>\lbrack</code></tableterm> + <item> + <para><math>\lbrack</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lceil</indexterm><code>\lceil</code></tableterm> + <item> + <para><math>\lceil</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\le</indexterm><code>\le</code></tableterm> + <item> + <para><math>\le</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\leadsto</indexterm><code>\leadsto</code></tableterm> +<!-- xx missing from plain --> + <item> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Leftarrow</indexterm><code>\Leftarrow</code></tableterm> + <item> + <para><math>\Leftarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\leftarrow</indexterm><code>\leftarrow</code></tableterm> + <item> + <para><math>\leftarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\leftharpoondown</indexterm><code>\leftharpoondown</code></tableterm> + <item> + <para><math>\leftharpoondown</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\leftharpoonup</indexterm><code>\leftharpoonup</code></tableterm> + <item> + <para><math>\leftharpoonup</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Leftrightarrow</indexterm><code>\Leftrightarrow</code></tableterm> + <item> + <para><math>\Leftrightarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\leftrightarrow</indexterm><code>\leftrightarrow</code></tableterm> + <item> + <para><math>\leftrightarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\leq</indexterm><code>\leq</code></tableterm> + <item> + <para><math>\leq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lfloor</indexterm><code>\lfloor</code></tableterm> + <item> + <para><math>\lfloor</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lhd</indexterm><code>\lhd</code></tableterm> + <item> + <para>(left-pointing arrow head) +<!-- xx not in plain --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ll</indexterm><code>\ll</code></tableterm> + <item> + <para><math>\ll</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lnot</indexterm><code>\lnot</code></tableterm> + <item> + <para><math>\lnot</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\longleftarrow</indexterm><code>\longleftarrow</code></tableterm> + <item> + <para><math>\longleftarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\longleftrightarrow</indexterm><code>\longleftrightarrow</code></tableterm> + <item> + <para><math>\longleftrightarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\longmapsto</indexterm><code>\longmapsto</code></tableterm> + <item> + <para><math>\longmapsto</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\longrightarrow</indexterm><code>\longrightarrow</code></tableterm> + <item> + <para><math>\longrightarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lor</indexterm><code>\lor</code></tableterm> + <item> + <para><math>\lor</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\mapsto</indexterm><code>\mapsto</code></tableterm> + <item> + <para><math>\mapsto</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\mho</indexterm><code>\mho</code></tableterm> +<!-- xx not in plain --> + <item> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\mid</indexterm><code>\mid</code></tableterm> + <item> + <para><math>\mid</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\models</indexterm><code>\models</code></tableterm> + <item> + <para><math>\models</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\mp</indexterm><code>\mp</code></tableterm> + <item> + <para><math>\mp</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\mu</indexterm><code>\mu</code></tableterm> + <item> + <para><math>\mu</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\nabla</indexterm><code>\nabla</code></tableterm> + <item> + <para><math>\nabla</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\natural</indexterm><code>\natural</code></tableterm> + <item> + <para><math>\natural</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ne</indexterm><code>\ne</code></tableterm> + <item> + <para><math>\ne</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\nearrow</indexterm><code>\nearrow</code></tableterm> + <item> + <para><math>\nearrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\neg</indexterm><code>\neg</code></tableterm> + <item> + <para><math>\neg</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\neq</indexterm><code>\neq</code></tableterm> + <item> + <para><math>\neq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ni</indexterm><code>\ni</code></tableterm> + <item> + <para><math>\ni</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\not</indexterm><code>\not</code></tableterm> + <item> + <para>Overstrike a following operator with a /, as in <math>\not=</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\notin</indexterm><code>\notin</code></tableterm> + <item> + <para><math>\ni</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\nu</indexterm><code>\nu</code></tableterm> + <item> + <para><math>\nu</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\nwarrow</indexterm><code>\nwarrow</code></tableterm> + <item> + <para><math>\nwarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\odot</indexterm><code>\odot</code></tableterm> + <item> + <para><math>\odot</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\oint</indexterm><code>\oint</code></tableterm> + <item> + <para><math>\oint</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Omega</indexterm><code>\Omega</code></tableterm> + <item> + <para><math>\Omega</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\omega</indexterm><code>\omega</code></tableterm> + <item> + <para><math>\omega</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ominus</indexterm><code>\ominus</code></tableterm> + <item> + <para><math>\ominus</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\oplus</indexterm><code>\oplus</code></tableterm> + <item> + <para><math>\oplus</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\oslash</indexterm><code>\oslash</code></tableterm> + <item> + <para><math>\oslash</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\otimes</indexterm><code>\otimes</code></tableterm> + <item> + <para><math>\otimes</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\owns</indexterm><code>\owns</code></tableterm> + <item> + <para><math>\owns</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\parallel</indexterm><code>\parallel</code></tableterm> + <item> + <para><math>\parallel</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\partial</indexterm><code>\partial</code></tableterm> + <item> + <para><math>\partial</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\perp</indexterm><code>\perp</code></tableterm> + <item> + <para><math>\perp</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\phi</indexterm><code>\phi</code></tableterm> + <item> + <para><math>\phi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Pi</indexterm><code>\Pi</code></tableterm> + <item> + <para><math>\Pi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\pi</indexterm><code>\pi</code></tableterm> + <item> + <para><math>\pi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\pm</indexterm><code>\pm</code></tableterm> + <item> + <para><math>\pm</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\prec</indexterm><code>\prec</code></tableterm> + <item> + <para><math>\prec</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\preceq</indexterm><code>\preceq</code></tableterm> + <item> + <para><math>\preceq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\prime</indexterm><code>\prime</code></tableterm> + <item> + <para><math>\prime</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\prod</indexterm><code>\prod</code></tableterm> + <item> + <para><math>\prod</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\propto</indexterm><code>\propto</code></tableterm> + <item> + <para><math>\propto</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Psi</indexterm><code>\Psi</code></tableterm> + <item> + <para><math>\Psi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\psi</indexterm><code>\psi</code></tableterm> + <item> + <para><math>\psi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rangle</indexterm><code>\rangle</code></tableterm> + <item> + <para><math>\rangle</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rbrace</indexterm><code>\rbrace</code></tableterm> + <item> + <para><math>\rbrace</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rbrack</indexterm><code>\rbrack</code></tableterm> + <item> + <para><math>\rbrack</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rceil</indexterm><code>\rceil</code></tableterm> + <item> + <para><math>\rceil</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Re</indexterm><code>\Re</code></tableterm> + <item> + <para><math>\Re</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rfloor</indexterm><code>\rfloor</code></tableterm> + <item> + <para><math>\rfloor</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rhd</indexterm><code>\rhd</code></tableterm> + <item> + <para>(binary operation) +<!-- xx not in plain @math{\rhd} --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rho</indexterm><code>\rho</code></tableterm> + <item> + <para><math>\rho</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Rightarrow</indexterm><code>\Rightarrow</code></tableterm> + <item> + <para><math>\Rightarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rightarrow</indexterm><code>\rightarrow</code></tableterm> + <item> + <para><math>\rightarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rightharpoondown</indexterm><code>\rightharpoondown</code></tableterm> + <item> + <para><math>\rightharpoondown</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rightharpoonup</indexterm><code>\rightharpoonup</code></tableterm> + <item> + <para><math>\rightharpoonup</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rightleftharpoons</indexterm><code>\rightleftharpoons</code></tableterm> + <item> + <para><math>\rightleftharpoons</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\searrow</indexterm><code>\searrow</code></tableterm> + <item> + <para><math>\searrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\setminus</indexterm><code>\setminus</code></tableterm> + <item> + <para><math>\setminus</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sharp</indexterm><code>\sharp</code></tableterm> + <item> + <para><math>\sharp</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Sigma</indexterm><code>\Sigma</code></tableterm> + <item> + <para><math>\Sigma</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sigma</indexterm><code>\sigma</code></tableterm> + <item> + <para><math>\sigma</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sim</indexterm><code>\sim</code></tableterm> + <item> + <para><math>\sim</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\simeq</indexterm><code>\simeq</code></tableterm> + <item> + <para><math>\simeq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\smallint</indexterm><code>\smallint</code></tableterm> + <item> + <para><math>\smallint</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\smile</indexterm><code>\smile</code></tableterm> + <item> + <para><math>\smile</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\spadesuit</indexterm><code>\spadesuit</code></tableterm> + <item> + <para><math>\spadesuit</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sqcap</indexterm><code>\sqcap</code></tableterm> + <item> + <para><math>\sqcap</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sqcup</indexterm><code>\sqcup</code></tableterm> + <item> + <para><math>\sqcup</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sqsubset</indexterm><code>\sqsubset</code></tableterm> + <item> + <para>(relation) +<!-- not in plain (@math{\sqsubset}) --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sqsubseteq</indexterm><code>\sqsubseteq</code></tableterm> + <item> + <para><math>\sqsubseteq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sqsupset</indexterm><code>\sqsupset</code></tableterm> + <item> + <para>(relation) +<!-- not in plain (@math{\sqsupset}) --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sqsupseteq</indexterm><code>\sqsupseteq</code></tableterm> + <item> + <para><math>\sqsupseteq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\star</indexterm><code>\star</code></tableterm> + <item> + <para><math>\star</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\subset</indexterm><code>\subset</code></tableterm> + <item> + <para><math>\subset</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\subseteq</indexterm><code>\subseteq</code></tableterm> + <item> + <para><math>\subseteq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\succ</indexterm><code>\succ</code></tableterm> + <item> + <para><math>\succ</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\succeq</indexterm><code>\succeq</code></tableterm> + <item> + <para><math>\succeq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sum</indexterm><code>\sum</code></tableterm> + <item> + <para><math>\sum</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\supset</indexterm><code>\supset</code></tableterm> + <item> + <para><math>\supset</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\supseteq</indexterm><code>\supseteq</code></tableterm> + <item> + <para><math>\supseteq</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\surd</indexterm><code>\surd</code></tableterm> + <item> + <para><math>\surd</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\swarrow</indexterm><code>\swarrow</code></tableterm> + <item> + <para><math>\swarrow</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\tau</indexterm><code>\tau</code></tableterm> + <item> + <para><math>\tau</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\theta</indexterm><code>\theta</code></tableterm> + <item> + <para><math>\theta</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\times</indexterm><code>\times</code></tableterm> + <item> + <para><math>\times</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\to</indexterm><code>\to</code></tableterm> + <item> + <para><math>\to</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\top</indexterm><code>\top</code></tableterm> + <item> + <para><math>\top</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\triangle</indexterm><code>\triangle</code></tableterm> + <item> + <para><math>\triangle</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\triangleleft</indexterm><code>\triangleleft</code></tableterm> + <item> + <para><math>\triangleleft</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\triangleright</indexterm><code>\triangleright</code></tableterm> + <item> + <para><math>\triangleright</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\unlhd</indexterm><code>\unlhd</code></tableterm> + <item> + <para>left-pointing arrowhead with line under (binary operation) +<!-- not in plain --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\unrhd</indexterm><code>\unrhd</code></tableterm> + <item> + <para>right-pointing arrowhead with line under (binary operation) +<!-- not in plain --></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Uparrow</indexterm><code>\Uparrow</code></tableterm> + <item> + <para><math>\Uparrow</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\uparrow</indexterm><code>\uparrow</code></tableterm> + <item> + <para><math>\uparrow</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Updownarrow</indexterm><code>\Updownarrow</code></tableterm> + <item> + <para><math>\Updownarrow</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\updownarrow</indexterm><code>\updownarrow</code></tableterm> + <item> + <para><math>\updownarrow</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\uplus</indexterm><code>\uplus</code></tableterm> + <item> + <para><math>\uplus</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Upsilon</indexterm><code>\Upsilon</code></tableterm> + <item> + <para><math>\Upsilon</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\upsilon</indexterm><code>\upsilon</code></tableterm> + <item> + <para><math>\upsilon</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\varepsilon</indexterm><code>\varepsilon</code></tableterm> + <item> + <para><math>\varepsilon</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\varphi</indexterm><code>\varphi</code></tableterm> + <item> + <para><math>\varphi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\varpi</indexterm><code>\varpi</code></tableterm> + <item> + <para><math>\varpi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\varrho</indexterm><code>\varrho</code></tableterm> + <item> + <para><math>\varrho</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\varsigma</indexterm><code>\varsigma</code></tableterm> + <item> + <para><math>\varsigma</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\vartheta</indexterm><code>\vartheta</code></tableterm> + <item> + <para><math>\vartheta</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\vdash</indexterm><code>\vdash</code></tableterm> + <item> + <para><math>\vdash</math> (relation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\vee</indexterm><code>\vee</code></tableterm> + <item> + <para><math>\vee</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Vert</indexterm><code>\Vert</code></tableterm> + <item> + <para><math>\Vert</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\vert</indexterm><code>\vert</code></tableterm> + <item> + <para><math>\vert</math> (delimiter)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\wedge</indexterm><code>\wedge</code></tableterm> + <item> + <para><math>\wedge</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\wp</indexterm><code>\wp</code></tableterm> + <item> + <para><math>\wp</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\wr</indexterm><code>\wr</code></tableterm> + <item> + <para><math>\wr</math> (binary operation)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Xi</indexterm><code>\Xi</code></tableterm> + <item> + <para><math>\Xi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\xi</indexterm><code>\xi</code></tableterm> + <item> + <para><math>\xi</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\zeta</indexterm><code>\zeta</code></tableterm> + <item> + <para><math>\zeta</math></para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Math functions</nodename> + <nodenext>Math accents</nodenext> + <nodeprev>Math symbols</nodeprev> + <nodeup>Math formulas</nodeup> + <section> + <title>Math functions</title> + <para><indexterm index="cp">math functions</indexterm><indexterm index="cp">functions, math</indexterm> These commands produce roman function names in math mode with proper spacing.</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\arccos</indexterm><code>\arccos</code></tableterm> + <item> + <para><math>\arccos</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\arcsin</indexterm><code>\arcsin</code></tableterm> + <item> + <para><math>\arcsin</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\arctan</indexterm><code>\arctan</code></tableterm> + <item> + <para><math>\arctan</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\arg</indexterm><code>\arg</code></tableterm> + <item> + <para><math>\arg</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\bmod</indexterm><code>\bmod</code></tableterm> + <item> + <para>Binary modulo operator (<math>x \bmod y</math>)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cos</indexterm><code>\cos</code></tableterm> + <item> + <para><math>\cos</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cosh</indexterm><code>\cosh</code></tableterm> + <item> + <para><math>\cosh</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cot</indexterm><code>\cot</code></tableterm> + <item> + <para><math>\cos</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\coth</indexterm><code>\coth</code></tableterm> + <item> + <para><math>\cosh</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\csc</indexterm><code>\csc</code></tableterm> + <item> + <para><math>\csc</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\deg</indexterm><code>\deg</code></tableterm> + <item> + <para><math>\deg</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\det</indexterm><code>\det</code></tableterm> + <item> + <para><math>\deg</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dim</indexterm><code>\dim</code></tableterm> + <item> + <para><math>\dim</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\exp</indexterm><code>\exp</code></tableterm> + <item> + <para><math>\exp</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\gcd</indexterm><code>\gcd</code></tableterm> + <item> + <para><math>\gcd</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\hom</indexterm><code>\hom</code></tableterm> + <item> + <para><math>\hom</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\inf</indexterm><code>\inf</code></tableterm> + <item> + <para><math>\inf</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ker</indexterm><code>\ker</code></tableterm> + <item> + <para><math>\ker</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lg</indexterm><code>\lg</code></tableterm> + <item> + <para><math>\lg</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lim</indexterm><code>\lim</code></tableterm> + <item> + <para><math>\lim</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\liminf</indexterm><code>\liminf</code></tableterm> + <item> + <para><math>\liminf</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\limsup</indexterm><code>\limsup</code></tableterm> + <item> + <para><math>\limsup</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ln</indexterm><code>\ln</code></tableterm> + <item> + <para><math>\ln</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\log</indexterm><code>\log</code></tableterm> + <item> + <para><math>\log</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\max</indexterm><code>\max</code></tableterm> + <item> + <para><math>\max</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\min</indexterm><code>\min</code></tableterm> + <item> + <para><math>\min</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\pmod</indexterm><code>\pmod</code></tableterm> + <item> + <para>parenthesized modulus, as in (<math>\pmod 2^n - 1</math>)</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\Pr</indexterm><code>\Pr</code></tableterm> + <item> + <para><math>\Pr</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sec</indexterm><code>\sec</code></tableterm> + <item> + <para><math>\sec</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sin</indexterm><code>\sin</code></tableterm> + <item> + <para><math>\sin</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sinh</indexterm><code>\sinh</code></tableterm> + <item> + <para><math>\sinh</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sup</indexterm><code>\sup</code></tableterm> + <item> + <para><math>\sup</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\tan</indexterm><code>\tan</code></tableterm> + <item> + <para><math>\tan</math></para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\tanh</indexterm><code>\tanh</code></tableterm> + <item> + <para><math>\tanh</math></para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Math accents</nodename> + <nodenext>Spacing in math mode</nodenext> + <nodeprev>Math functions</nodeprev> + <nodeup>Math formulas</nodeup> + <section> + <title>Math accents</title> + <para><indexterm index="cp">math accents</indexterm><indexterm index="cp">accents, mathematical</indexterm> &latex; provides a variety of commands for producing accented letters in math. These are different from accents in normal text (see <xref><xrefnodename>Accents</xrefnodename></xref>).</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\acute</indexterm><code>\acute</code></tableterm><indexterm index="cp">acute accent, math</indexterm> + <item> + <para>Math acute accent: <math>\acutex</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\breve</indexterm><code>\breve</code></tableterm><indexterm index="cp">breve accent, math</indexterm> + <item> + <para>Math breve accent: <math>\brevex</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\check</indexterm><code>\check</code></tableterm><indexterm index="cp">check accent, math</indexterm><indexterm index="cp">hác<ek accent, math</indexterm> + <item> + <para>Math hác<ek (check) accent: <math>\checkx</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ddot</indexterm><code>\ddot</code></tableterm><indexterm index="cp">double dot accent, math</indexterm> + <item> + <para>Math dieresis accent: <math>\ddotx</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dot</indexterm><code>\dot</code></tableterm><indexterm index="cp">overdot accent, math</indexterm><indexterm index="cp">dot over accent, math</indexterm> + <item> + <para>Math dot accent: <math>\dotx</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\grave</indexterm><code>\grave</code></tableterm><indexterm index="cp">grave accent, math</indexterm> + <item> + <para>Math grave accent: <math>\gravex</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\hat</indexterm><code>\hat</code></tableterm><indexterm index="cp">hat accent, math</indexterm><indexterm index="cp">circumflex accent, math</indexterm> + <item> + <para>Math hat (circumflex) accent: <math>\hatx</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\imath</indexterm><code>\imath</code></tableterm><indexterm index="cp">dotless i, math</indexterm> + <item> + <para>Math dotless i.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\jmath</indexterm><code>\jmath</code></tableterm><indexterm index="cp">dotless j, math</indexterm> + <item> + <para>Math dotless j.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\tilde</indexterm><code>\tilde</code></tableterm><indexterm index="cp">tilde accent, math</indexterm> + <item> + <para>Math tilde accent: <math>\tildex</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\vec</indexterm><code>\vec</code></tableterm><indexterm index="cp">vector symbol, math</indexterm> + <item> + <para>Math vector symbol: <math>\vecx</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\widehat</indexterm><code>\widehat</code></tableterm><indexterm index="cp">wide hat accent, math</indexterm> + <item> + <para>Math wide hat accent: <math>\widehatx+y</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\widehat</indexterm><code>\widehat</code></tableterm><indexterm index="cp">wide tile accent, math</indexterm> + <item> + <para>Math wide tilde accent: <math>\widetildex+y</math>.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Spacing in math mode</nodename> + <nodenext>Math Miscellany</nodenext> + <nodeprev>Math accents</nodeprev> + <nodeup>Math formulas</nodeup> + <section> + <title>Spacing in math mode</title> + <para><indexterm index="cp">spacing within math mode</indexterm><indexterm index="cp">math mode, spacing</indexterm> 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:</para> + <table> + <tableitem> + <tableterm><code>\;</code></tableterm><indexterm index="fn">\;</indexterm> + <item> + <para>A thick space (<math>5\over18\,</math>quad).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\:</code></tableterm> + <tableterm><code>\></code></tableterm><indexterm index="fn">\:</indexterm><indexterm index="fn">\></indexterm> + <item> + <para>Both of these produce a medium space (<math>2\over9\,</math>quad).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\,</code></tableterm><indexterm index="fn">\,</indexterm> + <item> + <para>A thin space (<math>1\over6\,</math>quad); not restricted to math mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\!</code></tableterm> + <item> + <para>A negative thin space (<math>-1\over6\,</math>quad).</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Math Miscellany</nodename> + <nodeprev>Spacing in math mode</nodeprev> + <nodeup>Math formulas</nodeup> + <section> + <title>Math Miscellany</title> + <para><indexterm index="cp">math Miscellany</indexterm></para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\*</indexterm><code>\*</code></tableterm><indexterm index="cp">discretionary multiplication</indexterm><indexterm index="cp">multiplication symbol, discretionary line break</indexterm> + <item> + <para>A “discretionary” multiplication symbol, at which a line break is allowed.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\cdots</indexterm><code>\cdots</code></tableterm> + <item> + <para>A horizontal ellipsis with the dots raised to the center of the line.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ddots</indexterm><code>\ddots</code></tableterm> + <item> + <para>A diagonal ellipsis: <math>\ddots</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\frac{num}{den}</indexterm><code>\frac{num}{den}</code></tableterm><indexterm index="fn">\frac</indexterm> + <item> + <para>Produces the fraction <code>num</code> divided by <code>den</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\left <var>delim1</var> ... \right <var>delim2</var></indexterm><code>\left <var>delim1</var> ... \right <var>delim2</var></code></tableterm><indexterm index="fn">\right</indexterm><indexterm index="cp">null delimiter</indexterm> + <item> + <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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\overbrace{<var>text</var>}</indexterm><code>\overbrace{<var>text</var>}</code></tableterm> + <item> + <para>Generates a brace over <var>text</var>. For example, <math>\overbracex+\cdots+x^k \rm\;times</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\overline{<var>text</var>}</indexterm><code>\overline{<var>text</var>}</code></tableterm> + <item> + <para>Generates a horizontal line over <var>tex</var>. For exampe, <math>\overlinex+y</math>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\sqrt[<var>root</var>]{arg}</indexterm><code>\sqrt[<var>root</var>]{arg}</code></tableterm> + <item> + <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 <code>$\sqrt[3]{x+y}$</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\stackrel{<var>text</var>}{<var>relation</var>}</indexterm><code>\stackrel{<var>text</var>}{<var>relation</var>}</code></tableterm> + <item> + <para>Puts <var>text</var> above <var>relation</var>. For example, <code>\stackrel{f}{\longrightarrow}</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\underbrace{math}</indexterm><code>\underbrace{math}</code></tableterm> + <item> + <para>Generates <var>math</var> with a brace underneath.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\underline{text}</indexterm><code>\underline{text}</code></tableterm> + <item> + <para>Causes <var>text</var>, which may be either math mode or not, to be underlined.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\vdots</indexterm><code>\vdots</code></tableterm><indexterm index="fn">\vdots</indexterm> + <item> + <para>Produces a vertical ellipsis.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Modes</nodename> + <nodenext>Page Styles</nodenext> + <nodeprev>Math formulas</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Modes</title> + <para><indexterm index="cp">modes</indexterm><indexterm index="cp">paragraph mode</indexterm><indexterm index="cp">math mode</indexterm><indexterm index="cp">left-to-right mode</indexterm><indexterm index="cp">lR mode</indexterm></para> + <para>When &latex; is processing your input text, it is always in one of three modes:</para> + <itemize> + <itemfunction>•</itemfunction> + <item> + <para>Paragraph mode</para> + </item> + <item> + <para>Math mode</para> + </item> + <item> + <para>Left-to-right mode, called LR mode for short</para> + </item> + </itemize> + <para>&latex; changes mode only when it goes up or down a staircase to a different level, though not all level changes produce mode changes. Mode changes occur only when entering or leaving an environment, or when &latex; is processing the argument of certain text-producing commands.</para> + <para>“Paragraph mode” is the most common; it's the one &latex; is in when processing ordinary text. In that mode, &latex; breaks your text into lines and breaks the lines into pages. &latex; is in “math mode” when it's generating a mathematical formula. In “LR mode”, 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 right; it never starts a new line in LR mode. Even if you put a hundred words into an <code>\mbox</code>, &latex; would keep typesetting them from left to right inside a single box, and then complain because the resulting box was too wide to fit on the line.</para> + <para>&latex; is in LR mode when it starts making a box with an <code>\mbox</code> command. You can get it to enter a different mode inside the box - for example, you can make it enter math mode to put a formula in the box. There are also several text-producing commands and environments for making a box that put &latex; in paragraph mode. The box make by one of these commands or environments will be called a <code>parbox</code>. When &latex; is in paragraph mode while making a box, it is said to be in “inner paragraph mode”. Its normal paragraph mode, which it starts out in, is called “outer paragraph mode”.</para> + </chapter> + </node> + <node> + <nodename>Page Styles</nodename> + <nodenext>Spaces</nodenext> + <nodeprev>Modes</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Page Styles</title> + <para><indexterm index="cp">styles, page</indexterm><indexterm index="cp">page styles</indexterm> The <code>\documentclass</code> command determines the size and position of the page's head and foot. The page style determines what goes in them.</para> + <menu> + <menuentry> + <menunode>\maketitle</menunode> + <menutitle>\maketitle</menutitle> + <menucomment>Generate a title page.</menucomment> + </menuentry> + <menuentry> + <menunode>\pagenumbering</menunode> + <menutitle>\pagenumbering</menutitle> + <menucomment>Set the style used for page numbers.</menucomment> + </menuentry> + <menuentry> + <menunode>\pagestyle</menunode> + <menutitle>\pagestyle</menutitle> + <menucomment>Change the headings/footings style.</menucomment> + </menuentry> + <menuentry> + <menunode>\thispagestyle</menunode> + <menutitle>\thispagestyle</menutitle> + <menucomment>Change the headings/footings style for this page.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\maketitle</nodename> + <nodenext>\pagenumbering</nodenext> + <nodeup>Page Styles</nodeup> + <section> + <title><code>\maketitle</code></title> + <para><indexterm index="cp">titles, making</indexterm><indexterm index="fn">\maketitle</indexterm> The <code>\maketitle</code> command generates a title on a separate title page—except in the <code>article</code> class, where the title is placed at the top of the first page. Information used to produce the title is obtained from the following declarations:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\author{<var>name</var> \and <var>name2</var>}</indexterm><code>\author{<var>name</var> \and <var>name2</var>}</code></tableterm><indexterm index="cp">author, for titlepage</indexterm><indexterm index="fn">\\ <r>for <code>\author</code></r></indexterm><indexterm index="fn">\and <r>for <code>\author</code></r></indexterm> + <item> + <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's entry—for example, to give the author's institution or address.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\date{<var>text</var>}</indexterm><code>\date{<var>text</var>}</code></tableterm><indexterm index="cp">date, for titlepage</indexterm> + <item> + <para>The <code>\date</code> command declares <var>text</var> to be the document's date. With no <code>\date</code> command, the current date (see <xref><xrefnodename>\today</xrefnodename></xref>) is used.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\thanks{<var>text</var>}</indexterm><code>\thanks{<var>text</var>}</code></tableterm><indexterm index="cp">thanks, for titlepage</indexterm><indexterm index="cp">credit footnote</indexterm> + <item> + <para>The <code>\thanks</code> command produces a <code>\footnote</code> to the title, usually used for credit acknowledgements.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\title{<var>text</var>}</indexterm><code>\title{<var>text</var>}</code></tableterm><indexterm index="cp">title, for titlepage</indexterm><indexterm index="fn">\\ <r>for <code>\title</code></r></indexterm> + <item> + <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> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\pagenumbering</nodename> + <nodenext>\pagestyle</nodenext> + <nodeprev>\maketitle</nodeprev> + <nodeup>Page Styles</nodeup> + <section> + <title><code>\pagenumbering</code></title> + <para><indexterm index="fn">\pagenumbering</indexterm><indexterm index="cp">page numbering style</indexterm> Synopsis:</para> + <example xml:space="preserve">\pagenumbering{<var>style</var>}</example> + <para>Specifies the style of page numbers, according to <var>style</var>:</para> + <table> + <tableitem> + <tableterm><code>arabic</code></tableterm> + <item> + <para>arabic numerals</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>roman</code></tableterm> + <item> + <para>lowercase Roman numerals</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>Roman</code></tableterm> + <item> + <para>uppercase Roman numerals</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>alph</code></tableterm> + <item> + <para>lowercase letters</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>Alph</code></tableterm> + <item> + <para>uppercase letters</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\pagestyle</nodename> + <nodenext>\thispagestyle</nodenext> + <nodeprev>\pagenumbering</nodeprev> + <nodeup>Page Styles</nodeup> + <section> + <title><code>\pagestyle</code></title> + <para><indexterm index="fn">\pagestyle</indexterm><indexterm index="cp">header style</indexterm><indexterm index="cp">footer style</indexterm><indexterm index="cp">running header and footer style</indexterm> Synopsis:</para> + <example xml:space="preserve">\pagestyle{<var>style</var>}</example> + <para>The <code>\pagestyle</code> command specifies how the headers and footers are typeset from the current page onwards. Values for <var>style</var>:</para> + <table> + <tableitem> + <tableterm><code>plain</code></tableterm> + <item> + <para>Just a plain page number.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>empty</code></tableterm> + <item> + <para>Empty headers and footers, e.g., no page numbers.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>headings</code></tableterm> + <item> + <para>Put running headers on each page. The document style specifies what goes in the headers.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>myheadings</code></tableterm> + <item> + <para>Custom headers, specified via the <code>\markboth</code> or the <code>\markright</code> commands.</para> + </item> + </tableitem> + </table> + <para>Here are the descriptions of <code>\markboth</code> and <code>\markright</code>:</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\markboth{<var>left</var>}{<var>right</var>}</indexterm><code>\markboth{<var>left</var>}{<var>right</var>}</code></tableterm> + <item> + <para>Sets both the left and the right heading. A “left-hand heading” (<var>left</var>) is generated by the last <code>\markboth</code> command before the end of the page, while a “right-hand heading” (<var>right</var> is 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> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\markright{<var>right</var>}</indexterm><code>\markright{<var>right</var>}</code></tableterm> + <item> + <para>Sets the right heading, leaving the left heading unchanged.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\thispagestyle</nodename> + <nodeprev>\pagestyle</nodeprev> + <nodeup>Page Styles</nodeup> + <section> + <title><code>\thispagestyle{<var>style</var>}</code></title> + <para><indexterm index="fn">\thispagestyle</indexterm> The <code>\thispagestyle</code> command works in the same manner as the <code>\pagestyle</code> command (see previous section) except that it changes to <var>style</var> for the current page only.</para> + </section> + </node> + <node> + <nodename>Spaces</nodename> + <nodenext>Boxes</nodenext> + <nodeprev>Page Styles</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Spaces</title> + <para><indexterm index="cp">spaces</indexterm> &latex; has many ways to produce white (or filled) space.</para> + <para>Another space-producing command is <code>\,</code> to produce a “thin” space (usually 1/6<dmn>quad</dmn>). It can be used in text mode, but is more often useful in math mode (see <xref><xrefnodename>Spacing in math mode</xrefnodename></xref>).</para> + <menu> + <para>Horizontal space</para> + <menuentry> + <menunode>\hspace</menunode> + <menutitle>\hspace</menutitle> + <menucomment>Fixed horizontal space.</menucomment> + </menuentry> + <menuentry> + <menunode>\SPACE</menunode> + <menutitle>\SPACE</menutitle> + <menucomment>Normal interword space.</menucomment> + </menuentry> + <menuentry> + <menunode>\AT</menunode> + <menutitle>\AT</menutitle> + <menucomment>Ending a sentence.</menucomment> + </menuentry> + <menuentry> + <menunode>\thinspace</menunode> + <menutitle>\thinspace</menutitle> + <menucomment>One-sixth of an em.</menucomment> + </menuentry> + <menuentry> + <menunode>\/</menunode> + <menutitle>\/</menutitle> + <menucomment>Per-character italic correction.</menucomment> + </menuentry> + <menuentry> + <menunode>\hfill</menunode> + <menutitle>\hfill</menutitle> + <menucomment>Stretchable horizontal space.</menucomment> + </menuentry> + <menuentry> + <menunode>\hrulefill</menunode> + <menutitle>\hrulefill</menutitle> + <menucomment>Stretchable horizontal rule.</menucomment> + </menuentry> + <menuentry> + <menunode>\dotfill</menunode> + <menutitle>\dotfill</menutitle> + <menucomment>Stretchable horizontal dots.</menucomment> + </menuentry> + <para>Vertical space</para> + <menuentry> + <menunode>\addvspace</menunode> + <menutitle>\addvspace</menutitle> + <menucomment>Add arbitrary vertical space if needed.</menucomment> + </menuentry> + <menuentry> + <menunode>\bigskip \medskip \smallskip</menunode> + <menutitle>\bigskip \medskip \smallskip</menutitle> + <menucomment>Fixed vertical spaces.</menucomment> + </menuentry> + <menuentry> + <menunode>\vfill</menunode> + <menutitle>\vfill</menutitle> + <menucomment>Infinitely stretchable vertical space.</menucomment> + </menuentry> + <menuentry> + <menunode>\vspace</menunode> + <menutitle>\vspace</menutitle> + <menucomment>Add arbitrary vertical space.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\hspace</nodename> + <nodenext>\SPACE</nodenext> + <nodeup>Spaces</nodeup> + <section> + <title><code>\hspace</code></title> + <para><indexterm index="fn">\hspace</indexterm> Synopsis:</para> + <example xml:space="preserve">\hspace[*]{<var>length</var>}</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> + <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> + </section> + </node> + <node> + <nodename>\hfill</nodename> + <nodenext>\hrulefill</nodenext> + <nodeprev>\/</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\hfill</code></title> + <para><indexterm index="fn">\hfill</indexterm>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.</para> + <para><indexterm index="fn">\fill</indexterm>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> + </section> + </node> + <node> + <nodename>\SPACE</nodename> + <nodenext>\AT</nodenext> + <nodeprev>\hspace</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\SPACE</code></title> + <para><indexterm index="fn">\SPACE</indexterm><indexterm index="fn">\TAB</indexterm><indexterm index="fn">\NEWLINE</indexterm> The <code>\ </code> (space) command produces a normal interword space. It's useful after punctuation which shouldn't end a sentence. For example <code>Knuth's 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></para> + <para>In normal circumstances, <code>\</code><key>tab</key> and <code>\</code><key>newline</key> are equivalent to <code>\ </code>.</para> + </section> + </node> + <node> + <nodename>\AT</nodename> + <nodenext>\thinspace</nodenext> + <nodeprev>\SPACE</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\@</code></title> + <para><indexterm index="fn">\@</indexterm> 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>:</para> + <example xml:space="preserve">&dots; in C\@. Pascal, though &dots; +&dots; in C. Pascal, though &dots;</example> + <para role="continues">produces</para> +<!-- Texinfo does it differently, but the result is the same. --> + <quotation> + <para>&dots; in C&eosperiod; Pascal, though &dots; &dots; in C. Pascal, though &dots;</para> + </quotation> + </section> + </node> + <node> + <nodename>\thinspace</nodename> + <nodenext>\/</nodenext> + <nodeprev>\AT</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\thinspace</code></title> + <para><indexterm index="fn">\thinspace</indexterm> <code>\thinspace</code> produces an unbreakable and unstretchable space that is 1/6 of an em. This is the proper space to use in nested quotes, as in '<dmn>”</dmn>.</para> + </section> + </node> + <node> + <nodename>\/</nodename> + <nodenext>\hfill</nodenext> + <nodeprev>\thinspace</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\/</code></title> + <para><indexterm index="fn">\/</indexterm> The <code>\/</code> command produces an <dfn>italic correction</dfn>. This is a small space defined by the font designer for a given character, to avoid the character colliding with whatever follows. The italic <i>f</i> character typically has a large italic correction value.</para> + <para>If the following character is a period or comma, it's not necessary to insert an italic correction, since those punctuation symbols have a very small height. However, with semicolons or colons, as well as normal letters, it can help. Compare <i>f: f;</i> (in the &tex; output, the `f's are nicely separated) with <i>f: f;</i>.</para> + <para>Despite the name, roman characters can also have an italic correction. Compare pdf&tex; (in the &tex; output, there is a small space after the `f') with pdf&tex;.</para> + </section> + </node> + <node> + <nodename>\hrulefill</nodename> + <nodenext>\dotfill</nodenext> + <nodeprev>\hfill</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\hrulefill</code></title> + <para><indexterm index="fn">\hrulefill</indexterm> The <code>\hrulefill</code> fill command produces a “rubber length” which can stretch or shrink horizontally. It will be filled with a horizontal rule.</para> + </section> + </node> + <node> + <nodename>\dotfill</nodename> + <nodenext>\addvspace</nodenext> + <nodeprev>\hrulefill</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\dotfill</code></title> + <para><indexterm index="fn">\dotfill</indexterm> The <code>\dotfill</code> command produces a “rubber length” that fills with dots instead of just white space.</para> +<!-- xx undone --> + </section> + </node> + <node> + <nodename>\addvspace</nodename> + <nodenext>\bigskip \medskip \smallskip</nodenext> + <nodeprev>\dotfill</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\addvspace</code></title> + <para><indexterm index="fn">\addvspace</indexterm><indexterm index="cp">vertical space</indexterm><indexterm index="cp">space, inserting vertical</indexterm> <code>\addvspace{length}</code></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 needed to make the natural length of the total vertical space equal to <code>length</code>.</para> + </section> + </node> + <node> + <nodename>\bigskip \medskip \smallskip</nodename> + <nodenext>\vfill</nodenext> + <nodeprev>\addvspace</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\bigskip \medskip \smallskip</code></title> + <para>These commands produce a given amount of space.</para> + <table> + <tableitem> + <tableterm><code>\bigskip</code></tableterm><indexterm index="fn">\bigskip</indexterm><indexterm index="fn">\bigskipamount</indexterm> + <item> + <para>The same as <code>\vspace{bigskipamount}</code>, ordinarily about one line space (with stretch and shrink).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\medskip</code></tableterm><indexterm index="fn">\medskip</indexterm><indexterm index="fn">\medskipamount</indexterm> + <item> + <para>The same as <code>\vspace{medskipamount}</code>, ordinarily about half of a line space (with stretch and shrink).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\smallskip</code></tableterm><indexterm index="fn">\smallskip</indexterm><indexterm index="fn">\smallskipamount</indexterm> + <item> + <para>The same as <code>\vspace{smallskipamount}</code>, ordinarily about a quarter of a line space (with stretch and shrink).</para> + </item> + </tableitem> + </table> + <para>The <code>\...amount</code> parameters are determined by the document class.</para> + </section> + </node> + <node> + <nodename>\vfill</nodename> + <nodenext>\vspace</nodenext> + <nodeprev>\bigskip \medskip \smallskip</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\vfill</code></title> + <para><indexterm index="fn">\vfill</indexterm> 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 <xref><xrefnodename>\hfill</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>\vspace</nodename> + <nodeprev>\vfill</nodeprev> + <nodeup>Spaces</nodeup> + <section> + <title><code>\vspace[*]{<var>length</var>}</code></title> + <para><indexterm index="fn">\vspace</indexterm> Synopsis:</para> + <example xml:space="preserve">\vspace[*]{<var>length</var>}</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> + <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> + </section> + </node> + <node> + <nodename>Boxes</nodename> + <nodenext>Special insertions</nodenext> + <nodeprev>Spaces</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Boxes</title> + <para><indexterm index="cp">boxes</indexterm> All the predefined length parameters (see <xref><xrefnodename>Predefined lengths</xrefnodename></xref>) can be used in the arguments of the box-making commands.</para> + <menu> + <menuentry> + <menunode>\mbox</menunode> + <menutitle>\mbox</menutitle> + <menucomment>Horizontal boxes.</menucomment> + </menuentry> + <menuentry> + <menunode>\fbox and \framebox</menunode> + <menutitle>\fbox and \framebox</menutitle> + <menucomment>Put a frame around a box.</menucomment> + </menuentry> + <menuentry> + <menunode>lrbox</menunode> + <menutitle>lrbox</menutitle> + <menucomment>An environment like \sbox.</menucomment> + </menuentry> + <menuentry> + <menunode>\makebox</menunode> + <menutitle>\makebox</menutitle> + <menucomment>Box, adjustable position.</menucomment> + </menuentry> + <menuentry> + <menunode>\parbox</menunode> + <menutitle>\parbox</menutitle> + <menucomment>Box with text in paragraph mode.</menucomment> + </menuentry> + <menuentry> + <menunode>\raisebox</menunode> + <menutitle>\raisebox</menutitle> + <menucomment>Raise or lower text.</menucomment> + </menuentry> + <menuentry> + <menunode>\savebox</menunode> + <menutitle>\savebox</menutitle> + <menucomment>Like \makebox, but save the text for later use.</menucomment> + </menuentry> + <menuentry> + <menunode>\sbox</menunode> + <menutitle>\sbox</menutitle> + <menucomment>Like \mbox, but save the text for later use.</menucomment> + </menuentry> + <menuentry> + <menunode>\usebox</menunode> + <menutitle>\usebox</menutitle> + <menucomment>Print saved text.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\mbox</nodename> + <nodenext>\fbox and \framebox</nodenext> + <nodeup>Boxes</nodeup> + <section> + <title><code>\mbox{<var>text}</var></code></title> + <para><indexterm index="fn">\mbox</indexterm> <indexterm index="cp">hyphenation, preventing</indexterm>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.</para> + </section> + </node> + <node> + <nodename>\fbox and \framebox</nodename> + <nodenext>lrbox</nodenext> + <nodeprev>\mbox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>\fbox</code> and <code>\framebox</code></title> + <para><indexterm index="fn">\fbox</indexterm><indexterm index="fn">\framebox</indexterm> Synopses:</para> + <example xml:space="preserve">\fbox{<var>text</var>} +\framebox[<var>width</var>][<var>position</var>]{<var>text</var>}</example> + <para>The <code>\fbox</code> and <code>\framebox</code> commands are like <code>\mbox</code>, except that they put a frame around the outside of the box being created.</para> + <para>In addition, the <code>\framebox</code> command allows for explicit specification of the box width with the optional <var>width</var> argument (a dimension), and positioning with the optional <var>position</var> argument. +<!-- xxref --> <indexterm index="fn">\fboxrule</indexterm><indexterm index="fn">\fboxsep</indexterm>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.</para> + <para>See <xref><xrefnodename>\framebox (picture)</xrefnodename></xref>, for the <code>\framebox</code> command in the <code>picture</code> environment.</para> + </section> + </node> + <node> + <nodename>lrbox</nodename> + <nodenext>\makebox</nodenext> + <nodeprev>\fbox and \framebox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>lrbox</code></title> + <para><indexterm index="fn">lrbox</indexterm> <code>\begin{lrbox}{cmd} text \end{lrbox}</code></para> + <para>This is the environment form of <code>\sbox</code>.</para> + <para>The text inside the environment is saved in the box <code>cmd</code>, which must have been declared with <code>\newsavebox</code>.</para> + </section> + </node> + <node> + <nodename>\makebox</nodename> + <nodenext>\parbox</nodenext> + <nodeprev>lrbox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>\makebox</code></title> + <para><indexterm index="fn">\makebox</indexterm> Synopsis:</para> + <example xml:space="preserve">\makebox[<var>width</var>][<var>position</var>]{<var>text</var>}</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 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:</para> + <table> + <tableitem> + <tableterm><code>c</code></tableterm> + <item> + <para>Centered (default).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>l</code></tableterm> + <item> + <para>Flush left.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>r</code></tableterm> + <item> + <para>Flush right.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>s</code></tableterm> + <item> + <para>Stretch (justify) across entire <var>width</var>; <var>text</var> must contain stretchable space for this to work.</para> + </item> + </tableitem> + </table> + <para><code>\makebox</code> is also used within the picture environment see <xref><xrefnodename>\makebox (picture)</xrefnodename></xref>.</para> + </section> + </node> + <node> + <nodename>\parbox</nodename> + <nodenext>\raisebox</nodenext> + <nodeprev>\makebox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>\parbox</code></title> + <para><indexterm index="fn">\parbox</indexterm> Synopsis:</para> + <example xml:space="preserve">\parbox[<var>position</var>][<var>height</var>][<var>inner-pos</var>]{<var>width</var>}{<var>text</var>}</example> + <para>The <code>\parbox</code> command produces a box whose contents are created in <code>paragraph</code> mode. It should be used to make a box small pieces of text, with nothing fancy inside. In particular, you shouldn't use any paragraph-making environments inside a <code>\parbox</code> argument. For larger pieces of text, including ones containing a paragraph-making environment, you should use a <code>minipage</code> environment (see <xref><xrefnodename>minipage</xrefnodename></xref>).</para> + <para><code>\parbox</code> has two mandatory arguments:</para> + <table> + <tableitem> + <tableterm><var>width</var></tableterm> + <item> + <para>the width of the parbox;</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>text</var></tableterm> + <item> + <para>the text that goes inside the parbox.</para> + </item> + </tableitem> + </table> + <para>The optional <var>position</var> argument allows you to align either the top or bottom line in the parbox with the baseline of the surrounding text (default is top).</para> + <para>The optional <var>height</var> argument overrides the natural height of the box.</para> + <para>The <var>inner-pos</var> argument controls the placement of the text inside the box, as follows; if it is not specified, <var>position</var> is used.</para> + <table> + <tableitem> + <tableterm><code>t</code></tableterm> + <item> + <para>text is placed at the top of the box.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>c</code></tableterm> + <item> + <para>text is centered in the box.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>b</code></tableterm> + <item> + <para>text is placed at the bottom of the box.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>s</code></tableterm> + <item> + <para>stretch vertically; the text must contain vertically stretchable space for this to work.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\raisebox</nodename> + <nodenext>\savebox</nodenext> + <nodeprev>\parbox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>\raisebox</code></title> + <para><indexterm index="fn">\raisebox</indexterm> Synopsis:</para> + <example xml:space="preserve">\raisebox{distance}[<var>height</var>][<var>depth</var>]{text}</example> + <para>The <code>\raisebox</code> command raises or lowers <var>text</var>. The first mandatory argument specifies how high <var>text</var> is to be raised (or lowered if it is a negative amount). <var>text</var> itself is processed in LR mode.</para> + <para>The optional arguments <var>height</var> and <var>depth</var> are dimensions. If they are specified, &latex; treats <var>text</var> as extending a certain distance above the baseline (height) or below (depth), ignoring its natural height and depth.</para> + </section> + </node> + <node> + <nodename>\savebox</nodename> + <nodenext>\sbox</nodenext> + <nodeprev>\raisebox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>\savebox</code></title> + <para><indexterm index="fn">\savebox</indexterm> Synopsis:</para> + <example xml:space="preserve">\savebox{<var>\boxcmd</var>}[<var>width</var>][<var>pos</var>]{<var>text</var>}</example> + <para>This command typeset <var>text</var> in a box just as with <code>\makebox</code> (see <xref><xrefnodename>\makebox</xrefnodename></xref>), except that instead of printing the resulting box, it saves it in the box labeled <var>\boxcmd</var>, which must have been declared with <code>\newsavebox</code> (see <xref><xrefnodename>\newsavebox</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>\sbox</nodename> + <nodenext>\usebox</nodenext> + <nodeprev>\savebox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>\sbox{<var>\boxcmd</var>}{<var>text</var>}</code></title> + <para><indexterm index="fn">\sbox</indexterm> Synopsis:</para> + <example xml:space="preserve">\sbox{<var>\boxcmd</var>}{<var>text</var>}</example> + <para><code>\sbox</code> types <var>text</var> in a box just as with <code>\mbox</code> (see <xref><xrefnodename>\mbox</xrefnodename></xref>) except that instead of the resulting box being included in the normal output, it is saved in the box labeled <var>\boxcmd</var>. <var>\boxcmd</var> must have been previously declared with <code>\newsavebox</code> (see <xref><xrefnodename>\newsavebox</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>\usebox</nodename> + <nodeprev>\sbox</nodeprev> + <nodeup>Boxes</nodeup> + <section> + <title><code>\usebox{<var>\boxcmd</var></code></title> + <para><indexterm index="fn">\usebox</indexterm> Synopsis:</para> + <example xml:space="preserve">\usebox{<var>\boxcmd</var>}</example> + <para><code>\usebox</code> producesthe box most recently saved in the bin <var>\boxcmd</var> by a <code>\savebox</code> command (see <xref><xrefnodename>\savebox</xrefnodename></xref>).</para> + </section> + </node> + <node> + <nodename>Special insertions</nodename> + <nodenext>Splitting the input</nodenext> + <nodeprev>Boxes</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Special insertions</title> + <para>&latex; provides commands for inserting characters that have a special meaning do not correspond to simple characters you can type.</para> + <menu> + <menuentry> + <menunode>Reserved characters</menunode> + <menutitle>Reserved characters</menutitle> + <menucomment>Inserting # $ % & ~ _ ^ \ { }</menucomment> + </menuentry> + <menuentry> + <menunode>Text symbols</menunode> + <menutitle>Text symbols</menutitle> + <menucomment>Inserting other non-letter symbols in text.</menucomment> + </menuentry> + <menuentry> + <menunode>Accents</menunode> + <menutitle>Accents</menutitle> + <menucomment>Inserting accents.</menucomment> + </menuentry> + <menuentry> + <menunode>Non-English characters</menunode> + <menutitle>Non-English characters</menutitle> + <menucomment>Inserting other non-English characters.</menucomment> + </menuentry> + <menuentry> + <menunode>\rule</menunode> + <menutitle>\rule</menutitle> + <menucomment>Inserting lines and rectangles.</menucomment> + </menuentry> + <menuentry> + <menunode>\today</menunode> + <menutitle>\today</menutitle> + <menucomment>Inserting today's date.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>Reserved characters</nodename> + <nodenext>Text symbols</nodenext> + <nodeup>Special insertions</nodeup> + <section> + <title>Reserved characters</title> + <para><indexterm index="cp">reserved characters</indexterm><indexterm index="cp">characters, reserved</indexterm> The following characters play a special role in &latex; and are called “reserved characters” or “special characters”.</para> + <example xml:space="preserve"># $ % & ~ _ ^ \ { }</example> + <para><indexterm index="fn">\#</indexterm><indexterm index="fn">\$</indexterm><indexterm index="fn">\%</indexterm><indexterm index="fn">\&</indexterm><indexterm index="fn">\_</indexterm><indexterm index="fn">\{</indexterm><indexterm index="fn">\}</indexterm>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> + <para><indexterm index="fn">\backslash</indexterm>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 (see <xref><xrefnodename>verbatim</xrefnodename></xref>).</para> + <para><indexterm index="fn">\~</indexterm><indexterm index="fn">\^</indexterm>Also, <code>\~</code> and <code>\^</code> place tilde and circumflex accents over the following letter, as in õ and ô (see <xref><xrefnodename>Accents</xrefnodename></xref>); to get a standalone <code>~</code> or <code>^</code>, you can again use a verbatim command.</para> + <para><indexterm index="fn">\symbol</indexterm><indexterm index="cp">accessing any character of a font</indexterm> 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 visible space character used in the <code>\verb*</code> command has the code decimal 32, so it can be typed as <code>\symbol{32}</code>.</para> + <para>You can also specify octal numbers with <code>'</code> or hexadecimal numbers with <code>"</code>, so the previous example could also be written as <code>\symbol{'40}</code> or <code>\symbol{"20}</code>.</para> + </section> + </node> + <node> + <nodename>Text symbols</nodename> + <nodenext>Accents</nodenext> + <nodeprev>Reserved characters</nodeprev> + <nodeup>Special insertions</nodeup> + <section> + <title>Text symbols</title> + <para><indexterm index="cp">text symbols</indexterm>&latex; provides commands to generate a number of non-letter symbols in running text.</para> + <table> + <tableitem> + <tableterm><indexterm index="fn">\copyright</indexterm><code>\copyright</code></tableterm><indexterm index="cp">copyright symbol</indexterm> + <item> + <para>The copyright symbol, ©right;.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\dag</indexterm><code>\dag</code></tableterm><indexterm index="cp">dagger, in text</indexterm> + <item> + <para>The dagger symbol (in text).</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ddag</indexterm><code>\ddag</code></tableterm><indexterm index="cp">double dagger, in text</indexterm> + <item> + <para>The double dagger symbol (in text).</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\LaTeX</indexterm><code>\LaTeX</code></tableterm><indexterm index="cp">&latex; logo</indexterm><indexterm index="cp">logo, &latex;</indexterm> + <item> + <para>The &latex; logo.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\ldots</indexterm><code>\ldots</code></tableterm><indexterm index="cp">ellipsis</indexterm> + <item> + <para>An ellipsis (three dots at the baseline): `&dots;'. This command also works in math mode.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\lq</indexterm><code>\lq</code></tableterm><indexterm index="cp">left quote</indexterm><indexterm index="cp">opening quote</indexterm> + <item> + <para>Left (opening) quote: `.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\P</indexterm><code>\P</code></tableterm><indexterm index="cp">paragraph sign</indexterm><indexterm index="cp">pilcrow</indexterm> + <item> + <para>Paragraph sign (pilcrow).</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\pounds</indexterm><code>\pounds</code></tableterm><indexterm index="cp">pounds symbol</indexterm><indexterm index="cp">sterling symbol</indexterm> + <item> + <para>English pounds sterling.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\rq</indexterm><code>\rq</code></tableterm><indexterm index="cp">right quote</indexterm><indexterm index="cp">closing quote</indexterm> + <item> + <para>Right (closing) quote: '.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\S</indexterm><code>\S</code></tableterm><indexterm index="cp">section symbol</indexterm> + <item> + <para>Section symbol.</para> + </item> + </tableitem> + <tableitem> + <tableterm><indexterm index="fn">\TeX</indexterm><code>\TeX</code></tableterm><indexterm index="cp">&tex; logo</indexterm><indexterm index="cp">logo, &tex;</indexterm> + <item> + <para>The &tex; logo.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Accents</nodename> + <nodenext>Non-English characters</nodenext> + <nodeprev>Text symbols</nodeprev> + <nodeup>Special insertions</nodeup> + <section> + <title>Accents</title> + <para><indexterm index="cp">accents</indexterm><indexterm index="cp">characters, accented</indexterm><indexterm index="cp">letters, accented</indexterm> &latex; has wide support for many of the world'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 the core &latex; commands for creating accented characters.</para> + <table> + <tableitem> + <tableterm><code>\"</code></tableterm><indexterm index="fn">\" <r>(umlaut accent)</r></indexterm><indexterm index="cp">umlaut accent</indexterm> + <item> + <para>Produces an umlaut, as in ö.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\'</code></tableterm><indexterm index="fn">\' <r>(acute accent)</r></indexterm><indexterm index="cp">acute accent</indexterm> + <item> + <para>Produces an acute accent, as in ó. In the <code>tabbing</code> environment, pushes current column to the right of the previous column (see <xref><xrefnodename>tabbing</xrefnodename></xref>).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\.</code></tableterm><indexterm index="fn">\. <r>(dot-over accent)</r></indexterm><indexterm index="cp">dot accent</indexterm><indexterm index="cp">dot-over accent</indexterm> + <item> + <para>Produces a dot accent over the following, as in o..</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\=</code></tableterm><indexterm index="fn">\= <r>(macron accent)</r></indexterm><indexterm index="cp">macron accent</indexterm><indexterm index="cp">overbar accent</indexterm><indexterm index="cp">bar-over accent</indexterm> + <item> + <para>Produces a macron (overbar) accent over the following, as in o¯.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\^</code></tableterm><indexterm index="fn">\^ <r>(circumflex accent)</r></indexterm><indexterm index="cp">circumflex accent</indexterm><indexterm index="cp">hat accent</indexterm> + <item> + <para>Produces a circumflex (hat) accent over the following, as in ô.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\`</code></tableterm><indexterm index="fn">\` <r>(grave accent)</r></indexterm><indexterm index="cp">grave accent</indexterm> + <item> + <para>Produces a grave accent over the following, as in ò. In the <code>tabbing</code> environment, move following text to the right margin (see <xref><xrefnodename>tabbing</xrefnodename></xref>).</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\~</code></tableterm><indexterm index="fn">\~ <r>(tilde accent)</r></indexterm><indexterm index="cp">tilde accent</indexterm> + <item> + <para>Produces a tilde accent over the following, as in ñ.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\b</code></tableterm><indexterm index="fn">\b <r>(bar-under accent)</r></indexterm><indexterm index="cp">bar-under accent</indexterm> + <item> + <para>Produces a bar accent under the following, as in o_.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\bar</code></tableterm><indexterm index="fn">\bar <r>(macron, bar-over accent)</r></indexterm><indexterm index="cp">bar-over accent</indexterm><indexterm index="cp">macron accent</indexterm> + <item> + <para>Produces a macron accent over the following, as in o¯.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\c</code></tableterm><indexterm index="fn">\c <r>(cedilla accent)</r></indexterm><indexterm index="cp">cedilla accent</indexterm> + <item> + <para>Produces a cedilla accent under the following, as in +<!-- {c}. --></para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\d</code></tableterm><indexterm index="fn">\d <r>(dot-under accent)</r></indexterm><indexterm index="cp">dot-under accent</indexterm> + <item> + <para>Produces a dot accent under the following, as in .o.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\H</code></tableterm><indexterm index="fn">\H <r>(Hungarian umlaut accent)</r></indexterm><indexterm index="cp">hungarian umlaut accent</indexterm> + <item> + <para>Produces a long Hungarian umlaut accent over the following, as in o''.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\i</code></tableterm><indexterm index="fn">\i <r>(dotless i)</r></indexterm><indexterm index="cp">dotless i</indexterm> + <item> + <para>Produces a dotless i, as in `i'.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\j</code></tableterm><indexterm index="fn">\j <r>(dotless j)</r></indexterm><indexterm index="cp">dotless j</indexterm> + <item> + <para>Produces a dotless j, as in `j'.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\t</code></tableterm><indexterm index="fn">\t <r>(tie-after accent)</r></indexterm><indexterm index="cp">tie-after accent</indexterm> + <item> + <para>Produces a tie-after accent, as in `oo['.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\u</code></tableterm><indexterm index="fn">\u <r>(breve accent)</r></indexterm><indexterm index="cp">breve accent</indexterm> + <item> + <para>Produces a breve accent, as in `o('.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\v</code></tableterm><indexterm index="fn">\v <r>(breve accent)</r></indexterm><indexterm index="cp">hacek accent</indexterm><indexterm index="cp">check accent</indexterm> + <item> + <para>Produces a hác<ek (check) accent, as in `o<'.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>Non-English characters</nodename> + <nodenext>\rule</nodenext> + <nodeprev>Accents</nodeprev> + <nodeup>Special insertions</nodeup> + <section> + <title>Non-English characters</title> + <para><indexterm index="cp">special characters</indexterm><indexterm index="cp">non-English characters</indexterm><indexterm index="cp">characters, non-English</indexterm><indexterm index="cp">letters, non-English</indexterm> Here are the basic &latex; commands for inserting characters commonly used in languages other than English.</para> + <table> + <tableitem> + <tableterm><code>\aa</code></tableterm> + <tableterm><code>\AA</code></tableterm><indexterm index="fn">\aa (å)</indexterm><indexterm index="fn">\AA (Å)</indexterm><indexterm index="cp">aring</indexterm> + <item> + <para>å and Å.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\ae</code></tableterm> + <tableterm><code>\AE</code></tableterm><indexterm index="fn">\ae (æ)</indexterm><indexterm index="fn">\AE (Æ)</indexterm><indexterm index="cp">ae ligature</indexterm> + <item> + <para>æ and Æ.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\l</code></tableterm> + <tableterm><code>\L</code></tableterm><indexterm index="fn">\l (/l)</indexterm><indexterm index="fn">\L (/L)</indexterm><indexterm index="cp">polish l</indexterm> + <item> + <para>/l and /L.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\o</code></tableterm> + <tableterm><code>\O</code></tableterm><indexterm index="fn">\o (ø)</indexterm><indexterm index="fn">\O (Ø)</indexterm><indexterm index="cp">oslash</indexterm> + <item> + <para>ø and Ø.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\oe</code></tableterm> + <tableterm><code>\OE</code></tableterm><indexterm index="fn">\oe (œ)</indexterm><indexterm index="fn">\OE (Œ)</indexterm><indexterm index="cp">oe ligature</indexterm> + <item> + <para>œ and Œ.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>\ss</code></tableterm><indexterm index="fn">\ss (ß)</indexterm><indexterm index="cp">es-zet German letter</indexterm><indexterm index="cp">sharp S letters</indexterm> + <item> + <para>ß.</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\rule</nodename> + <nodenext>\today</nodenext> + <nodeprev>Non-English characters</nodeprev> + <nodeup>Special insertions</nodeup> + <section> + <title><code>\rule</code></title> + <para><indexterm index="fn">\rule</indexterm> Synopsis:</para> + <example xml:space="preserve">\rule[<var>raise</var>]{<var>width</var>}{<var>thickness</var>}</example> + <para>The <code>\rule</code> command produces <dfn>rules</dfn>, that is, lines or rectangles. The arguments are:</para> + <table> + <tableitem> + <tableterm><var>raise</var></tableterm> + <item> + <para>How high to raise the rule (optional).</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>width</var></tableterm> + <item> + <para>The length of the rule (mandatory).</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>thickness</var></tableterm> + <item> + <para>The thickness of the rule (mandatory).</para> + </item> + </tableitem> + </table> + </section> + </node> + <node> + <nodename>\today</nodename> + <nodeprev>\rule</nodeprev> + <nodeup>Special insertions</nodeup> + <section> + <title><code>\today</code></title> + <para><indexterm index="fn">\today</indexterm> 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'. It uses the predefined counters <code>\day</code>, <code>\month</code>, and <code>\year</code> (see <xref><xrefnodename>\day \month \year</xrefnodename></xref>) to do this. It is not updated as the program runs.</para> + <para><indexterm index="cp"><code>datetime</code> package</indexterm>The <code>datetime</code> package, among others, can produce a wide variety of other date formats.</para> + </section> + </node> + <node> + <nodename>Splitting the input</nodename> + <nodenext>Front/back matter</nodenext> + <nodeprev>Special insertions</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Splitting the input</title> + <para><indexterm index="cp">splitting the input file</indexterm><indexterm index="cp">input file</indexterm> A large document requires a lot of input. Rather than putting the whole input in a single large file, it's more efficient to split it into several smaller ones. Regardless of how many separate files you use, there is one that is the root file; it is the one whose name you type when you run &latex;.</para> + <menu> + <menuentry> + <menunode>\include</menunode> + <menutitle>\include</menutitle> + <menucomment>Conditionally include a file.</menucomment> + </menuentry> + <menuentry> + <menunode>\includeonly</menunode> + <menutitle>\includeonly</menutitle> + <menucomment>Determine which files are included.</menucomment> + </menuentry> + <menuentry> + <menunode>\input</menunode> + <menutitle>\input</menutitle> + <menucomment>Unconditionally include a file.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\include</nodename> + <nodenext>\includeonly</nodenext> + <nodeup>Splitting the input</nodeup> + <section> + <title><code>\include</code></title> + <para><indexterm index="fn">\include</indexterm> Synopsis:</para> + <example xml:space="preserve">\include{<var>file</var>}</example> + <para>If no <code>\includeonly</code> command is present, the <code>\include</code> command executes <code>\clearpage</code> to start a new page (see <xref><xrefnodename>\clearpage</xrefnodename></xref>), then reads <var>file</var>, then does another <code>\clearpage</code>.</para> + <para>Given an <code>\includeonly</code> command, the <code>\include</code> actions are only run if <var>file</var> is listed as an argument to <code>\includeonly</code>. See the next section.</para> + <para><indexterm index="cp">nested <code>\include</code>, not allowed</indexterm>The <code>\include</code> command may not appear in the preamble or in a file read by another <code>\include</code> command.</para> + </section> + </node> + <node> + <nodename>\includeonly</nodename> + <nodenext>\input</nodenext> + <nodeprev>\include</nodeprev> + <nodeup>Splitting the input</nodeup> + <section> + <title>\<code>includeonly</code></title> + <para><indexterm index="fn">\includeonly</indexterm> Synopsis:</para> + <example xml:space="preserve">\includeonly{<var>file1</var>,<var>file2</var>,...}</example> + <para>The <code>\includeonly</code> command controls which files will be read by subsequent <code>\include</code> commands. The list of filenames is comma-separated. Each <var>file</var> must exactly match a filename specified in a <code>\include</code> command for the selection to be effective.</para> + <para>This command can only appear in the preamble.</para> + </section> + </node> + <node> + <nodename>\input</nodename> + <nodeprev>\includeonly</nodeprev> + <nodeup>Splitting the input</nodeup> + <section> + <title>\input</title> + <para><indexterm index="fn">\input</indexterm> Synopsis:</para> + <example xml:space="preserve">\input{<var>file</var>}</example> + <para>The <code>\input</code> command causes the specified <var>file</var> to be read and processed, as if its contents had been inserted in the current file at that point.</para> + <para>If <var>file</var> does not end in <samp>.tex</samp> (e.g., <samp>foo</samp> or <samp>foo.bar</samp>), it is first tried with that extension (<samp>foo.tex</samp> 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> + </node> + <node> + <nodename>Front/back matter</nodename> + <nodenext>Letters</nodenext> + <nodeprev>Splitting the input</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Front/back matter</title> + <menu> + <menuentry> + <menunode>Tables of contents</menunode> + <menutitle>Tables of contents</menutitle> + <menucomment></menucomment> + </menuentry> + <menuentry> + <menunode>Glossaries</menunode> + <menutitle>Glossaries</menutitle> + <menucomment></menucomment> + </menuentry> + <menuentry> + <menunode>Indexes</menunode> + <menutitle>Indexes</menutitle> + <menucomment></menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>Tables of contents</nodename> + <nodenext>Glossaries</nodenext> + <nodeup>Front/back matter</nodeup> + <section> + <title>Tables of contents</title> + <para><indexterm index="cp">table of contents, creating</indexterm> <indexterm index="fn">\tableofcontents</indexterm>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 have generated a <file>.toc</file> file.</para> + <para>The <code>\tableofcontents</code> command produces a heading, but it does 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> + <para><indexterm index="fn">\listoffigures</indexterm><indexterm index="fn">\listoftables</indexterm>The analagous commands <code>\listoffigures</code> and <code>\listoftables</code> produce a list of figures and a list of tables, respectively. Everything works exactly the same as for the table of contents.</para> + <para><indexterm index="fn">\nofiles</indexterm>The command <code>\nofiles</code> overrides these commands, and <emph>prevents</emph> any of these lists from being generated.</para> + <menu> + <menuentry> + <menunode>\addcontentsline</menunode> + <menutitle>\addcontentsline</menutitle> + <menucomment>Add an entry to table of contents etc.</menucomment> + </menuentry> + <menuentry> + <menunode>\addtocontents</menunode> + <menutitle>\addtocontents</menutitle> + <menucomment>Add text directly to table of contents file etc.</menucomment> + </menuentry> + </menu> + </section> + </node> + <node> + <nodename>\addcontentsline</nodename> + <nodenext>\addtocontents</nodenext> + <nodeup>Tables of contents</nodeup> + <subsection> + <title>\addcontentsline</title> + <para><indexterm index="fn">\addcontentsline{<var>ext</var>}{<var>unit</var>}{<var>text</var>}</indexterm><indexterm index="cp">table of contents entry, manually adding</indexterm> The <code>\addcontentsline</code> command adds an entry to the specified list or table where:</para> + <table> + <tableitem> + <tableterm><var>ext</var></tableterm> + <item> + <para>The extension of the file on which information is to be written, typically one of: <code>toc</code> (table of contents), <code>lof</code> (list of figures), or <code>lot</code> (list of tables).</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>unit</var></tableterm> + <item> + <para>The name of the sectional unit being added, typically one of the following, matching the value of the <var>ext</var> argument:</para> + <table> + <tableitem> + <tableterm><code>toc</code></tableterm> + <item> + <para>The name of the sectional unit: <code>part</code>, <code>chapter</code>, <code>section</code>, <code>subsection</code>, <code>subsubsection</code>.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>lof</code></tableterm> + <item> + <para>For the list of figures.</para> + </item> + </tableitem> + <tableitem> + <tableterm><code>lot</code></tableterm> + <item> + <para>For the list of tables.</para> + </item> + </tableitem> + </table> + </item> + </tableitem> + <tableitem> + <tableterm><var>entry</var></tableterm> + <item> + <para>The actual text of the entry.</para> + </item> + </tableitem> + </table> + <para><indexterm index="fn">\contentsline</indexterm>What is written to the <file>.<var>ext</var></file> file is the command <code>\contentsline{<var>unit</var>}{<var>name</var>}</code>.</para> +<!-- ?? how hardwired are these values? other unit names? --> + </subsection> + </node> + <node> + <nodename>\addtocontents</nodename> + <nodeprev>\addcontentsline</nodeprev> + <nodeup>Tables of contents</nodeup> + <subsection> + <title>\addtocontents</title> + <para><indexterm index="fn">\addtocontents{<var>ext</var>}{<var>text</var>}</indexterm> The <code>\addtocontents</code> command adds text (or formatting commands) directly to the <file>.</file><var>ext</var> file that generates the table of contents or lists of figures or tables.</para> + <table> + <tableitem> + <tableterm><var>ext</var></tableterm> + <item> + <para>The extension of the file on which information is to be written: <file>toc</file> (table of contents), <file>lof</file> (list of figures), or <file>lot</file> (list of tables).</para> + </item> + </tableitem> + <tableitem> + <tableterm><var>text</var></tableterm> + <item> + <para>The text to be written.</para> + </item> + </tableitem> + </table> + </subsection> + </node> + <node> + <nodename>Glossaries</nodename> + <nodenext>Indexes</nodenext> + <nodeprev>Tables of contents</nodeprev> + <nodeup>Front/back matter</nodeup> + <section> + <title>Glossaries</title> + <para><indexterm index="cp">glossaries</indexterm> <indexterm index="fn">\makeglossary</indexterm>The command <code>\makeglossary</code> enables creating glossaries.</para> + <para><indexterm index="fn">\glossary</indexterm><indexterm index="cp"><file>.glo</file> file</indexterm>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> + <para><indexterm index="fn">\glossaryentry</indexterm>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> + <para>The <code>glossary</code> package on CTAN provides support for fancier glossaries.</para> + </section> + </node> + <node> + <nodename>Indexes</nodename> + <nodeprev>Glossaries</nodeprev> + <nodeup>Front/back matter</nodeup> + <section> + <title>Indexes</title> + <para><indexterm index="cp">indexes</indexterm> <indexterm index="fn">\makeindex</indexterm>The command <code>\makeindex</code> enables creating indexes.</para> + <para><indexterm index="fn">\index</indexterm><indexterm index="cp"><file>.idx</file> file</indexterm>The command <code>\index{<var>text</var>}</code> writes a glossary entry for <var>text</var> to an auxiliary file with the <file>.idx</file> extension.</para> + <para><indexterm index="fn">\indexentry</indexterm>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> + <para>The rubber length <code>\indexspace</code> is inserted before each new letter in the index; its default value is <samp>10pt plus5pt minus3pt</samp>.</para> + <para><indexterm index="cp"><command>makeindex</command> program</indexterm><indexterm index="cp"><command>xindy</command> program</indexterm><indexterm index="cp"><file>.ind</file> file</indexterm> The <file>.idx</file> file can then be sorted with an external command, typically <command>makeindex</command> or <command>xindy</command>, resulting in a <file>.ind</file> file, which can then be used to typeset the index.</para> + </section> + </node> + <node> + <nodename>Letters</nodename> + <nodenext>Terminal Input/Output</nodenext> + <nodeprev>Front/back matter</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Letters</title> + <para><indexterm index="cp">letters</indexterm><indexterm index="cp">creating letters</indexterm> 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:</para> + <example xml:space="preserve"> \documentclass{letter} + \begin{document} + ... letters ... + \end{document}</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> + <example xml:space="preserve"> \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. + \\ Edinburgh, EH1 1AA} + ... + \end{letter}</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> + <para><indexterm index="fn">\\ <r>for letters</r></indexterm>After the <code>closing</code>, you can have additional material. The <code>\cc</code> command produces the usual “cc: &dots;”. 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.</para> + <para>These commands are used with the <code>letter</code> class.</para> + <menu> + <menuentry> + <menunode>\address</menunode> + <menutitle>\address</menutitle> + <menucomment>Your return address.</menucomment> + </menuentry> + <menuentry> + <menunode>\cc</menunode> + <menutitle>\cc</menutitle> + <menucomment>Cc list.</menucomment> + </menuentry> + <menuentry> + <menunode>\closing</menunode> + <menutitle>\closing</menutitle> + <menucomment>Saying goodbye.</menucomment> + </menuentry> + <menuentry> + <menunode>\encl</menunode> + <menutitle>\encl</menutitle> + <menucomment>List of enclosed material.</menucomment> + </menuentry> + <menuentry> + <menunode>\location</menunode> + <menutitle>\location</menutitle> + <menucomment>Your organisation's address.</menucomment> + </menuentry> + <menuentry> + <menunode>\makelabels</menunode> + <menutitle>\makelabels</menutitle> + <menucomment>Making address labels.</menucomment> + </menuentry> + <menuentry> + <menunode>\name</menunode> + <menutitle>\name</menutitle> + <menucomment>Your name, for the return address.</menucomment> + </menuentry> + <menuentry> + <menunode>\opening</menunode> + <menutitle>\opening</menutitle> + <menucomment>Saying hello.</menucomment> + </menuentry> + <menuentry> + <menunode>\ps</menunode> + <menutitle>\ps</menutitle> + <menucomment>Adding a postscript.</menucomment> + </menuentry> + <menuentry> + <menunode>\signature</menunode> + <menutitle>\signature</menutitle> + <menucomment>Your signature.</menucomment> + </menuentry> + <menuentry> + <menunode>\startbreaks</menunode> + <menutitle>\startbreaks</menutitle> + <menucomment>Allow page breaks.</menucomment> + </menuentry> + <menuentry> + <menunode>\stopbreaks</menunode> + <menutitle>\stopbreaks</menutitle> + <menucomment>Disallow page breaks.</menucomment> + </menuentry> + <menuentry> + <menunode>\telephone</menunode> + <menutitle>\telephone</menutitle> + <menucomment>Your phone number.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\address</nodename> + <nodenext>\cc</nodenext> + <nodeup>Letters</nodeup> + <section> + <title>\address{<var>return-address}</var></title> + <para><indexterm index="fn">\address</indexterm> 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> + <para>If you do not make an <code>\address</code> declaration, then the letter will be formatted for copying onto your organisation's standard letterhead. (See <xref><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> + </section> + </node> + <node> + <nodename>\cc</nodename> + <nodenext>\closing</nodenext> + <nodeprev>\address</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\cc</code></title> + <para><indexterm index="fn">\cc</indexterm><indexterm index="cp">cc list, in letters</indexterm> Synopsis:</para> + <example xml:space="preserve">\cc{<var>name1</var>\\<var>name2</var>}</example> + <para>Produce a list of <var>name</var>s the letter was copied to. Each name is printed on a separate line.</para> + </section> + </node> + <node> + <nodename>\closing</nodename> + <nodenext>\encl</nodenext> + <nodeprev>\cc</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\closing</code></title> + <para><indexterm index="fn">\closing</indexterm><indexterm index="cp">letters, ending</indexterm><indexterm index="cp">closing letters</indexterm> Synopsis:</para> + <example xml:space="preserve">\closing{text}</example> + <para>A letter closes with a <code>\closing</code> command, for example,</para> + <example xml:space="preserve">\closing{Best Regards,}</example> + </section> + </node> + <node> + <nodename>\encl</nodename> + <nodenext>\location</nodenext> + <nodeprev>\closing</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\encl</code></title> + <para><indexterm index="fn">\encl</indexterm><indexterm index="cp">enclosure list</indexterm> Synopsis:</para> + <example xml:space="preserve">\encl{<var>line1</var>\\<var>line2</var>}</example> + <para>Declare a list of one more enclosures.</para> + </section> + </node> + <node> + <nodename>\location</nodename> + <nodenext>\makelabels</nodenext> + <nodeprev>\encl</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\location</code></title> + <para><indexterm index="fn">\location</indexterm> <code>\location{address}</code></para> + <para>This modifies your organisation's standard address. This only appears if the <code>firstpage</code> pagestyle is selected.</para> + </section> + </node> + <node> + <nodename>\makelabels</nodename> + <nodenext>\name</nodenext> + <nodeprev>\location</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\makelabels</code></title> + <para><indexterm index="fn">\makelabels</indexterm> <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> + </section> + </node> + <node> + <nodename>\name</nodename> + <nodenext>\opening</nodenext> + <nodeprev>\makelabels</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\name</code></title> + <para><indexterm index="fn">\name</indexterm> <code>\name{June Davenport}</code></para> + <para>Your name, used for printing on the envelope together with the return address.</para> + </section> + </node> + <node> + <nodename>\opening</nodename> + <nodenext>\ps</nodenext> + <nodeprev>\name</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\opening{<var>text</var>}</code></title> + <para><indexterm index="fn">\opening</indexterm><indexterm index="cp">letters, starting</indexterm> Synopsis:</para> + <example xml:space="preserve">\opening{<var>text</var>}</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> + <example xml:space="preserve">\opening{Dear Joe,}</example> + </section> + </node> + <node> + <nodename>\ps</nodename> + <nodenext>\signature</nodenext> + <nodeprev>\opening</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\ps</code></title> + <para><indexterm index="fn">\ps</indexterm><indexterm index="cp">postscript, in letters</indexterm> Use the <code>\ps</code> command to start a postscript in a letter, after <code>\closing</code>.</para> + </section> + </node> + <node> + <nodename>\signature</nodename> + <nodenext>\startbreaks</nodenext> + <nodeprev>\ps</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\signature{<var>text</var>}</code></title> + <para><indexterm index="fn">\signature</indexterm> 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> + </section> + </node> + <node> + <nodename>\startbreaks</nodename> + <nodenext>\stopbreaks</nodenext> + <nodeprev>\signature</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\startbreaks</code></title> + <para><indexterm index="fn">\startbreaks</indexterm> <code>\startbreaks</code></para> + <para>Used after a <code>\stopbreaks</code> command to allow page breaks again.</para> + </section> + </node> + <node> + <nodename>\stopbreaks</nodename> + <nodenext>\telephone</nodenext> + <nodeprev>\startbreaks</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\stopbreaks</code></title> + <para><indexterm index="fn">\stopbreaks</indexterm> <code>\stopbreaks</code></para> + <para>Inhibit page breaks until a <code>\startbreaks</code> command occurs.</para> + </section> + </node> + <node> + <nodename>\telephone</nodename> + <nodeprev>\stopbreaks</nodeprev> + <nodeup>Letters</nodeup> + <section> + <title><code>\telephone</code></title> + <para><indexterm index="fn">\telephone</indexterm> <code>\telephone{number}</code></para> + <para>This is your telephone number. This only appears if the <code>firstpage</code> pagestyle is selected.</para> + </section> + </node> + <node> + <nodename>Terminal Input/Output</nodename> + <nodenext>Command Line</nodenext> + <nodeprev>Letters</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Terminal Input/Output</title> + <para><indexterm index="cp">input/Output</indexterm><indexterm index="cp">terminal Input/Output</indexterm></para> + <menu> + <menuentry> + <menunode>\typein</menunode> + <menutitle>\typein</menutitle> + <menucomment>Read text from the terminal.</menucomment> + </menuentry> + <menuentry> + <menunode>\typeout</menunode> + <menutitle>\typeout</menutitle> + <menucomment>Write text to the terminal.</menucomment> + </menuentry> + </menu> + </chapter> + </node> + <node> + <nodename>\typein</nodename> + <nodenext>\typeout</nodenext> + <nodeup>Terminal Input/Output</nodeup> + <section> + <title><code>\typein[<var>cmd</var>]{<var>msg</var>}</code></title> + <para><indexterm index="fn">\typein</indexterm> Synopsis:</para> + <example xml:space="preserve">\typein[<var>\cmd</var>]{<var>msg</var>}</example> + <para><code>\typein</code> prints <var>msg</var> on the terminal and causes &latex; to stop and wait for you to type a line of input, ending with return. If the optional <var>\cmd</var> argument is omitted, the typed input is processed as if it had been included in the input file in place of the <code>\typein</code> command. If the <var>\cmd</var> argument is present, it must be a command name. This command name is then defined or redefined to be the typed input.</para> + </section> + </node> + <node> + <nodename>\typeout</nodename> + <nodeprev>\typein</nodeprev> + <nodeup>Terminal Input/Output</nodeup> + <section> + <title><code>\typeout{<var>msg</var>}</code></title> + <para><indexterm index="fn">\typeout</indexterm> Synopsis:</para> + <example xml:space="preserve">\typeout{<var>msg</var>}</example> + <para>Prints <code>msg</code> on the terminal and in the <code>log</code> file. Commands in <code>msg</code> that are defined with <code>\newcommand</code> or <code>\renewcommand</code> (among others) are replaced by their definitions before being printed.</para> + <para>&latex;'s usual rules for treating multiple spaces as a single space and ignoring spaces after a command name apply to <code>msg</code>. A <code>\space</code> command in <code>msg</code> causes a single space to be printed, independent of surrounding spaces. A <code>^^J</code> in <code>msg</code> prints a newline.</para> + </section> + </node> + <node> + <nodename>Command Line</nodename> + <nodenext>Document templates</nodenext> + <nodeprev>Terminal Input/Output</nodeprev> + <nodeup>Top</nodeup> + <chapter> + <title>Command Line</title> + <para><indexterm index="cp">command Line</indexterm> 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 specify command options by supplying a string as a parameter to the command; e.g.</para> + <example xml:space="preserve">latex '\nonstopmode\input foo.tex'</example> + <para role="continues">will process <file>foo.tex</file> without pausing after every error.</para> + <para><indexterm index="cp"><samp>*</samp> prompt</indexterm><indexterm index="cp">prompt, <samp>*</samp></indexterm><indexterm index="fn">\stop</indexterm>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.</para> + </chapter> + </node> + <node> + <nodename>Document templates</nodename> + <nodenext>Command Index</nodenext> + <nodeprev>Command Line</nodeprev> + <nodeup>Top</nodeup> + <appendix> + <title>Document templates</title> + <para><indexterm index="cp">document templates</indexterm> Although not reference material, perhaps these document templates will be useful.</para> + <menu> + <menuentry> + <menunode>book template</menunode> + <menutitle>book template</menutitle> + <menucomment></menucomment> + </menuentry> + <menuentry> + <menunode>beamer template</menunode> + <menutitle>beamer template</menutitle> + <menucomment></menucomment> + </menuentry> + <menuentry> + <menunode>tugboat template</menunode> + <menutitle>tugboat template</menutitle> + <menucomment></menucomment> + </menuentry> + </menu> + </appendix> + </node> + <node> + <nodename>book template</nodename> + <nodenext>beamer template</nodenext> + <nodeup>Document templates</nodeup> + <section> + <title><code>book</code> template</title> + <verbatim xml:space="preserve">\documentclass{book} +\title{Book Class Template} +\author{Alex Author} + +\begin{document} +\maketitle + +\chapter{First} +Some text. + +\chapter{Second} +Some other text. + +\section{A subtopic} +The end. +\end{document}</verbatim> + </section> + </node> + <node> + <nodename>beamer template</nodename> + <nodenext>tugboat template</nodenext> + <nodeprev>book template</nodeprev> + <nodeup>Document templates</nodeup> + <section> + <title><code>beamer</code> template</title> + <para>The <code>beamer</code> class creates slides presentations.</para> + <verbatim xml:space="preserve">\documentclass{beamer} + +\title{Beamer Class template} +\author{Alex Author} +\date{July 31, 2007} + +\begin{document} + +\maketitle + +% without [fragile], any {verbatim} code gets mysterious errors. +\begin{frame}[fragile] + \frametitle{First Slide} + +\begin{verbatim} + This is \verbatim! +\end{verbatim} + +\end{frame} + +\end{document} +</verbatim> + </section> + </node> + <node> + <nodename>tugboat template</nodename> + <nodeprev>beamer template</nodeprev> + <nodeup>Document templates</nodeup> + <section> + <title><code>tugboat</code> template</title> + <para><cite>TUGboat</cite> is the journal of the &tex; Users Group, <uref><urefurl>http://tug.org/TUGboat</urefurl></uref>.</para> + <verbatim xml:space="preserve">\documentclass{ltugboat} % ltugproc for proceedings + +\usepackage{graphicx} +\usepackage{ifpdf} +\ifpdf + \usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, + urlcolor=black]{hyperref} +\else + \usepackage{url} +\fi + +\begin{document} + +\title{Example \TUB\ Regular Article} + +% repeat info for each author. +\author{First Last} +\address{Street Address \\ Town, Postal \\ Country} +\netaddress{user (at) example dot org} +\personalURL{http://example.org/~user/} + +\maketitle + +% The abstract comes after \maketitle in ltugboat. +\begin{abstract} +This is an example article for a regular \TUB{} issue. +\end{abstract} + +\section{Introduction} + +This is an example article for \TUB, from +\url{http://tug.org/TUGboat/location.html}. + +We recommend the graphicx package for image inclusions, and the hyperref +package for active url's (in the \acro{PDF} output). \TUB\ is produced +using \acro{PDF} files exclusively, nowadays. + +The \texttt{ltug*} classes provide these abbreviations, among many others: + +{\small +\begin{verbatim} +\AllTeX \AMS \AmS \AmSLaTeX \AmSTeX \aw \AW +\BibTeX \CandT \CTAN \DTD \DVItoVDU \HTML +\ISBN \ISSN \JTeX \JoT \LAMSTeX \LaTeXe +\Mc \mf \MFB \mtex \pcMF \PCTeX \pcTeX \Pas +\PiC \PiCTeX \plain \POBox \PS +\SC \SGML \SliTeX \TANGLE \TB \TP \TUB \TUG +\tug \UG \UNIX \VAX \VorTeX \XeT \WEB \WEAVE + +\Dash \dash \vellipsis \bull \cents \Dag +\careof \thinskip + +\acro{FRED} -> {\sc fred} % please use! +\cs{fred} -> \fred +\env{fred} -> \begin{fred} +\meta{fred} -> <fred> +\nth{n} -> 1st, 2nd, ... +\sfrac{3/4} -> 3/4 +\booktitle{Book of Fred} +\end{verbatim} +} + +For more information, see the ltubguid document at: +\url{http://mirror.ctan.org/macros/latex/contrib/tugboat} + +Email \verb|tugboat@tug.org| if problems or questions. + + +\bibliographystyle{plain} % we recommend the plain bibliography style +\nocite{book-minimal} % just making the bibliography non-empty +\bibliography{xampl} % xampl.bib comes with BibTeX + + +\makesignature % not in ltugproc +\end{document}</verbatim> + </section> + </node> + <node> + <nodename>Concept Index</nodename> + <nodeprev>Command Index</nodeprev> + <nodeup>Top</nodeup> + <unnumbered> + <title>Concept Index</title> + <printindex>cp</printindex> +<!-- The name of the `Command Index' node must NOT be altered for ltx-help.el. --> + </unnumbered> + </node> + <node> + <nodename>Command Index</nodename> + <nodenext>Concept Index</nodenext> + <nodeprev>Document templates</nodeprev> + <nodeup>Top</nodeup> + <unnumbered> + <title>Command Index</title> + <printindex>fn</printindex> + </unnumbered> + </node> +</texinfo> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-indent-step:1 +sgml-indent-data:nil +End: +--> |