diff options
author | Karl Berry <karl@freefriends.org> | 2012-05-13 22:58:34 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-05-13 22:58:34 +0000 |
commit | a74c16d06af04f22a53debd1a1ef211416c3a6f6 (patch) | |
tree | 0cbb1892377354b7b04acd3a18df9581343b6152 /Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi | |
parent | 54881f89f5ade7bdb55ea7c8d36a62d3860856b4 (diff) |
latex2e-help-texinfo (11may12)
git-svn-id: svn://tug.org/texlive/trunk@26333 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi')
-rw-r--r-- | Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi | 230 |
1 files changed, 155 insertions, 75 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 df7973788ba..f962885638c 100644 --- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi +++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.texi @@ -1,24 +1,23 @@ \input texinfo -@c $Id: latex2e.texi 261 2011-05-12 17:45:37Z karl $ +@c $Id: latex2e.texi 263 2012-04-25 16:43:05Z karl $ @comment %**start of header (This is for running Texinfo on a region.) @setfilename latex2e.info -@set UPDATED May 2011 +@set UPDATED May 2012 @settitle @LaTeX{}2e reference manual (@value{UPDATED}) @comment %**end of header (This is for running Texinfo on a region.) -@c xx latex 2.09 commands should all be present now, +@c latex 2.09 commands should all be present now, @c xx but latex2e stuff is missing. @c -@c xx mention \mathring -@c xx mention usrguide -@c xx mention ! float placement, p.15 of usrguide -@c xx merge http://ctan.org/tex-archive/info/latex-info/ -@c xx merged permuted-index +@c xx mention \oldstylenums (comes from where?) +@c xx mention \topnumber, \bottomnumber, \totalnumber @c -@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. +@c xx merge http://ctan.org/tex-archive/info/latex-info/ (alt-latex-info) +@c xx merge permuted-index +@c +@c xx The typeset source2e has an index with all kernel +@c xx commands, though some are internal and shouldn't be included. +@c xx classes.dtx et al. define additional commands. @c @c xx packages -- required, additional, useful; oberdiek ... @c xx fonts -- latexsys @@ -27,8 +26,8 @@ This document is an unofficial reference manual for @LaTeX{}, a document preparation system, version 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 +This manual was originally translated from @file{LATEX.HLP} v1.0a in +the VMS Help Library. The pre-translation version was written by George@tie{}D. Greenwade of Sam Houston State University. The @LaTeX{}@tie{}2.09 version was written by Stephen Gilmore. The @LaTeX{}2e version was adapted from this by Torsten Martinsen. Karl @@ -39,7 +38,7 @@ and C.@tie{}Biemesderfer (published by the @TeX{} Users Group as @cite{@TeX{}niques} number 10), as reference material (no text was directly copied). -Copyright @copyright{} 2007, 2008, 2009, 2010, 2011 Karl Berry.@* +Copyright @copyright{} 2007, 2008, 2009, 2010, 2011, 2012 Karl Berry.@* Copyright @copyright{} 1988, 1994, 2007 Stephen Gilmore.@* Copyright @copyright{} 1994, 1995, 1996 Torsten Martinsen. @@ -128,7 +127,7 @@ intended to cover @LaTeX{}2e, which has been the standard version of @node About this document -@chapter Overview of @LaTeX{} +@chapter About this document @cindex Knuth, Donald E. @cindex Lamport, Leslie @@ -153,6 +152,24 @@ The home page for this document is current output in various formats, sources, mailing lists, and other infrastructure. +Of course, there are many, many other sources of information about +@LaTeX{}. Here are a few: + +@table @url +@item http://www.ctan.org/pkg/latex-doc-ptr +Two pages of recommended references to @LaTeX{} documentation. + +@item http://www.ctan.org/pkg/first-latex-doc +Writing your first document, with a bit of both text and math. + +@item http://www.ctan.org/pkg/usrguide +The guide for document authors maintained as part of @LaTeX{}; there +are several others. + +@item http://tug.org/begin.html +Introduction to the @TeX{} system, including @LaTeX{}. +@end table + @node Overview @chapter Overview of @LaTeX{} @@ -455,18 +472,20 @@ and a style. The @LaTeX{} commands for doing this are described here. The following type style commands are supported by @LaTeX{}. -These commands are used like @code{\textit@{italic text@}}. The -corresponding command in parenthesis is the ``declaration form'', which -takes no arguments. The scope of the declaration form lasts until the -next type style command or the end of the current group. +This first group of commands is typically used like +@code{\textit@{italic text@}}. The corresponding command in +parenthesis is the ``declaration form'', which takes no arguments. The +scope of the declaration form lasts until the next type style command +or the end of the current group. The declaration forms are cumulative; i.e., you can say either @code{\sffamily\bfseries} or @code{\bfseries\sffamily} to get bold sans serif. -You can also use the environment form of the declaration forms; for instance, -@code{\begin@{ttfamily@}...\end@{ttfamily@}}. +You can alternatively use an environment form of the declarations; for +instance, @code{\begin@{ttfamily@}...\end@{ttfamily@}}. +These commands automatically supply an italic correction if the @table @code @item \textrm (\rmfamily) @findex \textrm @@ -1412,7 +1431,19 @@ letters: @findex eqnarray @r{environment} @cindex equations, aligning -@cindex aligning Equations +@cindex aligning equations + +@cindex align @r{environment, from @code{amsmath}} +@cindex amsmath @r{package, replacing @code{eqnarray}} +@cindex Madsen, Lars +First, a caveat: the @code{eqnarray} environment has some infelicities +which cannot be overcome; the article ``Avoid eqnarray!''@: by Lars +Madsen describes them in detail +(@url{http://tug.org/TUGboat/tb33-1/tb103madsen.pdf}). The bottom +line is that it is better to use the @code{align} environment (and +others) from the @code{amsmath} package. + +Nevertheless, here is a description of @code{eqnarray}: @example \begin@{eqnarray@} @r{(or @code{eqnarray*})} @@ -1487,6 +1518,8 @@ Figures will not be split between two pages. When typesetting in double-columns, the starred form produces a full-width figure (across both columns). +@cindex placement of floats +@cindex specifier, float placement 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: @@ -1505,22 +1538,34 @@ 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.) +appears. However, this is not allowed by itself; @code{t} is +automatically added. + +@cindex here, putting floats +@cindex @code{float} package +To absolutely force a figure to appear ``here'', you can +@code{\usepackage@{float@}} and use the @code{H} specifier which it +defines. For further discussion, see the FAQ entry at +@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=figurehere}. @item p (Page of floats)---on a separate float page, which is a page containing no text, only floats. +@item ! +Used in addition to one of the above; for this float only, @LaTeX{} +ignores the restrictions on both the number of floats that can appear +and the relative amounts of float and non-float text on the page. +The @code{!} specifier does @emph{not} mean ``put the float here''; +see above. + @end table The standard report and article classes use the default placement @code{tbp}. -The body of the figure is made up of whatever text, @LaTeX{} commands, etc. -you wish. +The body of the figure is made up of whatever text, @LaTeX{} commands, +etc.@: you wish. @findex \caption The @code{\caption} command specifies caption @var{text} for the @@ -1528,7 +1573,9 @@ figure. The caption is numbered by default. If @var{loftitle} is present, it is used in the list of figures instead of @var{text} (@pxref{Tables of contents}). -@c xx float-placement, float-caption sections? +Parameters relating to fractions of pages occupied by float and +non-float text: + @ftable @code @findex \bottomfraction The maximum fraction of the page allowed to be occuped by floats at @@ -1538,6 +1585,19 @@ the bottom; default @samp{.3}. The minimum fraction of a float page that must be occupied by floats; default @samp{.5}. +@item \textfraction +Minimum fraction of a page that must be text; if floats take up too +much space to preserve this much text, floats will be moved to a +different page. The default is @samp{.2}. + +@item \topfraction +Maximum fraction at the top of a page that may be occupied before +floats; default @samp{.7}. +@end ftable + +Parameters relating to vertical space around floats: + +@ftable @code @item \floatsep Space between floats at the top or bottom of a page; default @samp{12pt plus2pt minus2pt}. @@ -1550,18 +1610,26 @@ Space above and below a float in the middle of the main text; default @item \textfloatsep Space between the last (first) float at the top (bottom) of a page; default @samp{20pt plus2pt minus4pt}. +@end ftable -@item \textfraction -Minimum fraction of a page that must be text; if floats take up too -much space to preserve this much text, floats will be moved to a -different page. The default is @samp{.2}. +Parameters relating to the number of floats on a page: -@item \topfraction -Maximum fraction at the top of a page that may be occupied before -floats; default is @samp{.7}. +@ftable @code +@item \bottomnumber +Maximum number of floats that can appear at the bottom of a text page; +default 1. +@item \topnumber +Maximum number of floats that can appear at the top of a text page; +default 2. + +@item \totalnumber +Maximum number of floats that can appear on a text page; default 3. @end ftable +The principal @TeX{} FAQ entry relating to floats: +@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=floats}. + @node flushleft @section @code{flushleft} @@ -2288,7 +2356,7 @@ Unlike the @code{quotation} environment, paragraphs are not indented. @findex tabbing @r{environment} @cindex tab stops, using -@cindex lining text up in columns using tab stops +@cindex lining text up using tab stops @cindex alignment via tabbing Synopsis: @@ -2442,7 +2510,8 @@ column 1 entry & column 2 entry ... & column n entry \\ \end@{tabular@} @end example - or +@noindent +or @example \begin@{tabular*@}@{width@}[pos]@{cols@} @@ -2474,6 +2543,7 @@ the environment. @table @code @item t align on top row + @item b align on bottom row @end table @@ -2484,7 +2554,6 @@ following specifiers, corresponding to the sequence of columns and intercolumn material. @table @code - @item l A column of left-aligned items. @@ -2500,13 +2569,20 @@ 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 -@var{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. +before the adjacent item must be included in @var{text}. + +To insert commands that are automatically executed before a given +column, you have to load the @code{array} package and use the +@code{>@{...@}} specifier. +@c xx should fully explain array, tabularx, and all other base packages... + +@findex \extracolsep +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 @@ -2555,7 +2631,8 @@ Half the width of the space between columns; default is @samp{6pt}. @end ftable -These commands can be used inside a @code{tabular} environment: +The following commands can be used inside a @code{tabular} +environment: @menu * \multicolumn:: Make an item spanning several columns. @@ -3136,8 +3213,8 @@ Synopses: @end example By default, the @code{\pagebreak} (@code{\nopagebreak}) command forces -(prevents) a page break at the current position. For -@code{\linebreak}, the vertical space on the page is stretched out +(prevents) a page break at the current position. With +@code{\pagebreak}, the vertical space on the page is stretched out where possible so that it extends to the normal bottom margin. With the optional argument @var{priority}, you can convert the @@ -3753,7 +3830,6 @@ The @code{\settowidth} command sets the value of the command @var{\len} to the width of the @var{text} argument. - @node Predefined lengths @section Predefined lengths @cindex lengths, predefined @@ -3772,8 +3848,8 @@ to the width of the @var{text} argument. @findex \totalheight These length parameters can be used in the arguments of the box-making -commands (@pxref{Boxes}). They specify the natural width etc. of the -text in the box. @code{\totalheight} equals @code{\height} + +commands (@pxref{Boxes}). They specify the natural width, etc., of +the text in the box. @code{\totalheight} equals @code{\height} + @code{\depth}. To make a box with the text stretched to double the natural size, e.g., say @@ -4801,6 +4877,10 @@ Math dotless i. @cindex dotless j, math Math dotless j. +@item \mathring +@cindex ring accent, math +Math ring accent: @ringaccent{x}. @c don't bother implementing in texinfo + @item \tilde @cindex tilde accent, math Math tilde accent: @math{\tilde{x}}. @@ -5221,16 +5301,16 @@ a capital letter. Here are side-by-side examples with and without @code{\@@}: @example -@dots{} in C\@@. Pascal, though @dots{} -@dots{} in C. Pascal, though @dots{} +@dots{} in C\@@. Pascal, though @dots{} +@dots{} in C. Pascal, though @dots{} @end example @noindent produces @c Texinfo does it differently, but the result is the same. @quotation -@dots{} in C@. Pascal, though @dots{} -@dots{} in C. Pascal, though @dots{} +@dots{} in C@. Pascal, though @dots{} +@dots{} in C. Pascal, though @dots{} @end quotation @@ -6797,8 +6877,8 @@ If @LaTeX{} stops in the middle of the document and gives you a @cindex document templates Although not reference material, perhaps these document templates will -be useful. Additional templates are collected at -@url{http://www.howtotex.com/templates}. +be useful. Additional template resources are listed +@url{http://tug.org/interest.html#latextemplates}. @menu * book template:: @@ -6872,13 +6952,13 @@ The @code{beamer} class creates slides presentations. \usepackage{graphicx} \usepackage{ifpdf} \ifpdf - \usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, - urlcolor=black]{hyperref} +\usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black, + urlcolor=black]{hyperref} \else - \usepackage{url} +\usepackage{url} \fi -\title{Example \TUB\ Article} +\title{Example \TUB\ article} % repeat info for each author. \author{First Last} @@ -6886,12 +6966,12 @@ The @code{beamer} class creates slides presentations. \netaddress{user (at) example dot org} \personalURL{http://example.org/~user/} -\maketitle - \begin{document} +\maketitle + \begin{abstract} -This is an example article for a regular \TUB{} issue. +This is an example article for \TUB{}. \end{abstract} \section{Introduction} @@ -6903,22 +6983,23 @@ We recommend the graphicx package for image inclusions, and the hyperref package for active url's (in the \acro{PDF} output). Nowadays \TUB\ is produced using \acro{PDF} files exclusively. -The \texttt{ltug*} classes provide these abbreviations, among many others: +The \texttt{ltugboat} class provides these abbreviations and many more: -{\small -\begin{verbatim} +% verbatim blocks are often better in \small +\begin{verbatim}[\small] \AllTeX \AMS \AmS \AmSLaTeX \AmSTeX \aw \AW \BibTeX \CTAN \DTD \HTML -\ISBN \ISSN \JTeX \LaTeXe -\Mc \mf \MFB \mtex \PCTeX \pcTeX \Pas +\ISBN \ISSN \LaTeXe +\Mc \mf \MFB \mtex \PCTeX \pcTeX \PiC \PiCTeX \plain \POBox \PS -\SC \SGML \SliTeX \TANGLE \TB \TP \TUB \TUG \tug +\SC \SGML \SliTeX \TANGLE \TB \TP +\TUB \TUG \tug \UG \UNIX \VAX \XeT \WEB \WEAVE \Dash \dash \vellipsis \bull \cents \Dag \careof \thinskip -\acro{FRED} -> {\small fred} % please use! +\acro{FRED} -> {\small[er] fred} % please use! \cs{fred} -> \fred \env{fred} -> \begin{fred} \meta{fred} -> <fred> @@ -6926,14 +7007,13 @@ The \texttt{ltug*} classes provide these abbreviations, among many others: \sfrac{3/4} -> 3/4 \booktitle{Book of Fred} \end{verbatim} -} For more information, see the ltubguid document at: \url{http://mirror.ctan.org/macros/latex/contrib/tugboat} +(we recommend using \verb|mirror.ctan.org| for \CTAN\ references). Email \verb|tugboat@tug.org| if problems or questions. - \bibliographystyle{plain} % we recommend the plain bibliography style \nocite{book-minimal} % just making the bibliography non-empty \bibliography{xampl} % xampl.bib comes with BibTeX |