Debian Codegraph @

texmf-dist/doc/latex/base/ltnews29.tex

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2018-2025
4 % The LaTeX Project and any individual authors listed elsewhere
5 % in this file.
6 %
7 % This file is part of the LaTeX base system.
8 % -------------------------------------------
9 %
10 % It may be distributed and/or modified under the
11 % conditions of the LaTeX Project Public License, either version 1.3c
12 % of this license or (at your option) any later version.
13 % The latest version of this license is in
14 % http://www.latex-project.org/lppl.txt
15 % and version 1.3c or later is part of all distributions of LaTeX
16 % version 2008 or later.
17 %
18 % This file has the LPPL maintenance status "maintained".
19 %
20 % The list of all files belonging to the LaTeX base distribution is
21 % given in the file `manifest.txt'. See also `legal.txt' for additional
22 % information.
23 %
24 % The list of derived (unpacked) files belonging to the distribution
25 % and covered by LPPL is defined by the unpacking scripts (with
26 % extension .ins) which are part of the distribution.
27 %
28 % \fi
29 % Filename: ltnews29.tex
30 %
31 % This is issue 29 of LaTeX News.
32
33 \documentclass{ltnews}
34 \usepackage[T1]{fontenc}
35
36 \usepackage{lmodern,url,hologo}
37
38 \usepackage{csquotes}
39
40 \providecommand\acro[1]{\textsc{#1}}
41 \providecommand\meta[1]{$\langle$\textit{#1}$\rangle$}
42
43
44 \providecommand\XeTeX{\hologo{XeTeX}}
45 \providecommand\LuaTeX{\hologo{LuaTeX}}
46 \providecommand\pdfTeX{\hologo{pdfTeX}}
47
48 \newcommand\githubissue[2][]{\ifhmode\unskip\fi
49 \quad\penalty500\strut\nobreak\hfill
50 \mbox{\small\slshape(%
51 \href{https://github.com/latex3/latex2e/issues/\getfirstgithubissue#2 \relax}%
52 {github issue#1 #2}%
53 )}%
54 \par}
55
56 % simple solution right now (just link to the first issue if there are more)
57 \def\getfirstgithubissue#1 #2\relax{#1}
58
59 \newcommand\sxissue[1]{\ifhmode\unskip\fi
60 \quad\penalty500\strut\nobreak\hfill
61 \mbox{\small\slshape(\url{https://tex.stackexchange.com/#1})}\par}
62
63 \let\cls\pkg
64 \providecommand\env[1]{\texttt{#1}}
65
66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67 \iffalse % only for TUB production
68 \usepackage{graphicx}
69 \makeatletter
70 % Xe\TeX{} requires reflecting the first E, hence we complain if the
71 % graphics package is not present. (For plain documents, this can be
72 % loaded via Eplain.) Also, at Barbara's suggestion, if the current
73 % font is slanted, we rotate by 180 instead of reflecting so there is at
74 % least a chance to look ok. (The magic values here seem more or less
75 % ok for \texttt{cmsl} and \texttt{cmti}.)
76 %
77 % \begin{macrocode}
78 \def\tubreflect#1{%
79 \@ifundefined{reflectbox}{%
80 \TBerror{A graphics package must be loaded for \string\XeTeX}%
81 }{%
82 \ifdim \fontdimen1\font>0pt
83 \raise 1.6ex \hbox{\kern.1em\rotatebox{180}{#1}}\kern-.1em
84 \else
85 \reflectbox{#1}%
86 \fi
87 }%
88 }
89 \def\tubhideheight#1{\setbox0=\hbox{#1}\ht0=0pt \dp0=0pt \box0 }
90 \def\XekernbeforeE{-.125em}
91 \def\XekernafterE{-.1667em}
92 \DeclareRobustCommand{\Xe}{\leavevmode
93 \tubhideheight{\hbox{X%
94 \setbox0=\hbox{\TeX}\setbox1=\hbox{E}%
95 \ifdim \fontdimen1\font>0pt \def\XekernbeforeE{0em}\fi
96 \lower\dp0\hbox{\raise\dp1\hbox{\kern\XekernbeforeE\tubreflect{E}}}%
97 \kern\XekernafterE}}}
98 \def\XeTeX{\Xe\TeX}
99 \def\XeLaTeX{\Xe{\kern.11em \LaTeX}}
100 \fi
101 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
102
103 \publicationmonth{December}
104 \publicationyear{2018}
105
106 \publicationissue{29}
107
108 \begin{document}
109
110 %\addtolength\textheight{4.2pc} % only for TUB
111
112 \maketitle
113 \tableofcontents
114
115 \setlength\rightskip{0pt plus 3em}
116
117 \bigskip
118
119 \section{Introduction}
120
121 The December 2018 release of \LaTeX{} is a maintenance release in
122 which we have fixed a few bugs in the software: some are old, some
123 newer, and they are mostly rather obscure.
124
125 \section[Bug reports for core \LaTeXe{} and packages]
126 {Bug reports for core \LaTeXe{} and packages maintained by the Project Team}
127
128 In Spring 2018 we established a new issue tracking system
129 (Github issues at \url{https://github.com/latex3/latex2e/issues}) for both
130 the \LaTeX{} core and the packages maintained by the
131 \LaTeX{} Project Team, with an updated procedure for how to report a
132 bug or problem.
133
134 Initial experience with this system is good, with people who report
135 problems following the guidelines and including helpful working
136 examples to show the problem---thanks for doing this.
137
138 The detailed requirements and the workflow for reporting a bug in the
139 core \LaTeX{} software is documented at
140 \begin{quote}
141 \url{https://www.latex-project.org/bugs/}
142 \end{quote}
143 with further details and discussion in~\cite{29:Mittelbach:TB39-1}.
144
145
146 \section{Changes to the \LaTeX{} kernel}
147
148 \subsection{UTF-8:\ updates to the default input encoding}
149
150 In the April 2018 release of \LaTeX{} we changed the default encoding
151 from 7-bit \acro{ascii} to \acro{utf}-8 when using classic \TeX\ or
152 \hologo{pdfTeX}; see \textit{\LaTeX{} News~28}~\cite{29:ltnews28} for
153 details.
154
155 Now, after half a year of experience with
156 this new default,
157 we have
158 made a small number of adjustments to further improve the user experience.
159 These include:
160 \begin{itemize}
161 \item
162 Some improvements when displaying error messages about \acro{utf}-8
163 characters that have not been set up for use with \LaTeX{},
164 or are invalid for some other reason;
165 %
166 \githubissue[s]{60, 62 and 63}
167 %
168 \item
169 The addition of a number of previously missing declarations for
170 characters that are in fact available with the default fonts, e.g.,
171 \cs{j} \enquote{\j} (0237), \cs{SS} \enquote{\SS} (1E9E),
172 \verb=\k{}= \enquote{\k{ }} (02DB) and \verb=\.{}= \enquote{\.{ }}
173 (02D9);
174 \item
175 Correcting the names for \cs{guillemetleft}
176 \enquote{\guillemotleft} and \cs{guillemetright}
177 \enquote{\guillemotright} in all encoding files. These correct
178 names are in addition to the old (but wrong) Adobe names: Adobe
179 mistakenly called them Guillemot, which is a sea bird.
180 %
181 \githubissue{65}
182 %
183 \item
184 Added \cs{Hwithstroke} (\enquote{\Hwithstroke}) and \cs{hwithstroke}
185 (\enquote{\hwithstroke}) necessary for typesetting Maltese.
186 %
187 \sxissue{q/460110}
188 \end{itemize}
189
190
191
192 \subsection{Fixed \cs{verb*} and friends in \texorpdfstring{\XeTeX}{XeTeX} and \LuaTeX{}}
193
194
195 The original \cs{verb*} and \texttt{verbatim*} in \LaTeX{} were coded
196 under the assumption that the position of the space character (i.e.,
197 \acro{ascii} 32) in a typewriter font contains a visible space glyph
198 ``\verb*= =''. This is correct for \pdfTeX{} with the most used font
199 encodings \texttt{OT1} and \texttt{T1}. However, this unfortunately
200 does not work for Unicode engines using the \texttt{TU} encoding since
201 the space character slot (\acro{ascii} 32) then usually contains a real
202 (normal) space, which has the effect that \cs{verb*} produces the same
203 results as \cs{verb}.
204
205 The \cs{verb*} code now always uses the newly introduced command
206 \cs{verbvisiblespace} to produce the visible space character and this
207 command will get appropriate definitions for use with the different
208 engines. With \pdfTeX{} it will simply use \cs{asciispace}, which is
209 a posh name for ``select character 32 in the current font'', but with
210 Unicode engines the default definition is
211 \begin{verbatim}
212 \DeclareRobustCommand\verbvisiblespace
213 {\leavevmode
214 {\usefont{OT1}{cmtt}{m}{n}\asciispace}}
215 \end{verbatim}
216 which uses the visible space from the font Computer Modern Typewriter,
217 regardless of the currently chosen typewriter font. Internally the
218 code ensures that the character used has exactly the same width as the
219 other characters in the current (monospaced) font; thus, for example,
220 code displays line up properly.
221
222 It is possible to redefine this command to select your own character,
223 for example
224 \begin{verbatim}
225 \DeclareRobustCommand\verbvisiblespace
226 {\textvisiblespace}
227 \end{verbatim}
228 will select the ``official'' visible space character of the
229 current font. This may look like the natural default, but it wasn't
230 chosen as our default because many fonts just don't have that Unicode
231 character, or they have one with a strange shape.
232 %
233 \githubissue[s]{69 and 70}
234
235
236 \subsection{Error message corrected}
237 Trying to redefine an undefined command could in a few cases generate
238 an error message with a missing space, e.g.,
239 \verb=\renewcommand\1{...}= gave
240 \begin{verbatim}
241 LaTeX Error: \1undefined.
242 \end{verbatim}
243 This is now fixed.
244 %
245 \githubissue{41}
246
247
248 \subsection{Fixed fatal link error with \pkg{hyperref}}
249
250 If an \cs{href} link text gets broken across pages, \pdfTeX{} and
251 \LuaTeX{} will generate a fatal error unless both parts of the link
252 are internally at the same boxing level. In two-column mode that was
253 not the case if one of the pages had spanning top floats. This has now
254 been changed so that the error is avoided.
255 %
256 \githubissue{94}
257
258
259 \subsection{Avoid page breaks caused by invisible commands}
260
261 Commands like \cs{label} or \cs{index} could generate a potential page
262 break in places where a page break was otherwise prohibited, e.g.,
263 when used between two consecutive headings. This has now been
264 corrected. If for some reason you really want a break and you relied
265 on this faulty behavior, you can always add one using \cs{pagebreak},
266 with or without an optional argument.
267 %
268 \githubissue{81}
269
270
271
272 \subsection{Prevent spurious spaces when reading table of contents data}
273
274 When table of contents data is read in from a \texttt{.toc} file, the
275 new-line character at the end of each line is converted by \TeX{} to a
276 space. In normal processing this is harmless (as \TeX{} is doing this
277 input reading whilst in vertical mode and each line in the file
278 represents a single line (paragraph) in the table of contents. If,
279 however, this is done in horizontal mode, which is sometimes the case,
280 then these spaces will appear in the output. If you then omit some of
281 the input lines (e.g., because you do not display \acro{toc} data below a
282 certain level), then these spaces accumulate in the typeset output and
283 you get surprising, and unwanted, gaps inside the text.
284
285 The new code now adds a \texttt{\%} sign at the end of problematic
286 lines in the \texttt{.toc} file so that \TeX{} will not generate such
287 spaces that may survive to spoil the printed result. As some third
288 party packages have augmented or changed the core \LaTeX{}
289 functionality in that area (for example, by adding additional
290 arguments to the commands in \acro{toc} files) the code uses a conservative
291 approach and the \texttt{\%} signs are added only when certain
292 conditions are met. Therefore some packages might require updates if
293 they want to benefit from this correction, especially if they
294 unconditionally overwrite \LaTeX{}'s \cs{addcontentsline} definition.
295 %
296 \githubissue{73}
297
298
299 \subsection{Prevent protrusion in table of contents lines}
300
301 In \TeX{}'s internal processing model,
302 paragraph data is one of the
303 major data structures. As a result,
304 many things are internally modeled
305 as paragraphs even if they are not conceptually
306 ``text paragraphs'' in
307 the traditional sense.
308 In a few cases this has some surprising effects
309 that are not always
310 for the better. One example is
311 standard \acro{toc} entries,
312 where you have
313 heading data followed by some dot leaders and a page
314 number at the right, produced, for example, from this:
315 \begin{quote}
316 \contentsline {subsection}{Error message corrected}{2}{section*.7}
317 \end{quote}
318 The space reserved for the page number is of a fixed width, so that
319 the dots always end in the same place. Well, they did end in the same
320 place until the advent of protrusion support in the \TeX{} engines.
321 Now, with the \pkg{microtype} package loaded, it is possible that the
322 page number will protrude slightly into the margin (even though it’s
323 typeset inside a box) and as a result this page number box gets
324 shifted. With enough bad luck this can get you another dot in the
325 line, sticking out like the proverbial sore thumb, as exhibited in the
326 question on StackExchange that triggered the correction.
327
328 \LaTeX{} now takes care that there will be no protrusion happening on
329 such lines, even if it is generally enabled for the whole document.
330 %
331 \sxissue{q/172785}
332
333
334
335 \subsection{Start L-R mode for \cs{thinspace} and friends}
336
337 In \LaTeX{}, commands that are intended only for paragraph (L-R) mode
338 are generally careful to start paragraph mode if necessary; thus they
339 can be used at the start of a paragraph without surprising and
340 unwanted consequences. This important requirement had been overlooked
341 for a few horizontal spacing commands, such as \cs{thinspace}
342 (a.k.a.\ ``\cs{,}''), and for some other support commands such as
343 \cs{smash} or \cs{phantom}. Thus they ended up adding vertical space
344 when used at the beginning of a paragraph or, in the case of
345 \cs{smash}, creating a paragraph of their own. This has now been
346 corrected, and a corresponding update has been made to the
347 \pkg{amsmath} package, in which these commands are also defined.
348 %
349 \githubissue[s]{49 and 50}
350
351
352
353 \subsection{Guarding \cs{pfill} in \pkg{doc}}
354
355 For presenting index entries pointing to
356 code fragments and the like,
357 the \pkg{doc} package has a \cs{pfill} command that
358 generates within the index a line of dots leading from
359 the command name to the page or code line numbers.
360 If necessary it would automatically split the entry
361 over two lines. That worked well enough for a quarter century, but we
362 discovered recently that it is broken inside
363 the \cls{ltugboat} class,
364 where it sometimes produces
365 bad spacing within continuation lines.
366
367 The reason turned out to be a redefinition of the \LaTeX{} command
368 \cs{nobreakspace} (\verb=~=) inside the class \cls{ltugboat}, which
369 removed any preceding space (and thus unfortunately also removed the
370 dots on the continuation line). While one can argue that this is a
371 questionable redefinition (if only done by a single class and not generally),
372 it has been in the class so long that changing it would
373 certainly break older documents. So instead we now guard against that
374 removal of space.
375 %
376 \githubissue[s]{25 and 75}
377
378
379
380
381
382 \section{Changes to packages in the \pkg{tools} category}
383
384 \subsection{Sometimes the \pkg{trace} package turned off too much}
385
386 The \pkg{trace} package is a useful little tool for tracing macro
387 execution: it hides certain lengthy and typically uninteresting
388 expansions resulting from font changes and similar activities.
389 However, it had the problem that it also reset other tracing settings
390 such as \cs{showoutput} in such situations, so that you couldn't use
391 \cs{showoutput} in the preamble to get symbolic output of all the
392 pages in the document. This has now been corrected.
393
394
395
396
397 \subsection{Update to \pkg{xr}}
398
399 The \pkg{xr} package has been updated so that the code that reads the
400 \texttt{.aux} file has been made more robust. It now correctly
401 ignores conditionals (added by \pkg{hyperref} and other packages)
402 rather than generating low level parsing errors.
403 \sxissue{a/452321}
404
405
406 \subsection{Column data for \env{multicols*} sometimes vanished}
407
408 In certain situations involving \env{multicols*}, when there are more
409 explicit \cs{columnbreak} requests than there are columns on the
410 current page, data could vanish due to the removal of an internal
411 penalty marking the end of the environment. This has been corrected by
412 explicitly reinserting that penalty if necessary.
413 %
414 \githubissue{53}
415
416 \subsection{Extension to \cs{docolaction} in \pkg{multicol}}
417
418 The \cs{docolaction} command can be used to carry out actions
419 depending on the column you are currently in, i.e., first, any inner
420 one (if more than two) or last. However, if the action generates text
421 then there is the question: is this text part of the current column or
422 the one after? That is, on the next run, do we test before or after it,
423 to determine in which column we are?
424
425 This is now resolved as follows: if you use \cs{docolaction*} any
426 generated text by the chosen action is considered to be after the test
427 point. But if you use the command without the star then all the material
428 it generates will be placed before the test point to determine the
429 current column, i.e., the text will become part of the current column
430 and may affect the test result on the next run.
431
432
433
434 \subsection{Prevent color leak in \pkg{array}}
435
436 In some cases the color used inside a \env{tabular} cell could ``leak
437 out'' into the surrounding text. This has been corrected.
438 %
439 \githubissue{72}
440
441 \subsection{Support fragile commands in \env{array} or \env{tabular} column templates}
442
443 The preamble specifiers \texttt{p}, \texttt{m} and \texttt{b} each receives
444 a user supplied argument: the width of the paragraph column. Normally
445 that is something harmless, like a length or a simple length
446 expression. But in more complicated settings involving the \pkg{calc}
447 package it could break with a low-level error message. This has now
448 been corrected.
449 %
450 \sxissue{q/459285}
451
452
453
454 \section{Changes to packages in the \pkg{amsmath} category}
455
456 The changes in the kernel made for \cs{thinspace}, \cs{smash},
457 etc.\ (see above) have been reflected in the \pkg{amsmath} package
458 code, so that loading this package doesn't revert them.
459 %
460 \githubissue[s]{49 and 50}
461
462
463
464
465
466 \section{Website updates}
467
468 \subsection{Publications area reorganized and extended}
469
470 To help readers to find relevant information in more convenient and
471 easy ways, the area of the website covering publications by the
472 \LaTeX{} Project Team was reorganized and extended (many more
473 abstracts added). We now provide the articles, talks and supplementary
474 data structured both by year and also by major
475 topics~\cite{29:site-pub}. Feel free to take a look.
476
477 \subsection{Japanese translations of the user's guide}
478
479 Yukitoshi Fujimura has kindly translated
480 into Japanese two documents that are
481 distributed with standard \LaTeX{}.
482 These are:
483 \begin{itemize}
484 \item
485 \LaTeXe{} for authors;
486 \item
487 User's Guide for the \pkg{amsmath}~Package~\cite{29:amsldoc}.
488 \end{itemize}
489 They can be found on the website documentation page~\cite{29:site-doc}.
490 You will now also find there a typeset version of the full \LaTeXe{}
491 source code (with index etc.\@) and a number of other goodies.
492
493
494
495
496 \begin{thebibliography}{9}
497
498 \bibitem{29:Mittelbach:TB39-1} Frank Mittelbach:
499 \emph{New rules for reporting bugs in the \LaTeX{} core software}.
500 In: TUGboat, 39\#1, 2018.
501 \url{https://latex-project.org/publications/}
502
503 \bibitem{29:ltnews28}
504 \emph{\LaTeX{} News, Issue 28}.
505 In: TUGboat, 39\#1, 2018.\\
506 \rlap{\url{https://latex-project.org/news/latex2e-news/}}
507
508 \bibitem{29:site-doc}
509 \emph{\LaTeX{} documentation on the \LaTeX{} Project Website}.\\
510 \url{https://latex-project.org/documentation/}
511
512 \bibitem{29:site-pub}
513 \emph{\LaTeX{} Project publications on the \LaTeX{} Project Website}.\\
514 \url{https://latex-project.org/publications/}
515
516 \bibitem{29:amsldoc} American Mathematical Society and The \LaTeX\ Project:
517 \emph{User's Guide for the \texttt{amsmath} Package} (Version 2.1).
518 April 2018.
519 Available from
520 \url{https://www.ctan.org}
521 and distributed as part of every \LaTeX{} distribution.
522
523 \end{thebibliography}
524
525 \end{document}