| blob | 6f20ed12f65988715a54e055741ef34e680e2f63 |
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 (affecting 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>
230 <ul>
233 </ul>
235 <ul>
238 </ul>
240 </ul>
241 <hr>
244 <!====================================================================>
247 <ul>
250 </ul>
251 <p>
253 color, flavour, or comment on the document they precede. Typically,
254 they are centered at the top of a document's first page (underneath the
255 title) and set in a smaller point size than that of paragraph text.
256 <p>
259 this lets you input them on a line for line basis. This behaviour
260 can be changed to accomodate
263 <br>
265 <!---EPIGRAPH--->
268 <p>
271 </a>
273 <p>
275 <p>
276 <pre>
277 .EPIGRAPH
279 .EPIGRAPH OFF
280 </pre>
284 <p>
286 sets epigraphs
288 justified or quadded in the same direction as paragraphs, indented
289 equally from both the left and right margins.
290 <p>
291 If a block-style epigraph runs to more than one paragraph (unlikely,
295 tag.
296 <p>
298 used at the top of a document (i.e. just after
300 or after
302 recommended, but it does work. In all other places where you
303 want quotes or cited text, use
305 or
309 <p>
310 See
312 <p>
313 <pre>
314 .EPIGRAPH_FAMILY default = prevailing document family; default is Times Roman
315 .EPIGRAPH_FONT default = roman
316 .EPIGRAPH_SIZE default = -1.5 (points)
317 .EPIGRAPH_AUTOLEAD default = 2 points
321 .EPIGRAPH_QUAD default = same as paragraphs
324 *Indent here refers to the indent from both the left and right margins
325 that centres the block style epigraph on the page.
326 </pre>
327 <hr>
329 <!====================================================================>
332 <ul>
335 </ul>
336 <p>
337 The paragraph macro is the one you use most often. Consequently,
338 it's one of most powerful, yet simplest to use -- just the letters
340 on a line by itself any time, in any document element, tells
342 and indent appropriate to where you are in your document are taken
343 care of automatically.
344 <p>
346 of a document, nor paragraphs that fall immediately after
348 or
350 The first paragraphs of blockquotes and block-style epigraphs are
351 also not indented. This behaviour can be changed with the control
352 macro
354 <p>
356 deposit a blank line between paragraphs. If you want her to do so, use
358 using this macro with
360 <p>
362 control" for paragraphs (i.e. even if only one line of a paragraph
363 fits at the bottom of a page, she will set it on that page). The
364 reason for this is that writers of fiction often have single-line
365 paragraphs (e.g. in dialogue). Groff's simplistic orphan control
366 will break these one-liners -- if they fall at the bottom of the page
367 -- to a new page, which is not what you want.
368 <p>
370 and editing drafts of a document (particulary stories and chapters)
372 interruption in the flow of text is a serious obstacle to creativity
373 and critiquing.
374 <p>
375 I use the tab key on my keyboard to indent paragraphs when I'm writing,
376 producing a text file that looks pretty much like what you see on
377 a printed page. When it comes time to format and print the file,
378 I run it through a sed script that (amongst other things) converts
380 (plus a new line), and pipe the output to groff for processing and
381 printing.
382 <p>
383 Another solution is to insert a blank line between paragraphs.
384 The blank lines can then be sedded out at print time as above, or,
389 <p>
390 <pre>
391 .blm PP
392 </pre>
394 <br>
396 <!---PP--->
399 <p>
402 </a>
404 <p>
406 start a new paragraph. See
408 for more details. In addition to regular text paragraphs, you can
412 and
416 <p>
418 it were, the basis of everything that goes on in a document, its
419 control is managed in a manner somewhat different from other document
420 element tags.
421 <p>
422 <ol>
430 </ol>
433 The paragraph
435 is set with
437 prior to
439 or
441 afterwards. Please note that both globally affect the family of
442 every element in the document.
443 <p>
444 If you wish to change the family for regular
447 to differ from the prevailing document family.
448 <p>
450 is Times Roman.
453 To change the
456 which takes the same argument as
460 Only regular text paragraphs are affected; paragraphs in
463 and
465 remain at their default setting (medium roman) unless you change them
466 with the appropriate control macros.
467 <p>
471 The paragraph
473 is set with
475 prior to
477 or
479 afterwards. Please note that either method globally affects the
480 leading and spacing of every document element (except
482 and
484 <p>
485 If you wish to change the leading of regular text paragraphs only,
487 EVERY paragraph whose leading you wish to change.
488 <p>
492 of pages. Should you absolutely need to change paragraph leading
494 to get back on the right leading track, use the
496 macro.
497 <p>
499 is 16 points, adjusted to fill the page.
502 The justification/quad-direction of regular text paragraphs (i.e.
504 or
506 and
508 left/right/center) is set with
510 or
512 prior to
514 and with
516 afterwards.
517 <p>
518 Please note that either method of setting the paragraph
519 justification/quad-direction also affects
521 and
523 but not
525 (whose default is QUAD LEFT unless you change it with
527 The justification/quad-direction of epigraphs and footnotes may
528 be changed with their own control macros.
529 <p>
530 If you wish to change the justification/quad-direction of
533 Only the paragraph in question gets justified or quadded
534 differently; subsequent paragraphs remain unaffected.
535 <p>
537 paragraphs is justified for
539 and quad left for
543 The first-line indent of paragraphs is controlled by
546 or after
548 A
550 is required; fractional sizes are allowed. Thus, to set the paragraph
553 <p>
554 <pre>
555 .PARA_INDENT 4.5m
556 </pre>
558 In addition to establishing the basic first line-indent of
562 and
564 whose overal indenting from the left and (where applicable) right
566 first-line indent of paragraphs within these document elements (as well
569 <p>
571 ems for
576 <a name="PARA_INDENT_FIRST"><h3><u>6. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a>
578 of a document, nor the first paragraph after a head or
579 subhead, nor the first paragraphs of
582 or
584 that run to more than one paragraph.
586 <p>
587 If you wish to have first paragraphs indented, invoke the macro
589 before or after
593 its effect, meaning that first paragraphs will once again NOT be
594 indented.
598 between paragraphs. If you would like her to do so, invoke the
600 before or after
604 effect, meaning that paragraphs will once again NOT be separated by
605 a blank line.
606 <br>
607 <hr>
609 <!====================================================================>
612 <ul>
615 </ul>
616 <p>
618 -- should be used any place you want titles to introduce major
620 your heads for you. Head numbers can also be included
621 hierarchically in numbered
623 and
625 <p>
626 By default, heads are centered on the page, underlined,
627 all in caps. A double linespace precedes each head. In <a
629 are bold, slightly larger than paragraph text.
630 <p>
631 If these defaults don't suit you, you can change them with the
632 head control macros.
633 <br>
635 <!---HEAD--->
638 <p>
640 Macro: <strong>HEAD</strong> <var>"<text of head>" [ "<2nd line>" [ "<3rd line>" ... ] ]</var>
641 </a>
643 <p>
645 surrounded by double-quotes. If you need additional lines for a
646 head, simply surround each line with double-quotes.
647 <p>
650 one line of text underneath it</em>, she will set the head at the
651 top of the next page.
652 <p>
655 in a head (i.e. one of the lines surrounded by double-quotes) has
657 line-length (say, a narrow column measure), the head underline
658 (underscore) will not behave. You'll recognise the problem as soon
659 as you preview your document. If you encounter a head that
660 misbehaves with respect to underlining, the solution is to
663 <p>
665 <pre>
666 .HEAD "This is a very, very, very long head"
667 </pre>
668 into
669 <pre>
670 This is a very, very, very
671 long head
672 </pre>
674 you'll see the misbehaving underscore and should change the
676 <pre>
678 </pre>
681 <p>
682 There are, in addition to the usual family/font/size/quad control
683 macros, a number of macros to manage head numbering, spacing,
684 underlining, and so on. Check them out if you're unhappy with
686 <p>
687 <ol>
695 </ol>
696 <p>
698 <p>
699 See
701 <p>
702 <pre>
703 .HEAD_FAMILY default = prevailing document family; default is Times Roman
704 .HEAD_FONT default = bold
705 .HEAD_SIZE default = +1 (point)
706 .HEAD_QUAD default = CENTER
707 </pre>
711 of the
713 you give to
715 To change this behaviour, do
716 <p>
717 <pre>
718 .HEAD_CAPS OFF
719 </pre>
724 simply invoke it without an argument.
728 head. If you'd prefer just a single blank line, do
729 <p>
730 <pre>
731 .HEAD_SPACE OFF
732 </pre>
741 behaviour, do
742 <p>
743 <pre>
744 .HEAD_UNDERLINE OFF
745 </pre>
749 QUIT, Q, X</strong>...). To restore underlining of heads, invoke
753 If you'd like your heads numbered, simply invoke
755 will number all subsequent heads automatically (in ascending order,
756 naturally).
757 <p>
758 If, in addition to numbering heads, you also request that
760 and/or
762 be numbered, the head number will be included in their numbers
763 (each number separated by a period [dot]).
764 <p>
765 Should you wish to stop head numbering, invoke
767 END, X</strong>...). Head numbering will cease, and the head number
768 will not be included in the numbering of subheads and/or paraheads.
774 the next in ascending order (i.e. the last head number + 1), invoke
776 <p>
777 <pre>
778 .RESET_HEAD_NUMBER 6
779 </pre>
785 If you need to adjust the
787 position of a head (e.g. the head falls at the top of a column and
788 you want its
790 to line up with the ascenders of
792 in other columns), you can embed a vertical motion
794 (either
796 or
799 <p>
800 For example,
801 <p>
802 <pre>
803 .HEAD "\[ALD3]Text of head"
804 or
805 .HEAD "\[DOWN 3p]Text of head"
806 </pre>
808 will lower the baseline of the head by three points. Note that
809 there's no need to reverse the sense of the inline escape.
810 <p>
811 In the case of heads that run to more than one line, you must embed
812 the escape in the string for each line, like this:
813 <p>
814 <pre>
816 or
818 </pre>
823 <br>
824 <hr>
826 <!====================================================================>
829 <ul>
832 </ul>
833 <p>
834 Subheads should be used any place you want titles to introduce
836 can number subheads for you. Subhead numbers can also be included
837 hierarchically in numbered
839 <p>
840 By default, subheads are flush left. In
842 they are set bold, slightly larger than paragraph text. In
844 they are underlined. A single linespace precedes them in both
845 printstyles, and a tiny space adjustment raises them slightly
846 above text that comes afterwards for greater clarity in
847 document structuring.
848 <p>
849 If these defaults don't suit you, you can change them with the
850 subhead control macros.
851 <br>
853 <!---SUBHEAD--->
856 <p>
858 Macro: <strong>SUBHEAD</strong> <var>"<text of subhead>" [ "<2nd line>" [ "<3rd line>" ... ] ]</var>
859 </a>
860 <p>
862 surrounded by double-quotes. If you need additional lines for a
863 subhead, simply surround each line with double-quotes.
864 <p>
867 least one line of text underneath it</em>, she will set the subhead
868 at the top of the next page.
871 <p>
872 In addition to the usual family/font/size/quad control
873 macros, there are macros to manage subhead numbering.
874 <p>
875 <ol>
880 </ol>
881 <p>
883 <p>
884 See
886 <p>
887 <pre>
888 .SUBHEAD_FAMILY default = prevailing document family; default is Times Roman
889 .SUBHEAD_FONT default = bold
890 .SUBHEAD_SIZE default = +.5 (point)
891 .SUBHEAD_QUAD default = LEFT
892 </pre>
895 If you'd like your subheads numbered, simply invoke
898 (in ascending order, naturally).
899 <p>
900 If, in addition to numbering subheads, you also request that
902 be numbered, the head number will be included in the subhead number
903 (separated by a period [dot]).
904 <p>
905 Should you wish to stop subhead numbering, invoke
907 END, X</strong>...). Subhead numbering will cease, and the subhead
908 number will not be included in the numbering of paraheads.
910 <a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a>
914 the next in ascending order (i.e. the last subhead number + 1), invoke
916 <p>
917 <pre>
918 .RESET_SUBHEAD_NUMBER 4
919 </pre>
925 See
927 The information there applies equally to subheads.
930 <br>
931 <hr>
933 <!====================================================================>
936 <ul>
939 </ul>
940 <p>
941 Paragraph heads (paraheads) should be used any place you want titles
942 to introduce paragraphs below heads or subheads. If you wish,
944 <p>
945 By default, paraheads are joined to the body of a paragraph,
946 slightly indented (provided the paragraph is not a
949 In
951 they are set bold italic, slightly larger than paragraph text. In
953 they are underlined.
954 <p>
955 If these defaults don't suit you, you can change them with the
956 parahead control macros.
957 <br>
959 <!---PARAHEAD--->
962 <p>
965 </a>
966 <p>
969 or it will not work!
970 <p>
971 The argument is the text of the parahead, surrounded by double-quotes.
972 Because paraheads are joined to the body of a paragraph, they accept
973 only one argument (see
975 and
979 <p>
980 In addition to the family/font/size/indent control macros, there are
981 macros to manage parahead numbering.
982 <p>
983 <ol>
988 </ol>
989 <p>
991 <p>
992 See
994 <p>
995 <pre>
996 .PARAHEAD_FAMILY default = prevailing document family; default is Times Roman
997 .PARAHEAD_FONT default = bold italic
998 .PARAHEAD_SIZE default = +.5 (point)
999 </pre>
1002 Unlike other control macros that end in
1004 the argument to the macro that controls indenting of paragraph heads
1006 indent of normal paragraphs. In other words, it takes an absolute
1007 value, and requires a
1010 do:
1011 <p>
1012 <pre>
1013 .PARAHEAD_INDENT 2.5P
1014 </pre>
1016 the first-line indent of normal paragraphs (both printstyles).
1017 However, as stated above, if you choose to change the indent, you
1018 must give an absolute value (unless you're a groff expert and want
1022 <p>
1024 paragraphs", as defined in
1026 are not indented unless you turn
1028 on.
1031 If you'd like your paraheads numbered, simply invoke
1034 (in ascending order, naturally).
1035 <p>
1036 If, in addition to numbering paraheads, you also request that
1038 and
1040 be numbered, the head and/or subhead number will be included in the
1041 parahead number (separated by a period [dot]).
1042 <p>
1043 Should you wish to stop parahead numbering, invoke
1045 QUIT, END, X</strong>...). Parahead numbering will cease.
1047 <a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a>
1051 the next in ascending order (i.e. the last parahead number + 1), invoke
1053 <p>
1054 <pre>
1055 .RESET_PARAHEAD_NUMBER 7
1056 </pre>
1060 <br>
1061 <hr>
1063 <!====================================================================>
1066 <ul>
1069 </ul>
1070 <p>
1073 with three centered asterisks. You can change this behaviour
1074 with the linebreak character
1076 <br>
1078 <!---LINEBREAK--->
1081 <p>
1084 </a>
1086 <p>
1088 (on a line by itself, of course) whenever you want to insert an
1089 author linebreak. The appearance of the linebreak is controlled
1090 by the
1092 macro.
1095 <p>
1097 Macro: <strong>LINEBREAK_CHAR</strong> <var>[ <character> ] [ <iterations> [ <vertical adjustment> ] ]</var>
1098 </a>
1099 <br>
1100 <em>*The third optional argument requires a
1103 <p>
1106 optional arguments: the character you want deposited at the line
1107 break, the number of times you want the character repeated, and a
1108 vertical adjustment factor.
1109 <p>
1114 centered on the current line length.
1115 <p>
1116 The second argument is the number of times to repeat the character.
1117 <p>
1118 The third argument is a +|- value by which to raise (+) or lower (-)
1119 the character in order to make it appear visually centered between
1120 sections of text. This lets you make vertical adjustments
1121 to characters that don't sit on the
1123 (such as asterisks). The argument must be preceded by a plus or
1124 minus sign, and must include a unit of measure.
1125 <p>
1127 sections of text will be separated by two blank lines when you invoke
1129 <p>
1131 <p>
1132 <pre>
1134 </pre>
1136 i.e. three asterisks, lowered 3 points from their normal vertical
1137 position (for
1139 the vertical adjustment is -2 points for
1141 <br>
1142 <hr>
1144 <!====================================================================>
1147 <ul>
1150 </ul>
1151 <p>
1153 are always set in
1155 flush left. This permits entering quotes on a line for line basis in
1156 your text editor and have them come out the same way on output copy.
1157 (See
1159 for how quotes, in the present sense, differ from longer
1160 passages of cited text.)
1161 <p>
1163 the needs of creative writers (i.e. novelists, short story
1164 writers, etc. -- not to cast aspersions on the creativity of
1165 mathematicians and programmers), she sets quotes in italics
1167 or underlined
1169 indented from the left margin. Obviously, she's thinking
1171 quote control macros you can change her defaults so
1173 programming code, command line instructions, and so on.
1174 <p>
1177 off from
1179 with a small amount of vertical whitespace top and bottom. In
1181 this is always one full linespace. In
1185 if the quote fits fully on the page (i.e. with running text above
1186 and below it), otherwise it's a full linespace either above or below
1187 as is necessary to balance the page to the bottom margin. This
1188 behaviour can be changed with the control macro
1190 <p>
1192 applies to both
1194 and
1196 as does the control macro
1198 <br>
1200 <!---QUOTE--->
1203 <p>
1206 </a>
1208 <p>
1210 quoted text, invoke it with no argument, then type in your quote.
1212 argument (e.g. OFF, END, X, Q...) to turn it off. Example:
1213 <p>
1214 <pre>
1215 .QUOTE
1216 Nymphomaniacal Jill
1217 Used a dynamite stick for a thrill
1218 They found her vagina
1219 In North Carolina
1220 And bits of her tits in Brazil.
1221 .QUOTE END
1222 </pre>
1225 <ol>
1230 </ol>
1231 <p>
1233 <p>
1234 See
1236 <p>
1237 <pre>
1238 .QUOTE_FAMILY default = prevailing document family; default is Times Roman
1239 .QUOTE_FONT default = italic
1240 .QUOTE_SIZE default = +0 (i.e. same size as paragraph text)
1241 <a name="QUOTE_INDENT">.QUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
1242 (note that this macro also sets the indents (left and right)
1243 for blockquotes)
1244 </pre>
1246 <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
1250 default behaviour regarding the spacing of quotes (see
1252 invoke the macro with any argument (<strong>OFF, QUIT, END,
1253 X</strong>...)
1254 <p>
1256 spacing policy for
1259 <a name="UNDERLINE_QUOTES"><h3><u>3. Underlining -- UNDERLINE_QUOTES (typewrite only)</u></h3></a>
1260 By default in
1266 default underlining of quotes.
1267 <p>
1269 quotes, but also that she set them in italic, you must follow each
1275 is enabled (see
1279 Exceptionally, a quote or blockquote containing a footnote may cross
1280 a page or column. When this happens, the footnote marker may not be
1281 correct for its position relative to other footnotes on the page, and
1282 the footnote itself may appear on the wrong page or at the bottom of
1283 the wrong column. When this happens, study your output to determine
1284 the precise point at which the quote breaks (or at which you want
1286 afterwards. No other intervention is required, and the footnote(s)
1287 will be marked correctly and appear on the correct page.
1288 <p>
1290 blockquotes, and hence is aliased as <strong>BREAK_BLOCKQUOTE,
1292 <br>
1293 <hr>
1295 <!====================================================================>
1298 <ul>
1301 </ul>
1302 <p>
1304 author's work. So that they stand out well from
1307 and sets them in a different point size
1309 only).
1311 are
1313 and, by default,
1315 left.
1316 <p>
1318 off from running text with a small amount of vertical whitespace top
1319 and bottom. (See
1321 for a complete explanation of how this is managed, and how to control it.)
1322 <p>
1324 control
1326 although you can change the point size. There are Very Good
1327 Reasons for this. If you can't live with the limitation, change
1328 the leading of blockquotes (after invoking the tag) with
1330 but know that there will be Bottom Margin Consequences unless you
1331 use the
1333 macro after you turn the blockquote off.
1334 <br>
1336 <!---BLOCKQUOTE--->
1339 <p>
1342 <br>
1344 </a>
1346 <p>
1348 cited passage, invoke the tag with no argument, then type in your quote.
1350 argument (e.g. OFF, END, X, Q...) to turn it off. Example:
1351 <p>
1352 <pre>
1353 .BLOCKQUOTE
1354 Redefining the role of the United States from enablers to keep
1355 the peace to enablers to keep the peace from peacekeepers is
1356 going to be an assignment.
1357 .RIGHT
1358 \(emGeorge W. Bush
1359 .BLOCKQUOTE END
1360 </pre>
1362 If the cited passage runs to more than one paragraph, you MUST
1364 with
1366 <p>
1371 in any of the tag's control macros.
1374 <ol>
1377 <li><a href="#BREAK_QUOTE">Manually break a footnoted blockquote that crosses pages/columns</a>
1378 </ol>
1379 <p>
1381 <p>
1382 See
1384 <p>
1385 <pre>
1386 .BLOCKQUOTE_FAMILY default = prevailing document family; default is Times Roman
1387 .BLOCKQUOTE_FONT default = italic
1388 .BLOCKQUOTE_SIZE default = -1 (point)
1390 (note that this macro also sets the left indent for quotes)
1391 </pre>
1393 <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
1397 default behaviour regarding the spacing of blockquotes (see
1399 invoke the macro with any argument (<strong>OFF, QUIT, END,
1400 X</strong>...).
1401 <p>
1403 spacing policy for
1405 <br>
1406 <hr>
1408 <!====================================================================>
1411 <ul>
1415 </ul>
1417 <p>
1418 For something so complex behind the scenes, footnotes are easy to use.
1419 You just type, for example
1420 <p>
1422 <pre>
1423 ...the doctrines of Identity as urged by Schelling\c
1424 .FOOTNOTE
1426 .FOOTNOTE OFF
1427 were generally the points of discussion presenting the most
1428 of beauty to the imaginative Morella.
1429 </pre>
1431 and be done with it. (Note the obligatory use of the
1435 putting footnote markers in the body of the document, keeping track
1436 of how many footnotes are on the page, identifying the footnotes
1437 themeselves appropriately, balancing them properly with the botton
1438 margin, deferring footnotes that don't fit on the page... Even if
1439 you're using
1442 <p>
1443 Footnotes can be sly little beasts, though. If you're writing a
1444 document that's footnote-heavy, you might want to read the following.
1447 <p>
1449 alternating stars (asterisks) and daggers. The first footnote
1450 gets a star, the second a dagger, the third two stars,
1451 the fourth two daggers, etc. If you prefer numbered footnotes, rest
1453 <p>
1454 A small amount of vertical whitespace and a short horizontal rule
1455 separate footnotes from the document body. The amount of whitespace
1456 varies slightly from page to page depending on the number of lines
1458 between too little whitespace and too much, but when push comes to
1459 shove, she'll opt for ample over cramped. The last lines of footnotes
1460 are always flush with the document's bottom margin.
1461 <p>
1463 be fit on its page, she carries that portion over to the next
1464 page. If an entire footnote can't be fitted on its page (i.e.
1466 she defers the footnote to the next page, but sets it with the
1467 appropriate marker from the previous page.
1468 <p>
1469 In the unfortunate happenstance that a deferred footnote is the
1470 only footnote on its page (i.e. it's marked in the document body with
1471 a star) and the page it's deferred to has its own footnotes,
1473 proper footnote(s) with a blank line. This avoids the confusion that
1474 might result from readers seeing two footnote entries on the same page
1475 identified by a single star (or the number 1 if you've requested
1476 numbered footnotes that begin at 1 on every page). The blank line
1477 makes it clear that the first footnote entry belongs to the previous
1478 page.
1479 <p>
1480 In the circumstance where a deferred footnote is not the only one on
1481 its page, and is consequently marked by something other than a single
1483 with the blank line. (By convention, the first footnote on a page is
1484 always marked with a single star, so if readers see, say, a dagger or two
1485 stars marking the first footnote entry, they'll know the entry belongs
1486 to the previous page).
1487 <p>
1488 Obviously, deferred footnotes aren't an issue if you request numbered
1489 footnotes that increase incrementally throughout the whole document --
1491 <p>
1492 Exceptionally, you may encounter problems with footnotes inside
1493 quotes and blockquotes that cross a page or column. See
1495 for a solution.
1496 <br>
1498 <!---FOOTNOTE--->
1501 <p>
1503 Macro: <strong>FOOTNOTE</strong> <var><toggle> | INDENT LEFT | RIGHT | BOTH <indent value></var>
1504 <br>
1506 <br>
1509 </a>
1511 <p>
1513 on a line by itself allows you to enter a footnote in the body of a
1516 you're finished.
1517 <p>
1518 Footnotes are the only element of
1520 that are not affected by the typesetting
1522 In the unlikely event that you want a page's footnotes to line
1530 not save any footnote indent information from invocation to
1531 invocation.
1532 <p>
1535 the
1538 <p>
1540 The final word on the
1543 with a
1545 inline escape. Otherwise, the footnote marker for the word won't be attached to
1547 and the marker). See the
1549 above.
1551 <p>
1553 <ol>
1557 <li><a href="#RESET_FOOTNOTE_NUMBER">Reset footnote number</a> -- set footnote marker number to 1
1559 <li><a href="#FOOTNOTE_RULE_LENGTH">Footnote rule length</a> -- length of footnote separator rule
1561 </ol>
1562 <p>
1564 <p>
1565 See
1567 <p>
1568 <pre>
1569 .FOOTNOTE_FAMILY default = prevailing document family; default is Times Roman
1570 .FOOTNOTE_FONT default = roman
1571 .FOOTNOTE_SIZE default = -2 (points)
1572 .FOOTNOTE_AUTOLEAD default = 2 points (typeset); single-spaced (typewrite)
1573 .FOOTNOTE_QUAD default = same as paragraphs
1574 </pre>
1577 If you don't want footnote markers, in either the body of
1578 the document or beside footnote entries themselves, toggle
1581 you'll have to roll your own. If you want them back on, invoke
1583 are on by default.
1585 <a name="FOOTNOTE_MARKER_STYLE"><h3><u>3. Footnote marker style -- FOOTNOTE_MARKER_STYLE</u></h3></a>
1587 star+dagger (see
1589 above), or numbered.
1590 <p>
1592 (the default). There is a limit of 10 footnotes per page with
1593 this style.
1594 <p>
1596 numbers, both in the document body and in the footnote entries
1597 themselves. By default, footnote numbers increase incrementally
1598 (prev. footnote number + 1) throughout the whole document. You can
1602 <a name="RESET_FOOTNOTE_NUMBER"><h3><u>4. Reset footnote number -- RESET FOOTNOTE NUMBER</u></h3></a>
1604 footnote numbering so that the next footnote you enter is
1605 numbered 1.
1606 <p>
1611 If you don't want a footnote separator rule, toggle it off with
1613 QUIT, X</strong>...). Toggle it back on by invoking
1615 print the rule.
1617 <a name="FOOTNOTE_RULE_LENGTH"><h3><u>6. Footnote rule length -- FOOTNOTE_RULE_LENGTH</u></h3></a>
1618 If you want to change the length of the footnote separator rule,
1620 this,
1621 <p>
1622 <pre>
1623 .FOOTNOTE_RULE_LENGTH 1i
1624 </pre>
1626 which sets the length to 1 inch. Note that a
1628 is required. The default is 4
1630 for both
1632 <a name="FOOTNOTE_RULE_ADJ"><h3><u>7. Adjust vertical position of footnote separator rule -- FOOTNOTE_RULE_ADJ</u></h3></a>
1633 The footnote separator rule is actually a baseline rule that falls
1634 on the
1636 of the first line of a page's footnotes. By default,
1639 from the baseline so that the separator and the footnotes don't
1640 look jammed together. If you'd prefer a different vertical
1642 amount you'd like. For example
1643 <p>
1644 <pre>
1645 .FOOTNOTE_RULE_ADJ 4.25p
1646 </pre>
1649 the rule, not lower it. A
1651 is required.
1652 <br>
1653 <hr>
1655 <!====================================================================>
1658 <ul>
1661 </ul>
1663 <p>
1665 (at the end of a document before
1667 or
1671 (if they're on) and page numbering (if page
1672 numbers are at the bottom of the page) and deposits the word
1673 END, centered after a blank line, beneath the last
1674 line of the document. END is enclosed between
1676 <p>
1677 If you're writing in a language other than English, you can
1680 <br>
1682 <!---FINIS--->
1685 <p>
1688 </a>
1690 <p>
1692 it, it should be the last macro you invoke in a document (before
1694 or
1696 See
1699 <p>
1701 and you don't want
1703 (if they're on) or a page number at the bottom of the last page of
1704 a document, you have to turn them off manually, as the last two
1705 lines of your document file, like this:
1706 <p>
1707 <pre>
1708 .FOOTERS OFF
1709 .PAGINATE OFF
1710 </pre>
1714 <p>
1716 END between
1721 <p>
1722 For example, if your document's in French, you'd do
1723 <p>
1724 <pre>
1725 .FINIS_STRING "FIN"
1726 </pre>
1728 Double-quotes must enclose the macro's argument.
1729 <p>
1731 a blank string, i.e.
1732 <p>
1733 <pre>
1734 .FINIS_STRING ""
1735 </pre>
1739 short, centered horizontal rule that terminates the document.
1740 (In
1742 it's a short, dashed line composed of four hyphens.)
1744 <br>
1745 <hr>
1747 <!====================================================================>
1750 <ul>
1752 <ul>
1755 </ul>
1759 </ul>
1761 <p>
1763 the same way as embedding
1765 identical to the one shown in the
1769 <p>
1771 <pre>
1772 ...the doctrines of Identity as urged by Schelling\c
1773 .ENDNOTE
1775 .ENDNOTE OFF
1776 were generally the points of discussion presenting the most
1777 of beauty to the imaginative Morella.
1778 </pre>
1782 <p>
1783 Endnotes differ from footnotes in two ways (other than the fact that
1784 endnotes come at the end of a document whereas footnotes appear in the
1785 body of the document):
1786 <br>
1787 <ol>
1788 <li>Endnotes are always numbered incrementally throughout a
1789 document. In other words, you don't get a choice of marker styles,
1790 as you do with footnotes.
1792 not output them for you. In
1794 documents, this allows you to choose whether you
1795 want the endnotes to appear at the end of each chapter or
1796 section, or grouped together at the very end of the document.
1797 </ol>
1798 <p>
1799 Within endnotes, you may use the document element tags
1802 and
1804 This provides the flexibility to create endnotes that run to several
1805 paragraphs, as well as to embed cited text within endnotes.
1806 <p>
1807 Should you wish to change the appearance of quotes or blockquotes that
1808 appear within endnotes, you may do so with the
1810 or
1814 undo them prior to terminating the endnote (i.e. before <strong>ENDNOTE
1815 OFF</strong>), otherwise the changes will affect subsequent quotes and
1816 blockquotes that appear in the document body as well.
1819 <p>
1820 When you output endnotes (with
1823 then breaks to a new page for printing the endnotes. If the document
1824 type is
1826 the centre part of the
1828 (or footer), which, by default, contains a chapter number or title, is
1829 removed.
1830 <p>
1833 Underneath--flush left, bold, and underscored--she prints the document
1834 title (or, in the case of chapters, the chapter number or title). She
1835 then prints the endnotes. Each endnote is identified by its appropriate
1836 number, in bold, right aligned to two placeholders. The text of the
1837 endnotes themselves is indented to the right of the numbers.
1838 <p>
1839 If the endnotes are grouped together at the end of a collated document,
1840 each section of the document that contains endnotes is identified by its
1841 own unique title (or chapter number or title), bold, flush left, and
1842 underscored.
1843 <p>
1844 Of course, all the defaults, as well as the overall style of the
1845 endnotes page, can be changed with the
1847 The attentive will notice that endnotes have an awful lot of control
1848 macros. This is because endnotes are like a mini-document unto
1849 themselves, and therefore need not be bound by the style parameters of
1850 the body of the document.
1854 </a>
1855 <p>
1856 On the endnotes page(s), each new endnote is separated from the
1857 previous endnote by a full line space. This can result in a bottom
1858 margin that hangs, and is the one instance, other than the use of
1861 Should you wish to correct this, by adding or subtracting small amounts
1862 of space between endnotes that appear together on an endnote page, make
1863 the adjustment (with
1866 or
1870 rather than at the top.
1874 </a>
1875 <p>
1876 Formerly (pre 1.1.6), there was no way to set a document in columns
1877 (see
1879 and then turn off column mode for endnotes. As of version 1.1.6,
1880 you may now do so. See
1882 <br>
1883 <hr>
1885 <!---ENDNOTE--->
1887 <p>
1890 <br>
1892 </a>
1894 <p>
1896 on a line by itself allows you to enter an endnote in the body of a
1897 document. Invoking it with any other argument
1899 that you've finished the endnote.
1900 <p>
1905 <p>
1907 The final word on the
1910 with a
1912 inline escape. Otherwise, the endnote number for the word won't be attached to
1914 and the number). See the
1916 above.
1917 <br>
1919 <!---ENDNOTES--->
1922 <p>
1925 <p>
1927 bottom of pages, endnotes must be explicitly output by you, the user.
1929 the macro to do this.
1930 <p>
1932 a document. If it's a single (i.e. not collated) document,
1935 contained within all sections of the document (typically chapters),
1936 appropriately identified and numbered.
1937 <p>
1938 Should you wish to output the endnotes for each section of a collated
1939 document at the ends of the sections (instead of at the very end of the
1943 appropriately, on a separate page prior to starting the next section of
1946 after the previous invocation.
1947 <br>
1951 <p>
1952 Every time you embed an endnote in the body of a document,
1954 later outputting when you invoke
1956 For this reason, endnote control macros should always be invoked prior
1957 to the first instance of
1959 <br>
1960 <ol>
1962 <ul>
1967 <li><a href="#ENDNOTE_PARA_INDENT">Size of paragraph first line indent in multi-paragraph endnotes</a>
1968 <li><a href="#ENDNOTE_PARA_SPACE">Inserting space between paragraphs of multi-paragraph endnotes</a>
1970 <li>Pagination of endnotes
1971 <ul>
1974 <li><a href="#ENDNOTES_NO_FIRST_PAGENUM">Omitting a page number on the first page of endnotes</a>
1975 </ul>
1977 </ul>
1978 <li><a href="#ENDNOTES_HEADER_CONTROL"><strong>Endnotes-page header/footer control</strong></a>
1979 <ul>
1980 <li><a href="#ENDNOTES_MODIFY_HDRFTR">Modifying what goes in the endnotes-pages header/footer</a>
1981 <li><a href="#ENDNOTES_HDRFTR_CENTER">Enabling a header/footer centre when doctype is CHAPTER</a>
1983 </ul>
1984 <li><a href="#ENDNOTES_MAIN_TITLE"><strong>Endnotes-page head (i.e. the title at the top) control</strong></a>
1985 <ul>
1990 </ul>
1992 <ul>
1996 </ul>
1998 <ul>
2001 <ul>
2004 </ul>
2005 </ul>
2006 </ol>
2007 <hr>
2012 <p>
2013 See
2015 <p>
2016 <pre>
2017 .ENDNOTE_FAMILY default = prevailing document family; default is Times Roman
2018 .ENDNOTE_FONT default = roman
2019 .ENDNOTE_QUAD default = justified
2020 </pre>
2022 <!---ENDNOTE_PT_SIZE--->
2025 <p>
2028 <p>
2029 Unlike most other control macros that deal with size of document
2031 absolute value, relative to nothing. Therefore, the argument represents
2032 the size of endnote type in
2034 unless you append an alternative
2036 For example,
2037 <p>
2038 <pre>
2039 .ENDNOTE_PT_SIZE 12
2040 </pre>
2042 sets the base point size of type on the endnotes page to 12
2043 points, whereas
2044 <p>
2045 <pre>
2046 .ENDNOTE_PT_SIZE .6i
2047 </pre>
2050 inch.
2051 <p>
2053 type used for the text of the endnotes, and forms the basis from which
2054 the point size of other endnote page elements is calculated.
2055 <p>
2056 The default for
2058 is 12.5 points (the same default size used in the body of the document).
2060 <!---ENDNOTE_LEAD--->
2063 <p>
2065 <br>
2066 <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
2068 <p>
2069 Unlike most other control macros that deal with leading of document
2071 absolute value, relative to nothing. Therefore, the argument represents
2072 the
2074 of endnotes in
2076 unless you append an alternative
2078 For example,
2079 <p>
2080 <pre>
2081 .ENDNOTE_LEAD 14
2082 </pre>
2084 sets the base leading of type on the endnotes page to 14
2085 points, whereas
2086 <p>
2087 <pre>
2088 .ENDNOTE_LEAD .5i
2089 </pre>
2092 <p>
2093 If you want the leading of endnotes adjusted to fill the page, pass
2097 for an explanation of leading adjustment.)
2098 <p>
2099 The default for
2101 is 14 points, adjusted.
2102 <p>
2105 default, adjust endnote leading. You MUST enter
2109 <!---SINGLESPACE_ENDNOTES--->
2112 <p>
2115 <p>
2116 If your
2119 double-spacing, endnotes are double-spaced. If your document is
2120 single-spaced, endnotes are single-spaced.
2121 <p>
2122 If, for some reason, you'd prefer that endnotes be single-spaced
2123 in an otherwise double-spaced document (including double-spaced
2126 god help you, you want to change endnote single-spacing back to
2127 double-spacing for different spacing of endnotes output at the ends
2128 of separate docs in a collated doc, invoke
2130 QUIT, Q, X</strong>...).
2132 <!---ENDNOTE_PARA_INDENT--->
2135 <p>
2136 Macro: <strong>ENDNOTE_PARA_INDENT</strong> <var><amount to indent first line of paragraphs in endnotes></var>
2137 <br>
2140 <p>
2143 except that the indent given is the amount by which to indent the first
2144 lines of endnote paragraphs, not document body paragraphs.
2145 <p>
2146 The default is 1.5
2148 for
2153 <p>
2155 (the one attached immediately to the identifying endnote number) is
2156 never indented. Only subsequent paragraphs are affected by
2159 <!---ENDNOTE_PARA_SPACE--->
2162 <p>
2165 <p>
2168 except that it inserts a blank line between endnote paragraphs, not
2169 document body paragraphs.
2170 <p>
2171 The default is not to insert a blank line between paragraphs in
2172 endnotes.
2173 <p>
2176 refers only to paragraphs that appear within each discrete endnote.
2178 <!---ENDNOTES_NO_COLUMNS--->
2180 <a name="ENDNOTES_NO_COLUMNS"><h3><u>*Turning off column mode during endnotes output</u></h3></a>
2181 <p>
2184 <p>
2185 By default, if your document is
2188 if your document is set in columns and you'd like the endnotes not
2190 argument. The endnotes pages will be set to the full page measure
2191 of your document.
2192 <p>
2193 If you output endnotes at the end of each document in a
2195 document set in columns, column mode will automatically
2196 be reinstated for each document, even with
2199 <!---ENDNOTES_PAGENUM_STYLE--->
2202 <p>
2203 Macro: <strong>ENDNOTES_PAGENUM_STYLE</strong> <var>DIGIT | ROMAN | roman | ALPHA | alpha</var>
2205 <p>
2206 Use this macro to set the page numbering style of endnotes pages.
2207 The arguments are identical to those for
2211 <p>
2212 <pre>
2213 .ENDNOTES_PAGENUM_STYLE alpha
2214 </pre>
2216 <!---ENDNOTES_FIRST_PAGENUMBER--->
2218 <a name="ENDNOTES_FIRST_PAGENUMBER"><h3><u>*Setting the first page number of endnotes pages</u></h3></a>
2219 <p>
2220 Macro: <strong>ENDNOTES_FIRST_PAGENUMBER</strong> <var><page # that appears on page 1 of endnotes></var>
2222 <p>
2223 Use this macro with caution. If all endnotes for several
2225 documents are to be output at once, i.e. not at the end of each
2228 the endnotes.
2229 <p>
2231 documents where the endnotes are output after each separate doc,
2232 you have to reset every separate document's first page number after
2234 and before
2237 <!---ENDNOTES_NO_FIRST_PAGENUN--->
2239 <a name="ENDNOTES_NO_FIRST_PAGENUM"><h3><u>*Omitting a page number on the first page of endnotes</u></h3></a>
2240 <p>
2243 <p>
2245 tells
2247 not to print a page number on the first endnotes page.
2250 <!---SUSPEND_PAGINATION--->
2253 <p>
2255 <br>
2258 <p>
2260 Invoked immediately prior to
2263 continues, however to increment page numbers silently.
2264 <p>
2265 To restore normal document pagination after endnotes, invoke
2270 <p>
2272 If you wish to modify what appears in the header/footer that appears
2273 on endnotes page(s), make the changes before you invoke
2275 not afterwards.
2276 <p>
2277 Except in the case of
2280 the document on the endnotes page(s). Chapters get treated differently
2282 header/footer centre string (normally the chapter number or chapter
2283 title.) In most cases, this is what you want. However, should you
2285 the endnotes page(s) headers/footers, invoke
2287 with no argument.
2288 <p>
2289 An important change you may want to make is to put the word
2291 To do so, do
2292 <p>
2293 <pre>
2294 .HEADER_CENTER "Endnotes"
2295 or
2296 .FOOTER_CENTER "Endnotes"
2297 </pre>
2305 <a name="ENDNOTES_HDRFTR_CENTER"><h3><u>*Endnotes page(s) header/footer center string</u></h3></a>
2306 <p>
2309 <p>
2310 If your
2313 a centre string in the headers/footers that appear on endnotes pages,
2317 <p>
2318 If, for some reason, having enabled the header/footer center string
2319 on endnotes pages, you wish to disable it, invoke the same macro
2323 <p>
2326 <p>
2328 prints page headers on all endnotes pages except the first. If you
2329 don't want her to print headers on endnotes pages, do
2330 <p>
2331 <pre>
2332 .ENDNOTES_ALLOWS_HEADERS OFF
2333 </pre>
2336 <p>
2337 <pre>
2338 .ENDNOTES_ALLOWS_HEADERS ALL
2339 </pre>
2348 <!---ENDNOTE_STRING--->
2351 <p>
2352 Macro: <strong>ENDNOTE_STRING</strong> <var>"<head to print at the top of endnotes>"</var>
2354 <p>
2356 as a head at the top of the first page of endnotes. If you want her
2358 the endnotes-page head you want, surrounded by double-quotes. If
2359 you don't want a head at the top of the first endnotes-page, invoke
2362 at all).
2364 <!---ENDNOTE_STRING_CONTROL--->
2366 <a name="ENDNOTE_STRING_CONTROL"><h3><u>*Endnotes-page first page head (title) control</u></h3></a>
2367 <p>
2368 See
2370 <p>
2371 <pre>
2372 .ENDNOTE_STRING_FAMILY default = prevailing document family; default is Times Roman
2373 .ENDNOTE_STRING_FONT* default = bold
2374 .ENDNOTE_STRING_SIZE default = +1
2375 .ENDNOTE_STRING_QUAD default = centered
2377 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
2378 </pre>
2380 <!---ENDNOTE_STRING_UNDERSCORE--->
2382 <a name="ENDNOTE_STRING_UNDERSCORE"><h3><u>*Endnotes-page head (title) underscoring</h3></u></a>
2383 <p>
2386 <p>
2388 underscore the endnotes-page head. Invoked with the argument 2
2390 double-underscore the head. Invoked with any other argument, the macro
2391 disables underscoring of the head.
2392 <p>
2394 head, therefore if you want no underscoring, you must insert
2396 NONE,</kbd> etc.) into your document prior to outputting endnotes with
2399 <!---ENDNOTE_STRING_CAPS--->
2401 <a name="ENDNOTE_STRING_CAPS"><h3><u>*Endnotes-page head (title) automatic capitalisation</h3></u></a>
2402 <p>
2405 <p>
2407 automatically capitalise the endnotes-page head. Invoked with any
2408 other argument, the macro disables automatic capitalisation of the
2409 head.
2410 <p>
2411 If you're generating a table of contents, you may want the
2412 endnotes-pages head string in caps, but the toc entry in caps/lower
2413 case. If the argument to
2416 on, this is exactly what will happen.
2417 <p>
2419 head string.
2421 <!---ENDNOTE_TITLE--->
2425 <p>
2426 Macro: <strong>ENDNOTE_TITLE</strong> <var>"<title to identify a document in endnotes>"</var>
2428 <p>
2430 endnotes belong by the document title(s) given to the
2432 macro. If you'd want her to identify the document(s) another way,
2434 title you want, surrounded by double-quotes.
2435 <p>
2436 If you don't want any identifying title, invoke
2439 argument at all). This is particularly useful if you have a single
2440 (i.e. non-collated) document and find having the document's title
2441 included in the endnotes redundant.
2443 <!---ENDNOTE_TITLE_CONTROL--->
2445 <a name="ENDNOTE_TITLE_CONTROL"><h3><u>*Endnote document-identification title control</u></h3></a>
2446 <p>
2447 See
2449 <p>
2450 <pre>
2451 .ENDNOTE_TITLE_FAMILY default = prevailing document family; default is Times Roman
2452 .ENDNOTE_TITLE_FONT default = bold
2453 .ENDNOTE_TITLE_SIZE* default = 0
2454 .ENDNOTE_TITLE_QUAD default = left
2456 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
2457 </pre>
2459 <!---ENDNOTE_TITLE_UNDERSCORE--->
2461 <a name="ENDNOTE_TITLE_UNDERSCORE"><h3><u>*Endnote document-identification title underscoring</h3></u></a>
2462 <p>
2465 <p>
2467 underscore the endnote document-identification title(s). Invoked with any
2468 other argument, the macro disables underscoring of the title(s).
2469 <p>
2470 <strong>Mom</strong>'s default is to underscore the document-identification title, therefore if you want no underscoring, you must
2472 NONE,</kbd> etc.) into your document prior to outputting endnotes with
2475 <!---ENDNOTE_NUMBERING--->
2480 <p>
2481 See
2483 <p>
2484 Please note that the control macros for endnote numbering affect only
2485 the numbers that appear on the endnotes pages themselves, not the
2486 endnote numbers that appear in the body of the document(s).
2487 <p>
2488 <pre>
2489 .ENDNOTE_NUMBER_FAMILY default = prevailing document family; default is Times Roman
2490 .ENDNOTE_NUMBER_FONT default = bold
2491 .ENDNOTE_NUMBER_SIZE* default = 0
2493 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
2494 </pre>
2497 <p>
2499 aligned right to two placeholders, producing this:
2500 <p>
2502 <pre>
2503 9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2504 sed diam nonumy eirmod tempor invidunt ut labore et
2505 dolore magna aliquyam erat, sed diam voluptua.
2507 10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2508 sed diam nonumy eirmod tempor invidunt ut labore et
2509 dolore magna aliquyam erat, sed diam voluptua.
2510 </pre>
2512 The macros to alter this behaviour are
2513 <br>
2514 <ul>
2517 </ul>
2518 <br>
2521 <!---ENDNOTE_NUMBERS_ALIGN_RIGHT--->
2523 <p>
2526 </a>
2527 <p>
2529 argument: the number of placeholders to reserve for right alignment of
2530 endnote numbers.
2531 <p>
2532 For example, if you have fewer than ten endnotes, you might want to do
2533 <p>
2534 <pre>
2535 .ENDNOTE_NUMBERS_ALIGN_RIGHT 1
2536 </pre>
2538 which would ensure that the endnote numbers hang, but are all flush
2539 with the page's left margin. If, god help you, you have over a hundred
2540 endnotes, you'd want to do
2541 <p>
2542 <pre>
2543 .ENDNOTE_NUMBERS_ALIGN_RIGHT 3
2544 </pre>
2546 to ensure that the numbers hang and are properly right-aligned.
2547 <br>
2550 <!---ENDNOTE_NUMBERS_ALIGN_LEFT--->
2552 <p>
2555 </a>
2556 <p>
2557 If you don't want the endnote numbers to hang and right-align, invoke
2559 argument. This disables hanging and right-alignment of endnote numbers,
2560 so that the example
2562 comes out like this:
2563 <p>
2564 <pre>
2565 9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2566 sed diam nonumy eirmod tempor invidunt ut labore et
2567 dolore magna aliquyam erat, sed diam voluptua.
2569 10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2570 sed diam nonumy eirmod tempor invidunt ut labore et
2571 dolore magna aliquyam erat, sed diam voluptua.
2572 </pre>
2574 <br>
2575 <hr>
2577 <!====================================================================>
2580 <ul>
2584 </ul>
2586 <p>
2587 Want a table of contents for your document? Easy. Just enter
2588 <p>
2589 <pre>
2590 .TOC
2591 </pre>
2594 will have picked up all document titles (in
2596 documents), all heads, subheads, and paragraph heads, as well as any
2597 endnotes pages that have been output, and assigned them the
2598 appropriate page number (and page numbering style). Talk about a
2599 no-brainer!
2601 That said, tables of contents (tocs) have even more control macros
2602 than endnotes. As always, the reason for so many control macros is
2603 so that if you want to change just about any aspect of the toc's
2605 simplicity AND flexibility.
2608 <p>
2609 When you output a toc (with
2612 then breaks to a new page for printing the toc.
2613 <p>
2615 tables of contents. To this end, if
2617 are on for the document, the first page of the toc has no page
2618 header, but does have a first page (roman numeral) number, always
2621 are on for the document, the first page has neither a footer, nor a
2622 page number in the top margin. (If you absolutely must have a page
2623 footer on the first page of the toc, simply invoke
2626 both page headers or footers and a page number.
2627 <p>
2628 Entries in the toc are hierarchically indented, as you would
2629 expect. By default, each type of entry (e.g. a head or a subhead)
2630 is set in a different font as well. If any of heads, subheads or
2631 paragraph heads are numbered in the body of the document, they are
2632 also numbered in the toc. Head numbering in the toc is NOT
2633 concatenated as it is in the body of the document, which would be
2634 visually redundant in a toc.
2635 <p>
2636 Tocs are never set in columns, regardless of whether the rest of
2637 the document is. Lastly, if
2639 printing is enabled, the toc respects it. This sometimes leads to
2640 tocs that begin with the wrong margins, but the margins can be
2641 corrected either by outputting a
2643 or by using the toc control macro
2645 <p>
2646 The overall toc
2649 and
2651 can be altered with the toc
2653 as can the family,
2655 point size and indent of each type of toc entry (i.e. title, head,
2656 subhead, paragraph head). Furthermore, the page numbering style
2657 can be changed, as can the amount of visual space reserved for toc
2658 entry page numbers.
2659 <br>
2661 <!---TOC--->
2664 <p>
2667 <p>
2670 <br>
2674 <p>
2676 collects them, so you can put any toc control macros anywhere you
2677 like in your document. Some may prefer to place them at the top of
2678 the file. Others may prefer to place them just before outputting
2679 the toc. The choice is yours.
2680 <br>
2681 <ol>
2683 <ul>
2687 </ul>
2689 <ul>
2692 </ul>
2693 <li><a href="#TOC_HEADER"><strong>Changing the toc header (title), string and style</strong></a>
2694 <ul>
2697 </ul>
2699 <ul>
2706 </ul>
2708 <ul>
2712 </ul>
2713 </ol>
2714 <hr>
2719 <p>
2720 See
2722 <p>
2724 establishes the default family for every element of a toc page,
2726 in the top or bottom margin. The default is the prevailing document
2727 family.
2728 <p>
2729 All elements on a toc page also have their own _FAMILY
2730 control macros, which override the default set by
2732 <!---TOC_PT_SIZE--->
2735 <p>
2738 <p>
2739 Unlike most other control macros that deal with size of document
2741 absolute value, relative to nothing. Therefore, the argument
2742 represents the size of toc type in
2744 unless you append an alternative
2746 For example,
2747 <p>
2748 <pre>
2749 .TOC_PT_SIZE 12
2750 </pre>
2752 sets the base point size of type for the toc to 12 points, whereas
2753 <p>
2754 <pre>
2755 .TOC_PT_SIZE .6i
2756 </pre>
2759 <p>
2761 from which the point size of other toc page elements are calculated.
2762 <p>
2763 The default for
2765 is 12.5 points (the same default size used in the body of the
2766 document).
2768 <!---TOC_LEAD--->
2771 <p>
2773 <br>
2774 <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
2776 <p>
2777 Unlike most other control macros that deal with leading of document
2779 absolute value, relative to nothing. Therefore, the argument
2780 represents the
2782 of tocs in
2784 unless you append an alternative
2786 For example,
2787 <p>
2788 <pre>
2789 .TOC_LEAD 14
2790 </pre>
2792 sets the base leading of type on the endnotes page to 14
2793 points, whereas
2794 <p>
2795 <pre>
2796 .TOC_LEAD .5i
2797 </pre>
2800 <p>
2801 If you want the leading of toc pages adjusted to fill the
2805 for an explanation of leading adjustment.)
2806 <p>
2807 The default for
2809 is the prevailing document lead (16 by default), adjusted.
2810 <p>
2813 default, adjust toc leading. You MUST enter
2816 <p>
2819 body of the document is single-spaced.
2822 <p>
2823 The page numbering of toc pages is controlled by the same macros
2824 that control
2826 except
2828 (tocs always start on page 1). The defaults are the same as the
2829 rest of the document.
2830 <p>
2831 If you wish to change some aspect of toc pagination, use the
2832 document pagination control macros immediately prior to
2834 <p>
2835 A special macro,
2837 controls the style of toc pages page numbers.
2838 <br>
2842 <!---PAGINATE_TOC--->
2844 <p>
2847 </a>
2848 <p>
2850 her not to, do
2851 <p>
2852 <pre>
2853 .PAGINATE_TOC OFF
2854 </pre>
2860 if pagination is turned off elsewhere in your document.
2862 <p>
2864 <p>
2866 <!---TOC_PAGENUM_STYLE--->
2869 Macro: <strong>TOC_PAGENUM_STYLE</strong> <var><DIGIT | ROMAN | roman | ALPHA | alpha></var>
2870 </a>
2871 <p>
2874 something else. For example, to have standard digits instead of
2875 roman numerals, do the following:
2876 <p>
2877 <pre>
2878 .TOC_PAGENUM_STYLE DIGIT
2879 </pre>
2881 <br>
2883 <br>
2886 <p>
2887 The toc header string is the title that appears at to top of the
2890 <p>
2892 <pre>
2893 .TOC_HEADER_STRING "Table of Contents"
2894 </pre>
2897 The style of the toc header (title) is managed by the usual control
2898 macros (see
2900 <p>
2901 <pre>
2902 .TOC_HEADER_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
2903 .TOC_HEADER_FONT default = bold
2904 .TOC_HEADER_SIZE default = +4
2905 .TOC_HEADER_QUAD default = left
2906 </pre>
2909 <p>
2911 paragraph heads as they appear in the toc. Their style is managed
2912 by the usual
2914 starting with TOC_
2917 <p>
2918 The toc control macros that end in _INDENT all take a single
2919 argument that requires a
2921 The argument is the distance to indent the entry from the left
2922 margin. For example,
2923 <p>
2924 <pre>
2925 .TOC_HEAD_INDENT 2P
2926 </pre>
2928 indents head entries 2
2930 from the left margin.
2933 <p>
2934 (See
2936 <p>
2937 Toc title entries are the titles of documents that have been
2939 together.
2940 <p>
2941 <pre>
2942 .TOC_TITLE_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
2943 .TOC_TITLE_FONT default = bold italic
2944 .TOC_TITLE_SIZE default = +0
2945 .TOC_TITLE_INDENT default = 0 for TYPESET and TYPEWRITE
2946 </pre>
2949 <p>
2950 (See
2952 <p>
2953 Toc head entries are main heads that appear in the body of a
2954 document.
2955 <p>
2956 <pre>
2957 .TOC_HEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
2958 .TOC_HEAD_FONT default = bold
2959 .TOC_HEAD_SIZE default = +.5
2961 </pre>
2964 <p>
2965 (See
2967 <p>
2968 Toc subhead entries are subheads that appear in the body of a
2969 document.
2970 <p>
2971 <pre>
2972 .TOC_SUBHEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
2973 .TOC_SUBHEAD_FONT default = roman
2974 .TOC_SUBHEAD_SIZE default = +0
2976 </pre>
2979 <p>
2980 (See
2982 <p>
2983 Toc paragraph head entries are paragraph heads that appear in the
2984 body of a document.
2985 <p>
2986 <pre>
2987 .TOC_PARAHEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
2988 .TOC_PARAHEAD_FONT default = italic
2989 .TOC_PARAHEAD_SIZE default = +0
2991 </pre>
2993 <a name="TOC_PN"><h3><u>*Changing the style for toc paragraph page number listings</u></h3></a>
2994 <p>
2995 (See
2997 <p>
2998 Toc paragraph head entries are paragraph heads that appear in the
2999 body of a document.
3000 <p>
3001 <pre>
3002 .TOC_PN_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE)
3003 .TOC_PN_FONT default = roman
3004 .TOC_PN_SIZE default = +0
3005 </pre>
3008 <p>
3009 The following macros allow you to switch page margins should
3010 they be incorrect for recto/verso printing, to establish how
3011 many placeholders to leave for page listings, and to have
3014 <br>
3017 <!---TOC_RV_SWITCH--->
3019 <p>
3022 </a>
3023 <p>
3026 of
3028 documents should the toc happen to begin on an even page when you
3029 want an odd, or vice versa.
3030 <p>
3031 The same result can be accomplished by outputting a
3034 <br>
3037 <!---TOC_APPENDS_AUTHOR--->
3039 <p>
3041 Macro: <strong>TOC_APPENDS_AUTHOR</strong> <var><none> | <"name(s) of authors"></var>
3042 </a>
3043 <p>
3044 In certain kinds of collated documents, different authors are
3045 responsible for the articles or stories contained within them. In
3046 such documents, you may wish to have the author or authors
3047 appended to the toc's title entry for each story or article.
3048 <p>
3052 to toc title entries, separated by a front-slash.
3053 <p>
3056 to the toc title entries instead. This is useful if you have
3057 multiple authors you wish to identify by last name only. For
3058 example, if three authors--Joe Blough, Jane Doe, and John
3059 Deere--are responsible for a single article
3060 <p>
3061 <pre>
3062 .TOC_APPENDS_AUTHOR "Blough et al."
3063 </pre>
3065 would be a good way to identify them in the toc.
3067 <br>
3070 <!---TOC_PADDING--->
3072 <p>
3074 Macro: <strong>TOC_PADDING</strong> <var><# of placeholders to allow for page number listings></var>
3075 </a>
3076 <p>
3078 page number listings of tocs. If you'd like some other number of
3079 placeholders, say 2, do
3080 <p>
3081 <pre>
3082 .TOC_PADDING 2
3083 </pre>
3085 <br>
3086 <hr>
3088 <!====================================================================>
3091 <p>
3094 </a>
3096 <p>
3097 This one does exactly what you'd expect -- inserts a blank page into
3099 number of every blank page and keeps track of
3101 stuff, but otherwise, does nothing. It's up to you, the user, to
3102 figure out what to do with this feature. However, it's worth
3103 noting that without it, inserting completely blank pages, to use
3107 <p>
3109 pages to insert. The argument is not optional, hence even if you
3111 <p>
3112 <pre>
3113 .BLANKPAGE 1
3114 </pre>
3116 <p>
3117 <hr>
3122 </body>
3123 </html>