PageRenderTime 55ms CodeModel.GetById 12ms RepoModel.GetById 0ms app.codeStats 0ms

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