clqr-typographic-conventions.tex

   1 % Copyright (C) 2008, 2009, 2012 Bert Burgemeister
   2 %
   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.
   8 %
   9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  10 \section*{Typographic Conventions}
  11 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  12
  13 \begin{LIST}{1cm}
  14
  15   \IT{\kwd{NAME}; \FU{NAME}; \GFU{NAME}; \MC{NAME}; \SO{NAME}; \V{\A name\A};
  16     \CNS{name}}
  17   {
  18   Symbol defined in Common Lisp; esp.\ function, generic function,
  19   macro, special operator, variable, constant.
  20   }
  21
  22   \IT{\VAR{them}\qquad\qquad\qquad}
  23   {
  24   Placeholder for actual code.
  25   }
  26
  27   \IT{\LIT{me}\qquad\qquad\qquad\qquad}
  28   {
  29   Literal text.
  30   }
  31
  32   \IT{\Op{\VAR{foo}\DF{\LIT{bar}}}\qquad\qquad}
  33   {
  34   Either one \VAR{foo} or nothing; defaults to \LIT{bar}.
  35   }
  36
  37   \IT{\OPn{\VAR{foo}}; \Goos{\VAR{foo}}}
  38   {
  39   Zero or more \VAR{foo}s.
  40   }
  41
  42   \IT{\RP{\VAR{foo}}; \Goop{\VAR{foo}}}
  43   {
  44   One or more \VAR{foo}s.
  45   }
  46
  47   \IT{\VAR{foos}\qquad\qquad\qquad}
  48   {
  49   English plural denotes a list argument.
  50   }
  51
  52   \IT{\Goo{\VAR{foo}\XOR\VAR{bar}\XOR\VAR{baz}};
  53     \xorGOO{
  54       \VAR{foo}\\
  55       \VAR{bar}\\
  56       \VAR{baz}%
  57     }{.}}
  58   {
  59   Either \VAR{foo}, or \VAR{bar}, or \VAR{baz}.
  60   }
  61
  62   \IT{\orGOO{
  63       \VAR{foo}\\
  64       \VAR{bar}\\
  65       \VAR{baz}
  66     }{.}}
  67   {
  68   Anything from none to each of \VAR{foo}, \VAR{bar}, and \VAR{baz}.
  69   }
  70
  71   \IT{\NEV{\VAR{foo}}\qquad\qquad\qquad}
  72   {
  73   Argument \VAR{foo} is not evaluated.
  74   }
  75
  76   \IT{\DES{\VAR{bar}}\qquad\qquad\qquad}
  77   {
  78   Argument \VAR{bar} is possibly modified.
  79   }
  80
  81   \IT{\PROGN{\VAR{foo}}\qquad\qquad\qquad}
  82   {
  83   \OPn{\VAR{foo}} is evaluated as in \SO{progn}; see page \pageref{:progn}.
  84   }
  85
  86   \IT{\retval{\VAR{foo}}; \retvalii{\VAR{bar}};
  87     \retvaln{\VAR{n}}{\VAR{baz}}}
  88   {
  89   Primary, secondary, and \VAR{n}th return value.
  90   }
  91
  92   \IT{\T; \NIL\qquad\qquad\qquad}
  93   {
  94   \kwd*{T}, or truth in general; and \kwd*{NIL} or \kwd{()}.
  95   }
  96
  97 \end{LIST}
  98
  99 %%% Local Variables:
 100 %%% mode: latex
 101 %%% TeX-master: "clqr"
 102 %%% End: