summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/onedown/examples/onedown-ref.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/onedown/examples/onedown-ref.tex')
-rw-r--r--Master/texmf-dist/doc/latex/onedown/examples/onedown-ref.tex164
1 files changed, 77 insertions, 87 deletions
diff --git a/Master/texmf-dist/doc/latex/onedown/examples/onedown-ref.tex b/Master/texmf-dist/doc/latex/onedown/examples/onedown-ref.tex
index dfdac3f5060..36fa69fb493 100644
--- a/Master/texmf-dist/doc/latex/onedown/examples/onedown-ref.tex
+++ b/Master/texmf-dist/doc/latex/onedown/examples/onedown-ref.tex
@@ -17,28 +17,10 @@
\renewcommand\item[1][\relax]{\olditem\textbf{\bs#1}}
%\def\Item{\olditem[\bs]}
%
-\begin{document}
-\iffalse
-Word1 \onesuitEW{K98}{A65} word2
-%
-\onesuitNE{K}{A65} word3
-%
-\onesuitNS{K98}{A65} word4
-%
-\onesuitNW{K98}{A65} word5
+\definecolor{optbackgr}{named}{lightgray}
+\newcommand\Oarg[1]{\colorbox{optbackgr}{\texttt{#1}}}
-Word1 \onesuitEW!{K98}{A65} word2
-%
-\onesuitNE!{K98}{A65} word3
-%
-\onesuitNS!{K98}{A65} word4
-%
-\onesuitNW!{K98}{A65} word5
-
-Word1 \onesuitAll{K}{A}{QT7}{J432} word2
-%
-\onesuitAll!{K98}{A65}{QT7}{J432} word3
-\fi
+\begin{document}
\larger
\newgeometry{total={150mm, 265mm},left=25mm,top=15mm}
@@ -50,23 +32,25 @@ Here we show all user commands of the package |onedown| in alphabetical
order. If we only show the ouput that a command produces, then this output
is shown directly behind the command on the same line. If a description of
the command is given, then this description starts on a new line. Optional
-parameters of a command (including tokens) appear in brackets
-|[...]|. Output of a tokenized |\macro*!| is shown as:
-\qquad|\macro[*!]: \macro, \macro*, \macro!, \macro*!|\\
+parameters of a command appear in brackets |[...]|, parenthesis |(...)| or
+angles |<...>|. Optional tokens of a command appear with a different
+background color, like \Oarg{*!}. Output of a tokenized |\macro*!| is shown
+as:
+\quad|\macro|\Oarg{*!}|: \macro, \macro*, \macro!, \macro*!|\\
All output is shown for the English language.
\begin{description}[itemsep=-0.3em]
\item[ace]: \ace
-\item[Ace\Q{[*!]}]: \Ace, \Ace*, \Ace!, \Ace*!
+\item[Ace\Oarg{*!}]: \Ace, \Ace*, \Ace!, \Ace*!
\item[alert]: |2\NT\alert| typesets 2\NT\alert and |2\Cl\alert| typesets
2\Cl\alert
\item[all]: \all
-\item[All\Q{[*!]}]: \All, \All*, \All!, \All*!
+\item[All\Oarg{*!}]: \All, \All*, \All!, \All*!
\item[allpass]: \allpass
-\item[Allpass\Q{[*!]}]: \Allpass, \Allpass*, \Allpass!, \Allpass*!
+\item[Allpass\Oarg{*!}]: \Allpass, \Allpass*, \Allpass!, \Allpass*!
\item[announce]: |2\He\announce| typesets 2\He\announce
@@ -77,14 +61,14 @@ description like |\sffamily\bfseries\HUGE| or |\mdseries\slshape\smaller|
or |\sffamily\scalefont{3}|.
\item[board]: \board
-\item[Board\Q{[*!]}]: \Board, \Board*, \Board!, \Board*!
+\item[Board\Oarg{*!}]: \Board, \Board*, \Board!, \Board*!
\item[boardnr\Q{{Nr} }]\\
Calculates (and stores) the dealership and vulnerability if |Nr|
is a number. If it is just a text it is stored to be used instead of a
board number.
-\item[boardtext\Q{[*]}]\\
+\item[boardtext\Oarg{*}]\\
Typesets the value that is stored with |\boardnr|.
The star version writes the text \textbf{\boardtext*} in front of it.
@@ -96,10 +80,10 @@ The star version writes the text \textbf{\boardtext*} in front of it.
Defines the font for the compass.
\item[contract]: \contract
-\item[Contract\Q{[*!]}]: \Contract, \Contract*, \Contract!, \Contract*!
+\item[Contract\Oarg{*!}]: \Contract, \Contract*, \Contract!, \Contract*!
\item[deal]: \deal
-\item[Deal\Q{[*!]}]: \Deal, \Deal*, \Deal!, \Deal*!
+\item[Deal\Oarg{*!}]: \Deal, \Deal*, \Deal!, \Deal*!
\item[dealer\Q{[text]}]\\
Typeset the defined dealer. With the optional
@@ -111,30 +95,30 @@ e.g.\ \mbox{\dealertext[\east]}. With the optional parameter one can define
the |text| to be printed \emph{as is}.
\item[declarer]: \declarer
-\item[Declarer\Q{[*!]}]: \Declarer, \Declarer*, \Declarer!, \Declarer*!
+\item[Declarer\Oarg{*!}]: \Declarer, \Declarer*, \Declarer!, \Declarer*!
\item[Di]: \Di
\item[double]: \double
-\item[Double\Q{[*!]}]: \Double, \Double*, \Double!, \Double*!
+\item[Double\Oarg{*!}]: \Double, \Double*, \Double!, \Double*!
\item[DP]: \DP
-\item[dpts\Q{[*!]}]: \dpts, \dpts*, \dpts!, \dpts*!
+\item[dpts\Oarg{*!}]: \dpts, \dpts*, \dpts!, \dpts*!
\item[east]: \east
-\item[East\Q{[*!]}]: \East, \East*, \East!, \East*!
+\item[East\Oarg{*!}]: \East, \East*, \East!, \East*!
\item[easthand\Q{[h-offset]{Sp}{He}{Di}{Cl}}]\\
Defines the cards for the
\East*!-player. With the optional parameter |h-offset| one can adapt the
(\emph{horizontal}) distance between hand and compass (default
\textbf{0pt}). The 4 mandatory parameters define the cards for the 4 suits.
-To denote the rank \suit{T}, one has to use uppercase letter |T|.
+To denote the rank \suit{T}, one has to use the uppercase letter |T|.
\item[eastwest]: \eastwest
-\item[Eastwest\Q{[*!]}]: \EastWest, \EastWest*, \EastWest!, \EastWest*!
+\item[Eastwest\Oarg{*!}]: \EastWest, \EastWest*, \EastWest!, \EastWest*!
-\item[expertquiz\Q{[*!][comment]{award}}]\\
+\item[expertquiz\Oarg{*!}\Q{[comment]}{award}]\\
Typesets a quiz, showing a
predefined hand and a predefined bidding diagram. The star version centers
the output. The token |!| forces a newline between hand and bidding
@@ -148,15 +132,15 @@ writes \emph{expl} below the bidding diagram in a footnote like way.
Typeset the text below the card diagram.
\item[FSF]: \FSF
-\item[fsforce\Q{[*!]}]: \fsforce, \fsforce*, \fsforce!, \fsforce*!
+\item[fsforce\Oarg{*!}]: \fsforce, \fsforce*, \fsforce!, \fsforce*!
\item[gamefont\Q{{font} }]\\
Defines the font for card diagrams, hands and suits.
\item[GF]: \GF
-\item[gforce\Q{[*!]}]: \gforce, \gforce*, \gforce!, \gforce*!
+\item[gforce\Oarg{*!}]: \gforce, \gforce*, \gforce!, \gforce*!
-\item[hand\Q{[*!-][pos]{Sp}{He}{Di}{Cl}}]\\
+\item[hand\Oarg{*!-}\Q{[pos]{Sp}{He}{Di}{Cl}}]\\
Typesets the cards of 1 single hand,
normally horizontally, left aligned. The star version centers the output.
The token |!| typesets the hand vertically, left aligned. With both |*!|
@@ -165,7 +149,7 @@ the hand is typeset vertically, centered. The optional argument |pos|
The third token |-| suppresses all output, which is then only saved for
later use (in e.g.\ |\expertquiz|). The 4
mandatory parameters define the cards for the 4 suits. To denote the rank
-\suit{T}, one has to use uppercase letter |T|.
+\suit{T}, one has to use the uppercase letter |T|.
\item[handskip\Q{{length description} }]\\
Adds |length| to the distance (default |1em|) between the rightmost hand
@@ -178,16 +162,16 @@ Typeset the text above the card diagram.
\item[He]: \He
-\item[hpts\Q{[*!]}]: \hpts, \hpts*, \hpts!, \hpts*!
+\item[hpts\Oarg{*!}]: \hpts, \hpts*, \hpts!, \hpts*!
\item[jack]: \jack
-\item[Jack\Q{[*!]}]: \Jack. \Jack*, \Jack!, \Jack*!
+\item[Jack\Oarg{*!}]: \Jack. \Jack*, \Jack!, \Jack*!
\item[king]: \king
-\item[King\Q{[*!]}]: \King, \King*, \King!, \King*!
+\item[King\Oarg{*!}]: \King, \King*, \King!, \King*!
\item[lead]: \lead
-\item[Lead\Q{[*!]}]: \Lead, \Lead*, \Lead!, \Lead*!
+\item[Lead\Oarg{*!}]: \Lead, \Lead*, \Lead!, \Lead*!
\item[leftlower\Q{[h-offset]{line1}{line2}{line3}}]
@@ -200,7 +184,7 @@ space between hand and annotation.
Defines the font for annotations in card diagrams.
\item[LP]: \LP
-\item[lpts\Q{[*!]}]: \lpts, \lpts*, \lpts!, \lpts*!
+\item[lpts\Oarg{*!}]: \lpts, \lpts*, \lpts!, \lpts*!
\item[markit]\\
sets a footnote-like marker in a bidding diagram.
@@ -221,56 +205,56 @@ in the bidding diagram.
Resets some stored data
\item[NMF]: \NMF
-\item[nmforce\Q{[*!]}]: \nmforce, \nmforce*, \nmforce!, \nmforce*!
+\item[nmforce\Oarg{*!}]: \nmforce, \nmforce*, \nmforce!, \nmforce*!
\item[none]: \none
-\item[None\Q{[*!]}]: \None, \None*, \None!, \None*!
+\item[None\Oarg{*!}]: \None, \None*, \None!, \None*!
\item[north]: \north
-\item[North\Q{[*!]}]: \North, \North*, \North!, \North*!
+\item[North\Oarg{*!}]: \North, \North*, \North!, \North*!
\item[northhand\Q{[v-offset]{Sp}{He}{Di}{Cl}}]\\
Defines the cards for the
\North*!-player. With the optional parameter |v-offset| one can adapt the
(\emph{vertical}) distance between hand and compass (default \textbf{0pt}).
The 4 mandatory parameters define the cards for the 4 suits. To denote the
-rank \suit{T}, one has to use uppercase letter |T|.
+rank \suit{T}, one has to use the uppercase letter |T|.
\item[northsouth]: \northsouth
-\item[NorthSouth\Q{[*!]}]: \NorthSouth, \NorthSouth*, \NorthSouth!, \NorthSouth*!
+\item[NorthSouth\Oarg{*!}]: \NorthSouth, \NorthSouth*, \NorthSouth!, \NorthSouth*!
-\item[nt\Q{[*!]}]: \nt, \nt*, \nt!, \nt*!
+\item[nt\Oarg{*!}]: \nt, \nt*, \nt!, \nt*!
\item[NT]: \NT
-\item[onesuitAll\Q{[*!]{N}{S}{E}{W}}]\\
+\item[onesuitAll\Oarg{*!}\Q{{N}{S}{E}{W}}]\\
Typesets the cards of 1 suit for all
players. The star version centers the output. The token |!| prints a small
box rather than the compass. The 4 mandatory parameters denote the cards
for the \North*!-, the \South*!-, the \East*!- and the \West*!-player.
-\item[onesuitEW\Q{[*!]{E}{W}}]\\
+\item[onesuitEW\Oarg{*!}\Q{{E}{W}}]\\
Same as |onesuitAll|, but only for the \East*!- and the \West*!-player.
-\item[onesuitNE\Q{[*!]{N}{E}}]\\
+\item[onesuitNE\Oarg{*!}\Q{{N}{E}}]\\
Same as |onesuitAll|, but only for the \North*!- and the \East*!-player.
-\item[onesuitNS\Q{[*!]{N}{S}}]\\
+\item[onesuitNS\Oarg{*!}\Q{{N}{S}}]\\
Same as |onesuitAll|, but only for the \North*!- and the \South*!-player.
-\item[onesuitNW\Q{[*!]{N}{W}}]\\
+\item[onesuitNW\Oarg{*!}\Q{{N}{W}}]\\
Same as |onesuitAll|, but only for the \North*!- and the \West*!-player.
\item[otherfont\Q{{font} }]\\
Defines the font for other items.
\item[pass]: \pass
-\item[Pass\Q{[*!]}]: \Pass, \Pass*, \Pass!, \Pass*!
+\item[Pass\Oarg{*!}]: \Pass, \Pass*, \Pass!, \Pass*!
\item[queen]: \queen
-\item[Queen\Q{[*!]}]: \Queen, \Queen*, \Queen!, \Queen*!
+\item[Queen\Oarg{*!}]: \Queen, \Queen*, \Queen!, \Queen*!
\item[redouble]: \redouble
-\item[Redouble\Q{[*!]}]: \Redouble, \Redouble*, \Redouble!, \Redouble*!
+\item[Redouble\Oarg{*!}]: \Redouble, \Redouble*, \Redouble!, \Redouble*!
\item[resetfonts]\\
Sets all fonts back to their default value.
@@ -281,19 +265,20 @@ Typesets an annotation of 3 lines in the right lower/upper corner of the
card diagram. With the optional parameter one can add some extra horizontal
space between hand and annotation.
-\item[setdefaults\Q{[*]}\string{key1=val1,key2=val2,\ldots\string}]\\
-With the key |bidder|, |compass|, |game|, |legend|, |name| or |other| one
-can set the default font for the respective items. With the key |compline|,
-|compshow|, |compsize| or |compturn| on can set the look of the compass.
-With the key |bidders|
-|bidfirst|, |bidline| or |bidlong| one can fine-tune the bidding diagram.
+\item[setdefaults\Oarg{*}\string{key1=val1,key2=val2,\ldots\string}]\\
+With the keys |bidder|, |compass|, |game|, |legend|, |name| or |other| one
+can set the default font for the respective items. With the keys
+|compline|, |compmid|, |compshow|, |compsize| or |compturn| on can set the
+look of the compass. With the keys |bidders|, |bidfirst|, |bidline| or
+|bidlong| one can fine-tune the bidding diagram. The keys that can be used
+as package options (|colors|, |err| and |warn|) can also be set here.
The star form also calls |\resetfonts| which effectuates any font change
immediately.
\item[SF]: \SF
-\item[sforce\Q{[*!]}]: \sforce, \sforce*, \sforce!, \sforce*!
+\item[sforce\Oarg{*!}]: \sforce, \sforce*, \sforce!, \sforce*!
-\item[showAll\Q{[*+][pos]}]\\
+\item[showAll\Oarg{*+}\Q{[pos]}]\\
Typesets a card diagram with 4 (previously
defined, i.e.\ with |\northhand| etc.) hands. The star version centers the
output. The token |+| adds a bidding table to the diagram, that has to be
@@ -301,27 +286,32 @@ previously defined, i.e.\ with e.g:\\
|\begin{bidding}-|\ldots|\end{bidding}|. The optional parameter |pos|
(default~\textbf{c}) aligns the diagram.
-\item[showEW\Q{[*+][pos]}]\\
-Same as showAll, but for the \East*!- and the \West*!-hand.
-
-\item[showNE\Q{[*+][pos]}]\\
-Same as showAll, but for the \North*!- and the \East*!-hand.
+\DeleteShortVerb{\|}
+\item[showEW\Oarg{*+}\Q{[pos]}(E|W)]\\
+\MakeShortVerb{\|}
+Same as |\showAll|, but for the \East*!- and the \West*!-hand. |\showEW(E)|
+prints only the \East*!-hand
-\item[showNS\Q{[*+][pos]}]\\
-Same as showAll, but for the \North*!- and the \South*!-hand.
+\item[showNE\Oarg{*+}\Q{[pos]}]\\
+Same as |\showAll|, but for the \North*!- and the \East*!-hand.
-\item[showNW\Q{[*+][pos]}]\\
-Same as showAll, but for the \North*!- and the \West*!-hand.
+\DeleteShortVerb{\|}
+\item[showNS\Oarg{*+}\Q{[pos]}(N|S)]\\
+\MakeShortVerb{\|}
+Same as |\showAll|, but for the \North*!- and the \South*!-hand. |\showNS(S)|
+prints only the \South*!-hand
+\item[showNW\Oarg{*+}\Q{[pos]}]\\
+Same as |\showAll|, but for the \North*!- and the \West*!-hand.
\item[south]: \south
-\item[South\Q{[*!]}]: \South, \South*, \South!, \South*!
+\item[South\Oarg{*!}]: \South, \South*, \South!, \South*!
\item[southhand\Q{[v-offset]{Sp}{He}{Di}{Cl}}]\\
Defines the cards for the
\South*!-player. With the optional parameter |v-offset| one can adapt the
(\emph{vertical}) distance between hand and compass (default \textbf{0pt}).
The 4 mandatory parameters define the cards for the 4 suits. To denote the
-rank \suit{T}, one has to use uppercase letter |T|.
+rank \suit{T}, one has to use the uppercase letter |T|.
\item[Sp]: \Sp
@@ -332,10 +322,10 @@ of the cards. The mandatory parameter defines the cards for the suit. To
denote the rank \suit{T}, one has to use the letter |T|.
\item[TP]: \TP
-\item[tpts\Q{[*!]}]: \tpts, \tpts*, \tpts!, \tpts*!
+\item[tpts\Oarg{*!}]: \tpts, \tpts*, \tpts!, \tpts*!
\item[TSF]: \TSF
-\item[tsforce\Q{[*!]}]: \tsforce, \tsforce*, \tsforce!, \tsforce*!
+\item[tsforce\Oarg{*!}]: \tsforce, \tsforce*, \tsforce!, \tsforce*!
\item[vulner\Q{[text]}]\\
Typeset the user-defined vulnerability. With the optional parameter one can
@@ -347,16 +337,16 @@ Typeset the defined value for the |\vulner|, e.g.\
define the |text| to be printed \emph{as is}.
\item[west]: \west
-\item[West\Q{[*!]}]: \West, \West*, \West!, \West*!
+\item[West\Oarg{*!}]: \West, \West*, \West!, \West*!
\item[westhand\Q{[h-offset]{Sp}{He}{Di}{Cl}}]\\
Defines the cards for the
\West*!-player. With the optional parameter |h-offset| one can adapt the
(\emph{horizontal}) distance between hand and compass (default
\textbf{0pt}). The 4 mandatory parameters define the cards for the 4 suits.
-To denote the rank \suit{T}, one has to use uppercase letter |T|.
+To denote the rank \suit{T}, one has to use the uppercase letter |T|.
-\olditem[\string\begin\string{bidding\string}\Q{[*!-][pos](description)}\ldots\string\end\string{bidding\string}]~\\
+\olditem[\string\begin\string{bidding\string}\Oarg{*!-}\Q{[pos](description)}\ldots\string\end\string{bidding\string}]~\\
Typesets a bidding diagram. The star version centers the output. The
token~|!| forces a short form (\North*!) rather than the long form
(\North*) in the table header. The token~|-| suppresses all output, but the
@@ -372,10 +362,10 @@ The command |\setdefaults| has some keys to fine tune the
look of the bidding diagram. If the real world names of the players are
defined (e.g.\ with |\namesNS|, then they also appear in the table header.
-\olditem[\string\begin\string{biddingpair\string}\Q{[*!-][pos](description)}\ldots\string\end\string{biddingpair\string}]~\\
+\olditem[\string\begin\string{biddingpair\string}\Oarg{*!-}\Q{[pos](description)}\ldots\string\end\string{biddingpair\string}]~\\
Same as environment |bidding| but with only 2 columns.
-\olditem[\string\begin\string{play\string}\Q{[*]{lead}[trump]}\ldots\string\end\string{play\string}]~\\
+\olditem[\string\begin\string{play\string}\Oarg{*}\Q{{lead}[trump]}\ldots\string\end\string{play\string}]~\\
Typesets a diagram with the playing tricks. The star version centers the
output. The mandatory parameter defines the player who had the opening
lead. The optional parameter defines the trump suit, the default is \NT.