clqr-typographic-conventions.tex

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