[latex3-commits] [git/LaTeX3-latex3-latex2e] master: first draft for ltnews29 (tools not covered yet) (e7d4b58)
Frank Mittelbach
frank.mittelbach at latex-project.org
Thu Oct 25 13:01:24 CEST 2018
Repository : https://github.com/latex3/latex2e
On branch : master
Link : https://github.com/latex3/latex2e/commit/e7d4b5887d52f024dc51fde5e9ae38f3e9cb21f8
>---------------------------------------------------------------
commit e7d4b5887d52f024dc51fde5e9ae38f3e9cb21f8
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date: Thu Oct 25 13:01:24 2018 +0200
first draft for ltnews29 (tools not covered yet)
>---------------------------------------------------------------
e7d4b5887d52f024dc51fde5e9ae38f3e9cb21f8
doc/ltnews29.tex | 403 ++++++++++++++++++++++++++++++++++++++++++
required/amsmath/changes.txt | 4 +
required/tools/changes.txt | 4 +
3 files changed, 411 insertions(+)
diff --git a/doc/ltnews29.tex b/doc/ltnews29.tex
new file mode 100644
index 0000000..dc83836
--- /dev/null
+++ b/doc/ltnews29.tex
@@ -0,0 +1,403 @@
+% \iffalse meta-comment
+%
+% Copyright 2018
+% The LaTeX3 Project and any individual authors listed elsewhere
+% in this file.
+%
+% This file is part of the LaTeX base system.
+% -------------------------------------------
+%
+% It may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either version 1.3c
+% of this license or (at your option) any later version.
+% The latest version of this license is in
+% http://www.latex-project.org/lppl.txt
+% and version 1.3c or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+% This file has the LPPL maintenance status "maintained".
+%
+% The list of all files belonging to the LaTeX base distribution is
+% given in the file `manifest.txt'. See also `legal.txt' for additional
+% information.
+%
+% The list of derived (unpacked) files belonging to the distribution
+% and covered by LPPL is defined by the unpacking scripts (with
+% extension .ins) which are part of the distribution.
+%
+% \fi
+% Filename: ltnews29.tex
+%
+% This is issue 29 of LaTeX News.
+
+\documentclass{ltnews}
+\usepackage[T1]{fontenc}
+
+\usepackage{lmodern,url,hologo,csquotes}
+
+\providecommand\acro[1]{\textsc{#1}}
+\providecommand\meta[1]{$\langle$\textit{#1}$\rangle$}
+
+
+\providecommand\XeTeX{\hologo{XeTeX}}
+\providecommand\LuaTeX{\hologo{LuaTeX}}
+\providecommand\pdfTeX{\hologo{pdfTeX}}
+
+\newcommand\githubissue[2][]{\ifhmode\unskip\fi
+ \quad\penalty500\strut\nobreak\hfill
+ \mbox{\small\itshape(github issue#1 #2)}\par}
+
+\newcommand\sxissue[1]{\ifhmode\unskip\fi
+ \quad\penalty500\strut\nobreak\hfill
+ \mbox{\small\itshape\url(#1)}\par}
+
+\let\cls\pkg
+
+
+\publicationmonth{December}
+\publicationyear{2018}
+
+\publicationissue{29}
+
+\begin{document}
+
+\maketitle
+\tableofcontents
+
+\setlength\rightskip{0pt plus 3em}
+
+\section{Intro}
+
+\emph{to fill}
+
+\section[Bug reports for core \LaTeXe{} and packages]
+ {Bug reports for core \LaTeXe{} and packages maintained by the Project Team}
+
+
+
+In spring 2018 we established a new issue tracking system (GitHub
+issues) for the \LaTeX{} core and the packages maintained by the
+\LaTeX{} Project team with an updated procedure for how to report a bug or
+problem.
+
+Initial experience is good and people reporting problems follow the
+guidelines and produce helpful working examples that show the
+problem---thanks for that.
+
+The detailed requirements and the workflow for reporting a bug in the
+core \LaTeX{} software is documented at
+\begin{quote}
+\url{https://www.latex-project.org/bugs/}
+\end{quote}
+and with further details also discussed in~\cite{Mittelbach:TB39-1}.
+
+
+\section{Changes to the \LaTeX{} kernel}
+
+
+\subsection{UTF-8:\ updates to the default input encoding}
+
+In the April 2018 release of \LaTeX{} we changed the default encoding
+from 7-bit \acro{ascii} to to UTF-8 if used with classic \TeX\ or
+\hologo{pdfTeX}, see \textit{\LaTeX{} News~28}~\cite{ltnews28} for
+details.
+
+Now, after half a year of experience with the new default we made a
+small number of adjustments to further improve the user experience.
+These include
+\begin{itemize}
+\item
+ Some improvements when displaying error messages about UTF-8
+ characters that have not been set up for use with \LaTeX{} or are
+ invalid for some other reason;
+%
+\githubissue[s]{60, 62 and 63}
+%
+\item
+ Added a number of missing declarations for characters that are in
+ fact available with the default fonts, e.g., \cs{j} \enquote{\j}
+ (0237), \cs{SS} \enquote{\SS} (1E9E), \verb=\k{}= \enquote{\k{ }}
+ (02DB) and \verb=\.{}= \enquote{\.{ }} (02D9)
+ \item
+ Add correct names for \cs{guillemetleft} \enquote{\guillemotleft}
+ and \cs{guillemetright} \enquote{\guillemotright} in addition to
+ the old (but wrong) Adobe names in all encoding files. Adobe
+ called them by mistake Guillemot which is a bird.
+%
+ \githubissue{65}
+\end{itemize}
+
+
+
+\subsection{Fixed \cs{verb*} and friends in \XeTeX{} and \LuaTeX{}}
+%[Fixed \cs{verb*} and friends in \XeTeX{} and \LuaTeX{}]
+% {Fixed \cs{verb*} and friends in \XeTeX{} and \LuaTeX{}\githubissue[s]{69 and 70}}
+
+The original \cs{verb*} and \texttt{verbatim*} in \LaTeX{} was coded
+under the assumption that the position of the space character (i.e.,
+ASCII 32) in a Typewriter Font contains a visible space
+``\verb*= =''. This is correct in \pdfTeX{} for the predominant
+%
+font encodings \texttt{OT1} and \texttt{T1} but unfortunately no
+longer true in Unicode engines using the \texttt{TU} encoding. Here
+the slot normally contains a real space so that \cs{verb*} produced
+the same results as \cs{verb}.
+
+The \cs{verb*} code now always uses the newly introduced command
+\cs{verbvisiblespace} to produce the visible space character and this
+command will get an appropriate definition in the different
+engines. With \pdfTeX{} it will simply call \cs{asciispace} which is a
+posh name for ``select the character 32 in the current font'' but with
+the Unicode engines the default definition is
+\begin{verbatim}
+ \DeclareRobustCommand\verbvisiblespace
+ {\leavevmode
+ {\usefont{OT1}{cmtt}{m}{n}\asciispace}}
+\end{verbatim}
+i.e., the visible space from Computer Modern Typewriter regardless of
+the current typewriter font is chosen. Internally it is ensured that
+the character has exactly the same width as the other characters in
+the current monspaced font, so that code displays line up properly.
+
+It is possible to redefine this command to select your own character,
+for example
+\begin{verbatim}
+ \DeclareRobustCommand\verbvisiblespace
+ {\textvisiblespace}
+\end{verbatim}
+would select the the ``offical'' visible space character of the
+current font. This may look like the natural default but it wasn't
+chosen as default because many fonts just don't have that unicode
+character, or if they have one with a strange shape.
+%
+\githubissue[s]{69 and 70}
+
+
+\subsection{Error message corrected}
+Trying to redefine an undefined command could in a few cases generate
+an error message with a missing space, e.g.,
+\verb=\renewcommand\1{...}= gave
+\begin{verbatim}
+ LaTeX Error: \1undefined.
+\end{verbatim}
+This is now fixed.
+%
+\githubissue{41}
+
+
+\subsection{Avoid page breaks caused by invisible commands}
+
+Commands like \cs{label} or \cs{index} could generate a page break
+possibility in places where a page break was otherwise prohibited,
+e.g., if use between two consecutive headings. This has now been
+corrected. If for some reason you really want a break andd you relied
+on this faulty behavior, you can always add it using \cs{pagebreak}
+with or with optional argument.
+%
+\githubissue{41}
+
+
+
+\subsection{Prevent spurious spaces when reading table of contents data}
+
+When table of contents data is read in from a \texttt{.toc} file the
+new line character at the end of each line is converted by \TeX{} to a
+space. In normal processing this is harmless (as \TeX{} is doing this
+processing in vertical mode and each line in the file represents a
+single line (paragraph) in the table of contents. If, however, this is
+done in horizontal mode, which is sometimes the case, then these
+spaces appear in the output. If you then omit certain input lines
+(e.g., because you do not display TOC data below a certain level),
+then these spaces accumulate in the typeset output and you get
+surprising gaps inside the text.
+
+The new code now adds a \texttt{\%} sign at the end of problematic
+lines so that \TeX{} will not generate such spaces that may survive
+and disturb the printed result. As some third party packages have
+augmented or changed the core \LaTeX{} functionality in that area (for
+example, by adding additional arguments to the commands in TOC files)
+the code uses a conservative approach and adds the \texttt{\%} signs
+are only added if certain conditions are meet. Thus, some packages
+might require updates if they want to benefit from the correction in
+particular if they unconditionally overwrite \LaTeX{}'s
+\cs{addcontentsline} definition.
+%
+\githubissue{73}
+
+
+\subsection{Prevent protrusion in table of contents lines}
+
+In \TeX{}'s internal processing model paragraph data is one of the
+major data structures. As a result many things are internally modeled
+as paragraphs even if they are conceptually not ``text paragraphs'' in
+the traditional sense. In a few cases this has some surprising effects
+not necessarily for the better. One example are standard TOC entries,
+where you have a heading data followed by some dot leaders and a page
+number at the right, e.g.
+\begin{quote}
+ \contentsline {subsection}{Error message corrected}{2}{section*.7}
+\end{quote}
+The space reserved for the page number is of a fixed width, so that
+the dots always end in the same place. Well, did end in the same place
+until the event of protrusion support in the \TeX{} engines. Now, with
+the \pkg{microtype} package being loaded it became possible that the
+page number protruded slightly into the margin (even though inside a
+box) and as a result the page number box shifted. With enough bad luck
+this then got you another dot in the line sticking out like a sore
+thumb as exhibited in the question on StackExchange that triggered the
+correction.
+
+\LaTeX{} now takes care that there will be no protrusion happening on
+such lines even if is generally enabled for the whole document.
+%
+\sxissue{https://tex.stackexchange.com/q/172785}
+
+
+
+\subsection{Start LR-mode for \cs{thinspace} and friends}
+
+In \LaTeX{} commands that are only intended for paragraph (L-R) mode
+are carful to start paragraph mode if necessary so that they can be
+used at a start of a paragraph without surprising consequences. For a
+few horizontal spacing commands such as \cs{thinspace}
+(a.k.a.\ ``\cs{,}'') and other support commands such as \cs{smash} or
+\cs{phantom} this was overlooked so that they ended up adding vertical
+space if used at the beginning of a paragraph or in case of \cs{smash}
+on a paragraph of their own. This has now been corrected. A
+corresponding update has been made for \pkg{amsmath} as there these
+commands are also defined.
+%
+\githubissue[s]{49 and 50}
+
+
+
+\subsection{Guarding \cs{pfill} in \pkg{doc}}
+
+For presenting index entries to code fragments and the like the
+\pkg{doc} package has a \cs{pfill} command that generated a line of
+dots leading from a command name to the page or code line numbers
+inside the index. If necessarily it would automatically split over two
+lines. That worked well enough for a quarter century, but we
+discovered recently that it is broken inside of the \cls{ltugboat}
+class where it sometimes broduced ugly spaced out continuation lines.
+
+The reason turned out to be a redefinition of the \LaTeX{} command
+\cs{nobreakspace} (\verb=~=) inside that class which removed any
+preceding space (and unfortunately also the dots on the continuation
+line). While one can argue that this is a questionable redefinition,
+it is so long in that class that changing it would certainly break
+older documents. So instead we now guard against that removal.
+%
+\githubissue[s]{25 and 75}
+
+
+
+
+
+\section{Changes to packages in the tools category}
+
+\subsection{}
+
+
+
+\begin{verbatim}
+2018-10-13 Frank Mittelbach <Frank.Mittelbach at latex-project.org>
+
+ * trace.dtx (section{Implementation}):
+ Only reset \tracingoutput if not set by \showoutput earlier
+
+2018-10-01 David Carlisle <David.Carlisle at latex-project.org>
+
+ * xr.dtx: Update to handle \if tests in the aux file.
+ https://tex.stackexchange.com/a/452321
+
+2018-09-13 Frank Mittelbach <Frank.Mittelbach at latex-project.org>
+
+ * array.dtx (section{The macros \@classz):
+ Add group to prevent color leak (gh/72)
+
+2018-06-26 Frank Mittelbach <Frank.Mittelbach at latex-project.org>
+
+ * multicol.dtx (subsection{Not balancing the columns}):
+ Re-add end penalty for multicols* environment to guard
+ against leftovers (git/53)
+\end{verbatim}
+
+\section{Changes to packages in the amsmath category}
+
+\begin{em}
+With this release of \LaTeX{} a few minor issues with \pkg{amsmath}
+have been corrected.
+\end{em}
+
+\begin{verbatim}
+ * amsmath.dtx
+ Don't drop \frozen at everymath
+ Start LR-mode for \thinspace and friends if necessary (github/49)
+ Start LR-mode for \bigl and friends if necessary (github/49)
+ Start LR-mode for \smash if necessary (github/49)
+\end{verbatim}
+
+\section{Website updates}
+
+\subsection{Publications area reorganized and extended}
+
+To help readers to find relevent information in more convenient and
+easy way the website area on publications by the \LaTeX{} Project Team
+was reorganized and extended (many more abstracts added). We now
+provide the articles, talks and supplementary data structured both by
+year as well as by major topics~\cite{site-pub}. Feel free to take a
+look.
+
+\subsection{Japanense translations of the user's guide}
+
+Yukitoshi FUJIMURA kindly translated two documents that are
+distributed with standard \LaTeX{} to the Japanese language. These are
+are
+\begin{itemize}
+\item
+ \LaTeXe{} for authors
+\item
+ User’s Guide for the \pkg{amsmath}~\cite{amsldoc}
+\end{itemize}
+They can be found on the website documentation page~\cite{site-doc}.
+You will now also find there a compiled version of the full \LaTeXe{}
+source code (with index etc.\@) and a number of other goodies.
+
+
+
+
+\begin{thebibliography}{9}
+
+\bibitem{Mittelbach:TB39-1} Frank Mittelbach:
+ \emph{New rules for reporting bugs in the \LaTeX{} core software}.
+ In: TUGboat, 39\#1, 2018.
+ \url{https://www.latex-project.org/publications/}
+
+\bibitem{site-doc}
+ \emph{\LaTeX{} documentation on the \LaTeX{} Project Website}.\\
+ \url{https://latex-project.org/documentation/}
+
+\bibitem{site-pub}
+ \emph{\LaTeX{} Project Team publications on the \LaTeX{} Project Website}.\\
+ \url{https://latex-project.org/publications/}
+
+\bibitem{amsldoc} American Mathematical Society and The \LaTeX3 Project:
+ \emph{User's Guide for the \texttt{amsmath} package} (Version 2.1).
+ April 2018.
+ Available from
+ \url{https://www.ctan.org}
+ and distributed as part of every \LaTeX{} distribution.
+
+\end{thebibliography}
+
+\end{document}
+
+
+
+
+\bibitem{Mittelbach:TB38-2-213} Frank Mittelbach:
+ \emph{\LaTeX{} table columns with fixed widths}.
+ In: TUGboat, 38\#2, 2017.
+ \url{https://www.latex-project.org/publications/}
+
diff --git a/required/amsmath/changes.txt b/required/amsmath/changes.txt
index cd9bf23..8eea35f 100644
--- a/required/amsmath/changes.txt
+++ b/required/amsmath/changes.txt
@@ -6,6 +6,10 @@
Start LR-mode for \bigl and friends if necessary (github/49)
Start LR-mode for \smash if necessary (github/49)
+#########################
+# 2018-04-01 Release
+#########################
+
2017-09-02 David Carlisle <latex-bugs at latex-project.org>
* amsmath.dtx: ensure that overfull alignments give warnings in more cases
diff --git a/required/tools/changes.txt b/required/tools/changes.txt
index 4d82d69..36677f5 100644
--- a/required/tools/changes.txt
+++ b/required/tools/changes.txt
@@ -20,6 +20,10 @@ are not part of the distribution.
* array.dtx (section{The macros \@classz):
Add group to prevent color leak (gh/72)
+#########################
+# 2018-04-01 PL 5 Release
+#########################
+
2018-06-26 Frank Mittelbach <Frank.Mittelbach at latex-project.org>
* multicol.dtx (subsection{Not balancing the columns}):
More information about the latex3-commits
mailing list