Remove cruft from Makefile and source tree
[clqr.git] / clqr-typographic-conventions.tex
blob7487061927dc7ef051dc117af4a4fd6a38c1cd05
1 % Copyright (C) 2008, 2009, 2012 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 or any later version published by the Free Software
6 % Foundation; with no Invariant Sections, no Front-Cover Texts and
7 % no Back-Cover Texts. For details see file COPYING.
9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10 \section*{Typographic Conventions}
11 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 \begin{LIST}{1cm}
15 \IT{\kwd{NAME}; \FU{NAME}; \GFU{NAME}; \MC{NAME}; \SO{NAME}; \V{\A name\A};
16 \CNS{name}}
18 Symbol defined in Common Lisp; esp.\ function, generic function,
19 macro, special operator, variable, constant.
22 \IT{\VAR{them}\qquad\qquad\qquad}
24 Placeholder for actual code.
27 \IT{\LIT{me}\qquad\qquad\qquad\qquad}
29 Literal text.
32 \IT{\Op{\VAR{foo}\DF{\LIT{bar}}}\qquad\qquad}
34 Either one \VAR{foo} or nothing; defaults to \LIT{bar}.
37 \IT{\OPn{\VAR{foo}}; \Goos{\VAR{foo}}}
39 Zero or more \VAR{foo}s.
42 \IT{\RP{\VAR{foo}}; \Goop{\VAR{foo}}}
44 One or more \VAR{foo}s.
47 \IT{\VAR{foos}\qquad\qquad\qquad}
49 English plural denotes a list argument.
52 \IT{\Goo{\VAR{foo}\XOR\VAR{bar}\XOR\VAR{baz}};
53 \xorGOO{
54 \VAR{foo}\\
55 \VAR{bar}\\
56 \VAR{baz}%
57 }{.}}
59 Either \VAR{foo}, or \VAR{bar}, or \VAR{baz}.
62 \IT{\orGOO{
63 \VAR{foo}\\
64 \VAR{bar}\\
65 \VAR{baz}
66 }{.}}
68 Anything from none to each of \VAR{foo}, \VAR{bar}, and \VAR{baz}.
71 \IT{\NEV{\VAR{foo}}\qquad\qquad\qquad}
73 Argument \VAR{foo} is not evaluated.
76 \IT{\DES{\VAR{bar}}\qquad\qquad\qquad}
78 Argument \VAR{bar} is possibly modified.
81 \IT{\PROGN{\VAR{foo}}\qquad\qquad\qquad}
83 \OPn{\VAR{foo}} is evaluated as in \SO{progn}; see page \pageref{:progn}.
86 \IT{\retval{\VAR{foo}}; \retvalii{\VAR{bar}};
87 \retvaln{\VAR{n}}{\VAR{baz}}}
89 Primary, secondary, and \VAR{n}th return value.
92 \IT{\T; \NIL\qquad\qquad\qquad}
94 \kwd*{T}, or truth in general; and \kwd*{NIL} or \kwd{()}.
97 \end{LIST}
99 %%% Local Variables:
100 %%% mode: latex
101 %%% TeX-master: "clqr"
102 %%% End: