diff options
| author | Karl Berry <karl@freefriends.org> | 2021-01-08 23:37:35 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2021-01-08 23:37:35 +0000 |
| commit | c8a8389b451ae31ce16dad7f82b0866b662c0fcc (patch) | |
| tree | 18ee9d2c76625cde9f0df82bf5ee5ed0949ffb9f /Master/texmf-dist/doc/latex/base | |
| parent | 1c828276bd271cb63c97ad3e2ff36d7a8d772530 (diff) | |
latex (9jan21)
git-svn-id: svn://tug.org/texlive/trunk@57354 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/base')
84 files changed, 812 insertions, 18 deletions
diff --git a/Master/texmf-dist/doc/latex/base/README.md b/Master/texmf-dist/doc/latex/base/README.md index 7c6328be6d1..f9394d0f3bd 100644 --- a/Master/texmf-dist/doc/latex/base/README.md +++ b/Master/texmf-dist/doc/latex/base/README.md @@ -1,7 +1,7 @@ The LaTeX kernel ================ -Release 2020-10-01 patch level 3 +Release 2020-10-01 patch level 4 Overview -------- diff --git a/Master/texmf-dist/doc/latex/base/alltt.pdf b/Master/texmf-dist/doc/latex/base/alltt.pdf Binary files differindex 5cb6410fa1a..d31e7c526b6 100644 --- a/Master/texmf-dist/doc/latex/base/alltt.pdf +++ b/Master/texmf-dist/doc/latex/base/alltt.pdf diff --git a/Master/texmf-dist/doc/latex/base/cfgguide.pdf b/Master/texmf-dist/doc/latex/base/cfgguide.pdf Binary files differindex c0cb3f3c6fb..c4a7ad4323b 100644 --- a/Master/texmf-dist/doc/latex/base/cfgguide.pdf +++ b/Master/texmf-dist/doc/latex/base/cfgguide.pdf diff --git a/Master/texmf-dist/doc/latex/base/changes.txt b/Master/texmf-dist/doc/latex/base/changes.txt index cc8d59b61b5..e86d28740db 100644 --- a/Master/texmf-dist/doc/latex/base/changes.txt +++ b/Master/texmf-dist/doc/latex/base/changes.txt @@ -1,4 +1,4 @@ -================================================================================ +================================================================================ This file lists changes to the LaTeX2e files in reverse chronological order of publication (therefore the dates might be out of sequence if there are hotfixes). It is provided for convenience only. It therefore makes no claims to @@ -10,6 +10,33 @@ are not part of the distribution. All changes above are only part of the development branch for the next release. ================================================================================ + +######################### +# 2020-10-01 PL 4 Release +######################### + +2021-01-07 Phelype Oleinik <phelype.oleinik@latex-project.org> + + * ltfilehook.dtx: + Undefine \@expl@@@filehook@file@pop@@ to avoid error when rolling back (gh/463). + + * lthooks.dtx: + Modified internal copies of l3tl commands to avoid errors with l3debug (gh/463). + +2020-12-18 Phelype Oleinik <phelype.oleinik@latex-project.org> + + * lthooks.dtx: + Preserve trailing slash in file hook name if the file name is empty (gh/464). + + * ltfilehook.dtx: + Restore \CurrentFile(Path)(Used) after the file is input (gh/464). + +2020-12-03 Joseph Wright <Joseph.Wright@latex-project.org> + + * usrguide3.tex + New file to cover creation of document commands + + ######################### # 2020-10-01 PL 3 Release ######################### diff --git a/Master/texmf-dist/doc/latex/base/classes.pdf b/Master/texmf-dist/doc/latex/base/classes.pdf Binary files differindex 05b9379ef4f..7158ffe5e82 100644 --- a/Master/texmf-dist/doc/latex/base/classes.pdf +++ b/Master/texmf-dist/doc/latex/base/classes.pdf diff --git a/Master/texmf-dist/doc/latex/base/clsguide.pdf b/Master/texmf-dist/doc/latex/base/clsguide.pdf Binary files differindex c5d32dda9f7..39a99b0d264 100644 --- a/Master/texmf-dist/doc/latex/base/clsguide.pdf +++ b/Master/texmf-dist/doc/latex/base/clsguide.pdf diff --git a/Master/texmf-dist/doc/latex/base/cmfonts.pdf b/Master/texmf-dist/doc/latex/base/cmfonts.pdf Binary files differindex fe8f0083f69..18f18adb325 100644 --- a/Master/texmf-dist/doc/latex/base/cmfonts.pdf +++ b/Master/texmf-dist/doc/latex/base/cmfonts.pdf diff --git a/Master/texmf-dist/doc/latex/base/cyrguide.pdf b/Master/texmf-dist/doc/latex/base/cyrguide.pdf Binary files differindex 6fa40a338b6..2ae5f0aae32 100644 --- a/Master/texmf-dist/doc/latex/base/cyrguide.pdf +++ b/Master/texmf-dist/doc/latex/base/cyrguide.pdf diff --git a/Master/texmf-dist/doc/latex/base/doc.pdf b/Master/texmf-dist/doc/latex/base/doc.pdf Binary files differindex 5feed953988..8815f83c0b9 100644 --- a/Master/texmf-dist/doc/latex/base/doc.pdf +++ b/Master/texmf-dist/doc/latex/base/doc.pdf diff --git a/Master/texmf-dist/doc/latex/base/docstrip.pdf b/Master/texmf-dist/doc/latex/base/docstrip.pdf Binary files differindex 2e31d253a1b..9688ffddef4 100644 --- a/Master/texmf-dist/doc/latex/base/docstrip.pdf +++ b/Master/texmf-dist/doc/latex/base/docstrip.pdf diff --git a/Master/texmf-dist/doc/latex/base/encguide.pdf b/Master/texmf-dist/doc/latex/base/encguide.pdf Binary files differindex 249493684e9..141c91cc810 100644 --- a/Master/texmf-dist/doc/latex/base/encguide.pdf +++ b/Master/texmf-dist/doc/latex/base/encguide.pdf diff --git a/Master/texmf-dist/doc/latex/base/exscale.pdf b/Master/texmf-dist/doc/latex/base/exscale.pdf Binary files differindex 339a4d161a3..0ebbe07a054 100644 --- a/Master/texmf-dist/doc/latex/base/exscale.pdf +++ b/Master/texmf-dist/doc/latex/base/exscale.pdf diff --git a/Master/texmf-dist/doc/latex/base/fix-cm.pdf b/Master/texmf-dist/doc/latex/base/fix-cm.pdf Binary files differindex f39aca25258..d72171f772a 100644 --- a/Master/texmf-dist/doc/latex/base/fix-cm.pdf +++ b/Master/texmf-dist/doc/latex/base/fix-cm.pdf diff --git a/Master/texmf-dist/doc/latex/base/fntguide.pdf b/Master/texmf-dist/doc/latex/base/fntguide.pdf Binary files differindex 97c8a844f75..5faab35979a 100644 --- a/Master/texmf-dist/doc/latex/base/fntguide.pdf +++ b/Master/texmf-dist/doc/latex/base/fntguide.pdf diff --git a/Master/texmf-dist/doc/latex/base/graphpap.pdf b/Master/texmf-dist/doc/latex/base/graphpap.pdf Binary files differindex 8cad84bb4c1..4bc57dc7dbd 100644 --- a/Master/texmf-dist/doc/latex/base/graphpap.pdf +++ b/Master/texmf-dist/doc/latex/base/graphpap.pdf diff --git a/Master/texmf-dist/doc/latex/base/ifthen.pdf b/Master/texmf-dist/doc/latex/base/ifthen.pdf Binary files differindex be2ea9f956f..32e87c1326d 100644 --- a/Master/texmf-dist/doc/latex/base/ifthen.pdf +++ b/Master/texmf-dist/doc/latex/base/ifthen.pdf diff --git a/Master/texmf-dist/doc/latex/base/inputenc.pdf b/Master/texmf-dist/doc/latex/base/inputenc.pdf Binary files differindex 4c06af39d52..857279fa418 100644 --- a/Master/texmf-dist/doc/latex/base/inputenc.pdf +++ b/Master/texmf-dist/doc/latex/base/inputenc.pdf diff --git a/Master/texmf-dist/doc/latex/base/latexchanges.pdf b/Master/texmf-dist/doc/latex/base/latexchanges.pdf Binary files differindex 97fcc3330b7..3b20501afde 100644 --- a/Master/texmf-dist/doc/latex/base/latexchanges.pdf +++ b/Master/texmf-dist/doc/latex/base/latexchanges.pdf diff --git a/Master/texmf-dist/doc/latex/base/latexchanges.tex b/Master/texmf-dist/doc/latex/base/latexchanges.tex index dc8eb4be4eb..a00ca99d4f5 100644 --- a/Master/texmf-dist/doc/latex/base/latexchanges.tex +++ b/Master/texmf-dist/doc/latex/base/latexchanges.tex @@ -38,10 +38,10 @@ \title{Changes to the \LaTeXe{} format} -\author{\copyright~Copyright 2015--2020, \LaTeX3 Project Team.\\ +\author{\copyright~Copyright 2015--2021, \LaTeX3 Project Team.\\ All rights reserved.} -\date{2020-02-02} +\date{2021-01-08} % a few commands from doc \newcommand\Lpack[1]{\mbox{\textsf{#1}}} @@ -75,16 +75,15 @@ \url{https://tex.stackexchange.com/q/#1}} \fi -\begin{document} -\maketitle +\setcounter{tocdepth}{1} % don't show subsections -\tableofcontents -\newpage +\begin{document} -\section{Introduction} +\maketitle +\begin{abstract} This document describes changes that were made to the \LaTeX\ format since the 2014-05-01 \LaTeX\ releases. @@ -99,13 +98,79 @@ As a summary of changes for a main release will always be available in but changes in any patch releases will be listed in more detail here. -More detailed change logs are available as +More detailed change logs are available as \texttt{changes.txt} in the base distribution, and full code differences may be browsed via the code repository on GitHub see for example \url{https://github.com/latex3/latex2e/commits/master}. +\end{abstract} + +\tableofcontents + +\newpage + +%\section{Introduction} + + + +\section{Changes introduced in 2020-10-01 patch~4} + +This patch fixed two bugs in the hook management: if debugging for the +L3 programming layer was turned on it reported inconsistent use of +local/global variables. This was a spurious warning but nevertheless +disconcerting (\ghissue{463}). The other bug was more serious, in some +situations a wrong value of \verb=\CurrentFile= inside of file-related hooks +could lead to errors (\ghissue{464}). + +We also added the documentation file \texttt{userguide3.pdf} which +will become the main home for documenting new features of \LaTeX. At +this point in time it covers the \Lpack{xparse} functionality that has +been added to the kernel. + +\section{Changes introduced in 2020-10-01 patch~3} + +This patch fixed some rollback issues that prevented successful +rollback to other release levels in some cases. It also fixed an issue +with file hooks involving files with explicit paths (\ghissue{422}). + +One important change was to handle hook declarations done in the +document preamble in a special way, e.g., those done with +\verb=\AtBeginDocument=. They are now always executed last and are not +subject to the normal code sorting for hooks, because they are nearly always +needed to overwrite earlier settings made in packages. + +Finally, the NFSS series handling was slightly changed to +automatically drop surplus ``\texttt{m}''s from series specifications +when needed (and warn about them when encountered), e.g., +``\texttt{mc}'' automatically becomes ``\texttt{c}'' which is the +official NFSS name for a \emph{medium compact} series (\ghissue{453}). +This was done to improve the fix in 2020-02-02 PL~5. + +\section{Changes introduced in 2020-10-01 patch~2} + +This patch fixed the passing of options to packages and classes when +they are stored in a special place (denoted by \verb=\input@path=) +instead of their normal location (\ghissue{414}). In that case the +options got lost. + +\section{Changes introduced in 2020-10-01 patch~1} + +This patch fixed a file handling issue: to allow for spaces in file +names quotes were used but this upsets Bib\TeX{} (\ghissue{400}). In +addition, two rollback issues got corrected. + +\section{Changes introduced in 2020-10-01} +Major enhancements in this release include pre-loading of the +\Lpack{xparse} package for producing document-level commands with more +complicated argument signatures and the new hook management system for +\LaTeX{} documented in \texttt{lthooks-doc.pdf}, +\texttt{ltfilehook-doc.pdf} and \texttt{ltshipout-doc.pdf}. +In addition there have been many smaller fixes and enhancements. +Please see \ltnewsissue{32} for an overview of the new features and +the change log in \texttt{changes.txt} for a more detailed list of +individual changes. \section{Changes introduced in 2020-02-02 patch~5} @@ -167,7 +232,7 @@ Major enhancements in this release include pre-loading \Lpack{expl3} to improve startup times, especially with Lua\TeX\ and Xe\TeX, and extra features in the font selection mechanism. Please see \ltnewsissue{31} for an overview of the new features and the change -log in \texttt{changelog.txt} for a more detailed list of individual +log in \texttt{changes.txt} for a more detailed list of individual changes. @@ -248,7 +313,7 @@ counter prefix commands \verb|p@...| so that they would take the counter value as an argument instead of just acting as a prefix to them. These packages also provided the \verb|\labelformat| macro to change the prefix macro and \verb|\Ref| so that using counters defined that way in the -beginning of sentences would have the proper capitalisation. These features +beginning of sentences would have the proper capitalization. These features were added to the \LaTeXe{} kernel. The kernel now says ``Trying to load\ldots'' @@ -283,7 +348,7 @@ provided as alias for the names based on the Adobe font names The use of potrusion in tables of contents is suppressed by default, see \sxquestion{172785}. -The handling of visible space in verbation was adjusted for +The handling of visible space in verbatim was adjusted for \ghissue{69} and \ghissue{70}. Spaces are removed from the argument passed to BiBTeX, \ghissue{88}. @@ -295,7 +360,7 @@ levels of split hyperlinks, avoiding a fatal pdftex error. \ghissue{94}. \section{Changes introduced in 2018-04-01 patch~5} -Improved support for non ASCII filenames on the commandline on +Improved support for non ASCII filenames on the command line on filesystems using legacy encodings. Adjusted the new package rollback code so that some edge cases where rollback @@ -344,11 +409,11 @@ Lua\TeX, now at 1.04. Previously defining an encoding-specific composite with an undeclared accent (or an accent declared later) gave no error, but did nothing useful. -\LaTeX\ will now detect this and give the accent comamnd a default definition +\LaTeX\ will now detect this and give the accent command a default definition as an error, allowing the declared composite to work as intended. The definition of \verb|\-| is adjusted to match the comments in -\gnatsissue{3855} to accomodate non standard settings of \verb|\hyphenchar|. +\gnatsissue{3855} to accommodate non standard settings of \verb|\hyphenchar|. In parboxes and similar settings, \verb|\lineskiplimit| is now reset (to the existing default value, \verb|\normallineskiplimit|). @@ -409,7 +474,7 @@ Load Unicode data from new generic \texttt{unicode-data} distribution. \section{Changes introduced in 2015/10/01 patch~2} -This release fixes the behaviour of the allocation mechanism if the switch +This release fixes the behavior of the allocation mechanism if the switch from the standard to extended pool takes place within a group. \section{Changes introduced in 2015/10/01 patch~1} @@ -444,7 +509,7 @@ The command |\textcommabelow| has been added. This is mainly intended for Romani \textcommabelow{S}\,\textcommabelow{s}\,\textcommabelow{T}\,\textcommabelow{t}. \subsection{Unicode 8} -The file |unicode-letters.def| used to initialise character data in +The file |unicode-letters.def| used to initialize character data in Unicode \TeX\ variants has been regenerated from data files updated to Unicode~8. diff --git a/Master/texmf-dist/doc/latex/base/latexrelease.pdf b/Master/texmf-dist/doc/latex/base/latexrelease.pdf Binary files differindex d6190767823..313eb94505e 100644 --- a/Master/texmf-dist/doc/latex/base/latexrelease.pdf +++ b/Master/texmf-dist/doc/latex/base/latexrelease.pdf diff --git a/Master/texmf-dist/doc/latex/base/latexsym.pdf b/Master/texmf-dist/doc/latex/base/latexsym.pdf Binary files differindex 436ea23f3ab..1ad33cec9da 100644 --- a/Master/texmf-dist/doc/latex/base/latexsym.pdf +++ b/Master/texmf-dist/doc/latex/base/latexsym.pdf diff --git a/Master/texmf-dist/doc/latex/base/lb2.pdf b/Master/texmf-dist/doc/latex/base/lb2.pdf Binary files differindex 7d989cb0a0e..89e748bed0a 100644 --- a/Master/texmf-dist/doc/latex/base/lb2.pdf +++ b/Master/texmf-dist/doc/latex/base/lb2.pdf diff --git a/Master/texmf-dist/doc/latex/base/letter.pdf b/Master/texmf-dist/doc/latex/base/letter.pdf Binary files differindex 104f1157e23..f229f68d3bc 100644 --- a/Master/texmf-dist/doc/latex/base/letter.pdf +++ b/Master/texmf-dist/doc/latex/base/letter.pdf diff --git a/Master/texmf-dist/doc/latex/base/lgc2.pdf b/Master/texmf-dist/doc/latex/base/lgc2.pdf Binary files differindex f900bfefb39..d6032fe6a03 100644 --- a/Master/texmf-dist/doc/latex/base/lgc2.pdf +++ b/Master/texmf-dist/doc/latex/base/lgc2.pdf diff --git a/Master/texmf-dist/doc/latex/base/lppl.pdf b/Master/texmf-dist/doc/latex/base/lppl.pdf Binary files differindex 20a630928c5..58364d502bc 100644 --- a/Master/texmf-dist/doc/latex/base/lppl.pdf +++ b/Master/texmf-dist/doc/latex/base/lppl.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltfilehook-code.pdf b/Master/texmf-dist/doc/latex/base/ltfilehook-code.pdf Binary files differindex fcbf09fe980..b31a72bc78d 100644 --- a/Master/texmf-dist/doc/latex/base/ltfilehook-code.pdf +++ b/Master/texmf-dist/doc/latex/base/ltfilehook-code.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltfilehook-doc.pdf b/Master/texmf-dist/doc/latex/base/ltfilehook-doc.pdf Binary files differindex bf7f37f22b1..5fd86946d12 100644 --- a/Master/texmf-dist/doc/latex/base/ltfilehook-doc.pdf +++ b/Master/texmf-dist/doc/latex/base/ltfilehook-doc.pdf diff --git a/Master/texmf-dist/doc/latex/base/lthooks-code.pdf b/Master/texmf-dist/doc/latex/base/lthooks-code.pdf Binary files differindex 5bb5d7899fb..b209ada5430 100644 --- a/Master/texmf-dist/doc/latex/base/lthooks-code.pdf +++ b/Master/texmf-dist/doc/latex/base/lthooks-code.pdf diff --git a/Master/texmf-dist/doc/latex/base/lthooks-doc.pdf b/Master/texmf-dist/doc/latex/base/lthooks-doc.pdf Binary files differindex 1ca6ef3a6d4..b72a3e2b2f5 100644 --- a/Master/texmf-dist/doc/latex/base/lthooks-doc.pdf +++ b/Master/texmf-dist/doc/latex/base/lthooks-doc.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltluatex.pdf b/Master/texmf-dist/doc/latex/base/ltluatex.pdf Binary files differindex 7e559ecf456..2cc8ddad3f8 100644 --- a/Master/texmf-dist/doc/latex/base/ltluatex.pdf +++ b/Master/texmf-dist/doc/latex/base/ltluatex.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews.pdf b/Master/texmf-dist/doc/latex/base/ltnews.pdf Binary files differindex 7da22f913b4..19f3de087e4 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews01.pdf b/Master/texmf-dist/doc/latex/base/ltnews01.pdf Binary files differindex 54c09ea91b3..a595669dd51 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews01.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews01.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews02.pdf b/Master/texmf-dist/doc/latex/base/ltnews02.pdf Binary files differindex cfbebec5824..ce3cca52716 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews02.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews02.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews03.pdf b/Master/texmf-dist/doc/latex/base/ltnews03.pdf Binary files differindex 83b8cba6a6c..9f4b7fb62bb 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews03.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews03.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews04.pdf b/Master/texmf-dist/doc/latex/base/ltnews04.pdf Binary files differindex 82f78370d24..04914018864 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews04.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews04.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews05.pdf b/Master/texmf-dist/doc/latex/base/ltnews05.pdf Binary files differindex a3a3ba26083..4006b290166 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews05.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews05.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews06.pdf b/Master/texmf-dist/doc/latex/base/ltnews06.pdf Binary files differindex f08f1898409..86bb0d89c10 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews06.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews06.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews07.pdf b/Master/texmf-dist/doc/latex/base/ltnews07.pdf Binary files differindex c44afe8b772..a6c31f87019 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews07.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews07.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews08.pdf b/Master/texmf-dist/doc/latex/base/ltnews08.pdf Binary files differindex 575c90644eb..0645d3dc337 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews08.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews08.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews09.pdf b/Master/texmf-dist/doc/latex/base/ltnews09.pdf Binary files differindex 938671e92ba..1d17dca6e72 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews09.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews09.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews10.pdf b/Master/texmf-dist/doc/latex/base/ltnews10.pdf Binary files differindex 1b065aff918..cccbbd2ff31 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews10.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews10.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews11.pdf b/Master/texmf-dist/doc/latex/base/ltnews11.pdf Binary files differindex b5dbd3f7223..3073a3a2d38 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews11.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews11.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews12.pdf b/Master/texmf-dist/doc/latex/base/ltnews12.pdf Binary files differindex 103e8b18e3f..f33b9fa2b21 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews12.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews12.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews13.pdf b/Master/texmf-dist/doc/latex/base/ltnews13.pdf Binary files differindex 00416913297..0b8da8f1a3d 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews13.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews13.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews14.pdf b/Master/texmf-dist/doc/latex/base/ltnews14.pdf Binary files differindex 2bc925c555b..0efc5c9b027 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews14.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews14.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews15.pdf b/Master/texmf-dist/doc/latex/base/ltnews15.pdf Binary files differindex 820600a8df0..fce7d7f09ff 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews15.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews15.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews16.pdf b/Master/texmf-dist/doc/latex/base/ltnews16.pdf Binary files differindex 3c4336dd45c..9010892932b 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews16.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews16.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews17.pdf b/Master/texmf-dist/doc/latex/base/ltnews17.pdf Binary files differindex cecb7a07dc9..463a597b992 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews17.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews17.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews18.pdf b/Master/texmf-dist/doc/latex/base/ltnews18.pdf Binary files differindex 494f0fa0ec7..59ed450aeff 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews18.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews18.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews19.pdf b/Master/texmf-dist/doc/latex/base/ltnews19.pdf Binary files differindex 2c4a3b518a6..40360ea17cf 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews19.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews19.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews20.pdf b/Master/texmf-dist/doc/latex/base/ltnews20.pdf Binary files differindex b1e5c67560c..d9b48b8a9e2 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews20.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews20.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews21.pdf b/Master/texmf-dist/doc/latex/base/ltnews21.pdf Binary files differindex eb0264792cb..8212b9a06be 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews21.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews21.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews22.pdf b/Master/texmf-dist/doc/latex/base/ltnews22.pdf Binary files differindex ddfb6d3d3ac..4192e08538f 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews22.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews22.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews23.pdf b/Master/texmf-dist/doc/latex/base/ltnews23.pdf Binary files differindex a32e1efbb42..399e25e457c 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews23.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews23.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews24.pdf b/Master/texmf-dist/doc/latex/base/ltnews24.pdf Binary files differindex 6dc47bb3de1..18b2406db7e 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews24.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews24.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews25.pdf b/Master/texmf-dist/doc/latex/base/ltnews25.pdf Binary files differindex 82908a28f20..1b9c0bec61b 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews25.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews25.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews26.pdf b/Master/texmf-dist/doc/latex/base/ltnews26.pdf Binary files differindex 604db557097..4be6545a436 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews26.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews26.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews27.pdf b/Master/texmf-dist/doc/latex/base/ltnews27.pdf Binary files differindex 472ea7679f4..eaa272fd124 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews27.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews27.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews28.pdf b/Master/texmf-dist/doc/latex/base/ltnews28.pdf Binary files differindex 14ef2d02dda..f326e75b155 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews28.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews28.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews29.pdf b/Master/texmf-dist/doc/latex/base/ltnews29.pdf Binary files differindex e8197be1b30..bfae9f4a80b 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews29.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews29.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews30.pdf b/Master/texmf-dist/doc/latex/base/ltnews30.pdf Binary files differindex 920d022e991..433d8686393 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews30.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews30.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews31.pdf b/Master/texmf-dist/doc/latex/base/ltnews31.pdf Binary files differindex 6a62e971235..7ef233d67f9 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews31.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews31.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltnews32.pdf b/Master/texmf-dist/doc/latex/base/ltnews32.pdf Binary files differindex 93536d352ae..22b3c72894b 100644 --- a/Master/texmf-dist/doc/latex/base/ltnews32.pdf +++ b/Master/texmf-dist/doc/latex/base/ltnews32.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltshipout-code.pdf b/Master/texmf-dist/doc/latex/base/ltshipout-code.pdf Binary files differindex f95e0ebf754..fe2cee9f3df 100644 --- a/Master/texmf-dist/doc/latex/base/ltshipout-code.pdf +++ b/Master/texmf-dist/doc/latex/base/ltshipout-code.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltshipout-doc.pdf b/Master/texmf-dist/doc/latex/base/ltshipout-doc.pdf Binary files differindex 074774312a9..d762ede0a76 100644 --- a/Master/texmf-dist/doc/latex/base/ltshipout-doc.pdf +++ b/Master/texmf-dist/doc/latex/base/ltshipout-doc.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltx3info.pdf b/Master/texmf-dist/doc/latex/base/ltx3info.pdf Binary files differindex 070c822a17e..383b3ab3d41 100644 --- a/Master/texmf-dist/doc/latex/base/ltx3info.pdf +++ b/Master/texmf-dist/doc/latex/base/ltx3info.pdf diff --git a/Master/texmf-dist/doc/latex/base/ltxdoc.pdf b/Master/texmf-dist/doc/latex/base/ltxdoc.pdf Binary files differindex e5d6fb99cff..9af62b008f1 100644 --- a/Master/texmf-dist/doc/latex/base/ltxdoc.pdf +++ b/Master/texmf-dist/doc/latex/base/ltxdoc.pdf diff --git a/Master/texmf-dist/doc/latex/base/makeindx.pdf b/Master/texmf-dist/doc/latex/base/makeindx.pdf Binary files differindex 7993372c012..c439845e4bd 100644 --- a/Master/texmf-dist/doc/latex/base/makeindx.pdf +++ b/Master/texmf-dist/doc/latex/base/makeindx.pdf diff --git a/Master/texmf-dist/doc/latex/base/manifest.txt b/Master/texmf-dist/doc/latex/base/manifest.txt index f3c8f2b2165..0cf27343c13 100644 --- a/Master/texmf-dist/doc/latex/base/manifest.txt +++ b/Master/texmf-dist/doc/latex/base/manifest.txt @@ -38,6 +38,7 @@ % fntguide.tex -- Guide to font selection. % modguide.tex -- Guide to modifying and distributing LaTeX. % usrguide.tex -- User guide for this release. +% usrguide3.tex -- User guide for expl3-based methods. % % ltnews01.tex -- What was new in the release dated 1994/06. % ltnews02.tex -- What was new in the release dated 1994/12. diff --git a/Master/texmf-dist/doc/latex/base/manual.pdf b/Master/texmf-dist/doc/latex/base/manual.pdf Binary files differindex 50811f5d4c7..5c746a312a1 100644 --- a/Master/texmf-dist/doc/latex/base/manual.pdf +++ b/Master/texmf-dist/doc/latex/base/manual.pdf diff --git a/Master/texmf-dist/doc/latex/base/modguide.pdf b/Master/texmf-dist/doc/latex/base/modguide.pdf Binary files differindex 5f51237557c..59433901a41 100644 --- a/Master/texmf-dist/doc/latex/base/modguide.pdf +++ b/Master/texmf-dist/doc/latex/base/modguide.pdf diff --git a/Master/texmf-dist/doc/latex/base/nfssfont.pdf b/Master/texmf-dist/doc/latex/base/nfssfont.pdf Binary files differindex 8f189189d9c..17492f3e6f5 100644 --- a/Master/texmf-dist/doc/latex/base/nfssfont.pdf +++ b/Master/texmf-dist/doc/latex/base/nfssfont.pdf diff --git a/Master/texmf-dist/doc/latex/base/proc.pdf b/Master/texmf-dist/doc/latex/base/proc.pdf Binary files differindex 35ba9262e07..3b22d4c2078 100644 --- a/Master/texmf-dist/doc/latex/base/proc.pdf +++ b/Master/texmf-dist/doc/latex/base/proc.pdf diff --git a/Master/texmf-dist/doc/latex/base/slides.pdf b/Master/texmf-dist/doc/latex/base/slides.pdf Binary files differindex b4d275289cc..d2a5303726f 100644 --- a/Master/texmf-dist/doc/latex/base/slides.pdf +++ b/Master/texmf-dist/doc/latex/base/slides.pdf diff --git a/Master/texmf-dist/doc/latex/base/slifonts.pdf b/Master/texmf-dist/doc/latex/base/slifonts.pdf Binary files differindex 39952e8a883..f1120069c52 100644 --- a/Master/texmf-dist/doc/latex/base/slifonts.pdf +++ b/Master/texmf-dist/doc/latex/base/slifonts.pdf diff --git a/Master/texmf-dist/doc/latex/base/source2e.pdf b/Master/texmf-dist/doc/latex/base/source2e.pdf Binary files differindex 106d83f7234..2905a8efef8 100644 --- a/Master/texmf-dist/doc/latex/base/source2e.pdf +++ b/Master/texmf-dist/doc/latex/base/source2e.pdf diff --git a/Master/texmf-dist/doc/latex/base/syntonly.pdf b/Master/texmf-dist/doc/latex/base/syntonly.pdf Binary files differindex 1493490c91e..48bab0767eb 100644 --- a/Master/texmf-dist/doc/latex/base/syntonly.pdf +++ b/Master/texmf-dist/doc/latex/base/syntonly.pdf diff --git a/Master/texmf-dist/doc/latex/base/tlc2.pdf b/Master/texmf-dist/doc/latex/base/tlc2.pdf Binary files differindex 0c08e372a31..4e56aaa3fcc 100644 --- a/Master/texmf-dist/doc/latex/base/tlc2.pdf +++ b/Master/texmf-dist/doc/latex/base/tlc2.pdf diff --git a/Master/texmf-dist/doc/latex/base/tulm.pdf b/Master/texmf-dist/doc/latex/base/tulm.pdf Binary files differindex d480c33dff4..b871d94918a 100644 --- a/Master/texmf-dist/doc/latex/base/tulm.pdf +++ b/Master/texmf-dist/doc/latex/base/tulm.pdf diff --git a/Master/texmf-dist/doc/latex/base/usrguide.pdf b/Master/texmf-dist/doc/latex/base/usrguide.pdf Binary files differindex 51412a147a3..02e37ae6755 100644 --- a/Master/texmf-dist/doc/latex/base/usrguide.pdf +++ b/Master/texmf-dist/doc/latex/base/usrguide.pdf diff --git a/Master/texmf-dist/doc/latex/base/usrguide3.pdf b/Master/texmf-dist/doc/latex/base/usrguide3.pdf Binary files differnew file mode 100644 index 00000000000..b7063c2603e --- /dev/null +++ b/Master/texmf-dist/doc/latex/base/usrguide3.pdf diff --git a/Master/texmf-dist/doc/latex/base/usrguide3.tex b/Master/texmf-dist/doc/latex/base/usrguide3.tex new file mode 100644 index 00000000000..4c3bde94f6b --- /dev/null +++ b/Master/texmf-dist/doc/latex/base/usrguide3.tex @@ -0,0 +1,701 @@ +% \iffalse meta-comment +% +% Copyright (C) 2020 +% The LaTeX3 Project and any individual authors listed elsewhere +% in this file. +% +% This file is part of the LaTeX base system. +% ------------------------------------------- +% +% It may be distributed and/or modified under the +% conditions of the LaTeX Project Public License, either version 1.3c +% of this license or (at your option) any later version. +% The latest version of this license is in +% http://www.latex-project.org/lppl.txt +% and version 1.3c or later is part of all distributions of LaTeX +% version 2008 or later. +% +% This file has the LPPL maintenance status "maintained". +% +% The list of all files belonging to the LaTeX base distribution is +% given in the file `manifest.txt'. See also `legal.txt' for additional +% information. +% +% The list of derived (unpacked) files belonging to the distribution +% and covered by LPPL is defined by the unpacking scripts (with +% extension .ins) which are part of the distribution. +% +% \fi +% Filename: usrguide3.tex + +\documentclass{ltxguide} + +\usepackage[T1]{fontenc} % needed for \textbackslash in tt + +\title{\LaTeX3 methods for authors} +\author{\copyright~Copyright 2020, \LaTeX\ Project Team.\\ + All rights reserved.} + +\date{Released 2020-12-02} + +\NewDocumentCommand\cs{m}{\texttt{\textbackslash\detokenize{#1}}} +\NewDocumentCommand\marg{m}{\arg{#1}} +\NewDocumentCommand\meta{m}{\ensuremath{\langle}\textit{#1}\ensuremath{\rangle}} +\NewDocumentCommand\pkg{m}{\textsf{#1}} +\NewDocumentCommand\text{m}{\ifmmode\mbox{#1}\else#1\fi} +% Fix a 'feature' +\makeatletter +\renewcommand \verbatim@font {\normalfont \ttfamily} +\makeatother + +\begin{document} + +\maketitle + +\tableofcontents + +\section{Introduction} + +\LaTeXe{} was released in 1994 and added a number of then-new concepts to +\LaTeX{}. These are described in \texttt{usrguide}, which has largely remained +unchanged. Since then, the \LaTeX{} team have worked on a number of ideas, +firstly a programming language for \LaTeX{} (\pkg{expl3}) and then a range of +tools for document authors which build on that language. Here, we describe +\emph{stable} and \emph{widely-usable} concepts that have resulted from that +work. These `new' ideas have been transferred from development packages +into the \LaTeXe{} kernel. As such, they are now available to \emph{all} +\LaTeX{} users and have the \emph{same stability} as any other part of the +kernel. The fact that `behind the scenes' they are built on \pkg{expl3} +is useful for the development team, but is not directly important to users. + +\section{Creating document commands and environments} + +\subsection{Overview} + +Creating document commands and environments using the \LaTeX3 toolset is based +around the idea that a common set of descriptions can be used to cover almost +all argument types used in real documents. Thus parsing is reduced to a simple +description of which arguments a command takes: this description provides the +`glue' between the document syntax and the implementation of the +command. + +First, we will describe the argument types, then move on to explain how these +can be used to create both document commands and environments. Various more +specialized features are then described, which allow an even richer application +of a simple interface set up. + +The details here are intended to help users create document commands in +general. More technical detail, suitable for \TeX{} programmers, is included +in \texttt{interface3}. + +\subsection{Describing argument types} + +In order to allow each argument to be defined independently, the parser does +not simply need to know the number of arguments for a function, but also the +nature of each one. This is done by constructing an \emph{argument +specification}, which defines the number of arguments, the type of each +argument and any additional information needed for the parser to read the user +input and properly pass it through to internal functions. + +The basic form of the argument specifier is a list of letters, where each +letter defines a type of argument. As will be described below, some of the +types need additional information, such as default values. The argument types +can be divided into two, those which define arguments that are mandatory +(potentially raising an error if not found) and those which define optional +arguments. The mandatory types +\begin{itemize} + \item[\texttt{m}] A standard mandatory argument, which can either be a single token + alone or multiple tokens surrounded by curly braces |{}|. Regardless of the + input, the argument will be passed to the internal code without the outer + braces. This is the type specifier for a normal \TeX{} argument. + \item[\texttt{r}] Given as \texttt{r}\meta{token1}\meta{token2}, this denotes a + `required' delimited argument, where the delimiters are + \meta{token1} and \meta{token2}. If the opening delimiter \meta{token1} is + missing, the default marker |-NoValue-| will be inserted after a suitable + error. + \item[\texttt{R}] Given as \texttt{R}\meta{token1}\meta{token2}\marg{default}, + this is a `required' delimited argument as for~\texttt{r}, + but it has a user-definable recovery \meta{default} instead of + |-NoValue-|. + \item[\texttt{v}] Reads an argument `verbatim', between the following + character and its next occurrence, in a way similar to the argument + of the \LaTeXe{} command \cs{verb}. Thus a \texttt{v}-type argument + is read between two identical characters, which cannot be any of |%|, |\|, + |#|, |{|, |}| or \verb*| |. The verbatim argument can also be enclosed + between braces, |{| and |}|. A command with a verbatim argument will + produce an error when it appears within an argument of another function. + \item[\texttt{b}] Only suitable in the argument specification of an + environment, it denotes the body of the environment, between + |\begin|\marg{environment} and |\end|\marg{environment}. See + Section~\ref{sec:cmd:body} for details. +\end{itemize} +The types which define optional arguments are: +\begin{itemize} + \item[\texttt{o}] A standard \LaTeX{} optional argument, surrounded with square + brackets, which will supply the special |-NoValue-| marker if not given + (as described later). + \item[\texttt{d}] Given as \texttt{d}\meta{token1}\meta{token2}, an optional + argument which is delimited by \meta{token1} and \meta{token2}. As with + \texttt{o}, if no value is given the special marker |-NoValue-| is + returned. + \item[\texttt{O}] Given as \texttt{O}\marg{default}, is like \texttt{o}, but returns + \meta{default} if no value is given. + \item[\texttt{D}] Given as \texttt{D}\meta{token1}\meta{token2}\marg{default}, it is + as for \texttt{d}, but returns \meta{default} if no value is given. + Internally, the \texttt{o}, \texttt{d} and \texttt{O} types are + short-cuts to an appropriated-constructed \texttt{D} type argument. + \item[\texttt{s}] An optional star, which will result in a value + \cs{BooleanTrue} if a star is present and \cs{BooleanFalse} + otherwise (as described later). + \item[\texttt{t}] An optional \meta{token}, which will result in a value + \cs{BooleanTrue} if \meta{token} is present and \cs{BooleanFalse} + otherwise. Given as \texttt{t}\meta{token}. + \item[\texttt{e}] Given as \texttt{e}\marg{tokens}, a set of optional + \emph{embellishments}, each of which requires a \emph{value}. + If an embellishment is not present, |-NoValue-| is returned. Each + embellishment gives one argument, ordered as for the list of + \meta{tokens} in the argument specification. All \meta{tokens} + must be distinct. + \item[\texttt{E}] As for \texttt{e} but returns one or more \meta{defaults} + if values are not given: \texttt{E}\marg{tokens}\marg{defaults}. See + Section~\ref{sec:cmd:embellishment} for more details. +\end{itemize} + +\subsection{Modifying argument descriptions} + +In addition to the argument \emph{types} discussed above, the argument +description also gives special meaning to three other characters. + +First, \texttt{+} is used to make an argument long (to accept paragraph +tokens). In contrast to \cs{newcommand}, this applies on an +argument-by-argument basis. So modifying the example to `|s o o +m O{default}|' +means that the mandatory argument is now \cs{long}, whereas the optional +arguments are not. + +Secondly, \texttt{!} is used to control whether spaces are allowed before +optional arguments. There are some subtleties to this, as \TeX{} itself +has some restrictions on where spaces can be `detected': more detail +is given in Section~\ref{sec:cmd:opt-space}. + +Finally, the character \texttt{>} is used to declare so-called +`argument processors', which can be used to modify the contents of an +argument before it is passed to the macro definition. The use of argument +processors is a somewhat advanced topic, (or at least a less commonly used +feature) and is covered in Section~\ref{sec:cmd:processors}. + +\subsection{Creating document commands and environments} + +\begin{decl} + |\NewDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} \\ + |\RenewDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} \\ + |\ProvideDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} \\ + |\DeclareDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} +\end{decl} +This family of commands are used to create a \meta{cmd}. The argument +specification for the function is given by \meta{arg spec}, and the command +uses the \meta{code} with |#1|, |#2|, etc.\ replaced by the arguments found +by the parser. + +An example: +\begin{verbatim} + \NewDocumentCommand\chapter{s o m} + {% + \IfBooleanTF{#1}% + {\typesetstarchapter{#3}}% + {\typesetnormalchapter{#2}{#3}}% + } +\end{verbatim} +would be a way to define a \cs{chapter} command which would essentially behave +like the current \LaTeXe{} command (except that it would accept an optional +argument even when a \texttt{*} was parsed). The \cs{typesetnormalchapter} +could test its first argument for being |-NoValue-| to see if an optional +argument was present. (See Section~\ref{sec:cmd:special} for details of +\cs{IfBooleanTF} and testing for |-NoValue-|.) + +The difference between the \cs{New...} \cs{Renew...}, \cs{Provide...} +and \cs{Declare...} versions is the behavior if \meta{cmd} is already +defined. +\begin{itemize} + \item \cs{NewDocumentCommand} will issue an error if \meta{cmd} + has already been defined. + \item \cs{RenewDocumentCommand} will issue an error if \meta{cmd} + has not previously been defined. + \item \cs{ProvideDocumentCommand} creates a new definition for + \meta{function} only if one has not already been given. + \item \cs{DeclareDocumentCommand} will always create the new + definition, irrespective of any existing \meta{cmd} with the + same name. This should be used sparingly. +\end{itemize} + +\begin{decl} + |\NewDocumentEnvironment| \arg{env} \arg{arg spec} \arg{beg-code} \arg{end-code} \\ + |\RenewDocumentEnvironment| \arg{env} \arg{arg spec} \arg{beg-code} \arg{end-code} \\ + |\ProvideDocumentEnvironment| \arg{env} \arg{arg spec} \arg{beg-code} \arg{end-code} \\ + |\DeclareDocumentEnvironment| \arg{env} \arg{arg spec} \arg{beg-code} \arg{end-code} +\end{decl} +These commands work in the same way as \cs{NewDocumentCommand}, etc.\@, but +create environments (\cs{begin}\arg{env} \ldots{} +\cs{end}\arg{environment}). Both the \meta{beg-code} and \meta{end-code} +may access the arguments as defined by \meta{arg spec}. The arguments will be +given following \cs{begin}\arg{environment}. + +\subsection{Optional arguments} +\label{sec:cmd:opt} + +In contrast to commands created using \LaTeXe{}'s \cs{newcommand}, optional +arguments created using \cs{NewDocumentCommand} may safely be nested. Thus for +example, following +\begin{verbatim} +\NewDocumentCommand\foo{om}{I grabbed `#1' and `#2'} +\NewDocumentCommand\baz{o}{#1-#1} +\end{verbatim} +using the command as +\begin{verbatim} +\foo[\baz[stuff]]{more stuff} +\end{verbatim} +will print +\begin{quote} +I grabbed `stuff-stuff' and `more stuff' +\end{quote} +This is particularly useful when placing a command with an optional argument +\emph{inside} the optional argument of a second command. + +When an optional argument is followed by a mandatory argument with the same +delimiter, the parser issues a warning because the optional argument could not +be omitted by the user, thus becoming in effect mandatory. This can apply to +\texttt{o}, \texttt{d}, \texttt{O}, \texttt{D}, \texttt{s}, \texttt{t}, +\texttt{e}, and \texttt{E} type arguments followed by \texttt{r} or +\texttt{R}-type required arguments. + +The default for \texttt{O}, \texttt{D} and \texttt{E} arguments can be +the result of grabbing another argument. Thus for example +\begin{verbatim} + \NewDocumentCommand\foo{O{#2} m} +\end{verbatim} +would use the mandatory argument as the default for the leading optional +one. + +\subsection{Spacing and optional arguments} +\label{sec:cmd:opt-space} + +\TeX{} will find the first argument after a function name irrespective of any +intervening spaces. This is true for both mandatory and optional arguments. So +|\foo[arg]| and \verb*|\foo [arg]| are equivalent. Spaces are also ignored when +collecting arguments up to the last mandatory argument to be collected (as it +must exist). So after +\begin{verbatim} + \NewDocumentCommand\foo{m o m}{ ... } +\end{verbatim} +the user input |\foo{arg1}[arg2]{arg3}| and \verb*|\foo{arg1} [arg2] {arg3}| +will both be parsed in the same way. + +The behavior of optional arguments \emph{after} any mandatory arguments is +selectable. The standard settings will allow spaces here, and thus with +\begin{verbatim} + \NewDocumentCommand\foobar{m o}{ ... } +\end{verbatim} +both |\foobar{arg1}[arg2]| and \verb*|\foobar{arg1} [arg2]| will find an +optional argument. This can be changed by giving the modified |!| in the +argument specification: +\begin{verbatim} + \NewDocumentCommand\foobar{m !o}{ ... } +\end{verbatim} +where \verb*|\foobar{arg1} [arg2]| will not find an optional argument. + +There is one subtly here due to the difference in handling by \TeX{} of +`control symbols', where the command name is made up of a single +character, such as `\texttt{\textbackslash\textbackslash}'. +Spaces are not ignored by \TeX{} here, +and thus it is possible to require an optional argument directly follow such a +command. The most common example is the use of \texttt{\textbackslash\textbackslash} +in \pkg{amsmath} environments, which in the terms here would be defined as +\begin{verbatim} + \NewDocumentCommand\\{!s !o}{ ... } +\end{verbatim} + +\subsection{`Embellishments'} +\label{sec:cmd:embellishment} + +The \texttt{E}-type argument allows one default value per test token. This is +achieved by giving a list of defaults for each entry in the list, for example: +\begin{verbatim} + E{^_}{{UP}{DOWN}} +\end{verbatim} +If the list of default values is \emph{shorter} than the list of test tokens, +the special |-NoValue-| marker will be returned (as for the \texttt{e}-type +argument). Thus for example +\begin{verbatim} + E{^_}{{UP}} +\end{verbatim} +has default \texttt{UP} for the |^| test character, but will return the +|-NoValue-| marker as a default for |_|. This allows mixing of explicit +defaults with testing for missing values. + + +\subsection{Testing special values} +\label{sec:cmd:special} + +Optional arguments make use of dedicated variables to return information about +the nature of the argument received. + +\begin{decl} + |\IfNoValueTF| \arg{arg} \arg{true code} \arg{false code} \\ + |\IfNoValueT| \arg{arg} \arg{true code} \arg{false code} \\ + |\IfNoValueF| \arg{arg} \arg{true code} \arg{false code} +\end{decl} +The \cs{IfNoValue(TF)} tests are used to check if \meta{argument} (|#1|, +|#2|, \emph{etc.}) is the special |-NoValue-| marker For example +\begin{verbatim} + \NewDocumentCommand\foo{o m} + {% + \IfNoValueTF {#1}% + {\DoSomethingJustWithMandatoryArgument{#2}}% + {\DoSomethingWithBothArguments{#1}{#2}}% + } +\end{verbatim} +will use a different internal function if the optional argument +is given than if it is not present. + +Note that three tests are available, depending on which outcome +branches are required: \cs{IfNoValueTF}, \cs{IfNoValueT} and +\cs{IfNoValueF}. + +As the \cs{IfNoValue(TF)} tests are expandable, it is possible to +test these values later, for example at the point of typesetting or +in an expansion context. + +It is important to note that |-NoValue-| is constructed such that it +will \emph{not} match the simple text input |-NoValue-|, i.e.~that +\begin{verbatim} + \IfNoValueTF{-NoValue-} +\end{verbatim} +will be logically \texttt{false}. +When two optional arguments follow each other (a syntax we typically +discourage), it can make sense to allow users of the command to +specify only the second argument by providing an empty first +argument. Rather than testing separately for emptiness and for +|-NoValue-| it is then best to use the argument type~|O| with an +empty default value, and simply test for emptiness using the +\pkg{expl3} conditional \cs{tl_if_blank:nTF} or its \pkg{etoolbox} +analogue \cs{ifblank}. + +\begin{decl} + |\IfValueTF| \arg{arg} \arg{true code} \arg{false code} \\ + |\IfValueT| \arg{arg} \arg{true code} \arg{false code} \\ + |\IfValueF| \arg{arg} \arg{true code} \arg{false code} +\end{decl} +The reverse form of the \cs{IfNoValue(TF)} tests are also available +as \cs{IfValue(TF)}. The context will determine which logical +form makes the most sense for a given code scenario. + +\begin{decl} + |\BooleanFalse| \\ + |\BooleanTrue| +\end{decl} +The \texttt{true} and \texttt{false} flags set when searching for +an optional character (using \texttt{s} or \texttt{t\meta{char}}) have +names which are accessible outside of code blocks. + +\begin{decl} + |\IfBooleanTF| \arg{arg} \arg{true code} \arg{false code} \\ + |\IfBooleanT| \arg{arg} \arg{true code} \arg{false code} \\ + |\IfBooleanF| \arg{arg} \arg{true code} \arg{false code} +\end{decl} +Used to test if \meta{argument} (|#1|, |#2|, \emph{etc.}) is +\cs{BooleanTrue} or \cs{BooleanFalse}. For example +\begin{verbatim} + \NewDocumentCommand\foo{sm} + {% + \IfBooleanTF {#1}% + {\DoSomethingWithStar{#2}}% + {\DoSomethingWithoutStar{#2}}% + } +\end{verbatim} +checks for a star as the first argument, then chooses the action to +take based on this information. + +\subsection{Argument processors} +\label{sec:cmd:processors} + +Argument processor are applied to an argument \emph{after} it has been grabbed +by the underlying system but before it is passed to \meta{code}. An argument +processor can therefore be used to regularize input at an early stage, allowing +the internal functions to be completely independent of input form. Processors +are applied to user input and to default values for optional arguments, but +\emph{not} to the special |-NoValue-| marker. + +Each argument processor is specified by the syntax \texttt{>}\marg{processor} +in the argument specification. Processors are applied from right to left, so +that +\begin{verbatim} + >{\ProcessorB} >{\ProcessorA} m +\end{verbatim} +would apply \cs{ProcessorA} followed by \cs{ProcessorB} to the tokens grabbed +by the \texttt{m} argument. + +\begin{decl} + |\SplitArgument| \arg{number} \arg{token(s)} +\end{decl} +This processor splits the argument given at each occurrence of the +\meta{tokens} up to a maximum of \meta{number} tokens (thus +dividing the input into $\text{\meta{number}} + 1$ parts). +An error is given if too many \meta{tokens} are present in the +input. The processed input is placed inside +$\text{\meta{number}} + 1$ sets of braces for further use. +If there are fewer than \arg{number} of \arg{tokens} in the argument +then |-NoValue-| markers are added at the end of the processed +argument. +\begin{verbatim} + \NewDocumentCommand \foo {>{\SplitArgument{2}{;}} m} + {\InternalFunctionOfThreeArguments#1} +\end{verbatim} +If only a single character \meta{token} is used for the split, any +category code $13$ (active) character matching the \meta{token} will +be replaced before the split takes place. +Spaces are trimmed at each end of each item parsed. + +\begin{decl} + |\SplitList| \arg{token(s)} +\end{decl} +This processor splits the argument given at each occurrence of the +\meta{token(s)} where the number of items is not fixed. Each item is +then wrapped in braces within |#1|. The result is that the +processed argument can be further processed using a mapping function +(see below). +\begin{verbatim} + \NewDocumentCommand \foo {>{\SplitList{;}} m} + {\MappingFunction#1} +\end{verbatim} +If only a single character \meta{token} is used for the split, any +category code $13$ (active) character matching the \meta{token} will +be replaced before the split takes place. +Spaces are trimmed at each end of each item parsed. + +\begin{decl} + |\ProcessList| \arg{list} \arg{function} +\end{decl} +To support \cs{SplitList}, the function \cs{ProcessList} is available +to apply a \meta{function} to every entry in a \meta{list}. The +\meta{function} should absorb one argument: the list entry. For example +\begin{verbatim} + \NewDocumentCommand \foo {>{\SplitList{;}} m} + {\ProcessList{#1}{\SomeDocumentCommand}} +\end{verbatim} + +\begin{decl} + |\ReverseBoolean| +\end{decl} +This processor reverses the logic of \cs{BooleanTrue} and +\cs{BooleanFalse}, so that the example from earlier would become +\begin{verbatim} + \NewDocumentCommand\foo{>{\ReverseBoolean} s m} + {% + \IfBooleanTF#1% + {\DoSomethingWithoutStar{#2}}% + {\DoSomethingWithStar{#2}}% + } +\end{verbatim} + +\begin{decl} + |\TrimSpaces| +\end{decl} +Removes any leading and trailing spaces (tokens with character code~$32$ +and category code~$10$) for the ends of the argument. Thus for example +declaring a function +\begin{verbatim} + \NewDocumentCommand\foo {>{\TrimSpaces} m} + {\showtokens{#1}} +\end{verbatim} +and using it in a document as +\begin{flushleft} + \verb= =\verb*=\foo{ hello world }= +\end{flushleft} +will show `\verb*=hello world=' at the terminal, with the space at each +end removed. \cs{TrimSpaces} will remove multiple spaces from the ends of +the input in cases where these have been included such that the standard +\TeX{} conversion of multiple spaces to a single space does not apply. + +\subsection{Body of an environment} +\label{sec:cmd:body} + +While environments |\begin|\marg{environment}\ \dots{}\,|\end|\marg{environment} +are typically used in cases where the code implementing the \meta{environment} +does not need to access the contents of the environment (its `body'), +it is sometimes useful to have the body as a standard argument. + +This is achieved by ending the argument specification with~\texttt{b}, which is +a dedicated argument type for this situation. For instance +\begin{verbatim} + \NewDocumentEnvironment{twice} {O{\ttfamily} +b} + {#2#1#2} {} +\end{verbatim} +\begin{verbatim} + \begin{twice}[\itshape] + Hello world! + \end{twice} +\end{verbatim} +typesets `Hello world!{\itshape Hello world!}'. + +The prefix |+| is used to allow multiple paragraphs in the environment's body. +Argument processors can also be applied to \texttt{b}~arguments. By default, +spaces are trimmed at both ends of the body: in the example there would +otherwise be spaces coming from the ends the lines after |[\itshape]| and +|world!|. Putting the prefix |!| before \texttt{b} suppresses space-trimming. + +When \texttt{b} is used in the argument specification, the last argument of the environment declaration (e.g., \cs{NewDocumentEnvironment}), which consists of an \meta{end code} to insert at +|\end|\marg{environment}, is redundant since one can simply put that code at +the end of the \meta{start code}. Nevertheless this (empty) \meta{end code} +must be provided. + +Environments that use this feature can be nested. + +\subsection{Fully-expandable document commands} + +Document commands created using \cs{NewDocumentCommand}, etc.\@, are normally +created so that they do not expand unexpectedly. This is done using engine +features, so is more powerful than \LaTeXe{}'s \cs{protect} mechanism. There +are \emph{very rare} occasion when it may be useful to create functions using a +expansion-only grabber. This imposes a number of restrictions on the +nature of the arguments accepted by a function, and the code it implements. +This facility should only be used when \emph{absolutely necessary}. + +\begin{decl} + |\NewExpandableDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} \\ + |\RenewExpandableDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} \\ + |\ProvideExpandableDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} \\ + |\DeclareExpandableDocumentCommand| \arg{cmd} \arg{arg spec} \arg{code} +\end{decl} +This family of commands is used to create a document-level \meta{function}, +which will grab its arguments in a fully-expandable manner. The +argument specification for the function is given by \meta{arg spec}, +and the function will execute \meta{code}. In general, \meta{code} will +also be fully expandable, although it is possible that this will +not be the case (for example, a function for use in a table might +expand so that \cs{omit} is the first non-expandable non-space token). + +Parsing arguments by pure expansion imposes a number of restrictions on +both the type of arguments that can be read and the error checking +available: +\begin{itemize} + \item The last argument (if any are present) must be one of the + mandatory types \texttt{m}, \texttt{r} or \texttt{R}. + \item The `verbatim' argument type \texttt{v} is not available. + \item Argument processors (using \texttt{>}) are not available. + \item It is not possible to differentiate between, for example + |\foo[| and |\foo{[}|: in both cases the \texttt{[} will be + interpreted as the start of an optional argument. As a + result, checking for optional arguments is less robust than + in the standard version. +\end{itemize} + +\subsection{Details about argument delimiters} + +In normal (non-expandable) commands, the delimited types look for the +initial delimiter by peeking ahead (using \pkg{expl3}'s |\peek_...| +functions) looking for the delimiter token. The token has to have the +same meaning and `shape' of the token defined as delimiter. +There are three possible cases of delimiters: character tokens, control +sequence tokens, and active character tokens. For all practical purposes +of this description, active character tokens will behave exactly as +control sequence tokens. + +\subsubsection{Character tokens} + +A character token is characterized by its character code, and its meaning +is the category code~(|\catcode|). When a command is defined, the meaning +of the character token is fixed into the definition of the command and +cannot change. A command will correctly see an argument delimiter if +the open delimiter has the same character and category codes as at the +time of the definition. For example in: +\begin{verbatim} + \NewDocumentCommand { \foobar } { D<>{default} } {(#1)} +\end{verbatim} +\begin{verbatim} + \foobar <hello> \par + \char_set_catcode_letter:N < + \foobar <hello> +\end{verbatim} +the output would be: +\begin{verbatim} + (hello) + (default)<hello> +\end{verbatim} +as the open-delimiter |<| changed in meaning between the two calls to +|\foobar|, so the second one doesn't see the |<| as a valid delimiter. +Commands assume that if a valid open-delimiter was found, a matching +close-delimiter will also be there. If it is not (either by being +omitted or by changing in meaning), a low-level \TeX{} error is raised +and the command call is aborted. + +\subsubsection{Control sequence tokens} + +A control sequence (or control character) token is characterized by is +its name, and its meaning is its definition. +A token cannot have two different meanings at the same time. +When a control sequence is defined as delimiter in a command, +it will be detected as delimiter whenever the control sequence name +is found in the document regardless of its current definition. +For example in: +\begin{verbatim} + \cs_set:Npn \x { abc } + \NewDocumentCommand { \foobar } { D\x\y{default} } {(#1)} + \foobar \x hello\y \par + \cs_set:Npn \x { def } + \foobar \x hello\y +\end{verbatim} +the output would be: +\begin{verbatim} + (hello) + (hello) +\end{verbatim} +with both calls to the command seeing the delimiter |\x|. + +\subsection{Creating new argument processors} + +\begin{decl} + |\ProcessedArgument| +\end{decl} +Argument processors allow manipulation of a grabbed argument before it is +passed to the underlying code. New processor implementations may be created +as functions which take one trailing argument, and which leave their result in +the \cs{ProcessedArgument} variable. For example, \cs{ReverseBoolean} is +defined as +\begin{verbatim} +\ExplSyntaxOn + \cs_new_protected:Npn \ReverseBoolean #1 + { + \bool_if:NTF #1 + { \tl_set:Nn \ProcessedArgument { \c_false_bool } } + { \tl_set:Nn \ProcessedArgument { \c_true_bool } } + } +\ExplSyntaxOff +\end{verbatim} +[As an aside: the code is written in \pkg{expl3}, so we don't have to + worry about spaces creeping into the definition.] + +\subsection{Access to the argument specification} + +The argument specifications for document commands and environments are +available for examination and use. + +\begin{decl} + |\GetDocumentCommandArgSpec| \arg{function} \\ + |\GetDocumentEnvironmentArgSpec| \arg{environment} +\end{decl} +These functions transfer the current argument specification for the +requested \meta{function} or \meta{environment} into the token list +variable \cs{ArgumentSpecification}. If the \meta{function} or +\meta{environment} has no known argument specification then an error +is issued. The assignment to \cs{ArgumentSpecification} is local to +the current \TeX{} group. + +\begin{decl} + |\ShowDocumentCommandArgSpec| \arg{function} \\ + |\ShowDocumentEnvironmentArgSpec| \arg{environment} +\end{decl} +These functions show the current argument specification for the +requested \meta{function} or \meta{environment} at the terminal. If +the \meta{function} or \meta{environment} has no known argument +specification then an error is issued. + +\end{document} diff --git a/Master/texmf-dist/doc/latex/base/utf8ienc.pdf b/Master/texmf-dist/doc/latex/base/utf8ienc.pdf Binary files differindex 00da2138cd0..6ff7254be85 100644 --- a/Master/texmf-dist/doc/latex/base/utf8ienc.pdf +++ b/Master/texmf-dist/doc/latex/base/utf8ienc.pdf diff --git a/Master/texmf-dist/doc/latex/base/webcomp.pdf b/Master/texmf-dist/doc/latex/base/webcomp.pdf Binary files differindex 1c36db0c61c..1a1cca038ff 100644 --- a/Master/texmf-dist/doc/latex/base/webcomp.pdf +++ b/Master/texmf-dist/doc/latex/base/webcomp.pdf |