| blob | 2ba6eb0e2b5eb9c3f082d522f875a54b3a81d9da |
1 <html>
2 <head>
5 </head>
8 <!====================================================================>
17 </a>
19 <ul>
21 <ul>
22 <li><a href="#DOCELEMENT_CONTROL">Control macros -- changing defaults for document element tags</a>
24 </ul>
26 </ul>
30 </a>
32 Once you've completed the setup for a document (see
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
37 is a subhead, this is a footnote," and so on.
38 <p>
39 The list of tags is actually quite small -- ideal for the users
42 However, the list of macros that control the appearance of the
43 tags upon output is extensive. Generally, for each tag,
44 there are
46 for the tag's family, font and point size. Where appropriate, there
47 are macros to control leading, indents, quad and special features
48 as well.
49 <p>
51 only use the control macros when you want to change the way
52 she does things. This is usually done prior to
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
56 the tag.
60 <p>
61 The control macros for document processing tags let you
63 should you wish. At a bare minimum, all tags have macros to
65 and point size. Where appropriate, there are macros to control
66 leading, indents and quad as well.
67 <p>
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,
72 <p>
73 The control macros may be used at any time during the course of
74 a document (i.e. before or after
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
79 or off.
80 <p>
81 And don't forget: the
83 can be used at any time, including inside
85 tags (affected only that particular invocation of the tag).
86 Equally,
88 can be used in tags that take
90 <p>
92 leading control macros have no effect in
95 a linespace of 24 points).
96 <p>
97 Please also note that the defaults listed
98 with the control macros apply only to
101 <p>
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
110 is complex and unwieldy, which is not only untrue, but would offend
111 her mightily.
116 The arguments to the control macros that end in
118 as for
120 and
126 the number of
128 larger (+) or smaller (-) than the point size of paragraphs
129 you want the document element to be. For example, to change
131 <p>
132 <pre>
133 .SUBHEAD_SIZE +1.5
134 </pre>
136 There's no need for a
142 same argument as
144 viz. a digit that represents the number of points to add to the
145 tag's point size to arrive at its
147 For example, to set footnotes
149 <p>
150 <pre>
151 .FOOTNOTE_AUTOLEAD 0
152 </pre>
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
156 <p>
157 <pre>
158 .FOOTNOTE_AUTOLEAD 1
159 </pre>
163 macros that end
165 only; no decimal fractions) with no
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.
173 arguments as
178 <ul>
180 <ul>
183 </ul>
185 <ul>
188 </ul>
190 <ul>
193 </ul>
195 <ul>
198 </ul>
200 <ul>
203 </ul>
205 <ul>
208 </ul>
210 <ul>
213 </ul>
215 <ul>
218 </ul>
220 <ul>
223 </ul>
225 <ul>
228 </ul>
229 </ul>
230 <hr>
233 <!====================================================================>
236 <ul>
239 </ul>
240 <p>
242 color, flavour, or comment on the text they precede. Typically,
243 they are centered on the page and set in a smaller point size
244 than that of paragraph text.
245 <p>
248 this lets you input them on a line for line basis. This behaviour
250 <br>
252 <!---EPIGRAPH--->
255 <p>
258 </a>
260 <p>
262 <p>
263 <pre>
264 .EPIGRAPH
266 .EPIGRAPH OFF
267 </pre>
271 <p>
273 sets epigraphs
275 justified or quadded in the same direction as paragraphs, indented
276 equally from both the left and right margins.
277 <p>
278 If a block-style epigraph runs to more than one paragraph (unlikely,
282 tag.
283 <p>
285 used at the top of a document (i.e. just after
287 or after
289 recommended, but it does work. In all other places where you
290 want quotes or cited text, use
292 or
296 <p>
297 See
299 <p>
300 <pre>
301 .EPIGRAPH_FAMILY default = prevailing document family; default is Times Roman
302 .EPIGRAPH_FONT default = roman
303 .EPIGRAPH_SIZE default = -1.5 (points)
304 .EPIGRAPH_AUTOLEAD default = 2 points
308 .EPIGRAPH_QUAD default = same as paragraphs
310 </pre>
311 <hr>
313 <!====================================================================>
316 <ul>
319 </ul>
320 <p>
321 The paragraph macro is the one you use most often. Consequently,
322 it's one of most powerful, yet simplest to use -- just the letters
324 on a line by itself any time, in any document element, tells
326 and indent appropriate to where you are in your document are taken
327 care of automatically.
328 <p>
330 of a document, nor paragraphs that fall imediately after
332 or
334 The first paragraphs of blockquotes and block-style epigraphs are
335 also not indented. This behaviour can be changed with the control
336 macro
338 <p>
340 deposit a blank line between paragraphs. If you want her to do so, use
342 using this macro with
344 <p>
346 control" for paragraphs (i.e. even if only one line of a paragraph
347 fits at the bottom of a page, she will set it on that page). The
348 reason for this is that writers of fiction often have single-line
349 paragraphs (e.g. in dialogue). Groff's simplistic orphan control
350 will break these one-liners -- if they fall at the bottom of the page
351 -- to a new page, which is not what you want.
352 <p>
354 and editing drafts of a document (particulary stories and chapters)
356 interruption in the flow of text is a serious obstacle to creativity
357 and critiquing.
358 <p>
359 I use the tab key on my keyboard to indent paragraphs when I'm writing,
360 producing a text file that looks pretty much like what you see on
361 a printed page. When it comes time to format and print the file,
362 I run it through a sed script that (amongst other things) converts
364 (plus a new line), and pipe the output to groff for processing and
365 printing.
366 <p>
367 Another solution is to insert a blank line between paragraphs.
368 The blank lines can then be sedded out at print time as above, or,
373 <p>
374 <pre>
375 .blm PP
376 </pre>
378 <br>
380 <!---PP--->
383 <p>
386 </a>
388 <p>
390 start a new paragraph. See
392 for more details. In addition to regular text paragraphs, you can
396 and
400 <p>
402 it were, the basis of everything that goes on in a document, its
403 control is managed in a manner somewhat different from other document
404 element tags.
405 <p>
406 <ol>
414 </ol>
417 The paragraph
419 is set with
421 prior to
423 or
425 afterwards. Please note that both globally affect the family of
426 every element in the document.
427 <p>
428 If you wish to change the family for regular
431 to differ from the prevailing document family.
432 <p>
434 is Times Roman.
437 To change the
440 which takes the same argument as
444 Only regular text paragraphs are affected; paragraphs in
447 and
449 remain at their default setting (medium roman) unless you change them
450 with the appropriate control macros.
451 <p>
455 The paragraph
457 is set with
459 prior to
461 or
463 afterwards. Please note that either method globally affects the
464 leading and spacing of every document element (except
466 and
468 <p>
469 If you wish to change the leading of regular text paragraphs only,
471 EVERY paragraph whose leading you wish to change.
472 <p>
476 of pages.
477 <p>
479 is 16 points, adjusted to fill the page.
482 The justification/quad-direction of regular text paragraphs (i.e.
484 or
486 and
488 left/right/center) is set with
490 or
492 prior to
494 and with
496 afterwards.
497 <p>
498 Please note that either method of setting the paragraph
499 justification/quad-direction also affects
501 and
503 but not
505 (whose default is QUAD LEFT unless you change it with
507 The justification/quad-direction of epigraphs and footnotes may
508 be changed with their own control macros.
509 <p>
510 If you wish to change the justification/quad-direction of
513 Only the paragraph in question gets justified or quadded
514 differently; subsequent paragraphs remain unaffected.
515 <p>
517 paragraphs is justified for
519 and quad left for
523 The first-line indent of paragraphs is controlled by
526 or after
528 A
530 is required; fractional sizes are allowed. Thus, to set the paragraph
533 <p>
534 <pre>
535 .PARA_INDENT 4.5m
536 </pre>
538 In addition to establishing the basic first line-indent of
542 and
544 whose overal indenting from the left and (where applicable) right
546 first-line indent of paragraphs within these document elements (as well
549 <p>
551 ems for
556 <a name="PARA_INDENT_FIRST"><h3><u>6. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a>
558 of a document, nor the first paragraph after a head or
559 subhead, nor the first paragraphs of
562 or
564 that run to more than one paragraph.
566 <p>
567 If you wish to have first paragraphs indented, invoke the macro
569 before or after
573 its effect, meaning that first paragraphs will once again NOT be
574 indented.
578 between paragraphs. If you would like her to do so, invoke the
580 before or after
584 effect, meaning that paragraphs will once again NOT be separated by
585 a blank line.
586 <br>
587 <hr>
589 <!====================================================================>
592 <ul>
595 </ul>
596 <p>
598 -- should be used any place you want titles to introduce major
600 your heads for you. Head numbers can also be included
601 hierarchically in numbered
603 and
605 <p>
606 By default, heads are centered on the page, underlined,
607 all in caps. A double linespace precedes each head. In <a
609 are bold, slightly larger than paragraph text.
610 <p>
611 If these defaults don't suit you, you can change them with the
612 head control macros.
613 <br>
615 <!---HEAD--->
618 <p>
620 Macro: <strong>HEAD</strong> <var>"<text of head>" [ "<2nd line>" [ "<3rd line>" ... ] ]</var>
621 </a>
623 <p>
625 surrounded by double-quotes. If you need additional lines for a
626 head, simply surround each line with double-quotes.
627 <p>
630 one line of text underneath it</em>, she will set the head at the
631 top of the next page.
634 <p>
635 There are, in addition to the usual family/font/size/quad control
636 macros, a number of macros to manage head numbering, spacing,
637 underlining, and so on. Check them out if you're unhappy with
639 <p>
640 <ol>
648 </ol>
649 <p>
651 <p>
652 See
654 <p>
655 <pre>
656 .HEAD_FAMILY default = prevailing document family; default is Times Roman
657 .HEAD_FONT default = bold
658 .HEAD_SIZE default = +1 (point)
659 .HEAD_QUAD default = CENTER
660 </pre>
664 of the
666 you give to
668 To change this behaviour, do
669 <p>
670 <pre>
671 .HEAD_CAPS OFF
672 </pre>
677 simply invoke it without an argument.
681 head. If you'd prefer just a single blank line, do
682 <p>
683 <pre>
684 .HEAD_SPACE OFF
685 </pre>
694 behaviour, do
695 <p>
696 <pre>
697 .HEAD_UNDERLINE OFF
698 </pre>
702 QUIT, Q, X</strong>...). To restore underlining of heads, invoke
706 If you'd like your heads numbered, simply invoke
708 will number all subsequent heads automatically (in ascending order,
709 naturally).
710 <p>
711 If, in addition to numbering heads, you also request that
713 and/or
715 be numbered, the head number will be included in their numbers
716 (each number separated by a period [dot]).
717 <p>
718 Should you wish to stop head numbering, invoke
720 END, X</strong>...). Head numbering will cease, and the head number
721 will not be included in the numbering of subheads and/or paraheads.
727 the next in ascending order (i.e. the last head number + 1), invoke
729 <p>
730 <pre>
731 .RESET_HEAD_NUMBER 6
732 </pre>
738 If you need to adjust the
740 position of a head (e.g. the head falls at the top of a column and
741 you want its
743 to line up with the ascenders of
745 in other columns), you can embed a vertical motion
747 (either
749 or
752 <p>
753 For example,
754 <p>
755 <pre>
756 .HEAD "\[ALD3]Text of head
757 </pre>
759 will lower the baseline of the head by three points. Note that
760 there's no need to reverse the sense of the inline escape.
761 <p>
762 In the case of heads that run to more than one line, you must embed
763 the escape in the string for each line, like this:
764 <p>
765 <pre>
767 </pre>
772 <br>
773 <hr>
775 <!====================================================================>
778 <ul>
781 </ul>
782 <p>
783 Subheads should be used any place you want titles to introduce
784 sections of a document below heads. If you wish, <strong>mom</strong>
785 can number subheads for you. Subhead numbers can also be included
786 hierarchically in numbered
788 <p>
789 By default, subheads are flush left. In
791 they are set bold, slightly larger than paragraph text. In
793 they are underlined. A single linespace precedes them in both
794 printstyles, and a tiny space adjustment raises them slightly
795 above text that comes afterwards for greater clarity in
796 document structuring.
797 <p>
798 If these defaults don't suit you, you can change them with the
799 subhead control macros.
800 <br>
802 <!---SUBHEAD--->
805 <p>
807 Macro: <strong>SUBHEAD</strong> <var>"<text of subhead>" [ "<2nd line>" [ "<3rd line>" ... ] ]</var>
808 </a>
809 <p>
810 The argument to <strong>SUBHEAD</strong> is the text of the subhead,
811 surrounded by double-quotes. If you need additional lines for a
812 subhead, simply surround each line with double-quotes.
813 <p>
814 <strong>NOTE:</strong> If a subhead falls near the bottom of an output
815 page and <strong>mom</strong> is unable to fit the head <em>plus at
816 least one line of text underneath it</em>, she will set the subhead
817 at the top of the next page.
820 <p>
821 In addition to the usual family/font/size/quad control
822 macros, there are macros to manage subhead numbering.
823 <p>
824 <ol>
829 </ol>
830 <p>
832 <p>
833 See
835 <p>
836 <pre>
837 .SUBHEAD_FAMILY default = prevailing document family; default is Times Roman
838 .SUBHEAD_FONT default = bold
839 .SUBHEAD_SIZE default = +.5 (point)
840 .SUBHEAD_QUAD default = LEFT
841 </pre>
844 If you'd like your subheads numbered, simply invoke
845 <strong>.NUMBER_SUBHEADS</strong> with no argument.
846 <strong>Mom</strong> will number all subsequent subheads automatically
847 (in ascending order, naturally).
848 <p>
849 If, in addition to numbering subheads, you also request that
851 be numbered, the head number will be included in the subhead number
852 (separated by a period [dot]).
853 <p>
854 Should you wish to stop subhead numbering, invoke
855 <strong>NUMBER_SUBHEADS</strong> with any argument (<strong>OFF, QUIT,
856 END, X</strong>...). Subhead numbering will cease, and the subhead
857 number will not be included in the numbering of paraheads.
859 <a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a>
860 Should you wish to reset the subhead number to "1", invoke
861 <strong>RESET_SUBHEAD_NUMBER</strong> with no argument. If, for some
862 reason, you want <strong>mom</strong> to use a subhead number that is not
863 the next in ascending order (i.e. the last subhead number + 1), invoke
864 <strong>RESET_SUBHEAD_NUMBER</strong> with the number you want, e.g.
865 <p>
866 <pre>
867 .RESET_SUBHEAD_NUMBER 4
868 </pre>
870 Your next subhead will be numbered "4" and subsequent
871 subheads will be numbered in ascending order from "4".
874 See
876 The information there applies equally to subheads.
879 <br>
880 <hr>
882 <!====================================================================>
885 <ul>
888 </ul>
889 <p>
890 Paragraph heads (paraheads) should be used any place you want titles
891 to introduce paragraphs below heads or subheads. If you wish,
892 <strong>mom</strong> can number paraheads for you.
893 <p>
894 By default, paraheads are joined to the body of a paragraph,
895 slightly indented (provided the paragraph is not a
896 "first" paragraph as defined in
898 In
900 they are set bold italic, slightly larger than paragraph text. In
902 they are underlined.
903 <p>
904 If these defaults don't suit you, you can change them with the
905 parahead control macros.
906 <br>
908 <!---PARAHEAD--->
911 <p>
913 Macro: <strong>PARAHEAD</strong> <var>"<text of parahead>"</var>
914 </a>
915 <p>
916 <strong>PARAHEAD</strong> must come AFTER
918 or it will not work!
919 <p>
920 The argument is the text of the parahead, surrounded by double-quotes.
921 Because paraheads are joined to the body of a paragraph, they accept
922 only one argument (see
924 and
928 <p>
929 In addition to the family/font/size/indent control macros, there are
930 macros to manage parahead numbering.
931 <p>
932 <ol>
937 </ol>
938 <p>
940 <p>
941 See
943 <p>
944 <pre>
945 .PARAHEAD_FAMILY default = prevailing document family; default is Times Roman
946 .PARAHEAD_FONT default = bold italic
947 .PARAHEAD_SIZE default = +.5 (point)
948 </pre>
951 Unlike other control macros that end in
953 the argument to the macro that controls indenting of paragraph heads
954 (<strong>PARAHEAD_INDENT</strong>) is NOT relative to the first-line
955 indent of normal paragraphs. In other words, it takes an absolute
956 value, and requires a
958 For example, to set the paragraph head indent to 2-1/2 picas, you
959 do:
960 <p>
961 <pre>
962 .PARAHEAD_INDENT 2.5P
963 </pre>
964 <strong>Mom</strong>'s default indent for paragraph heads is 1/2
965 the first-line indent of normal paragraphs (both printstyles).
966 However, as stated above, if you choose to change the indent, you
967 must give an absolute value (unless you're a groff expert and want
968 to manipulate the number register <code>\n[#PP_INDENT]u</code>
969 arithmetically as the argument to <strong>PARAHEAD_INDENT</strong>
970 for an indent that's relative to <strong>PP_INDENT</strong>.)
971 <p>
972 <strong>NOTE:</strong> Paragraph heads in "first
973 paragraphs", as defined in
975 are not indented unless you turn
977 on.
980 If you'd like your paraheads numbered, simply invoke
981 <strong>.NUMBER_PARAHEADS</strong> with no argument.
982 <strong>Mom</strong> will number all subsequent paraheads automatically
983 (in ascending order, naturally).
984 <p>
985 If, in addition to numbering paraheads, you also request that
987 and
989 be numbered, the head and/or subhead number will be included in the
990 parahead number (separated by a period [dot]).
991 <p>
992 Should you wish to stop parahead numbering, invoke
993 <strong>NUMBER_PARAHEADS</strong> with any argument (<strong>OFF,
994 QUIT, END, X</strong>...). Parahead numbering will cease.
996 <a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a>
997 Should you wish to reset the parahead number to "1", invoke
998 <strong>RESET_PARAHEAD_NUMBER</strong> with no argument. If, for some
999 reason, you want <strong>mom</strong> to use a parahead number that is not
1000 the next in ascending order (i.e. the last parahead number + 1), invoke
1001 <strong>RESET_PARAHEAD_NUMBER</strong> with the number you want, e.g.
1002 <p>
1003 <pre>
1004 .RESET_PARAHEAD_NUMBER 7
1005 </pre>
1007 Your next parahead will be numbered "7" and subsequent
1008 paraheads will be numbered in ascending order from "7".
1009 <br>
1010 <hr>
1012 <!====================================================================>
1015 <ul>
1018 </ul>
1019 <p>
1020 By default, <strong>mom</strong> marks
1022 with three centered asterisks. You can change this behaviour
1023 with the linebreak character
1025 <br>
1027 <!---LINEBREAK--->
1030 <p>
1032 Macro: <strong>LINEBREAK</strong>
1033 </a>
1035 <p>
1036 <strong>LINEBREAK</strong> takes no arguments. Simply invoke it
1037 (on a line by itself, of course) whenever you want to insert an
1038 author linebreak. The appearance of the linebreak is controlled
1039 by the
1041 macro.
1043 <h3><u>Linebreak character control macro</u></h3>
1044 <p>
1046 Macro: <strong>LINEBREAK_CHAR</strong> <var>[ <character> ] [ <iterations> [ <vertical adjustment> ] ]</var>
1047 </a>
1048 <br>
1049 <em>*The third optional argument requires a
1052 <p>
1053 <strong>LINEBREAK_CHAR</strong> determines what <strong>mom</strong>
1054 prints when <strong>LINEBREAK</strong> is invoked. It takes 3
1055 optional arguments: the character you want deposited at the line
1056 break, the number of times you want the character repeated, and a
1057 vertical adjustment factor.
1058 <p>
1059 The first argument is any legal groff character (e.g. <kbd>*</kbd>
1060 [an asterisk], <kbd>\(dg</kbd> [a dagger], <kbd>\f(ZD\N'141\fP</kbd>
1061 [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd>
1062 [a 4-pica long rule]). <strong>Mom</strong> sets the character
1063 centered on the current line length.
1064 <p>
1065 The second argument is the number of times to repeat the character.
1066 <p>
1067 The third argument is a +|- value by which to raise (+) or lower (-)
1068 the character in order to make it appear visually centered between
1069 sections of text. This lets you make vertical adjustments
1070 to characters that don't sit on the
1072 (such as asterisks). The argument must be preceded by a plus or
1073 minus sign, and must include a unit of measure.
1074 <p>
1075 If you enter <strong>LINEBREAK_CHAR</strong> with no arguments,
1076 sections of text will be separated by two blank lines.
1077 <p>
1078 <strong>Mom</strong>'s default for <strong>LINEBREAK_CHAR</strong> is
1079 <p>
1080 <pre>
1081 .LINEBREAK_CHAR * 3 -3p
1082 </pre>
1084 i.e. three asterisks, lowered 3 points from their normal vertical
1085 position (for
1087 the vertical adjustment is -2 points for
1089 <br>
1090 <hr>
1092 <!====================================================================>
1095 <ul>
1098 </ul>
1099 <p>
1101 are always set in
1103 flush left. This permits entering quotes on a line for line basis in
1104 your text editor and have them come out the same way on output copy.
1105 (See
1107 for how quotes, in the present sense, differ from longer
1108 passages of cited text.)
1109 <p>
1110 Since <strong>mom</strong> originally came into being to serve
1111 the needs of creative writers (i.e. novelists, short story
1112 writers, etc. -- not to cast aspersions on the creativity of
1113 mathematicians and programmers), she sets quotes in italics
1115 or underlined
1117 indented from the left margin. Obviously, she's thinking
1118 "quotes from poetry or song lyrics", but with the
1119 quote control macros you can change her defaults so
1120 <strong>QUOTE</strong> serves other needs, e.g. entering snippets of
1121 programming code, command line instructions, and so on.
1122 <p>
1124 Besides indenting quotes, <strong>mom</strong> further sets them
1125 off from
1127 with a small amount of vertical whitespace top and bottom. In
1129 this is always one full linespace. In
1131 it's 1/2 of the prevailing
1133 if the quote fits fully on the page (i.e. with running text above
1134 and below it), otherwise it's a full linespace either above or below
1135 as is necessary to balance the page to the bottom margin. This
1136 behaviour can be changed with the control macro
1138 <p>
1139 <strong>NOTE:</strong> <strong>ALWAYS_FULLSPACE_QUOTES</strong>
1140 applies to both
1142 and
1144 as does the control macro
1146 <br>
1148 <!---QUOTE--->
1151 <p>
1153 Macro: <strong>QUOTE</strong> <var>toggle</var>
1154 </a>
1156 <p>
1157 <strong>QUOTE</strong> is a toggle macro. To begin a section of
1158 quoted text, invoke it with no argument, then type in your quote.
1159 When you're finished, invoke <strong>QUOTE</strong> with any
1160 argument (e.g. OFF, END, X, Q...) to turn it off. Example:
1161 <p>
1162 <pre>
1163 .QUOTE
1164 Nymphomaniacal Jill
1165 Used a dynamite stick for a thrill
1166 They found her vagina
1167 In North Carolina
1168 And bits of her tits in Brazil.
1169 .QUOTE END
1170 </pre>
1173 <ol>
1178 </ol>
1179 <p>
1181 <p>
1182 See
1184 <p>
1185 <pre>
1186 .QUOTE_FAMILY default = prevailing document family; default is Times Roman
1187 .QUOTE_FONT default = italic
1188 .QUOTE_SIZE default = 0 (i.e. same size as paragraph text)
1189 <a name="QUOTE_INDENT">.QUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
1190 (note that this macro also sets the indents (left and right)
1191 for blockquotes)
1192 </pre>
1194 <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
1195 If you'd like <strong>mom</strong> always to put a full linespace above
1196 and below quotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
1197 with no argument. If you wish to restore <strong>mom</strong>'s
1198 default behaviour regarding the spacing of quotes (see
1200 invoke the macro with any argument (<strong>OFF, QUIT, END,
1201 X</strong>...)
1202 <p>
1203 <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
1204 spacing policy for
1207 <a name="UNDERLINE_QUOTES"><h3><u>3. Underlining -- UNDERLINE_QUOTES (typewrite only)</u></h3></a>
1208 By default in
1210 <strong>mom</strong> underlines quotes. If you'd rather she didn't,
1211 invoke <strong>.UNDERLINE_QUOTES</strong> with any argument
1212 (<strong>OFF, QUIT, END, X</strong>...) to disable the feature.
1213 Invoke it without an argument to restore <strong>mom</strong>'s
1214 default underlining of quotes.
1215 <p>
1216 If you not only wish that <strong>mom</strong> not underline
1217 quotes, but also that she set them in italic, you must follow each
1218 instance of <strong>QUOTE</strong> with the typesetting macro <a
1220 Furthermore, since <strong>mom</strong> underlines all instances
1221 of italics by default in <strong>PRINTSTYLE TYPEWRITE</strong>,
1222 you must also make sure that <strong>ITALIC_MEANS_ITALIC</strong>
1223 is enabled (see
1227 Exceptionally, a quote or blockquote containing a footnote may crosse
1228 a page or column. When this happens, the footnote marker may not be
1229 correct for its position relative to other footnotes on the page, and
1230 the footnote itself may appear on the wrong page or at the bottom of
1231 the wrong column. When this happens, study your output to determine
1232 the precise point at which the quote breaks (or at which you want
1233 it to break), and add <code>.BREAK_QUOTE</code> on a line by itself
1234 afterwards. No other intervention is required, and the footnote(s)
1235 will be marked correctly and appear on the correct page.
1236 <p>
1237 <strong>BREAK_QUOTE</strong> may be used with both quotes and
1238 blockquotes, and hence is aliased as <strong>BREAK_BLOCKQUOTE,
1239 BREAK_CITATION</strong> and <strong>BREAK_CITE</strong>.
1240 <br>
1241 <hr>
1243 <!====================================================================>
1246 <ul>
1249 </ul>
1250 <p>
1251 <strong>BLOCKQUOTES</strong> are used to cite passages from another
1252 author's work. So that they stand out well from
1254 <strong>mom</strong> indents them from both the left and right margins
1255 and sets them in a different point size
1257 only).
1259 are
1261 and, by default,
1263 left.
1264 <p>
1265 Besides indenting blockquotes, <strong>mom</strong> further sets them
1266 off from running text with a small amount of vertical whitespace top
1267 and bottom. (See
1269 for a complete explanation of how this is managed, and how to control it.)
1270 <p>
1271 You may notice that <strong>BLOCKQUOTE</strong> has no macro to
1272 control
1274 although you can change the point size. There are Very Good
1275 Reasons for this. If you can't live with the limitation, change
1276 the leading of blockquotes (after invoking the tag) with
1278 but know that there will be Bottom Margin Consequences.
1279 <br>
1281 <!---BLOCKQUOTE--->
1284 <p>
1286 Macro: <strong>BLOCKQUOTE</strong> <var>toggle</var>
1287 <br>
1288 Aliases: <strong>CITE, CITATION</strong>
1289 </a>
1291 <p>
1292 <strong>BLOCKQUOTE</strong> is a toggle macro. To begin a
1293 cited passage, invoke the tag with no argument, then type in your quote.
1294 When you're finished, invoke <strong>BLOCKQUOTE</strong> with any
1295 argument (e.g. OFF, END, X, Q...) to turn it off. Example:
1296 <p>
1297 <pre>
1298 .BLOCKQUOTE
1299 Redefining the role of the United States from enablers to keep
1300 the peace to enablers to keep the peace from peacekeepers is
1301 going to be an assignment.
1302 .RIGHT
1303 \(emGeorge W. Bush
1304 .BLOCKQUOTE END
1305 </pre>
1307 If the cited passage runs to more than one paragraph, you MUST
1308 introduce each paragraph -- <em>including the first!</em> --
1309 with
1311 <p>
1312 <strong>NOTE:</strong> The aliases <strong>CITE</strong>
1313 and <strong>CITATION</strong> may be used in place of the
1314 <strong>BLOCKQUOTE</strong> tag, but "CITE" and
1315 "CITATION" must not be used to replace "BLOCKQUOTE"
1316 in any of the tag's control macros.
1319 <ol>
1322 <li><a href="#BREAK_QUOTE">Manually break a footnoted blockquote that crosses pages/columns</a>
1323 </ol>
1324 <p>
1326 <p>
1327 See
1329 <p>
1330 <pre>
1331 .BLOCKQUOTE_FAMILY default = prevailing document family; default is Times Roman
1332 .BLOCKQUOTE_FONT default = italic
1333 .BLOCKQUOTE_SIZE default = -1 (point)
1334 .QUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
1335 (note that this macro also sets the left indent for quotes)
1336 </pre>
1338 <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
1339 If you'd like <strong>mom</strong> always to put a full linespace above
1340 and below blockquotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
1341 with no argument. If you wish to restore <strong>mom</strong>'s
1342 default behaviour regarding the spacing of blockquotes (see
1344 invoke the macro with any argument (<strong>OFF, QUIT, END,
1345 X</strong>...).
1346 <p>
1347 <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
1348 spacing policy for
1350 <br>
1351 <hr>
1353 <!====================================================================>
1356 <ul>
1359 </ul>
1361 <p>
1362 For something so complex behind the scenes, footnotes are easy to use.
1363 You just type, for example
1364 <p>
1366 <pre>
1367 ...the doctrines of Identity as urged by Schelling\c
1368 .FOOTNOTE
1369 <footnote about who the hell is Schelling>
1370 .FOOTNOTE OFF
1371 were generally the points of discussion presenting the most
1372 of beauty to the imaginative Morella.
1373 </pre>
1375 and be done with it. (Note the obligatory use of the
1376 <strong>\c</strong>
1378 <strong>Mom</strong> takes care of everything:
1379 putting footnote markers in the body of the document, keeping track
1380 of how many footnotes are on the page, identifying the footnotes
1381 themeselves appropriately, balancing them properly with the botton
1382 margin, deferring footnotes that don't fit on the page... Even if
1383 you're using
1385 <strong>mom</strong> knows what to do, and Does The Right Thing.
1386 <p>
1387 Footnotes can be sly little beasts, though. If you're writing a
1388 document that's footnote-heavy, you might want to read the following.
1391 <p>
1392 By default, <strong>mom</strong> marks footnotes with
1393 alternating stars (asterisks) and daggers. The first footnote
1394 gets a star, the second a dagger, the third two stars,
1395 the fourth two daggers, etc. If you prefer numbered footnotes, rest
1396 assured <strong>mom</strong> is happy to oblige.
1397 <p>
1398 A small amount of vertical whitespace and a short horizontal rule
1399 separate footnotes from the document body. The amount of whitespace
1400 varies slightly from page to page depending on the number of lines
1401 in the footnotes. <strong>Mom</strong> tries for a nice balance
1402 between too little whitespace and too much, but when push comes to
1403 shove, she'll opt for ample over cramped. The last lines of footnotes
1404 are always flush with the document's bottom margin.
1405 <p>
1406 If <strong>mom</strong> sees that a portion of a footnote cannot
1407 be fit on its page, she carries that portion over to the next
1408 page. If an entire footnote can't be fitted on its page (i.e.
1409 <strong>FOOTNOTE</strong> has been called too close to the bottom),
1410 she defers the footnote to the next page, but sets it with the
1411 appropriate marker from the previous page.
1412 <p>
1413 In the unfortunate happenstance that a deferred footnote is the
1414 only footnote on its page (i.e. it's marked in the document body with
1415 a star) and the page it's deferred has its own footnotes,
1416 <strong>mom</strong> separates the deferred footnote from the page's
1417 proper footnote(s) with a blank line. This avoids the confusion that
1418 might result from readers seeing two footnote entries on the same page
1419 identified by a single star (or the number 1 if you've requested
1420 numbered footnotes that begin at 1 on every page). The blank line
1421 makes it clear that the first footnote entry belongs to the previous
1422 page.
1423 <p>
1424 In the circumstance where a deferred footnote is not the only one on
1425 its page, and is consequently marked by something other than a single
1426 star, there's no confusion and <strong>mom</strong> doesn't bother
1427 with the blank line. (By convention, the first footnote on a page is
1428 always marked with a single star, so if readers see, say, a dagger or two
1429 stars marking the first footnote entry, they'll know the entry belongs
1430 to the previous page).
1431 <p>
1432 Obviously, deferred footnotes aren't an issue if you request numbered
1433 footnotes that increase incrementally throughout the whole document --
1434 yet another convenience <strong>mom</strong> has thought of.
1435 <p>
1436 Exceptionally, you may encounter problems with footnotes inside
1437 quotes and blockquotes that cross a page or column. See
1439 for a solution.
1440 <br>
1442 <!---FOOTNOTE--->
1445 <p>
1447 Macro: <strong>FOOTNOTE</strong> <var><toggle> | INDENT LEFT | RIGHT | BOTH <indent value></var>
1448 <br>
1450 <br>
1451 <indent value> requires a
1453 </a>
1455 <p>
1456 <strong>FOOTNOTE</strong> is a toggle macro, therefore invoking it
1457 on a line by itself allows you to enter a footnote in the body of a
1458 document. Invoking it with any argument <em>other than INDENT</em>
1459 (i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong>
1460 you're finished.
1461 <p>
1462 Footnotes are the only element of
1464 that are not affected by the typesetting
1466 In the unlikely event that you want a page's footnotes to line
1467 up with a running indent, invoke <strong>FOOTNOTE</strong> with
1468 the <strong>INDENT</strong> argument and pass it an indent
1469 direction and indent value. <strong>L, R,</strong> and
1470 <strong>B</strong> may be used in place of <strong>LEFT,
1471 RIGHT,</strong> and <strong>BOTH</strong>.
1472 <strong>FOOTNOTE</strong> must be invoked with <strong>INDENT</strong>
1473 for every footnote you want indented; <strong>Mom</strong> does
1474 not save any footnote indent information from invocation to
1475 invocation.
1476 <p>
1477 <strong>NOTE:</strong> If a footnote runs to more than one
1478 paragraph(!), <strong>DO NOT</strong> begin the footnote with
1479 the
1481 tag. Use <strong>PP</strong> only to introduce subsequent paragraphs.
1482 <p>
1484 The final word on the
1486 that comes immediately before <strong>FOOTNOTE</strong> MUST terminate
1487 with a
1489 inline escape. Otherwise, the footnote marker for the word won't be attached to
1490 it (i.e. <strong>mom</strong> will insert a word space between the word
1491 and the marker). See the
1493 above.
1495 <p>
1497 <ol>
1501 <li><a href="#RESET_FOOTNOTE_NUMBER">Reset footnote number</a> -- set footnote marker number to 1
1503 <li><a href="#FOOTNOTE_RULE_LENGTH">Footnote rule length</a> -- length of footnote separator rule
1505 </ol>
1506 <p>
1508 <p>
1509 See
1511 <p>
1512 <pre>
1513 .FOOTNOTE_FAMILY default = prevailing document family; default is Times Roman
1514 .FOOTNOTE_FONT default = roman
1515 .FOOTNOTE_SIZE default = -2 (points)
1516 .FOOTNOTE_AUTOLEAD default = 2 points (typeset); single-spaced (typewrite)
1517 .FOOTNOTE_QUAD default = same as paragraphs
1518 </pre>
1521 If you don't want footnote markers, in either the body of
1522 the document or beside footnote entries themselves, toggle
1523 them off with <strong>.FOOTNOTE_MARKERS OFF</strong> (or
1524 <strong>END, QUIT, X</strong>...). This means, of course, that
1525 you'll have to roll your own. If you want them back on, invoke
1526 <strong>.FOOTNOTE_MARKERS</strong> with no argument. Footnote markers
1527 are on by default.
1529 <a name="FOOTNOTE_MARKER_STYLE"><h3><u>3. Footnote marker style -- FOOTNOTE_MARKER_STYLE</u></h3></a>
1530 <strong>Mom</strong> gives you two choices of footnote marker style:
1531 star+dagger (see
1533 above), or numbered.
1534 <p>
1535 <strong>.FOOTNOTE_MARKER_STYLE STAR</strong> gives you star+dagger
1536 (the default). There is a limit of 10 footnotes per page with
1537 this style.
1538 <p>
1539 <strong>.FOOTNOTE_MARKER_STYLE NUMBER</strong> gives you superscript
1540 numbers, both in the document body and in the footnote entries
1541 themselves. By default, footnote numbers increase incrementally
1542 (prev. footnote number + 1) throughout the whole document. You can
1543 ask <strong>mom</strong> to start each page's footnote numbers at 1
1544 with <strong>.RESET_FOOTNOTE_NUMBER</strong> (see below).
1546 <a name="RESET_FOOTNOTE_NUMBER"><h3><u>4. Reset footnote number -- RESET FOOTNOTE NUMBER</u></h3></a>
1547 <strong>.RESET_FOOTNOTE_NUMBER</strong>, by itself, resets
1548 footnote numbering so that the next footnote you enter is
1549 numbered 1.
1550 <p>
1551 <strong>.RESET_FOOTNOTE_NUMBER PAGE</strong> tells
1552 <strong>mom</strong> to start every page's footnote numbering at 1.
1555 If you don't want a footnote separator rule, toggle it off with
1556 <strong>.FOOTNOTE_RULE OFF</strong> (or <strong>END,
1557 QUIT, X</strong>...). Toggle it back on by invoking
1558 <strong>.FOOTNOTE_RULE</strong> with no argument. The default is to
1559 print the rule.
1561 <a name="FOOTNOTE_RULE_LENGTH"><h3><u>6. Footnote rule length -- FOOTNOTE_RULE_LENGTH</u></h3></a>
1562 If you want to change the length of the footnote separator rule,
1563 invoke <strong>.FOOTNOTE_RULE_LENGTH</strong> with a length, like
1564 this,
1565 <p>
1566 <pre>
1567 .FOOTNOTE_RULE_LENGTH 1i
1568 </pre>
1570 which sets the length to 1 inch. Note that a
1572 is required. The default is 4
1574 for both
1576 <a name="FOOTNOTE_RULE_ADJ"><h3><u>7. Adjust vertical position of footnote separator rule -- FOOTNOTE_RULE_ADJ</u></h3></a>
1577 The footnote separator rule is actually a baseline rule that falls
1578 on the
1580 of the first line of a page's footnotes. By default,
1581 <strong>mom</strong> raises the rule 3
1583 from the baseline so that the separator and the footnotes don't
1584 look jammed together. If you'd prefer a different vertical
1585 adjustment, invoke <strong>.FOOTNOTE_RULE_ADJ</strong> with the
1586 amount you'd like. For example
1587 <p>
1588 <pre>
1589 .FOOTNOTE_RULE_ADJ 4.25p
1590 </pre>
1592 raises the rule by 4-1/4 points. Note that you can only raise
1593 the rule, not lower it. A
1595 is required.
1596 <br>
1597 <hr>
1599 <!====================================================================>
1602 <ul>
1605 </ul>
1607 <p>
1608 The use of <strong>FINIS</strong> is optional. If you invoke it
1609 (at the end of a document, of course), <strong>mom</strong> turns off
1611 (if they're on) and page numbering (if page
1612 numbers are at the bottom of the page) and deposits the word
1613 END, centered after a blank line, beneath the last
1614 line of the document. END is enclosed between
1616 <p>
1617 If you're writing in a language other than English, you can
1618 change what <strong>mom</strong> prints for END with
1619 the control macro <strong>FINIS_STRING</strong>.
1620 <br>
1622 <!---FINIS--->
1625 <p>
1627 Macro: <strong>FINIS</strong>
1628 </a>
1630 <p>
1631 The use of <strong>FINIS</strong> is optional, but if you use
1632 it, it should be the last macro you invoke in a document. See
1634 for a description of how <strong>FINIS</strong> behaves.
1635 <p>
1636 <strong>NOTE:</strong> If you don't use <strong>FINIS</strong>,
1637 and you don't want
1639 (if they're on) or a page number at the bottom of the last page of
1640 a document, you have to turn them off manually, as the last two
1641 lines of your document file, like this:
1642 <p>
1643 <pre>
1644 .FOOTERS OFF
1645 .PAGINATE OFF
1646 </pre>
1650 <p>
1651 By default, <strong>FINIS</strong> prints the word
1652 END between
1654 If you'd like <strong>mom</strong> to print something else
1655 between the dashes, use the <strong>FINIS_STRING</strong> macro
1656 (anywhere in the document prior to <strong>FINIS</strong>).
1657 <p>
1658 For example, if your document's in French, you'd do
1659 <p>
1660 <pre>
1662 </pre>
1664 Double-quotes must enclose the macro's argument.
1665 <p>
1666 <strong>NOTE:</strong> If you pass <strong>FINIS_STRING</strong>
1667 a blank string, i.e.
1668 <p>
1669 <pre>
1671 </pre>
1673 <strong>mom</strong> will still print the em-dashes if you
1674 invoke <strong>FINIS</strong>. This, in effect, produces a
1675 short, centered horizontal rule that terminates the document.
1676 (In
1678 it's a short, dashed line composed of four hyphens.)
1680 <p>
1681 <hr>
1686 </body>
1687 </html>