o Added TOC (finally) and a nearly complete set of associated
[s-roff.git] / contrib / mom / momdoc / reserved.html
blob1371434292063402b2e9ed31d87361a107020c1d
1 <html>
2 <head>
3 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
4 <title>Mom -- List of reserved words</title>
5 </head>
6 <body bgcolor="#dfdfdf">
8 <!====================================================================>
10 <a href="appendices.html#TOP">Prev</a>&nbsp;&nbsp; <a href="toc.html">Back to Table of Contents</a> <a name="TOP"></a> <a name="RESERVED"> <h2 align="center"><u>LIST OF RESERVED WORDS</u></h2> </a> <p> The following is a list of &quot;reserved&quot; words used by <strong>mom</strong>. Before changing the name of any macro or document element tag with <a href="goodies.html#ALIAS">ALIAS</a>, I strongly recommend doing a search of this page for your proposed new name. If you find it in the left hand column, DON'T USE IT. Choose something else instead. <p>
11 Anyone interested in playing around inside <strong>mom</strong>'s macro
12 file (om.tmac) will find this list useful as well since it lists all
13 (I hope) the macros, strings, and number registers <strong>mom</strong>
14 uses, along with brief descriptions of their functions.
15 <p>
16 <pre>
17 TYPESETTING
18 ===========
20 +++MACROS+++
22 Page layout
23 -----------
24 PAGELENGTH Page width
25 PAGE Page width/length; left, right, top, bottom margins
26 PAGEWIDTH Page width
27 PAPER Letter, legal, or A4
29 B_MARGIN Space to leave at page bottom
30 L_MARGIN Page offset
31 R_MARGIN Line length as a function of
32 pagewidth minus pageoffset minus rightmargin
33 T_MARGIN Advance lead from page top
35 Page control
36 ------------
37 DO_B_MARGIN Margin at bottom of page
38 DO_T_MARGIN Margin at top of page
40 Style
41 -----
42 CONDENSE Set percentage of pseudo-condense (alias of
43 CONDENSE_OR_EXTEND)
44 EXTEND Set percentage of pseudo-extend (alias of
45 CONDENSE_OR_EXTEND)
46 FAMILY Family
47 FT Font
48 LL Line length
49 LS Leading (.vs)
50 PT_SIZE Point size
51 SETBOLDER Set degree of emboldening (pseudo-bold) in units
52 SETSLANT Set degree of pseudo-italic
54 Autolead
55 --------
56 AUTOLEAD Always lead n points more than .PT_SIZE
58 Flush
59 -----
60 JUSTIFY Justified text
61 QUAD Filled text, left, right, or center
63 Quad
64 ----
65 CENTER Non-filled text, center
66 LEFT Non-filled text, left
67 RIGHT Non-filled text, right
69 Hyphenation
70 -----------
71 HY Turn hyphenation on/off, or set LINES, MARGIN, SPACE
72 HY_SET Set LINES, MARGIN, SPACE in a single command
74 Advanced style
75 --------------
76 KERN Turn automatic kerning on or off
77 LIGATURES Turn ligatures on or off
78 SS Sentence space control
79 WS Word space control
81 Line breaks
82 -----------
83 BR Alias of br
84 EL Breaks line but doesn't advance
85 SPACE Alias of sp
86 SPREAD Alias of brp
88 Ald/rld
89 -------
90 ALD Advance lead
91 RLD Reverse lead
93 Indents
94 -------
95 HI Indent hang
96 IB Indent both
97 IBX Indent both off
98 IL Indent left
99 ILX Indent left off
100 IQ Indents off
101 IR Indent right
102 IRX Indent right off
103 IX Indents off -- deprecated
104 TI Indent temporary
106 Tabs
107 ----
108 ST String tab
109 TAB_SET Tab Set
110 TN Tab Next
111 TQ Tab Quit
113 MCO Turn on multi-column mode
114 MCR Return to top of column
115 MCX Turn off multi-column mode
117 Underscore
118 ----------
119 UNDERSCORE Underscores words or phrases
120 UNDERSCORE2 Double underscores words or phrases
122 Underline
123 ---------
124 UNDERLINE Underlines whole passages (Courier only)
126 Smart Quotes
127 ------------
128 SMARTQUOTES Turns smart quotes on or off
130 Misc + Support
131 --------------
132 BR_AT_LINE_KERN Deposit a break before RW and WE
133 CAPS Convert u/lc to UC
134 COMMENT Don't print lines till COMMENT OFF (alias of SILENT)
135 DROPCAP_ADJUST Points (poss. fractional) to add/subtract
136 from drop caps
137 DROPCAP Create drop cap
138 DROPCAP_FAMILY Drop cap family
139 DROPCAP_FONT Drop cap font
140 DROPCAP_GUTTER Drop cap gutter
141 DROPCAP_OFF Support only; restores .in if there was one
142 EW Extra white -- loosen overall line kern
143 (character spacing)
144 LEADER_CHARACTER Sets leader character
145 PAD Insert padding spaces at marked places
146 PADMARKER Sets character to use instead of # in PAD
147 PRINT Simply prints args passed to it; keeps my code
148 indented nicely
149 RW Reduce white -- tighten overal line kern
150 (character spacing)
151 SILENT Don't print lines till SILENT OFF
152 SIZESPECS Get cap-height, x-height and descender depth for
153 current point size
154 TRAP Turn traps off or on
156 +++DIVERSIONS+++
158 NO_FLASH Diverts output of SILENT or COMMENT so they don't print
159 NULL Diverts SIZESPECS in PRINT_HDRFTR so it doesn't screw up
160 FOOTER and FOOTNOTE processing when FOOTERS are on
161 PAD_STRING Diverts $PAD_STRING for processing
162 TYPESIZE Diverts SIZESPECS routine so it doesn't print
164 +++NUMBER REGISTERS+++
166 #ALD ALD value
167 #AUTOLEAD_FACTOR Using FACTOR arg to AUTOLEAD? (toggle)
168 #AUTO_LEAD Using autolead? (toggle)
169 #AUTO_LEAD_VALUE Auto leading value
170 #BL_INDENT Value of left indent when IB
171 #B_MARGIN Bottom margin
172 #BOLDER_UNITS # of units to embolden type
173 #BR_INDENT Value of right indent when IB
174 c column mark
175 #CONDENSE Are we in pseudo-condense mode? (toggle)
176 #COND_WIDTH Width of pseudo-condensed type
177 (pointsize x $COND_PERCENT)
178 #CURRENT_TAB Current tab number
179 #DC_GUT Width of dropcap gutter
180 #DEGREES # of degrees slant for pseudo-italic
181 #EXTEND Are we in pseudo-extend mode? (toggle)
182 #EXT_WIDTH Width of pseudo-extended type
183 (pointsize x $EXT_PERCENT)
184 #FILL_MODE Are we in fill mode (i.e. \n(.u=1)? (toggle)
185 #FONT_FOR_PAD Used to ensure that the font in effect prior
186 to PAD is restored at the start of every
187 iteration of $PAD_STRING
188 #H_INDENT Value of left indent when IH
189 #HL_INDENT Value of the hang when IH
190 #HYPHENATE Hyphenation on? (toggle)
191 #HY_SET Did we manually set hyphenation parameters?
192 (toggle)
193 #IN_TAB Are we in a tab? (toggle)
194 Set in macro TAB; used in ST to determine
195 whether to add #ST_OFFSET to #ST&lt;#&gt;_OFFSETT
196 #INDENT_ACTIVE Indicates whether an indent is active (toggle)
197 #INDENT_BOTH_ACTIVE Toggle
198 #INDENT_LEFT_ACTIVE Toggle
199 #INDENT_RIGHT_ACTIVE Toggle
200 #INDENT_STYLE_BOTH Indicates IB when #INDENT_ACTIVE=1 (toggle)
201 #INDENT_STYLE_HANG Indicates IH when #INDENT_ACTIVE=1 (toggle)
202 #INDENT_STYLE_LEFT Indicates IL when #INDENT_ACTIVE=1 (toggle)
203 #INDENT_STYLE_RIGHT Indicates IR when #INDENT_ACTIVE=1 (toggle)
204 #INDENT_STYLE_TEMP Indicates IT when #INDENT_ACTIVE=1 (toggle)
205 #IX_WARN Toggles to 1 the first time IX is user-invoked
206 #KERN Kern on? (toggle)
207 #LAST_TAB Last tab number set in multi-columns
208 #LEAD Leading (alias)
209 #LIGATURES Ligatures on? (toggle)
210 #L_INDENT Value of left indent
211 #L_LENGTH Line length
212 #L_MARGIN Page offset if set with LMARGIN;
213 if .po used, \n(.o returns page offset
214 #LOOP #LOOP=1 if a while loop executes; otherwise 0.
215 #NEXT_TAB Current tab number + 1 (used in TN)
216 #NEXT_TAB Next tab in an n+1 sequence
217 #OPEN_CLOSE Manipulates character " to print `` or ''
218 p Output line horiz position at end of
219 $PAD_STRING
220 #PAD_COUNT Number of times # was included in arg to PAD
221 #PAD_SPACE Size of padding space
222 #PAGE_LENGTH Page length (alias)
223 #PAGE_WIDTH Page width
224 #PP_ACTIVE Are we in the context of a para? (toggle)
225 #PRINT_FOOTER_ON_PAGE_1 toggle
226 #PT_SIZE Point size (fractional) in units (alias)
227 #Q_AT_TOP Does a quote start at the top of a new page?
228 (toggle)
229 #QUAD In autoquad mode? (toggle)
230 #RESTORE_LEAD Lead value in effect prior to AUTOLEAD
231 #RESTORE_LINE_LENGTH Restores actual line length in RULE
232 #RESTORE_PT_SIZE Stores current point size (in units) prior
233 to underscore
234 #R_INDENT Value of right indent
235 #RLD RLD value
236 #R_MARGIN Right margin
237 #SILENT Is silent on? (toggle)
238 #SIZE_FOR_PAD Used to ensure that the size in effect prior
239 to PAD is restored at the start of every
240 iteration of $PAD_STRING
241 #SLANT_ON Is SLANT on? (toggle)
242 #SMART_QUOTES Smartquotes on? (toggle)
243 #SPACE_TO_END Whitespace at end of string passed to PAD
244 #ST&lt;#&gt;_LENGTH Length of ST&lt;#&gt;; calculated during ST &lt;#&gt;
245 #ST&lt;#&gt;_MARK Page offset of autotab &lt;#&gt; at ST&lt;#&gt;X
246 #ST_NUM Incrementing counter for autotab identification
247 #ST_OFFSET Offset (from current tab) to add to #ST&lt;#&gt;_OFFSET
248 when calculating string indents set from within tabs
249 #ST&lt;#&gt;_OFFSET Indent of autotab &lt;#&gt; (page offset)
250 t "mark" register set in T_MARGIN; recalled
251 in LS and AUTOLEAD if #T_MARGIN_SET is 1
252 #TAB_ACTIVE Are we in a tab? (toggle)
253 #TAB_NUMBER Tab number
254 #TAB_OFFSET Tab indent
255 #T_INDENT Value of temporary indent
256 #T_MARGIN Top margin
257 #T_MARGIN_SET Did we set the top margin with T_MARGIN?
258 (toggle)
259 #USER_SET_L_LENGTH Did user invoke LL? (toggle)
260 #USER_SET_TITLE_ITEM Did user invoke TOC_TITLE_ENTRY?
261 u Horiz position of start of underscore
263 +++STRINGS+++
265 $COND_PERCENT Percentage by which to pseudo-condense type
266 $CURRENT_QUAD Restores current quad value in RULE
267 $CURRENT_TAB Current tab number
268 $DC_ADJUST +|- # of points to subtract from dropcap
269 $DC_FAM Drop cap family
270 $DC_FT Drop cap font
271 $EXT_PERCENT Percentage by which to pseudo-extend type
272 $FAMILY Family
273 $FAMILY_FOR_PAD Used to ensure that the family in effect prior
274 to PAD is restored at the start of every
275 iteration of $PAD_STRING
276 $FONT Font
277 $PAD_MARKER Character to mark off padding in PAD
278 $PAD_STRING Arg passed to PAD
279 $QUAD_VALUE Quad value (left, right, center, justify)
280 $QUOTE0 ``
281 $QUOTE1 ''
282 $RESTORE_QUAD_VALUE Quad value for use in restoring L, R, C, J
283 (after tabs)
284 $SS_VAR Holds + or - sentence space value
285 $ST&lt;#&gt;_FILL Always QUAD if QUAD passed to ST &lt;#&gt;
286 $ST&lt;#&gt;_QUAD_DIR Quad direction supplied to ST for &lt;#&gt;
287 $TAB_NUMBER Argument passed to TAB macro to call TAB# macro
288 created in TAB_SET
289 $WS_CONSTANT 12; used to hold groff default wordspace
290 $WS Holds WS value; concatenation of WS_CONSTANT and
291 WS_VAR
292 $WS_VAR + or - value to add to $WS_CONSTANT
294 +++ALIASES+++
296 ALIAS als
297 ALIASN aln
298 BR br
299 CENTRE CENTER
300 COMMENT SILENT
301 CONDENSE CONDENSE_OR_EXTEND
302 EXTEND CONDENSE_OR_EXTEND
303 FAM FAMILY
304 FT FONT
305 HYPHENATE HY
306 HYPHENATION HY
307 LIG LIGATURES
308 LL LINE_LENGTH
309 MAC de
310 NEW_PAGE bp
311 NEWPAGE NEW_PAGE
312 PAGELENGTH PAGE_LENGTH
313 PAGE_LENGTH pl
314 PAGEWIDTH PAGE_WIDTH
315 SPREAD brp
316 SP sp
317 STRING ds
318 TABSET TAB_SET
319 TB TAB
320 TI IT
321 UNDERSCORE_2 UNDERSCORE2
323 +++ALIASES FOR NUMBER REGISTERS+++
325 #DIVER_DEPTH dn -- diversion depth
326 #DIVER_WIDTH dl -- diversion width
327 #INDENT .i -- value of current indent
328 #LEAD .v -- line space (.vs, not .ls)
329 #L_LENGTH .l -- line length
330 #NUM_ARGS .$ -- number of arguments passed to a macro
331 #PAGE_LENGTH .p -- page length
332 #PT_SIZE .ps -- current point size (fractional) in units
333 #TRAP_DISTANCE .t -- distance to next trap
335 +++INLINE ESCAPES+++
337 BCK Inline backward horizontal movement
338 BOLDER Pseudo-bold on
339 BOLDERX Pseudo-bold off
340 BP Back points (horizontal movement)
341 BU Back units (inline pairwise kerning)
342 COND_FOR_SUP Pseudo-condense string for use with superscripts
343 (called with CONDSUP)
344 COND_FOR_SUP Pseudo-extend string for use with superscripts (called
345 with EXTSUP)
346 COND Pseudo-condense type
347 CONDX Pseudo-condense off
348 CONDSUP Pseudo-condensed superscript (using value set with
349 CONDENSE)
350 CONDSUPX Pseudo-condensed superscript off
351 DOWN Inline downward vertical movement
352 EXT Pseudo-extend type
353 EXTX Pseudo-extend off
354 EXTSUP Pseudo-extended superscript
355 EXTSUPX Pseudo-extended superscript off
356 FP Forward points (horizontal movement)
357 FU Forward units (inline pairwise kerning)
358 FWD Inline forward horizontal movement
359 LEADER Deposit leader to end of current LL or TAB
360 RULE Draw a rule to the full measure of the current line or
361 tab length
362 SLANT Slant (pseudo-italic on
363 SLANTX Slant off
364 ST&lt;#&gt; String tab end marker
365 ST&lt;#&gt; String tab start marker
366 SUP Superscript
367 SUPX Superscript off
368 UP Inline upward vertical movement
370 +++SPECIAL CHARACTERS+++
372 FEET The foot character \(fm
373 INCH The inch character \(fm\(fm
375 ------------------------------------------------------------------------
377 DOCUMENT PROCESSING
378 ===================
380 +++MACROS+++
382 Document info
383 -------------
384 AUTHOR Author
385 CHAPTER Chapter number
386 CHAPTER_TITLE Chapter title
387 DRAFT Draft number
388 REVISION Revision number
389 SUBTITLE Doc subtitle
390 TITLE Doc title
392 Document style
393 --------------
394 COPYSTYLE Output style (DRAFT or FINAL)
395 DEFAULTS In START, sets defaults
396 DOCTYPE Kind of doc (DEFAULT, CHAPTER, NAMED, LETTER)
397 PAGENUMBER Page number that appears on 1st page of doc
398 PAPER Paper size (LETTER, LEGAL, A4)
399 PRINTSTYLE Print style (TYPEWRITE or TYPESET)
401 Document tags
402 -------------
403 BLOCKQUOTE Block-indented, quoted text
404 COL_BREAK Breaks and spreads line before invocation; moves to
405 next column on page or 1st col of next page. An alias
406 of COL_NEXT.
407 COL_NEXT Moves to next column on page or 1st col of next page
408 ENDNOTE Endnote
409 ENDNOTES Output endnotes
410 EPIGRAPH Epigraph before 1st para
411 FINIS Prints --END--
412 FOOTNOTE Collects footnotes in text for printing at bottom of page
413 HEAD Section title (main heads)
414 LINEBREAK Break between narrative sections
415 PARAHEAD Paragraph head
416 PP Paragraph
417 QUOTE Poetic or line for line quotes
418 START Prints info collected with doc info macros
419 SUBHEAD Subheads
421 Headers/footers
422 --------------
423 BREAK_QUOTE Manually break a footnoted quote that crosses
424 a page/column
425 DO_FOOTER Prints footer (after footnote processing, if any)
426 FOOTER_ON_FIRST_PAGE Print footer on first page? (toggle)
427 FOOTER Trap-invoked footer macro
428 HEADER Trap-invoked header macro
429 PAGINATE Turns page numbering on or off (doc default=on)
430 PAGINATE_TOC Turns pagination of toc on or off (default=on)
431 RECTO_VERSO Enables switch HEADER_LEFT and HEADER_RIGHT on
432 alternate pages
434 Alter doc "look" and/or change defaults
435 ---------------------------------------
436 ALWAYS_FULLSPACE_QUOTES Fullspace quotes instead of default
437 1/2 spacing them.
438 ATTRIBUTE_STRING What to print before author (default is "by")
439 AUTHOR_FAMILY Family to use for author in doc header
440 AUTHOR_FONT Font to use for author in doc header
441 AUTHOR_SIZE ps to use for author in doc header
442 BLOCKQUOTE_FAMILY Family to use in blockquotes
443 BLOCKQUOTE_FONT Font to use in blockquotes
444 BLOCKQUOTE_QUAD How to quad blockquotes
445 BLOCKQUOTE_SIZE How much to de/increase point size of bquotes
446 CHAPTER_STRING What to print whenever the word "chapter"
447 is required
448 CHAPTER_TITLE_FAMILY Family to use for chapter title in doc header
449 CHAPTER_TITLE_FONT Font to use for chapter title in doc header
450 CHAPTER_TITLE_SIZE ps in/decrease of chapter title
451 (relative to size of running text)
452 COLUMNS Print in columns
453 DOC_FAMILY Overall doc family
454 DOCHEADER_ADVANCE Start position of docheader (relative to top
455 of page)
456 DOCHEADER_LEAD +|- value applied to #DOC_LEAD to in/decrease leading of doc header
457 DOC_HEADER Print doc header?
458 DOC_LEAD_ADJUST Adjust #DOC_LEAD to fill page to #B_MARGIN
459 DOC_LEAD Overall doc leading
460 DOC_LEFT_MARGIN Doc left margin
461 DOC_LINE_LENGTH Doc line length
462 DOC_PT_SIZE Overall doc point size
463 DOC_QUAD Overall quad of document
464 DOC_RIGHT_MARGIN Doc right margin
465 DOC_TITLE Overall doc title that gets printed in
466 headers/footers (mostly for use with collated
467 docs where each doc is an article with a
468 different title
469 DOCTYPE_FAMILY Family to use for doctype string in doc header
470 DOCTYPE_FONT Font to use for doctype string in doc header
471 DOCTYPE_SIZE ps to use for doctype string in doc header
472 DOCTYPE Type of doc (DEFAULT, CHAPTER, NAMED, LETTER)
473 DO_QUOTE Print quote (invoked from QUOTE or BLOCKQUOTE)
474 DRAFT_STRING What to print whenever the word "draft" is
475 required
476 DRAFT_WITH_PAGENUMBER Attach draft/revision info to page number
477 (instead of putting it HEADER center)
478 ENDNOTE_FAMILY Family for endnotes
479 ENDNOTE_FONT Font for endnotes
480 ENDNOTE_LEAD Leading for endnotes page
481 ENDNOTE_PARA_INDENT First line indent of paras in multi-para
482 endnotes
483 ENDNOTE_PARA_SPACE Whether to space paras in multi-para endnotes
484 ENDNOTE_PT_SIZE Base point size for endnotes page
485 ENDNOTE_QUAD Endnote quad
486 ENDNOTE_STRING Endnotes page head
487 ENDNOTE_STRING_CAPS Capitalize the endnotes string
488 ENDNOTE_STRING_FAMILY Family for endnotes page head
489 ENDNOTE_STRING_FONT Font for endnotes page head
490 ENDNOTE_STRING_QUAD Quad direction for endnotes page head
491 ENDNOTE_STRING_SIZE Size for endnotes page head***
492 ENDNOTE_STRING_UNDERSCORE Underscoring of endnotes page head
493 ENDNOTE_TITLE Endnotes identifying title
494 ENDNOTE_TITLE_FAMILY Family for endnotes identifying title
495 ENDNOTE_TITLE_FONT Font for endnotes identifying title
496 ENDNOTE_TITLE_QUAD Quad direction for endnotes identifying title
497 ENDNOTE_TITLE_SIZE Size for endnotes identifying title***
498 ENDNOTE_TITLE_UNDERSCORE Underscoring of endnotes identifying title
499 ENDNOTE_NUMBER_FAMILY Family of endnote numbers
500 ENDNOTE_NUMBER_FONT Font of endnote numbers
501 ENDNOTE_NUMBER_SIZE Size of endnote numbers***
502 ENDNOTE_NUMBERS_ALIGN_RIGHT Hang endnote numbers and align right
503 ENDNOTE_NUMBERS_ALIGN_LEFT Don't hang endnote numbers and align left
504 ENDNOTES_ALLOWS_HEADERS Page headers on endnotes pages? (toggle)
505 ENDNOTES_FIRST_PAGENUMBER Page number to appear on page 1 of endnotes
506 pages
507 ENDNOTES_HDRFTR_CENTER Print header/footer center string on endnotes pages?
508 ENDNOTES_HEADER_CENTER Print header center string on endnotes pages?
509 ENDNOTES_FOOTER_CENTER Print footer center string on endnotes pages?
510 ENDNOTES_NO_COLUMNS Turn columnar mode off for endnotes pages
511 ENDNOTES_NO_FIRST_PAGENUM Don't print a pagenumber on page 1 of
512 endnotes.
513 ENDNOTES_PAGENUM_STYLE Set numbering style for endnotes pages page
514 numbers
515 EPIGRAPH_AUTOLEAD Autolead value for epigraphs
516 EPIGRAPH_FAMILY Family to use in epigraphs
517 EPIGRAPH_FONT Font to use in epigraphs
518 EPIGRAPH_INDENT Value by which to multiply PP_INDENT for
519 block epigraphs
520 EPIGRAPH_QUAD Quad value of block style epigraphs
521 EPIGRAPH_SIZE ps de/increase of epigraphs*
522 FINIS_STRING What to print when FINIS is invoked
523 FOOTER_GAP Distance between running text and footer
524 FOOTER_MARGIN Distance from footer to bottom of page
525 FOOTERS Turns footers on or off
526 FOOTNOTE_AUTOLEAD Autolead to use in footnotes
527 FOOTNOTE_FAMILY Family to use in footnotes
528 FOOTNOTE_FONT Font to use in footnotes
529 FOOTNOTE_MARKERS Turns footnote markers on or off
530 FOOTNOTE_MARKER_STYLE STAR or NUMBER; default=STAR
531 FOOTNOTE_QUAD Quad to use in footnotes
532 FOOTNOTE_RULE_ADJ # of points to raise footnote rule from its
533 baseline
534 FOOTNOTE_RULE_LENGTH Length of footnote separator rule
535 FOOTNOTE_RULE Turns printing of fn separator rule on or off;
536 default is on
537 FOOTNOTE_SIZE ps of footnotes
538 HDRFTR_CENTER String to go in center part of header/footer;
539 default doctype
540 HDRFTR_CENTER_CAPS Center part of header/footer in caps? (toggle)
541 HDRFTR_CENTER_FAMILY Family of center part of header/footer
542 HDRFTR_CENTER_FONT Font of center part of header/footer
543 HDRFTR_CENTER_PAD Pad hdrftr center left or right by specified
544 amount
545 HDRFTR_CENTER_SIZE ps in/decrease of center part of header/footer**
546 HDRFTR_FAMILY Family to use in the headers/footers
547 HDRFTR_GAP Distance from header/footer to running text
548 HDRFTR_LEFT_CAPS Left part of header/footer in caps? (toggle)
549 HDRFTR_LEFT_FAMILY Family of left part of header/footer
550 HDRFTR_LEFT_FONT Font of left part of header/footer
551 HDRFTR_LEFT_SIZE ps in/decrease of left part of
552 headers/footers**
553 HDRFTR_LEFT String to go in left part of header/footer;
554 default is AUTHOR_1
555 HDRFTR_LEFT The header/footer left string
556 HDRFTR_MARGIN Distance from top of page to header
557 HDRFTR_PLAIN Header/footer fam/ft/ps all same as running
558 text
559 HDRFTR_RECTO User-defined, single string recto
560 header/footer
561 HDRFTR_RIGHT_CAPS Right part of header/footer in caps? (toggle)
562 HDRFTR_RIGHT_FAMILY Family of right part of headers/footers
563 HDRFTR_RIGHT_FONT Font of right part of headers/footers
564 HDRFTR_RIGHT_SIZE Size of right part of headers/footers
565 HDRFTR_RIGHT The header/footer right string
566 HDRFTR_RULE_GAP Space between header/footer and header/footer rule
567 HDRFTR_RULE_INTERNAL Prints the header/footer rule
568 HDRFTR_RULE Turns header/footer rule on or off
569 HDRFTR_RULE Turns header/footer rule on or off.
570 When invoked internally, prints the rule.
571 HDRFTR_SIZE ps in/decrease of headers/footers*
572 HDRFTR_VERSO User-defined, single string verso
573 header/footer
574 HEAD_CAPS Print section titles in caps? (toggle)
575 HEADER_GAP Space between header and running text
576 HEADER_MARGIN Space from top of page to header
577 HEADERS Turns headers on or off
578 HEAD_FAMILY Family to use in section titles
579 HEAD_FONT Font to use in section titles
580 HEAD_QUAD Quad value of section titles
581 HEAD_SIZE How much to in/decrease point size of section
582 titles*
583 HEAD_SPACE Give HEADs 2 line-spaces before. If OFF,
584 only 1. Default is on.
585 HEAD_UNDERLINE Underline section titles? (toggle)
586 INDENT_FIRST_PARAS Indent 1st paras? (doc default=not indented)
587 ITALIC_MEANS_ITALIC For TYPEWRITE; render .FT I in italic.
588 NUMBER_HEADS Print head numbers
589 NUMBER_PARAHEADS Print parahead numbers
590 NUMBER_SUBHEADS Print subhead numbers
591 PAGENUM_FAMILY Family to use in footers
592 PAGENUM_FONT Font to use for page numbers
593 PAGENUM_HYPHENS Turns on/off hyphens surrounding page numbers
594 PAGENUM_ON_FIRST_PAGE Print page number on first page when footers
595 are on (toggle)
596 PAGENUM_POS Controls placement of page numbers;
597 default=bottom/centered
598 PAGENUM_SIZE How much to in/decrease point size of page
599 numbers*
600 PAGENUM_STYLE Page # in roman, arabic, or alphabetic
601 PARAHEAD_FAMILY Family to use for paraheads
602 PARAHEAD_FONT Font to use for paraheads
603 PARAHEAD_INDENT How mucht to indent paraheads
604 PARAHEAD_SIZE Size of paraheads*
605 PARA_INDENT Size of para indent
606 PARA_SPACE Put a line space before paras
607 PP_FONT Overall doc font
608 QUOTE_FAMILY Family to use in pquotes
609 QUOTE_FONT Font to use in pquotes
610 QUOTE_INDENT Value by which to multiply PP_INDENT for
611 block quotes
612 QUOTE_SIZE How much to de/increase point size of
613 pquotes*
614 RESET_FOOTNOTE_NUMBER Reset fn# to 1, or, if arg PAGE, reset
615 automatically to 1 on every page
616 RESET_HEAD_NUMBER Reset head number
617 RESET_PARAHEAD_NUMBER Reset parahead number
618 RESET_SUBHEAD_NUMBER Reset subhead number
619 RESTORE_PAGINATION Restore pagination after outputting non-
620 paginated endnotes.
621 REVISION_STRING What to print whenever the word "revision"
622 is required
623 SINGLESPACE_ENDNOTES Single space TYPEWRITE endnotes
624 SLANT_MEANS_SLANT In TYPEWRITE, render \*[SLANT] as slant
625 SUBHEAD_FAMILY Family to use in subheads
626 SUBHEAD_FONT Font to use in subheads
627 SUBHEAD_SIZE How much to in/decrease point size of
628 subheads*
629 SUBTITLE_FAMILY Family to use for subtitle in doc header
630 SUBTITLE_FONT Font to use for subtitle in doc header
631 SUBTITLE_SIZE ps to use for subtitle in doc header
632 SUSPEND_PAGINATION Suspend pagination prior to outputting
633 endnotes
634 SWITCH_HDRFTR Switch HDRFTR_LEFT and HDRFTR_RIGHT
635 TITLE_FAMILY Family to use for title in doc headers
636 TITLE_FONT Font to use for title in doc headers
637 TITLE_SIZE How much to in/decrease title at start of doc*
638 TOC_APPENDS_AUTHORS Appends author(s) to toc doc title entries
639 TOC_LEAD Leading of toc pages
640 TOC_FAMILY Family to use on toc pages
641 TOC_HEADER_FAMILY Family to use for "Contents"
642 TOC_HEADER_FONT Font to use for "Contents"
643 TOC_PADDING Number of placeholders for toc entries page
644 numbers
645 TOC_PN_FAMILY Family to use for toc entries page numbers
646 TOC_PN_FONT Font to use for toc entries page numbers
647 TOC_PN_SIZE How much to in/decrease point size of
648 toc entries page numbers****
649 TOC_HEAD_FAMILY Family of toc head entries
650 TOC_HEAD_FONT Font of toc head entries
651 TOC_HEAD_INDENT Indent of toc head entries
652 TOC_HEAD_SIZE How much to in/decrease ps of head entries****
653 TOC_HEADER_QUAD Quad direction for "Contents"
654 TOC_HEADER_SIZE How much to in/decrease point size of
655 "Contents"****
656 TOC_HEADER_STRING TOC header string (default=Contents)
657 TOC_PAGENUM_STYLE Page numbering style (hdrftr nums) of
658 toc pages
659 TOC_PT_SIZE Point size to use on toc pages
660 TOC_RV_SWITCH Switch L/R margins of toc pages
661 TOC_PARAHEAD_FAMILY Family of toc parahead entries
662 TOC_PARAHEAD_FONT Font of toc parahead entries
663 TOC_PARAHEAD_INDENT Indent of toc parahead entries
664 TOC_PARAHEAD_SIZE How much to in/decrease ps of parahead
665 entries****
666 TOC_SUBHEAD_FAMILY Family of toc subhead entries
667 TOC_SUBHEAD_FONT Font of toc subhead entries
668 TOC_SUBHEAD_INDENT Indent of toc subhead entries
669 TOC_SUBHEAD_SIZE How much to in/decrease ps of subhead
670 entries****
671 TOC_TITLE_ENTRY User supplied toc doc title entry
672 TOC_TITLE_FAMILY Family of toc doc title entries
673 TOC_TITLE_FONT Font of toc doc title entries
674 TOC_TITLE_INDENT Indent of toc doc title entries
675 TOC_TITLE_SIZE How much to in/decrease ps of doc title
676 entries****
677 UNDERLINE_ITALIC In TYPEWRITE, render .FT I as underlined
678 UNDERLINE_QUOTES In TYPEWRITE, underline quotes? (toggle)
679 UNDERLINE_SLANT In TYPEWRITE, render \*[SLANT] as underlined
681 *relative to #DOC_PT_SIZE
682 **relative to overall ps of headers as set by HEADER_SIZE
683 ***relative to overal ps of endnotes pages
684 ****relative to overall ps of toc pages
686 +++LETTER MACROS+++
688 CLOSING Closing (ie. Yours truly,)
689 DATE Date string for letters
690 FROM Addressor's name and address
691 GREETING Full salutation (eg. Dear John Smith,)
692 NO_SUITE Remove suite page numbers from bottom of letter pages
693 TO Addressee's name and address
694 ALL_DONE .em (the "end macro") for letters
696 +++DIVERSIONS+++
698 B_QUOTE Block (indented) quote text
699 CLOSING Closing (ie. Yours truly,)
700 DATE Date string for letters
701 EPI_TEXT Epigraph text
702 END_NOTES Endnotes text
703 FN_OVERFLOW Excess footnotes when B_MARGIN is reached
704 FOOTNOTES Text of footnotes
705 FROM_ADDRESS Addressor's name and address
706 GREETING Full salutation (eg. Dear John Smith,)
707 P_QUOTE Line for line (poetic) quote text
708 TO_ADDRESS Addressee's name and address
709 TOC_ENTRIES TOC entries
711 +++SUPPORT+++
713 CHECK_INDENT Applies indents to doc elements inside ev's
714 (head, subhead, etc)
715 D0_QUOTE Outputs quotes with space adjustments before
716 and after
717 DIVERT_FN_LEFTOVER Diverts excess fn stored in FN_OVERFLOW into
718 FOOTNOTE
719 DIVERT_FN_OVERFLOW Diverts excess fn stored in FN_OVERFLOW when
720 FN_DEFER into FOOTNOTE
721 DO_EPIGRAPH Outputs epigraphs with space adjustments before
722 and after
723 FN_OVERFLOW_TRAP Fixed at B_MARGIN; if footnotes run longer than
724 B_MARGIN, diverts excess into FN_OVERFLOW
725 HDRFTR_RULE Prints rule under header or over footer
726 PRINT_FOOTNOTE_RULE An alias of PRINT_FOOTNOTE; prints footnote
727 separator rule
728 PRINT_HDRFTR Prints header/footer (trap invoked)
729 PRINT_PAGE_NUMBER Invoked in HEADER or FOOTER
730 PRINT_USERDEF_HDRFTR Prints user defined, single string recto/verso
731 header/footer
732 REMOVE_INDENT Removes indents set with CHECK_INDENT
733 TRAPS Sets hdrftr traps; optionally adjusts #DOC_LEAD
734 to fill page to #B_MARGIN
736 +++NUMBER REGISTERS+++
738 #ADJ_DOC_LEAD Adjust DOC_LEAD? (toggle)
739 #ADJ_TOC_LEAD Adjust TOC_LEAD? (toggle)
740 #ARG_NUM Keeps track of number of args passed to a
741 macro
742 #AUTHOR_[n] Strings passed to AUTHOR
743 #AUTHOR_LINES # of lines of authors in doc header; odd=0
744 even=1
745 #AUTHOR_NUM Keeps track of user-defined string
746 AUTHOR_&lt;#&gt; in AUTHOR
747 #AUTHORS Equals final value of AUTHOR_NUM;
748 used for authors in doc header
749 #BROKEN_QUOTE Did we invoke BREAK_QUOTE? (toggle)
750 #CAP_HEIGHT_ADJUST Tallest cap height of strings LEFT, CENTER,
751 and RIGHT in footers; used to place rule
752 over footer
753 #CAPS_WAS_ON In HDRFTR, to re-enable running text CAPS
754 (toggle)
755 #CENTER_CAP_HEIGHT Cap height of center string in
756 headers/footers
757 #CLOSING Is there a closing (for letters)? 1=yes
758 #COL_L_LENGTH Line length of columns
759 #COL_NEXT Was COL_NEXT invoked? (toggle; used in
760 FOOTER)
761 #COL_NUM Incrementing counter of num of columns;
762 for use with #COL_&lt;#&gt;_L_MARGIN
763 #COL_TOTAL #COL_L_LENGTH + #GUTTER; used to calculate
764 #COL_&lt;#&gt;_L_MARGIN
765 #COLLATED_DOC If 1, instructs TOC that this is a collated
767 #COLUMNS Are columns turned on? (toggle)
768 #COLUMNS_WERE_ON Stores columnar state prior to outputting
769 endnotes in no-columns mode
770 #COPY_STYLE 1=draft, 2=final
771 dc "mark" register for document columns
772 #DATE Is there a date (for letters)? 1=yes
773 #DEFER_PAGINATION Tells COLLATE to restore pagination (from
774 RESTORE_PAGINATION
775 #DEPTH_1 Doc header depth with lead adjustment
776 (#DOCHEADER_LINES * #DOCHEADER_LEAD)
777 #DEPTH_2 Doc header depth without lead adjustment
778 (#DOCHEADER_LINES * #DOC_LEAD)
779 #DEPTH_TO_B_MARGIN Page length minus #B_MARGIN
780 #DOCHEADER_ADVANCE Distance from top-of-page to baseline of
781 docheader
782 #DOCHEADER_LEAD_ADJ +|- value applied to #DOC_LEAD to
783 in/decrease leading of doc header
784 #DOCHEADER_LEAD Lead of doc header
785 (#DOC_LEAD + #DOCHEADER_LEAD_ADJ)
786 #DOCHEADER_SPACE_ADJ Lead difference between #DEPTH_1 and
787 #DEPTH_2
788 #DOC_HEADER Whether to print a doc header (toggle)
789 #DOC_LEAD_ADJ Incrementing value (in units) added to
790 #DOC_LEAD to fill page to #B_MARGIN
791 #DOC_LEAD Leading used in body
792 #DOC_L_LENGTH Global L_LENGTH
793 #DOC_L_MARGIN Global L_MARGIN
794 #DOC_LR_MARGIN_TMP In HEADER, if RECTO_VERSO=1, temporarily
795 holds DOC_L_MARGIN during page margin switch
796 #DOC_PT_SIZE Point size used for body text
797 #DOC_R_MARGIN Global R_MARGIN
798 #DOCS Always 1 after START
799 #DOC_TYPE 1=default, 2=chapter, 3=named, 4=letter
800 #DRAFT The draft number
801 #DRAFT_WITH_PAGENUM Are we attaching draft/revision info to page
802 number? (toggle)
803 #EM_ADJUST Amount to raise \(em at END
804 #EN_ALLOWS_HEADERS Put page headers on endnotes pages? (toggle)
805 #EN_ALLOWS_HEADERS_ALL Put page headers on all endnotes pages?
806 (toggle)
807 #EN_FIRST_PAGE Tells PRINT_PAGE_NUMBER about endnotes
808 first page number
809 #EN_FIRST_PN Page number that appears on page 1 of
810 endnotes pages.
811 #EN_LEAD Lead of endnotes
812 #EN_NO_COLS Do not set endnotes in columns? (toggle)
813 #EN_NO_FIRST_PN Put pagenumber on 1st page of endnotes?
814 (toggle)
815 #EN_NUMBERS_ALIGN_RIGHT Hang and align endnote numbers right?
816 (toggle)
817 #EN_NUMBERS_ALIGN_LEFT Align endnote numbers with left margin?
818 (toggle)
819 #EN_NUMBERS_PLACEHOLDERS Number of placeholders when endnote numbers hang and align right
820 #EN_NUMBER_L_LENGTH Line length for endnote numbers when they're
821 right aligned
822 #EN_PP_INDENT First line indent of paras in multi-para
823 endnotes
824 #EN_PP_SPACE Space multi-paras in endnotes? (toggle)
825 #EN_PS ps of endnotes
826 #EN_SINGLESPACE Single space endnotes pages? (toggle)
827 #EN_STRING_CAPS Should ENDNOTES capitalise the endnotes
828 string? (toggle)
829 #EN_STRING_UNDERSCORE Underscore endnotes page head? (toggle)
830 #EN_TITLE_UNDERSCORE Underscore endnotes document identifier?
831 (toggle)
832 #EN_TEXT_INDENT Page offset for text of endnotes when
833 numbers right align
834 #END_QUOTE For PP=0 indenting; did we just end a quote?
835 (toggle)
836 #ENDNOTE Are we in an endnote? (toggle)
837 #ENDNOTES Are we in an endnote (for FOOTERs; toggle)
838 #EN_HDRFTR_CENTER Should we print centre string of
839 headers/footers on endnotes pages? (toggle)
840 #EPI_ACTIVE Are we in an epigraph? (toggle)
841 #EPI_DEPTH Depth of epigraph from first baseline to
842 last
843 #EPI_FITS Does epigraph fit on page/column? (toggle)
844 #EPIGRAPH Did we have an epigraph? (toggle)
845 #EPI_LEAD_DIFF Difference between #DOC_LEAD and #EPI_LEAD
846 #EPI_LEAD Leading of epigraph; set by AUTOLEAD
847 #EPI_LINES_EVEN Even # of lines at end of epi crossing page in TYPEWRITE (d-spaced)?
848 #EPI_LINES Number of lines in the epigraph
849 #EPI_LINES_TO_END Number of epigraph lines remaining after
850 footer trap is sprung
851 #EPI_LINES_TO_TRAP Number of epigraph lines till footer trap is
852 sprung
853 #EPI_L_LENGTH Epigraph line length
854 #EPI_OFFSET Left margin of epigraphs
855 #EPI_OFFSET_VALUE Epigraph indent as a function of page offset
856 #EPI_ON Are we in an epigraph? (toggle)
857 #EPI_WHITESPACE Space after epigraph to compensate for
858 epigraph leading
859 #FINIS Was FINIS invoked? (toggle)
860 #FN_AUTOLEAD Autolead value of footnotes
861 #FN_BL_INDENT Left indent of INDENT BOTH in footnotes
862 #FN_BR_INDENT Right indent of INDENT BOTH in footnotes
863 #FN_COUNT_FOR_COLS Holds a separate footnote count for columns (so they don't reset to 0 1 until page break)
864 #FN_DEFER Defer footnote to next page/column? (toggle) If 0, don't defer.
865 #FN_DEFER_SPACE Whether to deposit space before
866 footnote 1 because there's a deferred
867 footnote on the page
868 #FN_DEPTH Depth of footnote diversion(s)
869 #FN_FOR_EPI Signals to epigraph that a footnote is being
870 processed
871 #FN_LEAD Lead in footnotes after FN_AUTOLEAD is
872 applied
873 #FN_L_INDENT Left indent of INDENT LEFT in footnotes
874 #FN_LINES Number of lines in fn; used to calculate fn depth
875 #FN_MARKERS Print footnote markers? (toggle)
876 #FN_MARKER_STYLE 1=STAR; 2=NUMBER
877 #FN_NUMBER Running count of fn #; used to print fn marker numbers
878 #FN_R_INDENT Right indent of INDENT RIGHT in footnotes
879 #FN_RULE_ADJ # of points to raise footnote separator from
880 its baseline
881 #FN_RULE_LENGTH Length of footnote separator rule
882 #FN_RULE Print fn rule? (toggle)
883 #FN_WAS_DEFERED Tells HEADER about a defered footnote
884 #FOOTER_GAP Amount of space between end of text and
885 page #
886 #FOOTER_MARGIN Amount of space between page # and bottom
887 of page
888 #FOOTERS_ON Are we using footers? (toggle)
889 #FOOTERS_WERE_ON Were footers on? - used in FINIS and BLANKPAGE (toggle)
890 #FROM Is there an addressor (for letters)? 1=yes
891 #FULLSPACE_QUOTES Should we fullspace quotes? (toggle)
892 #GREETING Is there a greeting (for letters)? 1=yes
893 #GUTTER Width of gutter between columns
894 #HDRFTR_CENTER_CAPS Center part of header/footer in caps?
895 (toggle; default=off)
896 #HDRFTR_CTR_PAD_LEFT Amount of hdrftr center padding on the left
897 #HDRFTR_CTR_PAD_RIGHT Amount of hdrftr center padding on the right
898 #HDRFTR_CTR_PAD_TMP Temp storage of left hdrftr center padding
899 (for recto/verso switch)
900 #HDRFTR_HEIGHT Cap height of $HDRFTR_RECTO/$HDRFTR_VERSO
901 strings
902 #HDRFTR_LEFT_CAPS Left part of header/footer in caps?
903 (toggle; default=off)
904 #HDRFTR_RIGHT_CAPS Right part of header/footer in caps?
905 (toggle; default=on)
906 #HDRFTR_RULE_GAP Space between header/footer and
907 header/footer rule
908 #HDRFTR_RULE Print head/footer rule? (toggle)
909 #HDRFTR_TMP_CAPS_SWITCH Temporarily holds HDRFTR_LEFT_CAPS value if
910 #SWITCH_HDRFTR=1
911 #HEAD 1=main/section head 2=subhead
912 #HEAD_CAPS Print section titles in caps? (toggle)
913 #HEADER_GAP Distance from header to running text
914 #HEADER_MARGIN Distance from top of page to header
915 #HEADERS_ON Headers on? (toggle)
916 #HEADER_STATE Saves header state in COLLATE for use in
917 START after COLLATE
918 #HEADERS_WERE_ON Were headers on? - used in BLANKPAGE (toggle)
919 #HEAD_NUM Head number
920 #HEAD_SPACE 2 line spaces before heads?
921 (toggle; 1=yes, 0=no)
922 #HEAD_UNDERLINE Underline section titles? (toggle)
923 #HOW_MANY Number of blank pages to output
924 #IGNORE Should we ignore this macro? Set to 1 in
925 TYPEWRITE.
926 #INDENT_FIRST_PARAS Indent first paras? (toggle)
927 #INDENT_FIRSTS Tells foonotes to leave INDENT_FIRST_PARAS
928 alone if it's on for running text.
929 #ITALIC_MEANS_ITALIC For TYPEWRITE. 1=yes; 0=no
930 #LEFT_CAP_HEIGHT Cap height of left string in headers/footers
931 #LETTER_STYLE 1=BUSINESS 2=PERSONAL
932 #LINEBREAK Did we have a linebreak? (toggle)
933 #LINES_PER_PAGE # of lines (at DOC_LEAD) that fit on
934 page after #B_MARGIN is set
935 #L_LENGTH_FOR_EPI Stores line length at top of doc for use
936 with EPIGRAPH when columns are on
937 #L_MARGIN_DIFF Difference between DOC_L_MARGIN and
938 L_MARGIN
939 #n%_AT_PAGENUM_SET Page # from n% when PAGENUMBER invoked
940 #NEXT_AUTHOR Supplies correct digit to AUTHOR_&lt;#&gt;
941 when printing authors in doc header
942 #NO_TRAP_RESET Should we reset page traps? (toggle)
943 #NUM_AUTHORS # of authors mod 2 to test if odd or even # of authors
944 #NUMBER_HEAD Are heads numbered? (toggle)
945 #NUMBER_PH Are paraheads numbered? (toggle)
946 #NUMBER_SH Are subheads numbered? (toggle)
947 #NUM_COLS Number of columns per page
948 #OK_PROCESS_LEAD Initial processing of TOC and endnote
949 leading is defered until OK_PROCESS_LEAD=1
950 #PAGE_NUM_ADJ What to add to n% to get #PAGENUMBER
951 #PAGENUMBER The page number
952 #PAGENUM_STYLE_SET Did we set pagenumber style? (toggle)
953 #PAGE_NUM_H_POS 1=left 2=center 3=right; default=2
954 #PAGE_NUM_HYPHENS Print hyphens surrounding page numbers?
955 (toggle)
956 #PAGE_NUM_HYPHENS_SET Did user set (or unset) hyphens around page numbers? (toggle)
957 #PAGE_NUM_POS_SET Did user set page number position? (toggle)
958 #PAGE_NUM_SET Test if PAGE_1_NUM was used to set 1st page number
959 #PAGE_NUMS Print page numbers? (toggle)
960 #PAGE_NUM_V_POS 1=top 2=bottom; default=2
961 #PAGE_TOP \n(nl after HEADER completes itself
962 #PH_NUM Parahead number
963 #PAGINATE_TOC Is toc pagination on? (toggle)
964 #PAGINATE_WAS_ON Keeps track of pagination state while
965 outputting blank pages
966 #PAGINATION_STATE Saves pagination state in COLLATE for use in
967 START after a COLLATE
968 #PAGINATION_WAS_ON Was pagination on? - used in FINIS (toggle)
969 #PP 0 at first para; auto-increments
970 #PP_AT_PAGE_BREAK # of last (incl. partial) para on page
971 #PP_INDENT How much to indent paras
972 #PP_SPACE Put space before paras? (toggle)
973 #PP_SPACE_SUSPEND Suspend para spacing for blockquotes and
974 epigraphs
975 #PP_STYLE_PREV In footnotes, stores PP style in effect
976 prior to invoking FOOTNOTE
977 #PP_STYLE Regular para=1; quote or epi para=2
978 #PRINT_PAGENUM_ON_PAGE_1 Should we print the page number on first
979 page of doc when footers are on? (toggle)
980 #PRINT_STYLE Typewrite=1, typeset=2
981 #PT_SIZE_IN_UNITS Stored value of \n[.ps] from last time
982 PT_SIZE was called
983 #Q_DEPTH Depth of quote
984 #Q_FITS Does this quote fit on one page/column?
985 (toggle)
986 #Q_L_LENGTH Line length of quotes
987 #Q_OFFSET Page offset for quotes
988 #Q_OFFSET_VALUE Factor by which to multiply PP_INDENT to
989 offset quotes
990 #Q_PP In PP, stores para # in QUOTE. Removed in
991 ENDQUOTE.
992 #Q_TOP Vertical place on page that a quote starts
993 #QUOTE 1=PQUOTE, 2=BQUOTE
994 #RECTO_VERSO Switch HEADER_LEFT and HEADER_RIGHT on
995 alternate pages? (toggle); default=0
996 #REPEAT Number of times to repeat linebreak
997 character
998 #RESET_EN_PP Holds value of register #EN_PP_INDENT
999 #RESET_FN_NUMBER Should fn# start at 1 on every page?
1000 (toggle)
1001 #RESET_L_LENGTH Stores current line length when necessary
1002 #RESET_PARA_SPACE Holds current value of toggle register
1003 #PP_SPACE
1004 #RESET_PP_INDENT Stores value of PP_INDENT when necessary
1005 #RESET_QUOTE_SPACING Stores value of toggle register
1006 #FULLSPACE_QUOTES (used in endnotes)
1007 #RESTORE_DOC_LEAD Holds value of current doc lead (used in
1008 endnotes)
1009 #RESTORE_OFFSET Page offset at moment footer trap is sprung;
1010 not currently used
1011 #RESTORE_TOC_PN_PADDING Saves #TOC_PN_PADDING in TOC prior to
1012 processing $FIRST_DOC_TITLE
1013 #REVISION The revision number
1014 #RIGHT_CAP_HEIGHT Cap height of right string in
1015 headers/footers
1016 #SH_LEAD_ADJUST #DOC_LEAD/8 (TYPESET) or /2 (TYPEWRITE)
1017 (used for subhead spacing)
1018 #SH_NUM Subhead number
1019 #SINGLE_SPACE Is TYPEWRITE in single space mode? (toggle)
1020 #SLANT_MEANS_SLANT For TYPEWRITE. 1=yes; 0=no
1021 #SLANT_WAS_ON Keeps track of SLANT when it needs to go off
1022 for a while
1023 #SPACE_REMAINING Space remaining to footer trap; used to
1024 decide whether or not to defer a footnote
1025 #START If 1, signals completion of START
1026 #START_FOR_FOOTERS Toggle set in START; signals to
1027 PRINT_HDRFTR that START has been invoked,
1028 allowing PRINT_HDRFTR to decide whether or
1029 not to print a footer on page 1
1030 #SUITE Current page number (for letters)
1031 #SUP_PT_SIZE Point size of superscript
1032 #SUSPEND_PAGINATION Suspend pagination prior to endnotes?
1033 #SWITCH_HDRFTR Switch HDRFTR_LEFT and HDRFTR_RIGHT?
1034 (toggle)
1035 #TAB_OFFSET# "#" at the end is from $CURRENT_TAB
1036 #TO Is there an addressee date (for letters)?
1037 1=yes
1038 #TOC_AUTHORS Whether to append author(s) to toc doc
1039 title entries (toggle)
1040 #TOC_ENTRY_PN Current page number when a toc entry is
1041 collected
1042 #TOC_FIRST_PAGE If 1, tells PRINT_PAGE_NUMBER that this
1043 is the first page of the toc
1044 #TOC_LEAD Leading of toc pages
1045 #TOC_PN_PADDING Max. # of placeholders for toc entries
1046 page numbers
1047 #TOC_PS Point size of toc pages
1048 #TOC_RV_SWITCH Switch L/R margins of toc pages
1049 #TOC_HEAD_INDENT Indent of toc head entries
1050 #TOC_HEAD_SIZE_CHANGE ps in/decrease of toc head entries****
1051 #TOC_PH_INDENT Indent of toc parahead entries
1052 #TOC_PH_SIZE_CHANGE ps in/decrease of toc parahead entries****
1053 #TOC_SH_INDENT Indent of toc subhead entries
1054 #TOC_SH_SIZE_CHANGE ps in/decrease of toc subhead entries****
1055 #TOC_TITLE_INDENT Indent of toc doc title entries
1056 #TOC_TITLE_SIZE_CHANGE ps in/decrease of toc doc title entries****
1057 #UNDERLINE_ITALIC For TYPEWRITE. 1=yes; 0=no
1058 #UNDERLINE_QUOTE Underline pquotes? (toggle)
1059 #UNDERLINE_SLANT For TYPEWRITE. 1=yes; 0=no
1060 #UNDERLINE_WAS_ON In HEADER to re-enable running text
1061 UNDERLINE (toggle)
1062 #USERDEF_HDRFTR User defined single string recto/verso
1063 header/footer? (toggle)
1064 #USERDEF_HDRFTR_RECTO_QUAD 1=left, 2=center, 3=right
1065 #USERDEF_HDRFTR_VERSO_QUAD 1=left, 2=center, 3=right
1066 #USER_DEF_HEADER_CENTER User defined center title? (1=yes);
1067 used in COPYSTYLE
1068 #USER_DEF_HEADER_LEFT User defined center title? (1=yes);
1069 used in COPYSTYLE
1070 #USER_DEF_HEADER_RIGHT User defined center title? (1=yes);
1071 used in COPYSTYLE
1072 #VARIABLE_FOOTER_POS Wandering trap position for processing
1073 footnotes and footers; pos depends on
1074 footnotes
1076 +++STRINGS+++
1078 $ATTRIBUTE_STRING "by" line in doc header
1079 $AUTHOR_1...9 Document author(s)
1080 $AUTHOR_FAM Family to use for author in doc header
1081 $AUTHOR_FT Font to use for author in doc header
1082 $AUTHOR_SIZE_CHANGE ps in/decrease of author in doc header*
1083 $AUTHOR_PT_SIZE Absolute ps of authors
1084 $BQUOTE_FAM Family to use for blockquotes
1085 $BQUOTE_FT Font to use for blockquotes
1086 $BQUOTE_QUAD Quad value for blockquotes
1087 $BQUOTE_SIZE_CHANGE ps in/decrease of blockquotes*
1088 $CENTER_TITLE What to put in the middle of header
1089 title
1090 $CHAPTER The chapter number
1091 $CHAPTER_STRING What to print whenever the word
1092 "chapter" is required
1093 $CHAPTER_TITLE Chapter title (if there is one)
1094 $CHAPTER_TITLE_FAM Family of chapter title
1095 $CHAPTER_TITLE_FT Font of chapter title
1096 $CHAPTER_TITLE_SIZE_CHANGE ps in/decrease of chapter title*
1097 $CHAPTER_TITLE_PT_SIZE Absolute ps of chapter title
1098 $COPY_STYLE DRAFT or FINAL
1099 $DOC_FAM Predominant font family used in the
1100 document
1101 $DOC_QUAD Quad used for body text (justified or
1102 left)
1103 $DOC_TITLE Overall doc title that gets printed in
1104 headers/footers (mostly for use with collated
1105 docs where each doc is an article with a
1106 different title
1107 $DOC_TYPE Document type (default, chapter, named,
1108 letter)
1109 $DOCTYPE_FAM Family to use for DOCTYPE string in
1110 doc header
1111 $DOCTYPE_FT Font to use for DOCTYPE string in
1112 doc header
1113 $DOCTYPE_SIZE_CHANGE ps in/decrease of DOCTYPE string in
1114 doc header*
1115 $DOCTYPE_PT_SIZE Absolute ps of DOCTYPE
1116 $DRAFT_STRING What to print whenever the word "draft"
1117 is required
1118 $EN_FAMILY Family for endnotes
1119 $EN_FT Font for endnotes
1120 $EN_PN_STYLE Pagenumbering style for endnotes pages
1121 $EN_QUAD Quad for endnotes
1122 $EN_STRING Endnotes page head
1123 $EN_STRING_FAM Endnotes page head family
1124 $EN_STRING_FT Endnotes page head font
1125 $EN_STRING_QUAD Endnotes page head quad direction
1126 $EN_STRING_SIZE_CHANGE Endnotes page head size***
1127 $EN_TITLE Endnote document identifier
1128 $EN_TITLE_FAM Endnote document identifier family
1129 $EN_TITLE_FT Endnote document identifier font
1130 $EN_TITLE_QUAD Endnote document identifier quad
1131 direction
1132 $EN_TITLE_SIZE_CHANGE Endnote document identifier size***
1133 $EN_NUMBER_FAM Endnote numbering family
1134 $EN_NUMBER_FT Endnote numbering font
1135 $EN_NUMBER_SIZE_CHANGE Endnote numbering size***
1136 $EPI_AUTOLEAD Autolead value (decimals ok) of
1137 epigraphs
1138 $EPI_FAM Family to use in epigraphs
1139 $EPI_FT Font to use in epigraphs
1140 $EPI_QUAD Quad in block-style epigraphs
1141 (justified or left)
1142 $EPI_SIZE_CHANGE ps in/decrease of epigraphs*
1143 $FINIS_STRING What to print when FINIS macro is
1144 invoked
1145 $FIRST_DOC_TITLE 1st doc's title captured in COLLATE
1146 $FN_FAM Family used in footnotes
1147 $FN_FT Font used in footnotes
1148 $FN_QUAD Quad used in footnotes
1149 $FN_SIZE_CHANGE ps in/decrease of footnotes*
1150 $HDRFTR_CENTER What to put in center part of headers;
1151 default doctype
1152 $HDRFTR_CENTER_FAM Family of center part of headers
1153 $HDRFTR_CENTER_FT Font of center part of headers
1154 $HDRFTR_CENTER_NEW HDRFTR_CENTER after the start of TOC;
1155 defined in HDRFTR_CENTER if
1156 HDRFTR_CENTER is called as
1157 FOOTER_CENTER
1158 $HDRFTR_CENTER_OLD HDRFTR_CENTER just prior to start of
1159 TOC; defined in HDRFTR_CENTER if
1160 HDRFTR_CENTER is called as
1161 FOOTER_CENTER
1162 $HDRFTR_CENTER_SIZE_CHANGE ps in/decrease of center title in
1163 headers**
1164 $HDRFTR_FAM Family to use in headers
1165 $HDRFTR_LEFT_FAM Family of left part of headers
1166 $HDRFTR_LEFT_FT Font of left part of headers
1167 $HDRFTR_LEFT_SIZE_CHANGE ps in/decrease of author in headers**
1168 $HDRFTR_LEFT What to put in left part of headers;
1169 default author
1170 $HDRFTR_RIGHT_FAM Family of right part of headers
1171 $HDRFTR_RIGHT_FT Font of right part of headers
1172 $HDRFTR_RIGHT_SIZE_CHANGE ps in/decrease of right part of
1173 headers**
1174 $HDRFTR_RIGHT What to put in right part of headers;
1175 default title
1176 $HDRFTR_SIZE_CHANGE ps in/decrease of headers*
1177 $HDRFTR_TMP_SIZE_CHANGE_SWITCH Temporarily holds
1178 HDRFTR_LEFT_SIZE_CHANGE if
1179 #SWITCH_HDRFTRS=1
1180 $HDRFTR_TMP_SWITCH Temporarily holds HDRFTR_LEFT if
1181 #SWITCH_HDRFTRS=1
1182 $HEAD_FAM Family to use for section titles
1183 $HEAD_FT Font to use for section titles
1184 $HEAD_QUAD Quad valude of section titles
1185 $HEAD_SIZE_CHANGE ps in/decrease of section titles*
1186 $LINEBREAK_CHAR Character that marks line breaks
1187 $LINEBREAK_CHAR_V_ADJ +|- amount by which to raise/lower
1188 linebreak character
1189 PAGE# For use in hdrftr strings where page #
1190 is needed; \*[PAGE]
1191 $PAGENUM_STYLE String passed to PAGENUM_STYLE
1192 $PAGE_NUM_FAM Family of page numbers
1193 $PAGE_NUM_FT Font of page numbers
1194 $PAGE_NUM_SIZE_CHANGE ps in/decrease of page numbers
1195 $PAPER Paper size (LETTER, A4, LEGAL);
1196 default=LETTER
1197 $PP_FT Font used in paragraphs
1198 $QUOTE_FAM Family to use for pquotes
1199 $QUOTE_FT Font to use for pquotes
1200 $QUOTE_SIZE_CHANGE ps in/decrease of pquotes*
1201 $REVISION_STRING What to print whenever the word
1202 "revision" is required
1203 $SH_FAM Family to use in subheads
1204 $SH_FT Font to use in subheads
1205 $SH_SIZE_CHANGE ps in/decrease of subheads*
1206 $SUBTITLE Document subtitle
1207 $SUBTITLE_FAM Family to use for subtitle in doc
1208 header
1209 $SUBTITLE_FT Font to use for subtitle in doc header
1210 $SUBTITLE_SIZE_CHANGE ps in/decrease of subtitle*
1211 $SUBTITLE_PT_SIZE Absolute ps of subtitle
1212 $SUITE The #SUITE number register
1213 $TITLE Document title
1214 $TITLE_FAM Family to use for title in doc header
1215 $TITLE_FT Font to use for title in doc header
1216 $TITLE_PT_SIZE Absolute point size of title in docheader
1217 $TITLE_SIZE_CHANGE ps in/decrease of title in doc header*
1218 $TOC_AUTHORS What to print after toc doc title entry
1219 if #TOC_AUTHORS=1
1220 $TOC_FAM Family to use on toc pages
1221 $TOC_HEAD_FAM Family of toc head entries
1222 $TOC_HEAD_FT Font of toc head entries
1223 $TOC_HEAD_ITEM A head as collected for TOC_ENTRIES
1224 $TOC_HEADER_FAM Family to use for "Contents"
1225 $TOC_HEADER_FT Font to use for "Contents"
1226 $TOC_HEADER_QUAD Quad direction of "Contents"
1227 $TOC_HEADER_SIZE ps in/decrease of "Contents"****
1228 $TOC_HEADER_STRING Header string of first toc page
1229 $TOC_PN Sets up toc leaders + entry pn
1230 (typeset)
1231 $TOC_PN_FAM Family for toc entries page numbers
1232 $TOC_PN_FT Font for toc entries page numbers
1233 $TOC_PN_SIZE_CHANGE ps in/decrease of toc entries page
1234 numbers
1235 $TOC_PN_STYLE Page-numbering style of toc pages
1236 $TOC_PN_TYPEWRITE Sets up toc leaders + entry pn
1237 (typewrite)
1238 $TOC_PH_FAM Family of toc parahead entries
1239 $TOC_PH_FT Font of toc parahead entries
1240 $TOC_PARAHEAD_ITEM A parahead collected for TOC_ENTRIES
1241 $TOC_SH_FAM Family of toc subhead entries
1242 $TOC_SH_FT Font of toc subhead entries
1243 $TOC_SH_ITEM A subhead collected for TOC_ENTRIES
1244 $TOC_TITLE_FAM Family of toc doc title entries
1245 $TOC_TITLE_FT Font of toc doc title entries
1246 $USER_SET_TITLE_ITEM User defined toc doc title entry as
1247 set by TOC_TITLE_ENTRY
1248 $UR_PAGINATION_STYLE Pagination style prior to endnotes
1249 $USERDEF_HDRFTR_RECTO User defined header/footer recto string
1250 $USERDEF_HDRFTR_VERSO User defined header/footer verso string
1252 *relative to #DOC_PT_SIZE
1253 **relative to overall ps of headers as set by HEADER_SIZE
1254 ***relative to overall ps of endnotes
1255 ****relative to overal ps of toc pages
1257 +++PREPROCESSOR KEYWORDS+++
1259 (eqn)
1263 (grn)
1268 (pic)
1272 (refer)
1278 (tbl)
1283 (grap)
1287 (ideal)
1291 (chem)
1292 cstart
1293 cend
1295 +++ALIASES+++
1297 BREAK_BLOCKQUOTE BREAK_QUOTE
1298 BREAK_CITATION BREAK_QUOTE
1299 BREAK_CITE BREAK_QUOTE
1300 CITATION BLOCKQUOTE
1301 CITE BLOCKQUOTE
1302 COL_BREAK COL_NEXT
1303 DOC_FAM DOC_FAMILY
1304 DOC_LLENGTH DOC_LINE_LENGTH
1305 DOC_L_LENGTT DOC_LINE_LENGTH
1306 DOC_L_MARGIN DOC_LEFT_MARGIN
1307 DOC_LMARGIN DOC_LEFT_MARGIN
1308 DOC_LS DOC_LEAD
1309 DOC_PS DOC_PT_SIZE
1310 DOC_R_MARGIN DOC_RIGHT_MARGIN
1311 DOC_RMARGIN DOC_RIGHT_MARGIN
1312 FOOTER_CENTER_CAPS HDRFTR_CENTER_CAPS
1313 FOOTER_CENTER_FAM HDRFTR_CENTER_FAMILY
1314 FOOTER_CENTER_FAMILY HDRFTR_CENTER_FAMILY
1315 FOOTER_CENTER_FONT HDRFTR_CENTER_FONT
1316 FOOTER_CENTER_FT HDRFTR_CENTER_FONT
1317 FOOTER_CENTER HDRFTR_CENTER
1318 FOOTER_CENTER_PS HDRFTR_CENTER_SIZE
1319 FOOTER_CENTER_SIZE HDRFTR_CENTER_SIZE
1320 FOOTER_CENTRE_CAPS HDRFTR_CENTER_CAPS
1321 FOOTER_CENTRE_FAM HDRFTR_CENTER_FAMILY
1322 FOOTER_CENTRE_FAMILY HDRFTR_CENTER_FAMILY
1323 FOOTER_CENTRE_FT HDRFTR_CENTER_FONT
1324 FOOTER_CENTRE HDRFTR_CENTER
1325 FOOTER_CENTRE_PS HDRFTR_CENTER_SIZE
1326 FOOTER_CENTRE_SIZE HDRFTR_CENTER_SIZE
1327 FOOTER_FAM HDRFTR_FAMILY
1328 FOOTER_FAMILY HDRFTR_FAMILY
1329 FOOTER_LEFT_CAPS HDRFTR_LEFT_CAPS
1330 FOOTER_LEFT_FAM HDRFTR_LEFT_FAMILY
1331 FOOTER_LEFT_FAMILY HDRFTR_LEFT_FAMILY
1332 FOOTER_LEFT_FONT HDRFTR_LEFT_FONT
1333 FOOTER_LEFT_FT HDRFTR_LEFT_FONT
1334 FOOTER_LEFT HDRFTR_LEFT
1335 FOOTER_LEFT_PS HDRFTR_LEFT_SIZE
1336 FOOTER_LEFT_SIZE HDRFTR_LEFT_SIZE
1337 FOOTER_PLAIN HDRFTR_PLAIN
1338 FOOTER_RECTO HDRFTR_RECTO
1339 FOOTER_RIGHT_CAPS HDRFTR_RIGHT_CAPS
1340 FOOTER_RIGHT_FAM HDRFTR_RIGHT_FAMILY
1341 FOOTER_RIGHT_FAMILY HDRFTR_RIGHT_FAMILY
1342 FOOTER_RIGHT_FONT HDRFTR_RIGHT_FONT
1343 FOOTER_RIGHT_FT HDRFTR_RIGHT_FONT
1344 FOOTER_RIGHT HDRFTR_RIGHT
1345 FOOTER_RIGHT_PS HDRFTR_RIGHT_SIZE
1346 FOOTER_RIGHT_SIZE HDRFTR_RIGHT_SIZE
1347 FOOTER_RULE_GAP HDRFTR_RULE_GAP
1348 FOOTER_RULE HDRFTR_RULE
1349 FOOTER_SIZE HDRFTR_SIZE
1350 FOOTER_VERSO HDRFTR_VERSO
1351 HDRFTR_RULE_INTERNAL HDRFTR_RULE
1352 HEADER_CENTER_CAPS HDRFTR_CENTER_CAPS
1353 HEADER_CENTER_FAM HDRFTR_CENTER_FAMILY
1354 HEADER_CENTER_FAMILY HDRFTR_CENTER_FAMILY
1355 HEADER_CENTER_FONT HDRFTR_CENTER_FONT
1356 HEADER_CENTER_FT HDRFTR_CENTER_FONT
1357 HEADER_CENTER HDRFTR_CENTER
1358 HEADER_CENTER_PS HDRFTR_CENTER_SIZE
1359 HEADER_CENTER_SIZE HDRFTR_CENTER_SIZE
1360 HEADER_CENTRE_CAPS HDRFTR_CENTER_CAPS
1361 HEADER_CENTRE_FAM HDRFTR_CENTER_FAMILY
1362 HEADER_CENTRE_FAMILY HDRFTR_CENTER_FAMILY
1363 HEADER_CENTRE_FONT HDRFTR_CENTER_FONT
1364 HEADER_CENTRE_FT HDRFTR_CENTER_FONT
1365 HEADER_CENTRE HDRFTR_CENTER
1366 HEADER_CENTRE_PS HDRFTR_CENTER_SIZE
1367 HEADER_CENTRE_SIZE HDRFTR_CENTER_SIZE
1368 HEADER_FAM HDRFTR_FAMILY
1369 HEADER_FAMILY HDRFTR_FAMILY
1370 HEADER_LEFT_CAPS HDRFTR_LEFT_CAPS
1371 HEADER_LEFT_FAM HDRFTR_LEFT_FAMILY
1372 HEADER_LEFT_FAMILY HDRFTR_LEFT_FAMILY
1373 HEADER_LEFT_FONT HDRFTR_LEFT_FONT
1374 HEADER_LEFT_FT HDRFTR_LEFT_FONT
1375 HEADER_LEFT HDRFTR_LEFT
1376 HEADER_LEFT_PS HDRFTR_LEFT_SIZE
1377 HEADER_LEFT_SIZE HDRFTR_LEFT_SIZE
1378 HEADER_PLAIN HDRFTR_PLAIN
1379 HEADER_RECTO HDRFTR_RECTO
1380 HEADER_RIGHT_CAPS HDRFTR_RIGHT_CAPS
1381 HEADER_RIGHT_FAM HDRFTR_RIGHT_FAMILY
1382 HEADER_RIGHT_FAMILY HDRFTR_RIGHT_FAMILY
1383 HEADER_RIGHT_FONT HDRFTR_RIGHT_FONT
1384 HEADER_RIGHT_FT HDRFTR_RIGHT_FONT
1385 HEADER_RIGHT HDRFTR_RIGHT
1386 HEADER_RIGHT_PS HDRFTR_RIGHT_SIZE
1387 HEADER_RIGHT_SIZE HDRFTR_RIGHT_SIZE
1388 HEADER_RULE_GAP HDRFTR_RULE_GAP
1389 HEADER_RULE HDRFTR_RULE
1390 HEADER_SIZE HDRFTR_SIZE
1391 HEADER_VERSO HDRFTR_VERSO
1392 PAGENUM PAGENUMBER
1393 PAGINATION PAGINATE
1394 PP_FT PP_FONT
1395 PRINT_FOOTNOTE_RULE FOOTNOTE_RULE
1396 SWITCH_FOOTERS SWITCH_HDRFTR
1397 SWITCH_HEADERS SWITCH_HDRFTR
1398 TOC_FAM TOC_FAMILY
1399 TOC_LS TOC_LEAD
1400 TOC_PS TOC_PT_SIZE
1401 </pre>
1403 <hr>
1404 <a href="appendices.html#TOP">Prev</a>&nbsp;&nbsp;
1405 <a href="#TOP">Top</a>&nbsp;&nbsp;
1406 <a href="toc.html">Back to Table of Contents</a>
1407 </body>
1408 </html>