| 1 |
%% |
| 2 |
%% This is file `xkvex1.tex', |
| 3 |
%% generated with the docstrip utility. |
| 4 |
%% |
| 5 |
%% The original source files were: |
| 6 |
%% |
| 7 |
%% xkeyval.dtx (with options: `xkvex1') |
| 8 |
%% |
| 9 |
%% --------------------------------------- |
| 10 |
%% Copyright (C) 2004-2022 Hendri Adriaens |
| 11 |
%% 2025 David Carlisle for latex-package-repositories |
| 12 |
%% --------------------------------------- |
| 13 |
%% |
| 14 |
%% This work may be distributed and/or modified under the |
| 15 |
%% conditions of the LaTeX Project Public License, either version 1.3 |
| 16 |
%% of this license or (at your option) any later version. |
| 17 |
%% The latest version of this license is in |
| 18 |
%% http://www.latex-project.org/lppl.txt |
| 19 |
%% and version 1.3 or later is part of all distributions of LaTeX |
| 20 |
%% version 2003/12/01 or later. |
| 21 |
%% |
| 22 |
%% This work has the LPPL maintenance status "maintained". |
| 23 |
%% |
| 24 |
%% This Current Maintainer of this work is Hendri Adriaens. |
| 25 |
%% |
| 26 |
%% This work consists of the file xkeyval.dtx and derived files |
| 27 |
%% keyval.tex, xkvtxhdr.tex, xkeyval.sty, xkeyval.tex, xkvview.sty, |
| 28 |
%% xkvltxp.sty, xkvutils.tex, pst-xkey.tex, pst-xkey.sty, xkveca.cls, |
| 29 |
%% xkvecb.cls, xkvesa.sty, xkvesb.sty, xkvesc.sty, xkvex1.tex, |
| 30 |
%% xkvex2.tex, xkvex3.tex and xkvex4.tex. |
| 31 |
%% |
| 32 |
%% The following files constitute the xkeyval bundle and must be |
| 33 |
%% distributed as a whole: readme, xkeyval.pdf, keyval.tex, |
| 34 |
%% pst-xkey.sty, pst-xkey.tex, xkeyval.sty, xkeyval.tex, xkvview.sty, |
| 35 |
%% xkvltxp.sty, xkvtxhdr.tex, xkvutils.tex, pst-xkey.dtx and xkeyval.dtx. |
| 36 |
%% |
| 37 |
\input xkeyval |
| 38 |
|
| 39 |
\catcode`\@=11 |
| 40 |
|
| 41 |
%% xkeyval package: TeX example |
| 42 |
%% Hendri Adriaens |
| 43 |
|
| 44 |
\noindent Example 1. This example demonstrates the use of the new |
| 45 |
macros for setting keys of the `xkeyval' package. Have a look at the |
| 46 |
source for information about this example and to understand the output. |
| 47 |
|
| 48 |
%% Define keys. |
| 49 |
\define@key{fami}{keyi}{key 1: #1 } |
| 50 |
\define@key{famii}{keyii}{key 2: #1 } |
| 51 |
\define@key{famiii}{keyiii}[test 2]{key 3: #1 } |
| 52 |
\define@key{famiv}{keyi}{key 4: #1 } |
| 53 |
|
| 54 |
%% Set keys from multiple families. |
| 55 |
\setkeys{fami,famii,famiii}{keyi=test 1,keyiii} |
| 56 |
|
| 57 |
%% Multiplely defined keys will be taken from the first family on the |
| 58 |
%% list that defines the key. When + is used, all families |
| 59 |
%% defining the key will set it. |
| 60 |
\setkeys{fami,famiv}{keyi=test 3}\par |
| 61 |
\setkeys{famiv,fami}{keyi=test 4}\par |
| 62 |
\setkeys+{fami,famiv}{keyi=test 5}\par |
| 63 |
|
| 64 |
%% Starred form sets keys that it can find in the families specified. |
| 65 |
%% Keys that cannot be located will be put onto a list for later use |
| 66 |
%% by \setrmkeys. |
| 67 |
\setkeys*{famiv}{keyi=test 9,keyii=http://www.test10.com, |
| 68 |
keyiii=test 11}\par |
| 69 |
|
| 70 |
%% Try to set the remaining keys from the previous step. The starred |
| 71 |
%% version defines a new list in case there are still keys that cannot |
| 72 |
%% be located in the given families. The command below does not do |
| 73 |
%% anything since the `keyi' key has already been taken from family |
| 74 |
%% `famiv' above. |
| 75 |
\setrmkeys*{fami}\par |
| 76 |
|
| 77 |
%% The normal version will complain (as \setkeys) when it cannot locate |
| 78 |
%% a key which was previously submitted to \xsetkeys and hasn't been |
| 79 |
%% set yet by previous commands. `xkeyval' commands can also be used to |
| 80 |
%% set `keyval' options. |
| 81 |
\setrmkeys{famii,famiii}\par |
| 82 |
|
| 83 |
%% Set keys, excluding some keys. |
| 84 |
\setkeys{fami,famii,famiii}[keyi,keyiii]{keyi=test 6,keyii=test |
| 85 |
7,keyiii=test 8}\par |
| 86 |
|
| 87 |
%% Test whether a key is defined in a family from the list. |
| 88 |
\key@ifundefined{fami,famii}{keyiii} |
| 89 |
{keyiii is not defined in family `fami' or `famii'} |
| 90 |
{keyiii is defined in family `fami' or `famii'} |
| 91 |
|
| 92 |
%% Define some keys and macros. |
| 93 |
\define@cmdkey[my]{fama}[my@]{keya}[none]{} |
| 94 |
\define@choicekey[my]{fama}{keyb}{a,b,c}[b]{correct input: #1} |
| 95 |
\define@boolkey[my]{famb}{keyc}[true]{} |
| 96 |
\def\testa{\setkeys[my]{fama}} |
| 97 |
\def\testb{\setkeys[my]{famb}} |
| 98 |
\def\testset{\setkeys[my]{fama,famb}} |
| 99 |
|
| 100 |
%% Now \testa can only set keya, \testb can only |
| 101 |
%% set keyb and \testset can set both. |
| 102 |
\testa{keya} |
| 103 |
\my@keya\ |
| 104 |
\testa{keyb} |
| 105 |
\testb{keyc} |
| 106 |
\ifmy@famb@keyc true \else false \fi |
| 107 |
\testset{keya=test 11,keyb=c,keyc=false} |
| 108 |
\my@keya\space |
| 109 |
\ifmy@famb@keyc true \else false \fi |
| 110 |
|
| 111 |
%% Pointer system |
| 112 |
|
| 113 |
%% First we (re)define some keys. |
| 114 |
\define@key{fam}{keyi}{key 1: #1 } |
| 115 |
\define@key{fam}{keyii}{key 2: #1 } |
| 116 |
\define@key{fam}{keyiii}[test 2]{key 3: #1 } |
| 117 |
|
| 118 |
%% Pointers can be used to copy the value of other keys in the same |
| 119 |
%% family. This can be done in two ways. The first example shows `on |
| 120 |
%% the spot' value saving. |
| 121 |
\setkeys{fam}{\savevalue{keyi}=test 12,\savevalue{keyii}=\usevalue{keyi}} |
| 122 |
\setkeys{fam}{keyiii=\usevalue{keyii}} |
| 123 |
|
| 124 |
%% However, you can also predefine the keys to be saved for the entire |
| 125 |
%% document with a single command. |
| 126 |
\savekeys{fam}{keyi,keyii} |
| 127 |
\setkeys{fam}{keyi=test 13,keyii=\usevalue{keyi}} |
| 128 |
\setkeys{fam}{keyiii=\usevalue{keyii}} |
| 129 |
|
| 130 |
%% Pointers can be used in default values as well. Remember that the |
| 131 |
%% previous example used \savekeys for keyi and keyii. |
| 132 |
\define@key{fam}{keyi}{keyi: #1 } |
| 133 |
\define@key{fam}{keyii}[\usevalue{keyi}]{keyii: #1 } |
| 134 |
\define@key{fam}{keyiii}[\usevalue{keyii}]{keyiii: #1 } |
| 135 |
\setkeys{fam}{keyi=test 14} |
| 136 |
\setkeys{fam}{keyii} |
| 137 |
\setkeys{fam}{keyiii} |
| 138 |
|
| 139 |
%% Presetting keys |
| 140 |
|
| 141 |
%% Simple example of the preset system. |
| 142 |
\define@key{fam}{keyi}{keyi: #1 } |
| 143 |
\define@key{fam}{keyii}{keyii: #1 } |
| 144 |
\presetkeys{fam}{keyi=blue}{keyii=\usevalue{keyi}} |
| 145 |
\setkeys{fam}{}\par |
| 146 |
\setkeys{fam}{keyi=red}\par |
| 147 |
\setkeys{fam}{keyii=red} |
| 148 |
\presetkeys{fam}{keyi=red}{}\par |
| 149 |
\setkeys{fam}{keyii=\usevalue{keyi}} |
| 150 |
|
| 151 |
\bye |
| 152 |
\endinput |
| 153 |
%% |
| 154 |
%% End of file `xkvex1.tex'. |