diff options
| author | Karl Berry <karl@freefriends.org> | 2009-05-23 00:23:51 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2009-05-23 00:23:51 +0000 |
| commit | a683c3d7e9fac38ec713f23fb6b9d2c7143aea82 (patch) | |
| tree | 424ab223921f85fd3f167a4ccd0e2d37d05c2927 /Master/texmf-dist/doc/latex/latex2e-help-texinfo | |
| parent | 5beb5368a684995153c8566797ba054f21c666af (diff) | |
move english latex doc out of texmf-doc
git-svn-id: svn://tug.org/texlive/trunk@13412 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo')
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog | 269 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile | 39 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS | 71 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/README | 13 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk | 6498 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dvi | bin | 0 -> 594424 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html | 7877 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf | bin | 0 -> 740914 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi | 6474 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt | 5951 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml | 7105 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/ltx-help.el | 270 |
12 files changed, 34567 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog new file mode 100644 index 00000000000..88a2c7beb97 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ChangeLog @@ -0,0 +1,269 @@ +2008-06-12 Karl Berry <karl@tug.org> + + * 2.0 release for ctan.org/get/doc/latex-info, and TeX Live 2008. + +2007-11-05 Karl Berry <karl@gnu.org> + + * latex2e.texi: \put \raggedbottom + +2007-11-04 Karl Berry <karl@gnu.org> + + * latex2e.texi: \ps \psi \Psi \pushtabs + +2007-11-03 Karl Berry <karl@gnu.org> + + * latex2e.texi: \protect + +2007-10-29 Karl Berry <karl@gnu.org> + + * latex2e.texi (math): \Pr \prec \preceq \prime \prod \propto. + +2007-10-28 Karl Berry <karl@gnu.org> + + * latex2e.texi (Text symbols): \poptabs \pounds. + +2007-10-25 Karl Berry <karl@gnu.org> + + * latex2e.texi: \perp \phi \pi \Pi \pm \pmod + +2007-10-24 Karl Berry <karl@gnu.org> + + * latex2e.texi: \part \partial + +2007-10-23 Karl Berry <karl@gnu.org> + + * latex2e.texi: \parskip + +2007-10-22 Karl Berry <karl@gnu.org> + + * latex2e.texi: \parsep + +2007-10-21 Karl Berry <karl@gnu.org> + + * latex2e.texi: \parindent + +2007-10-20 Karl Berry <karl@gnu.org> + + * latex2e.texi: \parbox + +2007-10-17 Karl Berry <karl@gnu.org> + + * latex2e.texi: \paragraph \parallel + +2007-10-16 Karl Berry <karl@gnu.org> + + * latex2e.texi: \pagestyle + +2007-10-15 Karl Berry <karl@gnu.org> + + * latex2e.texi: \pagenumberingstyle \pageref + +2007-10-11 Karl Berry <karl@gnu.org> + + * latex2e.texi: \oplus \oslash \otimes + +2007-10-10 Karl Berry <karl@gnu.org> + + * latex2e.texi: \onecolumn \opening + +2007-10-08 Karl Berry <karl@gnu.org> + + * latex2e.texi: \dot \oe \OE \oint \omega \Omega \ominus + +2007-10-07 Karl Berry <karl@gnu.org> + + * latex2e.texi (\oddsidemargin) + +2007-10-06 Karl Berry <karl@gnu.org> + + * latex2e.texi: \obeycr, \restorecr; split page/line breaking into + separate chapters. + +2007-10-05 Karl Berry <karl@gnu.org> + + * latex2e.texi: \not \notin \nu \nwarrow \o \O + +2007-10-04 Karl Berry <karl@gnu.org> + + * latex2e.texi (\normalmarginpar \normalsize) + +2007-10-03 Karl Berry <karl@gnu.org> + + * latex2e.texi: \nopagebreak + +2007-06-27 Karl Berry <karl@gnu.org> + + * latex2e.texi: \flat \flushbottom + +2007-06-26 Karl Berry <karl@gnu.org> + + * latex2e.texi: \evensidemargin \exists \exp \fbox \fboxrule + \fboxsep + +2007-06-25 Karl Berry <karl@gnu.org> + + * latex2e.texi: \epsilon \equiv \eta + +2007-06-24 Karl Berry <karl@gnu.org> + + * latex2e.texi: \em \emptyset \encl + +2007-06-23 Karl Berry <karl@gnu.org> + + * latex2e.texi: \doublerulesep \downarrow \Downarrow \ell + +2007-06-22 Karl Berry <karl@gnu.org> + + * latex2e.texi: \dot \doteq \dotfill + +2007-06-21 Karl Berry <karl@gnu.org> + + * latex2e.texi: \displaystyle + +2007-06-20 Karl Berry <karl@gnu.org> + + * latex2e.texi: \deg \delta \Delta \det \diamond \Diamong + \diamondsuit \dim \div + +2007-06-19 Karl Berry <karl@gnu.org> + + * latex2e.texi: \ddag \ddagger \ddot + +2007-06-18 Karl Berry <karl@gnu.org> + + * latex2e.texi: \dblfloatpagefraction \dblfloatsep + \dbltextfloatsep \dbltopfraction + +2007-06-17 Karl Berry <karl@gnu.org> + + * latex2e.texi: \day \month \year; put xref chapter earlier. + +2007-06-16 Karl Berry <karl@gnu.org> + + * latex2e.texi: \dashbox \dashv \date + +2007-06-15 Karl Berry <karl@gnu.org> + + * latex2e.texi: \d \dag \dagger + +2007-06-14 Karl Berry <karl@gnu.org> + + * latex2e.texi: \cos \cosh \cot \coth \cup + +2007-06-13 Karl Berry <karl@gnu.org> + + * latex2e.texi: \cong \coprod \copyright + +2007-06-12 Karl Berry <karl@gnu.org> + + * latex2e.texi: \columnsep \columnseprule \columnwidth + +2007-06-11 Karl Berry <karl@gnu.org> + + * latex2e.texi: \cline \closing \clubsuit + +2007-06-03 Karl Berry <karl@gnu.org> + + * latex2e.texi: \chi \circ \circle[*] + +2007-06-01 Karl Berry <karl@gnu.org> + + * latex2e.texi: \centering \chapter \check + +2007-05-31 Karl Berry <karl@gnu.org> + + * latex2e.texi: \caption \cc \cdot \cdots + +2007-05-30 Karl Berry <karl@gnu.org> + + * latex2e.texi: \cal \cap + +2007-05-24 Karl Berry <karl@gnu.org> + + * latex2e.texi: \bottomfraction, \bowtie, \Box, \breve, \bullet, \c. + +2007-05-23 Karl Berry <karl@gnu.org> + + * latex2e.texi: \boldmath, \bot. + +2007-05-22 Karl Berry <karl@gnu.org> + + * latex2e.texi (\bigskip, \bmod) + +2007-05-21 Karl Berry <karl@gnu.org> + + * latex2e.texi (Math Symbols): \big operators + +2007-05-19 Karl Berry <karl@gnu.org> + + * latex2e.texi (Using BibTeX): \bibliography, \bibliographystyle + +2007-05-18 Karl Berry <karl@gnu.org> + + * latex2e.texi (\bf, \bibitem) + +2007-05-17 Karl Berry <karl@gnu.org> + + * latex2e.texi (verse environment, \beta) + +2007-05-15 Karl Berry <karl@gnu.org> + + * latex2e.texi (titlepage, verbatim): environments. + (\verb). + +2007-05-14 Karl Berry <karl@gnu.org> + + * latex2e.texi (theorem): environment. + +2007-05-12 Karl Berry <karl@gnu.org> + + * latex2e.texi (tabbing): environment. + +2007-04-12 Karl Berry <karl@gnu.org> + + * latex2e.texi (\AT): new node for \@. + +2007-04-11 Karl Berry <karl@gnu.org> + + * latex2e.texi (tabbing): \a' \a` \a= for accents. + +2007-04-10 Karl Berry <karl@gnu.org> + + * latex2e.texi (Accents): \~ for tilde accent. + +2007-04-09 Karl Berry <karl@gnu.org> + + * latex2e.texi: \| + +2007-04-06 Karl Berry <karl@gnu.org> + + * latex2e.texi: \\ in its various contexts + +2007-04-02 Karl Berry <karl@gnu.org> + + * latex2e.texi: macron accent + * latex2e.texi (Accents): \= for macron. + +2007-04-01 Karl Berry <karl@gnu.org> + + * latex2e.texi: \: \; \< + +2007-03-30 Karl Berry <karl@gnu.org> + + * latex2e.texi: through \. + +2007-03-28 Karl Berry <karl@gnu.org> + + * latex2e.texi: remove unneeded @page, fix over/underfull boxes, etc. + +2007-03-27 Karl Berry <karl@gnu.org> + + * latex2e.texi: remove node pointers + * latex2e.texi: \*: discretionary multiplication. + +2007-03-21 Karl Berry <karl@gnu.org> + + * latex2e.texi (\SPACE): new node. + + * latex2e.texi: remove comments, single space after @node for ease + of searching. diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile new file mode 100644 index 00000000000..f2ef4f052b3 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/Makefile @@ -0,0 +1,39 @@ +# Copyright 2006 Karl Berry. +# You may freely use, modify and/or distribute this file. +# Makefile for latexrefman. + +texi2dvi = texi2dvi --batch --tidy --build-dir=$*.t2dvi +texi2pdf = texi2pdf --batch --tidy --build-dir=$*.t2pdf +# +texi2docbook = makeinfo --docbook +texi2html = makeinfo --no-split --html +texi2info = makeinfo --no-split +texi2txt = makeinfo --no-split --plaintext -o $@ +texi2xml = makeinfo --xml + +%.pdf: %.texi + $(texi2pdf) $< +%.dvi: %.texi + $(texi2dvi) $< +%.dbk: %.texi + $(texi2docbook) -o $@ $< +%.html: %.texi + $(texi2html) $< +%.info: %.texi + $(texi2info) $< +%.txt: %.texi + $(texi2txt) $< +%.xml: %.texi + $(texi2xml) $< + +tex_output = latex2e.dvi latex2e.pdf +makeinfo_output = latex2e.info latex2e.html latex2e.txt latex2e.xml latex2e.dbk +all: makeinfo_output tex_output +makeinfo_output: $(makeinfo_output) +tex_output: $(tex_output) + +mostlyclean clean: + rm -rf latex2e.t2* + +realclean distclean: clean + rm -f $(all) diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS new file mode 100644 index 00000000000..006d315db78 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/NEWS @@ -0,0 +1,71 @@ +NEWS for latex2e.texi, aka the latex2e-help-texinfo package. + +---------------------------------------------------------------- +Changes in release 2.0: + +After discussions with Torsten and Stephen Gilmore, maintainership of +this document has been handed off to me. See the README for more +project info. + +Dozens of missing commands added; all mathematical symbol commands in +basic LaTeX are now included. Also a few usage examples, template +documents, default values, and more. Of course plenty more work could +be done, contributions welcome. + +The Info file is now named latex2e.info, for consistency. ltx-help.el +updated accordingly. + +Derived files generated with the current TeX and Texinfo. + +Karl Berry (karl@freefriends.org), June 12 2008 + +---------------------------------------------------------------- +Changes in release 1.6: + +Some minor bug fixes; thanks to Piet van Oostrum and Ralf +Fassel for those. + +The node previously named 'List of Commands' is now named 'Command +Index' so that the Emacs command Info-index may work. Suggested by Ralf +Fassel. 'ltx-help.el' has therefore been updated. You _must_ use the +ltx-help.el included in this release with version 1.6 of latex2e.texi. +A bug has also been fixed in ltx-help.el; thanks to Kurt Hornik for +this. + +As always, bug reports and comments are welcome. + +Torsten Martinsen, April 24 1996 + +---------------------------------------------------------------- +Changes in release 1.3: + +A selection of low-level NFSS2 commands added. +A short description of how to use BibTeX. +Concept index cleaned up. +Function index should be complete now. +Better formatting. +Description of recommended naming conventions for labels. +Several minor omissions and errors fixed. + +Torsten Martinsen, March 13th 1995 + +---------------------------------------------------------------- +Changes in release 1.4: + +NOTE: The name of the generated Info file is now `latex' and not `latex2e'. +More commands added to function index (ahem). +Index generally improved. +A few omissions fixed. + +Torsten Martinsen, April 5th 1995 + +---------------------------------------------------------------- +Changes in release 1.5: + +All menu items now have one-line descriptions. +Major cleanup of next/previous links. +Some other minor cleanups. +NOTE that my mail address has changed. +Emacs Lisp file 'ltx-help.el' for use with AUC TeX included. + +Torsten Martinsen, April 9 1996 diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/README b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/README new file mode 100644 index 00000000000..66f243a1375 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/README @@ -0,0 +1,13 @@ +Copyright 2008 Karl Berry. +You may freely use, modify and/or distribute this file. + +This project is an attempt to write a reference manual for core LaTeX. +It is unofficial and the LaTeX Project members have not reviewed it. + +http://home.gna.org/latexrefman (the project home page) has more +information, including links to the current output in various formats, +sources, mailing lists, and other infrastructure. + +Help is most definitely wanted. (Search for "xx" in the source for just +a few of the known deficiencies.) Please email any bug reports, new +material, general discussion, whatever, to latexrefman-discuss@gna.org. diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk new file mode 100644 index 00000000000..8d7d14494a2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk @@ -0,0 +1,6498 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + <!ENTITY tex "TeX"> + <!ENTITY latex "LaTeX"> +]> +<book id="latex2e.dbk" lang="en"> + <title>&latex;2e reference manual 2.0</title> +<!-- %**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. --> + <bookinfo> + <legalnotice> + <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 <filename>LATEX.HLP</filename> 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 <citetitle>Hypertext Help with &latex;</citetitle>, by Sheldon Green, and the +<citetitle>&latex; Command Summary</citetitle> (for &latex; 2.09) by L. Botway +and C. Biemesderfer (published by the &tex; Users Group as +<citetitle>&tex;niques</citetitle> number 10), as reference material (text was not +directly copied).</para> + <para>Copyright © 2007, 2008 Karl Berry. +Copyright © 1988, 1994, 2007 Stephen Gilmore. +Copyright © 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> + </legalnotice> +</bookinfo> + <chapter label="" xreflabel="LaTeX2e" id="Top"> + <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 role="cp"><primary>Knuth, Donald E.</primary></indexterm><indexterm role="cp"><primary>Lamport, Leslie</primary></indexterm><indexterm role="cp"><primary>&latex; Project team</primary></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 +(<ulink url="http://latex-project.org">http://latex-project.org</ulink>). 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> + </chapter> + + <chapter label="1" id="Overview"> + <title>Overview of &latex;</title> + <para><indexterm role="cp"><primary>overview of &latex;</primary></indexterm><indexterm role="cp"><primary>&latex; overview</primary></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> + <orderedlist numeration="arabic"> + <listitem> + <para>A main output file, which is one of:</para> + <orderedlist numeration="arabic"> + <listitem> + <para>If invoked as <command>latex</command>, a “Device Independent” (<filename>.dvi</filename>) +file. This contains commands that can be translated into commands for +a variety of output devices. You can view such <filename>.dvi</filename> output of +&latex; by using a program such as <command>xdvi</command> (display directly) +or <command>dvips</command> (convert to PostScript).</para> + </listitem> + <listitem> + <para>If invoked as <command>pdflatex</command>, a “Portable Document Format” +(<filename>.pdf</filename>) 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 <filename>.dvi</filename> produced from the +same document.</para> + </listitem> + </orderedlist> + <para>There are other less-common variants of &latex; (and &tex;) as well, +which can produce HTML, XML, and other things.</para> + </listitem> + <listitem> + <para>A “transcript” or <filename>.log</filename> file that contains summary information and +diagnostic messages for any errors discovered in the input file.</para> + </listitem> + <listitem> + <para>An “auxiliary” or <filename>.aux</filename> file. This is used by &latex; itself, for +things such as sectioning.</para> + </listitem> + </orderedlist> + <para>A &latex; command begins with the command name, which consists of a +<literal>\</literal> followed by either (a) a string of letters or (b) a +single non-letter. Arguments contained in square brackets, <literal>[]</literal>, +are optional while arguments contained in braces, <literal>{}</literal>, are +required.</para> + <para>&latex; is case sensitive. Enter all commands in lower case unless +explicitly directed to do otherwise.</para> + </chapter> + + <chapter label="2" id="Starting-&-ending"> + <title>Starting & ending</title> + <para><indexterm role="cp"><primary>starting & ending</primary></indexterm><indexterm role="cp"><primary>ending & starting</primary></indexterm> +A minimal input file looks like the following:</para> + <screen> +\documentclass{<replaceable>class</replaceable>} +\begin{document} +<replaceable>your text</replaceable> +\end{document} +</screen> + <para role="continues">where the <replaceable>class</replaceable> is a valid document class for &latex;. +See <xref linkend="Document-classes"></xref>, for details of the various document classes +available locally.</para> + <para><indexterm role="cp"><primary>preamble, defined</primary></indexterm>You may include other &latex; commands between the <literal>\documentclass</literal> +and the <literal>\begin{document}</literal> commands (this area is called the +<firstterm>preamble</firstterm>).</para> + </chapter> + + <chapter label="3" id="Document-classes"> + <title>Document classes</title> + <para><indexterm role="cp"><primary>document classes</primary></indexterm><indexterm role="cp"><primary>classes of documents</primary></indexterm><indexterm role="fn"><primary>\documentclass</primary></indexterm> +The class of a given document is defined with the command:</para> + <screen> +\documentclass[<replaceable>options</replaceable>]{<replaceable>class</replaceable>} +</screen> + <para role="continues">The <literal>\documentclass</literal> command must be the first command in a +&latex; source file.</para> + <para><indexterm role="fn"><primary>article class</primary></indexterm><indexterm role="fn"><primary>report class</primary></indexterm><indexterm role="fn"><primary>book class</primary></indexterm><indexterm role="fn"><primary>letter class</primary></indexterm><indexterm role="fn"><primary>slides class</primary></indexterm>Built-in &latex; document <replaceable>class</replaceable> names are (many other document +classes are available as add-ons; see <xref linkend="Overview"></xref>):</para> + <screen> +article report book letter slides +</screen> +<!-- xx briefly describe each one --> + <para>Standard <replaceable>options</replaceable> are described below.</para> + + <sect1 label="3.1" id="Document-class-options"> + <title>Document class options</title> + <para><indexterm role="cp"><primary>document class options</primary></indexterm><indexterm role="cp"><primary>options, document class</primary></indexterm><indexterm role="cp"><primary>class options</primary></indexterm><indexterm role="cp"><primary>global options</primary></indexterm> +You can specify so-called <firstterm>global options</firstterm> or <firstterm>class options</firstterm> +to the <literal>\documentclass</literal> command by enclosing them in square +brackets as usual. To specify more than one <replaceable>option</replaceable>, separate +them with a comma:</para> + <screen> +\documentclass[<replaceable>option1</replaceable>,<replaceable>option2</replaceable>,...]{<replaceable>class</replaceable>} +</screen> + <para>Here is the list of the standard class options.</para> + <para><indexterm role="fn"><primary>10pt option</primary></indexterm><indexterm role="fn"><primary>11pt option</primary></indexterm><indexterm role="fn"><primary>12pt option</primary></indexterm>All of the standard classes except <literal>slides</literal> accept the following +options for selecting the typeface size (default is <literal>10pt</literal>):</para> + <screen> +10pt 11pt 12pt +</screen> + <para><indexterm role="fn"><primary>a4paper option</primary></indexterm><indexterm role="fn"><primary>a5paper option</primary></indexterm><indexterm role="fn"><primary>b5paper option</primary></indexterm><indexterm role="fn"><primary>executivepaper option</primary></indexterm><indexterm role="fn"><primary>legalpaper option</primary></indexterm><indexterm role="fn"><primary>letterpaper option</primary></indexterm>All of the standard classes accept these options for selecting the paper +size (default is <literal>letterpaper</literal>):</para> + <screen> +a4paper a5paper b5paper executivepaper legalpaper letterpaper +</screen> + <para><indexterm role="fn"><primary>draft option</primary></indexterm><indexterm role="fn"><primary>final option</primary></indexterm><indexterm role="fn"><primary>fleqn option</primary></indexterm><indexterm role="fn"><primary>landscape option</primary></indexterm><indexterm role="fn"><primary>leqno option</primary></indexterm><indexterm role="fn"><primary>openbib option</primary></indexterm><indexterm role="fn"><primary>titlepage option</primary></indexterm><indexterm role="fn"><primary>notitlepage option</primary></indexterm>Miscellaneous other options:</para> + <variablelist> + <varlistentry> + <term><literal>draft, final</literal></term> + <listitem> + <para><indexterm role="cp"><primary>black boxes, omitting</primary></indexterm>mark/do not mark overfull boxes with a big black box; default is <literal>final</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>fleqn</literal></term> + <listitem> + <para>Put displayed formulas flush left; default is centered.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>landscape</literal></term> + <listitem> + <para>Selects landscape format; default is portrait.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>leqno</literal></term> + <listitem> + <para>Put equation numbers on the left side of equations; default is the right side.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>openbib</literal></term> + <listitem> + <para>Use “open” bibliography format.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>titlepage, notitlepage</literal></term> + <listitem> + <para>Specifies whether the title page is separate; default depends on the class.</para> + </listitem> + </varlistentry> + </variablelist> + <para>These options are not available with the slides class:</para> + <para><indexterm role="fn"><primary>onecolumn option</primary></indexterm><indexterm role="fn"><primary>twocolumn option</primary></indexterm><indexterm role="fn"><primary>oneside option</primary></indexterm><indexterm role="fn"><primary>twoside option</primary></indexterm><indexterm role="fn"><primary>openright option</primary></indexterm><indexterm role="fn"><primary>openany option</primary></indexterm></para> + <variablelist> + <varlistentry> + <term><literal>onecolumn</literal></term> + <term><literal>twocolumn</literal></term> + <listitem> + <para>Typeset in one or two columns; default is <literal>onecolumn</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>oneside</literal></term> + <term><literal>twoside</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\evensidemargin</primary></indexterm><indexterm role="fn"><primary>\oddsidemargin</primary></indexterm>Selects one- or two-sided layout; default is <literal>oneside</literal>, except +for the <literal>book</literal> class.</para> + <para>The <literal>\evensidemargin</literal> (<literal>\oddsidemargin</literal> 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, <literal>\oddsidemargin</literal> is +40% of the difference between <literal>\paperwidth</literal> and <literal>\textwidth</literal> +with <literal>\evensidemargin</literal> the remainder.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>openright</literal></term> + <term><literal>openany</literal></term> + <listitem> + <para>Determines if a chapter should start on a +right-hand page; default is <literal>openright</literal> for book.</para> + </listitem> + </varlistentry> + </variablelist> + <para>The <literal>slides</literal> class offers the option <literal>clock</literal> for printing +the time at the bottom of each note.</para> + <para><indexterm role="cp"><primary>packages, loading</primary></indexterm><indexterm role="cp"><primary>loading additional packages</primary></indexterm><indexterm role="fn"><primary>\usepackage</primary></indexterm>Additional packages are loaded like this:</para> + <screen> +\usepackage[<replaceable>options</replaceable>]{<replaceable>pkg</replaceable>} +</screen> + <para>To specify more than one <replaceable>pkg</replaceable>, you can separate them with a +comma, or use multiple <literal>\usepackage</literal> commands.</para> + <para><indexterm role="cp"><primary>global options</primary></indexterm><indexterm role="cp"><primary>options, global</primary></indexterm>Any options given in the <literal>\documentclass</literal> command that are unknown +by the selected document class are passed on to the packages loaded with +<literal>\usepackage</literal>.</para> + </sect1> + </chapter> + + <chapter label="4" id="Typefaces"> + <title>Typefaces</title> + <para><indexterm role="cp"><primary>typefaces</primary></indexterm><indexterm role="cp"><primary>fonts</primary></indexterm> +Two important aspects of selecting a <firstterm>font</firstterm> are specifying a size +and a style. The &latex; commands for doing this are described here.</para> + + <sect1 label="4.1" id="Font-styles"> + <title>Font styles</title> + <para><indexterm role="cp"><primary>font styles</primary></indexterm><indexterm role="cp"><primary>typeface styles</primary></indexterm><indexterm role="cp"><primary>styles of text</primary></indexterm> +The following type style commands are supported by &latex;.</para> + <para>These commands are used like <literal>\textit{italic text}</literal>. 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 +<literal>\sffamily\bfseries</literal> or <literal>\bfseries\sffamily</literal> to get bold +sans serif.</para> + <para>You can also use the environment form of the declaration forms; for instance, +<literal>\begin{ttfamily}...\end{ttfamily}</literal>.</para> + <variablelist> + <varlistentry> + <term><literal>\textrm (\rmfamily)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textrm</primary></indexterm><indexterm role="fn"><primary>\rmfamily</primary></indexterm>Roman.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textit (\itshape)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textit</primary></indexterm><indexterm role="fn"><primary>\itshape</primary></indexterm>Italics.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\emph</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\emph</primary></indexterm><indexterm role="cp"><primary>emphasis</primary></indexterm>Emphasis (switches between <literal>\textit</literal> and <literal>\textrm</literal>).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textmd (\mdseries)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textmd</primary></indexterm><indexterm role="fn"><primary>\mdseries</primary></indexterm>Medium weight (default).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textbf (\bfseries)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textbf</primary></indexterm><indexterm role="fn"><primary>\bfseries</primary></indexterm>Boldface.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textup (\upshape)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textup</primary></indexterm><indexterm role="fn"><primary>\upshape</primary></indexterm>Upright (default). The opposite of slanted.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textsl (\slshape)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textsl</primary></indexterm><indexterm role="fn"><primary>\slshape</primary></indexterm>Slanted.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textsf (\sffamily)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textsf</primary></indexterm><indexterm role="fn"><primary>\sffamily</primary></indexterm>Sans serif.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textsc (\scshape)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textsc</primary></indexterm><indexterm role="fn"><primary>\scshape</primary></indexterm>Small caps.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\texttt (\ttfamily)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\texttt</primary></indexterm><indexterm role="fn"><primary>\ttfamily</primary></indexterm>Typewriter.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textnormal (\normalfont)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\textnormal</primary></indexterm><indexterm role="fn"><primary>\normalfont</primary></indexterm>Main document font.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mathrm</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\mathrm</primary></indexterm>Roman, for use in math mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mathbf</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\mathbf</primary></indexterm>Boldface, for use in math mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mathsf</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\mathsf</primary></indexterm>Sans serif, for use in math mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mathtt</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\mathtt</primary></indexterm>Typewriter, for use in math mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mathit</literal></term> + <term><literal>(\mit)</literal></term> + <listitem> + <para>Italics, for use in math mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mathnormal</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\mathnormal</primary></indexterm>For use in math mode, e.g. inside another type style declaration.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mathcal</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\mathcal</primary></indexterm>`Calligraphic' letters, for use in math mode.</para> + </listitem> + </varlistentry> + </variablelist> + <para>In addition, the command +<literal>\mathversion{bold}</literal> +<indexterm role="fn"><primary>\mathversion</primary></indexterm>can be used for switching to bold letters and symbols in +formulas. <literal>\mathversion{normal}</literal> restores the default.</para> + <para>&latex; also provides these commands, which unconditionally switch to +the given style, that is, are <emphasis>not</emphasis> cumulative. They are used +differently than the above commands, too: <literal>{\<replaceable>cmd</replaceable> ...}</literal> +instead of <literal>\<replaceable>cmd</replaceable>{...}</literal>. These are two very different +things.</para> + <variablelist> + <varlistentry> + <term><literal>\bf</literal></term> + <listitem> + <para><indexterm role="cp"><primary>bold font</primary></indexterm>Switch to <emphasis role="bold">bold face</emphasis>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cal</literal></term> + <listitem> + <para><indexterm role="cp"><primary>script letters for math</primary></indexterm><indexterm role="cp"><primary>calligraphic letters for math</primary></indexterm>Switch to calligraphic letters for math.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\em</literal></term> + <listitem> + <para><indexterm role="cp"><primary>emphasis</primary></indexterm>Emphasis (italics within roman, roman within italics).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\it</literal></term> + <listitem> + <para><indexterm role="cp"><primary>italic font</primary></indexterm>Italics.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rm</literal></term> + <listitem> + <para><indexterm role="cp"><primary>roman font</primary></indexterm>Roman.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sc</literal></term> + <listitem> + <para><indexterm role="cp"><primary>small caps font</primary></indexterm>Small caps.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sf</literal></term> + <listitem> + <para><indexterm role="cp"><primary>sans serif font</primary></indexterm>Sans serif.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sl</literal></term> + <listitem> + <para><indexterm role="cp"><primary>slanted font</primary></indexterm><indexterm role="cp"><primary>oblique font</primary></indexterm>Slanted (oblique).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\tt</literal></term> + <listitem> + <para><indexterm role="cp"><primary>typewriter font</primary></indexterm><indexterm role="cp"><primary>monospace font</primary></indexterm><indexterm role="cp"><primary>fixed-width font</primary></indexterm>Typewriter (monospace, fixed-width).</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="4.2" id="Font-sizes"> + <title>Font sizes</title> + <para><indexterm role="cp"><primary>font sizes</primary></indexterm><indexterm role="cp"><primary>typeface sizes</primary></indexterm><indexterm role="cp"><primary>sizes of text</primary></indexterm> +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 ‘<literal>10pt</literal>’, ‘<literal>11pt</literal>’, and +‘<literal>12pt</literal>’ document size options, respectively (see <xref linkend="Document-class-options"></xref>).</para> + <para><indexterm role="fn"><primary>\tiny</primary></indexterm><indexterm role="fn"><primary>\scriptsize</primary></indexterm><indexterm role="fn"><primary>\footnotesize</primary></indexterm><indexterm role="fn"><primary>\small</primary></indexterm><indexterm role="fn"><primary>\normalsize</primary></indexterm><indexterm role="fn"><primary>\large</primary></indexterm><indexterm role="fn"><primary>\Large</primary></indexterm><indexterm role="fn"><primary>\LARGE</primary></indexterm><indexterm role="fn"><primary>\huge</primary></indexterm><indexterm role="fn"><primary>\Huge</primary></indexterm></para> + <informaltable> + <tgroup cols="4"> + <colspec colwidth="42*"></colspec> + <colspec colwidth="7*"></colspec> + <colspec colwidth="7*"></colspec> + <colspec colwidth="7*"></colspec> + <thead> + <row> + <entry>Command</entry> + <entry><literal>10pt</literal></entry> + <entry><literal>11pt</literal></entry> + <entry><literal>12pt</literal></entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>\tiny</literal></entry> + <entry>5</entry> + <entry>6</entry> + <entry>6</entry> + </row> + <row> + <entry><literal>\scriptsize</literal></entry> + <entry>7</entry> + <entry>8</entry> + <entry>8</entry> + </row> + <row> + <entry><literal>\footnotesize</literal></entry> + <entry>8</entry> + <entry>9</entry> + <entry>10</entry> + </row> + <row> + <entry><literal>\small</literal></entry> + <entry>9</entry> + <entry>10</entry> + <entry>10.95</entry> + </row> + <row> + <entry><literal>\normalsize</literal> (default)</entry> + <entry>10</entry> + <entry>10.95</entry> + <entry>12</entry> + </row> + <row> + <entry><literal>\large</literal></entry> + <entry>12</entry> + <entry>12</entry> + <entry>14.4</entry> + </row> + <row> + <entry><literal>\Large</literal></entry> + <entry>14.4</entry> + <entry>14.4</entry> + <entry>17.28</entry> + </row> + <row> + <entry><literal>\LARGE</literal></entry> + <entry>17.28</entry> + <entry>17.28</entry> + <entry>20.74</entry> + </row> + <row> + <entry><literal>\huge</literal></entry> + <entry>20.74</entry> + <entry>20.74</entry> + <entry>24.88</entry> + </row> + <row> + <entry><literal>\Huge</literal></entry> + <entry>24.88</entry> + <entry>24.88</entry> + <entry>24.88</entry> + </row> + </tbody> + </tgroup> + </informaltable> + <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, <literal>\begin{tiny}...\end{tiny}</literal>.</para> + </sect1> + + <sect1 label="4.3" id="Low-level-font-commands"> + <title>Low-level font commands</title> + <para><indexterm role="cp"><primary>low-level font commands</primary></indexterm><indexterm role="cp"><primary>font commands, low-level</primary></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> + <variablelist> + <varlistentry> + <term><literal>\fontencoding{enc}</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\fontencoding</primary></indexterm>Select font encoding. Valid encodings include <literal>OT1</literal> and <literal>T1</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\fontfamily{family}</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\fontfamily</primary></indexterm>Select font family. Valid families include:</para> + <itemizedlist mark="bullet"> + <listitem> + <para><literal>cmr</literal> for Computer Modern Roman</para> + </listitem> + <listitem> + <para><literal>cmss</literal> for Computer Modern Sans Serif</para> + </listitem> + <listitem> + <para><literal>cmtt</literal> for Computer Modern Typewriter</para> + </listitem> + </itemizedlist> + <para>and numerous others.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\fontseries{series}</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\fontseries</primary></indexterm>Select font series. Valid series include:</para> + <itemizedlist mark="bullet"> + <listitem> + <para><literal>m</literal> Medium (normal)</para> + </listitem> + <listitem> + <para><literal>b</literal> Bold</para> + </listitem> + <listitem> + <para><literal>c</literal> Condensed</para> + </listitem> + <listitem> + <para><literal>bc</literal> Bold condensed</para> + </listitem> + <listitem> + <para><literal>bx</literal> Bold extended</para> + </listitem> + </itemizedlist> + <para>and various other combinations.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\fontshape{shape}</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\fontshape</primary></indexterm>Select font shape. Valid shapes are:</para> + <itemizedlist mark="bullet"> + <listitem> + <para><literal>n</literal> Upright (normal)</para> + </listitem> + <listitem> + <para><literal>it</literal> Italic</para> + </listitem> + <listitem> + <para><literal>sl</literal> Slanted (oblique)</para> + </listitem> + <listitem> + <para><literal>sc</literal> Small caps</para> + </listitem> + <listitem> + <para><literal>ui</literal> Upright italics</para> + </listitem> + <listitem> + <para><literal>ol</literal> Outline</para> + </listitem> + </itemizedlist> + <para>The two last shapes are not available for most font families.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\fontsize{size}{skip}</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\fontsize</primary></indexterm><indexterm role="fn"><primary>\baselineskip</primary></indexterm>Set font size. The first parameter is the font size to switch to and +the second is the line spacing to use; this is stored in a parameter +named <literal>\baselineskip</literal>. The unit of both parameters defaults to +pt. The default <literal>\baselineskip</literal> for the Computer Modern typeface +is 1.2 times the <literal>\fontsize</literal>.</para> + <para><indexterm role="fn"><primary>\baselinestretch</primary></indexterm><indexterm role="cp"><primary><literal>setspace</literal> package</primary></indexterm>The line spacing is also multiplied by the value of the +<literal>\baselinestretch</literal> parameter when the type size changes; the +default is 1. However, the best way to “double space” a document, +if you should be unlucky enough to have to produce such, is to use the +<literal>setspace</literal> package; see +<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</ulink>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\selectfont</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\selectfont</primary></indexterm>The changes made by calling the four font commands described above do +not come into effect until <literal>\selectfont</literal> is called.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\usefont{enc}{family}{series}{shape}</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\usefont</primary></indexterm>The same as invoking <literal>\fontencoding</literal>, <literal>\fontfamily</literal>, +<literal>\fontseries</literal> and <literal>\fontshape</literal> with the given parameters, +followed by <literal>\selectfont</literal>.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + </chapter> + + <chapter label="5" id="Layout"> + <title>Layout</title> + <para><indexterm role="cp"><primary>layout commands</primary></indexterm> +Miscellaneous commands for controlling the general layout of the page.</para> + + <sect1 label="5.1" id="\onecolumn"> + <title><literal>\onecolumn</literal></title> + <para><indexterm role="fn"><primary>\onecolumn</primary></indexterm><indexterm role="cp"><primary>one-column output</primary></indexterm> +The <literal>\onecolumn</literal> declaration starts a new page and produces +single-column output. This is the default.</para> + </sect1> + + <sect1 label="5.2" id="\twocolumn"> + <title><literal>\twocolumn</literal></title> + <para><indexterm role="fn"><primary>\twocolumn</primary></indexterm><indexterm role="cp"><primary>multicolumn text</primary></indexterm><indexterm role="cp"><primary>two-column output</primary></indexterm> +Synopsis:</para> + <screen> +\twocolumn[<replaceable>text1col</replaceable>] +</screen> + <para>The <literal>\twocolumn</literal> declaration starts a new page and produces +two-column output. If the optional <replaceable>text1col</replaceable> argument is present, +it is typeset in one-column mode before the two-column typesetting +starts.</para> + <para>These parameters control typesetting in two-column output:</para> + <variablelist> + <varlistentry> + <term><literal>\columnsep</literal></term> + <listitem> + <para>The distance between columns (35pt by default).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\columnseprule</literal></term> + <listitem> + <para>The width of the rule between columns; the default is 0pt, so there is no rule.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\columnwidth</literal></term> + <listitem> + <para>The width of the current column; this is equal to <literal>\textwidth</literal> in +single-column text.</para> + </listitem> + </varlistentry> + </variablelist> + <para>These parameters control float behavior in two-column output:</para> + <variablelist> + <varlistentry> + <term><literal>\dbltopfraction</literal></term> + <listitem> + <para>Maximum fraction at the top of a two-column page that may be occupied +by floats. Default ‘<literal>.7</literal>’, can be usefully redefined to (say) +‘<literal>.9</literal>’ to avoid going to float pages so soon.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dblfloatpagefraction</literal></term> + <listitem> + <para>The minimum fraction of a float page that must be occupied by floats, +for a two-column float page. Default ‘<literal>.5</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dblfloatsep</literal></term> + <listitem> + <para>Distance between floats at the top or bottom of a two-column float +page. Default ‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and +‘<literal>11pt</literal>’ documents, ‘<literal>14pt plus2pt minus4pt</literal>’ for ‘<literal>12pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dbltextfloatsep</literal></term> + <listitem> + <para>Distance between a multi-column float at the top or bottom of a page +and the main text. Default ‘<literal>20pt plus2pt minus4pt</literal>’.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="5.3" id="\flushbottom"> + <title><literal>\flushbottom</literal></title> + <para><indexterm role="fn"><primary>\flushbottom</primary></indexterm> +The <literal>\flushbottom</literal> 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 <literal>twocolumn</literal> mode is selected +(see <xref linkend="Document-class-options"></xref>).</para> + </sect1> + + <sect1 label="5.4" id="\raggedbottom"> + <title><literal>\raggedbottom</literal></title> + <para><indexterm role="fn"><primary>\raggedbottom</primary></indexterm><indexterm role="cp"><primary>stretch, omitting vertical</primary></indexterm> +The <literal>\raggedbottom</literal> declaration makes all pages the natural +height of the material on that page. No rubber lengths will be +stretched.</para> + </sect1> + + <sect1 label="5.5" id="Page-layout-parameters"> + <title>Page layout parameters</title> + <para><indexterm role="cp"><primary>page layout parameters</primary></indexterm><indexterm role="cp"><primary>parameters, page layout</primary></indexterm><indexterm role="cp"><primary>layout, page parameters for</primary></indexterm><indexterm role="cp"><primary>header, parameters for</primary></indexterm><indexterm role="cp"><primary>footer, parameters for</primary></indexterm><indexterm role="cp"><primary>running header and footer</primary></indexterm></para> + <variablelist> + <varlistentry> + <term><literal>\headheight</literal></term> + <listitem> + <para>Height of the box that contains the running head. Default is +‘<literal>30pt</literal>’, except in the <literal>book</literal> class, where it varies with the +type size.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\headsep</literal></term> + <listitem> + <para>Vertical distance between the bottom of the header line and the top of +the main text. Default is ‘<literal>25pt</literal>’, except in the <literal>book</literal> +class, where it varies with the type size.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\footskip</literal></term> + <listitem> + <para>Distance from the baseline of the last line of text to the baseline of +the page footer. Default is ‘<literal>30pt</literal>’, except in the <literal>book</literal> +class, where it varies with the type size.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\linewidth</literal></term> + <listitem> + <para>Width of the current line; the default varies with the font size, +paper width, two-column mode, etc. For an <literal>article</literal> document in +‘<literal>10pt</literal>’, it's set to ‘<literal>345pt</literal>’; in two-column mode, that +becomes ‘<literal>229.5pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textheight</literal></term> + <listitem> + <para>The normal vertical height of the page body; the default varies with +the font size, document class, etc. For an <literal>article</literal> or +<literal>report</literal> document in ‘<literal>10pt</literal>’, it's set to +‘<literal>43\baselineskip</literal>’; for <literal>book</literal>, it's ‘<literal>41\baselineskip</literal>’. +For ‘<literal>11pt</literal>’, it's ‘<literal>38\baselineskip</literal>’ and for ‘<literal>12pt</literal>’, +‘<literal>36\baselineskip</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textwidth</literal></term> + <listitem> + <para>The normal horizontal width of the page body; the default varies as +usual. For an <literal>article</literal> or <literal>report</literal> document, it's +‘<literal>345pt</literal>’ at ‘<literal>10pt</literal>’, ‘<literal>360pt</literal>’ at ‘<literal>11pt</literal>’, and +‘<literal>390pt</literal>’ at ‘<literal>12pt</literal>’. For a <literal>book</literal> document, it's +‘<literal>4.5in</literal>’ at ‘<literal>10pt</literal>’, and ‘<literal>5in</literal>’ at ‘<literal>11pt</literal>’ or ‘<literal>12pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\topmargin</literal></term> + <listitem> + <para>Space between the top of the &tex; page (one inch from the top of the +paper, by default) and the top of the header. The default is computed +based on many other parameters: <literal>\paperheight − 2in − +\headheight − \headsep − \textheight − \footskip</literal>, and +then divided by two.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\topskip</literal></term> + <listitem> + <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., ‘<literal>10pt</literal>’ at ‘<literal>10pt</literal>’.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + </chapter> + + <chapter label="6" id="Sectioning"> + <title>Sectioning</title> + <para><indexterm role="cp"><primary>sectioning</primary></indexterm> +Sectioning commands provide the means to structure your text into units:</para> + <variablelist> + <varlistentry> + <term><literal>\part</literal></term> + <term><literal>\chapter</literal></term> + <listitem> + <para>(report and book class only)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\section</literal></term> + <term><literal>\subsection</literal></term> + <term><literal>\subsubsection</literal></term> + <term><literal>\paragraph</literal></term> + <term><literal>\subparagraph</literal></term> + </varlistentry> + </variablelist> + <para>All sectioning commands take the same general form, e.g.,</para> + <screen> +\chapter[<replaceable>toctitle</replaceable>]{<replaceable>title</replaceable>} +</screen> + <para>In addition to providing the heading <replaceable>title</replaceable> in the main text, the +section title can appear in two other places:</para> + <orderedlist numeration="arabic"> + <listitem> + <para>The table of contents.</para> + </listitem> + <listitem> + <para>The running head at the top of the page.</para> + </listitem> + </orderedlist> + <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 +<replaceable>toctitle</replaceable> that, when given, specifies the text for these other +places.</para> + <para><indexterm role="cp"><primary>*-form of sectioning commands</primary></indexterm>Also, all sectioning commands have <literal>*</literal>-forms that print +<replaceable>title</replaceable> as usual, but do not include a number and do not make an +entry in the table of contents. For instance:</para> + <screen> +\section*{Preamble} +</screen> + <para><indexterm role="fn"><primary>\appendix</primary></indexterm><indexterm role="cp"><primary>appendix, creating</primary></indexterm>The <literal>\appendix</literal> command changes the way following sectional units +are numbered. The <literal>\appendix</literal> command itself generates no text +and does not affect the numbering of parts. The normal use of this +command is something like</para> + <screen> +\chapter{A Chapter} +… +\appendix +\chapter{The First Appendix} +</screen> + </chapter> + + <chapter label="7" id="Cross-references"> + <title>Cross references</title> + <para><indexterm role="cp"><primary>cross references</primary></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> + + <sect1 label="7.1" id="\label"> + <title><literal>\label</literal></title> + <para><indexterm role="fn"><primary>\label</primary></indexterm> +Synopsis:</para> + <screen> +\label{<replaceable>key</replaceable>} +</screen> + <para>A <literal>\label</literal> command appearing in ordinary text assigns to +<replaceable>key</replaceable> the number of the current sectional unit; one appearing +inside a numbered environment assigns that number to <replaceable>key</replaceable>.</para> + <para>A <replaceable>key</replaceable> name can consist of any sequence of letters, digits, or +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> + <variablelist> + <varlistentry> + <term><literal>ch</literal></term> + <listitem> + <para>for chapters</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>sec</literal></term> + <listitem> + <para>for lower-level sectioning commands</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>fig</literal></term> + <listitem> + <para>for figures</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>tab</literal></term> + <listitem> + <para>for tables</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>eq</literal></term> + <listitem> + <para>for equations</para> + </listitem> + </varlistentry> + </variablelist> + <para>Thus, a label for a figure would look like <literal>fig:snark</literal> or +<literal>fig.snark</literal>.</para> + </sect1> + + <sect1 label="7.2" id="\pageref"> + <title><literal>\pageref{<replaceable>key</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\pageref</primary></indexterm><indexterm role="cp"><primary>cross referencing with page number</primary></indexterm><indexterm role="cp"><primary>page number, cross referencing</primary></indexterm> +Synopsis:</para> + <screen> +\pageref{<replaceable>key</replaceable>} +</screen> + <para>The <literal>\pageref</literal>{<replaceable>key</replaceable>} command produces the page number of +the place in the text where the corresponding +<literal>\label</literal>{<replaceable>key</replaceable>} command appears.</para> + </sect1> + + <sect1 label="7.3" id="\ref"> + <title><literal>\ref{<replaceable>key</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\ref</primary></indexterm><indexterm role="cp"><primary>cross referencing, symbolic</primary></indexterm><indexterm role="cp"><primary>section number, cross referencing</primary></indexterm><indexterm role="cp"><primary>equation number, cross referencing</primary></indexterm><indexterm role="cp"><primary>figure number, cross referencing</primary></indexterm><indexterm role="cp"><primary>footnote number, cross referencing</primary></indexterm> +Synopsis:</para> + <screen> +\ref{<replaceable>key</replaceable>} +</screen> + <para>The <literal>\ref</literal> command produces the number of the sectional unit, +equation, footnote, figure, …, of the corresponding +<literal>\label</literal> command (see <xref linkend="\label"></xref>). It does not produce any text, +such as the word `Section' or `Figure', just the bare number itself.</para> + </sect1> + </chapter> + + <chapter label="8" id="Environments"> + <title>Environments</title> + <para><indexterm role="cp"><primary>environments</primary></indexterm> +<indexterm role="fn"><primary>\begin</primary></indexterm><indexterm role="fn"><primary>\end</primary></indexterm> +&latex; provides many environments for marking off certain text. +Each environment begins and ends in the same manner:</para> + <screen> +\begin{<replaceable>envname</replaceable>} +... +\end{<replaceable>envname</replaceable>} +</screen> + <sect1 label="8.1" id="abstract"> + <title><literal>abstract</literal></title> + <para><indexterm role="fn"><primary>abstract environment</primary></indexterm><indexterm role="cp"><primary>abstracts</primary></indexterm> +Synopsis:</para> + <screen> +\begin{abstract} +... +\end{abstract} +</screen> + <para>Environment for producing an abstract, possibly of multiple paragraphs.</para> + </sect1> + + <sect1 label="8.2" id="array"> + <title><literal>array</literal></title> + <para><indexterm role="fn"><primary>array environment</primary></indexterm><indexterm role="cp"><primary>arrays, math</primary></indexterm> +Synopsis:</para> + <screen> +\begin{array}{<replaceable>template</replaceable>} +<replaceable>col1 text</replaceable>&<replaceable>col1 text</replaceable>&<replaceable>coln</replaceable>}\\ +... +\end{array} +</screen> + <para>Math arrays are produced with the <literal>array</literal> environment, normally +within an <literal>equation</literal> environment (see <xref linkend="equation"></xref>). It has a +single mandatory <replaceable>template</replaceable> argument describing the number of +columns and the alignment within them. Each column <replaceable>col</replaceable> is +specified by a single letter that tells how items in that row should +be formatted, as follows:</para> + <variablelist> + <varlistentry> + <term><literal>c</literal></term> + <listitem> + <para>centered</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>l</literal></term> + <listitem> + <para>flush left</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>r</literal></term> + <listitem> + <para>flush right</para> + </listitem> + </varlistentry> + </variablelist> + <para><indexterm role="fn"><primary>\\ (for <literal>array</literal>)</primary></indexterm>Column entries are separated by <literal>&</literal>. Column entries may include +other &latex; commands. Each row of the array is terminated with +<literal>\\</literal>.</para> + <para><indexterm role="fn"><primary>@{...}</primary></indexterm>In the template, the construct <literal>@{<replaceable>text</replaceable>}</literal> puts <replaceable>text</replaceable> +between columns in each row.</para> + <para>Here's an example:</para> + <screen> +\begin{equation} + \begin{array}{lrc} + left1 & right1 & centered1 \\ + left2 & right2 & centered2 \\ + \end{array} +\end{equation} +</screen> + <para><indexterm role="fn"><primary>\arraycolsep</primary></indexterm>The <literal>\arraycolsep</literal> parameter defines half the width of the space +separating columns; the default is ‘<literal>5pt</literal>’. See <xref linkend="tabular"></xref>, for other +parameters which affect formatting in <literal>array</literal> environments, +namely <literal>\arrayrulewidth</literal> and <literal>\arraystretch</literal>.</para> + <para>The <literal>array</literal> environment can only be used in math mode.</para> + </sect1> + + <sect1 label="8.3" id="center"> + <title><literal>center</literal></title> + <para><indexterm role="fn"><primary>center environment</primary></indexterm><indexterm role="cp"><primary>centering text, environment for</primary></indexterm> +Synopsis:</para> + <screen> +\begin{center} +<replaceable>line1</replaceable> \\ +<replaceable>line2</replaceable> \\ +\end{center} +</screen> + <para><indexterm role="fn"><primary>\\ (for <literal>center</literal>)</primary></indexterm>The <literal>center</literal> environment allows you to create a paragraph +consisting of lines that are centered within the left and right +margins on the current page. Each line is terminated with the +string <literal>\\</literal>.</para> + + <sect2 label="8.3.1" id="\centering"> + <title><literal>\centering</literal></title> + <para><indexterm role="fn"><primary>\centering</primary></indexterm><indexterm role="cp"><primary>centering text, declaration for</primary></indexterm> +The <literal>\centering</literal> declaration corresponds to the <literal>center</literal> +environment. This declaration can be used inside an environment such +as <literal>quote</literal> or in a <literal>parbox</literal>. Thus, the text of a figure or +table can be centered on the page by putting a <literal>\centering</literal> +command at the beginning of the figure or table environment.</para> + <para>Unlike the <literal>center</literal> environment, the <literal>\centering</literal> command +does not start a new paragraph; it simply changes how &latex; formats +paragraph units. To affect a paragraph unit's format, the scope of +the declaration must contain the blank line or <literal>\end</literal> command (of +an environment such as quote) that ends the paragraph unit.</para> + <para>Here's an example:</para> + <screen> +\begin{quote} +\centering +first line \\ +second line \\ +\end{quote} +</screen> + </sect2> + </sect1> + + <sect1 label="8.4" id="description"> + <title><literal>description</literal></title> + <para><indexterm role="fn"><primary>description environment</primary></indexterm><indexterm role="cp"><primary>labelled lists, creating</primary></indexterm><indexterm role="cp"><primary>description lists, creating</primary></indexterm> +Synopsis:</para> + <screen> +\begin{description} +\item [<replaceable>label1</replaceable>] <replaceable>item1</replaceable> +\item [<replaceable>label2</replaceable>] <replaceable>item2</replaceable> +... +\end{description} +</screen> + <para><indexterm role="fn"><primary>\item</primary></indexterm>The <literal>description</literal> environment is used to make labelled lists. Each +<replaceable>label</replaceable> is typeset in bold, flush right. The <replaceable>item</replaceable> text may +contain multiple paragraphs.</para> + <para><indexterm role="cp"><primary>bold typewriter, avoiding</primary></indexterm><indexterm role="cp"><primary>typewriter labels in lists</primary></indexterm>Another variation: since the bold style is applied to the labels, if +you typeset a label in typewriter using <literal>\texttt</literal>, you'll get +bold typewriter: <literal>\item[\texttt{bold and typewriter}]</literal>. This +may be too bold, among other issues. To get just typewriter, use +<literal>\tt</literal>, which resets all other style variations: <literal>\item[{\tt +plain typewriter}]</literal>.</para> + <para>For details about list spacing, see <xref linkend="itemize"></xref>.</para> + </sect1> + + <sect1 label="8.5" id="displaymath"> + <title><literal>displaymath</literal></title> + <para><indexterm role="fn"><primary>displaymath environment</primary></indexterm> +Synopsis:</para> + <screen> +\begin{displaymath} +<replaceable>math</replaceable> +\end{displaymath} +</screen> + <para role="continues">or</para> + <screen> +\[<replaceable>math</replaceable>\] +</screen> + <para>The <literal>displaymath</literal> environment (<literal>\[...\]</literal> is a synonym) +typesets the <replaceable>math</replaceable> text on its own line, centered by default. +The global <literal>fleqn</literal> option makes equations flush left; see +<xref linkend="Document-class-options"></xref>.</para> + <para>No equation number is added to <literal>displaymath</literal> text; to get an +equation number, use the <literal>equation</literal> environment (see <xref linkend="equation"></xref>).</para> + </sect1> + + <sect1 label="8.6" id="document"> + <title><literal>document</literal></title> + <para><indexterm role="fn"><primary>document environment</primary></indexterm> +The <literal>document</literal> environment encloses the body of a document. +It is required in every &latex; document. See <xref linkend="Starting-&-ending"></xref>.</para> + </sect1> + + <sect1 label="8.7" id="enumerate"> + <title><literal>enumerate</literal></title> + <para><indexterm role="fn"><primary>enumerate environment</primary></indexterm><indexterm role="cp"><primary>lists of items, numbered</primary></indexterm> +Synopsis:</para> + <screen> +\begin{enumerate} +\item <replaceable>item1</replaceable> +\item <replaceable>item2</replaceable> +... +\end{enumerate} +</screen> + <para>The <literal>enumerate</literal> environment produces a numbered list. Enumerations +can be nested within one another, up to four levels deep. They can also +be nested within other paragraph-making environments, such as +<literal>itemize</literal> (see <xref linkend="itemize"></xref>) and <literal>description</literal> +(see <xref linkend="description"></xref>).</para> + <para><indexterm role="fn"><primary>\item</primary></indexterm>Each item of an enumerated list begins with an <literal>\item</literal> command. +There must be at least one <literal>\item</literal> command within the environment.</para> + <para>By default, the numbering at each level is done like this:</para> + <orderedlist numeration="arabic"> + <listitem> + <para>1., 2., …</para> + </listitem> + <listitem> + <para>(a), (b), …</para> + </listitem> + <listitem> + <para>i., ii., …</para> + </listitem> + <listitem> + <para>A., B., …</para> + </listitem> + </orderedlist> + <para><indexterm role="fn"><primary>\enumi</primary></indexterm><indexterm role="fn"><primary>\enumii</primary></indexterm><indexterm role="fn"><primary>\enumiii</primary></indexterm><indexterm role="fn"><primary>\enumiv</primary></indexterm>The <literal>enumerate</literal> environment uses the counters <literal>\enumi</literal> +through <literal>\enumiv</literal> counters (see <xref linkend="Counters"></xref>). If the optional +argument to <literal>\item</literal> is given, the counter is not incremented for +that item.</para> + <para><indexterm role="fn"><primary>\labelenumi</primary></indexterm><indexterm role="fn"><primary>\labelenumii</primary></indexterm><indexterm role="fn"><primary>\labelenumiii</primary></indexterm><indexterm role="fn"><primary>\labelenumiv</primary></indexterm>The <literal>enumerate</literal> environment uses the commands <literal>\labelenumi</literal> +through <literal>\labelenumiv</literal> to produce the default label. So, you can +use <literal>\renewcommand</literal> to change the labels (see <xref linkend="\newcommand-&-\renewcommand"></xref>). For instance, to have the first level use uppercase +letters:</para> + <para><indexterm role="fn"><primary>\Alph example</primary></indexterm></para> + <screen> +\renewcommand{\labelenumi}{\Alph{enumi}} +</screen> + </sect1> + + <sect1 label="8.8" id="eqnarray"> + <title><literal>eqnarray</literal></title> + <para><indexterm role="fn"><primary>eqnarray environment</primary></indexterm><indexterm role="cp"><primary>equations, aligning</primary></indexterm><indexterm role="cp"><primary>aligning Equations</primary></indexterm></para> + <screen> +\begin{eqnarray} <lineannotation>(or <literal>eqnarray*</literal>)</lineannotation> +<replaceable>formula1</replaceable> \\ +<replaceable>formula2</replaceable> \\ +... +\end{eqnarray} +</screen> + <para><indexterm role="fn"><primary>\\ (for <literal>eqnarray</literal>)</primary></indexterm>The <literal>eqnarray</literal> environment is used to display a sequence of +equations or inequalities. It is very much like a three-column +<literal>array</literal> environment, with consecutive rows separated by <literal>\\</literal> +and consecutive items within a row separated by an <literal>&</literal>.</para> + <para><indexterm role="fn"><primary>\\* (for <literal>eqnarray</literal>)</primary></indexterm><literal>\\*</literal> can also be used to separate equations, with its normal +meaning of not allowing a page break at that line.</para> + <para><indexterm role="fn"><primary>\nonumber</primary></indexterm><indexterm role="cp"><primary>equation numbers, omitting</primary></indexterm>An equation number is placed on every line unless that line has a +<literal>\nonumber</literal> command. Alternatively, The <literal>*</literal>-form of the +environment (<literal>\begin{eqnarray*} ... \end{eqnarray*}</literal>) will +omit equation numbering entirely, while otherwise being the same as +<literal>eqnarray</literal>.</para> + <para><indexterm role="fn"><primary>\lefteqn</primary></indexterm>The command <literal>\lefteqn</literal> is used for splitting long formulas across +lines. It typesets its argument in display style flush left in a box of +zero width.</para> + </sect1> + + <sect1 label="8.9" id="equation"> + <title><literal>equation</literal></title> + <para><indexterm role="fn"><primary>equation environment</primary></indexterm><indexterm role="cp"><primary>equations, environment for</primary></indexterm><indexterm role="cp"><primary>formulas, environment for</primary></indexterm> +Synopsis:</para> + <screen> +\begin{equation} +<replaceable>math</replaceable> +\end{equation} +</screen> + <para>The <literal>equation</literal> environment starts a <literal>displaymath</literal> +environment (see <xref linkend="displaymath"></xref>), e.g., centering the <replaceable>math</replaceable> text +on the page, and also places an equation number in the right margin.</para> + </sect1> + + <sect1 label="8.10" id="figure"> + <title><literal>figure</literal></title> + <para><indexterm role="fn"><primary>figure</primary></indexterm><indexterm role="cp"><primary>inserting figures</primary></indexterm><indexterm role="cp"><primary>figures, inserting</primary></indexterm></para> + <screen> +\begin{figure}[<replaceable>placement</replaceable>] +<replaceable>figbody</replaceable> +\label{<replaceable>label}</replaceable> +\caption[<replaceable>loftitle</replaceable>]{<replaceable>text</replaceable>} +\end{figure} +</screen> + <para>Figures are objects that are not part of the normal text, and are +instead “floated” to a convenient place, such as the top of a page. +Figures will not be split between two pages.</para> + <para>The optional argument <literal>[placement]</literal> determines where &latex; will try +to place your figure. There are four places where &latex; can possibly +put a float:</para> + <orderedlist numeration="arabic"> + <listitem> + <para><literal>h</literal> (Here) - at the position in the text where the figure +environment appears.</para> + </listitem> + <listitem> + <para><literal>t</literal> (Top) - at the top of a text page.</para> + </listitem> + <listitem> + <para><literal>b</literal> (Bottom) - at the bottom of a text page.</para> + </listitem> + <listitem> + <para><literal>p</literal> (Page of floats) - on a separate float page, which is a page +containing no text, only floats.</para> + </listitem> + </orderedlist> + <para>The standard report and article classes use the default placement +<literal>tbp</literal>.</para> + <para>The body of the figure is made up of whatever text, &latex; commands, etc. +you wish.</para> + <para><indexterm role="fn"><primary>\caption</primary></indexterm>The <literal>\caption</literal> command specifies caption <replaceable>text</replaceable> for the +figure. The caption is numbered by default. If <replaceable>loftitle</replaceable> is +present, it is used in the list of figures instead of <replaceable>text</replaceable> +(see <xref linkend="Tables-of-contents"></xref>).</para> +<!-- xx float-placement, float-caption sections? --> + <variablelist> + <title><indexterm role="fn"><primary>\bottomfraction</primary></indexterm>The maximum fraction of the page allowed to be occuped by floats atthe bottom; default ‘<literal>.3</literal>’.</title> + <varlistentry> + <term><literal>\floatpagefraction</literal></term> + <listitem> + <para>The minimum fraction of a float page that must be occupied by floats; +default ‘<literal>.5</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\floatsep</literal></term> + <listitem> + <para>Space between floats at the top or bottom of a page; default +‘<literal>12pt plus2pt minus2pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\intextsep</literal></term> + <listitem> + <para>Space above and below a float in the middle of the main text; default +‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and ‘<literal>11pt</literal>’ styles, +‘<literal>14pt plus4pt minus4pt</literal>’ for ‘<literal>12pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textfloatsep</literal></term> + <listitem> + <para>Space between the last (first) float at the top (bottom) of a page; +default ‘<literal>20pt plus2pt minus4pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\textfraction</literal></term> + <listitem> + <para>Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is ‘<literal>.2</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\topfraction</literal></term> + <listitem> + <para>Maximum fraction at the top of a page that may be occupied before +floats; default is ‘<literal>.7</literal>’.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="8.11" id="flushleft"> + <title><literal>flushleft</literal></title> + <para><indexterm role="fn"><primary>flushleft environment</primary></indexterm><indexterm role="cp"><primary>left-justifying text, environment for</primary></indexterm><indexterm role="cp"><primary>ragged right text, environment for</primary></indexterm></para> + <screen> +\begin{flushleft} +<replaceable>line1</replaceable> \\ +<replaceable>line2</replaceable> \\ +... +\end{flushleft} +</screen> + <para><indexterm role="fn"><primary>\\ for <literal>flushleft</literal></primary></indexterm>The <literal>flushleft</literal> environment allows you to create a paragraph +consisting of lines that are flush to the left-hand margin and ragged +right Each line must be terminated with the string <literal>\\</literal>.</para> + + <sect2 label="8.11.1" id="\raggedright"> + <title><literal>\raggedright</literal></title> + <para><indexterm role="fn"><primary>\raggedright</primary></indexterm><indexterm role="cp"><primary>ragged right text</primary></indexterm><indexterm role="cp"><primary>left-justifying text</primary></indexterm><indexterm role="cp"><primary>justification, ragged right</primary></indexterm> +The <literal>\raggedright</literal> declaration corresponds to the +<literal>flushleft</literal> environment. This declaration can be used inside an +environment such as <literal>quote</literal> or in a <literal>parbox</literal>.</para> + <para>Unlike the <literal>flushleft</literal> environment, the <literal>\raggedright</literal> +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 <literal>\end</literal> +command that ends the paragraph unit.</para> + </sect2> + </sect1> + + <sect1 label="8.12" id="flushright"> + <title><literal>flushright</literal></title> + <para><indexterm role="fn"><primary>flushright environment</primary></indexterm><indexterm role="cp"><primary>ragged left text, environment for</primary></indexterm><indexterm role="cp"><primary>right-justifying text, environment for</primary></indexterm></para> + <screen> +\begin{flushright} +<replaceable>line1</replaceable> \\ +<replaceable>line2</replaceable> \\ +... +\end{flushright} +</screen> + <para><indexterm role="fn"><primary>\\ (for <literal>flushright</literal>)</primary></indexterm>The <literal>flushright</literal> environment allows you to create a paragraph +consisting of lines that are flush to the right-hand margin and ragged +left. Each line must be terminated with the string <literal>\\</literal>.</para> + + <sect2 label="8.12.1" id="\raggedleft"> + <title><literal>\raggedleft</literal></title> + <para><indexterm role="fn"><primary>\raggedleft</primary></indexterm><indexterm role="cp"><primary>ragged left text</primary></indexterm><indexterm role="cp"><primary>justification, ragged left</primary></indexterm><indexterm role="cp"><primary>right-justifying text</primary></indexterm> +The <literal>\raggedleft</literal> declaration corresponds to the +<literal>flushright</literal> environment. This declaration can be used inside an +environment such as <literal>quote</literal> or in a <literal>parbox</literal>.</para> + <para>Unlike the <literal>flushright</literal> environment, the <literal>\raggedleft</literal> +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 <literal>\end</literal> +command that ends the paragraph unit.</para> + </sect2> + </sect1> + + <sect1 label="8.13" id="itemize"> + <title><literal>itemize</literal></title> + <para><indexterm role="fn"><primary>itemize environment</primary></indexterm><indexterm role="fn"><primary>\item</primary></indexterm><indexterm role="cp"><primary>lists of items</primary></indexterm><indexterm role="cp"><primary>unordered lists</primary></indexterm><indexterm role="cp"><primary>bulleted lists</primary></indexterm> +Synopsis:</para> + <screen> +\begin{itemize} +\item <replaceable>item1</replaceable> +\item <replaceable>item2</replaceable> +... +\end{itemize} +</screen> + <para>The <literal>itemize</literal> 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 <literal>enumerate</literal> (see <xref linkend="enumerate"></xref>).</para> + <para>Each item of an <literal>itemize</literal> list begins with an <literal>\item</literal> command. +There must be at least one <literal>\item</literal> command within the environment.</para> + <para>By default, the marks at each level look like this:</para> + <orderedlist numeration="arabic"> + <listitem> + <para>•</para> + </listitem> + <listitem> + <para><emphasis role="bold">--<!-- /@w --></emphasis> (bold en-dash)</para> + </listitem> + <listitem> + <para>*</para> + </listitem> + <listitem> + <para>. (centered dot, rendered here as a period)</para> + </listitem> + </orderedlist> + <para><indexterm role="fn"><primary>\labelitemi</primary></indexterm><indexterm role="fn"><primary>\labelitemii</primary></indexterm><indexterm role="fn"><primary>\labelitemiii</primary></indexterm><indexterm role="fn"><primary>\labelitemiv</primary></indexterm>The <literal>itemize</literal> environment uses the commands <literal>\labelitemi</literal> +through <literal>\labelitemiv</literal> to produce the default label. So, you can +use <literal>\renewcommand</literal> to change the labels. For instance, to have +the first level use diamonds:</para> + <screen> +\renewcommand{\labelitemi}{$\diamond$} +</screen> + <para><indexterm role="fn"><primary>\leftmargin</primary></indexterm><indexterm role="fn"><primary>\leftmargini</primary></indexterm><indexterm role="fn"><primary>\leftmarginii</primary></indexterm><indexterm role="fn"><primary>\leftmarginiii</primary></indexterm><indexterm role="fn"><primary>\leftmarginiv</primary></indexterm><indexterm role="fn"><primary>\leftmarginv</primary></indexterm><indexterm role="fn"><primary>\leftmarginvi</primary></indexterm>The <literal>\leftmargini</literal> through <literal>\leftmarginvi</literal> parameters define +the distance between the left margin of the enclosing environment and +the left margin of the list. By convention, <literal>\leftmargin</literal> is set +to the appropriate <literal>\leftmargin<replaceable>N</replaceable></literal> when a new level of +nesting is entered.</para> + <para>The defaults vary from ‘<literal>.5em</literal>’ (highest levels of nesting) to +‘<literal>2.5em</literal>’ (first level), and are a bit reduced in two-column mode. +This example greatly reduces the margin space for outermost lists:</para> + <screen> +\setlength{\leftmargini}{1.25em} % default 2.5em +</screen> +<!-- xx should be in its own generic section --> + <para>Some parameters that affect list formatting:</para> + <variablelist> + <varlistentry> + <term><literal>\itemindent</literal></term> + <listitem> + <para>Extra indentation before each item in a list; default zero.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\labelsep</literal></term> + <listitem> + <para>Space between the label and text of an item; default ‘<literal>.5em</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\labelwidth</literal></term> + <listitem> + <para>Width of the label; default ‘<literal>2em</literal>’, or ‘<literal>1.5em</literal>’ in two-column mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\listparindent</literal></term> + <listitem> + <para>Extra indentation added to second and subsequent paragraphs within a +list item; default ‘<literal>0pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rightmargin</literal></term> + <listitem> + <para>Horizontal distance between the right margin of the list and the +enclosing environment; default ‘<literal>0pt</literal>’, except in the <literal>quote</literal>, +<literal>quotation</literal>, and <literal>verse</literal> environments, where it is set equal +to <literal>\leftmargin</literal>.</para> + </listitem> + </varlistentry> + </variablelist> + <para>Parameters affecting vertical spacing between list items (rather +loose, by default).</para> + <variablelist> + <varlistentry> + <term><literal>\itemsep</literal></term> + <listitem> + <para>Vertical space between items. The default is <literal>2pt plus1pt +minus1pt</literal> for <literal>10pt</literal> documents, <literal>3pt plus2pt minus1pt</literal> for +<literal>11pt</literal>, and <literal>4.5pt plus2pt minus1pt</literal> for <literal>12pt</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\parsep</literal></term> + <listitem> + <para>Extra vertical space between paragraphs within a list item. Defaults +are the same as <literal>\itemsep</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\topsep</literal></term> + <listitem> + <para>Vertical space between the first item and the preceding paragraph. +The default is <literal>4pt plus2pt minus2pt</literal> for <literal>10pt</literal> documents, +<literal>6pt plus2pt minus2pt</literal> for <literal>11pt</literal>, and <literal>9pt plus3pt +minus5pt</literal> for <literal>12pt</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\partopsep</literal></term> + <listitem> + <para>Extra space added to <literal>\topsep</literal> when the list environment starts a +paragraph. The default is <literal>2pt plus1pt minus1pt</literal> for <literal>10pt</literal> +documents, <literal>3pt plus1pt minus1pt</literal> for <literal>11pt</literal>, and <literal>3pt +plus2pt minus2pt</literal> for <literal>12pt</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\topsep</literal></term> + <listitem> + <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 ‘<literal>10pt</literal>’, it is ‘<literal>4pt +plus2pt minus2pt</literal>’.</para> + </listitem> + </varlistentry> + </variablelist> + <para><indexterm role="fn"><primary>\parskip example</primary></indexterm>Especially for lists with short items, it may be desirable to elide +space between items. Here is an example defining an <literal>itemize*</literal> +environment with no extra spacing between items, or between paragraphs +within a single item (<literal>\parskip</literal> is not list-specific, +see <xref linkend="\parskip"></xref>):</para> + <screen> +\newenvironment{itemize*}% + {\begin{itemize}% + \setlength{\itemsep}{0pt}% + \setlength{\parsep}{0pt}}% + \setlength{\parskip}{0pt}}% + {\end{itemize}} +</screen> + </sect1> + + <sect1 label="8.14" id="letter"> + <title><literal>letter</literal> environment: writing letters</title> + <para><indexterm role="fn"><primary>letter</primary></indexterm> +This environment is used for creating letters. See <xref linkend="Letters"></xref>.</para> + </sect1> + + <sect1 label="8.15" id="list"> + <title><literal>list</literal></title> + <para><indexterm role="fn"><primary>list</primary></indexterm><indexterm role="cp"><primary>lists of items, generic</primary></indexterm> +The <literal>list</literal> 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> + <screen> +\begin{list}{<replaceable>labeling</replaceable>}{<replaceable>spacing</replaceable>} +\item <replaceable>item1</replaceable> +\item <replaceable>item2</replaceable> +... +\end{list} +</screen> + <para>The mandatory <replaceable>labeling</replaceable> argument specifies how items should be +labelled (unless the optional argument is supplied to <literal>\item</literal>). +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 <replaceable>spacing</replaceable> argument contains commands to change the +spacing parameters for the list. This argument will most often be +empty, i.e., <literal>{}</literal>, which leaves the default spacing.</para> + </sect1> + + <sect1 label="8.16" id="math"> + <title><literal>math</literal></title> + <para><indexterm role="fn"><primary>math environment</primary></indexterm><indexterm role="cp"><primary>in-line formulas</primary></indexterm> +Synopsis:</para> + <screen> +\begin{math} +<replaceable>math</replaceable> +\end{math} +</screen> + <para>The <literal>math</literal> environment inserts the given <replaceable>math</replaceable> within the +running text. <literal>\(...\))</literal> and <literal>$...$</literal> are synonyms. +See <xref linkend="Math-formulas"></xref>.</para> + </sect1> + + <sect1 label="8.17" id="minipage"> + <title><literal>minipage</literal></title> + <para><indexterm role="fn"><primary>minipage environment</primary></indexterm><indexterm role="cp"><primary>minipage, creating a</primary></indexterm></para> + <screen> +\begin{minipage}[<replaceable>position</replaceable>]{<replaceable>width</replaceable>} +<replaceable>text</replaceable> +\end{minipage} +</screen> + <para>The <literal>minipage</literal> environment typesets its body <replaceable>text</replaceable> in a +block that will not be broken across pages (similar to the +<literal>\parbox</literal> command, see <xref linkend="\parbox"></xref>). You may use other +paragraph-making environments inside a minipage (unlike <literal>\parbox</literal>).</para> +<!-- (xxref positions) --> + <para>It takes an optional <replaceable>position</replaceable> argument for placing <replaceable>text</replaceable>, +and a mandatory <replaceable>width</replaceable> argument for specifying the line width.</para> + <para><indexterm role="cp"><primary>indentation of paragraphs, in minipage</primary></indexterm><indexterm role="cp"><primary>paragraph indentation, in minipage</primary></indexterm><indexterm role="fn"><primary>\parindent</primary></indexterm>By default, paragraphs are not indented in the <literal>minipage</literal> +environment. You can restore indentation with a command such as +<literal>\setlength{\parindent}{1pc}</literal> command.</para> + <para><indexterm role="cp"><primary>footnotes in figures</primary></indexterm><indexterm role="cp"><primary>figures, footnotes in</primary></indexterm>Footnotes in a <literal>minipage</literal> environment are handled in a way that is +particularly useful for putting footnotes in figures or tables. A +<literal>\footnote</literal> or <literal>\footnotetext</literal> command puts the footnote at +the bottom of the minipage instead of at the bottom of the page, and it +uses the <literal>\mpfootnote</literal> counter instead of the ordinary +<literal>footnote</literal> counter (see <xref linkend="Counters"></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> + </sect1> + + <sect1 label="8.18" id="picture"> + <title><literal>picture</literal></title> + <para><indexterm role="fn"><primary>picture</primary></indexterm><indexterm role="cp"><primary>creating pictures</primary></indexterm><indexterm role="cp"><primary>pictures, creating</primary></indexterm></para> + <screen> +\begin{picture}(width,height)(x offset,y offset) +… <replaceable>picture commands</replaceable> … +\end{picture} +</screen> + <para><indexterm role="fn"><primary>\unitlength</primary></indexterm>The <literal>picture</literal> 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 <literal>5</literal>, <literal>0.3</literal> or +<literal>-3.1416</literal>. A coordinate specifies a length in multiples of the +unit length <literal>\unitlength</literal>, so if <literal>\unitlength</literal> has been set +to <literal>1cm</literal>, then the coordinate 2.54 specifies a length of 2.54 +centimeters. You should only change the value of <literal>\unitlength</literal>, +using the <literal>\setlength</literal> command, outside of a <literal>picture</literal> +environment.</para> + <para>A position is a pair of coordinates, such as <literal>(2.4,-5)</literal>, specifying +the point with x-coordinate <literal>2.4</literal> and y-coordinate <literal>-5</literal>. +Coordinates are specified in the usual way with respect to an origin, +which is normally at the lower-left corner of the picture. Note that +when a position appears as an argument, it is not enclosed in braces; +the parentheses serve to delimit the argument.</para> + <para>The <literal>picture</literal> environment has one mandatory argument, which is a +<literal>position</literal>. It specifies the size of the picture. The environment +produces a rectangular box with width and height determined by this +argument's x- and y-coordinates.</para> + <para>The <literal>picture</literal> environment also has an optional <literal>position</literal> +argument, following the <literal>size</literal> argument, that can change the +origin. (Unlike ordinary optional arguments, this argument is not +contained in square brackets.) The optional argument gives the +coordinates of the point at the lower-left corner of the picture +(thereby determining the origin). For example, if <literal>\unitlength</literal> +has been set to <literal>1mm</literal>, the command</para> + <screen> + \begin{picture}(100,200)(10,20) +</screen> + <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 <literal>\put</literal> +command. The command</para> + <screen> +\put (11.3,-.3){...} +</screen> + <para role="continues">puts the object specified by <literal>...</literal> in the +picture, with its reference point at coordinates (11.3,-.3). +The reference points for various objects will be described below.</para> + <para><indexterm role="fn"><primary>lR box</primary></indexterm>The <literal>\put</literal> command creates an <firstterm>LR box</firstterm>. You can put anything +that can go in an <literal>\mbox</literal> (see <xref linkend="\mbox"></xref>) in the text argument of +the <literal>\put</literal> command. When you do this, the reference point will +be the lower left corner of the box.</para> + <para>The <literal>picture</literal> commands are described in the following sections.</para> + + <sect2 label="8.18.1" id="\circle"> + <title><literal>\circle</literal></title> + <para><indexterm role="fn"><primary>\circle</primary></indexterm></para> + <screen> +\circle[*]{<replaceable>diameter</replaceable>} +</screen> + <para>The <literal>\circle</literal> command produces a circle with a diameter as close +to the specified one as possible. The <literal>*</literal>-form of the command +draws a solid circle.</para> + <para>Circles up to 40 pt can be drawn.</para> + </sect2> + + <sect2 label="8.18.2" id="\makebox-(picture)"> + <title><literal>\makebox</literal></title> + <para><indexterm role="fn"><primary>\makebox (picture)</primary></indexterm> +<literal>\makebox(width,height)[position]{...}</literal></para> + <para>The <literal>\makebox</literal> command for the picture environment is similar to +the normal <literal>\makebox</literal> command except that you must specify a +<literal>width</literal> and <literal>height</literal> in multiples of <literal>\unitlength</literal>.</para> + <para>The optional argument, <literal>[position]</literal>, specifies the quadrant that +your text appears in. You may select up to two of the following:</para> + <itemizedlist mark="bullet"> + <listitem> + <para><literal>t</literal> - Moves the item to the top of the rectangle</para> + </listitem> + <listitem> + <para><literal>b</literal> - Moves the item to the bottom</para> + </listitem> + <listitem> + <para><literal>l</literal> - Moves the item to the left</para> + </listitem> + <listitem> + <para><literal>r</literal> - Moves the item to the right</para> + </listitem> + </itemizedlist> + <para>See <xref linkend="\makebox"></xref>.</para> + </sect2> + + <sect2 label="8.18.3" id="\framebox-(picture)"> + <title><literal>\framebox</literal></title> + <para><indexterm role="fn"><primary>\framebox</primary></indexterm> +Synopsis:</para> + <screen> +\framebox(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>pos</replaceable>]{...} +</screen> + <para>The <literal>\framebox</literal> command is like <literal>\makebox</literal> (see previous +section), except that it puts a frame around the outside of the box +that it creates.</para> + <para><indexterm role="fn"><primary>\fboxrule</primary></indexterm><indexterm role="fn"><primary>\fboxsep</primary></indexterm>The <literal>\framebox</literal> command produces a rule of thickness +<literal>\fboxrule</literal>, and leaves a space <literal>\fboxsep</literal> between the rule +and the contents of the box.</para> + </sect2> + + <sect2 label="8.18.4" id="\dashbox"> + <title><literal>\dashbox</literal></title> + <para><indexterm role="fn"><primary>\dashbox</primary></indexterm> +Draws a box with a dashed line. Synopsis:</para> + <screen> +\dashbox{<replaceable>dlen</replaceable>}(<replaceable>rwidth</replaceable>,<replaceable>rheight</replaceable>)[<replaceable>pos</replaceable>]{<replaceable>text</replaceable>} +</screen> + <para><literal>\dashbox</literal> creates a dashed rectangle around <replaceable>text</replaceable> in a +<literal>picture</literal> environment. Dashes are <replaceable>dlen</replaceable> units long, and the +rectangle has overall width <replaceable>rwidth</replaceable> and height <replaceable>rheight</replaceable>. +The <replaceable>text</replaceable> is positioned at optional <replaceable>pos</replaceable>. +<!-- xxref positions. --> +A dashed box looks best when the <literal>rwidth</literal> and <literal>rheight</literal> are +multiples of the <literal>dlen</literal>.</para> + </sect2> + + <sect2 label="8.18.5" id="\frame"> + <title><literal>\frame</literal></title> + <para><indexterm role="fn"><primary>\frame</primary></indexterm> +Synopsis:</para> + <screen> +\frame{<replaceable>text</replaceable>} +</screen> + <para>The <literal>\frame</literal> command puts a rectangular frame around <replaceable>text</replaceable>. +The reference point is the bottom left corner of the frame. No extra +space is put between the frame and the object.</para> + </sect2> + + <sect2 label="8.18.6" id="\line"> + <title><literal>\line</literal></title> + <para><indexterm role="fn"><primary>\line</primary></indexterm> +Synopsis:</para> + <screen> +\line(<replaceable>xslope</replaceable>,<replaceable>yslope</replaceable>){<replaceable>length</replaceable>} +</screen> + <para>The <literal>\line</literal> command draws a line with the given <replaceable>length</replaceable> and +slope <replaceable>xslope</replaceable>/<replaceable>yslope</replaceable>.</para> + <para>Standard &latex; can only draw lines with <replaceable>slope</replaceable> = x/y, +where x and y have integer values from −6 +through 6. For lines of any slope, not to mention other shapes, +see the <literal>curve2e</literal> and many many other packages on CTAN.</para> + </sect2> + + <sect2 label="8.18.7" id="\linethickness"> + <title><literal>\linethickness</literal></title> + <para><indexterm role="fn"><primary>\linethickness</primary></indexterm> +The <literal>\linethickness{<replaceable>dim</replaceable>}</literal> command declares the thickness +of horizontal and vertical lines in a picture environment to be +<replaceable>dim</replaceable>, which must be a positive length.</para> + <para><literal>\linethickness</literal> does not affect the thickness of slanted lines, +circles, or the quarter circles drawn by <literal>\oval</literal>.</para> + </sect2> + + <sect2 label="8.18.8" id="\thicklines"> + <title><literal>\thicklines</literal></title> + <para><indexterm role="fn"><primary>\thicklines</primary></indexterm> +The <literal>\thicklines</literal> command is an alternate line thickness for +horizontal and vertical lines in a picture environment; +cf. <xref linkend="\linethickness"></xref> and <xref linkend="\thinlines"></xref>.</para> + </sect2> + + <sect2 label="8.18.9" id="\thinlines"> + <title><literal>\thinlines</literal></title> + <para><indexterm role="fn"><primary>\thinlines</primary></indexterm> +The <literal>\thinlines</literal> command is the default line thickness for +horizontal and vertical lines in a picture environment; +cf. <xref linkend="\linethickness"></xref> and <xref linkend="\thicklines"></xref>.</para> + </sect2> + + <sect2 label="8.18.10" id="\multiput"> + <title><literal>\multiput</literal></title> + <para><indexterm role="fn"><primary>\multiput</primary></indexterm> +Synopsis:</para> + <screen> +\multiput(<replaceable>x</replaceable>,<replaceable>y</replaceable>)(<replaceable>delta_x</replaceable>,<replaceable>delta_y</replaceable>){<replaceable>n</replaceable>}{<replaceable>obj</replaceable>} +</screen> + <para>The <literal>\multiput</literal> command copies the object <replaceable>obj</replaceable> in a regular +pattern across a picture. <replaceable>obj</replaceable> is first placed at position +(x,y), then at (x+\delta x,y+\delta y), and so on, +<replaceable>n</replaceable> times.</para> + </sect2> + + <sect2 label="8.18.11" id="\oval"> + <title><literal>\oval</literal></title> + <para><indexterm role="fn"><primary>\oval</primary></indexterm> +Synopsis:</para> + <screen> +\oval(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>portion</replaceable>] +</screen> + <para>The <literal>\oval</literal> command produces a rectangle with rounded corners. +The optional argument <replaceable>portion</replaceable> allows you to select part of the +oval via the following:</para> + <variablelist> + <varlistentry> + <term><literal>t</literal></term> + <listitem> + <para>selects the top portion;</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>b</literal></term> + <listitem> + <para>selects the bottom portion;</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>r</literal></term> + <listitem> + <para>selects the right portion;</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>l</literal></term> + <listitem> + <para>selects the left portion.</para> + </listitem> + </varlistentry> + </variablelist> + <para>The “corners” of the oval are made with quarter circles with a +maximum radius of 20pt, so large “ovals” will look more like +boxes with rounded corners.</para> + </sect2> + + <sect2 label="8.18.12" id="\put"> + <title><literal>\put</literal></title> + <para><indexterm role="fn"><primary>\put</primary></indexterm> +<literal>\put(x coord,y coord){ ... }</literal></para> + <para>The <literal>\put</literal> command places the item specified by the mandatory +argument at the given coordinates.</para> + </sect2> + + <sect2 label="8.18.13" id="\shortstack"> + <title><literal>\shortstack</literal></title> + <para><indexterm role="fn"><primary>\shortstack</primary></indexterm> +Synopsis:</para> + <screen> +\shortstack[<replaceable>position</replaceable>]{...\\...\\...} +</screen> + <para>The <literal>\shortstack</literal> command produces a stack of objects. The valid +positions are:</para> + <variablelist> + <varlistentry> + <term><literal>r</literal></term> + <listitem> + <para>Move the objects to the right of the stack.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>l</literal></term> + <listitem> + <para>Move the objects to the left of the stack</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>c</literal></term> + <listitem> + <para>Move the objects to the centre of the stack (default)</para> + </listitem> + </varlistentry> + </variablelist> + <para><indexterm role="fn"><primary>\\ (for <literal>\shortstack</literal> objects)</primary></indexterm>Objects are separated with <literal>\\</literal>.</para> + </sect2> + + <sect2 label="8.18.14" id="\vector"> + <title><literal>\vector</literal></title> + <para><indexterm role="fn"><primary>\vector</primary></indexterm> +Synopsis:</para> + <screen> +\vector(<replaceable>x-slope</replaceable>,<replaceable>y-slope</replaceable>){<replaceable>length</replaceable>} +</screen> + <para>The <literal>\vector</literal> command draws a line with an arrow of the specified +length and slope. The x and y values must lie between +−4 and +4, inclusive.</para> + </sect2> + </sect1> + + <sect1 label="8.19" id="quotation"> + <title><literal>quotation</literal></title> + <para><indexterm role="fn"><primary>quotation</primary></indexterm><indexterm role="cp"><primary>quoted text with paragraph indentation, displaying</primary></indexterm><indexterm role="cp"><primary>displaying quoted text with paragraph indentation</primary></indexterm><indexterm role="cp"><primary>paragraph indentations in quoted text</primary></indexterm> +Synopsis:</para> + <screen> +\begin{quotation} +<replaceable>text</replaceable> +\end{quotation} +</screen> + <para>The margins of the <literal>quotation</literal> environment are indented on both +the left and the right. The text is justified at both margins. +Leaving a blank line between text produces a new paragraph.</para> + <para>Unlike the <literal>quote</literal> environment, each paragraph is indented +normally.</para> + </sect1> + + <sect1 label="8.20" id="quote"> + <title><literal>quote</literal></title> + <para><indexterm role="fn"><primary>quote</primary></indexterm><indexterm role="cp"><primary>quoted text without paragraph indentation, displaying</primary></indexterm><indexterm role="cp"><primary>displaying quoted text without paragraph indentation</primary></indexterm><indexterm role="cp"><primary>paragraph indentations in quoted text, omitting</primary></indexterm> +Snyopsis:</para> + <screen> +\begin{quote} +<replaceable>text</replaceable> +\end{quote} +</screen> + <para>The margins of the <literal>quote</literal> environment are indented on both the +left and the right. The text is justified at both margins. Leaving a +blank line between text produces a new paragraph.</para> + <para>Unlike the <literal>quotation</literal> environment, paragraphs are not indented.</para> + </sect1> + + <sect1 label="8.21" id="tabbing"> + <title><literal>tabbing</literal></title> + <para><indexterm role="fn"><primary>tabbing environment</primary></indexterm><indexterm role="cp"><primary>tab stops, using</primary></indexterm><indexterm role="cp"><primary>lining text up in columns using tab stops</primary></indexterm><indexterm role="cp"><primary>alignment via tabbing</primary></indexterm> +Synopsis:</para> + <screen> +\begin{tabbing} +<replaceable>row1col1</replaceable> \= <replaceable>row1col2</replaceable> \= <replaceable>row1col3</replaceable> \= <replaceable>row1col4</replaceable> \\ +<replaceable>row2col1</replaceable> \> \> <replaceable>row2col3</replaceable> \\ +... +\end{tabbing} +</screen> + <para>The <literal>tabbing</literal> 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 <literal>tabular</literal> +environment.</para> + <para>The following commands can be used inside a <literal>tabbing</literal> enviroment:</para> + <variablelist> + <varlistentry> + <term><literal>\\ tabbing</literal></term> + <listitem> + <para>End a line.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\= (tabbing)</literal></term> + <listitem> + <para>Sets a tab stop at the current position.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\> (tabbing)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\></primary></indexterm>Advances to the next tab stop.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\<</literal></term> + <listitem> + <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> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\+</literal></term> + <listitem> + <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> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\-</literal></term> + <listitem> + <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> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\' (tabbing)</literal></term> + <listitem> + <para>Moves everything that you have typed so far in the +current column, i.e. everything from the most recent <literal>\></literal>, +<literal>\<</literal>, <literal>\'</literal>, <literal>\\</literal>, or <literal>\kill</literal> command, to the right +of the previous column, flush against the current column's tab stop.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\` (tabbing)</literal></term> + <listitem> + <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 <literal>\`</literal> command moves all the +text that follows it, up to the <literal>\\</literal> or <literal>\end{tabbing}</literal> +command that ends the line, to the right margin of the tabbing +environment. There must be no <literal>\></literal> or <literal>\'</literal> command between +the <literal>\`</literal> and the command that ends the line.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\a (tabbing)</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\a' (acute accent in tabbing)</primary></indexterm><indexterm role="fn"><primary>\a` (grave accent in tabbing)</primary></indexterm><indexterm role="fn"><primary>\a= (macron accent in tabbing)</primary></indexterm>In a <literal>tabbing</literal> environment, the commands <literal>\=</literal>, <literal>\'</literal> and +<literal>\`</literal> do not produce accents as usual (see <xref linkend="Accents"></xref>). Instead, +the commands <literal>\a=</literal>, <literal>\a'</literal> and <literal>\a`</literal> are used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\kill</literal></term> + <listitem> + <para>Sets tab stops without producing text. Works just like <literal>\\</literal> +except that it throws away the current line instead of producing +output for it. The effect of any <literal>\=</literal>, <literal>\+</literal> or <literal>\-</literal> +commands in that line remain in effect.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\poptabs</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\poptabs</primary></indexterm>Restores the tab stop positions saved by the last <literal>\pushtabs</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\pushtabs</literal></term> + <listitem> + <para>Saves all current tab stop positions. Useful for temporarily changing +tab stop positions in the middle of a <literal>tabbing</literal> environment.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\tabbingsep</literal></term> + <listitem> + <para>Distance to left of tab stop moved by <literal>\'</literal>.</para> + </listitem> + </varlistentry> + </variablelist> + <para>This example typesets a Pascal function in a traditional format:</para> + <screen> +\begin{tabbing} +function \= fact(n : integer) : integer;\\ + \> begin \= \+ \\ + \> if \= n $>$ 1 then \+ \\ + fact := n * fact(n-1) \- \\ + else \+ \\ + fact := 1; \-\- \\ + end;\\ +\end{tabbing} +</screen> + </sect1> + + <sect1 label="8.22" id="table"> + <title><literal>table</literal></title> + <para><indexterm role="fn"><primary>table</primary></indexterm><indexterm role="cp"><primary>tables, creating</primary></indexterm><indexterm role="cp"><primary>creating tables</primary></indexterm> +Synopsis:</para> + <screen> + \begin{table}[placement] + + body of the table + + \caption{table title} + \end{table} +</screen> + <para>Tables are objects that are not part of the normal text, and are +usually “floated” to a convenient place, like the top of a page. +Tables will not be split between two pages.</para> + <para>The optional argument <literal>[placement]</literal> determines where &latex; will try +to place your table. There are four places where &latex; can possibly put +a float:</para> + <itemizedlist mark="bullet"> + <listitem> + <para><literal>h</literal>: Here - at the position in the text where the table +environment appears.</para> + </listitem> + <listitem> + <para><literal>t</literal>: Top - at the top of a text page.</para> + </listitem> + <listitem> + <para><literal>b</literal>: Bottom - at the bottom of a text page.</para> + </listitem> + <listitem> + <para><literal>p</literal>: Page of floats - on a separate float page, which is a page +containing no text, only floats.</para> + </listitem> + </itemizedlist> + <para>The standard <literal>report</literal> and <literal>article</literal> classes use the default +placement <literal>[tbp]</literal>.</para> + <para>The body of the table is made up of whatever text, &latex; commands, etc., +you wish. The <literal>\caption</literal> command allows you to title your table.</para> + </sect1> + + <sect1 label="8.23" id="tabular"> + <title><literal>tabular</literal></title> + <para><indexterm role="fn"><primary>tabular environment</primary></indexterm><indexterm role="cp"><primary>lines in tables</primary></indexterm><indexterm role="cp"><primary>lining text up in tables</primary></indexterm> +Synopsis:</para> + <screen> +\begin{tabular}[pos]{cols} +column 1 entry & column 2 entry ... & column n entry \\ +... +\end{tabular} +</screen> + <para>or</para> + <screen> +\begin{tabular*}{width}[pos]{cols} +column 1 entry & column 2 entry ... & column n entry \\ +... +\end{tabular*} +</screen> + <para>These environments produce a box consisting of a sequence of rows of +items, aligned vertically in columns.</para> + <para><indexterm role="fn"><primary>\\ for <literal>tabular</literal></primary></indexterm><literal>\\</literal> must be used to specify the end of each row of the table, +except for the last, where it is optional—unless an <literal>\hline</literal> +command (to put a rule below the table) follows.</para> + <para>The mandatory and optional arguments consist of:</para> + <variablelist> + <varlistentry> + <term><literal>width</literal></term> + <listitem> + <para>Specifies the width of the <literal>tabular*</literal> environment. There must be +rubber space between columns that can stretch to fill out the specified +width.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>pos</literal></term> + <listitem> + <para>Specifies the vertical position; default is alignment on the centre of +the environment.</para> + <itemizedlist mark="bullet"> + <listitem> + <para><literal>t</literal> - align on top row</para> + </listitem> + <listitem> + <para><literal>b</literal> - align on bottom row</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>cols</literal></term> + <listitem> + <para>Specifies the column formatting. It consists of a sequence of the +following specifiers, corresponding to the sequence of columns and +intercolumn material.</para> + <itemizedlist mark="bullet"> + <listitem> + <para><literal>l</literal> - A column of left-aligned items.</para> + </listitem> + <listitem> + <para><literal>r</literal> - A column of right-aligned items.</para> + </listitem> + <listitem> + <para><literal>c</literal> - A column of centred items.</para> + </listitem> + <listitem> + <para><literal>|</literal> - A vertical line the full height and depth of the environment.</para> + </listitem> + <listitem> + <para><literal>@{text}</literal> - This inserts <literal>text</literal> 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 <literal>\extracolsep{wd}</literal> command in an +@-expression causes an extra space of width <literal>wd</literal> to appear to the +left of all subsequent columns, until countermanded by another +<literal>\extracolsep</literal> command. Unlike ordinary intercolumn space, this +extra space is not suppressed by an @-expression. An +<literal>\extracolsep</literal> command can be used only in an @-expression in the +<literal>cols</literal> argument.</para> + </listitem> + <listitem> + <para><literal>p{wd}</literal> - Produces a column with each item typeset in a parbox of +width <literal>wd</literal>, as if it were the argument of a <literal>\parbox[t]{wd}</literal> +command. However, a <literal>\\</literal> may not appear in the item, except in the +following situations:</para> + <orderedlist numeration="arabic"> + <listitem> + <para>inside an environment like <literal>minipage</literal>, <literal>array</literal>, or <literal>tabular</literal>.</para> + </listitem> + <listitem> + <para>inside an explicit <literal>\parbox</literal>.</para> + </listitem> + <listitem> + <para>in the scope of a <literal>\centering</literal>, <literal>\raggedright</literal>, or <literal>\raggedleft</literal> +declaration. The latter declarations must appear inside braces or an +environment when used in a <literal>p</literal>-column element.</para> + </listitem> + </orderedlist> + </listitem> + <listitem> + <para><literal>*{num}{cols}</literal> - Equivalent to <literal>num</literal> copies of +<literal>cols</literal>, where <literal>num</literal> is any positive integer and <literal>cols</literal> is +any list of column-specifiers, which may contain another +<literal>*-expression</literal>.</para> + </listitem> + </itemizedlist> + </listitem> + </varlistentry> + </variablelist> + <para>Parameters that control formatting: +<!-- xx defaults, own node (xref from array)? --></para> + <variablelist> + <varlistentry> + <term><literal>\arrayrulewidth</literal></term> + <listitem> + <para>Thickness of the rule created by <literal>|</literal>, <literal>\hline</literal>, and +<literal>\vline</literal> in the <literal>tabular</literal> and <literal>array</literal> environments; the +default is ‘<literal>.4pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\arraystretch</literal></term> + <listitem> + <para>Scaling of spacing between rows in the <literal>tabular</literal> and <literal>array</literal> +environments; default is ‘<literal>1</literal>’,for no scaling.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\doublerulesep</literal></term> + <listitem> + <para>Horizontal distance between the vertical rules produced by <literal>||</literal> +in the <literal>tabular</literal> and <literal>array</literal> environments; default is ‘<literal>2pt</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\tabcolsep</literal></term> + <listitem> + <para>Half the width of the space between columns; default is ‘<literal>6pt</literal>’.</para> + </listitem> + </varlistentry> + </variablelist> + <para>These commands can be used inside a <literal>tabular</literal> environment:</para> + + <sect2 label="8.23.1" id="\multicolumn"> + <title><literal>\multicolumn</literal></title> + <para><indexterm role="fn"><primary>\multicolumn</primary></indexterm> +Synopsis:</para> + <screen> +\multicolumn{<replaceable>cols</replaceable>}{<replaceable>pos</replaceable>}{<replaceable>text</replaceable>} +</screen> + <para>The <literal>\multicolumn</literal> command makes an entry that spans several +columns. The first mandatory argument, <replaceable>cols</replaceable>, specifies the +number of columns to span. The second mandatory argument, <replaceable>pos</replaceable>, +specifies the formatting of the entry; <literal>c</literal> for centered, <literal>l</literal> +for flushleft, <literal>r</literal> for flushright. The third mandatory argument, +<replaceable>text</replaceable>, specifies what text to put in the entry.</para> + <para>Here's an example showing two columns separated by an en-dash; +<literal>\multicolumn</literal> is used for the heading:</para> + <screen> +\begin{tabular}{r@{--}l} +\multicolumn{2}{c}{\bf Unicode}\cr + 0x80&0x7FF \cr + 0x800&0xFFFF \cr +0x10000&0x1FFFF \cr +\end{tabular} +</screen> + </sect2> + + <sect2 label="8.23.2" id="\cline"> + <title><literal>\cline</literal></title> + <para><indexterm role="fn"><primary>\cline</primary></indexterm> +Synopsis:</para> + <screen> +\cline{<replaceable>i</replaceable>-<replaceable>j</replaceable>} +</screen> + <para>The <literal>\cline</literal> command draws horizontal lines across the columns +specified, beginning in column <replaceable>i</replaceable> and ending in column <replaceable>j</replaceable>, +which are specified in the mandatory argument.</para> + </sect2> + + <sect2 label="8.23.3" id="\hline"> + <title><literal>\hline</literal></title> + <para><indexterm role="fn"><primary>\hline</primary></indexterm> +The <literal>\hline</literal> command draws a horizontal line the width of the +enclosing <literal>tabular</literal> or <literal>array</literal> environment. It's most +commonly used to draw a line at the top, bottom, and between the rows +of a table.</para> + </sect2> + + <sect2 label="8.23.4" id="\vline"> + <title><literal>\vline</literal></title> + <para><indexterm role="fn"><primary>\vline</primary></indexterm> +The <literal>\vline</literal> command will draw a vertical line extending the full +height and depth of its row. An <literal>\hfill</literal> command can be used to +move the line to the edge of the column. It can also be used in an +@-expression.</para> + </sect2> + </sect1> + + <sect1 label="8.24" id="thebibliography"> + <title><literal>thebibliography</literal></title> + <para><indexterm role="fn"><primary>thebibliography</primary></indexterm><indexterm role="cp"><primary>bibliography, creating (manually)</primary></indexterm> +Synopsis:</para> + <screen> +\begin{thebibliography}{<replaceable>widest-label</replaceable>} +\bibitem[<replaceable>label</replaceable>]{<replaceable>cite_key}</replaceable> +... +\end{thebibliography} +</screen> + <para>The <literal>thebibliography</literal> environment produces a bibliography or +reference list.</para> + <para>In the <literal>article</literal> class, this reference list is labelled +“References”; in the <literal>report</literal> class, it is labelled +“Bibliography”. You can change the label (in the standard classes) +by redefining the command <literal>\refname</literal>. For instance, this +eliminates it entirely:</para> + <screen> +\renewcommand{\refname}{} +</screen> + <para>The mandatory <replaceable>widest-label</replaceable> argument is text that, when typeset, +is as wide as the widest item label produced by the <literal>\bibitem</literal> +commands. It is typically given as <literal>9</literal> for bibliographies with +less than 10 references, <literal>99</literal> for ones with less than 100, etc.</para> + + <sect2 label="8.24.1" id="\bibitem"> + <title><literal>\bibitem</literal></title> + <para><indexterm role="fn"><primary>\bibitem</primary></indexterm> +Synopsis:</para> + <screen> +\bibitem[<replaceable>label</replaceable>]{<replaceable>cite_key</replaceable>} +</screen> + <para>The <literal>\bibitem</literal> command generates an entry labelled by +<replaceable>label</replaceable>. If the <replaceable>label</replaceable> argument is missing, a number is +automatically generated using the <literal>enumi</literal> counter. The +<replaceable>cite_key</replaceable> is any sequence of letters, numbers, and punctuation +symbols not containing a comma.</para> + <para>This command writes an entry to the <filename>.aux</filename> file containing the +item's <replaceable>cite_key</replaceable> and label. When the <filename>.aux</filename> file is read by +the <literal>\begin{document}</literal> command, the item's <literal>label</literal> is +associated with <literal>cite_key</literal>, causing references to <replaceable>cite_key</replaceable> +with a <literal>\cite</literal> command (see next section) to produce the +associated label.</para> + </sect2> + + <sect2 label="8.24.2" id="\cite"> + <title><literal>\cite</literal></title> + <para><indexterm role="fn"><primary>\cite</primary></indexterm> +Synopsis:</para> + <screen> +\cite[<replaceable>subcite</replaceable>]{<replaceable>keys</replaceable> +</screen> + <para>The <replaceable>keys</replaceable> argument is a list of one or more citation keys, +separated by commas. This command generates an in-text citation to +the references associated with <replaceable>keys</replaceable> by entries in the +<filename>.aux</filename> file.</para> + <para>The text of the optional <replaceable>subcite</replaceable> argument appears after the +citation. For example, <literal>\cite[p.~314]{knuth}</literal> might produce +`[Knuth, p. 314]'.</para> + </sect2> + + <sect2 label="8.24.3" id="\nocite"> + <title><literal>\nocite</literal></title> + <para><indexterm role="fn"><primary>\nocite</primary></indexterm> +<literal>\nocite{key_list}</literal></para> + <para>The <literal>\nocite</literal> command produces no text, but writes <literal>key_list</literal>, +which is a list of one or more citation keys, on the <filename>.aux</filename> file.</para> + </sect2> + + <sect2 label="8.24.4" id="Using-BibTeX"> + <title>Using Bib&tex;</title> + <para><indexterm role="cp"><primary>using Bib&tex;</primary></indexterm><indexterm role="cp"><primary>bib&tex;, using</primary></indexterm><indexterm role="cp"><primary>bibliography, creating (automatically)</primary></indexterm><indexterm role="fn"><primary>\bibliographystyle</primary></indexterm><indexterm role="fn"><primary>\bibliography</primary></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 +<literal>thebibliography</literal> environment (see <xref linkend="thebibliography"></xref>). Instead, +you include the lines</para> + <screen> +\bibliographystyle{<replaceable>bibstyle</replaceable>} +\bibliography{<replaceable>bibfile1</replaceable>,<replaceable>bibfile2</replaceable>} +</screen> + <para>The <literal>\bibliographystyle</literal> command does not produce any output of +its own. Rather, it defines the style in which the bibliography will +be produced: <replaceable>bibstyle</replaceable> refers to a file +<replaceable>bibstyle</replaceable><filename>.bst</filename>, which defines how your citations will look. +The standard <replaceable>style</replaceable> names distributed with Bib&tex; are:</para> + <variablelist> + <varlistentry> + <term><literal>alpha</literal></term> + <listitem> + <para>Sorted alphabetically. Labels are formed from name of author and year of +publication.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>plain</literal></term> + <listitem> + <para>Sorted alphabetically. Labels are numeric.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>unsrt</literal></term> + <listitem> + <para>Like <literal>plain</literal>, but entries are in order of citation.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>abbrv</literal></term> + <listitem> + <para>Like <literal>plain</literal>, but more compact labels.</para> + </listitem> + </varlistentry> + </variablelist> + <para>In addition, numerous other Bib&tex; style files exist tailored to +the demands of various publications. See +<ulink url="http://www.ctan.org/tex-archive/biblio/bibtex/contrib">http://www.ctan.org/tex-archive/biblio/bibtex/contrib</ulink>.</para> + <para>The <literal>\bibliography</literal> command is what actually produces the +bibliography. The argument to <literal>\bibliography</literal> refers to files +named <filename><replaceable>bibfile</replaceable>.bib</filename>, which should contain your database in +Bib&tex; format. Only the entries referred to via <literal>\cite</literal> and +<literal>\nocite</literal> will be listed in the bibliography.</para> + </sect2> + </sect1> + + <sect1 label="8.25" id="theorem"> + <title><literal>theorem</literal></title> + <para><indexterm role="fn"><primary>theorem environment</primary></indexterm><indexterm role="cp"><primary>theorems, typesetting</primary></indexterm> +Synopsis:</para> + <screen> +\begin{theorem} +<replaceable>theorem-text</replaceable> +\end{theorem} +</screen> + <para>The <literal>theorem</literal> environment produces “Theorem <replaceable>n</replaceable>” in +boldface followed by <replaceable>theorem-text</replaceable>, where the numbering +possibilities for <replaceable>n</replaceable> are described under <literal>\newtheorem</literal> +(see <xref linkend="\newtheorem"></xref>).</para> + </sect1> + + <sect1 label="8.26" id="titlepage"> + <title><literal>titlepage</literal></title> + <para><indexterm role="fn"><primary>titlepage environment</primary></indexterm><indexterm role="cp"><primary>making a title page</primary></indexterm><indexterm role="cp"><primary>title pages, creating</primary></indexterm> +Synopsis:</para> + <screen> +\begin{titlepage} +<replaceable>text</replaceable> +\end{titlepage} +</screen> + <para>The <literal>titlepage</literal> 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 <literal>\today</literal> command may be useful on title pages +(see <xref linkend="\today"></xref>).</para> + <para>You can use the <literal>\maketitle</literal> command (see <xref linkend="\maketitle"></xref>) to +produce a standard title page without a <literal>titlepage</literal> environment.</para> + </sect1> + + <sect1 label="8.27" id="verbatim"> + <title><literal>verbatim</literal></title> + <para><indexterm role="fn"><primary>verbatim environment</primary></indexterm><indexterm role="cp"><primary>verbatim text</primary></indexterm><indexterm role="cp"><primary>simulating typed text</primary></indexterm><indexterm role="cp"><primary>typed text, simulating</primary></indexterm><indexterm role="cp"><primary>code, typesetting</primary></indexterm><indexterm role="cp"><primary>computer programs, typesetting</primary></indexterm> +Synopsis:</para> + <screen> +\begin{verbatim} +<replaceable>literal-text</replaceable> +\end{verbatim} +</screen> + <para>The <literal>verbatim</literal> environment is a paragraph-making environment in +which &latex; produces exactly what you type in; for instance the +<literal>\</literal> character produces a printed ‘<literal>\</literal>’. It turns &latex; +into a typewriter with carriage returns and blanks having the same +effect that they would on a typewriter.</para> + <para>The <literal>verbatim</literal> uses a monospaced typewriter-like font (<literal>\tt</literal>).</para> + + <sect2 label="8.27.1" id="\verb"> + <title><literal>\verb</literal></title> + <para><indexterm role="fn"><primary>\verb</primary></indexterm><indexterm role="cp"><primary>verbatim text, inline</primary></indexterm> +Synopsis:</para> + <screen> +\verb<replaceable>char</replaceable><replaceable>literal-text</replaceable><replaceable>char</replaceable> +\verb*<replaceable>char</replaceable><replaceable>literal-text</replaceable><replaceable>char</replaceable> +</screen> + <para>The <literal>\verb</literal> command typesets <replaceable>literal-text</replaceable> as it is input, +including special characters and spaces, using the typewriter +(<literal>\tt</literal>) font. No spaces are allowed between <literal>\verb</literal> or +<literal>\verb*</literal> and the delimiter <replaceable>char</replaceable>, which begins and ends the +verbatim text. The delimiter must not appear in <replaceable>literal-text</replaceable>.</para> + <para><indexterm role="cp"><primary>visible space</primary></indexterm>The <literal>*</literal>-form differs only in that spaces are printed with a +“visible space” character.</para> + </sect2> + </sect1> + + <sect1 label="8.28" id="verse"> + <title><literal>verse</literal></title> + <para><indexterm role="fn"><primary>verse environment</primary></indexterm><indexterm role="cp"><primary>poetry, an environment for</primary></indexterm> +Synopsis:</para> + <screen> +\begin{verse} +<replaceable>line1</replaceable> \\ +<replaceable>line2</replaceable> \\ +... +\end{verse} +</screen> + <para>The <literal>verse</literal> environment is designed for poetry, though you may find +other uses for it.</para> + <para><indexterm role="fn"><primary>\\ for <literal>verse</literal></primary></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 <literal>\\</literal>, and use one or more blank lines to separate the +stanzas.</para> + </sect1> + </chapter> + + <chapter label="9" id="Footnotes"> + <title>Footnotes</title> + <para><indexterm role="cp"><primary>footnotes, creating</primary></indexterm> +Footnotes can be produced in one of two ways. They can be produced +with one command, the <literal>\footnote</literal> command. They can also be +produced with two commands, the <literal>\footnotemark</literal> and the +<literal>\footnotetext</literal> commands.</para> + + <sect1 label="9.1" id="\footnote"> + <title><literal>\footnote</literal></title> + <para><indexterm role="fn"><primary>\footnote</primary></indexterm> +Synopsis:</para> + <screen> +\footnote[<replaceable>number</replaceable>]{<replaceable>text</replaceable>} +</screen> + <para>The <literal>\footnote</literal> command places the numbered footnote <replaceable>text</replaceable> +at the bottom of the current page. The optional argument <replaceable>number</replaceable> +changes the default footnote number.</para> + <para>This command can only be used in outer paragraph mode; i.e., you +cannot use it in sectioning commands like <literal>\chapter</literal>, in figures, +tables or in a <literal>tabular</literal> environment. (See following sections.) +<!-- xx mention packages that fix this --></para> + </sect1> + + <sect1 label="9.2" id="\footnotemark"> + <title><literal>\footnotemark</literal></title> + <para><indexterm role="fn"><primary>\footnotemark</primary></indexterm> +With no optional argument, the <literal>\footnotemark</literal> command puts the +current footnote number in the text. This command can be used in +inner paragraph mode. You give the text of the footnote separately, +with the <literal>\footnotetext</literal> command.</para> + <para>This command can be used to produce several consecutive footnote +markers referring to the same footnote with</para> + <screen> +\footnotemark[\value{footnote}] +</screen> + <para>after the first <literal>\footnote</literal> command.</para> + </sect1> + + <sect1 label="9.3" id="\footnotetext"> + <title><literal>\footnotetext</literal></title> + <para><indexterm role="fn"><primary>\footnotetext</primary></indexterm> +Synopsis:</para> + <screen> +\footnotetext[<replaceable>number</replaceable>]{<replaceable>text</replaceable>} +</screen> + <para>The <literal>\footnotetext</literal> command places <replaceable>text</replaceable> at the bottom of +the page as a footnote. This command can come anywhere after the +<literal>\footnotemark</literal> command. The <literal>\footnotetext</literal> command must +appear in outer paragraph mode.</para> + <para>The optional argument <replaceable>number</replaceable> changes the default footnote number.</para> + </sect1> + + <sect1 label="9.4" id="Footnote-parameters"> + <title>Footnote parameters</title> + <para><indexterm role="cp"><primary>footnote parameters</primary></indexterm></para> + <variablelist> + <varlistentry> + <term><literal>\footnoterule</literal></term> + <listitem> + <para>Produces the rule separating the main text on a page from the page's +footnotes. Default dimensions: <literal>0.4pt</literal> thick (or wide), and +<literal>0.4\columnwidth</literal> long in the standard document classes (except +slides, where it does not appear).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\footnotesep</literal></term> + <listitem> + <para>The height of the strut placed at the beginning of the footnote. By +default, this is set to the normal strut for <literal>\footnotesize</literal> +fonts (see <xref linkend="Font-sizes"></xref>), therefore there is no extra space between +footnotes. This is ‘<literal>6.65pt</literal>’ for ‘<literal>10pt</literal>’, ‘<literal>7.7pt</literal>’ for +‘<literal>11pt</literal>’, and ‘<literal>8.4pt</literal>’ for ‘<literal>12pt</literal>’.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + </chapter> + + <chapter label="10" id="Definitions"> + <title>Definitions</title> + <para><indexterm role="cp"><primary>definitions</primary></indexterm> +&latex; has support for making new commands of many different kinds.</para> +<!-- xx everything in this chapter needs examples. --> + <sect1 label="10.1" id="\newcommand-&-\renewcommand"> + <title><literal>\newcommand</literal> & <literal>\renewcommand</literal></title> + <para><indexterm role="fn"><primary>\newcommand</primary></indexterm><indexterm role="cp"><primary>commands, defining new ones</primary></indexterm><indexterm role="cp"><primary>defining a new command</primary></indexterm><indexterm role="cp"><primary>new commands, defining</primary></indexterm> +<literal>\newcommand</literal> and <literal>\renewcommand</literal> define and redefine a +command, respectively. Synopses:</para> + <screen> + \newcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>defn</replaceable>} +\renewcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>defn</replaceable>} + \newcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>defn</replaceable>} +\renewcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>defn</replaceable>} +</screen> + <variablelist> + <varlistentry> + <term><replaceable>cmd</replaceable></term> + <listitem> + <para>The command name beginning with <literal>\</literal>. For <literal>\newcommand</literal>, it +must not be already defined and must not begin with <literal>\end</literal>; for +<literal>\renewcommand</literal>, it must already be defined.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>nargs</replaceable></term> + <listitem> + <para>An optional integer from 1 to 9 specifying the number of arguments +that the command will take. The default is for the command to have no +arguments.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>default</replaceable></term> + <listitem> + <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 ‘<literal>def</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>defn</replaceable></term> + <listitem> + <para>The text to be substituted for every occurrence of <literal>cmd</literal>; a +construct of the form <literal>#<replaceable>n</replaceable></literal> in <replaceable>defn</replaceable> is replaced by the +text of the <replaceable>n</replaceable>th argument.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="10.2" id="\newcounter"> + <title><literal>\newcounter</literal></title> + <para><indexterm role="fn"><primary>\newcounter</primary></indexterm><indexterm role="cp"><primary>counters, defining new</primary></indexterm> +Synopsis:</para> + <screen> +\newcounter{<replaceable>cnt</replaceable>}[<replaceable>countername</replaceable>] +</screen> + <para>The <literal>\newcounter</literal> command defines a new counter named <replaceable>cnt</replaceable>. +The new counter is initialized to zero.</para> + <para>Given the optional argument <literal>[<replaceable>countername</replaceable>]</literal>, <replaceable>cnt</replaceable> +will be reset whenever <replaceable>countername</replaceable> is incremented.</para> + <para>See <xref linkend="Counters"></xref>, for more information about counters.</para> + </sect1> + + <sect1 label="10.3" id="\newlength"> + <title><literal>\newlength</literal></title> + <para><indexterm role="fn"><primary>\newlength</primary></indexterm><indexterm role="cp"><primary>lengths, defining new</primary></indexterm> +Synopsis:</para> + <screen> +\newlength{\<replaceable>arg</replaceable>} +</screen> + <para>The <literal>\newlength</literal> command defines the mandatory argument as a +<literal>length</literal> command with a value of <literal>0in</literal>. The argument must +be a control sequence, as in <literal>\newlength{\foo}</literal>. An error +occurs if <literal>\foo</literal> is already defined.</para> + <para>See <xref linkend="Lengths"></xref>, for how to set the new length to a nonzero value, and +for more information about lengths in general.</para> + </sect1> + + <sect1 label="10.4" id="\newsavebox"> + <title><literal>\newsavebox</literal></title> + <para><indexterm role="fn"><primary>\newsavebox</primary></indexterm> +Synopsis:</para> + <screen> +\newsavebox{<replaceable>cmd</replaceable>} +</screen> + <para>Defines <literal>\<replaceable>cmd</replaceable></literal>, which must be a command name not already +defined, to refer to a new bin for storing boxes.</para> + </sect1> + + <sect1 label="10.5" id="\newenvironment-&-\renewenvironment"> + <title><literal>\newenvironment</literal> & <literal>\renewenvironment</literal></title> + <para><indexterm role="fn"><primary>\newenvironment</primary></indexterm><indexterm role="fn"><primary>\renewenvironment</primary></indexterm><indexterm role="cp"><primary>environments, defining</primary></indexterm><indexterm role="cp"><primary>defining new environments</primary></indexterm><indexterm role="cp"><primary>redefining environments</primary></indexterm> +Synopses:</para> + <screen> + \newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>} + \newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>} +\renewenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>} +</screen> + <para>These commands define or redefine an environment <replaceable>env</replaceable>, that is, +<literal>\begin{<replaceable>env</replaceable>} … \end{<replaceable>env</replaceable>}</literal>.</para> + <variablelist> + <varlistentry> + <term><replaceable>env</replaceable></term> + <listitem> + <para>The name of the environment. For <literal>\newenvironment</literal>, <replaceable>env</replaceable> +must not be an existing environment, and the command <literal>\<replaceable>env</replaceable></literal> +must be undefined. For <literal>\renewenvironment</literal>, <replaceable>env</replaceable> must be +the name of an existing environment.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>nargs</replaceable></term> + <listitem> + <para>An integer from 1 to 9 denoting the number of arguments of +the newly-defined environment. The default is no arguments.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>default</replaceable></term> + <listitem> + <para>If this is specified, the first argument is optional, and <replaceable>default</replaceable> +gives the default value for that argument.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>begdef</replaceable></term> + <listitem> + <para>The text expanded at every occurrence of <literal>\begin{<replaceable>env</replaceable>}</literal>; a +construct of the form <literal>#<replaceable>n</replaceable></literal> in <replaceable>begdef</replaceable> is replaced by +the text of the <replaceable>n</replaceable>th argument.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>enddef</replaceable></term> + <listitem> + <para>The text expanded at every occurrence of <literal>\end{<replaceable>env</replaceable>}</literal>. It +may not contain any argument parameters.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="10.6" id="\newtheorem"> + <title><literal>\newtheorem</literal></title> + <para><indexterm role="fn"><primary>\newtheorem</primary></indexterm><indexterm role="cp"><primary>theorems, defining</primary></indexterm><indexterm role="cp"><primary>defining new theorems</primary></indexterm></para> + <screen> +\newtheorem{<replaceable>newenv</replaceable>}{<replaceable>label</replaceable>}[<replaceable>within</replaceable>] +\newtheorem{<replaceable>newenv</replaceable>}[<replaceable>numbered_like</replaceable>]{<replaceable>label</replaceable>} +</screen> + <para>This command defines a theorem-like environment. Arguments:</para> + <variablelist> + <varlistentry> + <term><replaceable>newenv</replaceable></term> + <listitem> + <para>The name of the environment to be defined; must not be the name of an +existing environment or otherwise defined.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>label</replaceable></term> + <listitem> + <para>The text printed at the beginning of the environment, before the +number. For example, ‘<literal>Theorem</literal>’.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>numbered_like</replaceable></term> + <listitem> + <para>(Optional.) The name of an already defined theorem-like environment; +the new environment will be numbered just like <replaceable>numbered_like</replaceable>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>within</replaceable></term> + <listitem> + <para>(Optional.) The name of an already defined counter, a sectional unit. +The new theorem counter will be reset at the same time as the +<replaceable>within</replaceable> counter.</para> + </listitem> + </varlistentry> + </variablelist> + <para>At most one of <replaceable>numbered_like</replaceable> and <replaceable>within</replaceable> can be specified, +not both.</para> + </sect1> + + <sect1 label="10.7" id="\newfont"> + <title><literal>\newfont</literal></title> + <para><indexterm role="fn"><primary>\newfont</primary></indexterm><indexterm role="cp"><primary>fonts, new commands for</primary></indexterm><indexterm role="cp"><primary>defining new fonts</primary></indexterm> +Synopsis:</para> + <screen> +\newfont{<replaceable>cmd</replaceable>}{<replaceable>fontname</replaceable>} +</screen> + <para>Defines a control sequence <literal>\<replaceable>cmd</replaceable></literal>, which must not already +be defined, to make <replaceable>fontname</replaceable> be the current font. The file +looked for on the system is named <filename><replaceable>fontname</replaceable>.tfm</filename>.</para> + <para>This is a low-level command for setting up to use an individual font. +More commonly, fonts are defined in families through <filename>.fd</filename> files.</para> + </sect1> + + <sect1 label="10.8" id="\protect"> + <title><literal>\protect</literal></title> + <para><indexterm role="fn"><primary>\protect</primary></indexterm> +<indexterm role="cp"><primary>fragile commands</primary></indexterm><indexterm role="cp"><primary>moving arguments</primary></indexterm>Footnotes, line breaks, any command that has an optional argument, and +many more are so-called <firstterm>fragile</firstterm> commands. When a fragile +command is used in certain contexts, called <firstterm>moving arguments</firstterm>, it +must be preceded by <literal>\protect</literal>. In addition, any fragile +commands within the arguments must have their own <literal>\protect</literal>.</para> + <para>Some examples of moving arguments are <literal>\caption</literal> +(see <xref linkend="figure"></xref>), <literal>\thanks</literal> (see <xref linkend="\maketitle"></xref>), and +expressions in <literal>tabular</literal> and <literal>array</literal> environments +(see <xref linkend="tabular"></xref>).</para> + <para><indexterm role="cp"><primary>robust commands</primary></indexterm>Commands which are not fragile are called <firstterm>robust</firstterm>. They must not +be preceded by <literal>\protect</literal>.</para> + <para>See also:</para> + <screen> +<lineannotation><ulink url="http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html">http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</ulink></lineannotation> +<lineannotation><ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</ulink></lineannotation> +</screen> +<!-- xx really need examples. --> + </sect1> + </chapter> + + <chapter label="11" id="Counters"> + <title>Counters</title> + <para><indexterm role="cp"><primary>counters, a list of</primary></indexterm><indexterm role="cp"><primary>variables, a list of</primary></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 <literal>\</literal>. +(<literal>enumi</literal>–<literal>enumiv</literal> are used for the nested enumerate +environment.) Below is a list of the counters used in &latex;'s +standard document classes to control numbering.</para> + <screen> +part paragraph figure enumi +chapter subparagraph table enumii +section page footnote enumiii +subsection equation mpfootnote enumiv +subsubsection +</screen> + <sect1 label="11.1" id="\alph-\Alph-\arabic-\roman-\Roman-\fnsymbol"> + <title><literal>\alph \Alph \arabic \roman \Roman \fnsymbol</literal>: Printing counters</title> + <para>All of these commands take a single counter as an argument, for +instance, <literal>\alph{enumi}</literal>.</para> + <variablelist> + <varlistentry> + <term><literal>\alph</literal></term> + <listitem> + <para>prints <replaceable>counter</replaceable> using lowercase letters: `a', `b', ….</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Alph</literal></term> + <listitem> + <para>uses uppercase letters: `A', `B', ….</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\arabic</literal></term> + <listitem> + <para>uses Arabic numbers: `1', `2', ….</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\roman</literal></term> + <listitem> + <para>uses lowercase roman numerals: `i', `ii', ….</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\roman</literal></term> + <listitem> + <para>uses uppercase roman numerals: `I', `II', ….</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\fnsymbol</literal></term> + <listitem> + <para>prints the value of <replaceable>counter</replaceable> in a specific sequence of nine +symbols (conventionally used for labeling footnotes). The value of +<replaceable>counter</replaceable> must be between 1 and 9, inclusive.</para> + <para>The symbols mostly aren't supported in Info, but here are the names:<literallayout> +asterix(*) dagger ddagger section-sign paragraph-sign parallel +double-asterix(**) double-dagger double-ddagger +</literallayout></para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="11.2" id="\usecounter"> + <title><literal>\usecounter{<replaceable>counter</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\usecounter</primary></indexterm><indexterm role="cp"><primary>list items, specifying counter</primary></indexterm><indexterm role="cp"><primary>numbered items, specifying counter</primary></indexterm> +Synopsis:</para> + <screen> +\usecounter{<replaceable>counter</replaceable>} +</screen> + <para>The <literal>\usecounter</literal> command is used in the second argument of the +<literal>list</literal> environment to specify <replaceable>counter</replaceable> to be used to number +the list items.</para> + </sect1> + + <sect1 label="11.3" id="\value"> + <title><literal>\value{<replaceable>counter</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\value</primary></indexterm><indexterm role="cp"><primary>counters, getting value of</primary></indexterm> +Synopsis:</para> + <screen> +\value{<replaceable>counter</replaceable>} +</screen> + <para>The <literal>\value</literal> command produces the value of <replaceable>counter</replaceable>. It can +be used anywhere &latex; expects a number, for example:</para> + <screen> +\setcounter{myctr}{3} +\addtocounter{myctr}{1} +\hspace{\value{myctr}\parindent} +</screen> + </sect1> + + <sect1 label="11.4" id="\setcounter"> + <title><literal>\setcounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\setcounter</primary></indexterm><indexterm role="cp"><primary>counters, setting</primary></indexterm><indexterm role="cp"><primary>setting counters</primary></indexterm> +Synopsis:</para> + <screen> +\setcounter{<replaceable>\counter</replaceable>}{<replaceable>value</replaceable>} +</screen> + <para>The <literal>\setcounter</literal> command sets the value of <replaceable>\counter</replaceable> to the +<replaceable>value</replaceable> argument.</para> + </sect1> + + <sect1 label="11.5" id="\addtocounter"> + <title><literal>\addtocounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\addtocounter</primary></indexterm> +The <literal>\addtocounter</literal> command increments <replaceable>counter</replaceable> by the +amount specified by the <replaceable>value</replaceable> argument, which may be negative.</para> + </sect1> + + <sect1 label="11.6" id="\refstepcounter"> + <title><literal>\refstepcounter{<replaceable>counter</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\refstepcounter</primary></indexterm> +The <literal>\refstepcounter</literal> command works in the same way as +<literal>\stepcounter</literal> See <xref linkend="\stepcounter"></xref>, except it also defines the +current <literal>\ref</literal> value to be the result of <literal>\thecounter</literal>.</para> + </sect1> + + <sect1 label="11.7" id="\stepcounter"> + <title><literal>\stepcounter{<replaceable>counter</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\stepcounter</primary></indexterm> +The <literal>\stepcounter</literal> command adds one to <replaceable>counter</replaceable> and +resets all subsidiary counters.</para> + </sect1> + + <sect1 label="11.8" id="\day-\month-\year"> + <title><literal>\day \month \year</literal>: Predefined counters</title> + <para><indexterm role="fn"><primary>\day</primary></indexterm><indexterm role="fn"><primary>\month</primary></indexterm><indexterm role="fn"><primary>\year</primary></indexterm> +&latex; defines counters for the day of the month (<literal>\day</literal>, +1–31), month of the year (<literal>\month</literal>, 1–12), and year +(<literal>\year</literal>, 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 <literal>\today</literal> produces a string representing the +current day (see <xref linkend="\today"></xref>).</para> + </sect1> + </chapter> + + <chapter label="12" id="Lengths"> + <title>Lengths</title> + <para><indexterm role="cp"><primary>lengths, defining and using</primary></indexterm> +A <literal>length</literal> is a measure of distance. Many &latex; commands take a +length as an argument.</para> + + <sect1 label="12.1" id="\setlength"> + <title><literal>\setlength{\<replaceable>len</replaceable>}{<replaceable>value</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\setlength</primary></indexterm><indexterm role="cp"><primary>lengths, setting</primary></indexterm> +The <literal>\setlength</literal> sets the value of <replaceable>\len</replaceable> to the <replaceable>value</replaceable> +argument, which can be expressed in any units that &latex; +understands, i.e., inches (<literal>in</literal>), millimeters (<literal>mm</literal>), points +(<literal>pt</literal>), big points (<literal>bp</literal>, etc.</para> + </sect1> + + <sect1 label="12.2" id="\addtolength"> + <title>\addtolength{<replaceable>\len</replaceable>}{<replaceable>amount</replaceable>}</title> + <para><indexterm role="fn"><primary>\addtolength</primary></indexterm><indexterm role="cp"><primary>lengths, adding to</primary></indexterm> +The <literal>\addtolength</literal> command increments a “length command” +<replaceable>\len</replaceable> by the amount specified in the <replaceable>amount</replaceable> argument, which +may be negative.</para> + </sect1> + + <sect1 label="12.3" id="\settodepth"> + <title><literal>\settodepth</literal></title> + <para><indexterm role="fn"><primary>\settodepth</primary></indexterm> +<literal>\settodepth{\gnat}{text}</literal></para> + <para>The <literal>\settodepth</literal> command sets the value of a <literal>length</literal> command +equal to the depth of the <literal>text</literal> argument.</para> + </sect1> + + <sect1 label="12.4" id="\settoheight"> + <title><literal>\settoheight</literal></title> + <para><indexterm role="fn"><primary>\settoheight</primary></indexterm> +<literal>\settoheight{\gnat}{text}</literal></para> + <para>The <literal>\settoheight</literal> command sets the value of a <literal>length</literal> command +equal to the height of the <literal>text</literal> argument.</para> + </sect1> + + <sect1 label="12.5" id="\settowidth"> + <title><literal>\settowidth{\<replaceable>len</replaceable>}{<replaceable>text</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\settowidth</primary></indexterm> +The <literal>\settowidth</literal> command sets the value of the command <replaceable>\len</replaceable> +to the width of the <replaceable>text</replaceable> argument.</para> + </sect1> + + <sect1 label="12.6" id="Predefined-lengths"> + <title>Predefined lengths</title> + <para><indexterm role="cp"><primary>lengths, predefined</primary></indexterm><indexterm role="cp"><primary>predefined lengths</primary></indexterm> +<literal>\width</literal> +<indexterm role="fn"><primary>\width</primary></indexterm> +<literal>\height</literal> +<indexterm role="fn"><primary>\height</primary></indexterm> +<literal>\depth</literal> +<indexterm role="fn"><primary>\depth</primary></indexterm> +<literal>\totalheight</literal> +<indexterm role="fn"><primary>\totalheight</primary></indexterm> +These length parameters can be used in the arguments of the box-making +commands (see <xref linkend="Boxes"></xref>). They specify the natural width etc. of the +text in the box. <literal>\totalheight</literal> equals <literal>\height</literal> + +<literal>\depth</literal>. To make a box with the text stretched to double the +natural size, e.g., say</para> + <para><literal>\makebox[2\width]{Get a stretcher}</literal></para> + </sect1> + </chapter> + + <chapter label="13" id="Line-breaking"> + <title>Line breaking</title> + <para><indexterm role="cp"><primary>line breaking</primary></indexterm><indexterm role="cp"><primary>breaking lines</primary></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 +<literal>\\</literal> command, and you can always manually force breaks.</para> + + <sect1 label="13.1" id="\\"> + <title><literal>\\</literal>[*][<replaceable>morespace</replaceable>]</title> + <para><indexterm role="fn"><primary>\\ force line break</primary></indexterm><indexterm role="cp"><primary>new line, starting</primary></indexterm><indexterm role="cp"><primary>line break, forcing</primary></indexterm> +The <literal>\\</literal> command tells &latex; to start a new line. It has an +optional argument, <replaceable>morespace</replaceable>, that specifies how much extra +vertical space is to be inserted before the next line. This can be a +negative amount.</para> + <para>The <literal>\\*</literal> command is the same as the ordinary <literal>\\</literal> command +except that it tells &latex; not to start a new page after the line.</para> + </sect1> + + <sect1 label="13.2" id="\obeycr-&-\restorecr"> + <title><literal>\obeycr</literal> & <literal>\restorecr</literal></title> + <para><indexterm role="fn"><primary>\obeycr</primary></indexterm><indexterm role="fn"><primary>\restorecr</primary></indexterm><indexterm role="cp"><primary>new line, output as input</primary></indexterm> +The <literal>\obeycr</literal> command makes a return in the input file +(‘<literal>^^M</literal>’, internally) the same as <literal>\\</literal> (followed by +<literal>\relax</literal>). So each new line in the input will also be a new line +in the output.</para> + <para><literal>\restorecr</literal> restores normal line-breaking behavior.</para> + </sect1> + + <sect1 label="13.3" id="\newline"> + <title><literal>\newline</literal></title> + <para><indexterm role="fn"><primary>\newline</primary></indexterm><indexterm role="cp"><primary>new line, starting (paragraph mode)</primary></indexterm> +The <literal>\newline</literal> command breaks the line at the present point, with +no stretching of the text before it. It can only be used in paragraph +mode.</para> + </sect1> + + <sect1 label="13.4" id="\--(hyphenation)"> + <title><literal>\-</literal> (discretionary hyphen)</title> + <para><indexterm role="fn"><primary>\- (hyphenation)</primary></indexterm><indexterm role="cp"><primary>hyphenation, forcing</primary></indexterm> +The <literal>\-</literal> 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 <literal>\-</literal> command is used for the exceptional +cases.</para> + <para>When you insert <literal>\-</literal> 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> + </sect1> + + <sect1 label="13.5" id="\fussy"> + <title><literal>\fussy</literal></title> + <para><indexterm role="fn"><primary>\fussy</primary></indexterm> +The declaration <literal>\fussy</literal> (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 <literal>\sloppy</literal> command +(see <xref linkend="\sloppy"></xref>.</para> + </sect1> + + <sect1 label="13.6" id="\sloppy"> + <title><literal>\sloppy</literal></title> + <para>The declaration <literal>\sloppy</literal> makes &tex; less fussy about line +breaking. This will avoid overfull boxes, at the cost of loose +interword spacing.</para> + <para>Lasts until a <literal>\fussy</literal> command is issued (see <xref linkend="\fussy"></xref>).</para> + </sect1> + + <sect1 label="13.7" id="\hyphenation"> + <title><literal>\hyphenation</literal></title> + <para><indexterm role="fn"><primary>\hyphenation</primary></indexterm><indexterm role="cp"><primary>hyphenation, defining</primary></indexterm> +Synopsis:</para> + <screen> +\hyphenation{<replaceable>word-one</replaceable> <replaceable>word-two</replaceable>} +</screen> + <para>The <literal>\hyphenation</literal> command declares allowed hyphenation points +with a <literal>-</literal> 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 <literal>\hyphenation</literal> commands +accumulate. Some examples (the default &tex; hyphenation patterns +misses the hyphenations in these words):</para> + <screen> +\hyphenation{ap-pen-dix col-umns data-base data-bases} +</screen> + </sect1> + + <sect1 label="13.8" id="\linebreak-&-\nolinebreak"> + <title><literal>\linebreak</literal> & <literal>\nolinebreak</literal></title> + <para><indexterm role="fn"><primary>\linebreak</primary></indexterm><indexterm role="fn"><primary>\nolinebreak</primary></indexterm><indexterm role="cp"><primary>line breaks, forcing</primary></indexterm><indexterm role="cp"><primary>line breaks, preventing</primary></indexterm> +Synopses:</para> + <screen> +\linebreak[<replaceable>priority</replaceable>] +\nolinebreak[<replaceable>priority</replaceable>] +</screen> + <para>By default, the <literal>\linebreak</literal> (<literal>\nolinebreak</literal>) command forces +(prevents) a line break at the current position. For +<literal>\linebreak</literal>, the spaces in the line are stretched out so that it +extends to the right margin as usual.</para> + <para>With the optional argument <replaceable>priority</replaceable>, you can convert the command +from a demand to a request. The <replaceable>priority</replaceable> must be a number from +0 to 4. The higher the number, the more insistent the request.</para> + </sect1> + </chapter> + + <chapter label="14" id="Page-breaking"> + <title>Page breaking</title> + <para><indexterm role="cp"><primary>page breaking</primary></indexterm><indexterm role="cp"><primary>breaking pages</primary></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> + + <sect1 label="14.1" id="\cleardoublepage"> + <title><literal>\cleardoublepage</literal></title> + <para><indexterm role="fn"><primary>\cleardoublepage</primary></indexterm><indexterm role="cp"><primary>starting on a right-hand page</primary></indexterm> +The <literal>\cleardoublepage</literal> command ends the current page and causes all +figures and tables that have so far appeared in the input to be printed. +In a two-sided printing style, it also makes the next page a right-hand +(odd-numbered) page, producing a blank page if necessary.</para> + </sect1> + + <sect1 label="14.2" id="\clearpage"> + <title><literal>\clearpage</literal></title> + <para><indexterm role="fn"><primary>\clearpage</primary></indexterm><indexterm role="cp"><primary>flushing floats and starting a page</primary></indexterm><indexterm role="cp"><primary>starting a new page and clearing floats</primary></indexterm> +The <literal>\clearpage</literal> command ends the current page and causes all +figures and tables that have so far appeared in the input to be printed.</para> + </sect1> + + <sect1 label="14.3" id="\newpage"> + <title><literal>\newpage</literal></title> + <para><indexterm role="fn"><primary>\newpage</primary></indexterm><indexterm role="cp"><primary>new page, starting</primary></indexterm><indexterm role="cp"><primary>starting a new page</primary></indexterm> +The <literal>\newpage</literal> command ends the current page, but does not clear +floats (see <literal>\clearpage</literal> above).</para> + </sect1> + + <sect1 label="14.4" id="\enlargethispage"> + <title><literal>\enlargethispage</literal></title> + <para><indexterm role="fn"><primary>\enlargethispage</primary></indexterm><indexterm role="cp"><primary>enlarge current page</primary></indexterm> +<literal>\enlargethispage{size}</literal></para> + <para><literal>\enlargethispage*{size}</literal></para> + <para>Enlarge the <literal>\textheight</literal> for the current page by the specified +amount; e.g. <literal>\enlargethispage{\baselineskip}</literal> will allow one +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 +<literal>\pagebreak</literal>.</para> + </sect1> + + <sect1 label="14.5" id="\pagebreak-&-\nopagebreak"> + <title><literal>\pagebreak</literal> & <literal>\nopagebreak</literal></title> + <para><indexterm role="fn"><primary>\pagebreak</primary></indexterm><indexterm role="fn"><primary>\nopagebreak</primary></indexterm><indexterm role="cp"><primary>page break, forcing</primary></indexterm><indexterm role="cp"><primary>page break, preventing</primary></indexterm> +Synopses:</para> + <screen> +\pagebreak[<replaceable>priority</replaceable>] +\nopagebreak[<replaceable>priority</replaceable>] +</screen> + <para>By default, the <literal>\pagebreak</literal> (<literal>\nopagebreak</literal>) command forces +(prevents) a page break at the current position. For +<literal>\linebreak</literal>, 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 <replaceable>priority</replaceable>, you can convert the +<literal>\pagebreak</literal> 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> + </sect1> + </chapter> + + <chapter label="15" id="Making-paragraphs"> + <title>Making paragraphs</title> + <para><indexterm role="cp"><primary>making paragraphs</primary></indexterm><indexterm role="cp"><primary>paragraphs</primary></indexterm> +A paragraph is ended by one or more completely blank lines—lines not +containing even a <literal>%</literal>. 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> + + <sect1 label="15.1" id="\indent"> + <title><literal>\indent</literal></title> + <para><indexterm role="fn"><primary>\indent</primary></indexterm><indexterm role="fn"><primary>\parindent</primary></indexterm><indexterm role="cp"><primary>indent, forcing</primary></indexterm> +<literal>\indent</literal> produces a horizontal space whose width equals the +width of the <literal>\parindent</literal> length, the normal paragraph +indentation. It is used to add paragraph indentation where it would +otherwise be suppressed.</para> + <para>The default value for <literal>\parindent</literal> is <literal>1em</literal> in two-column +mode, otherwise <literal>15pt</literal> for <literal>10pt</literal> documents, <literal>17pt</literal> for +<literal>11pt</literal>, and <literal>1.5em</literal> for <literal>12pt</literal>.</para> + </sect1> + + <sect1 label="15.2" id="\noindent"> + <title><literal>\noindent</literal></title> + <para><indexterm role="fn"><primary>\noindent</primary></indexterm><indexterm role="cp"><primary>indent, suppressing</primary></indexterm> +When used at the beginning of the paragraph, <literal>\noindent</literal> +suppresses any paragraph indentation. It has no effect when used in +the middle of a paragraph.</para> + </sect1> + + <sect1 label="15.3" id="\parskip"> + <title><literal>\parskip</literal></title> + <para><indexterm role="fn"><primary>\parskip</primary></indexterm><indexterm role="cp"><primary>vertical space before paragraphs</primary></indexterm> +<literal>\parskip</literal> is a rubber length defining extra vertical space added +before each paragraph. The default is <literal>0pt plus1pt</literal>.</para> + </sect1> + + <sect1 label="15.4" id="Marginal-notes"> + <title>Marginal notes</title> + <para><indexterm role="cp"><primary>marginal notes</primary></indexterm><indexterm role="cp"><primary>notes in the margin</primary></indexterm><indexterm role="cp"><primary>remarks in the margin</primary></indexterm><indexterm role="fn"><primary>\marginpar</primary></indexterm> +Synopsis:</para> + <screen> +\marginpar[<replaceable>left</replaceable>]{<replaceable>right</replaceable>} +</screen> + <para>The <literal>\marginpar</literal> 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 <literal>\marginpar</literal> occurs.</para> + <para>When you only specify the mandatory argument <replaceable>right</replaceable>, the text +will be placed</para> + <itemizedlist mark="bullet"> + <listitem> + <para>in the right margin for one-sided layout;</para> + </listitem> + <listitem> + <para>in the outside margin for two-sided layout;</para> + </listitem> + <listitem> + <para>in the nearest margin for two-column layout.</para> + </listitem> + </itemizedlist> + <para><indexterm role="fn"><primary>\reversemarginpar</primary></indexterm><indexterm role="fn"><primary>\normalmarginpar</primary></indexterm>The command <literal>\reversemarginpar</literal> places subsequent marginal notes +in the opposite (inside) margin. <literal>\normalmarginpar</literal> places them +in the default position.</para> + <para>When you specify both arguments, <replaceable>left</replaceable> is used for the left +margin, and <replaceable>right</replaceable> 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 <literal>\hspace{0pt}</literal>.</para> + <para>These parameters affect the formatting of the note:</para> + <variablelist> + <varlistentry> + <term><literal>\marginparpush</literal></term> + <listitem> + <para>Minimum vertical space between notes; default ‘<literal>7pt</literal>’ for +‘<literal>12pt</literal>’ documents, ‘<literal>5pt</literal>’ else.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\marginparsep</literal></term> + <listitem> + <para>Horizontal space between the main text and the note; default +‘<literal>11pt</literal>’ for ‘<literal>10pt</literal>’ documents, ‘<literal>10pt</literal>’ else.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\marginparwidth</literal></term> + <listitem> + <para>Width of the note itself; default for a one-sided ‘<literal>10pt</literal>’ document +is ‘<literal>90pt</literal>’, ‘<literal>83pt</literal>’ for ‘<literal>11pt</literal>’, and ‘<literal>68pt</literal>’ for +‘<literal>12pt</literal>’; ‘<literal>17pt</literal>’ more in each case for a two-sided document. +In two column mode, the default is ‘<literal>48pt</literal>’.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + </chapter> + + <chapter label="16" id="Math-formulas"> + <title>Math formulas</title> + <para><indexterm role="cp"><primary>math formulas</primary></indexterm><indexterm role="cp"><primary>formulas, math</primary></indexterm><indexterm role="cp"><primary>math mode, entering</primary></indexterm> +<indexterm role="fn"><primary>math environment</primary></indexterm><indexterm role="fn"><primary>displaymath environment</primary></indexterm><indexterm role="fn"><primary>equation environment</primary></indexterm>There are three environments that put &latex; in math mode:</para> + <variablelist> + <varlistentry> + <term><literal>math</literal></term> + <listitem> + <para>For formulas that appear right in the text.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>displaymath</literal></term> + <listitem> + <para>For formulas that appear on their own line.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>equation</literal></term> + <listitem> + <para>The same as the displaymath environment except that it adds an equation +number in the right margin.</para> + </listitem> + </varlistentry> + </variablelist> + <para><indexterm role="fn"><primary>\(</primary></indexterm><indexterm role="fn"><primary>\)</primary></indexterm><indexterm role="fn"><primary>\[</primary></indexterm><indexterm role="fn"><primary>\]</primary></indexterm>The <literal>math</literal> environment can be used in both paragraph and LR mode, +but the <literal>displaymath</literal> and <literal>equation</literal> environments can be used +only in paragraph mode. The <literal>math</literal> and <literal>displaymath</literal> +environments are used so often that they have the following short forms:</para> + <screen> +\(...\) <lineannotation>instead of</lineannotation> \begin{math}...\end{math} +\[...\] <lineannotation>instead of</lineannotation> \begin{displaymath}...\end{displaymath} +</screen> + <para><indexterm role="fn"><primary>$</primary></indexterm>In fact, the <literal>math</literal> environment is so common that it has an even +shorter form:</para> + <screen> +$ ... $ <lineannotation>instead of</lineannotation> \(...\) +</screen> + <para><indexterm role="fn"><primary>\boldmath</primary></indexterm><indexterm role="fn"><primary>\unboldmath</primary></indexterm>The <literal>\boldmath</literal> command changes math letters and symbols to be in +a bold font. It is used <emphasis>outside</emphasis> of math mode. Conversely, the +<literal>\unboldmath</literal> command changes math glyphs to be in a normal font; +it too is used <emphasis>outside</emphasis> of math mode.</para> +<!-- xx own section? Math fonts? --> + <para><indexterm role="fn"><primary>\displaystyle</primary></indexterm>The <literal>\displaystyle</literal> declaration forces the size and style of the +formula to be that of <literal>displaymath</literal>, e.g., with limits above and +below summations. For example</para> + <screen> +$\displaystyle \sum_{n=0}^\infty x_n $ +</screen> +<!-- xx see also \cal, \mathcal --> + <sect1 label="16.1" id="Subscripts-&-Superscripts"> + <title>Subscripts & Superscripts</title> + <para><indexterm role="cp"><primary>superscript</primary></indexterm><indexterm role="cp"><primary>subscript</primary></indexterm><indexterm role="cp"><primary>exponent</primary></indexterm><indexterm role="fn"><primary>_</primary></indexterm><indexterm role="fn"><primary>^</primary></indexterm> +To get an expression <wordasword>exp</wordasword> to appear as a subscript, you just type +<literal>_{</literal><wordasword>exp</wordasword><literal>}</literal>. To get <wordasword>exp</wordasword> to appear as a +superscript, you type <literal>^{</literal><wordasword>exp</wordasword><literal>}</literal>. &latex; handles +superscripted superscripts and all of that stuff in the natural way. +It even does the right thing when something has both a subscript and a +superscript.</para> + </sect1> + + <sect1 label="16.2" id="Math-symbols"> + <title>Math symbols</title> + <para><indexterm role="cp"><primary>math symbols</primary></indexterm><indexterm role="cp"><primary>symbols, math</primary></indexterm><indexterm role="cp"><primary>greek letters</primary></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 <literal>$\pi$</literal> in your source, you will get +the pi symbol (\pi) in your output.</para> + <variablelist> + <varlistentry> + <term><literal>\|</literal></term> + <listitem> + <para>\|</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\aleph</literal></term> + <listitem> + <para>\aleph</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\alpha</literal></term> + <listitem> + <para>\alpha</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\amalg</literal></term> + <listitem> + <para>\amalg (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\angle</literal></term> + <listitem> + <para>\angle</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\approx</literal></term> + <listitem> + <para>\approx (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ast</literal></term> + <listitem> + <para>\ast (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\asymp</literal></term> + <listitem> + <para>\asymp (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\backslash</literal></term> + <listitem> + <para>\ (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\beta</literal></term> + <listitem> + <para>\beta</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigcap</literal></term> + <listitem> + <para>\bigcap</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigcirc</literal></term> + <listitem> + <para>\bigcirc (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigcup</literal></term> + <listitem> + <para>\bigcup</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigodot</literal></term> + <listitem> + <para>\bigodot</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigoplus</literal></term> + <listitem> + <para>\bigoplus</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigotimes</literal></term> + <listitem> + <para>\bigotimes</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigtriangledown</literal></term> + <listitem> + <para>\bigtriangledown (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigtriangleup</literal></term> + <listitem> + <para>\bigtriangleup (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigsqcup</literal></term> + <listitem> + <para>\bigsqcup</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\biguplus</literal></term> + <listitem> + <para>\biguplus</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigcap</literal></term> + <listitem> + <para>\bigvee</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bigwedge</literal></term> + <listitem> + <para>\bigwedge</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bot</literal></term> + <listitem> + <para>\bot</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bowtie</literal></term> + <listitem> + <para>\bowtie (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Box</literal></term> + <listitem> + <para>(square open box symbol) +<!-- xx not in plain --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bullet</literal></term> + <listitem> + <para><indexterm role="cp"><primary>bullet symbol</primary></indexterm>\bullet (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cap</literal></term> + <listitem> + <para>\cap (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cdot</literal></term> + <listitem> + <para>\cdot (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\chi</literal></term> + <listitem> + <para>\chi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\circ</literal></term> + <listitem> + <para>\circ (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\clubsuit</literal></term> + <listitem> + <para>\clubsuit</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cong</literal></term> + <listitem> + <para>\cong (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\coprod</literal></term> + <listitem> + <para>\coprod</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cup</literal></term> + <listitem> + <para>\cup (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dagger</literal></term> + <listitem> + <para>\dagger (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dashv</literal></term> + <listitem> + <para>\dashv (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ddagger</literal></term> + <listitem> + <para>\dagger (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Delta</literal></term> + <listitem> + <para>\Delta</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\delta</literal></term> + <listitem> + <para>\delta</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Diamond</literal></term> + <listitem> + <para>bigger \diamond +<!-- xx not in plain --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\diamond</literal></term> + <listitem> + <para>\diamond (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\diamondsuit</literal></term> + <listitem> + <para>\diamondsuit</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\div</literal></term> + <listitem> + <para>\div (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\doteq</literal></term> + <listitem> + <para>\doteq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\downarrow</literal></term> + <listitem> + <para>\downarrow (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Downarrow</literal></term> + <listitem> + <para>\Downarrow (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ell</literal></term> + <listitem> + <para>\ell</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\emptyset</literal></term> + <listitem> + <para>\emptyset</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\epsilon</literal></term> + <listitem> + <para>\epsilon</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\equiv</literal></term> + <listitem> + <para>\equiv (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\eta</literal></term> + <listitem> + <para>\eta</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\exists</literal></term> + <listitem> + <para>\exists</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\flat</literal></term> + <listitem> + <para>\flat</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\forall</literal></term> + <listitem> + <para>\forall</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\frown</literal></term> + <listitem> + <para>\frown (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Gamma</literal></term> + <listitem> + <para>\Gamma</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\gamma</literal></term> + <listitem> + <para>\gamma</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ge</literal></term> + <listitem> + <para>\ge</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\geq</literal></term> + <listitem> + <para>\geq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\gets</literal></term> + <listitem> + <para>\gets</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\gg</literal></term> + <listitem> + <para>\gg (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\hbar</literal></term> + <listitem> + <para>\hbar</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\heartsuit</literal></term> + <listitem> + <para>\heartsuit</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\hookleftarrow</literal></term> + <listitem> + <para>\hookleftarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\hookrightarrow</literal></term> + <listitem> + <para>\hookrightarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\iff</literal></term> + <listitem> + <para>\iff</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Im</literal></term> + <listitem> + <para>\Im</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\in</literal></term> + <listitem> + <para>\in (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\infty</literal></term> + <listitem> + <para>\infty</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\int</literal></term> + <listitem> + <para>\int</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\iota</literal></term> + <listitem> + <para>\iota</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Join</literal></term> + <listitem> + <para>condensed bowtie symbol (relation) +<!-- xx not in plain --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\kappa</literal></term> + <listitem> + <para>\kappa</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Lambda</literal></term> + <listitem> + <para>\Lambda</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lambda</literal></term> + <listitem> + <para>\lambda</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\land</literal></term> + <listitem> + <para>\land</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\langle</literal></term> + <listitem> + <para>\langle (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lbrace</literal></term> + <listitem> + <para>\lbrace (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lbrack</literal></term> + <listitem> + <para>\lbrack (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lceil</literal></term> + <listitem> + <para>\lceil (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\le</literal></term> + <listitem> + <para>\le</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\leadsto</literal></term> +<!-- xx missing from plain --> + <listitem> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Leftarrow</literal></term> + <listitem> + <para>\Leftarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\leftarrow</literal></term> + <listitem> + <para>\leftarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\leftharpoondown</literal></term> + <listitem> + <para>\leftharpoondown</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\leftharpoonup</literal></term> + <listitem> + <para>\leftharpoonup</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Leftrightarrow</literal></term> + <listitem> + <para>\Leftrightarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\leftrightarrow</literal></term> + <listitem> + <para>\leftrightarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\leq</literal></term> + <listitem> + <para>\leq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lfloor</literal></term> + <listitem> + <para>\lfloor (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lhd</literal></term> + <listitem> + <para>(left-pointing arrow head) +<!-- xx not in plain --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ll</literal></term> + <listitem> + <para>\ll (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lnot</literal></term> + <listitem> + <para>\lnot</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\longleftarrow</literal></term> + <listitem> + <para>\longleftarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\longleftrightarrow</literal></term> + <listitem> + <para>\longleftrightarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\longmapsto</literal></term> + <listitem> + <para>\longmapsto</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\longrightarrow</literal></term> + <listitem> + <para>\longrightarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lor</literal></term> + <listitem> + <para>\lor</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mapsto</literal></term> + <listitem> + <para>\mapsto</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mho</literal></term> +<!-- xx not in plain --> + <listitem> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mid</literal></term> + <listitem> + <para>\mid (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\models</literal></term> + <listitem> + <para>\models (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mp</literal></term> + <listitem> + <para>\mp (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\mu</literal></term> + <listitem> + <para>\mu</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\nabla</literal></term> + <listitem> + <para>\nabla</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\natural</literal></term> + <listitem> + <para>\natural</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ne</literal></term> + <listitem> + <para>\ne</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\nearrow</literal></term> + <listitem> + <para>\nearrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\neg</literal></term> + <listitem> + <para>\neg</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\neq</literal></term> + <listitem> + <para>\neq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ni</literal></term> + <listitem> + <para>\ni (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\not</literal></term> + <listitem> + <para>Overstrike a following operator with a /, as in \not=.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\notin</literal></term> + <listitem> + <para>\ni</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\nu</literal></term> + <listitem> + <para>\nu</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\nwarrow</literal></term> + <listitem> + <para>\nwarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\odot</literal></term> + <listitem> + <para>\odot (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\oint</literal></term> + <listitem> + <para>\oint</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Omega</literal></term> + <listitem> + <para>\Omega</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\omega</literal></term> + <listitem> + <para>\omega</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ominus</literal></term> + <listitem> + <para>\ominus (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\oplus</literal></term> + <listitem> + <para>\oplus (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\oslash</literal></term> + <listitem> + <para>\oslash (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\otimes</literal></term> + <listitem> + <para>\otimes (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\owns</literal></term> + <listitem> + <para>\owns</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\parallel</literal></term> + <listitem> + <para>\parallel (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\partial</literal></term> + <listitem> + <para>\partial</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\perp</literal></term> + <listitem> + <para>\perp (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\phi</literal></term> + <listitem> + <para>\phi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Pi</literal></term> + <listitem> + <para>\Pi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\pi</literal></term> + <listitem> + <para>\pi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\pm</literal></term> + <listitem> + <para>\pm (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\prec</literal></term> + <listitem> + <para>\prec (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\preceq</literal></term> + <listitem> + <para>\preceq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\prime</literal></term> + <listitem> + <para>\prime</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\prod</literal></term> + <listitem> + <para>\prod</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\propto</literal></term> + <listitem> + <para>\propto (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Psi</literal></term> + <listitem> + <para>\Psi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\psi</literal></term> + <listitem> + <para>\psi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rangle</literal></term> + <listitem> + <para>\rangle (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rbrace</literal></term> + <listitem> + <para>\rbrace (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rbrack</literal></term> + <listitem> + <para>\rbrack (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rceil</literal></term> + <listitem> + <para>\rceil (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Re</literal></term> + <listitem> + <para>\Re</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rfloor</literal></term> + <listitem> + <para>\rfloor</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rhd</literal></term> + <listitem> + <para>(binary operation) +<!-- xx not in plain @math{\rhd} --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rho</literal></term> + <listitem> + <para>\rho</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Rightarrow</literal></term> + <listitem> + <para>\Rightarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rightarrow</literal></term> + <listitem> + <para>\rightarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rightharpoondown</literal></term> + <listitem> + <para>\rightharpoondown</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rightharpoonup</literal></term> + <listitem> + <para>\rightharpoonup</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rightleftharpoons</literal></term> + <listitem> + <para>\rightleftharpoons</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\searrow</literal></term> + <listitem> + <para>\searrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\setminus</literal></term> + <listitem> + <para>\setminus (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sharp</literal></term> + <listitem> + <para>\sharp</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Sigma</literal></term> + <listitem> + <para>\Sigma</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sigma</literal></term> + <listitem> + <para>\sigma</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sim</literal></term> + <listitem> + <para>\sim (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\simeq</literal></term> + <listitem> + <para>\simeq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\smallint</literal></term> + <listitem> + <para>\smallint</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\smile</literal></term> + <listitem> + <para>\smile (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\spadesuit</literal></term> + <listitem> + <para>\spadesuit</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sqcap</literal></term> + <listitem> + <para>\sqcap (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sqcup</literal></term> + <listitem> + <para>\sqcup (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sqsubset</literal></term> + <listitem> + <para>(relation) +<!-- not in plain (@math{\sqsubset}) --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sqsubseteq</literal></term> + <listitem> + <para>\sqsubseteq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sqsupset</literal></term> + <listitem> + <para>(relation) +<!-- not in plain (@math{\sqsupset}) --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sqsupseteq</literal></term> + <listitem> + <para>\sqsupseteq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\star</literal></term> + <listitem> + <para>\star (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\subset</literal></term> + <listitem> + <para>\subset (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\subseteq</literal></term> + <listitem> + <para>\subseteq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\succ</literal></term> + <listitem> + <para>\succ (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\succeq</literal></term> + <listitem> + <para>\succeq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sum</literal></term> + <listitem> + <para>\sum</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\supset</literal></term> + <listitem> + <para>\supset (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\supseteq</literal></term> + <listitem> + <para>\supseteq (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\surd</literal></term> + <listitem> + <para>\surd</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\swarrow</literal></term> + <listitem> + <para>\swarrow</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\tau</literal></term> + <listitem> + <para>\tau</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\theta</literal></term> + <listitem> + <para>\theta</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\times</literal></term> + <listitem> + <para>\times (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\to</literal></term> + <listitem> + <para>\to</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\top</literal></term> + <listitem> + <para>\top</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\triangle</literal></term> + <listitem> + <para>\triangle</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\triangleleft</literal></term> + <listitem> + <para>\triangleleft (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\triangleright</literal></term> + <listitem> + <para>\triangleright (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\unlhd</literal></term> + <listitem> + <para>left-pointing arrowhead with line under (binary operation) +<!-- not in plain --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\unrhd</literal></term> + <listitem> + <para>right-pointing arrowhead with line under (binary operation) +<!-- not in plain --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Uparrow</literal></term> + <listitem> + <para>\Uparrow (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\uparrow</literal></term> + <listitem> + <para>\uparrow (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Updownarrow</literal></term> + <listitem> + <para>\Updownarrow (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\updownarrow</literal></term> + <listitem> + <para>\updownarrow (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\uplus</literal></term> + <listitem> + <para>\uplus (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Upsilon</literal></term> + <listitem> + <para>\Upsilon</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\upsilon</literal></term> + <listitem> + <para>\upsilon</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\varepsilon</literal></term> + <listitem> + <para>\varepsilon</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\varphi</literal></term> + <listitem> + <para>\varphi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\varpi</literal></term> + <listitem> + <para>\varpi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\varrho</literal></term> + <listitem> + <para>\varrho</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\varsigma</literal></term> + <listitem> + <para>\varsigma</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\vartheta</literal></term> + <listitem> + <para>\vartheta</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\vdash</literal></term> + <listitem> + <para>\vdash (relation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\vee</literal></term> + <listitem> + <para>\vee (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Vert</literal></term> + <listitem> + <para>\Vert (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\vert</literal></term> + <listitem> + <para>\vert (delimiter)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\wedge</literal></term> + <listitem> + <para>\wedge (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\wp</literal></term> + <listitem> + <para>\wp</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\wr</literal></term> + <listitem> + <para>\wr (binary operation)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Xi</literal></term> + <listitem> + <para>\Xi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\xi</literal></term> + <listitem> + <para>\xi</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\zeta</literal></term> + <listitem> + <para>\zeta</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="16.3" id="Math-functions"> + <title>Math functions</title> + <para><indexterm role="cp"><primary>math functions</primary></indexterm><indexterm role="cp"><primary>functions, math</primary></indexterm> +These commands produce roman function names in math mode with proper +spacing.</para> + <variablelist> + <varlistentry> + <term><literal>\arccos</literal></term> + <listitem> + <para>\arccos</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\arcsin</literal></term> + <listitem> + <para>\arcsin</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\arctan</literal></term> + <listitem> + <para>\arctan</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\arg</literal></term> + <listitem> + <para>\arg</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bmod</literal></term> + <listitem> + <para>Binary modulo operator (x \bmod y)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cos</literal></term> + <listitem> + <para>\cos</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cosh</literal></term> + <listitem> + <para>\cosh</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cot</literal></term> + <listitem> + <para>\cos</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\coth</literal></term> + <listitem> + <para>\cosh</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\csc</literal></term> + <listitem> + <para>\csc</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\deg</literal></term> + <listitem> + <para>\deg</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\det</literal></term> + <listitem> + <para>\deg</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dim</literal></term> + <listitem> + <para>\dim</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\exp</literal></term> + <listitem> + <para>\exp</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\gcd</literal></term> + <listitem> + <para>\gcd</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\hom</literal></term> + <listitem> + <para>\hom</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\inf</literal></term> + <listitem> + <para>\inf</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ker</literal></term> + <listitem> + <para>\ker</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lg</literal></term> + <listitem> + <para>\lg</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lim</literal></term> + <listitem> + <para>\lim</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\liminf</literal></term> + <listitem> + <para>\liminf</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\limsup</literal></term> + <listitem> + <para>\limsup</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ln</literal></term> + <listitem> + <para>\ln</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\log</literal></term> + <listitem> + <para>\log</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\max</literal></term> + <listitem> + <para>\max</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\min</literal></term> + <listitem> + <para>\min</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\pmod</literal></term> + <listitem> + <para>parenthesized modulus, as in (\pmod 2^n - 1)</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\Pr</literal></term> + <listitem> + <para>\Pr</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sec</literal></term> + <listitem> + <para>\sec</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sin</literal></term> + <listitem> + <para>\sin</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sinh</literal></term> + <listitem> + <para>\sinh</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sup</literal></term> + <listitem> + <para>\sup</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\tan</literal></term> + <listitem> + <para>\tan</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\tanh</literal></term> + <listitem> + <para>\tanh</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="16.4" id="Math-accents"> + <title>Math accents</title> + <para><indexterm role="cp"><primary>math accents</primary></indexterm><indexterm role="cp"><primary>accents, mathematical</primary></indexterm> +&latex; provides a variety of commands for producing accented letters +in math. These are different from accents in normal text +(see <xref linkend="Accents"></xref>).</para> + <variablelist> + <varlistentry> + <term><literal>\acute</literal></term> + <listitem> + <para><indexterm role="cp"><primary>acute accent, math</primary></indexterm>Math acute accent: \acutex.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\breve</literal></term> + <listitem> + <para><indexterm role="cp"><primary>breve accent, math</primary></indexterm>Math breve accent: \brevex.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\check</literal></term> + <listitem> + <para><indexterm role="cp"><primary>check accent, math</primary></indexterm><indexterm role="cp"><primary>hác<ek accent, math</primary></indexterm>Math hác<ek (check) accent: \checkx.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ddot</literal></term> + <listitem> + <para><indexterm role="cp"><primary>double dot accent, math</primary></indexterm>Math dieresis accent: \ddotx.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dot</literal></term> + <listitem> + <para><indexterm role="cp"><primary>overdot accent, math</primary></indexterm><indexterm role="cp"><primary>dot over accent, math</primary></indexterm>Math dot accent: \dotx.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\grave</literal></term> + <listitem> + <para><indexterm role="cp"><primary>grave accent, math</primary></indexterm>Math grave accent: \gravex.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\hat</literal></term> + <listitem> + <para><indexterm role="cp"><primary>hat accent, math</primary></indexterm><indexterm role="cp"><primary>circumflex accent, math</primary></indexterm>Math hat (circumflex) accent: \hatx.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\imath</literal></term> + <listitem> + <para><indexterm role="cp"><primary>dotless i, math</primary></indexterm>Math dotless i.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\jmath</literal></term> + <listitem> + <para><indexterm role="cp"><primary>dotless j, math</primary></indexterm>Math dotless j.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\tilde</literal></term> + <listitem> + <para><indexterm role="cp"><primary>tilde accent, math</primary></indexterm>Math tilde accent: \tildex.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\vec</literal></term> + <listitem> + <para><indexterm role="cp"><primary>vector symbol, math</primary></indexterm>Math vector symbol: \vecx.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\widehat</literal></term> + <listitem> + <para><indexterm role="cp"><primary>wide hat accent, math</primary></indexterm>Math wide hat accent: \widehatx+y.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\widehat</literal></term> + <listitem> + <para><indexterm role="cp"><primary>wide tile accent, math</primary></indexterm>Math wide tilde accent: \widetildex+y.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="16.5" id="Spacing-in-math-mode"> + <title>Spacing in math mode</title> + <para><indexterm role="cp"><primary>spacing within math mode</primary></indexterm><indexterm role="cp"><primary>math mode, spacing</primary></indexterm> +In a <literal>math</literal> environment, &latex; ignores the spaces you type and +puts in the spacing according to the normal rules for mathematics +texts. If you want different spacing, &latex; provides the following +commands for use in math mode:</para> + <variablelist> + <varlistentry> + <term><literal>\;</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\;</primary></indexterm>A thick space (5\over18\,quad).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\:</literal></term> + <term><literal>\></literal></term> + <listitem> + <para><indexterm role="fn"><primary>\:</primary></indexterm><indexterm role="fn"><primary>\></primary></indexterm>Both of these produce a medium space (2\over9\,quad).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\,</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\,</primary></indexterm>A thin space (1\over6\,quad); not restricted to math mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\!</literal></term> + <listitem> + <para>A negative thin space (-1\over6\,quad).</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="16.6" id="Math-Miscellany"> + <title>Math Miscellany</title> + <para><indexterm role="cp"><primary>math Miscellany</primary></indexterm></para> + <variablelist> + <varlistentry> + <term><literal>\*</literal></term> + <listitem> + <para><indexterm role="cp"><primary>discretionary multiplication</primary></indexterm><indexterm role="cp"><primary>multiplication symbol, discretionary line break</primary></indexterm>A “discretionary” multiplication symbol, at which a line break is +allowed.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\cdots</literal></term> + <listitem> + <para>A horizontal ellipsis with the dots raised to the center of the line.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ddots</literal></term> + <listitem> + <para>A diagonal ellipsis: \ddots.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\frac{num}{den}</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\frac</primary></indexterm>Produces the fraction <literal>num</literal> divided by <literal>den</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\left <replaceable>delim1</replaceable> ... \right <replaceable>delim2</replaceable></literal></term> + <listitem> + <para><indexterm role="fn"><primary>\right</primary></indexterm><indexterm role="cp"><primary>null delimiter</primary></indexterm>The two delimiters need not match; ‘<literal>.</literal>’ acts as a null delimiter, +producing no output. The delimiters are sized according to the math +in between. Example: <literal>\left( \sum_i=1^10 a_i \right]</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\overbrace{<replaceable>text</replaceable>}</literal></term> + <listitem> + <para>Generates a brace over <replaceable>text</replaceable>. +For example, \overbracex+\cdots+x^k \rm\;times.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\overline{<replaceable>text</replaceable>}</literal></term> + <listitem> + <para>Generates a horizontal line over <replaceable>tex</replaceable>. +For exampe, \overlinex+y.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\sqrt[<replaceable>root</replaceable>]{arg}</literal></term> + <listitem> + <para>Produces the representation of the square root of <replaceable>arg</replaceable>. The +optional argument <replaceable>root</replaceable> determines what root to produce. For +example, the cube root of <literal>x+y</literal> would be typed as +<literal>$\sqrt[3]{x+y}$</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\stackrel{<replaceable>text</replaceable>}{<replaceable>relation</replaceable>}</literal></term> + <listitem> + <para>Puts <replaceable>text</replaceable> above <replaceable>relation</replaceable>. For example, +<literal>\stackrel{f}{\longrightarrow}</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\underbrace{math}</literal></term> + <listitem> + <para>Generates <replaceable>math</replaceable> with a brace underneath.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\underline{text}</literal></term> + <listitem> + <para>Causes <replaceable>text</replaceable>, which may be either math mode or not, to be +underlined.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\vdots</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\vdots</primary></indexterm>Produces a vertical ellipsis.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + </chapter> + + <chapter label="17" id="Modes"> + <title>Modes</title> + <para><indexterm role="cp"><primary>modes</primary></indexterm><indexterm role="cp"><primary>paragraph mode</primary></indexterm><indexterm role="cp"><primary>math mode</primary></indexterm><indexterm role="cp"><primary>left-to-right mode</primary></indexterm><indexterm role="cp"><primary>lR mode</primary></indexterm></para> + <para>When &latex; is processing your input text, it is always in one of three +modes:</para> + <itemizedlist mark="bullet"> + <listitem> + <para>Paragraph mode</para> + </listitem> + <listitem> + <para>Math mode</para> + </listitem> + <listitem> + <para>Left-to-right mode, called LR mode for short</para> + </listitem> + </itemizedlist> + <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 <literal>\mbox</literal>, &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 <literal>\mbox</literal> +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 <literal>parbox</literal>. 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> + + <chapter label="18" id="Page-Styles"> + <title>Page Styles</title> + <para><indexterm role="cp"><primary>styles, page</primary></indexterm><indexterm role="cp"><primary>page styles</primary></indexterm> +The <literal>\documentclass</literal> command determines the size and position of +the page's head and foot. The page style determines what goes in them.</para> + + <sect1 label="18.1" id="\maketitle"> + <title><literal>\maketitle</literal></title> + <para><indexterm role="cp"><primary>titles, making</primary></indexterm><indexterm role="fn"><primary>\maketitle</primary></indexterm> +The <literal>\maketitle</literal> command generates a title on a separate title +page—except in the <literal>article</literal> 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> + <variablelist> + <varlistentry> + <term><literal>\author{<replaceable>name</replaceable> \and <replaceable>name2</replaceable>}</literal></term> + <listitem> + <para><indexterm role="cp"><primary>author, for titlepage</primary></indexterm><indexterm role="fn"><primary>\\ for <literal>\author</literal></primary></indexterm><indexterm role="fn"><primary>\and for <literal>\author</literal></primary></indexterm>The <literal>\author</literal> command declares the document author(s), where the +argument is a list of authors separated by <literal>\and</literal> commands. Use +<literal>\\</literal> to separate lines within a single author's entry—for +example, to give the author's institution or address.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\date{<replaceable>text</replaceable>}</literal></term> + <listitem> + <para><indexterm role="cp"><primary>date, for titlepage</primary></indexterm>The <literal>\date</literal> command declares <replaceable>text</replaceable> to be the document's +date. With no <literal>\date</literal> command, the current date (see <xref linkend="\today"></xref>) +is used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\thanks{<replaceable>text</replaceable>}</literal></term> + <listitem> + <para><indexterm role="cp"><primary>thanks, for titlepage</primary></indexterm><indexterm role="cp"><primary>credit footnote</primary></indexterm>The <literal>\thanks</literal> command produces a <literal>\footnote</literal> to the title, +usually used for credit acknowledgements.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\title{<replaceable>text</replaceable>}</literal></term> + <listitem> + <para><indexterm role="cp"><primary>title, for titlepage</primary></indexterm><indexterm role="fn"><primary>\\ for <literal>\title</literal></primary></indexterm>The <literal>\title</literal> command declares <replaceable>text</replaceable> to be the title of the +document. Use <literal>\\</literal> to force a line break, as usual.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="18.2" id="\pagenumbering"> + <title><literal>\pagenumbering</literal></title> + <para><indexterm role="fn"><primary>\pagenumbering</primary></indexterm><indexterm role="cp"><primary>page numbering style</primary></indexterm> +Synopsis:</para> + <screen> +\pagenumbering{<replaceable>style</replaceable>} +</screen> + <para>Specifies the style of page numbers, according to <replaceable>style</replaceable>:</para> + <variablelist> + <varlistentry> + <term><literal>arabic</literal></term> + <listitem> + <para>arabic numerals</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>roman</literal></term> + <listitem> + <para>lowercase Roman numerals</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>Roman</literal></term> + <listitem> + <para>uppercase Roman numerals</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>alph</literal></term> + <listitem> + <para>lowercase letters</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>Alph</literal></term> + <listitem> + <para>uppercase letters</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="18.3" id="\pagestyle"> + <title><literal>\pagestyle</literal></title> + <para><indexterm role="fn"><primary>\pagestyle</primary></indexterm><indexterm role="cp"><primary>header style</primary></indexterm><indexterm role="cp"><primary>footer style</primary></indexterm><indexterm role="cp"><primary>running header and footer style</primary></indexterm> +Synopsis:</para> + <screen> +\pagestyle{<replaceable>style</replaceable>} +</screen> + <para>The <literal>\pagestyle</literal> command specifies how the headers and footers +are typeset from the current page onwards. Values for <replaceable>style</replaceable>:</para> + <variablelist> + <varlistentry> + <term><literal>plain</literal></term> + <listitem> + <para>Just a plain page number.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>empty</literal></term> + <listitem> + <para>Empty headers and footers, e.g., no page numbers.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>headings</literal></term> + <listitem> + <para>Put running headers on each page. The document style specifies what +goes in the headers.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>myheadings</literal></term> + <listitem> + <para>Custom headers, specified via the <literal>\markboth</literal> or the +<literal>\markright</literal> commands.</para> + </listitem> + </varlistentry> + </variablelist> + <para>Here are the descriptions of <literal>\markboth</literal> and <literal>\markright</literal>:</para> + <variablelist> + <varlistentry> + <term><literal>\markboth{<replaceable>left</replaceable>}{<replaceable>right</replaceable>}</literal></term> + <listitem> + <para>Sets both the left and the right heading. A “left-hand heading” +(<replaceable>left</replaceable>) is generated by the last <literal>\markboth</literal> command before +the end of the page, while a “right-hand heading” (<replaceable>right</replaceable> is +generated by the first <literal>\markboth</literal> or <literal>\markright</literal> that +comes on the page if there is one, otherwise by the last one before +the page.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\markright{<replaceable>right</replaceable>}</literal></term> + <listitem> + <para>Sets the right heading, leaving the left heading unchanged.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="18.4" id="\thispagestyle"> + <title><literal>\thispagestyle{<replaceable>style</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\thispagestyle</primary></indexterm> +The <literal>\thispagestyle</literal> command works in the same manner as the +<literal>\pagestyle</literal> command (see previous section) except that it +changes to <replaceable>style</replaceable> for the current page only.</para> + </sect1> + </chapter> + + <chapter label="19" id="Spaces"> + <title>Spaces</title> + <para><indexterm role="cp"><primary>spaces</primary></indexterm> +&latex; has many ways to produce white (or filled) space.</para> + <para>Another space-producing command is <literal>\,</literal> to produce a “thin” +space (usually 1/6quad). It can be used in text mode, but is +more often useful in math mode (see <xref linkend="Spacing-in-math-mode"></xref>).</para> + + <sect1 label="19.1" id="\hspace"> + <title><literal>\hspace</literal></title> + <para><indexterm role="fn"><primary>\hspace</primary></indexterm> +Synopsis:</para> + <screen> +\hspace[*]{<replaceable>length</replaceable>} +</screen> + <para>The <literal>\hspace</literal> command adds horizontal space. The <replaceable>length</replaceable> +argument can be expressed in any terms that &latex; understands: +points, inches, etc. It is a rubber length. You can add both +negative and positive space with an <literal>\hspace</literal> command; adding +negative space is like backspacing.</para> + <para>&latex; normally removes horizontal space that comes at the beginning +or end of a line. To preserve this space, use the optional <literal>*</literal> +form.</para> + </sect1> + + <sect1 label="19.2" id="\hfill"> + <title><literal>\hfill</literal></title> + <para><indexterm role="fn"><primary>\hfill</primary></indexterm>The <literal>\hfill</literal> fill command produces a “rubber length” which has +no natural space but can stretch or shrink horizontally as far as +needed.</para> + <para><indexterm role="fn"><primary>\fill</primary></indexterm>The <literal>\fill</literal> parameter is the rubber length itself (technically, +the glue value ‘<literal>0pt plus1fill</literal>’); thus, <literal>\hspace\fill</literal> is +equivalent to <literal>\hfill</literal>.</para> + </sect1> + + <sect1 label="19.3" id="\SPACE"> + <title><literal>\SPACE</literal></title> + <para><indexterm role="fn"><primary>\SPACE</primary></indexterm><indexterm role="fn"><primary>\TAB</primary></indexterm><indexterm role="fn"><primary>\NEWLINE</primary></indexterm> +The <literal>\ </literal> (space) command produces a normal interword space. It's +useful after punctuation which shouldn't end a sentence. For example +<literal>Knuth's article in Proc.\ Amer.\ Math\. Soc.\ is fundamental</literal>. +It is also often used after control sequences, as in <literal>\TeX\ is a +nice system.</literal></para> + <para>In normal circumstances, <literal>\</literal><keycap>tab</keycap> and <literal>\</literal><keycap>newline</keycap> +are equivalent to <literal>\ </literal>.</para> + </sect1> + + <sect1 label="19.4" id="\AT"> + <title><literal>\@</literal></title> + <para><indexterm role="fn"><primary>\@</primary></indexterm> +The <literal>\@</literal> command makes the following punctuation character end a +sentence even if it normally would not. This is typically used after +a capital letter. Here are side-by-side examples with and without +<literal>\@</literal>:</para> + <screen> +… in C\@. Pascal, though … +… in C. Pascal, though … +</screen> + <para role="continues">produces</para> +<!-- Texinfo does it differently, but the result is the same. --> + <blockquote> + <para>… in C. Pascal, though … +… in C. Pascal, though …</para> + </blockquote> + </sect1> + + <sect1 label="19.5" id="\thinspace"> + <title><literal>\thinspace</literal></title> + <para><indexterm role="fn"><primary>\thinspace</primary></indexterm> +<literal>\thinspace</literal> 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 '”.</para> + </sect1> + + <sect1 label="19.6" id="\/"> + <title><literal>\/</literal></title> + <para><indexterm role="fn"><primary>\/</primary></indexterm> +The <literal>\/</literal> command produces an <firstterm>italic correction</firstterm>. This is a +small space defined by the font designer for a given character, +to avoid the character colliding with whatever follows. The italic +<wordasword>f</wordasword> 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 +<wordasword>f: f;</wordasword> (in the &tex; output, the `f's are nicely separated) +with <wordasword>f: f;</wordasword>.</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> + </sect1> + + <sect1 label="19.7" id="\hrulefill"> + <title><literal>\hrulefill</literal></title> + <para><indexterm role="fn"><primary>\hrulefill</primary></indexterm> +The <literal>\hrulefill</literal> fill command produces a “rubber length” which can +stretch or shrink horizontally. It will be filled with a horizontal +rule.</para> + </sect1> + + <sect1 label="19.8" id="\dotfill"> + <title><literal>\dotfill</literal></title> + <para><indexterm role="fn"><primary>\dotfill</primary></indexterm> +The <literal>\dotfill</literal> command produces a “rubber length” that fills +with dots instead of just white space.</para> +<!-- xx undone --> + </sect1> + + <sect1 label="19.9" id="\addvspace"> + <title><literal>\addvspace</literal></title> + <para><indexterm role="fn"><primary>\addvspace</primary></indexterm><indexterm role="cp"><primary>vertical space</primary></indexterm><indexterm role="cp"><primary>space, inserting vertical</primary></indexterm> +<literal>\addvspace{length}</literal></para> + <para>The <literal>\addvspace</literal> command normally adds a vertical space of height +length. However, if vertical space has already been added to the same +point in the output by a previous <literal>\addvspace</literal> command, then this +command will not add more space than needed to make the natural length +of the total vertical space equal to <literal>length</literal>.</para> + </sect1> + + <sect1 label="19.10" id="\bigskip-\medskip-\smallskip"> + <title><literal>\bigskip \medskip \smallskip</literal></title> + <para>These commands produce a given amount of space.</para> + <variablelist> + <varlistentry> + <term><literal>\bigskip</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\bigskip</primary></indexterm><indexterm role="fn"><primary>\bigskipamount</primary></indexterm>The same as <literal>\vspace{bigskipamount}</literal>, ordinarily about one line +space (with stretch and shrink).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\medskip</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\medskip</primary></indexterm><indexterm role="fn"><primary>\medskipamount</primary></indexterm>The same as <literal>\vspace{medskipamount}</literal>, ordinarily +about half of a line space (with stretch and shrink).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\smallskip</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\smallskip</primary></indexterm><indexterm role="fn"><primary>\smallskipamount</primary></indexterm>The same as <literal>\vspace{smallskipamount}</literal>, ordinarily about a +quarter of a line space (with stretch and shrink).</para> + </listitem> + </varlistentry> + </variablelist> + <para>The <literal>\...amount</literal> parameters are determined by the document class.</para> + </sect1> + + <sect1 label="19.11" id="\vfill"> + <title><literal>\vfill</literal></title> + <para><indexterm role="fn"><primary>\vfill</primary></indexterm> +The <literal>\vfill</literal> fill command produces a rubber length (glue) which +can stretch or shrink vertically as far as needed. It's equivalent to +<literal>\vspace{\fill}</literal> (see <xref linkend="\hfill"></xref>).</para> + </sect1> + + <sect1 label="19.12" id="\vspace"> + <title><literal>\vspace[*]{<replaceable>length</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\vspace</primary></indexterm> +Synopsis:</para> + <screen> +\vspace[*]{<replaceable>length</replaceable>} +</screen> + <para>The <literal>\vspace</literal> command adds the vertical space <replaceable>length</replaceable>, i.e., +a rubber length. <replaceable>length</replaceable> can be negative or positive.</para> + <para>Ordinarily, &latex; removes vertical space added by <literal>\vspace</literal> at +the top or bottom of a page. With the optional <literal>*</literal> argument, the +space is not removed.</para> + </sect1> + </chapter> + + <chapter label="20" id="Boxes"> + <title>Boxes</title> + <para><indexterm role="cp"><primary>boxes</primary></indexterm> +All the predefined length parameters (see <xref linkend="Predefined-lengths"></xref>) can be +used in the arguments of the box-making commands.</para> + + <sect1 label="20.1" id="\mbox"> + <title><literal>\mbox{<replaceable>text}</replaceable></literal></title> + <para><indexterm role="fn"><primary>\mbox</primary></indexterm> +<indexterm role="cp"><primary>hyphenation, preventing</primary></indexterm>The <literal>\mbox</literal> command creates a box just wide enough to hold the +text created by its argument. The <replaceable>text</replaceable> is not broken into +lines, so it can be used to prevent hyphenation.</para> + </sect1> + + <sect1 label="20.2" id="\fbox-and-\framebox"> + <title><literal>\fbox</literal> and <literal>\framebox</literal></title> + <para><indexterm role="fn"><primary>\fbox</primary></indexterm><indexterm role="fn"><primary>\framebox</primary></indexterm> +Synopses:</para> + <screen> +\fbox{<replaceable>text</replaceable>} +\framebox[<replaceable>width</replaceable>][<replaceable>position</replaceable>]{<replaceable>text</replaceable>} +</screen> + <para>The <literal>\fbox</literal> and <literal>\framebox</literal> commands are like <literal>\mbox</literal>, +except that they put a frame around the outside of the box being created.</para> + <para>In addition, the <literal>\framebox</literal> command allows for explicit +specification of the box width with the optional <replaceable>width</replaceable> argument +(a dimension), and positioning with the optional <replaceable>position</replaceable> +argument. +<!-- xxref --> +<indexterm role="fn"><primary>\fboxrule</primary></indexterm><indexterm role="fn"><primary>\fboxsep</primary></indexterm>Both commands produce a rule of thickness <literal>\fboxrule</literal> (default +‘<literal>.4pt</literal>’), and leave a space of <literal>\fboxsep</literal> (default +‘<literal>3pt</literal>’) between the rule and the contents of the box.</para> + <para>See <xref linkend="\framebox-(picture)"></xref>, for the <literal>\framebox</literal> command in the +<literal>picture</literal> environment.</para> + </sect1> + + <sect1 label="20.3" id="lrbox"> + <title><literal>lrbox</literal></title> + <para><indexterm role="fn"><primary>lrbox</primary></indexterm> +<literal>\begin{lrbox}{cmd} text \end{lrbox}</literal></para> + <para>This is the environment form of <literal>\sbox</literal>.</para> + <para>The text inside the environment is saved in the box <literal>cmd</literal>, which +must have been declared with <literal>\newsavebox</literal>.</para> + </sect1> + + <sect1 label="20.4" id="\makebox"> + <title><literal>\makebox</literal></title> + <para><indexterm role="fn"><primary>\makebox</primary></indexterm> +Synopsis:</para> + <screen> +\makebox[<replaceable>width</replaceable>][<replaceable>position</replaceable>]{<replaceable>text</replaceable>} +</screen> + <para>The <literal>\makebox</literal> command creates a box just wide enough to contain +the <replaceable>text</replaceable> specified. The width of the box is specified by the +optional <replaceable>width</replaceable> argument. The position of the text within the box +is determined by the optional <replaceable>position</replaceable> argument, which may take +the following values:</para> + <variablelist> + <varlistentry> + <term><literal>c</literal></term> + <listitem> + <para>Centered (default).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>l</literal></term> + <listitem> + <para>Flush left.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>r</literal></term> + <listitem> + <para>Flush right.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>s</literal></term> + <listitem> + <para>Stretch (justify) across entire <replaceable>width</replaceable>; <replaceable>text</replaceable> must contain +stretchable space for this to work.</para> + </listitem> + </varlistentry> + </variablelist> + <para><literal>\makebox</literal> is also used within the picture environment +see <xref linkend="\makebox-(picture)"></xref>.</para> + </sect1> + + <sect1 label="20.5" id="\parbox"> + <title><literal>\parbox</literal></title> + <para><indexterm role="fn"><primary>\parbox</primary></indexterm> +Synopsis:</para> + <screen> +\parbox[<replaceable>position</replaceable>][<replaceable>height</replaceable>][<replaceable>inner-pos</replaceable>]{<replaceable>width</replaceable>}{<replaceable>text</replaceable>} +</screen> + <para>The <literal>\parbox</literal> command produces a box whose contents are created +in <literal>paragraph</literal> 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 +<literal>\parbox</literal> argument. For larger pieces of text, including ones +containing a paragraph-making environment, you should use a +<literal>minipage</literal> environment (see <xref linkend="minipage"></xref>).</para> + <para><literal>\parbox</literal> has two mandatory arguments:</para> + <variablelist> + <varlistentry> + <term><replaceable>width</replaceable></term> + <listitem> + <para>the width of the parbox;</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>text</replaceable></term> + <listitem> + <para>the text that goes inside the parbox.</para> + </listitem> + </varlistentry> + </variablelist> + <para>The optional <replaceable>position</replaceable> 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 <replaceable>height</replaceable> argument overrides the natural height of the box.</para> + <para>The <replaceable>inner-pos</replaceable> argument controls the placement of the text inside +the box, as follows; if it is not specified, <replaceable>position</replaceable> is used.</para> + <variablelist> + <varlistentry> + <term><literal>t</literal></term> + <listitem> + <para>text is placed at the top of the box.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>c</literal></term> + <listitem> + <para>text is centered in the box.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>b</literal></term> + <listitem> + <para>text is placed at the bottom of the box.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>s</literal></term> + <listitem> + <para>stretch vertically; the text must contain vertically stretchable space +for this to work.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="20.6" id="\raisebox"> + <title><literal>\raisebox</literal></title> + <para><indexterm role="fn"><primary>\raisebox</primary></indexterm> +Synopsis:</para> + <screen> +\raisebox{distance}[<replaceable>height</replaceable>][<replaceable>depth</replaceable>]{text} +</screen> + <para>The <literal>\raisebox</literal> command raises or lowers <replaceable>text</replaceable>. The first +mandatory argument specifies how high <replaceable>text</replaceable> is to be raised (or +lowered if it is a negative amount). <replaceable>text</replaceable> itself is processed +in LR mode.</para> + <para>The optional arguments <replaceable>height</replaceable> and <replaceable>depth</replaceable> are dimensions. +If they are specified, &latex; treats <replaceable>text</replaceable> as extending a +certain distance above the baseline (height) or below (depth), +ignoring its natural height and depth.</para> + </sect1> + + <sect1 label="20.7" id="\savebox"> + <title><literal>\savebox</literal></title> + <para><indexterm role="fn"><primary>\savebox</primary></indexterm> +Synopsis:</para> + <screen> +\savebox{<replaceable>\boxcmd</replaceable>}[<replaceable>width</replaceable>][<replaceable>pos</replaceable>]{<replaceable>text</replaceable>} +</screen> + <para>This command typeset <replaceable>text</replaceable> in a box just as with <literal>\makebox</literal> +(see <xref linkend="\makebox"></xref>), except that instead of printing the resulting box, +it saves it in the box labeled <replaceable>\boxcmd</replaceable>, which must have been +declared with <literal>\newsavebox</literal> (see <xref linkend="\newsavebox"></xref>).</para> + </sect1> + + <sect1 label="20.8" id="\sbox"> + <title><literal>\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\sbox</primary></indexterm> +Synopsis:</para> + <screen> +\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>} +</screen> + <para><literal>\sbox</literal> types <replaceable>text</replaceable> in a box just as with <literal>\mbox</literal> +(see <xref linkend="\mbox"></xref>) except that instead of the resulting box being +included in the normal output, it is saved in the box labeled +<replaceable>\boxcmd</replaceable>. <replaceable>\boxcmd</replaceable> must have been previously declared with +<literal>\newsavebox</literal> (see <xref linkend="\newsavebox"></xref>).</para> + </sect1> + + <sect1 label="20.9" id="\usebox"> + <title><literal>\usebox{<replaceable>\boxcmd</replaceable></literal></title> + <para><indexterm role="fn"><primary>\usebox</primary></indexterm> +Synopsis:</para> + <screen> +\usebox{<replaceable>\boxcmd</replaceable>} +</screen> + <para><literal>\usebox</literal> producesthe box most recently saved in the bin +<replaceable>\boxcmd</replaceable> by a <literal>\savebox</literal> command (see <xref linkend="\savebox"></xref>).</para> + </sect1> + </chapter> + + <chapter label="21" id="Special-insertions"> + <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> + + <sect1 label="21.1" id="Reserved-characters"> + <title>Reserved characters</title> + <para><indexterm role="cp"><primary>reserved characters</primary></indexterm><indexterm role="cp"><primary>characters, reserved</primary></indexterm> +The following characters play a special role in &latex; and are called +“reserved characters” or “special characters”.</para> + <screen> +# $ % & ~ _ ^ \ { } +</screen> + <para><indexterm role="fn"><primary>\#</primary></indexterm><indexterm role="fn"><primary>\$</primary></indexterm><indexterm role="fn"><primary>\%</primary></indexterm><indexterm role="fn"><primary>\&</primary></indexterm><indexterm role="fn"><primary>\_</primary></indexterm><indexterm role="fn"><primary>\{</primary></indexterm><indexterm role="fn"><primary>\}</primary></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 <literal>\</literal> in front of the character. For +example, <literal>\$</literal> will produce <literal>$</literal> in your output.</para> + <para><indexterm role="fn"><primary>\backslash</primary></indexterm>One exception to this rule is <literal>\</literal> itself, because <literal>\\</literal> has +its own special (context-dependent) meaning. A roman \ is produced by +typing <literal>$\backslash$</literal> in your file, and a typewriter <literal>\</literal> is +produced by using ‘<literal>\</literal>’ in a verbatim command (see <xref linkend="verbatim"></xref>).</para> + <para><indexterm role="fn"><primary>\~</primary></indexterm><indexterm role="fn"><primary>\^</primary></indexterm>Also, <literal>\~</literal> and <literal>\^</literal> place tilde and circumflex accents over +the following letter, as in õ and ô (see <xref linkend="Accents"></xref>); to get +a standalone <literal>~</literal> or <literal>^</literal>, you can again use a verbatim +command.</para> + <para><indexterm role="fn"><primary>\symbol</primary></indexterm><indexterm role="cp"><primary>accessing any character of a font</primary></indexterm> +Finally, you can access any character of the current font once you +know its number by using the <literal>\symbol</literal> command. For example, the +visible space character used in the <literal>\verb*</literal> command has the code +decimal 32, so it can be typed as <literal>\symbol{32}</literal>.</para> + <para>You can also specify octal numbers with <literal>'</literal> or hexadecimal numbers +with <literal>"</literal>, so the previous example could also be written as +<literal>\symbol{'40}</literal> or <literal>\symbol{"20}</literal>.</para> + </sect1> + + <sect1 label="21.2" id="Text-symbols"> + <title>Text symbols</title> + <para><indexterm role="cp"><primary>text symbols</primary></indexterm>&latex; provides commands to generate a number of non-letter symbols +in running text.</para> + <variablelist> + <varlistentry> + <term><literal>\copyright</literal></term> + <listitem> + <para><indexterm role="cp"><primary>copyright symbol</primary></indexterm>The copyright symbol, ©.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\dag</literal></term> + <listitem> + <para><indexterm role="cp"><primary>dagger, in text</primary></indexterm>The dagger symbol (in text).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ddag</literal></term> + <listitem> + <para><indexterm role="cp"><primary>double dagger, in text</primary></indexterm>The double dagger symbol (in text).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\LaTeX</literal></term> + <listitem> + <para><indexterm role="cp"><primary>&latex; logo</primary></indexterm><indexterm role="cp"><primary>logo, &latex;</primary></indexterm>The &latex; logo.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ldots</literal></term> + <listitem> + <para><indexterm role="cp"><primary>ellipsis</primary></indexterm>An ellipsis (three dots at the baseline): `…'. This +command also works in math mode.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\lq</literal></term> + <listitem> + <para><indexterm role="cp"><primary>left quote</primary></indexterm><indexterm role="cp"><primary>opening quote</primary></indexterm>Left (opening) quote: `.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\P</literal></term> + <listitem> + <para><indexterm role="cp"><primary>paragraph sign</primary></indexterm><indexterm role="cp"><primary>pilcrow</primary></indexterm>Paragraph sign (pilcrow).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\pounds</literal></term> + <listitem> + <para><indexterm role="cp"><primary>pounds symbol</primary></indexterm><indexterm role="cp"><primary>sterling symbol</primary></indexterm>English pounds sterling.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\rq</literal></term> + <listitem> + <para><indexterm role="cp"><primary>right quote</primary></indexterm><indexterm role="cp"><primary>closing quote</primary></indexterm>Right (closing) quote: '.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\S</literal></term> + <listitem> + <para><indexterm role="cp"><primary>section symbol</primary></indexterm>Section symbol.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\TeX</literal></term> + <listitem> + <para><indexterm role="cp"><primary>&tex; logo</primary></indexterm><indexterm role="cp"><primary>logo, &tex;</primary></indexterm>The &tex; logo.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="21.3" id="Accents"> + <title>Accents</title> + <para><indexterm role="cp"><primary>accents</primary></indexterm><indexterm role="cp"><primary>characters, accented</primary></indexterm><indexterm role="cp"><primary>letters, accented</primary></indexterm> +&latex; has wide support for many of the world's scripts and +languages, through the <literal>babel</literal> 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> + <variablelist> + <varlistentry> + <term><literal>\"</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\" (umlaut accent)</primary></indexterm><indexterm role="cp"><primary>umlaut accent</primary></indexterm>Produces an umlaut, as in ö.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\'</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\' (acute accent)</primary></indexterm><indexterm role="cp"><primary>acute accent</primary></indexterm>Produces an acute accent, as in ó. In the <literal>tabbing</literal> +environment, pushes current column to the right of the previous column +(see <xref linkend="tabbing"></xref>).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\.</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\. (dot-over accent)</primary></indexterm><indexterm role="cp"><primary>dot accent</primary></indexterm><indexterm role="cp"><primary>dot-over accent</primary></indexterm>Produces a dot accent over the following, as in o..</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\=</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\= (macron accent)</primary></indexterm><indexterm role="cp"><primary>macron accent</primary></indexterm><indexterm role="cp"><primary>overbar accent</primary></indexterm><indexterm role="cp"><primary>bar-over accent</primary></indexterm>Produces a macron (overbar) accent over the following, as in o¯.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\^</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\^ (circumflex accent)</primary></indexterm><indexterm role="cp"><primary>circumflex accent</primary></indexterm><indexterm role="cp"><primary>hat accent</primary></indexterm>Produces a circumflex (hat) accent over the following, as in ô.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\`</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\` (grave accent)</primary></indexterm><indexterm role="cp"><primary>grave accent</primary></indexterm>Produces a grave accent over the following, as in ò. In the +<literal>tabbing</literal> environment, move following text to the right margin +(see <xref linkend="tabbing"></xref>).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\~</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\~ (tilde accent)</primary></indexterm><indexterm role="cp"><primary>tilde accent</primary></indexterm>Produces a tilde accent over the following, as in ñ.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\b</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\b (bar-under accent)</primary></indexterm><indexterm role="cp"><primary>bar-under accent</primary></indexterm>Produces a bar accent under the following, as in o_.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\bar</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\bar (macron, bar-over accent)</primary></indexterm><indexterm role="cp"><primary>bar-over accent</primary></indexterm><indexterm role="cp"><primary>macron accent</primary></indexterm>Produces a macron accent over the following, as in o¯.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\c</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\c (cedilla accent)</primary></indexterm><indexterm role="cp"><primary>cedilla accent</primary></indexterm>Produces a cedilla accent under the following, as in +<!-- {c}. --></para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\d</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\d (dot-under accent)</primary></indexterm><indexterm role="cp"><primary>dot-under accent</primary></indexterm>Produces a dot accent under the following, as in .o.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\H</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\H (Hungarian umlaut accent)</primary></indexterm><indexterm role="cp"><primary>hungarian umlaut accent</primary></indexterm>Produces a long Hungarian umlaut accent over the following, as in o''.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\i</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\i (dotless i)</primary></indexterm><indexterm role="cp"><primary>dotless i</primary></indexterm>Produces a dotless i, as in `i'.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\j</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\j (dotless j)</primary></indexterm><indexterm role="cp"><primary>dotless j</primary></indexterm>Produces a dotless j, as in `j'.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\t</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\t (tie-after accent)</primary></indexterm><indexterm role="cp"><primary>tie-after accent</primary></indexterm>Produces a tie-after accent, as in `oo['.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\u</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\u (breve accent)</primary></indexterm><indexterm role="cp"><primary>breve accent</primary></indexterm>Produces a breve accent, as in `o('.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\v</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\v (breve accent)</primary></indexterm><indexterm role="cp"><primary>hacek accent</primary></indexterm><indexterm role="cp"><primary>check accent</primary></indexterm>Produces a hác<ek (check) accent, as in `o<'.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="21.4" id="Non-English-characters"> + <title>Non-English characters</title> + <para><indexterm role="cp"><primary>special characters</primary></indexterm><indexterm role="cp"><primary>non-English characters</primary></indexterm><indexterm role="cp"><primary>characters, non-English</primary></indexterm><indexterm role="cp"><primary>letters, non-English</primary></indexterm> +Here are the basic &latex; commands for inserting characters commonly +used in languages other than English.</para> + <variablelist> + <varlistentry> + <term><literal>\aa</literal></term> + <term><literal>\AA</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\aa (å)</primary></indexterm><indexterm role="fn"><primary>\AA (Å)</primary></indexterm><indexterm role="cp"><primary>aring</primary></indexterm>å and Å.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ae</literal></term> + <term><literal>\AE</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\ae (æ)</primary></indexterm><indexterm role="fn"><primary>\AE (Æ)</primary></indexterm><indexterm role="cp"><primary>ae ligature</primary></indexterm>æ and Æ.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\l</literal></term> + <term><literal>\L</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\l (/l)</primary></indexterm><indexterm role="fn"><primary>\L (/L)</primary></indexterm><indexterm role="cp"><primary>polish l</primary></indexterm>/l and /L.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\o</literal></term> + <term><literal>\O</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\o (ø)</primary></indexterm><indexterm role="fn"><primary>\O (Ø)</primary></indexterm><indexterm role="cp"><primary>oslash</primary></indexterm>ø and Ø.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\oe</literal></term> + <term><literal>\OE</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\oe (œ)</primary></indexterm><indexterm role="fn"><primary>\OE (Œ)</primary></indexterm><indexterm role="cp"><primary>oe ligature</primary></indexterm>œ and Œ.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>\ss</literal></term> + <listitem> + <para><indexterm role="fn"><primary>\ss (ß)</primary></indexterm><indexterm role="cp"><primary>es-zet German letter</primary></indexterm><indexterm role="cp"><primary>sharp S letters</primary></indexterm>ß.</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="21.5" id="\rule"> + <title><literal>\rule</literal></title> + <para><indexterm role="fn"><primary>\rule</primary></indexterm> +Synopsis:</para> + <screen> +\rule[<replaceable>raise</replaceable>]{<replaceable>width</replaceable>}{<replaceable>thickness</replaceable>} +</screen> + <para>The <literal>\rule</literal> command produces <firstterm>rules</firstterm>, that is, lines or +rectangles. The arguments are:</para> + <variablelist> + <varlistentry> + <term><replaceable>raise</replaceable></term> + <listitem> + <para>How high to raise the rule (optional).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>width</replaceable></term> + <listitem> + <para>The length of the rule (mandatory).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>thickness</replaceable></term> + <listitem> + <para>The thickness of the rule (mandatory).</para> + </listitem> + </varlistentry> + </variablelist> + </sect1> + + <sect1 label="21.6" id="\today"> + <title><literal>\today</literal></title> + <para><indexterm role="fn"><primary>\today</primary></indexterm> +The <literal>\today</literal> command produces today's date, in the format +‘<literal><replaceable>month</replaceable> <replaceable>dd</replaceable>, <replaceable>yyyy</replaceable></literal>’; for example, `July 4, 1976'. +It uses the predefined counters <literal>\day</literal>, <literal>\month</literal>, and +<literal>\year</literal> (see <xref linkend="\day-\month-\year"></xref>) to do this. It is not +updated as the program runs.</para> + <para><indexterm role="cp"><primary><literal>datetime</literal> package</primary></indexterm>The <literal>datetime</literal> package, among others, can produce a wide variety +of other date formats.</para> + </sect1> + </chapter> + + <chapter label="22" id="Splitting-the-input"> + <title>Splitting the input</title> + <para><indexterm role="cp"><primary>splitting the input file</primary></indexterm><indexterm role="cp"><primary>input file</primary></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> + + <sect1 label="22.1" id="\include"> + <title><literal>\include</literal></title> + <para><indexterm role="fn"><primary>\include</primary></indexterm> +Synopsis:</para> + <screen> +\include{<replaceable>file</replaceable>} +</screen> + <para>If no <literal>\includeonly</literal> command is present, the <literal>\include</literal> +command executes <literal>\clearpage</literal> to start a new page +(see <xref linkend="\clearpage"></xref>), then reads <replaceable>file</replaceable>, then does another +<literal>\clearpage</literal>.</para> + <para>Given an <literal>\includeonly</literal> command, the <literal>\include</literal> actions are +only run if <replaceable>file</replaceable> is listed as an argument to +<literal>\includeonly</literal>. See the next section.</para> + <para><indexterm role="cp"><primary>nested <literal>\include</literal>, not allowed</primary></indexterm>The <literal>\include</literal> command may not appear in the preamble or in a file +read by another <literal>\include</literal> command.</para> + </sect1> + + <sect1 label="22.2" id="\includeonly"> + <title>\<literal>includeonly</literal></title> + <para><indexterm role="fn"><primary>\includeonly</primary></indexterm> +Synopsis:</para> + <screen> +\includeonly{<replaceable>file1</replaceable>,<replaceable>file2</replaceable>,...} +</screen> + <para>The <literal>\includeonly</literal> command controls which files will be read by +subsequent <literal>\include</literal> commands. The list of filenames is +comma-separated. Each <replaceable>file</replaceable> must exactly match a filename +specified in a <literal>\include</literal> command for the selection to be +effective.</para> + <para>This command can only appear in the preamble.</para> + </sect1> + + <sect1 label="22.3" id="\input"> + <title>\input</title> + <para><indexterm role="fn"><primary>\input</primary></indexterm> +Synopsis:</para> + <screen> +\input{<replaceable>file</replaceable>} +</screen> + <para>The <literal>\input</literal> command causes the specified <replaceable>file</replaceable> to be read +and processed, as if its contents had been inserted in the current +file at that point.</para> + <para>If <replaceable>file</replaceable> does not end in ‘<literal>.tex</literal>’ (e.g., ‘<literal>foo</literal>’ or +‘<literal>foo.bar</literal>’), it is first tried with that extension (‘<literal>foo.tex</literal>’ +or ‘<literal>foo.bar.tex</literal>’). If that is not found, the original <replaceable>file</replaceable> +is tried (‘<literal>foo</literal>’ or ‘<literal>foo.bar</literal>’).</para> + </sect1> + </chapter> + + <chapter label="23" id="Front/back-matter"> + <title>Front/back matter</title> + <sect1 label="23.1" id="Tables-of-contents"> + <title>Tables of contents</title> + <para><indexterm role="cp"><primary>table of contents, creating</primary></indexterm> +<indexterm role="fn"><primary>\tableofcontents</primary></indexterm>A table of contents is produced with the <literal>\tableofcontents</literal> +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 <filename>.toc</filename> file.</para> + <para>The <literal>\tableofcontents</literal> 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 <literal>\newpage</literal> command after the +<literal>\tableofcontents</literal> command.</para> + <para><indexterm role="fn"><primary>\listoffigures</primary></indexterm><indexterm role="fn"><primary>\listoftables</primary></indexterm>The analagous commands <literal>\listoffigures</literal> and <literal>\listoftables</literal> +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 role="fn"><primary>\nofiles</primary></indexterm>The command <literal>\nofiles</literal> overrides these commands, and +<emphasis>prevents</emphasis> any of these lists from being generated.</para> + + <sect2 label="23.1.1" id="\addcontentsline"> + <title>\addcontentsline</title> + <para><indexterm role="fn"><primary>\addcontentsline{<replaceable>ext</replaceable>}{<replaceable>unit</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm><indexterm role="cp"><primary>table of contents entry, manually adding</primary></indexterm> +The <literal>\addcontentsline</literal> command adds an entry to the specified list +or table where:</para> + <variablelist> + <varlistentry> + <term><replaceable>ext</replaceable></term> + <listitem> + <para>The extension of the file on which information is to be written, +typically one of: <literal>toc</literal> (table of contents), <literal>lof</literal> (list of +figures), or <literal>lot</literal> (list of tables).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>unit</replaceable></term> + <listitem> + <para>The name of the sectional unit being added, typically one of the +following, matching the value of the <replaceable>ext</replaceable> argument:</para> + <variablelist> + <varlistentry> + <term><literal>toc</literal></term> + <listitem> + <para>The name of the sectional unit: <literal>part</literal>, <literal>chapter</literal>, +<literal>section</literal>, <literal>subsection</literal>, <literal>subsubsection</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>lof</literal></term> + <listitem> + <para>For the list of figures.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>lot</literal></term> + <listitem> + <para>For the list of tables.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>entry</replaceable></term> + <listitem> + <para>The actual text of the entry.</para> + </listitem> + </varlistentry> + </variablelist> + <para><indexterm role="fn"><primary>\contentsline</primary></indexterm>What is written to the <filename>.<replaceable>ext</replaceable></filename> file is the +command <literal>\contentsline{<replaceable>unit</replaceable>}{<replaceable>name</replaceable>}</literal>.</para> +<!-- ?? how hardwired are these values? other unit names? --> + </sect2> + + <sect2 label="23.1.2" id="\addtocontents"> + <title>\addtocontents</title> + <para><indexterm role="fn"><primary>\addtocontents{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm> +The <literal>\addtocontents</literal> command adds text (or formatting commands) +directly to the <filename>.</filename><replaceable>ext</replaceable> file that generates the table of +contents or lists of figures or tables.</para> + <variablelist> + <varlistentry> + <term><replaceable>ext</replaceable></term> + <listitem> + <para>The extension of the file on which information is to be written: +<filename>toc</filename> (table of contents), <filename>lof</filename> (list of figures), or +<filename>lot</filename> (list of tables).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><replaceable>text</replaceable></term> + <listitem> + <para>The text to be written.</para> + </listitem> + </varlistentry> + </variablelist> + </sect2> + </sect1> + + <sect1 label="23.2" id="Glossaries"> + <title>Glossaries</title> + <para><indexterm role="cp"><primary>glossaries</primary></indexterm> +<indexterm role="fn"><primary>\makeglossary</primary></indexterm>The command <literal>\makeglossary</literal> enables creating glossaries.</para> + <para><indexterm role="fn"><primary>\glossary</primary></indexterm><indexterm role="cp"><primary><filename>.glo</filename> file</primary></indexterm>The command <literal>\glossary{<replaceable>text</replaceable>}</literal> writes a glossary entry for +<replaceable>text</replaceable> to an auxiliary file with the <filename>.glo</filename> extension.</para> + <para><indexterm role="fn"><primary>\glossaryentry</primary></indexterm>Specifically, what gets written is the command +<literal>\glossaryentry{<replaceable>text</replaceable>}{<replaceable>pageno</replaceable>}</literal>, where +<replaceable>pageno</replaceable> is the current <literal>\thepage</literal> value.</para> + <para>The <literal>glossary</literal> package on CTAN provides support for fancier +glossaries.</para> + </sect1> + + <sect1 label="23.3" id="Indexes"> + <title>Indexes</title> + <para><indexterm role="cp"><primary>indexes</primary></indexterm> +<indexterm role="fn"><primary>\makeindex</primary></indexterm>The command <literal>\makeindex</literal> enables creating indexes.</para> + <para><indexterm role="fn"><primary>\index</primary></indexterm><indexterm role="cp"><primary><filename>.idx</filename> file</primary></indexterm>The command <literal>\index{<replaceable>text</replaceable>}</literal> writes a glossary entry for +<replaceable>text</replaceable> to an auxiliary file with the <filename>.idx</filename> extension.</para> + <para><indexterm role="fn"><primary>\indexentry</primary></indexterm>Specifically, what gets written is the command +<literal>\indexentry{<replaceable>text</replaceable>}{<replaceable>pageno</replaceable>}</literal>, where <replaceable>pageno</replaceable> +is the current <literal>\thepage</literal> value.</para> + <para>The rubber length <literal>\indexspace</literal> is inserted before each new +letter in the index; its default value is ‘<literal>10pt plus5pt +minus3pt</literal>’.</para> + <para><indexterm role="cp"><primary><command>makeindex</command> program</primary></indexterm><indexterm role="cp"><primary><command>xindy</command> program</primary></indexterm><indexterm role="cp"><primary><filename>.ind</filename> file</primary></indexterm> +The <filename>.idx</filename> file can then be sorted with an external command, +typically <command>makeindex</command> or <command>xindy</command>, resulting in a +<filename>.ind</filename> file, which can then be used to typeset the index.</para> + </sect1> + </chapter> + + <chapter label="24" id="Letters"> + <title>Letters</title> + <para><indexterm role="cp"><primary>letters</primary></indexterm><indexterm role="cp"><primary>creating letters</primary></indexterm> +You can use &latex; to typeset letters, both personal and business. The +<literal>letter</literal> document class is designed to make a number of letters at +once, although you can make just one if you so desire.</para> + <para>Your <filename>.tex</filename> source file has the same minimum commands as the other +document classes, i.e., you must have the following commands as a +minimum:</para> + <screen> + \documentclass{letter} + \begin{document} + ... letters ... + \end{document} +</screen> + <para>Each letter is a <literal>letter</literal> environment, whose argument is the name +and address of the recipient. For example, you might have:</para> + <screen> + \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. + \\ Edinburgh, EH1 1AA} + ... + \end{letter} +</screen> + <para>The letter itself begins with the <literal>\opening</literal> command. The text of +the letter follows. It is typed as ordinary &latex; input. Commands that +make no sense in a letter, like <literal>\chapter</literal>, do not work. The letter +closes with a <literal>\closing</literal> command.</para> + <para><indexterm role="fn"><primary>\\ for letters</primary></indexterm>After the <literal>closing</literal>, you can have additional material. The +<literal>\cc</literal> command produces the usual “cc: …”. There's also a +similar <literal>\encl</literal> command for a list of enclosures. With both these +commands, use <literal>\\</literal> to separate the items.</para> + <para>These commands are used with the <literal>letter</literal> class.</para> + + <sect1 label="24.1" id="\address"> + <title>\address{<replaceable>return-address}</replaceable></title> + <para><indexterm role="fn"><primary>\address</primary></indexterm> +The <literal>\address</literal> specifies the return address of a letter, as it +should appear on the letter and the envelope. Separate lines of the +address should be separated by <literal>\\</literal> commands.</para> + <para>If you do not make an <literal>\address</literal> declaration, then the letter +will be formatted for copying onto your organisation's standard +letterhead. (See <xref linkend="Overview"></xref>, for details on your local +implementation). If you give an <literal>\address</literal> declaration, then the +letter will be formatted as a personal letter.</para> + </sect1> + + <sect1 label="24.2" id="\cc"> + <title><literal>\cc</literal></title> + <para><indexterm role="fn"><primary>\cc</primary></indexterm><indexterm role="cp"><primary>cc list, in letters</primary></indexterm> +Synopsis:</para> + <screen> +\cc{<replaceable>name1</replaceable>\\<replaceable>name2</replaceable>} +</screen> + <para>Produce a list of <replaceable>name</replaceable>s the letter was copied to. Each name is +printed on a separate line.</para> + </sect1> + + <sect1 label="24.3" id="\closing"> + <title><literal>\closing</literal></title> + <para><indexterm role="fn"><primary>\closing</primary></indexterm><indexterm role="cp"><primary>letters, ending</primary></indexterm><indexterm role="cp"><primary>closing letters</primary></indexterm> +Synopsis:</para> + <screen> +\closing{text} +</screen> + <para>A letter closes with a <literal>\closing</literal> command, for example,</para> + <screen> +\closing{Best Regards,} +</screen> + </sect1> + + <sect1 label="24.4" id="\encl"> + <title><literal>\encl</literal></title> + <para><indexterm role="fn"><primary>\encl</primary></indexterm><indexterm role="cp"><primary>enclosure list</primary></indexterm> +Synopsis:</para> + <screen> +\encl{<replaceable>line1</replaceable>\\<replaceable>line2</replaceable>} +</screen> + <para>Declare a list of one more enclosures.</para> + </sect1> + + <sect1 label="24.5" id="\location"> + <title><literal>\location</literal></title> + <para><indexterm role="fn"><primary>\location</primary></indexterm> +<literal>\location{address}</literal></para> + <para>This modifies your organisation's standard address. This only appears +if the <literal>firstpage</literal> pagestyle is selected.</para> + </sect1> + + <sect1 label="24.6" id="\makelabels"> + <title><literal>\makelabels</literal></title> + <para><indexterm role="fn"><primary>\makelabels</primary></indexterm> +<literal>\makelabels{number}</literal></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> + </sect1> + + <sect1 label="24.7" id="\name"> + <title><literal>\name</literal></title> + <para><indexterm role="fn"><primary>\name</primary></indexterm> +<literal>\name{June Davenport}</literal></para> + <para>Your name, used for printing on the envelope together with the return +address.</para> + </sect1> + + <sect1 label="24.8" id="\opening"> + <title><literal>\opening{<replaceable>text</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\opening</primary></indexterm><indexterm role="cp"><primary>letters, starting</primary></indexterm> +Synopsis:</para> + <screen> +\opening{<replaceable>text</replaceable>} +</screen> + <para>A letter begins with the <literal>\opening</literal> command. The mandatory +argument, <replaceable>text</replaceable>, is whatever text you wish to start your letter. +For instance:</para> + <screen> +\opening{Dear Joe,} +</screen> + </sect1> + + <sect1 label="24.9" id="\ps"> + <title><literal>\ps</literal></title> + <para><indexterm role="fn"><primary>\ps</primary></indexterm><indexterm role="cp"><primary>postscript, in letters</primary></indexterm> +Use the <literal>\ps</literal> command to start a postscript in a letter, after +<literal>\closing</literal>.</para> + </sect1> + + <sect1 label="24.10" id="\signature"> + <title><literal>\signature{<replaceable>text</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\signature</primary></indexterm> +Your name, as it should appear at the end of the letter underneath the +space for your signature. <literal>\\</literal> starts a new line within +<replaceable>text</replaceable> as usual.</para> + </sect1> + + <sect1 label="24.11" id="\startbreaks"> + <title><literal>\startbreaks</literal></title> + <para><indexterm role="fn"><primary>\startbreaks</primary></indexterm> +<literal>\startbreaks</literal></para> + <para>Used after a <literal>\stopbreaks</literal> command to allow page breaks again.</para> + </sect1> + + <sect1 label="24.12" id="\stopbreaks"> + <title><literal>\stopbreaks</literal></title> + <para><indexterm role="fn"><primary>\stopbreaks</primary></indexterm> +<literal>\stopbreaks</literal></para> + <para>Inhibit page breaks until a <literal>\startbreaks</literal> command occurs.</para> + </sect1> + + <sect1 label="24.13" id="\telephone"> + <title><literal>\telephone</literal></title> + <para><indexterm role="fn"><primary>\telephone</primary></indexterm> +<literal>\telephone{number}</literal></para> + <para>This is your telephone number. This only appears if the +<literal>firstpage</literal> pagestyle is selected.</para> + </sect1> + </chapter> + + <chapter label="25" id="Terminal-Input/Output"> + <title>Terminal Input/Output</title> + <para><indexterm role="cp"><primary>input/Output</primary></indexterm><indexterm role="cp"><primary>terminal Input/Output</primary></indexterm></para> + + <sect1 label="25.1" id="\typein"> + <title><literal>\typein[<replaceable>cmd</replaceable>]{<replaceable>msg</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\typein</primary></indexterm> +Synopsis:</para> + <screen> +\typein[<replaceable>\cmd</replaceable>]{<replaceable>msg</replaceable>} +</screen> + <para><literal>\typein</literal> prints <replaceable>msg</replaceable> on the terminal and causes &latex; to +stop and wait for you to type a line of input, ending with return. If +the optional <replaceable>\cmd</replaceable> argument is omitted, the typed input is +processed as if it had been included in the input file in place of the +<literal>\typein</literal> command. If the <replaceable>\cmd</replaceable> argument is present, it +must be a command name. This command name is then defined or +redefined to be the typed input.</para> + </sect1> + + <sect1 label="25.2" id="\typeout"> + <title><literal>\typeout{<replaceable>msg</replaceable>}</literal></title> + <para><indexterm role="fn"><primary>\typeout</primary></indexterm> +Synopsis:</para> + <screen> +\typeout{<replaceable>msg</replaceable>} +</screen> + <para>Prints <literal>msg</literal> on the terminal and in the <literal>log</literal> file. +Commands in <literal>msg</literal> that are defined with <literal>\newcommand</literal> or +<literal>\renewcommand</literal> (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 <literal>msg</literal>. A +<literal>\space</literal> command in <literal>msg</literal> causes a single space to be +printed, independent of surrounding spaces. A <literal>^^J</literal> in +<literal>msg</literal> prints a newline.</para> + </sect1> + </chapter> + + <chapter label="26" id="Command-Line"> + <title>Command Line</title> + <para><indexterm role="cp"><primary>command Line</primary></indexterm> +The input file specification indicates the file to be formatted; +&tex; uses <filename>.tex</filename> 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> + <screen> +latex '\nonstopmode\input foo.tex' +</screen> + <para role="continues">will process <filename>foo.tex</filename> without pausing after every error.</para> + <para><indexterm role="cp"><primary>‘<literal>*</literal>’ prompt</primary></indexterm><indexterm role="cp"><primary>prompt, ‘<literal>*</literal>’</primary></indexterm><indexterm role="fn"><primary>\stop</primary></indexterm>If &latex; stops in the middle of the document and gives you a +‘<literal>*</literal>’ prompt, it is waiting for input. You can type <literal>\stop</literal> +(and return) and it will prematurely end the document.</para> + </chapter> + + <appendix id="Document-templates"> + <title>Document templates</title> + <para><indexterm role="cp"><primary>document templates</primary></indexterm> +Although not reference material, perhaps these document templates will +be useful.</para> + + <sect1 id="book-template"> + <title><literal>book</literal> template</title> + <screen>\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} +</screen> + </sect1> + + <sect1 id="beamer-template"> + <title><literal>beamer</literal> template</title> + <para>The <literal>beamer</literal> class creates slides presentations.</para> + <screen>\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} + +</screen> + </sect1> + + <sect1 id="tugboat-template"> + <title><literal>tugboat</literal> template</title> + <para><citetitle>TUGboat</citetitle> is the journal of the &tex; Users Group, +<ulink url="http://tug.org/TUGboat">http://tug.org/TUGboat</ulink>.</para> + <screen>\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} +</screen> + </sect1> + </appendix> + + <chapter label="" xreflabel="Concept Index" id="Concept-Index"> + <title>Concept Index</title> + <index></index> +<!-- The name of the `Command Index' node must NOT be altered for ltx-help.el. --> + </chapter> + + <chapter label="" xreflabel="Command Index" id="Command-Index"> + <title>Command Index</title> + <index></index> + </chapter> +</book><!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-indent-step:1 +sgml-indent-data:nil +End: +--> diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dvi b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dvi Binary files differnew file mode 100644 index 00000000000..f5d54a76e71 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dvi diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html new file mode 100644 index 00000000000..2a810c81b3e --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.html @@ -0,0 +1,7877 @@ +<html lang="en"> +<head> +<title>LaTeX2e reference manual 2.0</title> +<meta http-equiv="Content-Type" content="text/html"> +<meta name="description" content="LaTeX2e reference manual 2.0"> +<meta name="generator" content="makeinfo 4.12"> +<link title="Top" rel="top" href="#Top"> +<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> +<!-- +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. + +This was originally translated from `LATEX.HLP' 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 +LaTeX2e version was adapted from this by Torsten Martinsen. Karl +Berry made further updates and additions, and gratefully acknowledges +using `Hypertext Help with LaTeX', by Sheldon Green, and the +`LaTeX Command Summary' (for LaTeX 2.09) by L. Botway +and C. Biemesderfer (published by the TeX Users Group as +`TeXniques' number 10), as reference material (text was not +directly copied). + +Copyright (C) 2007, 2008 Karl Berry. + +Copyright (C) 1988, 1994, 2007 Stephen Gilmore. + +Copyright (C) 1994, 1995, 1996 Torsten Martinsen. + +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. + + +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. + +Permission is granted to copy and distribute translations of this manual +into another language, under the above conditions for modified versions.--> +<meta http-equiv="Content-Style-Type" content="text/css"> +<style type="text/css"><!-- + pre.display { font-family:inherit } + pre.format { font-family:inherit } + pre.smalldisplay { font-family:inherit; font-size:smaller } + pre.smallformat { font-family:inherit; font-size:smaller } + pre.smallexample { font-size:smaller } + pre.smalllisp { font-size:smaller } + span.sc { font-variant:small-caps } + span.roman { font-family:serif; font-weight:normal; } + span.sansserif { font-family:sans-serif; font-weight:normal; } +--></style> +</head> +<body> +<h1 class="settitle">LaTeX2e reference manual 2.0</h1> +<div class="shortcontents"> +<h2>Short Contents</h2> +<ul> +<li><a href="#toc_Top">LaTeX2e</a></li> +<li><a href="#toc_Overview">1 Overview of LaTeX</a></li> +<li><a href="#toc_Starting-_0026-ending">2 Starting & ending</a></li> +<li><a href="#toc_Document-classes">3 Document classes</a></li> +<li><a href="#toc_Typefaces">4 Typefaces</a></li> +<li><a href="#toc_Layout">5 Layout</a></li> +<li><a href="#toc_Sectioning">6 Sectioning</a></li> +<li><a href="#toc_Cross-references">7 Cross references</a></li> +<li><a href="#toc_Environments">8 Environments</a></li> +<li><a href="#toc_Footnotes">9 Footnotes</a></li> +<li><a href="#toc_Definitions">10 Definitions</a></li> +<li><a href="#toc_Counters">11 Counters</a></li> +<li><a href="#toc_Lengths">12 Lengths</a></li> +<li><a href="#toc_Line-breaking">13 Line breaking</a></li> +<li><a href="#toc_Page-breaking">14 Page breaking</a></li> +<li><a href="#toc_Making-paragraphs">15 Making paragraphs</a></li> +<li><a href="#toc_Math-formulas">16 Math formulas</a></li> +<li><a href="#toc_Modes">17 Modes</a></li> +<li><a href="#toc_Page-Styles">18 Page Styles</a></li> +<li><a href="#toc_Spaces">19 Spaces</a></li> +<li><a href="#toc_Boxes">20 Boxes</a></li> +<li><a href="#toc_Special-insertions">21 Special insertions</a></li> +<li><a href="#toc_Splitting-the-input">22 Splitting the input</a></li> +<li><a href="#toc_Front_002fback-matter">23 Front/back matter</a></li> +<li><a href="#toc_Letters">24 Letters</a></li> +<li><a href="#toc_Terminal-Input_002fOutput">25 Terminal Input/Output</a></li> +<li><a href="#toc_Command-Line">26 Command Line</a></li> +<li><a href="#toc_Document-templates">Appendix A Document templates</a></li> +<li><a href="#toc_Concept-Index">Concept Index</a></li> +<li><a href="#toc_Command-Index">Command Index</a></li> +</ul> +</div> + + + + <div class="contents"> +<h2>Table of Contents</h2> +<ul> +<li><a name="toc_Top" href="#Top">LaTeX2e</a> +<li><a name="toc_Overview" href="#Overview">1 Overview of LaTeX</a> +<li><a name="toc_Starting-_0026-ending" href="#Starting-_0026-ending">2 Starting & ending</a> +<li><a name="toc_Document-classes" href="#Document-classes">3 Document classes</a> +<ul> +<li><a href="#Document-class-options">3.1 Document class options</a> +</li></ul> +<li><a name="toc_Typefaces" href="#Typefaces">4 Typefaces</a> +<ul> +<li><a href="#Font-styles">4.1 Font styles</a> +<li><a href="#Font-sizes">4.2 Font sizes</a> +<li><a href="#Low_002dlevel-font-commands">4.3 Low-level font commands</a> +</li></ul> +<li><a name="toc_Layout" href="#Layout">5 Layout</a> +<ul> +<li><a href="#_005conecolumn">5.1 <code>\onecolumn</code></a> +<li><a href="#_005ctwocolumn">5.2 <code>\twocolumn</code></a> +<li><a href="#_005cflushbottom">5.3 <code>\flushbottom</code></a> +<li><a href="#_005craggedbottom">5.4 <code>\raggedbottom</code></a> +<li><a href="#Page-layout-parameters">5.5 Page layout parameters</a> +</li></ul> +<li><a name="toc_Sectioning" href="#Sectioning">6 Sectioning</a> +<li><a name="toc_Cross-references" href="#Cross-references">7 Cross references</a> +<ul> +<li><a href="#_005clabel">7.1 <code>\label</code></a> +<li><a href="#_005cpageref">7.2 <code>\pageref{</code><var>key</var><code>}</code></a> +<li><a href="#_005cref">7.3 <code>\ref{</code><var>key</var><code>}</code></a> +</li></ul> +<li><a name="toc_Environments" href="#Environments">8 Environments</a> +<ul> +<li><a href="#abstract">8.1 <code>abstract</code></a> +<li><a href="#array">8.2 <code>array</code></a> +<li><a href="#center">8.3 <code>center</code></a> +<ul> +<li><a href="#_005ccentering">8.3.1 <code>\centering</code></a> +</li></ul> +<li><a href="#description">8.4 <code>description</code></a> +<li><a href="#displaymath">8.5 <code>displaymath</code></a> +<li><a href="#document">8.6 <code>document</code></a> +<li><a href="#enumerate">8.7 <code>enumerate</code></a> +<li><a href="#eqnarray">8.8 <code>eqnarray</code></a> +<li><a href="#equation">8.9 <code>equation</code></a> +<li><a href="#figure">8.10 <code>figure</code></a> +<li><a href="#flushleft">8.11 <code>flushleft</code></a> +<ul> +<li><a href="#_005craggedright">8.11.1 <code>\raggedright</code></a> +</li></ul> +<li><a href="#flushright">8.12 <code>flushright</code></a> +<ul> +<li><a href="#_005craggedleft">8.12.1 <code>\raggedleft</code></a> +</li></ul> +<li><a href="#itemize">8.13 <code>itemize</code></a> +<li><a href="#letter">8.14 <code>letter</code> environment: writing letters</a> +<li><a href="#list">8.15 <code>list</code></a> +<li><a href="#math">8.16 <code>math</code></a> +<li><a href="#minipage">8.17 <code>minipage</code></a> +<li><a href="#picture">8.18 <code>picture</code></a> +<ul> +<li><a href="#_005ccircle">8.18.1 <code>\circle</code></a> +<li><a href="#_005cmakebox-_0028picture_0029">8.18.2 <code>\makebox</code></a> +<li><a href="#_005cframebox-_0028picture_0029">8.18.3 <code>\framebox</code></a> +<li><a href="#_005cdashbox">8.18.4 <code>\dashbox</code></a> +<li><a href="#_005cframe">8.18.5 <code>\frame</code></a> +<li><a href="#_005cline">8.18.6 <code>\line</code></a> +<li><a href="#_005clinethickness">8.18.7 <code>\linethickness</code></a> +<li><a href="#_005cthicklines">8.18.8 <code>\thicklines</code></a> +<li><a href="#_005cthinlines">8.18.9 <code>\thinlines</code></a> +<li><a href="#_005cmultiput">8.18.10 <code>\multiput</code></a> +<li><a href="#_005coval">8.18.11 <code>\oval</code></a> +<li><a href="#_005cput">8.18.12 <code>\put</code></a> +<li><a href="#_005cshortstack">8.18.13 <code>\shortstack</code></a> +<li><a href="#_005cvector">8.18.14 <code>\vector</code></a> +</li></ul> +<li><a href="#quotation">8.19 <code>quotation</code></a> +<li><a href="#quote">8.20 <code>quote</code></a> +<li><a href="#tabbing">8.21 <code>tabbing</code></a> +<li><a href="#table">8.22 <code>table</code></a> +<li><a href="#tabular">8.23 <code>tabular</code></a> +<ul> +<li><a href="#_005cmulticolumn">8.23.1 <code>\multicolumn</code></a> +<li><a href="#_005ccline">8.23.2 <code>\cline</code></a> +<li><a href="#_005chline">8.23.3 <code>\hline</code></a> +<li><a href="#_005cvline">8.23.4 <code>\vline</code></a> +</li></ul> +<li><a href="#thebibliography">8.24 <code>thebibliography</code></a> +<ul> +<li><a href="#_005cbibitem">8.24.1 <code>\bibitem</code></a> +<li><a href="#_005ccite">8.24.2 <code>\cite</code></a> +<li><a href="#_005cnocite">8.24.3 <code>\nocite</code></a> +<li><a href="#Using-BibTeX">8.24.4 Using BibTeX</a> +</li></ul> +<li><a href="#theorem">8.25 <code>theorem</code></a> +<li><a href="#titlepage">8.26 <code>titlepage</code></a> +<li><a href="#verbatim">8.27 <code>verbatim</code></a> +<ul> +<li><a href="#_005cverb">8.27.1 <code>\verb</code></a> +</li></ul> +<li><a href="#verse">8.28 <code>verse</code></a> +</li></ul> +<li><a name="toc_Footnotes" href="#Footnotes">9 Footnotes</a> +<ul> +<li><a href="#_005cfootnote">9.1 <code>\footnote</code></a> +<li><a href="#_005cfootnotemark">9.2 <code>\footnotemark</code></a> +<li><a href="#_005cfootnotetext">9.3 <code>\footnotetext</code></a> +<li><a href="#Footnote-parameters">9.4 Footnote parameters</a> +</li></ul> +<li><a name="toc_Definitions" href="#Definitions">10 Definitions</a> +<ul> +<li><a href="#_005cnewcommand-_0026-_005crenewcommand">10.1 <code>\newcommand</code> & <code>\renewcommand</code></a> +<li><a href="#_005cnewcounter">10.2 <code>\newcounter</code></a> +<li><a href="#_005cnewlength">10.3 <code>\newlength</code></a> +<li><a href="#_005cnewsavebox">10.4 <code>\newsavebox</code></a> +<li><a href="#_005cnewenvironment-_0026-_005crenewenvironment">10.5 <code>\newenvironment</code> & <code>\renewenvironment</code></a> +<li><a href="#_005cnewtheorem">10.6 <code>\newtheorem</code></a> +<li><a href="#_005cnewfont">10.7 <code>\newfont</code></a> +<li><a href="#_005cprotect">10.8 <code>\protect</code></a> +</li></ul> +<li><a name="toc_Counters" href="#Counters">11 Counters</a> +<ul> +<li><a href="#_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">11.1 <code>\alph \Alph \arabic \roman \Roman \fnsymbol</code>: Printing counters</a> +<li><a href="#_005cusecounter">11.2 <code>\usecounter{</code><var>counter</var><code>}</code></a> +<li><a href="#_005cvalue">11.3 <code>\value{</code><var>counter</var><code>}</code></a> +<li><a href="#_005csetcounter">11.4 <code>\setcounter{</code><var>counter</var><code>}{</code><var>value</var><code>}</code></a> +<li><a href="#_005caddtocounter">11.5 <code>\addtocounter{</code><var>counter</var><code>}{</code><var>value</var><code>}</code></a> +<li><a href="#_005crefstepcounter">11.6 <code>\refstepcounter{</code><var>counter</var><code>}</code></a> +<li><a href="#_005cstepcounter">11.7 <code>\stepcounter{</code><var>counter</var><code>}</code></a> +<li><a href="#_005cday-_005cmonth-_005cyear">11.8 <code>\day \month \year</code>: Predefined counters</a> +</li></ul> +<li><a name="toc_Lengths" href="#Lengths">12 Lengths</a> +<ul> +<li><a href="#_005csetlength">12.1 <code>\setlength{\</code><var>len</var><code>}{</code><var>value</var><code>}</code></a> +<li><a href="#_005caddtolength">12.2 \addtolength{<var>\len</var>}{<var>amount</var>}</a> +<li><a href="#_005csettodepth">12.3 <code>\settodepth</code></a> +<li><a href="#_005csettoheight">12.4 <code>\settoheight</code></a> +<li><a href="#_005csettowidth">12.5 <code>\settowidth{\</code><var>len</var><code>}{</code><var>text</var><code>}</code></a> +<li><a href="#Predefined-lengths">12.6 Predefined lengths</a> +</li></ul> +<li><a name="toc_Line-breaking" href="#Line-breaking">13 Line breaking</a> +<ul> +<li><a href="#_005c_005c">13.1 <code>\\</code>[*][<var>morespace</var>]</a> +<li><a href="#_005cobeycr-_0026-_005crestorecr">13.2 <code>\obeycr</code> & <code>\restorecr</code></a> +<li><a href="#_005cnewline">13.3 <code>\newline</code></a> +<li><a href="#_005c_002d-_0028hyphenation_0029">13.4 <code>\-</code> (discretionary hyphen)</a> +<li><a href="#_005cfussy">13.5 <code>\fussy</code></a> +<li><a href="#_005csloppy">13.6 <code>\sloppy</code></a> +<li><a href="#_005chyphenation">13.7 <code>\hyphenation</code></a> +<li><a href="#_005clinebreak-_0026-_005cnolinebreak">13.8 <code>\linebreak</code> & <code>\nolinebreak</code></a> +</li></ul> +<li><a name="toc_Page-breaking" href="#Page-breaking">14 Page breaking</a> +<ul> +<li><a href="#_005ccleardoublepage">14.1 <code>\cleardoublepage</code></a> +<li><a href="#_005cclearpage">14.2 <code>\clearpage</code></a> +<li><a href="#_005cnewpage">14.3 <code>\newpage</code></a> +<li><a href="#_005cenlargethispage">14.4 <code>\enlargethispage</code></a> +<li><a href="#_005cpagebreak-_0026-_005cnopagebreak">14.5 <code>\pagebreak</code> & <code>\nopagebreak</code></a> +</li></ul> +<li><a name="toc_Making-paragraphs" href="#Making-paragraphs">15 Making paragraphs</a> +<ul> +<li><a href="#_005cindent">15.1 <code>\indent</code></a> +<li><a href="#_005cnoindent">15.2 <code>\noindent</code></a> +<li><a href="#_005cparskip">15.3 <code>\parskip</code></a> +<li><a href="#Marginal-notes">15.4 Marginal notes</a> +</li></ul> +<li><a name="toc_Math-formulas" href="#Math-formulas">16 Math formulas</a> +<ul> +<li><a href="#Subscripts-_0026-Superscripts">16.1 Subscripts & Superscripts</a> +<li><a href="#Math-symbols">16.2 Math symbols</a> +<li><a href="#Math-functions">16.3 Math functions</a> +<li><a href="#Math-accents">16.4 Math accents</a> +<li><a href="#Spacing-in-math-mode">16.5 Spacing in math mode</a> +<li><a href="#Math-Miscellany">16.6 Math Miscellany</a> +</li></ul> +<li><a name="toc_Modes" href="#Modes">17 Modes</a> +<li><a name="toc_Page-Styles" href="#Page-Styles">18 Page Styles</a> +<ul> +<li><a href="#_005cmaketitle">18.1 <code>\maketitle</code></a> +<li><a href="#_005cpagenumbering">18.2 <code>\pagenumbering</code></a> +<li><a href="#_005cpagestyle">18.3 <code>\pagestyle</code></a> +<li><a href="#_005cthispagestyle">18.4 <code>\thispagestyle{</code><var>style</var><code>}</code></a> +</li></ul> +<li><a name="toc_Spaces" href="#Spaces">19 Spaces</a> +<ul> +<li><a href="#_005chspace">19.1 <code>\hspace</code></a> +<li><a href="#_005chfill">19.2 <code>\hfill</code></a> +<li><a href="#_005cSPACE">19.3 <code>\SPACE</code></a> +<li><a href="#_005cAT">19.4 <code>\@</code></a> +<li><a href="#_005cthinspace">19.5 <code>\thinspace</code></a> +<li><a href="#_005c_002f">19.6 <code>\/</code></a> +<li><a href="#_005chrulefill">19.7 <code>\hrulefill</code></a> +<li><a href="#_005cdotfill">19.8 <code>\dotfill</code></a> +<li><a href="#_005caddvspace">19.9 <code>\addvspace</code></a> +<li><a href="#_005cbigskip-_005cmedskip-_005csmallskip">19.10 <code>\bigskip \medskip \smallskip</code></a> +<li><a href="#_005cvfill">19.11 <code>\vfill</code></a> +<li><a href="#_005cvspace">19.12 <code>\vspace[*]{</code><var>length</var><code>}</code></a> +</li></ul> +<li><a name="toc_Boxes" href="#Boxes">20 Boxes</a> +<ul> +<li><a href="#_005cmbox">20.1 <code>\mbox{</code><var>text}</var></a> +<li><a href="#_005cfbox-and-_005cframebox">20.2 <code>\fbox</code> and <code>\framebox</code></a> +<li><a href="#lrbox">20.3 <code>lrbox</code></a> +<li><a href="#_005cmakebox">20.4 <code>\makebox</code></a> +<li><a href="#_005cparbox">20.5 <code>\parbox</code></a> +<li><a href="#_005craisebox">20.6 <code>\raisebox</code></a> +<li><a href="#_005csavebox">20.7 <code>\savebox</code></a> +<li><a href="#_005csbox">20.8 <code>\sbox{</code><var>\boxcmd</var><code>}{</code><var>text</var><code>}</code></a> +<li><a href="#_005cusebox">20.9 <code>\usebox{</code><var>\boxcmd</var></a> +</li></ul> +<li><a name="toc_Special-insertions" href="#Special-insertions">21 Special insertions</a> +<ul> +<li><a href="#Reserved-characters">21.1 Reserved characters</a> +<li><a href="#Text-symbols">21.2 Text symbols</a> +<li><a href="#Accents">21.3 Accents</a> +<li><a href="#Non_002dEnglish-characters">21.4 Non-English characters</a> +<li><a href="#_005crule">21.5 <code>\rule</code></a> +<li><a href="#_005ctoday">21.6 <code>\today</code></a> +</li></ul> +<li><a name="toc_Splitting-the-input" href="#Splitting-the-input">22 Splitting the input</a> +<ul> +<li><a href="#_005cinclude">22.1 <code>\include</code></a> +<li><a href="#_005cincludeonly">22.2 \<code>includeonly</code></a> +<li><a href="#_005cinput">22.3 \input</a> +</li></ul> +<li><a name="toc_Front_002fback-matter" href="#Front_002fback-matter">23 Front/back matter</a> +<ul> +<li><a href="#Tables-of-contents">23.1 Tables of contents</a> +<ul> +<li><a href="#_005caddcontentsline">23.1.1 \addcontentsline</a> +<li><a href="#_005caddtocontents">23.1.2 \addtocontents</a> +</li></ul> +<li><a href="#Glossaries">23.2 Glossaries</a> +<li><a href="#Indexes">23.3 Indexes</a> +</li></ul> +<li><a name="toc_Letters" href="#Letters">24 Letters</a> +<ul> +<li><a href="#_005caddress">24.1 \address{<var>return-address}</var></a> +<li><a href="#_005ccc">24.2 <code>\cc</code></a> +<li><a href="#_005cclosing">24.3 <code>\closing</code></a> +<li><a href="#_005cencl">24.4 <code>\encl</code></a> +<li><a href="#_005clocation">24.5 <code>\location</code></a> +<li><a href="#_005cmakelabels">24.6 <code>\makelabels</code></a> +<li><a href="#_005cname">24.7 <code>\name</code></a> +<li><a href="#_005copening">24.8 <code>\opening{</code><var>text</var><code>}</code></a> +<li><a href="#_005cps">24.9 <code>\ps</code></a> +<li><a href="#_005csignature">24.10 <code>\signature{</code><var>text</var><code>}</code></a> +<li><a href="#_005cstartbreaks">24.11 <code>\startbreaks</code></a> +<li><a href="#_005cstopbreaks">24.12 <code>\stopbreaks</code></a> +<li><a href="#_005ctelephone">24.13 <code>\telephone</code></a> +</li></ul> +<li><a name="toc_Terminal-Input_002fOutput" href="#Terminal-Input_002fOutput">25 Terminal Input/Output</a> +<ul> +<li><a href="#_005ctypein">25.1 <code>\typein[</code><var>cmd</var><code>]{</code><var>msg</var><code>}</code></a> +<li><a href="#_005ctypeout">25.2 <code>\typeout{</code><var>msg</var><code>}</code></a> +</li></ul> +<li><a name="toc_Command-Line" href="#Command-Line">26 Command Line</a> +<li><a name="toc_Document-templates" href="#Document-templates">Appendix A Document templates</a> +<ul> +<li><a href="#book-template">A.1 <code>book</code> template</a> +<li><a href="#beamer-template">A.2 <code>beamer</code> template</a> +<li><a href="#tugboat-template">A.3 <code>tugboat</code> template</a> +</li></ul> +<li><a name="toc_Concept-Index" href="#Concept-Index">Concept Index</a> +<li><a name="toc_Command-Index" href="#Command-Index">Command Index</a> +</li></ul> +</div> + +<div class="node"> +<p><hr> +<a name="Top"></a> +Next: <a rel="next" accesskey="n" href="#Overview">Overview</a>, +Up: <a rel="up" accesskey="u" href="#dir">(dir)</a> + +</div> + +<h2 class="unnumbered">LaTeX2e</h2> + +<p>This document is version 2.0 (June 2008) of an +unofficial reference manual for LaTeX, a document preparation +system. It is intended to cover LaTeX2e, which has been the +standard version of LaTeX for many years. + + <p><a name="index-Knuth_002c-Donald-E_002e-1"></a><a name="index-Lamport_002c-Leslie-2"></a><a name="index-g_t_0040LaTeX_007b_007d-Project-team-3"></a>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 +(<a href="http://latex-project.org">http://latex-project.org</a>). 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. + +<ul class="menu"> +<li><a accesskey="1" href="#Overview">Overview</a>: What is LaTeX? +<li><a accesskey="2" href="#Starting-_0026-ending">Starting & ending</a>: The standard beginning and end of a document. +<li><a accesskey="3" href="#Document-classes">Document classes</a>: Some of the various classes available. +<li><a accesskey="4" href="#Typefaces">Typefaces</a>: And fonts, such as bold, italics etc. +<li><a accesskey="5" href="#Layout">Layout</a>: Controlling the page layout. +<li><a accesskey="6" href="#Sectioning">Sectioning</a>: How to section properly. +<li><a accesskey="7" href="#Cross-references">Cross references</a>: Automatic referencing. +<li><a accesskey="8" href="#Environments">Environments</a>: Such as enumerate & itemize. +<li><a accesskey="9" href="#Line-breaking">Line breaking</a>: Influencing line breaks. +<li><a href="#Page-breaking">Page breaking</a>: Influencing page breaks. +<li><a href="#Footnotes">Footnotes</a>: How to produce footnotes. +<li><a href="#Definitions">Definitions</a>: Define your own commands etc. +<li><a href="#Counters">Counters</a>: Internal counters used by LaTeX. +<li><a href="#Lengths">Lengths</a>: The length commands. +<li><a href="#Making-paragraphs">Making paragraphs</a>: Paragraph commands. +<li><a href="#Math-formulas">Math formulas</a>: How to create mathematical formulas. +<li><a href="#Modes">Modes</a>: Paragraph, Math or LR modes. +<li><a href="#Page-Styles">Page Styles</a>: Various styles of page layout. +<li><a href="#Spaces">Spaces</a>: Horizontal and vertical space. +<li><a href="#Boxes">Boxes</a>: Making boxes. +<li><a href="#Special-insertions">Special insertions</a>: Inserting reserved and special characters. +<li><a href="#Splitting-the-input">Splitting the input</a>: Dealing with big files by splitting. +<li><a href="#Front_002fback-matter">Front/back matter</a>: Tables of contents, glossaries, indexes. +<li><a href="#Letters">Letters</a>: The letter class. +<li><a href="#Terminal-Input_002fOutput">Terminal Input/Output</a>: User interaction. +<li><a href="#Command-Line">Command Line</a>: System-independent command-line behavior. +<li><a href="#Document-templates">Document templates</a>: Starter templates for various document classes. +<li><a href="#Command-Index">Command Index</a>: Alphabetical list of LaTeX commands. +<li><a href="#Concept-Index">Concept Index</a>: General index. +</ul> + +<div class="node"> +<p><hr> +<a name="Overview"></a> +Next: <a rel="next" accesskey="n" href="#Starting-_0026-ending">Starting & ending</a>, +Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">1 Overview of LaTeX</h2> + +<p><a name="index-overview-of-_0040LaTeX_007b_007d-4"></a><a name="index-g_t_0040LaTeX_007b_007d-overview-5"></a> +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: + + <ol type=1 start=1> +<li>A main output file, which is one of: + + <ol type=1 start=1> +<li>If invoked as <samp><span class="command">latex</span></samp>, a “Device Independent” (<samp><span class="file">.dvi</span></samp>) +file. This contains commands that can be translated into commands for +a variety of output devices. You can view such <samp><span class="file">.dvi</span></samp> output of +LaTeX by using a program such as <samp><span class="command">xdvi</span></samp> (display directly) +or <samp><span class="command">dvips</span></samp> (convert to PostScript). + + <li>If invoked as <samp><span class="command">pdflatex</span></samp>, a “Portable Document Format” +(<samp><span class="file">.pdf</span></samp>) 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 <samp><span class="file">.dvi</span></samp> produced from the +same document. + </ol> + + <p>There are other less-common variants of LaTeX (and TeX) as well, +which can produce HTML, XML, and other things. + + <li>A “transcript” or <samp><span class="file">.log</span></samp> file that contains summary information and +diagnostic messages for any errors discovered in the input file. + + <li>An “auxiliary” or <samp><span class="file">.aux</span></samp> file. This is used by LaTeX itself, for +things such as sectioning. + </ol> + + <p>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. + + <p>LaTeX is case sensitive. Enter all commands in lower case unless +explicitly directed to do otherwise. + +<div class="node"> +<p><hr> +<a name="Starting-%26-ending"></a> +<a name="Starting-_0026-ending"></a> +Next: <a rel="next" accesskey="n" href="#Document-classes">Document classes</a>, +Previous: <a rel="previous" accesskey="p" href="#Overview">Overview</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">2 Starting & ending</h2> + +<p><a name="index-starting-_0026-ending-6"></a><a name="index-ending-_0026-starting-7"></a> +A minimal input file looks like the following: + +<pre class="example"> \documentclass{<var>class</var>} + \begin{document} + <var>your text</var> + \end{document} +</pre> + <p class="noindent">where the <var>class</var> is a valid document class for LaTeX. +See <a href="#Document-classes">Document classes</a>, for details of the various document classes +available locally. + + <p><a name="index-preamble_002c-defined-8"></a>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>). + +<div class="node"> +<p><hr> +<a name="Document-classes"></a> +Next: <a rel="next" accesskey="n" href="#Typefaces">Typefaces</a>, +Previous: <a rel="previous" accesskey="p" href="#Starting-_0026-ending">Starting & ending</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">3 Document classes</h2> + +<p><a name="index-document-classes-9"></a><a name="index-classes-of-documents-10"></a><a name="index-g_t_005cdocumentclass-11"></a> +The class of a given document is defined with the command: + +<pre class="example"> \documentclass[<var>options</var>]{<var>class</var>} +</pre> + <p class="noindent">The <code>\documentclass</code> command must be the first command in a +LaTeX source file. + + <p><a name="index-article-_0040r_007bclass_007d-12"></a><a name="index-report-_0040r_007bclass_007d-13"></a><a name="index-book-_0040r_007bclass_007d-14"></a><a name="index-letter-_0040r_007bclass_007d-15"></a><a name="index-slides-_0040r_007bclass_007d-16"></a>Built-in LaTeX document <var>class</var> names are (many other document +classes are available as add-ons; see <a href="#Overview">Overview</a>): + +<pre class="example"> article report book letter slides +</pre> + <!-- xx briefly describe each one --> + <p>Standard <var>options</var> are described below. + +<ul class="menu"> +<li><a accesskey="1" href="#Document-class-options">Document class options</a>: Global options. +</ul> + +<div class="node"> +<p><hr> +<a name="Document-class-options"></a> +Up: <a rel="up" accesskey="u" href="#Document-classes">Document classes</a> + +</div> + +<h3 class="section">3.1 Document class options</h3> + +<p><a name="index-document-class-options-17"></a><a name="index-options_002c-document-class-18"></a><a name="index-class-options-19"></a><a name="index-global-options-20"></a> +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: + +<pre class="example"> \documentclass[<var>option1</var>,<var>option2</var>,...]{<var>class</var>} +</pre> + <p>Here is the list of the standard class options. + + <p><a name="index-g_t10pt-_0040r_007boption_007d-21"></a><a name="index-g_t11pt-_0040r_007boption_007d-22"></a><a name="index-g_t12pt-_0040r_007boption_007d-23"></a>All of the standard classes except <code>slides</code> accept the following +options for selecting the typeface size (default is <code>10pt</code>): + +<pre class="example"> 10pt 11pt 12pt +</pre> + <p><a name="index-a4paper-_0040r_007boption_007d-24"></a><a name="index-a5paper-_0040r_007boption_007d-25"></a><a name="index-b5paper-_0040r_007boption_007d-26"></a><a name="index-executivepaper-_0040r_007boption_007d-27"></a><a name="index-legalpaper-_0040r_007boption_007d-28"></a><a name="index-letterpaper-_0040r_007boption_007d-29"></a>All of the standard classes accept these options for selecting the paper +size (default is <code>letterpaper</code>): + +<pre class="example"> a4paper a5paper b5paper executivepaper legalpaper letterpaper +</pre> + <p><a name="index-draft-_0040r_007boption_007d-30"></a><a name="index-final-_0040r_007boption_007d-31"></a><a name="index-fleqn-_0040r_007boption_007d-32"></a><a name="index-landscape-_0040r_007boption_007d-33"></a><a name="index-leqno-_0040r_007boption_007d-34"></a><a name="index-openbib-_0040r_007boption_007d-35"></a><a name="index-titlepage-_0040r_007boption_007d-36"></a><a name="index-notitlepage-_0040r_007boption_007d-37"></a>Miscellaneous other options: + + <dl> +<dt><code>draft, final</code><dd><a name="index-black-boxes_002c-omitting-38"></a>mark/do not mark overfull boxes with a big black box; default is <code>final</code>. +<br><dt><code>fleqn</code><dd>Put displayed formulas flush left; default is centered. +<br><dt><code>landscape</code><dd>Selects landscape format; default is portrait. +<br><dt><code>leqno</code><dd>Put equation numbers on the left side of equations; default is the right side. +<br><dt><code>openbib</code><dd>Use “open” bibliography format. +<br><dt><code>titlepage, notitlepage</code><dd>Specifies whether the title page is separate; default depends on the class. +</dl> + + <p>These options are not available with the slides class: + + <p><a name="index-onecolumn-_0040r_007boption_007d-39"></a><a name="index-twocolumn-_0040r_007boption_007d-40"></a><a name="index-oneside-_0040r_007boption_007d-41"></a><a name="index-twoside-_0040r_007boption_007d-42"></a><a name="index-openright-_0040r_007boption_007d-43"></a><a name="index-openany-_0040r_007boption_007d-44"></a> + <dl> +<dt><code>onecolumn</code><dt><code>twocolumn</code><dd>Typeset in one or two columns; default is <code>onecolumn</code>. + + <br><dt><code>oneside</code><dt><code>twoside</code><dd><a name="index-g_t_005cevensidemargin-45"></a><a name="index-g_t_005coddsidemargin-46"></a>Selects one- or two-sided layout; default is <code>oneside</code>, except +for the <code>book</code> class. + + <p>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. + + <br><dt><code>openright</code><dt><code>openany</code><dd>Determines if a chapter should start on a +right-hand page; default is <code>openright</code> for book. +</dl> + + <p>The <code>slides</code> class offers the option <code>clock</code> for printing +the time at the bottom of each note. + + <p><a name="index-packages_002c-loading-47"></a><a name="index-loading-additional-packages-48"></a><a name="index-g_t_005cusepackage-49"></a>Additional packages are loaded like this: + +<pre class="example"> \usepackage[<var>options</var>]{<var>pkg</var>} +</pre> + <p>To specify more than one <var>pkg</var>, you can separate them with a +comma, or use multiple <code>\usepackage</code> commands. + + <p><a name="index-global-options-50"></a><a name="index-options_002c-global-51"></a>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>. + +<div class="node"> +<p><hr> +<a name="Typefaces"></a> +Next: <a rel="next" accesskey="n" href="#Layout">Layout</a>, +Previous: <a rel="previous" accesskey="p" href="#Document-classes">Document classes</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">4 Typefaces</h2> + +<p><a name="index-typefaces-52"></a><a name="index-fonts-53"></a> +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. + +<ul class="menu"> +<li><a accesskey="1" href="#Font-styles">Font styles</a>: Select roman, italics etc. +<li><a accesskey="2" href="#Font-sizes">Font sizes</a>: Select point size. +<li><a accesskey="3" href="#Low_002dlevel-font-commands">Low-level font commands</a>: Select encoding, family, series, shape. +</ul> + +<div class="node"> +<p><hr> +<a name="Font-styles"></a> +Next: <a rel="next" accesskey="n" href="#Font-sizes">Font sizes</a>, +Up: <a rel="up" accesskey="u" href="#Typefaces">Typefaces</a> + +</div> + +<h3 class="section">4.1 Font styles</h3> + +<p><a name="index-font-styles-54"></a><a name="index-typeface-styles-55"></a><a name="index-styles-of-text-56"></a> +The following type style commands are supported by LaTeX. + + <p>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. + + <p>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. + + <p>You can also use the environment form of the declaration forms; for instance, +<code>\begin{ttfamily}...\end{ttfamily}</code>. + + <dl> +<dt><code>\textrm (\rmfamily)</code><dd><a name="index-g_t_005ctextrm-57"></a><a name="index-g_t_005crmfamily-58"></a>Roman. + + <br><dt><code>\textit (\itshape)</code><dd><a name="index-g_t_005ctextit-59"></a><a name="index-g_t_005citshape-60"></a>Italics. + + <br><dt><code>\emph</code><dd><a name="index-g_t_005cemph-61"></a><a name="index-emphasis-62"></a>Emphasis (switches between <code>\textit</code> and <code>\textrm</code>). + + <br><dt><code>\textmd (\mdseries)</code><dd><a name="index-g_t_005ctextmd-63"></a><a name="index-g_t_005cmdseries-64"></a>Medium weight (default). + + <br><dt><code>\textbf (\bfseries)</code><dd><a name="index-g_t_005ctextbf-65"></a><a name="index-g_t_005cbfseries-66"></a>Boldface. +<br><dt><code>\textup (\upshape)</code><dd><a name="index-g_t_005ctextup-67"></a><a name="index-g_t_005cupshape-68"></a>Upright (default). The opposite of slanted. +<br><dt><code>\textsl (\slshape)</code><dd><a name="index-g_t_005ctextsl-69"></a><a name="index-g_t_005cslshape-70"></a>Slanted. +<br><dt><code>\textsf (\sffamily)</code><dd><a name="index-g_t_005ctextsf-71"></a><a name="index-g_t_005csffamily-72"></a>Sans serif. +<br><dt><code>\textsc (\scshape)</code><dd><a name="index-g_t_005ctextsc-73"></a><a name="index-g_t_005cscshape-74"></a>Small caps. +<br><dt><code>\texttt (\ttfamily)</code><dd><a name="index-g_t_005ctexttt-75"></a><a name="index-g_t_005cttfamily-76"></a>Typewriter. +<br><dt><code>\textnormal (\normalfont)</code><dd><a name="index-g_t_005ctextnormal-77"></a><a name="index-g_t_005cnormalfont-78"></a>Main document font. +<br><dt><code>\mathrm</code><dd><a name="index-g_t_005cmathrm-79"></a>Roman, for use in math mode. +<br><dt><code>\mathbf</code><dd><a name="index-g_t_005cmathbf-80"></a>Boldface, for use in math mode. +<br><dt><code>\mathsf</code><dd><a name="index-g_t_005cmathsf-81"></a>Sans serif, for use in math mode. +<br><dt><code>\mathtt</code><dd><a name="index-g_t_005cmathtt-82"></a>Typewriter, for use in math mode. + + <br><dt><code>\mathit</code><dt><code>(\mit)</code><dd>Italics, for use in math mode. + + <br><dt><code>\mathnormal</code><dd><a name="index-g_t_005cmathnormal-83"></a>For use in math mode, e.g. inside another type style declaration. +<br><dt><code>\mathcal</code><dd><a name="index-g_t_005cmathcal-84"></a>`Calligraphic' letters, for use in math mode. +</dl> + + <p>In addition, the command +<code>\mathversion{bold}</code> +<a name="index-g_t_005cmathversion-85"></a>can be used for switching to bold letters and symbols in +formulas. <code>\mathversion{normal}</code> restores the default. + + <p>LaTeX also provides these commands, which unconditionally switch to +the given style, that is, are <em>not</em> cumulative. They are used +differently than the above commands, too: <code>{\</code><var>cmd</var><code> ...}</code> +instead of <code>\</code><var>cmd</var><code>{...}</code>. These are two very different +things. + + <dl> +<dt><code>\bf</code><a name="index-g_t_005cbf-86"></a><dd><a name="index-bold-font-87"></a>Switch to <b>bold face</b>. + + <br><dt><code>\cal</code><a name="index-g_t_005ccal-88"></a><dd><a name="index-script-letters-for-math-89"></a><a name="index-calligraphic-letters-for-math-90"></a>Switch to calligraphic letters for math. + + <br><dt><code>\em</code><a name="index-g_t_005cem-91"></a><dd><a name="index-emphasis-92"></a>Emphasis (italics within roman, roman within italics). + + <br><dt><code>\it</code><a name="index-g_t_005cit-93"></a><dd><a name="index-italic-font-94"></a>Italics. + + <br><dt><code>\rm</code><a name="index-g_t_005crm-95"></a><dd><a name="index-roman-font-96"></a>Roman. + + <br><dt><code>\sc</code><a name="index-g_t_005csc-97"></a><dd><a name="index-small-caps-font-98"></a>Small caps. + + <br><dt><code>\sf</code><a name="index-g_t_005csf-99"></a><dd><a name="index-sans-serif-font-100"></a>Sans serif. + + <br><dt><code>\sl</code><a name="index-g_t_005csl-101"></a><dd><a name="index-slanted-font-102"></a><a name="index-oblique-font-103"></a>Slanted (oblique). + + <br><dt><code>\tt</code><a name="index-g_t_005ctt-104"></a><dd><a name="index-typewriter-font-105"></a><a name="index-monospace-font-106"></a><a name="index-fixed_002dwidth-font-107"></a>Typewriter (monospace, fixed-width). + + </dl> + +<div class="node"> +<p><hr> +<a name="Font-sizes"></a> +Next: <a rel="next" accesskey="n" href="#Low_002dlevel-font-commands">Low-level font commands</a>, +Previous: <a rel="previous" accesskey="p" href="#Font-styles">Font styles</a>, +Up: <a rel="up" accesskey="u" href="#Typefaces">Typefaces</a> + +</div> + +<h3 class="section">4.2 Font sizes</h3> + +<p><a name="index-font-sizes-108"></a><a name="index-typeface-sizes-109"></a><a name="index-sizes-of-text-110"></a> +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><span class="samp">10pt</span></samp>’, ‘<samp><span class="samp">11pt</span></samp>’, and +‘<samp><span class="samp">12pt</span></samp>’ document size options, respectively (see <a href="#Document-class-options">Document class options</a>). + + <p><a name="index-g_t_005ctiny-111"></a><a name="index-g_t_005cscriptsize-112"></a><a name="index-g_t_005cfootnotesize-113"></a><a name="index-g_t_005csmall-114"></a><a name="index-g_t_005cnormalsize-115"></a><a name="index-g_t_005clarge-116"></a><a name="index-g_t_005cLarge-117"></a><a name="index-g_t_005cLARGE-118"></a><a name="index-g_t_005chuge-119"></a><a name="index-g_t_005cHuge-120"></a> + <p><table summary=""><tr align="left"><th valign="top">Command </th><th valign="top"><code>10pt</code> </th><th valign="top"><code>11pt</code> </th><th valign="top"><code>12pt</code> +<br></th></tr><tr align="left"><td valign="top"><code>\tiny</code> +</td><td valign="top">5 </td><td valign="top">6 </td><td valign="top">6 +<br></td></tr><tr align="left"><td valign="top"><code>\scriptsize</code> +</td><td valign="top">7 </td><td valign="top">8 </td><td valign="top">8 +<br></td></tr><tr align="left"><td valign="top"><code>\footnotesize</code> +</td><td valign="top">8 </td><td valign="top">9 </td><td valign="top">10 +<br></td></tr><tr align="left"><td valign="top"><code>\small</code> +</td><td valign="top">9 </td><td valign="top">10 </td><td valign="top">10.95 +<br></td></tr><tr align="left"><td valign="top"><code>\normalsize</code> (default) +</td><td valign="top">10 </td><td valign="top">10.95 </td><td valign="top">12 +<br></td></tr><tr align="left"><td valign="top"><code>\large</code> +</td><td valign="top">12 </td><td valign="top">12 </td><td valign="top">14.4 +<br></td></tr><tr align="left"><td valign="top"><code>\Large</code> +</td><td valign="top">14.4 </td><td valign="top">14.4 </td><td valign="top">17.28 +<br></td></tr><tr align="left"><td valign="top"><code>\LARGE</code> +</td><td valign="top">17.28 </td><td valign="top">17.28 </td><td valign="top">20.74 +<br></td></tr><tr align="left"><td valign="top"><code>\huge</code> +</td><td valign="top">20.74 </td><td valign="top">20.74 </td><td valign="top">24.88 +<br></td></tr><tr align="left"><td valign="top"><code>\Huge</code> +</td><td valign="top">24.88 </td><td valign="top">24.88 </td><td valign="top">24.88 + <br></td></tr></table> + + <p>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>. + +<div class="node"> +<p><hr> +<a name="Low-level-font-commands"></a> +<a name="Low_002dlevel-font-commands"></a> +Previous: <a rel="previous" accesskey="p" href="#Font-sizes">Font sizes</a>, +Up: <a rel="up" accesskey="u" href="#Typefaces">Typefaces</a> + +</div> + +<h3 class="section">4.3 Low-level font commands</h3> + +<p><a name="index-low_002dlevel-font-commands-121"></a><a name="index-font-commands_002c-low_002dlevel-122"></a> +These commands are primarily intended for writers of macros and +packages. The commands listed here are only a subset of the available +ones. + + <dl> +<dt><code>\fontencoding{enc}</code><dd><a name="index-g_t_005cfontencoding-123"></a>Select font encoding. Valid encodings include <code>OT1</code> and <code>T1</code>. + + <br><dt><code>\fontfamily{family}</code><dd><a name="index-g_t_005cfontfamily-124"></a>Select font family. Valid families include: + + <ul> +<li><code>cmr</code> for Computer Modern Roman +<li><code>cmss</code> for Computer Modern Sans Serif +<li><code>cmtt</code> for Computer Modern Typewriter +</ul> + + <p>and numerous others. + + <br><dt><code>\fontseries{series}</code><dd><a name="index-g_t_005cfontseries-125"></a>Select font series. Valid series include: + + <ul> +<li><code>m</code> Medium (normal) +<li><code>b</code> Bold +<li><code>c</code> Condensed +<li><code>bc</code> Bold condensed +<li><code>bx</code> Bold extended +</ul> + + <p>and various other combinations. + + <br><dt><code>\fontshape{shape}</code><dd><a name="index-g_t_005cfontshape-126"></a>Select font shape. Valid shapes are: + + <ul> +<li><code>n</code> Upright (normal) +<li><code>it</code> Italic +<li><code>sl</code> Slanted (oblique) +<li><code>sc</code> Small caps +<li><code>ui</code> Upright italics +<li><code>ol</code> Outline +</ul> + + <p>The two last shapes are not available for most font families. + + <br><dt><code>\fontsize{size}{skip}</code><dd><a name="index-g_t_005cfontsize-127"></a><a name="index-g_t_005cbaselineskip-128"></a>Set font size. The first parameter is the font size to switch to and +the second is the line spacing to use; this is stored in a parameter +named <code>\baselineskip</code>. The unit of both parameters defaults to +pt. The default <code>\baselineskip</code> for the Computer Modern typeface +is 1.2 times the <code>\fontsize</code>. + + <p><a name="index-g_t_005cbaselinestretch-129"></a><a name="index-g_t_0040code_007bsetspace_007d-package-130"></a>The line spacing is also multiplied by the value of the +<code>\baselinestretch</code> parameter when the type size changes; the +default is 1. However, the best way to “double space” a document, +if you should be unlucky enough to have to produce such, is to use the +<code>setspace</code> package; see +<a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</a>. + + <br><dt><code>\selectfont</code><dd><a name="index-g_t_005cselectfont-131"></a>The changes made by calling the four font commands described above do +not come into effect until <code>\selectfont</code> is called. + + <br><dt><code>\usefont{enc}{family}{series}{shape}</code><dd><a name="index-g_t_005cusefont-132"></a>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>. +</dl> + +<div class="node"> +<p><hr> +<a name="Layout"></a> +Next: <a rel="next" accesskey="n" href="#Sectioning">Sectioning</a>, +Previous: <a rel="previous" accesskey="p" href="#Typefaces">Typefaces</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">5 Layout</h2> + +<p><a name="index-layout-commands-133"></a> +Miscellaneous commands for controlling the general layout of the page. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005conecolumn">\onecolumn</a>: Use one-column layout. +<li><a accesskey="2" href="#g_t_005ctwocolumn">\twocolumn</a>: Use two-column layout. +<li><a accesskey="3" href="#g_t_005cflushbottom">\flushbottom</a>: Make all text pages the same height. +<li><a accesskey="4" href="#g_t_005craggedbottom">\raggedbottom</a>: Allow text pages of differing height. +<li><a accesskey="5" href="#Page-layout-parameters">Page layout parameters</a>: \headheight \footskip. +</ul> + +<div class="node"> +<p><hr> +<a name="%5conecolumn"></a> +<a name="g_t_005conecolumn"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005ctwocolumn">\twocolumn</a>, +Up: <a rel="up" accesskey="u" href="#Layout">Layout</a> + +</div> + +<h3 class="section">5.1 <code>\onecolumn</code></h3> + +<p><a name="index-g_t_005conecolumn-134"></a><a name="index-one_002dcolumn-output-135"></a> +The <code>\onecolumn</code> declaration starts a new page and produces +single-column output. This is the default. + +<div class="node"> +<p><hr> +<a name="%5ctwocolumn"></a> +<a name="g_t_005ctwocolumn"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cflushbottom">\flushbottom</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005conecolumn">\onecolumn</a>, +Up: <a rel="up" accesskey="u" href="#Layout">Layout</a> + +</div> + +<h3 class="section">5.2 <code>\twocolumn</code></h3> + +<p><a name="index-g_t_005ctwocolumn-136"></a><a name="index-multicolumn-text-137"></a><a name="index-two_002dcolumn-output-138"></a> +Synopsis: + +<pre class="example"> \twocolumn[<var>text1col</var>] +</pre> + <p>The <code>\twocolumn</code> declaration starts a new page and produces +two-column output. If the optional <var>text1col</var> argument is present, +it is typeset in one-column mode before the two-column typesetting +starts. + + <p>These parameters control typesetting in two-column output: + + <dl> +<dt><code>\columnsep</code><a name="index-g_t_005ccolumnsep-139"></a><dd>The distance between columns (35pt by default). + + <br><dt><code>\columnseprule</code><a name="index-g_t_005ccolumnseprule-140"></a><dd>The width of the rule between columns; the default is 0pt, so there is no rule. + + <br><dt><code>\columnwidth</code><a name="index-g_t_005ccolumnwidth-141"></a><dd>The width of the current column; this is equal to <code>\textwidth</code> in +single-column text. + + </dl> + + <p>These parameters control float behavior in two-column output: + + <dl> +<dt><code>\dbltopfraction</code><a name="index-g_t_005cdbltopfraction-142"></a><dd>Maximum fraction at the top of a two-column page that may be occupied +by floats. Default ‘<samp><span class="samp">.7</span></samp>’, can be usefully redefined to (say) +‘<samp><span class="samp">.9</span></samp>’ to avoid going to float pages so soon. + + <br><dt><code>\dblfloatpagefraction</code><a name="index-g_t_005cdblfloatpagefraction-143"></a><dd>The minimum fraction of a float page that must be occupied by floats, +for a two-column float page. Default ‘<samp><span class="samp">.5</span></samp>’. + + <br><dt><code>\dblfloatsep</code><a name="index-g_t_005cdblfloatsep-144"></a><dd>Distance between floats at the top or bottom of a two-column float +page. Default ‘<samp><span class="samp">12pt plus2pt minus2pt</span></samp>’ for ‘<samp><span class="samp">10pt</span></samp>’ and +‘<samp><span class="samp">11pt</span></samp>’ documents, ‘<samp><span class="samp">14pt plus2pt minus4pt</span></samp>’ for ‘<samp><span class="samp">12pt</span></samp>’. + + <br><dt><code>\dbltextfloatsep</code><a name="index-g_t_005cdbltextfloatsep-145"></a><dd>Distance between a multi-column float at the top or bottom of a page +and the main text. Default ‘<samp><span class="samp">20pt plus2pt minus4pt</span></samp>’. + + </dl> + +<div class="node"> +<p><hr> +<a name="%5cflushbottom"></a> +<a name="g_t_005cflushbottom"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005craggedbottom">\raggedbottom</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005ctwocolumn">\twocolumn</a>, +Up: <a rel="up" accesskey="u" href="#Layout">Layout</a> + +</div> + +<h3 class="section">5.3 <code>\flushbottom</code></h3> + +<p><a name="index-g_t_005cflushbottom-146"></a> +The <code>\flushbottom</code> declaration makes all text pages the same +height, adding extra vertical space where necessary to fill out the +page. + + <p>This is the default if <code>twocolumn</code> mode is selected +(see <a href="#Document-class-options">Document class options</a>). + +<div class="node"> +<p><hr> +<a name="%5craggedbottom"></a> +<a name="g_t_005craggedbottom"></a> +Next: <a rel="next" accesskey="n" href="#Page-layout-parameters">Page layout parameters</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cflushbottom">\flushbottom</a>, +Up: <a rel="up" accesskey="u" href="#Layout">Layout</a> + +</div> + +<h3 class="section">5.4 <code>\raggedbottom</code></h3> + +<p><a name="index-g_t_005craggedbottom-147"></a><a name="index-stretch_002c-omitting-vertical-148"></a> +The <code>\raggedbottom</code> declaration makes all pages the natural +height of the material on that page. No rubber lengths will be +stretched. + +<div class="node"> +<p><hr> +<a name="Page-layout-parameters"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005craggedbottom">\raggedbottom</a>, +Up: <a rel="up" accesskey="u" href="#Layout">Layout</a> + +</div> + +<h3 class="section">5.5 Page layout parameters</h3> + +<p><a name="index-page-layout-parameters-149"></a><a name="index-parameters_002c-page-layout-150"></a><a name="index-layout_002c-page-parameters-for-151"></a><a name="index-header_002c-parameters-for-152"></a><a name="index-footer_002c-parameters-for-153"></a><a name="index-running-header-and-footer-154"></a> + <dl> +<dt><code>\headheight</code><a name="index-g_t_005cheadheight-155"></a><dd>Height of the box that contains the running head. Default is +‘<samp><span class="samp">30pt</span></samp>’, except in the <code>book</code> class, where it varies with the +type size. + + <br><dt><code>\headsep</code><a name="index-g_t_005cheadsep-156"></a><dd>Vertical distance between the bottom of the header line and the top of +the main text. Default is ‘<samp><span class="samp">25pt</span></samp>’, except in the <code>book</code> +class, where it varies with the type size. + + <br><dt><code>\footskip</code><a name="index-g_t_005cfootskip-157"></a><dd>Distance from the baseline of the last line of text to the baseline of +the page footer. Default is ‘<samp><span class="samp">30pt</span></samp>’, except in the <code>book</code> +class, where it varies with the type size. + + <br><dt><code>\linewidth</code><a name="index-g_t_005clinewidth-158"></a><dd>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><span class="samp">10pt</span></samp>’, it's set to ‘<samp><span class="samp">345pt</span></samp>’; in two-column mode, that +becomes ‘<samp><span class="samp">229.5pt</span></samp>’. + + <br><dt><code>\textheight</code><a name="index-g_t_005ctextheight-159"></a><dd>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><span class="samp">10pt</span></samp>’, it's set to +‘<samp><span class="samp">43\baselineskip</span></samp>’; for <code>book</code>, it's ‘<samp><span class="samp">41\baselineskip</span></samp>’. +For ‘<samp><span class="samp">11pt</span></samp>’, it's ‘<samp><span class="samp">38\baselineskip</span></samp>’ and for ‘<samp><span class="samp">12pt</span></samp>’, +‘<samp><span class="samp">36\baselineskip</span></samp>’. + + <br><dt><code>\textwidth</code><a name="index-g_t_005ctextwidth-160"></a><dd>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><span class="samp">345pt</span></samp>’ at ‘<samp><span class="samp">10pt</span></samp>’, ‘<samp><span class="samp">360pt</span></samp>’ at ‘<samp><span class="samp">11pt</span></samp>’, and +‘<samp><span class="samp">390pt</span></samp>’ at ‘<samp><span class="samp">12pt</span></samp>’. For a <code>book</code> document, it's +‘<samp><span class="samp">4.5in</span></samp>’ at ‘<samp><span class="samp">10pt</span></samp>’, and ‘<samp><span class="samp">5in</span></samp>’ at ‘<samp><span class="samp">11pt</span></samp>’ or ‘<samp><span class="samp">12pt</span></samp>’. + + <br><dt><code>\topmargin</code><a name="index-g_t_005ctopmargin-161"></a><dd>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. + + <br><dt><code>\topskip</code><a name="index-g_t_005ctopskip-162"></a><dd>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><span class="samp">10pt</span></samp>’ at ‘<samp><span class="samp">10pt</span></samp>’. + + </dl> + +<div class="node"> +<p><hr> +<a name="Sectioning"></a> +Next: <a rel="next" accesskey="n" href="#Cross-references">Cross references</a>, +Previous: <a rel="previous" accesskey="p" href="#Layout">Layout</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">6 Sectioning</h2> + +<p><a name="index-sectioning-163"></a> +Sectioning commands provide the means to structure your text into units: + + <dl> +<dt><code>\part</code><a name="index-g_t_005cpart-164"></a><br><dt><code>\chapter</code><a name="index-g_t_005cchapter-165"></a><dd>(report and book class only) +<br><dt><code>\section</code><a name="index-g_t_005csection-166"></a><br><dt><code>\subsection</code><a name="index-g_t_005csubsection-167"></a><br><dt><code>\subsubsection</code><a name="index-g_t_005csubsubsection-168"></a><br><dt><code>\paragraph</code><a name="index-g_t_005cparagraph-169"></a><br><dt><code>\subparagraph</code><a name="index-g_t_005csubparagraph-170"></a><dd></dl> + + <p>All sectioning commands take the same general form, e.g., + +<pre class="example"> \chapter[<var>toctitle</var>]{<var>title</var>} +</pre> + <p>In addition to providing the heading <var>title</var> in the main text, the +section title can appear in two other places: + + <ol type=1 start=1> +<li>The table of contents. +<li>The running head at the top of the page. + </ol> + + <p>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. + + <p><a name="index-g_t_002a_002dform-of-sectioning-commands-171"></a>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: + +<pre class="example"> \section*{Preamble} +</pre> + <p><a name="index-g_t_005cappendix-172"></a><a name="index-appendix_002c-creating-173"></a>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 + +<pre class="example"> \chapter{A Chapter} + ... + \appendix + \chapter{The First Appendix} +</pre> + <div class="node"> +<p><hr> +<a name="Cross-references"></a> +Next: <a rel="next" accesskey="n" href="#Environments">Environments</a>, +Previous: <a rel="previous" accesskey="p" href="#Sectioning">Sectioning</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">7 Cross references</h2> + +<p><a name="index-cross-references-174"></a> +One reason for numbering things like figures and equations is to refer +the reader to them, as in “See Figure 3 for more details.” + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005clabel">\label</a>: Assign a symbolic name to a piece of text. +<li><a accesskey="2" href="#g_t_005cpageref">\pageref</a>: Refer to a page number. +<li><a accesskey="3" href="#g_t_005cref">\ref</a>: Refer to a section, figure or similar. +</ul> + +<div class="node"> +<p><hr> +<a name="%5clabel"></a> +<a name="g_t_005clabel"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cpageref">\pageref</a>, +Up: <a rel="up" accesskey="u" href="#Cross-references">Cross references</a> + +</div> + +<h3 class="section">7.1 <code>\label</code></h3> + +<p><a name="index-g_t_005clabel-175"></a> +Synopsis: + +<pre class="example"> \label{<var>key</var>} +</pre> + <p>A <code>\label</code> command appearing in ordinary text assigns to +<var>key</var> the number of the current sectional unit; one appearing +inside a numbered environment assigns that number to <var>key</var>. + + <p>A <var>key</var> name can consist of any sequence of letters, digits, or +punctuation characters. Upper and lowercase letters are distinguished. + + <p>To avoid accidentally creating two labels with the same name, it is +common to use labels consisting of a prefix and a suffix separated by +a colon or period. Some conventionally-used prefixes: + + <dl> +<dt><code>ch</code><dd>for chapters +<br><dt><code>sec</code><dd>for lower-level sectioning commands +<br><dt><code>fig</code><dd>for figures +<br><dt><code>tab</code><dd>for tables +<br><dt><code>eq</code><dd>for equations +</dl> + + <p>Thus, a label for a figure would look like <code>fig:snark</code> or +<code>fig.snark</code>. + +<div class="node"> +<p><hr> +<a name="%5cpageref"></a> +<a name="g_t_005cpageref"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cref">\ref</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005clabel">\label</a>, +Up: <a rel="up" accesskey="u" href="#Cross-references">Cross references</a> + +</div> + +<h3 class="section">7.2 <code>\pageref{</code><var>key</var><code>}</code></h3> + +<p><a name="index-g_t_005cpageref-176"></a><a name="index-cross-referencing-with-page-number-177"></a><a name="index-page-number_002c-cross-referencing-178"></a> +Synopsis: + +<pre class="example"> \pageref{<var>key</var>} +</pre> + <p>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. + +<div class="node"> +<p><hr> +<a name="%5cref"></a> +<a name="g_t_005cref"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cpageref">\pageref</a>, +Up: <a rel="up" accesskey="u" href="#Cross-references">Cross references</a> + +</div> + +<h3 class="section">7.3 <code>\ref{</code><var>key</var><code>}</code></h3> + +<p><a name="index-g_t_005cref-179"></a><a name="index-cross-referencing_002c-symbolic-180"></a><a name="index-section-number_002c-cross-referencing-181"></a><a name="index-equation-number_002c-cross-referencing-182"></a><a name="index-figure-number_002c-cross-referencing-183"></a><a name="index-footnote-number_002c-cross-referencing-184"></a> +Synopsis: + +<pre class="example"> \ref{<var>key</var>} +</pre> + <p>The <code>\ref</code> command produces the number of the sectional unit, +equation, footnote, figure, <small class="dots">...</small>, of the corresponding +<code>\label</code> command (see <a href="#g_t_005clabel">\label</a>). It does not produce any text, +such as the word `Section' or `Figure', just the bare number itself. + +<div class="node"> +<p><hr> +<a name="Environments"></a> +Next: <a rel="next" accesskey="n" href="#Line-breaking">Line breaking</a>, +Previous: <a rel="previous" accesskey="p" href="#Cross-references">Cross references</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">8 Environments</h2> + +<p><a name="index-environments-185"></a> +<a name="index-g_t_005cbegin-186"></a><a name="index-g_t_005cend-187"></a> +LaTeX provides many environments for marking off certain text. +Each environment begins and ends in the same manner: + +<pre class="example"> \begin{<var>envname</var>} + ... + \end{<var>envname</var>} +</pre> + <ul class="menu"> +<li><a accesskey="1" href="#abstract">abstract</a>: Produce an abstract. +<li><a accesskey="2" href="#array">array</a>: Math arrays. +<li><a accesskey="3" href="#center">center</a>: Centred lines. +<li><a accesskey="4" href="#description">description</a>: Labelled lists. +<li><a accesskey="5" href="#displaymath">displaymath</a>: Formulas that appear on their own line. +<li><a accesskey="6" href="#document">document</a>: Enclose the whole document. +<li><a accesskey="7" href="#enumerate">enumerate</a>: Numbered lists. +<li><a accesskey="8" href="#eqnarray">eqnarray</a>: Sequences of aligned equations. +<li><a accesskey="9" href="#equation">equation</a>: Displayed equation. +<li><a href="#figure">figure</a>: Floating figures. +<li><a href="#flushleft">flushleft</a>: Flushed left lines. +<li><a href="#flushright">flushright</a>: Flushed right lines. +<li><a href="#itemize">itemize</a>: Bulleted lists. +<li><a href="#letter">letter</a>: Letters. +<li><a href="#list">list</a>: Generic list environment. +<li><a href="#math">math</a>: In-line math. +<li><a href="#minipage">minipage</a>: Miniature page. +<li><a href="#picture">picture</a>: Picture with text, arrows, lines and circles. +<li><a href="#quotation">quotation</a>: Indented environment with paragraph indentation. +<li><a href="#quote">quote</a>: Indented environment with no paragraph indentation. +<li><a href="#tabbing">tabbing</a>: Align text arbitrarily. +<li><a href="#table">table</a>: Floating tables. +<li><a href="#tabular">tabular</a>: Align text in columns. +<li><a href="#thebibliography">thebibliography</a>: Bibliography or reference list. +<li><a href="#theorem">theorem</a>: Theorems, lemmas, etc. +<li><a href="#titlepage">titlepage</a>: For hand crafted title pages. +<li><a href="#verbatim">verbatim</a>: Simulating typed input. +<li><a href="#verse">verse</a>: For poetry and other things. +</ul> + +<div class="node"> +<p><hr> +<a name="abstract"></a> +Next: <a rel="next" accesskey="n" href="#array">array</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.1 <code>abstract</code></h3> + +<p><a name="index-abstract-_0040r_007benvironment_007d-188"></a><a name="index-abstracts-189"></a> +Synopsis: +<pre class="example"> \begin{abstract} + ... + \end{abstract} +</pre> + <p>Environment for producing an abstract, possibly of multiple paragraphs. + +<div class="node"> +<p><hr> +<a name="array"></a> +Next: <a rel="next" accesskey="n" href="#center">center</a>, +Previous: <a rel="previous" accesskey="p" href="#abstract">abstract</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.2 <code>array</code></h3> + +<p><a name="index-array-_0040r_007benvironment_007d-190"></a><a name="index-arrays_002c-math-191"></a> +Synopsis: + +<pre class="example"> \begin{array}{<var>template</var>} + <var>col1 text</var>&<var>col1 text</var>&<var>coln</var>}\\ + ... + \end{array} +</pre> + <p>Math arrays are produced with the <code>array</code> environment, normally +within an <code>equation</code> environment (see <a href="#equation">equation</a>). It has a +single mandatory <var>template</var> argument describing the number of +columns and the alignment within them. Each column <var>col</var> is +specified by a single letter that tells how items in that row should +be formatted, as follows: + + <dl> +<dt><code>c</code><dd>centered +<br><dt><code>l</code><dd>flush left +<br><dt><code>r</code><dd>flush right +</dl> + + <p><a name="index-g_t_005c_005c-_0028for-_0040code_007barray_007d_0029-192"></a>Column entries are separated by <code>&</code>. Column entries may include +other LaTeX commands. Each row of the array is terminated with +<code>\\</code>. + + <p><a name="index-g_t_0040_0040_0040_007b_002e_002e_002e_0040_007d-193"></a>In the template, the construct <code>@{</code><var>text</var><code>}</code> puts <var>text</var> +between columns in each row. + + <p>Here's an example: + +<pre class="example"> \begin{equation} + \begin{array}{lrc} + left1 & right1 & centered1 \\ + left2 & right2 & centered2 \\ + \end{array} + \end{equation} +</pre> + <p><a name="index-g_t_005carraycolsep-194"></a>The <code>\arraycolsep</code> parameter defines half the width of the space +separating columns; the default is ‘<samp><span class="samp">5pt</span></samp>’. See <a href="#tabular">tabular</a>, for other +parameters which affect formatting in <code>array</code> environments, +namely <code>\arrayrulewidth</code> and <code>\arraystretch</code>. + + <p>The <code>array</code> environment can only be used in math mode. + +<div class="node"> +<p><hr> +<a name="center"></a> +Next: <a rel="next" accesskey="n" href="#description">description</a>, +Previous: <a rel="previous" accesskey="p" href="#array">array</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.3 <code>center</code></h3> + +<p><a name="index-center-_0040r_007benvironment_007d-195"></a><a name="index-centering-text_002c-environment-for-196"></a> +Synopsis: + +<pre class="example"> \begin{center} + <var>line1</var> \\ + <var>line2</var> \\ + \end{center} +</pre> + <p><a name="index-g_t_005c_005c-_0028for-_0040code_007bcenter_007d_0029-197"></a>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>. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005ccentering">\centering</a>: Declaration form of the <code>center</code> environment. +</ul> + +<div class="node"> +<p><hr> +<a name="%5ccentering"></a> +<a name="g_t_005ccentering"></a> +Up: <a rel="up" accesskey="u" href="#center">center</a> + +</div> + +<h4 class="subsection">8.3.1 <code>\centering</code></h4> + +<p><a name="index-g_t_005ccentering-198"></a><a name="index-centering-text_002c-declaration-for-199"></a> +The <code>\centering</code> declaration corresponds to the <code>center</code> +environment. This declaration can be used inside an environment such +as <code>quote</code> or in a <code>parbox</code>. Thus, the text of a figure or +table can be centered on the page by putting a <code>\centering</code> +command at the beginning of the figure or table environment. + + <p>Unlike the <code>center</code> environment, the <code>\centering</code> command +does not start a new paragraph; it simply changes how LaTeX formats +paragraph units. To affect a paragraph unit's format, the scope of +the declaration must contain the blank line or <code>\end</code> command (of +an environment such as quote) that ends the paragraph unit. + + <p>Here's an example: + +<pre class="example"> \begin{quote} + \centering + first line \\ + second line \\ + \end{quote} +</pre> + <div class="node"> +<p><hr> +<a name="description"></a> +Next: <a rel="next" accesskey="n" href="#displaymath">displaymath</a>, +Previous: <a rel="previous" accesskey="p" href="#center">center</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.4 <code>description</code></h3> + +<p><a name="index-description-_0040r_007benvironment_007d-200"></a><a name="index-labelled-lists_002c-creating-201"></a><a name="index-description-lists_002c-creating-202"></a> +Synopsis: + +<pre class="example"> \begin{description} + \item [<var>label1</var>] <var>item1</var> + \item [<var>label2</var>] <var>item2</var> + ... + \end{description} +</pre> + <p><a name="index-g_t_005citem-203"></a>The <code>description</code> environment is used to make labelled lists. Each +<var>label</var> is typeset in bold, flush right. The <var>item</var> text may +contain multiple paragraphs. + + <p><a name="index-bold-typewriter_002c-avoiding-204"></a><a name="index-typewriter-labels-in-lists-205"></a>Another variation: since the bold style is applied to the labels, if +you typeset a label in typewriter using <code>\texttt</code>, you'll get +bold typewriter: <code>\item[\texttt{bold and typewriter}]</code>. This +may be too bold, among other issues. To get just typewriter, use +<code>\tt</code>, which resets all other style variations: <code>\item[{\tt +plain typewriter}]</code>. + + <p>For details about list spacing, see <a href="#itemize">itemize</a>. + +<div class="node"> +<p><hr> +<a name="displaymath"></a> +Next: <a rel="next" accesskey="n" href="#document">document</a>, +Previous: <a rel="previous" accesskey="p" href="#description">description</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.5 <code>displaymath</code></h3> + +<p><a name="index-displaymath-_0040r_007benvironment_007d-206"></a> +Synopsis: +<pre class="example"> \begin{displaymath} + <var>math</var> + \end{displaymath} +</pre> + <p class="noindent">or + +<pre class="example"> \[<var>math</var>\] +</pre> + <p>The <code>displaymath</code> environment (<code>\[...\]</code> is a synonym) +typesets the <var>math</var> text on its own line, centered by default. +The global <code>fleqn</code> option makes equations flush left; see +<a href="#Document-class-options">Document class options</a>. + + <p>No equation number is added to <code>displaymath</code> text; to get an +equation number, use the <code>equation</code> environment (see <a href="#equation">equation</a>). + +<div class="node"> +<p><hr> +<a name="document"></a> +Next: <a rel="next" accesskey="n" href="#enumerate">enumerate</a>, +Previous: <a rel="previous" accesskey="p" href="#displaymath">displaymath</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.6 <code>document</code></h3> + +<p><a name="index-document-_0040r_007benvironment_007d-207"></a> +The <code>document</code> environment encloses the body of a document. +It is required in every LaTeX document. See <a href="#Starting-_0026-ending">Starting & ending</a>. + +<div class="node"> +<p><hr> +<a name="enumerate"></a> +Next: <a rel="next" accesskey="n" href="#eqnarray">eqnarray</a>, +Previous: <a rel="previous" accesskey="p" href="#document">document</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.7 <code>enumerate</code></h3> + +<p><a name="index-enumerate-_0040r_007benvironment_007d-208"></a><a name="index-lists-of-items_002c-numbered-209"></a> +Synopsis: + +<pre class="example"> \begin{enumerate} + \item <var>item1</var> + \item <var>item2</var> + ... + \end{enumerate} +</pre> + <p>The <code>enumerate</code> environment produces a numbered list. Enumerations +can be nested within one another, up to four levels deep. They can also +be nested within other paragraph-making environments, such as +<code>itemize</code> (see <a href="#itemize">itemize</a>) and <code>description</code> +(see <a href="#description">description</a>). + + <p><a name="index-g_t_005citem-210"></a>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. + + <p>By default, the numbering at each level is done like this: + + <ol type=1 start=1> +<li>1., 2., <small class="dots">...</small> +<li>(a), (b), <small class="dots">...</small> +<li>i., ii., <small class="dots">...</small> +<li>A., B., <small class="dots">...</small> + </ol> + + <p><a name="index-g_t_005cenumi-211"></a><a name="index-g_t_005cenumii-212"></a><a name="index-g_t_005cenumiii-213"></a><a name="index-g_t_005cenumiv-214"></a>The <code>enumerate</code> environment uses the counters <code>\enumi</code> +through <code>\enumiv</code> counters (see <a href="#Counters">Counters</a>). If the optional +argument to <code>\item</code> is given, the counter is not incremented for +that item. + + <p><a name="index-g_t_005clabelenumi-215"></a><a name="index-g_t_005clabelenumii-216"></a><a name="index-g_t_005clabelenumiii-217"></a><a name="index-g_t_005clabelenumiv-218"></a>The <code>enumerate</code> environment uses the commands <code>\labelenumi</code> +through <code>\labelenumiv</code> to produce the default label. So, you can +use <code>\renewcommand</code> to change the labels (see <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>). For instance, to have the first level use uppercase +letters: + + <p><a name="index-g_t_005cAlph-_0040r_007bexample_007d-219"></a> +<pre class="example"> \renewcommand{\labelenumi}{\Alph{enumi}} +</pre> + <div class="node"> +<p><hr> +<a name="eqnarray"></a> +Next: <a rel="next" accesskey="n" href="#equation">equation</a>, +Previous: <a rel="previous" accesskey="p" href="#enumerate">enumerate</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.8 <code>eqnarray</code></h3> + +<p><a name="index-eqnarray-_0040r_007benvironment_007d-220"></a><a name="index-equations_002c-aligning-221"></a><a name="index-aligning-Equations-222"></a> +<pre class="example"> \begin{eqnarray} <span class="roman">(or </span><code>eqnarray*</code><span class="roman">)</span> + <var>formula1</var> \\ + <var>formula2</var> \\ + ... + \end{eqnarray} +</pre> + <p><a name="index-g_t_005c_005c-_0028for-_0040code_007beqnarray_007d_0029-223"></a>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>. + + <p><a name="index-g_t_005c_005c_002a-_0028for-_0040code_007beqnarray_007d_0029-224"></a><code>\\*</code> can also be used to separate equations, with its normal +meaning of not allowing a page break at that line. + + <p><a name="index-g_t_005cnonumber-225"></a><a name="index-equation-numbers_002c-omitting-226"></a>An equation number is placed on every line unless that line has a +<code>\nonumber</code> command. Alternatively, The <code>*</code>-form of the +environment (<code>\begin{eqnarray*} ... \end{eqnarray*}</code>) will +omit equation numbering entirely, while otherwise being the same as +<code>eqnarray</code>. + + <p><a name="index-g_t_005clefteqn-227"></a>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. + +<div class="node"> +<p><hr> +<a name="equation"></a> +Next: <a rel="next" accesskey="n" href="#figure">figure</a>, +Previous: <a rel="previous" accesskey="p" href="#eqnarray">eqnarray</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.9 <code>equation</code></h3> + +<p><a name="index-equation-_0040r_007benvironment_007d-228"></a><a name="index-equations_002c-environment-for-229"></a><a name="index-formulas_002c-environment-for-230"></a> +Synopsis: + +<pre class="example"> \begin{equation} + <var>math</var> + \end{equation} +</pre> + <p>The <code>equation</code> environment starts a <code>displaymath</code> +environment (see <a href="#displaymath">displaymath</a>), e.g., centering the <var>math</var> text +on the page, and also places an equation number in the right margin. + +<div class="node"> +<p><hr> +<a name="figure"></a> +Next: <a rel="next" accesskey="n" href="#flushleft">flushleft</a>, +Previous: <a rel="previous" accesskey="p" href="#equation">equation</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.10 <code>figure</code></h3> + +<p><a name="index-figure-231"></a><a name="index-inserting-figures-232"></a><a name="index-figures_002c-inserting-233"></a> +<pre class="example"> \begin{figure}[<var>placement</var>] + <var>figbody</var> + \label{<var>label}</var> + \caption[<var>loftitle</var>]{<var>text</var>} + \end{figure} +</pre> + <p>Figures are objects that are not part of the normal text, and are +instead “floated” to a convenient place, such as the top of a page. +Figures will not be split between two pages. + + <p>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: + + <ol type=1 start=1> +<li><code>h</code> (Here) - at the position in the text where the figure +environment appears. +<li><code>t</code> (Top) - at the top of a text page. +<li><code>b</code> (Bottom) - at the bottom of a text page. +<li><code>p</code> (Page of floats) - on a separate float page, which is a page +containing no text, only floats. + </ol> + + <p>The standard report and article classes use the default placement +<code>tbp</code>. + + <p>The body of the figure is made up of whatever text, LaTeX commands, etc. +you wish. + + <p><a name="index-g_t_005ccaption-234"></a>The <code>\caption</code> command specifies caption <var>text</var> for the +figure. The caption is numbered by default. If <var>loftitle</var> is +present, it is used in the list of figures instead of <var>text</var> +(see <a href="#Tables-of-contents">Tables of contents</a>). + +<!-- xx float-placement, float-caption sections? --> + +<a name="index-g_t_005cbottomfraction-235"></a> +<dl>The maximum fraction of the page allowed to be occuped by floats at +the bottom; default ‘<samp><span class="samp">.3</span></samp>’. + + <dt><code>\floatpagefraction</code><a name="index-g_t_005cfloatpagefraction-236"></a><dd>The minimum fraction of a float page that must be occupied by floats; +default ‘<samp><span class="samp">.5</span></samp>’. + + <br><dt><code>\floatsep</code><a name="index-g_t_005cfloatsep-237"></a><dd>Space between floats at the top or bottom of a page; default +‘<samp><span class="samp">12pt plus2pt minus2pt</span></samp>’. + + <br><dt><code>\intextsep</code><a name="index-g_t_005cintextsep-238"></a><dd>Space above and below a float in the middle of the main text; default +‘<samp><span class="samp">12pt plus2pt minus2pt</span></samp>’ for ‘<samp><span class="samp">10pt</span></samp>’ and ‘<samp><span class="samp">11pt</span></samp>’ styles, +‘<samp><span class="samp">14pt plus4pt minus4pt</span></samp>’ for ‘<samp><span class="samp">12pt</span></samp>’. + + <br><dt><code>\textfloatsep</code><a name="index-g_t_005ctextfloatsep-239"></a><dd>Space between the last (first) float at the top (bottom) of a page; +default ‘<samp><span class="samp">20pt plus2pt minus4pt</span></samp>’. + + <br><dt><code>\textfraction</code><a name="index-g_t_005ctextfraction-240"></a><dd>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><span class="samp">.2</span></samp>’. + + <br><dt><code>\topfraction</code><a name="index-g_t_005ctopfraction-241"></a><dd>Maximum fraction at the top of a page that may be occupied before +floats; default is ‘<samp><span class="samp">.7</span></samp>’. + + </dl> + +<div class="node"> +<p><hr> +<a name="flushleft"></a> +Next: <a rel="next" accesskey="n" href="#flushright">flushright</a>, +Previous: <a rel="previous" accesskey="p" href="#figure">figure</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.11 <code>flushleft</code></h3> + +<p><a name="index-flushleft-_0040r_007benvironment_007d-242"></a><a name="index-left_002djustifying-text_002c-environment-for-243"></a><a name="index-ragged-right-text_002c-environment-for-244"></a> +<pre class="example"> \begin{flushleft} + <var>line1</var> \\ + <var>line2</var> \\ + ... + \end{flushleft} +</pre> + <p><a name="index-g_t_005c_005c-_0040r_007bfor-_0040code_007bflushleft_007d_007d-245"></a>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>. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005craggedright">\raggedright</a>: Declaration form of the <code>flushleft</code> environment. +</ul> + +<div class="node"> +<p><hr> +<a name="%5craggedright"></a> +<a name="g_t_005craggedright"></a> +Up: <a rel="up" accesskey="u" href="#flushleft">flushleft</a> + +</div> + +<h4 class="subsection">8.11.1 <code>\raggedright</code></h4> + +<p><a name="index-g_t_005craggedright-246"></a><a name="index-ragged-right-text-247"></a><a name="index-left_002djustifying-text-248"></a><a name="index-justification_002c-ragged-right-249"></a> +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>. + + <p>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. + +<div class="node"> +<p><hr> +<a name="flushright"></a> +Next: <a rel="next" accesskey="n" href="#itemize">itemize</a>, +Previous: <a rel="previous" accesskey="p" href="#flushleft">flushleft</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.12 <code>flushright</code></h3> + +<p><a name="index-flushright-_0040r_007benvironment_007d-250"></a><a name="index-ragged-left-text_002c-environment-for-251"></a><a name="index-right_002djustifying-text_002c-environment-for-252"></a> +<pre class="example"> \begin{flushright} + <var>line1</var> \\ + <var>line2</var> \\ + ... + \end{flushright} +</pre> + <p><a name="index-g_t_005c_005c-_0028for-_0040code_007bflushright_007d_0029-253"></a>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>. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005craggedleft">\raggedleft</a>: Declaration form of the <code>flushright</code> environment. +</ul> + +<div class="node"> +<p><hr> +<a name="%5craggedleft"></a> +<a name="g_t_005craggedleft"></a> +Up: <a rel="up" accesskey="u" href="#flushright">flushright</a> + +</div> + +<h4 class="subsection">8.12.1 <code>\raggedleft</code></h4> + +<p><a name="index-g_t_005craggedleft-254"></a><a name="index-ragged-left-text-255"></a><a name="index-justification_002c-ragged-left-256"></a><a name="index-right_002djustifying-text-257"></a> +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>. + + <p>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. + +<div class="node"> +<p><hr> +<a name="itemize"></a> +Next: <a rel="next" accesskey="n" href="#letter">letter</a>, +Previous: <a rel="previous" accesskey="p" href="#flushright">flushright</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.13 <code>itemize</code></h3> + +<p><a name="index-itemize-_0040r_007benvironment_007d-258"></a><a name="index-g_t_005citem-259"></a><a name="index-lists-of-items-260"></a><a name="index-unordered-lists-261"></a><a name="index-bulleted-lists-262"></a> +Synopsis: + +<pre class="example"> \begin{itemize} + \item <var>item1</var> + \item <var>item2</var> + ... + \end{itemize} +</pre> + <p>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 <a href="#enumerate">enumerate</a>). + + <p>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. + + <p>By default, the marks at each level look like this: + + <ol type=1 start=1> +<li>• +<li><b>--<!-- /@w --></b> (bold en-dash) +<li>* +<li>. (centered dot, rendered here as a period) + </ol> + + <p><a name="index-g_t_005clabelitemi-263"></a><a name="index-g_t_005clabelitemii-264"></a><a name="index-g_t_005clabelitemiii-265"></a><a name="index-g_t_005clabelitemiv-266"></a>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: + +<pre class="example"> \renewcommand{\labelitemi}{$\diamond$} +</pre> + <p><a name="index-g_t_005cleftmargin-267"></a><a name="index-g_t_005cleftmargini-268"></a><a name="index-g_t_005cleftmarginii-269"></a><a name="index-g_t_005cleftmarginiii-270"></a><a name="index-g_t_005cleftmarginiv-271"></a><a name="index-g_t_005cleftmarginv-272"></a><a name="index-g_t_005cleftmarginvi-273"></a>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</code><var>N</var> when a new level of +nesting is entered. + + <p>The defaults vary from ‘<samp><span class="samp">.5em</span></samp>’ (highest levels of nesting) to +‘<samp><span class="samp">2.5em</span></samp>’ (first level), and are a bit reduced in two-column mode. +This example greatly reduces the margin space for outermost lists: + +<pre class="example"> \setlength{\leftmargini}{1.25em} % default 2.5em +</pre> + <!-- xx should be in its own generic section --> + <p>Some parameters that affect list formatting: + + <dl> +<dt><code>\itemindent</code><a name="index-g_t_005citemindent-274"></a><dd>Extra indentation before each item in a list; default zero. + + <br><dt><code>\labelsep</code><a name="index-g_t_005clabelsep-275"></a><dd>Space between the label and text of an item; default ‘<samp><span class="samp">.5em</span></samp>’. + + <br><dt><code>\labelwidth</code><a name="index-g_t_005clabelwidth-276"></a><dd>Width of the label; default ‘<samp><span class="samp">2em</span></samp>’, or ‘<samp><span class="samp">1.5em</span></samp>’ in two-column mode. + + <br><dt><code>\listparindent</code><a name="index-g_t_005clistparindent-277"></a><dd>Extra indentation added to second and subsequent paragraphs within a +list item; default ‘<samp><span class="samp">0pt</span></samp>’. + + <br><dt><code>\rightmargin</code><a name="index-g_t_005crightmargin-278"></a><dd>Horizontal distance between the right margin of the list and the +enclosing environment; default ‘<samp><span class="samp">0pt</span></samp>’, except in the <code>quote</code>, +<code>quotation</code>, and <code>verse</code> environments, where it is set equal +to <code>\leftmargin</code>. + + </dl> + + <p>Parameters affecting vertical spacing between list items (rather +loose, by default). + + <dl> +<dt><code>\itemsep</code><a name="index-g_t_005citemsep-279"></a><dd>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>. + + <br><dt><code>\parsep</code><a name="index-g_t_005cparsep-280"></a><dd>Extra vertical space between paragraphs within a list item. Defaults +are the same as <code>\itemsep</code>. + + <br><dt><code>\topsep</code><a name="index-g_t_005ctopsep-281"></a><dd>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>. + + <br><dt><code>\partopsep</code><a name="index-g_t_005cpartopsep-282"></a><dd>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>. + + <br><dt><code>\topsep</code><a name="index-g_t_005ctopsep-283"></a><dd>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><span class="samp">10pt</span></samp>’, it is ‘<samp><span class="samp">4pt +plus2pt minus2pt</span></samp>’. + + </dl> + + <p><a name="index-g_t_005cparskip-_0040r_007bexample_007d-284"></a>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 <a href="#g_t_005cparskip">\parskip</a>): + +<pre class="example"> \newenvironment{itemize*}% + {\begin{itemize}% + \setlength{\itemsep}{0pt}% + \setlength{\parsep}{0pt}}% + \setlength{\parskip}{0pt}}% + {\end{itemize}} +</pre> + <div class="node"> +<p><hr> +<a name="letter"></a> +Next: <a rel="next" accesskey="n" href="#list">list</a>, +Previous: <a rel="previous" accesskey="p" href="#itemize">itemize</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.14 <code>letter</code> environment: writing letters</h3> + +<p><a name="index-letter-285"></a> +This environment is used for creating letters. See <a href="#Letters">Letters</a>. + +<div class="node"> +<p><hr> +<a name="list"></a> +Next: <a rel="next" accesskey="n" href="#math">math</a>, +Previous: <a rel="previous" accesskey="p" href="#letter">letter</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.15 <code>list</code></h3> + +<p><a name="index-list-286"></a><a name="index-lists-of-items_002c-generic-287"></a> +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. + +<pre class="example"> \begin{list}{<var>labeling</var>}{<var>spacing</var>} + \item <var>item1</var> + \item <var>item2</var> + ... + \end{list} +</pre> + <p>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. + + <p>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. + +<div class="node"> +<p><hr> +<a name="math"></a> +Next: <a rel="next" accesskey="n" href="#minipage">minipage</a>, +Previous: <a rel="previous" accesskey="p" href="#list">list</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.16 <code>math</code></h3> + +<p><a name="index-math-_0040r_007benvironment_007d-288"></a><a name="index-in_002dline-formulas-289"></a> +Synopsis: + +<pre class="example"> \begin{math} + <var>math</var> + \end{math} +</pre> + <p>The <code>math</code> environment inserts the given <var>math</var> within the +running text. <code>\(...\))</code> and <code>$...$</code> are synonyms. +See <a href="#Math-formulas">Math formulas</a>. + +<div class="node"> +<p><hr> +<a name="minipage"></a> +Next: <a rel="next" accesskey="n" href="#picture">picture</a>, +Previous: <a rel="previous" accesskey="p" href="#math">math</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.17 <code>minipage</code></h3> + +<p><a name="index-minipage-_0040r_007benvironment_007d-290"></a><a name="index-minipage_002c-creating-a-291"></a> +<pre class="example"> \begin{minipage}[<var>position</var>]{<var>width</var>} + <var>text</var> + \end{minipage} +</pre> + <p>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 <a href="#g_t_005cparbox">\parbox</a>). You may use other +paragraph-making environments inside a minipage (unlike <code>\parbox</code>). + +<!-- (xxref positions) --> + <p>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. + + <p><a name="index-indentation-of-paragraphs_002c-in-minipage-292"></a><a name="index-paragraph-indentation_002c-in-minipage-293"></a><a name="index-g_t_005cparindent-294"></a>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. + + <p><a name="index-footnotes-in-figures-295"></a><a name="index-figures_002c-footnotes-in-296"></a>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 <a href="#Counters">Counters</a>). + + <p>However, don't put one minipage inside another if you are using +footnotes; they may wind up at the bottom of the wrong minipage. + +<div class="node"> +<p><hr> +<a name="picture"></a> +Next: <a rel="next" accesskey="n" href="#quotation">quotation</a>, +Previous: <a rel="previous" accesskey="p" href="#minipage">minipage</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.18 <code>picture</code></h3> + +<p><a name="index-picture-297"></a><a name="index-creating-pictures-298"></a><a name="index-pictures_002c-creating-299"></a> +<pre class="example"> \begin{picture}(width,height)(x offset,y offset) + ... <var>picture commands</var> ... + \end{picture} +</pre> + <p><a name="index-g_t_005cunitlength-300"></a>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. + + <p>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. + + <p>The <code>picture</code> environment has one mandatory argument, which is a +<code>position</code>. It specifies the size of the picture. The environment +produces a rectangular box with width and height determined by this +argument's x- and y-coordinates. + + <p>The <code>picture</code> environment 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 +<pre class="example"> \begin{picture}(100,200)(10,20) +</pre> + <p>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. + + <p>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. + + <p>Everything that appears in a picture is drawn by the <code>\put</code> +command. The command + +<pre class="example"> \put (11.3,-.3){...} +</pre> + <p class="noindent">puts the object specified by <code>...</code> in the +picture, with its reference point at coordinates (11.3,-.3). +The reference points for various objects will be described below. + + <p><a name="index-lR-box-301"></a>The <code>\put</code> command creates an <dfn>LR box</dfn>. You can put anything +that can go in an <code>\mbox</code> (see <a href="#g_t_005cmbox">\mbox</a>) 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. + + <p>The <code>picture</code> commands are described in the following sections. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005ccircle">\circle</a>: Draw a circle. +<li><a accesskey="2" href="#g_t_005cmakebox-_0028picture_0029">\makebox (picture)</a>: Draw a box of the specified size. +<li><a accesskey="3" href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a>: Draw a box with a frame around it. +<li><a accesskey="4" href="#g_t_005cdashbox">\dashbox</a>: Draw a dashed box. +<li><a accesskey="5" href="#g_t_005cframe">\frame</a>: Draw a frame around an object. +<li><a accesskey="6" href="#g_t_005cline">\line</a>: Draw a straight line. +<li><a accesskey="7" href="#g_t_005clinethickness">\linethickness</a>: Set the line thickness. +<li><a accesskey="8" href="#g_t_005cthicklines">\thicklines</a>: A heavier line thickness. +<li><a accesskey="9" href="#g_t_005cthinlines">\thinlines</a>: The default line thickness. +<li><a href="#g_t_005cmultiput">\multiput</a>: Draw multiple instances of an object. +<li><a href="#g_t_005coval">\oval</a>: Draw an ellipse. +<li><a href="#g_t_005cput">\put</a>: Place an object at a specified place. +<li><a href="#g_t_005cshortstack">\shortstack</a>: Make a pile of objects. +<li><a href="#g_t_005cvector">\vector</a>: Draw a line with an arrow. +</ul> + +<div class="node"> +<p><hr> +<a name="%5ccircle"></a> +<a name="g_t_005ccircle"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cmakebox-_0028picture_0029">\makebox (picture)</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.1 <code>\circle</code></h4> + +<p><a name="index-g_t_005ccircle-302"></a> +<pre class="example"> \circle[*]{<var>diameter</var>} +</pre> + <p>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. + + <p>Circles up to 40 pt can be drawn. + +<div class="node"> +<p><hr> +<a name="%5cmakebox-(picture)"></a> +<a name="g_t_005cmakebox-_0028picture_0029"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005ccircle">\circle</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.2 <code>\makebox</code></h4> + +<p><a name="index-g_t_005cmakebox-_0028picture_0029-303"></a> +<code>\makebox(width,height)[position]{...}</code> + + <p>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>. + + <p>The optional argument, <code>[position]</code>, specifies the quadrant that +your text appears in. You may select up to two of the following: + + <ul> +<li><code>t</code> - Moves the item to the top of the rectangle +<li><code>b</code> - Moves the item to the bottom +<li><code>l</code> - Moves the item to the left +<li><code>r</code> - Moves the item to the right +</ul> + + <p>See <a href="#g_t_005cmakebox">\makebox</a>. + +<div class="node"> +<p><hr> +<a name="%5cframebox-(picture)"></a> +<a name="g_t_005cframebox-_0028picture_0029"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cdashbox">\dashbox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cmakebox-_0028picture_0029">\makebox (picture)</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.3 <code>\framebox</code></h4> + +<p><a name="index-g_t_005cframebox-304"></a> +Synopsis: + +<pre class="example"> \framebox(<var>width</var>,<var>height</var>)[<var>pos</var>]{...} +</pre> + <p>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. + + <p><a name="index-g_t_005cfboxrule-305"></a><a name="index-g_t_005cfboxsep-306"></a>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. + +<div class="node"> +<p><hr> +<a name="%5cdashbox"></a> +<a name="g_t_005cdashbox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cframe">\frame</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.4 <code>\dashbox</code></h4> + +<p><a name="index-g_t_005cdashbox-307"></a> +Draws a box with a dashed line. Synopsis: + +<pre class="example"> \dashbox{<var>dlen</var>}(<var>rwidth</var>,<var>rheight</var>)[<var>pos</var>]{<var>text</var>} +</pre> + <p><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. --> + + <p>A dashed box looks best when the <code>rwidth</code> and <code>rheight</code> are +multiples of the <code>dlen</code>. + +<div class="node"> +<p><hr> +<a name="%5cframe"></a> +<a name="g_t_005cframe"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cline">\line</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cdashbox">\dashbox</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.5 <code>\frame</code></h4> + +<p><a name="index-g_t_005cframe-308"></a> +Synopsis: + +<pre class="example"> \frame{<var>text</var>} +</pre> + <p>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. + +<div class="node"> +<p><hr> +<a name="%5cline"></a> +<a name="g_t_005cline"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005clinethickness">\linethickness</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cframe">\frame</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.6 <code>\line</code></h4> + +<p><a name="index-g_t_005cline-309"></a> +Synopsis: + +<pre class="example"> \line(<var>xslope</var>,<var>yslope</var>){<var>length</var>} +</pre> + <p>The <code>\line</code> command draws a line with the given <var>length</var> and +slope <var>xslope</var>/<var>yslope</var>. + + <p>Standard LaTeX can only draw lines with <var>slope</var> = x/y, +where x and y 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. + +<div class="node"> +<p><hr> +<a name="%5clinethickness"></a> +<a name="g_t_005clinethickness"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cthicklines">\thicklines</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cline">\line</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.7 <code>\linethickness</code></h4> + +<p><a name="index-g_t_005clinethickness-310"></a> +The <code>\linethickness{</code><var>dim</var><code>}</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. + + <p><code>\linethickness</code> does not affect the thickness of slanted lines, +circles, or the quarter circles drawn by <code>\oval</code>. + +<div class="node"> +<p><hr> +<a name="%5cthicklines"></a> +<a name="g_t_005cthicklines"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cthinlines">\thinlines</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005clinethickness">\linethickness</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.8 <code>\thicklines</code></h4> + +<p><a name="index-g_t_005cthicklines-311"></a> +The <code>\thicklines</code> command is an alternate line thickness for +horizontal and vertical lines in a picture environment; +cf. <a href="#g_t_005clinethickness">\linethickness</a> and <a href="#g_t_005cthinlines">\thinlines</a>. + +<div class="node"> +<p><hr> +<a name="%5cthinlines"></a> +<a name="g_t_005cthinlines"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cmultiput">\multiput</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cthicklines">\thicklines</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.9 <code>\thinlines</code></h4> + +<p><a name="index-g_t_005cthinlines-312"></a> +The <code>\thinlines</code> command is the default line thickness for +horizontal and vertical lines in a picture environment; +cf. <a href="#g_t_005clinethickness">\linethickness</a> and <a href="#g_t_005cthicklines">\thicklines</a>. + +<div class="node"> +<p><hr> +<a name="%5cmultiput"></a> +<a name="g_t_005cmultiput"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005coval">\oval</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cthinlines">\thinlines</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.10 <code>\multiput</code></h4> + +<p><a name="index-g_t_005cmultiput-313"></a> +Synopsis: +<pre class="example"> \multiput(<var>x</var>,<var>y</var>)(<var>delta_x</var>,<var>delta_y</var>){<var>n</var>}{<var>obj</var>} +</pre> + <p>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 +(x,y), then at (x+\delta x,y+\delta y), and so on, +<var>n</var> times. + +<div class="node"> +<p><hr> +<a name="%5coval"></a> +<a name="g_t_005coval"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cput">\put</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cmultiput">\multiput</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.11 <code>\oval</code></h4> + +<p><a name="index-g_t_005coval-314"></a> +Synopsis: + +<pre class="example"> \oval(<var>width</var>,<var>height</var>)[<var>portion</var>] +</pre> + <p>The <code>\oval</code> command produces a rectangle with rounded corners. +The optional argument <var>portion</var> allows you to select part of the +oval via the following: + + <dl> +<dt><code>t</code><dd>selects the top portion; +<br><dt><code>b</code><dd>selects the bottom portion; +<br><dt><code>r</code><dd>selects the right portion; +<br><dt><code>l</code><dd>selects the left portion. +</dl> + + <p>The “corners” of the oval are made with quarter circles with a +maximum radius of 20<span class="dmn">pt</span>, so large “ovals” will look more like +boxes with rounded corners. + +<div class="node"> +<p><hr> +<a name="%5cput"></a> +<a name="g_t_005cput"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cshortstack">\shortstack</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005coval">\oval</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.12 <code>\put</code></h4> + +<p><a name="index-g_t_005cput-315"></a> +<code>\put(x coord,y coord){ ... }</code> + + <p>The <code>\put</code> command places the item specified by the mandatory +argument at the given coordinates. + +<div class="node"> +<p><hr> +<a name="%5cshortstack"></a> +<a name="g_t_005cshortstack"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cvector">\vector</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cput">\put</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.13 <code>\shortstack</code></h4> + +<p><a name="index-g_t_005cshortstack-316"></a> +Synopsis: + +<pre class="example"> \shortstack[<var>position</var>]{...\\...\\...} +</pre> + <p>The <code>\shortstack</code> command produces a stack of objects. The valid +positions are: + + <dl> +<dt><code>r</code><dd>Move the objects to the right of the stack. +<br><dt><code>l</code><dd>Move the objects to the left of the stack +<br><dt><code>c</code><dd>Move the objects to the centre of the stack (default) +</dl> + + <p><a name="index-g_t_005c_005c-_0040r_007b_0028for-_0040code_007b_005cshortstack_007d-objects_0029_007d-317"></a>Objects are separated with <code>\\</code>. + +<div class="node"> +<p><hr> +<a name="%5cvector"></a> +<a name="g_t_005cvector"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cshortstack">\shortstack</a>, +Up: <a rel="up" accesskey="u" href="#picture">picture</a> + +</div> + +<h4 class="subsection">8.18.14 <code>\vector</code></h4> + +<p><a name="index-g_t_005cvector-318"></a> +Synopsis: + +<pre class="example"> \vector(<var>x-slope</var>,<var>y-slope</var>){<var>length</var>} +</pre> + <p>The <code>\vector</code> command draws a line with an arrow of the specified +length and slope. The x and y values must lie between +−4 and +4, inclusive. + +<div class="node"> +<p><hr> +<a name="quotation"></a> +Next: <a rel="next" accesskey="n" href="#quote">quote</a>, +Previous: <a rel="previous" accesskey="p" href="#picture">picture</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.19 <code>quotation</code></h3> + +<p><a name="index-quotation-319"></a><a name="index-quoted-text-with-paragraph-indentation_002c-displaying-320"></a><a name="index-displaying-quoted-text-with-paragraph-indentation-321"></a><a name="index-paragraph-indentations-in-quoted-text-322"></a> +Synopsis: + +<pre class="example"> \begin{quotation} + <var>text</var> + \end{quotation} +</pre> + <p>The margins of the <code>quotation</code> environment are indented on both +the left and the right. The text is justified at both margins. +Leaving a blank line between text produces a new paragraph. + + <p>Unlike the <code>quote</code> environment, each paragraph is indented +normally. + +<div class="node"> +<p><hr> +<a name="quote"></a> +Next: <a rel="next" accesskey="n" href="#tabbing">tabbing</a>, +Previous: <a rel="previous" accesskey="p" href="#quotation">quotation</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.20 <code>quote</code></h3> + +<p><a name="index-quote-323"></a><a name="index-quoted-text-without-paragraph-indentation_002c-displaying-324"></a><a name="index-displaying-quoted-text-without-paragraph-indentation-325"></a><a name="index-paragraph-indentations-in-quoted-text_002c-omitting-326"></a> +Snyopsis: + +<pre class="example"> \begin{quote} + <var>text</var> + \end{quote} +</pre> + <p>The margins of the <code>quote</code> environment are indented on both the +left and the right. The text is justified at both margins. Leaving a +blank line between text produces a new paragraph. + + <p>Unlike the <code>quotation</code> environment, paragraphs are not indented. + +<div class="node"> +<p><hr> +<a name="tabbing"></a> +Next: <a rel="next" accesskey="n" href="#table">table</a>, +Previous: <a rel="previous" accesskey="p" href="#quote">quote</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.21 <code>tabbing</code></h3> + +<p><a name="index-tabbing-_0040r_007benvironment_007d-327"></a><a name="index-tab-stops_002c-using-328"></a><a name="index-lining-text-up-in-columns-using-tab-stops-329"></a><a name="index-alignment-via-tabbing-330"></a> +Synopsis: + +<pre class="example"> \begin{tabbing} + <var>row1col1</var> \= <var>row1col2</var> \= <var>row1col3</var> \= <var>row1col4</var> \\ + <var>row2col1</var> \> \> <var>row2col3</var> \\ + ... + \end{tabbing} +</pre> + <p>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. + + <p>This environment can be broken across pages, unlike the <code>tabular</code> +environment. + + <p>The following commands can be used inside a <code>tabbing</code> enviroment: + + <dl> +<dt><code>\\ </code><span class="roman">tabbing</span><a name="index-g_t_005c_005c-_0040r_007btabbing_007d-331"></a><dd>End a line. + + <br><dt><code>\= </code><span class="roman">(tabbing)</span><a name="index-g_t_005c_003d-_0040r_007b_0028tabbing_0029_007d-332"></a><dd>Sets a tab stop at the current position. + + <br><dt><code>\> </code><span class="roman">(tabbing)</span><a name="index-g_t_005c_003e-_0040r_007b_0028tabbing_0029_007d-333"></a><dd><a name="index-g_t_005c_003e-334"></a>Advances to the next tab stop. + + <br><dt><code>\<</code><a name="index-g_t_005c_003c-335"></a><dd>Put following text to the left of the local margin (without changing +the margin). Can only be used at the start of the line. + + <br><dt><code>\+</code><a name="index-g_t_005c_002b-336"></a><dd>Moves the left margin of the next and all the +following commands one tab stop to the right, beginning tabbed line if +necessary. + + <br><dt><code>\-</code><a name="index-g_t_005c_002d-337"></a><dd>Moves the left margin of the next and all the +following commands one tab stop to the left, beginning tabbed line if +necessary. + + <br><dt><code>\' </code><span class="roman">(tabbing)</span><a name="index-g_t_005c_0027-_0040r_007b_0028tabbing_0029_007d-338"></a><dd>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. + + <br><dt><code>\` </code><span class="roman">(tabbing)</span><a name="index-g_t_005c_0060-_0040r_007b_0028tabbing_0029_007d-339"></a><dd>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. + + <br><dt><code>\a </code><span class="roman">(tabbing)</span><a name="index-g_t_005ca-_0040r_007b_0028tabbing_0029_007d-340"></a><dd><a name="index-g_t_005ca_0027-_0040r_007b_0028acute-accent-in-tabbing_0029_007d-341"></a><a name="index-g_t_005ca_0060-_0040r_007b_0028grave-accent-in-tabbing_0029_007d-342"></a><a name="index-g_t_005ca_003d-_0040r_007b_0028macron-accent-in-tabbing_0029_007d-343"></a>In a <code>tabbing</code> environment, the commands <code>\=</code>, <code>\'</code> and +<code>\`</code> do not produce accents as usual (see <a href="#Accents">Accents</a>). Instead, +the commands <code>\a=</code>, <code>\a'</code> and <code>\a`</code> are used. + + <br><dt><code>\kill</code><a name="index-g_t_005ckill-344"></a><dd>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. + + <br><dt><code>\poptabs</code><a name="index-g_t_005cpoptabs-345"></a><dd><a name="index-g_t_005cpoptabs-346"></a>Restores the tab stop positions saved by the last <code>\pushtabs</code>. + + <br><dt><code>\pushtabs</code><a name="index-g_t_005cpushtabs-347"></a><dd>Saves all current tab stop positions. Useful for temporarily changing +tab stop positions in the middle of a <code>tabbing</code> environment. + + <br><dt><code>\tabbingsep</code><a name="index-g_t_005ctabbingsep-348"></a><dd>Distance to left of tab stop moved by <code>\'</code>. + + </dl> + + <p>This example typesets a Pascal function in a traditional format: + +<pre class="example"> \begin{tabbing} + function \= fact(n : integer) : integer;\\ + \> begin \= \+ \\ + \> if \= n $>$ 1 then \+ \\ + fact := n * fact(n-1) \- \\ + else \+ \\ + fact := 1; \-\- \\ + end;\\ + \end{tabbing} +</pre> + <div class="node"> +<p><hr> +<a name="table"></a> +Next: <a rel="next" accesskey="n" href="#tabular">tabular</a>, +Previous: <a rel="previous" accesskey="p" href="#tabbing">tabbing</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.22 <code>table</code></h3> + +<p><a name="index-table-349"></a><a name="index-tables_002c-creating-350"></a><a name="index-creating-tables-351"></a> +Synopsis: + +<pre class="example"> \begin{table}[placement] + + body of the table + + \caption{table title} + \end{table} +</pre> + <p>Tables are objects that are not part of the normal text, and are +usually “floated” to a convenient place, like the top of a page. +Tables will not be split between two pages. + + <p>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: + + <ul> +<li><code>h</code>: Here - at the position in the text where the table +environment appears. +<li><code>t</code>: Top - at the top of a text page. +<li><code>b</code>: Bottom - at the bottom of a text page. +<li><code>p</code>: Page of floats - on a separate float page, which is a page +containing no text, only floats. +</ul> + + <p>The standard <code>report</code> and <code>article</code> classes use the default +placement <code>[tbp]</code>. + + <p>The body of the table is made up of whatever text, LaTeX commands, etc., +you wish. The <code>\caption</code> command allows you to title your table. + +<div class="node"> +<p><hr> +<a name="tabular"></a> +Next: <a rel="next" accesskey="n" href="#thebibliography">thebibliography</a>, +Previous: <a rel="previous" accesskey="p" href="#table">table</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.23 <code>tabular</code></h3> + +<p><a name="index-tabular-_0040r_007benvironment_007d-352"></a><a name="index-lines-in-tables-353"></a><a name="index-lining-text-up-in-tables-354"></a> +Synopsis: + +<pre class="example"> \begin{tabular}[pos]{cols} + column 1 entry & column 2 entry ... & column n entry \\ + ... + \end{tabular} +</pre> + <p>or + +<pre class="example"> \begin{tabular*}{width}[pos]{cols} + column 1 entry & column 2 entry ... & column n entry \\ + ... + \end{tabular*} +</pre> + <p>These environments produce a box consisting of a sequence of rows of +items, aligned vertically in columns. + + <p><a name="index-g_t_005c_005c-_0040r_007bfor-_0040code_007btabular_007d_007d-355"></a><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. + + <p>The mandatory and optional arguments consist of: + + <dl> +<dt><code>width</code><dd>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. +<br><dt><code>pos</code><dd>Specifies the vertical position; default is alignment on the centre of +the environment. + + <ul> +<li><code>t</code> - align on top row +<li><code>b</code> - align on bottom row +</ul> + + <br><dt><code>cols</code><dd>Specifies the column formatting. It consists of a sequence of the +following specifiers, corresponding to the sequence of columns and +intercolumn material. + + <ul> +<li><code>l</code> - A column of left-aligned items. +<li><code>r</code> - A column of right-aligned items. +<li><code>c</code> - A column of centred items. +<li><code>|</code> - A vertical line the full height and depth of the environment. +<li><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. +<li><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: + <ol type=1 start=1> +<li>inside an environment like <code>minipage</code>, <code>array</code>, or <code>tabular</code>. +<li>inside an explicit <code>\parbox</code>. +<li>in the scope of a <code>\centering</code>, <code>\raggedright</code>, or <code>\raggedleft</code> +declaration. The latter declarations must appear inside braces or an +environment when used in a <code>p</code>-column element. + </ol> +<li><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>. + + </ul> + + </dl> + + <p>Parameters that control formatting: +<!-- xx defaults, own node (xref from array)? --> + + <dl> +<dt><code>\arrayrulewidth</code><a name="index-g_t_005carrayrulewidth-356"></a><dd>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><span class="samp">.4pt</span></samp>’. + + <br><dt><code>\arraystretch</code><a name="index-g_t_005carraystretch-357"></a><dd>Scaling of spacing between rows in the <code>tabular</code> and <code>array</code> +environments; default is ‘<samp><span class="samp">1</span></samp>’,for no scaling. + + <br><dt><code>\doublerulesep</code><a name="index-g_t_005cdoublerulesep-358"></a><dd>Horizontal distance between the vertical rules produced by <code>||</code> +in the <code>tabular</code> and <code>array</code> environments; default is ‘<samp><span class="samp">2pt</span></samp>’. + + <br><dt><code>\tabcolsep</code><a name="index-g_t_005ctabcolsep-359"></a><dd>Half the width of the space between columns; default is ‘<samp><span class="samp">6pt</span></samp>’. + + </dl> + + <p>These commands can be used inside a <code>tabular</code> environment: + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cmulticolumn">\multicolumn</a>: Make an item spanning several columns. +<li><a accesskey="2" href="#g_t_005ccline">\cline</a>: Draw a horizontal line spanning some columns. +<li><a accesskey="3" href="#g_t_005chline">\hline</a>: Draw a horizontal line spanning all columns. +<li><a accesskey="4" href="#g_t_005cvline">\vline</a>: Draw a vertical line. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cmulticolumn"></a> +<a name="g_t_005cmulticolumn"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005ccline">\cline</a>, +Up: <a rel="up" accesskey="u" href="#tabular">tabular</a> + +</div> + +<h4 class="subsection">8.23.1 <code>\multicolumn</code></h4> + +<p><a name="index-g_t_005cmulticolumn-360"></a> +Synopsis: +<pre class="example"> \multicolumn{<var>cols</var>}{<var>pos</var>}{<var>text</var>} +</pre> + <p>The <code>\multicolumn</code> command makes an entry that spans several +columns. The first mandatory argument, <var>cols</var>, specifies the +number of columns to span. The second mandatory argument, <var>pos</var>, +specifies the formatting of the entry; <code>c</code> for centered, <code>l</code> +for flushleft, <code>r</code> for flushright. The third mandatory argument, +<var>text</var>, specifies what text to put in the entry. + + <p>Here's an example showing two columns separated by an en-dash; +<code>\multicolumn</code> is used for the heading: + +<pre class="example"> \begin{tabular}{r@{--}l} + \multicolumn{2}{c}{\bf Unicode}\cr + 0x80&0x7FF \cr + 0x800&0xFFFF \cr + 0x10000&0x1FFFF \cr + \end{tabular} +</pre> + <div class="node"> +<p><hr> +<a name="%5ccline"></a> +<a name="g_t_005ccline"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005chline">\hline</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cmulticolumn">\multicolumn</a>, +Up: <a rel="up" accesskey="u" href="#tabular">tabular</a> + +</div> + +<h4 class="subsection">8.23.2 <code>\cline</code></h4> + +<p><a name="index-g_t_005ccline-361"></a> +Synopsis: + +<pre class="example"> \cline{<var>i</var>-<var>j</var>} +</pre> + <p>The <code>\cline</code> command draws horizontal lines across the columns +specified, beginning in column <var>i</var> and ending in column <var>j</var>, +which are specified in the mandatory argument. + +<div class="node"> +<p><hr> +<a name="%5chline"></a> +<a name="g_t_005chline"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cvline">\vline</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005ccline">\cline</a>, +Up: <a rel="up" accesskey="u" href="#tabular">tabular</a> + +</div> + +<h4 class="subsection">8.23.3 <code>\hline</code></h4> + +<p><a name="index-g_t_005chline-362"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5cvline"></a> +<a name="g_t_005cvline"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005chline">\hline</a>, +Up: <a rel="up" accesskey="u" href="#tabular">tabular</a> + +</div> + +<h4 class="subsection">8.23.4 <code>\vline</code></h4> + +<p><a name="index-g_t_005cvline-363"></a> +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. + +<div class="node"> +<p><hr> +<a name="thebibliography"></a> +Next: <a rel="next" accesskey="n" href="#theorem">theorem</a>, +Previous: <a rel="previous" accesskey="p" href="#tabular">tabular</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.24 <code>thebibliography</code></h3> + +<p><a name="index-thebibliography-364"></a><a name="index-bibliography_002c-creating-_0028manually_0029-365"></a> +Synopsis: + +<pre class="example"> \begin{thebibliography}{<var>widest-label</var>} + \bibitem[<var>label</var>]{<var>cite_key}</var> + ... + \end{thebibliography} +</pre> + <p>The <code>thebibliography</code> environment produces a bibliography or +reference list. + + <p>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: + +<pre class="example"> \renewcommand{\refname}{} +</pre> + <p>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. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cbibitem">\bibitem</a>: Specify a bibliography item. +<li><a accesskey="2" href="#g_t_005ccite">\cite</a>: Refer to a bibliography item. +<li><a accesskey="3" href="#g_t_005cnocite">\nocite</a>: Include an item in the bibliography. +<li><a accesskey="4" href="#Using-BibTeX">Using BibTeX</a>: Automatic generation of bibliographies. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cbibitem"></a> +<a name="g_t_005cbibitem"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005ccite">\cite</a>, +Up: <a rel="up" accesskey="u" href="#thebibliography">thebibliography</a> + +</div> + +<h4 class="subsection">8.24.1 <code>\bibitem</code></h4> + +<p><a name="index-g_t_005cbibitem-366"></a> +Synopsis: +<pre class="example"> \bibitem[<var>label</var>]{<var>cite_key</var>} +</pre> + <p>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. + + <p>This command writes an entry to the <samp><span class="file">.aux</span></samp> file containing the +item's <var>cite_key</var> and label. When the <samp><span class="file">.aux</span></samp> 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. + +<div class="node"> +<p><hr> +<a name="%5ccite"></a> +<a name="g_t_005ccite"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnocite">\nocite</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cbibitem">\bibitem</a>, +Up: <a rel="up" accesskey="u" href="#thebibliography">thebibliography</a> + +</div> + +<h4 class="subsection">8.24.2 <code>\cite</code></h4> + +<p><a name="index-g_t_005ccite-367"></a> +Synopsis: + +<pre class="example"> \cite[<var>subcite</var>]{<var>keys</var> +</pre> + <p>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 +<samp><span class="file">.aux</span></samp> file. + + <p>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]'. + +<div class="node"> +<p><hr> +<a name="%5cnocite"></a> +<a name="g_t_005cnocite"></a> +Next: <a rel="next" accesskey="n" href="#Using-BibTeX">Using BibTeX</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005ccite">\cite</a>, +Up: <a rel="up" accesskey="u" href="#thebibliography">thebibliography</a> + +</div> + +<h4 class="subsection">8.24.3 <code>\nocite</code></h4> + +<p><a name="index-g_t_005cnocite-368"></a> +<code>\nocite{key_list}</code> + + <p>The <code>\nocite</code> command produces no text, but writes <code>key_list</code>, +which is a list of one or more citation keys, on the <samp><span class="file">.aux</span></samp> file. + +<div class="node"> +<p><hr> +<a name="Using-BibTeX"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnocite">\nocite</a>, +Up: <a rel="up" accesskey="u" href="#thebibliography">thebibliography</a> + +</div> + +<h4 class="subsection">8.24.4 Using BibTeX</h4> + +<p><a name="index-using-Bib_0040TeX_007b_007d-369"></a><a name="index-bib_0040TeX_007b_007d_002c-using-370"></a><a name="index-bibliography_002c-creating-_0028automatically_0029-371"></a><a name="index-g_t_005cbibliographystyle-372"></a><a name="index-g_t_005cbibliography-373"></a> +If you use the BibTeX 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 <a href="#thebibliography">thebibliography</a>). Instead, +you include the lines + +<pre class="example"> \bibliographystyle{<var>bibstyle</var>} + \bibliography{<var>bibfile1</var>,<var>bibfile2</var>} +</pre> + <p>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><samp><span class="file">.bst</span></samp>, which defines how your citations will look. +The standard <var>style</var> names distributed with BibTeX are: + + <dl> +<dt><code>alpha</code><dd>Sorted alphabetically. Labels are formed from name of author and year of +publication. +<br><dt><code>plain</code><dd>Sorted alphabetically. Labels are numeric. +<br><dt><code>unsrt</code><dd>Like <code>plain</code>, but entries are in order of citation. +<br><dt><code>abbrv</code><dd>Like <code>plain</code>, but more compact labels. +</dl> + + <p>In addition, numerous other BibTeX style files exist tailored to +the demands of various publications. See +<a href="http://www.ctan.org/tex-archive/biblio/bibtex/contrib">http://www.ctan.org/tex-archive/biblio/bibtex/contrib</a>. + + <p>The <code>\bibliography</code> command is what actually produces the +bibliography. The argument to <code>\bibliography</code> refers to files +named <samp><var>bibfile</var><span class="file">.bib</span></samp>, which should contain your database in +BibTeX format. Only the entries referred to via <code>\cite</code> and +<code>\nocite</code> will be listed in the bibliography. + +<div class="node"> +<p><hr> +<a name="theorem"></a> +Next: <a rel="next" accesskey="n" href="#titlepage">titlepage</a>, +Previous: <a rel="previous" accesskey="p" href="#thebibliography">thebibliography</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.25 <code>theorem</code></h3> + +<p><a name="index-theorem-_0040r_007benvironment_007d-374"></a><a name="index-theorems_002c-typesetting-375"></a> +Synopsis: + +<pre class="example"> \begin{theorem} + <var>theorem-text</var> + \end{theorem} +</pre> + <p>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 <a href="#g_t_005cnewtheorem">\newtheorem</a>). + +<div class="node"> +<p><hr> +<a name="titlepage"></a> +Next: <a rel="next" accesskey="n" href="#verbatim">verbatim</a>, +Previous: <a rel="previous" accesskey="p" href="#theorem">theorem</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.26 <code>titlepage</code></h3> + +<p><a name="index-titlepage-_0040r_007benvironment_007d-376"></a><a name="index-making-a-title-page-377"></a><a name="index-title-pages_002c-creating-378"></a> +Synopsis: + +<pre class="example"> \begin{titlepage} + <var>text</var> + \end{titlepage} +</pre> + <p>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 <a href="#g_t_005ctoday">\today</a>). + + <p>You can use the <code>\maketitle</code> command (see <a href="#g_t_005cmaketitle">\maketitle</a>) to +produce a standard title page without a <code>titlepage</code> environment. + +<div class="node"> +<p><hr> +<a name="verbatim"></a> +Next: <a rel="next" accesskey="n" href="#verse">verse</a>, +Previous: <a rel="previous" accesskey="p" href="#titlepage">titlepage</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.27 <code>verbatim</code></h3> + +<p><a name="index-verbatim-_0040r_007benvironment_007d-379"></a><a name="index-verbatim-text-380"></a><a name="index-simulating-typed-text-381"></a><a name="index-typed-text_002c-simulating-382"></a><a name="index-code_002c-typesetting-383"></a><a name="index-computer-programs_002c-typesetting-384"></a> +Synopsis: + +<pre class="example"> \begin{verbatim} + <var>literal-text</var> + \end{verbatim} +</pre> + <p>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><span class="samp">\</span></samp>’. It turns LaTeX +into a typewriter with carriage returns and blanks having the same +effect that they would on a typewriter. + + <p>The <code>verbatim</code> uses a monospaced typewriter-like font (<code>\tt</code>). + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cverb">\verb</a>: The macro form of the <code>verbatim</code> environment. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cverb"></a> +<a name="g_t_005cverb"></a> +Up: <a rel="up" accesskey="u" href="#verbatim">verbatim</a> + +</div> + +<h4 class="subsection">8.27.1 <code>\verb</code></h4> + +<p><a name="index-g_t_005cverb-385"></a><a name="index-verbatim-text_002c-inline-386"></a> +Synopsis: + +<pre class="example"> \verb<var>char</var><var>literal-text</var><var>char</var> + \verb*<var>char</var><var>literal-text</var><var>char</var> +</pre> + <p>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>. + + <p><a name="index-visible-space-387"></a>The <code>*</code>-form differs only in that spaces are printed with a +“visible space” character. + +<div class="node"> +<p><hr> +<a name="verse"></a> +Previous: <a rel="previous" accesskey="p" href="#verbatim">verbatim</a>, +Up: <a rel="up" accesskey="u" href="#Environments">Environments</a> + +</div> + +<h3 class="section">8.28 <code>verse</code></h3> + +<p><a name="index-verse-_0040r_007benvironment_007d-388"></a><a name="index-poetry_002c-an-environment-for-389"></a> +Synopsis: + +<pre class="example"> \begin{verse} + <var>line1</var> \\ + <var>line2</var> \\ + ... + \end{verse} +</pre> + <p>The <code>verse</code> environment is designed for poetry, though you may find +other uses for it. + + <p><a name="index-g_t_005c_005c-_0040r_007bfor-_0040code_007bverse_007d_007d-390"></a>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. + +<div class="node"> +<p><hr> +<a name="Footnotes"></a> +Next: <a rel="next" accesskey="n" href="#Definitions">Definitions</a>, +Previous: <a rel="previous" accesskey="p" href="#Page-breaking">Page breaking</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">9 Footnotes</h2> + +<p><a name="index-footnotes_002c-creating-391"></a> +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. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cfootnote">\footnote</a>: Insert a footnote. +<li><a accesskey="2" href="#g_t_005cfootnotemark">\footnotemark</a>: Insert footnote mark only. +<li><a accesskey="3" href="#g_t_005cfootnotetext">\footnotetext</a>: Insert footnote text only. +<li><a accesskey="4" href="#Footnote-parameters">Footnote parameters</a>: Parameters for footnote formatting. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cfootnote"></a> +<a name="g_t_005cfootnote"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cfootnotemark">\footnotemark</a>, +Up: <a rel="up" accesskey="u" href="#Footnotes">Footnotes</a> + +</div> + +<h3 class="section">9.1 <code>\footnote</code></h3> + +<p><a name="index-g_t_005cfootnote-392"></a> +Synopsis: + +<pre class="example"> \footnote[<var>number</var>]{<var>text</var>} +</pre> + <p>The <code>\footnote</code> command places the numbered footnote <var>text</var> +at the bottom of the current page. The optional argument <var>number</var> +changes the default footnote number. + + <p>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 --> + +<div class="node"> +<p><hr> +<a name="%5cfootnotemark"></a> +<a name="g_t_005cfootnotemark"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cfootnotetext">\footnotetext</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cfootnote">\footnote</a>, +Up: <a rel="up" accesskey="u" href="#Footnotes">Footnotes</a> + +</div> + +<h3 class="section">9.2 <code>\footnotemark</code></h3> + +<p><a name="index-g_t_005cfootnotemark-393"></a> +With no optional argument, the <code>\footnotemark</code> command puts the +current footnote number in the text. This command can be used in +inner paragraph mode. You give the text of the footnote separately, +with the <code>\footnotetext</code> command. + + <p>This command can be used to produce several consecutive footnote +markers referring to the same footnote with + +<pre class="example"> \footnotemark[\value{footnote}] +</pre> + <p>after the first <code>\footnote</code> command. + +<div class="node"> +<p><hr> +<a name="%5cfootnotetext"></a> +<a name="g_t_005cfootnotetext"></a> +Next: <a rel="next" accesskey="n" href="#Footnote-parameters">Footnote parameters</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cfootnotemark">\footnotemark</a>, +Up: <a rel="up" accesskey="u" href="#Footnotes">Footnotes</a> + +</div> + +<h3 class="section">9.3 <code>\footnotetext</code></h3> + +<p><a name="index-g_t_005cfootnotetext-394"></a> +Synopsis: + +<pre class="example"> \footnotetext[<var>number</var>]{<var>text</var>} +</pre> + <p>The <code>\footnotetext</code> command places <var>text</var> at the bottom of +the page as a footnote. This command can come anywhere after the +<code>\footnotemark</code> command. The <code>\footnotetext</code> command must +appear in outer paragraph mode. + + <p>The optional argument <var>number</var> changes the default footnote number. + +<div class="node"> +<p><hr> +<a name="Footnote-parameters"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cfootnotetext">\footnotetext</a>, +Up: <a rel="up" accesskey="u" href="#Footnotes">Footnotes</a> + +</div> + +<h3 class="section">9.4 Footnote parameters</h3> + +<p><a name="index-footnote-parameters-395"></a> + <dl> +<dt><code>\footnoterule</code><a name="index-g_t_005cfootnoterule-396"></a><dd>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). + + <br><dt><code>\footnotesep</code><a name="index-g_t_005cfootnotesep-397"></a><dd>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 <a href="#Font-sizes">Font sizes</a>), therefore there is no extra space between +footnotes. This is ‘<samp><span class="samp">6.65pt</span></samp>’ for ‘<samp><span class="samp">10pt</span></samp>’, ‘<samp><span class="samp">7.7pt</span></samp>’ for +‘<samp><span class="samp">11pt</span></samp>’, and ‘<samp><span class="samp">8.4pt</span></samp>’ for ‘<samp><span class="samp">12pt</span></samp>’. + + </dl> + +<div class="node"> +<p><hr> +<a name="Definitions"></a> +Next: <a rel="next" accesskey="n" href="#Counters">Counters</a>, +Previous: <a rel="previous" accesskey="p" href="#Footnotes">Footnotes</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">10 Definitions</h2> + +<p><a name="index-definitions-398"></a> +LaTeX has support for making new commands of many different kinds. + +<!-- xx everything in this chapter needs examples. --> +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>: (Re)define a new command. +<li><a accesskey="2" href="#g_t_005cnewcounter">\newcounter</a>: Define a new counter. +<li><a accesskey="3" href="#g_t_005cnewlength">\newlength</a>: Define a new length. +<li><a accesskey="4" href="#g_t_005cnewsavebox">\newsavebox</a>: Define a new box. +<li><a accesskey="5" href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a>: Define a new environment. +<li><a accesskey="6" href="#g_t_005cnewtheorem">\newtheorem</a>: Define a new theorem-like environment. +<li><a accesskey="7" href="#g_t_005cnewfont">\newfont</a>: Define a new font name. +<li><a accesskey="8" href="#g_t_005cprotect">\protect</a>: Using tricky commands. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cnewcommand-%26-%5crenewcommand"></a> +<a name="g_t_005cnewcommand-_0026-_005crenewcommand"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewcounter">\newcounter</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.1 <code>\newcommand</code> & <code>\renewcommand</code></h3> + +<p><a name="index-g_t_005cnewcommand-399"></a><a name="index-commands_002c-defining-new-ones-400"></a><a name="index-defining-a-new-command-401"></a><a name="index-new-commands_002c-defining-402"></a> +<code>\newcommand</code> and <code>\renewcommand</code> define and redefine a +command, respectively. Synopses: + +<pre class="example"> \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>} +</pre> + <dl> +<dt><var>cmd</var><dd>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. + + <br><dt><var>nargs</var><dd>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. + + <br><dt><var>default</var><dd>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><span class="samp">def</span></samp>’. + + <br><dt><var>defn</var><dd>The text to be substituted for every occurrence of <code>cmd</code>; a +construct of the form <code>#</code><var>n</var> in <var>defn</var> is replaced by the +text of the <var>n</var>th argument. + + </dl> + +<div class="node"> +<p><hr> +<a name="%5cnewcounter"></a> +<a name="g_t_005cnewcounter"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewlength">\newlength</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.2 <code>\newcounter</code></h3> + +<p><a name="index-g_t_005cnewcounter-403"></a><a name="index-counters_002c-defining-new-404"></a> +Synopsis: + +<pre class="example"> \newcounter{<var>cnt</var>}[<var>countername</var>] +</pre> + <p>The <code>\newcounter</code> command defines a new counter named <var>cnt</var>. +The new counter is initialized to zero. + + <p>Given the optional argument <code>[</code><var>countername</var><code>]</code>, <var>cnt</var> +will be reset whenever <var>countername</var> is incremented. + + <p>See <a href="#Counters">Counters</a>, for more information about counters. + +<div class="node"> +<p><hr> +<a name="%5cnewlength"></a> +<a name="g_t_005cnewlength"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewsavebox">\newsavebox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewcounter">\newcounter</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.3 <code>\newlength</code></h3> + +<p><a name="index-g_t_005cnewlength-405"></a><a name="index-lengths_002c-defining-new-406"></a> +Synopsis: + +<pre class="example"> \newlength{\<var>arg</var>} +</pre> + <p>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. + + <p>See <a href="#Lengths">Lengths</a>, for how to set the new length to a nonzero value, and +for more information about lengths in general. + +<div class="node"> +<p><hr> +<a name="%5cnewsavebox"></a> +<a name="g_t_005cnewsavebox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewlength">\newlength</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.4 <code>\newsavebox</code></h3> + +<p><a name="index-g_t_005cnewsavebox-407"></a> +Synopsis: + +<pre class="example"> \newsavebox{<var>cmd</var>} +</pre> + <p>Defines <code>\</code><var>cmd</var>, which must be a command name not already +defined, to refer to a new bin for storing boxes. + +<div class="node"> +<p><hr> +<a name="%5cnewenvironment-%26-%5crenewenvironment"></a> +<a name="g_t_005cnewenvironment-_0026-_005crenewenvironment"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewtheorem">\newtheorem</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewsavebox">\newsavebox</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.5 <code>\newenvironment</code> & <code>\renewenvironment</code></h3> + +<p><a name="index-g_t_005cnewenvironment-408"></a><a name="index-g_t_005crenewenvironment-409"></a><a name="index-environments_002c-defining-410"></a><a name="index-defining-new-environments-411"></a><a name="index-redefining-environments-412"></a> +Synopses: + +<pre class="example"> \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>} +</pre> + <p>These commands define or redefine an environment <var>env</var>, that is, +<code>\begin{</code><var>env</var><code>} ... \end{</code><var>env</var><code>}</code>. + + <dl> +<dt><var>env</var><dd>The name of the environment. For <code>\newenvironment</code>, <var>env</var> +must not be an existing environment, and the command <code>\</code><var>env</var> +must be undefined. For <code>\renewenvironment</code>, <var>env</var> must be +the name of an existing environment. + + <br><dt><var>nargs</var><dd>An integer from 1 to 9 denoting the number of arguments of +the newly-defined environment. The default is no arguments. + + <br><dt><var>default</var><dd>If this is specified, the first argument is optional, and <var>default</var> +gives the default value for that argument. + + <br><dt><var>begdef</var><dd>The text expanded at every occurrence of <code>\begin{</code><var>env</var><code>}</code>; a +construct of the form <code>#</code><var>n</var> in <var>begdef</var> is replaced by +the text of the <var>n</var>th argument. + + <br><dt><var>enddef</var><dd>The text expanded at every occurrence of <code>\end{</code><var>env</var><code>}</code>. It +may not contain any argument parameters. + + </dl> + +<div class="node"> +<p><hr> +<a name="%5cnewtheorem"></a> +<a name="g_t_005cnewtheorem"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewfont">\newfont</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.6 <code>\newtheorem</code></h3> + +<p><a name="index-g_t_005cnewtheorem-413"></a><a name="index-theorems_002c-defining-414"></a><a name="index-defining-new-theorems-415"></a> +<pre class="example"> \newtheorem{<var>newenv</var>}{<var>label</var>}[<var>within</var>] + \newtheorem{<var>newenv</var>}[<var>numbered_like</var>]{<var>label</var>} +</pre> + <p>This command defines a theorem-like environment. Arguments: + + <dl> +<dt><var>newenv</var><dd>The name of the environment to be defined; must not be the name of an +existing environment or otherwise defined. + + <br><dt><var>label</var><dd>The text printed at the beginning of the environment, before the +number. For example, ‘<samp><span class="samp">Theorem</span></samp>’. + + <br><dt><var>numbered_like</var><dd>(Optional.) The name of an already defined theorem-like environment; +the new environment will be numbered just like <var>numbered_like</var>. + + <br><dt><var>within</var><dd>(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. + + </dl> + + <p>At most one of <var>numbered_like</var> and <var>within</var> can be specified, +not both. + +<div class="node"> +<p><hr> +<a name="%5cnewfont"></a> +<a name="g_t_005cnewfont"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cprotect">\protect</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewtheorem">\newtheorem</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.7 <code>\newfont</code></h3> + +<p><a name="index-g_t_005cnewfont-416"></a><a name="index-fonts_002c-new-commands-for-417"></a><a name="index-defining-new-fonts-418"></a> +Synopsis: + +<pre class="example"> \newfont{<var>cmd</var>}{<var>fontname</var>} +</pre> + <p>Defines a control sequence <code>\</code><var>cmd</var>, which must not already +be defined, to make <var>fontname</var> be the current font. The file +looked for on the system is named <samp><var>fontname</var><span class="file">.tfm</span></samp>. + + <p>This is a low-level command for setting up to use an individual font. +More commonly, fonts are defined in families through <samp><span class="file">.fd</span></samp> files. + +<div class="node"> +<p><hr> +<a name="%5cprotect"></a> +<a name="g_t_005cprotect"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewfont">\newfont</a>, +Up: <a rel="up" accesskey="u" href="#Definitions">Definitions</a> + +</div> + +<h3 class="section">10.8 <code>\protect</code></h3> + +<p><a name="index-g_t_005cprotect-419"></a> +<a name="index-fragile-commands-420"></a><a name="index-moving-arguments-421"></a>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>. + + <p>Some examples of moving arguments are <code>\caption</code> +(see <a href="#figure">figure</a>), <code>\thanks</code> (see <a href="#g_t_005cmaketitle">\maketitle</a>), and +expressions in <code>tabular</code> and <code>array</code> environments +(see <a href="#tabular">tabular</a>). + + <p><a name="index-robust-commands-422"></a>Commands which are not fragile are called <dfn>robust</dfn>. They must not +be preceded by <code>\protect</code>. + + <p>See also: + +<pre class="smallexample"><br><a href="http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html">http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</a><br> +<br><a href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</a><br> +</pre> + <!-- xx really need examples. --> +<div class="node"> +<p><hr> +<a name="Counters"></a> +Next: <a rel="next" accesskey="n" href="#Lengths">Lengths</a>, +Previous: <a rel="previous" accesskey="p" href="#Definitions">Definitions</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">11 Counters</h2> + +<p><a name="index-counters_002c-a-list-of-423"></a><a name="index-variables_002c-a-list-of-424"></a> +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. + +<pre class="example"> part paragraph figure enumi + chapter subparagraph table enumii + section page footnote enumiii + subsection equation mpfootnote enumiv + subsubsection +</pre> + <ul class="menu"> +<li><a accesskey="1" href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a>: Print value of a counter. +<li><a accesskey="2" href="#g_t_005cusecounter">\usecounter</a>: Use a specified counter in a list environment. +<li><a accesskey="3" href="#g_t_005cvalue">\value</a>: Use the value of a counter in an expression. +<li><a accesskey="4" href="#g_t_005csetcounter">\setcounter</a>: Set the value of a counter. +<li><a accesskey="5" href="#g_t_005caddtocounter">\addtocounter</a>: Add a quantity to a counter. +<li><a accesskey="6" href="#g_t_005crefstepcounter">\refstepcounter</a>: Add to counter, resetting subsidiary counters. +<li><a accesskey="7" href="#g_t_005cstepcounter">\stepcounter</a>: Add to counter, resetting subsidiary counters. +<li><a accesskey="8" href="#g_t_005cday-_005cmonth-_005cyear">\day \month \year</a>: Numeric date values. +</ul> + +<div class="node"> +<p><hr> +<a name="%5calph-%5cAlph-%5carabic-%5croman-%5cRoman-%5cfnsymbol"></a> +<a name="g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cusecounter">\usecounter</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.1 <code>\alph \Alph \arabic \roman \Roman \fnsymbol</code>: Printing counters</h3> + +<p>All of these commands take a single counter as an argument, for +instance, <code>\alph{enumi}</code>. + + <dl> +<dt><code>\alph</code><a name="index-g_t_005calph-425"></a><dd>prints <var>counter</var> using lowercase letters: `a', `b', <small class="enddots">...</small> + + <br><dt><code>\Alph</code><a name="index-g_t_005cAlph-426"></a><dd>uses uppercase letters: `A', `B', <small class="enddots">...</small> + + <br><dt><code>\arabic</code><a name="index-g_t_005carabic-427"></a><dd>uses Arabic numbers: `1', `2', <small class="enddots">...</small> + + <br><dt><code>\roman</code><a name="index-g_t_005croman-428"></a><dd>uses lowercase roman numerals: `i', `ii', <small class="enddots">...</small> + + <br><dt><code>\roman</code><a name="index-g_t_005croman-429"></a><dd>uses uppercase roman numerals: `I', `II', <small class="enddots">...</small> + + <br><dt><code>\fnsymbol</code><a name="index-g_t_005cfnsymbol-430"></a><dd>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. + + <p>The symbols mostly aren't supported in Info, but here are the names: + <pre class="display"> asterix(*) dagger ddagger section-sign paragraph-sign parallel + double-asterix(**) double-dagger double-ddagger +</pre> + </dl> + +<div class="node"> +<p><hr> +<a name="%5cusecounter"></a> +<a name="g_t_005cusecounter"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cvalue">\value</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.2 <code>\usecounter{</code><var>counter</var><code>}</code></h3> + +<p><a name="index-g_t_005cusecounter-431"></a><a name="index-list-items_002c-specifying-counter-432"></a><a name="index-numbered-items_002c-specifying-counter-433"></a> +Synopsis: + +<pre class="example"> \usecounter{<var>counter</var>} +</pre> + <p>The <code>\usecounter</code> command is used in the second argument of the +<code>list</code> environment to specify <var>counter</var> to be used to number +the list items. + +<div class="node"> +<p><hr> +<a name="%5cvalue"></a> +<a name="g_t_005cvalue"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csetcounter">\setcounter</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cusecounter">\usecounter</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.3 <code>\value{</code><var>counter</var><code>}</code></h3> + +<p><a name="index-g_t_005cvalue-434"></a><a name="index-counters_002c-getting-value-of-435"></a> +Synopsis: + +<pre class="example"> \value{<var>counter</var>} +</pre> + <p>The <code>\value</code> command produces the value of <var>counter</var>. It can +be used anywhere LaTeX expects a number, for example: + +<pre class="example"> \setcounter{myctr}{3} + \addtocounter{myctr}{1} + \hspace{\value{myctr}\parindent} +</pre> + <div class="node"> +<p><hr> +<a name="%5csetcounter"></a> +<a name="g_t_005csetcounter"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005caddtocounter">\addtocounter</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cvalue">\value</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.4 <code>\setcounter{</code><var>counter</var><code>}{</code><var>value</var><code>}</code></h3> + +<p><a name="index-g_t_005csetcounter-436"></a><a name="index-counters_002c-setting-437"></a><a name="index-setting-counters-438"></a> +Synopsis: + +<pre class="example"> \setcounter{<var>\counter</var>}{<var>value</var>} +</pre> + <p>The <code>\setcounter</code> command sets the value of <var>\counter</var> to the +<var>value</var> argument. + +<div class="node"> +<p><hr> +<a name="%5caddtocounter"></a> +<a name="g_t_005caddtocounter"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005crefstepcounter">\refstepcounter</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005csetcounter">\setcounter</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.5 <code>\addtocounter{</code><var>counter</var><code>}{</code><var>value</var><code>}</code></h3> + +<p><a name="index-g_t_005caddtocounter-439"></a> +The <code>\addtocounter</code> command increments <var>counter</var> by the +amount specified by the <var>value</var> argument, which may be negative. + +<div class="node"> +<p><hr> +<a name="%5crefstepcounter"></a> +<a name="g_t_005crefstepcounter"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cstepcounter">\stepcounter</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005caddtocounter">\addtocounter</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.6 <code>\refstepcounter{</code><var>counter</var><code>}</code></h3> + +<p><a name="index-g_t_005crefstepcounter-440"></a> +The <code>\refstepcounter</code> command works in the same way as +<code>\stepcounter</code> See <a href="#g_t_005cstepcounter">\stepcounter</a>, except it also defines the +current <code>\ref</code> value to be the result of <code>\thecounter</code>. + +<div class="node"> +<p><hr> +<a name="%5cstepcounter"></a> +<a name="g_t_005cstepcounter"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cday-_005cmonth-_005cyear">\day \month \year</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005crefstepcounter">\refstepcounter</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.7 <code>\stepcounter{</code><var>counter</var><code>}</code></h3> + +<p><a name="index-g_t_005cstepcounter-441"></a> +The <code>\stepcounter</code> command adds one to <var>counter</var> and +resets all subsidiary counters. + +<div class="node"> +<p><hr> +<a name="%5cday-%5cmonth-%5cyear"></a> +<a name="g_t_005cday-_005cmonth-_005cyear"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cstepcounter">\stepcounter</a>, +Up: <a rel="up" accesskey="u" href="#Counters">Counters</a> + +</div> + +<h3 class="section">11.8 <code>\day \month \year</code>: Predefined counters</h3> + +<p><a name="index-g_t_005cday-442"></a><a name="index-g_t_005cmonth-443"></a><a name="index-g_t_005cyear-444"></a> +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. + + <p>The related command <code>\today</code> produces a string representing the +current day (see <a href="#g_t_005ctoday">\today</a>). + +<div class="node"> +<p><hr> +<a name="Lengths"></a> +Next: <a rel="next" accesskey="n" href="#Making-paragraphs">Making paragraphs</a>, +Previous: <a rel="previous" accesskey="p" href="#Counters">Counters</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">12 Lengths</h2> + +<p><a name="index-lengths_002c-defining-and-using-445"></a> +A <code>length</code> is a measure of distance. Many LaTeX commands take a +length as an argument. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005csetlength">\setlength</a>: Set the value of a length. +<li><a accesskey="2" href="#g_t_005caddtolength">\addtolength</a>: Add a quantity to a length. +<li><a accesskey="3" href="#g_t_005csettodepth">\settodepth</a>: Set a length to the depth of something. +<li><a accesskey="4" href="#g_t_005csettoheight">\settoheight</a>: Set a length to the height of something. +<li><a accesskey="5" href="#g_t_005csettowidth">\settowidth</a>: Set a length to the width of something. +<li><a accesskey="6" href="#Predefined-lengths">Predefined lengths</a>: Lengths that are, like, predefined. +</ul> + +<div class="node"> +<p><hr> +<a name="%5csetlength"></a> +<a name="g_t_005csetlength"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005caddtolength">\addtolength</a>, +Up: <a rel="up" accesskey="u" href="#Lengths">Lengths</a> + +</div> + +<h3 class="section">12.1 <code>\setlength{\</code><var>len</var><code>}{</code><var>value</var><code>}</code></h3> + +<p><a name="index-g_t_005csetlength-446"></a><a name="index-lengths_002c-setting-447"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5caddtolength"></a> +<a name="g_t_005caddtolength"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csettodepth">\settodepth</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005csetlength">\setlength</a>, +Up: <a rel="up" accesskey="u" href="#Lengths">Lengths</a> + +</div> + +<h3 class="section">12.2 \addtolength{<var>\len</var>}{<var>amount</var>}</h3> + +<p><a name="index-g_t_005caddtolength-448"></a><a name="index-lengths_002c-adding-to-449"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5csettodepth"></a> +<a name="g_t_005csettodepth"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csettoheight">\settoheight</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005caddtolength">\addtolength</a>, +Up: <a rel="up" accesskey="u" href="#Lengths">Lengths</a> + +</div> + +<h3 class="section">12.3 <code>\settodepth</code></h3> + +<p><a name="index-g_t_005csettodepth-450"></a> +<code>\settodepth{\gnat}{text}</code> + + <p>The <code>\settodepth</code> command sets the value of a <code>length</code> command +equal to the depth of the <code>text</code> argument. + +<div class="node"> +<p><hr> +<a name="%5csettoheight"></a> +<a name="g_t_005csettoheight"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csettowidth">\settowidth</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005csettodepth">\settodepth</a>, +Up: <a rel="up" accesskey="u" href="#Lengths">Lengths</a> + +</div> + +<h3 class="section">12.4 <code>\settoheight</code></h3> + +<p><a name="index-g_t_005csettoheight-451"></a> +<code>\settoheight{\gnat}{text}</code> + + <p>The <code>\settoheight</code> command sets the value of a <code>length</code> command +equal to the height of the <code>text</code> argument. + +<div class="node"> +<p><hr> +<a name="%5csettowidth"></a> +<a name="g_t_005csettowidth"></a> +Next: <a rel="next" accesskey="n" href="#Predefined-lengths">Predefined lengths</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005csettoheight">\settoheight</a>, +Up: <a rel="up" accesskey="u" href="#Lengths">Lengths</a> + +</div> + +<h3 class="section">12.5 <code>\settowidth{\</code><var>len</var><code>}{</code><var>text</var><code>}</code></h3> + +<p><a name="index-g_t_005csettowidth-452"></a> +The <code>\settowidth</code> command sets the value of the command <var>\len</var> +to the width of the <var>text</var> argument. + +<div class="node"> +<p><hr> +<a name="Predefined-lengths"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005csettowidth">\settowidth</a>, +Up: <a rel="up" accesskey="u" href="#Lengths">Lengths</a> + +</div> + +<h3 class="section">12.6 Predefined lengths</h3> + +<p><a name="index-lengths_002c-predefined-453"></a><a name="index-predefined-lengths-454"></a> +<code>\width</code> +<a name="index-g_t_005cwidth-455"></a> +<code>\height</code> +<a name="index-g_t_005cheight-456"></a> +<code>\depth</code> +<a name="index-g_t_005cdepth-457"></a> +<code>\totalheight</code> +<a name="index-g_t_005ctotalheight-458"></a> +These length parameters can be used in the arguments of the box-making +commands (see <a href="#Boxes">Boxes</a>). 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 + + <p><code>\makebox[2\width]{Get a stretcher}</code> + +<div class="node"> +<p><hr> +<a name="Line-breaking"></a> +Next: <a rel="next" accesskey="n" href="#Page-breaking">Page breaking</a>, +Previous: <a rel="previous" accesskey="p" href="#Environments">Environments</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">13 Line breaking</h2> + +<p><a name="index-line-breaking-459"></a><a name="index-breaking-lines-460"></a> +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). + + <p>LaTeX usually does the line (and page) breaking for you, but in +some environments, you do the line breaking yourself with the +<code>\\</code> command, and you can always manually force breaks. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005c_005c">\\</a>: Start a new line. +<li><a accesskey="2" href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a>: Make each input line start a new output line. +<li><a accesskey="3" href="#g_t_005cnewline">\newline</a>: Break the line +<li><a accesskey="4" href="#g_t_005c_002d-_0028hyphenation_0029">\- (hyphenation)</a>: Insert explicit hyphenation. +<li><a accesskey="5" href="#g_t_005cfussy">\fussy</a>: Be fussy about line breaking. +<li><a accesskey="6" href="#g_t_005chyphenation">\hyphenation</a>: Tell LaTeX how to hyphenate a word. +<li><a accesskey="7" href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a>: Forcing & avoiding line breaks. +<li><a accesskey="8" href="#g_t_005csloppy">\sloppy</a>: Be sloppy about line breaking. +</ul> + +<div class="node"> +<p><hr> +<a name="%5c%5c"></a> +<a name="g_t_005c_005c"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.1 <code>\\</code>[*][<var>morespace</var>]</h3> + +<p><a name="index-g_t_005c_005c-_0040r_007bforce-line-break_007d-461"></a><a name="index-new-line_002c-starting-462"></a><a name="index-line-break_002c-forcing-463"></a> +The <code>\\</code> command tells LaTeX to start a new line. It has an +optional argument, <var>morespace</var>, that specifies how much extra +vertical space is to be inserted before the next line. This can be a +negative amount. + + <p>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. + +<div class="node"> +<p><hr> +<a name="%5cobeycr-%26-%5crestorecr"></a> +<a name="g_t_005cobeycr-_0026-_005crestorecr"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewline">\newline</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005c_005c">\\</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.2 <code>\obeycr</code> & <code>\restorecr</code></h3> + +<p><a name="index-g_t_005cobeycr-464"></a><a name="index-g_t_005crestorecr-465"></a><a name="index-new-line_002c-output-as-input-466"></a> +The <code>\obeycr</code> command makes a return in the input file +(‘<samp><span class="samp">^^M</span></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. + + <p><code>\restorecr</code> restores normal line-breaking behavior. + +<div class="node"> +<p><hr> +<a name="%5cnewline"></a> +<a name="g_t_005cnewline"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005c_002d-_0028hyphenation_0029">\- (hyphenation)</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.3 <code>\newline</code></h3> + +<p><a name="index-g_t_005cnewline-467"></a><a name="index-new-line_002c-starting-_0028paragraph-mode_0029-468"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5c--(hyphenation)"></a> +<a name="g_t_005c_002d-_0028hyphenation_0029"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cfussy">\fussy</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewline">\newline</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.4 <code>\-</code> (discretionary hyphen)</h3> + +<p><a name="index-g_t_005c_002d-_0040r_007b_0028hyphenation_0029_007d-469"></a><a name="index-hyphenation_002c-forcing-470"></a> +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. + + <p>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. + +<div class="node"> +<p><hr> +<a name="%5cfussy"></a> +<a name="g_t_005cfussy"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005chyphenation">\hyphenation</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005c_002d-_0028hyphenation_0029">\- (hyphenation)</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.5 <code>\fussy</code></h3> + +<p><a name="index-g_t_005cfussy-471"></a> +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. + + <p>This command cancels the effect of a previous <code>\sloppy</code> command +(see <a href="#g_t_005csloppy">\sloppy</a>. + +<div class="node"> +<p><hr> +<a name="%5csloppy"></a> +<a name="g_t_005csloppy"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.6 <code>\sloppy</code></h3> + +<p>The declaration <code>\sloppy</code> makes TeX less fussy about line +breaking. This will avoid overfull boxes, at the cost of loose +interword spacing. + + <p>Lasts until a <code>\fussy</code> command is issued (see <a href="#g_t_005cfussy">\fussy</a>). + +<div class="node"> +<p><hr> +<a name="%5chyphenation"></a> +<a name="g_t_005chyphenation"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cfussy">\fussy</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.7 <code>\hyphenation</code></h3> + +<p><a name="index-g_t_005chyphenation-472"></a><a name="index-hyphenation_002c-defining-473"></a> +Synopsis: + +<pre class="example"> \hyphenation{<var>word-one</var> <var>word-two</var>} +</pre> + <p>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): + +<pre class="example"> \hyphenation{ap-pen-dix col-umns data-base data-bases} +</pre> + <div class="node"> +<p><hr> +<a name="%5clinebreak-%26-%5cnolinebreak"></a> +<a name="g_t_005clinebreak-_0026-_005cnolinebreak"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csloppy">\sloppy</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005chyphenation">\hyphenation</a>, +Up: <a rel="up" accesskey="u" href="#Line-breaking">Line breaking</a> + +</div> + +<h3 class="section">13.8 <code>\linebreak</code> & <code>\nolinebreak</code></h3> + +<p><a name="index-g_t_005clinebreak-474"></a><a name="index-g_t_005cnolinebreak-475"></a><a name="index-line-breaks_002c-forcing-476"></a><a name="index-line-breaks_002c-preventing-477"></a> +Synopses: + +<pre class="example"> \linebreak[<var>priority</var>] + \nolinebreak[<var>priority</var>] +</pre> + <p>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. + + <p>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. + +<div class="node"> +<p><hr> +<a name="Page-breaking"></a> +Next: <a rel="next" accesskey="n" href="#Footnotes">Footnotes</a>, +Previous: <a rel="previous" accesskey="p" href="#Line-breaking">Line breaking</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">14 Page breaking</h2> + +<p><a name="index-page-breaking-478"></a><a name="index-breaking-pages-479"></a> +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. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005ccleardoublepage">\cleardoublepage</a>: Start a new right-hand page. +<li><a accesskey="2" href="#g_t_005cclearpage">\clearpage</a>: Start a new page. +<li><a accesskey="3" href="#g_t_005cnewpage">\newpage</a>: Start a new page. +<li><a accesskey="4" href="#g_t_005cenlargethispage">\enlargethispage</a>: Enlarge the current page a bit. +<li><a accesskey="5" href="#g_t_005cpagebreak-_0026-_005cnopagebreak">\pagebreak & \nopagebreak</a>: Forcing & avoiding page breaks. +</ul> + +<div class="node"> +<p><hr> +<a name="%5ccleardoublepage"></a> +<a name="g_t_005ccleardoublepage"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cclearpage">\clearpage</a>, +Up: <a rel="up" accesskey="u" href="#Page-breaking">Page breaking</a> + +</div> + +<h3 class="section">14.1 <code>\cleardoublepage</code></h3> + +<p><a name="index-g_t_005ccleardoublepage-480"></a><a name="index-starting-on-a-right_002dhand-page-481"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5cclearpage"></a> +<a name="g_t_005cclearpage"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnewpage">\newpage</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005ccleardoublepage">\cleardoublepage</a>, +Up: <a rel="up" accesskey="u" href="#Page-breaking">Page breaking</a> + +</div> + +<h3 class="section">14.2 <code>\clearpage</code></h3> + +<p><a name="index-g_t_005cclearpage-482"></a><a name="index-flushing-floats-and-starting-a-page-483"></a><a name="index-starting-a-new-page-and-clearing-floats-484"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5cnewpage"></a> +<a name="g_t_005cnewpage"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cenlargethispage">\enlargethispage</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cclearpage">\clearpage</a>, +Up: <a rel="up" accesskey="u" href="#Page-breaking">Page breaking</a> + +</div> + +<h3 class="section">14.3 <code>\newpage</code></h3> + +<p><a name="index-g_t_005cnewpage-485"></a><a name="index-new-page_002c-starting-486"></a><a name="index-starting-a-new-page-487"></a> +The <code>\newpage</code> command ends the current page, but does not clear +floats (see <code>\clearpage</code> above). + +<div class="node"> +<p><hr> +<a name="%5cenlargethispage"></a> +<a name="g_t_005cenlargethispage"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cpagebreak-_0026-_005cnopagebreak">\pagebreak & \nopagebreak</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnewpage">\newpage</a>, +Up: <a rel="up" accesskey="u" href="#Page-breaking">Page breaking</a> + +</div> + +<h3 class="section">14.4 <code>\enlargethispage</code></h3> + +<p><a name="index-g_t_005cenlargethispage-488"></a><a name="index-enlarge-current-page-489"></a> +<code>\enlargethispage{size}</code> + + <p><code>\enlargethispage*{size}</code> + + <p>Enlarge the <code>\textheight</code> for the current page by the specified +amount; e.g. <code>\enlargethispage{\baselineskip}</code> will allow one +additional line. + + <p>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>. + +<div class="node"> +<p><hr> +<a name="%5cpagebreak-%26-%5cnopagebreak"></a> +<a name="g_t_005cpagebreak-_0026-_005cnopagebreak"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cenlargethispage">\enlargethispage</a>, +Up: <a rel="up" accesskey="u" href="#Page-breaking">Page breaking</a> + +</div> + +<h3 class="section">14.5 <code>\pagebreak</code> & <code>\nopagebreak</code></h3> + +<p><a name="index-g_t_005cpagebreak-490"></a><a name="index-g_t_005cnopagebreak-491"></a><a name="index-page-break_002c-forcing-492"></a><a name="index-page-break_002c-preventing-493"></a> +Synopses: + +<pre class="example"> \pagebreak[<var>priority</var>] + \nopagebreak[<var>priority</var>] +</pre> + <p>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. + + <p>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. + +<div class="node"> +<p><hr> +<a name="Making-paragraphs"></a> +Next: <a rel="next" accesskey="n" href="#Math-formulas">Math formulas</a>, +Previous: <a rel="previous" accesskey="p" href="#Lengths">Lengths</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">15 Making paragraphs</h2> + +<p><a name="index-making-paragraphs-494"></a><a name="index-paragraphs-495"></a> +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. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cindent">\indent</a>: Indent this paragraph. +<li><a accesskey="2" href="#g_t_005cnoindent">\noindent</a>: Do not indent this paragraph. +<li><a accesskey="3" href="#g_t_005cparskip">\parskip</a>: Space added before paragraphs. +<li><a accesskey="4" href="#Marginal-notes">Marginal notes</a>: Putting remarks in the margin. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cindent"></a> +<a name="g_t_005cindent"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cnoindent">\noindent</a>, +Up: <a rel="up" accesskey="u" href="#Making-paragraphs">Making paragraphs</a> + +</div> + +<h3 class="section">15.1 <code>\indent</code></h3> + +<p><a name="index-g_t_005cindent-496"></a><a name="index-g_t_005cparindent-497"></a><a name="index-indent_002c-forcing-498"></a> +<code>\indent</code> produces a horizontal space whose width equals the +width of the <code>\parindent</code> length, the normal paragraph +indentation. It is used to add paragraph indentation where it would +otherwise be suppressed. + + <p>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>. + +<div class="node"> +<p><hr> +<a name="%5cnoindent"></a> +<a name="g_t_005cnoindent"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cparskip">\parskip</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cindent">\indent</a>, +Up: <a rel="up" accesskey="u" href="#Making-paragraphs">Making paragraphs</a> + +</div> + +<h3 class="section">15.2 <code>\noindent</code></h3> + +<p><a name="index-g_t_005cnoindent-499"></a><a name="index-indent_002c-suppressing-500"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5cparskip"></a> +<a name="g_t_005cparskip"></a> +Next: <a rel="next" accesskey="n" href="#Marginal-notes">Marginal notes</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cnoindent">\noindent</a>, +Up: <a rel="up" accesskey="u" href="#Making-paragraphs">Making paragraphs</a> + +</div> + +<h3 class="section">15.3 <code>\parskip</code></h3> + +<p><a name="index-g_t_005cparskip-501"></a><a name="index-vertical-space-before-paragraphs-502"></a> +<code>\parskip</code> is a rubber length defining extra vertical space added +before each paragraph. The default is <code>0pt plus1pt</code>. + +<div class="node"> +<p><hr> +<a name="Marginal-notes"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cparskip">\parskip</a>, +Up: <a rel="up" accesskey="u" href="#Making-paragraphs">Making paragraphs</a> + +</div> + +<h3 class="section">15.4 Marginal notes</h3> + +<p><a name="index-marginal-notes-503"></a><a name="index-notes-in-the-margin-504"></a><a name="index-remarks-in-the-margin-505"></a><a name="index-g_t_005cmarginpar-506"></a> +Synopsis: + +<pre class="example"> \marginpar[<var>left</var>]{<var>right</var>} +</pre> + <p>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. + + <p>When you only specify the mandatory argument <var>right</var>, the text +will be placed + + <ul> +<li>in the right margin for one-sided layout; +<li>in the outside margin for two-sided layout; +<li>in the nearest margin for two-column layout. +</ul> + + <p><a name="index-g_t_005creversemarginpar-507"></a><a name="index-g_t_005cnormalmarginpar-508"></a>The command <code>\reversemarginpar</code> places subsequent marginal notes +in the opposite (inside) margin. <code>\normalmarginpar</code> places them +in the default position. + + <p>When you specify both arguments, <var>left</var> is used for the left +margin, and <var>right</var> is used for the right margin. + + <p>The first word will normally not be hyphenated; you can enable +hyphenation there by beginning the node with <code>\hspace{0pt}</code>. + + <p>These parameters affect the formatting of the note: + + <dl> +<dt><code>\marginparpush</code><a name="index-g_t_005cmarginparpush-509"></a><dd>Minimum vertical space between notes; default ‘<samp><span class="samp">7pt</span></samp>’ for +‘<samp><span class="samp">12pt</span></samp>’ documents, ‘<samp><span class="samp">5pt</span></samp>’ else. + + <br><dt><code>\marginparsep</code><a name="index-g_t_005cmarginparsep-510"></a><dd>Horizontal space between the main text and the note; default +‘<samp><span class="samp">11pt</span></samp>’ for ‘<samp><span class="samp">10pt</span></samp>’ documents, ‘<samp><span class="samp">10pt</span></samp>’ else. + + <br><dt><code>\marginparwidth</code><a name="index-g_t_005cmarginparwidth-511"></a><dd>Width of the note itself; default for a one-sided ‘<samp><span class="samp">10pt</span></samp>’ document +is ‘<samp><span class="samp">90pt</span></samp>’, ‘<samp><span class="samp">83pt</span></samp>’ for ‘<samp><span class="samp">11pt</span></samp>’, and ‘<samp><span class="samp">68pt</span></samp>’ for +‘<samp><span class="samp">12pt</span></samp>’; ‘<samp><span class="samp">17pt</span></samp>’ more in each case for a two-sided document. +In two column mode, the default is ‘<samp><span class="samp">48pt</span></samp>’. + + </dl> + +<div class="node"> +<p><hr> +<a name="Math-formulas"></a> +Next: <a rel="next" accesskey="n" href="#Modes">Modes</a>, +Previous: <a rel="previous" accesskey="p" href="#Making-paragraphs">Making paragraphs</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">16 Math formulas</h2> + +<p><a name="index-math-formulas-512"></a><a name="index-formulas_002c-math-513"></a><a name="index-math-mode_002c-entering-514"></a> +<a name="index-math-_0040r_007benvironment_007d-515"></a><a name="index-displaymath-_0040r_007benvironment_007d-516"></a><a name="index-equation-_0040r_007benvironment_007d-517"></a>There are three environments that put LaTeX in math mode: + + <dl> +<dt><code>math</code><dd>For formulas that appear right in the text. +<br><dt><code>displaymath</code><dd>For formulas that appear on their own line. +<br><dt><code>equation</code><dd>The same as the displaymath environment except that it adds an equation +number in the right margin. +</dl> + + <p><a name="index-g_t_005c_0028-518"></a><a name="index-g_t_005c_0029-519"></a><a name="index-g_t_005c_005b-520"></a><a name="index-g_t_005c_005d-521"></a>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: + +<pre class="example"> \(...\) <span class="roman">instead of</span> \begin{math}...\end{math} + \[...\] <span class="roman">instead of</span> \begin{displaymath}...\end{displaymath} +</pre> + <p><a name="index-g_t_0024-522"></a>In fact, the <code>math</code> environment is so common that it has an even +shorter form: + +<pre class="example"> $ ... $ <span class="roman">instead of</span> \(...\) +</pre> + <p><a name="index-g_t_005cboldmath-523"></a><a name="index-g_t_005cunboldmath-524"></a>The <code>\boldmath</code> command changes math letters and symbols to be in +a bold font. It is used <em>outside</em> of math mode. Conversely, the +<code>\unboldmath</code> command changes math glyphs to be in a normal font; +it too is used <em>outside</em> of math mode. + +<!-- xx own section? Math fonts? --> + <p><a name="index-g_t_005cdisplaystyle-525"></a>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 +<pre class="example"> $\displaystyle \sum_{n=0}^\infty x_n $ +</pre> + <!-- xx see also \cal, \mathcal --> +<ul class="menu"> +<li><a accesskey="1" href="#Subscripts-_0026-Superscripts">Subscripts & Superscripts</a>: Also known as exponent or index. +<li><a accesskey="2" href="#Math-symbols">Math symbols</a>: Various mathematical squiggles. +<li><a accesskey="3" href="#Math-functions">Math functions</a>: Math function names like sin and exp. +<li><a accesskey="4" href="#Math-accents">Math accents</a>: Accents in math. +<li><a accesskey="5" href="#Spacing-in-math-mode">Spacing in math mode</a>: Thick, medium, thin and negative spaces. +<li><a accesskey="6" href="#Math-Miscellany">Math Miscellany</a>: Stuff that doesn't fit anywhere else. +</ul> + +<div class="node"> +<p><hr> +<a name="Subscripts-%26-Superscripts"></a> +<a name="Subscripts-_0026-Superscripts"></a> +Next: <a rel="next" accesskey="n" href="#Math-symbols">Math symbols</a>, +Up: <a rel="up" accesskey="u" href="#Math-formulas">Math formulas</a> + +</div> + +<h3 class="section">16.1 Subscripts & Superscripts</h3> + +<p><a name="index-superscript-526"></a><a name="index-subscript-527"></a><a name="index-exponent-528"></a><a name="index-g_t_005f-529"></a><a name="index-g_t_005e-530"></a> +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. + +<div class="node"> +<p><hr> +<a name="Math-symbols"></a> +Next: <a rel="next" accesskey="n" href="#Math-functions">Math functions</a>, +Previous: <a rel="previous" accesskey="p" href="#Subscripts-_0026-Superscripts">Subscripts & Superscripts</a>, +Up: <a rel="up" accesskey="u" href="#Math-formulas">Math formulas</a> + +</div> + +<h3 class="section">16.2 Math symbols</h3> + +<p><a name="index-math-symbols-531"></a><a name="index-symbols_002c-math-532"></a><a name="index-greek-letters-533"></a> +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 (\pi) in your output. + + <dl> +<dt><code>\|</code><a name="index-g_t_005c_007c-534"></a><dd>\| + + <br><dt><code>\aleph</code><a name="index-g_t_005caleph-535"></a><dd>\aleph + + <br><dt><code>\alpha</code><a name="index-g_t_005calpha-536"></a><dd>\alpha + + <br><dt><code>\amalg</code><a name="index-g_t_005camalg-537"></a><dd>\amalg (binary operation) + + <br><dt><code>\angle</code><a name="index-g_t_005cangle-538"></a><dd>\angle + + <br><dt><code>\approx</code><a name="index-g_t_005capprox-539"></a><dd>\approx (relation) + + <br><dt><code>\ast</code><a name="index-g_t_005cast-540"></a><dd>\ast (binary operation) + + <br><dt><code>\asymp</code><a name="index-g_t_005casymp-541"></a><dd>\asymp (relation) + + <br><dt><code>\backslash</code><a name="index-g_t_005cbackslash-542"></a><dd>\ (delimiter) + + <br><dt><code>\beta</code><a name="index-g_t_005cbeta-543"></a><dd>\beta + + <br><dt><code>\bigcap</code><a name="index-g_t_005cbigcap-544"></a><dd>\bigcap + + <br><dt><code>\bigcirc</code><a name="index-g_t_005cbigcirc-545"></a><dd>\bigcirc (binary operation) + + <br><dt><code>\bigcup</code><a name="index-g_t_005cbigcup-546"></a><dd>\bigcup + + <br><dt><code>\bigodot</code><a name="index-g_t_005cbigodot-547"></a><dd>\bigodot + + <br><dt><code>\bigoplus</code><a name="index-g_t_005cbigoplus-548"></a><dd>\bigoplus + + <br><dt><code>\bigotimes</code><a name="index-g_t_005cbigotimes-549"></a><dd>\bigotimes + + <br><dt><code>\bigtriangledown</code><a name="index-g_t_005cbigtriangledown-550"></a><dd>\bigtriangledown (binary operation) + + <br><dt><code>\bigtriangleup</code><a name="index-g_t_005cbigtriangleup-551"></a><dd>\bigtriangleup (binary operation) + + <br><dt><code>\bigsqcup</code><a name="index-g_t_005cbigsqcup-552"></a><dd>\bigsqcup + + <br><dt><code>\biguplus</code><a name="index-g_t_005cbiguplus-553"></a><dd>\biguplus + + <br><dt><code>\bigcap</code><a name="index-g_t_005cbigcap-554"></a><dd>\bigvee + + <br><dt><code>\bigwedge</code><a name="index-g_t_005cbigwedge-555"></a><dd>\bigwedge + + <br><dt><code>\bot</code><a name="index-g_t_005cbot-556"></a><dd>\bot + + <br><dt><code>\bowtie</code><a name="index-g_t_005cbowtie-557"></a><dd>\bowtie (relation) + + <br><dt><code>\Box</code><a name="index-g_t_005cBox-558"></a><dd>(square open box symbol) <!-- xx not in plain --> + + <br><dt><code>\bullet</code><a name="index-g_t_005cbullet-559"></a><dd><a name="index-bullet-symbol-560"></a>\bullet (binary operation) + + <br><dt><code>\cap</code><a name="index-g_t_005ccap-561"></a><dd>\cap (binary operation) + + <br><dt><code>\cdot</code><a name="index-g_t_005ccdot-562"></a><dd>\cdot (binary operation) + + <br><dt><code>\chi</code><a name="index-g_t_005cchi-563"></a><dd>\chi + + <br><dt><code>\circ</code><a name="index-g_t_005ccirc-564"></a><dd>\circ (binary operation) + + <br><dt><code>\clubsuit</code><a name="index-g_t_005cclubsuit-565"></a><dd>\clubsuit + + <br><dt><code>\cong</code><a name="index-g_t_005ccong-566"></a><dd>\cong (relation) + + <br><dt><code>\coprod</code><a name="index-g_t_005ccoprod-567"></a><dd>\coprod + + <br><dt><code>\cup</code><a name="index-g_t_005ccup-568"></a><dd>\cup (binary operation) + + <br><dt><code>\dagger</code><a name="index-g_t_005cdagger-569"></a><dd>\dagger (binary operation) + + <br><dt><code>\dashv</code><a name="index-g_t_005cdashv-570"></a><dd>\dashv (relation) + + <br><dt><code>\ddagger</code><a name="index-g_t_005cddagger-571"></a><dd>\dagger (binary operation) + + <br><dt><code>\Delta</code><a name="index-g_t_005cDelta-572"></a><dd>\Delta + + <br><dt><code>\delta</code><a name="index-g_t_005cdelta-573"></a><dd>\delta + + <br><dt><code>\Diamond</code><a name="index-g_t_005cDiamond-574"></a><dd>bigger \diamond <!-- xx not in plain --> + + <br><dt><code>\diamond</code><a name="index-g_t_005cdiamond-575"></a><dd>\diamond (binary operation) + + <br><dt><code>\diamondsuit</code><a name="index-g_t_005cdiamondsuit-576"></a><dd>\diamondsuit + + <br><dt><code>\div</code><a name="index-g_t_005cdiv-577"></a><dd>\div (binary operation) + + <br><dt><code>\doteq</code><a name="index-g_t_005cdoteq-578"></a><dd>\doteq (relation) + + <br><dt><code>\downarrow</code><a name="index-g_t_005cdownarrow-579"></a><dd>\downarrow (delimiter) + + <br><dt><code>\Downarrow</code><a name="index-g_t_005cDownarrow-580"></a><dd>\Downarrow (delimiter) + + <br><dt><code>\ell</code><a name="index-g_t_005cell-581"></a><dd>\ell + + <br><dt><code>\emptyset</code><a name="index-g_t_005cemptyset-582"></a><dd>\emptyset + + <br><dt><code>\epsilon</code><a name="index-g_t_005cepsilon-583"></a><dd>\epsilon + + <br><dt><code>\equiv</code><a name="index-g_t_005cequiv-584"></a><dd>\equiv (relation) + + <br><dt><code>\eta</code><a name="index-g_t_005ceta-585"></a><dd>\eta + + <br><dt><code>\exists</code><a name="index-g_t_005cexists-586"></a><dd>\exists + + <br><dt><code>\flat</code><a name="index-g_t_005cflat-587"></a><dd>\flat + + <br><dt><code>\forall</code><a name="index-g_t_005cforall-588"></a><dd>\forall + + <br><dt><code>\frown</code><a name="index-g_t_005cfrown-589"></a><dd>\frown (relation) + + <br><dt><code>\Gamma</code><a name="index-g_t_005cGamma-590"></a><dd>\Gamma + + <br><dt><code>\gamma</code><a name="index-g_t_005cgamma-591"></a><dd>\gamma + + <br><dt><code>\ge</code><a name="index-g_t_005cge-592"></a><dd>\ge + + <br><dt><code>\geq</code><a name="index-g_t_005cgeq-593"></a><dd>\geq (relation) + + <br><dt><code>\gets</code><a name="index-g_t_005cgets-594"></a><dd>\gets + + <br><dt><code>\gg</code><a name="index-g_t_005cgg-595"></a><dd>\gg (relation) + + <br><dt><code>\hbar</code><a name="index-g_t_005chbar-596"></a><dd>\hbar + + <br><dt><code>\heartsuit</code><a name="index-g_t_005cheartsuit-597"></a><dd>\heartsuit + + <br><dt><code>\hookleftarrow</code><a name="index-g_t_005chookleftarrow-598"></a><dd>\hookleftarrow + + <br><dt><code>\hookrightarrow</code><a name="index-g_t_005chookrightarrow-599"></a><dd>\hookrightarrow + + <br><dt><code>\iff</code><a name="index-g_t_005ciff-600"></a><dd>\iff + + <br><dt><code>\Im</code><a name="index-g_t_005cIm-601"></a><dd>\Im + + <br><dt><code>\in</code><a name="index-g_t_005cin-602"></a><dd>\in (relation) + + <br><dt><code>\infty</code><a name="index-g_t_005cinfty-603"></a><dd>\infty + + <br><dt><code>\int</code><a name="index-g_t_005cint-604"></a><dd>\int + + <br><dt><code>\iota</code><a name="index-g_t_005ciota-605"></a><dd>\iota + + <br><dt><code>\Join</code><a name="index-g_t_005cJoin-606"></a><dd>condensed bowtie symbol (relation) <!-- xx not in plain --> + + <br><dt><code>\kappa</code><a name="index-g_t_005ckappa-607"></a><dd>\kappa + + <br><dt><code>\Lambda</code><a name="index-g_t_005cLambda-608"></a><dd>\Lambda + + <br><dt><code>\lambda</code><a name="index-g_t_005clambda-609"></a><dd>\lambda + + <br><dt><code>\land</code><a name="index-g_t_005cland-610"></a><dd>\land + + <br><dt><code>\langle</code><a name="index-g_t_005clangle-611"></a><dd>\langle (delimiter) + + <br><dt><code>\lbrace</code><a name="index-g_t_005clbrace-612"></a><dd>\lbrace (delimiter) + + <br><dt><code>\lbrack</code><a name="index-g_t_005clbrack-613"></a><dd>\lbrack (delimiter) + + <br><dt><code>\lceil</code><a name="index-g_t_005clceil-614"></a><dd>\lceil (delimiter) + + <br><dt><code>\le</code><a name="index-g_t_005cle-615"></a><dd>\le + + <br><dt><code>\leadsto</code><a name="index-g_t_005cleadsto-616"></a><dd><!-- xx missing from plain --> + + <br><dt><code>\Leftarrow</code><a name="index-g_t_005cLeftarrow-617"></a><dd>\Leftarrow + + <br><dt><code>\leftarrow</code><a name="index-g_t_005cleftarrow-618"></a><dd>\leftarrow + + <br><dt><code>\leftharpoondown</code><a name="index-g_t_005cleftharpoondown-619"></a><dd>\leftharpoondown + + <br><dt><code>\leftharpoonup</code><a name="index-g_t_005cleftharpoonup-620"></a><dd>\leftharpoonup + + <br><dt><code>\Leftrightarrow</code><a name="index-g_t_005cLeftrightarrow-621"></a><dd>\Leftrightarrow + + <br><dt><code>\leftrightarrow</code><a name="index-g_t_005cleftrightarrow-622"></a><dd>\leftrightarrow + + <br><dt><code>\leq</code><a name="index-g_t_005cleq-623"></a><dd>\leq (relation) + + <br><dt><code>\lfloor</code><a name="index-g_t_005clfloor-624"></a><dd>\lfloor (delimiter) + + <br><dt><code>\lhd</code><a name="index-g_t_005clhd-625"></a><dd>(left-pointing arrow head) <!-- xx not in plain --> + + <br><dt><code>\ll</code><a name="index-g_t_005cll-626"></a><dd>\ll (relation) + + <br><dt><code>\lnot</code><a name="index-g_t_005clnot-627"></a><dd>\lnot + + <br><dt><code>\longleftarrow</code><a name="index-g_t_005clongleftarrow-628"></a><dd>\longleftarrow + + <br><dt><code>\longleftrightarrow</code><a name="index-g_t_005clongleftrightarrow-629"></a><dd>\longleftrightarrow + + <br><dt><code>\longmapsto</code><a name="index-g_t_005clongmapsto-630"></a><dd>\longmapsto + + <br><dt><code>\longrightarrow</code><a name="index-g_t_005clongrightarrow-631"></a><dd>\longrightarrow + + <br><dt><code>\lor</code><a name="index-g_t_005clor-632"></a><dd>\lor + + <br><dt><code>\mapsto</code><a name="index-g_t_005cmapsto-633"></a><dd>\mapsto + + <br><dt><code>\mho</code><a name="index-g_t_005cmho-634"></a><dd><!-- xx not in plain --> + + <br><dt><code>\mid</code><a name="index-g_t_005cmid-635"></a><dd>\mid (relation) + + <br><dt><code>\models</code><a name="index-g_t_005cmodels-636"></a><dd>\models (relation) + + <br><dt><code>\mp</code><a name="index-g_t_005cmp-637"></a><dd>\mp (binary operation) + + <br><dt><code>\mu</code><a name="index-g_t_005cmu-638"></a><dd>\mu + + <br><dt><code>\nabla</code><a name="index-g_t_005cnabla-639"></a><dd>\nabla + + <br><dt><code>\natural</code><a name="index-g_t_005cnatural-640"></a><dd>\natural + + <br><dt><code>\ne</code><a name="index-g_t_005cne-641"></a><dd>\ne + + <br><dt><code>\nearrow</code><a name="index-g_t_005cnearrow-642"></a><dd>\nearrow + + <br><dt><code>\neg</code><a name="index-g_t_005cneg-643"></a><dd>\neg + + <br><dt><code>\neq</code><a name="index-g_t_005cneq-644"></a><dd>\neq (relation) + + <br><dt><code>\ni</code><a name="index-g_t_005cni-645"></a><dd>\ni (relation) + + <br><dt><code>\not</code><a name="index-g_t_005cnot-646"></a><dd>Overstrike a following operator with a /, as in \not=. + + <br><dt><code>\notin</code><a name="index-g_t_005cnotin-647"></a><dd>\ni + + <br><dt><code>\nu</code><a name="index-g_t_005cnu-648"></a><dd>\nu + + <br><dt><code>\nwarrow</code><a name="index-g_t_005cnwarrow-649"></a><dd>\nwarrow + + <br><dt><code>\odot</code><a name="index-g_t_005codot-650"></a><dd>\odot (binary operation) + + <br><dt><code>\oint</code><a name="index-g_t_005coint-651"></a><dd>\oint + + <br><dt><code>\Omega</code><a name="index-g_t_005cOmega-652"></a><dd>\Omega + + <br><dt><code>\omega</code><a name="index-g_t_005comega-653"></a><dd>\omega + + <br><dt><code>\ominus</code><a name="index-g_t_005cominus-654"></a><dd>\ominus (binary operation) + + <br><dt><code>\oplus</code><a name="index-g_t_005coplus-655"></a><dd>\oplus (binary operation) + + <br><dt><code>\oslash</code><a name="index-g_t_005coslash-656"></a><dd>\oslash (binary operation) + + <br><dt><code>\otimes</code><a name="index-g_t_005cotimes-657"></a><dd>\otimes (binary operation) + + <br><dt><code>\owns</code><a name="index-g_t_005cowns-658"></a><dd>\owns + + <br><dt><code>\parallel</code><a name="index-g_t_005cparallel-659"></a><dd>\parallel (relation) + + <br><dt><code>\partial</code><a name="index-g_t_005cpartial-660"></a><dd>\partial + + <br><dt><code>\perp</code><a name="index-g_t_005cperp-661"></a><dd>\perp (relation) + + <br><dt><code>\phi</code><a name="index-g_t_005cphi-662"></a><dd>\phi + + <br><dt><code>\Pi</code><a name="index-g_t_005cPi-663"></a><dd>\Pi + + <br><dt><code>\pi</code><a name="index-g_t_005cpi-664"></a><dd>\pi + + <br><dt><code>\pm</code><a name="index-g_t_005cpm-665"></a><dd>\pm (binary operation) + + <br><dt><code>\prec</code><a name="index-g_t_005cprec-666"></a><dd>\prec (relation) + + <br><dt><code>\preceq</code><a name="index-g_t_005cpreceq-667"></a><dd>\preceq (relation) + + <br><dt><code>\prime</code><a name="index-g_t_005cprime-668"></a><dd>\prime + + <br><dt><code>\prod</code><a name="index-g_t_005cprod-669"></a><dd>\prod + + <br><dt><code>\propto</code><a name="index-g_t_005cpropto-670"></a><dd>\propto (relation) + + <br><dt><code>\Psi</code><a name="index-g_t_005cPsi-671"></a><dd>\Psi + + <br><dt><code>\psi</code><a name="index-g_t_005cpsi-672"></a><dd>\psi + + <br><dt><code>\rangle</code><a name="index-g_t_005crangle-673"></a><dd>\rangle (delimiter) + + <br><dt><code>\rbrace</code><a name="index-g_t_005crbrace-674"></a><dd>\rbrace (delimiter) + + <br><dt><code>\rbrack</code><a name="index-g_t_005crbrack-675"></a><dd>\rbrack (delimiter) + + <br><dt><code>\rceil</code><a name="index-g_t_005crceil-676"></a><dd>\rceil (delimiter) + + <br><dt><code>\Re</code><a name="index-g_t_005cRe-677"></a><dd>\Re + + <br><dt><code>\rfloor</code><a name="index-g_t_005crfloor-678"></a><dd>\rfloor + + <br><dt><code>\rhd</code><a name="index-g_t_005crhd-679"></a><dd>(binary operation) <!-- xx not in plain @math{\rhd} --> + + <br><dt><code>\rho</code><a name="index-g_t_005crho-680"></a><dd>\rho + + <br><dt><code>\Rightarrow</code><a name="index-g_t_005cRightarrow-681"></a><dd>\Rightarrow + + <br><dt><code>\rightarrow</code><a name="index-g_t_005crightarrow-682"></a><dd>\rightarrow + + <br><dt><code>\rightharpoondown</code><a name="index-g_t_005crightharpoondown-683"></a><dd>\rightharpoondown + + <br><dt><code>\rightharpoonup</code><a name="index-g_t_005crightharpoonup-684"></a><dd>\rightharpoonup + + <br><dt><code>\rightleftharpoons</code><a name="index-g_t_005crightleftharpoons-685"></a><dd>\rightleftharpoons + + <br><dt><code>\searrow</code><a name="index-g_t_005csearrow-686"></a><dd>\searrow + + <br><dt><code>\setminus</code><a name="index-g_t_005csetminus-687"></a><dd>\setminus (binary operation) + + <br><dt><code>\sharp</code><a name="index-g_t_005csharp-688"></a><dd>\sharp + + <br><dt><code>\Sigma</code><a name="index-g_t_005cSigma-689"></a><dd>\Sigma + + <br><dt><code>\sigma</code><a name="index-g_t_005csigma-690"></a><dd>\sigma + + <br><dt><code>\sim</code><a name="index-g_t_005csim-691"></a><dd>\sim (relation) + + <br><dt><code>\simeq</code><a name="index-g_t_005csimeq-692"></a><dd>\simeq (relation) + + <br><dt><code>\smallint</code><a name="index-g_t_005csmallint-693"></a><dd>\smallint + + <br><dt><code>\smile</code><a name="index-g_t_005csmile-694"></a><dd>\smile (relation) + + <br><dt><code>\spadesuit</code><a name="index-g_t_005cspadesuit-695"></a><dd>\spadesuit + + <br><dt><code>\sqcap</code><a name="index-g_t_005csqcap-696"></a><dd>\sqcap (binary operation) + + <br><dt><code>\sqcup</code><a name="index-g_t_005csqcup-697"></a><dd>\sqcup (binary operation) + + <br><dt><code>\sqsubset</code><a name="index-g_t_005csqsubset-698"></a><dd>(relation) <!-- not in plain (@math{\sqsubset}) --> + + <br><dt><code>\sqsubseteq</code><a name="index-g_t_005csqsubseteq-699"></a><dd>\sqsubseteq (relation) + + <br><dt><code>\sqsupset</code><a name="index-g_t_005csqsupset-700"></a><dd>(relation) <!-- not in plain (@math{\sqsupset}) --> + + <br><dt><code>\sqsupseteq</code><a name="index-g_t_005csqsupseteq-701"></a><dd>\sqsupseteq (relation) + + <br><dt><code>\star</code><a name="index-g_t_005cstar-702"></a><dd>\star (binary operation) + + <br><dt><code>\subset</code><a name="index-g_t_005csubset-703"></a><dd>\subset (relation) + + <br><dt><code>\subseteq</code><a name="index-g_t_005csubseteq-704"></a><dd>\subseteq (relation) + + <br><dt><code>\succ</code><a name="index-g_t_005csucc-705"></a><dd>\succ (relation) + + <br><dt><code>\succeq</code><a name="index-g_t_005csucceq-706"></a><dd>\succeq (relation) + + <br><dt><code>\sum</code><a name="index-g_t_005csum-707"></a><dd>\sum + + <br><dt><code>\supset</code><a name="index-g_t_005csupset-708"></a><dd>\supset (relation) + + <br><dt><code>\supseteq</code><a name="index-g_t_005csupseteq-709"></a><dd>\supseteq (relation) + + <br><dt><code>\surd</code><a name="index-g_t_005csurd-710"></a><dd>\surd + + <br><dt><code>\swarrow</code><a name="index-g_t_005cswarrow-711"></a><dd>\swarrow + + <br><dt><code>\tau</code><a name="index-g_t_005ctau-712"></a><dd>\tau + + <br><dt><code>\theta</code><a name="index-g_t_005ctheta-713"></a><dd>\theta + + <br><dt><code>\times</code><a name="index-g_t_005ctimes-714"></a><dd>\times (binary operation) + + <br><dt><code>\to</code><a name="index-g_t_005cto-715"></a><dd>\to + + <br><dt><code>\top</code><a name="index-g_t_005ctop-716"></a><dd>\top + + <br><dt><code>\triangle</code><a name="index-g_t_005ctriangle-717"></a><dd>\triangle + + <br><dt><code>\triangleleft</code><a name="index-g_t_005ctriangleleft-718"></a><dd>\triangleleft (binary operation) + + <br><dt><code>\triangleright</code><a name="index-g_t_005ctriangleright-719"></a><dd>\triangleright (binary operation) + + <br><dt><code>\unlhd</code><a name="index-g_t_005cunlhd-720"></a><dd>left-pointing arrowhead with line under (binary operation) <!-- not in plain --> + + <br><dt><code>\unrhd</code><a name="index-g_t_005cunrhd-721"></a><dd>right-pointing arrowhead with line under (binary operation) <!-- not in plain --> + + <br><dt><code>\Uparrow</code><a name="index-g_t_005cUparrow-722"></a><dd>\Uparrow (delimiter) + + <br><dt><code>\uparrow</code><a name="index-g_t_005cuparrow-723"></a><dd>\uparrow (delimiter) + + <br><dt><code>\Updownarrow</code><a name="index-g_t_005cUpdownarrow-724"></a><dd>\Updownarrow (delimiter) + + <br><dt><code>\updownarrow</code><a name="index-g_t_005cupdownarrow-725"></a><dd>\updownarrow (delimiter) + + <br><dt><code>\uplus</code><a name="index-g_t_005cuplus-726"></a><dd>\uplus (binary operation) + + <br><dt><code>\Upsilon</code><a name="index-g_t_005cUpsilon-727"></a><dd>\Upsilon + + <br><dt><code>\upsilon</code><a name="index-g_t_005cupsilon-728"></a><dd>\upsilon + + <br><dt><code>\varepsilon</code><a name="index-g_t_005cvarepsilon-729"></a><dd>\varepsilon + + <br><dt><code>\varphi</code><a name="index-g_t_005cvarphi-730"></a><dd>\varphi + + <br><dt><code>\varpi</code><a name="index-g_t_005cvarpi-731"></a><dd>\varpi + + <br><dt><code>\varrho</code><a name="index-g_t_005cvarrho-732"></a><dd>\varrho + + <br><dt><code>\varsigma</code><a name="index-g_t_005cvarsigma-733"></a><dd>\varsigma + + <br><dt><code>\vartheta</code><a name="index-g_t_005cvartheta-734"></a><dd>\vartheta + + <br><dt><code>\vdash</code><a name="index-g_t_005cvdash-735"></a><dd>\vdash (relation) + + <br><dt><code>\vee</code><a name="index-g_t_005cvee-736"></a><dd>\vee (binary operation) + + <br><dt><code>\Vert</code><a name="index-g_t_005cVert-737"></a><dd>\Vert (delimiter) + + <br><dt><code>\vert</code><a name="index-g_t_005cvert-738"></a><dd>\vert (delimiter) + + <br><dt><code>\wedge</code><a name="index-g_t_005cwedge-739"></a><dd>\wedge (binary operation) + + <br><dt><code>\wp</code><a name="index-g_t_005cwp-740"></a><dd>\wp + + <br><dt><code>\wr</code><a name="index-g_t_005cwr-741"></a><dd>\wr (binary operation) + + <br><dt><code>\Xi</code><a name="index-g_t_005cXi-742"></a><dd>\Xi + + <br><dt><code>\xi</code><a name="index-g_t_005cxi-743"></a><dd>\xi + + <br><dt><code>\zeta</code><a name="index-g_t_005czeta-744"></a><dd>\zeta + + </dl> + +<div class="node"> +<p><hr> +<a name="Math-functions"></a> +Next: <a rel="next" accesskey="n" href="#Math-accents">Math accents</a>, +Previous: <a rel="previous" accesskey="p" href="#Math-symbols">Math symbols</a>, +Up: <a rel="up" accesskey="u" href="#Math-formulas">Math formulas</a> + +</div> + +<h3 class="section">16.3 Math functions</h3> + +<p><a name="index-math-functions-745"></a><a name="index-functions_002c-math-746"></a> +These commands produce roman function names in math mode with proper +spacing. + + <dl> +<dt><code>\arccos</code><a name="index-g_t_005carccos-747"></a><dd>\arccos + + <br><dt><code>\arcsin</code><a name="index-g_t_005carcsin-748"></a><dd>\arcsin + + <br><dt><code>\arctan</code><a name="index-g_t_005carctan-749"></a><dd>\arctan + + <br><dt><code>\arg</code><a name="index-g_t_005carg-750"></a><dd>\arg + + <br><dt><code>\bmod</code><a name="index-g_t_005cbmod-751"></a><dd>Binary modulo operator (x \bmod y) + + <br><dt><code>\cos</code><a name="index-g_t_005ccos-752"></a><dd>\cos + + <br><dt><code>\cosh</code><a name="index-g_t_005ccosh-753"></a><dd>\cosh + + <br><dt><code>\cot</code><a name="index-g_t_005ccot-754"></a><dd>\cos + + <br><dt><code>\coth</code><a name="index-g_t_005ccoth-755"></a><dd>\cosh + + <br><dt><code>\csc</code><a name="index-g_t_005ccsc-756"></a><dd>\csc + + <br><dt><code>\deg</code><a name="index-g_t_005cdeg-757"></a><dd>\deg + + <br><dt><code>\det</code><a name="index-g_t_005cdet-758"></a><dd>\deg + + <br><dt><code>\dim</code><a name="index-g_t_005cdim-759"></a><dd>\dim + + <br><dt><code>\exp</code><a name="index-g_t_005cexp-760"></a><dd>\exp + + <br><dt><code>\gcd</code><a name="index-g_t_005cgcd-761"></a><dd>\gcd + + <br><dt><code>\hom</code><a name="index-g_t_005chom-762"></a><dd>\hom + + <br><dt><code>\inf</code><a name="index-g_t_005cinf-763"></a><dd>\inf + + <br><dt><code>\ker</code><a name="index-g_t_005cker-764"></a><dd>\ker + + <br><dt><code>\lg</code><a name="index-g_t_005clg-765"></a><dd>\lg + + <br><dt><code>\lim</code><a name="index-g_t_005clim-766"></a><dd>\lim + + <br><dt><code>\liminf</code><a name="index-g_t_005climinf-767"></a><dd>\liminf + + <br><dt><code>\limsup</code><a name="index-g_t_005climsup-768"></a><dd>\limsup + + <br><dt><code>\ln</code><a name="index-g_t_005cln-769"></a><dd>\ln + + <br><dt><code>\log</code><a name="index-g_t_005clog-770"></a><dd>\log + + <br><dt><code>\max</code><a name="index-g_t_005cmax-771"></a><dd>\max + + <br><dt><code>\min</code><a name="index-g_t_005cmin-772"></a><dd>\min + + <br><dt><code>\pmod</code><a name="index-g_t_005cpmod-773"></a><dd>parenthesized modulus, as in (\pmod 2^n - 1) + + <br><dt><code>\Pr</code><a name="index-g_t_005cPr-774"></a><dd>\Pr + + <br><dt><code>\sec</code><a name="index-g_t_005csec-775"></a><dd>\sec + + <br><dt><code>\sin</code><a name="index-g_t_005csin-776"></a><dd>\sin + + <br><dt><code>\sinh</code><a name="index-g_t_005csinh-777"></a><dd>\sinh + + <br><dt><code>\sup</code><a name="index-g_t_005csup-778"></a><dd>\sup + + <br><dt><code>\tan</code><a name="index-g_t_005ctan-779"></a><dd>\tan + + <br><dt><code>\tanh</code><a name="index-g_t_005ctanh-780"></a><dd>\tanh + + </dl> + +<div class="node"> +<p><hr> +<a name="Math-accents"></a> +Next: <a rel="next" accesskey="n" href="#Spacing-in-math-mode">Spacing in math mode</a>, +Previous: <a rel="previous" accesskey="p" href="#Math-functions">Math functions</a>, +Up: <a rel="up" accesskey="u" href="#Math-formulas">Math formulas</a> + +</div> + +<h3 class="section">16.4 Math accents</h3> + +<p><a name="index-math-accents-781"></a><a name="index-accents_002c-mathematical-782"></a> +LaTeX provides a variety of commands for producing accented letters +in math. These are different from accents in normal text +(see <a href="#Accents">Accents</a>). + + <dl> +<dt><code>\acute</code><a name="index-g_t_005cacute-783"></a><dd><a name="index-acute-accent_002c-math-784"></a>Math acute accent: \acutex. + + <br><dt><code>\breve</code><a name="index-g_t_005cbreve-785"></a><dd><a name="index-breve-accent_002c-math-786"></a>Math breve accent: \brevex. + + <br><dt><code>\check</code><a name="index-g_t_005ccheck-787"></a><dd><a name="index-check-accent_002c-math-788"></a><a name="index-h_0040_0027a_0040v_007bc_007dek-accent_002c-math-789"></a>Math hác<ek (check) accent: \checkx. + + <br><dt><code>\ddot</code><a name="index-g_t_005cddot-790"></a><dd><a name="index-double-dot-accent_002c-math-791"></a>Math dieresis accent: \ddotx. + + <br><dt><code>\dot</code><a name="index-g_t_005cdot-792"></a><dd><a name="index-overdot-accent_002c-math-793"></a><a name="index-dot-over-accent_002c-math-794"></a>Math dot accent: \dotx. + + <br><dt><code>\grave</code><a name="index-g_t_005cgrave-795"></a><dd><a name="index-grave-accent_002c-math-796"></a>Math grave accent: \gravex. + + <br><dt><code>\hat</code><a name="index-g_t_005chat-797"></a><dd><a name="index-hat-accent_002c-math-798"></a><a name="index-circumflex-accent_002c-math-799"></a>Math hat (circumflex) accent: \hatx. + + <br><dt><code>\imath</code><a name="index-g_t_005cimath-800"></a><dd><a name="index-dotless-i_002c-math-801"></a>Math dotless i. + + <br><dt><code>\jmath</code><a name="index-g_t_005cjmath-802"></a><dd><a name="index-dotless-j_002c-math-803"></a>Math dotless j. + + <br><dt><code>\tilde</code><a name="index-g_t_005ctilde-804"></a><dd><a name="index-tilde-accent_002c-math-805"></a>Math tilde accent: \tildex. + + <br><dt><code>\vec</code><a name="index-g_t_005cvec-806"></a><dd><a name="index-vector-symbol_002c-math-807"></a>Math vector symbol: \vecx. + + <br><dt><code>\widehat</code><a name="index-g_t_005cwidehat-808"></a><dd><a name="index-wide-hat-accent_002c-math-809"></a>Math wide hat accent: \widehatx+y. + + <br><dt><code>\widehat</code><a name="index-g_t_005cwidehat-810"></a><dd><a name="index-wide-tile-accent_002c-math-811"></a>Math wide tilde accent: \widetildex+y. + + </dl> + +<div class="node"> +<p><hr> +<a name="Spacing-in-math-mode"></a> +Next: <a rel="next" accesskey="n" href="#Math-Miscellany">Math Miscellany</a>, +Previous: <a rel="previous" accesskey="p" href="#Math-accents">Math accents</a>, +Up: <a rel="up" accesskey="u" href="#Math-formulas">Math formulas</a> + +</div> + +<h3 class="section">16.5 Spacing in math mode</h3> + +<p><a name="index-spacing-within-math-mode-812"></a><a name="index-math-mode_002c-spacing-813"></a> +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: + + <dl> +<dt><code>\;</code><dd><a name="index-g_t_005c_003b-814"></a>A thick space (5\over18\,quad). +<br><dt><code>\:</code><dt><code>\></code><dd><a name="index-g_t_005c_003a-815"></a><a name="index-g_t_005c_003e-816"></a>Both of these produce a medium space (2\over9\,quad). +<br><dt><code>\,</code><dd><a name="index-g_t_005c_002c-817"></a>A thin space (1\over6\,quad); not restricted to math mode. +<br><dt><code>\!</code><dd>A negative thin space (-1\over6\,quad). +</dl> + +<div class="node"> +<p><hr> +<a name="Math-Miscellany"></a> +Previous: <a rel="previous" accesskey="p" href="#Spacing-in-math-mode">Spacing in math mode</a>, +Up: <a rel="up" accesskey="u" href="#Math-formulas">Math formulas</a> + +</div> + +<h3 class="section">16.6 Math Miscellany</h3> + +<p><a name="index-math-Miscellany-818"></a> + <dl> +<dt><code>\*</code><a name="index-g_t_005c_002a-819"></a><dd><a name="index-discretionary-multiplication-820"></a><a name="index-multiplication-symbol_002c-discretionary-line-break-821"></a>A “discretionary” multiplication symbol, at which a line break is +allowed. + + <br><dt><code>\cdots</code><a name="index-g_t_005ccdots-822"></a><dd>A horizontal ellipsis with the dots raised to the center of the line. + + <br><dt><code>\ddots</code><a name="index-g_t_005cddots-823"></a><dd>A diagonal ellipsis: \ddots. + + <br><dt><code>\frac{num}{den}</code><a name="index-g_t_005cfrac_0040_007bnum_0040_007d_0040_007bden_0040_007d-824"></a><dd><a name="index-g_t_005cfrac-825"></a>Produces the fraction <code>num</code> divided by <code>den</code>. + + <br><dt><code>\left </code><var>delim1</var><code> ... \right </code><var>delim2</var><a name="index-g_t_005cleft-_0040var_007bdelim1_007d-_002e_002e_002e-_005cright-_0040var_007bdelim2_007d-826"></a><dd><a name="index-g_t_005cright-827"></a><a name="index-null-delimiter-828"></a>The two delimiters need not match; ‘<samp><span class="samp">.</span></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>. + + <br><dt><code>\overbrace{</code><var>text</var><code>}</code><a name="index-g_t_005coverbrace_0040_007b_0040var_007btext_007d_0040_007d-829"></a><dd>Generates a brace over <var>text</var>. +For example, \overbracex+\cdots+x^k \rm\;times. + + <br><dt><code>\overline{</code><var>text</var><code>}</code><a name="index-g_t_005coverline_0040_007b_0040var_007btext_007d_0040_007d-830"></a><dd>Generates a horizontal line over <var>tex</var>. +For exampe, \overlinex+y. + + <br><dt><code>\sqrt[</code><var>root</var><code>]{arg}</code><a name="index-g_t_005csqrt_005b_0040var_007broot_007d_005d_0040_007barg_0040_007d-831"></a><dd>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>. + + <br><dt><code>\stackrel{</code><var>text</var><code>}{</code><var>relation</var><code>}</code><a name="index-g_t_005cstackrel_0040_007b_0040var_007btext_007d_0040_007d_0040_007b_0040var_007brelation_007d_0040_007d-832"></a><dd>Puts <var>text</var> above <var>relation</var>. For example, +<code>\stackrel{f}{\longrightarrow}</code>. + + <br><dt><code>\underbrace{math}</code><a name="index-g_t_005cunderbrace_0040_007bmath_0040_007d-833"></a><dd>Generates <var>math</var> with a brace underneath. + + <br><dt><code>\underline{text}</code><a name="index-g_t_005cunderline_0040_007btext_0040_007d-834"></a><dd>Causes <var>text</var>, which may be either math mode or not, to be +underlined. + + <br><dt><code>\vdots</code><a name="index-g_t_005cvdots-835"></a><dd><a name="index-g_t_005cvdots-836"></a>Produces a vertical ellipsis. + + </dl> + +<div class="node"> +<p><hr> +<a name="Modes"></a> +Next: <a rel="next" accesskey="n" href="#Page-Styles">Page Styles</a>, +Previous: <a rel="previous" accesskey="p" href="#Math-formulas">Math formulas</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">17 Modes</h2> + +<p><a name="index-modes-837"></a><a name="index-paragraph-mode-838"></a><a name="index-math-mode-839"></a><a name="index-left_002dto_002dright-mode-840"></a><a name="index-lR-mode-841"></a> + + <p>When LaTeX is processing your input text, it is always in one of three +modes: + + <ul> +<li>Paragraph mode +<li>Math mode +<li>Left-to-right mode, called LR mode for short +</ul> + + <p>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. + + <p>“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. + + <p>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”. + +<div class="node"> +<p><hr> +<a name="Page-Styles"></a> +Next: <a rel="next" accesskey="n" href="#Spaces">Spaces</a>, +Previous: <a rel="previous" accesskey="p" href="#Modes">Modes</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">18 Page Styles</h2> + +<p><a name="index-styles_002c-page-842"></a><a name="index-page-styles-843"></a> +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. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cmaketitle">\maketitle</a>: Generate a title page. +<li><a accesskey="2" href="#g_t_005cpagenumbering">\pagenumbering</a>: Set the style used for page numbers. +<li><a accesskey="3" href="#g_t_005cpagestyle">\pagestyle</a>: Change the headings/footings style. +<li><a accesskey="4" href="#g_t_005cthispagestyle">\thispagestyle</a>: Change the headings/footings style for this page. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cmaketitle"></a> +<a name="g_t_005cmaketitle"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cpagenumbering">\pagenumbering</a>, +Up: <a rel="up" accesskey="u" href="#Page-Styles">Page Styles</a> + +</div> + +<h3 class="section">18.1 <code>\maketitle</code></h3> + +<p><a name="index-titles_002c-making-844"></a><a name="index-g_t_005cmaketitle-845"></a> +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: + + <dl> +<dt><code>\author{</code><var>name</var><code> \and </code><var>name2</var><code>}</code><a name="index-g_t_005cauthor_0040_007b_0040var_007bname_007d-_005cand-_0040var_007bname2_007d_0040_007d-846"></a><dd><a name="index-author_002c-for-titlepage-847"></a><a name="index-g_t_005c_005c-_0040r_007bfor-_0040code_007b_005cauthor_007d_007d-848"></a><a name="index-g_t_005cand-_0040r_007bfor-_0040code_007b_005cauthor_007d_007d-849"></a>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. + + <br><dt><code>\date{</code><var>text</var><code>}</code><a name="index-g_t_005cdate_0040_007b_0040var_007btext_007d_0040_007d-850"></a><dd><a name="index-date_002c-for-titlepage-851"></a>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 <a href="#g_t_005ctoday">\today</a>) +is used. + + <br><dt><code>\thanks{</code><var>text</var><code>}</code><a name="index-g_t_005cthanks_0040_007b_0040var_007btext_007d_0040_007d-852"></a><dd><a name="index-thanks_002c-for-titlepage-853"></a><a name="index-credit-footnote-854"></a>The <code>\thanks</code> command produces a <code>\footnote</code> to the title, +usually used for credit acknowledgements. + + <br><dt><code>\title{</code><var>text</var><code>}</code><a name="index-g_t_005ctitle_0040_007b_0040var_007btext_007d_0040_007d-855"></a><dd><a name="index-title_002c-for-titlepage-856"></a><a name="index-g_t_005c_005c-_0040r_007bfor-_0040code_007b_005ctitle_007d_007d-857"></a>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. + + </dl> + +<div class="node"> +<p><hr> +<a name="%5cpagenumbering"></a> +<a name="g_t_005cpagenumbering"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cpagestyle">\pagestyle</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cmaketitle">\maketitle</a>, +Up: <a rel="up" accesskey="u" href="#Page-Styles">Page Styles</a> + +</div> + +<h3 class="section">18.2 <code>\pagenumbering</code></h3> + +<p><a name="index-g_t_005cpagenumbering-858"></a><a name="index-page-numbering-style-859"></a> +Synopsis: + +<pre class="example"> \pagenumbering{<var>style</var>} +</pre> + <p>Specifies the style of page numbers, according to <var>style</var>: + + <dl> +<dt><code>arabic</code><dd>arabic numerals +<br><dt><code>roman</code><dd>lowercase Roman numerals +<br><dt><code>Roman</code><dd>uppercase Roman numerals +<br><dt><code>alph</code><dd>lowercase letters +<br><dt><code>Alph</code><dd>uppercase letters +</dl> + +<div class="node"> +<p><hr> +<a name="%5cpagestyle"></a> +<a name="g_t_005cpagestyle"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cthispagestyle">\thispagestyle</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cpagenumbering">\pagenumbering</a>, +Up: <a rel="up" accesskey="u" href="#Page-Styles">Page Styles</a> + +</div> + +<h3 class="section">18.3 <code>\pagestyle</code></h3> + +<p><a name="index-g_t_005cpagestyle-860"></a><a name="index-header-style-861"></a><a name="index-footer-style-862"></a><a name="index-running-header-and-footer-style-863"></a> +Synopsis: + +<pre class="example"> \pagestyle{<var>style</var>} +</pre> + <p>The <code>\pagestyle</code> command specifies how the headers and footers +are typeset from the current page onwards. Values for <var>style</var>: + + <dl> +<dt><code>plain</code><dd>Just a plain page number. + + <br><dt><code>empty</code><dd>Empty headers and footers, e.g., no page numbers. + + <br><dt><code>headings</code><dd>Put running headers on each page. The document style specifies what +goes in the headers. + + <br><dt><code>myheadings</code><dd>Custom headers, specified via the <code>\markboth</code> or the +<code>\markright</code> commands. + + </dl> + + <p>Here are the descriptions of <code>\markboth</code> and <code>\markright</code>: + + <dl> +<dt><code>\markboth{</code><var>left</var><code>}{</code><var>right</var><code>}</code><a name="index-g_t_005cmarkboth_0040_007b_0040var_007bleft_007d_0040_007d_0040_007b_0040var_007bright_007d_0040_007d-864"></a><dd>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. + + <br><dt><code>\markright{</code><var>right</var><code>}</code><a name="index-g_t_005cmarkright_0040_007b_0040var_007bright_007d_0040_007d-865"></a><dd>Sets the right heading, leaving the left heading unchanged. + + </dl> + +<div class="node"> +<p><hr> +<a name="%5cthispagestyle"></a> +<a name="g_t_005cthispagestyle"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cpagestyle">\pagestyle</a>, +Up: <a rel="up" accesskey="u" href="#Page-Styles">Page Styles</a> + +</div> + +<h3 class="section">18.4 <code>\thispagestyle{</code><var>style</var><code>}</code></h3> + +<p><a name="index-g_t_005cthispagestyle-866"></a> +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. + +<div class="node"> +<p><hr> +<a name="Spaces"></a> +Next: <a rel="next" accesskey="n" href="#Boxes">Boxes</a>, +Previous: <a rel="previous" accesskey="p" href="#Page-Styles">Page Styles</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">19 Spaces</h2> + +<p><a name="index-spaces-867"></a> +LaTeX has many ways to produce white (or filled) space. + + <p>Another space-producing command is <code>\,</code> to produce a “thin” +space (usually 1/6<span class="dmn">quad</span>). It can be used in text mode, but is +more often useful in math mode (see <a href="#Spacing-in-math-mode">Spacing in math mode</a>). + +</li></ul> +<p>Horizontal space +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005chspace">\hspace</a>: Fixed horizontal space. +<li><a accesskey="2" href="#g_t_005cSPACE">\SPACE</a>: Normal interword space. +<li><a accesskey="3" href="#g_t_005cAT">\AT</a>: Ending a sentence. +<li><a accesskey="4" href="#g_t_005cthinspace">\thinspace</a>: One-sixth of an em. +<li><a accesskey="5" href="#g_t_005c_002f">\/</a>: Per-character italic correction. +<li><a accesskey="6" href="#g_t_005chfill">\hfill</a>: Stretchable horizontal space. +<li><a accesskey="7" href="#g_t_005chrulefill">\hrulefill</a>: Stretchable horizontal rule. +<li><a accesskey="8" href="#g_t_005cdotfill">\dotfill</a>: Stretchable horizontal dots. + +</li></ul> +<p>Vertical space +</p> +<ul class="menu"> +<li><a accesskey="9" href="#g_t_005caddvspace">\addvspace</a>: Add arbitrary vertical space if needed. +<li><a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a>: Fixed vertical spaces. +<li><a href="#g_t_005cvfill">\vfill</a>: Infinitely stretchable vertical space. +<li><a href="#g_t_005cvspace">\vspace</a>: Add arbitrary vertical space. +</ul> + +<div class="node"> +<p><hr> +<a name="%5chspace"></a> +<a name="g_t_005chspace"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cSPACE">\SPACE</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.1 <code>\hspace</code></h3> + +<p><a name="index-g_t_005chspace-868"></a> +Synopsis: + +<pre class="example"> \hspace[*]{<var>length</var>} +</pre> + <p>The <code>\hspace</code> command adds horizontal space. The <var>length</var> +argument can be expressed in any terms that LaTeX understands: +points, inches, etc. It is a rubber length. You can add both +negative and positive space with an <code>\hspace</code> command; adding +negative space is like backspacing. + + <p>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. + +<div class="node"> +<p><hr> +<a name="%5chfill"></a> +<a name="g_t_005chfill"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005chrulefill">\hrulefill</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005c_002f">\/</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.2 <code>\hfill</code></h3> + +<p><a name="index-g_t_005chfill-869"></a>The <code>\hfill</code> fill command produces a “rubber length” which has +no natural space but can stretch or shrink horizontally as far as +needed. + + <p><a name="index-g_t_005cfill-870"></a>The <code>\fill</code> parameter is the rubber length itself (technically, +the glue value ‘<samp><span class="samp">0pt plus1fill</span></samp>’); thus, <code>\hspace\fill</code> is +equivalent to <code>\hfill</code>. + +<div class="node"> +<p><hr> +<a name="%5cSPACE"></a> +<a name="g_t_005cSPACE"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cAT">\AT</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005chspace">\hspace</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.3 <code>\SPACE</code></h3> + +<p><a name="index-g_t_005cSPACE-871"></a><a name="index-g_t_005cTAB-872"></a><a name="index-g_t_005cNEWLINE-873"></a> +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> + + <p>In normal circumstances, <code>\</code><tab> and <code>\</code><newline> +are equivalent to <code>\ </code>. + +<div class="node"> +<p><hr> +<a name="%5cAT"></a> +<a name="g_t_005cAT"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cthinspace">\thinspace</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cSPACE">\SPACE</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.4 <code>\@</code></h3> + +<p><a name="index-g_t_005c_0040_0040-874"></a> +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>: + +<pre class="example"> ... in C\@. Pascal, though ... + ... in C. Pascal, though ... +</pre> + <p class="noindent">produces + +<!-- Texinfo does it differently, but the result is the same. --> + <blockquote> +<small class="dots">...</small> in C. Pascal, though <small class="dots">...</small> +<small class="dots">...</small> in C. Pascal, though <small class="dots">...</small> +</blockquote> + +<div class="node"> +<p><hr> +<a name="%5cthinspace"></a> +<a name="g_t_005cthinspace"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005c_002f">\/</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cAT">\AT</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.5 <code>\thinspace</code></h3> + +<p><a name="index-g_t_005cthinspace-875"></a> +<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 '<span class="dmn">”</span>. + +<div class="node"> +<p><hr> +<a name="%5c%2f"></a> +<a name="g_t_005c_002f"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005chfill">\hfill</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cthinspace">\thinspace</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.6 <code>\/</code></h3> + +<p><a name="index-g_t_005c_002f-876"></a> +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. + + <p>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>. + + <p>Despite the name, roman characters can also have an italic +correction. Compare +pdfTeX (in the TeX output, there is a small space after the `f') +with pdfTeX. + +<div class="node"> +<p><hr> +<a name="%5chrulefill"></a> +<a name="g_t_005chrulefill"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cdotfill">\dotfill</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005chfill">\hfill</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.7 <code>\hrulefill</code></h3> + +<p><a name="index-g_t_005chrulefill-877"></a> +The <code>\hrulefill</code> fill command produces a “rubber length” which can +stretch or shrink horizontally. It will be filled with a horizontal +rule. + +<div class="node"> +<p><hr> +<a name="%5cdotfill"></a> +<a name="g_t_005cdotfill"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005caddvspace">\addvspace</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005chrulefill">\hrulefill</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.8 <code>\dotfill</code></h3> + +<p><a name="index-g_t_005cdotfill-878"></a> +The <code>\dotfill</code> command produces a “rubber length” that fills +with dots instead of just white space. + +<!-- xx undone --> +<div class="node"> +<p><hr> +<a name="%5caddvspace"></a> +<a name="g_t_005caddvspace"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cdotfill">\dotfill</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.9 <code>\addvspace</code></h3> + +<p><a name="index-g_t_005caddvspace-879"></a><a name="index-vertical-space-880"></a><a name="index-space_002c-inserting-vertical-881"></a> +<code>\addvspace{length}</code> + + <p>The <code>\addvspace</code> command normally adds a vertical space of height +length. However, if vertical space has already been added to the same +point in the output by a previous <code>\addvspace</code> command, then this +command will not add more space than needed to make the natural length +of the total vertical space equal to <code>length</code>. + +<div class="node"> +<p><hr> +<a name="%5cbigskip-%5cmedskip-%5csmallskip"></a> +<a name="g_t_005cbigskip-_005cmedskip-_005csmallskip"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cvfill">\vfill</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005caddvspace">\addvspace</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.10 <code>\bigskip \medskip \smallskip</code></h3> + +<p>These commands produce a given amount of space. + + <dl> +<dt><code>\bigskip</code><dd><a name="index-g_t_005cbigskip-882"></a><a name="index-g_t_005cbigskipamount-883"></a>The same as <code>\vspace{bigskipamount}</code>, ordinarily about one line +space (with stretch and shrink). + + <br><dt><code>\medskip</code><dd><a name="index-g_t_005cmedskip-884"></a><a name="index-g_t_005cmedskipamount-885"></a>The same as <code>\vspace{medskipamount}</code>, ordinarily +about half of a line space (with stretch and shrink). + + <br><dt><code>\smallskip</code><dd><a name="index-g_t_005csmallskip-886"></a><a name="index-g_t_005csmallskipamount-887"></a>The same as <code>\vspace{smallskipamount}</code>, ordinarily about a +quarter of a line space (with stretch and shrink). + + </dl> + + <p>The <code>\...amount</code> parameters are determined by the document class. + +<div class="node"> +<p><hr> +<a name="%5cvfill"></a> +<a name="g_t_005cvfill"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cvspace">\vspace</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.11 <code>\vfill</code></h3> + +<p><a name="index-g_t_005cvfill-888"></a> +The <code>\vfill</code> fill command produces a rubber length (glue) which +can stretch or shrink vertically as far as needed. It's equivalent to +<code>\vspace{\fill}</code> (see <a href="#g_t_005chfill">\hfill</a>). + +<div class="node"> +<p><hr> +<a name="%5cvspace"></a> +<a name="g_t_005cvspace"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cvfill">\vfill</a>, +Up: <a rel="up" accesskey="u" href="#Spaces">Spaces</a> + +</div> + +<h3 class="section">19.12 <code>\vspace[*]{</code><var>length</var><code>}</code></h3> + +<p><a name="index-g_t_005cvspace-889"></a> +Synopsis: + +<pre class="example"> \vspace[*]{<var>length</var>} +</pre> + <p>The <code>\vspace</code> command adds the vertical space <var>length</var>, i.e., +a rubber length. <var>length</var> can be negative or positive. + + <p>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. + +<div class="node"> +<p><hr> +<a name="Boxes"></a> +Next: <a rel="next" accesskey="n" href="#Special-insertions">Special insertions</a>, +Previous: <a rel="previous" accesskey="p" href="#Spaces">Spaces</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">20 Boxes</h2> + +<p><a name="index-boxes-890"></a> +All the predefined length parameters (see <a href="#Predefined-lengths">Predefined lengths</a>) can be +used in the arguments of the box-making commands. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cmbox">\mbox</a>: Horizontal boxes. +<li><a accesskey="2" href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a>: Put a frame around a box. +<li><a accesskey="3" href="#lrbox">lrbox</a>: An environment like \sbox. +<li><a accesskey="4" href="#g_t_005cmakebox">\makebox</a>: Box, adjustable position. +<li><a accesskey="5" href="#g_t_005cparbox">\parbox</a>: Box with text in paragraph mode. +<li><a accesskey="6" href="#g_t_005craisebox">\raisebox</a>: Raise or lower text. +<li><a accesskey="7" href="#g_t_005csavebox">\savebox</a>: Like \makebox, but save the text for later use. +<li><a accesskey="8" href="#g_t_005csbox">\sbox</a>: Like \mbox, but save the text for later use. +<li><a accesskey="9" href="#g_t_005cusebox">\usebox</a>: Print saved text. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cmbox"></a> +<a name="g_t_005cmbox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.1 <code>\mbox{</code><var>text}</var></h3> + +<p><a name="index-g_t_005cmbox-891"></a> +<a name="index-hyphenation_002c-preventing-892"></a>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. + +<div class="node"> +<p><hr> +<a name="%5cfbox-and-%5cframebox"></a> +<a name="g_t_005cfbox-and-_005cframebox"></a> +Next: <a rel="next" accesskey="n" href="#lrbox">lrbox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cmbox">\mbox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.2 <code>\fbox</code> and <code>\framebox</code></h3> + +<p><a name="index-g_t_005cfbox-893"></a><a name="index-g_t_005cframebox-894"></a> +Synopses: + +<pre class="example"> \fbox{<var>text</var>} + \framebox[<var>width</var>][<var>position</var>]{<var>text</var>} +</pre> + <p>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. + + <p>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 --> + + <p><a name="index-g_t_005cfboxrule-895"></a><a name="index-g_t_005cfboxsep-896"></a>Both commands produce a rule of thickness <code>\fboxrule</code> (default +‘<samp><span class="samp">.4pt</span></samp>’), and leave a space of <code>\fboxsep</code> (default +‘<samp><span class="samp">3pt</span></samp>’) between the rule and the contents of the box. + + <p>See <a href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a>, for the <code>\framebox</code> command in the +<code>picture</code> environment. + +<div class="node"> +<p><hr> +<a name="lrbox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cmakebox">\makebox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.3 <code>lrbox</code></h3> + +<p><a name="index-lrbox-897"></a> +<code>\begin{lrbox}{cmd} text \end{lrbox}</code> + + <p>This is the environment form of <code>\sbox</code>. + + <p>The text inside the environment is saved in the box <code>cmd</code>, which +must have been declared with <code>\newsavebox</code>. + +<div class="node"> +<p><hr> +<a name="%5cmakebox"></a> +<a name="g_t_005cmakebox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cparbox">\parbox</a>, +Previous: <a rel="previous" accesskey="p" href="#lrbox">lrbox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.4 <code>\makebox</code></h3> + +<p><a name="index-g_t_005cmakebox-898"></a> +Synopsis: + +<pre class="example"> \makebox[<var>width</var>][<var>position</var>]{<var>text</var>} +</pre> + <p>The <code>\makebox</code> command creates a box just wide enough to contain +the <var>text</var> specified. The width of the box is specified by the +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: + + <dl> +<dt><code>c</code><dd>Centered (default). +<br><dt><code>l</code><dd>Flush left. +<br><dt><code>r</code><dd>Flush right. +<br><dt><code>s</code><dd>Stretch (justify) across entire <var>width</var>; <var>text</var> must contain +stretchable space for this to work. +</dl> + + <p><code>\makebox</code> is also used within the picture environment +see <a href="#g_t_005cmakebox-_0028picture_0029">\makebox (picture)</a>. + +<div class="node"> +<p><hr> +<a name="%5cparbox"></a> +<a name="g_t_005cparbox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005craisebox">\raisebox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cmakebox">\makebox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.5 <code>\parbox</code></h3> + +<p><a name="index-g_t_005cparbox-899"></a> +Synopsis: + +<pre class="example"> \parbox[<var>position</var>][<var>height</var>][<var>inner-pos</var>]{<var>width</var>}{<var>text</var>} +</pre> + <p>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 <a href="#minipage">minipage</a>). + + <p><code>\parbox</code> has two mandatory arguments: + + <dl> +<dt><var>width</var><dd>the width of the parbox; +<br><dt><var>text</var><dd>the text that goes inside the parbox. +</dl> + + <p>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). + + <p>The optional <var>height</var> argument overrides the natural height of the box. + + <p>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. + + <dl> +<dt><code>t</code><dd>text is placed at the top of the box. +<br><dt><code>c</code><dd>text is centered in the box. +<br><dt><code>b</code><dd>text is placed at the bottom of the box. +<br><dt><code>s</code><dd>stretch vertically; the text must contain vertically stretchable space +for this to work. +</dl> + +<div class="node"> +<p><hr> +<a name="%5craisebox"></a> +<a name="g_t_005craisebox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csavebox">\savebox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cparbox">\parbox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.6 <code>\raisebox</code></h3> + +<p><a name="index-g_t_005craisebox-900"></a> +Synopsis: + +<pre class="example"> \raisebox{distance}[<var>height</var>][<var>depth</var>]{text} +</pre> + <p>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. + + <p>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. + +<div class="node"> +<p><hr> +<a name="%5csavebox"></a> +<a name="g_t_005csavebox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csbox">\sbox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005craisebox">\raisebox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.7 <code>\savebox</code></h3> + +<p><a name="index-g_t_005csavebox-901"></a> +Synopsis: + +<pre class="example"> \savebox{<var>\boxcmd</var>}[<var>width</var>][<var>pos</var>]{<var>text</var>} +</pre> + <p>This command typeset <var>text</var> in a box just as with <code>\makebox</code> +(see <a href="#g_t_005cmakebox">\makebox</a>), 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 <a href="#g_t_005cnewsavebox">\newsavebox</a>). + +<div class="node"> +<p><hr> +<a name="%5csbox"></a> +<a name="g_t_005csbox"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cusebox">\usebox</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005csavebox">\savebox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.8 <code>\sbox{</code><var>\boxcmd</var><code>}{</code><var>text</var><code>}</code></h3> + +<p><a name="index-g_t_005csbox-902"></a> +Synopsis: + +<pre class="example"> \sbox{<var>\boxcmd</var>}{<var>text</var>} +</pre> + <p><code>\sbox</code> types <var>text</var> in a box just as with <code>\mbox</code> +(see <a href="#g_t_005cmbox">\mbox</a>) 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 <a href="#g_t_005cnewsavebox">\newsavebox</a>). + +<div class="node"> +<p><hr> +<a name="%5cusebox"></a> +<a name="g_t_005cusebox"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005csbox">\sbox</a>, +Up: <a rel="up" accesskey="u" href="#Boxes">Boxes</a> + +</div> + +<h3 class="section">20.9 <code>\usebox{</code><var>\boxcmd</var></h3> + +<p><a name="index-g_t_005cusebox-903"></a> +Synopsis: + +<pre class="example"> \usebox{<var>\boxcmd</var>} +</pre> + <p><code>\usebox</code> producesthe box most recently saved in the bin +<var>\boxcmd</var> by a <code>\savebox</code> command (see <a href="#g_t_005csavebox">\savebox</a>). + +<div class="node"> +<p><hr> +<a name="Special-insertions"></a> +Next: <a rel="next" accesskey="n" href="#Splitting-the-input">Splitting the input</a>, +Previous: <a rel="previous" accesskey="p" href="#Boxes">Boxes</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">21 Special insertions</h2> + +<p>LaTeX provides commands for inserting characters that have a +special meaning do not correspond to simple characters you can type. + +<ul class="menu"> +<li><a accesskey="1" href="#Reserved-characters">Reserved characters</a>: Inserting # $ % & ~ _ ^ \ { } +<li><a accesskey="2" href="#Text-symbols">Text symbols</a>: Inserting other non-letter symbols in text. +<li><a accesskey="3" href="#Accents">Accents</a>: Inserting accents. +<li><a accesskey="4" href="#Non_002dEnglish-characters">Non-English characters</a>: Inserting other non-English characters. +<li><a accesskey="5" href="#g_t_005crule">\rule</a>: Inserting lines and rectangles. +<li><a accesskey="6" href="#g_t_005ctoday">\today</a>: Inserting today's date. +</ul> + +<div class="node"> +<p><hr> +<a name="Reserved-characters"></a> +Next: <a rel="next" accesskey="n" href="#Text-symbols">Text symbols</a>, +Up: <a rel="up" accesskey="u" href="#Special-insertions">Special insertions</a> + +</div> + +<h3 class="section">21.1 Reserved characters</h3> + +<p><a name="index-reserved-characters-904"></a><a name="index-characters_002c-reserved-905"></a> +The following characters play a special role in LaTeX and are called +“reserved characters” or “special characters”. + +<pre class="example"> # $ % & ~ _ ^ \ { } +</pre> + <p><a name="index-g_t_005c_0023-906"></a><a name="index-g_t_005c_0024-907"></a><a name="index-g_t_005c_0025-908"></a><a name="index-g_t_005c_0026-909"></a><a name="index-g_t_005c_005f-910"></a><a name="index-g_t_005c_0040_007b-911"></a><a name="index-g_t_005c_0040_007d-912"></a>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. + + <p><a name="index-g_t_005cbackslash-913"></a>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><span class="samp">\</span></samp>’ in a verbatim command (see <a href="#verbatim">verbatim</a>). + + <p><a name="index-g_t_005c_007e-914"></a><a name="index-g_t_005c_005e-915"></a>Also, <code>\~</code> and <code>\^</code> place tilde and circumflex accents over +the following letter, as in õ and ô (see <a href="#Accents">Accents</a>); to get +a standalone <code>~</code> or <code>^</code>, you can again use a verbatim +command. + + <p><a name="index-g_t_005csymbol-916"></a><a name="index-accessing-any-character-of-a-font-917"></a> +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>. + + <p>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>. + +<div class="node"> +<p><hr> +<a name="Text-symbols"></a> +Next: <a rel="next" accesskey="n" href="#Accents">Accents</a>, +Previous: <a rel="previous" accesskey="p" href="#Reserved-characters">Reserved characters</a>, +Up: <a rel="up" accesskey="u" href="#Special-insertions">Special insertions</a> + +</div> + +<h3 class="section">21.2 Text symbols</h3> + +<p><a name="index-text-symbols-918"></a>LaTeX provides commands to generate a number of non-letter symbols +in running text. + + <dl> +<dt><code>\copyright</code><a name="index-g_t_005ccopyright-919"></a><dd><a name="index-copyright-symbol-920"></a>The copyright symbol, ©. + + <br><dt><code>\dag</code><a name="index-g_t_005cdag-921"></a><dd><a name="index-dagger_002c-in-text-922"></a>The dagger symbol (in text). + + <br><dt><code>\ddag</code><a name="index-g_t_005cddag-923"></a><dd><a name="index-double-dagger_002c-in-text-924"></a>The double dagger symbol (in text). + + <br><dt><code>\LaTeX</code><a name="index-g_t_005cLaTeX-925"></a><dd><a name="index-g_t_0040LaTeX_007b_007d-logo-926"></a><a name="index-logo_002c-_0040LaTeX_007b_007d-927"></a>The LaTeX logo. + + <br><dt><code>\ldots</code><a name="index-g_t_005cldots-928"></a><dd><a name="index-ellipsis-929"></a>An ellipsis (three dots at the baseline): `<small class="dots">...</small>'. This +command also works in math mode. + + <br><dt><code>\lq</code><a name="index-g_t_005clq-930"></a><dd><a name="index-left-quote-931"></a><a name="index-opening-quote-932"></a>Left (opening) quote: `. + + <br><dt><code>\P</code><a name="index-g_t_005cP-933"></a><dd><a name="index-paragraph-sign-934"></a><a name="index-pilcrow-935"></a>Paragraph sign (pilcrow). + + <br><dt><code>\pounds</code><a name="index-g_t_005cpounds-936"></a><dd><a name="index-pounds-symbol-937"></a><a name="index-sterling-symbol-938"></a>English pounds sterling. + + <br><dt><code>\rq</code><a name="index-g_t_005crq-939"></a><dd><a name="index-right-quote-940"></a><a name="index-closing-quote-941"></a>Right (closing) quote: '. + + <br><dt><code>\S</code><a name="index-g_t_005cS-942"></a><dd><a name="index-section-symbol-943"></a>Section symbol. + + <br><dt><code>\TeX</code><a name="index-g_t_005cTeX-944"></a><dd><a name="index-g_t_0040TeX_007b_007d-logo-945"></a><a name="index-logo_002c-_0040TeX_007b_007d-946"></a>The TeX logo. + + </dl> + +<div class="node"> +<p><hr> +<a name="Accents"></a> +Next: <a rel="next" accesskey="n" href="#Non_002dEnglish-characters">Non-English characters</a>, +Previous: <a rel="previous" accesskey="p" href="#Text-symbols">Text symbols</a>, +Up: <a rel="up" accesskey="u" href="#Special-insertions">Special insertions</a> + +</div> + +<h3 class="section">21.3 Accents</h3> + +<p><a name="index-accents-947"></a><a name="index-characters_002c-accented-948"></a><a name="index-letters_002c-accented-949"></a> +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. + + <dl> +<dt><code>\"</code><dd><a name="index-g_t_005c_0022-_0040r_007b_0028umlaut-accent_0029_007d-950"></a><a name="index-umlaut-accent-951"></a>Produces an umlaut, as in ö. + + <br><dt><code>\'</code><dd><a name="index-g_t_005c_0027-_0040r_007b_0028acute-accent_0029_007d-952"></a><a name="index-acute-accent-953"></a>Produces an acute accent, as in ó. In the <code>tabbing</code> +environment, pushes current column to the right of the previous column +(see <a href="#tabbing">tabbing</a>). + + <br><dt><code>\.</code><dd><a name="index-g_t_005c_002e-_0040r_007b_0028dot_002dover-accent_0029_007d-954"></a><a name="index-dot-accent-955"></a><a name="index-dot_002dover-accent-956"></a>Produces a dot accent over the following, as in o.. + + <br><dt><code>\=</code><dd><a name="index-g_t_005c_003d-_0040r_007b_0028macron-accent_0029_007d-957"></a><a name="index-macron-accent-958"></a><a name="index-overbar-accent-959"></a><a name="index-bar_002dover-accent-960"></a>Produces a macron (overbar) accent over the following, as in o¯. + + <br><dt><code>\^</code><dd><a name="index-g_t_005c_005e-_0040r_007b_0028circumflex-accent_0029_007d-961"></a><a name="index-circumflex-accent-962"></a><a name="index-hat-accent-963"></a>Produces a circumflex (hat) accent over the following, as in ô. + + <br><dt><code>\`</code><dd><a name="index-g_t_005c_0060-_0040r_007b_0028grave-accent_0029_007d-964"></a><a name="index-grave-accent-965"></a>Produces a grave accent over the following, as in ò. In the +<code>tabbing</code> environment, move following text to the right margin +(see <a href="#tabbing">tabbing</a>). + + <br><dt><code>\~</code><dd><a name="index-g_t_005c_007e-_0040r_007b_0028tilde-accent_0029_007d-966"></a><a name="index-tilde-accent-967"></a>Produces a tilde accent over the following, as in ñ. + + <br><dt><code>\b</code><dd><a name="index-g_t_005cb-_0040r_007b_0028bar_002dunder-accent_0029_007d-968"></a><a name="index-bar_002dunder-accent-969"></a>Produces a bar accent under the following, as in o_. + + <br><dt><code>\bar</code><dd><a name="index-g_t_005cbar-_0040r_007b_0028macron_002c-bar_002dover-accent_0029_007d-970"></a><a name="index-bar_002dover-accent-971"></a><a name="index-macron-accent-972"></a>Produces a macron accent over the following, as in o¯. + + <br><dt><code>\c</code><dd><a name="index-g_t_005cc-_0040r_007b_0028cedilla-accent_0029_007d-973"></a><a name="index-cedilla-accent-974"></a>Produces a cedilla accent under the following, as in <!-- {c}. --> + + <br><dt><code>\d</code><dd><a name="index-g_t_005cd-_0040r_007b_0028dot_002dunder-accent_0029_007d-975"></a><a name="index-dot_002dunder-accent-976"></a>Produces a dot accent under the following, as in .o. + + <br><dt><code>\H</code><dd><a name="index-g_t_005cH-_0040r_007b_0028Hungarian-umlaut-accent_0029_007d-977"></a><a name="index-hungarian-umlaut-accent-978"></a>Produces a long Hungarian umlaut accent over the following, as in o''. + + <br><dt><code>\i</code><dd><a name="index-g_t_005ci-_0040r_007b_0028dotless-i_0029_007d-979"></a><a name="index-dotless-i-980"></a>Produces a dotless i, as in `i'. + + <br><dt><code>\j</code><dd><a name="index-g_t_005cj-_0040r_007b_0028dotless-j_0029_007d-981"></a><a name="index-dotless-j-982"></a>Produces a dotless j, as in `j'. + + <br><dt><code>\t</code><dd><a name="index-g_t_005ct-_0040r_007b_0028tie_002dafter-accent_0029_007d-983"></a><a name="index-tie_002dafter-accent-984"></a>Produces a tie-after accent, as in `oo['. + + <br><dt><code>\u</code><dd><a name="index-g_t_005cu-_0040r_007b_0028breve-accent_0029_007d-985"></a><a name="index-breve-accent-986"></a>Produces a breve accent, as in `o('. + + <br><dt><code>\v</code><dd><a name="index-g_t_005cv-_0040r_007b_0028breve-accent_0029_007d-987"></a><a name="index-hacek-accent-988"></a><a name="index-check-accent-989"></a>Produces a hác<ek (check) accent, as in `o<'. + + </dl> + +<div class="node"> +<p><hr> +<a name="Non-English-characters"></a> +<a name="Non_002dEnglish-characters"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005crule">\rule</a>, +Previous: <a rel="previous" accesskey="p" href="#Accents">Accents</a>, +Up: <a rel="up" accesskey="u" href="#Special-insertions">Special insertions</a> + +</div> + +<h3 class="section">21.4 Non-English characters</h3> + +<p><a name="index-special-characters-990"></a><a name="index-non_002dEnglish-characters-991"></a><a name="index-characters_002c-non_002dEnglish-992"></a><a name="index-letters_002c-non_002dEnglish-993"></a> +Here are the basic LaTeX commands for inserting characters commonly +used in languages other than English. + + <dl> +<dt><code>\aa</code><dt><code>\AA</code><dd><a name="index-g_t_005caa-_0028_0040aa_007b_007d_0029-994"></a><a name="index-g_t_005cAA-_0028_0040AA_007b_007d_0029-995"></a><a name="index-aring-996"></a>å and Å. + + <br><dt><code>\ae</code><dt><code>\AE</code><dd><a name="index-g_t_005cae-_0028_0040ae_007b_007d_0029-997"></a><a name="index-g_t_005cAE-_0028_0040AE_007b_007d_0029-998"></a><a name="index-ae-ligature-999"></a>æ and Æ. + + <br><dt><code>\l</code><dt><code>\L</code><dd><a name="index-g_t_005cl-_0028_0040l_007b_007d_0029-1000"></a><a name="index-g_t_005cL-_0028_0040L_007b_007d_0029-1001"></a><a name="index-polish-l-1002"></a>/l and /L. + + <br><dt><code>\o</code><dt><code>\O</code><dd><a name="index-g_t_005co-_0028_0040o_007b_007d_0029-1003"></a><a name="index-g_t_005cO-_0028_0040O_007b_007d_0029-1004"></a><a name="index-oslash-1005"></a>ø and Ø. + + <br><dt><code>\oe</code><dt><code>\OE</code><dd><a name="index-g_t_005coe-_0028_0040oe_007b_007d_0029-1006"></a><a name="index-g_t_005cOE-_0028_0040OE_007b_007d_0029-1007"></a><a name="index-oe-ligature-1008"></a>œ and Œ. + + <br><dt><code>\ss</code><dd><a name="index-g_t_005css-_0028_0040ss_007b_007d_0029-1009"></a><a name="index-es_002dzet-German-letter-1010"></a><a name="index-sharp-S-letters-1011"></a>ß. + + </dl> + +<div class="node"> +<p><hr> +<a name="%5crule"></a> +<a name="g_t_005crule"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005ctoday">\today</a>, +Previous: <a rel="previous" accesskey="p" href="#Non_002dEnglish-characters">Non-English characters</a>, +Up: <a rel="up" accesskey="u" href="#Special-insertions">Special insertions</a> + +</div> + +<h3 class="section">21.5 <code>\rule</code></h3> + +<p><a name="index-g_t_005crule-1012"></a> +Synopsis: + +<pre class="example"> \rule[<var>raise</var>]{<var>width</var>}{<var>thickness</var>} +</pre> + <p>The <code>\rule</code> command produces <dfn>rules</dfn>, that is, lines or +rectangles. The arguments are: + + <dl> +<dt><var>raise</var><dd>How high to raise the rule (optional). + + <br><dt><var>width</var><dd>The length of the rule (mandatory). + + <br><dt><var>thickness</var><dd>The thickness of the rule (mandatory). +</dl> + +<div class="node"> +<p><hr> +<a name="%5ctoday"></a> +<a name="g_t_005ctoday"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005crule">\rule</a>, +Up: <a rel="up" accesskey="u" href="#Special-insertions">Special insertions</a> + +</div> + +<h3 class="section">21.6 <code>\today</code></h3> + +<p><a name="index-g_t_005ctoday-1013"></a> +The <code>\today</code> command produces today's date, in the format +‘<samp><var>month</var> <var>dd</var><span class="samp">, </span><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 <a href="#g_t_005cday-_005cmonth-_005cyear">\day \month \year</a>) to do this. It is not +updated as the program runs. + + <p><a name="index-g_t_0040code_007bdatetime_007d-package-1014"></a>The <code>datetime</code> package, among others, can produce a wide variety +of other date formats. + +<div class="node"> +<p><hr> +<a name="Splitting-the-input"></a> +Next: <a rel="next" accesskey="n" href="#Front_002fback-matter">Front/back matter</a>, +Previous: <a rel="previous" accesskey="p" href="#Special-insertions">Special insertions</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">22 Splitting the input</h2> + +<p><a name="index-splitting-the-input-file-1015"></a><a name="index-input-file-1016"></a> +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. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005cinclude">\include</a>: Conditionally include a file. +<li><a accesskey="2" href="#g_t_005cincludeonly">\includeonly</a>: Determine which files are included. +<li><a accesskey="3" href="#g_t_005cinput">\input</a>: Unconditionally include a file. +</ul> + +<div class="node"> +<p><hr> +<a name="%5cinclude"></a> +<a name="g_t_005cinclude"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cincludeonly">\includeonly</a>, +Up: <a rel="up" accesskey="u" href="#Splitting-the-input">Splitting the input</a> + +</div> + +<h3 class="section">22.1 <code>\include</code></h3> + +<p><a name="index-g_t_005cinclude-1017"></a> +Synopsis: + +<pre class="example"> \include{<var>file</var>} +</pre> + <p>If no <code>\includeonly</code> command is present, the <code>\include</code> +command executes <code>\clearpage</code> to start a new page +(see <a href="#g_t_005cclearpage">\clearpage</a>), then reads <var>file</var>, then does another +<code>\clearpage</code>. + + <p>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. + + <p><a name="index-nested-_0040code_007b_005cinclude_007d_002c-not-allowed-1018"></a>The <code>\include</code> command may not appear in the preamble or in a file +read by another <code>\include</code> command. + +<div class="node"> +<p><hr> +<a name="%5cincludeonly"></a> +<a name="g_t_005cincludeonly"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cinput">\input</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cinclude">\include</a>, +Up: <a rel="up" accesskey="u" href="#Splitting-the-input">Splitting the input</a> + +</div> + +<h3 class="section">22.2 \<code>includeonly</code></h3> + +<p><a name="index-g_t_005cincludeonly-1019"></a> +Synopsis: + +<pre class="example"> \includeonly{<var>file1</var>,<var>file2</var>,...} +</pre> + <p>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. + + <p>This command can only appear in the preamble. + +<div class="node"> +<p><hr> +<a name="%5cinput"></a> +<a name="g_t_005cinput"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cincludeonly">\includeonly</a>, +Up: <a rel="up" accesskey="u" href="#Splitting-the-input">Splitting the input</a> + +</div> + +<h3 class="section">22.3 \input</h3> + +<p><a name="index-g_t_005cinput-1020"></a> +Synopsis: + +<pre class="example"> \input{<var>file</var>} +</pre> + <p>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. + + <p>If <var>file</var> does not end in ‘<samp><span class="samp">.tex</span></samp>’ (e.g., ‘<samp><span class="samp">foo</span></samp>’ or +‘<samp><span class="samp">foo.bar</span></samp>’), it is first tried with that extension (‘<samp><span class="samp">foo.tex</span></samp>’ +or ‘<samp><span class="samp">foo.bar.tex</span></samp>’). If that is not found, the original <var>file</var> +is tried (‘<samp><span class="samp">foo</span></samp>’ or ‘<samp><span class="samp">foo.bar</span></samp>’). + +<div class="node"> +<p><hr> +<a name="Front%2fback-matter"></a> +<a name="Front_002fback-matter"></a> +Next: <a rel="next" accesskey="n" href="#Letters">Letters</a>, +Previous: <a rel="previous" accesskey="p" href="#Splitting-the-input">Splitting the input</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">23 Front/back matter</h2> + +<ul class="menu"> +<li><a accesskey="1" href="#Tables-of-contents">Tables of contents</a> +<li><a accesskey="2" href="#Glossaries">Glossaries</a> +<li><a accesskey="3" href="#Indexes">Indexes</a> +</ul> + +<div class="node"> +<p><hr> +<a name="Tables-of-contents"></a> +Next: <a rel="next" accesskey="n" href="#Glossaries">Glossaries</a>, +Up: <a rel="up" accesskey="u" href="#Front_002fback-matter">Front/back matter</a> + +</div> + +<h3 class="section">23.1 Tables of contents</h3> + +<p><a name="index-table-of-contents_002c-creating-1021"></a> +<a name="index-g_t_005ctableofcontents-1022"></a>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 <samp><span class="file">.toc</span></samp> file. + + <p>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. + + <p><a name="index-g_t_005clistoffigures-1023"></a><a name="index-g_t_005clistoftables-1024"></a>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. + + <p><a name="index-g_t_005cnofiles-1025"></a>The command <code>\nofiles</code> overrides these commands, and +<em>prevents</em> any of these lists from being generated. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005caddcontentsline">\addcontentsline</a>: Add an entry to table of contents etc. +<li><a accesskey="2" href="#g_t_005caddtocontents">\addtocontents</a>: Add text directly to table of contents file etc. +</ul> + +<div class="node"> +<p><hr> +<a name="%5caddcontentsline"></a> +<a name="g_t_005caddcontentsline"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005caddtocontents">\addtocontents</a>, +Up: <a rel="up" accesskey="u" href="#Tables-of-contents">Tables of contents</a> + +</div> + +<h4 class="subsection">23.1.1 \addcontentsline</h4> + +<p><a name="index-g_t_005caddcontentsline_0040_007b_0040var_007bext_007d_0040_007d_0040_007b_0040var_007bunit_007d_0040_007d_0040_007b_0040var_007btext_007d_0040_007d-1026"></a><a name="index-table-of-contents-entry_002c-manually-adding-1027"></a> +The <code>\addcontentsline</code> command adds an entry to the specified list +or table where: + + <dl> +<dt><var>ext</var><dd>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). + + <br><dt><var>unit</var><dd>The name of the sectional unit being added, typically one of the +following, matching the value of the <var>ext</var> argument: + + <dl> +<dt><code>toc</code><dd>The name of the sectional unit: <code>part</code>, <code>chapter</code>, +<code>section</code>, <code>subsection</code>, <code>subsubsection</code>. +<br><dt><code>lof</code><dd>For the list of figures. +<br><dt><code>lot</code><dd>For the list of tables. +</dl> + + <br><dt><var>entry</var><dd>The actual text of the entry. +</dl> + + <p><a name="index-g_t_005ccontentsline-1028"></a>What is written to the <samp><span class="file">.</span><var>ext</var></samp> file is the +command <code>\contentsline{</code><var>unit</var><code>}{</code><var>name</var><code>}</code>. + +<!-- ?? how hardwired are these values? other unit names? --> +<div class="node"> +<p><hr> +<a name="%5caddtocontents"></a> +<a name="g_t_005caddtocontents"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005caddcontentsline">\addcontentsline</a>, +Up: <a rel="up" accesskey="u" href="#Tables-of-contents">Tables of contents</a> + +</div> + +<h4 class="subsection">23.1.2 \addtocontents</h4> + +<p><a name="index-g_t_005caddtocontents_0040_007b_0040var_007bext_007d_0040_007d_0040_007b_0040var_007btext_007d_0040_007d-1029"></a> +The <code>\addtocontents</code> command adds text (or formatting commands) +directly to the <samp><span class="file">.</span></samp><var>ext</var> file that generates the table of +contents or lists of figures or tables. + + <dl> +<dt><var>ext</var><dd>The extension of the file on which information is to be written: +<samp><span class="file">toc</span></samp> (table of contents), <samp><span class="file">lof</span></samp> (list of figures), or +<samp><span class="file">lot</span></samp> (list of tables). + + <br><dt><var>text</var><dd>The text to be written. +</dl> + +<div class="node"> +<p><hr> +<a name="Glossaries"></a> +Next: <a rel="next" accesskey="n" href="#Indexes">Indexes</a>, +Previous: <a rel="previous" accesskey="p" href="#Tables-of-contents">Tables of contents</a>, +Up: <a rel="up" accesskey="u" href="#Front_002fback-matter">Front/back matter</a> + +</div> + +<h3 class="section">23.2 Glossaries</h3> + +<p><a name="index-glossaries-1030"></a> +<a name="index-g_t_005cmakeglossary-1031"></a>The command <code>\makeglossary</code> enables creating glossaries. + + <p><a name="index-g_t_005cglossary-1032"></a><a name="index-g_t_0040file_007b_002eglo_007d-file-1033"></a>The command <code>\glossary{</code><var>text</var><code>}</code> writes a glossary entry for +<var>text</var> to an auxiliary file with the <samp><span class="file">.glo</span></samp> extension. + + <p><a name="index-g_t_005cglossaryentry-1034"></a>Specifically, what gets written is the command +<code>\glossaryentry{</code><var>text</var><code>}{</code><var>pageno</var><code>}</code>, where +<var>pageno</var> is the current <code>\thepage</code> value. + + <p>The <code>glossary</code> package on CTAN provides support for fancier +glossaries. + +<div class="node"> +<p><hr> +<a name="Indexes"></a> +Previous: <a rel="previous" accesskey="p" href="#Glossaries">Glossaries</a>, +Up: <a rel="up" accesskey="u" href="#Front_002fback-matter">Front/back matter</a> + +</div> + +<h3 class="section">23.3 Indexes</h3> + +<p><a name="index-indexes-1035"></a> +<a name="index-g_t_005cmakeindex-1036"></a>The command <code>\makeindex</code> enables creating indexes. + + <p><a name="index-g_t_005cindex-1037"></a><a name="index-g_t_0040file_007b_002eidx_007d-file-1038"></a>The command <code>\index{</code><var>text</var><code>}</code> writes a glossary entry for +<var>text</var> to an auxiliary file with the <samp><span class="file">.idx</span></samp> extension. + + <p><a name="index-g_t_005cindexentry-1039"></a>Specifically, what gets written is the command +<code>\indexentry{</code><var>text</var><code>}{</code><var>pageno</var><code>}</code>, where <var>pageno</var> +is the current <code>\thepage</code> value. + + <p>The rubber length <code>\indexspace</code> is inserted before each new +letter in the index; its default value is ‘<samp><span class="samp">10pt plus5pt +minus3pt</span></samp>’. + + <p><a name="index-g_t_0040command_007bmakeindex_007d-program-1040"></a><a name="index-g_t_0040command_007bxindy_007d-program-1041"></a><a name="index-g_t_0040file_007b_002eind_007d-file-1042"></a> +The <samp><span class="file">.idx</span></samp> file can then be sorted with an external command, +typically <samp><span class="command">makeindex</span></samp> or <samp><span class="command">xindy</span></samp>, resulting in a +<samp><span class="file">.ind</span></samp> file, which can then be used to typeset the index. + +<div class="node"> +<p><hr> +<a name="Letters"></a> +Next: <a rel="next" accesskey="n" href="#Terminal-Input_002fOutput">Terminal Input/Output</a>, +Previous: <a rel="previous" accesskey="p" href="#Front_002fback-matter">Front/back matter</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">24 Letters</h2> + +<p><a name="index-letters-1043"></a><a name="index-creating-letters-1044"></a> +You can use LaTeX to typeset letters, both personal and business. The +<code>letter</code> document class is designed to make a number of letters at +once, although you can make just one if you so desire. + + <p>Your <samp><span class="file">.tex</span></samp> source file has the same minimum commands as the other +document classes, i.e., you must have the following commands as a +minimum: + +<pre class="example"> \documentclass{letter} + \begin{document} + ... letters ... + \end{document} +</pre> + <p>Each letter is a <code>letter</code> environment, whose argument is the name +and address of the recipient. For example, you might have: + +<pre class="example"> \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. + \\ Edinburgh, EH1 1AA} + ... + \end{letter} +</pre> + <p>The letter itself begins with the <code>\opening</code> command. The text of +the letter follows. It is typed as ordinary LaTeX input. Commands that +make no sense in a letter, like <code>\chapter</code>, do not work. The letter +closes with a <code>\closing</code> command. + + <p><a name="index-g_t_005c_005c-_0040r_007bfor-letters_007d-1045"></a>After the <code>closing</code>, you can have additional material. The +<code>\cc</code> command produces the usual “cc: <small class="dots">...</small>”. There's also a +similar <code>\encl</code> command for a list of enclosures. With both these +commands, use <code>\\</code> to separate the items. + + <p>These commands are used with the <code>letter</code> class. + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005caddress">\address</a>: Your return address. +<li><a accesskey="2" href="#g_t_005ccc">\cc</a>: Cc list. +<li><a accesskey="3" href="#g_t_005cclosing">\closing</a>: Saying goodbye. +<li><a accesskey="4" href="#g_t_005cencl">\encl</a>: List of enclosed material. +<li><a accesskey="5" href="#g_t_005clocation">\location</a>: Your organisation's address. +<li><a accesskey="6" href="#g_t_005cmakelabels">\makelabels</a>: Making address labels. +<li><a accesskey="7" href="#g_t_005cname">\name</a>: Your name, for the return address. +<li><a accesskey="8" href="#g_t_005copening">\opening</a>: Saying hello. +<li><a accesskey="9" href="#g_t_005cps">\ps</a>: Adding a postscript. +<li><a href="#g_t_005csignature">\signature</a>: Your signature. +<li><a href="#g_t_005cstartbreaks">\startbreaks</a>: Allow page breaks. +<li><a href="#g_t_005cstopbreaks">\stopbreaks</a>: Disallow page breaks. +<li><a href="#g_t_005ctelephone">\telephone</a>: Your phone number. +</ul> + +<div class="node"> +<p><hr> +<a name="%5caddress"></a> +<a name="g_t_005caddress"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005ccc">\cc</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.1 \address{<var>return-address}</var></h3> + +<p><a name="index-g_t_005caddress-1046"></a> +The <code>\address</code> specifies the return address of a letter, as it +should appear on the letter and the envelope. Separate lines of the +address should be separated by <code>\\</code> commands. + + <p>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 <a href="#Overview">Overview</a>, for details on your local +implementation). If you give an <code>\address</code> declaration, then the +letter will be formatted as a personal letter. + +<div class="node"> +<p><hr> +<a name="%5ccc"></a> +<a name="g_t_005ccc"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cclosing">\closing</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005caddress">\address</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.2 <code>\cc</code></h3> + +<p><a name="index-g_t_005ccc-1047"></a><a name="index-cc-list_002c-in-letters-1048"></a> +Synopsis: + +<pre class="example"> \cc{<var>name1</var>\\<var>name2</var>} +</pre> + <p>Produce a list of <var>name</var>s the letter was copied to. Each name is +printed on a separate line. + +<div class="node"> +<p><hr> +<a name="%5cclosing"></a> +<a name="g_t_005cclosing"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cencl">\encl</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005ccc">\cc</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.3 <code>\closing</code></h3> + +<p><a name="index-g_t_005cclosing-1049"></a><a name="index-letters_002c-ending-1050"></a><a name="index-closing-letters-1051"></a> +Synopsis: + +<pre class="example"> \closing{text} +</pre> + <p>A letter closes with a <code>\closing</code> command, for example, +<pre class="example"> \closing{Best Regards,} +</pre> + <div class="node"> +<p><hr> +<a name="%5cencl"></a> +<a name="g_t_005cencl"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005clocation">\location</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cclosing">\closing</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.4 <code>\encl</code></h3> + +<p><a name="index-g_t_005cencl-1052"></a><a name="index-enclosure-list-1053"></a> +Synopsis: + +<pre class="example"> \encl{<var>line1</var>\\<var>line2</var>} +</pre> + <p>Declare a list of one more enclosures. + +<div class="node"> +<p><hr> +<a name="%5clocation"></a> +<a name="g_t_005clocation"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cmakelabels">\makelabels</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cencl">\encl</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.5 <code>\location</code></h3> + +<p><a name="index-g_t_005clocation-1054"></a> +<code>\location{address}</code> + + <p>This modifies your organisation's standard address. This only appears +if the <code>firstpage</code> pagestyle is selected. + +<div class="node"> +<p><hr> +<a name="%5cmakelabels"></a> +<a name="g_t_005cmakelabels"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cname">\name</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005clocation">\location</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.6 <code>\makelabels</code></h3> + +<p><a name="index-g_t_005cmakelabels-1055"></a> +<code>\makelabels{number}</code> + + <p>If you issue this command in the preamble, LaTeX will create a sheet of +address labels. This sheet will be output before the letters. + +<div class="node"> +<p><hr> +<a name="%5cname"></a> +<a name="g_t_005cname"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005copening">\opening</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cmakelabels">\makelabels</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.7 <code>\name</code></h3> + +<p><a name="index-g_t_005cname-1056"></a> +<code>\name{June Davenport}</code> + + <p>Your name, used for printing on the envelope together with the return +address. + +<div class="node"> +<p><hr> +<a name="%5copening"></a> +<a name="g_t_005copening"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cps">\ps</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cname">\name</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.8 <code>\opening{</code><var>text</var><code>}</code></h3> + +<p><a name="index-g_t_005copening-1057"></a><a name="index-letters_002c-starting-1058"></a> +Synopsis: + +<pre class="example"> \opening{<var>text</var>} +</pre> + <p>A letter begins with the <code>\opening</code> command. The mandatory +argument, <var>text</var>, is whatever text you wish to start your letter. +For instance: + +<pre class="example"> \opening{Dear Joe,} +</pre> + <div class="node"> +<p><hr> +<a name="%5cps"></a> +<a name="g_t_005cps"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005csignature">\signature</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005copening">\opening</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.9 <code>\ps</code></h3> + +<p><a name="index-g_t_005cps-1059"></a><a name="index-postscript_002c-in-letters-1060"></a> +Use the <code>\ps</code> command to start a postscript in a letter, after +<code>\closing</code>. + +<div class="node"> +<p><hr> +<a name="%5csignature"></a> +<a name="g_t_005csignature"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cstartbreaks">\startbreaks</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cps">\ps</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.10 <code>\signature{</code><var>text</var><code>}</code></h3> + +<p><a name="index-g_t_005csignature-1061"></a> +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. + +<div class="node"> +<p><hr> +<a name="%5cstartbreaks"></a> +<a name="g_t_005cstartbreaks"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005cstopbreaks">\stopbreaks</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005csignature">\signature</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.11 <code>\startbreaks</code></h3> + +<p><a name="index-g_t_005cstartbreaks-1062"></a> +<code>\startbreaks</code> + + <p>Used after a <code>\stopbreaks</code> command to allow page breaks again. + +<div class="node"> +<p><hr> +<a name="%5cstopbreaks"></a> +<a name="g_t_005cstopbreaks"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005ctelephone">\telephone</a>, +Previous: <a rel="previous" accesskey="p" href="#g_t_005cstartbreaks">\startbreaks</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.12 <code>\stopbreaks</code></h3> + +<p><a name="index-g_t_005cstopbreaks-1063"></a> +<code>\stopbreaks</code> + + <p>Inhibit page breaks until a <code>\startbreaks</code> command occurs. + +<div class="node"> +<p><hr> +<a name="%5ctelephone"></a> +<a name="g_t_005ctelephone"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005cstopbreaks">\stopbreaks</a>, +Up: <a rel="up" accesskey="u" href="#Letters">Letters</a> + +</div> + +<h3 class="section">24.13 <code>\telephone</code></h3> + +<p><a name="index-g_t_005ctelephone-1064"></a> +<code>\telephone{number}</code> + + <p>This is your telephone number. This only appears if the +<code>firstpage</code> pagestyle is selected. + +<div class="node"> +<p><hr> +<a name="Terminal-Input%2fOutput"></a> +<a name="Terminal-Input_002fOutput"></a> +Next: <a rel="next" accesskey="n" href="#Command-Line">Command Line</a>, +Previous: <a rel="previous" accesskey="p" href="#Letters">Letters</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">25 Terminal Input/Output</h2> + +<p><a name="index-input_002fOutput-1065"></a><a name="index-terminal-Input_002fOutput-1066"></a> + +<ul class="menu"> +<li><a accesskey="1" href="#g_t_005ctypein">\typein</a>: Read text from the terminal. +<li><a accesskey="2" href="#g_t_005ctypeout">\typeout</a>: Write text to the terminal. +</ul> + +<div class="node"> +<p><hr> +<a name="%5ctypein"></a> +<a name="g_t_005ctypein"></a> +Next: <a rel="next" accesskey="n" href="#g_t_005ctypeout">\typeout</a>, +Up: <a rel="up" accesskey="u" href="#Terminal-Input_002fOutput">Terminal Input/Output</a> + +</div> + +<h3 class="section">25.1 <code>\typein[</code><var>cmd</var><code>]{</code><var>msg</var><code>}</code></h3> + +<p><a name="index-g_t_005ctypein-1067"></a> +Synopsis: + +<pre class="example"> \typein[<var>\cmd</var>]{<var>msg</var>} +</pre> + <p><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. + +<div class="node"> +<p><hr> +<a name="%5ctypeout"></a> +<a name="g_t_005ctypeout"></a> +Previous: <a rel="previous" accesskey="p" href="#g_t_005ctypein">\typein</a>, +Up: <a rel="up" accesskey="u" href="#Terminal-Input_002fOutput">Terminal Input/Output</a> + +</div> + +<h3 class="section">25.2 <code>\typeout{</code><var>msg</var><code>}</code></h3> + +<p><a name="index-g_t_005ctypeout-1068"></a> +Synopsis: + +<pre class="example"> \typeout{<var>msg</var>} +</pre> + <p>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. + + <p>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. + +<div class="node"> +<p><hr> +<a name="Command-Line"></a> +Next: <a rel="next" accesskey="n" href="#Document-templates">Document templates</a>, +Previous: <a rel="previous" accesskey="p" href="#Terminal-Input_002fOutput">Terminal Input/Output</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="chapter">26 Command Line</h2> + +<p><a name="index-command-Line-1069"></a> +The input file specification indicates the file to be formatted; +TeX uses <samp><span class="file">.tex</span></samp> 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. + +<pre class="example"> latex '\nonstopmode\input foo.tex' +</pre> + <p class="noindent">will process <samp><span class="file">foo.tex</span></samp> without pausing after every error. + + <p><a name="index-g_t_0040samp_007b_002a_007d-prompt-1070"></a><a name="index-prompt_002c-_0040samp_007b_002a_007d-1071"></a><a name="index-g_t_005cstop-1072"></a>If LaTeX stops in the middle of the document and gives you a +‘<samp><span class="samp">*</span></samp>’ prompt, it is waiting for input. You can type <code>\stop</code> +(and return) and it will prematurely end the document. + +<div class="node"> +<p><hr> +<a name="Document-templates"></a> +Next: <a rel="next" accesskey="n" href="#Command-Index">Command Index</a>, +Previous: <a rel="previous" accesskey="p" href="#Command-Line">Command Line</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="appendix">Appendix A Document templates</h2> + +<p><a name="index-document-templates-1073"></a> +Although not reference material, perhaps these document templates will +be useful. + +<ul class="menu"> +<li><a accesskey="1" href="#book-template">book template</a> +<li><a accesskey="2" href="#beamer-template">beamer template</a> +<li><a accesskey="3" href="#tugboat-template">tugboat template</a> +</ul> + +<div class="node"> +<p><hr> +<a name="book-template"></a> +Next: <a rel="next" accesskey="n" href="#beamer-template">beamer template</a>, +Up: <a rel="up" accesskey="u" href="#Document-templates">Document templates</a> + +</div> + +<h3 class="section">A.1 <code>book</code> template</h3> + +<pre class="verbatim">\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} +</pre> + +<div class="node"> +<p><hr> +<a name="beamer-template"></a> +Next: <a rel="next" accesskey="n" href="#tugboat-template">tugboat template</a>, +Previous: <a rel="previous" accesskey="p" href="#book-template">book template</a>, +Up: <a rel="up" accesskey="u" href="#Document-templates">Document templates</a> + +</div> + +<h3 class="section">A.2 <code>beamer</code> template</h3> + +<p>The <code>beamer</code> class creates slides presentations. + +<pre class="verbatim">\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} + +</pre> + +<div class="node"> +<p><hr> +<a name="tugboat-template"></a> +Previous: <a rel="previous" accesskey="p" href="#beamer-template">beamer template</a>, +Up: <a rel="up" accesskey="u" href="#Document-templates">Document templates</a> + +</div> + +<h3 class="section">A.3 <code>tugboat</code> template</h3> + +<p><cite>TUGboat</cite> is the journal of the TeX Users Group, +<a href="http://tug.org/TUGboat">http://tug.org/TUGboat</a>. + +<pre class="verbatim">\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} +</pre> + +<div class="node"> +<p><hr> +<a name="Concept-Index"></a> +Previous: <a rel="previous" accesskey="p" href="#Command-Index">Command Index</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="unnumbered">Concept Index</h2> + +<ul class="index-cp" compact> +<li><a href="#index-g_t_0040samp_007b_002a_007d-prompt-1070">‘<samp><span class="samp">*</span></samp>’ prompt</a>: <a href="#Command-Line">Command Line</a></li> +<li><a href="#index-g_t_002a_002dform-of-sectioning-commands-171">*-form of sectioning commands</a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_0040file_007b_002eglo_007d-file-1033"><samp><span class="file">.glo</span></samp> file</a>: <a href="#Glossaries">Glossaries</a></li> +<li><a href="#index-g_t_0040file_007b_002eidx_007d-file-1038"><samp><span class="file">.idx</span></samp> file</a>: <a href="#Indexes">Indexes</a></li> +<li><a href="#index-g_t_0040file_007b_002eind_007d-file-1042"><samp><span class="file">.ind</span></samp> file</a>: <a href="#Indexes">Indexes</a></li> +<li><a href="#index-abstracts-189">abstracts</a>: <a href="#abstract">abstract</a></li> +<li><a href="#index-accents-947">accents</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-accents_002c-mathematical-782">accents, mathematical</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-accessing-any-character-of-a-font-917">accessing any character of a font</a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-acute-accent-953">acute accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-acute-accent_002c-math-784">acute accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-ae-ligature-999">ae ligature</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-aligning-Equations-222">aligning Equations</a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-alignment-via-tabbing-330">alignment via tabbing</a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-appendix_002c-creating-173">appendix, creating</a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-aring-996">aring</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-arrays_002c-math-191">arrays, math</a>: <a href="#array">array</a></li> +<li><a href="#index-author_002c-for-titlepage-847">author, for titlepage</a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-bar_002dover-accent-960">bar-over accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-bar_002dunder-accent-969">bar-under accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-bibliography_002c-creating-_0028automatically_0029-371">bibliography, creating (automatically)</a>: <a href="#Using-BibTeX">Using BibTeX</a></li> +<li><a href="#index-bibliography_002c-creating-_0028manually_0029-365">bibliography, creating (manually)</a>: <a href="#thebibliography">thebibliography</a></li> +<li><a href="#index-bib_0040TeX_007b_007d_002c-using-370">bibTeX, using</a>: <a href="#Using-BibTeX">Using BibTeX</a></li> +<li><a href="#index-black-boxes_002c-omitting-38">black boxes, omitting</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-bold-font-87">bold font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-bold-typewriter_002c-avoiding-204">bold typewriter, avoiding</a>: <a href="#description">description</a></li> +<li><a href="#index-boxes-890">boxes</a>: <a href="#Boxes">Boxes</a></li> +<li><a href="#index-breaking-lines-460">breaking lines</a>: <a href="#Line-breaking">Line breaking</a></li> +<li><a href="#index-breaking-pages-479">breaking pages</a>: <a href="#Page-breaking">Page breaking</a></li> +<li><a href="#index-breve-accent-986">breve accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-breve-accent_002c-math-786">breve accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-bullet-symbol-560">bullet symbol</a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-bulleted-lists-262">bulleted lists</a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-calligraphic-letters-for-math-90">calligraphic letters for math</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-cc-list_002c-in-letters-1048">cc list, in letters</a>: <a href="#g_t_005ccc">\cc</a></li> +<li><a href="#index-cedilla-accent-974">cedilla accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-centering-text_002c-declaration-for-199">centering text, declaration for</a>: <a href="#g_t_005ccentering">\centering</a></li> +<li><a href="#index-centering-text_002c-environment-for-196">centering text, environment for</a>: <a href="#center">center</a></li> +<li><a href="#index-characters_002c-accented-948">characters, accented</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-characters_002c-non_002dEnglish-992">characters, non-English</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-characters_002c-reserved-905">characters, reserved</a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-check-accent-989">check accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-check-accent_002c-math-788">check accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-circumflex-accent-962">circumflex accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-circumflex-accent_002c-math-799">circumflex accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-class-options-19">class options</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-classes-of-documents-10">classes of documents</a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-closing-letters-1051">closing letters</a>: <a href="#g_t_005cclosing">\closing</a></li> +<li><a href="#index-closing-quote-941">closing quote</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-code_002c-typesetting-383">code, typesetting</a>: <a href="#verbatim">verbatim</a></li> +<li><a href="#index-command-Line-1069">command Line</a>: <a href="#Command-Line">Command Line</a></li> +<li><a href="#index-commands_002c-defining-new-ones-400">commands, defining new ones</a>: <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></li> +<li><a href="#index-computer-programs_002c-typesetting-384">computer programs, typesetting</a>: <a href="#verbatim">verbatim</a></li> +<li><a href="#index-copyright-symbol-920">copyright symbol</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-counters_002c-a-list-of-423">counters, a list of</a>: <a href="#Counters">Counters</a></li> +<li><a href="#index-counters_002c-defining-new-404">counters, defining new</a>: <a href="#g_t_005cnewcounter">\newcounter</a></li> +<li><a href="#index-counters_002c-getting-value-of-435">counters, getting value of</a>: <a href="#g_t_005cvalue">\value</a></li> +<li><a href="#index-counters_002c-setting-437">counters, setting</a>: <a href="#g_t_005csetcounter">\setcounter</a></li> +<li><a href="#index-creating-letters-1044">creating letters</a>: <a href="#Letters">Letters</a></li> +<li><a href="#index-creating-pictures-298">creating pictures</a>: <a href="#picture">picture</a></li> +<li><a href="#index-creating-tables-351">creating tables</a>: <a href="#table">table</a></li> +<li><a href="#index-credit-footnote-854">credit footnote</a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-cross-references-174">cross references</a>: <a href="#Cross-references">Cross references</a></li> +<li><a href="#index-cross-referencing-with-page-number-177">cross referencing with page number</a>: <a href="#g_t_005cpageref">\pageref</a></li> +<li><a href="#index-cross-referencing_002c-symbolic-180">cross referencing, symbolic</a>: <a href="#g_t_005cref">\ref</a></li> +<li><a href="#index-dagger_002c-in-text-922">dagger, in text</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-date_002c-for-titlepage-851">date, for titlepage</a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_0040code_007bdatetime_007d-package-1014"><code>datetime</code> package</a>: <a href="#g_t_005ctoday">\today</a></li> +<li><a href="#index-defining-a-new-command-401">defining a new command</a>: <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></li> +<li><a href="#index-defining-new-environments-411">defining new environments</a>: <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></li> +<li><a href="#index-defining-new-fonts-418">defining new fonts</a>: <a href="#g_t_005cnewfont">\newfont</a></li> +<li><a href="#index-defining-new-theorems-415">defining new theorems</a>: <a href="#g_t_005cnewtheorem">\newtheorem</a></li> +<li><a href="#index-definitions-398">definitions</a>: <a href="#Definitions">Definitions</a></li> +<li><a href="#index-description-lists_002c-creating-202">description lists, creating</a>: <a href="#description">description</a></li> +<li><a href="#index-discretionary-multiplication-820">discretionary multiplication</a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-displaying-quoted-text-with-paragraph-indentation-321">displaying quoted text with paragraph indentation</a>: <a href="#quotation">quotation</a></li> +<li><a href="#index-displaying-quoted-text-without-paragraph-indentation-325">displaying quoted text without paragraph indentation</a>: <a href="#quote">quote</a></li> +<li><a href="#index-document-class-options-17">document class options</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-document-classes-9">document classes</a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-document-templates-1073">document templates</a>: <a href="#Document-templates">Document templates</a></li> +<li><a href="#index-dot-accent-955">dot accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-dot-over-accent_002c-math-794">dot over accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-dot_002dover-accent-956">dot-over accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-dot_002dunder-accent-976">dot-under accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-dotless-i-980">dotless i</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-dotless-i_002c-math-801">dotless i, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-dotless-j-982">dotless j</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-dotless-j_002c-math-803">dotless j, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-double-dagger_002c-in-text-924">double dagger, in text</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-double-dot-accent_002c-math-791">double dot accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-ellipsis-929">ellipsis</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-emphasis-62">emphasis</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-enclosure-list-1053">enclosure list</a>: <a href="#g_t_005cencl">\encl</a></li> +<li><a href="#index-ending-_0026-starting-7">ending & starting</a>: <a href="#Starting-_0026-ending">Starting & ending</a></li> +<li><a href="#index-enlarge-current-page-489">enlarge current page</a>: <a href="#g_t_005cenlargethispage">\enlargethispage</a></li> +<li><a href="#index-environments-185">environments</a>: <a href="#Environments">Environments</a></li> +<li><a href="#index-environments_002c-defining-410">environments, defining</a>: <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></li> +<li><a href="#index-equation-number_002c-cross-referencing-182">equation number, cross referencing</a>: <a href="#g_t_005cref">\ref</a></li> +<li><a href="#index-equation-numbers_002c-omitting-226">equation numbers, omitting</a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-equations_002c-aligning-221">equations, aligning</a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-equations_002c-environment-for-229">equations, environment for</a>: <a href="#equation">equation</a></li> +<li><a href="#index-es_002dzet-German-letter-1010">es-zet German letter</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-exponent-528">exponent</a>: <a href="#Subscripts-_0026-Superscripts">Subscripts & Superscripts</a></li> +<li><a href="#index-figure-number_002c-cross-referencing-183">figure number, cross referencing</a>: <a href="#g_t_005cref">\ref</a></li> +<li><a href="#index-figures_002c-footnotes-in-296">figures, footnotes in</a>: <a href="#minipage">minipage</a></li> +<li><a href="#index-figures_002c-inserting-233">figures, inserting</a>: <a href="#figure">figure</a></li> +<li><a href="#index-fixed_002dwidth-font-107">fixed-width font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-flushing-floats-and-starting-a-page-483">flushing floats and starting a page</a>: <a href="#g_t_005cclearpage">\clearpage</a></li> +<li><a href="#index-font-commands_002c-low_002dlevel-122">font commands, low-level</a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-font-sizes-108">font sizes</a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-font-styles-54">font styles</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-fonts-53">fonts</a>: <a href="#Typefaces">Typefaces</a></li> +<li><a href="#index-fonts_002c-new-commands-for-417">fonts, new commands for</a>: <a href="#g_t_005cnewfont">\newfont</a></li> +<li><a href="#index-footer-style-862">footer style</a>: <a href="#g_t_005cpagestyle">\pagestyle</a></li> +<li><a href="#index-footer_002c-parameters-for-153">footer, parameters for</a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-footnote-number_002c-cross-referencing-184">footnote number, cross referencing</a>: <a href="#g_t_005cref">\ref</a></li> +<li><a href="#index-footnote-parameters-395">footnote parameters</a>: <a href="#Footnote-parameters">Footnote parameters</a></li> +<li><a href="#index-footnotes-in-figures-295">footnotes in figures</a>: <a href="#minipage">minipage</a></li> +<li><a href="#index-footnotes_002c-creating-391">footnotes, creating</a>: <a href="#Footnotes">Footnotes</a></li> +<li><a href="#index-formulas_002c-environment-for-230">formulas, environment for</a>: <a href="#equation">equation</a></li> +<li><a href="#index-formulas_002c-math-513">formulas, math</a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-fragile-commands-420">fragile commands</a>: <a href="#g_t_005cprotect">\protect</a></li> +<li><a href="#index-functions_002c-math-746">functions, math</a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-global-options-20">global options</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-glossaries-1030">glossaries</a>: <a href="#Glossaries">Glossaries</a></li> +<li><a href="#index-grave-accent-965">grave accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-grave-accent_002c-math-796">grave accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-greek-letters-533">greek letters</a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-h_0040_0027a_0040v_007bc_007dek-accent_002c-math-789">hác<ek accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-hacek-accent-988">hacek accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-hat-accent-963">hat accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-hat-accent_002c-math-798">hat accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-header-style-861">header style</a>: <a href="#g_t_005cpagestyle">\pagestyle</a></li> +<li><a href="#index-header_002c-parameters-for-152">header, parameters for</a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-hungarian-umlaut-accent-978">hungarian umlaut accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-hyphenation_002c-defining-473">hyphenation, defining</a>: <a href="#g_t_005chyphenation">\hyphenation</a></li> +<li><a href="#index-hyphenation_002c-forcing-470">hyphenation, forcing</a>: <a href="#g_t_005c_002d-_0028hyphenation_0029">\- (hyphenation)</a></li> +<li><a href="#index-hyphenation_002c-preventing-892">hyphenation, preventing</a>: <a href="#g_t_005cmbox">\mbox</a></li> +<li><a href="#index-in_002dline-formulas-289">in-line formulas</a>: <a href="#math">math</a></li> +<li><a href="#index-indent_002c-forcing-498">indent, forcing</a>: <a href="#g_t_005cindent">\indent</a></li> +<li><a href="#index-indent_002c-suppressing-500">indent, suppressing</a>: <a href="#g_t_005cnoindent">\noindent</a></li> +<li><a href="#index-indentation-of-paragraphs_002c-in-minipage-292">indentation of paragraphs, in minipage</a>: <a href="#minipage">minipage</a></li> +<li><a href="#index-indexes-1035">indexes</a>: <a href="#Indexes">Indexes</a></li> +<li><a href="#index-input-file-1016">input file</a>: <a href="#Splitting-the-input">Splitting the input</a></li> +<li><a href="#index-input_002fOutput-1065">input/Output</a>: <a href="#Terminal-Input_002fOutput">Terminal Input/Output</a></li> +<li><a href="#index-inserting-figures-232">inserting figures</a>: <a href="#figure">figure</a></li> +<li><a href="#index-italic-font-94">italic font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-justification_002c-ragged-left-256">justification, ragged left</a>: <a href="#g_t_005craggedleft">\raggedleft</a></li> +<li><a href="#index-justification_002c-ragged-right-249">justification, ragged right</a>: <a href="#g_t_005craggedright">\raggedright</a></li> +<li><a href="#index-Knuth_002c-Donald-E_002e-1">Knuth, Donald E.</a>: <a href="#Top">Top</a></li> +<li><a href="#index-labelled-lists_002c-creating-201">labelled lists, creating</a>: <a href="#description">description</a></li> +<li><a href="#index-Lamport_002c-Leslie-2">Lamport, Leslie</a>: <a href="#Top">Top</a></li> +<li><a href="#index-g_t_0040LaTeX_007b_007d-logo-926">LaTeX logo</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_0040LaTeX_007b_007d-overview-5">LaTeX overview</a>: <a href="#Overview">Overview</a></li> +<li><a href="#index-g_t_0040LaTeX_007b_007d-Project-team-3">LaTeX Project team</a>: <a href="#Top">Top</a></li> +<li><a href="#index-layout-commands-133">layout commands</a>: <a href="#Layout">Layout</a></li> +<li><a href="#index-layout_002c-page-parameters-for-151">layout, page parameters for</a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-left-quote-931">left quote</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-left_002djustifying-text-248">left-justifying text</a>: <a href="#g_t_005craggedright">\raggedright</a></li> +<li><a href="#index-left_002djustifying-text_002c-environment-for-243">left-justifying text, environment for</a>: <a href="#flushleft">flushleft</a></li> +<li><a href="#index-left_002dto_002dright-mode-840">left-to-right mode</a>: <a href="#Modes">Modes</a></li> +<li><a href="#index-lengths_002c-adding-to-449">lengths, adding to</a>: <a href="#g_t_005caddtolength">\addtolength</a></li> +<li><a href="#index-lengths_002c-defining-and-using-445">lengths, defining and using</a>: <a href="#Lengths">Lengths</a></li> +<li><a href="#index-lengths_002c-defining-new-406">lengths, defining new</a>: <a href="#g_t_005cnewlength">\newlength</a></li> +<li><a href="#index-lengths_002c-predefined-453">lengths, predefined</a>: <a href="#Predefined-lengths">Predefined lengths</a></li> +<li><a href="#index-lengths_002c-setting-447">lengths, setting</a>: <a href="#g_t_005csetlength">\setlength</a></li> +<li><a href="#index-letters-1043">letters</a>: <a href="#Letters">Letters</a></li> +<li><a href="#index-letters_002c-accented-949">letters, accented</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-letters_002c-ending-1050">letters, ending</a>: <a href="#g_t_005cclosing">\closing</a></li> +<li><a href="#index-letters_002c-non_002dEnglish-993">letters, non-English</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-letters_002c-starting-1058">letters, starting</a>: <a href="#g_t_005copening">\opening</a></li> +<li><a href="#index-line-break_002c-forcing-463">line break, forcing</a>: <a href="#g_t_005c_005c">\\</a></li> +<li><a href="#index-line-breaking-459">line breaking</a>: <a href="#Line-breaking">Line breaking</a></li> +<li><a href="#index-line-breaks_002c-forcing-476">line breaks, forcing</a>: <a href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a></li> +<li><a href="#index-line-breaks_002c-preventing-477">line breaks, preventing</a>: <a href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a></li> +<li><a href="#index-lines-in-tables-353">lines in tables</a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-lining-text-up-in-columns-using-tab-stops-329">lining text up in columns using tab stops</a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-lining-text-up-in-tables-354">lining text up in tables</a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-list-items_002c-specifying-counter-432">list items, specifying counter</a>: <a href="#g_t_005cusecounter">\usecounter</a></li> +<li><a href="#index-lists-of-items-260">lists of items</a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-lists-of-items_002c-generic-287">lists of items, generic</a>: <a href="#list">list</a></li> +<li><a href="#index-lists-of-items_002c-numbered-209">lists of items, numbered</a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-loading-additional-packages-48">loading additional packages</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-logo_002c-_0040LaTeX_007b_007d-927">logo, LaTeX</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-logo_002c-_0040TeX_007b_007d-946">logo, TeX</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-low_002dlevel-font-commands-121">low-level font commands</a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-lR-mode-841">lR mode</a>: <a href="#Modes">Modes</a></li> +<li><a href="#index-macron-accent-958">macron accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_0040command_007bmakeindex_007d-program-1040"><samp><span class="command">makeindex</span></samp> program</a>: <a href="#Indexes">Indexes</a></li> +<li><a href="#index-making-a-title-page-377">making a title page</a>: <a href="#titlepage">titlepage</a></li> +<li><a href="#index-making-paragraphs-494">making paragraphs</a>: <a href="#Making-paragraphs">Making paragraphs</a></li> +<li><a href="#index-marginal-notes-503">marginal notes</a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-math-accents-781">math accents</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-math-formulas-512">math formulas</a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-math-functions-745">math functions</a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-math-Miscellany-818">math Miscellany</a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-math-mode-839">math mode</a>: <a href="#Modes">Modes</a></li> +<li><a href="#index-math-mode_002c-entering-514">math mode, entering</a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-math-mode_002c-spacing-813">math mode, spacing</a>: <a href="#Spacing-in-math-mode">Spacing in math mode</a></li> +<li><a href="#index-math-symbols-531">math symbols</a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-minipage_002c-creating-a-291">minipage, creating a</a>: <a href="#minipage">minipage</a></li> +<li><a href="#index-modes-837">modes</a>: <a href="#Modes">Modes</a></li> +<li><a href="#index-monospace-font-106">monospace font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-moving-arguments-421">moving arguments</a>: <a href="#g_t_005cprotect">\protect</a></li> +<li><a href="#index-multicolumn-text-137">multicolumn text</a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-multiplication-symbol_002c-discretionary-line-break-821">multiplication symbol, discretionary line break</a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-nested-_0040code_007b_005cinclude_007d_002c-not-allowed-1018">nested <code>\include</code>, not allowed</a>: <a href="#g_t_005cinclude">\include</a></li> +<li><a href="#index-new-commands_002c-defining-402">new commands, defining</a>: <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></li> +<li><a href="#index-new-line_002c-output-as-input-466">new line, output as input</a>: <a href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a></li> +<li><a href="#index-new-line_002c-starting-462">new line, starting</a>: <a href="#g_t_005c_005c">\\</a></li> +<li><a href="#index-new-line_002c-starting-_0028paragraph-mode_0029-468">new line, starting (paragraph mode)</a>: <a href="#g_t_005cnewline">\newline</a></li> +<li><a href="#index-new-page_002c-starting-486">new page, starting</a>: <a href="#g_t_005cnewpage">\newpage</a></li> +<li><a href="#index-non_002dEnglish-characters-991">non-English characters</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-notes-in-the-margin-504">notes in the margin</a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-null-delimiter-828">null delimiter</a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-numbered-items_002c-specifying-counter-433">numbered items, specifying counter</a>: <a href="#g_t_005cusecounter">\usecounter</a></li> +<li><a href="#index-oblique-font-103">oblique font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-oe-ligature-1008">oe ligature</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-one_002dcolumn-output-135">one-column output</a>: <a href="#g_t_005conecolumn">\onecolumn</a></li> +<li><a href="#index-opening-quote-932">opening quote</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-options_002c-document-class-18">options, document class</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-options_002c-global-51">options, global</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-oslash-1005">oslash</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-overbar-accent-959">overbar accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-overdot-accent_002c-math-793">overdot accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-overview-of-_0040LaTeX_007b_007d-4">overview of LaTeX</a>: <a href="#Overview">Overview</a></li> +<li><a href="#index-packages_002c-loading-47">packages, loading</a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-page-break_002c-forcing-492">page break, forcing</a>: <a href="#g_t_005cpagebreak-_0026-_005cnopagebreak">\pagebreak & \nopagebreak</a></li> +<li><a href="#index-page-break_002c-preventing-493">page break, preventing</a>: <a href="#g_t_005cpagebreak-_0026-_005cnopagebreak">\pagebreak & \nopagebreak</a></li> +<li><a href="#index-page-breaking-478">page breaking</a>: <a href="#Page-breaking">Page breaking</a></li> +<li><a href="#index-page-layout-parameters-149">page layout parameters</a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-page-number_002c-cross-referencing-178">page number, cross referencing</a>: <a href="#g_t_005cpageref">\pageref</a></li> +<li><a href="#index-page-numbering-style-859">page numbering style</a>: <a href="#g_t_005cpagenumbering">\pagenumbering</a></li> +<li><a href="#index-page-styles-843">page styles</a>: <a href="#Page-Styles">Page Styles</a></li> +<li><a href="#index-paragraph-indentation_002c-in-minipage-293">paragraph indentation, in minipage</a>: <a href="#minipage">minipage</a></li> +<li><a href="#index-paragraph-indentations-in-quoted-text-322">paragraph indentations in quoted text</a>: <a href="#quotation">quotation</a></li> +<li><a href="#index-paragraph-indentations-in-quoted-text_002c-omitting-326">paragraph indentations in quoted text, omitting</a>: <a href="#quote">quote</a></li> +<li><a href="#index-paragraph-mode-838">paragraph mode</a>: <a href="#Modes">Modes</a></li> +<li><a href="#index-paragraph-sign-934">paragraph sign</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-paragraphs-495">paragraphs</a>: <a href="#Making-paragraphs">Making paragraphs</a></li> +<li><a href="#index-parameters_002c-page-layout-150">parameters, page layout</a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-pictures_002c-creating-299">pictures, creating</a>: <a href="#picture">picture</a></li> +<li><a href="#index-pilcrow-935">pilcrow</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-poetry_002c-an-environment-for-389">poetry, an environment for</a>: <a href="#verse">verse</a></li> +<li><a href="#index-polish-l-1002">polish l</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-postscript_002c-in-letters-1060">postscript, in letters</a>: <a href="#g_t_005cps">\ps</a></li> +<li><a href="#index-pounds-symbol-937">pounds symbol</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-preamble_002c-defined-8">preamble, defined</a>: <a href="#Starting-_0026-ending">Starting & ending</a></li> +<li><a href="#index-predefined-lengths-454">predefined lengths</a>: <a href="#Predefined-lengths">Predefined lengths</a></li> +<li><a href="#index-prompt_002c-_0040samp_007b_002a_007d-1071">prompt, ‘<samp><span class="samp">*</span></samp>’</a>: <a href="#Command-Line">Command Line</a></li> +<li><a href="#index-quoted-text-with-paragraph-indentation_002c-displaying-320">quoted text with paragraph indentation, displaying</a>: <a href="#quotation">quotation</a></li> +<li><a href="#index-quoted-text-without-paragraph-indentation_002c-displaying-324">quoted text without paragraph indentation, displaying</a>: <a href="#quote">quote</a></li> +<li><a href="#index-ragged-left-text-255">ragged left text</a>: <a href="#g_t_005craggedleft">\raggedleft</a></li> +<li><a href="#index-ragged-left-text_002c-environment-for-251">ragged left text, environment for</a>: <a href="#flushright">flushright</a></li> +<li><a href="#index-ragged-right-text-247">ragged right text</a>: <a href="#g_t_005craggedright">\raggedright</a></li> +<li><a href="#index-ragged-right-text_002c-environment-for-244">ragged right text, environment for</a>: <a href="#flushleft">flushleft</a></li> +<li><a href="#index-redefining-environments-412">redefining environments</a>: <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></li> +<li><a href="#index-remarks-in-the-margin-505">remarks in the margin</a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-reserved-characters-904">reserved characters</a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-right-quote-940">right quote</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-right_002djustifying-text-257">right-justifying text</a>: <a href="#g_t_005craggedleft">\raggedleft</a></li> +<li><a href="#index-right_002djustifying-text_002c-environment-for-252">right-justifying text, environment for</a>: <a href="#flushright">flushright</a></li> +<li><a href="#index-robust-commands-422">robust commands</a>: <a href="#g_t_005cprotect">\protect</a></li> +<li><a href="#index-roman-font-96">roman font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-running-header-and-footer-154">running header and footer</a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-running-header-and-footer-style-863">running header and footer style</a>: <a href="#g_t_005cpagestyle">\pagestyle</a></li> +<li><a href="#index-sans-serif-font-100">sans serif font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-script-letters-for-math-89">script letters for math</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-section-number_002c-cross-referencing-181">section number, cross referencing</a>: <a href="#g_t_005cref">\ref</a></li> +<li><a href="#index-section-symbol-943">section symbol</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-sectioning-163">sectioning</a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_0040code_007bsetspace_007d-package-130"><code>setspace</code> package</a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-setting-counters-438">setting counters</a>: <a href="#g_t_005csetcounter">\setcounter</a></li> +<li><a href="#index-sharp-S-letters-1011">sharp S letters</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-simulating-typed-text-381">simulating typed text</a>: <a href="#verbatim">verbatim</a></li> +<li><a href="#index-sizes-of-text-110">sizes of text</a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-slanted-font-102">slanted font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-small-caps-font-98">small caps font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-space_002c-inserting-vertical-881">space, inserting vertical</a>: <a href="#g_t_005caddvspace">\addvspace</a></li> +<li><a href="#index-spaces-867">spaces</a>: <a href="#Spaces">Spaces</a></li> +<li><a href="#index-spacing-within-math-mode-812">spacing within math mode</a>: <a href="#Spacing-in-math-mode">Spacing in math mode</a></li> +<li><a href="#index-special-characters-990">special characters</a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-splitting-the-input-file-1015">splitting the input file</a>: <a href="#Splitting-the-input">Splitting the input</a></li> +<li><a href="#index-starting-_0026-ending-6">starting & ending</a>: <a href="#Starting-_0026-ending">Starting & ending</a></li> +<li><a href="#index-starting-a-new-page-487">starting a new page</a>: <a href="#g_t_005cnewpage">\newpage</a></li> +<li><a href="#index-starting-a-new-page-and-clearing-floats-484">starting a new page and clearing floats</a>: <a href="#g_t_005cclearpage">\clearpage</a></li> +<li><a href="#index-starting-on-a-right_002dhand-page-481">starting on a right-hand page</a>: <a href="#g_t_005ccleardoublepage">\cleardoublepage</a></li> +<li><a href="#index-sterling-symbol-938">sterling symbol</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-stretch_002c-omitting-vertical-148">stretch, omitting vertical</a>: <a href="#g_t_005craggedbottom">\raggedbottom</a></li> +<li><a href="#index-styles-of-text-56">styles of text</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-styles_002c-page-842">styles, page</a>: <a href="#Page-Styles">Page Styles</a></li> +<li><a href="#index-subscript-527">subscript</a>: <a href="#Subscripts-_0026-Superscripts">Subscripts & Superscripts</a></li> +<li><a href="#index-superscript-526">superscript</a>: <a href="#Subscripts-_0026-Superscripts">Subscripts & Superscripts</a></li> +<li><a href="#index-symbols_002c-math-532">symbols, math</a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-tab-stops_002c-using-328">tab stops, using</a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-table-of-contents-entry_002c-manually-adding-1027">table of contents entry, manually adding</a>: <a href="#g_t_005caddcontentsline">\addcontentsline</a></li> +<li><a href="#index-table-of-contents_002c-creating-1021">table of contents, creating</a>: <a href="#Tables-of-contents">Tables of contents</a></li> +<li><a href="#index-tables_002c-creating-350">tables, creating</a>: <a href="#table">table</a></li> +<li><a href="#index-terminal-Input_002fOutput-1066">terminal Input/Output</a>: <a href="#Terminal-Input_002fOutput">Terminal Input/Output</a></li> +<li><a href="#index-g_t_0040TeX_007b_007d-logo-945">TeX logo</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-text-symbols-918">text symbols</a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-thanks_002c-for-titlepage-853">thanks, for titlepage</a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-theorems_002c-defining-414">theorems, defining</a>: <a href="#g_t_005cnewtheorem">\newtheorem</a></li> +<li><a href="#index-theorems_002c-typesetting-375">theorems, typesetting</a>: <a href="#theorem">theorem</a></li> +<li><a href="#index-tie_002dafter-accent-984">tie-after accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-tilde-accent-967">tilde accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-tilde-accent_002c-math-805">tilde accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-title-pages_002c-creating-378">title pages, creating</a>: <a href="#titlepage">titlepage</a></li> +<li><a href="#index-title_002c-for-titlepage-856">title, for titlepage</a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-titles_002c-making-844">titles, making</a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-two_002dcolumn-output-138">two-column output</a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-typed-text_002c-simulating-382">typed text, simulating</a>: <a href="#verbatim">verbatim</a></li> +<li><a href="#index-typeface-sizes-109">typeface sizes</a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-typeface-styles-55">typeface styles</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-typefaces-52">typefaces</a>: <a href="#Typefaces">Typefaces</a></li> +<li><a href="#index-typewriter-font-105">typewriter font</a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-typewriter-labels-in-lists-205">typewriter labels in lists</a>: <a href="#description">description</a></li> +<li><a href="#index-umlaut-accent-951">umlaut accent</a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-unordered-lists-261">unordered lists</a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-using-Bib_0040TeX_007b_007d-369">using BibTeX</a>: <a href="#Using-BibTeX">Using BibTeX</a></li> +<li><a href="#index-variables_002c-a-list-of-424">variables, a list of</a>: <a href="#Counters">Counters</a></li> +<li><a href="#index-vector-symbol_002c-math-807">vector symbol, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-verbatim-text-380">verbatim text</a>: <a href="#verbatim">verbatim</a></li> +<li><a href="#index-verbatim-text_002c-inline-386">verbatim text, inline</a>: <a href="#g_t_005cverb">\verb</a></li> +<li><a href="#index-vertical-space-880">vertical space</a>: <a href="#g_t_005caddvspace">\addvspace</a></li> +<li><a href="#index-vertical-space-before-paragraphs-502">vertical space before paragraphs</a>: <a href="#g_t_005cparskip">\parskip</a></li> +<li><a href="#index-visible-space-387">visible space</a>: <a href="#g_t_005cverb">\verb</a></li> +<li><a href="#index-wide-hat-accent_002c-math-809">wide hat accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-wide-tile-accent_002c-math-811">wide tile accent, math</a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_0040command_007bxindy_007d-program-1041"><samp><span class="command">xindy</span></samp> program</a>: <a href="#Indexes">Indexes</a></li> + </ul><!-- The name of the `Command Index' node must NOT be altered for ltx-help.el. --> +<div class="node"> +<p><hr> +<a name="Command-Index"></a> +Next: <a rel="next" accesskey="n" href="#Concept-Index">Concept Index</a>, +Previous: <a rel="previous" accesskey="p" href="#Document-templates">Document templates</a>, +Up: <a rel="up" accesskey="u" href="#Top">Top</a> + +</div> + +<h2 class="unnumbered">Command Index</h2> + + + +<ul class="index-fn" compact> +<li><a href="#index-g_t_0024-522"><code>$</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t10pt-_0040r_007boption_007d-21"><code>10pt </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-g_t11pt-_0040r_007boption_007d-22"><code>11pt </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-g_t12pt-_0040r_007boption_007d-23"><code>12pt </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-g_t_0040_0040_0040_007b_002e_002e_002e_0040_007d-193"><code>@{...}</code></a>: <a href="#array">array</a></li> +<li><a href="#index-g_t_005c_0022-_0040r_007b_0028umlaut-accent_0029_007d-950"><code>\" </code><span class="roman">(umlaut accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005c_0023-906"><code>\#</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_0024-907"><code>\$</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_0025-908"><code>\%</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_0026-909"><code>\&</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_0027-_0040r_007b_0028acute-accent_0029_007d-952"><code>\' </code><span class="roman">(acute accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005c_0027-_0040r_007b_0028tabbing_0029_007d-338"><code>\' </code><span class="roman">(tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_0028-518"><code>\(</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t_005c_0029-519"><code>\)</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t_005c_002a-819"><code>\*</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005c_002b-336"><code>\+</code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_002c-817"><code>\,</code></a>: <a href="#Spacing-in-math-mode">Spacing in math mode</a></li> +<li><a href="#index-g_t_005c_002d-337"><code>\-</code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_002d-_0040r_007b_0028hyphenation_0029_007d-469"><code>\- </code><span class="roman">(hyphenation)</span></a>: <a href="#g_t_005c_002d-_0028hyphenation_0029">\- (hyphenation)</a></li> +<li><a href="#index-g_t_005c_002e-_0040r_007b_0028dot_002dover-accent_0029_007d-954"><code>\. </code><span class="roman">(dot-over accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005c_002f-876"><code>\/</code></a>: <a href="#g_t_005c_002f">\/</a></li> +<li><a href="#index-g_t_005c_003a-815"><code>\:</code></a>: <a href="#Spacing-in-math-mode">Spacing in math mode</a></li> +<li><a href="#index-g_t_005c_003b-814"><code>\;</code></a>: <a href="#Spacing-in-math-mode">Spacing in math mode</a></li> +<li><a href="#index-g_t_005c_003c-335"><code>\<</code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_003d-_0040r_007b_0028macron-accent_0029_007d-957"><code>\= </code><span class="roman">(macron accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005c_003d-_0040r_007b_0028tabbing_0029_007d-332"><code>\= </code><span class="roman">(tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_003e-816"><code>\></code></a>: <a href="#Spacing-in-math-mode">Spacing in math mode</a></li> +<li><a href="#index-g_t_005c_003e-334"><code>\></code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_003e-_0040r_007b_0028tabbing_0029_007d-333"><code>\> </code><span class="roman">(tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_0040_0040-874"><code>\@</code></a>: <a href="#g_t_005cAT">\AT</a></li> +<li><a href="#index-g_t_005c_005b-520"><code>\[</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007b_0028for-_0040code_007b_005cshortstack_007d-objects_0029_007d-317"><code>\\ </code><span class="roman">(for </span><code>\shortstack</code><span class="roman"> objects)</span></a>: <a href="#g_t_005cshortstack">\shortstack</a></li> +<li><a href="#index-g_t_005c_005c-_0028for-_0040code_007barray_007d_0029-192"><code>\\ (for array)</code></a>: <a href="#array">array</a></li> +<li><a href="#index-g_t_005c_005c-_0028for-_0040code_007bcenter_007d_0029-197"><code>\\ (for center)</code></a>: <a href="#center">center</a></li> +<li><a href="#index-g_t_005c_005c-_0028for-_0040code_007beqnarray_007d_0029-223"><code>\\ (for eqnarray)</code></a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-g_t_005c_005c-_0028for-_0040code_007bflushright_007d_0029-253"><code>\\ (for flushright)</code></a>: <a href="#flushright">flushright</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007bfor-_0040code_007b_005cauthor_007d_007d-848"><code>\\ </code><span class="roman">for </span><code>\author</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007bfor-_0040code_007b_005ctitle_007d_007d-857"><code>\\ </code><span class="roman">for </span><code>\title</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007bfor-_0040code_007bflushleft_007d_007d-245"><code>\\ </code><span class="roman">for </span><code>flushleft</code></a>: <a href="#flushleft">flushleft</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007bfor-letters_007d-1045"><code>\\ </code><span class="roman">for letters</span></a>: <a href="#Letters">Letters</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007bfor-_0040code_007btabular_007d_007d-355"><code>\\ </code><span class="roman">for </span><code>tabular</code></a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007bfor-_0040code_007bverse_007d_007d-390"><code>\\ </code><span class="roman">for </span><code>verse</code></a>: <a href="#verse">verse</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007bforce-line-break_007d-461"><code>\\ </code><span class="roman">force line break</span></a>: <a href="#g_t_005c_005c">\\</a></li> +<li><a href="#index-g_t_005c_005c-_0040r_007btabbing_007d-331"><code>\\ </code><span class="roman">tabbing</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005c_005c_002a-_0028for-_0040code_007beqnarray_007d_0029-224"><code>\\* (for eqnarray)</code></a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-g_t_005c_005d-521"><code>\]</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t_005c_005e-915"><code>\^</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_005e-_0040r_007b_0028circumflex-accent_0029_007d-961"><code>\^ </code><span class="roman">(circumflex accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005c_005f-910"><code>\_</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_0060-_0040r_007b_0028grave-accent_0029_007d-964"><code>\` </code><span class="roman">(grave accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005c_0060-_0040r_007b_0028tabbing_0029_007d-339"><code>\` </code><span class="roman">(tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005ca-_0040r_007b_0028tabbing_0029_007d-340"><code>\a </code><span class="roman">(tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005ca_0027-_0040r_007b_0028acute-accent-in-tabbing_0029_007d-341"><code>\a' </code><span class="roman">(acute accent in tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005ca_003d-_0040r_007b_0028macron-accent-in-tabbing_0029_007d-343"><code>\a= </code><span class="roman">(macron accent in tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005ca_0060-_0040r_007b_0028grave-accent-in-tabbing_0029_007d-342"><code>\a` </code><span class="roman">(grave accent in tabbing)</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005cAA-_0028_0040AA_007b_007d_0029-995"><code>\AA (Å)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005caa-_0028_0040aa_007b_007d_0029-994"><code>\aa (å)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005cacute-783"><code>\acute</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005caddcontentsline_0040_007b_0040var_007bext_007d_0040_007d_0040_007b_0040var_007bunit_007d_0040_007d_0040_007b_0040var_007btext_007d_0040_007d-1026"><code>\addcontentsline{</code><var>ext</var><code>}{</code><var>unit</var><code>}{</code><var>text</var><code>}</code></a>: <a href="#g_t_005caddcontentsline">\addcontentsline</a></li> +<li><a href="#index-g_t_005caddress-1046"><code>\address</code></a>: <a href="#g_t_005caddress">\address</a></li> +<li><a href="#index-g_t_005caddtocontents_0040_007b_0040var_007bext_007d_0040_007d_0040_007b_0040var_007btext_007d_0040_007d-1029"><code>\addtocontents{</code><var>ext</var><code>}{</code><var>text</var><code>}</code></a>: <a href="#g_t_005caddtocontents">\addtocontents</a></li> +<li><a href="#index-g_t_005caddtocounter-439"><code>\addtocounter</code></a>: <a href="#g_t_005caddtocounter">\addtocounter</a></li> +<li><a href="#index-g_t_005caddtolength-448"><code>\addtolength</code></a>: <a href="#g_t_005caddtolength">\addtolength</a></li> +<li><a href="#index-g_t_005caddvspace-879"><code>\addvspace</code></a>: <a href="#g_t_005caddvspace">\addvspace</a></li> +<li><a href="#index-g_t_005cAE-_0028_0040AE_007b_007d_0029-998"><code>\AE (Æ)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005cae-_0028_0040ae_007b_007d_0029-997"><code>\ae (æ)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005caleph-535"><code>\aleph</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cAlph-426"><code>\Alph</code></a>: <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a></li> +<li><a href="#index-g_t_005calph-425"><code>\alph</code></a>: <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a></li> +<li><a href="#index-g_t_005cAlph-_0040r_007bexample_007d-219"><code>\Alph </code><span class="roman">example</span></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005calpha-536"><code>\alpha</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005camalg-537"><code>\amalg</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cand-_0040r_007bfor-_0040code_007b_005cauthor_007d_007d-849"><code>\and </code><span class="roman">for </span><code>\author</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005cangle-538"><code>\angle</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cappendix-172"><code>\appendix</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005capprox-539"><code>\approx</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005carabic-427"><code>\arabic</code></a>: <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a></li> +<li><a href="#index-g_t_005carccos-747"><code>\arccos</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005carcsin-748"><code>\arcsin</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005carctan-749"><code>\arctan</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005carg-750"><code>\arg</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005carraycolsep-194"><code>\arraycolsep</code></a>: <a href="#array">array</a></li> +<li><a href="#index-g_t_005carrayrulewidth-356"><code>\arrayrulewidth</code></a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-g_t_005carraystretch-357"><code>\arraystretch</code></a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-g_t_005cast-540"><code>\ast</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005casymp-541"><code>\asymp</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cauthor_0040_007b_0040var_007bname_007d-_005cand-_0040var_007bname2_007d_0040_007d-846"><code>\author{</code><var>name</var><code> \and </code><var>name2</var><code>}</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005cb-_0040r_007b_0028bar_002dunder-accent_0029_007d-968"><code>\b </code><span class="roman">(bar-under accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005cbackslash-913"><code>\backslash</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005cbackslash-542"><code>\backslash</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbar-_0040r_007b_0028macron_002c-bar_002dover-accent_0029_007d-970"><code>\bar </code><span class="roman">(macron, bar-over accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005cbaselineskip-128"><code>\baselineskip</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cbaselinestretch-129"><code>\baselinestretch</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cbegin-186"><code>\begin</code></a>: <a href="#Environments">Environments</a></li> +<li><a href="#index-g_t_005cbeta-543"><code>\beta</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbf-86"><code>\bf</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cbfseries-66"><code>\bfseries</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cbibitem-366"><code>\bibitem</code></a>: <a href="#g_t_005cbibitem">\bibitem</a></li> +<li><a href="#index-g_t_005cbibliography-373"><code>\bibliography</code></a>: <a href="#Using-BibTeX">Using BibTeX</a></li> +<li><a href="#index-g_t_005cbibliographystyle-372"><code>\bibliographystyle</code></a>: <a href="#Using-BibTeX">Using BibTeX</a></li> +<li><a href="#index-g_t_005cbigcap-544"><code>\bigcap</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigcirc-545"><code>\bigcirc</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigcup-546"><code>\bigcup</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigodot-547"><code>\bigodot</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigoplus-548"><code>\bigoplus</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigotimes-549"><code>\bigotimes</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigskip-882"><code>\bigskip</code></a>: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></li> +<li><a href="#index-g_t_005cbigskipamount-883"><code>\bigskipamount</code></a>: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></li> +<li><a href="#index-g_t_005cbigsqcup-552"><code>\bigsqcup</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigtriangledown-550"><code>\bigtriangledown</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigtriangleup-551"><code>\bigtriangleup</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbiguplus-553"><code>\biguplus</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbigwedge-555"><code>\bigwedge</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbmod-751"><code>\bmod</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cboldmath-523"><code>\boldmath</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t_005cbot-556"><code>\bot</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbottomfraction-235"><code>\bottomfraction</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005cbowtie-557"><code>\bowtie</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cBox-558"><code>\Box</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cbreve-785"><code>\breve</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cbullet-559"><code>\bullet</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cc-_0040r_007b_0028cedilla-accent_0029_007d-973"><code>\c </code><span class="roman">(cedilla accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005ccal-88"><code>\cal</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ccap-561"><code>\cap</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ccaption-234"><code>\caption</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005ccc-1047"><code>\cc</code></a>: <a href="#g_t_005ccc">\cc</a></li> +<li><a href="#index-g_t_005ccdot-562"><code>\cdot</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ccdots-822"><code>\cdots</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005ccentering-198"><code>\centering</code></a>: <a href="#g_t_005ccentering">\centering</a></li> +<li><a href="#index-g_t_005cchapter-165"><code>\chapter</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005ccheck-787"><code>\check</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cchi-563"><code>\chi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ccirc-564"><code>\circ</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ccircle-302"><code>\circle</code></a>: <a href="#g_t_005ccircle">\circle</a></li> +<li><a href="#index-g_t_005ccite-367"><code>\cite</code></a>: <a href="#g_t_005ccite">\cite</a></li> +<li><a href="#index-g_t_005ccleardoublepage-480"><code>\cleardoublepage</code></a>: <a href="#g_t_005ccleardoublepage">\cleardoublepage</a></li> +<li><a href="#index-g_t_005cclearpage-482"><code>\clearpage</code></a>: <a href="#g_t_005cclearpage">\clearpage</a></li> +<li><a href="#index-g_t_005ccline-361"><code>\cline</code></a>: <a href="#g_t_005ccline">\cline</a></li> +<li><a href="#index-g_t_005cclosing-1049"><code>\closing</code></a>: <a href="#g_t_005cclosing">\closing</a></li> +<li><a href="#index-g_t_005cclubsuit-565"><code>\clubsuit</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ccolumnsep-139"><code>\columnsep</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005ccolumnseprule-140"><code>\columnseprule</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005ccolumnwidth-141"><code>\columnwidth</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005ccong-566"><code>\cong</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ccontentsline-1028"><code>\contentsline</code></a>: <a href="#g_t_005caddcontentsline">\addcontentsline</a></li> +<li><a href="#index-g_t_005ccoprod-567"><code>\coprod</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ccopyright-919"><code>\copyright</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005ccos-752"><code>\cos</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ccosh-753"><code>\cosh</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ccot-754"><code>\cot</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ccoth-755"><code>\coth</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ccsc-756"><code>\csc</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ccup-568"><code>\cup</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cd-_0040r_007b_0028dot_002dunder-accent_0029_007d-975"><code>\d </code><span class="roman">(dot-under accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005cdag-921"><code>\dag</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005cdagger-569"><code>\dagger</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdashbox-307"><code>\dashbox</code></a>: <a href="#g_t_005cdashbox">\dashbox</a></li> +<li><a href="#index-g_t_005cdashv-570"><code>\dashv</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdate_0040_007b_0040var_007btext_007d_0040_007d-850"><code>\date{</code><var>text</var><code>}</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005cday-442"><code>\day</code></a>: <a href="#g_t_005cday-_005cmonth-_005cyear">\day \month \year</a></li> +<li><a href="#index-g_t_005cdblfloatpagefraction-143"><code>\dblfloatpagefraction</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005cdblfloatsep-144"><code>\dblfloatsep</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005cdbltextfloatsep-145"><code>\dbltextfloatsep</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005cdbltopfraction-142"><code>\dbltopfraction</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005cddag-923"><code>\ddag</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005cddagger-571"><code>\ddagger</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cddot-790"><code>\ddot</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cddots-823"><code>\ddots</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cdeg-757"><code>\deg</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cdelta-573"><code>\delta</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cDelta-572"><code>\Delta</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdepth-457"><code>\depth</code></a>: <a href="#Predefined-lengths">Predefined lengths</a></li> +<li><a href="#index-g_t_005cdet-758"><code>\det</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cdiamond-575"><code>\diamond</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cDiamond-574"><code>\Diamond</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdiamondsuit-576"><code>\diamondsuit</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdim-759"><code>\dim</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cdisplaystyle-525"><code>\displaystyle</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t_005cdiv-577"><code>\div</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdocumentclass-11"><code>\documentclass</code></a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-g_t_005cdot-792"><code>\dot</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cdoteq-578"><code>\doteq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdotfill-878"><code>\dotfill</code></a>: <a href="#g_t_005cdotfill">\dotfill</a></li> +<li><a href="#index-g_t_005cdoublerulesep-358"><code>\doublerulesep</code></a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-g_t_005cDownarrow-580"><code>\Downarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cdownarrow-579"><code>\downarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cell-581"><code>\ell</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cem-91"><code>\em</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cemph-61"><code>\emph</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cemptyset-582"><code>\emptyset</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cencl-1052"><code>\encl</code></a>: <a href="#g_t_005cencl">\encl</a></li> +<li><a href="#index-g_t_005cend-187"><code>\end</code></a>: <a href="#Environments">Environments</a></li> +<li><a href="#index-g_t_005cenlargethispage-488"><code>\enlargethispage</code></a>: <a href="#g_t_005cenlargethispage">\enlargethispage</a></li> +<li><a href="#index-g_t_005cenumi-211"><code>\enumi</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005cenumii-212"><code>\enumii</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005cenumiii-213"><code>\enumiii</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005cenumiv-214"><code>\enumiv</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005cepsilon-583"><code>\epsilon</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cequiv-584"><code>\equiv</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ceta-585"><code>\eta</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cevensidemargin-45"><code>\evensidemargin</code></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-g_t_005cexists-586"><code>\exists</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cexp-760"><code>\exp</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cfbox-893"><code>\fbox</code></a>: <a href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a></li> +<li><a href="#index-g_t_005cfboxrule-895"><code>\fboxrule</code></a>: <a href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a></li> +<li><a href="#index-g_t_005cfboxrule-305"><code>\fboxrule</code></a>: <a href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a></li> +<li><a href="#index-g_t_005cfboxsep-896"><code>\fboxsep</code></a>: <a href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a></li> +<li><a href="#index-g_t_005cfboxsep-306"><code>\fboxsep</code></a>: <a href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a></li> +<li><a href="#index-g_t_005cfill-870"><code>\fill</code></a>: <a href="#g_t_005chfill">\hfill</a></li> +<li><a href="#index-g_t_005cflat-587"><code>\flat</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cfloatpagefraction-236"><code>\floatpagefraction</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005cfloatsep-237"><code>\floatsep</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005cflushbottom-146"><code>\flushbottom</code></a>: <a href="#g_t_005cflushbottom">\flushbottom</a></li> +<li><a href="#index-g_t_005cfnsymbol-430"><code>\fnsymbol</code></a>: <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a></li> +<li><a href="#index-g_t_005cfontencoding-123"><code>\fontencoding</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cfontfamily-124"><code>\fontfamily</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cfontseries-125"><code>\fontseries</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cfontshape-126"><code>\fontshape</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cfontsize-127"><code>\fontsize</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cfootnote-392"><code>\footnote</code></a>: <a href="#g_t_005cfootnote">\footnote</a></li> +<li><a href="#index-g_t_005cfootnotemark-393"><code>\footnotemark</code></a>: <a href="#g_t_005cfootnotemark">\footnotemark</a></li> +<li><a href="#index-g_t_005cfootnoterule-396"><code>\footnoterule</code></a>: <a href="#Footnote-parameters">Footnote parameters</a></li> +<li><a href="#index-g_t_005cfootnotesep-397"><code>\footnotesep</code></a>: <a href="#Footnote-parameters">Footnote parameters</a></li> +<li><a href="#index-g_t_005cfootnotesize-113"><code>\footnotesize</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005cfootnotetext-394"><code>\footnotetext</code></a>: <a href="#g_t_005cfootnotetext">\footnotetext</a></li> +<li><a href="#index-g_t_005cfootskip-157"><code>\footskip</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005cforall-588"><code>\forall</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cfrac-825"><code>\frac</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cfrac_0040_007bnum_0040_007d_0040_007bden_0040_007d-824"><code>\frac{num}{den}</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cframe-308"><code>\frame</code></a>: <a href="#g_t_005cframe">\frame</a></li> +<li><a href="#index-g_t_005cframebox-894"><code>\framebox</code></a>: <a href="#g_t_005cfbox-and-_005cframebox">\fbox and \framebox</a></li> +<li><a href="#index-g_t_005cframebox-304"><code>\framebox</code></a>: <a href="#g_t_005cframebox-_0028picture_0029">\framebox (picture)</a></li> +<li><a href="#index-g_t_005cfrown-589"><code>\frown</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cfussy-471"><code>\fussy</code></a>: <a href="#g_t_005cfussy">\fussy</a></li> +<li><a href="#index-g_t_005cgamma-591"><code>\gamma</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cGamma-590"><code>\Gamma</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cgcd-761"><code>\gcd</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cge-592"><code>\ge</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cgeq-593"><code>\geq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cgets-594"><code>\gets</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cgg-595"><code>\gg</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cglossary-1032"><code>\glossary</code></a>: <a href="#Glossaries">Glossaries</a></li> +<li><a href="#index-g_t_005cglossaryentry-1034"><code>\glossaryentry</code></a>: <a href="#Glossaries">Glossaries</a></li> +<li><a href="#index-g_t_005cgrave-795"><code>\grave</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cH-_0040r_007b_0028Hungarian-umlaut-accent_0029_007d-977"><code>\H </code><span class="roman">(Hungarian umlaut accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005chat-797"><code>\hat</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005chbar-596"><code>\hbar</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cheadheight-155"><code>\headheight</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005cheadsep-156"><code>\headsep</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005cheartsuit-597"><code>\heartsuit</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cheight-456"><code>\height</code></a>: <a href="#Predefined-lengths">Predefined lengths</a></li> +<li><a href="#index-g_t_005chfill-869"><code>\hfill</code></a>: <a href="#g_t_005chfill">\hfill</a></li> +<li><a href="#index-g_t_005chline-362"><code>\hline</code></a>: <a href="#g_t_005chline">\hline</a></li> +<li><a href="#index-g_t_005chom-762"><code>\hom</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005chookleftarrow-598"><code>\hookleftarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005chookrightarrow-599"><code>\hookrightarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005chrulefill-877"><code>\hrulefill</code></a>: <a href="#g_t_005chrulefill">\hrulefill</a></li> +<li><a href="#index-g_t_005chspace-868"><code>\hspace</code></a>: <a href="#g_t_005chspace">\hspace</a></li> +<li><a href="#index-g_t_005cHuge-120"><code>\Huge</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005chuge-119"><code>\huge</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005chyphenation-472"><code>\hyphenation</code></a>: <a href="#g_t_005chyphenation">\hyphenation</a></li> +<li><a href="#index-g_t_005ci-_0040r_007b_0028dotless-i_0029_007d-979"><code>\i </code><span class="roman">(dotless i)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005ciff-600"><code>\iff</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cIm-601"><code>\Im</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cimath-800"><code>\imath</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cin-602"><code>\in</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cinclude-1017"><code>\include</code></a>: <a href="#g_t_005cinclude">\include</a></li> +<li><a href="#index-g_t_005cincludeonly-1019"><code>\includeonly</code></a>: <a href="#g_t_005cincludeonly">\includeonly</a></li> +<li><a href="#index-g_t_005cindent-496"><code>\indent</code></a>: <a href="#g_t_005cindent">\indent</a></li> +<li><a href="#index-g_t_005cindex-1037"><code>\index</code></a>: <a href="#Indexes">Indexes</a></li> +<li><a href="#index-g_t_005cindexentry-1039"><code>\indexentry</code></a>: <a href="#Indexes">Indexes</a></li> +<li><a href="#index-g_t_005cinf-763"><code>\inf</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cinfty-603"><code>\infty</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cinput-1020"><code>\input</code></a>: <a href="#g_t_005cinput">\input</a></li> +<li><a href="#index-g_t_005cint-604"><code>\int</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cintextsep-238"><code>\intextsep</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005ciota-605"><code>\iota</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cit-93"><code>\it</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005citem-259"><code>\item</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005citem-210"><code>\item</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005citem-203"><code>\item</code></a>: <a href="#description">description</a></li> +<li><a href="#index-g_t_005citemindent-274"><code>\itemindent</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005citemsep-279"><code>\itemsep</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005citshape-60"><code>\itshape</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cj-_0040r_007b_0028dotless-j_0029_007d-981"><code>\j </code><span class="roman">(dotless j)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005cjmath-802"><code>\jmath</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cJoin-606"><code>\Join</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ckappa-607"><code>\kappa</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cker-764"><code>\ker</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ckill-344"><code>\kill</code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005cL-_0028_0040L_007b_007d_0029-1001"><code>\L (/L)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005cl-_0028_0040l_007b_007d_0029-1000"><code>\l (/l)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005clabel-175"><code>\label</code></a>: <a href="#g_t_005clabel">\label</a></li> +<li><a href="#index-g_t_005clabelenumi-215"><code>\labelenumi</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005clabelenumii-216"><code>\labelenumii</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005clabelenumiii-217"><code>\labelenumiii</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005clabelenumiv-218"><code>\labelenumiv</code></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-g_t_005clabelitemi-263"><code>\labelitemi</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005clabelitemii-264"><code>\labelitemii</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005clabelitemiii-265"><code>\labelitemiii</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005clabelitemiv-266"><code>\labelitemiv</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005clabelsep-275"><code>\labelsep</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005clabelwidth-276"><code>\labelwidth</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005clambda-609"><code>\lambda</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cLambda-608"><code>\Lambda</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cland-610"><code>\land</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clangle-611"><code>\langle</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cLARGE-118"><code>\LARGE</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005cLarge-117"><code>\Large</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005clarge-116"><code>\large</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005cLaTeX-925"><code>\LaTeX</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005clbrace-612"><code>\lbrace</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clbrack-613"><code>\lbrack</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clceil-614"><code>\lceil</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cldots-928"><code>\ldots</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005cle-615"><code>\le</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cleadsto-616"><code>\leadsto</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cleft-_0040var_007bdelim1_007d-_002e_002e_002e-_005cright-_0040var_007bdelim2_007d-826"><code>\left </code><var>delim1</var><code> ... \right </code><var>delim2</var></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cleftarrow-618"><code>\leftarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cLeftarrow-617"><code>\Leftarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clefteqn-227"><code>\lefteqn</code></a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-g_t_005cleftharpoondown-619"><code>\leftharpoondown</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cleftharpoonup-620"><code>\leftharpoonup</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cleftmargin-267"><code>\leftmargin</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cleftmargini-268"><code>\leftmargini</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cleftmarginii-269"><code>\leftmarginii</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cleftmarginiii-270"><code>\leftmarginiii</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cleftmarginiv-271"><code>\leftmarginiv</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cleftmarginv-272"><code>\leftmarginv</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cleftmarginvi-273"><code>\leftmarginvi</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cleftrightarrow-622"><code>\leftrightarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cLeftrightarrow-621"><code>\Leftrightarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cleq-623"><code>\leq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clfloor-624"><code>\lfloor</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clg-765"><code>\lg</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005clhd-625"><code>\lhd</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clim-766"><code>\lim</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005climinf-767"><code>\liminf</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005climsup-768"><code>\limsup</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cline-309"><code>\line</code></a>: <a href="#g_t_005cline">\line</a></li> +<li><a href="#index-g_t_005clinebreak-474"><code>\linebreak</code></a>: <a href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a></li> +<li><a href="#index-g_t_005clinethickness-310"><code>\linethickness</code></a>: <a href="#g_t_005clinethickness">\linethickness</a></li> +<li><a href="#index-g_t_005clinewidth-158"><code>\linewidth</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005clistoffigures-1023"><code>\listoffigures</code></a>: <a href="#Tables-of-contents">Tables of contents</a></li> +<li><a href="#index-g_t_005clistoftables-1024"><code>\listoftables</code></a>: <a href="#Tables-of-contents">Tables of contents</a></li> +<li><a href="#index-g_t_005clistparindent-277"><code>\listparindent</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cll-626"><code>\ll</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cln-769"><code>\ln</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005clnot-627"><code>\lnot</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clocation-1054"><code>\location</code></a>: <a href="#g_t_005clocation">\location</a></li> +<li><a href="#index-g_t_005clog-770"><code>\log</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005clongleftarrow-628"><code>\longleftarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clongleftrightarrow-629"><code>\longleftrightarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clongmapsto-630"><code>\longmapsto</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clongrightarrow-631"><code>\longrightarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clor-632"><code>\lor</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005clq-930"><code>\lq</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005cmakebox-898"><code>\makebox</code></a>: <a href="#g_t_005cmakebox">\makebox</a></li> +<li><a href="#index-g_t_005cmakebox-_0028picture_0029-303"><code>\makebox (picture)</code></a>: <a href="#g_t_005cmakebox-_0028picture_0029">\makebox (picture)</a></li> +<li><a href="#index-g_t_005cmakeglossary-1031"><code>\makeglossary</code></a>: <a href="#Glossaries">Glossaries</a></li> +<li><a href="#index-g_t_005cmakeindex-1036"><code>\makeindex</code></a>: <a href="#Indexes">Indexes</a></li> +<li><a href="#index-g_t_005cmakelabels-1055"><code>\makelabels</code></a>: <a href="#g_t_005cmakelabels">\makelabels</a></li> +<li><a href="#index-g_t_005cmaketitle-845"><code>\maketitle</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005cmapsto-633"><code>\mapsto</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cmarginpar-506"><code>\marginpar</code></a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-g_t_005cmarginparpush-509"><code>\marginparpush</code></a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-g_t_005cmarginparsep-510"><code>\marginparsep</code></a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-g_t_005cmarginparwidth-511"><code>\marginparwidth</code></a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-g_t_005cmarkboth_0040_007b_0040var_007bleft_007d_0040_007d_0040_007b_0040var_007bright_007d_0040_007d-864"><code>\markboth{</code><var>left</var><code>}{</code><var>right</var><code>}</code></a>: <a href="#g_t_005cpagestyle">\pagestyle</a></li> +<li><a href="#index-g_t_005cmarkright_0040_007b_0040var_007bright_007d_0040_007d-865"><code>\markright{</code><var>right</var><code>}</code></a>: <a href="#g_t_005cpagestyle">\pagestyle</a></li> +<li><a href="#index-g_t_005cmathbf-80"><code>\mathbf</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmathcal-84"><code>\mathcal</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmathnormal-83"><code>\mathnormal</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmathrm-79"><code>\mathrm</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmathsf-81"><code>\mathsf</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmathtt-82"><code>\mathtt</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmathversion-85"><code>\mathversion</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmax-771"><code>\max</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cmbox-891"><code>\mbox</code></a>: <a href="#g_t_005cmbox">\mbox</a></li> +<li><a href="#index-g_t_005cmdseries-64"><code>\mdseries</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cmedskip-884"><code>\medskip</code></a>: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></li> +<li><a href="#index-g_t_005cmedskipamount-885"><code>\medskipamount</code></a>: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></li> +<li><a href="#index-g_t_005cmho-634"><code>\mho</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cmid-635"><code>\mid</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cmin-772"><code>\min</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cmodels-636"><code>\models</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cmonth-443"><code>\month</code></a>: <a href="#g_t_005cday-_005cmonth-_005cyear">\day \month \year</a></li> +<li><a href="#index-g_t_005cmp-637"><code>\mp</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cmu-638"><code>\mu</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cmulticolumn-360"><code>\multicolumn</code></a>: <a href="#g_t_005cmulticolumn">\multicolumn</a></li> +<li><a href="#index-g_t_005cmultiput-313"><code>\multiput</code></a>: <a href="#g_t_005cmultiput">\multiput</a></li> +<li><a href="#index-g_t_005cnabla-639"><code>\nabla</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cname-1056"><code>\name</code></a>: <a href="#g_t_005cname">\name</a></li> +<li><a href="#index-g_t_005cnatural-640"><code>\natural</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cne-641"><code>\ne</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cnearrow-642"><code>\nearrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cneg-643"><code>\neg</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cneq-644"><code>\neq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cnewcommand-399"><code>\newcommand</code></a>: <a href="#g_t_005cnewcommand-_0026-_005crenewcommand">\newcommand & \renewcommand</a></li> +<li><a href="#index-g_t_005cnewcounter-403"><code>\newcounter</code></a>: <a href="#g_t_005cnewcounter">\newcounter</a></li> +<li><a href="#index-g_t_005cnewenvironment-408"><code>\newenvironment</code></a>: <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></li> +<li><a href="#index-g_t_005cnewfont-416"><code>\newfont</code></a>: <a href="#g_t_005cnewfont">\newfont</a></li> +<li><a href="#index-g_t_005cnewlength-405"><code>\newlength</code></a>: <a href="#g_t_005cnewlength">\newlength</a></li> +<li><a href="#index-g_t_005cNEWLINE-873"><code>\NEWLINE</code></a>: <a href="#g_t_005cSPACE">\SPACE</a></li> +<li><a href="#index-g_t_005cnewline-467"><code>\newline</code></a>: <a href="#g_t_005cnewline">\newline</a></li> +<li><a href="#index-g_t_005cnewpage-485"><code>\newpage</code></a>: <a href="#g_t_005cnewpage">\newpage</a></li> +<li><a href="#index-g_t_005cnewsavebox-407"><code>\newsavebox</code></a>: <a href="#g_t_005cnewsavebox">\newsavebox</a></li> +<li><a href="#index-g_t_005cnewtheorem-413"><code>\newtheorem</code></a>: <a href="#g_t_005cnewtheorem">\newtheorem</a></li> +<li><a href="#index-g_t_005cni-645"><code>\ni</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cnocite-368"><code>\nocite</code></a>: <a href="#g_t_005cnocite">\nocite</a></li> +<li><a href="#index-g_t_005cnofiles-1025"><code>\nofiles</code></a>: <a href="#Tables-of-contents">Tables of contents</a></li> +<li><a href="#index-g_t_005cnoindent-499"><code>\noindent</code></a>: <a href="#g_t_005cnoindent">\noindent</a></li> +<li><a href="#index-g_t_005cnolinebreak-475"><code>\nolinebreak</code></a>: <a href="#g_t_005clinebreak-_0026-_005cnolinebreak">\linebreak & \nolinebreak</a></li> +<li><a href="#index-g_t_005cnonumber-225"><code>\nonumber</code></a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-g_t_005cnopagebreak-491"><code>\nopagebreak</code></a>: <a href="#g_t_005cpagebreak-_0026-_005cnopagebreak">\pagebreak & \nopagebreak</a></li> +<li><a href="#index-g_t_005cnormalfont-78"><code>\normalfont</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cnormalmarginpar-508"><code>\normalmarginpar</code></a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-g_t_005cnormalsize-115"><code>\normalsize</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005cnot-646"><code>\not</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cnotin-647"><code>\notin</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cnu-648"><code>\nu</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cnwarrow-649"><code>\nwarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cO-_0028_0040O_007b_007d_0029-1004"><code>\O (Ø)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005co-_0028_0040o_007b_007d_0029-1003"><code>\o (ø)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005cobeycr-464"><code>\obeycr</code></a>: <a href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a></li> +<li><a href="#index-g_t_005coddsidemargin-46"><code>\oddsidemargin</code></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-g_t_005codot-650"><code>\odot</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cOE-_0028_0040OE_007b_007d_0029-1007"><code>\OE (Œ)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005coe-_0028_0040oe_007b_007d_0029-1006"><code>\oe (œ)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005coint-651"><code>\oint</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005comega-653"><code>\omega</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cOmega-652"><code>\Omega</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cominus-654"><code>\ominus</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005conecolumn-134"><code>\onecolumn</code></a>: <a href="#g_t_005conecolumn">\onecolumn</a></li> +<li><a href="#index-g_t_005copening-1057"><code>\opening</code></a>: <a href="#g_t_005copening">\opening</a></li> +<li><a href="#index-g_t_005coplus-655"><code>\oplus</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005coslash-656"><code>\oslash</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cotimes-657"><code>\otimes</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005coval-314"><code>\oval</code></a>: <a href="#g_t_005coval">\oval</a></li> +<li><a href="#index-g_t_005coverbrace_0040_007b_0040var_007btext_007d_0040_007d-829"><code>\overbrace{</code><var>text</var><code>}</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005coverline_0040_007b_0040var_007btext_007d_0040_007d-830"><code>\overline{</code><var>text</var><code>}</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cowns-658"><code>\owns</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cP-933"><code>\P</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005cpagebreak-490"><code>\pagebreak</code></a>: <a href="#g_t_005cpagebreak-_0026-_005cnopagebreak">\pagebreak & \nopagebreak</a></li> +<li><a href="#index-g_t_005cpagenumbering-858"><code>\pagenumbering</code></a>: <a href="#g_t_005cpagenumbering">\pagenumbering</a></li> +<li><a href="#index-g_t_005cpageref-176"><code>\pageref</code></a>: <a href="#g_t_005cpageref">\pageref</a></li> +<li><a href="#index-g_t_005cpagestyle-860"><code>\pagestyle</code></a>: <a href="#g_t_005cpagestyle">\pagestyle</a></li> +<li><a href="#index-g_t_005cparagraph-169"><code>\paragraph</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005cparallel-659"><code>\parallel</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cparbox-899"><code>\parbox</code></a>: <a href="#g_t_005cparbox">\parbox</a></li> +<li><a href="#index-g_t_005cparindent-497"><code>\parindent</code></a>: <a href="#g_t_005cindent">\indent</a></li> +<li><a href="#index-g_t_005cparindent-294"><code>\parindent</code></a>: <a href="#minipage">minipage</a></li> +<li><a href="#index-g_t_005cparsep-280"><code>\parsep</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cparskip-501"><code>\parskip</code></a>: <a href="#g_t_005cparskip">\parskip</a></li> +<li><a href="#index-g_t_005cparskip-_0040r_007bexample_007d-284"><code>\parskip </code><span class="roman">example</span></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cpart-164"><code>\part</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005cpartial-660"><code>\partial</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cpartopsep-282"><code>\partopsep</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005cperp-661"><code>\perp</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cphi-662"><code>\phi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cpi-664"><code>\pi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cPi-663"><code>\Pi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cpm-665"><code>\pm</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cpmod-773"><code>\pmod</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cpoptabs-345"><code>\poptabs</code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005cpounds-936"><code>\pounds</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005cPr-774"><code>\Pr</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005cprec-666"><code>\prec</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cpreceq-667"><code>\preceq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cprime-668"><code>\prime</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cprod-669"><code>\prod</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cpropto-670"><code>\propto</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cprotect-419"><code>\protect</code></a>: <a href="#g_t_005cprotect">\protect</a></li> +<li><a href="#index-g_t_005cps-1059"><code>\ps</code></a>: <a href="#g_t_005cps">\ps</a></li> +<li><a href="#index-g_t_005cpsi-672"><code>\psi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cPsi-671"><code>\Psi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cpushtabs-347"><code>\pushtabs</code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005cput-315"><code>\put</code></a>: <a href="#g_t_005cput">\put</a></li> +<li><a href="#index-g_t_005craggedbottom-147"><code>\raggedbottom</code></a>: <a href="#g_t_005craggedbottom">\raggedbottom</a></li> +<li><a href="#index-g_t_005craggedleft-254"><code>\raggedleft</code></a>: <a href="#g_t_005craggedleft">\raggedleft</a></li> +<li><a href="#index-g_t_005craggedright-246"><code>\raggedright</code></a>: <a href="#g_t_005craggedright">\raggedright</a></li> +<li><a href="#index-g_t_005craisebox-900"><code>\raisebox</code></a>: <a href="#g_t_005craisebox">\raisebox</a></li> +<li><a href="#index-g_t_005crangle-673"><code>\rangle</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crbrace-674"><code>\rbrace</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crbrack-675"><code>\rbrack</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crceil-676"><code>\rceil</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cRe-677"><code>\Re</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cref-179"><code>\ref</code></a>: <a href="#g_t_005cref">\ref</a></li> +<li><a href="#index-g_t_005crefstepcounter-440"><code>\refstepcounter</code></a>: <a href="#g_t_005crefstepcounter">\refstepcounter</a></li> +<li><a href="#index-g_t_005crenewenvironment-409"><code>\renewenvironment</code></a>: <a href="#g_t_005cnewenvironment-_0026-_005crenewenvironment">\newenvironment & \renewenvironment</a></li> +<li><a href="#index-g_t_005crestorecr-465"><code>\restorecr</code></a>: <a href="#g_t_005cobeycr-_0026-_005crestorecr">\obeycr & \restorecr</a></li> +<li><a href="#index-g_t_005creversemarginpar-507"><code>\reversemarginpar</code></a>: <a href="#Marginal-notes">Marginal notes</a></li> +<li><a href="#index-g_t_005crfloor-678"><code>\rfloor</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crhd-679"><code>\rhd</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crho-680"><code>\rho</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cright-827"><code>\right</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005crightarrow-682"><code>\rightarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cRightarrow-681"><code>\Rightarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crightharpoondown-683"><code>\rightharpoondown</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crightharpoonup-684"><code>\rightharpoonup</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crightleftharpoons-685"><code>\rightleftharpoons</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005crightmargin-278"><code>\rightmargin</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005crm-95"><code>\rm</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005crmfamily-58"><code>\rmfamily</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005croman-428"><code>\roman</code></a>: <a href="#g_t_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</a></li> +<li><a href="#index-g_t_005crq-939"><code>\rq</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005crule-1012"><code>\rule</code></a>: <a href="#g_t_005crule">\rule</a></li> +<li><a href="#index-g_t_005cS-942"><code>\S</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005csavebox-901"><code>\savebox</code></a>: <a href="#g_t_005csavebox">\savebox</a></li> +<li><a href="#index-g_t_005csbox-902"><code>\sbox</code></a>: <a href="#g_t_005csbox">\sbox</a></li> +<li><a href="#index-g_t_005csc-97"><code>\sc</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cscriptsize-112"><code>\scriptsize</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005cscshape-74"><code>\scshape</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005csearrow-686"><code>\searrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csec-775"><code>\sec</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005csection-166"><code>\section</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005cselectfont-131"><code>\selectfont</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005csetcounter-436"><code>\setcounter</code></a>: <a href="#g_t_005csetcounter">\setcounter</a></li> +<li><a href="#index-g_t_005csetlength-446"><code>\setlength</code></a>: <a href="#g_t_005csetlength">\setlength</a></li> +<li><a href="#index-g_t_005csetminus-687"><code>\setminus</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csettodepth-450"><code>\settodepth</code></a>: <a href="#g_t_005csettodepth">\settodepth</a></li> +<li><a href="#index-g_t_005csettoheight-451"><code>\settoheight</code></a>: <a href="#g_t_005csettoheight">\settoheight</a></li> +<li><a href="#index-g_t_005csettowidth-452"><code>\settowidth</code></a>: <a href="#g_t_005csettowidth">\settowidth</a></li> +<li><a href="#index-g_t_005csf-99"><code>\sf</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005csffamily-72"><code>\sffamily</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005csharp-688"><code>\sharp</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cshortstack-316"><code>\shortstack</code></a>: <a href="#g_t_005cshortstack">\shortstack</a></li> +<li><a href="#index-g_t_005csigma-690"><code>\sigma</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cSigma-689"><code>\Sigma</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csignature-1061"><code>\signature</code></a>: <a href="#g_t_005csignature">\signature</a></li> +<li><a href="#index-g_t_005csim-691"><code>\sim</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csimeq-692"><code>\simeq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csin-776"><code>\sin</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005csinh-777"><code>\sinh</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005csl-101"><code>\sl</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cslshape-70"><code>\slshape</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005csmall-114"><code>\small</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005csmallint-693"><code>\smallint</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csmallskip-886"><code>\smallskip</code></a>: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></li> +<li><a href="#index-g_t_005csmallskipamount-887"><code>\smallskipamount</code></a>: <a href="#g_t_005cbigskip-_005cmedskip-_005csmallskip">\bigskip \medskip \smallskip</a></li> +<li><a href="#index-g_t_005csmile-694"><code>\smile</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cSPACE-871"><code>\SPACE</code></a>: <a href="#g_t_005cSPACE">\SPACE</a></li> +<li><a href="#index-g_t_005cspadesuit-695"><code>\spadesuit</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csqcap-696"><code>\sqcap</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csqcup-697"><code>\sqcup</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csqrt_005b_0040var_007broot_007d_005d_0040_007barg_0040_007d-831"><code>\sqrt[</code><var>root</var><code>]{arg}</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005csqsubset-698"><code>\sqsubset</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csqsubseteq-699"><code>\sqsubseteq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csqsupset-700"><code>\sqsupset</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csqsupseteq-701"><code>\sqsupseteq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005css-_0028_0040ss_007b_007d_0029-1009"><code>\ss (ß)</code></a>: <a href="#Non_002dEnglish-characters">Non-English characters</a></li> +<li><a href="#index-g_t_005cstackrel_0040_007b_0040var_007btext_007d_0040_007d_0040_007b_0040var_007brelation_007d_0040_007d-832"><code>\stackrel{</code><var>text</var><code>}{</code><var>relation</var><code>}</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cstar-702"><code>\star</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cstartbreaks-1062"><code>\startbreaks</code></a>: <a href="#g_t_005cstartbreaks">\startbreaks</a></li> +<li><a href="#index-g_t_005cstepcounter-441"><code>\stepcounter</code></a>: <a href="#g_t_005cstepcounter">\stepcounter</a></li> +<li><a href="#index-g_t_005cstop-1072"><code>\stop</code></a>: <a href="#Command-Line">Command Line</a></li> +<li><a href="#index-g_t_005cstopbreaks-1063"><code>\stopbreaks</code></a>: <a href="#g_t_005cstopbreaks">\stopbreaks</a></li> +<li><a href="#index-g_t_005csubparagraph-170"><code>\subparagraph</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005csubsection-167"><code>\subsection</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005csubset-703"><code>\subset</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csubseteq-704"><code>\subseteq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csubsubsection-168"><code>\subsubsection</code></a>: <a href="#Sectioning">Sectioning</a></li> +<li><a href="#index-g_t_005csucc-705"><code>\succ</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csucceq-706"><code>\succeq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csum-707"><code>\sum</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csup-778"><code>\sup</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005csupset-708"><code>\supset</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csupseteq-709"><code>\supseteq</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csurd-710"><code>\surd</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cswarrow-711"><code>\swarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005csymbol-916"><code>\symbol</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005ct-_0040r_007b_0028tie_002dafter-accent_0029_007d-983"><code>\t </code><span class="roman">(tie-after accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005cTAB-872"><code>\TAB</code></a>: <a href="#g_t_005cSPACE">\SPACE</a></li> +<li><a href="#index-g_t_005ctabbingsep-348"><code>\tabbingsep</code></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-g_t_005ctabcolsep-359"><code>\tabcolsep</code></a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-g_t_005ctableofcontents-1022"><code>\tableofcontents</code></a>: <a href="#Tables-of-contents">Tables of contents</a></li> +<li><a href="#index-g_t_005ctan-779"><code>\tan</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ctanh-780"><code>\tanh</code></a>: <a href="#Math-functions">Math functions</a></li> +<li><a href="#index-g_t_005ctau-712"><code>\tau</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ctelephone-1064"><code>\telephone</code></a>: <a href="#g_t_005ctelephone">\telephone</a></li> +<li><a href="#index-g_t_005cTeX-944"><code>\TeX</code></a>: <a href="#Text-symbols">Text symbols</a></li> +<li><a href="#index-g_t_005ctextbf-65"><code>\textbf</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextfloatsep-239"><code>\textfloatsep</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005ctextfraction-240"><code>\textfraction</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005ctextheight-159"><code>\textheight</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005ctextit-59"><code>\textit</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextmd-63"><code>\textmd</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextnormal-77"><code>\textnormal</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextrm-57"><code>\textrm</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextsc-73"><code>\textsc</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextsf-71"><code>\textsf</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextsl-69"><code>\textsl</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctexttt-75"><code>\texttt</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextup-67"><code>\textup</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctextwidth-160"><code>\textwidth</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005cthanks_0040_007b_0040var_007btext_007d_0040_007d-852"><code>\thanks{</code><var>text</var><code>}</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005ctheta-713"><code>\theta</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cthicklines-311"><code>\thicklines</code></a>: <a href="#g_t_005cthicklines">\thicklines</a></li> +<li><a href="#index-g_t_005cthinlines-312"><code>\thinlines</code></a>: <a href="#g_t_005cthinlines">\thinlines</a></li> +<li><a href="#index-g_t_005cthinspace-875"><code>\thinspace</code></a>: <a href="#g_t_005cthinspace">\thinspace</a></li> +<li><a href="#index-g_t_005cthispagestyle-866"><code>\thispagestyle</code></a>: <a href="#g_t_005cthispagestyle">\thispagestyle</a></li> +<li><a href="#index-g_t_005ctilde-804"><code>\tilde</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005ctimes-714"><code>\times</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ctiny-111"><code>\tiny</code></a>: <a href="#Font-sizes">Font sizes</a></li> +<li><a href="#index-g_t_005ctitle_0040_007b_0040var_007btext_007d_0040_007d-855"><code>\title{</code><var>text</var><code>}</code></a>: <a href="#g_t_005cmaketitle">\maketitle</a></li> +<li><a href="#index-g_t_005cto-715"><code>\to</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ctoday-1013"><code>\today</code></a>: <a href="#g_t_005ctoday">\today</a></li> +<li><a href="#index-g_t_005ctop-716"><code>\top</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ctopfraction-241"><code>\topfraction</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-g_t_005ctopmargin-161"><code>\topmargin</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005ctopsep-281"><code>\topsep</code></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-g_t_005ctopskip-162"><code>\topskip</code></a>: <a href="#Page-layout-parameters">Page layout parameters</a></li> +<li><a href="#index-g_t_005ctotalheight-458"><code>\totalheight</code></a>: <a href="#Predefined-lengths">Predefined lengths</a></li> +<li><a href="#index-g_t_005ctriangle-717"><code>\triangle</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ctriangleleft-718"><code>\triangleleft</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ctriangleright-719"><code>\triangleright</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005ctt-104"><code>\tt</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cttfamily-76"><code>\ttfamily</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005ctwocolumn-136"><code>\twocolumn</code></a>: <a href="#g_t_005ctwocolumn">\twocolumn</a></li> +<li><a href="#index-g_t_005ctypein-1067"><code>\typein</code></a>: <a href="#g_t_005ctypein">\typein</a></li> +<li><a href="#index-g_t_005ctypeout-1068"><code>\typeout</code></a>: <a href="#g_t_005ctypeout">\typeout</a></li> +<li><a href="#index-g_t_005cu-_0040r_007b_0028breve-accent_0029_007d-985"><code>\u </code><span class="roman">(breve accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005cunboldmath-524"><code>\unboldmath</code></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-g_t_005cunderbrace_0040_007bmath_0040_007d-833"><code>\underbrace{math}</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cunderline_0040_007btext_0040_007d-834"><code>\underline{text}</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cunitlength-300"><code>\unitlength</code></a>: <a href="#picture">picture</a></li> +<li><a href="#index-g_t_005cunlhd-720"><code>\unlhd</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cunrhd-721"><code>\unrhd</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cuparrow-723"><code>\uparrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cUparrow-722"><code>\Uparrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cupdownarrow-725"><code>\updownarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cUpdownarrow-724"><code>\Updownarrow</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cuplus-726"><code>\uplus</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cupshape-68"><code>\upshape</code></a>: <a href="#Font-styles">Font styles</a></li> +<li><a href="#index-g_t_005cupsilon-728"><code>\upsilon</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cUpsilon-727"><code>\Upsilon</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cusebox-903"><code>\usebox</code></a>: <a href="#g_t_005cusebox">\usebox</a></li> +<li><a href="#index-g_t_005cusecounter-431"><code>\usecounter</code></a>: <a href="#g_t_005cusecounter">\usecounter</a></li> +<li><a href="#index-g_t_005cusefont-132"><code>\usefont</code></a>: <a href="#Low_002dlevel-font-commands">Low-level font commands</a></li> +<li><a href="#index-g_t_005cusepackage-49"><code>\usepackage</code></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-g_t_005cv-_0040r_007b_0028breve-accent_0029_007d-987"><code>\v </code><span class="roman">(breve accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005cvalue-434"><code>\value</code></a>: <a href="#g_t_005cvalue">\value</a></li> +<li><a href="#index-g_t_005cvarepsilon-729"><code>\varepsilon</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvarphi-730"><code>\varphi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvarpi-731"><code>\varpi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvarrho-732"><code>\varrho</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvarsigma-733"><code>\varsigma</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvartheta-734"><code>\vartheta</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvdash-735"><code>\vdash</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvdots-835"><code>\vdots</code></a>: <a href="#Math-Miscellany">Math Miscellany</a></li> +<li><a href="#index-g_t_005cvec-806"><code>\vec</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cvector-318"><code>\vector</code></a>: <a href="#g_t_005cvector">\vector</a></li> +<li><a href="#index-g_t_005cvee-736"><code>\vee</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cverb-385"><code>\verb</code></a>: <a href="#g_t_005cverb">\verb</a></li> +<li><a href="#index-g_t_005cvert-738"><code>\vert</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cVert-737"><code>\Vert</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cvfill-888"><code>\vfill</code></a>: <a href="#g_t_005cvfill">\vfill</a></li> +<li><a href="#index-g_t_005cvline-363"><code>\vline</code></a>: <a href="#g_t_005cvline">\vline</a></li> +<li><a href="#index-g_t_005cvspace-889"><code>\vspace</code></a>: <a href="#g_t_005cvspace">\vspace</a></li> +<li><a href="#index-g_t_005cwedge-739"><code>\wedge</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cwidehat-808"><code>\widehat</code></a>: <a href="#Math-accents">Math accents</a></li> +<li><a href="#index-g_t_005cwidth-455"><code>\width</code></a>: <a href="#Predefined-lengths">Predefined lengths</a></li> +<li><a href="#index-g_t_005cwp-740"><code>\wp</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cwr-741"><code>\wr</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cxi-743"><code>\xi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cXi-742"><code>\Xi</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005cyear-444"><code>\year</code></a>: <a href="#g_t_005cday-_005cmonth-_005cyear">\day \month \year</a></li> +<li><a href="#index-g_t_005czeta-744"><code>\zeta</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005c_0040_007b-911"><code>\{</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_007c-534"><code>\|</code></a>: <a href="#Math-symbols">Math symbols</a></li> +<li><a href="#index-g_t_005c_0040_007d-912"><code>\}</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_007e-914"><code>\~</code></a>: <a href="#Reserved-characters">Reserved characters</a></li> +<li><a href="#index-g_t_005c_007e-_0040r_007b_0028tilde-accent_0029_007d-966"><code>\~ </code><span class="roman">(tilde accent)</span></a>: <a href="#Accents">Accents</a></li> +<li><a href="#index-g_t_005e-530"><code>^</code></a>: <a href="#Subscripts-_0026-Superscripts">Subscripts & Superscripts</a></li> +<li><a href="#index-g_t_005f-529"><code>_</code></a>: <a href="#Subscripts-_0026-Superscripts">Subscripts & Superscripts</a></li> +<li><a href="#index-a4paper-_0040r_007boption_007d-24"><code>a4paper </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-a5paper-_0040r_007boption_007d-25"><code>a5paper </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-abstract-_0040r_007benvironment_007d-188"><code>abstract </code><span class="roman">environment</span></a>: <a href="#abstract">abstract</a></li> +<li><a href="#index-array-_0040r_007benvironment_007d-190"><code>array </code><span class="roman">environment</span></a>: <a href="#array">array</a></li> +<li><a href="#index-article-_0040r_007bclass_007d-12"><code>article </code><span class="roman">class</span></a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-b5paper-_0040r_007boption_007d-26"><code>b5paper </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-book-_0040r_007bclass_007d-14"><code>book </code><span class="roman">class</span></a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-center-_0040r_007benvironment_007d-195"><code>center </code><span class="roman">environment</span></a>: <a href="#center">center</a></li> +<li><a href="#index-description-_0040r_007benvironment_007d-200"><code>description </code><span class="roman">environment</span></a>: <a href="#description">description</a></li> +<li><a href="#index-displaymath-_0040r_007benvironment_007d-516"><code>displaymath </code><span class="roman">environment</span></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-displaymath-_0040r_007benvironment_007d-206"><code>displaymath </code><span class="roman">environment</span></a>: <a href="#displaymath">displaymath</a></li> +<li><a href="#index-document-_0040r_007benvironment_007d-207"><code>document </code><span class="roman">environment</span></a>: <a href="#document">document</a></li> +<li><a href="#index-draft-_0040r_007boption_007d-30"><code>draft </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-enumerate-_0040r_007benvironment_007d-208"><code>enumerate </code><span class="roman">environment</span></a>: <a href="#enumerate">enumerate</a></li> +<li><a href="#index-eqnarray-_0040r_007benvironment_007d-220"><code>eqnarray </code><span class="roman">environment</span></a>: <a href="#eqnarray">eqnarray</a></li> +<li><a href="#index-equation-_0040r_007benvironment_007d-517"><code>equation </code><span class="roman">environment</span></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-equation-_0040r_007benvironment_007d-228"><code>equation </code><span class="roman">environment</span></a>: <a href="#equation">equation</a></li> +<li><a href="#index-executivepaper-_0040r_007boption_007d-27"><code>executivepaper </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-figure-231"><code>figure</code></a>: <a href="#figure">figure</a></li> +<li><a href="#index-final-_0040r_007boption_007d-31"><code>final </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-fleqn-_0040r_007boption_007d-32"><code>fleqn </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-flushleft-_0040r_007benvironment_007d-242"><code>flushleft </code><span class="roman">environment</span></a>: <a href="#flushleft">flushleft</a></li> +<li><a href="#index-flushright-_0040r_007benvironment_007d-250"><code>flushright </code><span class="roman">environment</span></a>: <a href="#flushright">flushright</a></li> +<li><a href="#index-itemize-_0040r_007benvironment_007d-258"><code>itemize </code><span class="roman">environment</span></a>: <a href="#itemize">itemize</a></li> +<li><a href="#index-landscape-_0040r_007boption_007d-33"><code>landscape </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-legalpaper-_0040r_007boption_007d-28"><code>legalpaper </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-leqno-_0040r_007boption_007d-34"><code>leqno </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-letter-285"><code>letter</code></a>: <a href="#letter">letter</a></li> +<li><a href="#index-letter-_0040r_007bclass_007d-15"><code>letter </code><span class="roman">class</span></a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-letterpaper-_0040r_007boption_007d-29"><code>letterpaper </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-list-286"><code>list</code></a>: <a href="#list">list</a></li> +<li><a href="#index-lR-box-301"><code>lR box</code></a>: <a href="#picture">picture</a></li> +<li><a href="#index-lrbox-897"><code>lrbox</code></a>: <a href="#lrbox">lrbox</a></li> +<li><a href="#index-math-_0040r_007benvironment_007d-515"><code>math </code><span class="roman">environment</span></a>: <a href="#Math-formulas">Math formulas</a></li> +<li><a href="#index-math-_0040r_007benvironment_007d-288"><code>math </code><span class="roman">environment</span></a>: <a href="#math">math</a></li> +<li><a href="#index-minipage-_0040r_007benvironment_007d-290"><code>minipage </code><span class="roman">environment</span></a>: <a href="#minipage">minipage</a></li> +<li><a href="#index-notitlepage-_0040r_007boption_007d-37"><code>notitlepage </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-onecolumn-_0040r_007boption_007d-39"><code>onecolumn </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-oneside-_0040r_007boption_007d-41"><code>oneside </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-openany-_0040r_007boption_007d-44"><code>openany </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-openbib-_0040r_007boption_007d-35"><code>openbib </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-openright-_0040r_007boption_007d-43"><code>openright </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-picture-297"><code>picture</code></a>: <a href="#picture">picture</a></li> +<li><a href="#index-quotation-319"><code>quotation</code></a>: <a href="#quotation">quotation</a></li> +<li><a href="#index-quote-323"><code>quote</code></a>: <a href="#quote">quote</a></li> +<li><a href="#index-report-_0040r_007bclass_007d-13"><code>report </code><span class="roman">class</span></a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-slides-_0040r_007bclass_007d-16"><code>slides </code><span class="roman">class</span></a>: <a href="#Document-classes">Document classes</a></li> +<li><a href="#index-tabbing-_0040r_007benvironment_007d-327"><code>tabbing </code><span class="roman">environment</span></a>: <a href="#tabbing">tabbing</a></li> +<li><a href="#index-table-349"><code>table</code></a>: <a href="#table">table</a></li> +<li><a href="#index-tabular-_0040r_007benvironment_007d-352"><code>tabular </code><span class="roman">environment</span></a>: <a href="#tabular">tabular</a></li> +<li><a href="#index-thebibliography-364"><code>thebibliography</code></a>: <a href="#thebibliography">thebibliography</a></li> +<li><a href="#index-theorem-_0040r_007benvironment_007d-374"><code>theorem </code><span class="roman">environment</span></a>: <a href="#theorem">theorem</a></li> +<li><a href="#index-titlepage-_0040r_007benvironment_007d-376"><code>titlepage </code><span class="roman">environment</span></a>: <a href="#titlepage">titlepage</a></li> +<li><a href="#index-titlepage-_0040r_007boption_007d-36"><code>titlepage </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-twocolumn-_0040r_007boption_007d-40"><code>twocolumn </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-twoside-_0040r_007boption_007d-42"><code>twoside </code><span class="roman">option</span></a>: <a href="#Document-class-options">Document class options</a></li> +<li><a href="#index-verbatim-_0040r_007benvironment_007d-379"><code>verbatim </code><span class="roman">environment</span></a>: <a href="#verbatim">verbatim</a></li> +<li><a href="#index-verse-_0040r_007benvironment_007d-388"><code>verse </code><span class="roman">environment</span></a>: <a href="#verse">verse</a></li> + </ul></body></html> + diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf Binary files differnew file mode 100644 index 00000000000..99e78eebdbd --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.pdf diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi new file mode 100644 index 00000000000..f9c7070c6a7 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi @@ -0,0 +1,6474 @@ +\input texinfo +@c $Id: latex2e.texi 234 2008-06-10 18:27:54Z karl $ +@comment %**start of header (This is for running Texinfo on a region.) +@setfilename latex2e.info +@set UPDATED June 2008 +@set VERSION 2.0 +@settitle @LaTeX{}2e reference manual @value{VERSION} +@comment %**end of header (This is for running Texinfo on a region.) + +@c xx merge http://ctan.org/tex-archive/info/latex-info/ +@c xx latex 2.09 should be pretty much complete now, but +@c new stuff in latex2e is surely missing. + +@copying +This document is version @value{VERSION} (@value{UPDATED}) of an +unofficial reference manual for @LaTeX{}, a document preparation +system. @LaTeX{} is a macro package for @TeX{}. + +This was originally translated from @file{LATEX.HLP} v1.0a in the VMS +Help Library. The pre-translation version was written by +George@tie{}D. Greenwade of Sam Houston State University. The +@LaTeX{}@tie{}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{}}, by Sheldon Green, and the +@cite{@LaTeX{} Command Summary} (for @LaTeX{} 2.09) by L.@tie{}Botway +and C.@tie{}Biemesderfer (published by the @TeX{} Users Group as +@cite{@TeX{}niques} number 10), as reference material (text was not +directly copied). + +Copyright @copyright{} 2007, 2008 Karl Berry.@* +Copyright @copyright{} 1988, 1994, 2007 Stephen Gilmore.@* +Copyright @copyright{} 1994, 1995, 1996 Torsten Martinsen. + +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. + +@ignore +Permission is granted to process this file through TeX and print the +results, provided the printed document carries copying permission +notice identical to this one except for the removal of this paragraph +(this paragraph not being relevant to the printed manual). +@end ignore + +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. + +Permission is granted to copy and distribute translations of this manual +into another language, under the above conditions for modified versions. +@end copying + +@dircategory TeX +@direntry +* LaTeX2e: (latex2e). Unofficial LaTeX reference manual. +@end direntry + +@tex +\global\hbadness=4444 % don't complain much +@end tex + +@titlepage +@title @LaTeX{}: Structured documents for @TeX{} +@subtitle unofficial @LaTeX{} reference manual +@subtitle version @value{VERSION}, @value{UPDATED} +@author +@page +@vskip 0pt plus 1filll +@insertcopying +@end titlepage + +@shortcontents +@contents + +@node Top +@top @LaTeX{}2e + +This document is version @value{VERSION} (@value{UPDATED}) 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. + +@cindex Knuth, Donald E. +@cindex Lamport, Leslie +@cindex @LaTeX{} Project team +@LaTeX{} is implemented as a macro package for Donald@tie{}E. Knuth's +@TeX{} typesetting program. @LaTeX{} was originally created by Leslie +Lamport; it is now maintained by a group of volunteers +(@url{http://latex-project.org}). 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. + +@menu +* Overview:: What is @LaTeX{}? +* Starting & ending:: The standard beginning and end of a document. +* Document classes:: Some of the various classes available. +* Typefaces:: And fonts, such as bold, italics etc. +* Layout:: Controlling the page layout. +* Sectioning:: How to section properly. +* Cross references:: Automatic referencing. +* Environments:: Such as enumerate & itemize. +* Line breaking:: Influencing line breaks. +* Page breaking:: Influencing page breaks. +* Footnotes:: How to produce footnotes. +* Definitions:: Define your own commands etc. +* Counters:: Internal counters used by @LaTeX{}. +* Lengths:: The length commands. +* Making paragraphs:: Paragraph commands. +* Math formulas:: How to create mathematical formulas. +* Modes:: Paragraph, Math or LR modes. +* Page Styles:: Various styles of page layout. +* Spaces:: Horizontal and vertical space. +* Boxes:: Making boxes. +* Special insertions:: Inserting reserved and special characters. +* Splitting the input:: Dealing with big files by splitting. +* Front/back matter:: Tables of contents, glossaries, indexes. +* Letters:: The letter class. +* Terminal Input/Output:: User interaction. +* Command Line:: System-independent command-line behavior. +* Document templates:: Starter templates for various document classes. +* Command Index:: Alphabetical list of @LaTeX{} commands. +* Concept Index:: General index. +@end menu + + +@node Overview +@chapter Overview of @LaTeX{} + +@cindex overview of @LaTeX{} +@cindex @LaTeX{} overview + +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: + +@enumerate +@item +A main output file, which is one of: + +@enumerate +@item +If invoked as @command{latex}, a ``Device Independent'' (@file{.dvi}) +file. This contains commands that can be translated into commands for +a variety of output devices. You can view such @file{.dvi} output of +@LaTeX{} by using a program such as @command{xdvi} (display directly) +or @command{dvips} (convert to PostScript). + +@item +If invoked as @command{pdflatex}, a ``Portable Document Format'' +(@file{.pdf}) 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} produced from the +same document. +@end enumerate + +There are other less-common variants of @LaTeX{} (and @TeX{}) as well, +which can produce HTML, XML, and other things. + +@item +A ``transcript'' or @file{.log} file that contains summary information and +diagnostic messages for any errors discovered in the input file. + +@item +An ``auxiliary'' or @file{.aux} file. This is used by @LaTeX{} itself, for +things such as sectioning. +@end enumerate + +A @LaTeX{} command begins with the command name, which consists of a +@code{\} followed by either (a)@tie{}a string of letters or (b)@tie{}a +single non-letter. Arguments contained in square brackets, @code{[]}, +are optional while arguments contained in braces, @code{@{@}}, are +required. + +@LaTeX{} is case sensitive. Enter all commands in lower case unless +explicitly directed to do otherwise. + + +@node Starting & ending +@chapter Starting & ending + +@cindex starting & ending +@cindex ending & starting + +A minimal input file looks like the following: + +@example +\documentclass@{@var{class}@} +\begin@{document@} +@var{your text} +\end@{document@} +@end example + +@noindent +where the @var{class} is a valid document class for @LaTeX{}. +@xref{Document classes}, for details of the various document classes +available locally. + +@cindex preamble, defined +You may include other @LaTeX{} commands between the @code{\documentclass} +and the @code{\begin@{document@}} commands (this area is called the +@dfn{preamble}). + + +@node Document classes +@chapter Document classes + +@cindex document classes +@cindex classes of documents +@findex \documentclass + +The class of a given document is defined with the command: + +@example +\documentclass[@var{options}]@{@var{class}@} +@end example + +@noindent +The @code{\documentclass} command must be the first command in a +@LaTeX{} source file. + +@findex article @r{class} +@findex report @r{class} +@findex book @r{class} +@findex letter @r{class} +@findex slides @r{class} +Built-in @LaTeX{} document @var{class} names are (many other document +classes are available as add-ons; @pxref{Overview}): + +@example +article report book letter slides +@end example + +@c xx briefly describe each one + +Standard @var{options} are described below. + +@menu +* Document class options:: Global options. +@end menu + + +@node Document class options +@section Document class options + +@cindex document class options +@cindex options, document class +@cindex class options +@cindex global options + +You can specify so-called @dfn{global options} or @dfn{class options} +to the @code{\documentclass} command by enclosing them in square +brackets as usual. To specify more than one @var{option}, separate +them with a comma: + +@example +\documentclass[@var{option1},@var{option2},...]@{@var{class}@} +@end example + +Here is the list of the standard class options. + +@findex 10pt @r{option} +@findex 11pt @r{option} +@findex 12pt @r{option} +All of the standard classes except @code{slides} accept the following +options for selecting the typeface size (default is @code{10pt}): + +@example +10pt 11pt 12pt +@end example + +@findex a4paper @r{option} +@findex a5paper @r{option} +@findex b5paper @r{option} +@findex executivepaper @r{option} +@findex legalpaper @r{option} +@findex letterpaper @r{option} +All of the standard classes accept these options for selecting the paper +size (default is @code{letterpaper}): + +@example +a4paper a5paper b5paper executivepaper legalpaper letterpaper +@end example + +@findex draft @r{option} +@findex final @r{option} +@findex fleqn @r{option} +@findex landscape @r{option} +@findex leqno @r{option} +@findex openbib @r{option} +@findex titlepage @r{option} +@findex notitlepage @r{option} +Miscellaneous other options: + +@table @code +@item draft, final +@cindex black boxes, omitting +mark/do not mark overfull boxes with a big black box; default is @code{final}. +@item fleqn +Put displayed formulas flush left; default is centered. +@item landscape +Selects landscape format; default is portrait. +@item leqno +Put equation numbers on the left side of equations; default is the right side. +@item openbib +Use ``open'' bibliography format. +@item titlepage, notitlepage +Specifies whether the title page is separate; default depends on the class. +@end table + +These options are not available with the slides class: + +@findex onecolumn @r{option} +@findex twocolumn @r{option} +@findex oneside @r{option} +@findex twoside @r{option} +@findex openright @r{option} +@findex openany @r{option} +@table @code +@item onecolumn +@itemx twocolumn +Typeset in one or two columns; default is @code{onecolumn}. + +@item oneside +@itemx twoside +@findex \evensidemargin +@findex \oddsidemargin +Selects one- or two-sided layout; default is @code{oneside}, except +for the @code{book} class. + +The @code{\evensidemargin} (@code{\oddsidemargin} 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} is +40% of the difference between @code{\paperwidth} and @code{\textwidth} +with @code{\evensidemargin} the remainder. + +@item openright +@itemx openany +Determines if a chapter should start on a +right-hand page; default is @code{openright} for book. +@end table + +The @code{slides} class offers the option @code{clock} for printing +the time at the bottom of each note. + + +@cindex packages, loading +@cindex loading additional packages +@findex \usepackage +Additional packages are loaded like this: + +@example +\usepackage[@var{options}]@{@var{pkg}@} +@end example + +To specify more than one @var{pkg}, you can separate them with a +comma, or use multiple @code{\usepackage} commands. + +@cindex global options +@cindex options, global +Any options given in the @code{\documentclass} command that are unknown +by the selected document class are passed on to the packages loaded with +@code{\usepackage}. + + +@node Typefaces +@chapter Typefaces + +@cindex typefaces +@cindex fonts + +Two important aspects of selecting a @dfn{font} are specifying a size +and a style. The @LaTeX{} commands for doing this are described here. + +@menu +* Font styles:: Select roman, italics etc. +* Font sizes:: Select point size. +* Low-level font commands:: Select encoding, family, series, shape. +@end menu + + +@node Font styles +@section Font styles + +@cindex font styles +@cindex typeface styles +@cindex styles of text + +The following type style commands are supported by @LaTeX{}. + +These commands are used like @code{\textit@{italic text@}}. 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. + +The declaration forms are cumulative; i.e., you can say either +@code{\sffamily\bfseries} or @code{\bfseries\sffamily} to get bold +sans serif. + +You can also use the environment form of the declaration forms; for instance, +@code{\begin@{ttfamily@}...\end@{ttfamily@}}. + +@table @code +@item \textrm (\rmfamily) +@findex \textrm +@findex \rmfamily +Roman. + +@item \textit (\itshape) +@findex \textit +@findex \itshape +Italics. + +@item \emph +@findex \emph +@cindex emphasis +Emphasis (switches between @code{\textit} and @code{\textrm}). + +@item \textmd (\mdseries) +@findex \textmd +@findex \mdseries +Medium weight (default). + +@item \textbf (\bfseries) +@findex \textbf +@findex \bfseries +Boldface. +@item \textup (\upshape) +@findex \textup +@findex \upshape +Upright (default). The opposite of slanted. +@item \textsl (\slshape) +@findex \textsl +@findex \slshape +Slanted. +@item \textsf (\sffamily) +@findex \textsf +@findex \sffamily +Sans serif. +@item \textsc (\scshape) +@findex \textsc +@findex \scshape +Small caps. +@item \texttt (\ttfamily) +@findex \texttt +@findex \ttfamily +Typewriter. +@item \textnormal (\normalfont) +@findex \textnormal +@findex \normalfont +Main document font. +@item \mathrm +@findex \mathrm +Roman, for use in math mode. +@item \mathbf +@findex \mathbf +Boldface, for use in math mode. +@item \mathsf +@findex \mathsf +Sans serif, for use in math mode. +@item \mathtt +@findex \mathtt +Typewriter, for use in math mode. + +@item \mathit +@itemx (\mit) +Italics, for use in math mode. + +@item \mathnormal +@findex \mathnormal +For use in math mode, e.g. inside another type style declaration. +@item \mathcal +@findex \mathcal +`Calligraphic' letters, for use in math mode. +@end table + +In addition, the command +@code{\mathversion@{bold@}} +@findex \mathversion +can be used for switching to bold letters and symbols in +formulas. @code{\mathversion@{normal@}} restores the default. + +@LaTeX{} also provides these commands, which unconditionally switch to +the given style, that is, are @emph{not} cumulative. They are used +differently than the above commands, too: @code{@{\@var{cmd} ...@}} +instead of @code{\@var{cmd}@{...@}}. These are two very different +things. + +@ftable @code +@item \bf +@cindex bold font +Switch to @b{bold face}. + +@item \cal +@cindex script letters for math +@cindex calligraphic letters for math +Switch to calligraphic letters for math. + +@item \em +@cindex emphasis +Emphasis (italics within roman, roman within italics). + +@item \it +@cindex italic font +Italics. + +@item \rm +@cindex roman font +Roman. + +@item \sc +@cindex small caps font +Small caps. + +@item \sf +@cindex sans serif font +Sans serif. + +@item \sl +@cindex slanted font +@cindex oblique font +Slanted (oblique). + +@item \tt +@cindex typewriter font +@cindex monospace font +@cindex fixed-width font +Typewriter (monospace, fixed-width). + +@end ftable + + +@node Font sizes +@section Font sizes +@cindex font sizes +@cindex typeface sizes +@cindex sizes of text + +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{11pt}, and +@samp{12pt} document size options, respectively (@pxref{Document class +options}). + +@findex \tiny +@findex \scriptsize +@findex \footnotesize +@findex \small +@findex \normalsize +@findex \large +@findex \Large +@findex \LARGE +@findex \huge +@findex \Huge + +@multitable {@code{\normalsize} (default)} {24.88} {24.88} {24.88} +@headitem Command @tab @code{10pt} @tab @code{11pt} @tab @code{12pt} +@item @code{\tiny} +@tab 5 @tab 6 @tab 6 +@item @code{\scriptsize} +@tab 7 @tab 8 @tab 8 +@item @code{\footnotesize} +@tab 8 @tab 9 @tab 10 +@item @code{\small} +@tab 9 @tab 10 @tab 10.95 +@item @code{\normalsize} (default) +@tab 10 @tab 10.95 @tab 12 +@item @code{\large} +@tab 12 @tab 12 @tab 14.4 +@item @code{\Large} +@tab 14.4 @tab 14.4 @tab 17.28 +@item @code{\LARGE} +@tab 17.28 @tab 17.28 @tab 20.74 +@item @code{\huge} +@tab 20.74 @tab 20.74 @tab 24.88 +@item @code{\Huge} +@tab 24.88 @tab 24.88 @tab 24.88 +@end multitable + +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@}}. + + +@node Low-level font commands +@section Low-level font commands +@cindex low-level font commands +@cindex font commands, low-level + +These commands are primarily intended for writers of macros and +packages. The commands listed here are only a subset of the available +ones. + +@table @code +@item \fontencoding@{enc@} +@findex \fontencoding +Select font encoding. Valid encodings include @code{OT1} and @code{T1}. + +@item \fontfamily@{family@} +@findex \fontfamily +Select font family. Valid families include: + +@itemize @bullet +@item @code{cmr} for Computer Modern Roman +@item @code{cmss} for Computer Modern Sans Serif +@item @code{cmtt} for Computer Modern Typewriter +@end itemize + +and numerous others. + +@item \fontseries@{series@} +@findex \fontseries +Select font series. Valid series include: + +@itemize @bullet +@item @code{m} Medium (normal) +@item @code{b} Bold +@item @code{c} Condensed +@item @code{bc} Bold condensed +@item @code{bx} Bold extended +@end itemize + +and various other combinations. + +@item \fontshape@{shape@} +@findex \fontshape +Select font shape. Valid shapes are: + +@itemize @bullet +@item @code{n} Upright (normal) +@item @code{it} Italic +@item @code{sl} Slanted (oblique) +@item @code{sc} Small caps +@item @code{ui} Upright italics +@item @code{ol} Outline +@end itemize + +The two last shapes are not available for most font families. + +@item \fontsize@{size@}@{skip@} +@findex \fontsize +@findex \baselineskip +Set font size. The first parameter is the font size to switch to and +the second is the line spacing to use; this is stored in a parameter +named @code{\baselineskip}. The unit of both parameters defaults to +pt. The default @code{\baselineskip} for the Computer Modern typeface +is 1.2 times the @code{\fontsize}. + +@findex \baselinestretch +@cindex @code{setspace} package +The line spacing is also multiplied by the value of the +@code{\baselinestretch} parameter when the type size changes; the +default is 1. However, the best way to ``double space'' a document, +if you should be unlucky enough to have to produce such, is to use the +@code{setspace} package; see +@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace}. + +@item \selectfont +@findex \selectfont +The changes made by calling the four font commands described above do +not come into effect until @code{\selectfont} is called. + +@item \usefont@{enc@}@{family@}@{series@}@{shape@} +@findex \usefont +The same as invoking @code{\fontencoding}, @code{\fontfamily}, +@code{\fontseries} and @code{\fontshape} with the given parameters, +followed by @code{\selectfont}. +@end table + + +@node Layout +@chapter Layout +@cindex layout commands + +Miscellaneous commands for controlling the general layout of the page. + +@menu +* \onecolumn:: Use one-column layout. +* \twocolumn:: Use two-column layout. +* \flushbottom:: Make all text pages the same height. +* \raggedbottom:: Allow text pages of differing height. +* Page layout parameters:: \headheight \footskip. +@end menu + + +@node \onecolumn +@section @code{\onecolumn} +@findex \onecolumn +@cindex one-column output + +The @code{\onecolumn} declaration starts a new page and produces +single-column output. This is the default. + + +@node \twocolumn +@section @code{\twocolumn} +@findex \twocolumn +@cindex multicolumn text +@cindex two-column output + +Synopsis: + +@example +\twocolumn[@var{text1col}] +@end example + +The @code{\twocolumn} declaration starts a new page and produces +two-column output. If the optional @var{text1col} argument is present, +it is typeset in one-column mode before the two-column typesetting +starts. + +These parameters control typesetting in two-column output: + +@ftable @code +@item \columnsep +The distance between columns (35pt by default). + +@item \columnseprule +The width of the rule between columns; the default is 0pt, so there is no rule. + +@item \columnwidth +The width of the current column; this is equal to @code{\textwidth} in +single-column text. + +@end ftable + +These parameters control float behavior in two-column output: + +@ftable @code +@item \dbltopfraction +Maximum fraction at the top of a two-column page that may be occupied +by floats. Default @samp{.7}, can be usefully redefined to (say) +@samp{.9} to avoid going to float pages so soon. + +@item \dblfloatpagefraction +The minimum fraction of a float page that must be occupied by floats, +for a two-column float page. Default @samp{.5}. + +@item \dblfloatsep +Distance between floats at the top or bottom of a two-column float +page. Default @samp{12pt plus2pt minus2pt} for @samp{10pt} and +@samp{11pt} documents, @samp{14pt plus2pt minus4pt} for @samp{12pt}. + +@item \dbltextfloatsep +Distance between a multi-column float at the top or bottom of a page +and the main text. Default @samp{20pt plus2pt minus4pt}. + +@end ftable + + +@node \flushbottom +@section @code{\flushbottom} + +@findex \flushbottom + +The @code{\flushbottom} declaration makes all text pages the same +height, adding extra vertical space where necessary to fill out the +page. + +This is the default if @code{twocolumn} mode is selected +(@pxref{Document class options}). + + +@node \raggedbottom +@section @code{\raggedbottom} +@findex \raggedbottom +@cindex stretch, omitting vertical + +The @code{\raggedbottom} declaration makes all pages the natural +height of the material on that page. No rubber lengths will be +stretched. + + +@node Page layout parameters +@section Page layout parameters + +@cindex page layout parameters +@cindex parameters, page layout +@cindex layout, page parameters for +@cindex header, parameters for +@cindex footer, parameters for +@cindex running header and footer + +@ftable @code +@item \headheight +Height of the box that contains the running head. Default is +@samp{30pt}, except in the @code{book} class, where it varies with the +type size. + +@item \headsep +Vertical distance between the bottom of the header line and the top of +the main text. Default is @samp{25pt}, except in the @code{book} +class, where it varies with the type size. + +@item \footskip +Distance from the baseline of the last line of text to the baseline of +the page footer. Default is @samp{30pt}, except in the @code{book} +class, where it varies with the type size. + +@item \linewidth +Width of the current line; the default varies with the font size, +paper width, two-column mode, etc. For an @code{article} document in +@samp{10pt}, it's set to @samp{345pt}; in two-column mode, that +becomes @samp{229.5pt}. + +@item \textheight +The normal vertical height of the page body; the default varies with +the font size, document class, etc. For an @code{article} or +@code{report} document in @samp{10pt}, it's set to +@samp{43\baselineskip}; for @code{book}, it's @samp{41\baselineskip}. +For @samp{11pt}, it's @samp{38\baselineskip} and for @samp{12pt}, +@samp{36\baselineskip}. + +@item \textwidth +The normal horizontal width of the page body; the default varies as +usual. For an @code{article} or @code{report} document, it's +@samp{345pt} at @samp{10pt}, @samp{360pt} at @samp{11pt}, and +@samp{390pt} at @samp{12pt}. For a @code{book} document, it's +@samp{4.5in} at @samp{10pt}, and @samp{5in} at @samp{11pt} or @samp{12pt}. + +@item \topmargin +Space between the top of the @TeX{} page (one inch from the top of the +paper, by default) and the top of the header. The default is computed +based on many other parameters: @code{\paperheight @minus{} 2in @minus{} +\headheight @minus{} \headsep @minus{} \textheight @minus{} \footskip}, and +then divided by two. + +@item \topskip +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} at @samp{10pt}. + +@end ftable + + +@node Sectioning +@chapter Sectioning +@cindex sectioning + +Sectioning commands provide the means to structure your text into units: + +@ftable @code +@item \part +@item \chapter +(report and book class only) +@item \section +@item \subsection +@item \subsubsection +@item \paragraph +@item \subparagraph +@end ftable + +All sectioning commands take the same general form, e.g., + +@example +\chapter[@var{toctitle}]@{@var{title}@} +@end example + +In addition to providing the heading @var{title} in the main text, the +section title can appear in two other places: + +@enumerate +@item +The table of contents. +@item +The running head at the top of the page. +@end enumerate + +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} that, when given, specifies the text for these other +places. + +@cindex *-form of sectioning commands +Also, all sectioning commands have @code{*}-forms that print +@var{title} as usual, but do not include a number and do not make an +entry in the table of contents. For instance: + +@example +\section*@{Preamble@} +@end example + +@findex \appendix +@cindex appendix, creating +The @code{\appendix} command changes the way following sectional units +are numbered. The @code{\appendix} command itself generates no text +and does not affect the numbering of parts. The normal use of this +command is something like + +@example +\chapter@{A Chapter@} +@dots{} +\appendix +\chapter@{The First Appendix@} +@end example + + +@node Cross references +@chapter Cross references +@cindex cross references + +One reason for numbering things like figures and equations is to refer +the reader to them, as in ``See Figure 3 for more details.'' + +@menu +* \label:: Assign a symbolic name to a piece of text. +* \pageref:: Refer to a page number. +* \ref:: Refer to a section, figure or similar. +@end menu + + +@node \label +@section @code{\label} +@findex \label + +Synopsis: + +@example +\label@{@var{key}@} +@end example + +A @code{\label} command appearing in ordinary text assigns to +@var{key} the number of the current sectional unit; one appearing +inside a numbered environment assigns that number to @var{key}. + +A @var{key} name can consist of any sequence of letters, digits, or +punctuation characters. Upper and lowercase letters are distinguished. + +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: + +@table @code +@item ch +for chapters +@item sec +for lower-level sectioning commands +@item fig +for figures +@item tab +for tables +@item eq +for equations +@end table + +Thus, a label for a figure would look like @code{fig:snark} or +@code{fig.snark}. + + +@node \pageref +@section @code{\pageref@{@var{key}@}} +@findex \pageref +@cindex cross referencing with page number +@cindex page number, cross referencing + +Synopsis: + +@example +\pageref@{@var{key}@} +@end example + +The @code{\pageref}@{@var{key}@} command produces the page number of +the place in the text where the corresponding +@code{\label}@{@var{key}@} command appears. + + +@node \ref +@section @code{\ref@{@var{key}@}} +@findex \ref +@cindex cross referencing, symbolic +@cindex section number, cross referencing +@cindex equation number, cross referencing +@cindex figure number, cross referencing +@cindex footnote number, cross referencing + +Synopsis: + +@example +\ref@{@var{key}@} +@end example + +The @code{\ref} command produces the number of the sectional unit, +equation, footnote, figure, @dots{}, of the corresponding +@code{\label} command (@pxref{\label}). It does not produce any text, +such as the word `Section' or `Figure', just the bare number itself. + + +@node Environments +@chapter Environments +@cindex environments + +@findex \begin +@findex \end + +@LaTeX{} provides many environments for marking off certain text. +Each environment begins and ends in the same manner: + +@example +\begin@{@var{envname}@} +... +\end@{@var{envname}@} +@end example + +@menu +* abstract:: Produce an abstract. +* array:: Math arrays. +* center:: Centred lines. +* description:: Labelled lists. +* displaymath:: Formulas that appear on their own line. +* document:: Enclose the whole document. +* enumerate:: Numbered lists. +* eqnarray:: Sequences of aligned equations. +* equation:: Displayed equation. +* figure:: Floating figures. +* flushleft:: Flushed left lines. +* flushright:: Flushed right lines. +* itemize:: Bulleted lists. +* letter:: Letters. +* list:: Generic list environment. +* math:: In-line math. +* minipage:: Miniature page. +* picture:: Picture with text, arrows, lines and circles. +* quotation:: Indented environment with paragraph indentation. +* quote:: Indented environment with no paragraph indentation. +* tabbing:: Align text arbitrarily. +* table:: Floating tables. +* tabular:: Align text in columns. +* thebibliography:: Bibliography or reference list. +* theorem:: Theorems, lemmas, etc. +* titlepage:: For hand crafted title pages. +* verbatim:: Simulating typed input. +* verse:: For poetry and other things. +@end menu + + +@node abstract +@section @code{abstract} + +@findex abstract @r{environment} +@cindex abstracts + +Synopsis: +@example +\begin@{abstract@} +... +\end@{abstract@} +@end example + +Environment for producing an abstract, possibly of multiple paragraphs. + + +@node array +@section @code{array} +@findex array @r{environment} +@cindex arrays, math + +Synopsis: + +@example +\begin@{array@}@{@var{template}@} +@var{col1 text}&@var{col1 text}&@var{coln}@}\\ +... +\end@{array@} +@end example + +Math arrays are produced with the @code{array} environment, normally +within an @code{equation} environment (@pxref{equation}). It has a +single mandatory @var{template} argument describing the number of +columns and the alignment within them. Each column @var{col} is +specified by a single letter that tells how items in that row should +be formatted, as follows: + +@table @code +@item c +centered +@item l +flush left +@item r +flush right +@end table + +@findex \\ (for @code{array}) +Column entries are separated by @code{&}. Column entries may include +other @LaTeX{} commands. Each row of the array is terminated with +@code{\\}. + +@findex @@@{...@} +In the template, the construct @code{@@@{@var{text}@}} puts @var{text} +between columns in each row. + +Here's an example: + +@example +\begin@{equation@} + \begin@{array@}@{lrc@} + left1 & right1 & centered1 \\ + left2 & right2 & centered2 \\ + \end@{array@} +\end@{equation@} +@end example + +@findex \arraycolsep +The @code{\arraycolsep} parameter defines half the width of the space +separating columns; the default is @samp{5pt}. @xref{tabular}, for other +parameters which affect formatting in @code{array} environments, +namely @code{\arrayrulewidth} and @code{\arraystretch}. + +The @code{array} environment can only be used in math mode. + + +@node center +@section @code{center} + +@findex center @r{environment} +@cindex centering text, environment for + +Synopsis: + +@example +\begin@{center@} +@var{line1} \\ +@var{line2} \\ +\end@{center@} +@end example + +@findex \\ (for @code{center}) +The @code{center} environment allows you to create a paragraph +consisting of lines that are centered within the left and right +margins on the current page. Each line is terminated with the +string @code{\\}. + +@menu +* \centering:: Declaration form of the @code{center} environment. +@end menu + + +@node \centering +@subsection @code{\centering} + +@findex \centering +@cindex centering text, declaration for + +The @code{\centering} declaration corresponds to the @code{center} +environment. This declaration can be used inside an environment such +as @code{quote} or in a @code{parbox}. Thus, the text of a figure or +table can be centered on the page by putting a @code{\centering} +command at the beginning of the figure or table environment. + +Unlike the @code{center} environment, the @code{\centering} command +does not start a new paragraph; it simply changes how @LaTeX{} formats +paragraph units. To affect a paragraph unit's format, the scope of +the declaration must contain the blank line or @code{\end} command (of +an environment such as quote) that ends the paragraph unit. + +Here's an example: + +@example +\begin@{quote@} +\centering +first line \\ +second line \\ +\end@{quote@} +@end example + + +@node description +@section @code{description} + +@findex description @r{environment} +@cindex labelled lists, creating +@cindex description lists, creating + +Synopsis: + +@example +\begin@{description@} +\item [@var{label1}] @var{item1} +\item [@var{label2}] @var{item2} +... +\end@{description@} +@end example + +@findex \item +The @code{description} environment is used to make labelled lists. Each +@var{label} is typeset in bold, flush right. The @var{item} text may +contain multiple paragraphs. + +@cindex bold typewriter, avoiding +@cindex typewriter labels in lists +Another variation: since the bold style is applied to the labels, if +you typeset a label in typewriter using @code{\texttt}, you'll get +bold typewriter: @code{\item[\texttt@{bold and typewriter@}]}. This +may be too bold, among other issues. To get just typewriter, use +@code{\tt}, which resets all other style variations: @code{\item[@{\tt +plain typewriter@}]}. + +For details about list spacing, see @ref{itemize}. + + +@node displaymath +@section @code{displaymath} + +@findex displaymath @r{environment} + +Synopsis: +@example +\begin@{displaymath@} +@var{math} +\end@{displaymath@} +@end example + +@noindent or + +@example +\[@var{math}\] +@end example + +The @code{displaymath} environment (@code{\[...\]} is a synonym) +typesets the @var{math} text on its own line, centered by default. +The global @code{fleqn} option makes equations flush left; see +@ref{Document class options}. + +No equation number is added to @code{displaymath} text; to get an +equation number, use the @code{equation} environment (@pxref{equation}). + + +@node document +@section @code{document} + +@findex document @r{environment} + +The @code{document} environment encloses the body of a document. +It is required in every @LaTeX{} document. @xref{Starting & ending}. + + +@node enumerate +@section @code{enumerate} + +@findex enumerate @r{environment} +@cindex lists of items, numbered + +Synopsis: + +@example +\begin@{enumerate@} +\item @var{item1} +\item @var{item2} +... +\end@{enumerate@} +@end example + +The @code{enumerate} environment produces a numbered list. Enumerations +can be nested within one another, up to four levels deep. They can also +be nested within other paragraph-making environments, such as +@code{itemize} (@pxref{itemize}) and @code{description} +(@pxref{description}). + +@findex \item +Each item of an enumerated list begins with an @code{\item} command. +There must be at least one @code{\item} command within the environment. + +By default, the numbering at each level is done like this: + +@enumerate +@item 1., 2., @dots{} +@item (a), (b), @dots{} +@item i., ii., @dots{} +@item A., B., @dots{} +@end enumerate + +@findex \enumi +@findex \enumii +@findex \enumiii +@findex \enumiv +The @code{enumerate} environment uses the counters @code{\enumi} +through @code{\enumiv} counters (@pxref{Counters}). If the optional +argument to @code{\item} is given, the counter is not incremented for +that item. + +@findex \labelenumi +@findex \labelenumii +@findex \labelenumiii +@findex \labelenumiv +The @code{enumerate} environment uses the commands @code{\labelenumi} +through @code{\labelenumiv} to produce the default label. So, you can +use @code{\renewcommand} to change the labels (@pxref{\newcommand & +\renewcommand}). For instance, to have the first level use uppercase +letters: + +@findex \Alph @r{example} +@example +\renewcommand@{\labelenumi@}@{\Alph@{enumi@}@} +@end example + + + +@node eqnarray +@section @code{eqnarray} + +@findex eqnarray @r{environment} +@cindex equations, aligning +@cindex aligning Equations + +@example +\begin@{eqnarray@} @r{(or @code{eqnarray*})} +@var{formula1} \\ +@var{formula2} \\ +... +\end@{eqnarray@} +@end example + +@findex \\ (for @code{eqnarray}) +The @code{eqnarray} environment is used to display a sequence of +equations or inequalities. It is very much like a three-column +@code{array} environment, with consecutive rows separated by @code{\\} +and consecutive items within a row separated by an @code{&}. + +@findex \\* (for @code{eqnarray}) +@code{\\*} can also be used to separate equations, with its normal +meaning of not allowing a page break at that line. + +@findex \nonumber +@cindex equation numbers, omitting +An equation number is placed on every line unless that line has a +@code{\nonumber} command. Alternatively, The @code{*}-form of the +environment (@code{\begin@{eqnarray*@} ... \end@{eqnarray*@}}) will +omit equation numbering entirely, while otherwise being the same as +@code{eqnarray}. + +@findex \lefteqn +The command @code{\lefteqn} is used for splitting long formulas across +lines. It typesets its argument in display style flush left in a box of +zero width. + + +@node equation +@section @code{equation} + +@findex equation @r{environment} +@cindex equations, environment for +@cindex formulas, environment for + +Synopsis: + +@example +\begin@{equation@} +@var{math} +\end@{equation@} +@end example + +The @code{equation} environment starts a @code{displaymath} +environment (@pxref{displaymath}), e.g., centering the @var{math} text +on the page, and also places an equation number in the right margin. + + +@node figure +@section @code{figure} +@findex figure +@cindex inserting figures +@cindex figures, inserting + +@example +\begin@{figure@}[@var{placement}] +@var{figbody} +\label@{@var{label@}} +\caption[@var{loftitle}]@{@var{text}@} +\end@{figure@} +@end example + +Figures are objects that are not part of the normal text, and are +instead ``floated'' to a convenient place, such as the top of a page. +Figures will not be split between two pages. + +The optional argument @code{[placement]} determines where @LaTeX{} will try +to place your figure. There are four places where @LaTeX{} can possibly +put a float: + +@enumerate +@item +@code{h} (Here) - at the position in the text where the figure +environment appears. +@item +@code{t} (Top) - at the top of a text page. +@item +@code{b} (Bottom) - at the bottom of a text page. +@item +@code{p} (Page of floats) - on a separate float page, which is a page +containing no text, only floats. +@end enumerate + +The standard report and article classes use the default placement +@code{tbp}. + +The body of the figure is made up of whatever text, @LaTeX{} commands, etc. +you wish. + +@findex \caption +The @code{\caption} command specifies caption @var{text} for the +figure. The caption is numbered by default. If @var{loftitle} is +present, it is used in the list of figures instead of @var{text} +(@pxref{Tables of contents}). + +@c xx float-placement, float-caption sections? +@ftable @code +@findex \bottomfraction +The maximum fraction of the page allowed to be occuped by floats at +the bottom; default @samp{.3}. + +@item \floatpagefraction +The minimum fraction of a float page that must be occupied by floats; +default @samp{.5}. + +@item \floatsep +Space between floats at the top or bottom of a page; default +@samp{12pt plus2pt minus2pt}. + +@item \intextsep +Space above and below a float in the middle of the main text; default +@samp{12pt plus2pt minus2pt} for @samp{10pt} and @samp{11pt} styles, +@samp{14pt plus4pt minus4pt} for @samp{12pt}. + +@item \textfloatsep +Space between the last (first) float at the top (bottom) of a page; +default @samp{20pt plus2pt minus4pt}. + +@item \textfraction +Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is @samp{.2}. + +@item \topfraction +Maximum fraction at the top of a page that may be occupied before +floats; default is @samp{.7}. + +@end ftable + + +@node flushleft +@section @code{flushleft} +@findex flushleft @r{environment} +@cindex left-justifying text, environment for +@cindex ragged right text, environment for + +@example +\begin@{flushleft@} +@var{line1} \\ +@var{line2} \\ +... +\end@{flushleft@} +@end example + +@findex \\ @r{for @code{flushleft}} +The @code{flushleft} environment allows you to create a paragraph +consisting of lines that are flush to the left-hand margin and ragged +right Each line must be terminated with the string @code{\\}. + +@menu +* \raggedright:: Declaration form of the @code{flushleft} environment. +@end menu + + +@node \raggedright +@subsection @code{\raggedright} +@findex \raggedright +@cindex ragged right text +@cindex left-justifying text +@cindex justification, ragged right + +The @code{\raggedright} declaration corresponds to the +@code{flushleft} environment. This declaration can be used inside an +environment such as @code{quote} or in a @code{parbox}. + +Unlike the @code{flushleft} environment, the @code{\raggedright} +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} +command that ends the paragraph unit. + + +@node flushright +@section @code{flushright} +@findex flushright @r{environment} +@cindex ragged left text, environment for +@cindex right-justifying text, environment for + +@example +\begin@{flushright@} +@var{line1} \\ +@var{line2} \\ +... +\end@{flushright@} +@end example + +@findex \\ (for @code{flushright}) +The @code{flushright} environment allows you to create a paragraph +consisting of lines that are flush to the right-hand margin and ragged +left. Each line must be terminated with the string @code{\\}. + +@menu +* \raggedleft:: Declaration form of the @code{flushright} environment. +@end menu + + +@node \raggedleft +@subsection @code{\raggedleft} +@findex \raggedleft +@cindex ragged left text +@cindex justification, ragged left +@cindex right-justifying text + +The @code{\raggedleft} declaration corresponds to the +@code{flushright} environment. This declaration can be used inside an +environment such as @code{quote} or in a @code{parbox}. + +Unlike the @code{flushright} environment, the @code{\raggedleft} +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} +command that ends the paragraph unit. + + +@node itemize +@section @code{itemize} +@findex itemize @r{environment} +@findex \item +@cindex lists of items +@cindex unordered lists +@cindex bulleted lists + +Synopsis: + +@example +\begin@{itemize@} +\item @var{item1} +\item @var{item2} +... +\end@{itemize@} +@end example + +The @code{itemize} 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} (@pxref{enumerate}). + +Each item of an @code{itemize} list begins with an @code{\item} command. +There must be at least one @code{\item} command within the environment. + +By default, the marks at each level look like this: + +@enumerate +@item @bullet{} +@item @b{-@w{-}} (bold en-dash) +@item * +@iftex +@item @math{\cdot} (centered dot) +@end iftex +@ifnottex +@item . (centered dot, rendered here as a period) +@end ifnottex +@end enumerate + +@findex \labelitemi +@findex \labelitemii +@findex \labelitemiii +@findex \labelitemiv +The @code{itemize} environment uses the commands @code{\labelitemi} +through @code{\labelitemiv} to produce the default label. So, you can +use @code{\renewcommand} to change the labels. For instance, to have +the first level use diamonds: + +@example +\renewcommand@{\labelitemi@}@{$\diamond$@} +@end example + +@findex \leftmargin +@findex \leftmargini +@findex \leftmarginii +@findex \leftmarginiii +@findex \leftmarginiv +@findex \leftmarginv +@findex \leftmarginvi +The @code{\leftmargini} through @code{\leftmarginvi} parameters define +the distance between the left margin of the enclosing environment and +the left margin of the list. By convention, @code{\leftmargin} is set +to the appropriate @code{\leftmargin@var{N}} when a new level of +nesting is entered. + +The defaults vary from @samp{.5em} (highest levels of nesting) to +@samp{2.5em} (first level), and are a bit reduced in two-column mode. +This example greatly reduces the margin space for outermost lists: + +@example +\setlength@{\leftmargini@}@{1.25em@} % default 2.5em +@end example + +@c xx should be in its own generic section +Some parameters that affect list formatting: + +@ftable @code +@item \itemindent +Extra indentation before each item in a list; default zero. + +@item \labelsep +Space between the label and text of an item; default @samp{.5em}. + +@item \labelwidth +Width of the label; default @samp{2em}, or @samp{1.5em} in two-column mode. + +@item \listparindent +Extra indentation added to second and subsequent paragraphs within a +list item; default @samp{0pt}. + +@item \rightmargin +Horizontal distance between the right margin of the list and the +enclosing environment; default @samp{0pt}, except in the @code{quote}, +@code{quotation}, and @code{verse} environments, where it is set equal +to @code{\leftmargin}. + +@end ftable + +Parameters affecting vertical spacing between list items (rather +loose, by default). + +@ftable @code +@item \itemsep +Vertical space between items. The default is @code{2pt plus1pt +minus1pt} for @code{10pt} documents, @code{3pt plus2pt minus1pt} for +@code{11pt}, and @code{4.5pt plus2pt minus1pt} for @code{12pt}. + +@item \parsep +Extra vertical space between paragraphs within a list item. Defaults +are the same as @code{\itemsep}. + +@item \topsep +Vertical space between the first item and the preceding paragraph. +The default is @code{4pt plus2pt minus2pt} for @code{10pt} documents, +@code{6pt plus2pt minus2pt} for @code{11pt}, and @code{9pt plus3pt +minus5pt} for @code{12pt}. + +@item \partopsep +Extra space added to @code{\topsep} when the list environment starts a +paragraph. The default is @code{2pt plus1pt minus1pt} for @code{10pt} +documents, @code{3pt plus1pt minus1pt} for @code{11pt}, and @code{3pt +plus2pt minus2pt} for @code{12pt}. + +@item \topsep +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}, it is @samp{4pt +plus2pt minus2pt}. + +@end ftable + +@findex \parskip @r{example} +Especially for lists with short items, it may be desirable to elide +space between items. Here is an example defining an @code{itemize*} +environment with no extra spacing between items, or between paragraphs +within a single item (@code{\parskip} is not list-specific, +@pxref{\parskip}): + +@example +\newenvironment@{itemize*@}% + @{\begin@{itemize@}% + \setlength@{\itemsep@}@{0pt@}% + \setlength@{\parsep@}@{0pt@}@}% + \setlength@{\parskip@}@{0pt@}@}% + @{\end@{itemize@}@} +@end example + + +@node letter +@section @code{letter} environment: writing letters +@findex letter + +This environment is used for creating letters. @xref{Letters}. + + +@node list +@section @code{list} +@findex list +@cindex lists of items, generic + +The @code{list} 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. + +@example +\begin@{list@}@{@var{labeling}@}@{@var{spacing}@} +\item @var{item1} +\item @var{item2} +... +\end@{list@} +@end example + +The mandatory @var{labeling} argument specifies how items should be +labelled (unless the optional argument is supplied to @code{\item}). +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. + +The mandatory @var{spacing} argument contains commands to change the +spacing parameters for the list. This argument will most often be +empty, i.e., @code{@{@}}, which leaves the default spacing. + + +@node math +@section @code{math} + +@findex math @r{environment} +@cindex in-line formulas + +Synopsis: + +@example +\begin@{math@} +@var{math} +\end@{math@} +@end example + +The @code{math} environment inserts the given @var{math} within the +running text. @code{\(...\))} and @code{$...$} are synonyms. +@xref{Math formulas}. + + +@node minipage +@section @code{minipage} + +@findex minipage @r{environment} +@cindex minipage, creating a + +@example +\begin@{minipage@}[@var{position}]@{@var{width}@} +@var{text} +\end@{minipage@} +@end example + +The @code{minipage} environment typesets its body @var{text} in a +block that will not be broken across pages (similar to the +@code{\parbox} command, @pxref{\parbox}). You may use other +paragraph-making environments inside a minipage (unlike @code{\parbox}). + +@c (xxref positions) +It takes an optional @var{position} argument for placing @var{text}, +and a mandatory @var{width} argument for specifying the line width. + +@cindex indentation of paragraphs, in minipage +@cindex paragraph indentation, in minipage +@findex \parindent +By default, paragraphs are not indented in the @code{minipage} +environment. You can restore indentation with a command such as +@code{\setlength@{\parindent@}@{1pc@}} command. + +@cindex footnotes in figures +@cindex figures, footnotes in +Footnotes in a @code{minipage} environment are handled in a way that is +particularly useful for putting footnotes in figures or tables. A +@code{\footnote} or @code{\footnotetext} command puts the footnote at +the bottom of the minipage instead of at the bottom of the page, and it +uses the @code{\mpfootnote} counter instead of the ordinary +@code{footnote} counter (@pxref{Counters}). + +However, don't put one minipage inside another if you are using +footnotes; they may wind up at the bottom of the wrong minipage. + + +@node picture +@section @code{picture} + +@findex picture +@cindex creating pictures +@cindex pictures, creating + +@example +\begin@{picture@}(width,height)(x offset,y offset) +@dots{} @var{picture commands} @dots{} +\end@{picture@} +@end example + +@findex \unitlength +The @code{picture} 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{0.3} or +@code{-3.1416}. A coordinate specifies a length in multiples of the +unit length @code{\unitlength}, so if @code{\unitlength} has been set +to @code{1cm}, then the coordinate 2.54 specifies a length of 2.54 +centimeters. You should only change the value of @code{\unitlength}, +using the @code{\setlength} command, outside of a @code{picture} +environment. + +A position is a pair of coordinates, such as @code{(2.4,-5)}, specifying +the point with x-coordinate @code{2.4} and y-coordinate @code{-5}. +Coordinates are specified in the usual way with respect to an origin, +which is normally at the lower-left corner of the picture. Note that +when a position appears as an argument, it is not enclosed in braces; +the parentheses serve to delimit the argument. + +The @code{picture} environment has one mandatory argument, which is a +@code{position}. It specifies the size of the picture. The environment +produces a rectangular box with width and height determined by this +argument's x- and y-coordinates. + +The @code{picture} environment also has an optional @code{position} +argument, following the @code{size} argument, that can change the +origin. (Unlike ordinary optional arguments, this argument is not +contained in square brackets.) The optional argument gives the +coordinates of the point at the lower-left corner of the picture +(thereby determining the origin). For example, if @code{\unitlength} +has been set to @code{1mm}, the command +@example + \begin@{picture@}(100,200)(10,20) +@end example +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. + +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. + +Everything that appears in a picture is drawn by the @code{\put} +command. The command + +@example +\put (11.3,-.3)@{...@} +@end example + +@noindent puts the object specified by @code{...} in the +picture, with its reference point at coordinates @math{(11.3,-.3)}. +The reference points for various objects will be described below. + +@findex lR box +The @code{\put} command creates an @dfn{LR box}. You can put anything +that can go in an @code{\mbox} (@pxref{\mbox}) in the text argument of +the @code{\put} command. When you do this, the reference point will +be the lower left corner of the box. + +The @code{picture} commands are described in the following sections. + +@menu +* \circle:: Draw a circle. +* \makebox (picture):: Draw a box of the specified size. +* \framebox (picture):: Draw a box with a frame around it. +* \dashbox:: Draw a dashed box. +* \frame:: Draw a frame around an object. +* \line:: Draw a straight line. +* \linethickness:: Set the line thickness. +* \thicklines:: A heavier line thickness. +* \thinlines:: The default line thickness. +* \multiput:: Draw multiple instances of an object. +* \oval:: Draw an ellipse. +* \put:: Place an object at a specified place. +* \shortstack:: Make a pile of objects. +* \vector:: Draw a line with an arrow. +@end menu + + +@node \circle +@subsection @code{\circle} +@findex \circle + +@example +\circle[*]@{@var{diameter}@} +@end example + +The @code{\circle} command produces a circle with a diameter as close +to the specified one as possible. The @code{*}-form of the command +draws a solid circle. + +Circles up to 40 pt can be drawn. + + +@node \makebox (picture) +@subsection @code{\makebox} +@findex \makebox (picture) + +@code{\makebox(width,height)[position]@{...@}} + +The @code{\makebox} command for the picture environment is similar to +the normal @code{\makebox} command except that you must specify a +@code{width} and @code{height} in multiples of @code{\unitlength}. + +The optional argument, @code{[position]}, specifies the quadrant that +your text appears in. You may select up to two of the following: + +@itemize @bullet +@item +@code{t} - Moves the item to the top of the rectangle +@item +@code{b} - Moves the item to the bottom +@item +@code{l} - Moves the item to the left +@item +@code{r} - Moves the item to the right +@end itemize + +@xref{\makebox}. + + +@node \framebox (picture) +@subsection @code{\framebox} +@findex \framebox + +Synopsis: + +@example +\framebox(@var{width},@var{height})[@var{pos}]@{...@} +@end example + +The @code{\framebox} command is like @code{\makebox} (see previous +section), except that it puts a frame around the outside of the box +that it creates. + +@findex \fboxrule +@findex \fboxsep +The @code{\framebox} command produces a rule of thickness +@code{\fboxrule}, and leaves a space @code{\fboxsep} between the rule +and the contents of the box. + + +@node \dashbox +@subsection @code{\dashbox} + +@findex \dashbox + +Draws a box with a dashed line. Synopsis: + +@example +\dashbox@{@var{dlen}@}(@var{rwidth},@var{rheight})[@var{pos}]@{@var{text}@} +@end example + +@code{\dashbox} creates a dashed rectangle around @var{text} in a +@code{picture} environment. Dashes are @var{dlen} units long, and the +rectangle has overall width @var{rwidth} and height @var{rheight}. +The @var{text} is positioned at optional @var{pos}. @c xxref positions. + +A dashed box looks best when the @code{rwidth} and @code{rheight} are +multiples of the @code{dlen}. + + +@node \frame +@subsection @code{\frame} +@findex \frame + +Synopsis: + +@example +\frame@{@var{text}@} +@end example + +The @code{\frame} command puts a rectangular frame around @var{text}. +The reference point is the bottom left corner of the frame. No extra +space is put between the frame and the object. + + +@node \line +@subsection @code{\line} +@findex \line + +Synopsis: + +@example +\line(@var{xslope},@var{yslope})@{@var{length}@} +@end example + +The @code{\line} command draws a line with the given @var{length} and +slope @var{xslope}/@var{yslope}. + +Standard @LaTeX{} can only draw lines with @math{@var{slope} = x/y}, +where @math{x} and @math{y} have integer values from @minus{}6 +through@tie{}6. For lines of any slope, not to mention other shapes, +see the @code{curve2e} and many many other packages on CTAN. + + +@node \linethickness +@subsection @code{\linethickness} +@findex \linethickness + +The @code{\linethickness@{@var{dim}@}} command declares the thickness +of horizontal and vertical lines in a picture environment to be +@var{dim}, which must be a positive length. + +@code{\linethickness} does not affect the thickness of slanted lines, +circles, or the quarter circles drawn by @code{\oval}. + + +@node \thicklines +@subsection @code{\thicklines} +@findex \thicklines + +The @code{\thicklines} command is an alternate line thickness for +horizontal and vertical lines in a picture environment; +cf.@tie{}@ref{\linethickness} and @ref{\thinlines}. + + +@node \thinlines +@subsection @code{\thinlines} +@findex \thinlines + +The @code{\thinlines} command is the default line thickness for +horizontal and vertical lines in a picture environment; +cf.@tie{}@ref{\linethickness} and @ref{\thicklines}. + + +@node \multiput +@subsection @code{\multiput} +@findex \multiput + +Synopsis: +@example +\multiput(@var{x},@var{y})(@var{delta_x},@var{delta_y})@{@var{n}@}@{@var{obj}@} +@end example + +The @code{\multiput} command copies the object @var{obj} in a regular +pattern across a picture. @var{obj} is first placed at position +@math{(x,y)}, then at @math{(x+\delta x,y+\delta y)}, and so on, +@var{n} times. + + +@node \oval +@subsection @code{\oval} +@findex \oval + +Synopsis: + +@example +\oval(@var{width},@var{height})[@var{portion}] +@end example + +The @code{\oval} command produces a rectangle with rounded corners. +The optional argument @var{portion} allows you to select part of the +oval via the following: + +@table @code +@item t +selects the top portion; +@item b +selects the bottom portion; +@item r +selects the right portion; +@item l +selects the left portion. +@end table + +The ``corners'' of the oval are made with quarter circles with a +maximum radius of 20@dmn{pt}, so large ``ovals'' will look more like +boxes with rounded corners. + + +@node \put +@subsection @code{\put} + +@findex \put + +@code{\put(x coord,y coord)@{ ... @}} + +The @code{\put} command places the item specified by the mandatory +argument at the given coordinates. + + +@node \shortstack +@subsection @code{\shortstack} +@findex \shortstack + +Synopsis: + +@example +\shortstack[@var{position}]@{...\\...\\...@} +@end example + +The @code{\shortstack} command produces a stack of objects. The valid +positions are: + +@table @code +@item r +Move the objects to the right of the stack. +@item l +Move the objects to the left of the stack +@item c +Move the objects to the centre of the stack (default) +@end table + +@findex \\ @r{(for @code{\shortstack} objects)} +Objects are separated with @code{\\}. + + +@node \vector +@subsection @code{\vector} +@findex \vector + +Synopsis: + +@example +\vector(@var{x-slope},@var{y-slope})@{@var{length}@} +@end example + +The @code{\vector} command draws a line with an arrow of the specified +length and slope. The @math{x} and @math{y} values must lie between +@minus{}4 and +4, inclusive. + + +@node quotation +@section @code{quotation} + +@findex quotation +@cindex quoted text with paragraph indentation, displaying +@cindex displaying quoted text with paragraph indentation +@cindex paragraph indentations in quoted text + +Synopsis: + +@example +\begin@{quotation@} +@var{text} +\end@{quotation@} +@end example + +The margins of the @code{quotation} environment are indented on both +the left and the right. The text is justified at both margins. +Leaving a blank line between text produces a new paragraph. + +Unlike the @code{quote} environment, each paragraph is indented +normally. + + +@node quote +@section @code{quote} + +@findex quote +@cindex quoted text without paragraph indentation, displaying +@cindex displaying quoted text without paragraph indentation +@cindex paragraph indentations in quoted text, omitting + +Snyopsis: + +@example +\begin@{quote@} +@var{text} +\end@{quote@} +@end example + +The margins of the @code{quote} environment are indented on both the +left and the right. The text is justified at both margins. Leaving a +blank line between text produces a new paragraph. + +Unlike the @code{quotation} environment, paragraphs are not indented. + + +@node tabbing +@section @code{tabbing} + +@findex tabbing @r{environment} +@cindex tab stops, using +@cindex lining text up in columns using tab stops +@cindex alignment via tabbing + +Synopsis: + +@example +\begin@{tabbing@} +@var{row1col1} \= @var{row1col2} \= @var{row1col3} \= @var{row1col4} \\ +@var{row2col1} \> \> @var{row2col3} \\ +... +\end@{tabbing@} +@end example + +The @code{tabbing} 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. + +This environment can be broken across pages, unlike the @code{tabular} +environment. + +The following commands can be used inside a @code{tabbing} enviroment: + +@ftable @code +@item \\ @r{tabbing} +End a line. + +@item \= @r{(tabbing)} +Sets a tab stop at the current position. + +@item \> @r{(tabbing)} +@findex \> +Advances to the next tab stop. + +@item \< +Put following text to the left of the local margin (without changing +the margin). Can only be used at the start of the line. + +@item \+ +Moves the left margin of the next and all the +following commands one tab stop to the right, beginning tabbed line if +necessary. + +@item \- +Moves the left margin of the next and all the +following commands one tab stop to the left, beginning tabbed line if +necessary. + +@item \' @r{(tabbing)} +Moves everything that you have typed so far in the +current column, i.e. everything from the most recent @code{\>}, +@code{\<}, @code{\'}, @code{\\}, or @code{\kill} command, to the right +of the previous column, flush against the current column's tab stop. + +@item \` @r{(tabbing)} +Allows you to put text flush right against any tab stop, including tab +stop@tie{}0. However, it can't move text to the right of the last column +because there's no tab stop there. The @code{\`} command moves all the +text that follows it, up to the @code{\\} or @code{\end@{tabbing@}} +command that ends the line, to the right margin of the tabbing +environment. There must be no @code{\>} or @code{\'} command between +the @code{\`} and the command that ends the line. + +@item \a @r{(tabbing)} +@findex \a' @r{(acute accent in tabbing)} +@findex \a` @r{(grave accent in tabbing)} +@findex \a= @r{(macron accent in tabbing)} +In a @code{tabbing} environment, the commands @code{\=}, @code{\'} and +@code{\`} do not produce accents as usual (@pxref{Accents}). Instead, +the commands @code{\a=}, @code{\a'} and @code{\a`} are used. + +@item \kill +Sets tab stops without producing text. Works just like @code{\\} +except that it throws away the current line instead of producing +output for it. The effect of any @code{\=}, @code{\+} or @code{\-} +commands in that line remain in effect. + +@item \poptabs +@findex \poptabs +Restores the tab stop positions saved by the last @code{\pushtabs}. + +@item \pushtabs +Saves all current tab stop positions. Useful for temporarily changing +tab stop positions in the middle of a @code{tabbing} environment. + +@item \tabbingsep +Distance to left of tab stop moved by @code{\'}. + +@end ftable + +This example typesets a Pascal function in a traditional format: + +@example +\begin@{tabbing@} +function \= fact(n : integer) : integer;\\ + \> begin \= \+ \\ + \> if \= n $>$ 1 then \+ \\ + fact := n * fact(n-1) \- \\ + else \+ \\ + fact := 1; \-\- \\ + end;\\ +\end@{tabbing@} +@end example + + +@node table +@section @code{table} + +@findex table +@cindex tables, creating +@cindex creating tables + +Synopsis: + +@example + \begin@{table@}[placement] + + body of the table + + \caption@{table title@} + \end@{table@} +@end example + +Tables are objects that are not part of the normal text, and are +usually ``floated'' to a convenient place, like the top of a page. +Tables will not be split between two pages. + +The optional argument @code{[placement]} determines where @LaTeX{} will try +to place your table. There are four places where @LaTeX{} can possibly put +a float: + +@itemize @bullet +@item +@code{h}: Here - at the position in the text where the table +environment appears. +@item +@code{t}: Top - at the top of a text page. +@item +@code{b}: Bottom - at the bottom of a text page. +@item +@code{p}: Page of floats - on a separate float page, which is a page +containing no text, only floats. +@end itemize + +The standard @code{report} and @code{article} classes use the default +placement @code{[tbp]}. + +The body of the table is made up of whatever text, @LaTeX{} commands, etc., +you wish. The @code{\caption} command allows you to title your table. + + +@node tabular +@section @code{tabular} +@findex tabular @r{environment} +@cindex lines in tables +@cindex lining text up in tables + +Synopsis: + +@example +\begin@{tabular@}[pos]@{cols@} +column 1 entry & column 2 entry ... & column n entry \\ +... +\end@{tabular@} +@end example + + or + +@example +\begin@{tabular*@}@{width@}[pos]@{cols@} +column 1 entry & column 2 entry ... & column n entry \\ +... +\end@{tabular*@} +@end example + +These environments produce a box consisting of a sequence of rows of +items, aligned vertically in columns. + +@findex \\ @r{for @code{tabular}} +@code{\\} must be used to specify the end of each row of the table, +except for the last, where it is optional---unless an @code{\hline} +command (to put a rule below the table) follows. + +The mandatory and optional arguments consist of: + +@table @code +@item width +Specifies the width of the @code{tabular*} environment. There must be +rubber space between columns that can stretch to fill out the specified +width. +@item pos +Specifies the vertical position; default is alignment on the centre of +the environment. + +@itemize @bullet +@item +@code{t} - align on top row +@item +@code{b} - align on bottom row +@end itemize + +@item cols +Specifies the column formatting. It consists of a sequence of the +following specifiers, corresponding to the sequence of columns and +intercolumn material. + +@itemize @bullet + +@item +@code{l} - A column of left-aligned items. +@item +@code{r} - A column of right-aligned items. +@item +@code{c} - A column of centred items. +@item +@code{|} - A vertical line the full height and depth of the environment. +@item +@code{@@@{text@}} - This inserts @code{text} 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@}} command in an +@@-expression causes an extra space of width @code{wd} to appear to the +left of all subsequent columns, until countermanded by another +@code{\extracolsep} command. Unlike ordinary intercolumn space, this +extra space is not suppressed by an @@-expression. An +@code{\extracolsep} command can be used only in an @@-expression in the +@code{cols} argument. +@item +@code{p@{wd@}} - Produces a column with each item typeset in a parbox of +width @code{wd}, as if it were the argument of a @code{\parbox[t]@{wd@}} +command. However, a @code{\\} may not appear in the item, except in the +following situations: +@enumerate +@item +inside an environment like @code{minipage}, @code{array}, or @code{tabular}. +@item +inside an explicit @code{\parbox}. +@item +in the scope of a @code{\centering}, @code{\raggedright}, or @code{\raggedleft} +declaration. The latter declarations must appear inside braces or an +environment when used in a @code{p}-column element. +@end enumerate +@item +@code{*@{num@}@{cols@}} - Equivalent to @code{num} copies of +@code{cols}, where @code{num} is any positive integer and @code{cols} is +any list of column-specifiers, which may contain another +@code{*-expression}. + +@end itemize + +@end table + +Parameters that control formatting: +@c xx defaults, own node (xref from array)? + +@ftable @code +@item \arrayrulewidth +Thickness of the rule created by @code{|}, @code{\hline}, and +@code{\vline} in the @code{tabular} and @code{array} environments; the +default is @samp{.4pt}. + +@item \arraystretch +Scaling of spacing between rows in the @code{tabular} and @code{array} +environments; default is @samp{1},for no scaling. + +@item \doublerulesep +Horizontal distance between the vertical rules produced by @code{||} +in the @code{tabular} and @code{array} environments; default is @samp{2pt}. + +@item \tabcolsep +Half the width of the space between columns; default is @samp{6pt}. + +@end ftable + +These commands can be used inside a @code{tabular} environment: + +@menu +* \multicolumn:: Make an item spanning several columns. +* \cline:: Draw a horizontal line spanning some columns. +* \hline:: Draw a horizontal line spanning all columns. +* \vline:: Draw a vertical line. +@end menu + + +@node \multicolumn +@subsection @code{\multicolumn} +@findex \multicolumn + +Synopsis: +@example +\multicolumn@{@var{cols}@}@{@var{pos}@}@{@var{text}@} +@end example + +The @code{\multicolumn} command makes an entry that spans several +columns. The first mandatory argument, @var{cols}, specifies the +number of columns to span. The second mandatory argument, @var{pos}, +specifies the formatting of the entry; @code{c} for centered, @code{l} +for flushleft, @code{r} for flushright. The third mandatory argument, +@var{text}, specifies what text to put in the entry. + +Here's an example showing two columns separated by an en-dash; +@code{\multicolumn} is used for the heading: + +@example +\begin@{tabular@}@{r@@@{--@}l@} +\multicolumn@{2@}@{c@}@{\bf Unicode@}\cr + 0x80&0x7FF \cr + 0x800&0xFFFF \cr +0x10000&0x1FFFF \cr +\end@{tabular@} +@end example + + +@node \cline +@subsection @code{\cline} +@findex \cline + +Synopsis: + +@example +\cline@{@var{i}-@var{j}@} +@end example + +The @code{\cline} command draws horizontal lines across the columns +specified, beginning in column @var{i} and ending in column @var{j}, +which are specified in the mandatory argument. + + +@node \hline +@subsection @code{\hline} +@findex \hline + +The @code{\hline} command draws a horizontal line the width of the +enclosing @code{tabular} or @code{array} environment. It's most +commonly used to draw a line at the top, bottom, and between the rows +of a table. + + +@node \vline +@subsection @code{\vline} +@findex \vline + +The @code{\vline} command will draw a vertical line extending the full +height and depth of its row. An @code{\hfill} command can be used to +move the line to the edge of the column. It can also be used in an +@@-expression. + + +@node thebibliography +@section @code{thebibliography} + +@findex thebibliography +@cindex bibliography, creating (manually) + +Synopsis: + +@example +\begin@{thebibliography@}@{@var{widest-label}@} +\bibitem[@var{label}]@{@var{cite_key@}} +... +\end@{thebibliography@} +@end example + +The @code{thebibliography} environment produces a bibliography or +reference list. + +In the @code{article} class, this reference list is labelled +``References''; in the @code{report} class, it is labelled +``Bibliography''. You can change the label (in the standard classes) +by redefining the command @code{\refname}. For instance, this +eliminates it entirely: + +@example +\renewcommand@{\refname@}@{@} +@end example + +The mandatory @var{widest-label} argument is text that, when typeset, +is as wide as the widest item label produced by the @code{\bibitem} +commands. It is typically given as @code{9} for bibliographies with +less than 10 references, @code{99} for ones with less than 100, etc. + +@menu +* \bibitem:: Specify a bibliography item. +* \cite:: Refer to a bibliography item. +* \nocite:: Include an item in the bibliography. +* Using BibTeX:: Automatic generation of bibliographies. +@end menu + + +@node \bibitem +@subsection @code{\bibitem} + +@findex \bibitem + +Synopsis: +@example +\bibitem[@var{label}]@{@var{cite_key}@} +@end example + +The @code{\bibitem} command generates an entry labelled by +@var{label}. If the @var{label} argument is missing, a number is +automatically generated using the @code{enumi} counter. The +@var{cite_key} is any sequence of letters, numbers, and punctuation +symbols not containing a comma. + +This command writes an entry to the @file{.aux} file containing the +item's @var{cite_key} and label. When the @file{.aux} file is read by +the @code{\begin@{document@}} command, the item's @code{label} is +associated with @code{cite_key}, causing references to @var{cite_key} +with a @code{\cite} command (see next section) to produce the +associated label. + + +@node \cite +@subsection @code{\cite} + +@findex \cite + +Synopsis: + +@example +\cite[@var{subcite}]@{@var{keys} +@end example + +The @var{keys} 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} by entries in the +@file{.aux} file. + +The text of the optional @var{subcite} argument appears after the +citation. For example, @code{\cite[p.~314]@{knuth@}} might produce +`[Knuth, p.@tie{}314]'. + + +@node \nocite +@subsection @code{\nocite} +@findex \nocite + +@code{\nocite@{key_list@}} + +The @code{\nocite} command produces no text, but writes @code{key_list}, +which is a list of one or more citation keys, on the @file{.aux} file. + + +@node Using BibTeX +@subsection Using Bib@TeX{} + +@cindex using Bib@TeX{} +@cindex bib@TeX{}, using +@cindex bibliography, creating (automatically) +@findex \bibliographystyle +@findex \bibliography + +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} environment (@pxref{thebibliography}). Instead, +you include the lines + +@example +\bibliographystyle@{@var{bibstyle}@} +\bibliography@{@var{bibfile1},@var{bibfile2}@} +@end example + +The @code{\bibliographystyle} command does not produce any output of +its own. Rather, it defines the style in which the bibliography will +be produced: @var{bibstyle} refers to a file +@var{bibstyle}@file{.bst}, which defines how your citations will look. +The standard @var{style} names distributed with Bib@TeX{} are: + +@table @code +@item alpha +Sorted alphabetically. Labels are formed from name of author and year of +publication. +@item plain +Sorted alphabetically. Labels are numeric. +@item unsrt +Like @code{plain}, but entries are in order of citation. +@item abbrv +Like @code{plain}, but more compact labels. +@end table + +In addition, numerous other Bib@TeX{} style files exist tailored to +the demands of various publications. See +@url{http://www.ctan.org/tex-archive/biblio/bibtex/contrib}. + +The @code{\bibliography} command is what actually produces the +bibliography. The argument to @code{\bibliography} refers to files +named @file{@var{bibfile}.bib}, which should contain your database in +Bib@TeX{} format. Only the entries referred to via @code{\cite} and +@code{\nocite} will be listed in the bibliography. + + +@node theorem +@section @code{theorem} + +@findex theorem @r{environment} +@cindex theorems, typesetting + +Synopsis: + +@example +\begin@{theorem@} +@var{theorem-text} +\end@{theorem@} +@end example + +The @code{theorem} environment produces ``Theorem @var{n}'' in +boldface followed by @var{theorem-text}, where the numbering +possibilities for @var{n} are described under @code{\newtheorem} +(@pxref{\newtheorem}). + + +@node titlepage +@section @code{titlepage} + +@findex titlepage @r{environment} +@cindex making a title page +@cindex title pages, creating + +Synopsis: + +@example +\begin@{titlepage@} +@var{text} +\end@{titlepage@} +@end example + +The @code{titlepage} 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} command may be useful on title pages +(@pxref{\today}). + +You can use the @code{\maketitle} command (@pxref{\maketitle}) to +produce a standard title page without a @code{titlepage} environment. + + +@node verbatim +@section @code{verbatim} + +@findex verbatim @r{environment} +@cindex verbatim text +@cindex simulating typed text +@cindex typed text, simulating +@cindex code, typesetting +@cindex computer programs, typesetting + +Synopsis: + +@example +\begin@{verbatim@} +@var{literal-text} +\end@{verbatim@} +@end example + +The @code{verbatim} environment is a paragraph-making environment in +which @LaTeX{} produces exactly what you type in; for instance the +@code{\} character produces a printed @samp{\}. It turns @LaTeX{} +into a typewriter with carriage returns and blanks having the same +effect that they would on a typewriter. + +The @code{verbatim} uses a monospaced typewriter-like font (@code{\tt}). + +@menu +* \verb:: The macro form of the @code{verbatim} environment. +@end menu + +@node \verb +@subsection @code{\verb} + +@findex \verb +@cindex verbatim text, inline + +Synopsis: + +@example +\verb@var{char}@var{literal-text}@var{char} +\verb*@var{char}@var{literal-text}@var{char} +@end example + +The @code{\verb} command typesets @var{literal-text} as it is input, +including special characters and spaces, using the typewriter +(@code{\tt}) font. No spaces are allowed between @code{\verb} or +@code{\verb*} and the delimiter @var{char}, which begins and ends the +verbatim text. The delimiter must not appear in @var{literal-text}. + +@cindex visible space +The @code{*}-form differs only in that spaces are printed with a +``visible space'' character. +@tex +(Namely, {\tt\char`\ }.) +@end tex + + +@node verse +@section @code{verse} + +@findex verse @r{environment} +@cindex poetry, an environment for + +Synopsis: + +@example +\begin@{verse@} +@var{line1} \\ +@var{line2} \\ +... +\end@{verse@} +@end example + +The @code{verse} environment is designed for poetry, though you may find +other uses for it. + +@findex \\ @r{for @code{verse}} +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{\\}, and use one or more blank lines to separate the +stanzas. + + +@node Footnotes +@chapter Footnotes +@cindex footnotes, creating + +Footnotes can be produced in one of two ways. They can be produced +with one command, the @code{\footnote} command. They can also be +produced with two commands, the @code{\footnotemark} and the +@code{\footnotetext} commands. + +@menu +* \footnote:: Insert a footnote. +* \footnotemark:: Insert footnote mark only. +* \footnotetext:: Insert footnote text only. +* Footnote parameters:: Parameters for footnote formatting. +@end menu + + +@node \footnote +@section @code{\footnote} +@findex \footnote + +Synopsis: + +@example +\footnote[@var{number}]@{@var{text}@} +@end example + +The @code{\footnote} command places the numbered footnote @var{text} +at the bottom of the current page. The optional argument @var{number} +changes the default footnote number. + +This command can only be used in outer paragraph mode; i.e., you +cannot use it in sectioning commands like @code{\chapter}, in figures, +tables or in a @code{tabular} environment. (See following sections.) +@c xx mention packages that fix this + + +@node \footnotemark +@section @code{\footnotemark} +@findex \footnotemark + +With no optional argument, the @code{\footnotemark} command puts the +current footnote number in the text. This command can be used in +inner paragraph mode. You give the text of the footnote separately, +with the @code{\footnotetext} command. + +This command can be used to produce several consecutive footnote +markers referring to the same footnote with + +@example +\footnotemark[\value@{footnote@}] +@end example + +after the first @code{\footnote} command. + + +@node \footnotetext +@section @code{\footnotetext} +@findex \footnotetext + +Synopsis: + +@example +\footnotetext[@var{number}]@{@var{text}@} +@end example + +The @code{\footnotetext} command places @var{text} at the bottom of +the page as a footnote. This command can come anywhere after the +@code{\footnotemark} command. The @code{\footnotetext} command must +appear in outer paragraph mode. + +The optional argument @var{number} changes the default footnote number. + + +@node Footnote parameters +@section Footnote parameters + +@cindex footnote parameters + +@ftable @code +@item \footnoterule +Produces the rule separating the main text on a page from the page's +footnotes. Default dimensions: @code{0.4pt} thick (or wide), and +@code{0.4\columnwidth} long in the standard document classes (except +slides, where it does not appear). + +@item \footnotesep +The height of the strut placed at the beginning of the footnote. By +default, this is set to the normal strut for @code{\footnotesize} +fonts (@pxref{Font sizes}), therefore there is no extra space between +footnotes. This is @samp{6.65pt} for @samp{10pt}, @samp{7.7pt} for +@samp{11pt}, and @samp{8.4pt} for @samp{12pt}. + +@end ftable + + +@node Definitions +@chapter Definitions +@cindex definitions + +@LaTeX{} has support for making new commands of many different kinds. + +@c xx everything in this chapter needs examples. + +@menu +* \newcommand & \renewcommand:: (Re)define a new command. +* \newcounter:: Define a new counter. +* \newlength:: Define a new length. +* \newsavebox:: Define a new box. +* \newenvironment & \renewenvironment:: Define a new environment. +* \newtheorem:: Define a new theorem-like environment. +* \newfont:: Define a new font name. +* \protect:: Using tricky commands. +@end menu + + +@node \newcommand & \renewcommand +@section @code{\newcommand} & @code{\renewcommand} +@findex \newcommand +@cindex commands, defining new ones +@cindex defining a new command +@cindex new commands, defining + +@code{\newcommand} and @code{\renewcommand} define and redefine a +command, respectively. Synopses: + +@example + \newcommand@{@var{cmd}@}[@var{nargs}]@{@var{defn}@} +\renewcommand@{@var{cmd}@}[@var{nargs}]@{@var{defn}@} + \newcommand@{@var{cmd}@}[@var{nargs}][@var{default}]@{@var{defn}@} +\renewcommand@{@var{cmd}@}[@var{nargs}][@var{default}]@{@var{defn}@} +@end example + + +@table @var +@item cmd +The command name beginning with @code{\}. For @code{\newcommand}, it +must not be already defined and must not begin with @code{\end}; for +@code{\renewcommand}, it must already be defined. + +@item nargs +An optional integer from 1 to 9 specifying the number of arguments +that the command will take. The default is for the command to have no +arguments. + +@item default +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}. + +@item defn +The text to be substituted for every occurrence of @code{cmd}; a +construct of the form @code{#@var{n}} in @var{defn} is replaced by the +text of the @var{n}th argument. + +@end table + + +@node \newcounter +@section @code{\newcounter} +@findex \newcounter +@cindex counters, defining new + +Synopsis: + +@example +\newcounter@{@var{cnt}@}[@var{countername}] +@end example + +The @code{\newcounter} command defines a new counter named @var{cnt}. +The new counter is initialized to zero. + +Given the optional argument @code{[@var{countername}]}, @var{cnt} +will be reset whenever @var{countername} is incremented. + +@xref{Counters}, for more information about counters. + + +@node \newlength +@section @code{\newlength} +@findex \newlength +@cindex lengths, defining new + +Synopsis: + +@example +\newlength@{\@var{arg}@} +@end example + +The @code{\newlength} command defines the mandatory argument as a +@code{length} command with a value of @code{0in}. The argument must +be a control sequence, as in @code{\newlength@{\foo@}}. An error +occurs if @code{\foo} is already defined. + +@xref{Lengths}, for how to set the new length to a nonzero value, and +for more information about lengths in general. + + +@node \newsavebox +@section @code{\newsavebox} +@findex \newsavebox + +Synopsis: + +@example +\newsavebox@{@var{cmd}@} +@end example + +Defines @code{\@var{cmd}}, which must be a command name not already +defined, to refer to a new bin for storing boxes. + + +@node \newenvironment & \renewenvironment +@section @code{\newenvironment} & @code{\renewenvironment} +@findex \newenvironment +@findex \renewenvironment +@cindex environments, defining +@cindex defining new environments +@cindex redefining environments + +Synopses: + +@example + \newenvironment@{@var{env}@}[@var{nargs}]@{@var{begdef}@}@{@var{enddef}@} + \newenvironment@{@var{env}@}[@var{nargs}][@var{default}]@{@var{begdef}@}@{@var{enddef}@} +\renewenvironment@{@var{env}@}[@var{nargs}]@{@var{begdef}@}@{@var{enddef}@} +@end example + +These commands define or redefine an environment @var{env}, that is, +@code{\begin@{@var{env}@} @dots{} \end@{@var{env}@}}. + +@table @var +@item env +The name of the environment. For @code{\newenvironment}, @var{env} +must not be an existing environment, and the command @code{\@var{env}} +must be undefined. For @code{\renewenvironment}, @var{env} must be +the name of an existing environment. + +@item nargs +An integer from 1 to 9 denoting the number of arguments of +the newly-defined environment. The default is no arguments. + +@item default +If this is specified, the first argument is optional, and @var{default} +gives the default value for that argument. + +@item begdef +The text expanded at every occurrence of @code{\begin@{@var{env}@}}; a +construct of the form @code{#@var{n}} in @var{begdef} is replaced by +the text of the @var{n}th argument. + +@item enddef +The text expanded at every occurrence of @code{\end@{@var{env}@}}. It +may not contain any argument parameters. + +@end table + + +@node \newtheorem +@section @code{\newtheorem} +@findex \newtheorem +@cindex theorems, defining +@cindex defining new theorems + +@example +\newtheorem@{@var{newenv}@}@{@var{label}@}[@var{within}] +\newtheorem@{@var{newenv}@}[@var{numbered_like}]@{@var{label}@} +@end example + +This command defines a theorem-like environment. Arguments: + +@table @var +@item newenv +The name of the environment to be defined; must not be the name of an +existing environment or otherwise defined. + +@item label +The text printed at the beginning of the environment, before the +number. For example, @samp{Theorem}. + +@item numbered_like +(Optional.) The name of an already defined theorem-like environment; +the new environment will be numbered just like @var{numbered_like}. + +@item within +(Optional.) The name of an already defined counter, a sectional unit. +The new theorem counter will be reset at the same time as the +@var{within} counter. + +@end table + +At most one of @var{numbered_like} and @var{within} can be specified, +not both. + + +@node \newfont +@section @code{\newfont} +@findex \newfont +@cindex fonts, new commands for +@cindex defining new fonts + +Synopsis: + +@example +\newfont@{@var{cmd}@}@{@var{fontname}@} +@end example + +Defines a control sequence @code{\@var{cmd}}, which must not already +be defined, to make @var{fontname} be the current font. The file +looked for on the system is named @file{@var{fontname}.tfm}. + +This is a low-level command for setting up to use an individual font. +More commonly, fonts are defined in families through @file{.fd} files. + + +@node \protect +@section @code{\protect} +@findex \protect + +@cindex fragile commands +@cindex moving arguments +Footnotes, line breaks, any command that has an optional argument, and +many more are so-called @dfn{fragile} commands. When a fragile +command is used in certain contexts, called @dfn{moving arguments}, it +must be preceded by @code{\protect}. In addition, any fragile +commands within the arguments must have their own @code{\protect}. + +Some examples of moving arguments are @code{\caption} +(@pxref{figure}), @code{\thanks} (@pxref{\maketitle}), and +@-expressions in @code{tabular} and @code{array} environments +(@pxref{tabular}). + +@cindex robust commands +Commands which are not fragile are called @dfn{robust}. They must not +be preceded by @code{\protect}. + +See also: + +@smallexample +@exdent @url{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html} +@exdent @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect} +@end smallexample + +@c xx really need examples. + + +@node Counters +@chapter Counters +@cindex counters, a list of +@cindex variables, a list of + +Everything @LaTeX{} numbers for you has a counter associated with +it. The name of the counter is the same as the name of the environment +or command that produces the number, except with no @code{\}. +(@code{enumi}--@code{enumiv} are used for the nested enumerate +environment.) Below is a list of the counters used in @LaTeX{}'s +standard document classes to control numbering. + +@example +part paragraph figure enumi +chapter subparagraph table enumii +section page footnote enumiii +subsection equation mpfootnote enumiv +subsubsection +@end example + +@menu +* \alph \Alph \arabic \roman \Roman \fnsymbol:: Print value of a counter. +* \usecounter:: Use a specified counter in a list environment. +* \value:: Use the value of a counter in an expression. +* \setcounter:: Set the value of a counter. +* \addtocounter:: Add a quantity to a counter. +* \refstepcounter:: Add to counter, resetting subsidiary counters. +* \stepcounter:: Add to counter, resetting subsidiary counters. +* \day \month \year:: Numeric date values. +@end menu + + +@node \alph \Alph \arabic \roman \Roman \fnsymbol +@section @code{\alph \Alph \arabic \roman \Roman \fnsymbol}: Printing counters + +All of these commands take a single counter as an argument, for +instance, @code{\alph@{enumi@}}. + +@ftable @code +@item \alph +prints @var{counter} using lowercase letters: `a', `b', @enddots{} + +@item \Alph +uses uppercase letters: `A', `B', @enddots{} + +@item \arabic +uses Arabic numbers: `1', `2', @enddots{} + +@item \roman +uses lowercase roman numerals: `i', `ii', @enddots{} + +@item \roman +uses uppercase roman numerals: `I', `II', @enddots{} + +@item \fnsymbol +prints the value of @var{counter} in a specific sequence of nine +symbols (conventionally used for labeling footnotes). The value of +@var{counter} must be between@tie{}1 and@tie{}9, inclusive. + +@tex +Here are the symbols: +$\ast$ $\dagger$ $\ddagger$ $\S$ $\P$ $\parallel$ +$\ast\ast$ $\dagger\dagger$ $\ddagger\ddagger$ +@end tex +@ifnottex +The symbols mostly aren't supported in Info, but here are the names: +@display +asterix(*) dagger ddagger section-sign paragraph-sign parallel +double-asterix(**) double-dagger double-ddagger +@end display +@end ifnottex + +@end ftable + + +@node \usecounter +@section @code{\usecounter@{@var{counter}@}} +@findex \usecounter +@cindex list items, specifying counter +@cindex numbered items, specifying counter + +Synopsis: + +@example +\usecounter@{@var{counter}@} +@end example + +The @code{\usecounter} command is used in the second argument of the +@code{list} environment to specify @var{counter} to be used to number +the list items. + + +@node \value +@section @code{\value@{@var{counter}@}} +@findex \value +@cindex counters, getting value of + +Synopsis: + +@example +\value@{@var{counter}@} +@end example + +The @code{\value} command produces the value of @var{counter}. It can +be used anywhere @LaTeX{} expects a number, for example: + +@example +\setcounter@{myctr@}@{3@} +\addtocounter@{myctr@}@{1@} +\hspace@{\value@{myctr@}\parindent@} +@end example + + +@node \setcounter +@section @code{\setcounter@{@var{counter}@}@{@var{value}@}} +@findex \setcounter +@cindex counters, setting +@cindex setting counters + +Synopsis: + +@example +\setcounter@{@var{\counter}@}@{@var{value}@} +@end example + +The @code{\setcounter} command sets the value of @var{\counter} to the +@var{value} argument. + + +@node \addtocounter +@section @code{\addtocounter@{@var{counter}@}@{@var{value}@}} +@findex \addtocounter + +The @code{\addtocounter} command increments @var{counter} by the +amount specified by the @var{value} argument, which may be negative. + + +@node \refstepcounter +@section @code{\refstepcounter@{@var{counter}@}} +@findex \refstepcounter + +The @code{\refstepcounter} command works in the same way as +@code{\stepcounter} @xref{\stepcounter}, except it also defines the +current @code{\ref} value to be the result of @code{\thecounter}. + + +@node \stepcounter +@section @code{\stepcounter@{@var{counter}@}} +@findex \stepcounter + +The @code{\stepcounter} command adds one to @var{counter} and +resets all subsidiary counters. + + +@node \day \month \year +@section @code{\day \month \year}: Predefined counters +@findex \day +@findex \month +@findex \year + +@LaTeX{} defines counters for the day of the month (@code{\day}, +1--31), month of the year (@code{\month}, 1--12), and year +(@code{\year}, 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. + +The related command @code{\today} produces a string representing the +current day (@pxref{\today}). + + +@node Lengths +@chapter Lengths +@cindex lengths, defining and using + +A @code{length} is a measure of distance. Many @LaTeX{} commands take a +length as an argument. + +@menu +* \setlength:: Set the value of a length. +* \addtolength:: Add a quantity to a length. +* \settodepth:: Set a length to the depth of something. +* \settoheight:: Set a length to the height of something. +* \settowidth:: Set a length to the width of something. +* Predefined lengths:: Lengths that are, like, predefined. +@end menu + + +@node \setlength +@section @code{\setlength@{\@var{len}@}@{@var{value}@}} +@findex \setlength +@cindex lengths, setting + +The @code{\setlength} sets the value of @var{\len} to the @var{value} +argument, which can be expressed in any units that @LaTeX{} +understands, i.e., inches (@code{in}), millimeters (@code{mm}), points +(@code{pt}), big points (@code{bp}, etc. + + +@node \addtolength +@section \addtolength@{@var{\len}@}@{@var{amount}@} +@findex \addtolength +@cindex lengths, adding to + +The @code{\addtolength} command increments a ``length command'' +@var{\len} by the amount specified in the @var{amount} argument, which +may be negative. + + +@node \settodepth +@section @code{\settodepth} +@findex \settodepth + +@code{\settodepth@{\gnat@}@{text@}} + +The @code{\settodepth} command sets the value of a @code{length} command +equal to the depth of the @code{text} argument. + + +@node \settoheight +@section @code{\settoheight} +@findex \settoheight + +@code{\settoheight@{\gnat@}@{text@}} + +The @code{\settoheight} command sets the value of a @code{length} command +equal to the height of the @code{text} argument. + + + +@node \settowidth +@section @code{\settowidth@{\@var{len}@}@{@var{text}@}} +@findex \settowidth + +The @code{\settowidth} command sets the value of the command @var{\len} +to the width of the @var{text} argument. + + + +@node Predefined lengths +@section Predefined lengths +@cindex lengths, predefined +@cindex predefined lengths + +@code{\width} +@findex \width + +@code{\height} +@findex \height + +@code{\depth} +@findex \depth + +@code{\totalheight} +@findex \totalheight + +These length parameters can be used in the arguments of the box-making +commands (@pxref{Boxes}). They specify the natural width etc. of the +text in the box. @code{\totalheight} equals @code{\height} + +@code{\depth}. To make a box with the text stretched to double the +natural size, e.g., say + +@code{\makebox[2\width]@{Get a stretcher@}} + + +@node Line breaking +@chapter Line breaking +@cindex line breaking +@cindex breaking lines + +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). + +@LaTeX{} usually does the line (and page) breaking for you, but in +some environments, you do the line breaking yourself with the +@code{\\} command, and you can always manually force breaks. + +@menu +* \\:: Start a new line. +* \obeycr & \restorecr:: Make each input line start a new output line. +* \newline:: Break the line +* \- (hyphenation):: Insert explicit hyphenation. +* \fussy:: Be fussy about line breaking. +* \hyphenation:: Tell @LaTeX{} how to hyphenate a word. +* \linebreak & \nolinebreak:: Forcing & avoiding line breaks. +* \sloppy:: Be sloppy about line breaking. +@end menu + + +@node \\ +@section @code{\\}[*][@var{morespace}] +@findex \\ @r{force line break} +@cindex new line, starting +@cindex line break, forcing + +The @code{\\} command tells @LaTeX{} to start a new line. It has an +optional argument, @var{morespace}, that specifies how much extra +vertical space is to be inserted before the next line. This can be a +negative amount. + +The @code{\\*} command is the same as the ordinary @code{\\} command +except that it tells @LaTeX{} not to start a new page after the line. + + +@node \obeycr & \restorecr +@section @code{\obeycr} & @code{\restorecr} +@findex \obeycr +@findex \restorecr +@cindex new line, output as input + +The @code{\obeycr} command makes a return in the input file +(@samp{^^M}, internally) the same as @code{\\} (followed by +@code{\relax}). So each new line in the input will also be a new line +in the output. + +@code{\restorecr} restores normal line-breaking behavior. + + +@node \newline +@section @code{\newline} +@findex \newline +@cindex new line, starting (paragraph mode) + +The @code{\newline} command breaks the line at the present point, with +no stretching of the text before it. It can only be used in paragraph +mode. + + +@node \- (hyphenation) +@section @code{\-} (discretionary hyphen) +@findex \- @r{(hyphenation)} +@cindex hyphenation, forcing + +The @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{\-} command is used for the exceptional +cases. + +When you insert @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. + + + +@node \fussy +@section @code{\fussy} +@findex \fussy + +The declaration @code{\fussy} (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. + +This command cancels the effect of a previous @code{\sloppy} command +(@pxref{\sloppy}. + + +@node \sloppy +@section @code{\sloppy} + +The declaration @code{\sloppy} makes @TeX{} less fussy about line +breaking. This will avoid overfull boxes, at the cost of loose +interword spacing. + +Lasts until a @code{\fussy} command is issued (@pxref{\fussy}). + + +@node \hyphenation +@section @code{\hyphenation} +@findex \hyphenation +@cindex hyphenation, defining + +Synopsis: + +@example +\hyphenation@{@var{word-one} @var{word-two}@} +@end example + +The @code{\hyphenation} command declares allowed hyphenation points +with a @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} commands +accumulate. Some examples (the default @TeX{} hyphenation patterns +misses the hyphenations in these words): + +@example +\hyphenation@{ap-pen-dix col-umns data-base data-bases@} +@end example + + +@node \linebreak & \nolinebreak +@section @code{\linebreak} & @code{\nolinebreak} +@findex \linebreak +@findex \nolinebreak +@cindex line breaks, forcing +@cindex line breaks, preventing + +Synopses: + +@example +\linebreak[@var{priority}] +\nolinebreak[@var{priority}] +@end example + +By default, the @code{\linebreak} (@code{\nolinebreak}) command forces +(prevents) a line break at the current position. For +@code{\linebreak}, the spaces in the line are stretched out so that it +extends to the right margin as usual. + +With the optional argument @var{priority}, you can convert the command +from a demand to a request. The @var{priority} must be a number from +0 to@tie{}4. The higher the number, the more insistent the request. + + +@node Page breaking +@chapter Page breaking +@cindex page breaking +@cindex breaking pages + +@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. + +@menu +* \cleardoublepage:: Start a new right-hand page. +* \clearpage:: Start a new page. +* \newpage:: Start a new page. +* \enlargethispage:: Enlarge the current page a bit. +* \pagebreak & \nopagebreak:: Forcing & avoiding page breaks. +@end menu + + +@node \cleardoublepage +@section @code{\cleardoublepage} + +@findex \cleardoublepage +@cindex starting on a right-hand page + +The @code{\cleardoublepage} command ends the current page and causes all +figures and tables that have so far appeared in the input to be printed. +In a two-sided printing style, it also makes the next page a right-hand +(odd-numbered) page, producing a blank page if necessary. + + +@node \clearpage +@section @code{\clearpage} +@findex \clearpage +@cindex flushing floats and starting a page +@cindex starting a new page and clearing floats + +The @code{\clearpage} command ends the current page and causes all +figures and tables that have so far appeared in the input to be printed. + + +@node \newpage +@section @code{\newpage} +@findex \newpage +@cindex new page, starting +@cindex starting a new page + +The @code{\newpage} command ends the current page, but does not clear +floats (see @code{\clearpage} above). + + +@node \enlargethispage +@section @code{\enlargethispage} +@findex \enlargethispage +@cindex enlarge current page + +@code{\enlargethispage@{size@}} + +@code{\enlargethispage*@{size@}} + +Enlarge the @code{\textheight} for the current page by the specified +amount; e.g. @code{\enlargethispage@{\baselineskip@}} will allow one +additional line. + +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}. + + +@node \pagebreak & \nopagebreak +@section @code{\pagebreak} & @code{\nopagebreak} +@findex \pagebreak +@findex \nopagebreak +@cindex page break, forcing +@cindex page break, preventing + +Synopses: + +@example +\pagebreak[@var{priority}] +\nopagebreak[@var{priority}] +@end example + +By default, the @code{\pagebreak} (@code{\nopagebreak}) command forces +(prevents) a page break at the current position. For +@code{\linebreak}, the vertical space on the page is stretched out +where possible so that it extends to the normal bottom margin. + +With the optional argument @var{priority}, you can convert the +@code{\pagebreak} command from a demand to a request. The number must +be a number from 0 to@tie{}4. The higher the number, the more +insistent the request is. + + +@node Making paragraphs +@chapter Making paragraphs +@cindex making paragraphs +@cindex paragraphs + +A paragraph is ended by one or more completely blank lines---lines not +containing even a @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. + +@menu +* \indent:: Indent this paragraph. +* \noindent:: Do not indent this paragraph. +* \parskip:: Space added before paragraphs. +* Marginal notes:: Putting remarks in the margin. +@end menu + + +@node \indent +@section @code{\indent} +@findex \indent +@findex \parindent +@cindex indent, forcing + +@code{\indent} produces a horizontal space whose width equals the +width of the @code{\parindent} length, the normal paragraph +indentation. It is used to add paragraph indentation where it would +otherwise be suppressed. + +The default value for @code{\parindent} is @code{1em} in two-column +mode, otherwise @code{15pt} for @code{10pt} documents, @code{17pt} for +@code{11pt}, and @code{1.5em} for @code{12pt}. + + +@node \noindent +@section @code{\noindent} +@findex \noindent +@cindex indent, suppressing + +When used at the beginning of the paragraph, @code{\noindent} +suppresses any paragraph indentation. It has no effect when used in +the middle of a paragraph. + + +@node \parskip +@section @code{\parskip} +@findex \parskip +@cindex vertical space before paragraphs + +@code{\parskip} is a rubber length defining extra vertical space added +before each paragraph. The default is @code{0pt plus1pt}. + + +@node Marginal notes +@section Marginal notes +@cindex marginal notes +@cindex notes in the margin +@cindex remarks in the margin +@findex \marginpar + +Synopsis: + +@example +\marginpar[@var{left}]@{@var{right}@} +@end example + +The @code{\marginpar} 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} occurs. + +When you only specify the mandatory argument @var{right}, the text +will be placed + +@itemize @bullet +@item +in the right margin for one-sided layout; +@item +in the outside margin for two-sided layout; +@item +in the nearest margin for two-column layout. +@end itemize + +@findex \reversemarginpar +@findex \normalmarginpar +The command @code{\reversemarginpar} places subsequent marginal notes +in the opposite (inside) margin. @code{\normalmarginpar} places them +in the default position. + +When you specify both arguments, @var{left} is used for the left +margin, and @var{right} is used for the right margin. + +The first word will normally not be hyphenated; you can enable +hyphenation there by beginning the node with @code{\hspace@{0pt@}}. + +These parameters affect the formatting of the note: + +@ftable @code +@item \marginparpush +Minimum vertical space between notes; default @samp{7pt} for +@samp{12pt} documents, @samp{5pt} else. + +@item \marginparsep +Horizontal space between the main text and the note; default +@samp{11pt} for @samp{10pt} documents, @samp{10pt} else. + +@item \marginparwidth +Width of the note itself; default for a one-sided @samp{10pt} document +is @samp{90pt}, @samp{83pt} for @samp{11pt}, and @samp{68pt} for +@samp{12pt}; @samp{17pt} more in each case for a two-sided document. +In two column mode, the default is @samp{48pt}. + +@end ftable + + +@node Math formulas +@chapter Math formulas +@cindex math formulas +@cindex formulas, math +@cindex math mode, entering + +@findex math @r{environment} +@findex displaymath @r{environment} +@findex equation @r{environment} +There are three environments that put @LaTeX{} in math mode: + +@table @code +@item math +For formulas that appear right in the text. +@item displaymath +For formulas that appear on their own line. +@item equation +The same as the displaymath environment except that it adds an equation +number in the right margin. +@end table + +@findex \( +@findex \) +@findex \[ +@findex \] +The @code{math} environment can be used in both paragraph and LR mode, +but the @code{displaymath} and @code{equation} environments can be used +only in paragraph mode. The @code{math} and @code{displaymath} +environments are used so often that they have the following short forms: + +@example +\(...\) @r{instead of} \begin@{math@}...\end@{math@} +\[...\] @r{instead of} \begin@{displaymath@}...\end@{displaymath@} +@end example + +@findex $ +In fact, the @code{math} environment is so common that it has an even +shorter form: + +@example +$ ... $ @r{instead of} \(...\) +@end example + +@findex \boldmath +@findex \unboldmath +The @code{\boldmath} command changes math letters and symbols to be in +a bold font. It is used @emph{outside} of math mode. Conversely, the +@code{\unboldmath} command changes math glyphs to be in a normal font; +it too is used @emph{outside} of math mode. + +@c xx own section? Math fonts? +@findex \displaystyle +The @code{\displaystyle} declaration forces the size and style of the +formula to be that of @code{displaymath}, e.g., with limits above and +below summations. For example +@example +$\displaystyle \sum_@{n=0@}^\infty x_n $ +@end example + +@c xx see also \cal, \mathcal + +@menu +* Subscripts & Superscripts:: Also known as exponent or index. +* Math symbols:: Various mathematical squiggles. +* Math functions:: Math function names like sin and exp. +* Math accents:: Accents in math. +* Spacing in math mode:: Thick, medium, thin and negative spaces. +* Math Miscellany:: Stuff that doesn't fit anywhere else. +@end menu + + +@node Subscripts & Superscripts +@section Subscripts & Superscripts +@cindex superscript +@cindex subscript +@cindex exponent +@findex _ +@findex ^ + +To get an expression @i{exp} to appear as a subscript, you just type +@code{_@{}@i{exp}@code{@}}. To get @i{exp} to appear as a +superscript, you type @code{^@{}@i{exp}@code{@}}. @LaTeX{} handles +superscripted superscripts and all of that stuff in the natural way. +It even does the right thing when something has both a subscript and a +superscript. + + +@node Math symbols +@section Math symbols +@cindex math symbols +@cindex symbols, math +@cindex greek letters + +@LaTeX{} provides almost any mathematical symbol you're likely to +need. The commands for generating them can be used only in math mode. +For example, if you include @code{$\pi$} in your source, you will get +the pi symbol (@math{\pi}) in your output. + +@ftable @code +@item \| +@math{\|} + +@item \aleph +@math{\aleph} + +@item \alpha +@math{\alpha} + +@item \amalg +@math{\amalg} (binary operation) + +@item \angle +@math{\angle} + +@item \approx +@math{\approx} (relation) + +@item \ast +@math{\ast} (binary operation) + +@item \asymp +@math{\asymp} (relation) + +@item \backslash +\ (delimiter) + +@item \beta +@math{\beta} + +@item \bigcap +@math{\bigcap} + +@item \bigcirc +@math{\bigcirc} (binary operation) + +@item \bigcup +@math{\bigcup} + +@item \bigodot +@math{\bigodot} + +@item \bigoplus +@math{\bigoplus} + +@item \bigotimes +@math{\bigotimes} + +@item \bigtriangledown +@math{\bigtriangledown} (binary operation) + +@item \bigtriangleup +@math{\bigtriangleup} (binary operation) + +@item \bigsqcup +@math{\bigsqcup} + +@item \biguplus +@math{\biguplus} + +@item \bigcap +@math{\bigvee} + +@item \bigwedge +@math{\bigwedge} + +@item \bot +@math{\bot} + +@item \bowtie +@math{\bowtie} (relation) + +@item \Box +(square open box symbol) @c xx not in plain + +@item \bullet +@cindex bullet symbol +@math{\bullet} (binary operation) + +@item \cap +@math{\cap} (binary operation) + +@item \cdot +@math{\cdot} (binary operation) + +@item \chi +@math{\chi} + +@item \circ +@math{\circ} (binary operation) + +@item \clubsuit +@math{\clubsuit} + +@item \cong +@math{\cong} (relation) + +@item \coprod +@math{\coprod} + +@item \cup +@math{\cup} (binary operation) + +@item \dagger +@math{\dagger} (binary operation) + +@item \dashv +@math{\dashv} (relation) + +@item \ddagger +@math{\dagger} (binary operation) + +@item \Delta +@math{\Delta} + +@item \delta +@math{\delta} + +@item \Diamond +bigger @math{\diamond} @c xx not in plain + +@item \diamond +@math{\diamond} (binary operation) + +@item \diamondsuit +@math{\diamondsuit} + +@item \div +@math{\div} (binary operation) + +@item \doteq +@math{\doteq} (relation) + +@item \downarrow +@math{\downarrow} (delimiter) + +@item \Downarrow +@math{\Downarrow} (delimiter) + +@item \ell +@math{\ell} + +@item \emptyset +@math{\emptyset} + +@item \epsilon +@math{\epsilon} + +@item \equiv +@math{\equiv} (relation) + +@item \eta +@math{\eta} + +@item \exists +@math{\exists} + +@item \flat +@math{\flat} + +@item \forall +@math{\forall} + +@item \frown +@math{\frown} (relation) + +@item \Gamma +@math{\Gamma} + +@item \gamma +@math{\gamma} + +@item \ge +@math{\ge} + +@item \geq +@math{\geq} (relation) + +@item \gets +@math{\gets} + +@item \gg +@math{\gg} (relation) + +@item \hbar +@math{\hbar} + +@item \heartsuit +@math{\heartsuit} + +@item \hookleftarrow +@math{\hookleftarrow} + +@item \hookrightarrow +@math{\hookrightarrow} + +@item \iff +@math{\iff} + +@item \Im +@math{\Im} + +@item \in +@math{\in} (relation) + +@item \infty +@math{\infty} + +@item \int +@math{\int} + +@item \iota +@math{\iota} + +@item \Join +condensed bowtie symbol (relation) @c xx not in plain + +@item \kappa +@math{\kappa} + +@item \Lambda +@math{\Lambda} + +@item \lambda +@math{\lambda} + +@item \land +@math{\land} + +@item \langle +@math{\langle} (delimiter) + +@item \lbrace +@math{\lbrace} (delimiter) + +@item \lbrack +@math{\lbrack} (delimiter) + +@item \lceil +@math{\lceil} (delimiter) + +@item \le +@math{\le} + +@item \leadsto +@c xx missing from plain + +@item \Leftarrow +@math{\Leftarrow} + +@item \leftarrow +@math{\leftarrow} + +@item \leftharpoondown +@math{\leftharpoondown} + +@item \leftharpoonup +@math{\leftharpoonup} + +@item \Leftrightarrow +@math{\Leftrightarrow} + +@item \leftrightarrow +@math{\leftrightarrow} + +@item \leq +@math{\leq} (relation) + +@item \lfloor +@math{\lfloor} (delimiter) + +@item \lhd +(left-pointing arrow head) @c xx not in plain + +@item \ll +@math{\ll} (relation) + +@item \lnot +@math{\lnot} + +@item \longleftarrow +@math{\longleftarrow} + +@item \longleftrightarrow +@math{\longleftrightarrow} + +@item \longmapsto +@math{\longmapsto} + +@item \longrightarrow +@math{\longrightarrow} + +@item \lor +@math{\lor} + +@item \mapsto +@math{\mapsto} + +@item \mho +@c xx not in plain + +@item \mid +@math{\mid} (relation) + +@item \models +@math{\models} (relation) + +@item \mp +@math{\mp} (binary operation) + +@item \mu +@math{\mu} + +@item \nabla +@math{\nabla} + +@item \natural +@math{\natural} + +@item \ne +@math{\ne} + +@item \nearrow +@math{\nearrow} + +@item \neg +@math{\neg} + +@item \neq +@math{\neq} (relation) + +@item \ni +@math{\ni} (relation) + +@item \not +Overstrike a following operator with a /, as in @math{\not=}. + +@item \notin +@math{\ni} + +@item \nu +@math{\nu} + +@item \nwarrow +@math{\nwarrow} + +@item \odot +@math{\odot} (binary operation) + +@item \oint +@math{\oint} + +@item \Omega +@math{\Omega} + +@item \omega +@math{\omega} + +@item \ominus +@math{\ominus} (binary operation) + +@item \oplus +@math{\oplus} (binary operation) + +@item \oslash +@math{\oslash} (binary operation) + +@item \otimes +@math{\otimes} (binary operation) + +@item \owns +@math{\owns} + +@item \parallel +@math{\parallel} (relation) + +@item \partial +@math{\partial} + +@item \perp +@math{\perp} (relation) + +@item \phi +@math{\phi} + +@item \Pi +@math{\Pi} + +@item \pi +@math{\pi} + +@item \pm +@math{\pm} (binary operation) + +@item \prec +@math{\prec} (relation) + +@item \preceq +@math{\preceq} (relation) + +@item \prime +@math{\prime} + +@item \prod +@math{\prod} + +@item \propto +@math{\propto} (relation) + +@item \Psi +@math{\Psi} + +@item \psi +@math{\psi} + +@item \rangle +@math{\rangle} (delimiter) + +@item \rbrace +@math{\rbrace} (delimiter) + +@item \rbrack +@math{\rbrack} (delimiter) + +@item \rceil +@math{\rceil} (delimiter) + +@item \Re +@math{\Re} + +@item \rfloor +@math{\rfloor} + +@item \rhd +(binary operation) @c xx not in plain @math{\rhd} + +@item \rho +@math{\rho} + +@item \Rightarrow +@math{\Rightarrow} + +@item \rightarrow +@math{\rightarrow} + +@item \rightharpoondown +@math{\rightharpoondown} + +@item \rightharpoonup +@math{\rightharpoonup} + +@item \rightleftharpoons +@math{\rightleftharpoons} + +@item \searrow +@math{\searrow} + +@item \setminus +@math{\setminus} (binary operation) + +@item \sharp +@math{\sharp} + +@item \Sigma +@math{\Sigma} + +@item \sigma +@math{\sigma} + +@item \sim +@math{\sim} (relation) + +@item \simeq +@math{\simeq} (relation) + +@item \smallint +@math{\smallint} + +@item \smile +@math{\smile} (relation) + +@item \spadesuit +@math{\spadesuit} + +@item \sqcap +@math{\sqcap} (binary operation) + +@item \sqcup +@math{\sqcup} (binary operation) + +@item \sqsubset +(relation) @c not in plain (@math{\sqsubset}) + +@item \sqsubseteq +@math{\sqsubseteq} (relation) + +@item \sqsupset +(relation) @c not in plain (@math{\sqsupset}) + +@item \sqsupseteq +@math{\sqsupseteq} (relation) + +@item \star +@math{\star} (binary operation) + +@item \subset +@math{\subset} (relation) + +@item \subseteq +@math{\subseteq} (relation) + +@item \succ +@math{\succ} (relation) + +@item \succeq +@math{\succeq} (relation) + +@item \sum +@math{\sum} + +@item \supset +@math{\supset} (relation) + +@item \supseteq +@math{\supseteq} (relation) + +@item \surd +@math{\surd} + +@item \swarrow +@math{\swarrow} + +@item \tau +@math{\tau} + +@item \theta +@math{\theta} + +@item \times +@math{\times} (binary operation) + +@item \to +@math{\to} + +@item \top +@math{\top} + +@item \triangle +@math{\triangle} + +@item \triangleleft +@math{\triangleleft} (binary operation) + +@item \triangleright +@math{\triangleright} (binary operation) + +@item \unlhd +left-pointing arrowhead with line under (binary operation) @c not in plain + +@item \unrhd +right-pointing arrowhead with line under (binary operation) @c not in plain + +@item \Uparrow +@math{\Uparrow} (delimiter) + +@item \uparrow +@math{\uparrow} (delimiter) + +@item \Updownarrow +@math{\Updownarrow} (delimiter) + +@item \updownarrow +@math{\updownarrow} (delimiter) + +@item \uplus +@math{\uplus} (binary operation) + +@item \Upsilon +@math{\Upsilon} + +@item \upsilon +@math{\upsilon} + +@item \varepsilon +@math{\varepsilon} + +@item \varphi +@math{\varphi} + +@item \varpi +@math{\varpi} + +@item \varrho +@math{\varrho} + +@item \varsigma +@math{\varsigma} + +@item \vartheta +@math{\vartheta} + +@item \vdash +@math{\vdash} (relation) + +@item \vee +@math{\vee} (binary operation) + +@item \Vert +@math{\Vert} (delimiter) + +@item \vert +@math{\vert} (delimiter) + +@item \wedge +@math{\wedge} (binary operation) + +@item \wp +@math{\wp} + +@item \wr +@math{\wr} (binary operation) + +@item \Xi +@math{\Xi} + +@item \xi +@math{\xi} + +@item \zeta +@math{\zeta} + +@end ftable + + +@node Math functions +@section Math functions +@cindex math functions +@cindex functions, math + +These commands produce roman function names in math mode with proper +spacing. + +@ftable @code +@item \arccos +@math{\arccos} + +@item \arcsin +@math{\arcsin} + +@item \arctan +@math{\arctan} + +@item \arg +@math{\arg} + +@item \bmod +Binary modulo operator (@math{x \bmod y}) + +@item \cos +@math{\cos} + +@item \cosh +@math{\cosh} + +@item \cot +@math{\cos} + +@item \coth +@math{\cosh} + +@item \csc +@math{\csc} + +@item \deg +@math{\deg} + +@item \det +@math{\deg} + +@item \dim +@math{\dim} + +@item \exp +@math{\exp} + +@item \gcd +@math{\gcd} + +@item \hom +@math{\hom} + +@item \inf +@math{\inf} + +@item \ker +@math{\ker} + +@item \lg +@math{\lg} + +@item \lim +@math{\lim} + +@item \liminf +@math{\liminf} + +@item \limsup +@math{\limsup} + +@item \ln +@math{\ln} + +@item \log +@math{\log} + +@item \max +@math{\max} + +@item \min +@math{\min} + +@item \pmod +parenthesized modulus, as in (@math{\pmod 2^n - 1}) + +@item \Pr +@math{\Pr} + +@item \sec +@math{\sec} + +@item \sin +@math{\sin} + +@item \sinh +@math{\sinh} + +@item \sup +@math{\sup} + +@item \tan +@math{\tan} + +@item \tanh +@math{\tanh} + +@end ftable + + +@node Math accents +@section Math accents +@cindex math accents +@cindex accents, mathematical + +@LaTeX{} provides a variety of commands for producing accented letters +in math. These are different from accents in normal text +(@pxref{Accents}). + +@ftable @code +@item \acute +@cindex acute accent, math +Math acute accent: @math{\acute{x}}. + +@item \breve +@cindex breve accent, math +Math breve accent: @math{\breve{x}}. + +@item \check +@cindex check accent, math +@cindex h@'a@v{c}ek accent, math +Math h@'a@v{c}ek (check) accent: @math{\check{x}}. + +@item \ddot +@cindex double dot accent, math +Math dieresis accent: @math{\ddot{x}}. + +@item \dot +@cindex overdot accent, math +@cindex dot over accent, math +Math dot accent: @math{\dot{x}}. + +@item \grave +@cindex grave accent, math +Math grave accent: @math{\grave{x}}. + +@item \hat +@cindex hat accent, math +@cindex circumflex accent, math +Math hat (circumflex) accent: @math{\hat{x}}. + +@item \imath +@cindex dotless i, math +Math dotless i. + +@item \jmath +@cindex dotless j, math +Math dotless j. + +@item \tilde +@cindex tilde accent, math +Math tilde accent: @math{\tilde{x}}. + +@item \vec +@cindex vector symbol, math +Math vector symbol: @math{\vec{x}}. + +@item \widehat +@cindex wide hat accent, math +Math wide hat accent: @math{\widehat{x+y}}. + +@item \widehat +@cindex wide tile accent, math +Math wide tilde accent: @math{\widetilde{x+y}}. + +@end ftable + + +@node Spacing in math mode +@section Spacing in math mode +@cindex spacing within math mode +@cindex math mode, spacing + +In a @code{math} environment, @LaTeX{} ignores the spaces you type and +puts in the spacing according to the normal rules for mathematics +texts. If you want different spacing, @LaTeX{} provides the following +commands for use in math mode: + +@table @code +@item \; +@findex \; +A thick space (@math{5\over18\,}quad). +@item \: +@itemx \> +@findex \: +@findex \> +Both of these produce a medium space (@math{2\over9\,}quad). +@item \, +@findex \, +A thin space (@math{1\over6\,}quad); not restricted to math mode. +@item \! +A negative thin space (@math{-{1\over6}\,}quad). +@end table + + +@node Math Miscellany +@section Math Miscellany +@cindex math Miscellany + +@ftable @code + +@item \* +@cindex discretionary multiplication +@cindex multiplication symbol, discretionary line break +A ``discretionary'' multiplication symbol, at which a line break is +allowed. + +@item \cdots +A horizontal ellipsis with the dots raised to the center of the line. +@tex +As in: `$\cdots$'. +@end tex + +@item \ddots +A diagonal ellipsis: @math{\ddots}. + +@item \frac@{num@}@{den@} +@findex \frac +Produces the fraction @code{num} divided by @code{den}. + +@iftex +eg. +@tex +${1}\over{4}$ +@end tex +@end iftex + +@item \left @var{delim1} ... \right @var{delim2} +@findex \right +@cindex null delimiter +The two delimiters need not match; @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]}. + +@item \overbrace@{@var{text}@} +Generates a brace over @var{text}. +For example, @math{\overbrace{x+\cdots+x}^{k \rm\;times}}. + +@item \overline@{@var{text}@} +Generates a horizontal line over @var{tex}. +For exampe, @math{\overline{x+y}}. + +@item \sqrt[@var{root}]@{arg@} +Produces the representation of the square root of @var{arg}. The +optional argument @var{root} determines what root to produce. For +example, the cube root of @code{x+y} would be typed as +@code{$\sqrt[3]@{x+y@}$}. +@tex +In @TeX{}, the result looks like this: +$\root 3 \of x+y$. +@end tex + +@item \stackrel@{@var{text}@}@{@var{relation}@} +Puts @var{text} above @var{relation}. For example, +@code{\stackrel@{f@}@{\longrightarrow@}}. +@tex +In @TeX{}, the result looks like this: +$\buildrel f \over \longrightarrow$. +@end tex + +@item \underbrace@{math@} +Generates @var{math} with a brace underneath. +@tex +In @TeX{}, the result looks like this: +$\underbrace{x+y+z}_{>\,0}$. +@end tex + +@item \underline@{text@} +Causes @var{text}, which may be either math mode or not, to be +underlined. +@tex +In @TeX{}, the result looks like this: +$\underline{z}$ +@end tex + +@item \vdots +@findex \vdots +Produces a vertical ellipsis. +@tex +In @TeX{}, the result looks like this: +$\vdots$. +@end tex + +@end ftable + + +@node Modes +@chapter Modes +@cindex modes +@cindex paragraph mode +@cindex math mode +@cindex left-to-right mode +@cindex lR mode + + +When @LaTeX{} is processing your input text, it is always in one of three +modes: + +@itemize @bullet +@item +Paragraph mode +@item +Math mode +@item +Left-to-right mode, called LR mode for short +@end itemize + +@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. + +``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}, @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. + +@LaTeX{} is in LR mode when it starts making a box with an @code{\mbox} +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}. 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''. + + +@node Page Styles +@chapter Page Styles +@cindex styles, page +@cindex page styles + +The @code{\documentclass} command determines the size and position of +the page's head and foot. The page style determines what goes in them. + +@menu +* \maketitle:: Generate a title page. +* \pagenumbering:: Set the style used for page numbers. +* \pagestyle:: Change the headings/footings style. +* \thispagestyle:: Change the headings/footings style for this page. +@end menu + + +@node \maketitle +@section @code{\maketitle} +@cindex titles, making +@findex \maketitle + +The @code{\maketitle} command generates a title on a separate title +page---except in the @code{article} 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: + +@ftable @code +@item \author@{@var{name} \and @var{name2}@} +@cindex author, for titlepage +@findex \\ @r{for @code{\author}} +@findex \and @r{for @code{\author}} +The @code{\author} command declares the document author(s), where the +argument is a list of authors separated by @code{\and} commands. Use +@code{\\} to separate lines within a single author's entry---for +example, to give the author's institution or address. + +@item \date@{@var{text}@} +@cindex date, for titlepage +The @code{\date} command declares @var{text} to be the document's +date. With no @code{\date} command, the current date (@pxref{\today}) +is used. + +@item \thanks@{@var{text}@} +@cindex thanks, for titlepage +@cindex credit footnote +The @code{\thanks} command produces a @code{\footnote} to the title, +usually used for credit acknowledgements. + +@item \title@{@var{text}@} +@cindex title, for titlepage +@findex \\ @r{for @code{\title}} +The @code{\title} command declares @var{text} to be the title of the +document. Use @code{\\} to force a line break, as usual. + +@end ftable + + +@node \pagenumbering +@section @code{\pagenumbering} +@findex \pagenumbering +@cindex page numbering style + +Synopsis: + +@example +\pagenumbering@{@var{style}@} +@end example + +Specifies the style of page numbers, according to @var{style}: + +@table @code +@item arabic +arabic numerals +@item roman +lowercase Roman numerals +@item Roman +uppercase Roman numerals +@item alph +lowercase letters +@item Alph +uppercase letters +@end table + + +@node \pagestyle +@section @code{\pagestyle} +@findex \pagestyle +@cindex header style +@cindex footer style +@cindex running header and footer style + +Synopsis: + +@example +\pagestyle@{@var{style}@} +@end example + +The @code{\pagestyle} command specifies how the headers and footers +are typeset from the current page onwards. Values for @var{style}: + +@table @code +@item plain +Just a plain page number. + +@item empty +Empty headers and footers, e.g., no page numbers. + +@item headings +Put running headers on each page. The document style specifies what +goes in the headers. + +@item myheadings +Custom headers, specified via the @code{\markboth} or the +@code{\markright} commands. + +@end table + +Here are the descriptions of @code{\markboth} and @code{\markright}: + +@ftable @code +@item \markboth@{@var{left}@}@{@var{right}@} +Sets both the left and the right heading. A ``left-hand heading'' +(@var{left}) is generated by the last @code{\markboth} command before +the end of the page, while a ``right-hand heading'' (@var{right} is +generated by the first @code{\markboth} or @code{\markright} that +comes on the page if there is one, otherwise by the last one before +the page. + +@item \markright@{@var{right}@} +Sets the right heading, leaving the left heading unchanged. + +@end ftable + + +@node \thispagestyle +@section @code{\thispagestyle@{@var{style}@}} +@findex \thispagestyle + +The @code{\thispagestyle} command works in the same manner as the +@code{\pagestyle} command (see previous section) except that it +changes to @var{style} for the current page only. + + +@node Spaces +@chapter Spaces +@cindex spaces + +@LaTeX{} has many ways to produce white (or filled) space. + +Another space-producing command is @code{\,} to produce a ``thin'' +space (usually 1/6@dmn{quad}). It can be used in text mode, but is +more often useful in math mode (@pxref{Spacing in math mode}). + +@menu +Horizontal space +* \hspace:: Fixed horizontal space. +* \SPACE:: Normal interword space. +* \AT:: Ending a sentence. +* \thinspace:: One-sixth of an em. +* \/:: Per-character italic correction. +* \hfill:: Stretchable horizontal space. +* \hrulefill:: Stretchable horizontal rule. +* \dotfill:: Stretchable horizontal dots. + +Vertical space +* \addvspace:: Add arbitrary vertical space if needed. +* \bigskip \medskip \smallskip:: Fixed vertical spaces. +* \vfill:: Infinitely stretchable vertical space. +* \vspace:: Add arbitrary vertical space. +@end menu + + +@node \hspace +@section @code{\hspace} +@findex \hspace + +Synopsis: + +@example +\hspace[*]@{@var{length}@} +@end example + +The @code{\hspace} command adds horizontal space. The @var{length} +argument can be expressed in any terms that @LaTeX{} understands: +points, inches, etc. It is a rubber length. You can add both +negative and positive space with an @code{\hspace} command; adding +negative space is like backspacing. + +@LaTeX{} normally removes horizontal space that comes at the beginning +or end of a line. To preserve this space, use the optional @code{*} +form. + + +@node \hfill +@section @code{\hfill} + +@findex \hfill +The @code{\hfill} fill command produces a ``rubber length'' which has +no natural space but can stretch or shrink horizontally as far as +needed. + +@findex \fill +The @code{\fill} parameter is the rubber length itself (technically, +the glue value @samp{0pt plus1fill}); thus, @code{\hspace\fill} is +equivalent to @code{\hfill}. + + +@node \SPACE +@section @code{\SPACE} +@findex \SPACE +@findex \TAB +@findex \NEWLINE + +The @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}. +It is also often used after control sequences, as in @code{\TeX\ is a +nice system.} + +In normal circumstances, @code{\}@key{tab} and @code{\}@key{newline} +are equivalent to @code{\ }. + + +@node \AT +@section @code{\@@} +@findex \@@ + +The @code{\@@} command makes the following punctuation character end a +sentence even if it normally would not. This is typically used after +a capital letter. Here are side-by-side examples with and without +@code{\@@}: + +@example +@dots{} in C\@@. Pascal, though @dots{} +@dots{} in C. Pascal, though @dots{} +@end example + +@noindent produces + +@c Texinfo does it differently, but the result is the same. +@quotation +@dots{} in C@. Pascal, though @dots{} +@dots{} in C. Pascal, though @dots{} +@end quotation + + +@node \thinspace +@section @code{\thinspace} +@findex \thinspace + +@code{\thinspace} 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{''}. + + +@node \/ +@section @code{\/} +@findex \/ + +The @code{\/} command produces an @dfn{italic correction}. 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} character typically has a large italic correction value. + +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 +@tex +{\it f\/: f\/;} +@end tex +@ifnottex +@i{f: f;} (in the @TeX{} output, the `f's are nicely separated) +@end ifnottex +with @i{f: f;}. + +Despite the name, roman characters can also have an italic +correction. Compare +@tex +pdf\/\TeX{} +@end tex +@ifnottex +pdf@TeX{} (in the @TeX{} output, there is a small space after the `f') +@end ifnottex +with pdf@TeX{}. + + +@node \hrulefill +@section @code{\hrulefill} +@findex \hrulefill + +The @code{\hrulefill} fill command produces a ``rubber length'' which can +stretch or shrink horizontally. It will be filled with a horizontal +rule. + + +@node \dotfill +@section @code{\dotfill} + +@findex \dotfill + +The @code{\dotfill} command produces a ``rubber length'' that fills +with dots instead of just white space. + + +@c xx undone +@node \addvspace +@section @code{\addvspace} +@findex \addvspace +@cindex vertical space +@cindex space, inserting vertical + +@code{\addvspace@{length@}} + +The @code{\addvspace} command normally adds a vertical space of height +length. However, if vertical space has already been added to the same +point in the output by a previous @code{\addvspace} command, then this +command will not add more space than needed to make the natural length +of the total vertical space equal to @code{length}. + + +@node \bigskip \medskip \smallskip +@section @code{\bigskip \medskip \smallskip} + +These commands produce a given amount of space. + +@table @code +@item \bigskip +@findex \bigskip +@findex \bigskipamount +The same as @code{\vspace@{bigskipamount@}}, ordinarily about one line +space (with stretch and shrink). + +@item \medskip +@findex \medskip +@findex \medskipamount +The same as @code{\vspace@{medskipamount@}}, ordinarily +about half of a line space (with stretch and shrink). + +@item \smallskip +@findex \smallskip +@findex \smallskipamount +The same as @code{\vspace@{smallskipamount@}}, ordinarily about a +quarter of a line space (with stretch and shrink). + +@end table + +The @code{\...amount} parameters are determined by the document class. + + +@node \vfill +@section @code{\vfill} +@findex \vfill + +The @code{\vfill} fill command produces a rubber length (glue) which +can stretch or shrink vertically as far as needed. It's equivalent to +@code{\vspace@{\fill@}} (@pxref{\hfill}). + + +@node \vspace +@section @code{\vspace[*]@{@var{length}@}} +@findex \vspace + +Synopsis: + +@example +\vspace[*]@{@var{length}@} +@end example + +The @code{\vspace} command adds the vertical space @var{length}, i.e., +a rubber length. @var{length} can be negative or positive. + +Ordinarily, @LaTeX{} removes vertical space added by @code{\vspace} at +the top or bottom of a page. With the optional @code{*} argument, the +space is not removed. + + +@node Boxes +@chapter Boxes + +@cindex boxes + +All the predefined length parameters (@pxref{Predefined lengths}) can be +used in the arguments of the box-making commands. + +@menu +* \mbox:: Horizontal boxes. +* \fbox and \framebox:: Put a frame around a box. +* lrbox:: An environment like \sbox. +* \makebox:: Box, adjustable position. +* \parbox:: Box with text in paragraph mode. +* \raisebox:: Raise or lower text. +* \savebox:: Like \makebox, but save the text for later use. +* \sbox:: Like \mbox, but save the text for later use. +* \usebox:: Print saved text. +@end menu + + +@node \mbox +@section @code{\mbox@{@var{text@}}} +@findex \mbox + +@cindex hyphenation, preventing +The @code{\mbox} command creates a box just wide enough to hold the +text created by its argument. The @var{text} is not broken into +lines, so it can be used to prevent hyphenation. + + +@node \fbox and \framebox +@section @code{\fbox} and @code{\framebox} + +@findex \fbox +@findex \framebox + +Synopses: + +@example +\fbox@{@var{text}@} +\framebox[@var{width}][@var{position}]@{@var{text}@} +@end example + +The @code{\fbox} and @code{\framebox} commands are like @code{\mbox}, +except that they put a frame around the outside of the box being created. + +In addition, the @code{\framebox} command allows for explicit +specification of the box width with the optional @var{width} argument +(a dimension), and positioning with the optional @var{position} +argument. @c xxref + +@findex \fboxrule +@findex \fboxsep +Both commands produce a rule of thickness @code{\fboxrule} (default +@samp{.4pt}), and leave a space of @code{\fboxsep} (default +@samp{3pt}) between the rule and the contents of the box. + +@xref{\framebox (picture)}, for the @code{\framebox} command in the +@code{picture} environment. + + +@node lrbox +@section @code{lrbox} +@findex lrbox + +@code{\begin@{lrbox@}@{cmd@} text \end@{lrbox@}} + +This is the environment form of @code{\sbox}. + +The text inside the environment is saved in the box @code{cmd}, which +must have been declared with @code{\newsavebox}. + + + +@node \makebox +@section @code{\makebox} +@findex \makebox + +Synopsis: + +@example +\makebox[@var{width}][@var{position}]@{@var{text}@} +@end example + +The @code{\makebox} command creates a box just wide enough to contain +the @var{text} specified. The width of the box is specified by the +optional @var{width} argument. The position of the text within the box +is determined by the optional @var{position} argument, which may take +the following values: + +@table @code +@item c +Centered (default). +@item l +Flush left. +@item r +Flush right. +@item s +Stretch (justify) across entire @var{width}; @var{text} must contain +stretchable space for this to work. +@end table + +@code{\makebox} is also used within the picture environment +@pxref{\makebox (picture)}. + + +@node \parbox +@section @code{\parbox} +@findex \parbox + +Synopsis: + +@example +\parbox[@var{position}][@var{height}][@var{inner-pos}]@{@var{width}@}@{@var{text}@} +@end example + +The @code{\parbox} command produces a box whose contents are created +in @code{paragraph} 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} argument. For larger pieces of text, including ones +containing a paragraph-making environment, you should use a +@code{minipage} environment (@pxref{minipage}). + +@code{\parbox} has two mandatory arguments: + +@table @var +@item width +the width of the parbox; +@item text +the text that goes inside the parbox. +@end table + +The optional @var{position} argument allows you to align either the +top or bottom line in the parbox with the baseline of the surrounding +text (default is top). + +The optional @var{height} argument overrides the natural height of the box. + +The @var{inner-pos} argument controls the placement of the text inside +the box, as follows; if it is not specified, @var{position} is used. + +@table @code +@item t +text is placed at the top of the box. +@item c +text is centered in the box. +@item b +text is placed at the bottom of the box. +@item s +stretch vertically; the text must contain vertically stretchable space +for this to work. +@end table + + +@node \raisebox +@section @code{\raisebox} +@findex \raisebox + +Synopsis: + +@example +\raisebox@{distance@}[@var{height}][@var{depth}]@{text@} +@end example + +The @code{\raisebox} command raises or lowers @var{text}. The first +mandatory argument specifies how high @var{text} is to be raised (or +lowered if it is a negative amount). @var{text} itself is processed +in LR mode. + +The optional arguments @var{height} and @var{depth} are dimensions. +If they are specified, @LaTeX{} treats @var{text} as extending a +certain distance above the baseline (height) or below (depth), +ignoring its natural height and depth. + + +@node \savebox +@section @code{\savebox} +@findex \savebox + +Synopsis: + +@example +\savebox@{@var{\boxcmd}@}[@var{width}][@var{pos}]@{@var{text}@} +@end example + +This command typeset @var{text} in a box just as with @code{\makebox} +(@pxref{\makebox}), except that instead of printing the resulting box, +it saves it in the box labeled @var{\boxcmd}, which must have been +declared with @code{\newsavebox} (@pxref{\newsavebox}). + + +@node \sbox +@section @code{\sbox@{@var{\boxcmd}@}@{@var{text}@}} +@findex \sbox + +Synopsis: + +@example +\sbox@{@var{\boxcmd}@}@{@var{text}@} +@end example + +@code{\sbox} types @var{text} in a box just as with @code{\mbox} +(@pxref{\mbox}) except that instead of the resulting box being +included in the normal output, it is saved in the box labeled +@var{\boxcmd}. @var{\boxcmd} must have been previously declared with +@code{\newsavebox} (@pxref{\newsavebox}). + + +@node \usebox +@section @code{\usebox@{@var{\boxcmd}} +@findex \usebox + +Synopsis: + +@example +\usebox@{@var{\boxcmd}@} +@end example + +@code{\usebox} producesthe box most recently saved in the bin +@var{\boxcmd} by a @code{\savebox} command (@pxref{\savebox}). + + +@node Special insertions +@chapter Special insertions + +@LaTeX{} provides commands for inserting characters that have a +special meaning do not correspond to simple characters you can type. + +@menu +* Reserved characters:: Inserting # $ % & ~ _ ^ \ @{ @} +* Text symbols:: Inserting other non-letter symbols in text. +* Accents:: Inserting accents. +* Non-English characters:: Inserting other non-English characters. +* \rule:: Inserting lines and rectangles. +* \today:: Inserting today's date. +@end menu + + +@node Reserved characters +@section Reserved characters +@cindex reserved characters +@cindex characters, reserved + +The following characters play a special role in @LaTeX{} and are called +``reserved characters'' or ``special characters''. + +@example +# $ % & ~ _ ^ \ @{ @} +@end example + +@findex \# +@findex \$ +@findex \% +@findex \& +@findex \_ +@findex \@{ +@findex \@} +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{\} in front of the character. For +example, @code{\$} will produce @code{$} in your output. + +@findex \backslash +One exception to this rule is @code{\} itself, because @code{\\} has +its own special (context-dependent) meaning. A roman \ is produced by +typing @code{$\backslash$} in your file, and a typewriter @code{\} is +produced by using @samp{\} in a verbatim command (@pxref{verbatim}). + +@findex \~ +@findex \^ +Also, @code{\~} and @code{\^} place tilde and circumflex accents over +the following letter, as in @~{o} and @^{o} (@pxref{Accents}); to get +a standalone @code{~} or @code{^}, you can again use a verbatim +command. + +@findex \symbol +@cindex accessing any character of a font + +Finally, you can access any character of the current font once you +know its number by using the @code{\symbol} command. For example, the +visible space character used in the @code{\verb*} command has the code +decimal 32, so it can be typed as @code{\symbol@{32@}}. + +You can also specify octal numbers with @code{'} or hexadecimal numbers +with @code{"}, so the previous example could also be written as +@code{\symbol@{'40@}} or @code{\symbol@{"20@}}. + + +@node Text symbols +@section Text symbols + +@cindex text symbols +@LaTeX{} provides commands to generate a number of non-letter symbols +in running text. + +@ftable @code + +@item \copyright +@cindex copyright symbol +The copyright symbol, @copyright{}. + +@item \dag +@cindex dagger, in text +The dagger symbol (in text). + +@item \ddag +@cindex double dagger, in text +The double dagger symbol (in text). + +@item \LaTeX +@cindex @LaTeX{} logo +@cindex logo, @LaTeX{} +The @LaTeX{} logo. + +@item \ldots +@cindex ellipsis +An ellipsis (three dots at the baseline): `@dots{}'. This +command also works in math mode. + +@item \lq +@cindex left quote +@cindex opening quote +Left (opening) quote: `. + +@item \P +@cindex paragraph sign +@cindex pilcrow +Paragraph sign (pilcrow). + +@item \pounds +@cindex pounds symbol +@cindex sterling symbol +English pounds sterling. + +@item \rq +@cindex right quote +@cindex closing quote +Right (closing) quote: '. + +@item \S +@cindex section symbol +Section symbol. + +@item \TeX +@cindex @TeX{} logo +@cindex logo, @TeX{} +The @TeX{} logo. + +@end ftable + + +@node Accents +@section Accents + +@cindex accents +@cindex characters, accented +@cindex letters, accented + +@LaTeX{} has wide support for many of the world's scripts and +languages, through the @code{babel} package and related support. This +section does not attempt to cover all that support. It merely the +core @LaTeX{} commands for creating accented characters. + +@table @code +@item \" +@findex \" @r{(umlaut accent)} +@cindex umlaut accent +Produces an umlaut, as in @"{o}. + +@item \' +@findex \' @r{(acute accent)} +@cindex acute accent +Produces an acute accent, as in @'{o}. In the @code{tabbing} +environment, pushes current column to the right of the previous column +(@pxref{tabbing}). + +@item \. +@findex \. @r{(dot-over accent)} +@cindex dot accent +@cindex dot-over accent +Produces a dot accent over the following, as in @dotaccent{o}. + +@item \= +@findex \= @r{(macron accent)} +@cindex macron accent +@cindex overbar accent +@cindex bar-over accent +Produces a macron (overbar) accent over the following, as in @={o}. + +@item \^ +@findex \^ @r{(circumflex accent)} +@cindex circumflex accent +@cindex hat accent +Produces a circumflex (hat) accent over the following, as in @^{o}. + +@item \` +@findex \` @r{(grave accent)} +@cindex grave accent +Produces a grave accent over the following, as in @`{o}. In the +@code{tabbing} environment, move following text to the right margin +(@pxref{tabbing}). + +@item \~ +@findex \~ @r{(tilde accent)} +@cindex tilde accent +Produces a tilde accent over the following, as in @~{n}. + +@item \b +@findex \b @r{(bar-under accent)} +@cindex bar-under accent +Produces a bar accent under the following, as in @ubaraccent{o}. + +@item \bar +@findex \bar @r{(macron, bar-over accent)} +@cindex bar-over accent +@cindex macron accent +Produces a macron accent over the following, as in @={o}. + +@item \c +@findex \c @r{(cedilla accent)} +@cindex cedilla accent +Produces a cedilla accent under the following, as in @c{c}. + +@item \d +@findex \d @r{(dot-under accent)} +@cindex dot-under accent +Produces a dot accent under the following, as in @udotaccent{o}. + +@item \H +@findex \H @r{(Hungarian umlaut accent)} +@cindex hungarian umlaut accent +Produces a long Hungarian umlaut accent over the following, as in @H{o}. + +@item \i +@findex \i @r{(dotless i)} +@cindex dotless i +Produces a dotless i, as in `@dotless{i}'. + +@item \j +@findex \j @r{(dotless j)} +@cindex dotless j +Produces a dotless j, as in `@dotless{j}'. + +@item \t +@findex \t @r{(tie-after accent)} +@cindex tie-after accent +Produces a tie-after accent, as in `@tieaccent{oo}'. + +@item \u +@findex \u @r{(breve accent)} +@cindex breve accent +Produces a breve accent, as in `@u{o}'. + +@item \v +@findex \v @r{(breve accent)} +@cindex hacek accent +@cindex check accent +Produces a h@'a@v{c}ek (check) accent, as in `@v{o}'. + +@end table + + +@node Non-English characters +@section Non-English characters + +@cindex special characters +@cindex non-English characters +@cindex characters, non-English +@cindex letters, non-English + +Here are the basic @LaTeX{} commands for inserting characters commonly +used in languages other than English. + +@table @code + +@item \aa +@itemx \AA +@findex \aa (@aa{}) +@findex \AA (@AA{}) +@cindex aring +@aa{} and @AA{}. + +@item \ae +@itemx \AE +@findex \ae (@ae{}) +@findex \AE (@AE{}) +@cindex ae ligature +@ae{} and @AE{}. + +@item \l +@itemx \L +@findex \l (@l{}) +@findex \L (@L{}) +@cindex polish l +@l{} and @L{}. + +@item \o +@itemx \O +@findex \o (@o{}) +@findex \O (@O{}) +@cindex oslash +@o{} and @O{}. + +@item \oe +@itemx \OE +@findex \oe (@oe{}) +@findex \OE (@OE{}) +@cindex oe ligature +@oe{} and @OE{}. + +@item \ss +@findex \ss (@ss{}) +@cindex es-zet German letter +@cindex sharp S letters +@ss{}. + +@end table + + +@node \rule +@section @code{\rule} +@findex \rule + +Synopsis: + +@example +\rule[@var{raise}]@{@var{width}@}@{@var{thickness}@} +@end example + +The @code{\rule} command produces @dfn{rules}, that is, lines or +rectangles. The arguments are: + +@table @var +@item raise +How high to raise the rule (optional). + +@item width +The length of the rule (mandatory). + +@item thickness +The thickness of the rule (mandatory). +@end table + + +@node \today +@section @code{\today} +@findex \today + +The @code{\today} command produces today's date, in the format +@samp{@var{month} @var{dd}, @var{yyyy}}; for example, `July 4, 1976'. +It uses the predefined counters @code{\day}, @code{\month}, and +@code{\year} (@pxref{\day \month \year}) to do this. It is not +updated as the program runs. + +@cindex @code{datetime} package +The @code{datetime} package, among others, can produce a wide variety +of other date formats. + + +@node Splitting the input +@chapter Splitting the input +@cindex splitting the input file +@cindex input file + +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{}. + +@menu +* \include:: Conditionally include a file. +* \includeonly:: Determine which files are included. +* \input:: Unconditionally include a file. +@end menu + + +@node \include +@section @code{\include} +@findex \include + +Synopsis: + +@example +\include@{@var{file}@} +@end example + +If no @code{\includeonly} command is present, the @code{\include} +command executes @code{\clearpage} to start a new page +(@pxref{\clearpage}), then reads @var{file}, then does another +@code{\clearpage}. + +Given an @code{\includeonly} command, the @code{\include} actions are +only run if @var{file} is listed as an argument to +@code{\includeonly}. See the next section. + +@cindex nested @code{\include}, not allowed +The @code{\include} command may not appear in the preamble or in a file +read by another @code{\include} command. + + +@node \includeonly +@section \@code{includeonly} +@findex \includeonly + +Synopsis: + +@example +\includeonly@{@var{file1},@var{file2},...@} +@end example + +The @code{\includeonly} command controls which files will be read by +subsequent @code{\include} commands. The list of filenames is +comma-separated. Each @var{file} must exactly match a filename +specified in a @code{\include} command for the selection to be +effective. + +This command can only appear in the preamble. + + +@node \input +@section \input +@findex \input + +Synopsis: + +@example +\input@{@var{file}@} +@end example + +The @code{\input} command causes the specified @var{file} to be read +and processed, as if its contents had been inserted in the current +file at that point. + +If @var{file} does not end in @samp{.tex} (e.g., @samp{foo} or +@samp{foo.bar}), it is first tried with that extension (@samp{foo.tex} +or @samp{foo.bar.tex}). If that is not found, the original @var{file} +is tried (@samp{foo} or @samp{foo.bar}). + + +@node Front/back matter +@chapter Front/back matter + +@menu +* Tables of contents:: +* Glossaries:: +* Indexes:: +@end menu + + +@node Tables of contents +@section Tables of contents + +@cindex table of contents, creating + +@findex \tableofcontents +A table of contents is produced with the @code{\tableofcontents} +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. + +The @code{\tableofcontents} 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} command after the +@code{\tableofcontents} command. + +@findex \listoffigures +@findex \listoftables +The analagous commands @code{\listoffigures} and @code{\listoftables} +produce a list of figures and a list of tables, respectively. +Everything works exactly the same as for the table of contents. + +@findex \nofiles +The command @code{\nofiles} overrides these commands, and +@emph{prevents} any of these lists from being generated. + +@menu +* \addcontentsline:: Add an entry to table of contents etc. +* \addtocontents:: Add text directly to table of contents file etc. +@end menu + + +@node \addcontentsline +@subsection \addcontentsline +@findex \addcontentsline@{@var{ext}@}@{@var{unit}@}@{@var{text}@} +@cindex table of contents entry, manually adding + +The @code{\addcontentsline} command adds an entry to the specified list +or table where: + +@table @var +@item ext +The extension of the file on which information is to be written, +typically one of: @code{toc} (table of contents), @code{lof} (list of +figures), or @code{lot} (list of tables). + +@item unit +The name of the sectional unit being added, typically one of the +following, matching the value of the @var{ext} argument: + +@table @code +@item toc +The name of the sectional unit: @code{part}, @code{chapter}, +@code{section}, @code{subsection}, @code{subsubsection}. +@item lof +For the list of figures. +@item lot +For the list of tables. +@end table + +@item entry +The actual text of the entry. +@end table + +@findex \contentsline +What is written to the @file{.@var{ext}} file is the +command @code{\contentsline@{@var{unit}@}@{@var{name}@}}. + +@c ?? how hardwired are these values? other unit names? + + +@node \addtocontents +@subsection \addtocontents +@findex \addtocontents@{@var{ext}@}@{@var{text}@} + +The @code{\addtocontents} command adds text (or formatting commands) +directly to the @file{.}@var{ext} file that generates the table of +contents or lists of figures or tables. + +@table @var +@item ext +The extension of the file on which information is to be written: +@file{toc} (table of contents), @file{lof} (list of figures), or +@file{lot} (list of tables). + +@item text +The text to be written. +@end table + + +@node Glossaries +@section Glossaries +@cindex glossaries + +@findex \makeglossary +The command @code{\makeglossary} enables creating glossaries. + +@findex \glossary +@cindex @file{.glo} file +The command @code{\glossary@{@var{text}@}} writes a glossary entry for +@var{text} to an auxiliary file with the @file{.glo} extension. + +@findex \glossaryentry +Specifically, what gets written is the command +@code{\glossaryentry@{@var{text}@}@{@var{pageno}@}}, where +@var{pageno} is the current @code{\thepage} value. + +The @code{glossary} package on CTAN provides support for fancier +glossaries. + + +@node Indexes +@section Indexes +@cindex indexes + +@findex \makeindex +The command @code{\makeindex} enables creating indexes. + +@findex \index +@cindex @file{.idx} file +The command @code{\index@{@var{text}@}} writes a glossary entry for +@var{text} to an auxiliary file with the @file{.idx} extension. + +@findex \indexentry +Specifically, what gets written is the command +@code{\indexentry@{@var{text}@}@{@var{pageno}@}}, where @var{pageno} +is the current @code{\thepage} value. + +The rubber length @code{\indexspace} is inserted before each new +letter in the index; its default value is @samp{10pt plus5pt +minus3pt}. + +@cindex @command{makeindex} program +@cindex @command{xindy} program +@cindex @file{.ind} file + +The @file{.idx} file can then be sorted with an external command, +typically @command{makeindex} or @command{xindy}, resulting in a +@file{.ind} file, which can then be used to typeset the index. + + +@node Letters +@chapter Letters +@cindex letters +@cindex creating letters + +You can use @LaTeX{} to typeset letters, both personal and business. The +@code{letter} document class is designed to make a number of letters at +once, although you can make just one if you so desire. + +Your @file{.tex} source file has the same minimum commands as the other +document classes, i.e., you must have the following commands as a +minimum: + +@example + \documentclass@{letter@} + \begin@{document@} + ... letters ... + \end@{document@} +@end example + +Each letter is a @code{letter} environment, whose argument is the name +and address of the recipient. For example, you might have: + +@example + \begin@{letter@}@{Mr. Joe Smith\\ 2345 Princess St. + \\ Edinburgh, EH1 1AA@} + ... + \end@{letter@} +@end example + +The letter itself begins with the @code{\opening} command. The text of +the letter follows. It is typed as ordinary @LaTeX{} input. Commands that +make no sense in a letter, like @code{\chapter}, do not work. The letter +closes with a @code{\closing} command. + +@findex \\ @r{for letters} +After the @code{closing}, you can have additional material. The +@code{\cc} command produces the usual ``cc: @dots{}''. There's also a +similar @code{\encl} command for a list of enclosures. With both these +commands, use @code{\\} to separate the items. + +These commands are used with the @code{letter} class. + +@menu +* \address:: Your return address. +* \cc:: Cc list. +* \closing:: Saying goodbye. +* \encl:: List of enclosed material. +* \location:: Your organisation's address. +* \makelabels:: Making address labels. +* \name:: Your name, for the return address. +* \opening:: Saying hello. +* \ps:: Adding a postscript. +* \signature:: Your signature. +* \startbreaks:: Allow page breaks. +* \stopbreaks:: Disallow page breaks. +* \telephone:: Your phone number. +@end menu + + +@node \address +@section \address@{@var{return-address@}} +@findex \address + +The @code{\address} specifies the return address of a letter, as it +should appear on the letter and the envelope. Separate lines of the +address should be separated by @code{\\} commands. + +If you do not make an @code{\address} declaration, then the letter +will be formatted for copying onto your organisation's standard +letterhead. (@xref{Overview}, for details on your local +implementation). If you give an @code{\address} declaration, then the +letter will be formatted as a personal letter. + + +@node \cc +@section @code{\cc} + +@findex \cc +@cindex cc list, in letters + +Synopsis: + +@example +\cc@{@var{name1}\\@var{name2}@} +@end example + +Produce a list of @var{name}s the letter was copied to. Each name is +printed on a separate line. + + +@node \closing +@section @code{\closing} + +@findex \closing +@cindex letters, ending +@cindex closing letters + +Synopsis: + +@example +\closing@{text@} +@end example + +A letter closes with a @code{\closing} command, for example, +@example +\closing@{Best Regards,@} +@end example + + +@node \encl +@section @code{\encl} + +@findex \encl +@cindex enclosure list + +Synopsis: + +@example +\encl@{@var{line1}\\@var{line2}@} +@end example + +Declare a list of one more enclosures. + + +@node \location +@section @code{\location} +@findex \location + +@code{\location@{address@}} + +This modifies your organisation's standard address. This only appears +if the @code{firstpage} pagestyle is selected. + + +@node \makelabels +@section @code{\makelabels} +@findex \makelabels + +@code{\makelabels@{number@}} + +If you issue this command in the preamble, @LaTeX{} will create a sheet of +address labels. This sheet will be output before the letters. + + + +@node \name +@section @code{\name} +@findex \name + +@code{\name@{June Davenport@}} + +Your name, used for printing on the envelope together with the return +address. + + +@node \opening +@section @code{\opening@{@var{text}@}} +@findex \opening +@cindex letters, starting + +Synopsis: + +@example +\opening@{@var{text}@} +@end example + +A letter begins with the @code{\opening} command. The mandatory +argument, @var{text}, is whatever text you wish to start your letter. +For instance: + +@example +\opening@{Dear Joe,@} +@end example + + +@node \ps +@section @code{\ps} +@findex \ps +@cindex postscript, in letters + +Use the @code{\ps} command to start a postscript in a letter, after +@code{\closing}. + + +@node \signature +@section @code{\signature@{@var{text}@}} +@findex \signature + +Your name, as it should appear at the end of the letter underneath the +space for your signature. @code{\\} starts a new line within +@var{text} as usual. + + +@node \startbreaks +@section @code{\startbreaks} +@findex \startbreaks + +@code{\startbreaks} + +Used after a @code{\stopbreaks} command to allow page breaks again. + + + +@node \stopbreaks +@section @code{\stopbreaks} +@findex \stopbreaks + +@code{\stopbreaks} + +Inhibit page breaks until a @code{\startbreaks} command occurs. + + + +@node \telephone +@section @code{\telephone} +@findex \telephone + +@code{\telephone@{number@}} + +This is your telephone number. This only appears if the +@code{firstpage} pagestyle is selected. + + +@node Terminal Input/Output +@chapter Terminal Input/Output +@cindex input/Output +@cindex terminal Input/Output + +@menu +* \typein:: Read text from the terminal. +* \typeout:: Write text to the terminal. +@end menu + + +@node \typein +@section @code{\typein[@var{cmd}]@{@var{msg}@}} +@findex \typein + +Synopsis: + +@example +\typein[@var{\cmd}]@{@var{msg}@} +@end example + +@code{\typein} prints @var{msg} 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} argument is omitted, the typed input is +processed as if it had been included in the input file in place of the +@code{\typein} command. If the @var{\cmd} argument is present, it +must be a command name. This command name is then defined or +redefined to be the typed input. + + +@node \typeout +@section @code{\typeout@{@var{msg}@}} +@findex \typeout + +Synopsis: + +@example +\typeout@{@var{msg}@} +@end example + +Prints @code{msg} on the terminal and in the @code{log} file. +Commands in @code{msg} that are defined with @code{\newcommand} or +@code{\renewcommand} (among others) are replaced by their definitions +before being printed. + +@LaTeX{}'s usual rules for treating multiple spaces as a single space +and ignoring spaces after a command name apply to @code{msg}. A +@code{\space} command in @code{msg} causes a single space to be +printed, independent of surrounding spaces. A @code{^^J} in +@code{msg} prints a newline. + + +@node Command Line +@chapter Command Line +@cindex command Line + +The input file specification indicates the file to be formatted; +@TeX{} uses @file{.tex} 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. + +@example +latex '\nonstopmode\input foo.tex' +@end example + +@noindent +will process @file{foo.tex} without pausing after every error. + +@cindex @samp{*} prompt +@cindex prompt, @samp{*} +@findex \stop +If @LaTeX{} stops in the middle of the document and gives you a +@samp{*} prompt, it is waiting for input. You can type @code{\stop} +(and return) and it will prematurely end the document. + + + +@node Document templates +@appendix Document templates +@cindex document templates + +Although not reference material, perhaps these document templates will +be useful. + +@menu +* book template:: +* beamer template:: +* tugboat template:: +@end menu + + +@node book template +@section @code{book} template + +@verbatim +\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} +@end verbatim + + +@node beamer template +@section @code{beamer} template + +The @code{beamer} class creates slides presentations. + +@verbatim +\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} + +@end verbatim + + +@node tugboat template +@section @code{tugboat} template + +@cite{TUGboat} is the journal of the @TeX{} Users Group, +@url{http://tug.org/TUGboat}. + +@verbatim +\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} +@end verbatim + + +@node Concept Index +@unnumbered Concept Index + +@printindex cp + +@c The name of the `Command Index' node must NOT be altered for ltx-help.el. +@node Command Index +@unnumbered Command Index + +@printindex fn + +@bye diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt new file mode 100644 index 00000000000..c1e85d52913 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.txt @@ -0,0 +1,5951 @@ +Short Contents +************** + +LaTeX2e +1 Overview of LaTeX +2 Starting & ending +3 Document classes +4 Typefaces +5 Layout +6 Sectioning +7 Cross references +8 Environments +9 Footnotes +10 Definitions +11 Counters +12 Lengths +13 Line breaking +14 Page breaking +15 Making paragraphs +16 Math formulas +17 Modes +18 Page Styles +19 Spaces +20 Boxes +21 Special insertions +22 Splitting the input +23 Front/back matter +24 Letters +25 Terminal Input/Output +26 Command Line +Appendix A Document templates +Concept Index +Command Index + + +Table of Contents +***************** + +LaTeX2e +1 Overview of LaTeX +2 Starting & ending +3 Document classes + 3.1 Document class options +4 Typefaces + 4.1 Font styles + 4.2 Font sizes + 4.3 Low-level font commands +5 Layout + 5.1 `\onecolumn' + 5.2 `\twocolumn' + 5.3 `\flushbottom' + 5.4 `\raggedbottom' + 5.5 Page layout parameters +6 Sectioning +7 Cross references + 7.1 `\label' + 7.2 `\pageref{KEY}' + 7.3 `\ref{KEY}' +8 Environments + 8.1 `abstract' + 8.2 `array' + 8.3 `center' + 8.3.1 `\centering' + 8.4 `description' + 8.5 `displaymath' + 8.6 `document' + 8.7 `enumerate' + 8.8 `eqnarray' + 8.9 `equation' + 8.10 `figure' + 8.11 `flushleft' + 8.11.1 `\raggedright' + 8.12 `flushright' + 8.12.1 `\raggedleft' + 8.13 `itemize' + 8.14 `letter' environment: writing letters + 8.15 `list' + 8.16 `math' + 8.17 `minipage' + 8.18 `picture' + 8.18.1 `\circle' + 8.18.2 `\makebox' + 8.18.3 `\framebox' + 8.18.4 `\dashbox' + 8.18.5 `\frame' + 8.18.6 `\line' + 8.18.7 `\linethickness' + 8.18.8 `\thicklines' + 8.18.9 `\thinlines' + 8.18.10 `\multiput' + 8.18.11 `\oval' + 8.18.12 `\put' + 8.18.13 `\shortstack' + 8.18.14 `\vector' + 8.19 `quotation' + 8.20 `quote' + 8.21 `tabbing' + 8.22 `table' + 8.23 `tabular' + 8.23.1 `\multicolumn' + 8.23.2 `\cline' + 8.23.3 `\hline' + 8.23.4 `\vline' + 8.24 `thebibliography' + 8.24.1 `\bibitem' + 8.24.2 `\cite' + 8.24.3 `\nocite' + 8.24.4 Using BibTeX + 8.25 `theorem' + 8.26 `titlepage' + 8.27 `verbatim' + 8.27.1 `\verb' + 8.28 `verse' +9 Footnotes + 9.1 `\footnote' + 9.2 `\footnotemark' + 9.3 `\footnotetext' + 9.4 Footnote parameters +10 Definitions + 10.1 `\newcommand' & `\renewcommand' + 10.2 `\newcounter' + 10.3 `\newlength' + 10.4 `\newsavebox' + 10.5 `\newenvironment' & `\renewenvironment' + 10.6 `\newtheorem' + 10.7 `\newfont' + 10.8 `\protect' +11 Counters + 11.1 `\alph \Alph \arabic \roman \Roman \fnsymbol': Printing counters + 11.2 `\usecounter{COUNTER}' + 11.3 `\value{COUNTER}' + 11.4 `\setcounter{COUNTER}{VALUE}' + 11.5 `\addtocounter{COUNTER}{VALUE}' + 11.6 `\refstepcounter{COUNTER}' + 11.7 `\stepcounter{COUNTER}' + 11.8 `\day \month \year': Predefined counters +12 Lengths + 12.1 `\setlength{\LEN}{VALUE}' + 12.2 \addtolength{\LEN}{AMOUNT} + 12.3 `\settodepth' + 12.4 `\settoheight' + 12.5 `\settowidth{\LEN}{TEXT}' + 12.6 Predefined lengths +13 Line breaking + 13.1 `\\'[*][MORESPACE] + 13.2 `\obeycr' & `\restorecr' + 13.3 `\newline' + 13.4 `\-' (discretionary hyphen) + 13.5 `\fussy' + 13.6 `\sloppy' + 13.7 `\hyphenation' + 13.8 `\linebreak' & `\nolinebreak' +14 Page breaking + 14.1 `\cleardoublepage' + 14.2 `\clearpage' + 14.3 `\newpage' + 14.4 `\enlargethispage' + 14.5 `\pagebreak' & `\nopagebreak' +15 Making paragraphs + 15.1 `\indent' + 15.2 `\noindent' + 15.3 `\parskip' + 15.4 Marginal notes +16 Math formulas + 16.1 Subscripts & Superscripts + 16.2 Math symbols + 16.3 Math functions + 16.4 Math accents + 16.5 Spacing in math mode + 16.6 Math Miscellany +17 Modes +18 Page Styles + 18.1 `\maketitle' + 18.2 `\pagenumbering' + 18.3 `\pagestyle' + 18.4 `\thispagestyle{STYLE}' +19 Spaces + 19.1 `\hspace' + 19.2 `\hfill' + 19.3 `\SPACE' + 19.4 `\@' + 19.5 `\thinspace' + 19.6 `\/' + 19.7 `\hrulefill' + 19.8 `\dotfill' + 19.9 `\addvspace' + 19.10 `\bigskip \medskip \smallskip' + 19.11 `\vfill' + 19.12 `\vspace[*]{LENGTH}' +20 Boxes + 20.1 `\mbox{TEXT}' + 20.2 `\fbox' and `\framebox' + 20.3 `lrbox' + 20.4 `\makebox' + 20.5 `\parbox' + 20.6 `\raisebox' + 20.7 `\savebox' + 20.8 `\sbox{\BOXCMD}{TEXT}' + 20.9 `\usebox{\BOXCMD' +21 Special insertions + 21.1 Reserved characters + 21.2 Text symbols + 21.3 Accents + 21.4 Non-English characters + 21.5 `\rule' + 21.6 `\today' +22 Splitting the input + 22.1 `\include' + 22.2 \`includeonly' + 22.3 \input +23 Front/back matter + 23.1 Tables of contents + 23.1.1 \addcontentsline + 23.1.2 \addtocontents + 23.2 Glossaries + 23.3 Indexes +24 Letters + 24.1 \address{RETURN-ADDRESS} + 24.2 `\cc' + 24.3 `\closing' + 24.4 `\encl' + 24.5 `\location' + 24.6 `\makelabels' + 24.7 `\name' + 24.8 `\opening{TEXT}' + 24.9 `\ps' + 24.10 `\signature{TEXT}' + 24.11 `\startbreaks' + 24.12 `\stopbreaks' + 24.13 `\telephone' +25 Terminal Input/Output + 25.1 `\typein[CMD]{MSG}' + 25.2 `\typeout{MSG}' +26 Command Line +Appendix A Document templates + A.1 `book' template + A.2 `beamer' template + A.3 `tugboat' template +Concept Index +Command Index + + +LaTeX2e +******* + +This document is version 2.0 (June 2008) of an unofficial reference +manual for LaTeX, a document preparation system. It is intended to +cover LaTeX2e, which has been the standard version of LaTeX for many +years. + + 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 +(`http://latex-project.org'). 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. + +1 Overview of LaTeX +******************* + +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: + + 1. A main output file, which is one of: + + 1. If invoked as `latex', a "Device Independent" (`.dvi') file. + This contains commands that can be translated into commands + for a variety of output devices. You can view such `.dvi' + output of LaTeX by using a program such as `xdvi' (display + directly) or `dvips' (convert to PostScript). + + 2. If invoked as `pdflatex', a "Portable Document Format" + (`.pdf') 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 `.dvi' produced + from the same document. + + There are other less-common variants of LaTeX (and TeX) as well, + which can produce HTML, XML, and other things. + + 2. A "transcript" or `.log' file that contains summary information and + diagnostic messages for any errors discovered in the input file. + + 3. An "auxiliary" or `.aux' file. This is used by LaTeX itself, for + things such as sectioning. + + A LaTeX command begins with the command name, which consists of a +`\' followed by either (a) a string of letters or (b) a single +non-letter. Arguments contained in square brackets, `[]', are optional +while arguments contained in braces, `{}', are required. + + LaTeX is case sensitive. Enter all commands in lower case unless +explicitly directed to do otherwise. + +2 Starting & ending +******************* + +A minimal input file looks like the following: + + \documentclass{CLASS} + \begin{document} + YOUR TEXT + \end{document} + +where the CLASS is a valid document class for LaTeX. *Note Document +classes::, for details of the various document classes available +locally. + + You may include other LaTeX commands between the `\documentclass' +and the `\begin{document}' commands (this area is called the +"preamble"). + +3 Document classes +****************** + +The class of a given document is defined with the command: + + \documentclass[OPTIONS]{CLASS} + +The `\documentclass' command must be the first command in a LaTeX +source file. + + Built-in LaTeX document CLASS names are (many other document classes +are available as add-ons; *note Overview::): + + article report book letter slides + + Standard OPTIONS are described below. + +3.1 Document class options +========================== + +You can specify so-called "global options" or "class options" to the +`\documentclass' command by enclosing them in square brackets as usual. +To specify more than one OPTION, separate them with a comma: + + \documentclass[OPTION1,OPTION2,...]{CLASS} + + Here is the list of the standard class options. + + All of the standard classes except `slides' accept the following +options for selecting the typeface size (default is `10pt'): + + 10pt 11pt 12pt + + All of the standard classes accept these options for selecting the +paper size (default is `letterpaper'): + + a4paper a5paper b5paper executivepaper legalpaper letterpaper + + Miscellaneous other options: + +`draft, final' + mark/do not mark overfull boxes with a big black box; default is + `final'. + +`fleqn' + Put displayed formulas flush left; default is centered. + +`landscape' + Selects landscape format; default is portrait. + +`leqno' + Put equation numbers on the left side of equations; default is the + right side. + +`openbib' + Use "open" bibliography format. + +`titlepage, notitlepage' + Specifies whether the title page is separate; default depends on + the class. + + These options are not available with the slides class: + +`onecolumn' +`twocolumn' + Typeset in one or two columns; default is `onecolumn'. + +`oneside' +`twoside' + Selects one- or two-sided layout; default is `oneside', except for + the `book' class. + + The `\evensidemargin' (`\oddsidemargin' 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, + `\oddsidemargin' is 40% of the difference between `\paperwidth' + and `\textwidth' with `\evensidemargin' the remainder. + +`openright' +`openany' + Determines if a chapter should start on a right-hand page; default + is `openright' for book. + + The `slides' class offers the option `clock' for printing the time +at the bottom of each note. + + Additional packages are loaded like this: + + \usepackage[OPTIONS]{PKG} + + To specify more than one PKG, you can separate them with a comma, or +use multiple `\usepackage' commands. + + Any options given in the `\documentclass' command that are unknown +by the selected document class are passed on to the packages loaded with +`\usepackage'. + +4 Typefaces +*********** + +Two important aspects of selecting a "font" are specifying a size and a +style. The LaTeX commands for doing this are described here. + +4.1 Font styles +=============== + +The following type style commands are supported by LaTeX. + + These commands are used like `\textit{italic text}'. 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. + + The declaration forms are cumulative; i.e., you can say either +`\sffamily\bfseries' or `\bfseries\sffamily' to get bold sans serif. + + You can also use the environment form of the declaration forms; for +instance, `\begin{ttfamily}...\end{ttfamily}'. + +`\textrm (\rmfamily)' + Roman. + +`\textit (\itshape)' + Italics. + +`\emph' + Emphasis (switches between `\textit' and `\textrm'). + +`\textmd (\mdseries)' + Medium weight (default). + +`\textbf (\bfseries)' + Boldface. + +`\textup (\upshape)' + Upright (default). The opposite of slanted. + +`\textsl (\slshape)' + Slanted. + +`\textsf (\sffamily)' + Sans serif. + +`\textsc (\scshape)' + Small caps. + +`\texttt (\ttfamily)' + Typewriter. + +`\textnormal (\normalfont)' + Main document font. + +`\mathrm' + Roman, for use in math mode. + +`\mathbf' + Boldface, for use in math mode. + +`\mathsf' + Sans serif, for use in math mode. + +`\mathtt' + Typewriter, for use in math mode. + +`\mathit' +`(\mit)' + Italics, for use in math mode. + +`\mathnormal' + For use in math mode, e.g. inside another type style declaration. + +`\mathcal' + `Calligraphic' letters, for use in math mode. + + In addition, the command `\mathversion{bold}' can be used for +switching to bold letters and symbols in formulas. +`\mathversion{normal}' restores the default. + + LaTeX also provides these commands, which unconditionally switch to +the given style, that is, are _not_ cumulative. They are used +differently than the above commands, too: `{\CMD ...}' instead of +`\CMD{...}'. These are two very different things. + +`\bf' + Switch to bold face. + +`\cal' + Switch to calligraphic letters for math. + +`\em' + Emphasis (italics within roman, roman within italics). + +`\it' + Italics. + +`\rm' + Roman. + +`\sc' + Small caps. + +`\sf' + Sans serif. + +`\sl' + Slanted (oblique). + +`\tt' + Typewriter (monospace, fixed-width). + + +4.2 Font sizes +============== + +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 `10pt', `11pt', and `12pt' document size +options, respectively (*note Document class options::). + +Command `10pt' `11pt' `12pt' +-------------------------------------------------- +`\tiny' 5 6 6 +`\scriptsize' 7 8 8 +`\footnotesize' 8 9 10 +`\small' 9 10 10.95 +`\normalsize' (default) 10 10.95 12 +`\large' 12 12 14.4 +`\Large' 14.4 14.4 17.28 +`\LARGE' 17.28 17.28 20.74 +`\huge' 20.74 20.74 24.88 +`\Huge' 24.88 24.88 24.88 + + 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, `\begin{tiny}...\end{tiny}'. + +4.3 Low-level font commands +=========================== + +These commands are primarily intended for writers of macros and +packages. The commands listed here are only a subset of the available +ones. + +`\fontencoding{enc}' + Select font encoding. Valid encodings include `OT1' and `T1'. + +`\fontfamily{family}' + Select font family. Valid families include: + + * `cmr' for Computer Modern Roman + + * `cmss' for Computer Modern Sans Serif + + * `cmtt' for Computer Modern Typewriter + + and numerous others. + +`\fontseries{series}' + Select font series. Valid series include: + + * `m' Medium (normal) + + * `b' Bold + + * `c' Condensed + + * `bc' Bold condensed + + * `bx' Bold extended + + and various other combinations. + +`\fontshape{shape}' + Select font shape. Valid shapes are: + + * `n' Upright (normal) + + * `it' Italic + + * `sl' Slanted (oblique) + + * `sc' Small caps + + * `ui' Upright italics + + * `ol' Outline + + The two last shapes are not available for most font families. + +`\fontsize{size}{skip}' + Set font size. The first parameter is the font size to switch to + and the second is the line spacing to use; this is stored in a + parameter named `\baselineskip'. The unit of both parameters + defaults to pt. The default `\baselineskip' for the Computer + Modern typeface is 1.2 times the `\fontsize'. + + The line spacing is also multiplied by the value of the + `\baselinestretch' parameter when the type size changes; the + default is 1. However, the best way to "double space" a document, + if you should be unlucky enough to have to produce such, is to use + the `setspace' package; see + `http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace'. + +`\selectfont' + The changes made by calling the four font commands described above + do not come into effect until `\selectfont' is called. + +`\usefont{enc}{family}{series}{shape}' + The same as invoking `\fontencoding', `\fontfamily', `\fontseries' + and `\fontshape' with the given parameters, followed by + `\selectfont'. + +5 Layout +******** + +Miscellaneous commands for controlling the general layout of the page. + +5.1 `\onecolumn' +================ + +The `\onecolumn' declaration starts a new page and produces +single-column output. This is the default. + +5.2 `\twocolumn' +================ + +Synopsis: + + \twocolumn[TEXT1COL] + + The `\twocolumn' declaration starts a new page and produces +two-column output. If the optional TEXT1COL argument is present, it is +typeset in one-column mode before the two-column typesetting starts. + + These parameters control typesetting in two-column output: + +`\columnsep' + The distance between columns (35pt by default). + +`\columnseprule' + The width of the rule between columns; the default is 0pt, so + there is no rule. + +`\columnwidth' + The width of the current column; this is equal to `\textwidth' in + single-column text. + + + These parameters control float behavior in two-column output: + +`\dbltopfraction' + Maximum fraction at the top of a two-column page that may be + occupied by floats. Default `.7', can be usefully redefined to + (say) `.9' to avoid going to float pages so soon. + +`\dblfloatpagefraction' + The minimum fraction of a float page that must be occupied by + floats, for a two-column float page. Default `.5'. + +`\dblfloatsep' + Distance between floats at the top or bottom of a two-column float + page. Default `12pt plus2pt minus2pt' for `10pt' and `11pt' + documents, `14pt plus2pt minus4pt' for `12pt'. + +`\dbltextfloatsep' + Distance between a multi-column float at the top or bottom of a + page and the main text. Default `20pt plus2pt minus4pt'. + + +5.3 `\flushbottom' +================== + +The `\flushbottom' declaration makes all text pages the same height, +adding extra vertical space where necessary to fill out the page. + + This is the default if `twocolumn' mode is selected (*note Document +class options::). + +5.4 `\raggedbottom' +=================== + +The `\raggedbottom' declaration makes all pages the natural height of +the material on that page. No rubber lengths will be stretched. + +5.5 Page layout parameters +========================== + +`\headheight' + Height of the box that contains the running head. Default is + `30pt', except in the `book' class, where it varies with the type + size. + +`\headsep' + Vertical distance between the bottom of the header line and the + top of the main text. Default is `25pt', except in the `book' + class, where it varies with the type size. + +`\footskip' + Distance from the baseline of the last line of text to the + baseline of the page footer. Default is `30pt', except in the + `book' class, where it varies with the type size. + +`\linewidth' + Width of the current line; the default varies with the font size, + paper width, two-column mode, etc. For an `article' document in + `10pt', it's set to `345pt'; in two-column mode, that becomes + `229.5pt'. + +`\textheight' + The normal vertical height of the page body; the default varies + with the font size, document class, etc. For an `article' or + `report' document in `10pt', it's set to `43\baselineskip'; for + `book', it's `41\baselineskip'. For `11pt', it's + `38\baselineskip' and for `12pt', `36\baselineskip'. + +`\textwidth' + The normal horizontal width of the page body; the default varies as + usual. For an `article' or `report' document, it's `345pt' at + `10pt', `360pt' at `11pt', and `390pt' at `12pt'. For a `book' + document, it's `4.5in' at `10pt', and `5in' at `11pt' or `12pt'. + +`\topmargin' + Space between the top of the TeX page (one inch from the top of the + paper, by default) and the top of the header. The default is + computed based on many other parameters: `\paperheight - 2in - + \headheight - \headsep - \textheight - \footskip', and then + divided by two. + +`\topskip' + 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., `10pt' at `10pt'. + + +6 Sectioning +************ + +Sectioning commands provide the means to structure your text into units: + +`\part' + +`\chapter' + (report and book class only) + +`\section' + +`\subsection' + +`\subsubsection' + +`\paragraph' + +`\subparagraph' + + All sectioning commands take the same general form, e.g., + + \chapter[TOCTITLE]{TITLE} + + In addition to providing the heading TITLE in the main text, the +section title can appear in two other places: + + 1. The table of contents. + + 2. The running head at the top of the page. + + 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 +TOCTITLE that, when given, specifies the text for these other places. + + Also, all sectioning commands have `*'-forms that print TITLE as +usual, but do not include a number and do not make an entry in the +table of contents. For instance: + + \section*{Preamble} + + The `\appendix' command changes the way following sectional units +are numbered. The `\appendix' command itself generates no text and +does not affect the numbering of parts. The normal use of this command +is something like + + \chapter{A Chapter} + ... + \appendix + \chapter{The First Appendix} + +7 Cross references +****************** + +One reason for numbering things like figures and equations is to refer +the reader to them, as in "See Figure 3 for more details." + +7.1 `\label' +============ + +Synopsis: + + \label{KEY} + + A `\label' command appearing in ordinary text assigns to KEY the +number of the current sectional unit; one appearing inside a numbered +environment assigns that number to KEY. + + A KEY name can consist of any sequence of letters, digits, or +punctuation characters. Upper and lowercase letters are distinguished. + + 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: + +`ch' + for chapters + +`sec' + for lower-level sectioning commands + +`fig' + for figures + +`tab' + for tables + +`eq' + for equations + + Thus, a label for a figure would look like `fig:snark' or +`fig.snark'. + +7.2 `\pageref{KEY}' +=================== + +Synopsis: + + \pageref{KEY} + + The `\pageref'{KEY} command produces the page number of the place in +the text where the corresponding `\label'{KEY} command appears. + +7.3 `\ref{KEY}' +=============== + +Synopsis: + + \ref{KEY} + + The `\ref' command produces the number of the sectional unit, +equation, footnote, figure, ..., of the corresponding `\label' command +(*note \label::). It does not produce any text, such as the word +`Section' or `Figure', just the bare number itself. + +8 Environments +************** + +LaTeX provides many environments for marking off certain text. Each +environment begins and ends in the same manner: + + \begin{ENVNAME} + ... + \end{ENVNAME} + +8.1 `abstract' +============== + +Synopsis: + \begin{abstract} + ... + \end{abstract} + + Environment for producing an abstract, possibly of multiple +paragraphs. + +8.2 `array' +=========== + +Synopsis: + + \begin{array}{TEMPLATE} + COL1 TEXT&COL1 TEXT&COLN}\\ + ... + \end{array} + + Math arrays are produced with the `array' environment, normally +within an `equation' environment (*note equation::). It has a single +mandatory TEMPLATE argument describing the number of columns and the +alignment within them. Each column COL is specified by a single letter +that tells how items in that row should be formatted, as follows: + +`c' + centered + +`l' + flush left + +`r' + flush right + + Column entries are separated by `&'. Column entries may include +other LaTeX commands. Each row of the array is terminated with `\\'. + + In the template, the construct `@{TEXT}' puts TEXT between columns +in each row. + + Here's an example: + + \begin{equation} + \begin{array}{lrc} + left1 & right1 & centered1 \\ + left2 & right2 & centered2 \\ + \end{array} + \end{equation} + + The `\arraycolsep' parameter defines half the width of the space +separating columns; the default is `5pt'. *Note tabular::, for other +parameters which affect formatting in `array' environments, namely +`\arrayrulewidth' and `\arraystretch'. + + The `array' environment can only be used in math mode. + +8.3 `center' +============ + +Synopsis: + + \begin{center} + LINE1 \\ + LINE2 \\ + \end{center} + + The `center' environment allows you to create a paragraph consisting +of lines that are centered within the left and right margins on the +current page. Each line is terminated with the string `\\'. + +8.3.1 `\centering' +------------------ + +The `\centering' declaration corresponds to the `center' environment. +This declaration can be used inside an environment such as `quote' or +in a `parbox'. Thus, the text of a figure or table can be centered on +the page by putting a `\centering' command at the beginning of the +figure or table environment. + + Unlike the `center' environment, the `\centering' command does not +start a new paragraph; it simply changes how LaTeX formats paragraph +units. To affect a paragraph unit's format, the scope of the +declaration must contain the blank line or `\end' command (of an +environment such as quote) that ends the paragraph unit. + + Here's an example: + + \begin{quote} + \centering + first line \\ + second line \\ + \end{quote} + +8.4 `description' +================= + +Synopsis: + + \begin{description} + \item [LABEL1] ITEM1 + \item [LABEL2] ITEM2 + ... + \end{description} + + The `description' environment is used to make labelled lists. Each +LABEL is typeset in bold, flush right. The ITEM text may contain +multiple paragraphs. + + Another variation: since the bold style is applied to the labels, if +you typeset a label in typewriter using `\texttt', you'll get bold +typewriter: `\item[\texttt{bold and typewriter}]'. This may be too +bold, among other issues. To get just typewriter, use `\tt', which +resets all other style variations: `\item[{\tt plain typewriter}]'. + + For details about list spacing, see *note itemize::. + +8.5 `displaymath' +================= + +Synopsis: + \begin{displaymath} + MATH + \end{displaymath} + +or + + \[MATH\] + + The `displaymath' environment (`\[...\]' is a synonym) typesets the +MATH text on its own line, centered by default. The global `fleqn' +option makes equations flush left; see *note Document class options::. + + No equation number is added to `displaymath' text; to get an +equation number, use the `equation' environment (*note equation::). + +8.6 `document' +============== + +The `document' environment encloses the body of a document. It is +required in every LaTeX document. *Note Starting & ending::. + +8.7 `enumerate' +=============== + +Synopsis: + + \begin{enumerate} + \item ITEM1 + \item ITEM2 + ... + \end{enumerate} + + The `enumerate' environment produces a numbered list. Enumerations +can be nested within one another, up to four levels deep. They can also +be nested within other paragraph-making environments, such as `itemize' +(*note itemize::) and `description' (*note description::). + + Each item of an enumerated list begins with an `\item' command. +There must be at least one `\item' command within the environment. + + By default, the numbering at each level is done like this: + + 1. 1., 2., ... + + 2. (a), (b), ... + + 3. i., ii., ... + + 4. A., B., ... + + The `enumerate' environment uses the counters `\enumi' through +`\enumiv' counters (*note Counters::). If the optional argument to +`\item' is given, the counter is not incremented for that item. + + The `enumerate' environment uses the commands `\labelenumi' through +`\labelenumiv' to produce the default label. So, you can use +`\renewcommand' to change the labels (*note \newcommand & +\renewcommand::). For instance, to have the first level use uppercase +letters: + + \renewcommand{\labelenumi}{\Alph{enumi}} + +8.8 `eqnarray' +============== + + \begin{eqnarray} (or `eqnarray*') + FORMULA1 \\ + FORMULA2 \\ + ... + \end{eqnarray} + + The `eqnarray' environment is used to display a sequence of +equations or inequalities. It is very much like a three-column `array' +environment, with consecutive rows separated by `\\' and consecutive +items within a row separated by an `&'. + + `\\*' can also be used to separate equations, with its normal +meaning of not allowing a page break at that line. + + An equation number is placed on every line unless that line has a +`\nonumber' command. Alternatively, The `*'-form of the environment +(`\begin{eqnarray*} ... \end{eqnarray*}') will omit equation numbering +entirely, while otherwise being the same as `eqnarray'. + + The command `\lefteqn' is used for splitting long formulas across +lines. It typesets its argument in display style flush left in a box of +zero width. + +8.9 `equation' +============== + +Synopsis: + + \begin{equation} + MATH + \end{equation} + + The `equation' environment starts a `displaymath' environment (*note +displaymath::), e.g., centering the MATH text on the page, and also +places an equation number in the right margin. + +8.10 `figure' +============= + + \begin{figure}[PLACEMENT] + FIGBODY + \label{LABEL} + \caption[LOFTITLE]{TEXT} + \end{figure} + + Figures are objects that are not part of the normal text, and are +instead "floated" to a convenient place, such as the top of a page. +Figures will not be split between two pages. + + The optional argument `[placement]' determines where LaTeX will try +to place your figure. There are four places where LaTeX can possibly +put a float: + + 1. `h' (Here) - at the position in the text where the figure + environment appears. + + 2. `t' (Top) - at the top of a text page. + + 3. `b' (Bottom) - at the bottom of a text page. + + 4. `p' (Page of floats) - on a separate float page, which is a page + containing no text, only floats. + + The standard report and article classes use the default placement +`tbp'. + + The body of the figure is made up of whatever text, LaTeX commands, +etc. you wish. + + The `\caption' command specifies caption TEXT for the figure. The +caption is numbered by default. If LOFTITLE is present, it is used in +the list of figures instead of TEXT (*note Tables of contents::). + + The maximum fraction of the page allowed to be occuped by floats at + the bottom; default `.3'. + +`\floatpagefraction' + The minimum fraction of a float page that must be occupied by + floats; default `.5'. + +`\floatsep' + Space between floats at the top or bottom of a page; default `12pt + plus2pt minus2pt'. + +`\intextsep' + Space above and below a float in the middle of the main text; + default `12pt plus2pt minus2pt' for `10pt' and `11pt' styles, + `14pt plus4pt minus4pt' for `12pt'. + +`\textfloatsep' + Space between the last (first) float at the top (bottom) of a page; + default `20pt plus2pt minus4pt'. + +`\textfraction' + Minimum fraction of a page that must be text; if floats take up too + much space to preserve this much text, floats will be moved to a + different page. The default is `.2'. + +`\topfraction' + Maximum fraction at the top of a page that may be occupied before + floats; default is `.7'. + + +8.11 `flushleft' +================ + + \begin{flushleft} + LINE1 \\ + LINE2 \\ + ... + \end{flushleft} + + The `flushleft' environment allows you to create a paragraph +consisting of lines that are flush to the left-hand margin and ragged +right Each line must be terminated with the string `\\'. + +8.11.1 `\raggedright' +--------------------- + +The `\raggedright' declaration corresponds to the `flushleft' +environment. This declaration can be used inside an environment such +as `quote' or in a `parbox'. + + Unlike the `flushleft' environment, the `\raggedright' 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 `\end' command that ends the +paragraph unit. + +8.12 `flushright' +================= + + \begin{flushright} + LINE1 \\ + LINE2 \\ + ... + \end{flushright} + + The `flushright' environment allows you to create a paragraph +consisting of lines that are flush to the right-hand margin and ragged +left. Each line must be terminated with the string `\\'. + +8.12.1 `\raggedleft' +-------------------- + +The `\raggedleft' declaration corresponds to the `flushright' +environment. This declaration can be used inside an environment such +as `quote' or in a `parbox'. + + Unlike the `flushright' environment, the `\raggedleft' 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 `\end' command that ends the +paragraph unit. + +8.13 `itemize' +============== + +Synopsis: + + \begin{itemize} + \item ITEM1 + \item ITEM2 + ... + \end{itemize} + + The `itemize' 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 `enumerate' (*note enumerate::). + + Each item of an `itemize' list begins with an `\item' command. +There must be at least one `\item' command within the environment. + + By default, the marks at each level look like this: + + 1. * + + 2. -- (bold en-dash) + + 3. * + + 4. . (centered dot, rendered here as a period) + + The `itemize' environment uses the commands `\labelitemi' through +`\labelitemiv' to produce the default label. So, you can use +`\renewcommand' to change the labels. For instance, to have the first +level use diamonds: + + \renewcommand{\labelitemi}{$\diamond$} + + The `\leftmargini' through `\leftmarginvi' parameters define the +distance between the left margin of the enclosing environment and the +left margin of the list. By convention, `\leftmargin' is set to the +appropriate `\leftmarginN' when a new level of nesting is entered. + + The defaults vary from `.5em' (highest levels of nesting) to `2.5em' +(first level), and are a bit reduced in two-column mode. This example +greatly reduces the margin space for outermost lists: + + \setlength{\leftmargini}{1.25em} % default 2.5em + + Some parameters that affect list formatting: + +`\itemindent' + Extra indentation before each item in a list; default zero. + +`\labelsep' + Space between the label and text of an item; default `.5em'. + +`\labelwidth' + Width of the label; default `2em', or `1.5em' in two-column mode. + +`\listparindent' + Extra indentation added to second and subsequent paragraphs within + a list item; default `0pt'. + +`\rightmargin' + Horizontal distance between the right margin of the list and the + enclosing environment; default `0pt', except in the `quote', + `quotation', and `verse' environments, where it is set equal to + `\leftmargin'. + + + Parameters affecting vertical spacing between list items (rather +loose, by default). + +`\itemsep' + Vertical space between items. The default is `2pt plus1pt + minus1pt' for `10pt' documents, `3pt plus2pt minus1pt' for `11pt', + and `4.5pt plus2pt minus1pt' for `12pt'. + +`\parsep' + Extra vertical space between paragraphs within a list item. + Defaults are the same as `\itemsep'. + +`\topsep' + Vertical space between the first item and the preceding paragraph. + The default is `4pt plus2pt minus2pt' for `10pt' documents, `6pt + plus2pt minus2pt' for `11pt', and `9pt plus3pt minus5pt' for + `12pt'. + +`\partopsep' + Extra space added to `\topsep' when the list environment starts a + paragraph. The default is `2pt plus1pt minus1pt' for `10pt' + documents, `3pt plus1pt minus1pt' for `11pt', and `3pt plus2pt + minus2pt' for `12pt'. + +`\topsep' + 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 `10pt', it is `4pt + plus2pt minus2pt'. + + + Especially for lists with short items, it may be desirable to elide +space between items. Here is an example defining an `itemize*' +environment with no extra spacing between items, or between paragraphs +within a single item (`\parskip' is not list-specific, *note +\parskip::): + + \newenvironment{itemize*}% + {\begin{itemize}% + \setlength{\itemsep}{0pt}% + \setlength{\parsep}{0pt}}% + \setlength{\parskip}{0pt}}% + {\end{itemize}} + +8.14 `letter' environment: writing letters +========================================== + +This environment is used for creating letters. *Note Letters::. + +8.15 `list' +=========== + +The `list' 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. + + \begin{list}{LABELING}{SPACING} + \item ITEM1 + \item ITEM2 + ... + \end{list} + + The mandatory LABELING argument specifies how items should be +labelled (unless the optional argument is supplied to `\item'). 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. + + The mandatory SPACING argument contains commands to change the +spacing parameters for the list. This argument will most often be +empty, i.e., `{}', which leaves the default spacing. + +8.16 `math' +=========== + +Synopsis: + + \begin{math} + MATH + \end{math} + + The `math' environment inserts the given MATH within the running +text. `\(...\))' and `$...$' are synonyms. *Note Math formulas::. + +8.17 `minipage' +=============== + + \begin{minipage}[POSITION]{WIDTH} + TEXT + \end{minipage} + + The `minipage' environment typesets its body TEXT in a block that +will not be broken across pages (similar to the `\parbox' command, +*note \parbox::). You may use other paragraph-making environments +inside a minipage (unlike `\parbox'). + + It takes an optional POSITION argument for placing TEXT, and a +mandatory WIDTH argument for specifying the line width. + + By default, paragraphs are not indented in the `minipage' +environment. You can restore indentation with a command such as +`\setlength{\parindent}{1pc}' command. + + Footnotes in a `minipage' environment are handled in a way that is +particularly useful for putting footnotes in figures or tables. A +`\footnote' or `\footnotetext' command puts the footnote at the bottom +of the minipage instead of at the bottom of the page, and it uses the +`\mpfootnote' counter instead of the ordinary `footnote' counter (*note +Counters::). + + However, don't put one minipage inside another if you are using +footnotes; they may wind up at the bottom of the wrong minipage. + +8.18 `picture' +============== + + \begin{picture}(width,height)(x offset,y offset) + ... PICTURE COMMANDS ... + \end{picture} + + The `picture' 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 `5', `0.3' or `-3.1416'. A coordinate +specifies a length in multiples of the unit length `\unitlength', so if +`\unitlength' has been set to `1cm', then the coordinate 2.54 specifies +a length of 2.54 centimeters. You should only change the value of +`\unitlength', using the `\setlength' command, outside of a `picture' +environment. + + A position is a pair of coordinates, such as `(2.4,-5)', specifying +the point with x-coordinate `2.4' and y-coordinate `-5'. Coordinates +are specified in the usual way with respect to an origin, which is +normally at the lower-left corner of the picture. Note that when a +position appears as an argument, it is not enclosed in braces; the +parentheses serve to delimit the argument. + + The `picture' environment has one mandatory argument, which is a +`position'. It specifies the size of the picture. The environment +produces a rectangular box with width and height determined by this +argument's x- and y-coordinates. + + The `picture' environment also has an optional `position' argument, +following the `size' argument, that can change the origin. (Unlike +ordinary optional arguments, this argument is not contained in square +brackets.) The optional argument gives the coordinates of the point at +the lower-left corner of the picture (thereby determining the origin). +For example, if `\unitlength' has been set to `1mm', the command + \begin{picture}(100,200)(10,20) + 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. + + 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. + + Everything that appears in a picture is drawn by the `\put' command. +The command + + \put (11.3,-.3){...} + +puts the object specified by `...' in the picture, with its reference +point at coordinates (11.3,-.3). The reference points for various +objects will be described below. + + The `\put' command creates an "LR box". You can put anything that +can go in an `\mbox' (*note \mbox::) in the text argument of the `\put' +command. When you do this, the reference point will be the lower left +corner of the box. + + The `picture' commands are described in the following sections. + +8.18.1 `\circle' +---------------- + + \circle[*]{DIAMETER} + + The `\circle' command produces a circle with a diameter as close to +the specified one as possible. The `*'-form of the command draws a +solid circle. + + Circles up to 40 pt can be drawn. + +8.18.2 `\makebox' +----------------- + +`\makebox(width,height)[position]{...}' + + The `\makebox' command for the picture environment is similar to the +normal `\makebox' command except that you must specify a `width' and +`height' in multiples of `\unitlength'. + + The optional argument, `[position]', specifies the quadrant that +your text appears in. You may select up to two of the following: + + * `t' - Moves the item to the top of the rectangle + + * `b' - Moves the item to the bottom + + * `l' - Moves the item to the left + + * `r' - Moves the item to the right + + *Note \makebox::. + +8.18.3 `\framebox' +------------------ + +Synopsis: + + \framebox(WIDTH,HEIGHT)[POS]{...} + + The `\framebox' command is like `\makebox' (see previous section), +except that it puts a frame around the outside of the box that it +creates. + + The `\framebox' command produces a rule of thickness `\fboxrule', +and leaves a space `\fboxsep' between the rule and the contents of the +box. + +8.18.4 `\dashbox' +----------------- + +Draws a box with a dashed line. Synopsis: + + \dashbox{DLEN}(RWIDTH,RHEIGHT)[POS]{TEXT} + + `\dashbox' creates a dashed rectangle around TEXT in a `picture' +environment. Dashes are DLEN units long, and the rectangle has overall +width RWIDTH and height RHEIGHT. The TEXT is positioned at optional +POS. A dashed box looks best when the `rwidth' and `rheight' are +multiples of the `dlen'. + +8.18.5 `\frame' +--------------- + +Synopsis: + + \frame{TEXT} + + The `\frame' command puts a rectangular frame around TEXT. The +reference point is the bottom left corner of the frame. No extra space +is put between the frame and the object. + +8.18.6 `\line' +-------------- + +Synopsis: + + \line(XSLOPE,YSLOPE){LENGTH} + + The `\line' command draws a line with the given LENGTH and slope +XSLOPE/YSLOPE. + + Standard LaTeX can only draw lines with SLOPE = x/y, where x and y +have integer values from -6 through 6. For lines of any slope, not to +mention other shapes, see the `curve2e' and many many other packages on +CTAN. + +8.18.7 `\linethickness' +----------------------- + +The `\linethickness{DIM}' command declares the thickness of horizontal +and vertical lines in a picture environment to be DIM, which must be a +positive length. + + `\linethickness' does not affect the thickness of slanted lines, +circles, or the quarter circles drawn by `\oval'. + +8.18.8 `\thicklines' +-------------------- + +The `\thicklines' command is an alternate line thickness for horizontal +and vertical lines in a picture environment; cf. *note \linethickness:: +and *note \thinlines::. + +8.18.9 `\thinlines' +------------------- + +The `\thinlines' command is the default line thickness for horizontal +and vertical lines in a picture environment; cf. *note \linethickness:: +and *note \thicklines::. + +8.18.10 `\multiput' +------------------- + +Synopsis: + \multiput(X,Y)(DELTA_X,DELTA_Y){N}{OBJ} + + The `\multiput' command copies the object OBJ in a regular pattern +across a picture. OBJ is first placed at position (x,y), then at +(x+\delta x,y+\delta y), and so on, N times. + +8.18.11 `\oval' +--------------- + +Synopsis: + + \oval(WIDTH,HEIGHT)[PORTION] + + The `\oval' command produces a rectangle with rounded corners. The +optional argument PORTION allows you to select part of the oval via the +following: + +`t' + selects the top portion; + +`b' + selects the bottom portion; + +`r' + selects the right portion; + +`l' + selects the left portion. + + The "corners" of the oval are made with quarter circles with a +maximum radius of 20pt, so large "ovals" will look more like boxes with +rounded corners. + +8.18.12 `\put' +-------------- + +`\put(x coord,y coord){ ... }' + + The `\put' command places the item specified by the mandatory +argument at the given coordinates. + +8.18.13 `\shortstack' +--------------------- + +Synopsis: + + \shortstack[POSITION]{...\\...\\...} + + The `\shortstack' command produces a stack of objects. The valid +positions are: + +`r' + Move the objects to the right of the stack. + +`l' + Move the objects to the left of the stack + +`c' + Move the objects to the centre of the stack (default) + + Objects are separated with `\\'. + +8.18.14 `\vector' +----------------- + +Synopsis: + + \vector(X-SLOPE,Y-SLOPE){LENGTH} + + The `\vector' command draws a line with an arrow of the specified +length and slope. The x and y values must lie between -4 and +4, +inclusive. + +8.19 `quotation' +================ + +Synopsis: + + \begin{quotation} + TEXT + \end{quotation} + + The margins of the `quotation' environment are indented on both the +left and the right. The text is justified at both margins. Leaving a +blank line between text produces a new paragraph. + + Unlike the `quote' environment, each paragraph is indented normally. + +8.20 `quote' +============ + +Snyopsis: + + \begin{quote} + TEXT + \end{quote} + + The margins of the `quote' environment are indented on both the left +and the right. The text is justified at both margins. Leaving a blank +line between text produces a new paragraph. + + Unlike the `quotation' environment, paragraphs are not indented. + +8.21 `tabbing' +============== + +Synopsis: + + \begin{tabbing} + ROW1COL1 \= ROW1COL2 \= ROW1COL3 \= ROW1COL4 \\ + ROW2COL1 \> \> ROW2COL3 \\ + ... + \end{tabbing} + + The `tabbing' 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. + + This environment can be broken across pages, unlike the `tabular' +environment. + + The following commands can be used inside a `tabbing' enviroment: + +`\\ tabbing' + End a line. + +`\= (tabbing)' + Sets a tab stop at the current position. + +`\> (tabbing)' + Advances to the next tab stop. + +`\<' + Put following text to the left of the local margin (without + changing the margin). Can only be used at the start of the line. + +`\+' + Moves the left margin of the next and all the following commands + one tab stop to the right, beginning tabbed line if necessary. + +`\-' + Moves the left margin of the next and all the following commands + one tab stop to the left, beginning tabbed line if necessary. + +`\' (tabbing)' + Moves everything that you have typed so far in the current column, + i.e. everything from the most recent `\>', `\<', `\'', `\\', or + `\kill' command, to the right of the previous column, flush + against the current column's tab stop. + +`\` (tabbing)' + 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 `\`' command moves + all the text that follows it, up to the `\\' or `\end{tabbing}' + command that ends the line, to the right margin of the tabbing + environment. There must be no `\>' or `\'' command between the + `\`' and the command that ends the line. + +`\a (tabbing)' + In a `tabbing' environment, the commands `\=', `\'' and `\`' do + not produce accents as usual (*note Accents::). Instead, the + commands `\a=', `\a'' and `\a`' are used. + +`\kill' + Sets tab stops without producing text. Works just like `\\' + except that it throws away the current line instead of producing + output for it. The effect of any `\=', `\+' or `\-' commands in + that line remain in effect. + +`\poptabs' + Restores the tab stop positions saved by the last `\pushtabs'. + +`\pushtabs' + Saves all current tab stop positions. Useful for temporarily + changing tab stop positions in the middle of a `tabbing' + environment. + +`\tabbingsep' + Distance to left of tab stop moved by `\''. + + + This example typesets a Pascal function in a traditional format: + + \begin{tabbing} + function \= fact(n : integer) : integer;\\ + \> begin \= \+ \\ + \> if \= n $>$ 1 then \+ \\ + fact := n * fact(n-1) \- \\ + else \+ \\ + fact := 1; \-\- \\ + end;\\ + \end{tabbing} + +8.22 `table' +============ + +Synopsis: + + \begin{table}[placement] + + body of the table + + \caption{table title} + \end{table} + + Tables are objects that are not part of the normal text, and are +usually "floated" to a convenient place, like the top of a page. +Tables will not be split between two pages. + + The optional argument `[placement]' determines where LaTeX will try +to place your table. There are four places where LaTeX can possibly put +a float: + + * `h': Here - at the position in the text where the table + environment appears. + + * `t': Top - at the top of a text page. + + * `b': Bottom - at the bottom of a text page. + + * `p': Page of floats - on a separate float page, which is a page + containing no text, only floats. + + The standard `report' and `article' classes use the default +placement `[tbp]'. + + The body of the table is made up of whatever text, LaTeX commands, +etc., you wish. The `\caption' command allows you to title your table. + +8.23 `tabular' +============== + +Synopsis: + + \begin{tabular}[pos]{cols} + column 1 entry & column 2 entry ... & column n entry \\ + ... + \end{tabular} + + or + + \begin{tabular*}{width}[pos]{cols} + column 1 entry & column 2 entry ... & column n entry \\ + ... + \end{tabular*} + + These environments produce a box consisting of a sequence of rows of +items, aligned vertically in columns. + + `\\' must be used to specify the end of each row of the table, +except for the last, where it is optional--unless an `\hline' command +(to put a rule below the table) follows. + + The mandatory and optional arguments consist of: + +`width' + Specifies the width of the `tabular*' environment. There must be + rubber space between columns that can stretch to fill out the + specified width. + +`pos' + Specifies the vertical position; default is alignment on the + centre of the environment. + + * `t' - align on top row + + * `b' - align on bottom row + +`cols' + Specifies the column formatting. It consists of a sequence of the + following specifiers, corresponding to the sequence of columns and + intercolumn material. + + * `l' - A column of left-aligned items. + + * `r' - A column of right-aligned items. + + * `c' - A column of centred items. + + * `|' - A vertical line the full height and depth of the + environment. + + * `@{text}' - This inserts `text' in every row. An @-expression + suppresses the intercolumn space normally inserted between + columns; any desired space between the inserted text and the + adjacent items must be included in text. An + `\extracolsep{wd}' command in an @-expression causes an extra + space of width `wd' to appear to the left of all subsequent + columns, until countermanded by another `\extracolsep' + command. Unlike ordinary intercolumn space, this extra space + is not suppressed by an @-expression. An `\extracolsep' + command can be used only in an @-expression in the `cols' + argument. + + * `p{wd}' - Produces a column with each item typeset in a + parbox of width `wd', as if it were the argument of a + `\parbox[t]{wd}' command. However, a `\\' may not appear in + the item, except in the following situations: + 1. inside an environment like `minipage', `array', or + `tabular'. + + 2. inside an explicit `\parbox'. + + 3. in the scope of a `\centering', `\raggedright', or + `\raggedleft' declaration. The latter declarations must + appear inside braces or an environment when used in a + `p'-column element. + + * `*{num}{cols}' - Equivalent to `num' copies of `cols', where + `num' is any positive integer and `cols' is any list of + column-specifiers, which may contain another `*-expression'. + + + + Parameters that control formatting: + +`\arrayrulewidth' + Thickness of the rule created by `|', `\hline', and `\vline' in + the `tabular' and `array' environments; the default is `.4pt'. + +`\arraystretch' + Scaling of spacing between rows in the `tabular' and `array' + environments; default is `1',for no scaling. + +`\doublerulesep' + Horizontal distance between the vertical rules produced by `||' in + the `tabular' and `array' environments; default is `2pt'. + +`\tabcolsep' + Half the width of the space between columns; default is `6pt'. + + + These commands can be used inside a `tabular' environment: + +8.23.1 `\multicolumn' +--------------------- + +Synopsis: + \multicolumn{COLS}{POS}{TEXT} + + The `\multicolumn' command makes an entry that spans several +columns. The first mandatory argument, COLS, specifies the number of +columns to span. The second mandatory argument, POS, specifies the +formatting of the entry; `c' for centered, `l' for flushleft, `r' for +flushright. The third mandatory argument, TEXT, specifies what text to +put in the entry. + + Here's an example showing two columns separated by an en-dash; +`\multicolumn' is used for the heading: + + \begin{tabular}{r@{--}l} + \multicolumn{2}{c}{\bf Unicode}\cr + 0x80&0x7FF \cr + 0x800&0xFFFF \cr + 0x10000&0x1FFFF \cr + \end{tabular} + +8.23.2 `\cline' +--------------- + +Synopsis: + + \cline{I-J} + + The `\cline' command draws horizontal lines across the columns +specified, beginning in column I and ending in column J, which are +specified in the mandatory argument. + +8.23.3 `\hline' +--------------- + +The `\hline' command draws a horizontal line the width of the enclosing +`tabular' or `array' environment. It's most commonly used to draw a +line at the top, bottom, and between the rows of a table. + +8.23.4 `\vline' +--------------- + +The `\vline' command will draw a vertical line extending the full +height and depth of its row. An `\hfill' command can be used to move +the line to the edge of the column. It can also be used in an +@-expression. + +8.24 `thebibliography' +====================== + +Synopsis: + + \begin{thebibliography}{WIDEST-LABEL} + \bibitem[LABEL]{CITE_KEY} + ... + \end{thebibliography} + + The `thebibliography' environment produces a bibliography or +reference list. + + In the `article' class, this reference list is labelled +"References"; in the `report' class, it is labelled "Bibliography". +You can change the label (in the standard classes) by redefining the +command `\refname'. For instance, this eliminates it entirely: + + \renewcommand{\refname}{} + + The mandatory WIDEST-LABEL argument is text that, when typeset, is +as wide as the widest item label produced by the `\bibitem' commands. +It is typically given as `9' for bibliographies with less than 10 +references, `99' for ones with less than 100, etc. + +8.24.1 `\bibitem' +----------------- + +Synopsis: + \bibitem[LABEL]{CITE_KEY} + + The `\bibitem' command generates an entry labelled by LABEL. If the +LABEL argument is missing, a number is automatically generated using +the `enumi' counter. The CITE_KEY is any sequence of letters, numbers, +and punctuation symbols not containing a comma. + + This command writes an entry to the `.aux' file containing the +item's CITE_KEY and label. When the `.aux' file is read by the +`\begin{document}' command, the item's `label' is associated with +`cite_key', causing references to CITE_KEY with a `\cite' command (see +next section) to produce the associated label. + +8.24.2 `\cite' +-------------- + +Synopsis: + + \cite[SUBCITE]{KEYS + + The KEYS argument is a list of one or more citation keys, separated +by commas. This command generates an in-text citation to the +references associated with KEYS by entries in the `.aux' file. + + The text of the optional SUBCITE argument appears after the +citation. For example, `\cite[p.~314]{knuth}' might produce `[Knuth, +p. 314]'. + +8.24.3 `\nocite' +---------------- + +`\nocite{key_list}' + + The `\nocite' command produces no text, but writes `key_list', which +is a list of one or more citation keys, on the `.aux' file. + +8.24.4 Using BibTeX +------------------- + +If you use the BibTeX 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 `thebibliography' environment +(*note thebibliography::). Instead, you include the lines + + \bibliographystyle{BIBSTYLE} + \bibliography{BIBFILE1,BIBFILE2} + + The `\bibliographystyle' command does not produce any output of its +own. Rather, it defines the style in which the bibliography will be +produced: BIBSTYLE refers to a file BIBSTYLE`.bst', which defines how +your citations will look. The standard STYLE names distributed with +BibTeX are: + +`alpha' + Sorted alphabetically. Labels are formed from name of author and + year of publication. + +`plain' + Sorted alphabetically. Labels are numeric. + +`unsrt' + Like `plain', but entries are in order of citation. + +`abbrv' + Like `plain', but more compact labels. + + In addition, numerous other BibTeX style files exist tailored to the +demands of various publications. See +`http://www.ctan.org/tex-archive/biblio/bibtex/contrib'. + + The `\bibliography' command is what actually produces the +bibliography. The argument to `\bibliography' refers to files named +`BIBFILE.bib', which should contain your database in BibTeX format. +Only the entries referred to via `\cite' and `\nocite' will be listed +in the bibliography. + +8.25 `theorem' +============== + +Synopsis: + + \begin{theorem} + THEOREM-TEXT + \end{theorem} + + The `theorem' environment produces "Theorem N" in boldface followed +by THEOREM-TEXT, where the numbering possibilities for N are described +under `\newtheorem' (*note \newtheorem::). + +8.26 `titlepage' +================ + +Synopsis: + + \begin{titlepage} + TEXT + \end{titlepage} + + The `titlepage' 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 `\today' command may be useful on title pages (*note \today::). + + You can use the `\maketitle' command (*note \maketitle::) to produce +a standard title page without a `titlepage' environment. + +8.27 `verbatim' +=============== + +Synopsis: + + \begin{verbatim} + LITERAL-TEXT + \end{verbatim} + + The `verbatim' environment is a paragraph-making environment in +which LaTeX produces exactly what you type in; for instance the `\' +character produces a printed `\'. It turns LaTeX into a typewriter +with carriage returns and blanks having the same effect that they would +on a typewriter. + + The `verbatim' uses a monospaced typewriter-like font (`\tt'). + +8.27.1 `\verb' +-------------- + +Synopsis: + + \verbCHARLITERAL-TEXTCHAR + \verb*CHARLITERAL-TEXTCHAR + + The `\verb' command typesets LITERAL-TEXT as it is input, including +special characters and spaces, using the typewriter (`\tt') font. No +spaces are allowed between `\verb' or `\verb*' and the delimiter CHAR, +which begins and ends the verbatim text. The delimiter must not appear +in LITERAL-TEXT. + + The `*'-form differs only in that spaces are printed with a "visible +space" character. + +8.28 `verse' +============ + +Synopsis: + + \begin{verse} + LINE1 \\ + LINE2 \\ + ... + \end{verse} + + The `verse' environment is designed for poetry, though you may find +other uses for it. + + 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 `\\', and use one or more blank lines to separate the +stanzas. + +9 Footnotes +*********** + +Footnotes can be produced in one of two ways. They can be produced +with one command, the `\footnote' command. They can also be produced +with two commands, the `\footnotemark' and the `\footnotetext' commands. + +9.1 `\footnote' +=============== + +Synopsis: + + \footnote[NUMBER]{TEXT} + + The `\footnote' command places the numbered footnote TEXT at the +bottom of the current page. The optional argument NUMBER changes the +default footnote number. + + This command can only be used in outer paragraph mode; i.e., you +cannot use it in sectioning commands like `\chapter', in figures, +tables or in a `tabular' environment. (See following sections.) + +9.2 `\footnotemark' +=================== + +With no optional argument, the `\footnotemark' command puts the current +footnote number in the text. This command can be used in inner +paragraph mode. You give the text of the footnote separately, with the +`\footnotetext' command. + + This command can be used to produce several consecutive footnote +markers referring to the same footnote with + + \footnotemark[\value{footnote}] + + after the first `\footnote' command. + +9.3 `\footnotetext' +=================== + +Synopsis: + + \footnotetext[NUMBER]{TEXT} + + The `\footnotetext' command places TEXT at the bottom of the page as +a footnote. This command can come anywhere after the `\footnotemark' +command. The `\footnotetext' command must appear in outer paragraph +mode. + + The optional argument NUMBER changes the default footnote number. + +9.4 Footnote parameters +======================= + +`\footnoterule' + Produces the rule separating the main text on a page from the + page's footnotes. Default dimensions: `0.4pt' thick (or wide), and + `0.4\columnwidth' long in the standard document classes (except + slides, where it does not appear). + +`\footnotesep' + The height of the strut placed at the beginning of the footnote. + By default, this is set to the normal strut for `\footnotesize' + fonts (*note Font sizes::), therefore there is no extra space + between footnotes. This is `6.65pt' for `10pt', `7.7pt' for + `11pt', and `8.4pt' for `12pt'. + + +10 Definitions +************** + +LaTeX has support for making new commands of many different kinds. + +10.1 `\newcommand' & `\renewcommand' +==================================== + +`\newcommand' and `\renewcommand' define and redefine a command, +respectively. Synopses: + + \newcommand{CMD}[NARGS]{DEFN} + \renewcommand{CMD}[NARGS]{DEFN} + \newcommand{CMD}[NARGS][DEFAULT]{DEFN} + \renewcommand{CMD}[NARGS][DEFAULT]{DEFN} + +CMD + The command name beginning with `\'. For `\newcommand', it must + not be already defined and must not begin with `\end'; for + `\renewcommand', it must already be defined. + +NARGS + An optional integer from 1 to 9 specifying the number of arguments + that the command will take. The default is for the command to + have no arguments. + +DEFAULT + 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 `def'. + +DEFN + The text to be substituted for every occurrence of `cmd'; a + construct of the form `#N' in DEFN is replaced by the text of the + Nth argument. + + +10.2 `\newcounter' +================== + +Synopsis: + + \newcounter{CNT}[COUNTERNAME] + + The `\newcounter' command defines a new counter named CNT. The new +counter is initialized to zero. + + Given the optional argument `[COUNTERNAME]', CNT will be reset +whenever COUNTERNAME is incremented. + + *Note Counters::, for more information about counters. + +10.3 `\newlength' +================= + +Synopsis: + + \newlength{\ARG} + + The `\newlength' command defines the mandatory argument as a +`length' command with a value of `0in'. The argument must be a control +sequence, as in `\newlength{\foo}'. An error occurs if `\foo' is +already defined. + + *Note Lengths::, for how to set the new length to a nonzero value, +and for more information about lengths in general. + +10.4 `\newsavebox' +================== + +Synopsis: + + \newsavebox{CMD} + + Defines `\CMD', which must be a command name not already defined, to +refer to a new bin for storing boxes. + +10.5 `\newenvironment' & `\renewenvironment' +============================================ + +Synopses: + + \newenvironment{ENV}[NARGS]{BEGDEF}{ENDDEF} + \newenvironment{ENV}[NARGS][DEFAULT]{BEGDEF}{ENDDEF} + \renewenvironment{ENV}[NARGS]{BEGDEF}{ENDDEF} + + These commands define or redefine an environment ENV, that is, +`\begin{ENV} ... \end{ENV}'. + +ENV + The name of the environment. For `\newenvironment', ENV must not + be an existing environment, and the command `\ENV' must be + undefined. For `\renewenvironment', ENV must be the name of an + existing environment. + +NARGS + An integer from 1 to 9 denoting the number of arguments of the + newly-defined environment. The default is no arguments. + +DEFAULT + If this is specified, the first argument is optional, and DEFAULT + gives the default value for that argument. + +BEGDEF + The text expanded at every occurrence of `\begin{ENV}'; a + construct of the form `#N' in BEGDEF is replaced by the text of + the Nth argument. + +ENDDEF + The text expanded at every occurrence of `\end{ENV}'. It may not + contain any argument parameters. + + +10.6 `\newtheorem' +================== + + \newtheorem{NEWENV}{LABEL}[WITHIN] + \newtheorem{NEWENV}[NUMBERED_LIKE]{LABEL} + + This command defines a theorem-like environment. Arguments: + +NEWENV + The name of the environment to be defined; must not be the name of + an existing environment or otherwise defined. + +LABEL + The text printed at the beginning of the environment, before the + number. For example, `Theorem'. + +NUMBERED_LIKE + (Optional.) The name of an already defined theorem-like + environment; the new environment will be numbered just like + NUMBERED_LIKE. + +WITHIN + (Optional.) The name of an already defined counter, a sectional + unit. The new theorem counter will be reset at the same time as + the WITHIN counter. + + + At most one of NUMBERED_LIKE and WITHIN can be specified, not both. + +10.7 `\newfont' +=============== + +Synopsis: + + \newfont{CMD}{FONTNAME} + + Defines a control sequence `\CMD', which must not already be +defined, to make FONTNAME be the current font. The file looked for on +the system is named `FONTNAME.tfm'. + + This is a low-level command for setting up to use an individual font. +More commonly, fonts are defined in families through `.fd' files. + +10.8 `\protect' +=============== + +Footnotes, line breaks, any command that has an optional argument, and +many more are so-called "fragile" commands. When a fragile command is +used in certain contexts, called "moving arguments", it must be +preceded by `\protect'. In addition, any fragile commands within the +arguments must have their own `\protect'. + + Some examples of moving arguments are `\caption' (*note figure::), +`\thanks' (*note \maketitle::), and expressions in `tabular' and +`array' environments (*note tabular::). + + Commands which are not fragile are called "robust". They must not +be preceded by `\protect'. + + See also: + +`http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html' +`http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect' + + +11 Counters +*********** + +Everything LaTeX numbers for you has a counter associated with it. The +name of the counter is the same as the name of the environment or +command that produces the number, except with no `\'. +(`enumi'-`enumiv' are used for the nested enumerate environment.) +Below is a list of the counters used in LaTeX's standard document +classes to control numbering. + + part paragraph figure enumi + chapter subparagraph table enumii + section page footnote enumiii + subsection equation mpfootnote enumiv + subsubsection + +11.1 `\alph \Alph \arabic \roman \Roman \fnsymbol': Printing counters +===================================================================== + +All of these commands take a single counter as an argument, for +instance, `\alph{enumi}'. + +`\alph' + prints COUNTER using lowercase letters: `a', `b', ... + +`\Alph' + uses uppercase letters: `A', `B', ... + +`\arabic' + uses Arabic numbers: `1', `2', ... + +`\roman' + uses lowercase roman numerals: `i', `ii', ... + +`\roman' + uses uppercase roman numerals: `I', `II', ... + +`\fnsymbol' + prints the value of COUNTER in a specific sequence of nine symbols + (conventionally used for labeling footnotes). The value of + COUNTER must be between 1 and 9, inclusive. + + The symbols mostly aren't supported in Info, but here are the + names: + asterix(*) dagger ddagger section-sign paragraph-sign parallel + double-asterix(**) double-dagger double-ddagger + + +11.2 `\usecounter{COUNTER}' +=========================== + +Synopsis: + + \usecounter{COUNTER} + + The `\usecounter' command is used in the second argument of the +`list' environment to specify COUNTER to be used to number the list +items. + +11.3 `\value{COUNTER}' +====================== + +Synopsis: + + \value{COUNTER} + + The `\value' command produces the value of COUNTER. It can be used +anywhere LaTeX expects a number, for example: + + \setcounter{myctr}{3} + \addtocounter{myctr}{1} + \hspace{\value{myctr}\parindent} + +11.4 `\setcounter{COUNTER}{VALUE}' +================================== + +Synopsis: + + \setcounter{\COUNTER}{VALUE} + + The `\setcounter' command sets the value of \COUNTER to the VALUE +argument. + +11.5 `\addtocounter{COUNTER}{VALUE}' +==================================== + +The `\addtocounter' command increments COUNTER by the amount specified +by the VALUE argument, which may be negative. + +11.6 `\refstepcounter{COUNTER}' +=============================== + +The `\refstepcounter' command works in the same way as `\stepcounter' +*Note \stepcounter::, except it also defines the current `\ref' value +to be the result of `\thecounter'. + +11.7 `\stepcounter{COUNTER}' +============================ + +The `\stepcounter' command adds one to COUNTER and resets all +subsidiary counters. + +11.8 `\day \month \year': Predefined counters +============================================= + +LaTeX defines counters for the day of the month (`\day', 1-31), month +of the year (`\month', 1-12), and year (`\year', 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. + + The related command `\today' produces a string representing the +current day (*note \today::). + +12 Lengths +********** + +A `length' is a measure of distance. Many LaTeX commands take a length +as an argument. + +12.1 `\setlength{\LEN}{VALUE}' +============================== + +The `\setlength' sets the value of \LEN to the VALUE argument, which +can be expressed in any units that LaTeX understands, i.e., inches +(`in'), millimeters (`mm'), points (`pt'), big points (`bp', etc. + +12.2 \addtolength{\LEN}{AMOUNT} +=============================== + +The `\addtolength' command increments a "length command" \LEN by the +amount specified in the AMOUNT argument, which may be negative. + +12.3 `\settodepth' +================== + +`\settodepth{\gnat}{text}' + + The `\settodepth' command sets the value of a `length' command equal +to the depth of the `text' argument. + +12.4 `\settoheight' +=================== + +`\settoheight{\gnat}{text}' + + The `\settoheight' command sets the value of a `length' command +equal to the height of the `text' argument. + +12.5 `\settowidth{\LEN}{TEXT}' +============================== + +The `\settowidth' command sets the value of the command \LEN to the +width of the TEXT argument. + +12.6 Predefined lengths +======================= + +`\width' + + `\height' + + `\depth' + + `\totalheight' + + These length parameters can be used in the arguments of the +box-making commands (*note Boxes::). They specify the natural width +etc. of the text in the box. `\totalheight' equals `\height' + +`\depth'. To make a box with the text stretched to double the natural +size, e.g., say + + `\makebox[2\width]{Get a stretcher}' + +13 Line breaking +**************** + +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). + + LaTeX usually does the line (and page) breaking for you, but in some +environments, you do the line breaking yourself with the `\\' command, +and you can always manually force breaks. + +13.1 `\\'[*][MORESPACE] +======================= + +The `\\' command tells LaTeX to start a new line. It has an optional +argument, MORESPACE, that specifies how much extra vertical space is to +be inserted before the next line. This can be a negative amount. + + The `\\*' command is the same as the ordinary `\\' command except +that it tells LaTeX not to start a new page after the line. + +13.2 `\obeycr' & `\restorecr' +============================= + +The `\obeycr' command makes a return in the input file (`^^M', +internally) the same as `\\' (followed by `\relax'). So each new line +in the input will also be a new line in the output. + + `\restorecr' restores normal line-breaking behavior. + +13.3 `\newline' +=============== + +The `\newline' command breaks the line at the present point, with no +stretching of the text before it. It can only be used in paragraph +mode. + +13.4 `\-' (discretionary hyphen) +================================ + +The `\-' 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 `\-' command is used for the exceptional cases. + + When you insert `\-' 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. + +13.5 `\fussy' +============= + +The declaration `\fussy' (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. + + This command cancels the effect of a previous `\sloppy' command +(*note \sloppy::. + +13.6 `\sloppy' +============== + +The declaration `\sloppy' makes TeX less fussy about line breaking. +This will avoid overfull boxes, at the cost of loose interword spacing. + + Lasts until a `\fussy' command is issued (*note \fussy::). + +13.7 `\hyphenation' +=================== + +Synopsis: + + \hyphenation{WORD-ONE WORD-TWO} + + The `\hyphenation' command declares allowed hyphenation points with +a `-' 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 `\hyphenation' commands accumulate. Some examples +(the default TeX hyphenation patterns misses the hyphenations in these +words): + + \hyphenation{ap-pen-dix col-umns data-base data-bases} + +13.8 `\linebreak' & `\nolinebreak' +================================== + +Synopses: + + \linebreak[PRIORITY] + \nolinebreak[PRIORITY] + + By default, the `\linebreak' (`\nolinebreak') command forces +(prevents) a line break at the current position. For `\linebreak', the +spaces in the line are stretched out so that it extends to the right +margin as usual. + + With the optional argument PRIORITY, you can convert the command +from a demand to a request. The PRIORITY must be a number from 0 to 4. +The higher the number, the more insistent the request. + +14 Page breaking +**************** + +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. + +14.1 `\cleardoublepage' +======================= + +The `\cleardoublepage' command ends the current page and causes all +figures and tables that have so far appeared in the input to be printed. +In a two-sided printing style, it also makes the next page a right-hand +(odd-numbered) page, producing a blank page if necessary. + +14.2 `\clearpage' +================= + +The `\clearpage' command ends the current page and causes all figures +and tables that have so far appeared in the input to be printed. + +14.3 `\newpage' +=============== + +The `\newpage' command ends the current page, but does not clear floats +(see `\clearpage' above). + +14.4 `\enlargethispage' +======================= + +`\enlargethispage{size}' + + `\enlargethispage*{size}' + + Enlarge the `\textheight' for the current page by the specified +amount; e.g. `\enlargethispage{\baselineskip}' will allow one +additional line. + + The starred form tries to squeeze the material together on the page +as much as possible. This is normally used together with an explicit +`\pagebreak'. + +14.5 `\pagebreak' & `\nopagebreak' +================================== + +Synopses: + + \pagebreak[PRIORITY] + \nopagebreak[PRIORITY] + + By default, the `\pagebreak' (`\nopagebreak') command forces +(prevents) a page break at the current position. For `\linebreak', the +vertical space on the page is stretched out where possible so that it +extends to the normal bottom margin. + + With the optional argument PRIORITY, you can convert the +`\pagebreak' 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. + +15 Making paragraphs +******************** + +A paragraph is ended by one or more completely blank lines--lines not +containing even a `%'. 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. + +15.1 `\indent' +============== + +`\indent' produces a horizontal space whose width equals the width of +the `\parindent' length, the normal paragraph indentation. It is used +to add paragraph indentation where it would otherwise be suppressed. + + The default value for `\parindent' is `1em' in two-column mode, +otherwise `15pt' for `10pt' documents, `17pt' for `11pt', and `1.5em' +for `12pt'. + +15.2 `\noindent' +================ + +When used at the beginning of the paragraph, `\noindent' suppresses any +paragraph indentation. It has no effect when used in the middle of a +paragraph. + +15.3 `\parskip' +=============== + +`\parskip' is a rubber length defining extra vertical space added +before each paragraph. The default is `0pt plus1pt'. + +15.4 Marginal notes +=================== + +Synopsis: + + \marginpar[LEFT]{RIGHT} + + The `\marginpar' 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 `\marginpar' occurs. + + When you only specify the mandatory argument RIGHT, the text will be +placed + + * in the right margin for one-sided layout; + + * in the outside margin for two-sided layout; + + * in the nearest margin for two-column layout. + + The command `\reversemarginpar' places subsequent marginal notes in +the opposite (inside) margin. `\normalmarginpar' places them in the +default position. + + When you specify both arguments, LEFT is used for the left margin, +and RIGHT is used for the right margin. + + The first word will normally not be hyphenated; you can enable +hyphenation there by beginning the node with `\hspace{0pt}'. + + These parameters affect the formatting of the note: + +`\marginparpush' + Minimum vertical space between notes; default `7pt' for `12pt' + documents, `5pt' else. + +`\marginparsep' + Horizontal space between the main text and the note; default + `11pt' for `10pt' documents, `10pt' else. + +`\marginparwidth' + Width of the note itself; default for a one-sided `10pt' document + is `90pt', `83pt' for `11pt', and `68pt' for `12pt'; `17pt' more + in each case for a two-sided document. In two column mode, the + default is `48pt'. + + +16 Math formulas +**************** + +There are three environments that put LaTeX in math mode: + +`math' + For formulas that appear right in the text. + +`displaymath' + For formulas that appear on their own line. + +`equation' + The same as the displaymath environment except that it adds an + equation number in the right margin. + + The `math' environment can be used in both paragraph and LR mode, +but the `displaymath' and `equation' environments can be used only in +paragraph mode. The `math' and `displaymath' environments are used so +often that they have the following short forms: + + \(...\) instead of \begin{math}...\end{math} + \[...\] instead of \begin{displaymath}...\end{displaymath} + + In fact, the `math' environment is so common that it has an even +shorter form: + + $ ... $ instead of \(...\) + + The `\boldmath' command changes math letters and symbols to be in a +bold font. It is used _outside_ of math mode. Conversely, the +`\unboldmath' command changes math glyphs to be in a normal font; it +too is used _outside_ of math mode. + + The `\displaystyle' declaration forces the size and style of the +formula to be that of `displaymath', e.g., with limits above and below +summations. For example + $\displaystyle \sum_{n=0}^\infty x_n $ + +16.1 Subscripts & Superscripts +============================== + +To get an expression exp to appear as a subscript, you just type +`_{'exp`}'. To get exp to appear as a superscript, you type +`^{'exp`}'. LaTeX handles superscripted superscripts and all of that +stuff in the natural way. It even does the right thing when something +has both a subscript and a superscript. + +16.2 Math symbols +================= + +LaTeX provides almost any mathematical symbol you're likely to need. +The commands for generating them can be used only in math mode. For +example, if you include `$\pi$' in your source, you will get the pi +symbol (\pi) in your output. + +`\|' + \| + +`\aleph' + \aleph + +`\alpha' + \alpha + +`\amalg' + \amalg (binary operation) + +`\angle' + \angle + +`\approx' + \approx (relation) + +`\ast' + \ast (binary operation) + +`\asymp' + \asymp (relation) + +`\backslash' + \ (delimiter) + +`\beta' + \beta + +`\bigcap' + \bigcap + +`\bigcirc' + \bigcirc (binary operation) + +`\bigcup' + \bigcup + +`\bigodot' + \bigodot + +`\bigoplus' + \bigoplus + +`\bigotimes' + \bigotimes + +`\bigtriangledown' + \bigtriangledown (binary operation) + +`\bigtriangleup' + \bigtriangleup (binary operation) + +`\bigsqcup' + \bigsqcup + +`\biguplus' + \biguplus + +`\bigcap' + \bigvee + +`\bigwedge' + \bigwedge + +`\bot' + \bot + +`\bowtie' + \bowtie (relation) + +`\Box' + (square open box symbol) + +`\bullet' + \bullet (binary operation) + +`\cap' + \cap (binary operation) + +`\cdot' + \cdot (binary operation) + +`\chi' + \chi + +`\circ' + \circ (binary operation) + +`\clubsuit' + \clubsuit + +`\cong' + \cong (relation) + +`\coprod' + \coprod + +`\cup' + \cup (binary operation) + +`\dagger' + \dagger (binary operation) + +`\dashv' + \dashv (relation) + +`\ddagger' + \dagger (binary operation) + +`\Delta' + \Delta + +`\delta' + \delta + +`\Diamond' + bigger \diamond + +`\diamond' + \diamond (binary operation) + +`\diamondsuit' + \diamondsuit + +`\div' + \div (binary operation) + +`\doteq' + \doteq (relation) + +`\downarrow' + \downarrow (delimiter) + +`\Downarrow' + \Downarrow (delimiter) + +`\ell' + \ell + +`\emptyset' + \emptyset + +`\epsilon' + \epsilon + +`\equiv' + \equiv (relation) + +`\eta' + \eta + +`\exists' + \exists + +`\flat' + \flat + +`\forall' + \forall + +`\frown' + \frown (relation) + +`\Gamma' + \Gamma + +`\gamma' + \gamma + +`\ge' + \ge + +`\geq' + \geq (relation) + +`\gets' + \gets + +`\gg' + \gg (relation) + +`\hbar' + \hbar + +`\heartsuit' + \heartsuit + +`\hookleftarrow' + \hookleftarrow + +`\hookrightarrow' + \hookrightarrow + +`\iff' + \iff + +`\Im' + \Im + +`\in' + \in (relation) + +`\infty' + \infty + +`\int' + \int + +`\iota' + \iota + +`\Join' + condensed bowtie symbol (relation) + +`\kappa' + \kappa + +`\Lambda' + \Lambda + +`\lambda' + \lambda + +`\land' + \land + +`\langle' + \langle (delimiter) + +`\lbrace' + \lbrace (delimiter) + +`\lbrack' + \lbrack (delimiter) + +`\lceil' + \lceil (delimiter) + +`\le' + \le + +`\leadsto' + +`\Leftarrow' + \Leftarrow + +`\leftarrow' + \leftarrow + +`\leftharpoondown' + \leftharpoondown + +`\leftharpoonup' + \leftharpoonup + +`\Leftrightarrow' + \Leftrightarrow + +`\leftrightarrow' + \leftrightarrow + +`\leq' + \leq (relation) + +`\lfloor' + \lfloor (delimiter) + +`\lhd' + (left-pointing arrow head) + +`\ll' + \ll (relation) + +`\lnot' + \lnot + +`\longleftarrow' + \longleftarrow + +`\longleftrightarrow' + \longleftrightarrow + +`\longmapsto' + \longmapsto + +`\longrightarrow' + \longrightarrow + +`\lor' + \lor + +`\mapsto' + \mapsto + +`\mho' + +`\mid' + \mid (relation) + +`\models' + \models (relation) + +`\mp' + \mp (binary operation) + +`\mu' + \mu + +`\nabla' + \nabla + +`\natural' + \natural + +`\ne' + \ne + +`\nearrow' + \nearrow + +`\neg' + \neg + +`\neq' + \neq (relation) + +`\ni' + \ni (relation) + +`\not' + Overstrike a following operator with a /, as in \not=. + +`\notin' + \ni + +`\nu' + \nu + +`\nwarrow' + \nwarrow + +`\odot' + \odot (binary operation) + +`\oint' + \oint + +`\Omega' + \Omega + +`\omega' + \omega + +`\ominus' + \ominus (binary operation) + +`\oplus' + \oplus (binary operation) + +`\oslash' + \oslash (binary operation) + +`\otimes' + \otimes (binary operation) + +`\owns' + \owns + +`\parallel' + \parallel (relation) + +`\partial' + \partial + +`\perp' + \perp (relation) + +`\phi' + \phi + +`\Pi' + \Pi + +`\pi' + \pi + +`\pm' + \pm (binary operation) + +`\prec' + \prec (relation) + +`\preceq' + \preceq (relation) + +`\prime' + \prime + +`\prod' + \prod + +`\propto' + \propto (relation) + +`\Psi' + \Psi + +`\psi' + \psi + +`\rangle' + \rangle (delimiter) + +`\rbrace' + \rbrace (delimiter) + +`\rbrack' + \rbrack (delimiter) + +`\rceil' + \rceil (delimiter) + +`\Re' + \Re + +`\rfloor' + \rfloor + +`\rhd' + (binary operation) + +`\rho' + \rho + +`\Rightarrow' + \Rightarrow + +`\rightarrow' + \rightarrow + +`\rightharpoondown' + \rightharpoondown + +`\rightharpoonup' + \rightharpoonup + +`\rightleftharpoons' + \rightleftharpoons + +`\searrow' + \searrow + +`\setminus' + \setminus (binary operation) + +`\sharp' + \sharp + +`\Sigma' + \Sigma + +`\sigma' + \sigma + +`\sim' + \sim (relation) + +`\simeq' + \simeq (relation) + +`\smallint' + \smallint + +`\smile' + \smile (relation) + +`\spadesuit' + \spadesuit + +`\sqcap' + \sqcap (binary operation) + +`\sqcup' + \sqcup (binary operation) + +`\sqsubset' + (relation) + +`\sqsubseteq' + \sqsubseteq (relation) + +`\sqsupset' + (relation) + +`\sqsupseteq' + \sqsupseteq (relation) + +`\star' + \star (binary operation) + +`\subset' + \subset (relation) + +`\subseteq' + \subseteq (relation) + +`\succ' + \succ (relation) + +`\succeq' + \succeq (relation) + +`\sum' + \sum + +`\supset' + \supset (relation) + +`\supseteq' + \supseteq (relation) + +`\surd' + \surd + +`\swarrow' + \swarrow + +`\tau' + \tau + +`\theta' + \theta + +`\times' + \times (binary operation) + +`\to' + \to + +`\top' + \top + +`\triangle' + \triangle + +`\triangleleft' + \triangleleft (binary operation) + +`\triangleright' + \triangleright (binary operation) + +`\unlhd' + left-pointing arrowhead with line under (binary operation) + +`\unrhd' + right-pointing arrowhead with line under (binary operation) + +`\Uparrow' + \Uparrow (delimiter) + +`\uparrow' + \uparrow (delimiter) + +`\Updownarrow' + \Updownarrow (delimiter) + +`\updownarrow' + \updownarrow (delimiter) + +`\uplus' + \uplus (binary operation) + +`\Upsilon' + \Upsilon + +`\upsilon' + \upsilon + +`\varepsilon' + \varepsilon + +`\varphi' + \varphi + +`\varpi' + \varpi + +`\varrho' + \varrho + +`\varsigma' + \varsigma + +`\vartheta' + \vartheta + +`\vdash' + \vdash (relation) + +`\vee' + \vee (binary operation) + +`\Vert' + \Vert (delimiter) + +`\vert' + \vert (delimiter) + +`\wedge' + \wedge (binary operation) + +`\wp' + \wp + +`\wr' + \wr (binary operation) + +`\Xi' + \Xi + +`\xi' + \xi + +`\zeta' + \zeta + + +16.3 Math functions +=================== + +These commands produce roman function names in math mode with proper +spacing. + +`\arccos' + \arccos + +`\arcsin' + \arcsin + +`\arctan' + \arctan + +`\arg' + \arg + +`\bmod' + Binary modulo operator (x \bmod y) + +`\cos' + \cos + +`\cosh' + \cosh + +`\cot' + \cos + +`\coth' + \cosh + +`\csc' + \csc + +`\deg' + \deg + +`\det' + \deg + +`\dim' + \dim + +`\exp' + \exp + +`\gcd' + \gcd + +`\hom' + \hom + +`\inf' + \inf + +`\ker' + \ker + +`\lg' + \lg + +`\lim' + \lim + +`\liminf' + \liminf + +`\limsup' + \limsup + +`\ln' + \ln + +`\log' + \log + +`\max' + \max + +`\min' + \min + +`\pmod' + parenthesized modulus, as in (\pmod 2^n - 1) + +`\Pr' + \Pr + +`\sec' + \sec + +`\sin' + \sin + +`\sinh' + \sinh + +`\sup' + \sup + +`\tan' + \tan + +`\tanh' + \tanh + + +16.4 Math accents +================= + +LaTeX provides a variety of commands for producing accented letters in +math. These are different from accents in normal text (*note +Accents::). + +`\acute' + Math acute accent: \acutex. + +`\breve' + Math breve accent: \brevex. + +`\check' + Math ha'c<ek (check) accent: \checkx. + +`\ddot' + Math dieresis accent: \ddotx. + +`\dot' + Math dot accent: \dotx. + +`\grave' + Math grave accent: \gravex. + +`\hat' + Math hat (circumflex) accent: \hatx. + +`\imath' + Math dotless i. + +`\jmath' + Math dotless j. + +`\tilde' + Math tilde accent: \tildex. + +`\vec' + Math vector symbol: \vecx. + +`\widehat' + Math wide hat accent: \widehatx+y. + +`\widehat' + Math wide tilde accent: \widetildex+y. + + +16.5 Spacing in math mode +========================= + +In a `math' environment, LaTeX ignores the spaces you type and puts in +the spacing according to the normal rules for mathematics texts. If +you want different spacing, LaTeX provides the following commands for +use in math mode: + +`\;' + A thick space (5\over18\,quad). + +`\:' +`\>' + Both of these produce a medium space (2\over9\,quad). + +`\,' + A thin space (1\over6\,quad); not restricted to math mode. + +`\!' + A negative thin space (-1\over6\,quad). + +16.6 Math Miscellany +==================== + +`\*' + A "discretionary" multiplication symbol, at which a line break is + allowed. + +`\cdots' + A horizontal ellipsis with the dots raised to the center of the + line. + +`\ddots' + A diagonal ellipsis: \ddots. + +`\frac{num}{den}' + Produces the fraction `num' divided by `den'. + +`\left DELIM1 ... \right DELIM2' + The two delimiters need not match; `.' acts as a null delimiter, + producing no output. The delimiters are sized according to the + math in between. Example: `\left( \sum_i=1^10 a_i \right]'. + +`\overbrace{TEXT}' + Generates a brace over TEXT. For example, \overbracex+\cdots+x^k + \rm\;times. + +`\overline{TEXT}' + Generates a horizontal line over TEX. For exampe, \overlinex+y. + +`\sqrt[ROOT]{arg}' + Produces the representation of the square root of ARG. The + optional argument ROOT determines what root to produce. For + example, the cube root of `x+y' would be typed as + `$\sqrt[3]{x+y}$'. + +`\stackrel{TEXT}{RELATION}' + Puts TEXT above RELATION. For example, + `\stackrel{f}{\longrightarrow}'. + +`\underbrace{math}' + Generates MATH with a brace underneath. + +`\underline{text}' + Causes TEXT, which may be either math mode or not, to be + underlined. + +`\vdots' + Produces a vertical ellipsis. + + +17 Modes +******** + +When LaTeX is processing your input text, it is always in one of three +modes: + + * Paragraph mode + + * Math mode + + * Left-to-right mode, called LR mode for short + + 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. + + "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 `\mbox', 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. + + LaTeX is in LR mode when it starts making a box with an `\mbox' +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 `parbox'. 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". + +18 Page Styles +************** + +The `\documentclass' command determines the size and position of the +page's head and foot. The page style determines what goes in them. + +18.1 `\maketitle' +================= + +The `\maketitle' command generates a title on a separate title +page--except in the `article' 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: + +`\author{NAME \and NAME2}' + The `\author' command declares the document author(s), where the + argument is a list of authors separated by `\and' commands. Use + `\\' to separate lines within a single author's entry--for + example, to give the author's institution or address. + +`\date{TEXT}' + The `\date' command declares TEXT to be the document's date. With + no `\date' command, the current date (*note \today::) is used. + +`\thanks{TEXT}' + The `\thanks' command produces a `\footnote' to the title, usually + used for credit acknowledgements. + +`\title{TEXT}' + The `\title' command declares TEXT to be the title of the + document. Use `\\' to force a line break, as usual. + + +18.2 `\pagenumbering' +===================== + +Synopsis: + + \pagenumbering{STYLE} + + Specifies the style of page numbers, according to STYLE: + +`arabic' + arabic numerals + +`roman' + lowercase Roman numerals + +`Roman' + uppercase Roman numerals + +`alph' + lowercase letters + +`Alph' + uppercase letters + +18.3 `\pagestyle' +================= + +Synopsis: + + \pagestyle{STYLE} + + The `\pagestyle' command specifies how the headers and footers are +typeset from the current page onwards. Values for STYLE: + +`plain' + Just a plain page number. + +`empty' + Empty headers and footers, e.g., no page numbers. + +`headings' + Put running headers on each page. The document style specifies + what goes in the headers. + +`myheadings' + Custom headers, specified via the `\markboth' or the `\markright' + commands. + + + Here are the descriptions of `\markboth' and `\markright': + +`\markboth{LEFT}{RIGHT}' + Sets both the left and the right heading. A "left-hand heading" + (LEFT) is generated by the last `\markboth' command before the end + of the page, while a "right-hand heading" (RIGHT is generated by + the first `\markboth' or `\markright' that comes on the page if + there is one, otherwise by the last one before the page. + +`\markright{RIGHT}' + Sets the right heading, leaving the left heading unchanged. + + +18.4 `\thispagestyle{STYLE}' +============================ + +The `\thispagestyle' command works in the same manner as the +`\pagestyle' command (see previous section) except that it changes to +STYLE for the current page only. + +19 Spaces +********* + +LaTeX has many ways to produce white (or filled) space. + + Another space-producing command is `\,' to produce a "thin" space +(usually 1/6quad). It can be used in text mode, but is more often +useful in math mode (*note Spacing in math mode::). + +19.1 `\hspace' +============== + +Synopsis: + + \hspace[*]{LENGTH} + + The `\hspace' command adds horizontal space. The LENGTH argument +can be expressed in any terms that LaTeX understands: points, inches, +etc. It is a rubber length. You can add both negative and positive +space with an `\hspace' command; adding negative space is like +backspacing. + + LaTeX normally removes horizontal space that comes at the beginning +or end of a line. To preserve this space, use the optional `*' form. + +19.2 `\hfill' +============= + +The `\hfill' fill command produces a "rubber length" which has no +natural space but can stretch or shrink horizontally as far as needed. + + The `\fill' parameter is the rubber length itself (technically, the +glue value `0pt plus1fill'); thus, `\hspace\fill' is equivalent to +`\hfill'. + +19.3 `\SPACE' +============= + +The `\ ' (space) command produces a normal interword space. It's +useful after punctuation which shouldn't end a sentence. For example +`Knuth's article in Proc.\ Amer.\ Math\. Soc.\ is fundamental'. It is +also often used after control sequences, as in `\TeX\ is a nice system.' + + In normal circumstances, `\'<tab> and `\'<newline> are equivalent to +`\ '. + +19.4 `\@' +========= + +The `\@' command makes the following punctuation character end a +sentence even if it normally would not. This is typically used after a +capital letter. Here are side-by-side examples with and without `\@': + + ... in C\@. Pascal, though ... + ... in C. Pascal, though ... + +produces + + ... in C. Pascal, though ... ... in C. Pascal, though ... + +19.5 `\thinspace' +================= + +`\thinspace' 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 +'". + +19.6 `\/' +========= + +The `\/' command produces an "italic correction". This is a small +space defined by the font designer for a given character, to avoid the +character colliding with whatever follows. The italic f character +typically has a large italic correction value. + + 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 f: f; (in the TeX output, the `f's +are nicely separated) with f: f;. + + Despite the name, roman characters can also have an italic +correction. Compare pdfTeX (in the TeX output, there is a small space +after the `f') with pdfTeX. + +19.7 `\hrulefill' +================= + +The `\hrulefill' fill command produces a "rubber length" which can +stretch or shrink horizontally. It will be filled with a horizontal +rule. + +19.8 `\dotfill' +=============== + +The `\dotfill' command produces a "rubber length" that fills with dots +instead of just white space. + +19.9 `\addvspace' +================= + +`\addvspace{length}' + + The `\addvspace' command normally adds a vertical space of height +length. However, if vertical space has already been added to the same +point in the output by a previous `\addvspace' command, then this +command will not add more space than needed to make the natural length +of the total vertical space equal to `length'. + +19.10 `\bigskip \medskip \smallskip' +==================================== + +These commands produce a given amount of space. + +`\bigskip' + The same as `\vspace{bigskipamount}', ordinarily about one line + space (with stretch and shrink). + +`\medskip' + The same as `\vspace{medskipamount}', ordinarily about half of a + line space (with stretch and shrink). + +`\smallskip' + The same as `\vspace{smallskipamount}', ordinarily about a quarter + of a line space (with stretch and shrink). + + + The `\...amount' parameters are determined by the document class. + +19.11 `\vfill' +============== + +The `\vfill' fill command produces a rubber length (glue) which can +stretch or shrink vertically as far as needed. It's equivalent to +`\vspace{\fill}' (*note \hfill::). + +19.12 `\vspace[*]{LENGTH}' +========================== + +Synopsis: + + \vspace[*]{LENGTH} + + The `\vspace' command adds the vertical space LENGTH, i.e., a rubber +length. LENGTH can be negative or positive. + + Ordinarily, LaTeX removes vertical space added by `\vspace' at the +top or bottom of a page. With the optional `*' argument, the space is +not removed. + +20 Boxes +******** + +All the predefined length parameters (*note Predefined lengths::) can be +used in the arguments of the box-making commands. + +20.1 `\mbox{TEXT}' +================== + +The `\mbox' command creates a box just wide enough to hold the text +created by its argument. The TEXT is not broken into lines, so it can +be used to prevent hyphenation. + +20.2 `\fbox' and `\framebox' +============================ + +Synopses: + + \fbox{TEXT} + \framebox[WIDTH][POSITION]{TEXT} + + The `\fbox' and `\framebox' commands are like `\mbox', except that +they put a frame around the outside of the box being created. + + In addition, the `\framebox' command allows for explicit +specification of the box width with the optional WIDTH argument (a +dimension), and positioning with the optional POSITION argument. Both +commands produce a rule of thickness `\fboxrule' (default `.4pt'), and +leave a space of `\fboxsep' (default `3pt') between the rule and the +contents of the box. + + *Note \framebox (picture)::, for the `\framebox' command in the +`picture' environment. + +20.3 `lrbox' +============ + +`\begin{lrbox}{cmd} text \end{lrbox}' + + This is the environment form of `\sbox'. + + The text inside the environment is saved in the box `cmd', which +must have been declared with `\newsavebox'. + +20.4 `\makebox' +=============== + +Synopsis: + + \makebox[WIDTH][POSITION]{TEXT} + + The `\makebox' command creates a box just wide enough to contain the +TEXT specified. The width of the box is specified by the optional +WIDTH argument. The position of the text within the box is determined +by the optional POSITION argument, which may take the following values: + +`c' + Centered (default). + +`l' + Flush left. + +`r' + Flush right. + +`s' + Stretch (justify) across entire WIDTH; TEXT must contain + stretchable space for this to work. + + `\makebox' is also used within the picture environment *note +\makebox (picture)::. + +20.5 `\parbox' +============== + +Synopsis: + + \parbox[POSITION][HEIGHT][INNER-POS]{WIDTH}{TEXT} + + The `\parbox' command produces a box whose contents are created in +`paragraph' 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 `\parbox' argument. For larger +pieces of text, including ones containing a paragraph-making +environment, you should use a `minipage' environment (*note minipage::). + + `\parbox' has two mandatory arguments: + +WIDTH + the width of the parbox; + +TEXT + the text that goes inside the parbox. + + The optional POSITION argument allows you to align either the top or +bottom line in the parbox with the baseline of the surrounding text +(default is top). + + The optional HEIGHT argument overrides the natural height of the box. + + The INNER-POS argument controls the placement of the text inside the +box, as follows; if it is not specified, POSITION is used. + +`t' + text is placed at the top of the box. + +`c' + text is centered in the box. + +`b' + text is placed at the bottom of the box. + +`s' + stretch vertically; the text must contain vertically stretchable + space for this to work. + +20.6 `\raisebox' +================ + +Synopsis: + + \raisebox{distance}[HEIGHT][DEPTH]{text} + + The `\raisebox' command raises or lowers TEXT. The first mandatory +argument specifies how high TEXT is to be raised (or lowered if it is a +negative amount). TEXT itself is processed in LR mode. + + The optional arguments HEIGHT and DEPTH are dimensions. If they are +specified, LaTeX treats TEXT as extending a certain distance above the +baseline (height) or below (depth), ignoring its natural height and +depth. + +20.7 `\savebox' +=============== + +Synopsis: + + \savebox{\BOXCMD}[WIDTH][POS]{TEXT} + + This command typeset TEXT in a box just as with `\makebox' (*note +\makebox::), except that instead of printing the resulting box, it +saves it in the box labeled \BOXCMD, which must have been declared with +`\newsavebox' (*note \newsavebox::). + +20.8 `\sbox{\BOXCMD}{TEXT}' +=========================== + +Synopsis: + + \sbox{\BOXCMD}{TEXT} + + `\sbox' types TEXT in a box just as with `\mbox' (*note \mbox::) +except that instead of the resulting box being included in the normal +output, it is saved in the box labeled \BOXCMD. \BOXCMD must have been +previously declared with `\newsavebox' (*note \newsavebox::). + +20.9 `\usebox{\BOXCMD' +====================== + +Synopsis: + + \usebox{\BOXCMD} + + `\usebox' producesthe box most recently saved in the bin \BOXCMD by +a `\savebox' command (*note \savebox::). + +21 Special insertions +********************* + +LaTeX provides commands for inserting characters that have a special +meaning do not correspond to simple characters you can type. + +21.1 Reserved characters +======================== + +The following characters play a special role in LaTeX and are called +"reserved characters" or "special characters". + + # $ % & ~ _ ^ \ { } + + 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 `\' in front of the character. For +example, `\$' will produce `$' in your output. + + One exception to this rule is `\' itself, because `\\' has its own +special (context-dependent) meaning. A roman \ is produced by typing +`$\backslash$' in your file, and a typewriter `\' is produced by using +`\' in a verbatim command (*note verbatim::). + + Also, `\~' and `\^' place tilde and circumflex accents over the +following letter, as in o~ and o^ (*note Accents::); to get a +standalone `~' or `^', you can again use a verbatim command. + + Finally, you can access any character of the current font once you +know its number by using the `\symbol' command. For example, the +visible space character used in the `\verb*' command has the code +decimal 32, so it can be typed as `\symbol{32}'. + + You can also specify octal numbers with `'' or hexadecimal numbers +with `"', so the previous example could also be written as +`\symbol{'40}' or `\symbol{"20}'. + +21.2 Text symbols +================= + +LaTeX provides commands to generate a number of non-letter symbols in +running text. + +`\copyright' + The copyright symbol, (C). + +`\dag' + The dagger symbol (in text). + +`\ddag' + The double dagger symbol (in text). + +`\LaTeX' + The LaTeX logo. + +`\ldots' + An ellipsis (three dots at the baseline): `...'. This command + also works in math mode. + +`\lq' + Left (opening) quote: `. + +`\P' + Paragraph sign (pilcrow). + +`\pounds' + English pounds sterling. + +`\rq' + Right (closing) quote: '. + +`\S' + Section symbol. + +`\TeX' + The TeX logo. + + +21.3 Accents +============ + +LaTeX has wide support for many of the world's scripts and languages, +through the `babel' package and related support. This section does not +attempt to cover all that support. It merely the core LaTeX commands +for creating accented characters. + +`\"' + Produces an umlaut, as in o". + +`\'' + Produces an acute accent, as in o'. In the `tabbing' environment, + pushes current column to the right of the previous column (*note + tabbing::). + +`\.' + Produces a dot accent over the following, as in o.. + +`\=' + Produces a macron (overbar) accent over the following, as in o=. + +`\^' + Produces a circumflex (hat) accent over the following, as in o^. + +`\`' + Produces a grave accent over the following, as in o`. In the + `tabbing' environment, move following text to the right margin + (*note tabbing::). + +`\~' + Produces a tilde accent over the following, as in n~. + +`\b' + Produces a bar accent under the following, as in o_. + +`\bar' + Produces a macron accent over the following, as in o=. + +`\c' + Produces a cedilla accent under the following, as in + +`\d' + Produces a dot accent under the following, as in .o. + +`\H' + Produces a long Hungarian umlaut accent over the following, as in + o''. + +`\i' + Produces a dotless i, as in `i'. + +`\j' + Produces a dotless j, as in `j'. + +`\t' + Produces a tie-after accent, as in `oo['. + +`\u' + Produces a breve accent, as in `o('. + +`\v' + Produces a ha'c<ek (check) accent, as in `o<'. + + +21.4 Non-English characters +=========================== + +Here are the basic LaTeX commands for inserting characters commonly +used in languages other than English. + +`\aa' +`\AA' + aa and AA. + +`\ae' +`\AE' + ae and AE. + +`\l' +`\L' + /l and /L. + +`\o' +`\O' + /o and /O. + +`\oe' +`\OE' + oe and OE. + +`\ss' + ss. + + +21.5 `\rule' +============ + +Synopsis: + + \rule[RAISE]{WIDTH}{THICKNESS} + + The `\rule' command produces "rules", that is, lines or rectangles. +The arguments are: + +RAISE + How high to raise the rule (optional). + +WIDTH + The length of the rule (mandatory). + +THICKNESS + The thickness of the rule (mandatory). + +21.6 `\today' +============= + +The `\today' command produces today's date, in the format `MONTH DD, +YYYY'; for example, `July 4, 1976'. It uses the predefined counters +`\day', `\month', and `\year' (*note \day \month \year::) to do this. +It is not updated as the program runs. + + The `datetime' package, among others, can produce a wide variety of +other date formats. + +22 Splitting the input +********************** + +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. + +22.1 `\include' +=============== + +Synopsis: + + \include{FILE} + + If no `\includeonly' command is present, the `\include' command +executes `\clearpage' to start a new page (*note \clearpage::), then +reads FILE, then does another `\clearpage'. + + Given an `\includeonly' command, the `\include' actions are only run +if FILE is listed as an argument to `\includeonly'. See the next +section. + + The `\include' command may not appear in the preamble or in a file +read by another `\include' command. + +22.2 \`includeonly' +=================== + +Synopsis: + + \includeonly{FILE1,FILE2,...} + + The `\includeonly' command controls which files will be read by +subsequent `\include' commands. The list of filenames is +comma-separated. Each FILE must exactly match a filename specified in a +`\include' command for the selection to be effective. + + This command can only appear in the preamble. + +22.3 \input +=========== + +Synopsis: + + \input{FILE} + + The `\input' command causes the specified FILE to be read and +processed, as if its contents had been inserted in the current file at +that point. + + If FILE does not end in `.tex' (e.g., `foo' or `foo.bar'), it is +first tried with that extension (`foo.tex' or `foo.bar.tex'). If that +is not found, the original FILE is tried (`foo' or `foo.bar'). + +23 Front/back matter +******************** + +23.1 Tables of contents +======================= + +A table of contents is produced with the `\tableofcontents' 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 +`.toc' file. + + The `\tableofcontents' 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 `\newpage' command after the `\tableofcontents' +command. + + The analagous commands `\listoffigures' and `\listoftables' produce +a list of figures and a list of tables, respectively. Everything works +exactly the same as for the table of contents. + + The command `\nofiles' overrides these commands, and _prevents_ any +of these lists from being generated. + +23.1.1 \addcontentsline +----------------------- + +The `\addcontentsline' command adds an entry to the specified list or +table where: + +EXT + The extension of the file on which information is to be written, + typically one of: `toc' (table of contents), `lof' (list of + figures), or `lot' (list of tables). + +UNIT + The name of the sectional unit being added, typically one of the + following, matching the value of the EXT argument: + + `toc' + The name of the sectional unit: `part', `chapter', `section', + `subsection', `subsubsection'. + + `lof' + For the list of figures. + + `lot' + For the list of tables. + +ENTRY + The actual text of the entry. + + What is written to the `.EXT' file is the command +`\contentsline{UNIT}{NAME}'. + +23.1.2 \addtocontents +--------------------- + +The `\addtocontents' command adds text (or formatting commands) +directly to the `.'EXT file that generates the table of contents or +lists of figures or tables. + +EXT + The extension of the file on which information is to be written: + `toc' (table of contents), `lof' (list of figures), or `lot' (list + of tables). + +TEXT + The text to be written. + +23.2 Glossaries +=============== + +The command `\makeglossary' enables creating glossaries. + + The command `\glossary{TEXT}' writes a glossary entry for TEXT to an +auxiliary file with the `.glo' extension. + + Specifically, what gets written is the command +`\glossaryentry{TEXT}{PAGENO}', where PAGENO is the current `\thepage' +value. + + The `glossary' package on CTAN provides support for fancier +glossaries. + +23.3 Indexes +============ + +The command `\makeindex' enables creating indexes. + + The command `\index{TEXT}' writes a glossary entry for TEXT to an +auxiliary file with the `.idx' extension. + + Specifically, what gets written is the command +`\indexentry{TEXT}{PAGENO}', where PAGENO is the current `\thepage' +value. + + The rubber length `\indexspace' is inserted before each new letter +in the index; its default value is `10pt plus5pt minus3pt'. + + The `.idx' file can then be sorted with an external command, +typically `makeindex' or `xindy', resulting in a `.ind' file, which can +then be used to typeset the index. + +24 Letters +********** + +You can use LaTeX to typeset letters, both personal and business. The +`letter' document class is designed to make a number of letters at +once, although you can make just one if you so desire. + + Your `.tex' source file has the same minimum commands as the other +document classes, i.e., you must have the following commands as a +minimum: + + \documentclass{letter} + \begin{document} + ... letters ... + \end{document} + + Each letter is a `letter' environment, whose argument is the name +and address of the recipient. For example, you might have: + + \begin{letter}{Mr. Joe Smith\\ 2345 Princess St. + \\ Edinburgh, EH1 1AA} + ... + \end{letter} + + The letter itself begins with the `\opening' command. The text of +the letter follows. It is typed as ordinary LaTeX input. Commands that +make no sense in a letter, like `\chapter', do not work. The letter +closes with a `\closing' command. + + After the `closing', you can have additional material. The `\cc' +command produces the usual "cc: ...". There's also a similar `\encl' +command for a list of enclosures. With both these commands, use `\\' to +separate the items. + + These commands are used with the `letter' class. + +24.1 \address{RETURN-ADDRESS} +============================= + +The `\address' specifies the return address of a letter, as it should +appear on the letter and the envelope. Separate lines of the address +should be separated by `\\' commands. + + If you do not make an `\address' declaration, then the letter will +be formatted for copying onto your organisation's standard letterhead. +(*Note Overview::, for details on your local implementation). If you +give an `\address' declaration, then the letter will be formatted as a +personal letter. + +24.2 `\cc' +========== + +Synopsis: + + \cc{NAME1\\NAME2} + + Produce a list of NAMEs the letter was copied to. Each name is +printed on a separate line. + +24.3 `\closing' +=============== + +Synopsis: + + \closing{text} + + A letter closes with a `\closing' command, for example, + \closing{Best Regards,} + +24.4 `\encl' +============ + +Synopsis: + + \encl{LINE1\\LINE2} + + Declare a list of one more enclosures. + +24.5 `\location' +================ + +`\location{address}' + + This modifies your organisation's standard address. This only +appears if the `firstpage' pagestyle is selected. + +24.6 `\makelabels' +================== + +`\makelabels{number}' + + If you issue this command in the preamble, LaTeX will create a sheet +of address labels. This sheet will be output before the letters. + +24.7 `\name' +============ + +`\name{June Davenport}' + + Your name, used for printing on the envelope together with the return +address. + +24.8 `\opening{TEXT}' +===================== + +Synopsis: + + \opening{TEXT} + + A letter begins with the `\opening' command. The mandatory +argument, TEXT, is whatever text you wish to start your letter. For +instance: + + \opening{Dear Joe,} + +24.9 `\ps' +========== + +Use the `\ps' command to start a postscript in a letter, after +`\closing'. + +24.10 `\signature{TEXT}' +======================== + +Your name, as it should appear at the end of the letter underneath the +space for your signature. `\\' starts a new line within TEXT as usual. + +24.11 `\startbreaks' +==================== + +`\startbreaks' + + Used after a `\stopbreaks' command to allow page breaks again. + +24.12 `\stopbreaks' +=================== + +`\stopbreaks' + + Inhibit page breaks until a `\startbreaks' command occurs. + +24.13 `\telephone' +================== + +`\telephone{number}' + + This is your telephone number. This only appears if the `firstpage' +pagestyle is selected. + +25 Terminal Input/Output +************************ + +25.1 `\typein[CMD]{MSG}' +======================== + +Synopsis: + + \typein[\CMD]{MSG} + + `\typein' prints MSG on the terminal and causes LaTeX to stop and +wait for you to type a line of input, ending with return. If the +optional \CMD argument is omitted, the typed input is processed as if +it had been included in the input file in place of the `\typein' +command. If the \CMD argument is present, it must be a command name. +This command name is then defined or redefined to be the typed input. + +25.2 `\typeout{MSG}' +==================== + +Synopsis: + + \typeout{MSG} + + Prints `msg' on the terminal and in the `log' file. Commands in +`msg' that are defined with `\newcommand' or `\renewcommand' (among +others) are replaced by their definitions before being printed. + + LaTeX's usual rules for treating multiple spaces as a single space +and ignoring spaces after a command name apply to `msg'. A `\space' +command in `msg' causes a single space to be printed, independent of +surrounding spaces. A `^^J' in `msg' prints a newline. + +26 Command Line +*************** + +The input file specification indicates the file to be formatted; TeX +uses `.tex' 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. + + latex '\nonstopmode\input foo.tex' + +will process `foo.tex' without pausing after every error. + + If LaTeX stops in the middle of the document and gives you a `*' +prompt, it is waiting for input. You can type `\stop' (and return) and +it will prematurely end the document. + +Appendix A Document templates +***************************** + +Although not reference material, perhaps these document templates will +be useful. + +A.1 `book' template +=================== + +\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} + +A.2 `beamer' template +===================== + +The `beamer' class creates slides presentations. + +\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} + +A.3 `tugboat' template +====================== + +`TUGboat' is the journal of the TeX Users Group, +`http://tug.org/TUGboat'. + +\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} + +Concept Index +************* + +* prompt: See 26. (line 4738) +*-form of sectioning commands: See 6. (line 788) +.glo file: See 23.2. (line 4515) +.idx file: See 23.3. (line 4530) +.ind file: See 23.3. (line 4540) +abstracts: See 8.1. (line 881) +accents: See 21.3. (line 4263) +accents, mathematical: See 16.4. (line 3611) +accessing any character of a font: See 21.1. (line 4210) +acute accent: See 21.3. (line 4272) +acute accent, math: See 16.4. (line 3616) +ae ligature: See 21.4. (line 4337) +aligning Equations: See 8.8. (line 1065) +alignment via tabbing: See 8.21. (line 1688) +appendix, creating: See 6. (line 794) +aring: See 21.4. (line 4333) +arrays, math: See 8.2. (line 892) +author, for titlepage: See 18.1. (line 3779) +bar-over accent: See 21.3. (line 4280) +bar-under accent: See 21.3. (line 4294) +bibliography, creating (automatically): See 8.24.4. (line 2035) +bibliography, creating (manually): See 8.24. (line 1970) +bibTeX, using: See 8.24.4. (line 2035) +black boxes, omitting: See 3.1. (line 357) +bold font: See 4.1. (line 502) +bold typewriter, avoiding: See 8.4. (line 988) +boxes: See 20. (line 4019) +breaking lines: See 13. (line 2578) +breaking pages: See 14. (line 2679) +breve accent: See 21.3. (line 4319) +breve accent, math: See 16.4. (line 3619) +bullet symbol: See 16.2. (line 2946) +bulleted lists: See 8.13. (line 1223) +calligraphic letters for math: See 4.1. (line 505) +cc list, in letters: See 24.2. (line 4596) +cedilla accent: See 21.3. (line 4300) +centering text, declaration for: See 8.3.1. (line 953) +centering text, environment for: See 8.3. (line 939) +characters, accented: See 21.3. (line 4263) +characters, non-English: See 21.4. (line 4328) +characters, reserved: See 21.1. (line 4191) +check accent: See 21.3. (line 4322) +check accent, math: See 16.4. (line 3622) +circumflex accent: See 21.3. (line 4283) +circumflex accent, math: See 16.4. (line 3634) +class options: See 3.1. (line 336) +classes of documents: See 3. (line 319) +closing letters: See 24.3. (line 4606) +closing quote: See 21.2. (line 4251) +code, typesetting: See 8.27. (line 2105) +command Line: See 26. (line 4729) +commands, defining new ones: See 10.1. (line 2231) +computer programs, typesetting: See 8.27. (line 2105) +copyright symbol: See 21.2. (line 4226) +counters, a list of: See 11. (line 2405) +counters, defining new: See 10.2. (line 2264) +counters, getting value of: See 11.3. (line 2464) +counters, setting: See 11.4. (line 2478) +creating letters: See 24. (line 4547) +creating pictures: See 8.18. (line 1404) +creating tables: See 8.22. (line 1780) +credit footnote: See 18.1. (line 3789) +cross references: See 7. (line 807) +cross referencing with page number: See 7.2. (line 849) +cross referencing, symbolic: See 7.3. (line 859) +dagger, in text: See 21.2. (line 4229) +date, for titlepage: See 18.1. (line 3785) +datetime package: See 21.6. (line 4382) +defining a new command: See 10.1. (line 2231) +defining new environments: See 10.5. (line 2304) +defining new fonts: See 10.7. (line 2369) +defining new theorems: See 10.6. (line 2340) +definitions: See 10. (line 2226) +description lists, creating: See 8.4. (line 976) +discretionary multiplication: See 16.6. (line 3680) +displaying quoted text with paragraph indentation:See 8.19. (line 1658) +displaying quoted text without paragraph indentation:See 8.20. + (line 1673) +document class options: See 3.1. (line 336) +document classes: See 3. (line 319) +document templates: See Appendix A. + (line 4745) +dot accent: See 21.3. (line 4277) +dot over accent, math: See 16.4. (line 3628) +dot-over accent: See 21.3. (line 4277) +dot-under accent: See 21.3. (line 4303) +dotless i: See 21.3. (line 4310) +dotless i, math: See 16.4. (line 3637) +dotless j: See 21.3. (line 4313) +dotless j, math: See 16.4. (line 3640) +double dagger, in text: See 21.2. (line 4232) +double dot accent, math: See 16.4. (line 3625) +ellipsis: See 21.2. (line 4238) +emphasis: See 4.1. (line 444) +enclosure list: See 24.4. (line 4616) +ending & starting: See 2. (line 301) +enlarge current page: See 14.4. (line 2706) +environments: See 8. (line 871) +environments, defining: See 10.5. (line 2304) +equation number, cross referencing: See 7.3. (line 859) +equation numbers, omitting: See 8.8. (line 1079) +equations, aligning: See 8.8. (line 1065) +equations, environment for: See 8.9. (line 1091) +es-zet German letter: See 21.4. (line 4352) +exponent: See 16.1. (line 2856) +figure number, cross referencing: See 7.3. (line 859) +figures, footnotes in: See 8.17. (line 1391) +figures, inserting: See 8.10. (line 1104) +fixed-width font: See 4.1. (line 526) +flushing floats and starting a page: See 14.2. (line 2694) +font commands, low-level: See 4.3. (line 558) +font sizes: See 4.2. (line 532) +font styles: See 4.1. (line 424) +fonts: See 4. (line 418) +fonts, new commands for: See 10.7. (line 2369) +footer style: See 18.3. (line 3824) +footer, parameters for: See 5.5. (line 706) +footnote number, cross referencing: See 7.3. (line 859) +footnote parameters: See 9.4. (line 2209) +footnotes in figures: See 8.17. (line 1391) +footnotes, creating: See 9. (line 2158) +formulas, environment for: See 8.9. (line 1091) +formulas, math: See 16. (line 2818) +fragile commands: See 10.8. (line 2383) +functions, math: See 16.3. (line 3502) +global options: See 3.1. (line 336) +glossaries: See 23.2. (line 4513) +grave accent: See 21.3. (line 4286) +grave accent, math: See 16.4. (line 3631) +greek letters: See 16.2. (line 2865) +ha'c<ek accent, math: See 16.4. (line 3622) +hacek accent: See 21.3. (line 4322) +hat accent: See 21.3. (line 4283) +hat accent, math: See 16.4. (line 3634) +header style: See 18.3. (line 3824) +header, parameters for: See 5.5. (line 706) +hungarian umlaut accent: See 21.3. (line 4306) +hyphenation, defining: See 13.7. (line 2646) +hyphenation, forcing: See 13.4. (line 2616) +hyphenation, preventing: See 20.1. (line 4025) +in-line formulas: See 8.16. (line 1363) +indent, forcing: See 15.1. (line 2747) +indent, suppressing: See 15.2. (line 2758) +indentation of paragraphs, in minipage: See 8.17. (line 1387) +indexes: See 23.3. (line 4528) +input file: See 22. (line 4388) +input/Output: See 25. (line 4696) +inserting figures: See 8.10. (line 1104) +italic font: See 4.1. (line 511) +justification, ragged left: See 8.12.1. (line 1210) +justification, ragged right: See 8.11.1. (line 1184) +Knuth, Donald E.: + See ``LaTeX2e''. (line 251) +labelled lists, creating: See 8.4. (line 976) +Lamport, Leslie: + See ``LaTeX2e''. (line 251) +LaTeX logo: See 21.2. (line 4235) +LaTeX overview: See 1. (line 261) +LaTeX Project team: + See ``LaTeX2e''. (line 251) +layout commands: See 5. (line 634) +layout, page parameters for: See 5.5. (line 706) +left quote: See 21.2. (line 4242) +left-justifying text: See 8.11.1. (line 1184) +left-justifying text, environment for: See 8.11. (line 1171) +left-to-right mode: See 17. (line 3729) +lengths, adding to: See 12.2. (line 2531) +lengths, defining and using: See 12. (line 2518) +lengths, defining new: See 10.3. (line 2279) +lengths, predefined: See 12.6. (line 2559) +lengths, setting: See 12.1. (line 2524) +letters: See 24. (line 4547) +letters, accented: See 21.3. (line 4263) +letters, ending: See 24.3. (line 4606) +letters, non-English: See 21.4. (line 4328) +letters, starting: See 24.8. (line 4649) +line break, forcing: See 13.1. (line 2590) +line breaking: See 13. (line 2578) +line breaks, forcing: See 13.8. (line 2662) +line breaks, preventing: See 13.8. (line 2662) +lines in tables: See 8.23. (line 1816) +lining text up in columns using tab stops: See 8.21. (line 1688) +lining text up in tables: See 8.23. (line 1816) +list items, specifying counter: See 11.2. (line 2453) +lists of items: See 8.13. (line 1223) +lists of items, generic: See 8.15. (line 1341) +lists of items, numbered: See 8.7. (line 1024) +loading additional packages: See 3.1. (line 404) +logo, LaTeX: See 21.2. (line 4235) +logo, TeX: See 21.2. (line 4257) +low-level font commands: See 4.3. (line 558) +lR mode: See 17. (line 3729) +macron accent: See 21.3. (line 4280) +makeindex program: See 23.3. (line 4540) +making a title page: See 8.26. (line 2088) +making paragraphs: See 15. (line 2739) +marginal notes: See 15.4. (line 2771) +math accents: See 16.4. (line 3611) +math formulas: See 16. (line 2818) +math functions: See 16.3. (line 3502) +math Miscellany: See 16.6. (line 3679) +math mode: See 17. (line 3729) +math mode, entering: See 16. (line 2818) +math mode, spacing: See 16.5. (line 3658) +math symbols: See 16.2. (line 2865) +minipage, creating a: See 8.17. (line 1375) +modes: See 17. (line 3729) +monospace font: See 4.1. (line 526) +moving arguments: See 10.8. (line 2383) +multicolumn text: See 5.2. (line 645) +multiplication symbol, discretionary line break:See 16.6. (line 3680) +nested \include, not allowed: See 22.1. (line 4409) +new commands, defining: See 10.1. (line 2231) +new line, output as input: See 13.2. (line 2600) +new line, starting: See 13.1. (line 2590) +new line, starting (paragraph mode): See 13.3. (line 2609) +new page, starting: See 14.3. (line 2700) +non-English characters: See 21.4. (line 4328) +notes in the margin: See 15.4. (line 2771) +null delimiter: See 16.6. (line 3694) +numbered items, specifying counter: See 11.2. (line 2453) +oblique font: See 4.1. (line 523) +oe ligature: See 21.4. (line 4349) +one-column output: See 5.1. (line 639) +opening quote: See 21.2. (line 4242) +options, document class: See 3.1. (line 336) +options, global: See 3.1. (line 411) +oslash: See 21.4. (line 4345) +overbar accent: See 21.3. (line 4280) +overdot accent, math: See 16.4. (line 3628) +overview of LaTeX: See 1. (line 261) +packages, loading: See 3.1. (line 404) +page break, forcing: See 14.5. (line 2721) +page break, preventing: See 14.5. (line 2721) +page breaking: See 14. (line 2679) +page layout parameters: See 5.5. (line 706) +page number, cross referencing: See 7.2. (line 849) +page numbering style: See 18.2. (line 3800) +page styles: See 18. (line 3767) +paragraph indentation, in minipage: See 8.17. (line 1387) +paragraph indentations in quoted text: See 8.19. (line 1658) +paragraph indentations in quoted text, omitting:See 8.20. (line 1673) +paragraph mode: See 17. (line 3729) +paragraph sign: See 21.2. (line 4245) +paragraphs: See 15. (line 2739) +parameters, page layout: See 5.5. (line 706) +pictures, creating: See 8.18. (line 1404) +pilcrow: See 21.2. (line 4245) +poetry, an environment for: See 8.28. (line 2139) +polish l: See 21.4. (line 4341) +postscript, in letters: See 24.9. (line 4662) +pounds symbol: See 21.2. (line 4248) +preamble, defined: See 2. (line 312) +predefined lengths: See 12.6. (line 2559) +prompt, *: See 26. (line 4738) +quoted text with paragraph indentation, displaying:See 8.19. (line 1658) +quoted text without paragraph indentation, displaying:See 8.20. + (line 1673) +ragged left text: See 8.12.1. (line 1210) +ragged left text, environment for: See 8.12. (line 1197) +ragged right text: See 8.11.1. (line 1184) +ragged right text, environment for: See 8.11. (line 1171) +redefining environments: See 10.5. (line 2304) +remarks in the margin: See 15.4. (line 2771) +reserved characters: See 21.1. (line 4191) +right quote: See 21.2. (line 4251) +right-justifying text: See 8.12.1. (line 1210) +right-justifying text, environment for: See 8.12. (line 1197) +robust commands: See 10.8. (line 2393) +roman font: See 4.1. (line 514) +running header and footer: See 5.5. (line 706) +running header and footer style: See 18.3. (line 3824) +sans serif font: See 4.1. (line 520) +script letters for math: See 4.1. (line 505) +section number, cross referencing: See 7.3. (line 859) +section symbol: See 21.2. (line 4254) +sectioning: See 6. (line 756) +setspace package: See 4.3. (line 615) +setting counters: See 11.4. (line 2478) +sharp S letters: See 21.4. (line 4352) +simulating typed text: See 8.27. (line 2105) +sizes of text: See 4.2. (line 532) +slanted font: See 4.1. (line 523) +small caps font: See 4.1. (line 517) +space, inserting vertical: See 19.9. (line 3967) +spaces: See 19. (line 3869) +spacing within math mode: See 16.5. (line 3658) +special characters: See 21.4. (line 4328) +splitting the input file: See 22. (line 4388) +starting & ending: See 2. (line 301) +starting a new page: See 14.3. (line 2700) +starting a new page and clearing floats: See 14.2. (line 2694) +starting on a right-hand page: See 14.1. (line 2686) +sterling symbol: See 21.2. (line 4248) +stretch, omitting vertical: See 5.4. (line 700) +styles of text: See 4.1. (line 424) +styles, page: See 18. (line 3767) +subscript: See 16.1. (line 2856) +superscript: See 16.1. (line 2856) +symbols, math: See 16.2. (line 2865) +tab stops, using: See 8.21. (line 1688) +table of contents entry, manually adding: See 23.1.1. (line 4467) +table of contents, creating: See 23.1. (line 4447) +tables, creating: See 8.22. (line 1780) +terminal Input/Output: See 25. (line 4696) +TeX logo: See 21.2. (line 4257) +text symbols: See 21.2. (line 4222) +thanks, for titlepage: See 18.1. (line 3789) +theorems, defining: See 10.6. (line 2340) +theorems, typesetting: See 8.25. (line 2075) +tie-after accent: See 21.3. (line 4316) +tilde accent: See 21.3. (line 4291) +tilde accent, math: See 16.4. (line 3643) +title pages, creating: See 8.26. (line 2088) +title, for titlepage: See 18.1. (line 3793) +titles, making: See 18.1. (line 3773) +two-column output: See 5.2. (line 645) +typed text, simulating: See 8.27. (line 2105) +typeface sizes: See 4.2. (line 532) +typeface styles: See 4.1. (line 424) +typefaces: See 4. (line 418) +typewriter font: See 4.1. (line 526) +typewriter labels in lists: See 8.4. (line 988) +umlaut accent: See 21.3. (line 4269) +unordered lists: See 8.13. (line 1223) +using BibTeX: See 8.24.4. (line 2035) +variables, a list of: See 11. (line 2405) +vector symbol, math: See 16.4. (line 3646) +verbatim text: See 8.27. (line 2105) +verbatim text, inline: See 8.27.1. (line 2122) +vertical space: See 19.9. (line 3967) +vertical space before paragraphs: See 15.3. (line 2765) +visible space: See 8.27.1. (line 2133) +wide hat accent, math: See 16.4. (line 3649) +wide tile accent, math: See 16.4. (line 3652) +xindy program: See 23.3. (line 4540) +Command Index +************* + +$: See 16. (line 2838) +10pt option: See 3.1. (line 344) +11pt option: See 3.1. (line 344) +12pt option: See 3.1. (line 344) +@{...}: See 8.2. (line 917) +\" (umlaut accent): See 21.3. (line 4269) +\#: See 21.1. (line 4196) +\$: See 21.1. (line 4196) +\%: See 21.1. (line 4196) +\&: See 21.1. (line 4196) +\' (acute accent): See 21.3. (line 4272) +\' (tabbing): See 8.21. (line 1727) +\(: See 16. (line 2830) +\): See 16. (line 2830) +\*: See 16.6. (line 3679) +\+: See 8.21. (line 1719) +\,: See 16.5. (line 3671) +\-: See 8.21. (line 1723) +\- (hyphenation): See 13.4. (line 2616) +\. (dot-over accent): See 21.3. (line 4277) +\/: See 19.6. (line 3936) +\:: See 16.5. (line 3668) +\;: See 16.5. (line 3664) +\<: See 8.21. (line 1715) +\= (macron accent): See 21.3. (line 4280) +\= (tabbing): See 8.21. (line 1709) +\> <1>: See 16.5. (line 3668) +\>: See 8.21. (line 1713) +\> (tabbing): See 8.21. (line 1712) +\@: See 19.4. (line 3915) +\[: See 16. (line 2830) +\\ (for \shortstack objects): See 8.18.13. (line 1642) +\\ (for array): See 8.2. (line 914) +\\ (for center): See 8.3. (line 946) +\\ (for eqnarray): See 8.8. (line 1071) +\\ (for flushright): See 8.12. (line 1203) +\\ for \author: See 18.1. (line 3779) +\\ for \title: See 18.1. (line 3793) +\\ for flushleft: See 8.11. (line 1177) +\\ for letters: See 24. (line 4573) +\\ for tabular: See 8.23. (line 1833) +\\ for verse: See 8.28. (line 2150) +\\ force line break: See 13.1. (line 2590) +\\ tabbing: See 8.21. (line 1706) +\\* (for eqnarray): See 8.8. (line 1076) +\]: See 16. (line 2830) +\^: See 21.1. (line 4206) +\^ (circumflex accent): See 21.3. (line 4283) +\_: See 21.1. (line 4196) +\` (grave accent): See 21.3. (line 4286) +\` (tabbing): See 8.21. (line 1733) +\a (tabbing): See 8.21. (line 1742) +\a' (acute accent in tabbing): See 8.21. (line 1743) +\a= (macron accent in tabbing): See 8.21. (line 1743) +\a` (grave accent in tabbing): See 8.21. (line 1743) +\AA (AA): See 21.4. (line 4333) +\aa (aa): See 21.4. (line 4333) +\acute: See 16.4. (line 3615) +\addcontentsline{EXT}{UNIT}{TEXT}: See 23.1.1. (line 4467) +\address: See 24.1. (line 4583) +\addtocontents{EXT}{TEXT}: See 23.1.2. (line 4498) +\addtocounter: See 11.5. (line 2488) +\addtolength: See 12.2. (line 2531) +\addvspace: See 19.9. (line 3967) +\AE (AE): See 21.4. (line 4337) +\ae (ae): See 21.4. (line 4337) +\aleph: See 16.2. (line 2873) +\Alph: See 11.1. (line 2427) +\alph: See 11.1. (line 2424) +\Alph example: See 8.7. (line 1060) +\alpha: See 16.2. (line 2876) +\amalg: See 16.2. (line 2879) +\and for \author: See 18.1. (line 3779) +\angle: See 16.2. (line 2882) +\appendix: See 6. (line 794) +\approx: See 16.2. (line 2885) +\arabic: See 11.1. (line 2430) +\arccos: See 16.3. (line 3505) +\arcsin: See 16.3. (line 3508) +\arctan: See 16.3. (line 3511) +\arg: See 16.3. (line 3514) +\arraycolsep: See 8.2. (line 929) +\arrayrulewidth: See 8.23. (line 1900) +\arraystretch: See 8.23. (line 1904) +\ast: See 16.2. (line 2888) +\asymp: See 16.2. (line 2891) +\author{NAME \and NAME2}: See 18.1. (line 3778) +\b (bar-under accent): See 21.3. (line 4294) +\backslash <1>: See 21.1. (line 4201) +\backslash: See 16.2. (line 2894) +\bar (macron, bar-over accent): See 21.3. (line 4297) +\baselineskip: See 4.3. (line 609) +\baselinestretch: See 4.3. (line 615) +\begin: See 8. (line 871) +\beta: See 16.2. (line 2897) +\bf: See 4.1. (line 501) +\bfseries: See 4.1. (line 450) +\bibitem: See 8.24.1. (line 1995) +\bibliography: See 8.24.4. (line 2035) +\bibliographystyle: See 8.24.4. (line 2035) +\bigcap: See 16.2. (line 2900) +\bigcirc: See 16.2. (line 2903) +\bigcup: See 16.2. (line 2906) +\bigodot: See 16.2. (line 2909) +\bigoplus: See 16.2. (line 2912) +\bigotimes: See 16.2. (line 2915) +\bigskip: See 19.10. (line 3981) +\bigskipamount: See 19.10. (line 3981) +\bigsqcup: See 16.2. (line 2924) +\bigtriangledown: See 16.2. (line 2918) +\bigtriangleup: See 16.2. (line 2921) +\biguplus: See 16.2. (line 2927) +\bigwedge: See 16.2. (line 2933) +\bmod: See 16.3. (line 3517) +\boldmath: See 16. (line 2843) +\bot: See 16.2. (line 2936) +\bottomfraction: See 8.10. (line 1138) +\bowtie: See 16.2. (line 2939) +\Box: See 16.2. (line 2942) +\breve: See 16.4. (line 3618) +\bullet: See 16.2. (line 2945) +\c (cedilla accent): See 21.3. (line 4300) +\cal: See 4.1. (line 504) +\cap: See 16.2. (line 2948) +\caption: See 8.10. (line 1134) +\cc: See 24.2. (line 4596) +\cdot: See 16.2. (line 2951) +\cdots: See 16.6. (line 3683) +\centering: See 8.3.1. (line 953) +\chapter: See 6. (line 760) +\check: See 16.4. (line 3621) +\chi: See 16.2. (line 2954) +\circ: See 16.2. (line 2957) +\circle: See 8.18.1. (line 1470) +\cite: See 8.24.2. (line 2012) +\cleardoublepage: See 14.1. (line 2686) +\clearpage: See 14.2. (line 2694) +\cline: See 8.23.2. (line 1944) +\closing: See 24.3. (line 4606) +\clubsuit: See 16.2. (line 2960) +\columnsep: See 5.2. (line 655) +\columnseprule: See 5.2. (line 658) +\columnwidth: See 5.2. (line 662) +\cong: See 16.2. (line 2963) +\contentsline: See 23.1.1. (line 4492) +\coprod: See 16.2. (line 2966) +\copyright: See 21.2. (line 4225) +\cos: See 16.3. (line 3520) +\cosh: See 16.3. (line 3523) +\cot: See 16.3. (line 3526) +\coth: See 16.3. (line 3529) +\csc: See 16.3. (line 3532) +\cup: See 16.2. (line 2969) +\d (dot-under accent): See 21.3. (line 4303) +\dag: See 21.2. (line 4228) +\dagger: See 16.2. (line 2972) +\dashbox: See 8.18.4. (line 1518) +\dashv: See 16.2. (line 2975) +\date{TEXT}: See 18.1. (line 3784) +\day: See 11.8. (line 2507) +\dblfloatpagefraction: See 5.2. (line 674) +\dblfloatsep: See 5.2. (line 678) +\dbltextfloatsep: See 5.2. (line 683) +\dbltopfraction: See 5.2. (line 669) +\ddag: See 21.2. (line 4231) +\ddagger: See 16.2. (line 2978) +\ddot: See 16.4. (line 3624) +\ddots: See 16.6. (line 3687) +\deg: See 16.3. (line 3535) +\delta: See 16.2. (line 2984) +\Delta: See 16.2. (line 2981) +\depth: See 12.6. (line 2563) +\det: See 16.3. (line 3538) +\diamond: See 16.2. (line 2990) +\Diamond: See 16.2. (line 2987) +\diamondsuit: See 16.2. (line 2993) +\dim: See 16.3. (line 3541) +\displaystyle: See 16. (line 2848) +\div: See 16.2. (line 2996) +\documentclass: See 3. (line 319) +\dot: See 16.4. (line 3627) +\doteq: See 16.2. (line 2999) +\dotfill: See 19.8. (line 3961) +\doublerulesep: See 8.23. (line 1908) +\Downarrow: See 16.2. (line 3005) +\downarrow: See 16.2. (line 3002) +\ell: See 16.2. (line 3008) +\em: See 4.1. (line 507) +\emph: See 4.1. (line 444) +\emptyset: See 16.2. (line 3011) +\encl: See 24.4. (line 4616) +\end: See 8. (line 871) +\enlargethispage: See 14.4. (line 2706) +\enumi: See 8.7. (line 1050) +\enumii: See 8.7. (line 1050) +\enumiii: See 8.7. (line 1050) +\enumiv: See 8.7. (line 1050) +\epsilon: See 16.2. (line 3014) +\equiv: See 16.2. (line 3017) +\eta: See 16.2. (line 3020) +\evensidemargin: See 3.1. (line 385) +\exists: See 16.2. (line 3023) +\exp: See 16.3. (line 3544) +\fbox: See 20.2. (line 4032) +\fboxrule <1>: See 20.2. (line 4042) +\fboxrule: See 8.18.3. (line 1511) +\fboxsep <1>: See 20.2. (line 4042) +\fboxsep: See 8.18.3. (line 1511) +\fill: See 19.2. (line 3897) +\flat: See 16.2. (line 3026) +\floatpagefraction: See 8.10. (line 1141) +\floatsep: See 8.10. (line 1145) +\flushbottom: See 5.3. (line 691) +\fnsymbol: See 11.1. (line 2439) +\fontencoding: See 4.3. (line 563) +\fontfamily: See 4.3. (line 566) +\fontseries: See 4.3. (line 577) +\fontshape: See 4.3. (line 592) +\fontsize: See 4.3. (line 609) +\footnote: See 9.1. (line 2165) +\footnotemark: See 9.2. (line 2180) +\footnoterule: See 9.4. (line 2209) +\footnotesep: See 9.4. (line 2215) +\footnotesize: See 4.2. (line 537) +\footnotetext: See 9.3. (line 2195) +\footskip: See 5.5. (line 716) +\forall: See 16.2. (line 3029) +\frac: See 16.6. (line 3691) +\frac{num}{den}: See 16.6. (line 3690) +\frame: See 8.18.5. (line 1531) +\framebox <1>: See 20.2. (line 4032) +\framebox: See 8.18.3. (line 1503) +\frown: See 16.2. (line 3032) +\fussy: See 13.5. (line 2628) +\gamma: See 16.2. (line 3038) +\Gamma: See 16.2. (line 3035) +\gcd: See 16.3. (line 3547) +\ge: See 16.2. (line 3041) +\geq: See 16.2. (line 3044) +\gets: See 16.2. (line 3047) +\gg: See 16.2. (line 3050) +\glossary: See 23.2. (line 4515) +\glossaryentry: See 23.2. (line 4518) +\grave: See 16.4. (line 3630) +\H (Hungarian umlaut accent): See 21.3. (line 4306) +\hat: See 16.4. (line 3633) +\hbar: See 16.2. (line 3053) +\headheight: See 5.5. (line 706) +\headsep: See 5.5. (line 711) +\heartsuit: See 16.2. (line 3056) +\height: See 12.6. (line 2561) +\hfill: See 19.2. (line 3894) +\hline: See 8.23.3. (line 1955) +\hom: See 16.3. (line 3550) +\hookleftarrow: See 16.2. (line 3059) +\hookrightarrow: See 16.2. (line 3062) +\hrulefill: See 19.7. (line 3954) +\hspace: See 19.1. (line 3878) +\Huge: See 4.2. (line 537) +\huge: See 4.2. (line 537) +\hyphenation: See 13.7. (line 2646) +\i (dotless i): See 21.3. (line 4310) +\iff: See 16.2. (line 3065) +\Im: See 16.2. (line 3068) +\imath: See 16.4. (line 3636) +\in: See 16.2. (line 3071) +\include: See 22.1. (line 4397) +\includeonly: See 22.2. (line 4415) +\indent: See 15.1. (line 2747) +\index: See 23.3. (line 4530) +\indexentry: See 23.3. (line 4533) +\inf: See 16.3. (line 3553) +\infty: See 16.2. (line 3074) +\input: See 22.3. (line 4429) +\int: See 16.2. (line 3077) +\intextsep: See 8.10. (line 1149) +\iota: See 16.2. (line 3080) +\it: See 4.1. (line 510) +\item <1>: See 8.13. (line 1223) +\item <2>: See 8.7. (line 1037) +\item: See 8.4. (line 984) +\itemindent: See 8.13. (line 1269) +\itemsep: See 8.13. (line 1292) +\itshape: See 4.1. (line 441) +\j (dotless j): See 21.3. (line 4313) +\jmath: See 16.4. (line 3639) +\Join: See 16.2. (line 3083) +\kappa: See 16.2. (line 3086) +\ker: See 16.3. (line 3556) +\kill: See 8.21. (line 1747) +\L (/L): See 21.4. (line 4341) +\l (/l): See 21.4. (line 4341) +\label: See 7.1. (line 813) +\labelenumi: See 8.7. (line 1054) +\labelenumii: See 8.7. (line 1054) +\labelenumiii: See 8.7. (line 1054) +\labelenumiv: See 8.7. (line 1054) +\labelitemi: See 8.13. (line 1249) +\labelitemii: See 8.13. (line 1249) +\labelitemiii: See 8.13. (line 1249) +\labelitemiv: See 8.13. (line 1249) +\labelsep: See 8.13. (line 1272) +\labelwidth: See 8.13. (line 1275) +\lambda: See 16.2. (line 3092) +\Lambda: See 16.2. (line 3089) +\land: See 16.2. (line 3095) +\langle: See 16.2. (line 3098) +\LARGE: See 4.2. (line 537) +\Large: See 4.2. (line 537) +\large: See 4.2. (line 537) +\LaTeX: See 21.2. (line 4234) +\lbrace: See 16.2. (line 3101) +\lbrack: See 16.2. (line 3104) +\lceil: See 16.2. (line 3107) +\ldots: See 21.2. (line 4237) +\le: See 16.2. (line 3110) +\leadsto: See 16.2. (line 3113) +\left DELIM1 ... \right DELIM2: See 16.6. (line 3693) +\leftarrow: See 16.2. (line 3118) +\Leftarrow: See 16.2. (line 3115) +\lefteqn: See 8.8. (line 1084) +\leftharpoondown: See 16.2. (line 3121) +\leftharpoonup: See 16.2. (line 3124) +\leftmargin: See 8.13. (line 1256) +\leftmargini: See 8.13. (line 1256) +\leftmarginii: See 8.13. (line 1256) +\leftmarginiii: See 8.13. (line 1256) +\leftmarginiv: See 8.13. (line 1256) +\leftmarginv: See 8.13. (line 1256) +\leftmarginvi: See 8.13. (line 1256) +\leftrightarrow: See 16.2. (line 3130) +\Leftrightarrow: See 16.2. (line 3127) +\leq: See 16.2. (line 3133) +\lfloor: See 16.2. (line 3136) +\lg: See 16.3. (line 3559) +\lhd: See 16.2. (line 3139) +\lim: See 16.3. (line 3562) +\liminf: See 16.3. (line 3565) +\limsup: See 16.3. (line 3568) +\line: See 8.18.6. (line 1542) +\linebreak: See 13.8. (line 2662) +\linethickness: See 8.18.7. (line 1557) +\linewidth: See 5.5. (line 721) +\listoffigures: See 23.1. (line 4457) +\listoftables: See 23.1. (line 4457) +\listparindent: See 8.13. (line 1278) +\ll: See 16.2. (line 3142) +\ln: See 16.3. (line 3571) +\lnot: See 16.2. (line 3145) +\location: See 24.5. (line 4625) +\log: See 16.3. (line 3574) +\longleftarrow: See 16.2. (line 3148) +\longleftrightarrow: See 16.2. (line 3151) +\longmapsto: See 16.2. (line 3154) +\longrightarrow: See 16.2. (line 3157) +\lor: See 16.2. (line 3160) +\lq: See 21.2. (line 4241) +\makebox: See 20.4. (line 4063) +\makebox (picture): See 8.18.2. (line 1481) +\makeglossary: See 23.2. (line 4513) +\makeindex: See 23.3. (line 4528) +\makelabels: See 24.6. (line 4633) +\maketitle: See 18.1. (line 3773) +\mapsto: See 16.2. (line 3163) +\marginpar: See 15.4. (line 2771) +\marginparpush: See 15.4. (line 2800) +\marginparsep: See 15.4. (line 2804) +\marginparwidth: See 15.4. (line 2808) +\markboth{LEFT}{RIGHT}: See 18.3. (line 3848) +\markright{RIGHT}: See 18.3. (line 3855) +\mathbf: See 4.1. (line 474) +\mathcal: See 4.1. (line 490) +\mathnormal: See 4.1. (line 487) +\mathrm: See 4.1. (line 471) +\mathsf: See 4.1. (line 477) +\mathtt: See 4.1. (line 480) +\mathversion: See 4.1. (line 492) +\max: See 16.3. (line 3577) +\mbox: See 20.1. (line 4025) +\mdseries: See 4.1. (line 447) +\medskip: See 19.10. (line 3985) +\medskipamount: See 19.10. (line 3985) +\mho: See 16.2. (line 3166) +\mid: See 16.2. (line 3168) +\min: See 16.3. (line 3580) +\models: See 16.2. (line 3171) +\month: See 11.8. (line 2507) +\mp: See 16.2. (line 3174) +\mu: See 16.2. (line 3177) +\multicolumn: See 8.23.1. (line 1921) +\multiput: See 8.18.10. (line 1581) +\nabla: See 16.2. (line 3180) +\name: See 24.7. (line 4641) +\natural: See 16.2. (line 3183) +\ne: See 16.2. (line 3186) +\nearrow: See 16.2. (line 3189) +\neg: See 16.2. (line 3192) +\neq: See 16.2. (line 3195) +\newcommand: See 10.1. (line 2231) +\newcounter: See 10.2. (line 2264) +\newenvironment: See 10.5. (line 2304) +\newfont: See 10.7. (line 2369) +\newlength: See 10.3. (line 2279) +\NEWLINE: See 19.3. (line 3904) +\newline: See 13.3. (line 2609) +\newpage: See 14.3. (line 2700) +\newsavebox: See 10.4. (line 2294) +\newtheorem: See 10.6. (line 2340) +\ni: See 16.2. (line 3198) +\nocite: See 8.24.3. (line 2027) +\nofiles: See 23.1. (line 4461) +\noindent: See 15.2. (line 2758) +\nolinebreak: See 13.8. (line 2662) +\nonumber: See 8.8. (line 1079) +\nopagebreak: See 14.5. (line 2721) +\normalfont: See 4.1. (line 468) +\normalmarginpar: See 15.4. (line 2788) +\normalsize: See 4.2. (line 537) +\not: See 16.2. (line 3201) +\notin: See 16.2. (line 3204) +\nu: See 16.2. (line 3207) +\nwarrow: See 16.2. (line 3210) +\O (/O): See 21.4. (line 4345) +\o (/o): See 21.4. (line 4345) +\obeycr: See 13.2. (line 2600) +\oddsidemargin: See 3.1. (line 385) +\odot: See 16.2. (line 3213) +\OE (OE): See 21.4. (line 4349) +\oe (oe): See 21.4. (line 4349) +\oint: See 16.2. (line 3216) +\omega: See 16.2. (line 3222) +\Omega: See 16.2. (line 3219) +\ominus: See 16.2. (line 3225) +\onecolumn: See 5.1. (line 639) +\opening: See 24.8. (line 4649) +\oplus: See 16.2. (line 3228) +\oslash: See 16.2. (line 3231) +\otimes: See 16.2. (line 3234) +\oval: See 8.18.11. (line 1591) +\overbrace{TEXT}: See 16.6. (line 3698) +\overline{TEXT}: See 16.6. (line 3702) +\owns: See 16.2. (line 3237) +\P: See 21.2. (line 4244) +\pagebreak: See 14.5. (line 2721) +\pagenumbering: See 18.2. (line 3800) +\pageref: See 7.2. (line 849) +\pagestyle: See 18.3. (line 3824) +\paragraph: See 6. (line 769) +\parallel: See 16.2. (line 3240) +\parbox: See 20.5. (line 4091) +\parindent <1>: See 15.1. (line 2747) +\parindent: See 8.17. (line 1387) +\parsep: See 8.13. (line 1297) +\parskip: See 15.3. (line 2765) +\parskip example: See 8.13. (line 1320) +\part: See 6. (line 758) +\partial: See 16.2. (line 3243) +\partopsep: See 8.13. (line 1307) +\perp: See 16.2. (line 3246) +\phi: See 16.2. (line 3249) +\pi: See 16.2. (line 3255) +\Pi: See 16.2. (line 3252) +\pm: See 16.2. (line 3258) +\pmod: See 16.3. (line 3583) +\poptabs: See 8.21. (line 1753) +\pounds: See 21.2. (line 4247) +\Pr: See 16.3. (line 3586) +\prec: See 16.2. (line 3261) +\preceq: See 16.2. (line 3264) +\prime: See 16.2. (line 3267) +\prod: See 16.2. (line 3270) +\propto: See 16.2. (line 3273) +\protect: See 10.8. (line 2383) +\ps: See 24.9. (line 4662) +\psi: See 16.2. (line 3279) +\Psi: See 16.2. (line 3276) +\pushtabs: See 8.21. (line 1756) +\put: See 8.18.12. (line 1618) +\raggedbottom: See 5.4. (line 700) +\raggedleft: See 8.12.1. (line 1210) +\raggedright: See 8.11.1. (line 1184) +\raisebox: See 20.6. (line 4135) +\rangle: See 16.2. (line 3282) +\rbrace: See 16.2. (line 3285) +\rbrack: See 16.2. (line 3288) +\rceil: See 16.2. (line 3291) +\Re: See 16.2. (line 3294) +\ref: See 7.3. (line 859) +\refstepcounter: See 11.6. (line 2494) +\renewenvironment: See 10.5. (line 2304) +\restorecr: See 13.2. (line 2600) +\reversemarginpar: See 15.4. (line 2788) +\rfloor: See 16.2. (line 3297) +\rhd: See 16.2. (line 3300) +\rho: See 16.2. (line 3303) +\right: See 16.6. (line 3694) +\rightarrow: See 16.2. (line 3309) +\Rightarrow: See 16.2. (line 3306) +\rightharpoondown: See 16.2. (line 3312) +\rightharpoonup: See 16.2. (line 3315) +\rightleftharpoons: See 16.2. (line 3318) +\rightmargin: See 8.13. (line 1282) +\rm: See 4.1. (line 513) +\rmfamily: See 4.1. (line 438) +\roman: See 11.1. (line 2433) +\rq: See 21.2. (line 4250) +\rule: See 21.5. (line 4358) +\S: See 21.2. (line 4253) +\savebox: See 20.7. (line 4151) +\sbox: See 20.8. (line 4163) +\sc: See 4.1. (line 516) +\scriptsize: See 4.2. (line 537) +\scshape: See 4.1. (line 462) +\searrow: See 16.2. (line 3321) +\sec: See 16.3. (line 3589) +\section: See 6. (line 763) +\selectfont: See 4.3. (line 623) +\setcounter: See 11.4. (line 2478) +\setlength: See 12.1. (line 2524) +\setminus: See 16.2. (line 3324) +\settodepth: See 12.3. (line 2537) +\settoheight: See 12.4. (line 2545) +\settowidth: See 12.5. (line 2553) +\sf: See 4.1. (line 519) +\sffamily: See 4.1. (line 459) +\sharp: See 16.2. (line 3327) +\shortstack: See 8.18.13. (line 1626) +\sigma: See 16.2. (line 3333) +\Sigma: See 16.2. (line 3330) +\signature: See 24.10. (line 4668) +\sim: See 16.2. (line 3336) +\simeq: See 16.2. (line 3339) +\sin: See 16.3. (line 3592) +\sinh: See 16.3. (line 3595) +\sl: See 4.1. (line 522) +\slshape: See 4.1. (line 456) +\small: See 4.2. (line 537) +\smallint: See 16.2. (line 3342) +\smallskip: See 19.10. (line 3989) +\smallskipamount: See 19.10. (line 3989) +\smile: See 16.2. (line 3345) +\SPACE: See 19.3. (line 3904) +\spadesuit: See 16.2. (line 3348) +\sqcap: See 16.2. (line 3351) +\sqcup: See 16.2. (line 3354) +\sqrt[ROOT]{arg}: See 16.6. (line 3705) +\sqsubset: See 16.2. (line 3357) +\sqsubseteq: See 16.2. (line 3360) +\sqsupset: See 16.2. (line 3363) +\sqsupseteq: See 16.2. (line 3366) +\ss (ss): See 21.4. (line 4352) +\stackrel{TEXT}{RELATION}: See 16.6. (line 3711) +\star: See 16.2. (line 3369) +\startbreaks: See 24.11. (line 4674) +\stepcounter: See 11.7. (line 2501) +\stop: See 26. (line 4738) +\stopbreaks: See 24.12. (line 4681) +\subparagraph: See 6. (line 771) +\subsection: See 6. (line 765) +\subset: See 16.2. (line 3372) +\subseteq: See 16.2. (line 3375) +\subsubsection: See 6. (line 767) +\succ: See 16.2. (line 3378) +\succeq: See 16.2. (line 3381) +\sum: See 16.2. (line 3384) +\sup: See 16.3. (line 3598) +\supset: See 16.2. (line 3387) +\supseteq: See 16.2. (line 3390) +\surd: See 16.2. (line 3393) +\swarrow: See 16.2. (line 3396) +\symbol: See 21.1. (line 4210) +\t (tie-after accent): See 21.3. (line 4316) +\TAB: See 19.3. (line 3904) +\tabbingsep: See 8.21. (line 1761) +\tabcolsep: See 8.23. (line 1912) +\tableofcontents: See 23.1. (line 4447) +\tan: See 16.3. (line 3601) +\tanh: See 16.3. (line 3604) +\tau: See 16.2. (line 3399) +\telephone: See 24.13. (line 4688) +\TeX: See 21.2. (line 4256) +\textbf: See 4.1. (line 450) +\textfloatsep: See 8.10. (line 1154) +\textfraction: See 8.10. (line 1158) +\textheight: See 5.5. (line 727) +\textit: See 4.1. (line 441) +\textmd: See 4.1. (line 447) +\textnormal: See 4.1. (line 468) +\textrm: See 4.1. (line 438) +\textsc: See 4.1. (line 462) +\textsf: See 4.1. (line 459) +\textsl: See 4.1. (line 456) +\texttt: See 4.1. (line 465) +\textup: See 4.1. (line 453) +\textwidth: See 5.5. (line 734) +\thanks{TEXT}: See 18.1. (line 3788) +\theta: See 16.2. (line 3402) +\thicklines: See 8.18.8. (line 1567) +\thinlines: See 8.18.9. (line 1574) +\thinspace: See 19.5. (line 3929) +\thispagestyle: See 18.4. (line 3862) +\tilde: See 16.4. (line 3642) +\times: See 16.2. (line 3405) +\tiny: See 4.2. (line 537) +\title{TEXT}: See 18.1. (line 3792) +\to: See 16.2. (line 3408) +\today: See 21.6. (line 4377) +\top: See 16.2. (line 3411) +\topfraction: See 8.10. (line 1163) +\topmargin: See 5.5. (line 740) +\topsep: See 8.13. (line 1301) +\topskip: See 5.5. (line 747) +\totalheight: See 12.6. (line 2565) +\triangle: See 16.2. (line 3414) +\triangleleft: See 16.2. (line 3417) +\triangleright: See 16.2. (line 3420) +\tt: See 4.1. (line 525) +\ttfamily: See 4.1. (line 465) +\twocolumn: See 5.2. (line 645) +\typein: See 25.1. (line 4699) +\typeout: See 25.2. (line 4713) +\u (breve accent): See 21.3. (line 4319) +\unboldmath: See 16. (line 2843) +\underbrace{math}: See 16.6. (line 3715) +\underline{text}: See 16.6. (line 3718) +\unitlength: See 8.18. (line 1408) +\unlhd: See 16.2. (line 3423) +\unrhd: See 16.2. (line 3426) +\uparrow: See 16.2. (line 3432) +\Uparrow: See 16.2. (line 3429) +\updownarrow: See 16.2. (line 3438) +\Updownarrow: See 16.2. (line 3435) +\uplus: See 16.2. (line 3441) +\upshape: See 4.1. (line 453) +\upsilon: See 16.2. (line 3447) +\Upsilon: See 16.2. (line 3444) +\usebox: See 20.9. (line 4175) +\usecounter: See 11.2. (line 2453) +\usefont: See 4.3. (line 627) +\usepackage: See 3.1. (line 404) +\v (breve accent): See 21.3. (line 4322) +\value: See 11.3. (line 2464) +\varepsilon: See 16.2. (line 3450) +\varphi: See 16.2. (line 3453) +\varpi: See 16.2. (line 3456) +\varrho: See 16.2. (line 3459) +\varsigma: See 16.2. (line 3462) +\vartheta: See 16.2. (line 3465) +\vdash: See 16.2. (line 3468) +\vdots: See 16.6. (line 3722) +\vec: See 16.4. (line 3645) +\vector: See 8.18.14. (line 1647) +\vee: See 16.2. (line 3471) +\verb: See 8.27.1. (line 2122) +\vert: See 16.2. (line 3477) +\Vert: See 16.2. (line 3474) +\vfill: See 19.11. (line 3998) +\vline: See 8.23.4. (line 1962) +\vspace: See 19.12. (line 4005) +\wedge: See 16.2. (line 3480) +\widehat: See 16.4. (line 3648) +\width: See 12.6. (line 2559) +\wp: See 16.2. (line 3483) +\wr: See 16.2. (line 3486) +\xi: See 16.2. (line 3492) +\Xi: See 16.2. (line 3489) +\year: See 11.8. (line 2507) +\zeta: See 16.2. (line 3495) +\{: See 21.1. (line 4196) +\|: See 16.2. (line 2870) +\}: See 21.1. (line 4196) +\~: See 21.1. (line 4206) +\~ (tilde accent): See 21.3. (line 4291) +^: See 16.1. (line 2856) +_: See 16.1. (line 2856) +a4paper option: See 3.1. (line 349) +a5paper option: See 3.1. (line 349) +abstract environment: See 8.1. (line 881) +array environment: See 8.2. (line 892) +article class: See 3. (line 326) +b5paper option: See 3.1. (line 349) +book class: See 3. (line 326) +center environment: See 8.3. (line 939) +description environment: See 8.4. (line 976) +displaymath environment <1>: See 16. (line 2818) +displaymath environment: See 8.5. (line 999) +document environment: See 8.6. (line 1018) +draft option: See 3.1. (line 354) +enumerate environment: See 8.7. (line 1024) +eqnarray environment: See 8.8. (line 1065) +equation environment <1>: See 16. (line 2818) +equation environment: See 8.9. (line 1091) +executivepaper option: See 3.1. (line 349) +figure: See 8.10. (line 1104) +final option: See 3.1. (line 354) +fleqn option: See 3.1. (line 354) +flushleft environment: See 8.11. (line 1171) +flushright environment: See 8.12. (line 1197) +itemize environment: See 8.13. (line 1223) +landscape option: See 3.1. (line 354) +legalpaper option: See 3.1. (line 349) +leqno option: See 3.1. (line 354) +letter: See 8.14. (line 1336) +letter class: See 3. (line 326) +letterpaper option: See 3.1. (line 349) +list: See 8.15. (line 1341) +lR box: See 8.18. (line 1460) +lrbox: See 20.3. (line 4053) +math environment <1>: See 16. (line 2818) +math environment: See 8.16. (line 1363) +minipage environment: See 8.17. (line 1375) +notitlepage option: See 3.1. (line 354) +onecolumn option: See 3.1. (line 379) +oneside option: See 3.1. (line 379) +openany option: See 3.1. (line 379) +openbib option: See 3.1. (line 354) +openright option: See 3.1. (line 379) +picture: See 8.18. (line 1404) +quotation: See 8.19. (line 1658) +quote: See 8.20. (line 1673) +report class: See 3. (line 326) +slides class: See 3. (line 326) +tabbing environment: See 8.21. (line 1688) +table: See 8.22. (line 1780) +tabular environment: See 8.23. (line 1816) +thebibliography: See 8.24. (line 1970) +theorem environment: See 8.25. (line 2075) +titlepage environment: See 8.26. (line 2088) +titlepage option: See 3.1. (line 354) +twocolumn option: See 3.1. (line 379) +twoside option: See 3.1. (line 379) +verbatim environment: See 8.27. (line 2105) +verse environment: See 8.28. (line 2139) 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: +--> diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ltx-help.el b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ltx-help.el new file mode 100644 index 00000000000..89175d29637 --- /dev/null +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/ltx-help.el @@ -0,0 +1,270 @@ +;;; ltx-help.el --- Lookup latex commands in info pages. + +;; Author: Peter Galbraith <rhogee@bathybius.meteo.mcgill.ca> or <galbrth@ac.dal.ca> +;; Christian Lynbech <lynbech@daimi.aau.dk> +;; Martin Sjolin <marsj@ida.liu.se> +;; Boris Goldowsky <boris@cs.rochester.edu> +;; Maintainer: Torsten Martinsen <bullestock@dk-online.dk> +;; Updated: 12 June 2008 +;; Keywords: help, latex, info + + +;;; Commentary: + +;; Use the function latex-help to look up a latex command or +;; environment in the latex online manual. If point is at such a +;; command, this will be the default. + +;; Installation: +;; +;; Add the following piece of code to your .emacs +;; +;; (define-key help-map "\C-l" 'latex-help) +;; +;; to bind latex-help to C-h C-l. To load latex-help when loading AUC-TeX or +;; some other LaTeX/TeX mode and bind the it to C-C i key, add the the following +;; to you .emacs: +;; +;; (add-hook 'Latex-mode-hook +;; (function (lambda () +;; (define-key LaTeX-mode-map "\C-ci" 'latex-help)))) +;; +;; or if you do not have add-hook (a very nice package): +;; +;; (setq Latex-mode-hook +;; (function (lambda () +;; (define-key LaTeX-mode-map "\C-ci" 'latex-help)))) +;; +;; + +;; The info document that this code works with is at +;; http://ctan.org/get/info/latex2e-help-texinfo. + +;;; Change Log: + +;;Mar 4, 1994 <lynbech@daimi.aau.dk>: +;; Changed to my personal preferences. I have changed the function +;; names. I have changed it to take a parameter, rather than just +;; taking the current word. I am also basing it on the index rather +;; than the node names. +;; +;;Mar 10, 1994 <marsj@ida.liu.se>: +;; Added definition of current-word if not present. +;; Made default value pick up a leading \ if apropriate +;; +;;Mar 11, 1994 <lynbech@daimi.aau.dk>: +;; Changed the name of current-word into latex-help-guess. This +;; eliminates the need for the embedded defun. +;; Also made describe-latex work more like describe-function in its +;; way of using default values. Now you must press return at an +;; empty prompt to get the listed default (if any). +;; +;;Mar 10, 1994 <marsj@ida.liu.se>: +;; Rewrote part of the describe-latex command to use the prefix +;; argument, changed latex-help-get-cmd-obarray to return the +;; the new array and test if it is empty or not. Add information +;; concerning where to find the latex.texi file and emacs 18 info.el +;; +;;Mar 28, 1994 <boris@cs.rochester.edu>: +;; * rewrote describe-latex's command-reading code; it did not +;; default correctly on my system. +;; * Added latex-help-hist, for completion history. +;; * Modified it to use show-temp-buffer, if defined, so that it will +;; display the help buffer in accord with user preferences. +;; * Renamed describe-latex to latex-help, for consistency with other names. +;; * Removed unneeded (interactive) specs for latex-help-guess and +;; latex-help-get-cmd-obarray. +;; * Added autoload cookies. +;; * Doc fix. +;; +;;Mar 29, 1994 <marsj@ida.liu.se>: +;; * made it working under epoch/emacs-18 by calling +;; completion-read without the last argument. +;; * made prompting similar to emacs help +;; * moved add-hook and define keys to installation section, since +;; the settings conflict with my own keybindings. Also, the key +;; binding should be chosen by the end user. +;; +;; Wed Mar 30 08:45:50 1994 LYNBECH +;; * Changed file layout to conform to FSF's standards +;; * Tweaked latex-help-guess to include any leading backslashes +;; * Inversed the meaning of the prefix argument. Now default is +;; to switch buffers. Also added new variable `latex-help-split-window' +;; to allow window splitting always. +;; * Minor doc fixes +;; +;; Wed Apr 6 08:34:08 1994 LYNBECH +;; * fixed latex-help-guess to be more faithful to the lexical rules +;; of TeX. The result is not especially elegant. +;; +;;Apr 16, 1994 <abraham@iesd.auc.dk>: +;; Changed the name to `ltx-help.el'. +;; +;; Sat Apr 1 1995 Torsten Martinsen (torsten@kom.auc.dk) +;; Changed obarray to an alist where the car of each cons cell is the +;; command name, and the cdr is the Info node describing that +;; command. This implementation has the following advantages: +;; - we don't need to have a lot of small redundant Info nodes; instead, +;; we can use the Texinfo function index mechanism. +;; - the alist is dynamically sized, so this version will work regardless +;; of how many LaTeX commands the Info file contains. +;; Added info on LaTeX2e Info file. +;; +;; Mon Apr 15 1996 Torsten Martinsen (bullestock@dk-online.dk) +;; Changed node 'List of Commands' to 'Command Index' as suggested by +;; Ralf Fassel <ralf@natlab.research.philips.com>. +;; +;; Mon Apr 22 1996 Torsten Martinsen (bullestock@dk-online.dk) +;; When running under FSF Emacs, use (buffer-substring-no-properties) +;; instead of (buffer-substring) as suggested by Kurt Hornik +;; <hornik@ci.tuwien.ac.at>. Also removed Emacs 18 support. +;; +;; Thu Jun 12 2008 Karl Berry (karl@freefriends.org) +;; Change latex-help-file to "(latex2e)", so our names are consistent. +;; Doc updates. +;; +;;; Code: + +(require 'info) + +(if (string-match "XEmacs\\|Lucid" emacs-version) + ; XEmacs + (fset 'ltxh-buffer-substring (symbol-function 'buffer-substring)) + ; FSFmacs + (fset 'ltxh-buffer-substring (symbol-function 'buffer-substring-no-properties))) + +(defvar latex-help-file "(latex2e)") + +(defvar latex-help-split-window nil + "*When this is non-nil, `latex-help' will always pop up the info +buffer, rather than just switch to it.") + +(defvar latex-help-hist nil + "History for latex command help") + +(defconst latex-help-cmd-alist nil + "Alist of the commands in the index of the latex info manual, +used for validation and completion.") + +;;;###autoload +(defun latex-help (cmd split) + "Try to find info entry about LaTeX entity CMD. +CMD may be either a command or an environment. +If CMD is not a string, this function will prompt for it, eventually +with completion. If SPLIT (prefix arg.) is non-nil, latex-help will +pop up the Info buffer, rather than just switch to it. See also +variable `latex-help-split-window'." + (interactive + (list + (let* ((cw (latex-help-guess)) + (cww (concat "\\" cw)) + (cmd-alist (latex-help-get-cmd-alist)) + (guess (cond ((try-completion cw cmd-alist) cw) + ((try-completion cww cmd-alist) cww) + (t nil))) + (val (completing-read (if guess + (format "Describe LaTeX command (default %s): " guess) + "Describe LaTeX command: ") + cmd-alist nil t nil + 'latex-help-hist))) + (cdr (assoc (if (equal val "") + guess + val) cmd-alist))) + current-prefix-arg)) + (if (not (or split latex-help-split-window)) + (Info-goto-node (concat latex-help-file cmd)) + (save-excursion + (let ((pop-up-windows t) + (buffer (current-buffer))) + (pop-to-buffer nil) + (Info-goto-node (concat latex-help-file cmd)) + (if (fboundp 'show-temp-buffer) + (show-temp-buffer (current-buffer) t) + (pop-to-buffer buffer)))))) + +(defun latex-help-guess () + "Return the word point is on as a string, if it's between two +word-constituent characters. If not, but it immediately follows one, +move back first. Otherwise, if point precedes a word constituent, +move forward first. Otherwise, move backwards until a word constituent +is found and get that word; if you reach a newline first, move forward +instead. + +This function has been tweaked to deal better with latex commands. + +Return the LaTeX command point is on as a string. +" + ;; cl: I am not claiming this to be neither elegant nor fast. + (save-excursion + (let ((oldpoint (point)) (start (point)) (end (point)) + (wc "A-Za-z") (nwc "^A-Za-z")) + + (cond + ((looking-at "\\\\[^A-Za-z]") + (setq start (point) + end (+ 2 (point)))) + + ((looking-at "\\\\[A-Za-z]+") + (setq start (match-beginning 0) + end (match-end 0))) + + (t + (skip-chars-backward wc) + (skip-chars-backward "\\\\" (1- (point))) + (setq start (point)) + + (goto-char oldpoint) + + (skip-chars-forward "\\\\" (1+ (point))) + (skip-chars-forward wc) + (setq end (point)) + + (if (and (eq start oldpoint) (eq end oldpoint)) + (progn + (skip-chars-backward nwc + (save-excursion (beginning-of-line) (point))) + (if (eq (preceding-char) ?\n) + (progn + (skip-chars-forward nwc) + (setq start (point)) + (skip-chars-forward "\\\\" (1+ (point))) + (skip-chars-forward wc) + (setq end (point))) + (setq end (point)) + (skip-chars-backward wc) + (skip-chars-backward "\\\\" (1- (point))) + (setq start (point))))) + ) + ) + (ltxh-buffer-substring start end))) + ) + +(defun latex-help-get-cmd-alist () + "Scoop up the commands in the index of the latex info manual. +The values are saved in `latex-help-cmd-alist' for speed." + ;; mm, does it contain any cached entries + (if (not (assoc "\\begin" latex-help-cmd-alist)) + (save-window-excursion + (setq latex-help-cmd-alist nil) + (Info-goto-node (concat latex-help-file "Command Index")) + (if (search-forward "::" nil t) + (progn + (end-of-buffer) + (while (re-search-backward "^\\* \\(.+\\)::$" nil t) + (setq key (ltxh-buffer-substring (match-beginning 1) (match-end 1))) + (setq latex-help-cmd-alist + (cons (cons key key) latex-help-cmd-alist)))) + (end-of-buffer) + (while (re-search-backward "^\\* \\(.+\\): *\\(.+\\)\\.$" nil t) + (setq key (ltxh-buffer-substring (match-beginning 1) (match-end 1))) + (setq value (ltxh-buffer-substring (match-beginning 2) (match-end 2))) + (setq latex-help-cmd-alist + (cons (cons key value) latex-help-cmd-alist)))) + )) + ;; and return the alist. + latex-help-cmd-alist + ) + +(provide 'ltx-help) + +;;; ltx-help.el ends here |