diff options
| author | Karl Berry <karl@freefriends.org> | 2012-05-13 22:58:34 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2012-05-13 22:58:34 +0000 |
| commit | a74c16d06af04f22a53debd1a1ef211416c3a6f6 (patch) | |
| tree | 0cbb1892377354b7b04acd3a18df9581343b6152 /Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk | |
| parent | 54881f89f5ade7bdb55ea7c8d36a62d3860856b4 (diff) | |
latex2e-help-texinfo (11may12)
git-svn-id: svn://tug.org/texlive/trunk@26333 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk')
| -rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk | 5079 |
1 files changed, 2976 insertions, 2103 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk index 7dcf8aa18db..6d42c9c12d1 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk @@ -3,49 +3,46 @@ <!ENTITY tex "TeX"> <!ENTITY latex "LaTeX"> ]> -<book id="latex2e.xml" lang="en"> -<title>@LaTeX{}2e reference manual (May 2011)</title> +<book id="latex2e.dbk" lang="en"> +<title>&latex;2e reference manual (May 2012)</title> <!-- %**end of header (This is for running Texinfo on a region.) --> -<!-- xx latex 2.09 commands should all be present now, --> +<!-- latex 2.09 commands should all be present now, --> <!-- xx but latex2e stuff is missing. --> -<!-- --> -<!-- xx mention \mathring --> -<!-- xx mention usrguide --> -<!-- xx mention ! float placement, p.15 of usrguide --> -<!-- xx merge http://ctan.org/tex-archive/info/latex-info/ --> -<!-- xx merged permuted-index --> -<!-- --> -<!-- xx The typeset source2e will have an index with all kernel --> -<!-- xx commands, which would be a good start. classes.dtx et al. --> -<!-- xx define additional commands, and some of the kernel commands are --> -<!-- xx internal and so shouldn't be included here. --> -<!-- --> +<!-- --> +<!-- xx mention \oldstylenums (comes from where?) --> +<!-- xx mention \topnumber, \bottomnumber, \totalnumber --> +<!-- --> +<!-- xx merge http://ctan.org/tex-archive/info/latex-info/ (alt-latex-info) --> +<!-- xx merge permuted-index --> +<!-- --> +<!-- xx The typeset source2e has an index with all kernel --> +<!-- xx commands, though some are internal and shouldn't be included. --> +<!-- xx classes.dtx et al. define additional commands. --> +<!-- --> <!-- xx packages - required, additional, useful; oberdiek ... --> <!-- xx fonts - latexsys --> -<bookinfo> -<legalnotice> -<para>This document is an unofficial reference manual for &latex;, a -document preparation system, version of May 2011. +<bookinfo><legalnotice><para>This document is an unofficial reference manual for &latex;, a +document preparation system, version of May 2012. </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 +<para>This manual was originally translated from <filename>LATEX.HLP</filename> v1.0a in +the VMS Help Library. The pre-translation version was written by +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>&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 (no text was directly copied). </para> -<para>Copyright © 2007, 2008, 2009, 2010, 2011 Karl Berry. +<para>Copyright © 2007, 2008, 2009, 2010, 2011, 2012 Karl Berry. -Copyright © 1988, 1994, 2007 Stephen Gilmore. +Copyright © 1988, 1994, 2007 Stephen Gilmore. -Copyright © 1994, 1995, 1996 Torsten Martinsen. +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 @@ -59,21 +56,50 @@ 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> +</para></legalnotice></bookinfo> + -* Menu: -* LaTeX2e: (latex2e). Unofficial LaTeX reference manual. +<para>This document is an unofficial reference manual for &latex;, a +document preparation system, version of May 2012. +</para> +<para>This manual was originally translated from <filename>LATEX.HLP</filename> v1.0a in +the VMS Help Library. The pre-translation version was written by +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 (no text was +directly copied). +</para> +<para>Copyright © 2007, 2008, 2009, 2010, 2011, 2012 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> -<chapter label="" xreflabel="&latex;2e" id="Top"> +<chapter label="" id="Top"> <title>&latex;2e</title> <para>This document is an unofficial reference manual for &latex;, a -document preparation system, version as of May 2011. It is +document preparation system, version as of May 2012. It is intended to cover &latex;2e, which has been the standard version of &latex; for many years. </para> @@ -81,16 +107,22 @@ intended to cover &latex;2e, which has been the standard version of </chapter> <chapter label="1" id="About-this-document"> -<title>Overview of &latex;</title> +<title>About this document</title> -<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><para>The &latex; document preparation system is implemented as a macro -package for Donald E. Knuth's &tex; typesetting program. +<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> +<para>The &latex; document preparation system 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 from their web site. </para> -<indexterm role="cp"><primary>bug reporting</primary></indexterm><indexterm role="cp"><primary>reporting bugs</primary></indexterm><indexterm role="fn"><primary><email>latexrefman-discuss@gna.org</email> email address</primary></indexterm><para>The present document is completely unofficial and has not been +<indexterm role="cp"><primary>bug reporting</primary></indexterm> +<indexterm role="cp"><primary>reporting bugs</primary></indexterm> +<indexterm role="fn"><primary><email>latexrefman-discuss@gna.org</email> <lineannotation>email address</lineannotation></primary></indexterm> +<para>The present document is completely unofficial and has not been reviewed by the &latex; maintainers. Do not send bug reports or anything else about this document to them. Instead, please send all comments to <email>latexrefman-discuss@gna.org</email>. @@ -100,6 +132,22 @@ comments to <email>latexrefman-discuss@gna.org</email>. current output in various formats, sources, mailing lists, and other infrastructure. </para> +<para>Of course, there are many, many other sources of information about +&latex;. Here are a few: +</para> +<variablelist><varlistentry><term> +</term><listitem><para>Two pages of recommended references to &latex; documentation. +</para> +</listitem></varlistentry><varlistentry><term> +</term><listitem><para>Writing your first document, with a bit of both text and math. +</para> +</listitem></varlistentry><varlistentry><term> +</term><listitem><para>The guide for document authors maintained as part of &latex;; there +are several others. +</para> +</listitem></varlistentry><varlistentry><term> +</term><listitem><para>Introduction to the &tex; system, including &latex;. +</para></listitem></varlistentry></variablelist> </chapter> <chapter label="2" id="Overview"> @@ -107,72 +155,88 @@ infrastructure. <para>What is &latex;? </para> -<indexterm role="cp"><primary>overview of &latex;</primary></indexterm><indexterm role="cp"><primary>basics of &latex;</primary></indexterm><indexterm role="cp"><primary>&latex; overview</primary></indexterm><para>&latex; typesets a file of text using the &tex; program and the -&latex; “macro package” for &tex;. That is, it processes an input +<indexterm role="cp"><primary>overview of &latex;</primary></indexterm> +<indexterm role="cp"><primary>basics of &latex;</primary></indexterm> +<indexterm role="cp"><primary>&latex; overview</primary></indexterm> +<para>&latex; typesets a file of text using the &tex; program and the +&latex; “macro package” for &tex;. That is, it processes an input file containing the text of a document with interspersed commands that describe how the text should be formatted. &latex; files are plain text that can be written in any reasonable editor. It produces at least three files as output: </para> -<orderedlist numeration="arabic"><listitem> -<para>The main output file, which is one of: +<orderedlist numeration="arabic"><listitem><para>The main output file, which is one of: </para> -<variablelist><varlistentry><term><literal>.dvi</literal></term> -<listitem><indexterm role="fn"><primary>.dvi file</primary></indexterm><indexterm role="fn"><primary>latex command</primary></indexterm><para>If invoked as <command>latex</command>, a “Device Independent” (<filename>.dvi</filename>) +<variablelist><varlistentry><term><literal>.dvi</literal> +</term><listitem><indexterm role="fn"><primary>.dvi <lineannotation>file</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>latex <lineannotation>command</lineannotation></primary></indexterm> +<para>If invoked as <command>latex</command>, a “Device Independent” (<filename>.dvi</filename>) file is produced. This contains commands that can be translated into commands for virtually any output device. You can view such <filename>.dvi</filename> output of &latex; by using a program such as <command>xdvi</command> (display directly), <command>dvips</command> (convert to PostScript), or <command>dvipdfmx</command> (convert to PDF). </para> -</listitem></varlistentry><varlistentry><term><literal>.pdf</literal></term> -<listitem><indexterm role="fn"><primary>.pdf file</primary></indexterm><indexterm role="cp"><primary>pdf&tex;</primary></indexterm><indexterm role="fn"><primary>pdflatex command</primary></indexterm><para>If invoked as <command>pdflatex</command>, a “Portable Document Format” +</listitem></varlistentry><varlistentry><term><literal>.pdf</literal> +</term><listitem><indexterm role="fn"><primary>.pdf <lineannotation>file</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>pdf&tex;</primary></indexterm> +<indexterm role="fn"><primary>pdflatex <lineannotation>command</lineannotation></primary></indexterm> +<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> -<indexterm role="fn"><primary>lualatex command</primary></indexterm><indexterm role="cp"><primary>Lua&tex;</primary></indexterm><para>If invoked as <command>lualatex</command>, a <filename>.pdf</filename> file is created using +<indexterm role="fn"><primary>lualatex <lineannotation>command</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>Lua&tex;</primary></indexterm> +<para>If invoked as <command>lualatex</command>, a <filename>.pdf</filename> file is created using the Lua&tex; engine (<ulink url="http://luatex.org">http://luatex.org</ulink>). </para> -<indexterm role="fn"><primary>xelatex command</primary></indexterm><indexterm role="cp"><primary>Xe&tex;</primary></indexterm><para>If invoked as <command>xelatex</command>, a <filename>.pdf</filename> file is created using +<indexterm role="fn"><primary>xelatex <lineannotation>command</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>Xe&tex;</primary></indexterm> +<para>If invoked as <command>xelatex</command>, a <filename>.pdf</filename> file is created using the Xe&tex; engine (<ulink url="http://tug.org/xetex">http://tug.org/xetex</ulink>). </para> </listitem></varlistentry></variablelist> - <para>Many other less-common variants of &latex; (and &tex;) exist, which can produce HTML, XML, and other things. </para> -</listitem> -<listitem> -<indexterm role="cp"><primary>transcript file</primary></indexterm><indexterm role="cp"><primary>log file</primary></indexterm><indexterm role="fn"><primary>.log file</primary></indexterm><para>The “transcript” or <filename>.log</filename> file that contains summary +</listitem><listitem><indexterm role="cp"><primary>transcript file</primary></indexterm> +<indexterm role="cp"><primary>log file</primary></indexterm> +<indexterm role="fn"><primary>.log <lineannotation>file</lineannotation></primary></indexterm> +<para>The “transcript” or <filename>.log</filename> file that contains summary information and diagnostic messages for any errors discovered in the input file. </para> -</listitem> -<listitem> -<indexterm role="cp"><primary>auxiliary file</primary></indexterm><indexterm role="fn"><primary>.aux file</primary></indexterm><para>An “auxiliary” or <filename>.aux</filename> file. This is used by &latex; itself, +</listitem><listitem><indexterm role="cp"><primary>auxiliary file</primary></indexterm> +<indexterm role="fn"><primary>.aux <lineannotation>file</lineannotation></primary></indexterm> +<para>An “auxiliary” or <filename>.aux</filename> file. This is used by &latex; itself, for things such as cross-references. -</para></listitem> -</orderedlist> -<para>An open-ended list of other files might be created. We won't try to +</para></listitem></orderedlist> +<para>An open-ended list of other files might be created. We won’t try to list them all. Xxx components? </para> -<indexterm role="fn"><primary>\ character starting commands</primary></indexterm><indexterm role="fn"><primary>[...] for optional arguments</primary></indexterm><indexterm role="fn"><primary>{...} for required arguments</primary></indexterm><para>In the &latex; input file, a command name starts with a <literal>\</literal>, -followed by either (a) a string of letters or (b) a single +<indexterm role="fn"><primary>\ <lineannotation>character starting commands</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>[...] <lineannotation>for optional arguments</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>{...} <lineannotation>for required arguments</lineannotation></primary></indexterm> +<para>In the &latex; input file, a command name starts with 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> -<indexterm role="cp"><primary>case sensitivity of &latex;</primary></indexterm><para>&latex; is case sensitive. Enter all commands in lower case unless +<indexterm role="cp"><primary>case sensitivity of &latex;</primary></indexterm> +<para>&latex; is case sensitive. Enter all commands in lower case unless explicitly directed to do otherwise. </para> </chapter> -<chapter label="3" id="Starting-&-ending"> +<chapter label="3" id="Starting-_0026-ending"> <title>Starting & ending</title> -<indexterm role="cp"><primary>starting & ending</primary></indexterm><indexterm role="cp"><primary>ending & starting</primary></indexterm> +<indexterm role="cp"><primary>starting & ending</primary></indexterm> +<indexterm role="cp"><primary>ending & starting</primary></indexterm> + <para>A minimal input file looks like the following: </para> <screen>\documentclass{<replaceable>class</replaceable>} @@ -181,10 +245,11 @@ explicitly directed to do otherwise. \end{document} </screen> <para>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 +See <link linkend="Document-classes">Document classes</link>, for details of the various document classes available locally. </para> -<indexterm role="cp"><primary>preamble, defined</primary></indexterm><para>You may include other &latex; commands between the <literal>\documentclass</literal> +<indexterm role="cp"><primary>preamble, defined</primary></indexterm> +<para>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> @@ -193,7 +258,10 @@ and the <literal>\begin{document}</literal> commands (this area is called the <chapter label="4" id="Document-classes"> <title>Document classes</title> -<indexterm role="cp"><primary>document classes</primary></indexterm><indexterm role="cp"><primary>classes of documents</primary></indexterm><indexterm role="fn"><primary>\documentclass</primary></indexterm> +<indexterm role="cp"><primary>document classes</primary></indexterm> +<indexterm role="cp"><primary>classes of documents</primary></indexterm> +<indexterm role="fn"><primary>\documentclass</primary></indexterm> + <para>The class of a given document is defined with the command: </para> <screen>\documentclass[<replaceable>options</replaceable>]{<replaceable>class</replaceable>} @@ -201,8 +269,13 @@ and the <literal>\begin{document}</literal> commands (this area is called the <para>The <literal>\documentclass</literal> command must be the first command in a &latex; source file. </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><para>Built-in &latex; document <replaceable>class</replaceable> names are (many other document -classes are available as add-ons; see <xref linkend="Overview"></xref>): +<indexterm role="fn"><primary>article <lineannotation>class</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>report <lineannotation>class</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>book <lineannotation>class</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>letter <lineannotation>class</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>slides <lineannotation>class</lineannotation></primary></indexterm> +<para>Built-in &latex; document <replaceable>class</replaceable> names are (many other document +classes are available as add-ons; see <link linkend="Overview">Overview</link>): </para> <screen>article report book letter slides </screen> @@ -215,7 +288,11 @@ classes are available as add-ons; see <xref linkend="Overview"></xref>): <sect1 label="4.1" id="Document-class-options"> <title>Document class options</title> -<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> +<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> + <para>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 @@ -225,69 +302,98 @@ them with a comma: </screen> <para>Here is the list of the standard class options. </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><para>All of the standard classes except <literal>slides</literal> accept the following +<indexterm role="fn"><primary>10pt <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>11pt <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>12pt <lineannotation>option</lineannotation></primary></indexterm> +<para>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> -<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><para>All of the standard classes accept these options for selecting the paper +<indexterm role="fn"><primary>a4paper <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>a5paper <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>b5paper <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>executivepaper <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>legalpaper <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>letterpaper <lineannotation>option</lineannotation></primary></indexterm> +<para>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> -<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><para>Miscellaneous other options: -</para> -<variablelist><varlistentry><term><literal>draft, final</literal></term> -<listitem><indexterm role="cp"><primary>black boxes, omitting</primary></indexterm><para>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. +<indexterm role="fn"><primary>draft <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>final <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>fleqn <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>landscape <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>leqno <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>openbib <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>titlepage <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>notitlepage <lineannotation>option</lineannotation></primary></indexterm> +<para>Miscellaneous other options: +</para> +<variablelist><varlistentry><term><literal>draft, final</literal> +</term><listitem><indexterm role="cp"><primary>black boxes, omitting</primary></indexterm> +<para>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> -<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><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><indexterm role="fn"><primary>\evensidemargin</primary></indexterm><indexterm role="fn"><primary>\oddsidemargin</primary></indexterm><para>Selects one- or two-sided layout; default is <literal>oneside</literal>, except +<indexterm role="fn"><primary>onecolumn <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>twocolumn <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>oneside <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>twoside <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>openright <lineannotation>option</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>openany <lineannotation>option</lineannotation></primary></indexterm> +<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><indexterm role="fn"><primary>\evensidemargin</primary></indexterm> +<indexterm role="fn"><primary>\oddsidemargin</primary></indexterm> +<para>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 +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 +</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> -<indexterm role="cp"><primary>packages, loading</primary></indexterm><indexterm role="cp"><primary>loading additional packages</primary></indexterm><indexterm role="fn"><primary>\usepackage</primary></indexterm><para>Additional packages are loaded like this: +<indexterm role="cp"><primary>packages, loading</primary></indexterm> +<indexterm role="cp"><primary>loading additional packages</primary></indexterm> +<indexterm role="fn"><primary>\usepackage</primary></indexterm> +<para>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> -<indexterm role="cp"><primary>global options</primary></indexterm><indexterm role="cp"><primary>options, global</primary></indexterm><para>Any options given in the <literal>\documentclass</literal> command that are unknown +<indexterm role="cp"><primary>global options</primary></indexterm> +<indexterm role="cp"><primary>options, global</primary></indexterm> +<para>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> @@ -297,7 +403,9 @@ by the selected document class are passed on to the packages loaded with <chapter label="5" id="Typefaces"> <title>Typefaces</title> -<indexterm role="cp"><primary>typefaces</primary></indexterm><indexterm role="cp"><primary>fonts</primary></indexterm> +<indexterm role="cp"><primary>typefaces</primary></indexterm> +<indexterm role="cp"><primary>fonts</primary></indexterm> + <para>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> @@ -306,69 +414,102 @@ and a style. The &latex; commands for doing this are described here. <sect1 label="5.1" id="Font-styles"> <title>Font styles</title> -<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> +<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> + <para>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>This first group of commands is typically 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><indexterm role="fn"><primary>\textrm</primary></indexterm><indexterm role="fn"><primary>\rmfamily</primary></indexterm><para>Roman. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textit (\itshape)</literal></term> -<listitem><indexterm role="fn"><primary>\textit</primary></indexterm><indexterm role="fn"><primary>\itshape</primary></indexterm><para>Italics. -</para> -</listitem></varlistentry><varlistentry><term><literal>\emph</literal></term> -<listitem><indexterm role="fn"><primary>\emph</primary></indexterm><indexterm role="cp"><primary>emphasis</primary></indexterm><para>Emphasis (switches between <literal>\textit</literal> and <literal>\textrm</literal>). -</para> -</listitem></varlistentry><varlistentry><term><literal>\textmd (\mdseries)</literal></term> -<listitem><indexterm role="fn"><primary>\textmd</primary></indexterm><indexterm role="fn"><primary>\mdseries</primary></indexterm><para>Medium weight (default). -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbf (\bfseries)</literal></term> -<listitem><indexterm role="fn"><primary>\textbf</primary></indexterm><indexterm role="fn"><primary>\bfseries</primary></indexterm><para>Boldface. -</para></listitem></varlistentry><varlistentry><term><literal>\textup (\upshape)</literal></term> -<listitem><indexterm role="fn"><primary>\textup</primary></indexterm><indexterm role="fn"><primary>\upshape</primary></indexterm><para>Upright (default). The opposite of slanted. -</para></listitem></varlistentry><varlistentry><term><literal>\textsl (\slshape)</literal></term> -<listitem><indexterm role="fn"><primary>\textsl</primary></indexterm><indexterm role="fn"><primary>\slshape</primary></indexterm><para>Slanted. -</para></listitem></varlistentry><varlistentry><term><literal>\textsf (\sffamily)</literal></term> -<listitem><indexterm role="fn"><primary>\textsf</primary></indexterm><indexterm role="fn"><primary>\sffamily</primary></indexterm><para>Sans serif. -</para></listitem></varlistentry><varlistentry><term><literal>\textsc (\scshape)</literal></term> -<listitem><indexterm role="fn"><primary>\textsc</primary></indexterm><indexterm role="fn"><primary>\scshape</primary></indexterm><para>Small caps. -</para></listitem></varlistentry><varlistentry><term><literal>\texttt (\ttfamily)</literal></term> -<listitem><indexterm role="fn"><primary>\texttt</primary></indexterm><indexterm role="fn"><primary>\ttfamily</primary></indexterm><para>Typewriter. -</para></listitem></varlistentry><varlistentry><term><literal>\textnormal (\normalfont)</literal></term> -<listitem><indexterm role="fn"><primary>\textnormal</primary></indexterm><indexterm role="fn"><primary>\normalfont</primary></indexterm><para>Main document font. -</para></listitem></varlistentry><varlistentry><term><literal>\mathrm</literal></term> -<listitem><indexterm role="fn"><primary>\mathrm</primary></indexterm><para>Roman, for use in math mode. -</para></listitem></varlistentry><varlistentry><term><literal>\mathbf</literal></term> -<listitem><indexterm role="fn"><primary>\mathbf</primary></indexterm><para>Boldface, for use in math mode. -</para></listitem></varlistentry><varlistentry><term><literal>\mathsf</literal></term> -<listitem><indexterm role="fn"><primary>\mathsf</primary></indexterm><para>Sans serif, for use in math mode. -</para></listitem></varlistentry><varlistentry><term><literal>\mathtt</literal></term> -<listitem><indexterm role="fn"><primary>\mathtt</primary></indexterm><para>Typewriter, for use in math mode. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathit</literal></term> -<term><literal>(\mit)</literal></term> -<listitem><para>Italics, for use in math mode. -</para> -</listitem></varlistentry><varlistentry><term><literal>\mathnormal</literal></term> -<listitem><indexterm role="fn"><primary>\mathnormal</primary></indexterm><para>For use in math mode, e.g. inside another type style declaration. -</para></listitem></varlistentry><varlistentry><term><literal>\mathcal</literal></term> -<listitem><indexterm role="fn"><primary>\mathcal</primary></indexterm><para>`Calligraphic' letters, for use in math mode. +<para>You can alternatively use an environment form of the declarations; for +instance, <literal>\begin{ttfamily}...\end{ttfamily}</literal>. +</para> +<para>These commands automatically supply an italic correction if the +</para><variablelist><varlistentry><term><literal>\textrm (\rmfamily)</literal> +</term><listitem><indexterm role="fn"><primary>\textrm</primary></indexterm> +<indexterm role="fn"><primary>\rmfamily</primary></indexterm> +<para>Roman. +</para> +</listitem></varlistentry><varlistentry><term><literal>\textit (\itshape)</literal> +</term><listitem><indexterm role="fn"><primary>\textit</primary></indexterm> +<indexterm role="fn"><primary>\itshape</primary></indexterm> +<para>Italics. +</para> +</listitem></varlistentry><varlistentry><term><literal>\emph</literal> +</term><listitem><indexterm role="fn"><primary>\emph</primary></indexterm> +<indexterm role="cp"><primary>emphasis</primary></indexterm> +<para>Emphasis (switches between <literal>\textit</literal> and <literal>\textrm</literal>). +</para> +</listitem></varlistentry><varlistentry><term><literal>\textmd (\mdseries)</literal> +</term><listitem><indexterm role="fn"><primary>\textmd</primary></indexterm> +<indexterm role="fn"><primary>\mdseries</primary></indexterm> +<para>Medium weight (default). +</para> +</listitem></varlistentry><varlistentry><term><literal>\textbf (\bfseries)</literal> +</term><listitem><indexterm role="fn"><primary>\textbf</primary></indexterm> +<indexterm role="fn"><primary>\bfseries</primary></indexterm> +<para>Boldface. +</para></listitem></varlistentry><varlistentry><term><literal>\textup (\upshape)</literal> +</term><listitem><indexterm role="fn"><primary>\textup</primary></indexterm> +<indexterm role="fn"><primary>\upshape</primary></indexterm> +<para>Upright (default). The opposite of slanted. +</para></listitem></varlistentry><varlistentry><term><literal>\textsl (\slshape)</literal> +</term><listitem><indexterm role="fn"><primary>\textsl</primary></indexterm> +<indexterm role="fn"><primary>\slshape</primary></indexterm> +<para>Slanted. +</para></listitem></varlistentry><varlistentry><term><literal>\textsf (\sffamily)</literal> +</term><listitem><indexterm role="fn"><primary>\textsf</primary></indexterm> +<indexterm role="fn"><primary>\sffamily</primary></indexterm> +<para>Sans serif. +</para></listitem></varlistentry><varlistentry><term><literal>\textsc (\scshape)</literal> +</term><listitem><indexterm role="fn"><primary>\textsc</primary></indexterm> +<indexterm role="fn"><primary>\scshape</primary></indexterm> +<para>Small caps. +</para></listitem></varlistentry><varlistentry><term><literal>\texttt (\ttfamily)</literal> +</term><listitem><indexterm role="fn"><primary>\texttt</primary></indexterm> +<indexterm role="fn"><primary>\ttfamily</primary></indexterm> +<para>Typewriter. +</para></listitem></varlistentry><varlistentry><term><literal>\textnormal (\normalfont)</literal> +</term><listitem><indexterm role="fn"><primary>\textnormal</primary></indexterm> +<indexterm role="fn"><primary>\normalfont</primary></indexterm> +<para>Main document font. +</para></listitem></varlistentry><varlistentry><term><literal>\mathrm</literal> +</term><listitem><indexterm role="fn"><primary>\mathrm</primary></indexterm> +<para>Roman, for use in math mode. +</para></listitem></varlistentry><varlistentry><term><literal>\mathbf</literal> +</term><listitem><indexterm role="fn"><primary>\mathbf</primary></indexterm> +<para>Boldface, for use in math mode. +</para></listitem></varlistentry><varlistentry><term><literal>\mathsf</literal> +</term><listitem><indexterm role="fn"><primary>\mathsf</primary></indexterm> +<para>Sans serif, for use in math mode. +</para></listitem></varlistentry><varlistentry><term><literal>\mathtt</literal> +</term><listitem><indexterm role="fn"><primary>\mathtt</primary></indexterm> +<para>Typewriter, for use in math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathit</literal> +</term><term><literal>(\mit)</literal> +</term><listitem><para>Italics, for use in math mode. +</para> +</listitem></varlistentry><varlistentry><term><literal>\mathnormal</literal> +</term><listitem><indexterm role="fn"><primary>\mathnormal</primary></indexterm> +<para>For use in math mode, e.g. inside another type style declaration. +</para></listitem></varlistentry><varlistentry><term><literal>\mathcal</literal> +</term><listitem><indexterm role="fn"><primary>\mathcal</primary></indexterm> +<para>‘Calligraphic’ letters, for use in math mode. </para></listitem></varlistentry></variablelist> - <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 +<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 @@ -377,183 +518,214 @@ differently than the above commands, too: <literal>{\<replaceable>cmd</replaceab instead of <literal>\<replaceable>cmd</replaceable>{...}</literal>. These are two very different things. </para> -<variablelist><varlistentry><term><literal>\bf</literal></term> -<listitem><indexterm role="cp"><primary>bold font</primary></indexterm><para>Switch to <emphasis role="bold">bold face</emphasis>. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\bf</primary></indexterm><literal>\bf</literal> +</term><listitem><indexterm role="cp"><primary>bold font</primary></indexterm> +<para>Switch to <emphasis role="bold">bold face</emphasis>. </para> -</listitem></varlistentry><varlistentry><term><literal>\cal</literal></term> -<listitem><indexterm role="cp"><primary>script letters for math</primary></indexterm><indexterm role="cp"><primary>calligraphic letters for math</primary></indexterm><para>Switch to calligraphic letters for math. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cal</primary></indexterm><literal>\cal</literal> +</term><listitem><indexterm role="cp"><primary>script letters for math</primary></indexterm> +<indexterm role="cp"><primary>calligraphic letters for math</primary></indexterm> +<para>Switch to calligraphic letters for math. </para> -</listitem></varlistentry><varlistentry><term><literal>\em</literal></term> -<listitem><indexterm role="cp"><primary>emphasis</primary></indexterm><para>Emphasis (italics within roman, roman within italics). +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\em</primary></indexterm><literal>\em</literal> +</term><listitem><indexterm role="cp"><primary>emphasis</primary></indexterm> +<para>Emphasis (italics within roman, roman within italics). </para> -</listitem></varlistentry><varlistentry><term><literal>\it</literal></term> -<listitem><indexterm role="cp"><primary>italic font</primary></indexterm><para>Italics. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\it</primary></indexterm><literal>\it</literal> +</term><listitem><indexterm role="cp"><primary>italic font</primary></indexterm> +<para>Italics. </para> -</listitem></varlistentry><varlistentry><term><literal>\rm</literal></term> -<listitem><indexterm role="cp"><primary>roman font</primary></indexterm><para>Roman. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rm</primary></indexterm><literal>\rm</literal> +</term><listitem><indexterm role="cp"><primary>roman font</primary></indexterm> +<para>Roman. </para> -</listitem></varlistentry><varlistentry><term><literal>\sc</literal></term> -<listitem><indexterm role="cp"><primary>small caps font</primary></indexterm><para>Small caps. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sc</primary></indexterm><literal>\sc</literal> +</term><listitem><indexterm role="cp"><primary>small caps font</primary></indexterm> +<para>Small caps. </para> -</listitem></varlistentry><varlistentry><term><literal>\sf</literal></term> -<listitem><indexterm role="cp"><primary>sans serif font</primary></indexterm><para>Sans serif. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sf</primary></indexterm><literal>\sf</literal> +</term><listitem><indexterm role="cp"><primary>sans serif font</primary></indexterm> +<para>Sans serif. </para> -</listitem></varlistentry><varlistentry><term><literal>\sl</literal></term> -<listitem><indexterm role="cp"><primary>slanted font</primary></indexterm><indexterm role="cp"><primary>oblique font</primary></indexterm><para>Slanted (oblique). +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sl</primary></indexterm><literal>\sl</literal> +</term><listitem><indexterm role="cp"><primary>slanted font</primary></indexterm> +<indexterm role="cp"><primary>oblique font</primary></indexterm> +<para>Slanted (oblique). </para> -</listitem></varlistentry><varlistentry><term><literal>\tt</literal></term> -<listitem><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><para>Typewriter (monospace, fixed-width). +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tt</primary></indexterm><literal>\tt</literal> +</term><listitem><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> +<para>Typewriter (monospace, fixed-width). </para> </listitem></varlistentry></variablelist> - </sect1> <sect1 label="5.2" id="Font-sizes"> <title>Font sizes</title> -<indexterm role="cp"><primary>font sizes</primary></indexterm><indexterm role="cp"><primary>typeface sizes</primary></indexterm><indexterm role="cp"><primary>sizes of text</primary></indexterm> +<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> + <para>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> -<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> -<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 +size used (in points) with the ‘<literal>10pt</literal>’, ‘<literal>11pt</literal>’, and +‘<literal>12pt</literal>’ document size options, respectively (see <link linkend="Document-class-options">Document class +options</link>). +</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> + +<informaltable><tgroup cols="4"><colspec colwidth="21*"></colspec><colspec colwidth="5*"></colspec><colspec colwidth="5*"></colspec><colspec colwidth="5*"></colspec><thead><row><entry><para>Command </para></entry><entry><para><literal>10pt</literal> </para></entry><entry><para><literal>11pt</literal> </para></entry><entry><para><literal>12pt</literal> +</para></entry></row></thead><tbody><row><entry><para><literal>\tiny</literal> +</para></entry><entry><para>5 </para></entry><entry><para>6 </para></entry><entry><para>6 +</para></entry></row><row><entry><para><literal>\scriptsize</literal> +</para></entry><entry><para>7 </para></entry><entry><para>8 </para></entry><entry><para>8 +</para></entry></row><row><entry><para><literal>\footnotesize</literal> +</para></entry><entry><para>8 </para></entry><entry><para>9 </para></entry><entry><para>10 +</para></entry></row><row><entry><para><literal>\small</literal> +</para></entry><entry><para>9 </para></entry><entry><para>10 </para></entry><entry><para>10.95 +</para></entry></row><row><entry><para><literal>\normalsize</literal> (default) +</para></entry><entry><para>10 </para></entry><entry><para>10.95 </para></entry><entry><para>12 +</para></entry></row><row><entry><para><literal>\large</literal> +</para></entry><entry><para>12 </para></entry><entry><para>12 </para></entry><entry><para>14.4 +</para></entry></row><row><entry><para><literal>\Large</literal> +</para></entry><entry><para>14.4 </para></entry><entry><para>14.4 </para></entry><entry><para>17.28 +</para></entry></row><row><entry><para><literal>\LARGE</literal> +</para></entry><entry><para>17.28 </para></entry><entry><para>17.28 </para></entry><entry><para>20.74 +</para></entry></row><row><entry><para><literal>\huge</literal> +</para></entry><entry><para>20.74 </para></entry><entry><para>20.74 </para></entry><entry><para>24.88 +</para></entry></row><row><entry><para><literal>\Huge</literal> +</para></entry><entry><para>24.88 </para></entry><entry><para>24.88 </para></entry><entry><para>24.88 +</para></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="5.3" id="Low-level-font-commands"> +<sect1 label="5.3" id="Low_002dlevel-font-commands"> <title>Low-level font commands</title> -<indexterm role="cp"><primary>low-level font commands</primary></indexterm><indexterm role="cp"><primary>font commands, low-level</primary></indexterm> +<indexterm role="cp"><primary>low-level font commands</primary></indexterm> +<indexterm role="cp"><primary>font commands, low-level</primary></indexterm> + <para>These commands are primarily intended for writers of macros and packages. The commands listed here are only a subset of the available ones. </para> -<variablelist><varlistentry><term><literal>\fontencoding{enc}</literal></term> -<listitem><indexterm role="fn"><primary>\fontencoding</primary></indexterm><para>Select font encoding. Valid encodings include <literal>OT1</literal> and <literal>T1</literal>. +<variablelist><varlistentry><term><literal>\fontencoding{enc}</literal> +</term><listitem><indexterm role="fn"><primary>\fontencoding</primary></indexterm> +<para>Select font encoding. Valid encodings include <literal>OT1</literal> and <literal>T1</literal>. </para> -</listitem></varlistentry><varlistentry><term><literal>\fontfamily{family}</literal></term> -<listitem><indexterm role="fn"><primary>\fontfamily</primary></indexterm><para>Select font family. Valid families include: +</listitem></varlistentry><varlistentry><term><literal>\fontfamily{family}</literal> +</term><listitem><indexterm role="fn"><primary>\fontfamily</primary></indexterm> +<para>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> +<itemizedlist><listitem><para><literal>cmr</literal> for Computer Modern Roman +</para></listitem><listitem><para><literal>cmss</literal> for Computer Modern Sans Serif +</para></listitem><listitem><para><literal>cmtt</literal> for Computer Modern Typewriter +</para></listitem></itemizedlist> <para>and numerous others. </para> -</listitem></varlistentry><varlistentry><term><literal>\fontseries{series}</literal></term> -<listitem><indexterm role="fn"><primary>\fontseries</primary></indexterm><para>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> +</listitem></varlistentry><varlistentry><term><literal>\fontseries{series}</literal> +</term><listitem><indexterm role="fn"><primary>\fontseries</primary></indexterm> +<para>Select font series. Valid series include: +</para> +<itemizedlist><listitem><para><literal>m</literal> Medium (normal) +</para></listitem><listitem><para><literal>b</literal> Bold +</para></listitem><listitem><para><literal>c</literal> Condensed +</para></listitem><listitem><para><literal>bc</literal> Bold condensed +</para></listitem><listitem><para><literal>bx</literal> Bold extended +</para></listitem></itemizedlist> <para>and various other combinations. </para> -</listitem></varlistentry><varlistentry><term><literal>\fontshape{shape}</literal></term> -<listitem><indexterm role="fn"><primary>\fontshape</primary></indexterm><para>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> +</listitem></varlistentry><varlistentry><term><literal>\fontshape{shape}</literal> +</term><listitem><indexterm role="fn"><primary>\fontshape</primary></indexterm> +<para>Select font shape. Valid shapes are: +</para> +<itemizedlist><listitem><para><literal>n</literal> Upright (normal) +</para></listitem><listitem><para><literal>it</literal> Italic +</para></listitem><listitem><para><literal>sl</literal> Slanted (oblique) +</para></listitem><listitem><para><literal>sc</literal> Small caps +</para></listitem><listitem><para><literal>ui</literal> Upright italics +</para></listitem><listitem><para><literal>ol</literal> Outline +</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><indexterm role="fn"><primary>\fontsize</primary></indexterm><indexterm role="fn"><primary>\baselineskip</primary></indexterm><para>Set font size. The first parameter is the font size to switch to and +</listitem></varlistentry><varlistentry><term><literal>\fontsize{size}{skip}</literal> +</term><listitem><indexterm role="fn"><primary>\fontsize</primary></indexterm> +<indexterm role="fn"><primary>\baselineskip</primary></indexterm> +<para>Set font size. The first parameter is the font size to switch to and the second is the line spacing to use; this is stored in a parameter named <literal>\baselineskip</literal>. The unit of both parameters defaults to pt. The default <literal>\baselineskip</literal> for the Computer Modern typeface is 1.2 times the <literal>\fontsize</literal>. </para> -<indexterm role="fn"><primary>\baselinestretch</primary></indexterm><indexterm role="cp"><primary><literal>setspace</literal> package</primary></indexterm><indexterm role="cp"><primary>double spacing</primary></indexterm><para>The line spacing is also multiplied by the value of the +<indexterm role="fn"><primary>\baselinestretch</primary></indexterm> +<indexterm role="cp"><primary><literal>setspace</literal> package</primary></indexterm> +<indexterm role="cp"><primary>double spacing</primary></indexterm> +<para>The line spacing is also multiplied by the value of the <literal>\baselinestretch</literal> parameter when the type size changes; the -default is 1. However, the best way to “double space” a document, +default is 1. However, the best way to “double space” a document, if you should be unlucky enough to have to produce such, is to use the <literal>setspace</literal> package; see <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</ulink>. </para> -<indexterm role="fn"><primary>\linespread</primary></indexterm></listitem></varlistentry><varlistentry><term><literal>\linespread{<replaceable>factor</replaceable>}</literal></term> -<listitem><para>Equivalent to +<indexterm role="fn"><primary>\linespread</primary></indexterm> +</listitem></varlistentry><varlistentry><term><literal>\linespread{<replaceable>factor</replaceable>}</literal> +</term><listitem><para>Equivalent to <literal>\renewcommand{\baselinestretch}{<replaceable>factor</replaceable>}</literal>, and therefore must be followed by <literal>\selectfont</literal> to have any effect. Best specified in the preamble, or use the <literal>setspace</literal> package, as described just above. </para> -<indexterm role="fn"><primary>\selectfont</primary></indexterm><para>The changes made by calling the font commands described above do +<indexterm role="fn"><primary>\selectfont</primary></indexterm> +<para>The changes made by calling the font commands described above do not come into effect until <literal>\selectfont</literal> is called. </para> -</listitem></varlistentry><varlistentry><term><literal>\usefont{enc}{family}{series}{shape}</literal></term> -<listitem><indexterm role="fn"><primary>\usefont</primary></indexterm><para>The same as invoking <literal>\fontencoding</literal>, <literal>\fontfamily</literal>, +</listitem></varlistentry><varlistentry><term><literal>\usefont{enc}{family}{series}{shape}</literal> +</term><listitem><indexterm role="fn"><primary>\usefont</primary></indexterm> +<para>The same as invoking <literal>\fontencoding</literal>, <literal>\fontfamily</literal>, <literal>\fontseries</literal> and <literal>\fontshape</literal> with the given parameters, followed by <literal>\selectfont</literal>. </para> </listitem></varlistentry></variablelist> - </sect1> </chapter> <chapter label="6" id="Layout"> <title>Layout</title> <indexterm role="cp"><primary>layout commands</primary></indexterm> + <para>Miscellaneous commands for controlling the general layout of the page. </para> -<sect1 label="6.1"> +<sect1 label="6.1" id="_005conecolumn"> <title><literal>\onecolumn</literal></title> -<indexterm role="fn"><primary>\onecolumn</primary></indexterm><indexterm role="cp"><primary>one-column output</primary></indexterm> +<indexterm role="fn"><primary>\onecolumn</primary></indexterm> +<indexterm role="cp"><primary>one-column output</primary></indexterm> + <para>The <literal>\onecolumn</literal> declaration starts a new page and produces single-column output. This is the default. </para> </sect1> -<sect1 label="6.2"> +<sect1 label="6.2" id="_005ctwocolumn"> <title><literal>\twocolumn</literal></title> -<indexterm role="fn"><primary>\twocolumn</primary></indexterm><indexterm role="cp"><primary>multicolumn text</primary></indexterm><indexterm role="cp"><primary>two-column output</primary></indexterm> +<indexterm role="fn"><primary>\twocolumn</primary></indexterm> +<indexterm role="cp"><primary>multicolumn text</primary></indexterm> +<indexterm role="cp"><primary>two-column output</primary></indexterm> + <para>Synopsis: </para> <screen>\twocolumn[<replaceable>text1col</replaceable>] @@ -565,58 +737,59 @@ 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). +<variablelist><varlistentry><term><indexterm role="fn"><primary>\columnsep</primary></indexterm><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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\columnseprule</primary></indexterm><literal>\columnseprule</literal> +</term><listitem><para>The width of the rule between columns; the default is 0pt, so there is no rule. </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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\columnwidth</primary></indexterm><literal>\columnwidth</literal> +</term><listitem><para>The width of the current column; this is equal to <literal>\textwidth</literal> in single-column text. </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. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\dbltopfraction</primary></indexterm><literal>\dbltopfraction</literal> +</term><listitem><para>Maximum fraction at the top of a two-column page that may be occupied +by floats. Default ‘<literal>.7</literal>’, can be usefully redefined to (say) +‘<literal>.9</literal>’ to avoid going to float pages so soon. </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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dblfloatpagefraction</primary></indexterm><literal>\dblfloatpagefraction</literal> +</term><listitem><para>The minimum fraction of a float page that must be occupied by floats, +for a two-column float page. Default ‘<literal>.5</literal>’. </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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dblfloatsep</primary></indexterm><literal>\dblfloatsep</literal> +</term><listitem><para>Distance between floats at the top or bottom of a two-column float +page. Default ‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and +‘<literal>11pt</literal>’ documents, ‘<literal>14pt plus2pt minus4pt</literal>’ for ‘<literal>12pt</literal>’. </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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dbltextfloatsep</primary></indexterm><literal>\dbltextfloatsep</literal> +</term><listitem><para>Distance between a multi-column float at the top or bottom of a page +and the main text. Default ‘<literal>20pt plus2pt minus4pt</literal>’. </para> </listitem></varlistentry></variablelist> - </sect1> -<sect1 label="6.3"> +<sect1 label="6.3" id="_005cflushbottom"> <title><literal>\flushbottom</literal></title> <indexterm role="fn"><primary>\flushbottom</primary></indexterm> + <para>The <literal>\flushbottom</literal> declaration makes all text pages the same height, adding extra vertical space where necessary to fill out the page. </para> <para>This is the default if <literal>twocolumn</literal> mode is selected -(see <xref linkend="Document-class-options"></xref>). +(see <link linkend="Document-class-options">Document class options</link>). </para> </sect1> -<sect1 label="6.4"> +<sect1 label="6.4" id="_005craggedbottom"> <title><literal>\raggedbottom</literal></title> -<indexterm role="fn"><primary>\raggedbottom</primary></indexterm><indexterm role="cp"><primary>stretch, omitting vertical</primary></indexterm> +<indexterm role="fn"><primary>\raggedbottom</primary></indexterm> +<indexterm role="cp"><primary>stretch, omitting vertical</primary></indexterm> + <para>The <literal>\raggedbottom</literal> declaration makes all pages the natural height of the material on that page. No rubber lengths will be stretched. @@ -626,96 +799,102 @@ stretched. <sect1 label="6.5" id="Page-layout-parameters"> <title>Page layout parameters</title> -<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> -<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 +<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> + +<variablelist><varlistentry><term><indexterm role="fn"><primary>\headheight</primary></indexterm><literal>\headheight</literal> +</term><listitem><para>Height of the box that contains the running head. Default is +‘<literal>30pt</literal>’, except in the <literal>book</literal> class, where it varies with the type size. </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> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\headsep</primary></indexterm><literal>\headsep</literal> +</term><listitem><para>Vertical distance between the bottom of the header line and the top of +the main text. Default is ‘<literal>25pt</literal>’, except in the <literal>book</literal> class, where it varies with the type size. </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> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\footskip</primary></indexterm><literal>\footskip</literal> +</term><listitem><para>Distance from the baseline of the last line of text to the baseline of +the page footer. Default is ‘<literal>30pt</literal>’, except in the <literal>book</literal> class, where it varies with the type size. </para> -</listitem></varlistentry><varlistentry><term><literal>\linewidth</literal></term> -<listitem><para>Width of the current line, decreased for each nested <literal>list</literal> -(see <xref linkend="list"></xref>). Specifically, it is smaller than <literal>\textwidth</literal> by +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\linewidth</primary></indexterm><literal>\linewidth</literal> +</term><listitem><para>Width of the current line, decreased for each nested <literal>list</literal> +(see <link linkend="list">list</link>). Specifically, it is smaller than <literal>\textwidth</literal> by the sum of <literal>\leftmargin</literal> and <literal>\rightmargin</literal> -(see <xref linkend="itemize"></xref>). The default varies with the font size, paper +(see <link linkend="itemize">itemize</link>). The default varies with the font size, paper width, two-column mode, etc. For an <literal>article</literal> document in -‘<literal>10pt</literal>’, it's set to ‘<literal>345pt</literal>’; in two-column mode, that -becomes ‘<literal>229.5pt</literal>’. +‘<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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textheight</primary></indexterm><literal>\textheight</literal> +</term><listitem><para>The normal vertical height of the page body; the default varies with the font size, document class, etc. For an <literal>article</literal> or -<literal>report</literal> document in ‘<literal>10pt</literal>’, it's set to -‘<literal>43\baselineskip</literal>’; for <literal>book</literal>, it's ‘<literal>41\baselineskip</literal>’. -For ‘<literal>11pt</literal>’, it's ‘<literal>38\baselineskip</literal>’ and for ‘<literal>12pt</literal>’, -‘<literal>36\baselineskip</literal>’. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textwidth</literal></term> -<listitem><para>The full horizontal width of the entire page body; the default varies -as usual. For an <literal>article</literal> or <literal>report</literal> document, it's -‘<literal>345pt</literal>’ at ‘<literal>10pt</literal>’, ‘<literal>360pt</literal>’ at ‘<literal>11pt</literal>’, and -‘<literal>390pt</literal>’ at ‘<literal>12pt</literal>’. For a <literal>book</literal> document, it's -‘<literal>4.5in</literal>’ at ‘<literal>10pt</literal>’, and ‘<literal>5in</literal>’ at ‘<literal>11pt</literal>’ or -‘<literal>12pt</literal>’. +<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><indexterm role="fn"><primary>\textwidth</primary></indexterm><literal>\textwidth</literal> +</term><listitem><para>The full horizontal width of the entire page body; the default varies +as usual. For an <literal>article</literal> or <literal>report</literal> document, it’s +‘<literal>345pt</literal>’ at ‘<literal>10pt</literal>’, ‘<literal>360pt</literal>’ at ‘<literal>11pt</literal>’, and +‘<literal>390pt</literal>’ at ‘<literal>12pt</literal>’. For a <literal>book</literal> document, it’s +‘<literal>4.5in</literal>’ at ‘<literal>10pt</literal>’, and ‘<literal>5in</literal>’ at ‘<literal>11pt</literal>’ or +‘<literal>12pt</literal>’. </para> <para>In multi-column output, <literal>\textwidth</literal> remains the width of the entire page body, while <literal>\columnwidth</literal> is the width of one column -(see <xref linkend="\twocolumn"></xref>). +(see <link linkend="_005ctwocolumn">\twocolumn</link>). </para> -<para>In lists (see <xref linkend="list"></xref>), <literal>\textwidth</literal> remains the width of the +<para>In lists (see <link linkend="list">list</link>), <literal>\textwidth</literal> remains the width of the entire page body (and <literal>\columnwidth</literal> the width of the entire column), while <literal>\linewidth</literal> may decrease for nested lists. </para> -<para>Inside a minipage (see <xref linkend="minipage"></xref>) or <literal>\parbox</literal> -(see <xref linkend="\parbox"></xref>), all the width-related parameters are set to the +<para>Inside a minipage (see <link linkend="minipage">minipage</link>) or <literal>\parbox</literal> +(see <link linkend="_005cparbox">\parbox</link>), all the width-related parameters are set to the specified width, and revert to their normal values at the end of the <literal>minipage</literal> or <literal>\parbox</literal>. </para> -<indexterm role="fn"><primary>\hsize</primary></indexterm><para>For completeness: <literal>\hsize</literal> is the &tex; primitive parameter used +<indexterm role="fn"><primary>\hsize</primary></indexterm> +<para>For completeness: <literal>\hsize</literal> is the &tex; primitive parameter used when text is broken into lines. It should not be used in normal &latex; documents. </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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topmargin</primary></indexterm><literal>\topmargin</literal> +</term><listitem><para>Space between the top of the &tex; page (one inch from the top of the paper, by default) and the top of the header. The default is computed -based on many other parameters: <literal>\paperheight − 2in − -\headheight − \headsep − \textheight − \footskip</literal>, and +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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topskip</primary></indexterm><literal>\topskip</literal> +</term><listitem><para>Minimum distance between the top of the page body and the baseline of 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>’. +same as the font size, e.g., ‘<literal>10pt</literal>’ at ‘<literal>10pt</literal>’. </para> </listitem></varlistentry></variablelist> - </sect1> </chapter> <chapter label="7" id="Sectioning"> <title>Sectioning</title> <indexterm role="cp"><primary>sectioning</primary></indexterm> + <para>Sectioning commands provide the means to structure your text into units: </para> -<variablelist><varlistentry><term><literal>\part</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry><varlistentry><term><literal>\chapter</literal></term> -<listitem><para>(report and book class only) -</para></listitem></varlistentry><varlistentry><term><literal>\section</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry><varlistentry><term><literal>\subsection</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry><varlistentry><term><literal>\subsubsection</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry><varlistentry><term><literal>\paragraph</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry><varlistentry><term><literal>\subparagraph</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry></variablelist> - +<variablelist><varlistentry><term><indexterm role="fn"><primary>\part</primary></indexterm><literal>\part</literal> +</term></varlistentry><varlistentry><term><indexterm role="fn"><primary>\chapter</primary></indexterm><literal>\chapter</literal> +</term><listitem><para>(report and book class only) +</para></listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\section</primary></indexterm><literal>\section</literal> +</term></varlistentry><varlistentry><term><indexterm role="fn"><primary>\subsection</primary></indexterm><literal>\subsection</literal> +</term></varlistentry><varlistentry><term><indexterm role="fn"><primary>\subsubsection</primary></indexterm><literal>\subsubsection</literal> +</term></varlistentry><varlistentry><term><indexterm role="fn"><primary>\paragraph</primary></indexterm><literal>\paragraph</literal> +</term></varlistentry><varlistentry><term><indexterm role="fn"><primary>\subparagraph</primary></indexterm><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>} @@ -723,55 +902,58 @@ same as the font size, e.g., ‘<literal>10pt</literal>’ at ‘<li <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> +<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> -<indexterm role="cp"><primary>*-form of sectioning commands</primary></indexterm><para>Also, all sectioning commands have <literal>*</literal>-forms that print +<indexterm role="cp"><primary>*-form of sectioning commands</primary></indexterm> +<para>Also, all sectioning commands have <literal>*</literal>-forms that print <replaceable>title</replaceable> as usual, but do not include a number and do not make an entry in the table of contents. For instance: </para> <screen>\section*{Preamble} </screen> -<indexterm role="fn"><primary>\appendix</primary></indexterm><indexterm role="cp"><primary>appendix, creating</primary></indexterm><para>The <literal>\appendix</literal> command changes the way following sectional units +<indexterm role="fn"><primary>\appendix</primary></indexterm> +<indexterm role="cp"><primary>appendix, creating</primary></indexterm> +<para>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> -<indexterm role="fn"><primary>secnumdepth counter</primary></indexterm><indexterm role="cp"><primary>section numbers, printing</primary></indexterm><para>The <literal>secnumdepth</literal> counter controls printing of section numbers. +<indexterm role="fn"><primary>secnumdepth <lineannotation>counter</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>section numbers, printing</primary></indexterm> +<para>The <literal>secnumdepth</literal> counter controls printing of section numbers. The setting </para> <screen>\setcounter{secnumdepth}{<replaceable>level</replaceable>} </screen> -<para>suppresses heading numbers at any depth > <replaceable>level</replaceable>, where -<literal>chapter</literal> is level zero. (See <xref linkend="\setcounter"></xref>.) +<para>suppresses heading numbers at any depth <inlineequation><mathphrase>> <replaceable>level</replaceable></mathphrase></inlineequation>, where +<literal>chapter</literal> is level zero. (See <link linkend="_005csetcounter">\setcounter</link>.) </para> </chapter> <chapter label="8" id="Cross-references"> <title>Cross references</title> <indexterm role="cp"><primary>cross references</primary></indexterm> + <para>One reason for numbering things like figures and equations is to refer -the reader to them, as in “See Figure 3 for more details.” +the reader to them, as in “See Figure 3 for more details.” </para> -<sect1 label="8.1"> +<sect1 label="8.1" id="_005clabel"> <title><literal>\label</literal></title> <indexterm role="fn"><primary>\label</primary></indexterm> + <para>Synopsis: </para> <screen>\label{<replaceable>key</replaceable>} @@ -787,26 +969,28 @@ punctuation characters. Upper and lowercase letters are distinguished. 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 +<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="8.2"> +<sect1 label="8.2" id="_005cpageref"> <title><literal>\pageref{<replaceable>key</replaceable>}</literal></title> -<indexterm role="fn"><primary>\pageref</primary></indexterm><indexterm role="cp"><primary>cross referencing with page number</primary></indexterm><indexterm role="cp"><primary>page number, cross referencing</primary></indexterm> +<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> + <para>Synopsis: </para> <screen>\pageref{<replaceable>key</replaceable>} @@ -817,17 +1001,23 @@ the place in the text where the corresponding </para> </sect1> -<sect1 label="8.3"> +<sect1 label="8.3" id="_005cref"> <title><literal>\ref{<replaceable>key</replaceable>}</literal></title> -<indexterm role="fn"><primary>\ref</primary></indexterm><indexterm role="cp"><primary>cross referencing, symbolic</primary></indexterm><indexterm role="cp"><primary>section number, cross referencing</primary></indexterm><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> +<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> + <para>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. +equation, footnote, figure, …, of the corresponding +<literal>\label</literal> command (see <link linkend="_005clabel">\label</link>). It does not produce any text, +such as the word ‘Section’ or ‘Figure’, just the bare number itself. </para> </sect1> @@ -835,7 +1025,10 @@ such as the word `Section' or `Figure', just the bare number itself. <chapter label="9" id="Environments"> <title>Environments</title> <indexterm role="cp"><primary>environments</primary></indexterm> -<indexterm role="fn"><primary>\begin</primary></indexterm><indexterm role="fn"><primary>\end</primary></indexterm> + +<indexterm role="fn"><primary>\begin</primary></indexterm> +<indexterm role="fn"><primary>\end</primary></indexterm> + <para>&latex; provides many environments for marking off certain text. Each environment begins and ends in the same manner: </para> @@ -845,10 +1038,12 @@ Each environment begins and ends in the same manner: </screen> -<sect1 label="9.1"> +<sect1 label="9.1" id="abstract"> <title><literal>abstract</literal></title> -<indexterm role="fn"><primary>abstract environment</primary></indexterm><indexterm role="cp"><primary>abstracts</primary></indexterm> +<indexterm role="fn"><primary>abstract <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>abstracts</primary></indexterm> + <para>Synopsis: </para><screen>\begin{abstract} ... @@ -858,9 +1053,11 @@ Each environment begins and ends in the same manner: </para> </sect1> -<sect1 label="9.2"> +<sect1 label="9.2" id="array"> <title><literal>array</literal></title> -<indexterm role="fn"><primary>array environment</primary></indexterm><indexterm role="cp"><primary>arrays, math</primary></indexterm> +<indexterm role="fn"><primary>array <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>arrays, math</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{array}{<replaceable>template</replaceable>} @@ -869,28 +1066,29 @@ Each environment begins and ends in the same manner: \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 +within an <literal>equation</literal> environment (see <link linkend="equation">equation</link>). It has a single mandatory <replaceable>template</replaceable> argument describing the number of columns and the alignment within them. Each column <replaceable>col</replaceable> is specified by a single letter that tells how items in 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 +<variablelist><varlistentry><term><literal>c</literal> +</term><listitem><para>centered +</para></listitem></varlistentry><varlistentry><term><literal>l</literal> +</term><listitem><para>flush left +</para></listitem></varlistentry><varlistentry><term><literal>r</literal> +</term><listitem><para>flush right </para></listitem></varlistentry></variablelist> - -<indexterm role="fn"><primary>\\ (for <literal>array</literal>)</primary></indexterm><para>Column entries are separated by <literal>&</literal>. Column entries may include +<indexterm role="fn"><primary>\\ (for <literal>array</literal>)</primary></indexterm> +<para>Column entries are separated by <literal>&</literal>. Column entries may include other &latex; commands. Each row of the array is terminated with <literal>\\</literal>. </para> -<indexterm role="fn"><primary>@{...}</primary></indexterm><para>In the template, the construct <literal>@{<replaceable>text</replaceable>}</literal> puts <replaceable>text</replaceable> +<indexterm role="fn"><primary>@{...}</primary></indexterm> +<para>In the template, the construct <literal>@{<replaceable>text</replaceable>}</literal> puts <replaceable>text</replaceable> between columns in each row. </para> -<para>Here's an example: +<para>Here’s an example: </para> <screen>\begin{equation} \begin{array}{lrc} @@ -899,8 +1097,9 @@ between columns in each row. \end{array} \end{equation} </screen> -<indexterm role="fn"><primary>\arraycolsep</primary></indexterm><para>The <literal>\arraycolsep</literal> parameter defines half the width of the space -separating columns; the default is ‘<literal>5pt</literal>’. See <xref linkend="tabular"></xref>, for other +<indexterm role="fn"><primary>\arraycolsep</primary></indexterm> +<para>The <literal>\arraycolsep</literal> parameter defines half the width of the space +separating columns; the default is ‘<literal>5pt</literal>’. See <link linkend="tabular">tabular</link>, for other parameters which affect formatting in <literal>array</literal> environments, namely <literal>\arrayrulewidth</literal> and <literal>\arraystretch</literal>. </para> @@ -908,10 +1107,12 @@ namely <literal>\arrayrulewidth</literal> and <literal>\arraystretch</literal>. </para> </sect1> -<sect1 label="9.3"> +<sect1 label="9.3" id="center"> <title><literal>center</literal></title> -<indexterm role="fn"><primary>center environment</primary></indexterm><indexterm role="cp"><primary>centering text, environment for</primary></indexterm> +<indexterm role="fn"><primary>center <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>centering text, environment for</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{center} @@ -919,17 +1120,20 @@ namely <literal>\arrayrulewidth</literal> and <literal>\arraystretch</literal>. <replaceable>line2</replaceable> \\ \end{center} </screen> -<indexterm role="fn"><primary>\\ (for <literal>center</literal>)</primary></indexterm><para>The <literal>center</literal> environment allows you to create a paragraph +<indexterm role="fn"><primary>\\ (for <literal>center</literal>)</primary></indexterm> +<para>The <literal>center</literal> environment allows you to create a paragraph consisting of lines that are centered within the left and right margins on the current page. Each line is terminated with the string <literal>\\</literal>. </para> -<sect2 label="9.3.1"> +<sect2 label="9.3.1" id="_005ccentering"> <title><literal>\centering</literal></title> -<indexterm role="fn"><primary>\centering</primary></indexterm><indexterm role="cp"><primary>centering text, declaration for</primary></indexterm> +<indexterm role="fn"><primary>\centering</primary></indexterm> +<indexterm role="cp"><primary>centering text, declaration for</primary></indexterm> + <para>The <literal>\centering</literal> declaration corresponds to the <literal>center</literal> environment. This declaration can be used inside an environment such as <literal>quote</literal> or in a <literal>parbox</literal>. Thus, the text of a figure or @@ -938,11 +1142,11 @@ 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 +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>Here’s an example: </para> <screen>\begin{quote} \centering @@ -953,10 +1157,13 @@ second line \\ </sect2> </sect1> -<sect1 label="9.4"> +<sect1 label="9.4" id="description"> <title><literal>description</literal></title> -<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> +<indexterm role="fn"><primary>description <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>labelled lists, creating</primary></indexterm> +<indexterm role="cp"><primary>description lists, creating</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{description} @@ -965,25 +1172,29 @@ second line \\ ... \end{description} </screen> -<indexterm role="fn"><primary>\item</primary></indexterm><para>The <literal>description</literal> environment is used to make labelled lists. Each +<indexterm role="fn"><primary>\item</primary></indexterm> +<para>The <literal>description</literal> environment is used to make labelled lists. Each <replaceable>label</replaceable> is typeset in bold, flush right. The <replaceable>item</replaceable> text may contain multiple paragraphs. </para> -<indexterm role="cp"><primary>bold typewriter, avoiding</primary></indexterm><indexterm role="cp"><primary>typewriter labels in lists</primary></indexterm><para>Another variation: since the bold style is applied to the labels, if -you typeset a label in typewriter using <literal>\texttt</literal>, you'll get +<indexterm role="cp"><primary>bold typewriter, avoiding</primary></indexterm> +<indexterm role="cp"><primary>typewriter labels in lists</primary></indexterm> +<para>Another variation: since the bold style is applied to the labels, if +you typeset a label in typewriter using <literal>\texttt</literal>, you’ll get bold typewriter: <literal>\item[\texttt{bold and typewriter}]</literal>. This may be too bold, among other issues. To get just typewriter, use <literal>\tt</literal>, which resets all other style variations: <literal>\item[{\tt plain typewriter}]</literal>. </para> -<para>For details about list spacing, see <xref linkend="itemize"></xref>. +<para>For details about list spacing, see <link linkend="itemize">itemize</link>. </para> </sect1> -<sect1 label="9.5"> +<sect1 label="9.5" id="displaymath"> <title><literal>displaymath</literal></title> -<indexterm role="fn"><primary>displaymath environment</primary></indexterm> +<indexterm role="fn"><primary>displaymath <lineannotation>environment</lineannotation></primary></indexterm> + <para>Synopsis: </para> <screen>\begin{displaymath} @@ -997,26 +1208,29 @@ plain typewriter}]</literal>. <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>. +<link linkend="Document-class-options">Document class options</link>. </para> <para>No equation number is added to <literal>displaymath</literal> text; to get an -equation number, use the <literal>equation</literal> environment (see <xref linkend="equation"></xref>). +equation number, use the <literal>equation</literal> environment (see <link linkend="equation">equation</link>). </para> </sect1> -<sect1 label="9.6"> +<sect1 label="9.6" id="document"> <title><literal>document</literal></title> -<indexterm role="fn"><primary>document environment</primary></indexterm> +<indexterm role="fn"><primary>document <lineannotation>environment</lineannotation></primary></indexterm> + <para>The <literal>document</literal> environment encloses the body of a document. -It is required in every &latex; document. See <xref linkend="Starting-&-ending"></xref>. +It is required in every &latex; document. See <link linkend="Starting-_0026-ending">Starting & ending</link>. </para> </sect1> -<sect1 label="9.7"> +<sect1 label="9.7" id="enumerate"> <title><literal>enumerate</literal></title> -<indexterm role="fn"><primary>enumerate environment</primary></indexterm><indexterm role="cp"><primary>lists of items, numbered</primary></indexterm> +<indexterm role="fn"><primary>enumerate <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>lists of items, numbered</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{enumerate} @@ -1028,72 +1242,102 @@ It is required in every &latex; document. See <xref linkend="Starting-&-end <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>). +<literal>itemize</literal> (see <link linkend="itemize">itemize</link>) and <literal>description</literal> +(see <link linkend="description">description</link>). </para> -<indexterm role="fn"><primary>\item</primary></indexterm><para>Each item of an enumerated list begins with an <literal>\item</literal> command. +<indexterm role="fn"><primary>\item</primary></indexterm> +<para>Each item of an enumerated list begins with an <literal>\item</literal> command. There must be at least one <literal>\item</literal> command within the environment. </para> <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> -<indexterm role="fn"><primary>\enumi</primary></indexterm><indexterm role="fn"><primary>\enumii</primary></indexterm><indexterm role="fn"><primary>\enumiii</primary></indexterm><indexterm role="fn"><primary>\enumiv</primary></indexterm><para>The <literal>enumerate</literal> environment uses the counters <literal>\enumi</literal> -through <literal>\enumiv</literal> counters (see <xref linkend="Counters"></xref>). If the optional +<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> +<indexterm role="fn"><primary>\enumi</primary></indexterm> +<indexterm role="fn"><primary>\enumii</primary></indexterm> +<indexterm role="fn"><primary>\enumiii</primary></indexterm> +<indexterm role="fn"><primary>\enumiv</primary></indexterm> +<para>The <literal>enumerate</literal> environment uses the counters <literal>\enumi</literal> +through <literal>\enumiv</literal> counters (see <link linkend="Counters">Counters</link>). If the optional argument to <literal>\item</literal> is given, the counter is not incremented for that item. </para> -<indexterm role="fn"><primary>\labelenumi</primary></indexterm><indexterm role="fn"><primary>\labelenumii</primary></indexterm><indexterm role="fn"><primary>\labelenumiii</primary></indexterm><indexterm role="fn"><primary>\labelenumiv</primary></indexterm><para>The <literal>enumerate</literal> environment uses the commands <literal>\labelenumi</literal> +<indexterm role="fn"><primary>\labelenumi</primary></indexterm> +<indexterm role="fn"><primary>\labelenumii</primary></indexterm> +<indexterm role="fn"><primary>\labelenumiii</primary></indexterm> +<indexterm role="fn"><primary>\labelenumiv</primary></indexterm> +<para>The <literal>enumerate</literal> environment uses the commands <literal>\labelenumi</literal> through <literal>\labelenumiv</literal> to produce the default label. So, you can -use <literal>\renewcommand</literal> to change the labels (see <xref linkend="\newcommand-&-\renewcommand"></xref>). For instance, to have the first level use uppercase +use <literal>\renewcommand</literal> to change the labels (see <link linkend="_005cnewcommand-_0026-_005crenewcommand">\newcommand & +\renewcommand</link>). For instance, to have the first level use uppercase letters: </para> -<indexterm role="fn"><primary>\Alph example</primary></indexterm><screen>\renewcommand{\labelenumi}{\Alph{enumi}} +<indexterm role="fn"><primary>\Alph <lineannotation>example</lineannotation></primary></indexterm> +<screen>\renewcommand{\labelenumi}{\Alph{enumi}} </screen> </sect1> -<sect1 label="9.8"> +<sect1 label="9.8" id="eqnarray"> <title><literal>eqnarray</literal></title> -<indexterm role="fn"><primary>eqnarray environment</primary></indexterm><indexterm role="cp"><primary>equations, aligning</primary></indexterm><indexterm role="cp"><primary>aligning Equations</primary></indexterm> +<indexterm role="fn"><primary>eqnarray <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>equations, aligning</primary></indexterm> +<indexterm role="cp"><primary>aligning equations</primary></indexterm> + +<indexterm role="cp"><primary>align <lineannotation>environment, from <literal>amsmath</literal></lineannotation></primary></indexterm> +<indexterm role="cp"><primary>amsmath <lineannotation>package, replacing <literal>eqnarray</literal></lineannotation></primary></indexterm> +<indexterm role="cp"><primary>Madsen, Lars</primary></indexterm> +<para>First, a caveat: the <literal>eqnarray</literal> environment has some infelicities +which cannot be overcome; the article “Avoid eqnarray!” by Lars +Madsen describes them in detail +(<ulink url="http://tug.org/TUGboat/tb33-1/tb103madsen.pdf">http://tug.org/TUGboat/tb33-1/tb103madsen.pdf</ulink>). The bottom +line is that it is better to use the <literal>align</literal> environment (and +others) from the <literal>amsmath</literal> package. +</para> +<para>Nevertheless, here is a description of <literal>eqnarray</literal>: +</para> <screen>\begin{eqnarray} <lineannotation>(or <literal>eqnarray*</literal>)</lineannotation> <replaceable>formula1</replaceable> \\ <replaceable>formula2</replaceable> \\ ... \end{eqnarray} </screen> -<indexterm role="fn"><primary>\\ (for <literal>eqnarray</literal>)</primary></indexterm><para>The <literal>eqnarray</literal> environment is used to display a sequence of +<indexterm role="fn"><primary>\\ (for <literal>eqnarray</literal>)</primary></indexterm> +<para>The <literal>eqnarray</literal> environment is used to display a sequence of equations or inequalities. It is 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> -<indexterm role="fn"><primary>\\* (for <literal>eqnarray</literal>)</primary></indexterm><para><literal>\\*</literal> can also be used to separate equations, with its normal +<indexterm role="fn"><primary>\\* (for <literal>eqnarray</literal>)</primary></indexterm> +<para><literal>\\*</literal> can also be used to separate equations, with its normal meaning of not allowing a page break at that line. </para> -<indexterm role="fn"><primary>\nonumber</primary></indexterm><indexterm role="cp"><primary>equation numbers, omitting</primary></indexterm><para>An equation number is placed on every line unless that line has a +<indexterm role="fn"><primary>\nonumber</primary></indexterm> +<indexterm role="cp"><primary>equation numbers, omitting</primary></indexterm> +<para>An equation number is placed on every line unless that line has a <literal>\nonumber</literal> command. Alternatively, The <literal>*</literal>-form of the environment (<literal>\begin{eqnarray*} ... \end{eqnarray*}</literal>) will omit equation numbering entirely, while otherwise being the same as <literal>eqnarray</literal>. </para> -<indexterm role="fn"><primary>\lefteqn</primary></indexterm><para>The command <literal>\lefteqn</literal> is used for splitting long formulas across +<indexterm role="fn"><primary>\lefteqn</primary></indexterm> +<para>The command <literal>\lefteqn</literal> is used for splitting long formulas across lines. It typesets its argument in display style flush left in a box of zero width. </para> </sect1> -<sect1 label="9.9"> +<sect1 label="9.9" id="equation"> <title><literal>equation</literal></title> -<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> +<indexterm role="fn"><primary>equation <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>equations, environment for</primary></indexterm> +<indexterm role="cp"><primary>formulas, environment for</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{equation} @@ -1101,14 +1345,17 @@ zero width. \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 +environment (see <link linkend="displaymath">displaymath</link>), e.g., centering the <replaceable>math</replaceable> text on the page, and also places an equation number in the right margin. </para> </sect1> -<sect1 label="9.10"> +<sect1 label="9.10" id="figure"> <title><literal>figure</literal></title> -<indexterm role="fn"><primary>figure</primary></indexterm><indexterm role="cp"><primary>inserting figures</primary></indexterm><indexterm role="cp"><primary>figures, inserting</primary></indexterm> +<indexterm role="fn"><primary>figure</primary></indexterm> +<indexterm role="cp"><primary>inserting figures</primary></indexterm> +<indexterm role="cp"><primary>figures, inserting</primary></indexterm> + <screen>\begin{figure[*]}[<replaceable>placement</replaceable>] <replaceable>figbody</replaceable> \label{<replaceable>label}</replaceable> @@ -1116,149 +1363,204 @@ on the page, and also places an equation number in the right margin. \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. +instead “floated” to a convenient place, such as the top of a page. Figures will not be split between two pages. </para> <para>When typesetting in double-columns, the starred form produces a full-width figure (across both columns). </para> +<indexterm role="cp"><primary>placement of floats</primary></indexterm> +<indexterm role="cp"><primary>specifier, float placement</primary></indexterm> <para>The optional argument <literal>[placement]</literal> determines where &latex; will try to place your figure. There are four places where &latex; can possibly put a float: </para> -<variablelist><varlistentry><term><literal>t</literal></term> -<listitem><para>(Top)—at the top of a text page. +<variablelist><varlistentry><term><literal>t</literal> +</term><listitem><para>(Top)—at the top of a text page. </para> -</listitem></varlistentry><varlistentry><term><literal>b</literal></term> -<listitem><para>(Bottom)—at the bottom of a text page. However, <literal>b</literal> is not +</listitem></varlistentry><varlistentry><term><literal>b</literal> +</term><listitem><para>(Bottom)—at the bottom of a text page. However, <literal>b</literal> is not allowed for full-width floats (<literal>figure*</literal>) with double-column output. To ameliorate this, use the <literal>stfloats</literal> or <literal>dblfloatfix</literal> package, but see the discussion at caveats in the FAQ: <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</ulink>. </para> -</listitem></varlistentry><varlistentry><term><literal>h</literal></term> -<listitem><indexterm role="cp"><primary><literal>float</literal> package</primary></indexterm><para>(Here)—at the position in the text where the figure environment -appears. However, this is not allowed by itself, <literal>t</literal> is -automatically added. To absolutely force a figure to appear “here”, -use the <literal>float</literal> and use its <literal>H</literal> placement letter. (That -package also provides other options.) -</para> -</listitem></varlistentry><varlistentry><term><literal>p</literal></term> -<listitem><para>(Page of floats)—on a separate float page, which is a page +</listitem></varlistentry><varlistentry><term><literal>h</literal> +</term><listitem><indexterm role="cp"><primary><literal>float</literal> package</primary></indexterm> +<para>(Here)—at the position in the text where the figure environment +appears. However, this is not allowed by itself; <literal>t</literal> is +automatically added. +</para> +<indexterm role="cp"><primary>here, putting floats</primary></indexterm> +<indexterm role="cp"><primary><literal>float</literal> package</primary></indexterm> +<para>To absolutely force a figure to appear “here”, you can +<literal>\usepackage{float}</literal> and use the <literal>H</literal> specifier which it +defines. For further discussion, see the FAQ entry at +<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere</ulink>. +</para> +</listitem></varlistentry><varlistentry><term><literal>p</literal> +</term><listitem><para>(Page of floats)—on a separate float page, which is a page containing no text, only floats. </para> +</listitem></varlistentry><varlistentry><term><literal>!</literal> +</term><listitem><para>Used in addition to one of the above; for this float only, &latex; +ignores the restrictions on both the number of floats that can appear +and the relative amounts of float and non-float text on the page. +The <literal>!</literal> specifier does <emphasis>not</emphasis> mean “put the float here”; +see above. +</para> </listitem></varlistentry></variablelist> - <para>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>The body of the figure is made up of whatever text, &latex; commands, +etc. you wish. </para> -<indexterm role="fn"><primary>\caption</primary></indexterm><para>The <literal>\caption</literal> command specifies caption <replaceable>text</replaceable> for the +<indexterm role="fn"><primary>\caption</primary></indexterm> +<para>The <literal>\caption</literal> command specifies caption <replaceable>text</replaceable> for the figure. The caption is numbered by default. If <replaceable>loftitle</replaceable> is present, it is used in the list of figures instead of <replaceable>text</replaceable> -(see <xref linkend="Tables-of-contents"></xref>). +(see <link linkend="Tables-of-contents">Tables of contents</link>). </para> -<!-- xx float-placement, float-caption sections? --> -<variablelist><indexterm role="fn"><primary>\bottomfraction</primary></indexterm><para>The maximum fraction of the page allowed to be occuped by floats at -the bottom; default ‘<literal>.3</literal>’. +<para>Parameters relating to fractions of pages occupied by float and +non-float text: </para> -<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>’. +<variablelist><indexterm role="fn"><primary>\bottomfraction</primary></indexterm> +<para>The maximum fraction of the page allowed to be occuped by floats at +the bottom; default ‘<literal>.3</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>’. +<varlistentry><term><indexterm role="fn"><primary>\floatpagefraction</primary></indexterm><literal>\floatpagefraction</literal> +</term><listitem><para>The minimum fraction of a float page that must be occupied by floats; +default ‘<literal>.5</literal>’. </para> -</listitem></varlistentry><varlistentry><term><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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textfraction</primary></indexterm><literal>\textfraction</literal> +</term><listitem><para>Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is ‘<literal>.2</literal>’. </para> -</listitem></varlistentry><varlistentry><term><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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topfraction</primary></indexterm><literal>\topfraction</literal> +</term><listitem><para>Maximum fraction at the top of a page that may be occupied before +floats; default ‘<literal>.7</literal>’. +</para></listitem></varlistentry></variablelist> +<para>Parameters relating to vertical space around floats: </para> -</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>’. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\floatsep</primary></indexterm><literal>\floatsep</literal> +</term><listitem><para>Space between floats at the top or bottom of a page; default +‘<literal>12pt plus2pt minus2pt</literal>’. </para> -</listitem></varlistentry><varlistentry><term><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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\intextsep</primary></indexterm><literal>\intextsep</literal> +</term><listitem><para>Space above and below a float in the middle of the main text; default +‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and ‘<literal>11pt</literal>’ styles, +‘<literal>14pt plus4pt minus4pt</literal>’ for ‘<literal>12pt</literal>’. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textfloatsep</primary></indexterm><literal>\textfloatsep</literal> +</term><listitem><para>Space between the last (first) float at the top (bottom) of a page; +default ‘<literal>20pt plus2pt minus4pt</literal>’. +</para></listitem></varlistentry></variablelist> +<para>Parameters relating to the number of floats on a page: +</para> +<variablelist><varlistentry><term><indexterm role="fn"><primary>\bottomnumber</primary></indexterm><literal>\bottomnumber</literal> +</term><listitem><para>Maximum number of floats that can appear at the bottom of a text page; +default 1. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topnumber</primary></indexterm><literal>\topnumber</literal> +</term><listitem><para>Maximum number of floats that can appear at the top of a text page; +default 2. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\totalnumber</primary></indexterm><literal>\totalnumber</literal> +</term><listitem><para>Maximum number of floats that can appear on a text page; default 3. +</para></listitem></varlistentry></variablelist> +<para>The principal &tex; FAQ entry relating to floats: +<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats</ulink>. </para> -</listitem></varlistentry></variablelist> - </sect1> -<sect1 label="9.11"> +<sect1 label="9.11" id="flushleft"> <title><literal>flushleft</literal></title> -<indexterm role="fn"><primary>flushleft environment</primary></indexterm><indexterm role="cp"><primary>left-justifying text, environment for</primary></indexterm><indexterm role="cp"><primary>ragged right text, environment for</primary></indexterm> +<indexterm role="fn"><primary>flushleft <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>left-justifying text, environment for</primary></indexterm> +<indexterm role="cp"><primary>ragged right text, environment for</primary></indexterm> + <screen>\begin{flushleft} <replaceable>line1</replaceable> \\ <replaceable>line2</replaceable> \\ ... \end{flushleft} </screen> -<indexterm role="fn"><primary>\\ for <literal>flushleft</literal></primary></indexterm><para>The <literal>flushleft</literal> environment allows you to create a paragraph +<indexterm role="fn"><primary>\\ <lineannotation>for <literal>flushleft</literal></lineannotation></primary></indexterm> +<para>The <literal>flushleft</literal> environment allows you to create a paragraph consisting of lines that are flush to the left-hand margin and ragged right Each line must be terminated with the string <literal>\\</literal>. </para> -<sect2 label="9.11.1"> +<sect2 label="9.11.1" id="_005craggedright"> <title><literal>\raggedright</literal></title> -<indexterm role="fn"><primary>\raggedright</primary></indexterm><indexterm role="cp"><primary>ragged right text</primary></indexterm><indexterm role="cp"><primary>left-justifying text</primary></indexterm><indexterm role="cp"><primary>justification, ragged right</primary></indexterm> +<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> + <para>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 +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="9.12"> +<sect1 label="9.12" id="flushright"> <title><literal>flushright</literal></title> -<indexterm role="fn"><primary>flushright environment</primary></indexterm><indexterm role="cp"><primary>ragged left text, environment for</primary></indexterm><indexterm role="cp"><primary>right-justifying text, environment for</primary></indexterm> +<indexterm role="fn"><primary>flushright <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>ragged left text, environment for</primary></indexterm> +<indexterm role="cp"><primary>right-justifying text, environment for</primary></indexterm> + <screen>\begin{flushright} <replaceable>line1</replaceable> \\ <replaceable>line2</replaceable> \\ ... \end{flushright} </screen> -<indexterm role="fn"><primary>\\ (for <literal>flushright</literal>)</primary></indexterm><para>The <literal>flushright</literal> environment allows you to create a paragraph +<indexterm role="fn"><primary>\\ (for <literal>flushright</literal>)</primary></indexterm> +<para>The <literal>flushright</literal> environment allows you to create a paragraph consisting of lines that are flush to the right-hand margin and ragged left. Each line must be terminated with the string <literal>\\</literal>. </para> -<sect2 label="9.12.1"> +<sect2 label="9.12.1" id="_005craggedleft"> <title><literal>\raggedleft</literal></title> -<indexterm role="fn"><primary>\raggedleft</primary></indexterm><indexterm role="cp"><primary>ragged left text</primary></indexterm><indexterm role="cp"><primary>justification, ragged left</primary></indexterm><indexterm role="cp"><primary>right-justifying text</primary></indexterm> +<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> + <para>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 +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="9.13"> +<sect1 label="9.13" id="itemize"> <title><literal>itemize</literal></title> -<indexterm role="fn"><primary>itemize environment</primary></indexterm><indexterm role="fn"><primary>\item</primary></indexterm><indexterm role="cp"><primary>lists of items</primary></indexterm><indexterm role="cp"><primary>unordered lists</primary></indexterm><indexterm role="cp"><primary>bulleted lists</primary></indexterm> +<indexterm role="fn"><primary>itemize <lineannotation>environment</lineannotation></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> + <para>Synopsis: </para> <screen>\begin{itemize} @@ -1267,40 +1569,47 @@ command that ends the paragraph unit. ... \end{itemize} </screen> -<para>The <literal>itemize</literal> environment produces an “unordered”, “bulleted” +<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>). +environments, such as <literal>enumerate</literal> (see <link linkend="enumerate">enumerate</link>). </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> • (bullet) -</para></listitem> -<listitem><para> <emphasis role="bold">--<!-- /@w --></emphasis> (bold en-dash) -</para></listitem> -<listitem><para> * (asterisk) -</para></listitem> -<listitem><para> . (centered dot, rendered here as a period) -</para></listitem> -</orderedlist> -<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><para>The <literal>itemize</literal> environment uses the commands <literal>\labelitemi</literal> +<orderedlist numeration="arabic"><listitem><para>• (bullet) +</para></listitem><listitem><para><emphasis role="bold">--<!-- /@w --></emphasis> (bold en-dash) +</para></listitem><listitem><para>* (asterisk) +</para></listitem><listitem><para>. (centered dot, rendered here as a period) +</para></listitem></orderedlist> +<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> +<para>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> -<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><para>The <literal>\leftmargini</literal> through <literal>\leftmarginvi</literal> parameters define +<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> +<para>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. +<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 @@ -1308,59 +1617,58 @@ This example greatly reduces the margin space for outermost lists: <!-- 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. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\itemindent</primary></indexterm><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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\labelsep</primary></indexterm><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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\labelwidth</primary></indexterm><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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\listparindent</primary></indexterm><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>, +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightmargin</primary></indexterm><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 +<variablelist><varlistentry><term><indexterm role="fn"><primary>\itemsep</primary></indexterm><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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\parsep</primary></indexterm><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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\topsep</primary></indexterm><literal>\topsep</literal> +</term><listitem><para>Vertical space between the first item and the preceding paragraph. For top-level lists, the default is <literal>8pt plus2pt minus4pt</literal> for <literal>10pt</literal> documents, <literal>9pt plus3pt minus5pt</literal> for <literal>11pt</literal>, and <literal>10pt plus4pt minus6pt</literal> for <literal>12pt</literal>. These are reduced for nested lists. </para> -</listitem></varlistentry><varlistentry><term><literal>\partopsep</literal></term> -<listitem><para>Extra space added to <literal>\topsep</literal> when the list environment starts a +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\partopsep</primary></indexterm><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></variablelist> - -<indexterm role="fn"><primary>\parskip example</primary></indexterm><para>Especially for lists with short items, it may be desirable to elide +<indexterm role="fn"><primary>\parskip <lineannotation>example</lineannotation></primary></indexterm> +<para>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>): +see <link linkend="_005cparskip">\parskip</link>): </para> <screen>\newenvironment{itemize*}% {\begin{itemize}% @@ -1371,16 +1679,19 @@ see <xref linkend="\parskip"></xref>): </screen> </sect1> -<sect1 label="9.14"> +<sect1 label="9.14" id="letter"> <title><literal>letter</literal> environment: writing letters</title> <indexterm role="fn"><primary>letter</primary></indexterm> -<para>This environment is used for creating letters. See <xref linkend="Letters"></xref>. + +<para>This environment is used for creating letters. See <link linkend="Letters">Letters</link>. </para> </sect1> -<sect1 label="9.15"> +<sect1 label="9.15" id="list"> <title><literal>list</literal></title> -<indexterm role="fn"><primary>list</primary></indexterm><indexterm role="cp"><primary>lists of items, generic</primary></indexterm> +<indexterm role="fn"><primary>list</primary></indexterm> +<indexterm role="cp"><primary>lists of items, generic</primary></indexterm> + <para>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. @@ -1401,14 +1712,16 @@ spacing parameters for the list. This argument will most often be empty, i.e., <literal>{}</literal>, which leaves the default spacing. </para> <para>The width used for typesetting the list items is specified by -<literal>\linewidth</literal> (see <xref linkend="Page-layout-parameters"></xref>). +<literal>\linewidth</literal> (see <link linkend="Page-layout-parameters">Page layout parameters</link>). </para> </sect1> -<sect1 label="9.16"> +<sect1 label="9.16" id="math"> <title><literal>math</literal></title> -<indexterm role="fn"><primary>math environment</primary></indexterm><indexterm role="cp"><primary>in-line formulas</primary></indexterm> +<indexterm role="fn"><primary>math <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>in-line formulas</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{math} @@ -1417,55 +1730,66 @@ empty, i.e., <literal>{}</literal>, which leaves the default spacing. </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>. +See <link linkend="Math-formulas">Math formulas</link>. </para> </sect1> -<sect1 label="9.17"> +<sect1 label="9.17" id="minipage"> <title><literal>minipage</literal></title> -<indexterm role="fn"><primary>minipage environment</primary></indexterm><indexterm role="cp"><primary>minipage, creating a</primary></indexterm> +<indexterm role="fn"><primary>minipage <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>minipage, creating a</primary></indexterm> + <screen>\begin{minipage}[<replaceable>position</replaceable>][<replaceable>height</replaceable>][<replaceable>inner-pos</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. This is similar to the -<literal>\parbox</literal> command (see <xref linkend="\parbox"></xref>), but unlike <literal>\parbox</literal>, +<literal>\parbox</literal> command (see <link linkend="_005cparbox">\parbox</link>), but unlike <literal>\parbox</literal>, other paragraph-making environments can be used inside a minipage. </para> <!-- (xxref positions) --> -<para>The arguments are the same as for <literal>\parbox</literal> (see <xref linkend="\parbox"></xref>). +<para>The arguments are the same as for <literal>\parbox</literal> (see <link linkend="_005cparbox">\parbox</link>). </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><para>By default, paragraphs are not indented in the <literal>minipage</literal> +<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> +<para>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> -<indexterm role="cp"><primary>footnotes in figures</primary></indexterm><indexterm role="cp"><primary>figures, footnotes in</primary></indexterm><para>Footnotes in a <literal>minipage</literal> environment are handled in a way that is +<indexterm role="cp"><primary>footnotes in figures</primary></indexterm> +<indexterm role="cp"><primary>figures, footnotes in</primary></indexterm> +<para>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>). +<literal>footnote</literal> counter (see <link linkend="Counters">Counters</link>). </para> -<para>However, don't put one minipage inside another if you are using +<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="9.18"> +<sect1 label="9.18" id="picture"> <title><literal>picture</literal></title> -<indexterm role="fn"><primary>picture</primary></indexterm><indexterm role="cp"><primary>creating pictures</primary></indexterm><indexterm role="cp"><primary>pictures, creating</primary></indexterm> +<indexterm role="fn"><primary>picture</primary></indexterm> +<indexterm role="cp"><primary>creating pictures</primary></indexterm> +<indexterm role="cp"><primary>pictures, creating</primary></indexterm> + <screen>\begin{picture}(width,height)(x offset,y offset) -… <replaceable>picture commands</replaceable> … +… <replaceable>picture commands</replaceable> … \end{picture} </screen> -<indexterm role="fn"><primary>\unitlength</primary></indexterm><para>The <literal>picture</literal> environment allows you to create just about any +<indexterm role="fn"><primary>\unitlength</primary></indexterm> +<para>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 +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 @@ -1483,7 +1807,7 @@ the parentheses serve to delimit the argument. <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. +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 @@ -1503,10 +1827,10 @@ origin at the lower-left corner. If you then want to modify your picture by shifting everything, you can just add the appropriate optional argument. </para> -<para>The environment's mandatory argument determines the nominal size of the +<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 +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> @@ -1515,11 +1839,12 @@ command. The command <screen>\put (11.3,-.3){...} </screen> <para>puts the object specified by <literal>...</literal> in the -picture, with its reference point at coordinates (11.3,-.3). +picture, with its reference point at coordinates <inlineequation><mathphrase>(11.3,-.3)</mathphrase></inlineequation>. The reference points for various objects will be described below. </para> -<indexterm role="fn"><primary>lR box</primary></indexterm><para>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 +<indexterm role="fn"><primary>lR box</primary></indexterm> +<para>The <literal>\put</literal> command creates an <firstterm>LR box</firstterm>. You can put anything +that can go in an <literal>\mbox</literal> (see <link linkend="_005cmbox">\mbox</link>) 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> @@ -1527,9 +1852,10 @@ be the lower left corner of the box. </para> -<sect2 label="9.18.1"> +<sect2 label="9.18.1" id="_005ccircle"> <title><literal>\circle</literal></title> <indexterm role="fn"><primary>\circle</primary></indexterm> + <screen>\circle[*]{<replaceable>diameter</replaceable>} </screen> <para>The <literal>\circle</literal> command produces a circle with a diameter as close @@ -1540,9 +1866,10 @@ draws a solid circle. </para> </sect2> -<sect2 label="9.18.2"> +<sect2 label="9.18.2" id="_005cmakebox-_0028picture_0029"> <title><literal>\makebox</literal></title> <indexterm role="fn"><primary>\makebox (picture)</primary></indexterm> + <para><literal>\makebox(width,height)[position]{...}</literal> </para> <para>The <literal>\makebox</literal> command for the picture environment is similar to @@ -1552,27 +1879,27 @@ the normal <literal>\makebox</literal> command except that you must specify a <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> -<variablelist><varlistentry><term><literal>t</literal></term> -<listitem><para>Moves the item to the top of the rectangle. +<variablelist><varlistentry><term><literal>t</literal> +</term><listitem><para>Moves the item to the top of the rectangle. </para> -</listitem></varlistentry><varlistentry><term><literal>b</literal></term> -<listitem><para>Moves the item to the bottom. +</listitem></varlistentry><varlistentry><term><literal>b</literal> +</term><listitem><para>Moves the item to the bottom. </para> -</listitem></varlistentry><varlistentry><term><literal>l</literal></term> -<listitem><para>Moves the item to the left. +</listitem></varlistentry><varlistentry><term><literal>l</literal> +</term><listitem><para>Moves the item to the left. </para> -</listitem></varlistentry><varlistentry><term><literal>r</literal></term> -<listitem><para>Moves the item to the right. +</listitem></varlistentry><varlistentry><term><literal>r</literal> +</term><listitem><para>Moves the item to the right. </para> </listitem></varlistentry></variablelist> - -<para>See <xref linkend="\makebox"></xref>. +<para>See <link linkend="_005cmakebox">\makebox</link>. </para> </sect2> -<sect2 label="9.18.3"> +<sect2 label="9.18.3" id="_005cframebox-_0028picture_0029"> <title><literal>\framebox</literal></title> <indexterm role="fn"><primary>\framebox</primary></indexterm> + <para>Synopsis: </para> <screen>\framebox(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>pos</replaceable>]{...} @@ -1581,16 +1908,19 @@ your text appears in. You may select up to two of the following: section), except that it puts a frame around the outside of the box that it creates. </para> -<indexterm role="fn"><primary>\fboxrule</primary></indexterm><indexterm role="fn"><primary>\fboxsep</primary></indexterm><para>The <literal>\framebox</literal> command produces a rule of thickness +<indexterm role="fn"><primary>\fboxrule</primary></indexterm> +<indexterm role="fn"><primary>\fboxsep</primary></indexterm> +<para>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="9.18.4"> +<sect2 label="9.18.4" id="_005cdashbox"> <title><literal>\dashbox</literal></title> <indexterm role="fn"><primary>\dashbox</primary></indexterm> + <para>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>} @@ -1605,9 +1935,10 @@ multiples of the <literal>dlen</literal>. </para> </sect2> -<sect2 label="9.18.5"> +<sect2 label="9.18.5" id="_005cframe"> <title><literal>\frame</literal></title> <indexterm role="fn"><primary>\frame</primary></indexterm> + <para>Synopsis: </para> <screen>\frame{<replaceable>text</replaceable>} @@ -1618,9 +1949,10 @@ space is put between the frame and the object. </para> </sect2> -<sect2 label="9.18.6"> +<sect2 label="9.18.6" id="_005cline"> <title><literal>\line</literal></title> <indexterm role="fn"><primary>\line</primary></indexterm> + <para>Synopsis: </para> <screen>\line(<replaceable>xslope</replaceable>,<replaceable>yslope</replaceable>){<replaceable>length</replaceable>} @@ -1628,16 +1960,17 @@ space is put between the frame and the object. <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, +<para>Standard &latex; can only draw lines with <inlineequation><mathphrase><replaceable>slope</replaceable> = x/y</mathphrase></inlineequation>, +where <inlineequation><mathphrase>x</mathphrase></inlineequation> and <inlineequation><mathphrase>y</mathphrase></inlineequation> 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="9.18.7"> +<sect2 label="9.18.7" id="_005clinethickness"> <title><literal>\linethickness</literal></title> <indexterm role="fn"><primary>\linethickness</primary></indexterm> + <para>The <literal>\linethickness{<replaceable>dim</replaceable>}</literal> command declares the thickness of horizontal and vertical lines in a picture environment to be <replaceable>dim</replaceable>, which must be a positive length. @@ -1647,40 +1980,44 @@ circles, or the quarter circles drawn by <literal>\oval</literal>. </para> </sect2> -<sect2 label="9.18.8"> +<sect2 label="9.18.8" id="_005cthicklines"> <title><literal>\thicklines</literal></title> <indexterm role="fn"><primary>\thicklines</primary></indexterm> + <para>The <literal>\thicklines</literal> command is an alternate line thickness for horizontal and vertical lines in a picture environment; -cf. <xref linkend="\linethickness"></xref> and <xref linkend="\thinlines"></xref>. +cf. <link linkend="_005clinethickness">\linethickness</link> and <link linkend="_005cthinlines">\thinlines</link>. </para> </sect2> -<sect2 label="9.18.9"> +<sect2 label="9.18.9" id="_005cthinlines"> <title><literal>\thinlines</literal></title> <indexterm role="fn"><primary>\thinlines</primary></indexterm> + <para>The <literal>\thinlines</literal> command is the default line thickness for horizontal and vertical lines in a picture environment; -cf. <xref linkend="\linethickness"></xref> and <xref linkend="\thicklines"></xref>. +cf. <link linkend="_005clinethickness">\linethickness</link> and <link linkend="_005cthicklines">\thicklines</link>. </para> </sect2> -<sect2 label="9.18.10"> +<sect2 label="9.18.10" id="_005cmultiput"> <title><literal>\multiput</literal></title> <indexterm role="fn"><primary>\multiput</primary></indexterm> + <para>Synopsis: </para><screen>\multiput(<replaceable>x</replaceable>,<replaceable>y</replaceable>)(<replaceable>delta_x</replaceable>,<replaceable>delta_y</replaceable>){<replaceable>n</replaceable>}{<replaceable>obj</replaceable>} </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, +<inlineequation><mathphrase>(x,y)</mathphrase></inlineequation>, then at <inlineequation><mathphrase>(x+\delta x,y+\delta y)</mathphrase></inlineequation>, and so on, <replaceable>n</replaceable> times. </para> </sect2> -<sect2 label="9.18.11"> +<sect2 label="9.18.11" id="_005coval"> <title><literal>\oval</literal></title> <indexterm role="fn"><primary>\oval</primary></indexterm> + <para>Synopsis: </para> <screen>\oval(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>portion</replaceable>] @@ -1689,26 +2026,26 @@ pattern across a picture. <replaceable>obj</replaceable> is first placed at pos 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. +<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 +<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="9.18.12"> +<sect2 label="9.18.12" id="_005cput"> <title><literal>\put</literal></title> <indexterm role="fn"><primary>\put</primary></indexterm> + <para><literal>\put(x coord,y coord){ ... }</literal> </para> <para>The <literal>\put</literal> command places the item specified by the mandatory @@ -1716,9 +2053,10 @@ argument at the given coordinates. </para> </sect2> -<sect2 label="9.18.13"> +<sect2 label="9.18.13" id="_005cshortstack"> <title><literal>\shortstack</literal></title> <indexterm role="fn"><primary>\shortstack</primary></indexterm> + <para>Synopsis: </para> <screen>\shortstack[<replaceable>position</replaceable>]{...\\...\\...} @@ -1726,36 +2064,41 @@ argument at the given coordinates. <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) +<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> - -<indexterm role="fn"><primary>\\ (for <literal>\shortstack</literal> objects)</primary></indexterm><para>Objects are separated with <literal>\\</literal>. +<indexterm role="fn"><primary>\\ <lineannotation>(for <literal>\shortstack</literal> objects)</lineannotation></primary></indexterm> +<para>Objects are separated with <literal>\\</literal>. </para> </sect2> -<sect2 label="9.18.14"> +<sect2 label="9.18.14" id="_005cvector"> <title><literal>\vector</literal></title> <indexterm role="fn"><primary>\vector</primary></indexterm> + <para>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. +length and slope. The <inlineequation><mathphrase>x</mathphrase></inlineequation> and <inlineequation><mathphrase>y</mathphrase></inlineequation> values must lie between +−4 and +4, inclusive. </para> </sect2> </sect1> -<sect1 label="9.19"> +<sect1 label="9.19" id="quotation"> <title><literal>quotation</literal></title> -<indexterm role="fn"><primary>quotation</primary></indexterm><indexterm role="cp"><primary>quoted text with paragraph indentation, displaying</primary></indexterm><indexterm role="cp"><primary>displaying quoted text with paragraph indentation</primary></indexterm><indexterm role="cp"><primary>paragraph indentations in quoted text</primary></indexterm> +<indexterm role="fn"><primary>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> + <para>Synopsis: </para> <screen>\begin{quotation} @@ -1771,10 +2114,14 @@ normally. </para> </sect1> -<sect1 label="9.20"> +<sect1 label="9.20" id="quote"> <title><literal>quote</literal></title> -<indexterm role="fn"><primary>quote</primary></indexterm><indexterm role="cp"><primary>quoted text without paragraph indentation, displaying</primary></indexterm><indexterm role="cp"><primary>displaying quoted text without paragraph indentation</primary></indexterm><indexterm role="cp"><primary>paragraph indentations in quoted text, omitting</primary></indexterm> +<indexterm role="fn"><primary>quote</primary></indexterm> +<indexterm role="cp"><primary>quoted text without paragraph indentation, displaying</primary></indexterm> +<indexterm role="cp"><primary>displaying quoted text without paragraph indentation</primary></indexterm> +<indexterm role="cp"><primary>paragraph indentations in quoted text, omitting</primary></indexterm> + <para>Snyopsis: </para> <screen>\begin{quote} @@ -1789,10 +2136,14 @@ blank line between text produces a new paragraph. </para> </sect1> -<sect1 label="9.21"> +<sect1 label="9.21" id="tabbing"> <title><literal>tabbing</literal></title> -<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> +<indexterm role="fn"><primary>tabbing <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>tab stops, using</primary></indexterm> +<indexterm role="cp"><primary>lining text up using tab stops</primary></indexterm> +<indexterm role="cp"><primary>alignment via tabbing</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{tabbing} @@ -1811,67 +2162,71 @@ 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. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\\ <lineannotation>(tabbing)</lineannotation></primary></indexterm><literal>\\ <lineannotation>(tabbing)</lineannotation></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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\= <lineannotation>(tabbing)</lineannotation></primary></indexterm><literal>\= <lineannotation>(tabbing)</lineannotation></literal> +</term><listitem><para>Sets a tab stop at the current position. </para> -</listitem></varlistentry><varlistentry><term><literal>\> (tabbing)</literal></term> -<listitem><indexterm role="fn"><primary>\></primary></indexterm><para>Advances to the next tab stop. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\> <lineannotation>(tabbing)</lineannotation></primary></indexterm><literal>\> <lineannotation>(tabbing)</lineannotation></literal> +</term><listitem><indexterm role="fn"><primary>\></primary></indexterm> +<para>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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\<</primary></indexterm><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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\+</primary></indexterm><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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\-</primary></indexterm><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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\’ <lineannotation>(tabbing)</lineannotation></primary></indexterm><literal>\' <lineannotation>(tabbing)</lineannotation></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. +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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\‘ <lineannotation>(tabbing)</lineannotation></primary></indexterm><literal>\` <lineannotation>(tabbing)</lineannotation></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><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><para>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, +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\a <lineannotation>(tabbing)</lineannotation></primary></indexterm><literal>\a <lineannotation>(tabbing)</lineannotation></literal> +</term><listitem><indexterm role="fn"><primary>\a’ <lineannotation>(acute accent in tabbing)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\a‘ <lineannotation>(grave accent in tabbing)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\a= <lineannotation>(macron accent in tabbing)</lineannotation></primary></indexterm> +<para>In a <literal>tabbing</literal> environment, the commands <literal>\=</literal>, <literal>\'</literal> and +<literal>\`</literal> do not produce accents as usual (see <link linkend="Accents">Accents</link>). 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> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\kill</primary></indexterm><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><indexterm role="fn"><primary>\poptabs</primary></indexterm><para>Restores the tab stop positions saved by the last <literal>\pushtabs</literal>. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\poptabs</primary></indexterm><literal>\poptabs</literal> +</term><listitem><indexterm role="fn"><primary>\poptabs</primary></indexterm> +<para>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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\pushtabs</primary></indexterm><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>. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tabbingsep</primary></indexterm><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} @@ -1886,10 +2241,13 @@ function \= fact(n : integer) : integer;\\ </screen> </sect1> -<sect1 label="9.22"> +<sect1 label="9.22" id="table"> <title><literal>table</literal></title> -<indexterm role="fn"><primary>table</primary></indexterm><indexterm role="cp"><primary>tables, creating</primary></indexterm><indexterm role="cp"><primary>creating tables</primary></indexterm> +<indexterm role="fn"><primary>table</primary></indexterm> +<indexterm role="cp"><primary>tables, creating</primary></indexterm> +<indexterm role="cp"><primary>creating tables</primary></indexterm> + <para>Synopsis: </para> <screen> \begin{table}[placement] @@ -1900,13 +2258,13 @@ function \= fact(n : integer) : integer;\\ \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. +usually “floated” to a convenient place, like the top of a page. Tables will not be split between two pages. </para> <para>The optional argument <literal>[placement]</literal> determines where &latex; will try to place your table. There are four places where &latex; can possibly put a float; these are the same as that used with the <literal>figure</literal> -environment, and described there (see <xref linkend="figure"></xref>). +environment, and described there (see <link linkend="figure">figure</link>). </para> <para>The standard <literal>report</literal> and <literal>article</literal> classes use the default placement <literal>[tbp]</literal>. @@ -1916,9 +2274,12 @@ you wish. The <literal>\caption</literal> command allows you to title your tabl </para> </sect1> -<sect1 label="9.23"> +<sect1 label="9.23" id="tabular"> <title><literal>tabular</literal></title> -<indexterm role="fn"><primary>tabular environment</primary></indexterm><indexterm role="cp"><primary>lines in tables</primary></indexterm><indexterm role="cp"><primary>lining text up in tables</primary></indexterm> +<indexterm role="fn"><primary>tabular <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>lines in tables</primary></indexterm> +<indexterm role="cp"><primary>lining text up in tables</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{tabular}[pos]{cols} @@ -1926,7 +2287,7 @@ column 1 entry & column 2 entry ... & column n entry \\ ... \end{tabular} </screen> -<para> or +<para>or </para> <screen>\begin{tabular*}{width}[pos]{cols} column 1 entry & column 2 entry ... & column n entry \\ @@ -1936,109 +2297,110 @@ column 1 entry & column 2 entry ... & column n entry \\ <para>These environments produce a box consisting of a sequence of rows of items, aligned vertically in columns. </para> -<indexterm role="fn"><primary>\\ for <literal>tabular</literal></primary></indexterm><para><literal>\\</literal> must be used to specify the end of each row of the table, -except for the last, where it is optional—unless an <literal>\hline</literal> +<indexterm role="fn"><primary>\\ <lineannotation>for <literal>tabular</literal></lineannotation></primary></indexterm> +<para><literal>\\</literal> must be used to specify the end of each row of the table, +except for the last, where it is optional—unless an <literal>\hline</literal> command (to put a rule below the table) follows. </para> <para>The mandatory and optional arguments consist of: </para> -<variablelist><varlistentry><term><literal>width</literal></term> -<listitem><para>Specifies the width of the <literal>tabular*</literal> environment. There must be +<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 +</listitem></varlistentry><varlistentry><term><literal>pos</literal> +</term><listitem><para>Specifies the vertical position; default is alignment on the centre of the environment. </para> -<variablelist><varlistentry><term><literal>t</literal></term> -<listitem><para>align on top row -</para></listitem></varlistentry><varlistentry><term><literal>b</literal></term> -<listitem><para>align on bottom row +<variablelist><varlistentry><term><literal>t</literal> +</term><listitem><para>align on top row +</para> +</listitem></varlistentry><varlistentry><term><literal>b</literal> +</term><listitem><para>align on bottom row </para></listitem></varlistentry></variablelist> - -</listitem></varlistentry><varlistentry><term><literal>cols</literal></term> -<listitem><para>Specifies the column formatting. It consists of a sequence of the +</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> -<variablelist><varlistentry><term><literal>l</literal></term> -<listitem><para>A column of left-aligned items. +<variablelist><varlistentry><term><literal>l</literal> +</term><listitem><para>A column of left-aligned items. </para> -</listitem></varlistentry><varlistentry><term><literal>r</literal></term> -<listitem><para>A column of right-aligned items. +</listitem></varlistentry><varlistentry><term><literal>r</literal> +</term><listitem><para>A column of right-aligned items. </para> -</listitem></varlistentry><varlistentry><term><literal>c</literal></term> -<listitem><para>A column of centered items. +</listitem></varlistentry><varlistentry><term><literal>c</literal> +</term><listitem><para>A column of centered items. </para> -</listitem></varlistentry><varlistentry><term><literal>|</literal></term> -<listitem><para>A vertical line the full height and depth of the environment. +</listitem></varlistentry><varlistentry><term><literal>|</literal> +</term><listitem><para>A vertical line the full height and depth of the environment. </para> -</listitem></varlistentry><varlistentry><term><literal>@{<replaceable>text</replaceable>}</literal></term> -<listitem><para>This inserts <replaceable>text</replaceable> in every row. An @-expression suppresses the +</listitem></varlistentry><varlistentry><term><literal>@{<replaceable>text</replaceable>}</literal> +</term><listitem><para>This inserts <replaceable>text</replaceable> in every row. An @-expression suppresses the intercolumn space normally inserted between columns; any desired space -between the inserted text and the adjacent items must be included in -<replaceable>text</replaceable>. 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></varlistentry><varlistentry><term><literal>p{<replaceable>wd</replaceable>}</literal></term> -<listitem><para>Produces a column with each item typeset in a parbox of width +before the adjacent item must be included in <replaceable>text</replaceable>. +</para> +<para>To insert commands that are automatically executed before a given +column, you have to load the <literal>array</literal> package and use the +<literal>>{...}</literal> specifier. +<!-- xx should fully explain array, tabularx, and all other base packages... --> +</para> +<indexterm role="fn"><primary>\extracolsep</primary></indexterm> +<para>An <literal>\extracolsep{wd}</literal> command in an @-expression causes an +extra space of width <literal>wd</literal> to appear to the left of all subsequent +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></varlistentry><varlistentry><term><literal>p{<replaceable>wd</replaceable>}</literal> +</term><listitem><para>Produces a column with each item typeset in a parbox of width <replaceable>wd</replaceable>, as if it were the argument of a <literal>\parbox[t]{<replaceable>wd</replaceable>}</literal> command. However, a <literal>\\</literal> may not appear in the item, except in the following situations: </para> -<orderedlist numeration="arabic"><listitem> -<para>inside an environment like <literal>minipage</literal>, <literal>array</literal>, or <literal>tabular</literal>. -</para></listitem> -<listitem> -<para>inside an explicit <literal>\parbox</literal>. -</para></listitem> -<listitem> -<para>in the scope of a <literal>\centering</literal>, <literal>\raggedright</literal>, or <literal>\raggedleft</literal> +<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></varlistentry><varlistentry><term><literal>*{<replaceable>num</replaceable>}{<replaceable>cols</replaceable>}</literal></term> -<listitem><para>Equivalent to <replaceable>num</replaceable> copies of <replaceable>cols</replaceable>, where <replaceable>num</replaceable> is a +</para></listitem></orderedlist> +</listitem></varlistentry><varlistentry><term><literal>*{<replaceable>num</replaceable>}{<replaceable>cols</replaceable>}</literal> +</term><listitem><para>Equivalent to <replaceable>num</replaceable> copies of <replaceable>cols</replaceable>, where <replaceable>num</replaceable> is a positive integer and <replaceable>cols</replaceable> is any list of column-specifiers, which may contain another <literal>*-expression</literal>. </para> -</listitem></varlistentry></variablelist> -</listitem></varlistentry></variablelist> - +</listitem></varlistentry></variablelist></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 +<variablelist><varlistentry><term><indexterm role="fn"><primary>\arrayrulewidth</primary></indexterm><literal>\arrayrulewidth</literal> +</term><listitem><para>Thickness of the rule created by <literal>|</literal>, <literal>\hline</literal>, and <literal>\vline</literal> in the <literal>tabular</literal> and <literal>array</literal> environments; the -default is ‘<literal>.4pt</literal>’. +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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\arraystretch</primary></indexterm><literal>\arraystretch</literal> +</term><listitem><para>Scaling of spacing between rows in the <literal>tabular</literal> and <literal>array</literal> +environments; default is ‘<literal>1</literal>’, for no scaling. </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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\doublerulesep</primary></indexterm><literal>\doublerulesep</literal> +</term><listitem><para>Horizontal distance between the vertical rules produced by <literal>||</literal> +in the <literal>tabular</literal> and <literal>array</literal> environments; default is ‘<literal>2pt</literal>’. </para> -</listitem></varlistentry><varlistentry><term><literal>\tabcolsep</literal></term> -<listitem><para>Half the width of the space between columns; default is ‘<literal>6pt</literal>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tabcolsep</primary></indexterm><literal>\tabcolsep</literal> +</term><listitem><para>Half the width of the space between columns; default is ‘<literal>6pt</literal>’. </para> </listitem></varlistentry></variablelist> - -<para>These commands can be used inside a <literal>tabular</literal> environment: +<para>The following commands can be used inside a <literal>tabular</literal> +environment: </para> -<sect2 label="9.23.1"> +<sect2 label="9.23.1" id="_005cmulticolumn"> <title><literal>\multicolumn</literal></title> <indexterm role="fn"><primary>\multicolumn</primary></indexterm> + <para>Synopsis: </para><screen>\multicolumn{<replaceable>cols</replaceable>}{<replaceable>pos</replaceable>}{<replaceable>text</replaceable>} </screen> @@ -2049,7 +2411,7 @@ specifies the formatting of the entry; <literal>c</literal> for centered, <liter 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; +<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} @@ -2061,9 +2423,10 @@ for flushleft, <literal>r</literal> for flushright. The third mandatory argumen </screen> </sect2> -<sect2 label="9.23.2"> +<sect2 label="9.23.2" id="_005ccline"> <title><literal>\cline</literal></title> <indexterm role="fn"><primary>\cline</primary></indexterm> + <para>Synopsis: </para> <screen>\cline{<replaceable>i</replaceable>-<replaceable>j</replaceable>} @@ -2074,19 +2437,21 @@ which are specified in the mandatory argument. </para> </sect2> -<sect2 label="9.23.3"> +<sect2 label="9.23.3" id="_005chline"> <title><literal>\hline</literal></title> <indexterm role="fn"><primary>\hline</primary></indexterm> + <para>The <literal>\hline</literal> command draws a horizontal line the width of the -enclosing <literal>tabular</literal> or <literal>array</literal> environment. It's most +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="9.23.4"> +<sect2 label="9.23.4" id="_005cvline"> <title><literal>\vline</literal></title> <indexterm role="fn"><primary>\vline</primary></indexterm> + <para>The <literal>\vline</literal> command will draw a vertical line extending the full height and depth of its row. An <literal>\hfill</literal> command can be used to move the line to the edge of the column. It can also be used in an @@ -2095,10 +2460,12 @@ move the line to the edge of the column. It can also be used in an </sect2> </sect1> -<sect1 label="9.24"> +<sect1 label="9.24" id="thebibliography"> <title><literal>thebibliography</literal></title> -<indexterm role="fn"><primary>thebibliography</primary></indexterm><indexterm role="cp"><primary>bibliography, creating (manually)</primary></indexterm> +<indexterm role="fn"><primary>thebibliography</primary></indexterm> +<indexterm role="cp"><primary>bibliography, creating (manually)</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{thebibliography}{<replaceable>widest-label</replaceable>} @@ -2110,8 +2477,8 @@ move the line to the edge of the column. It can also be used in an 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) +“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> @@ -2124,10 +2491,11 @@ less than 10 references, <literal>99</literal> for ones with less than 100, etc. </para> -<sect2 label="9.24.1"> +<sect2 label="9.24.1" id="_005cbibitem"> <title><literal>\bibitem</literal></title> <indexterm role="fn"><primary>\bibitem</primary></indexterm> + <para>Synopsis: </para><screen>\bibitem[<replaceable>label</replaceable>]{<replaceable>cite_key</replaceable>} </screen> @@ -2138,18 +2506,19 @@ automatically generated using the <literal>enumi</literal> counter. The 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 +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="9.24.2"> +<sect2 label="9.24.2" id="_005ccite"> <title><literal>\cite</literal></title> <indexterm role="fn"><primary>\cite</primary></indexterm> + <para>Synopsis: </para> <screen>\cite[<replaceable>subcite</replaceable>]{<replaceable>keys</replaceable> @@ -2161,13 +2530,14 @@ the references associated with <replaceable>keys</replaceable> by entries in the </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]'. +‘[Knuth, p. 314]’. </para> </sect2> -<sect2 label="9.24.3"> +<sect2 label="9.24.3" id="_005cnocite"> <title><literal>\nocite</literal></title> <indexterm role="fn"><primary>\nocite</primary></indexterm> + <para><literal>\nocite{key_list}</literal> </para> <para>The <literal>\nocite</literal> command produces no text, but writes <literal>key_list</literal>, @@ -2178,11 +2548,16 @@ which is a list of one or more citation keys, on the <filename>.aux</filename> f <sect2 label="9.24.4" id="Using-BibTeX"> <title>Using Bib&tex;</title> -<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> +<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> + <para>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, +titles) to maintain your bibliography, you don’t use the +<literal>thebibliography</literal> environment (see <link linkend="thebibliography">thebibliography</link>). Instead, you include the lines </para> <screen>\bibliographystyle{<replaceable>bibstyle</replaceable>} @@ -2194,17 +2569,16 @@ 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 +<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><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>. @@ -2218,27 +2592,32 @@ Bib&tex; format. Only the entries referred to via <literal>\cite</literal> and </sect2> </sect1> -<sect1 label="9.25"> +<sect1 label="9.25" id="theorem"> <title><literal>theorem</literal></title> -<indexterm role="fn"><primary>theorem environment</primary></indexterm><indexterm role="cp"><primary>theorems, typesetting</primary></indexterm> +<indexterm role="fn"><primary>theorem <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>theorems, typesetting</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{theorem} <replaceable>theorem-text</replaceable> \end{theorem} </screen> -<para>The <literal>theorem</literal> environment produces “Theorem <replaceable>n</replaceable>” in +<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>). +(see <link linkend="_005cnewtheorem">\newtheorem</link>). </para> </sect1> -<sect1 label="9.26"> +<sect1 label="9.26" id="titlepage"> <title><literal>titlepage</literal></title> -<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> +<indexterm role="fn"><primary>titlepage <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>making a title page</primary></indexterm> +<indexterm role="cp"><primary>title pages, creating</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{titlepage} @@ -2249,17 +2628,23 @@ possibilities for <replaceable>n</replaceable> are described under <literal>\new 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>). +(see <link linkend="_005ctoday">\today</link>). </para> -<para>You can use the <literal>\maketitle</literal> command (see <xref linkend="\maketitle"></xref>) to +<para>You can use the <literal>\maketitle</literal> command (see <link linkend="_005cmaketitle">\maketitle</link>) to produce a standard title page without a <literal>titlepage</literal> environment. </para> </sect1> -<sect1 label="9.27"> +<sect1 label="9.27" id="verbatim"> <title><literal>verbatim</literal></title> -<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> +<indexterm role="fn"><primary>verbatim <lineannotation>environment</lineannotation></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> + <para>Synopsis: </para> <screen>\begin{verbatim} @@ -2268,17 +2653,19 @@ produce a standard title page without a <literal>titlepage</literal> environment </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; +<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="9.27.1"> +<sect2 label="9.27.1" id="_005cverb"> <title><literal>\verb</literal></title> -<indexterm role="fn"><primary>\verb</primary></indexterm><indexterm role="cp"><primary>verbatim text, inline</primary></indexterm> +<indexterm role="fn"><primary>\verb</primary></indexterm> +<indexterm role="cp"><primary>verbatim text, inline</primary></indexterm> + <para>Synopsis: </para> <screen>\verb<replaceable>char</replaceable><replaceable>literal-text</replaceable><replaceable>char</replaceable> @@ -2290,16 +2677,19 @@ including special characters and spaces, using the typewriter <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> -<indexterm role="cp"><primary>visible space</primary></indexterm><para>The <literal>*</literal>-form differs only in that spaces are printed with a -“visible space” character. +<indexterm role="cp"><primary>visible space</primary></indexterm> +<para>The <literal>*</literal>-form differs only in that spaces are printed with a +“visible space” character. </para> </sect2> </sect1> -<sect1 label="9.28"> +<sect1 label="9.28" id="verse"> <title><literal>verse</literal></title> -<indexterm role="fn"><primary>verse environment</primary></indexterm><indexterm role="cp"><primary>poetry, an environment for</primary></indexterm> +<indexterm role="fn"><primary>verse <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>poetry, an environment for</primary></indexterm> + <para>Synopsis: </para> <screen>\begin{verse} @@ -2311,7 +2701,8 @@ verbatim text. The delimiter must not appear in <replaceable>literal-text</repl <para>The <literal>verse</literal> environment is designed for poetry, though you may find other uses for it. </para> -<indexterm role="fn"><primary>\\ for <literal>verse</literal></primary></indexterm><para>The margins are indented on the left and the right, paragraphs are not +<indexterm role="fn"><primary>\\ <lineannotation>for <literal>verse</literal></lineannotation></primary></indexterm> +<para>The margins are indented on the left and the right, paragraphs are not indented, and the text is not justified. Separate the lines of each stanza with <literal>\\</literal>, and use one or more blank lines to separate the stanzas. @@ -2321,7 +2712,9 @@ stanzas. </chapter> <chapter label="10" id="Line-breaking"> <title>Line breaking</title> -<indexterm role="cp"><primary>line breaking</primary></indexterm><indexterm role="cp"><primary>breaking lines</primary></indexterm> +<indexterm role="cp"><primary>line breaking</primary></indexterm> +<indexterm role="cp"><primary>breaking lines</primary></indexterm> + <para>The first thing &latex; does when processing ordinary text is to translate your input file into a sequence of glyphs and spaces. To produce a printed document, this sequence must be broken into lines @@ -2333,9 +2726,12 @@ some environments, you do the line breaking yourself with the </para> -<sect1 label="10.1"> +<sect1 label="10.1" id="_005c_005c"> <title><literal>\\</literal>[*][<replaceable>morespace</replaceable>]</title> -<indexterm role="fn"><primary>\\ force line break</primary></indexterm><indexterm role="cp"><primary>new line, starting</primary></indexterm><indexterm role="cp"><primary>line break, forcing</primary></indexterm> +<indexterm role="fn"><primary>\\ <lineannotation>force line break</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>new line, starting</primary></indexterm> +<indexterm role="cp"><primary>line break, forcing</primary></indexterm> + <para>The <literal>\\</literal> command tells &latex; to start a new line. It has an optional argument, <replaceable>morespace</replaceable>, that specifies how much extra vertical space is to be inserted before the next line. This can be a @@ -2346,11 +2742,14 @@ except that it tells &latex; not to start a new page after the line. </para> </sect1> -<sect1 label="10.2"> +<sect1 label="10.2" id="_005cobeycr-_0026-_005crestorecr"> <title><literal>\obeycr</literal> & <literal>\restorecr</literal></title> -<indexterm role="fn"><primary>\obeycr</primary></indexterm><indexterm role="fn"><primary>\restorecr</primary></indexterm><indexterm role="cp"><primary>new line, output as input</primary></indexterm> +<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> + <para>The <literal>\obeycr</literal> command makes a return in the input file -(‘<literal>^^M</literal>’, internally) the same as <literal>\\</literal> (followed by +(‘<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> @@ -2358,18 +2757,22 @@ in the output. </para> </sect1> -<sect1 label="10.3"> +<sect1 label="10.3" id="_005cnewline"> <title><literal>\newline</literal></title> -<indexterm role="fn"><primary>\newline</primary></indexterm><indexterm role="cp"><primary>new line, starting (paragraph mode)</primary></indexterm> +<indexterm role="fn"><primary>\newline</primary></indexterm> +<indexterm role="cp"><primary>new line, starting (paragraph mode)</primary></indexterm> + <para>The <literal>\newline</literal> command breaks the line at the present point, with no stretching of the text before it. It can only be used in paragraph mode. </para> </sect1> -<sect1 label="10.4"> +<sect1 label="10.4" id="_005c_002d-_0028hyphenation_0029"> <title><literal>\-</literal> (discretionary hyphen)</title> -<indexterm role="fn"><primary>\- (hyphenation)</primary></indexterm><indexterm role="cp"><primary>hyphenation, forcing</primary></indexterm> +<indexterm role="fn"><primary>\- <lineannotation>(hyphenation)</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>hyphenation, forcing</primary></indexterm> + <para>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 @@ -2383,32 +2786,35 @@ that &latex; might otherwise have chosen. </sect1> -<sect1 label="10.5"> +<sect1 label="10.5" id="_005cfussy"> <title><literal>\fussy</literal></title> <indexterm role="fn"><primary>\fussy</primary></indexterm> + <para>The declaration <literal>\fussy</literal> (which is the default) makes &tex; 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>. +(see <link linkend="_005csloppy">\sloppy</link>. </para> </sect1> -<sect1 label="10.6"> +<sect1 label="10.6" id="_005csloppy"> <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>Lasts until a <literal>\fussy</literal> command is issued (see <link linkend="_005cfussy">\fussy</link>). </para> </sect1> -<sect1 label="10.7"> +<sect1 label="10.7" id="_005chyphenation"> <title><literal>\hyphenation</literal></title> -<indexterm role="fn"><primary>\hyphenation</primary></indexterm><indexterm role="cp"><primary>hyphenation, defining</primary></indexterm> +<indexterm role="fn"><primary>\hyphenation</primary></indexterm> +<indexterm role="cp"><primary>hyphenation, defining</primary></indexterm> + <para>Synopsis: </para> <screen>\hyphenation{<replaceable>word-one</replaceable> <replaceable>word-two</replaceable>} @@ -2424,9 +2830,13 @@ misses the hyphenations in these words): </screen> </sect1> -<sect1 label="10.8"> +<sect1 label="10.8" id="_005clinebreak-_0026-_005cnolinebreak"> <title><literal>\linebreak</literal> & <literal>\nolinebreak</literal></title> -<indexterm role="fn"><primary>\linebreak</primary></indexterm><indexterm role="fn"><primary>\nolinebreak</primary></indexterm><indexterm role="cp"><primary>line breaks, forcing</primary></indexterm><indexterm role="cp"><primary>line breaks, preventing</primary></indexterm> +<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> + <para>Synopses: </para> <screen>\linebreak[<replaceable>priority</replaceable>] @@ -2439,24 +2849,28 @@ 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. +0 to 4. The higher the number, the more insistent the request. </para> </sect1> </chapter> <chapter label="11" id="Page-breaking"> <title>Page breaking</title> -<indexterm role="cp"><primary>page breaking</primary></indexterm><indexterm role="cp"><primary>breaking pages</primary></indexterm> +<indexterm role="cp"><primary>page breaking</primary></indexterm> +<indexterm role="cp"><primary>breaking pages</primary></indexterm> + <para>&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="11.1"> +<sect1 label="11.1" id="_005ccleardoublepage"> <title><literal>\cleardoublepage</literal></title> -<indexterm role="fn"><primary>\cleardoublepage</primary></indexterm><indexterm role="cp"><primary>starting on a right-hand page</primary></indexterm> +<indexterm role="fn"><primary>\cleardoublepage</primary></indexterm> +<indexterm role="cp"><primary>starting on a right-hand page</primary></indexterm> + <para>The <literal>\cleardoublepage</literal> command ends the current page and causes all figures and tables that have so far appeared in the input to be printed. In a two-sided printing style, it also makes the next page a right-hand @@ -2464,25 +2878,33 @@ In a two-sided printing style, it also makes the next page a right-hand </para> </sect1> -<sect1 label="11.2"> +<sect1 label="11.2" id="_005cclearpage"> <title><literal>\clearpage</literal></title> -<indexterm role="fn"><primary>\clearpage</primary></indexterm><indexterm role="cp"><primary>flushing floats and starting a page</primary></indexterm><indexterm role="cp"><primary>starting a new page and clearing floats</primary></indexterm> +<indexterm role="fn"><primary>\clearpage</primary></indexterm> +<indexterm role="cp"><primary>flushing floats and starting a page</primary></indexterm> +<indexterm role="cp"><primary>starting a new page and clearing floats</primary></indexterm> + <para>The <literal>\clearpage</literal> command ends the current page and causes all figures and tables that have so far appeared in the input to be printed. </para> </sect1> -<sect1 label="11.3"> +<sect1 label="11.3" id="_005cnewpage"> <title><literal>\newpage</literal></title> -<indexterm role="fn"><primary>\newpage</primary></indexterm><indexterm role="cp"><primary>new page, starting</primary></indexterm><indexterm role="cp"><primary>starting a new page</primary></indexterm> +<indexterm role="fn"><primary>\newpage</primary></indexterm> +<indexterm role="cp"><primary>new page, starting</primary></indexterm> +<indexterm role="cp"><primary>starting a new page</primary></indexterm> + <para>The <literal>\newpage</literal> command ends the current page, but does not clear floats (see <literal>\clearpage</literal> above). </para> </sect1> -<sect1 label="11.4"> +<sect1 label="11.4" id="_005cenlargethispage"> <title><literal>\enlargethispage</literal></title> -<indexterm role="fn"><primary>\enlargethispage</primary></indexterm><indexterm role="cp"><primary>enlarge current page</primary></indexterm> +<indexterm role="fn"><primary>\enlargethispage</primary></indexterm> +<indexterm role="cp"><primary>enlarge current page</primary></indexterm> + <para><literal>\enlargethispage{size}</literal> </para> <para><literal>\enlargethispage*{size}</literal> @@ -2497,22 +2919,26 @@ much as possible. This is normally used together with an explicit </para> </sect1> -<sect1 label="11.5"> +<sect1 label="11.5" id="_005cpagebreak-_0026-_005cnopagebreak"> <title><literal>\pagebreak</literal> & <literal>\nopagebreak</literal></title> -<indexterm role="fn"><primary>\pagebreak</primary></indexterm><indexterm role="fn"><primary>\nopagebreak</primary></indexterm><indexterm role="cp"><primary>page break, forcing</primary></indexterm><indexterm role="cp"><primary>page break, preventing</primary></indexterm> +<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> + <para>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 +(prevents) a page break at the current position. With +<literal>\pagebreak</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 +be a number from 0 to 4. The higher the number, the more insistent the request is. </para> @@ -2521,6 +2947,7 @@ insistent the request is. <chapter label="12" id="Footnotes"> <title>Footnotes</title> <indexterm role="cp"><primary>footnotes, creating</primary></indexterm> + <para>Footnotes can be produced in one of two ways. They can be produced with one command, the <literal>\footnote</literal> command. They can also be produced with two commands, the <literal>\footnotemark</literal> and the @@ -2528,9 +2955,10 @@ produced with two commands, the <literal>\footnotemark</literal> and the </para> -<sect1 label="12.1"> +<sect1 label="12.1" id="_005cfootnote"> <title><literal>\footnote</literal></title> <indexterm role="fn"><primary>\footnote</primary></indexterm> + <para>Synopsis: </para> <screen>\footnote[<replaceable>number</replaceable>]{<replaceable>text</replaceable>} @@ -2546,9 +2974,10 @@ tables or in a <literal>tabular</literal> environment. (See following sections. </para> </sect1> -<sect1 label="12.2"> +<sect1 label="12.2" id="_005cfootnotemark"> <title><literal>\footnotemark</literal></title> <indexterm role="fn"><primary>\footnotemark</primary></indexterm> + <para>With no optional argument, the <literal>\footnotemark</literal> command puts the current footnote number in the text. This command can be used in inner paragraph mode. You give the text of the footnote separately, @@ -2563,9 +2992,10 @@ markers referring to the same footnote with </para> </sect1> -<sect1 label="12.3"> +<sect1 label="12.3" id="_005cfootnotetext"> <title><literal>\footnotetext</literal></title> <indexterm role="fn"><primary>\footnotetext</primary></indexterm> + <para>Synopsis: </para> <screen>\footnotetext[<replaceable>number</replaceable>]{<replaceable>text</replaceable>} @@ -2582,14 +3012,17 @@ appear in outer paragraph mode. <sect1 label="12.4" id="Symbolic-footnotes"> <title>Symbolic footnotes</title> -<indexterm role="cp"><primary>footnotes, symbolic instead of numbered</primary></indexterm><para>If you want to use symbols for footnotes, rather than increasing +<indexterm role="cp"><primary>footnotes, symbolic instead of numbered</primary></indexterm> +<para>If you want to use symbols for footnotes, rather than increasing numbers, redefine <literal>\thefootnote</literal> like this: </para> <screen>\renewcommand{\thefootnote}{\fnsymbol{footnote}} </screen> -<indexterm role="fn"><primary>\fnsymbol, and footnotes</primary></indexterm><indexterm role="fn"><primary>\@fnsymbol</primary></indexterm><para>The <literal>\fnsymbol</literal> command produces a predefined series of symbols -(see <xref linkend="\alph-\Alph-\arabic-\roman-\Roman-\fnsymbol"></xref>). If you want to -use a different symbol as your footnote mark, you'll need to also +<indexterm role="fn"><primary>\fnsymbol<lineannotation>, and footnotes</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\@fnsymbol</primary></indexterm> +<para>The <literal>\fnsymbol</literal> command produces a predefined series of symbols +(see <link linkend="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol">\alph \Alph \arabic \roman \Roman \fnsymbol</link>). If you want to +use a different symbol as your footnote mark, you’ll need to also redefine <literal>\@fnsymbol</literal>. </para> @@ -2597,37 +3030,43 @@ redefine <literal>\@fnsymbol</literal>. <sect1 label="12.5" id="Footnote-parameters"> <title>Footnote parameters</title> -<indexterm role="cp"><primary>footnote parameters</primary></indexterm><indexterm role="cp"><primary>parameters, for footnotes</primary></indexterm> -<variablelist><varlistentry><term><literal>\footnoterule</literal></term> -<listitem><para>Produces the rule separating the main text on a page from the page's +<indexterm role="cp"><primary>footnote parameters</primary></indexterm> +<indexterm role="cp"><primary>parameters, for footnotes</primary></indexterm> + +<variablelist><varlistentry><term><indexterm role="fn"><primary>\footnoterule</primary></indexterm><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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\footnotesep</primary></indexterm><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>’. +fonts (see <link linkend="Font-sizes">Font sizes</link>), 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="13" id="Definitions"> <title>Definitions</title> <indexterm role="cp"><primary>definitions</primary></indexterm> + <para>&latex; has support for making new commands of many different kinds. </para> <!-- xx everything in this chapter needs examples. --> -<sect1 label="13.1"> +<sect1 label="13.1" id="_005cnewcommand-_0026-_005crenewcommand"> <title><literal>\newcommand</literal> & <literal>\renewcommand</literal></title> -<indexterm role="fn"><primary>\newcommand</primary></indexterm><indexterm role="cp"><primary>commands, defining new ones</primary></indexterm><indexterm role="cp"><primary>defining a new command</primary></indexterm><indexterm role="cp"><primary>new commands, defining</primary></indexterm> +<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> + <para><literal>\newcommand</literal> and <literal>\renewcommand</literal> define and redefine a command, respectively. Synopses: </para> @@ -2637,35 +3076,36 @@ command, respectively. Synopses: \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 +<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 +</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 +</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>’. +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 +</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> - <!-- xx \providecommand, * form (non-\long) --> </sect1> -<sect1 label="13.2"> +<sect1 label="13.2" id="_005cnewcounter"> <title><literal>\newcounter</literal></title> -<indexterm role="fn"><primary>\newcounter</primary></indexterm><indexterm role="cp"><primary>counters, defining new</primary></indexterm> +<indexterm role="fn"><primary>\newcounter</primary></indexterm> +<indexterm role="cp"><primary>counters, defining new</primary></indexterm> + <para>Synopsis: </para> <screen>\newcounter{<replaceable>cnt</replaceable>}[<replaceable>countername</replaceable>] @@ -2676,13 +3116,15 @@ The new counter is initialized to zero. <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>See <link linkend="Counters">Counters</link>, for more information about counters. </para> </sect1> -<sect1 label="13.3"> +<sect1 label="13.3" id="_005cnewlength"> <title><literal>\newlength</literal></title> -<indexterm role="fn"><primary>\newlength</primary></indexterm><indexterm role="cp"><primary>lengths, defining new</primary></indexterm> +<indexterm role="fn"><primary>\newlength</primary></indexterm> +<indexterm role="cp"><primary>lengths, defining new</primary></indexterm> + <para>Synopsis: </para> <screen>\newlength{\<replaceable>arg</replaceable>} @@ -2692,14 +3134,15 @@ will be reset whenever <replaceable>countername</replaceable> is incremented. 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 +<para>See <link linkend="Lengths">Lengths</link>, for how to set the new length to a nonzero value, and for more information about lengths in general. </para> </sect1> -<sect1 label="13.4"> +<sect1 label="13.4" id="_005cnewsavebox"> <title><literal>\newsavebox</literal></title> <indexterm role="fn"><primary>\newsavebox</primary></indexterm> + <para>Synopsis: </para> <screen>\newsavebox{<replaceable>cmd</replaceable>} @@ -2709,9 +3152,14 @@ defined, to refer to a new bin for storing boxes. </para> </sect1> -<sect1 label="13.5"> +<sect1 label="13.5" id="_005cnewenvironment-_0026-_005crenewenvironment"> <title><literal>\newenvironment</literal> & <literal>\renewenvironment</literal></title> -<indexterm role="fn"><primary>\newenvironment</primary></indexterm><indexterm role="fn"><primary>\renewenvironment</primary></indexterm><indexterm role="cp"><primary>environments, defining</primary></indexterm><indexterm role="cp"><primary>defining new environments</primary></indexterm><indexterm role="cp"><primary>redefining environments</primary></indexterm> +<indexterm role="fn"><primary>\newenvironment</primary></indexterm> +<indexterm role="fn"><primary>\renewenvironment</primary></indexterm> +<indexterm role="cp"><primary>environments, defining</primary></indexterm> +<indexterm role="cp"><primary>defining new environments</primary></indexterm> +<indexterm role="cp"><primary>redefining environments</primary></indexterm> + <para>Synopses: </para> <screen> \newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>} @@ -2719,70 +3167,74 @@ defined, to refer to a new bin for storing boxes. \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>. +<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> +<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 +</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> +</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 +</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 +</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="13.6"> +<sect1 label="13.6" id="_005cnewtheorem"> <title><literal>\newtheorem</literal></title> -<indexterm role="fn"><primary>\newtheorem</primary></indexterm><indexterm role="cp"><primary>theorems, defining</primary></indexterm><indexterm role="cp"><primary>defining new theorems</primary></indexterm> +<indexterm role="fn"><primary>\newtheorem</primary></indexterm> +<indexterm role="cp"><primary>theorems, defining</primary></indexterm> +<indexterm role="cp"><primary>defining new theorems</primary></indexterm> + <screen>\newtheorem{<replaceable>newenv</replaceable>}{<replaceable>label</replaceable>}[<replaceable>within</replaceable>] \newtheorem{<replaceable>newenv</replaceable>}[<replaceable>numbered_like</replaceable>]{<replaceable>label</replaceable>} </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 +<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>’. +</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; +</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. +</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="13.7"> +<sect1 label="13.7" id="_005cnewfont"> <title><literal>\newfont</literal></title> -<indexterm role="fn"><primary>\newfont</primary></indexterm><indexterm role="cp"><primary>fonts, new commands for</primary></indexterm><indexterm role="cp"><primary>defining new fonts</primary></indexterm> +<indexterm role="fn"><primary>\newfont</primary></indexterm> +<indexterm role="cp"><primary>fonts, new commands for</primary></indexterm> +<indexterm role="cp"><primary>defining new fonts</primary></indexterm> + <para>Synopsis: </para> <screen>\newfont{<replaceable>cmd</replaceable>}{<replaceable>fontname</replaceable>} @@ -2796,28 +3248,32 @@ More commonly, fonts are defined in families through <filename>.fd</filename> fi </para> </sect1> -<sect1 label="13.8"> +<sect1 label="13.8" id="_005cprotect"> <title><literal>\protect</literal></title> <indexterm role="fn"><primary>\protect</primary></indexterm> -<indexterm role="cp"><primary>fragile commands</primary></indexterm><indexterm role="cp"><primary>moving arguments</primary></indexterm><para>Footnotes, line breaks, any command that has an optional argument, and + +<indexterm role="cp"><primary>fragile commands</primary></indexterm> +<indexterm role="cp"><primary>moving arguments</primary></indexterm> +<para>Footnotes, line breaks, any command that has an optional argument, and many more are so-called <firstterm>fragile</firstterm> commands. When a fragile command is used in certain contexts, called <firstterm>moving arguments</firstterm>, it must be preceded by <literal>\protect</literal>. In addition, any fragile commands within the arguments must have their own <literal>\protect</literal>. </para> <para>Some examples of moving arguments are <literal>\caption</literal> -(see <xref linkend="figure"></xref>), <literal>\thanks</literal> (see <xref linkend="\maketitle"></xref>), and +(see <link linkend="figure">figure</link>), <literal>\thanks</literal> (see <link linkend="_005cmaketitle">\maketitle</link>), and expressions in <literal>tabular</literal> and <literal>array</literal> environments -(see <xref linkend="tabular"></xref>). +(see <link linkend="tabular">tabular</link>). </para> -<indexterm role="cp"><primary>robust commands</primary></indexterm><para>Commands which are not fragile are called <firstterm>robust</firstterm>. They must not +<indexterm role="cp"><primary>robust commands</primary></indexterm> +<para>Commands which are not fragile are called <firstterm>robust</firstterm>. They must not be preceded by <literal>\protect</literal>. </para> <para>See also: </para> -<screen><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> -<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</ulink> -</screen> +<simpara><ulink url="http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html">http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</ulink></simpara> +<simpara><ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</ulink></simpara> + <!-- xx really need examples. --> @@ -2825,12 +3281,14 @@ be preceded by <literal>\protect</literal>. </chapter> <chapter label="14" id="Counters"> <title>Counters</title> -<indexterm role="cp"><primary>counters, a list of</primary></indexterm><indexterm role="cp"><primary>variables, a list of</primary></indexterm> +<indexterm role="cp"><primary>counters, a list of</primary></indexterm> +<indexterm role="cp"><primary>variables, a list of</primary></indexterm> + <para>Everything &latex; numbers for you has a counter associated with it. The name of the counter is the same as the name of the environment or command that produces the number, except with no <literal>\</literal>. -(<literal>enumi</literal>–<literal>enumiv</literal> are used for the nested enumerate -environment.) Below is a list of the counters used in &latex;'s +(<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 @@ -2841,43 +3299,45 @@ subsubsection </screen> -<sect1 label="14.1"> +<sect1 label="14.1" id="_005calph-_005cAlph-_005carabic-_005croman-_005cRoman-_005cfnsymbol"> <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', …. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\alph</primary></indexterm><literal>\alph</literal> +</term><listitem><para>prints <replaceable>counter</replaceable> using lowercase letters: ‘a’, ‘b’, ... </para> -</listitem></varlistentry><varlistentry><term><literal>\Alph</literal></term> -<listitem><para>uses uppercase letters: `A', `B', …. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Alph</primary></indexterm><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', …. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\arabic</primary></indexterm><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', …. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\roman</primary></indexterm><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', …. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\roman</primary></indexterm><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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\fnsymbol</primary></indexterm><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. +<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: +<para>The symbols mostly aren’t supported in Info, but here are the names: </para><literallayout>asterix(*) dagger ddagger section-sign paragraph-sign parallel double-asterix(**) double-dagger double-ddagger </literallayout> </listitem></varlistentry></variablelist> - </sect1> -<sect1 label="14.2"> +<sect1 label="14.2" id="_005cusecounter"> <title><literal>\usecounter{<replaceable>counter</replaceable>}</literal></title> -<indexterm role="fn"><primary>\usecounter</primary></indexterm><indexterm role="cp"><primary>list items, specifying counter</primary></indexterm><indexterm role="cp"><primary>numbered items, specifying counter</primary></indexterm> +<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> + <para>Synopsis: </para> <screen>\usecounter{<replaceable>counter</replaceable>} @@ -2888,9 +3348,11 @@ the list items. </para> </sect1> -<sect1 label="14.3"> +<sect1 label="14.3" id="_005cvalue"> <title><literal>\value{<replaceable>counter</replaceable>}</literal></title> -<indexterm role="fn"><primary>\value</primary></indexterm><indexterm role="cp"><primary>counters, getting value of</primary></indexterm> +<indexterm role="fn"><primary>\value</primary></indexterm> +<indexterm role="cp"><primary>counters, getting value of</primary></indexterm> + <para>Synopsis: </para> <screen>\value{<replaceable>counter</replaceable>} @@ -2904,9 +3366,12 @@ be used anywhere &latex; expects a number, for example: </screen> </sect1> -<sect1 label="14.4"> +<sect1 label="14.4" id="_005csetcounter"> <title><literal>\setcounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title> -<indexterm role="fn"><primary>\setcounter</primary></indexterm><indexterm role="cp"><primary>counters, setting</primary></indexterm><indexterm role="cp"><primary>setting counters</primary></indexterm> +<indexterm role="fn"><primary>\setcounter</primary></indexterm> +<indexterm role="cp"><primary>counters, setting</primary></indexterm> +<indexterm role="cp"><primary>setting counters</primary></indexterm> + <para>Synopsis: </para> <screen>\setcounter{<replaceable>\counter</replaceable>}{<replaceable>value</replaceable>} @@ -2916,42 +3381,48 @@ be used anywhere &latex; expects a number, for example: </para> </sect1> -<sect1 label="14.5"> +<sect1 label="14.5" id="_005caddtocounter"> <title><literal>\addtocounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title> <indexterm role="fn"><primary>\addtocounter</primary></indexterm> + <para>The <literal>\addtocounter</literal> command increments <replaceable>counter</replaceable> by the amount specified by the <replaceable>value</replaceable> argument, which may be negative. </para> </sect1> -<sect1 label="14.6"> +<sect1 label="14.6" id="_005crefstepcounter"> <title><literal>\refstepcounter{<replaceable>counter</replaceable>}</literal></title> <indexterm role="fn"><primary>\refstepcounter</primary></indexterm> + <para>The <literal>\refstepcounter</literal> command works in the same way as -<literal>\stepcounter</literal> See <xref linkend="\stepcounter"></xref>, except it also defines the +<literal>\stepcounter</literal> See <link linkend="_005cstepcounter">\stepcounter</link>, except it also defines the current <literal>\ref</literal> value to be the result of <literal>\thecounter</literal>. </para> </sect1> -<sect1 label="14.7"> +<sect1 label="14.7" id="_005cstepcounter"> <title><literal>\stepcounter{<replaceable>counter</replaceable>}</literal></title> <indexterm role="fn"><primary>\stepcounter</primary></indexterm> + <para>The <literal>\stepcounter</literal> command adds one to <replaceable>counter</replaceable> and resets all subsidiary counters. </para> </sect1> -<sect1 label="14.8"> +<sect1 label="14.8" id="_005cday-_005cmonth-_005cyear"> <title><literal>\day \month \year</literal>: Predefined counters</title> -<indexterm role="fn"><primary>\day</primary></indexterm><indexterm role="fn"><primary>\month</primary></indexterm><indexterm role="fn"><primary>\year</primary></indexterm> +<indexterm role="fn"><primary>\day</primary></indexterm> +<indexterm role="fn"><primary>\month</primary></indexterm> +<indexterm role="fn"><primary>\year</primary></indexterm> + <para>&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 +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>). +current day (see <link linkend="_005ctoday">\today</link>). </para> </sect1> @@ -2959,14 +3430,17 @@ current day (see <xref linkend="\today"></xref>). <chapter label="15" id="Lengths"> <title>Lengths</title> <indexterm role="cp"><primary>lengths, defining and using</primary></indexterm> + <para>A <literal>length</literal> is a measure of distance. Many &latex; commands take a length as an argument. </para> -<sect1 label="15.1"> +<sect1 label="15.1" id="_005csetlength"> <title><literal>\setlength{\<replaceable>len</replaceable>}{<replaceable>value</replaceable>}</literal></title> -<indexterm role="fn"><primary>\setlength</primary></indexterm><indexterm role="cp"><primary>lengths, setting</primary></indexterm> +<indexterm role="fn"><primary>\setlength</primary></indexterm> +<indexterm role="cp"><primary>lengths, setting</primary></indexterm> + <para>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 @@ -2974,18 +3448,21 @@ understands, i.e., inches (<literal>in</literal>), millimeters (<literal>mm</lit </para> </sect1> -<sect1 label="15.2"> +<sect1 label="15.2" id="_005caddtolength"> <title>\addtolength{<replaceable>\len</replaceable>}{<replaceable>amount</replaceable>}</title> -<indexterm role="fn"><primary>\addtolength</primary></indexterm><indexterm role="cp"><primary>lengths, adding to</primary></indexterm> -<para>The <literal>\addtolength</literal> command increments a “length command” +<indexterm role="fn"><primary>\addtolength</primary></indexterm> +<indexterm role="cp"><primary>lengths, adding to</primary></indexterm> + +<para>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="15.3"> +<sect1 label="15.3" id="_005csettodepth"> <title><literal>\settodepth</literal></title> <indexterm role="fn"><primary>\settodepth</primary></indexterm> + <para><literal>\settodepth{\gnat}{text}</literal> </para> <para>The <literal>\settodepth</literal> command sets the value of a <literal>length</literal> command @@ -2993,9 +3470,10 @@ equal to the depth of the <literal>text</literal> argument. </para> </sect1> -<sect1 label="15.4"> +<sect1 label="15.4" id="_005csettoheight"> <title><literal>\settoheight</literal></title> <indexterm role="fn"><primary>\settoheight</primary></indexterm> + <para><literal>\settoheight{\gnat}{text}</literal> </para> <para>The <literal>\settoheight</literal> command sets the value of a <literal>length</literal> command @@ -3004,29 +3482,35 @@ equal to the height of the <literal>text</literal> argument. </sect1> -<sect1 label="15.5"> +<sect1 label="15.5" id="_005csettowidth"> <title><literal>\settowidth{\<replaceable>len</replaceable>}{<replaceable>text</replaceable>}</literal></title> <indexterm role="fn"><primary>\settowidth</primary></indexterm> + <para>The <literal>\settowidth</literal> command sets the value of the command <replaceable>\len</replaceable> to the width of the <replaceable>text</replaceable> argument. </para> - </sect1> <sect1 label="15.6" id="Predefined-lengths"> <title>Predefined lengths</title> -<indexterm role="cp"><primary>lengths, predefined</primary></indexterm><indexterm role="cp"><primary>predefined lengths</primary></indexterm> +<indexterm role="cp"><primary>lengths, predefined</primary></indexterm> +<indexterm role="cp"><primary>predefined lengths</primary></indexterm> + <para><literal>\width</literal> -<indexterm role="fn"><primary>\width</primary></indexterm></para> +<indexterm role="fn"><primary>\width</primary></indexterm> +</para> <para><literal>\height</literal> -<indexterm role="fn"><primary>\height</primary></indexterm></para> +<indexterm role="fn"><primary>\height</primary></indexterm> +</para> <para><literal>\depth</literal> -<indexterm role="fn"><primary>\depth</primary></indexterm></para> +<indexterm role="fn"><primary>\depth</primary></indexterm> +</para> <para><literal>\totalheight</literal> -<indexterm role="fn"><primary>\totalheight</primary></indexterm></para> +<indexterm role="fn"><primary>\totalheight</primary></indexterm> +</para> <para>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> + +commands (see <link linkend="Boxes">Boxes</link>). 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> @@ -3037,17 +3521,22 @@ natural size, e.g., say </chapter> <chapter label="16" id="Making-paragraphs"> <title>Making paragraphs</title> -<indexterm role="cp"><primary>making paragraphs</primary></indexterm><indexterm role="cp"><primary>paragraphs</primary></indexterm> -<para>A paragraph is ended by one or more completely blank lines—lines not +<indexterm role="cp"><primary>making paragraphs</primary></indexterm> +<indexterm role="cp"><primary>paragraphs</primary></indexterm> + +<para>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="16.1"> +<sect1 label="16.1" id="_005cindent"> <title><literal>\indent</literal></title> -<indexterm role="fn"><primary>\indent</primary></indexterm><indexterm role="fn"><primary>\parindent</primary></indexterm><indexterm role="cp"><primary>indent, forcing</primary></indexterm> +<indexterm role="fn"><primary>\indent</primary></indexterm> +<indexterm role="fn"><primary>\parindent</primary></indexterm> +<indexterm role="cp"><primary>indent, forcing</primary></indexterm> + <para><literal>\indent</literal> produces a horizontal space whose width equals the width of the <literal>\parindent</literal> length, the normal paragraph indentation. It is used to add paragraph indentation where it would @@ -3059,18 +3548,22 @@ mode, otherwise <literal>15pt</literal> for <literal>10pt</literal> documents, < </para> </sect1> -<sect1 label="16.2"> +<sect1 label="16.2" id="_005cnoindent"> <title><literal>\noindent</literal></title> -<indexterm role="fn"><primary>\noindent</primary></indexterm><indexterm role="cp"><primary>indent, suppressing</primary></indexterm> +<indexterm role="fn"><primary>\noindent</primary></indexterm> +<indexterm role="cp"><primary>indent, suppressing</primary></indexterm> + <para>When used at the beginning of the paragraph, <literal>\noindent</literal> suppresses any paragraph indentation. It has no effect when used in the middle of a paragraph. </para> </sect1> -<sect1 label="16.3"> +<sect1 label="16.3" id="_005cparskip"> <title><literal>\parskip</literal></title> -<indexterm role="fn"><primary>\parskip</primary></indexterm><indexterm role="cp"><primary>vertical space before paragraphs</primary></indexterm> +<indexterm role="fn"><primary>\parskip</primary></indexterm> +<indexterm role="cp"><primary>vertical space before paragraphs</primary></indexterm> + <para><literal>\parskip</literal> is a rubber length defining extra vertical space added before each paragraph. The default is <literal>0pt plus1pt</literal>. </para> @@ -3078,7 +3571,11 @@ before each paragraph. The default is <literal>0pt plus1pt</literal>. </sect1> <sect1 label="16.4" id="Marginal-notes"> <title>Marginal notes</title> -<indexterm role="cp"><primary>marginal notes</primary></indexterm><indexterm role="cp"><primary>notes in the margin</primary></indexterm><indexterm role="cp"><primary>remarks in the margin</primary></indexterm><indexterm role="fn"><primary>\marginpar</primary></indexterm> +<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> + <para>Synopsis: </para> <screen>\marginpar[<replaceable>left</replaceable>]{<replaceable>right</replaceable>} @@ -3090,17 +3587,13 @@ where the <literal>\marginpar</literal> occurs. <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> -<indexterm role="fn"><primary>\reversemarginpar</primary></indexterm><indexterm role="fn"><primary>\normalmarginpar</primary></indexterm><para>The command <literal>\reversemarginpar</literal> places subsequent marginal notes +<itemizedlist><listitem><para>in the right margin for one-sided layout; +</para></listitem><listitem><para>in the outside margin for two-sided layout; +</para></listitem><listitem><para>in the nearest margin for two-column layout. +</para></listitem></itemizedlist> +<indexterm role="fn"><primary>\reversemarginpar</primary></indexterm> +<indexterm role="fn"><primary>\normalmarginpar</primary></indexterm> +<para>The command <literal>\reversemarginpar</literal> places subsequent marginal notes in the opposite (inside) margin. <literal>\normalmarginpar</literal> places them in the default position. </para> @@ -3112,22 +3605,21 @@ 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. +<variablelist><varlistentry><term><indexterm role="fn"><primary>\marginparpush</primary></indexterm><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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\marginparsep</primary></indexterm><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>’. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\marginparwidth</primary></indexterm><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> - <para>The standard &latex; routine for marginal notes does not prevent notes from falling off the bottom of the page. <!-- @TeX{} FAQ entry on this topic (xx when there): --> @@ -3139,19 +3631,28 @@ notes from falling off the bottom of the page. </chapter> <chapter label="17" id="Math-formulas"> <title>Math formulas</title> -<indexterm role="cp"><primary>math formulas</primary></indexterm><indexterm role="cp"><primary>formulas, math</primary></indexterm><indexterm role="cp"><primary>math mode, entering</primary></indexterm> -<indexterm role="fn"><primary>math environment</primary></indexterm><indexterm role="fn"><primary>displaymath environment</primary></indexterm><indexterm role="fn"><primary>equation environment</primary></indexterm><para>There are three environments that put &latex; in math mode: -</para> -<variablelist><varlistentry><term><literal>math</literal></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 +<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 <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>displaymath <lineannotation>environment</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>equation <lineannotation>environment</lineannotation></primary></indexterm> +<para>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> - -<indexterm role="fn"><primary>\(</primary></indexterm><indexterm role="fn"><primary>\)</primary></indexterm><indexterm role="fn"><primary>\[</primary></indexterm><indexterm role="fn"><primary>\]</primary></indexterm><para>The <literal>math</literal> environment can be used in both paragraph and LR mode, +<indexterm role="fn"><primary>\(</primary></indexterm> +<indexterm role="fn"><primary>\)</primary></indexterm> +<indexterm role="fn"><primary>\[</primary></indexterm> +<indexterm role="fn"><primary>\]</primary></indexterm> +<para>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: @@ -3159,18 +3660,22 @@ environments are used so often that they have the following short forms: <screen>\(...\) <lineannotation>instead of</lineannotation> \begin{math}...\end{math} \[...\] <lineannotation>instead of</lineannotation> \begin{displaymath}...\end{displaymath} </screen> -<indexterm role="fn"><primary>$</primary></indexterm><para>In fact, the <literal>math</literal> environment is so common that it has an even +<indexterm role="fn"><primary>$</primary></indexterm> +<para>In fact, the <literal>math</literal> environment is so common that it has an even shorter form: </para> <screen>$ ... $ <lineannotation>instead of</lineannotation> \(...\) </screen> -<indexterm role="fn"><primary>\boldmath</primary></indexterm><indexterm role="fn"><primary>\unboldmath</primary></indexterm><para>The <literal>\boldmath</literal> command changes math letters and symbols to be in +<indexterm role="fn"><primary>\boldmath</primary></indexterm> +<indexterm role="fn"><primary>\unboldmath</primary></indexterm> +<para>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? --> -<indexterm role="fn"><primary>\displaystyle</primary></indexterm><para>The <literal>\displaystyle</literal> declaration forces the size and style of the +<indexterm role="fn"><primary>\displaystyle</primary></indexterm> +<para>The <literal>\displaystyle</literal> declaration forces the size and style of the formula to be that of <literal>displaymath</literal>, e.g., with limits above and below summations. For example </para><screen>$\displaystyle \sum_{n=0}^\infty x_n $ @@ -3179,12 +3684,17 @@ below summations. For example -<sect1 label="17.1" id="Subscripts-&-superscripts"> +<sect1 label="17.1" id="Subscripts-_0026-superscripts"> <title>Subscripts & superscripts</title> -<indexterm role="cp"><primary>superscript</primary></indexterm><indexterm role="cp"><primary>subscript</primary></indexterm><indexterm role="cp"><primary>exponent</primary></indexterm><indexterm role="fn"><primary>_</primary></indexterm><indexterm role="fn"><primary>^</primary></indexterm> -<para>To get an expression <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 +<indexterm role="cp"><primary>superscript</primary></indexterm> +<indexterm role="cp"><primary>subscript</primary></indexterm> +<indexterm role="cp"><primary>exponent</primary></indexterm> +<indexterm role="fn"><primary>_</primary></indexterm> +<indexterm role="fn"><primary>^</primary></indexterm> + +<para>To get an expression <emphasis>exp</emphasis> to appear as a subscript, you just type +<literal>_{</literal><emphasis>exp</emphasis><literal>}</literal>. To get <emphasis>exp</emphasis> to appear as a +superscript, you type <literal>^{</literal><emphasis>exp</emphasis><literal>}</literal>. &latex; handles superscripted superscripts and all of that stuff in the natural way. It even does the right thing when something has both a subscript and a superscript. @@ -3193,915 +3703,953 @@ superscript. </sect1> <sect1 label="17.2" id="Math-symbols"> <title>Math symbols</title> -<indexterm role="cp"><primary>math symbols</primary></indexterm><indexterm role="cp"><primary>symbols, math</primary></indexterm><indexterm role="cp"><primary>greek letters</primary></indexterm> -<para>&latex; provides almost any mathematical symbol you're likely to +<indexterm role="cp"><primary>math symbols</primary></indexterm> +<indexterm role="cp"><primary>symbols, math</primary></indexterm> +<indexterm role="cp"><primary>greek letters</primary></indexterm> + +<para>&latex; provides almost any mathematical symbol you’re likely to need. The commands for generating them can be used only in math mode. For example, if you include <literal>$\pi$</literal> in your source, you will get -the pi symbol (\pi) in your output. +the pi symbol (<inlineequation><mathphrase>\pi</mathphrase></inlineequation>) in your output. </para> -<variablelist><varlistentry><term><literal>\|</literal></term> -<listitem><para>\| +<variablelist><varlistentry><term><indexterm role="fn"><primary>\|</primary></indexterm><literal>\|</literal> +</term><listitem><para><inlineequation><mathphrase>\|</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\aleph</literal></term> -<listitem><para>\aleph +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\aleph</primary></indexterm><literal>\aleph</literal> +</term><listitem><para><inlineequation><mathphrase>\aleph</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\alpha</literal></term> -<listitem><para>\alpha +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\alpha</primary></indexterm><literal>\alpha</literal> +</term><listitem><para><inlineequation><mathphrase>\alpha</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\amalg</literal></term> -<listitem><para>\amalg (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\amalg</primary></indexterm><literal>\amalg</literal> +</term><listitem><para><inlineequation><mathphrase>\amalg</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\angle</literal></term> -<listitem><para>\angle +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\angle</primary></indexterm><literal>\angle</literal> +</term><listitem><para><inlineequation><mathphrase>\angle</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\approx</literal></term> -<listitem><para>\approx (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\approx</primary></indexterm><literal>\approx</literal> +</term><listitem><para><inlineequation><mathphrase>\approx</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\ast</literal></term> -<listitem><para>\ast (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ast</primary></indexterm><literal>\ast</literal> +</term><listitem><para><inlineequation><mathphrase>\ast</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\asymp</literal></term> -<listitem><para>\asymp (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\asymp</primary></indexterm><literal>\asymp</literal> +</term><listitem><para><inlineequation><mathphrase>\asymp</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\backslash</literal></term> -<listitem><para>\ (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\backslash</primary></indexterm><literal>\backslash</literal> +</term><listitem><para>\ (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\beta</literal></term> -<listitem><para>\beta +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\beta</primary></indexterm><literal>\beta</literal> +</term><listitem><para><inlineequation><mathphrase>\beta</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigcap</literal></term> -<listitem><para>\bigcap +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcap</primary></indexterm><literal>\bigcap</literal> +</term><listitem><para><inlineequation><mathphrase>\bigcap</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigcirc</literal></term> -<listitem><para>\bigcirc (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcirc</primary></indexterm><literal>\bigcirc</literal> +</term><listitem><para><inlineequation><mathphrase>\bigcirc</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\bigcup</literal></term> -<listitem><para>\bigcup +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcup</primary></indexterm><literal>\bigcup</literal> +</term><listitem><para><inlineequation><mathphrase>\bigcup</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigodot</literal></term> -<listitem><para>\bigodot +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigodot</primary></indexterm><literal>\bigodot</literal> +</term><listitem><para><inlineequation><mathphrase>\bigodot</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigoplus</literal></term> -<listitem><para>\bigoplus +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigoplus</primary></indexterm><literal>\bigoplus</literal> +</term><listitem><para><inlineequation><mathphrase>\bigoplus</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigotimes</literal></term> -<listitem><para>\bigotimes +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigotimes</primary></indexterm><literal>\bigotimes</literal> +</term><listitem><para><inlineequation><mathphrase>\bigotimes</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigtriangledown</literal></term> -<listitem><para>\bigtriangledown (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigtriangledown</primary></indexterm><literal>\bigtriangledown</literal> +</term><listitem><para><inlineequation><mathphrase>\bigtriangledown</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\bigtriangleup</literal></term> -<listitem><para>\bigtriangleup (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigtriangleup</primary></indexterm><literal>\bigtriangleup</literal> +</term><listitem><para><inlineequation><mathphrase>\bigtriangleup</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\bigsqcup</literal></term> -<listitem><para>\bigsqcup +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigsqcup</primary></indexterm><literal>\bigsqcup</literal> +</term><listitem><para><inlineequation><mathphrase>\bigsqcup</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\biguplus</literal></term> -<listitem><para>\biguplus +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\biguplus</primary></indexterm><literal>\biguplus</literal> +</term><listitem><para><inlineequation><mathphrase>\biguplus</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigcap</literal></term> -<listitem><para>\bigvee +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigcap</primary></indexterm><literal>\bigcap</literal> +</term><listitem><para><inlineequation><mathphrase>\bigvee</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bigwedge</literal></term> -<listitem><para>\bigwedge +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bigwedge</primary></indexterm><literal>\bigwedge</literal> +</term><listitem><para><inlineequation><mathphrase>\bigwedge</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bot</literal></term> -<listitem><para>\bot +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bot</primary></indexterm><literal>\bot</literal> +</term><listitem><para><inlineequation><mathphrase>\bot</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bowtie</literal></term> -<listitem><para>\bowtie (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bowtie</primary></indexterm><literal>\bowtie</literal> +</term><listitem><para><inlineequation><mathphrase>\bowtie</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\Box</literal></term> -<listitem><para>(square open box symbol) <!-- xx not in plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Box</primary></indexterm><literal>\Box</literal> +</term><listitem><para>(square open box symbol) <!-- xx not in plain --> </para> -</listitem></varlistentry><varlistentry><term><literal>\bullet</literal></term> -<listitem><indexterm role="cp"><primary>bullet symbol</primary></indexterm><para>\bullet (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bullet</primary></indexterm><literal>\bullet</literal> +</term><listitem><indexterm role="cp"><primary>bullet symbol</primary></indexterm> +<para><inlineequation><mathphrase>\bullet</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\cap</literal></term> -<listitem><para>\cap (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cap</primary></indexterm><literal>\cap</literal> +</term><listitem><para><inlineequation><mathphrase>\cap</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\cdot</literal></term> -<listitem><para>\cdot (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cdot</primary></indexterm><literal>\cdot</literal> +</term><listitem><para><inlineequation><mathphrase>\cdot</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\chi</literal></term> -<listitem><para>\chi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\chi</primary></indexterm><literal>\chi</literal> +</term><listitem><para><inlineequation><mathphrase>\chi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\circ</literal></term> -<listitem><para>\circ (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\circ</primary></indexterm><literal>\circ</literal> +</term><listitem><para><inlineequation><mathphrase>\circ</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\clubsuit</literal></term> -<listitem><para>\clubsuit +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\clubsuit</primary></indexterm><literal>\clubsuit</literal> +</term><listitem><para><inlineequation><mathphrase>\clubsuit</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\cong</literal></term> -<listitem><para>\cong (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cong</primary></indexterm><literal>\cong</literal> +</term><listitem><para><inlineequation><mathphrase>\cong</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\coprod</literal></term> -<listitem><para>\coprod +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\coprod</primary></indexterm><literal>\coprod</literal> +</term><listitem><para><inlineequation><mathphrase>\coprod</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\cup</literal></term> -<listitem><para>\cup (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cup</primary></indexterm><literal>\cup</literal> +</term><listitem><para><inlineequation><mathphrase>\cup</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\dagger</literal></term> -<listitem><para>\dagger (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dagger</primary></indexterm><literal>\dagger</literal> +</term><listitem><para><inlineequation><mathphrase>\dagger</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\dashv</literal></term> -<listitem><para>\dashv (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dashv</primary></indexterm><literal>\dashv</literal> +</term><listitem><para><inlineequation><mathphrase>\dashv</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\ddagger</literal></term> -<listitem><para>\dagger (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ddagger</primary></indexterm><literal>\ddagger</literal> +</term><listitem><para><inlineequation><mathphrase>\dagger</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\Delta</literal></term> -<listitem><para>\Delta +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Delta</primary></indexterm><literal>\Delta</literal> +</term><listitem><para><inlineequation><mathphrase>\Delta</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\delta</literal></term> -<listitem><para>\delta +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\delta</primary></indexterm><literal>\delta</literal> +</term><listitem><para><inlineequation><mathphrase>\delta</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Diamond</literal></term> -<listitem><para>bigger \diamond <!-- xx not in plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Diamond</primary></indexterm><literal>\Diamond</literal> +</term><listitem><para>bigger <inlineequation><mathphrase>\diamond</mathphrase></inlineequation> <!-- xx not in plain --> </para> -</listitem></varlistentry><varlistentry><term><literal>\diamond</literal></term> -<listitem><para>\diamond (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\diamond</primary></indexterm><literal>\diamond</literal> +</term><listitem><para><inlineequation><mathphrase>\diamond</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\diamondsuit</literal></term> -<listitem><para>\diamondsuit +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\diamondsuit</primary></indexterm><literal>\diamondsuit</literal> +</term><listitem><para><inlineequation><mathphrase>\diamondsuit</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\div</literal></term> -<listitem><para>\div (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\div</primary></indexterm><literal>\div</literal> +</term><listitem><para><inlineequation><mathphrase>\div</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\doteq</literal></term> -<listitem><para>\doteq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\doteq</primary></indexterm><literal>\doteq</literal> +</term><listitem><para><inlineequation><mathphrase>\doteq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\downarrow</literal></term> -<listitem><para>\downarrow (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\downarrow</primary></indexterm><literal>\downarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\downarrow</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\Downarrow</literal></term> -<listitem><para>\Downarrow (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Downarrow</primary></indexterm><literal>\Downarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\Downarrow</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\ell</literal></term> -<listitem><para>\ell +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ell</primary></indexterm><literal>\ell</literal> +</term><listitem><para><inlineequation><mathphrase>\ell</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\emptyset</literal></term> -<listitem><para>\emptyset +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\emptyset</primary></indexterm><literal>\emptyset</literal> +</term><listitem><para><inlineequation><mathphrase>\emptyset</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\epsilon</literal></term> -<listitem><para>\epsilon +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\epsilon</primary></indexterm><literal>\epsilon</literal> +</term><listitem><para><inlineequation><mathphrase>\epsilon</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\equiv</literal></term> -<listitem><para>\equiv (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\equiv</primary></indexterm><literal>\equiv</literal> +</term><listitem><para><inlineequation><mathphrase>\equiv</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\eta</literal></term> -<listitem><para>\eta +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\eta</primary></indexterm><literal>\eta</literal> +</term><listitem><para><inlineequation><mathphrase>\eta</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\exists</literal></term> -<listitem><para>\exists +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\exists</primary></indexterm><literal>\exists</literal> +</term><listitem><para><inlineequation><mathphrase>\exists</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\flat</literal></term> -<listitem><para>\flat +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\flat</primary></indexterm><literal>\flat</literal> +</term><listitem><para><inlineequation><mathphrase>\flat</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\forall</literal></term> -<listitem><para>\forall +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\forall</primary></indexterm><literal>\forall</literal> +</term><listitem><para><inlineequation><mathphrase>\forall</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\frown</literal></term> -<listitem><para>\frown (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\frown</primary></indexterm><literal>\frown</literal> +</term><listitem><para><inlineequation><mathphrase>\frown</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\Gamma</literal></term> -<listitem><para>\Gamma +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Gamma</primary></indexterm><literal>\Gamma</literal> +</term><listitem><para><inlineequation><mathphrase>\Gamma</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\gamma</literal></term> -<listitem><para>\gamma +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\gamma</primary></indexterm><literal>\gamma</literal> +</term><listitem><para><inlineequation><mathphrase>\gamma</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\ge</literal></term> -<listitem><para>\ge +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ge</primary></indexterm><literal>\ge</literal> +</term><listitem><para><inlineequation><mathphrase>\ge</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\geq</literal></term> -<listitem><para>\geq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\geq</primary></indexterm><literal>\geq</literal> +</term><listitem><para><inlineequation><mathphrase>\geq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\gets</literal></term> -<listitem><para>\gets +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\gets</primary></indexterm><literal>\gets</literal> +</term><listitem><para><inlineequation><mathphrase>\gets</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\gg</literal></term> -<listitem><para>\gg (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\gg</primary></indexterm><literal>\gg</literal> +</term><listitem><para><inlineequation><mathphrase>\gg</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\hbar</literal></term> -<listitem><para>\hbar +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hbar</primary></indexterm><literal>\hbar</literal> +</term><listitem><para><inlineequation><mathphrase>\hbar</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\heartsuit</literal></term> -<listitem><para>\heartsuit +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\heartsuit</primary></indexterm><literal>\heartsuit</literal> +</term><listitem><para><inlineequation><mathphrase>\heartsuit</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\hookleftarrow</literal></term> -<listitem><para>\hookleftarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hookleftarrow</primary></indexterm><literal>\hookleftarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\hookleftarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\hookrightarrow</literal></term> -<listitem><para>\hookrightarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hookrightarrow</primary></indexterm><literal>\hookrightarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\hookrightarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\iff</literal></term> -<listitem><para>\iff +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\iff</primary></indexterm><literal>\iff</literal> +</term><listitem><para><inlineequation><mathphrase>\iff</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Im</literal></term> -<listitem><para>\Im +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Im</primary></indexterm><literal>\Im</literal> +</term><listitem><para><inlineequation><mathphrase>\Im</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\in</literal></term> -<listitem><para>\in (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\in</primary></indexterm><literal>\in</literal> +</term><listitem><para><inlineequation><mathphrase>\in</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\infty</literal></term> -<listitem><para>\infty +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\infty</primary></indexterm><literal>\infty</literal> +</term><listitem><para><inlineequation><mathphrase>\infty</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\int</literal></term> -<listitem><para>\int +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\int</primary></indexterm><literal>\int</literal> +</term><listitem><para><inlineequation><mathphrase>\int</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\iota</literal></term> -<listitem><para>\iota +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\iota</primary></indexterm><literal>\iota</literal> +</term><listitem><para><inlineequation><mathphrase>\iota</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Join</literal></term> -<listitem><para>condensed bowtie symbol (relation) <!-- xx not in plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Join</primary></indexterm><literal>\Join</literal> +</term><listitem><para>condensed bowtie symbol (relation) <!-- xx not in plain --> </para> -</listitem></varlistentry><varlistentry><term><literal>\kappa</literal></term> -<listitem><para>\kappa +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\kappa</primary></indexterm><literal>\kappa</literal> +</term><listitem><para><inlineequation><mathphrase>\kappa</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Lambda</literal></term> -<listitem><para>\Lambda +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Lambda</primary></indexterm><literal>\Lambda</literal> +</term><listitem><para><inlineequation><mathphrase>\Lambda</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\lambda</literal></term> -<listitem><para>\lambda +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lambda</primary></indexterm><literal>\lambda</literal> +</term><listitem><para><inlineequation><mathphrase>\lambda</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\land</literal></term> -<listitem><para>\land +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\land</primary></indexterm><literal>\land</literal> +</term><listitem><para><inlineequation><mathphrase>\land</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\langle</literal></term> -<listitem><para>\langle (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\langle</primary></indexterm><literal>\langle</literal> +</term><listitem><para><inlineequation><mathphrase>\langle</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\lbrace</literal></term> -<listitem><para>\lbrace (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lbrace</primary></indexterm><literal>\lbrace</literal> +</term><listitem><para><inlineequation><mathphrase>\lbrace</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\lbrack</literal></term> -<listitem><para>\lbrack (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lbrack</primary></indexterm><literal>\lbrack</literal> +</term><listitem><para><inlineequation><mathphrase>\lbrack</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\lceil</literal></term> -<listitem><para>\lceil (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lceil</primary></indexterm><literal>\lceil</literal> +</term><listitem><para><inlineequation><mathphrase>\lceil</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\le</literal></term> -<listitem><para>\le +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\le</primary></indexterm><literal>\le</literal> +</term><listitem><para><inlineequation><mathphrase>\le</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\leadsto</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry><varlistentry><term><!-- xx missing from plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leadsto</primary></indexterm><literal>\leadsto</literal> +</term><listitem><!-- xx missing from plain --> -<literal>\Leftarrow</literal></term> -<listitem><para>\Leftarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Leftarrow</primary></indexterm><literal>\Leftarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\Leftarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\leftarrow</literal></term> -<listitem><para>\leftarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftarrow</primary></indexterm><literal>\leftarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\leftarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\leftharpoondown</literal></term> -<listitem><para>\leftharpoondown +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftharpoondown</primary></indexterm><literal>\leftharpoondown</literal> +</term><listitem><para><inlineequation><mathphrase>\leftharpoondown</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\leftharpoonup</literal></term> -<listitem><para>\leftharpoonup +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftharpoonup</primary></indexterm><literal>\leftharpoonup</literal> +</term><listitem><para><inlineequation><mathphrase>\leftharpoonup</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Leftrightarrow</literal></term> -<listitem><para>\Leftrightarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Leftrightarrow</primary></indexterm><literal>\Leftrightarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\Leftrightarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\leftrightarrow</literal></term> -<listitem><para>\leftrightarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leftrightarrow</primary></indexterm><literal>\leftrightarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\leftrightarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\leq</literal></term> -<listitem><para>\leq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\leq</primary></indexterm><literal>\leq</literal> +</term><listitem><para><inlineequation><mathphrase>\leq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\lfloor</literal></term> -<listitem><para>\lfloor (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lfloor</primary></indexterm><literal>\lfloor</literal> +</term><listitem><para><inlineequation><mathphrase>\lfloor</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\lhd</literal></term> -<listitem><para>(left-pointing arrow head) <!-- xx not in plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lhd</primary></indexterm><literal>\lhd</literal> +</term><listitem><para>(left-pointing arrow head) <!-- xx not in plain --> </para> -</listitem></varlistentry><varlistentry><term><literal>\ll</literal></term> -<listitem><para>\ll (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ll</primary></indexterm><literal>\ll</literal> +</term><listitem><para><inlineequation><mathphrase>\ll</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\lnot</literal></term> -<listitem><para>\lnot +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lnot</primary></indexterm><literal>\lnot</literal> +</term><listitem><para><inlineequation><mathphrase>\lnot</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\longleftarrow</literal></term> -<listitem><para>\longleftarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longleftarrow</primary></indexterm><literal>\longleftarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\longleftarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\longleftrightarrow</literal></term> -<listitem><para>\longleftrightarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longleftrightarrow</primary></indexterm><literal>\longleftrightarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\longleftrightarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\longmapsto</literal></term> -<listitem><para>\longmapsto +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longmapsto</primary></indexterm><literal>\longmapsto</literal> +</term><listitem><para><inlineequation><mathphrase>\longmapsto</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\longrightarrow</literal></term> -<listitem><para>\longrightarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\longrightarrow</primary></indexterm><literal>\longrightarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\longrightarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\lor</literal></term> -<listitem><para>\lor +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lor</primary></indexterm><literal>\lor</literal> +</term><listitem><para><inlineequation><mathphrase>\lor</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\mapsto</literal></term> -<listitem><para>\mapsto +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mapsto</primary></indexterm><literal>\mapsto</literal> +</term><listitem><para><inlineequation><mathphrase>\mapsto</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\mho</literal></term> -<listitem><para><!-- empty table line --></para></listitem></varlistentry><varlistentry><term><!-- xx not in plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mho</primary></indexterm><literal>\mho</literal> +</term><listitem><!-- xx not in plain --> -<literal>\mid</literal></term> -<listitem><para>\mid (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mid</primary></indexterm><literal>\mid</literal> +</term><listitem><para><inlineequation><mathphrase>\mid</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\models</literal></term> -<listitem><para>\models (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\models</primary></indexterm><literal>\models</literal> +</term><listitem><para><inlineequation><mathphrase>\models</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\mp</literal></term> -<listitem><para>\mp (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mp</primary></indexterm><literal>\mp</literal> +</term><listitem><para><inlineequation><mathphrase>\mp</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\mu</literal></term> -<listitem><para>\mu +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mu</primary></indexterm><literal>\mu</literal> +</term><listitem><para><inlineequation><mathphrase>\mu</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\nabla</literal></term> -<listitem><para>\nabla +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nabla</primary></indexterm><literal>\nabla</literal> +</term><listitem><para><inlineequation><mathphrase>\nabla</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\natural</literal></term> -<listitem><para>\natural +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\natural</primary></indexterm><literal>\natural</literal> +</term><listitem><para><inlineequation><mathphrase>\natural</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\ne</literal></term> -<listitem><para>\ne +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ne</primary></indexterm><literal>\ne</literal> +</term><listitem><para><inlineequation><mathphrase>\ne</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\nearrow</literal></term> -<listitem><para>\nearrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nearrow</primary></indexterm><literal>\nearrow</literal> +</term><listitem><para><inlineequation><mathphrase>\nearrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\neg</literal></term> -<listitem><para>\neg +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\neg</primary></indexterm><literal>\neg</literal> +</term><listitem><para><inlineequation><mathphrase>\neg</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\neq</literal></term> -<listitem><para>\neq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\neq</primary></indexterm><literal>\neq</literal> +</term><listitem><para><inlineequation><mathphrase>\neq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\ni</literal></term> -<listitem><para>\ni (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ni</primary></indexterm><literal>\ni</literal> +</term><listitem><para><inlineequation><mathphrase>\ni</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\not</literal></term> -<listitem><para>Overstrike a following operator with a /, as in \not=. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\not</primary></indexterm><literal>\not</literal> +</term><listitem><para>Overstrike a following operator with a /, as in <inlineequation><mathphrase>\not=</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\notin</literal></term> -<listitem><para>\ni +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\notin</primary></indexterm><literal>\notin</literal> +</term><listitem><para><inlineequation><mathphrase>\ni</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\nu</literal></term> -<listitem><para>\nu +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nu</primary></indexterm><literal>\nu</literal> +</term><listitem><para><inlineequation><mathphrase>\nu</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\nwarrow</literal></term> -<listitem><para>\nwarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\nwarrow</primary></indexterm><literal>\nwarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\nwarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\odot</literal></term> -<listitem><para>\odot (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\odot</primary></indexterm><literal>\odot</literal> +</term><listitem><para><inlineequation><mathphrase>\odot</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\oint</literal></term> -<listitem><para>\oint +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\oint</primary></indexterm><literal>\oint</literal> +</term><listitem><para><inlineequation><mathphrase>\oint</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Omega</literal></term> -<listitem><para>\Omega +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Omega</primary></indexterm><literal>\Omega</literal> +</term><listitem><para><inlineequation><mathphrase>\Omega</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\omega</literal></term> -<listitem><para>\omega +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\omega</primary></indexterm><literal>\omega</literal> +</term><listitem><para><inlineequation><mathphrase>\omega</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\ominus</literal></term> -<listitem><para>\ominus (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ominus</primary></indexterm><literal>\ominus</literal> +</term><listitem><para><inlineequation><mathphrase>\ominus</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\oplus</literal></term> -<listitem><para>\oplus (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\oplus</primary></indexterm><literal>\oplus</literal> +</term><listitem><para><inlineequation><mathphrase>\oplus</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\oslash</literal></term> -<listitem><para>\oslash (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\oslash</primary></indexterm><literal>\oslash</literal> +</term><listitem><para><inlineequation><mathphrase>\oslash</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\otimes</literal></term> -<listitem><para>\otimes (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\otimes</primary></indexterm><literal>\otimes</literal> +</term><listitem><para><inlineequation><mathphrase>\otimes</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\owns</literal></term> -<listitem><para>\owns +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\owns</primary></indexterm><literal>\owns</literal> +</term><listitem><para><inlineequation><mathphrase>\owns</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\parallel</literal></term> -<listitem><para>\parallel (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\parallel</primary></indexterm><literal>\parallel</literal> +</term><listitem><para><inlineequation><mathphrase>\parallel</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\partial</literal></term> -<listitem><para>\partial +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\partial</primary></indexterm><literal>\partial</literal> +</term><listitem><para><inlineequation><mathphrase>\partial</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\perp</literal></term> -<listitem><para>\perp (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\perp</primary></indexterm><literal>\perp</literal> +</term><listitem><para><inlineequation><mathphrase>\perp</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\phi</literal></term> -<listitem><para>\phi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\phi</primary></indexterm><literal>\phi</literal> +</term><listitem><para><inlineequation><mathphrase>\phi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Pi</literal></term> -<listitem><para>\Pi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Pi</primary></indexterm><literal>\Pi</literal> +</term><listitem><para><inlineequation><mathphrase>\Pi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\pi</literal></term> -<listitem><para>\pi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\pi</primary></indexterm><literal>\pi</literal> +</term><listitem><para><inlineequation><mathphrase>\pi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\pm</literal></term> -<listitem><para>\pm (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\pm</primary></indexterm><literal>\pm</literal> +</term><listitem><para><inlineequation><mathphrase>\pm</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\prec</literal></term> -<listitem><para>\prec (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\prec</primary></indexterm><literal>\prec</literal> +</term><listitem><para><inlineequation><mathphrase>\prec</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\preceq</literal></term> -<listitem><para>\preceq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\preceq</primary></indexterm><literal>\preceq</literal> +</term><listitem><para><inlineequation><mathphrase>\preceq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\prime</literal></term> -<listitem><para>\prime +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\prime</primary></indexterm><literal>\prime</literal> +</term><listitem><para><inlineequation><mathphrase>\prime</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\prod</literal></term> -<listitem><para>\prod +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\prod</primary></indexterm><literal>\prod</literal> +</term><listitem><para><inlineequation><mathphrase>\prod</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\propto</literal></term> -<listitem><para>\propto (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\propto</primary></indexterm><literal>\propto</literal> +</term><listitem><para><inlineequation><mathphrase>\propto</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\Psi</literal></term> -<listitem><para>\Psi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Psi</primary></indexterm><literal>\Psi</literal> +</term><listitem><para><inlineequation><mathphrase>\Psi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\psi</literal></term> -<listitem><para>\psi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\psi</primary></indexterm><literal>\psi</literal> +</term><listitem><para><inlineequation><mathphrase>\psi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\rangle</literal></term> -<listitem><para>\rangle (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rangle</primary></indexterm><literal>\rangle</literal> +</term><listitem><para><inlineequation><mathphrase>\rangle</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\rbrace</literal></term> -<listitem><para>\rbrace (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rbrace</primary></indexterm><literal>\rbrace</literal> +</term><listitem><para><inlineequation><mathphrase>\rbrace</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\rbrack</literal></term> -<listitem><para>\rbrack (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rbrack</primary></indexterm><literal>\rbrack</literal> +</term><listitem><para><inlineequation><mathphrase>\rbrack</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\rceil</literal></term> -<listitem><para>\rceil (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rceil</primary></indexterm><literal>\rceil</literal> +</term><listitem><para><inlineequation><mathphrase>\rceil</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\Re</literal></term> -<listitem><para>\Re +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Re</primary></indexterm><literal>\Re</literal> +</term><listitem><para><inlineequation><mathphrase>\Re</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\rfloor</literal></term> -<listitem><para>\rfloor +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rfloor</primary></indexterm><literal>\rfloor</literal> +</term><listitem><para><inlineequation><mathphrase>\rfloor</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\rhd</literal></term> -<listitem><para>(binary operation) <!-- xx not in plain @math{\rhd} --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rhd</primary></indexterm><literal>\rhd</literal> +</term><listitem><para>(binary operation) <!-- xx not in plain @math{\rhd} --> </para> -</listitem></varlistentry><varlistentry><term><literal>\rho</literal></term> -<listitem><para>\rho +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rho</primary></indexterm><literal>\rho</literal> +</term><listitem><para><inlineequation><mathphrase>\rho</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Rightarrow</literal></term> -<listitem><para>\Rightarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Rightarrow</primary></indexterm><literal>\Rightarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\Rightarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\rightarrow</literal></term> -<listitem><para>\rightarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightarrow</primary></indexterm><literal>\rightarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\rightarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\rightharpoondown</literal></term> -<listitem><para>\rightharpoondown +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightharpoondown</primary></indexterm><literal>\rightharpoondown</literal> +</term><listitem><para><inlineequation><mathphrase>\rightharpoondown</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\rightharpoonup</literal></term> -<listitem><para>\rightharpoonup +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightharpoonup</primary></indexterm><literal>\rightharpoonup</literal> +</term><listitem><para><inlineequation><mathphrase>\rightharpoonup</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\rightleftharpoons</literal></term> -<listitem><para>\rightleftharpoons +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rightleftharpoons</primary></indexterm><literal>\rightleftharpoons</literal> +</term><listitem><para><inlineequation><mathphrase>\rightleftharpoons</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\searrow</literal></term> -<listitem><para>\searrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\searrow</primary></indexterm><literal>\searrow</literal> +</term><listitem><para><inlineequation><mathphrase>\searrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\setminus</literal></term> -<listitem><para>\setminus (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\setminus</primary></indexterm><literal>\setminus</literal> +</term><listitem><para><inlineequation><mathphrase>\setminus</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\sharp</literal></term> -<listitem><para>\sharp +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sharp</primary></indexterm><literal>\sharp</literal> +</term><listitem><para><inlineequation><mathphrase>\sharp</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\Sigma</literal></term> -<listitem><para>\Sigma +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Sigma</primary></indexterm><literal>\Sigma</literal> +</term><listitem><para><inlineequation><mathphrase>\Sigma</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\sigma</literal></term> -<listitem><para>\sigma +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sigma</primary></indexterm><literal>\sigma</literal> +</term><listitem><para><inlineequation><mathphrase>\sigma</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\sim</literal></term> -<listitem><para>\sim (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sim</primary></indexterm><literal>\sim</literal> +</term><listitem><para><inlineequation><mathphrase>\sim</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\simeq</literal></term> -<listitem><para>\simeq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\simeq</primary></indexterm><literal>\simeq</literal> +</term><listitem><para><inlineequation><mathphrase>\simeq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\smallint</literal></term> -<listitem><para>\smallint +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\smallint</primary></indexterm><literal>\smallint</literal> +</term><listitem><para><inlineequation><mathphrase>\smallint</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\smile</literal></term> -<listitem><para>\smile (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\smile</primary></indexterm><literal>\smile</literal> +</term><listitem><para><inlineequation><mathphrase>\smile</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\spadesuit</literal></term> -<listitem><para>\spadesuit +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\spadesuit</primary></indexterm><literal>\spadesuit</literal> +</term><listitem><para><inlineequation><mathphrase>\spadesuit</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\sqcap</literal></term> -<listitem><para>\sqcap (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqcap</primary></indexterm><literal>\sqcap</literal> +</term><listitem><para><inlineequation><mathphrase>\sqcap</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\sqcup</literal></term> -<listitem><para>\sqcup (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqcup</primary></indexterm><literal>\sqcup</literal> +</term><listitem><para><inlineequation><mathphrase>\sqcup</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\sqsubset</literal></term> -<listitem><para>(relation) <!-- not in plain (@math{\sqsubset}) --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsubset</primary></indexterm><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) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsubseteq</primary></indexterm><literal>\sqsubseteq</literal> +</term><listitem><para><inlineequation><mathphrase>\sqsubseteq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\sqsupset</literal></term> -<listitem><para>(relation) <!-- not in plain (@math{\sqsupset}) --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsupset</primary></indexterm><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) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqsupseteq</primary></indexterm><literal>\sqsupseteq</literal> +</term><listitem><para><inlineequation><mathphrase>\sqsupseteq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\star</literal></term> -<listitem><para>\star (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\star</primary></indexterm><literal>\star</literal> +</term><listitem><para><inlineequation><mathphrase>\star</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\subset</literal></term> -<listitem><para>\subset (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\subset</primary></indexterm><literal>\subset</literal> +</term><listitem><para><inlineequation><mathphrase>\subset</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\subseteq</literal></term> -<listitem><para>\subseteq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\subseteq</primary></indexterm><literal>\subseteq</literal> +</term><listitem><para><inlineequation><mathphrase>\subseteq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\succ</literal></term> -<listitem><para>\succ (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\succ</primary></indexterm><literal>\succ</literal> +</term><listitem><para><inlineequation><mathphrase>\succ</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\succeq</literal></term> -<listitem><para>\succeq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\succeq</primary></indexterm><literal>\succeq</literal> +</term><listitem><para><inlineequation><mathphrase>\succeq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\sum</literal></term> -<listitem><para>\sum +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sum</primary></indexterm><literal>\sum</literal> +</term><listitem><para><inlineequation><mathphrase>\sum</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\supset</literal></term> -<listitem><para>\supset (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\supset</primary></indexterm><literal>\supset</literal> +</term><listitem><para><inlineequation><mathphrase>\supset</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\supseteq</literal></term> -<listitem><para>\supseteq (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\supseteq</primary></indexterm><literal>\supseteq</literal> +</term><listitem><para><inlineequation><mathphrase>\supseteq</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\surd</literal></term> -<listitem><para>\surd +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\surd</primary></indexterm><literal>\surd</literal> +</term><listitem><para><inlineequation><mathphrase>\surd</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\swarrow</literal></term> -<listitem><para>\swarrow +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\swarrow</primary></indexterm><literal>\swarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\swarrow</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\tau</literal></term> -<listitem><para>\tau +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tau</primary></indexterm><literal>\tau</literal> +</term><listitem><para><inlineequation><mathphrase>\tau</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\theta</literal></term> -<listitem><para>\theta +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\theta</primary></indexterm><literal>\theta</literal> +</term><listitem><para><inlineequation><mathphrase>\theta</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\times</literal></term> -<listitem><para>\times (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\times</primary></indexterm><literal>\times</literal> +</term><listitem><para><inlineequation><mathphrase>\times</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\to</literal></term> -<listitem><para>\to +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\to</primary></indexterm><literal>\to</literal> +</term><listitem><para><inlineequation><mathphrase>\to</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\top</literal></term> -<listitem><para>\top +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\top</primary></indexterm><literal>\top</literal> +</term><listitem><para><inlineequation><mathphrase>\top</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\triangle</literal></term> -<listitem><para>\triangle +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\triangle</primary></indexterm><literal>\triangle</literal> +</term><listitem><para><inlineequation><mathphrase>\triangle</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\triangleleft</literal></term> -<listitem><para>\triangleleft (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\triangleleft</primary></indexterm><literal>\triangleleft</literal> +</term><listitem><para><inlineequation><mathphrase>\triangleleft</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\triangleright</literal></term> -<listitem><para>\triangleright (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\triangleright</primary></indexterm><literal>\triangleright</literal> +</term><listitem><para><inlineequation><mathphrase>\triangleright</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\unlhd</literal></term> -<listitem><para>left-pointing arrowhead with line under (binary operation) <!-- not in plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\unlhd</primary></indexterm><literal>\unlhd</literal> +</term><listitem><para>left-pointing arrowhead with line under (binary operation) <!-- not in plain --> </para> -</listitem></varlistentry><varlistentry><term><literal>\unrhd</literal></term> -<listitem><para>right-pointing arrowhead with line under (binary operation) <!-- not in plain --> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\unrhd</primary></indexterm><literal>\unrhd</literal> +</term><listitem><para>right-pointing arrowhead with line under (binary operation) <!-- not in plain --> </para> -</listitem></varlistentry><varlistentry><term><literal>\Uparrow</literal></term> -<listitem><para>\Uparrow (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Uparrow</primary></indexterm><literal>\Uparrow</literal> +</term><listitem><para><inlineequation><mathphrase>\Uparrow</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\uparrow</literal></term> -<listitem><para>\uparrow (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\uparrow</primary></indexterm><literal>\uparrow</literal> +</term><listitem><para><inlineequation><mathphrase>\uparrow</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\Updownarrow</literal></term> -<listitem><para>\Updownarrow (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Updownarrow</primary></indexterm><literal>\Updownarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\Updownarrow</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\updownarrow</literal></term> -<listitem><para>\updownarrow (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\updownarrow</primary></indexterm><literal>\updownarrow</literal> +</term><listitem><para><inlineequation><mathphrase>\updownarrow</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\uplus</literal></term> -<listitem><para>\uplus (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\uplus</primary></indexterm><literal>\uplus</literal> +</term><listitem><para><inlineequation><mathphrase>\uplus</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\Upsilon</literal></term> -<listitem><para>\Upsilon +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Upsilon</primary></indexterm><literal>\Upsilon</literal> +</term><listitem><para><inlineequation><mathphrase>\Upsilon</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\upsilon</literal></term> -<listitem><para>\upsilon +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\upsilon</primary></indexterm><literal>\upsilon</literal> +</term><listitem><para><inlineequation><mathphrase>\upsilon</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\varepsilon</literal></term> -<listitem><para>\varepsilon +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varepsilon</primary></indexterm><literal>\varepsilon</literal> +</term><listitem><para><inlineequation><mathphrase>\varepsilon</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\varphi</literal></term> -<listitem><para>\varphi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varphi</primary></indexterm><literal>\varphi</literal> +</term><listitem><para><inlineequation><mathphrase>\varphi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\varpi</literal></term> -<listitem><para>\varpi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varpi</primary></indexterm><literal>\varpi</literal> +</term><listitem><para><inlineequation><mathphrase>\varpi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\varrho</literal></term> -<listitem><para>\varrho +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varrho</primary></indexterm><literal>\varrho</literal> +</term><listitem><para><inlineequation><mathphrase>\varrho</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\varsigma</literal></term> -<listitem><para>\varsigma +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\varsigma</primary></indexterm><literal>\varsigma</literal> +</term><listitem><para><inlineequation><mathphrase>\varsigma</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\vartheta</literal></term> -<listitem><para>\vartheta +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vartheta</primary></indexterm><literal>\vartheta</literal> +</term><listitem><para><inlineequation><mathphrase>\vartheta</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\vdash</literal></term> -<listitem><para>\vdash (relation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vdash</primary></indexterm><literal>\vdash</literal> +</term><listitem><para><inlineequation><mathphrase>\vdash</mathphrase></inlineequation> (relation) </para> -</listitem></varlistentry><varlistentry><term><literal>\vee</literal></term> -<listitem><para>\vee (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vee</primary></indexterm><literal>\vee</literal> +</term><listitem><para><inlineequation><mathphrase>\vee</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\Vert</literal></term> -<listitem><para>\Vert (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Vert</primary></indexterm><literal>\Vert</literal> +</term><listitem><para><inlineequation><mathphrase>\Vert</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\vert</literal></term> -<listitem><para>\vert (delimiter) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vert</primary></indexterm><literal>\vert</literal> +</term><listitem><para><inlineequation><mathphrase>\vert</mathphrase></inlineequation> (delimiter) </para> -</listitem></varlistentry><varlistentry><term><literal>\wedge</literal></term> -<listitem><para>\wedge (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\wedge</primary></indexterm><literal>\wedge</literal> +</term><listitem><para><inlineequation><mathphrase>\wedge</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\wp</literal></term> -<listitem><para>\wp +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\wp</primary></indexterm><literal>\wp</literal> +</term><listitem><para><inlineequation><mathphrase>\wp</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\wr</literal></term> -<listitem><para>\wr (binary operation) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\wr</primary></indexterm><literal>\wr</literal> +</term><listitem><para><inlineequation><mathphrase>\wr</mathphrase></inlineequation> (binary operation) </para> -</listitem></varlistentry><varlistentry><term><literal>\Xi</literal></term> -<listitem><para>\Xi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Xi</primary></indexterm><literal>\Xi</literal> +</term><listitem><para><inlineequation><mathphrase>\Xi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\xi</literal></term> -<listitem><para>\xi +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\xi</primary></indexterm><literal>\xi</literal> +</term><listitem><para><inlineequation><mathphrase>\xi</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\zeta</literal></term> -<listitem><para>\zeta +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\zeta</primary></indexterm><literal>\zeta</literal> +</term><listitem><para><inlineequation><mathphrase>\zeta</mathphrase></inlineequation> </para> </listitem></varlistentry></variablelist> - </sect1> <sect1 label="17.3" id="Math-functions"> <title>Math functions</title> -<indexterm role="cp"><primary>math functions</primary></indexterm><indexterm role="cp"><primary>functions, math</primary></indexterm> +<indexterm role="cp"><primary>math functions</primary></indexterm> +<indexterm role="cp"><primary>functions, math</primary></indexterm> + <para>These commands produce roman function names in math mode with proper spacing. </para> -<variablelist><varlistentry><term><literal>\arccos</literal></term> -<listitem><para>\arccos +<variablelist><varlistentry><term><indexterm role="fn"><primary>\arccos</primary></indexterm><literal>\arccos</literal> +</term><listitem><para><inlineequation><mathphrase>\arccos</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\arcsin</literal></term> -<listitem><para>\arcsin +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\arcsin</primary></indexterm><literal>\arcsin</literal> +</term><listitem><para><inlineequation><mathphrase>\arcsin</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\arctan</literal></term> -<listitem><para>\arctan +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\arctan</primary></indexterm><literal>\arctan</literal> +</term><listitem><para><inlineequation><mathphrase>\arctan</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\arg</literal></term> -<listitem><para>\arg +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\arg</primary></indexterm><literal>\arg</literal> +</term><listitem><para><inlineequation><mathphrase>\arg</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\bmod</literal></term> -<listitem><para>Binary modulo operator (x \bmod y) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bmod</primary></indexterm><literal>\bmod</literal> +</term><listitem><para>Binary modulo operator (<inlineequation><mathphrase>x \bmod y</mathphrase></inlineequation>) </para> -</listitem></varlistentry><varlistentry><term><literal>\cos</literal></term> -<listitem><para>\cos +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cos</primary></indexterm><literal>\cos</literal> +</term><listitem><para><inlineequation><mathphrase>\cos</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\cosh</literal></term> -<listitem><para>\cosh +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cosh</primary></indexterm><literal>\cosh</literal> +</term><listitem><para><inlineequation><mathphrase>\cosh</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\cot</literal></term> -<listitem><para>\cos +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cot</primary></indexterm><literal>\cot</literal> +</term><listitem><para><inlineequation><mathphrase>\cos</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\coth</literal></term> -<listitem><para>\cosh +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\coth</primary></indexterm><literal>\coth</literal> +</term><listitem><para><inlineequation><mathphrase>\cosh</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\csc</literal></term> -<listitem><para>\csc +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\csc</primary></indexterm><literal>\csc</literal> +</term><listitem><para><inlineequation><mathphrase>\csc</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\deg</literal></term> -<listitem><para>\deg +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\deg</primary></indexterm><literal>\deg</literal> +</term><listitem><para><inlineequation><mathphrase>\deg</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\det</literal></term> -<listitem><para>\deg +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\det</primary></indexterm><literal>\det</literal> +</term><listitem><para><inlineequation><mathphrase>\deg</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\dim</literal></term> -<listitem><para>\dim +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dim</primary></indexterm><literal>\dim</literal> +</term><listitem><para><inlineequation><mathphrase>\dim</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\exp</literal></term> -<listitem><para>\exp +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\exp</primary></indexterm><literal>\exp</literal> +</term><listitem><para><inlineequation><mathphrase>\exp</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\gcd</literal></term> -<listitem><para>\gcd +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\gcd</primary></indexterm><literal>\gcd</literal> +</term><listitem><para><inlineequation><mathphrase>\gcd</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\hom</literal></term> -<listitem><para>\hom +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hom</primary></indexterm><literal>\hom</literal> +</term><listitem><para><inlineequation><mathphrase>\hom</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\inf</literal></term> -<listitem><para>\inf +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\inf</primary></indexterm><literal>\inf</literal> +</term><listitem><para><inlineequation><mathphrase>\inf</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\ker</literal></term> -<listitem><para>\ker +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ker</primary></indexterm><literal>\ker</literal> +</term><listitem><para><inlineequation><mathphrase>\ker</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\lg</literal></term> -<listitem><para>\lg +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lg</primary></indexterm><literal>\lg</literal> +</term><listitem><para><inlineequation><mathphrase>\lg</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\lim</literal></term> -<listitem><para>\lim +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lim</primary></indexterm><literal>\lim</literal> +</term><listitem><para><inlineequation><mathphrase>\lim</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\liminf</literal></term> -<listitem><para>\liminf +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\liminf</primary></indexterm><literal>\liminf</literal> +</term><listitem><para><inlineequation><mathphrase>\liminf</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\limsup</literal></term> -<listitem><para>\limsup +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\limsup</primary></indexterm><literal>\limsup</literal> +</term><listitem><para><inlineequation><mathphrase>\limsup</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\ln</literal></term> -<listitem><para>\ln +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ln</primary></indexterm><literal>\ln</literal> +</term><listitem><para><inlineequation><mathphrase>\ln</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\log</literal></term> -<listitem><para>\log +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\log</primary></indexterm><literal>\log</literal> +</term><listitem><para><inlineequation><mathphrase>\log</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\max</literal></term> -<listitem><para>\max +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\max</primary></indexterm><literal>\max</literal> +</term><listitem><para><inlineequation><mathphrase>\max</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\min</literal></term> -<listitem><para>\min +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\min</primary></indexterm><literal>\min</literal> +</term><listitem><para><inlineequation><mathphrase>\min</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\pmod</literal></term> -<listitem><para>parenthesized modulus, as in (\pmod 2^n - 1) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\pmod</primary></indexterm><literal>\pmod</literal> +</term><listitem><para>parenthesized modulus, as in (<inlineequation><mathphrase>\pmod 2^n - 1</mathphrase></inlineequation>) </para> -</listitem></varlistentry><varlistentry><term><literal>\Pr</literal></term> -<listitem><para>\Pr +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\Pr</primary></indexterm><literal>\Pr</literal> +</term><listitem><para><inlineequation><mathphrase>\Pr</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\sec</literal></term> -<listitem><para>\sec +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sec</primary></indexterm><literal>\sec</literal> +</term><listitem><para><inlineequation><mathphrase>\sec</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\sin</literal></term> -<listitem><para>\sin +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sin</primary></indexterm><literal>\sin</literal> +</term><listitem><para><inlineequation><mathphrase>\sin</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\sinh</literal></term> -<listitem><para>\sinh +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sinh</primary></indexterm><literal>\sinh</literal> +</term><listitem><para><inlineequation><mathphrase>\sinh</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\sup</literal></term> -<listitem><para>\sup +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sup</primary></indexterm><literal>\sup</literal> +</term><listitem><para><inlineequation><mathphrase>\sup</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\tan</literal></term> -<listitem><para>\tan +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tan</primary></indexterm><literal>\tan</literal> +</term><listitem><para><inlineequation><mathphrase>\tan</mathphrase></inlineequation> </para> -</listitem></varlistentry><varlistentry><term><literal>\tanh</literal></term> -<listitem><para>\tanh +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tanh</primary></indexterm><literal>\tanh</literal> +</term><listitem><para><inlineequation><mathphrase>\tanh</mathphrase></inlineequation> </para> </listitem></varlistentry></variablelist> - </sect1> <sect1 label="17.4" id="Math-accents"> <title>Math accents</title> -<indexterm role="cp"><primary>math accents</primary></indexterm><indexterm role="cp"><primary>accents, mathematical</primary></indexterm> +<indexterm role="cp"><primary>math accents</primary></indexterm> +<indexterm role="cp"><primary>accents, mathematical</primary></indexterm> + <para>&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>). +(see <link linkend="Accents">Accents</link>). +</para> +<variablelist><varlistentry><term><indexterm role="fn"><primary>\acute</primary></indexterm><literal>\acute</literal> +</term><listitem><indexterm role="cp"><primary>acute accent, math</primary></indexterm> +<para>Math acute accent: <inlineequation><mathphrase>\acute{x}</mathphrase></inlineequation>. </para> -<variablelist><varlistentry><term><literal>\acute</literal></term> -<listitem><indexterm role="cp"><primary>acute accent, math</primary></indexterm><para>Math acute accent: \acute{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\bar</primary></indexterm><literal>\bar</literal> +</term><listitem><indexterm role="cp"><primary>bar-over accent, math</primary></indexterm> +<indexterm role="cp"><primary>macron accent, math</primary></indexterm> +<para>Math bar-over accent: <inlineequation><mathphrase>\bar{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\bar</literal></term> -<listitem><indexterm role="cp"><primary>bar-over accent, math</primary></indexterm><indexterm role="cp"><primary>macron accent, math</primary></indexterm><para>Math bar-over accent: \bar{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\breve</primary></indexterm><literal>\breve</literal> +</term><listitem><indexterm role="cp"><primary>breve accent, math</primary></indexterm> +<para>Math breve accent: <inlineequation><mathphrase>\breve{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\breve</literal></term> -<listitem><indexterm role="cp"><primary>breve accent, math</primary></indexterm><para>Math breve accent: \breve{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\check</primary></indexterm><literal>\check</literal> +</term><listitem><indexterm role="cp"><primary>check accent, math</primary></indexterm> +<indexterm role="cp"><primary>háček accent, math</primary></indexterm> +<para>Math háček (check) accent: <inlineequation><mathphrase>\check{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\check</literal></term> -<listitem><indexterm role="cp"><primary>check accent, math</primary></indexterm><indexterm role="cp"><primary>hác<ek accent, math</primary></indexterm><para>Math hác<ek (check) accent: \check{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ddot</primary></indexterm><literal>\ddot</literal> +</term><listitem><indexterm role="cp"><primary>double dot accent, math</primary></indexterm> +<para>Math dieresis accent: <inlineequation><mathphrase>\ddot{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\ddot</literal></term> -<listitem><indexterm role="cp"><primary>double dot accent, math</primary></indexterm><para>Math dieresis accent: \ddot{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dot</primary></indexterm><literal>\dot</literal> +</term><listitem><indexterm role="cp"><primary>overdot accent, math</primary></indexterm> +<indexterm role="cp"><primary>dot over accent, math</primary></indexterm> +<para>Math dot accent: <inlineequation><mathphrase>\dot{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\dot</literal></term> -<listitem><indexterm role="cp"><primary>overdot accent, math</primary></indexterm><indexterm role="cp"><primary>dot over accent, math</primary></indexterm><para>Math dot accent: \dot{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\grave</primary></indexterm><literal>\grave</literal> +</term><listitem><indexterm role="cp"><primary>grave accent, math</primary></indexterm> +<para>Math grave accent: <inlineequation><mathphrase>\grave{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\grave</literal></term> -<listitem><indexterm role="cp"><primary>grave accent, math</primary></indexterm><para>Math grave accent: \grave{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\hat</primary></indexterm><literal>\hat</literal> +</term><listitem><indexterm role="cp"><primary>hat accent, math</primary></indexterm> +<indexterm role="cp"><primary>circumflex accent, math</primary></indexterm> +<para>Math hat (circumflex) accent: <inlineequation><mathphrase>\hat{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\hat</literal></term> -<listitem><indexterm role="cp"><primary>hat accent, math</primary></indexterm><indexterm role="cp"><primary>circumflex accent, math</primary></indexterm><para>Math hat (circumflex) accent: \hat{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\imath</primary></indexterm><literal>\imath</literal> +</term><listitem><indexterm role="cp"><primary>dotless i, math</primary></indexterm> +<para>Math dotless i. </para> -</listitem></varlistentry><varlistentry><term><literal>\imath</literal></term> -<listitem><indexterm role="cp"><primary>dotless i, math</primary></indexterm><para>Math dotless i. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\jmath</primary></indexterm><literal>\jmath</literal> +</term><listitem><indexterm role="cp"><primary>dotless j, math</primary></indexterm> +<para>Math dotless j. </para> -</listitem></varlistentry><varlistentry><term><literal>\jmath</literal></term> -<listitem><indexterm role="cp"><primary>dotless j, math</primary></indexterm><para>Math dotless j. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\mathring</primary></indexterm><literal>\mathring</literal> +</term><listitem><indexterm role="cp"><primary>ring accent, math</primary></indexterm> +<para>Math ring accent: x*. <!-- don't bother implementing in texinfo --> </para> -</listitem></varlistentry><varlistentry><term><literal>\tilde</literal></term> -<listitem><indexterm role="cp"><primary>tilde accent, math</primary></indexterm><para>Math tilde accent: \tilde{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\tilde</primary></indexterm><literal>\tilde</literal> +</term><listitem><indexterm role="cp"><primary>tilde accent, math</primary></indexterm> +<para>Math tilde accent: <inlineequation><mathphrase>\tilde{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\vec</literal></term> -<listitem><indexterm role="cp"><primary>vector symbol, math</primary></indexterm><para>Math vector symbol: \vec{x}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vec</primary></indexterm><literal>\vec</literal> +</term><listitem><indexterm role="cp"><primary>vector symbol, math</primary></indexterm> +<para>Math vector symbol: <inlineequation><mathphrase>\vec{x}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\widehat</literal></term> -<listitem><indexterm role="cp"><primary>wide hat accent, math</primary></indexterm><para>Math wide hat accent: \widehat{x+y}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\widehat</primary></indexterm><literal>\widehat</literal> +</term><listitem><indexterm role="cp"><primary>wide hat accent, math</primary></indexterm> +<para>Math wide hat accent: <inlineequation><mathphrase>\widehat{x+y}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\widehat</literal></term> -<listitem><indexterm role="cp"><primary>wide tile accent, math</primary></indexterm><para>Math wide tilde accent: \widetilde{x+y}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\widehat</primary></indexterm><literal>\widehat</literal> +</term><listitem><indexterm role="cp"><primary>wide tile accent, math</primary></indexterm> +<para>Math wide tilde accent: <inlineequation><mathphrase>\widetilde{x+y}</mathphrase></inlineequation>. </para> </listitem></varlistentry></variablelist> - </sect1> <sect1 label="17.5" id="Spacing-in-math-mode"> <title>Spacing in math mode</title> -<indexterm role="cp"><primary>spacing within math mode</primary></indexterm><indexterm role="cp"><primary>math mode, spacing</primary></indexterm> +<indexterm role="cp"><primary>spacing within math mode</primary></indexterm> +<indexterm role="cp"><primary>math mode, spacing</primary></indexterm> + <para>In a <literal>math</literal> environment, &latex; ignores the spaces you type and puts in the spacing according to the normal rules for mathematics texts. If you want different spacing, &latex; provides the following commands for use in math mode: </para> -<variablelist><varlistentry><term><literal>\;</literal></term> -<listitem><indexterm role="fn"><primary>\;</primary></indexterm><para>A thick space (5\over18\,quad). -</para></listitem></varlistentry><varlistentry><term><literal>\:</literal></term> -<term><literal>\></literal></term> -<listitem><indexterm role="fn"><primary>\:</primary></indexterm><indexterm role="fn"><primary>\></primary></indexterm><para>Both of these produce a medium space (2\over9\,quad). -</para></listitem></varlistentry><varlistentry><term><literal>\,</literal></term> -<listitem><indexterm role="fn"><primary>\,</primary></indexterm><para>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). +<variablelist><varlistentry><term><literal>\;</literal> +</term><listitem><indexterm role="fn"><primary>\;</primary></indexterm> +<para>A thick space (<inlineequation><mathphrase>5\over18\,</mathphrase></inlineequation>quad). +</para></listitem></varlistentry><varlistentry><term><literal>\:</literal> +</term><term><literal>\></literal> +</term><listitem><indexterm role="fn"><primary>\:</primary></indexterm> +<indexterm role="fn"><primary>\></primary></indexterm> +<para>Both of these produce a medium space (<inlineequation><mathphrase>2\over9\,</mathphrase></inlineequation>quad). +</para></listitem></varlistentry><varlistentry><term><literal>\,</literal> +</term><listitem><indexterm role="fn"><primary>\,</primary></indexterm> +<para>A thin space (<inlineequation><mathphrase>1\over6\,</mathphrase></inlineequation>quad); not restricted to math mode. +</para></listitem></varlistentry><varlistentry><term><literal>\!</literal> +</term><listitem><para>A negative thin space (<inlineequation><mathphrase>-{1\over6}\,</mathphrase></inlineequation>quad). </para></listitem></varlistentry></variablelist> - </sect1> <sect1 label="17.6" id="Math-miscellany"> <title>Math miscellany</title> <indexterm role="cp"><primary>math miscellany</primary></indexterm> -<variablelist><varlistentry><term><literal>\*</literal></term> -<listitem><indexterm role="cp"><primary>discretionary multiplication</primary></indexterm><indexterm role="cp"><primary>multiplication symbol, discretionary line break</primary></indexterm><para>A “discretionary” multiplication symbol, at which a line break is + +<variablelist> +<varlistentry><term><indexterm role="fn"><primary>\*</primary></indexterm><literal>\*</literal> +</term><listitem><indexterm role="cp"><primary>discretionary multiplication</primary></indexterm> +<indexterm role="cp"><primary>multiplication symbol, discretionary line break</primary></indexterm> +<para>A “discretionary” multiplication symbol, at which a line break is 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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\cdots</primary></indexterm><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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ddots</primary></indexterm><literal>\ddots</literal> +</term><listitem><para>A diagonal ellipsis: <inlineequation><mathphrase>\ddots</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\frac{num}{den}</literal></term> -<listitem><indexterm role="fn"><primary>\frac</primary></indexterm><para>Produces the fraction <literal>num</literal> divided by <literal>den</literal>. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\frac{num}{den}</primary></indexterm><literal>\frac{num}{den}</literal> +</term><listitem><indexterm role="fn"><primary>\frac</primary></indexterm> +<para>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><indexterm role="fn"><primary>\right</primary></indexterm><indexterm role="cp"><primary>null delimiter</primary></indexterm><para>The two delimiters need not match; ‘<literal>.</literal>’ acts as a null delimiter, +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\left <replaceable>delim1</replaceable> ... \right <replaceable>delim2</replaceable></primary></indexterm><literal>\left <replaceable>delim1</replaceable> ... \right <replaceable>delim2</replaceable></literal> +</term><listitem><indexterm role="fn"><primary>\right</primary></indexterm> +<indexterm role="cp"><primary>null delimiter</primary></indexterm> +<para>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, \overbrace{x+\cdots+x}^{k \rm\;times}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\overbrace{<replaceable>text</replaceable>}</primary></indexterm><literal>\overbrace{<replaceable>text</replaceable>}</literal> +</term><listitem><para>Generates a brace over <replaceable>text</replaceable>. +For example, <inlineequation><mathphrase>\overbrace{x+\cdots+x}^{k \rm\;times}</mathphrase></inlineequation>. </para> -</listitem></varlistentry><varlistentry><term><literal>\overline{<replaceable>text</replaceable>}</literal></term> -<listitem><para>Generates a horizontal line over <replaceable>tex</replaceable>. -For exampe, \overline{x+y}. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\overline{<replaceable>text</replaceable>}</primary></indexterm><literal>\overline{<replaceable>text</replaceable>}</literal> +</term><listitem><para>Generates a horizontal line over <replaceable>tex</replaceable>. +For exampe, <inlineequation><mathphrase>\overline{x+y}</mathphrase></inlineequation>. </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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\sqrt[<replaceable>root</replaceable>]{arg}</primary></indexterm><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, +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\stackrel{<replaceable>text</replaceable>}{<replaceable>relation</replaceable>}</primary></indexterm><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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\underbrace{math}</primary></indexterm><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 +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\underline{text}</primary></indexterm><literal>\underline{text}</literal> +</term><listitem><para>Causes <replaceable>text</replaceable>, which may be either math mode or not, to be underlined. The line is always below the text, taking account of descenders. </para> -</listitem></varlistentry><varlistentry><term><literal>\vdots</literal></term> -<listitem><indexterm role="fn"><primary>\vdots</primary></indexterm><para>Produces a vertical ellipsis. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\vdots</primary></indexterm><literal>\vdots</literal> +</term><listitem><indexterm role="fn"><primary>\vdots</primary></indexterm> +<para>Produces a vertical ellipsis. </para> </listitem></varlistentry></variablelist> - </sect1> </chapter> <chapter label="18" id="Modes"> <title>Modes</title> -<indexterm role="cp"><primary>modes</primary></indexterm><indexterm role="cp"><primary>paragraph mode</primary></indexterm><indexterm role="cp"><primary>math mode</primary></indexterm><indexterm role="cp"><primary>left-to-right mode</primary></indexterm><indexterm role="cp"><primary>lR mode</primary></indexterm> +<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>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> +<itemizedlist><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 +<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 +“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 @@ -4116,76 +4664,92 @@ 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”. +“inner paragraph mode”. Its normal paragraph mode, which it starts out +in, is called “outer paragraph mode”. </para> </chapter> <chapter label="19" id="Page-styles"> <title>Page styles</title> -<indexterm role="cp"><primary>styles, page</primary></indexterm><indexterm role="cp"><primary>page styles</primary></indexterm> +<indexterm role="cp"><primary>styles, page</primary></indexterm> +<indexterm role="cp"><primary>page styles</primary></indexterm> + <para>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. +the page’s head and foot. The page style determines what goes in them. </para> -<sect1 label="19.1"> +<sect1 label="19.1" id="_005cmaketitle"> <title><literal>\maketitle</literal></title> -<indexterm role="cp"><primary>titles, making</primary></indexterm><indexterm role="fn"><primary>\maketitle</primary></indexterm> +<indexterm role="cp"><primary>titles, making</primary></indexterm> +<indexterm role="fn"><primary>\maketitle</primary></indexterm> + <para>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 +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><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><para>The <literal>\author</literal> command declares the document author(s), where the +<variablelist><varlistentry><term><indexterm role="fn"><primary>\author{<replaceable>name</replaceable> \and <replaceable>name2</replaceable>}</primary></indexterm><literal>\author{<replaceable>name</replaceable> \and <replaceable>name2</replaceable>}</literal> +</term><listitem><indexterm role="cp"><primary>author, for titlepage</primary></indexterm> +<indexterm role="fn"><primary>\\ <lineannotation>for <literal>\author</literal></lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\and <lineannotation>for <literal>\author</literal></lineannotation></primary></indexterm> +<para>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. +<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><indexterm role="cp"><primary>date, for titlepage</primary></indexterm><para>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>) +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\date{<replaceable>text</replaceable>}</primary></indexterm><literal>\date{<replaceable>text</replaceable>}</literal> +</term><listitem><indexterm role="cp"><primary>date, for titlepage</primary></indexterm> +<para>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 <link linkend="_005ctoday">\today</link>) is used. </para> -</listitem></varlistentry><varlistentry><term><literal>\thanks{<replaceable>text</replaceable>}</literal></term> -<listitem><indexterm role="cp"><primary>thanks, for titlepage</primary></indexterm><indexterm role="cp"><primary>credit footnote</primary></indexterm><para>The <literal>\thanks</literal> command produces a <literal>\footnote</literal> to the title, +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\thanks{<replaceable>text</replaceable>}</primary></indexterm><literal>\thanks{<replaceable>text</replaceable>}</literal> +</term><listitem><indexterm role="cp"><primary>thanks, for titlepage</primary></indexterm> +<indexterm role="cp"><primary>credit footnote</primary></indexterm> +<para>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><indexterm role="cp"><primary>title, for titlepage</primary></indexterm><indexterm role="fn"><primary>\\ for <literal>\title</literal></primary></indexterm><para>The <literal>\title</literal> command declares <replaceable>text</replaceable> to be the title of the +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\title{<replaceable>text</replaceable>}</primary></indexterm><literal>\title{<replaceable>text</replaceable>}</literal> +</term><listitem><indexterm role="cp"><primary>title, for titlepage</primary></indexterm> +<indexterm role="fn"><primary>\\ <lineannotation>for <literal>\title</literal></lineannotation></primary></indexterm> +<para>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="19.2"> +<sect1 label="19.2" id="_005cpagenumbering"> <title><literal>\pagenumbering</literal></title> -<indexterm role="fn"><primary>\pagenumbering</primary></indexterm><indexterm role="cp"><primary>page numbering style</primary></indexterm> +<indexterm role="fn"><primary>\pagenumbering</primary></indexterm> +<indexterm role="cp"><primary>page numbering style</primary></indexterm> + <para>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 +<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="19.3"> +<sect1 label="19.3" id="_005cpagestyle"> <title><literal>\pagestyle</literal></title> -<indexterm role="fn"><primary>\pagestyle</primary></indexterm><indexterm role="cp"><primary>header style</primary></indexterm><indexterm role="cp"><primary>footer style</primary></indexterm><indexterm role="cp"><primary>running header and footer style</primary></indexterm> +<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> + <para>Synopsis: </para> <screen>\pagestyle{<replaceable>style</replaceable>} @@ -4193,42 +4757,41 @@ document. Use <literal>\\</literal> to force a line break, as usual. <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. +<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. +</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 +</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 +</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” +<variablelist><varlistentry><term><indexterm role="fn"><primary>\markboth{<replaceable>left</replaceable>}{<replaceable>right</replaceable>}</primary></indexterm><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 +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. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\markright{<replaceable>right</replaceable>}</primary></indexterm><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="19.4"> +<sect1 label="19.4" id="_005cthispagestyle"> <title><literal>\thispagestyle{<replaceable>style</replaceable>}</literal></title> <indexterm role="fn"><primary>\thispagestyle</primary></indexterm> + <para>The <literal>\thispagestyle</literal> command works in the same manner as the <literal>\pagestyle</literal> command (see previous section) except that it changes to <replaceable>style</replaceable> for the current page only. @@ -4239,17 +4802,19 @@ changes to <replaceable>style</replaceable> for the current page only. <chapter label="20" id="Spaces"> <title>Spaces</title> <indexterm role="cp"><primary>spaces</primary></indexterm> + <para>&latex; has many ways to produce white (or filled) space. </para> -<para>Another space-producing command is <literal>\,</literal> to produce a “thin” +<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>). +more often useful in math mode (see <link linkend="Spacing-in-math-mode">Spacing in math mode</link>). </para> -<sect1 label="20.1"> +<sect1 label="20.1" id="_005chspace"> <title><literal>\hspace</literal></title> <indexterm role="fn"><primary>\hspace</primary></indexterm> + <para>Synopsis: </para> <screen>\hspace[*]{<replaceable>length</replaceable>} @@ -4266,24 +4831,29 @@ form. </para> </sect1> -<sect1 label="20.2"> +<sect1 label="20.2" id="_005chfill"> <title><literal>\hfill</literal></title> -<indexterm role="fn"><primary>\hfill</primary></indexterm><para>The <literal>\hfill</literal> fill command produces a “rubber length” which has +<indexterm role="fn"><primary>\hfill</primary></indexterm> +<para>The <literal>\hfill</literal> fill command produces a “rubber length” which has no natural space but can stretch or shrink horizontally as far as needed. </para> -<indexterm role="fn"><primary>\fill</primary></indexterm><para>The <literal>\fill</literal> parameter is the rubber length itself (technically, -the glue value ‘<literal>0pt plus1fill</literal>’); thus, <literal>\hspace\fill</literal> is +<indexterm role="fn"><primary>\fill</primary></indexterm> +<para>The <literal>\fill</literal> parameter is the rubber length itself (technically, +the glue value ‘<literal>0pt plus1fill</literal>’); thus, <literal>\hspace\fill</literal> is equivalent to <literal>\hfill</literal>. </para> </sect1> -<sect1 label="20.3"> +<sect1 label="20.3" id="_005cSPACE"> <title><literal>\SPACE</literal></title> -<indexterm role="fn"><primary>\SPACE</primary></indexterm><indexterm role="fn"><primary>\TAB</primary></indexterm><indexterm role="fn"><primary>\NEWLINE</primary></indexterm> -<para>The <literal>\ </literal> (space) command produces a normal interword space. It's -useful after punctuation which shouldn't end a sentence. For example +<indexterm role="fn"><primary>\SPACE</primary></indexterm> +<indexterm role="fn"><primary>\TAB</primary></indexterm> +<indexterm role="fn"><primary>\NEWLINE</primary></indexterm> + +<para>The <literal>\ </literal> (space) command produces a normal interword space. It’s +useful after punctuation which shouldn’t end a sentence. For example <literal>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> @@ -4293,79 +4863,86 @@ are equivalent to <literal>\ </literal>. </para> </sect1> -<sect1 label="20.4"> +<sect1 label="20.4" id="_005cAT"> <title><literal>\@</literal></title> <indexterm role="fn"><primary>\@</primary></indexterm> + <para>The <literal>\@</literal> command makes the following punctuation character end a sentence even if it normally would not. This is typically used after a capital letter. Here are side-by-side examples with and without <literal>\@</literal>: </para> -<screen>… in C\@. Pascal, though … -… in C. Pascal, though … +<screen>… in C\@. Pascal, though … +… in C. Pascal, though … </screen> <para>produces </para> <!-- Texinfo does it differently, but the result is the same. --> -<blockquote><para>… in C. Pascal, though … -… in C. Pascal, though … +<blockquote><para>… in C. Pascal, though … +… in C. Pascal, though … </para></blockquote> - </sect1> -<sect1 label="20.5"> +<sect1 label="20.5" id="_005cthinspace"> <title><literal>\thinspace</literal></title> <indexterm role="fn"><primary>\thinspace</primary></indexterm> + <para><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 '”. +in ’”. </para> </sect1> -<sect1 label="20.6"> +<sect1 label="20.6" id="_005c_002f"> <title><literal>\/</literal></title> <indexterm role="fn"><primary>\/</primary></indexterm> + <para>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. +<emphasis>f</emphasis> character typically has a large italic correction value. </para> -<para>If the following character is a period or comma, it's not necessary to +<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>. +<emphasis>f: f;</emphasis> (in the &tex; output, the ‘f’s are nicely separated) +with <emphasis>f: f;</emphasis>. </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') +pdf&tex; (in the &tex; output, there is a small space after the ‘f’) with pdf&tex;. </para> </sect1> -<sect1 label="20.7"> +<sect1 label="20.7" id="_005chrulefill"> <title><literal>\hrulefill</literal></title> <indexterm role="fn"><primary>\hrulefill</primary></indexterm> -<para>The <literal>\hrulefill</literal> fill command produces a “rubber length” which can + +<para>The <literal>\hrulefill</literal> fill command produces a “rubber length” which can stretch or shrink horizontally. It will be filled with a horizontal rule. </para> </sect1> -<sect1 label="20.8"> +<sect1 label="20.8" id="_005cdotfill"> <title><literal>\dotfill</literal></title> <indexterm role="fn"><primary>\dotfill</primary></indexterm> -<para>The <literal>\dotfill</literal> command produces a “rubber length” that fills + +<para>The <literal>\dotfill</literal> command produces a “rubber length” that fills with dots instead of just white space. </para> <!-- xx undone --> </sect1> -<sect1 label="20.9"> +<sect1 label="20.9" id="_005caddvspace"> <title><literal>\addvspace</literal></title> -<indexterm role="fn"><primary>\addvspace</primary></indexterm><indexterm role="cp"><primary>vertical space</primary></indexterm><indexterm role="cp"><primary>space, inserting vertical</primary></indexterm> +<indexterm role="fn"><primary>\addvspace</primary></indexterm> +<indexterm role="cp"><primary>vertical space</primary></indexterm> +<indexterm role="cp"><primary>space, inserting vertical</primary></indexterm> + <para><literal>\addvspace{length}</literal> </para> <para>The <literal>\addvspace</literal> command normally adds a vertical space of height @@ -4376,41 +4953,48 @@ of the total vertical space equal to <literal>length</literal>. </para> </sect1> -<sect1 label="20.10"> +<sect1 label="20.10" id="_005cbigskip-_005cmedskip-_005csmallskip"> <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><indexterm role="fn"><primary>\bigskip</primary></indexterm><indexterm role="fn"><primary>\bigskipamount</primary></indexterm><para>The same as <literal>\vspace{bigskipamount}</literal>, ordinarily about one line +<variablelist><varlistentry><term><literal>\bigskip</literal> +</term><listitem><indexterm role="fn"><primary>\bigskip</primary></indexterm> +<indexterm role="fn"><primary>\bigskipamount</primary></indexterm> +<para>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><indexterm role="fn"><primary>\medskip</primary></indexterm><indexterm role="fn"><primary>\medskipamount</primary></indexterm><para>The same as <literal>\vspace{medskipamount}</literal>, ordinarily +</listitem></varlistentry><varlistentry><term><literal>\medskip</literal> +</term><listitem><indexterm role="fn"><primary>\medskip</primary></indexterm> +<indexterm role="fn"><primary>\medskipamount</primary></indexterm> +<para>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><indexterm role="fn"><primary>\smallskip</primary></indexterm><indexterm role="fn"><primary>\smallskipamount</primary></indexterm><para>The same as <literal>\vspace{smallskipamount}</literal>, ordinarily about a +</listitem></varlistentry><varlistentry><term><literal>\smallskip</literal> +</term><listitem><indexterm role="fn"><primary>\smallskip</primary></indexterm> +<indexterm role="fn"><primary>\smallskipamount</primary></indexterm> +<para>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="20.11"> +<sect1 label="20.11" id="_005cvfill"> <title><literal>\vfill</literal></title> <indexterm role="fn"><primary>\vfill</primary></indexterm> + <para>The <literal>\vfill</literal> fill command produces a rubber length (glue) which -can stretch or shrink vertically as far as needed. It's equivalent to -<literal>\vspace{\fill}</literal> (see <xref linkend="\hfill"></xref>). +can stretch or shrink vertically as far as needed. It’s equivalent to +<literal>\vspace{\fill}</literal> (see <link linkend="_005chfill">\hfill</link>). </para> </sect1> -<sect1 label="20.12"> +<sect1 label="20.12" id="_005cvspace"> <title><literal>\vspace[*]{<replaceable>length</replaceable>}</literal></title> <indexterm role="fn"><primary>\vspace</primary></indexterm> + <para>Synopsis: </para> <screen>\vspace[*]{<replaceable>length</replaceable>} @@ -4429,24 +5013,29 @@ space is not removed. <title>Boxes</title> <indexterm role="cp"><primary>boxes</primary></indexterm> -<para>All the predefined length parameters (see <xref linkend="Predefined-lengths"></xref>) can be + +<para>All the predefined length parameters (see <link linkend="Predefined-lengths">Predefined lengths</link>) can be used in the arguments of the box-making commands. </para> -<sect1 label="21.1"> +<sect1 label="21.1" id="_005cmbox"> <title><literal>\mbox{<replaceable>text}</replaceable></literal></title> <indexterm role="fn"><primary>\mbox</primary></indexterm> -<indexterm role="cp"><primary>hyphenation, preventing</primary></indexterm><para>The <literal>\mbox</literal> command creates a box just wide enough to hold the + +<indexterm role="cp"><primary>hyphenation, preventing</primary></indexterm> +<para>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="21.2"> +<sect1 label="21.2" id="_005cfbox-and-_005cframebox"> <title><literal>\fbox</literal> and <literal>\framebox</literal></title> -<indexterm role="fn"><primary>\fbox</primary></indexterm><indexterm role="fn"><primary>\framebox</primary></indexterm> +<indexterm role="fn"><primary>\fbox</primary></indexterm> +<indexterm role="fn"><primary>\framebox</primary></indexterm> + <para>Synopses: </para> <screen>\fbox{<replaceable>text</replaceable>} @@ -4460,18 +5049,21 @@ specification of the box width with the optional <replaceable>width</replaceable (a dimension), and positioning with the optional <replaceable>position</replaceable> argument. <!-- xxref --> </para> -<indexterm role="fn"><primary>\fboxrule</primary></indexterm><indexterm role="fn"><primary>\fboxsep</primary></indexterm><para>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. +<indexterm role="fn"><primary>\fboxrule</primary></indexterm> +<indexterm role="fn"><primary>\fboxsep</primary></indexterm> +<para>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 +<para>See <link linkend="_005cframebox-_0028picture_0029">\framebox (picture)</link>, for the <literal>\framebox</literal> command in the <literal>picture</literal> environment. </para> </sect1> -<sect1 label="21.3"> +<sect1 label="21.3" id="lrbox"> <title><literal>lrbox</literal></title> <indexterm role="fn"><primary>lrbox</primary></indexterm> + <para><literal>\begin{lrbox}{cmd} text \end{lrbox}</literal> </para> <para>This is the environment form of <literal>\sbox</literal>. @@ -4481,9 +5073,10 @@ must have been declared with <literal>\newsavebox</literal>. </para> </sect1> -<sect1 label="21.4"> +<sect1 label="21.4" id="_005cmakebox"> <title><literal>\makebox</literal></title> <indexterm role="fn"><primary>\makebox</primary></indexterm> + <para>Synopsis: </para> <screen>\makebox[<replaceable>width</replaceable>][<replaceable>position</replaceable>]{<replaceable>text</replaceable>} @@ -4494,25 +5087,25 @@ optional <replaceable>width</replaceable> argument. The position of the text wi 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 +<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>. +see <link linkend="_005cmakebox-_0028picture_0029">\makebox (picture)</link>. </para> </sect1> -<sect1 label="21.5"> +<sect1 label="21.5" id="_005cparbox"> <title><literal>\parbox</literal></title> <indexterm role="fn"><primary>\parbox</primary></indexterm> + <para>Synopsis: </para> <screen>\parbox[<replaceable>position</replaceable>][<replaceable>height</replaceable>][<replaceable>inner-pos</replaceable>]{<replaceable>width</replaceable>}{<replaceable>text</replaceable>} @@ -4520,19 +5113,18 @@ see <xref linkend="\makebox-(picture)"></xref>. <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 +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>). +<literal>minipage</literal> environment (see <link linkend="minipage">minipage</link>). </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. +<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). @@ -4542,22 +5134,22 @@ text (default is top). <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 +<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="21.6"> +<sect1 label="21.6" id="_005craisebox"> <title><literal>\raisebox</literal></title> <indexterm role="fn"><primary>\raisebox</primary></indexterm> + <para>Synopsis: </para> <screen>\raisebox{distance}[<replaceable>height</replaceable>][<replaceable>depth</replaceable>]{text} @@ -4574,44 +5166,47 @@ ignoring its natural height and depth. </para> </sect1> -<sect1 label="21.7"> +<sect1 label="21.7" id="_005csavebox"> <title><literal>\savebox</literal></title> <indexterm role="fn"><primary>\savebox</primary></indexterm> + <para>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, +(see <link linkend="_005cmakebox">\makebox</link>), 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>). +declared with <literal>\newsavebox</literal> (see <link linkend="_005cnewsavebox">\newsavebox</link>). </para> </sect1> -<sect1 label="21.8"> +<sect1 label="21.8" id="_005csbox"> <title><literal>\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>}</literal></title> <indexterm role="fn"><primary>\sbox</primary></indexterm> + <para>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 +(see <link linkend="_005cmbox">\mbox</link>) 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>). +<literal>\newsavebox</literal> (see <link linkend="_005cnewsavebox">\newsavebox</link>). </para> </sect1> -<sect1 label="21.9"> +<sect1 label="21.9" id="_005cusebox"> <title><literal>\usebox{<replaceable>\boxcmd</replaceable></literal></title> <indexterm role="fn"><primary>\usebox</primary></indexterm> + <para>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>). +<replaceable>\boxcmd</replaceable> by a <literal>\savebox</literal> command (see <link linkend="_005csavebox">\savebox</link>). </para> </sect1> @@ -4626,28 +5221,42 @@ special meaning do not correspond to simple characters you can type. <sect1 label="22.1" id="Reserved-characters"> <title>Reserved characters</title> -<indexterm role="cp"><primary>reserved characters</primary></indexterm><indexterm role="cp"><primary>characters, reserved</primary></indexterm> +<indexterm role="cp"><primary>reserved characters</primary></indexterm> +<indexterm role="cp"><primary>characters, reserved</primary></indexterm> + <para>The following characters play a special role in &latex; and are called -“reserved characters” or “special characters”. +“reserved characters” or “special characters”. </para> <screen># $ % & ~ _ ^ \ { } </screen> -<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><para>Whenever you write one of these characters into your file, &latex; +<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> +<para>Whenever you write one of these characters into your file, &latex; will do something special. If you simply want the character to be printed as itself, include a <literal>\</literal> in front of the character. For example, <literal>\$</literal> will produce <literal>$</literal> in your output. </para> -<indexterm role="fn"><primary>\backslash</primary></indexterm><para>One exception to this rule is <literal>\</literal> itself, because <literal>\\</literal> has +<indexterm role="fn"><primary>\backslash</primary></indexterm> +<para>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>). +produced by using ‘<literal>\</literal>’ in a verbatim command (see <link linkend="verbatim">verbatim</link>). </para> -<indexterm role="fn"><primary>\~</primary></indexterm><indexterm role="fn"><primary>\^</primary></indexterm><para>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 +<indexterm role="fn"><primary>\~</primary></indexterm> +<indexterm role="fn"><primary>\^</primary></indexterm> +<para>Also, <literal>\~</literal> and <literal>\^</literal> place tilde and circumflex accents over +the following letter, as in õ and ô (see <link linkend="Accents">Accents</link>); to get a standalone <literal>~</literal> or <literal>^</literal>, you can again use a verbatim command. </para> -<indexterm role="fn"><primary>\symbol</primary></indexterm><indexterm role="cp"><primary>accessing any character of a font</primary></indexterm> +<indexterm role="fn"><primary>\symbol</primary></indexterm> +<indexterm role="cp"><primary>accessing any character of a font</primary></indexterm> + <para>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 @@ -4662,187 +5271,286 @@ with <literal>"</literal>, so the previous example could also be written as <sect1 label="22.2" id="Text-symbols"> <title>Text symbols</title> -<indexterm role="cp"><primary>text symbols</primary></indexterm><indexterm role="fn"><primary>textcomp package</primary></indexterm><para>&latex; provides commands to generate a number of non-letter symbols +<indexterm role="cp"><primary>text symbols</primary></indexterm> +<indexterm role="fn"><primary>textcomp <lineannotation>package</lineannotation></primary></indexterm> +<para>&latex; provides commands to generate a number of non-letter symbols in running text. Some of these, especially the more obscure ones, are not available in OT1; you may need to load the <literal>textcomp</literal> package. </para> -<variablelist><varlistentry><term><literal>\copyright</literal></term> -<term><literal>\textcopyright</literal></term> -<listitem><indexterm role="cp"><primary>copyright symbol</primary></indexterm><para>The copyright symbol, ©. -</para> -</listitem></varlistentry><varlistentry><term><literal>\dag</literal></term> -<listitem><indexterm role="cp"><primary>dagger, in text</primary></indexterm><para>The dagger symbol (in text). -</para> -</listitem></varlistentry><varlistentry><term><literal>\ddag</literal></term> -<listitem><indexterm role="cp"><primary>double dagger, in text</primary></indexterm><para>The double dagger symbol (in text). -</para> -</listitem></varlistentry><varlistentry><term><literal>\LaTeX</literal></term> -<listitem><indexterm role="cp"><primary>&latex; logo</primary></indexterm><indexterm role="cp"><primary>logo, &latex;</primary></indexterm><para>The &latex; logo. -</para> -</listitem></varlistentry><varlistentry><term><literal>\guillemotleft («)</literal></term> -<term><literal>\guillemotright (»)</literal></term> -<term><literal>\guilsinglleft (<)</literal></term> -<term><literal>\guilsinglright (>)</literal></term> -<listitem><indexterm role="cp"><primary>double guillemets</primary></indexterm><indexterm role="cp"><primary>single guillemets</primary></indexterm><indexterm role="cp"><primary>left angle quotation marks</primary></indexterm><indexterm role="cp"><primary>right angle quotation marks</primary></indexterm><indexterm role="cp"><primary>double angle quotation marks</primary></indexterm><indexterm role="cp"><primary>single angle quotation marks</primary></indexterm><indexterm role="cp"><primary>French quotation marks</primary></indexterm><indexterm role="cp"><primary>quotation marks, French</primary></indexterm><para>Double and single angle quotation marks, commonly used in French: -«, », <, >. -</para> -</listitem></varlistentry><varlistentry><term><literal>\ldots</literal></term> -<term><literal>\dots</literal></term> -<term><literal>\textellipsis</literal></term> -<listitem><indexterm role="cp"><primary>ellipsis</primary></indexterm><para>An ellipsis (three dots at the baseline): `…'. <literal>\ldots</literal> +<variablelist> +<varlistentry><term><indexterm role="fn"><primary>\copyright</primary></indexterm><literal>\copyright</literal> +</term><term><indexterm role="fn"><primary>\textcopyright</primary></indexterm><literal>\textcopyright</literal> +</term><listitem><indexterm role="cp"><primary>copyright symbol</primary></indexterm> +<para>The copyright symbol, ©. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\dag</primary></indexterm><literal>\dag</literal> +</term><listitem><indexterm role="cp"><primary>dagger, in text</primary></indexterm> +<para>The dagger symbol (in text). +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ddag</primary></indexterm><literal>\ddag</literal> +</term><listitem><indexterm role="cp"><primary>double dagger, in text</primary></indexterm> +<para>The double dagger symbol (in text). +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\LaTeX</primary></indexterm><literal>\LaTeX</literal> +</term><listitem><indexterm role="cp"><primary>&latex; logo</primary></indexterm> +<indexterm role="cp"><primary>logo, &latex;</primary></indexterm> +<para>The &latex; logo. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\guillemotleft <lineannotation>(«)</lineannotation></primary></indexterm><literal>\guillemotleft <lineannotation>(«)</lineannotation></literal> +</term><term><indexterm role="fn"><primary>\guillemotright <lineannotation>(»)</lineannotation></primary></indexterm><literal>\guillemotright <lineannotation>(»)</lineannotation></literal> +</term><term><indexterm role="fn"><primary>\guilsinglleft <lineannotation>(‹)</lineannotation></primary></indexterm><literal>\guilsinglleft <lineannotation>(‹)</lineannotation></literal> +</term><term><indexterm role="fn"><primary>\guilsinglright <lineannotation>(›)</lineannotation></primary></indexterm><literal>\guilsinglright <lineannotation>(›)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>double guillemets</primary></indexterm> +<indexterm role="cp"><primary>single guillemets</primary></indexterm> +<indexterm role="cp"><primary>left angle quotation marks</primary></indexterm> +<indexterm role="cp"><primary>right angle quotation marks</primary></indexterm> +<indexterm role="cp"><primary>double angle quotation marks</primary></indexterm> +<indexterm role="cp"><primary>single angle quotation marks</primary></indexterm> +<indexterm role="cp"><primary>French quotation marks</primary></indexterm> +<indexterm role="cp"><primary>quotation marks, French</primary></indexterm> +<para>Double and single angle quotation marks, commonly used in French: +«, », ‹, ›. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\ldots</primary></indexterm><literal>\ldots</literal> +</term><term><indexterm role="fn"><primary>\dots</primary></indexterm><literal>\dots</literal> +</term><term><indexterm role="fn"><primary>\textellipsis</primary></indexterm><literal>\textellipsis</literal> +</term><listitem><indexterm role="cp"><primary>ellipsis</primary></indexterm> +<para>An ellipsis (three dots at the baseline): ‘…’. <literal>\ldots</literal> and <literal>\dots</literal> also work in math mode. </para> -</listitem></varlistentry><varlistentry><term><literal>\lq</literal></term> -<listitem><indexterm role="cp"><primary>left quote</primary></indexterm><indexterm role="cp"><primary>opening quote</primary></indexterm><para>Left (opening) quote: `. -</para> -</listitem></varlistentry><varlistentry><term><literal>\P</literal></term> -<term><literal>\textparagraph</literal></term> -<listitem><indexterm role="cp"><primary>paragraph symbol</primary></indexterm><indexterm role="cp"><primary>pilcrow</primary></indexterm><para>Paragraph sign (pilcrow). -</para> -</listitem></varlistentry><varlistentry><term><literal>\pounds</literal></term> -<term><literal>\textsterling</literal></term> -<listitem><indexterm role="cp"><primary>pounds symbol</primary></indexterm><indexterm role="cp"><primary>sterling symbol</primary></indexterm><para>English pounds sterling: £. -</para> -</listitem></varlistentry><varlistentry><term><literal>\quotedblbase („)</literal></term> -<term><literal>\quotesinglbase (‚)</literal></term> -<listitem><indexterm role="cp"><primary>double low-9 quotation mark</primary></indexterm><indexterm role="cp"><primary>single low-9 quotation mark</primary></indexterm><indexterm role="cp"><primary>low-9 quotation marks, single and double</primary></indexterm><para>Double and single quotation marks on the baseline: -„ and ‚. -</para> -</listitem></varlistentry><varlistentry><term><literal>\rq</literal></term> -<listitem><indexterm role="cp"><primary>right quote</primary></indexterm><indexterm role="cp"><primary>closing quote</primary></indexterm><para>Right (closing) quote: '. -</para> -</listitem></varlistentry><varlistentry><term><literal>\S</literal></term> -<listitem><indexterm role="cp"><primary>section symbol</primary></indexterm><para>Section symbol. -</para> -</listitem></varlistentry><varlistentry><term><literal>\TeX</literal></term> -<listitem><indexterm role="cp"><primary>&tex; logo</primary></indexterm><indexterm role="cp"><primary>logo, &tex;</primary></indexterm><para>The &tex; logo. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textasciicircum</literal></term> -<listitem><indexterm role="cp"><primary>circumflex, ASCII, in text</primary></indexterm><indexterm role="cp"><primary>ASCII circumflex, in text</primary></indexterm><para>ASCII circumflex: ^. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textasciitilde</literal></term> -<listitem><indexterm role="cp"><primary>tilde, ASCII, in text</primary></indexterm><indexterm role="cp"><primary>ASCII tilde, in text</primary></indexterm><para>ASCII tilde: ~. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textasteriskcentered</literal></term> -<listitem><indexterm role="cp"><primary>asterisk, centered, in text</primary></indexterm><indexterm role="cp"><primary>centered asterisk, in text</primary></indexterm><para>Centered asterisk: *. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbackslash</literal></term> -<listitem><indexterm role="cp"><primary>backslash, in text</primary></indexterm><para>Backslash: \. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbar</literal></term> -<listitem><indexterm role="cp"><primary>vertical bar, in text</primary></indexterm><indexterm role="cp"><primary>bar, vertical, in text</primary></indexterm><para>Vertical bar: |. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbardbl</literal></term> -<listitem><indexterm role="cp"><primary>vertical bar, double, in text</primary></indexterm><indexterm role="cp"><primary>bar, double vertical, in text</primary></indexterm><indexterm role="cp"><primary>double vertical bar, in text</primary></indexterm><para>Double vertical bar. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbigcircle</literal></term> -<listitem><indexterm role="cp"><primary>big circle symbols, in text</primary></indexterm><indexterm role="cp"><primary>circle symbol, big, in text</primary></indexterm><para>Big circle symbol. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbraceleft</literal></term> -<listitem><indexterm role="cp"><primary>left brace, in text</primary></indexterm><indexterm role="cp"><primary>brace, left, in text</primary></indexterm><para>Left brace: {. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbraceright</literal></term> -<listitem><indexterm role="cp"><primary>right brace, in text</primary></indexterm><indexterm role="cp"><primary>brace, right, in text</primary></indexterm><para>Right brace: }. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textbullet</literal></term> -<listitem><indexterm role="cp"><primary>bullet, in text</primary></indexterm><para>Bullet: •. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textcircled{<replaceable>letter</replaceable>}</literal></term> -<listitem><indexterm role="cp"><primary>circled letter, in text</primary></indexterm><para><replaceable>letter</replaceable> in a circle, as in ®. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textcompwordmark</literal></term> -<term><literal>\textcapitalwordmark</literal></term> -<term><literal>\textascenderwordmark</literal></term> -<listitem><indexterm role="cp"><primary>composite word mark, in text</primary></indexterm><indexterm role="cp"><primary>cap height</primary></indexterm><indexterm role="cp"><primary>ascender height</primary></indexterm><para>Composite word mark (invisible). The <literal>\textcapital...</literal> form +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\lq</primary></indexterm><literal>\lq</literal> +</term><listitem><indexterm role="cp"><primary>left quote</primary></indexterm> +<indexterm role="cp"><primary>opening quote</primary></indexterm> +<para>Left (opening) quote: ‘. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\P</primary></indexterm><literal>\P</literal> +</term><term><indexterm role="fn"><primary>\textparagraph</primary></indexterm><literal>\textparagraph</literal> +</term><listitem><indexterm role="cp"><primary>paragraph symbol</primary></indexterm> +<indexterm role="cp"><primary>pilcrow</primary></indexterm> +<para>Paragraph sign (pilcrow). +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\pounds</primary></indexterm><literal>\pounds</literal> +</term><term><indexterm role="fn"><primary>\textsterling</primary></indexterm><literal>\textsterling</literal> +</term><listitem><indexterm role="cp"><primary>pounds symbol</primary></indexterm> +<indexterm role="cp"><primary>sterling symbol</primary></indexterm> +<para>English pounds sterling: £. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\quotedblbase <lineannotation>(„)</lineannotation></primary></indexterm><literal>\quotedblbase <lineannotation>(„)</lineannotation></literal> +</term><term><indexterm role="fn"><primary>\quotesinglbase <lineannotation>(‚)</lineannotation></primary></indexterm><literal>\quotesinglbase <lineannotation>(‚)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>double low-9 quotation mark</primary></indexterm> +<indexterm role="cp"><primary>single low-9 quotation mark</primary></indexterm> +<indexterm role="cp"><primary>low-9 quotation marks, single and double</primary></indexterm> +<para>Double and single quotation marks on the baseline: +„ and ‚. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\rq</primary></indexterm><literal>\rq</literal> +</term><listitem><indexterm role="cp"><primary>right quote</primary></indexterm> +<indexterm role="cp"><primary>closing quote</primary></indexterm> +<para>Right (closing) quote: ’. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\S</primary></indexterm><literal>\S</literal> +</term><listitem><indexterm role="cp"><primary>section symbol</primary></indexterm> +<para>Section symbol. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\TeX</primary></indexterm><literal>\TeX</literal> +</term><listitem><indexterm role="cp"><primary>&tex; logo</primary></indexterm> +<indexterm role="cp"><primary>logo, &tex;</primary></indexterm> +<para>The &tex; logo. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textasciicircum</primary></indexterm><literal>\textasciicircum</literal> +</term><listitem><indexterm role="cp"><primary>circumflex, ASCII, in text</primary></indexterm> +<indexterm role="cp"><primary>ASCII circumflex, in text</primary></indexterm> +<para>ASCII circumflex: ^. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textasciitilde</primary></indexterm><literal>\textasciitilde</literal> +</term><listitem><indexterm role="cp"><primary>tilde, ASCII, in text</primary></indexterm> +<indexterm role="cp"><primary>ASCII tilde, in text</primary></indexterm> +<para>ASCII tilde: ~. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textasteriskcentered</primary></indexterm><literal>\textasteriskcentered</literal> +</term><listitem><indexterm role="cp"><primary>asterisk, centered, in text</primary></indexterm> +<indexterm role="cp"><primary>centered asterisk, in text</primary></indexterm> +<para>Centered asterisk: *. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textbackslash</primary></indexterm><literal>\textbackslash</literal> +</term><listitem><indexterm role="cp"><primary>backslash, in text</primary></indexterm> +<para>Backslash: \. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textbar</primary></indexterm><literal>\textbar</literal> +</term><listitem><indexterm role="cp"><primary>vertical bar, in text</primary></indexterm> +<indexterm role="cp"><primary>bar, vertical, in text</primary></indexterm> +<para>Vertical bar: |. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textbardbl</primary></indexterm><literal>\textbardbl</literal> +</term><listitem><indexterm role="cp"><primary>vertical bar, double, in text</primary></indexterm> +<indexterm role="cp"><primary>bar, double vertical, in text</primary></indexterm> +<indexterm role="cp"><primary>double vertical bar, in text</primary></indexterm> +<para>Double vertical bar. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textbigcircle</primary></indexterm><literal>\textbigcircle</literal> +</term><listitem><indexterm role="cp"><primary>big circle symbols, in text</primary></indexterm> +<indexterm role="cp"><primary>circle symbol, big, in text</primary></indexterm> +<para>Big circle symbol. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textbraceleft</primary></indexterm><literal>\textbraceleft</literal> +</term><listitem><indexterm role="cp"><primary>left brace, in text</primary></indexterm> +<indexterm role="cp"><primary>brace, left, in text</primary></indexterm> +<para>Left brace: {. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textbraceright</primary></indexterm><literal>\textbraceright</literal> +</term><listitem><indexterm role="cp"><primary>right brace, in text</primary></indexterm> +<indexterm role="cp"><primary>brace, right, in text</primary></indexterm> +<para>Right brace: }. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textbullet</primary></indexterm><literal>\textbullet</literal> +</term><listitem><indexterm role="cp"><primary>bullet, in text</primary></indexterm> +<para>Bullet: •. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textcircled{<replaceable>letter</replaceable>}</primary></indexterm><literal>\textcircled{<replaceable>letter</replaceable>}</literal> +</term><listitem><indexterm role="cp"><primary>circled letter, in text</primary></indexterm> +<para><replaceable>letter</replaceable> in a circle, as in ®. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textcompwordmark</primary></indexterm><literal>\textcompwordmark</literal> +</term><term><indexterm role="fn"><primary>\textcapitalwordmark</primary></indexterm><literal>\textcapitalwordmark</literal> +</term><term><indexterm role="fn"><primary>\textascenderwordmark</primary></indexterm><literal>\textascenderwordmark</literal> +</term><listitem><indexterm role="cp"><primary>composite word mark, in text</primary></indexterm> +<indexterm role="cp"><primary>cap height</primary></indexterm> +<indexterm role="cp"><primary>ascender height</primary></indexterm> +<para>Composite word mark (invisible). The <literal>\textcapital...</literal> form has the cap height of the font, while the <literal>\textascender...</literal> form has the ascender height. </para> -</listitem></varlistentry><varlistentry><term><literal>\textdagger</literal></term> -<listitem><indexterm role="cp"><primary>dagger, in text</primary></indexterm><para>Dagger: \dag. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textdaggerdbl</literal></term> -<listitem><indexterm role="cp"><primary>dagger, double, in text</primary></indexterm><indexterm role="cp"><primary>double dagger, in text</primary></indexterm><para>Double dagger: \ddag. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textdollar (or <literal>$</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>dollar sign</primary></indexterm><indexterm role="cp"><primary>currency, dollar</primary></indexterm><para>Dollar sign: $. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textemdash (or <literal>---</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>em-dash</primary></indexterm><para>Em-dash: — (for punctuation). -</para> -</listitem></varlistentry><varlistentry><term><literal>\textendash (or <literal>--</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>e-dash</primary></indexterm><para>En-dash: — (for ranges). -</para> -</listitem></varlistentry><varlistentry><term><literal>\texteuro</literal></term> -<listitem><indexterm role="cp"><primary>euro symbol</primary></indexterm><indexterm role="cp"><primary>currency, euro</primary></indexterm><para>The Euro symbol: €. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textexclamdown (or <literal>!`</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>exclamation point, upside-down</primary></indexterm><para>Upside down exclamation point: ¡. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textgreater</literal></term> -<listitem><indexterm role="cp"><primary>greater than symbol, in text</primary></indexterm><para>Greater than: >. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textless</literal></term> -<listitem><indexterm role="cp"><primary>less than symbol, in text</primary></indexterm><para>Less than: <. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textleftarrow</literal></term> -<listitem><indexterm role="cp"><primary>arrow, left, in text</primary></indexterm><indexterm role="cp"><primary>left arrow, in text</primary></indexterm><para>Left arrow. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textordfeminine</literal></term> -<term><literal>\textordmasculine</literal></term> -<listitem><indexterm role="cp"><primary>feminine ordinal symbol</primary></indexterm><indexterm role="cp"><primary>masculine ordinal symbol</primary></indexterm><indexterm role="cp"><primary>ordinals, feminine and masculine</primary></indexterm><indexterm role="cp"><primary>Spanish ordinals, feminine and masculine</primary></indexterm><para>Feminine and masculine ordinal symbols: ª, º. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textperiodcentered</literal></term> -<listitem><indexterm role="cp"><primary>period, centered, in text</primary></indexterm><indexterm role="cp"><primary>centered period, in text</primary></indexterm><para>Centered period: \cdot. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textquestiondown (or <literal>?`</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>questionation point, upside-down</primary></indexterm><para>Upside down questionation point: ¿. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textquotedblleft (or <literal>``</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>left quote, double</primary></indexterm><indexterm role="cp"><primary>double left quote</primary></indexterm><para>Double left quote: “. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textquotedblright (or <literal>'</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>right quote, double</primary></indexterm><indexterm role="cp"><primary>double right quote</primary></indexterm><para>Double right quote: ”. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textquoteleft (or <literal>`</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>left quote, single</primary></indexterm><indexterm role="cp"><primary>single left quote</primary></indexterm><para>Single left quote: `. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textquoteright (or <literal>'</literal>)</literal></term> -<listitem><indexterm role="cp"><primary>right quote, single</primary></indexterm><indexterm role="cp"><primary>single right quote</primary></indexterm><para>Single right quote: '. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textquotestraightbase</literal></term> -<term><literal>\textquotestraightdblbase</literal></term> -<listitem><indexterm role="cp"><primary>quote, straight base</primary></indexterm><indexterm role="cp"><primary>straight quote, base</primary></indexterm><indexterm role="cp"><primary>double quote, straight base</primary></indexterm><indexterm role="cp"><primary>straight double quote, base</primary></indexterm><para>Single and double straight quotes on the baseline. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textregistered</literal></term> -<listitem><indexterm role="cp"><primary>registered symbol</primary></indexterm><para>Registered symbol: ®. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textrightarrow</literal></term> -<listitem><indexterm role="cp"><primary>arrow, right, in text</primary></indexterm><indexterm role="cp"><primary>right arrow, in text</primary></indexterm><para>Right arrow. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textthreequartersemdash</literal></term> -<listitem><indexterm role="cp"><primary>three-quarters em-dash</primary></indexterm><indexterm role="cp"><primary>em-dash, three-quarters</primary></indexterm><para>“Three-quarters” em-dash, between en-dash and em-dash. -</para> -</listitem></varlistentry><varlistentry><term><literal>\texttrademark</literal></term> -<listitem><indexterm role="cp"><primary>trademark symbol</primary></indexterm><para>Trademark symbol: ^{\hbox{TM}}. -</para> -</listitem></varlistentry><varlistentry><term><literal>\texttwelveudash</literal></term> -<listitem><indexterm role="cp"><primary>two-thirds em-dash</primary></indexterm><indexterm role="cp"><primary>em-dash, two-thirds</primary></indexterm><para>“Two-thirds” em-dash, between en-dash and em-dash. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textunderscore</literal></term> -<listitem><indexterm role="cp"><primary>underscore, in text</primary></indexterm><para>Underscore: _. -</para> -</listitem></varlistentry><varlistentry><term><literal>\textvisiblespace</literal></term> -<listitem><indexterm role="cp"><primary>visible space symbol, in text</primary></indexterm><para>Visible space symbol. +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textdagger</primary></indexterm><literal>\textdagger</literal> +</term><listitem><indexterm role="cp"><primary>dagger, in text</primary></indexterm> +<para>Dagger: <inlineequation><mathphrase>\dag</mathphrase></inlineequation>. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textdaggerdbl</primary></indexterm><literal>\textdaggerdbl</literal> +</term><listitem><indexterm role="cp"><primary>dagger, double, in text</primary></indexterm> +<indexterm role="cp"><primary>double dagger, in text</primary></indexterm> +<para>Double dagger: <inlineequation><mathphrase>\ddag</mathphrase></inlineequation>. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textdollar <lineannotation>(or <literal>$</literal>)</lineannotation></primary></indexterm><literal>\textdollar <lineannotation>(or <literal>$</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>dollar sign</primary></indexterm> +<indexterm role="cp"><primary>currency, dollar</primary></indexterm> +<para>Dollar sign: $. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textemdash <lineannotation>(or <literal>---</literal>)</lineannotation></primary></indexterm><literal>\textemdash <lineannotation>(or <literal>---</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>em-dash</primary></indexterm> +<para>Em-dash: — (for punctuation). +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textendash <lineannotation>(or <literal>--</literal>)</lineannotation></primary></indexterm><literal>\textendash <lineannotation>(or <literal>--</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>e-dash</primary></indexterm> +<para>En-dash: — (for ranges). +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\texteuro</primary></indexterm><literal>\texteuro</literal> +</term><listitem><indexterm role="cp"><primary>euro symbol</primary></indexterm> +<indexterm role="cp"><primary>currency, euro</primary></indexterm> +<para>The Euro symbol: €. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textexclamdown <lineannotation>(or <literal>!`</literal>)</lineannotation></primary></indexterm><literal>\textexclamdown <lineannotation>(or <literal>!`</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>exclamation point, upside-down</primary></indexterm> +<para>Upside down exclamation point: ¡. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textgreater</primary></indexterm><literal>\textgreater</literal> +</term><listitem><indexterm role="cp"><primary>greater than symbol, in text</primary></indexterm> +<para>Greater than: >. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textless</primary></indexterm><literal>\textless</literal> +</term><listitem><indexterm role="cp"><primary>less than symbol, in text</primary></indexterm> +<para>Less than: <. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textleftarrow</primary></indexterm><literal>\textleftarrow</literal> +</term><listitem><indexterm role="cp"><primary>arrow, left, in text</primary></indexterm> +<indexterm role="cp"><primary>left arrow, in text</primary></indexterm> +<para>Left arrow. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textordfeminine</primary></indexterm><literal>\textordfeminine</literal> +</term><term><indexterm role="fn"><primary>\textordmasculine</primary></indexterm><literal>\textordmasculine</literal> +</term><listitem><indexterm role="cp"><primary>feminine ordinal symbol</primary></indexterm> +<indexterm role="cp"><primary>masculine ordinal symbol</primary></indexterm> +<indexterm role="cp"><primary>ordinals, feminine and masculine</primary></indexterm> +<indexterm role="cp"><primary>Spanish ordinals, feminine and masculine</primary></indexterm> +<para>Feminine and masculine ordinal symbols: ª, º. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textperiodcentered</primary></indexterm><literal>\textperiodcentered</literal> +</term><listitem><indexterm role="cp"><primary>period, centered, in text</primary></indexterm> +<indexterm role="cp"><primary>centered period, in text</primary></indexterm> +<para>Centered period: <inlineequation><mathphrase>\cdot</mathphrase></inlineequation>. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textquestiondown <lineannotation>(or <literal>?`</literal>)</lineannotation></primary></indexterm><literal>\textquestiondown <lineannotation>(or <literal>?`</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>questionation point, upside-down</primary></indexterm> +<para>Upside down questionation point: ¿. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textquotedblleft <lineannotation>(or <literal>``</literal>)</lineannotation></primary></indexterm><literal>\textquotedblleft <lineannotation>(or <literal>``</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>left quote, double</primary></indexterm> +<indexterm role="cp"><primary>double left quote</primary></indexterm> +<para>Double left quote: “. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textquotedblright <lineannotation>(or <literal>'</literal>)</lineannotation></primary></indexterm><literal>\textquotedblright <lineannotation>(or <literal>'</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>right quote, double</primary></indexterm> +<indexterm role="cp"><primary>double right quote</primary></indexterm> +<para>Double right quote: ”. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textquoteleft <lineannotation>(or <literal>`</literal>)</lineannotation></primary></indexterm><literal>\textquoteleft <lineannotation>(or <literal>`</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>left quote, single</primary></indexterm> +<indexterm role="cp"><primary>single left quote</primary></indexterm> +<para>Single left quote: ‘. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textquoteright <lineannotation>(or <literal>'</literal>)</lineannotation></primary></indexterm><literal>\textquoteright <lineannotation>(or <literal>'</literal>)</lineannotation></literal> +</term><listitem><indexterm role="cp"><primary>right quote, single</primary></indexterm> +<indexterm role="cp"><primary>single right quote</primary></indexterm> +<para>Single right quote: ’. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textquotestraightbase</primary></indexterm><literal>\textquotestraightbase</literal> +</term><term><indexterm role="fn"><primary>\textquotestraightdblbase</primary></indexterm><literal>\textquotestraightdblbase</literal> +</term><listitem><indexterm role="cp"><primary>quote, straight base</primary></indexterm> +<indexterm role="cp"><primary>straight quote, base</primary></indexterm> +<indexterm role="cp"><primary>double quote, straight base</primary></indexterm> +<indexterm role="cp"><primary>straight double quote, base</primary></indexterm> +<para>Single and double straight quotes on the baseline. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textregistered</primary></indexterm><literal>\textregistered</literal> +</term><listitem><indexterm role="cp"><primary>registered symbol</primary></indexterm> +<para>Registered symbol: ®. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textrightarrow</primary></indexterm><literal>\textrightarrow</literal> +</term><listitem><indexterm role="cp"><primary>arrow, right, in text</primary></indexterm> +<indexterm role="cp"><primary>right arrow, in text</primary></indexterm> +<para>Right arrow. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textthreequartersemdash</primary></indexterm><literal>\textthreequartersemdash</literal> +</term><listitem><indexterm role="cp"><primary>three-quarters em-dash</primary></indexterm> +<indexterm role="cp"><primary>em-dash, three-quarters</primary></indexterm> +<para>“Three-quarters” em-dash, between en-dash and em-dash. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\texttrademark</primary></indexterm><literal>\texttrademark</literal> +</term><listitem><indexterm role="cp"><primary>trademark symbol</primary></indexterm> +<para>Trademark symbol: <inlineequation><mathphrase>^{\hbox{TM}}</mathphrase></inlineequation>. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\texttwelveudash</primary></indexterm><literal>\texttwelveudash</literal> +</term><listitem><indexterm role="cp"><primary>two-thirds em-dash</primary></indexterm> +<indexterm role="cp"><primary>em-dash, two-thirds</primary></indexterm> +<para>“Two-thirds” em-dash, between en-dash and em-dash. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textunderscore</primary></indexterm><literal>\textunderscore</literal> +</term><listitem><indexterm role="cp"><primary>underscore, in text</primary></indexterm> +<para>Underscore: _. +</para> +</listitem></varlistentry><varlistentry><term><indexterm role="fn"><primary>\textvisiblespace</primary></indexterm><literal>\textvisiblespace</literal> +</term><listitem><indexterm role="cp"><primary>visible space symbol, in text</primary></indexterm> +<para>Visible space symbol. </para> </listitem></varlistentry></variablelist> - </sect1> <sect1 label="22.3" id="Accents"> <title>Accents</title> -<indexterm role="cp"><primary>accents</primary></indexterm><indexterm role="cp"><primary>characters, accented</primary></indexterm><indexterm role="cp"><primary>letters, accented</primary></indexterm> -<para>&latex; has wide support for many of the world's scripts and +<indexterm role="cp"><primary>accents</primary></indexterm> +<indexterm role="cp"><primary>characters, accented</primary></indexterm> +<indexterm role="cp"><primary>letters, accented</primary></indexterm> + +<para>&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 lists the core &latex; commands for creating accented characters. @@ -4850,150 +5558,249 @@ the core &latex; commands for creating accented characters. <para>The <literal>\capital...</literal> commands produce alternative forms for use with capital letters. These are not available with OT1. </para> -<variablelist><varlistentry><term><literal>\"</literal></term> -<term><literal>\capitaldieresis</literal></term> -<listitem><indexterm role="fn"><primary>\" (umlaut accent)</primary></indexterm><indexterm role="fn"><primary>\capitaldieresis</primary></indexterm><indexterm role="cp"><primary>umlaut accent</primary></indexterm><indexterm role="cp"><primary>dieresis accent</primary></indexterm><para>Produces an umlaut (dieresis), as in ö. -</para> -</listitem></varlistentry><varlistentry><term><literal>\'</literal></term> -<term><literal>\capitalacute</literal></term> -<listitem><indexterm role="fn"><primary>\' (acute accent)</primary></indexterm><indexterm role="fn"><primary>\capitalacute</primary></indexterm><indexterm role="cp"><primary>acute accent</primary></indexterm><para>Produces an acute accent, as in ó. In the <literal>tabbing</literal> +<variablelist><varlistentry><term><literal>\"</literal> +</term><term><literal>\capitaldieresis</literal> +</term><listitem><indexterm role="fn"><primary>\" <lineannotation>(umlaut accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitaldieresis</primary></indexterm> +<indexterm role="cp"><primary>umlaut accent</primary></indexterm> +<indexterm role="cp"><primary>dieresis accent</primary></indexterm> +<para>Produces an umlaut (dieresis), as in ö. +</para> +</listitem></varlistentry><varlistentry><term><literal>\'</literal> +</term><term><literal>\capitalacute</literal> +</term><listitem><indexterm role="fn"><primary>\’ <lineannotation>(acute accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalacute</primary></indexterm> +<indexterm role="cp"><primary>acute accent</primary></indexterm> +<para>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><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><para>Produces a dot accent over the following, as in o.. -</para> -</listitem></varlistentry><varlistentry><term><literal>\=</literal></term> -<term><literal>\capitalmacron</literal></term> -<listitem><indexterm role="fn"><primary>\= (macron accent)</primary></indexterm><indexterm role="fn"><primary>\capitalmacron</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><para>Produces a macron (overbar) accent over the following, as in o¯. -</para> -</listitem></varlistentry><varlistentry><term><literal>\^</literal></term> -<term><literal>\capitalcircumflex</literal></term> -<listitem><indexterm role="fn"><primary>\^ (circumflex accent)</primary></indexterm><indexterm role="fn"><primary>\capitalcircumflex</primary></indexterm><indexterm role="cp"><primary>circumflex accent</primary></indexterm><indexterm role="cp"><primary>hat accent</primary></indexterm><para>Produces a circumflex (hat) accent over the following, as in ô. -</para> -</listitem></varlistentry><varlistentry><term><literal>\`</literal></term> -<term><literal>\capitalgrave</literal></term> -<listitem><indexterm role="fn"><primary>\` (grave accent)</primary></indexterm><indexterm role="fn"><primary>\capitalgrave</primary></indexterm><indexterm role="cp"><primary>grave accent</primary></indexterm><para>Produces a grave accent over the following, as in ò. In the +(see <link linkend="tabbing">tabbing</link>). +</para> +</listitem></varlistentry><varlistentry><term><literal>\.</literal> +</term><listitem><indexterm role="fn"><primary>\. <lineannotation>(dot-over accent)</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>dot accent</primary></indexterm> +<indexterm role="cp"><primary>dot-over accent</primary></indexterm> +<para>Produces a dot accent over the following, as in ȯ. +</para> +</listitem></varlistentry><varlistentry><term><literal>\=</literal> +</term><term><literal>\capitalmacron</literal> +</term><listitem><indexterm role="fn"><primary>\= <lineannotation>(macron accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalmacron</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> +<para>Produces a macron (overbar) accent over the following, as in ō. +</para> +</listitem></varlistentry><varlistentry><term><literal>\^</literal> +</term><term><literal>\capitalcircumflex</literal> +</term><listitem><indexterm role="fn"><primary>\^ <lineannotation>(circumflex accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalcircumflex</primary></indexterm> +<indexterm role="cp"><primary>circumflex accent</primary></indexterm> +<indexterm role="cp"><primary>hat accent</primary></indexterm> +<para>Produces a circumflex (hat) accent over the following, as in ô. +</para> +</listitem></varlistentry><varlistentry><term><literal>\`</literal> +</term><term><literal>\capitalgrave</literal> +</term><listitem><indexterm role="fn"><primary>\‘ <lineannotation>(grave accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalgrave</primary></indexterm> +<indexterm role="cp"><primary>grave accent</primary></indexterm> +<para>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> -<term><literal>\capitaltilde</literal></term> -<listitem><indexterm role="fn"><primary>\~ (tilde accent)</primary></indexterm><indexterm role="fn"><primary>\capitaltilde</primary></indexterm><indexterm role="cp"><primary>tilde accent</primary></indexterm><para>Produces a tilde accent over the following, as in ñ. -</para> -</listitem></varlistentry><varlistentry><term><literal>\b</literal></term> -<listitem><indexterm role="fn"><primary>\b (bar-under accent)</primary></indexterm><indexterm role="cp"><primary>bar-under accent</primary></indexterm><para>Produces a bar accent under the following, as in o_. -</para> -</listitem></varlistentry><varlistentry><term><literal>\c</literal></term> -<term><literal>\capitalcedilla</literal></term> -<listitem><indexterm role="fn"><primary>\c (cedilla accent)</primary></indexterm><indexterm role="fn"><primary>\capitalcedilla</primary></indexterm><indexterm role="cp"><primary>cedilla accent</primary></indexterm><para>Produces a cedilla accent under the following, as in ç. -</para> -</listitem></varlistentry><varlistentry><term><literal>\d</literal></term> -<term><literal>\capitaldotaccent</literal></term> -<listitem><indexterm role="fn"><primary>\d (dot-under accent)</primary></indexterm><indexterm role="fn"><primary>\capitaldotaccent</primary></indexterm><indexterm role="cp"><primary>dot-under accent</primary></indexterm><para>Produces a dot accent under the following, as in .o. -</para> -</listitem></varlistentry><varlistentry><term><literal>\H</literal></term> -<term><literal>\capitalhungarumlaut</literal></term> -<listitem><indexterm role="fn"><primary>\H (Hungarian umlaut accent)</primary></indexterm><indexterm role="fn"><primary>\capitalhungarumlaut</primary></indexterm><indexterm role="cp"><primary>hungarian umlaut accent</primary></indexterm><para>Produces a long Hungarian umlaut accent over the following, as in o''. -</para> -</listitem></varlistentry><varlistentry><term><literal>\i</literal></term> -<listitem><indexterm role="fn"><primary>\i (dotless i)</primary></indexterm><indexterm role="cp"><primary>dotless i</primary></indexterm><para>Produces a dotless i, as in `i'. -</para> -</listitem></varlistentry><varlistentry><term><literal>\j</literal></term> -<listitem><indexterm role="fn"><primary>\j (dotless j)</primary></indexterm><indexterm role="cp"><primary>dotless j</primary></indexterm><para>Produces a dotless j, as in `j'. -</para> -</listitem></varlistentry><varlistentry><term><literal>\k</literal></term> -<term><literal>\capitalogonek</literal></term> -<listitem><indexterm role="fn"><primary>\k (ogonek)</primary></indexterm><indexterm role="fn"><primary>\capitalogonek</primary></indexterm><indexterm role="cp"><primary>ogonek</primary></indexterm><para>Produces a letter with ogonek, as in `o;'. Not available in +(see <link linkend="tabbing">tabbing</link>). +</para> +</listitem></varlistentry><varlistentry><term><literal>\~</literal> +</term><term><literal>\capitaltilde</literal> +</term><listitem><indexterm role="fn"><primary>\~ <lineannotation>(tilde accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitaltilde</primary></indexterm> +<indexterm role="cp"><primary>tilde accent</primary></indexterm> +<para>Produces a tilde accent over the following, as in ñ. +</para> +</listitem></varlistentry><varlistentry><term><literal>\b</literal> +</term><listitem><indexterm role="fn"><primary>\b <lineannotation>(bar-under accent)</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>bar-under accent</primary></indexterm> +<para>Produces a bar accent under the following, as in o_. +</para> +</listitem></varlistentry><varlistentry><term><literal>\c</literal> +</term><term><literal>\capitalcedilla</literal> +</term><listitem><indexterm role="fn"><primary>\c <lineannotation>(cedilla accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalcedilla</primary></indexterm> +<indexterm role="cp"><primary>cedilla accent</primary></indexterm> +<para>Produces a cedilla accent under the following, as in ç. +</para> +</listitem></varlistentry><varlistentry><term><literal>\d</literal> +</term><term><literal>\capitaldotaccent</literal> +</term><listitem><indexterm role="fn"><primary>\d <lineannotation>(dot-under accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitaldotaccent</primary></indexterm> +<indexterm role="cp"><primary>dot-under accent</primary></indexterm> +<para>Produces a dot accent under the following, as in ọ. +</para> +</listitem></varlistentry><varlistentry><term><literal>\H</literal> +</term><term><literal>\capitalhungarumlaut</literal> +</term><listitem><indexterm role="fn"><primary>\H <lineannotation>(Hungarian umlaut accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalhungarumlaut</primary></indexterm> +<indexterm role="cp"><primary>hungarian umlaut accent</primary></indexterm> +<para>Produces a long Hungarian umlaut accent over the following, as in ő. +</para> +</listitem></varlistentry><varlistentry><term><literal>\i</literal> +</term><listitem><indexterm role="fn"><primary>\i <lineannotation>(dotless i)</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>dotless i</primary></indexterm> +<para>Produces a dotless i, as in ‘i’. +</para> +</listitem></varlistentry><varlistentry><term><literal>\j</literal> +</term><listitem><indexterm role="fn"><primary>\j <lineannotation>(dotless j)</lineannotation></primary></indexterm> +<indexterm role="cp"><primary>dotless j</primary></indexterm> +<para>Produces a dotless j, as in ‘j’. +</para> +</listitem></varlistentry><varlistentry><term><literal>\k</literal> +</term><term><literal>\capitalogonek</literal> +</term><listitem><indexterm role="fn"><primary>\k <lineannotation>(ogonek)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalogonek</primary></indexterm> +<indexterm role="cp"><primary>ogonek</primary></indexterm> +<para>Produces a letter with ogonek, as in ‘ǫ’. Not available in the OT1 encoding. </para> -</listitem></varlistentry><varlistentry><term><literal>\r</literal></term> -<term><literal>\capitalring</literal></term> -<listitem><indexterm role="fn"><primary>\r (ring accent)</primary></indexterm><indexterm role="fn"><primary>\capitalring</primary></indexterm><indexterm role="cp"><primary>ring accent</primary></indexterm><para>Produces a ring accent, as in `o*'. -</para> -</listitem></varlistentry><varlistentry><term><literal>\t</literal></term> -<term><literal>\capitaltie</literal></term> -<term><literal>\newtie</literal></term> -<term><literal>\capitalnewtie</literal></term> -<listitem><indexterm role="fn"><primary>\t (tie-after accent)</primary></indexterm><indexterm role="fn"><primary>\capitaltie</primary></indexterm><indexterm role="fn"><primary>\newtie</primary></indexterm><indexterm role="fn"><primary>\capitalnewtie</primary></indexterm><indexterm role="cp"><primary>tie-after accent</primary></indexterm><para>Produces a tie-after accent, as in `oo['. The +</listitem></varlistentry><varlistentry><term><literal>\r</literal> +</term><term><literal>\capitalring</literal> +</term><listitem><indexterm role="fn"><primary>\r <lineannotation>(ring accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalring</primary></indexterm> +<indexterm role="cp"><primary>ring accent</primary></indexterm> +<para>Produces a ring accent, as in ‘o*’. +</para> +</listitem></varlistentry><varlistentry><term><literal>\t</literal> +</term><term><literal>\capitaltie</literal> +</term><term><literal>\newtie</literal> +</term><term><literal>\capitalnewtie</literal> +</term><listitem><indexterm role="fn"><primary>\t <lineannotation>(tie-after accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitaltie</primary></indexterm> +<indexterm role="fn"><primary>\newtie</primary></indexterm> +<indexterm role="fn"><primary>\capitalnewtie</primary></indexterm> +<indexterm role="cp"><primary>tie-after accent</primary></indexterm> +<para>Produces a tie-after accent, as in ‘oo[’. The <literal>\newtie</literal> form is centered in its box. </para> -</listitem></varlistentry><varlistentry><term><literal>\u</literal></term> -<term><literal>\capitalbreve</literal></term> -<listitem><indexterm role="fn"><primary>\u (breve accent)</primary></indexterm><indexterm role="fn"><primary>\capitalbreve</primary></indexterm><indexterm role="cp"><primary>breve accent</primary></indexterm><para>Produces a breve accent, as in `o('. -</para> -</listitem></varlistentry><varlistentry><term><literal>\underbar</literal></term> -<listitem><indexterm role="fn"><primary>\underbar</primary></indexterm><indexterm role="cp"><primary>underbar</primary></indexterm><para>Not exactly an accent, this produces a bar under the argument text. +</listitem></varlistentry><varlistentry><term><literal>\u</literal> +</term><term><literal>\capitalbreve</literal> +</term><listitem><indexterm role="fn"><primary>\u <lineannotation>(breve accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalbreve</primary></indexterm> +<indexterm role="cp"><primary>breve accent</primary></indexterm> +<para>Produces a breve accent, as in ‘ŏ’. +</para> +</listitem></varlistentry><varlistentry><term><literal>\underbar</literal> +</term><listitem><indexterm role="fn"><primary>\underbar</primary></indexterm> +<indexterm role="cp"><primary>underbar</primary></indexterm> +<para>Not exactly an accent, this produces a bar under the argument text. The argument is always processed in horizontal mode. The bar is always a fixed position under the baseline, thus crossing through -descenders. See also <literal>\underline</literal> in <xref linkend="Math-miscellany"></xref>. +descenders. See also <literal>\underline</literal> in <link linkend="Math-miscellany">Math miscellany</link>. </para> -</listitem></varlistentry><varlistentry><term><literal>\v</literal></term> -<term><literal>\capitalcaron</literal></term> -<listitem><indexterm role="fn"><primary>\v (breve accent)</primary></indexterm><indexterm role="fn"><primary>\capitalcaron</primary></indexterm><indexterm role="cp"><primary>hacek accent</primary></indexterm><indexterm role="cp"><primary>check accent</primary></indexterm><indexterm role="cp"><primary>caron accent</primary></indexterm><para>Produces a hác<ek (check, caron) accent, as in `o<'. +</listitem></varlistentry><varlistentry><term><literal>\v</literal> +</term><term><literal>\capitalcaron</literal> +</term><listitem><indexterm role="fn"><primary>\v <lineannotation>(breve accent)</lineannotation></primary></indexterm> +<indexterm role="fn"><primary>\capitalcaron</primary></indexterm> +<indexterm role="cp"><primary>hacek accent</primary></indexterm> +<indexterm role="cp"><primary>check accent</primary></indexterm> +<indexterm role="cp"><primary>caron accent</primary></indexterm> +<para>Produces a háček (check, caron) accent, as in ‘ǒ’. </para> </listitem></varlistentry></variablelist> - </sect1> -<sect1 label="22.4" id="Non-English-characters"> +<sect1 label="22.4" id="Non_002dEnglish-characters"> <title>Non-English characters</title> -<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> +<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> + <para>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><indexterm role="fn"><primary>\aa (å)</primary></indexterm><indexterm role="fn"><primary>\AA (Å)</primary></indexterm><indexterm role="cp"><primary>aring</primary></indexterm><para>å and Å. -</para> -</listitem></varlistentry><varlistentry><term><literal>\ae</literal></term> -<term><literal>\AE</literal></term> -<listitem><indexterm role="fn"><primary>\ae (æ)</primary></indexterm><indexterm role="fn"><primary>\AE (Æ)</primary></indexterm><indexterm role="cp"><primary>ae ligature</primary></indexterm><para>æ and Æ. -</para> -</listitem></varlistentry><varlistentry><term><literal>\dh</literal></term> -<term><literal>\DH</literal></term> -<listitem><indexterm role="fn"><primary>\dh (æ)</primary></indexterm><indexterm role="fn"><primary>\DH (Æ)</primary></indexterm><indexterm role="cp"><primary>Icelandic eth</primary></indexterm><indexterm role="cp"><primary>eth, Icelandic letter</primary></indexterm><para>Icelandic letter eth: ð and Ð. -</para> -</listitem></varlistentry><varlistentry><term><literal>\dj</literal></term> -<term><literal>\DJ</literal></term> -<listitem><indexterm role="fn"><primary>\dj</primary></indexterm><indexterm role="fn"><primary>\DJ</primary></indexterm><para>xxxx -</para> -</listitem></varlistentry><varlistentry><term><literal>\ij</literal></term> -<term><literal>\IJ</literal></term> -<listitem><indexterm role="fn"><primary>\ij (ij)</primary></indexterm><indexterm role="fn"><primary>\IJ (IJ)</primary></indexterm><indexterm role="cp"><primary>ij letter, Dutch</primary></indexterm><para>ij and IJ (except somewhat closer together than appears here). -</para> -</listitem></varlistentry><varlistentry><term><literal>\l</literal></term> -<term><literal>\L</literal></term> -<listitem><indexterm role="fn"><primary>\l (/l)</primary></indexterm><indexterm role="fn"><primary>\L (/L)</primary></indexterm><indexterm role="cp"><primary>polish l</primary></indexterm><para>/l and /L. -</para> -</listitem></varlistentry><varlistentry><term><literal>\ng</literal></term> -<term><literal>\NG</literal></term> -<listitem><indexterm role="fn"><primary>\ng</primary></indexterm><indexterm role="fn"><primary>\NG</primary></indexterm><para>xxxx -</para> -</listitem></varlistentry><varlistentry><term><literal>\o</literal></term> -<term><literal>\O</literal></term> -<listitem><indexterm role="fn"><primary>\o (ø)</primary></indexterm><indexterm role="fn"><primary>\O (Ø)</primary></indexterm><indexterm role="cp"><primary>oslash</primary></indexterm><para>ø and Ø. -</para> -</listitem></varlistentry><varlistentry><term><literal>\oe</literal></term> -<term><literal>\OE</literal></term> -<listitem><indexterm role="fn"><primary>\oe (œ)</primary></indexterm><indexterm role="fn"><primary>\OE (Œ)</primary></indexterm><indexterm role="cp"><primary>oe ligature</primary></indexterm><para>œ and Œ. -</para> -</listitem></varlistentry><varlistentry><term><literal>\ss</literal></term> -<term><literal>\SS</literal></term> -<listitem><indexterm role="fn"><primary>\ss (ß)</primary></indexterm><indexterm role="fn"><primary>\SS (SS)</primary></indexterm><indexterm role="cp"><primary>es-zet German letter</primary></indexterm><indexterm role="cp"><primary>sharp S letters</primary></indexterm><para>ß and SS. -</para> -</listitem></varlistentry><varlistentry><term><literal>\th</literal></term> -<term><literal>\TH</literal></term> -<listitem><indexterm role="fn"><primary>\th (þ)</primary></indexterm><indexterm role="fn"><primary>\TH (Þ)</primary></indexterm><indexterm role="cp"><primary>Icelandic thorn</primary></indexterm><indexterm role="cp"><primary>thorn, Icelandic letter</primary></indexterm><para>Icelandic letter thorn: þ and Þ. +<variablelist> +<varlistentry><term><literal>\aa</literal> +</term><term><literal>\AA</literal> +</term><listitem><indexterm role="fn"><primary>\aa (å)</primary></indexterm> +<indexterm role="fn"><primary>\AA (Å)</primary></indexterm> +<indexterm role="cp"><primary>aring</primary></indexterm> +<para>å and Å. +</para> +</listitem></varlistentry><varlistentry><term><literal>\ae</literal> +</term><term><literal>\AE</literal> +</term><listitem><indexterm role="fn"><primary>\ae (æ)</primary></indexterm> +<indexterm role="fn"><primary>\AE (Æ)</primary></indexterm> +<indexterm role="cp"><primary>ae ligature</primary></indexterm> +<para>æ and Æ. +</para> +</listitem></varlistentry><varlistentry><term><literal>\dh</literal> +</term><term><literal>\DH</literal> +</term><listitem><indexterm role="fn"><primary>\dh (æ)</primary></indexterm> +<indexterm role="fn"><primary>\DH (Æ)</primary></indexterm> +<indexterm role="cp"><primary>Icelandic eth</primary></indexterm> +<indexterm role="cp"><primary>eth, Icelandic letter</primary></indexterm> +<para>Icelandic letter eth: ð and Ð. +</para> +</listitem></varlistentry><varlistentry><term><literal>\dj</literal> +</term><term><literal>\DJ</literal> +</term><listitem><indexterm role="fn"><primary>\dj</primary></indexterm> +<indexterm role="fn"><primary>\DJ</primary></indexterm> +<para>xxxx +</para> +</listitem></varlistentry><varlistentry><term><literal>\ij</literal> +</term><term><literal>\IJ</literal> +</term><listitem><indexterm role="fn"><primary>\ij (ij)</primary></indexterm> +<indexterm role="fn"><primary>\IJ (IJ)</primary></indexterm> +<indexterm role="cp"><primary>ij letter, Dutch</primary></indexterm> +<para>ij and IJ (except somewhat closer together than appears here). +</para> +</listitem></varlistentry><varlistentry><term><literal>\l</literal> +</term><term><literal>\L</literal> +</term><listitem><indexterm role="fn"><primary>\l (ł)</primary></indexterm> +<indexterm role="fn"><primary>\L (Ł)</primary></indexterm> +<indexterm role="cp"><primary>polish l</primary></indexterm> +<para>ł and Ł. +</para> +</listitem></varlistentry><varlistentry><term><literal>\ng</literal> +</term><term><literal>\NG</literal> +</term><listitem><indexterm role="fn"><primary>\ng</primary></indexterm> +<indexterm role="fn"><primary>\NG</primary></indexterm> +<para>xxxx +</para> +</listitem></varlistentry><varlistentry><term><literal>\o</literal> +</term><term><literal>\O</literal> +</term><listitem><indexterm role="fn"><primary>\o (ø)</primary></indexterm> +<indexterm role="fn"><primary>\O (Ø)</primary></indexterm> +<indexterm role="cp"><primary>oslash</primary></indexterm> +<para>ø and Ø. +</para> +</listitem></varlistentry><varlistentry><term><literal>\oe</literal> +</term><term><literal>\OE</literal> +</term><listitem><indexterm role="fn"><primary>\oe (œ)</primary></indexterm> +<indexterm role="fn"><primary>\OE (Œ)</primary></indexterm> +<indexterm role="cp"><primary>oe ligature</primary></indexterm> +<para>œ and Œ. +</para> +</listitem></varlistentry><varlistentry><term><literal>\ss</literal> +</term><term><literal>\SS</literal> +</term><listitem><indexterm role="fn"><primary>\ss (ß)</primary></indexterm> +<indexterm role="fn"><primary>\SS (SS)</primary></indexterm> +<indexterm role="cp"><primary>es-zet German letter</primary></indexterm> +<indexterm role="cp"><primary>sharp S letters</primary></indexterm> +<para>ß and SS. +</para> +</listitem></varlistentry><varlistentry><term><literal>\th</literal> +</term><term><literal>\TH</literal> +</term><listitem><indexterm role="fn"><primary>\th (þ)</primary></indexterm> +<indexterm role="fn"><primary>\TH (Þ)</primary></indexterm> +<indexterm role="cp"><primary>Icelandic thorn</primary></indexterm> +<indexterm role="cp"><primary>thorn, Icelandic letter</primary></indexterm> +<para>Icelandic letter thorn: þ and Þ. </para> </listitem></varlistentry></variablelist> - </sect1> -<sect1 label="22.5"> +<sect1 label="22.5" id="_005crule"> <title><literal>\rule</literal></title> <indexterm role="fn"><primary>\rule</primary></indexterm> + <para>Synopsis: </para> <screen>\rule[<replaceable>raise</replaceable>]{<replaceable>width</replaceable>}{<replaceable>thickness</replaceable>} @@ -5001,28 +5808,29 @@ used in languages other than English. <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). +<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). +</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). +</listitem></varlistentry><varlistentry><term><replaceable>thickness</replaceable> +</term><listitem><para>The thickness of the rule (mandatory). </para></listitem></varlistentry></variablelist> - </sect1> -<sect1 label="22.6"> +<sect1 label="22.6" id="_005ctoday"> <title><literal>\today</literal></title> <indexterm role="fn"><primary>\today</primary></indexterm> -<para>The <literal>\today</literal> command produces today's date, in the format -‘<literal><replaceable>month</replaceable> <replaceable>dd</replaceable>, <replaceable>yyyy</replaceable></literal>’; for example, `July 4, 1976'. + +<para>The <literal>\today</literal> command produces today’s date, in the format +‘<literal><replaceable>month</replaceable> <replaceable>dd</replaceable>, <replaceable>yyyy</replaceable></literal>’; for example, ‘July 4, 1976’. 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 +<literal>\year</literal> (see <link linkend="_005cday-_005cmonth-_005cyear">\day \month \year</link>) to do this. It is not updated as the program runs. </para> -<indexterm role="cp"><primary><literal>datetime</literal> package</primary></indexterm><para>The <literal>datetime</literal> package, among others, can produce a wide variety +<indexterm role="cp"><primary><literal>datetime</literal> package</primary></indexterm> +<para>The <literal>datetime</literal> package, among others, can produce a wide variety of other date formats. </para> @@ -5030,39 +5838,44 @@ of other date formats. </chapter> <chapter label="23" id="Splitting-the-input"> <title>Splitting the input</title> -<indexterm role="cp"><primary>splitting the input file</primary></indexterm><indexterm role="cp"><primary>input file</primary></indexterm> +<indexterm role="cp"><primary>splitting the input file</primary></indexterm> +<indexterm role="cp"><primary>input file</primary></indexterm> + <para>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 +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="23.1"> +<sect1 label="23.1" id="_005cinclude"> <title><literal>\include</literal></title> <indexterm role="fn"><primary>\include</primary></indexterm> + <para>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 +(see <link linkend="_005cclearpage">\clearpage</link>), 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> -<indexterm role="cp"><primary>nested <literal>\include</literal>, not allowed</primary></indexterm><para>The <literal>\include</literal> command may not appear in the preamble or in a file +<indexterm role="cp"><primary>nested <literal>\include</literal>, not allowed</primary></indexterm> +<para>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="23.2"> +<sect1 label="23.2" id="_005cincludeonly"> <title>\<literal>includeonly</literal></title> <indexterm role="fn"><primary>\includeonly</primary></indexterm> + <para>Synopsis: </para> <screen>\includeonly{<replaceable>file1</replaceable>,<replaceable>file2</replaceable>,...} @@ -5077,9 +5890,10 @@ effective. </para> </sect1> -<sect1 label="23.3" id="\input"> +<sect1 label="23.3" id="_005cinput"> <title>\input</title> <indexterm role="fn"><primary>\input</primary></indexterm> + <para>Synopsis: </para> <screen>\input{<replaceable>file</replaceable>} @@ -5088,15 +5902,15 @@ effective. 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>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="24" id="Front/back-matter"> +<chapter label="24" id="Front_002fback-matter"> <title>Front/back matter</title> @@ -5105,7 +5919,10 @@ is tried (‘<literal>foo</literal>’ or ‘<literal>foo.bar</liter <title>Tables of contents</title> <indexterm role="cp"><primary>table of contents, creating</primary></indexterm> -<indexterm role="fn"><primary>\tableofcontents</primary></indexterm><indexterm role="fn"><primary>.toc file</primary></indexterm><para>A table of contents is produced with the <literal>\tableofcontents</literal> + +<indexterm role="fn"><primary>\tableofcontents</primary></indexterm> +<indexterm role="fn"><primary>.toc <lineannotation>file</lineannotation></primary></indexterm> +<para>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. @@ -5115,78 +5932,87 @@ 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> -<indexterm role="fn"><primary>\listoffigures</primary></indexterm><indexterm role="fn"><primary>\listoftables</primary></indexterm><para>The analogous commands <literal>\listoffigures</literal> and <literal>\listoftables</literal> +<indexterm role="fn"><primary>\listoffigures</primary></indexterm> +<indexterm role="fn"><primary>\listoftables</primary></indexterm> +<para>The analogous 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> -<indexterm role="fn"><primary>\nofiles</primary></indexterm><para>The command <literal>\nofiles</literal> overrides these commands, and +<indexterm role="fn"><primary>\nofiles</primary></indexterm> +<para>The command <literal>\nofiles</literal> overrides these commands, and <emphasis>prevents</emphasis> any of these lists from being generated. </para> -<sect2 label="24.1.1" id="\addcontentsline"> +<sect2 label="24.1.1" id="_005caddcontentsline"> <title>\addcontentsline</title> -<indexterm role="fn"><primary>\addcontentsline{<replaceable>ext</replaceable>}{<replaceable>unit</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm><indexterm role="cp"><primary>table of contents entry, manually adding</primary></indexterm> +<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> + <para>The <literal>\addcontentsline</literal>{<replaceable>ext</replaceable>}{<replaceable>unit</replaceable>}{<replaceable>text</replaceable>} 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, +<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 +</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>, +<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><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. +</listitem></varlistentry><varlistentry><term><replaceable>entry</replaceable> +</term><listitem><para>The actual text of the entry. </para></listitem></varlistentry></variablelist> - -<indexterm role="fn"><primary>\contentsline</primary></indexterm><para>What is written to the <filename>.<replaceable>ext</replaceable></filename> file is the +<indexterm role="fn"><primary>\contentsline</primary></indexterm> +<para>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="24.1.2" id="\addtocontents"> +<sect2 label="24.1.2" id="_005caddtocontents"> <title>\addtocontents</title> <indexterm role="fn"><primary>\addtocontents{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm> + <para>The <literal>\addtocontents</literal>{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>} command adds text (or formatting commands) directly to the <filename>.<replaceable>ext</replaceable></filename> 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: +<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. +</listitem></varlistentry><varlistentry><term><replaceable>text</replaceable> +</term><listitem><para>The text to be written. </para></listitem></varlistentry></variablelist> - </sect2> </sect1> <sect1 label="24.2" id="Glossaries"> <title>Glossaries</title> <indexterm role="cp"><primary>glossaries</primary></indexterm> -<indexterm role="fn"><primary>\makeglossary</primary></indexterm><para>The command <literal>\makeglossary</literal> enables creating glossaries. + +<indexterm role="fn"><primary>\makeglossary</primary></indexterm> +<para>The command <literal>\makeglossary</literal> enables creating glossaries. </para> -<indexterm role="fn"><primary>\glossary</primary></indexterm><indexterm role="cp"><primary><filename>.glo</filename> file</primary></indexterm><para>The command <literal>\glossary{<replaceable>text</replaceable>}</literal> writes a glossary entry for +<indexterm role="fn"><primary>\glossary</primary></indexterm> +<indexterm role="cp"><primary><filename>.glo</filename> file</primary></indexterm> +<para>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> -<indexterm role="fn"><primary>\glossaryentry</primary></indexterm><para>Specifically, what gets written is the command +<indexterm role="fn"><primary>\glossaryentry</primary></indexterm> +<para>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> @@ -5198,44 +6024,60 @@ glossaries. <sect1 label="24.3" id="Indexes"> <title>Indexes</title> <indexterm role="cp"><primary>indexes</primary></indexterm> -<indexterm role="fn"><primary>\makeindex</primary></indexterm><para>The command <literal>\makeindex</literal> enables creating indexes. Put this in + +<indexterm role="fn"><primary>\makeindex</primary></indexterm> +<para>The command <literal>\makeindex</literal> enables creating indexes. Put this in the preamble. </para> -<indexterm role="fn"><primary>\index</primary></indexterm><indexterm role="cp"><primary><filename>.idx</filename> file</primary></indexterm><para>The command <literal>\index{<replaceable>text</replaceable>}</literal> writes an index entry for +<indexterm role="fn"><primary>\index</primary></indexterm> +<indexterm role="cp"><primary><filename>.idx</filename> file</primary></indexterm> +<para>The command <literal>\index{<replaceable>text</replaceable>}</literal> writes an index entry for <replaceable>text</replaceable> to an auxiliary file with the <filename>.idx</filename> extension. </para> -<indexterm role="fn"><primary>\indexentry</primary></indexterm><para>Specifically, what gets written is the command +<indexterm role="fn"><primary>\indexentry</primary></indexterm> +<para>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> -<indexterm role="cp"><primary>`see' and `see also' index entries</primary></indexterm><para>To generate a index entry for `bar' that says `See foo', use a +<indexterm role="cp"><primary>‘see’ and ‘see also’ index entries</primary></indexterm> +<para>To generate a index entry for ‘bar’ that says ‘See foo’, use a vertical bar: <literal>\index{bar|see{foo}}</literal>. Use <literal>seealso</literal> -instead of <literal>see</literal> to make a `See also' entry. +instead of <literal>see</literal> to make a ‘See also’ entry. </para> -<indexterm role="fn"><primary>\seename</primary></indexterm><indexterm role="fn"><primary>\alsoname</primary></indexterm><para>The text `See' is defined by the macro <literal>\seename</literal>, and `See also' +<indexterm role="fn"><primary>\seename</primary></indexterm> +<indexterm role="fn"><primary>\alsoname</primary></indexterm> +<para>The text ‘See’ is defined by the macro <literal>\seename</literal>, and ‘See also’ by the macro <literal>\alsoname</literal>. These can be redefined for other languages. </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><para>The generated <filename>.idx</filename> file is then sorted with an external +<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> +<para>The generated <filename>.idx</filename> file is then sorted with an external command, usually either <command>makeindex</command> (<ulink url="http://mirror.ctan.org/indexing/makeindex">http://mirror.ctan.org/indexing/makeindex</ulink>) or (the multi-lingual) <command>xindy</command> (<ulink url="http://xindy.sourceforge.net">http://xindy.sourceforge.net</ulink>). This results in a <filename>.ind</filename> file, which can then be read to typeset the index. </para> -<indexterm role="fn"><primary>printindex</primary></indexterm><indexterm role="cp"><primary><literal>makeidx</literal> package</primary></indexterm><para>The index is usually generated with the <literal>\printindex</literal> command. +<indexterm role="fn"><primary>printindex</primary></indexterm> +<indexterm role="cp"><primary><literal>makeidx</literal> package</primary></indexterm> +<para>The index is usually generated with the <literal>\printindex</literal> command. This is defined in the <literal>makeidx</literal> package, so <literal>\usepackage{makeidx}</literal> needs to be in the preamble. </para> -<indexterm role="fn"><primary>indexspace</primary></indexterm><para>The rubber length <literal>\indexspace</literal> is inserted before each new -letter in the printed index; its default value is ‘<literal>10pt plus5pt -minus3pt</literal>’. +<indexterm role="fn"><primary>indexspace</primary></indexterm> +<para>The rubber length <literal>\indexspace</literal> is inserted before each new +letter in the printed index; its default value is ‘<literal>10pt plus5pt +minus3pt</literal>’. </para> -<indexterm role="cp"><primary><literal>showidx</literal> package</primary></indexterm><para>The <literal>showidx</literal> package causes each index entries to be shown in +<indexterm role="cp"><primary><literal>showidx</literal> package</primary></indexterm> +<para>The <literal>showidx</literal> package causes each index entries to be shown in the margin on the page where the entry appears. This can help in preparing the index. </para> -<indexterm role="cp"><primary><literal>multind</literal> package</primary></indexterm><para>The <literal>multind</literal> package supports multiple indexes. See also the +<indexterm role="cp"><primary><literal>multind</literal> package</primary></indexterm> +<para>The <literal>multind</literal> package supports multiple indexes. See also the &tex; FAQ entry on this topic, <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind</ulink>. </para> @@ -5244,7 +6086,9 @@ preparing the index. </chapter> <chapter label="25" id="Letters"> <title>Letters</title> -<indexterm role="cp"><primary>letters</primary></indexterm><indexterm role="cp"><primary>creating letters</primary></indexterm> +<indexterm role="cp"><primary>letters</primary></indexterm> +<indexterm role="cp"><primary>creating letters</primary></indexterm> + <para>You can use &latex; to typeset letters, both personal and business. The <literal>letter</literal> document class is designed to make a number of letters at once, although you can make just one if you so desire. @@ -5271,8 +6115,9 @@ 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> -<indexterm role="fn"><primary>\\ for letters</primary></indexterm><para>After the <literal>closing</literal>, you can have additional material. The -<literal>\cc</literal> command produces the usual “cc: …”. There's also a +<indexterm role="fn"><primary>\\ <lineannotation>for letters</lineannotation></primary></indexterm> +<para>After the <literal>closing</literal>, you can have additional material. The +<literal>\cc</literal> command produces the usual “cc: …”. There’s also a similar <literal>\encl</literal> command for a list of enclosures. With both these commands, use <literal>\\</literal> to separate the items. </para> @@ -5280,25 +6125,28 @@ commands, use <literal>\\</literal> to separate the items. </para> -<sect1 label="25.1"> +<sect1 label="25.1" id="_005caddress"> <title>\address{<replaceable>return-address}</replaceable></title> <indexterm role="fn"><primary>\address</primary></indexterm> + <para>The <literal>\address</literal> specifies the return address of a letter, as it should appear on the letter and the envelope. Separate lines of the address should be separated by <literal>\\</literal> commands. </para> <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 +will be formatted for copying onto your organisation’s standard +letterhead. (See <link linkend="Overview">Overview</link>, for details on your local implementation). If you give an <literal>\address</literal> declaration, then the letter will be formatted as a personal letter. </para> </sect1> -<sect1 label="25.2"> +<sect1 label="25.2" id="_005ccc"> <title><literal>\cc</literal></title> -<indexterm role="fn"><primary>\cc</primary></indexterm><indexterm role="cp"><primary>cc list, in letters</primary></indexterm> +<indexterm role="fn"><primary>\cc</primary></indexterm> +<indexterm role="cp"><primary>cc list, in letters</primary></indexterm> + <para>Synopsis: </para> <screen>\cc{<replaceable>name1</replaceable>\\<replaceable>name2</replaceable>} @@ -5308,10 +6156,13 @@ printed on a separate line. </para> </sect1> -<sect1 label="25.3"> +<sect1 label="25.3" id="_005cclosing"> <title><literal>\closing</literal></title> -<indexterm role="fn"><primary>\closing</primary></indexterm><indexterm role="cp"><primary>letters, ending</primary></indexterm><indexterm role="cp"><primary>closing letters</primary></indexterm> +<indexterm role="fn"><primary>\closing</primary></indexterm> +<indexterm role="cp"><primary>letters, ending</primary></indexterm> +<indexterm role="cp"><primary>closing letters</primary></indexterm> + <para>Synopsis: </para> <screen>\closing{text} @@ -5321,10 +6172,12 @@ printed on a separate line. </screen> </sect1> -<sect1 label="25.4"> +<sect1 label="25.4" id="_005cencl"> <title><literal>\encl</literal></title> -<indexterm role="fn"><primary>\encl</primary></indexterm><indexterm role="cp"><primary>enclosure list</primary></indexterm> +<indexterm role="fn"><primary>\encl</primary></indexterm> +<indexterm role="cp"><primary>enclosure list</primary></indexterm> + <para>Synopsis: </para> <screen>\encl{<replaceable>line1</replaceable>\\<replaceable>line2</replaceable>} @@ -5333,19 +6186,21 @@ printed on a separate line. </para> </sect1> -<sect1 label="25.5"> +<sect1 label="25.5" id="_005clocation"> <title><literal>\location</literal></title> <indexterm role="fn"><primary>\location</primary></indexterm> + <para><literal>\location{address}</literal> </para> -<para>This modifies your organisation's standard address. This only appears +<para>This modifies your organisation’s standard address. This only appears if the <literal>firstpage</literal> pagestyle is selected. </para> </sect1> -<sect1 label="25.6"> +<sect1 label="25.6" id="_005cmakelabels"> <title><literal>\makelabels</literal></title> <indexterm role="fn"><primary>\makelabels</primary></indexterm> + <para><literal>\makelabels{number}</literal> </para> <para>If you issue this command in the preamble, &latex; will create a sheet of @@ -5354,9 +6209,10 @@ address labels. This sheet will be output before the letters. </sect1> -<sect1 label="25.7"> +<sect1 label="25.7" id="_005cname"> <title><literal>\name</literal></title> <indexterm role="fn"><primary>\name</primary></indexterm> + <para><literal>\name{June Davenport}</literal> </para> <para>Your name, used for printing on the envelope together with the return @@ -5364,9 +6220,11 @@ address. </para> </sect1> -<sect1 label="25.8"> +<sect1 label="25.8" id="_005copening"> <title><literal>\opening{<replaceable>text</replaceable>}</literal></title> -<indexterm role="fn"><primary>\opening</primary></indexterm><indexterm role="cp"><primary>letters, starting</primary></indexterm> +<indexterm role="fn"><primary>\opening</primary></indexterm> +<indexterm role="cp"><primary>letters, starting</primary></indexterm> + <para>Synopsis: </para> <screen>\opening{<replaceable>text</replaceable>} @@ -5379,26 +6237,30 @@ For instance: </screen> </sect1> -<sect1 label="25.9"> +<sect1 label="25.9" id="_005cps"> <title><literal>\ps</literal></title> -<indexterm role="fn"><primary>\ps</primary></indexterm><indexterm role="cp"><primary>postscript, in letters</primary></indexterm> +<indexterm role="fn"><primary>\ps</primary></indexterm> +<indexterm role="cp"><primary>postscript, in letters</primary></indexterm> + <para>Use the <literal>\ps</literal> command to start a postscript in a letter, after <literal>\closing</literal>. </para> </sect1> -<sect1 label="25.10"> +<sect1 label="25.10" id="_005csignature"> <title><literal>\signature{<replaceable>text</replaceable>}</literal></title> <indexterm role="fn"><primary>\signature</primary></indexterm> + <para>Your name, as it should appear at the end of the letter underneath the space for your signature. <literal>\\</literal> starts a new line within <replaceable>text</replaceable> as usual. </para> </sect1> -<sect1 label="25.11"> +<sect1 label="25.11" id="_005cstartbreaks"> <title><literal>\startbreaks</literal></title> <indexterm role="fn"><primary>\startbreaks</primary></indexterm> + <para><literal>\startbreaks</literal> </para> <para>Used after a <literal>\stopbreaks</literal> command to allow page breaks again. @@ -5406,9 +6268,10 @@ space for your signature. <literal>\\</literal> starts a new line within </sect1> -<sect1 label="25.12"> +<sect1 label="25.12" id="_005cstopbreaks"> <title><literal>\stopbreaks</literal></title> <indexterm role="fn"><primary>\stopbreaks</primary></indexterm> + <para><literal>\stopbreaks</literal> </para> <para>Inhibit page breaks until a <literal>\startbreaks</literal> command occurs. @@ -5416,9 +6279,10 @@ space for your signature. <literal>\\</literal> starts a new line within </sect1> -<sect1 label="25.13"> +<sect1 label="25.13" id="_005ctelephone"> <title><literal>\telephone</literal></title> <indexterm role="fn"><primary>\telephone</primary></indexterm> + <para><literal>\telephone{number}</literal> </para> <para>This is your telephone number. This only appears if the @@ -5427,14 +6291,17 @@ space for your signature. <literal>\\</literal> starts a new line within </sect1> </chapter> -<chapter label="26" id="Terminal-input/output"> +<chapter label="26" id="Terminal-input_002foutput"> <title>Terminal input/output</title> -<indexterm role="cp"><primary>input/output</primary></indexterm><indexterm role="cp"><primary>terminal input/output</primary></indexterm> +<indexterm role="cp"><primary>input/output</primary></indexterm> +<indexterm role="cp"><primary>terminal input/output</primary></indexterm> -<sect1 label="26.1"> + +<sect1 label="26.1" id="_005ctypein"> <title><literal>\typein[<replaceable>cmd</replaceable>]{<replaceable>msg</replaceable>}</literal></title> <indexterm role="fn"><primary>\typein</primary></indexterm> + <para>Synopsis: </para> <screen>\typein[<replaceable>\cmd</replaceable>]{<replaceable>msg</replaceable>} @@ -5449,9 +6316,10 @@ redefined to be the typed input. </para> </sect1> -<sect1 label="26.2"> +<sect1 label="26.2" id="_005ctypeout"> <title><literal>\typeout{<replaceable>msg</replaceable>}</literal></title> <indexterm role="fn"><primary>\typeout</primary></indexterm> + <para>Synopsis: </para> <screen>\typeout{<replaceable>msg</replaceable>} @@ -5461,7 +6329,7 @@ Commands in <literal>msg</literal> that are defined with <literal>\newcommand</l <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 +<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 @@ -5473,6 +6341,7 @@ printed, independent of surrounding spaces. A <literal>^^J</literal> in <chapter label="27" id="Command-line"> <title>Command line</title> <indexterm role="cp"><primary>command line</primary></indexterm> + <para>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 @@ -5483,23 +6352,27 @@ command; e.g. </screen> <para>will process <filename>foo.tex</filename> without pausing after every error. </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><para>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> +<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> +<para>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 label="Appendix A" id="Document-templates"> +<appendix label="A" id="Document-templates"> <title>Document templates</title> <indexterm role="cp"><primary>document templates</primary></indexterm> + <para>Although not reference material, perhaps these document templates will -be useful. Additional templates are collected at -<ulink url="http://www.howtotex.com/templates">http://www.howtotex.com/templates</ulink>. +be useful. Additional template resources are listed +<ulink url="http://tug.org/interest.html#latextemplates">http://tug.org/interest.html#latextemplates</ulink>. </para> -<sect1 label="A.1"> +<sect1 label="A.1" id="book-template"> <title><literal>book</literal> template</title> <screen>\documentclass{book} @@ -5521,7 +6394,7 @@ The end. </screen> </sect1> -<sect1 label="A.2"> +<sect1 label="A.2" id="beamer-template"> <title><literal>beamer</literal> template</title> <para>The <literal>beamer</literal> class creates slides presentations. @@ -5551,7 +6424,7 @@ The end. </screen> </sect1> -<sect1 label="A.3"> +<sect1 label="A.3" id="tugboat-template"> <title><literal>tugboat</literal> template</title> <para><citetitle>TUGboat</citetitle> is the journal of the &tex; Users Group, @@ -5561,13 +6434,13 @@ The end. \usepackage{graphicx} \usepackage{ifpdf} \ifpdf - \usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, - urlcolor=black]{hyperref} +\usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, + urlcolor=black]{hyperref} \else - \usepackage{url} +\usepackage{url} \fi -\title{Example \TUB\ Article} +\title{Example \TUB\ article} % repeat info for each author. \author{First Last} @@ -5575,12 +6448,12 @@ The end. \netaddress{user (at) example dot org} \personalURL{http://example.org/~user/} -\maketitle - \begin{document} +\maketitle + \begin{abstract} -This is an example article for a regular \TUB{} issue. +This is an example article for \TUB{}. \end{abstract} \section{Introduction} @@ -5592,22 +6465,23 @@ We recommend the graphicx package for image inclusions, and the hyperref package for active url's (in the \acro{PDF} output). Nowadays \TUB\ is produced using \acro{PDF} files exclusively. -The \texttt{ltug*} classes provide these abbreviations, among many others: +The \texttt{ltugboat} class provides these abbreviations and many more: -{\small -\begin{verbatim} +% verbatim blocks are often better in \small +\begin{verbatim}[\small] \AllTeX \AMS \AmS \AmSLaTeX \AmSTeX \aw \AW \BibTeX \CTAN \DTD \HTML -\ISBN \ISSN \JTeX \LaTeXe -\Mc \mf \MFB \mtex \PCTeX \pcTeX \Pas +\ISBN \ISSN \LaTeXe +\Mc \mf \MFB \mtex \PCTeX \pcTeX \PiC \PiCTeX \plain \POBox \PS -\SC \SGML \SliTeX \TANGLE \TB \TP \TUB \TUG \tug +\SC \SGML \SliTeX \TANGLE \TB \TP +\TUB \TUG \tug \UG \UNIX \VAX \XeT \WEB \WEAVE \Dash \dash \vellipsis \bull \cents \Dag \careof \thinskip -\acro{FRED} -> {\small fred} % please use! +\acro{FRED} -> {\small[er] fred} % please use! \cs{fred} -> \fred \env{fred} -> \begin{fred} \meta{fred} -> <fred> @@ -5615,14 +6489,13 @@ The \texttt{ltug*} classes provide these abbreviations, among many others: \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} +(we recommend using \verb|mirror.ctan.org| for \CTAN\ references). 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 @@ -5633,17 +6506,17 @@ Email \verb|tugboat@tug.org| if problems or questions. </sect1> </appendix> -<chapter label="" xreflabel="Concept Index" id="Concept-Index"> +<chapter label="" id="Concept-Index"> <title>Concept Index</title> -<index></index> +<index role="cp"></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"> +<chapter label="" id="Command-Index"> <title>Command Index</title> -<index></index> +<index role="fn"></index> </chapter> </book> |