summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-12-18 03:01:19 +0000
committerNorbert Preining <norbert@preining.info>2019-12-18 03:01:19 +0000
commit6d3d0706f9b7085f8bc6efa81398dbfe551272db (patch)
tree46f604191e8b84eb8f939a14f2bfc5fd795dddd9 /macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx
parent6cbf49c3ed1a2881b7fccbc67eccb5532d196b74 (diff)
CTAN sync 201912180301
Diffstat (limited to 'macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx')
-rw-r--r--macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx612
1 files changed, 612 insertions, 0 deletions
diff --git a/macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx b/macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx
new file mode 100644
index 0000000000..11810e3324
--- /dev/null
+++ b/macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx
@@ -0,0 +1,612 @@
+% \iffalse meta-comment
+%
+% File: kvdefinekeys.dtx
+% Version: 2019/12/15 v1.5
+% Info: Define keys
+%
+% Copyright (C)
+% 2010, 2011 Heiko Oberdiek
+% 2016-2019 Oberdiek Package Support Group
+% https://github.com/ho-tex/kvdefinekeys/issues
+%
+% This work may be distributed and/or modified under the
+% conditions of the LaTeX Project Public License, either
+% version 1.3c of this license or (at your option) any later
+% version. This version of this license is in
+% https://www.latex-project.org/lppl/lppl-1-3c.txt
+% and the latest version of this license is in
+% https://www.latex-project.org/lppl.txt
+% and version 1.3 or later is part of all distributions of
+% LaTeX version 2005/12/01 or later.
+%
+% This work has the LPPL maintenance status "maintained".
+%
+% The Current Maintainers of this work are
+% Heiko Oberdiek and the Oberdiek Package Support Group
+% https://github.com/ho-tex/kvdefinekeys/issues
+%
+% The Base Interpreter refers to any `TeX-Format',
+% because some files are installed in TDS:tex/generic//.
+%
+% This work consists of the main source file kvdefinekeys.dtx
+% and the derived files
+% kvdefinekeys.sty, kvdefinekeys.pdf, kvdefinekeys.ins, kvdefinekeys.drv,
+% kvdefinekeys-test1.tex.
+%
+% Distribution:
+% CTAN:macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx
+% CTAN:macros/latex/contrib/kvdefinekeys/kvdefinekeys.pdf
+%
+% Unpacking:
+% (a) If kvdefinekeys.ins is present:
+% tex kvdefinekeys.ins
+% (b) Without kvdefinekeys.ins:
+% tex kvdefinekeys.dtx
+% (c) If you insist on using LaTeX
+% latex \let\install=y\input{kvdefinekeys.dtx}
+% (quote the arguments according to the demands of your shell)
+%
+% Documentation:
+% (a) If kvdefinekeys.drv is present:
+% latex kvdefinekeys.drv
+% (b) Without kvdefinekeys.drv:
+% latex kvdefinekeys.dtx; ...
+% The class ltxdoc loads the configuration file ltxdoc.cfg
+% if available. Here you can specify further options, e.g.
+% use A4 as paper format:
+% \PassOptionsToClass{a4paper}{article}
+%
+% Programm calls to get the documentation (example):
+% pdflatex kvdefinekeys.dtx
+% makeindex -s gind.ist kvdefinekeys.idx
+% pdflatex kvdefinekeys.dtx
+% makeindex -s gind.ist kvdefinekeys.idx
+% pdflatex kvdefinekeys.dtx
+%
+% Installation:
+% TDS:tex/generic/kvdefinekeys/kvdefinekeys.sty
+% TDS:doc/latex/kvdefinekeys/kvdefinekeys.pdf
+% TDS:source/latex/kvdefinekeys/kvdefinekeys.dtx
+%
+%<*ignore>
+\begingroup
+ \catcode123=1 %
+ \catcode125=2 %
+ \def\x{LaTeX2e}%
+\expandafter\endgroup
+\ifcase 0\ifx\install y1\fi\expandafter
+ \ifx\csname processbatchFile\endcsname\relax\else1\fi
+ \ifx\fmtname\x\else 1\fi\relax
+\else\csname fi\endcsname
+%</ignore>
+%<*install>
+\input docstrip.tex
+\Msg{************************************************************************}
+\Msg{* Installation}
+\Msg{* Package: kvdefinekeys 2019/12/15 v1.5 Define keys (HO)}
+\Msg{************************************************************************}
+
+\keepsilent
+\askforoverwritefalse
+
+\let\MetaPrefix\relax
+\preamble
+
+This is a generated file.
+
+Project: kvdefinekeys
+Version: 2019/12/15 v1.5
+
+Copyright (C)
+ 2010, 2011 Heiko Oberdiek
+ 2016-2019 Oberdiek Package Support Group
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either
+version 1.3c of this license or (at your option) any later
+version. This version of this license is in
+ https://www.latex-project.org/lppl/lppl-1-3c.txt
+and the latest version of this license is in
+ https://www.latex-project.org/lppl.txt
+and version 1.3 or later is part of all distributions of
+LaTeX version 2005/12/01 or later.
+
+This work has the LPPL maintenance status "maintained".
+
+The Current Maintainers of this work are
+Heiko Oberdiek and the Oberdiek Package Support Group
+https://github.com/ho-tex/kvdefinekeys/issues
+
+
+The Base Interpreter refers to any `TeX-Format',
+because some files are installed in TDS:tex/generic//.
+
+This work consists of the main source file kvdefinekeys.dtx
+and the derived files
+ kvdefinekeys.sty, kvdefinekeys.pdf, kvdefinekeys.ins, kvdefinekeys.drv,
+ kvdefinekeys-test1.tex.
+
+\endpreamble
+\let\MetaPrefix\DoubleperCent
+
+\generate{%
+ \file{kvdefinekeys.ins}{\from{kvdefinekeys.dtx}{install}}%
+ \file{kvdefinekeys.drv}{\from{kvdefinekeys.dtx}{driver}}%
+ \usedir{tex/generic/kvdefinekeys}%
+ \file{kvdefinekeys.sty}{\from{kvdefinekeys.dtx}{package}}%
+}
+
+\catcode32=13\relax% active space
+\let =\space%
+\Msg{************************************************************************}
+\Msg{*}
+\Msg{* To finish the installation you have to move the following}
+\Msg{* file into a directory searched by TeX:}
+\Msg{*}
+\Msg{* kvdefinekeys.sty}
+\Msg{*}
+\Msg{* To produce the documentation run the file `kvdefinekeys.drv'}
+\Msg{* through LaTeX.}
+\Msg{*}
+\Msg{* Happy TeXing!}
+\Msg{*}
+\Msg{************************************************************************}
+
+\endbatchfile
+%</install>
+%<*ignore>
+\fi
+%</ignore>
+%<*driver>
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesFile{kvdefinekeys.drv}%
+ [2019/12/15 v1.5 Define keys (HO)]%
+\documentclass{ltxdoc}
+\usepackage{holtxdoc}[2011/11/22]
+\begin{document}
+ \DocInput{kvdefinekeys.dtx}%
+\end{document}
+%</driver>
+% \fi
+%
+%
+%
+% \GetFileInfo{kvdefinekeys.drv}
+%
+% \title{The \xpackage{kvdefinekeys} package}
+% \date{2019/12/15 v1.5}
+% \author{Heiko Oberdiek\thanks
+% {Please report any issues at \url{https://github.com/ho-tex/kvdefinekeys/issues}}}
+%
+% \maketitle
+%
+% \begin{abstract}
+% Package \xpackage{kvdefinekeys} provides \cs{kv@define@key} to define
+% keys the same way as \xpackage{keyval}'s \cs{define@key}. However, it
+% works also using \iniTeX.
+% \end{abstract}
+%
+% \tableofcontents
+%
+% \def\M#1{\texttt{\{}\meta{#1}\texttt{\}}}
+%
+% \section{Documentation}
+%
+% \subsection{Motivation}
+%
+% \cs{kvsetkeys} serves as replacement for \xpackage{keyval}'s
+% \cs{setkeys}. This package adds macros to define keys, closing
+% the gap \cs{kvsetkeys} leaves.
+%
+% \begin{declcs}{kv@define@key}\,\M{family}\,\M{key}\,[\meta{default}]\,^^A
+% \M{definition}
+% \end{declcs}
+% Macro \cs{kv@define@key} reimplements \xpackage{keyval}'s
+% \cs{define@key}. Differences to the original:
+% \begin{itemize}
+% \item The defined keys also allow \cs{par} inside values.
+% \item Shorthands of package \xpackage{babel} are supported in
+% family and key names.
+% \item Macro \cs{kv@define@key} is made robust if
+% \hologo{eTeX}'s \cs{protected} or \hologo{LaTeX}'s
+% \cs{DeclareRobustCommand} are found.
+% \end{itemize}
+%
+% \StopEventually{
+% }
+%
+% \section{Implementation}
+%
+% \subsection{Identification}
+%
+% \begin{macrocode}
+%<*package>
+% \end{macrocode}
+% Reload check, especially if the package is not used with \LaTeX.
+% \begin{macrocode}
+\begingroup\catcode61\catcode48\catcode32=10\relax%
+ \catcode13=5 % ^^M
+ \endlinechar=13 %
+ \catcode35=6 % #
+ \catcode39=12 % '
+ \catcode44=12 % ,
+ \catcode45=12 % -
+ \catcode46=12 % .
+ \catcode58=12 % :
+ \catcode64=11 % @
+ \catcode123=1 % {
+ \catcode125=2 % }
+ \expandafter\let\expandafter\x\csname ver@kvdefinekeys.sty\endcsname
+ \ifx\x\relax % plain-TeX, first loading
+ \else
+ \def\empty{}%
+ \ifx\x\empty % LaTeX, first loading,
+ % variable is initialized, but \ProvidesPackage not yet seen
+ \else
+ \expandafter\ifx\csname PackageInfo\endcsname\relax
+ \def\x#1#2{%
+ \immediate\write-1{Package #1 Info: #2.}%
+ }%
+ \else
+ \def\x#1#2{\PackageInfo{#1}{#2, stopped}}%
+ \fi
+ \x{kvdefinekeys}{The package is already loaded}%
+ \aftergroup\endinput
+ \fi
+ \fi
+\endgroup%
+% \end{macrocode}
+% Package identification:
+% \begin{macrocode}
+\begingroup\catcode61\catcode48\catcode32=10\relax%
+ \catcode13=5 % ^^M
+ \endlinechar=13 %
+ \catcode35=6 % #
+ \catcode39=12 % '
+ \catcode40=12 % (
+ \catcode41=12 % )
+ \catcode44=12 % ,
+ \catcode45=12 % -
+ \catcode46=12 % .
+ \catcode47=12 % /
+ \catcode58=12 % :
+ \catcode64=11 % @
+ \catcode91=12 % [
+ \catcode93=12 % ]
+ \catcode123=1 % {
+ \catcode125=2 % }
+ \expandafter\ifx\csname ProvidesPackage\endcsname\relax
+ \def\x#1#2#3[#4]{\endgroup
+ \immediate\write-1{Package: #3 #4}%
+ \xdef#1{#4}%
+ }%
+ \else
+ \def\x#1#2[#3]{\endgroup
+ #2[{#3}]%
+ \ifx#1\@undefined
+ \xdef#1{#3}%
+ \fi
+ \ifx#1\relax
+ \xdef#1{#3}%
+ \fi
+ }%
+ \fi
+\expandafter\x\csname ver@kvdefinekeys.sty\endcsname
+\ProvidesPackage{kvdefinekeys}%
+ [2019/12/15 v1.5 Define keys (HO)]%
+% \end{macrocode}
+%
+% \begin{macrocode}
+\begingroup\catcode61\catcode48\catcode32=10\relax%
+ \catcode13=5 % ^^M
+ \endlinechar=13 %
+ \catcode123=1 % {
+ \catcode125=2 % }
+ \catcode64=11 % @
+ \def\x{\endgroup
+ \expandafter\edef\csname KVD@AtEnd\endcsname{%
+ \endlinechar=\the\endlinechar\relax
+ \catcode13=\the\catcode13\relax
+ \catcode32=\the\catcode32\relax
+ \catcode35=\the\catcode35\relax
+ \catcode61=\the\catcode61\relax
+ \catcode64=\the\catcode64\relax
+ \catcode123=\the\catcode123\relax
+ \catcode125=\the\catcode125\relax
+ }%
+ }%
+\x\catcode61\catcode48\catcode32=10\relax%
+\catcode13=5 % ^^M
+\endlinechar=13 %
+\catcode35=6 % #
+\catcode64=11 % @
+\catcode123=1 % {
+\catcode125=2 % }
+\def\TMP@EnsureCode#1#2{%
+ \edef\KVD@AtEnd{%
+ \KVD@AtEnd
+ \catcode#1=\the\catcode#1\relax
+ }%
+ \catcode#1=#2\relax
+}
+\TMP@EnsureCode{42}{12}% *
+\TMP@EnsureCode{46}{12}% .
+\TMP@EnsureCode{47}{12}% /
+\TMP@EnsureCode{91}{12}% [
+\TMP@EnsureCode{93}{12}% ]
+\edef\KVD@AtEnd{\KVD@AtEnd\noexpand\endinput}
+% \end{macrocode}
+%
+% \subsection{Package loading}
+%
+% \begin{macrocode}
+\begingroup\expandafter\expandafter\expandafter\endgroup
+\expandafter\ifx\csname RequirePackage\endcsname\relax
+ \def\TMP@RequirePackage#1[#2]{%
+ \begingroup\expandafter\expandafter\expandafter\endgroup
+ \expandafter\ifx\csname ver@#1.sty\endcsname\relax
+ \input #1.sty\relax
+ \fi
+ }%
+ \TMP@RequirePackage{ltxcmds}[2010/03/01]%
+ \let\@ifundefined\ltx@IfUndefined
+ \let\@ifnextchar\ltx@ifnextchar
+ \long\def\@firstoftwo#1#2{#1}
+ \long\def\@secondoftwo#1#2{#2}
+\else
+\fi
+% \end{macrocode}
+%
+%
+% \subsection{Provide key defining macro}
+%
+% \begin{macro}{\kv@define@key}
+% \begin{macrocode}
+\@ifundefined{protected}{%
+ \@ifundefined{DeclareRobustCommand}{%
+ \def\kv@define@key#1#2%
+ }{%
+ \DeclareRobustCommand*{\kv@define@key}[2]%
+ }%
+}{%
+ \protected\def\kv@define@key#1#2%
+}%
+{%
+ \begingroup
+ \csname @safe@activestrue\endcsname
+ \let\ifincsname\iftrue
+ \edef\KVD@temp{\endgroup
+ \noexpand\KVD@DefineKey{#1}{#2}%
+ }%
+ \KVD@temp
+}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\KVD@DefineKey}
+% \begin{macrocode}
+\def\KVD@DefineKey#1#2{%
+ \@ifnextchar[\@firstoftwo\@secondoftwo{%
+ \KVD@DefineKeyWithDefault{#1}{#2}%
+ }{%
+ \long\expandafter\def\csname KV@#1@#2\endcsname##1%
+ }%
+}
+% \end{macrocode}
+% \end{macro}
+% \begin{macro}{\KVD@DefineKeyWithDefault}
+% \begin{macrocode}
+\long\def\KVD@DefineKeyWithDefault#1#2[#3]{%
+ \expandafter\def\csname KV@#1@#2@default\expandafter\endcsname
+ \expandafter{%
+ \csname KV@#1@#2\endcsname{#3}%
+ }%
+ \long\expandafter\def\csname KV@#1@#2\endcsname##1%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macrocode}
+\KVD@AtEnd%
+%</package>
+% \end{macrocode}
+% \section{Installation}
+%
+% \subsection{Download}
+%
+% \paragraph{Package.} This package is available on
+% CTAN\footnote{\CTANpkg{kvdefinekeys}}:
+% \begin{description}
+% \item[\CTAN{macros/latex/contrib/kvdefinekeys/kvdefinekeys.dtx}] The source file.
+% \item[\CTAN{macros/latex/contrib/kvdefinekeys/kvdefinekeys.pdf}] Documentation.
+% \end{description}
+%
+%
+% \paragraph{Bundle.} All the packages of the bundle `kvdefinekeys'
+% are also available in a TDS compliant ZIP archive. There
+% the packages are already unpacked and the documentation files
+% are generated. The files and directories obey the TDS standard.
+% \begin{description}
+% \item[\CTANinstall{install/macros/latex/contrib/kvdefinekeys.tds.zip}]
+% \end{description}
+% \emph{TDS} refers to the standard ``A Directory Structure
+% for \TeX\ Files'' (\CTANpkg{tds}). Directories
+% with \xfile{texmf} in their name are usually organized this way.
+%
+% \subsection{Bundle installation}
+%
+% \paragraph{Unpacking.} Unpack the \xfile{kvdefinekeys.tds.zip} in the
+% TDS tree (also known as \xfile{texmf} tree) of your choice.
+% Example (linux):
+% \begin{quote}
+% |unzip kvdefinekeys.tds.zip -d ~/texmf|
+% \end{quote}
+%
+% \subsection{Package installation}
+%
+% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
+% \docstrip\ archive. The files are extracted by running the
+% \xfile{.dtx} through \plainTeX:
+% \begin{quote}
+% \verb|tex kvdefinekeys.dtx|
+% \end{quote}
+%
+% \paragraph{TDS.} Now the different files must be moved into
+% the different directories in your installation TDS tree
+% (also known as \xfile{texmf} tree):
+% \begin{quote}
+% \def\t{^^A
+% \begin{tabular}{@{}>{\ttfamily}l@{ $\rightarrow$ }>{\ttfamily}l@{}}
+% kvdefinekeys.sty & tex/generic/kvdefinekeys/kvdefinekeys.sty\\
+% kvdefinekeys.pdf & doc/latex/kvdefinekeys/kvdefinekeys.pdf\\
+% kvdefinekeys.dtx & source/latex/kvdefinekeys/kvdefinekeys.dtx\\
+% \end{tabular}^^A
+% }^^A
+% \sbox0{\t}^^A
+% \ifdim\wd0>\linewidth
+% \begingroup
+% \advance\linewidth by\leftmargin
+% \advance\linewidth by\rightmargin
+% \edef\x{\endgroup
+% \def\noexpand\lw{\the\linewidth}^^A
+% }\x
+% \def\lwbox{^^A
+% \leavevmode
+% \hbox to \linewidth{^^A
+% \kern-\leftmargin\relax
+% \hss
+% \usebox0
+% \hss
+% \kern-\rightmargin\relax
+% }^^A
+% }^^A
+% \ifdim\wd0>\lw
+% \sbox0{\small\t}^^A
+% \ifdim\wd0>\linewidth
+% \ifdim\wd0>\lw
+% \sbox0{\footnotesize\t}^^A
+% \ifdim\wd0>\linewidth
+% \ifdim\wd0>\lw
+% \sbox0{\scriptsize\t}^^A
+% \ifdim\wd0>\linewidth
+% \ifdim\wd0>\lw
+% \sbox0{\tiny\t}^^A
+% \ifdim\wd0>\linewidth
+% \lwbox
+% \else
+% \usebox0
+% \fi
+% \else
+% \lwbox
+% \fi
+% \else
+% \usebox0
+% \fi
+% \else
+% \lwbox
+% \fi
+% \else
+% \usebox0
+% \fi
+% \else
+% \lwbox
+% \fi
+% \else
+% \usebox0
+% \fi
+% \else
+% \lwbox
+% \fi
+% \else
+% \usebox0
+% \fi
+% \end{quote}
+% If you have a \xfile{docstrip.cfg} that configures and enables \docstrip's
+% TDS installing feature, then some files can already be in the right
+% place, see the documentation of \docstrip.
+%
+% \subsection{Refresh file name databases}
+%
+% If your \TeX~distribution
+% (\TeX\,Live, \mikTeX, \dots) relies on file name databases, you must refresh
+% these. For example, \TeX\,Live\ users run \verb|texhash| or
+% \verb|mktexlsr|.
+%
+% \subsection{Some details for the interested}
+%
+% \paragraph{Unpacking with \LaTeX.}
+% The \xfile{.dtx} chooses its action depending on the format:
+% \begin{description}
+% \item[\plainTeX:] Run \docstrip\ and extract the files.
+% \item[\LaTeX:] Generate the documentation.
+% \end{description}
+% If you insist on using \LaTeX\ for \docstrip\ (really,
+% \docstrip\ does not need \LaTeX), then inform the autodetect routine
+% about your intention:
+% \begin{quote}
+% \verb|latex \let\install=y\input{kvdefinekeys.dtx}|
+% \end{quote}
+% Do not forget to quote the argument according to the demands
+% of your shell.
+%
+% \paragraph{Generating the documentation.}
+% You can use both the \xfile{.dtx} or the \xfile{.drv} to generate
+% the documentation. The process can be configured by the
+% configuration file \xfile{ltxdoc.cfg}. For instance, put this
+% line into this file, if you want to have A4 as paper format:
+% \begin{quote}
+% \verb|\PassOptionsToClass{a4paper}{article}|
+% \end{quote}
+% An example follows how to generate the
+% documentation with pdf\LaTeX:
+% \begin{quote}
+%\begin{verbatim}
+%pdflatex kvdefinekeys.dtx
+%makeindex -s gind.ist kvdefinekeys.idx
+%pdflatex kvdefinekeys.dtx
+%makeindex -s gind.ist kvdefinekeys.idx
+%pdflatex kvdefinekeys.dtx
+%\end{verbatim}
+% \end{quote}
+%
+% \begin{thebibliography}{9}
+% \bibitem{keyval}
+% David Carlisle:
+% \textit{The \xpackage{keyval} package};
+% 1999/03/16 v1.13;
+% \CTAN{macros/latex/required/graphics/keyval.dtx}.
+%
+% \end{thebibliography}
+%
+% \begin{History}
+% \begin{Version}{2010/03/01 v1.0}
+% \item
+% First version.
+% \end{Version}
+% \begin{Version}{2010/08/19 v1.1}
+% \item
+% Documentation fix, no code change.
+% \end{Version}
+% \begin{Version}{2011/01/30 v1.2}
+% \item
+% Already loaded package files are not input in \hologo{plainTeX}.
+% \end{Version}
+% \begin{Version}{2011/04/07 v1.3}
+% \item
+% Support for package \xpackage{babel}'s shorthands added.
+% \item
+% \cs{kv@define@key} is made robust if available.
+% \end{Version}
+% \begin{Version}{2016/05/16 v1.4}
+% \item
+% Documentation updates.
+% \end{Version}
+% \begin{Version}{2019/12/15 v1.5}
+% \item
+% Documentation updates.
+% \end{Version}
+% \end{History}
+%
+% \PrintIndex
+%
+% \Finale
+\endinput