Debian Codegraph @

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

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2015-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: ltnews22.tex
30 %
31 % This is issue 22 of LaTeX News.
32
33 \documentclass{ltnews}
34 \usepackage[T1]{fontenc}
35
36 \usepackage{lmodern,url,hologo}
37
38 \publicationmonth{January}
39 \publicationyear{2015}
40
41 \publicationissue{22}
42
43 \providecommand\pkg[1]{\texttt{#1}}
44 \providecommand\cls[1]{\texttt{#1}}
45 \providecommand\option[1]{\texttt{#1}}
46 \providecommand\env[1]{\texttt{#1}}
47 \providecommand\file[1]{\texttt{#1}}
48
49 \begin{document}
50
51 \maketitle
52
53 \section{New \LaTeXe\ bug-fix policy}
54
55 \subsection{Introduction}
56
57 For some years we have supplied bug fixes to the \LaTeXe\ kernel via the
58 \pkg{fixltx2e} package. This
59 kept the kernel stable, but at the expense of meaning that most users did not
60 benefit from bug fixes, and that some compromises
61 which were made to save space in the
62 machines of the time are still affecting most users today.
63
64 In this release we have started a new update policy. All the fixes previously
65 available via \pkg{fixltx2e} are now enabled \emph{by default} in the
66 format, as are some further extensions for extended \TeX\ engines, \eTeX,
67 \hologo{XeTeX} and \hologo{LuaTeX}. Compatibility and stability are still
68 important considerations, and while most users will not notice these
69 improvements, or will want to benefit from them, a new \pkg{latexrelease}
70 package is provided that will revert all the changes and re-instate the
71 definitions from earlier releases. The package can also be used with older
72 releases to effectively \emph{update} the kernel to be equivalent to this 2015
73 release.
74
75 A new document, \file{latexchanges}, is distributed with the release
76 that documents all the changes to documented commands since the 2014
77 \LaTeX\ release, and will be updated in future releases if further
78 changes have been made.
79
80 \subsection{The \pkg{latexrelease} package}
81
82 As noted above a new package is available to manage differences between \LaTeX\
83 releases. If you wish to revert all changes back to the definitions as they
84 were in previous releases you may start your document requesting the \LaTeX{} release from May~2014:
85 \begin{verbatim}
86 \RequirePackage[2014/05/01]{latexrelease}
87 \documentclass{article}
88 \end{verbatim}
89 Conversely if you start a large project now and want to protect yourself
90 against possible future changes, you may start your document
91 \begin{verbatim}
92 \RequirePackage[2015/01/01]{latexrelease}
93 \documentclass{article}
94 \end{verbatim}
95 Then the version of \pkg{latexrelease} distributed with any future \LaTeX\
96 release will revert any changes made in that format, and revert to the
97 definitions as they where at the beginning of 2015.
98
99 If you wish to share a document using the latest features with a
100 user restricted to using an older
101 format, you may use the form above and make the \pkg{latexrelease} package
102 available on the older installation. The package will then update the format
103 definitions as needed to enable the older format to work as if dated on the date
104 specified in the package option.
105
106 \subsection{The \cs{IncludeInRelease} command}
107
108 The mechanism used in the \pkg{latexrelease} package is available for use in
109 package code. If in your \pkg{zzz} package you have
110 \begin{verbatim}
111 \RequirePackage{latexrelease}
112 \IncludeInRelease{2015/06/01}
113 {\zzz}{\zzz definition}
114 \def\zzz......new code
115 \EndIncludeInRelease
116 \IncludeInRelease{0000/00/00}
117 {\zzz}{\zzz definition}
118 \def\zzz....original
119 \EndIncludeInRelease
120 \end{verbatim}
121 then in a document using a format dated 2015/06/01 or later, the ``new code''
122 will be used, and for documents being processed with an older format, the
123 ``original'' code will be used. Note the format date here may be the original
124 format date as shown at the start of every \LaTeX\ run, or a format date
125 specified as a package option to the \pkg{latexrelease} package.
126
127 So if the document has
128 \begin{verbatim}
129 \RequirePackage[2014/05/01]{latexrelease}
130 \documentclass{article}
131 \usepackage{zzz}
132 \end{verbatim}
133 then it will use the \emph{original} definition of \verb|\zzz| even if
134 processed with the current format, as the format acts as if dated 2014/05/01.
135
136
137 \subsection{Limitations of the approach}
138
139 The new concept provides full backward and forward compatibility for
140 the \LaTeX{} format, i.e., with the help of a current
141 \pkg{latexrelease} package the kernel can emulate all released
142 formats (starting with 2014/06/01\footnote{Patching an older format
143 most likely works too, given that the changes in the past have been
144 minimal, though this isn't guaranteed and hasn't been tested.}).
145
146
147 However, this is not necessarily true for all packages.
148 Only if a package makes use of the \cs{IncludeInRelease}
149 functionality will it adjust to the
150 requested \LaTeX{} release date. Initially this will only be true for
151 a few selected packages and in general it may not even be advisable for packages
152 that have their own well-established release cycles and methods.
153
154 Thus, to regenerate a document with 100\,\% compatible behavior
155 it will still be necessary
156 to archive it together with all its inputs, for example, by archiving
157 the base distribution trees (and any modifications made). However, the
158 fact that a document requests a specific \LaTeX{} release date should
159 help identifying what release tree to use to achieve perfect accuracy.
160
161
162 \section{Updates to the kernel}
163
164 \subsection{Updates incorporated from \pkg{fixltx2e}}
165
166 The detailed list of changes incorporated from \pkg{fixltx2e} is
167 available in the new \file{latexchanges} document that is
168 distributed with this release. The main changes are that $2$-column
169 floats are kept in sequence with one column floats, corrections are
170 made to the \verb|\mark| system to ensure correct page headings in
171 $2$-column documents, several additional commands are made robust.
172
173 \subsection{\eTeX\ register allocation}
174
175 \LaTeX\ has traditionally used allocation routines inherited from plain \TeX\
176 that allocated registers in the range $0$--$255$. Almost all distributions have
177 for some years used \eTeX\ based formats (or \hologo{XeTeX} or \hologo{LuaTeX})
178 which have $2^{15}$ registers of each type ($2^{16}$ in the case of
179 \hologo{LuaTeX}). The \pkg{etex} package has been available to provided an
180 allocation mechanism for these extended registers but now the format will by
181 default allocate in a range suitable for the engine being used. The new
182 allocation mechanism is different than the \pkg{etex} package mechanism, and
183 supports \hologo{LuaTeX}'s full range and an allocation mechanism for \LaTeX\
184 floats as described below.
185
186 On \eTeX\ based engines, an additional command, \verb|\newmarks| is available
187 (as with the \pkg{etex} package) that allocates extended \eTeX\ marks, and
188 similarly if \hologo{XeTeX} is detected a new command
189 \verb|\newXeTeXintercharclass| is available, this is similar to the command
190 previously defined in the \file{xelatex.ini} file used to build the
191 \texttt{xelatex} format.
192
193 \subsection{Additional \LaTeX{} float storage}
194
195 \LaTeX's float placement algorithm needs to store floats (figures and tables)
196 until it finds a suitable page to output them. It allocates $18$ registers for
197 this storage, but this can often be insufficient.
198 The contributed \pkg{morefloats} package has
199 been available to extend this list; however, it also only allocates from the
200 standard range $0$--$255$ so cannot take advantage of the extended registers.
201 The new allocation mechanism in this release incorporates a new command
202 \verb|\extrafloats|. If you get the error:
203 \mbox{\texttt{Too many unprocessed floats.}}
204 then you can add (say) \verb|\extrafloats{500}| to the document preamble to
205 make many more boxes available to hold floats.
206
207
208 \subsection{Built-in support for Unicode engines}
209
210 The kernel sources now detect the engine being used and adjust definitions
211 accordingly, this reduces the need for the ``\texttt{.ini}'' files used to make
212 the formats to patch definitions defined in \file{latex.ltx}.
213
214 As noted above the format now includes extended allocation routines.
215
216 The distribution includes a file \file{unicode-letters.def} derived from the
217 Unicode Consortium's Unicode Character Data files that details the upper and
218 lower case transformation data for the full Unicode range. This is used to set
219 the \verb|lccode| and \verb|uccode| values if a Unicode engine is being used,
220 rather than the values derived from the T1 font encoding which are used with
221 8-bit engines.
222
223 Finally \verb|\typein| is modified if \hologo{LuaTeX} is detected
224 such that it works with this engine.
225
226 \section{l3build}
227
228 This release has been tested and built using a new build system implemented in
229 \textsf{Lua}, intended to be run on the \textsf{texlua} interpreter distributed
230 with modern \TeX\ distributions. It is already separately available
231 from CTAN. This replaces earlier build systems (based at various times on
232 \textsf{make}, \textsf{cons}, and Windows \textsf{bat} files). It allows the
233 sources to be tested and packaged on a range of platforms (within the team,
234 OS X, Windows, Linux and Cygwin platforms are used). It also allows the
235 format to be tested on \hologo{XeTeX} and \hologo{LuaTeX} as well as the
236 standard \hologo{pdfTeX}/\eTeX\ engines.
237
238 \section{Hyperlinked documentation and TDS zip files}
239
240 As well as updating the build system, the team have looked again at exactly
241 what gets released to \textsc{ctan}. Taking inspiration from Heiko Oberdiek's
242 \textsf{latex-tds} bundle, the PDF documentation provided now includes
243 hyperlinks where appropriate. This has been done without modifying the sources
244 such that users without \pkg{hyperref} available can still typeset the
245 documentation using only the core distribution. At the same time, the release
246 now includes ready-to-install TDS-style zip files. This will be of principal
247 interest to \TeX\ system maintainers, but end users with older machines who
248 wish to manually update \LaTeX\ will also benefit.
249
250 \end{document}