[latexrefman-commits] [SCM] latexrefman updated: r604 - trunk
karl at gnu.org.ua
karl at gnu.org.ua
Mon Feb 19 19:29:38 CET 2018
Author: karl
Date: 2018-02-19 20:29:38 +0200 (Mon, 19 Feb 2018)
New Revision: 604
Modified:
trunk/ChangeLog
trunk/NEWS
trunk/aspell.en.pws
trunk/latex2e-es.pdf
trunk/latex2e.html
trunk/latex2e.info
trunk/latex2e.pdf
trunk/latex2e.texi
Log:
wording, formatting
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/ChangeLog 2018-02-19 18:29:38 UTC (rev 604)
@@ -1,3 +1,11 @@
+2018-02-19 Karl Berry <karl at freefriends.org>
+
+ * latex2e.texi (\list),
+ (\item),
+ (trivlist): minor wording and formatting updates.
+ (\AtBeginDocument, \AtEndDocument): @subsection commands needed.
+ Various typos etc. throughout.
+
2018-01-02 Vincent Belaïche <vincentb1 at users.sourceforge.net>
* latex2e-fr.texi (thebibliography, Upper and lower case): Align
@@ -26,7 +34,7 @@
« Non-English characters » to « Additional Latin letters ». Add an
anchor for backward compatibility.
- * latex2e.texi (Document class options): Add @PkgIndex{geometry}.
+ * latex2e.texi (Document class options): Add @PkgIndex{geometry}.
2017-10-08 Vincent Belaïche <vincentb1 at users.sourceforge.net>
Modified: trunk/NEWS
===================================================================
--- trunk/NEWS 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/NEWS 2018-02-19 18:29:38 UTC (rev 604)
@@ -4,6 +4,9 @@
Spanish translation originally from Nacho Pacheco (currently unmaintained).
French translation originally from Vincent Belaiche.
+- list environment: diagram of parameters and much additional text.
+- tabbing environment added.
+
----------------------------------------------------------------
Changes in Aug 2017 release:
Modified: trunk/aspell.en.pws
===================================================================
--- trunk/aspell.en.pws 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/aspell.en.pws 2018-02-19 18:29:38 UTC (rev 604)
@@ -104,3 +104,4 @@
startsection
mfirstuc
texi
+outdent
Index: trunk/latex2e-es.pdf
===================================================================
--- trunk/latex2e-es.pdf 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/latex2e-es.pdf 2018-02-19 18:29:38 UTC (rev 604)
Property changes on: trunk/latex2e-es.pdf
___________________________________________________________________
Modified: svn:mime-type
## -1 +1 ##
-application/octet-stream
+application/pdf
\ No newline at end of property
Modified: trunk/latex2e.html
===================================================================
--- trunk/latex2e.html 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/latex2e.html 2018-02-19 18:29:38 UTC (rev 604)
@@ -1,7 +1,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This document is an unofficial reference manual for LaTeX, a
-document preparation system, version of August 2017.
+document preparation system, version of February 2018.
This manual was originally translated from LATEX.HLP v1.0a in
the VMS Help Library. The pre-translation version was written by
@@ -16,7 +16,7 @@
text was directly copied).
Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013,
-2014, 2015, 2016, 2017 Karl Berry.
+2014, 2015, 2016, 2017, 2018 Karl Berry.
Copyright 1988, 1994, 2007 Stephen Gilmore.
@@ -34,16 +34,16 @@
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions. -->
-<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
+<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
-<title>LaTeX2e unofficial reference manual (August 2017)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>LaTeX2e unofficial reference manual (February 2018)</title>
-<meta name="description" content="LaTeX2e unofficial reference manual (August 2017)">
-<meta name="keywords" content="LaTeX2e unofficial reference manual (August 2017)">
+<meta name="description" content="LaTeX2e unofficial reference manual (February 2018)">
+<meta name="keywords" content="LaTeX2e unofficial reference manual (February 2018)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="#Concept-Index" rel="index" title="Concept Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
@@ -80,7 +80,7 @@
</head>
<body lang="en">
-<h1 class="settitle" align="center">LaTeX2e unofficial reference manual (August 2017)</h1>
+<h1 class="settitle" align="center">LaTeX2e unofficial reference manual (February 2018)</h1>
@@ -193,7 +193,11 @@
</ul></li>
<li><a name="toc-description-1" href="#description">8.4 <code>description</code></a></li>
<li><a name="toc-displaymath-1" href="#displaymath">8.5 <code>displaymath</code></a></li>
- <li><a name="toc-document-1" href="#document">8.6 <code>document</code></a></li>
+ <li><a name="toc-document-1" href="#document">8.6 <code>document</code></a>
+ <ul class="no-bullet">
+ <li><a name="toc-_005cAtBeginDocument-1" href="#g_t_005cAtBeginDocument">8.6.1 <code>\AtBeginDocument</code></a></li>
+ <li><a name="toc-_005cAtEndDocument-1" href="#g_t_005cAtEndDocument">8.6.2 <code>\AtEndDocument</code></a></li>
+ </ul></li>
<li><a name="toc-enumerate-1" href="#enumerate">8.7 <code>enumerate</code></a></li>
<li><a name="toc-eqnarray-1" href="#eqnarray">8.8 <code>eqnarray</code></a></li>
<li><a name="toc-equation-1" href="#equation">8.9 <code>equation</code></a></li>
@@ -211,8 +215,8 @@
<li><a name="toc-letter-environment_003a-writing-letters" href="#letter">8.15 <code>letter</code> environment: writing letters</a></li>
<li><a name="toc-list-1" href="#list">8.16 <code>list</code></a>
<ul class="no-bullet">
- <li><a name="toc-_005citem_003a-An-entry-in-a-list_002e" href="#g_t_005citem">8.16.1 <code>\item</code>: An entry in a list.</a></li>
- <li><a name="toc-trivlist_003a-A-restricted-form-of-list_002e" href="#trivlist">8.16.2 <code>trivlist</code>: A restricted form of <code>list</code>.</a></li>
+ <li><a name="toc-_005citem_003a-An-entry-in-a-list" href="#g_t_005citem">8.16.1 <code>\item</code>: An entry in a list</a></li>
+ <li><a name="toc-trivlist_003a-A-restricted-form-of-list" href="#trivlist">8.16.2 <code>trivlist</code>: A restricted form of <code>list</code></a></li>
</ul></li>
<li><a name="toc-math-1" href="#math">8.17 <code>math</code></a></li>
<li><a name="toc-minipage-1" href="#minipage">8.18 <code>minipage</code></a></li>
@@ -446,7 +450,7 @@
<h1 class="top">LaTeX2e: An unofficial reference manual</h1>
<p>This document is an unofficial reference manual (version of
-August 2017) for LaTeX2e, a document preparation system.
+February 2018) for LaTeX2e, a document preparation system.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#About-this-document" accesskey="1">About this document</a>:</td><td> </td><td align="left" valign="top">Bug reporting, etc.
@@ -4209,7 +4213,8 @@
<p>
Next: <a href="#g_t_005cAtEndDocument" accesskey="n" rel="next">\AtEndDocument</a>, Up: <a href="#document" accesskey="u" rel="up">document</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<h4 class="node-heading">\AtBeginDocument</h4>
+<a name="g_t_005cAtBeginDocument-1"></a>
+<h4 class="subsection">8.6.1 <code>\AtBeginDocument</code></h4>
<a name="index-_005cAtBeginDocument"></a>
<a name="index-beginning-of-document-hook"></a>
@@ -4236,7 +4241,8 @@
<p>
Previous: <a href="#g_t_005cAtBeginDocument" accesskey="p" rel="prev">\AtBeginDocument</a>, Up: <a href="#document" accesskey="u" rel="up">document</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<h4 class="node-heading">\AtEndDocument</h4>
+<a name="g_t_005cAtEndDocument-1"></a>
+<h4 class="subsection">8.6.2 <code>\AtEndDocument</code></h4>
<a name="index-_005cAtEndDocument"></a>
<a name="index-end-of-document-hook"></a>
@@ -4901,22 +4907,32 @@
\end{list}
</pre></div>
-<p>The <code>list</code> environment is a generic environment, for constructing
-more specialized lists. It is most often used in macros to create lists
-like <a href="#description">description</a>, <a href="#enumerate">enumerate</a>, and <a href="#itemize">itemize</a>. Many
-LaTeX environments that are not obviously lists are constructed using
-<code>list</code>, including <a href="#quotation-and-quote">quotation and quote</a>, <a href="#center">center</a>, and
-<a href="#flushright">flushright</a>. You can also construct custom lists, as here.
+<p>The <code>list</code> environment is a generic environment for constructing
+more specialized lists. It is most often used to create lists via the
+<code>description</code>, <code>enumerate</code>, and <code>itemize</code> environments
+(see <a href="#description">description</a>, <a href="#enumerate">enumerate</a>, and <a href="#itemize">itemize</a>).
</p>
+<p>Also, many standard LaTeX environments that are not visually lists
+are constructed using <code>list</code>, including <code>quotation</code>,
+<code>quote</code>, <code>center</code>, <code>verbatim</code>, and plenty more
+(see <a href="#quotation-and-quote">quotation and quote</a>, see <a href="#center">center</a>, see <a href="#flushright">flushright</a>).
+</p>
+<a name="index-package_002c-enumitem"></a>
+<a name="index-enumitem-package"></a>
+
+<p>The third-party package <code>enumitem</code> is useful for customizing lists.
+Here, we describe the <code>list</code> environment by defining a new custom
+environment.
+</p>
<div class="example">
<pre class="example">\newcounter{namedlistcounter} % number the items
-\newenvironment{named}{%
- \begin{list}{Item~\Roman{namedlistcounter}.}% labeling argument
- {\usecounter{namedlistcounter} % spacing argument
- \setlength{\leftmargin}{3.5em}}% paren closes spacing arg
-}{%
- \end{list}
-}
+\newenvironment{named}
+ {\begin{list}
+ {Item~\Roman{namedlistcounter}.} % labeling argument
+ {\usecounter{namedlistcounter} % spacing argument
+ \setlength{\leftmargin}{3.5em}} % still spacing arg
+ }
+ {\end{list}}
\begin{named}
\item Shows as ``Item~I.''
@@ -4925,16 +4941,18 @@
\end{named}
</pre></div>
-<p>The mandatory first argument <var>labeling</var> specifies the default
-labeling of list items. It can contain text and LaTeX commands, as
-above where it contains both ‘<samp>Item</samp>’ and ‘<samp>\Roman{...}</samp>’.
-LaTeX forms the label by putting the <var>labeling</var> argument in a box
-of width <code>\labelwidth</code>. If the label is wider than that then the
-additional material extends to the right. While making an instance of a
-list you can override the default labeling by giving <code>\item</code> an
-optional argument by including square braces and the text, as in
+<p>The <code>list</code> environment’s mandatory first argument,
+<var>labeling</var>, specifies the default labeling of list items. It can
+contain text and LaTeX commands, as above where it contains both
+‘<samp>Item</samp>’ and ‘<samp>\Roman{...}</samp>’. LaTeX forms the label by
+putting the <var>labeling</var> argument in a box of width
+<code>\labelwidth</code>. If the label is wider than that, the additional
+material extends to the right. When making an instance of a list you
+can override the default labeling by giving <code>\item</code> an optional
+argument by including square braces and the text, as in the above
<code>\item[Special label.]</code>; see <a href="#g_t_005citem">\item</a>.
</p>
+<a name="index-_005cmakelabel"></a>
<p>The label box is constructed by the command <code>\makelabel</code>. By
default it positions the contents flush right. It takes one argument,
the label. It typesets the contents in LR mode. An example of changing
@@ -4945,24 +4963,25 @@
<var>spacing</var> argument also add <code>\let\makelabel\namedmakelabel</code>.
Then the items will be typeset in small caps. Similarly, changing the
second code line to <code>\let\makelabel\fbox</code> puts the labels inside a
-framed box. Another exampe is at the bottom of this entry.
+framed box. Another example is at the bottom of this entry.
</p>
-<p>The mandatory second argument <var>spacing</var> can have a list of commands
-to redefine the spacing parameters for the list, such as
+<p>The mandatory second argument <var>spacing</var> can have a list of
+commands to redefine the spacing parameters for the list, such as
<code>\setlength{\labelwidth}{2em}</code>. If this argument is empty,
i.e., <code>{}</code>, then the list will have the default spacing given
-below. And, to number the items using a counter put
-<code>\usecounter{<var>countername</var>}</code> in this argument.
+below. To number the items using a counter, put
+<code>\usecounter{<var>countername</var>}</code> in this argument
+(see <a href="#g_t_005cusecounter">\usecounter</a>).
</p>
<p>Below are the spacing parameters for list formatting. See also the
-figure below. Each is a length (see <a href="#Lengths">Lengths</a>). The vertical spaces
-should be rubber lengths, with <code>plus</code> and <code>minus</code> components,
-to give TeX flexibility in setting the page. Change each with a
-command such as <code>\setlength{itemsep}{2pt plus1pt minus1pt}</code>.
-For some effects these lengths should be zero or a negative. The
-entries for <a href="#description">description</a>, <a href="#enumerate">enumerate</a>, and <a href="#itemize">itemize</a>
-describe the default values for those lists. The package
-<samp>enumitem</samp> is useful for customizing lists.
+figure below. Each is a length (see <a href="#Lengths">Lengths</a>). The vertical
+spaces are normally rubber lengths, with <code>plus</code> and <code>minus</code>
+components, to give TeX flexibility in setting the page. Change
+each with a command such as <code>\setlength{itemsep}{2pt plus1pt
+minus1pt}</code>. For some effects these lengths should be zero or
+negative. Default values for derived environments such as
+<code>itemize</code> can be changed from the values shown here for the basic
+<code>list</code>.
</p>
<dl compact="compact">
<dt><code>\itemindent</code>
@@ -5024,7 +5043,7 @@
</dt>
<dd><p>Horizontal space between the left margin of the enclosing environment
(or the left margin of the page if this is a top-level list), and the
-left margin of this list. It must be nonnegative.
+left margin of this list. It must be non-negative.
</p>
<p>In the standard LaTeX document classes, a top-level list has this set
to the value of <code>\leftmargini</code>, while a list that is nested inside
@@ -5044,8 +5063,8 @@
</dt>
<dd><p>Horizontal space of additional line indentation, beyond
<code>\leftmargin</code>, for second and subsequent paragraphs within a list
-item. A negative value makes this an outdent. Its default value is
-<code>0pt</code>.
+item. A negative value makes this an “outdent”. Its default value
+is <code>0pt</code>.
</p>
</dd>
<dt><code>\parsep</code>
@@ -5126,30 +5145,30 @@
enclosing environment with
<code>\setlength{\leftmargin}{0.25\linewidth}</code>.
</p>
-<p>Page breaking in a list structure is controlled by three parameters.
-For each, the LaTeX default is <code>-\@lowpenalty</code>, that is,
-<code>-51</code>. Because it is negative, it somewhat encourages a page break
-at each spot. Change it with something like
-<code>\@beginparpenalty=9999</code>; a value of 10000 prohibits a page break.
+<p>Page breaking in a list structure is controlled by the three
+parameters below. For each, the LaTeX default is
+<code>-\@lowpenalty</code>, that is, <code>-51</code>. Because it is negative,
+it somewhat encourages a page break at each spot. Change it with,
+e.g., <code>\@beginparpenalty=9999</code>; a value of 10000 prohibits a
+page break.
</p>
<dl compact="compact">
<dt><code>\@beginparpenalty</code>
<a name="index-_005c_0040beginparpenalty"></a>
</dt>
-<dd><p>The page breaking penalty for breaking before the list. The
-LaTeXdefault is
+<dd><p>The page breaking penalty for breaking before the list (default <code>-51</code>).
</p>
</dd>
<dt><code>\@itempenalty</code>
<a name="index-_005c_0040itempenalty"></a>
</dt>
-<dd><p>The page breaking penalty for breaking before a list item.
+<dd><p>The page breaking penalty for breaking before a list item (default <code>-51</code>).
</p>
</dd>
<dt><code>\@endparpenalty</code>
<a name="index-_005c_0040endparpenalty"></a>
</dt>
-<dd><p>The page breaking penalty for breaking after a list.
+<dd><p>The page breaking penalty for breaking after a list (default <code>-51</code>).
</p>
</dd>
</dl>
@@ -5161,26 +5180,24 @@
<pre class="example">\usepackage{color}
\newcounter{cnt}
\newcommand{\makeredlabel}[1]{\textcolor{red}{#1.}}
-\newenvironment{redlabel}{%
- \begin{list}{\arabic{cnt}}%
+\newenvironment{redlabel}
+ {\begin{list}
+ {\arabic{cnt}}
{\usecounter{cnt}
- \setlength{\labelwidth}{0em}
- \setlength{\labelsep}{0.5em}
- \setlength{\leftmargin}{1.5em}
- \setlength{\itemindent}{0.5em} % equals \labelwidth+\labelsep
- \let\makelabel=\makeredlabel}
-}{
- \end{list}
-}
+ \setlength{\labelwidth}{0em}
+ \setlength{\labelsep}{0.5em}
+ \setlength{\leftmargin}{1.5em}
+ \setlength{\itemindent}{0.5em} % equals \labelwidth+\labelsep
+ \let\makelabel=\makeredlabel
+ }
+ }
+{\end{list} }
</pre></div>
-
-
-
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#g_t_005citem" accesskey="1">\item</a>:</td><td> </td><td align="left" valign="top">An entry in a list.
</td></tr>
-<tr><td align="left" valign="top">• <a href="#trivlist" accesskey="2">trivlist</a>:</td><td> </td><td align="left" valign="top">A restricted form of list.
+<tr><td align="left" valign="top">• <a href="#trivlist" accesskey="2">trivlist</a>:</td><td> </td><td align="left" valign="top">A restricted form of <code>list</code>.
</td></tr>
</table>
@@ -5191,8 +5208,8 @@
<p>
Next: <a href="#trivlist" accesskey="n" rel="next">trivlist</a>, Up: <a href="#list" accesskey="u" rel="up">list</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<a name="g_t_005citem_003a-An-entry-in-a-list_002e"></a>
-<h4 class="subsection">8.16.1 <code>\item</code>: An entry in a list.</h4>
+<a name="g_t_005citem_003a-An-entry-in-a-list"></a>
+<h4 class="subsection">8.16.1 <code>\item</code>: An entry in a list</h4>
<p>Synopsis:
</p>
@@ -5202,21 +5219,22 @@
<p>or
</p><div class="example">
-<pre class="example">\item[<var>optional label</var>] text of item
+<pre class="example">\item[<var>optional-label</var>] text of item
</pre></div>
<p>An entry in a list. The entries are prefixed by a label, whose default
depends on the list type.
</p>
-<p>Because the optional label starts with a square bracket ‘<samp>[</samp>’, if you
-have an item with no optional argument whose text starts with that
-character then LaTeX will think it marks the start of an optional
-label. The fix is to hide the bracket inside curly braces, as in
-<code>\item {[} is an open square bracket</code>. In the same way, if the
-item does have an optional label and you must put a close square bracket
-inside that label then you can hide it, as in <code>\item[Close square
-bracket, {]}]</code>. See <a href="#LaTeX-command-syntax">LaTeX command syntax</a>.
+<p>Because the optional label is surrounded by square brackets
+‘<samp>[...]</samp>’, if you have an item whose text starts with ‘<samp>[</samp>’, you
+have to to hide the bracket inside curly braces, as in: <code>\item
+{[} is an open square bracket</code>; otherwise, LaTeX will think it
+marks the start of an optional label.
</p>
+<p>Similarly, if the item does have the optional label and you need a
+close square bracket inside that label, you must hide it in the same
+way: <code>\item[Close square bracket, {]}]</code>. See <a href="#LaTeX-command-syntax">LaTeX command syntax</a>.
+</p>
<p>In this example the enumerate list has two items that use the default
label and one that uses the optional label.
</p>
@@ -5229,9 +5247,9 @@
</pre></div>
<p>The first item is labelled ‘<samp>1.</samp>’, the second item is labelled
-‘<samp>sometimes</samp>’, and the third item is labelled ‘<samp>2.</samp>’ (note that,
-because of the optional label in the second item, the third item does
-not get a ‘<samp>3.</samp>’).
+‘<samp>sometimes</samp>’, and the third item is labelled ‘<samp>2.</samp>’. Because
+of the optional label in the second item, the third item is not
+labelled ‘<samp>3.</samp>’.
</p>
<hr>
@@ -5240,8 +5258,8 @@
<p>
Previous: <a href="#g_t_005citem" accesskey="p" rel="prev">\item</a>, Up: <a href="#list" accesskey="u" rel="up">list</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
-<a name="trivlist_003a-A-restricted-form-of-list_002e"></a>
-<h4 class="subsection">8.16.2 <code>trivlist</code>: A restricted form of <code>list</code>.</h4>
+<a name="trivlist_003a-A-restricted-form-of-list"></a>
+<h4 class="subsection">8.16.2 <code>trivlist</code>: A restricted form of <code>list</code></h4>
<p>Synopsis:
</p>
@@ -5251,35 +5269,33 @@
\end{trivlist}
</pre></div>
-<p>A restriction of the list environment, in which margins are not indented
-and an <code>\item</code> without an optional argument produces no text. It
-is most often used in macros, to define to define an environment where
+<p>A restricted version of the list environment, in which margins are not
+indented and an <code>\item</code> without an optional argument produces no
+text. It is most often used in macros, to define an environment where
the <code>\item</code> command as part of the environment’s definition. For
-instance, the <code>center</code> environment is defined in essentially the
-following way.
+instance, the <code>center</code> environment is defined essentially like
+this:
</p>
<div class="example">
-<pre class="example">\newenvironment{center}{%
- \begin{trivlist}\centering\item\relax}{%
- \end{trivlist}}
+<pre class="example">\newenvironment{center}
+ {\begin{trivlist}\centering\item\relax}
+ {\end{trivlist}}
</pre></div>
-<p>Using <code>trivlist</code> in this way allows the macro to inherit the code
-to handle how to combine vertical space if one environment that is set
-off from the preceeding and following material immediately follows
-another, to detect whether the text following the environment should be
-set as a new paragraph or a continuation of the previous one, and to
-adjust the left and right margins in a way that tells any nested list
-environments which margins to use.
+<p>Using <code>trivlist</code> in this way allows the macro to inherit some
+common code: combining vertical space of two adjacent environments;
+detecting whether the text following the environment should be
+considered a new paragraph or a continuation of the previous one;
+adjusting the left and right margins for possible nested list
+environments.
</p>
<p>Specifically, <code>trivlist</code> uses the current values of the list
parameters (see <a href="#list">list</a>), except that <code>\parsep</code> is set to the
value of <code>\parskip</code>, and <code>\leftmargin</code>, <code>\labelwidth</code>,
and <code>\itemindent</code> are set to zero.
</p>
-<p>This example outputs the items as two paragraphs, except that with
-LaTeX’s defaults they have no paragraph indent and are vertically
-separated.
+<p>This example outputs the items as two paragraphs, except that (by
+default) they have no paragraph indent and are vertically separated.
</p>
<div class="example">
<pre class="example">\begin{trivlist}
@@ -5311,8 +5327,8 @@
\end{math}
</pre></div>
-<p>The <code>math</code> environment inserts the given <var>math</var> within the
-running text. <code>\(...\)</code> and <code>$...$</code> are synonyms.
+<p>The <code>math</code> environment inserts given <var>math</var> material within
+the running text. <code>\(...\)</code> and <code>$...$</code> are synonyms.
See <a href="#Math-formulas">Math formulas</a>.
</p>
@@ -5941,7 +5957,6 @@
<a name="tabbing-1"></a>
<h3 class="section">8.21 <code>tabbing</code></h3>
-
<a name="index-environment_002c-tabbing"></a>
<a name="index-tabbing-environment"></a>
@@ -5964,8 +5979,8 @@
It is best suited for cases where the width of each column is constant
and known in advance.
</p>
-<p>This example has a first line where the tab stops are set, ended by a
-<code>\kill</code> command.
+<p>This example has a first line where the tab stops are set to explicit
+widths, ended by a <code>\kill</code> command (which is described below):
</p>
<div class="example">
<pre class="example">\begin{tabbing}
@@ -5974,18 +5989,18 @@
\textit{Sophie} \> 14 \> 1800 \\
\textit{Polychrest} \> 24 \> 1803 \\
\textit{Lively} \> 38 \> 1804 \\
-\textit{Surprise} \> 28 \> 1805
+\textit{Surprise} \> 28 \> 1805 \\
\end{tabbing}
</pre></div>
<p>Both the <code>tabbing</code> environment and the more widely-used
<code>tabular</code> environment put text in columns. The most important
-distinction is that in <code>tabular</code> the width of columns is determined
-automatically by LaTeX but in <code>tabbing</code> the user sets tab stops.
-Another distinction is that <code>tabular</code> generates a box, but
-<code>tabbing</code> can be broken across pages. Finally, while
-<code>tabular</code> can be used in any mode, <code>tabbing</code> can be used only
-in paragraph mode and it starts a new paragraph.
+distinction is that in <code>tabular</code> the width of columns is
+determined automatically by LaTeX, while in <code>tabbing</code> the user
+sets the tab stops. Another distinction is that <code>tabular</code>
+generates a box, but <code>tabbing</code> can be broken across pages.
+Finally, while <code>tabular</code> can be used in any mode, <code>tabbing</code>
+can be used only in paragraph mode and it starts a new paragraph.
</p>
<p>A <code>tabbing</code> environment always starts a new paragraph, without
indentation. Moreover, as shown in the example above, there is no need
@@ -5995,20 +6010,20 @@
<code>\linewidth</code>.
</p>
<a name="index-row_002c-tabbing"></a>
-<p>The <code>tabbing</code> environment contains a sequence of <em>tabbed rows</em>.
-The first tabbed row begins immediately after <code>\begin{tabbing}</code>
-and each row ends with <code>\\</code> or <code>\kill</code>. The last row may end
-with just <code>\end{tabbing}</code>, which is equivalent to <code>\\
-\end{tabbing}</code>.
+<p>The <code>tabbing</code> environment contains a sequence of <em>tabbed
+rows</em>. The first tabbed row begins immediately after
+<code>\begin{tabbing}</code> and each row ends with <code>\\</code> or
+<code>\kill</code>. The last row may omit the <code>\\</code> and end with just
+<code>\end{tabbing}</code>.
</p>
<p>At any point the <code>tabbing</code> environment has a current tab stop
-pattern, a sequence of <em><var>n</var> > 0</em> tab stops, numbered 0, 1, etc.
-These create <var>n</var> corresponding columns. Tab stop 0 is always
-the left margin, defined by the enclosing environment. Tab stop
-number <var>i</var> is set if it is assigned a horizontal position on
-the page. Tab stop number <var>i</var> can only be set if all the stops
-0, ..., <var>i-1</var> have already been set; normally later stops are to the
-right of earlier ones.
+pattern, a sequence of <em><var>n</var> > 0</em> tab stops, numbered 0, 1,
+etc. These create <var>n</var> corresponding columns. Tab stop 0 is
+always the left margin, defined by the enclosing environment. Tab
+stop number <var>i</var> is set if it is assigned a horizontal
+position on the page. Tab stop number <var>i</var> can only be set if
+all the stops 0, …, <em>i-1</em> have already been set; normally
+later stops are to the right of earlier ones.
</p>
<p>By default any text typeset in a <code>tabbing</code> environment is typeset
ragged right and left-aligned on the current tab stop. Typesetting is
@@ -6124,13 +6139,13 @@
</dd>
</dl>
-<p>This example typesets a Pascal function.
+<p>This example typesets a Pascal function:
</p>
<div class="example">
<pre class="example">\begin{tabbing}
function \= fact(n : integer) : integer;\\
\> begin \= \+ \\
- \> if \= n $>$ 1 then \+ \\
+ \> if \= n > 1 then \+ \\
fact := n * fact(n-1) \- \\
else \+ \\
fact := 1; \-\- \\
@@ -6138,7 +6153,7 @@
\end{tabbing}
</pre></div>
-<p>The output will look like this.
+<p>The output looks like this:
</p><div class="example">
<pre class="example">function fact(n : integer) : integer;
begin
@@ -6156,10 +6171,18 @@
<a name="index-package_002c-minted"></a>
<a name="index-minted-package"></a>
-<p>(Note that there are a number of packages specialized for typesetting
-computer code, including <code>listings</code>, <code>minted</code>, and
-<samp>algorithm2e</samp>.)
-</p>
+<a name="index-package_002c-fancyvrb"></a>
+<a name="index-fancyvrb-package"></a>
+
+
+<p>(The above example is just for illustration of the environment. To
+actually typeset computer code in typewriter like this, a verbatim
+environment (see <a href="#verbatim">verbatim</a>) would normally suffice. For
+pretty-printed code, there are quite a few packages, including
+<code>algorithm2e</code>, <code>fancyvrb</code>, <code>listings</code>, and
+<code>minted</code>.)
+</p>
+
<hr>
<a name="table"></a>
<div class="header">
@@ -15165,6 +15188,7 @@
<tr><td></td><td valign="top"><a href="#index-ending-and-starting">ending and starting</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-engines_002c-TeX">engines, TeX</a>:</td><td> </td><td valign="top"><a href="#TeX-engines">TeX engines</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-enlarge-current-page">enlarge current page</a>:</td><td> </td><td valign="top"><a href="#g_t_005cenlargethispage">\enlargethispage</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-enumitem-package"><code>enumitem</code> <span class="roman">package</span></a>:</td><td> </td><td valign="top"><a href="#list">list</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-environment">environment</a>:</td><td> </td><td valign="top"><a href="#Starting-and-ending">Starting and ending</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-environment_002c-theorem_002dlike">environment, theorem-like</a>:</td><td> </td><td valign="top"><a href="#g_t_005cnewtheorem">\newtheorem</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-environments">environments</a>:</td><td> </td><td valign="top"><a href="#Environments">Environments</a></td></tr>
@@ -15187,6 +15211,7 @@
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-families_002c-of-fonts">families, of fonts</a>:</td><td> </td><td valign="top"><a href="#Low_002dlevel-font-commands">Low-level font commands</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-fancyvrb-package"><code>fancyvrb</code> <span class="roman">package</span></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-feminine-ordinal-symbol">feminine ordinal symbol</a>:</td><td> </td><td valign="top"><a href="#Text-symbols">Text symbols</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-figure-number_002c-cross-referencing">figure number, cross referencing</a>:</td><td> </td><td valign="top"><a href="#g_t_005cref">\ref</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-figures_002c-footnotes-in">figures, footnotes in</a>:</td><td> </td><td valign="top"><a href="#minipage">minipage</a></td></tr>
@@ -15429,7 +15454,9 @@
<tr><td></td><td valign="top"><a href="#index-package_002c-babel"><span class="roman">package</span>, <code>babel</code></a>:</td><td> </td><td valign="top"><a href="#thebibliography">thebibliography</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-babel-1"><span class="roman">package</span>, <code>babel</code></a>:</td><td> </td><td valign="top"><a href="#Accents">Accents</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-datetime"><span class="roman">package</span>, <code>datetime</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005ctoday">\today</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-package_002c-enumitem"><span class="roman">package</span>, <code>enumitem</code></a>:</td><td> </td><td valign="top"><a href="#list">list</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-etoolbox"><span class="roman">package</span>, <code>etoolbox</code></a>:</td><td> </td><td valign="top"><a href="#Class-and-package-commands">Class and package commands</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-package_002c-fancyvrb"><span class="roman">package</span>, <code>fancyvrb</code></a>:</td><td> </td><td valign="top"><a href="#tabbing">tabbing</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-flafter"><span class="roman">package</span>, <code>flafter</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-float"><span class="roman">package</span>, <code>float</code></a>:</td><td> </td><td valign="top"><a href="#Floats">Floats</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-package_002c-footmisc"><span class="roman">package</span>, <code>footmisc</code></a>:</td><td> </td><td valign="top"><a href="#Footnotes-in-section-headings">Footnotes in section headings</a></td></tr>
@@ -16255,6 +16282,7 @@
<tr><td></td><td valign="top"><a href="#index-_005cmakebox-_0028for-picture_0029"><code>\makebox <span class="roman">(for <code>picture</code>)</span></code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cmakebox-_0028picture_0029">\makebox (picture)</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cmakeglossary"><code>\makeglossary</code></a>:</td><td> </td><td valign="top"><a href="#Glossaries">Glossaries</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cmakeindex"><code>\makeindex</code></a>:</td><td> </td><td valign="top"><a href="#Indexes">Indexes</a></td></tr>
+<tr><td></td><td valign="top"><a href="#index-_005cmakelabel"><code>\makelabel</code></a>:</td><td> </td><td valign="top"><a href="#list">list</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cmakelabels"><code>\makelabels</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cmakelabels">\makelabels</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cmaketitle"><code>\maketitle</code></a>:</td><td> </td><td valign="top"><a href="#g_t_005cmaketitle">\maketitle</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_005cmapsto"><code>\mapsto</code></a>:</td><td> </td><td valign="top"><a href="#Math-symbols">Math symbols</a></td></tr>
Modified: trunk/latex2e.info
===================================================================
--- trunk/latex2e.info 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/latex2e.info 2018-02-19 18:29:38 UTC (rev 604)
@@ -1,8 +1,8 @@
-This is latex2e.info, produced by makeinfo version 6.1 from
+This is latex2e.info, produced by makeinfo version 6.5 from
latex2e.texi.
This document is an unofficial reference manual for LaTeX, a document
-preparation system, version of August 2017.
+preparation system, version of February 2018.
This manual was originally translated from 'LATEX.HLP' v1.0a in the
VMS Help Library. The pre-translation version was written by George D.
@@ -15,7 +15,7 @@
number 10), as reference material (no text was directly copied).
Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016,
-2017 Karl Berry.
+2017, 2018 Karl Berry.
Copyright 1988, 1994, 2007 Stephen Gilmore.
Copyright 1994, 1995, 1996 Torsten Martinsen.
@@ -42,8 +42,8 @@
LaTeX2e: An unofficial reference manual
***************************************
-This document is an unofficial reference manual (version of August 2017)
-for LaTeX2e, a document preparation system.
+This document is an unofficial reference manual (version of February
+2018) for LaTeX2e, a document preparation system.
* Menu:
@@ -2639,6 +2639,9 @@
File: latex2e.info, Node: \AtBeginDocument, Next: \AtEndDocument, Up: document
+8.6.1 '\AtBeginDocument'
+------------------------
+
Synopsis:
\AtBeginDocument{CODE}
@@ -2655,6 +2658,9 @@
File: latex2e.info, Node: \AtEndDocument, Prev: \AtBeginDocument, Up: document
+8.6.2 '\AtEndDocument'
+----------------------
+
Synopsis:
\AtEndDocument{CODE}
@@ -3106,21 +3112,28 @@
...
\end{list}
- The 'list' environment is a generic environment, for constructing
-more specialized lists. It is most often used in macros to create lists
-like *note description::, *note enumerate::, and *note itemize::. Many
-LaTeX environments that are not obviously lists are constructed using
-'list', including *note quotation and quote::, *note center::, and *note
-flushright::. You can also construct custom lists, as here.
+ The 'list' environment is a generic environment for constructing more
+specialized lists. It is most often used to create lists via the
+'description', 'enumerate', and 'itemize' environments (*note
+description::, *note enumerate::, and *note itemize::).
+ Also, many standard LaTeX environments that are not visually lists
+are constructed using 'list', including 'quotation', 'quote', 'center',
+'verbatim', and plenty more (*note quotation and quote::, *note
+center::, *note flushright::).
+
+ The third-party package 'enumitem' is useful for customizing lists.
+Here, we describe the 'list' environment by defining a new custom
+environment.
+
\newcounter{namedlistcounter} % number the items
- \newenvironment{named}{%
- \begin{list}{Item~\Roman{namedlistcounter}.}% labeling argument
- {\usecounter{namedlistcounter} % spacing argument
- \setlength{\leftmargin}{3.5em}}% paren closes spacing arg
- }{%
- \end{list}
- }
+ \newenvironment{named}
+ {\begin{list}
+ {Item~\Roman{namedlistcounter}.} % labeling argument
+ {\usecounter{namedlistcounter} % spacing argument
+ \setlength{\leftmargin}{3.5em}} % still spacing arg
+ }
+ {\end{list}}
\begin{named}
\item Shows as ``Item~I.''
@@ -3128,14 +3141,15 @@
\item Shows as ``Item~II.''
\end{named}
- The mandatory first argument LABELING specifies the default labeling
-of list items. It can contain text and LaTeX commands, as above where
-it contains both 'Item' and '\Roman{...}'. LaTeX forms the label by
-putting the LABELING argument in a box of width '\labelwidth'. If the
-label is wider than that then the additional material extends to the
-right. While making an instance of a list you can override the default
-labeling by giving '\item' an optional argument by including square
-braces and the text, as in '\item[Special label.]'; *note \item::.
+ The 'list' environment's mandatory first argument, LABELING,
+specifies the default labeling of list items. It can contain text and
+LaTeX commands, as above where it contains both 'Item' and
+'\Roman{...}'. LaTeX forms the label by putting the LABELING argument
+in a box of width '\labelwidth'. If the label is wider than that, the
+additional material extends to the right. When making an instance of a
+list you can override the default labeling by giving '\item' an optional
+argument by including square braces and the text, as in the above
+'\item[Special label.]'; *note \item::.
The label box is constructed by the command '\makelabel'. By default
it positions the contents flush right. It takes one argument, the
@@ -3146,24 +3160,23 @@
SPACING argument also add '\let\makelabel\namedmakelabel'. Then the
items will be typeset in small caps. Similarly, changing the second
code line to '\let\makelabel\fbox' puts the labels inside a framed box.
-Another exampe is at the bottom of this entry.
+Another example is at the bottom of this entry.
The mandatory second argument SPACING can have a list of commands to
redefine the spacing parameters for the list, such as
'\setlength{\labelwidth}{2em}'. If this argument is empty, i.e., '{}',
-then the list will have the default spacing given below. And, to number
-the items using a counter put '\usecounter{COUNTERNAME}' in this
-argument.
+then the list will have the default spacing given below. To number the
+items using a counter, put '\usecounter{COUNTERNAME}' in this argument
+(*note \usecounter::).
Below are the spacing parameters for list formatting. See also the
figure below. Each is a length (*note Lengths::). The vertical spaces
-should be rubber lengths, with 'plus' and 'minus' components, to give
+are normally rubber lengths, with 'plus' and 'minus' components, to give
TeX flexibility in setting the page. Change each with a command such as
'\setlength{itemsep}{2pt plus1pt minus1pt}'. For some effects these
-lengths should be zero or a negative. The entries for *note
-description::, *note enumerate::, and *note itemize:: describe the
-default values for those lists. The package 'enumitem' is useful for
-customizing lists.
+lengths should be zero or negative. Default values for derived
+environments such as 'itemize' can be changed from the values shown here
+for the basic 'list'.
'\itemindent'
Extra horizontal space indentation, beyond 'leftmargin', of the
@@ -3209,7 +3222,7 @@
'\leftmargin'
Horizontal space between the left margin of the enclosing
environment (or the left margin of the page if this is a top-level
- list), and the left margin of this list. It must be nonnegative.
+ list), and the left margin of this list. It must be non-negative.
In the standard LaTeX document classes, a top-level list has this
set to the value of '\leftmargini', while a list that is nested
@@ -3226,7 +3239,7 @@
'\listparindent'
Horizontal space of additional line indentation, beyond
'\leftmargin', for second and subsequent paragraphs within a list
- item. A negative value makes this an outdent. Its default value
+ item. A negative value makes this an "outdent". Its default value
is '0pt'.
'\parsep'
@@ -3288,21 +3301,23 @@
quarter of the distance between the left and right margins of the
enclosing environment with '\setlength{\leftmargin}{0.25\linewidth}'.
- Page breaking in a list structure is controlled by three parameters.
-For each, the LaTeX default is '-\@lowpenalty', that is, '-51'. Because
-it is negative, it somewhat encourages a page break at each spot.
-Change it with something like '\@beginparpenalty=9999'; a value of 10000
-prohibits a page break.
+ Page breaking in a list structure is controlled by the three
+parameters below. For each, the LaTeX default is '-\@lowpenalty', that
+is, '-51'. Because it is negative, it somewhat encourages a page break
+at each spot. Change it with, e.g., '\@beginparpenalty=9999'; a value
+of 10000 prohibits a page break.
'\@beginparpenalty'
- The page breaking penalty for breaking before the list. The
- LaTeXdefault is
+ The page breaking penalty for breaking before the list (default
+ '-51').
'\@itempenalty'
- The page breaking penalty for breaking before a list item.
+ The page breaking penalty for breaking before a list item (default
+ '-51').
'\@endparpenalty'
- The page breaking penalty for breaking after a list.
+ The page breaking penalty for breaking after a list (default
+ '-51').
This example has the labels in red. They are numbered, and the left
edge of the label lines up with the left edge of the item text.
@@ -3310,48 +3325,50 @@
\usepackage{color}
\newcounter{cnt}
\newcommand{\makeredlabel}[1]{\textcolor{red}{#1.}}
- \newenvironment{redlabel}{%
- \begin{list}{\arabic{cnt}}%
+ \newenvironment{redlabel}
+ {\begin{list}
+ {\arabic{cnt}}
{\usecounter{cnt}
- \setlength{\labelwidth}{0em}
- \setlength{\labelsep}{0.5em}
- \setlength{\leftmargin}{1.5em}
- \setlength{\itemindent}{0.5em} % equals \labelwidth+\labelsep
- \let\makelabel=\makeredlabel}
- }{
- \end{list}
- }
+ \setlength{\labelwidth}{0em}
+ \setlength{\labelsep}{0.5em}
+ \setlength{\leftmargin}{1.5em}
+ \setlength{\itemindent}{0.5em} % equals \labelwidth+\labelsep
+ \let\makelabel=\makeredlabel
+ }
+ }
+ {\end{list} }
* Menu:
* \item:: An entry in a list.
-* trivlist:: A restricted form of list.
+* trivlist:: A restricted form of 'list'.
File: latex2e.info, Node: \item, Next: trivlist, Up: list
-8.16.1 '\item': An entry in a list.
------------------------------------
+8.16.1 '\item': An entry in a list
+----------------------------------
Synopsis:
\item text of item
or
- \item[OPTIONAL LABEL] text of item
+ \item[OPTIONAL-LABEL] text of item
An entry in a list. The entries are prefixed by a label, whose
default depends on the list type.
- Because the optional label starts with a square bracket '[', if you
-have an item with no optional argument whose text starts with that
-character then LaTeX will think it marks the start of an optional label.
-The fix is to hide the bracket inside curly braces, as in '\item {[} is
-an open square bracket'. In the same way, if the item does have an
-optional label and you must put a close square bracket inside that label
-then you can hide it, as in '\item[Close square bracket, {]}]'. *Note
-LaTeX command syntax::.
+ Because the optional label is surrounded by square brackets '[...]',
+if you have an item whose text starts with '[', you have to to hide the
+bracket inside curly braces, as in: '\item {[} is an open square
+bracket'; otherwise, LaTeX will think it marks the start of an optional
+label.
+ Similarly, if the item does have the optional label and you need a
+close square bracket inside that label, you must hide it in the same
+way: '\item[Close square bracket, {]}]'. *Note LaTeX command syntax::.
+
In this example the enumerate list has two items that use the default
label and one that uses the optional label.
@@ -3362,15 +3379,14 @@
\end{enumerate}
The first item is labelled '1.', the second item is labelled
-'sometimes', and the third item is labelled '2.' (note that, because of
-the optional label in the second item, the third item does not get a
-'3.').
+'sometimes', and the third item is labelled '2.'. Because of the
+optional label in the second item, the third item is not labelled '3.'.
File: latex2e.info, Node: trivlist, Prev: \item, Up: list
-8.16.2 'trivlist': A restricted form of 'list'.
------------------------------------------------
+8.16.2 'trivlist': A restricted form of 'list'
+----------------------------------------------
Synopsis:
@@ -3378,33 +3394,29 @@
...
\end{trivlist}
- A restriction of the list environment, in which margins are not
-indented and an '\item' without an optional argument produces no text.
-It is most often used in macros, to define to define an environment
-where the '\item' command as part of the environment's definition. For
-instance, the 'center' environment is defined in essentially the
-following way.
+ A restricted version of the list environment, in which margins are
+not indented and an '\item' without an optional argument produces no
+text. It is most often used in macros, to define an environment where
+the '\item' command as part of the environment's definition. For
+instance, the 'center' environment is defined essentially like this:
- \newenvironment{center}{%
- \begin{trivlist}\centering\item\relax}{%
- \end{trivlist}}
+ \newenvironment{center}
+ {\begin{trivlist}\centering\item\relax}
+ {\end{trivlist}}
- Using 'trivlist' in this way allows the macro to inherit the code to
-handle how to combine vertical space if one environment that is set off
-from the preceeding and following material immediately follows another,
-to detect whether the text following the environment should be set as a
-new paragraph or a continuation of the previous one, and to adjust the
-left and right margins in a way that tells any nested list environments
-which margins to use.
+ Using 'trivlist' in this way allows the macro to inherit some common
+code: combining vertical space of two adjacent environments; detecting
+whether the text following the environment should be considered a new
+paragraph or a continuation of the previous one; adjusting the left and
+right margins for possible nested list environments.
Specifically, 'trivlist' uses the current values of the list
parameters (*note list::), except that '\parsep' is set to the value of
'\parskip', and '\leftmargin', '\labelwidth', and '\itemindent' are set
to zero.
- This example outputs the items as two paragraphs, except that with
-LaTeX's defaults they have no paragraph indent and are vertically
-separated.
+ This example outputs the items as two paragraphs, except that (by
+default) they have no paragraph indent and are vertically separated.
\begin{trivlist}
\item The \textit{Surprise} is not old; no one would call her old.
@@ -3423,7 +3435,7 @@
MATH
\end{math}
- The 'math' environment inserts the given MATH within the running
+ The 'math' environment inserts given MATH material within the running
text. '\(...\)' and '$...$' are synonyms. *Note Math formulas::.
@@ -3849,8 +3861,8 @@
It is best suited for cases where the width of each column is constant
and known in advance.
- This example has a first line where the tab stops are set, ended by a
-'\kill' command.
+ This example has a first line where the tab stops are set to explicit
+widths, ended by a '\kill' command (which is described below):
\begin{tabbing}
\hspace{0.75in} \= \hspace{0.40in} \= \hspace{0.40in} \kill
@@ -3858,16 +3870,16 @@
\textit{Sophie} \> 14 \> 1800 \\
\textit{Polychrest} \> 24 \> 1803 \\
\textit{Lively} \> 38 \> 1804 \\
- \textit{Surprise} \> 28 \> 1805
+ \textit{Surprise} \> 28 \> 1805 \\
\end{tabbing}
Both the 'tabbing' environment and the more widely-used 'tabular'
environment put text in columns. The most important distinction is that
-in 'tabular' the width of columns is determined automatically by LaTeX
-but in 'tabbing' the user sets tab stops. Another distinction is that
-'tabular' generates a box, but 'tabbing' can be broken across pages.
-Finally, while 'tabular' can be used in any mode, 'tabbing' can be used
-only in paragraph mode and it starts a new paragraph.
+in 'tabular' the width of columns is determined automatically by LaTeX,
+while in 'tabbing' the user sets the tab stops. Another distinction is
+that 'tabular' generates a box, but 'tabbing' can be broken across
+pages. Finally, while 'tabular' can be used in any mode, 'tabbing' can
+be used only in paragraph mode and it starts a new paragraph.
A 'tabbing' environment always starts a new paragraph, without
indentation. Moreover, as shown in the example above, there is no need
@@ -3877,15 +3889,15 @@
The 'tabbing' environment contains a sequence of "tabbed rows". The
first tabbed row begins immediately after '\begin{tabbing}' and each row
-ends with '\\' or '\kill'. The last row may end with just
-'\end{tabbing}', which is equivalent to '\\ \end{tabbing}'.
+ends with '\\' or '\kill'. The last row may omit the '\\' and end with
+just '\end{tabbing}'.
At any point the 'tabbing' environment has a current tab stop
pattern, a sequence of N > 0 tab stops, numbered 0, 1, etc. These
create N corresponding columns. Tab stop 0 is always the left margin,
defined by the enclosing environment. Tab stop number I is set if it is
assigned a horizontal position on the page. Tab stop number I can only
-be set if all the stops 0, ..., I-1 have already been set; normally
+be set if all the stops 0, ..., i-1 have already been set; normally
later stops are to the right of earlier ones.
By default any text typeset in a 'tabbing' environment is typeset
@@ -3953,19 +3965,19 @@
'\tabbingsep'
Distance of the text moved by '\'' to left of current tab stop.
- This example typesets a Pascal function.
+ This example typesets a Pascal function:
\begin{tabbing}
function \= fact(n : integer) : integer;\\
\> begin \= \+ \\
- \> if \= n $>$ 1 then \+ \\
+ \> if \= n > 1 then \+ \\
fact := n * fact(n-1) \- \\
else \+ \\
fact := 1; \-\- \\
end;\\
\end{tabbing}
- The output will look like this.
+ The output looks like this:
function fact(n : integer) : integer;
begin
if n > 1 then
@@ -3974,8 +3986,11 @@
fact := 1;
end;
- (Note that there are a number of packages specialized for typesetting
-computer code, including 'listings', 'minted', and 'algorithm2e'.)
+ (The above example is just for illustration of the environment. To
+actually typeset computer code in typewriter like this, a verbatim
+environment (*note verbatim::) would normally suffice. For
+pretty-printed code, there are quite a few packages, including
+'algorithm2e', 'fancyvrb', 'listings', and 'minted'.)
File: latex2e.info, Node: table, Next: tabular, Prev: tabbing, Up: Environments
@@ -8026,7 +8041,7 @@
Synopsis:
\begin{lrbox}{\CMD}
- TEXT
+ TEXT
\end{lrbox}
This is the environment form of *note '\sbox': \sbox.
@@ -9508,7 +9523,7 @@
* bar-under accent: Accents. (line 46)
* basics of LaTeX: Overview. (line 6)
* beamer template and class: beamer template. (line 6)
-* beginning of document hook: \AtBeginDocument. (line 3)
+* beginning of document hook: \AtBeginDocument. (line 6)
* bibliography format, open: Document class options.
(line 67)
* bibliography, creating (automatically): Using BibTeX. (line 6)
@@ -9682,10 +9697,11 @@
* em-dash, two-thirds: Text symbols. (line 175)
* emphasis: Font styles. (line 59)
* enclosure list: \encl. (line 6)
-* end of document hook: \AtEndDocument. (line 3)
+* end of document hook: \AtEndDocument. (line 6)
* ending and starting: Starting and ending. (line 6)
* engines, TeX: TeX engines. (line 6)
* enlarge current page: \enlargethispage. (line 6)
+* enumitem package: list. (line 24)
* environment: Starting and ending. (line 22)
* environment, theorem-like: \newtheorem. (line 6)
* environments: Environments. (line 6)
@@ -9715,6 +9731,7 @@
* external files, writing: filecontents. (line 6)
* families, of fonts: Low-level font commands.
(line 21)
+* fancyvrb package: tabbing. (line 144)
* feminine ordinal symbol: Text symbols. (line 135)
* figure number, cross referencing: \ref. (line 6)
* figures, footnotes in: minipage. (line 21)
@@ -9984,8 +10001,10 @@
* package, babel: thebibliography. (line 29)
* package, babel <1>: Accents. (line 6)
* package, datetime: \today. (line 22)
+* package, enumitem: list. (line 24)
* package, etoolbox: Class and package commands.
(line 110)
+* package, fancyvrb: tabbing. (line 144)
* package, flafter: Floats. (line 82)
* package, float: Floats. (line 52)
* package, footmisc: Footnotes in section headings.
@@ -10315,11 +10334,11 @@
(line 21)
* \> (tabbing): tabbing. (line 71)
* \@: \(SPACE) and \@. (line 6)
-* \@beginparpenalty: list. (line 201)
-* \@endparpenalty: list. (line 208)
+* \@beginparpenalty: list. (line 208)
+* \@endparpenalty: list. (line 216)
* \@fnsymbol: \footnote. (line 23)
* \@ifstar: \@ifstar. (line 6)
-* \@itempenalty: list. (line 205)
+* \@itempenalty: list. (line 212)
* \@startsection: \@startsection. (line 6)
* \a (tabbing): tabbing. (line 101)
* \a' (acute accent in tabbing): tabbing. (line 102)
@@ -10363,10 +10382,10 @@
* \arraystretch: tabular. (line 162)
* \ast: Math symbols. (line 39)
* \asymp: Math symbols. (line 48)
-* \AtBeginDocument: \AtBeginDocument. (line 3)
+* \AtBeginDocument: \AtBeginDocument. (line 6)
* \AtBeginDvi: Class and package commands.
(line 9)
-* \AtEndDocument: \AtEndDocument. (line 3)
+* \AtEndDocument: \AtEndDocument. (line 6)
* \AtEndOfClass: Class and package commands.
(line 14)
* \AtEndOfPackage: Class and package commands.
@@ -10681,8 +10700,8 @@
* \item <1>: enumerate. (line 29)
* \item <2>: itemize. (line 6)
* \item <3>: itemize. (line 28)
-* \itemindent: list. (line 73)
-* \itemsep: list. (line 77)
+* \itemindent: list. (line 80)
+* \itemsep: list. (line 84)
* \itshape: Font styles. (line 33)
* \j (dotless j): Accents. (line 66)
* \jmath: Math accents. (line 37)
@@ -10704,8 +10723,8 @@
* \labelitemii: itemize. (line 35)
* \labelitemiii: itemize. (line 35)
* \labelitemiv: itemize. (line 35)
-* \labelsep: list. (line 89)
-* \labelwidth: list. (line 94)
+* \labelsep: list. (line 96)
+* \labelwidth: list. (line 101)
* \Lambda: Math symbols. (line 287)
* \lambda: Math symbols. (line 290)
* \land: Math symbols. (line 293)
@@ -10728,7 +10747,7 @@
* \leftharpoondown: Math symbols. (line 335)
* \leftharpoonup: Math symbols. (line 338)
* \leftmargin: itemize. (line 54)
-* \leftmargin <1>: list. (line 114)
+* \leftmargin <1>: list. (line 121)
* \leftmargini: itemize. (line 54)
* \leftmarginii: itemize. (line 54)
* \leftmarginiii: itemize. (line 54)
@@ -10756,7 +10775,7 @@
(line 34)
* \listoffigures: Tables of contents. (line 16)
* \listoftables: Tables of contents. (line 16)
-* \listparindent: list. (line 131)
+* \listparindent: list. (line 138)
* \ll: Math symbols. (line 366)
* \ln: Math functions. (line 75)
* \lnot: Math symbols. (line 370)
@@ -10776,6 +10795,7 @@
* \makebox (for picture): \makebox (picture). (line 6)
* \makeglossary: Glossaries. (line 6)
* \makeindex: Indexes. (line 6)
+* \makelabel: list. (line 53)
* \makelabels: \makelabels. (line 6)
* \maketitle: \maketitle. (line 6)
* \mapsto: Math symbols. (line 395)
@@ -10937,12 +10957,12 @@
* \parbox: \parbox. (line 6)
* \parindent: minipage. (line 17)
* \parindent <1>: \indent. (line 6)
-* \parsep: list. (line 137)
+* \parsep: list. (line 144)
* \parskip: \parskip. (line 6)
* \parskip example: itemize. (line 73)
* \part: Sectioning. (line 8)
* \partial: Math symbols. (line 505)
-* \partopsep: list. (line 146)
+* \partopsep: list. (line 153)
* \PassOptionsToClass: Class and package commands.
(line 198)
* \PassOptionsToPackage: Class and package commands.
@@ -11023,7 +11043,7 @@
* \rightharpoondown: Math symbols. (line 610)
* \rightharpoonup: Math symbols. (line 613)
* \rightleftharpoons: Math symbols. (line 616)
-* \rightmargin: list. (line 161)
+* \rightmargin: list. (line 168)
* \rm: Font styles. (line 79)
* \rmfamily: Font styles. (line 30)
* \roman{COUNTER}: \alph \Alph \arabic \roman \Roman \fnsymbol.
@@ -11207,7 +11227,7 @@
* \topfraction <1>: Floats. (line 108)
* \topmargin: Page layout parameters.
(line 123)
-* \topsep: list. (line 166)
+* \topsep: list. (line 173)
* \topskip: Page layout parameters.
(line 130)
* \topskip <1>: Page layout parameters.
@@ -11465,244 +11485,244 @@
Tag Table:
-Node: Top1697
-Node: About this document3446
-Node: Overview5306
-Node: Starting and ending6806
-Ref: Starting & ending6941
-Node: Output files7927
-Node: TeX engines10173
-Node: LaTeX command syntax12611
-Node: Environment14445
-Node: Declaration15518
-Node: \makeatletter and \makeatother15904
-Node: \@ifstar18097
-Node: Document classes20926
-Node: Document class options22249
-Node: Additional packages25348
-Node: Class and package construction25979
-Node: Class and package structure27431
-Node: Class and package commands29725
-Node: Fonts47250
-Ref: Typefaces47353
-Node: Font styles47681
-Node: Font sizes52110
-Node: Low-level font commands53341
-Node: Layout58448
-Node: \onecolumn58946
-Node: \twocolumn59277
-Node: \flushbottom63672
-Node: \raggedbottom64772
-Node: Page layout parameters65308
-Node: Floats71006
-Node: Sectioning77471
-Ref: Sectioning/secnumdepth78792
-Node: \@startsection79202
-Ref: \@startsection/name80474
-Ref: \@startsection/level80934
-Ref: \@startsection/indent82005
-Ref: \@startsection/beforeskip82268
-Ref: \@startsection/afterskip83789
-Ref: \@startsection/style85100
-Node: Cross references88936
-Node: \label90802
-Node: \pageref92349
-Node: \ref93019
-Node: Environments93708
-Node: abstract95711
-Node: array97300
-Node: center99558
-Node: \centering101199
-Node: description102571
-Node: displaymath104758
-Node: document106536
-Node: \AtBeginDocument106966
-Node: \AtEndDocument107539
-Node: enumerate108136
-Node: eqnarray110933
-Node: equation112987
-Node: figure113505
-Node: filecontents115317
-Node: flushleft117070
-Node: \raggedright117563
-Node: flushright118122
-Node: \raggedleft118620
-Node: itemize119177
-Node: letter122678
-Node: list122916
-Node: \item133669
-Node: trivlist134953
-Node: math136622
-Node: minipage136923
-Node: picture138115
-Node: \circle142410
-Node: \makebox (picture)142753
-Node: \framebox (picture)143459
-Node: \dashbox143949
-Node: \frame144472
-Node: \line144798
-Node: \linethickness145256
-Node: \thicklines145677
-Node: \thinlines145987
-Node: \multiput146289
-Node: \oval146656
-Node: \put147377
-Node: \shortstack147668
-Node: \vector148142
-Node: quotation and quote148456
-Node: tabbing149663
-Node: table155397
-Node: tabular156824
-Node: \multicolumn164032
-Node: \vline167917
-Node: \cline169262
-Node: \hline169946
-Node: thebibliography170629
-Node: \bibitem172243
-Node: \cite173001
-Node: \nocite173520
-Node: Using BibTeX173808
-Node: theorem175317
-Node: titlepage175703
-Node: verbatim176993
-Node: \verb177632
-Node: verse178182
-Node: Line breaking178676
-Node: \\179773
-Node: \obeycr & \restorecr180811
-Node: \newline181213
-Node: \- (hyphenation)182047
-Node: \discretionary182662
-Node: \fussy182954
-Node: \sloppy183344
-Node: \hyphenation183671
-Node: \linebreak & \nolinebreak184296
-Node: Page breaking184948
-Node: \cleardoublepage185556
-Node: \clearpage185985
-Node: \newpage186282
-Node: \enlargethispage186513
-Node: \pagebreak & \nopagebreak187040
-Node: Footnotes187734
-Node: \footnote188988
-Node: \footnotemark190784
-Node: \footnotetext192028
-Node: Footnotes in a table192518
-Node: Footnotes in section headings194375
-Node: Footnotes of footnotes195231
-Node: Multiple reference to footnotes195998
-Node: Footnote parameters196856
-Node: Definitions197606
-Node: \newcommand & \renewcommand198419
-Node: \providecommand202255
-Node: \newcounter202916
-Node: \newlength203887
-Node: \newsavebox204534
-Node: \newenvironment & \renewenvironment205145
-Node: \newtheorem209505
-Node: \newfont212994
-Node: \protect214559
-Node: Counters216899
-Node: \alph \Alph \arabic \roman \Roman \fnsymbol218499
-Node: \usecounter220571
-Node: \value221403
-Node: \setcounter222346
-Node: \addtocounter222832
-Node: \refstepcounter223297
-Node: \stepcounter223955
-Node: \day \month \year224297
-Node: Lengths224842
-Node: Units of length226632
-Node: \setlength228126
-Node: \addtolength228530
-Node: \settodepth228848
-Node: \settoheight229139
-Node: \settowidth229436
-Node: Predefined lengths229744
-Node: Making paragraphs230259
-Node: \indent230831
-Node: \noindent231293
-Node: \parskip231802
-Node: Marginal notes232060
-Node: Math formulas233872
-Node: Subscripts & superscripts235656
-Node: Math symbols236994
-Node: Math functions262324
-Node: Math accents263267
-Node: Spacing in math mode264239
-Node: Math miscellany265706
-Node: Modes268256
-Node: \ensuremath270096
-Node: Page styles271012
-Node: \maketitle271506
-Node: \pagenumbering272576
-Node: \pagestyle273072
-Node: \thispagestyle274213
-Node: Spaces274519
-Node: \hspace275444
-Node: \hfill276399
-Node: \(SPACE) and \@276794
-Ref: \AT276955
-Node: \(SPACE) after control sequence278492
-Node: \frenchspacing279410
-Node: \thinspace280028
-Node: \/280331
-Node: \hrulefill \dotfill281513
-Node: \addvspace282506
-Node: \bigskip \medskip \smallskip283552
-Node: \vfill284446
-Node: \vspace285315
-Node: Boxes286308
-Node: \mbox287033
-Node: \fbox and \framebox287320
-Node: lrbox288123
-Node: \makebox288482
-Node: \parbox289202
-Node: \raisebox290770
-Node: \savebox291367
-Node: \sbox291782
-Node: \usebox292231
-Node: Special insertions292492
-Node: Reserved characters293293
-Node: Upper and lower case294494
-Node: Symbols by font position296409
-Node: Text symbols297029
-Node: Accents300477
-Node: Additional Latin letters303019
-Ref: Non-English characters303190
-Node: \rule304207
-Node: \today304636
-Node: Splitting the input305390
-Node: \include306154
-Node: \includeonly306745
-Node: \input307258
-Node: Front/back matter307753
-Node: Tables of contents307958
-Node: \addcontentsline309019
-Node: \addtocontents310037
-Node: Glossaries310570
-Node: Indexes311089
-Node: Letters312722
-Node: \address316400
-Node: \cc317270
-Node: \closing317688
-Node: \encl317999
-Node: \location318414
-Node: \makelabels318683
-Node: \name319684
-Node: \opening319914
-Node: \ps320254
-Node: \signature320543
-Node: \telephone321635
-Node: Terminal input/output322000
-Node: \typein322265
-Node: \typeout322850
-Node: Command line323473
-Node: Document templates324425
-Node: beamer template324832
-Node: book template325483
-Node: tugboat template325851
-Node: Concept Index328215
-Node: Command Index385326
+Node: Top1705
+Node: About this document3456
+Node: Overview5316
+Node: Starting and ending6816
+Ref: Starting & ending6951
+Node: Output files7937
+Node: TeX engines10183
+Node: LaTeX command syntax12621
+Node: Environment14455
+Node: Declaration15528
+Node: \makeatletter and \makeatother15914
+Node: \@ifstar18107
+Node: Document classes20936
+Node: Document class options22259
+Node: Additional packages25358
+Node: Class and package construction25989
+Node: Class and package structure27441
+Node: Class and package commands29735
+Node: Fonts47260
+Ref: Typefaces47363
+Node: Font styles47691
+Node: Font sizes52120
+Node: Low-level font commands53351
+Node: Layout58458
+Node: \onecolumn58956
+Node: \twocolumn59287
+Node: \flushbottom63682
+Node: \raggedbottom64782
+Node: Page layout parameters65318
+Node: Floats71016
+Node: Sectioning77481
+Ref: Sectioning/secnumdepth78802
+Node: \@startsection79212
+Ref: \@startsection/name80484
+Ref: \@startsection/level80944
+Ref: \@startsection/indent82015
+Ref: \@startsection/beforeskip82278
+Ref: \@startsection/afterskip83799
+Ref: \@startsection/style85110
+Node: Cross references88946
+Node: \label90812
+Node: \pageref92359
+Node: \ref93029
+Node: Environments93718
+Node: abstract95721
+Node: array97310
+Node: center99568
+Node: \centering101209
+Node: description102581
+Node: displaymath104768
+Node: document106546
+Node: \AtBeginDocument106976
+Node: \AtEndDocument107600
+Node: enumerate108244
+Node: eqnarray111041
+Node: equation113095
+Node: figure113613
+Node: filecontents115425
+Node: flushleft117178
+Node: \raggedright117671
+Node: flushright118230
+Node: \raggedleft118728
+Node: itemize119285
+Node: letter122786
+Node: list123024
+Node: \item134064
+Node: trivlist135317
+Node: math136845
+Node: minipage137151
+Node: picture138343
+Node: \circle142638
+Node: \makebox (picture)142981
+Node: \framebox (picture)143687
+Node: \dashbox144177
+Node: \frame144700
+Node: \line145026
+Node: \linethickness145484
+Node: \thicklines145905
+Node: \thinlines146215
+Node: \multiput146517
+Node: \oval146884
+Node: \put147605
+Node: \shortstack147896
+Node: \vector148370
+Node: quotation and quote148684
+Node: tabbing149891
+Node: table155829
+Node: tabular157256
+Node: \multicolumn164464
+Node: \vline168349
+Node: \cline169694
+Node: \hline170378
+Node: thebibliography171061
+Node: \bibitem172675
+Node: \cite173433
+Node: \nocite173952
+Node: Using BibTeX174240
+Node: theorem175749
+Node: titlepage176135
+Node: verbatim177425
+Node: \verb178064
+Node: verse178614
+Node: Line breaking179108
+Node: \\180205
+Node: \obeycr & \restorecr181243
+Node: \newline181645
+Node: \- (hyphenation)182479
+Node: \discretionary183094
+Node: \fussy183386
+Node: \sloppy183776
+Node: \hyphenation184103
+Node: \linebreak & \nolinebreak184728
+Node: Page breaking185380
+Node: \cleardoublepage185988
+Node: \clearpage186417
+Node: \newpage186714
+Node: \enlargethispage186945
+Node: \pagebreak & \nopagebreak187472
+Node: Footnotes188166
+Node: \footnote189420
+Node: \footnotemark191216
+Node: \footnotetext192460
+Node: Footnotes in a table192950
+Node: Footnotes in section headings194807
+Node: Footnotes of footnotes195663
+Node: Multiple reference to footnotes196430
+Node: Footnote parameters197288
+Node: Definitions198038
+Node: \newcommand & \renewcommand198851
+Node: \providecommand202687
+Node: \newcounter203348
+Node: \newlength204319
+Node: \newsavebox204966
+Node: \newenvironment & \renewenvironment205577
+Node: \newtheorem209937
+Node: \newfont213426
+Node: \protect214991
+Node: Counters217331
+Node: \alph \Alph \arabic \roman \Roman \fnsymbol218931
+Node: \usecounter221003
+Node: \value221835
+Node: \setcounter222778
+Node: \addtocounter223264
+Node: \refstepcounter223729
+Node: \stepcounter224387
+Node: \day \month \year224729
+Node: Lengths225274
+Node: Units of length227064
+Node: \setlength228558
+Node: \addtolength228962
+Node: \settodepth229280
+Node: \settoheight229571
+Node: \settowidth229868
+Node: Predefined lengths230176
+Node: Making paragraphs230691
+Node: \indent231263
+Node: \noindent231725
+Node: \parskip232234
+Node: Marginal notes232492
+Node: Math formulas234304
+Node: Subscripts & superscripts236088
+Node: Math symbols237426
+Node: Math functions262756
+Node: Math accents263699
+Node: Spacing in math mode264671
+Node: Math miscellany266138
+Node: Modes268688
+Node: \ensuremath270528
+Node: Page styles271444
+Node: \maketitle271938
+Node: \pagenumbering273008
+Node: \pagestyle273504
+Node: \thispagestyle274645
+Node: Spaces274951
+Node: \hspace275876
+Node: \hfill276831
+Node: \(SPACE) and \@277226
+Ref: \AT277387
+Node: \(SPACE) after control sequence278924
+Node: \frenchspacing279842
+Node: \thinspace280460
+Node: \/280763
+Node: \hrulefill \dotfill281945
+Node: \addvspace282938
+Node: \bigskip \medskip \smallskip283984
+Node: \vfill284878
+Node: \vspace285747
+Node: Boxes286740
+Node: \mbox287465
+Node: \fbox and \framebox287752
+Node: lrbox288555
+Node: \makebox288913
+Node: \parbox289633
+Node: \raisebox291201
+Node: \savebox291798
+Node: \sbox292213
+Node: \usebox292662
+Node: Special insertions292923
+Node: Reserved characters293724
+Node: Upper and lower case294925
+Node: Symbols by font position296840
+Node: Text symbols297460
+Node: Accents300908
+Node: Additional Latin letters303450
+Ref: Non-English characters303621
+Node: \rule304638
+Node: \today305067
+Node: Splitting the input305821
+Node: \include306585
+Node: \includeonly307176
+Node: \input307689
+Node: Front/back matter308184
+Node: Tables of contents308389
+Node: \addcontentsline309450
+Node: \addtocontents310468
+Node: Glossaries311001
+Node: Indexes311520
+Node: Letters313153
+Node: \address316831
+Node: \cc317701
+Node: \closing318119
+Node: \encl318430
+Node: \location318845
+Node: \makelabels319114
+Node: \name320115
+Node: \opening320345
+Node: \ps320685
+Node: \signature320974
+Node: \telephone322066
+Node: Terminal input/output322431
+Node: \typein322696
+Node: \typeout323281
+Node: Command line323904
+Node: Document templates324856
+Node: beamer template325263
+Node: book template325914
+Node: tugboat template326282
+Node: Concept Index328646
+Node: Command Index386049
End Tag Table
Modified: trunk/latex2e.pdf
===================================================================
(Binary files differ)
Index: trunk/latex2e.pdf
===================================================================
--- trunk/latex2e.pdf 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/latex2e.pdf 2018-02-19 18:29:38 UTC (rev 604)
Property changes on: trunk/latex2e.pdf
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2018-02-18 16:00:10 UTC (rev 603)
+++ trunk/latex2e.texi 2018-02-19 18:29:38 UTC (rev 604)
@@ -2,7 +2,7 @@
@c $Id$
@comment %**start of header (This is for running Texinfo on a region.)
@setfilename latex2e.info
- at set UPDATED August 2017
+ at set UPDATED February 2018
@include common.texi
@settitle @LaTeX{}2e unofficial reference manual (@value{UPDATED})
@comment %**end of header (This is for running Texinfo on a region.)
@@ -47,7 +47,7 @@
text was directly copied).
Copyright 2007, 2008, 2009, 2010, 2011, 2012, 2013,
-2014, 2015, 2016, 2017 Karl Berry.@*
+2014, 2015, 2016, 2017, 2018 Karl Berry.@*
Copyright 1988, 1994, 2007 Stephen Gilmore.@*
Copyright 1994, 1995, 1996 Torsten Martinsen.
@@ -3401,6 +3401,7 @@
@node \AtBeginDocument
+ at subsection @code{\AtBeginDocument}
@findex \AtBeginDocument
@cindex beginning of document hook
@@ -3422,6 +3423,7 @@
@node \AtEndDocument
+ at subsection @code{\AtEndDocument}
@findex \AtEndDocument
@cindex end of document hook
@@ -3998,22 +4000,30 @@
\end@{list@}
@end example
-The @code{list} environment is a generic environment, for constructing
-more specialized lists. It is most often used in macros to create lists
-like @ref{description}, @ref{enumerate}, and @ref{itemize}. Many
- at LaTeX{} environments that are not obviously lists are constructed using
- at code{list}, including @ref{quotation and quote}, @ref{center}, and
- at ref{flushright}. You can also construct custom lists, as here.
+The @code{list} environment is a generic environment for constructing
+more specialized lists. It is most often used to create lists via the
+ at code{description}, @code{enumerate}, and @code{itemize} environments
+(@pxref{description}, @ref{enumerate}, and @ref{itemize}).
+Also, many standard @LaTeX{} environments that are not visually lists
+are constructed using @code{list}, including @code{quotation},
+ at code{quote}, @code{center}, @code{verbatim}, and plenty more
+(@pxref{quotation and quote}, @pxref{center}, @pxref{flushright}).
+
+ at PkgIndex{enumitem}
+The third-party package @code{enumitem} is useful for customizing lists.
+Here, we describe the @code{list} environment by defining a new custom
+environment.
+
@example
\newcounter@{namedlistcounter@} % number the items
-\newenvironment@{named@}@{%
- \begin@{list@}@{Item~\Roman@{namedlistcounter@}.@}% labeling argument
- @{\usecounter@{namedlistcounter@} % spacing argument
- \setlength@{\leftmargin@}@{3.5em@}@}% paren closes spacing arg
-@}@{%
- \end@{list@}
-@}
+\newenvironment@{named@}
+ @{\begin@{list@}
+ @{Item~\Roman@{namedlistcounter@}.@} % labeling argument
+ @{\usecounter@{namedlistcounter@} % spacing argument
+ \setlength@{\leftmargin@}@{3.5em@}@} % still spacing arg
+ @}
+ @{\end@{list@}@}
\begin@{named@}
\item Shows as ``Item~I.''
@@ -4022,16 +4032,18 @@
\end@{named@}
@end example
-The mandatory first argument @var{labeling} specifies the default
-labeling of list items. It can contain text and @LaTeX{} commands, as
-above where it contains both @samp{Item} and @samp{\Roman@{...@}}.
- at LaTeX{} forms the label by putting the @var{labeling} argument in a box
-of width @code{\labelwidth}. If the label is wider than that then the
-additional material extends to the right. While making an instance of a
-list you can override the default labeling by giving @code{\item} an
-optional argument by including square braces and the text, as in
+The @code{list} environment's mandatory first argument,
+ at var{labeling}, specifies the default labeling of list items. It can
+contain text and @LaTeX{} commands, as above where it contains both
+ at samp{Item} and @samp{\Roman@{...@}}. @LaTeX{} forms the label by
+putting the @var{labeling} argument in a box of width
+ at code{\labelwidth}. If the label is wider than that, the additional
+material extends to the right. When making an instance of a list you
+can override the default labeling by giving @code{\item} an optional
+argument by including square braces and the text, as in the above
@code{\item[Special label.]}; @pxref{\item}.
+ at findex \makelabel
The label box is constructed by the command @code{\makelabel}. By
default it positions the contents flush right. It takes one argument,
the label. It typesets the contents in LR mode. An example of changing
@@ -4042,24 +4054,25 @@
@var{spacing} argument also add @code{\let\makelabel\namedmakelabel}.
Then the items will be typeset in small caps. Similarly, changing the
second code line to @code{\let\makelabel\fbox} puts the labels inside a
-framed box. Another exampe is at the bottom of this entry.
+framed box. Another example is at the bottom of this entry.
-The mandatory second argument @var{spacing} can have a list of commands
-to redefine the spacing parameters for the list, such as
+The mandatory second argument @var{spacing} can have a list of
+commands to redefine the spacing parameters for the list, such as
@code{\setlength@{\labelwidth@}@{2em@}}. If this argument is empty,
i.e., @code{@{@}}, then the list will have the default spacing given
-below. And, to number the items using a counter put
- at code{\usecounter@{@var{countername}@}} in this argument.
+below. To number the items using a counter, put
+ at code{\usecounter@{@var{countername}@}} in this argument
+(@pxref{\usecounter}).
Below are the spacing parameters for list formatting. See also the
-figure below. Each is a length (@pxref{Lengths}). The vertical spaces
-should be rubber lengths, with @code{plus} and @code{minus} components,
-to give @TeX{} flexibility in setting the page. Change each with a
-command such as @code{\setlength@{itemsep@}@{2pt plus1pt minus1pt@}}.
-For some effects these lengths should be zero or a negative. The
-entries for @ref{description}, @ref{enumerate}, and @ref{itemize}
-describe the default values for those lists. The package
- at file{enumitem} is useful for customizing lists.
+figure below. Each is a length (@pxref{Lengths}). The vertical
+spaces are normally rubber lengths, with @code{plus} and @code{minus}
+components, to give @TeX{} flexibility in setting the page. Change
+each with a command such as @code{\setlength@{itemsep@}@{2pt plus1pt
+minus1pt@}}. For some effects these lengths should be zero or
+negative. Default values for derived environments such as
+ at code{itemize} can be changed from the values shown here for the basic
+ at code{list}.
@ftable @code
@item \itemindent
@@ -4107,7 +4120,7 @@
@item \leftmargin
Horizontal space between the left margin of the enclosing environment
(or the left margin of the page if this is a top-level list), and the
-left margin of this list. It must be nonnegative.
+left margin of this list. It must be non-negative.
In the standard @LaTeX{} document classes, a top-level list has this set
to the value of @code{\leftmargini}, while a list that is nested inside
@@ -4124,8 +4137,8 @@
@item \listparindent
Horizontal space of additional line indentation, beyond
@code{\leftmargin}, for second and subsequent paragraphs within a list
-item. A negative value makes this an outdent. Its default value is
- at code{0pt}.
+item. A negative value makes this an ``outdent''. Its default value
+is @code{0pt}.
@item \parsep
Vertical space between paragraphs within an item. In the @samp{book}
@@ -4195,22 +4208,22 @@
enclosing environment with
@code{\setlength@{\leftmargin@}@{0.25\linewidth@}}.
-Page breaking in a list structure is controlled by three parameters.
-For each, the @LaTeX{} default is @code{-\@@lowpenalty}, that is,
- at code{-51}. Because it is negative, it somewhat encourages a page break
-at each spot. Change it with something like
- at code{\@@beginparpenalty=9999}; a value of 10000 prohibits a page break.
+Page breaking in a list structure is controlled by the three
+parameters below. For each, the @LaTeX{} default is
+ at code{-\@@lowpenalty}, that is, @code{-51}. Because it is negative,
+it somewhat encourages a page break at each spot. Change it with,
+e.g., @code{\@@beginparpenalty=9999}; a value of 10000 prohibits a
+page break.
@ftable @code
@item \@@beginparpenalty
-The page breaking penalty for breaking before the list. The
- at LaTeX{}default is
+The page breaking penalty for breaking before the list (default @code{-51}).
@item \@@itempenalty
-The page breaking penalty for breaking before a list item.
+The page breaking penalty for breaking before a list item (default @code{-51}).
@item \@@endparpenalty
-The page breaking penalty for breaking after a list.
+The page breaking penalty for breaking after a list (default @code{-51}).
@end ftable
@@ -4221,30 +4234,28 @@
\usepackage@{color@}
\newcounter@{cnt@}
\newcommand@{\makeredlabel@}[1]@{\textcolor@{red@}@{#1.@}@}
-\newenvironment@{redlabel@}@{%
- \begin@{list@}@{\arabic@{cnt@}@}%
+\newenvironment@{redlabel@}
+ @{\begin@{list@}
+ @{\arabic@{cnt@}@}
@{\usecounter@{cnt@}
- \setlength@{\labelwidth@}@{0em@}
- \setlength@{\labelsep@}@{0.5em@}
- \setlength@{\leftmargin@}@{1.5em@}
- \setlength@{\itemindent@}@{0.5em@} % equals \labelwidth+\labelsep
- \let\makelabel=\makeredlabel@}
-@}@{
- \end@{list@}
-@}
+ \setlength@{\labelwidth@}@{0em@}
+ \setlength@{\labelsep@}@{0.5em@}
+ \setlength@{\leftmargin@}@{1.5em@}
+ \setlength@{\itemindent@}@{0.5em@} % equals \labelwidth+\labelsep
+ \let\makelabel=\makeredlabel
+ @}
+ @}
+@{\end@{list@} @}
@end example
-
-
-
@menu
* \item:: An entry in a list.
-* trivlist:: A restricted form of list.
+* trivlist:: A restricted form of @code{list}.
@end menu
@node \item
- at subsection @code{\item}: An entry in a list.
+ at subsection @code{\item}: An entry in a list
Synopsis:
@@ -4254,21 +4265,23 @@
or
@example
-\item[@var{optional label}] text of item
+\item[@var{optional-label}] text of item
@end example
An entry in a list. The entries are prefixed by a label, whose default
depends on the list type.
-Because the optional label starts with a square bracket @samp{[}, if you
-have an item with no optional argument whose text starts with that
-character then @LaTeX{} will think it marks the start of an optional
-label. The fix is to hide the bracket inside curly braces, as in
- at code{\item @{[@} is an open square bracket}. In the same way, if the
-item does have an optional label and you must put a close square bracket
-inside that label then you can hide it, as in @code{\item[Close square
-bracket, @{]@}]}. @xref{@LaTeX{} command syntax}.
+Because the optional label is surrounded by square brackets
+ at samp{[...]}, if you have an item whose text starts with @samp{[}, you
+have to to hide the bracket inside curly braces, as in: @code{\item
+@{[@} is an open square bracket}; otherwise, @LaTeX{} will think it
+marks the start of an optional label.
+Similarly, if the item does have the optional label and you need a
+close square bracket inside that label, you must hide it in the same
+way: @code{\item[Close square bracket, @{]@}]}. @xref{@LaTeX{}
+command syntax}.
+
In this example the enumerate list has two items that use the default
label and one that uses the optional label.
@@ -4281,13 +4294,13 @@
@end example
The first item is labelled @samp{1.}, the second item is labelled
- at samp{sometimes}, and the third item is labelled @samp{2.} (note that,
-because of the optional label in the second item, the third item does
-not get a @samp{3.}).
+ at samp{sometimes}, and the third item is labelled @samp{2.}. Because
+of the optional label in the second item, the third item is not
+labelled at tie{}@samp{3.}.
@node trivlist
- at subsection @code{trivlist}: A restricted form of @code{list}.
+ at subsection @code{trivlist}: A restricted form of @code{list}
Synopsis:
@@ -4297,35 +4310,33 @@
\end@{trivlist@}
@end example
-A restriction of the list environment, in which margins are not indented
-and an @code{\item} without an optional argument produces no text. It
-is most often used in macros, to define to define an environment where
+A restricted version of the list environment, in which margins are not
+indented and an @code{\item} without an optional argument produces no
+text. It is most often used in macros, to define an environment where
the @code{\item} command as part of the environment's definition. For
-instance, the @code{center} environment is defined in essentially the
-following way.
+instance, the @code{center} environment is defined essentially like
+this:
@example
-\newenvironment@{center@}@{%
- \begin@{trivlist@}\centering\item\relax@}@{%
- \end@{trivlist@}@}
+\newenvironment@{center@}
+ @{\begin@{trivlist@}\centering\item\relax@}
+ @{\end@{trivlist@}@}
@end example
-Using @code{trivlist} in this way allows the macro to inherit the code
-to handle how to combine vertical space if one environment that is set
-off from the preceeding and following material immediately follows
-another, to detect whether the text following the environment should be
-set as a new paragraph or a continuation of the previous one, and to
-adjust the left and right margins in a way that tells any nested list
-environments which margins to use.
+Using @code{trivlist} in this way allows the macro to inherit some
+common code: combining vertical space of two adjacent environments;
+detecting whether the text following the environment should be
+considered a new paragraph or a continuation of the previous one;
+adjusting the left and right margins for possible nested list
+environments.
Specifically, @code{trivlist} uses the current values of the list
parameters (@pxref{list}), except that @code{\parsep} is set to the
value of @code{\parskip}, and @code{\leftmargin}, @code{\labelwidth},
and @code{\itemindent} are set to zero.
-This example outputs the items as two paragraphs, except that with
- at LaTeX{}'s defaults they have no paragraph indent and are vertically
-separated.
+This example outputs the items as two paragraphs, except that (by
+default) they have no paragraph indent and are vertically separated.
@example
\begin@{trivlist@}
@@ -4349,8 +4360,8 @@
\end@{math@}
@end example
-The @code{math} environment inserts the given @var{math} within the
-running text. @code{\(...\)} and @code{$...$} are synonyms.
+The @code{math} environment inserts given @var{math} material within
+the running text. @code{\(...\)} and @code{$...$} are synonyms.
@xref{Math formulas}.
@@ -4838,9 +4849,6 @@
@node tabbing
@section @code{tabbing}
- at c xx vincentb1: please complete translation from French. Start from the
- at c French version and check concistency paragraph by paragraph.
-
@EnvIndex{tabbing}
@cindex tab stops, using
@cindex lining text up using tab stops
@@ -4861,8 +4869,8 @@
It is best suited for cases where the width of each column is constant
and known in advance.
-This example has a first line where the tab stops are set, ended by a
- at code{\kill} command.
+This example has a first line where the tab stops are set to explicit
+widths, ended by a @code{\kill} command (which is described below):
@example
\begin@{tabbing@}
@@ -4871,18 +4879,18 @@
\textit@{Sophie@} \> 14 \> 1800 \\
\textit@{Polychrest@} \> 24 \> 1803 \\
\textit@{Lively@} \> 38 \> 1804 \\
-\textit@{Surprise@} \> 28 \> 1805
+\textit@{Surprise@} \> 28 \> 1805 \\
\end@{tabbing@}
@end example
Both the @code{tabbing} environment and the more widely-used
@code{tabular} environment put text in columns. The most important
-distinction is that in @code{tabular} the width of columns is determined
-automatically by @LaTeX{} but in @code{tabbing} the user sets tab stops.
-Another distinction is that @code{tabular} generates a box, but
- at code{tabbing} can be broken across pages. Finally, while
- at code{tabular} can be used in any mode, @code{tabbing} can be used only
-in paragraph mode and it starts a new paragraph.
+distinction is that in @code{tabular} the width of columns is
+determined automatically by @LaTeX{}, while in @code{tabbing} the user
+sets the tab stops. Another distinction is that @code{tabular}
+generates a box, but @code{tabbing} can be broken across pages.
+Finally, while @code{tabular} can be used in any mode, @code{tabbing}
+can be used only in paragraph mode and it starts a new paragraph.
A @code{tabbing} environment always starts a new paragraph, without
indentation. Moreover, as shown in the example above, there is no need
@@ -4892,20 +4900,20 @@
@code{\linewidth}.
@cindex row, @r{tabbing}
-The @code{tabbing} environment contains a sequence of @dfn{tabbed rows}.
-The first tabbed row begins immediately after @code{\begin@{tabbing@}}
-and each row ends with @code{\\} or @code{\kill}. The last row may end
-with just @code{\end@{tabbing@}}, which is equivalent to @code{\\
-\end@{tabbing@}}.
+The @code{tabbing} environment contains a sequence of @dfn{tabbed
+rows}. The first tabbed row begins immediately after
+ at code{\begin@{tabbing@}} and each row ends with @code{\\} or
+ at code{\kill}. The last row may omit the @code{\\} and end with just
+ at code{\end@{tabbing@}}.
At any point the @code{tabbing} environment has a current tab stop
-pattern, a sequence of @math{@var{n} > 0} tab stops, numbered 0, 1, etc.
-These create @var{n} corresponding columns. Tab stop at tie{}0 is always
-the left margin, defined by the enclosing environment. Tab stop
-number at tie{}@var{i} is set if it is assigned a horizontal position on
-the page. Tab stop number at tie{}@var{i} can only be set if all the stops
-0, ..., @var{i-1} have already been set; normally later stops are to the
-right of earlier ones.
+pattern, a sequence of @math{@var{n} > 0} tab stops, numbered 0, 1,
+etc. These create @var{n} corresponding columns. Tab stop at tie{}0 is
+always the left margin, defined by the enclosing environment. Tab
+stop number at tie{}@var{i} is set if it is assigned a horizontal
+position on the page. Tab stop number at tie{}@var{i} can only be set if
+all the stops 0, @dots{}, @math{i-1} have already been set; normally
+later stops are to the right of earlier ones.
By default any text typeset in a @code{tabbing} environment is typeset
ragged right and left-aligned on the current tab stop. Typesetting is
@@ -4982,13 +4990,13 @@
@end ftable
-This example typesets a Pascal function.
+This example typesets a Pascal function:
@example
\begin@{tabbing@}
function \= fact(n : integer) : integer;\\
\> begin \= \+ \\
- \> if \= n $>$ 1 then \+ \\
+ \> if \= n > 1 then \+ \\
fact := n * fact(n-1) \- \\
else \+ \\
fact := 1; \-\- \\
@@ -4996,7 +5004,7 @@
\end@{tabbing@}
@end example
-The output will look like this.
+The output looks like this:
@example
function fact(n : integer) : integer;
begin
@@ -5008,9 +5016,15 @@
@end example
@PkgIndex{algorithm2e} @PkgIndex{listings} @PkgIndex{minted}
-(Note that there are a number of packages specialized for typesetting
-computer code, including @code{listings}, @code{minted}, and
- at file{algorithm2e}.)
+ at PkgIndex{fancyvrb}
+
+(The above example is just for illustration of the environment. To
+actually typeset computer code in typewriter like this, a verbatim
+environment (@pxref{verbatim}) would normally suffice. For
+pretty-printed code, there are quite a few packages, including
+ at code{algorithm2e}, @code{fancyvrb}, @code{listings}, and
+ at code{minted}.)
+
@node table
@section @code{table}
More information about the latexrefman-commits
mailing list