[latexrefman-commits] [SCM] latexrefman updated: r833 - trunk
karl at gnu.org.ua
karl at gnu.org.ua
Thu Sep 10 23:14:51 CEST 2020
Author: karl
Date: 2020-09-11 00:14:50 +0300 (Fri, 11 Sep 2020)
New Revision: 833
Modified:
trunk/ChangeLog
trunk/latex2e.texi
Log:
declaration form explanations
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2020-09-06 17:14:57 UTC (rev 832)
+++ trunk/ChangeLog 2020-09-10 21:14:50 UTC (rev 833)
@@ -1,3 +1,12 @@
+2020-09-10 Karl Berry <karl at freefriends.org>
+
+ * latex2e.texi (@LaTeX{} command syntax): omit declaration form
+ here, as it's not exactly syntax.
+ (Environment): @var{environment-name} instead of with space.
+ (Font styles, Font sizes): reword declaration-related info.
+ (\frontmatter & \mainmatter & \backmatter): not declarations.
+ (\@@startsection): fewer words in list of defaults.
+
2020-09-06 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
* NEWS-fr: September 2020 version delivery note.
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2020-09-06 17:14:57 UTC (rev 832)
+++ trunk/latex2e.texi 2020-09-10 21:14:50 UTC (rev 833)
@@ -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 2020
+ at set UPDATED September 2020
@include common.texi
@settitle @LaTeX{}2e unofficial reference manual (@value{UPDATED})
@comment %**end of header (This is for running Texinfo on a region.)
@@ -527,12 +527,6 @@
the first character of the following text be an open square bracket,
hide it inside curly braces.
-Some of @LaTeX{}'s commands are a @dfn{declaration}. Such a command
-changes the value the meaning of some other command or parameter. For
-instance, the @code{\mainmatter} declaration changes the typesetting of
-page numbers from roman numerals to arabic (@pxref{\frontmatter &
-\mainmatter & \backmatter}).
-
@LaTeX{} has the convention that some commands have a @code{*} form that
is related to the form without a @code{*}, such as @code{\chapter} and
@code{\chapter*}. The exact difference in behavior varies from command
@@ -548,9 +542,9 @@
Synopsis:
@example
-\begin@{@var{environment name}@}
+\begin@{@var{environment-name}@}
...
-\end@{@var{environment name}@}
+\end@{@var{environment-name}@}
@end example
An area of @LaTeX{} source, inside of which there is a distinct
@@ -568,8 +562,8 @@
that every @LaTeX{} document must have a @code{document} environment,
a @code{\begin@{document@} ... \end@{document@}} pair.
-The @var{environment name} at the beginning must exactly match that at
-the end. This includes the case where @var{environment name} ends in a
+The @var{environment-name} at the beginning must exactly match that at
+the end. This includes the case where @var{environment-name} ends in a
star at tie{}(@code{*}); both the @code{\begin} and @code{\end} texts must
include the star.
@@ -935,9 +929,9 @@
document font size.
@item
-Finally, in the @dfn{more declarations part} the class or package usually does
-most of its work: declaring new variables, commands and fonts, and
-loading other files.
+Finally, in the @dfn{more declarations part} the class or package
+usually does most of its work: declaring new variables, commands and
+fonts, and loading other files.
@end enumerate
Here is a starting class file, which should be saved as @file{stub.cls}
@@ -1064,10 +1058,10 @@
@code{\ProcessOptions}).
If you request an option that has not been declared, by default this
-will produce a warning like @code{Unused global option(s): [badoption].}
-Change this behavior with the starred version
- at code{\DeclareOption*@{@var{code}@}}. For example, many classes extend
-an existing class, using a declaration such as
+will produce a warning like @code{Unused global option(s):
+[badoption].} Change this behavior with the starred version
+ at code{\DeclareOption*@{@var{code}@}}. For example, many classes
+extend an existing class, using a command such as
@code{\LoadClass@{article@}}, and for passing extra options to the
underlying class use code such as this.
@@ -2024,18 +2018,20 @@
The following type style commands are supported by @LaTeX{}.
+ at cindex declaration form of font style commands
In the table below the listed commands, the @code{\text...} commands,
is used with an argument, as in @code{\textit@{@var{text}@}}. This is
the preferred form. But shown after it, in parenthesis, is the
-corresponding declaration form, which is sometimes useful. This form
-takes no arguments, as in @code{@{\itshape @var{text}@}}. The scope of
-the declaration form lasts until the next type style command or the end
-of the current group. In addition, each has an environment form such as
- at code{\begin@{itshape@}...\end@{itshape@}}.
+corresponding @dfn{declaration form}, which is often useful. This
+form takes no arguments, as in @code{@{\itshape @var{text}@}}. The
+scope of the declaration form lasts until the next type style command
+or the end of the current group. In addition, each has an environment
+form such as @code{\begin@{itshape@}...\end@{itshape@}}, which we'll
+describe further at the end of the section.
-These commands, in both the argument form and the declaration form, are
-cumulative; for instance you can get bold sans serif by saying either of
- at code{\sffamily\bfseries} or @code{\bfseries\sffamily}.
+These commands, in any form, are cumulative; for instance you can get
+bold sans serif by saying either of @code{\sffamily\bfseries} or
+ at code{\bfseries\sffamily}.
@findex \nocorrlist
@findex \nocorr
@@ -2269,9 +2265,8 @@
@tab 24.88 @tab 24.88 @tab 24.88
@end multitable
- at cindex declaration form of font size commands
-The commands are listed here in @dfn{declaration forms}. You use them by
-declaring them, as with this example.
+The commands are listed here in declaration (not environment) form.
+since that is how they are typically used. For example.
@example
\begin@{quotation@} \small
@@ -2285,7 +2280,7 @@
style command or the end of the current group, so you could enclose it
in curly braces @code{@{\small This text is typeset in the small font.@}}.
- at cindex environment form of commands
+ at cindex environment form of font size commands
An @dfn{environment form} of each of these commands is also defined; for
instance, @code{\begin@{tiny@}...\end@{tiny@}}. However, in practice
this form can easily lead to unwanted spaces at the beginning and/or
@@ -2297,8 +2292,7 @@
technically has an environment form. But in almost all cases, it would
only cause confusion to use it. The reason for mentioning the
environment form of the font size declarations specifically is that
-this particular use turns out to be rather common, despite its
-problems.)
+this particular use is not rare.)
@node Low-level font commands
@@ -3777,23 +3771,27 @@
@node \frontmatter & \mainmatter & \backmatter
-
@section @code{\frontmatter}, @code{\mainmatter}, @code{\backmatter}
@findex \frontmatter
@cindex book, front matter
+ at cindex front matter of a book
@findex \mainmatter
@cindex book, main matter
@findex \backmatter
@cindex book, back matter
- at cindex book, end matter
+ at cindex back matter of a book
+ at cindex end matter of a book
-Synopsis, one of:
+Synopsis, one or more of:
@example
\frontmatter
+...
\mainmatter
+...
\backmatter
+...
@end example
Format a @code{book} class document differently according to which part
@@ -3806,16 +3804,20 @@
back matter may contain such things as a glossary, notes, a
bibliography, and an index.
-The @code{\frontmatter} declaration makes the pages numbered in
-lowercase roman, and makes chapters not numbered, although each
-chapter's title appears in the table of contents; if you use other
-sectioning commands here, use the @code{*}-version (@pxref{Sectioning}).
-The @code{\mainmatter} changes the behavior back to the expected
-version, and resets the page number. The @code{\backmatter} leaves the
-page numbering alone but switches the chapters back to being not
-numbered. @xref{Larger book template}, for an example using the three.
+The @code{\frontmatter} command makes the pages numbered in lowercase
+roman, and makes chapters not numbered, although each chapter's title
+appears in the table of contents; if you use other sectioning commands
+here, use the @code{*}-version (@pxref{Sectioning}).
+The @code{\mainmatter} command changes the behavior back to the expected
+version, and resets the page number.
+The @code{\backmatter} command leaves the page numbering alone but
+switches the chapters back to being not numbered.
+
+ at xref{Larger book template}, for an example using these three commands.
+
+
@node \@@startsection
@section @code{\@@startsection}, typesetting sectional unit headings
@@ -3983,26 +3985,28 @@
These are @LaTeX{}'s defaults for the first three sectioning units that
are defined with @code{\@@startsection}, for the @file{article},
@file{book}, and @file{report} classes.
+
@itemize
@item
-For section, the @var{level} is 1, the @var{indent} is 0 at dmn{pt}, the
- at var{beforeskip} is @code{-3.5ex plus -1ex minus -0.2ex}, the
- at var{afterskip} is @code{2.3ex plus 0.2ex}, and the @var{style} is
+For @code{section}: @var{level} is 1, @var{indent} is 0 at dmn{pt},
+ at var{beforeskip} is @code{-3.5ex plus -1ex minus -0.2ex},
+ at var{afterskip} is @code{2.3ex plus 0.2ex}, and @var{style} is
@code{\normalfont\Large\bfseries}.
+
@item
-For subsection, the @var{level} is 2, the @var{indent} is 0 at dmn{pt}, the
- at var{beforeskip} is @code{-3.25ex plus -1ex minus -0.2ex}, the
- at var{afterskip} is @code{1.5ex plus 0.2ex}, and the @var{style} is
+For @code{subsection}: @var{level} is 2, @var{indent} is 0 at dmn{pt},
+ at var{beforeskip} is @code{-3.25ex plus -1ex minus @w{-0.2ex}},
+ at var{afterskip} is @code{1.5ex plus 0.2ex}, and @var{style} is
@code{\normalfont\large\bfseries}.
+
@item
-For subsubsection, the @var{level} is 3, the @var{indent} is 0 at dmn{pt},
-the @var{beforeskip} is @code{-3.25ex plus -1ex minus -0.2ex}, the
- at var{afterskip} is @code{1.5ex plus 0.2ex}, and the @var{style} is
+For @code{subsubsection}: @var{level} is 3, @var{indent} is 0 at dmn{pt},
+ at var{beforeskip} is @code{-3.25ex plus -1ex minus -0.2ex},
+ at var{afterskip} is @code{1.5ex plus 0.2ex}, and @var{style} is
@code{\normalfont\normalsize\bfseries}.
@end itemize
-
-Here are examples. They go either in a package or class file or in the
+Some examples follow. These go either in a package or class file or in the
preamble of a @LaTeX{} document. If you put them in the preamble they
must go between a @code{\makeatletter} command and a
@code{\makeatother}. (Probably the error message @code{You can't use
@@ -20602,7 +20606,6 @@
\author{Alex Author}
\includeonly{%
- frontcover,
preface,
chap1,
...
@@ -20620,7 +20623,7 @@
\include{chap1}
...
\appendix
-\include{appena}
+\include{appenA}
...
\backmatter
More information about the latexrefman-commits
mailing list.