[latex3-commits] [git/LaTeX3-latex3-latex2e] typo-fix: Update classes.dtx to tackle #430, also remediated some other inconsistent wording. [ci skip] (6efae2cc)
Johannes Braams
texniek at braams.xs4all.nl
Mon Nov 23 19:30:33 CET 2020
Repository : https://github.com/latex3/latex2e
On branch : typo-fix
Link : https://github.com/latex3/latex2e/commit/6efae2ccf0dbe89146bc436b80d2ec8db915f82f
>---------------------------------------------------------------
commit 6efae2ccf0dbe89146bc436b80d2ec8db915f82f
Author: Johannes Braams <texniek at braams.xs4all.nl>
Date: Mon Nov 23 19:30:33 2020 +0100
Update classes.dtx to tackle #430, also remediated some other inconsistent wording. [ci skip]
>---------------------------------------------------------------
6efae2ccf0dbe89146bc436b80d2ec8db915f82f
base/classes.dtx | 91 +++++++++++++++++++++++++++++---------------------------
1 file changed, 47 insertions(+), 44 deletions(-)
diff --git a/base/classes.dtx b/base/classes.dtx
index d6f2bb64..6188509b 100644
--- a/base/classes.dtx
+++ b/base/classes.dtx
@@ -53,7 +53,7 @@
%<*driver>
\ProvidesFile{classes.drv}
%</driver>
- [2020/04/10 v1.4m
+ [2020/11/23 v1.4m
%<article|report|book> Standard LaTeX document class]
%<10pt|11pt|12pt> Standard LaTeX file (size option)]
% \end{macrocode}
@@ -423,7 +423,7 @@
%<!article>\fi
% \end{macrocode}
%
-% \subsection{Twocolumn printing}
+% \subsection{Two-column printing}
%
% Two-column and one-column printing is again realized via a switch.
% \begin{macrocode}
@@ -788,7 +788,7 @@
% \begin{macro}{\parindent}
% |\parskip| gives extra vertical space between paragraphs and
% |\parindent| is the width of the paragraph indentation. The value
-% of |\parindent| depends on whether we are in two column mode.
+% of |\parindent| depends on whether we are in two-column mode.
% \changes{v1.0m}{1994/01/12}{\cs{parindent} should be different,
% depending on the pointsize}
% \begin{macrocode}
@@ -998,7 +998,7 @@
% Now we can set the |\textwidth|, depending on whether we will be
% setting one or two columns.
%
-% In two column mode each \emph{column} shouldn't be wider than
+% In two-column mode each \emph{column} shouldn't be wider than
% |\@tempdimb| (which could happen on \textsc{a3} paper for
% instance).
% \begin{macrocode}
@@ -1010,7 +1010,7 @@
\fi
% \end{macrocode}
%
-% In one column mode the text should not be wider than the minimum
+% In one-column mode the text should not be wider than the minimum
% of the paperwidth (minus 2 inches for the margins) and the
% maximum length of a line as defined by the number of characters.
% \begin{macrocode}
@@ -1168,7 +1168,7 @@
\fi
%</!bk>
% \end{macrocode}
-% And values for two column mode:
+% And values for two-column mode:
% \begin{macrocode}
\if at twocolumn
\setlength\oddsidemargin {30\p@}
@@ -1389,7 +1389,7 @@
%
% \begin{macro}{\c at dbltopnumber}
% The \Lcount{dbltopnumber} counter holds the maximum number of
-% two column floats that can appear on the top of a two column text
+% two-column floats that can appear on the top of a two-column text
% page.
% \begin{macrocode}
\setcounter{dbltopnumber}{2}
@@ -1397,8 +1397,8 @@
% \end{macro}
%
% \begin{macro}{\dbltopfraction}
-% This indicates the maximum part of a two column text page that
-% can be occupied by two column floats at the top.
+% This indicates the maximum part of a two-column text page that
+% can be occupied by two-column floats at the top.
% \changes{v1.0h}{1993/12/18}{Replaced \cs{newcommand} with
% \cs{renewcommand}. ASAJ.}
% \begin{macrocode}
@@ -1408,7 +1408,7 @@
%
% \begin{macro}{\dblfloatpagefraction}
% This indicates the minimum part of a page that has to be
-% occupied by two column wide floating objects before a `float
+% occupied by two-column wide floating objects before a `float
% page' is produced.
% \changes{v1.0h}{1993/12/18}{Replaced \cs{newcommand} with
% \cs{renewcommand}. ASAJ.}
@@ -1459,7 +1459,7 @@
% \begin{macro}{\dblfloatsep}
% \begin{macro}{\dbltextfloatsep}
% When floating objects that span the whole |\textwidth| are placed
-% on a text page when we are in twocolumn mode the separation
+% on a text page when we are in two-column mode the separation
% between the float and the text is controlled by |\dblfloatsep|
% and |\dbltextfloatsep|.
%
@@ -1498,7 +1498,7 @@
% whitespace. Between adjacent floats the |\@fpsep| is inserted.
%
% These parameters are used for the placement of floating objects
-% in one column mode, or in single column floats in two column
+% in one-column mode, or in single-column floats in two-column
% mode.
%
% Note that at least one of the two parameters |\@fptop| and
@@ -1528,7 +1528,7 @@
% \begin{macro}{\@dblfptop}
% \begin{macro}{\@dblfpsep}
% \begin{macro}{\@dblfpbot}
-% Double column floats in two column mode are handled with similar
+% Double-column floats in two-column mode are handled with similar
% parameters.
% \begin{macrocode}
%<*10pt>
@@ -1872,7 +1872,7 @@
% \end{macrocode}
% When the title is not on a page of its own, the layout of the
% title is a little different. We use symbols to mark the footnotes
-% and we have to deal with two column documents.
+% and we have to deal with two-column documents.
%
% Therefore we first start a new group to keep changes local. Then
% we redefine |\thefootnote| to use |\fnsymbol|; and change
@@ -1893,7 +1893,7 @@
\hb at xt@1.8em{%
\hss\@textsuperscript{\normalfont\@thefnmark}}##1}%
% \end{macrocode}
-% If this is a twocolumn document we start a new page in twocolumn
+% If this is a two-column document we start a new page in two-column
% mode, with the title set to the full width of the text. The
% actual printing of the title information is left to
% |\@maketitle|.
@@ -1908,7 +1908,7 @@
\fi
\else
% \end{macrocode}
-% When this is not a twocolumn document we just start a new page,
+% When this is not a two-column document we just start a new page,
% prevent floating objects from appearing on the top of this page
% and print the title information.
% \begin{macrocode}
@@ -2281,7 +2281,7 @@
\fi
\thispagestyle{plain}%
% \end{macrocode}
-% When we are making a two column document, this will be a one
+% When we are making a two-column document, this will be a one
% column page. We use |@tempswa| to remember to switch back to two
% columns.
% \begin{macrocode}
@@ -2453,8 +2453,8 @@
\fi
\fi
% \end{macrocode}
-% When this was a two column document we have to switch back to two
-% column mode.
+% When this was a two-column document we have to switch back to
+% two-column mode.
% \begin{macrocode}
\if at tempswa
\twocolumn
@@ -2522,8 +2522,8 @@
% \end{macrocode}
% Then we call upon |\@makechapterhead| to format the actual
% chapter title. We have to do this in a special way when we are in
-% twocolumn mode in order to have the chapter title use the entire
-% |\textwidth|. In one column mode we call |\@afterheading| which
+% two-column mode in order to have the chapter title use the entire
+% |\textwidth|. In one-column mode we call |\@afterheading| which
% takes care of suppressing the indentation.
% \begin{macrocode}
\if at twocolumn
@@ -2705,7 +2705,7 @@
% \changes{v1.3q}{1995/12/20}{Temporary(?) fix: revert to setting
% \cs{leftmargin} at outer level}
%
-% When we are in two column mode some of the margins are set somewhat
+% When we are in two-column mode some of the margins are set somewhat
% smaller.
% \begin{macrocode}
\if at twocolumn
@@ -3036,7 +3036,7 @@
{\par\vfil\null\endtitlepage}
% \end{macrocode}
% When we are not making a separate titlepage --the default for the
-% article document class-- we have to check if we are in twocolumn
+% article document class-- we have to check if we are in two-column
% mode. In that case the abstract is as a |\section*|, otherwise
% the quotation environment is used to typeset the abstract.
% \begin{macrocode}
@@ -3125,13 +3125,16 @@
%
% \begin{environment}{titlepage}
% In the normal environments, the titlepage environment does nothing
-% but start and end a page, and inhibit page numbers. In the report
-% style, it also resets the page number to one, and then sets it
-% back to one at the end. In compatibility mode, it sets the
-% page number to zero. This is incorrect since it results in using
-% the page parameters for a right-hand page but it is the way it was.
-% In two-column style, it still makes a
-% one-column page.
+% but start and end a page, and inhibit page numbers. When \LaTeX\ is
+% in two-column mode, the environmont temporarily switches to
+% one-column mode.
+% In the report class, it also resets the page number to one, and
+% then, in two-column mode, sets it back to one at the end.
+% For the book class the environment makes sure that the title page
+% is on a recto page by issueing a \cs{\cleardouplepage}-command.
+% In compatibility mode, it sets the page number to zero. This is
+% incorrect since it results in using the page parameters for a
+% right-hand page but it is the way it was.
%
% \changes{v1.0g}{1993/12/09}{Moved the setting of
% \cs{@restonecolfalse}}
@@ -3291,7 +3294,7 @@
% \begin{macro}{\@minipagerestore}
% The macro |\@minipagerestore| is called upon entry to a minipage
% environment to set up things that are to be handled differently
-% inside a minipage environment. In the current styles, it does
+% inside a minipage environment. In the current classes, it does
% nothing.
% \end{macro}
%
@@ -3397,7 +3400,7 @@
% a figure is defined using the macros |\@float| and |\end at float|,
% which are defined in \file{latex.dtx}.
%
-% An environment that implements a single column floating object is
+% An environment that implements a single-column floating object is
% started with |\@float{|\texttt{TYPE}|}[|\meta{placement}|]| of type
% \texttt{TYPE} with \meta{placement} as the placement specifier.
% The default value of \meta{PLACEMENT} is defined by |\fps at TYPE|.
@@ -3449,7 +3452,7 @@
% \begin{environment}{figure}
% \begin{environment}{figure*}
% And the definition of the actual environment. The form with the
-% |*| is used for double column figures.
+% |*| is used for double-column figures.
% \begin{macrocode}
\newenvironment{figure}
{\@float{figure}}
@@ -3506,7 +3509,7 @@
% \begin{environment}{table}
% \begin{environment}{table*}
% And the definition of the actual environment. The form with the
-% |*| is used for double column tables.
+% |*| is used for double-column tables.
% \begin{macrocode}
\newenvironment{table}
{\@float{table}}
@@ -3743,7 +3746,7 @@
% \begin{macro}{\tableofcontents}
% This macro is used to request that \LaTeX{} produces a table of
% contents. In the report and book document classes the tables of
-% contents, figures etc. are always set in single-column style.
+% contents, figures etc. are always set in single-column mode.
%
% \changes{v1.0g}{1993/12/09}{Moved the setting of
% \cs{@restonecolfalse}}
@@ -3778,7 +3781,7 @@
\MakeUppercase\contentsname}{\MakeUppercase\contentsname}}%
% \end{macrocode}
% The actual table of contents is made by calling
-% |\@starttoc{toc}|. After that we restore twocolumn mode if
+% |\@starttoc{toc}|. After that we restore two-column mode if
% necessary.
% \begin{macrocode}
\@starttoc{toc}%
@@ -4238,9 +4241,9 @@
\columnsep 35\p@
\let\item\@idxitem}
% \end{macrocode}
-% When the document continues after the index and it was a one
-% column document we have to switch back to one column after the
-% index.
+% When the document continues after the index and it was a
+% one-column document we have to switch back to one column after
+% the index.
% \begin{macrocode}
{\if at restonecol\onecolumn\else\clearpage\fi}
% \end{macrocode}
@@ -4293,7 +4296,7 @@
%
% \begin{macro}{\c at footnote}
% Footnotes are numbered within chapters in the report and book
-% document styles.
+% document classes.
% \begin{macrocode}
%<!article>\@addtoreset{footnote}{chapter}
% \end{macrocode}
@@ -4433,18 +4436,18 @@
% \end{macrocode}
% \end{macro}
%
-% \subsection{Two column mode}
+% \subsection{Two-column mode}
%
% \begin{macro}{\columnsep}
-% This gives the distance between two columns in two column mode.
+% This gives the distance between two columns in two-column mode.
% \begin{macrocode}
\setlength\columnsep{10\p@}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\columnseprule}
-% This gives the width of the rule between two columns in two
-% column mode. We have no visible rule.
+% This gives the width of the rule between two columns in
+% two-column mode. We have no visible rule.
% \begin{macrocode}
\setlength\columnseprule{0\p@}
% \end{macrocode}
More information about the latex3-commits
mailing list.