[latexrefman-commits] [SCM] latexrefman updated: r1177 - trunk
Karl Berry
INVALID.NOREPLY at gnu.org.ua
Sun Jun 16 00:44:59 CEST 2024
Author: karl
Date: 2024-06-15 22:44:58 +0000 (Sat, 15 Jun 2024)
New Revision: 1177
Modified:
trunk/ChangeLog
trunk/latex2e.html
trunk/latex2e.texi
Log:
{displaymath} not {equation*} is part of LaTeX; "plain @TeX{}"
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2024-05-24 15:44:18 UTC (rev 1176)
+++ trunk/ChangeLog 2024-06-15 22:44:58 UTC (rev 1177)
@@ -1,3 +1,11 @@
+2024-06-15 Karl Berry <karl at freefriends.org>
+
+ * latex2e.texi (array): for the example, use LaTeX's {displaymath},
+ not amsmaths' {equation*}. Report from Claude Quitte, 11 Jun 2024.
+ (displaymath): mention equation* and breqn.
+ (throughout): "plain @TeX{}" not "Plain at tie{}@TeX{}", per
+ The TeXbook.
+
2024-05-24 Karl Berry <karl at freefriends.org>
* latex2e.texi (itemize): give an example of language settings
Modified: trunk/latex2e.html
===================================================================
--- trunk/latex2e.html 2024-05-24 15:44:18 UTC (rev 1176)
+++ trunk/latex2e.html 2024-06-15 22:44:58 UTC (rev 1177)
@@ -5243,7 +5243,7 @@
<a class="index-entry-id" id="index-environments"></a>
<a class="index-entry-id" id="index-_005cbegin"></a>
<a class="index-entry-id" id="index-_005cend"></a>
-<a class="anchor" id="Environment"></a>
+
<p>LaTeX provides many environments for delimiting certain behavior.
An environment begins with <code class="code">\begin</code> and ends with <code class="code">\end</code>,
like this:
@@ -5402,7 +5402,7 @@
<p>This example shows a three by three array.
</p>
<div class="example">
-<pre class="example-preformatted">\begin{equation*}
+<pre class="example-preformatted">\begin{displaymath}
\chi(x) =
\left| % vertical bar fence
\begin{array}{ccc}
@@ -5411,7 +5411,7 @@
-g &-h &x-i
\end{array}
\right|
-\end{equation*}
+\end{displaymath}
</pre></div>
<p>The required argument <var class="var">cols</var> describes the number of columns, their
@@ -5706,7 +5706,7 @@
<p>Environment to typeset the <var class="var">mathematical text</var> on its own line, in
display style and centered. To make the text be flush-left use the
-global option <code class="code">fleqn</code>; see <a class="ref" href="#Document-class-options">Document class options</a>.
+global option <code class="code">fleqn</code> (see <a class="pxref" href="#Document-class-options">Document class options</a>).
</p>
<p>In the <code class="code">displaymath</code> environment no equation number is added to the
math text. One way to get an equation number is to use the
@@ -5717,9 +5717,19 @@
<a class="index-entry-id" id="index-package_002c-amsmath-2"></a>
<a class="index-entry-id" id="index-amsmath-package-2"></a>
-<p>Note that the <code class="code">amsmath</code> package has significantly more extensive
-displayed equation facilities. For example, there are a number of
-ways in that package for having math text broken across lines.
+<a class="index-entry-id" id="index-package_002c-breqn"></a>
+<a class="index-entry-id" id="index-breqn-package"></a>
+
+<a class="index-entry-id" id="index-environment_002c-equation_002a"></a>
+<a class="index-entry-id" id="index-equation_002a-environment"></a>
+
+<p>The <code class="code">amsmath</code> package defines an <code class="code">equation*</code> environment
+which is functionally identical to <code class="code">displaymath</code> but allows use
+of other <code class="code">amsmath</code> facilities. In general,
+<code class="code">amsmath</code>has significantly more extensive displayed equation
+facilities. For example, there are a number of ways in that package
+for having math text broken across lines; see also the <code class="code">breqn</code>
+package for that (<a class="url" href="https://ctan.org/pkg/breqn">https://ctan.org/pkg/breqn</a>).
</p>
<a class="index-entry-id" id="index-_005c_005b_002e_002e_002e_005c_005d-display-math"></a>
<p>The construct <code class="code">\[ <var class="var">math</var> \]</code> is a synonym for the environment
@@ -5729,11 +5739,11 @@
<code class="code">displaymath</code> will likely be unique.
</p>
<a class="index-entry-id" id="index-_0024_0024_002e_002e_002e_0024_0024-plain-TeX-display-math"></a>
-<p>The construct <code class="code">$$<var class="var">math</var>$$</code> from Plain TeX is
-sometimes used as a synonym for LaTeX’s <code class="code">displaymath</code>. It is
-not a synonym, and is not officially supported in LaTeX at all;
-<code class="code">$$</code> doesn’t support the <code class="code">fleqn</code> option (see <a class="pxref" href="#Document-class-options">Document class options</a>), has different vertical spacing, and doesn’t perform
-consistency checks.
+<p>The construct <code class="code">$$<var class="var">math</var>$$</code> from plain TeX is sometimes
+used instead of LaTeX’s <code class="code">displaymath</code>. Although the output is
+similar, but is not officially supported in LaTeX at all; <code class="code">$$</code>
+doesn’t support the <code class="code">fleqn</code> option, has different vertical
+spacing, and doesn’t perform consistency checks.
</p>
<p>The output from this example is centered and alone on its line.
</p>
@@ -6435,11 +6445,12 @@
\end{itemize}
</pre></div>
-<p>Produce an <em class="dfn">unordered list</em>, sometimes called a bullet list. There
-must be at least one <code class="code">\item</code> within the environment; having none causes the
-LaTeX error ‘<samp class="samp">Something's wrong--perhaps a missing \item</samp>’.
+<p>Produce an <em class="dfn">unordered list</em>, sometimes called a bullet list.
+There must be at least one <code class="code">\item</code> within the environment; having
+none causes the LaTeX error ‘<samp class="samp">Something's wrong--perhaps a
+missing \item</samp>’.
</p>
-<p>This gives a two-item list.
+<p>This gives a two-item list:
</p>
<div class="example">
<pre class="example-preformatted">\begin{itemize}
@@ -6448,11 +6459,19 @@
\end{itemize}
</pre></div>
-<p>With the default locale—without loading e.g. <code class="code">babel</code> package
-with another language than USenglish—as a top-level list each label
-would come out as a bullet, •. The format of the labeling
-depends on the nesting level; see below.
+<p>By default, in a top-level list each label would come out as a bullet,
+•. The format of the labeling depends on the nesting level;
+see below.
</p>
+<p>Many language adaptations change list formatting, in which case this
+section may apply only partially or not at all. For instance, after this:
+</p>
+<div class="example">
+<pre class="example-preformatted">\usepackage[french]{babel} % changes list formatting!
+</pre></div>
+
+<p>the margins are smaller and the item markers are different.
+</p>
<a class="index-entry-id" id="index-_005citem-3"></a>
<p>Start list items with the <code class="code">\item</code> command (see <a class="pxref" href="#g_t_005citem"><code class="code">\item</code>: An entry in a list</a>). If you
give <code class="code">\item</code> an optional argument by following it with square
@@ -6478,9 +6497,11 @@
</p>
<ol class="enumerate">
<li> • (bullet, from <code class="code">\textbullet</code>)
-</li><li> <b class="b">--<!-- /@w --></b> (bold en-dash, from <code class="code">\normalfont\bfseries\textendash</code>)
+</li><li> <b class="b">–</b> (bold en-dash, from <code class="code">\normalfont\bfseries\textendash</code>)
</li><li> * (asterisk, from <code class="code">\textasteriskcentered</code>)
-</li><li> . (vertically centered dot, rendered here as a period, from <code class="code">\textperiodcentered</code>)
+</li><li> <em class="math">\cdot</em> (vertically centered dot,
+rendered here as a period,
+from <code class="code">\textperiodcentered</code>)
</li></ol>
<p>Change the labels with <code class="code">\renewcommand</code>. For instance, this makes
@@ -6499,12 +6520,13 @@
<a class="index-entry-id" id="index-_005cleftmarginvi"></a>
<a class="anchor" id="itemize-leftmargin"></a><a class="anchor" id="itemize-leftmargini"></a><a class="anchor" id="itemize-leftmarginii"></a><a class="anchor" id="itemize-leftmarginiii"></a><a class="anchor" id="itemize-leftmarginiv"></a><a class="anchor" id="itemize-leftmarginv"></a><a class="anchor" id="itemize-leftmarginvi"></a><p>The distance between the left margin of the enclosing environment and
the left margin of the <code class="code">itemize</code> list is determined by the
-parameters <code class="code">\leftmargini</code> through <code class="code">\leftmarginvi</code>. (This also
-uses the convention of using lowercase roman numerals a the end of the
-command name to denote the nesting level.) The defaults are:
-<code class="code">2.5em</code> in level 1 (<code class="code">2em</code> in two-column mode), <code class="code">2.2em</code> in
-level 2, <code class="code">1.87em</code> in level 3, and <code class="code">1.7em</code> in level 4, with
-smaller values for more deeply nested levels.
+parameters <code class="code">\leftmargini</code> through <code class="code">\leftmarginvi</code>. (This
+also uses the convention of using lowercase roman numerals at the end
+of the command name to denote the nesting level.) The defaults are:
+<code class="code">2.5em</code> in level 1 (<code class="code">2em</code> in two-column mode), <code class="code">2.2em</code>
+in level 2, <code class="code">1.87em</code> in level 3, and <code class="code">1.7em</code> in level 4,
+with smaller values for more deeply nested levels. The margin
+parameters must be overridden before the list starts.
</p>
<a class="index-entry-id" id="index-package_002c-enumitem"></a>
<a class="index-entry-id" id="index-enumitem-package"></a>
@@ -6516,11 +6538,14 @@
for information about customizing list layout, see <a class="ref" href="#list"><code class="code">list</code></a>. The
package <code class="code">enumitem</code> is useful for customizing lists.
</p>
-<p>This example greatly reduces the margin space for outermost itemized
-lists.
+<p>This example greatly reduces the margin space for an outermost itemized
+list:
</p>
<div class="example">
<pre class="example-preformatted">\setlength{\leftmargini}{1.25em} % default 2.5em
+\begin{itemize}
+\item ...
+\end{itemize}
</pre></div>
<a class="index-entry-id" id="index-_005cparskip-example"></a>
@@ -6527,7 +6552,7 @@
<p>Especially for lists with short items, it may be desirable to elide
space between items. Here is an example defining an <code class="code">itemize*</code>
environment with no extra spacing between items, or between paragraphs
-within a single item (<code class="code">\parskip</code> is not list-specific,
+within a single item (<code class="code">\parskip</code> is not list-specific;
see <a class="pxref" href="#g_t_005cparindent-_0026-_005cparskip"><code class="code">\parindent</code> & <code class="code">\parskip</code></a>):
</p>
<div class="example">
@@ -12777,7 +12802,7 @@
<code class="code">\DocumentMetadata</code> command (see <a class="pxref" href="#g_t_005cDocumentMetadata"><code class="code">\DocumentMetadata</code>: Producing tagged PDF output</a>).
</p>
<p>The LaTeX development team strongly recommends use of these and
-related commands over Plain TeX’s <code class="code">\input</code>; see the Class
+related commands over plain TeX’s <code class="code">\input</code>; see the Class
Guide (<a class="url" href="https://ctan.org/pkg/clsguide">https://ctan.org/pkg/clsguide</a>).
</p>
@@ -24611,12 +24636,12 @@
<a class="index-entry-id" id="index-_005cwrite-streams-16_002c-17_002c-18"></a>
<p>The cases where <var class="var">number</var> is 16, 17, or 18 are special. Because of
<code class="code">\write</code>’s behavior when <var class="var">number</var> is outside the range from 0
-to 15 described above, in Plain TeX <code class="code">\write16</code> and
+to 15 described above, in plain TeX <code class="code">\write16</code> and
<code class="code">\write17</code> were sometimes used to write to the log file and the
terminal; however, in LaTeX, the natural way to do that is with
<code class="code">\typeout</code> (see <a class="pxref" href="#g_t_005ctypeout"><code class="code">\typeout</code></a>). The <code class="code">\write18</code> command is
-even more special; modern TeX systems use it for giving commands to
-the operating system (see <a class="pxref" href="#g_t_005cwrite18"><code class="code">\write18</code></a>).
+even more special; modern TeX systems use it to run an external
+operating system command (see <a class="pxref" href="#g_t_005cwrite18"><code class="code">\write18</code></a>).
</p>
<a class="index-entry-id" id="index-newline_002c-in-_005cwrite"></a>
<a class="index-entry-id" id="index-_005e_005eJ_002c-in-_005cwrite"></a>
@@ -26915,6 +26940,7 @@
<tr><td></td><td class="printindex-index-entry"><a href="#index-breaking-lines">breaking lines</a></td><td class="printindex-index-section"><a href="#Line-breaking">Line breaking</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-breaking-pages">breaking pages</a></td><td class="printindex-index-section"><a href="#Page-breaking">Page breaking</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-breaks_002c-multiplication-discretionary">breaks, multiplication discretionary</a></td><td class="printindex-index-section"><a href="#g_t_005c_002a">\*</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a href="#index-breqn-package"><code class="code">breqn</code> <span class="r">package</span></a></td><td class="printindex-index-section"><a href="#displaymath">displaymath</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-breve-accent">breve accent</a></td><td class="printindex-index-section"><a href="#Accents">Accents</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-breve-accent_002c-math">breve accent, math</a></td><td class="printindex-index-section"><a href="#Math-accents">Math accents</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-bug-reporting">bug reporting</a></td><td class="printindex-index-section"><a href="#About-this-document">About this document</a></td></tr>
@@ -27176,6 +27202,7 @@
<tr><td></td><td class="printindex-index-entry"><a href="#index-environment_002c-eqnarray"><code><span class="r">environment</span>, <code class="code">eqnarray</code></code></a></td><td class="printindex-index-section"><a href="#eqnarray">eqnarray</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-environment_002c-equation"><code><span class="r">environment</span>, <code class="code">equation</code></code></a></td><td class="printindex-index-section"><a href="#equation">equation</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-environment_002c-equation-1"><code><span class="r">environment</span>, <code class="code">equation</code></code></a></td><td class="printindex-index-section"><a href="#Math-formulas">Math formulas</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a href="#index-environment_002c-equation_002a"><code><span class="r">environment</span>, <code class="code">equation*</code></code></a></td><td class="printindex-index-section"><a href="#displaymath">displaymath</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-environment_002c-figure"><code><span class="r">environment</span>, <code class="code">figure</code></code></a></td><td class="printindex-index-section"><a href="#figure">figure</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-environment_002c-filecontents"><code><span class="r">environment</span>, <code class="code">filecontents</code></code></a></td><td class="printindex-index-section"><a href="#filecontents">filecontents</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-environment_002c-filecontents_002a"><code><span class="r">environment</span>, <code class="code">filecontents*</code></code></a></td><td class="printindex-index-section"><a href="#filecontents">filecontents</a></td></tr>
@@ -27212,6 +27239,7 @@
<tr><td></td><td class="printindex-index-entry"><a href="#index-equation-number_002c-cross-referencing">equation number, cross referencing</a></td><td class="printindex-index-section"><a href="#g_t_005cref">\ref</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-equation-numbers_002c-left-vs_002e-right">equation numbers, left vs. right</a></td><td class="printindex-index-section"><a href="#Document-class-options">Document class options</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-equation-numbers_002c-omitting">equation numbers, omitting</a></td><td class="printindex-index-section"><a href="#eqnarray">eqnarray</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a href="#index-equation_002a-environment"><code><code class="code">equation*</code> <span class="r">environment</span></code></a></td><td class="printindex-index-section"><a href="#displaymath">displaymath</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-equations_002c-aligning">equations, aligning</a></td><td class="printindex-index-section"><a href="#eqnarray">eqnarray</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-equations_002c-environment-for">equations, environment for</a></td><td class="printindex-index-section"><a href="#equation">equation</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-equations_002c-flush-left-vs_002e-centered">equations, flush left vs. centered</a></td><td class="printindex-index-section"><a href="#Document-class-options">Document class options</a></td></tr>
@@ -27742,6 +27770,7 @@
<tr><td></td><td class="printindex-index-entry"><a href="#index-package_002c-beamer"><span class="r">package</span>, <code class="code">beamer</code></a></td><td class="printindex-index-section"><a href="#beamer-template">beamer template</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-package_002c-bigfoot"><span class="r">package</span>, <code class="code">bigfoot</code></a></td><td class="printindex-index-section"><a href="#Footnotes-of-footnotes">Footnotes of footnotes</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-package_002c-bm"><span class="r">package</span>, <code class="code">bm</code></a></td><td class="printindex-index-section"><a href="#bm">bm</a></td></tr>
+<tr><td></td><td class="printindex-index-entry"><a href="#index-package_002c-breqn"><span class="r">package</span>, <code class="code">breqn</code></a></td><td class="printindex-index-section"><a href="#displaymath">displaymath</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-package_002c-caption"><span class="r">package</span>, <code class="code">caption</code></a></td><td class="printindex-index-section"><a href="#g_t_005ccaption">\caption</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-package_002c-cleveref"><span class="r">package</span>, <code class="code">cleveref</code></a></td><td class="printindex-index-section"><a href="#Cross-references">Cross references</a></td></tr>
<tr><td></td><td class="printindex-index-entry"><a href="#index-package_002c-cleveref-1"><span class="r">package</span>, <code class="code">cleveref</code></a></td><td class="printindex-index-section"><a href="#g_t_005cref">\ref</a></td></tr>
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2024-05-24 15:44:18 UTC (rev 1176)
+++ trunk/latex2e.texi 2024-06-15 22:44:58 UTC (rev 1177)
@@ -4675,7 +4675,7 @@
This example shows a three by three array.
@example
-\begin@{equation*@}
+\begin@{displaymath@}
\chi(x) =
\left| % vertical bar fence
\begin@{array@}@{ccc@}
@@ -4684,7 +4684,7 @@
-g &-h &x-i
\end@{array@}
\right|
-\end@{equation*@}
+\end@{displaymath@}
@end example
The required argument @var{cols} describes the number of columns, their
@@ -4945,7 +4945,7 @@
Environment to typeset the @var{mathematical text} on its own line, in
display style and centered. To make the text be flush-left use the
-global option @code{fleqn}; see @ref{Document class options}.
+global option @code{fleqn} (@pxref{Document class options}).
In the @code{displaymath} environment no equation number is added to the
math text. One way to get an equation number is to use the
@@ -4954,9 +4954,15 @@
@LaTeX{} will not break the @var{math text} across lines.
@PkgIndex{amsmath}
-Note that the @package{amsmath} package has significantly more extensive
-displayed equation facilities. For example, there are a number of
-ways in that package for having math text broken across lines.
+ at PkgIndex{breqn}
+ at EnvIndex equation*
+The @package{amsmath} package defines an @code{equation*} environment
+which is functionally identical to @code{displaymath} but allows use
+of other @package{amsmath} facilities. In general,
+ at package{amsmath}has significantly more extensive displayed equation
+facilities. For example, there are a number of ways in that package
+for having math text broken across lines; see also the @package{breqn}
+package for that (@url{https://ctan.org/pkg/breqn}).
@findex \[...\] @r{display math}
The construct @code{\[ @var{math} \]} is a synonym for the environment
@@ -4966,12 +4972,11 @@
@code{displaymath} will likely be unique.
@findex $$...$$ @r{plain @TeX{} display math}
-The construct @code{$$@var{math}$$} from Plain at tie{}@TeX{} is
-sometimes used as a synonym for @LaTeX{}'s @code{displaymath}. It is
-not a synonym, and is not officially supported in @LaTeX{} at all;
- at code{$$} doesn't support the @code{fleqn} option (@pxref{Document
-class options}), has different vertical spacing, and doesn't perform
-consistency checks.
+The construct @code{$$@var{math}$$} from plain @TeX{} is sometimes
+used instead of @LaTeX{}'s @code{displaymath}. Although the output is
+similar, but is not officially supported in @LaTeX{} at all; @code{$$}
+doesn't support the @code{fleqn} option, has different vertical
+spacing, and doesn't perform consistency checks.
The output from this example is centered and alone on its line.
@@ -11426,7 +11431,7 @@
@code{\DocumentMetadata} command (@pxref{\DocumentMetadata}).
The @LaTeX{} development team strongly recommends use of these and
-related commands over Plain at tie{}@TeX{}'s @code{\input}; see the Class
+related commands over plain @TeX{}'s @code{\input}; see the Class
Guide (@url{https://ctan.org/pkg/clsguide}).
@@ -22329,12 +22334,12 @@
@cindex @code{\write} streams 16, 17, 18
The cases where @var{number} is 16, 17, or 18 are special. Because of
@code{\write}'s behavior when @var{number} is outside the range from 0
-to 15 described above, in Plain at tie{}@TeX{} @code{\write16} and
+to 15 described above, in plain @TeX{} @code{\write16} and
@code{\write17} were sometimes used to write to the log file and the
terminal; however, in @LaTeX{}, the natural way to do that is with
@code{\typeout} (@pxref{\typeout}). The @code{\write18} command is
-even more special; modern @TeX{} systems use it for giving commands to
-the operating system (@pxref{\write18}).
+even more special; modern @TeX{} systems use it to run an external
+operating system command (@pxref{\write18}).
@cindex newline, in @code{\write}
@cindex @code{^^J}, in @code{\write}
More information about the latexrefman-commits
mailing list.