[latex3-commits] [git/LaTeX3-latex3-latex2e] testmetadata: documentation update (something wrong with *-doc.tex) (f44de974)
Frank Mittelbach
frank.mittelbach at latex-project.org
Wed Jan 12 11:47:36 CET 2022
Repository : https://github.com/latex3/latex2e
On branch : testmetadata
Link : https://github.com/latex3/latex2e/commit/f44de9749d684d9db99e12f125ff2a4cad04d523
>---------------------------------------------------------------
commit f44de9749d684d9db99e12f125ff2a4cad04d523
Author: Frank Mittelbach <frank.mittelbach at latex-project.org>
Date: Wed Jan 12 11:47:36 2022 +0100
documentation update (something wrong with *-doc.tex)
>---------------------------------------------------------------
f44de9749d684d9db99e12f125ff2a4cad04d523
required/latex-lab/build.lua | 10 +++-
required/latex-lab/documentmetadata-support.dtx | 73 +++++++++++++++++++------
2 files changed, 64 insertions(+), 19 deletions(-)
diff --git a/required/latex-lab/build.lua b/required/latex-lab/build.lua
index 33de1bb7..296c794f 100644
--- a/required/latex-lab/build.lua
+++ b/required/latex-lab/build.lua
@@ -8,12 +8,16 @@ module = "latex-lab"
ctanpkg = "latex-lab"
--- Location of main directory: use Unix-style path separators
maindir = "../.."
-- Minor modifications to file types
-installfiles = {"*.ltx", "*.sty", "*.tex"}
-typesetfiles = {"*.dtx"}
+installfiles = {"*.ltx", "*.sty"}
+typesetfiles = {
+ "latex-lab-testphase.dtx",
+ "*-doc.tex",
+ "*-code.tex",
+ }
+
unpackfiles = {"*.ins"}
sourcefiles = {"*.dtx", "*.ins", "*-????-??-??.sty"}
diff --git a/required/latex-lab/documentmetadata-support.dtx b/required/latex-lab/documentmetadata-support.dtx
index 16ab9650..f12cd224 100644
--- a/required/latex-lab/documentmetadata-support.dtx
+++ b/required/latex-lab/documentmetadata-support.dtx
@@ -17,6 +17,12 @@
%
% for those people who are interested or want to report an issue.
%
+% \begin{macrocode}
+\def\documentmetadatasupportversion{1.0a}
+\def\documentmetadatasupportdate{2022-01-12}
+% \end{macrocode}
+%
+%
%<*driver>
\documentclass{l3doc}
\EnableCrossrefs
@@ -28,44 +34,79 @@
%
% \fi
%
-
-% \title{The \texttt{documentmetadata-support} code\thanks{}}
+%
+%
+%
+% \title{The \texttt{documentmetadata-support} code\thanks{This file
+% has version \documentmetadatasupportversion\ dated
+% \documentmetadatasupportdate, \copyright\ \LaTeX\
+% Project.}}
% \author{Frank Mittelbach, Ulrike Fischer, \LaTeX{} Project}
%
% \maketitle
%
%
-% \begin{abstract}
-% \end{abstract}
-%
% \section{Introduction}
-% This file currently does the main work for \cs{DocumentMetadata}: it (re)defines
-% it so that it load the pdfmanagement code and it setups the keys of the command.
+%
+% The kernel command \cs{DocumentMetadata}, which can be used as
+% the very first declaration in a document (i.e., before
+% \cs{documentclass}), defines metadata and other configuration
+% data that applies to the document as a whole (using a key/value
+% syntax).
+%
+% While the underlying functionality is still under
+% development (e.g., further keys will be added over time and keys
+% marked temporary may vanish again) the code for
+% \cs{DocumentMetadata} is place in a separate bundle, so that it
+% is easier to update it without the need to build a full \LaTeX{}
+% release. Over time the functionality will move fully into the
+% kernel.
+%
+% From a process perspective \cs{DocumentMetadata} loads the
+% \pkg{pdfmanagement} code the first time it is called and then
+% redefines itself to only manage key/value pairs in case it is
+% called more than once. In particular, this means that a document
+% without a \cs{DocumentMetadata} declaration has no code available
+% for extended management of PDF output as needed for various
+% features developed as part of the multi-year ``Tagged PDF''
+% project~\cite{blueprint}.
+%
+%
+%
+% \section{Currently supported key/values}
+%
%
% Currently the following keys are implemented for \cs{DocumentMetadata}:
%
%
% \begin{description}
-% \item[\texttt{backend}] passes the backend name to expl3.
-%^^A This will probably be extended to pass the value also to packages.
-% \item[\texttt{pdfversion}] e.g. \texttt{pdfversion=1.7}
-% \item[\texttt{uncompress}] no value. Forces an uncompressed pdf.
-% \item[\texttt{lang}] to set the Lang entry in the Catalog,
+% \item[\texttt{backend}] Passes the backend name to expl3. This is
+% needed only if the needed backend can't be automatically
+% determined or if the workflow used requires a special backend.
+%
+%^^A This will probably be extended to pass the value also to
+%^^A packages.
+%
+% \item[\texttt{pdfversion}] Sets the PDF version explicitly, e.g., \texttt{pdfversion=1.7}
+% \item[\texttt{uncompress}] (no value) Forces an uncompressed pdf
+% --- mainly for debugging purposes.
+%
+% \item[\texttt{lang}] Explicitly sets the Lang entry in the Catalog,
% e.g., \texttt{lang=de-DE}. If not given the default value used is |en-US|.
%
% \item[\texttt{pdfstandard}] Choice key to set the pdf standard.
% Currently |A-1b|, |A-2a|, |A-2b|, |A-2u|, |A-3a|, |A-3b| and |A-3u| are accepted as
% values. The casing is irrelevant, |a-1b| works too.
% The underlying code to ensure the requirements (as far as they
-% can be ensured) is incomplete, but a color profile is included and the
-% /OutputIntent is set. The |u| variants for example do not force unicode,
+% can be ensured) is still incomplete, but a color profile is included and the
+% \texttt{/OutputIntent} is set. The |u| variants for example do not force unicode,
% but they will pass the information to hyperref and hyperxmp. The |a| variants
% do \emph{not} enforce (or even test) a tagged pdf yet.
% More information can be found in the documentation
% of \pkg{l3pdfmeta}.
%
% \item[\texttt{colorprofiles}] This allows to load icc-colorprofiles. Details
-% are described in the documentation of \pkg{l3pdfmeta}.
+% are described in the documentation of \pkg{l3pdfmeta}.
%
% \item[\texttt{testphase}] This key is used to load testphase code. The values it accepts
% and their effect will change over time, when testphase packages are added or
@@ -111,7 +152,7 @@
%
%
%
-% \StopEventually{\setlength\IndexMin{200pt} \PrintIndex }
+% \MaybeStop{\setlength\IndexMin{200pt} \PrintIndex }
%
%
% \section{The Implementation}
More information about the latex3-commits
mailing list.