/contrib/groff/contrib/mom/momdoc/reserved.html

https://bitbucket.org/freebsd/freebsd-head/ · HTML · 2200 lines · 2174 code · 26 blank · 0 comment · 0 complexity · 19d8ad444a198cc367401ace486aade4 MD5 · raw file

Large files are truncated click here to view the full file

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
    5. 

  5. <title>Mom -- List of reserved words</title>
    6. 

  6. </head>
    7. 

  7. <body bgcolor="#dfdfdf">
    8. 

  8. 

  9. <!====================================================================>
    10. 

  10. 

  11. <a href="appendices.html#TOP">Prev</a>&nbsp;&nbsp; <a href="toc.html">Back to Table of Contents</a>
    12. 

  12. <p>
    13. 

  13. 

  14. <a name="TOP"></a>
    15. 

  15. <a name="RESERVED">
    16. 

  16. <h1 align="center"><u>LIST OF RESERVED WORDS</u></h1>
    17. 

  17. </a>
    18. 

  18. <p> The following is a list of &quot;reserved&quot; words used by
    19. 

  19. <strong>mom</strong>.  Before changing the name of any macro or
    20. 

  20. document element tag with
    21. 

  21. <a href="goodies.html#ALIAS">ALIAS</a>,
    22. 

  22. I strongly recommend doing a search of this page for your proposed
    23. 

  23. new name.  If you find it in the left hand column, DON'T USE IT.
    24. 

  24. Choose something else instead.
    25. 

  25. <p>
    26. 

  26. Anyone interested in playing around inside <strong>mom</strong>'s macro
    27. 

  27. file (om.tmac) will find this list useful as well since it lists all
    28. 

  28. (I hope) the macros, strings, diversions and number registers
    29. 

  29. <strong>mom</strong> uses, along with brief descriptions of their
    30. 

  30. functions.
    31. 

  31. <p>
    32. 

  32. <pre>
    33. 

  33. TYPESETTING
    34. 

  34. ===========
    35. 

  35. 

  36. +++MACROS+++
    37. 

  37. 

  38. Page layout
    39. 

  39. -----------
    40. 

  40. PAGELENGTH  Page width
    41. 

  41. PAGE        Page width/length; left, right, top, bottom margins
    42. 

  42. PAGEWIDTH   Page width
    43. 

  43. PAPER       Letter, legal, or A4
    44. 

  44. 

  45. B_MARGIN  Space to leave at page bottom
    46. 

  46. L_MARGIN  Page offset
    47. 

  47. R_MARGIN  Line length as a function of
    48. 

  48.           pagewidth minus pageoffset minus rightmargin
    49. 

  49. T_MARGIN  Advance lead from page top
    50. 

  50. 

  51. Page control
    52. 

  52. ------------
    53. 

  53. DO_B_MARGIN  Margin at bottom of page; trap-invoked
    54. 

  54. DO_T_MARGIN  Margin at top of page; trap-invoked
    55. 

  55. 

  56. Style
    57. 

  57. -----
    58. 

  58. COLOR          Change color of text to predefined value
    59. 

  59. CONDENSE       Set percentage of pseudo-condense (alias of
    60. 

  60.                CONDENSE_OR_EXTEND)
    61. 

  61. EXTEND         Set percentage of pseudo-extend (alias of
    62. 

  62.                CONDENSE_OR_EXTEND)
    63. 

  63. FAMILY         Family
    64. 

  64. FT             Font
    65. 

  65. FALLBACK_FONT  Font to use whenever FAMILY or FT errors occur
    66. 

  66. LL             Line length
    67. 

  67. LS             Leading (.vs)
    68. 

  68. NEWCOLOR       Define a text color
    69. 

  69. PT_SIZE        Point size
    70. 

  70. SETBOLDER      Set degree of emboldening (pseudo-bold) in units
    71. 

  71. SETSLANT       Set degree of pseudo-italic
    72. 

  72. XCOLOR         Initialize a color from rgb.txt
    73. 

  73. 

  74. Autolead
    75. 

  75. --------
    76. 

  76. AUTOLEAD  Always lead n points more than .PT_SIZE
    77. 

  77. 

  78. Flush
    79. 

  79. -----
    80. 

  80. JUSTIFY  Justified text
    81. 

  81. QUAD     Filled text, left, right, or centre
    82. 

  82. 

  83. Quad
    84. 

  84. ----
    85. 

  85. CENTER  Non-filled text, centre
    86. 

  86. LEFT    Non-filled text, left
    87. 

  87. RIGHT   Non-filled text, right
    88. 

  88. 

  89. Hyphenation
    90. 

  90. -----------
    91. 

  91. HY      Turn hyphenation on/off, or set LINES, MARGIN, SPACE
    92. 

  92. HY_SET  Set LINES, MARGIN, SPACE in a single command
    93. 

  93. 

  94. Advanced style
    95. 

  95. --------------
    96. 

  96. KERN       Turn automatic kerning on or off
    97. 

  97. LIGATURES  Turn ligatures on or off
    98. 

  98. SS         Sentence space control
    99. 

  99. WS         Word space control
    100. 

  100. 

  101. Line breaks
    102. 

  102. -----------
    103. 

  103. BR      Alias of br
    104. 

  104. EL      Breaks line but doesn't advance
    105. 

  105. SPACE   Alias of sp
    106. 

  106. SPREAD  Alias of brp
    107. 

  107. 

  108. Ald/rld
    109. 

  109. -------
    110. 

  110. ALD  Advance lead
    111. 

  111. RLD  Reverse lead
    112. 

  112. 

  113. Indents
    114. 

  114. -------
    115. 

  115. HI   Indent hang
    116. 

  116. IB   Indent both
    117. 

  117. IBX  Indent both off
    118. 

  118. IL   Indent left
    119. 

  119. ILX  Indent left off
    120. 

  120. IQ   Indents off
    121. 

  121. IR   Indent right
    122. 

  122. IRX  Indent right off
    123. 

  123. IX   Indents off -- deprecated
    124. 

  124. TI   Indent temporary
    125. 

  125. 

  126. Tabs
    127. 

  127. ----
    128. 

  128. ST       String tab
    129. 

  129. TAB_SET  Tab Set
    130. 

  130. TN       Tab Next
    131. 

  131. TQ       Tab Quit
    132. 

  132. 

  133. MCO      Turn on multi-column mode
    134. 

  134. MCR      Return to top of column
    135. 

  135. MCX      Turn off multi-column mode
    136. 

  136. 

  137. Underscore
    138. 

  138. ----------
    139. 

  139. UNDERSCORE   Underscores words or phrases
    140. 

  140. UNDERSCORE2  Double underscores words or phrases
    141. 

  141. 

  142. Underline
    143. 

  143. ---------
    144. 

  144. UNDERLINE  Underlines whole passages (Courier only)
    145. 

  145. 

  146. Smart Quotes
    147. 

  147. ------------
    148. 

  148. SMARTQUOTES  Turns smart quotes on or off
    149. 

  149. 

  150. Misc + Support
    151. 

  151. --------------
    152. 

  152. BR_AT_LINE_KERN  Deposit a break before RW and WE
    153. 

  153. CAPS             Convert u/lc to UC
    154. 

  154. COMMENT          Don't print lines till COMMENT OFF (alias of SILENT)
    155. 

  155. DROPCAP_ADJUST   Points (poss. fractional) to add/subtract
    156. 

  156.                  from drop caps
    157. 

  157. DROPCAP          Create drop cap
    158. 

  158. DROPCAP_FAMILY   Drop cap family
    159. 

  159. DROPCAP_FONT     Drop cap font
    160. 

  160. DROPCAP_GUTTER   Drop cap gutter
    161. 

  161. DROPCAP_OFF      Support only; restores .in if there was one
    162. 

  162. ESC_CHAR         Alias for .ec
    163. 

  163. EW               Extra white -- loosen overall line kern
    164. 

  164.                  (character spacing)
    165. 

  165. LEADER_CHARACTER Sets leader character
    166. 

  166. PAD              Insert padding spaces at marked places
    167. 

  167. PADMARKER        Sets character to use instead of # in PAD
    168. 

  168. PRINT            Simply prints args passed to it; keeps my code
    169. 

  169.                  indented nicely
    170. 

  170. RW               Reduce white -- tighten overall line kern
    171. 

  171.                  (character spacing)
    172. 

  172. SILENT           Don't print lines till SILENT OFF
    173. 

  173. SIZESPECS        Get cap-height, x-height and descender depth for
    174. 

  174.                  current point size
    175. 

  175. TRAP             Turn traps off or on
    176. 

  176. 

  177. +++DIVERSIONS+++
    178. 

  178. 

  179. NO_FLASH    Diverts output of SILENT or COMMENT so they don't print
    180. 

  180. NULL        Diverts SIZESPECS in PRINT_HDRFTR so it doesn't screw up
    181. 

  181.             FOOTER and FOOTNOTE processing when FOOTERS are on
    182. 

  182. PAD_STRING  Diverts $PAD_STRING for processing
    183. 

  183. TYPESIZE    Diverts SIZESPECS routine so it doesn't print
    184. 

    185. 

  185. +++NUMBER REGISTERS+++
    186. 

  186. 

  187. #ABORT_FT_ERRORS        Abort on FT errors? (toggle)
    188. 

  188. #ALD                    ALD value
    189. 

  189. #ARGS_TO_LIST           Tells LIST whether LIST was invoked with a legal
    190. 

  190.                         arg; controls LIST OFF processing
    191. 

  191. #ARGS_TO_SQ             Tells SMARTQUOTES whether it was invoked with a
    192. 

  192.                         legal arg; controls SMARTQUOTES OFF
    193. 

  193.                         processing
    194. 

  194. #AUTOLEAD_FACTOR        Using FACTOR arg to AUTOLEAD? (toggle)
    195. 

  195. #AUTO_LEAD              Using autolead? (toggle)
    196. 

  196. #AUTO_LEAD_VALUE        Auto leading value
    197. 

  197. #BL_INDENT              Value of left indent when IB
    198. 

  198. #B_MARGIN               Bottom margin
    199. 

  199. #BOLDER_UNITS           # of units to embolden type
    200. 

  200. #BR_INDENT              Value of right indent when IB
    201. 

  201. c                       column mark
    202. 

  202. #CONDENSE               Are we in pseudo-condense mode? (toggle)
    203. 

  203. #CONDENSE_WAS_ON        For restoring \*[COND] in DROPCAP
    204. 

  204. #COND_WIDTH             Width of pseudo-condensed type
    205. 

  205.                         (pointsize x $COND_PERCENT)
    206. 

  206. #CURRENT_L_LENGTH       Current line length at first invocation of LIST;
    207. 

  207.                         like #ORIG_L_LENGTH
    208. 

  208. #CURRENT_TAB            Current tab number
    209. 

  209. #DC_GUT                 Width of dropcap gutter
    210. 

  210. #DEGREES                # of degrees slant for pseudo-italic
    211. 

  211. #ENUMERATOR&lt;n&gt;          Number register enumerator for depth &lt;n&gt; in lists 
    212. 

  212. #EXT_WIDTH              Width of pseudo-extended type
    213. 

  213.                         (pointsize x $EXT_PERCENT)
    214. 

  214. #EXTEND                 Are we in pseudo-extend mode? (toggle)
    215. 

  215. #EXTEND_WAS_ON          For restoring \*[EXT] in DROPCAP
    216. 

  216. #FILL_MODE              Are we in fill mode (i.e. \n(.u=1)? (toggle)
    217. 

  217. #H_INDENT               Value of left indent when IH
    218. 

  218. #HL_INDENT              Value of the hang when IH
    219. 

  219. #HYPHENATE              Hyphenation on? (toggle)
    220. 

  220. #HY_SET                 Did we manually set hyphenation parameters?
    221. 

  221.                         (toggle)
    222. 

  222. #IN_TAB                 Are we in a tab? (toggle)
    223. 

  223.                         Set in macro TAB; used in ST to determine
    224. 

  224.                         whether to add #ST_OFFSET to #ST&lt;#&gt;_OFFSET
    225. 

  225. #INDENT_ACTIVE          Indicates whether an indent is active (toggle)
    226. 

  226. #INDENT_BOTH_ACTIVE     Toggle
    227. 

  227. #INDENT_LEFT_ACTIVE     Toggle
    228. 

  228. #INDENT_RIGHT_ACTIVE    Toggle
    229. 

  229. #INDENT_STYLE_BOTH      Indicates IB when #INDENT_ACTIVE=1 (toggle)
    230. 

  230. #INDENT_STYLE_HANG      Indicates IH when #INDENT_ACTIVE=1 (toggle)
    231. 

  231. #INDENT_STYLE_LEFT      Indicates IL when #INDENT_ACTIVE=1 (toggle)
    232. 

  232. #INDENT_STYLE_RIGHT     Indicates IR when #INDENT_ACTIVE=1 (toggle)
    233. 

  233. #INDENT_STYLE_TEMP      Indicates IT when #INDENT_ACTIVE=1 (toggle)
    234. 

  234. #IX_WARN                Toggles to 1 the first time IX is user-invoked
    235. 

  235. #JUSTIFY                In EW/RW, when BR_AT_LINE_KERN, whether to
    236. 

  236.                         break or break-spread preceding line (toggle)
    237. 

  237. #KERN                   Kern on? (toggle)
    238. 

  238. #LAST_TAB               Last tab number set in multi-columns
    239. 

  239. #LEAD                   Leading (alias)
    240. 

  240. #LIGATURES              Ligatures on? (toggle)
    241. 

  241. #LIST_INDENT&lt;n&gt;         Left indent of list &lt;n&gt;
    242. 

  242. #L_INDENT               Value of left indent
    243. 

  243. #L_LENGTH               Line length
    244. 

  244. #L_MARGIN               Page offset if set with LMARGIN;
    245. 

  245.                         if .po used, \n(.o returns page offset
    246. 

  246. #LOOP                   #LOOP=1 if a while loop executes; otherwise 0.
    247. 

  247. #NEXT_DEPTH_BACK        Next list level back in lists
    248. 

  248. #NEXT_TAB               Current tab number + 1 (used in TN)
    249. 

  249. #NEXT_TAB               Next tab in an n+1 sequence
    250. 

  250. #OLD_LEAD               Lead in effect prior to changing it with .vs
    251. 

  251.                         in .LS
    252. 

  252. #OPEN_CLOSE             Manipulates character " to print `` or ''
    253. 

  253. #ORIGINAL_L_LENGTH      Used in LIST for IB processing; holds \n(.l
    254. 

  254. p                       Output line horiz position at end of
    255. 

  255.                         $PAD_STRING
    256. 

  256. #PAD_COUNT              Number of times # was included in arg to PAD
    257. 

  257. #PAD_LIST_DIGITS        Pad list digits to the left? (toggle)
    258. 

  258. #PAD_SPACE              Size of padding space
    259. 

  259. #PAGE_LENGTH            Page length (alias)
    260. 

  260. #PAGE_WIDTH             Page width
    261. 

  261. #PP_ACTIVE              Are we in the context of a para? (toggle)
    262. 

  262. #PRINT_FOOTER_ON_PAGE_1 (toggle)
    263. 

  263. #PSEUDO_FILL            Signals that LEFT, RIGHT or CENTER is
    264. 

  264.                         in effect (toggled off, i.e. to 0, when
    265. 

  265.                         QUAD <arg> or JUSTIFY is called)
    266. 

  266. #PT_SIZE                Point size (fractional) in units (alias)
    267. 

  267. #Q_AT_TOP               Does a quote start at the top of a new page?
    268. 

  268.                         (toggle)
    269. 

  269. #QUAD                   In autoquad mode? (toggle)
    270. 

  270. #QUIT                   Tells LIST whether to exit lists completely
    271. 

  271.                         (toggle)
    272. 

  272. #REMOVE                 Used in LIST OFF cleanup
    273. 

  273. #RESTORE_LEAD           Lead value in effect prior to AUTOLEAD
    274. 

  274. #RESTORE_LINE_LENGTH    Restores actual line length in RULE
    275. 

  275. #RESTORE_LN_NUMBER      Start linenumbering again with stored
    276. 

  276.                         #NEXT_LN? (toggle)
    277. 

  277. #RESTORE_PT_SIZE        Stores current point size (in units) prior
    278. 

  278.                         to underscore
    279. 

  279. #R_INDENT               Value of right indent
    280. 

  280. #R_MARGIN               Right margin
    281. 

  281. #RESTORE_PREV_INDENT    Tells LIST OFF what kind of indent was active
    282. 

  282.                         prior to first invocation of LIST
    283. 

  283. #RLD                    RLD value
    284. 

  284. #SILENT                 Is silent on? (toggle)
    285. 

  285. #SIZE_FOR_PAD           Used to ensure that the size in effect prior
    286. 

  286.                         to PAD is restored at the start of every
    287. 

  287.                         iteration of $PAD_STRING
    288. 

  288. #SLANT_ON               Is SLANT on? (toggle)
    289. 

  289. #SMART_QUOTES           Smartquotes on? (toggle)
    290. 

  290. #SPACE_TO_END           Whitespace at end of string passed to PAD
    291. 

  291. #ST&lt;#&gt;_LENGTH           Length of ST&lt;#&gt;; calculated during ST &lt;#&gt;
    292. 

  292. #ST&lt;#&gt;_MARK             Page offset of autotab &lt;#&gt; at ST&lt;#&gt;X
    293. 

  293. #ST_NUM                 Incrementing counter for autotab identification
    294. 

  294. #ST_OFFSET              Offset (from current tab) to add to #ST&lt;#&gt;_OFFSET
    295. 

  295.                         when calculating string indents set from within
    296. 

  296.                         tabs
    297. 

  297. #ST&lt;#&gt;_OFFSET           Indent of autotab &lt;#&gt; (page offset)
    298. 

  298. #STORED_L_INDENT        Current left indent at first invocation of LIST
    299. 

  299. #STORED_R_INDENT        Current right indent at first invocation of LIST
    300. 

  300. #STORED_BL_INDENT       Current "both, left" indent at first invocation
    301. 

  301.                         of LIST
    302. 

  302. #STORED_BR_INDENT       Current "both, right" indent at first invocation
    303. 

  303.                         of LIST
    304. 

  304. #STORED_HL_INDENT       Current hanging indent at first invocation
    305. 

  305.                         of LIST
    306. 

  306. #STORED_T_INDENT        Current temporary indent at first invocation
    307. 

  307.                         of LIST
    308. 

  308. #T_INDENT               Value of temporary indent
    309. 

  309. #T_MARGIN               Top margin
    310. 

  310. #TAB_ACTIVE             Are we in a tab? (toggle)
    311. 

  311. #TAB_NUMBER             Tab number
    312. 

  312. #TAB_OFFSET             Tab indent
    313. 

  313. #TOP                    Set to 1 in T_MARGIN, DO_T_MARGIN and ALD; tells
    314. 

  314.                         the first LS or AUTOLEAD on a page to maintain
    315. 

  315.                         the baseline position prior to the LS call
    316. 

  316. #TOP_BASELINE_ADJ       Amount by which to adjust the baseline position
    317. 

  317.                         of the first line on the page if an LS or AUTOLEAD
    318. 

  318.                         request differs from the lead current at the end of
    319. 

  319.                         the previous page
    320. 

  320. #TOTAL_LISTS            Total number of lists in a nest
    321. 

  321. #USER_SET_L_LENGTH      Did user invoke LL? (toggle)
    322. 

  322. #USER_SET_TITLE_ITEM    Did user invoke TOC_TITLE_ENTRY?
    323. 

  323. u                       Horiz position of start of underscore
    324. 

  324. 

  325. +++STRINGS+++
    326. 

  326. 

  327. $COND_PERCENT        Percentage by which to pseudo-condense type
    328. 

  328. $COLOR_SCHEME        Color scheme used in NEWCOLOR
    329. 

  329. $CURRENT_QUAD        Restores current quad value in RULE
    330. 

  330. $CURRENT_TAB         Current tab number
    331. 

  331. $DC_ADJUST           +|- # of points to subtract from dropcap
    332. 

  332. $DC_FAM              Drop cap family
    333. 

  333. $DC_FT               Drop cap font
    334. 

  334. $ENUMERATOR&lt;n&gt;       String enumerator for depth &lt;n&gt; in lists 
    335. 

  335. $EXT_PERCENT         Percentage by which to pseudo-extend type
    336. 

  336. $FAMILY              Family
    337. 

  337. $FAMILY_FOR_PAD      Used to ensure that the family in effect prior
    338. 

  338.                      to PAD is restored at the start of every
    339. 

  339.                      iteration of $PAD_STRING
    340. 

  340. $FONT                Font
    341. 

  341. $FONT_FOR_PAD        Used to ensure that the font in effect prior
    342. 

  342.                      to PAD is restored at the start of every
    343. 

  343.                      iteration of $PAD_STRING
    344. 

  344. $PAD_MARKER          Character to mark off padding in PAD
    345. 

  345. $PAD_STRING          Arg passed to PAD
    346. 

  346. $QUAD_VALUE          Quad value (left, right, centre, justify)
    347. 

  347. $QUOTE0              Open quotation marks
    348. 

  348. $QUOTE1              Close quotation marks
    349. 

  349. $RESTORE_COND        Restores the pseudo-condense value in effect
    350. 

  350.                      prior to DROPCAP
    351. 

  351. $RESTORE_EXT         Restores the pseudo-extend value in effect
    352. 

  352.                      prior to DROPCAP
    353. 

  353. $RESTORE_FAM         Used to restore the family in effect
    354. 

  354.                      prior to DROPCAP
    355. 

  355. $RESTORE_FT          Used to restore the font/fontstyle in effect
    356. 

  356.                      prior to DROPCAP
    357. 

  357. $RESTORE_PT_SIZE     Used to restore the point size of normal
    358. 

  358.                      running text after a dropcap
    359. 

  359. $RESTORE_QUAD_VALUE  Quad value for use in restoring L, R, C, J
    360. 

  360.                      (after tabs)
    361. 

  361. $SAVED_STYLE         Current style, if there is one (used in FAMILY)
    362. 

  362. $SEPARATOR&lt;n&gt;        Separator for depth &lt;n&gt; in lists
    363. 

  363. $SS_VAR              Holds + or - sentence space value
    364. 

  364. $ST&lt;#&gt;_FILL          Always QUAD if QUAD passed to ST &lt;#&gt;
    365. 

  365. $ST&lt;#&gt;_QUAD_DIR      Quad direction supplied to ST for &lt;#&gt;
    366. 

  366. $TAB_NUMBER          Argument passed to TAB macro to call TAB# macro
    367. 

  367.                      created in TAB_SET
    368. 

  368. $WS_CONSTANT         12; used to hold groff default wordspace
    369. 

  369. $WS                  Holds WS value; concatenation of WS_CONSTANT and
    370. 

  370.                      WS_VAR
    371. 

  371. $WS_VAR              + or - value to add to $WS_CONSTANT
    372. 

  372. BLACK                Pre-defined black color
    373. 

  373. black                Pre-defined black color
    374. 

  374. WHITE                Pre-defined white color
    375. 

  375. white                Pre-defined white color
    376. 

  376. 

  377. +++ALIASES+++
    378. 

  378. 

  379. ALIAS         als
    380. 

  380. ALIASN        aln
    381. 

  381. BR            br
    382. 

  382. CENTRE        CENTER
    383. 

  383. COLOUR        COLOR
    384. 

  384. COMMENT       SILENT
    385. 

  385. CONDENSE      CONDENSE_OR_EXTEND
    386. 

  386. EXTEND        CONDENSE_OR_EXTEND
    387. 

  387. FAM           FAMILY
    388. 

  388. FT            FONT
    389. 

  389. HYPHENATE     HY
    390. 

  390. HYPHENATION   HY
    391. 

  391. LIG           LIGATURES
    392. 

  392. LL            LINE_LENGTH
    393. 

  393. MAC           de
    394. 

  394. NEW_PAGE      bp
    395. 

  395. NEWCOLOUR     NEWCOLOR
    396. 

  396. NEWPAGE       NEW_PAGE
    397. 

  397. PAGELENGTH    PAGE_LENGTH
    398. 

  398. PAGE_LENGTH   pl
    399. 

  399. PAGEWIDTH     PAGE_WIDTH
    400. 

  400. SPREAD        brp
    401. 

  401. SP            sp
    402. 

  402. STRING        ds
    403. 

  403. TABSET        TAB_SET
    404. 

  404. TB            TAB
    405. 

  405. TI            IT
    406. 

  406. UNDERSCORE_2  UNDERSCORE2
    407. 

  407. XCOLOUR       XCOLOR
    408. 

  408. 

  409. +++ALIASES FOR NUMBER REGISTERS+++
    410. 

  410. 

  411. #DIVER_DEPTH    dn   -- diversion depth
    412. 

  412. #DIVER_WIDTH    dl   -- diversion width
    413. 

  413. #INDENT         .i   -- value of current indent
    414. 

  414. #LEAD           .v   -- line space (.vs, not .ls)
    415. 

  415. #L_LENGTH       .l   -- line length
    416. 

  416. #NUM_ARGS       .$   -- number of arguments passed to a macro
    417. 

  417. #PAGE_LENGTH    .p   -- page length
    418. 

  418. #PT_SIZE        .ps  -- current point size (fractional) in units
    419. 

  419. #TRAP_DISTANCE  .t   -- distance to next trap
    420. 

  420. 

  421. +++INLINE ESCAPES+++
    422. 

  422. 

  423. BCK          Inline backward horizontal movement
    424. 

  424. BOLDER       Pseudo-bold on
    425. 

  425. BOLDERX      Pseudo-bold off
    426. 

  426. BP           Back points (horizontal movement)
    427. 

  427. BU           Back units (inline pairwise kerning)
    428. 

  428. COND_FOR_SUP Pseudo-condense string for use with superscripts
    429. 

  429.              (called with CONDSUP)
    430. 

  430. COND_FOR_SUP Pseudo-extend string for use with superscripts (called
    431. 

  431.              with EXTSUP)
    432. 

  432. COND         Pseudo-condense type
    433. 

  433. CONDX        Pseudo-condense off
    434. 

  434. CONDSUP      Pseudo-condensed superscript (using value set with
    435. 

  435.              CONDENSE)
    436. 

  436. CONDSUPX     Pseudo-condensed superscript off
    437. 

  437. DOWN         Inline downward vertical movement
    438. 

  438. EXT          Pseudo-extend type
    439. 

  439. EXTX         Pseudo-extend off
    440. 

  440. EXTSUP       Pseudo-extended superscript
    441. 

  441. EXTSUPX      Pseudo-extended superscript off
    442. 

  442. FP           Forward points (horizontal movement)
    443. 

  443. FU           Forward units (inline pairwise kerning)
    444. 

  444. FWD          Inline forward horizontal movement
    445. 

  445. LEADER       Deposit leader to end of current LL or TAB
    446. 

  446. RULE         Draw a rule to the full measure of the current line or
    447. 

  447.              tab length
    448. 

  448. SLANT        Slant (pseudo-italic on
    449. 

  449. SLANTX       Slant off
    450. 

  450. ST&lt;#&gt;        String tab end marker
    451. 

  451. ST&lt;#&gt;        String tab start marker
    452. 

  452. SUP          Superscript
    453. 

  453. SUPX         Superscript off
    454. 

  454. UP           Inline upward vertical movement
    455. 

  455. 

  456. +++SPECIAL CHARACTERS+++
    457. 

  457. 

  458. FEET         The foot character \(fm
    459. 

  459. INCH         The inch character \(fm\(fm
    460. 

  460. 

  461. ------------------------------------------------------------------------
    462. 

  462. 

  463. DOCUMENT PROCESSING
    464. 

  464. ===================
    465. 

  465. 

  466. +++MACROS+++
    467. 

  467. 

  468. Document info
    469. 

  469. -------------
    470. 

  470. AUTHOR          Author
    471. 

  471. CHAPTER         Chapter number
    472. 

  472. CHAPTER_TITLE   Chapter title
    473. 

  473. COPYRIGHT       Copyright info (covers only)
    474. 

  474. DOCTITLE        Overall doc title (for collated docs)
    475. 

  475. DRAFT           Draft number
    476. 

  476. MISC            Misc info (covers only)
    477. 

  477. REVISION        Revision number
    478. 

  478. SUBTITLE        Doc subtitle
    479. 

  479. TITLE           Doc title
    480. 

  480. 

  481. Covers
    482. 

  482. ------
    483. 

  483. COVER               What goes on cover
    484. 

  484. COVERS              Whether covers get printed (toggle)
    485. 

  485. COVER_ADVANCE       Set vertical start position of cover material
    486. 

  486. COVER_LEAD          Overall leading of covers
    487. 

  487. COVERTITLE          User-defined cover title string
    488. 

  488. DOC_COVER           What goes on doc cover
    489. 

  489. DOC_COVERS          Whether doc covers get printed
    490. 

  490. DOC_COVER_ADVANCE   Set vertical start position of doc cover material
    491. 

  491. DOC_COVER_LEAD      Overall leading of doc covers
    492. 

  492. DOC_COVERTITLE      User-defined doc cover title string
    493. 

  493. 

  494. Document style
    495. 

  495. --------------
    496. 

  496. COPYSTYLE     Output style (DRAFT or FINAL)
    497. 

  497. DEFAULTS      In START, sets defaults
    498. 

  498. DOCTYPE       Kind of doc (DEFAULT, CHAPTER, NAMED, LETTER)
    499. 

  499. PAGENUMBER    Page number that appears on 1st page of doc
    500. 

  500. PAPER         Paper size (LETTER, LEGAL, A4)
    501. 

  501. PRINTSTYLE    Print style (TYPEWRITE or TYPESET)
    502. 

  502. NUMBER_LINES  Number output lines in the left margin
    503. 

  503. 

  504. Document tags and macros
    505. 

  505. ------------------------
    506. 

  506. ADD_SPACE               Special macro to add space to the top of a pages after
    507. 

  507.                         page 1; must be preceded by NEWPAGE
    508. 

  508. BIBLIOGRAPHY            Begin a bibliography page
    509. 

  509. BIBLIOGRAPHY_TYPE       LIST or PLAIN
    510. 

  510. BLOCKQUOTE              Block-indented, quoted text
    511. 

  511. COL_BREAK               Breaks and spreads line before invocation; moves to
    512. 

  512.                         next column on page or 1st col of next page.  An alias
    513. 

  513.                         of COL_NEXT.
    514. 

  514. COL_NEXT                Moves to next column on page or 1st col of next page
    515. 

  515. ENDNOTE                 Endnote
    516. 

  516. ENDNOTE_REFS            Send REFs to endnotes
    517. 

  517. ENDNOTES                Output endnotes
    518. 

  518. EPIGRAPH                Epigraph before 1st para 
    519. 

  519. FINIS                   Prints --END--
    520. 

  520. FOOTNOTE                Collects footnotes in text for printing at bottom of page
    521. 

  521. FOOTNOTE_REFS           Send REFs to footnotes
    522. 

  522. HEAD                    Section title (main heads)
    523. 

  523. HYPHENATE_REFS          Turn on/off hyphenation of REF references
    524. 

  524. ITEM                    Begin a list item
    525. 

  525. LINEBREAK               Break between narrative sections
    526. 

  526. LIST                    Initialize a list
    527. 

  527. MN                      Margin note
    528. 

  528. MN_INIT                 Initialize parameters for margin notes
    529. 

  529. NUMBER_LINES            Number text lines
    530. 

  530. NUMBER_BLOCKQUOTE_LINES Number blockquote lines
    531. 

  531. NUMBER_QUOTE_LINES      Number quote lines
    532. 

  532. PAD_LIST_DIGITS         Leave space for two-numeral digit enumerators
    533. 

  533.                         in a list
    534. 

  534. PARAHEAD                Paragraph head
    535. 

  535. PP                      Paragraph
    536. 

  536. QUOTE                   Poetic or line for line quotes
    537. 

  537. REF                     Wrapper around FOOTNOTE or ENDNOTE, depending
    538. 

  538.                         on FOOTNOTE_REFS or ENDNOTE_REFS
    539. 

  539. REF(                    Begin embedded reference, parens
    540. 

  540. REF)                    End embedded reference, parens
    541. 

  541. REF[                    Begin embedded reference, square brackets
    542. 

  542. REF]                    End embedded reference, square brackets
    543. 

  543. REF{                    Begin embedded reference, braces
    544. 

  544. REF}                    End embedded reference, braces
    545. 

  545. REF_INDENT              Amount of 2nd line indent of references for
    546. 

  546.                         footnote, endnote or bibliography refs
    547. 

  547. RESET_LIST              Reset digit or alpha list enumerator
    548. 

  548. SHIFT_LIST              Move a list over to the right
    549. 

  549. START                   Sets doc defaults and prints info collected
    550. 

  550.                         with doc info macros
    551. 

  551. SUBHEAD                 Subheads
    552. 

  552. 

  553. Headers/footers
    554. 

  554. ---------------
    555. 

  555. BREAK_QUOTE          Manually break a footnoted quote that crosses
    556. 

  556.                      a page/column
    557. 

  557. DO_FOOTER            Prints footer (after footnote processing, if any)
    558. 

  558. FOOTER_ON_FIRST_PAGE Print footer on first page? (toggle)
    559. 

  559. FOOTER               Trap-invoked footer macro
    560. 

  560. HEADER               Trap-invoked header macro
    561. 

  561. PAGINATE             Turns page numbering on or off (doc default=on)
    562. 

  562. PAGINATE_TOC         Turns pagination of toc on or off (default=on)
    563. 

  563. RECTO_VERSO          Enables switch HEADER_LEFT and HEADER_RIGHT on
    564. 

  564.                      alternate pages
    565. 

  565. 

  566. Alter doc "look" and/or change defaults
    567. 

  567. ---------------------------------------
    568. 

  568. ***General***
    569. 

  569. 

  570. ALWAYS_FULLSPACE_QUOTES  Fullspace quotes instead of default
    571. 

  571.                          1/2 spacing them.
    572. 

  572. ATTRIBUTE_STRING         What to print before author (default is "by")
    573. 

  573. CHAPTER_STRING           What to print whenever the word "chapter"
    574. 

  574.                          is required
    575. 

  575. COLUMNS                  Print in columns
    576. 

  576. DOC_FAMILY               Overall doc family
    577. 

  577. DOCHEADER                Print doc header?
    578. 

  578. DOCHEADER_ADVANCE        Start position of docheader (relative to top
    579. 

  579.                          of page)
    580. 

  580. DOCHEADER_LEAD           +|- value applied to #DOC_LEAD to in/decrease
    581. 

  581.                          leading of doc header
    582. 

  582. DOC_LEAD_ADJUST          Adjust #DOC_LEAD to fill page to #B_MARGIN
    583. 

  583. DOC_LEAD                 Overall doc leading
    584. 

  584. DOC_LEFT_MARGIN          Doc left margin
    585. 

  585. DOC_LINE_LENGTH          Doc line length
    586. 

  586. DOC_PT_SIZE              Overall doc point size
    587. 

  587. DOC_RIGHT_MARGIN         Doc right margin
    588. 

  588. DOC_TITLE                Overall doc title that gets printed in
    589. 

  589.                          headers/footers (mostly for use with collated
    590. 

  590.                          docs where each doc is an article with a
    591. 

  591.                          different title
    592. 

  592. DRAFT_STRING             What to print whenever the word "draft" is
    593. 

  593.                          required
    594. 

  594. DRAFT_WITH_PAGENUMBER    Attach draft/revision info to page number
    595. 

  595.                          (instead of putting it HEADER centre)
    596. 

  596. REVISION_STRING          What to print whenever the word "revision"
    597. 

  597.                          is required
    598. 

  598. 

  599. ***Covers***
    600. 

  600. 

  601. COVER_ADVANCE            Vertical place on page to start outputting
    602. 

  602.                          cover material
    603. 

  603. COVER_LEAD               Lead in/decrease for cover pages
    604. 

  604. DOC_COVER_ADVANCE        Vertical place on page to start outputting
    605. 

  605.                          doc cover material
    606. 

  606. DOC_COVER_LEAD           Lead in/decrease for doc cover pages
    607. 

  607. 

  608. ***Epigraphs and finis***
    609. 

  609. 

  610. EPIGRAPH_AUTOLEAD        Autolead value for epigraphs
    611. 

  611. EPIGRAPH_INDENT          Value by which to multiply PP_INDENT for
    612. 

  612.                          block epigraphs
    613. 

  613. FINIS_STRING             What to print when FINIS is invoked
    614. 

  614. 

  615. ***Footnotes***
    616. 

  616. 

  617. FOOTNOTE_AUTOLEAD             Autolead to use in footnotes
    618. 

  618. FOOTNOTE_LINENUMBER_BRACKETS  Brackets for footnote linenumbers
    619. 

  619. FOOTNOTE_LINENUMBER_SEPARATOR Separator for footnote linenumbers
    620. 

  620. FOOTNOTE_MARKERS              Turns footnote markers on or off
    621. 

  621. FOOTNOTE_MARKER_STYLE         STAR or NUMBER; default=STAR
    622. 

  622. FOOTNOTE_RULE_ADJ             # of points to raise footnote rule from its
    623. 

  623.                               baseline
    624. 

  624. FOOTNOTE_RULE_LENGTH          Length of footnote separator rule
    625. 

  625. FOOTNOTE_RULE                 Turns printing of fn separator rule on or off;
    626. 

  626.                               default is on
    627. 

  627. FOOTNOTE_SPACING              Post footnote item spacing
    628. 

  628. FOOTNOTES_RUN_ON              Run footnotes on (line numbering mode only)
    629. 

  629. RESET_FOOTNOTE_NUMBER         Reset fn# to 1, or, if arg PAGE, reset
    630. 

  630.                               automatically to 1 on every page
    631. 

  631. RUNON_WARNING                 Utility macro; warns if FOOTNOTES_RUN_ON
    632. 

  632.                               was called when fn marker style is STAR or NUMBER
    633. 

  633. 

  634. ***Endnotes***
    635. 

  635. 

  636. ENDNOTE_LEAD                 Leading for endnotes page
    637. 

  637. ENDNOTE_LINENUMBER_BRACKETS  Brackets around line numbers identifying
    638. 

  638.                              endnotes and text
    639. 

  639. ENDNOTE_LINENUMBER_GAP       Amount of space to leave between line
    640. 

  640. ENDNOTE_LINENUMBER_SEPARATOR Separator between line numbers identifying
    641. 

  641.                              endnotes and the endnote item text
    642. 

  642.                              endnotes and text
    643. 

  643. ENDNOTE_MARKER_STYLE         NUMBER or LINE
    644. 

  644. ENDNOTE_NUMBERS_ALIGN_RIGHT  Hang endnote numbers and align right
    645. 

  645. ENDNOTE_NUMBERS_ALIGN_LEFT   Don't hang endnote numbers and align left
    646. 

  646. ENDNOTE_PARA_INDENT          First line indent of paras in multi-para
    647. 

  647.                              endnotes
    648. 

  648. ENDNOTE_PARA_SPACE           Whether to space paras in multi-para endnotes
    649. 

  649. ENDNOTE_PT_SIZE              Base point size for endnotes page
    650. 

  650. ENDNOTE_STRING               Endnotes page head
    651. 

  651. ENDNOTE_STRING_CAPS          Capitalize the endnotes string
    652. 

  652. ENDNOTE_STRING_UNDERSCORE    Underscoring of endnotes page head
    653. 

  653. ENDNOTE_TITLE                Endnotes identifying title
    654. 

  654. ENDNOTE_TITLE_SPACE          Distance from top of page to endnotest title
    655. 

  655. ENDNOTE_TITLE_UNDERSCORE     Underscoring of endnotes identifying title
    656. 

  656. ENDNOTES_ALLOWS_HEADERS      Page headers on endnotes pages? (toggle)
    657. 

  657. ENDNOTES_FIRST_PAGENUMBER    Page number to appear on page 1 of endnotes
    658. 

  658.                              pages
    659. 

  659. ENDNOTES_HDRFTR_CENTER       Print header/footer centre string on endnotes
    660. 

  660.                              pages?
    661. 

  661. ENDNOTES_HEADER_CENTER       Print header centre string on endnotes pages?
    662. 

  662. ENDNOTES_FOOTER_CENTER       Print footer centre string on endnotes pages?
    663. 

  663. ENDNOTES_NO_COLUMNS          Turn columnar mode off for endnotes pages
    664. 

  664. ENDNOTES_NO_FIRST_PAGENUM    Don't print a pagenumber on page 1 of
    665. 

  665.                              endnotes.
    666. 

  666. ENDNOTES_PAGENUM_STYLE       Set numbering style for endnotes pages page
    667. 

  667.                              numbers
    668. 

  668. SINGLESPACE_ENDNOTES         Single space TYPEWRITE endnotes
    669. 

  669. 

  670. ***Bibliographies***
    671. 

  671. 

  672. BIBLIOGRAPHY_ALLOWS_HEADERS    Allow headers on bib pages
    673. 

  673. BIBLIOGRAPHY_FIRST_PAGENUMBER  Starting page number for bibliographies
    674. 

  674. BIBLIOGRAPHY_HDRFTR_CENTER     Header/footer center string for bib pages
    675. 

  675. BIBLIOGRAPHY_LEAD              Base lead of bib pages
    676. 

  676. BIBLIOGRAPHY_NO_COLUMNS        De-columnize bibliographies
    677. 

  677. BIBLIOGRAPHY_NO_FIRST_PAGENUM  Don't print a page number on the first
    678. 

  678.                                page of bibliographies
    679. 

  679. BIBLIOGRAPHY_PAGENUM_STYLE     Format for bib pages page numbering
    680. 

  680. BIBLIOGRAPHY_PT_SIZE           Base point size for bib pages
    681. 

  681. BIBLIOGRAPHY_SPACING           Post bib entry space
    682. 

  682. BIBLIOGRAPHY_STRING            String for bib title
    683. 

  683. BIBLIOGRAPHY_STRING_CAPS       Capitalize bib title string
    684. 

  684. BIBLIOGRAPHY_STRING_UNDERSCORE Underscore bib title string
    685. 

  685. SINGLESPACE_BIBLIOGRAPHY       Singlespace bibs if PRINTSTYLE TYPEWRITE
    686. 

  686. 

  687. ***Headers and footers***
    688. 

  688. 

  689. FOOTER_COLOR             Footer color
    690. 

  690. FOOTER_GAP               Distance between running text and footer
    691. 

  691. FOOTER_MARGIN            Distance from footer to bottom of page
    692. 

  692. FOOTERS                  Turns footers on or off
    693. 

  693. HDRFTR_CENTER            String to go in centre part of header/footer;
    694. 

  694.                          default doctype 
    695. 

  695. HDRFTR_CENTER_CAPS       Centre part of header/footer in caps? (toggle)
    696. 

  696. HDRFTR_CENTER_PAD        Pad hdrftr CENTER left or right by specified
    697. 

  697.                          amount
    698. 

  698. HDRFTR_GAP               Distance from header/footer to running text
    699. 

  699. HDRFTR_LEFT_CAPS         Left part of header/footer in caps? (toggle)
    700. 

  700. HDRFTR_LEFT              String to go in left part of header/footer;
    701. 

  701.                          default is AUTHOR_1
    702. 

  702. HDRFTR_LEFT              The header/footer left string
    703. 

  703. HDRFTR_MARGIN            Distance from top of page to header
    704. 

  704. HDRFTR_PLAIN             Header/footer fam/ft/ps all same as running
    705. 

  705.                          text
    706. 

  706. HDRFTR_RECTO             User-defined, single string recto
    707. 

  707.                          header/footer
    708. 

  708. HDRFTR_RIGHT_CAPS        Right part of header/footer in caps? (toggle)
    709. 

  709. HDRFTR_RIGHT             The header/footer right string
    710. 

  710. HDRFTR_RULE_GAP          Space between header/footer and header/footer
    711. 

  711.                          rule
    712. 

  712. HDRFTR_RULE_INTERNAL     Prints the header/footer rule
    713. 

  713. HDRFTR_RULE              Turns header/footer rule on or off
    714. 

  714.                          When invoked internally, prints the rule.
    715. 

  715. HDRFTR_VERSO             User-defined, single string verso
    716. 

  716.                          header/footer
    717. 

  717. HEADERS                  Turns headers on or off
    718. 

  718. SWITCH_HDRFTR            Switch HDRFTR_LEFT and HDRFTR_RIGHT
    719. 

  719. 

  720. ***Page numbering***
    721. 

  721. 

  722. PAGENUM_HYPHENS          Turns on/off hyphens surrounding page numbers
    723. 

  723. PAGENUM_ON_FIRST_PAGE    Print page number on first page when footers
    724. 

  724.                          are on (toggle)
    725. 

  725. PAGENUM_POS              Controls placement of page numbers;
    726. 

  726.                          default=bottom/centred
    727. 

  727. PAGENUM_SIZE             How much to in/decrease point size of page
    728. 

  728.                          numbers*
    729. 

  729. PAGENUM_STYLE            Page # in roman, Arabic, or alphabetic
    730. 

  730. RESTORE_PAGINATION       Restore pagination after outputting non-
    731. 

  731.                          paginated endnotes.
    732. 

  732. SUSPEND_PAGINATION       Suspend pagination prior to outputting
    733. 

  733.                          endnotes
    734. 

  734. 

  735. ***Heads***
    736. 

  736. 

  737. HEADER_GAP               Space between header and running text
    738. 

  738. HEADER_MARGIN            Space from top of page to header
    739. 

  739. HEAD_CAPS                Print section titles in caps? (toggle)
    740. 

  740. HEAD_SPACE               Give HEADs 2 line-spaces before. If OFF,
    741. 

  741.                          only 1.  Default is on.
    742. 

  742. HEAD_UNDERLINE           Underline section titles? (toggle)
    743. 

  743. NUMBER_HEADS             Print head numbers
    744. 

  744. RESET_HEAD_NUMBER        Reset head number
    745. 

  745. 

  746. ***Subheads***
    747. 

  747. 

  748. NUMBER_SUBHEADS          Print subhead numbers
    749. 

  749. RESET_SUBHEAD_NUMBER     Reset subhead number
    750. 

  750. 

  751. ***Para heads***
    752. 

  752. 

  753. NUMBER_PARAHEADS         Print parahead numbers
    754. 

  754. PARAHEAD_INDENT          How much to indent paraheads
    755. 

  755. RESET_PARAHEAD_NUMBER    Reset parahead number
    756. 

  756. 

  757. ***Paragraphs***
    758. 

  758. 

  759. INDENT_FIRST_PARAS       Indent 1st paras? (doc default=not indented) 
    760. 

  760. PARA_INDENT              Size of para indent
    761. 

  761. PARA_SPACE               Put a line space before paras
    762. 

  762. PP_FONT                  Overall doc font
    763. 

  763. 

  764. ***Quotes***
    765. 

  765. 

  766. Q_FITS                  Utility macro for DO_QUOTE
    767. 

  767. Q_NOFIT                 Utility macro for DO_QUOTE
    768. 

  768. QUOTE_AUTOLEAD          Leading of (block)quotes
    769. 

  769. 

  770. ***Line/section breaks***
    771. 

  771. 

  772. LINEBREAK_CHAR           Linebreak character, iterations and positioning
    773. 

  773. 

  774. ***Printstyle TYPEWRITE***
    775. 

  775. 

  776. ITALIC_MEANS_ITALIC      For TYPEWRITE; render .FT I in italic.
    777. 

  777. SLANT_MEANS_SLANT        In TYPEWRITE, render \*[SLANT] as slant
    778. 

  778. UNDERLINE_ITALIC         In TYPEWRITE, render .FT I as underlined
    779. 

  779. UNDERLINE_QUOTES         In TYPEWRITE, underline quotes? (toggle)
    780. 

  780. UNDERLINE_SLANT          In TYPEWRITE, render \*[SLANT] as underlined
    781. 

  781. 

  782. ***Table of contents***
    783. 

  783. 

  784. TOC_APPENDS_AUTHORS      Appends author(s) to toc doc title entries
    785. 

  785. TOC_LEAD                 Leading of toc pages
    786. 

  786. TOC_PADDING              Number of placeholders for toc entries page
    787. 

  787.                          numbers
    788. 

  788. TOC_HEAD_INDENT          Indent of toc head entries
    789. 

  789. TOC_HEADER_STRING        TOC header string (default=Contents)
    790. 

  790. TOC_PAGENUM_STYLE        Page numbering style (hdrftr nums) of
    791. 

  791.                          toc pages
    792. 

  792. TOC_RV_SWITCH            Switch L/R margins of toc pages
    793. 

  793. TOC_PARAHEAD_INDENT      Indent of toc parahead entries
    794. 

  794. TOC_SUBHEAD_INDENT       Indent of toc subhead entries
    795. 

  795. TOC_TITLE_ENTRY          User supplied toc doc title entry
    796. 

  796. TOC_TITLE_INDENT         Indent of toc doc title entries
    797. 

  797. 

  798. ***Aliases for headers and footers***
    799. 

  799. HEADER_SIZE           HDRFTR_SIZE
    800. 

  800. HEADER_RIGHT_PS       HDRFTR_RIGHT_SIZE
    801. 

  801. HEADER_RIGHT_SIZE     HDRFTR_RIGHT_SIZE
    802. 

  802. HEADER_RIGHT_FAM      HDRFTR_RIGHT_FAMILY
    803. 

  803. HEADER_RIGHT_FAMILY   HDRFTR_RIGHT_FAMILY
    804. 

  804. HEADER_RIGHT_FONT     HDRFTR_RIGHT_FONT
    805. 

  805. HEADER_RIGHT_FT       HDRFTR_RIGHT_FONT
    806. 

  806. HEADER_LEFT_PS        HDRFTR_LEFT_SIZE
    807. 

  807. HEADER_LEFT_SIZE      HDRFTR_LEFT_SIZE
    808. 

  808. HEADER_LEFT_FAM       HDRFTR_LEFT_FAMILY
    809. 

  809. HEADER_LEFT_FAMILY    HDRFTR_LEFT_FAMILY
    810. 

  810. HEADER_LEFT_FONT      HDRFTR_LEFT_FONT
    811. 

  811. HEADER_LEFT_FT        HDRFTR_LEFT_FONT
    812. 

  812. HEADER_CENTRE_PS      HDRFTR_CENTER_SIZE
    813. 

  813. HEADER_CENTRE_SIZE    HDRFTR_CENTER_SIZE
    814. 

  814. HEADER_FAM            HDRFTR_FAMILY
    815. 

  815. HEADER_FAMILY         HDRFTR_FAMILY
    816. 

  816. HEADER_CENTRE_FAM     HDRFTR_CENTER_FAMILY
    817. 

  817. HEADER_CENTRE_FAMILY  HDRFTR_CENTER_FAMILY
    818. 

  818. HEADER_CENTRE_FONT    HDRFTR_CENTER_FONT
    819. 

  819. HEADER_CENTRE_FT      HDRFTR_CENTER_FONT
    820. 

  820. HEADER_CENTER_PS      HDRFTR_CENTER_SIZE
    821. 

  821. HEADER_CENTER_SIZE    HDRFTR_CENTER_SIZE
    822. 

  822. HEADER_CENTER_FAM     HDRFTR_CENTER_FAMILY
    823. 

  823. HEADER_CENTER_FAMILY  HDRFTR_CENTER_FAMILY
    824. 

  824. HEADER_CENTER_FONT    HDRFTR_CENTER_FONT
    825. 

  825. HEADER_CENTER_FT      HDRFTR_CENTER_FONT
    826. 

  826. FOOTER_SIZE           HDRFTR_SIZE
    827. 

  827. FOOTER_RIGHT_PS       HDRFTR_RIGHT_SIZE
    828. 

  828. FOOTER_RIGHT_SIZE     HDRFTR_RIGHT_SIZE
    829. 

  829. FOOTER_RIGHT_FAM      HDRFTR_RIGHT_FAMILY
    830. 

  830. FOOTER_RIGHT_FAMILY   HDRFTR_RIGHT_FAMILY
    831. 

  831. FOOTER_RIGHT_FONT     HDRFTR_RIGHT_FONT
    832. 

  832. FOOTER_RIGHT_FT       HDRFTR_RIGHT_FONT
    833. 

  833. FOOTER_LEFT_PS        HDRFTR_LEFT_SIZE
    834. 

  834. FOOTER_LEFT_SIZE      HDRFTR_LEFT_SIZE
    835. 

  835. FOOTER_LEFT_FAM       HDRFTR_LEFT_FAMILY
    836. 

  836. FOOTER_LEFT_FAMILY    HDRFTR_LEFT_FAMILY
    837. 

  837. FOOTER_LEFT_FONT      HDRFTR_LEFT_FONT
    838. 

  838. FOOTER_LEFT_FT        HDRFTR_LEFT_FONT
    839. 

  839. FOOTER_CENTRE_PS      HDRFTR_CENTER_SIZE
    840. 

  840. FOOTER_CENTRE_SIZE    HDRFTR_CENTER_SIZE
    841. 

  841. FOOTER_FAM            HDRFTR_FAMILY
    842. 

  842. FOOTER_FAMILY         HDRFTR_FAMILY
    843. 

  843. FOOTER_CENTRE_FAM     HDRFTR_CENTER_FAMILY
    844. 

  844. FOOTER_CENTRE_FAMILY  HDRFTR_CENTER_FAMILY
    845. 

  845. FOOTER_CENTRE_FT      HDRFTR_CENTER_FONT
    846. 

  846. FOOTER_CENTER_PS      HDRFTR_CENTER_SIZE
    847. 

  847. FOOTER_CENTER_SIZE    HDRFTR_CENTER_SIZE
    848. 

  848. FOOTER_CENTER_FAM     HDRFTR_CENTER_FAMILY
    849. 

  849. FOOTER_CENTER_FAMILY  HDRFTR_CENTER_FAMILY
    850. 

  850. FOOTER_CENTER_FONT    HDRFTR_CENTER_FONT
    851. 

  851. FOOTER_CENTER_FT      HDRFTR_CENTER_FONT
    852. 

  852. 

  853.    *relative to #DOC_PT_SIZE
    854. 

  854.   **relative to overall ps of headers as set by HEADER_SIZE
    855. 

  855.  ***relative to overall ps of endnotes pages
    856. 

  856. ****relative to overall ps of toc pages
    857. 

  857. 

  858. +++LETTER MACROS+++
    859. 

  859. 

  860. CLOSING      Closing (i.e. Yours truly,)
    861. 

  861. DATE         Date for letters
    862. 

  862. FROM         Addresser's name and address
    863. 

  863. GREETING     Full salutation (e.g. Dear John Smith,)
    864. 

  864. NO_SUITE     Remove suite page numbers from bottom of letter pages
    865. 

  865. TO           Addressee's name and address
    866. 

  866. ALL_DONE     .em (the "end macro") for letters
    867. 

  867. 

  868. +++SUPPORT+++
    869. 

  869. 

  870. CHECK_INDENT         Applies indents to doc elements inside ev's
    871. 

  871.                      (head, subhead, etc)
    872. 

  872. CLEANUP_DEFAULTS     Removes selected rregisters and strings
    873. 

  873.                      from DEFAULTS after START
    874. 

  874. DO_COVER             Formats and outputs covers
    875. 

  875. DO_DOC_COVER         Formats and outputs doc covers
    876. 

  876. D0_QUOTE             Outputs quotes with space adjustments before
    877. 

  877.                      and after
    878. 

  878. DIVER_FN_1_PRE  -+     
    879. 

  879. DIVER_FN_2_PRE   |   Manage footnotes called inside diversions
    880. 

  880.                  |   QUOTE, BLOCKQUOTE and EPIGRAPH
    881. 

  881. DIVER_FN_2_POST -+
    882. 

  882. DIVERT_FN_LEFTOVER   Diverts excess fn stored in FN_OVERFLOW into
    883. 

  883.                      FOOTNOTE
    884. 

  884. DIVERT_FN_OVERFLOW   Diverts excess fn stored in FN_OVERFLOW when
    885. 

  885.                      FN_DEFER into FOOTNOTE
    886. 

  886. DO_EPIGRAPH          Outputs epigraphs with space adjustments before
    887. 

  887.                      and after
    888. 

  888. FN_OVERFLOW_TRAP     Fixed at B_MARGIN; if footnotes run longer than
    889. 

  889.                      B_MARGIN, diverts excess into FN_OVERFLOW
    890. 

  890. GET_ROMAN_INDENT     Figures out amount of space to reserve
    891. 

  891.                      for roman numerals in lists
    892. 

  892. HDRFTR_RULE          Prints rule under header or over footer
    893. 

  893. MN_OVERFLOW_TRAP     Trap-invoked macro to collect margin note
    894. 

  894.                      overflows
    895. 

  895. PRINT_FOOTNOTE_RULE  An alias of PRINT_FOOTNOTE; prints footnote
    896. 

  896.                      separator rule
    897. 

  897. PRINT_HDRFTR         Prints header/footer (trap invoked)
    898. 

  898. PRINT_PAGE_NUMBER    Invoked in HEADER or FOOTER
    899. 

  899. PRINT_USERDEF_HDRFTR Prints user defined, single string recto/verso
    900. 

  900.                      header/footer
    901. 

  901. PROCESS_SHIM         Calculates #SHIM when \n(.d is lower on the
    902. 

  902.                      page than #T_MARGIN
    903. 

  903. PROCESS_FN_IN_DIVER  Processes footnotes gathered in a diversion (called
    904. 

  904.                      at page/column breaks)
    905. 

  905. REMOVE_INDENT        Removes indents set with CHECK_INDENT
    906. 

  906. Q_FITS               Handles spacing of quotes when quote fits on the page
    907. 

  907. Q_NOFIT              Handles spacing of quotes when quote does not fit on
    908. 

  908.                      the page
    909. 

  909. QUIT_LISTS           Exit lists cleanly and completely
    910. 

  910. SET_LIST_INDENT      Restore indent of a prev. level of list
    911. 

  911. SHIM                 Advance to next "legal" baseline
    912. 

  912. TERMINATE            .em that ensures deferred footnotes get output
    913. 

  913.                      on final pages
    914. 

  914. TRAPS                Sets hdrftr traps; optionally adjusts #DOC_LEAD
    915. 

  915.                      to fill page to #B_MARGIN
    916. 

  916. TYPEWRITER           Sets family (C), font (R) and point size (12)
    917. 

  917.                      for PRINTSTYLE TYPEWRITE
    918. 

  918. VFP_CHECK            Trap-sprung macro 1 legal baseline higher than
    919. 

  919.                      where FOOTER will be sprung; checks whether
    920. 

  920.                      there is, in fact, just enough room for
    921. 

  921.                      another line of running text to be added to
    922. 

  922.                      the page without jamming footnotes too close
    923. 

  923.                      to running text.
    924. 

  924. 

  925. +++DIVERSIONS+++
    926. 

  926. 

  927. B_QUOTE           Block (indented) quote text
    928. 

  928. CLOSING           Closing (i.e. Yours truly,)
    929. 

  929. EPI_TEXT          Epigraph text
    930. 

  930. END_NOTES         Endnotes text
    931. 

  931. FN_IN_DIVER       Footnotes gathered from inside a diversion
    932. 

  932. FN_OVERFLOW       Excess footnotes when B_MARGIN is reached
    933. 

  933. FOOTNOTES         Text of footnotes
    934. 

  934. GREETING          Full salutation (e.g. Dear John Smith,)
    935. 

  935. LETTERHEAD&lt;n&gt;     Date, addresser, addressee or greeting;
    936. 

  936.                   &lt;n&gt; is from 1 to 4, supplied by #FIELD
    937. 

  937. P_QUOTE           Line for line (poetic) quote text
    938. 

  938. RUNON_FOOTNOTES   Special diversion for run-on footnotes
    939. 

  939. RUNON_FN_IN_DIVER Special diversion for run-on footnotes inside
    940. 

  940.                   (block)quotes
    941. 

  941. TOC_ENTRIES       TOC entries
    942. 

  942. 

  943. +++NUMBER REGISTERS+++
    944. 

  944. 

  945. #1ST_FN_VP_ADJ             An adjustment factor that ensures VFP
    946. 

  946.                            doesn't fall below what should be the
    947. 

  947.                            correct last printed line of running
    948. 

  948.                            text
    949. 

  949. #ADD_BREAK                 Instructs FOOTNOTEs and ENDNOTEs to add
    950. 

  950.                            a break afer processing a footnote if
    951. 

  951.                            we're not in fill mode
    952. 

  952. #ADJ_BIB_LEAD              Adjust BIB_LEAD? (toggle)
    953. 

  953. #ADJ_DOC_LEAD              Adjust DOC_LEAD? (toggle)
    954. 

  954. #ADJ_TOC_LEAD              Adjust TOC_LEAD? (toggle)
    955. 

  955. #ARG_NUM                   Keeps track of number of args passed to a
    956. 

  956.                            macro
    957. 

  957. #ARGS_TO_LIST              Was LIST passed some args? (toggle)
    958. 

  958. #AUTHOR_[n]                Strings passed to AUTHOR
    959. 

  959. #AUTHOR_LINES              # of lines of authors in doc header; odd=0
    960. 

  960.                            even=1
    961. 

  961. #AUTHOR_NUM                Keeps track of user-defined string
    962. 

  962.                            AUTHOR_&lt;#&gt; in AUTHOR
    963. 

  963. #AUTHORS                   Equals final value of AUTHOR_NUM;
    964. 

  964.                            used for authors in doc header
    965. 

  965. #BASELINE_MARK             In PP, the vertical position on the page
    966. 

  966.                            (when paragraph spacing is on) after a
    967. 

  967.                            quote or blockquote has been output and
    968. 

  968.                            the post-quote space has been added.
    969. 

  969. #BMARG                     Position of unvarying bottom margin
    970. 

  970.                            during doc processing; required for
    971. 

  971.                            collecting footnotes inside diversions
    972. 

  972. #BIB_ALLOWS_HEADERS        Put headers on bib pages? (toggle)
    973. 

  973. #BIB_ALLOWS_HEADERS_ALL    Put headers on all bib pages? (toggle)
    974. 

  974. #BIB_FIRST_PAGE            Tells PRINT_PAGE_NUMBER about bibliography
    975. 

  975.                            first page number
    976. 

  976. #BIB_FIRST_PN              Starting pagenumber for bibliographies
    977. 

  977. #BIB_HDRFTR_CENTER         Put a center string in bib page headers?
    978. 

  978.                            (toggle)
    979. 

  979. #BIB_LEAD                  Bibliography lead, expressed in points
    980. 

  980. #BIB_LIST                  Output bibs in list style? (toggle)
    981. 

  981. #BIB_NO_COLS               De-columnize bibliographies? (toggle)
    982. 

  982. #BIB_NO_FIRST_PN           Put a page number on the first page of
    983. 

  983.                            bibliographies? (toggle)
    984. 

  984. #BIB_SINGLESPACE           Single-space TYPEWRITE bibliographies? (toggle)
    985. 

  985. #BIB_SPACE                 Post item space for bibliography pages
    986. 

  986. #BIB_STRING_CAPS           Capitalize bib title? (toggle)
    987. 

  987. #BIB_STRING_UNDERSCORE     Underscore bib title? 0=no; 1=yes; 2=double
    988. 

  988. #BIB_PS                    Base point size for bibliography pages expressed
    989. 

  989.                            in points
    990. 

  990. #BIBLIOGRAPHY              Are we doing a bib page? (toggle)
    991. 

  991. #BQ_AUTOLEAD               Register created by BLOCKQUOTE_AUTOLEAD
    992. 

  992. #BQ_LEAD                   Leading of blockquotes
    993. 

  993. #BQUOTE_COLOR              Colored blockquotes? (toggle)
    994. 

  994. #BQUOTE_LN                 Number blockquotes? (toggle)
    995. 

  995. #BROKEN_QUOTE              Did we invoke BREAK_QUOTE? (toggle)
    996. 

  996. #CAP_HEIGHT_ADJUST         Tallest cap height of strings LEFT, CENTER,
    997. 

  997.                            and RIGHT in footers; used to place rule
    998. 

  998.                            over footer
    999. 

  999. #CAPS_WAS_ON               In HDRFTR, to re-enable running text CAPS
    1000. 

  1000.                            (toggle)
    1001. 

  1001. #CENTER_CAP_HEIGHT         Cap height of CENTER string in
    1002. 

  1002.                            headers/footers
    1003. 

  1003. #CHAPTER_TITLE_COLOR       Colored chapter title? (toggle)
    1004. 

  1004. #CLOSING                   Is there a closing (for letters)? 1=yes
    1005. 

  1005. #COL_L_LENGTH              Line length of columns
    1006. 

  1006. #COL_NEXT                  Was COL_NEXT invoked? (toggle; used in
    1007. 

  1007.                            FOOTER)
    1008. 

  1008. #COL_NUM                   Incrementing counter of num of columns;
    1009. 

  1009.                            for use with #COL_&lt;#&gt;_L_MARGIN
    1010. 

  1010. #COL_TOTAL                 #COL_L_LENGTH + #GUTTER; used to calculate
    1011. 

  1011.                            #COL_&lt;#&gt;_L_MARGIN
    1012. 

  1012. #COLLATED_DOC              If 1, instructs TOC that this is a collated
    1013. 

  1013.                            doc
    1014. 

  1014. #COLUMNS                   Are columns turned on? (toggle)
    1015. 

  1015. #COLUMNS_WERE_ON           Stores columnar state prior to outputting
    1016. 

  1016.                            endnotes in no-columns mode
    1017. 

  1017. #COPY_STYLE                1=draft, 2=final
    1018. 

  1018. #COUNTERS_RESET            Tells FOOTNOTE if fn counters have
    1019. 

  1019.                            been reset because of footnotes gathered
    1020. 

  1020.                            inside a diversion
    1021. 

  1021. #COVER_COLOR               Colored cover? (toggle)
    1022. 

  1022. #COVER_START_POS           Vertical starting pos of cover material
    1023. 

  1023. #COVER_TITLE_COLOR         Colored cover title? (toggle)
    1024. 

  1024. #COVER_SUBTITLE_COLOR      Colored cover subtitle? (toggle)
    1025. 

  1025. #COVER_ATTRIBUTE_COLOR     Colored cover attribution string? (toggle)
    1026. 

  1026. #COVER_AUTHOR_COLOR        Colored cover author(s)? (toggle)
    1027. 

  1027. #COVER_DOCTYPE_COLOR       Colored cover doctype? (toggle)
    1028. 

  1028. #COVER_COPYRIGHT_COLOR     Colored cover copyright line? (toggle)
    1029. 

  1029. #COVER_MISC_COLOR          Colored cover misc line? (toggle)
    1030. 

  1030. #CURRENT_V_POS             \n(.d ; used in SHIM
    1031. 

  1031. #COVERS                    Print covers? (toggle)
    1032. 

  1032. #DATE_FIRST                Was .DATE invoked as first letter
    1033. 

  1033.                            header after .START? (toggle)
    1034. 

  1034. dc                         "mark" register for document columns
    1035. 

  1035. #DIVER_FN                  Register that tells FOOTNOTE whether to
    1036. 

  1036.                            "move" or "defer" a footnote collected
    1037. 

  1037.                            inside a diversion
    1038. 

  1038. #DEFER_BIB_SPACING         Tells DEFAULTS to do BIBLIOGRAPHY_SPACING
    1039. 

  1039.                            if it was called before START
    1040. 

  1040. #DEFER_PAGINATION          Tells COLLATE to restore pagination (from
    1041. 

  1041.                            RESTORE_PAGINATION
    1042. 

  1042. #DELAY_SHIM                Instructs DO_QUOTE to delay SHIM when quote
    1043. 

  1043.                            falls at the top of a page
    1044. 

  1044. #DEPTH_1                   Doc header depth with lead adjustment
    1045. 

  1045.                            (#DOCHEADER_LINES * #DOCHEADER_LEAD)
    1046. 

  1046. #DEPTH_2                   Doc header depth without lead adjustment
    1047. 

  1047.                            (#DOCHEADER_LINES * #DOC_LEAD)
    1048. 

  1048. #DEPTH_TO_B_MARGIN         Page length minus #B_MARGIN
    1049. 

  1049. #DIVERSIONS_HY_MARGIN      A reasonable value for .hym applied to
    1050. 

  1050.                            QUOTE, BLOCKQUOTE and EPIGRAPH to
    1051. 

  1051.                            avoid excessive hyphenation if these are
    1052. 

  1052.                            set quad left
    1053. 

  1053. #DIVERTED                  Set to 1 in DIVERT_FN_OVERFLOW; reset
    1054. 

  1054.                            subsequently in FOOTNOTES when called by
    1055. 

  1055.                            PROCESS_FN_LEFTOVER to 2 or 3 for use by
    1056. 

  1056.                            FOOTER to decide whether to in/decrease
    1057. 

  1057.                            #FN_DEPTH when outputting footnotes
    1058. 

  1058. #DOCHEADER_ADVANCE         Distance from top-of-page to baseline of
    1059. 

  1059.                            docheader
    1060. 

  1060. #DOCHEADER_COLOR           Colored docheader? (toggle)
    1061. 

  1061. #DOCHEADER_LEAD            Lead of doc header
    1062. 

  1062.                            (#DOC_LEAD + #DOCHEADER_LEAD_ADJ)
    1063. 

  1063. #DOCHEADER_SPACE_ADJ       Lead difference between #DEPTH_1 and
    1064. 

  1064.                            #DEPTH_2
    1065. 

  1065. #DOC_COVER_START_POS       Vertical starting pos of doc cover material
    1066. 

  1066. #DOC_COVERS                Print doc covers? (toggle)
    1067. 

  1067. #DOC_COVER_COLOR           Colored cover? (toggle)
    1068. 

  1068. #DOC_COVER_START_POS       Vertical starting pos of cover material
    1069. 

  1069. #DOC_COVER_TITLE_COLOR     Colored doc cover title? (toggle)
    1070. 

  1070. #DOC_COVER_SUBTITLE_COLOR  Colored doc cover subtitle? (toggle)
    1071. 

  1071. #DOC_COVER_ATTRIBUTE_COLOR Colored doc cover attribution string? (toggle)
    1072. 

  1072. #DOC_COVER_AUTHOR_COLOR    Colored doc cover author(s)? (toggle)
    1073. 

  1073. #DOC_COVER_DOCTYPE_COLOR   Colored doc cover doctype? (toggle)
    1074. 

  1074. #DOC_COVER_COPYRIGHT_COLOR Colored doc cover copyright line? (toggle)
    1075. 

  1075. #DOC_COVER_MISC_COLOR      Colored doc cover misc line? (toggle)
    1076. 

  1076. #DOC_HEADER                Whether to print a doc header (toggle)
    1077. 

  1077. #DOC_LEAD_ADJ              Incrementing value (in units) added to
    1078. 

  1078.                            #DOC_LEAD to fill page to #B_MARGIN
    1079. 

  1079. #DOC_LEAD                  Leading used in body
    1080. 

  1080. #DOC_L_LENGTH              Global L_LENGTH
    1081. 

  1081. #DOC_L_MARGIN              Global L_MARGIN
    1082. 

  1082. #DOC_LR_MARGIN_TMP         In HEADER, if RECTO_VERSO=1, temporarily
    1083. 

  1083.                            holds DOC_L_MARGIN during page margin switch
    1084. 

  1084. #DOC_PT_SIZE               Point size used for body text
    1085. 

  1085. #DOC_R_MARGIN              Global R_MARGIN
    1086. 

  1086. #DOCS                      Always 1 after START
    1087. 

  1087. #DOC_TYPE                  1=default, 2=chapter, 3=named, 4=letter
    1088. 

  1088. #DOING_COVER               Tells PRINT_AUTHORS that it's printing
    1089. 

  1089.                            the authors for a cover or doc cover
    1090. 

  1090. #DONE_ONCE                 Keeps track of how many times footnotes
    1091. 

  1091.                            have been collected inside the same diversion
    1092. 

  1092. #DONT_RULE_ME              Rule this (apparent) first footnote? (toggle)
    1093. 

  1093. #DIVER_LN_OFF              Turn linenumbering off in (block)quotes?
    1094. 

  1094.                            (toggle)
    1095. 

  1095. #DRAFT_WITH_PAGENUM        Are we attaching draft/revision info to page
    1096. 

  1096.                            number? (toggle)
    1097. 

  1097. #EM_ADJUST                 Amount to raise \(em at END
    1098. 

  1098. #EN_ALLOWS_HEADERS         Put page headers on endnotes pages? (toggle)
    1099. 

  1099. #EN_ALLOWS_HEADERS_ALL     Put page headers on all endnotes pages?
    1100. 

  1100.                            (toggle)
    1101. 

  1101. #EN_BQ_AUTOLEAD            Register created by EN_BLOCKQUOTE_AUTOLEAD
    1102. 

  1102. #EN_BQ_LEAD                Leading of blockquotes on endnotes pages
    1103. 

  1103. #EN_FIGURE_SPACE           Width of \0, for use with formatting endnotes
    1104. 

  1104. #EN_FIRST_PAGE             Tells PRINT_PAGE_NUMBER about endnotes
    1105. 

  1105.                            first page number
    1106. 

  1106. #EN_FIRST_PN               Page number that appears on page 1 of
    1107. 

  1107.                            endnotes pages.
    1108. 

  1108. #EN_HDRFTR_CENTER          Should we print centre string of
    1109. 

  1109.                            headers/footers on endnotes pages? (toggle)
    1110. 

  1110. #EN_LEAD                   Lead of endnotes
    1111. 

  1111. #EN_LN_BRACKETS            Are we using brackets for line-numbered
    1112. 

  1112.                            endnotes (toggle)
    1113. 

  1113. #EN_LN_SEP                 Are we using a separator for line-numbered
    1114. 

  1114.                            endnotes (toggle)
    1115. 

  1115. #EN_MARK                   \n(ln when \*[EN-MARK] is called
    1116. 

  1116. #EN_MARK_2…
    1117.