3 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
4 <title>Mom -- Document Processing, element tags</title>
6 <body bgcolor="#dfdfdf">
8 <!====================================================================>
10 <a href="headfootpage.html#TOP">Next</a>
11 <a href="docprocessing.html#TOP">Prev</a>
12 <a href="toc.html">Back to Table of Contents</a>
16 <h2 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h2>
20 <li><a href="#DOCELEMENT_INTRO">Introduction to the document element tags</a>
22 <li><a href="#DOCELEMENT_CONTROL">Control macros -- changing defaults for document element tags</a>
23 <li><a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
25 <li><a href="#INDEX_DOCELEMENT">Index of document element tags</a>
28 <a name="DOCELEMENT_INTRO">
29 <h2><u>Introduction to the document element tags</u></h2>
32 Once you've completed the setup for a document (see
33 <a href="docprocessing.html#DOCPROCESSING_TUT">Setting up a mom document</a>),
34 formatting it is a snap. Simply invoke the appropriate tag for
35 each document element as you need it. The tags are macros that
36 tell <strong>mom</strong>, "This is a paragraph, this
37 is a subhead, this is a footnote," and so on.
39 The list of tags is actually quite small -- ideal for the users
40 <strong>mom</strong> brought herself into being for (see
41 <a href="intro.html#INTRO_INTRO">Who mom is meant for</a>).
42 However, the list of macros that control the appearance of the
43 tags upon output is extensive. Generally, for each tag,
45 <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>
46 for the tag's family, font and point size. Where appropriate, there
47 are macros to control leading, indents, quad and special features
50 <strong>Mom</strong> has tasteful defaults for all the tags, hence you
51 only use the control macros when you want to change the way
52 she does things. This is usually done prior to
53 <a href="docprocessing.html#START">START</a>,
54 but can, in fact, be done at any time in the course of a document.
55 Any change to a tag's style affects all subsequent invocations of
58 <a name="DOCELEMENT_CONTROL"><h3><u>Control macros -- changing defaults</u></h3></a>
61 The control macros for document processing tags let you
62 "design" the look of all the parts of your documents --
63 should you wish. At a bare minimum, all tags have macros to
64 change <strong>mom</strong>'s defaults for family, font
65 and point size. Where appropriate, there are macros to control
66 leading, indents and quad as well.
68 In addition, many tags have special macros to control features that
69 are pertinent to those tags alone. Have a look at the section dealing
70 with any particular tag to find out what macros control the tag,
71 and what <strong>mom</strong>'s defaults for the tag are.
73 The control macros may be used at any time during the course of
74 a document (i.e. before or after
75 <a href="docprocessing.html#START">START</a>). The changes you
76 make alter all subsequent invocations of the affected tag until
77 you make another change, either by passing new arguments to the
78 tag's control macro, or toggling a particular feature of the tag on
82 <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
83 can be used at any time, including inside
84 <a href="definitions.html#TERMS_TOGGLE">toggle</a>
85 tags (affecting only that particular invocation of the tag).
87 <a href="definitions.html#TERMS_INLINES">inline escapes</a>
88 can be used in tags that take
89 <a href="definitions.html#TERMS_STRINGARGUMENT">string arguments.</a>
91 <strong>IMPORTANT NOTE:</strong> The family, font, point size and
92 leading control macros have no effect in
93 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
94 which sets EVERYTHING in Courier roman, 12/24 (i.e. 12-point type on
95 a linespace of 24 points).
97 Please also note that the defaults listed
98 with the control macros apply only to
99 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
100 unless a default for <strong>TYPEWRITE</strong> is also given.
102 <strong>A WORD OF ADVICE:</strong> Get familiar with
103 <strong>mom</strong> at her default settings before exploring the
104 control macros. Put her through her paces. She how she behaves.
105 Get to know what she feels like and how she looks, both in your text
106 editor and on the printed page. Then, if you don't like something,
107 use this documentation to find the precise macro you need to change it.
108 There are tons of control macros. Reading up on them and trying to
109 remember them all might lead you to think that <strong>mom</strong>
110 is complex and unwieldy, which is not only untrue, but would offend
113 <a name="CONTROL_MACRO_ARGS"><h3><u>Arguments to the control macros</u></h3></a>
115 <h3>Family and font</h3>
116 The arguments to the control macros that end in
117 <strong>_FAMILY</strong> or <strong>_FONT</strong> are the same
119 <a href="typesetting.html#FAMILY">FAMILY</a>
121 <a href="typesetting.html#FONT">FT</a>.
124 Control macros that end in <strong>_SIZE</strong> always take
125 the form <kbd>+digit</kbd> or <kbd>-digit</kbd> where digit is
127 <a href="definitions.html#TERMS_PICASPOINTS">points</a>
128 larger (+) or smaller (-) than the point size of paragraphs
129 you want the document element to be. For example, to change
130 subheads to 1-1/2 points larger than the type in paragraphs, do
136 There's no need for a
137 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
138 with the <strong>_SIZE</strong> control macros; points is assumed.
140 <h3>Lead/linespacing</h3>
141 Control macros that end in <strong>_AUTOLEAD</strong> take the
143 <a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>,
144 viz. a digit that represents the number of points to add to the
145 tag's point size to arrive at its
146 <a href="definitions.html#TERMS_LEADING">lead</a>.
147 For example, to set footnotes
148 <a href="definitions.html#TERMS_SOLID">solid</a>, do
154 To set footnotes with a 1-point lead (i.e. with the line spacing
155 one point greater than the footnote's point size), do
161 <a name="CONTROL_INDENTS"><h3>Indents</h3></a>
162 Except for <strong>PARA_INDENT</strong>, the argument to the control
164 in <strong>_INDENT</strong> is always a single digit (whole numbers
165 only; no decimal fractions) with no
166 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
167 appended to it. The digit represents by how much you want the
168 size of the paragraph first-line indent multiplied to achieve the
169 correct indent for a particular tag.
171 <h3>Quad/justification style</h3>
172 Control macros that end in <strong>_QUAD</strong> take the same
174 <a href="typesetting.html#QUAD">QUAD</a>.
177 <a name="INDEX_DOCELEMENT"><h3><u>Document element tags list</u></h3></a>
179 <li><a href="#EPIGRAPH_INTRO">Epigraphs</a>
181 <li><a href="#EPIGRAPH">EPIGRAPH</a>
182 <li><a href="#EPIGRAPH_CONTROL">Epigrah control</a>
184 <li><a href="#PP_INTRO">Paragraphs</a>
186 <li><a href="#PP">PP</a>
187 <li><a href="#PP_CONTROL">Paragraph control</a>
189 <li><a href="#HEAD_INTRO">Main heads</a>
191 <li><a href="#HEAD">HEAD</a>
192 <li><a href="#HEAD_CONTROL">Head control</a>
194 <li><a href="#SUBHEAD_INTRO">Subheads</a>
196 <li><a href="#SUBHEAD">SUBHEAD</a>
197 <li><a href="#SUBHEAD_CONTROL">Subhead control</a>
199 <li><a href="#PARAHEAD_INTRO">Paragraph heads</a>
201 <li><a href="#PARAHEAD">PARAHEAD</a>
202 <li><a href="#PARAHEAD_CONTROL">Parahead control</a>
204 <li><a href="#LINEBREAK_INTRO">Linebreaks (author linebreaks)</a>
206 <li><a href="#LINEBREAK">LINEBREAK</a>
207 <li><a href="#LINEBREAK_CHAR">Linebreak character</a>
209 <li><a href="#QUOTE_INTRO">Quotes (line for line)</a>
211 <li><a href="#QUOTE">QUOTE</a>
212 <li><a href="#QUOTE_CONTROL">Quote control</a>
214 <li><a href="#BLOCKQUOTE_INTRO">Blockquotes (cited material)</a>
216 <li><a href="#BLOCKQUOTE">BLOCKQUOTE</a>
217 <li><a href="#BLOCKQUOTE_CONTROL">Blockquote control</a>
219 <li><a href="#FOOTNOTE_INTRO">Footnotes</a>
221 <li><a href="#FOOTNOTE">FOOTNOTE</a>
222 <li><a href="#FOOTNOTE_CONTROL">Footnote control</a>
224 <li><a href="#ENDNOTE_INTRO">Endnotes</a>
226 <li><a href="#ENDNOTE">ENDNOTE</a>
227 <li><a href="#ENDNOTE_CONTROL">Endnote control</a>
229 <li><a href="#FINIS_INTRO">Document termination</a>
231 <li><a href="#FINIS">FINIS</a>
232 <li><a href="#FINIS_STRING">Finis control</a> -- changing the FINIS string
238 <!====================================================================>
240 <a name="EPIGRAPH_INTRO"><h2><u>Epigraphs</u></h2></a>
242 <li><a href="#EPIGRAPH">Tag: EPIGRAPH</a>
243 <li><a href="#EPIGRAPH_CONTROL">Epigraph control macros</a>
246 <a href="definitions.html#TERMS_EPIGRAPH">Epigraphs</a>
247 color, flavour, or comment on the document they precede. Typically,
248 they are centered at the top of a document's first page (underneath the
249 title) and set in a smaller point size than that of paragraph text.
251 By default, <strong>mom</strong> sets epigraphs centered and
252 <a href="definitions.html#TERMS_NOFILL">unfilled</a>;
253 this lets you input them on a line for line basis. This behaviour
254 can be changed to accomodate
255 <a href="definitions.html#TERMS_FILLED">filled</a>
256 epigraph "blocks."
261 <hr width="66%" align="left">
264 Macro: <strong>EPIGRAPH</strong> <var><toggle> | [ BLOCK ]</var></a>
268 <strong>EPIGRAPH</strong> is a toggle, used like this:
272 <text of epigraph>
276 <strong>OFF</strong>, above, could be anything -- say, Q or X --
277 since any argument other than <strong>BLOCK</strong> turns it off.
279 If given the argument <strong>BLOCK</strong>, <strong>EPIGRAPH</strong>
281 <a href="definitions.html#TERMS_FILLED">filled</a>,
282 justified or quadded in the same direction as paragraphs, indented
283 equally from both the left and right margins.
285 If a block-style epigraph runs to more than one paragraph (unlikely,
286 but conceivable), you <strong>MUST</strong> introduce every paragraph
287 -- <u>INCLUDING THE FIRST!!!</u> -- with the
291 <strong>NOTE:</strong> <strong>EPIGRAPH</strong> should only be
292 used at the top of a document (i.e. just after
293 <a href="docprocessing.html#START">START</a>)
295 <a href="#HEAD_INTRO">heads</a>. The latter is not especially
296 recommended, but it does work. In all other places where you
297 want quotes or cited text, use
298 <a href="#QUOTE">QUOTE</a>
300 <a href="#BLOCKQUOTE">BLOCKQUOTE</a>.
302 <a name="EPIGRAPH_CONTROL"><h3><u>Epigraph control macros</u></h3></a>
305 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
308 .EPIGRAPH_FAMILY default = prevailing document family; default is Times Roman
309 .EPIGRAPH_FONT default = roman
310 .EPIGRAPH_SIZE default = -1.5 (points)
311 .EPIGRAPH_AUTOLEAD default = 2 points
313 (The next two apply to "block" style epigraphs only)
315 .EPIGRAPH_QUAD default = same as paragraphs
316 .EPIGRAPH_INDENT* default = para indent x 3 (for typeset), x 2 (for typewrite)
318 *Indent here refers to the indent from both the left and right margins
319 that centres the block style epigraph on the page.
323 <!====================================================================>
325 <a name="PP_INTRO"><h2><u>Paragraphs</u></h2></a>
327 <li><a href="#PP">Tag: PP</a>
328 <li><a href="#PP_CONTROL">Paragraph control macros</a>
331 The paragraph macro is the one you use most often. Consequently,
332 it's one of most powerful, yet simplest to use -- just the letters
333 <strong>PP</strong>. No arguments, nothing. Just <kbd>.PP</kbd>
334 on a line by itself any time, in any document element, tells
335 <strong>mom</strong> you want to start a new paragraph. The spacing
336 and indent appropriate to where you are in your document are taken
337 care of automatically.
339 By default, <strong>mom</strong> does not indent the first paragraph
340 of a document, nor paragraphs that fall imediately after
341 <a href="#HEAD_INTRO">heads</a>
343 <a href="#SUBHEAD_INTRO">subheads</a>.
344 The first paragraphs of blockquotes and block-style epigraphs are
345 also not indented. This behaviour can be changed with the control
347 <a href="#PARA_INDENT_FIRST">INDENT_FIRST_PARAS</a>.
349 In contrast to some other macro packages, <strong>mom</strong> does not
350 deposit a blank line between paragraphs. If you want her to do so, use
351 the control macro <strong>PARA_SPACE</strong>. (I don't recommend
352 using this macro with
353 <a href="typesetting.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.)
355 Note that <strong>mom</strong> does not provide "orphan
356 control" for paragraphs (i.e. even if only one line of a paragraph
357 fits at the bottom of a page, she will set it on that page). The
358 reason for this is that writers of fiction often have single-line
359 paragraphs (e.g. in dialogue). Groff's simplistic orphan control
360 will break these one-liners -- if they fall at the bottom of the page
361 -- to a new page, which is not what you want.
363 <strong>TIP:</strong> The last thing you want while you're writing
364 and editing drafts of a document (particulary stories and chapters)
365 is a text file cluttered up with <strong>PP</strong>'s. The visual
366 interruption in the flow of text is a serious obstacle to creativity
369 I use the tab key on my keyboard to indent paragraphs when I'm writing,
370 producing a text file that looks pretty much like what you see on
371 a printed page. When it comes time to format and print the file,
372 I run it through a sed script that (amongst other things) converts
373 the character generated by the tab key (<kbd>^I</kbd>) into <code>.PP</code>
374 (plus a new line), and pipe the output to groff for processing and
377 Another solution is to insert a blank line between paragraphs.
378 The blank lines can then be sedded out at print time as above, or,
379 more conveniently, you can use the <code>.blm</code>
380 <a href="definitions.html#TERMS_PRIMITIVES">primitive</a>
381 (blank line macro) to instruct groff (and <strong>mom</strong>)
382 that blank lines should be interpreted as <strong>PP</strong>'s.
387 tells groff that all blank lines are really the macro <strong>PP</strong>.
392 <hr width="66%" align="left">
395 Macro: <strong>PP</strong>
399 <strong>PP</strong> (on a line by itself, of course) tells mom to
400 start a new paragraph. See
401 <a href="#PP_INTRO">above</a>
402 for more details. In addition to regular text paragraphs, you can
403 use <strong>PP</strong> in
404 <a href="#EPIGRAPH_INTRO">epigraphs</a>,
405 <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
407 <a href="#FOOTNOTE_INTRO">footnotes</a>.
409 <a name="PP_CONTROL"><h3><u>Paragraph control macros</u></h3></a>
411 The <strong>PP</strong> being so important, and representing, as
412 it were, the basis of everything that goes on in a document, its
413 control is managed in a manner somewhat different from other document
417 <li><a href="#PP_FAMILY">Family control</a>
418 <li><a href="#PP_FONT">Font control</a>
419 <li><a href="#PP_LEADING">Leading/linespacing control</a>
420 <li><a href="#PP_JUST_QUAD">Justification/quad control</a>
421 <li><a href="#PARA_INDENT">First-line indent control</a>
422 <li><a href="#PARA_INDENT_FIRST">Intitial paragraphs indent control</a>
423 <li><a href="#PP_SPACE">Paragraph spacing control</a>
426 <a name="PP_FAMILY"><h3><u>1. Family</u></h3></a>
428 <a href="definitions.html#TERMS_FAMILY">family</a>
430 <a href="typesetting.html#FAMILY">FAMILY</a>
432 <a href="docprocessing.html#START">START</a>,
434 <a href="docprocessing.html#DOC_FAMILY">DOC_FAMILY</a>
435 afterwards. Please note that both globally affect the family of
436 every element in the document.
438 If you wish to change the family for regular
439 text paragraphs only, invoke <strong>FAMILY</strong> immediately
440 after <strong>PP</strong> in EVERY paragraph whose family you wish
441 to differ from the prevailing document family.
443 <strong>Mom</strong>'s default paragraph (and document) family
446 <a name="PP_FONT"><h3><u>2. Font -- PP_FONT</u></h3></a>
448 <a href="definitions.html#TERMS_FONT">font</a>
449 used in regular text paragraphs, use <code>.PP_FONT</code>,
450 which takes the same argument as
451 <a href="typesetting.html#FONT">FT</a>.
452 <strong>PP_FONT</strong> may be used before or after
453 <a href="docprocessing.html#START">START</a>.
454 Only regular text paragraphs are affected; paragraphs in
455 <a href="#EPIGRAPH_INTRO">epigraphs</a>,
456 <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
458 <a href="#FOOTNOTE_INTRO">footnotes</a>
459 remain at their default setting (medium roman) unless you change them
460 with the appropriate control macros.
462 <strong>Mom</strong>'s default paragraph font is medium roman.
464 <a name="PP_LEADING"><h3><u>3.Leading</u></h3></a>
466 <a href="definitions.html#TERMS_LEADING">leading</a>
468 <a href="typesetting.html#LEADING">LS</a>
470 <a href="docprocessing.html#START">START</a>,
472 <a href="docprocessing.html#DOC_LEAD">DOC_LEAD</a>
473 afterwards. Please note that either method globally affects the
474 leading and spacing of every document element (except
475 <a href="definitions.html#TERMS_HEADER">headers</a>
477 <a href="definitions.html#TERMS_FOOTER">footers</a>).
479 If you wish to change the leading of regular text paragraphs only,
480 invoke <strong>LS</strong> immediately after <strong>PP</strong> in
481 EVERY paragraph whose leading you wish to change.
483 <strong>HYPER-IMPORTANT NOTE:</strong> It is extremely unwise to change
484 paragraph leading with <strong>LS</strong>, as it will, in all cases,
485 screw up <strong>mom</strong>'s ability to balance the bottom margin
488 <strong>Mom</strong>'s default paragraph leading (document leading)
489 is 16 points, adjusted to fill the page.
491 <a name="PP_JUST_QUAD"><h3><u>4. Justification/quad</u></h3></a>
492 The justification/quad-direction of regular text paragraphs (i.e.
493 <a href="definitions.html#TERMS_JUST">justified</a>,
495 <a href="definitions.html#TERMS_FILLED">filled</a>
497 <a href="definitions.html#TERMS_QUAD">quadded</a>
498 left/right/center) is set with
499 <a href="typesetting.html#JUSTIFY">JUSTIFY</a>
501 <a href="typesetting.html#QUAD">QUAD</a>
503 <a href="docprocessing.html#START">START</a>,
505 <a href="docprocessing.html#DOC_QUAD">DOC_QUAD</a>
508 Please note that either method of setting the paragraph
509 justification/quad-direction also affects
510 <a href="#EPIGRAPH_INTRO">epigraphs</a>
512 <a href="#FOOTNOTE_INTRO">footnotes</a>,
514 <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
515 (whose default is QUAD LEFT unless you change it with
516 <a href="#BLOCKQUOTE">BLOCKQUOTE_QUAD</a>).
517 The justification/quad-direction of epigraphs and footnotes may
518 be changed with their own control macros.
520 If you wish to change the justification/quad-direction of
521 individual paragraphs, use <strong>JUSTIFY</strong> or
522 <strong>QUAD</strong> immediately after <strong>PP</strong>.
523 Only the paragraph in question gets justified or quadded
524 differently; subsequent paragraphs remain unaffected.
526 <strong>Mom</strong>'s default justification/quad-direction for
527 paragraphs is justified for
528 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
530 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>.
532 <a name="PARA_INDENT"><h3><u>5. First-line indent -- PARA_INDENT</u></h3></a>
533 The first-line indent of paragraphs is controlled by
534 <strong>PARA_INDENT</strong>, which takes one argument: the size
535 of the indent. <strong>PARA_INDENT</strong> may be used before
537 <a href="docprocessing.html#START">START</a>.
539 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
540 is required; fractional sizes are allowed. Thus, to set the paragraph
542 <a href="definitions.html#TERMS_EM">ems</a>, do
548 In addition to establishing the basic first line-indent of
549 paragraphs, <strong>PARA_INDENT</strong> also affects
550 <a href="#EPIGRAPH_INTRO">epigraphs</a>,
551 <a href="#QUOTE_INTRO">quotes</a>
553 <a href="#BLOCKQUOTE_INTRO">blockquotes</a>,
554 whose overal indenting from the left and (where applicable) right
555 margins is relative to <strong>PARA_INDENT</strong>. Furthermore, the
556 first-line indent of paragraphs within these document elements (as well
557 as footnotes) is also relative to <strong>PARA_INDENT</strong> (always
558 1/2 of <strong>PARA_INDENT)</strong>), hence they are also affected.
560 <strong>Mom</strong>'s default <strong>PARA_INDENT</strong> is 2
562 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
563 and 3 picas (1/2 inch) for
564 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>.
566 <a name="PARA_INDENT_FIRST"><h3><u>6. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a>
567 By default, <strong>mom</strong> does not indent the first paragraph
568 of a document, nor the first paragraph after a head or
569 subhead, nor the first paragraphs of
570 <a href="#EPIGRAPH_INTRO">epigraphs</a>,
571 <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
573 <a href="#FOOTNOTE_INTRO">footnotes</a>
574 that run to more than one paragraph.
575 <a name="INDENT_FIRST_PARAS"></a>
577 If you wish to have first paragraphs indented, invoke the macro
578 <strong>.INDENT_FIRST_PARAS</strong> with no argument, either
580 <a href="docprocessing.html#START">START</a>.
581 <strong>INDENT_FIRST_PARAS</strong> is a toggle macro, therefore
582 passing it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels
583 its effect, meaning that first paragraphs will once again NOT be
586 <a name="PP_SPACE"><h3><u>7. Spacing paragraphs -- PARA_SPACE</u></h3></a>
587 By default, <strong>mom</strong> does not insert a blank line
588 between paragraphs. If you would like her to do so, invoke the
589 macro <code>.PARA_SPACE</code> with no argument, either
591 <a href="docprocessing.html#START">START</a>.
592 <strong>PARA_SPACE</strong> is a toggle macro, therefore passing
593 it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels its
594 effect, meaning that paragraphs will once again NOT be separated by
599 <!====================================================================>
601 <a name="HEAD_INTRO"><h2><u>Main heads</u></h2></a>
603 <li><a href="#HEAD">Tag: HEAD</a>
604 <li><a href="#HEAD_CONTROL">Head control macros</a>
607 Main heads -- or, in this documentation, just "heads"
608 -- should be used any place you want titles to introduce major
609 sections of a document. If you wish, <strong>mom</strong> can number
610 your heads for you. Head numbers can also be included
611 hierarchically in numbered
612 <a href="#SUBHEAD_INTRO">subheads</a>
614 <a href="#PARAHEAD_INTRO">paraheads</a>.
616 By default, heads are centered on the page, underlined,
617 all in caps. A double linespace precedes each head. In <a
618 href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, heads
619 are bold, slightly larger than paragraph text.
621 If these defaults don't suit you, you can change them with the
627 <hr width="66%" align="left">
630 Macro: <strong>HEAD</strong> <var>"<text of head>" [ "<2nd line>" [ "<3rd line>" ... ] ]</var>
634 The argument to <strong>HEAD</strong> is the text of the head,
635 surrounded by double-quotes. If you need additional lines for a
636 head, simply surround each line with double-quotes.
638 <strong>NOTE:</strong> If a head falls near the bottom of an output page
639 and <strong>mom</strong> is unable to fit the head <em>plus at least
640 one line of text underneath it</em>, she will set the head at the
641 top of the next page.
643 <a name="HEAD_CONTROL"><h3><u>Head control macros</u></h3></a>
645 There are, in addition to the usual family/font/size/quad control
646 macros, a number of macros to manage head numbering, spacing,
647 underlining, and so on. Check them out if you're unhappy with
648 <strong>mom</strong>'s defaults.
651 <li><a href="#HEAD_GENERAL">Family/font/size/quad</a>
652 <li><a href="#HEAD_CAPS">Caps</a>
653 <li><a href="#HEAD_SPACE">Pre-head space</a>
654 <li><a href="#HEAD_UNDERLINE">Underlining</a>
655 <li><a href="#NUMBER_HEADS">Numbering</a>
656 <li><a href="#RESET_HEAD_NUMBER">Reset head numbering</a>
657 <li><a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>
660 <a name="HEAD_GENERAL"><h3><u>1. Family/font/size/quad</u></h3></a>
663 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
666 .HEAD_FAMILY default = prevailing document family; default is Times Roman
667 .HEAD_FONT default = bold
668 .HEAD_SIZE default = +1 (point)
669 .HEAD_QUAD default = CENTER
672 <a name="HEAD_CAPS"><h3><u>2. Capitalizing heads -- HEAD_CAPS</u></h3></a>
673 By default, <strong>mom</strong> sets heads in caps, regardless
675 <a href="definitions.html#TERMS_STRINGARGUMENT">string(s)</a>
677 <a href="#HEAD">HEAD</a>.
678 To change this behaviour, do
684 <strong>HEAD_CAPS</strong> is a toggle macro, therefore you can use
685 any argument you like instead of <strong>OFF</strong> (<strong>END,
686 QUIT, Q, X</strong>...). To turn <strong>HEAD_CAPS</strong> back on,
687 simply invoke it without an argument.
689 <a name="HEAD_SPACE"><h3><u>3. Space before heads -- HEAD_SPACE</u></h3></a>
690 By default, <strong>mom</strong> deposits 2 blank lines prior to every
691 head. If you'd prefer just a single blank line, do
697 <strong>HEAD_SPACE</strong> is a toggle macro, therefore you can use
698 any argument you like instead of <strong>OFF</strong> (<strong>END,
699 QUIT, Q, X</strong>...). To restore the space before heads to 2
700 blank lines, invoke <strong>HEAD_SPACE</strong> without an argument.
702 <a name="HEAD_UNDERLINE"><h3><u>4. Underlining heads -- HEAD_UNDERLINE</u></h3></a>
703 By default, <strong>mom</strong> underlines heads. To change this
710 <strong>HEAD_UNDERLINE</strong> is a toggle macro, therefore you can
711 use any argument you like instead of <strong>OFF</strong> (<strong>END,
712 QUIT, Q, X</strong>...). To restore underlining of heads, invoke
713 <strong>HEAD_UNDERLINE</strong> without an argument.
715 <a name="NUMBER_HEADS"><h3><u>5. Number heads -- NUMBER_HEADS</u></h3></a>
716 If you'd like your heads numbered, simply invoke
717 <strong>NUMBER_HEADS</strong> with no argument. <strong>Mom</strong>
718 will number all subsequent heads automatically (in ascending order,
721 If, in addition to numbering heads, you also request that
722 <a href="#SUBHEAD_INTRO">subheads</a>
724 <a href="#PARAHEAD_INTRO">paraheads</a>
725 be numbered, the head number will be included in their numbers
726 (each number separated by a period [dot]).
728 Should you wish to stop head numbering, invoke
729 <strong>NUMBER_HEADS</strong> with any argument (<strong>OFF, QUIT,
730 END, X</strong>...). Head numbering will cease, and the head number
731 will not be included in the numbering of subheads and/or paraheads.
733 <a name="RESET_HEAD_NUMBER"><h3><u>6. Reset head numbering -- RESET_HEAD_NUMBER</u></h3></a>
734 Should you wish to reset the head number to "1", invoke
735 <strong>RESET_HEAD_NUMBER</strong> with no argument. If, for some
736 reason, you want <strong>mom</strong> to use a head number that is not
737 the next in ascending order (i.e. the last head number + 1), invoke
738 <strong>RESET_HEAD_NUMBER</strong> with the number you want, e.g.
744 Your next head will be numbered "6" and subsequent heads will
745 be numbered in ascending order from "6".
747 <a name="HEAD_INLINES"><h3><u>7. Vertical inline escapes inside heads</u></h3></a>
748 If you need to adjust the
749 <a href="definitions.html#TERMS_BASELINE">baseline</a>
750 position of a head (e.g. the head falls at the top of a column and
752 <a href="definitions.html#TERMS_ASCENDER">ascenders</a>
753 to line up with the ascenders of
754 <a href="definitions.html#TERMS_RUNNING">running text</a>
755 in other columns), you can embed a vertical motion
756 <a href="definitions.html#TERMS_INLINES">inline escape</a>
758 <a href="inlines.html#INLINE_VERTICAL_MOM">mom's</a>
760 <a href="inlines.html#INLINE_VERTICAL_GROFF">groff's</a>
761 in the string(s) you pass to <strong>HEAD</strong>
766 .HEAD "\[ALD3]Text of head
769 will lower the baseline of the head by three points. Note that
770 there's no need to reverse the sense of the inline escape.
772 In the case of heads that run to more than one line, you must embed
773 the escape in the string for each line, like this:
776 .HEAD "\[ALD3]First line" "\[ALD3]Next line"
785 <!====================================================================>
787 <a name="SUBHEAD_INTRO"><h2><u>Subheads</u></h2></a>
789 <li><a href="#SUBHEAD">Tag: SUBHEAD</a>
790 <li><a href="#SUBHEAD_CONTROL">Subhead control macros</a>
793 Subheads should be used any place you want titles to introduce
794 sections of a document below heads. If you wish, <strong>mom</strong>
795 can number subheads for you. Subhead numbers can also be included
796 hierarchically in numbered
797 <a href="#PARAHEAD_INTRO">paraheads</a>.
799 By default, subheads are flush left. In
800 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
801 they are set bold, slightly larger than paragraph text. In
802 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
803 they are underlined. A single linespace precedes them in both
804 printstyles, and a tiny space adjustment raises them slightly
805 above text that comes afterwards for greater clarity in
806 document structuring.
808 If these defaults don't suit you, you can change them with the
809 subhead control macros.
814 <hr width="66%" align="left">
817 Macro: <strong>SUBHEAD</strong> <var>"<text of subhead>" [ "<2nd line>" [ "<3rd line>" ... ] ]</var>
820 The argument to <strong>SUBHEAD</strong> is the text of the subhead,
821 surrounded by double-quotes. If you need additional lines for a
822 subhead, simply surround each line with double-quotes.
824 <strong>NOTE:</strong> If a subhead falls near the bottom of an output
825 page and <strong>mom</strong> is unable to fit the head <em>plus at
826 least one line of text underneath it</em>, she will set the subhead
827 at the top of the next page.
829 <a name="SUBHEAD_CONTROL"><h3><u>Subhead control macros</u></h3></a>
831 In addition to the usual family/font/size/quad control
832 macros, there are macros to manage subhead numbering.
835 <li><a href="#SUBHEAD_GENERAL">Family/font/size/quad</a>
836 <li><a href="#NUMBER_SUBHEADS">Numbering</a>
837 <li><a href="#RESET_SUBHEAD_NUMBER">Reset subhead numbering</a>
838 <li><a href="#SUBHEAD_INLINES">Vertical inline escapes inside subheads</a>
841 <a name="SUBHEAD_GENERAL"><h3><u>1. Family/font/size/quad</u></h3></a>
844 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
847 .SUBHEAD_FAMILY default = prevailing document family; default is Times Roman
848 .SUBHEAD_FONT default = bold
849 .SUBHEAD_SIZE default = +.5 (point)
850 .SUBHEAD_QUAD default = LEFT
853 <a name="NUMBER_SUBHEADS"><h3><u>2. Number subheads -- NUMBER_SUBHEADS</u></h3></a>
854 If you'd like your subheads numbered, simply invoke
855 <strong>.NUMBER_SUBHEADS</strong> with no argument.
856 <strong>Mom</strong> will number all subsequent subheads automatically
857 (in ascending order, naturally).
859 If, in addition to numbering subheads, you also request that
860 <a href="#HEAD_INTRO">heads</a>
861 be numbered, the head number will be included in the subhead number
862 (separated by a period [dot]).
864 Should you wish to stop subhead numbering, invoke
865 <strong>NUMBER_SUBHEADS</strong> with any argument (<strong>OFF, QUIT,
866 END, X</strong>...). Subhead numbering will cease, and the subhead
867 number will not be included in the numbering of paraheads.
869 <a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a>
870 Should you wish to reset the subhead number to "1", invoke
871 <strong>RESET_SUBHEAD_NUMBER</strong> with no argument. If, for some
872 reason, you want <strong>mom</strong> to use a subhead number that is not
873 the next in ascending order (i.e. the last subhead number + 1), invoke
874 <strong>RESET_SUBHEAD_NUMBER</strong> with the number you want, e.g.
877 .RESET_SUBHEAD_NUMBER 4
880 Your next subhead will be numbered "4" and subsequent
881 subheads will be numbered in ascending order from "4".
883 <a name="#SUBHEAD_INLINES"><h3><u>Vertical inline escapes inside subheads</u></h3></a>
885 <a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>.
886 The information there applies equally to subheads.
892 <!====================================================================>
894 <a name="PARAHEAD_INTRO"><h2><u>Paragraph heads</u></h2></a>
896 <li><a href="#PARAHEAD">Tag: PARAHEAD</a>
897 <li><a href="#PARAHEAD_CONTROL">Parahead control macros</a>
900 Paragraph heads (paraheads) should be used any place you want titles
901 to introduce paragraphs below heads or subheads. If you wish,
902 <strong>mom</strong> can number paraheads for you.
904 By default, paraheads are joined to the body of a paragraph,
905 slightly indented (provided the paragraph is not a
906 "first" paragraph as defined in
907 <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>).
909 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
910 they are set bold italic, slightly larger than paragraph text. In
911 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
914 If these defaults don't suit you, you can change them with the
915 parahead control macros.
920 <hr width="66%" align="left">
923 Macro: <strong>PARAHEAD</strong> <var>"<text of parahead>"</var>
926 <strong>PARAHEAD</strong> must come AFTER
930 The argument is the text of the parahead, surrounded by double-quotes.
931 Because paraheads are joined to the body of a paragraph, they accept
932 only one argument (see
933 <a href="#HEAD">HEAD</a>
935 <a href="#SUBHEAD">SUBHEAD</a>).
937 <a name="PARAHEAD_CONTROL"><h3><u>Parahead control macros</u></h3></a>
939 In addition to the family/font/size/indent control macros, there are
940 macros to manage parahead numbering.
943 <li><a href="#PARAHEAD_GENERAL">Family/font/size</a>
944 <li><a href="#PARAHEAD_INDENT">Indent</a>
945 <li><a href="#NUMBER_PARAHEADS">Numbering</a>
946 <li><a href="#RESET_PARAHEAD_NUMBER">Reset parahead numbering</a>
949 <a name="PARAHEAD_GENERAL"><h3><u>1. Family/font/size</u></h3></a>
952 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
955 .PARAHEAD_FAMILY default = prevailing document family; default is Times Roman
956 .PARAHEAD_FONT default = bold italic
957 .PARAHEAD_SIZE default = +.5 (point)
960 <a name="PARAHEAD_INDENT"><h3><u>2. Indent</u></h3></a>
961 Unlike other control macros that end in
962 <a href="#CONTROL_INDENTS"><strong>_INDENT</strong></a>,
963 the argument to the macro that controls indenting of paragraph heads
964 (<strong>PARAHEAD_INDENT</strong>) is NOT relative to the first-line
965 indent of normal paragraphs. In other words, it takes an absolute
966 value, and requires a
967 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
968 For example, to set the paragraph head indent to 2-1/2 picas, you
972 .PARAHEAD_INDENT 2.5P
974 <strong>Mom</strong>'s default indent for paragraph heads is 1/2
975 the first-line indent of normal paragraphs (both printstyles).
976 However, as stated above, if you choose to change the indent, you
977 must give an absolute value (unless you're a groff expert and want
978 to manipulate the number register <code>\n[#PP_INDENT]u</code>
979 arithmetically as the argument to <strong>PARAHEAD_INDENT</strong>
980 for an indent that's relative to <strong>PP_INDENT</strong>.)
982 <strong>NOTE:</strong> Paragraph heads in "first
983 paragraphs", as defined in
984 <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>,
985 are not indented unless you turn
986 <a href="#INDENT_FIRST_PARAS">INDENT_FIRST_PARAS</a>
989 <a name="NUMBER_PARAHEADS"><h3><u>3. Number paraheads -- NUMBER_PARAHEADS</u></h3></a>
990 If you'd like your paraheads numbered, simply invoke
991 <strong>.NUMBER_PARAHEADS</strong> with no argument.
992 <strong>Mom</strong> will number all subsequent paraheads automatically
993 (in ascending order, naturally).
995 If, in addition to numbering paraheads, you also request that
996 <a href="#HEAD_INTRO">heads</a>
998 <a href="#SUBHEAD_INTRO">subheads</a>
999 be numbered, the head and/or subhead number will be included in the
1000 parahead number (separated by a period [dot]).
1002 Should you wish to stop parahead numbering, invoke
1003 <strong>NUMBER_PARAHEADS</strong> with any argument (<strong>OFF,
1004 QUIT, END, X</strong>...). Parahead numbering will cease.
1006 <a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a>
1007 Should you wish to reset the parahead number to "1", invoke
1008 <strong>RESET_PARAHEAD_NUMBER</strong> with no argument. If, for some
1009 reason, you want <strong>mom</strong> to use a parahead number that is not
1010 the next in ascending order (i.e. the last parahead number + 1), invoke
1011 <strong>RESET_PARAHEAD_NUMBER</strong> with the number you want, e.g.
1014 .RESET_PARAHEAD_NUMBER 7
1017 Your next parahead will be numbered "7" and subsequent
1018 paraheads will be numbered in ascending order from "7".
1022 <!====================================================================>
1024 <a name="LINEBREAK_INTRO"><h2><u>Author linebreaks</u></h2></a>
1026 <li><a href="#LINEBREAK">Tag: LINEBREAK</a>
1027 <li><a href="#LINEBREAK_CHAR">Linebreak character control macro</a>
1030 By default, <strong>mom</strong> marks
1031 <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>
1032 with three centered asterisks. You can change this behaviour
1033 with the linebreak character
1034 <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>.
1039 <hr width="66%" align="left">
1041 <a name="LINEBREAK">
1042 Macro: <strong>LINEBREAK</strong>
1046 <strong>LINEBREAK</strong> takes no arguments. Simply invoke it
1047 (on a line by itself, of course) whenever you want to insert an
1048 author linebreak. The appearance of the linebreak is controlled
1050 <a href="#LINEBREAK_CHAR">LINEBREAK_CHAR</a>
1053 <h3><u>Linebreak character control macro</u></h3>
1055 <a name="LINEBREAK_CHAR">
1056 Macro: <strong>LINEBREAK_CHAR</strong> <var>[ <character> ] [ <iterations> [ <vertical adjustment> ] ]</var>
1059 <em>*The third optional argument requires a
1060 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>.
1063 <strong>LINEBREAK_CHAR</strong> determines what <strong>mom</strong>
1064 prints when <strong>LINEBREAK</strong> is invoked. It takes 3
1065 optional arguments: the character you want deposited at the line
1066 break, the number of times you want the character repeated, and a
1067 vertical adjustment factor.
1069 The first argument is any legal groff character (e.g. <kbd>*</kbd>
1070 [an asterisk], <kbd>\(dg</kbd> [a dagger], <kbd>\f(ZD\N'141\fP</kbd>
1071 [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd>
1072 [a 4-pica long rule]). <strong>Mom</strong> sets the character
1073 centered on the current line length.
1075 The second argument is the number of times to repeat the character.
1077 The third argument is a +|- value by which to raise (+) or lower (-)
1078 the character in order to make it appear visually centered between
1079 sections of text. This lets you make vertical adjustments
1080 to characters that don't sit on the
1081 <a href="definitions.html#TERMS_BASELINE">baseline</a>
1082 (such as asterisks). The argument must be preceded by a plus or
1083 minus sign, and must include a unit of measure.
1085 If you enter <strong>LINEBREAK_CHAR</strong> with no arguments,
1086 sections of text will be separated by two blank lines when you invoke
1087 <strong>LINEBREAK</strong>.
1089 <strong>Mom</strong>'s default for <strong>LINEBREAK_CHAR</strong> is
1092 .LINEBREAK_CHAR * 3 -3p
1095 i.e. three asterisks, lowered 3 points from their normal vertical
1097 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
1098 the vertical adjustment is -2 points for
1099 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>).
1103 <!====================================================================>
1105 <a name="QUOTE_INTRO"><h2><u>Quotes (line for line)</u></h2></a>
1107 <li><a href="#QUOTE">Tag: QUOTE</a>
1108 <li><a href="#QUOTE_CONTROL">Quote control macros</a>
1111 <a href="definitions.html#TERMS_QUOTE">Quotes</a>
1113 <a href="definitions.html#TERMS_NOFILL">nofill mode</a>,
1114 flush left. This permits entering quotes on a line for line basis in
1115 your text editor and have them come out the same way on output copy.
1117 <a href="#BLOCKQUOTE_INTRO">Blockquotes</a>
1118 for how quotes, in the present sense, differ from longer
1119 passages of cited text.)
1121 Since <strong>mom</strong> originally came into being to serve
1122 the needs of creative writers (i.e. novelists, short story
1123 writers, etc. -- not to cast aspersions on the creativity of
1124 mathematicians and programmers), she sets quotes in italics
1125 <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET)</a>
1127 <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPEWRITE)</a>,
1128 indented from the left margin. Obviously, she's thinking
1129 "quotes from poetry or song lyrics", but with the
1130 quote control macros you can change her defaults so
1131 <strong>QUOTE</strong> serves other needs, e.g. entering snippets of
1132 programming code, command line instructions, and so on.
1134 <a name="QUOTE_SPACING"></a>
1135 Besides indenting quotes, <strong>mom</strong> further sets them
1137 <a href="definitions.html#TERMS_RUNNING">running text</a>
1138 with a small amount of vertical whitespace top and bottom. In
1139 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
1140 this is always one full linespace. In
1141 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
1142 it's 1/2 of the prevailing
1143 <a href="definitions.html#TERMS_LEADING">leading</a>
1144 if the quote fits fully on the page (i.e. with running text above
1145 and below it), otherwise it's a full linespace either above or below
1146 as is necessary to balance the page to the bottom margin. This
1147 behaviour can be changed with the control macro
1148 <a href="#ALWAYS_FULLSPACE_QUOTES">ALWAYS_FULLSPACE_QUOTES</a>.
1150 <strong>NOTE:</strong> <strong>ALWAYS_FULLSPACE_QUOTES</strong>
1152 <a href="#QUOTE">QUOTE</a>
1154 <a href="#BLOCKQUOTE">BLOCKQUOTE</a>,
1155 as does the control macro
1156 <a href="#QUOTE_INDENT">QUOTE_INDENT</a>.
1161 <hr width="66%" align="left">
1164 Macro: <strong>QUOTE</strong> <var>toggle</var>
1168 <strong>QUOTE</strong> is a toggle macro. To begin a section of
1169 quoted text, invoke it with no argument, then type in your quote.
1170 When you're finished, invoke <strong>QUOTE</strong> with any
1171 argument (e.g. OFF, END, X, Q...) to turn it off. Example:
1176 Used a dynamite stick for a thrill
1177 They found her vagina
1179 And bits of her tits in Brazil.
1183 <a name="QUOTE_CONTROL"><h3><u>Quote control macros</u></h3></a>
1185 <li><a href="#QUOTE_GENERAL">Family/font/size/indent</a>
1186 <li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a>
1187 <li><a href="#UNDERLINE_QUOTES">Underline quotes (typewrite only)</a>
1188 <li><a href="#BREAK_QUOTE">Manually break a footnoted quote that crosses pages/columns</a>
1191 <a name="QUOTE_GENERAL"><h3><u>1. Family/font/size/indent</u></h3></a>
1194 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
1197 .QUOTE_FAMILY default = prevailing document family; default is Times Roman
1198 .QUOTE_FONT default = italic
1199 .QUOTE_SIZE default = 0 (i.e. same size as paragraph text)
1200 <a name="QUOTE_INDENT">.QUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
1201 (note that this macro also sets the indents (left and right)
1205 <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
1206 If you'd like <strong>mom</strong> always to put a full linespace above
1207 and below quotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
1208 with no argument. If you wish to restore <strong>mom</strong>'s
1209 default behaviour regarding the spacing of quotes (see
1210 <a href="#QUOTE_SPACING">above</a>),
1211 invoke the macro with any argument (<strong>OFF, QUIT, END,
1214 <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
1216 <a href="#BLOCKQUOTE_INTRO">blockquotes</a>.
1218 <a name="UNDERLINE_QUOTES"><h3><u>3. Underlining -- UNDERLINE_QUOTES (typewrite only)</u></h3></a>
1220 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
1221 <strong>mom</strong> underlines quotes. If you'd rather she didn't,
1222 invoke <strong>.UNDERLINE_QUOTES</strong> with any argument
1223 (<strong>OFF, QUIT, END, X</strong>...) to disable the feature.
1224 Invoke it without an argument to restore <strong>mom</strong>'s
1225 default underlining of quotes.
1227 If you not only wish that <strong>mom</strong> not underline
1228 quotes, but also that she set them in italic, you must follow each
1229 instance of <strong>QUOTE</strong> with the typesetting macro <a
1230 href="typesetting.html#FONT">FT I</a>.
1231 Furthermore, since <strong>mom</strong> underlines all instances
1232 of italics by default in <strong>PRINTSTYLE TYPEWRITE</strong>,
1233 you must also make sure that <strong>ITALIC_MEANS_ITALIC</strong>
1235 <a href="docprocessing.html#TYPEWRITE_CONTROL">PRINTSTYLE TYPEWRITE control macros</a>).
1237 <a name="BREAK_QUOTE"><h3><u>4. Manually break a footnoted quote -- BREAK_QUOTE</u></h3></a>
1238 Exceptionally, a quote or blockquote containing a footnote may cross
1239 a page or column. When this happens, the footnote marker may not be
1240 correct for its position relative to other footnotes on the page, and
1241 the footnote itself may appear on the wrong page or at the bottom of
1242 the wrong column. When this happens, study your output to determine
1243 the precise point at which the quote breaks (or at which you want
1244 it to break), and add <code>.BREAK_QUOTE</code> on a line by itself
1245 afterwards. No other intervention is required, and the footnote(s)
1246 will be marked correctly and appear on the correct page.
1248 <strong>BREAK_QUOTE</strong> may be used with both quotes and
1249 blockquotes, and hence is aliased as <strong>BREAK_BLOCKQUOTE,
1250 BREAK_CITATION</strong> and <strong>BREAK_CITE</strong>.
1254 <!====================================================================>
1256 <a name="BLOCKQUOTE_INTRO"><h2><u>Blockquotes (cited passages)</u></h2></a>
1258 <li><a href="#BLOCKQUOTE">Tag: BLOCKQUOTE (aliases: CITE, CITATION)</a>
1259 <li><a href="#BLOCKQUOTE_CONTROL">BLOCKQUOTE control macros</a>
1262 <strong>BLOCKQUOTES</strong> are used to cite passages from another
1263 author's work. So that they stand out well from
1264 <a href="definitions.html#TERMS_RUNNING">running text</a>,
1265 <strong>mom</strong> indents them from both the left and right margins
1266 and sets them in a different point size
1267 <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET</a>
1269 <a href="definitions.html#TERMS_OUTPUTLINE">Output lines</a>
1271 <a href="definitions.html#TERMS_FILLED">filled</a>,
1273 <a href="definitions.html#TERMS_QUAD">quadded</a>
1276 Besides indenting blockquotes, <strong>mom</strong> further sets them
1277 off from running text with a small amount of vertical whitespace top
1279 <a href="#QUOTE_SPACING">above</a>
1280 for a complete explanation of how this is managed, and how to control it.)
1282 You may notice that <strong>BLOCKQUOTE</strong> has no macro to
1284 <a href="definitions.html#TERMS_LEADING">leading</a>,
1285 although you can change the point size. There are Very Good
1286 Reasons for this. If you can't live with the limitation, change
1287 the leading of blockquotes (after invoking the tag) with
1288 <a href="typesetting.html#LS">LS</a>,
1289 but know that there will be Bottom Margin Consequences.
1294 <hr width="66%" align="left">
1296 <a name="BLOCKQUOTE">
1297 Macro: <strong>BLOCKQUOTE</strong> <var>toggle</var>
1299 Aliases: <strong>CITE, CITATION</strong>
1303 <strong>BLOCKQUOTE</strong> is a toggle macro. To begin a
1304 cited passage, invoke the tag with no argument, then type in your quote.
1305 When you're finished, invoke <strong>BLOCKQUOTE</strong> with any
1306 argument (e.g. OFF, END, X, Q...) to turn it off. Example:
1310 Redefining the role of the United States from enablers to keep
1311 the peace to enablers to keep the peace from peacekeepers is
1312 going to be an assignment.
1318 If the cited passage runs to more than one paragraph, you MUST
1319 introduce each paragraph -- <em>including the first!</em> --
1321 <a href="#PP">PP</a>.
1323 <strong>NOTE:</strong> The aliases <strong>CITE</strong>
1324 and <strong>CITATION</strong> may be used in place of the
1325 <strong>BLOCKQUOTE</strong> tag, but "CITE" and
1326 "CITATION" must not be used to replace "BLOCKQUOTE"
1327 in any of the tag's control macros.
1329 <a name="BLOCKQUOTE_CONTROL"><h3><u>Blockquote control macros</u></h3></a>
1331 <li><a href="#BLOCKQUOTE_GENERAL">Family/font/size/indent</a>
1332 <li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a>
1333 <li><a href="#BREAK_QUOTE">Manually break a footnoted blockquote that crosses pages/columns</a>
1336 <a name="BLOCKQUOTE_GENERAL"><h3><u>1. Family/font/size/indent</u></h3></a>
1339 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
1342 .BLOCKQUOTE_FAMILY default = prevailing document family; default is Times Roman
1343 .BLOCKQUOTE_FONT default = italic
1344 .BLOCKQUOTE_SIZE default = -1 (point)
1345 .QUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
1346 (note that this macro also sets the left indent for quotes)
1349 <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
1350 If you'd like <strong>mom</strong> always to put a full linespace above
1351 and below blockquotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
1352 with no argument. If you wish to restore <strong>mom</strong>'s
1353 default behaviour regarding the spacing of blockquotes (see
1354 <a href="#QUOTE_SPACING">above</a>),
1355 invoke the macro with any argument (<strong>OFF, QUIT, END,
1358 <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
1360 <a href="#QUOTE_INTRO">quotes</a>.
1364 <!====================================================================>
1366 <a name="FOOTNOTE_INTRO"><h2><u>Footnotes</u></h2></a>
1368 <li><a href="#FOOTNOTE_BEHAVIOUR">Footnote behaviour</a>
1369 <li><a href="#FOOTNOTE">Tag: FOOTNOTE</a>
1370 <li><a href="#FOOTNOTE_CONTROL">FOOTNOTE control macros</a>
1374 For something so complex behind the scenes, footnotes are easy to use.
1375 You just type, for example
1377 <a name="FOOTNOTE_EXAMPLE"></a>
1379 ...the doctrines of Identity as urged by Schelling\c
1381 <footnote about who the hell is Schelling>
1383 were generally the points of discussion presenting the most
1384 of beauty to the imaginative Morella.
1387 and be done with it. (Note the obligatory use of the
1389 <a href="definitions.html#TERMS_INLINES">inline escape</a>.)
1390 <strong>Mom</strong> takes care of everything:
1391 putting footnote markers in the body of the document, keeping track
1392 of how many footnotes are on the page, identifying the footnotes
1393 themeselves appropriately, balancing them properly with the botton
1394 margin, deferring footnotes that don't fit on the page... Even if
1396 <a href="columns.html#COLUMNS">COLUMNS</a>,
1397 <strong>mom</strong> knows what to do, and Does The Right Thing.
1399 Footnotes can be sly little beasts, though. If you're writing a
1400 document that's footnote-heavy, you might want to read the following.
1402 <a name="FOOTNOTE_BEHAVIOUR"><h3><u>Footnote behaviour</u></h3></a>
1404 By default, <strong>mom</strong> marks footnotes with
1405 alternating stars (asterisks) and daggers. The first footnote
1406 gets a star, the second a dagger, the third two stars,
1407 the fourth two daggers, etc. If you prefer numbered footnotes, rest
1408 assured <strong>mom</strong> is happy to oblige.
1410 A small amount of vertical whitespace and a short horizontal rule
1411 separate footnotes from the document body. The amount of whitespace
1412 varies slightly from page to page depending on the number of lines
1413 in the footnotes. <strong>Mom</strong> tries for a nice balance
1414 between too little whitespace and too much, but when push comes to
1415 shove, she'll opt for ample over cramped. The last lines of footnotes
1416 are always flush with the document's bottom margin.
1418 If <strong>mom</strong> sees that a portion of a footnote cannot
1419 be fit on its page, she carries that portion over to the next
1420 page. If an entire footnote can't be fitted on its page (i.e.
1421 <strong>FOOTNOTE</strong> has been called too close to the bottom),
1422 she defers the footnote to the next page, but sets it with the
1423 appropriate marker from the previous page.
1425 In the unfortunate happenstance that a deferred footnote is the
1426 only footnote on its page (i.e. it's marked in the document body with
1427 a star) and the page it's deferred has its own footnotes,
1428 <strong>mom</strong> separates the deferred footnote from the page's
1429 proper footnote(s) with a blank line. This avoids the confusion that
1430 might result from readers seeing two footnote entries on the same page
1431 identified by a single star (or the number 1 if you've requested
1432 numbered footnotes that begin at 1 on every page). The blank line
1433 makes it clear that the first footnote entry belongs to the previous
1436 In the circumstance where a deferred footnote is not the only one on
1437 its page, and is consequently marked by something other than a single
1438 star, there's no confusion and <strong>mom</strong> doesn't bother
1439 with the blank line. (By convention, the first footnote on a page is
1440 always marked with a single star, so if readers see, say, a dagger or two
1441 stars marking the first footnote entry, they'll know the entry belongs
1442 to the previous page).
1444 Obviously, deferred footnotes aren't an issue if you request numbered
1445 footnotes that increase incrementally throughout the whole document --
1446 yet another convenience <strong>mom</strong> has thought of.
1448 Exceptionally, you may encounter problems with footnotes inside
1449 quotes and blockquotes that cross a page or column. See
1450 <a href="#BREAK_QUOTE">BREAK_QUOTE</a>
1456 <hr width="66%" align="left">
1459 Macro: <strong>FOOTNOTE</strong> <var><toggle> | INDENT LEFT | RIGHT | BOTH <indent value></var>
1461 <em>*See <a href="#FOOTNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!
1463 <indent value> requires a
1464 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
1468 <strong>FOOTNOTE</strong> is a toggle macro, therefore invoking it
1469 on a line by itself allows you to enter a footnote in the body of a
1470 document. Invoking it with any argument <em>other than INDENT</em>
1471 (i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong>
1474 Footnotes are the only element of
1475 <a href="definitions.html#TERMS_RUNNING">running text</a>
1476 that are not affected by the typesetting
1477 <a href="typesetting.html#INDENTS">indent macros</a>.
1478 In the unlikely event that you want a page's footnotes to line
1479 up with a running indent, invoke <strong>FOOTNOTE</strong> with
1480 the <strong>INDENT</strong> argument and pass it an indent
1481 direction and indent value. <strong>L, R,</strong> and
1482 <strong>B</strong> may be used in place of <strong>LEFT,
1483 RIGHT,</strong> and <strong>BOTH</strong>.
1484 <strong>FOOTNOTE</strong> must be invoked with <strong>INDENT</strong>
1485 for every footnote you want indented; <strong>mom</strong> does
1486 not save any footnote indent information from invocation to
1489 <strong>NOTE:</strong> If a footnote runs to more than one
1490 paragraph(!), <strong>DO NOT</strong> begin the footnote with
1492 <a href="#PP">PP</a>
1493 tag. Use <strong>PP</strong> only to introduce subsequent paragraphs.
1495 <a name="FOOTNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a>
1496 The final word on the
1497 <a href="definitions.html#TERMS_INPUTLINE">input line</a>
1498 that comes immediately before <strong>FOOTNOTE</strong> MUST terminate
1500 <a href="typesetting.html#JOIN">\c</a>
1501 inline escape. Otherwise, the footnote marker for the word won't be attached to
1502 it (i.e. <strong>mom</strong> will insert a word space between the word
1503 and the marker). See the
1504 <a href="#FOOTNOTE_EXAMPLE">footnote example</a>
1508 <a name="FOOTNOTE_CONTROL"><h3><u>Footnote control macros</u></h3></a>
1510 <li><a href="#FOOTNOTE_GENERAL">Family/font/size/lead/quad</a>
1511 <li><a href="#FOOTNOTE_MARKERS">Footnote markers</a> -- on or off
1512 <li><a href="#FOOTNOTE_MARKER_STYLE">Footnote marker style</a> -- star+dagger or numbered
1513 <li><a href="#RESET_FOOTNOTE_NUMBER">Reset footnote number</a> -- set footnote marker number to 1
1514 <li><a href="#FOOTNOTE_RULE">Footnote rule</a> -- on or off
1515 <li><a href="#FOOTNOTE_RULE_LENGTH">Footnote rule length</a> -- length of footnote separator rule
1516 <li><a href="#FOOTNOTE_RULE_ADJ">Adjust vertical position of footnote separator rule</a>
1519 <a name="FOOTNOTE_GENERAL"><h3><u>1. Family/font/size/quad/lead</u></h3></a>
1522 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
1525 .FOOTNOTE_FAMILY default = prevailing document family; default is Times Roman
1526 .FOOTNOTE_FONT default = roman
1527 .FOOTNOTE_SIZE default = -2 (points)
1528 .FOOTNOTE_AUTOLEAD default = 2 points (typeset); single-spaced (typewrite)
1529 .FOOTNOTE_QUAD default = same as paragraphs
1532 <a name="FOOTNOTE_MARKERS"><h3><u>2. Footnote markers -- FOOTNOTE_MARKERS</u></h3></a>
1533 If you don't want footnote markers, in either the body of
1534 the document or beside footnote entries themselves, toggle
1535 them off with <strong>.FOOTNOTE_MARKERS OFF</strong> (or
1536 <strong>END, QUIT, X</strong>...). This means, of course, that
1537 you'll have to roll your own. If you want them back on, invoke
1538 <strong>.FOOTNOTE_MARKERS</strong> with no argument. Footnote markers
1541 <a name="FOOTNOTE_MARKER_STYLE"><h3><u>3. Footnote marker style -- FOOTNOTE_MARKER_STYLE</u></h3></a>
1542 <strong>Mom</strong> gives you two choices of footnote marker style:
1544 <a href="#FOOTNOTE_BEHAVIOUR">footnote behaviour</a>
1545 above), or numbered.
1547 <strong>.FOOTNOTE_MARKER_STYLE STAR</strong> gives you star+dagger
1548 (the default). There is a limit of 10 footnotes per page with
1551 <strong>.FOOTNOTE_MARKER_STYLE NUMBER</strong> gives you superscript
1552 numbers, both in the document body and in the footnote entries
1553 themselves. By default, footnote numbers increase incrementally
1554 (prev. footnote number + 1) throughout the whole document. You can
1555 ask <strong>mom</strong> to start each page's footnote numbers at 1
1556 with <strong>.RESET_FOOTNOTE_NUMBER</strong> (see below).
1558 <a name="RESET_FOOTNOTE_NUMBER"><h3><u>4. Reset footnote number -- RESET FOOTNOTE NUMBER</u></h3></a>
1559 <strong>.RESET_FOOTNOTE_NUMBER</strong>, by itself, resets
1560 footnote numbering so that the next footnote you enter is
1563 <strong>.RESET_FOOTNOTE_NUMBER PAGE</strong> tells
1564 <strong>mom</strong> to start every page's footnote numbering at 1.
1566 <a name="FOOTNOTE_RULE"><h3><u>5. Footnote rule -- FOOTNOTE_RULE</u></h3></a>
1567 If you don't want a footnote separator rule, toggle it off with
1568 <strong>.FOOTNOTE_RULE OFF</strong> (or <strong>END,
1569 QUIT, X</strong>...). Toggle it back on by invoking
1570 <strong>.FOOTNOTE_RULE</strong> with no argument. The default is to
1573 <a name="FOOTNOTE_RULE_LENGTH"><h3><u>6. Footnote rule length -- FOOTNOTE_RULE_LENGTH</u></h3></a>
1574 If you want to change the length of the footnote separator rule,
1575 invoke <strong>.FOOTNOTE_RULE_LENGTH</strong> with a length, like
1579 .FOOTNOTE_RULE_LENGTH 1i
1582 which sets the length to 1 inch. Note that a
1583 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
1584 is required. The default is 4
1585 <a href="definitions.html#TERMS_PICASPOINTS">picas</a>
1587 <a href="docprocessing.html#PRINTSTYLE">printstyles</a>.
1588 <a name="FOOTNOTE_RULE_ADJ"><h3><u>7. Adjust vertical position of footnote separator rule -- FOOTNOTE_RULE_ADJ</u></h3></a>
1589 The footnote separator rule is actually a baseline rule that falls
1591 <a href="definitions.html#TERMS_BASELINE">baseline</a>
1592 of the first line of a page's footnotes. By default,
1593 <strong>mom</strong> raises the rule 3
1594 <a href="definitions.html#TERMS_PICASPOINTS">points</a>
1595 from the baseline so that the separator and the footnotes don't
1596 look jammed together. If you'd prefer a different vertical
1597 adjustment, invoke <strong>.FOOTNOTE_RULE_ADJ</strong> with the
1598 amount you'd like. For example
1601 .FOOTNOTE_RULE_ADJ 4.25p
1604 raises the rule by 4-1/4 points. Note that you can only raise
1605 the rule, not lower it. A
1606 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
1611 <!====================================================================>
1613 <a name="ENDNOTE_INTRO"><h2><u>Endnotes</u></h2></a>
1615 <li><a href="#ENDNOTE_BEHAVIOUR">Endnote behaviour</a>
1617 <li><a href="#ENDNOTE_SPACING">A Note on Endnote Spacing</a>
1618 <li><a href="#ENDNOTE_COLUMNS">Endnotes and columnar documents</a>
1620 <li><a href="#ENDNOTE">Tag: ENDNOTE</a>
1621 <li><a href="#ENDNOTES">Macro: ENDNOTES</a> -- tell <strong>mom</strong> to output endnotes
1622 <li><a href="#ENDNOTE_CONTROL">ENDNOTE control macros</a>
1626 Embedding endnotes into <strong>mom</strong> documents is accomplished
1627 the same way as embedding
1628 <a href="#FOOTNOTE_INTRO">footnotes</a>. The example below is
1629 identical to the one shown in the
1630 <a href="#FOOTNOTE_EXAMPLE">introduction to footnotes</a>,
1631 except that <kbd>.FOOTNOTE</kbd> has been replaced with
1632 <kbd>.ENDNOTE</kbd>.
1634 <a name="ENDNOTE_EXAMPLE"></a>
1636 ...the doctrines of Identity as urged by Schelling\c
1638 <endnote about who the hell is Schelling>
1640 were generally the points of discussion presenting the most
1641 of beauty to the imaginative Morella.
1644 As with footnotes, note the obligatory use of the <strong>\c</strong>
1645 <a href="definitions.html#TERMS_INLINES">inline escape</a>.
1647 Endnotes differ from footnotes in two ways (other than the fact that
1648 endnotes come at the end of a document whereas footnotes appear in the
1649 body of the document):
1652 <li>Endnotes are always numbered incrementally throughout a
1653 document. In other words, you don't get a choice of marker styles,
1654 as you do with footnotes.
1655 <li>Endnotes MUST be output explicitly; <strong>mom</strong> does
1656 not output them for you. In
1657 <a href="rectoverso.html#COLLATE">collated</a>
1658 documents, this allows you to choose whether you
1659 want the endnotes to appear at the end of each chapter or
1660 section, or grouped together at the very end of the document.
1663 Within endnotes, you may use the document element tags
1664 <a href="#PP">PP</a>,
1665 <a href="#QUOTE">QUOTE</a>
1667 <a href="#BLOCKQUOTE">BLOCKQUOTE</a>.
1668 This provides the flexibility to create endnotes that run to several
1669 paragraphs, as well as to embed cited text within endnotes.
1671 Should you wish to change the appearance of quotes or blockquotes that
1672 appear within endnotes, you may do so with the
1673 <a href="#QUOTE_CONTROL">quote control macros</a>
1675 <a href="#BLOCKQUOTE_CONTROL">blockquote control macros</a>.
1676 HOWEVER... you must make the changes <em>within</em> each endnote, prior
1677 to invoking <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong>, and
1678 undo them prior to terminating the endnote (i.e. before <strong>ENDNOTE
1679 OFF</strong>), otherwise the changes will affect subsequent quotes and
1680 blockquotes that appear in the document body as well.
1682 <a name="ENDNOTE_BEHAVIOUR"><h3><u>Endnote behaviour</u></h3></a>
1684 When you output endnotes (with
1685 <a href="#ENDNOTES">ENDNOTES</a>),
1686 <strong>mom</strong> finishes processing the last page of your document,
1687 then breaks to a new page for printing the endnotes. If the document
1689 <a href="docprocessing.html#DOCTYPE">CHAPTER</a>,
1690 the centre part of the
1691 <a href="definitions.html#TERMS_HEADER">header</a>
1692 (or footer), which, by default, contains a chapter number or title, is
1695 By default, <strong>mom</strong> starts the endnotes page with a
1696 bold, centered, double-underscored head, "ENDNOTES".
1697 Underneath--flush left, bold, and underscored--she prints the document
1698 title (or, in the case of chapters, the chapter number or title). She
1699 then prints the endnotes. Each endnote is identified by its appropriate
1700 number, in bold, right aligned to two placeholders. The text of the
1701 endnotes themselves is indented to the right of the numbers.
1703 If the endnotes are grouped together at the end of a collated document,
1704 each section of the document that contains endnotes is identified by its
1705 own unique title (or chapter number or title), bold, flush left, and
1708 Of course, all the defaults, as well as the overall style of the
1709 endnotes page, can be changed with the
1710 <a href="#ENDNOTE_CONTROL">endnote control macros</a>.
1711 The attentive will notice that endnotes have an awful lot of control
1712 macros. This is because endnotes are like a mini-document unto
1713 themselves, and therefore need not be bound by the style parameters of
1714 the body of the document.
1716 <a name="ENDNOTE_SPACING">
1717 <h3><u>A Note on Endnote Spacing</u></h3>
1720 On the endnotes page(s), each new endnote is separated from the
1721 previous endnote by a full line space. This can result in a bottom
1722 margin that hangs, and is the one instance, other than the use of
1723 <a href="#PP_SPACE">PARA_SPACE</a>,
1724 where <strong>mom</strong> allows unequal bottom alignment of pages.
1725 Should you wish to correct this, by adding or subtracting small amounts
1726 of space between endnotes that appear together on an endnote page, make
1727 the adjustment (with
1728 <a href="typesetting.html#ALD">ALD</a>,
1729 <a href="typesetting.html#RLD">RLD</a>
1731 <a href="typesetting.html#SPACE">SPACE</a>)
1732 <em>at the end of each endnote</em> (i.e. just before invoking
1733 <a href="#ENDNOTE">ENDNOTE OFF</a>)
1734 rather than at the top.
1736 <a name="ENDNOTE_COLUMNS">
1737 <h3><u>Endnotes and columnar documents</u></h3>
1740 At present, there is no way to set a document in columns (see
1741 <a href="docprocessing.html#COLUMNS">COLUMNS</a>)
1742 and then turn off column mode for endnotes. If your document is set in
1743 columns, your endnotes will be, too.
1751 Macro: <strong>ENDNOTE</strong> <var><toggle></var>
1753 <em>*See <a href="#ENDNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!
1757 <strong>ENDNOTE</strong> is a toggle macro, therefore invoking it
1758 on a line by itself allows you to enter an endnote in the body of a
1759 document. Invoking it with any other argument
1760 (i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong>
1761 that you've finished the endnote.
1763 <strong>NOTE:</strong> If an endnote runs to more than one paragraph,
1764 <strong>DO NOT</strong> begin the endnote with the
1765 <a href="#PP">PP</a>
1766 tag. Use <strong>PP</strong> only to introduce subsequent paragraphs.
1768 <a name="ENDNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a>
1769 The final word on the
1770 <a href="definitions.html#TERMS_INPUTLINE">input line</a>
1771 that comes immediately before <strong>ENDNOTE</strong> MUST terminate
1773 <a href="typesetting.html#JOIN">\c</a>
1774 inline escape. Otherwise, the endnote number for the word won't be attached to
1775 it (i.e. <strong>mom</strong> will insert a word space between the word
1776 and the number). See the
1777 <a href="#ENDNOTE_EXAMPLE">endnote example</a>
1783 <hr width="66%" align="left">
1785 <a name="ENDNOTES">Macro: <strong>ENDNOTES</strong></a>
1788 Unlike footnotes, which <strong>mom</strong> automatically outputs at the
1789 bottom of pages, endnotes must be explicitly output by you, the user.
1790 <strong>ENDNOTES</strong>, by itself (i.e. without any argument), is
1791 the macro to do this.
1793 Typically, you'll use <strong>ENDNOTES</strong> at the end of
1794 a document. If it's a single (i.e. not collated) document,
1795 <strong>mom</strong> will print the endnotes pertaining to it. If it's
1796 a collated document, <strong>mom</strong> will print all the endnotes
1797 contained within all sections of the document (typically chapters),
1798 appropriately identified and numbered.
1800 Should you wish to output the endnotes for each section of a collated
1801 document at the ends of the sections (instead of at the very end of the
1802 document), simply invoke <strong>ENDNOTES</strong> immediately prior to
1803 <a href="rectoverso.html#COLLATE">COLLATE</a>.
1804 <strong>Mom</strong> will print the endnotes, identified and numbered
1805 appropriately, on a separate page prior to starting the next section of
1806 the document. Each subsequent invocation of <strong>ENDNOTES</strong>
1807 outputs only those endnotes that <strong>mom</strong> collected
1808 after the previous invocation.
1810 <hr width="66%" align="left">
1812 <a name="ENDNOTE_CONTROL"><h3><u>Endnote control macros</u></h3></a>
1814 Every time you embed an endnote in the body of a document,
1815 <strong>mom</strong> collects <em>and processes</em> the endnote for
1816 later outputting when you invoke
1817 <a href="#ENDNOTES">ENDNOTES</a>.
1818 For this reason, endnote control macros should always be invoked prior
1819 to the first instance of
1820 <a href="#ENDNOTE">ENDNOTE/ENDNOTE OFF</a>.
1823 <li><a href="#ENDNOTES_GENERAL"><strong>General endnotes-pages style control</strong></a>
1825 <li><a href="#ENDNOTE_GENERAL">Base family/font/quad for endnotes-pages</a>
1826 <li><a href="#ENDNOTE_PT_SIZE">Base point size for the endnotes-pages</a>
1827 <li><a href="#ENDNOTE_LEAD">Leading of endnotes-pages</a>
1828 <li><a href="#ENDNOTE_PARA_INDENT">Size of paragraph first line indent in multi-paragraph endnotes</a>
1829 <li><a href="#ENDNOTE_PARA_SPACE">Inserting space between paragraphs of multi-paragraph endnotes</a>
1831 <li><a href="#ENDNOTES_HEADER_CONTROL"><strong>Endnotes-page header/footer control</strong></a>
1832 <li><a href="#ENDNOTES_MAIN_TITLE"><strong>Endnotes-page head control</strong></a>
1834 <li><a href="#ENDNOTE_STRING">Creating/modifying the endnotes-page head</a>
1835 <li><a href="#ENDNOTE_STRING_CONTROL">Endnotes-page head control</a>
1836 <li><a href="#ENDNOTE_STRING_UNDERSCORE">Endnotes-page head underscoring</a>
1838 <li><a href="#ENDNOTES_DOC_TITLE"><strong>Endnote document-identification title</strong></a>
1840 <li><a href="#ENDNOTE_TITLE">Creating/modifying the endnote document-identification title</a>
1841 <li><a href="#ENDNOTE_TITLE_CONTROL">Document-identification title control</a>
1842 <li><a href="#ENDNOTE_TITLE_UNDERSCORE">Document-identification title underscoring</a>
1844 <li><a href="#ENDNOTES_NUMBERING"><strong>Endnotes-pages endnote numbering style</strong></a>
1846 <li><a href="#ENDNOTE_NUMBER_CONTROL">Endnotes-pages endnote numbering style control</a>
1847 <li><a href="#ENDNOTE_NUMBER_ALIGNMENT">Endnote numbering alignment</a>
1849 <li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT">ENDNOTE_NUMBERS_ALIGN_RIGHT</a>
1850 <li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT">ENDNOTE_NUMBERS_ALIGN_LEFT</a>
1856 <a name="ENDNOTES_GENERAL"><h2><u>1. General endnotes page style control</u></h2>
1858 <a name="ENDNOTE_GENERAL"><h3><u>Endnote family/font/quad</u></h3></a>
1861 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
1864 .ENDNOTE_FAMILY default = prevailing document family; default is Times Roman
1865 .ENDNOTE_FONT default = roman
1866 .ENDNOTE_QUAD default = justified
1869 <!---ENDNOTE_PT_SIZE--->
1871 <a name="ENDNOTE_PT_SIZE"><h3><u>Endnote point size</u></h3></a>
1873 Macro: <strong>ENDNOTE_PT_SIZE</strong> <var><base type size of endnotes></var>
1876 Unlike most other control macros that deal with size of document
1877 elements, <strong>ENDNOTE_PT_SIZE</strong> takes as its argument an
1878 absolute value, relative to nothing. Therefore, the argument represents
1879 the size of endnote type in
1880 <a href="definitions.html#TERMS_PICASPOINTS">points</a>,
1881 unless you append an alternative
1882 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
1889 sets the base point size of type on the endnotes page to 12
1893 .ENDNOTE_PT_SIZE .6i
1896 sets the base point size of type on the endnotes page to 1/6 of an
1899 The type size set with <strong>ENDNOTE_PT_SIZE</strong> is the size of
1900 type used for the text of the endnotes, and forms the basis from which
1901 the point size of other endnote page elements is calculated.
1904 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
1905 is 12 points (the same default size used in the body of the document).
1907 <!---ENDNOTE_LEAD--->
1909 <a name="ENDNOTE_LEAD"><h3><u>Endnote lead</u></h3></a>
1911 Macro: <strong>ENDNOTE_LEAD</strong> <var><base leading of endnotes></var>
1914 Unlike most other control macros that deal with leading of document
1915 elements, <strong>ENDNOTE_LEAD</strong> takes as its argument an
1916 absolute value, relative to nothing. Therefore, the argument represents
1918 <a href="definitions.html#TERMS_LEADING">leading</a>
1920 <a href="definitions.html#TERMS_PICASPOINTS">points</a>
1921 unless you append an alternative
1922 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
1929 sets the base leading of type on the endnotes page to 14
1936 sets the base leading of type on the endnotes page to 1/2 inch.
1939 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
1942 <!---ENDNOTE_PARA_INDENT--->
1944 <a name="ENDNOTE_PARA_INDENT"><h3><u>Endnote paragraph indent</u></h3></a>
1946 Macro: <strong>ENDNOTE_PARA_INDENT</strong> <var><amount to indent first line of paragraphs in endnotes></var>
1948 <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
1951 <strong>ENDNOTE_PARA_INDENT</strong> works exactly the same way as
1952 <a href="#PARA_INDENT">PARA_INDENT</a>,
1953 except that the indent given is the amount by which to indent the first
1954 lines of endnote paragraphs, not document body paragraphs.
1957 <a href="definitions.html#TERMS_EM">ems</a>
1959 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
1961 <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.
1964 <strong>NOTE:</strong> The first line of the first paragraph of endnotes
1965 (the one attached immediately to the identifying endnote number) is
1966 never indented. Only subsequent paragraphs are affected by
1967 <strong>ENDNOTE_PARA_INDENT</strong>.
1969 <!---ENDNOTE_PARA_SPACE--->
1971 <a name="ENDNOTE_PARA_SPACE"><h3><u>Endnote paragraph spacing</u></h3></a>
1973 Macro: <strong>ENDNOTE_PARA_SPACE</strong> <var><toggle></var>
1976 <strong>ENDNOTE_PARA_SPACE</strong> works exactly the same way as
1977 <a href="#PP_SPACE">PARA_SPACE</a>,
1978 except that it inserts a blank line between endnote paragraphs, not
1979 document body paragraphs.
1981 The default is not to insert a blank line between paragraphs in
1984 <strong>NOTE:</strong> Each endnote itself is always separated from any
1985 previous endnote by a line space. <strong>ENDNOTE_PARA_SPACE</strong>
1986 refers only to paragraphs that appear within each discrete endnote.
1988 <a name="ENDNOTES_HEADER_CONTROL"><h2><u>2. Endnotes-page header/footer control</u></h2></a>
1990 If you wish to modify the header/footer that appears on endnotes
1991 page(s), make the changes before you invoke
1992 <a href="#ENDNOTES">ENDNOTES</a>,
1995 Except in the case of
1996 <a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a>,
1997 <strong>mom</strong> prints the same header or footer used throughout
1998 the document on the endnotes page(s). Chapters get treated differently
1999 in that, by default, <strong>mom</strong> does not print the
2000 header/footer centre string (normally the chapter number or chapter
2001 title.) In most cases, this is what you want. However, should you
2002 <em>not</em> want <strong>mom</strong> to remove the centre string from
2003 the endnotes page(s) headers/footers, invoke
2004 <a href="#ENDNOTES_HDRFTR_CENTER">ENDNOTES_HEADER_CENTER</a>
2007 <a name="ENDNOTES_HDRFTR_CENTER"><h3><u>Endnotes page(s) header/footer center string</u></h3></a>
2009 Macro: <strong>ENDNOTES_HEADER_CENTER</strong> <var>toggle</var>
2013 <a href="docprocessing.html#DOCTYPE">DOCTYPE</a>
2014 is <kbd>CHAPTER</kbd> and you want <strong>mom</strong> to include
2015 a centre string in the headers/footers that appear on endnotes pages,
2016 invoke <strong>ENDNOTES_HEADER_CENTER</strong> (or
2017 <strong>ENDNOTES_FOOTER_CENTER</strong>) with no argument.
2018 <strong>Mom</strong>'s default is NOT to print the center string.
2021 reason, having enabled the header/footer center string on endnotes
2022 pages, you wish to disable it, invoke the same macro with any argument
2023 (<strong>OFF, QUIT, Q, X</strong>...).
2025 <a name="ENDNOTES_MAIN_TITLE"><h2><u>3. Endnotes page head control</u></h2>
2027 <!---ENDNOTE_STRING--->
2029 <a name="ENDNOTE_STRING"><h3><u>Endnotes-page head string</u></h3></a>
2031 Macro: <strong>ENDNOTE_STRING</strong> <var>"<head to print at the top of endnotes>"</var>
2034 By default, <strong>mom</strong> prints the word "ENDNOTES"
2035 as a head at the top of the first page of endnotes. If you want her
2036 to print something else, invoke <strong>ENDNOTE_STRING</strong> with
2037 the endnotes-page head you want, surrounded by double-quotes. If
2038 you don't want a head at the top of the first endnotes-page, invoke
2039 <strong>ENDNOTE_STRING</strong> with a blank argument (either two
2040 double-quotes side by side -- <kbd>""</kbd> -- or no argument
2043 <!---ENDNOTE_STRING_CONTROL--->
2045 <a name="ENDNOTE_STRING_CONTROL"><h3><u>Endnotes-page head control</u></h3></a>
2048 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
2051 .ENDNOTE_STRING_FAMILY default = prevailing document family; default is Times Roman
2052 .ENDNOTE_STRING_FONT* default = bold
2053 .ENDNOTE_STRING_SIZE default = +1
2054 .ENDNOTE_STRING_QUAD default = centered
2056 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
2059 <!---ENDNOTE_STRING_UNDERSCORE--->
2061 <a name="ENDNOTE_STRING_UNDERSCORE"><h3><u>Endnotes-page head underscoring</h3></u></a>
2063 Macro: <strong>ENDNOTE_STRING_UNDERSCORE</strong> <var>toggle | 2</var>
2066 Invoked by itself, <strong>ENDNOTE_STRING_UNDERSCORE</strong> will
2067 underscore the endnotes-page head. Invoked with the argument 2
2068 (i.e. the digit 2), <strong>ENDNOTE_STRING_UNDERSCORE</strong> will
2069 double-underscore the head. Invoked with any other argument, the macro
2070 disables underscoring of the head.
2072 <strong>Mom</strong>'s default is to double-underscore the
2073 head, therefore if you want no underscoring, you must insert
2074 <kbd>.ENDNOTE_STRING_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO,
2075 NONE,</kbd> etc.) into your document prior to outputting endnotes with
2076 <a href="#ENDNOTES">ENDNOTES</a>.
2078 <!---ENDNOTE_TITLE--->
2080 <a name="ENDNOTES_DOC_TITLE"><h2><u>4. Endnote document-identification title</u></h2>
2081 <a name="ENDNOTE_TITLE"><h3><u>Endnote document-identification title string</u></h3></a>
2083 Macro: <strong>ENDNOTE_TITLE</strong> <var>"<title to identify a document in endnotes>"</var>
2086 By default, <strong>mom</strong> identifies the document(s) to which
2087 endnotes belong by the document title(s) given to the
2088 <a href="docprocessing.html#TITLE">TITLE</a>
2089 macro. If you want her to identify the document(s) another way,
2090 invoke <strong>ENDNOTE_TITLE</strong> with the identifying title you
2091 want, surrounded by double-quotes. If you don't any identifying title,
2092 invoke <strong>ENDNOTE_TITLE</strong> with a blank argument (either two
2093 double-quotes side by side -- <kbd>""</kbd> -- or no argument
2096 <!---ENDNOTE_TITLE_CONTROL--->
2098 <a name="ENDNOTE_TITLE_CONTROL"><h3><u>Endnote document-identification title control</u></h3></a>
2101 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
2104 .ENDNOTE_TITLE_FAMILY default = prevailing document family; default is Times Roman
2105 .ENDNOTE_TITLE_FONT default = bold
2106 .ENDNOTE_TITLE_SIZE* default = 0
2107 .ENDNOTE_TITLE_QUAD default = left
2109 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
2112 <!---ENDNOTE_TITLE_UNDERSCORE--->
2114 <a name="ENDNOTE_TITLE_UNDERSCORE"><h3><u>Endnote document-identification title underscoring</h3></u></a>
2116 Macro: <strong>ENDNOTE_TITLE_UNDERSCORE</strong> <var>toggle</var>
2119 Inovked by itself, <strong>ENDNOTE_TITLE_UNDERSCORE</strong> will
2120 underscore the endnote document-identification title. Invoked with any
2121 other argument, the macro disables underscoring of the title.
2123 <strong>Mom</strong>'s default is to underscore the document-identification title, therefore if you want no underscoring, you must
2124 insert <kbd>.ENDNOTE_TITLE_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO,
2125 NONE,</kbd> etc.) into your document prior to outputting endnotes with
2126 <a href="#ENDNOTES">ENDNOTES</a>.
2130 <!---ENDNOTE_NUMBERING--->
2132 <a name="ENDNOTES_NUMBERING"><h2><u>5. Endnotes-pages endnote numbering style</u></h2>
2134 <a name="ENDNOTE_NUMBER_CONTROL"><h3><u>Endnote numbering style control</u></h3></a>
2137 <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
2139 Please note that the control macros for endnote numbering affect only
2140 the numbers that appear on the endnotes pages themselves, not the
2141 endnote numbers that appear in the body of the document(s).
2144 .ENDNOTE_NUMBER_FAMILY default = prevailing document family; default is Times Roman
2145 .ENDNOTE_NUMBER_FONT default = bold
2146 .ENDNOTE_NUMBER_SIZE* default = 0
2148 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
2151 <a name="ENDNOTE_NUMBER_ALIGNMENT"><h3><u>Endnote numbering alignment</u></h3></a>
2153 By default, <strong>mom</strong> hangs the numbers on endnotes pages,
2154 aligned right to two placeholders, producing this:
2156 <a name="ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE"></a>
2158 9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2159 sed diam nonumy eirmod tempor invidunt ut labore et
2160 dolore magna aliquyam erat, sed diam voluptua.
2162 10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2163 sed diam nonumy eirmod tempor invidunt ut labore et
2164 dolore magna aliquyam erat, sed diam voluptua.
2167 The macros to alter this behaviour are
2170 <li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT"><strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong></a>
2171 <li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT"><strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong></a>
2174 <hr width="66%" align="left">
2176 <!---ENDNOTE_NUMBERS_ALIGN_RIGHT--->
2179 <a name="ENDNOTE_NUMBERS_ALIGN_RIGHT">
2180 Macro: <strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> <var><number of placeholders></var>
2183 <strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> takes one (non-optional)
2184 argument: the number of placeholders to reserve for right alignment of
2187 For example, if you have fewer than ten endnotes, you might want to do
2190 .ENDNOTE_NUMBERS_ALIGN_RIGHT 1
2193 which would ensure that the endnote numbers hang, but are all flush
2194 with the page's left margin. If, god help you, you have over a hundred
2195 endnotes, you'd want to do
2198 .ENDNOTE_NUMBERS_ALIGN_RIGHT 3
2201 to ensure that the numbers hang and are properly right-aligned.
2203 <hr width="66%" align="left">
2205 <!---ENDNOTE_NUMBERS_ALIGN_LEFT--->
2208 <a name="ENDNOTE_NUMBERS_ALIGN_LEFT">
2209 Macro: <strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong>
2212 If you don't want the endnote numbers to hang and right-align, invoke
2213 <strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong>, which doesn't require any
2214 argument. This disables hanging and right-alignment of endnote numbers,
2216 <a href="#ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE">above</a>
2217 comes out like this:
2220 9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2221 sed diam nonumy eirmod tempor invidunt ut labore et
2222 dolore magna aliquyam erat, sed diam voluptua.
2224 10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2225 sed diam nonumy eirmod tempor invidunt ut labore et
2226 dolore magna aliquyam erat, sed diam voluptua.
2232 <!====================================================================>
2234 <a name="FINIS_INTRO"><h2><u>Terminate document processing</u></h2></a>
2236 <li><a href="#FINIS">Tag: FINIS</a>
2237 <li><a href="#FINIS_STRING">Changing the FINIS string</a>
2241 The use of <strong>FINIS</strong> is optional. If you invoke it
2242 (at the end of a document, of course), <strong>mom</strong> turns off
2243 <a href="definitions.html#TERMS_FOOTER">footers</a>
2244 (if they're on) and page numbering (if page
2245 numbers are at the bottom of the page) and deposits the word
2246 END, centered after a blank line, beneath the last
2247 line of the document. END is enclosed between
2248 <a href="definitions.html#TERMS_EM">em-dashes</a>.
2250 If you're writing in a language other than English, you can
2251 change what <strong>mom</strong> prints for END with
2252 the control macro <strong>FINIS_STRING</strong>.
2257 <hr width="66%" align="left">
2260 Macro: <strong>FINIS</strong>
2264 The use of <strong>FINIS</strong> is optional, but if you use
2265 it, it should be the last macro you invoke in a document. See
2266 <a href="#FINIS_INTRO">above</a>
2267 for a description of how <strong>FINIS</strong> behaves.
2269 <strong>NOTE:</strong> If you don't use <strong>FINIS</strong>,
2271 <a href="definitions.html#TERMS_FOOTER">footers</a>
2272 (if they're on) or a page number at the bottom of the last page of
2273 a document, you have to turn them off manually, as the last two
2274 lines of your document file, like this:
2281 <a name="FINIS_STRING"><h3><u>Changing the FINIS string</u></h3></a>
2284 By default, <strong>FINIS</strong> prints the word
2286 <a href="definitions.html#TERMS_EM">em-dashes</a>.
2287 If you'd like <strong>mom</strong> to print something else
2288 between the dashes, use the <strong>FINIS_STRING</strong> macro
2289 (anywhere in the document prior to <strong>FINIS</strong>).
2291 For example, if your document's in French, you'd do
2297 Double-quotes must enclose the macro's argument.
2299 <strong>NOTE:</strong> If you pass <strong>FINIS_STRING</strong>
2300 a blank string, i.e.
2306 <strong>mom</strong> will still print the em-dashes if you
2307 invoke <strong>FINIS</strong>. This, in effect, produces a
2308 short, centered horizontal rule that terminates the document.
2310 <a href="docprocessing.html.#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
2311 it's a short, dashed line composed of four hyphens.)
2315 <a href="headfootpage.html#TOP">Next</a>
2316 <a href="docprocessing.html#TOP">Prev</a>
2317 <a href="#TOP">Top</a>
2318 <a href="toc.html">Back to Table of Contents</a>