% \iffalse meta-comment % % Copyright (C) 2006 by Heiko Oberdiek % % This work may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either % version 1.3 of this license or (at your option) any later % version. The latest version of this license is in % http://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". % % This Current Maintainer of this work is Heiko Oberdiek. % % This work consists of the main source file kvsetkeys.dtx % and the derived files % kvsetkeys.sty, kvsetkeys.pdf, kvsetkeys.ins, kvsetkeys.drv, % kvsetkeys-example.tex. % % Distribution: % CTAN:macros/latex/contrib/oberdiek/kvsetkeys.dtx % CTAN:macros/latex/contrib/oberdiek/kvsetkeys.pdf % % Unpacking: % (a) If kvsetkeys.ins is present: % tex kvsetkeys.ins % (b) Without kvsetkeys.ins: % tex kvsetkeys.dtx % (c) If you insist on using LaTeX % latex \let\install=y\input{kvsetkeys.dtx} % (quote the arguments according to the demands of your shell) % % Documentation: % (a) If kvsetkeys.drv is present: % latex kvsetkeys.drv % (b) Without kvsetkeys.drv: % latex kvsetkeys.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 kvsetkeys.dtx % makeindex -s gind.ist kvsetkeys.idx % pdflatex kvsetkeys.dtx % makeindex -s gind.ist kvsetkeys.idx % pdflatex kvsetkeys.dtx % % Installation: % TDS:tex/generic/oberdiek/kvsetkeys.sty % TDS:doc/latex/oberdiek/kvsetkeys.pdf % TDS:doc/latex/oberdiek/kvsetkeys-example.tex % TDS:source/latex/oberdiek/kvsetkeys.dtx % %<*ignore> \begingroup \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 % %<*install> \input docstrip.tex \Msg{************************************************************************} \Msg{* Installation} \Msg{* Package: kvsetkeys 2006/10/19 v1.1 Key value parser with default handler support (HO)} \Msg{************************************************************************} \keepsilent \askforoverwritefalse \preamble This is a generated file. Copyright (C) 2006 by Heiko Oberdiek This work may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 of this license or (at your option) any later version. The latest version of this license is in http://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". This Current Maintainer of this work is Heiko Oberdiek. This work consists of the main source file kvsetkeys.dtx and the derived files kvsetkeys.sty, kvsetkeys.pdf, kvsetkeys.ins, kvsetkeys.drv, kvsetkeys-example.tex. \endpreamble \generate{% \file{kvsetkeys.ins}{\from{kvsetkeys.dtx}{install}}% \file{kvsetkeys.drv}{\from{kvsetkeys.dtx}{driver}}% \usedir{tex/generic/oberdiek}% \file{kvsetkeys.sty}{\from{kvsetkeys.dtx}{package}}% \usedir{doc/latex/oberdiek}% \file{kvsetkeys-example.tex}{\from{kvsetkeys.dtx}{example}}% } \obeyspaces \Msg{************************************************************************} \Msg{*} \Msg{* To finish the installation you have to move the following} \Msg{* file into a directory searched by TeX:} \Msg{*} \Msg{* kvsetkeys.sty} \Msg{*} \Msg{* To produce the documentation run the file `kvsetkeys.drv'} \Msg{* through LaTeX.} \Msg{*} \Msg{* Happy TeXing!} \Msg{*} \Msg{************************************************************************} \endbatchfile % %<*ignore> \fi % %<*driver> \NeedsTeXFormat{LaTeX2e} \ProvidesFile{kvsetkeys.drv}% [2006/10/19 v1.1 Key value parser with default handler support (HO)]% \documentclass{ltxdoc} \usepackage{holtxdoc} \begin{document} \DocInput{kvsetkeys.dtx}% \end{document} % % \fi % % \CheckSum{598} % % \CharacterTable % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z % Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z % Digits \0\1\2\3\4\5\6\7\8\9 % Exclamation \! Double quote \" Hash (number) \# % Dollar \$ Percent \% Ampersand \& % Acute accent \' Left paren \( Right paren \) % Asterisk \* Plus \+ Comma \, % Minus \- Point \. Solidus \/ % Colon \: Semicolon \; Less than \< % Equals \= Greater than \> Question mark \? % Commercial at \@ Left bracket \[ Backslash \\ % Right bracket \] Circumflex \^ Underscore \_ % Grave accent \` Left brace \{ Vertical bar \| % Right brace \} Tilde \~} % % \GetFileInfo{kvsetkeys.drv} % % \title{The \xpackage{kvsetkeys} package} % \date{2006/10/19 v1.1} % \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}} % % \maketitle % % \begin{abstract} % Package \xpackage{kvsetkeys} provides \cs{kvsetkeys}, a variant % of package \xpackage{keyval}'s \cs{setkeys}. It allows to specify % a handler that deals with unknown options. Active commas and equal % signs may be used (e.g. see \xpackage{babel}'s shorthands) and % only one level of curly braces is removed from the values. % \end{abstract} % % \tableofcontents % % \def\M#1{\texttt{\{}\meta{#1}\texttt{\}}} % % \section{Documentation} % % \cs{kvsetkeys} can be used as replacement for \xpackage{keyval}'s % \cs{setkeys}. Also it uses the same syntax. Before I describe % \cs{kvsetkeys} in more detail, first I want to explain, how % this package deals with key value lists. For the package also % provides low level interfaces that can be used by package authors. % % \subsection{Normalizing key value lists} % % \begin{declcs}{kv@normalize}\,\M{key value list} % \end{declcs} % Specifying key value lists, the user usually wants to have % nice formatted souce code, e.g.: % \begin{quote} %\begin{verbatim} %\hypersetup{ % pdftitle = {...}, % pdfsubject = {...}, % pdfauthor = {...}, % pdfkeywords = {...}, % ... %} %\end{verbatim} % \end{quote} % Thus there can be spaces around keys, around |=| or around the value. % Also empty entries are possible by too many commas. Therefore these % spaces and empty entries are silently removed by package \xpackage{keyval} % and this package. Whereas the contents of the value can be protected % by curly braces, especially if spaces or commas are used inside, % a key name must not use spaces or other syntax characters. % % \cs{kv@normalize} takes a key value list and performs the cleanup: % \begin{itemize} % \item Spaces are removed. % \item Syntax characters (comma and equal sign) that are active % are replaces by the same characters with standard catcode. % (Example: \xpackage{babel}'s language option \xoption{turkish} % uses the equal sign as active shorthand character.) % \end{itemize} % The result is stored in \cs{kv@list}, e.g.: % \begin{quote} % |\kv@list| $\rightarrow$ |,pdftitle={},pdfsubject={},...,| % \end{quote} % Empty entries are removed later. In fact it adds a comma at the begin % and end to protect the last value and an easier implementation. % % \subsection{Parsing key value lists} % % \begin{declcs}{kv@parse}\,\M{key value list}\,\M{processor} % \end{declcs} % It is easier to parse a normalized list, thus \cs{kv@parse} % normalizes the list and calls \cs{kv@parse@normalized}. % % \begin{declcs}{kv@parse@normalized}\,\M{key value list}% % \,\M{processor} % \end{declcs} % Now the key value list is split into single key value pairs. % For further processing the key and value are given as arguments % for the \meta{processor}: % \begin{quote} % \meta{processor}\,\M{key}\,\M{value} % \end{quote} % Also key and value are stored in macro names: % \begin{itemize} % \item \cs{kv@key} stores the key. % \item \cs{kv@value} stores the value or if the value was not % specified it has the meaning \cs{relax}. % \end{itemize} % The behaviour in pseudo code: % \begin{quote} % foreach (\meta{key}, \meta{value}) in (\meta{key value list})\\ % \hspace*{1.5em}\cs{kv@key} := \meta{key}\\ % \hspace*{1.5em}\cs{kv@value} := \meta{value}\\ % \hspace*{1.5em}\meta{processor}\,\M{key}\,\M{value} % \end{quote} % % \subsection{Processing key value pairs} % % \begin{declcs}{kv@processor@default}\,\M{family}\,\M{key}\,\M{value} % \end{declcs} % There are many possiblities to process key value pairs. % \cs{kv@processor@default} is the processor used in \cs{kvsetkeys}. % It reimplements and extends the behaviour of % \xpackage{keyval}'s \cs{setkeys}. % In case of unknown keys \cs{setkeys} raise an error. % This processer, however, calls a handler instead, if it % is provided by the family. % % The behaviour in pseudo code: % \begin{quote} % if \meta{key} exists\\ % \hspace*{1.5em}call the keyval code of \meta{key}\\ % else\\ % \hspace*{1.5em}if \meta{handler} for \meta{family} exists\\ % \hspace*{3em}\meta{handler}\,\M{key}\,\M{value}\\ % \hspace*{1.5em}else\\ % \hspace*{3em}raise unknown key error\\ % \hspace*{1.5em}fi\\ % fi % \end{quote} % % \subsection{Default family handler} % % \cs{kv@processor@default} calls \meta{handler}, the default % handler for the family, if the key does not exist in the family. % The handler is called with two arguments, the key and the value. % It can be defined with \cs{kv@set@family@hander}: % % \begin{declcs}{kv@set@family@handler}\,\M{family}\,\M{handler definition} % \end{declcs} % This sets the default family handler for the keyval family % \meta{family}. Inside \meta{handler definition} |#1| stands for % the key and |#2| is the value. Also \cs{kv@key} and \cs{kv@value} % can be used for the key and the value. If the value is not given, % \cs{kv@value} has the meaning \cs{relax}. % % \subsection{Do it all} % % \begin{declcs}{kvsetkeys}\,\M{family}\,\M{key value list} % \end{declcs} % The work is done by the previous commands. \cs{kvsetkeys} % just calls them: % \begin{quote} % \cs{kv@parse}\,\M{key value list}^^A % \texttt{\{}\cs{kv@processor@default}\,\M{family}\texttt{\}} % \end{quote} % % Thus you can replace \cs{setkeys} of package \xpackage{keyval} % by the key value parser of this package: % \begin{quote} % |\renewcommand*{\setkeys}{\kvsetkeys}|\\ % or\\ % |\let\setkeys\kvsetkeys| % \end{quote} % % \section{Example} % % The following example prints a short piece of HTML code using % the tabbing environment for indenting purpose and a key value % syntax for specifying the attributes of an HTML tag. % The example illustrates the use of a default family handler. % \begin{macrocode} %<*example> \documentclass{article} \usepackage[T1]{fontenc} \usepackage{kvsetkeys} \usepackage{keyval} \makeatletter \newcommand*{\tag}[2][]{% % #1: attributes % #2: tag name \begingroup \toks@={}% \let\@endslash\@empty \kvsetkeys{tag}{#1}% \texttt{% \textless #2\the\toks@\@endslash\textgreater }% \endgroup } \kv@set@family@handler{tag}{% % #1: key % #2: value \toks@\expandafter{% \the\toks@ \space #1=\string"#2\string"% }% } \define@key{tag}{/}[]{% \def\@endslash{/}% } \makeatother \begin{document} \begin{tabbing} \mbox{}\qquad\=\qquad\=\kill \tag{html}\\ \>\dots\\ \>\tag[border=1]{table}\\ \>\>\tag[width=200, span=3, /]{colgroup}\\ \>\>\dots\\ \>\tag{/table}\\ \>\dots\\ \tag{/html}\\ \end{tabbing} \end{document} % % \end{macrocode} % % \StopEventually{ % } % % \section{Implementation} % % \subsection{Identification} % % \begin{macrocode} %<*package> % \end{macrocode} % Reload check, especially if the package is not used with \LaTeX. % \begin{macrocode} \begingroup \catcode44 12 % , \catcode45 12 % - \catcode46 12 % . \catcode58 12 % : \catcode64 11 % @ \expandafter\let\expandafter\x\csname ver@kvsetkeys.sty\endcsname \ifcase 0% \ifx\x\relax % plain \else \ifx\x\empty % LaTeX \else 1% \fi \fi \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{kvsetkeys}{The package is already loaded}% \endgroup \expandafter\endinput \fi \endgroup % \end{macrocode} % Package identification: % \begin{macrocode} \begingroup \catcode40 12 % ( \catcode41 12 % ) \catcode44 12 % , \catcode45 12 % - \catcode46 12 % . \catcode47 12 % / \catcode58 12 % : \catcode64 11 % @ \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\relax \xdef#1{#3}% \fi }% \fi \expandafter\x\csname ver@kvsetkeys.sty\endcsname \ProvidesPackage{kvsetkeys}% [2006/10/19 v1.1 Key value parser with default handler support (HO)] % \end{macrocode} % % \begin{macrocode} \expandafter\edef\csname KVS@endinput\endcsname{% \catcode39 \the\catcode39 % ' \catcode44 \the\catcode44 % , \catcode61 \the\catcode61 % = \catcode64 \the\catcode64 % @ \catcode94 \the\catcode94 % ^ \catcode96 \the\catcode96 % ` \catcode126 \the\catcode126 % ~ \relax \noexpand\endinput } \catcode39 12 % ' \catcode44 12 % , \catcode61 12 % = \catcode64 11 % @ \catcode94 7 % ^ \catcode96 12 % ` \catcode126 13 % ~ % \end{macrocode} % % \begin{macrocode} \def\KVS@empty{} \long\def\@ReturnAfterFi#1\fi{\fi#1} % \end{macrocode} % % \subsection{Normalizing key value lists} % % \begin{macro}{\kv@normalize} % \begin{macrocode} \def\kv@normalize#1{% \begingroup \toks@{,#1}% \KVS@comma \KVS@equal \KVS@spaceA \KVS@spaceB{ }% \KVS@spaceC \KVS@spaceD{ }% \xdef\kv@global{\the\toks@}% \endgroup \let\kv@list\kv@global } % \end{macrocode} % \end{macro} % \begin{macro}{\KVS@comma} % Converts active commas into comma with catcode other. % Also adds a comma at the end to protect the last value % for next cleanup steps. % \begin{macrocode} \begingroup \lccode`\,=`\,% \lccode`\~=`\,% \lowercase{\endgroup \def\KVS@comma{% \toks@\expandafter{\expandafter}\expandafter \KVS@@comma\the\toks@~\KVS@nil }% \def\KVS@@comma#1~#2\KVS@nil{% \toks@\expandafter{\the\toks@#1,}% \toks2{#2}% \edef\x{\the\toks2}% \ifx\x\KVS@empty \else \@ReturnAfterFi{% \KVS@@comma#2\KVS@nil }% \fi }% } % \end{macrocode} % \end{macro} % \begin{macro}{\KVS@equal} % Converts active equal signs into catcode other characters. % \begin{macrocode} \begingroup \lccode`\==`\=% \lccode`\~=`\=% \lowercase{\endgroup \def\KVS@equal{% \toks@\expandafter{\expandafter}\expandafter \KVS@@equal\the\toks@~\KVS@nil }% \def\KVS@@equal#1~#2\KVS@nil{% \edef\x{\the\toks@}% \ifx\x\KVS@empty \toks@{#1}% \else \toks@\expandafter{\the\toks@=#1}% \fi \toks2{#2}% \edef\x{\the\toks2}% \ifx\x\KVS@empty \else \@ReturnAfterFi{% \KVS@@equal#2\KVS@nil }% \fi }% } % \end{macrocode} % \end{macro} % \begin{macro}{\KVS@spaceA} % Removes one space after the equal sign. In theory also several % spaces could be removed, but this is not really necessary, % because \TeX\ usually collapses several spaces to one already. % \begin{macrocode} \def\KVS@spaceA{% \toks@\expandafter{\expandafter}\expandafter \KVS@@spaceA\the\toks@= \KVS@nil } \def\KVS@@spaceA#1= #2\KVS@nil{% \edef\x{\the\toks@}% \ifx\x\KVS@empty \toks@{#1}% \else \toks@\expandafter{\the\toks@=#1}% \fi \toks2{#2}% \edef\x{\the\toks2}% \ifx\x\KVS@empty \else \@ReturnAfterFi{% \KVS@@spaceA#2\KVS@nil }% \fi } % \end{macrocode} % \end{macro} % \begin{macro}{\KVS@spaceB} % Removes one space before the comma. % \begin{macrocode} \def\KVS@spaceB#1{% \toks@\expandafter{\expandafter}\expandafter \KVS@@spaceB\the\toks@#1,\KVS@nil } \def\KVS@@spaceB#1 ,#2\KVS@nil{% \edef\x{\the\toks@}% \ifx\x\KVS@empty \toks@{#1}% \else \toks@\expandafter{\the\toks@,#1}% \fi \toks2{#2}% \edef\x{\the\toks2}% \ifx\x\KVS@empty \else \@ReturnAfterFi{% \KVS@@spaceB#2\KVS@nil }% \fi } % \end{macrocode} % \end{macro} % % \begin{macro}{\KVS@spaceC} % Removes one space after the comma. % \begin{macrocode} \def\KVS@spaceC{% \toks@\expandafter{\expandafter}\expandafter \KVS@@spaceC\the\toks@, \KVS@nil } \def\KVS@@spaceC#1, #2\KVS@nil{% \edef\x{\the\toks@}% \ifx\x\KVS@empty \toks@{#1}% \else \toks@\expandafter{\the\toks@,#1}% \fi \toks2{#2}% \edef\x{\the\toks2}% \ifx\x\KVS@empty \else \@ReturnAfterFi{% \KVS@@spaceC#2\KVS@nil }% \fi } % \end{macrocode} % \end{macro} % \begin{macro}{\KVS@spaceD} % Removes one space before the equal sign. % \begin{macrocode} \def\KVS@spaceD#1{% \toks@\expandafter{\expandafter}\expandafter \KVS@@spaceD\the\toks@#1=\KVS@nil } \def\KVS@@spaceD#1 =#2\KVS@nil{% \edef\x{\the\toks@}% \ifx\x\KVS@empty \toks@{#1}% \else \toks@\expandafter{\the\toks@=#1}% \fi \toks2{#2}% \edef\x{\the\toks2}% \ifx\x\KVS@empty \else \@ReturnAfterFi{% \KVS@@spaceD#2\KVS@nil }% \fi } % \end{macrocode} % \end{macro} % % \subsection{Parsing key value lists} % % \begin{macro}{\kv@parse} % Normalizes and parses the key value list. Also sets \cs{kv@list}. % \begin{macrocode} \def\kv@parse#1{% \kv@normalize{#1}% \expandafter\kv@parse@normalized\expandafter{\kv@list}% } % \end{macrocode} % \end{macro} % \begin{macro}{\kv@parse@normalized} % \begin{macrocode} \def\kv@parse@normalized#1#2{% \KVS@parse#1,\KVS@nil{#2}% } % \end{macrocode} % \end{macro} % \begin{macrocode} \def\KVS@parse#1,#2\KVS@nil#3{% \begingroup \toks@{#1}% \edef\x{\the\toks@}% \expandafter\endgroup \ifx\x\KVS@empty \else \KVS@process#1=\KVS@nil{#3}% \fi \begingroup \toks@{#2}% \edef\x{\the\toks@}% \expandafter\endgroup \ifx\x\KVS@empty \else \@ReturnAfterFi{% \KVS@parse#2\KVS@nil{#3}% }% \fi } % \end{macrocode} % \begin{macrocode} \def\KVS@process#1=#2\KVS@nil#3{% \def\kv@key{#1}% \begingroup \toks@{#2}% \edef\x{\the\toks@}% \expandafter\endgroup \ifx\x\KVS@empty \let\kv@value\relax #3{#1}{}% \else \KVS@@process{#1}#2\KVS@nil{#3}% \fi } \def\KVS@@process#1#2=\KVS@nil#3{% \begingroup \toks@{#2}% \xdef\KVS@global{\the\toks@}% \endgroup \let\kv@value\KVS@global #3{#1}{#2}% } % \end{macrocode} % % \subsection{Processing key value pairs} % % \begin{macro}{\kv@processor@default} % \begin{macrocode} \def\kv@processor@default#1#2#3{% \begingroup\expandafter\expandafter\expandafter\endgroup \expandafter\ifx\csname KV@#1@#2\endcsname\relax \begingroup\expandafter\expandafter\expandafter\endgroup \expandafter\ifx\csname KVS@#1@handler\endcsname\relax \kv@error@unknownkey{#1}{#2}% \else \csname KVS@#1@handler\endcsname{#2}{#3}% \relax \fi \else \ifx\kv@value\relax \begingroup\expandafter\expandafter\expandafter\endgroup \expandafter\ifx\csname KV@#1@#2@default\endcsname\relax \kv@error@novalue{#1}{#2}% \else \csname KV@#1@#2@default\endcsname \relax \fi \else \csname KV@#1@#2\endcsname{#3}% \fi \fi } % \end{macrocode} % \end{macro} % % \begin{macro}{\kv@set@family@handler} % \begin{macrocode} \def\kv@set@family@handler#1{% \KVS@set@family@handler{#1}\@nil } \def\KVS@set@family@handler#1\@nil#{% \expandafter\def\csname KVS@#1@handler\endcsname##1##2% } % \end{macrocode} % \end{macro} % % \subsection{Error handling} % % \begin{macro}{\kv@error@novalue} % Only a poor \cs{PackageError} is provided by \xfile{miniltx.tex}. % \begin{macrocode} \expandafter\ifx\csname MessageBreak\endcsname\relax \def\MessageBreak{^^J}% \fi \expandafter\ifx\csname @ehc\endcsname\relax \def\@ehc{% Try typing \space\string % \space to proceed.\MessageBreak If that doesn't work, type \space X % \string \space to quit\string.% }% \fi \def\kv@error@novalue{% \kv@error@generic{No value specified for}% } \def\kv@error@unknownkey{% \kv@error@generic{Undefined}% } \def\kv@error@generic#1#2#3{% \begingroup \newlinechar=10 % \def\MessageBreak{^^J}% \expandafter\ifx\csname PackageError\endcsname\relax \edef\x{% \errhelp{% The keyval family of the key `#3' is `#2'.\MessageBreak \MessageBreak \@ehc }% }% \x \errmessage{kvsetkeys: #1 key `#3'}% \else \edef\x{% \noexpand\PackageError{kvsetkeys}{% #1 key `#3'% }{% The keyval family of the key `#3' is `#2'.\MessageBreak \MessageBreak \@ehc }% }% \x \fi \endgroup }% % \end{macrocode} % \end{macro} % % \subsection{Do it all} % % \begin{macro}{\kvsetkeys} % \begin{macrocode} \def\kvsetkeys#1#2{% \kv@parse{#2}{\kv@processor@default{#1}}% } % \end{macrocode} % \end{macro} % % \begin{macrocode} \KVS@endinput % % \end{macrocode} % \section{Installation} % % \subsection{Download} % % \paragraph{Package.} This package is available on % CTAN\footnote{\url{ftp://ftp.ctan.org/tex-archive/}}: % \begin{description} % \item[\CTAN{macros/latex/contrib/oberdiek/kvsetkeys.dtx}] The source file. % \item[\CTAN{macros/latex/contrib/oberdiek/kvsetkeys.pdf}] Documentation. % \end{description} % % % \paragraph{Bundle.} All the packages of the bundle `oberdiek' % 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[\CTAN{macros/latex/contrib/oberdiek/oberdiek-tds.zip}] % \end{description} % \emph{TDS} refers to the standard ``A Directory Structure % for \TeX\ Files'' (\CTAN{tds/tds.pdf}). Directories % with \xfile{texmf} in their name are usually organized this way. % % \subsection{Bundle installation} % % \paragraph{Unpacking.} Unpack the \xfile{oberdiek-tds.zip} in the % TDS tree (also known as \xfile{texmf} tree) of your choice. % Example (linux): % \begin{quote} % |unzip oberdiek-tds.zip -d ~/texmf| % \end{quote} % % \paragraph{Script installation.} % Check the directory \xfile{TDS:scripts/oberdiek/} for % scripts that need further installation steps. % Package \xpackage{attachfile2} comes with the Perl script % \xfile{pdfatfi.pl} that should be installed in such a way % that it can be called as \texttt{pdfatfi}. % Example (linux): % \begin{quote} % |chmod +x scripts/oberdiek/pdfatfi.pl|\\ % |cp scripts/oberdiek/pdfatfi.pl /usr/local/bin/| % \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 kvsetkeys.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@{}} % kvsetkeys.sty & tex/generic/oberdiek/kvsetkeys.sty\\ % kvsetkeys.pdf & doc/latex/oberdiek/kvsetkeys.pdf\\ % kvsetkeys-example.tex & doc/latex/oberdiek/kvsetkeys-example.tex\\ % kvsetkeys.dtx & source/latex/oberdiek/kvsetkeys.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 % (\teTeX, \mikTeX, \dots) relies on file name databases, you must refresh % these. For example, \teTeX\ users run \verb|texhash| or % \verb|mktexlsr|. % % \subsection{Some details for the interested} % % \paragraph{Attached source.} % % The PDF documentation on CTAN also includes the % \xfile{.dtx} source file. It can be extracted by % AcrobatReader 6 or higher. Another option is \textsf{pdftk}, % e.g. unpack the file into the current directory: % \begin{quote} % \verb|pdftk kvsetkeys.pdf unpack_files output .| % \end{quote} % % \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{kvsetkeys.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 kvsetkeys.dtx %makeindex -s gind.ist kvsetkeys.idx %pdflatex kvsetkeys.dtx %makeindex -s gind.ist kvsetkeys.idx %pdflatex kvsetkeys.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}{2006/03/06 v1.0} % \item % First version. % \end{Version} % \begin{Version}{2006/10/19 v1.1} % \item % Fix of \cs{kv@set@family@handler}. % \item % Example added. % \end{Version} % \end{History} % % \PrintIndex % % \Finale \endinput