[latexrefman-commits] [SCM] latexrefman updated: r812 - trunk

[karl at gnu.org.ua]

Author: karl
Date: 2020-06-10 19:24:47 +0300 (Wed, 10 Jun 2020)
New Revision: 812

Modified:
   trunk/ChangeLog
   trunk/latex2e.texi
Log:
reword $$ description

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog	2020-06-07 22:50:14 UTC (rev 811)
+++ trunk/ChangeLog	2020-06-10 16:24:47 UTC (rev 812)
@@ -1,3 +1,8 @@
+2020-06-10  Karl Berry  <karl at freefriends.org>
+
+	* latex2e.texi (displaymath): reword details about not using $$.
+	More index entries.
+
 2020-06-07  Karl Berry  <karl at freefriends.org>
 
 	* latex2e.texi (Font sizes): words of warning about the env form

Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi	2020-06-07 22:50:14 UTC (rev 811)
+++ trunk/latex2e.texi	2020-06-10 16:24:47 UTC (rev 812)
@@ -4669,9 +4669,9 @@
 \end@{displaymath@}
 @end example
 
-Environment to typeset the math text on its own line, in display style
-and centered.  To make the text be flush-left use the global option
- at code{fleqn}; see @ref{Document class options}.
+Environment to typeset the 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}.
 
 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
@@ -4684,19 +4684,21 @@
 displayed equation facilities.  For example, there are a number of
 ways in that package for having math text broken across lines.
 
-The construct @code{\[@var{math text}\]} is essentially a synonym for
- at code{\begin@{displaymath@}@var{math text}\end@{displaymath@}} but the
-latter is easier to work with in the source file; for instance,
+ at findex \[...\] @r{display math}
+The construct @code{\[@var{math}\]} is a synonym for the environment
+ at code{\begin@{displaymath@} @var{math} \end@{displaymath@}} but the
+latter is easier to work with in the source; for instance,
 searching for a square bracket may get false positives but the word
- at code{displaymath} will likely be unique.  (The construct
- at code{$$@var{math text}$$} from Plain at tie{}@TeX{} is sometimes
-mistakenly used as a synonym for @code{displaymath}.  It is not a
-synonym, because the @code{displaymath} environment checks that it isn't
-started in math mode and that it ends in math mode begun by the matching
-environment start, because the @code{displaymath} environment has
-different vertical spacing, and because the @code{displaymath}
-environment honors the @code{fleqn} option.)
+ at code{displaymath} will likely be unique.
 
+ at findex $$...$$ @r{plain @TeX{} display math}
+(Aside: The construct @code{$$@var{math}$$} from Plain at tie{}@TeX{} is
+sometimes mistakenly used as a synonym for @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 output from this example is centered and alone on its line. 
 
 @example
@@ -5853,7 +5855,7 @@
 @section @code{math}
 
 @EnvIndex{math}
- at cindex in-line formulas
+ at cindex inline formulas
 
 Synopsis:
 
@@ -5863,6 +5865,8 @@
 \end@{math@}
 @end example
 
+ at findex $ @r{inline math}
+ at findex \(...\) @r{inline math}
 The @code{math} environment inserts given @var{math} material within
 the running text.  @code{\(...\)} and @code{$...$} are synonyms.
 @xref{Math formulas}.
@@ -7116,7 +7120,7 @@
 The output will have two left-aligned columns with a vertical bar
 between them.  This is specified in @code{tabular}'s argument
 @code{@{l|l@}}.
- at findex & 
+ at findex & @r{for table cells}
 Put the entries into different columns by separating them with an
 ampersand, @code{&}.  The end of each row is marked with a double
 backslash, @code{\\}.  Put a horizontal rule below a row, after a double
@@ -11173,9 +11177,9 @@
 
 @cindex superscript
 @cindex subscript
+ at findex ^ @r{superscript}
+ at findex _ @r{subscript}
 @cindex exponent
- at findex _
- at findex ^
 
 Synopsis (in math mode or display math mode), one of:
 
@@ -13531,9 +13535,8 @@
 @node Colon character & \colon  
 @subsection Colon character @code{:} & @code{\colon}
 
- at cindex :
 @cindex colon character
- at findex :
+ at findex : @r{for math}
 @findex \colon
 
 Synopsis, one of:
@@ -17015,7 +17018,8 @@
 @cindex characters, special
 @LaTeX{} sets aside the following characters for special purposes. For
 example, the percent sign at tie{}@code{%} is for comments.  They are
-called @dfn{reserved characters} or @dfn{special characters}.
+called @dfn{reserved characters} or @dfn{special characters}. They are
+all discussed elsewhere in this manual.
 
 @example
 # $ % & @{ @} _ ~ ^ \ 
@@ -17038,13 +17042,13 @@
 @findex \textbackslash
 As to the last three characters, to get a tilde in the text body font
 use @code{\~@{@}} (omitting the curly braces would result in the next
-character receiving a tilde accent).  Similarly, to get a get a text
-body font circumflex use @code{\^@{@}}.  To get a backslash in the font
-of the text body, enter @code{\textbackslash@{@}}.
+character receiving a tilde accent).  Similarly, to get a text body
+font circumflex use @code{\^@{@}}.  To get a backslash in the font of
+the text body, enter @code{\textbackslash@{@}}.
 
 To produce the reserved characters in a typewriter font use
 @code{\verb!!} as below (the double backslash at tie{}@code{\\} is only
-there to split the lines).
+there to split the lines in the output).
 
 @example
 \begin@{center@}
@@ -18586,8 +18590,8 @@
 followed by two subitems, like @samp{program, 50} and @samp{results,
 51}.
 
- at cindex `see' and `see also' index entries
- at cindex  index entries, `see' and `see also'
+ at cindex see and see also index entries
+ at cindex index entries, `see' and `see also'
 @findex \seename
 @findex \alsoname
 @PkgIndex{babel} @PkgIndex{polyglossia}