]> CyberLeo.Net >> Repos - FreeBSD/releng/9.2.git/blob - contrib/groff/contrib/mom/momdoc/reserved.html
- Copy stable/9 to releng/9.2 as part of the 9.2-RELEASE cycle.
[FreeBSD/releng/9.2.git] / contrib / groff / contrib / mom / momdoc / reserved.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <html>
3 <head>
4 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
5 <title>Mom -- List of reserved words</title>
6 </head>
7 <body bgcolor="#dfdfdf">
8
9 <!====================================================================>
10
11 <a href="appendices.html#TOP">Prev</a>&nbsp;&nbsp; <a href="toc.html">Back to Table of Contents</a>
12 <p>
13
14 <a name="TOP"></a>
15 <a name="RESERVED">
16 <h1 align="center"><u>LIST OF RESERVED WORDS</u></h1>
17 </a>
18 <p> The following is a list of &quot;reserved&quot; words used by
19 <strong>mom</strong>.  Before changing the name of any macro or
20 document element tag with
21 <a href="goodies.html#ALIAS">ALIAS</a>,
22 I strongly recommend doing a search of this page for your proposed
23 new name.  If you find it in the left hand column, DON'T USE IT.
24 Choose something else instead.
25 <p>
26 Anyone interested in playing around inside <strong>mom</strong>'s macro
27 file (om.tmac) will find this list useful as well since it lists all
28 (I hope) the macros, strings, diversions and number registers
29 <strong>mom</strong> uses, along with brief descriptions of their
30 functions.
31 <p>
32 <pre>
33 TYPESETTING
34 ===========
35
36 +++MACROS+++
37
38 Page layout
39 -----------
40 PAGELENGTH  Page width
41 PAGE        Page width/length; left, right, top, bottom margins
42 PAGEWIDTH   Page width
43 PAPER       Letter, legal, or A4
44
45 B_MARGIN  Space to leave at page bottom
46 L_MARGIN  Page offset
47 R_MARGIN  Line length as a function of
48           pagewidth minus pageoffset minus rightmargin
49 T_MARGIN  Advance lead from page top
50
51 Page control
52 ------------
53 DO_B_MARGIN  Margin at bottom of page; trap-invoked
54 DO_T_MARGIN  Margin at top of page; trap-invoked
55
56 Style
57 -----
58 COLOR          Change color of text to predefined value
59 CONDENSE       Set percentage of pseudo-condense (alias of
60                CONDENSE_OR_EXTEND)
61 EXTEND         Set percentage of pseudo-extend (alias of
62                CONDENSE_OR_EXTEND)
63 FAMILY         Family
64 FT             Font
65 FALLBACK_FONT  Font to use whenever FAMILY or FT errors occur
66 LL             Line length
67 LS             Leading (.vs)
68 NEWCOLOR       Define a text color
69 PT_SIZE        Point size
70 SETBOLDER      Set degree of emboldening (pseudo-bold) in units
71 SETSLANT       Set degree of pseudo-italic
72 XCOLOR         Initialize a color from rgb.txt
73
74 Autolead
75 --------
76 AUTOLEAD  Always lead n points more than .PT_SIZE
77
78 Flush
79 -----
80 JUSTIFY  Justified text
81 QUAD     Filled text, left, right, or centre
82
83 Quad
84 ----
85 CENTER  Non-filled text, centre
86 LEFT    Non-filled text, left
87 RIGHT   Non-filled text, right
88
89 Hyphenation
90 -----------
91 HY      Turn hyphenation on/off, or set LINES, MARGIN, SPACE
92 HY_SET  Set LINES, MARGIN, SPACE in a single command
93
94 Advanced style
95 --------------
96 KERN       Turn automatic kerning on or off
97 LIGATURES  Turn ligatures on or off
98 SS         Sentence space control
99 WS         Word space control
100
101 Line breaks
102 -----------
103 BR      Alias of br
104 EL      Breaks line but doesn't advance
105 SPACE   Alias of sp
106 SPREAD  Alias of brp
107
108 Ald/rld
109 -------
110 ALD  Advance lead
111 RLD  Reverse lead
112
113 Indents
114 -------
115 HI   Indent hang
116 IB   Indent both
117 IBX  Indent both off
118 IL   Indent left
119 ILX  Indent left off
120 IQ   Indents off
121 IR   Indent right
122 IRX  Indent right off
123 IX   Indents off -- deprecated
124 TI   Indent temporary
125
126 Tabs
127 ----
128 ST       String tab
129 TAB_SET  Tab Set
130 TN       Tab Next
131 TQ       Tab Quit
132
133 MCO      Turn on multi-column mode
134 MCR      Return to top of column
135 MCX      Turn off multi-column mode
136
137 Underscore
138 ----------
139 UNDERSCORE   Underscores words or phrases
140 UNDERSCORE2  Double underscores words or phrases
141
142 Underline
143 ---------
144 UNDERLINE  Underlines whole passages (Courier only)
145
146 Smart Quotes
147 ------------
148 SMARTQUOTES  Turns smart quotes on or off
149
150 Misc + Support
151 --------------
152 BR_AT_LINE_KERN  Deposit a break before RW and WE
153 CAPS             Convert u/lc to UC
154 COMMENT          Don't print lines till COMMENT OFF (alias of SILENT)
155 DROPCAP_ADJUST   Points (poss. fractional) to add/subtract
156                  from drop caps
157 DROPCAP          Create drop cap
158 DROPCAP_FAMILY   Drop cap family
159 DROPCAP_FONT     Drop cap font
160 DROPCAP_GUTTER   Drop cap gutter
161 DROPCAP_OFF      Support only; restores .in if there was one
162 ESC_CHAR         Alias for .ec
163 EW               Extra white -- loosen overall line kern
164                  (character spacing)
165 LEADER_CHARACTER Sets leader character
166 PAD              Insert padding spaces at marked places
167 PADMARKER        Sets character to use instead of # in PAD
168 PRINT            Simply prints args passed to it; keeps my code
169                  indented nicely
170 RW               Reduce white -- tighten overall line kern
171                  (character spacing)
172 SILENT           Don't print lines till SILENT OFF
173 SIZESPECS        Get cap-height, x-height and descender depth for
174                  current point size
175 TRAP             Turn traps off or on
176
177 +++DIVERSIONS+++
178
179 NO_FLASH    Diverts output of SILENT or COMMENT so they don't print
180 NULL        Diverts SIZESPECS in PRINT_HDRFTR so it doesn't screw up
181             FOOTER and FOOTNOTE processing when FOOTERS are on
182 PAD_STRING  Diverts $PAD_STRING for processing
183 TYPESIZE    Diverts SIZESPECS routine so it doesn't print
184
185 +++NUMBER REGISTERS+++
186
187 #ABORT_FT_ERRORS        Abort on FT errors? (toggle)
188 #ALD                    ALD value
189 #ARGS_TO_LIST           Tells LIST whether LIST was invoked with a legal
190                         arg; controls LIST OFF processing
191 #ARGS_TO_SQ             Tells SMARTQUOTES whether it was invoked with a
192                         legal arg; controls SMARTQUOTES OFF
193                         processing
194 #AUTOLEAD_FACTOR        Using FACTOR arg to AUTOLEAD? (toggle)
195 #AUTO_LEAD              Using autolead? (toggle)
196 #AUTO_LEAD_VALUE        Auto leading value
197 #BL_INDENT              Value of left indent when IB
198 #B_MARGIN               Bottom margin
199 #BOLDER_UNITS           # of units to embolden type
200 #BR_INDENT              Value of right indent when IB
201 c                       column mark
202 #CONDENSE               Are we in pseudo-condense mode? (toggle)
203 #CONDENSE_WAS_ON        For restoring \*[COND] in DROPCAP
204 #COND_WIDTH             Width of pseudo-condensed type
205                         (pointsize x $COND_PERCENT)
206 #CURRENT_L_LENGTH       Current line length at first invocation of LIST;
207                         like #ORIG_L_LENGTH
208 #CURRENT_TAB            Current tab number
209 #DC_GUT                 Width of dropcap gutter
210 #DEGREES                # of degrees slant for pseudo-italic
211 #ENUMERATOR&lt;n&gt;          Number register enumerator for depth &lt;n&gt; in lists 
212 #EXT_WIDTH              Width of pseudo-extended type
213                         (pointsize x $EXT_PERCENT)
214 #EXTEND                 Are we in pseudo-extend mode? (toggle)
215 #EXTEND_WAS_ON          For restoring \*[EXT] in DROPCAP
216 #FILL_MODE              Are we in fill mode (i.e. \n(.u=1)? (toggle)
217 #H_INDENT               Value of left indent when IH
218 #HL_INDENT              Value of the hang when IH
219 #HYPHENATE              Hyphenation on? (toggle)
220 #HY_SET                 Did we manually set hyphenation parameters?
221                         (toggle)
222 #IN_TAB                 Are we in a tab? (toggle)
223                         Set in macro TAB; used in ST to determine
224                         whether to add #ST_OFFSET to #ST&lt;#&gt;_OFFSET
225 #INDENT_ACTIVE          Indicates whether an indent is active (toggle)
226 #INDENT_BOTH_ACTIVE     Toggle
227 #INDENT_LEFT_ACTIVE     Toggle
228 #INDENT_RIGHT_ACTIVE    Toggle
229 #INDENT_STYLE_BOTH      Indicates IB when #INDENT_ACTIVE=1 (toggle)
230 #INDENT_STYLE_HANG      Indicates IH when #INDENT_ACTIVE=1 (toggle)
231 #INDENT_STYLE_LEFT      Indicates IL when #INDENT_ACTIVE=1 (toggle)
232 #INDENT_STYLE_RIGHT     Indicates IR when #INDENT_ACTIVE=1 (toggle)
233 #INDENT_STYLE_TEMP      Indicates IT when #INDENT_ACTIVE=1 (toggle)
234 #IX_WARN                Toggles to 1 the first time IX is user-invoked
235 #JUSTIFY                In EW/RW, when BR_AT_LINE_KERN, whether to
236                         break or break-spread preceding line (toggle)
237 #KERN                   Kern on? (toggle)
238 #LAST_TAB               Last tab number set in multi-columns
239 #LEAD                   Leading (alias)
240 #LIGATURES              Ligatures on? (toggle)
241 #LIST_INDENT&lt;n&gt;         Left indent of list &lt;n&gt;
242 #L_INDENT               Value of left indent
243 #L_LENGTH               Line length
244 #L_MARGIN               Page offset if set with LMARGIN;
245                         if .po used, \n(.o returns page offset
246 #LOOP                   #LOOP=1 if a while loop executes; otherwise 0.
247 #NEXT_DEPTH_BACK        Next list level back in lists
248 #NEXT_TAB               Current tab number + 1 (used in TN)
249 #NEXT_TAB               Next tab in an n+1 sequence
250 #OLD_LEAD               Lead in effect prior to changing it with .vs
251                         in .LS
252 #OPEN_CLOSE             Manipulates character " to print `` or ''
253 #ORIGINAL_L_LENGTH      Used in LIST for IB processing; holds \n(.l
254 p                       Output line horiz position at end of
255                         $PAD_STRING
256 #PAD_COUNT              Number of times # was included in arg to PAD
257 #PAD_LIST_DIGITS        Pad list digits to the left? (toggle)
258 #PAD_SPACE              Size of padding space
259 #PAGE_LENGTH            Page length (alias)
260 #PAGE_WIDTH             Page width
261 #PP_ACTIVE              Are we in the context of a para? (toggle)
262 #PRINT_FOOTER_ON_PAGE_1 (toggle)
263 #PSEUDO_FILL            Signals that LEFT, RIGHT or CENTER is
264                         in effect (toggled off, i.e. to 0, when
265                         QUAD <arg> or JUSTIFY is called)
266 #PT_SIZE                Point size (fractional) in units (alias)
267 #Q_AT_TOP               Does a quote start at the top of a new page?
268                         (toggle)
269 #QUAD                   In autoquad mode? (toggle)
270 #QUIT                   Tells LIST whether to exit lists completely
271                         (toggle)
272 #REMOVE                 Used in LIST OFF cleanup
273 #RESTORE_LEAD           Lead value in effect prior to AUTOLEAD
274 #RESTORE_LINE_LENGTH    Restores actual line length in RULE
275 #RESTORE_LN_NUMBER      Start linenumbering again with stored
276                         #NEXT_LN? (toggle)
277 #RESTORE_PT_SIZE        Stores current point size (in units) prior
278                         to underscore
279 #R_INDENT               Value of right indent
280 #R_MARGIN               Right margin
281 #RESTORE_PREV_INDENT    Tells LIST OFF what kind of indent was active
282                         prior to first invocation of LIST
283 #RLD                    RLD value
284 #SILENT                 Is silent on? (toggle)
285 #SIZE_FOR_PAD           Used to ensure that the size in effect prior
286                         to PAD is restored at the start of every
287                         iteration of $PAD_STRING
288 #SLANT_ON               Is SLANT on? (toggle)
289 #SMART_QUOTES           Smartquotes on? (toggle)
290 #SPACE_TO_END           Whitespace at end of string passed to PAD
291 #ST&lt;#&gt;_LENGTH           Length of ST&lt;#&gt;; calculated during ST &lt;#&gt;
292 #ST&lt;#&gt;_MARK             Page offset of autotab &lt;#&gt; at ST&lt;#&gt;X
293 #ST_NUM                 Incrementing counter for autotab identification
294 #ST_OFFSET              Offset (from current tab) to add to #ST&lt;#&gt;_OFFSET
295                         when calculating string indents set from within
296                         tabs
297 #ST&lt;#&gt;_OFFSET           Indent of autotab &lt;#&gt; (page offset)
298 #STORED_L_INDENT        Current left indent at first invocation of LIST
299 #STORED_R_INDENT        Current right indent at first invocation of LIST
300 #STORED_BL_INDENT       Current "both, left" indent at first invocation
301                         of LIST
302 #STORED_BR_INDENT       Current "both, right" indent at first invocation
303                         of LIST
304 #STORED_HL_INDENT       Current hanging indent at first invocation
305                         of LIST
306 #STORED_T_INDENT        Current temporary indent at first invocation
307                         of LIST
308 #T_INDENT               Value of temporary indent
309 #T_MARGIN               Top margin
310 #TAB_ACTIVE             Are we in a tab? (toggle)
311 #TAB_NUMBER             Tab number
312 #TAB_OFFSET             Tab indent
313 #TOP                    Set to 1 in T_MARGIN, DO_T_MARGIN and ALD; tells
314                         the first LS or AUTOLEAD on a page to maintain
315                         the baseline position prior to the LS call
316 #TOP_BASELINE_ADJ       Amount by which to adjust the baseline position
317                         of the first line on the page if an LS or AUTOLEAD
318                         request differs from the lead current at the end of
319                         the previous page
320 #TOTAL_LISTS            Total number of lists in a nest
321 #USER_SET_L_LENGTH      Did user invoke LL? (toggle)
322 #USER_SET_TITLE_ITEM    Did user invoke TOC_TITLE_ENTRY?
323 u                       Horiz position of start of underscore
324
325 +++STRINGS+++
326
327 $COND_PERCENT        Percentage by which to pseudo-condense type
328 $COLOR_SCHEME        Color scheme used in NEWCOLOR
329 $CURRENT_QUAD        Restores current quad value in RULE
330 $CURRENT_TAB         Current tab number
331 $DC_ADJUST           +|- # of points to subtract from dropcap
332 $DC_FAM              Drop cap family
333 $DC_FT               Drop cap font
334 $ENUMERATOR&lt;n&gt;       String enumerator for depth &lt;n&gt; in lists 
335 $EXT_PERCENT         Percentage by which to pseudo-extend type
336 $FAMILY              Family
337 $FAMILY_FOR_PAD      Used to ensure that the family in effect prior
338                      to PAD is restored at the start of every
339                      iteration of $PAD_STRING
340 $FONT                Font
341 $FONT_FOR_PAD        Used to ensure that the font in effect prior
342                      to PAD is restored at the start of every
343                      iteration of $PAD_STRING
344 $PAD_MARKER          Character to mark off padding in PAD
345 $PAD_STRING          Arg passed to PAD
346 $QUAD_VALUE          Quad value (left, right, centre, justify)
347 $QUOTE0              Open quotation marks
348 $QUOTE1              Close quotation marks
349 $RESTORE_COND        Restores the pseudo-condense value in effect
350                      prior to DROPCAP
351 $RESTORE_EXT         Restores the pseudo-extend value in effect
352                      prior to DROPCAP
353 $RESTORE_FAM         Used to restore the family in effect
354                      prior to DROPCAP
355 $RESTORE_FT          Used to restore the font/fontstyle in effect
356                      prior to DROPCAP
357 $RESTORE_PT_SIZE     Used to restore the point size of normal
358                      running text after a dropcap
359 $RESTORE_QUAD_VALUE  Quad value for use in restoring L, R, C, J
360                      (after tabs)
361 $SAVED_STYLE         Current style, if there is one (used in FAMILY)
362 $SEPARATOR&lt;n&gt;        Separator for depth &lt;n&gt; in lists
363 $SS_VAR              Holds + or - sentence space value
364 $ST&lt;#&gt;_FILL          Always QUAD if QUAD passed to ST &lt;#&gt;
365 $ST&lt;#&gt;_QUAD_DIR      Quad direction supplied to ST for &lt;#&gt;
366 $TAB_NUMBER          Argument passed to TAB macro to call TAB# macro
367                      created in TAB_SET
368 $WS_CONSTANT         12; used to hold groff default wordspace
369 $WS                  Holds WS value; concatenation of WS_CONSTANT and
370                      WS_VAR
371 $WS_VAR              + or - value to add to $WS_CONSTANT
372 BLACK                Pre-defined black color
373 black                Pre-defined black color
374 WHITE                Pre-defined white color
375 white                Pre-defined white color
376
377 +++ALIASES+++
378
379 ALIAS         als
380 ALIASN        aln
381 BR            br
382 CENTRE        CENTER
383 COLOUR        COLOR
384 COMMENT       SILENT
385 CONDENSE      CONDENSE_OR_EXTEND
386 EXTEND        CONDENSE_OR_EXTEND
387 FAM           FAMILY
388 FT            FONT
389 HYPHENATE     HY
390 HYPHENATION   HY
391 LIG           LIGATURES
392 LL            LINE_LENGTH
393 MAC           de
394 NEW_PAGE      bp
395 NEWCOLOUR     NEWCOLOR
396 NEWPAGE       NEW_PAGE
397 PAGELENGTH    PAGE_LENGTH
398 PAGE_LENGTH   pl
399 PAGEWIDTH     PAGE_WIDTH
400 SPREAD        brp
401 SP            sp
402 STRING        ds
403 TABSET        TAB_SET
404 TB            TAB
405 TI            IT
406 UNDERSCORE_2  UNDERSCORE2
407 XCOLOUR       XCOLOR
408
409 +++ALIASES FOR NUMBER REGISTERS+++
410
411 #DIVER_DEPTH    dn   -- diversion depth
412 #DIVER_WIDTH    dl   -- diversion width
413 #INDENT         .i   -- value of current indent
414 #LEAD           .v   -- line space (.vs, not .ls)
415 #L_LENGTH       .l   -- line length
416 #NUM_ARGS       .$   -- number of arguments passed to a macro
417 #PAGE_LENGTH    .p   -- page length
418 #PT_SIZE        .ps  -- current point size (fractional) in units
419 #TRAP_DISTANCE  .t   -- distance to next trap
420
421 +++INLINE ESCAPES+++
422
423 BCK          Inline backward horizontal movement
424 BOLDER       Pseudo-bold on
425 BOLDERX      Pseudo-bold off
426 BP           Back points (horizontal movement)
427 BU           Back units (inline pairwise kerning)
428 COND_FOR_SUP Pseudo-condense string for use with superscripts
429              (called with CONDSUP)
430 COND_FOR_SUP Pseudo-extend string for use with superscripts (called
431              with EXTSUP)
432 COND         Pseudo-condense type
433 CONDX        Pseudo-condense off
434 CONDSUP      Pseudo-condensed superscript (using value set with
435              CONDENSE)
436 CONDSUPX     Pseudo-condensed superscript off
437 DOWN         Inline downward vertical movement
438 EXT          Pseudo-extend type
439 EXTX         Pseudo-extend off
440 EXTSUP       Pseudo-extended superscript
441 EXTSUPX      Pseudo-extended superscript off
442 FP           Forward points (horizontal movement)
443 FU           Forward units (inline pairwise kerning)
444 FWD          Inline forward horizontal movement
445 LEADER       Deposit leader to end of current LL or TAB
446 RULE         Draw a rule to the full measure of the current line or
447              tab length
448 SLANT        Slant (pseudo-italic on
449 SLANTX       Slant off
450 ST&lt;#&gt;        String tab end marker
451 ST&lt;#&gt;        String tab start marker
452 SUP          Superscript
453 SUPX         Superscript off
454 UP           Inline upward vertical movement
455
456 +++SPECIAL CHARACTERS+++
457
458 FEET         The foot character \(fm
459 INCH         The inch character \(fm\(fm
460
461 ------------------------------------------------------------------------
462
463 DOCUMENT PROCESSING
464 ===================
465
466 +++MACROS+++
467
468 Document info
469 -------------
470 AUTHOR          Author
471 CHAPTER         Chapter number
472 CHAPTER_TITLE   Chapter title
473 COPYRIGHT       Copyright info (covers only)
474 DOCTITLE        Overall doc title (for collated docs)
475 DRAFT           Draft number
476 MISC            Misc info (covers only)
477 REVISION        Revision number
478 SUBTITLE        Doc subtitle
479 TITLE           Doc title
480
481 Covers
482 ------
483 COVER               What goes on cover
484 COVERS              Whether covers get printed (toggle)
485 COVER_ADVANCE       Set vertical start position of cover material
486 COVER_LEAD          Overall leading of covers
487 COVERTITLE          User-defined cover title string
488 DOC_COVER           What goes on doc cover
489 DOC_COVERS          Whether doc covers get printed
490 DOC_COVER_ADVANCE   Set vertical start position of doc cover material
491 DOC_COVER_LEAD      Overall leading of doc covers
492 DOC_COVERTITLE      User-defined doc cover title string
493
494 Document style
495 --------------
496 COPYSTYLE     Output style (DRAFT or FINAL)
497 DEFAULTS      In START, sets defaults
498 DOCTYPE       Kind of doc (DEFAULT, CHAPTER, NAMED, LETTER)
499 PAGENUMBER    Page number that appears on 1st page of doc
500 PAPER         Paper size (LETTER, LEGAL, A4)
501 PRINTSTYLE    Print style (TYPEWRITE or TYPESET)
502 NUMBER_LINES  Number output lines in the left margin
503
504 Document tags and macros
505 ------------------------
506 ADD_SPACE               Special macro to add space to the top of a pages after
507                         page 1; must be preceded by NEWPAGE
508 BIBLIOGRAPHY            Begin a bibliography page
509 BIBLIOGRAPHY_TYPE       LIST or PLAIN
510 BLOCKQUOTE              Block-indented, quoted text
511 COL_BREAK               Breaks and spreads line before invocation; moves to
512                         next column on page or 1st col of next page.  An alias
513                         of COL_NEXT.
514 COL_NEXT                Moves to next column on page or 1st col of next page
515 ENDNOTE                 Endnote
516 ENDNOTE_REFS            Send REFs to endnotes
517 ENDNOTES                Output endnotes
518 EPIGRAPH                Epigraph before 1st para 
519 FINIS                   Prints --END--
520 FOOTNOTE                Collects footnotes in text for printing at bottom of page
521 FOOTNOTE_REFS           Send REFs to footnotes
522 HEAD                    Section title (main heads)
523 HYPHENATE_REFS          Turn on/off hyphenation of REF references
524 ITEM                    Begin a list item
525 LINEBREAK               Break between narrative sections
526 LIST                    Initialize a list
527 MN                      Margin note
528 MN_INIT                 Initialize parameters for margin notes
529 NUMBER_LINES            Number text lines
530 NUMBER_BLOCKQUOTE_LINES Number blockquote lines
531 NUMBER_QUOTE_LINES      Number quote lines
532 PAD_LIST_DIGITS         Leave space for two-numeral digit enumerators
533                         in a list
534 PARAHEAD                Paragraph head
535 PP                      Paragraph
536 QUOTE                   Poetic or line for line quotes
537 REF                     Wrapper around FOOTNOTE or ENDNOTE, depending
538                         on FOOTNOTE_REFS or ENDNOTE_REFS
539 REF(                    Begin embedded reference, parens
540 REF)                    End embedded reference, parens
541 REF[                    Begin embedded reference, square brackets
542 REF]                    End embedded reference, square brackets
543 REF{                    Begin embedded reference, braces
544 REF}                    End embedded reference, braces
545 REF_INDENT              Amount of 2nd line indent of references for
546                         footnote, endnote or bibliography refs
547 RESET_LIST              Reset digit or alpha list enumerator
548 SHIFT_LIST              Move a list over to the right
549 START                   Sets doc defaults and prints info collected
550                         with doc info macros
551 SUBHEAD                 Subheads
552
553 Headers/footers
554 ---------------
555 BREAK_QUOTE          Manually break a footnoted quote that crosses
556                      a page/column
557 DO_FOOTER            Prints footer (after footnote processing, if any)
558 FOOTER_ON_FIRST_PAGE Print footer on first page? (toggle)
559 FOOTER               Trap-invoked footer macro
560 HEADER               Trap-invoked header macro
561 PAGINATE             Turns page numbering on or off (doc default=on)
562 PAGINATE_TOC         Turns pagination of toc on or off (default=on)
563 RECTO_VERSO          Enables switch HEADER_LEFT and HEADER_RIGHT on
564                      alternate pages
565
566 Alter doc "look" and/or change defaults
567 ---------------------------------------
568 ***General***
569
570 ALWAYS_FULLSPACE_QUOTES  Fullspace quotes instead of default
571                          1/2 spacing them.
572 ATTRIBUTE_STRING         What to print before author (default is "by")
573 CHAPTER_STRING           What to print whenever the word "chapter"
574                          is required
575 COLUMNS                  Print in columns
576 DOC_FAMILY               Overall doc family
577 DOCHEADER                Print doc header?
578 DOCHEADER_ADVANCE        Start position of docheader (relative to top
579                          of page)
580 DOCHEADER_LEAD           +|- value applied to #DOC_LEAD to in/decrease
581                          leading of doc header
582 DOC_LEAD_ADJUST          Adjust #DOC_LEAD to fill page to #B_MARGIN
583 DOC_LEAD                 Overall doc leading
584 DOC_LEFT_MARGIN          Doc left margin
585 DOC_LINE_LENGTH          Doc line length
586 DOC_PT_SIZE              Overall doc point size
587 DOC_RIGHT_MARGIN         Doc right margin
588 DOC_TITLE                Overall doc title that gets printed in
589                          headers/footers (mostly for use with collated
590                          docs where each doc is an article with a
591                          different title
592 DRAFT_STRING             What to print whenever the word "draft" is
593                          required
594 DRAFT_WITH_PAGENUMBER    Attach draft/revision info to page number
595                          (instead of putting it HEADER centre)
596 REVISION_STRING          What to print whenever the word "revision"
597                          is required
598
599 ***Covers***
600
601 COVER_ADVANCE            Vertical place on page to start outputting
602                          cover material
603 COVER_LEAD               Lead in/decrease for cover pages
604 DOC_COVER_ADVANCE        Vertical place on page to start outputting
605                          doc cover material
606 DOC_COVER_LEAD           Lead in/decrease for doc cover pages
607
608 ***Epigraphs and finis***
609
610 EPIGRAPH_AUTOLEAD        Autolead value for epigraphs
611 EPIGRAPH_INDENT          Value by which to multiply PP_INDENT for
612                          block epigraphs
613 FINIS_STRING             What to print when FINIS is invoked
614
615 ***Footnotes***
616
617 FOOTNOTE_AUTOLEAD             Autolead to use in footnotes
618 FOOTNOTE_LINENUMBER_BRACKETS  Brackets for footnote linenumbers
619 FOOTNOTE_LINENUMBER_SEPARATOR Separator for footnote linenumbers
620 FOOTNOTE_MARKERS              Turns footnote markers on or off
621 FOOTNOTE_MARKER_STYLE         STAR or NUMBER; default=STAR
622 FOOTNOTE_RULE_ADJ             # of points to raise footnote rule from its
623                               baseline
624 FOOTNOTE_RULE_LENGTH          Length of footnote separator rule
625 FOOTNOTE_RULE                 Turns printing of fn separator rule on or off;
626                               default is on
627 FOOTNOTE_SPACING              Post footnote item spacing
628 FOOTNOTES_RUN_ON              Run footnotes on (line numbering mode only)
629 RESET_FOOTNOTE_NUMBER         Reset fn# to 1, or, if arg PAGE, reset
630                               automatically to 1 on every page
631 RUNON_WARNING                 Utility macro; warns if FOOTNOTES_RUN_ON
632                               was called when fn marker style is STAR or NUMBER
633
634 ***Endnotes***
635
636 ENDNOTE_LEAD                 Leading for endnotes page
637 ENDNOTE_LINENUMBER_BRACKETS  Brackets around line numbers identifying
638                              endnotes and text
639 ENDNOTE_LINENUMBER_GAP       Amount of space to leave between line
640 ENDNOTE_LINENUMBER_SEPARATOR Separator between line numbers identifying
641                              endnotes and the endnote item text
642                              endnotes and text
643 ENDNOTE_MARKER_STYLE         NUMBER or LINE
644 ENDNOTE_NUMBERS_ALIGN_RIGHT  Hang endnote numbers and align right
645 ENDNOTE_NUMBERS_ALIGN_LEFT   Don't hang endnote numbers and align left
646 ENDNOTE_PARA_INDENT          First line indent of paras in multi-para
647                              endnotes
648 ENDNOTE_PARA_SPACE           Whether to space paras in multi-para endnotes
649 ENDNOTE_PT_SIZE              Base point size for endnotes page
650 ENDNOTE_STRING               Endnotes page head
651 ENDNOTE_STRING_CAPS          Capitalize the endnotes string
652 ENDNOTE_STRING_UNDERSCORE    Underscoring of endnotes page head
653 ENDNOTE_TITLE                Endnotes identifying title
654 ENDNOTE_TITLE_SPACE          Distance from top of page to endnotest title
655 ENDNOTE_TITLE_UNDERSCORE     Underscoring of endnotes identifying title
656 ENDNOTES_ALLOWS_HEADERS      Page headers on endnotes pages? (toggle)
657 ENDNOTES_FIRST_PAGENUMBER    Page number to appear on page 1 of endnotes
658                              pages
659 ENDNOTES_HDRFTR_CENTER       Print header/footer centre string on endnotes
660                              pages?
661 ENDNOTES_HEADER_CENTER       Print header centre string on endnotes pages?
662 ENDNOTES_FOOTER_CENTER       Print footer centre string on endnotes pages?
663 ENDNOTES_NO_COLUMNS          Turn columnar mode off for endnotes pages
664 ENDNOTES_NO_FIRST_PAGENUM    Don't print a pagenumber on page 1 of
665                              endnotes.
666 ENDNOTES_PAGENUM_STYLE       Set numbering style for endnotes pages page
667                              numbers
668 SINGLESPACE_ENDNOTES         Single space TYPEWRITE endnotes
669
670 ***Bibliographies***
671
672 BIBLIOGRAPHY_ALLOWS_HEADERS    Allow headers on bib pages
673 BIBLIOGRAPHY_FIRST_PAGENUMBER  Starting page number for bibliographies
674 BIBLIOGRAPHY_HDRFTR_CENTER     Header/footer center string for bib pages
675 BIBLIOGRAPHY_LEAD              Base lead of bib pages
676 BIBLIOGRAPHY_NO_COLUMNS        De-columnize bibliographies
677 BIBLIOGRAPHY_NO_FIRST_PAGENUM  Don't print a page number on the first
678                                page of bibliographies
679 BIBLIOGRAPHY_PAGENUM_STYLE     Format for bib pages page numbering
680 BIBLIOGRAPHY_PT_SIZE           Base point size for bib pages
681 BIBLIOGRAPHY_SPACING           Post bib entry space
682 BIBLIOGRAPHY_STRING            String for bib title
683 BIBLIOGRAPHY_STRING_CAPS       Capitalize bib title string
684 BIBLIOGRAPHY_STRING_UNDERSCORE Underscore bib title string
685 SINGLESPACE_BIBLIOGRAPHY       Singlespace bibs if PRINTSTYLE TYPEWRITE
686
687 ***Headers and footers***
688
689 FOOTER_COLOR             Footer color
690 FOOTER_GAP               Distance between running text and footer
691 FOOTER_MARGIN            Distance from footer to bottom of page
692 FOOTERS                  Turns footers on or off
693 HDRFTR_CENTER            String to go in centre part of header/footer;
694                          default doctype 
695 HDRFTR_CENTER_CAPS       Centre part of header/footer in caps? (toggle)
696 HDRFTR_CENTER_PAD        Pad hdrftr CENTER left or right by specified
697                          amount
698 HDRFTR_GAP               Distance from header/footer to running text
699 HDRFTR_LEFT_CAPS         Left part of header/footer in caps? (toggle)
700 HDRFTR_LEFT              String to go in left part of header/footer;
701                          default is AUTHOR_1
702 HDRFTR_LEFT              The header/footer left string
703 HDRFTR_MARGIN            Distance from top of page to header
704 HDRFTR_PLAIN             Header/footer fam/ft/ps all same as running
705                          text
706 HDRFTR_RECTO             User-defined, single string recto
707                          header/footer
708 HDRFTR_RIGHT_CAPS        Right part of header/footer in caps? (toggle)
709 HDRFTR_RIGHT             The header/footer right string
710 HDRFTR_RULE_GAP          Space between header/footer and header/footer
711                          rule
712 HDRFTR_RULE_INTERNAL     Prints the header/footer rule
713 HDRFTR_RULE              Turns header/footer rule on or off
714                          When invoked internally, prints the rule.
715 HDRFTR_VERSO             User-defined, single string verso
716                          header/footer
717 HEADERS                  Turns headers on or off
718 SWITCH_HDRFTR            Switch HDRFTR_LEFT and HDRFTR_RIGHT
719
720 ***Page numbering***
721
722 PAGENUM_HYPHENS          Turns on/off hyphens surrounding page numbers
723 PAGENUM_ON_FIRST_PAGE    Print page number on first page when footers
724                          are on (toggle)
725 PAGENUM_POS              Controls placement of page numbers;
726                          default=bottom/centred
727 PAGENUM_SIZE             How much to in/decrease point size of page
728                          numbers*
729 PAGENUM_STYLE            Page # in roman, Arabic, or alphabetic
730 RESTORE_PAGINATION       Restore pagination after outputting non-
731                          paginated endnotes.
732 SUSPEND_PAGINATION       Suspend pagination prior to outputting
733                          endnotes
734
735 ***Heads***
736
737 HEADER_GAP               Space between header and running text
738 HEADER_MARGIN            Space from top of page to header
739 HEAD_CAPS                Print section titles in caps? (toggle)
740 HEAD_SPACE               Give HEADs 2 line-spaces before. If OFF,
741                          only 1.  Default is on.
742 HEAD_UNDERLINE           Underline section titles? (toggle)
743 NUMBER_HEADS             Print head numbers
744 RESET_HEAD_NUMBER        Reset head number
745
746 ***Subheads***
747
748 NUMBER_SUBHEADS          Print subhead numbers
749 RESET_SUBHEAD_NUMBER     Reset subhead number
750
751 ***Para heads***
752
753 NUMBER_PARAHEADS         Print parahead numbers
754 PARAHEAD_INDENT          How much to indent paraheads
755 RESET_PARAHEAD_NUMBER    Reset parahead number
756
757 ***Paragraphs***
758
759 INDENT_FIRST_PARAS       Indent 1st paras? (doc default=not indented) 
760 PARA_INDENT              Size of para indent
761 PARA_SPACE               Put a line space before paras
762 PP_FONT                  Overall doc font
763
764 ***Quotes***
765
766 Q_FITS                  Utility macro for DO_QUOTE
767 Q_NOFIT                 Utility macro for DO_QUOTE
768 QUOTE_AUTOLEAD          Leading of (block)quotes
769
770 ***Line/section breaks***
771
772 LINEBREAK_CHAR           Linebreak character, iterations and positioning
773
774 ***Printstyle TYPEWRITE***
775
776 ITALIC_MEANS_ITALIC      For TYPEWRITE; render .FT I in italic.
777 SLANT_MEANS_SLANT        In TYPEWRITE, render \*[SLANT] as slant
778 UNDERLINE_ITALIC         In TYPEWRITE, render .FT I as underlined
779 UNDERLINE_QUOTES         In TYPEWRITE, underline quotes? (toggle)
780 UNDERLINE_SLANT          In TYPEWRITE, render \*[SLANT] as underlined
781
782 ***Table of contents***
783
784 TOC_APPENDS_AUTHORS      Appends author(s) to toc doc title entries
785 TOC_LEAD                 Leading of toc pages
786 TOC_PADDING              Number of placeholders for toc entries page
787                          numbers
788 TOC_HEAD_INDENT          Indent of toc head entries
789 TOC_HEADER_STRING        TOC header string (default=Contents)
790 TOC_PAGENUM_STYLE        Page numbering style (hdrftr nums) of
791                          toc pages
792 TOC_RV_SWITCH            Switch L/R margins of toc pages
793 TOC_PARAHEAD_INDENT      Indent of toc parahead entries
794 TOC_SUBHEAD_INDENT       Indent of toc subhead entries
795 TOC_TITLE_ENTRY          User supplied toc doc title entry
796 TOC_TITLE_INDENT         Indent of toc doc title entries
797
798 ***Aliases for headers and footers***
799 HEADER_SIZE           HDRFTR_SIZE
800 HEADER_RIGHT_PS       HDRFTR_RIGHT_SIZE
801 HEADER_RIGHT_SIZE     HDRFTR_RIGHT_SIZE
802 HEADER_RIGHT_FAM      HDRFTR_RIGHT_FAMILY
803 HEADER_RIGHT_FAMILY   HDRFTR_RIGHT_FAMILY
804 HEADER_RIGHT_FONT     HDRFTR_RIGHT_FONT
805 HEADER_RIGHT_FT       HDRFTR_RIGHT_FONT
806 HEADER_LEFT_PS        HDRFTR_LEFT_SIZE
807 HEADER_LEFT_SIZE      HDRFTR_LEFT_SIZE
808 HEADER_LEFT_FAM       HDRFTR_LEFT_FAMILY
809 HEADER_LEFT_FAMILY    HDRFTR_LEFT_FAMILY
810 HEADER_LEFT_FONT      HDRFTR_LEFT_FONT
811 HEADER_LEFT_FT        HDRFTR_LEFT_FONT
812 HEADER_CENTRE_PS      HDRFTR_CENTER_SIZE
813 HEADER_CENTRE_SIZE    HDRFTR_CENTER_SIZE
814 HEADER_FAM            HDRFTR_FAMILY
815 HEADER_FAMILY         HDRFTR_FAMILY
816 HEADER_CENTRE_FAM     HDRFTR_CENTER_FAMILY
817 HEADER_CENTRE_FAMILY  HDRFTR_CENTER_FAMILY
818 HEADER_CENTRE_FONT    HDRFTR_CENTER_FONT
819 HEADER_CENTRE_FT      HDRFTR_CENTER_FONT
820 HEADER_CENTER_PS      HDRFTR_CENTER_SIZE
821 HEADER_CENTER_SIZE    HDRFTR_CENTER_SIZE
822 HEADER_CENTER_FAM     HDRFTR_CENTER_FAMILY
823 HEADER_CENTER_FAMILY  HDRFTR_CENTER_FAMILY
824 HEADER_CENTER_FONT    HDRFTR_CENTER_FONT
825 HEADER_CENTER_FT      HDRFTR_CENTER_FONT
826 FOOTER_SIZE           HDRFTR_SIZE
827 FOOTER_RIGHT_PS       HDRFTR_RIGHT_SIZE
828 FOOTER_RIGHT_SIZE     HDRFTR_RIGHT_SIZE
829 FOOTER_RIGHT_FAM      HDRFTR_RIGHT_FAMILY
830 FOOTER_RIGHT_FAMILY   HDRFTR_RIGHT_FAMILY
831 FOOTER_RIGHT_FONT     HDRFTR_RIGHT_FONT
832 FOOTER_RIGHT_FT       HDRFTR_RIGHT_FONT
833 FOOTER_LEFT_PS        HDRFTR_LEFT_SIZE
834 FOOTER_LEFT_SIZE      HDRFTR_LEFT_SIZE
835 FOOTER_LEFT_FAM       HDRFTR_LEFT_FAMILY
836 FOOTER_LEFT_FAMILY    HDRFTR_LEFT_FAMILY
837 FOOTER_LEFT_FONT      HDRFTR_LEFT_FONT
838 FOOTER_LEFT_FT        HDRFTR_LEFT_FONT
839 FOOTER_CENTRE_PS      HDRFTR_CENTER_SIZE
840 FOOTER_CENTRE_SIZE    HDRFTR_CENTER_SIZE
841 FOOTER_FAM            HDRFTR_FAMILY
842 FOOTER_FAMILY         HDRFTR_FAMILY
843 FOOTER_CENTRE_FAM     HDRFTR_CENTER_FAMILY
844 FOOTER_CENTRE_FAMILY  HDRFTR_CENTER_FAMILY
845 FOOTER_CENTRE_FT      HDRFTR_CENTER_FONT
846 FOOTER_CENTER_PS      HDRFTR_CENTER_SIZE
847 FOOTER_CENTER_SIZE    HDRFTR_CENTER_SIZE
848 FOOTER_CENTER_FAM     HDRFTR_CENTER_FAMILY
849 FOOTER_CENTER_FAMILY  HDRFTR_CENTER_FAMILY
850 FOOTER_CENTER_FONT    HDRFTR_CENTER_FONT
851 FOOTER_CENTER_FT      HDRFTR_CENTER_FONT
852
853    *relative to #DOC_PT_SIZE
854   **relative to overall ps of headers as set by HEADER_SIZE
855  ***relative to overall ps of endnotes pages
856 ****relative to overall ps of toc pages
857
858 +++LETTER MACROS+++
859
860 CLOSING      Closing (i.e. Yours truly,)
861 DATE         Date for letters
862 FROM         Addresser's name and address
863 GREETING     Full salutation (e.g. Dear John Smith,)
864 NO_SUITE     Remove suite page numbers from bottom of letter pages
865 TO           Addressee's name and address
866 ALL_DONE     .em (the "end macro") for letters
867
868 +++SUPPORT+++
869
870 CHECK_INDENT         Applies indents to doc elements inside ev's
871                      (head, subhead, etc)
872 CLEANUP_DEFAULTS     Removes selected rregisters and strings
873                      from DEFAULTS after START
874 DO_COVER             Formats and outputs covers
875 DO_DOC_COVER         Formats and outputs doc covers
876 D0_QUOTE             Outputs quotes with space adjustments before
877                      and after
878 DIVER_FN_1_PRE  -+     
879 DIVER_FN_2_PRE   |   Manage footnotes called inside diversions
880                  |   QUOTE, BLOCKQUOTE and EPIGRAPH
881 DIVER_FN_2_POST -+
882 DIVERT_FN_LEFTOVER   Diverts excess fn stored in FN_OVERFLOW into
883                      FOOTNOTE
884 DIVERT_FN_OVERFLOW   Diverts excess fn stored in FN_OVERFLOW when
885                      FN_DEFER into FOOTNOTE
886 DO_EPIGRAPH          Outputs epigraphs with space adjustments before
887                      and after
888 FN_OVERFLOW_TRAP     Fixed at B_MARGIN; if footnotes run longer than
889                      B_MARGIN, diverts excess into FN_OVERFLOW
890 GET_ROMAN_INDENT     Figures out amount of space to reserve
891                      for roman numerals in lists
892 HDRFTR_RULE          Prints rule under header or over footer
893 MN_OVERFLOW_TRAP     Trap-invoked macro to collect margin note
894                      overflows
895 PRINT_FOOTNOTE_RULE  An alias of PRINT_FOOTNOTE; prints footnote
896                      separator rule
897 PRINT_HDRFTR         Prints header/footer (trap invoked)
898 PRINT_PAGE_NUMBER    Invoked in HEADER or FOOTER
899 PRINT_USERDEF_HDRFTR Prints user defined, single string recto/verso
900                      header/footer
901 PROCESS_SHIM         Calculates #SHIM when \n(.d is lower on the
902                      page than #T_MARGIN
903 PROCESS_FN_IN_DIVER  Processes footnotes gathered in a diversion (called
904                      at page/column breaks)
905 REMOVE_INDENT        Removes indents set with CHECK_INDENT
906 Q_FITS               Handles spacing of quotes when quote fits on the page
907 Q_NOFIT              Handles spacing of quotes when quote does not fit on
908                      the page
909 QUIT_LISTS           Exit lists cleanly and completely
910 SET_LIST_INDENT      Restore indent of a prev. level of list
911 SHIM                 Advance to next "legal" baseline
912 TERMINATE            .em that ensures deferred footnotes get output
913                      on final pages
914 TRAPS                Sets hdrftr traps; optionally adjusts #DOC_LEAD
915                      to fill page to #B_MARGIN
916 TYPEWRITER           Sets family (C), font (R) and point size (12)
917                      for PRINTSTYLE TYPEWRITE
918 VFP_CHECK            Trap-sprung macro 1 legal baseline higher than
919                      where FOOTER will be sprung; checks whether
920                      there is, in fact, just enough room for
921                      another line of running text to be added to
922                      the page without jamming footnotes too close
923                      to running text.
924
925 +++DIVERSIONS+++
926
927 B_QUOTE           Block (indented) quote text
928 CLOSING           Closing (i.e. Yours truly,)
929 EPI_TEXT          Epigraph text
930 END_NOTES         Endnotes text
931 FN_IN_DIVER       Footnotes gathered from inside a diversion
932 FN_OVERFLOW       Excess footnotes when B_MARGIN is reached
933 FOOTNOTES         Text of footnotes
934 GREETING          Full salutation (e.g. Dear John Smith,)
935 LETTERHEAD&lt;n&gt;     Date, addresser, addressee or greeting;
936                   &lt;n&gt; is from 1 to 4, supplied by #FIELD
937 P_QUOTE           Line for line (poetic) quote text
938 RUNON_FOOTNOTES   Special diversion for run-on footnotes
939 RUNON_FN_IN_DIVER Special diversion for run-on footnotes inside
940                   (block)quotes
941 TOC_ENTRIES       TOC entries
942
943 +++NUMBER REGISTERS+++
944
945 #1ST_FN_VP_ADJ             An adjustment factor that ensures VFP
946                            doesn't fall below what should be the
947                            correct last printed line of running
948                            text
949 #ADD_BREAK                 Instructs FOOTNOTEs and ENDNOTEs to add
950                            a break afer processing a footnote if
951                            we're not in fill mode
952 #ADJ_BIB_LEAD              Adjust BIB_LEAD? (toggle)
953 #ADJ_DOC_LEAD              Adjust DOC_LEAD? (toggle)
954 #ADJ_TOC_LEAD              Adjust TOC_LEAD? (toggle)
955 #ARG_NUM                   Keeps track of number of args passed to a
956                            macro
957 #ARGS_TO_LIST              Was LIST passed some args? (toggle)
958 #AUTHOR_[n]                Strings passed to AUTHOR
959 #AUTHOR_LINES              # of lines of authors in doc header; odd=0
960                            even=1
961 #AUTHOR_NUM                Keeps track of user-defined string
962                            AUTHOR_&lt;#&gt; in AUTHOR
963 #AUTHORS                   Equals final value of AUTHOR_NUM;
964                            used for authors in doc header
965 #BASELINE_MARK             In PP, the vertical position on the page
966                            (when paragraph spacing is on) after a
967                            quote or blockquote has been output and
968                            the post-quote space has been added.
969 #BMARG                     Position of unvarying bottom margin
970                            during doc processing; required for
971                            collecting footnotes inside diversions
972 #BIB_ALLOWS_HEADERS        Put headers on bib pages? (toggle)
973 #BIB_ALLOWS_HEADERS_ALL    Put headers on all bib pages? (toggle)
974 #BIB_FIRST_PAGE            Tells PRINT_PAGE_NUMBER about bibliography
975                            first page number
976 #BIB_FIRST_PN              Starting pagenumber for bibliographies
977 #BIB_HDRFTR_CENTER         Put a center string in bib page headers?
978                            (toggle)
979 #BIB_LEAD                  Bibliography lead, expressed in points
980 #BIB_LIST                  Output bibs in list style? (toggle)
981 #BIB_NO_COLS               De-columnize bibliographies? (toggle)
982 #BIB_NO_FIRST_PN           Put a page number on the first page of
983                            bibliographies? (toggle)
984 #BIB_SINGLESPACE           Single-space TYPEWRITE bibliographies? (toggle)
985 #BIB_SPACE                 Post item space for bibliography pages
986 #BIB_STRING_CAPS           Capitalize bib title? (toggle)
987 #BIB_STRING_UNDERSCORE     Underscore bib title? 0=no; 1=yes; 2=double
988 #BIB_PS                    Base point size for bibliography pages expressed
989                            in points
990 #BIBLIOGRAPHY              Are we doing a bib page? (toggle)
991 #BQ_AUTOLEAD               Register created by BLOCKQUOTE_AUTOLEAD
992 #BQ_LEAD                   Leading of blockquotes
993 #BQUOTE_COLOR              Colored blockquotes? (toggle)
994 #BQUOTE_LN                 Number blockquotes? (toggle)
995 #BROKEN_QUOTE              Did we invoke BREAK_QUOTE? (toggle)
996 #CAP_HEIGHT_ADJUST         Tallest cap height of strings LEFT, CENTER,
997                            and RIGHT in footers; used to place rule
998                            over footer
999 #CAPS_WAS_ON               In HDRFTR, to re-enable running text CAPS
1000                            (toggle)
1001 #CENTER_CAP_HEIGHT         Cap height of CENTER string in
1002                            headers/footers
1003 #CHAPTER_TITLE_COLOR       Colored chapter title? (toggle)
1004 #CLOSING                   Is there a closing (for letters)? 1=yes
1005 #COL_L_LENGTH              Line length of columns
1006 #COL_NEXT                  Was COL_NEXT invoked? (toggle; used in
1007                            FOOTER)
1008 #COL_NUM                   Incrementing counter of num of columns;
1009                            for use with #COL_&lt;#&gt;_L_MARGIN
1010 #COL_TOTAL                 #COL_L_LENGTH + #GUTTER; used to calculate
1011                            #COL_&lt;#&gt;_L_MARGIN
1012 #COLLATED_DOC              If 1, instructs TOC that this is a collated
1013                            doc
1014 #COLUMNS                   Are columns turned on? (toggle)
1015 #COLUMNS_WERE_ON           Stores columnar state prior to outputting
1016                            endnotes in no-columns mode
1017 #COPY_STYLE                1=draft, 2=final
1018 #COUNTERS_RESET            Tells FOOTNOTE if fn counters have
1019                            been reset because of footnotes gathered
1020                            inside a diversion
1021 #COVER_COLOR               Colored cover? (toggle)
1022 #COVER_START_POS           Vertical starting pos of cover material
1023 #COVER_TITLE_COLOR         Colored cover title? (toggle)
1024 #COVER_SUBTITLE_COLOR      Colored cover subtitle? (toggle)
1025 #COVER_ATTRIBUTE_COLOR     Colored cover attribution string? (toggle)
1026 #COVER_AUTHOR_COLOR        Colored cover author(s)? (toggle)
1027 #COVER_DOCTYPE_COLOR       Colored cover doctype? (toggle)
1028 #COVER_COPYRIGHT_COLOR     Colored cover copyright line? (toggle)
1029 #COVER_MISC_COLOR          Colored cover misc line? (toggle)
1030 #CURRENT_V_POS             \n(.d ; used in SHIM
1031 #COVERS                    Print covers? (toggle)
1032 #DATE_FIRST                Was .DATE invoked as first letter
1033                            header after .START? (toggle)
1034 dc                         "mark" register for document columns
1035 #DIVER_FN                  Register that tells FOOTNOTE whether to
1036                            "move" or "defer" a footnote collected
1037                            inside a diversion
1038 #DEFER_BIB_SPACING         Tells DEFAULTS to do BIBLIOGRAPHY_SPACING
1039                            if it was called before START
1040 #DEFER_PAGINATION          Tells COLLATE to restore pagination (from
1041                            RESTORE_PAGINATION
1042 #DELAY_SHIM                Instructs DO_QUOTE to delay SHIM when quote
1043                            falls at the top of a page
1044 #DEPTH_1                   Doc header depth with lead adjustment
1045                            (#DOCHEADER_LINES * #DOCHEADER_LEAD)
1046 #DEPTH_2                   Doc header depth without lead adjustment
1047                            (#DOCHEADER_LINES * #DOC_LEAD)
1048 #DEPTH_TO_B_MARGIN         Page length minus #B_MARGIN
1049 #DIVERSIONS_HY_MARGIN      A reasonable value for .hym applied to
1050                            QUOTE, BLOCKQUOTE and EPIGRAPH to
1051                            avoid excessive hyphenation if these are
1052                            set quad left
1053 #DIVERTED                  Set to 1 in DIVERT_FN_OVERFLOW; reset
1054                            subsequently in FOOTNOTES when called by
1055                            PROCESS_FN_LEFTOVER to 2 or 3 for use by
1056                            FOOTER to decide whether to in/decrease
1057                            #FN_DEPTH when outputting footnotes
1058 #DOCHEADER_ADVANCE         Distance from top-of-page to baseline of
1059                            docheader
1060 #DOCHEADER_COLOR           Colored docheader? (toggle)
1061 #DOCHEADER_LEAD            Lead of doc header
1062                            (#DOC_LEAD + #DOCHEADER_LEAD_ADJ)
1063 #DOCHEADER_SPACE_ADJ       Lead difference between #DEPTH_1 and
1064                            #DEPTH_2
1065 #DOC_COVER_START_POS       Vertical starting pos of doc cover material
1066 #DOC_COVERS                Print doc covers? (toggle)
1067 #DOC_COVER_COLOR           Colored cover? (toggle)
1068 #DOC_COVER_START_POS       Vertical starting pos of cover material
1069 #DOC_COVER_TITLE_COLOR     Colored doc cover title? (toggle)
1070 #DOC_COVER_SUBTITLE_COLOR  Colored doc cover subtitle? (toggle)
1071 #DOC_COVER_ATTRIBUTE_COLOR Colored doc cover attribution string? (toggle)
1072 #DOC_COVER_AUTHOR_COLOR    Colored doc cover author(s)? (toggle)
1073 #DOC_COVER_DOCTYPE_COLOR   Colored doc cover doctype? (toggle)
1074 #DOC_COVER_COPYRIGHT_COLOR Colored doc cover copyright line? (toggle)
1075 #DOC_COVER_MISC_COLOR      Colored doc cover misc line? (toggle)
1076 #DOC_HEADER                Whether to print a doc header (toggle)
1077 #DOC_LEAD_ADJ              Incrementing value (in units) added to
1078                            #DOC_LEAD to fill page to #B_MARGIN
1079 #DOC_LEAD                  Leading used in body
1080 #DOC_L_LENGTH              Global L_LENGTH
1081 #DOC_L_MARGIN              Global L_MARGIN
1082 #DOC_LR_MARGIN_TMP         In HEADER, if RECTO_VERSO=1, temporarily
1083                            holds DOC_L_MARGIN during page margin switch
1084 #DOC_PT_SIZE               Point size used for body text
1085 #DOC_R_MARGIN              Global R_MARGIN
1086 #DOCS                      Always 1 after START
1087 #DOC_TYPE                  1=default, 2=chapter, 3=named, 4=letter
1088 #DOING_COVER               Tells PRINT_AUTHORS that it's printing
1089                            the authors for a cover or doc cover
1090 #DONE_ONCE                 Keeps track of how many times footnotes
1091                            have been collected inside the same diversion
1092 #DONT_RULE_ME              Rule this (apparent) first footnote? (toggle)
1093 #DIVER_LN_OFF              Turn linenumbering off in (block)quotes?
1094                            (toggle)
1095 #DRAFT_WITH_PAGENUM        Are we attaching draft/revision info to page
1096                            number? (toggle)
1097 #EM_ADJUST                 Amount to raise \(em at END
1098 #EN_ALLOWS_HEADERS         Put page headers on endnotes pages? (toggle)
1099 #EN_ALLOWS_HEADERS_ALL     Put page headers on all endnotes pages?
1100                            (toggle)
1101 #EN_BQ_AUTOLEAD            Register created by EN_BLOCKQUOTE_AUTOLEAD
1102 #EN_BQ_LEAD                Leading of blockquotes on endnotes pages
1103 #EN_FIGURE_SPACE           Width of \0, for use with formatting endnotes
1104 #EN_FIRST_PAGE             Tells PRINT_PAGE_NUMBER about endnotes
1105                            first page number
1106 #EN_FIRST_PN               Page number that appears on page 1 of
1107                            endnotes pages.
1108 #EN_HDRFTR_CENTER          Should we print centre string of
1109                            headers/footers on endnotes pages? (toggle)
1110 #EN_LEAD                   Lead of endnotes
1111 #EN_LN_BRACKETS            Are we using brackets for line-numbered
1112                            endnotes (toggle)
1113 #EN_LN_SEP                 Are we using a separator for line-numbered
1114                            endnotes (toggle)
1115 #EN_MARK                   \n(ln when \*[EN-MARK] is called
1116 #EN_MARK_2                 \n(ln when ENDNOTE is called
1117 #EN_MARKER_STYLE           1=NUMBER; 2=LINE
1118 #EN_NO_COLS                Do not set endnotes in columns? (toggle)
1119 #EN_NO_FIRST_PN            Put pagenumber on 1st page of endnotes?
1120                            (toggle)
1121 #EN_NUMBERS_ALIGN_RIGHT    Hang and align endnote numbers right?
1122                            (toggle)
1123 #EN_NUMBERS_ALIGN_LEFT     Align endnote numbers with left margin?
1124                            (toggle)
1125 #EN_NUMBERS_PLACEHOLDERS   Number of placeholders when endnote numbers
1126                            hang and align right
1127 #EN_NUMBER_L_LENGTH        Line length for endnote numbers when they're
1128                            right aligned
1129 #EN_PP_INDENT              First line indent of paras in multi-para
1130                            endnotes
1131 #EN_PP_SPACE               Space multi-paras in endnotes? (toggle)
1132 #EN_PS                     ps of endnotes
1133 #EN_Q_AUTOLEAD             Register created by EN_QUOTE_AUTOLEAD
1134 #EN_Q_LEAD                 Leading of quotes on endnotes pages
1135 #EN_REF                    Put REFs in endnotes? (toggle)
1136 #EN_SINGLESPACE            Single space endnotes pages? (toggle)
1137 #EN_STRING_CAPS            Should ENDNOTES capitalize the endnotes
1138                            string? (toggle)
1139 #EN_STRING_UNDERSCORE      Underscore endnotes page head? (toggle)
1140 #EN_TITLE_UNDERSCORE       Underscore endnotes document identifier?
1141                            (toggle)
1142 #EN_TEXT_INDENT            Page offset for text of endnotes when
1143                            numbers right align
1144 #END_QUOTE                 For PP=0 indenting; did we just end a quote?
1145                            (toggle)
1146 #ENDNOTE                   Are we in an endnote? (toggle)
1147 #ENDNOTE_REFS              Are REFs going to endnotes? (toggle)
1148 #ENDNOTES                  Are we in an endnote (for FOOTERs; toggle)
1149 #EPI_ACTIVE                Are we in an epigraph? (toggle)
1150 #EPI_COLOR                 Colored epigraphs? (toggle)
1151 #EPI_DEPTH                 Depth of epigraph from first baseline to
1152                            last
1153 #EPI_FITS                  Does epigraph fit on page/column? (toggle)
1154 #EPIGRAPH                  Did we have an epigraph? (toggle) 
1155 #EPI_LEAD_DIFF             Difference between #DOC_LEAD and #EPI_LEAD
1156 #EPI_LEAD                  Leading of epigraph; set by AUTOLEAD
1157 #EPI_LINES_EVEN            Even # of lines at end of epi crossing page in
1158                            TYPEWRITE (d-spaced)?
1159 #EPI_LINES                 Number of lines in the epigraph
1160 #EPI_LINES_TO_END          Number of epigraph lines remaining after
1161                            footer trap is sprung
1162 #EPI_LINES_TO_TRAP         Number of epigraph lines till footer trap is
1163                            sprung
1164 #EPI_L_LENGTH              Epigraph line length
1165 #EPI_OFFSET                Left margin of epigraphs
1166 #EPI_OFFSET_VALUE          Epigraph indent as a function of page offset
1167 #EPI_ON                    Are we in an epigraph? (toggle)
1168 #EPI_WHITESPACE            Space after epigraph to compensate for
1169                            epigraph leading
1170 #FIELD                     Incrementing register tacked onto LETTERHEAD
1171 #FINIS                     Was FINIS invoked? (toggle)
1172 #FINIS_COLOR               Colored FINIS? (toggle)
1173 #FN_AUTOLEAD               Autolead value of footnotes
1174 #FN_BL_INDENT              Left indent of INDENT BOTH in footnotes
1175 #FN_BR_INDENT              Right indent of INDENT BOTH in footnotes
1176 #FN_COUNT                  Which fn marker to print; also to
1177                            tell mom to reserve space for and print
1178                            the rule above footnotes
1179 #FN_COUNT_AT_FOOTER        The FN_COUNT after FOOTNOTES has been
1180                            output in FOOTER
1181 #FN_COUNT_FOR_COLS         Holds a separate footnote count for columns
1182                            (so they don't reset to 0 1 until page break)
1183 #FN_DEFER                  Defer footnote to next page/column? (toggle)
1184                            If 0, don't defer.
1185 #FN_DEFER_SPACE            Whether to deposit space before
1186                            footnote 1 because there's a deferred
1187                            footnote on the page
1188 #FN_DEPTH                  Depth of footnote diversion(s)
1189 #FN_FOR_EPI                Signals to epigraph that a footnote is being
1190                            processed
1191 #FN_GAP                    When there are footnotes on a page, the
1192                            difference between where FOOTER will be
1193                            sprung and the next legal baseline.
1194                            Used in VFP_CHECK.
1195 #FN_LEAD                   Lead in footnotes after FN_AUTOLEAD is
1196                            applied
1197 #FN_L_INDENT               Left indent of INDENT LEFT in footnotes
1198 #FN_LINES                  Number of lines in fn; used to calculate
1199                            fn depth
1200 #FN_LN_BRACKETS            Are footnote linenumber brackets being used?
1201                            (toggle)
1202 #FN_LN_SEP                 Is a footnote linenumber separator being used?
1203                            (toggle)
1204 #FN_MARK                   \n(ln when \*[FN-MARK] is called
1205 #FN_MARK_2                 \n(nl when FOOTNOTE is called
1206 #FN_MARKERS                Print footnote markers? (toggle)
1207 #FN_MARKER_STYLE           1=STAR; 2=NUMBER
1208 #FN_NUMBER                 The footnote number attached to running text
1209                            (and fns) when numbers instead of
1210                            star/dagger is being used for footnootes
1211                            numbers
1212 #FN_OVERFLOW_TRAP_POS      The register that sets the position of
1213                            trap FN_OVERFLOW_TRAP.
1214 #FN_R_INDENT               Right indent of INDENT RIGHT in footnotes
1215 #FN_REF                    Put REFs in footnotes? (toggle)
1216 #FN_RULE_ADJ               # of points to raise footnote separator from
1217                            its baseline
1218 #FN_RULE_LENGTH            Length of footnote separator rule
1219 #FN_RULE                   Print fn rule? (toggle)
1220 #FN_SPACE                  Post footnote space
1221 #FN_WAS_DEFERED            Tells HEADER about a deferred footnote
1222 #FOOTER_DIFF               In TRAPS, the difference between the
1223                            original #B_MARGIN and #VISUAL_B_MARGIN
1224 #FOOTER_GAP                Amount of space between end of text and
1225                            page #
1226 #FOOTER_MARGIN             Amount of space between page # and bottom
1227                            of page
1228 #FOOTER_POS                Position of footer trap (required for
1229                            collecting footnotes inside a diversion)
1230 #FOOTERS_ON                Are we using footers? (toggle)
1231 #FOOTERS_WERE_ON           Were footers on? - used in FINIS and BLANKPAGE
1232                            (toggle)
1233 #FOOTNOTE_COLOR            Colored footnotes? (toggle)
1234 #FROM_DIVERT_FN            Signals to FOOTNOTE, when run from
1235                            within DIVERT_FN_LEFTOVER, to set #SPACE_REMAINING
1236                            to the total area allowable for running text
1237 #FROM_FOOTER               In col to col footnote processing, tells
1238                            FOOTNOTE that FOOTNOTES was output from
1239                            FOOTER.
1240 #FROM_HEADER               In col to col footnote processing, tells
1241                            FOOTNOTE that FOOTNOTES was output from
1242                            HEADER.
1243 #FULLSPACE_QUOTES          Should we fullspace quotes? (toggle)
1244 #GET_DEPTH                 Signals to FOOTNOTE that it should
1245                            measure the depth of current footnotes
1246                            plus the most recently added one, except
1247                            where the footnote is to be deferred to
1248                            the next page or column
1249 #GUTTER                    Width of gutter between columns
1250 #HDRFTR_CENTER_CAPS        CENTER part of header/footer in caps?
1251                            (toggle; default=off)
1252 #HDRFTR_COLOR              Colored headers/footers? (toggle)
1253 #HDRFTR_CTR_PAD_LEFT       Amount of hdrftr CENTER padding on the left
1254 #HDRFTR_CTR_PAD_RIGHT      Amount of hdrftr CENTER padding on the right
1255 #HDRFTR_CTR_PAD_TMP        Temp storage of left hdrftr CENTER padding
1256                            (for recto/verso switch)
1257 #HDRFTR_HEIGHT             Cap height of $HDRFTR_RECTO/$HDRFTR_VERSO
1258                            strings
1259 #HDRFTR_LEFT_CAPS          Left part of header/footer in caps?
1260                            (toggle; default=off)
1261 #HDRFTR_RIGHT_CAPS         Right part of header/footer in caps?
1262                            (toggle; default=on)
1263 #HDRFTR_RULE_COLOR         Colored header/footer rule? (toggle)
1264 #HDRFTR_RULE_GAP           Space between header/footer and
1265                            header/footer rule
1266 #HDRFTR_RULE               Print head/footer rule? (toggle)
1267 #HDRFTR_TMP_CAPS_SWITCH    Temporarily holds HDRFTR_LEFT_CAPS value if
1268                            #SWITCH_HDRFTR=1
1269 #HEAD                      1=main/section head 2=subhead
1270 #HEAD_CAPS                 Print section titles in caps? (toggle)
1271 #HEAD_COLOR                Colored heads? (toggle)
1272 #HEADER_GAP                Distance from header to running text
1273 #HEADER_MARGIN             Distance from top of page to header
1274 #HEADERS_ON                Headers on? (toggle)
1275 #HEADER_STATE              Saves header state in COLLATE for use in
1276                            START after COLLATE
1277 #HEADERS_WERE_ON           Were headers on? - used in BLANKPAGE (toggle)
1278 #HEAD_NUM                  Head number
1279 #HEAD_SPACE                2 line spaces before heads?
1280                            (toggle; 1=yes, 0=no)
1281 #HORIZ_MARK                Horizontal 
1282 #HOW_MANY                  Number of blank pages to output
1283 #IGNORE                    Should we ignore this macro? Set to 1 in
1284                            TYPEWRITE.
1285 #IN_BIB_LIST               Tells ITEM we're doing a bibliography in
1286                            list style
1287 #INDENT_FIRST_PARAS        Indent first paras? (toggle)
1288 #INDENT_FIRSTS             Tells footnotes to leave INDENT_FIRST_PARAS
1289                            alone if it's on for running text.
1290 #ITALIC_MEANS_ITALIC       For TYPEWRITE.  1=yes; 0=no
1291 #L_LENGTH_FOR_EPI          Stores line length at top of doc for use
1292                            with EPIGRAPH when columns are on
1293 #L_MARGIN_DIFF             Difference between DOC_L_MARGIN and
1294                            L_MARGIN
1295 #LEFT_CAP_HEIGHT           Cap height of left string in headers/footers
1296 #LEGAL_BASELINE            Calculates vert. position of next legal
1297                            baseline in SHIM
1298 #LETTER_STYLE              1=BUSINESS 2=PERSONAL
1299 #LINEBREAK                 Did we have a linebreak? (toggle)
1300 #LINEBREAK_COLOR           Colored linebreak? (toggle)
1301 #LINENUMBERS               Holds various states of line-numbering when
1302                            line numbering is enabled
1303 #LINES_PER_PAGE            # of lines (at DOC_LEAD) that fit on
1304                            page after #B_MARGIN is set
1305 #LN                        Are line numbers on? (toggle)
1306 #MISC_&lt;n&gt;            Used to print "next" misc lines in DO_COVER
1307 #MISC_NUM                  Number of MISC lines
1308 #MISCS                     =#MISC_NUM in DO_COVER
1309 #MN_OVERFLOW_LEFT          If 1, left margin note text overflows
1310 #MN_OVERFLOW_RIGHT         If 1, right margin note text overflows
1311 #n%_AT_PAGENUM_SET         Page # from n% when PAGENUMBER invoked
1312 #NEEDS_SPACE               Instruct FOOTNOTE, when called by
1313                            PROCESS_FN_IN_DIVER, that if the footnote
1314                            had to be deferred, the VFP must be
1315                            raised by 1v (set in DIVER_FN_2_PRE)
1316 #NEXT_AUTHOR               Supplies correct digit to AUTHOR_&lt;#&gt;
1317                            when printing authors in doc header
1318 #NEXT_LN                   Next linenumber when \n(ln has to be stored
1319                            because linenumbering suspended
1320 #NEXT_MISC                 Incrementing counter for misc lines in
1321                            DO_COVER
1322 #NO_BACK_UP                Instructs FN_OVERFLOW_TRAP not to
1323                            subtract 1 line of footnote lead from
1324                            FN_OVERFLOW in a PREV_FN_DEFERRED
1325                            situation.
1326 #NO_SPACE                  When para spacing is active, instructs
1327                            PP not to add space after a quote or blockquote.
1328 #NO_TRAP_RESET             Should we reset page traps? (toggle)
1329 #NUM_AUTHORS               # of authors mod 2 to test if odd or even
1330                            # of authors
1331 #NUM_MISCS                 Number of args passed to MISC
1332 #NUMBER_HEAD               Are heads numbered? (toggle)
1333 #NUMBER_PH                 Are paraheads numbered? (toggle)
1334 #NUMBER_SH                 Are subheads numbered? (toggle)
1335 #NUM_COLS                  Number of columns per page
1336 #NUM_FIELDS                Incrementing register used to match
1337                            #TOTAL_FIELDS
1338 #OK_PROCESS_LEAD           Initial processing of TOC and endnote
1339                            leading is deferred until OK_PROCESS_LEAD=1
1340 #ORIGINAL_B_MARGIN         The value for #B_MARGIN as set by the
1341                            macro B_MARGIN
1342 #ORIGINAL_DOC_LEAD         The lead for PRINT_STYLE 1 as set in
1343                            PRINTSTYLE; required so that PRINT_STYLE 1
1344                            footnotes have an unadjusted lead of
1345                            12 points
1346 #OVERFLOW                  Signals to FOOTNOTE that some of the
1347                            footnote text won't fit on the page
1348 #PAGE_NUM_ADJ              What to add to n% to get #PAGENUMBER
1349 #PAGENUMBER                The page number
1350 #PAGENUM_STYLE_SET         Did we set pagenumber style? (toggle)
1351 #PAGE_NUM_H_POS            1=left 2=CENTER 3=right; default=2
1352 #PAGE_NUM_COLOR            Colored pagenumbers? (toggle)
1353 #PAGE_NUM_HYPHENS          Print hyphens surrounding page numbers?
1354                            (toggle)
1355 #PAGE_NUM_HYPHENS_SET      Did user set (or unset) hyphens around page
1356                            numbers? (toggle)
1357 #PAGE_NUM_POS_SET          Did user set page number position? (toggle)
1358 #PAGE_NUM_SET              Test if PAGE_1_NUM was used to set 1st page
1359                            number
1360 #PAGE_NUMS                 Print page numbers? (toggle)
1361 #PAGE_NUM_V_POS            1=top 2=bottom; default=2
1362 #PAGE_TOP                  \n(nl after HEADER completes itself
1363 #PH_COLOR                  Colored paraheads? (toggle)
1364 #PH_NUM                    Parahead number
1365 #PAGE_POS                  Exact position on page during a diversion
1366                            (required for collecting footnotes inside
1367                            a diversion)
1368 #PAGINATE_TOC              Is toc pagination on? (toggle)
1369 #PAGINATE_WAS_ON           Keeps track of pagination state while
1370                            outputting blank pages
1371 #PAGINATION_STATE          Saves pagination state in COLLATE for use in
1372                            START after a COLLATE
1373 #PAGINATION_WAS_ON         Was pagination on? - used in FINIS (toggle)
1374 #PP                        0 at first para; auto-increments
1375 #PP_AT_PAGE_BREAK          # of last (incl. partial) para on page
1376 #PP_INDENT                 How much to indent paras
1377 #PP_SPACE                  Put space before paras? (toggle)
1378 #PP_SPACE_SUSPEND          Suspend para spacing for blockquotes and
1379                            epigraphs
1380 #PP_STYLE_PREV             In footnotes, stores PP style in effect
1381                            prior to invoking FOOTNOTE
1382 #PP_STYLE                  Regular para=1; quote or epi para=2
1383 #PRINT_PAGENUM_ON_PAGE_1   Should we print the page number on first
1384                            page of doc when footers are on? (toggle)
1385 #PRINT_STYLE               Typewrite=1, typeset=2
1386 #PT_SIZE_IN_UNITS          Stored value of \n[.ps] from last time
1387                            PT_SIZE was called
1388 #Q_AUTOLEAD                Register created by QUOTE_AUTOLEAD
1389 #Q_DEPTH                   Depth of quote
1390 #Q_FITS                    Does this quote fit on one page/column?
1391                            (toggle)
1392 #Q_LEAD                    Leading of quotes
1393 #Q_LEAD_DIFF               Difference between leading of running text
1394                            and the leading used in quotes/blockquotes
1395 #Q_LEAD_REAL               Leading of quotes and blockquotes saved at the
1396                            ends of their respective diversions
1397 #Q_L_LENGTH                Line length of quotes
1398 #Q_OFFSET                  Page offset for quotes
1399 #Q_OFFSET_VALUE            Factor by which to multiply PP_INDENT to
1400                            offset quotes
1401 #Q_PARTIAL_DEPTH           The amount of a quote/blockquote that fits at
1402                            the bottom of a page when a quote/blockquote
1403                            spans pages
1404 #Q_PP                      In PP, stores para # in QUOTE.  Removed in
1405                            ENDQUOTE.
1406 #Q_SPACE_ADJ               The flexible amount of whitespace to add before
1407                            and after a quote/blockquote
1408 #Q_TOP                     Vertical place on page that a quote starts
1409 #QUOTE                     1=PQUOTE, 2=BQUOTE
1410 #QUOTE_COLOR               Color quotes (poetic)? (toggle)
1411 #QUOTE_LN                  Linenumber quotes? (toggle)
1412 #RECTO_VERSO               Switch HEADER_LEFT and HEADER_RIGHT on
1413                            alternate pages? (toggle); default=0
1414 #REF_HYPHENATE             Hyphenate REFs? (toggle)
1415 #REF_WARNING               Have we issued a ref warning? (toggle)
1416 #REPEAT                    Number of times to repeat linebreak
1417                            character
1418 #RESERVED_SPACE            Just enough room to put 1 more line of
1419                            footnotes on the page
1420 #RESET_EN_PP               Holds value of register #EN_PP_INDENT
1421 #RESET_FN_COUNTERS         1 = "moved" footnote collected in a diversion
1422                            2 = "deferred" fn collected in a diversion
1423 #RESET_FN_NUMBER           Should fn# start at 1 on every page?
1424                            (toggle)
1425 #RESET_L_LENGTH            Stores current line length when necessary
1426 #RESET_PARA_SPACE          Holds current value of toggle register
1427                            #PP_SPACE
1428 #RESET_PP_INDENT           Stores value of PP_INDENT when necessary
1429 #RESET_QUOTE_SPACING       Stores value of toggle register
1430                            #FULLSPACE_QUOTES (used in endnotes)
1431 #RESTORE_DOC_LEAD          Holds value of current doc lead (used in
1432                            endnotes)
1433 #RESTORE_HY                Restore hyphenation after .][? (toggle)
1434 #RESTORE_OFFSET            Page offset at moment footer trap is sprung;
1435                            not currently used
1436 #RESTORE_TOC_PN_PADDING    Saves #TOC_PN_PADDING in TOC prior to
1437                            processing $FIRST_DOC_TITLE
1438 #RIGHT_CAP_HEIGHT          Cap height of right string in
1439                            headers/footers
1440 #RULED                     Tells FOOTNOTE if a rule (or space has been
1441                            put above the first footnote on the page
1442 #RUNON_FN_IN_DIVER         If #LN=1, if we're in a (block)quote, instructs
1443                            FOOTNOTE to unformat diversion RUNON_FN_IN_DIVER
1444 #RUNON_FOOTNOTES           If #LN=1, instructs FOOTNOTE to unformat
1445                            diversion RUNON_FOOTNOTES
1446 #RUN_ON                    Are we using run-on footnotes? (toggle)
1447 #SAVED_DIVER_FN_COUNT      In the case of a footnote inside a
1448                            diversion that should be treated as a
1449                            "normal" footnote, FOOTNOTE needs to
1450                            distinguish between a "normal" deferred
1451                            footnote (always the 1st footnote on the
1452                            page) and one that only looks as if
1453                            it should be deferred, when, in fact,
1454                            it's an overflow; this register lets
1455                            FOOTNOTE know whether the diversion
1456                            footnote is, in fact, the first on the
1457                            page.
1458 #SAVED_FN_COUNT            #FN_COUNT+1 prior to +#FN_COUNT; used
1459                            in FOOTNOTES while gathering fns inside
1460                            diversions
1461 #SAVED_FN_COUNT_FOR_COLS   #FN_COUNT_FOR_COLS+1 prior to
1462                            +#FN_COUNT_FOR_COLS; used in FOOTNOTES
1463                            while gathering fns inside diversions
1464 #SAVED_FN_DEPTH_1          Footnote depth prior to adding footnote
1465                            diversion depth to FN_DEPTH; used when
1466                            footnote text will overflow
1467 #SAVED_FN_DEPTH_2          Footnote depth after to adding footnote
1468                            diversion depth to FN_DEPTH; used when
1469                            footnote text will overflow
1470 #SAVED_FOOTER_POS          Position of FOOTER in DO_QUOTE (hack)
1471 #SAVED_LEAD                In FOOTER and DO_FOOTER, stores the
1472                            lead in effect prior to outputting
1473                            FOOTNOTES or performing either
1474                            PROCESS_FN_LEFTOVER or
1475                            PROCESS_FN_IN_DIVERSION; both the
1476                            diversion FOOTNOTES and the two macros
1477                            have, for PRINT_STYLE 2, an AUTOLEAD
1478                            call, which requires that an LS be
1479                            performed with the #SAVED_LEAD in
1480                            order to remove register #AUTO_LEAD or
1481                            #AUTO_LEAD_FACTOR.
1482 #SEP_TYPE                  Set to 1 if LIST separator is ( or [ or {
1483 #SH_LEAD_ADJUST            #DOC_LEAD/8 (TYPESET) or /2 (TYPEWRITE)
1484                            (used for subhead spacing)
1485 #SH_NUM                    Subhead number
1486 #SHIM                      Amount of lead required to advance to
1487                            next legal baseline
1488 #SILENT_BQUOTE_LN          "Silently" linenumber blockquotes? (toggle)
1489 #SILENT_QUOTE_LN           "Silently" linenumber quotes? (toggle)
1490 #SINGLE_SPACE              Is TYPEWRITE in single space mode? (toggle)
1491 #SKIP_FOOTER               If 1, instructs DO_FOOTER to do nothing
1492                            if B_MARGIN falls below FOOTER_MARGIN
1493 #SLANT_MEANS_SLANT         For TYPEWRITE.  1=yes; 0=no
1494 #SLANT_WAS_ON              Keeps track of SLANT when it needs to go off
1495                            for a while
1496 #SPACE_REMAINING           Space remaining to footer trap; used to
1497                            decide whether or not to defer a footnote
1498 #SR_ADJ_FACTOR             An adjustment factor that compensates
1499                            for the fact that #SPACE_REMAINING
1500                            sometimes reports a fractionally larger
1501                            space than is actually available for
1502                            footnote text.
1503 #START                     If 1, signals completion of START
1504 #START_FOR_FOOTERS         Toggle set in START; signals to
1505                            PRINT_HDRFTR that START has been invoked,
1506                            allowing PRINT_HDRFTR to decide whether or
1507                            not to print a footer on page 1
1508 #START_FOR_MNinit          If 1, defer processing MN_INIT until #START
1509 #STORED_PP_INDENT          Temporarily holds value of #PP_INDENT
1510 #SUITE                     Current page number (for letters)
1511 #SUP_PT_SIZE               Point size of superscript
1512 #SUSPEND_PAGINATION        Suspend pagination prior to endnotes?
1513 #SWITCH_HDRFTR             Switch HDRFTR_LEFT and HDRFTR_RIGHT?
1514                            (toggle)
1515 #T_MARGIN_LEAD_ADJ         \n(.v-12000; ensures critically accurate
1516                            placement of first lines on pages when
1517                            doc processing is not being used and
1518                            a T_MARGIN has been set
1519 #TAB_OFFSET#               "#" at the end is from $CURRENT_TAB
1520 #TERMINATE                 Has TERMINATE been called? (toggle)
1521 #TOC_AUTHORS               Whether to append author(s) to toc doc
1522                            title entries (toggle)
1523 #TOC_ENTRY_PN              Current page number when a toc entry is
1524                            collected
1525 #TOC_FIRST_PAGE            If 1, tells PRINT_PAGE_NUMBER that this
1526                            is the first page of the toc
1527 #TOC_LEAD                  Leading of toc pages
1528 #TOC_PN_PADDING            Max. # of placeholders for toc entries
1529                            page numbers
1530 #TOC_PS                    Point size of toc pages
1531 #TOC_RV_SWITCH             Switch L/R margins of toc pages
1532 #TOC_HEAD_INDENT           Indent of toc head entries
1533 #TOC_HEAD_SIZE_CHANGE      ps in/decrease of toc head entries****
1534 #TOC_PH_INDENT             Indent of toc parahead entries
1535 #TOC_PH_SIZE_CHANGE        ps in/decrease of toc parahead entries****
1536 #TOC_SH_INDENT             Indent of toc subhead entries
1537 #TOC_SH_SIZE_CHANGE        ps in/decrease of toc subhead entries****
1538 #TOC_TITLE_INDENT          Indent of toc doc title entries
1539 #TOC_TITLE_SIZE_CHANGE     ps in/decrease of toc doc title entries****
1540 #TOTAL_FIELDS              Total number of letter header fields
1541 #UNDERLINE_ITALIC          For TYPEWRITE.  1=yes; 0=no
1542 #UNDERLINE_QUOTE           Underline pquotes? (toggle)
1543 #UNDERLINE_SLANT           For TYPEWRITE.  1=yes; 0=no
1544 #UNDERLINE_WAS_ON          In HEADER to re-enable running text
1545                            UNDERLINE (toggle)
1546 #USERDEF_HDRFTR            User defined single string recto/verso
1547                            header/footer? (toggle)
1548 #USERDEF_HDRFTR_RECTO_QUAD 1=left, 2=CENTER, 3=right
1549 #USERDEF_HDRFTR_VERSO_QUAD 1=left, 2=CENTER, 3=right
1550 #USER_DEF_HEADER_CENTER    User defined CENTER title? (1=yes);
1551                            used in COPYSTYLE
1552 #USER_DEF_HEADER_LEFT      User defined CENTER title? (1=yes);
1553                            used in COPYSTYLE
1554 #USER_DEF_HEADER_RIGHT     User defined CENTER title? (1=yes);
1555                            used in COPYSTYLE
1556 #VARIABLE_FOOTER_POS       Wandering trap position for processing
1557                            footnotes and footers; pos depends on
1558                            footnotes
1559 #VISUAL_B_MARGIN           Set in TRAPS, what \n(nl would report
1560                            on the last line of running text before
1561                            FOOTER is sprung.
1562 #VFP_DIFF                  #FN_DEPTH minus #SAVED_FN_DEPTH; the
1563                            number of footnote lines that will fit
1564                            on the page when there will be over, and
1565                            therefore the amount by which to raise
1566                            the VFP for footnotes with overflow after
1567                            the 1st footnote.
1568 y                          Vertical position stored with mk in hdrftrs.
1569  
1570 +++STRINGS+++
1571
1572 $1ST_LETTER                      First letter of first arg to LIST
1573 $ADJUST_BIB_LEAD                 2nd arg to BIBLIOGRAPHY_LEAD; if not blank
1574                                  adjust bib leading
1575 $ATTRIBUTE_STRING               "by" line in doc header
1576 $AUTHOR_1...9                    Document author(s)
1577 $AUTHOR_FAM                      Family to use for author in doc header
1578 $AUTHOR_FT                       Font to use for author in doc header
1579 $AUTHOR_SIZE_CHANGE              ps in/decrease of author in doc header*
1580 $AUTHOR_PT_SIZE                  Absolute ps of authors
1581 $BIB_FAM                         Bibliography page family
1582 $BIB_FT                          Bibliography page font
1583 $BIB_LEAD                        Base leading for bibliographies
1584 $BIB_LIST_SEPARATOR              Separator between enumerator and text
1585                                  when outputting bibliographies in LIST style
1586 $BIB_LIST_PREFIX                 Prefix before enumerator when outputting
1587                                  bibliographies in LIST style
1588 $BIB_PN_STYLE                    Format of bibliography page numbers
1589 $BIB_SPACE                       Post entry space for bibliographies
1590 $BIB_STRING                      Bibliography title string
1591 $BIB_STRING_FAM                  Bib title family
1592 $BIB_STRING_FT                   Bib title font
1593 $BIB_STRING_QUAD                 Bib title quad
1594 $BIB_STRING_SIZE_CHANGE          Bib title size (+ or -)
1595 $BQ_LN_GUTTER                    Gutter between line numbers and bquotes in
1596                                  bquotes
1597 $BQUOTE_COLOR                    Blockquote color
1598 $BQUOTE_FAM                      Family to use for blockquotes
1599 $BQUOTE_FT                       Font to use for blockquotes
1600 $BQUOTE_QUAD                     Quad value for blockquotes
1601 $BQUOTE_SIZE_CHANGE              ps in/decrease of blockquotes*
1602 $CENTER_TITLE                    What to put in the middle of header
1603                                  title
1604 $CHAPTER                         The chapter number
1605 $CHAPTER_STRING                  What to print whenever the word
1606                                  "chapter" is required
1607 $CHAPTER_TITLE                   Chapter title (if there is one)
1608 $CHAPTER_TITLE_FAM               Family of chapter title
1609 $CHAPTER_TITLE_FT                Font of chapter title
1610 $CHAPTER_TITLE_SIZE_CHANGE       ps in/decrease of chapter title*
1611 $CHAPTER_TITLE_PT_SIZE           Absolute ps of chapter title
1612 $CHAPTER_TITLE_COLOR             Color of chapter title
1613 $COPYRIGHT_FAM                   Copyright line family
1614 $COPYRIGHT_FT                    Copyright line font
1615 $COPYRIGHT_SIZE_CHANGE           Copyright line size*
1616 $COPYRIGHT_COLOR                 Copyright line color
1617 $COPYRIGHT_QUAD                  Copyright line quad direction
1618 $COPY_STYLE                      DRAFT or FINAL
1619 $COVER_FAM                       Overall cover family
1620 $COVER_COLOR                     Overall cover color
1621 $COVER_TITLE                     User-defined cover title string
1622 $COVER_TITLE_FAM                 Cover title family
1623 $COVER_TITLE_FT                  Cover title font
1624 $COVER_TITLE_SIZE_CHANGE         Cover title size*
1625 $COVER_TITLE_COLOR               Cover title color
1626 $COVER_SUBTITLE_FAM              Cover subtitle family
1627 $COVER_SUBTITLE_FT               Cover subtitle font
1628 $COVER_SUBTITLE_SIZE_CHANGE      Cover subtitle size*
1629 $COVER_SUBTITLE_COLOR            Cover subtitle color
1630 $COVER_ATTRIBUTE_COLOR           Cover attribution string color
1631 $COVER_AUTHOR_FAM                Cover author(s) family
1632 $COVER_AUTHOR_FT                 Cover author(s) font
1633 $COVER_AUTHOR_SIZE_CHANGE        Cover author(s) size*
1634 $COVER_AUTHOR_COLOR              Cover author(s) color
1635 $COVER_DOCTYPE_FAM               Cover doctype family
1636 $COVER_DOCTYPE_FT                Cover doctype font
1637 $COVER_DOCTYPE_SIZE_CHANGE       Cover doctype size*
1638 $COVER_DOCTYPE_COLOR             Cover doctype color
1639 $COVER_COPYRIGHT_FAM             Cover copyright family
1640 $COVER_COPYRIGHT_FT              Cover copyright font
1641 $COVER_COPYRIGHT_SIZE_CHANGE     Cover copyright size*
1642 $COVER_COPYRIGHT_COLOR           Cover copyright color
1643 $COVER_MISC_FAM                  Cover misc family
1644 $COVER_MISC_FT                   Cover misc font
1645 $COVER_MISC_SIZE_CHANGE          Cover misc size*
1646 $COVER_MISC_COLOR                Cover misc color
1647 $CURRENT_EV                      \n[.ev] at REF_BRACKETS_START
1648 $DOC_COVER_FAM                   Overall doc cover family
1649 $DOC_COVER_COLOR                 Overall doc cover color
1650 $DOC_COVER_TITLE                 User-defined doc cover title string
1651 $DOC_COVER_TITLE_FAM             Doc cover title family
1652 $DOC_COVER_TITLE_FT              Doc cover title font
1653 $DOC_COVER_TITLE_SIZE_CHANGE     Doc cover title size*
1654 $DOC_COVER_TITLE_COLOR           Doc cover title color
1655 $DOC_COVER_SUBTITLE_FAM          Doc cover subtitle family
1656 $DOC_COVER_SUBTITLE_FT           Doc cover subtitle font
1657 $DOC_COVER_SUBTITLE_SIZE_CHANGE  Doc cover subtitle size*
1658 $DOC_COVER_SUBTITLE_COLOR        Doc cover subtitle color
1659 $DOC_COVER_ATTRIBUTE_COLOR       Doc cover attribution string color
1660 $DOC_COVER_AUTHOR_FAM            Doc cover author(s) family
1661 $DOC_COVER_AUTHOR_FT             Doc cover author(s) font
1662 $DOC_COVER_AUTHOR_SIZE_CHANGE    Doc cover author(s) size*
1663 $DOC_COVER_AUTHOR_COLOR          Doc cover author(s) color
1664 $DOC_COVER_DOCTYPE_FAM           Doc cover doctype family
1665 $DOC_COVER_DOCTYPE_FT            Doc cover doctype font
1666 $DOC_COVER_DOCTYPE_SIZE_CHANGE   Doc cover doctype size*
1667 $DOC_COVER_DOCTYPE_COLOR         Doc cover doctype color
1668 $DOC_COVER_COPYRIGHT_FAM         Doc cover copyright family
1669 $DOC_COVER_COPYRIGHT_FT          Doc cover copyright font
1670 $DOC_COVER_COPYRIGHT_SIZE_CHANGE Doc cover copyright size*
1671 $DOC_COVER_COPYRIGHT_COLOR       Doc cover copyright color
1672 $DOC_COVER_MISC_FAM              Doc cover misc family
1673 $DOC_COVER_MISC_FT               Doc cover misc font
1674 $DOC_COVER_MISC_SIZE_CHANGE      Doc cover misc size*
1675 $DOC_COVER_MISC_COLOR            Doc cover misc color
1676 $DOC_FAM                         Predominant font family used in the
1677                                  document
1678 $DOC_QUAD                        Quad used for body text (justified or
1679                                  left) 
1680 $DOC_TITLE                       Overall doc title that gets printed in
1681                                  headers/footers (mostly for use with
1682                                  collated docs where each doc is an
1683                                  article with a different title)
1684 $DOC_TYPE                        Document type (default, chapter, named,
1685                                  letter)
1686 $DOCHEADER_COLOR                 Color of docheader
1687 $DOCHEADER_FAM                   Family used for all parts of the docheader
1688 $DOCHEADER_LEAD_ADJ              +|- value applied to #DOC_LEAD to
1689                                  in/decrease leading of doc header
1690 $DOCTYPE_FAM                     Family to use for DOCTYPE string in
1691                                  doc header
1692 $DOCTYPE_FT                      Font to use for DOCTYPE string in
1693                                  doc header
1694 $DOCTYPE_SIZE_CHANGE             ps in/decrease of DOCTYPE string in
1695                                  doc header*
1696 $DOCTYPE_PT_SIZE                 Absolute ps of DOCTYPE
1697 $DRAFT                           The draft number (string valued)
1698 $DRAFT_STRING                    What to print whenever the word "draft"
1699                                  is required
1700 EN_MARK                          Inline, gets #EN_MARK (\(ln)
1701 $EN_CLOSE_BRACKET                Close bracket for line-number enumerated
1702                                  endnotes
1703 $EN_FAMILY                       Family for endnotes
1704 $EN_FT                           Font for endnotes
1705 $EN_LINENUMBER                   String to print for line-number enumerators
1706                                  in line-numbered endnotes
1707 $EN_LN_FAM                       Family for line-numbers in line-number
1708                                  identified endnotes
1709 $EN_LN_FT                        Font for line-numbers in line-number
1710                                  identified endnotes
1711 $EN_LN_GAP                       Gap to leave in initial endnote lines
1712                                  between line-number identifies and text
1713 $EN_OPEN_BRACKET                 Open bracket for line-number enumerated
1714                                  endnotes
1715 $EN_LN_SIZE_CHANGE               Size change (+ or -) for line-numbers in
1716                                  line-number identified endnotes
1717 $EN_PN_STYLE                     Pagenumbering style for endnotes pages
1718 $EN_QUAD                         Quad for endnotes
1719 $EN_STRING                       Endnotes page head
1720 $EN_STRING_FAM                   Endnotes page head family
1721 $EN_STRING_FT                    Endnotes page head font
1722 $EN_STRING_QUAD                  Endnotes page head quad direction
1723 $EN_STRING_SIZE_CHANGE           Endnotes page head size***
1724 $EN_TITLE                        Endnote document identifier
1725 $EN_TITLE_FAM                    Endnote document identifier family
1726 $EN_TITLE_FT                     Endnote document identifier font
1727 $EN_TITLE_QUAD                   Endnote document identifier quad
1728                                  direction
1729 $EN_TITLE_SIZE_CHANGE            Endnote document identifier size***
1730 $EN_NUMBER_FAM                   Endnote numbering family
1731 $EN_NUMBER_FT                    Endnote numbering font
1732 $EN_NUMBER_SIZE_CHANGE           Endnote numbering size***
1733 $EPI_AUTOLEAD                    Autolead value (decimals ok) of
1734                                  epigraphs
1735 $EPI_COLOR                       Color of epigraphs
1736 $EPI_FAM                         Family to use in epigraphs
1737 $EPI_FT                          Font to use in epigraphs
1738 $EPI_QUAD                        Quad in block-style epigraphs
1739                                  (justified or left)
1740 $EPI_SIZE_CHANGE                 ps in/decrease of epigraphs*
1741 $EVAL_BIB_SPACE                  Temporary string to find out if the
1742                                  arg to BIBLIOGRAPHY_SPACING ended in "v"
1743 $FINIS_COLOR                     Color of FINIS string
1744 $FINIS_STRING                    What to print when FINIS macro is
1745                                  invoked
1746 $FIRST_DOC_TITLE                 1st doc's title captured in COLLATE
1747 FN_MARK                          Inline, gets #FN_MARK (\n(ln)
1748 $FN_CLOSE_BRACKET                Close bracket for line-number identified
1749                                  footnotes
1750 $FN_FAM                          Family used in footnotes
1751 $FN_FT                           Font used in footnotes
1752 $FN_LINENUMBER                   String to print before footnotes when
1753                                  line-numbering enabled for footnotes
1754 $FN_LN_SEP                       Separator after line-number identified
1755                                  footnotes
1756 $FN_OPEN_BRACKET                 Open bracket for line-number identified
1757                                  footnotes
1758 $FN_QUAD                         Quad used in footnotes
1759 $FN_SIZE_CHANGE                  ps in/decrease of footnotes*
1760 $FOOTNOTE_COLOR                  Footnote color
1761 $HDRFTR_CENTER                   What to put in CENTER part of headers;
1762                                  default doctype
1763 $HDRFTR_CENTER_FAM               Family of CENTER part of headers
1764 $HDRFTR_CENTER_FT                Font of centre part of headers
1765 $HDRFTR_CENTER_NEW               HDRFTR_CENTER after the start of TOC;
1766                                  defined in HDRFTR_CENTER if
1767                                  HDRFTR_CENTER is called as
1768                                  FOOTER_CENTER
1769 $HDRFTR_CENTER_OLD               HDRFTR_CENTER just prior to start of
1770                                  TOC; defined in HDRFTR_CENTER if
1771                                  HDRFTR_CENTER is called as
1772                                  FOOTER_CENTER
1773 $HDRFTR_CENTER_SIZE_CHANGE       ps in/decrease of centre title in
1774                                  headers**
1775 $HDRFTR_COLOR                    Color of headers/footers
1776 $HDRFTR_FAM                      Family to use in headers
1777 $HDRFTR_LEFT_FAM                 Family of left part of headers
1778 $HDRFTR_LEFT_FT                  Font of left part of headers
1779 $HDRFTR_LEFT_SIZE_CHANGE         ps in/decrease of author in headers**
1780 $HDRFTR_LEFT                     What to put in left part of headers;
1781                                  default author
1782 $HDRFTR_RIGHT_FAM                Family of right part of headers
1783 $HDRFTR_RIGHT_FT                 Font of right part of headers
1784 $HDRFTR_RIGHT_SIZE_CHANGE        ps in/decrease of right part of
1785                                  headers**
1786 $HDRFTR_RIGHT                    What to put in right part of headers;
1787                                  default title
1788 $HDRFTR_SIZE_CHANGE              ps in/decrease of headers*
1789 $HDRFTR_TMP_SIZE_CHANGE_SWITCH   Temporarily holds
1790                                  HDRFTR_LEFT_SIZE_CHANGE if
1791                                  #SWITCH_HDRFTRS=1
1792 $HDRFTR_TMP_SWITCH               Temporarily holds HDRFTR_LEFT if
1793                                  #SWITCH_HDRFTRS=1
1794 $HEAD_COLOR                      Head color
1795 $HEAD_FAM                        Family to use for section titles
1796 $HEAD_FT                         Font to use for section titles
1797 $HEAD_QUAD                       Quad value of section titles
1798 $HEAD_SIZE_CHANGE                ps in/decrease of section titles*
1799 $LINEBREAK_CHAR                  Character that marks line breaks
1800 $LINEBREAK_CHAR_V_ADJ            +|- amount by which to raise/lower
1801                                  linebreak character
1802 $LAST_CHAR                       Temporary string used to discover whether
1803                                  user has remembered to put a digit after
1804                                  ROMAN or roman in arg to LIST
1805 $LINEBREAK_COLOR                 Linebreak color
1806 $LIST_ARG_1                      The first arg to LIST (minus digits if
1807                                  ROMAN or roman
1808 $LN_GUTTER                       Gutter to leave between line numbers
1809                                  and text
1810 $LN_INC                          2nd arg to NUMBER_LINES as a string
1811 $LN_NUM                          1st arg to NUMBER_LINES as a string
1812 $MISC_COLOR                      Misc line color
1813 $MISC_QUAD                       Misc line quad
1814 PAGE#                            For use in hdrftr strings where page #
1815                                  is needed; \*[PAGE]
1816 $PAGENUM_COLOR                   Page number color
1817 $PAGENUM_STYLE                   String passed to PAGENUM_STYLE
1818 $PAGE_NUM_FAM                    Family of page numbers
1819 $PAGE_NUM_FT                     Font of page numbers
1820 $PAGE_NUM_SIZE_CHANGE            ps in/decrease of page numbers
1821 $PAPER                           Paper size (LETTER, A4, LEGAL);
1822                                  default=LETTER
1823 $PH_COLOR                        Parahead color
1824 $PP_FT                           Font used in paragraphs
1825 $ROMAN_WIDTH                     The digit(s) appended to ROMAN or
1826                                  roman LIST args
1827 $Q_LN_GUTTER                     Gutter between linenumbers and quotes
1828                                  in quotes
1829 $QUOTE_COLOR                     Quote (poetic) color
1830 $QUOTE_FAM                       Family to use for pquotes
1831 $QUOTE_FT                        Font to use for pquotes
1832 $QUOTE_SIZE_CHANGE               ps in/decrease of pquotes*
1833 $REF_BIB_INDENT                  2nd line indent value for references in
1834                                  bibliographies
1835 $REF_EN_INDENT                   2nd line indent value for references in
1836                                  endnotes
1837 $REF_FN_INDENT                   2nd line indent value for references in
1838                                  footnotes
1839 $RESTORE_SS_VAR                  Saves \*[$SS_VAR] for use with ref*build
1840 #REVISION                        The revision number (string valued)
1841 $REVISION_STRING                 What to print whenever the word
1842                                  "revision" is required
1843 $SH_FAM                          Family to use in subheads
1844 $SH_FT                           Font to use in subheads
1845 $SH_SIZE_CHANGE                  ps in/decrease of subheads*
1846 $SH_COLOR                        Subhead color
1847 $SUBTITLE                        Document subtitle
1848 $SUBTITLE_FAM                    Family to use for subtitle in doc
1849                                  header
1850 $SUBTITLE_FT                     Font to use for subtitle in doc header
1851 $SUBTITLE_SIZE_CHANGE            ps in/decrease of subtitle*
1852 $SUBTITLE_PT_SIZE                Absolute ps of subtitle
1853 $SUITE                           The #SUITE number register
1854 $TITLE                           Document title
1855 $TITLE_FAM                       Family to use for title in doc header
1856 $TITLE_FT                        Font to use for title in doc header
1857 $TITLE_PT_SIZE                   Absolute point size of title in docheader
1858 $TITLE_SIZE_CHANGE               ps in/decrease of title in doc header*
1859 $TOC_AUTHORS                     What to print after toc doc title entry
1860                                  if #TOC_AUTHORS=1
1861 $TOC_FAM                         Family to use on toc pages
1862 $TOC_HEAD_FAM                    Family of toc head entries
1863 $TOC_HEAD_FT                     Font of toc head entries
1864 $TOC_HEAD_ITEM                   A head as collected for TOC_ENTRIES
1865 $TOC_HEADER_FAM                  Family to use for "Contents"
1866 $TOC_HEADER_FT                   Font to use for "Contents"
1867 $TOC_HEADER_QUAD                 Quad direction of "Contents"
1868 $TOC_HEADER_SIZE                 ps in/decrease of "Contents"****
1869 $TOC_HEADER_STRING               Header string of first toc page
1870 $TOC_PN                          Sets up toc leaders + entry pn
1871                                  (typeset)
1872 $TOC_PN_FAM                      Family for toc entries page numbers
1873 $TOC_PN_FT                       Font for toc entries page numbers
1874 $TOC_PN_SIZE_CHANGE              ps in/decrease of toc entries page
1875                                  numbers
1876 $TOC_PN_STYLE                    Page-numbering style of toc pages
1877 $TOC_PN_TYPEWRITE                Sets up toc leaders + entry pn
1878                                  (typewrite)
1879 $TOC_PH_FAM                      Family of toc parahead entries
1880 $TOC_PH_FT                       Font of toc parahead entries
1881 $TOC_PARAHEAD_ITEM               A parahead collected for TOC_ENTRIES
1882 $TOC_SH_FAM                      Family of toc subhead entries
1883 $TOC_SH_FT                       Font of toc subhead entries
1884 $TOC_SH_ITEM                     A subhead collected for TOC_ENTRIES
1885 $TOC_TITLE_FAM                   Family of toc doc title entries
1886 $TOC_TITLE_FT                    Font of toc doc title entries
1887 $USER_SET_TITLE_ITEM             User defined toc doc title entry as
1888                                  set by TOC_TITLE_ENTRY
1889 $UR_PAGINATION_STYLE             Pagination style prior to endnotes
1890 $USERDEF_HDRFTR_RECTO            User defined header/footer recto string
1891 $USERDEF_HDRFTR_VERSO            User defined header/footer verso string
1892
1893    *relative to #DOC_PT_SIZE
1894   **relative to overall ps of headers as set by HEADER_SIZE
1895  ***relative to overall ps of endnotes
1896 ****relative to overall ps of toc pages
1897
1898 +++PREPROCESSOR KEYWORDS+++
1899
1900 (eqn)
1901 EQ
1902 EN
1903
1904 (grn)
1905 GS
1906 GE
1907 GF
1908
1909 (pic)
1910 PS
1911 PE
1912
1913 (refer)
1914 R1
1915 R2
1916 [
1917 ]
1918
1919 (tbl)
1920 TS
1921 TE
1922 TH
1923
1924 (grap)
1925 G1
1926 G2
1927
1928 (ideal)
1929 IS
1930 IE
1931
1932 (chem)
1933 cstart
1934 cend
1935
1936 +++ALIASES+++
1937
1938 Please note:
1939
1940 Prior to version 1.1.9, all macros that included the word COLOR had
1941 aliases that used COLOUR instead.  This convenience has now been
1942 removed, in an effort to reduce the size of the om.tmac file.
1943
1944 Furthermore, if you want the convenience, you'll have to edit the
1945 om.tmac file.  Simply aliasing, say, HEAD_COLOR as HEAD_COLOUR will
1946 not work, owing to significant changes in the handling of
1947 docelement control macros that end in _COLOR.
1948
1949 +++The following are for convenience, and header/footer management+++
1950
1951 BREAK_BLOCKQUOTE      BREAK_QUOTE
1952 BREAK_CITATION        BREAK_QUOTE
1953 BREAK_CITE            BREAK_QUOTE
1954 CITATION              BLOCKQUOTE
1955 CITE                  BLOCKQUOTE
1956 COL_BREAK             COL_NEXT
1957 DOC_FAM               DOC_FAMILY
1958 DOC_LLENGTH           DOC_LINE_LENGTH
1959 DOC_L_LENGTH          DOC_LINE_LENGTH
1960 DOC_L_MARGIN          DOC_LEFT_MARGIN
1961 DOC_LMARGIN           DOC_LEFT_MARGIN
1962 DOC_LS                DOC_LEAD
1963 DOC_PS                DOC_PT_SIZE
1964 DOC_R_MARGIN          DOC_RIGHT_MARGIN
1965 DOC_RMARGIN           DOC_RIGHT_MARGIN
1966 FOOTER_CENTER_CAPS    HDRFTR_CENTER_CAPS
1967 FOOTER_CENTER         HDRFTR_CENTER
1968 FOOTER_CENTRE_CAPS    HDRFTR_CENTER_CAPS
1969 FOOTER_CENTRE         HDRFTR_CENTER
1970 FOOTER_LEFT_CAPS      HDRFTR_LEFT_CAPS
1971 FOOTER_LEFT           HDRFTR_LEFT
1972 FOOTER_PLAIN          HDRFTR_PLAIN
1973 FOOTER_RECTO          HDRFTR_RECTO
1974 FOOTER_RIGHT_CAPS     HDRFTR_RIGHT_CAPS
1975 FOOTER_RIGHT          HDRFTR_RIGHT
1976 FOOTER_RULE_GAP       HDRFTR_RULE_GAP
1977 FOOTER_RULE           HDRFTR_RULE
1978 FOOTER_VERSO          HDRFTR_VERSO
1979 HDRFTR_RULE_INTERNAL  HDRFTR_RULE
1980 HEADER_CENTER_CAPS    HDRFTR_CENTER_CAPS
1981 HEADER_CENTER         HDRFTR_CENTER
1982 HEADER_CENTRE_CAPS    HDRFTR_CENTER_CAPS
1983 HEADER_CENTRE         HDRFTR_CENTER
1984 HEADER_LEFT_CAPS      HDRFTR_LEFT_CAPS
1985 HEADER_LEFT           HDRFTR_LEFT
1986 HEADER_PLAIN          HDRFTR_PLAIN
1987 HEADER_RECTO          HDRFTR_RECTO
1988 HEADER_RIGHT_CAPS     HDRFTR_RIGHT_CAPS
1989 HEADER_RIGHT          HDRFTR_RIGHT
1990 HEADER_RULE_GAP       HDRFTR_RULE_GAP
1991 HEADER_RULE           HDRFTR_RULE
1992 HEADER_VERSO          HDRFTR_VERSO
1993 PAGENUM               PAGENUMBER
1994 PAGINATION            PAGINATE
1995 PP_FT                 PP_FONT
1996 PRINT_FOOTNOTE_RULE   FOOTNOTE_RULE
1997 SWITCH_FOOTERS        SWITCH_HDRFTR
1998 SWITCH_HEADERS        SWITCH_HDRFTR
1999 TOC_LS                TOC_LEAD
2000 TOC_PS                TOC_PT_SIZE
2001
2002 +++The following are used for docelement type-style control+++
2003
2004 AUTHOR_FAMILY                 _FAMILY
2005 AUTHOR_FONT                   _FONT
2006 AUTHOR_SIZE                   _SIZE
2007 BIBLIOGRAPHY_FAMILY           _FAMILY
2008 BIBLIOGRAPHY_FONT             _FONT
2009 BIBLIOGRAPHY_FOOTER_CENTER    BIBLIOGRAPHY_HDRFTR_CENTER
2010 BIBLIOGRAPHY_FOOTER_CENTRE    BIBLIOGRAPHY_HDRFTR_CENTRE
2011 BIBLIOGRAPHY_HEADER_CENTER    BIBLIOGRAPHY_HDRFTR_CENTER
2012 BIBLIOGRAPHY_HEADER_CENTRE    BIBLIOGRAPHY_HDRFTR_CENTRE
2013 BIBLIOGRAPHY_QUAD             _QUAD
2014 BIBLIOGRAPHY_STRING_FAMILY    _FAMILY
2015 BIBLIOGRAPHY_STRING_FONT      _FONT
2016 BIBLIOGRAPHY_STRING_QUAD      _QUAD
2017 BIBLIOGRAPHY_STRING_SIZE      _SIZE
2018 BLOCKQUOTE_AUTOLEAD           Q_AUTOLEAD
2019 BLOCKQUOTE_AUTOLEAD           QUOTE_AUTOLEAD
2020 BLOCKQUOTE_COLOR              _COLOR
2021 BLOCKQUOTE_FAMILY             _FAMILY
2022 BLOCKQUOTE_FONT               _FONT
2023 BLOCKQUOTE_QUAD               _QUAD
2024 BLOCKQUOTE_SIZE               _SIZE
2025 CHAPTER_TITLE_COLOR           _COLOR
2026 CHAPTER_TITLE_FAMILY          _FAMILY
2027 CHAPTER_TITLE_FONT            _FONT
2028 CHAPTER_TITLE_SIZE            _SIZE
2029 COVER_ATTRIBUTE_COLOR         _COLOR
2030 COVER_AUTHOR_COLOR            _COLOR
2031 COVER_AUTHOR_FAMILY           _FAMILY
2032 COVER_AUTHOR_FONT             _FONT
2033 COVER_AUTHOR_SIZE             _SIZE
2034 COVER_COLOR                   _COLOR
2035 COVER_COPYRIGHT_COLOR         _COLOR
2036 COVER_COPYRIGHT_FAMILY        _FAMILY
2037 COVER_COPYRIGHT_FONT          _FONT
2038 COVER_COPYRIGHT_QUAD          _QUAD
2039 COVER_COPYRIGHT_SIZE          _SIZE
2040 COVER_DOCTYPE_COLOR           _COLOR
2041 COVER_DOCTYPE_FAMILY          _FAMILY
2042 COVER_DOCTYPE_FONT            _FONT
2043 COVER_DOCTYPE_SIZE            _SIZE
2044 COVER_FAMILY                  _FAMILY
2045 COVER_MISC_COLOR              _COLOR
2046 COVER_MISC_QUAD               _QUAD
2047 COVER_SUBTITLE_COLOR          _COLOR
2048 COVER_SUBTITLE_FAMILY         _FAMILY
2049 COVER_SUBTITLE_FONT           _FONT
2050 COVER_SUBTITLE_SIZE           _SIZE
2051 COVER_TITLE_COLOR             _COLOR
2052 COVER_TITLE_FAMILY            _FAMILY
2053 COVER_TITLE_FONT              _FONT
2054 COVER_TITLE_SIZE              _SIZE
2055 DOC_COVER_ATTRIBUTE_COLOR     _COLOR
2056 DOC_COVER_AUTHOR_COLOR        _COLOR
2057 DOC_COVER_AUTHOR_FAMILY       _FAMILY
2058 DOC_COVER_AUTHOR_FONT         _FONT
2059 DOC_COVER_AUTHOR_SIZE         _SIZE
2060 DOC_COVER_COLOR               _COLOR
2061 DOC_COVER_COPYRIGHT_COLOR     _COLOR
2062 DOC_COVER_COPYRIGHT_FAMILY    _FAMILY
2063 DOC_COVER_COPYRIGHT_FONT      _FONT
2064 DOC_COVER_COPYRIGHT_QUAD      _QUAD
2065 DOC_COVER_COPYRIGHT_SIZE      _SIZE
2066 DOC_COVER_DOCTYPE_COLOR       _COLOR
2067 DOC_COVER_DOCTYPE_FAMILY      _FAMILY
2068 DOC_COVER_DOCTYPE_FONT        _FONT
2069 DOC_COVER_DOCTYPE_SIZE        _SIZE
2070 DOC_COVER_FAMILY              _FAMILY
2071 DOC_COVER_MISC_COLOR          _COLOR
2072 DOC_COVER_MISC_QUAD           _QUAD
2073 DOC_COVER_SUBTITLE_COLOR      _COLOR
2074 DOC_COVER_SUBTITLE_FAMILY     _FAMILY
2075 DOC_COVER_SUBTITLE_FONT       _FONT
2076 DOC_COVER_SUBTITLE_SIZE       _SIZE
2077 DOC_COVER_TITLE_COLOR         _COLOR
2078 DOC_COVER_TITLE_FAMILY        _FAMILY
2079 DOC_COVER_TITLE_FONT          _FONT
2080 DOC_COVER_TITLE_SIZE          _SIZE
2081 DOCHEADER_COLOR               _COLOR
2082 DOCHEADER_FAMILY              _FAMILY
2083 DOC_QUAD                      _QUAD
2084 DOCTYPE_FAMILY                _FAMILY
2085 DOCTYPE_FONT                  _FONT
2086 DOCTYPE_SIZE                  _SIZE
2087 ENDNOTE_BLOCKQUOTE_AUTOLEAD   Q_AUTOLEAD
2088 ENDNOTE_BLOCKQUOTE_AUTOLEAD   QUOTE_AUTOLEAD
2089 ENDNOTE_FAMILY                _FAMILY
2090 ENDNOTE_FONT                  _FONT
2091 ENDNOTE_LINENUMBER_FAMILY     _FAMILY
2092 ENDNOTE_LINENUMBER_FONT       _FONT
2093 ENDNOTE_LINENUMBER_SIZE       _SIZE
2094 ENDNOTE_NUMBER_FAMILY         _FAMILY
2095 ENDNOTE_NUMBER_FONT           _FONT
2096 ENDNOTE_NUMBER_SIZE           _SIZE
2097 ENDNOTE_QUAD                  _QUAD
2098 ENDNOTE_QUOTE_AUTLOEAD        Q_AUTOLEAD
2099 ENDNOTE_QUOTE_AUTOLEAD        QUOTE_AUTOLEAD
2100 ENDNOTE_STRING_FAMILY         _FAMILY
2101 ENDNOTE_STRING_FONT           _FONT
2102 ENDNOTE_STRING_QUAD           _QUAD
2103 ENDNOTE_STRING_SIZE           _SIZE
2104 ENDNOTE_TITLE_FAMILY          _FAMILY
2105 ENDNOTE_TITLE_FONT            _FONT
2106 ENDNOTE_TITLE_QUAD            _QUAD
2107 ENDNOTE_TITLE_SIZE            _SIZE
2108 EPIGRAPH_COLOR                _COLOR
2109 EPIGRAPH_FAMILY               _FAMILY
2110 EPIGRAPH_FONT                 _FONT
2111 EPIGRAPH_QUAD                 _QUAD
2112 EPIGRAPH_SIZE                 _SIZE
2113 FINIS_COLOR                   _COLOR
2114 FOOTNOTE_COLOR                _COLOR
2115 FOOTNOTE_FAMILY               _FAMILY
2116 FOOTNOTE_FONT                 _FONT
2117 FOOTNOTE_QUAD                 _QUAD
2118 FOOTNOTE_SIZE                 _SIZE
2119 HDRFTR_CENTER_FAMILY          _FAMILY
2120 HDRFTR_CENTER_FONT            _FONT
2121 HDRFTR_CENTER_SIZE            _SIZE
2122 HDRFTR_COLOR                  _COLOR
2123 HDRFTR_FAMILY                 _FAMILY
2124 HDRFTR_LEFT_FAMILY            _FAMILY
2125 HDRFTR_LEFT_FONT              _FONT
2126 HDRFTR_LEFT_SIZE              _SIZE
2127 HDRFTR_RIGHT_FAMILY           _FAMILY
2128 HDRFTR_RIGHT_FONT             _FONT
2129 HDRFTR_RIGHT_SIZE             _SIZE
2130 HDRFTR_RULE_COLOR             _COLOR
2131 HDRFTR_SIZE                   _SIZE
2132 HEAD_COLOR                    _COLOR
2133 HEAD_FAMILY                   _FAMILY
2134 HEAD_FONT                     _FONT
2135 HEAD_QUAD                     _QUAD
2136 HEAD_SIZE                     _SIZE
2137 LINEBREAK_COLOR               _COLOR
2138 MISC_COLOR                    _COLOR
2139 MISC_QUAD                     _QUAD
2140 PAGENUM_COLOR                 _COLOR
2141 PAGENUM_FAMILY                _FAMILY
2142 PAGENUM_FONT                  _FONT
2143 PARAHEAD_COLOR                _COLOR
2144 PARAHEAD_FAMILY               _FAMILY
2145 PARAHEAD_FONT                 _FONT
2146 PARAHEAD_SIZE                 _SIZE
2147 QUOTE_COLOR                   _COLOR
2148 QUOTE_FAMILY                  _FAMILY
2149 QUOTE_FONT                    _FONT
2150 QUOTE_INDENT                  _INDENT
2151 QUOTE_SIZE                    _SIZE
2152 REF_INDENT                    INDENT_REFS
2153 REF)                          REF_BRACKETS_END
2154 REF]                          REF_BRACKETS_END
2155 REF}                          REF_BRACKETS_END
2156 REF(                          REF_BRACKETS_START
2157 REF[                          REF_BRACKETS_START
2158 REF{                          REF_BRACKETS_START
2159 SUBHEAD_COLOR                 _COLOR
2160 SUBHEAD_FAMILY                _FAMILY
2161 SUBHEAD_FONT                  _FONT
2162 SUBHEAD_SIZE                  _SIZE
2163 SUBTITLE_COLOR                _COLOR
2164 SUBTITLE_FAMILY               _FAMILY
2165 SUBTITLE_FONT                 _FONT
2166 SUBTITLE_SIZE                 _SIZE
2167 TITLE_COLOR                   _COLOR
2168 TITLE_FAMILY                  _FAMILY
2169 TITLE_FONT                    _FONT
2170 TITLE_SIZE                    _SIZE
2171 TOC_FAM                       _FAMILY
2172 TOC_FAMILY                    _FAMILY
2173 TOC_HEADER_FAMILY             _FAMILY
2174 TOC_HEADER_FONT               _FONT
2175 TOC_HEADER_QUAD               _QUAD
2176 TOC_HEADER_SIZE               _SIZE
2177 TOC_HEAD_FAMILY               _FAMILY
2178 TOC_HEAD_FONT                 _FONT
2179 TOC_HEAD_SIZE                 _SIZE
2180 TOC_PARAHEAD_FAMILY           _FAMILY
2181 TOC_PARAHEAD_FONT             _FONT
2182 TOC_PARAHEAD_SIZE             _SIZE
2183 TOC_PN_FAMILY                 _FAMILY
2184 TOC_PN_FONT                   _FONT
2185 TOC_PN_SIZE                   _SIZE
2186 TOC_PT_SIZE                   _SIZE
2187 TOC_SUBHEAD_FAMILY            _FAMILY
2188 TOC_SUBHEAD_FONT              _FONT
2189 TOC_SUBHEAD_SIZE              _SIZE
2190 TOC_TITLE_FAMILY              _FAMILY
2191 TOC_TITLE_FONT                _FONT
2192 TOC_TITLE_SIZE                _SIZE
2193 </pre>
2194
2195 <hr>
2196 <a href="appendices.html#TOP">Prev</a>&nbsp;&nbsp;
2197 <a href="#TOP">Top</a>&nbsp;&nbsp;
2198 <a href="toc.html">Back to Table of Contents</a>
2199 </body>
2200 </html>