| 1 |
% \iffalse meta-comment |
| 2 |
% |
| 3 |
% Copyright 2024-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 |
% https://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: ltnews41.tex |
| 30 |
% |
| 31 |
% This is issue 41 of LaTeX News. |
| 32 |
|
| 33 |
\ifx\TUB\undefined |
| 34 |
\NeedsTeXFormat{LaTeX2e}[2020-02-02] |
| 35 |
|
| 36 |
\documentclass{ltnews} |
| 37 |
\fi |
| 38 |
|
| 39 |
%% Maybe needed only for Chris' inadequate system: |
| 40 |
\providecommand\Dash {\unskip \textemdash} |
| 41 |
|
| 42 |
%% NOTE: Chris' preferred hyphens! |
| 43 |
%% \hyphenation{because} |
| 44 |
|
| 45 |
\usepackage[T1]{fontenc} |
| 46 |
|
| 47 |
\usepackage{lmodern,url,hologo} |
| 48 |
|
| 49 |
\usepackage{csquotes} |
| 50 |
\usepackage{multicol} |
| 51 |
\usepackage{color} |
| 52 |
|
| 53 |
\providecommand\hook[1]{\texttt{#1}} |
| 54 |
\providecommand\socket[1]{\texttt{#1}} |
| 55 |
\providecommand\plug[1]{\texttt{#1}} |
| 56 |
|
| 57 |
\providecommand\meta[1]{$\langle$\textrm{\itshape#1}$\rangle$} |
| 58 |
\providecommand\option[1]{\texttt{#1}} |
| 59 |
\providecommand\env[1]{\texttt{#1}} |
| 60 |
\providecommand\Arg[1]{\texttt\{\meta{#1}\texttt\}} |
| 61 |
|
| 62 |
|
| 63 |
\providecommand\eTeX{\hologo{eTeX}} |
| 64 |
\providecommand\XeTeX{\hologo{XeTeX}} |
| 65 |
\providecommand\LuaTeX{\hologo{LuaTeX}} |
| 66 |
\providecommand\pdfTeX{\hologo{pdfTeX}} |
| 67 |
\providecommand\MiKTeX{\hologo{MiKTeX}} |
| 68 |
\providecommand\CTAN{\textsc{ctan}} |
| 69 |
\providecommand\TL{\TeX\,Live} |
| 70 |
|
| 71 |
\providecommand\githubissue[2][]{\ifhmode\unskip\fi |
| 72 |
\quad\penalty500\strut\nobreak\hfill |
| 73 |
\mbox{\small\slshape(% |
| 74 |
\href{https://github.com/latex3/latex2e/issues/\getfirstgithubissue#2 \relax}% |
| 75 |
{github issue#1 #2}% |
| 76 |
)}% |
| 77 |
\par\smallskip} |
| 78 |
|
| 79 |
% simple solution right now (just link to the first issue if there are more) |
| 80 |
\def\getfirstgithubissue#1 #2\relax{#1} |
| 81 |
|
| 82 |
|
| 83 |
\providecommand\taggingissue[2][]{\ifhmode\unskip\fi |
| 84 |
\quad\penalty500\strut\nobreak\hfill |
| 85 |
\mbox{\small\slshape(% |
| 86 |
\href{https://github.com/latex3/tagging-project/issues/\getfirstgithubissue#2 \relax}% |
| 87 |
{tagging-project issue#1 #2}% |
| 88 |
)}% |
| 89 |
\par\smallskip} |
| 90 |
|
| 91 |
|
| 92 |
|
| 93 |
\providecommand\sxissue[1]{\ifhmode\unskip |
| 94 |
\else |
| 95 |
% githubissue preceding |
| 96 |
\vskip-\smallskipamount |
| 97 |
\vskip-\parskip |
| 98 |
\fi |
| 99 |
\quad\penalty500\strut\nobreak\hfill |
| 100 |
\mbox{\small\slshape(\url{https://tex.stackexchange.com/#1})}\par} |
| 101 |
|
| 102 |
\providecommand\gnatsissue[2]{\ifhmode\unskip\fi |
| 103 |
\quad\penalty500\strut\nobreak\hfill |
| 104 |
\mbox{\small\slshape(% |
| 105 |
\href{https://www.latex-project.org/cgi-bin/ltxbugs2html?pr=#1\%2F\getfirstgithubissue#2 \relax}% |
| 106 |
{gnats issue #1/#2}% |
| 107 |
)}% |
| 108 |
\par} |
| 109 |
|
| 110 |
\let\cls\pkg |
| 111 |
\providecommand\env[1]{\texttt{#1}} |
| 112 |
\providecommand\acro[1]{\textsc{#1}} |
| 113 |
|
| 114 |
\vbadness=1400 % accept slightly empty columns |
| 115 |
|
| 116 |
\let\finalpagebreak\pagebreak % for TUB (if they use it) |
| 117 |
\let\finalvspace\vspace % for document layout fixes |
| 118 |
|
| 119 |
\makeatletter |
| 120 |
% maybe not the greatest design but normally we wouldn't have subsubsections |
| 121 |
\renewcommand{\subsubsection}{% |
| 122 |
\@startsection {subsubsection}{2}{0pt}{1.5ex \@plus 1ex \@minus .2ex}% |
| 123 |
{-1em}{\@subheadingfont\colonize}% |
| 124 |
} |
| 125 |
\providecommand\colonize[1]{#1:} |
| 126 |
\makeatother |
| 127 |
|
| 128 |
|
| 129 |
% Undo ltnews's \verbatim@font with active < and > |
| 130 |
\makeatletter |
| 131 |
\def\verbatim@font{\normalsize\ttfamily} |
| 132 |
\makeatother |
| 133 |
|
| 134 |
|
| 135 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 136 |
\providecommand\tubcommand[1]{} |
| 137 |
\tubcommand{\input{tubltmac}} |
| 138 |
|
| 139 |
\publicationmonth{June} |
| 140 |
\publicationyear{2025} |
| 141 |
|
| 142 |
\publicationissue{41} |
| 143 |
|
| 144 |
|
| 145 |
\begin{document} |
| 146 |
|
| 147 |
\maketitle |
| 148 |
{\hyphenpenalty=10000 \exhyphenpenalty=10000 \spaceskip=3.33pt \hbadness=10000 |
| 149 |
\small |
| 150 |
\tableofcontents} |
| 151 |
|
| 152 |
\setlength\rightskip{0pt plus 3em} |
| 153 |
|
| 154 |
\medskip |
| 155 |
|
| 156 |
\section{Introduction} |
| 157 |
|
| 158 |
We are continuing to work on the support of tagged PDF output and on |
| 159 |
wider kernel development, much of which is needed to make this |
| 160 |
happen. Probably the most notable changes in this latest release of |
| 161 |
the kernel are those in the output routine and in the mark mechanism: |
| 162 |
these are described in the first two sections. |
| 163 |
|
| 164 |
Work also continues apace on further aspects of the tagging project, |
| 165 |
where some highlights are: new sockets, better graphics tagging, |
| 166 |
improved math mode support and the promotion of PDF~2.0. |
| 167 |
|
| 168 |
In addition to this tagging-focussed work, we have also made advances |
| 169 |
in these areas: a new argument type for use in |
| 170 |
\cs{NewDocumentEnvironment} and friends which will make working with |
| 171 |
verbatim content a \emph{lot} easier; further improvements to case |
| 172 |
changing; and, of course, several bug fixes. |
| 173 |
|
| 174 |
Finally, we have highlighted a few of the recent changes in the L3 |
| 175 |
programming layer, where development work continues in parallel with |
| 176 |
other improvements to the \LaTeX{} kernel; and we are integrating |
| 177 |
more, formerly \enquote{experimental}, ideas into this core |
| 178 |
programming system. |
| 179 |
|
| 180 |
|
| 181 |
|
| 182 |
\section{A configurable output routine} |
| 183 |
|
| 184 |
For nearly 40 years \LaTeX's output routine (the mechanism to paginate |
| 185 |
the document and attach footnotes, floats and headers \& footers) was |
| 186 |
a largely hardwired algorithm with a limited number of configuration |
| 187 |
possibilities. Packages that attempted to alter any aspect of this |
| 188 |
process had to overwrite the internals, which led to the usual |
| 189 |
problems: incompatibilities and out-of-date code whenever something |
| 190 |
was changed in \LaTeX{}. |
| 191 |
|
| 192 |
To improve this, and to support the production of accessible PDF |
| 193 |
documents, we have started to refactor the output routine by adding a |
| 194 |
number of hooks and sockets. This means that packages needing to |
| 195 |
adjust the output routine can do so safely, avoiding the dangers |
| 196 |
previously associated with such activities. |
| 197 |
|
| 198 |
|
| 199 |
For packages that need to hook into the output routine we have implemented |
| 200 |
the following hooks: |
| 201 |
\begin{description} |
| 202 |
|
| 203 |
\item[\hook{build/page/before}, \hook{build/page/after}] |
| 204 |
|
| 205 |
These two hooks enable packages to prepend or append code to the |
| 206 |
processing of each page in the output routine. They are implemented |
| 207 |
as mirrored hooks. Technically, they are executed at the start and |
| 208 |
the end, respectively, of the internal \LaTeXe{} \cs{@outputpage} |
| 209 |
command. Currently, a number of packages change this command by |
| 210 |
adding code in exactly these two places\Dash so they can now |
| 211 |
instead simply add code to these hooks. |
| 212 |
|
| 213 |
\item[\hook{build/page/reset}] |
| 214 |
|
| 215 |
Packages that set up special conventions for the main text (such as |
| 216 |
catcode changes, etc.)\ can use this hook to undo these changes |
| 217 |
within the output routine, so that they aren't applied to unrelated |
| 218 |
material such as the text for running headers or footers. |
| 219 |
|
| 220 |
\item[\hook{build/column/before}, \hook{build/column/after}] |
| 221 |
|
| 222 |
These two hooks enable packages to prepend or append code to the |
| 223 |
column processing in the output routine. They are implemented as |
| 224 |
mirrored hooks. Technically, they are executed at the start and the |
| 225 |
end, respectively, of the internal \LaTeXe{} \cs{@makecol} command. |
| 226 |
A number of packages alter \cs{@makecol} to place code in exactly |
| 227 |
these two places\Dash they can now instead simply add their code to |
| 228 |
these hooks. |
| 229 |
|
| 230 |
\end{description} |
| 231 |
|
| 232 |
We have also added a number of sockets: for configuring the algorithm |
| 233 |
and also to support tagging. Two of these sockets are of interest for |
| 234 |
use in class files and also in the document preamble. |
| 235 |
|
| 236 |
The first and most complex of these is the socket |
| 237 |
\socket{build/column/outputbox}, which controls how the column text, |
| 238 |
the column floats (top and bottom) and the footnotes are combined in a |
| 239 |
column: i.e., their order and spacing. |
| 240 |
|
| 241 |
Thus in order to change the layout, all one now has to do is to assign |
| 242 |
a suitable plug to this socket, like this: |
| 243 |
\begin{flushleft} |
| 244 |
\verb= \AssignSocketPlug{build/column/outputbox}= |
| 245 |
\verb= {=\meta{plug-name}\verb=}= |
| 246 |
\end{flushleft} |
| 247 |
% |
| 248 |
For this socket we have provided the following plugs: |
| 249 |
\begin{description} |
| 250 |
\item[\plug{space-footnotes-floats}] |
| 251 |
|
| 252 |
After the galley text there is a vertical \cs{vfil} followed by the |
| 253 |
footnotes, followed by the bottom floats, if any. |
| 254 |
|
| 255 |
\item[\plug{footnotes-space-floats}] |
| 256 |
|
| 257 |
As before but the \cs{vfil} is between the footnotes and the |
| 258 |
floats. |
| 259 |
|
| 260 |
\item[\plug{floats-space-footnotes}] |
| 261 |
|
| 262 |
The floats come directly after the text, followed by a \cs{vfil} |
| 263 |
and then the footnotes at the bottom. |
| 264 |
|
| 265 |
\item[\plug{space-floats-footnotes}] |
| 266 |
|
| 267 |
Both floats and footnotes are pushed to the bottom, the footnotes |
| 268 |
coming last.\footnote{There are two more permutations but neither |
| 269 |
of them has ever been requested; so these two are not set up by |
| 270 |
default\Dash doing that in a class would be trivial though.} |
| 271 |
|
| 272 |
\item[\plug{floats-footnotes}] |
| 273 |
|
| 274 |
All excess space is distributed across the existing glue on the |
| 275 |
page: e.g., within the text galley, the separation between blocks, |
| 276 |
etc. The order is text, floats, footnotes. |
| 277 |
|
| 278 |
\item[\plug{footnotes-floats}] |
| 279 |
|
| 280 |
Like the previous plug, but floats and footnotes are swapped. This |
| 281 |
is the \LaTeX{} default for newer documents, i.e., this plug is |
| 282 |
assigned to the socket when \cs{DocumentMetadata} is used. |
| 283 |
|
| 284 |
\item[\plug{footnotes-floats-legacy}] |
| 285 |
|
| 286 |
Like the previous plug, but \LaTeX{}'s bottom skip bug is not |
| 287 |
corrected: i.e., in ragged bottom designs where footnotes are |
| 288 |
supposed to be directly attached to the text, they suddenly appear |
| 289 |
at the bottom of the page when the page ends with a \cs{newpage} or |
| 290 |
\cs{clearpage}. While this is clearly a bug, it has been like this |
| 291 |
since the days of \LaTeX~2.09; thus, for compatibility, we continue |
| 292 |
to support this behavior. This plug is assigned to the socket when |
| 293 |
\cs{DocumentMetadata} is \emph{not} used. |
| 294 |
\end{description} |
| 295 |
|
| 296 |
By default the separation between the last line of text and the |
| 297 |
footnotes (\cs{skip}\cs{footins}) is not measured from the baseline of |
| 298 |
the last text line, but from its bottom. This goes back to plain |
| 299 |
\TeX{} where it is done in this way. Similarly, \cs{textfloatsep} is |
| 300 |
added between text and bottom floats, not starting from the baseline of |
| 301 |
the last text line. Typographically speaking this is suboptimal, |
| 302 |
because it means that with \cs{flushbottom} in effect, the position of |
| 303 |
the last text line, when it is followed by footnotes or floats, |
| 304 |
depends on whether or not that line contains characters with |
| 305 |
descenders. |
| 306 |
|
| 307 |
For this reason there is now also a socket |
| 308 |
\socket{build/column/baselineattach} with a plug \plug{on}: this |
| 309 |
causes the attachment of footnotes/floats to be measured from the |
| 310 |
baseline of the last text line. To mimic the behavior of old |
| 311 |
documents, this socket is, by default, assigned the plug \plug{off}. |
| 312 |
For documents using \cs{DocumentMetadata}, the plug \plug{on} will |
| 313 |
probably become the default here. |
| 314 |
|
| 315 |
There are more configuration possibilities, mainly for class |
| 316 |
developers to use: documentation of these can be found in \cite[\S54 |
| 317 |
\texttt{ltoutput.dtx}]{41:source2e}. |
| 318 |
|
| 319 |
|
| 320 |
\section{Replacement for the legacy mark mechanism} |
| 321 |
|
| 322 |
\LaTeX{}'s legacy mechanism supported only two classes of marks, left |
| 323 |
and right marks, and setting the left mark (with \cs{markboth}) always |
| 324 |
altered the state of the right mark as well, i.e., they were far from |
| 325 |
independent. For generating running headers with \enquote{chapter |
| 326 |
titles} on the left and \enquote{section titles} on the right, they |
| 327 |
work reasonably well but without much flexibility: e.g., \cs{leftmark} |
| 328 |
always generated the last \enquote{left}-mark on the page, while |
| 329 |
\cs{rightmark} always generated the first \enquote{right}-mark. |
| 330 |
|
| 331 |
A few releases ago~\cite[p.\,76]{41:ltnews} we therefore introduced a |
| 332 |
new mark mechanism for \LaTeX{}, one that supports any number of truly |
| 333 |
independent mark classes. This mechanism also offers the ability to |
| 334 |
query the mark status at the top of the page, something that wasn't |
| 335 |
previously available at all. |
| 336 |
|
| 337 |
Up to now these two mechanisms coexisted, with completely separate |
| 338 |
implementations; but we have now retired the legacy code and |
| 339 |
reimplemented its public interfaces using the new concepts. Thus |
| 340 |
the old commands (\cs{markboth}, \cs{markright}, \cs{leftmark} and |
| 341 |
\cs{rightmark}) remain supported, but internally these commands all |
| 342 |
use \cs{InsertMark}, etc. |
| 343 |
|
| 344 |
Existing document classes, and documents using the legacy interfaces, |
| 345 |
will therefore continue to work without any modifications; but they |
| 346 |
now use a single underlying implementation. Also, new documents can |
| 347 |
benefit from the additional flexibility, e.g., by being able to |
| 348 |
display not only the first right-mark (\cs{rightmark} or |
| 349 |
\verb=\FirstMark{2e-right}=) but also, or alternatively, the last |
| 350 |
right-mark (\verb=\LastMark{2e-right}=) or the top right-mark |
| 351 |
(\verb=\TopMark{2e-right}=), etc. |
| 352 |
|
| 353 |
More information concerning all of this extended functionality can be |
| 354 |
found in~\cite{41:ltmarks}. |
| 355 |
|
| 356 |
|
| 357 |
\section{News from the Tagged PDF project} |
| 358 |
|
| 359 |
In the Tagged PDF project we have now reached a state where, within |
| 360 |
certain limits, it is possible to generate accessible PDF output that |
| 361 |
conforms to PDF/UA for arbitrarily complex documents as long as they |
| 362 |
only use (a growing number of) compatible packages and classes. |
| 363 |
|
| 364 |
The focus for this release was on adding special sockets for tagging |
| 365 |
support, on improving the tagging of math formulas, and on extending |
| 366 |
the tagging support for various types of graphics. |
| 367 |
|
| 368 |
\subsection{New Metadata keys, to activate tagging} |
| 369 |
|
| 370 |
Up to now users had to activate tagging by loading modules from |
| 371 |
\texttt{latex-lab} with the help of the \texttt{testphase} |
| 372 |
key. Further configuration of the tagging then had to be done by using |
| 373 |
the \cs{tagpdfsetup} command. We now offer Metadata keys for this |
| 374 |
that do not use \enquote{test} in their names, reflecting the fact |
| 375 |
that producing tagged PDF documents has become |
| 376 |
\enquote{production-ready}.\footnote{To be fully precise, this is true |
| 377 |
provided only compatible\\ |
| 378 |
packages and classes are used: these are listed at\\ |
| 379 |
\url{https://latex3.github.io/tagging-project/tagging-status/}.} |
| 380 |
|
| 381 |
The \texttt{tagging} key allows for the activation and deactivation of the |
| 382 |
tagging support. It accepts the three values \texttt{on}, |
| 383 |
\texttt{off} and \texttt{draft}. When this key is used it loads the |
| 384 |
\pkg{tagpdf} package and all the modules that we currently recommend |
| 385 |
should be loaded.\footnote{This set of modules can also be loaded with |
| 386 |
the key\\ \texttt{testphase=latest}.} |
| 387 |
The list of loaded modules will be adjusted as needed as |
| 388 |
the project progresses. For reference, it is also written to the log. |
| 389 |
Setting \texttt{tagging=off} loads the |
| 390 |
same set of modules and then |
| 391 |
deactivates the tagging commands in the \texttt{class/before} hook; |
| 392 |
and \texttt{tagging=draft} leaves the tagging commands active, so as |
| 393 |
to preserve warnings and errors in the tagging, but it deactivates the |
| 394 |
writing of the structure tree at the end of the compilation. This can |
| 395 |
save time when drafting a long document. |
| 396 |
|
| 397 |
The \texttt{tagging-setup} key allows configuration of the tagging. It |
| 398 |
accepts as values all the keys that can be used in \cs{tagpdfsetup}, |
| 399 |
such as the \texttt{math/setup} key described below. It knows about |
| 400 |
both the key \texttt{modules}, which allows overwriting of the set of |
| 401 |
loaded modules, and the key \texttt{extra-modules}, which allows |
| 402 |
loading of experimental modules that are not yet in \texttt{latest}. |
| 403 |
% |
| 404 |
The \texttt{tagging-setup} key implies \texttt{tagging=on} so that, if |
| 405 |
this key is used, then it is not necessary to also set the |
| 406 |
\texttt{tagging} key unless you want to turn tagging \texttt{off}, or |
| 407 |
to set it to \texttt{draft}. |
| 408 |
|
| 409 |
With these new Metadata keys a standard setup might look like this: |
| 410 |
\begin{verbatim} |
| 411 |
\DocumentMetadata{ |
| 412 |
pdfstandard={UA-2,A-4f}, |
| 413 |
tagging=on, |
| 414 |
tagging-setup= |
| 415 |
{math/setup=mathml-SE, |
| 416 |
extra-modules=verbatim-alt} |
| 417 |
} |
| 418 |
\end{verbatim} |
| 419 |
|
| 420 |
|
| 421 |
\subsection{New value \texttt{latest} for \texttt{testphase} key} |
| 422 |
|
| 423 |
With the new keys for enabling tagging the use of the |
| 424 |
\texttt{testphase} key is now of minor importance and mainly of |
| 425 |
interest for developers and for backwards compatibility. |
| 426 |
|
| 427 |
With this release it also supports the value \texttt{latest}. This |
| 428 |
will load all modules that we currently recommend should be loaded, so |
| 429 |
that it is not necessary to specify a long list of individual |
| 430 |
modules. The list of loaded modules will be adjusted as needed when |
| 431 |
the project progresses. For reference, it is also written to the log. |
| 432 |
|
| 433 |
|
| 434 |
\subsection{Sockets for tagging support} |
| 435 |
|
| 436 |
A lot of the tagging support in packages is handled through the |
| 437 |
socket-and-plug mechanism that was introduced in \LaTeX{} |
| 438 |
2023-11-01~\cite[p.\,93]{41:ltnews}. |
| 439 |
% |
| 440 |
Sockets offer an easily used interface for package developers to |
| 441 |
invoke variable code at pre-specified places: code that then can be |
| 442 |
changed from outside the package by assigning a different plug to |
| 443 |
alter the processing. |
| 444 |
|
| 445 |
For the tagging support, a specialized set of sockets is available: |
| 446 |
their plugs are invoked by using the \cs{UseTaggingSocket} command, |
| 447 |
instead of the normal \cs{UseSocket} command. This allows tagging to |
| 448 |
be turned off or on at high speed by the commands \cs{SuspendTagging} |
| 449 |
and \cs{ResumeTagging}, without the need to individually reassign |
| 450 |
plugs to each of the many tagging |
| 451 |
sockets~\cite[p.\,97]{41:ltnews}. This is very useful when there is a |
| 452 |
need to typeset material several times during trials. |
| 453 |
|
| 454 |
In the current release we now also offer three dedicated declaration |
| 455 |
commands for these \enquote{tagging sockets}: this works better than |
| 456 |
directly using the underlying general socket interface. These new |
| 457 |
commands also better support the special conventions used for |
| 458 |
\enquote{tagging sockets}. They are: \cs{NewTaggingSocket}, |
| 459 |
\cs{NewTaggingSocketPlug} and \cs{AssignTaggingSocketPlug}. |
| 460 |
|
| 461 |
|
| 462 |
\subsection{Setting the version to PDF 2.0} |
| 463 |
|
| 464 |
Creating a PDF 2.0 version is considered essential for any document |
| 465 |
that has substantial mathematical content. This is because only this |
| 466 |
PDF version supports the straightforward use of tags from the MathML |
| 467 |
namespace. |
| 468 |
|
| 469 |
When \cs{DocumentMetadata} is used, \LaTeX{} will therefore, by |
| 470 |
default, set PDF~2.0 as the PDF version. A different PDF version can, |
| 471 |
if required, be set by explicit use of the \texttt{pdfversion} key. |
| 472 |
|
| 473 |
|
| 474 |
|
| 475 |
|
| 476 |
\subsection{Setting up math tagging} |
| 477 |
|
| 478 |
With the \LuaTeX{} engine there are now various options for the |
| 479 |
production of accessible math which are described in full detail in |
| 480 |
\texttt{latex-lab-math.pdf}. To simplify the setup, a new key |
| 481 |
\texttt{math/setup} can be used in \cs{tagpdfsetup} (or in |
| 482 |
\texttt{tagging-setup} as shown above) that accepts a comma list with |
| 483 |
the values \texttt{mathml-SE} (add MathML structure elements), |
| 484 |
\texttt{mathml-AF} (attach MathML associated files) or \texttt{tex-AF} |
| 485 |
(attach the \TeX{} sources). |
| 486 |
|
| 487 |
|
| 488 |
\subsection{The use of \texttt{\$\$...\$\$} for math displays} |
| 489 |
|
| 490 |
Use of the plain \TeX{} method \verb=$$...$$= in \LaTeX{}, to mark up |
| 491 |
a display math formula, is not officially supported because it |
| 492 |
produces a fixed visual result that is not receptive to style changes |
| 493 |
such as the \texttt{fleqn} option. Instead, the recommended way is to |
| 494 |
use \verb=\[ ... \]= or the \env{displaymath} environment. However, |
| 495 |
since many authors have used this input method in their documents, we |
| 496 |
are doing our best to support it for the production of accessible |
| 497 |
PDFs; but users should be aware that it has some limitations. |
| 498 |
|
| 499 |
However, these accommodations for tagged PDF clash with the direct use |
| 500 |
of \verb=$$= in environment definitions for special math environments |
| 501 |
(such as those defined in \pkg{amsmath}). The kernel therefore now |
| 502 |
contains the two commands \cs{dollardollar@begin} and |
| 503 |
\cs{dollardollar@end}. These new commands must be used by packages |
| 504 |
and classes to specify where inside an environment the displayed math |
| 505 |
formula starts and ends: their use is essential in order to make the |
| 506 |
package or a class compatible with tagging, and to allow its use when |
| 507 |
producing accessible documents. |
| 508 |
% |
| 509 |
No more explicit \texttt{\$\$}s in |
| 510 |
code, please! |
| 511 |
|
| 512 |
Package and class developers can prepare code to meet |
| 513 |
this new requirement by adding these two commands: |
| 514 |
\begin{verbatim} |
| 515 |
\providecommand\dollardollar@begin{$$} |
| 516 |
\providecommand\dollardollar@end{$$} |
| 517 |
\end{verbatim} |
| 518 |
and replacing every occurrence of \verb=$$= with the appropriate start |
| 519 |
or end command. |
| 520 |
|
| 521 |
Adding these \cs{providecommand} lines to classes and packages doesn't |
| 522 |
hurt but ensures that they will work with older \LaTeX{} kernels. |
| 523 |
|
| 524 |
|
| 525 |
|
| 526 |
\subsection{Fixing the spacing after display math} |
| 527 |
|
| 528 |
When \LaTeX{} produces accessible (tagged) PDF it has to add structure |
| 529 |
data in the PDF to mark (i.e., tag) individual elements. If the |
| 530 |
\pdfTeX{} engine is used this has to be done with the help of |
| 531 |
\cs{pdfliteral}s, which are whatsit nodes like \cs{special} or |
| 532 |
\cs{write}. This means that they should be added only in places where |
| 533 |
these extra nodes do not affect the spacing\Dash \TeX{} can't, for |
| 534 |
example, look backwards past such a whatsit node, so consecutive |
| 535 |
spaces, that are normally collapsed into one, suddenly both appear |
| 536 |
when such a node separates them. |
| 537 |
|
| 538 |
The situation is especially complicated in displayed math because |
| 539 |
there \TeX{} adds penalties and spaces using low-level procedures that |
| 540 |
are not directly accessible from the macro level. Moreover, the PDF |
| 541 |
tagging structures have to be added somewhere in the middle of this |
| 542 |
processing: this is needed to ensure that the formula and these PDF |
| 543 |
structures do not get separated by a page break. Because of this it is |
| 544 |
necessary to use some fairly complex methods (essentially, we disable |
| 545 |
\TeX's mechanisms and reprogram them on the macro level) to get the |
| 546 |
structure data in the right places. |
| 547 |
|
| 548 |
Our first attempt to do this was slightly faulty and, in some cases, |
| 549 |
resulted in the addition of an incorrect \cs{parskip} space; this has |
| 550 |
now been corrected. The implementation that achieves this is a rather |
| 551 |
\enquote{interesting} study in obfuscated \TeX{} coding\Dash it is |
| 552 |
described in \file{latex-lab-math.pdf} for the interested. |
| 553 |
|
| 554 |
When using \LuaTeX{} the situation is much better because the |
| 555 |
necessary extra structures can be added at a later stage, after the |
| 556 |
formula has been typeset. |
| 557 |
% |
| 558 |
\taggingissue{762} |
| 559 |
|
| 560 |
|
| 561 |
\subsection{Local changes to spacing around math displays} |
| 562 |
|
| 563 |
Due to \TeX{}'s low-level handling of display math, it is very |
| 564 |
difficult to add the code needed for tagging within such display math |
| 565 |
formulas whilst ensuring that such code always stays on the same page |
| 566 |
as the formula. This is because such code must be placed after the |
| 567 |
end of the display, but before the \TeX{} engine adds a |
| 568 |
\cs{postdisplaypenalty} to the page. However, there is no way to add |
| 569 |
code in the middle of this low-level \TeX{} processing, which is why |
| 570 |
we have to resort to complex gymnastics as already hinted at: we set |
| 571 |
\cs{postdisplaypenalty} locally to 10000 and also make sure that |
| 572 |
\cs{belowdisplayskip} when used by \TeX{} is negative. Then we let |
| 573 |
\TeX{} do its job and afterwards regain control via \cs{aftergroup} |
| 574 |
and insert the tagging code. Finally, we add the real |
| 575 |
\cs{postdisplaypenalty} and make a space correction. |
| 576 |
|
| 577 |
With our first implementation of this approach it was not possible for |
| 578 |
a user to add an explicit \cs{postdisplaypenalty} or |
| 579 |
\cs{belowdisplayskip} setting inside the formula. In this release we |
| 580 |
have slightly altered our algorithm to make such user adjustments |
| 581 |
possible again. |
| 582 |
% |
| 583 |
\taggingissue{809} |
| 584 |
|
| 585 |
|
| 586 |
\subsection{Extended support for pictures} |
| 587 |
|
| 588 |
|
| 589 |
The tagging of graphics has been reimplemented and now uses tagging |
| 590 |
sockets (see above). Document authors can choose between four tagging |
| 591 |
flavors on a per-graphic basis: as illustrative figures, as artifacts |
| 592 |
(i.e., decorations), as replacements for symbols, and if applicable as |
| 593 |
normal text (for example, \enquote{todo notes}). To this effect the |
| 594 |
options of \cs{includegraphics} and the environments \env{picture} and |
| 595 |
\env{tikzpicture} have been extended and now accept keys such as |
| 596 |
\texttt{alt} (for the description text of illustrative figures), |
| 597 |
\texttt{actualtext} (to set the symbol), and \texttt{artifact}. |
| 598 |
%% |
| 599 |
The code supports graphics produced using the \pkg{tikz} packages and |
| 600 |
\enquote{todo notes} from the \pkg{todonotes} package. The |
| 601 |
extended documentation in \texttt{latex-lab-graphics.pdf} lists the |
| 602 |
full set of options and also describes what authors of other graphic |
| 603 |
packages can do to make their packages tagging aware. |
| 604 |
|
| 605 |
|
| 606 |
|
| 607 |
|
| 608 |
\section{New or improved commands} |
| 609 |
|
| 610 |
\subsection{Socket-and-plug conditionals} |
| 611 |
|
| 612 |
It is sometimes necessary, or helpful, to know whether a particular |
| 613 |
socket or plug exists (or whether a plug is assigned to a certain |
| 614 |
socket) and, based on such information, to take different |
| 615 |
actions. With the current release we added conditionals, such as |
| 616 |
\cs{IfSocketExistsTF}, to support such scenarios. Corresponding L3 |
| 617 |
programming layer conditionals are also provided. |
| 618 |
% |
| 619 |
\githubissue{1577} |
| 620 |
|
| 621 |
|
| 622 |
\subsection{Accessing the current counter} |
| 623 |
|
| 624 |
Counter commands such as \cs{alph}, \cs{stepcounter}, can now use the |
| 625 |
argument \texttt{*} to denote the \emph{current counter} (in the sense |
| 626 |
used by \cs{label}). This is compatible with the use by the |
| 627 |
\pkg{enumitem} package of \verb|\alph*| in item labels; and it is now |
| 628 |
generally available. Not all commands accept \verb|*|; for example, |
| 629 |
\verb|\counterwithin| and \verb|\counterwithout| still require counter |
| 630 |
names as before. |
| 631 |
% |
| 632 |
\githubissue{1632} |
| 633 |
|
| 634 |
\subsection{Collecting environment bodies verbatim} |
| 635 |
|
| 636 |
The mechanisms provided with \cs{NewDocumentCommand}, etc., offer a |
| 637 |
powerful way to specify a range of types of document command and |
| 638 |
environment syntax. This includes the ability to collect the entire |
| 639 |
body of an environment, for cases where treating it as a standard |
| 640 |
argument is useful. It is also possible to use this mechanism to define |
| 641 |
arguments which grab their content verbatim. To date, however, it was |
| 642 |
not possible to combine these two ideas. |
| 643 |
|
| 644 |
In this release a new specifier,~\texttt{c}, has been introduced for |
| 645 |
use in \cs{NewDocumentEnvironment} and friends: this collects the body |
| 646 |
of an environment in a verbatim-like way. As with the existing |
| 647 |
\texttt{+v}~specification, each separate line is marked by the special |
| 648 |
\cs{obeyedline} marker, which |
| 649 |
%FMi |
| 650 |
%, as usual, |
| 651 |
by default |
| 652 |
issues a normal |
| 653 |
paragraph. Thus, this new specifier is usable both for typesetting and |
| 654 |
for collecting file contents (the letter~\texttt{c} indicates |
| 655 |
\enquote{collect code}). Thus, we may use\footnote{Proper support |
| 656 |
for Tagged PDF needs additional code which is not shown here.} |
| 657 |
\begin{verbatim} |
| 658 |
\NewDocumentEnvironment |
| 659 |
{MyVerbatim}{!O{\ttfamily} c} |
| 660 |
{\begin{flushright}#1 #2\end{flushright}} |
| 661 |
{} |
| 662 |
\begin{MyVerbatim}[\ttfamily\itshape] |
| 663 |
% Some code is shown here |
| 664 |
$y = mx + c$ |
| 665 |
\end{MyVerbatim} |
| 666 |
\end{verbatim} |
| 667 |
to obtain |
| 668 |
\begin{quote} |
| 669 |
\makeatletter |
| 670 |
\def\@verbatim{% |
| 671 |
\trivlist |
| 672 |
\raggedleft |
| 673 |
\let \do \@makeother |
| 674 |
\dospecials |
| 675 |
\obeylines |
| 676 |
\normalfont \ttfamily \itshape |
| 677 |
\@noligs |
| 678 |
} |
| 679 |
\begin{verbatim} |
| 680 |
% Some code is shown here |
| 681 |
$y = mx + c$ |
| 682 |
\end{verbatim} |
| 683 |
\end{quote} |
| 684 |
|
| 685 |
|
| 686 |
|
| 687 |
\section{Code improvements} |
| 688 |
|
| 689 |
\subsection{Refinement of \cs{MakeTitlecase}} |
| 690 |
|
| 691 |
We introduced \cs{MakeTitlecase} as a late addition to the June 2022 |
| 692 |
release, making use of the improved case code in the L3 programming |
| 693 |
layer. Compared to upper and lowercasing, making text titlecased is even |
| 694 |
trickier to get right: it can be applied either to the whole text, or |
| 695 |
on a word-by-word basis. |
| 696 |
|
| 697 |
A subtle issue was reported concerning the L3 programming layer |
| 698 |
(\url{https://github.com/latex3/latex3/issues/1316}); this |
| 699 |
is related to how we deal with the case changing of \enquote{words} |
| 700 |
but it also shows up when you titlecase some text stored in a command. |
| 701 |
|
| 702 |
We have looked again at how to implement \cs{MakeTitlecase} in order |
| 703 |
to make it as predictable as possible, and we have made a change in |
| 704 |
this release. The command no longer tries to lowercase text before |
| 705 |
applying titlecasing, and it therefore gives correct results for text |
| 706 |
stored in commands. |
| 707 |
|
| 708 |
We have also added an additional key to the optional argument to |
| 709 |
\cs{MakeTitlecase} which allows the user to decide if the case change |
| 710 |
gets applied only to the first word (the default) or to all the words. |
| 711 |
|
| 712 |
|
| 713 |
\subsection{Tab character as a special character} |
| 714 |
|
| 715 |
In \LaTeX{} News~38~\cite[p.\,95]{41:ltnews}, we described a change to \cs{verb}, etc., that |
| 716 |
makes the tab character equivalent to a space; we have now completed |
| 717 |
this work by adding the tab character to the list of characters |
| 718 |
covered by \cs{dospecials}. This allows tab to be used, for example, |
| 719 |
in a \texttt{v}~specification document command without the need for |
| 720 |
additional steps. |
| 721 |
|
| 722 |
|
| 723 |
\subsection{Refinement of \texttt{v}~specification category codes} |
| 724 |
|
| 725 |
Work on verbatim argument handling has highlighted that it is |
| 726 |
problematic to store all characters as \enquote{other} (category |
| 727 |
code~12) when using a \texttt{v}~specification in |
| 728 |
\cs{NewDocumentCommand}, etc. We have therefore now revised this so |
| 729 |
that characters of category code letter retain their original category |
| 730 |
code. |
| 731 |
|
| 732 |
|
| 733 |
\subsection{Logging declarations of commands and symbols} |
| 734 |
|
| 735 |
For thirty years the documentation claimed that |
| 736 |
\cs{DeclareTextSymbol}, \cs{DeclareTextCommand} and friends all log |
| 737 |
their changes. However, in contrast to their math counterparts, they never |
| 738 |
in fact did so. This behavior has now finally been corrected. |
| 739 |
% |
| 740 |
\githubissue{1242} |
| 741 |
|
| 742 |
\subsection{Improved management of the NFSS font series} |
| 743 |
|
| 744 |
\LaTeX's font selection mechanism (NFSS) supports 9~weight levels, |
| 745 |
from ultra-light~(\texttt{ul}) to ultra-bold~(\texttt{ub}), and also |
| 746 |
9~width levels, from ultra-condensed~(\texttt{uc}) to |
| 747 |
ultra-expanded~(\texttt{ux}). In the February~2020 release this |
| 748 |
mechanism was extended, so that requests to set the weight or the |
| 749 |
width attributes of a font series are combined in a sensible |
| 750 |
way~\cite[p.\,52]{41:ltnews}: for example, if you typeset a paragraph |
| 751 |
in a condensed face using \verb+\fontseries{c}\selectfont+ and then |
| 752 |
you use \cs{textbf} inside the paragraph, a bold condensed face is |
| 753 |
selected. The combination of such values is done by consulting a |
| 754 |
simple lookup table whose entries are defined by using the command |
| 755 |
\cs{DeclareFontSeriesChangeRule}. |
| 756 |
|
| 757 |
Until now, this lookup table was missing some entries, especially with |
| 758 |
regard to rarely used width values. In such cases, the series values |
| 759 |
were not combined as expected. This has been fixed (thanks to Maurice |
| 760 |
Hansen) by adding numerous \cs{DeclareFontSeriesChangeRule} entries so |
| 761 |
that, when combining these font series values, the full range of |
| 762 |
weights (from \texttt{ul} to \texttt{ub}) and widths (from \texttt{uc} |
| 763 |
to \texttt{ux}) is now supported. |
| 764 |
% |
| 765 |
\githubissue{1583} |
| 766 |
|
| 767 |
|
| 768 |
\subsection{Supporting the \texttt{ssc} and \texttt{sw} font shapes} |
| 769 |
|
| 770 |
The \texttt{ssc} font shape (spaced small capitals) is supported in |
| 771 |
\LaTeX{} through the commands \cs{sscshape} and \cs{textssc}. However, |
| 772 |
until this release there were no font shape change rules defined for |
| 773 |
this, admittedly seldom available, shape; so |
| 774 |
\begin{verbatim} |
| 775 |
\sscshape\itshape |
| 776 |
\end{verbatim} |
| 777 |
changed unconditionally to \texttt{it} (italics) rather than to |
| 778 |
\texttt{sscit} (spaced small italic capitals). Thanks to Michael |
| 779 |
Ummels, the missing declarations have now been added, so shape changes |
| 780 |
in font families that support spaced small capitals work properly. |
| 781 |
% |
| 782 |
At the same time we took the opportunity to improve the fallbacks for |
| 783 |
the \texttt{sw} (swash) shapes, which are accessible through the |
| 784 |
commands \cs{swshape} or \cs{textsw}. If an \texttt{sw} combination is |
| 785 |
not available, the rules now try to replace \texttt{sw} with |
| 786 |
\texttt{it} rather than falling back to \texttt{n}. |
| 787 |
% |
| 788 |
\githubissue{1581} |
| 789 |
|
| 790 |
|
| 791 |
\subsection{Improving the handling of \cs{label}, \cs{index}, and \cs{glossary}} |
| 792 |
|
| 793 |
In standard \LaTeX{}, the three commands \cs{label}, \cs{index}, and |
| 794 |
\cs{glossary} take exactly one mandatory argument, e.g., |
| 795 |
\verb=\index{=\meta{entry}\verb=}=. In some extension packages, for |
| 796 |
example \pkg{index} or \pkg{cleveref}, these are all augmented to |
| 797 |
accept an optional argument and, in the case of \cs{index}, also a |
| 798 |
star form. These extensions conflicted with \LaTeX's way of disabling |
| 799 |
these commands within the table of contents and within running headers |
| 800 |
because they were, in these places, redefined to expect just a |
| 801 |
mandatory argument and then do nothing. We have now changed this |
| 802 |
behavior, so that the redefinitions in these places now accept this |
| 803 |
extended syntax. |
| 804 |
% |
| 805 |
\githubissue{311} |
| 806 |
|
| 807 |
\subsection{Tracing lost characters} |
| 808 |
|
| 809 |
In \LaTeX\ News 33~\cite[p.\,63]{41:ltnews} we announced that |
| 810 |
\cs{tracingall} changes \cs{tracinglostchars} to an error |
| 811 |
condition. This change has been reverted and \cs{tracingall} and |
| 812 |
\cs{tracingnone} no longer alter \cs{tracinglostchars}, so its |
| 813 |
current setting is retained. |
| 814 |
|
| 815 |
The default value used in \LaTeX{} is set so that lost character |
| 816 |
information is written as a warning to both the log and the terminal. |
| 817 |
Users may wish to change this into an error, in which case |
| 818 |
\cs{tracinglostchars} should be set to~5 (not~3) as this works in all |
| 819 |
engines. |
| 820 |
% |
| 821 |
\githubissue{1687} |
| 822 |
|
| 823 |
|
| 824 |
\subsection{Always use the extended pool of registers} |
| 825 |
|
| 826 |
As the kernel has grown, the use of registers has risen to the |
| 827 |
point where rolling back to the classical register allocation approach |
| 828 |
(using only 256 registers) is no longer viable. We have therefore |
| 829 |
adjusted the rollback code so that even when requesting a pre-2015 |
| 830 |
\LaTeX{}, the extended pool remains in use. |
| 831 |
|
| 832 |
\subsection{A version of \cs{input} for expansion contexts} |
| 833 |
|
| 834 |
The \LaTeX{} definition of \cs{input} cannot be used in places where |
| 835 |
\TeX{} is performing expansion: the classic example is at the start of |
| 836 |
a tabular cell. There are a number of reasons for this: the key ones |
| 837 |
are that \LaTeX{}'s \cs{input} records which files are read, and |
| 838 |
provides pre- and post-file hooks. |
| 839 |
% |
| 840 |
To support the need to carry out file input in expansion contexts, we |
| 841 |
have now added \cs{expandableinput}; this skips recording the file |
| 842 |
name and does not apply any file hooks, but otherwise behaves like |
| 843 |
\cs{input}. In particular, it still uses \cs{input@path} when doing |
| 844 |
file lookup (contrasting with the behavior of the \TeX{} primitive, |
| 845 |
which remains internally available for programmers as \cs{@@input}). |
| 846 |
% |
| 847 |
\githubissue{514} |
| 848 |
|
| 849 |
|
| 850 |
\section{Bug fixes} |
| 851 |
|
| 852 |
|
| 853 |
\subsection{Avoid problems with page breaks in the middle of \env{verbatim}-like environments} |
| 854 |
|
| 855 |
If a page break occurs in the middle of an environment that sets up |
| 856 |
special \cs{catcode} settings, such as a \env{verbatim} environment, |
| 857 |
then these settings will remain active when the output routine is |
| 858 |
building the page. This is normally harmless, because the material |
| 859 |
contained in the page had been previously tokenized, so that the |
| 860 |
\cs{catcode} changes do not matter. However, in certain circumstances |
| 861 |
tokenization can happen during this page processing: for example, if |
| 862 |
processing the header involves reading in a file; or if there is a |
| 863 |
command that uses \cs{scantokens} so that it retokenizes some material |
| 864 |
using the verbatim settings. |
| 865 |
|
| 866 |
This has been fixed and \LaTeX{} now explicitly resets the |
| 867 |
\cs{catcode} values to their default settings when entering the output |
| 868 |
routine. Furthermore, packages that make changes to the tokenization |
| 869 |
beyond what is done by \env{verbatim} can use the newly introduced |
| 870 |
hook \hook{build/page/reset} to add their own resets to the output |
| 871 |
routine processing. This hook is evaluated after \LaTeX{} has done its |
| 872 |
reset, so it is also possible, if necessary, to overwrite \LaTeX{}'s |
| 873 |
default behavior. |
| 874 |
% |
| 875 |
\githubissue{600} |
| 876 |
|
| 877 |
|
| 878 |
|
| 879 |
\subsection{Fix for nested use of \texttt{localmathalphabets}} |
| 880 |
|
| 881 |
In 2021 we introduced a method to overcome the problem that classic |
| 882 |
\TeX{} engines (but not the Unicode engines) have only a very limited |
| 883 |
number of math alphabets available (so they easily got used up by |
| 884 |
loading math font packages, even if their symbols got used only |
| 885 |
occasionally). The idea was to avoid allocating all math alphabets |
| 886 |
globally, but instead to allow a number of them (defined by counter |
| 887 |
\texttt{localmathalphabets}) to vary from one formula to the next. This |
| 888 |
means that different formulas can make use of different alphabets, |
| 889 |
so the chances are much higher that the processing of a complex |
| 890 |
document succeeds. See~\cite[p.\,69]{41:ltnews} for details. |
| 891 |
|
| 892 |
Unfortunately, the approach we took back then failed in some cases of |
| 893 |
nested formulas, with the result that the wrong glyphs were used. |
| 894 |
This has now been corrected. |
| 895 |
% |
| 896 |
\githubissue[s]{1101 1028} |
| 897 |
|
| 898 |
|
| 899 |
\subsection{\pkg{docstrip}:\ Error if an \texttt{.ins} file is problematic} |
| 900 |
|
| 901 |
If the file to be generated had the same name as a preamble declared |
| 902 |
with \cs{declarepreamble} then the preamble definition was |
| 903 |
overwritten, because the macro used to store it got reused to denote |
| 904 |
the output stream. The same problem happened with postambles declared |
| 905 |
with \cs{declarepostamble}. This situation is now detected and an |
| 906 |
error message is issued. To circumvent the issue, simply |
| 907 |
use a different macro name for the preamble or postamble. |
| 908 |
% |
| 909 |
\githubissue{1150} |
| 910 |
|
| 911 |
|
| 912 |
\subsection{Prevent a \texttt{cmd} hook from defining an undefined command} |
| 913 |
|
| 914 |
Using \verb=\AddToHook{cmd/FOO/...}= when the command \cs{FOO} was |
| 915 |
undefined resulted in this command becoming \cs{relax}. Thus, if used, |
| 916 |
it no longer raised an \enquote{Undefined control sequence} error, but |
| 917 |
silently did nothing. This behavior has been corrected, and, if the |
| 918 |
command \cs{FOO} does not get defined later, e.g., in a package, it |
| 919 |
now raises an error when it is used in the document. |
| 920 |
% |
| 921 |
\githubissue{1591} |
| 922 |
|
| 923 |
|
| 924 |
\subsection{Process global options just once per package} |
| 925 |
|
| 926 |
In 2022, we introduced key--value (keyval) option processing in the |
| 927 |
kernel~\cite[p.\,77]{41:ltnews}. This also added the idea that keys |
| 928 |
could have scope: load-only, preamble-only and general use. However, |
| 929 |
we overlooked that an option given globally (in the optional argument |
| 930 |
to \cs{documentclass}) would be repeatedly processed and could |
| 931 |
therefore lead to spurious warnings. This has now been corrected so |
| 932 |
that now each global option is seen, by the keyval-based option |
| 933 |
handling system, exactly once per package. |
| 934 |
% |
| 935 |
\githubissue{1619} |
| 936 |
|
| 937 |
|
| 938 |
\subsection{Make \cs{label}, \cs{index}, and \cs{glossary} truly invisible in running headers} |
| 939 |
|
| 940 |
\LaTeX{} has had this bug since its initial implementation: whilst it |
| 941 |
correctly ignored any \cs{label}, \cs{index}, or \cs{glossary} command |
| 942 |
that appears in a mark, it neglected correct handling of the spaces |
| 943 |
around the command. As a result, one could end up with two spaces in |
| 944 |
the running header where only one should be present. This was detected |
| 945 |
as part of working on issue~311 and has now been corrected. |
| 946 |
% |
| 947 |
\githubissue{1638} |
| 948 |
|
| 949 |
|
| 950 |
|
| 951 |
\subsection [Fully expand the arguments of \cs{counterwithin} and \cs{counterwithout}]% |
| 952 |
{Fully expand the arguments of the declarations \cs{counterwithin} and \cs{counterwithout}} |
| 953 |
|
| 954 |
The arguments of the commands \cs{counterwithin} and |
| 955 |
\cs{counterwithout} are two counter names that are used to reset (or |
| 956 |
not reset) one counter when the other is stepped. They also redefine |
| 957 |
the representation of that counter, e.g., |
| 958 |
\verb=\counterwithin{section}{chapter}= would lead to: |
| 959 |
\begin{verbatim} |
| 960 |
\renewcommand\thesection |
| 961 |
{\thechapter.\arabic{section}} |
| 962 |
\end{verbatim} |
| 963 |
However, if one of these counters was not named explicitly, as in this |
| 964 |
example: |
| 965 |
\begin{verbatim} |
| 966 |
\newcommand\sectioncounter{section} |
| 967 |
\counterwithin{\sectioncounter}{chapter} |
| 968 |
\end{verbatim} |
| 969 |
then we ended up with |
| 970 |
\begin{verbatim} |
| 971 |
\renewcommand\thesection |
| 972 |
{\thechapter.\arabic{\sectioncounter}} |
| 973 |
\end{verbatim} |
| 974 |
which could lead to strange results if \cs{sectioncounter} got changed |
| 975 |
later on. |
| 976 |
% |
| 977 |
This has been corrected: these arguments now get fully expanded when |
| 978 |
the declaration is made. |
| 979 |
% |
| 980 |
\githubissue{1675} |
| 981 |
|
| 982 |
|
| 983 |
|
| 984 |
\subsection{Correction in the float placement algorithm} |
| 985 |
|
| 986 |
When floats are added to the current or next page, \LaTeX{} makes |
| 987 |
several tests in order to find an area that can receive the float. One |
| 988 |
of these tests calculates how much space is already used on the page |
| 989 |
and how much additional space is needed to place the float in a |
| 990 |
particular area. This means that it looks not only at the height of |
| 991 |
the float but also at the values from \cs{intextsep} (for \texttt{h} |
| 992 |
floats) or \cs{textfloatsep} and \cs{floatsep} (for \texttt{t} and |
| 993 |
\texttt{b} floats). The resulting space requirement was then stored in |
| 994 |
an internal variable and compared to the space still available on the |
| 995 |
page. If the test failed, the algorithm tried the next area. |
| 996 |
|
| 997 |
Unfortunately, the code was reusing the value in that internal |
| 998 |
variable as the starting point for the next test, without removing the |
| 999 |
added space for the float separation (\cs{intextsep}, \cs{floatsep}, |
| 1000 |
or \cs{textfloatsep}). Thus the comparison was being made with the |
| 1001 |
wrong value (i.e., too high); therefore the test may have incorrectly |
| 1002 |
concluded that a float doesn't fit, even when it would in fact have fit. |
| 1003 |
This has now been corrected. |
| 1004 |
% |
| 1005 |
\githubissue{1645} |
| 1006 |
|
| 1007 |
|
| 1008 |
\subsection{Correct \cs{CheckEncodingSubset}} |
| 1009 |
|
| 1010 |
In \cite[p.\,83]{41:ltnews}, and again in \cite[p.\,100]{41:ltnews}, |
| 1011 |
we suggested that font maintainers should place an appropriate |
| 1012 |
\cs{DeclareEncodingSubset} declaration in each |
| 1013 |
\texttt{ts1\meta{family}.fd} file, so that this is tied to the font |
| 1014 |
definition and so will be available whenever a font family is |
| 1015 |
explicitly selected by \cs{fontfamily}\texttt{\{\meta{name}\}} instead |
| 1016 |
of using a font support package. Unfortunately, however, this method |
| 1017 |
could result in incorrect selection of glyphs if the font encoding |
| 1018 |
subset setting was evaluated before the \texttt{.fd} file was loaded |
| 1019 |
\finalpagebreak |
| 1020 |
(as subset 9 would then be assumed). This has been corrected: |
| 1021 |
\cs{CheckEncodingSubset} now first loads the \texttt{.fd} file when |
| 1022 |
this is necessary. |
| 1023 |
% |
| 1024 |
\githubissue{1669} |
| 1025 |
|
| 1026 |
|
| 1027 |
\subsection{Ensuring late \cs{write} commands aren't lost} |
| 1028 |
|
| 1029 |
If a non-\cs{immediate} \cs{write} command is used after the final |
| 1030 |
page has been shipped out then no write will happen because the system |
| 1031 |
waits for a \cs{shipout} that will never happen. After the last page |
| 1032 |
has been shipped out, we therefore force all further \cs{write} calls |
| 1033 |
to be \cs{immediate}: this ensures that they get written even though |
| 1034 |
we are not going to ship out any more pages. This change of behavior |
| 1035 |
is implemented just before the \texttt{enddocument/afterlastpage} hook |
| 1036 |
because this hook may contain such \cs{write} commands. |
| 1037 |
% |
| 1038 |
\githubissue{1689} |
| 1039 |
|
| 1040 |
|
| 1041 |
\section{Documentation} |
| 1042 |
|
| 1043 |
\subsection{Clarifying the handling of spaces by \cs{textcolor}} |
| 1044 |
|
| 1045 |
In contrast to other \cs{text}-commands such as \cs{textbf} or |
| 1046 |
\cs{textrm}, the command \cs{textcolor} gobbles spaces at the start of |
| 1047 |
its argument. Thus, for example, |
| 1048 |
\verb*=Hello\textcolor{red}{ World}= will produce the output |
| 1049 |
Hello\textcolor{red}{ World}\tubcommand{ (grayscaled for |
| 1050 |
the printed \textsl{TUGboat})}. |
| 1051 |
There are technical as well as |
| 1052 |
compatibility reasons for this, so the behavior will not change. This |
| 1053 |
is now correctly documented. |
| 1054 |
% |
| 1055 |
\githubissue{1474} |
| 1056 |
|
| 1057 |
|
| 1058 |
\section{Changes to packages in the \pkg{amsmath} category} |
| 1059 |
|
| 1060 |
\subsection{\cs{numberwithin} now aliased to \cs{counterwithin}} |
| 1061 |
|
| 1062 |
The \pkg{amsmath} package offers a \cs{numberwithin} declaration to |
| 1063 |
specify that a counter should be reset whenever some other counter is |
| 1064 |
stepped. This is a restricted version of the more general kernel |
| 1065 |
command \cs{counterwithin} which was introduced in the \LaTeX{} kernel |
| 1066 |
in 2018 and extended in 2021~\cite[p.\,72]{41:ltnews}. With the |
| 1067 |
current release we have made \cs{numberwithin} an alias for the more |
| 1068 |
powerful \cs{counterwithin} and we suggest that the latter command is |
| 1069 |
used in new documents. |
| 1070 |
% |
| 1071 |
\githubissue{1673} |
| 1072 |
|
| 1073 |
|
| 1074 |
\subsection{\pkg{amsmath}:\ Correct equation tag placement} |
| 1075 |
|
| 1076 |
If there is not enough space to place an equation tag on the same line |
| 1077 |
as the equation then \pkg{amsmath} calculates a suitable offset |
| 1078 |
placement for the tag, above (or below) the equation. In the case of |
| 1079 |
the \env{gather} environment this offset was not reset correctly, so |
| 1080 |
that it also got applied to these tags in any following environment, |
| 1081 |
which gave incorrect placement in certain situations. The fix for |
| 1082 |
this, implemented in 2024/06, was not entirely correct; so this has |
| 1083 |
been changed to do such resetting at the start of every displayed |
| 1084 |
math environment. |
| 1085 |
% |
| 1086 |
\githubissue{1289} |
| 1087 |
|
| 1088 |
|
| 1089 |
\section{Changes to packages in the \pkg{graphics} category} |
| 1090 |
|
| 1091 |
\subsection{More accessibility keys in \pkg{graphicx}} |
| 1092 |
|
| 1093 |
The \cs{includegraphics} command now accepts \verb|actualtext| and |
| 1094 |
\verb|artifact| keys, which by default do nothing but are used by the |
| 1095 |
tagging code to provide an ActualText string or a boolean flag to |
| 1096 |
indicate that the graphic is an artifact. |
| 1097 |
% |
| 1098 |
\githubissue{1552} |
| 1099 |
|
| 1100 |
|
| 1101 |
\section{Changes to packages in the \pkg{tools} category} |
| 1102 |
|
| 1103 |
\subsection{\pkg{multicol}:\ Full support for extended marks} |
| 1104 |
|
| 1105 |
In 2022 we introduced a new mark mechanism for |
| 1106 |
\LaTeX{}~\cite[p.\,76]{41:ltnews}. However, the initial implementation |
| 1107 |
covered only the standard output routine of \LaTeX{}. As a result the |
| 1108 |
extended marks were not available within columns produced with the |
| 1109 |
\pkg{multicol} package (where they would be especially useful). This |
| 1110 |
limitation has finally been lifted so that the new mechanism is now |
| 1111 |
fully supported by all of our packages. |
| 1112 |
% |
| 1113 |
\githubissue{1421} |
| 1114 |
|
| 1115 |
|
| 1116 |
\subsection{\pkg{array}:\ Improve preamble code for \texttt{p}, \texttt{m} and \texttt{b}} |
| 1117 |
|
| 1118 |
When the preamble of a \env{tabular} or \env{array} is being built, |
| 1119 |
the arguments to \texttt{p}, \texttt{m}, or \texttt{b} columns all get |
| 1120 |
expanded several times. This is normally harmless because that |
| 1121 |
argument usually contains just an explicit dimension. However, in a |
| 1122 |
case such as \verb=p{\fpeval{15}pt}= these expansions resulted in an |
| 1123 |
error; this happened because \cs{fpeval} was expanded a few times, but |
| 1124 |
not often enough to result in a single number. This has now been |
| 1125 |
corrected: these arguments are not expanded at all. This allows for |
| 1126 |
such edge cases and also for the extensions available with the |
| 1127 |
\pkg{calc} package, such as \verb=p{\widthof{AAAAAA}}=. |
| 1128 |
% |
| 1129 |
\githubissue{1585} |
| 1130 |
|
| 1131 |
|
| 1132 |
\subsection{\pkg{array}:\ Fix handling of empty p-cells} |
| 1133 |
|
| 1134 |
If an \cs{arraystretch} greater than \texttt{1} is used, table rows are |
| 1135 |
spread apart by placing suitable struts (invisible rules) into each |
| 1136 |
row, or in case of p-cells into each cell. If such a cell was empty |
| 1137 |
the placement of the strut was not correct so that the cell appeared |
| 1138 |
to be larger than it should have been. This has now been corrected. |
| 1139 |
% |
| 1140 |
\githubissue{1730} |
| 1141 |
|
| 1142 |
|
| 1143 |
|
| 1144 |
|
| 1145 |
\subsection[\pkg{varioref}:\ How to make \cs{reftext...}\ empty] |
| 1146 |
{\pkg{varioref}:\ How to make \cs{reftextfaceafter}, etc.\ empty} |
| 1147 |
|
| 1148 |
In the case that one wants to make a command such as |
| 1149 |
\cs{reftextfaceafter} produce truly nothing, one has to get rid of the |
| 1150 |
space that is automatically placed in front of the command by |
| 1151 |
\cs{vref}. This can be done by simply defining the command to remove |
| 1152 |
it, e.g., |
| 1153 |
\begin{verbatim} |
| 1154 |
\renewcommand\reftextfaceafter{\unskip} |
| 1155 |
\end{verbatim} |
| 1156 |
The \pkg{varioref} package does not test if such strings are empty, |
| 1157 |
\finalpagebreak |
| 1158 |
because that would require a lot of tests each time \cs{vref} is used, |
| 1159 |
and it would nearly always find that the text is not empty. However, |
| 1160 |
as shown above, the solution for this uncommon case is simple, and it |
| 1161 |
is now explicitly documented in the package documentation. |
| 1162 |
% |
| 1163 |
\githubissue{1622} |
| 1164 |
|
| 1165 |
|
| 1166 |
\section{Changes to files in the L3 programming layer} |
| 1167 |
|
| 1168 |
|
| 1169 |
Work on the L3 programming layer continues in parallel with |
| 1170 |
development of the rest of the \LaTeX{} kernel. Of note for |
| 1171 |
developers is that we have integrated more code into the main |
| 1172 |
\pkg{l3kernel} bundle, and therefore into the functionality available |
| 1173 |
automatically in \LaTeX{}. Most notably, \pkg{l3benchmark}, which |
| 1174 |
provides tools for checking code performance, is now part of |
| 1175 |
\pkg{l3kernel}. |
| 1176 |
|
| 1177 |
We have also extended the \pkg{color} module to recognize the Oklab |
| 1178 |
and Oklch color models; thanks to Markus Kurtz for contributing this |
| 1179 |
code. The Oklab color space |
| 1180 |
(\url{https://bottosson.github.io/posts/oklab}) is a perceptual color |
| 1181 |
space which is supported by CSS and so also by modern web browsers; |
| 1182 |
Oklch expresses the Oklab color space in cylindrical form. |
| 1183 |
|
| 1184 |
%\section{Changes to files in the \pkg{cyrillic} category} |
| 1185 |
|
| 1186 |
\begin{thebibliography}{9}\frenchspacing |
| 1187 |
|
| 1188 |
%\fontsize{9.3}{11.3}\selectfont |
| 1189 |
|
| 1190 |
\bibitem{41:Lamport} |
| 1191 |
Leslie Lamport. |
| 1192 |
\newblock \emph{{\LaTeX}: {A} Document Preparation System: User's Guide and Reference |
| 1193 |
Manual}. |
| 1194 |
\newblock \mbox{Addison}-Wesley, Reading, MA, USA, 2nd edition, 1994. |
| 1195 |
\newblock ISBN 0-201-52983-1. |
| 1196 |
\newblock Reprinted with corrections in 1996. |
| 1197 |
|
| 1198 |
\bibitem{41:ltnews} \LaTeX{} Project Team. |
| 1199 |
\emph{\LaTeXe{} news 1--41}. June~2025. |
| 1200 |
\url{https://latex-project.org/news/latex2e-news/ltnews.pdf} |
| 1201 |
|
| 1202 |
\bibitem{41:ltmarks} Frank Mittelbach, \LaTeX{} Project Team. |
| 1203 |
\emph{The \texttt{ltmarks.dtx} code}. June~2025. |
| 1204 |
\url{https://latex-project.org/help/documentation/ltmarks-doc.pdf} |
| 1205 |
|
| 1206 |
\bibitem{41:source2e} \LaTeX{} Project Team. |
| 1207 |
\emph{The \LaTeXe{} Sources}. June~2025. |
| 1208 |
\url{https://latex-project.org/help/documentation/source2e.pdf} |
| 1209 |
|
| 1210 |
\end{thebibliography} |
| 1211 |
|
| 1212 |
\end{document} |