diff options
author | Karl Berry <karl@freefriends.org> | 2009-09-20 23:56:34 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-09-20 23:56:34 +0000 |
commit | 0ed8c3b79d4d60feca2ebd474727ac34dfd113ea (patch) | |
tree | d5d32e4cdea7d4c2ad65246c1095087eb0a54026 /Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk | |
parent | 468ebe00c99a6481bb3542f4ddf6cdadde20d9f7 (diff) |
latex2e-help-texinfo (sep09)
git-svn-id: svn://tug.org/texlive/trunk@15392 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 | 378 |
1 files changed, 217 insertions, 161 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 8d7d14494a2..2efdec9b56a 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.dbk @@ -4,16 +4,19 @@ <!ENTITY latex "LaTeX"> ]> <book id="latex2e.dbk" lang="en"> - <title>&latex;2e reference manual 2.0</title> + <title>&latex;2e reference manual (September 2009)</title> <!-- %**end of header (This is for running Texinfo on a region.) --> <!-- xx merge http://ctan.org/tex-archive/info/latex-info/ --> -<!-- xx latex 2.09 should be pretty much complete now, but --> -<!-- new stuff in latex2e is surely missing. --> +<!-- xx check http://ctan.org/tex-archive/info/latexcheat --> +<!-- xx latex 2.09 should be complete, but latex2e stuff is missing. --> +<!-- 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. --> <bookinfo> <legalnotice> - <para>This document is version 2.0 (June 2008) of an -unofficial reference manual for &latex;, a document preparation -system. &latex; is a macro package for &tex;.</para> + <para>This document is an unofficial reference manual for &latex;, a +document preparation system, version as of September 2009.</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 @@ -25,7 +28,7 @@ using <citetitle>Hypertext Help with &latex;</citetitle>, by Sheldon Green, and and C. Biemesderfer (published by the &tex; Users Group as <citetitle>&tex;niques</citetitle> number 10), as reference material (text was not directly copied).</para> - <para>Copyright © 2007, 2008 Karl Berry. + <para>Copyright © 2007, 2008, 2009 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 @@ -41,10 +44,10 @@ into another language, under the above conditions for modified versions.</para> </bookinfo> <chapter label="" xreflabel="LaTeX2e" id="Top"> <title>&latex;2e</title> - <para>This document is version 2.0 (June 2008) of an -unofficial reference manual for &latex;, a document preparation -system. It is intended to cover &latex;2e, which has been the -standard version of &latex; for many years.</para> + <para>This document is an unofficial reference manual for &latex;, a +document preparation system, version as of September 2009. It is +intended to cover &latex;2e, which has been the standard version of +&latex; for many years.</para> <para><indexterm role="cp"><primary>Knuth, Donald E.</primary></indexterm><indexterm role="cp"><primary>Lamport, Leslie</primary></indexterm><indexterm role="cp"><primary>&latex; Project team</primary></indexterm>&latex; is implemented as a macro package for Donald E. Knuth's &tex; typesetting program. &latex; was originally created by Leslie Lamport; it is now maintained by a group of volunteers @@ -1229,7 +1232,7 @@ on the page, and also places an equation number in the right margin.</para> <title><literal>figure</literal></title> <para><indexterm role="fn"><primary>figure</primary></indexterm><indexterm role="cp"><primary>inserting figures</primary></indexterm><indexterm role="cp"><primary>figures, inserting</primary></indexterm></para> <screen> -\begin{figure}[<replaceable>placement</replaceable>] +\begin{figure[*]}[<replaceable>placement</replaceable>] <replaceable>figbody</replaceable> \label{<replaceable>label}</replaceable> \caption[<replaceable>loftitle</replaceable>]{<replaceable>text</replaceable>} @@ -1238,25 +1241,46 @@ on the page, and also places an equation number in the right margin.</para> <para>Figures are objects that are not part of the normal text, and are instead “floated” to a convenient place, such as the top of a page. Figures will not be split between two pages.</para> + <para>When typesetting in double-columns, the starred form produces a +full-width figure (across both columns).</para> <para>The optional argument <literal>[placement]</literal> determines where &latex; will try to place your figure. There are four places where &latex; can possibly put a float:</para> - <orderedlist numeration="arabic"> - <listitem> - <para><literal>h</literal> (Here) - at the position in the text where the figure -environment appears.</para> - </listitem> - <listitem> - <para><literal>t</literal> (Top) - at the top of a text page.</para> - </listitem> - <listitem> - <para><literal>b</literal> (Bottom) - at the bottom of a text page.</para> - </listitem> - <listitem> - <para><literal>p</literal> (Page of floats) - on a separate float page, which is a page + <variablelist> + <varlistentry> + <term><literal>t</literal></term> + <listitem> + <para>(Top)—at the top of a text page.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>b</literal></term> + <listitem> + <para>(Bottom)—at the bottom of a text page. However, <literal>b</literal> is not +allowed for full-width floats (<literal>figure*</literal>) with double-column +output. To ameliorate this, use the <literal>stfloats</literal> or +<literal>dblfloatfix</literal> package, but see the discussion at caveats in the +FAQ: <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</ulink>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>h</literal></term> + <listitem> + <para><indexterm role="cp"><primary><literal>float</literal> package</primary></indexterm>(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 containing no text, only floats.</para> - </listitem> - </orderedlist> + </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. @@ -1391,13 +1415,13 @@ There must be at least one <literal>\item</literal> command within the environme <para>By default, the marks at each level look like this:</para> <orderedlist numeration="arabic"> <listitem> - <para>•</para> + <para>• (bullet)</para> </listitem> <listitem> <para><emphasis role="bold">--<!-- /@w --></emphasis> (bold en-dash)</para> </listitem> <listitem> - <para>*</para> + <para>* (asterisk)</para> </listitem> <listitem> <para>. (centered dot, rendered here as a period)</para> @@ -1481,9 +1505,10 @@ are the same as <literal>\itemsep</literal>.</para> <term><literal>\topsep</literal></term> <listitem> <para>Vertical space between the first item and the preceding paragraph. -The default is <literal>4pt plus2pt minus2pt</literal> for <literal>10pt</literal> documents, -<literal>6pt plus2pt minus2pt</literal> for <literal>11pt</literal>, and <literal>9pt plus3pt -minus5pt</literal> for <literal>12pt</literal>.</para> +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> @@ -1495,15 +1520,6 @@ documents, <literal>3pt plus1pt minus1pt</literal> for <literal>11pt</literal>, plus2pt minus2pt</literal> for <literal>12pt</literal>.</para> </listitem> </varlistentry> - <varlistentry> - <term><literal>\topsep</literal></term> - <listitem> - <para>Extra vertical space added before an initial and after a final list -item. Its value is changed with list level and font size changes; for -instance, within a first-level list at ‘<literal>10pt</literal>’, it is ‘<literal>4pt -plus2pt minus2pt</literal>’.</para> - </listitem> - </varlistentry> </variablelist> <para><indexterm role="fn"><primary>\parskip example</primary></indexterm>Especially for lists with short items, it may be desirable to elide space between items. Here is an example defining an <literal>itemize*</literal> @@ -1566,17 +1582,16 @@ See <xref linkend="Math-formulas"></xref>.</para> <title><literal>minipage</literal></title> <para><indexterm role="fn"><primary>minipage environment</primary></indexterm><indexterm role="cp"><primary>minipage, creating a</primary></indexterm></para> <screen> -\begin{minipage}[<replaceable>position</replaceable>]{<replaceable>width</replaceable>} +\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 (similar to the -<literal>\parbox</literal> command, see <xref linkend="\parbox"></xref>). You may use other -paragraph-making environments inside a minipage (unlike <literal>\parbox</literal>).</para> +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>, +other paragraph-making environments can be used inside a minipage.</para> <!-- (xxref positions) --> - <para>It takes an optional <replaceable>position</replaceable> argument for placing <replaceable>text</replaceable>, -and a mandatory <replaceable>width</replaceable> argument for specifying the line width.</para> + <para>The arguments are the same as for <literal>\parbox</literal> (see <xref linkend="\parbox"></xref>).</para> <para><indexterm role="cp"><primary>indentation of paragraphs, in minipage</primary></indexterm><indexterm role="cp"><primary>paragraph indentation, in minipage</primary></indexterm><indexterm role="fn"><primary>\parindent</primary></indexterm>By default, paragraphs are not indented in the <literal>minipage</literal> environment. You can restore indentation with a command such as <literal>\setlength{\parindent}{1pc}</literal> command.</para> @@ -1627,14 +1642,15 @@ coordinates of the point at the lower-left corner of the picture (thereby determining the origin). For example, if <literal>\unitlength</literal> has been set to <literal>1mm</literal>, the command</para> <screen> - \begin{picture}(100,200)(10,20) +\begin{picture}(100,200)(10,20) </screen> - <para>produces a picture of width 100 millimeters and height 200 + <para role="continues">produces a picture of width 100 millimeters and height 200 millimeters, whose lower-left corner is the point (10,20) and whose upper-right corner is therefore the point (110,220). When you first -draw a picture, you will omit the optional argument, leaving the origin -at the lower-left corner. If you then want to modify your picture by -shifting everything, you just add the appropriate optional argument.</para> +draw a picture, you typically omit the optional argument, leaving the +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 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 @@ -1675,20 +1691,32 @@ the normal <literal>\makebox</literal> command except that you must specify a <literal>width</literal> and <literal>height</literal> in multiples of <literal>\unitlength</literal>.</para> <para>The optional argument, <literal>[position]</literal>, specifies the quadrant that your text appears in. You may select up to two of the following:</para> - <itemizedlist mark="bullet"> - <listitem> - <para><literal>t</literal> - Moves the item to the top of the rectangle</para> - </listitem> - <listitem> - <para><literal>b</literal> - Moves the item to the bottom</para> - </listitem> - <listitem> - <para><literal>l</literal> - Moves the item to the left</para> - </listitem> - <listitem> - <para><literal>r</literal> - Moves the item to the right</para> - </listitem> - </itemizedlist> + <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.</para> + </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.</para> + </listitem> + </varlistentry> + </variablelist> <para>See <xref linkend="\makebox"></xref>.</para> </sect2> @@ -2063,23 +2091,8 @@ usually “floated” to a convenient place, like the top of a page. Tables will not be split between two pages.</para> <para>The optional argument <literal>[placement]</literal> determines where &latex; will try to place your table. There are four places where &latex; can possibly put -a float:</para> - <itemizedlist mark="bullet"> - <listitem> - <para><literal>h</literal>: Here - at the position in the text where the table -environment appears.</para> - </listitem> - <listitem> - <para><literal>t</literal>: Top - at the top of a text page.</para> - </listitem> - <listitem> - <para><literal>b</literal>: Bottom - at the bottom of a text page.</para> - </listitem> - <listitem> - <para><literal>p</literal>: Page of floats - on a separate float page, which is a page -containing no text, only floats.</para> - </listitem> - </itemizedlist> +a float; these are the same as that used with the <literal>figure</literal> +environment, and described there (see <xref linkend="figure"></xref>).</para> <para>The standard <literal>report</literal> and <literal>article</literal> classes use the default placement <literal>[tbp]</literal>.</para> <para>The body of the table is made up of whatever text, &latex; commands, etc., @@ -2123,14 +2136,20 @@ width.</para> <listitem> <para>Specifies the vertical position; default is alignment on the centre of the environment.</para> - <itemizedlist mark="bullet"> - <listitem> - <para><literal>t</literal> - align on top row</para> - </listitem> - <listitem> - <para><literal>b</literal> - align on bottom row</para> - </listitem> - </itemizedlist> + <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> @@ -2139,57 +2158,76 @@ the environment.</para> <para>Specifies the column formatting. It consists of a sequence of the following specifiers, corresponding to the sequence of columns and intercolumn material.</para> - <itemizedlist mark="bullet"> - <listitem> - <para><literal>l</literal> - A column of left-aligned items.</para> - </listitem> - <listitem> - <para><literal>r</literal> - A column of right-aligned items.</para> - </listitem> - <listitem> - <para><literal>c</literal> - A column of centred items.</para> - </listitem> - <listitem> - <para><literal>|</literal> - A vertical line the full height and depth of the environment.</para> - </listitem> - <listitem> - <para><literal>@{text}</literal> - This inserts <literal>text</literal> in every row. An @-expression -suppresses the intercolumn space normally inserted between columns; any -desired space between the inserted text and the adjacent items must be -included in text. An <literal>\extracolsep{wd}</literal> command in an -@-expression causes an extra space of width <literal>wd</literal> to appear to the -left of all subsequent columns, until countermanded by another -<literal>\extracolsep</literal> command. Unlike ordinary intercolumn space, this -extra space is not suppressed by an @-expression. An -<literal>\extracolsep</literal> command can be used only in an @-expression in the -<literal>cols</literal> argument.</para> - </listitem> - <listitem> - <para><literal>p{wd}</literal> - Produces a column with each item typeset in a parbox of -width <literal>wd</literal>, as if it were the argument of a <literal>\parbox[t]{wd}</literal> -command. However, a <literal>\\</literal> may not appear in the item, except in the -following situations:</para> - <orderedlist numeration="arabic"> - <listitem> - <para>inside an environment like <literal>minipage</literal>, <literal>array</literal>, or <literal>tabular</literal>.</para> - </listitem> - <listitem> - <para>inside an explicit <literal>\parbox</literal>.</para> - </listitem> - <listitem> - <para>in the scope of a <literal>\centering</literal>, <literal>\raggedright</literal>, or <literal>\raggedleft</literal> + <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.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal></literal></term> + <listitem> + <para>A column of centred items.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>|</literal></term> + <listitem> + <para>A vertical line the full height and depth of the environment.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>@{<replaceable>text</replaceable>}</literal></term> + <listitem> + <para>This inserts <replaceable>text</replaceable> in every row. An @-expression suppresses the +intercolumn space normally inserted between columns; any desired space +between the inserted text and the adjacent items must be included in +text. An <literal>\extracolsep{wd}</literal> command in an @-expression causes +an extra space of width <literal>wd</literal> to appear to the left of all +subsequent columns, until countermanded by another <literal>\extracolsep</literal> +command. Unlike ordinary intercolumn space, this extra space is not +suppressed by an @-expression. An <literal>\extracolsep</literal> command can be +used only in an @-expression in the <literal>cols</literal> argument.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>p{<replaceable>wd</replaceable>}</literal></term> + <listitem> + <para>Produces a column with each item typeset in a parbox of width +<replaceable>wd</replaceable>, as if it were the argument of a +<literal>\parbox[t]{<replaceable>wd</replaceable>}</literal> command. However, a <literal>\\</literal> may not +appear in the item, except in the following situations:</para> + <orderedlist numeration="arabic"> + <listitem> + <para>inside an environment like <literal>minipage</literal>, <literal>array</literal>, or <literal>tabular</literal>.</para> + </listitem> + <listitem> + <para>inside an explicit <literal>\parbox</literal>.</para> + </listitem> + <listitem> + <para>in the scope of a <literal>\centering</literal>, <literal>\raggedright</literal>, or <literal>\raggedleft</literal> declaration. The latter declarations must appear inside braces or an environment when used in a <literal>p</literal>-column element.</para> - </listitem> - </orderedlist> - </listitem> - <listitem> - <para><literal>*{num}{cols}</literal> - Equivalent to <literal>num</literal> copies of -<literal>cols</literal>, where <literal>num</literal> is any positive integer and <literal>cols</literal> is -any list of column-specifiers, which may contain another -<literal>*-expression</literal>.</para> - </listitem> - </itemizedlist> + </listitem> + </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> @@ -2208,7 +2246,7 @@ default is ‘<literal>.4pt</literal>’.</para> <term><literal>\arraystretch</literal></term> <listitem> <para>Scaling of spacing between rows in the <literal>tabular</literal> and <literal>array</literal> -environments; default is ‘<literal>1</literal>’,for no scaling.</para> +environments; default is ‘<literal>1</literal>’, for no scaling.</para> </listitem> </varlistentry> <varlistentry> @@ -4837,6 +4875,12 @@ in math. These are different from accents in normal text </listitem> </varlistentry> <varlistentry> + <term><literal>\bar</literal></term> + <listitem> + <para><indexterm role="cp"><primary>bar-over accent, math</primary></indexterm><indexterm role="cp"><primary>macron accent, math</primary></indexterm>Math bar-over accent: \barx.</para> + </listitem> + </varlistentry> + <varlistentry> <term><literal>\breve</literal></term> <listitem> <para><indexterm role="cp"><primary>breve accent, math</primary></indexterm>Math breve accent: \brevex.</para> @@ -5788,12 +5832,6 @@ environment, pushes current column to the right of the previous column </listitem> </varlistentry> <varlistentry> - <term><literal>\bar</literal></term> - <listitem> - <para><indexterm role="fn"><primary>\bar (macron, bar-over accent)</primary></indexterm><indexterm role="cp"><primary>bar-over accent</primary></indexterm><indexterm role="cp"><primary>macron accent</primary></indexterm>Produces a macron accent over the following, as in o¯.</para> - </listitem> - </varlistentry> - <varlistentry> <term><literal>\c</literal></term> <listitem> <para><indexterm role="fn"><primary>\c (cedilla accent)</primary></indexterm><indexterm role="cp"><primary>cedilla accent</primary></indexterm>Produces a cedilla accent under the following, as in @@ -6011,7 +6049,7 @@ have generated a <filename>.toc</filename> file.</para> not automatically start a new page. If you want a new page after the table of contents, write a <literal>\newpage</literal> command after the <literal>\tableofcontents</literal> command.</para> - <para><indexterm role="fn"><primary>\listoffigures</primary></indexterm><indexterm role="fn"><primary>\listoftables</primary></indexterm>The analagous commands <literal>\listoffigures</literal> and <literal>\listoftables</literal> + <para><indexterm role="fn"><primary>\listoffigures</primary></indexterm><indexterm role="fn"><primary>\listoftables</primary></indexterm>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> <para><indexterm role="fn"><primary>\nofiles</primary></indexterm>The command <literal>\nofiles</literal> overrides these commands, and @@ -6020,8 +6058,8 @@ Everything works exactly the same as for the table of contents.</para> <sect2 label="23.1.1" id="\addcontentsline"> <title>\addcontentsline</title> <para><indexterm role="fn"><primary>\addcontentsline{<replaceable>ext</replaceable>}{<replaceable>unit</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm><indexterm role="cp"><primary>table of contents entry, manually adding</primary></indexterm> -The <literal>\addcontentsline</literal> command adds an entry to the specified list -or table where:</para> +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> @@ -6074,9 +6112,9 @@ command <literal>\contentsline{<replaceable>unit</replaceable>}{<replaceable>nam <sect2 label="23.1.2" id="\addtocontents"> <title>\addtocontents</title> <para><indexterm role="fn"><primary>\addtocontents{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm> -The <literal>\addtocontents</literal> command adds text (or formatting commands) -directly to the <filename>.</filename><replaceable>ext</replaceable> file that generates the table of -contents or lists of figures or tables.</para> +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> @@ -6112,19 +6150,37 @@ glossaries.</para> <sect1 label="23.3" id="Indexes"> <title>Indexes</title> <para><indexterm role="cp"><primary>indexes</primary></indexterm> -<indexterm role="fn"><primary>\makeindex</primary></indexterm>The command <literal>\makeindex</literal> enables creating indexes.</para> - <para><indexterm role="fn"><primary>\index</primary></indexterm><indexterm role="cp"><primary><filename>.idx</filename> file</primary></indexterm>The command <literal>\index{<replaceable>text</replaceable>}</literal> writes a glossary entry for +<indexterm role="fn"><primary>\makeindex</primary></indexterm>The command <literal>\makeindex</literal> enables creating indexes. Put this in +the preamble.</para> + <para><indexterm role="fn"><primary>\index</primary></indexterm><indexterm role="cp"><primary><filename>.idx</filename> file</primary></indexterm>The command <literal>\index{<replaceable>text</replaceable>}</literal> writes an index entry for <replaceable>text</replaceable> to an auxiliary file with the <filename>.idx</filename> extension.</para> <para><indexterm role="fn"><primary>\indexentry</primary></indexterm>Specifically, what gets written is the command <literal>\indexentry{<replaceable>text</replaceable>}{<replaceable>pageno</replaceable>}</literal>, where <replaceable>pageno</replaceable> is the current <literal>\thepage</literal> value.</para> - <para>The rubber length <literal>\indexspace</literal> is inserted before each new -letter in the index; its default value is ‘<literal>10pt plus5pt + <para><indexterm role="cp"><primary>`see' and `see also' index entries</primary></indexterm>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.</para> + <para><indexterm role="fn"><primary>\seename</primary></indexterm><indexterm role="fn"><primary>\alsoname</primary></indexterm>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> + <para><indexterm role="cp"><primary><command>makeindex</command> program</primary></indexterm><indexterm role="cp"><primary><command>xindy</command> program</primary></indexterm><indexterm role="cp"><primary><filename>.ind</filename> file</primary></indexterm>The 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> + <para><indexterm role="fn"><primary>printindex</primary></indexterm><indexterm role="cp"><primary><literal>makeidx</literal> package</primary></indexterm>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> + <para><indexterm role="fn"><primary>indexspace</primary></indexterm>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> - <para><indexterm role="cp"><primary><command>makeindex</command> program</primary></indexterm><indexterm role="cp"><primary><command>xindy</command> program</primary></indexterm><indexterm role="cp"><primary><filename>.ind</filename> file</primary></indexterm> -The <filename>.idx</filename> file can then be sorted with an external command, -typically <command>makeindex</command> or <command>xindy</command>, resulting in a -<filename>.ind</filename> file, which can then be used to typeset the index.</para> + <para><indexterm role="cp"><primary><literal>showidx</literal> package</primary></indexterm>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> + <para><indexterm role="cp"><primary><literal>multind</literal> package</primary></indexterm>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> </sect1> </chapter> |