[latex3-commits] [git/LaTeX3-latex3-latex2e] copyedits-chris: ltnews34: first round (083ee0b6)
Chris Rowley
car222222 at github.github.io
Sun Oct 3 05:50:39 CEST 2021
Repository : https://github.com/latex3/latex2e
On branch : copyedits-chris
Link : https://github.com/latex3/latex2e/commit/083ee0b6629eb2d44ac6caaf34336e7d99d226dc
>---------------------------------------------------------------
commit 083ee0b6629eb2d44ac6caaf34336e7d99d226dc
Author: Chris Rowley <car222222 at users.noreply.github.com>
Date: Sun Oct 3 10:50:39 2021 +0700
ltnews34: first round
Has some notes for discussion.
>---------------------------------------------------------------
083ee0b6629eb2d44ac6caaf34336e7d99d226dc
base/doc/ltnews34.tex | 211 ++++++++++++++++++++++++++------------------------
1 file changed, 110 insertions(+), 101 deletions(-)
diff --git a/base/doc/ltnews34.tex b/base/doc/ltnews34.tex
index 5cc82410..b34d6895 100644
--- a/base/doc/ltnews34.tex
+++ b/base/doc/ltnews34.tex
@@ -72,6 +72,8 @@
{github issue#1 #2}%
)}%
\par\smallskip}
+%% CCC TEMP mostly disable \href for TEXPAD
+\def\href #1{}
% simple solution right now (just link to the first issue if there are more)
\def\getfirstgithubissue#1 #2\relax{#1}
@@ -147,17 +149,19 @@
\section{Hook business}
-After the introduction of the hook management system in the 2020
+Since the introduction of the hook management system in the 2020
release of \LaTeX{}~\cite{34:ltnews32} package developers have started
-to make more and more use of the new functionality. This resulted in a
+to make more and more use of this new functionality. One result has been a
number of queries showing that some of the documentation was not
-precise enough and that one or the other clarification was
-needed. This has now been addressed in the documentation. The extended
+precise enough and that some clarifications were
+needed; these have now been addressed in the documentation.
+%
+The extended
usage also showed a small number of deficiencies that we thought
-should be corrected now while the adoption rate is still relatively
-small. These are addressed in this release and documented below.
-
+should be corrected now, while the adoption rate is still relatively
+small; these have been addressed in this release and are documented here.
+%% NOT YET CHECKED
\subsection{Providing \cs{ActivateGenericHook}}
The hook management system offers a number of generic hooks, i.e.,
@@ -216,7 +220,7 @@ document are printed. For such situations the new command
\githubissue{565}
-
+%% NOT YET CHECKED
\subsection{Clean up after \cs{UseOneTimeHook}}
Some hooks are meant to be used only once in a document, and any
@@ -239,21 +243,21 @@ and the hook code is removed after usage to free up the memory.
\subsection{Class, package, and include hook improvements}
-Classes, packages and include files can only be loaded once in a
+Classes, packages and included files can only be loaded once in a
\LaTeX{} document. For that reasons hooks that are specific to such
-files have been made one-time hooks. Beside being more efficient this
+file loading have been made one-time hooks. Beside being more efficient, this
supports the following important use case
\begin{verbatim}
\AddToHook{package/varioref/after}
- { ... apply my customizations if the package
- gets loaded (or was loaded already) ... }
+ { ... apply when the package gets loaded,
+ or apply now (if it is already loaded) ... }
\end{verbatim}
-without the need to first test if the package was already loaded
-before.
+without the need to first test whether the package is already loaded.
%
\githubissue{623}
+%% NOT YET CHECKED
\subsection{Standardizing generic hook names}
The initial set of generic hooks provided by the \LaTeXe{} kernel had
@@ -294,7 +298,7 @@ deprecated names will be turned into errors and then removed completely.
\githubissue{648}
-
+%% NOT YET CHECKED
\subsection{Changed how \cs{RemoveFromHook} treats code that isn't in the hook}
In the first version of \cs{RemoveFromHook}, in case the code label
@@ -334,54 +338,59 @@ preferred.
\subsection{Added \cs{PackageNote} and \cs{ClassNote}}
-\LaTeX{} offers \cs{PackageError} to signal errors that stop
-processing, \cs{PackageWarning} that generates a warning message on the
-terminal, but continues with the processing and also \cs{PackageInfo}
+\LaTeX{} offers these three commands:\cs{PackageError} to signal errors that stop
+processing; \cs{PackageWarning} to generate a warning message on the
+terminal but continue with the processing; and \cs{PackageInfo}
to provide some information that is only written to the \texttt{.log}
-file. What hasn't existed up to now is a way to provide some
-information on the terminal that is identifying itself as coming from
-a specific package but which isn't claiming to be a warning. Thus,
-packages that wanted to write to the terminal used \cs{PackageWarning}
-even though the information wasn't really warning the user. For this
-we now have \cs{PackageNote} and \cs{PackageNoteNoLine}, that identify
-themselves as \enquote{informational}, but still go to the terminal and
+file but not sent to the terminal.
+%
+What hasn't existed up to now is a way to provide some
+information on the terminal that identifies itself as coming from
+a specific package but which is not claiming to be a warning. (Packages that wanted to write to the terminal used \cs{PackageWarning}
+even though the information wasn't really warning the user.) We have therefore
+now added \cs{PackageNote} and \cs{PackageNoteNoLine}, that identify
+themselves as \enquote{informational}, but that still go to the terminal and
not only to the transcript.
-
-Similar commands exist for classes and there we have added the missing
-\cs{ClassNote} and \cs{ClassNoteNoLine} as well.
+% CCC ?? And: say what the NoLine means?
+Similar commands exist for classes and so there too we have added the missing
+\cs{ClassNote} and \cs{ClassNoteNoLine}.
%
\githubissue{613}
\subsection{New implementation for \cs{counterwithin}}
-New implementation for \cs{counterwithout} and \cs{counterwithin} with
-an additional optional arg so it becomes a drop-in replacement for
-amsmath \cs{numberwithin}. In the optional argument you can specify a
-counter formatting command, such as \cs{roman}, if absent it
-defaults to \cs{arabic}.
+The commands \cs{counterwithout} and \cs{counterwithin} each now has
+an additional optional argument, similar to the command
+%% so it becomes a drop-in replacement for
+ \cs{numberwithin} from \pkg{amsmath}.
+This optional argument is used to
+specify the format of the counter, such as \cs{roman}, the default value being \cs{arabic}.
\subsection{New default for \cs{tracinglostchars}}
-In 2021 the \TeX{} engines got enhanced so that \cs{tracinglostchars}
-is now also supporting the value \texttt{3}, turning missing
-characters into errors and not just warnings. This change made us
-realize that \LaTeX{} should use a better default for this parameter
-(so far the warning was only written to the transcript file).
-Using the now available \texttt{3} would really be the best, but for
+In 2021 all \TeX{} engines were enhanced so that \cs{tracinglostchars}
+supported the extra value \texttt{3}, tyat turns missing
+characters into errors and not just warnings.
+%
+This engine change made us
+realize that \LaTeX{} should set a better default value for this parameter
+(previously, the warning was written only to the transcript file).
+Using the now available \texttt{3} as the default would really be best, but for
compatibility reasons we only set it to \texttt{2} in the kernel.
+%
However, we recommend adding \cs{tracinglostchars}\texttt{=3} to the
-preamble of documents, because missing glyphs in the output are an
-error and should therefore be properly looked at.
-
+preamble of documents: this is because having missing glyphs in the output is definitely an
+error and should therefore be flagged as such (to ensure that it gets proper attention).
+%% NOT YET CHECKED
\subsection{Provide tests for package and class loading}
To test if a package was loaded you can now use \cs{IfPackageLoadedTF}
@@ -411,7 +420,7 @@ For classes similar commands (\texttt{Package} replaced by
-
+%% NOT YET CHECKED
\subsection{New \cs{ShowFloat} command}
The package \pkg{fltrace} offers a (fairly low-level but very
@@ -434,22 +443,22 @@ also useful when interpreting the tracing output of the
\subsection{Add \pkg{ltcmd} support for \cs{NewCommandCopy} and \cs{ShowCommand}}
-Since the 2020-10-01 release (see~\cite{34:ltnews32}), \LaTeX{} provides
+Since the 2020-10-01 release (see~\cite{34:ltnews32}), \LaTeX{} has provided
\cs{NewCommandCopy} to copy robust commands, and \cs{ShowCommand} to
-show their definition in the terminal. In the same release, the
-\pkg{xparse} package was integrated in the kernel (now called
+show their definitions on the terminal. In the same release, the
+\pkg{xparse} package was integrated into the kernel (as
\pkg{ltcmd}). However, the extended support for \cs{NewCommandCopy} and
\cs{ShowCommand} was not implemented in \pkg{ltcmd}. The present
-\LaTeX{} release ships with that support implemented, so now commands
-defined with \pkg{xparse}/\pkg{ltcmd} can be copied and their definition
-can be easily shown in the terminal without \cs{csname} gymnastics.
+\LaTeX{} release implements this support, so now commands
+defined with \pkg{xparse}/\pkg{ltcmd} can be copied, and their definitions
+can be easily shown on the terminal without the need for ``\cs{csname} gymnastics''.
%
\githubissue{569}
-
+%% NOT YET CHECKED
\subsection{Undo some math alphabet allocations if necessary}
\TeX{} or more exactly the 8-bit versions of \TeX, such as \pdfTeX{}
@@ -493,20 +502,21 @@ whether used or not.
\subsection{Detect ``\cs{endfoo}'' when using \cs{NewDocumentEnvironment}}
-The \cs{newenvironment} command has always checked that both \cs{foo} and
-\cs{endfoo} do not exist before creating a \texttt{foo} environment. In
-contrast, \cs{NewDocumentEnvironment} has only to date checked for \cs{foo};
-this reflects the fact that historically the code was designed around the
-target of an entirely new format. The behavior of \cs{NewDocumentEnvironment}
-now aligns with \cs{newenvironment}, except that it gives separate errors
-for the existence of \cs{foo} and \cs{endfoo}.
+The \cs{newenvironment} command has always checked that neither \cs{foo} nor
+\cs{endfoo} exists before creating a \texttt{foo} environment.
+In contrast, \cs{NewDocumentEnvironment} has to date checked only \cs{foo}.
+%% this reflects the fact that historically the code was
+%% designed around the target of an entirely new format.
+The behavior of \cs{NewDocumentEnvironment}
+now aligns with that of \cs{newenvironment}, except that it gives distinct errors
+concerning the existence of \cs{foo} and \cs{endfoo}.
-\subsection{Improve ``\cs{begin} ended by'' error message}
+\subsection{Improve the error message ``\cs{begin} ended by''}
In the past it was possible to get an error message stating something
like \verb=\begin{foo} ended by \end{foo}=. This could happen when the
-environment name was partly hidden inside a macro, because the test was
-comparing the literal strings while the error message expanded the
+environment name was partly hidden inside a macro. It happened because the test was
+comparing the literal strings while the error message expanded those
strings fully. This has now been changed to show a more sensible error
message in this instance.
%
@@ -515,18 +525,18 @@ message in this instance.
\subsection{Additional Extended Latin characters predefined}
-Some additional characters such as \'k (U+1E131) are now pre-defined and
-will work without needing \verb|\DeclareUnicodeCharacter| declarations.
+Some additional characters, such as \'k (U+1E131), are now pre-defined and
+will work without needing a \verb|\DeclareUnicodeCharacter| declaration.
%
\githubissue{593}
\subsection{Use OpenType version of Latin Modern Upright Italic}
-When Latin Modern is used with the TU encoding under \XeTeX\ or \LuaTeX\
+When a Latin Modern font is used with the TU encoding under \XeTeX\ or \LuaTeX\
and fontshape \texttt{ui} is requested, \LaTeX\ now uses the OpenType
-version instead of substituting the (T1 encoded) Type 1 version.
-
+version of the font instead of substituting the (T1-encoded) Type 1 version.
+%% NOT YET CHECKED
\subsection{Pick up all arguments to \cs{contentsline}}
The \cs{contentsline} commands in the TOC file are always followed by
@@ -546,7 +556,7 @@ that it can be used by \pkg{hyperref}.
The \LuaTeX\ callbacks \texttt{pre\_mlist\_to\_hlist\_filter}
and \texttt{post\_mlist\_to\_hlist\_filter} no longer create an error if
-the callback handler indicates to remove the entire math block.
+the callback handler indicates removal of the entire math list.
%
\githubissue{644}
@@ -563,15 +573,15 @@ the callback handler indicates to remove the entire math block.
\section{Bug fixes}
-\subsection{Replicate argument processors for all embellishments}
+\subsection{Replicate argument processors for all embellishments in command declarations}
-There was a bug in \pkg{ltcmd} (former \pkg{xparse}) that caused
+There was a bug in \pkg{ltcmd} (formerly \pkg{xparse}) that caused
commands to misbehave if they were defined with embellishments and
argument processors. In that case, only one (possibly void) argument
processor would be added to the full set of embellishment arguments,
-resulting in too few processors in some cases, leading to unpredictable
+resulting in too few processors in some cases and thus leading to unpredictable
behavior. This bug has been fixed by applying the same argument
-processors to all the embellishments in a set, so a declaration like:
+processors to all the embellishments in a set, so that a declaration like:
\begin{verbatim}
\NewDocumentCommand\foo{>{\TrimSpaces}e{_^}}
{(#1)[#2]}
@@ -587,16 +597,16 @@ will now correctly apply \cs{TrimSpaces} to both arguments.
The ligatures \enquote{\ij} and \enquote{\IJ}, as used in Dutch,
-are only available in most \TeX{} fonts, if the commands \cs{ij} or
-\cs{IJ} are used or when you enter them as UTF-8 characters U+0133 or
+are available (for most \TeX{} fonts) only
+when the commands \cs{ij} or
+\cs{IJ} are used, or when you enter them as the Unicode characters U+0133 or
U+0132.
%
However, when using \texttt{OT1} or \texttt{T1} encoded fonts in
\pdfTeX, the upper or lower casing with \cs{MakeUppercase} and
\cs{MakeLowercase} would always fail regardless of the input method.
This has now been corrected. At the same time we improved the
-hyphenation results for words containing this ligature (when
-typesetting is done in \texttt{OT1} encoding).
+hyphenation results for words containing this ligature (when using the \texttt{OT1} encoding).
%
\githubissue{658}
@@ -613,14 +623,14 @@ sans serif family without changing it for \cs{rmfamily} or \cs{ttfamily}.
See~\cite{34:ltnews31} for more details.
For backwards compatibility, changing \cs{bfdefault} with
-\cs{renewcommand} remained possible. If used, it alters the setting
-for all meta families in one go. This cannot be done when the
-\cs{renewcommand} happens and was therefore delayed until the next
+\cs{renewcommand} remained possible: if used, this alters the setting
+for all meta families in one go. This alteration cannot be done when the
+\cs{renewcommand} happens and it was therefore delayed until the next
time \cs{bfseries} or \cs{mdseries} was executed.
However, the problem with that
approach was that any call to \cs{DeclareFontSeriesDefault} that
-happened in the mean time was overwritten---the two approaches didn't
+happened in the mean time was overwritten---thus the two approaches didn't
work well side by side. This is a problem because older font packages
use the legacy method while newer ones use
\cs{DeclareFontSeriesDefault}. This has now been corrected by changing
@@ -630,12 +640,12 @@ setting new defaults.
\githubissue{663}
-\subsection{Use of \texttt{\#} in \cs{textbf} and similar commands}
+\subsection{Use of \texttt{\textup{\#}} in \cs{textbf} and similar commands}
Previously you could not use the macro parameter character \texttt{\#}
in inline functions
-in the argument of \cs{texbf} and similar text font commands.
+within the argument of \cs{texbf} or similar text font commands.
An internal definition is now guarded with \cs{unexpanded}
-so that \texttt{\#} does not generate an error.
+so that \texttt{\#} no longer generates an error.
%
\githubissue{665}
@@ -654,46 +664,45 @@ so that \texttt{\#} does not generate an error.
\subsection{Key for alt text}
-A new key \texttt{alt} has been added to \verb|\includegraphics| allowing specification
-of an alternative text for accessibility.
-This is unused by default but may be used by extension packages and possible future use.
+A new key, \texttt{alt}, has been added to \verb|\includegraphics| to support the addition of a descriptive text that is important for accessibility.
+This key is unused by default but it can be used by extension packages and it provides support for other future possibilities.
%
\githubissue{651}
-
\section{Changes to packages in the \pkg{tools} category}
-\subsection{\pkg{varioref}: Improve missing label handling}
+\subsection{\pkg{varioref}: Improve the handling of missing labels}
If an undefined label is referenced, \pkg{varioref} makes a default
definition so that later processing finds the right structure (two
brace groups inside \cs{r@}\meta{label}) However, if \pkg{nameref} or
\pkg{hyperref} is loaded, the data structure changes to five
-arguments, resulting in low-evel errors in some cases. The code has
+arguments, which led to low-evel errors in some cases. The code has now
been changed to avoid these errors.
%
\sxissue{603948}
+%% XXX END 03/10
+\subsection{\pkg{array}: Remove added \cs{mathsurround} from \env{tabular}}
-\subsection{\pkg{array}: Cancel \cs{mathsurround} for \env{tabular}}
-
-A \env{tabular} environment is internally typeset as an \env{array}
-environment with special settings and therefore in math mode. This
-math group should not get any \cs{mathsuround} added as it isn't a
-real formula because otherwise the spacing around the \env{tabular}
-changes. This bug has been there forever (which means not many people
-use \cs{mathsurround} or noticed the difference). Anyhow, this now got
-fixed.
+A \env{tabular} environment is typeset (internally) as an \env{array}
+environment with special settings, and it therefore uses math mode. Since it is not in fact a math formula, this
+no extra space from \cs{mathsuround} shpuld be added (the spacing around the \env{tabular}
+should not get changed).
+%
+Note that this bug has been present ``forever'', which shows that \cs{mathsurround} is never used, or at least its use is never noticed. Anyhow, this bug has now finally gotten fixed.
%
\githubissue{614}
\subsection{\pkg{longtable}: Improve behavior after a section heading}
-The \env{longtable} environment now sets the \cs{@nobreakfalse} flag so that
-spacing and indentation changes after a section heading are not triggered by
-a paragraph which follows a table which starts a section. Similarly a test for
-\cs{if at noskipsec} added so that a table follows a run-in heading
-rather than appearing before it.
+The \env{longtable} environment now sets the \cs{@nobreakfalse} flag to correct the typesetting when a table immediately follows a heading. Previously the
+spacing and indentation changes that are required after a section heading were incorrectly triggered in
+a paragraph which followed the table.
+%
+A similar test for
+\cs{if at noskipsec} has been added, so that a table is placed after a run-in heading
+rather than appearing before that heading.
%
\githubissue[s]{131 and 173}
More information about the latex3-commits
mailing list.