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