summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/doclicense/doclicense.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/doclicense/doclicense.dtx')
-rw-r--r--macros/latex/contrib/doclicense/doclicense.dtx38
1 files changed, 26 insertions, 12 deletions
diff --git a/macros/latex/contrib/doclicense/doclicense.dtx b/macros/latex/contrib/doclicense/doclicense.dtx
index c03b64f472..ef894621f8 100644
--- a/macros/latex/contrib/doclicense/doclicense.dtx
+++ b/macros/latex/contrib/doclicense/doclicense.dtx
@@ -27,7 +27,7 @@
%<package>\NeedsTeXFormat{LaTeX2e}[1998/12/01]
%<package>\ProvidesPackage{doclicense}
%<*package>
- [2020/07/26 v2.1.0 Support for putting documents under a license]
+ [2020/09/18 v2.2.1.dev Support for putting documents under a license]
%</package>
%
%<*driver>
@@ -82,7 +82,7 @@ corresponds to \PackageName\nobreakspace\fileversion, dated \printdateTeX{\filed
\author{\PackageAuthor\\
\texttt{\href{mailto:\PackageAuthorEmail?subject=LaTeX package doclicense%
- \&body=Dear Robin Schneider,}%
+ \&body=Hey Robin,}%
{\PackageAuthorEmail}%
}%
}
@@ -117,13 +117,13 @@ corresponds to \PackageName\nobreakspace\fileversion, dated \printdateTeX{\filed
% Grave accent \` Left brace \{ Vertical bar \|
% Right brace \} Tilde \~}
%
-% \changes{0.07}{2015/02/05}{Initial version}
+% \changes{0.07}{2015/02/05}{Initial version.}
% \changes{0.08}{2015/02/06}{Added support for CC-zero and CC-pd and small improvements}
% \changes{0.09}{2015/02/07}{Added list of supported licenses to docu and added option imagemodifier.
-% Also renamed macro \cmd{\doclicenseLicense} to \cmd{\doclicenseThis}}
-% \changes{0.10}{2015/02/13}{Added support for hyperxmp}
-% \changes{1.0}{2015/03/30}{Removed space before quotes (Example: \enquote{CC } $\rightarrow$ \enquote{CC})}
-% \changes{1.1}{2015/04/06}{Added support for Creative Commons 4.0 and added \cmd{\doclicenseImageFileName}}
+% Also renamed macro \cmd{\doclicenseLicense} to \cmd{\doclicenseThis}.}
+% \changes{0.10}{2015/02/13}{Added support for hyperxmp.}
+% \changes{1.0}{2015/03/30}{Removed space before quotes (Example: \enquote{CC } $\rightarrow$ \enquote{CC}).}
+% \changes{1.1}{2015/04/06}{Added support for Creative Commons 4.0 and added \cmd{\doclicenseImageFileName}.}
% \changes{1.2}{2015/04/06}{Allow \cmd{\doclicenseModifier} to be used with hyperref. Fixed \cmd{\doclicenseIcon} macro, added missing image and wrote test framework. Added notes about how to add translations. Added Spanish translation.}
% \changes{1.4.0}{2015/12/13}{Added \cmd{\doclicensePlainFullText} and \cmd{\doclicenseFullText} macros. Thanks to \href{https://github.com/siefkenj}{siefkenj} for the help.}
% \changes{1.4.1}{2016/04/10}{Translation fixes for: fr, en-gb. Included missing CC-by-nc-nd icon (US dollar).}
@@ -138,6 +138,7 @@ corresponds to \PackageName\nobreakspace\fileversion, dated \printdateTeX{\filed
% \changes{2.0.0}{2020/05/27}{Add 80x15 version of CC images which can be used with the imagemodifier option. Fix slight color offset for all CC images caused by bad image conversion. Thanks to rodrigoalcarazdelaosa for reporting. Fix \cmd{\doclicenseThis} support for twocolumn layouts. Thanks to Nao Pross. Soft require package options "type", "modifier" and "version" now. Defaults are deprecated. This will become a package error in an upcoming major version of the package, with the earliest release in 2021-07 to give people time to migrate. Remove Creative Commons PD which has been replaced by CC-zero as of 2010-10-11. Update example license used for examples in manual to CC-BY-SA-4.0.}
% \changes{2.0.1}{2020/06/26}{Fix backwards compatibility by still accepting imagemodifier={-eu} and imagemodifier={-us}. Thanks to Jürgen Spitzmüller for reporting. Fix ability to modify currency of \cmd{\doclicenseIcon} macro using imagemodifier to Japan currency JP without breaking \cmd{\doclicenseImage}.}
% \changes{2.1.0}{2020/07/26}{Fix regression: Proper language default image variants (Euro variants for example) was broken and the US variant was always used. This bug was introduced in v2.0.0. Documentation fixes. Added Marathi translation.}
+% \changes{2.2.0}{2020/09/18}{Add Japanese and Bulgarian translation. Add hint how to use Chinese to docs. Load hyperxmp by default when it is installed. Before, doclicense just suggested to load it and made use of the package when the user did.}
%
%
@@ -181,7 +182,6 @@ corresponds to \PackageName\nobreakspace\fileversion, dated \printdateTeX{\filed
% \begin{quote}
% |\usepackage{| \\
% | babel,| \\
-% | hyperxmp,| \\
% |}| \\
% |\usepackage[| \\
% | type={CC},| \\
@@ -194,10 +194,16 @@ corresponds to \PackageName\nobreakspace\fileversion, dated \printdateTeX{\filed
%
% This will explicitly set the license to \doclicenseNameRef.
%
-% If the \PrintPackage{hyperxmp} package is loaded, then the options
+% If the \PrintPackage{hyperxmp} package is installed, it will be loaded and the options
% \PrintOptionF{pdflicenseurl} and \PrintOptionF{pdfcopyright} will be set
% by \PackageName{} to the corresponding values
% (\enquote{\url{\doclicenseURL}} and \enquote{\doclicenseLongText{}}).
+% This embeds license metadata into the PDF which proper PDF readers can show.
+% For example Evince shows it in the \enquote{Document License} tab under
+% \enquote{Properties}. You may check this manual for how your PDF reader
+% handles such metadata.
+% If the package is not installed, a warning will be emitted to allow you to
+% install the package as needed.
%
% \section{Package options}
%
@@ -224,13 +230,15 @@ corresponds to \PackageName\nobreakspace\fileversion, dated \printdateTeX{\filed
% ^^A Sorted alphabetically.
% \begin{eqlist}
% \item[Brazilian] Added by \href{https://github.com/iagows}{Iago}.
+% \item[Bulgarian] Added by \href{https://github.com/hristo-d-hristov}{hristo-d-hristov}.
% \item[Catalan] Added by \href{https://github.com/elancha98}{Ernesto Lanchares}.
-% \item[Chinese] Added by \href{https://github.com/sd44}{sd44}.
+% \item[Chinese] Added by \href{https://github.com/sd44}{sd44}. Note that you might need to pass \verb+lang={chinese-utf8}+ or \verb+chinese-gbk+.
% \item[English] Added by \href{https://me.ypid.de/}{Robin Schneider}.
% \item[French] Added by \href{https://github.com/ericguirbal}{\'Eric Guirbal}.
% \item[Galician] Submitted by Email.
% \item[German] Added by \href{https://me.ypid.de/}{Robin Schneider}.
% \item[Italian] Added by \href{https://github.com/rig8f}{Filippo Rigotto}.
+% \item[Japanese] Added by \href{https://github.com/cmplstofB}{cmplstofB}.
% \item[Marathi] Added by \href{https://github.com/NiranjanTambe}{Niranjan}. Note that Niranjan also translated the images which are considered unofficial by the package. Creative Commons has no plans to support additional currencies.
% \item[Polish] Added by \href{https://github.com/jsbien}{jsbien}.
% \item[Portuguese] Added by \href{https://github.com/alexandre1985}{Daniel Alexandre Cerqueira Santos}.
@@ -615,13 +623,19 @@ corresponds to \PackageName\nobreakspace\fileversion, dated \printdateTeX{\filed
\@ifpackageloaded{graphicx}{}{\RequirePackage{graphicx}}
%% For \doclicenseImage
\@ifpackageloaded{hyperref}{}{\RequirePackage{hyperref}}
- \@ifpackageloaded{hyperxmp}{%
+ \IfFileExists{hyperxmp.sty}{
+ \@ifpackageloaded{hyperxmp}{}{\RequirePackage{hyperxmp}}
%% The following options are only defined when the hyperxmp package was loaded.
\hypersetup{
pdfcopyright = {\doclicenseLongText},
pdflicenseurl = {\doclicenseURL},
}
- }{}
+ }{
+ \PackageWarning{doclicense}{%
+ The hyperxmp package is missing so no license metadata can be embedded
+ into the PDF. Consider installing hyperxmp.% chktex 13
+ }
+ }
}
%% )))