[latexrefman-commits] r343 - in /trunk: ChangeLog Makefile latex2e.texi
karl at domain.hid
karl at domain.hid
Tue May 26 01:22:06 CEST 2015
Author: karl
Date: Tue May 26 01:22:06 2015
New Revision: 343
URL: http://svn.gna.org/viewcvs/latexrefman?rev=343&view=rev
Log:
text reviews
Modified:
trunk/ChangeLog
trunk/Makefile
trunk/latex2e.texi
Modified: trunk/ChangeLog
URL: http://svn.gna.org/viewcvs/latexrefman/trunk/ChangeLog?rev=343&r1=342&r2=343&view=diff
==============================================================================
--- trunk/ChangeLog (original)
+++ trunk/ChangeLog Tue May 26 01:22:06 2015
@@ -1,3 +1,15 @@
+2015-05-25 Karl Berry <karl at domain.hid>
+
+ * Makefile (texi2html_top): New variable.
+ (texi2html): use it.
+
+ * latex2e.texi (\label),
+ (Font styles),
+ (\newcounter, \stepcounter, \refstepcounter),
+ (\newcommand & \renewcommand):
+ tweak new and old examples and text.
+ (Math formulas): Consistently use "xx" with "not in plain".
+
2015-05-25 Jim Hefferon <jhefferon at domain.hid>
* latex2e.texi (\newcommand & \renewcommand): Add examples. Drop
@@ -22,7 +34,7 @@
2015-05-16 Jim Hefferon <jhefferon at domain.hid>
* latex2e.texi (\newcounter, \stepcounter, \refstepcounter): Expand
- definions, particularly of the defintion of one counter numbered
+ definitions, particularly of the definition of one counter numbered
within the other.
2015-05-15 Jim Hefferon <jhefferon at domain.hid>
Modified: trunk/Makefile
URL: http://svn.gna.org/viewcvs/latexrefman/trunk/Makefile?rev=343&r1=342&r2=343&view=diff
==============================================================================
--- trunk/Makefile (original)
+++ trunk/Makefile Tue May 26 01:22:06 2015
@@ -21,10 +21,13 @@
#
makeinfo = makeinfo
texi2docbook = $(makeinfo) --docbook
-texi2html = $(makeinfo) --html --no-split
+texi2html = $(makeinfo) --html --no-split $(texi2html_top)
texi2info = $(makeinfo) --no-split
texi2txt = $(makeinfo) --plaintext --no-split
texi2xml = $(makeinfo) --xml
+#
+# Go somewhere useful from Top.
+texi2html_top = -c TOP_NODE_UP_URL=http://tug.org/texinfohtml/
%.pdf: %.texi
$(texi2pdf) $<
Modified: trunk/latex2e.texi
URL: http://svn.gna.org/viewcvs/latexrefman/trunk/latex2e.texi?rev=343&r1=342&r2=343&view=diff
==============================================================================
--- trunk/latex2e.texi (original)
+++ trunk/latex2e.texi Tue May 26 01:22:06 2015
@@ -653,7 +653,7 @@
@section Font styles
@cindex font styles
- at domain.hid typeface styles
+ at cindex type styles
@cindex styles of text
The following type style commands are supported by @LaTeX{}.
@@ -707,7 +707,7 @@
@item \textup (\upshape)
@findex \textup
@findex \upshape
-Upright (default). The opposite of slanted.
+Upright (default).
@item \textsl (\slshape)
@findex \textsl
@@ -738,17 +738,18 @@
@cindex emphasis
@findex \emph
-The @code{\emph at domain.hid}@}} command is semantic, for text to be
-emphasized, and should not be used as a substitute for @code{\textit}.
-For example, @code{\emph at domain.hid text} \emph at domain.hid text}@}
- at domain.hid text}@}} will result in the @var{start text} and @var{end text}
-in italics, but @var{middle text} will be in roman.
+Although it also changes fonts, the @code{\emph at domain.hid}@}} command
+is semantic, for text to be emphasized, and should not be used as a
+substitute for @code{\textit}. For example, @code{\emph at domain.hid
+text} \emph at domain.hid text}@} @var{end text}@}} will result in the
+ at var{start text} and @var{end text} in italics, but @var{middle text}
+will be in roman.
@LaTeX{} also provides the following commands, which unconditionally
switch to the given style, that is, are @emph{not} cumulative. Also,
-they are used differently than the above commands: @code{@{\@var{cmd}
-...@}} instead of @code{\@var{cmd}@{...@}}. These are two unrelated
-constructs.
+they are used differently than the above commands:
+ at code{@{\@var{cmd}...@}} instead of @code{\@var{cmd}@{...@}}. These
+are two unrelated constructs.
@ftable @code
@item \bf
@@ -791,21 +792,20 @@
The @code{\em} command is the unconditional version of @code{\emph}.
-(Some people consider the unconditional font-switching commands, such as
- at domain.hid}, obsolete and that only the cumulative commands
+(Some people consider the unconditional font-switching commands, such
+as @code{\tt}, obsolete and that only the cumulative commands
(@code{\texttt}) should be used. Others think that both sets of
-commands have their place and sometimes an unconditional font switch is
-precisely what you need; for an example
+commands have their place and sometimes an unconditional font switch
+is precisely what you want; for one example,
@pxref{description,, at code{description}}.)
The following commands are for use in math mode. They are not
-cumulative, so @code{\mathbf at domain.hid}@}@}} does not create
-a boldface and italic @var{symbol}, instead it will just be in italics.
-This is because typically math symbols need a typographic treatment that
-is consistent, regardless of the surrounding environment.
+cumulative, so @code{\mathbf at domain.hid}@}@}} does not
+create a boldface and italic @var{symbol}; instead, it will just be in
+italics. This is because typically math symbols need consistent
+typographic treatment, regardless of the surrounding environment.
@table @code
-
@item \mathrm
@findex \mathrm
Roman, for use in math mode.
@@ -828,7 +828,7 @@
@item \mathnormal
@findex \mathnormal
-For use in math mode, e.g. inside another type style declaration.
+For use in math mode, e.g., inside another type style declaration.
@item \mathcal
@findex \mathcal
@@ -858,7 +858,6 @@
@code{textcomp} package must be loaded, and sometimes package options
are provided to make them the default. FAQ entry:
@url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=osf}.
-
@node Font sizes
@@ -1234,7 +1233,7 @@
@var{toctitle} that, when given, specifies the text for these other
places.
- at domain.hid *-form of sectioning commands
+ at cindex @code{*}-form of sectioning commands
Also, all sectioning commands have @code{*}-forms that print
@var{title} as usual, but do not include a number and do not make an
entry in the table of contents. For instance:
@@ -1295,20 +1294,22 @@
\label at domain.hid}@}
@end example
-A @code{\label} command appearing in ordinary text assigns to @var{key}
-the number of the current sectional unit; one appearing inside a
-numbered environment assigns that number to @var{key}. The assigned
-number can be recovered by using the @code{\ref at domain.hid}@}} command
-(@pxref{\ref}).
+A @code{\label} command appearing in ordinary text assigns to
+ at var{key} the number of the current sectional unit; one appearing
+inside a numbered environment assigns that number to @var{key}. The
+assigned number can be retrieved with the @code{\ref at domain.hid}@}}
+command (@pxref{\ref}).
Thus, in the example below the key @code{sec:test} holds the number of
the current section and the key @code{fig:test} that of the figure.
-
- at domain.hid
-\section at domain.hid name@} \label at domain.hid@}
+(Incidentally, labels must appear after captions in figures and
+tables.)
+
+ at example
+\section at domain.hid name@}
+\label at domain.hid@}
This is Section~\ref at domain.hid@}.
\begin at domain.hid@}
- \centering
...
\caption at domain.hid text@}
\label at domain.hid@}
@@ -1316,14 +1317,14 @@
See Figure~\ref at domain.hid@}.
@end example
-A key name can consist of any sequence of letters, digits, or
-punctuation characters. Upper and lowercase letters are distinguished,
-as usual.
-
-A common convention is to use labels consisting of a prefix and a suffix
-separated by a colon or period. One advantage is that it helps avoid
-accidentally creating two labels with the same name. Some commonly-used
-prefixes:
+A key name can consist of any sequence of letters, digits, or common
+punctuation characters. Upper and lowercase letters are
+distinguished, as usual.
+
+Although the name can be more or less anything, a common convention is
+to use labels consisting of a prefix and a suffix separated by a colon
+or period. This helps to avoid accidentally creating two labels with
+the same name. Some commonly-used prefixes:
@table @code
@item ch
@@ -1338,8 +1339,8 @@
for equations
@end table
-Thus, a label for a figure would look like @code{fig:snark} or
- at domain.hid}.
+Thus, a label for a figure would look like @code{fig:test} or
+ at code{fig.test}.
@node \pageref
@@ -2754,7 +2755,7 @@
@item \' @r{(tabbing)}
Moves everything that you have typed so far in the
-current column, i.e. everything from the most recent @code{\>},
+current column, i.e., everything from the most recent @code{\>},
@code{\<}, @code{\'}, @code{\\}, or @code{\kill} command, to the right
of the previous column, flush against the current column's tab stop.
@@ -3538,7 +3539,7 @@
@code{\enlargethispage*@{size@}}
Enlarge the @code{\textheight} for the current page by the specified
-amount; e.g. @code{\enlargethispage at domain.hid@}} will allow one
+amount; e.g., @code{\enlargethispage at domain.hid@}} will allow one
additional line.
The starred form tries to squeeze the material together on the page as
@@ -3727,31 +3728,40 @@
\renewcommand*@{@var{cmd}@}[@var{nargs}][@var{optargval}]@{@var{defn}@}
@end example
-The *-form of these two commands requires that the arguments not contain
-multiple paragraphs of text (not @code{\long}, in plain @TeX{} terms).
+The @code{*}-form of these two commands requires that the arguments
+not contain multiple paragraphs of text (not @code{\long}, in plain
+ at TeX{} terms).
@table @var
-
@item cmd
-The command name. It must begin with @code{\}. For @code{\newcommand},
-it must not be already defined and must not begin with @code{\end}; for
- at domain.hid}, it must already be defined.
+Required; the command name. It must begin with @code{\}. For
+ at code{\newcommand}, it must not be already defined and must not begin
+with @code{\end}. For @code{\renewcommand}, it must already be
+defined.
@item nargs
-An integer from 0 to 9, specifying the number of arguments that the
-command will take. The default is for the command to have no arguments;
-this is what you get if you omit the @code{[@var{nargs}]}.
+Optional; an integer from 0 to 9, specifying the number of arguments
+that the command will take. If this argument is not present, the
+default is for the command to have no arguments. When redefining a
+command, the new version can have a different number of arguments than
+the old version.
@item optargval
-If this parameter is present then the first argument of command
- at domain.hid} is optional, with the default value @var{optarg}. That is,
-if the macro is called with the command name followed by square brackets
- at domain.hid}]} then within @var{defn} the @code{#1}
-expands to the contents of the square brackets @var{value}. If the
-macro is called not followed by square brackets then within @var{defn}
-the @code{#1} expands to the default @var{optargval}. (Note that
-omitting @code{[@var{value}]} is different from having the square
-brackets with no contents @code{[]}, which is an empty @var{value}.)
+Optional; if this argument is present then the first argument of
+defined command @var{\cmd} is optional, with default value
+ at var{optarg} (which may be the empty string). If this argument is not
+present, then @var{\cmd} does not take an optional argument.
+
+That is, if @var{\cmd} is used with square brackets following, as in
+ at code{\@var{cmd}[@var{myval}]}, then within @var{defn} @code{#1}
+expands @var{myval}. While if @var{\cmd} is called without square
+brackets following, then within @var{defn} the @code{#1} expands to
+the default @var{optargval}.
+
+Omitting @code{[@var{myval}]} in the call is different from having the
+square brackets with no contents, as in @code{[]}. The former results
+in @code{#1} expanding to @var{optargval}; the latter results in
+ at code{#1} expanding to the empty string.
@item defn
The text to be substituted for every occurrence of @code{cmd}; a
@@ -3760,29 +3770,40 @@
@end table
-A simple example of defining a new command is that
- at domain.hid Hef at domain.hid@}} will cause the
-abbreviation @code{\JH} to be replaced by the longer text. Redefining a
-command is basically the same:
- at domain.hid QED@}@}}. When redefining a
-command, the new version can have a different number of arguments than
-the old version.
-
-
-This command definition uses arguments
- at domain.hid@}@}}, so that
- at domain.hid@}} will expand to something like
- at domain.hid}. You can use up to nine arguments so this
-command @code{\newcommand at domain.hid@}} is invoked as
+A simple example of defining a new command:
+ at code{\newcommand at domain.hid Hef at domain.hid@}} causes the abbreviation
+ at code{\JH} to be replaced by the longer text.
+
+Redefining a command is basically the same:
+ at code{\renewcommand at domain.hid QED@}@}}.
+
+Here's a command definition that uses arguments:
+
+ at example
+\newcommand at domain.hid@}@}
+ at end example
+
+ at noindent Then, @code{\defreference at domain.hid@}} will expand to
+something like @samp{Definition~3.14}.
+
+An example with two arguments:
+ at code{\newcommand at domain.hid@}} is invoked as
@code{\nbym at domain.hid@}}.
-An example of the use of optional arguments is that with this definition
- at domain.hid or Madam]@{Dear #1:@}}
-then @code{\salutation} will give @samp{Dear Sir or Madam:} while
- at domain.hid]} gives @samp{Dear John:}.
+An example with optional arguments:
+
+ at example
+\newcommand at domain.hid or Madam]@{Dear #1:@}
+ at end example
+
+ at noindent
+Then, @code{\salutation} gives @samp{Dear Sir or Madam:} while
+ at code{\salutation[John]} gives @samp{Dear John:}. And
+ at code{\salutation[]} gives @samp{Dear :}.
@c xx \ensuremath, ?xspace or at least some comment about swallowing a space.
@c xx \providecommand, * form (non-\long)
+
@node \newcounter
@section @code{\newcounter}
@@ -3796,18 +3817,18 @@
@end example
The @code{\newcounter} command globally defines a new counter named
- at domain.hid}. The new counter is initialized to zero.
-
-If the optional argument @code{[@var{supercounter}]} appears then
+ at var{countername}. The name consists of letters and does not begin
+with a backslash (@samp{\}). The new counter is initialized to zero.
+
+If the optional argument @code{[@var{supercounter}]} appears, then
@var{countername} will be numbered within, or subsidiary to, the
existing counter @var{supercounter}. For example, ordinarily
@code{subsection} is numbered within @code{section}. Any time
@var{supercounter} is incremented with @code{\stepcounter}
(@pxref{\stepcounter}) or @code{\refstepcounter}
-(@pxref{\refstepcounter}) then @var{counter} is reset to zero.
+(@pxref{\refstepcounter}) then @var{countername} is reset to zero.
+
@xref{Counters}, for more information about counters.
-
-Note that the name of each counter does not begin with a backslash (\).
@node \newlength
@@ -3864,9 +3885,10 @@
@table @var
@item @code{*}
- at domain.hid *-form of environment commands
-The *-form of these commands requires that the arguments (not the
-contents of the environment) not contain multiple paragraphs of text.
+ at cindex @code{*}-form of environment commands
+The @code{*}-form of these commands requires that the arguments (not
+the contents of the environment) not contain multiple paragraphs of
+text.
@item env
The name of the environment. For @code{\newenvironment}, @var{env}
@@ -4149,14 +4171,16 @@
@findex \refstepcounter
The @code{\refstepcounter} command works in the same way as
- at domain.hid} (@pxref{\stepcounter}), meaning that it globally
-increments the value of @var{counter} by one and resets the value of any
-counter numbered within it. (For the definition of counters numbered
-within this one, @pxref{\newcounter}.) In addition, this command also
-defines the current @code{\ref} value to be the result of
- at domain.hid}. Note that while setting the counter is done
-globally, setting the current @code{\ref} value is only valid inside the
-current group.
+ at code{\stepcounter} (@pxref{\stepcounter}): it globally increments the
+value of @var{counter} by one and resets the value of any counter
+numbered within it. (For the definition of ``counters numbered
+within'', @pxref{\newcounter}.)
+
+In addition, this command also defines the current @code{\ref} value
+to be the result of @code{\thecounter}.
+
+While the counter value is set globally, the @code{\ref} value is set
+locally, i.e., inside the current group.
@node \stepcounter
@@ -4164,8 +4188,8 @@
@findex \stepcounter
The @code{\stepcounter} command globally adds one to @var{counter} and
-resets all counters numbered within it. (For the definition of counters
-numbered within this one, @pxref{\newcounter}.)
+resets all counters numbered within it. (For the definition of
+``counters numbered within'', @pxref{\newcounter}.)
@node \day \month \year
@@ -4795,7 +4819,7 @@
@math{\mapsto}
@item \mho
-(glyph not available; it is an upside down Omega)
+(glyph not available; it is an upside-down Omega)
@c xx not in plain
@item \mid
@@ -4988,13 +5012,13 @@
@math{\sqcup} (binary operation)
@item \sqsubset
-(relation) @c not in plain (@math{\sqsubset})
+(relation) @c xx not in plain (@math{\sqsubset})
@item \sqsubseteq
@math{\sqsubseteq} (relation)
@item \sqsupset
-(relation) @c not in plain (@math{\sqsupset})
+(relation) @c xx not in plain (@math{\sqsupset})
@item \sqsupseteq
@math{\sqsupseteq} (relation)
@@ -5054,10 +5078,10 @@
@math{\triangleright} (binary operation)
@item \unlhd
-left-pointing arrowhead with line under (binary operation) @c not in plain
+left-pointing arrowhead with line under (binary operation) @c xx not in plain
@item \unrhd
-right-pointing arrowhead with line under (binary operation) @c not in plain
+right-pointing arrowhead with line under (binary operation) @c xx not in plain
@item \Uparrow
@math{\Uparrow} (delimiter)
More information about the latexrefman-commits
mailing list