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.texi | |
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.texi')
-rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi | 375 |
1 files changed, 208 insertions, 167 deletions
diff --git a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi index f9c7070c6a7..2eef185e6f4 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi @@ -1,20 +1,23 @@ \input texinfo -@c $Id: latex2e.texi 234 2008-06-10 18:27:54Z karl $ +@c $Id: latex2e.texi 244 2009-09-07 17:14:36Z karl $ @comment %**start of header (This is for running Texinfo on a region.) @setfilename latex2e.info -@set UPDATED June 2008 -@set VERSION 2.0 -@settitle @LaTeX{}2e reference manual @value{VERSION} +@set UPDATED September 2009 +@settitle @LaTeX{}2e reference manual (@value{UPDATED}) @comment %**end of header (This is for running Texinfo on a region.) @c xx merge http://ctan.org/tex-archive/info/latex-info/ -@c xx latex 2.09 should be pretty much complete now, but -@c new stuff in latex2e is surely missing. +@c xx check http://ctan.org/tex-archive/info/latexcheat +@c +@c xx latex 2.09 should be complete, but latex2e stuff is missing. +@c xx The typeset source2e will have an index with all kernel +@c xx commands, which would be a good start. classes.dtx et al. +@c xx define additional commands, and some of the kernel commands are +@c xx internal and so shouldn't be included here. @copying -This document is version @value{VERSION} (@value{UPDATED}) of an -unofficial reference manual for @LaTeX{}, a document preparation -system. @LaTeX{} is a macro package for @TeX{}. +This document is an unofficial reference manual for @LaTeX{}, a +document preparation system, version as of @value{UPDATED}. This was originally translated from @file{LATEX.HLP} v1.0a in the VMS Help Library. The pre-translation version was written by @@ -28,7 +31,7 @@ and C.@tie{}Biemesderfer (published by the @TeX{} Users Group as @cite{@TeX{}niques} number 10), as reference material (text was not directly copied). -Copyright @copyright{} 2007, 2008 Karl Berry.@* +Copyright @copyright{} 2007, 2008, 2009 Karl Berry.@* Copyright @copyright{} 1988, 1994, 2007 Stephen Gilmore.@* Copyright @copyright{} 1994, 1995, 1996 Torsten Martinsen. @@ -64,8 +67,8 @@ into another language, under the above conditions for modified versions. @titlepage @title @LaTeX{}: Structured documents for @TeX{} @subtitle unofficial @LaTeX{} reference manual -@subtitle version @value{VERSION}, @value{UPDATED} -@author +@subtitle @value{UPDATED} +@author @page @vskip 0pt plus 1filll @insertcopying @@ -77,10 +80,10 @@ into another language, under the above conditions for modified versions. @node Top @top @LaTeX{}2e -This document is version @value{VERSION} (@value{UPDATED}) of an -unofficial reference manual for @LaTeX{}, a document preparation -system. It is intended to cover @LaTeX{}2e, which has been the -standard version of @LaTeX{} for many years. +This document is an unofficial reference manual for @LaTeX{}, a +document preparation system, version as of @value{UPDATED}. It is +intended to cover @LaTeX{}2e, which has been the standard version of +@LaTeX{} for many years. @cindex Knuth, Donald E. @cindex Lamport, Leslie @@ -302,7 +305,7 @@ Miscellaneous other options: mark/do not mark overfull boxes with a big black box; default is @code{final}. @item fleqn Put displayed formulas flush left; default is centered. -@item landscape +@item landscape Selects landscape format; default is portrait. @item leqno Put equation numbers on the left side of equations; default is the right side. @@ -366,7 +369,7 @@ comma, or use multiple @code{\usepackage} commands. @cindex options, global Any options given in the @code{\documentclass} command that are unknown by the selected document class are passed on to the packages loaded with -@code{\usepackage}. +@code{\usepackage}. @node Typefaces @@ -480,7 +483,7 @@ For use in math mode, e.g. inside another type style declaration. `Calligraphic' letters, for use in math mode. @end table -In addition, the command +In addition, the command @code{\mathversion@{bold@}} @findex \mathversion can be used for switching to bold letters and symbols in @@ -720,7 +723,7 @@ These parameters control typesetting in two-column output: @ftable @code @item \columnsep -The distance between columns (35pt by default). +The distance between columns (35pt by default). @item \columnseprule The width of the rule between columns; the default is 0pt, so there is no rule. @@ -1211,7 +1214,7 @@ For details about list spacing, see @ref{itemize}. Synopsis: @example -\begin@{displaymath@} +\begin@{displaymath@} @var{math} \end@{displaymath@} @end example @@ -1367,7 +1370,7 @@ on the page, and also places an equation number in the right margin. @cindex figures, inserting @example -\begin@{figure@}[@var{placement}] +\begin@{figure[*]@}[@var{placement}] @var{figbody} \label@{@var{label@}} \caption[@var{loftitle}]@{@var{text}@} @@ -1378,22 +1381,37 @@ 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. +When typesetting in double-columns, the starred form produces a +full-width figure (across both columns). + The optional argument @code{[placement]} determines where @LaTeX{} will try to place your figure. There are four places where @LaTeX{} can possibly put a float: -@enumerate -@item -@code{h} (Here) - at the position in the text where the figure -environment appears. -@item -@code{t} (Top) - at the top of a text page. -@item -@code{b} (Bottom) - at the bottom of a text page. -@item -@code{p} (Page of floats) - on a separate float page, which is a page +@table @code +@item t +(Top)---at the top of a text page. + +@item b +(Bottom)---at the bottom of a text page. However, @code{b} is not +allowed for full-width floats (@code{figure*}) with double-column +output. To ameliorate this, use the @code{stfloats} or +@code{dblfloatfix} package, but see the discussion at caveats in the +FAQ: @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat}. + +@item h +@cindex @code{float} package +(Here)---at the position in the text where the figure environment +appears. However, this is not allowed by itself, @code{t} is +automatically added. To absolutely force a figure to appear ``here'', +use the @code{float} and use its @code{H} placement letter. (That +package also provides other options.) + +@item p +(Page of floats)---on a separate float page, which is a page containing no text, only floats. -@end enumerate + +@end table The standard report and article classes use the default placement @code{tbp}. @@ -1415,7 +1433,7 @@ the bottom; default @samp{.3}. @item \floatpagefraction The minimum fraction of a float page that must be occupied by floats; -default @samp{.5}. +default @samp{.5}. @item \floatsep Space between floats at the top or bottom of a page; default @@ -1555,9 +1573,9 @@ There must be at least one @code{\item} command within the environment. By default, the marks at each level look like this: @enumerate -@item @bullet{} +@item @bullet{} (bullet) @item @b{-@w{-}} (bold en-dash) -@item * +@item * (asterisk) @iftex @item @math{\cdot} (centered dot) @end iftex @@ -1626,7 +1644,7 @@ to @code{\leftmargin}. @end ftable Parameters affecting vertical spacing between list items (rather -loose, by default). +loose, by default). @ftable @code @item \itemsep @@ -1640,9 +1658,10 @@ are the same as @code{\itemsep}. @item \topsep Vertical space between the first item and the preceding paragraph. -The default is @code{4pt plus2pt minus2pt} for @code{10pt} documents, -@code{6pt plus2pt minus2pt} for @code{11pt}, and @code{9pt plus3pt -minus5pt} for @code{12pt}. +For top-level lists, the default is @code{8pt plus2pt minus4pt} for +@code{10pt} documents, @code{9pt plus3pt minus5pt} for @code{11pt}, +and @code{10pt plus4pt minus6pt} for @code{12pt}. These are reduced +for nested lists. @item \partopsep Extra space added to @code{\topsep} when the list environment starts a @@ -1650,12 +1669,6 @@ paragraph. The default is @code{2pt plus1pt minus1pt} for @code{10pt} documents, @code{3pt plus1pt minus1pt} for @code{11pt}, and @code{3pt plus2pt minus2pt} for @code{12pt}. -@item \topsep -Extra vertical space added before an initial and after a final list -item. Its value is changed with list level and font size changes; for -instance, within a first-level list at @samp{10pt}, it is @samp{4pt -plus2pt minus2pt}. - @end ftable @findex \parskip @r{example} @@ -1735,19 +1748,18 @@ running text. @code{\(...\))} and @code{$...$} are synonyms. @cindex minipage, creating a @example -\begin@{minipage@}[@var{position}]@{@var{width}@} +\begin@{minipage@}[@var{position}][@var{height}][@var{inner-pos}]@{@var{width}@} @var{text} \end@{minipage@} @end example The @code{minipage} environment typesets its body @var{text} in a -block that will not be broken across pages (similar to the -@code{\parbox} command, @pxref{\parbox}). You may use other -paragraph-making environments inside a minipage (unlike @code{\parbox}). +block that will not be broken across pages. This is similar to the +@code{\parbox} command (@pxref{\parbox}), but unlike @code{\parbox}, +other paragraph-making environments can be used inside a minipage. @c (xxref positions) -It takes an optional @var{position} argument for placing @var{text}, -and a mandatory @var{width} argument for specifying the line width. +The arguments are the same as for @code{\parbox} (@pxref{\parbox}). @cindex indentation of paragraphs, in minipage @cindex paragraph indentation, in minipage @@ -1814,15 +1826,18 @@ contained in square brackets.) The optional argument gives the coordinates of the point at the lower-left corner of the picture (thereby determining the origin). For example, if @code{\unitlength} has been set to @code{1mm}, the command + @example - \begin@{picture@}(100,200)(10,20) +\begin@{picture@}(100,200)(10,20) @end example -produces a picture of width 100 millimeters and height 200 + +@noindent 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. +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. The environment's mandatory argument determines the nominal size of the picture. This need bear no relation to how large the picture really is; @@ -1895,16 +1910,20 @@ the normal @code{\makebox} command except that you must specify a The optional argument, @code{[position]}, specifies the quadrant that your text appears in. You may select up to two of the following: -@itemize @bullet -@item -@code{t} - Moves the item to the top of the rectangle -@item -@code{b} - Moves the item to the bottom -@item -@code{l} - Moves the item to the left -@item -@code{r} - Moves the item to the right -@end itemize +@table @code +@item t +Moves the item to the top of the rectangle. + +@item b +Moves the item to the bottom. + +@item l +Moves the item to the left. + +@item r +Moves the item to the right. + +@end table @xref{\makebox}. @@ -2165,7 +2184,7 @@ Unlike the @code{quotation} environment, paragraphs are not indented. @cindex tab stops, using @cindex lining text up in columns using tab stops @cindex alignment via tabbing - + Synopsis: @example @@ -2197,7 +2216,7 @@ Sets a tab stop at the current position. @findex \> Advances to the next tab stop. -@item \< +@item \< Put following text to the left of the local margin (without changing the margin). Can only be used at the start of the line. @@ -2206,7 +2225,7 @@ Moves the left margin of the next and all the following commands one tab stop to the right, beginning tabbed line if necessary. -@item \- +@item \- Moves the left margin of the next and all the following commands one tab stop to the left, beginning tabbed line if necessary. @@ -2292,20 +2311,8 @@ Tables will not be split between two pages. The optional argument @code{[placement]} determines where @LaTeX{} will try to place your table. There are four places where @LaTeX{} can possibly put -a float: - -@itemize @bullet -@item -@code{h}: Here - at the position in the text where the table -environment appears. -@item -@code{t}: Top - at the top of a text page. -@item -@code{b}: Bottom - at the bottom of a text page. -@item -@code{p}: Page of floats - on a separate float page, which is a page -containing no text, only floats. -@end itemize +a float; these are the same as that used with the @code{figure} +environment, and described there (@pxref{figure}). The standard @code{report} and @code{article} classes use the default placement @code{[tbp]}. @@ -2353,48 +2360,54 @@ The mandatory and optional arguments consist of: Specifies the width of the @code{tabular*} environment. There must be rubber space between columns that can stretch to fill out the specified width. + @item pos Specifies the vertical position; default is alignment on the centre of the environment. -@itemize @bullet -@item -@code{t} - align on top row -@item -@code{b} - align on bottom row -@end itemize +@table @code +@item t +align on top row +@item b +align on bottom row +@end table @item cols Specifies the column formatting. It consists of a sequence of the following specifiers, corresponding to the sequence of columns and intercolumn material. -@itemize @bullet +@table @code + +@item l +A column of left-aligned items. + +@item r +A column of right-aligned items. @item -@code{l} - A column of left-aligned items. -@item -@code{r} - A column of right-aligned items. -@item -@code{c} - A column of centred items. -@item -@code{|} - A vertical line the full height and depth of the environment. -@item -@code{@@@{text@}} - This inserts @code{text} in every row. An @@-expression -suppresses the intercolumn space normally inserted between columns; any -desired space between the inserted text and the adjacent items must be -included in text. An @code{\extracolsep@{wd@}} command in an -@@-expression causes an extra space of width @code{wd} to appear to the -left of all subsequent columns, until countermanded by another -@code{\extracolsep} command. Unlike ordinary intercolumn space, this -extra space is not suppressed by an @@-expression. An -@code{\extracolsep} command can be used only in an @@-expression in the -@code{cols} argument. -@item -@code{p@{wd@}} - Produces a column with each item typeset in a parbox of -width @code{wd}, as if it were the argument of a @code{\parbox[t]@{wd@}} -command. However, a @code{\\} may not appear in the item, except in the -following situations: +A column of centred items. + +@item | +A vertical line the full height and depth of the environment. + +@item @@@{@var{text}@} +This inserts @var{text} in every row. An @@-expression suppresses the +intercolumn space normally inserted between columns; any desired space +between the inserted text and the adjacent items must be included in +text. An @code{\extracolsep@{wd@}} command in an @@-expression causes +an extra space of width @code{wd} to appear to the left of all +subsequent columns, until countermanded by another @code{\extracolsep} +command. Unlike ordinary intercolumn space, this extra space is not +suppressed by an @@-expression. An @code{\extracolsep} command can be +used only in an @@-expression in the @code{cols} argument. + +@item p@{@var{wd}@} +Produces a column with each item typeset in a parbox of width +@var{wd}, as if it were the argument of a +@code{\parbox[t]@{@var{wd}@}} command. However, a @code{\\} may not +appear in the item, except in the following situations: + @enumerate @item inside an environment like @code{minipage}, @code{array}, or @code{tabular}. @@ -2405,15 +2418,14 @@ in the scope of a @code{\centering}, @code{\raggedright}, or @code{\raggedleft} declaration. The latter declarations must appear inside braces or an environment when used in a @code{p}-column element. @end enumerate -@item -@code{*@{num@}@{cols@}} - Equivalent to @code{num} copies of -@code{cols}, where @code{num} is any positive integer and @code{cols} is -any list of column-specifiers, which may contain another -@code{*-expression}. -@end itemize +@item *@{@var{num}@}@{@var{cols}@} +Equivalent to @var{num} copies of @var{cols}, where @var{num} is a +positive integer and @var{cols} is any list of column-specifiers, +which may contain another @code{*-expression}. @end table +@end table Parameters that control formatting: @c xx defaults, own node (xref from array)? @@ -2426,7 +2438,7 @@ default is @samp{.4pt}. @item \arraystretch Scaling of spacing between rows in the @code{tabular} and @code{array} -environments; default is @samp{1},for no scaling. +environments; default is @samp{1}, for no scaling. @item \doublerulesep Horizontal distance between the vertical rules produced by @code{||} @@ -2636,7 +2648,7 @@ The standard @var{style} names distributed with Bib@TeX{} are: @table @code @item alpha Sorted alphabetically. Labels are formed from name of author and year of -publication. +publication. @item plain Sorted alphabetically. Labels are numeric. @item unsrt @@ -3094,7 +3106,7 @@ Synopsis: Defines a control sequence @code{\@var{cmd}}, which must not already be defined, to make @var{fontname} be the current font. The file -looked for on the system is named @file{@var{fontname}.tfm}. +looked for on the system is named @file{@var{fontname}.tfm}. This is a low-level command for setting up to use an individual font. More commonly, fonts are defined in families through @file{.fd} files. @@ -3124,7 +3136,7 @@ be preceded by @code{\protect}. See also: @smallexample -@exdent @url{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html} +@exdent @url{http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html} @exdent @url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect} @end smallexample @@ -3483,7 +3495,7 @@ that @LaTeX{} might otherwise have chosen. The declaration @code{\fussy} (which is the default) makes @TeX{} picky about line breaking. This usually avoids too much space between -words, at the cost of an occasional overfull box. +words, at the cost of an occasional overfull box. This command cancels the effect of a previous @code{\sloppy} command (@pxref{\sloppy}. @@ -3715,7 +3727,7 @@ will be placed @itemize @bullet @item in the right margin for one-sided layout; -@item +@item in the outside margin for two-sided layout; @item in the nearest margin for two-column layout. @@ -4614,6 +4626,11 @@ in math. These are different from accents in normal text @cindex acute accent, math Math acute accent: @math{\acute{x}}. +@item \bar +@cindex bar-over accent, math +@cindex macron accent, math +Math bar-over accent: @math{\bar{x}}. + @item \breve @cindex breve accent, math Math breve accent: @math{\breve{x}}. @@ -4712,7 +4729,7 @@ A horizontal ellipsis with the dots raised to the center of the line. @tex As in: `$\cdots$'. @end tex - + @item \ddots A diagonal ellipsis: @math{\ddots}. @@ -4955,7 +4972,7 @@ Custom headers, specified via the @code{\markboth} or the Here are the descriptions of @code{\markboth} and @code{\markright}: @ftable @code -@item \markboth@{@var{left}@}@{@var{right}@} +@item \markboth@{@var{left}@}@{@var{right}@} Sets both the left and the right heading. A ``left-hand heading'' (@var{left}) is generated by the last @code{\markboth} command before the end of the page, while a ``right-hand heading'' (@var{right} is @@ -4964,7 +4981,7 @@ comes on the page if there is one, otherwise by the last one before the page. @item \markright@{@var{right}@} -Sets the right heading, leaving the left heading unchanged. +Sets the right heading, leaving the left heading unchanged. @end ftable @@ -4990,20 +5007,20 @@ more often useful in math mode (@pxref{Spacing in math mode}). @menu Horizontal space -* \hspace:: Fixed horizontal space. +* \hspace:: Fixed horizontal space. * \SPACE:: Normal interword space. * \AT:: Ending a sentence. * \thinspace:: One-sixth of an em. * \/:: Per-character italic correction. -* \hfill:: Stretchable horizontal space. -* \hrulefill:: Stretchable horizontal rule. -* \dotfill:: Stretchable horizontal dots. +* \hfill:: Stretchable horizontal space. +* \hrulefill:: Stretchable horizontal rule. +* \dotfill:: Stretchable horizontal dots. Vertical space * \addvspace:: Add arbitrary vertical space if needed. * \bigskip \medskip \smallskip:: Fixed vertical spaces. -* \vfill:: Infinitely stretchable vertical space. -* \vspace:: Add arbitrary vertical space. +* \vfill:: Infinitely stretchable vertical space. +* \vspace:: Add arbitrary vertical space. @end menu @@ -5286,7 +5303,6 @@ The text inside the environment is saved in the box @code{cmd}, which must have been declared with @code{\newsavebox}. - @node \makebox @section @code{\makebox} @findex \makebox @@ -5619,28 +5635,22 @@ Produces a grave accent over the following, as in @`{o}. In the @item \~ @findex \~ @r{(tilde accent)} @cindex tilde accent -Produces a tilde accent over the following, as in @~{n}. +Produces a tilde accent over the following, as in @~{n}. @item \b @findex \b @r{(bar-under accent)} @cindex bar-under accent -Produces a bar accent under the following, as in @ubaraccent{o}. - -@item \bar -@findex \bar @r{(macron, bar-over accent)} -@cindex bar-over accent -@cindex macron accent -Produces a macron accent over the following, as in @={o}. +Produces a bar accent under the following, as in @ubaraccent{o}. @item \c @findex \c @r{(cedilla accent)} @cindex cedilla accent -Produces a cedilla accent under the following, as in @c{c}. +Produces a cedilla accent under the following, as in @c{c}. @item \d @findex \d @r{(dot-under accent)} @cindex dot-under accent -Produces a dot accent under the following, as in @udotaccent{o}. +Produces a dot accent under the following, as in @udotaccent{o}. @item \H @findex \H @r{(Hungarian umlaut accent)} @@ -5648,27 +5658,27 @@ Produces a dot accent under the following, as in @udotaccent{o}. Produces a long Hungarian umlaut accent over the following, as in @H{o}. @item \i -@findex \i @r{(dotless i)} +@findex \i @r{(dotless i)} @cindex dotless i Produces a dotless i, as in `@dotless{i}'. @item \j -@findex \j @r{(dotless j)} +@findex \j @r{(dotless j)} @cindex dotless j Produces a dotless j, as in `@dotless{j}'. @item \t -@findex \t @r{(tie-after accent)} +@findex \t @r{(tie-after accent)} @cindex tie-after accent Produces a tie-after accent, as in `@tieaccent{oo}'. @item \u -@findex \u @r{(breve accent)} +@findex \u @r{(breve accent)} @cindex breve accent Produces a breve accent, as in `@u{o}'. @item \v -@findex \v @r{(breve accent)} +@findex \v @r{(breve accent)} @cindex hacek accent @cindex check accent Produces a h@'a@v{c}ek (check) accent, as in `@v{o}'. @@ -5882,7 +5892,7 @@ table of contents, write a @code{\newpage} command after the @findex \listoffigures @findex \listoftables -The analagous commands @code{\listoffigures} and @code{\listoftables} +The analogous commands @code{\listoffigures} and @code{\listoftables} produce a list of figures and a list of tables, respectively. Everything works exactly the same as for the table of contents. @@ -5901,8 +5911,8 @@ The command @code{\nofiles} overrides these commands, and @findex \addcontentsline@{@var{ext}@}@{@var{unit}@}@{@var{text}@} @cindex table of contents entry, manually adding -The @code{\addcontentsline} command adds an entry to the specified list -or table where: +The @code{\addcontentsline}@{@var{ext}@}@{@var{unit}@}@{@var{text}@} +command adds an entry to the specified list or table where: @table @var @item ext @@ -5939,9 +5949,9 @@ command @code{\contentsline@{@var{unit}@}@{@var{name}@}}. @subsection \addtocontents @findex \addtocontents@{@var{ext}@}@{@var{text}@} -The @code{\addtocontents} command adds text (or formatting commands) -directly to the @file{.}@var{ext} file that generates the table of -contents or lists of figures or tables. +The @code{\addtocontents}@{@var{ext}@}@{@var{text}@} command adds text +(or formatting commands) directly to the @file{.@var{ext}} file that +generates the table of contents or lists of figures or tables. @table @var @item ext @@ -5980,11 +5990,12 @@ glossaries. @cindex indexes @findex \makeindex -The command @code{\makeindex} enables creating indexes. +The command @code{\makeindex} enables creating indexes. Put this in +the preamble. @findex \index @cindex @file{.idx} file -The command @code{\index@{@var{text}@}} writes a glossary entry for +The command @code{\index@{@var{text}@}} writes an index entry for @var{text} to an auxiliary file with the @file{.idx} extension. @findex \indexentry @@ -5992,17 +6003,47 @@ Specifically, what gets written is the command @code{\indexentry@{@var{text}@}@{@var{pageno}@}}, where @var{pageno} is the current @code{\thepage} value. -The rubber length @code{\indexspace} is inserted before each new -letter in the index; its default value is @samp{10pt plus5pt -minus3pt}. +@cindex `see' and `see also' index entries +To generate a index entry for `bar' that says `See foo', use a +vertical bar: @code{\index@{bar|see@{foo@}@}}. Use @code{seealso} +instead of @code{see} to make a `See also' entry. + +@findex \seename +@findex \alsoname +The text `See' is defined by the macro @code{\seename}, and `See also' +by the macro @code{\alsoname}. These can be redefined for other +languages. @cindex @command{makeindex} program @cindex @command{xindy} program @cindex @file{.ind} file +The generated @file{.idx} file is then sorted with an external +command, usually either @command{makeindex} +(@url{http://mirror.ctan.org/indexing/makeindex}) or (the +multi-lingual) @command{xindy} (@url{http://xindy.sourceforge.net}). +This results in a @file{.ind} file, which can then be read to typeset +the index. + +@findex printindex +@cindex @code{makeidx} package +The index is usually generated with the @code{\printindex} command. +This is defined in the @code{makeidx} package, so +@code{\usepackage@{makeidx@}} needs to be in the preamble. + +@findex indexspace +The rubber length @code{\indexspace} is inserted before each new +letter in the printed index; its default value is @samp{10pt plus5pt +minus3pt}. + +@cindex @code{showidx} package +The @code{showidx} 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. -The @file{.idx} file can then be sorted with an external command, -typically @command{makeindex} or @command{xindy}, resulting in a -@file{.ind} file, which can then be used to typeset the index. +@cindex @code{multind} package +The @code{multind} package supports multiple indexes. See also the +@TeX{} FAQ entry on this topic, +@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind}. @node Letters @@ -6029,7 +6070,7 @@ Each letter is a @code{letter} environment, whose argument is the name and address of the recipient. For example, you might have: @example - \begin@{letter@}@{Mr. Joe Smith\\ 2345 Princess St. + \begin@{letter@}@{Mr. Joe Smith\\ 2345 Princess St. \\ Edinburgh, EH1 1AA@} ... \end@{letter@} @@ -6303,7 +6344,7 @@ will process @file{foo.tex} without pausing after every error. @findex \stop If @LaTeX{} stops in the middle of the document and gives you a @samp{*} prompt, it is waiting for input. You can type @code{\stop} -(and return) and it will prematurely end the document. +(and return) and it will prematurely end the document. |