[latex3-commits] [git/LaTeX3-latex3-pdfresources] rename-coredict: improve docu (1e7fbb6)

[Ulrike Fischer]

Repository : https://github.com/latex3/pdfresources
On branch  : rename-coredict
Link       : https://github.com/latex3/pdfresources/commit/1e7fbb6d186cb17273934b7b171356240613db53

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

commit 1e7fbb6d186cb17273934b7b171356240613db53
Author: Ulrike Fischer <fischer at troubleshooting-tex.de>
Date:   Sat Nov 28 21:10:50 2020 +0100

    improve docu


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

1e7fbb6d186cb17273934b7b171356240613db53
 pdfresources.dtx | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/pdfresources.dtx b/pdfresources.dtx
index 0b4fa17..cac3521 100644
--- a/pdfresources.dtx
+++ b/pdfresources.dtx
@@ -117,12 +117,19 @@
 %  }
 % \end{verbatim}
 %
+% The pdf management can be deactivated either by commenting the
+% \cs{DeclareDocumentMetadata} or by using in the options \texttt{pdfmanagement=false}.
+% The options of \cs{DeclareDocumentMetadata} are described in the documentation of
+% \pkg{ltdocinit}.
 %
+% If the pdf management is active can be tested with the predicate \cs{pdfmanagement_if_active:TF},
+% see the documentation of \pkg{l3pdfmanagement}.
 %
-% \section{Modules of the package}
-%
+% We hope that this setup will allow packages writers and authors to test the pdfmanagement and adapt
+% packages and document safely.
 %
 %
+% \section{Backend support}
 % The supported backends are pdflatex, lualatex, (x)dvipdfmx (latex, xelatex)
 % and dvips with ps2pdf (not completely yet). dvips with distiller could work too
 % but is untested.
@@ -132,7 +139,11 @@
 % The backends are too different to allow this.
 % Some backends expand arguments e.g. in a \cs{special} while other don't.
 % Some backends can insert a resource at the first compilation, while another uses
-% the aux-file and a label and so needs at least two.
+% the aux-file and a label and so needs at least two. Some backends manage some
+% of the resources through side-effects, some manage them automatically.
+% All this mean that package writers will still have to keep an eye on
+% backend requirements and run tests for all variants. Also backend specific code
+% will still be needed in some cases.
 % 
 % \section{Use}
 % The package should be loaded before \cs{documentclass}. To activate