summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/keyreader
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-01-16 00:24:41 +0000
committerKarl Berry <karl@freefriends.org>2010-01-16 00:24:41 +0000
commit7dfb5fe2031be6fd3d904936cda1e43b9670731a (patch)
treec472f7f52ff3c17844c8b193f9ab045b571af244 /Master/texmf-dist/doc/latex/keyreader
parent481aaeaf01d66cd4e10e55ba8ac30885dbc0330d (diff)
keyreader update (15jan10)
git-svn-id: svn://tug.org/texlive/trunk@16733 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/keyreader')
-rw-r--r--Master/texmf-dist/doc/latex/keyreader/README12
-rw-r--r--Master/texmf-dist/doc/latex/keyreader/keyreader-guide.pdf (renamed from Master/texmf-dist/doc/latex/keyreader/keyreader-guide-0dot2.pdf)bin116557 -> 116648 bytes
-rw-r--r--Master/texmf-dist/doc/latex/keyreader/keyreader-guide.tex (renamed from Master/texmf-dist/doc/latex/keyreader/keyreader-guide-0dot2.tex)23
3 files changed, 13 insertions, 22 deletions
diff --git a/Master/texmf-dist/doc/latex/keyreader/README b/Master/texmf-dist/doc/latex/keyreader/README
index f8b3c25df38..4431b02d8c3 100644
--- a/Master/texmf-dist/doc/latex/keyreader/README
+++ b/Master/texmf-dist/doc/latex/keyreader/README
@@ -18,15 +18,15 @@
% %
%+++++++++++++++++++++++++++++++++++++ LICENSE ++++++++++++++++++++++++++++++++++++++%
% %
-% This is file 'keyreader.sty', version 0.2. %
+% This is file 'keyreader.sty', version 0.1. %
% %
% This package reads multiple keys to be defined by xkeyval.sty. %
% %
-% 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 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 package and accompanying files may be distributed and/or modified under %
+% the conditions of the LaTeX Project Public License, either version 1.3 of %
+% this license or 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. %
% %
% The LPPL maintenance status of this software is 'author-maintained'. %
% %
diff --git a/Master/texmf-dist/doc/latex/keyreader/keyreader-guide-0dot2.pdf b/Master/texmf-dist/doc/latex/keyreader/keyreader-guide.pdf
index d85c1c17a05..f7d1027006a 100644
--- a/Master/texmf-dist/doc/latex/keyreader/keyreader-guide-0dot2.pdf
+++ b/Master/texmf-dist/doc/latex/keyreader/keyreader-guide.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/keyreader/keyreader-guide-0dot2.tex b/Master/texmf-dist/doc/latex/keyreader/keyreader-guide.tex
index 2ac2ad0cc4f..5b1cd3b34d6 100644
--- a/Master/texmf-dist/doc/latex/keyreader/keyreader-guide-0dot2.tex
+++ b/Master/texmf-dist/doc/latex/keyreader/keyreader-guide.tex
@@ -22,9 +22,9 @@
implicit=true,breaklinks=true,pagebackref=true,backref=true,
bookmarks=true,bookmarksnumbered=true,hyperfootnotes=true,debug=true,
naturalnames=false,citecolor=purple,pdfview=FitH,pdfstartview=FitH}
-\def\krvlabel{\textcolor{green}{\fboxrule1pt\fcolorbox{red}{gray!45}{\hspace{1cm}}}}
+\def\krverblabel{\textcolor{green}{\fboxrule1pt\fcolorbox{red}{gray!45}{\hspace{1cm}}}}
\CustomVerbatimEnvironment{krverbatim}{Verbatim}{numbers=left,
- label={\krvlabel},labelposition=topline,numberblanklines=false, firstnumber=last,frame=single,rulecolor=\color{xmagenta1},framerule=1pt,
+ label={\krverblabel},labelposition=topline,numberblanklines=false, firstnumber=last,frame=single,rulecolor=\color{xmagenta1},framerule=1pt,
framesep=7pt,formatcom=\color{blue},xrightmargin=0pc,commandchars=\|\(\),
commentchar=&}
@@ -40,23 +40,14 @@
\begin{multicols}{2}
\small\tableofcontents\normalsize
\end{multicols}
-\vspace*{-.5cm}
+\removelastskip
\leavevmode\textcolor{blue}{\rule[0ex]{\hsize}{2pt}}
\section{Motivation}
-The elaborate and powerful \krsty{xkeyval} package provides
-\krcmd{define@cmdkeys} and \krcmd{define@boolkeys} for defining and setting multiple command keys and boolean keys, but in each category those keys must have the same default value
-and no key macro/function. This package seeks to remove these restrictions,
-so that multiple keys of all categories (ordinary keys, command keys, boolean
-keys, and choice keys) can be set at one go and those keys can have different
-default values and functions. This greatly minimizes tokens, as hundreds of keys
-can, in principle, be issued simultaneously by one command.
+The elaborate and powerful \krsty{xkeyval} package provides \krcmd{define@cmdkeys} and \krcmd{define@boolkeys} for defining and setting multiple command keys and boolean keys, but in each category those keys must have the same default value and no key macro/function. This package seeks to remove these restrictions, so that multiple keys of all categories (ordinary keys, command keys, boolean keys, and choice keys) can be set at one go and those keys can have different default values and functions. This greatly minimizes tokens, as hundreds of keys can, in principle, be issued simultaneously by one command.
-Also, the \krsty{xkeyval} package doesn't have the notion of complementary keys,
-which can be handy in the case of boolean keys. The present package introduces
-this concept and additionally permits the submission of individual/different
-key macros to the complementary keys.
+Also, the \krsty{xkeyval} package doesn't have the notion of complementary keys, which can be handy in the case of boolean keys. The present package introduces this concept and additionally permits the submission of individual/different key macros to the complementary keys.
\section{Usage}
@@ -70,7 +61,7 @@ and in document files via
\end{krverbatim}
where the options and their default values are
\begin{krverbatim}
-parser=;, macroprefix=mp@, keyprefix=KV, keyfamily=myfamily,
+parser=;, macroprefix=mp@, keyprefix=KV, keyfamily=myfamily,
xchoicelist=false.
\end{krverbatim}
The \krsty{parser} is the separator between the keys in the key list to be defined in one go (see examples in section~\ref{sec:examples}). All these options can be set dynamically by using the \krcmd{krsetup} macro:
@@ -147,7 +138,7 @@ Suppose we wish to define a set of keys \krsty{\{color,angle,scale,align\}}. The
2,scale,1,\def\mydo##1{\do ##1};4,align,center,\f@align;
|color(red)\stopread|color(blue);3,mybool,true,}.
\end{krverbatim}
-The \krcmd{kr@nr} macro is a bin parameter defined by the keyreader package in accordance with the instructions in the \krsty{xkeyval} guide. It refreshes with the choice key. See the \krsty{xkeyval} guide for further details.
+The \krcmd{nr} macro is a bin parameter defined by the keyreader package in accordance with the instructions in the \krsty{xkeyval} guide. It refreshes with the choice key. See the \krsty{xkeyval} guide for further details.
Instead of defining the macro \krcmd{f@align} before hand, we can submit its replacement text directly to the macro \krcmd{define@keylist}, but, because \krcmd{f@align} contains a conditional, some care is needed in doing so (see section~\ref{sec:conditionals}). Once the key \krsty{align} has been defined, the macro \krcmd{f@align} can be reused---perhaps to define other keys---even before the key \krsty{align} is set. This is because it isn't \krcmd{f@align} that is used in defining the key \krsty{align} but its ``meaning'' (\ie, the meaning of \krcmd{f@align}). In this way, the user can economize on tokens. The same applies to all the macros that may be used in defining keys.