summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/skeycommand/skeycommand-guide.tex
blob: dba05792f5615ca2e8c26884e6b3f66f37985c1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
\documentclass[a4paper,10pt,final,language=UKenglish,fancysec,fancyfnote]{amltxdoc}
\makeatletter
\let\sectionbreak\medbreak

\begin{document}

\begin{frontmatter}
\suptitle{}
\title{The \texttt{\color{blue}skeycommand} Package\titleref{t1}}
\iftogon{pdf}{%
  \titlenote[t1]{The package is available at \url{\@titleurl}.}%
}{%
  \titlenote[t1]{The package is available at \url{\@shorttitleurl}.}%
}
\subtitle{Version 0.3}
\titleurl{http://www.ctan.org/tex-archive/macros/latex/contrib/skeycommand/}
\shorttitleurl{http://www.ctan.org/}
\author{Ahmed Musa\Email{a.musa@rocketmail.com}\\Preston, Lancashire, UK}

\redef*\abstractname{\vspace{-\baselineskip}}
\begin{abstract}
\frameshade[width=\hsize,fillcolor=yellow!20,framesep=2pt,framerule=2pt,
  framecolor=brown]{%
  \frameshade[fillcolor=white,width=2.5cm,framecolor=red!60,framerule=2pt]%
  {\centering SUMMARY}\small
  The \pkgm{skeycommand} provides tools for defining \latex-style commands and environments using parameters and keys together. The advantages of keys over parameters include the facts that the former aren't limited to nine but can rise as desired by the user, and keys are much easier to match to their values than parameters to arguments, especially if the parameters are many. Moreover, keys can have natural functions. The design approach and user interfaces in the \pkg{skeycommand} differ from those found in the \pkgm{keycommand}. This package also provides the \acmd{\newtwooptcmd} and \acmd{\newtwooptenviron} macros for defining new commands and environments with two options/optional arguments. At both key command definition and invocation times there is no reference by the user to the semantics of key parsing and management. All the complex semantics and calculations involved in defining and setting keys are transparent to the user. The user of the \pkg{skeycommand} has access to some (but not all) of the machinery of \asty{xkeyval} and \asty{skeyval} packages (including the pointer mechanism) at the much lesser cost of worrying only about the key names and their values. Native boolean keys are automatically recognized and handled appropriately. However, because of the need to keep the user interface simple, toggle boolean keys aren't available in this package; neither are choice keys.
}
\end{abstract}
\pkgm*{xkeyval,skeyval}

\NewLet\licname\licensename
\redef*\licensename{\vspace{-\baselineskip}}
\begin{license}
\frameshade[width=\hsize,fillcolor=white,framesep=2pt,framerule=2pt,
  framecolor=brown]{\small
  \vspace{1ex}\centerline{\licname}\endgraf
  This work (\ie, all the files in the \asty{skeycommand} bundle) may be distributed and/or modified under the conditions of the \lppl (LPPL), either version~1.3 of this license or any later version.
  \endgraf
  The \lppl maintenance status of this software is ``author-maintained''. This software is provided ``as it is,'' without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose.
  \endgraf
  \endgraf\centerline{\makered{\CopyrightYear}}%
}
\end{license}
\end{frontmatter}

\newpage
\frameshade[fillcolor=yellow!20,framecolor=brown,framerule=2pt,framesep=2pt,
  width=\hsize]{\tableofcontents}

\section{Package options}
\label{sec:pack-options}

The package has only one option (namely, \acmdm{verbose}) and can be invoked at the time of loading the package or via the \acmd{\skeycommand} macro. The option \fx{verbose} is a boolean, initially set to false (\ie, its complement, \acmdm{silent}, is true by default). Setting \fx{silent} to \fx{false} is tantamount to setting \fx{verbose} to \fx{true}.
\begin{example}
|comm(In style files:)
\RequirePackage[verbose=true |orr false |orr on |orr off]{skeycommand}

|comm(In document files:)
\usepackage[verbose=true |orr false |orr on |orr off]{skeycommand}

|comm(In all cases:)
\skeycommand{verbose=true |orr false |orr on |orr off}
\end{example}

If you enter the boolean  \fx{verbose} (or \fx{silent}) without value, the value is assumed to be \fx{true}. The \fx{verbose} option is simply passed on to the \pkgm{skeyval} to log informational messages in the transcript file. The major task of key parsing for the \pkg{skeycommand} is undertaken by the \pkgm{skeyval}.

\section{User interfaces}

\subsection{Defining new key commands and environments}

The user interfaces for defining new key commands and environments are as follows:
\begin{macro}
\newkeycmd|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\newkeycmd|redstar|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}

\renewkeycmd|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\renewkeycmd|redstar|vang(cmd)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}

\newkeyenviron|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\newkeyenviron|redstar|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}

\renewkeyenviron|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\renewkeyenviron|redstar|vang(env)<|vang(mprefix)>|:|vang(keyval)|![|vang(narg)][|vang(default1)]{|vang(defn)}
\end{macro}

Here, \ang{cmd} is the new control sequence; \ang{env} is the new environment name; \ang{mprefix} is the prefix for macros deriving from the defined keys whose values will be used in the new command or environment (this is called the \emph{macro prefix} in the parlance of keys); \ang{keyval} is the key-value list [\eg, (\fx{keya=valuea}, \fx{keyb=valueb})]; \ang{narg} is the number of arguments for the new command or environment (excluding the keys), as you would enter it in \fx{\newcommand} and \fx{\newenvironment}; \ang{default1} is the default value for your optional argument (normally the first argument in \fx{\newcommand} and \fx{\newenvironment}); \ang{defn} is the replacement text (as in \fx{\newcommand} and \fx{\newenvironment}). If you don't supply the optional \ang{mprefix}, the package will use the first three letters of the key command or environment name, excluding the escape character but including an added ``at sign'' (\fx{@}). The aim of default ``at sign'' is to aid the visual separation of key names from macro prefixes.

Please note the angle bracket surrounding \ang{mprefix}, and the parenthesis surrounding \ang{keyval} in the above syntaxes. The \ang{mprefix} can't be empty (\ie, don't  enter \texttt{<>}) because it will be used by the package to build unique names for the macros that will hold the key values. You can choose not to enter anything for \ang{mprefix}, and the package will happily use the default prefix \fx{<xxx@>}, where ``\fx{xxx}'' represents the first three letters of the new command or environment name. Also, \ang{keyval} can't be empty: if it was empty, then we should ask: why use key commands instead of \latex's \fx{\newcommand} and \fx{\newenvironment}?

In \ang{defn}, you refer to your arguments in the normal way. You refer to the values of the keys using macros whose first three characters (after the escape character) are the \ang{mprefix} or, if \ang{mprefix} is not supplied, the first three letters of the declared key command (excluding the escape character). The family name of the keys defined via a key command is the key command name itself (without the escape character). The package uses this internally in developing the keys.  The key prefix is always ``KV''. If any of your key values contains parenthesis, simply enclose it in braces, to avoid confusing it with \ang{keyval} list.

The starred variants (\RedStar) give ``short'' macros, while the unstarred variants yield ``long'' macros.

The optional \ang{mprefix} will be useful if you fear clashes with previously defined key commands. Although, to be defined, key commands must be definable, two key commands may have their first three or four characters identical, thereby leading to clashes of their key-value prefixes.

\subsection{Final tokens of every environment}
\label{sec:env-final-tokens}

The user can add some tokens to the very end of every subsequent environment by declaring those tokens in \acmdm{\everyeoe}, which by default contains only \latex's \acmd{\ignorespacesafterend}, that is, the \pkg{skeycommand} automatically issues

\begin{example}
|makered(\everyeoe){\ignorespacesafterend}
\end{example}

It is important to note that new tokens are prepended (not appended) to the hook that underlies \fx{\everyeoe}, such that by default \fx{\ignorespacesafterend} always comes last in the list. You can empty the token list \fx{\everyeoe} by issuing the command \fx*{\everyeoe{}} and rebuild the list afresh, still by prepending elements to it. \fx{\everyeoe} isn't actually a token list register, but has been designed to behave like one. It is safe to issue \fx{\everyeoe} and/or \fx*{\everyeoe{}} in the pre-code part of the environment. The following example illustrates this point.

\begin{example}
\newkeyenviron*{testenv}<mp@>|:xwidth=2cm,ywidth=1.5cm,
  bool=off,body=\null,author=\null|!{%
  \centering\fbox{\parbox{\mp@xwidth}{\mp@body}}
  \ifmp@bool\color{red}\fi
  \fbox{\parbox{\mp@ywidth}{\mp@body}}%
  \normalcolor
  |makered(\everyeoe){}%
  |makered(\everyeoe){\ignorespacesafterend}%
  |makered(\everyeoe){\endgraf\vskip\baselineskip\centerline{\itshape\mp@author}}
}{}

\begin{document}
\begin{testenv}|:xwidth=5cm,ywidth=4cm,bool=on,
  author={Cornelius Tacitus \textup{|:55--120~AD|!}},body={%
  Love of fame is the last thing even learned men can bear
  to be parted from.
}|!%
\end{testenv}
\end{document}
\end{example}

%%+
\newkeyenviron*{testenv}<mp@>(xwidth=2cm,ywidth=1.5cm,
  boola=off,body=\null,author=\null){%
  \centering\fbox{\parbox{\mp@xwidth}{\raggedright\mp@body}}%
  {\ifmp@boola\color{red}\fi
    \hspace*{2mm}\fbox{\parbox{\mp@ywidth}{\raggedright\mp@body}}}%
  \everyeoe{}%
  \everyeoe{\ignorespacesafterend}%
  \everyeoe{\endgraf\vskip\baselineskip
  \centerline{\itshape\mp@author}}%
}{}%
\printexample{%
  \begin{testenv}(xwidth=5cm,ywidth=6cm,boola=on,
    author={Cornelius Tacitus \textup{(c.55--c.120~AD)}},
    body={Love of fame is the last thing even learned men can bear
    to be parted from.})%
  \end{testenv}%
}
\everyeoe{}
\everyeoe{\ignorespacesafterend}
%%+

\subsection{Invoking new key commands and environments}

The syntaxes for calling new key commands and environments are as follows:

\begin{macro}
\cmd[|vang(arg1)]{|vang(arg2)}...{|vang(argn)}|:|vang(keyval)|!

\begin{env}[|vang(arg1)]{|vang(arg2)}...{|vang(argn)}|:|vang(keyval)|!
  environment body
\end{env}
\end{macro}
where \fx{\cmd} and \fx{env} have been previously defined using key command and key environment. You refer to your arguments using parameter number one \fx{#1} onwards, up to a maximum of \fx{#8} (yes, \fx{#8}, not \fx{#9}). Here, \ang{keyval} (including the parenthesis) are optional arguments: you can omit them if you want to use the values of the keys set at key command definition time. Using keys is preferable to using parameters: you don't have to match parameters to arguments and, in principle, there is no limit to the number of keys that are permissible.

\subsection[Commands with two optional arguments]
{Commands and environments with two optional arguments}

The \pkg{skeycommand} uses the following macros internally. They can be used to define new commands and environments with two optional arguments. Their philosophy, intent, and use syntaxes differ from those of the \pkgm{twoopt}. They may be useful to some users, although I recommend the use of the above key commands.

\begin{macro}
\newtwooptcmd|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\newtwooptcmd|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}

\renewtwooptcmd|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\renewtwooptcmd|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}

\newtwooptenviron|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\newtwooptenviron|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}

\renewtwooptenviron|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\renewtwooptenviron|redstar|vang(cmd)[|vang(narg)][|vang(default1)]{|vang(defn)}
\end{macro}

\ang{narg} is the total number of arguments, including the first and second optional arguments.
Where are the second optional arguments here, you might be wondering? The second optional argument is usually empty and doesn't appear at command definition time. The second optional argument isn't the second argument of your command (as in \pkg{twoopt}), but the last. At command invocation, if you don't supply a value for the second optional argument, the command will assume it to be empty. But how do you supply a value for the second optional argument? The next section shows how.

\subsubsection[Invoking commands and environments]
{Invoking commands and environments with two optional arguments}

The syntaxes for calling commands and environments with two optional arguments are as follows:

\begin{macro}
\cmd[|vang(1st optarg)]{|vang(arg2)}...{|vang(argn)}|:|vang(2nd optarg)|!

\begin{env}[|vang(1st optarg)]{|vang(arg2)}...{|vang(argn)}|:|vang(2nd optarg)|!
  environment body
\end{env}
\end{macro}

If \ang{2nd optarg} is empty at command or environment invocation, the command or environment will assume it to be empty. Now you can see the conceptual link between \fx{\newtwooptcmd} (and friends) and \fx{\newkeycmd} (and friends).

\section{Examples}
\hbadness\@M

\begin{example}
|comm(The following is a macro of 3 parameters and 4 keys:)

|makered(\newkeycmd*)\demomacro|:name=Steve,height=1.60m,weight=75kg,
  tested=true|![3][Registered]{%
  \def\x{#1}\def\y{#2}\def\z{#3}%
  \ifdem@tested
    \edef\cleared{\dem@name}%
  \else
    \let\cleared\relax
  \fi
}
|comm(|makered(\dem@name) will hold the value supplied for |makered(`name') by the user of)
|comm(\demomacro. |makered(`dem') is from |makered(`demomacro'). Notice the LaTeX-like)
|comm(syntax of this command. The user doesn't have to bother about)
|comm(the nitty-gritty of key infrastructure.)

|comm(You can use the following statement to instruct the user)
|comm(to always supply value for `name' in \demomacro macro:)

|makered(\uservaluekeys)[KV]{demomacro}{name}
\end{example}

Instead of using the macro \acmd{\uservaluekeys}, you can use the full pointer system of the \pkg{skeyval}. For example, the following requires the user to supply a value for `name' and the package will save that value for some later use:
\begin{example}
|makered(\newkeycmd)*\demomacro|:|makered(\uservalue\savevalue|mcolor({)name|mcolor(}))=Steve,
  height=1.60m,wieght=75kg,tested=true|![3][Registered]{%
  \def\x{#1}\def\y{#2}\def\z{#3}%
  \edef\xxx{\dem@name}%
}

|comm(User now calls the \demomacro macro:)
\demomacro[data1]{data2}{data3}|:name,height=1.55m,wieght=55kg,
  tested=true|!
  |makered(|tto Error: no value supplied for `name')
\end{example}

You can use the saved value of key \fx{name} within \fx{\demomacro}. Suppose, oddly, that the key \fx{height} can use the value of the key \fx{name}, then we can do

\begin{example}
\demomacro[data1]{data2}{data3}|:name=John,
  height=|makered(\usevalue){|mcolor(name)},wieght=55kg,tested=true|!%
\end{example}

If for any key in \fx{\demomacro} you don't supply a key-value pair, the macro will use the above default value of that key. For example, in the following, the key \fx{height} is missing, so the macro will use its default value specified at key definition time:

\begin{example}
\demomacro[data1]{data2}{data3}|:name=John,weight=55kg,tested=true|!
\end{example}

\begin{example}
|makered(\newkeycmd*)\firstmacro<skc@>|:name=Steve,
  height=1.6m|![8][xxx]{%
  \noindent Name: \skc@name\\
  Height: \skc@height\\
  Details: #1#2#3#4#5#6#7#8%
  \endgraf
}

\begin{document}
\firstmacro[1]{-2}{-3}{-4}{-5}{-6}{-7}{-8}%
  |:name=John {|:Winner|!},height=1.54m|!
\end{document}
\end{example}

%%+
\newkeycmd*\firstmacro<skc@>(name=Steve,height=1.6m)[8][xxx]{%
  \noindent Name: \skc@name\\Height: \skc@height\\
  Details: #1#2#3#4#5#6#7#8\endgraf
}
\printexample{%
  \firstmacro[1]{-2}{-3}{-4}{-5}{-6}{-7}{-8}%
    (name=John {(Winner)},height=1.54m)%
}
%%+

\begin{example}
|makered(\newkeyenviron*){vdescription}<skv@>|:labelwidth=5pt,
  labelsep=5pt|![2][\qquad]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\skv@labelwidth
    +\labelsep+\skv@labelsep}}%
  \item[Description Preamble] #2%
}{\end{list}}

\begin{document}
\begin{vdescription}[Description Postamble]%
  {$\star\star\star$}|:labelwidth=10pt,labelsep=10pt|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] $\langle$End of my
    environment$\rangle$
\end{vdescription}
\end{document}
\end{example}

%%+
\newkeyenviron*{vdescription}<skv@>(labelwidth=5pt,labelsep=5pt)[2][\qquad]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
  \settowidth\labelwidth{\makelabel{#1}}%
  \SKV@dimdef\leftmargin{\labelwidth+\skv@labelwidth
    +\labelsep+\skv@labelsep}}%
  \item[Description Preamble] #2%
}{\end{list}}
\printexample{%
  \begin{vdescription}[Alexandre P\'ere Dumas (1802--1870)]%
    {$\langle\star\star\star\rangle$}(labelwidth=5pt,labelsep=5pt)
    \item[Alexandre P\'ere Dumas (1802--1870)] All for one, and one for all.
    \item[Alexandre Fils Dumas (1824--1895)] All generalizations are dangerous, even this one.
    \item[Description Postamble] $\langle\bullet\bullet\bullet\rangle$
  \end{vdescription}%
}
%%+

\EnableMathInExampleCode
\begin{example}
\newkeyenviron*{dialog}<dia@>|:labelwidth=5pt,labelsep=5pt|![1][\qquad]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
  \centering\textbf{G. H. Hardy vs.\ Srinivasa Ramanujan |:1920|!}%
  \settowidth\labelwidth{\makelabel{#1}}%
  \SKV@dimdef\leftmargin{\labelwidth+\dia@labelwidth
    +\labelsep+\dia@labelsep}}%
}{\end{list}}

\begin{dialog}[Ramanujan]|:labelwidth=20pt,labelsep=10pt|!%
  \item[Hardy] Srinivasa, can you see that number from here, the
    one on that taxi cab?
  \item[Ramanujan] I can see it, it is 1729.
  \item[Hardy] What a dull registration number to have on your vehicle?
  \item[Ramanujan] No, it is a very interesting number.
  \item[Hardy] What is interesting about it?
  \item[Ramanujan] It is the smallest number expressible as a sum of two
    cubes in two different ways.
  \item[Hardy] What are the different ways?
  \item[Ramanujan] They are $1^3+12^3$ and $9^3+10^3$.
  \item[Hardy] I am impressed! When did you work that out?
\end{dialog}
\end{example}
\DisableMathInExampleCode

%%+
\newkeyenviron*{dialog}<dia@>(labelwidth=5pt,labelsep=5pt)[1][\qquad]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
  \centering\textbf{G. H. Hardy vs.\ Srinivasa Ramanujan (1920)}%
  \settowidth\labelwidth{\makelabel{#1}}%
  \SKV@dimdef\leftmargin{\labelwidth+\dia@labelwidth
    +\labelsep+\dia@labelsep}}%
}{\end{list}}

\printexample{%
  \begin{dialog}[Ramanujan](labelwidth=0pt,labelsep=0pt)%
    \item[Hardy] Srinivasa, can you see that number from here, the one on that taxi cab?
    \item[Ramanujan] I can see it, it is 1729.
    \item[Hardy] What a dull registration number to have on your vehicle?
    \item[Ramanujan] No, it is a very interesting number.
    \item[Hardy] What is interesting about it?
    \item[Ramanujan] It is the smallest number expressible as a sum of two cubes in two different ways.
    \item[Hardy] What are the different ways?
    \item[Ramanujan] They are $1^3+12^3$ and $9^3+10^3$.
    \item[Hardy] I am impressed! When did you work that out?
  \end{dialog}%
}
%%+

\begin{example}
\def\@barbara{An author writing an article for publication
  in TUGboat is encouraged to create it on a computer file
  and submit it on magnetic tape.}
\def\barbara{BARBARA BEETON,\\ \emph{How to Prepare a File For
  Publication in TUGboat} |:1981|!}
\def\@hieronymus{The printer should refuse to employ wandering
  men, foreigners who, after having committed some grievous
  error, can easily disappear and return to their own country.}
\def\hieronymus{HIERONYMUS HORNSCHUCH |:1608|!}

|comm(The macros \@barbara, \barbara, etc. are just shorthands:)
|comm(you can enter their contents directly in key commands,)
|comm(as we shall see later.)

|makered(\newkeyenviron){Quote}<mp@>|:left=\leftmargin,
  right=\rightmargin,mode=false,whoby=\null,
  source=\null|!{%
  \begin{list}{}{%
    \setlength\leftmargin{\mp@left}%
    \setlength\rightmargin{\mp@right}%
  }%
  \item[]\makebox[0pt][r]{``}%
}{%
  \unskip\makebox[0pt][l]{''}%
  \item[] \flushright\mp@whoby
  \item[] \flushleft\small Source: \mp@source
  \end{list}
  \vskip\baselineskip
}
\usepackage{lipsum}
\lipsum[1]
\begin{Quote}|:left=30pt,right=30pt,mode=false,
  whoby=\barbara,source={The \TeX Book}|!%
  {\ifmp@mode\color{red}\else\color{blue}\fi\@barbara}
\end{Quote}

\lipsum[1]
\begin{Quote}|:left=20pt,right=20pt,mode=true,
  whoby=\hieronymus,source={The \TeX Book}|!%
  {\ifmp@mode\color{red}\else\color{blue}\fi\@hieronymus}
\end{Quote}

\lipsum[1]
\begin{Quote}|:left=40pt,right=40pt,mode=false,
  whoby={EDWARD ELGAR},source={Letter to A.\ J.\ Jaeger |:1898|!}|!%
  {\ifmp@mode\color{red}\else\color{blue}\fi
    If I write a tune you all say it's commonplace---if I
    don't, you all say it's rot.%
  }%
\end{Quote}

\begin{Quote}|:left=40pt,right=40pt,mode=false,
  whoby={ALBERT EINSTEIN},source={The World As I See It}|!%
  {\ifmp@mode\color{red}\else\color{blue}\fi
    If you want to find out anything from the theoretical physicists
    about the methods they use, I advise you to stick closely to
    one principle: don't listen to their words, fix your attention
    on their deeds.%
  }%
\end{Quote}
\end{example}

%%+
\newkeyenviron{Quote}<mp@>(left=\leftmargin,
  right=\rightmargin,mode=false,whoby=\null,source=\null){%
  \begin{list}{}{%
    \setlength\leftmargin{\mp@left}%
    \setlength\rightmargin{\mp@right}%
  }%
  \item[]\makebox[0pt][r]{``}%
}{%
  \unskip\makebox[0pt][l]{''}%
  \item[]\flushright\mp@whoby
  \item[]\flushleft\small Source:~\mp@source
  \end{list}%
  \vskip\baselineskip
}
\def\@barbara{An author writing an article for publication
  in TUGboat is encouraged to create it on a computer file
  and submit it on magnetic tape.}
\def\barbara{BARBARA BEETON,\\ \emph{How to Prepare a File For
  Publication in TUGboat} (1981)}
\def\@hieronymus{The printer should refuse to employ wandering
  men, foreigners who, after having committed some grievous
  error, can easily disappear and return to their own country.}
\def\hieronymus{HIERONYMUS HORNSCHUCH (1608)}
\printexample{%
  \begin{Quote}(left=30pt,right=30pt,mode=false,
    whoby=\barbara,source={The \TeX Book})%
    {\ifmp@mode\color{red}\else\color{blue}\fi\@barbara}%
  \end{Quote}%
}
\printexample*{%
  \begin{Quote}(left=40pt,right=40pt,mode=true,
    whoby=\hieronymus,source={The \TeX Book})%
    {\ifmp@mode\color{red}\else\color{blue}\fi\@hieronymus}%
  \end{Quote}%
}
\printexample*{%
  \begin{Quote}(left=80pt,right=80pt,mode=false,
    whoby={EDWARD ELGAR (1898)},source={Letter to A.\ J.\ Jaeger})%
    {\ifmp@mode\color{red}\else\color{blue}\fi
      If I write a tune you all say it's commonplace---if I
      don't, you all say it's rot.%
    }%
  \end{Quote}%
}
\printexample*{%
  \begin{Quote}(left=40pt,right=40pt,mode=false,
  whoby={ALBERT EINSTEIN},source={The World As I See It})%
  {\ifmp@mode\color{red}\else\color{blue}\fi
    If you want to find out anything from the theoretical physicists
    about the methods they use, I advise you to stick closely to
    one principle: don't listen to their words, fix your attention
    on their deeds.%
  }%
  \end{Quote}%
}
%%+

\begin{example}
\usepackage{lipsum}
\newcounter{notecnt}
\def\noteparameters{\labelsep=\notelabelsep
  \itemindent=\noteitemindent \leftmargin=\noteleft
  \rightmargin=\noteright \labelwidth=\notelabelwidth}

|makered(\newkeyenviron*){notex}<note>|:labelsep=8pt,itemindent=8pt,
  left=\parindent,right=\parindent,labelwidth=0pt,
  preskip=0ex,aftskip=0ex|![1][\baselineskip]%
  {\begin{list}{\textsc{Note}~\arabic{notecnt}:}%
    {\noteparameters\usecounter{notecnt}}%
      \vskip#1}%
  {\end{list}\vskip\noteaftskip}

\begin{document}
\noindent\lipsum[1]
\begin{notex}[\notepreskip]|:labelsep=8pt,itemindent=8pt,
  left=30pt,right=30pt,labelwidth=0pt,preskip=2ex,aftskip=2ex|!
\item \lipsum[1]
\item \lipsum[1]
\end{notex}
\end{document}
\end{example}

%%+
\newcounter{notecnt}
\def\noteparameters{\labelsep=\notelabelsep
  \itemindent=\noteitemindent \leftmargin=\noteleft
  \rightmargin=\noteright \labelwidth=\notelabelwidth}
\newkeyenviron*{notex}<note>(labelsep=8pt,itemindent=8pt,
  left=\parindent,right=\parindent,labelwidth=0pt,
  preskip=0ex,aftskip=0ex)[1][\baselineskip]%
  {\begin{list}{\textbf{Note~\arabic{notecnt}}}%
    {\centering\textbf{How to make a recurring list}\\[1ex]%
      \noteparameters\usecounter{notecnt}}%
      \vskip#1%
  }%
  {\end{list}\vskip\noteaftskip}

\StartRecurrentList{2}
\printexample*{%
  \begin{notex}[\notepreskip](labelsep=8pt,itemindent=8pt,
    left=20pt,right=20pt,labelwidth=0pt,preskip=2ex,aftskip=2ex)%
    \item The play was a great success, but the audience was a disaster. (Oscar Wilde, 1854--1900)
    \item If people behaved in the way nations do they would all be put in straitjackets. (Tennessee Williams, 1911--1983)
    \item If you hate a person, you hate something in him that is part of yourself. What isn't part of ourselves doesn't disturb us. (Hermann Hesse, 1877-1962)
    \item If a man makes a better mouse-trap than his neighbor, though he builds his house in the woods, the world will make a beaten path to his door. (Ralph Waldo Emerson, 1803--1882)
  \end{notex}
}
\EndRecurrentList
%%+

\begin{example}
\def\sitation{}
\def\sitparameters{\leftmargin=\sit@left\rightmargin=\sit@right}
\newbox\sitname
|makered(\renewkeyenviron*){sitation}|:left=\parindent,
  right=\parindent,nolinebreak=1|![2][\relax]%
  {\def\quoteend{#1}\sitparameters
    \sbox\sitname{\textit{#2}}%
    \begin{quote}\quoteend
  }%
  {\hspace*{\fill}\nolinebreak[\sit@nolinebreak]%
    \quad\hspace*{\fill}\finalhyphendemerits\z@
    \box\sitname
  \end{quote}}

\begin{document}
\begin{sitation}[\sit@nolinebreak]%
  {Theodore Roosevelt~|:1858--1919|!}%
  |:left=30pt,right=30pt,nolinebreak=2|!
  No man is justified in doing evil on the ground of expediency.
\end{sitation}

\begin{sitation}{George Bernard Shaw |:1856-1950|!}%
A man of great common sense and good taste; meaning thereby
a man without originality or moral courage.
\end{sitation}
\end{document}
\end{example}

%%+
\def\sitation{}
\def\sitparameters{\leftmargin=\sit@left\rightmargin=\sit@right}
\csnewbox{sitname}
\renewkeyenviron*{sitation}(left=\parindent,
  right=\parindent,nolinebreak=1)[2][\relax]%
  {\def\quoteend{#1}\sitparameters
    \sbox\sitname{\textit{#2}}%
    \begin{quote}%
  }{%
    \hspace*{\fill}\nolinebreak[\sit@nolinebreak]%
    \quad\hspace*{\fill}\finalhyphendemerits\z@
    \box\sitname
  \end{quote}\quoteend
}
\printexample{%
  \begin{sitation}[\vskip2ex\relax]{Theodore Roosevelt~\textup{(1858--1919)}}%
    (left=30pt,right=30pt,nolinebreak=2)%
   No man is justified in doing evil on the ground of expediency.
  \end{sitation}%
}
\printexample*{%
  \begin{sitation}{George Bernard Shaw~\textup{(1856-1950)}}%
    (left=0pt,right=0pt,nolinebreak=2)%
    A man of great common sense and good taste;
    meaning thereby a man without originality and/or moral courage.
  \end{sitation}%
}
%%+

\begin{example}
|makered(\newkeyenviron*){vdescription}|:labelwidth=5pt,
  labelsep=5pt|![2][\qquad]%
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\vde@labelwidth
      +\labelsep+\vde@labelsep}}%
    \item[Description Preamble] #2%
}{\end{list}}

\begin{document}
\begin{vdescription}[Description Postamble]{+++xxx+++}%
  |:labelwidth=10pt,labelsep=5pt|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] $\langle$End of my
    environment$\rangle$
\end{vdescription}
\end{document}
\end{example}

\begin{example}
|makered(\renewtwooptenviron*){vdescription}[3][\qquad]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\labelsep+#2}}%
    \item[Description Preamble] #3%
  }{\end{list}}

\begin{document}
\begin{vdescription}[Description Postamble]{4cm}|:{|:Begin
  environment no.\ 1|!}|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] |:End of environment no.\ 1|!
\end{vdescription}
\end{document}
\end{example}

\begin{example}
|makered(\newtwooptenviron*){udescription}[3][\hspace{1cm}]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef\leftmargin{\labelwidth+\labelsep+#3}}%
    \item[Description Preamble] #2%
  }{\end{list}}

\begin{document}
\begin{udescription}[Description Postamble]{uuu}|:4cm|!
  \item[Item 1] xxx
  \item[Item 2] yyy
  \item[Description Postamble] The End
\end{udescription}
\end{document}
\end{example}

%%+
\newtwooptenviron*{udescription}[3][\hspace{1cm}]
  {\begin{list}{}{\redef*\makelabel##1{\sffamily ##1:\hfil}%
    \settowidth\labelwidth{\makelabel{#1}}%
    \SKV@dimdef!\leftmargin{\labelwidth+\labelsep+#3}}%
    \item[Preamble] #2%
  }{\end{list}%
}
\printexample{%
  \begin{udescription}[Bertrand Russell (1872--1970)]{\tcl{red}{Beginning of quotations}}(1mm)
    \item[John Ruskin (1819--1900)]Whereas it has long being known and declared that the poor have no right to the property of the rich, I wish it also to be known and declared that the rich have no right to the property of the poor.
    \item[Bertrand Russell (1872--1970)]The megalomaniac differs from the narcissist by the fact that he wishes to be powerful rather than charming, and seeks to be feared rather than loved. To this type belong many lunatics and most of the great men of history.
    \item[Postamble] \tcl{magenta}{End of quotations}
  \end{udescription}%
}
%%+

\begin{example}
\def\firstmacro{}
|makered(\renewkeycmd*)\firstmacro<skv@>|:name=Steve,
  module=Martian logic,pass=true|![2][\@ptsize]{%
  \edef\x{\skv@name}%
  \wlog{\if0#1 10pt\else\if1#1 11pt\else
    \if2#1 12pt\fi\fi\fi\space font used}%
  \def\y{#2}%
}

\firstmacro[0]{aaa}|:name=John,module=Philosophy,pass=false|!
\end{example}

\begin{example}
|makered(\newtwooptcmd*)\macro[3][xxx]{\def\x{#1}\def\y{#2}\def\z{#3}}
\macro[uuu]{vvv}|:www|!
\macro{vvv}|:www|!
\macro{vvv}
\end{example}

\begin{example}
\SKV@undef\macro
|makered(\newtwooptcmd*)\macro[2][xxx]{\def\x{#1}\def\y{#2}}
\macro[uuu]|:vvv|!
\macro|:vvv|!
\end{example}

\begin{example}
|makered(\renewtwooptcmd)\macro[2][xxx]{\def\x{#1}\long\def\y{#2}}
\macro[uuu]|:\par|!
\macro|:\par|!
\end{example}

\begin{example}
\let\tcl\textcolor
|makered(\newkeycmd*)\firstrule|:raise=.5ex,width=1em,thick=2pt,
  proclaim=false|![1]{%
  \tcl{blue}{\rule[\fir@raise]{\fir@width}{\fir@thick}}%
  #1%
  \tcl{cyan}{\rule[\fir@raise]{\fir@width}{\fir@thick}}%
  \iffir@proclaim \color{red}\fi\textdaggerdbl
}

\usepackage[left=2cm,right=2cm]{geometry}
\begin{document}
\parindent\z@
\begin{tabular*}\textwidth{lr}
\verb+\firstrule{Hello World}|:width=2em,thick=4pt,
  proclaim|!+:|ampersand
  \firstrule{Hello World}|:width=2em,thick=4pt|!\cr
\verb+\firstrule{Hello}|:width=2em,thick=.5pt,
  proclaim=true|!+:|ampersand
  \firstrule{Hello}|:width=2em,thick=.5pt,proclaim=true|!\cr
\verb+\firstrule{Hello World}|:thick=2pt,
  proclaim=true|!+:|ampersand
  \firstrule{Hello World}|:thick=2pt,proclaim=true|!\cr
\verb+\firstrule{Hello World}|:raise=1ex,width=2em,
  thick=1pt|!+:|ampersand
  \firstrule{Hello}|:raise=1ex,width=2em,thick=1pt|!
\end{tabular*}
\end{document}
\end{example}

%%+
\let\tcl\textcolor
\newkeycmd*\firstrule(raise=.5ex,width=1em,thick=2pt,
  proclaim=false)[1]{%
  \tcl{blue}{\rule[\fir@raise]{\fir@width}{\fir@thick}}%
  #1%
  \tcl{cyan}{\rule[\fir@raise]{\fir@width}{\fir@thick}}%
  \iffir@proclaim \color{red}\fi\textdaggerdbl
}
\printexample{%
  \parindent10pt
  \small
  \begin{tabular*}\hsize{lr}%
    \fx*{\firstrule{Hello World}(width=2em,thick=4pt,proclaim)}:&
      \firstrule{Hello World}(width=2em,thick=4pt)\cr
    \fx*{\firstrule{Hello}(width=2em,thick=.5pt,proclaim=true)}:&
      \firstrule{Hello}(width=2em,thick=.5pt,proclaim=true)\cr
    \fx*{\firstrule{Hello World}(thick=2pt,proclaim=true)}:&
      \firstrule{Hello World}(thick=2pt,proclaim=true)\cr
    \fx*{\firstrule{Hello World}(raise=1ex,width=2em,thick=1pt)}:&
      \firstrule{Hello}(raise=1ex,width=2em,thick=1pt)%
  \end{tabular*}%
}
%%+

\begin{example}
\let\tcl\textcolor
|makered(\newkeycmd)\secondrule<mp@>|:raise=.5ex,width=1em,thick=2pt,
  proclaim=false|![2][\tcl{magenta}{$\star$}]{%
  \tcl{cyan}{\rule[\mp@raise]{\mp@width}{\mp@thick}}%
  #1#2#1%
  \tcl{blue}{\rule[\mp@raise]{\mp@width}{\mp@thick}}%
  \ifmp@proclaim \color{red}\fi\textdaggerdbl
}
\usepackage[left=2cm,right=2cm]{geometry}
\begin{document}
\parindent\z@
\begin{tabular*}\textwidth{lr}
\verb+\secondrule[\textbullet]{Hello World}|:width=2em,
  thick=4pt,proclaim|!+:|ampersand
  \secondrule[\textbullet]{Hello World}|:width=2em,
    thick=4pt|!\cr
\verb+\secondrule{Hello}|:width=2em,thick=.5pt,
  proclaim=true|!+:|ampersand
  \secondrule{Hello}|:width=2em,thick=.5pt,proclaim=true|!\cr
\verb+\secondrule{Hello World}|:thick=2pt,
  proclaim=true|!+:|ampersand
  \secondrule{Hello World}|:thick=2pt,proclaim=true|!\cr
\verb+\secondrule{Hello World}|:raise=1ex,width=2em,
  thick=1pt|!+:|ampersand
  \secondrule{Hello}|:raise=1ex,width=2em,thick=1pt|!
\end{tabular*}
\end{document}
\end{example}

%%+
\newkeycmd\secondrule<mp@>(raise=.5ex,width=1em,thick=2pt,
  proclaim=false)[2][\tcl{magenta}{$\star$}]{%
  \tcl{cyan}{\rule[\mp@raise]{\mp@width}{\mp@thick}}%
  \textcolor{red}{#1}#2\textcolor{red}{#1}%
  \tcl{blue}{\rule[\mp@raise]{\mp@width}{\mp@thick}}%
  \ifmp@proclaim \color{red}\fi\textdaggerdbl
}
\printexample{%
  \parindent-5pt
  \footnotesize
  \begin{tabular*}\hsize{lr}%
  \fx*{\secondrule[\textbullet]{Hello World}(width=2em,thick=4pt,proclaim)}:&
    \secondrule[\textbullet]{Hello World}(width=2em,thick=4pt)\cr
  \fx*{\secondrule{Hello}(width=2em,thick=.5pt,proclaim=true)}:&
    \secondrule{Hello}(width=2em,thick=.5pt,proclaim=true)\cr
  \fx*{\secondrule{Hello World}(thick=2pt,proclaim=true)}:&
    \secondrule{Hello World}(thick=2pt,proclaim=true)\cr
  \fx*{\secondrule{Hello World}(raise=1ex,width=2em,thick=1pt)}:&
    \secondrule[\textbullet]{Hello}(raise=1ex,width=2em,thick=1pt)%
  \end{tabular*}%
}
%%+

\section{Version history}
\label{sec:version-hist}

The numbers on the right-hand side of the following lists are section numbers; the star sign (\RedStar) means the subject features in the package but is not reflected anywhere in this user guide.

\begin{versionhist}
  \begin{version}{0.1}{2010/05/05}
  \item First public release \xsecref
  \end{version}

  \begin{version}{0.2}{2010/05/20}
  \item Addressed the case of \fx{\newkeycmd} without parameters \xsecref
  \end{version}

  \begin{version}{0.3}{2010/05/21}
  \item Introduced \acmd{\everyeoe} \secref{sec:env-final-tokens}
  \end{version}

\end{versionhist}

\end{document}

% End of skeycommand-guide.tex