[latex3-commits] [git/LaTeX3-latex3-latex2e] adapt-new-or: update documentation for DocumentMetadata (df4a2d5e)

[Ulrike Fischer]

Repository : https://github.com/latex3/latex2e
On branch  : adapt-new-or
Link       : https://github.com/latex3/latex2e/commit/df4a2d5e9cb93854eeed1c0808722fbd4061b879

>---------------------------------------------------------------

commit df4a2d5e9cb93854eeed1c0808722fbd4061b879
Author: Ulrike Fischer <fischer at troubleshooting-tex.de>
Date:   Fri Nov 4 11:25:01 2022 +0100

    update documentation for DocumentMetadata


>---------------------------------------------------------------

df4a2d5e9cb93854eeed1c0808722fbd4061b879
 required/latex-lab/documentmetadata-support.dtx | 53 +++++++++++++++++++++----
 1 file changed, 45 insertions(+), 8 deletions(-)

diff --git a/required/latex-lab/documentmetadata-support.dtx b/required/latex-lab/documentmetadata-support.dtx
index 23053a48..61ae166e 100644
--- a/required/latex-lab/documentmetadata-support.dtx
+++ b/required/latex-lab/documentmetadata-support.dtx
@@ -64,13 +64,19 @@
 %    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
+%    \cs{DocumentMetadata} is placed 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.
 %    
+%    \cs{DocumentMetadata} also loads and activates
+%    the new PDF management code from \pkg{pdfmanagement-testphase}.
+%    As this forces the loading of the \pkg{l3backend} files, a backend
+%    which can't be detected automatically like |dvipdfmx|,
+%    must be set in the first \cs{DocumentMetadata}.
+%
 %    From a process perspective \cs{DocumentMetadata} loads the
-%    \pkg{pdfmanagement} code the first time it is called and then
+%    \pkg{pdfmanagement-testphase} 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
@@ -84,10 +90,12 @@
 %
 %
 % Currently the following keys are implemented for \cs{DocumentMetadata}:
+% \DescribeMkey{backend}
 % \DescribeMkey{colorprofiles}
 % \DescribeMkey{debug}
 % \DescribeMkey{lang}
 % \DescribeMkey{pdfstandard}
+% \DescribeMkey{xmp}
 % \DescribeMkey{pdfversion}
 % \DescribeMkey{testphase}
 % \DescribeMkey{uncompress}
@@ -110,15 +118,34 @@
 %    \item[\texttt{pdfstandard}] Choice key to set the pdf standard.
 %      Currently |A-1b|, |A-2a|, |A-2b|, |A-2u|, |A-3a|, |A-3b|, |A-3u| and |A-4| 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 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. The |A-4| support is
-%      currently incomplete.
+%      Note that using these
+%      key doesn't mean that the document actually follows the standard. \LaTeX{}
+%      can neither ensure nor check all requirements of a standard, and not everything
+%      it can do theoretically has already been implemented.
+%      When setting an A-standard a color profile is included and the
+%      \texttt{/OutputIntent} is set and javascript action in hyperref are suppressed.
+%      The |u| variants do not force unicode,
+%      but they will pass the information to hyperref. The |a| variants
+%      do \emph{not} enforce (or even test) a tagged pdf yet.
+%      
+%      Starting with version 0.95s of \pkg{pdfmanagement-testphase}
+%      it is also possible to use the values
+%      |X-4|, |X-4p|, |X-5g|, |X-5n|, |X-5pg|, |X-6|, |X-6n|, |X-6p|, |UA-1| for
+%      a PDF/X and PDF/UA standard. These keys set \emph{only} the relevant
+%      XMP-metadata.
+%
+%      |pdfstandard| can be used more than once to set overlapping standards, e.g:\\
+%      |pdfstandard=A-2b,pdfstandard=X-4,pdfstandard=UA-1|
+%      
+%      If XMP-metadata are added (see the following key \texttt{xmp}
+%      the needed conformance marker for the standards are set.
+%      
 %      More information can be found in the documentation
 %      of \pkg{l3pdfmeta}.   
 %
+%    \item[\texttt{xmp}] A boolean, if set to false no XMP metadata are added to the PDF.
+%    The default is true. Details are described in the documentation of \pkg{l3pdfmeta}.
+%    
 %    \item[\texttt{colorprofiles}] This allows to load icc-colorprofiles. Details
 %       are described in the documentation of \pkg{l3pdfmeta}.
 %
@@ -137,6 +164,16 @@
 %       additionally activate tagging of paragraphs with
 %       |\tagpdfsetup{paratagging}|. In the upcoming months it will
 %       also enable automatic tagging of other basic document elements.
+%    \item[\texttt{new-or-1}] This patches a few commands related
+%    to the output routine. The patches are needed for the tagging
+%    of paragraphs, for the tagging of header and footer and 
+%    to allow the PDF management to insert code which avoids that
+%    links happening at page breaks spills into the header and footer. 
+%    This code is automatically loaded if the \texttt{testphase} values
+%    \texttt{phase-I}, \texttt{phase-II} or \texttt{new-or} are used.%   
+%    \item[\texttt{new-or}] This loads more changes to the output routine required for the 
+%    tagging. It is not compatible with every class! The code is also loaded by the 
+%    \texttt{phase-II} value.
 %    \end{description}
 %    The |testphase| key can only be used in the first \cs{DocumentMetadata}.
 %