docelement.html revision 1.1.1.1
1 1.1 christos <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> 2 1.1 christos <html> 3 1.1 christos <head> 4 1.1 christos <meta http-equiv="content-type" content="text/html;charset=iso-8859-1"> 5 1.1 christos <title>Mom -- Document Processing, element tags</title> 6 1.1 christos </head> 7 1.1 christos <body bgcolor="#dfdfdf"> 8 1.1 christos 9 1.1 christos <!====================================================================> 10 1.1 christos 11 1.1 christos <a href="headfootpage.html#TOP">Next</a> 12 1.1 christos <a href="docprocessing.html#TOP">Prev</a> 13 1.1 christos <a href="toc.html">Back to Table of Contents</a> 14 1.1 christos <p> 15 1.1 christos <a name="TOP"></a> 16 1.1 christos <a name="DOCELEMENT"> 17 1.1 christos <h1 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h1> 18 1.1 christos </a> 19 1.1 christos 20 1.1 christos <ul> 21 1.1 christos <li><a href="#DOCELEMENT_INTRO">Introduction to the document element tags</a> 22 1.1 christos <ul> 23 1.1 christos <li><a href="#DOCELEMENT_CONTROL">Control macros -- changing defaults for document element tags</a> 24 1.1 christos <li><a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a> 25 1.1 christos </ul> 26 1.1 christos <li><a href="#INDEX_DOCELEMENT">Index of document element tags</a> 27 1.1 christos </ul> 28 1.1 christos 29 1.1 christos <a name="DOCELEMENT_INTRO"> 30 1.1 christos <h2><u>Introduction to the document element tags</u></h2> 31 1.1 christos </a> 32 1.1 christos 33 1.1 christos Once you've completed the setup for a document (see 34 1.1 christos <a href="docprocessing.html#DOCPROCESSING_TUT">Setting up a mom document</a>), 35 1.1 christos formatting it is a snap. Simply invoke the appropriate tag for 36 1.1 christos each document element as you need it. The tags are macros that 37 1.1 christos tell <strong>mom</strong>, "This is a paragraph, this 38 1.1 christos is a subhead, this is a footnote," and so on. 39 1.1 christos <p> 40 1.1 christos The list of tags is actually quite small -- ideal for the users 41 1.1 christos <strong>mom</strong> brought herself into being for (see 42 1.1 christos <a href="intro.html#INTRO_INTRO">Who mom is meant for</a>). 43 1.1 christos However, the list of macros that control the appearance of the 44 1.1 christos tags upon output is extensive. Generally, for each tag, 45 1.1 christos there are 46 1.1 christos <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a> 47 1.1 christos for the tag's family, font and point size. Where appropriate, there 48 1.1 christos are macros to control leading, indents, quad and special features 49 1.1 christos as well. 50 1.1 christos <p> 51 1.1 christos <strong>Mom</strong> has tasteful defaults for all the tags, hence you 52 1.1 christos only use the control macros when you want to change the way 53 1.1 christos she does things. This is usually done prior to 54 1.1 christos <a href="docprocessing.html#START">START</a>, 55 1.1 christos but can, in fact, be done at any time in the course of a document. 56 1.1 christos Any change to a tag's style affects all subsequent invocations of 57 1.1 christos the tag. 58 1.1 christos <p> 59 1.1 christos 60 1.1 christos <a name="DOCELEMENT_CONTROL"><h3><u>Control macros -- changing defaults</u></h3></a> 61 1.1 christos 62 1.1 christos <p> 63 1.1 christos The control macros for document processing tags let you 64 1.1 christos "design" the look of all the parts of your documents -- 65 1.1 christos should you wish. At a bare minimum, all tags have macros to change 66 1.1 christos <strong>mom</strong>'s defaults for family, font, point size and 67 1.1 christos colour. Where appropriate, there are macros to control leading, 68 1.1 christos indents and quad as well. 69 1.1 christos <p> 70 1.1 christos In addition, many tags have special macros to control features that 71 1.1 christos are pertinent to those tags alone. Have a look at the section dealing 72 1.1 christos with any particular tag to find out what macros control the tag, 73 1.1 christos and what <strong>mom</strong>'s defaults for the tag are. 74 1.1 christos <p> 75 1.1 christos The control macros may be used at any time during the course of 76 1.1 christos a document (i.e. before or after 77 1.1 christos <a href="docprocessing.html#START">START</a>). The changes you 78 1.1 christos make alter all subsequent invocations of the affected tag until 79 1.1 christos you make another change, either by passing new arguments to the 80 1.1 christos tag's control macro, or toggling a particular feature of the tag on 81 1.1 christos or off. 82 1.1 christos <p> 83 1.1 christos And don't forget: the 84 1.1 christos <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a> 85 1.1 christos can be used at any time, including inside 86 1.1 christos <a href="definitions.html#TERMS_TOGGLE">toggle</a> 87 1.1 christos tags (affecting only that particular invocation of the tag). 88 1.1 christos Equally, 89 1.1 christos <a href="definitions.html#TERMS_INLINES">inline escapes</a> 90 1.1 christos can be used in tags that take 91 1.1 christos <a href="definitions.html#TERMS_STRINGARGUMENT">string arguments.</a> 92 1.1 christos <p> 93 1.1 christos <strong>IMPORTANT NOTE:</strong> The family, font, point size, 94 1.1 christos colour and leading control macros have no effect in 95 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 96 1.1 christos which sets EVERYTHING in Courier roman, 12/24 (i.e. 12-point type on 97 1.1 christos a linespace of 24 points). 98 1.1 christos <p> 99 1.1 christos Please also note that the defaults listed 100 1.1 christos with the control macros apply only to 101 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a> 102 1.1 christos unless a default for <strong>TYPEWRITE</strong> is also given. 103 1.1 christos <p> 104 1.1 christos <strong>A WORD OF ADVICE:</strong> Get familiar with 105 1.1 christos <strong>mom</strong> at her default settings before exploring the 106 1.1 christos control macros. Put her through her paces. See how she behaves. 107 1.1 christos Get to know what she feels like and how she looks, both in your text 108 1.1 christos editor and on the printed page. Then, if you don't like something, 109 1.1 christos use this documentation to find the precise macro you need to change it. 110 1.1 christos There are tons of control macros. Reading up on them and trying to 111 1.1 christos remember them all might lead you to think that <strong>mom</strong> 112 1.1 christos is complex and unwieldy, which is not only untrue, but would offend 113 1.1 christos her mightily. 114 1.1 christos <p> 115 1.1 christos 116 1.1 christos <a name="CONTROL_MACRO_ARGS"><h3><u>Arguments to the control macros</u></h3></a> 117 1.1 christos 118 1.1 christos <h3>Family and font</h3> 119 1.1 christos The arguments to the control macros that end in 120 1.1 christos <strong>_FAMILY</strong> or <strong>_FONT</strong> are the same 121 1.1 christos as for 122 1.1 christos <a href="typesetting.html#FAMILY">FAMILY</a> 123 1.1 christos and 124 1.1 christos <a href="typesetting.html#FONT">FT</a>. 125 1.1 christos 126 1.1 christos <h3>Point size</h3> 127 1.1 christos Control macros that end in <strong>_SIZE</strong> always take 128 1.1 christos the form <kbd>+digit</kbd> or <kbd>-digit</kbd> where digit is 129 1.1 christos the number of 130 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a> 131 1.1 christos larger (+) or smaller (-) than the point size of paragraphs 132 1.1 christos you want the document element to be. For example, to change 133 1.1 christos subheads to 1-1/2 points larger than the type in paragraphs, do 134 1.1 christos <p> 135 1.1 christos <pre> 136 1.1 christos .SUBHEAD_SIZE +1.5 137 1.1 christos </pre> 138 1.1 christos 139 1.1 christos There's no need for a 140 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 141 1.1 christos with the <strong>_SIZE</strong> control macros; points is assumed. 142 1.1 christos 143 1.1 christos <h3>Colour</h3> 144 1.1 christos Control macros that end in <strong>_COLOR</strong> take as their 145 1.1 christos argument a colour name pre-defined (or "initialized") 146 1.1 christos with 147 1.1 christos <a href="color.html#NEWCOLOR">NEWCOLOR</a> 148 1.1 christos or 149 1.1 christos <a href="color.html#XCOLOR">XCOLOR</a>. 150 1.1 christos For example, if you want your heads to be red, once you've defined 151 1.1 christos or initialized the color, red, 152 1.1 christos <p> 153 1.1 christos <pre> 154 1.1 christos .HEAD_COLOR red 155 1.1 christos </pre> 156 1.1 christos 157 1.1 christos will turn your heads red. 158 1.1 christos 159 1.1 christos <h3>Lead/linespacing</h3> 160 1.1 christos Control macros that end in <strong>_AUTOLEAD</strong> take the 161 1.1 christos same argument as 162 1.1 christos <a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>, 163 1.1 christos viz. a digit that represents the number of points to add to the 164 1.1 christos tag's point size to arrive at its 165 1.1 christos <a href="definitions.html#TERMS_LEADING">lead</a>. 166 1.1 christos For example, to set footnotes 167 1.1 christos <a href="definitions.html#TERMS_SOLID">solid</a>, do 168 1.1 christos <p> 169 1.1 christos <pre> 170 1.1 christos .FOOTNOTE_AUTOLEAD 0 171 1.1 christos </pre> 172 1.1 christos 173 1.1 christos To set footnotes with a 1-point lead (i.e. with the line spacing 174 1.1 christos one point greater than the footnote's point size), do 175 1.1 christos <p> 176 1.1 christos <pre> 177 1.1 christos .FOOTNOTE_AUTOLEAD 1 178 1.1 christos </pre> 179 1.1 christos 180 1.1 christos <h3><a name="CONTROL_INDENTS">Indents</a></h3> 181 1.1 christos Except for <strong>PARA_INDENT</strong>, the argument to the control 182 1.1 christos macros that end 183 1.1 christos in <strong>_INDENT</strong> is always a single digit (whole numbers 184 1.1 christos only; no decimal fractions) with no 185 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 186 1.1 christos appended to it. The digit represents by how much you want the 187 1.1 christos size of the paragraph first-line indent multiplied to achieve the 188 1.1 christos correct indent for a particular tag. 189 1.1 christos 190 1.1 christos <h3>Quad/justification style</h3> 191 1.1 christos Control macros that end in <strong>_QUAD</strong> take the same 192 1.1 christos arguments as 193 1.1 christos <a href="typesetting.html#QUAD">QUAD</a>. 194 1.1 christos <p> 195 1.1 christos <hr> 196 1.1 christos 197 1.1 christos <a name="INDEX_DOCELEMENT"><h3><u>Document element tags list</u></h3></a> 198 1.1 christos <ul> 199 1.1 christos <li><a href="#EPIGRAPH_INTRO">Epigraphs</a> 200 1.1 christos <ul> 201 1.1 christos <li><a href="#EPIGRAPH">EPIGRAPH</a> 202 1.1 christos <li><a href="#EPIGRAPH_CONTROL">Epigrah control</a> 203 1.1 christos </ul> 204 1.1 christos <li><a href="#PP_INTRO">Paragraphs</a> 205 1.1 christos <ul> 206 1.1 christos <li><a href="#PP">PP</a> 207 1.1 christos <li><a href="#PP_CONTROL">Paragraph control</a> 208 1.1 christos </ul> 209 1.1 christos <li><a href="#HEAD_INTRO">Main heads</a> 210 1.1 christos <ul> 211 1.1 christos <li><a href="#HEAD">HEAD</a> 212 1.1 christos <li><a href="#HEAD_CONTROL">Head control</a> 213 1.1 christos </ul> 214 1.1 christos <li><a href="#SUBHEAD_INTRO">Subheads</a> 215 1.1 christos <ul> 216 1.1 christos <li><a href="#SUBHEAD">SUBHEAD</a> 217 1.1 christos <li><a href="#SUBHEAD_CONTROL">Subhead control</a> 218 1.1 christos </ul> 219 1.1 christos <li><a href="#PARAHEAD_INTRO">Paragraph heads</a> 220 1.1 christos <ul> 221 1.1 christos <li><a href="#PARAHEAD">PARAHEAD</a> 222 1.1 christos <li><a href="#PARAHEAD_CONTROL">Parahead control</a> 223 1.1 christos </ul> 224 1.1 christos <li><a href="#LINEBREAK_INTRO">Linebreaks (author linebreaks, section breaks)</a> 225 1.1 christos <ul> 226 1.1 christos <li><a href="#LINEBREAK">LINEBREAK</a> 227 1.1 christos <li><a href="#LINEBREAK_CHAR">Linebreak character</a> 228 1.1 christos <li><a href="#LINEBREAK_COLOR">Linebreak colour</a> 229 1.1 christos </ul> 230 1.1 christos <li><a href="#QUOTE_INTRO">Quotes (line for line)</a> 231 1.1 christos <ul> 232 1.1 christos <li><a href="#QUOTE">QUOTE</a> 233 1.1 christos <li><a href="#QUOTE_CONTROL">Quote control</a> 234 1.1 christos </ul> 235 1.1 christos <li><a href="#BLOCKQUOTE_INTRO">Blockquotes (cited material)</a> 236 1.1 christos <ul> 237 1.1 christos <li><a href="#BLOCKQUOTE">BLOCKQUOTE</a> 238 1.1 christos <li><a href="#BLOCKQUOTE_CONTROL">Blockquote control</a> 239 1.1 christos </ul> 240 1.1 christos <li><a href="#LIST_INTRO">Nested lists</a> 241 1.1 christos <ul> 242 1.1 christos <li><a href="#LIST">LIST</a> 243 1.1 christos <ul> 244 1.1 christos <li><a href="#ITEM">ITEM</a> 245 1.1 christos </ul> 246 1.1 christos <li><a href="#LIST_CONTROL">List control</a> 247 1.1 christos </ul> 248 1.1 christos <li><a href="#NUMBER_LINES_INTRO">Line numbering</a> 249 1.1 christos <ul> 250 1.1 christos <li><a href="#NUMBER_LINES">NUMBER_LINES</a> 251 1.1 christos <li><a href="#NUMBER_LINES_CONTROL">Control macros</a> (for QUOTE and BLOCKQUOTE) 252 1.1 christos </ul> 253 1.1 christos <li><a href="#FOOTNOTE_INTRO">Footnotes</a> 254 1.1 christos <ul> 255 1.1 christos <li><a href="#FOOTNOTE">FOOTNOTE</a> 256 1.1 christos <li><a href="#FOOTNOTE_CONTROL">Footnote control</a> 257 1.1 christos </ul> 258 1.1 christos <li><a href="#ENDNOTE_INTRO">Endnotes</a> 259 1.1 christos <ul> 260 1.1 christos <li><a href="#ENDNOTE">ENDNOTE</a> 261 1.1 christos <li><a href="#ENDNOTE_CONTROL">Endnote control</a> 262 1.1 christos </ul> 263 1.1 christos <li><a href="#MARGIN_NOTES_INTRO">Margin notes</a> 264 1.1 christos <ul> 265 1.1 christos <li><a href="#MN_INIT">MN_INIT</a> -- initialize margin notes 266 1.1 christos <li><a href="#MN">MN</a> -- start and end a margin note 267 1.1 christos </ul> 268 1.1 christos <li><a href="refer.html#TOP">Bibliographies and references</a> 269 1.1 christos <ul> 270 1.1 christos <li><a href="refer.html#REF">REF</a> 271 1.1 christos <li><a href="refer.html#ENDNOTE_REFS">ENDNOTE_REFS</a> 272 1.1 christos <li><a href="refer.html#FOOTNOTE_REFS">FOOTNOTE_REFS</a> 273 1.1 christos <li><a href="refer.html#BRACKET_REFS">Embedded references</a> 274 1.1 christos <li><a href="refer.html#BIBLIOGRAPHY">BIBLIOGRAPHY</a> 275 1.1 christos <li><a href="refer.html#BIBLIOGRAPHY_TYPE">BIBLIOGRAPHY_TYPE</a> 276 1.1 christos </ul> 277 1.1 christos <li><a href="#BLANK_PAGE_TITLE">Blank pages</a> 278 1.1 christos <li><a href="#TOC_INTRO">Table of contents</a> 279 1.1 christos <ul> 280 1.1 christos <li><a href="#TOC">TOC</a> 281 1.1 christos <li><a href="#TOC_CONTROL">Table of contents control</a> 282 1.1 christos </ul> 283 1.1 christos <li><a href="#FINIS_INTRO">Document termination</a> 284 1.1 christos <ul> 285 1.1 christos <li><a href="#FINIS">FINIS (Document termination)</a> 286 1.1 christos </ul> 287 1.1 christos <ul> 288 1.1 christos <li><a href="#FINIS_STRING">Changing the FINIS string</a> 289 1.1 christos <li><a href="#FINIS_COLOR">Changing the FINIS colour</a> 290 1.1 christos </ul> 291 1.1 christos </ul> 292 1.1 christos <hr> 293 1.1 christos 294 1.1 christos 295 1.1 christos <!====================================================================> 296 1.1 christos 297 1.1 christos <a name="EPIGRAPH_INTRO"><h2><u>Epigraphs</u></h2></a> 298 1.1 christos <ul> 299 1.1 christos <li><a href="#EPIGRAPH">Tag: EPIGRAPH</a> 300 1.1 christos <li><a href="#EPIGRAPH_CONTROL">Epigraph control macros</a> 301 1.1 christos </ul> 302 1.1 christos <p> 303 1.1 christos <a href="definitions.html#TERMS_EPIGRAPH">Epigraphs</a> 304 1.1 christos colour, flavour, or comment on the document they precede. Typically, 305 1.1 christos they are centred at the top of a document's first page (underneath the 306 1.1 christos title) and set in a smaller point size than that of paragraph text. 307 1.1 christos <p> 308 1.1 christos By default, <strong>mom</strong> sets epigraphs centred and 309 1.1 christos <a href="definitions.html#TERMS_NOFILL">unfilled</a>; 310 1.1 christos this lets you input them on a line for line basis. This behaviour 311 1.1 christos can be changed to accomodate 312 1.1 christos <a href="definitions.html#TERMS_FILLED">filled</a> 313 1.1 christos epigraph "blocks." 314 1.1 christos <p> 315 1.1 christos 316 1.1 christos <!---EPIGRAPH---> 317 1.1 christos 318 1.1 christos <hr width="66%" align="left"> 319 1.1 christos <p> 320 1.1 christos <a name="EPIGRAPH"> 321 1.1 christos <nobr>Macro: <strong>EPIGRAPH</strong> <toggle> | [ BLOCK ]</a></nobr> 322 1.1 christos </a> 323 1.1 christos 324 1.1 christos <p> 325 1.1 christos <strong>EPIGRAPH</strong> is a toggle, used like this: 326 1.1 christos <p> 327 1.1 christos <pre> 328 1.1 christos .EPIGRAPH 329 1.1 christos <text of epigraph> 330 1.1 christos .EPIGRAPH OFF 331 1.1 christos </pre> 332 1.1 christos 333 1.1 christos <strong>OFF</strong>, above, could be anything -- say, Q or X -- 334 1.1 christos since any argument other than <strong>BLOCK</strong> turns it off. 335 1.1 christos <p> 336 1.1 christos If given the argument <strong>BLOCK</strong>, <strong>EPIGRAPH</strong> 337 1.1 christos sets epigraphs 338 1.1 christos <a href="definitions.html#TERMS_FILLED">filled</a>, 339 1.1 christos justified or quadded in the same direction as paragraphs, indented 340 1.1 christos equally from both the left and right margins. 341 1.1 christos <p> 342 1.1 christos If a block-style epigraph runs to more than one paragraph (unlikely, 343 1.1 christos but conceivable), you <strong>MUST</strong> introduce every paragraph 344 1.1 christos -- <u>INCLUDING THE FIRST!!!</u> -- with the 345 1.1 christos <a href="#PP">PP</a> 346 1.1 christos tag. 347 1.1 christos <p> 348 1.1 christos <strong>NOTE:</strong> <strong>EPIGRAPH</strong> should only be 349 1.1 christos used at the top of a document (i.e. just after 350 1.1 christos <a href="docprocessing.html#START">START</a>) 351 1.1 christos or after 352 1.1 christos <a href="#HEAD_INTRO">heads</a>. The latter is not especially 353 1.1 christos recommended, but it does work. In all other places where you 354 1.1 christos want quotes or cited text, use 355 1.1 christos <a href="#QUOTE">QUOTE</a> 356 1.1 christos or 357 1.1 christos <a href="#BLOCKQUOTE">BLOCKQUOTE</a>. 358 1.1 christos <p> 359 1.1 christos 360 1.1 christos <a name="EPIGRAPH_CONTROL"><h3><u>Epigraph control macros</u></h3></a> 361 1.1 christos <p> 362 1.1 christos See 363 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 364 1.1 christos <p> 365 1.1 christos <pre> 366 1.1 christos .EPIGRAPH_FAMILY default = prevailing document family; default is Times Roman 367 1.1 christos .EPIGRAPH_FONT default = roman 368 1.1 christos .EPIGRAPH_SIZE default = -1.5 (points) 369 1.1 christos .EPIGRAPH_COLOR default = black 370 1.1 christos .EPIGRAPH_AUTOLEAD default = 2 points 371 1.1 christos 372 1.1 christos (The next two apply to "block" style epigraphs only) 373 1.1 christos 374 1.1 christos .EPIGRAPH_QUAD default = same as paragraphs 375 1.1 christos .EPIGRAPH_INDENT* default = para indent x 3 (for typeset), x 2 (for typewrite) 376 1.1 christos 377 1.1 christos *Indent here refers to the indent from both the left and right margins 378 1.1 christos that centres the block style epigraph on the page. 379 1.1 christos </pre> 380 1.1 christos <hr> 381 1.1 christos 382 1.1 christos <!====================================================================> 383 1.1 christos 384 1.1 christos <a name="PP_INTRO"><h2><u>Paragraphs</u></h2></a> 385 1.1 christos <ul> 386 1.1 christos <li><a href="#PP">Tag: PP</a> 387 1.1 christos <li><a href="#PP_CONTROL">Paragraph control macros</a> 388 1.1 christos </ul> 389 1.1 christos <p> 390 1.1 christos The paragraph macro is the one you use most often. Consequently, 391 1.1 christos it's one of most powerful, yet simplest to use -- just the letters 392 1.1 christos <strong>PP</strong>. No arguments, nothing. Just <kbd>.PP</kbd> 393 1.1 christos on a line by itself any time, in any document element, tells 394 1.1 christos <strong>mom</strong> you want to start a new paragraph. The spacing 395 1.1 christos and indent appropriate to where you are in your document are taken 396 1.1 christos care of automatically. 397 1.1 christos <p> 398 1.1 christos By default, <strong>mom</strong> does not indent the first paragraph 399 1.1 christos of a document, nor paragraphs that fall immediately after 400 1.1 christos <a href="#HEAD_INTRO">heads</a> 401 1.1 christos or 402 1.1 christos <a href="#SUBHEAD_INTRO">subheads</a>. 403 1.1 christos The first paragraphs of blockquotes and block-style epigraphs are 404 1.1 christos also not indented. This behaviour can be changed with the control 405 1.1 christos macro 406 1.1 christos <a href="#PARA_INDENT_FIRST">INDENT_FIRST_PARAS</a>. 407 1.1 christos <p> 408 1.1 christos In contrast to some other macro packages, <strong>mom</strong> does not 409 1.1 christos deposit a blank line between paragraphs. If you want her to do so, use 410 1.1 christos the control macro <strong>PARA_SPACE</strong>. (I don't recommend 411 1.1 christos using this macro with 412 1.1 christos <a href="typesetting.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.) 413 1.1 christos <p> 414 1.1 christos Note that <strong>mom</strong> does not provide "orphan 415 1.1 christos control" for paragraphs (i.e. even if only one line of a paragraph 416 1.1 christos fits at the bottom of a page, she will set it on that page). The 417 1.1 christos reason for this is that writers of fiction often have single-line 418 1.1 christos paragraphs (e.g. in dialogue). Groff's simplistic orphan control 419 1.1 christos will break these one-liners -- if they fall at the bottom of the page 420 1.1 christos -- to a new page, which is not what you want. 421 1.1 christos <p> 422 1.1 christos <strong>TIP:</strong> The last thing you want while you're writing 423 1.1 christos and editing drafts of a document (particularly stories and chapters) 424 1.1 christos is a text file cluttered up with <strong>PP</strong>'s. The visual 425 1.1 christos interruption in the flow of text is a serious obstacle to creativity 426 1.1 christos and critiquing. 427 1.1 christos <p> 428 1.1 christos I use the tab key on my keyboard to indent paragraphs when I'm writing, 429 1.1 christos producing a text file that looks pretty much like what you see on 430 1.1 christos a printed page. When it comes time to format and print the file, 431 1.1 christos I run it through a sed script that (amongst other things) converts 432 1.1 christos the character generated by the tab key (<kbd>^I</kbd>) into <code>.PP</code> 433 1.1 christos (plus a new line), and pipe the output to groff for processing and 434 1.1 christos printing. 435 1.1 christos <p> 436 1.1 christos Another solution is to insert a blank line between paragraphs. 437 1.1 christos The blank lines can then be sedded out at print time as above, or, 438 1.1 christos more conveniently, you can use the <code>.blm</code> 439 1.1 christos <a href="definitions.html#TERMS_PRIMITIVES">primitive</a> 440 1.1 christos (blank line macro) to instruct groff (and <strong>mom</strong>) 441 1.1 christos that blank lines should be interpreted as <strong>PP</strong>'s. 442 1.1 christos <p> 443 1.1 christos <pre> 444 1.1 christos .blm PP 445 1.1 christos </pre> 446 1.1 christos tells groff that all blank lines are really the macro <strong>PP</strong>. 447 1.1 christos <p> 448 1.1 christos 449 1.1 christos <!---PP---> 450 1.1 christos 451 1.1 christos <hr width="66%" align="left"> 452 1.1 christos <p> 453 1.1 christos <a name="PP"> 454 1.1 christos Macro: <strong>PP</strong> 455 1.1 christos </a> 456 1.1 christos 457 1.1 christos <p> 458 1.1 christos <strong>PP</strong> (on a line by itself, of course) tells mom to 459 1.1 christos start a new paragraph. See 460 1.1 christos <a href="#PP_INTRO">above</a> 461 1.1 christos for more details. In addition to regular text paragraphs, you can 462 1.1 christos use <strong>PP</strong> in 463 1.1 christos <a href="#EPIGRAPH_INTRO">epigraphs</a>, 464 1.1 christos <a href="#BLOCKQUOTE_INTRO">blockquotes</a> 465 1.1 christos and 466 1.1 christos <a href="#FOOTNOTE_INTRO">footnotes</a>. 467 1.1 christos 468 1.1 christos <a name="PP_CONTROL"><h3><u>Paragraph control macros</u></h3></a> 469 1.1 christos <p> 470 1.1 christos The <strong>PP</strong> being so important, and representing, as 471 1.1 christos it were, the basis of everything that goes on in a document, its 472 1.1 christos control is managed in a manner somewhat different from other document 473 1.1 christos element tags. 474 1.1 christos <p> 475 1.1 christos <ol> 476 1.1 christos <li><a href="#PP_FAMILY">Family control</a> 477 1.1 christos <li><a href="#PP_FONT">Font control</a> 478 1.1 christos <li><a href="#PP_COLOR">Paragraph colour</a> 479 1.1 christos <li><a href="#PP_LEADING">Leading/linespacing control</a> 480 1.1 christos <li><a href="#PP_JUST_QUAD">Justification/quad control</a> 481 1.1 christos <li><a href="#PARA_INDENT">First-line indent control</a> 482 1.1 christos <li><a href="#PARA_INDENT_FIRST">Initial paragraphs indent control</a> 483 1.1 christos <li><a href="#PP_SPACE">Paragraph spacing control</a> 484 1.1 christos </ol> 485 1.1 christos 486 1.1 christos <a name="PP_FAMILY"><h3><u>1. Family</u></h3></a> 487 1.1 christos <p> 488 1.1 christos The paragraph 489 1.1 christos <a href="definitions.html#TERMS_FAMILY">family</a> 490 1.1 christos is set with 491 1.1 christos <a href="typesetting.html#FAMILY">FAMILY</a> 492 1.1 christos prior to 493 1.1 christos <a href="docprocessing.html#START">START</a>, 494 1.1 christos or 495 1.1 christos <a href="docprocessing.html#DOC_FAMILY">DOC_FAMILY</a> 496 1.1 christos afterwards. Please note that both globally affect the family of 497 1.1 christos every element in the document. 498 1.1 christos <p> 499 1.1 christos If you wish to change the family for regular 500 1.1 christos text paragraphs only, invoke <strong>FAMILY</strong> immediately 501 1.1 christos after <strong>PP</strong> in EVERY paragraph whose family you wish 502 1.1 christos to differ from the prevailing document family. 503 1.1 christos <p> 504 1.1 christos <strong>Mom</strong>'s default paragraph (and document) family 505 1.1 christos is Times Roman. 506 1.1 christos <p> 507 1.1 christos 508 1.1 christos <a name="PP_FONT"><h3><u>2. Font -- PP_FONT</u></h3></a> 509 1.1 christos <p> 510 1.1 christos To change the 511 1.1 christos <a href="definitions.html#TERMS_FONT">font</a> 512 1.1 christos used in regular text paragraphs, use <code>.PP_FONT</code>, 513 1.1 christos which takes the same argument as 514 1.1 christos <a href="typesetting.html#FONT">FT</a>. 515 1.1 christos <strong>PP_FONT</strong> may be used before or after 516 1.1 christos <a href="docprocessing.html#START">START</a>. 517 1.1 christos Only regular text paragraphs are affected; paragraphs in 518 1.1 christos <a href="#EPIGRAPH_INTRO">epigraphs</a>, 519 1.1 christos <a href="#BLOCKQUOTE_INTRO">blockquotes</a> 520 1.1 christos and 521 1.1 christos <a href="#FOOTNOTE_INTRO">footnotes</a> 522 1.1 christos remain at their default setting (medium roman) unless you change them 523 1.1 christos with the appropriate control macros. 524 1.1 christos <p> 525 1.1 christos <strong>Mom</strong>'s default paragraph font is medium roman. 526 1.1 christos <p> 527 1.1 christos 528 1.1 christos <a name="PP_COLOR"><h3><u>3. Paragraph colour</u></h3></a> 529 1.1 christos <p> 530 1.1 christos <strong>Mom</strong> has no special control macro for colourizing 531 1.1 christos paragraphs. If you wish a colourized paragraph, you must use the 532 1.1 christos macro, 533 1.1 christos <a href="color.html#COLOR">COLOR</a>, 534 1.1 christos or the 535 1.1 christos <a href="definitions.html#TERMS_INLINE">inline escape</a>, 536 1.1 christos <a href="color.html#COLOR_INLINE">\*[<colorname>]</a>, 537 1.1 christos <em>after</em> <strong>.PP</strong>. The colour must be one 538 1.1 christos pre-defined (or "initialized") with 539 1.1 christos <a href="color.html#NEWCOLOR">NEWCOLOR</a> 540 1.1 christos or 541 1.1 christos <a href="color.html#XCOLOR">XCOLOR</a>. 542 1.1 christos <p> 543 1.1 christos Please note that unless you change the colour back to it's default 544 1.1 christos (usually black) at the end of the paragraph, all subsequent 545 1.1 christos paragraphs will be set in the new colour, although most other 546 1.1 christos elements of your document will continue to be set in the default 547 1.1 christos colour (usually black). 548 1.1 christos <p> 549 1.1 christos For example, assuming you have defined the colour, blue, 550 1.1 christos <p> 551 1.1 christos <pre> 552 1.1 christos .PP 553 1.1 christos .COLOR blue 554 1.1 christos <first paragraph> 555 1.1 christos .HEAD "Monty Python" 556 1.1 christos .SUBHEAD "The Origins of Spam" 557 1.1 christos .PP 558 1.1 christos <second paragraph> 559 1.1 christos </pre> 560 1.1 christos 561 1.1 christos the first paragraph will be blue, the head and subhead will be in 562 1.1 christos the document's default colour (usually black), and the second 563 1.1 christos paragraph will be in blue. 564 1.1 christos <p> 565 1.1 christos The one document element that is affected by changing the colour 566 1.1 christos of paragraphs are 567 1.1 christos <a href="#PARAHEAD">paraheads</a>, 568 1.1 christos since they are attached directly to the body of paragraphs. In 569 1.1 christos other words, if you change the colour of a paragraph and do not 570 1.1 christos reset the paragraph colour back to its default, subsequent paraheads 571 1.1 christos will appear in the same colour as your paragraphs unless you have 572 1.1 christos explicitly told <strong>mom</strong> you want a pre-defined (or 573 1.1 christos "initialized") color (usually black) for your paraheads. 574 1.1 christos <p> 575 1.1 christos See the footnote to 576 1.1 christos <a href="#PARAHEAD_COLOR">.PARAHEAD_COLOR</a>. 577 1.1 christos 578 1.1 christos <a name="PP_LEADING"><h3><u>4. Leading</u></h3></a> 579 1.1 christos <p> 580 1.1 christos The paragraph 581 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a> 582 1.1 christos is set with 583 1.1 christos <a href="typesetting.html#LEADING">LS</a> 584 1.1 christos prior to 585 1.1 christos <a href="docprocessing.html#START">START</a>, 586 1.1 christos or 587 1.1 christos <a href="docprocessing.html#DOC_LEAD">DOC_LEAD</a> 588 1.1 christos afterwards. Please note that either method globally affects the 589 1.1 christos leading and spacing of every document element (except 590 1.1 christos <a href="definitions.html#TERMS_HEADER">headers</a> 591 1.1 christos and 592 1.1 christos <a href="definitions.html#TERMS_FOOTER">footers</a>). 593 1.1 christos <p> 594 1.1 christos If you wish to change the leading of regular text paragraphs only, 595 1.1 christos invoke <strong>LS</strong> immediately after <strong>PP</strong> in 596 1.1 christos EVERY paragraph whose leading you wish to change. 597 1.1 christos <p> 598 1.1 christos <strong>HYPER-IMPORTANT NOTE:</strong> It is extremely unwise to change 599 1.1 christos paragraph leading with <strong>LS</strong>, as it will, in all cases, 600 1.1 christos screw up <strong>mom</strong>'s ability to balance the bottom margin 601 1.1 christos of pages. Should you absolutely need to change paragraph leading 602 1.1 christos with <strong>LS</strong>, and subsequently want <strong>mom</strong> 603 1.1 christos to get back on the right leading track, use the 604 1.1 christos <a href="docprocessing.html#SHIM">SHIM</a> 605 1.1 christos macro. 606 1.1 christos <p> 607 1.1 christos <strong>Mom</strong>'s default paragraph leading (document leading) 608 1.1 christos is 16 points, adjusted to fill the page. 609 1.1 christos <p> 610 1.1 christos 611 1.1 christos <a name="PP_JUST_QUAD"><h3><u>5. Justification/quad</u></h3></a> 612 1.1 christos <p> 613 1.1 christos The justification/quad-direction of regular text paragraphs (i.e. 614 1.1 christos <a href="definitions.html#TERMS_JUST">justified</a>, 615 1.1 christos or 616 1.1 christos <a href="definitions.html#TERMS_FILLED">filled</a> 617 1.1 christos and 618 1.1 christos <a href="definitions.html#TERMS_QUAD">quadded</a> 619 1.1 christos left/right/centre) is set with 620 1.1 christos <a href="typesetting.html#JUSTIFY">JUSTIFY</a> 621 1.1 christos or 622 1.1 christos <a href="typesetting.html#QUAD">QUAD</a> 623 1.1 christos prior to 624 1.1 christos <a href="docprocessing.html#START">START</a>, 625 1.1 christos and with 626 1.1 christos <a href="docprocessing.html#DOC_QUAD">DOC_QUAD</a> 627 1.1 christos afterwards. 628 1.1 christos <p> 629 1.1 christos Please note that either method of setting the paragraph 630 1.1 christos justification/quad-direction also affects 631 1.1 christos <a href="#EPIGRAPH_INTRO">epigraphs</a> 632 1.1 christos and 633 1.1 christos <a href="#FOOTNOTE_INTRO">footnotes</a>, 634 1.1 christos but not 635 1.1 christos <a href="#BLOCKQUOTE_INTRO">blockquotes</a> 636 1.1 christos (whose default is QUAD LEFT unless you change it with 637 1.1 christos <a href="#BLOCKQUOTE">BLOCKQUOTE_QUAD</a>). 638 1.1 christos The justification/quad-direction of epigraphs and footnotes may 639 1.1 christos be changed with their own control macros. 640 1.1 christos <p> 641 1.1 christos If you wish to change the justification/quad-direction of 642 1.1 christos individual paragraphs, use <strong>JUSTIFY</strong> or 643 1.1 christos <strong>QUAD</strong> immediately after <strong>PP</strong>. 644 1.1 christos Only the paragraph in question gets justified or quadded 645 1.1 christos differently; subsequent paragraphs remain unaffected. 646 1.1 christos <p> 647 1.1 christos <strong>Mom</strong>'s default justification/quad-direction for 648 1.1 christos paragraphs is 649 1.1 christos <br> 650 1.1 christos <ul> 651 1.1 christos <li>justified, for 652 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a> 653 1.1 christos <li>quad left, for 654 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a> 655 1.1 christos </ul> 656 1.1 christos <p> 657 1.1 christos <a name="PARA_INDENT"><h3><u>6. First-line indent -- PARA_INDENT</u></h3></a> 658 1.1 christos <p> 659 1.1 christos The first-line indent of paragraphs is controlled by 660 1.1 christos <strong>PARA_INDENT</strong>, which takes one argument: the size 661 1.1 christos of the indent. <strong>PARA_INDENT</strong> may be used before 662 1.1 christos or after 663 1.1 christos <a href="docprocessing.html#START">START</a>. 664 1.1 christos A 665 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 666 1.1 christos is required; fractional sizes are allowed. Thus, to set the paragraph 667 1.1 christos indent to 4-1/2 668 1.1 christos <a href="definitions.html#TERMS_EM">ems</a>, do 669 1.1 christos <p> 670 1.1 christos <pre> 671 1.1 christos .PARA_INDENT 4.5m 672 1.1 christos </pre> 673 1.1 christos 674 1.1 christos In addition to establishing the basic first line-indent of 675 1.1 christos paragraphs, <strong>PARA_INDENT</strong> also affects 676 1.1 christos <a href="#EPIGRAPH_INTRO">epigraphs</a>, 677 1.1 christos <a href="#QUOTE_INTRO">quotes</a> 678 1.1 christos and 679 1.1 christos <a href="#BLOCKQUOTE_INTRO">blockquotes</a>, 680 1.1 christos whose overall indenting from the left and (where applicable) right 681 1.1 christos margins is relative to <strong>PARA_INDENT</strong>. Furthermore, the 682 1.1 christos first-line indent of paragraphs within these document elements (as well 683 1.1 christos as footnotes) is also relative to <strong>PARA_INDENT</strong> (always 684 1.1 christos 1/2 of <strong>PARA_INDENT)</strong>), hence they are also affected. 685 1.1 christos <p> 686 1.1 christos <strong>Mom</strong>'s default <strong>PARA_INDENT</strong> is 2 687 1.1 christos ems for 688 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a> 689 1.1 christos and 3 picas (1/2 inch) for 690 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>. 691 1.1 christos <p> 692 1.1 christos 693 1.1 christos <a name="PARA_INDENT_FIRST"><h3><u>7. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a> 694 1.1 christos <p> 695 1.1 christos By default, <strong>mom</strong> does not indent the first paragraph 696 1.1 christos of a document, nor the first paragraph after a head or 697 1.1 christos subhead, nor the first paragraphs of 698 1.1 christos <a href="#EPIGRAPH_INTRO">epigraphs</a>, 699 1.1 christos <a href="#BLOCKQUOTE_INTRO">blockquotes</a> 700 1.1 christos or 701 1.1 christos <a href="#FOOTNOTE_INTRO">footnotes</a> 702 1.1 christos that run to more than one paragraph. 703 1.1 christos <a name="INDENT_FIRST_PARAS"></a> 704 1.1 christos <p> 705 1.1 christos If you wish to have first paragraphs indented, invoke the macro 706 1.1 christos <strong>.INDENT_FIRST_PARAS</strong> with no argument, either 707 1.1 christos before or after 708 1.1 christos <a href="docprocessing.html#START">START</a>. 709 1.1 christos <strong>INDENT_FIRST_PARAS</strong> is a toggle macro, therefore 710 1.1 christos passing it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels 711 1.1 christos its effect, meaning that first paragraphs will once again NOT be 712 1.1 christos indented. 713 1.1 christos <p> 714 1.1 christos 715 1.1 christos <a name="PP_SPACE"><h3><u>8. Spacing paragraphs -- PARA_SPACE</u></h3></a> 716 1.1 christos <p> 717 1.1 christos By default, <strong>mom</strong> does not insert a blank line 718 1.1 christos between paragraphs. If you would like her to do so, invoke the 719 1.1 christos macro <code>.PARA_SPACE</code> with no argument, either 720 1.1 christos before or after 721 1.1 christos <a href="docprocessing.html#START">START</a>. 722 1.1 christos <strong>PARA_SPACE</strong> is a toggle macro, therefore passing 723 1.1 christos it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels its 724 1.1 christos effect, meaning that paragraphs will once again NOT be separated by 725 1.1 christos a blank line. 726 1.1 christos <p> 727 1.1 christos <strong>NOTE:</strong> If <strong>PARA_SPACE</strong> is on, 728 1.1 christos <strong>mom</strong> spaces only those paragraphs that come after 729 1.1 christos an "initial" paragraph. Initial paragraphs are those 730 1.1 christos that come immediately after the 731 1.1 christos <a href="definitions.html#TERMS_DOCHEADER">docheader</a>, 732 1.1 christos <a href="#EPIGRAPH_INTRO">epigraphs</a>, 733 1.1 christos <a href="#HEAD_INTRO">heads</a>, 734 1.1 christos <a href="#SUBHEAD_INTRO">subheads</a> 735 1.1 christos and 736 1.1 christos <a href="#LINEBREAK_INTRO">linebreaks</a>. 737 1.1 christos (The first paragraph after these document elements requires no 738 1.1 christos blank line to separate it from other paragraphs.) 739 1.1 christos <p> 740 1.1 christos Sometimes, you can be fairly deep into a document before using 741 1.1 christos <strong>.PP</strong> for the first time, and when you do, because 742 1.1 christos <strong>mom</strong> is still waiting for that "initial" 743 1.1 christos paragraph, she doesn't space it with a blank line, even though 744 1.1 christos you expect her to. The simple workaround for this is to invoke 745 1.1 christos <strong>.PP</strong> <em>twice</em> (in succession) at the point you 746 1.1 christos expect the blank line to appear. 747 1.1 christos <br> 748 1.1 christos <hr> 749 1.1 christos 750 1.1 christos <!====================================================================> 751 1.1 christos 752 1.1 christos <a name="HEAD_INTRO"><h2><u>Main heads</u></h2></a> 753 1.1 christos <ul> 754 1.1 christos <li><a href="#HEAD">Tag: HEAD</a> 755 1.1 christos <li><a href="#HEAD_CONTROL">Head control macros</a> 756 1.1 christos </ul> 757 1.1 christos <p> 758 1.1 christos Main heads -- or, in this documentation, just "heads" 759 1.1 christos -- should be used any place you want titles to introduce major 760 1.1 christos sections of a document. If you wish, <strong>mom</strong> can number 761 1.1 christos your heads for you. Head numbers can also be included 762 1.1 christos hierarchically in numbered 763 1.1 christos <a href="#SUBHEAD_INTRO">subheads</a> 764 1.1 christos and 765 1.1 christos <a href="#PARAHEAD_INTRO">paraheads</a>. 766 1.1 christos <p> 767 1.1 christos By default, heads are centred on the page, underlined, 768 1.1 christos all in caps. A double linespace precedes each head. In <a 769 1.1 christos href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, heads 770 1.1 christos are bold, slightly larger than paragraph text. 771 1.1 christos <p> 772 1.1 christos If these defaults don't suit you, you can change them with the 773 1.1 christos head control macros. 774 1.1 christos <p> 775 1.1 christos 776 1.1 christos <!---HEAD---> 777 1.1 christos 778 1.1 christos <hr width="66%" align="left"> 779 1.1 christos <p> 780 1.1 christos <a name="HEAD"> 781 1.1 christos <nobr>Macro: <strong>HEAD</strong> "<text of head>" [ "<2nd line>" [ "<3rd line>" ... ] ]</nobr> 782 1.1 christos </a> 783 1.1 christos 784 1.1 christos <p> 785 1.1 christos The argument to <strong>HEAD</strong> is the text of the head, 786 1.1 christos surrounded by double-quotes. If you need additional lines for a 787 1.1 christos head, simply surround each line with double-quotes. 788 1.1 christos <p> 789 1.1 christos <strong>NOTE:</strong> If a head falls near the bottom of an output page 790 1.1 christos and <strong>mom</strong> is unable to fit the head <em>plus at least 791 1.1 christos one line of text underneath it</em>, she will set the head at the 792 1.1 christos top of the next page. 793 1.1 christos <p> 794 1.1 christos <strong>ADDITIONAL NOTE:</strong> If an 795 1.1 christos <a href="definitions.html#TERMS_INPUTLINE">input line</a> 796 1.1 christos in a head (i.e. one of the lines surrounded by double-quotes) has 797 1.1 christos to be broken by <strong>mom</strong> in order to fit the current 798 1.1 christos line-length (say, a narrow column measure), the head underline 799 1.1 christos (underscore) will not behave. You'll recognize the problem as soon 800 1.1 christos as you preview your document. If you encounter a head that 801 1.1 christos misbehaves with respect to underlining, the solution is to 802 1.1 christos supply each line <em>as you want it</em> as a separate argument 803 1.1 christos (surrounded by double-quotes) to the <strong>HEAD</strong> macro. 804 1.1 christos <p> 805 1.1 christos For example, if <strong>mom</strong> breaks 806 1.1 christos <pre> 807 1.1 christos .HEAD "This is a very, very, very long head" 808 1.1 christos </pre> 809 1.1 christos into 810 1.1 christos <pre> 811 1.1 christos This is a very, very, very 812 1.1 christos long head 813 1.1 christos </pre> 814 1.1 christos 815 1.1 christos you'll see the misbehaving underscore and should change the 816 1.1 christos argument to <strong>HEAD</strong> to 817 1.1 christos <pre> 818 1.1 christos .HEAD "This is a very, very very" "long head" 819 1.1 christos </pre> 820 1.1 christos 821 1.1 christos <a name="HEAD_CONTROL"><h3><u>Head control macros</u></h3></a> 822 1.1 christos <p> 823 1.1 christos There are, in addition to the usual family/font/size/quad control 824 1.1 christos macros, a number of macros to manage head numbering, spacing, 825 1.1 christos underlining, and so on. Check them out if you're unhappy with 826 1.1 christos <strong>mom</strong>'s defaults. 827 1.1 christos <p> 828 1.1 christos <ol> 829 1.1 christos <li><a href="#HEAD_GENERAL">Family/font/size/colour/quad</a> 830 1.1 christos <li><a href="#HEAD_CAPS">Caps</a> 831 1.1 christos <li><a href="#HEAD_SPACE">Pre-head space</a> 832 1.1 christos <li><a href="#HEAD_UNDERLINE">Underlining</a> 833 1.1 christos <li><a href="#NUMBER_HEADS">Numbering</a> 834 1.1 christos <li><a href="#RESET_HEAD_NUMBER">Reset head numbering</a> 835 1.1 christos <li><a href="#HEAD_INLINES">Vertical inline escapes inside heads</a> 836 1.1 christos </ol> 837 1.1 christos <p> 838 1.1 christos <a name="HEAD_GENERAL"><h3><u>1. Family/font/size/colour/quad</u></h3></a> 839 1.1 christos <p> 840 1.1 christos See 841 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 842 1.1 christos <p> 843 1.1 christos <pre> 844 1.1 christos .HEAD_FAMILY default = prevailing document family; default is Times Roman 845 1.1 christos .HEAD_FONT default = bold 846 1.1 christos .HEAD_SIZE default = +1 (point) 847 1.1 christos .HEAD_COLOR default = black 848 1.1 christos .HEAD_QUAD default = CENTER 849 1.1 christos </pre> 850 1.1 christos 851 1.1 christos <a name="HEAD_CAPS"><h3><u>2. Capitalizing heads -- HEAD_CAPS</u></h3></a> 852 1.1 christos <p> 853 1.1 christos By default, <strong>mom</strong> sets heads in caps, regardless 854 1.1 christos of the 855 1.1 christos <a href="definitions.html#TERMS_STRINGARGUMENT">string(s)</a> 856 1.1 christos you give to 857 1.1 christos <a href="#HEAD">HEAD</a>. 858 1.1 christos To change this behaviour, do 859 1.1 christos <p> 860 1.1 christos <pre> 861 1.1 christos .HEAD_CAPS OFF 862 1.1 christos </pre> 863 1.1 christos 864 1.1 christos <strong>HEAD_CAPS</strong> is a toggle macro, therefore you can use 865 1.1 christos any argument you like instead of <strong>OFF</strong> (<strong>END, 866 1.1 christos QUIT, Q, X</strong>...). To turn <strong>HEAD_CAPS</strong> back on, 867 1.1 christos simply invoke it without an argument. 868 1.1 christos <p> 869 1.1 christos 870 1.1 christos <a name="HEAD_SPACE"><h3><u>3. Space before heads -- HEAD_SPACE</u></h3></a> 871 1.1 christos <p> 872 1.1 christos By default, <strong>mom</strong> deposits 2 blank lines prior to every 873 1.1 christos head. If you'd prefer just a single blank line, do 874 1.1 christos <p> 875 1.1 christos <pre> 876 1.1 christos .HEAD_SPACE OFF 877 1.1 christos </pre> 878 1.1 christos 879 1.1 christos <strong>HEAD_SPACE</strong> is a toggle macro, therefore you can use 880 1.1 christos any argument you like instead of <strong>OFF</strong> (<strong>END, 881 1.1 christos QUIT, Q, X</strong>...). To restore the space before heads to 2 882 1.1 christos blank lines, invoke <strong>HEAD_SPACE</strong> without an argument. 883 1.1 christos <p> 884 1.1 christos 885 1.1 christos <a name="HEAD_UNDERLINE"><h3><u>4. Underlining heads -- HEAD_UNDERLINE</u></h3></a> 886 1.1 christos <p> 887 1.1 christos By default, <strong>mom</strong> underlines heads. To change this 888 1.1 christos behaviour, do 889 1.1 christos <p> 890 1.1 christos <pre> 891 1.1 christos .HEAD_UNDERLINE OFF 892 1.1 christos </pre> 893 1.1 christos 894 1.1 christos <strong>HEAD_UNDERLINE</strong> is a toggle macro, therefore you can 895 1.1 christos use any argument you like instead of <strong>OFF</strong> (<strong>END, 896 1.1 christos QUIT, Q, X</strong>...). To restore underlining of heads, invoke 897 1.1 christos <strong>HEAD_UNDERLINE</strong> without an argument. 898 1.1 christos <p> 899 1.1 christos 900 1.1 christos <a name="NUMBER_HEADS"><h3><u>5. Number heads -- NUMBER_HEADS</u></h3></a> 901 1.1 christos <p> 902 1.1 christos If you'd like your heads numbered, simply invoke 903 1.1 christos <strong>NUMBER_HEADS</strong> with no argument. <strong>Mom</strong> 904 1.1 christos will number all subsequent heads automatically (in ascending order, 905 1.1 christos naturally). 906 1.1 christos <p> 907 1.1 christos If, in addition to numbering heads, you also request that 908 1.1 christos <a href="#SUBHEAD_INTRO">subheads</a> 909 1.1 christos and/or 910 1.1 christos <a href="#PARAHEAD_INTRO">paraheads</a> 911 1.1 christos be numbered, the head number will be included in their numbers 912 1.1 christos (each number separated by a period [dot]). 913 1.1 christos <p> 914 1.1 christos Should you wish to stop head numbering, invoke 915 1.1 christos <strong>NUMBER_HEADS</strong> with any argument (<strong>OFF, QUIT, 916 1.1 christos END, X</strong>...). Head numbering will cease, and the head number 917 1.1 christos will not be included in the numbering of subheads and/or paraheads. 918 1.1 christos <p> 919 1.1 christos 920 1.1 christos <a name="RESET_HEAD_NUMBER"><h3><u>6. Reset head numbering -- RESET_HEAD_NUMBER</u></h3></a> 921 1.1 christos <p> 922 1.1 christos Should you wish to reset the head number to "1", invoke 923 1.1 christos <strong>RESET_HEAD_NUMBER</strong> with no argument. If, for some 924 1.1 christos reason, you want <strong>mom</strong> to use a head number that is not 925 1.1 christos the next in ascending order (i.e. the last head number + 1), invoke 926 1.1 christos <strong>RESET_HEAD_NUMBER</strong> with the number you want, e.g. 927 1.1 christos <p> 928 1.1 christos <pre> 929 1.1 christos .RESET_HEAD_NUMBER 6 930 1.1 christos </pre> 931 1.1 christos 932 1.1 christos Your next head will be numbered "6" and subsequent heads will 933 1.1 christos be numbered in ascending order from "6". 934 1.1 christos <p> 935 1.1 christos 936 1.1 christos <a name="HEAD_INLINES"><h3><u>7. Vertical inline escapes inside heads</u></h3></a> 937 1.1 christos <p> 938 1.1 christos If you need to adjust the 939 1.1 christos <a href="definitions.html#TERMS_BASELINE">baseline</a> 940 1.1 christos position of a head (e.g. the head falls at the top of a column and 941 1.1 christos you want its 942 1.1 christos <a href="definitions.html#TERMS_ASCENDER">ascenders</a> 943 1.1 christos to line up with the ascenders of 944 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a> 945 1.1 christos in other columns), you can embed a vertical motion 946 1.1 christos <a href="definitions.html#TERMS_INLINES">inline escape</a> 947 1.1 christos (either 948 1.1 christos <a href="inlines.html#INLINE_VERTICAL_MOM">mom</a>'s 949 1.1 christos or 950 1.1 christos <a href="inlines.html#INLINE_VERTICAL_GROFF">groff</a>'s 951 1.1 christos in the string(s) you pass to <strong>HEAD</strong> 952 1.1 christos <p> 953 1.1 christos For example, 954 1.1 christos <p> 955 1.1 christos <pre> 956 1.1 christos .HEAD "\[ALD3]Text of head" 957 1.1 christos or 958 1.1 christos .HEAD "\[DOWN 3p]Text of head" 959 1.1 christos </pre> 960 1.1 christos 961 1.1 christos will lower the baseline of the head by three points. Note that 962 1.1 christos there's no need to reverse the sense of the inline escape. 963 1.1 christos <p> 964 1.1 christos In the case of heads that run to more than one line, you must embed 965 1.1 christos the escape in the string for each line, like this: 966 1.1 christos <p> 967 1.1 christos <pre> 968 1.1 christos .HEAD "\[ALD3]First line" "\[ALD3]Next line" 969 1.1 christos or 970 1.1 christos .HEAD "\[DOWN 3p]First line" "\[DOWN 3p]Next line" 971 1.1 christos </pre> 972 1.1 christos <hr> 973 1.1 christos 974 1.1 christos <!====================================================================> 975 1.1 christos 976 1.1 christos <a name="SUBHEAD_INTRO"><h2><u>Subheads</u></h2></a> 977 1.1 christos <ul> 978 1.1 christos <li><a href="#SUBHEAD">Tag: SUBHEAD</a> 979 1.1 christos <li><a href="#SUBHEAD_CONTROL">Subhead control macros</a> 980 1.1 christos </ul> 981 1.1 christos <p> 982 1.1 christos Subheads should be used any place you want titles to introduce 983 1.1 christos sections of a document below heads. If you wish, <strong>mom</strong> 984 1.1 christos can number subheads for you. Subhead numbers can also be included 985 1.1 christos hierarchically in numbered 986 1.1 christos <a href="#PARAHEAD_INTRO">paraheads</a>. 987 1.1 christos <p> 988 1.1 christos By default, subheads are flush left. In 989 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, 990 1.1 christos they are set bold, slightly larger than paragraph text. In 991 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 992 1.1 christos they are underlined. A single linespace precedes them in both 993 1.1 christos printstyles, and a tiny space adjustment raises them slightly 994 1.1 christos above text that comes afterwards for greater clarity in 995 1.1 christos document structuring. 996 1.1 christos <p> 997 1.1 christos If these defaults don't suit you, you can change them with the 998 1.1 christos subhead control macros. 999 1.1 christos <p> 1000 1.1 christos 1001 1.1 christos <!---SUBHEAD---> 1002 1.1 christos 1003 1.1 christos <hr width="66%" align="left"> 1004 1.1 christos <p> 1005 1.1 christos <a name="SUBHEAD"> 1006 1.1 christos <nobr>Macro: <strong>SUBHEAD</strong> "<text of subhead>" [ "<2nd line>" [ "<3rd line>" ... ] ]</nobr> 1007 1.1 christos </a> 1008 1.1 christos <p> 1009 1.1 christos The argument to <strong>SUBHEAD</strong> is the text of the subhead, 1010 1.1 christos surrounded by double-quotes. If you need additional lines for a 1011 1.1 christos subhead, simply surround each line with double-quotes. 1012 1.1 christos <p> 1013 1.1 christos <strong>NOTE:</strong> If a subhead falls near the bottom of an output 1014 1.1 christos page and <strong>mom</strong> is unable to fit the head <em>plus at 1015 1.1 christos least one line of text underneath it</em>, she will set the subhead 1016 1.1 christos at the top of the next page. 1017 1.1 christos 1018 1.1 christos <a name="SUBHEAD_CONTROL"><h3><u>Subhead control macros</u></h3></a> 1019 1.1 christos <p> 1020 1.1 christos In addition to the usual family/font/size/quad control 1021 1.1 christos macros, there are macros to manage subhead numbering. 1022 1.1 christos <p> 1023 1.1 christos <ol> 1024 1.1 christos <li><a href="#SUBHEAD_GENERAL">Family/font/size/colour/quad</a> 1025 1.1 christos <li><a href="#NUMBER_SUBHEADS">Numbering</a> 1026 1.1 christos <li><a href="#RESET_SUBHEAD_NUMBER">Reset subhead numbering</a> 1027 1.1 christos <li><a href="#SUBHEAD_INLINES">Vertical inline escapes inside subheads</a> 1028 1.1 christos </ol> 1029 1.1 christos <p> 1030 1.1 christos <a name="SUBHEAD_GENERAL"><h3><u>1. Family/font/size/quad</u></h3></a> 1031 1.1 christos <p> 1032 1.1 christos See 1033 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 1034 1.1 christos <p> 1035 1.1 christos <pre> 1036 1.1 christos .SUBHEAD_FAMILY default = prevailing document family; default is Times Roman 1037 1.1 christos .SUBHEAD_FONT default = bold 1038 1.1 christos .SUBHEAD_SIZE default = +.5 (point) 1039 1.1 christos .SUBHEAD_COLOR default = black 1040 1.1 christos .SUBHEAD_QUAD default = LEFT 1041 1.1 christos </pre> 1042 1.1 christos 1043 1.1 christos <a name="NUMBER_SUBHEADS"><h3><u>2. Number subheads -- NUMBER_SUBHEADS</u></h3></a> 1044 1.1 christos <p> 1045 1.1 christos If you'd like your subheads numbered, simply invoke 1046 1.1 christos <strong>.NUMBER_SUBHEADS</strong> with no argument. 1047 1.1 christos <strong>Mom</strong> will number all subsequent subheads automatically 1048 1.1 christos (in ascending order, naturally). 1049 1.1 christos <p> 1050 1.1 christos If, in addition to numbering subheads, you also request that 1051 1.1 christos <a href="#HEAD_INTRO">heads</a> 1052 1.1 christos be numbered, the head number will be included in the subhead number 1053 1.1 christos (separated by a period [dot]). 1054 1.1 christos <p> 1055 1.1 christos Should you wish to stop subhead numbering, invoke 1056 1.1 christos <strong>NUMBER_SUBHEADS</strong> with any argument (<strong>OFF, QUIT, 1057 1.1 christos END, X</strong>...). Subhead numbering will cease, and the subhead 1058 1.1 christos number will not be included in the numbering of paraheads. 1059 1.1 christos <p> 1060 1.1 christos 1061 1.1 christos <a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a> 1062 1.1 christos <p> 1063 1.1 christos Should you wish to reset the subhead number to "1", invoke 1064 1.1 christos <strong>RESET_SUBHEAD_NUMBER</strong> with no argument. If, for some 1065 1.1 christos reason, you want <strong>mom</strong> to use a subhead number that is not 1066 1.1 christos the next in ascending order (i.e. the last subhead number + 1), invoke 1067 1.1 christos <strong>RESET_SUBHEAD_NUMBER</strong> with the number you want, e.g. 1068 1.1 christos <p> 1069 1.1 christos <pre> 1070 1.1 christos .RESET_SUBHEAD_NUMBER 4 1071 1.1 christos </pre> 1072 1.1 christos 1073 1.1 christos Your next subhead will be numbered "4" and subsequent 1074 1.1 christos subheads will be numbered in ascending order from "4". 1075 1.1 christos 1076 1.1 christos <a name="SUBHEAD_INLINES"><h3><u>Vertical inline escapes inside subheads</u></h3></a> 1077 1.1 christos See 1078 1.1 christos <a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>. 1079 1.1 christos The information there applies equally to subheads. 1080 1.1 christos <p> 1081 1.1 christos <hr> 1082 1.1 christos 1083 1.1 christos <!====================================================================> 1084 1.1 christos 1085 1.1 christos <a name="PARAHEAD_INTRO"><h2><u>Paragraph heads</u></h2></a> 1086 1.1 christos <ul> 1087 1.1 christos <li><a href="#PARAHEAD">Tag: PARAHEAD</a> 1088 1.1 christos <li><a href="#PARAHEAD_CONTROL">Parahead control macros</a> 1089 1.1 christos </ul> 1090 1.1 christos <p> 1091 1.1 christos Paragraph heads (paraheads) should be used any place you want titles 1092 1.1 christos to introduce paragraphs below heads or subheads. If you wish, 1093 1.1 christos <strong>mom</strong> can number paraheads for you. 1094 1.1 christos <p> 1095 1.1 christos By default, paraheads are joined to the body of a paragraph, 1096 1.1 christos slightly indented (provided the paragraph is not a 1097 1.1 christos "first" paragraph as defined in 1098 1.1 christos <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>). 1099 1.1 christos In 1100 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, 1101 1.1 christos they are set bold italic, slightly larger than paragraph text. In 1102 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 1103 1.1 christos they are underlined. 1104 1.1 christos <p> 1105 1.1 christos If these defaults don't suit you, you can change them with the 1106 1.1 christos parahead control macros. 1107 1.1 christos <p> 1108 1.1 christos 1109 1.1 christos <!---PARAHEAD---> 1110 1.1 christos 1111 1.1 christos <hr width="66%" align="left"> 1112 1.1 christos <p> 1113 1.1 christos <a name="PARAHEAD"> 1114 1.1 christos <nobr>Macro: <strong>PARAHEAD</strong> "<text of parahead>"</nobr> 1115 1.1 christos </a> 1116 1.1 christos <p> 1117 1.1 christos <strong>PARAHEAD</strong> must come AFTER 1118 1.1 christos <a href="#PP">PP</a> 1119 1.1 christos or it will not work! 1120 1.1 christos <p> 1121 1.1 christos The argument is the text of the parahead, surrounded by double-quotes. 1122 1.1 christos Because paraheads are joined to the body of a paragraph, they accept 1123 1.1 christos only one argument (see 1124 1.1 christos <a href="#HEAD">HEAD</a> 1125 1.1 christos and 1126 1.1 christos <a href="#SUBHEAD">SUBHEAD</a>). 1127 1.1 christos <p> 1128 1.1 christos 1129 1.1 christos <a name="PARAHEAD_CONTROL"><h3><u>Parahead control macros</u></h3></a> 1130 1.1 christos <p> 1131 1.1 christos In addition to the family/font/size/colour/indent control macros, 1132 1.1 christos there are macros to manage parahead numbering. 1133 1.1 christos <p> 1134 1.1 christos <ol> 1135 1.1 christos <li><a href="#PARAHEAD_GENERAL">Family/font/size/color</a> 1136 1.1 christos <li><a href="#PARAHEAD_INDENT">Indent</a> 1137 1.1 christos <li><a href="#NUMBER_PARAHEADS">Numbering</a> 1138 1.1 christos <li><a href="#RESET_PARAHEAD_NUMBER">Reset parahead numbering</a> 1139 1.1 christos </ol> 1140 1.1 christos <p> 1141 1.1 christos <a name="PARAHEAD_GENERAL"><h3><u>1. Family/font/size/colour</u></h3></a> 1142 1.1 christos <p> 1143 1.1 christos See 1144 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 1145 1.1 christos <p> 1146 1.1 christos <pre> 1147 1.1 christos .PARAHEAD_FAMILY default = prevailing document family; default is Times Roman 1148 1.1 christos .PARAHEAD_FONT default = bold italic 1149 1.1 christos .PARAHEAD_SIZE default = +.5 (point) 1150 1.1 christos <a name="PARAHEAD_COLOR">.PARAHEAD_COLOR default = black*</a> 1151 1.1 christos 1152 1.1 christos *If you colourize paragraph text, paraheads will appear in the same 1153 1.1 christos colour as the text unless you explicitly tell mom to colour them 1154 1.1 christos otherwise by invoking .PARAHEAD_COLOR. If you do want paraheads 1155 1.1 christos that are coloured the same as paragraph text, it's generally a good 1156 1.1 christos idea to invoke .PARAHEAD_COLOR anyway (with the same colour used 1157 1.1 christos for paragraph text), just to let mom know. 1158 1.1 christos </pre> 1159 1.1 christos 1160 1.1 christos <a name="PARAHEAD_INDENT"><h3><u>2. Indent</u></h3></a> 1161 1.1 christos <p> 1162 1.1 christos Unlike other control macros that end in 1163 1.1 christos <a href="#CONTROL_INDENTS"><strong>_INDENT</strong></a>, 1164 1.1 christos the argument to the macro that controls indenting of paragraph heads 1165 1.1 christos (<strong>PARAHEAD_INDENT</strong>) is NOT relative to the first-line 1166 1.1 christos indent of normal paragraphs. In other words, it takes an absolute 1167 1.1 christos value, and requires a 1168 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 1169 1.1 christos For example, to set the paragraph head indent to 2-1/2 picas, you 1170 1.1 christos do: 1171 1.1 christos <p> 1172 1.1 christos <pre> 1173 1.1 christos .PARAHEAD_INDENT 2.5P 1174 1.1 christos </pre> 1175 1.1 christos <strong>Mom</strong>'s default indent for paragraph heads is 1/2 1176 1.1 christos the first-line indent of normal paragraphs (both printstyles). 1177 1.1 christos However, as stated above, if you choose to change the indent, you 1178 1.1 christos must give an absolute value (unless you're a groff expert and want 1179 1.1 christos to manipulate the number register <code>\n[#PP_INDENT]u</code> 1180 1.1 christos arithmetically as the argument to <strong>PARAHEAD_INDENT</strong> 1181 1.1 christos for an indent that's relative to <strong>PP_INDENT</strong>.) 1182 1.1 christos <p> 1183 1.1 christos <strong>NOTE:</strong> Paragraph heads in "first 1184 1.1 christos paragraphs", as defined in 1185 1.1 christos <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>, 1186 1.1 christos are not indented unless you turn 1187 1.1 christos <a href="#INDENT_FIRST_PARAS">INDENT_FIRST_PARAS</a> 1188 1.1 christos on. 1189 1.1 christos <p> 1190 1.1 christos 1191 1.1 christos <a name="NUMBER_PARAHEADS"><h3><u>3. Number paraheads -- NUMBER_PARAHEADS</u></h3></a> 1192 1.1 christos <p> 1193 1.1 christos If you'd like your paraheads numbered, simply invoke 1194 1.1 christos <strong>.NUMBER_PARAHEADS</strong> with no argument. 1195 1.1 christos <strong>Mom</strong> will number all subsequent paraheads automatically 1196 1.1 christos (in ascending order, naturally). 1197 1.1 christos <p> 1198 1.1 christos If, in addition to numbering paraheads, you also request that 1199 1.1 christos <a href="#HEAD_INTRO">heads</a> 1200 1.1 christos and 1201 1.1 christos <a href="#SUBHEAD_INTRO">subheads</a> 1202 1.1 christos be numbered, the head and/or subhead number will be included in the 1203 1.1 christos parahead number (separated by a period [dot]). 1204 1.1 christos <p> 1205 1.1 christos Should you wish to stop parahead numbering, invoke 1206 1.1 christos <strong>NUMBER_PARAHEADS</strong> with any argument (<strong>OFF, 1207 1.1 christos QUIT, END, X</strong>...). Parahead numbering will cease. 1208 1.1 christos <p> 1209 1.1 christos 1210 1.1 christos <a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a> 1211 1.1 christos <p> 1212 1.1 christos Should you wish to reset the parahead number to "1", invoke 1213 1.1 christos <strong>RESET_PARAHEAD_NUMBER</strong> with no argument. If, for some 1214 1.1 christos reason, you want <strong>mom</strong> to use a parahead number that is not 1215 1.1 christos the next in ascending order (i.e. the last parahead number + 1), invoke 1216 1.1 christos <strong>RESET_PARAHEAD_NUMBER</strong> with the number you want, e.g. 1217 1.1 christos <p> 1218 1.1 christos <pre> 1219 1.1 christos .RESET_PARAHEAD_NUMBER 7 1220 1.1 christos </pre> 1221 1.1 christos 1222 1.1 christos Your next parahead will be numbered "7" and subsequent 1223 1.1 christos paraheads will be numbered in ascending order from "7". 1224 1.1 christos <p> 1225 1.1 christos <hr> 1226 1.1 christos 1227 1.1 christos <!====================================================================> 1228 1.1 christos 1229 1.1 christos <a name="LINEBREAK_INTRO"><h2><u>Author linebreaks</u></h2></a> 1230 1.1 christos <ul> 1231 1.1 christos <li><a href="#LINEBREAK">Tag: LINEBREAK</a> 1232 1.1 christos <li><a href="#LINEBREAK_CHAR">Linebreak character control macro</a> 1233 1.1 christos </ul> 1234 1.1 christos <p> 1235 1.1 christos By default, <strong>mom</strong> marks 1236 1.1 christos <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a> 1237 1.1 christos with three centred asterisks. You can change this behaviour 1238 1.1 christos with the linebreak character 1239 1.1 christos <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>. 1240 1.1 christos <p> 1241 1.1 christos 1242 1.1 christos <!---LINEBREAK---> 1243 1.1 christos 1244 1.1 christos <hr width="66%" align="left"> 1245 1.1 christos <p> 1246 1.1 christos <a name="LINEBREAK"> 1247 1.1 christos Macro: <strong>LINEBREAK</strong> 1248 1.1 christos </a> 1249 1.1 christos <br> 1250 1.1 christos Alias: <strong>SECTION</strong> 1251 1.1 christos 1252 1.1 christos <p> 1253 1.1 christos <strong>LINEBREAK</strong> takes no arguments. Simply invoke it 1254 1.1 christos (on a line by itself, of course) whenever you want to insert an 1255 1.1 christos author linebreak. The appearance of the linebreak is controlled 1256 1.1 christos by the 1257 1.1 christos <a href="#LINEBREAK_CHAR">LINEBREAK_CHAR</a> 1258 1.1 christos macro. 1259 1.1 christos 1260 1.1 christos <h3><u>Linebreak character control macro</u></h3> 1261 1.1 christos <p> 1262 1.1 christos <a name="LINEBREAK_CHAR"> 1263 1.1 christos <nobr>Macro: <strong>LINEBREAK_CHAR</strong> [ <character> ] [ <iterations> [ <vertical adjustment> ] ]</nobr> 1264 1.1 christos </a> 1265 1.1 christos <br> 1266 1.1 christos Alias: <strong>SECTION_CHAR</strong> 1267 1.1 christos <br> 1268 1.1 christos <em>*The third optional argument requires a 1269 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>. 1270 1.1 christos <p> 1271 1.1 christos <strong>LINEBREAK_CHAR</strong> determines what <strong>mom</strong> 1272 1.1 christos prints when <strong>LINEBREAK</strong> is invoked. It takes 3 1273 1.1 christos optional arguments: the character you want deposited at the line 1274 1.1 christos break, the number of times you want the character repeated, and a 1275 1.1 christos vertical adjustment factor. 1276 1.1 christos <p> 1277 1.1 christos The first argument is any legal groff character (e.g. <kbd>*</kbd> 1278 1.1 christos [an asterisk], <kbd>\(dg</kbd> [a dagger], <kbd>\f(ZD\N'141\fP</kbd> 1279 1.1 christos [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd> 1280 1.1 christos [a 4-pica long rule]). <strong>Mom</strong> sets the character 1281 1.1 christos centred on the current line length. (See "man groff_char" 1282 1.1 christos for a list of all legal groff characters.) 1283 1.1 christos <p> 1284 1.1 christos The second argument is the number of times to repeat the character. 1285 1.1 christos <p> 1286 1.1 christos The third argument is a +|- value by which to raise (+) or lower (-) 1287 1.1 christos the character in order to make it appear visually centred between 1288 1.1 christos sections of text. This lets you make vertical adjustments 1289 1.1 christos to characters that don't sit on the 1290 1.1 christos <a href="definitions.html#TERMS_BASELINE">baseline</a> 1291 1.1 christos (such as asterisks). The argument must be preceded by a plus or 1292 1.1 christos minus sign, and must include a unit of measure. 1293 1.1 christos <p> 1294 1.1 christos If you enter <strong>LINEBREAK_CHAR</strong> with no arguments, 1295 1.1 christos sections of text will be separated by two blank lines when you invoke 1296 1.1 christos <strong>LINEBREAK</strong>. 1297 1.1 christos <p> 1298 1.1 christos <strong>Mom</strong>'s default for <strong>LINEBREAK_CHAR</strong> is 1299 1.1 christos <p> 1300 1.1 christos <pre> 1301 1.1 christos .LINEBREAK_CHAR * 3 -3p 1302 1.1 christos </pre> 1303 1.1 christos 1304 1.1 christos i.e. three asterisks, lowered 3 points from their normal vertical 1305 1.1 christos position (for 1306 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>; 1307 1.1 christos the vertical adjustment is -2 points for 1308 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>). 1309 1.1 christos 1310 1.1 christos <h3><u>Linebreak colour control macro</u></h3> 1311 1.1 christos <p> 1312 1.1 christos <a name="LINEBREAK_COLOR"> 1313 1.1 christos <nobr>Macro: <strong>LINEBREAK_COLOR</strong> <color name></nobr> 1314 1.1 christos </a> 1315 1.1 christos <p> 1316 1.1 christos To change the colour of the linebreak character(s), simply invoke 1317 1.1 christos <strong>LINBREAK_COLOR</strong> with the name of a pre-defined (or 1318 1.1 christos "initialized") colour. 1319 1.1 christos <br> 1320 1.1 christos <hr> 1321 1.1 christos 1322 1.1 christos <!====================================================================> 1323 1.1 christos 1324 1.1 christos <a name="QUOTE_INTRO"><h2><u>Quotes (line for line)</u></h2></a> 1325 1.1 christos <ul> 1326 1.1 christos <li><a href="#QUOTE">Tag: QUOTE</a> 1327 1.1 christos <li><a href="#QUOTE_CONTROL">Quote control macros</a> 1328 1.1 christos </ul> 1329 1.1 christos <p> 1330 1.1 christos <a href="definitions.html#TERMS_QUOTE">Quotes</a> 1331 1.1 christos are always set in 1332 1.1 christos <a href="definitions.html#TERMS_NOFILL">nofill mode</a>, 1333 1.1 christos flush left. This permits entering quotes on a line for line basis in 1334 1.1 christos your text editor and have them come out the same way on output copy. 1335 1.1 christos (See 1336 1.1 christos <a href="#BLOCKQUOTE_INTRO">Blockquotes</a> 1337 1.1 christos for how quotes, in the present sense, differ from longer 1338 1.1 christos passages of cited text.) 1339 1.1 christos <p> 1340 1.1 christos Since <strong>mom</strong> originally came into being to serve 1341 1.1 christos the needs of creative writers (i.e. novelists, short story 1342 1.1 christos writers, etc. -- not to cast aspersions on the creativity of 1343 1.1 christos mathematicians and programmers), she sets quotes in italics 1344 1.1 christos <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET)</a> 1345 1.1 christos or underlined 1346 1.1 christos <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPEWRITE)</a>, 1347 1.1 christos indented from the left margin. Obviously, she's thinking 1348 1.1 christos "quotes from poetry or song lyrics", but with the 1349 1.1 christos <a href="#QUOTE_CONTROL">quote control macros</a> 1350 1.1 christos you can change her defaults so <strong>QUOTE</strong> serves other 1351 1.1 christos needs, e.g. entering verbatim snippets of programming code, command 1352 1.1 christos line instructions, and so on. (See the 1353 1.1 christos <a href="#QUOTE_TIP">tip</a> 1354 1.1 christos below for suggestions about including programming code snippets in 1355 1.1 christos documents.) 1356 1.1 christos <p> 1357 1.1 christos <a name="QUOTE_SPACING"></a> 1358 1.1 christos Besides indenting quotes, <strong>mom</strong> further sets them 1359 1.1 christos off from 1360 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a> 1361 1.1 christos with a small amount of vertical whitespace top and bottom. In 1362 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 1363 1.1 christos this is always one full linespace. In 1364 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, 1365 1.1 christos it's 1/2 of the prevailing 1366 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a> 1367 1.1 christos if the quote fits fully on the page (i.e. with running text above 1368 1.1 christos and below it), otherwise it's a full linespace either above or below 1369 1.1 christos as is necessary to balance the page to the bottom margin. This 1370 1.1 christos behaviour can be changed with the control macro 1371 1.1 christos <a href="#ALWAYS_FULLSPACE_QUOTES">ALWAYS_FULLSPACE_QUOTES</a>. 1372 1.1 christos <p> 1373 1.1 christos <strong>NOTE:</strong> <strong>ALWAYS_FULLSPACE_QUOTES</strong> 1374 1.1 christos applies to both 1375 1.1 christos <a href="#QUOTE">QUOTE</a> 1376 1.1 christos and 1377 1.1 christos <a href="#BLOCKQUOTE">BLOCKQUOTE</a>, 1378 1.1 christos as does the control macro 1379 1.1 christos <a href="#QUOTE_INDENT">QUOTE_INDENT</a>. 1380 1.1 christos <p> 1381 1.1 christos <strong>Version 1.3: mom</strong>'s handling of the vertical 1382 1.1 christos whitespace around quotes has changed slightly. In versions prior 1383 1.1 christos to 1.3, it was not possible to alter the 1384 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a> 1385 1.1 christos of quotes and blockquotes (which was the same as the document 1386 1.1 christos leading), ensuring that the vertical whitespace remained consistent, 1387 1.1 christos as described above. In 1.3 and later, it is possible to change the 1388 1.1 christos leading of quotes and blockquote via 1389 1.1 christos the <strong>QUOTE_AUTOLEAD</strong> and 1390 1.1 christos <strong>BLOCKQUOTE_AUTOLEAD</strong>macro. Now, if your quote 1391 1.1 christos (or blockquote) leading differs from the document leading, 1392 1.1 christos <strong>mom</strong> attempts to observe the same rules for vertical 1393 1.1 christos whitespace outlined above; however, she will also insert a small, 1394 1.1 christos flexible amount of extra whitespace around the quotes to make sure 1395 1.1 christos the whitespace is equal, top and bottom. Since she does this on a 1396 1.1 christos quote by quote basis, rather than by figuring out how much extra 1397 1.1 christos whitespace is needed to adjust <em>all</em> quotes on a page, 1398 1.1 christos the spacing around multiple quotes on the same page will differ 1399 1.1 christos slightly, although each will be balanced between lines of normal 1400 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a>, 1401 1.1 christos top and bottom. (The inability to scan an entire page and insert 1402 1.1 christos equalized whitespace at marked places is a limitation of groff, 1403 1.1 christos which, by and large, works in a linear, line by line fashion.) 1404 1.1 christos If you don't provide <strong>mom</strong> with a 1405 1.1 christos <strong>QUOTE_AUTOLEAD</strong>, quotes are leaded at the default 1406 1.1 christos for normal running text, meaning that multiple quotes on the same 1407 1.1 christos page are all spaced identically. 1408 1.1 christos <p> 1409 1.1 christos <a name="QUOTE_TIP"><strong>TIP:</strong></a> 1410 1.1 christos If you want to include snippets of programming code in 1411 1.1 christos <strong>mom</strong> documents, you may come acropper of the fact 1412 1.1 christos that groff (and <strong>mom</strong>'s) escape character is the 1413 1.1 christos backslash. In order for <strong>mom</strong> not to interpret 1414 1.1 christos backslashes that occur in code snippets as escapes, you have to 1415 1.1 christos tell <strong>mom</strong> that the backslash character is 1416 1.1 christos (temporarily) no longer the escape character. The easiest way 1417 1.1 christos to do this is to set the escape character to something else for 1418 1.1 christos the duration of the code snippet. You accomplish this with 1419 1.1 christos <strong>ESC_CHAR</strong>, like this: 1420 1.1 christos <p> 1421 1.1 christos <pre> 1422 1.1 christos .ESC_CHAR c 1423 1.1 christos </pre> 1424 1.1 christos 1425 1.1 christos where "c", above, is the alternate escape character 1426 1.1 christos (which should be a character that does not appear in the code). To 1427 1.1 christos set the escape character back to the backslash, simply invoke 1428 1.1 christos <strong>.ESC_CHAR</strong> by itself (i.e. with no argument). 1429 1.1 christos <p> 1430 1.1 christos Because <strong>mom</strong>, by default, sets the text after 1431 1.1 christos <strong>.QUOTE</strong> in italic (for <strong>PRINTSTYLE 1432 1.1 christos TYPESET</strong>) or underlined (for <strong>PRINTSTYLE 1433 1.1 christos TYPEWRITE</strong>), you'll want to change that behaviour as 1434 1.1 christos well. Therefore, a recipe for setting verbatim code snippets using 1435 1.1 christos <strong>QUOTE</strong> could be (assuming you want a fixed width 1436 1.1 christos font like Courier): 1437 1.1 christos <p> 1438 1.1 christos <pre> 1439 1.1 christos \# You only need the first two lines before the first invocation 1440 1.1 christos \# of QUOTE. They stay in effect for all subsequent invocations. 1441 1.1 christos \# 1442 1.1 christos .QUOTE_FONT CR \" Set quote font to Courier roman 1443 1.1 christos .UNDERLINE_QUOTES OFF \" Don't underline quotes in TYPEWRITE 1444 1.1 christos .QUOTE 1445 1.1 christos .ESC_CHAR ^ \" Change escape character to ^ 1446 1.1 christos <code snippet> 1447 1.1 christos .ESC_CHAR \" Restore escape character to \ 1448 1.1 christos .QUOTE OFF 1449 1.1 christos 1450 1.1 christos </pre> 1451 1.1 christos 1452 1.1 christos <!---QUOTE---> 1453 1.1 christos 1454 1.1 christos <hr width="66%" align="left"> 1455 1.1 christos <p> 1456 1.1 christos <a name="QUOTE"> 1457 1.1 christos <nobr>Macro: <strong>QUOTE</strong> toggle</nobr> 1458 1.1 christos </a> 1459 1.1 christos 1460 1.1 christos <p> 1461 1.1 christos <strong>QUOTE</strong> is a toggle macro. To begin a section of 1462 1.1 christos quoted text, invoke it with no argument, then type in your quote. 1463 1.1 christos When you're finished, invoke <strong>QUOTE</strong> with any 1464 1.1 christos argument (e.g. OFF, END, X, Q...) to turn it off. Example: 1465 1.1 christos <p> 1466 1.1 christos <pre> 1467 1.1 christos .QUOTE 1468 1.1 christos Nymphomaniacal Jill 1469 1.1 christos Used a dynamite stick for a thrill 1470 1.1 christos They found her vagina 1471 1.1 christos In North Carolina 1472 1.1 christos And bits of her tits in Brazil. 1473 1.1 christos .QUOTE END 1474 1.1 christos </pre> 1475 1.1 christos 1476 1.1 christos <a name="QUOTE_CONTROL"><h3><u>Quote control macros</u></h3></a> 1477 1.1 christos <ol> 1478 1.1 christos <li><a href="#QUOTE_GENERAL">Family/font/size/leading/colour/indent</a> 1479 1.1 christos <li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a> 1480 1.1 christos <li><a href="#UNDERLINE_QUOTES">Underline quotes (typewrite only)</a> 1481 1.1 christos <li><a href="#BREAK_QUOTE">Manually break a footnoted quote that crosses pages/columns</a> 1482 1.1 christos </ol> 1483 1.1 christos <p> 1484 1.1 christos <a name="QUOTE_GENERAL"><h3><u>1. Family/font/size/colour/indent</u></h3></a> 1485 1.1 christos <p> 1486 1.1 christos See 1487 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 1488 1.1 christos <p> 1489 1.1 christos <pre> 1490 1.1 christos .QUOTE_FAMILY default = prevailing document family; default is Times Roman 1491 1.1 christos .QUOTE_FONT default = italic; underlined in TYPEWRITE 1492 1.1 christos .QUOTE_SIZE default = +0 (i.e. same size as paragraph text) 1493 1.1 christos .QUOTE_AUTOLEAD default = none; leading of quotes is the same as paragraphs 1494 1.1 christos .QUOTE_COLOR default = black 1495 1.1 christos <a name="QUOTE_INDENT">.QUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a> 1496 1.1 christos (note that this macro also sets the indents (left and right) 1497 1.1 christos for blockquotes) 1498 1.1 christos </pre> 1499 1.1 christos 1500 1.1 christos <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a> 1501 1.1 christos <p> 1502 1.1 christos If you'd like <strong>mom</strong> always to put a full linespace above 1503 1.1 christos and below quotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong> 1504 1.1 christos with no argument. If you wish to restore <strong>mom</strong>'s 1505 1.1 christos default behaviour regarding the spacing of quotes (see 1506 1.1 christos <a href="#QUOTE_SPACING">above</a>), 1507 1.1 christos invoke the macro with any argument (<strong>OFF, QUIT, END, 1508 1.1 christos X</strong>...) 1509 1.1 christos <p> 1510 1.1 christos <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s 1511 1.1 christos spacing policy for 1512 1.1 christos <a href="#BLOCKQUOTE_INTRO">blockquotes</a>. 1513 1.1 christos <p> 1514 1.1 christos 1515 1.1 christos <a name="UNDERLINE_QUOTES"><h3><u>3. Underlining -- UNDERLINE_QUOTES (typewrite only)</u></h3></a> 1516 1.1 christos <p> 1517 1.1 christos By default in 1518 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 1519 1.1 christos <strong>mom</strong> underlines quotes. If you'd rather she didn't, 1520 1.1 christos invoke <strong>.UNDERLINE_QUOTES</strong> with any argument 1521 1.1 christos (<strong>OFF, QUIT, END, X</strong>...) to disable the feature. 1522 1.1 christos Invoke it without an argument to restore <strong>mom</strong>'s 1523 1.1 christos default underlining of quotes. 1524 1.1 christos <p> 1525 1.1 christos If you not only wish that <strong>mom</strong> not underline 1526 1.1 christos quotes, but also that she set them in italic, you must follow each 1527 1.1 christos instance of <strong>QUOTE</strong> with the typesetting macro <a 1528 1.1 christos href="typesetting.html#FONT">FT I</a>. 1529 1.1 christos Furthermore, since <strong>mom</strong> underlines all instances 1530 1.1 christos of italics by default in <strong>PRINTSTYLE TYPEWRITE</strong>, 1531 1.1 christos you must also make sure that <strong>ITALIC_MEANS_ITALIC</strong> 1532 1.1 christos is enabled (see 1533 1.1 christos <a href="docprocessing.html#TYPEWRITE_CONTROL">PRINTSTYLE TYPEWRITE control macros</a>). 1534 1.1 christos <p> 1535 1.1 christos 1536 1.1 christos <a name="BREAK_QUOTE"><h3><u>4. Manually break a footnoted quote -- BREAK_QUOTE</u></h3></a> 1537 1.1 christos <p> 1538 1.1 christos <strong>NOTE:</strong> <em>As of version 1.1.9, the macro</em> 1539 1.1 christos <strong>BREAK_QUOTE</strong> <em>has become obsolete (or, at least, 1540 1.1 christos should have become obsolete.) It remains here for backward 1541 1.1 christos compatibility with documents created prior to 1.1.9, and just in 1542 1.1 christos case, despite my efforts to make it obsolete, you still encounter the 1543 1.1 christos problem it's supposed to fix. Should you find yourself having to 1544 1.1 christos use</em> <strong>BREAK_QUOTE</strong> <em>while running</em> <strong>mom</strong> 1545 1.1 christos 1.1.9 <em>or higher, please notify me immediately.</em> 1546 1.1 christos 1547 1.1 christos <p> 1548 1.1 christos Exceptionally, a quote or blockquote containing a footnote may cross 1549 1.1 christos a page or column. When this happens, the footnote marker may not be 1550 1.1 christos correct for its position relative to other footnotes on the page, and 1551 1.1 christos the footnote itself may appear on the wrong page or at the bottom of 1552 1.1 christos the wrong column. When this happens, study your output to determine 1553 1.1 christos the precise point at which the quote breaks (or at which you want 1554 1.1 christos it to break), and add <code>.BREAK_QUOTE</code> on a line by itself 1555 1.1 christos afterwards. No other intervention is required, and the footnote(s) 1556 1.1 christos will be marked correctly and appear on the correct page. 1557 1.1 christos <p> 1558 1.1 christos <strong>BREAK_QUOTE</strong> may be used with both quotes and 1559 1.1 christos blockquotes, and hence is aliased as <strong>BREAK_BLOCKQUOTE, 1560 1.1 christos BREAK_CITATION</strong> and <strong>BREAK_CITE</strong>. 1561 1.1 christos <p> 1562 1.1 christos <hr> 1563 1.1 christos 1564 1.1 christos <!====================================================================> 1565 1.1 christos 1566 1.1 christos <a name="BLOCKQUOTE_INTRO"><h2><u>Blockquotes (cited passages)</u></h2></a> 1567 1.1 christos <ul> 1568 1.1 christos <li><a href="#BLOCKQUOTE">Tag: BLOCKQUOTE (aliases: CITE, CITATION)</a> 1569 1.1 christos <li><a href="#BLOCKQUOTE_CONTROL">BLOCKQUOTE control macros</a> 1570 1.1 christos </ul> 1571 1.1 christos <p> 1572 1.1 christos <strong>BLOCKQUOTES</strong> are used to cite passages from another 1573 1.1 christos author's work. So that they stand out well from 1574 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a>, 1575 1.1 christos <strong>mom</strong> indents them from both the left and right margins 1576 1.1 christos and sets them in a different point size 1577 1.1 christos <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET</a> 1578 1.1 christos only). 1579 1.1 christos <a href="definitions.html#TERMS_OUTPUTLINE">Output lines</a> 1580 1.1 christos are 1581 1.1 christos <a href="definitions.html#TERMS_FILLED">filled</a>, 1582 1.1 christos and, by default, 1583 1.1 christos <a href="definitions.html#TERMS_QUAD">quadded</a> 1584 1.1 christos left. 1585 1.1 christos <p> 1586 1.1 christos Besides indenting blockquotes, <strong>mom</strong> further sets them 1587 1.1 christos off from running text with a small amount of vertical whitespace top 1588 1.1 christos and bottom. (See 1589 1.1 christos <a href="#QUOTE_SPACING">above</a> 1590 1.1 christos for a complete explanation of how this is managed, and how to control it. 1591 1.1 christos Be sure to read the section <strong>Version 1.3</strong>.) 1592 1.1 christos <p> 1593 1.1 christos 1594 1.1 christos <!---BLOCKQUOTE---> 1595 1.1 christos 1596 1.1 christos <hr width="66%" align="left"> 1597 1.1 christos <p> 1598 1.1 christos <a name="BLOCKQUOTE"> 1599 1.1 christos <nobr>Macro: <strong>BLOCKQUOTE</strong> toggle</nobr> 1600 1.1 christos <br> 1601 1.1 christos Aliases: <strong>CITE, CITATION</strong> 1602 1.1 christos </a> 1603 1.1 christos 1604 1.1 christos <p> 1605 1.1 christos <strong>BLOCKQUOTE</strong> is a toggle macro. To begin a 1606 1.1 christos cited passage, invoke the tag with no argument, then type in your quote. 1607 1.1 christos When you're finished, invoke <strong>BLOCKQUOTE</strong> with any 1608 1.1 christos argument (e.g. OFF, END, X, Q...) to turn it off. Example: 1609 1.1 christos <p> 1610 1.1 christos <pre> 1611 1.1 christos .BLOCKQUOTE 1612 1.1 christos Redefining the role of the United States from enablers to keep 1613 1.1 christos the peace to enablers to keep the peace from peacekeepers is 1614 1.1 christos going to be an assignment. 1615 1.1 christos .RIGHT 1616 1.1 christos \(emGeorge W. Bush 1617 1.1 christos .BLOCKQUOTE END 1618 1.1 christos </pre> 1619 1.1 christos 1620 1.1 christos If the cited passage runs to more than one paragraph, you MUST 1621 1.1 christos introduce each paragraph -- <em>including the first!</em> -- 1622 1.1 christos with 1623 1.1 christos <a href="#PP">PP</a>. 1624 1.1 christos <p> 1625 1.1 christos <strong>NOTE:</strong> The aliases <strong>CITE</strong> 1626 1.1 christos and <strong>CITATION</strong> may be used in place of the 1627 1.1 christos <strong>BLOCKQUOTE</strong> tag, as well as in any of the control 1628 1.1 christos macros that begin with <strong>BLOCKQUOTE_</strong> or end with 1629 1.1 christos <strong>_BLOCKQUOTE</strong>. 1630 1.1 christos 1631 1.1 christos <a name="BLOCKQUOTE_CONTROL"><h3><u>Blockquote control macros</u></h3></a> 1632 1.1 christos <ol> 1633 1.1 christos <li><a href="#BLOCKQUOTE_GENERAL">Family/font/size/leading/colour/quad/indent</a> 1634 1.1 christos <li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a> 1635 1.1 christos <li><a href="#BREAK_QUOTE">Manually break a footnoted blockquote that crosses pages/columns</a> 1636 1.1 christos </ol> 1637 1.1 christos <p> 1638 1.1 christos <a name="BLOCKQUOTE_GENERAL"><h3><u>1. Family/font/size/colour/quad/indent</u></h3></a> 1639 1.1 christos <p> 1640 1.1 christos See 1641 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 1642 1.1 christos <p> 1643 1.1 christos <pre> 1644 1.1 christos .BLOCKQUOTE_FAMILY default = prevailing document family; default is Times Roman 1645 1.1 christos .BLOCKQUOTE_FONT default = roman 1646 1.1 christos .BLOCKQUOTE_SIZE default = -1 (point) 1647 1.1 christos .BLOCKQUOTE_AUTOLEAD default = none; leading of blockquotes is the same as paragraphs 1648 1.1 christos .BLOCKQUOTE_COLOR default = black 1649 1.1 christos .BLOCKQUOTE_QUAD default = left 1650 1.1 christos .BLOCKQUOTE_INDENT default = paragraph indent x 3 (typeset); x 2 (typewrite)</a> 1651 1.1 christos (note that this macro also sets the left indent for quotes) 1652 1.1 christos </pre> 1653 1.1 christos 1654 1.1 christos <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a> 1655 1.1 christos <p> 1656 1.1 christos If you'd like <strong>mom</strong> always to put a full linespace above 1657 1.1 christos and below blockquotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong> 1658 1.1 christos with no argument. If you wish to restore <strong>mom</strong>'s 1659 1.1 christos default behaviour regarding the spacing of blockquotes (see 1660 1.1 christos <a href="#QUOTE_SPACING">above</a>), 1661 1.1 christos invoke the macro with any argument (<strong>OFF, QUIT, END, 1662 1.1 christos X</strong>...). 1663 1.1 christos <p> 1664 1.1 christos <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s 1665 1.1 christos spacing policy for 1666 1.1 christos <a href="#QUOTE_INTRO">quotes</a>. 1667 1.1 christos <p> 1668 1.1 christos <hr> 1669 1.1 christos 1670 1.1 christos <!====================================================================> 1671 1.1 christos 1672 1.1 christos <a name="LIST_INTRO"><h2><u>Nested lists</u></h2></a> 1673 1.1 christos <ul> 1674 1.1 christos <li><a href="#LIST">Tag: LIST</a> 1675 1.1 christos <li><a href="#ITEM">Tag: ITEM</a> 1676 1.1 christos <li><a href="#LIST_CONTROL">LIST control macros</a> 1677 1.1 christos </ul> 1678 1.1 christos <p> 1679 1.1 christos Lists are points or items of interest or importance that are 1680 1.1 christos separated from 1681 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a> 1682 1.1 christos by enumerators. Some typical enumerators are 1683 1.1 christos <a href="definitions.html#TERMS_EM">en-dashes</a>, 1684 1.1 christos <a href="definitions.html#TERMS_BULLET">bullets</a>, 1685 1.1 christos digits and letters. 1686 1.1 christos <p> 1687 1.1 christos Setting lists with <strong>mom</strong> is easy. First, you 1688 1.1 christos initialize a list with the <strong>LIST</strong> macro. Then, for 1689 1.1 christos every item in the list, you invoke the macro, <strong>ITEM</strong>, 1690 1.1 christos followed by the text of the item. When a list is finished, you 1691 1.1 christos exit the list with <strong>LIST OFF</strong> (or 1692 1.1 christos <strong>QUIT</strong>, <strong>END</strong>, <strong>BACK</strong>, 1693 1.1 christos etc.) 1694 1.1 christos <p> 1695 1.1 christos By default <strong>mom</strong> starts each list with the enumerator 1696 1.1 christos flush with the left margin of running text that comes before it, 1697 1.1 christos like this: 1698 1.1 christos <p> 1699 1.1 christos <pre> 1700 1.1 christos My daily schedule needs organizing. I can't 1701 1.1 christos seem to get everything done I want. 1702 1.1 christos o an hour's worth of exercise 1703 1.1 christos o time to prepare at least one healthy 1704 1.1 christos meal per day 1705 1.1 christos o reading time 1706 1.1 christos o work on mom 1707 1.1 christos o writing 1708 1.1 christos - changes from publisher 1709 1.1 christos - current novel 1710 1.1 christos o a couple of hours at the piano 1711 1.1 christos </pre> 1712 1.1 christos 1713 1.1 christos In other words, <strong>mom</strong> does not, by default, indent 1714 1.1 christos entire lists. Indenting a list is controlled by the macro, 1715 1.1 christos <a href="#SHIFT_LIST">SHIFT_LIST</a>. 1716 1.1 christos (This is a design decision; there are too many instances where a 1717 1.1 christos default indent is not desirable.) Equally, <strong>mom</strong> 1718 1.1 christos does not add any extra space above or below lists. 1719 1.1 christos <p> 1720 1.1 christos Lists can be nested (as in the example above). In other words, you 1721 1.1 christos can set lists within lists, each with an enumerator (and possibly, 1722 1.1 christos indent) of your choosing. In nested lists, each invocation of 1723 1.1 christos <strong>LIST OFF</strong> (you may prefer to use <strong>LIST 1724 1.1 christos BACK</strong>) takes you back to the previous depth (or 1725 1.1 christos level) of list, with that list's enumerator and indent intact. The 1726 1.1 christos final <strong>LIST OFF</strong> exits lists completely and returns 1727 1.1 christos you to the left margin of running text. 1728 1.1 christos <p> 1729 1.1 christos Finally, lists can be used in documents created with either the 1730 1.1 christos document processing macros or just the typesetting macros. 1731 1.1 christos <p> 1732 1.1 christos 1733 1.1 christos <!---LIST---> 1734 1.1 christos 1735 1.1 christos <hr width="66%" align="left"> 1736 1.1 christos <p> 1737 1.1 christos <a name="LIST"> 1738 1.1 christos <nobr>Macro: <strong>LIST</strong> [ BULLET | DASH | DIGIT | ALPHA | alpha | ROMAN<n> | roman<n> | USER <string>] [ <separator> | <user-defined enumerator> ] [ <prefix> ] [ <off> ]</a></nobr> 1739 1.1 christos <p> 1740 1.1 christos Invoked by itself (i.e. with no argument), <strong>LIST</strong> 1741 1.1 christos initializes a list (with bullets as the default enumerator). 1742 1.1 christos Afterwards, each block of input text preceded by 1743 1.1 christos <a href="#ITEM">.ITEM</a>, 1744 1.1 christos on a line by itself, is treated as a list item. 1745 1.1 christos <p> 1746 1.1 christos <strong>NOTE:</strong> Every time you invoke <strong>LIST</strong> 1747 1.1 christos to start a list (as opposed to 1748 1.1 christos <a href="#LIST_EXIT">exiting one</a>), 1749 1.1 christos you must supply an enumerator (and optionally, a separator) for the 1750 1.1 christos list, unless you want <strong>mom</strong>'s default enumerator, 1751 1.1 christos which is a bullet. Within nested lists, <strong>mom</strong> 1752 1.1 christos stores the enumerator, separator and indent for any list you return 1753 1.1 christos <em>backwards</em> to (i.e. with <strong>LIST OFF</strong>), but 1754 1.1 christos does not store any information for lists you move <em>forward</em> 1755 1.1 christos to. 1756 1.1 christos <br> 1757 1.1 christos 1758 1.1 christos <h3><u>The first argument--enumerator style</u></h3> 1759 1.1 christos <p> 1760 1.1 christos The optional arguments <strong>BULLET</strong>, 1761 1.1 christos <strong>DASH</strong>, <strong>DIGIT</strong> (for 1762 1.1 christos Arabic numerals), <strong>ALPHA</strong> (for uppercase 1763 1.1 christos letters), <strong>alpha</strong> (for lowercase letters), 1764 1.1 christos <strong>ROMAN<n></strong> (for uppercase roman numerals), 1765 1.1 christos <strong>roman<n></strong> (for lowercase roman numerals) tell 1766 1.1 christos <strong>mom</strong> what kind of enumerator to use for a given 1767 1.1 christos list. 1768 1.1 christos <p> 1769 1.1 christos The arguments, <strong>ROMAN<n></strong> and 1770 1.1 christos <strong>roman<n></strong>, are special. You must append to 1771 1.1 christos them a digit (arabic, e.g. "1" or "9" or "17") saying how many items 1772 1.1 christos a particular roman-numeralled <strong>LIST</strong> is going to 1773 1.1 christos have. <strong>Mom</strong> requires this information in order to 1774 1.1 christos align roman numerals sensibly, and will abort--with a message--if 1775 1.1 christos you don't provide it. 1776 1.1 christos <p> 1777 1.1 christos A roman-numeralled list containing, say, five items, would be set 1778 1.1 christos up like this: 1779 1.1 christos <p> 1780 1.1 christos <pre> 1781 1.1 christos .LIST roman5 producing i) Item 1. 1782 1.1 christos .ITEM ii) Item 2. 1783 1.1 christos Item 1. iii) Item 3. 1784 1.1 christos .ITEM iv) Item 4. 1785 1.1 christos Item 2. v) Item 5. 1786 1.1 christos .ITEM 1787 1.1 christos Item 3 1788 1.1 christos .ITEM 1789 1.1 christos Item 4 1790 1.1 christos .ITEM 1791 1.1 christos Item 5 1792 1.1 christos </pre> 1793 1.1 christos 1794 1.1 christos <p> 1795 1.1 christos The argument, <strong>USER</strong>, lets you make up your own 1796 1.1 christos enumerator, and must be followed by a second argument: what you'd 1797 1.1 christos like the enumerator to look like. For example, if you want a list 1798 1.1 christos enumerated with 1799 1.1 christos <strong>=></strong>, 1800 1.1 christos <p> 1801 1.1 christos <pre> 1802 1.1 christos .LIST USER => 1803 1.1 christos .ITEM 1804 1.1 christos A list item 1805 1.1 christos </pre> 1806 1.1 christos 1807 1.1 christos will produce 1808 1.1 christos <p> 1809 1.1 christos <pre> 1810 1.1 christos => A list item 1811 1.1 christos </pre> 1812 1.1 christos 1813 1.1 christos <strong>Please note:</strong> if the argument to 1814 1.1 christos <strong>USER</strong> contains spaces, you must enclose the argument 1815 1.1 christos in double quotes. 1816 1.1 christos 1817 1.1 christos <br> 1818 1.1 christos 1819 1.1 christos <h3><u>The second argument--separator style</u></h3> 1820 1.1 christos <p> 1821 1.1 christos If you choose <strong>DIGIT</strong>, <strong>ALPHA</strong>, 1822 1.1 christos <strong>alpha</strong>, <strong>ROMAN<n></strong>, or 1823 1.1 christos <strong>roman<n></strong>, you may enter the optional 1824 1.1 christos argument, <strong>separator</strong>, to say what kind of separator 1825 1.1 christos you want after the enumerator. The separator can be anything you 1826 1.1 christos like. The default for <strong>DIGIT</strong> is a period (dot), 1827 1.1 christos like this: 1828 1.1 christos <p> 1829 1.1 christos <pre> 1830 1.1 christos 1. A list item 1831 1.1 christos </pre> 1832 1.1 christos 1833 1.1 christos The default separator for <strong>ALPHA</strong>, 1834 1.1 christos <strong>alpha</strong>, <strong>ROMAN<n></strong> and 1835 1.1 christos <strong>roman<n></strong> is a right parenthesis, like this: 1836 1.1 christos <p> 1837 1.1 christos <pre> 1838 1.1 christos a) An alpha-ed list item 1839 1.1 christos b) A second alpha-ed list item 1840 1.1 christos 1841 1.1 christos or 1842 1.1 christos 1843 1.1 christos i) A roman-ed list item 1844 1.1 christos ii) A second roman-ed item 1845 1.1 christos </pre> 1846 1.1 christos 1847 1.1 christos If you'd prefer, say, digits with right-parenthesis separators 1848 1.1 christos instead of the default period, you'd do 1849 1.1 christos <p> 1850 1.1 christos <pre> 1851 1.1 christos .LIST DIGIT ) 1852 1.1 christos .ITEM 1853 1.1 christos A numberd list item 1854 1.1 christos </pre> 1855 1.1 christos 1856 1.1 christos which would produce 1857 1.1 christos <p> 1858 1.1 christos <pre> 1859 1.1 christos 1) A numbered list item 1860 1.1 christos </pre> 1861 1.1 christos 1862 1.1 christos <strong>Please note: BULLET</strong>, <strong>DASH</strong> and 1863 1.1 christos <strong>USER</strong> do not take a separator. 1864 1.1 christos <br> 1865 1.1 christos 1866 1.1 christos <h3><u>The third argument--prefix style</u></h3> 1867 1.1 christos <p> 1868 1.1 christos Additionally, you may give a prefix (i.e. a character that comes 1869 1.1 christos <em>before</em> the enumerator) when your enumerator style for a 1870 1.1 christos particular list is <strong>DIGIT</strong>, <strong>ALPHA</strong>, 1871 1.1 christos <strong>alpha</strong>, <strong>ROMAN<n></strong> 1872 1.1 christos or <strong>roman<n></strong>. In the arguments to 1873 1.1 christos <strong>LIST</strong>, the prefix comes <em>after</em> the 1874 1.1 christos separator, which may seem counter-intuitive, so please be careful. 1875 1.1 christos <p> 1876 1.1 christos A prefix can be anything you like. Most likely, you'll want some 1877 1.1 christos kind of open-bracket, such as a left parenthesis. If, for example, 1878 1.1 christos you want a <strong>DIGIT</strong> list with the numbers enclosed in 1879 1.1 christos parentheses, you'd enter 1880 1.1 christos <p> 1881 1.1 christos <pre> 1882 1.1 christos .LIST DIGIT ) ( 1883 1.1 christos .ITEM 1884 1.1 christos The first item on the list. 1885 1.1 christos .ITEM 1886 1.1 christos The second item on the list. 1887 1.1 christos </pre> 1888 1.1 christos 1889 1.1 christos which would produce 1890 1.1 christos <p> 1891 1.1 christos <pre> 1892 1.1 christos (1) The first item on the list. 1893 1.1 christos (2) The second item on the list. 1894 1.1 christos </pre> 1895 1.1 christos 1896 1.1 christos <strong>Please note: BULLET</strong>, <strong>DASH</strong> and 1897 1.1 christos <strong>USER</strong> do not take a prefix. 1898 1.1 christos <br> 1899 1.1 christos 1900 1.1 christos <a name="LIST_EXIT"></a> 1901 1.1 christos <h3><u>Exiting lists--.LIST OFF/BACK or .QUIT_LISTS</u></h3> 1902 1.1 christos <p> 1903 1.1 christos Any single argument to <strong>LIST</strong> other 1904 1.1 christos than <strong>BULLET</strong>, <strong>DASH</strong>, 1905 1.1 christos <strong>DIGIT</strong>, <strong>ALPHA</strong>, 1906 1.1 christos <strong>alpha</strong>, <strong>ROMAN<n></strong>, 1907 1.1 christos <strong>roman<n></strong> or <strong>USER</strong> (e.g. 1908 1.1 christos <strong>LIST</strong> <kbd>OFF</kbd> or <strong>LIST</strong> 1909 1.1 christos <kbd>BACK</kbd>) takes you out of the current list. 1910 1.1 christos <p> 1911 1.1 christos If you are at the first list-level (or "list-depth"), 1912 1.1 christos <strong>mom</strong> returns you to the left margin of running text. 1913 1.1 christos Any indents that were in effect prior to setting the list are fully 1914 1.1 christos restored. 1915 1.1 christos <p> 1916 1.1 christos If you are in a nested list, <strong>mom</strong> moves you 1917 1.1 christos <em>back one list-level</em> (i.e. does not take you out of the 1918 1.1 christos list structure) and restores the enumerator, separator and indent 1919 1.1 christos appropriate to that level. 1920 1.1 christos <p> 1921 1.1 christos Each invocation of <strong>LIST</strong> should be be matched by 1922 1.1 christos a corresponding <strong>LIST OFF</strong> in order to fully exit 1923 1.1 christos lists. For example, 1924 1.1 christos <p> 1925 1.1 christos <pre> 1926 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 1927 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 1928 1.1 christos o List item in level 1 1929 1.1 christos o List item in level 1 1930 1.1 christos - List item in level 2 1931 1.1 christos - List item in level 2 1932 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 1933 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 1934 1.1 christos </pre> 1935 1.1 christos 1936 1.1 christos is created like this: 1937 1.1 christos <p> 1938 1.1 christos <pre> 1939 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 1940 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 1941 1.1 christos .LIST BULLET 1942 1.1 christos .ITEM 1943 1.1 christos List item in level 1 1944 1.1 christos .ITEM 1945 1.1 christos List item in level 1 1946 1.1 christos .LIST DASH 1947 1.1 christos .ITEM 1948 1.1 christos List item in level 2 1949 1.1 christos .ITEM 1950 1.1 christos List item in level 2 1951 1.1 christos .LIST OFF \" Turn level 2 list off 1952 1.1 christos .LIST OFF \" Turn level 1 list off 1953 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 1954 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 1955 1.1 christos </pre> 1956 1.1 christos 1957 1.1 christos Alternatively, you may use the single-purpose macro, 1958 1.1 christos <strong>QUIT_LISTS</strong>, to get yourself out of a list 1959 1.1 christos structure. In the example above, the two <kbd>.LIST OFF</kbd> 1960 1.1 christos lines could be replaced with a single <kbd>.QUIT_LISTS</kbd>. 1961 1.1 christos <p> 1962 1.1 christos 1963 1.1 christos <hr width="33%" align="left"> 1964 1.1 christos <p> 1965 1.1 christos <a name="ITEM"> 1966 1.1 christos Macro: <strong>ITEM</strong> 1967 1.1 christos <p> 1968 1.1 christos After you've initialized a list with 1969 1.1 christos <a href="#LIST">LIST</a>, 1970 1.1 christos precede each item you want in the list with <strong>ITEM</strong>. 1971 1.1 christos <strong>Mom</strong> takes care of everything else with respect to 1972 1.1 christos setting the item appropriate to the list you're in. 1973 1.1 christos <p> 1974 1.1 christos In document processing, it is legal to have list items that contain 1975 1.1 christos multiple paragraphs. Simply issue a 1976 1.1 christos <a href="#PP">PP</a> 1977 1.1 christos request for each paragraph <em>following</em> the first item. 1978 1.1 christos I.e., don't do this: 1979 1.1 christos <p> 1980 1.1 christos <pre> 1981 1.1 christos .ITEM 1982 1.1 christos .PP 1983 1.1 christos Some text... 1984 1.1 christos .PP 1985 1.1 christos A second paragraph of text 1986 1.1 christos </pre> 1987 1.1 christos 1988 1.1 christos but rather 1989 1.1 christos <p> 1990 1.1 christos <pre> 1991 1.1 christos .ITEM 1992 1.1 christos Some text... 1993 1.1 christos .PP 1994 1.1 christos A second paragraph of text 1995 1.1 christos </pre> 1996 1.1 christos <hr width="33%" align="left"> 1997 1.1 christos 1998 1.1 christos <a name="LIST_CONTROL"><h3><u>List control macros</u></h3></a> 1999 1.1 christos <ol> 2000 1.1 christos <li><a href="#SHIFT_LIST">Indenting lists (SHIFT_LIST)</a> 2001 1.1 christos <li><a href="#RESET_LIST">Resetting an initialized list's enumerator (RESET_LIST)</a> 2002 1.1 christos <li><a href="#PAD_LIST_DIGITS">Padding digit enumerators (PAD_LIST_DIGITS)</a> 2003 1.1 christos </ol> 2004 1.1 christos 2005 1.1 christos <a name="SHIFT_LIST"><h3><u>1. Indenting lists -- SHIFT_LIST</u></h3></a> 2006 1.1 christos <p> 2007 1.1 christos If you want a list to be indented to the right of running text, or 2008 1.1 christos indented to the right of a current list, use the macro 2009 1.1 christos <strong>SHIFT_LIST</strong> immediately after 2010 1.1 christos <a href="#LIST">LIST</a>. 2011 1.1 christos <strong>SHIFT_LIST</strong> takes just one argument: the amount by 2012 1.1 christos which you want the list shifted to the right. The argument requires 2013 1.1 christos a 2014 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>, 2015 1.1 christos <p> 2016 1.1 christos <strong>SHIFT_LIST</strong> applies <em>only</em> to the list you 2017 1.1 christos just initialized with <strong>LIST</strong>. It does not carry 2018 1.1 christos over from one invocation of <strong>LIST</strong> to the next. 2019 1.1 christos However, the indent remains in effect when you <em>return</em> to a 2020 1.1 christos list level in a nested list. 2021 1.1 christos <p> 2022 1.1 christos For example, if you want a 2-level list, with each list indented to 2023 1.1 christos the right by 18 2024 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a>, 2025 1.1 christos <p> 2026 1.1 christos <pre> 2027 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 2028 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 2029 1.1 christos .LIST \" List 1 2030 1.1 christos .SHIFT_LIST 18p \" Indent 18 points right of running text 2031 1.1 christos .ITEM 2032 1.1 christos List 1 item 2033 1.1 christos .ITEM 2034 1.1 christos List 1 item 2035 1.1 christos .LIST DASH \" List 2 2036 1.1 christos .SHIFT_LIST 18p \" Indent 18 points right of list 1 2037 1.1 christos .ITEM 2038 1.1 christos List 2 item 2039 1.1 christos .ITEM 2040 1.1 christos List 2 item 2041 1.1 christos .LIST OFF \" Move back to list 1 2042 1.1 christos .ITEM 2043 1.1 christos List 1 item 2044 1.1 christos .ITEM 2045 1.1 christos List 1 item 2046 1.1 christos .LIST OFF \" Exit lists 2047 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 2048 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 2049 1.1 christos </pre> 2050 1.1 christos 2051 1.1 christos produces (approximately) 2052 1.1 christos <p> 2053 1.1 christos <pre> 2054 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 2055 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 2056 1.1 christos o List 1 item 2057 1.1 christos o List 1 item 2058 1.1 christos - List 2 item 2059 1.1 christos - List 2 item 2060 1.1 christos o List 1 item 2061 1.1 christos o List 1 item 2062 1.1 christos Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 2063 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore. 2064 1.1 christos </pre> 2065 1.1 christos 2066 1.1 christos <a name="RESET_LIST"><h3><u>2. Resetting an initialized list's enumerator -- RESET_LIST</u></h3></a> 2067 1.1 christos <p> 2068 1.1 christos In nested lists, if your choice of list enumerator for a given 2069 1.1 christos level of list is <strong>DIGIT</strong>, <strong>ALPHA</strong>, 2070 1.1 christos <strong>alpha</strong>, <strong>ROMAN</strong> or 2071 1.1 christos <strong>roman</strong>, you may sometimes want to reset the list's 2072 1.1 christos enumerator when you return to that list. Consider the following: 2073 1.1 christos <p> 2074 1.1 christos <pre> 2075 1.1 christos Things to do religiously each and every day: 2076 1.1 christos 1. Take care of the dog 2077 1.1 christos a) walk every day 2078 1.1 christos b) brush once a week 2079 1.1 christos - trim around the eyes every fourth brushing 2080 1.1 christos - don't forget to check nails 2081 1.1 christos 2. Feed the cat 2082 1.1 christos a) soft food on Mon., Wed. and Fri. 2083 1.1 christos b) dry food on Tues., Thurs. and Sat. 2084 1.1 christos c) canned tuna on Sunday 2085 1.1 christos </pre> 2086 1.1 christos 2087 1.1 christos Normally, within a nested list, when you return to an 2088 1.1 christos incrementally-enumerated list, the enumerator continues incrementing 2089 1.1 christos from where it left off. That means, in the example above, the 2090 1.1 christos normal state of affairs for the alpha'ed list under "2. Feed 2091 1.1 christos the cat" would be c), d) and e). The solution, in such a case, 2092 1.1 christos is simply to reset the enumerator --before <strong>ITEM</strong>!-- 2093 1.1 christos with the macro, <strong>RESET_LIST</strong>. 2094 1.1 christos <p> 2095 1.1 christos By default, with no argument, <strong>RESET_LIST</strong> resets the 2096 1.1 christos enumerator to 1, A, a, I or i depending on the style of enumerator. 2097 1.1 christos You may, if you wish, pass <strong>RESET_LISTS</strong> a numeric 2098 1.1 christos argument representing the starting enumerator for the reset (if 2099 1.1 christos different from "1"), although I can't at present think of a use for 2100 1.1 christos this feature. 2101 1.1 christos <p> 2102 1.1 christos <a name="PAD_LIST_DIGITS"><h3><u>3. Padding digit enumerators (PAD_LIST_DIGITS)</a></u></h3></a> 2103 1.1 christos <p> 2104 1.1 christos <strong><u>Arabic digits</u></strong> 2105 1.1 christos <p> 2106 1.1 christos When your choice of enumerators is <strong>DIGIT</strong> AND the 2107 1.1 christos number of items in the list exceeds nine (9), you have to make a 2108 1.1 christos design decision: should <strong>mom</strong> leave room for the 2109 1.1 christos extra numeral in two-numeral digits to the right or the left of 2110 1.1 christos the single-numeral digits? 2111 1.1 christos <p> 2112 1.1 christos If you want the extra space to the right, invoke the macro, 2113 1.1 christos <strong>.PAD_LIST_DIGITS</strong> (with no argument), after 2114 1.1 christos <strong>LIST</strong> and before <strong>ITEM</strong>. This will 2115 1.1 christos produce something like 2116 1.1 christos <p> 2117 1.1 christos <pre> 2118 1.1 christos 8. List item 2119 1.1 christos 9. List item 2120 1.1 christos 10. List item 2121 1.1 christos </pre> 2122 1.1 christos 2123 1.1 christos If you want the extra space to the left, invoke 2124 1.1 christos <strong>PAD_LIST_DIGITS</strong> with the single argument, 2125 1.1 christos <strong>LEFT</strong>, which will produce 2126 1.1 christos <p> 2127 1.1 christos <pre> 2128 1.1 christos 8. List item 2129 1.1 christos 9. List item 2130 1.1 christos 10. List item 2131 1.1 christos </pre> 2132 1.1 christos 2133 1.1 christos Of course, if the number of items in the list is less than ten 2134 1.1 christos (10), there's no need for <strong>PAD_LIST_DIGITS</strong>. 2135 1.1 christos <p> 2136 1.1 christos <strong><u>Roman numerals</u></strong> 2137 1.1 christos <p> 2138 1.1 christos By default, <strong>mom</strong> sets roman numerals in lists flush 2139 1.1 christos left. The <strong><n></strong> argument appended to 2140 1.1 christos <strong>ROMAN<n></strong> or <strong>roman<n></strong> 2141 1.1 christos allows her to calculate how much space to put after each numeral in 2142 1.1 christos order to ensure that the text of items lines up properly. 2143 1.1 christos <p> 2144 1.1 christos If you'd like the roman numerals to line up flush right (i.e. be 2145 1.1 christos padded "left"), simply invoke <strong>PAD_LIST_DIGITS</strong> 2146 1.1 christos <kbd>LEFT</kbd> after <strong>LIST</strong> <kbd>ROMAN<n></kbd> 2147 1.1 christos or <strong>LIST</strong> <kbd>roman<n></kbd> amd before 2148 1.1 christos <strong>ITEM</strong>. 2149 1.1 christos <p> 2150 1.1 christos <hr> 2151 1.1 christos 2152 1.1 christos <!---LINE NUMBERING---> 2153 1.1 christos 2154 1.1 christos <a name="NUMBER_LINES_INTRO"><h2><u>Line numbering</u></h2></a> 2155 1.1 christos <ul> 2156 1.1 christos <li><a href="#NUMBER_LINES">Macro: NUMBER_LINES</a> 2157 1.1 christos <li><a href="#NUMBER_LINES_CONTROL">Control macros</a> (for quotes and blockquotes) 2158 1.1 christos </ul> 2159 1.1 christos 2160 1.1 christos <p> 2161 1.1 christos <strong>Mom</strong>'s line-numbering capabilities are not as flexible 2162 1.1 christos as most of her other document processing macros. The reason is 2163 1.1 christos that groff's underlying line-numbering 2164 1.1 christos <a href="definitions.html#TERMS_PRIMITIVEX">primitive</a>, 2165 1.1 christos <kbd>.nm</kbd>, is, well...primtive. It is not possible, for 2166 1.1 christos example, to select a particular family or font for use exclusively 2167 1.1 christos with line numbers. Nor is it possible to set the 2168 1.1 christos <a href="definitions.html#TERMS_GUTTER">gutter</a> 2169 1.1 christos using any 2170 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 2171 1.1 christos other than the 2172 1.1 christos <a href="definitions.html#TERMS_FIGURESPACE">figure space</a>. 2173 1.1 christos <p> 2174 1.1 christos That said, when you turn line-numbering on, <strong>mom</strong>, 2175 1.1 christos by default 2176 1.1 christos <br> 2177 1.1 christos <a name="NUMBER_LINES_DEFAULTS"></a> 2178 1.1 christos <ul> 2179 1.1 christos <li>numbers every line of paragraph text; line-numbering is 2180 1.1 christos suspended for all other document processing tags (like 2181 1.1 christos docheaders, epigraphs, heads, subheads, etc.) and special 2182 1.1 christos pages (covers, endotes, bibliographies, etc.); be aware, 2183 1.1 christos though, that if you turn 2184 1.1 christos <a href="definitions.html#TERMS_DOCHEADER">docheaders</a> 2185 1.1 christos off (with 2186 1.1 christos <a href="docprocessing.html#DOCHEADER">DOCHEADER</a> <strong>OFF</strong>) 2187 1.1 christos and create your own docheader, <strong>mom</strong> 2188 1.1 christos <em>will</em> line-number your custom docheader 2189 1.1 christos <li>doesn't touch your line length; line numbers are hung 2190 1.1 christos outside your current left margin (as set with 2191 1.1 christos <a href="typesetting.html#L_MARGIN">L_MARGIN</a>, 2192 1.1 christos <a href="typesetting.html#PAGE">PAGE</a> 2193 1.1 christos or 2194 1.1 christos <a href="docprocessing.html#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a>), 2195 1.1 christos regardless of any indents that may be active 2196 1.1 christos <li>separates line numbers from running text by two 2197 1.1 christos <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>. 2198 1.1 christos </ul> 2199 1.1 christos <p> 2200 1.1 christos Line numbering may be enabled and disabled for 2201 1.1 christos <a href="#QUOTE">QUOTE</a> 2202 1.1 christos and/or 2203 1.1 christos <a href="#BLOCKQUOTE">BLOCKQUOTE</a> 2204 1.1 christos in one of three styles. See 2205 1.1 christos <a href="#NUMBER_LINES_CONTROL">Line numbering control macros for quotes and blockquotes</a>. 2206 1.1 christos <p> 2207 1.1 christos The first time you invoke 2208 1.1 christos <a href="#NUMBER_LINES">NUMBER_LINES</a> 2209 1.1 christos you must, at a minimum, tell it what line number you want the 2210 1.1 christos <em>next</em> 2211 1.1 christos <a href="definitions.html#TERMS_OUTPUTLINE">output line</a> 2212 1.1 christos to have. Optional arguments allow you to state which lines should 2213 1.1 christos be numbered (e.g. every five or every ten lines), and the gutter to 2214 1.1 christos place between line numbers and 2215 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a>. 2216 1.1 christos <p> 2217 1.1 christos Subsequently, you can turn line-numbering off, either permanently, 2218 1.1 christos or resume it later at a place of your choosing. When you 2219 1.1 christos resume line-numbering, the line numbers pick up where you left off. 2220 1.1 christos <p> 2221 1.1 christos 2222 1.1 christos <!---NUMBER_LINES---> 2223 1.1 christos 2224 1.1 christos <hr width="66%" align="left"> 2225 1.1 christos <p> 2226 1.1 christos <nobr> 2227 1.1 christos <a name="NUMBER_LINES"> 2228 1.1 christos <nobr>Macro: <strong>NUMBER_LINES</strong> <start number> [ <which lines to number> [ <gutter> ] ]</nobr> 2229 1.1 christos <br> 2230 1.1 christos <nobr>Macro: <strong>NUMBER_LINES</strong> <anything> | RESUME</nobr> 2231 1.1 christos <br> 2232 1.1 christos </a> 2233 1.1 christos </nobr> 2234 1.1 christos 2235 1.1 christos <p> 2236 1.1 christos <strong>NUMBER_LINES</strong> does what it says: prints line 2237 1.1 christos numbers, to the left of 2238 1.1 christos <a href="definitions.html#TERMS_OUTPUTLINE">output lines</a> 2239 1.1 christos of paragraph text. One of the chief reasons for wanting numbered 2240 1.1 christos lines is in order to identify footnotes or endnotes by line number 2241 1.1 christos instead of by a marker in the text. (See 2242 1.1 christos <a href="#FOOTNOTE_LINENUMBERS">.FOOTNOTE_MARKER_STYLE LINE</a> 2243 1.1 christos for instructions on line-numbered footnotes, and 2244 1.1 christos <a href="#ENDNOTE_MARKER_STYLE">.ENDNOTE_MARKER_STYLE</a> 2245 1.1 christos for instructions on line-numbered endnotes.) 2246 1.1 christos <p> 2247 1.1 christos Every time you invoke <strong>NUMBER_LINES</strong>, unless you are 2248 1.1 christos using the arguments <strong>OFF</strong> (<strong>QUIT</strong>, 2249 1.1 christos <strong>END</strong>, <strong>X</strong>, etc.) or 2250 1.1 christos <strong>RESUME</strong> you must, at a minimum, pass it one 2251 1.1 christos argument, namely the number (digit) you want the <em>next</em> 2252 1.1 christos <a href="definitions.html#TERMS_OUTPUTLINE">output line</a> 2253 1.1 christos to have. For example, 2254 1.1 christos <pre> 2255 1.1 christos .NUMBER_LINES 3 2256 1.1 christos </pre> 2257 1.1 christos 2258 1.1 christos will prepend the number, 3, to the next output line. 2259 1.1 christos <p> 2260 1.1 christos Normally, of course, you will number lines of text starting at 1. 2261 1.1 christos All you have to do in that case is ensure that 2262 1.1 christos <pre> 2263 1.1 christos .NUMBER_LINES 1 2264 1.1 christos </pre> 2265 1.1 christos 2266 1.1 christos precedes your first line of input text, which will also be the 2267 1.1 christos first line of output text. 2268 1.1 christos <p> 2269 1.1 christos You can alter <strong>mom</strong>'s default line numbering 2270 1.1 christos behaviour (see 2271 1.1 christos <a href="#NUMBER_LINES_DEFAULT">above</a>) 2272 1.1 christos with the optional arguments <strong><which lines to 2273 1.1 christos number></strong> and <strong><gutter></strong>. 2274 1.1 christos <p> 2275 1.1 christos <strong><which lines to number></strong> instructs 2276 1.1 christos <strong>NUMBER_LINES</strong> to number only certain lines, e.g. 2277 1.1 christos every two lines or every five lines. If you want, say, only every 2278 1.1 christos five lines to have a prepended number, you'd do 2279 1.1 christos <pre> 2280 1.1 christos .NUMBER_LINES 1 5 2281 1.1 christos </pre> 2282 1.1 christos 2283 1.1 christos <strong>GOTCHA!</strong> The argument to <strong><which 2284 1.1 christos lines to number></strong> only numbers those lines that are 2285 1.1 christos multiples of the argument. Hence, in the above example, line 2286 1.1 christos number "1" will <em>not</em> be numbered, since "1" is not a 2287 1.1 christos multiple of "5". 2288 1.1 christos <p> 2289 1.1 christos If you wanted line number "1" to be numbered, you'd have to invoke 2290 1.1 christos <kbd>.NUMBER_LINES 1 1</kbd> before the first output line, then 2291 1.1 christos study your <em>output</em> copy and determine where best to insert 2292 1.1 christos the following in your <em>input</em> copy: 2293 1.1 christos <pre> 2294 1.1 christos .NUMBER_LINES \n(ln 5 2295 1.1 christos </pre> 2296 1.1 christos 2297 1.1 christos (The escape, <kbd>\n(ln</kbd>, ensures that 2298 1.1 christos <strong>NUMBER_LINES</strong> automatically supplies the correct 2299 1.1 christos value for the first argument, <strong><start 2300 1.1 christos number></strong>.) 2301 1.1 christos <p> 2302 1.1 christos Following this recipe, line number 1 will be numbered; subsequently, 2303 1.1 christos only line numbers that are multiples of 5 will be numbered. A 2304 1.1 christos little experimentation may be required to determine the best place 2305 1.1 christos for it. 2306 1.1 christos <p> 2307 1.1 christos The optional argument, <strong><gutter></strong>, tells 2308 1.1 christos <strong>mom</strong> how much space to put between the line numbers 2309 1.1 christos and the running text. 2310 1.1 christos <p> 2311 1.1 christos <strong>Note</strong>: when giving a value for 2312 1.1 christos <strong><gutter></strong>, you cannot skip the 2313 1.1 christos <strong><which lines to number></strong> argument. Either 2314 1.1 christos fill in the desired value, or use two double-quotes 2315 1.1 christos (<strong>""</strong>) to have <strong>mom</strong> use the value 2316 1.1 christos formerly in effect. 2317 1.1 christos <p> 2318 1.1 christos <strong><gutter></strong> does not require (or even accept) a 2319 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 2320 1.1 christos The argument you pass to it is the number of 2321 1.1 christos <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a> 2322 1.1 christos you want between line numbers and running text. 2323 1.1 christos <strong>Mom</strong>'s default gutter is two figure spaces. If 2324 1.1 christos you'd like a wider gutter, say, four figures spaces, you'd do 2325 1.1 christos <pre> 2326 1.1 christos .NUMBER_LINES 1 1 4 2327 1.1 christos | 2328 1.1 christos +-- Notice you *must* supply a value 2329 1.1 christos for the 2nd argument in order to supply 2330 1.1 christos a value for the 3rd. 2331 1.1 christos </pre> 2332 1.1 christos 2333 1.1 christos <p> 2334 1.1 christos After you've set up line-numbering, <strong>NUMBER_LINES</strong> 2335 1.1 christos can be used to control line numbering. 2336 1.1 christos <br> 2337 1.1 christos <h3><u>Line-numbering control</u></h3> 2338 1.1 christos <p> 2339 1.1 christos <strong>NUMBER_LINES OFF</strong> (or <strong>END, QUIT, X,</strong> etc.) 2340 1.1 christos turns line-numbering off. 2341 1.1 christos <p> 2342 1.1 christos Sometimes, you merely want to suspend line-numbering. In that case, 2343 1.1 christos turn line numbering off with <strong>NUMBER_LINES OFF</strong>. 2344 1.1 christos Later, when you want it to resume, enter 2345 1.1 christos <pre> 2346 1.1 christos .NUMBER_LINES RESUME 2347 1.1 christos </pre> 2348 1.1 christos 2349 1.1 christos Line numbering will resume exactly where it left off. If this is 2350 1.1 christos not what you want--say you want to reset the line number to "1"--simply 2351 1.1 christos invoke <strong>NUMBER_LINES</strong> with whatever arguments 2352 1.1 christos are needed for the desired result. 2353 1.1 christos <p> 2354 1.1 christos <strong>Extra Notes:</strong> 2355 1.1 christos <br> 2356 1.1 christos <ol> 2357 1.1 christos <li>In document processing, you may invoke <strong>NUMBER_LINES</strong> 2358 1.1 christos either before or after <strong>START</strong>. 2359 1.1 christos <strong>Mom</strong> doesn't care. 2360 1.1 christos <li>If you're collating documents with 2361 1.1 christos <a href="rectoverso.html#COLLATE">COLLATE</a>, 2362 1.1 christos you should re-invoke, at a minimum, <kbd>.NUMBER_LINES 2363 1.1 christos 1</kbd> for each collated document, in order to ensure that 2364 1.1 christos each begins with the number "1" prepended to the first line 2365 1.1 christos (unless, of course, that is not what you want). 2366 1.1 christos <li>Occasionally, you may want to change the current gutter 2367 1.1 christos between line numbers and running text without knowing 2368 1.1 christos what the next output line number should be. Since 2369 1.1 christos <strong>NUMBER_LINES</strong> requires this number 2370 1.1 christos as its first argument, in such instances, pass 2371 1.1 christos <strong>NUMBER_LINES</strong> as its first argument the 2372 1.1 christos escape <kbd>\n(ln</kbd>. 2373 1.1 christos <p> 2374 1.1 christos For example, if you were numbering every 5 lines with a 2375 1.1 christos gutter of 2 (figure spaces) and you needed to change the 2376 1.1 christos gutter to 4 (figures spaces), 2377 1.1 christos <p> 2378 1.1 christos <kbd> .NUMBER_LINES \n(ln 5 4</kbd> 2379 1.1 christos <p> 2380 1.1 christos would do the trick. 2381 1.1 christos <li>If you're using margin notes in a document, be sure to set 2382 1.1 christos the gutter for margin notes wide enough to allow room for 2383 1.1 christos the line numbers. 2384 1.1 christos <li><strong>Mom</strong> (groff, actually), only numbers lines 2385 1.1 christos <em>to the left of text</em>. For aesthetic reason, 2386 1.1 christos therefore, the use of line numbering when setting a document 2387 1.1 christos in columns is discouraged. However, should you wish to 2388 1.1 christos number lines when setting in columns, make sure the 2389 1.1 christos <a href="definitions.html#TERMS_GUTTER">gutter(s)</a> 2390 1.1 christos between columns is wide enough to leave room for the 2391 1.1 christos numbers. 2392 1.1 christos </ol> 2393 1.1 christos <hr width="33%" align="left"> 2394 1.1 christos 2395 1.1 christos <a name="NUMBER_LINES_CONTROL"><h3><u>Line numbering control macros for QUOTE and BLOCKQUOTE</u></h3></a> 2396 1.1 christos <ol> 2397 1.1 christos <li><a href="#NUMBER_QUOTE_LINES">NUMBER_QUOTE_LINES</a> 2398 1.1 christos <li><a href="#NUMBER_BLOCKQUOTE_LINES">NUMBER_BLOCKQUOTE_LINES</a> 2399 1.1 christos <li><a href="#NUMBER_LINES_QUOTES">Setting up line numbering in quotes and blockquotes on a case by case basis</a> 2400 1.1 christos </ol> 2401 1.1 christos 2402 1.1 christos <a name="NUMBER_QUOTE_LINES"><h3><u>1. NUMBER_QUOTE_LINES</u></h3></a> 2403 1.1 christos <p> 2404 1.1 christos If you'd like <strong>mom</strong> to number lines of output text 2405 1.1 christos in a 2406 1.1 christos <a href="#QUOTE">QUOTE</a> 2407 1.1 christos as part of the same order and sequence as paragraph text, simply 2408 1.1 christos invoke <strong>NUMBER_QUOTE_LINES</strong> by itself. 2409 1.1 christos <p> 2410 1.1 christos There is a catch with numbering quotes, though. Owing to groff's 2411 1.1 christos restriction of accepting only the figure space as the line number 2412 1.1 christos gutter's unit of measure, it is not possible for line numbers 2413 1.1 christos in quotes to hang outside a document's overall left margin and 2414 1.1 christos be reliably flush with the line numbers of paragraph text. 2415 1.1 christos Conseqently, line numbers in quotes hang to the left of the quote, 2416 1.1 christos separated from the quote by the <strong><gutter></strong> 2417 1.1 christos argument. 2418 1.1 christos <p> 2419 1.1 christos If you'd like to change the gutter for quotes line-numbered in 2420 1.1 christos this way, invoke <strong>NUMBER_QUOTE_LINES</strong> with a digit 2421 1.1 christos representing the number of 2422 1.1 christos <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a> 2423 1.1 christos you'd like between the line numbers and the quoted text, like this: 2424 1.1 christos <pre> 2425 1.1 christos .NUMBER_QUOTE_LINES 1 2426 1.1 christos </pre> 2427 1.1 christos 2428 1.1 christos With the above, line numbers in quotes (and only quotes) will have 2429 1.1 christos a gutter of 1 figure space. 2430 1.1 christos <p> 2431 1.1 christos If you are using "line numbering style" for footnotes 2432 1.1 christos (<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> <strong>LINE</strong>), 2433 1.1 christos you may not wish to have quotes <em>visibly</em> line-numbered, but 2434 1.1 christos still want to embed footnotes inside quotes. In order to do that, 2435 1.1 christos <strong>mom</strong> allows you to say <strong>NUMBER_QUOTE_LINES 2436 1.1 christos SILENT</strong>. 2437 1.1 christos <p> 2438 1.1 christos When you invoke <strong>NUMBER_QUOTE_LINES</strong> 2439 1.1 christos <kbd>SILENT</kbd>, <strong>mom</strong> continues to increment line 2440 1.1 christos numbers while quotes are being output, but they won't appear in the 2441 1.1 christos output copy. (Compare this with <strong>mom</strong>'s default 2442 1.1 christos behaviour of <em>suspending</em> incrementing of line numbers 2443 1.1 christos during the output of quotes.) This allows you to embed 2444 1.1 christos line-numbered footnotes inside quotes and have the line number 2445 1.1 christos "label" in the footnote come out sensibly. 2446 1.1 christos <p> 2447 1.1 christos Once having turned <strong>NUMBER_QUOTE_LINES</strong> on, you 2448 1.1 christos may disable it with <strong>NUMBER_QUOTE_LINES OFF</strong> (or 2449 1.1 christos <strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>, 2450 1.1 christos etc). 2451 1.1 christos <p> 2452 1.1 christos 2453 1.1 christos <a name="NUMBER_BLOCKQUOTE_LINES"><h3><u>2. NUMBER_BLOCKQUOTE_LINES</u></h3></a> 2454 1.1 christos <p> 2455 1.1 christos If you'd like <strong>mom</strong> to number lines of output text 2456 1.1 christos in a 2457 1.1 christos <a href="#QUOTE">BLOCKQUOTE</a> 2458 1.1 christos as part of the same order and sequence as paragraph text, simply 2459 1.1 christos invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong> by itself. 2460 1.1 christos <p> 2461 1.1 christos There is a catch with numbering blockquotes, though. Owing to 2462 1.1 christos groff's restriction of accepting only the figure space as the 2463 1.1 christos line number gutter's unit of measure, it is not possible for line 2464 1.1 christos numbers in blockquotes to hang outside a document's overall left 2465 1.1 christos margin and be reliably flush with the line numbers of paragraph 2466 1.1 christos text. Conseqently, line numbers in blockquotes hang to the 2467 1.1 christos left of the blockquote, separated from the blockquote by the 2468 1.1 christos <strong><gutter></strong> argument. 2469 1.1 christos <p> 2470 1.1 christos If you'd like to change the gutter for blockquotes line-numbered in 2471 1.1 christos this way, invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong> with a digit 2472 1.1 christos representing the number of 2473 1.1 christos <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a> 2474 1.1 christos you'd like between the line numbers and the blockquoted text, like 2475 1.1 christos this: 2476 1.1 christos <pre> 2477 1.1 christos .NUMBER_BLOCKQUOTE_LINES 1 2478 1.1 christos </pre> 2479 1.1 christos 2480 1.1 christos With the above, line numbers in blockquotes (and only blockquotes) 2481 1.1 christos will have a gutter of 1 figure space. 2482 1.1 christos <p> 2483 1.1 christos If you are using "line numbering style" for footnotes 2484 1.1 christos (<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> <strong>LINE</strong>), 2485 1.1 christos you may not wish to have blockquotes <em>visibly</em> line-numbered, 2486 1.1 christos but still want to embed footnotes inside blockquotes. In 2487 1.1 christos order to do that, <strong>mom</strong> allows you to say 2488 1.1 christos <strong>NUMBER_BLOCKQUOTE_LINES SILENT</strong>. 2489 1.1 christos <p> 2490 1.1 christos When you invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong> 2491 1.1 christos <kbd>SILENT</kbd>, <strong>mom</strong> continues to increment line 2492 1.1 christos numbers while blockquotes are being output, but they won't appear in 2493 1.1 christos the output copy. (Compare this with <strong>mom</strong>'s default 2494 1.1 christos behaviour of <em>suspending</em> incrementing of line numbers during 2495 1.1 christos the output of blockquotes.) This allows you to embed line-numbered 2496 1.1 christos footnotes inside blockquotes and have the line number "label" in the 2497 1.1 christos footnote come out sensibly. 2498 1.1 christos <p> 2499 1.1 christos Once having turned <strong>NUMBER_BLOCKQUOTE_LINES</strong> on, you 2500 1.1 christos may disable it with <strong>NUMBER_BLOCKQUOTE_LINES OFF</strong> (or 2501 1.1 christos <strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>, 2502 1.1 christos etc). 2503 1.1 christos <p> 2504 1.1 christos 2505 1.1 christos <a name="NUMBER_LINES_QUOTES"><h3><u>3. Setting up line numbering in quotes and blockquotes on a case by case basis</u></h3></a> 2506 1.1 christos <p> 2507 1.1 christos Sometimes, you may want quotes or blockquotes to have a different 2508 1.1 christos line numbering scheme from the one used in the rest of the 2509 1.1 christos document. Or, you may want line numbering enabled only inside a 2510 1.1 christos particular quote or blockquote. A common reason for this would be 2511 1.1 christos if you were using the 2512 1.1 christos <a href="#QUOTE">QUOTE</a> 2513 1.1 christos macro to insert lines of programming code into a document. (See 2514 1.1 christos <a href="#QUOTE_TIP">here</a> 2515 1.1 christos for suggestions about including programming code snippets in 2516 1.1 christos documents.) 2517 1.1 christos <p> 2518 1.1 christos To enable line numbering within quotes or blockquotes on a case by 2519 1.1 christos case basis, simply invoke <strong>NUMBER_LINES</strong>, with the 2520 1.1 christos arguments you need, immediately after entering <strong>QUOTE</strong> 2521 1.1 christos or <strong>BLOCKQUOTE</strong>. (<strong>NUMBER_QUOTE_LINES</strong> 2522 1.1 christos and/or <strong>NUMBER_BLOCKQUOTE_LINES</strong> should be turned 2523 1.1 christos off if you're doing this.) The quote or blockquote will then be 2524 1.1 christos line-numbered according to your specifications: the starting line 2525 1.1 christos number of the quote or blockquote will be the one you give as a 2526 1.1 christos first argument to <strong>NUMBER_LINES</strong>; which lines to 2527 1.1 christos number will be the value you pass to <strong><which lines to 2528 1.1 christos number></strong> (defaults to "1"); line numbers will hang 2529 1.1 christos to the left of the quote or blockquote, separated from the quote or 2530 1.1 christos blockquote by <strong><gutter></strong> (defaults to "2"). 2531 1.1 christos <p> 2532 1.1 christos As soon as <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong> is 2533 1.1 christos turned off, line numbering ceases, not only with respect to 2534 1.1 christos subsequent paragraph text (if they are not being line-numbered), 2535 1.1 christos but also for any subsequent invocation of <strong>QUOTE</strong> or 2536 1.1 christos <strong>BLOCKQUOTE</strong>. In other words, you must re-enable 2537 1.1 christos quote or blockquote line-numbering inside every instance of 2538 1.1 christos <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong> when 2539 1.1 christos line-numbering either of them on a case by case basis. 2540 1.1 christos <p> 2541 1.1 christos <hr> 2542 1.1 christos 2543 1.1 christos <!====================================================================> 2544 1.1 christos 2545 1.1 christos <a name="FOOTNOTE_INTRO"><h2><u>Footnotes</u></h2></a> 2546 1.1 christos <ul> 2547 1.1 christos <li><a href="#FOOTNOTE_BEHAVIOUR">Footnote behaviour</a> 2548 1.1 christos <ul> 2549 1.1 christos <li><a href="#FN_AND_PUNCT">Footnote markers and punctuation in the running text</a> 2550 1.1 christos </ul> 2551 1.1 christos <li><a href="#FOOTNOTE">Tag: FOOTNOTE</a> 2552 1.1 christos <li><a href="#FOOTNOTE_CONTROL">FOOTNOTE control macros</a> 2553 1.1 christos </ul> 2554 1.1 christos 2555 1.1 christos <p> 2556 1.1 christos For something so complex behind the scenes, footnotes are easy to use. 2557 1.1 christos You just type, for example 2558 1.1 christos <p> 2559 1.1 christos <a name="FOOTNOTE_EXAMPLE"></a> 2560 1.1 christos <pre> 2561 1.1 christos ...the doctrines of Identity as urged by Schelling\c 2562 1.1 christos .FOOTNOTE 2563 1.1 christos <footnote about who the hell is Schelling> 2564 1.1 christos .FOOTNOTE OFF 2565 1.1 christos were generally the points of discussion presenting the most 2566 1.1 christos of beauty to the imaginative Morella. 2567 1.1 christos </pre> 2568 1.1 christos 2569 1.1 christos and be done with it. 2570 1.1 christos <p> 2571 1.1 christos (Note the obligatory use of the <strong>\c</strong> 2572 1.1 christos <a href="definitions.html#TERMS_INLINES">inline escape</a>. 2573 1.1 christos It is required when your 2574 1.1 christos <a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> 2575 1.1 christos is either <strong>STAR</strong> [star/dagger footnotes] or 2576 1.1 christos <strong>NUMBER</strong> [superscript numbers]; it is NOT to be used 2577 1.1 christos when the <strong>FOOTNOTE_MARKER_STYLE</strong> is 2578 1.1 christos <strong>LINE</strong>, or when footnote markers have been disabled 2579 1.1 christos with 2580 1.1 christos <a href="#FOOTNOTE_MARKERS">.FOOTNOTE_MARKERS</a> 2581 1.1 christos <strong>OFF</strong>.) 2582 1.1 christos <p> 2583 1.1 christos <strong>***Version 1.3 change***</strong> 2584 1.1 christos <p> 2585 1.1 christos As of version 1.3, the manner of entering the line 2586 1.1 christos <em>after</em> <strong>.FOOTNOTE OFF</strong> has changed 2587 1.1 christos to accommodate users' differing wishes with respect to 2588 1.1 christos the order of punctuation and footnote markers. The 2589 1.1 christos correct way to enter the line after <strong>.FOOTNOTE 2590 1.1 christos OFF</strong>--<strong><em><u>ONLY</u></em></strong> if your 2591 1.1 christos <a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> is 2592 1.1 christos <strong>STAR</strong> or <strong>NUMBER</strong>--is to input 2593 1.1 christos it as if it's literally a continuation of the line before 2594 1.1 christos <strong>.FOOTNOTE</strong>, and therefore begins with either a space 2595 1.1 christos or a punctuation mark, as in the two following examples. 2596 1.1 christos <p> 2597 1.1 christos <pre> 2598 1.1 christos Example 1 Example 2 2599 1.1 christos --------- --------- 2600 1.1 christos 2601 1.1 christos A line of text,\c A line of text\c 2602 1.1 christos .FOOTNOTE .FOOTNOTE 2603 1.1 christos A footnote line. A footnote line. 2604 1.1 christos .FOOTNOTE OFF .FOOTNOTE OFF 2605 1.1 christos broken up with a comma. , broken up with a comma. 2606 1.1 christos 2607 1.1 christos (last line begins with (last line begins with 2608 1.1 christos a literal space) the comma and a space) 2609 1.1 christos </pre> 2610 1.1 christos 2611 1.1 christos If your <strong>FOOTNOTE_MARKER_STYLE</strong> is line, none of 2612 1.1 christos this is a concern. 2613 1.1 christos <p> 2614 1.1 christos <strong>***End of version 1.3 change***</strong> 2615 1.1 christos <p> 2616 1.1 christos After you invoke <strong>FOOTNOTE</strong>, <strong>mom</strong> 2617 1.1 christos takes care of everything: putting footnote markers in the body of 2618 1.1 christos the document, keeping track of how many footnotes are on the page, 2619 1.1 christos identifying the footnotes themselves appropriately, balancing them 2620 1.1 christos properly with the bottom margin, deferring footnotes that don't fit 2621 1.1 christos on the page... Even if you're using 2622 1.1 christos <a href="columns.html#COLUMNS">COLUMNS</a>, 2623 1.1 christos <strong>mom</strong> knows what to do, and Does The Right Thing. 2624 1.1 christos <p> 2625 1.1 christos Footnotes can be sly little beasts, though. If you're writing a 2626 1.1 christos document that's footnote-heavy, you might want to read the following. 2627 1.1 christos <p> 2628 1.1 christos 2629 1.1 christos <a name="FOOTNOTE_BEHAVIOUR"><h3><u>Footnote behaviour</u></h3></a> 2630 1.1 christos <p> 2631 1.1 christos By default, <strong>mom</strong> marks footnotes with alternating 2632 1.1 christos stars (asterisks), daggers, and double-daggers. The first footnote 2633 1.1 christos gets a star, the second a dagger, the third a double-dagger, the 2634 1.1 christos fourth two stars, the fifth two daggers, etc. If you prefer 2635 1.1 christos numbered footnotes, rest assured <strong>mom</strong> is happy to 2636 1.1 christos oblige. 2637 1.1 christos <p> 2638 1.1 christos A small amount of vertical whitespace and a short horizontal rule 2639 1.1 christos separate footnotes from the document body. The amount of whitespace 2640 1.1 christos varies slightly from page to page depending on the number of lines 2641 1.1 christos in the footnotes. <strong>Mom</strong> tries for a nice balance 2642 1.1 christos between too little whitespace and too much, but when push comes to 2643 1.1 christos shove, she'll usually opt for ample over cramped. The last lines of 2644 1.1 christos footnotes are always flush with the document's bottom margin. 2645 1.1 christos <a name="FOOTNOTE_RULES"></a> 2646 1.1 christos <p> 2647 1.1 christos If <strong>mom</strong> sees that a portion of a footnote cannot 2648 1.1 christos be fit on its page, she carries that portion over to the next 2649 1.1 christos page. If an entire footnote can't be fit on its page (i.e. 2650 1.1 christos <strong>FOOTNOTE</strong> has been called too close to the bottom), 2651 1.1 christos she defers the footnote to the next page, but sets it with the 2652 1.1 christos appropriate marker from the previous page. 2653 1.1 christos <p> 2654 1.1 christos When footnotes occur within cited text, for example a 2655 1.1 christos <a href="#QUOTE">QUOTE</a> 2656 1.1 christos or a 2657 1.1 christos <a href="#BLOCKQUOTE">BLOCKQUOTE</a>, 2658 1.1 christos <strong>mom</strong> will usually opt for deferring the footnote 2659 1.1 christos over to the next page if it allows her to complete the cited text 2660 1.1 christos on one page. 2661 1.1 christos <p> 2662 1.1 christos In the unfortunate happenstance that a deferred footnote is the 2663 1.1 christos only footnote on its page (i.e. it's marked in the document body with 2664 1.1 christos a star) and the page it's deferred to has its own footnotes, 2665 1.1 christos <strong>mom</strong> separates the deferred footnote from the page's 2666 1.1 christos proper footnote(s) with a blank line. This avoids the confusion that 2667 1.1 christos might result from readers seeing two footnote entries on the same page 2668 1.1 christos identified by a single star (or the number 1 if you've requested 2669 1.1 christos numbered footnotes that begin at 1 on every page). The blank line 2670 1.1 christos makes it clear that the first footnote entry belongs to the previous 2671 1.1 christos page. 2672 1.1 christos <p> 2673 1.1 christos In the circumstance where a deferred footnote is not the only one 2674 1.1 christos on its page, and is consequently marked by something other than a 2675 1.1 christos single star, there's no confusion and <strong>mom</strong> doesn't 2676 1.1 christos bother with the blank line. (By convention, the first footnote on 2677 1.1 christos a page is always marked with a single star, so if readers see, say, 2678 1.1 christos a dagger or double-dagger marking the first footnote entry, they'll 2679 1.1 christos know the entry belongs to the previous page). 2680 1.1 christos <p> 2681 1.1 christos Very exceptionally, two footnotes may have to be deferred (e.g. one 2682 1.1 christos occurs on the second to last line of a page, and another on the 2683 1.1 christos last line). In such a circumstance, <strong>mom</strong> does not 2684 1.1 christos add a blank after the second deferred footnote. If you'd like a 2685 1.1 christos blank line separating both deferred footnotes from any footnotes 2686 1.1 christos proper to the page the deferred ones were moved to, add the space 2687 1.1 christos manually by putting a 2688 1.1 christos <a href="typesetting.html#SPACE">.SPACE</a> 2689 1.1 christos command at the end of the footnote text, before 2690 1.1 christos <strong>FOOTNOTE OFF</strong> (or <strong>FOOTNOTE X, QUIT, 2691 1.1 christos EXIT, etc...</strong>). 2692 1.1 christos <p> 2693 1.1 christos Obviously, deferred footnotes aren't an issue if you request numbered 2694 1.1 christos footnotes that increase incrementally throughout the whole document -- 2695 1.1 christos yet another convenience <strong>mom</strong> has thought of. 2696 1.1 christos <p> 2697 1.1 christos While <strong>mom</strong>'s handling of footnotes is 2698 1.1 christos sophisticated, and tries to take nearly every imaginable situation 2699 1.1 christos under which they might occur into account, some situations are 2700 1.1 christos simply impossible from a typographic standpoint. For example, if 2701 1.1 christos you have a 2702 1.1 christos <a href="#HEAD">HEAD</a> 2703 1.1 christos near the bottom of the page AND that page has some footnotes on it, 2704 1.1 christos <strong>mom</strong> may simply not have room to set any text under 2705 1.1 christos the head (normally, she insists on having room for at least one line 2706 1.1 christos of text beneath a head). In such an instance, <strong>mom</strong> 2707 1.1 christos will either set the head, with nothing under it but footnotes, 2708 1.1 christos or transfer the head to the next page. Either way, you'll have a 2709 1.1 christos gaping hole at the bottom of the page. It's a sort of typographic 2710 1.1 christos Catch-22, and can only be resolved by you, the writer or formatter 2711 1.1 christos of the document, adjusting the type on the offending page so as to 2712 1.1 christos circumvent the problem. 2713 1.1 christos <p> 2714 1.1 christos <strong>NOTE:</strong> Exceptionally, you may encounter problems with footnotes inside 2715 1.1 christos quotes and blockquotes that cross a page or column. See <a 2716 1.1 christos href="#BREAK_QUOTE">BREAK_QUOTE</a> 2717 1.1 christos for a solution. 2718 1.1 christos <p> 2719 1.1 christos 2720 1.1 christos <h3><u><a name="FN_AND_PUNCT">Footnote markers and punctuation in the running text</a></u></h3> 2721 1.1 christos 2722 1.1 christos <p> 2723 1.1 christos As of version 1.3, the manner of entering the line <em>after</em> 2724 1.1 christos <strong>.FOOTNOTE OFF</strong> has changed. The correct way to 2725 1.1 christos enter the line after <strong>.FOOTNOTE OFF</strong> now is to 2726 1.1 christos input it as if it's literally a continuation of the line before 2727 1.1 christos <strong>.FOOTNOTE</strong>, and therefore begins with either a space 2728 1.1 christos or a punctuation mark, as in the two following examples. 2729 1.1 christos <p> 2730 1.1 christos <pre> 2731 1.1 christos Example 1 Example 2 2732 1.1 christos --------- --------- 2733 1.1 christos 2734 1.1 christos A line of text,\c A line of text\c 2735 1.1 christos .FOOTNOTE .FOOTNOTE 2736 1.1 christos A footnote line. A footnote line. 2737 1.1 christos .FOOTNOTE OFF .FOOTNOTE OFF 2738 1.1 christos broken up with a comma. , broken up with a comma. 2739 1.1 christos 2740 1.1 christos (last line begins with (last line begins with 2741 1.1 christos a literal space) the comma and a space) 2742 1.1 christos </pre> 2743 1.1 christos 2744 1.1 christos Care must be taken, though, if the punctuation mark that begins the 2745 1.1 christos line after <strong>FOOTNOTE OFF</strong> is a period (dot). You 2746 1.1 christos <strong><em><u>must</u></em></strong> begin such lines with 2747 1.1 christos <strong>\&.</strong>, like this: 2748 1.1 christos <p> 2749 1.1 christos <pre> 2750 1.1 christos end of a sentence\c 2751 1.1 christos .FOOTNOTE 2752 1.1 christos A footnote line. 2753 1.1 christos .FOOTNOTE OFF 2754 1.1 christos \&. A new sentence... 2755 1.1 christos </pre> 2756 1.1 christos 2757 1.1 christos If you omit the <strong>\&.</strong>, the line will vanish! 2758 1.1 christos <p> 2759 1.1 christos 2760 1.1 christos 2761 1.1 christos <!---FOOTNOTE---> 2762 1.1 christos 2763 1.1 christos <hr width="66%" align="left"> 2764 1.1 christos <p> 2765 1.1 christos <a name="FOOTNOTE"> 2766 1.1 christos <nobr>Tag: <strong>FOOTNOTE</strong> <toggle> | INDENT LEFT | RIGHT | BOTH <indent value></nobr> 2767 1.1 christos <br> 2768 1.1 christos <em>*See <a href="#FOOTNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!</em> 2769 1.1 christos <br> 2770 1.1 christos <indent value> requires a 2771 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em> 2772 1.1 christos </a> 2773 1.1 christos 2774 1.1 christos <p> 2775 1.1 christos <strong>FOOTNOTE</strong> is a toggle macro, therefore invoking it 2776 1.1 christos on a line by itself allows you to enter a footnote in the body of a 2777 1.1 christos document. Invoking it with any argument <em>other than INDENT</em> 2778 1.1 christos (i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong> 2779 1.1 christos you're finished. 2780 1.1 christos <p> 2781 1.1 christos Footnotes are the only element of 2782 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a> 2783 1.1 christos that are not affected by the typesetting 2784 1.1 christos <a href="typesetting.html#INDENTS">indent macros</a>. 2785 1.1 christos In the unlikely event that you want a page's footnotes to line 2786 1.1 christos up with a running indent, invoke <strong>FOOTNOTE</strong> with 2787 1.1 christos the <strong>INDENT</strong> argument and pass it an indent 2788 1.1 christos direction and indent value. <strong>L, R,</strong> and 2789 1.1 christos <strong>B</strong> may be used in place of <strong>LEFT, 2790 1.1 christos RIGHT,</strong> and <strong>BOTH</strong>. 2791 1.1 christos <strong>FOOTNOTE</strong> must be invoked with <strong>INDENT</strong> 2792 1.1 christos for every footnote you want indented; <strong>mom</strong> does 2793 1.1 christos not save any footnote indent information from invocation to 2794 1.1 christos invocation. 2795 1.1 christos <p> 2796 1.1 christos <strong>NOTE:</strong> If a footnote runs to more than one 2797 1.1 christos paragraph(!), <strong>DO NOT</strong> begin the footnote with 2798 1.1 christos the 2799 1.1 christos <a href="#PP">PP</a> 2800 1.1 christos tag. Use <strong>PP</strong> only to introduce subsequent paragraphs. 2801 1.1 christos <p> 2802 1.1 christos <a name="FOOTNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a> 2803 1.1 christos The final word on the 2804 1.1 christos <a href="definitions.html#TERMS_INPUTLINE">input line</a> 2805 1.1 christos that comes immediately before <strong>FOOTNOTE</strong> MUST terminate 2806 1.1 christos with a 2807 1.1 christos <a href="typesetting.html#JOIN">\c</a> 2808 1.1 christos inline escape if your 2809 1.1 christos <a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> 2810 1.1 christos is either <strong>STAR</strong> or <strong>NUMBER</strong>. 2811 1.1 christos See the 2812 1.1 christos <a href="#FOOTNOTE_EXAMPLE">footnote example</a> 2813 1.1 christos above. 2814 1.1 christos <p> 2815 1.1 christos Additionally, the line <em>after</em> a <strong>FOOTNOTE 2816 1.1 christos OFF</strong> should be entered as if there were no interruption in 2817 1.1 christos the input text, i.e. the line should begin with a literal space or 2818 1.1 christos punctuation mark. See 2819 1.1 christos <a href="#FN_AND_PUNCT">above</a>. 2820 1.1 christos <p> 2821 1.1 christos Do NOT use the <strong>\c</strong> inline escape if your 2822 1.1 christos <strong>FOOTNOTE_MARKER_STYLE</strong> is <strong>LINE</strong>, or 2823 1.1 christos if you have disabled footnote markers with 2824 1.1 christos <a href="#FOOTNOTE_MARKERS">.FOOTNOTE_MARKERS</a> 2825 1.1 christos <strong>OFF</strong>. As well, the line after 2826 1.1 christos <strong>FOOTNOTE OFF</strong> should be entered normally. 2827 1.1 christos 2828 1.1 christos <p> 2829 1.1 christos <a name="FOOTNOTE_CONTROL"><h3><u>Footnote control macros</u></h3></a> 2830 1.1 christos <ol> 2831 1.1 christos <li><a href="#FOOTNOTE_GENERAL">Family/font/size/colour/lead/quad</a> 2832 1.1 christos <li><a href="#FOOTNOTE_MARKERS">Footnote markers</a> -- on or off 2833 1.1 christos <li><a href="#FOOTNOTE_MARKER_STYLE">Footnote marker style</a> -- star+dagger, numbered or by line number 2834 1.1 christos <ul> 2835 1.1 christos <li><a href="#FOOTNOTE_LINENUMBER_BRACKETS">FOOTNOTE_LINENUMBER_BRACKETS</a> 2836 1.1 christos <li><a href="#FOOTNOTE_LINENUMBER_SEPARATOR">FOOTNOTE_LINENUMBER_SEPARATOR</a> 2837 1.1 christos <li><a href="#FOOTNOTES_RUN_ON">FOOTNOTES_RUN_ON</a>--line-numbered footnotes only 2838 1.1 christos </ul> 2839 1.1 christos <li><a href="#RESET_FOOTNOTE_NUMBER">Reset footnote number</a> -- set footnote marker number to 1 2840 1.1 christos <li><a href="#FOOTNOTE_SPACE">Inter-footnote spacing</a> 2841 1.1 christos <li><a href="#FOOTNOTE_RULE">Footnote rule</a> -- on or off 2842 1.1 christos <li><a href="#FOOTNOTE_RULE_LENGTH">Footnote rule length</a> -- length of footnote separator rule 2843 1.1 christos <li><a href="#FOOTNOTE_RULE_ADJ">Adjust vertical position of footnote separator rule</a> 2844 1.1 christos </ol> 2845 1.1 christos <p> 2846 1.1 christos <a name="FOOTNOTE_GENERAL"><h3><u>1. Family/font/size/colour/lead/quad</u></h3></a> 2847 1.1 christos <p> 2848 1.1 christos See 2849 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 2850 1.1 christos <p> 2851 1.1 christos <pre> 2852 1.1 christos .FOOTNOTE_FAMILY default = prevailing document family; default is Times Roman 2853 1.1 christos .FOOTNOTE_FONT default = roman 2854 1.1 christos .FOOTNOTE_SIZE default = -2 (points) 2855 1.1 christos .FOOTNOTE_COLOR default = black 2856 1.1 christos .FOOTNOTE_AUTOLEAD default = 2 points (typeset); single-spaced (typewrite) 2857 1.1 christos .FOOTNOTE_QUAD default = same as paragraphs 2858 1.1 christos </pre> 2859 1.1 christos 2860 1.1 christos <a name="FOOTNOTE_MARKERS"><h3><u>2. Footnote markers -- FOOTNOTE_MARKERS</u></h3></a> 2861 1.1 christos <p> 2862 1.1 christos If you don't want footnote markers, in either the body of 2863 1.1 christos the document or beside footnote entries themselves, toggle 2864 1.1 christos them off with <strong>.FOOTNOTE_MARKERS OFF</strong> (or 2865 1.1 christos <strong>END, QUIT, X</strong>...). This means, of course, that 2866 1.1 christos you'll have to roll your own. If you want them back on, invoke 2867 1.1 christos <strong>.FOOTNOTE_MARKERS</strong> with no argument. Footnote markers 2868 1.1 christos are on by default. 2869 1.1 christos <p> 2870 1.1 christos If <strong>FOOTNOTE_MARKERS</strong> are disabled, do NOT use the 2871 1.1 christos <strong>\c</strong> inline escape to terminate the line before 2872 1.1 christos <strong>.FOOTNOTE</strong>. 2873 1.1 christos <p> 2874 1.1 christos 2875 1.1 christos <a name="FOOTNOTE_MARKER_STYLE"><h3><u>3. Footnote marker style -- FOOTNOTE_MARKER_STYLE</u></h3></a> 2876 1.1 christos <p> 2877 1.1 christos <strong>Mom</strong> gives you two choices of footnote marker style: 2878 1.1 christos star+dagger (see 2879 1.1 christos <a href="#FOOTNOTE_BEHAVIOUR">footnote behaviour</a> 2880 1.1 christos above), or numbered. 2881 1.1 christos <p> 2882 1.1 christos <strong>.FOOTNOTE_MARKER_STYLE STAR</strong> gives you star+dagger 2883 1.1 christos (the default). There is a limit of 10 footnotes per page with 2884 1.1 christos this style. 2885 1.1 christos <p> 2886 1.1 christos <strong>.FOOTNOTE_MARKER_STYLE NUMBER</strong> gives you superscript 2887 1.1 christos numbers, both in the document body and in the footnote entries 2888 1.1 christos themselves. By default, footnote numbers increase incrementally 2889 1.1 christos (prev. footnote number + 1) throughout the whole document. You can 2890 1.1 christos ask <strong>mom</strong> to start each page's footnote numbers at 1 2891 1.1 christos with <strong>.RESET_FOOTNOTE_NUMBER</strong> 2892 1.1 christos (<a href="#RESET_FOOTNOTE_NUMBER">see below</a>.) 2893 1.1 christos <a name="FOOTNOTE_LINENUMBERS"><p></a> 2894 1.1 christos <p> 2895 1.1 christos <strong>.FOOTNOTE_MARKER_STYLE LINE</strong> lets you have 2896 1.1 christos footnotes which are identified by line number, rather than by a 2897 1.1 christos marker in the text. (Note that 2898 1.1 christos <a href="#NUMBER_LINES">NUMBER_LINES</a> 2899 1.1 christos must be enabled in order to use this marker style.) 2900 1.1 christos <p> 2901 1.1 christos With <strong>FOOTNOTE_MARKER_STYLE LINE</strong>, <strong>mom</strong> 2902 1.1 christos will identify footnotes either by single line numbers, or line 2903 1.1 christos ranges. If what you want is a single line number, you need only 2904 1.1 christos invoke <strong>.FOOTNOTE</strong>, <em>without terminating the text 2905 1.1 christos line before it with</em> <strong>\c</strong>, at the appropriate 2906 1.1 christos place in running text. 2907 1.1 christos <p> 2908 1.1 christos If you want a range of line numbers (e.g. [5-11] ), 2909 1.1 christos insert, directly into the first line of the range you want, the 2910 1.1 christos <a href="definitions.html#TERMS_INLINES">inline escape</a>, 2911 1.1 christos <strong>\*[FN-MARK]</strong>. For the terminating line number of 2912 1.1 christos the range, you need only invoke <strong>.FOOTNOTE</strong>, (again, 2913 1.1 christos without attaching <strong>\c</strong> to the text line before it). 2914 1.1 christos <strong>Mom</strong> is smart enough to figure out that where 2915 1.1 christos <strong>FOOTNOTE</strong> was invoked represents the terminating 2916 1.1 christos line number. Range-numbered footnotes are always output on the page 2917 1.1 christos where <strong>FOOTNOTE</strong> was invoked, not the page where 2918 1.1 christos <strong>\*[FN-MARK]</strong> appears (subject, of course, to the 2919 1.1 christos rules for footnotes that fall too close to the bottom of a page, as 2920 1.1 christos outlined 2921 1.1 christos <a href="#FOOTNOTE_RULES">here</a>). 2922 1.1 christos <a name="FOOTNOTE_LINENUMBER_BRACKETS"></a> 2923 1.1 christos <p> 2924 1.1 christos <strong>Mom</strong>, by default, puts footnote line numbers inside 2925 1.1 christos square brackets. The style of the brackets may be changed with 2926 1.1 christos the macro, <strong>FOOTNOTE_LINENUMBER_BRACKETS</strong>, which 2927 1.1 christos takes one of three possible arguments: <strong>PARENS</strong> 2928 1.1 christos ("round" brackets), <strong>SQUARE</strong> (the default) or 2929 1.1 christos <strong>BRACES</strong> (curly braces). If you prefer a 2930 1.1 christos shortform, the arguments, <strong>(</strong>, <strong>[</strong> or 2931 1.1 christos <strong>{</strong> may be used instead. 2932 1.1 christos <a name="FOOTNOTE_LINENUMBER_SEPARATOR"></a> 2933 1.1 christos <p> 2934 1.1 christos If you don't want the numbers enclosed in brackets, you may tell 2935 1.1 christos <strong>mom</strong> to use a "separator" instead. A common 2936 1.1 christos separator would be the colon, but it can be anything you like. The 2937 1.1 christos macro to do this is <strong>FOOTNOTE_LINENUMBER_SEPARATOR</strong>, 2938 1.1 christos which takes, as its single argument, the separator you want. For 2939 1.1 christos safety and consistency's sake, ALWAYS enclose the argument in 2940 1.1 christos double-quotes. 2941 1.1 christos <p> 2942 1.1 christos The separator can be composed of any legal groff character, or any 2943 1.1 christos combination of characters. <strong>A word of caution:</strong> when 2944 1.1 christos using a separator, <strong>mom</strong> doesn't insert a space 2945 1.1 christos after the separator. Hence, if you want the space (you probably 2946 1.1 christos do), you must make the space part of the argument you pass to 2947 1.1 christos <strong>FOOTNOTE_LINENUMBER_SEPARATOR</strong>. For example, 2948 1.1 christos to get a colon separator with a space after it, you'd do 2949 1.1 christos <p> 2950 1.1 christos <pre> 2951 1.1 christos .FOOTNOTE_LINENUMBER_SEPARATOR ": " 2952 1.1 christos </pre> 2953 1.1 christos 2954 1.1 christos <a name="FOOTNOTES_RUN_ON"><strong><u>RUN-ON FOOTNOTES</u></strong></a> 2955 1.1 christos <p> 2956 1.1 christos Finally, if your footnote marker style is <strong>LINE</strong>, you 2957 1.1 christos may instruct <strong>mom</strong> to do "run-on style" footnotes. 2958 1.1 christos Run-on footnotes do not treat footnotes as discrete entities, i.e. 2959 1.1 christos on a line by themselves. Rather, each footnote is separated from 2960 1.1 christos the footnote before it by a space, so that the footnotes on any 2961 1.1 christos given page form a continuous block, like lines in a paragraph. The 2962 1.1 christos macro to get 2963 1.1 christos <strong>mom</strong> to run footnotes on is 2964 1.1 christos <strong>.FOOTNOTES_RUN_ON</strong>. Invoked by itself, it turns 2965 1.1 christos the feature on. Invoked with any other argument 2966 1.1 christos (<strong>OFF</strong>, <strong>NO</strong>, etc.), it turns the 2967 1.1 christos feature off. It is generally NOT a good idea to turn the feature 2968 1.1 christos on and off during the course of a single document. If you do, 2969 1.1 christos <strong>mom</strong> will issue a warning if there's going to be a 2970 1.1 christos problem. However, it is always perfectly safe to enable/disable the 2971 1.1 christos feature after 2972 1.1 christos <a href="rectoverso.html#COLLATE">COLLATE</a>. 2973 1.1 christos <p> 2974 1.1 christos The usual reason for wanting run-on footnotes is that you're 2975 1.1 christos using them to hold many, short references. (See 2976 1.1 christos <a href="refer.html#TOP">here</a> 2977 1.1 christos for instructions on using the <strong>groff</strong> program, 2978 1.1 christos <strong>refer</strong>, to set up references.) 2979 1.1 christos 2980 1.1 christos <p> 2981 1.1 christos 2982 1.1 christos <a name="RESET_FOOTNOTE_NUMBER"><h3><u>4. Reset footnote number -- RESET_FOOTNOTE_NUMBER</u></h3></a> 2983 1.1 christos <p> 2984 1.1 christos <strong>.RESET_FOOTNOTE_NUMBER</strong>, by itself, resets 2985 1.1 christos footnote numbering so that the next footnote you enter is 2986 1.1 christos numbered 1. 2987 1.1 christos <p> 2988 1.1 christos <strong>.RESET_FOOTNOTE_NUMBER PAGE</strong> tells 2989 1.1 christos <strong>mom</strong> to start every page's footnote numbering at 1. 2990 1.1 christos <p> 2991 1.1 christos 2992 1.1 christos <a name="FOOTNOTE_SPACE"><h3><u>5. Inter-footnote spacing -- FOOTNOTE_SPACE</u></h3></a> 2993 1.1 christos <p> 2994 1.1 christos If you'd like a little extra space between footnotes, you can have 2995 1.1 christos <strong>mom</strong> put it in for you by invoking 2996 1.1 christos <strong>.FOOTNOTE_SPACE</strong> with an argument representing the 2997 1.1 christos amount of extra space you'd like. The argument to 2998 1.1 christos <strong>FOOTNOTE_SPACE</strong> requires a 2999 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 3000 1.1 christos <p> 3001 1.1 christos In the following example, footnotes will be separated from each 3002 1.1 christos other by 3 3003 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a>. 3004 1.1 christos <pre> 3005 1.1 christos .FOOTNOTE_SPACE 3p 3006 1.1 christos </pre> 3007 1.1 christos 3008 1.1 christos <a name="FOOTNOTE_RULE"><h3><u>6. Footnote rule -- FOOTNOTE_RULE</u></h3></a> 3009 1.1 christos <p> 3010 1.1 christos If you don't want a footnote separator rule, toggle it off with 3011 1.1 christos <strong>.FOOTNOTE_RULE OFF</strong> (or <strong>END, 3012 1.1 christos QUIT, X</strong>...). Toggle it back on by invoking 3013 1.1 christos <strong>.FOOTNOTE_RULE</strong> with no argument. The default is to 3014 1.1 christos print the rule. 3015 1.1 christos <p> 3016 1.1 christos 3017 1.1 christos <a name="FOOTNOTE_RULE_LENGTH"><h3><u>7. Footnote rule length -- FOOTNOTE_RULE_LENGTH</u></h3></a> 3018 1.1 christos <p> 3019 1.1 christos If you want to change the length of the footnote separator rule, 3020 1.1 christos invoke <strong>.FOOTNOTE_RULE_LENGTH</strong> with a length, like 3021 1.1 christos this, 3022 1.1 christos <pre> 3023 1.1 christos .FOOTNOTE_RULE_LENGTH 1i 3024 1.1 christos </pre> 3025 1.1 christos 3026 1.1 christos which sets the length to 1 inch. Note that a 3027 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 3028 1.1 christos is required. The default is 4 3029 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">picas</a> 3030 1.1 christos for both 3031 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLES</a>. 3032 1.1 christos <p> 3033 1.1 christos 3034 1.1 christos <a name="FOOTNOTE_RULE_ADJ"><h3><u>8. Adjust vertical position of footnote separator rule -- FOOTNOTE_RULE_ADJ</u></h3></a> 3035 1.1 christos <p> 3036 1.1 christos The footnote separator rule is actually a baseline rule that falls 3037 1.1 christos on the 3038 1.1 christos <a href="definitions.html#TERMS_BASELINE">baseline</a> 3039 1.1 christos of the first line of a page's footnotes. By default, 3040 1.1 christos <strong>mom</strong> raises the rule 3 3041 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a> 3042 1.1 christos from the baseline so that the separator and the footnotes don't 3043 1.1 christos look jammed together. If you'd prefer a different vertical 3044 1.1 christos adjustment, invoke <strong>.FOOTNOTE_RULE_ADJ</strong> with the 3045 1.1 christos amount you'd like. For example 3046 1.1 christos <p> 3047 1.1 christos <pre> 3048 1.1 christos .FOOTNOTE_RULE_ADJ 4.25p 3049 1.1 christos </pre> 3050 1.1 christos 3051 1.1 christos raises the rule by 4-1/4 points. Note that you can only raise 3052 1.1 christos the rule, not lower it. A 3053 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 3054 1.1 christos is required. 3055 1.1 christos <p> 3056 1.1 christos <strong>Tip:</strong> If your document 3057 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a> 3058 1.1 christos is 2 3059 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a> 3060 1.1 christos or less (e.g your 3061 1.1 christos <a href="definitions.html#TERMS_PS">point size</a> 3062 1.1 christos is 10 and your linespacing is 10, 11, or 12, lowering 3063 1.1 christos <strong>mom</strong>'s default footnote rule adjustment will 3064 1.1 christos almost certainly give you nicer looking results than leaving 3065 1.1 christos the adjustment at the default. Furthermore, you can invoke 3066 1.1 christos <strong>FOOTNOTE_RULE_ADJ</strong> on any page in which footnotes 3067 1.1 christos appear, or in any column, so that the placement of the footnote rule 3068 1.1 christos can be changed on-the-fly, should you wish to do so. 3069 1.1 christos <p> 3070 1.1 christos <hr> 3071 1.1 christos 3072 1.1 christos <!====================================================================> 3073 1.1 christos 3074 1.1 christos <a name="ENDNOTE_INTRO"><h2><u>Endnotes</u></h2></a> 3075 1.1 christos <ul> 3076 1.1 christos <li><a href="#ENDNOTE_BEHAVIOUR">Endnote behaviour</a> 3077 1.1 christos <ul> 3078 1.1 christos <li><a href="#ENDNOTE_SPACING">A Note on Endnote Spacing</a> 3079 1.1 christos <li><a href="#ENDNOTE_COLUMNS">Endnotes and columnar documents</a> 3080 1.1 christos </ul> 3081 1.1 christos <li><a href="#ENDNOTE">Tag: ENDNOTE</a> 3082 1.1 christos <li><a href="#ENDNOTES">Macro: ENDNOTES</a> -- tell <strong>mom</strong> to output endnotes 3083 1.1 christos <li><a href="#ENDNOTE_CONTROL">ENDNOTES control macros</a> 3084 1.1 christos </ul> 3085 1.1 christos 3086 1.1 christos <p> 3087 1.1 christos Embedding endnotes into <strong>mom</strong> documents is accomplished 3088 1.1 christos the same way as embedding 3089 1.1 christos <a href="#FOOTNOTE_INTRO">footnotes</a>. The example below is 3090 1.1 christos identical to the one shown in the 3091 1.1 christos <a href="#FOOTNOTE_EXAMPLE">introduction to footnotes</a>, 3092 1.1 christos except that <kbd>.FOOTNOTE</kbd> has been replaced with 3093 1.1 christos <kbd>.ENDNOTE</kbd>. 3094 1.1 christos <p> 3095 1.1 christos <a name="ENDNOTE_EXAMPLE"></a> 3096 1.1 christos <pre> 3097 1.1 christos ...the doctrines of Identity as urged by Schelling\c 3098 1.1 christos .ENDNOTE 3099 1.1 christos <endnote about who the hell is Schelling> 3100 1.1 christos .ENDNOTE OFF 3101 1.1 christos were generally the points of discussion presenting the most 3102 1.1 christos of beauty to the imaginative Morella. 3103 1.1 christos </pre> 3104 1.1 christos 3105 1.1 christos As with footnotes, note the obligatory use of the <strong>\c</strong> 3106 1.1 christos <a href="definitions.html#TERMS_INLINES">inline escape</a> 3107 1.1 christos when your 3108 1.1 christos <a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a> 3109 1.1 christos is <strong>NUMBER</strong> (which marks endnotes references in 3110 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a> 3111 1.1 christos with superscript numbers). When the marker style is 3112 1.1 christos <strong>LINE</strong>, you must <em>not</em> use the 3113 1.1 christos <strong>\c</strong> escape. 3114 1.1 christos <p> 3115 1.1 christos <strong>***Version 1.3 change***</strong> 3116 1.1 christos <p> 3117 1.1 christos As of version 1.3, the manner of entering the line <em>after</em> 3118 1.1 christos <strong>.ENDNOTE OFF</strong> has changed to accommodate users' 3119 1.1 christos differing wishes with respect to the order of punctuation and 3120 1.1 christos endnote markers. The correct way to enter the line after 3121 1.1 christos <strong>.ENDNOTE OFF</strong>--but <strong><em><u>NOT</u></em></strong> 3122 1.1 christos if your 3123 1.1 christos <a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a> 3124 1.1 christos is <strong>LINE</strong>--is to input it as if it's literally 3125 1.1 christos a continuation of the line before <strong>.ENDNOTE</strong>, and 3126 1.1 christos therefore begins with either a space or a punctuation mark, as in 3127 1.1 christos the two following examples. 3128 1.1 christos <p> 3129 1.1 christos <a name="EN_PUNCT"></a> 3130 1.1 christos <pre> 3131 1.1 christos Example 1 Example 2 3132 1.1 christos --------- --------- 3133 1.1 christos 3134 1.1 christos A line of text,\c A line of text\c 3135 1.1 christos .ENDNOTE .ENDNOTE 3136 1.1 christos A footnote line. A footnote line. 3137 1.1 christos .ENDNOTE OFF .ENDNOTE OFF 3138 1.1 christos broken up with a comma. , broken up with a comma. 3139 1.1 christos 3140 1.1 christos (last line begins with (last line begins with 3141 1.1 christos a literal space) the comma and a space) 3142 1.1 christos </pre> 3143 1.1 christos 3144 1.1 christos <strong>***End version 1.3 change***</strong> 3145 1.1 christos <p> 3146 1.1 christos Endnotes differ from footnotes in two ways (other than the fact that 3147 1.1 christos endnotes come at the end of a document whereas footnotes appear in the 3148 1.1 christos body of the document): 3149 1.1 christos <br> 3150 1.1 christos <ol> 3151 1.1 christos <li>When your <strong>ENDNOTE_MARKER_STYLE</strong> is 3152 1.1 christos <strong>NUMBER</strong>, endnotes are always numbered 3153 1.1 christos incrementally, starting at "1". 3154 1.1 christos <li>Endnotes MUST be output explicitly; <strong>mom</strong> does 3155 1.1 christos not output them for you. In 3156 1.1 christos <a href="rectoverso.html#COLLATE">collated</a> 3157 1.1 christos documents, this allows you to choose whether you 3158 1.1 christos want the endnotes to appear at the end of each chapter or 3159 1.1 christos article in a document, or grouped together at the very end 3160 1.1 christos of the document. 3161 1.1 christos </ol> 3162 1.1 christos <p> 3163 1.1 christos Within endnotes, you may use the document element tags 3164 1.1 christos <a href="#PP">PP</a>, 3165 1.1 christos <a href="#QUOTE">QUOTE</a> 3166 1.1 christos and 3167 1.1 christos <a href="#BLOCKQUOTE">BLOCKQUOTE</a>. 3168 1.1 christos This provides the flexibility to create endnotes that run to several 3169 1.1 christos paragraphs, as well as to embed cited text within endnotes. 3170 1.1 christos <p> 3171 1.1 christos Should you wish to change the appearance of quotes or blockquotes that 3172 1.1 christos appear within endnotes, you may do so with the 3173 1.1 christos <a href="#QUOTE_CONTROL">quote control macros</a> 3174 1.1 christos or 3175 1.1 christos <a href="#BLOCKQUOTE_CONTROL">blockquote control macros</a>. 3176 1.1 christos HOWEVER... you must make the changes <em>within</em> each endnote, prior 3177 1.1 christos to invoking <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong>, and 3178 1.1 christos undo them prior to terminating the endnote (i.e. before <strong>ENDNOTE 3179 1.1 christos OFF</strong>), otherwise the changes will affect subsequent quotes and 3180 1.1 christos blockquotes that appear in the document body as well. 3181 1.1 christos <p> 3182 1.1 christos 3183 1.1 christos <a name="ENDNOTE_BEHAVIOUR"><h3><u>Endnote behaviour</u></h3></a> 3184 1.1 christos <br> 3185 1.1 christos When you output endnotes (with 3186 1.1 christos <a href="#ENDNOTES">ENDNOTES</a>), 3187 1.1 christos <strong>mom</strong> finishes processing the last page of your document, 3188 1.1 christos then breaks to a new page for printing the endnotes. If the document 3189 1.1 christos type is 3190 1.1 christos <a href="docprocessing.html#DOCTYPE">CHAPTER</a>, 3191 1.1 christos the centre part of the 3192 1.1 christos <a href="definitions.html#TERMS_HEADER">header</a> 3193 1.1 christos (or footer), which, by default, contains a chapter number or title, is 3194 1.1 christos removed. 3195 1.1 christos <p> 3196 1.1 christos By default, <strong>mom</strong> starts the endnotes page with a 3197 1.1 christos bold, centred, double-underscored head, "ENDNOTES". 3198 1.1 christos Underneath--flush left, bold, and underscored--she prints the document 3199 1.1 christos title (or, in the case of chapters, the chapter number or title). She 3200 1.1 christos then prints the endnotes. Each endnote is identified by its appropriate 3201 1.1 christos number, in bold, right aligned to two placeholders. The text of the 3202 1.1 christos endnotes themselves is indented to the right of the numbers. 3203 1.1 christos <p> 3204 1.1 christos If the endnotes are grouped together at the end of a collated document, 3205 1.1 christos each section of the document that contains endnotes is identified by its 3206 1.1 christos own unique title (or chapter number or title), bold, flush left, and 3207 1.1 christos underscored. 3208 1.1 christos <p> 3209 1.1 christos Of course, all the defaults, as well as the overall style of the 3210 1.1 christos endnotes page, can be changed with the 3211 1.1 christos <a href="#ENDNOTE_CONTROL">endnote control macros</a>. 3212 1.1 christos The attentive will notice that endnotes have an awful lot of control 3213 1.1 christos macros. This is because endnotes are like a mini-document unto 3214 1.1 christos themselves, and therefore need not be bound by the style parameters of 3215 1.1 christos the body of the document. 3216 1.1 christos <p> 3217 1.1 christos 3218 1.1 christos <a name="ENDNOTE_SPACING"> 3219 1.1 christos <h3><u>A Note on Endnote Spacing</u></h3> 3220 1.1 christos </a> 3221 1.1 christos <br> 3222 1.1 christos On the endnotes page(s), each new endnote is separated from the 3223 1.1 christos previous endnote by a full line space. This can result in a bottom 3224 1.1 christos margin that hangs, and is the one instance, other than the use of 3225 1.1 christos <a href="#PP_SPACE">PARA_SPACE</a>, 3226 1.1 christos where <strong>mom</strong> allows unequal bottom alignment of pages. 3227 1.1 christos Should you wish to correct this, by adding or subtracting small amounts 3228 1.1 christos of space between endnotes that appear together on an endnotes page, make 3229 1.1 christos the adjustment (with 3230 1.1 christos <a href="typesetting.html#ALD">ALD</a>, 3231 1.1 christos <a href="typesetting.html#RLD">RLD</a> 3232 1.1 christos or 3233 1.1 christos <a href="typesetting.html#SPACE">SPACE</a>) 3234 1.1 christos <em>at the end of each endnote</em> (i.e. just before invoking 3235 1.1 christos <a href="#ENDNOTE">ENDNOTE OFF</a>) 3236 1.1 christos rather than at the top. 3237 1.1 christos <p> 3238 1.1 christos 3239 1.1 christos <a name="ENDNOTE_COLUMNS"> 3240 1.1 christos <h3><u>Endnotes and columnar documents</u></h3> 3241 1.1 christos </a> 3242 1.1 christos <br> 3243 1.1 christos Formerly (pre 1.1.6), there was no way to set a document in columns 3244 1.1 christos (see 3245 1.1 christos <a href="docprocessing.html#COLUMNS">COLUMNS</a>) 3246 1.1 christos and then turn off column mode for endnotes. As of version 1.1.6, 3247 1.1 christos you may now do so. See 3248 1.1 christos <a href="#ENDNOTES_NO_COLUMNS">ENDNOTES_NO_COLUMNS</a>. 3249 1.1 christos <p> 3250 1.1 christos <hr> 3251 1.1 christos 3252 1.1 christos <!---ENDNOTE---> 3253 1.1 christos 3254 1.1 christos <p> 3255 1.1 christos <a name="ENDNOTE"> 3256 1.1 christos <nobr>Macro: <strong>ENDNOTE</strong> <toggle></nobr> 3257 1.1 christos <br> 3258 1.1 christos <em>*See <a href="#ENDNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!</em> 3259 1.1 christos </a> 3260 1.1 christos 3261 1.1 christos <p> 3262 1.1 christos <strong>ENDNOTE</strong> is a toggle macro, therefore invoking it 3263 1.1 christos on a line by itself allows you to enter an endnote in the body of a 3264 1.1 christos document. Invoking it with any other argument 3265 1.1 christos (i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong> 3266 1.1 christos that you've finished the endnote. 3267 1.1 christos <p> 3268 1.1 christos <strong>NOTE:</strong> If an endnote runs to more than one paragraph, 3269 1.1 christos <strong>DO NOT</strong> begin the endnote with the 3270 1.1 christos <a href="#PP">PP</a> 3271 1.1 christos tag. Use <strong>PP</strong> only to introduce subsequent paragraphs. 3272 1.1 christos <p> 3273 1.1 christos <a name="ENDNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a> 3274 1.1 christos If your 3275 1.1 christos <a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a> 3276 1.1 christos is <strong>NUMBER</strong> (<strong>mom</strong>'s default), the 3277 1.1 christos final word on the 3278 1.1 christos <a href="definitions.html#TERMS_INPUTLINE">input line</a> 3279 1.1 christos that comes immediately before <strong>ENDNOTE</strong> MUST terminate 3280 1.1 christos with a 3281 1.1 christos <a href="typesetting.html#JOIN">\c</a> 3282 1.1 christos inline escape. See the 3283 1.1 christos <a href="#ENDNOTE_EXAMPLE">endnote example</a> 3284 1.1 christos above. 3285 1.1 christos <p> 3286 1.1 christos Additionally, the line <em>after</em> 3287 1.1 christos <strong>.ENDNOTE OFF</strong> should be entered as if there 3288 1.1 christos were no interruption in the input text, i.e. the line should begin 3289 1.1 christos with a literal space or punctuation mark. See the two 3290 1.1 christos <a href="#EN_PUNCT">examples</a>, 3291 1.1 christos above. 3292 1.1 christos <p> 3293 1.1 christos If your <strong>ENDNOTE_MARKER_STYLE</strong> is 3294 1.1 christos <strong>LINE</strong>, do NOT use the <strong>\c</strong> escape, 3295 1.1 christos and enter the line after <strong>.ENDNOTE OFF</strong> 3296 1.1 christos normally. 3297 1.1 christos <p> 3298 1.1 christos 3299 1.1 christos <!---ENDNOTES---> 3300 1.1 christos 3301 1.1 christos <hr width="66%" align="left"> 3302 1.1 christos <p> 3303 1.1 christos <a name="ENDNOTES">Tag: <strong>ENDNOTES</strong></a> 3304 1.1 christos 3305 1.1 christos <p> 3306 1.1 christos Unlike footnotes, which <strong>mom</strong> automatically outputs at the 3307 1.1 christos bottom of pages, endnotes must be explicitly output by you, the user. 3308 1.1 christos <strong>ENDNOTES</strong>, by itself (i.e. without any argument), is 3309 1.1 christos the macro to do this. 3310 1.1 christos <p> 3311 1.1 christos Typically, you'll use <strong>ENDNOTES</strong> at the end of 3312 1.1 christos a document. If it's a single (i.e. not collated) document, 3313 1.1 christos <strong>mom</strong> will print the endnotes pertaining to it. If it's 3314 1.1 christos a collated document, <strong>mom</strong> will print all the endnotes 3315 1.1 christos contained within all sections of the document (typically chapters), 3316 1.1 christos appropriately identified and numbered. 3317 1.1 christos <p> 3318 1.1 christos Should you wish to output the endnotes for each section of a collated 3319 1.1 christos document at the ends of the sections (instead of at the very end of the 3320 1.1 christos document), simply invoke <strong>ENDNOTES</strong> immediately prior to 3321 1.1 christos <a href="rectoverso.html#COLLATE">COLLATE</a>. 3322 1.1 christos <strong>Mom</strong> will print the endnotes, identified and numbered 3323 1.1 christos appropriately, on a separate page prior to starting the next section of 3324 1.1 christos the document. Each subsequent invocation of <strong>ENDNOTES</strong> 3325 1.1 christos outputs only those endnotes that <strong>mom</strong> collected 3326 1.1 christos after the previous invocation. 3327 1.1 christos <p> 3328 1.1 christos <hr width="66%" align="left"> 3329 1.1 christos 3330 1.1 christos <a name="ENDNOTE_CONTROL"><h3><u>Endnote control macros</u></h3></a> 3331 1.1 christos <p> 3332 1.1 christos <strong>VERY IMPORTANT NOTE!</strong> 3333 1.1 christos <br> 3334 1.1 christos Endnote control macros must always be invoked prior to the first 3335 1.1 christos instance of 3336 1.1 christos <a href="#ENDNOTE">ENDNOTE/ENDNOTE OFF</a>. 3337 1.1 christos <p> 3338 1.1 christos When you embed endnotes in the body of a document, 3339 1.1 christos <strong>mom</strong> collects <em>and processes</em> them for later 3340 1.1 christos outputting (when you invoke 3341 1.1 christos <a href="#ENDNOTES">ENDNOTES</a>). 3342 1.1 christos By the time you do invoke <strong>ENDNOTES</strong>, it's much too 3343 1.1 christos late to change your mind about how you want them to look. 3344 1.1 christos <p> 3345 1.1 christos My advice? If you're planning to change the default appearance of 3346 1.1 christos endnotes pages, set them up prior to 3347 1.1 christos <a href="docprocessing.html#START">START</a>. 3348 1.1 christos <p> 3349 1.1 christos <ol> 3350 1.1 christos <li><a href="#ENDNOTES_GENERAL"><strong>General endnotes-pages style control</strong></a> 3351 1.1 christos <ul> 3352 1.1 christos <li><a href="#ENDNOTE_STYLE">Base family/font/quad for endnotes-pages</a> 3353 1.1 christos <li><a href="#ENDNOTE_PT_SIZE">Base point size for the endnotes-pages</a> 3354 1.1 christos <li><a href="#ENDNOTE_LEAD">Leading of endnotes-pages</a> 3355 1.1 christos <li><a href="#SINGLESPACE_ENDNOTES">Singlespace endnotes (for TYPEWRITE only)</a> 3356 1.1 christos <li><a href="#ENDNOTE_PARA_INDENT">Size of paragraph first line indent in multi-paragraph endnotes</a> 3357 1.1 christos <li><a href="#ENDNOTE_PARA_SPACE">Inserting space between paragraphs of multi-paragraph endnotes</a> 3358 1.1 christos <li><a href="#ENDNOTES_NO_COLUMNS">Turning off column mode during endnotes output</a> 3359 1.1 christos <li>Pagination of endnotes: 3360 1.1 christos <ul> 3361 1.1 christos <li><a href="#ENDNOTES_PAGENUM_STYLE">Endnotes-pages page numbering style</a> 3362 1.1 christos <li><a href="#ENDNOTES_FIRST_PAGENUMBER">Setting the first page number of endnotes pages</a> 3363 1.1 christos <li><a href="#ENDNOTES_NO_FIRST_PAGENUM">Omitting a page number on the first page of endnotes</a> 3364 1.1 christos </ul> 3365 1.1 christos <li><a href="#SUSPEND_PAGINATION">Suspending pagination of endnotes pages</a> 3366 1.1 christos </ul> 3367 1.1 christos <li><a href="#ENDNOTES_HEADER_CONTROL"><strong>Endnotes-page header/footer control</strong></a> 3368 1.1 christos <ul> 3369 1.1 christos <li><a href="#ENDNOTES_MODIFY_HDRFTR">Modifying what goes in the endnotes-pages header/footer</a> 3370 1.1 christos <li><a href="#ENDNOTES_HDRFTR_CENTER">Enabling a header/footer centre when doctype is CHAPTER</a> 3371 1.1 christos <li><a href="#ENDNOTES_ALLOWS_HEADERS">Allow headers on endnotes-pages</a> 3372 1.1 christos </ul> 3373 1.1 christos <li><a href="#ENDNOTES_MAIN_TITLE"><strong>Endnotes-page head (i.e. the title at the top) control</strong></a> 3374 1.1 christos <ul> 3375 1.1 christos <li><a href="#ENDNOTE_STRING">Creating/modifying the endnotes-page head</a> 3376 1.1 christos <li><a href="#ENDNOTE_STRING_CONTROL">Endnotes-page head control</a> 3377 1.1 christos <li><a href="#ENDNOTE_STRING_UNDERSCORE">Endnotes-page head underscoring</a> 3378 1.1 christos <li><a href="#ENDNOTE_STRING_CAPS">Endnotes-page head capitalization</a> 3379 1.1 christos </ul> 3380 1.1 christos <li><a href="#ENDNOTES_DOC_TITLE"><strong>Endnote document-identification title</strong></a> 3381 1.1 christos <ul> 3382 1.1 christos <li><a href="#ENDNOTE_TITLE">Creating/modifying the endnote document-identification title</a> 3383 1.1 christos <li><a href="#ENDNOTE_TITLE_CONTROL">Document-identification title control</a> 3384 1.1 christos <li><a href="#ENDNOTE_TITLE_UNDERSCORE">Document-identification title underscoring</a> 3385 1.1 christos </ul> 3386 1.1 christos <li><a href="#ENDNOTES_NUMBERING"><strong>Endnotes-pages endnote numbering style</strong></a> 3387 1.1 christos <ul> 3388 1.1 christos <li><a href="#ENDNOTE_MARKER_STYLE">Endnote marker style</a>--by numbers in the text, or by line number 3389 1.1 christos <ul> 3390 1.1 christos <li><a href="#ENDNOTE_LINENUMBER_GAP">ENDNOTE_LINENUMBER_GAP</a> 3391 1.1 christos <li><a href="#ENDNOTE_LINENUMBER_BRACKETS">ENDNOTE_LINENUMBER_BRACKETS</a> 3392 1.1 christos <li><a href="#ENDNOTE_LINENUMBER_SEPARATOR">ENDNOTE_LINENUMBER_SEPARATOR</a> 3393 1.1 christos </ul> 3394 1.1 christos <li><a href="#ENDNOTE_NUMBER_CONTROL">Endnotes-pages endnote numbering style control</a> 3395 1.1 christos <li><a href="#ENDNOTE_NUMBER_ALIGNMENT">Endnote numbering alignment</a> 3396 1.1 christos <ul> 3397 1.1 christos <li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT">ENDNOTE_NUMBERS_ALIGN_RIGHT</a> 3398 1.1 christos <li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT">ENDNOTE_NUMBERS_ALIGN_LEFT</a> 3399 1.1 christos </ul> 3400 1.1 christos </ul> 3401 1.1 christos </ol> 3402 1.1 christos <hr> 3403 1.1 christos 3404 1.1 christos <a name="ENDNOTES_GENERAL"><h2><u>1. General endnotes page style control</u></h2> 3405 1.1 christos 3406 1.1 christos <a name="ENDNOTE_STYLE"><h3><u>*Endnote family/font/quad</u></h3></a> 3407 1.1 christos <p> 3408 1.1 christos See 3409 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 3410 1.1 christos <p> 3411 1.1 christos <pre> 3412 1.1 christos .ENDNOTE_FAMILY default = prevailing document family; default is Times Roman 3413 1.1 christos .ENDNOTE_FONT default = roman 3414 1.1 christos .ENDNOTE_QUAD* default = justified 3415 1.1 christos 3416 1.1 christos *Note: ENDNOTE_QUAD must be set to either L or J 3417 1.1 christos </pre> 3418 1.1 christos 3419 1.1 christos <!---ENDNOTE_PT_SIZE---> 3420 1.1 christos 3421 1.1 christos <a name="ENDNOTE_PT_SIZE"><h3><u>*Endnote point size</u></h3></a> 3422 1.1 christos <p> 3423 1.1 christos <nobr>Macro: <strong>ENDNOTE_PT_SIZE</strong> <base type size of endnotes></nobr> 3424 1.1 christos 3425 1.1 christos <p> 3426 1.1 christos Unlike most other control macros that deal with size of document 3427 1.1 christos elements, <strong>ENDNOTE_PT_SIZE</strong> takes as its argument an 3428 1.1 christos absolute value, relative to nothing. Therefore, the argument represents 3429 1.1 christos the size of endnote type in 3430 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a>, 3431 1.1 christos unless you append an alternative 3432 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 3433 1.1 christos For example, 3434 1.1 christos <p> 3435 1.1 christos <pre> 3436 1.1 christos .ENDNOTE_PT_SIZE 12 3437 1.1 christos </pre> 3438 1.1 christos 3439 1.1 christos sets the base point size of type on the endnotes page to 12 3440 1.1 christos points, whereas 3441 1.1 christos <p> 3442 1.1 christos <pre> 3443 1.1 christos .ENDNOTE_PT_SIZE .6i 3444 1.1 christos </pre> 3445 1.1 christos 3446 1.1 christos sets the base point size of type on the endnotes page to 1/6 of an 3447 1.1 christos inch. 3448 1.1 christos <p> 3449 1.1 christos The type size set with <strong>ENDNOTE_PT_SIZE</strong> is the size of 3450 1.1 christos type used for the text of the endnotes, and forms the basis from which 3451 1.1 christos the point size of other endnote page elements is calculated. 3452 1.1 christos <p> 3453 1.1 christos The default for 3454 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a> 3455 1.1 christos is 12.5 points (the same default size used in the body of the document). 3456 1.1 christos <p> 3457 1.1 christos 3458 1.1 christos <!---ENDNOTE_LEAD---> 3459 1.1 christos 3460 1.1 christos <a name="ENDNOTE_LEAD"><h3><u>*Endnote lead</u></h3></a> 3461 1.1 christos <p> 3462 1.1 christos <nobr>Macro: <strong>ENDNOTE_LEAD</strong> <base leading of endnotes> [ ADJUST ] </nobr> 3463 1.1 christos <br> 3464 1.1 christos <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em> 3465 1.1 christos 3466 1.1 christos <p> 3467 1.1 christos Unlike most other control macros that deal with leading of document 3468 1.1 christos elements, <strong>ENDNOTE_LEAD</strong> takes as its argument an 3469 1.1 christos absolute value, relative to nothing. Therefore, the argument represents 3470 1.1 christos the 3471 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a> 3472 1.1 christos of endnotes in 3473 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a> 3474 1.1 christos unless you append an alternative 3475 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 3476 1.1 christos For example, 3477 1.1 christos <p> 3478 1.1 christos <pre> 3479 1.1 christos .ENDNOTE_LEAD 14 3480 1.1 christos </pre> 3481 1.1 christos 3482 1.1 christos sets the base leading of type on the endnotes page to 14 3483 1.1 christos points, whereas 3484 1.1 christos <p> 3485 1.1 christos <pre> 3486 1.1 christos .ENDNOTE_LEAD .5i 3487 1.1 christos </pre> 3488 1.1 christos 3489 1.1 christos sets the base leading of type on the endnotes page to 1/2 inch. 3490 1.1 christos <p> 3491 1.1 christos If you want the leading of endnotes adjusted to fill the page, pass 3492 1.1 christos <strong>ENDNOTE_LEAD</strong> the optional argument 3493 1.1 christos <strong>ADJUST</strong>. (See 3494 1.1 christos <a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> 3495 1.1 christos for an explanation of leading adjustment.) 3496 1.1 christos <p> 3497 1.1 christos The default for 3498 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a> 3499 1.1 christos is 14 points, adjusted. 3500 1.1 christos <p> 3501 1.1 christos <strong>NOTE:</strong> Even if you give <strong>mom</strong> a 3502 1.1 christos <strong>DOC_LEAD_ADJUST OFF</strong> command, she will still, by 3503 1.1 christos default, adjust endnote leading. You MUST enter 3504 1.1 christos <strong>ENDNOTE_LEAD <lead></strong> with no 3505 1.1 christos <strong>ADJUST</strong> argument to disable this default behaviour. 3506 1.1 christos <p> 3507 1.1 christos 3508 1.1 christos <!---SINGLESPACE_ENDNOTES---> 3509 1.1 christos 3510 1.1 christos <a name="SINGLESPACE_ENDNOTES"><h3><u>*Singlespace endnotes (TYPEWRITE only)</u></h3></a> 3511 1.1 christos <p> 3512 1.1 christos <nobr>Macro: <strong>SINGLESPACE_ENDNOTES</strong> <toggle></nobr> 3513 1.1 christos 3514 1.1 christos <p> 3515 1.1 christos If your 3516 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a> 3517 1.1 christos is <strong>TYPEWRITE</strong> and you use TYPEWRITE's default 3518 1.1 christos double-spacing, endnotes are double-spaced. If your document is 3519 1.1 christos single-spaced, endnotes are single-spaced. 3520 1.1 christos <p> 3521 1.1 christos If, for some reason, you'd prefer that endnotes be single-spaced 3522 1.1 christos in an otherwise double-spaced document (including double-spaced 3523 1.1 christos <a href="rectoverso.html#COLLATE">collated</a> 3524 1.1 christos documents), invoke <strong>SINGLESPACE_ENDNOTES</strong> with 3525 1.1 christos no argument. And if, god help you, you want to change endnote 3526 1.1 christos single-spacing back to double-spacing for different spacing of 3527 1.1 christos endnotes output at the ends of separate documents in a collated 3528 1.1 christos document, invoke <strong>SINGLESPACE_ENDNOTES</strong> with any 3529 1.1 christos argument (<strong>OFF, QUIT, Q, X</strong>...). 3530 1.1 christos <p> 3531 1.1 christos 3532 1.1 christos <!---ENDNOTE_PARA_INDENT---> 3533 1.1 christos 3534 1.1 christos <a name="ENDNOTE_PARA_INDENT"><h3><u>*Endnote paragraph indenting</u></h3></a> 3535 1.1 christos <p> 3536 1.1 christos <nobr>Macro: <strong>ENDNOTE_PARA_INDENT</strong> <amount to indent first line of paragraphs in endnotes></nobr> 3537 1.1 christos <br> 3538 1.1 christos <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em> 3539 1.1 christos 3540 1.1 christos <p> 3541 1.1 christos <strong>ENDNOTE_PARA_INDENT</strong> works exactly the same way as 3542 1.1 christos <a href="#PARA_INDENT">PARA_INDENT</a>, 3543 1.1 christos except that the indent given is the amount by which to indent the first 3544 1.1 christos lines of endnote paragraphs, not document body paragraphs. 3545 1.1 christos <p> 3546 1.1 christos The default is 1.5 3547 1.1 christos <a href="definitions.html#TERMS_EM">ems</a> 3548 1.1 christos for 3549 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>; 3550 1.1 christos 1/2 inch for 3551 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>. 3552 1.1 christos 3553 1.1 christos <p> 3554 1.1 christos <strong>NOTE:</strong> The first line of the first paragraph of endnotes 3555 1.1 christos (the one attached immediately to the identifying endnote number) is 3556 1.1 christos never indented. Only subsequent paragraphs are affected by 3557 1.1 christos <strong>ENDNOTE_PARA_INDENT</strong>. 3558 1.1 christos <p> 3559 1.1 christos 3560 1.1 christos <!---ENDNOTE_PARA_SPACE---> 3561 1.1 christos 3562 1.1 christos <a name="ENDNOTE_PARA_SPACE"><h3><u>*Endnote paragraph spacing</u></h3></a> 3563 1.1 christos <p> 3564 1.1 christos <nobr>Macro: <strong>ENDNOTE_PARA_SPACE</strong> <toggle></nobr> 3565 1.1 christos 3566 1.1 christos <p> 3567 1.1 christos <strong>ENDNOTE_PARA_SPACE</strong> works exactly the same way as 3568 1.1 christos <a href="#PP_SPACE">PARA_SPACE</a>, 3569 1.1 christos except that it inserts a blank line between endnote paragraphs, not 3570 1.1 christos document body paragraphs. 3571 1.1 christos <p> 3572 1.1 christos The default is not to insert a blank line between paragraphs in 3573 1.1 christos endnotes. 3574 1.1 christos <p> 3575 1.1 christos <strong>NOTE:</strong> Each endnote itself is always separated from any 3576 1.1 christos previous endnote by a line space. <strong>ENDNOTE_PARA_SPACE</strong> 3577 1.1 christos refers only to paragraphs that appear within each discrete endnote. 3578 1.1 christos <p> 3579 1.1 christos 3580 1.1 christos <!---ENDNOTES_NO_COLUMNS---> 3581 1.1 christos 3582 1.1 christos <a name="ENDNOTES_NO_COLUMNS"><h3><u>*Turning off column mode during endnotes output</u></h3></a> 3583 1.1 christos <p> 3584 1.1 christos <nobr>Macro: <strong>ENDNOTES_NO_COLUMNS</strong> <toggle></nobr> 3585 1.1 christos 3586 1.1 christos <p> 3587 1.1 christos By default, if your document is 3588 1.1 christos <a href="columns.html#COLUMNS">set in columns</a>, 3589 1.1 christos <strong>mom</strong> sets the endnotes in columns, too. However, 3590 1.1 christos if your document is set in columns and you'd like the endnotes not 3591 1.1 christos to be, just invoke <strong>ENDNOTES_NO_COLUMNS</strong> with no 3592 1.1 christos argument. The endnotes pages will be set to the full page measure 3593 1.1 christos of your document. 3594 1.1 christos <p> 3595 1.1 christos If you output endnotes at the end of each document in a 3596 1.1 christos <a href="rectoverso.html#COLLATE">collated</a> 3597 1.1 christos document set in columns, column mode will automatically 3598 1.1 christos be reinstated for each document, even with 3599 1.1 christos <strong>ENDNOTES_NO_COLUMNS</strong> turned on. 3600 1.1 christos <p> 3601 1.1 christos 3602 1.1 christos <!---ENDNOTES_PAGENUM_STYLE---> 3603 1.1 christos 3604 1.1 christos <a name="ENDNOTES_PAGENUM_STYLE"><h3><u>*Endnotes-pages page numbering style</u></h3></a> 3605 1.1 christos <p> 3606 1.1 christos <nobr>Macro: <strong>ENDNOTES_PAGENUM_STYLE</strong> DIGIT | ROMAN | roman | ALPHA | alpha</nobr> 3607 1.1 christos 3608 1.1 christos <p> 3609 1.1 christos Use this macro to set the page numbering style of endnotes pages. 3610 1.1 christos The arguments are identical to those for 3611 1.1 christos <a href="headfootpage.html#PAGENUM_STYLE">PAGENUM_STYLE</a>. 3612 1.1 christos The default is <strong>digit</strong>. You may want to change it 3613 1.1 christos to, say, <strong>alpha</strong>, which you would do with 3614 1.1 christos <p> 3615 1.1 christos <pre> 3616 1.1 christos .ENDNOTES_PAGENUM_STYLE alpha 3617 1.1 christos </pre> 3618 1.1 christos 3619 1.1 christos <!---ENDNOTES_FIRST_PAGENUMBER---> 3620 1.1 christos 3621 1.1 christos <a name="ENDNOTES_FIRST_PAGENUMBER"><h3><u>*Setting the first page number of endnotes pages</u></h3></a> 3622 1.1 christos <p> 3623 1.1 christos <nobr>Macro: <strong>ENDNOTES_FIRST_PAGENUMBER</strong> <page # that appears on page 1 of endnotes></nobr> 3624 1.1 christos 3625 1.1 christos <p> 3626 1.1 christos Use this macro with caution. If all endnotes for several 3627 1.1 christos <a href="rectoverso.html#COLLATE">collated</a> 3628 1.1 christos documents are to be output at once, i.e. not at the end of each 3629 1.1 christos separate doc, <strong>ENDNOTES_FIRST_PAGENUMBER</strong> tells 3630 1.1 christos <strong>mom</strong> what page number to put on the first page of 3631 1.1 christos the endnotes. 3632 1.1 christos <p> 3633 1.1 christos If you set <strong>ENDNOTES_FIRST_PAGENUMBER</strong> in collated 3634 1.1 christos documents where the endnotes are output after each separate doc, 3635 1.1 christos you have to reset every separate document's first page number after 3636 1.1 christos <a href="rectoverso.html#COLLATE">COLLATE</a> 3637 1.1 christos and before 3638 1.1 christos <a href="docprocessing.html#START">START</a>. 3639 1.1 christos <p> 3640 1.1 christos 3641 1.1 christos <!---ENDNOTES_NO_FIRST_PAGENUN---> 3642 1.1 christos 3643 1.1 christos <a name="ENDNOTES_NO_FIRST_PAGENUM"><h3><u>*Omitting a page number on the first page of endnotes</u></h3></a> 3644 1.1 christos <p> 3645 1.1 christos <nobr>Macro: <strong>ENDNOTES_NO_FIRST_PAGENUM</strong> <toggle></nobr> 3646 1.1 christos 3647 1.1 christos <p> 3648 1.1 christos This macro is for use only if <strong>FOOTERS</strong> are on. It 3649 1.1 christos tells 3650 1.1 christos <a href="#ENDNOTES">ENDNOTES</a> 3651 1.1 christos not to print a page number on the first endnotes page. 3652 1.1 christos <strong>Mom</strong>'s default is to print the page number. 3653 1.1 christos <p> 3654 1.1 christos 3655 1.1 christos <!---SUSPEND_PAGINATION---> 3656 1.1 christos 3657 1.1 christos <a name="SUSPEND_PAGINATION"><h3><u>*Suspending pagination of endnotes pages</u></h3></a> 3658 1.1 christos <p> 3659 1.1 christos Macro: <strong>SUSPEND_PAGINATION</strong> 3660 1.1 christos <br> 3661 1.1 christos Macro: <strong>RESTORE_PAGINATION</strong> 3662 1.1 christos 3663 1.1 christos <p> 3664 1.1 christos <strong>SUSPEND_PAGINATION</strong> doesn't take an argument. 3665 1.1 christos Invoked immediately prior to 3666 1.1 christos <a href="#ENDNOTES">ENDNOTES</a>, 3667 1.1 christos it turns off endnotes pages pagination. <strong>Mom</strong> 3668 1.1 christos continues, however to increment page numbers silently. 3669 1.1 christos <p> 3670 1.1 christos To restore normal document pagination after endnotes, invoke 3671 1.1 christos <strong>RESTORE_PAGINATION</strong> (again, with no argument) 3672 1.1 christos immediately after <strong>ENDNOTES</strong>. 3673 1.1 christos 3674 1.1 christos <a name="ENDNOTES_HEADER_CONTROL"><h2><u>2. Endnotes-page header/footer control</u></h2></a> 3675 1.1 christos <p> 3676 1.1 christos <a name="ENDNOTES_MODIFY_HDRFTR"></a> 3677 1.1 christos If you wish to modify what appears in the header/footer that appears 3678 1.1 christos on endnotes page(s), make the changes before you invoke 3679 1.1 christos <a href="#ENDNOTES">ENDNOTES</a>, 3680 1.1 christos not afterwards. 3681 1.1 christos <p> 3682 1.1 christos Except in the case of 3683 1.1 christos <a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a>, 3684 1.1 christos <strong>mom</strong> prints the same header or footer used throughout 3685 1.1 christos the document on the endnotes page(s). Chapters get treated differently 3686 1.1 christos in that, by default, <strong>mom</strong> does not print the 3687 1.1 christos header/footer centre string (normally the chapter number or chapter 3688 1.1 christos title.) In most cases, this is what you want. However, should you 3689 1.1 christos <em>not</em> want <strong>mom</strong> to remove the centre string from 3690 1.1 christos the endnotes page(s) headers/footers, invoke 3691 1.1 christos <a href="#ENDNOTES_HDRFTR_CENTER">ENDNOTES_HEADER_CENTER</a> 3692 1.1 christos with no argument. 3693 1.1 christos <p> 3694 1.1 christos An important change you may want to make is to put the word 3695 1.1 christos "Endnotes" in the header/footer centre position. 3696 1.1 christos To do so, do 3697 1.1 christos <p> 3698 1.1 christos <pre> 3699 1.1 christos .HEADER_CENTER "Endnotes" 3700 1.1 christos or 3701 1.1 christos .FOOTER_CENTER "Endnotes" 3702 1.1 christos </pre> 3703 1.1 christos 3704 1.1 christos prior to invoking <strong>.ENDNOTES</strong>. If your 3705 1.1 christos <a href="docprocessing.html#DOCTYPE">DOCTYPE</a> 3706 1.1 christos is <kbd>CHAPTER</kbd>, you must also invoke 3707 1.1 christos <a href="#ENDNOTES_HDRFTR_CENTER">ENDNOTES_HEADER_CENTER</a> 3708 1.1 christos for the <strong>HEADER_CENTER</strong> to appear. 3709 1.1 christos <p> 3710 1.1 christos 3711 1.1 christos <a name="ENDNOTES_HDRFTR_CENTER"><h3><u>*Endnotes page(s) header/footer centre string</u></h3></a> 3712 1.1 christos <p> 3713 1.1 christos <nobr>Macro: <strong>ENDNOTES_HEADER_CENTER</strong> toggle</nobr> 3714 1.1 christos 3715 1.1 christos <p> 3716 1.1 christos If your 3717 1.1 christos <a href="docprocessing.html#DOCTYPE">DOCTYPE</a> 3718 1.1 christos is <kbd>CHAPTER</kbd> and you want <strong>mom</strong> to include 3719 1.1 christos a centre string in the headers/footers that appear on endnotes pages, 3720 1.1 christos invoke <strong>ENDNOTES_HEADER_CENTER</strong> (or 3721 1.1 christos <strong>ENDNOTES_FOOTER_CENTER</strong>) with no argument. 3722 1.1 christos <strong>Mom</strong>'s default is NOT to print the centre string. 3723 1.1 christos <p> 3724 1.1 christos If, for some reason, having enabled the header/footer centre string 3725 1.1 christos on endnotes pages, you wish to disable it, invoke the same macro 3726 1.1 christos with any argument (<strong>OFF, QUIT, Q, X</strong>...). 3727 1.1 christos <p> 3728 1.1 christos 3729 1.1 christos <a name="ENDNOTES_ALLOWS_HEADERS"><h3><u>*Allow headers on endnotes-pages</u></h3></a> 3730 1.1 christos <p> 3731 1.1 christos <nobr>Macro: <strong>ENDNOTES_ALLOWS_HEADERS</strong> <none> | ALL</nobr> 3732 1.1 christos 3733 1.1 christos <p> 3734 1.1 christos By default, if <strong>HEADERS</strong> are on, <strong>mom</strong> 3735 1.1 christos prints page headers on all endnotes pages except the first. If you 3736 1.1 christos don't want her to print headers on endnotes pages, do 3737 1.1 christos <p> 3738 1.1 christos <pre> 3739 1.1 christos .ENDNOTES_ALLOWS_HEADERS OFF 3740 1.1 christos </pre> 3741 1.1 christos 3742 1.1 christos If you want headers on every page <em>including the first</em>, do 3743 1.1 christos <p> 3744 1.1 christos <pre> 3745 1.1 christos .ENDNOTES_ALLOWS_HEADERS ALL 3746 1.1 christos </pre> 3747 1.1 christos 3748 1.1 christos <strong>NOTE:</strong> If <strong>FOOTERS</strong> are on, 3749 1.1 christos <strong>mom</strong> prints footers on every endnotes page. This is 3750 1.1 christos a style convention. In <strong>mom</strong>, there is no such beast 3751 1.1 christos as <strong>ENDNOTES_ALLOWS_FOOTERS OFF</strong>. 3752 1.1 christos <p> 3753 1.1 christos 3754 1.1 christos <a name="ENDNOTES_MAIN_TITLE"><h2><u>3. Endnotes-page first page head (title) control</u></h2> 3755 1.1 christos 3756 1.1 christos <!---ENDNOTE_STRING---> 3757 1.1 christos 3758 1.1 christos <a name="ENDNOTE_STRING"><h3><u>*Endnotes-page first page head (title) string</u></h3></a> 3759 1.1 christos <p> 3760 1.1 christos <nobr>Macro: <strong>ENDNOTE_STRING</strong> "<head to print at the top of endnotes>"</nobr> 3761 1.1 christos 3762 1.1 christos <p> 3763 1.1 christos By default, <strong>mom</strong> prints the word "ENDNOTES" 3764 1.1 christos as a head at the top of the first page of endnotes. If you want her 3765 1.1 christos to print something else, invoke <strong>ENDNOTE_STRING</strong> with 3766 1.1 christos the endnotes-page head you want, surrounded by double-quotes. If 3767 1.1 christos you don't want a head at the top of the first endnotes-page, invoke 3768 1.1 christos <strong>ENDNOTE_STRING</strong> with a blank argument (either two 3769 1.1 christos double-quotes side by side -- <kbd>""</kbd> -- or no argument 3770 1.1 christos at all). 3771 1.1 christos <p> 3772 1.1 christos 3773 1.1 christos <!---ENDNOTE_STRING_CONTROL---> 3774 1.1 christos 3775 1.1 christos <a name="ENDNOTE_STRING_CONTROL"><h3><u>*Endnotes-page first page head (title) control</u></h3></a> 3776 1.1 christos <p> 3777 1.1 christos See 3778 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 3779 1.1 christos <p> 3780 1.1 christos <pre> 3781 1.1 christos .ENDNOTE_STRING_FAMILY default = prevailing document family; default is Times Roman 3782 1.1 christos .ENDNOTE_STRING_FONT default = bold 3783 1.1 christos .ENDNOTE_STRING_SIZE* default = +1 3784 1.1 christos .ENDNOTE_STRING_QUAD default = centred 3785 1.1 christos 3786 1.1 christos *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE) 3787 1.1 christos </pre> 3788 1.1 christos 3789 1.1 christos <!---ENDNOTE_STRING_UNDERSCORE---> 3790 1.1 christos 3791 1.1 christos <a name="ENDNOTE_STRING_UNDERSCORE"><h3><u>*Endnotes-page head (title) underscoring</h3></u></a> 3792 1.1 christos <p> 3793 1.1 christos <nobr>Macro: <strong>ENDNOTE_STRING_UNDERSCORE</strong> toggle | 2</nobr> 3794 1.1 christos 3795 1.1 christos <p> 3796 1.1 christos Invoked by itself, <strong>ENDNOTE_STRING_UNDERSCORE</strong> will 3797 1.1 christos underscore the endnotes-page head. Invoked with the argument 2 3798 1.1 christos (i.e. the digit 2), <strong>ENDNOTE_STRING_UNDERSCORE</strong> will 3799 1.1 christos double-underscore the head. Invoked with any other argument, the macro 3800 1.1 christos disables underscoring of the head. 3801 1.1 christos <p> 3802 1.1 christos <strong>Mom</strong>'s default is to double-underscore the 3803 1.1 christos head, therefore if you want no underscoring, you must insert 3804 1.1 christos <kbd>.ENDNOTE_STRING_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO, 3805 1.1 christos NONE,</kbd> etc.) into your document prior to outputting endnotes with 3806 1.1 christos <a href="#ENDNOTES">ENDNOTES</a>. 3807 1.1 christos 3808 1.1 christos <!---ENDNOTE_STRING_CAPS---> 3809 1.1 christos 3810 1.1 christos <a name="ENDNOTE_STRING_CAPS"><h3><u>*Endnotes-page head (title) automatic capitalization</h3></u></a> 3811 1.1 christos <p> 3812 1.1 christos <nobr>Macro: <strong>ENDNOTE_STRING_CAPS</strong> toggle</nobr> 3813 1.1 christos 3814 1.1 christos <p> 3815 1.1 christos Invoked by itself, <strong>ENDNOTE_STRING_CAPS</strong> will 3816 1.1 christos automatically capitalize the endnotes-page head. Invoked with any 3817 1.1 christos other argument, the macro disables automatic capitalization of the 3818 1.1 christos head. 3819 1.1 christos <p> 3820 1.1 christos If you're generating a table of contents, you may want the 3821 1.1 christos endnotes-pages head string in caps, but the toc entry in caps/lower 3822 1.1 christos case. If the argument to 3823 1.1 christos <a href="#ENDNOTE_STRING">ENDNOTE_STRING</a> 3824 1.1 christos is in caps/lower case and <strong>ENDNOTE_STRING_CAPS</strong> is 3825 1.1 christos on, this is exactly what will happen. 3826 1.1 christos <p> 3827 1.1 christos <strong>Mom</strong>'s default is to capitalize the endnotes-pages 3828 1.1 christos head string. 3829 1.1 christos <p> 3830 1.1 christos 3831 1.1 christos <!---ENDNOTE_TITLE---> 3832 1.1 christos 3833 1.1 christos <a name="ENDNOTES_DOC_TITLE"><h2><u>4. Endnote document-identification title</u></h2> 3834 1.1 christos <a name="ENDNOTE_TITLE"><h3><u>*Endnote document-identification title string</u></h3></a> 3835 1.1 christos <p> 3836 1.1 christos <nobr>Macro: <strong>ENDNOTE_TITLE</strong> "<title to identify a document in endnotes>"</nobr> 3837 1.1 christos 3838 1.1 christos <p> 3839 1.1 christos By default, <strong>mom</strong> identifies the document(s) to which 3840 1.1 christos endnotes belong by the document title(s) given to the 3841 1.1 christos <a href="docprocessing.html#TITLE">TITLE</a> 3842 1.1 christos macro. If you'd want her to identify the document(s) another way, 3843 1.1 christos just invoke <strong>ENDNOTE_TITLE</strong> with the identifying 3844 1.1 christos title you want, surrounded by double-quotes. 3845 1.1 christos <p> 3846 1.1 christos If you don't want any identifying title, invoke 3847 1.1 christos <strong>ENDNOTE_TITLE</strong> with a blank argument (either two 3848 1.1 christos double-quotes side by side -- <kbd>""</kbd> -- or no 3849 1.1 christos argument at all). This is particularly useful if you have a single 3850 1.1 christos (i.e. non-collated) document and find having the document's title 3851 1.1 christos included in the endnotes redundant. 3852 1.1 christos <p> 3853 1.1 christos 3854 1.1 christos <!---ENDNOTE_TITLE_CONTROL---> 3855 1.1 christos 3856 1.1 christos <a name="ENDNOTE_TITLE_CONTROL"><h3><u>*Endnote document-identification title control</u></h3></a> 3857 1.1 christos <p> 3858 1.1 christos See 3859 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 3860 1.1 christos <p> 3861 1.1 christos <pre> 3862 1.1 christos .ENDNOTE_TITLE_FAMILY default = prevailing document family; default is Times Roman 3863 1.1 christos .ENDNOTE_TITLE_FONT default = bold 3864 1.1 christos .ENDNOTE_TITLE_SIZE* default = 0 3865 1.1 christos .ENDNOTE_TITLE_QUAD default = left 3866 1.1 christos 3867 1.1 christos *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE) 3868 1.1 christos </pre> 3869 1.1 christos 3870 1.1 christos <!---ENDNOTE_TITLE_UNDERSCORE---> 3871 1.1 christos 3872 1.1 christos <a name="ENDNOTE_TITLE_UNDERSCORE"><h3><u>*Endnote document-identification title underscoring</h3></u></a> 3873 1.1 christos <p> 3874 1.1 christos <nobr>Macro: <strong>ENDNOTE_TITLE_UNDERSCORE</strong> toggle</nobr> 3875 1.1 christos 3876 1.1 christos <p> 3877 1.1 christos Invoked by itself, <strong>ENDNOTE_TITLE_UNDERSCORE</strong> will 3878 1.1 christos underscore the endnote document-identification title(s). Invoked with any 3879 1.1 christos other argument, the macro disables underscoring of the title(s). 3880 1.1 christos <p> 3881 1.1 christos <strong>Mom</strong>'s default is to underscore the document-identification title, therefore if you want no underscoring, you must 3882 1.1 christos insert <kbd>.ENDNOTE_TITLE_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO, 3883 1.1 christos NONE,</kbd> etc.) into your document prior to outputting endnotes with 3884 1.1 christos <a href="#ENDNOTES">ENDNOTES</a>. 3885 1.1 christos <p> 3886 1.1 christos 3887 1.1 christos <!---ENDNOTE_NUMBERING---> 3888 1.1 christos 3889 1.1 christos <a name="ENDNOTES_NUMBERING"><h2><u>5. Endnotes-pages endnote numbering style</u></h2> 3890 1.1 christos 3891 1.1 christos <a name="ENDNOTE_MARKER_STYLE"><h3><u>*Endnote marker style</u></h3></a> 3892 1.1 christos <p> 3893 1.1 christos The macro to control how endnotes are referenced is 3894 1.1 christos <strong>ENDNOTE_MARKER_STYLE</strong>. 3895 1.1 christos <p> 3896 1.1 christos By default, <strong>mom</strong> places superscript numbers in 3897 1.1 christos <a href="definitions.html#RUNNING">running text</a> 3898 1.1 christos to identify endnotes. However, if you have 3899 1.1 christos <a href="#NUMBER_LINES">line-numbering</a> 3900 1.1 christos turned on, you may instruct <strong>mom</strong> not to put 3901 1.1 christos superscript numbers in the running text, but rather to reference 3902 1.1 christos endnotes by line number. The command to do this is 3903 1.1 christos <p> 3904 1.1 christos <pre> 3905 1.1 christos .ENDNOTE_MARKER_STYLE LINE 3906 1.1 christos </pre> 3907 1.1 christos 3908 1.1 christos With <strong>ENDNOTE_MARKER_STYLE LINE</strong>, <strong>mom</strong> 3909 1.1 christos will identify endnotes either by single line numbers, or line 3910 1.1 christos ranges. If what you want is a single line number, you need only 3911 1.1 christos invoke <strong>.ENDNOTE</strong>, <em>without terminating the text 3912 1.1 christos line before it with</em> <strong>\c</strong>, at the appropriate 3913 1.1 christos place in running text. (Should you wish to revert to 3914 1.1 christos <strong>mom</strong>'s default behaviour of placing a superscript 3915 1.1 christos number in the text to identify an endnote, you can invoke 3916 1.1 christos <strong>ENDNOTE_MARKER_STYLE</strong> with the argument, 3917 1.1 christos <strong>NUMBER</strong>. It is not advisable to switch marker 3918 1.1 christos styles within a single document, for aesthetic reasons, but there 3919 1.1 christos is nothing to prevent you from doing so.) 3920 1.1 christos <p> 3921 1.1 christos If you want a range of line numbers (e.g. [5-11] ), 3922 1.1 christos insert, directly into the first line of the range you want, the 3923 1.1 christos <a href="definitions.html#TERMS_INLINES">inline escape</a>, 3924 1.1 christos <strong>\*[EN-MARK]</strong>. For the terminating line number of 3925 1.1 christos the range, you need only invoke <strong>.ENDNOTE</strong>, (again, 3926 1.1 christos without attaching <strong>\c</strong> to the text line before it). 3927 1.1 christos <strong>Mom</strong> is smart enough to figure out that where 3928 1.1 christos <strong>ENDNOTE</strong> was invoked represents the terminating 3929 1.1 christos line number. 3930 1.1 christos <a name="ENDNOTE_LINENUMBER_GAP"></a> 3931 1.1 christos <p> 3932 1.1 christos Given the impossibility of knowing, in advance, the "string length" 3933 1.1 christos of all the line numbers or ranges of line numbers that will be used 3934 1.1 christos in endnotes (the string length of 12 is two; the string length 3935 1.1 christos of 12-15 is 5), <strong>mom</strong> cannot "hang" line numbers 3936 1.1 christos and guarantee that they, and the endnote text, will align in a 3937 1.1 christos visually pleasing manner. Consequently, <strong>mom</strong> sets 3938 1.1 christos the entirety of line-numbered endnotes completely flush left, 3939 1.1 christos <strong>including the line numbers themselves</strong>. The line 3940 1.1 christos numbers (by default, enclosed in square brackets) are separated from 3941 1.1 christos the beginning of each endnote by a gap, so that a line-numbered 3942 1.1 christos endnote looks approximately like this: 3943 1.1 christos <p> 3944 1.1 christos <pre> 3945 1.1 christos [1-2] Notwithstanding, Frye later asserts that Christianity 3946 1.1 christos is "a ghost with the chains of a foul historical record of 3947 1.1 christos cruelty clanking behind it." 3948 1.1 christos </pre> 3949 1.1 christos 3950 1.1 christos The default gap for <strong>PRINTSTYLE TYPESET</strong> and 3951 1.1 christos <strong>PRINSTYLE TYPEWRITE</strong> is 1.5 3952 1.1 christos <a href="definitions.html#TERMS_EM">ems</a>. 3953 1.1 christos You can change the size of the gap with the macro, 3954 1.1 christos <strong>ENDNOTE_LINENUMBER_GAP</strong>, which takes, as its single 3955 1.1 christos argument, the size of the gap. The argument requires a 3956 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>, 3957 1.1 christos so, for example, to change the gap to 2 3958 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">picas</a>, 3959 1.1 christos you'd do 3960 1.1 christos <p> 3961 1.1 christos <pre> 3962 1.1 christos .ENDNOTE_LINENUMBER_GAP 2P 3963 1.1 christos </pre> 3964 1.1 christos 3965 1.1 christos <a name="ENDNOTE_LINENUMBER_BRACKETS"></a> 3966 1.1 christos By default, <strong>mom</strong> puts endnote line numbers inside 3967 1.1 christos square brackets. The style of the brackets may be changed with 3968 1.1 christos the macro, <strong>ENDNOTE_LINENUMBER_BRACKETS</strong>, which 3969 1.1 christos takes one of three possible arguments: <strong>PARENS</strong> 3970 1.1 christos ("round" brackets), <strong>SQUARE</strong> (the default) or 3971 1.1 christos <strong>BRACES</strong> (curly braces). If you prefer a 3972 1.1 christos shortform, the arguments, <strong>(</strong>, <strong>[</strong> or 3973 1.1 christos <strong>{</strong> may be used instead. 3974 1.1 christos <a name="ENDNOTE_LINENUMBER_SEPARATOR"></a> 3975 1.1 christos <p> 3976 1.1 christos If you don't want the numbers enclosed in brackets, you may tell 3977 1.1 christos <strong>mom</strong> to use a "separator" instead. A common 3978 1.1 christos separator would be the colon, but it can be anything you like. The 3979 1.1 christos macro to do this is <strong>ENDNOTE_LINENUMBER_SEPARATOR</strong>, 3980 1.1 christos which takes, as its single argument, the separator you want. 3981 1.1 christos (If the argument contains spaces, don't forget to enclose the 3982 1.1 christos argument in double-quotes.) The separator can be composed of 3983 1.1 christos any legal groff character, or any combination of characters. 3984 1.1 christos For example, to get a colon separator after the line number in 3985 1.1 christos line-numbered endnotes, you'd do 3986 1.1 christos <p> 3987 1.1 christos <pre> 3988 1.1 christos .ENDNOTE_LINENUMBER_SEPARATOR : 3989 1.1 christos </pre> 3990 1.1 christos 3991 1.1 christos <a name="ENDNOTE_NUMBER_CONTROL"><h3><u>*Endnote numbering style control</u></h3></a> 3992 1.1 christos <p> 3993 1.1 christos See 3994 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 3995 1.1 christos <p> 3996 1.1 christos Please note that the control macros for endnote numbering affect only 3997 1.1 christos the numbers that appear on the endnotes pages themselves, not the 3998 1.1 christos endnote numbers that appear in the body of the document(s). 3999 1.1 christos <p> 4000 1.1 christos <pre> 4001 1.1 christos .ENDNOTE_NUMBER_FAMILY default = prevailing document family; default is Times Roman 4002 1.1 christos .ENDNOTE_NUMBER_FONT default = bold 4003 1.1 christos .ENDNOTE_NUMBER_SIZE* default = 0 4004 1.1 christos 4005 1.1 christos *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE) 4006 1.1 christos </pre> 4007 1.1 christos 4008 1.1 christos <a name="ENDNOTE_NUMBER_ALIGNMENT"><h3><u>*Endnote numbering alignment</u></h3></a> 4009 1.1 christos <p> 4010 1.1 christos By default, <strong>mom</strong> hangs the numbers on endnotes pages, 4011 1.1 christos aligned right to two placeholders, producing this: 4012 1.1 christos <p> 4013 1.1 christos <a name="ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE"></a> 4014 1.1 christos <pre> 4015 1.1 christos 9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 4016 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore et 4017 1.1 christos dolore magna aliquyam erat, sed diam voluptua. 4018 1.1 christos 4019 1.1 christos 10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 4020 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore et 4021 1.1 christos dolore magna aliquyam erat, sed diam voluptua. 4022 1.1 christos </pre> 4023 1.1 christos 4024 1.1 christos The macros to alter this behaviour are 4025 1.1 christos <br> 4026 1.1 christos <ul> 4027 1.1 christos <li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT"><strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong></a> 4028 1.1 christos <li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT"><strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong></a> 4029 1.1 christos </ul> 4030 1.1 christos <br> 4031 1.1 christos <hr width="66%" align="left"> 4032 1.1 christos 4033 1.1 christos <!---ENDNOTE_NUMBERS_ALIGN_RIGHT---> 4034 1.1 christos 4035 1.1 christos <p> 4036 1.1 christos <a name="ENDNOTE_NUMBERS_ALIGN_RIGHT"> 4037 1.1 christos <nobr>Macro: <strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> <number of placeholders></nobr> 4038 1.1 christos </a> 4039 1.1 christos <p> 4040 1.1 christos <strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> takes one (non-optional) 4041 1.1 christos argument: the number of placeholders to reserve for right alignment of 4042 1.1 christos endnote numbers. 4043 1.1 christos <p> 4044 1.1 christos For example, if you have fewer than ten endnotes, you might want to do 4045 1.1 christos <p> 4046 1.1 christos <pre> 4047 1.1 christos .ENDNOTE_NUMBERS_ALIGN_RIGHT 1 4048 1.1 christos </pre> 4049 1.1 christos 4050 1.1 christos which would ensure that the endnote numbers hang, but are all flush 4051 1.1 christos with the page's left margin. If, god help you, you have over a hundred 4052 1.1 christos endnotes, you'd want to do 4053 1.1 christos <p> 4054 1.1 christos <pre> 4055 1.1 christos .ENDNOTE_NUMBERS_ALIGN_RIGHT 3 4056 1.1 christos </pre> 4057 1.1 christos 4058 1.1 christos to ensure that the numbers hang and are properly right-aligned. 4059 1.1 christos <p> 4060 1.1 christos 4061 1.1 christos <hr width="66%" align="left"> 4062 1.1 christos 4063 1.1 christos <!---ENDNOTE_NUMBERS_ALIGN_LEFT---> 4064 1.1 christos 4065 1.1 christos <p> 4066 1.1 christos <a name="ENDNOTE_NUMBERS_ALIGN_LEFT"> 4067 1.1 christos Macro: <strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong> 4068 1.1 christos </a> 4069 1.1 christos <p> 4070 1.1 christos If you don't want the endnote numbers to hang and right-align, invoke 4071 1.1 christos <strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong>, which doesn't require any 4072 1.1 christos argument. This disables hanging and right-alignment of endnote numbers, 4073 1.1 christos so that the example 4074 1.1 christos <a href="#ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE">above</a> 4075 1.1 christos comes out like this: 4076 1.1 christos <p> 4077 1.1 christos <pre> 4078 1.1 christos 9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 4079 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore et 4080 1.1 christos dolore magna aliquyam erat, sed diam voluptua. 4081 1.1 christos 4082 1.1 christos 10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, 4083 1.1 christos sed diam nonumy eirmod tempor invidunt ut labore et 4084 1.1 christos dolore magna aliquyam erat, sed diam voluptua. 4085 1.1 christos </pre> 4086 1.1 christos <hr> 4087 1.1 christos 4088 1.1 christos <!====================================================================> 4089 1.1 christos 4090 1.1 christos <a name="MARGIN_NOTES_INTRO"><h2><u>Margin notes</u></h2></a> 4091 1.1 christos <ul> 4092 1.1 christos <li><a href="#MARGIN_NOTES_BEHAVIOUR">Margin notes behaviour 4093 1.1 christos <ul> 4094 1.1 christos <li><a href="#MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a> 4095 1.1 christos </ul> 4096 1.1 christos <li><a href="#MN_INIT">Macro: MN_INIT</a> -- initialize margin notes 4097 1.1 christos <li><a href="#MN">Tag: MN</a> 4098 1.1 christos </ul> 4099 1.1 christos 4100 1.1 christos <p> 4101 1.1 christos Margin notes are short annotations that appear in either the left 4102 1.1 christos or right margin of a document. Sometimes they comment on the text. 4103 1.1 christos Sometimes they assist in following the "flow" of a document by 4104 1.1 christos summarizing the subject of a portion of text. Sometimes they're 4105 1.1 christos comments to yourself in a draft copy. 4106 1.1 christos <p> 4107 1.1 christos The margin notes macros and routines in om.tmac 4108 1.1 christos (<strong>mom</strong>) are "mommified" versions of the margin notes 4109 1.1 christos macros and routines written by Werner Lemberg and patched by Gaius 4110 1.1 christos Mulley. 4111 1.1 christos <p> 4112 1.1 christos 4113 1.1 christos <a name="MARGIN_NOTES_BEHAVIOUR"<h3><u>Margin notes behaviour</u></h3> 4114 1.1 christos <p> 4115 1.1 christos First things first: before you enter your first margin note, you 4116 1.1 christos must "initialize" margin notes with 4117 1.1 christos <a href="#MN_INIT">MN_INIT</a>. 4118 1.1 christos <strong>MN_INIT</strong> sets up the style parameters for margin 4119 1.1 christos notes, including things like 4120 1.1 christos <a href="definitions.html#TERMS_FONT">font</a>, 4121 1.1 christos <a href="definitions.html#TERMS_FAMILY">family</a> 4122 1.1 christos and 4123 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a>. 4124 1.1 christos <p> 4125 1.1 christos After initializing margin notes, you create margin notes with the 4126 1.1 christos <a href="#MN">MN</a> 4127 1.1 christos macro. Based on the argument you pass <strong>MN</strong>, your 4128 1.1 christos margin note will go in either the left or the right margin. 4129 1.1 christos <p> 4130 1.1 christos Margin notes are tricky from a typographic standpoint with respect 4131 1.1 christos to vertical placement. Since the leading of margin notes may 4132 1.1 christos differ from that of 4133 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a>, 4134 1.1 christos it's impossible for <strong>mom</strong> to guess whether to align 4135 1.1 christos the first lines of margin notes with a document 4136 1.1 christos <a href="definitions.html#TERMS_BASELINE">baseline</a>, 4137 1.1 christos whether to align the last lines of margin notes with a document 4138 1.1 christos baseline, or whether to center them, vertically, so that neither 4139 1.1 christos first nor last line aligns with anything! 4140 1.1 christos <p> 4141 1.1 christos Given this difficulty, <strong>mom</strong> always aligns the first 4142 1.1 christos line of any margin note with a document baseline. If you want a 4143 1.1 christos different behaviour, you must adjust the position(s) of margin 4144 1.1 christos notes yourself, on a note by note basis. (See 4145 1.1 christos <a href="#MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a>.) 4146 1.1 christos <p> 4147 1.1 christos Generally speaking, <strong>mom</strong> tries to place margin 4148 1.1 christos notes at the point where you invoke the tag, 4149 1.1 christos <a href="#MN">MN</a>. 4150 1.1 christos However, in the event that a margin note runs deep, she may not 4151 1.1 christos be able to place a subsequent margin note exactly where you want. 4152 1.1 christos In such an instance, <strong>mom</strong> will "shift" the margin 4153 1.1 christos note down on the page, placing it one (margin note) 4154 1.1 christos linespace beneath the previous margin note (plus whatever vertical 4155 1.1 christos space is required to get the first line to line up with a baseline 4156 1.1 christos of running text). A warning will be issued, letting you know this 4157 1.1 christos has happened, and where. 4158 1.1 christos <p> 4159 1.1 christos Sometimes, if a margin note has to be shifted down, there simply 4160 1.1 christos isn't enough room to start the margin note on the page on which 4161 1.1 christos <strong>MN</strong> is invoked. In that case, <strong>mom</strong> 4162 1.1 christos ignores the margin note entirely and issues a warning, letting you 4163 1.1 christos know what she's done, and where. 4164 1.1 christos <p> 4165 1.1 christos In the event that a margin note, sucessfully begun on a page, 4166 1.1 christos runs past your bottom margin (or the last line before footnotes 4167 1.1 christos begin), the margin note will "flow" onto the next page. If it is a 4168 1.1 christos "left" margin note, it will continue in the left margin. If it is a 4169 1.1 christos "right" margin note, it will continue in the right margin. 4170 1.1 christos <p> 4171 1.1 christos If your document is being set in two columns, <strong>mom</strong> 4172 1.1 christos will sensibly and automatically set all margin notes pertaining 4173 1.1 christos to the left column in the left margin, and all margin notes 4174 1.1 christos pertaining to the right column in the right margin, regardless of 4175 1.1 christos the "direction" argument you give the <strong>MN</strong> tag. If 4176 1.1 christos you try to use <strong>MN</strong> in documents of more than two 4177 1.1 christos columns, <strong>mom</strong> will ignore all margin notes, and 4178 1.1 christos issue warning for each. 4179 1.1 christos <p> 4180 1.1 christos <h3><u><a name="MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a></u></h3> 4181 1.1 christos <p> 4182 1.1 christos When the 4183 1.1 christos <a href="definitions.html#TERM_LEADING">leading</a> 4184 1.1 christos of margin notes differs from the leading used throughout a document, 4185 1.1 christos you may want to adjust the vertical position of individual margin 4186 1.1 christos notes. This is most often going to be the case with margin notes 4187 1.1 christos that end near the bottom of the page, where you want the last line of 4188 1.1 christos the margin note to line up with the last line of text on the page. 4189 1.1 christos <p> 4190 1.1 christos Adjustments to the vertical position of margin notes must be done 4191 1.1 christos inside the margin note (i.e. after <strong>MN</strong>), at the 4192 1.1 christos top, before entering text. The commands to use are 4193 1.1 christos \!<a href="typesetting.html#ALD">.ALD</a> 4194 1.1 christos (to lower the margin note), and 4195 1.1 christos \!<a href="typesetting.html#RLD">.RLD</a> 4196 1.1 christos (to raise it). The <strong>\!</strong> <em>must</em> precede the 4197 1.1 christos macros, or they won't have any effect. 4198 1.1 christos 4199 1.1 christos <p> 4200 1.1 christos <hr width="66%" align="left"> 4201 1.1 christos 4202 1.1 christos <!---MN_INIT---> 4203 1.1 christos 4204 1.1 christos <p> 4205 1.1 christos <a name="MN_INIT"> 4206 1.1 christos <nobr>Macro: <strong>MN_INIT</strong> [ ragged | symmetric ] < left-width right-width gutter family+font point-size lead colour hyphenation-flags ></nobr> 4207 1.1 christos </a> 4208 1.1 christos <p> 4209 1.1 christos Before you enter your first margin note, you must initialize 4210 1.1 christos all the parameters associated with margin notes with 4211 1.1 christos <strong>MN_INIT</strong>. If you forget to do so, 4212 1.1 christos <strong>mom</strong> will issue a warning and abort. 4213 1.1 christos <p> 4214 1.1 christos The argument list is quite long; an 4215 1.1 christos explanation of each argument follows. Any argument whose value you 4216 1.1 christos want to be the default must be entered as "" (i.e. two 4217 1.1 christos double-quotes with no space between them). Defaults for each 4218 1.1 christos argument are given in the explanation below. 4219 1.1 christos <p> 4220 1.1 christos <strong>[ ragged | symmetric ]</strong> 4221 1.1 christos <br> 4222 1.1 christos If the first argument is "ragged", both left and right margin notes 4223 1.1 christos will be flush left. If the first argument is "symmetric", left 4224 1.1 christos margin notes will be set flush <em>right</em>, and right margin 4225 1.1 christos notes will be set flush <em>left</em>. The effect is something 4226 1.1 christos like this: 4227 1.1 christos <p> 4228 1.1 christos <pre> 4229 1.1 christos A left This is a meaningless batch A right 4230 1.1 christos margin note of text whose sole purpose is margin note 4231 1.1 christos with just to demonstrate how the sym- with just 4232 1.1 christos a few words metric argument to MN sets left a few words 4233 1.1 christos in it. and right margin notes. in it. 4234 1.1 christos </pre> 4235 1.1 christos 4236 1.1 christos 4237 1.1 christos If the argument is omitted, 4238 1.1 christos or given as "", both left and right margin notes will be set 4239 1.1 christos justified. (Justified is usually not a good idea, since the narrow 4240 1.1 christos measure of margin notes makes pleasing justification a near 4241 1.1 christos impossibility.) 4242 1.1 christos <p> 4243 1.1 christos <strong>left-width</strong> 4244 1.1 christos <br> 4245 1.1 christos The width of left margin notes. A 4246 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 4247 1.1 christos must be appended directly onto the argument. The default is to set 4248 1.1 christos left margin notes right out to the edge of the page, which is 4249 1.1 christos almost certainly not what you want, so you should give a value for 4250 1.1 christos this argument if using left margin notes. 4251 1.1 christos <p> 4252 1.1 christos <strong>right-width</strong> 4253 1.1 christos <br> 4254 1.1 christos The width of right margin notes. A 4255 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 4256 1.1 christos must be appended directly onto the argument. The default is to set 4257 1.1 christos right margin notes right out to the edge of the page, which is 4258 1.1 christos almost certainly not what you want, so you should give a value for 4259 1.1 christos this argument if using right margin notes. 4260 1.1 christos <p> 4261 1.1 christos <strong>gutter</strong> 4262 1.1 christos <br> 4263 1.1 christos The 4264 1.1 christos <a href="definitions.html#TERMS_GUTTER">gutter</a> 4265 1.1 christos between margin notes and 4266 1.1 christos <a href="definitions.html#TERMS_RUNNING">running text</a>. 4267 1.1 christos A 4268 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 4269 1.1 christos must be appended directly onto the argument. The gutter applies to 4270 1.1 christos both left and right margin notes. The default is 1 4271 1.1 christos <a href="definitions.html#TERMS_EM">em</a>. 4272 1.1 christos <p> 4273 1.1 christos <strong>font</strong> 4274 1.1 christos <br> 4275 1.1 christos The family+font for margin notes. Yes, that's right: the family 4276 1.1 christos PLUS font combo. For example, if you want Times Roman Medium, 4277 1.1 christos the argument must be TR. If you want Palatino Medium Italic, the 4278 1.1 christos argument must be PI. The default is the same family+font combo used 4279 1.1 christos for a document's paragraph text. 4280 1.1 christos <p> 4281 1.1 christos <strong>lead</strong> 4282 1.1 christos <br> 4283 1.1 christos The 4284 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a> 4285 1.1 christos of margin notes. <strong>lead</strong> uses 4286 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a> 4287 1.1 christos as its unit of measure, so don't tack a unit of measure onto the 4288 1.1 christos end of the argument. The default lead is the same leading as 4289 1.1 christos is used for paragraph text (i.e. the document's base leading). 4290 1.1 christos For convenience and clarity, you may also give the word, 4291 1.1 christos <strong>DOC</strong>, to this argument, which indicates that the 4292 1.1 christos leading should be the same as the document's base leading. 4293 1.1 christos <p> 4294 1.1 christos <strong>colour</strong> 4295 1.1 christos <br> 4296 1.1 christos The colour of margin notes. The colour must be pre-initialized 4297 1.1 christos with 4298 1.1 christos <a href="color.html#NEWCOLOR">NEWCOLOR</a> 4299 1.1 christos or 4300 1.1 christos <a href="color.html#XCOLOR">XCOLOR</a>. 4301 1.1 christos The default is black. 4302 1.1 christos <p> 4303 1.1 christos <strong>hyphenation-flags</strong> 4304 1.1 christos <br> 4305 1.1 christos A number telling <strong>groff</strong> how you want margin notes 4306 1.1 christos hyphenated. 4307 1.1 christos <p> 4308 1.1 christos <pre> 4309 1.1 christos 1 = hyphenate without restrictions 4310 1.1 christos 2 = do not hyphenate the last word on the page 4311 1.1 christos 4 = do not hyphenate the last two characters of a word 4312 1.1 christos 8 = do not hyphenate the first two characters of a word 4313 1.1 christos </pre> 4314 1.1 christos 4315 1.1 christos The values can be added together, so, for example, if you want 4316 1.1 christos neither the first two nor the last two characters of words 4317 1.1 christos hyphenated, the hyphenation-flag would be 12. The default value is 4318 1.1 christos 14 (i.e. 2+4+8). 4319 1.1 christos 4320 1.1 christos <p> 4321 1.1 christos <hr width="66%" align="left"> 4322 1.1 christos 4323 1.1 christos <!---MN_INIT---> 4324 1.1 christos 4325 1.1 christos <p> 4326 1.1 christos <a name="MN"> 4327 1.1 christos <nobr>Macro: <strong>MN</strong> LEFT|RIGHT | <anything></nobr> 4328 1.1 christos </a> 4329 1.1 christos <p> 4330 1.1 christos Once you've initialized margin notes with 4331 1.1 christos <a href="#MN_INIT">MN_INIT</a>, 4332 1.1 christos you can enter margin notes any time you like with 4333 1.1 christos <strong>MN</strong>. An argument of <strong>LEFT</strong> will set 4334 1.1 christos a left margin note. An argument of <strong>RIGHT</strong> will set 4335 1.1 christos a right margin note. 4336 1.1 christos <p> 4337 1.1 christos Any argument, such as <strong>OFF</strong> (or 4338 1.1 christos <strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>, 4339 1.1 christos etc) exits the current margin note. 4340 1.1 christos 4341 1.1 christos <p> 4342 1.1 christos <hr> 4343 1.1 christos 4344 1.1 christos <!====================================================================> 4345 1.1 christos 4346 1.1 christos <a name="BLANK_PAGE_TITLE"><h2><u>Inserting a blank page into the document</u></h2></a> 4347 1.1 christos <p> 4348 1.1 christos <a name="BLANK_PAGE"> 4349 1.1 christos <nobr>Macro: <strong>BLANKPAGE</strong> <# of blank pages to insert></nobr> 4350 1.1 christos </a> 4351 1.1 christos 4352 1.1 christos <p> 4353 1.1 christos This one does exactly what you'd expect -- inserts a blank page into 4354 1.1 christos the document. <strong>Mom</strong> silently increments the page 4355 1.1 christos number of every blank page and keeps track of 4356 1.1 christos <a href="rectoverso.html#RECTO_VERSO">recto/verso</a> 4357 1.1 christos stuff, but otherwise, does nothing. It's up to you, the user, to 4358 1.1 christos figure out what to do with this feature. However, it's worth 4359 1.1 christos noting that without it, inserting completely blank pages, to use 4360 1.1 christos a vernacular Qubcois phrase, "c'est pas vident" 4361 1.1 christos (somewhere between "isn't easy", "isn't 4362 1.1 christos obvious" and "isn't fun"). 4363 1.1 christos <p> 4364 1.1 christos The argument to <strong>BLANK_PAGE</strong> is the number of blank 4365 1.1 christos pages to insert. The argument is not optional, hence even if you 4366 1.1 christos only want one blank page, you have to tell <strong>mom</strong>: 4367 1.1 christos <p> 4368 1.1 christos <pre> 4369 1.1 christos .BLANKPAGE 1 4370 1.1 christos </pre> 4371 1.1 christos 4372 1.1 christos <a name="FINIS_INTRO"><h2><u>Terminate document processing</u></h2></a> 4373 1.1 christos <ul> 4374 1.1 christos <li><a href="#FINIS">Tag: FINIS</a> 4375 1.1 christos <li><a href="#FINIS_STRING">Changing the FINIS string</a> 4376 1.1 christos </ul> 4377 1.1 christos 4378 1.1 christos <p> 4379 1.1 christos The use of <strong>FINIS</strong> is optional. If you invoke it 4380 1.1 christos (at the end of a document before 4381 1.1 christos <a href="#TOC">TOC</a> 4382 1.1 christos or 4383 1.1 christos <a href="#ENDNOTES">ENDNOTES</a>), 4384 1.1 christos <strong>mom</strong> 4385 1.1 christos deposits the word END, centred after a blank line, beneath the last 4386 1.1 christos line of the document. END is enclosed between 4387 1.1 christos <a href="definitions.html#TERMS_EM">em-dashes</a>. 4388 1.1 christos <p> 4389 1.1 christos <strong>Please note</strong> that in versions of 4390 1.1 christos <strong>mom</strong> prior to 1.1.9, <strong>FINIS</strong> used to 4391 1.1 christos turn off 4392 1.1 christos <a href="definitions.html#TERMS_FOOTER">footers</a> 4393 1.1 christos (if they were on) and page numbering (if page numbers were at the 4394 1.1 christos bottom of the page). Damned if I can recall why I thought anyone 4395 1.1 christos would want this behaviour, but it has been removed. 4396 1.1 christos <p> 4397 1.1 christos If you're writing in a language other than English, you can 4398 1.1 christos change what <strong>mom</strong> prints for END with 4399 1.1 christos the control macro <strong>FINIS_STRING</strong>. 4400 1.1 christos <p> 4401 1.1 christos <hr> 4402 1.1 christos 4403 1.1 christos <!====================================================================> 4404 1.1 christos 4405 1.1 christos <a name="TOC_INTRO"><h2><u>Table of contents</u></h2></a> 4406 1.1 christos <ul> 4407 1.1 christos <li><a href="#TOC_BEHAVIOUR">TOC behaviour</a> 4408 1.1 christos <li><a href="#TOC">Macro: TOC</a> -- tell <strong>mom</strong> to output a table of contents 4409 1.1 christos <li><a href="#TOC_CONTROL">TOC control macros</a> 4410 1.1 christos </ul> 4411 1.1 christos 4412 1.1 christos <p> 4413 1.1 christos Want a table of contents for your document? Easy. Just enter 4414 1.1 christos <p> 4415 1.1 christos <pre> 4416 1.1 christos .TOC 4417 1.1 christos </pre> 4418 1.1 christos 4419 1.1 christos as the very last macro of your document file. <strong>Mom</strong> 4420 1.1 christos will have picked up all document titles (in 4421 1.1 christos <a href="docprocessing.html#COLLATE">collated</a> 4422 1.1 christos documents), all heads, subheads, and paragraph heads, as well as any 4423 1.1 christos endnotes pages that have been output, and assigned them the 4424 1.1 christos appropriate page number (and page numbering style). Talk about a 4425 1.1 christos no-brainer! 4426 1.1 christos 4427 1.1 christos That said, tables of contents (tocs) have even more control macros 4428 1.1 christos than endnotes. As always, the reason for so many control macros is 4429 1.1 christos so that if you want to change just about any aspect of the toc's 4430 1.1 christos typographic appearance, you can. <strong>Mom</strong> is all about 4431 1.1 christos simplicity AND flexibility. 4432 1.1 christos <p> 4433 1.1 christos 4434 1.1 christos <a name="TOC_BEHAVIOUR"><h3><u>TOC behaviour</u></h3></a> 4435 1.1 christos <p> 4436 1.1 christos When you output a toc (with 4437 1.1 christos <a href="#TOC">TOC</a>), 4438 1.1 christos <strong>mom</strong> finishes processing the last page of your document, 4439 1.1 christos then breaks to a new page for printing the toc. 4440 1.1 christos <p> 4441 1.1 christos <strong>Mom</strong> follows standard typesetting conventions for 4442 1.1 christos tables of contents. To this end, if 4443 1.1 christos <a href="headfootpage.html#HEADERS">HEADERS</a> 4444 1.1 christos are on for the document, the first page of the toc has no page 4445 1.1 christos header, but does have a first page (roman numeral) number, always 4446 1.1 christos "1", in the bottom margin. If 4447 1.1 christos <a href="headfootpage.html#FOOTERS">FOOTERS</a> 4448 1.1 christos are on for the document, the first page has neither a footer, nor a 4449 1.1 christos page number in the top margin. (If you absolutely must have a page 4450 1.1 christos footer on the first page of the toc, simply invoke 4451 1.1 christos <a href="headfootpage.html#FOOTER_ON_FIRST_PAGE">FOOTER_ON_FIRST_PAGE</a> 4452 1.1 christos immediately before <strong>TOC</strong>.) Subsequent toc pages have 4453 1.1 christos both page headers or footers and a page number. 4454 1.1 christos <p> 4455 1.1 christos Entries in the toc are hierarchically indented, as you would 4456 1.1 christos expect. By default, each type of entry (e.g. a head or a subhead) 4457 1.1 christos is set in a different font as well. If any of heads, subheads or 4458 1.1 christos paragraph heads are numbered in the body of the document, they are 4459 1.1 christos also numbered in the toc. Head numbering in the toc is NOT 4460 1.1 christos concatenated as it is in the body of the document, which would be 4461 1.1 christos visually redundant in a toc. 4462 1.1 christos <p> 4463 1.1 christos Tocs are never set in columns, regardless of whether the rest of 4464 1.1 christos the document is. Lastly, if 4465 1.1 christos <a href="rectoverso.html#RECTO_VERSO">recto/verso</a> 4466 1.1 christos printing is enabled, the toc respects it. This sometimes leads to 4467 1.1 christos tocs that begin with the wrong margins, but the margins can be 4468 1.1 christos corrected either by outputting a 4469 1.1 christos <a href="#BLANK_PAGE">BLANKPAGE</a> 4470 1.1 christos or by using the toc control macro 4471 1.1 christos <a href="#TOC_RV_SWITCH">TOC_RV_SWITCH</a>. 4472 1.1 christos <p> 4473 1.1 christos The overall toc 4474 1.1 christos <a href="definitions.html#TERMS_FAMILY">family</a>, 4475 1.1 christos <a href="definitions.html#TERMS_PS">point size</a> 4476 1.1 christos and 4477 1.1 christos <a href="definitions.html#TERMS_LEADING">lead</a> 4478 1.1 christos can be altered with the toc 4479 1.1 christos <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>, 4480 1.1 christos as can the family, 4481 1.1 christos <a href="definitions.html#TERMS_FONT">font</a>, 4482 1.1 christos point size and indent of each type of toc entry (i.e. title, head, 4483 1.1 christos subhead, paragraph head). Furthermore, the page numbering style 4484 1.1 christos can be changed, as can the amount of visual space reserved for toc 4485 1.1 christos entry page numbers. 4486 1.1 christos <p> 4487 1.1 christos 4488 1.1 christos <!---TOC---> 4489 1.1 christos 4490 1.1 christos <hr width="66%" align="left"> 4491 1.1 christos <p> 4492 1.1 christos <a name="TOC">Macro: <strong>TOC</strong></a> 4493 1.1 christos 4494 1.1 christos <p> 4495 1.1 christos If you want a toc, just put <strong>TOC</strong> as the last macro 4496 1.1 christos in a document. <strong>Mom</strong> takes care of the rest. 4497 1.1 christos <p> 4498 1.1 christos <hr width="66%" align="left"> 4499 1.1 christos 4500 1.1 christos <a name="TOC_CONTROL"><h3><u>TOC control macros</u></h3></a> 4501 1.1 christos <p> 4502 1.1 christos Toc entries are not actually processed when <strong>mom</strong> 4503 1.1 christos collects them, so you can put any toc control macros anywhere you 4504 1.1 christos like in your document. Some may prefer to place them at the top of 4505 1.1 christos the file. Others may prefer to place them just before outputting 4506 1.1 christos the toc. The choice is yours. 4507 1.1 christos <br> 4508 1.1 christos <ol> 4509 1.1 christos <li><a href="#TOC_GENERAL"><strong>General toc page style control</strong></a> 4510 1.1 christos <ul> 4511 1.1 christos <li><a href="#TOC_FAMILY">Base family for toc pages</a> 4512 1.1 christos <li><a href="#TOC_PT_SIZE">Base point size for toc pages</a> 4513 1.1 christos <li><a href="#TOC_LEAD">Leading of toc pages</a> 4514 1.1 christos </ul> 4515 1.1 christos <li><a href="#TOC_PAGENUMBERING"><strong>Toc page numbering</strong></a> 4516 1.1 christos <ul> 4517 1.1 christos <li><a href="#PAGINATE_TOC">Turn toc pagination on or off</a> 4518 1.1 christos <li><a href="#TOC_PAGENUM_STYLE">Toc page numbering style</a> 4519 1.1 christos </ul> 4520 1.1 christos <li><a href="#TOC_HEADER"><strong>Changing the toc header (title), string and style</strong></a> 4521 1.1 christos <ul> 4522 1.1 christos <li><a href="#TOC_HEADER_STRING">Changing the string (title)</a> 4523 1.1 christos <li><a href="#TOC_HEADER_STYLE">Changing the string (title) style</a> 4524 1.1 christos </ul> 4525 1.1 christos <li><a href="#TOC_STYLE"><strong>Changing the style for toc entries</strong></a> 4526 1.1 christos <ul> 4527 1.1 christos <li><a href="#TOC_INDENT">The toc _INDENT control macros</a> 4528 1.1 christos <li><a href="#TOC_TITLE">Changing the style for toc title entries</a> 4529 1.1 christos <li><a href="#TOC_HEAD">Changing the style for toc head entries</a> 4530 1.1 christos <li><a href="#TOC_SUBHEAD">Changing the style for toc subhead entries</a> 4531 1.1 christos <li><a href="#TOC_PARAHEAD">Changing the style for toc paragraph head entries</a> 4532 1.1 christos <li><a href="#TOC_PN">Changing the style for toc page number listings</a> 4533 1.1 christos </ul> 4534 1.1 christos <li><a href="#TOC_ADDITIONAL"><strong>Additional toc control macros</strong></a> 4535 1.1 christos <ul> 4536 1.1 christos <li><a href="#TOC_TITLE_ENTRY">Change the wording of a toc title entry</a> 4537 1.1 christos <li><a href="#TOC_APPENDS_AUTHOR">Append author(s) to toc title entries</a> 4538 1.1 christos <li><a href="#TOC_RV_SWITCH">TOC_RV_SWITCH</a> 4539 1.1 christos <li><a href="#TOC_PADDING">TOC_PADDING</a> 4540 1.1 christos </ul> 4541 1.1 christos </ol> 4542 1.1 christos <hr> 4543 1.1 christos 4544 1.1 christos <a name="TOC_GENERAL"><h2><u>1. General toc page style control</u></h2> 4545 1.1 christos 4546 1.1 christos <a name="TOC_FAMILY"><h3><u>*Toc family</u></h3></a> 4547 1.1 christos <p> 4548 1.1 christos See 4549 1.1 christos <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>. 4550 1.1 christos <p> 4551 1.1 christos Set the family of toc pages with <strong>TOC_FAMILY</strong>, which 4552 1.1 christos establishes the default family for every element of a toc page, 4553 1.1 christos including the toc title ("Contents") and the page number 4554 1.1 christos in the top or bottom margin. The default is the prevailing document 4555 1.1 christos family. 4556 1.1 christos <p> 4557 1.1 christos All elements on a toc page also have their own _FAMILY 4558 1.1 christos control macros, which override the default set by 4559 1.1 christos <strong>TOC_FAMILY</strong>. 4560 1.1 christos <p> 4561 1.1 christos 4562 1.1 christos <!---TOC_PT_SIZE---> 4563 1.1 christos 4564 1.1 christos <a name="TOC_PT_SIZE"><h3><u>*Toc point size</u></h3></a> 4565 1.1 christos <p> 4566 1.1 christos <nobr>Macro: <strong>TOC_PT_SIZE</strong> <base type size of the toc></nobr> 4567 1.1 christos 4568 1.1 christos <p> 4569 1.1 christos Unlike most other control macros that deal with size of document 4570 1.1 christos elements, <strong>TOC_PT_SIZE</strong> takes as its argument an 4571 1.1 christos absolute value, relative to nothing. Therefore, the argument 4572 1.1 christos represents the size of toc type in 4573 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a>, 4574 1.1 christos unless you append an alternative 4575 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 4576 1.1 christos For example, 4577 1.1 christos <p> 4578 1.1 christos <pre> 4579 1.1 christos .TOC_PT_SIZE 12 4580 1.1 christos </pre> 4581 1.1 christos 4582 1.1 christos sets the base point size of type for the toc to 12 points, whereas 4583 1.1 christos <p> 4584 1.1 christos <pre> 4585 1.1 christos .TOC_PT_SIZE .6i 4586 1.1 christos </pre> 4587 1.1 christos 4588 1.1 christos sets the base point size of type for the toc to 1/6 of an inch. 4589 1.1 christos <p> 4590 1.1 christos The type size set with <strong>TOC_PT_SIZE</strong> forms the basis 4591 1.1 christos from which the point size of other toc page elements are calculated. 4592 1.1 christos <p> 4593 1.1 christos The default for 4594 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a> 4595 1.1 christos is 12.5 points (the same default size used in the body of the 4596 1.1 christos document). 4597 1.1 christos <p> 4598 1.1 christos 4599 1.1 christos <!---TOC_LEAD---> 4600 1.1 christos 4601 1.1 christos <a name="TOC_LEAD"><h3><u>*Toc lead</u></h3></a> 4602 1.1 christos <p> 4603 1.1 christos <nobr>Macro: <strong>TOC_LEAD</strong> <leading of the toc> [ ADJUST ]</nobr> 4604 1.1 christos <br> 4605 1.1 christos <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em> 4606 1.1 christos 4607 1.1 christos <p> 4608 1.1 christos Unlike most other control macros that deal with leading of document 4609 1.1 christos elements, <strong>TOC_LEAD</strong> takes as its argument an 4610 1.1 christos absolute value, relative to nothing. Therefore, the argument 4611 1.1 christos represents the 4612 1.1 christos <a href="definitions.html#TERMS_LEADING">leading</a> 4613 1.1 christos of tocs in 4614 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">points</a> 4615 1.1 christos unless you append an alternative 4616 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 4617 1.1 christos For example, 4618 1.1 christos <p> 4619 1.1 christos <pre> 4620 1.1 christos .TOC_LEAD 14 4621 1.1 christos </pre> 4622 1.1 christos 4623 1.1 christos sets the base leading of type on the endnotes page to 14 4624 1.1 christos points, whereas 4625 1.1 christos <p> 4626 1.1 christos <pre> 4627 1.1 christos .TOC_LEAD .5i 4628 1.1 christos </pre> 4629 1.1 christos 4630 1.1 christos sets the base leading of type on the endnotes page to 1/2 inch. 4631 1.1 christos <p> 4632 1.1 christos If you want the leading of toc pages adjusted to fill the 4633 1.1 christos page, pass <strong>TOC_LEAD</strong> the optional argument 4634 1.1 christos <strong>ADJUST</strong>. (See 4635 1.1 christos <a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> 4636 1.1 christos for an explanation of leading adjustment.) 4637 1.1 christos <p> 4638 1.1 christos The default for 4639 1.1 christos <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a> 4640 1.1 christos is the prevailing document lead (16 by default), adjusted. 4641 1.1 christos <p> 4642 1.1 christos <strong>NOTE:</strong> Even if you give <strong>mom</strong> a 4643 1.1 christos <strong>DOC_LEAD_ADJUST OFF</strong> command, she will still, by 4644 1.1 christos default, adjust toc leading. You MUST enter 4645 1.1 christos <strong>TOC_LEAD <lead></strong> with no 4646 1.1 christos <strong>ADJUST</strong> argument to disable this default behaviour. 4647 1.1 christos <p> 4648 1.1 christos <strong>ADDITIONAL NOTE:</strong> Tocs are always double-spaced in 4649 1.1 christos <strong>PRINTSTYLE TYPEWRITE</strong>, regardless of whether the 4650 1.1 christos body of the document is single-spaced. 4651 1.1 christos 4652 1.1 christos <a name="TOC_PAGENUMBERING"><h2><u>2. Toc page numbering</u></h2></a> 4653 1.1 christos <p> 4654 1.1 christos The page numbering of toc pages is controlled by the same macros 4655 1.1 christos that control 4656 1.1 christos <a href="headfootpage.html#PAGINATION">document page numbering</a>, 4657 1.1 christos except 4658 1.1 christos <a href="headfootpage.html#PAGENUM">PAGENUM</a> 4659 1.1 christos (tocs always start on page 1). The defaults are the same as the 4660 1.1 christos rest of the document. 4661 1.1 christos <p> 4662 1.1 christos If you wish to change some aspect of toc pagination, use the 4663 1.1 christos document pagination control macros immediately prior to 4664 1.1 christos <strong>.TOC</strong>. 4665 1.1 christos <p> 4666 1.1 christos A special macro, 4667 1.1 christos <a href="#TOC_PAGENUM_STYLE">TOC_PAGENUM_STYLE</a> 4668 1.1 christos controls the style of toc pages page numbers. 4669 1.1 christos <p> 4670 1.1 christos 4671 1.1 christos <hr width="33%" align="left"> 4672 1.1 christos 4673 1.1 christos <!---PAGINATE_TOC---> 4674 1.1 christos 4675 1.1 christos <p> 4676 1.1 christos <a name="PAGINATE_TOC"> 4677 1.1 christos <nobr>Macro: <strong>PAGINATE_TOC</strong> <toggle></nobr> 4678 1.1 christos </a> 4679 1.1 christos <p> 4680 1.1 christos By default, <strong>mom</strong> paginates the toc. If you'd like 4681 1.1 christos her not to, do 4682 1.1 christos <p> 4683 1.1 christos <pre> 4684 1.1 christos .PAGINATE_TOC OFF 4685 1.1 christos </pre> 4686 1.1 christos 4687 1.1 christos <strong>NOTE:</strong> Simply invoking <strong>PAGINATION 4688 1.1 christos OFF</strong> or <strong>PAGINATE OFF</strong> disables toc 4689 1.1 christos pagination <em>for the first toc page only.</em> You MUST use 4690 1.1 christos <strong>.PAGINATE_TOC OFF</strong> to disable toc pagination, even 4691 1.1 christos if pagination is turned off elsewhere in your document. 4692 1.1 christos <p> 4693 1.1 christos 4694 1.1 christos <hr width="33%" align="left"> 4695 1.1 christos <p> 4696 1.1 christos 4697 1.1 christos <!---TOC_PAGENUM_STYLE---> 4698 1.1 christos 4699 1.1 christos <a name="TOC_PAGENUM_STYLE"> 4700 1.1 christos <nobr>Macro: <strong>TOC_PAGENUM_STYLE</strong> <DIGIT | ROMAN | roman | ALPHA | alpha></nobr> 4701 1.1 christos </a> 4702 1.1 christos <p> 4703 1.1 christos By default, <strong>mom</strong> uses roman numerals to number 4704 1.1 christos toc pages. Use <strong>TOC_PAGENUM_STYLE</strong> if you'd prefer 4705 1.1 christos something else. For example, to have standard digits instead of 4706 1.1 christos roman numerals, do the following: 4707 1.1 christos <p> 4708 1.1 christos <pre> 4709 1.1 christos .TOC_PAGENUM_STYLE DIGIT 4710 1.1 christos </pre> 4711 1.1 christos 4712 1.1 christos <hr width="33%" align="left"> 4713 1.1 christos 4714 1.1 christos <a name="TOC_HEADER"><h2><u>3. Changing the toc header (title) string and style</u></h2></a> 4715 1.1 christos <p> 4716 1.1 christos The toc header string is the title that appears at to top of the 4717 1.1 christos toc. By default, it's "Contents". If you'd like 4718 1.1 christos something else, say, "Table of Contents", do 4719 1.1 christos <p> 4720 1.1 christos <a name="TOC_HEADER_STRING"></a> 4721 1.1 christos <pre> 4722 1.1 christos .TOC_HEADER_STRING "Table of Contents" 4723 1.1 christos </pre> 4724 1.1 christos 4725 1.1 christos <a name="TOC_HEADER_STYLE"></a> 4726 1.1 christos The style of the toc header (title) is managed by the usual control 4727 1.1 christos macros (see 4728 1.1 christos <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>). 4729 1.1 christos <p> 4730 1.1 christos <pre> 4731 1.1 christos .TOC_HEADER_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE) 4732 1.1 christos .TOC_HEADER_FONT default = bold 4733 1.1 christos .TOC_HEADER_SIZE default = +4 4734 1.1 christos .TOC_HEADER_QUAD default = left 4735 1.1 christos </pre> 4736 1.1 christos 4737 1.1 christos <a name="TOC_STYLE"><h2><u>4. Changing the style for toc entries</u></h2></a> 4738 1.1 christos <p> 4739 1.1 christos "Toc entries" refers to titles, heads, subheads and 4740 1.1 christos paragraph heads as they appear in the toc. Their style is managed 4741 1.1 christos by the usual 4742 1.1 christos <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>, 4743 1.1 christos starting with TOC_ 4744 1.1 christos <p> 4745 1.1 christos 4746 1.1 christos <a name="TOC_INDENT"><h3><u>The toc _INDENT control macros</u></h3></a> 4747 1.1 christos <p> 4748 1.1 christos The toc control macros that end in _INDENT all take a single 4749 1.1 christos argument that requires a 4750 1.1 christos <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. 4751 1.1 christos The argument is the distance to indent the entry, always measured 4752 1.1 christos from the left margin. For example, 4753 1.1 christos <p> 4754 1.1 christos <pre> 4755 1.1 christos .TOC_HEAD_INDENT 2P 4756 1.1 christos </pre> 4757 1.1 christos 4758 1.1 christos indents head entries 2 4759 1.1 christos <a href="definitions.html#TERMS_PICASPOINTS">picas</a> 4760 1.1 christos from the left margin. 4761 1.1 christos <p> 4762 1.1 christos 4763 1.1 christos <a name="TOC_TITLE"><h3><u>*Changing the style for toc title entries</u></h3></a> 4764 1.1 christos <p> 4765 1.1 christos (See 4766 1.1 christos <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>). 4767 1.1 christos <p> 4768 1.1 christos Toc title entries are the titles of documents that have been 4769 1.1 christos <a href="rectoverso.html#COLLATE">collated</a> 4770 1.1 christos together. 4771 1.1 christos <p> 4772 1.1 christos <pre> 4773 1.1 christos .TOC_TITLE_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE) 4774 1.1 christos .TOC_TITLE_FONT default = bold italic 4775 1.1 christos .TOC_TITLE_SIZE default = +0 4776 1.1 christos .TOC_TITLE_INDENT default = 0 for TYPESET and TYPEWRITE 4777 1.1 christos </pre> 4778 1.1 christos 4779 1.1 christos <a name="TOC_HEAD"><h3><u>*Changing the style for toc head entries</u></h3></a> 4780 1.1 christos <p> 4781 1.1 christos (See 4782 1.1 christos <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>). 4783 1.1 christos <p> 4784 1.1 christos Toc head entries are main heads that appear in the body of a 4785 1.1 christos document. 4786 1.1 christos <p> 4787 1.1 christos <pre> 4788 1.1 christos .TOC_HEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE) 4789 1.1 christos .TOC_HEAD_FONT default = bold 4790 1.1 christos .TOC_HEAD_SIZE default = +.5 4791 1.1 christos .TOC_HEAD_INDENT default = 18p for TYPESET; 2m for TYPEWRITE 4792 1.1 christos </pre> 4793 1.1 christos 4794 1.1 christos <a name="TOC_SUBHEAD"><h3><u>*Changing the style for toc subhead entries</u></h3></a> 4795 1.1 christos <p> 4796 1.1 christos (See 4797 1.1 christos <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>). 4798 1.1 christos <p> 4799 1.1 christos Toc subhead entries are subheads that appear in the body of a 4800 1.1 christos document. 4801 1.1 christos <p> 4802 1.1 christos <pre> 4803 1.1 christos .TOC_SUBHEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE) 4804 1.1 christos .TOC_SUBHEAD_FONT default = roman 4805 1.1 christos .TOC_SUBHEAD_SIZE default = +0 4806 1.1 christos .TOC_SUBHEAD_INDENT default = 30p for TYPESET; 4m for TYPEWRITE 4807 1.1 christos </pre> 4808 1.1 christos 4809 1.1 christos <a name="TOC_PARAHEAD"><h3><u>*Changing the style for toc paragraph head entries</u></h3></a> 4810 1.1 christos <p> 4811 1.1 christos (See 4812 1.1 christos <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>). 4813 1.1 christos <p> 4814 1.1 christos Toc paragraph head entries are paragraph heads that appear in the 4815 1.1 christos body of a document. 4816 1.1 christos <p> 4817 1.1 christos <pre> 4818 1.1 christos .TOC_PARAHEAD_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE) 4819 1.1 christos .TOC_PARAHEAD_FONT default = italic 4820 1.1 christos .TOC_PARAHEAD_SIZE default = +0 4821 1.1 christos .TOC_PARAHEAD_INDENT default = 42p for TYPESET; 6m for TYPEWRITE 4822 1.1 christos </pre> 4823 1.1 christos 4824 1.1 christos <a name="TOC_PN"><h3><u>*Changing the style for toc paragraph page number listings</u></h3></a> 4825 1.1 christos <p> 4826 1.1 christos (See 4827 1.1 christos <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>). 4828 1.1 christos <p> 4829 1.1 christos Toc paragraph head entries are paragraph heads that appear in the 4830 1.1 christos body of a document. 4831 1.1 christos <p> 4832 1.1 christos <pre> 4833 1.1 christos .TOC_PN_FAMILY default = prevailing doc family (Times Roman in TYPEWRITE) 4834 1.1 christos .TOC_PN_FONT default = roman 4835 1.1 christos .TOC_PN_SIZE default = +0 4836 1.1 christos </pre> 4837 1.1 christos 4838 1.1 christos <a name="TOC_ADDITIONAL"><h2><u>5. Additional toc macros</u></h2></a> 4839 1.1 christos <p> 4840 1.1 christos The following macros allow you to switch page margins should 4841 1.1 christos they be incorrect for recto/verso printing, to establish how 4842 1.1 christos many placeholders to leave for page listings, and to have 4843 1.1 christos <strong>mom</strong> append author(s) to toc title entries. 4844 1.1 christos <p> 4845 1.1 christos 4846 1.1 christos <hr width="33%" align="left"> 4847 1.1 christos 4848 1.1 christos <!---TOC_RV_SWITCH---> 4849 1.1 christos 4850 1.1 christos <p> 4851 1.1 christos <a name="TOC_RV_SWITCH"> 4852 1.1 christos Macro: <strong>TOC_RV_SWITCH</strong> 4853 1.1 christos </a> 4854 1.1 christos <p> 4855 1.1 christos <strong>TOC_RV_SWITCH</strong> doesn't take an argument. It simply 4856 1.1 christos instructs <strong>mom</strong> to switch the left and right margins 4857 1.1 christos of 4858 1.1 christos <a href="rectoverso.html#RECTO_VERSO">recto/verso</a> 4859 1.1 christos documents should the toc happen to begin on an even page when you 4860 1.1 christos want an odd, or vice versa. 4861 1.1 christos <p> 4862 1.1 christos The same result can be accomplished by outputting a 4863 1.1 christos <a href="#BLANK_PAGE">BLANKPAGE</a>. 4864 1.1 christos <p> 4865 1.1 christos 4866 1.1 christos <hr width="33%" align="left"> 4867 1.1 christos 4868 1.1 christos <!---TOC_TITLE_ENTRY---> 4869 1.1 christos 4870 1.1 christos <p> 4871 1.1 christos <a name="TOC_TITLE_ENTRY"> 4872 1.1 christos <nobr>Macro: <strong>TOC_TITLE_ENTRY</strong> <"alternate wording for a title entry in the toc"></nobr> 4873 1.1 christos </a> 4874 1.1 christos <p> 4875 1.1 christos In 4876 1.1 christos <a href="rectoverso.html#COLLATE">collated</a> 4877 1.1 christos documents, the title of each separate document appears in the table 4878 1.1 christos of contents. It may sometimes happen that you don't want the title 4879 1.1 christos as it appears in the toc to be the same as what appears in 4880 1.1 christos the 4881 1.1 christos <a href="definitions.html#TERMS_DOCHEADER">docheader</a>. 4882 1.1 christos You might, for example, want to shorten it. Or, in the case of 4883 1.1 christos chapters where the docheader contains both a chapter number and a 4884 1.1 christos chapter title, like this 4885 1.1 christos <p> 4886 1.1 christos <pre> 4887 1.1 christos Chapter 6 4888 1.1 christos Burning Bush -- Maybe God Was Right 4889 1.1 christos </pre> 4890 1.1 christos 4891 1.1 christos you might want only the chapter title, not the chapter number, to 4892 1.1 christos show up in the toc. (By default, <strong>TOC</strong> generates 4893 1.1 christos both.) 4894 1.1 christos <p> 4895 1.1 christos If you want to change the wording of a title entry in the toc, 4896 1.1 christos simply invoke <strong>TOC_TITLE_ENTRY</strong> with the desired 4897 1.1 christos wording, enclosed in double-quotes. Using the example, above, 4898 1.1 christos <p> 4899 1.1 christos <pre> 4900 1.1 christos .CHAPTER 6 4901 1.1 christos .CHAPTER_TITLE "Burning Bush -- Maybe God Was Right" 4902 1.1 christos .TOC_TITLE_ENTRY "Burning Bush" 4903 1.1 christos .DOCTYPE CHAPTER 4904 1.1 christos </pre> 4905 1.1 christos 4906 1.1 christos would identify chapter 6 in the toc simply as "Burning 4907 1.1 christos Bush". 4908 1.1 christos 4909 1.1 christos <p> 4910 1.1 christos 4911 1.1 christos <hr width="33%" align="left"> 4912 1.1 christos 4913 1.1 christos <!---TOC_APPENDS_AUTHOR---> 4914 1.1 christos 4915 1.1 christos <p> 4916 1.1 christos <a name="TOC_APPENDS_AUTHOR"> 4917 1.1 christos <nobr>Macro: <strong>TOC_APPENDS_AUTHOR</strong> <none> | <"name(s) of authors"></nobr> 4918 1.1 christos </a> 4919 1.1 christos <p> 4920 1.1 christos In certain kinds of collated documents, different authors are 4921 1.1 christos responsible for the articles or stories contained within them. In 4922 1.1 christos such documents, you may wish to have the author or authors 4923 1.1 christos appended to the toc's title entry for each story or article. 4924 1.1 christos <p> 4925 1.1 christos If you invoke <strong>TOC_APPENDS_AUTHOR</strong> with no argument, 4926 1.1 christos <strong>mom</strong> appends the first argument you passed to 4927 1.1 christos <a href="docprocessing.html#AUTHOR">AUTHOR</a> 4928 1.1 christos to toc title entries, separated by a front-slash. 4929 1.1 christos <p> 4930 1.1 christos If you invoke <strong>TOC_APPENDS_AUTHOR</strong> with an argument 4931 1.1 christos (surrounded by double-quotes), <strong>mom</strong> will append it 4932 1.1 christos to the toc title entries instead. This is useful if you have 4933 1.1 christos multiple authors you wish to identify by last name only. For 4934 1.1 christos example, if three authors--Joe Blough, Jane Doe, and John 4935 1.1 christos Deere--are responsible for a single article 4936 1.1 christos <p> 4937 1.1 christos <pre> 4938 1.1 christos .TOC_APPENDS_AUTHOR "Blough et al." 4939 1.1 christos </pre> 4940 1.1 christos 4941 1.1 christos would be a good way to identify them in the toc. 4942 1.1 christos <p> 4943 1.1 christos 4944 1.1 christos <hr width="33%" align="left"> 4945 1.1 christos 4946 1.1 christos <!---TOC_PADDING---> 4947 1.1 christos 4948 1.1 christos <p> 4949 1.1 christos <a name="TOC_PADDING"> 4950 1.1 christos <nobr>Macro: <strong>TOC_PADDING</strong> <# of placeholders to allow for page number listings></nobr> 4951 1.1 christos </a> 4952 1.1 christos <p> 4953 1.1 christos By default, <strong>mom</strong> allows room for 3 digits in the 4954 1.1 christos page number listings of tocs. If you'd like some other number of 4955 1.1 christos placeholders, say 2, do 4956 1.1 christos <p> 4957 1.1 christos <pre> 4958 1.1 christos .TOC_PADDING 2 4959 1.1 christos </pre> 4960 1.1 christos 4961 1.1 christos <!---FINIS---> 4962 1.1 christos 4963 1.1 christos <hr width="66%" align="left"> 4964 1.1 christos <p> 4965 1.1 christos <a name="FINIS"> 4966 1.1 christos Macro: <strong>FINIS</strong> 4967 1.1 christos </a> 4968 1.1 christos 4969 1.1 christos <p> 4970 1.1 christos The use of <strong>FINIS</strong> is optional, but if you use 4971 1.1 christos it, it should be the last macro you invoke in a document (before 4972 1.1 christos <a href="#ENDNOTES">ENDNOTES</a> 4973 1.1 christos or 4974 1.1 christos <a href="#TOC">TOC</a>). 4975 1.1 christos See 4976 1.1 christos <a href="#FINIS_INTRO">above</a> 4977 1.1 christos for a description of how <strong>FINIS</strong> behaves. 4978 1.1 christos <p> 4979 1.1 christos <strong>NOTE:</strong> If you don't use <strong>FINIS</strong>, 4980 1.1 christos and you don't want 4981 1.1 christos <a href="definitions.html#TERMS_FOOTER">footers</a> 4982 1.1 christos (if they're on) or a page number at the bottom of the last page of 4983 1.1 christos a document, you have to turn them off manually, as the last two 4984 1.1 christos lines of your document file, like this: 4985 1.1 christos <p> 4986 1.1 christos <pre> 4987 1.1 christos .FOOTERS OFF 4988 1.1 christos .PAGINATE OFF 4989 1.1 christos </pre> 4990 1.1 christos 4991 1.1 christos <a name="FINIS_STRING"><h3><u>Changing the FINIS string</u></h3></a> 4992 1.1 christos 4993 1.1 christos <p> 4994 1.1 christos By default, <strong>FINIS</strong> prints the word 4995 1.1 christos END between 4996 1.1 christos <a href="definitions.html#TERMS_EM">em-dashes</a>. 4997 1.1 christos If you'd like <strong>mom</strong> to print something else 4998 1.1 christos between the dashes, use the <strong>FINIS_STRING</strong> macro 4999 1.1 christos (anywhere in the document prior to <strong>FINIS</strong>). 5000 1.1 christos <p> 5001 1.1 christos For example, if your document's in French, you'd do 5002 1.1 christos <p> 5003 1.1 christos <pre> 5004 1.1 christos .FINIS_STRING "FIN" 5005 1.1 christos </pre> 5006 1.1 christos 5007 1.1 christos Double-quotes must enclose the macro's argument. 5008 1.1 christos <p> 5009 1.1 christos <strong>NOTE:</strong> If you pass <strong>FINIS_STRING</strong> 5010 1.1 christos a blank string, i.e. 5011 1.1 christos <p> 5012 1.1 christos <pre> 5013 1.1 christos .FINIS_STRING "" 5014 1.1 christos </pre> 5015 1.1 christos 5016 1.1 christos <strong>mom</strong> will still print the em-dashes if you 5017 1.1 christos invoke <strong>FINIS</strong>. This, in effect, produces a 5018 1.1 christos short, centred horizontal rule that terminates the document. 5019 1.1 christos (In 5020 1.1 christos <a href="docprocessing.html.#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 5021 1.1 christos it's a short, dashed line composed of four hyphens.) 5022 1.1 christos 5023 1.1 christos <a name="FINIS_COLOR"><h3><u>Changing the FINIS colour</u></h3></a> 5024 1.1 christos <p> 5025 1.1 christos Invoking <strong>FINIS_COLOR</strong> with a pre-defined (or 5026 1.1 christos "initalized") color changes the colour of both the FINIS 5027 1.1 christos string and the em-dashes that surround it. If you use the 5028 1.1 christos <a href="definitions.html#TERMS_INLINE">inline escape</a>, 5029 1.1 christos <a href="color.html#COLOR_INLINE">\*[<colorname>]</a>, 5030 1.1 christos in the argument passed to <strong>FINIS</strong>, only the text 5031 1.1 christos will be in the new colour; the em-dashes will be in the default 5032 1.1 christos document colour (usually black). 5033 1.1 christos 5034 1.1 christos <p> 5035 1.1 christos <hr> 5036 1.1 christos <a href="headfootpage.html#TOP">Next</a> 5037 1.1 christos <a href="docprocessing.html#TOP">Prev</a> 5038 1.1 christos <a href="#TOP">Top</a> 5039 1.1 christos <a href="toc.html">Back to Table of Contents</a> 5040 1.1 christos </body> 5041 1.1 christos </html> 5042
Indexes created Sun Jul 19 00:25:04 UTC 2026