[latex3-commits] [git/LaTeX3-latex3-latex2e] develop: copyediting (76aec3b0)
Frank Mittelbach
frank.mittelbach at latex-project.org
Fri Sep 13 12:57:57 CEST 2019
Repository : https://github.com/latex3/latex2e
On branch : develop
Link : https://github.com/latex3/latex2e/commit/76aec3b0a78caae5d517381a3389fbb5efe3b366
>---------------------------------------------------------------
commit 76aec3b0a78caae5d517381a3389fbb5efe3b366
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date: Fri Sep 13 12:57:57 2019 +0200
copyediting
>---------------------------------------------------------------
76aec3b0a78caae5d517381a3389fbb5efe3b366
base/doc/ltnews30.tex | 332 +++++++++++++++++++++++++++++++-------------------
1 file changed, 208 insertions(+), 124 deletions(-)
diff --git a/base/doc/ltnews30.tex b/base/doc/ltnews30.tex
index 86c70820..fd435958 100644
--- a/base/doc/ltnews30.tex
+++ b/base/doc/ltnews30.tex
@@ -54,7 +54,7 @@
\quad\penalty500\strut\nobreak\hfill
\mbox{\small\slshape(%
\href{https://github.com/latex3/latex2e/issues/\getfirstgithubissue#2 \relax}%
- {github issue#1 #2}%
+ {github issue#1 #2}%
)}%
\par}
@@ -69,7 +69,7 @@
\quad\penalty500\strut\nobreak\hfill
\mbox{\small\slshape(%
\href{https://www.latex-project.org/cgi-bin/ltxbugs2html?pr=#1\%2F#2}%
- {gnats issue #1/#2}%
+ {gnats issue #1/#2}%
)}%
\par}
@@ -113,7 +113,7 @@
\fi
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\publicationmonth{Pre-release Version --- unfinished}
+\publicationmonth{October}
\publicationyear{2019}
\publicationissue{30}
@@ -127,11 +127,15 @@
\setlength\rightskip{0pt plus 3em}
-\newpage
+%\newpage
-\section{Introduction}
+\medskip
-This document is under construction \ldots
+
+%%CCC Does it need an intro?
+%% \section{Introduction}
+
+%% This document is under construction \ldots
\section{\LaTeX\texttt{-dev} formats now available}
@@ -176,7 +180,8 @@ of important packages) will use the new facilities and help us to
ensure that future public releases of \LaTeX{} do not (as has happened in
the past) require some immediate patches because of issues that were
not identified by our internal regression test suite or by other
-testing that we do.
+testing
+we do.
Any issue identified when using the development format should
preferably be logged as an issue on GitHub, following the procedure
@@ -201,7 +206,7 @@ the process is available in an upcoming TUGboat article: \enquote{The
\subsection{Setting up menu items}
While the command line call works out of the box if you have a recent
-up-to-date \TL{} or \MiKTeX{} installation, the use within an integrated
+\TL{} or \MiKTeX{} installation, the use within an integrated
editing environment doesn’t at this point in time (maybe the
developers of these editors will include it in the future). However,
it is normally fairly simple to enable it as most (or even all?) of
@@ -219,17 +224,21 @@ call from \texttt{xelatex} to \texttt{xelatex-dev} inside.
\section{Improving Unicode handling in \pdfTeX{}}
-The perhaps most important improvement in this release is an even
+Perhaps the most important improvement in this release is
+even
better support for UTF-8 characters when using \pdfTeX{}.\footnote{The
Japanese engines e-p\TeX{} and e-up\TeX{} can't use these features
yet as they don't support the primitive \cs{ifincsname}. Work is
under way to resolve this in the engines.}
-In Unicode engines any Unicode character (that is not acting as a
-command, i.e., is \enquote{active}) can be used as part of the
+When using a \enquote{Unicode engine},
+any Unicode character (that is not acting as a command,
+i.e., is not \enquote{active})
+can be used as part of the
\cs{label}/\cs{ref} mechanism or can be displayed in a message or
written to a file. In 8-bit engines, however, this was severely
-restricted, essentially you had to limit yourself to using
+restricted:
+essentially you had to limit yourself to using
\acro{ascii} letters, digits and a few punctuation symbols. With the
new release most of these restrictions have been removed and you now
can write labels such as
@@ -239,11 +248,18 @@ can write labels such as
or use accented characters, etc.\ as part of a \cs{typeout} message.
The only requirement remaining is that only those UTF-8 characters
that are also available for typesetting can be used, i.e., only those
+characters for
which adequate font support is loaded. Otherwise you will get an
-error message stating that a particular Unicode character is not set
+error message stating that
+the
+particular Unicode character is not set
up for use with \LaTeX{}.
-What is not possible with an 8-bit engine such as \pdfTeX{} is to use
+Note, however, that the restrictions on what characters can be
+used in the names of commands have not changed.
+
+What is not possible when using
+an 8-bit engine such as \pdfTeX{} is to use
characters other than \acro{ascii} letters as part of a command
name. This is due to the fact that all other characters in such
engines are not single character tokens, but in fact consist of a
@@ -252,31 +268,45 @@ sequence of bytes and this is not supported in command names.
\section{Improving file name handling in \pdfTeX{}}
A related change is that file names used as part of \cs{input},
-\cs{includegraphics}, etc.\ can now contain Unicode characters as well
-as spaces. In this case even characters that can't be typeset because
-of missing font support can be used.
+\cs{includegraphics}, etc.\ commands
+can now contain any
+Unicode characters allowed by the File System in use,
+including spaces.
+In this case,
+ even characters that can't be typeset
+(due to lack of font support) can be used.
-\section{Improve the \env{filecontents} environment}
+\section{Improving the \env{filecontents} environment}
The \env{filecontents} environment now supports an optional argument
in which you can specify that it is allowed to \option{overwrite} an
-already existing file, by default nothing is written if the file
+already existing file;
+ by default nothing is written if a file with the given name
exists anywhere in the search tree. An alternative name for this
-option is \texttt{force}. Even then the environment will refuse to write
+option is \texttt{force}.
+Even then the environment will refuse to write
to \cs{jobname}\texttt{.tex} to avoid clobbering its own input
file. However, if you use a different extension on your input file you
could still overwrite it (there is no way to test for that).
-With the option \option{nosearch} only the current directory is
-examined not the \TeX{} tree. This is useful if you want to write a
+There is also an
+option
+\option{nosearch},
+which specifies that only the current directory is
+examined for an existing file, not the whole \TeX{} inputs tree.
+This is useful if you want to write a
local copy of a standard system file.
Finally, \option{noheader} prevents writing a preamble to the file
-(which is the same as using the star form of the environment.
+(this
+is the same as using the star form of the environment).
-The environment is now allowed anywhere in the document which means
-it provides everything (and more than) the \pkg{filecontents}
-package provided in the past.
+Another change is that this
+environment is
+now allowed anywhere in the document,
+which means
+it provides everything (and more) of what the now obsolete
+\pkg{filecontents} package provided.
@@ -284,18 +314,20 @@ package provided in the past.
In the early days of \LaTeX{} many commands were fragile, i.e., they
needed \cs{protect} in front of them when used in places such as
-section headings etc. With \LaTeXe{} already many were made robust,
+section headings and other \enquote{moving arguments}, etc.
+In \LaTeXe{} many of these commands were made robust,
but still a fairly huge number remained unnecessarily fragile.
-In this release of \LaTeX{} we have now tackled most of the remaining
-ones, except for a few that for one or the other reasons need to
-always expand (at least partially) or where it is rather unlikely that
-they are ever needed in a so-called \enquote{moving argument}.
+In this release of \LaTeX{} we have now
+made a lot more commands robust.
+There is a very small collection of commands that must stay fragile
+because their expansion (maybe partially) at just the right time is critical.
+Yet others are unlikely to ever be needed in an \enquote{moving argument}.
Doing this for \cs{begin} and \cs{end} was rather tricky as the
standard mechanism with \cs{DeclareRobustCommand} doesn't work here,
at least not for \cs{end} as that needs to expand during typesetting
-without generating a \cs{relax} (from the \cs{protect}). Such a token
+without generating a \cs{relax} (from the \cs{protect}. Such a token
would start a new row in table environments, such as \texttt{tabular}
etc. Furthermore some packages try to look into the definition of
\cs{end} by expanding it several times. Thus expansion with
@@ -304,10 +336,16 @@ in the end we overcame that hurdle too, so now environments are
automatically robust if used in places like headings or
\verb=\typeout= and so forth.
-What hasn't been tackled yet is \pkg{amsmath}. As this package
-redefines a number of basic math constructs they become fragile again
-once the package is loaded. This area will be addressed in a follow up
-release.
+%%CCC do we need to say something about possible problems if other packages
+%% or documents have redefined commands whose robustness has changed?
+
+What hasn't been tackled yet is the redefinitions in \pkg{amsmath}:
+this package
+redefines a number of basic math constructs
+that are now robust, so that
+they become fragile again
+once the package is loaded.
+This area will be addressed in a follow up release.
\githubissue{123}
@@ -315,39 +353,47 @@ release.
\section{Other changes to the \LaTeX{} kernel}
+\subsection{Guard against \cs{unskip} in tabular cells}
-\subsection{Guard against \cs{unskip} at the start of a tabular cell}
-
-If a \env{tabular} or \env{array} cell started with command that
-issued an \cs{unskip} as its first action centering the column got
-broken because the space on the left got removed. This got corrected
-by adding a minuscule additional space after the stretching space that
-could be safely removed in such a case without being noticeable.
+If a \env{tabular} or \env{array} cell started with a
+command that started with an
+\cs{unskip}
+then centering the column broke
+ because the stretching glue
+ on the left got removed. The fix for this was to add
+ a minuscule, and hence unnoticeable, additional space after the stretching space:
+removing this extra space causes no problems.
This change was also applied in the \pkg{array} package.
\githubissue{102}
-\subsection{Fixes to Unicode table data}
+\subsection{Fix Unicode table data}
-\texttt{U+012F} which is \enquote{i with ogonek} should produce an
-\enquote{i} and not a \enquote{dotless i}. This has been corrected.
+\texttt{U+012F} which is \enquote{i with ogonek} produced a
+\enquote{dotless i with ogonek} by mistake. This has been corrected.
\githubissue{122}
The Unicode slots \texttt{27E8} and \texttt{27E9} have been mapped to
\cs{textlangle} and \cs{textrangle} which is the recommended mapping.
+In the past they raised a \LaTeX{} error.
\githubissue{110}
-When doing cut-and-paste from other documents f-ligatures might show
-up as Unicode characters. In the past those got rejected. We now
-translate them back to individual characters so that they get
-accepted. If supported by the font (which is normally the case) they
-are then reconstructed as ligatures and thus come out as
-desired. Otherwise they will come out as individual characters which
-is fine too.
+When doing cut-and-paste from other documents or websites f-ligatures and others ligatures
+might end up as
+single Unicode characters in your file. In the past those got rejected by \LaTeX{}.
+ We
+ now define those Unicode slots and map them back to the sequence of
+ individual characters constituting the ligature.
+If supported by the current font
+(which is normally the case) they
+are then reconstructed as ligatures and thus get typeset
+as desired.
+Otherwise they will come out as individual characters which
+is still better than an error message.
\githubissue{154}
@@ -365,48 +411,63 @@ would load \texttt{foo.tex} twice. This has been corrected.
\githubissue{109}
-\subsection{Provide slightly improved reference interface}
-
-The packages \pkg{fncylab} and \pkg{varioref} provided a slightly
-improved definition of \cs{refstepcounter} which allowed the internal
-\cs{p at ...} commands to receive the counter value as an argument instead
-of just acting as a simple prefix. Then way more complex reference
-value formatting can be carried out. They also defined the command
-\cs{labelformat} to specify such formatting in an easy way. For
-example, \verb=\labelformat{equation}{eq.~(#1}}= would result in
-references to equations would come out automatically as
-\enquote{eq.~(5)} or similar. As this means a \cs{ref} command can't
-any longer be used at a start of a sentence, the packages also
+\subsection{Improve interface for cross-references}
+
+%%CCC should be 'provide' as they still exist. FMi - no they no longer do that
+The packages \pkg{fcnylab} and \pkg{varioref} provided
+a slightly
+improved definition of \cs{refstepcounter} which allowed
+the internal
+\cs{p at ..} commands to receive the counter value as an argument,
+instead of
+acting as a simple prefix. This supports
+more complex
+formatting of the value in the reference.
+
+
+These packages also provided
+the command \cs{labelformat} to help in the specification of
+such formatting in an easy way. For
+example, \verb=\labelformat{equation}{eq.~(#1}}= specifies that
+references to equations
+automatically come out as
+\enquote{eq.~(5)} or similar. As this means a \cs{ref} command can no
+longer be used at the start of a sentence, the packages also
provided \cs{Ref} for such scenarios.
-Both \cs{labelformat} and \cs{Ref} are now moved into the kernel so
-that they are available out of the box without the need to load
-additional packages.
+Both of these commands, cs{labelformat} and \cs{Ref},
+are now removed from the packages and instead made available in
+the kernel so there is no
+need to load additional packages.
\subsection{Improve wording of a warning message}
-% write? vv
-\emph{write} The kernel now says \enquote{Trying to load \ldots}
+The kernel now says \enquote{Trying to load \ldots}
instead of \enquote{Try loading \ldots} in one of its informal
messages to match style of similar messages.
\githubissue{107}
-\subsection{Avoid \cs{DeclareErrorFont} side effects}
+\subsection{Avoid bad side-effects of cs{DeclareErrorFont}}
-As a side effect of setting up the error font for NFSS that
-declaration also changed the current font back to 10\,pt size. In most
+As a side effect of setting up the error font for NFSS, this
+declaration also changed the current font-size back to 10pt.
+In most
circumstances that doesn't matter, because that declaration was meant
-to be used only during the early stages of a \LaTeX{} run.
-
-However, it turned out to be also used in other places
-(incorrectly actually, e.g., inside some \texttt{.fd} files) and there
-the size reset caused havoc in seemingly random places. The command
-has now changed to not produce such side effects.
+to be used only during the format generation and not during
+a \LaTeX{} run.
+However, it has turned out to
+used by some developers in other places
+(incorrectly in fact:
+e.g., inside some \texttt{.fd} files) where
+resetting the size causes
+havoc
+seemingly at random.
+The command has now changed to not produce such side effects.
\gnatsissue{latex}{4399}
@@ -415,21 +476,27 @@ has now changed to not produce such side effects.
\subsection{\pkg{nfssfont}: Generate a font table as the default action}
With the small file \texttt{nfssfont.tex} it is possible to produce
-font tables and other font tests in the style set up by Don Knuth. As
-in nearly all cases producing a font table is the desired action this
-action has been made the default so that one can simply hit enter
+font tables and other font tests
+in the style set up by Don Knuth.
+In nearly all cases
+a font table is wanted,
+so this action has been made the default.
+Now one can simply hit enter
instead of having to write \verb=\table\bye=.
-\subsection{For developers: \pkg{trace} package support by the kernel}
+\subsection{\pkg{trace} package support in the kernel}
The \pkg{trace} package implements the commands \cs{traceon}
-and \cs{traceoff} that work similar to \cs{tracingall} and \cs{tracingnone},
-but skip certain code blocks that produce a lot of tracing output of no
-interest during debugging (for example loading a font).
-Code blocks that should be hidden during tracing need
-to be surrounded by the macros \cs{conditionally at traceoff}
-and \cs{contionally at traceon}.
+and \cs{traceoff} that work like
+\cs{tracingall} but skip
+certain code blocks that produce a lot of tracing output.
+%%CCC being of no interest to anyone!! -- FMi I love your encouragement
+This is useful when debugging, to suppress uninteresting tracing
+from, for example, loading a font.
+Code blocks that should not be traced
+need to be surrounded by the commands
+\cs{conditionally at traceoff} and \cs{conditionally at traceon}.
The \LaTeX{} kernel now provides dummy definitions for these two
commands so that package writers can use them in their packages
@@ -445,8 +512,9 @@ regardless of \pkg{trace} being loaded or not.
With \cs{newcolumntype} it is possible to define your own column
specifiers for a \texttt{tabular} preamble, it is also possible to
change existing ones. However, doing that for a primitive column
-specifier, such as \texttt{c}, is seldom a good idea, since then its
-functionality becomes unavailable. Therefore the package was supposed
+specifier, such a \texttt{c}, is seldom a good idea, since then its
+functionality becomes unavailable.
+The package was therefore supposed
to warn the user in this case, but due to a missing \cs{expandafter}
in the code it never did---now it does.
@@ -456,13 +524,19 @@ in the code it never did---now it does.
\subsection{\pkg{multicol}: Introduce \texttt{minrows} counter for balancing}
When there are only a few lines of text on a page at the end of a
-\env{multicols} environment balancing them looks rather odd, e.g., if
-you then end up with three columns each containing a single line. This
-can now be controlled through the counter \texttt{minrows} (default is~1)
-which requires at least that many lines in the first column during
-balancing. Thus, if you set it to \texttt{2} one would get a
-distribution of \texttt{2+1+0} lines and if set it to three, the result
-would have been \texttt{3+0+0} instead of the default \texttt{1+1+1}.
+\env{multicols} environment,
+balancing the columns often looks rather odd: such as
+three columns each containing a single line. The balancing behavior
+can now be controlled through the counter \texttt{minrows}
+(default is~1) which specifies that,
+after balancing, there must be at least that many lines in the first column.
+Thus, if you set \texttt{minrows}
+to \texttt{2} then you
+would get a
+distribution of \texttt{2+1+0} lines and if set
+to three, the result
+would be
+\texttt{3+0+0} instead of the default \texttt{1+1+1}.
What is most appropriate really depends on the circumstances, but this
now gives you the tools to make local or global adjustments.
@@ -474,13 +548,17 @@ The \pkg{varioref} package has been internally updated to provide
better interfaces for packages such as \pkg{hyperref} and
\pkg{cleveref}.
-It now has a new package option \option{nospace} that stops
-\pkg{varioref} from meddling with space in front it its commands. The
+It also
+has a new package option \option{nospace} that stops
+\pkg{varioref} from meddling with space in front of
+its commands. The
original behavior was always somewhat problematical and it is
-suggested that for new documents to always use this option (which
+suggested that
+all new documents
+use this option (which
should really have been the default).
-Also added was support for the Arabic language through the option
+Support was also added for the Arabic language through the option
\option{arabic}.
@@ -488,12 +566,14 @@ Also added was support for the Arabic language through the option
\subsection{\pkg{xr}: Support citations to bibliographies in external documents}
-The \pkg{xr} package can be used to reference labels in external
-document, e.g., when a work is split over different documents that
-need to be processed separately, but has \cs{ref} or \cs{pageref}
-links between each other. With this update \cs{cite} commands and
+The \pkg{xr} package can be used to cross-reference an external \LaTeX{}
+document.
+This means that even when a work is split over different documents (that
+need to be processed separately) \cs{ref} or \cs{pageref} can use labels from
+any document, creating links between them. This facility has now been extended
+so that \cs{cite} commands and
their cousins can now also reference bibliographies in external
-documents, a feature that was originally made available by the package
+documents; this feature was first provided in the package
\pkg{xcite} by Enrico Gregorio.
Note that for technical reasons \pkg{xr} doesn't work with
@@ -505,21 +585,28 @@ package.
\subsection{\pkg{amsmath}: Introduce \texttt{overunderset} command}
-The \pkg{amsmath} package always offer the commands \cs{overset} and
+The \pkg{amsmath} package has always offered
+the commands \cs{overset} and
\cs{underset} to produce binary operators with something set above or
-below. But sometimes one needs to put something on both sides and that
-required some gymnastics. With the newly added \cs{overunderset} this
-is now easily possible.
+below. But sometimes one needs to put something above and something below:
+The newly added \cs{overunderset} makes this
+easily possible.
\section{Documentation updates}
-There are a number of smaller documentation updates in different files
-found on the documentation page of the \LaTeX{} Project
-website~\cite{30:site-doc}.
+There are a number of
+%small
+documentation updates in files
+on the documentation page of the project website~\cite{30:site-doc}.
+
+\subsection{Highlighting the standard NFSS codes for series}
+
+The \emph{Font Selection Guide}~\cite{fntguide} has been
+updated to strongly recommend that the standard codes should be used
+when providing font support. The reason for this recommendation is explained here.
-\subsection{High-lighting the standard NFSS codes for series}
The font selection scheme uses a number of standard codes for
\cs{fontseries} and \cs{fontshape} to ensure that different fonts are
@@ -529,10 +616,7 @@ etc. Over the years people came up with a number of other creative
short codes like \texttt{k}, \texttt{j}, \texttt{t} and others with
the result that changing a font family required different codes and
thus prevented user from easily mixing and matching different
-families. The \emph{Font Selection Guide}~\cite{fntguide} has been
-updated to strongly recommend that the standard codes should be used
-when providing font support.
-
+families.
Some work has been undertaken to get back to a coherent scheme and
all the font families supported through the program \texttt{autoinst}
are now producing the standard codes again.
@@ -551,12 +635,13 @@ is no longer separately available from \CTAN{} but contained in the
\begin{thebibliography}{9}
+%\fontsize{9.3}{11.3}\selectfont
+
\bibitem{30:Mittelbach:TB39-1} Frank Mittelbach:
\emph{New rules for reporting bugs in the \LaTeX{} core software}.
In: TUGboat, 39\#1, 2018.
\url{https://latex-project.org/publications/}
-
\bibitem{devformat} Frank Mittelbach:
\emph{The
\LaTeX{} release workflow and the \LaTeX{} dev formats}.
@@ -571,11 +656,10 @@ is no longer separately available from \CTAN{} but contained in the
\emph{\LaTeX{} documentation on the \LaTeX{} Project Website}.\\
\url{https://latex-project.org/documentation/}
-\bibitem{30:site-pub}
- \emph{\LaTeX{} Project publications on the \LaTeX{} Project Website}.\\
- \url{https://latex-project.org/publications/}
+%\bibitem{30:site-pub}
+% \emph{\LaTeX{} Project publications on the \LaTeX{} Project Website}.\\
+% \url{https://latex-project.org/publications/}
\end{thebibliography}
\end{document}
-
More information about the latex3-commits
mailing list