summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml')
-rw-r--r--Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml296
1 files changed, 166 insertions, 130 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml
index 2ff958c3e60..14221cde150 100644
--- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml
+++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml
@@ -1,17 +1,20 @@
<?xml version="1.0"?>
-<!DOCTYPE texinfo PUBLIC "-//GNU//DTD TexinfoML V4.12//EN" "http://www.gnu.org/software/texinfo/dtd/4.12/texinfo.dtd">
+<!DOCTYPE texinfo PUBLIC "-//GNU//DTD TexinfoML V4.13//EN" "http://www.gnu.org/software/texinfo/dtd/4.13/texinfo.dtd">
<texinfo xml:lang="en">
<setfilename>latex2e.xml</setfilename>
- <setvalue name="UPDATED">June 2008</setvalue>
- <setvalue name="VERSION">2.0</setvalue>
- <settitle>&latex;2e reference manual 2.0</settitle>
+ <setvalue name="UPDATED">September 2009</setvalue>
+ <settitle>&latex;2e reference manual (September 2009)</settitle>
<!-- %**end of header (This is for running Texinfo on a region.) -->
<!-- xx merge http://ctan.org/tex-archive/info/latex-info/ -->
-<!-- xx latex 2.09 should be pretty much complete now, but -->
-<!-- new stuff in latex2e is surely missing. -->
- <para>This document is version 2.0 (June 2008) of an unofficial reference manual for &latex;, a document preparation system. &latex; is a macro package for &tex;.</para>
+<!-- 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. -->
+ <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 <file>LATEX.HLP</file> v1.0a in the VMS Help Library. The pre-translation version was written by George&#xa0;D. Greenwade of Sam Houston State University. The &latex;&#xa0;2.09 version was written by Stephen Gilmore. The &latex;2e version was adapted from this by Torsten Martinsen. Karl Berry made further updates and additions, and gratefully acknowledges using <cite>Hypertext Help with &latex;</cite>, by Sheldon Green, and the <cite>&latex; Command Summary</cite> (for &latex; 2.09) by L.&#xa0;Botway and C.&#xa0;Biemesderfer (published by the &tex; Users Group as <cite>&tex;niques</cite> number 10), as reference material (text was not directly copied).</para>
- <para>Copyright &copyright; 2007, 2008 Karl Berry.&linebreak; Copyright &copyright; 1988, 1994, 2007 Stephen Gilmore.&linebreak; Copyright &copyright; 1994, 1995, 1996 Torsten Martinsen.</para>
+ <para>Copyright &copyright; 2007, 2008, 2009 Karl Berry.&linebreak; Copyright &copyright; 1988, 1994, 2007 Stephen Gilmore.&linebreak; Copyright &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>
@@ -19,11 +22,11 @@
<titlepage>
<booktitle>&amp;latex;: Structured documents for &amp;tex;</booktitle>
<booksubtitle>unofficial &amp;latex; reference manual</booksubtitle>
- <booksubtitle>version 2.0, June 2008</booksubtitle>
+ <booksubtitle>September 2009</booksubtitle>
<author></author>
- <para>This document is version 2.0 (June 2008) of an unofficial reference manual for &latex;, a document preparation system. &latex; is a macro package for &tex;.</para>
+ <para>This document is an unofficial reference manual for &latex;, a document preparation system, version as of September 2009.</para>
<para>This was originally translated from <file>LATEX.HLP</file> v1.0a in the VMS Help Library. The pre-translation version was written by George&#xa0;D. Greenwade of Sam Houston State University. The &latex;&#xa0;2.09 version was written by Stephen Gilmore. The &latex;2e version was adapted from this by Torsten Martinsen. Karl Berry made further updates and additions, and gratefully acknowledges using <cite>Hypertext Help with &latex;</cite>, by Sheldon Green, and the <cite>&latex; Command Summary</cite> (for &latex; 2.09) by L.&#xa0;Botway and C.&#xa0;Biemesderfer (published by the &tex; Users Group as <cite>&tex;niques</cite> number 10), as reference material (text was not directly copied).</para>
- <para>Copyright &copyright; 2007, 2008 Karl Berry.&linebreak; Copyright &copyright; 1988, 1994, 2007 Stephen Gilmore.&linebreak; Copyright &copyright; 1994, 1995, 1996 Torsten Martinsen.</para>
+ <para>Copyright &copyright; 2007, 2008, 2009 Karl Berry.&linebreak; Copyright &copyright; 1988, 1994, 2007 Stephen Gilmore.&linebreak; Copyright &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>
@@ -36,7 +39,7 @@
<nodeup>(dir)</nodeup>
<unnumbered>
<title>&latex;2e</title>
- <para>This document is version 2.0 (June 2008) of an unofficial reference manual for &latex;, a document preparation system. It is intended to cover &latex;2e, which has been the standard version of &latex; for many years.</para>
+ <para>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 index="cp">Knuth, Donald E.</indexterm><indexterm index="cp">Lamport, Leslie</indexterm><indexterm index="cp">&latex; Project team</indexterm>&latex; is implemented as a macro package for Donald&#xa0;E. Knuth's &tex; typesetting program. &latex; was originally created by Leslie Lamport; it is now maintained by a group of volunteers (<uref><urefurl>http://latex-project.org</urefurl></uref>). The official documentation written by the &latex; project is available there. Again, the present document is unofficial and has not been reviewed by the &latex; maintainers.</para>
<menu>
<menuentry>
@@ -1446,27 +1449,40 @@ second line \\
<section>
<title><code>figure</code></title>
<para><indexterm index="fn">figure</indexterm><indexterm index="cp">inserting figures</indexterm><indexterm index="cp">figures, inserting</indexterm></para>
- <example xml:space="preserve">\begin{figure}[<var>placement</var>]
+ <example xml:space="preserve">\begin{figure[*]}[<var>placement</var>]
<var>figbody</var>
\label{<var>label}</var>
\caption[<var>loftitle</var>]{<var>text</var>}
\end{figure}</example>
<para>Figures are objects that are not part of the normal text, and are instead &ldquo;floated&rdquo; 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 <code>[placement]</code> determines where &latex; will try to place your figure. There are four places where &latex; can possibly put a float:</para>
- <enumerate first="1">
- <item>
- <para><code>h</code> (Here) - at the position in the text where the figure environment appears.</para>
- </item>
- <item>
- <para><code>t</code> (Top) - at the top of a text page.</para>
- </item>
- <item>
- <para><code>b</code> (Bottom) - at the bottom of a text page.</para>
- </item>
- <item>
- <para><code>p</code> (Page of floats) - on a separate float page, which is a page containing no text, only floats.</para>
- </item>
- </enumerate>
+ <table>
+ <tableitem>
+ <tableterm><code>t</code></tableterm>
+ <item>
+ <para>(Top)&mdash;at the top of a text page.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>b</code></tableterm>
+ <item>
+ <para>(Bottom)&mdash;at the bottom of a text page. However, <code>b</code> is not allowed for full-width floats (<code>figure*</code>) with double-column output. To ameliorate this, use the <code>stfloats</code> or <code>dblfloatfix</code> package, but see the discussion at caveats in the FAQ: <uref><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</urefurl></uref>.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>h</code></tableterm><indexterm index="cp"><code>float</code> package</indexterm>
+ <item>
+ <para>(Here)&mdash;at the position in the text where the figure environment appears. However, this is not allowed by itself, <code>t</code> is automatically added. To absolutely force a figure to appear &ldquo;here&rdquo;, use the <code>float</code> and use its <code>H</code> placement letter. (That package also provides other options.)</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>p</code></tableterm>
+ <item>
+ <para>(Page of floats)&mdash;on a separate float page, which is a page containing no text, only floats.</para>
+ </item>
+ </tableitem>
+ </table>
<para>The standard report and article classes use the default placement <code>tbp</code>.</para>
<para>The body of the figure is made up of whatever text, &latex; commands, etc. you wish.</para>
<para><indexterm index="fn">\caption</indexterm>The <code>\caption</code> command specifies caption <var>text</var> for the figure. The caption is numbered by default. If <var>loftitle</var> is present, it is used in the list of figures instead of <var>text</var> (see <xref><xrefnodename>Tables of contents</xrefnodename></xref>).</para>
@@ -1593,13 +1609,13 @@ second line \\
<para>By default, the marks at each level look like this:</para>
<enumerate first="1">
<item>
- <para>&bullet;</para>
+ <para>&bullet; (bullet)</para>
</item>
<item>
<para><b>--<!-- /@w --></b> (bold en-dash)</para>
</item>
<item>
- <para>*</para>
+ <para>* (asterisk)</para>
</item>
<item>
<para>. (centered dot, rendered here as a period)</para>
@@ -1661,7 +1677,7 @@ second line \\
<tableitem>
<tableterm><indexterm index="fn">\topsep</indexterm><code>\topsep</code></tableterm>
<item>
- <para>Vertical space between the first item and the preceding paragraph. The default is <code>4pt plus2pt minus2pt</code> for <code>10pt</code> documents, <code>6pt plus2pt minus2pt</code> for <code>11pt</code>, and <code>9pt plus3pt minus5pt</code> for <code>12pt</code>.</para>
+ <para>Vertical space between the first item and the preceding paragraph. For top-level lists, the default is <code>8pt plus2pt minus4pt</code> for <code>10pt</code> documents, <code>9pt plus3pt minus5pt</code> for <code>11pt</code>, and <code>10pt plus4pt minus6pt</code> for <code>12pt</code>. These are reduced for nested lists.</para>
</item>
</tableitem>
<tableitem>
@@ -1670,12 +1686,6 @@ second line \\
<para>Extra space added to <code>\topsep</code> when the list environment starts a paragraph. The default is <code>2pt plus1pt minus1pt</code> for <code>10pt</code> documents, <code>3pt plus1pt minus1pt</code> for <code>11pt</code>, and <code>3pt plus2pt minus2pt</code> for <code>12pt</code>.</para>
</item>
</tableitem>
- <tableitem>
- <tableterm><indexterm index="fn">\topsep</indexterm><code>\topsep</code></tableterm>
- <item>
- <para>Extra vertical space added before an initial and after a final list item. Its value is changed with list level and font size changes; for instance, within a first-level list at <samp>10pt</samp>, it is <samp>4pt plus2pt minus2pt</samp>.</para>
- </item>
- </tableitem>
</table>
<para><indexterm index="fn">\parskip <r>example</r></indexterm>Especially for lists with short items, it may be desirable to elide space between items. Here is an example defining an <code>itemize*</code> environment with no extra spacing between items, or between paragraphs within a single item (<code>\parskip</code> is not list-specific, see <xref><xrefnodename>\parskip</xrefnodename></xref>):</para>
<example xml:space="preserve">\newenvironment{itemize*}%
@@ -1735,12 +1745,12 @@ second line \\
<section>
<title><code>minipage</code></title>
<para><indexterm index="fn">minipage <r>environment</r></indexterm><indexterm index="cp">minipage, creating a</indexterm></para>
- <example xml:space="preserve">\begin{minipage}[<var>position</var>]{<var>width</var>}
+ <example xml:space="preserve">\begin{minipage}[<var>position</var>][<var>height</var>][<var>inner-pos</var>]{<var>width</var>}
<var>text</var>
\end{minipage}</example>
- <para>The <code>minipage</code> environment typesets its body <var>text</var> in a block that will not be broken across pages (similar to the <code>\parbox</code> command, see <xref><xrefnodename>\parbox</xrefnodename></xref>). You may use other paragraph-making environments inside a minipage (unlike <code>\parbox</code>).</para>
+ <para>The <code>minipage</code> environment typesets its body <var>text</var> in a block that will not be broken across pages. This is similar to the <code>\parbox</code> command (see <xref><xrefnodename>\parbox</xrefnodename></xref>), but unlike <code>\parbox</code>, other paragraph-making environments can be used inside a minipage.</para>
<!-- (xxref positions) -->
- <para>It takes an optional <var>position</var> argument for placing <var>text</var>, and a mandatory <var>width</var> argument for specifying the line width.</para>
+ <para>The arguments are the same as for <code>\parbox</code> (see <xref><xrefnodename>\parbox</xrefnodename></xref>).</para>
<para><indexterm index="cp">indentation of paragraphs, in minipage</indexterm><indexterm index="cp">paragraph indentation, in minipage</indexterm><indexterm index="fn">\parindent</indexterm>By default, paragraphs are not indented in the <code>minipage</code> environment. You can restore indentation with a command such as <code>\setlength{\parindent}{1pc}</code> command.</para>
<para><indexterm index="cp">footnotes in figures</indexterm><indexterm index="cp">figures, footnotes in</indexterm>Footnotes in a <code>minipage</code> environment are handled in a way that is particularly useful for putting footnotes in figures or tables. A <code>\footnote</code> or <code>\footnotetext</code> command puts the footnote at the bottom of the minipage instead of at the bottom of the page, and it uses the <code>\mpfootnote</code> counter instead of the ordinary <code>footnote</code> counter (see <xref><xrefnodename>Counters</xrefnodename></xref>).</para>
<para>However, don't put one minipage inside another if you are using footnotes; they may wind up at the bottom of the wrong minipage.</para>
@@ -1761,8 +1771,8 @@ second line \\
<para>A position is a pair of coordinates, such as <code>(2.4,-5)</code>, specifying the point with x-coordinate <code>2.4</code> and y-coordinate <code>-5</code>. Coordinates are specified in the usual way with respect to an origin, which is normally at the lower-left corner of the picture. Note that when a position appears as an argument, it is not enclosed in braces; the parentheses serve to delimit the argument.</para>
<para>The <code>picture</code> environment has one mandatory argument, which is a <code>position</code>. It specifies the size of the picture. The environment produces a rectangular box with width and height determined by this argument's x- and y-coordinates.</para>
<para>The <code>picture</code> environment also has an optional <code>position</code> argument, following the <code>size</code> argument, that can change the origin. (Unlike ordinary optional arguments, this argument is not contained in square brackets.) The optional argument gives the coordinates of the point at the lower-left corner of the picture (thereby determining the origin). For example, if <code>\unitlength</code> has been set to <code>1mm</code>, the command</para>
- <example xml:space="preserve"> \begin{picture}(100,200)(10,20)</example>
- <para>produces a picture of width 100 millimeters and height 200 millimeters, whose lower-left corner is the point (10,20) and whose upper-right corner is therefore the point (110,220). When you first draw a picture, you will omit the optional argument, leaving the origin at the lower-left corner. If you then want to modify your picture by shifting everything, you just add the appropriate optional argument.</para>
+ <example xml:space="preserve">\begin{picture}(100,200)(10,20)</example>
+ <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 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 off the page. The picture's nominal size is used by &latex; in determining how much room to leave for it.</para>
<para>Everything that appears in a picture is drawn by the <code>\put</code> command. The command</para>
<example xml:space="preserve">\put (11.3,-.3){...}</example>
@@ -1865,21 +1875,32 @@ second line \\
<para><indexterm index="fn">\makebox (picture)</indexterm> <code>\makebox(width,height)[position]{...}</code></para>
<para>The <code>\makebox</code> command for the picture environment is similar to the normal <code>\makebox</code> command except that you must specify a <code>width</code> and <code>height</code> in multiples of <code>\unitlength</code>.</para>
<para>The optional argument, <code>[position]</code>, specifies the quadrant that your text appears in. You may select up to two of the following:</para>
- <itemize>
- <itemfunction>&bullet;</itemfunction>
- <item>
- <para><code>t</code> - Moves the item to the top of the rectangle</para>
- </item>
- <item>
- <para><code>b</code> - Moves the item to the bottom</para>
- </item>
- <item>
- <para><code>l</code> - Moves the item to the left</para>
- </item>
- <item>
- <para><code>r</code> - Moves the item to the right</para>
- </item>
- </itemize>
+ <table>
+ <tableitem>
+ <tableterm><code>t</code></tableterm>
+ <item>
+ <para>Moves the item to the top of the rectangle.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>b</code></tableterm>
+ <item>
+ <para>Moves the item to the bottom.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>l</code></tableterm>
+ <item>
+ <para>Moves the item to the left.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>r</code></tableterm>
+ <item>
+ <para>Moves the item to the right.</para>
+ </item>
+ </tableitem>
+ </table>
<para>See <xref><xrefnodename>\makebox</xrefnodename></xref>.</para>
</subsection>
</node>
@@ -2224,22 +2245,7 @@ function \= fact(n : integer) : integer;\\
\caption{table title}
\end{table}</example>
<para>Tables are objects that are not part of the normal text, and are usually &ldquo;floated&rdquo; to a convenient place, like the top of a page. Tables will not be split between two pages.</para>
- <para>The optional argument <code>[placement]</code> determines where &latex; will try to place your table. There are four places where &latex; can possibly put a float:</para>
- <itemize>
- <itemfunction>&bullet;</itemfunction>
- <item>
- <para><code>h</code>: Here - at the position in the text where the table environment appears.</para>
- </item>
- <item>
- <para><code>t</code>: Top - at the top of a text page.</para>
- </item>
- <item>
- <para><code>b</code>: Bottom - at the bottom of a text page.</para>
- </item>
- <item>
- <para><code>p</code>: Page of floats - on a separate float page, which is a page containing no text, only floats.</para>
- </item>
- </itemize>
+ <para>The optional argument <code>[placement]</code> determines where &latex; will try to place your table. There are four places where &latex; can possibly put a float; these are the same as that used with the <code>figure</code> environment, and described there (see <xref><xrefnodename>figure</xrefnodename></xref>).</para>
<para>The standard <code>report</code> and <code>article</code> classes use the default placement <code>[tbp]</code>.</para>
<para>The body of the table is made up of whatever text, &latex; commands, etc., you wish. The <code>\caption</code> command allows you to title your table.</para>
</section>
@@ -2275,56 +2281,81 @@ column 1 entry &amp; column 2 entry ... &amp; column n entry \\
<tableterm><code>pos</code></tableterm>
<item>
<para>Specifies the vertical position; default is alignment on the centre of the environment.</para>
- <itemize>
- <itemfunction>&bullet;</itemfunction>
- <item>
- <para><code>t</code> - align on top row</para>
- </item>
- <item>
- <para><code>b</code> - align on bottom row</para>
- </item>
- </itemize>
+ <table>
+ <tableitem>
+ <tableterm><code>t</code></tableterm>
+ <item>
+ <para>align on top row</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>b</code></tableterm>
+ <item>
+ <para>align on bottom row</para>
+ </item>
+ </tableitem>
+ </table>
</item>
</tableitem>
<tableitem>
<tableterm><code>cols</code></tableterm>
<item>
<para>Specifies the column formatting. It consists of a sequence of the following specifiers, corresponding to the sequence of columns and intercolumn material.</para>
- <itemize>
- <itemfunction>&bullet;</itemfunction>
- <item>
- <para><code>l</code> - A column of left-aligned items.</para>
- </item>
- <item>
- <para><code>r</code> - A column of right-aligned items.</para>
- </item>
- <item>
- <para><code>c</code> - A column of centred items.</para>
- </item>
- <item>
- <para><code>|</code> - A vertical line the full height and depth of the environment.</para>
- </item>
- <item>
- <para><code>@{text}</code> - This inserts <code>text</code> in every row. An @-expression suppresses the intercolumn space normally inserted between columns; any desired space between the inserted text and the adjacent items must be included in text. An <code>\extracolsep{wd}</code> command in an @-expression causes an extra space of width <code>wd</code> to appear to the left of all subsequent columns, until countermanded by another <code>\extracolsep</code> command. Unlike ordinary intercolumn space, this extra space is not suppressed by an @-expression. An <code>\extracolsep</code> command can be used only in an @-expression in the <code>cols</code> argument.</para>
- </item>
- <item>
- <para><code>p{wd}</code> - Produces a column with each item typeset in a parbox of width <code>wd</code>, as if it were the argument of a <code>\parbox[t]{wd}</code> command. However, a <code>\\</code> may not appear in the item, except in the following situations:</para>
- <enumerate first="1">
- <item>
- <para>inside an environment like <code>minipage</code>, <code>array</code>, or <code>tabular</code>.</para>
- </item>
- <item>
- <para>inside an explicit <code>\parbox</code>.</para>
- </item>
- <item>
- <para>in the scope of a <code>\centering</code>, <code>\raggedright</code>, or <code>\raggedleft</code> declaration. The latter declarations must appear inside braces or an environment when used in a <code>p</code>-column element.</para>
- </item>
- </enumerate>
- </item>
- <item>
- <para><code>*{num}{cols}</code> - Equivalent to <code>num</code> copies of <code>cols</code>, where <code>num</code> is any positive integer and <code>cols</code> is any list of column-specifiers, which may contain another <code>*-expression</code>.</para>
- </item>
- </itemize>
+ <table>
+ <tableitem>
+ <tableterm><code>l</code></tableterm>
+ <item>
+ <para>A column of left-aligned items.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>r</code></tableterm>
+ <item>
+ <para>A column of right-aligned items.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code></code></tableterm>
+ <item>
+ <para>A column of centred items.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>|</code></tableterm>
+ <item>
+ <para>A vertical line the full height and depth of the environment.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>@{<var>text</var>}</code></tableterm>
+ <item>
+ <para>This inserts <var>text</var> in every row. An @-expression suppresses the intercolumn space normally inserted between columns; any desired space between the inserted text and the adjacent items must be included in text. An <code>\extracolsep{wd}</code> command in an @-expression causes an extra space of width <code>wd</code> to appear to the left of all subsequent columns, until countermanded by another <code>\extracolsep</code> command. Unlike ordinary intercolumn space, this extra space is not suppressed by an @-expression. An <code>\extracolsep</code> command can be used only in an @-expression in the <code>cols</code> argument.</para>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>p{<var>wd</var>}</code></tableterm>
+ <item>
+ <para>Produces a column with each item typeset in a parbox of width <var>wd</var>, as if it were the argument of a <code>\parbox[t]{<var>wd</var>}</code> command. However, a <code>\\</code> may not appear in the item, except in the following situations:</para>
+ <enumerate first="1">
+ <item>
+ <para>inside an environment like <code>minipage</code>, <code>array</code>, or <code>tabular</code>.</para>
+ </item>
+ <item>
+ <para>inside an explicit <code>\parbox</code>.</para>
+ </item>
+ <item>
+ <para>in the scope of a <code>\centering</code>, <code>\raggedright</code>, or <code>\raggedleft</code> declaration. The latter declarations must appear inside braces or an environment when used in a <code>p</code>-column element.</para>
+ </item>
+ </enumerate>
+ </item>
+ </tableitem>
+ <tableitem>
+ <tableterm><code>*{<var>num</var>}{<var>cols</var>}</code></tableterm>
+ <item>
+ <para>Equivalent to <var>num</var> copies of <var>cols</var>, where <var>num</var> is a positive integer and <var>cols</var> is any list of column-specifiers, which may contain another <code>*-expression</code>.</para>
+ </item>
+ </tableitem>
+ </table>
</item>
</tableitem>
</table>
@@ -2340,7 +2371,7 @@ column 1 entry &amp; column 2 entry ... &amp; column n entry \\
<tableitem>
<tableterm><indexterm index="fn">\arraystretch</indexterm><code>\arraystretch</code></tableterm>
<item>
- <para>Scaling of spacing between rows in the <code>tabular</code> and <code>array</code> environments; default is <samp>1</samp>,for no scaling.</para>
+ <para>Scaling of spacing between rows in the <code>tabular</code> and <code>array</code> environments; default is <samp>1</samp>, for no scaling.</para>
</item>
</tableitem>
<tableitem>
@@ -5192,6 +5223,12 @@ double-asterix(**) double-dagger double-ddagger</display>
</item>
</tableitem>
<tableitem>
+ <tableterm><indexterm index="fn">\bar</indexterm><code>\bar</code></tableterm><indexterm index="cp">bar-over accent, math</indexterm><indexterm index="cp">macron accent, math</indexterm>
+ <item>
+ <para>Math bar-over accent: <math>\barx</math>.</para>
+ </item>
+ </tableitem>
+ <tableitem>
<tableterm><indexterm index="fn">\breve</indexterm><code>\breve</code></tableterm><indexterm index="cp">breve accent, math</indexterm>
<item>
<para>Math breve accent: <math>\brevex</math>.</para>
@@ -6248,12 +6285,6 @@ double-asterix(**) double-dagger double-ddagger</display>
</item>
</tableitem>
<tableitem>
- <tableterm><code>\bar</code></tableterm><indexterm index="fn">\bar <r>(macron, bar-over accent)</r></indexterm><indexterm index="cp">bar-over accent</indexterm><indexterm index="cp">macron accent</indexterm>
- <item>
- <para>Produces a macron accent over the following, as in o&macr;.</para>
- </item>
- </tableitem>
- <tableitem>
<tableterm><code>\c</code></tableterm><indexterm index="fn">\c <r>(cedilla accent)</r></indexterm><indexterm index="cp">cedilla accent</indexterm>
<item>
<para>Produces a cedilla accent under the following, as in
@@ -6499,7 +6530,7 @@ double-asterix(**) double-dagger double-ddagger</display>
<title>Tables of contents</title>
<para><indexterm index="cp">table of contents, creating</indexterm> <indexterm index="fn">\tableofcontents</indexterm>A table of contents is produced with the <code>\tableofcontents</code> command. You put the command right where you want the table of contents to go; &latex; does the rest for you. A previous run must have generated a <file>.toc</file> file.</para>
<para>The <code>\tableofcontents</code> command produces a heading, but it does not automatically start a new page. If you want a new page after the table of contents, write a <code>\newpage</code> command after the <code>\tableofcontents</code> command.</para>
- <para><indexterm index="fn">\listoffigures</indexterm><indexterm index="fn">\listoftables</indexterm>The analagous commands <code>\listoffigures</code> and <code>\listoftables</code> produce a list of figures and a list of tables, respectively. Everything works exactly the same as for the table of contents.</para>
+ <para><indexterm index="fn">\listoffigures</indexterm><indexterm index="fn">\listoftables</indexterm>The analogous commands <code>\listoffigures</code> and <code>\listoftables</code> produce a list of figures and a list of tables, respectively. Everything works exactly the same as for the table of contents.</para>
<para><indexterm index="fn">\nofiles</indexterm>The command <code>\nofiles</code> overrides these commands, and <emph>prevents</emph> any of these lists from being generated.</para>
<menu>
<menuentry>
@@ -6521,7 +6552,7 @@ double-asterix(**) double-dagger double-ddagger</display>
<nodeup>Tables of contents</nodeup>
<subsection>
<title>\addcontentsline</title>
- <para><indexterm index="fn">\addcontentsline{<var>ext</var>}{<var>unit</var>}{<var>text</var>}</indexterm><indexterm index="cp">table of contents entry, manually adding</indexterm> The <code>\addcontentsline</code> command adds an entry to the specified list or table where:</para>
+ <para><indexterm index="fn">\addcontentsline{<var>ext</var>}{<var>unit</var>}{<var>text</var>}</indexterm><indexterm index="cp">table of contents entry, manually adding</indexterm> The <code>\addcontentsline</code>{<var>ext</var>}{<var>unit</var>}{<var>text</var>} command adds an entry to the specified list or table where:</para>
<table>
<tableitem>
<tableterm><var>ext</var></tableterm>
@@ -6572,7 +6603,7 @@ double-asterix(**) double-dagger double-ddagger</display>
<nodeup>Tables of contents</nodeup>
<subsection>
<title>\addtocontents</title>
- <para><indexterm index="fn">\addtocontents{<var>ext</var>}{<var>text</var>}</indexterm> The <code>\addtocontents</code> command adds text (or formatting commands) directly to the <file>.</file><var>ext</var> file that generates the table of contents or lists of figures or tables.</para>
+ <para><indexterm index="fn">\addtocontents{<var>ext</var>}{<var>text</var>}</indexterm> The <code>\addtocontents</code>{<var>ext</var>}{<var>text</var>} command adds text (or formatting commands) directly to the <file>.<var>ext</var></file> file that generates the table of contents or lists of figures or tables.</para>
<table>
<tableitem>
<tableterm><var>ext</var></tableterm>
@@ -6608,11 +6639,16 @@ double-asterix(**) double-dagger double-ddagger</display>
<nodeup>Front/back matter</nodeup>
<section>
<title>Indexes</title>
- <para><indexterm index="cp">indexes</indexterm> <indexterm index="fn">\makeindex</indexterm>The command <code>\makeindex</code> enables creating indexes.</para>
- <para><indexterm index="fn">\index</indexterm><indexterm index="cp"><file>.idx</file> file</indexterm>The command <code>\index{<var>text</var>}</code> writes a glossary entry for <var>text</var> to an auxiliary file with the <file>.idx</file> extension.</para>
+ <para><indexterm index="cp">indexes</indexterm> <indexterm index="fn">\makeindex</indexterm>The command <code>\makeindex</code> enables creating indexes. Put this in the preamble.</para>
+ <para><indexterm index="fn">\index</indexterm><indexterm index="cp"><file>.idx</file> file</indexterm>The command <code>\index{<var>text</var>}</code> writes an index entry for <var>text</var> to an auxiliary file with the <file>.idx</file> extension.</para>
<para><indexterm index="fn">\indexentry</indexterm>Specifically, what gets written is the command <code>\indexentry{<var>text</var>}{<var>pageno</var>}</code>, where <var>pageno</var> is the current <code>\thepage</code> value.</para>
- <para>The rubber length <code>\indexspace</code> is inserted before each new letter in the index; its default value is <samp>10pt plus5pt minus3pt</samp>.</para>
- <para><indexterm index="cp"><command>makeindex</command> program</indexterm><indexterm index="cp"><command>xindy</command> program</indexterm><indexterm index="cp"><file>.ind</file> file</indexterm> The <file>.idx</file> file can then be sorted with an external command, typically <command>makeindex</command> or <command>xindy</command>, resulting in a <file>.ind</file> file, which can then be used to typeset the index.</para>
+ <para><indexterm index="cp">`see' and `see also' index entries</indexterm>To generate a index entry for `bar' that says `See foo', use a vertical bar: <code>\index{bar|see{foo}}</code>. Use <code>seealso</code> instead of <code>see</code> to make a `See also' entry.</para>
+ <para><indexterm index="fn">\seename</indexterm><indexterm index="fn">\alsoname</indexterm>The text `See' is defined by the macro <code>\seename</code>, and `See also' by the macro <code>\alsoname</code>. These can be redefined for other languages.</para>
+ <para><indexterm index="cp"><command>makeindex</command> program</indexterm><indexterm index="cp"><command>xindy</command> program</indexterm><indexterm index="cp"><file>.ind</file> file</indexterm>The generated <file>.idx</file> file is then sorted with an external command, usually either <command>makeindex</command> (<uref><urefurl>http://mirror.ctan.org/indexing/makeindex</urefurl></uref>) or (the multi-lingual) <command>xindy</command> (<uref><urefurl>http://xindy.sourceforge.net</urefurl></uref>). This results in a <file>.ind</file> file, which can then be read to typeset the index.</para>
+ <para><indexterm index="fn">printindex</indexterm><indexterm index="cp"><code>makeidx</code> package</indexterm>The index is usually generated with the <code>\printindex</code> command. This is defined in the <code>makeidx</code> package, so <code>\usepackage{makeidx}</code> needs to be in the preamble.</para>
+ <para><indexterm index="fn">indexspace</indexterm>The rubber length <code>\indexspace</code> is inserted before each new letter in the printed index; its default value is <samp>10pt plus5pt minus3pt</samp>.</para>
+ <para><indexterm index="cp"><code>showidx</code> package</indexterm>The <code>showidx</code> package causes each index entries to be shown in the margin on the page where the entry appears. This can help in preparing the index.</para>
+ <para><indexterm index="cp"><code>multind</code> package</indexterm>The <code>multind</code> package supports multiple indexes. See also the &tex; FAQ entry on this topic, <uref><urefurl>http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind</urefurl></uref>.</para>
</section>
</node>
<node>