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.xml187
1 files changed, 124 insertions, 63 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 f2d62157bbb..fe4c53219ce 100644
--- a/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml
+++ b/Master/texmf-dist/doc/latex/latex2e-help-texinfo/latex2e.xml
@@ -3,8 +3,8 @@
<texinfo xml:lang="en">
<setfilename>latex2e.xml</setfilename>
-<setvalue name="UPDATED">July 2010</setvalue>
-<settitle>&latex;2e reference manual (July 2010)</settitle>
+<setvalue name="UPDATED">May 2011</setvalue>
+<settitle>&latex;2e reference manual (May 2011)</settitle>
<!-- %**end of header (This is for running Texinfo on a region.) -->
<!-- xx latex 2.09 commands should all be present now, -->
@@ -14,6 +14,7 @@
<!-- xx mention usrguide -->
<!-- xx mention ! float placement, p.15 of usrguide -->
<!-- xx merge http://ctan.org/tex-archive/info/latex-info/ -->
+<!-- xx merged permuted-index -->
<!-- -->
<!-- xx The typeset source2e will have an index with all kernel -->
<!-- xx commands, which would be a good start. classes.dtx et al. -->
@@ -24,7 +25,7 @@
<!-- xx fonts - latexsys -->
<para>This document is an unofficial reference manual for &latex;, a
-document preparation system, version of July 2010.
+document preparation system, version of May 2011.
</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
@@ -35,10 +36,10 @@ 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.&nbsp;Botway
and C.&nbsp;Biemesderfer (published by the &tex; Users Group as
-<cite>&tex;niques</cite> number 10), as reference material (text was not
+<cite>&tex;niques</cite> number 10), as reference material (no text was
directly copied).
</para>
-<para>Copyright &copyright; 2007, 2008, 2009, 2010 Karl Berry.&linebreak;
+<para>Copyright &copyright; 2007, 2008, 2009, 2010, 2011 Karl Berry.&linebreak;
Copyright &copyright; 1988, 1994, 2007 Stephen Gilmore.&linebreak;
Copyright &copyright; 1994, 1995, 1996 Torsten Martinsen.
</para>
@@ -68,11 +69,11 @@ into another language, under the above conditions for modified versions.
<titlepage>
<booktitle>&latex;: Structured documents for &tex;</booktitle>
<booksubtitle>unofficial &latex; reference manual</booksubtitle>
-<booksubtitle>July 2010</booksubtitle>
-<author></author>
+<booksubtitle>May 2011</booksubtitle>
+<author><uref><urefurl>http://home.gna.org/latexrefman</urefurl></uref></author>
<page></page>
<vskip></vskip><para>This document is an unofficial reference manual for &latex;, a
-document preparation system, version of July 2010.
+document preparation system, version of May 2011.
</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
@@ -83,10 +84,10 @@ 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.&nbsp;Botway
and C.&nbsp;Biemesderfer (published by the &tex; Users Group as
-<cite>&tex;niques</cite> number 10), as reference material (text was not
+<cite>&tex;niques</cite> number 10), as reference material (no text was
directly copied).
</para>
-<para>Copyright &copyright; 2007, 2008, 2009, 2010 Karl Berry.&linebreak;
+<para>Copyright &copyright; 2007, 2008, 2009, 2010, 2011 Karl Berry.&linebreak;
Copyright &copyright; 1988, 1994, 2007 Stephen Gilmore.&linebreak;
Copyright &copyright; 1994, 1995, 1996 Torsten Martinsen.
</para>
@@ -109,27 +110,24 @@ into another language, under the above conditions for modified versions.
<node>
<nodename>Top</nodename>
-<nodenext>Overview</nodenext>
+<nodenext>About this document</nodenext>
<nodeup>(dir)</nodeup>
</node>
<top>
<title>&latex;2e</title>
<para>This document is an unofficial reference manual for &latex;, a
-document preparation system, version as of July 2010. It is
+document preparation system, version as of May 2011. 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&nbsp;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>
+<menunode>About this document</menunode>
+<menutitle>About this document</menutitle>
+<menucomment> Bug reporting, etc.
+</menucomment>
+</menuentry><menuentry>
<menunode>Overview</menunode>
<menutitle>Overview</menutitle>
<menucomment> What is &latex;?
@@ -279,63 +277,103 @@ maintainers.
</top>
<node>
+<nodename>About this document</nodename>
+<nodenext>Overview</nodenext>
+<nodeprev>Top</nodeprev>
+<nodeup>Top</nodeup>
+</node>
+<chapter>
+<title>Overview of &latex;</title>
+
+<para><indexterm index="cp">Knuth, Donald E.</indexterm><indexterm index="cp">Lamport, Leslie</indexterm><indexterm index="cp">&latex; Project team</indexterm>The &latex; document preparation system is implemented as a macro
+package for Donald&nbsp;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 from their web site.
+</para>
+<para><indexterm index="cp">bug reporting</indexterm><indexterm index="cp">reporting bugs</indexterm><indexterm index="fn"><email><emailaddress>latexrefman-discuss@gna.org</emailaddress></email> <r>email address</r></indexterm>The present document is completely unofficial and has not been
+reviewed by the &latex; maintainers. Do not send bug reports or
+anything else about this document to them. Instead, please send all
+comments to <email><emailaddress>latexrefman-discuss@gna.org</emailaddress></email>.
+</para>
+<para>The home page for this document is
+<uref><urefurl>http://home.gna.org/latexrefman</urefurl></uref>. That page has links to the
+current output in various formats, sources, mailing lists, and other
+infrastructure.
+</para>
+
+</chapter>
+<node>
<nodename>Overview</nodename>
<nodenext>Starting &amp; ending</nodenext>
-<nodeprev>Top</nodeprev>
+<nodeprev>About this document</nodeprev>
<nodeup>Top</nodeup>
</node>
<chapter>
<title>Overview of &latex;</title>
-<para><indexterm index="cp">overview of &latex;</indexterm><indexterm index="cp">&latex; overview</indexterm></para>
-<para>The &latex; command typesets a file of text using the &tex; program
-and the &latex; &ldquo;macro package&rdquo; for &tex;. To be more specific,
-it processes an input file containing the text of a document with
-interspersed commands that describe how the text should be formatted.
-It produces at least three files as output:
+<para>What is &latex;?
</para>
-<enumerate first="1"><item>
-<para>A main output file, which is one of:
+<para><indexterm index="cp">overview of &latex;</indexterm><indexterm index="cp">basics of &latex;</indexterm><indexterm index="cp">&latex; overview</indexterm>&latex; typesets a file of text using the &tex; program and the
+&latex; &ldquo;macro package&rdquo; for &tex;. That is, it processes an input
+file containing the text of a document with interspersed commands that
+describe how the text should be formatted. &latex; files are plain
+text that can be written in any reasonable editor. It produces at
+least three files as output:
</para>
<enumerate first="1"><item>
-<para>If invoked as <command>latex</command>, a &ldquo;Device Independent&rdquo; (<file>.dvi</file>)
-file. This contains commands that can be translated into commands for
-a variety of output devices. You can view such <file>.dvi</file> output of
-&latex; by using a program such as <command>xdvi</command> (display directly)
-or <command>dvips</command> (convert to PostScript).
-</para>
-</item>
-<item>
-<para>If invoked as <command>pdflatex</command>, a &ldquo;Portable Document Format&rdquo;
+<para>The main output file, which is one of:
+</para>
+<table><tableitem><tableterm><code>.dvi</code></tableterm>
+<item><para><indexterm index="fn">.dvi <r>file</r></indexterm><indexterm index="fn">latex <r>command</r></indexterm>If invoked as <command>latex</command>, a &ldquo;Device Independent&rdquo; (<file>.dvi</file>)
+file is produced. This contains commands that can be translated into
+commands for virtually any output device. You can view such
+<file>.dvi</file> output of &latex; by using a program such as
+<command>xdvi</command> (display directly), <command>dvips</command> (convert to
+PostScript), or <command>dvipdfmx</command> (convert to PDF).
+</para>
+</item></tableitem><tableitem><tableterm><code>.pdf</code></tableterm>
+<item><para><indexterm index="fn">.pdf <r>file</r></indexterm><indexterm index="cp">pdf&tex;</indexterm><indexterm index="fn">pdflatex <r>command</r></indexterm>If invoked as <command>pdflatex</command>, a &ldquo;Portable Document Format&rdquo;
(<file>.pdf</file>) file. Typically, this is a self-contained file, with
all fonts and images embedded. This can be very useful, but it does
make the output much larger than the <file>.dvi</file> produced from the
same document.
-</para></item>
-</enumerate>
+</para>
+<para><indexterm index="fn">lualatex <r>command</r></indexterm><indexterm index="cp">Lua&tex;</indexterm>If invoked as <command>lualatex</command>, a <file>.pdf</file> file is created using
+the Lua&tex; engine (<uref><urefurl>http://luatex.org</urefurl></uref>).
+</para>
+<para><indexterm index="fn">xelatex <r>command</r></indexterm><indexterm index="cp">Xe&tex;</indexterm>If invoked as <command>xelatex</command>, a <file>.pdf</file> file is created using
+the Xe&tex; engine (<uref><urefurl>http://tug.org/xetex</urefurl></uref>).
+</para>
+</item></tableitem></table>
-<para>There are other less-common variants of &latex; (and &tex;) as well,
-which can produce HTML, XML, and other things.
+<para>Many other less-common variants of &latex; (and &tex;) exist, which
+can produce HTML, XML, and other things.
</para>
</item>
<item>
-<para>A &ldquo;transcript&rdquo; or <file>.log</file> file that contains summary information and
-diagnostic messages for any errors discovered in the input file.
+<para><indexterm index="cp">transcript file</indexterm><indexterm index="cp">log file</indexterm><indexterm index="fn">.log <r>file</r></indexterm>The &ldquo;transcript&rdquo; or <file>.log</file> file that contains summary
+information and diagnostic messages for any errors discovered in the
+input file.
</para>
</item>
<item>
-<para>An &ldquo;auxiliary&rdquo; or <file>.aux</file> file. This is used by &latex; itself, for
-things such as sectioning.
+<para><indexterm index="cp">auxiliary file</indexterm><indexterm index="fn">.aux <r>file</r></indexterm>An &ldquo;auxiliary&rdquo; or <file>.aux</file> file. This is used by &latex; itself,
+for things such as cross-references.
</para></item>
</enumerate>
-<para>A &latex; command begins with the command name, which consists of a
-<code>\</code> followed by either (a)&nbsp;a string of letters or (b)&nbsp;a
-single non-letter. Arguments contained in square brackets, <code>[]</code>,
-are optional while arguments contained in braces, <code>{}</code>, are
+<para>An open-ended list of other files might be created. We won't try to
+list them all. Xxx components?
+</para>
+<para><indexterm index="fn">\ <r>character starting commands</r></indexterm><indexterm index="fn">[...] <r>for optional arguments</r></indexterm><indexterm index="fn">{...} <r>for required arguments</r></indexterm>In the &latex; input file, a command name starts with a <code>\</code>,
+followed by either (a)&nbsp;a string of letters or (b)&nbsp;a single
+non-letter. Arguments contained in square brackets, <code>[]</code>, are
+optional while arguments contained in braces, <code>{}</code>, are
required.
</para>
-<para>&latex; is case sensitive. Enter all commands in lower case unless
+<para><indexterm index="cp">case sensitivity of &latex;</indexterm>&latex; is case sensitive. Enter all commands in lower case unless
explicitly directed to do otherwise.
</para>
@@ -461,7 +499,7 @@ the distance on even (odd) numbered pages between the left side of the
page and the text's left margin. The defaults vary with the paper
size and whether one- or two-side layout is selected. For one-sided
printing the text is centered, for two-sided, <code>\oddsidemargin</code> is
-40% of the difference between <code>\paperwidth</code> and <code>\textwidth</code>
+40% of the difference between <code>\paperwidth</code> and <code>\textwidth</code>,
with <code>\evensidemargin</code> the remainder.
</para>
</item></tableitem><tableitem><tableterm><code>openright</code></tableterm>
@@ -945,8 +983,11 @@ the page footer. Default is <samp>30pt</samp>, except in the <code>book</code>
class, where it varies with the type size.
</para>
</item></tableitem><tableitem><tableterm><indexterm index="fn">\linewidth</indexterm><code>\linewidth</code></tableterm>
-<item><para>Width of the current line; the default varies with the font size,
-paper width, two-column mode, etc. For an <code>article</code> document in
+<item><para>Width of the current line, decreased for each nested <code>list</code>
+(see <xref><xrefnodename>list</xrefnodename></xref>). Specifically, it is smaller than <code>\textwidth</code> by
+the sum of <code>\leftmargin</code> and <code>\rightmargin</code>
+(see <xref><xrefnodename>itemize</xrefnodename></xref>). The default varies with the font size, paper
+width, two-column mode, etc. For an <code>article</code> document in
<samp>10pt</samp>, it's set to <samp>345pt</samp>; in two-column mode, that
becomes <samp>229.5pt</samp>.
</para>
@@ -959,11 +1000,29 @@ For <samp>11pt</samp>, it's <samp>38\baselineskip</samp> and for <samp>12pt</sam
<samp>36\baselineskip</samp>.
</para>
</item></tableitem><tableitem><tableterm><indexterm index="fn">\textwidth</indexterm><code>\textwidth</code></tableterm>
-<item><para>The normal horizontal width of the page body; the default varies as
-usual. For an <code>article</code> or <code>report</code> document, it's
+<item><para>The full horizontal width of the entire page body; the default varies
+as usual. For an <code>article</code> or <code>report</code> document, it's
<samp>345pt</samp> at <samp>10pt</samp>, <samp>360pt</samp> at <samp>11pt</samp>, and
<samp>390pt</samp> at <samp>12pt</samp>. For a <code>book</code> document, it's
-<samp>4.5in</samp> at <samp>10pt</samp>, and <samp>5in</samp> at <samp>11pt</samp> or <samp>12pt</samp>.
+<samp>4.5in</samp> at <samp>10pt</samp>, and <samp>5in</samp> at <samp>11pt</samp> or
+<samp>12pt</samp>.
+</para>
+<para>In multi-column output, <code>\textwidth</code> remains the width of the
+entire page body, while <code>\columnwidth</code> is the width of one column
+(see <xref><xrefnodename>\twocolumn</xrefnodename></xref>).
+</para>
+<para>In lists (see <xref><xrefnodename>list</xrefnodename></xref>), <code>\textwidth</code> remains the width of the
+entire page body (and <code>\columnwidth</code> the width of the entire
+column), while <code>\linewidth</code> may decrease for nested lists.
+</para>
+<para>Inside a minipage (see <xref><xrefnodename>minipage</xrefnodename></xref>) or <code>\parbox</code>
+(see <xref><xrefnodename>\parbox</xrefnodename></xref>), all the width-related parameters are set to the
+specified width, and revert to their normal values at the end of the
+<code>minipage</code> or <code>\parbox</code>.
+</para>
+<para><indexterm index="fn">\hsize</indexterm>For completeness: <code>\hsize</code> is the &tex; primitive parameter used
+when text is broken into lines. It should not be used in normal
+&latex; documents.
</para>
</item></tableitem><tableitem><tableterm><indexterm index="fn">\topmargin</indexterm><code>\topmargin</code></tableterm>
<item><para>Space between the top of the &tex; page (one inch from the top of the
@@ -1999,6 +2058,9 @@ label. It can and usually does contain other &latex; commands.
spacing parameters for the list. This argument will most often be
empty, i.e., <code>{}</code>, which leaves the default spacing.
</para>
+<para>The width used for typesetting the list items is specified by
+<code>\linewidth</code> (see <xref><xrefnodename>Page layout parameters</xrefnodename></xref>).
+</para>
</section>
<node>
@@ -3856,6 +3918,7 @@ text of the <var>n</var>th argument.
</para>
</item></tableitem></table>
+<!-- xx \providecommand, * form (non-\long) -->
</section>
<node>
@@ -6669,9 +6732,6 @@ has the ascender height.
<tableterm><indexterm index="fn">\textordmasculine</indexterm><code>\textordmasculine</code></tableterm>
<item><para><indexterm index="cp">feminine ordinal symbol</indexterm><indexterm index="cp">masculine ordinal symbol</indexterm><indexterm index="cp">ordinals, feminine and masculine</indexterm><indexterm index="cp">Spanish ordinals, feminine and masculine</indexterm>Feminine and masculine ordinal symbols: &ordf;, &ordm;.
</para>
-</item></tableitem><tableitem><tableterm><indexterm index="fn">\textordfeminine</indexterm><code>\textordfeminine</code></tableterm>
-<item><para><indexterm index="cp">feminine ordinal symbol</indexterm>Feminine ordinal symbol: &registered;.
-</para>
</item></tableitem><tableitem><tableterm><indexterm index="fn">\textperiodcentered</indexterm><code>\textperiodcentered</code></tableterm>
<item><para><indexterm index="cp">period, centered, in text</indexterm><indexterm index="cp">centered period, in text</indexterm>Centered period: <math>\cdot</math>.
</para>
@@ -6707,7 +6767,7 @@ has the ascender height.
<item><para><indexterm index="cp">trademark symbol</indexterm>Trademark symbol: <math>^{\hbox{TM}}</math>.
</para>
</item></tableitem><tableitem><tableterm><indexterm index="fn">\texttwelveudash</indexterm><code>\texttwelveudash</code></tableterm>
-<item><para>Xx 12u-.
+<item><para><indexterm index="cp">two-thirds em-dash</indexterm><indexterm index="cp">em-dash, two-thirds</indexterm>&ldquo;Two-thirds&rdquo; em-dash, between en-dash and em-dash.
</para>
</item></tableitem><tableitem><tableterm><indexterm index="fn">\textunderscore</indexterm><code>\textunderscore</code></tableterm>
<item><para><indexterm index="cp">underscore, in text</indexterm>Underscore: _.
@@ -7076,7 +7136,7 @@ is tried (<samp>foo</samp> or <samp>foo.bar</samp>).
<title>Tables of contents</title>
<para><indexterm index="cp">table of contents, creating</indexterm></para>
-<para><indexterm index="fn">\tableofcontents</indexterm>A table of contents is produced with the <code>\tableofcontents</code>
+<para><indexterm index="fn">\tableofcontents</indexterm><indexterm index="fn">.toc <r>file</r></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.
@@ -7687,7 +7747,8 @@ command; e.g.
<title>Document templates</title>
<para><indexterm index="cp">document templates</indexterm></para>
<para>Although not reference material, perhaps these document templates will
-be useful.
+be useful. Additional templates are collected at
+<uref><urefurl>http://www.howtotex.com/templates</urefurl></uref>.
</para>
<menu>
<menuentry>