summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/hyperxmp/hyperxmp.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/hyperxmp/hyperxmp.dtx')
-rw-r--r--Master/texmf-dist/source/latex/hyperxmp/hyperxmp.dtx41
1 files changed, 38 insertions, 3 deletions
diff --git a/Master/texmf-dist/source/latex/hyperxmp/hyperxmp.dtx b/Master/texmf-dist/source/latex/hyperxmp/hyperxmp.dtx
index 7edb195c983..dd4cd3b9d4c 100644
--- a/Master/texmf-dist/source/latex/hyperxmp/hyperxmp.dtx
+++ b/Master/texmf-dist/source/latex/hyperxmp/hyperxmp.dtx
@@ -1,6 +1,6 @@
% \iffalse meta-comment
%
-% Copyright (C) 2018 by Scott Pakin <scott+hyxmp@pakin.org>
+% Copyright (C) 2019 by Scott Pakin <scott+hyxmp@pakin.org>
% -------------------------------------------------------
%
% This file may be distributed and/or modified under the
@@ -22,7 +22,7 @@
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{hyperxmp}
%<*package>
- [2018/11/27 v3.5 Store hyperref metadata in XMP format]
+ [2019/02/25 v3.5a Store hyperref metadata in XMP format]
%</package>
%
%<*driver>
@@ -55,7 +55,7 @@
pdftitle={The hyperxmp package},
pdfsubject={LaTeX2e support for XMP metadata},
pdfkeywords={LaTeX, embedded metadata, XMP, PDF, copyright, license, comments},
- pdfcopyright={Copyright (C) 2018, Scott Pakin},
+ pdfcopyright={Copyright (C) 2019, Scott Pakin},
pdflicenseurl={http://www.latex-project.org/lppl/},
pdfcaptionwriter={Scott Pakin},
pdfcontactemail={scott+hyxmp@pakin.org},
@@ -835,6 +835,41 @@
% \XMPLangAlt{rm}{pdftitle={Titel rumantsch}}
% \end{verbatim}
%
+% \usagenote{Expandable arguments}
+% All arguments passed to \pkgname{hyperxmp} options must be expandable,
+% in \tex\ terminology. This implies that any macros that are used in
+% arguments are limited to a relatively small set of operations (such as
+% conditionals and macro expansion) and must produce a string of text.
+% Code (such as macro definitions and arithmetic operations) will be
+% written to \acro{XMP} as code, not as the result of executing the
+% code.
+%
+% By way of example, the macros provided by the \pkgname{texdate}
+% package for typesetting dates are not expandable (at least at the time
+% of this writing). Hence, the |\printfdate{Y}| in the following code
+% snippet is not replaced by the current year, as one might expect:
+%
+% \begin{verbatim}
+% \usepackage{texdate}
+% \initcurrdate
+% \hypersetup{%
+% pdfcopyright={Copyright \textcopyright\ \printfdate{Y}, Scott Pakin}
+% }
+% \end{verbatim}
+%
+% \noindent
+% Rather, it generates a \xmpterm{dc:rights} tag of the form
+% ``\texttt{Copyright \textcopyright\ =2=0=by-1by=0\the\year, Scott
+% Pakin}''. The garbage in that line corresponds to the remnants of
+% the |\printfdate| code after expanding all of the \tex\ primitives and
+% certain other control sequences it uses to the empty string. For
+% example, ``|\global\advance\texd@yr| |by-1|'' expands to ``|by-1|''.
+%
+% It is not possible to determine a~priori whether or not a macro is
+% expandable. The best advice is to carefully inspect the \acro{XMP}
+% package in the output file to ensure that any macros used in arguments
+% to \pkgname{hyperxmp} options produced the expected output.
+%
%
% \StopEventually{^^A
% \section{Future Work}