Fix bugs reported by Fengjing Xiao
[clqr.git] / clqr-typographic-conventions.tex
blobaf34799133295a28a57eac6f59666d77e9e95b1a
1 % Copyright (C) 2008, 2009, 2012, 2014, 2018 Bert Burgemeister
3 % Permission is granted to copy, distribute and/or modify this
4 % document under the terms of the GNU Free Documentation License,
5 % Version 1.2; with no Invariant Sections, no Front-Cover Texts and
6 % no Back-Cover Texts. For details see file COPYING.
8 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
9 \section*{Typographic Conventions}
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12 \begin{LIST}{1cm}
14 \IT{\kwd{NAME}; \FU{NAME}; \GFU{NAME}; \MC{NAME}; \SO{NAME}; \V{\A name\A};
15 \CNS{name}}
17 Symbol defined in Common Lisp; esp.\ function, generic function,
18 macro, special operator, variable, constant.
21 \IT{\VAR{them}\qquad\qquad\qquad}
23 Placeholder for actual code.
26 \IT{\LIT{me}\qquad\qquad\qquad\qquad}
28 Literal text.
31 \IT{\Op{\VAR{foo}\DF{\LIT{bar}}}\qquad\qquad}
33 Either one \VAR{foo} or nothing; defaults to \LIT{bar}.
36 \IT{\OPn{\VAR{foo}}; \Goos{\VAR{foo}}}
38 Zero or more \VAR{foo}s.
41 \IT{\RP{\VAR{foo}}; \Goop{\VAR{foo}}}
43 One or more \VAR{foo}s.
46 \IT{\VAR{foos}\qquad\qquad\qquad}
48 English plural denotes a list argument.
51 \IT{\Goo{\VAR{foo}\XOR\VAR{bar}\XOR\VAR{baz}};
52 \xorGOO{
53 \VAR{foo}\\
54 \VAR{bar}\\
55 \VAR{baz}%
56 }{.}}
58 Either \VAR{foo}, or \VAR{bar}, or \VAR{baz}.
61 \IT{\orGOO{
62 \VAR{foo}\\
63 \VAR{bar}\\
64 \VAR{baz}
65 }{.}}
67 Anything from none to each of \VAR{foo}, \VAR{bar}, and \VAR{baz}.
70 \IT{\NEV{\VAR{foo}}\qquad\qquad\qquad}
72 Argument \VAR{foo} is not evaluated.
75 \IT{\DES{\VAR{bar}}\qquad\qquad\qquad}
77 Argument \VAR{bar} is possibly modified.
80 \IT{\PROGN{\VAR{foo}}\qquad\qquad\qquad}
82 \OPn{\VAR{foo}} is evaluated as in \SO{progn}; see page \pageref{:progn}.
85 \IT{\retval{\VAR{foo}}; \retvalii{\VAR{bar}};
86 \retvaln{\VAR{n}}{\VAR{baz}}}
88 Primary, secondary, and \VAR{n}th return value.
91 \IT{\T; \NIL\qquad\qquad\qquad}
93 \kwd*{T}, or truth in general; and \kwd*{NIL} or \kwd{()}.
96 \end{LIST}
98 %%% Local Variables:
99 %%% mode: latex
100 %%% TeX-master: "clqr"
101 %%% End: