contrib/mom/momdoc/docelement.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!--
   3 This file is part of groff, the GNU roff type-setting system.
   4
   5 Copyright (C) 2004-2014 Free Software Foundation, Inc.
   6 Written by Peter Schaffter (peter@schaffter.ca).
   7
   8 Permission is granted to copy, distribute and/or modify this document
   9 under the terms of the GNU Free Documentation License, Version 1.3 or
  10 any later version published by the Free Software Foundation; with the
  11 Invariant Sections being this comment section, with no Front-Cover
  12 Texts, and with no Back-Cover Texts.
  13
  14 A copy of the Free Documentation License is included as a file called
  15 FDL in the main directory of the groff source package.
  16 -->
  17
  18 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  19 <html xmlns="http://www.w3.org/1999/xhtml">
  20
  21 <head>
  22   <meta http-equiv="content-type" content="text/html;charset=utf-8"/>
  23   <title>Mom -- Document processing, element tags</title>
  24   <link rel="stylesheet" type="text/css" href="stylesheet.css" />
  25 </head>
  26
  27 <body style="background-color: #f5faff;">
  28
  29 <!-- ==================================================================== -->
  30
  31 <div id="top" class="page">
  32
  33 <!-- Navigation links -->
  34 <table style="width: 100%;">
  35 <tr>
  36   <td><a href="toc.html">Back to Table of Contents</a></td>
  37   <td style="text-align: right;"><a href="images.html#top">Next: Graphics, floats, preprocessor support</a></td>
  38 </tr>
  39 </table>
  40
  41 <h1 class="docs">The document element tags</h1>
  42
  43 <div style="width: 386px; margin: auto;">
  44 <ul class="no-enumerator">
  45   <li><a href="#docelement-intro">Introduction to the document element tags</a></li>
  46   <li><a href="#docelement-control">Control macros &ndash; changing the tag defaults</a>
  47   <ul style="margin-left: -.5em; list-style-type: disc;">
  48     <li><a href="#control-macro-args">Arguments to the control macros</a>
  49     <ul style="margin-left: -.5em; list-style-type: circle;">
  50       <li><a href="#family-and-font">family and font</a></li>
  51       <li><a href="#point-size">point size</a></li>
  52       <li><a href="#color">colour</a></li>
  53       <li><a href="#quad">quad/justification</a></li>
  54       <li><a href="#underline">underline style, rule weight</a></li>
  55     </ul></li>
  56   </ul></li>
  57 </ul>
  58 </div>
  59
  60 <div class="rule-medium"><hr/></div>
  61
  62 <h2 id="toc-doc-element" class="docs" style="text-align: center;">Document element tags table of contents</h2>
  63
  64 <div id="docelement-mini-toc" style="font-size: 100%; line-height: 150%; margin-top: .5em;">
  65 <div class="mini-toc-col-1" style="margin-left: 0;">
  66 <h3 class="toc toc-docproc-header" style="margin-top: 1em;"><a class="header-link" href="#epigraph-intro">Epigraphs</a></h3>
  67 <ul class="toc-docproc" style="margin-top: .5em;">
  68   <li><a href="#epigraph">EPIGRAPH</a></li>
  69   <li><a href="#epigraph-control">Epigraph control</a></li>
  70 </ul>
  71 <h3 class="toc toc-docproc-header"><a class="header-link" href="#pp-intro">Paragraphs</a></h3>
  72 <ul class="toc-docproc" style="margin-top: .5em;">
  73   <li><a href="#pp">PP</a></li>
  74   <li><a href="#pp-control">Paragraph control</a></li>
  75 </ul>
  76 <h3 class="toc toc-docproc-header"><a class="header-link" href="#heading-intro">Headings</a></h3>
  77 <ul class="toc-docproc" style="margin-top: .5em;">
  78   <li><a href="#heading">HEADING</a></li>
  79   <li><a href="#heading-control">Heading control</a></li>
  80   <li><a href="#oldstyle-headings-intro">Oldstyle headings</a></li>
  81 </ul>
  82 <h3 class="toc toc-docproc-header"><a class="header-link" href="#linebreak-intro">Linebreaks (section breaks)</a></h3>
  83 <ul class="toc-docproc" style="margin-top: .5em;">
  84   <li><a href="#linebreak">LINEBREAK</a></li>
  85   <li><a href="#linebreak-control">Linebreak control</a></li>
  86 </ul>
  87 <h3 class="toc toc-docproc-header"><a class="header-link" href="#quote-intro">Quotes (line for line; poetry or code)</a></h3>
  88 <ul class="toc-docproc" style="margin-top: .5em;">
  89   <li><a href="#quote">QUOTE</a></li>
  90   <li><a href="#quote-control">Quote control</a></li>
  91 </ul>
  92 <h3 class="toc toc-docproc-header"><a class="header-link" href="#blockquote-intro">Blockquotes (cited material)</a></h3>
  93 <ul class="toc-docproc" style="margin-top: .5em;">
  94   <li><a href="#blockquote">BLOCKQUOTE</a></li>
  95   <li><a href="#blockquote-control">Blockquote control</a></li>
  96 </ul>
  97 <h3 class="toc toc-docproc-header"><a class="header-link" href="#code-intro">Inserting code snippets</a></h3>
  98 <ul class="toc-docproc" style="margin-top: .5em;">
  99   <li><a href="#code">CODE</a></li>
 100   <li><a href="#code-control">Code control</a></li>
 101 </ul>
 102 </div>
 103 <div class="mini-toc-col-2" style="margin-top: 1.5em;">
 104 <h3 class="toc toc-docproc-header"><a class="header-link" href="#list-intro">Nested lists</a></h3>
 105 <ul class="toc-docproc" style="margin-top: .5em;">
 106   <li><a href="#list">LIST</a></li>
 107   <li><a href="#item">ITEM</a></li>
 108   <li><a href="#list-control">List control</a></li>
 109 </ul>
 110 <h3 class="toc toc-docproc-header"><a class="header-link" href="#number-lines-intro">Line numbering</a></h3>
 111 <ul class="toc-docproc" style="margin-top: .5em;">
 112   <li><a href="#number-lines">NUMBER_LINES</a></li>
 113   <li><a href="#number-lines-control">Line numbering control</a></li>
 114 </ul>
 115 <h3 class="toc toc-docproc-header"><a class="header-link" href="#footnote-intro">Footnotes</a></h3>
 116 <ul class="toc-docproc" style="margin-top: .5em;">
 117   <li><a href="#footnote">FOOTNOTE</a></li>
 118   <li><a href="#footnote-control">Footnote control</a></li>
 119 </ul>
 120 <h3 class="toc toc-docproc-header"><a class="header-link" href="#endnote-intro">Endnotes</a></h3>
 121 <ul class="toc-docproc" style="margin-top: .5em;">
 122   <li><a href="#endnote">ENDNOTE</a></li>
 123   <li><a href="#endnote-control">Endnote control</a></li>
 124 </ul>
 125 <h3 class="toc toc-docproc-header"><a class="header-link" href="#margin-notes-intro">Margin notes</a></h3>
 126 <ul class="toc-docproc" style="margin-top: .5em;">
 127   <li><a href="#mn-init">MN_INIT (set margin notes parameters)</a></li>
 128   <li><a href="#mn">MN</a></li>
 129 </ul>
 130 <h3 class="toc toc-docproc-header"><a class="header-link" href="#finis-intro">Document termination string</a></h3>
 131 <ul class="toc-docproc" style="margin-top: .5em;">
 132   <li><a href="#finis">FINIS</a></li>
 133   <li><a href="#finis-control">Finis control</a></li>
 134 </ul>
 135 </div>
 136 </div>
 137
 138 <div class="rule-medium" style="clear: both;"><hr/></div>
 139
 140 <h2 id="docelement-intro" class="docs">Introduction to the document element tags</h2>
 141
 142 <p>
 143 Once you&#8217;ve completed the setup for a document (see
 144 <a href="docprocessing.html#docprocessing-tut">Setting up a mom document</a>),
 145 formatting it is a snap.  Simply invoke the appropriate tag for
 146 each document element as you need it.  The tags are macros that
 147 tell mom: &#8220;This is a paragraph; this is a heading; this is a
 148 footnote,&#8221; and so on.
 149 </p>
 150
 151 <p>
 152 Generally, for each tag, there are
 153 <a href="definitions.html#controlmacro">control macros</a>
 154 for the tag&#8217;s family, font and point size.  Where appropriate,
 155 there are macros to control leading, indents, quad and special
 156 features as well.
 157 Mom has tasteful defaults for all the tags, hence you only use the
 158 control macros when you want to change the way she does things.
 159 This is usually done prior to
 160 <a href="docprocessing.html#start">START</a>,
 161 but can, in fact, be done at any time in the course of a document.
 162 Any change to a tag&#8217;s style affects all subsequent invocations
 163 of the tag.
 164 </p>
 165
 166 <h2 id="docelement-control" class="docs">Control macros &ndash; changing the tag defaults</h2>
 167
 168 <p>
 169 The control macros for document processing tags let you design the
 170 look of all the parts of your documents&mdash;should you wish.  At
 171 a bare minimum, all tags have macros to change mom&#8217;s defaults
 172 for family, font, point size and colour.  Where appropriate, there
 173 are macros to control leading, indents and quad as well.
 174 </p>
 175
 176 <p>
 177 In addition, many tags have special macros to control features that
 178 are pertinent to those tags alone.  Have a look at the section
 179 dealing with any particular tag to find out what macros control the
 180 tag, and what mom&#8217;s defaults for the tag are.
 181 </p>
 182
 183 <p>
 184 The control macros may be used at any time during the course of a
 185 document (ie before or after
 186 <a href="docprocessing.html#start">START</a>).
 187 The changes you make alter all subsequent invocations of the
 188 affected tag until you make another change, either by passing new
 189 arguments to the tag&#8217;s control macro, or toggling a particular
 190 feature of the tag on or off.
 191 </p>
 192
 193 <p>
 194 And don&#8217;t forget: the
 195 <a href="typesetting.html#macros-typesetting">typesetting macros</a>
 196 can be used at any time, including inside
 197 <a href="definitions.html#toggle">toggle</a>
 198 tags (affecting only that particular invocation of the tag).
 199 Equally,
 200 <a href="definitions.html#inlines">inline escapes</a>
 201 can be used in tags that take
 202 <a href="definitions.html#stringargument">string arguments.</a>
 203 </p>
 204
 205 <div class="box-tip">
 206 <p class="tip">
 207 <span class="tip">Tip:</span>
 208 Get familiar with mom at her default settings before exploring the
 209 control macros.  Put her through her paces.  See how she behaves.
 210 Get to know what she feels like and how she looks, both in your
 211 text editor and on the printed page.  Then, if you don&#8217;t like
 212 something, use this documentation to find the precise macro you need
 213 to change it.  There are tons of control macros.  Reading up on them
 214 and trying to remember them all might lead you to think that mom is
 215 complex and unwieldy, which is not only untrue, but would offend her
 216 mightily.
 217 </p>
 218 </div>
 219
 220 <div class="box-important">
 221 <p class="tip-top">
 222 <span class="important">Important:</span>
 223 The family, font, point size, colour and leading control macros have
 224 no effect in
 225 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>,
 226 except where noted throughout this documentation.
 227 </p>
 228
 229 <p class="tip-bottom">
 230 Please also note that the defaults listed with the control macros
 231 apply only to
 232 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>
 233 unless a default for <kbd>TYPEWRITE</kbd> is also given.
 234 </p>
 235 </div>
 236
 237 <h3 id="control-macro-args" class="docs">Arguments to the control macros</h3>
 238
 239 <h4 id="family-and-font" class="docs" style="margin-top: 1em; margin-bottom: -.75em;">Family and font</h4>
 240
 241 <p>
 242 The arguments to the control macros that end in _FAMILY or _FONT are
 243 the same as for
 244 <a href="typesetting.html#family">FAMILY</a>
 245 and
 246 <a href="typesetting.html#font">FT</a>.
 247 </p>
 248
 249 <h4 id="point-size" class="docs" style="margin-top: -.5em; margin-bottom: -.75em;">Point size</h4>
 250
 251 <p>
 252 Control macros that end in _SIZE always take
 253 the form <kbd>+&lt;n&gt;</kbd> or <kbd>-&lt;n&gt;</kbd> where
 254 &lt;n&gt; is the number of
 255 <a href="definitions.html#picaspoints">points</a>
 256 larger (+) or smaller (-) than the point size of paragraphs
 257 you want the document element to be.  For example, to set
 258 blockquotes 2 points smaller than the type in paragraphs, do
 259 <br/>
 260 <span class="pre-in-pp">
 261   .BLOCKQUOTE_SIZE -2
 262 </span>
 263 There&#8217;s no need for a
 264 <a href="definitions.html#unitofmeasure">unit of measure</a>
 265 with the _SIZE control macros; points is assumed.
 266 </p>
 267
 268 <h4 id="color" class="docs" style="margin-top: -.5em; margin-bottom: -.75em;">Colour</h4>
 269
 270 <p>
 271 Control macros that end in _COLOR take as their argument a colour
 272 name pre-defined (or &#8220;initialized&#8221;) with
 273 <a href="color.html#newcolor">NEWCOLOR</a>
 274 or
 275 <a href="color.html#xcolor">XCOLOR</a>.
 276 For example, if you want your
 277 <a href="#linebreak">author linebreaks</a>
 278 to be red, once you&#8217;ve defined or initialized the colour, red,
 279 <br/>
 280 <span class="pre-in-pp">
 281   .LINEBREAK_COLOR red
 282 </span>
 283 will turn them red.
 284 </p>
 285
 286 <h4 id="lead" class="docs" style="margin-top: -.5em; margin-bottom: -.75em;">Lead/linespacing</h4>
 287
 288 <p>
 289 Control macros that end in _AUTOLEAD take the same argument as
 290 <a href="typesetting.html#autolead">AUTOLEAD</a>,
 291 <i>viz.</i> a digit that represents the number of points to add to
 292 the tag&#8217;s point size to arrive at its
 293 <a href="definitions.html#leading">leading</a>.
 294 For example, to set footnotes
 295 <a href="definitions.html#solid">solid</a>, do
 296 <br/>
 297 <span class="pre-in-pp">
 298   .FOOTNOTE_AUTOLEAD 0
 299 </span>
 300 To set footnotes with a 1-point lead (ie with the line spacing
 301 one point greater than the footnote&#8217;s point size), do
 302 <br/>
 303 <span class="pre-in-pp">
 304   .FOOTNOTE_AUTOLEAD 1
 305 </span>
 306 </p>
 307
 308 <div class="box-tip" style="margin-top: -1.25em;">
 309 <p class="tip">
 310 <span class="note">Note:</span>
 311 _AUTOLEAD control macros do not have a <kbd>FACTOR</kbd> argument.
 312 </p>
 313 </div>
 314
 315
 316 <h4 id="control-indents" class="docs" style="margin-top: -.75em; margin-bottom: -.75em;">Indents</h4>
 317
 318 <p>
 319 Except for
 320 <a href="#para-indent">PARA_INDENT</a>,
 321 the argument to control macros that end in _INDENT can take
 322 either a single numeral (whole numbers only, no decimal fractions)
 323 <i>without</i> a
 324 <a href="definitions.html#unitofmeasure">unit of measure</a>
 325 appended to it, or a digit (including decimal fractions) <i>with</i>
 326 a unit of measure appended.
 327 </p>
 328
 329 <p>
 330 A digit <i>without</i> a unit of measure appended represents by
 331 how much you want your paragraph first-line indents (set with
 332 PARA_INDENT) multiplied to achieve the correct indent for a
 333 particular tag.  For example,
 334 <br/>
 335 <span class="pre-in-pp">
 336   .PARA_INDENT       2m
 337   .BLOCKQUOTE_INDENT 2
 338 </span>
 339 means that blockquotes will be indented from the left and right
 340 margins by twice the size of the paragraph indent, or 4
 341 <a href="definitions.html#em">ems</a>.
 342 </p>
 343
 344 <p>
 345 A digit <i>with</i> a unit of measure appended defines an absolute
 346 indent, relative to nothing.  In the following, blockquotes will be
 347 indented by 3
 348 <a href="definitions.html#picaspoints">picas</a>
 349 and 6
 350 <a href="definitions.html#picaspoints">points</a>,
 351 regardless of the paragraph indent.
 352 <br/>
 353 <span class="pre-in-pp">
 354   .PARA_INDENT       2m
 355   .BLOCKQUOTE_INDENT 3P+6p
 356 </span>
 357 </p>
 358
 359 <h4 id="quad" class="docs" style="margin-top: -1em; margin-bottom: -.75em;">Quad/justification style</h4>
 360
 361 <p>
 362 Control macros that end in _QUAD take the same arguments as
 363 <a href="typesetting.html#quad">QUAD</a>.
 364 </p>
 365
 366 <h4 id="underline" class="docs" style="margin-bottom: -.75em;">Underline style, rule weight</h4>
 367
 368 <p>
 369 If mom gives the option to underline a document element, the weight
 370 of the underline and its distance from the
 371 <a href="definitions.html#baseline">baseline</a>
 372 are controlled by macros that end in _UNDERLINE.
 373 </p>
 374
 375 <p>
 376 Page elements that are separated from
 377 <a href="definitions.html#running">running text</a>
 378 by a rule (ie page headers, page footers and footnotes) are
 379 controlled by macros that end in _RULE_WEIGHT.
 380 </p>
 381
 382 <p>
 383 The weight argument to _UNDERLINE macros is the same as the argument
 384 to
 385 <a href="inlines.html#rule-weight">RULE_WEIGHT</a>,
 386 as is the argument to _RULE_WEIGHT macros.
 387 </p>
 388
 389 <div class="rule-short"><hr/></div>
 390
 391 <!-- ==================================================================== -->
 392
 393 <h2 id="epigraph-intro" class="macro-group">Epigraphs</h2>
 394
 395 <ul style="margin-left: -.5em;">
 396   <li><a href="#epigraph">Tag: EPIGRAPH</a></li>
 397   <li><a href="#epigraph-control">Epigraph control macros and defaults</a></li>
 398 </ul>
 399
 400 <p>
 401 <a href="definitions.html#epigraph">Epigraphs</a>
 402 colour, flavour, or comment on the document they precede.
 403 Typically, they are centred at the top of a document&#8217;s first page
 404 (underneath the title) and set in a smaller point size than that of
 405 paragraph text.
 406 </p>
 407
 408 <p>
 409 By default, mom sets epigraphs centred and
 410 <a href="definitions.html#filled">unfilled</a>;
 411 this lets you input them on a line for line basis.  This behaviour
 412 can be changed to accomodate
 413 <a href="definitions.html#filled">filled</a>
 414 epigraph &#8220;blocks.&#8221;
 415 </p>
 416
 417 <!-- -EPIGRAPH- -->
 418
 419 <div class="macro-id-overline">
 420 <h3 id="epigraph" class="macro-id">EPIGRAPH</h3>
 421 </div>
 422
 423 <div class="box-macro-args">
 424 Macro: <b>EPIGRAPH</b> <kbd class="macro-args">&lt;toggle&gt; | [ BLOCK ]</kbd>
 425 </div>
 426
 427 <p>
 428 EPIGRAPH is a toggle, used like this:
 429 <br/>
 430 <span class="pre-in-pp">
 431   .EPIGRAPH
 432   &lt;text of epigraph&gt;
 433   .EPIGRAPH OFF
 434 </span>
 435 <kbd>OFF</kbd>, above, could be anything&mdash;say, <kbd>Q</kbd> or
 436 <kbd>X</kbd>&mdash;since any argument other than <kbd>BLOCK</kbd>
 437 turns it off.
 438 </p>
 439
 440 <p>
 441 If given the argument, <kbd>BLOCK</kbd>, EPIGRAPH sets epigraphs
 442 <a href="definitions.html#filled">filled</a>,
 443 justified or quadded in the same direction as paragraphs, indented
 444 equally from both the left and right margins.
 445 </p>
 446
 447 <p>
 448 If a block-style epigraph runs to more than one paragraph (unlikely,
 449 but conceivable), you must introduce every paragraph&mdash;including
 450 the first&mdash;with the
 451 <a href="#pp">PP</a>
 452 tag.
 453 </p>
 454
 455 <div class="box-tip">
 456 <p class="tip">
 457 <span class="note">Note:</span>
 458 EPIGRAPH should only be used at the top of a document (ie just
 459 after
 460 <a href="docprocessing.html#start">START</a>)
 461 or after headings.  The latter is not especially recommended, but it
 462 does work.  In all other places where you want quotes or cited text,
 463 use
 464 <a href="#quote">QUOTE</a>
 465 or
 466 <a href="#blockquote">BLOCKQUOTE</a>.
 467 </p>
 468 </div>
 469
 470 <div class="box-tip">
 471 <p class="tip">
 472 <span class="tip">Tip:</span>
 473 If you&#8217;re setting a document in
 474 <a href="docprocessing.html#columns">columns</a>
 475 and you&#8217;d like to add or subtract space after the epigraph,
 476 the place to do it is inside the epigraph, like this:
 477 <br/>
 478 <span class="pre-in-pp">
 479   .EPIGRAPH
 480   A notable quote.
 481   .SP 1v
 482   .EPIGRAPH OFF
 483 </span>
 484 If you were to add the <kbd>.SP 1v</kbd> outside the epigraph, the
 485 space would be added to the top of the leftmost column only,
 486 resulting in unbalanced columns.
 487 </p>
 488 </div>
 489
 490 <div class="defaults-container" style="padding-bottom: 8px;">
 491 <h3 id="epigraph-control" class="docs defaults" style="margin-top: -.25em;">EPIGRAPH control macros and defaults</h3>
 492
 493 <p class="defaults">
 494 See
 495 <a href="#control-macro-args">Arguments to the control macros</a>.
 496 </p>
 497
 498 <span class="pre defaults">
 499 .EPIGRAPH_FAMILY    default = prevailing document family; default is Times Roman
 500 .EPIGRAPH_FONT      default = roman
 501 .EPIGRAPH_SIZE      default = -1.5 (points)
 502 .EPIGRAPH_COLOR     default = black
 503 .EPIGRAPH_AUTOLEAD  default = 2 points
 504
 505 (The next two apply to &#8220;block&#8221; style epigraphs only)
 506
 507 .EPIGRAPH_QUAD      default = same as paragraphs
 508 .EPIGRAPH_INDENT*  (see Note on EPIGRAPH_INDENT, below)
 509
 510 *Indent here refers to the indent from both the left and right margins
 511  that centres block style epigraphs on the page.
 512 </span>
 513 </div>
 514
 515 <div class="box-notes">
 516 <h3 id="epigraph-indent" class="docs notes" style="margin-bottom: -.75em;">Note on EPIGRAPH_INDENT</h3>
 517
 518 <p style="margin-top: .5em;">
 519 If you pass EPIGRAPH_INDENT an integer with no unit of measure
 520 appended, the integer represents the amount by which to multiply
 521 PARA_INDENT to arrive at an indent for block style epigraphs.  If
 522 you append a unit of measure to the argument, the indent will be
 523 precisely the amount specified.
 524 </p>
 525
 526 <p>
 527 Please also note that if your PARA_INDENT is <kbd>0</kbd> (ie
 528 no indenting of the first line of paragraphs), you must set an
 529 EPIGRAPH_INDENT yourself, with a unit of measure appended to the
 530 argument.  Mom has no default for EPIGRAPH_INDENT if paragraph first
 531 lines are not being indented.
 532 </p>
 533
 534 <p class="tip-bottom">
 535 The default value for EPIGRAPH_INDENT is <kbd>3</kbd> (for
 536 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPESET</a>)
 537 and <kbd>2</kbd> (for
 538 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>).
 539 </p>
 540 </div>
 541
 542 <div class="rule-short"><hr/></div>
 543
 544 <!-- ==================================================================== -->
 545
 546 <h2 id="pp-intro" class="macro-group">Paragraphs</h2>
 547
 548 <ul style="margin-left: -.5em;">
 549   <li><a href="#pp">Tag: PP</a></li>
 550   <li><a href="#pp-control">Paragraph control macros and defaults</a></li>
 551 </ul>
 552
 553 <p>
 554 The paragraph macro is the one you use most often.  Consequently,
 555 it&#8217;s one of most powerful, yet simplest to use&mdash;just the
 556 letters PP.  No arguments, nothing.  Just <kbd>.PP</kbd> on a line
 557 by itself any time, in any document element, tells mom you want to
 558 start a new paragraph.  The spacing and indent appropriate to where
 559 you are in your document are taken care of automatically.
 560 </p>
 561
 562 <p>
 563 By default, mom does not indent the first paragraph of a document,
 564 nor paragraphs that fall immediately after headings.  The first
 565 paragraphs of blockquotes and block-style epigraphs are also not
 566 indented.  This behaviour can be changed with the control macro
 567 <kbd><a href="#para-indent-first">INDENT_FIRST_PARAS</a></kbd>.
 568 </p>
 569
 570 <p>
 571 Mom does not deposit a blank line between paragraphs.  If you want
 572 her to do so, use the control macro
 573 <a href="#pp-space">PARA_SPACE</a>.
 574 (I don&#8217;t recommend using this macro with
 575 <a href="typesetting.html#printstyle">PRINTSTYLE TYPEWRITE</a>.)
 576 </p>
 577
 578 <div class="box-tip">
 579 <p class="tip">
 580 <span class="tip">Tip:</span>
 581 If you want to add less than a full linespace between
 582 paragraphs, you may give the amount of space you&#8217;d like as an
 583 argument to
 584 <kbd>.PARA_SPACE</kbd>.
 585 </span>
 586 Introducing a paragraph with <kbd>.PP2</kbd> will add a space equal
 587 to one-quarter of the prevailing linespace before the start of the
 588 paragraph.  Initial paragraphs, ie those at the start of a document,
 589 or after a heading or
 590 <a href="#linebreak-intro">linebreak</a>,
 591 should still be introduced with
 592 <kbd>.PP</kbd>.
 593 </div>
 594
 595 <p>
 596 Note that mom does not provide widow or orphan control for
 597 paragraphs (ie even if only one line of a paragraph fits at the
 598 bottom of a page, she will set it on that page).  The reason for
 599 this is that writers of fiction often have single-line paragraphs
 600 (eg in dialogue).  Groff&#8217;s simplistic orphan control will
 601 break these one-liners&mdash;if they fall at the bottom of the
 602 page&mdash;to a new page, which is not what you want.
 603 </p>
 604
 605 <div class="box-tip">
 606 <p class="tip-top">
 607 <span class="tip">Tip:</span>
 608 The last thing you want while you&#8217;re writing and editing
 609 drafts of a document (particularly stories and chapters) is a
 610 text file cluttered up with <kbd>.PP</kbd>&#8217;s. The visual
 611 interruption in the flow of text is a serious obstacle to creativity
 612 and critiquing.
 613 </p>
 614
 615 <p>
 616 I use the tab key on my keyboard to indent paragraphs by four spaces
 617 when I'm writing, producing a text file that looks pretty much like
 618 what you see on a printed page.  When it comes time to format and
 619 print the file, I run it through a sed script that (amongst other
 620 things) converts the intial four spaces into <kbd>.PP</kbd> (plus a
 621 new line) and pipes the output to groff for processing and printing.
 622 </p>
 623
 624 <p class="tip-bottom">
 625 Another solution would be to insert a blank line between paragraphs
 626 of your text files.  The blank lines can then be sedded out at
 627 print time, as above (<kbd>.PP</kbd> plus a newline), or, more
 628 conveniently, you could use the <kbd>.blm</kbd>
 629 <a href="definitions.html#primitives">primitive</a>
 630 (blank line macro) to tell groff (and mom) that blank lines should
 631 be interpreted as PP&#8217;s.
 632 <br/>
 633 <span class="pre-in-pp">
 634   .blm PP
 635 </span>
 636 tells groff that blank lines are really the macro PP.
 637 </p>
 638 </div>
 639
 640 <!-- -PP- -->
 641
 642 <div class="macro-id-overline">
 643 <h3 id="pp" class="macro-id">PP</h3>
 644 </div>
 645
 646 <div class="box-macro-args">
 647 Macro: <b>PP</b>
 648 </div>
 649 <p>
 650 <kbd>.PP</kbd> (on a line by itself, of course) tells mom to start a
 651 new paragraph.  See
 652 <a href="#pp-intro">above</a>
 653 for more details.  In addition to regular text paragraphs, you can
 654 use PP in
 655 <a href="#epigraph-intro">epigraphs</a>,
 656 <a href="#blockquote-intro">blockquotes</a>,
 657 <a href="#endnote-intro">endnotes</a>
 658 and
 659 <a href="#footnote-intro">footnotes</a>.
 660 </p>
 661
 662 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
 663 <h3 id="pp-control" class="docs defaults">PP control macros and defaults</h3>
 664
 665 <p class="defaults">
 666 The PP macro being so important, and representing, as it were, the
 667 basis of everything that goes on in a document, its control is
 668 managed in a manner somewhat different from other document element
 669 tags.
 670 </p>
 671 <ol style="margin-top: .5em; padding-bottom: .5em;">
 672   <li><a href="#pp-family">Family control</a></li>
 673   <li><a href="#pp-font">Font control</a></li>
 674   <li><a href="#pp-color">Paragraph colour</a></li>
 675   <li><a href="#pp-leading">Leading/linespacing control</a></li>
 676   <li><a href="#pp-just-quad">Justification/quad control</a></li>
 677   <li><a href="#para-indent">First-line indent control</a></li>
 678   <li><a href="#para-indent-first">Initial paragraphs indent control</a></li>
 679   <li><a href="#pp-space">Inter-paragraph spacing</a></li>
 680 </ol>
 681 </div>
 682
 683 <h4 id="pp-family" class="docs" style="margin-top: -1.5em;">1. Family control</h4>
 684
 685 <p>
 686 The paragraph
 687 <a href="definitions.html#family">family</a>
 688 is set with
 689 <a href="typesetting.html#family">FAMILY</a>
 690 prior to
 691 <a href="docprocessing.html#start">START</a>,
 692 or
 693 <a href="docprocessing.html#doc-family">DOC_FAMILY</a>
 694 afterwards.  Please note that both globally affect the family of
 695 every element in the document.
 696 </p>
 697
 698 <p>
 699 If you wish to change the family for regular text paragraphs only,
 700 invoke <kbd>.FAMILY</kbd> immediately after <kbd>.PP</kbd> in every
 701 paragraph whose family you wish to differ from the prevailing
 702 document family.  Alternatively, set the family and font for
 703 paragraphs with PP_FONT, giving it a complete family+font name, eg
 704 <br/>
 705 <span class="pre-in-pp">
 706   PP_FONT TI
 707 </span>
 708 which would make the font used in paragraphs Times Roman Italic.
 709 </p>
 710
 711 <p>
 712 Mom&#8217;s default paragraph (and document) family is Times Roman.
 713 </p>
 714
 715 <div class="box-tip">
 716 <p class="tip">
 717 <span class="note">Note:</span>
 718 Neither FAMILY nor DOC_FAMILY has any effect when the PRINTSTYLE is
 719 <kbd>TYPEWRITE</kbd>.
 720 </p>
 721 </div>
 722
 723 <h4 id="pp-font" class="docs" style="margin-top: -.25em;">2. Font control</h4>
 724
 725 <p>
 726 To change the
 727 <a href="definitions.html#font">font</a>
 728 used in regular text paragraphs, use PP_FONT, which takes the same
 729 argument as
 730 <a href="typesetting.html#font">FT</a>.
 731 PP_FONT may be used before or after
 732 <a href="docprocessing.html#start">START</a>.
 733 Only regular text paragraphs are affected; paragraphs in
 734 <a href="#epigraph-intro">epigraphs</a>,
 735 <a href="#blockquote-intro">blockquotes</a>,
 736 <a href="#endnote-intro">endnotes</a>,
 737 and
 738 <a href="#footnote-intro">footnotes</a>
 739 remain at their default setting (medium roman) unless you change
 740 them with the appropriate control macros.
 741 </p>
 742
 743 <p>
 744 Mom&#8217;s default paragraph font is medium roman.
 745 </p>
 746
 747 <div class="box-tip">
 748 <p class="tip">
 749 <span class="note">Note:</span>
 750 PP_FONT has no effect when the PRINTSTYLE is <kbd>TYPEWRITE</kbd>.
 751 If you wish to set whole typewritten paragraphs in italic, invoke
 752 invoke <kbd>.FT I</kbd> immediately after <kbd>.PP</kbd>.  Depending
 753 on which of
 754 <a href="docprocessing.html#printstyle-italics">UNDERLINE_ITALIC</a>
 755 or
 756 <a href="docprocessing.html#printstyle-italics">ITALIC_MEANS_ITALIC</a>
 757 is currently enabled, the paragraph will be set underlined or in
 758 italic.  Neither persists past the end of the paragraph.
 759 </p>
 760 </div>
 761
 762 <h4 id="pp-color" class="docs" style="margin-top: -.25em;">3. Paragraph colour</h4>
 763
 764 <p>
 765 Mom has no special control macro for colourizing paragraphs.  If you
 766 wish a colourized paragraph, you must use the macro,
 767 <a href="color.html#color">COLOR</a>,
 768 or the
 769 <a href="definitions.html#inline">inline escape</a>,
 770 <a href="color.html#color-inline"><kbd>\*[&lt;colourname&gt;]</kbd></a>,
 771 <i>after</i> <kbd>.PP</kbd>.  The colour must be one pre-defined (or
 772 &#8220;initialized&#8221;) with
 773 <a href="color.html#newcolor">NEWCOLOR</a>
 774 or
 775 <a href="color.html#xcolor">XCOLOR</a>.
 776 </p>
 777
 778 <p>
 779 Please note that unless you change the colour back to it&#8217;s
 780 default (usually black) at the end of the paragraph, all subsequent
 781 paragraphs will be set in the new colour, although most other
 782 elements of your document will continue to be set in the default
 783 colour (usually black).
 784 </p>
 785
 786 <p>
 787 For example, assuming you have defined the colour, blue,
 788 <br/>
 789 <span class="pre-in-pp">
 790   .PP
 791   .COLOR blue
 792   &lt;first paragraph&gt;
 793   .HEADING 1 "Monty Python"
 794   .HEADING 2 "The Origins of Spam"
 795   .PP
 796   &lt;second paragraph&gt;
 797 </span>
 798 the first paragraph will be blue, the head and subhead will be in
 799 the document&#8217;s default colour (usually black), and the second
 800 paragraph will be in blue.
 801 </p>
 802
 803 <h4 id="pp-leading" class="docs" style="margin-top: -.25em;">4. Leading</h4>
 804
 805 <p>
 806 The paragraph
 807 <a href="definitions.html#leading">leading</a>
 808 is set with
 809 <a href="typesetting.html#leading">LS</a>
 810 prior to
 811 <a href="docprocessing.html#start">START</a>,
 812 or
 813 <a href="docprocessing.html#doc-lead">DOC_LEAD</a>
 814 afterwards.  Please note that either method globally affects the
 815 leading and spacing of every document element (except
 816 <a href="definitions.html#header">headers</a>
 817 and
 818 <a href="definitions.html#footer">footers</a>).
 819 </p>
 820
 821 <p>
 822 If you wish to change the leading of regular text paragraphs only,
 823 invoke <kbd>.LS</kbd> immediately after <kbd>.PP</kbd> in every
 824 paragraph whose leading you wish to change.
 825 </p>
 826
 827 <div class="box-tip">
 828 <p class="tip">
 829 <span class="note">Warning:</span>
 830 It is extremely unwise to change a paragraph&#8217;s leading with LS as
 831 it will, in all cases, screw up mom&#8217;s ability to balance
 832 the bottom margin of pages.  Should you absolutely need to change
 833 paragraph leading with LS, and subsequently want mom to get back on
 834 the right leading track, use the
 835 <a href="docprocessing.html#shim">SHIM</a>
 836 macro.
 837 </p>
 838 </div>
 839
 840 <p>
 841 Mom&#8217;s default paragraph leading (document leading)
 842 is 16 points, adjusted to fill the page.
 843 </p>
 844
 845 <h4 id="pp-just-quad" class="docs" style="margin-top: -.25em;">5. Justification/quad</h4>
 846
 847 <p>
 848 The justification/quad-direction of regular text paragraphs (ie
 849 <a href="definitions.html#just">justified</a>,
 850 or
 851 <a href="definitions.html#filled">filled</a>
 852 and
 853 <a href="definitions.html#quad">quadded</a>
 854 left/right/centre) is set with
 855 <a href="typesetting.html#justify">JUSTIFY</a>
 856 or
 857 <a href="typesetting.html#quad">QUAD</a>
 858 prior to
 859 <a href="docprocessing.html#start">START</a>,
 860 and with
 861 <a href="docprocessing.html#doc-quad">DOC_QUAD</a>
 862 afterwards.
 863 </p>
 864
 865 <p>
 866 Please note that either method of setting the paragraph
 867 justification/quad-direction also affects
 868 <a href="#epigraph-intro">epigraphs</a>,
 869 <a href="#footnote-intro">footnotes</a>,
 870 and
 871 <a href="#endnote-intro">endnotes</a>,
 872 but not
 873 <a href="#blockquote-intro">blockquotes</a>
 874 (whose default is quad left unless you change it with
 875 <a href="#blockquote">BLOCKQUOTE_QUAD</a>).
 876 The justification/quad-direction of epigraphs and footnotes may be
 877 changed with their own control macros.
 878 </p>
 879
 880 <p>
 881 If you wish to change the justification/quad-direction of individual
 882 paragraphs, invoke
 883 <a href="typesetting.html#justify"><kbd>.JUSTIFY</kbd></a>
 884 or
 885 <a href="typesetting.html#quad"><kbd>.QUAD</kbd></a>
 886 on the line immediately after <kbd>.PP</kbd>.  Only the paragraph
 887 in question gets justified or quadded differently; subsequent
 888 paragraphs remain unaffected.
 889 </p>
 890
 891 <p>
 892 Mom&#8217;s default justification/quad-direction for paragraphs
 893 when the
 894 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>
 895 is <kbd>TYPESET</kbd> is justified; for PRINTSTYLE
 896 <kbd>TYPEWRITE</kbd>, the default is quad left.
 897 </p>
 898
 899 <h4 id="para-indent" class="docs" style="margin-top: -.25em;">6. First-line indent</h4>
 900
 901 <p>
 902 The first-line indent of paragraphs is controlled by PARA_INDENT,
 903 which takes one argument: the size of the indent. PARA_INDENT may be
 904 used before or after
 905 <a href="docprocessing.html#start">START</a>.
 906 A
 907 <a href="definitions.html#unitofmeasure">unit of measure</a>
 908 is required; fractional sizes are allowed.  Thus, to set the
 909 paragraph indent to 4-1/2
 910 <a href="definitions.html#em">ems</a>, do
 911 <br/>
 912 <span class="pre-in-pp">
 913   .PARA_INDENT 4.5m
 914 </span>
 915 In addition to establishing the basic first line-indent of
 916 paragraphs, PARA_INDENT also affects
 917 <a href="#epigraph-intro">epigraphs</a>,
 918 <a href="#quote-intro">quotes</a>
 919 and
 920 <a href="#blockquote-intro">blockquotes</a>,
 921 whose overall indenting from the left and (where applicable)
 922 right margins is relative to PARA_INDENT if
 923 the _INDENT control macro for these tags has
 924 no
 925 <a href="definitions.html#unitofmeasure">unit of measure</a>
 926 appended to it.  Furthermore, the first-line indent of paragraphs
 927 within these document elements (as well as footnotes) is also
 928 relative to PARA_INDENT (always 1/2 of PARA_INDENT), hence they are
 929 also affected.
 930 </p>
 931
 932 <p>
 933 Mom&#8217;s default PARA_INDENT is 2 ems for
 934 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>
 935 <kbd>TYPESET</kbd> and 3 picas (1/2 inch) for
 936 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>
 937 <kbd>TYPEWRITE</kbd>.
 938 </p>
 939
 940 <h4 id="para-indent-first" class="docs" style="margin-top: -.25em;">7. Indenting initial paragraphs</h4>
 941
 942 <p>
 943 By default, mom does not indent the first paragraph of a document,
 944 nor the first paragraph after a heading or
 945 <a href="#linebreak-intro">linebreak</a>,
 946 nor the first paragraphs of
 947 <a href="#epigraph-intro">epigraphs</a>,
 948 <a href="#blockquote-intro">blockquotes</a>,
 949 <a href="#endnote-intro">endnotes</a>
 950 or
 951 <a href="#footnote-intro">footnotes</a>
 952 that run to more than one paragraph.
 953 </p>
 954
 955 <p>
 956 If you wish to have first paragraphs indented, invoke the macro
 957 <kbd>.INDENT_FIRST_PARAS</kbd> without an argument, either before or
 958 after
 959 <a href="docprocessing.html#start">START</a>.
 960 INDENT_FIRST_PARAS is a toggle macro, therefore passing it any
 961 argument (<b>OFF, QUIT, Q, X</b>...) cancels its effect, meaning
 962 that first paragraphs will once again not be indented.
 963 </p>
 964
 965 <h4 id="pp-space" class="docs">8. Inter-paragraph spacing</h4>
 966
 967 <p>
 968 By default, mom does not insert a blank line between
 969 paragraphs.  If you would like her to do so, invoke the macro,
 970 <kbd>.PARA_SPACE</kbd>, without an argument, either before or after
 971 <a href="docprocessing.html#start">START</a>.
 972 PARA_SPACE is a toggle macro, therefore passing it any argument
 973 (<b>OFF, QUIT, Q, X</b>...) cancels its effect, meaning that
 974 paragraphs will once again not be separated by a blank line.
 975 </p>
 976
 977 <p>
 978 If you would like to space paragraphs by less than a full linespace,
 979 invoke PARA_SPACE with the amount of space you want as a numeric
 980 argument.  A
 981 <a href="definitions.html#unitofmeasure">unit of measure</a>
 982 is required.  For example, to space paragraphs by one-quarter
 983 linespace
 984 <span class="pre-in-pp">
 985   .PARA_SPACE .25v
 986 </span>
 987 is how you&#8217;d do it, or, if you want six points between
 988 paragraphs
 989 <span class="pre-in-pp">
 990   .PARA_SPACE 6p
 991 </span>
 992 </p>
 993
 994 <p>
 995 PARA_SPACE is not recommended for use with PRINTSTYLE TYPEWRITE
 996 unless you give PRINTSTYLE the <kbd>SINGLESPACE</kbd> option.
 997 </p>
 998
 999 <div class="box-tip">
1000 <p class="tip-top">
1001 <span class="note">Note:</span>
1002 If PARA_SPACE is on, mom spaces only those paragraphs that come
1003 after an initial paragraph.  Initial paragraphs are those that come
1004 immediately after the
1005 <a href="definitions.html#docheader">docheader</a>
1006 (ie the start of a document),
1007 <a href="#epigraph-intro">epigraphs</a>,
1008 <a href="#heading-intro">headings</a>,
1009 and
1010 <a href="#linebreak-intro">linebreaks</a>.
1011 (The first paragraph after these document elements requires no
1012 blank line to separate it from other paragraphs.)
1013 </p>
1014
1015 <p class="tip-bottom">
1016 Sometimes, you can be fairly deep into a document before using PP
1017 for the first time, and when you do, because mom is still waiting
1018 for that initial paragraph, she doesn&#8217;t space it with a blank
1019 line, even though you expect her to.  The simple workaround for this
1020 is to invoke <kbd>.PP</kbd> twice (in succession) at the point you
1021 expect the blank line to appear.
1022 </p>
1023 </div>
1024
1025 <div class="rule-short"><hr/></div>
1026
1027 <!-- ==================================================================== -->
1028
1029 <h2 id="heading-intro" class="macro-group">Headings</h2>
1030
1031 <ul style="margin-left: -.5em;">
1032   <li><a href="#heading">Tag: HEADING</a></li>
1033   <li><a href="#head-spacing-notes">Spacing of headings</a></li>
1034   <li><a href="#heading-control">Heading control macros and defaults</a></li>
1035   <li><a href="#prefix-chapter-number">Prefixing chapter numbers</a></li>
1036   <li><a href="#oldstyle-headings">Oldstyle headings</a>
1037   <ul style="list-style-type: circle; margin-left: -1.25em">
1038     <li><a href="#parahead">Important information about PARAHEAD</a>
1039     <ul style="list-style-type: square; margin-left: -1.25em">
1040       <li><a href="#parahead-usage">Correct usage of paraheads</a></li>
1041     </ul></li>
1042   </ul></li>
1043 </ul>
1044
1045 <p>
1046 Heads, subheads, and deeper levels of section headings are handled by
1047 a single macro, HEADING, to which you pass an argument stating the
1048 desired level.  <kbd>.HEADING 1 &quot;&lt;text&gt;&quot;</kbd>, for
1049 example, would be a main head; <kbd>.HEADING 2
1050 &quot;&lt;text&gt;&quot;</kbd> would be a subhead; etc.
1051 </p>
1052
1053 <p>
1054 In addition to printing headings in the body of your document,
1055 HEADING collects the heading as an entry for the Table of Contents,
1056 if the document is to have one, and the
1057 <a href="definitions.html#pdfoutline">PDF outline</a>.
1058 With the <kbd>NAMED</kbd> argument, it furthermore acts as a
1059 bookmark for
1060 <a href="definitions.html#pdflink">PDF links</a>.
1061 </p>
1062
1063 <p>
1064 Headings can also be numbered on a per-heading-level basis,
1065 hierarchically and concatenatively, eg
1066 <br/>
1067 <span class="pre-in-pp">
1068   1.
1069   1.1
1070   1.2
1071   1.2.1
1072   2.
1073   2.1
1074   2.2
1075   2.2.1
1076 </span>
1077 By default, a blank line precedes headings, regardless of the level.
1078 Mom initially sets up a very basic style for nine levels of heading,
1079 of which you can have an infinite number, although as has been said,
1080 if you need more than four levels of heading, you should consider
1081 re-organizing your material.  The pared-down style of mom&#8217;s
1082 defaults is intentional; it is expected that you will design
1083 headings to your own specifications with the
1084 <a href="definitions.html#controlmacro">control macro</a>,
1085 <a href="#heading-style">HEADING_STYLE</a>.
1086 </p>
1087
1088 <p>
1089 It is very good practice, and strongly recommended, that you respect
1090 the hierarchy of headings, using level-1 for main heads, level-2 for
1091 subheads, level-3 for subsubheads, etc.  The ease of designing and
1092 re-designing the style for each level, plus mom&#8217;s very basic
1093 defaults, are meant, in part, to prevent the whimsical misuse of
1094 a particular heading level just because its style appeals to you.
1095 </p>
1096
1097 <!-- -HEAD- -->
1098
1099 <div class="macro-id-overline">
1100 <h3 id="heading" class="macro-id">HEADING</h3>
1101 </div>
1102
1103 <div class="box-macro-args">
1104 Macro: <b>HEADING</b> <kbd class="macro-args">&lt;level&gt; [
1105 PARAHEAD ] [ NAMED &lt;pdf-id&gt; ] &quot;&lt;heading text&gt;&quot;
1106 </div>
1107
1108 <p>
1109 The first argument to HEADING is the <kbd>level</kbd>.  Level 1 is
1110 analogous to a main head; level 2 is analogous to a subhead; level 3
1111 is analogous to a subsubhead; etc.
1112 </p>
1113
1114 <p>
1115 The second (optional) argument, <kbd>PARAHEAD</kbd>, instructs mom
1116 that the heading should be treated as a
1117 <a href="definitions.html#parahead">paragraph head</a>.
1118 If HEADING is being used to create a parahead, it must come after
1119 <a href="#pp">PP</a>,
1120 not before.
1121 </p>
1122
1123 <p>
1124 The indent applied to a parahead is the same as what would be
1125 expected from a paragraph without the parahead (see
1126 <a href="#para-indent-first">Indenting initial paragraphs</a>).
1127 If you wish that a paragraph introduced by a parahead not be
1128 indented, use
1129 <a href="#para-indent">PARA_INDENT</a>
1130 to set the paragraph indent to zero, then reset the indent for
1131 subsequent paragraphs.
1132 </p>
1133
1134 <p>
1135 The optional third argument, <kbd>NAMED &lt;id&gt;</kbd>, gives the
1136 heading a unique, non-printing identifier that allows it to
1137 referenced from anywhere in the final PDF document with the PDF_LINK
1138 macro, provided the mom file is processed with
1139 <a href="using.html#pdfmom" style="font-weight: bold">pdfmom</a>.
1140 PDF_LINK usage is explained in the manual,
1141 <a href="http://www.schaffter.ca/mom/pdf/mom-pdf.pdf"><span class="book-title">Producing PDFs with groff and mom</span></a>.
1142 </p>
1143
1144 <p>
1145 The final argument is the text of the heading, surrounded by double
1146 quotes.  Long headings that are likely to exceed the current
1147 line length should be broken into chunks, each surrounded by
1148 double-quotes, like this:
1149 <br/>
1150 <span class="pre-in-pp">
1151   .HEADING 1 "A needlessly long but instructive" "first level heading"
1152 </span>
1153 </p>
1154
1155 <div class="box-tip">
1156 <p class="tip">
1157 <span class="note">Note:</span>
1158 If a heading falls near the bottom of an output page and mom is
1159 unable to fit the heading plus at least one line of text underneath
1160 it, she will set the head at the top of the next page.
1161 </p>
1162 </div>
1163
1164 <div class="box-tip">
1165 <h3 id="head-spacing-notes" class="docs" style="padding-top: 9px; font-size: 100%; text-transform: none">Spacing of headings</h3>
1166
1167 <p>
1168 As described above, mom inserts a blank line before each heading.
1169 If the leading of your document never changes, and you introduce no
1170 additional space into the text&mdash;as, for example, between
1171 paragraphs&mdash;this will result in perfectly equal whitespace before
1172 each heading.
1173 </p>
1174
1175 <p>
1176 If, however, you disrupt the regular placement of text on
1177 mom&#8217;s baseline grid, HEADING adds as much whitespace to the
1178 blank line as is necessary to get things back on track.  The extra
1179 whitespace is always less than the current leading and therefore
1180 usually doesn't draw attention to itself.  This, along with a
1181 similar strategy for whitespace around quotes and blockquotes, is
1182 what allows mom to balance the bottom margins of pages effectively.
1183 The manual,
1184 <a href="http://www.schaffter.ca/mom/pdf/mom-pdf.pdf"><span class="book-title">Producing PDFs with groff and mom</span></a>,
1185 demonstrates this well: the inter-paragraph spacing is 1/3 of the
1186 leading, yet mom is able to produce a document with good page-rhythm
1187 and evenly balanced bottom margins.
1188 </p>
1189
1190 <p>
1191 It occasionally happens that the extra whitespace becomes noticeable,
1192 typically when the amount of whitespace approaches the value of the
1193 current leading.  The result looks like two blank lines instead of
1194 one.  When this happens, a simple but effective fix is to reduce the
1195 space before the heading by backing up one line, either with
1196 <br/>
1197 <span class="pre-in-pp">
1198   .SPACE -1v
1199 </span>
1200 or
1201 <br/>
1202 <span class="pre-in-pp">
1203   .RLD -1v
1204 </span>
1205 This results in slightly less whitespace than normal, but the
1206 difference is usually not apparent.
1207 </p>
1208
1209 <p class="tip-bottom">
1210 If you&#8217;d prefer that mom not add flexible whitespace to
1211 headings, invoke the macro
1212 <br/>
1213 <span class="pre-in-pp">
1214   .NO_SHIM
1215 </span>
1216 either in the style sheet section of your document (ie after
1217 PRINTSTYLE but before START), which will globally disable whitespace
1218 adjustment not only before headings, but around quotes and
1219 blockquotes as well, or on a per-instance basis.  <kbd>.NO_SHIM</kbd>
1220 is disabled by issuing
1221 <br/>
1222 <span class="pre-in-pp">
1223   .NO_SHIM OFF
1224 </span>
1225 Please note that <kbd>.NO_SHIM</kbd> also disables mom&#8217;s
1226 automatic shimming around quotes, blockquotes, after PDF images and
1227 floats, and
1228 <a href="docprocessing.html#shim">SHIM</a>
1229 macro itself.
1230 </p>
1231 </div>
1232
1233 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
1234 <h3 id="heading-control" class="defaults" style="margin-left: 6px; margin-bottom: -1em">HEADING control and defaults</h3>
1235
1236 <div style="padding-left: 15px; padding-right: 15px">
1237 <p style="margin-bottom: 1em">
1238 By default, mom pre-initializes nine levels of headings to use
1239 the bold font of the prevailing document family, with a baseline
1240 adjustment of 1/10 of the current
1241 <a href="definitions.html#leading">leading</a>.
1242 In addition, level-1 headings are 3 points larger than running text,
1243 level-2 headings 2 points larger, and level 3-headings 1 point
1244 larger.  The remaining 6 levels are the same size as running text.
1245 A single blank line precedes all levels of heading.
1246 </p>
1247
1248 <h4 id="heading-style" class="docs" style="margin-bottom: -.5em">The HEADING_STYLE macro</h4>
1249
1250 <p>
1251 Styling heads is accomplished with a single macro,
1252 <br/>
1253 <span class="pre-in-pp">
1254   .HEADING_STYLE&nbsp;&lt;level&gt;
1255 </span>
1256 where <kbd>&lt;level&gt;</kbd> is the numeric heading level to which
1257 the style applies.
1258 </p>
1259
1260 <p>
1261 HEADING_STYLE takes any or all of the following arguments,
1262 which may be given in any order:
1263 <br/>
1264 <span class="pre defaults">
1265   FAMILY &lt;family&gt; \
1266   FONT   &lt;font&gt; \
1267   SIZE   &lt;+|-size&gt; \
1268   QUAD   &lt;direction&gt; \
1269   COLOR  &lt;colour&gt; \
1270   UNDERSCORE  &lt;weight&gt; &lt;gap&gt; | NO_UNDERSCORE \
1271   UNDERSCORE2 &lt;weight&gt; &lt;gap1&gt; &lt;gap2&gt; | NO_UNDERSCORE2 \
1272   CAPS | NO_CAPS \
1273   BASELINE_ADJUST &lt;amount to raise heading from the baseline&gt; \
1274   SPACE_AFTER | NO_SPACE_AFTER \
1275   NUMBER | NO_NUMBER
1276 </span>
1277 </p>
1278
1279 <p>
1280 You may enter your entire argument list on a single line, or, if it
1281 is very long, break it into shorter lines with the
1282 &#8220;line-continued&#8221; backslash {<kbd>\</kbd>), as shown
1283 above.
1284 </p>
1285
1286 <p class="defaults" style="margin-bottom: 1em">
1287 The arguments to <kbd>FAMILY</kbd>, <kbd>FONT</kbd>,
1288 <kbd>SIZE</kbd>, <kbd>QUAD</kbd>, and
1289 <kbd>COLOR</kbd> are the same as
1290 those you&#8217;d give to the
1291 <a href="#docelement-control">control macros</a>
1292 ending in _FAMILY, _FONT, _SIZE, _QUAD, or _COLOR.  See
1293 <a href="#control-macro-args">Arguments to the control macros</a>.
1294 </p>
1295
1296 <p class="defaults" style="margin-bottom: 1em">
1297 <kbd>UNDERSCORE</kbd> and <kbd>UNDERSCORE2</kbd> require that a
1298 weight for the underscore be given, in points (decimal fractions
1299 allowed), but without the unit of measure <kbd>p</kbd> appended.
1300 They also require that the underscore's distance from the baseline
1301 be supplied; in the case of UNDERSCORE2, an additional gap argument
1302 representing the distance between the two underscores must be
1303 provided.
1304 </p>
1305
1306 <p class="defaults" style="margin-bottom: 1em">
1307 The <kbd>CAPS</kbd> argument capitalizes the text of a heading
1308 level in the body of a document but not in the Table of
1309 Contents, where capitalization of entries is controlled by
1310 <a href="tables-of-contents.html#toc-entry-style">TOC_ENTRY_STYLE&nbsp;&lt;n&gt;</a>.
1311 </p>
1312
1313 <p class="defaults" style="margin-bottom: 1em">
1314 <kbd>BASELINE_ADJUST</kbd> allows you to raise a heading slightly
1315 above the baseline on which it would otherwise sit.  For aesthetic
1316 reasons, it is often desirable to introduce a small amount of space
1317 between a heading and the text following it.  Since headings are
1318 preceded by a blank line, it is preferable to move the heading
1319 upward than to lower the text following it.  The argument to
1320 BASELINE_ADJUST is the amount by which to raise the heading.  It
1321 requires no <kbd>+</kbd> or <kbd>-</kbd> sign, and must have a
1322 <a href="definitions.html#unitofmeasure">unit of measure</a>
1323 appended to it.
1324 </p>
1325
1326 <p class="defaults" style="margin-bottom: 1em">
1327 <kbd>SPACE_AFTER</kbd> inserts a blank line equal to the current
1328 <a href="definitions.html#leading">leading</a> after a HEADING.
1329 If you'd like a full linespace after a heading level, use
1330 <kbd>SPACE_AFTER</kbd>.  If you'd like additional space before a
1331 heading level, you must introduce it yourself with
1332 <a href="typesetting.html#space">SPACE</a>
1333 or
1334 <a href="typesetting.html#ald">ALD</a>.
1335 </p>
1336
1337 <p class="defaults" style="margin-bottom: 1em">
1338 <kbd>NUMBER</kbd> and <kbd>NO_NUMBER</kbd> allow you to determine
1339 whether mom prepends a hierarchic numbering scheme to a heading
1340 level in the body of a document.  Numbering of Table of Contents
1341 entries is controlled separately with
1342 <a href="tables-of-contents.html#toc-entry-numbers">TOC_ENTRY_NUMBERS</a>.
1343 Mom also has a special macro to toggle whether to prefix a chapter
1344 number to numbered headings and Table of Contents entries,
1345 <a href="#prefix-chapter-number">PREFIX_CHAPTER_NUMBER</a>.
1346 </p>
1347
1348 <p class="defaults" style="padding-bottom: .5em">
1349 The argument list is long, so you may want to break it into
1350 several lines by using the backslash character (<kbd>\</kbd>).
1351 Here's an example of how you might style a level 1 heading:
1352 <br/>
1353 <span class="pre defaults">
1354   .HEADING_STYLE 1 \
1355   FONT B \
1356   QUAD C \
1357   UNDERSCORE .5 2p \
1358   BASELINE_ADJUST 3p \
1359   NUMBER
1360 </span>
1361 This creates a level-1 heading style that's bold, centered,
1362 underscored and numbered, raised by 3 points from the baseline.
1363 </p>
1364 </div>
1365 </div>
1366
1367 <!-- -PREFIX_CHAPTER_NUMBER- -->
1368
1369 <div id="prefix-chapter-number" class="macro-id-overline" style="margin-top: -1em;">
1370 <h3 class="macro-id" style="text-transform: none; font-size: 105%;">Prefixing chapter numbers</h3>
1371 </div>
1372
1373 <div class="box-macro-args">
1374 Macro: <b>PREFIX_CHAPTER_NUMBER</b> <kbd class="macro-args">&lt;none&gt; | &lt;chapter number as digit&gt; | &lt;anything&gt;</kbd>
1375 </div>
1376
1377 <p>
1378 If you&#8217;ve requested numbering for any level of heading and
1379 you&#8217;d like mom, in addition, to prefix a chapter number to the
1380 numbering scheme, you can do so with PREFIX_CHAPTER_NUMBER.
1381 </p>
1382
1383 <p>
1384 After you invoke <kbd>.PREFIX_CHAPTER_NUMBER</kbd>, mom will prepend
1385 the current chapter number to all headings you have requested be
1386 numbered with
1387 <a href="#heading-style"><kbd>.HEADING_STYLE &lt;n&gt; NUMBER</a>.
1388 Thus, assuming chapter number twelve (12):
1389 <br/>
1390 <span class="pre-in-pp">
1391   1.   LEVEL 1 HEADING
1392   1.1. Level 2 heading
1393 </span>
1394 would become
1395 <br/>
1396 <span class="pre-in-pp">
1397   12.1.   LEVEL 1 HEADING
1398   12.1.1. Level 2 heading
1399 </span>
1400 </p>
1401
1402 <p>
1403 When you invoke <kbd>.PREFIX_CHAPTER_NUMBER</kbd> without an
1404 argument, mom checks to see whether the argument you passed to
1405 <a href="docprocessing.html#chapter">CHAPTER</a>
1406 is a digit.  If it is, she immediately starts pre-pending the
1407 current chapter number to numbered head elements.  If it isn&#8217;t
1408 (say you&#8217;ve called your chapter &#8220;One&#8221; instead
1409 of &#8220;1&#8221;), mom will abort with a request that you pass
1410 PREFIX_CHAPTER_NUMBER a digit representing the current chapter
1411 number.
1412 </p>
1413
1414 <p>
1415 In collated documents, mom automatically increments
1416 the digit used by PREFIX_CHAPTER_NUMBER by one
1417 (current chapter digit + 1) every time you invoke <a
1418 href="rectoverso.html#collate"><kbd>.COLLATE</kbd></a>, even if
1419 you&#8217;ve (temporarily) turned off the prefixing of chapter
1420 numbers.  Thus, even if you call your chapters &#8220;One&#8221;,
1421 &#8220;Two&#8221;, &#8220;Three&#8221; instead of &#8220;1&#8221;,
1422 &#8220;2&#8221;, &#8220;3&#8221;, mom will Do The Right Thing
1423 with respect to numbering head elements in all collated chapters
1424 following the first invocation of PREFIX_CHAPTER_NUMBER (assuming,
1425 of course, that the collated chapters are in incrementing order; if
1426 not, you must must put
1427 <br/>
1428 <span class="pre-in-pp">
1429   .PREFIX_CHAPTER_NUMBER &lt;chapter number&gt;
1430 </span>
1431 somewhere after the invocation of COLLATE and before the first
1432 numbered head element of each collated document).
1433 </p>
1434
1435 <p>
1436 PREFIX_CHAPTER_NUMBER can be disabled by passing it any argument
1437 other than a digit (eg <b>OFF, QUIT, END, X</b>, etc), although,
1438 as noted above, mom will keep, and&mdash;in the case of collated
1439 documents&mdash;increment the chapter number, allowing you to turn
1440 prefixing of chapter numbers to numbered head elements off and on
1441 according to your needs or whims.
1442 </p>
1443
1444 <p>
1445 <span class="note">Note:</span>
1446 Because PREFIX_CHAPTER_NUMBER takes an (optional) digit representing
1447 the chapter number, it&#8217;s use need not be restricted to
1448 <a href="docprocessing.html#doctype">DOCTYPE <kbd>CHAPTER</kbd></a>.
1449 You can use it with any document type.  Furthermore, even if
1450 your doctype isn&#8217;t <kbd>CHAPTER</kbd>, you can identify
1451 the document as a chapter for the purposes of numbering head
1452 elements by invoking the macro,
1453 <a href="docprocessing.html#chapter"><kbd>.CHAPTER</kbd></a>,
1454 with a
1455 <a href="definitions.html#numericargument">numeric argument</a>
1456 in your document setup.
1457 </p>
1458
1459 <div class="rule-short"><hr/></div>
1460
1461 <!-- ==================================================================== -->
1462
1463 <h2 id="oldstyle-headings-intro" class="macro-group">Oldstyle headings</h2>
1464
1465 <ul style="margin-left: -.5em;">
1466   <li><a href="#oldstyle-headings">Macro: OLDSTYLE_HEADINGS</a></li>
1467   <li><a href="#head">Macro: HEAD</a></li>
1468   <li><a href="#subhead">Macro: SUBHEAD</a></li>
1469   <li><a href="#subsubhead">Macro: SUBSUBHEAD</a></li>
1470 </ul>
1471
1472 <p>
1473 In versions of mom prior to 2.0, headings were entered by their
1474 commonly used names, <i>viz.</i> HEAD, SUBHEAD, and SUBSUBHEAD. The
1475 new
1476 <a href="#heading-intro">HEADING</a>
1477 scheme allows for greater flexibility, and permits seamless
1478 integration with PDF output.
1479 </p>
1480
1481 <p>
1482 Documents created with pre-2.0 versions may still use the oldstyle
1483 heading names, as may new documents, however there are some
1484 differences in their behaviour.
1485 </p>
1486
1487 <p>
1488 Whenever mom encounters an oldstyle heading, she loads the default
1489 style formerly associated with the oldstyle name.  See below for a
1490 description of the default styles in the sections
1491 <a href="#head">HEAD</a> (now HEADING 1),
1492 <a href="#subhead">SUBHEAD</a> (now HEADING 2),
1493 and
1494 <a href="#subsubhead">SUBSUBHEAD</a> (now HEADING 3).
1495 Mom also emits a message to stderr alerting you to what she's doing.
1496 </p>
1497
1498 <p>
1499 The control macros formerly associated with oldstyle headings are no
1500 longer present in mom's macro file, which means that if you
1501 made changes to mom's default for those headings, you must recreate
1502 the changes with the
1503 <a href="#heading-style">HEADING_STYLE</a>
1504 macro.  The entire style need not be recreated, only those
1505 parameters that differed from mom's defaults.  Thus, if your HEADs
1506 were set flush left, instead of the oldstyle default, centered, but
1507 otherwise kept mom's settings, you need only do
1508 <br/>
1509 <span class="pre-in-pp">
1510   .HEADING_STYLE 1 QUAD L
1511 </span>
1512 </p>
1513
1514 <div id="parahead" class="box-important">
1515 <p class="tip-top">
1516 <span class="important">Important:</span>
1517 The macro, PARAHEAD, is no longer available.  You must create paragraph
1518 heads using the
1519 <a href="#heading">HEADING</a>
1520 macro.  Mom will abort with an informational message whenever she
1521 encounters PARAHEAD. Assuming a heading level of 3 for your
1522 paraheads, the former defaults for PARAHEAD can be set up like this:
1523 <br/>
1524 <span class="pre-in-pp">
1525   .HEADING STYLE 3 FONT BI SIZE -.25 \" For PRINTSTYLE TYPESET
1526   .HEADING STYLE 3 FONT I SIZE +0    \" For PRINTSTYLE TYPEWRITE
1527 </span>
1528 Equally, the macro NUMBER_PARAHEADS is no longer available.  You
1529 must enable numbering of the correct level for paraheads with
1530 HEADING_STYLE.  Again assuming a heading level of 3 for paraheads,
1531 it's simply done:
1532 <br/>
1533 <span class="pre-in-pp">
1534   .HEADING_STYLE 3 NUMBER
1535 </span>
1536 </p>
1537
1538 <h3 id="parahead-usage" class="docs" style="text-transform: none; margin-top: -1em">Correct usage of paraheads</h3>
1539
1540 <p style="margin-top: .5em">
1541 It is tempting to choose an arbitrary heading level for paraheads,
1542 since they are sometimes needed out-of-sequence; for example,
1543 immediately after a main head (level-1) in a document that
1544 subsequently requires subheads (level-2).  In such a circumstance,
1545 choosing level-3 for all your paraheads might seem to make sense,
1546 but in fact doesn&#8217;t, since it disrupts the hierarchy of
1547 both the Table of Contents (if your document has one) and the PDF
1548 outline.
1549 </p>
1550
1551 <p>
1552 Correct use of the <kbd>PARAHEAD</kbd> option to HEADING under such
1553 circumstances requires always assigning <kbd>PARAHEAD</kbd> to
1554 the next logical level in the heading hierarchy.  For example, if
1555 there are no headings before the parahead, it should be assigned to
1556 level-1.  If subsequently there is a main head to be followed by
1557 more paraheads, the main head should be level-1, and the paraheads
1558 level-2.  This will almost certainly require assigning new style
1559 parameters to level-1 (with
1560 <a href="#heading-style">HEADING_STYLE</a>)
1561 and to the level now being used for paraheads.  The following
1562 example demonstrates.
1563 <br/>
1564 <span class="pre-in-pp">
1565   .HEADING_STYLE 1 FONT BI SIZE +.25 \" parahead style, level-1
1566   .PP
1567   .HEADING 1 PARAHEAD &lt;parahead&gt;
1568   &lt;paragraph text&gt;
1569   .PP
1570   .HEADING 1 PARAHEAD &lt;parahead&gt;
1571   &lt;paragraph text&gt;
1572   \# main head style, level-1
1573   .HEADING_STYLE 1 FONT B SIZE +3 QUAD CENTER UNDERSCORE .5 2p
1574   .HEADING_STYLE 2 FONT BI SIZE +.25 \" parahead style, level-2
1575   .HEADING 1 &lt;main head&gt;
1576   .PP
1577   &lt;paragraph text&gt;
1578   .PP
1579   .HEADING 2 PARAHEAD &lt;parahead&gt;
1580   &lt;paragraph text&gt;
1581 </span>
1582 </p>
1583 </div>
1584
1585 <!-- -OLDSTYLE_HEADINGS - -->
1586
1587 <div class="macro-id-overline">
1588 <h3 id="oldstyle-headings" class="macro-id">OLDSTYLE HEADINGS</h3>
1589 </div>
1590
1591 <div class="box-macro-args">
1592 Macro: <b>OLDSTYLE_HEADINGS</b>
1593 </div>
1594
1595 <p>
1596 OLDSTYLE_HEADINGS requires no argument.  It instructs mom to set the
1597 first three levels of heading to the parameters of her old defaults
1598 for HEAD, SUBHEAD, and SUBSUBHEAD.  Use of OLDSTYLE_HEADINGS will
1599 also prevent mom from generating the message she issues the first
1600 time she encounters HEAD, SUBHEAD, and SUBSUBHEAD.
1601 </p>
1602
1603 <!-- -HEAD- -->
1604
1605 <div id="head" class="box-macro-args">
1606 Macro: <b>HEAD</b> <kbd class="macro-args">[ NAMED &lt;id&gt; ] &quot;&lt;text of head&gt;&quot; &quot;&lt;another line&gt;&quot;...</kbd>
1607 </div>
1608
1609 <p>
1610 When invoked for the first time, with or without
1611 <a href="oldstyle-headings">OLDSTYLE_HEADINGS</a>,
1612 HEAD sets the parameters for level-1 headings to mom&#8217;s old
1613 HEAD defaults, then prints the head as a level-1 heading.
1614 The <kbd>NAMED &lt;id&gt;</kbd> optional argument is explained in
1615 the description of
1616 <a href="#heading">HEADING</a>.
1617 </p>
1618
1619 <p>
1620 If, prior to invoking HEAD, you have given any parameters to level-1
1621 heads with
1622 <a href="#heading-style">HEADING STYLE</a>,
1623 they will be preserved; any you give afterwards will be respected.
1624 </p>
1625
1626 <p>
1627 The former style defaults for HEAD were:
1628 <br/>
1629 <span class="pre-in-pp">
1630   FAMILY     = prevailing document family
1631   FONT       = bold (TYPESET); roman (TYPEWRITE)
1632   SIZE       = +1 (TYPESET); +0 (TYPEWRITE)
1633   QUAD       = C
1634   UNDERSCORE .5 2p
1635   CAPS
1636 </span>
1637 </p>
1638
1639 <div class="box-tip">
1640 <p class="tip">
1641 <span class="note">Note:</span>
1642 The macro, NUMBER_HEADS, from pre-2.0 versions of mom, can still be
1643 used, though it is now a wrapper for
1644 <br/>
1645 <span class="pre-in-pp">
1646   .HEADING_STYLE 1 NUMBER
1647 </span>
1648 Mom will alert you to this on stderr.
1649 </p>
1650 </div>
1651
1652 <!-- -SUBHEAD- -->
1653
1654 <div id="subhead" class="box-macro-args">
1655 Macro: <b>SUBHEAD</b> <kbd class="macro-args">[ NAMED &lt;id&gt; ] &quot;&lt;text of head&gt;&quot; &quot;&lt;another line&gt;&quot;...</kbd>
1656 </div>
1657
1658 <p>
1659 When invoked for the first time, with or without
1660 <a href="oldstyle-headings">OLDSTYLE_HEADINGS</a>,
1661 SUBHEAD sets the parameters for level-2 headings to mom&#8217;s old
1662 SUBHEAD defaults, then prints the subhead as a level-2 heading.
1663 The <kbd>NAMED &lt;id&gt;</kbd> optional argument is explained in
1664 the description of
1665 <a href="#heading">HEADING</a>.
1666 </p>
1667
1668 <p>
1669 The former style defaults for SUBHEAD were:
1670 <br/>
1671 <span class="pre-in-pp">
1672   FAMILY          = prevailing document family
1673   FONT            = bold (TYPESET); italic, ie underlined (TYPEWRITE)
1674   SIZE            = +.5 (TYPESET); +0 (TYPEWRITE)
1675   QUAD            = L
1676   BASELINE_ADJUST = 1/8 the current leading
1677 </span>
1678 </p>
1679
1680 <div class="box-tip">
1681 <p class="tip">
1682 <span class="note">Note:</span>
1683 The macro, NUMBER_SUBHEADS, from pre-2.0 versions of mom, can still be
1684 used, though it is now a wrapper for
1685 <br/>
1686 <span class="pre-in-pp">
1687   .HEADING_STYLE 2 NUMBER
1688 </span>
1689 Mom will alert you to this on stderr.
1690 </p>
1691 </div>
1692
1693 <!-- -SUBSUBHEAD- -->
1694
1695 <div id="subsubhead" class="box-macro-args">
1696 Macro: <b>SUBSUBHEAD</b> <kbd class="macro-args">[ NAMED &lt;id&gt; ] &quot;&lt;text of head&gt;&quot; &quot;&lt;another line&gt;&quot;...</kbd>
1697
1698 </div>
1699
1700 <p>
1701 When invoked for the first time, with or without
1702 <a href="oldstyle-headings">OLDSTYLE_HEADINGS</a>,
1703 SUBSUBHEAD sets the parameters for level-3 headings to mom&#8217;s old
1704 SUBSUBHEAD defaults, then prints the subsubhead as a level-3 heading.
1705 The <kbd>NAMED &lt;id&gt;</kbd> optional argument is explained in
1706 the description of
1707 <a href="#heading">HEADING</a>.
1708 </p>
1709
1710 <p>
1711 The former style defaults for SUBSUBHEAD were:
1712 <br/>
1713 <span class="pre-in-pp">
1714   FAMILY          = prevailing document family
1715   FONT            = italic (TYPESET); roman (TYPEWRITE)
1716   SIZE            = +.5 (TYPESET); +0 (TYPEWRITE)
1717   QUAD            = L
1718   BASELINE_ADJUST = 1/8 the current leading
1719 </span>
1720 </p>
1721
1722 <div class="box-tip">
1723 <p class="tip">
1724 <span class="note">Note:</span>
1725 The macro, NUMBER_SUBSUBHEADS, from pre-2.0 versions of mom, can still be
1726 used, though it is now a wrapper for
1727 <br/>
1728 <span class="pre-in-pp">
1729   .HEADING_STYLE 3 NUMBER
1730 </span>
1731 Mom will alert you to this on stderr.
1732 </p>
1733 </div>
1734
1735 <div class="rule-short"><hr/></div>
1736
1737 <!-- ==================================================================== -->
1738
1739 <h2 id="linebreak-intro" class="macro-group">Linebreaks (section breaks)</h2>
1740
1741 <ul style="margin-left: -.5em;">
1742   <li><a href="#linebreak">Tag: LINEBREAK</a></li>
1743   <li><a href="#linebreak-control">Linebreak control macros and defaults</a></li>
1744 </ul>
1745
1746 <p>
1747 Linebreaks (&#8220;author linebreaks&#8221;, &#8220;section
1748 breaks&#8221;) are gaps in the vertical flow of running text that
1749 indicate a shift in content (eg a scene change in story).  They
1750 are frequently set off by typographic symbols, sometimes whimsical
1751 in nature.
1752 </p>
1753
1754 <!-- -LINEBREAK- -->
1755
1756 <div class="macro-id-overline">
1757 <h3 id="linebreak" class="macro-id">LINEBREAK</h3>
1758 </div>
1759
1760 <div class="box-macro-args">
1761 Macro: <b>LINEBREAK</b>
1762 </div>
1763 <p class="alias" style="margin-bottom: 0;">
1764 <i>Alias:</i> <b>SECTION</b>
1765 </p>
1766
1767 <p>
1768 LINEBREAK takes no arguments.  Simply invoke it (on a line by
1769 itself, of course) whenever you want to insert an author linebreak.
1770 </p>
1771
1772 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
1773 <h3 id="linebreak-control" class="docs defaults">LINEBREAK control macros and defaults</h3>
1774
1775 <p class="defaults">
1776 By default, mom marks
1777 <a href="definitions.html#linebreak">author linebreaks</a>
1778 with three centred asterisks (stars) in the prevailing colour of the
1779 document (by default, black).  You can alter this with the control
1780 macros
1781 </p>
1782 <ol style="margin-top: .5em; padding-bottom: .5em;">
1783   <li><a href="#linebreak-char">LINEBREAK_CHAR</a></li>
1784   <li><a href="#linebreak-color">LINEBREAK_COLOR</a></li>
1785 </ol>
1786 </div>
1787
1788 <h4 id="linebreak-char" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Linebreak character</h4>
1789 <div class="box-macro-args">
1790 Macro: <b>LINEBREAK_CHAR</b> <kbd class="macro-args">[ &lt;character&gt; ] [ &lt;iterations&gt; [ &lt;vertical adjustment&gt; ] ]</kbd>
1791 </div>
1792
1793 <p class="alias" style="margin-bottom: 0;">
1794 <i>Alias:</i> <b>SECTION_CHAR</b>
1795 </p>
1796 <p class="requires">
1797 &bull;&nbsp;The third optional argument requires a
1798 <a href="definitions.html#unitofmeasure">unit of measure</a>.
1799 </p>
1800
1801 <p>
1802 LINEBREAK_CHAR determines what mom prints when LINEBREAK is invoked.
1803 It takes 3 optional arguments: the character you want deposited at
1804 the line break, the number of times you want the character repeated,
1805 and a vertical adjustment factor.
1806 </p>
1807
1808 <p>
1809 The first argument is any valid groff character (eg <kbd>*</kbd>
1810 [an asterisk], <kbd>\[dg]</kbd> [a dagger], <kbd>\f[ZD]\N'141\fP</kbd>
1811 [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd> [a
1812 4-pica long rule]). Mom sets the character centred on the current
1813 line length.  (See <kbd>man groff_char</kbd> for a list of all
1814 valid groff characters.)
1815 </p>
1816
1817 <p>
1818 The second argument is the number of times to repeat the character.
1819 </p>
1820
1821 <p>
1822 The third argument is a +|-value by which to raise (+) or lower (-)
1823 the character in order to make it appear visually centred between
1824 sections of text.  This lets you make vertical adjustments to
1825 characters that don&#8217;t sit on the
1826 <a href="definitions.html#baseline">baseline</a>
1827 (such as asterisks).  The argument must be preceded by a plus or
1828 minus sign, and must include a unit of measure.
1829 </p>
1830
1831 <p>
1832 If you enter LINEBREAK_CHAR with no arguments, sections of
1833 text will be separated by two blank lines when you invoke
1834 <kbd>.LINEBREAK</kbd>.
1835 </p>
1836
1837 <p>
1838 Mom&#8217;s default for LINEBREAK_CHAR is
1839 <br/>
1840 <span class="pre-in-pp">
1841   .LINEBREAK_CHAR * 3 -3p
1842 </span>
1843 ie three asterisks, lowered 3 points from their normal vertical
1844 position (for
1845 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>;
1846 the vertical adjustment is -2 points for
1847 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>).
1848 </p>
1849
1850 <h4 id="linebreak-color" class="docs" style="margin-top: -.25em; margin-bottom: .5em;">2. Linebreak colour</h4>
1851
1852 <div class="box-macro-args">
1853 Macro: <b>LINEBREAK_COLOR</b> <kbd class="macro-args">&lt;colourname&gt;</kbd>
1854 </div>
1855 <p class="alias" style="margin-bottom: 0;">
1856 <i>Alias:</i> <b>SECTION_COLOR</b>
1857 </p>
1858
1859 <p>
1860 To change the colour of the linebreak character(s), simply invoke
1861 <kbd>.LINEBREAK_COLOR</kbd> with the name of a colour pre-defined
1862 (or &#8220;initialized&#8221;) with
1863 <a href="color.html#newcolor">NEWCOLOR</a>
1864 or
1865 <a href="color.html#xcolor">XCOLOR</a>.
1866
1867 </p>
1868
1869 <div class="rule-short"><hr/></div>
1870
1871 <!-- ==================================================================== -->
1872
1873 <h2 id="quote-intro" class="macro-group">Quotes (line for line, poetry or code)</h2>
1874
1875 <ul style="margin-left: -.5em;">
1876   <li><a href="#quote">Tag: QUOTE</a></li>
1877   <li><a href="#quote-control">Quote control macros and defaults</a></li>
1878 </ul>
1879
1880 <p>
1881 <a href="definitions.html#quote">Quotes</a>
1882 are always set in
1883 <a href="definitions.html#filled">nofill mode</a>,
1884 flush left.  This permits entering quotes on a line for line basis
1885 in your text editor and have them come out the same way on output
1886 copy.  (See
1887 <a href="#blockquote-intro">Blockquotes</a>
1888 for how quotes, in the present sense, differ from longer passages of
1889 cited text.)
1890 </p>
1891
1892 <p>
1893 Since mom originally came into being to serve the needs of creative
1894 writers (ie novelists, short story writers, etc.&mdash;not
1895 to cast aspersions on the creativity of mathematicians and
1896 programmers), she sets quotes in italics
1897 <a href="docprocessing.html#printstyle">(PRINTSTYLE <kbd>TYPESET</kbd>)</a>
1898 or underlined
1899 <a href="docprocessing.html#printstyle">(PRINTSTYLE <kbd>TYPEWRITE</kbd>)</a>,
1900 indented from the left margin.  Obviously, she&#8217;s thinking
1901 &#8220;quotes from poetry or song lyrics&#8221;, but with the
1902 <a href="#quote-control">QUOTE control macros</a>
1903 you can change her defaults so QUOTE serves other needs, eg
1904 entering verbatim snippets of programming code, command line
1905 instructions, and so on.  (See the
1906 <a href="#code">CODE</a>
1907 for a convenience macro to assist in including code snippets in
1908 documents.)
1909 </p>
1910
1911 <h3 id="quote-spacing" class="docs">QUOTE spacing</h3>
1912
1913 <p>
1914 Besides indenting quotes, mom further sets them off from
1915 <a href="definitions.html#running">running text</a>
1916 with a small amount of vertical whitespace top and bottom.  In
1917 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>,
1918 this is always one full linespace.  In
1919 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>,
1920 it&#8217;s 1/2 of the prevailing
1921 <a href="definitions.html#leading">leading</a>
1922 if the quote fits fully on the page (ie with running text above
1923 and below it), otherwise it&#8217;s a full linespace either above
1924 or below as is necessary to balance the page to the bottom margin.
1925 This behaviour can be changed with the control macro
1926 <a href="#always-fullspace-quotes">ALWAYS_FULLSPACE_QUOTES</a>.
1927 </p>
1928
1929 <div class="box-tip">
1930 <h2 id="quote-spacing-notes" class="docs" style="padding-top: 9px; font-size: 100%;">Further notes on quote spacing</h2>
1931
1932 <p clas"defaults">
1933 If your quote (or blockquote) leading differs from the document
1934 leading, mom attempts to observe the same rules for vertical
1935 whitespace outlined above; however, she will also insert a small,
1936 flexible amount of extra whitespace around the quotes to make sure
1937 the whitespace is equal, top and bottom.  Since she does this
1938 on a quote by quote basis, rather than by figuring out how much
1939 extra whitespace is needed to adjust <i>all</i> quotes on a page,
1940 the spacing around multiple quotes on the same page will differ
1941 slightly, although each will be balanced between lines of normal
1942 <a href="definitions.html#running">running text</a>,
1943 top and bottom.  (The inability to scan an entire page and insert
1944 equalized whitespace at marked places is a limitation of groff,
1945 which, by and large, processes text on a line-per-line basis.)
1946 </p>
1947
1948 <h3 id="no-shim" class="docs">Disable shimming of quotes and blockquotes</h3>
1949
1950 <p>
1951 If you don&#8217;t want the behaviour described above (ie you
1952 don&#8217;t want mom shimming
1953 quotes and blockquotes), issue the macro
1954 <br/>
1955 <span class="pre-in-pp">
1956   .NO_SHIM
1957 </span>
1958 in the style sheet section of your document (ie after PRINTSTYLE but
1959 before START), which will disable shimming globally, or on a
1960 per-instance basis prior to <kbd>.QUOTE</kbd> or <kbd>.BLOCKQUOTE</kbd>.
1961 </p>
1962
1963 <p>
1964 If you&#8217;ve disabled shimming of quotes and blockquotes with
1965 <kbd>.NO_SHIM</kbd> and you want mom to return to her default
1966 behaviour in this matter, invoke <kbd>.NO_SHIM&nbsp;OFF</kbd> (or
1967 <kbd>QUIT, END, X</kbd>, etc).
1968 </p>
1969
1970 <p>
1971 Please note that <kbd>NO_SHIM</kbd> disables shimming before
1972 headings, and the
1973 <a href="docprocessing.html#shim">SHIM</a>
1974 macro itself.
1975 </p>
1976
1977 <p class="tip-bottom">
1978 If you don&#8217;t provide mom with a QUOTE_AUTOLEAD, quotes are
1979 leaded at the default for normal running text, meaning that multiple
1980 quotes on the same page are all spaced identically.
1981 </p>
1982 </div>
1983
1984 <h3 id="float-quote" class="docs">Keeping QUOTEs and BLOCKQUOTEs together as a block</h3>
1985
1986 <p>
1987 The text of quotes and blockquotes is output immediately, and may therefore
1988 start on one page and finish on the next.  If you wish to keep the
1989 text together as a block, deferred to the following page if the
1990 block doesn&#8217;t all fit on one page, wrap
1991 (BLOCK)QUOTE&nbsp;/&nbsp;(BLOCK)QUOTE&nbsp;OFF
1992 inside a
1993 <a href="images.html#floats-intro">float</a>.  If you further wish to
1994 force a page break before the floated quote or blockquote (leaving
1995 whitespace at the bottom of the page, pass
1996 <a href="images.html#float">FLOAT</a>
1997 the <kbd>FORCE</kbd> argument.
1998 <span class="pre-in-pp">
1999   .FLOAT FORCE
2000   .QUOTE
2001   Fly me to the moon
2002   And let me play among the stars
2003   Let me see what life is like
2004   On Jupiter and Mars
2005   .QUOTE END
2006   .FLOAT OFF
2007 </span>
2008
2009 </p>
2010
2011 <!-- -QUOTE- -->
2012
2013 <div class="macro-id-overline">
2014 <h3 id="quote" class="macro-id">QUOTE</h3>
2015 </div>
2016
2017 <div class="box-macro-args">
2018 Macro: <b>QUOTE</b> <kbd class="macro-args">toggle</kbd>
2019 </div>
2020
2021 <p>
2022 QUOTE is a toggle macro.  To begin a section
2023 of quoted text, invoke it with no argument, then type in your
2024 quote.  When you&#8217;re finished, invoke <kbd>.QUOTE</kbd> with any
2025 argument (eg <kbd>OFF, END, X, Q</kbd>...) to turn it off.  Example:
2026 <br/>
2027 <span class="pre-in-pp">
2028   .QUOTE
2029   Nymphomaniacal Jill
2030   Used a dynamite stick for a thrill
2031   They found her vagina
2032   In North Carolina
2033   And bits of her tits in Brazil.
2034   .QUOTE END
2035 </span>
2036 </p>
2037
2038 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
2039 <h3 id="quote-control" class="docs defaults">QUOTE control macros and defaults</h3>
2040
2041 <ol style="margin-top: .5em; padding-bottom: .5em;">
2042   <li><a href="#quote-general">Family/font/size/leading/colour/indent</a></li>
2043   <li><a href="#always-fullspace-quotes">Spacing above and below quotes (typeset only)</a></li>
2044   <li><a href="#underline-quotes">Underlining quotes (typewrite only)</a></li>
2045 </ol>
2046 </div>
2047
2048 <h4 id="quote-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour/indent</h4>
2049
2050 <div class="defaults-container" style="padding-bottom: 8px;">
2051 <p class="defaults" style="padding-top: 6px;">
2052 See
2053 <a href="#control-macro-args">Arguments to the control macros</a>.
2054 </p>
2055 <span class="pre defaults">
2056 .QUOTE_FAMILY   default = prevailing document family; default is Times Roman
2057 .QUOTE_FONT     default = italic; underlined in TYPEWRITE
2058 .QUOTE_SIZE     default = +0 (ie same size as paragraph text)
2059 .QUOTE_AUTOLEAD default = none; leading of quotes is the same as paragraphs
2060 .QUOTE_COLOR    default = black
2061 .QUOTE_INDENT  (see below, "Quote indent")
2062 </span>
2063 </div>
2064
2065 <h4 id="quote-indent" class="docs" style="margin-top: -1.5em;">Quote indent</h4>
2066
2067 <p>
2068 <kbd>QUOTE_INDENT</kbd> takes one of two kinds of argument: an integer
2069 representing the amount by which to multiply the argument passed to
2070 <a href="#para-indent"><kbd>.PARA_INDENT</kbd></a>
2071 (by default, 2
2072 <a href="definitions.html#em">ems</a>
2073 for TYPESET, 3
2074 <a href="definitions.html#picaspoints">picas</a>
2075 for TYPEWRITE) to arrive at the quote indent, or a distance with a
2076 <a href="definitions.html#unitofmesaure">unit of measure</a>
2077 appended.  Both result in quotes being indented equally from the
2078 left and right margins.
2079 </p>
2080
2081 <p>
2082 The default value for QUOTE_INDENT is 3 (for
2083 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>)
2084 and 1 (for
2085 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>).
2086 </p>
2087
2088 <div class="box-tip">
2089 <p class="tip-top">
2090 <span class="note">Note:</span>
2091 If your PARA_INDENT is 0 (ie no indenting of the first line of
2092 paragraphs), you <i>must</i> set a QUOTE_INDENT yourself, with a
2093 unit of measure appended to the argument. Mom has no default for
2094 QUOTE_INDENT if paragraph first lines are not being indented.
2095 </p>
2096
2097 <p class="tip-bottom">
2098 <span class="note">Additional note:</span>
2099 QUOTE_INDENT also sets the indent for
2100 <a href="#blockquote">blockquotes</a>.
2101 </p>
2102 </div>
2103
2104 <h4 id="always-fullspace-quotes" class="docs" style="margin-top: -.25em;">2. Spacing above and below quotes (typeset only)</h4>
2105
2106 <p>
2107 If you&#8217;d like mom always to put a full linespace above and
2108 below quotes, invoke
2109 <br/>
2110 <span class="pre-in-pp">
2111   .ALWAYS_FULLSPACE_QUOTES
2112 </span>
2113 with no argument.  If you wish to restore mom&#8217;s
2114 default behaviour regarding the spacing of quotes (see
2115 <a href="#quote-spacing">above</a>),
2116 invoke the macro with any argument (<kbd>OFF, QUIT, END, X</kbd>...)
2117 </p>
2118
2119 <div class="box-tip">
2120 <p class="tip">
2121 <span class="note">Note:</span>
2122 This macro also sets mom&#8217;s spacing policy for
2123 <a href="#blockquote-intro">blockquotes</a>.
2124 </p>
2125 </div>
2126
2127 <h4 id="underline-quotes" class="docs" style="margin-top: -.25em;">3. Underlining quotes (typewrite only)</h4>
2128
2129 <p>
2130 By default in
2131 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
2132 mom underlines quotes.  If you&#8217;d rather she didn&#8217;t,
2133 invoke <kbd>.UNDERLINE_QUOTES</kbd> with any argument (<b>OFF,
2134 QUIT, END, X</b>...) to disable the feature.  Invoke it without
2135 an argument to restore mom&#8217;s default underlining of
2136 quotes.
2137 </p>
2138
2139 <p>
2140 If you not only wish that mom not underline quotes, but also that
2141 she set them in italic, you must follow each instance of QUOTE with
2142 the typesetting macro
2143 <a href="typesetting.html#font">FT I</a>.
2144 Furthermore, since mom underlines all instances of italics by
2145 default in <b>PRINTSTYLE TYPEWRITE</b>, you must also make sure that
2146 ITALIC_MEANS_ITALIC is enabled (see
2147 <a href="docprocessing.html#typewrite-control">PRINTSTYLE TYPEWRITE control macros</a>).
2148 </p>
2149
2150 <div class="rule-short"><hr/></div>
2151
2152 <!-- ==================================================================== -->
2153
2154 <h2 id="blockquote-intro" class="macro-group">Blockquotes (cited material)</h2>
2155
2156 <ul style="margin-left: -.5em;">
2157   <li><a href="#blockquote">Tag: BLOCKQUOTE</a></li>
2158   <li><a href="#blockquote-control">BLOCKQUOTE control macros</a></li>
2159 </ul>
2160
2161 <p>
2162 <a href="definitions.html#blockquote">Blockquotes</a>
2163 are used to cite passages from another author&#8217;s work.  So that
2164 they stand out well from
2165 <a href="definitions.html#running">running text</a>,
2166 mom indents them from both the left and right margins and sets them
2167 in a different point size
2168 (<a href="docprocessing.html#printstyle">PRINTSTYLE TYPESET</a>
2169 only).
2170 <a href="definitions.html#outputline">Output lines</a>
2171 are
2172 <a href="definitions.html#filled">filled</a>,
2173 and, by default,
2174 <a href="definitions.html#quad">quadded</a>
2175 left.
2176 </p>
2177
2178 <p>
2179 Besides indenting blockquotes, mom further sets them off from
2180 running text with a small amount of vertical whitespace top and
2181 bottom.  (See
2182 <a href="#quote-spacing">above</a>
2183 for a complete explanation of how this is managed, and how
2184 to control it.)
2185 </p>
2186
2187 <!-- -BLOCKQUOTE- -->
2188
2189 <div class="macro-id-overline">
2190 <h3 id="blockquote" class="macro-id">BLOCKQUOTE</h3>
2191 </div>
2192
2193 <div class="box-macro-args">
2194 Macro: <b>BLOCKQUOTE</b> <kbd class="macro-args">toggle</kbd>
2195 </div>
2196
2197 <p class="alias" style="margin-bottom: 0;">
2198 <i>Aliases: </i> <b>CITE, CITATION</b>
2199 </p>
2200
2201 <p>
2202 BLOCKQUOTE is a toggle macro.  To begin a cited passage, invoke
2203 the tag with no argument, then type in your blockquote.  When
2204 you&#8217;re finished, invoke <kbd>.BLOCKQUOTE</kbd> with any
2205 argument (eg <kbd>OFF, END, X, Q</kbd>...) to turn it off.
2206 Example:
2207 <br/>
2208 <span class="pre-in-pp">
2209   .BLOCKQUOTE
2210   Redefining the role of the United States from enablers to keep
2211   the peace to enablers to keep the peace from peacekeepers is
2212   going to be an assignment.
2213   .RIGHT
2214   \[em]George W. Bush
2215   .BLOCKQUOTE END
2216 </span>
2217 If the cited passage runs to more than one paragraph, you must
2218 introduce each paragraph&mdash;including the first&mdash;with
2219 <kbd><a href="#pp">.PP</a></kbd>.
2220 </p>
2221
2222 <div class="box-tip">
2223 <p class="tip">
2224 <span class="note">Note:</span>
2225 The aliases CITE and CITATION may be used in place of the BLOCKQUOTE
2226 tag, as well as in any of the control macros that begin or end with
2227 <kbd>BLOCKQUOTE_</kbd>.
2228 </p>
2229 </div>
2230
2231 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
2232 <h3 id="blockquote-control" class="docs defaults">BLOCKQUOTE control macros and defaults</h3>
2233
2234 <ol style="margin-top: .5em; padding-bottom: .5em;">
2235   <li><a href="#blockquote-general">Family/font/size/leading/colour/quad/indent</a></li>
2236   <li><a href="#bq-always-fullspace-quotes">Spacing above and below (typeset only)</a></li>
2237 </ol>
2238 </div>
2239
2240 <h4 id="blockquote-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour/quad/indent</h4>
2241
2242 <div class="defaults-container" style="padding-bottom: 8px;">
2243 <p class="defaults" style="padding-top: 6px;">
2244 See
2245 <a href="#control-macro-args">Arguments to the control macros</a>.
2246 </p>
2247 <span class="pre defaults">
2248 .BLOCKQUOTE_FAMILY   default = prevailing document family; default is Times Roman
2249 .BLOCKQUOTE_FONT     default = roman
2250 .BLOCKQUOTE_SIZE     default = -1 (point)
2251 .BLOCKQUOTE_AUTOLEAD default = none; leading of blockquotes is the same as paragraphs
2252 .BLOCKQUOTE_COLOR    default = black
2253 .BLOCKQUOTE_QUAD     default = left
2254 .BLOCKQUOTE_INDENT  (see below)
2255 </span>
2256 </div>
2257
2258 <h4 id="blockquote-indent" class="docs" style="margin-top: -1.5em;">Blockquote indent</h4>
2259
2260 <p>
2261 <kbd>BLOCKQUOTE_INDENT</kbd> takes one of two kinds of argument: an
2262 integer representing the amount by which to multiply the argument
2263 passed to
2264 <a href="#para-indent"><kbd>.PARA_INDENT</kbd></a>
2265 (by default, 2
2266 <a href="definitions.html#em">ems</a>
2267 for TYPESET, 3
2268 <a href="definitions.html#picaspoints">picas</a>
2269 for TYPEWRITE) to arrive at the blockquote indent, or a distance with a
2270 <a href="definitions.html#unitofmesaure">unit of measure</a>
2271 appended.  Both result in blockquotes being indented equally from
2272 the left and right margins.
2273 </p>
2274
2275 <p>
2276 The default value for BLOCKQUOTE_INDENT is 3 (for
2277 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>)
2278 and 1 (for
2279 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>).
2280 </p>
2281
2282 <div class="box-tip">
2283 <p class="tip-top">
2284 <span class="note">Note:</span>
2285 If your PARA_INDENT is 0 (ie no indenting of the first line of
2286 paragraphs), you <i>must</i> set a BLOCKQUOTE_INDENT yourself, with
2287 a unit of measure appended to the argument.  Mom has no default for
2288 BLOCKQUOTE_INDENT if paragraph first lines are not being indented.
2289 </p>
2290
2291 <p class="tip-bottom">
2292 <span class="note">Additional note:</span>
2293 BLOCKQUOTE_INDENT also sets the indent for
2294 <a href="#quote">quotes</a>.
2295 </p>
2296 </div>
2297
2298
2299
2300 <h4 id="bq-always-fullspace-quotes" class="docs">2. Spacing above and below blockquotes (typeset only)</h4>
2301
2302 <p>
2303 If you&#8217;d like mom always to put a full linespace above and
2304 below blockquotes, invoke
2305 <br/>
2306 <span class="pre-in-pp">
2307   .ALWAYS_FULLSPACE_QUOTES
2308 </span>
2309 with no argument.  If you wish to restore mom&#8217;s default
2310 behaviour regarding the spacing of blockquotes (see
2311 <a href="#quote-spacing">above</a>),
2312 invoke the macro with any argument (<b>OFF, QUIT, END,
2313 X</b>...).
2314 </p>
2315
2316 <div class="box-tip">
2317 <p class="tip">
2318 <span class="note">Note:</span>
2319 This macro also sets mom&#8217;s spacing policy for
2320 <a href="#quote-intro">quotes</a>.
2321 </p>
2322 </div>
2323
2324 <div class="rule-short"><hr/></div>
2325
2326 <!-- ==================================================================== -->
2327
2328 <h2 id="code-intro" class="macro-group">Inserting code into a document</h2>
2329
2330 <ul style="margin-left: -.5em;">
2331   <li><a href="#code">Tag: CODE</a></li>
2332   <li><a href="#code-control">CODE control macros and defaults</a></li>
2333 </ul>
2334
2335 <p>
2336 CODE is a convenience macro that facilitates entering code blocks
2337 into documents.  Its use is not restricted to documents created
2338 using mom&#8217;s document processing macros; it can be used for
2339 &#8220;manually&#8221; typeset documents as well.
2340 </p>
2341
2342 <div class="macro-id-overline">
2343 <h3 id="code" class="macro-id">CODE</h3>
2344 </div>
2345
2346 <div class="box-macro-args">
2347 Macro: <b>CODE</b> <kbd class="macro-args">[BR | BREAK | SPREAD] toggle</kbd>
2348 </div>
2349
2350 <p class="requires" style="font-style: normal">
2351 Inline escape: <b><kbd>\*[CODE]</kbd></b>
2352 </p>
2353
2354 <p>
2355 When you invoke the macro, <kbd>.CODE</kbd>, or insert <kbd>\*[CODE]</kbd> into
2356 running text, mom switches to a
2357 <a href="definitions.html#fixedwidthfont">fixed-width font</a>
2358 (Courier, by default) and turns
2359 <a href="goodies.html#smartquotes">SMARTQUOTES</a>
2360 off.
2361 </p>
2362
2363 <p>
2364 If your code includes the backslash character, which is
2365 groff&#8217;s escape character, you will have to change the
2366 escape character temporarily to something else with the macro,
2367 <a href="goodies.html#esc-char">ESC_CHAR</a>.
2368 Mom has no way of knowing what special characters you&#8217;re going
2369 to use in code snippets, therefore she cannot automatically replace
2370 the escape character with something else.
2371 </p>
2372
2373 <p>
2374 The correct order for changing the escape character inside
2375 <kbd>CODE</kbd> is
2376 <span class="pre-in-pp">
2377   .CODE
2378   .ESC_CHAR character
2379   &lt;code&gt;
2380   .ESC_CHAR .
2381   .CODE OFF
2382 </span>
2383 </p>
2384
2385 <p>
2386 Alternatively, you can enter the backslash character as
2387 <kbd>\e</kbd>, which tells groff to print a literal backslash.
2388 </p>
2389
2390 <div class="box-tip">
2391 <p class="tip-top">
2392 <span class="tip">Note:</span>
2393 <kbd>.CODE</kbd> does not cause a line break when
2394 you&#8217;re in a
2395 <a href="definitions.html#filled">fill mode</a>
2396 (ie
2397 <a href="typesetting.html#justify">JUSTIFY</a>
2398 or
2399 <a href="typesetting.html#quad">QUAD</a>
2400 <kbd>LEFT, CENTER,</kbd> or <kbd>RIGHT</kbd>).
2401 If you want CODE to deposit a break, invoke <kbd>.CODE</kbd> with
2402 the argument <kbd>BR</kbd> (or <kbd>BREAK</kbd>).  If, in addition
2403 to having mom break the line before <kbd>.CODE</kbd>, you want her
2404 to
2405 <a href="definitions.html#force">force justify</a>
2406 it as well, invoke <kbd>.CODE</kbd> with the argument,
2407 <kbd>SPREAD</kbd>.  If, in addition to breaking the line before CODE
2408 you want a break afterwards, you must supply it manually with
2409 <a href="typesetting.html#br">BR</a>
2410 unless what follows immediately is a macro that automatically causes
2411 a break (eg
2412 <a href="#pp">PP</a>).
2413 </p>
2414
2415 <p class="tip-bottom">
2416 In all likelihood, if you want the situation described above (ie a
2417 break before and after CODE), what you probably want is to use
2418 <a href="quote">QUOTE</a>
2419 in conjunction with CODE, like this:
2420 <br/>
2421 <span class="pre-in-pp">
2422   .QUOTE
2423   .CODE
2424   $ echo "Hello, world" | sed -e 's/Hello,/Goodbye, cruel/'
2425   .CODE OFF
2426   .QUOTE OFF
2427 </span>
2428 QUOTE takes care of breaking both the text and the code, as well as
2429 indenting the code and offsetting it from
2430 <a href="definitions.html#running">running text</a>
2431 with vertical whitespace.
2432 </p>
2433 </div>
2434
2435 <p>
2436 Passing any argument other than <kbd>BR</kbd>, <kbd>BREAK</kbd> or
2437 <kbd>SPREAD</kbd> to CODE (eg <kbd>OFF, QUIT, END, X,</kbd> etc.)
2438 turns CODE off and returns the family, font, and smartquotes back to
2439 their former state.
2440 </p>
2441
2442 <h4 class="docs" style="font-size: 102%">Using <kbd>\*[CODE]</kbd> inline</h4>
2443
2444 <p>
2445 <kbd>\*[CODE]</kbd> invokes <kbd>.CODE</kbd>, allowing you to
2446 bracket code snippets inline.  It does not accept the <kbd>BR</kbd>,
2447 <kbd>BREAK</kbd>, or <kbd>SPREAD</kbd> arguments.  It is most useful
2448 for short snippets, as in the following example.
2449 <br/>
2450 <span class="pre-in-pp">
2451   \*[CODE]apropos\*[CODE OFF] and \*[CODE]man&nbsp;-k\*[CODE] are identical.
2452 </span>
2453 </p>
2454
2455 <p>
2456 <kbd>\*[CODE]</kbd> does not permit changing the escape character,
2457 so <kbd>\e</kbd> must be used.  Furthermore, if your code starts
2458 with a period, you must enter it as &#8220;<kbd>\&.</kbd>&#8221;.
2459 <br/>
2460 <span class="pre-in-pp">
2461   Registers are created with the \*[CODE]\&.nr\*[CODE OFF] request.
2462 </span>
2463 </p>
2464
2465 <h4 class="docs" style="font-size: 102%; margin-top: -1em">CODE and punctuation</h4>
2466
2467 <p>
2468 <kbd>.CODE&nbsp;OFF</kbd> automatically inserts a word space into
2469 running text.  If your CODE block is to be followed by punctuation
2470 with the parameters of
2471 <a href="definitions.html#running">running text</a>,
2472 you must terminate the block with &#8220;<kbd>\c</kbd>&#8221; and
2473 enter the punctuation at the beginning of the next input line.  If
2474 the punctuation mark is a period, you must precede it with
2475 &#8220;<kbd>\&amp;</kbd>&#8221;.
2476 <br/>
2477 <span class="pre-in-pp">
2478   ...for example,
2479   .CODE
2480    echo "Hello, world" | sed -e 's/Hello,/Goodbye, cruel/'\c
2481   .CODE OFF
2482   \&.  As this demonstrates...
2483 </span>
2484 Use of <kbd>\*[CODE]</kbd> inline does not require the
2485 <kbd>\c</kbd>, however periods after <kbd>\*[CODE&nbsp;OFF]</kbd>
2486 still need to be introduced with <kbd>\&</kbd>, as in this example:
2487 <br/>
2488 <span class="pre-in-pp">
2489   ...append the unit of measure \*[CODE]p\*[CODE&nbsp;OFF]\&. New sentence...
2490 </span>
2491 </p>
2492
2493
2494 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
2495 <h3 id="code-control" class="docs defaults">CODE control macros and defaults</h3>
2496
2497 <ol style="margin-top: .5em; padding-bottom: .5em;">
2498   <li><a href="#code-general">Family/Font/Colour</a></li>
2499   <li><a href="#code-size">Size</a></li>
2500 </ol>
2501 </div>
2502
2503 <h4 id="code-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/colour</h4>
2504
2505 <div class="defaults-container" style="padding-bottom: 8px;">
2506 <p class="defaults" style="padding-top: 6px;">
2507 See
2508 <a href="#control-macro-args">Arguments to the control macros</a>.
2509 </p>
2510 <span class="pre defaults">
2511 .CODE_FAMILY  default = Courier
2512 .CODE_FONT    default = roman; see Note
2513 .CODE_COLOR   default = black
2514
2515 Note: Unlike other control macros, CODE_FONT sets the code font for both
2516 PRINTSTYLE TYPESET and PRINTSTYLE TYPEWRITE.
2517 </span>
2518 </div>
2519
2520 <h4 id="code-size" class="docs" style="margin-top: -1.25em;">2. Size</h4>
2521
2522 <p>
2523 CODE_SIZE works a little differently from the other _SIZE macros
2524 (see <a href="#control-macro-args">Arguments to the control
2525 macros</a>).  The argument you pass it is a percentage of the
2526 prevailing document point size.  It does not require a pre-pended
2527 plus (<kbd>+</kbd>) or minus (<kbd>-</kbd>) sign, nor an appended
2528 percent sign (<kbd>%</kbd>).  Thus, is you want the point size of your CODE font to be
2529 90% of the prevailing document point size, you enter:
2530 <br/>
2531 <span class="pre-in-pp">
2532   .CODE_SIZE 90
2533 </span>
2534 Fixed-width fonts have notoriously whimsical
2535 <a href="definitions.html#xheight">x-heights</a>,
2536 meaning that they frequently look bigger (or, in some cases,
2537 smaller) than the type surrounding them, even if they're technically
2538 the same point size.  CODE_SIZE lets you choose a percentage of the
2539 prevailing point size for your fixed-width CODE font so it doesn't look
2540 gangly or miniscule in relation to the type around it.  All
2541 invocations of <kbd>.CODE</kbd> or <kbd>\*[CODE]</kbd> will use this
2542 size, so that if you decide to change the prevailing point size of your
2543 document, the CODE font will be scaled proportionally.
2544 </p>
2545
2546 <div class="rule-short"><hr/></div>
2547
2548 <!-- ==================================================================== -->
2549
2550 <h2 id="list-intro" class="macro-group">Nested lists</h2>
2551
2552 <ul style="margin-left: -.5em;">
2553   <li><a href="#list">Tag: LIST</a></li>
2554   <li><a href="#item">Tag: ITEM</a></li>
2555   <li><a href="#list-control">LIST control macros and defaults</a></li>
2556 </ul>
2557
2558 <p>
2559 Lists are points or items of interest or importance that are
2560 separated from
2561 <a href="definitions.html#running">running text</a>
2562 by enumerators.  Some typical enumerators are
2563 <a href="definitions.html#em">en-dashes</a>,
2564 <a href="definitions.html#bullet">bullets</a>,
2565 digits and letters.
2566 </p>
2567
2568 <p>
2569 Setting lists with mom is easy.  First, you initialize a list with
2570 the LIST macro.  Then, for every item in the list, you invoke
2571 the macro, <kbd>.ITEM</kbd>, followed by the text of the item.
2572 When a list is finished, you exit the list with
2573 <kbd>.LIST&nbsp;OFF</kbd> (or <kbd>QUIT, END, BACK,</kbd> etc.)
2574 </p>
2575
2576 <p>
2577 By default mom starts each list with the enumerator flush with the
2578 left margin of running text that comes before it, like this:
2579 <br/>
2580 <span class="pre-in-pp">
2581   My daily schedule needs organizing.  I can&#8217;t
2582   seem to get everything done I want.
2583   o an hour&#8217;s worth of exercise
2584   o time to prepare at least one healthy
2585     meal per day
2586   o reading time
2587   o work on mom
2588   o writing
2589     - changes from publisher
2590     - current novel
2591   o a couple of hours at the piano
2592 </span>
2593 In other words, mom does not, by default, indent entire lists.
2594 Indenting a list is controlled by the macro,
2595 <a href="#shift-list">SHIFT_LIST</a>.
2596 (This is a design decision; there are too many instances where a
2597 default indent is not desirable.)  Equally, mom does not add any
2598 extra space above or below lists.
2599 </p>
2600
2601 <p>
2602 Lists can be nested (as in the example above).  In other words,
2603 you can set lists within lists, each with an enumerator (and
2604 possibly, indent) of your choosing.  In nested lists, each
2605 invocation of <kbd>.LIST&nbsp;OFF</kbd> (you may prefer to use
2606 <kbd>.LIST&nbsp;BACK</kbd>) takes you back to the previous depth
2607 (or level) of list, with that list&#8217;s enumerator and indent
2608 intact.  The final <kbd>.LIST&nbsp;OFF</kbd> exits lists completely
2609 and returns you to the left margin of running text.
2610 </p>
2611
2612 <p>
2613 Finally, lists can be used in documents created with either the
2614 <a href="docprocessing.html#top">document processing macros</a>
2615 or the
2616 <a href="typesetting.html#top">typesetting macros</a>.
2617 </p>
2618
2619 <!-- -LIST- -->
2620
2621 <div class="macro-id-overline">
2622 <h3 id="list" class="macro-id">LIST</h3>
2623 </div>
2624
2625 <div class="box-macro-args">
2626 Macro: <b>LIST</b> <kbd class="macro-args">[ BULLET | DASH | DIGIT | ALPHA | alpha | ROMAN&lt;n&gt; | roman&lt;n&gt; | USER &lt;string&gt;] [ &lt;separator&gt; | &lt;user-defined enumerator&gt; ] [ &lt;prefix&gt; ] [ &lt;off&gt; ]</kbd>
2627 </div>
2628
2629 <p>
2630 Invoked by itself (ie with no argument), LIST
2631 initializes a list (with bullets as the default enumerator).
2632 Afterwards, each block of input text preceded by
2633 <kbd><a href="#item">.ITEM</a></kbd>,
2634 on a line by itself, is treated as a list item.
2635 </p>
2636
2637 <div class="box-tip">
2638 <p class="tip">
2639 <span class="note">Note:</span>
2640 Every time you invoke <kbd>.LIST</kbd> to start a list (as opposed to
2641 <a href="#list-exit">exiting one</a>),
2642 you must supply an enumerator (and optionally, a separator) for the
2643 list, unless you want mom&#8217;s default enumerator, which is a
2644 bullet.  Within nested lists, mom stores the enumerator, separator
2645 and indent for any list you return <i>backwards</i> to (ie with
2646 <kbd>.LIST OFF</kbd>), but does not store any information for lists
2647 you move <i>forward</i> to.
2648 </p>
2649 </div>
2650
2651 <p>
2652 There are a lot of arguments (be sure to side-scroll through them
2653 all, above), so I&#8217;ll discuss them one at a time here.
2654 </p>
2655 <h3 class="docs">The first argument &ndash; enumerator style</h3>
2656
2657 <p>
2658 The optional arguments <kbd>BULLET</kbd>, <kbd>DASH</kbd>,
2659 <kbd>DIGIT</kbd> (for Arabic numerals), <kbd>ALPHA</kbd> (for
2660 uppercase letters), <kbd>alpha</kbd> (for lowercase letters),
2661 <kbd>ROMAN&lt;n&gt;</kbd> (for uppercase roman numerals),
2662 <kbd>roman&lt;n&gt;</kbd> (for lowercase roman numerals) tell
2663 <kbd>mom</kbd> what kind of enumerator to use for a given list.
2664 </p>
2665
2666 <p>
2667 The arguments, <kbd>ROMAN&lt;n&gt;</kbd> and
2668 <kbd>roman&lt;n&gt;</kbd>, are special.  You must append to them
2669 a digit (arabic, eg "1" or "9" or "17") saying how many items a
2670 particular roman-numeralled LIST is going to have. Mom requires this
2671 information in order to align roman numerals sensibly, and will
2672 abort&mdash;with a message &mdash; if you don&#8217;t provide it.
2673 </p>
2674
2675 <p>
2676 A roman-numeralled list containing, say, five items, would be set
2677 up like this:
2678 <br/>
2679 <span class="pre-in-pp">
2680   .LIST roman5        producing        i)   Item 1.
2681   .ITEM                                ii)  Item 2.
2682   Item 1.                              iii) Item 3.
2683   .ITEM                                iv)  Item 4.
2684   Item 2.                              v)   Item 5.
2685   .ITEM
2686   Item 3
2687   .ITEM
2688   Item 4
2689   .ITEM
2690   Item 5
2691 </span>
2692 </p>
2693
2694 <p>
2695 The argument, <kbd>USER</kbd>, lets you make up your own enumerator,
2696 and must be followed by a second argument: what you&#8217;d like the
2697 enumerator to look like.
2698 </p>
2699
2700 <p>
2701 For example, if you want a list enumerated with <kbd>=&gt;</kbd>,
2702 <br/>
2703 <span class="pre-in-pp">
2704   .LIST USER =&gt;
2705   .ITEM
2706   A list item
2707 </span>
2708
2709 will produce
2710 <br/>
2711 <span class="pre-in-pp">
2712   =&gt; A list item
2713 </span>
2714 Some useful special groff characters you might want to pass to
2715 <kbd>USER</kbd> are:
2716 <span class="pre-in-pp">
2717   \[sq] - square box
2718   \[rh] - pointing hand
2719   \[-&gt;] - right arrow
2720   \[rA] - right double arrow
2721   \[OK] - checkmark
2722 </span>
2723 The size and vertical positioning of special characters may be
2724 adjusted with
2725 <a href="definitions.html#inlines">inline escapes</a>
2726 in the argument passed to USER.  For example, to raise the position
2727 of <kbd>\[sq]</kbd> slightly, you might do
2728 <span class="pre-in-pp">
2729   .LIST USER "\*[UP .25p]\[sq]\*[DOWN .25p]"
2730     or
2731   .LIST USER \v'-.25p]\[sq]\[\v'.25p']
2732 </span>
2733 </p>
2734
2735 <div class="box-tip">
2736 <p class="tip">
2737 <span class="note">Note:</span>
2738 If the argument to <kbd>USER</kbd> contains spaces, you must enclose
2739 the argument in double quotes.
2740 </p>
2741 </div>
2742
2743 <h3 class="docs">The second argument &ndash; separator style</h3>
2744
2745 <p>
2746 If you choose <kbd>DIGIT</kbd>, <kbd>ALPHA</kbd>, <kbd>alpha</kbd>,
2747 <kbd>ROMAN&lt;n&gt;</kbd>, or <kbd>roman&lt;n&gt;</kbd>, you may
2748 enter the optional argument, <kbd>separator</kbd>, to say what kind
2749 of separator you want after the enumerator.  The separator can be
2750 anything you like.  The default for <kbd>DIGIT</kbd> is a period
2751 (dot), like this:
2752 <br/>
2753 <span class="pre-in-pp">
2754   1. A list item
2755 </span>
2756 The default separator for <kbd>ALPHA</kbd>, <kbd>alpha</kbd>,
2757 <kbd>ROMAN&lt;n&gt;</kbd> and <kbd>roman&lt;n&gt;</kbd> is a right
2758 parenthesis, like this:
2759 <br/>
2760 <span class="pre-in-pp">
2761   a) An alpha-ed list item
2762   b) A second alpha-ed list item
2763 </span>
2764 If you&#8217;d prefer, say, digits with right-parenthesis separators
2765 instead of the default period, you&#8217;d do
2766 <br/>
2767 <span class="pre-in-pp">
2768   .LIST DIGIT )
2769   .ITEM
2770   A numbered list item
2771 </span>
2772 which would produce
2773 <br/>
2774 <span class="pre-in-pp">
2775   1) A numbered list item
2776 </span>
2777 </p>
2778
2779 <div class="box-tip">
2780 <p class="tip">
2781 <span class="note">Note:</span>
2782 <kbd>BULLET</kbd>, <kbd>DASH</kbd> and <kbd>USER</kbd> do not take a
2783 separator.
2784 </p>
2785 </div>
2786
2787 <h3 class="docs">The third argument &ndash; prefix style</h3>
2788
2789 <p>
2790 Additionally, you may give a prefix (ie a character
2791 that comes <i>before</i> the enumerator) when your
2792 enumerator style for a particular list is <kbd>DIGIT</kbd>,
2793 <kbd>ALPHA</kbd>, <kbd>alpha</kbd>, <kbd>ROMAN&lt;n&gt;</kbd> or
2794 <kbd>roman&lt;n&gt;</kbd>.  In the arguments to LIST, the prefix
2795 comes <i>after</i> the separator, which is counter-intuitive,
2796 so please be careful.
2797 </p>
2798
2799 <p>
2800 A prefix can be anything you like.  Most likely, you&#8217;ll want
2801 some kind of open-bracket, such as a left parenthesis.  If, for
2802 example, you want a <kbd>DIGIT</kbd> list with the numbers enclosed
2803 in parentheses, you&#8217;d enter
2804 <br/>
2805 <span class="pre-in-pp">
2806   .LIST DIGIT ) (
2807   .ITEM
2808   The first item on the list.
2809   .ITEM
2810   The second item on the list.
2811 </span>
2812 which would produce
2813 <br/>
2814 <span class="pre-in-pp">
2815   (1) The first item on the list.
2816   (2) The second item on the list.
2817 </span>
2818 </p>
2819
2820 <div class="box-tip">
2821 <p class="tip">
2822 <span class="note">Note:</span>
2823 <kbd>BULLET</kbd>, <kbd>DASH</kbd> and
2824 <kbd>USER</kbd> do not take a prefix.
2825 </p>
2826 </div>
2827
2828 <h3 class="docs">Exiting lists &ndash; LIST OFF/BACK or QUIT_LISTS</h3>
2829
2830 <p>
2831 Any single argument to <kbd>LIST</kbd> other than
2832 <kbd>BULLET</kbd>, <kbd>DASH</kbd>, <kbd>DIGIT</kbd>,
2833 <kbd>ALPHA</kbd>, <kbd>alpha</kbd>, <kbd>ROMAN&lt;n&gt;</kbd>,
2834 <kbd>roman&lt;n&gt;</kbd> or <kbd>USER</kbd> (eg
2835 <kbd>LIST&nbsp;OFF</kbd> or <kbd>LIST&nbsp;BACK</kbd>) takes you out
2836 of the current list.
2837 </p>
2838
2839 <p>
2840 If you are at the first list-level (or list-depth), mom returns you
2841 to the left margin of running text.  Any indents that were in effect
2842 prior to setting the list are fully restored.
2843 </p>
2844
2845 <p>
2846 If you are in a nested list, mom moves you back one list-level
2847 (ie does not take you out of the list structure) and restores the
2848 enumerator, separator and indent appropriate to that level.
2849 </p>
2850
2851 <p>
2852 Each invocation of <kbd>.LIST</kbd> should thus be be matched by
2853 a corresponding <kbd>.LIST&nbsp;OFF</kbd> in order to fully exit
2854 lists.  For example,
2855 <br/>
2856 <span class="pre-in-pp">
2857   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2858   sed diam nonumy eirmod tempor invidunt ut labore.
2859   o List item in level 1
2860   o List item in level 1
2861     - List item in level 2
2862     - List item in level 2
2863   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2864   sed diam nonumy eirmod tempor invidunt ut labore.
2865 </span>
2866 is created like this:
2867 <br/>
2868 <span class="pre-in-pp">
2869   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2870   sed diam nonumy eirmod tempor invidunt ut labore.
2871   .LIST BULLET
2872   .ITEM
2873   List item in level 1
2874   .ITEM
2875   List item in level 1
2876   .LIST DASH
2877   .ITEM
2878   List item in level 2
2879   .ITEM
2880   List item in level 2
2881   .LIST OFF    \" Turn level 2 list off
2882   .LIST OFF    \" Turn level 1 list off
2883   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2884   sed diam nonumy eirmod tempor invidunt ut labore.
2885 </span>
2886 </p>
2887
2888 <p>
2889 Alternatively, you may use the single-purpose macro,
2890 <kbd>.QUIT_LISTS</kbd>, to get yourself out of a list structure.  In
2891 the example above, the two <kbd>.LIST&nbsp;OFF</kbd> lines could be
2892 replaced with a single <kbd>.QUIT_LISTS</kbd>.
2893 </p>
2894
2895 <div class="macro-id-overline">
2896 <h3 id="item" class="macro-id">ITEM</h3>
2897 </div>
2898
2899 <div class="box-macro-args">
2900 Macro: <b>ITEM</b>
2901 </div>
2902
2903 <p>
2904 After you&#8217;ve initialized a list with
2905 <a href="#list">LIST</a>,
2906 precede each item you want in the list with <kbd>.ITEM</kbd>.  Mom
2907 takes care of everything else with respect to setting the item
2908 appropriate to the list you&#8217;re in.
2909 </p>
2910
2911 <p>
2912 In document processing, it is valid to have list items that contain
2913 multiple paragraphs.  Simply issue a
2914 <kbd><a href="#pp">.PP</a></kbd>
2915 request for each paragraph <i>following</i> the first item.
2916 I.e., don&#8217;t do this:
2917 <br/>
2918 <span class="pre-in-pp">
2919   .ITEM
2920   .PP
2921   Some text...
2922   .PP
2923   A second paragraph of text
2924 </span>
2925 but rather
2926 <br/>
2927 <span class="pre-in-pp">
2928   .ITEM
2929   Some text...
2930   .PP
2931   A second paragraph of text
2932 </span>
2933 </p>
2934
2935 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
2936 <h3 id="list-control" class="docs defaults">LIST control macros and defaults</h3>
2937
2938 <ol style="margin-top: .5em; padding-bottom: .5em;">
2939   <li><a href="#shift-list">Indenting lists (SHIFT_LIST)</a></li>
2940   <li><a href="#reset-list">Resetting an initialized list&#8217;s enumerator (RESET_LIST)</a></li>
2941   <li><a href="#pad-list-digits">Padding digit enumerators (PAD_LIST_DIGITS)</a></li>
2942 </ol>
2943 </div>
2944
2945 <h4 id="shift-list" class="docs" style="margin-top: -1.5em;">1. Indenting lists &ndash; SHIFT_LIST</h4>
2946
2947 <p>
2948 If you want a list to be indented to the right of running text, or
2949 indented to the right of a current list, use the macro SHIFT_LIST
2950 immediately after
2951 <a href="#list">LIST</a>.
2952 SHIFT_LIST takes just one argument: the amount by which you want the
2953 list shifted to the right.  The argument requires a
2954 <a href="definitions.html#unitofmeasure">unit of measure</a>.
2955 </p>
2956
2957 <p>
2958 SHIFT_LIST applies only to the list you just initialized with LIST.
2959 It does not carry over from one invocation of LIST to the next.
2960 However, the indent remains in effect when you return to a list
2961 level in a nested list.
2962 </p>
2963
2964 <p>
2965 For example, if you want a 2-level list, with each list indented to
2966 the right by 18
2967 <a href="definitions.html#picaspoints">points</a>,
2968 <br/>
2969 <span class="pre-in-pp">
2970   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2971   sed diam nonumy eirmod tempor invidunt ut labore.
2972   .LIST           \" List 1
2973   .SHIFT_LIST 18p \" Indent 18 points right of running text
2974   .ITEM
2975   List 1 item
2976   .ITEM
2977   List 1 item
2978   .LIST DASH      \" List 2
2979   .SHIFT_LIST 18p \" Indent 18 points right of list 1
2980   .ITEM
2981   List 2 item
2982   .ITEM
2983   List 2 item
2984   .LIST OFF       \" Move back to list 1
2985   .ITEM
2986   List 1 item
2987   .ITEM
2988   List 1 item
2989   .LIST OFF       \" Exit lists
2990   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2991   sed diam nonumy eirmod tempor invidunt ut labore.
2992 </span>
2993 produces (approximately)
2994 <br/>
2995 <span class="pre-in-pp">
2996   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
2997   sed diam nonumy eirmod tempor invidunt ut labore.
2998       o List 1 item
2999       o List 1 item
3000           - List 2 item
3001           - List 2 item
3002       o List 1 item
3003       o List 1 item
3004   Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
3005   sed diam nonumy eirmod tempor invidunt ut labore.
3006 </span>
3007 </p>
3008
3009 <h4 id="reset-list" class="docs" style="margin-top: -.25em;">2. Resetting an initialized list&#8217;s enumerator &ndash; RESET_LIST</h4>
3010
3011 <p>
3012 In nested lists, if your choice of list enumerator for a given level
3013 of list is <kbd>DIGIT</kbd>, <kbd>ALPHA</kbd>, <kbd>alpha</kbd>,
3014 <kbd>ROMAN</kbd> or <kbd>roman</kbd>, you may sometimes want to
3015 reset the list&#8217;s enumerator when you return to that list.
3016 Consider the following:
3017 <br/>
3018 <span class="pre-in-pp">
3019   Things to do religiously each and every day:
3020   1. Take care of the dog
3021      a) walk every day
3022      b) brush once a week
3023         - trim around the eyes every fourth brushing
3024         - don&#8217;t forget to check nails
3025   2. Feed the cat
3026      a) soft food on Mon., Wed. and Fri.
3027      b) dry food on Tues., Thurs. and Sat.
3028      c) canned tuna on Sunday
3029 </span>
3030 </p>
3031
3032 <p>
3033 Normally, within a nested list, when you return to an
3034 incrementally-enumerated list, the enumerator continues incrementing
3035 from where it left off.  That means, in the example above, the
3036 normal state of affairs for the alpha'ed list under
3037 <br/>
3038 <span class="pre-in-pp">
3039   2.  Feed the cat
3040 </span>
3041 would be d), e) and f).  The solution, in such a case, is simply
3042 to reset the enumerator&mdash;before <kbd>.ITEM</kbd>&mdash;with
3043 the macro, <kbd>.RESET_LIST</kbd>.  By default, with no argument,
3044 <kbd>.RESET_LIST</kbd> resets the enumerator to 1, A, a, I or i
3045 depending on the style of enumerator.  You may, if you wish, pass
3046 <kbd>.RESET_LIST</kbd> a
3047 <a href="definitions.html#numericargument">numeric argument</a>
3048 representing the starting enumerator for the reset (if different
3049 from "1"), although I can&#8217;t at present think of a use for this
3050 feature.
3051 </p>
3052
3053 <h4 id="pad-list-digits" class="docs" style="margin-top: -.25em;">3. Padding digit enumerators &ndash; PAD_LIST_DIGITS</h4>
3054
3055 <h5 class="docs" style="margin-top: 1em;">Arabic digits</h5>
3056
3057 <p style="margin-top: .5em;">
3058 When your choice of enumerators is DIGIT and the number of items
3059 in the list exceeds nine (9), you have to make a design decision:
3060 should mom leave room for the extra numeral in two-numeral digits to
3061 the right or the left of the single-numeral digits?
3062 </p>
3063
3064 <p>
3065 If you want the extra space to the right, invoke the macro,
3066 <kbd>.PAD_LIST_DIGITS</kbd> (with no argument), after
3067 <kbd>.LIST</kbd> and before <kbd>.ITEM</kbd>.  This will produce
3068 something like
3069 <br/>
3070 <span class="pre-in-pp">
3071   8.  List item
3072   9.  List item
3073   10. List item
3074 </span>
3075 If you want the extra space to the left, invoke
3076 <kbd>.PAD_LIST_DIGITS</kbd> with the single argument,
3077 <kbd>LEFT</kbd>, which will produce
3078 <br/>
3079 <span class="pre-in-pp">
3080    8. List item
3081    9. List item
3082   10. List item
3083 </span>
3084 </p>
3085
3086 <p>
3087 Of course, if the number of items in the list is less than ten
3088 (10), there&#8217;s no need for PAD_LIST_DIGITS.
3089 </p>
3090
3091 <h5 class="docs" style="margin-top: -.5em;">Roman numerals</h5>
3092
3093 <p style="margin-top: .5em;">
3094 By default, mom sets roman numerals in lists flush left.  The
3095 <kbd>&lt;n&gt;</kbd> argument appended to <kbd>ROMAN&lt;n&gt;</kbd>
3096 or <kbd>roman&lt;n&gt;</kbd> allows her to calculate how much space
3097 to put after each numeral in order to ensure that the text of items
3098 lines up properly.
3099 </p>
3100
3101 <p>
3102 If you&#8217;d like the roman numerals to line
3103 up flush right (ie be padded "left"), simply
3104 invoke <kbd>.PAD_LIST_DIGITS&nbsp;LEFT</kbd> after
3105 <kbd>.LIST&nbsp;ROMAN&lt;n&gt;</kbd> or
3106 <kbd>.LIST&nbsp;roman&lt;n&gt;</kbd> and before <kbd>.ITEM</kbd>.
3107 </p>
3108
3109 <div class="rule-short"><hr/></div>
3110
3111 <!-- -LINE NUMBERING- -->
3112
3113 <h2 id="number-lines-intro" class="macro-group">Line numbering &ndash; prepend numbers to output lines</h2>
3114
3115 <ul style="margin-left: -.5em;">
3116   <li><a href="#number-lines">Macro: <b>NUMBER_LINES</b></a>
3117   <ul style="margin-left: -.5em;">
3118     <li><a href="#ln-control">Line numbering control (off/suspend, resume)</a></li>
3119   </ul></li>
3120   <li><a href="#number-lines-control">Control macros and defaults</a>
3121   <ul style="margin-left: -.5em;">
3122     <li><a href="#number-quote-lines">Line numbering control macros for quotes and blockquotes</a></li>
3123   </ul></li>
3124 </ul>
3125
3126 <p style="margin-top: -.5em;">
3127 When you turn line-numbering on, mom, by default
3128 </p>
3129 <ul style="margin-top: -.5em;">
3130   <li>numbers every line of paragraph text; line-numbering is
3131       suspended for all other document processing tags (like
3132       docheaders, epigraphs, headings, quotes, etc.) and special
3133       pages (covers, endotes, bibliographies, etc.); be aware,
3134       though, that if you turn
3135       <a href="definitions.html#docheader">docheaders</a>
3136       off (with
3137       <a href="docprocessing.html#docheader">DOCHEADER</a> OFF)
3138       and create your own docheader, mom
3139       <i>will</i> line-number your custom docheader, so turn
3140       line numbering on afterwards
3141   </li>
3142   <li>doesn&#8217;t touch your line length; line numbers are hung
3143       outside your current left margin (as set with
3144       <a href="typesetting.html#l-margin">L_MARGIN</a>,
3145       <a href="typesetting.html#page">PAGE</a>
3146       or
3147       <a href="docprocessing.html#doc-left-margin">DOC_LEFT_MARGIN</a>),
3148       regardless of any indents that may be active
3149   </li>
3150   <li>separates line numbers from running text by two
3151       <a href="definitions.html#figurespace">figure spaces</a>.
3152   </li>
3153 </ul>
3154
3155 <p>
3156 Mom expects that
3157 <kbd><a href="#quote">QUOTE</a></kbd>s
3158 and
3159 <kbd><a href="#blockquote">BLOCKQUOTE</a></kbd>s
3160 will not be line-numbered, however control macros
3161 are provided to enable line numbering for either.
3162 See
3163 <a href="#number-quote-lines">Line numbering control macros for quotes and blockquotes</a>.
3164 </p>
3165
3166 <!-- -NUMBER_LINES- -->
3167
3168 <div class="macro-id-overline">
3169 <h3 id="number-lines" class="macro-id">NUMBER_LINES</h3>
3170 </div>
3171
3172 <div class="box-macro-args">
3173 Macro: <b>NUMBER_LINES</b> <kbd class="macro-args">&lt;start number&gt; [ &lt;which lines to number&gt; [ &lt;gutter&gt; ] ]</kbd>
3174 </div>
3175
3176 <div class="box-macro-args" style="margin-top: 1em;">
3177 Macro: <b>NUMBER_LINES</b>  <kbd class="macro-args">&lt;anything&gt; | RESUME</kbd>
3178 </div>
3179
3180 <p>
3181 NUMBER_LINES does what it says: prints line numbers, to the left of
3182 <a href="definitions.html#outputline">output lines</a>
3183 of paragraph text.  One of the chief reasons for wanting numbered
3184 lines is in order to identify footnotes or endnotes by line number
3185 instead of by a marker in the text.  (See
3186 <a href="#footnotes-by-linenumber">Footnotes by linenumber</a>
3187 for instructions on line-numbered footnotes, and
3188 <a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE LINE</a>
3189 for instructions on line-numbered endnotes.)
3190 </p>
3191
3192 <div class="box-tip">
3193 <p class="tip">
3194 <span class="note">Note:</span>
3195 Do not use <kbd>NUMBER_LINES</kbd> inside
3196 <a href="#quote">QUOTE</a>
3197 or
3198 <a href="#blockquote">BLOCKQUOTE</a>.
3199 By default, mom expects that quotes and blockquotes will not be
3200 line numbered.  If you wish to enable line numbering for them, you
3201 must invoke
3202 <a href="#number-quote-lines">NUMBER_QUOTE_LINES</a>
3203 or
3204 <a href="#number-quote-lines">NUMBER_BLOCKQUOTE_LINES</a>.
3205 </p>
3206 </div>
3207
3208
3209 <p>
3210 The first time you invoke
3211 <a href="#number-lines">NUMBER_LINES</a>
3212 you must, at a minimum, tell it what line number you want the
3213 <i>next</i>
3214 <a href="definitions.html#outputline">output line</a>
3215 to have.  The optional arguments <kbd>which lines to number</kbd>
3216 and <kbd>gutter</kbd> allow you to state which lines should
3217 be numbered (eg every five or every ten lines), and the gutter to
3218 place between line numbers and
3219 <a href="definitions.html#running">running text</a>.
3220 </p>
3221
3222 <p>
3223 For example, if you want mom to number output lines using her defaults,
3224 <span class="pre-in-pp">
3225   .NUMBER_LINES 1
3226 </span>
3227 will prepend the number, 1, to the next output line and number all
3228 subsequent output lines sequentially.
3229 </p>
3230
3231 <p>
3232 If you want only every five lines numbered, pass mom the optional
3233 <kbd>which lines to number</kbd> argument, like this:
3234 <span class="pre-in-pp">
3235   .NUMBER_LINES 1 5
3236 </span>
3237 </p>
3238
3239 <div class="box-important">
3240 <p class="tip-top">
3241 <span class="important">GOTCHA!</span>
3242 The argument to <kbd>&lt;which lines to number&gt;</kbd> instructs
3243 mom to number only those lines that are multiples of the argument.
3244 Hence, in the above example, line number <kbd>1</kbd> will
3245 <i>not</i> be numbered, since <kbd>1</kbd> is not a multiple of
3246 <kbd>5</kbd>.
3247 </p>
3248
3249 <p>
3250 If you want line number <kbd>1</kbd> to be numbered, you have to
3251 invoke <kbd>.NUMBER_LINES 1 1</kbd> before the first output line
3252 you want numbered, then study your <i>output</i> copy and determine
3253 where best to insert the following in your <i>input</i> input text:
3254 <br/>
3255 <span class="pre-in-pp">
3256   .NUMBER_LINES \n[ln] 5
3257 </span>
3258 (The escape, <kbd>\n[ln]</kbd>, ensures that NUMBER_LINES
3259 automatically supplies the correct value for the first argument,
3260 <kbd>&lt;start number&gt;</kbd>.)
3261 </p>
3262
3263 <p class="tip-bottom">
3264 Following this recipe, line number <kbd>1</kbd> will be numbered;
3265 subsequently, only line numbers that are multiples of 5 will be
3266 numbered.  A little experimentation may be required to determine the
3267 best place for it in your input text.
3268 </p>
3269 </div>
3270
3271 <p>
3272 The optional argument, <kbd>&lt;gutter&gt;</kbd>, tells mom how much
3273 space to put between the line numbers and the running text.
3274 <kbd>&lt;gutter&gt;</kbd> does not require (or even accept) a
3275 <a href="definitions.html#unitofmeasure">unit of measure</a>.
3276 The argument you pass to it is the number of
3277 <a href="definitions.html#figurespace">figure spaces</a>
3278 you want between line numbers and running text.
3279 Mom&#8217;s default gutter is two figure spaces.  If
3280 you&#8217;d like a wider gutter, say, four figures spaces, you&#8217;d do
3281 <br/>
3282 <span class="pre-in-pp">
3283   .NUMBER_LINES 1 1 4
3284                   |
3285                   +-- Notice you *must* supply a value
3286                       for the 2nd argument in order to supply
3287                       a value for the 3rd.
3288 </span>
3289 </p>
3290
3291 <div class="box-tip">
3292 <p class="tip">
3293 <span class="note">Note:</span>
3294 When giving a value for <kbd>&lt;gutter&gt;</kbd>, you cannot skip
3295 the <kbd>&lt;which lines to number&gt;</kbd> argument.  Either fill
3296 in the desired value, or use two double-quotes ( <kbd>""</kbd> ) to
3297 have mom use the value formerly in effect.
3298 </p>
3299 </div>
3300
3301 <h3 id="ln-control" class="docs" style="margin-top: -.5em;">Off/suspend, resume</h3>
3302
3303 <p style="margin-top: .5em;">
3304 After initializing line numbering, you can suspend it, with the
3305 option to resume, using
3306 <br/>
3307 <span class="pre-in-pp">
3308   .NUMBER_LINES&nbsp;OFF
3309 </span>
3310 (or <kbd>END, QUIT, X,</kbd> etc).
3311 </p>
3312
3313 <p>To resume line numbering:
3314 <br/>
3315 <span class="pre-in-pp">
3316   .NUMBER_LINES RESUME
3317 </span>
3318 When you resume, the line number will be the next in sequence
3319 from where you left off.  If that is not what you want&mdash;say
3320 you want to reset the line number to <kbd>1</kbd>&mdash;re-invoke
3321 <kbd>.NUMBER_LINES</kbd> with whatever arguments are needed for the
3322 desired result.
3323 </p>
3324
3325 <div class="box-tip" style="margin-left: 6px;">
3326 <p class="tip">
3327 <span class="note">Additional notes:</span>
3328 </p>
3329 <ol style="margin-top: -1.25em; margin-left: -1.25em; padding-bottom: .5em;">
3330   <li>In document processing, you may invoke
3331       <kbd>.NUMBER_LINES</kbd> either before or after
3332       <kbd>.START</kbd>.  Mom doesn&#8217;t care.
3333   </li>
3334   <li style="margin-top: .25em;">If you&#8217;re collating documents with
3335       <a href="rectoverso.html#collate">COLLATE</a>,
3336       you should re-invoke, at a minimum,
3337       <kbd>.NUMBER_LINES&nbsp;1</kbd> for each collated
3338       document, in order to ensure that each begins with the
3339       number, <kbd>1</kbd>, prepended to the first line.
3340   </li>
3341   <li style="margin-top: .25em;">Occasionally, you may want to
3342       change the current gutter between line numbers and running
3343       text without knowing what the next output line number should
3344       be.  Since NUMBER_LINES requires this number as its first
3345       argument, in such instances, pass NUMBER_LINES as its first
3346       argument the escape
3347       <kbd>\n[ln]</kbd>.
3348       <br/>
3349       <span style="display: block; margin-top: .5em;">For example, if you were numbering every 5 lines with a
3350       gutter of 2 (figure spaces) and you needed to change the
3351       gutter to 4 (figures spaces),
3352       <br/>
3353       <span class="pre-in-pp" style="margin-bottom: -2em;">
3354   .NUMBER_LINES \n[ln] 5 4
3355       </span>
3356       would do the trick.
3357       </span>
3358   </li>
3359   <li style="margin-top: .25em;">If you&#8217;re using
3360       <a href="#mn-intro">margin notes</a>
3361       in a document, be sure to set the gutter for margin notes wide
3362       enough to allow room for the line numbers.
3363   </li>
3364   <li style="margin-top: .25em;">Mom (groff, actually), only numbers
3365       lines <i>to the left</i> of running text.  For aesthetic
3366       reason, therefore, the use of line numbering when setting a
3367       document in columns is discouraged.  However, should you wish
3368       to number lines when setting in columns, make sure the
3369       <a href="definitions.html#gutter">gutter(s)</a>
3370       between columns is wide enough to leave room for the numbers.
3371   </li>
3372 </ol>
3373 </div>
3374
3375 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
3376 <h3 id="number-lines-control" class="docs defaults">NUMBER_LINES control macros and defaults</h3>
3377
3378 <ol style="margin-top: .5em; padding-bottom: .5em;">
3379   <li><a href="#number-lines-general">Family/font/size/colour</a></li>
3380   <li><a href="#number-quote-lines">Line numbering control for quotes and blockquotes</a>
3381   <ul>
3382     <li><a href="#number-quote-lines-global">Including QUOTEs and BLOCKQUOTEs in the line numbering scheme</a></li>
3383     <li><a href="#number-quote-lines-selective">Selectively enabling line numbering for QUOTEs and BLOCKQUOTEs</a></li>
3384     <li><a href="#number-quote-lines-gutter">Changing the line number gutter for QUOTEs and BLOCKQUOTEs</a></li>
3385     <li><a href="#number-quote-lines-silent">Silently increment line numbers during  QUOTE and BLOCKQUOTE</a></li>
3386   </ul></li>
3387 </ol>
3388 </div>
3389
3390 <h4 id="number-lines-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour</h4>
3391
3392 <div class="defaults-container" style="padding-bottom: 8px;">
3393 <p class="defaults" style="padding-top: 6px;">
3394 See
3395 <a href="#control-macro-args">Arguments to the control macros</a>.
3396 </p>
3397 <span class="pre defaults">
3398 .LINENUMBER_FAMILY default = prevailing family or document family; default is Times Roman
3399 .LINENUMBER_FONT   default = prevailing font
3400 .LINENUMBER_SIZE   default = +0
3401 .LINENUMBER_COLOR  default = black
3402 </span>
3403 </div>
3404
3405 <h4 id="number-quote-lines" class="docs" style="margin-top: -1.75em;">2. Line numbering control macros for QUOTE and BLOCKQUOTE</h4>
3406
3407 <h5 id="number-quote-lines-global" class="docs" style="font-size: 87%">&bull;&nbsp;Including QUOTEs and BLOCKQUOTEs in the line numbering scheme</h5>
3408
3409 <p>
3410 If you&#8217;d like mom to number lines in a
3411 <a href="#quote">QUOTE</a>
3412 or
3413 <a href="#blockquote">BLOCKQUOTE</a>
3414 as part of the same order and sequence as paragraph text,
3415 invoke
3416 <span class="pre-in-pp">
3417   .NUMBER_QUOTE_LINES
3418 </span>
3419 or
3420 <span class="pre-in-pp">
3421   .NUMBER_BLOCKQUOTE_LINES
3422 </span>
3423 either before or after <kbd>NUMBER_LINES</kbd>.  Both behave
3424 identically with respect to the affected macro (ie <kbd>QUOTE</kbd>
3425 or <kbd>BLOCKQUOTE</kbd>).
3426 </p>
3427
3428 <h5 id="number-quote-lines-selective" class="docs" style="font-size: 87%">&bull;&nbsp;Selectively enabling line numbering for QUOTEs and BLOCKQUOTEs</h5>
3429
3430 <p>
3431 If you&#8217;d like to enable line numbering
3432 selectively for quotes and blockquotes <i>only</i>, enable
3433 <kbd>NUMBER_QUOTE_LINES</kbd> or <kbd>NUMBER_BLOCKQUOTE_LINES</kbd>
3434 first, followed by <kbd>NUMBER_LINES&nbsp;&lt;n&gt;</kbd>, where
3435 <kbd>&lt;n&gt;</kbd> is the first line number of the quote
3436 or blockquote.  Afterwards, enter your <kbd>QUOTE</kbd> or
3437 <kbd>BLOCKQUOTE</kbd>.  When the quote or blockquote is finished (ie
3438 after <kbd>QUOTE&nbsp;OFF</kbd> or <kbd>BLOCKQUOTE&nbsp;OFF</kbd>),
3439 turn line numbering off.  Each subsequent quote or blockquote you
3440 want line numbered requires only <kbd>NUMBER_LINES &lt;n&gt;</kbd>
3441 (with a corresponding <kbd>NUMBER_LINES OFF</kbd>) until you turn
3442 <kbd>NUMBER_QUOTE_LINES</kbd> or <kbd>NUMBER_BLOCKQUOTE_LINES</kbd>
3443 off.
3444 </p>
3445
3446 <p>
3447 Here&#8217;s a recipe where the first line number of quotes starts
3448 repeatedly at &#8220;1&#8221;.
3449 <span class="pre-in-pp">
3450   &lt;running text&gt;
3451   .NUMBER_QUOTE_LINES
3452   .NUMBER_LINES 1
3453   .QUOTE
3454   &lt;text of quote&gt;
3455   .QUOTE OFF
3456   .NUMBER_LINES OFF
3457   &lt;further running text&gt;
3458   .NUMBER_LINES 1
3459   .QUOTE
3460   &lt;text of quote&gt;
3461   .QUOTE OFF
3462   .NUMBER_LINES OFF
3463   &lt;further running text&gt;
3464 </span>
3465 </p>
3466
3467 <h5 id="number-quote-lines-gutter" class="docs" style="font-size: 87%">&bull;&nbsp;Changing the line number gutter for QUOTEs and BLOCKQUOTEs</h5>
3468
3469 <p>
3470 Owing to groff&#8217;s restriction on accepting only the figure
3471 space as the line number
3472 <a href="definitions.html#gutter">gutter</a>&#8217;s
3473 unit of measure, it is not possible for line numbers in quotes
3474 or blockquotes to hang outside a document&#8217;s overall left
3475 margin and be reliably flush with the line numbers of paragraph
3476 text.  Conseqently, line numbers in quotes or blockquotes hang
3477 to the left of the quote, separated by the currently active
3478 gutter for <kbd>NUMBER_LINES</kbd>.
3479 </p>
3480
3481 <p>
3482 If you&#8217;d like to change the line number gutter for
3483 quotes or blockquotes, invoke <kbd>NUMBER_QUOTE_LINES</kbd> or
3484 <kbd>NUMBER_BLOCKQUOTE_LINES</kbd> with a digit representing the
3485 number of
3486 <a href="definitions.html#figurespace">figure spaces</a>
3487 you&#8217;d like between the line numbers and the quoted text, like this:
3488 <br/>
3489 <span class="pre-in-pp">
3490   .NUMBER_QUOTE_LINES 3
3491 </span>
3492 With the above, line numbers in quotes (and only quotes) will have
3493 a gutter of 3 figure spaces.
3494 </p>
3495
3496 <h5 id="number-quote-lines-silent" class="docs" style="font-size: 87%">&bull;&nbsp;Silently increment line numbers during QUOTE and BLOCKQUOTE</h5>
3497
3498 <p>
3499 If you&#8217;ve asked mom not to line number quotes or blockquotes,
3500 but would like line numbering to continue while they&#8217;re
3501 being output (as opposed to mom&#8217;s default behaviour of
3502 <i>suspending</i> incrementing of line numbers during the output of
3503 quotes and blockquotes), invoke
3504 <span class="pre-in-pp">
3505   .NUMBER_QUOTE_LINES&nbsp;SILENT
3506 </span>
3507 or
3508 <span class="pre-in-pp">
3509   .NUMBER_BLOCKQUOTE_LINES&nbsp;SILENT
3510 </span>
3511 With these, mom continues to increment line numbers while quotes
3512 or blockquotes are being output, but the line numbers won&#8217;t
3513 appear in the output copy.
3514 </p>
3515
3516 <p>
3517 Once having turned <kbd>NUMBER_QUOTE_LINES</kbd> or
3518 <kbd>NUMBER_BLOCKQUOTE_LINES</kbd> on, you may disable them with
3519 <span class="pre-in-pp">
3520   .NUMBER_QUOTE_LINES OFF
3521 </span>
3522 or
3523 <span class="pre-in-pp">
3524   .NUMBER_BLOCKQUOTE_LINES OFF
3525 </span>
3526 </p>
3527
3528 <div class="rule-short"><hr/></div>
3529
3530 <!-- ==================================================================== -->
3531
3532 <h2 id="footnote-intro" class="macro-group">Footnotes</h2>
3533
3534 <ul>
3535   <li><a href="#footnote-behaviour">Footnote behaviour</a>
3536   <ul style="margin-left: -.5em;">
3537     <li><a href="#fn-and-punct">Footnote markers and punctuation in the running text</a></li>
3538   </ul></li>
3539   <li><a href="#footnote">Tag: FOOTNOTE</a></li>
3540   <li><a href="#footnote-control">Footnote control macros and defaults</a></li>
3541 </ul>
3542
3543 <p>
3544 For something so complex behind the scenes, footnotes are easy to use.
3545 You just type, for example,
3546 <br/>
3547 <span id="footnote-example" class="pre-in-pp">
3548   ...the doctrines of Identity as urged by Schelling\c
3549   .FOOTNOTE
3550   &lt;footnote about who the hell is Schelling&gt;
3551   .FOOTNOTE OFF
3552    were generally the points of discussion presenting the most
3553   of beauty to the imaginative Morella.
3554 </span>
3555 and be done with it.
3556 (Note the obligatory use of the <kbd>\c</kbd>
3557 <a href="definitions.html#inlines">inline escape</a>,
3558 required whenever your
3559 <a href="#footnote-marker-style">FOOTNOTE_MARKER_STYLE</a>
3560 is either <kbd>STAR</kbd> [star/dagger footnotes] or
3561 <kbd>NUMBER</kbd> [superscript numbers].)
3562 </p>
3563
3564 <p>
3565 After you invoke <kbd>.FOOTNOTE</kbd>, mom takes care of everything:
3566 putting footnote markers in the body of the document, keeping track
3567 of how many footnotes are on the page, identifying the footnotes
3568 themselves appropriately, balancing them properly with the bottom
3569 margin, deferring footnotes that don&#8217;t fit on the page...
3570 Even if you&#8217;re using
3571 <a href="docprocessing.html#columns">COLUMNS</a>,
3572 mom knows what to do, and Does The Right Thing.
3573 </p>
3574
3575 <div class="box-tip">
3576 <p class="tip">
3577 <span class="note">Note:</span>
3578 See
3579 <a href="refer.html">refer.html</a>
3580 for information on using footnotes with the <kbd>refer</kbd>
3581 bibliographic database.
3582 </p>
3583 </div>
3584
3585 <h3 id="footnote-behaviour" class="docs">Footnote behaviour</h3>
3586
3587 <p>
3588 Footnotes can be sly little beasts.  If you&#8217;re writing a
3589 document that&#8217;s footnote-heavy, you might want to read the
3590 following.
3591 </p>
3592
3593 <p>
3594 By default, mom marks footnotes with alternating stars (asterisks),
3595 daggers, and double-daggers.  The first footnote gets a star, the
3596 second a dagger, the third a double-dagger, the fourth two stars,
3597 the fifth two daggers, etc.  If you prefer numbered footnotes, rest
3598 assured mom is happy to oblige.
3599 </p>
3600
3601 <p>
3602 A small amount of vertical whitespace and a short horizontal rule
3603 separate footnotes from the document body.  The amount of whitespace
3604 varies slightly from page to page depending on the number of lines
3605 in the footnotes. Mom tries for a nice balance between too little
3606 whitespace and too much, but when push comes to shove, she&#8217;ll
3607 usually opt for ample over cramped.  The last lines of footnotes are
3608 always flush with the document&#8217;s bottom margin.
3609 </p>
3610
3611 <p>
3612 If mom sees that a portion of a footnote cannot be fit on its page,
3613 she carries that portion over to the next page.  If an entire
3614 footnote can&#8217;t be fit on its page (ie  FOOTNOTE has been
3615 called too close to the bottom), she defers the footnote to the next
3616 page, but sets it with the appropriate marker from the previous
3617 page.
3618 </p>
3619
3620 <p>
3621 When footnotes occur within cited text, for example a
3622 <a href="#quote">QUOTE</a>
3623 or a
3624 <a href="#blockquote">BLOCKQUOTE</a>,
3625 mom will usually opt for deferring the footnote over to the next
3626 page if it allows her to complete the cited text on one page.
3627 </p>
3628
3629 <p>
3630 In the unfortunate happenstance that a deferred footnote is the
3631 only footnote on its page (ie it&#8217;s marked in the document
3632 body with a star) and the page it&#8217;s deferred to has its own
3633 footnotes, mom separates the deferred footnote from the page&#8217;s
3634 proper footnote(s) with a blank line.  This avoids the confusion
3635 that might result from readers seeing two footnote entries on
3636 the same page identified by a single star (or the number 1 if
3637 you&#8217;ve requested numbered footnotes that begin at 1 on every
3638 page).  The blank line makes it clear that the first footnote entry
3639 belongs to the previous page.
3640 </p>
3641
3642 <p>
3643 In the circumstance where a deferred footnote is not the only one
3644 on its page, and is consequently marked by something other than
3645 a single star, there&#8217;s no confusion and mom doesn&#8217;t
3646 bother with the blank line.  (By convention, the first footnote on
3647 a page is always marked with a single star, so if readers see, say,
3648 a dagger or double-dagger marking the first footnote entry,
3649 they&#8217;ll know the entry belongs to the previous page).
3650 </p>
3651
3652 <p>
3653 Very exceptionally, two footnotes may have to be deferred (eg one
3654 occurs on the second to last line of a page, and another on the last
3655 line).  In such a circumstance, mom does not add
3656 a blank after the second deferred footnote.  If you&#8217;d like a blank
3657 line separating both deferred footnotes from any footnotes proper to
3658 the page the deferred ones were moved to, add the space manually by
3659 putting a
3660 <a href="typesetting.html#space"><kbd>.SPACE</kbd></a>
3661 command at the end of the footnote text, before
3662 <kbd>.FOOTNOTE&nbsp;OFF</kbd> (or <kbd>X, QUIT, EXIT</kbd>, etc).
3663 </p>
3664
3665 <p>
3666 Obviously, deferred footnotes aren&#8217;t an issue if you request
3667 numbered footnotes that increase incrementally throughout the whole
3668 document&mdash;yet another convenience mom has thought of.
3669 </p>
3670
3671 <p>
3672 While mom&#8217;s handling of footnotes is sophisticated,
3673 and tries to take nearly every imaginable situation under which they
3674 might occur into account, some situations are simply impossible from
3675 a typographic standpoint.  For example, if you have a
3676 <a href="#head">HEAD</a>
3677 near the bottom of a page and the page has some footnotes on it, mom
3678 may simply not have room to set any text under the head (normally,
3679 she insists on having room for at least one line of text beneath
3680 a head).  In such an instance, mom will either set the head, with
3681 nothing under it but footnotes, or transfer the head to the next
3682 page.  Either way, you&#8217;ll have a gaping hole at the bottom
3683 of the page.  It&#8217;s a sort of typographic Catch-22, and can
3684 only be resolved by you, the writer or formatter of the document,
3685 adjusting the type on the offending page so as to circumvent the
3686 problem.
3687 </p>
3688
3689 <h3 id="fn-and-punct" class="docs">Footnote markers and punctuation in the running text</h3>
3690
3691 <ol style="margin-left: -1.25em;">
3692   <li><a href="#fn-and-punct-fill">&#8220;Fill&#8221; modes &ndash; JUSTIFY, or QUAD LEFT | CENTER | RIGHT</a></li>
3693   <li><a href="#fn-and-punct-nofill">&#8220;No-fill&#8221; modes &ndash; LEFT, CENTER, RIGHT</a></li>
3694 </ol>
3695
3696 <h4 id="fn-and-punct-fill" class="docs">1. &#8220;Fill&#8221; modes &ndash; JUSTIFY, or QUAD LEFT | CENTER | RIGHT</h4>
3697
3698 <p>
3699 In
3700 <a href="definitions.html#filled">fill</a>
3701 modes, the correct way to enter the line after
3702 <kbd>.FOOTNOTE&nbsp;OFF</kbd> is to input it as if it&#8217;s
3703 literally a continuation of the input line you were entering before
3704 you invoked <kbd>.FOOTNOTE</kbd>.  Therefore, if necessary, the
3705 input line may have to begin with space(s) or a punctuation mark, as
3706 in the two following examples.
3707 </p>
3708
3709 <div id="examples-footnotes-1" class="examples-container" style="padding-bottom: 1em;">
3710 <div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 1</div>
3711 <span class="pre">
3712 A line of text,\c
3713 .FOOTNOTE
3714 A footnote line.
3715 .FOOTNOTE OFF
3716  broken up with a comma.
3717 ^
3718 (last line begins with a literal space)
3719 </span>
3720 </div>
3721
3722 <div id="examples-footnotes-2" class="examples-container" style="margin-top: 1em; padding-bottom: 1em;">
3723 <div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 2</div>
3724 <span class="pre">
3725 A line of text\c
3726 .FOOTNOTE
3727 A footnote line.
3728 .FOOTNOTE OFF
3729 , broken up with a comma.
3730 ^
3731 (last line begins with a comma and a space)
3732 </span>
3733 </div>
3734
3735 <p>
3736 Example 1 produces, on output
3737 <br/>
3738 <span class="pre-in-pp">
3739   A line of text,* broken up with a comma.
3740 </span>
3741 Example 2 produces
3742 <br/>
3743 <span class="pre-in-pp">
3744   A line of text*, broken up with a comma.
3745 </span>
3746 Care must be taken, though, if the punctuation mark that begins the
3747 line after <kbd>.FOOTNOTE&nbsp;OFF</kbd> is a period (dot).  You
3748 <b><i>must</i></b> begin such lines with <kbd>\&amp;.</kbd>, like
3749 this:
3750 <br/>
3751 <span class="pre-in-pp">
3752   ...end of sentence\c
3753   .FOOTNOTE
3754   A footnote line.
3755   .FOOTNOTE OFF
3756   \&amp;.  A new sentence...
3757 </span>
3758 If you omit the <kbd>\&amp;.</kbd>, the line will vanish!
3759 </p>
3760
3761 <div class="box-tip">
3762 <p class="tip">
3763 <span class="note">Note:</span>
3764 The document element tags,
3765 <a href="#epigraph">EPIGRAPH</a>
3766 and
3767 <a href="#blockquote">BLOCKQUOTE</a>,
3768 imply a fill mode, therefore these instructions also apply when you
3769 insert a footnote into epigraphs or blockquotes.
3770 </p>
3771 </div>
3772
3773 <h4 id="fn-and-punct-nofill" class="docs">2. &#8220;No-fill&#8221; modes &ndash; LEFT, CENTER, RIGHT</h4>
3774
3775 <p>
3776 In
3777 <a href="definitions.html#filled">no-fill</a>
3778 modes, you must decide a) whether text on the <i>input</i> line
3779 after <kbd>.FOOTNOTE&nbsp;OFF</kbd> is to be joined to the
3780 <i>output</i> line before <kbd>.FOOTNOTE</kbd> was invoked, or b)
3781 whether you want the <i>output</i> text to begin on a new line.
3782 </p>
3783
3784 <p>
3785 In the first instance, simply follow the instructions,
3786 <a href="#fn-and-punct-fill">above</a>,
3787 for fill modes.
3788 </p>
3789
3790 <p>
3791 In the second instance, you must explicitly tell mom that
3792 you want input text after <kbd>.FOOTNOTE&nbsp;OFF</kbd> to
3793 begin on a new output line.  This is accomplished by passing
3794 <kbd>.FOOTNOTE&nbsp;OFF</kbd> (or <kbd>QUIT, END, X,</kbd> etc) an
3795 additional argument: <kbd>BREAK</kbd> or <kbd>BR</kbd>.
3796 </p>
3797
3798 <p>
3799 Study the two examples below to understand the difference.
3800 </p>
3801
3802 <div id="examples-footnotes-3" class="examples-container" style="padding-bottom: 1em;">
3803 <div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 1</div>
3804 <span class="pre">
3805 .LEFT
3806 A line of text\c
3807 .FOOTNOTE
3808 A footnote line
3809 .FOOTNOTE OFF
3810 that carries on after the footnote.
3811 </span>
3812 </div>
3813
3814 <div id="examples-footnotes-4" class="examples-container" style="margin-top: 1em; padding-bottom: 1em;">
3815 <div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example 2</div>
3816 <span class="pre">
3817 .LEFT
3818 A line of text\c
3819 .FOOTNOTE
3820 A footnote line
3821 .FOOTNOTE OFF BREAK
3822 that doesn&#8217;t carry on after the footnote.
3823 </span>
3824 </div>
3825
3826 <p>
3827 Example 1, on output, produces
3828 <br/>
3829 <span class="pre-in-pp">
3830   A line of text* that carries on after the footnote.
3831 </span>
3832 whereas Example 2 produces
3833 <span class="pre-in-pp">
3834   A line of text*
3835   that doesn&#8217;t carry on after the footnote.
3836 </span>
3837 The distinction becomes particularly important if you like to see
3838 punctuation marks come <i>after</i> footnote markers.  In no-fill
3839 modes, that&#8217;s accomplished like this:
3840 <br/>
3841 <span class="pre-in-pp">
3842   .LEFT
3843   A line of text\c
3844   .FOOTNOTE
3845   A footnote line
3846   .FOOTNOTE OFF
3847   ,
3848   broken up with a comma.
3849 </span>
3850 The output of the above looks like this:
3851 <br/>
3852 <span class="pre-in-pp">
3853   A line of text*,
3854   broken up with a comma.
3855 </span>
3856 </p>
3857
3858 <div class="box-tip">
3859 <p class="tip">
3860 <span class="note">Note:</span>
3861 The document element tag,
3862 <a href="#quote">QUOTE</a>,
3863 implies a no-fill mode, therefore these instructions also apply when
3864 you insert footnotes into quotes.
3865 </p>
3866 </div>
3867
3868 <!-- -FOOTNOTE- -->
3869
3870 <div class="macro-id-overline">
3871 <h3 id="footnote" class="macro-id">FOOTNOTE</h3>
3872 </div>
3873
3874 <div class="box-macro-args">
3875 Tag: FOOTNOTE <kbd class="macro-args">&lt;toggle&gt; [ BREAK | BR ] | INDENT LEFT | RIGHT | BOTH &lt;indent value&gt;</kbd>
3876 </div>
3877
3878 <p class="requires">
3879 &bull;&nbsp;<kbd><span style="font-style: normal">&lt;indent value&gt;</span></kbd> requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
3880 <br/>
3881 See <span style="font-style: normal"><a href="#footnote-note">HYPER-IMPORTANT NOTE</a></span>.
3882 </p>
3883
3884 <p>
3885 FOOTNOTE is a toggle macro, therefore invoking it on a line by
3886 itself allows you to enter a footnote in the body of a document.
3887 Invoking it with any argument other than INDENT (ie <kbd>OFF,
3888 QUIT, END, X...</kbd>) tells mom you&#8217;re finished.
3889 </p>
3890
3891 <p>
3892 Footnotes are the only element of
3893 <a href="definitions.html#running">running text</a>
3894 that are not affected by the typesetting
3895 <a href="typesetting.html#indents">indent macros</a>.
3896 In the unlikely event that you want a page&#8217;s footnotes to
3897 line up with a running indent, invoke <kbd>.FOOTNOTE</kbd> with
3898 the <kbd>INDENT</kbd> argument and pass it an indent direction and
3899 indent value. <kbd>L, R,</kbd> and <kbd>B</kbd> may be used in place
3900 of <kbd>LEFT, RIGHT,</kbd> and <kbd>BOTH</kbd>. FOOTNOTE must be
3901 invoked with <kbd>INDENT</kbd> for every footnote you want indented;
3902 mom does not save any footnote indent information from invocation to
3903 invocation.
3904 </p>
3905
3906 <div class="box-tip">
3907 <p class="tip">
3908 <span class="note">Note:</span>
3909 If a footnote runs to more than one paragraph, do <i>not</i> begin
3910 the footnote with the
3911 <a href="#pp">PP</a>
3912 tag.  Use <kbd>.PP</kbd> only to introduce subsequent paragraphs.
3913 </p>
3914 </div>
3915
3916 <div id="footnote-note" class="box-tip">
3917 <p class="tip-top">
3918 <span class="note">HYPER-IMPORTANT NOTE:</span>
3919 The final word on the
3920 <a href="definitions.html#inputline">input line</a>
3921 that comes immediately before FOOTNOTE <i>must</i> terminate with a
3922 <kbd><a href="typesetting.html#join">\c</a></kbd>
3923 inline escape if your
3924 <a href="#footnote-marker-style">FOOTNOTE_MARKER_STYLE</a>
3925 is either <kbd>STAR</kbd> or <kbd>NUMBER</kbd>.  See the
3926 <a href="#footnote-example">footnote example</a>
3927 above.
3928 </p>
3929
3930 <p>
3931 Additionally, in
3932 <a href="definitions.html#filled">fill</a>
3933 modes
3934 (<a href="typesetting.html#justify">JUSTIFY</a>
3935 or
3936 <a href="typesetting.html#quad">QUAD</a>),
3937 the line <i>after</i> a <kbd>.FOOTNOTE&nbsp;OFF</kbd> should be
3938 entered as if there were no interruption in the input text, ie
3939 the line should begin with a literal space or punctuation mark (see
3940 explanation and examples
3941 <a href="#fn-and-punct">here</a>).
3942 </p>
3943
3944 <p>
3945 In
3946 <a href="definitions.html#filled">no-fill</a>
3947 modes, the optional argument <kbd>BREAK</kbd> or <kbd>BR</kbd> may
3948 be used after the <kbd>OFF</kbd> (or <kbd>QUIT, END, X,</kbd> etc.)
3949 argument to instruct mom not to join the next input line to the
3950 previous output.  See
3951 <a href="#fn-and-punct-nofill">here</a>
3952 for a more complete explanation, with examples.
3953 </p>
3954
3955 <p class="tip-bottom">
3956 Do not use the <kbd>\c</kbd> inline escape if your
3957 FOOTNOTE_MARKER_STYLE is <kbd>LINE</kbd>, or if you have disabled
3958 footnote markers with
3959 <kbd><a href="#footnote-markers">.FOOTNOTE_MARKERS OFF</a></kbd>.
3960 In these instances, the line after <kbd>.FOOTNOTE&nbsp;OFF</kbd>
3961 should be entered normally.
3962 </p>
3963 </div>
3964
3965 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
3966 <h3 id="footnote-control" class="docs defaults">FOOTNOTE control macros macros and defaults</h3>
3967
3968 <ol style="margin-top: .5em; padding-bottom: .5em;">
3969   <li><a href="#footnote-general">Family/font/size/colour/lead/quad</a></li>
3970   <li><a href="#footnote-markers">Footnote markers</a> &ndash; on or off</li>
3971   <li><a href="#footnote-marker-style">Footnote marker style</a> &ndash; star+dagger or numbered
3972   <ul style="margin-left: -.5em; list-style-type: disc;">
3973     <li><a href="#footnote-number-placeholders">Left padding of footnote numbers</a></li>
3974   </ul></li>
3975   <li><a href="#footnotes-by-linenumber">Footnotes by line number</a>
3976   <ul style="margin-left: -.5em; list-style-type: disc;">
3977     <li><a href="#footnote-linenumber-brackets">FOOTNOTE_LINENUMBER_BRACKETS</a></li>
3978     <li><a href="#footnote-linenumber-separator">FOOTNOTE_LINENUMBER_SEPARATOR</a></li>
3979     <li><a href="#footnotes-run-on">FOOTNOTES_RUN_ON</a> &ndash; line-numbered footnotes only</li>
3980   </ul></li>
3981   <li><a href="#reset-footnote-number">Reset footnote number</a> &ndash; set footnote marker number to 1</li>
3982   <li><a href="#footnote-space">Inter-footnote spacing</a></li>
3983   <li><a href="#footnote-rule">Footnote rule</a> &ndash; on or off</li>
3984   <li><a href="#footnote-rule-length">Footnote rule length</a> &ndash; length of footnote separator rule</li>
3985   <li><a href="#footnote-rule-weight">Footnote rule weight</a> &ndash; weight of footnote separator rule</li>
3986   <li><a href="#footnote-rule-adj">Adjust vertical position of footnote separator rule</a></li>
3987 </ol>
3988 </div>
3989
3990 <h4 id="footnote-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. Family/font/size/colour/lead/quad</h4>
3991
3992 <div class="defaults-container" style="padding-bottom: 8px;">
3993 <p class="defaults" style="padding-top: 6px;">
3994 See
3995 <a href="#control-macro-args">Arguments to the control macros</a>.
3996 </p>
3997 <span class="pre defaults">
3998 .FOOTNOTE_FAMILY    default = prevailing document family; default is Times Roman
3999 .FOOTNOTE_FONT      default = roman
4000 .FOOTNOTE_SIZE      default = -2 (points)
4001 .FOOTNOTE_COLOR     default = black
4002 .FOOTNOTE_AUTOLEAD  default = 2 points (typeset); single-spaced (typewrite)
4003 .FOOTNOTE_QUAD      default = same as paragraphs
4004 </span>
4005 </div>
4006
4007 <h4 id="footnote-markers" class="docs" style="margin-top: -1.25em;">2. Footnote markers &ndash; FOOTNOTE_MARKERS</h4>
4008
4009 <p>
4010 If you don&#8217;t want footnote markers, in either the body of
4011 the document or beside footnote entries themselves, toggle them
4012 off with <kbd>.FOOTNOTE_MARKERS&nbsp;OFF</kbd> (or <kbd>END, QUIT,
4013 X</kbd>...).  This means, of course, that you&#8217;ll
4014 have to roll your own.  If you want them back on, invoke
4015 <kbd>.FOOTNOTE_MARKERS</kbd> with no argument.  Footnote markers are
4016 on by default.
4017 </p>
4018
4019 <p>
4020 If FOOTNOTE_MARKERS are disabled, do not use the <kbd>\c</kbd>
4021 inline escape to terminate the line before <kbd>.FOOTNOTE</kbd>.
4022 </p>
4023
4024 <h4 id="footnote-marker-style" class="docs" style="margin-top: -.25em;">3. Footnote marker style &ndash; FOOTNOTE_MARKER_STYLE</h4>
4025
4026 <p>
4027 Mom gives you two choices of footnote marker style: star+dagger (see
4028 <a href="#footnote-behaviour">footnote behaviour</a>
4029 above), or numbered.
4030 </p>
4031
4032 <p>
4033 <kbd>.FOOTNOTE_MARKER_STYLE STAR</kbd> gives you star+dagger (the
4034 default).  There is a limit of 10 footnotes per page with this
4035 style.
4036 </p>
4037
4038 <p>
4039 <kbd>.FOOTNOTE_MARKER_STYLE NUMBER</kbd> gives you superscript
4040 numbers, both in the document body and in the footnote entries
4041 themselves.  By default, footnote numbers increase incrementally
4042 (prev. footnote number + 1) throughout the whole document.  You
4043 can ask mom to start each page&#8217;s footnote numbers at 1 with
4044 <kbd>.RESET_FOOTNOTE_NUMBER</kbd>
4045 (<a href="#reset-footnote-number">see below</a>.)
4046 </p>
4047
4048 <p>
4049 If your
4050 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>
4051 is <kbd>TYPEWRITE</kbd> and you would prefer that the footnotes
4052 themselves not use superscript numbers, you may pass
4053 <kbd>.FOOTNOTE_MARKER_STYLE NUMBER</kbd> an additional argument:
4054 <kbd>NO_SUPERSCRIPT</kbd>.  While the marker in the text will still
4055 be superscript, the footnotes themselves will be identified with
4056 normal-sized, base aligned numbers, surrounded by parentheses.
4057 </p>
4058
4059 <h5 id="footnote-number-placeholders" class="docs">Left padding of footnote numbers</h5>
4060
4061 <p>
4062 When footnote numbering is enabled, in order to ensure that the
4063 left margin of footnote text aligns regardless of the footnote
4064 number, you sometimes have to pad the footnote numbers.  This will
4065 be the case any time the footnote numbers change from 9 to 10 on
4066 the same page, or from 99 to 100.  Consider this scenario:
4067 <br/>
4068 <span class="pre-in-pp">
4069   <sup>9</sup>&nbsp;Footnote text
4070   <sup>10</sup>&nbsp;Footnote text
4071   <sup>11</sup>&nbsp;Footnote text
4072 </span>
4073 As you can see, the left margins of the footnotes are not aligned.
4074 </p>
4075
4076 <p>
4077 In order to correct this, use the macro
4078 <kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS</kbd>, which takes a single
4079 argument: the number of placeholders in the longer digit.  For
4080 example, placed at an appropriate point in your input file,
4081 <kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS&nbsp;2</kbd> causes the above
4082 example to come out like this:
4083 <br/>
4084 <span class="pre-in-pp">
4085   <sup> 9</sup> Footnote text
4086   <sup>10</sup> Footnote text
4087   <sup>11</sup> Footnote text
4088 </span>
4089 Given the impossibility of knowing in advance when the number of
4090 placeholders required for footnote numbers will change, you must
4091 study your <i>output</i> file to determine where to insert this
4092 macro into your <i>input</i> file.
4093 </p>
4094
4095 <p>
4096 Obviously, mom does not provide a default for
4097 <kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS</kbd>.
4098 </p>
4099
4100 <div class="box-tip">
4101 <p class="tip">
4102 <span class="note">Note:</span>
4103 <kbd>.FOOTNOTE_NUMBER_PLACEHOLDERS</kbd> affects both superscript
4104 footnote numbers, and, in
4105 <a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>,
4106 the normal, base-aligned numbers surrounded by parentheses that you
4107 get with
4108 <kbd>.FOOTNOTE_MARKER_STYLE&nbsp;NUMBER&nbsp;NO_SUPERSCRIPT</kbd>.
4109 </p>
4110 </div>
4111
4112 <h4 id="footnotes-by-linenumber" class="docs" style="margin-top: -.25em;">4. Footnotes by line number &ndash; FOOTNOTE_MARKER_STYLE LINE</h4>
4113
4114 <p>
4115 FOOTNOTE_MARKER_STYLE with the argument, <kbd>LINE</kbd> lets you
4116 have footnotes which are identified by line number, rather than by a
4117 marker in the text.  (Note that
4118 <a href="#number-lines">NUMBER_LINES</a>
4119 must be enabled in order to use this marker style.)
4120 </p>
4121
4122 <p>
4123 With FOOTNOTE_MARKER_STYLE <kbd>LINE</kbd>, mom will identify
4124 footnotes either by single line numbers, or line ranges.  If
4125 what you want is a single line number, you need only invoke
4126 <kbd>.FOOTNOTE</kbd>, <i>without the terminating</i> <kbd>\c</kbd>,
4127 at the appropriate place in running text.  Input lines after the
4128 footnote has been terminated (eg with <kbd>.FOOTNOTE OFF</kbd>)
4129 must begin at the left margin.
4130 </p>
4131
4132 <p>
4133 If you want a range of line numbers (eg&nbsp;[5-11]&nbsp;),
4134 insert, directly into the first line of the range you want,
4135 the <a href="definitions.html#inlines">inline escape</a>,
4136 <kbd>\*[FN_MARK]</kbd>.  For the terminating line number of the
4137 range, you need only invoke <kbd>.FOOTNOTE</kbd> (again, without the
4138 terminating <kbd>\c</kbd>); mom is smart enough to figure out that
4139 where <kbd>.FOOTNOTE</kbd> was invoked represents the terminating
4140 line number.  Range-numbered footnotes are always output on the
4141 page where <kbd>.FOOTNOTE</kbd> was invoked, not the page where
4142 <kbd>\*[FN_MARK]</kbd> appears (subject, of course, to the rules for
4143 footnotes that fall too close to the bottom of a page, as outlined
4144 <a href="#footnote-rules">here</a>).
4145 </p>
4146
4147 <p>
4148 The behaviour of line-numbered footnotes can be controlled with the
4149 macros:
4150 <br/>
4151 <span style="display: inline-block; margin-left: 2em; margin-top: .5em;"><a href="#footnote-linenumber-brackets">FOOTNOTE_LINENUMBER_BRACKETS</a></span>
4152 <br/>
4153 <span style="margin-left: 2em;"><a href="#footnote-linenumber-separator">FOOTNOTE_LINENUMBER_SEPARATOR</a></span>
4154 <br/>
4155 <span style="margin-left: 2em;"><a href="#footnotes-run-on">FOOTNOTES_RUN_ON</a></span>
4156 </p>
4157
4158 <div style="margin-left: 1.25em;">
4159 <h5 id="footnote-linenumber-brackets" class="docs" style="margin-top: -.25em;">&bull;&nbsp;FOOTNOTE_LINENUMBER_BRACKETS</h5>
4160
4161 <p style="margin-left: .5em;">
4162 Mom, by default, surrounds footnote line numbers with square
4163 brackets.  The style of the brackets may be changed with the macro,
4164 <br/>
4165 <span class="pre-in-pp">
4166   .FOOTNOTE_LINENUMBER_BRACKETS
4167 </span>
4168 which takes one of three possible arguments: <kbd>PARENS</kbd>
4169 (round brackets), <kbd>SQUARE</kbd> (the default) or
4170 <kbd>BRACES</kbd> (curly braces).  If you prefer a shortform, the
4171 arguments, <kbd>(</kbd>, <kbd>[</kbd> or <kbd>{</kbd> may be used
4172 instead.
4173 </p>
4174
4175 <p style="margin-left: .5em;">Thus, for example, either
4176 <br/>
4177 <span class="pre-in-pp">
4178   .FOOTNOTE_LINENUMBER_BRACKETS PARENS
4179 </span>
4180 or
4181 <br/>
4182 <span class="pre-in-pp">
4183   .FOOTNOTE_LINENUMBER_BRACKETS (
4184 </span>
4185 will surround footnote line numbers with round brackets.
4186 </p>
4187
4188 <h5 id="footnote-linenumber-separator" class="docs" style="margin-top: -.25em;">&bull;&nbsp;FOOTNOTE_LINENUMBER_SEPARATOR</h5>
4189
4190 <p style="margin-left: .5em;">
4191 If you don&#8217;t want the numbers enclosed in brackets, you
4192 may tell mom to use a &#8220;separator&#8221; instead.  A common
4193 separator would be the colon, but it can be anything you like.
4194 The macro to do this is
4195 <br/>
4196 <span class="pre-in-pp">
4197   .FOOTNOTE_LINENUMBER_SEPARATOR
4198 </span>
4199 which takes, as its single argument, the separator you want.  For
4200 safety and consistency&#8217;s sake, always enclose the argument in
4201 double-quotes.  The separator can be composed of any valid groff
4202 character, or any combination of characters.
4203 </p>
4204
4205 <p style="margin-left: .5em;">
4206 <b>A word of caution:</b> when using a separator, mom doesn&#8217;t
4207 insert any space after the separator.  Hence, if you want space
4208 (you probably do), you must make the space part of the argument you
4209 pass to FOOTNOTE_LINENUMBER_SEPARATOR.  For example, to get a colon
4210 separator with a space after it, you&#8217;d do
4211 <br/>
4212 <span class="pre-in-pp">
4213   .FOOTNOTE_LINENUMBER_SEPARATOR ": "
4214 </span>
4215 </p>
4216
4217 <h5 id="footnotes-run-on" class="docs" style="margin-top: -1em;">&bull;&nbsp;FOOTNOTES_RUN_ON</h5>
4218
4219 <p style="margin-left: .5em;">
4220 Finally, if your footnote marker style is <kbd>LINE</kbd>, you may
4221 instruct mom to do &#8220;run-on style&#8221; footnotes.  Run-on
4222 footnotes do not treat footnotes as discrete entities, ie each
4223 beginning on a new line.  Rather, each footnote is separated from
4224 the footnote before it by horizontal space in the running line, so
4225 that the footnotes on any given page form a continuous block, like
4226 lines in a paragraph.
4227 </p>
4228
4229 <p style="margin-left: .5em;">
4230 The macro to get mom to run footnotes on is
4231 <br/>
4232 <span class="pre-in-pp">
4233   .FOOTNOTES_RUN_ON
4234 </span>
4235 Invoked by itself, it turns the feature on.  Invoked with any other
4236 argument (<kbd>OFF, NO</kbd>, etc.), it turns the feature off.
4237 It is generally not a good idea to turn the feature on and off
4238 during the course of a single document.  If you do, mom will issue
4239 a warning if there&#8217;s going to be a problem.  However, it is
4240 always perfectly safe to enable/disable the feature after
4241 <a href="rectoverso.html#collate">COLLATE</a>.
4242 </p>
4243 </div>
4244
4245 <h4 id="reset-footnote-number" class="docs" style="margin-top: -.25em;">5. Reset footnote number &ndash; RESET_FOOTNOTE_NUMBER</h4>
4246
4247 <p>
4248 <kbd>.RESET_FOOTNOTE_NUMBER</kbd>, by itself, resets footnote
4249 numbering so that the next footnote you enter is numbered 1.
4250 </p>
4251
4252 <p>
4253 <kbd>.RESET_FOOTNOTE_NUMBER&nbsp;PAGE</kbd> tells mom to start every
4254 page&#8217;s footnote numbering at 1.
4255 </p>
4256
4257 <h4 id="footnote-space" class="docs" style="margin-top: -.25em;">6. Inter-footnote spacing &ndash; FOOTNOTE_SPACING</h4>
4258
4259 <p>
4260 If you&#8217;d like some space between footnotes, you can
4261 have mom put it in for you by invoking <kbd>.FOOTNOTE_SPACING</kbd>
4262 with an argument representing the amount of extra space you&#8217;d
4263 like.  The argument to FOOTNOTE_SPACING requires a
4264 <a href="definitions.html#unitofmeasure">unit of measure</a>.
4265 </p>
4266
4267 <p>
4268 In the following example, footnotes will be separated from each
4269 other by 3
4270 <a href="definitions.html#picaspoints">points</a>.
4271 <br/>
4272 <span class="pre-in-pp">
4273   .FOOTNOTE_SPACING 3p
4274 </span>
4275 </p>
4276
4277 <div class="box-tip">
4278 <p class="tip">
4279 <span class="note">Note:</span>
4280 If you&#8217;re using footnotes for references generated from the
4281 refer database (see
4282 <a href="refer.html">refer.html</a>),
4283 correct MLA style requires a full linespace between footnotes, which
4284 you can accomplish with <kbd>.FOOTNOTE_SPACING&nbsp;1v</kbd>.
4285 </p>
4286 </div>
4287
4288 <h4 id="footnote-rule" class="docs" style="margin-top: -.25em;">7. Footnote rule &ndash; FOOTNOTE_RULE</h4>
4289
4290 <p>
4291 If you don&#8217;t want a footnote separator rule, toggle it off with
4292 <kbd>.FOOTNOTE_RULE&nbsp;OFF</kbd> (or <kbd>END, QUIT, X</kbd>...).
4293 Toggle it back on by invoking <kbd>.FOOTNOTE_RULE</kbd> with no
4294 argument.  The default is to print the rule.
4295 </p>
4296
4297 <h4 id="footnote-rule-length" class="docs" style="margin-top: -.25em;">8. Footnote rule length &ndash; FOOTNOTE_RULE_LENGTH</h4>
4298
4299 <p>
4300 If you want to change the length of the footnote separator rule,
4301 invoke <kbd>.FOOTNOTE_RULE_LENGTH</kbd> with a length, like this,
4302 <br/>
4303 <span class="pre-in-pp">
4304     .FOOTNOTE_RULE_LENGTH 1i
4305 </span>
4306
4307 which sets the length to 1 inch.  Note that a
4308 <a href="definitions.html#unitofmeasure">unit of measure</a>
4309 is required.  The default is 4
4310 <a href="definitions.html#picaspoints">picas</a>
4311 for both
4312 <a href="docprocessing.html#printstyle">PRINTSTYLES</a>.
4313 </p>
4314
4315 <h4 id="footnote-rule-weight" class="docs" style="margin-top: -.25em;">9. Footnote rule weight &ndash; FOOTNOTE_RULE_WEIGHT</h4>
4316
4317 <p>
4318 If you want to change the weight (&#8220;thickness&#8221;) of the
4319 footnote separator rule, invoke <kbd>.FOOTNOTE_RULE_WEIGHT</kbd>
4320 with the desired weight.  The weight is measured in
4321 <a href="definitions.html#picaspoints">points</a>;
4322 however, do not append the
4323 <a href="definitions.html#unitofmeasure">unit of measure</a>,
4324 <kbd>p</kbd>, to the argument.
4325 </p>
4326
4327 <p>
4328 Mom&#8217;s default footnote rule weight is 1/2 point.  If
4329 you&#8217;d like a 1-point rule instead,<br/>
4330 <span class="pre-in-pp">
4331   .FOOTNOTE_RULE_WEIGHT 1
4332 </span>
4333 is how you&#8217;d get it.
4334 </p>
4335
4336 <h4 id="footnote-rule-adj" class="docs" style="margin-top: -.25em;">10. Adjust vertical position of footnote separator rule &ndash; FOOTNOTE_RULE_ADJ</h4>
4337
4338 <p>
4339 The footnote separator rule is a rule whose bottom edge falls
4340 on the
4341 <a href="definitions.html#baseline">baseline</a>
4342 (at the footnote
4343 <a href="definitions.html#leading">leading</a>)
4344 one line above the first line of a page&#8217;s footnotes.  By default,
4345 mom raises the rule 3
4346 <a href="definitions.html#picaspoints">points</a>
4347 from the baseline so that the separator and the footnotes don&#8217;t
4348 look jammed together.  If you&#8217;d prefer a different vertical
4349 adjustment, invoke <kbd>.FOOTNOTE_RULE_ADJ</kbd> with the
4350 amount you&#8217;d like.  For example
4351 <br/>
4352 <span class="pre-in-pp">
4353   .FOOTNOTE_RULE_ADJ 4.25p
4354 </span>
4355 raises the rule by 4-1/4 points.  Note that you can only raise
4356 the rule, not lower it.  A
4357 <a href="definitions.html#unitofmeasure">unit of measure</a>
4358 is required.
4359 </p>
4360
4361 <div class="box-tip">
4362 <p class="tip">
4363 <span class="note">Note:</span>
4364 If your document
4365 <a href="definitions.html#leading">leading</a>
4366 is 2
4367 <a href="definitions.html#picaspoints">points</a>
4368 or less (e.g your
4369 <a href="definitions.html#ps">point size</a>
4370 is 10 and your linespacing is 10, 11, or 12), lowering mom&#8217;s
4371 default footnote rule adjustment will almost certainly give you
4372 nicer looking results than leaving the adjustment at the default.
4373 Furthermore, you can invoke <kbd>.FOOTNOTE_RULE_ADJ</kbd> on any
4374 page in which footnotes appear, or in any column, so that the
4375 placement of the footnote rule can be changed on-the-fly, should you
4376 wish.
4377 </p>
4378 </div>
4379
4380 <div class="rule-short"><hr/></div>
4381
4382 <!-- ==================================================================== -->
4383
4384 <h2 id="endnote-intro" class="macro-group">Endnotes</h2>
4385
4386 <ul style="margin-left: -.5em;">
4387   <li><a href="#endnote-behaviour">Endnotes behaviour</a>
4388   <ul style="margin-left: -.5em;">
4389     <li><a href="#endnote-columns">Endnotes and columnar documents</a></li>
4390   </ul></li>
4391   <li><a href="#endnote">Tag: ENDNOTE</a></li>
4392   <li><a href="#endnotes">Macro: <b>ENDNOTES</b></a>&mdash;tell mom to output endnotes</li>
4393   <li><a href="#endnote-control">ENDNOTES control macros and defaults</a></li>
4394 </ul>
4395
4396 <p>
4397 Embedding endnotes into mom documents is accomplished the same way
4398 as embedding
4399 <a href="#footnote-intro">footnotes</a>.
4400 The example below is identical to the one shown in the
4401 <a href="#footnote-example">introduction to footnotes</a>,
4402 except that <kbd>.FOOTNOTE</kbd> has been replaced with
4403 <kbd>.ENDNOTE</kbd>.
4404 </p>
4405
4406 <div id="examples" class="examples-container" style="padding-bottom: 1em;">
4407 <div class="examples" style="margin-top: 0; margin-bottom: -.25em;">Example</div>
4408 <span id="endnote-example" class="pre">
4409   ...the doctrines of Identity as urged by Schelling\c
4410   .ENDNOTE
4411   &lt;endnote about who the hell is Schelling&gt;
4412   .ENDNOTE OFF
4413    were generally the points of discussion presenting the most
4414   of beauty to the imaginative Morella.
4415 </span>
4416 </div>
4417
4418 <p>
4419 As with footnotes, note the obligatory use of the <kbd>\c</kbd>
4420 <a href="definitions.html#inlines">inline escape</a>
4421 when your
4422 <a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
4423 is <kbd>NUMBER</kbd> or <kbd>SUPERSCRIPT</kbd> (both of which mark
4424 endnotes references in
4425 <a href="definitions.html#running">running text</a>
4426 with superscript numbers).  When the marker style is
4427 <kbd>LINE</kbd>, you must <i>not</i> use the <kbd>\c</kbd>
4428 escape.
4429 </p>
4430
4431 <p>
4432 Endnotes differ from footnotes in two ways (other than the fact that
4433 endnotes come at the end of a document whereas footnotes appear in
4434 the body of the document):
4435 </p>
4436
4437 <ol style="margin-top: -.5em;">
4438   <li>When your ENDNOTE_MARKER_STYLE is <kbd>NUMBER</kbd> or
4439       <kbd>SUPERSCRIPT</kbd>, endnotes are always numbered
4440       incrementally, starting at &#8220;1&#8221;.
4441   </li>
4442   <li>Endnotes must be output explicitly; mom does not output
4443       them for you.  In
4444       <a href="rectoverso.html#collate">collated</a>
4445       documents, this allows you to choose whether you want the
4446       endnotes to appear at the end of each chapter or article in a
4447       document, or grouped together at the very end of the document.
4448   </li>
4449 </ol>
4450
4451 <p>
4452 Within endnotes, you may use the document element tags
4453 <a href="#pp">PP</a>,
4454 <a href="#quote">QUOTE</a>
4455 and
4456 <a href="#blockquote">BLOCKQUOTE</a>.
4457 This provides the flexibility to create endnotes that run to several
4458 paragraphs, as well as to embed cited text within endnotes.
4459 </p>
4460
4461 <p>
4462 Should you wish to change the appearance of quotes or blockquotes
4463 that appear within endnotes, you may do so with the
4464 <a href="#quote-control">quote control macros</a>
4465 or
4466 <a href="#blockquote-control">blockquote control macros</a>.
4467 However, you must make the changes <i>within</i> each endnote,
4468 prior to invoking <kbd>.QUOTE</kbd> or <kbd>.BLOCKQUOTE</kbd>,
4469 and undo them prior to terminating the endnote (ie before
4470 <kbd>.ENDNOTE&nbsp;OFF</kbd>), otherwise the changes will affect
4471 subsequent quotes and blockquotes that appear in the document body
4472 as well.
4473 </p>
4474
4475 <div class="box-tip">
4476 <p class="tip">
4477 <span class="note">Note:</span>
4478 See
4479 <a href="refer.html">refer.html</a>
4480 for information on using endnotes with the <kbd>refer</kbd>
4481 bibliographic database.
4482 </p>
4483 </div>
4484
4485 <h3 id="endnote-behaviour" class="docs">Endnotes behaviour</h3>
4486
4487 <p>
4488 When you output endnotes (with
4489 <kbd><a href="#endnotes">.ENDNOTES</a></kbd>),
4490 mom finishes processing the last page of your document, then breaks
4491 to a new page for printing the endnotes.  If the document type is
4492 <kbd><a href="docprocessing.html#doctype">CHAPTER</a></kbd>,
4493 the centre part of the
4494 <a href="definitions.html#header">header</a>
4495 (or footer), which, by default, contains a chapter number or title,
4496 is removed.
4497 </p>
4498
4499 <p>
4500 By default, mom starts the endnotes page with a bold,
4501 centred, double-underscored head, &#8220;ENDNOTES&#8221;.
4502 Subsequently, for each section in a
4503 <a href="rectoverso.html#collate-intro">collated</a>
4504 document (eg chapters in a book), she identifies the section in bold
4505 type, flush left and underscored, followed by one-half linespace.
4506 Endnotes pertaining to the section are output underneath, identified
4507 by superscript numbers.  The text of the endnotes themselves is
4508 indented to the right of the numbers.
4509 </p>
4510
4511 <div class="box-tip">
4512 <p class="tip">
4513 <span class="note">Note:</span>
4514 The one-half linespace between section identifiers and the endnotes
4515 themselves, plus the need to group identifiers and endnotes sensibly,
4516 means that mom cannot guarantee perfectly aligned bottom margins.
4517 This is an unavoidable consequence of the structure of endnotes.
4518 </p>
4519 </div>
4520
4521 <p>
4522 Of course, all the defaults, as well as the overall style of the
4523 endnotes pages, can be changed with the
4524 <a href="#endnote-control">endnote control macros</a>.
4525 The attentive will notice that endnotes have an awful lot of control
4526 macros.  This is because endnotes are like a mini-document unto
4527 themselves, and therefore need not be bound by the style parameters
4528 of the body of the document.
4529 </p>
4530
4531 <h3 id="endnote-columns" class="docs">Endnotes and columnar documents</h3>
4532
4533 <p>
4534 If your document is set in columns (see
4535 <a href="docprocessing.html#columns">COLUMNS</a>),
4536 mom gives you the option to have endnotes appear in either
4537 the column format or set to the full page width.  See
4538 <a href="#endnotes-no-columns">ENDNOTES_NO_COLUMNS</a>.
4539 </p>
4540
4541 <!-- -ENDNOTE- -->
4542
4543 <div class="macro-id-overline">
4544 <h3 id="endnote" class="macro-id">ENDNOTE</h3>
4545 </div>
4546
4547 <div class="box-macro-args">
4548 Macro: <b>ENDNOTE</b> <kbd class="macro-args">&lt;toggle&gt; [ BREAK | BR ]</kbd>
4549 </div>
4550 <p class="requires">
4551 See <span style="font-style: normal"><a href="#endnote-note">HYPER-IMPORTANT NOTE</a></span>
4552 </p>
4553
4554 <p>
4555 ENDNOTE is a toggle macro, therefore invoking it on a line by itself
4556 allows you to enter an endnote in the body of a document.  Invoking
4557 it with any other argument (ie <kbd>OFF, QUIT, END, X...</kbd>)
4558 tells mom that you&#8217;ve finished the endnote.
4559 </p>
4560
4561 <div class="box-tip">
4562 <p class="tip">
4563 <span class="note">Note:</span>
4564 If an endnote runs to more than one paragraph, do <i>not</i> begin
4565 the endnote with the
4566 <a href="#pp">PP</a>
4567 tag.  Use PP only to introduce subsequent paragraphs.
4568 </p>
4569 </div>
4570
4571 <div id="endnote-note" class="box-tip">
4572 <p class="tip-top">
4573 <span class="note">HYPER-IMPORTANT NOTE:</span>
4574 If your
4575 <a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
4576 is <kbd>NUMBER</kbd> or <kbd>SUPERSCRIPT</kbd> (mom&#8217;s
4577 default is <kbd>NUMBER</kbd> unless you have
4578 <a href="refer.html#endnote-refs">ENDNOTE_REFS</a>
4579 enabled, in which case it&#8217;s <kbd>SUPERSCRIPT</kbd>), the final word on the
4580 <a href="definitions.html#inputline">input line</a>
4581 that comes immediately before <kbd>.ENDNOTE</kbd> must terminate
4582 with a
4583 <a href="typesetting.html#join"><kbd>\c</kbd></a>
4584 inline escape.  See the
4585 <a href="#endnote-example">endnote example</a>
4586 above.
4587 </p>
4588
4589 <p>
4590 Additionally, in
4591 <a href="definitions.html#filled">fill</a>
4592 modes
4593 (<a href="typesetting.html#justify">JUSTIFY</a>
4594 or
4595 <a href="typesetting.html#quad">QUAD</a>,
4596 the line after <kbd>.ENDNOTE&nbsp;OFF</kbd> should be
4597 entered as if there were no interruption in the input text, ie
4598 the line should begin with a literal space or punctuation mark (see
4599 explanation and examples for footnotes, which apply equally to
4600 endnotes,
4601 <a href="#fn-and-punct">here</a>).
4602 </p>
4603
4604 <p>
4605 In
4606 <a href="definitions.html#filled">no-fill</a>
4607 modes, the optional argument <kbd>BREAK</kbd> or <kbd>BR</kbd> may
4608 be used after the <kbd>OFF</kbd> (or <kbd>QUIT, END, X,</kbd> etc.)
4609 argument to instruct mom not to join the next input line to the
4610 previous output.  See
4611 <a href="#fn-and-punct-nofill">here</a>
4612 for a more complete explanation.  The examples are for
4613 <kbd>.FOOTNOTE</kbd>, but apply equally to <kbd>.ENDNOTE</kbd>.
4614 </p>
4615
4616 <p class="tip-bottom">
4617 If your ENDNOTE_MARKER_STYLE is LINE, do not use the <kbd>\c</kbd>
4618 escape, and enter the line after <kbd>.ENDNOTE OFF</kbd> normally,
4619 ie at your text editor&#8217;s left margin.
4620 </p>
4621 </div>
4622
4623 <!-- -ENDNOTES- -->
4624
4625 <div class="macro-id-overline">
4626 <h3 id="endnotes" class="macro-id">ENDNOTES</h3>
4627 </div>
4628
4629 <div class="box-macro-args">
4630 Macro: <b>ENDNOTES</b>
4631 </div>
4632
4633 <p>
4634 Unlike footnotes, which mom automatically outputs at the bottom
4635 of pages, endnotes must be explicitly output by you, the
4636 user. ENDNOTES, by itself (ie without any argument), is the macro
4637 to do this.
4638 </p>
4639
4640 <p>
4641 Typically, you&#8217;ll use ENDNOTES at the end of a document.  If
4642 it&#8217;s a single (ie not collated) document, mom will print
4643 the endnotes pertaining to it.  If it&#8217;s a collated document,
4644 mom will print all the endnotes contained within all sections of
4645 the document (typically chapters), appropriately identified and
4646 numbered.
4647 </p>
4648
4649 <p>
4650 Should you wish to output the endnotes for each section of a
4651 collated document at the ends of the sections (instead of at the
4652 very end of the document), simply invoke <kbd>.ENDNOTES</kbd>
4653 immediately prior to
4654 <a href="rectoverso.html#collate">COLLATE</a>.
4655 Mom will print the endnotes, identified and numbered appropriately,
4656 on a separate page prior to starting the next section of the
4657 document.  Each subsequent invocation of <kbd>.ENDNOTES</kbd>
4658 outputs only those endnotes that mom collected after the previous
4659 invocation.
4660 </p>
4661
4662 <div class="defaults-container" style="background-color: #ded4bd; border: none;">
4663 <h3 id="endnote-control" class="docs defaults">ENDNOTES control macros and defaults</h3>
4664
4665 <div class="box-important" style="width: 700px; margin: auto; background-color: #ded4bd;">
4666 <p class="tip-top" style="color: #000056;">
4667 <span class="important">Important:</span>
4668 Endnotes control macros must always be invoked prior to the first
4669 instance of
4670 <a href="#endnote"><kbd>.ENDNOTE</kbd></a>.
4671 </p>
4672
4673 <p style="color: #000056; margin-top: -.5em;">
4674 When you embed endnotes in the body of a document, mom collects
4675 <i>and processes</i> them for later outputting (when you invoke
4676 <a href="#endnotes"><kbd>.ENDNOTES</kbd></a>).
4677 By the time you do invoke <kbd
4678 style="color: #000056;">.ENDNOTES</kbd>, it&#8217;s much too late to
4679 change your mind about how you want them to look.
4680 </p>
4681
4682 <p class="tip-bottom" style="color: #000056; margin-top: -.5em;">
4683 My advice?  If you&#8217;re planning to change the default
4684 appearance of endnotes pages, set them up prior to
4685 <a href="docprocessing.html#start">START</a>.
4686 </p>
4687 </div>
4688
4689 <ol style="margin-top: .5em; padding-bottom: .5em;">
4690   <li><a href="#endnotes-general"><b>General endnotes style control</b></a>
4691   <ul style="margin-left: -.5em;">
4692     <li><a href="#endnote-style">Base family/font/quad</a></li>
4693     <li><a href="#endnote-pt-size">Base point size</a></li>
4694     <li><a href="#endnote-lead">Leading</a></li>
4695     <li><a href="#endnote-spacing">Spacing between endnotes</a></li>
4696     <li><a href="#singlespace-endnotes">Singlespace endnotes (TYPEWRITE only)</a></li>
4697     <li><a href="#endnote-para-indent">Paragraph indenting</a></li>
4698     <li><a href="#endnote-para-space">Inter-paragraph spacing</a></li>
4699     <li><a href="#endnotes-no-columns">Turning off column mode during endnotes output</a></li>
4700   </ul></li>
4701   <li><a href="#endnotes-pagination"><b>Pagination of endnotes</b></a>
4702   <ul style="margin-left: -.5em;">
4703     <li><a href="#endnotes-pagenum-style">Page numbering style</a></li>
4704     <li><a href="#endnotes-first-pagenumber">Setting the first page number of endnotes</a></li>
4705     <li><a href="#endnotes-no-first-pagenum">Omitting a page number on the first page of endnotes</a></li>
4706     <li><a href="#suspend-pagination">Suspending pagination during endnotes output</a></li>
4707   </ul></li>
4708   <li><a href="#endnotes-header-control"><b>Header/footer control</b></a>
4709   <ul style="margin-left: -.5em;">
4710     <li><a href="#endnotes-modify-hdrftr">Modifying what goes in the endnotes header/footer</a></li>
4711     <li><a href="#endnotes-hdrftr-center">Header/footer centre string when doctype is CHAPTER</a></li>
4712     <li><a href="#endnotes-allows-headers">Allow headers on endnotes pages</a></li>
4713   </ul></li>
4714   <li><a href="#endnotes-main-title"><b>Endnotes' first-page title control</b></a>
4715   <ul style="margin-left: -.5em;">
4716     <li><a href="#endnote-string">Title string</a></li>
4717     <li><a href="#endnote-string-control">Title string control macros and defaults</a></li>
4718     <li><a href="#endnote-string-placement">Title string placement</a></li>
4719     <li><a href="#endnote-string-underline">Title string underscoring</a></li>
4720     <li><a href="#endnote-string-caps">Title string capitalization</a></li>
4721   </ul></li>
4722   <li><a href="#endnotes-doc-title"><b>Endnotes document-identification string control</b></a>
4723   <ul style="margin-left: -.5em;">
4724     <li><a href="#endnote-title">Document-identification string(s)</a></li>
4725     <li><a href="#endnote-title-control">Document-identification string control macros and defaults</a></li>
4726     <li><a href="#endnote-title-underscore">Document-identification string underscoring</a></li>
4727   </ul></li>
4728   <li><a href="#endnotes-numbering"><b>Endnotes referencing style</b></a>
4729   <ul style="margin-left: -.5em;">
4730     <li><a href="#endnote-marker-style">Endnote marker style</a> &ndash; by numbers in the text, or by line number
4731     <ul style="margin-left: -.5em;">
4732       <li><a href="#endnote-linenumber-gap">Spacing between line-numbered endnotes and the endnote text</a></li>
4733       <li><a href="#endnote-linenumber-brackets">Brackets around endnote line numbers</a></li>
4734       <li><a href="#endnote-linenumber-separator">Separator after endnote line numbers instead of brackets</a></li>
4735     </ul></li>
4736     <li><a href="#endnote-number-control">Endnote numbering control macros and defaults</a></li>
4737     <li><a href="#endnote-number-alignment">Endnote numbering alignment</a></li>
4738   </ul></li>
4739 </ol>
4740 </div>
4741
4742 <h4 id="endnotes-general" class="docs" style="margin-top: -1.5em; margin-bottom: .5em;">1. General endnotes page style control</h4>
4743
4744 <h5 id="endnote-style" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Base family/font/quad</h5>
4745
4746 <div class="defaults-container" style="padding-bottom: 8px;">
4747 <p class="defaults" style="padding-top: 6px;">
4748 See
4749 <a href="#control-macro-args">Arguments to the control macros</a>.
4750 </p>
4751 <span class="pre defaults">
4752 .ENDNOTE_FAMILY    default = prevailing document family; default is Times Roman
4753 .ENDNOTE_FONT      default = roman
4754 .ENDNOTE_QUAD*     default = justified
4755
4756 *Note: ENDNOTE_QUAD must be set to either L (LEFT) or J (JUSTIFIED);
4757  R (RIGHT) and C (CENTER) will not work.
4758 </span>
4759 </div>
4760
4761 <!-- -ENDNOTE_PT_SIZE- -->
4762
4763 <h5 id="endnote-pt-size" class="docs" style="margin-top: -1.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Base point size</h5>
4764
4765 <div class="box-macro-args">
4766 Macro: <b>ENDNOTE_PT_SIZE</b> <kbd class="macro-args">&lt;base type size of endnotes&gt;</kbd>
4767 </div>
4768
4769 <p>
4770 Unlike most other control macros that deal with size of document
4771 elements, ENDNOTE_PT_SIZE takes as its argument an absolute value,
4772 relative to nothing.  Therefore, the argument represents the size of
4773 endnote type in
4774 <a href="definitions.html#picaspoints">points</a>,
4775 unless you append an alternative
4776 <a href="definitions.html#unitofmeasure">unit of measure</a>.
4777 For example,
4778 <br/>
4779 <span class="pre-in-pp">
4780   .ENDNOTE_PT_SIZE 12
4781 </span>
4782 sets the base point size of type on the endnotes page to 12
4783 points, whereas
4784 <br/>
4785 <span class="pre-in-pp">
4786   .ENDNOTE_PT_SIZE .6i
4787 </span>
4788 sets the base point size of type on the endnotes page to 1/6 of an
4789 inch.
4790 </p>
4791
4792 <p>
4793 The type size set with ENDNOTE_PT_SIZE is the size of type used for
4794 the text of the endnotes, and forms the basis from which the point
4795 size of other endnote page elements is calculated.
4796 </p>
4797
4798 <p>
4799 The default for
4800 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>
4801 is 12.5 points (the same default size used in the body of the
4802 document).
4803 </p>
4804
4805 <!-- -ENDNOTE_LEAD- -->
4806
4807 <h5 id="endnote-lead" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Leading</h5>
4808
4809 <div class="box-macro-args">
4810 Macro: <b>ENDNOTE_LEAD</b> <kbd class="macro-args">&lt;base leading of endnotes&gt; [ ADJUST ] </kbd>
4811 </div>
4812
4813 <p class="requires">
4814 &bull;&nbsp;Does not require a <a href="definitions.html#unitofmeasure">unit of measure</a>; points is assumed
4815 </p>
4816
4817 <p>
4818 Unlike most other control macros that deal with leading of document
4819 elements, ENDNOTE_LEAD takes as its argument an absolute value,
4820 relative to nothing.  Therefore, the argument represents the
4821 <a href="definitions.html#leading">leading</a>
4822 of endnotes in
4823 <a href="definitions.html#picaspoints">points</a>
4824 unless you append an alternative
4825 <a href="definitions.html#unitofmeasure">unit of measure</a>.
4826 For example,
4827 <br/>
4828 <span class="pre-in-pp">
4829   .ENDNOTE_LEAD 14
4830 </span>
4831 sets the base leading of type on the endnotes page to 14
4832 points, whereas
4833 <br/>
4834 <span class="pre-in-pp">
4835   .ENDNOTE_LEAD .5i
4836 </span>
4837 sets the base leading of type on the endnotes page to 1/2 inch.
4838 </p>
4839
4840 <p>
4841 If you want the leading of endnotes adjusted to fill the page, pass
4842 ENDNOTE_LEAD the optional argument
4843 <kbd>ADJUST</kbd>.  (See
4844 <a href="docprocessing.html#doc-lead-adjust">DOC_LEAD_ADJUST</a>
4845 for an explanation of leading adjustment.)
4846 </p>
4847
4848 <p>
4849 The default for
4850 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>
4851 is the prevailing document leading (16 by default), adjusted.
4852 </p>
4853
4854 <div class="box-tip">
4855 <p class="tip">
4856 <span class="note">Note:</span>
4857 Even if you give mom a <kbd>.DOC_LEAD_ADJUST&nbsp;OFF</kbd> command, she
4858 will still, by default, adjust endnote leading.  You <i>must</i>
4859 enter <kbd>.ENDNOTE_LEAD&nbsp;&lt;lead&gt;</kbd> with no
4860 <kbd>ADJUST</kbd> argument to disable this default behaviour.
4861 </p>
4862 </div>
4863
4864 <!-- -ENDNOTE_SPACING- -->
4865
4866 <h5 id="endnote-spacing" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Spacing between endnotes</h5>
4867
4868 <div class="box-macro-args">
4869 Macro: <b>ENDNOTE_SPACING</b> <kbd class="macro-args">&lt;space to insert between endnotes&gt;</kbd>
4870 </div>
4871 <p class="requires">
4872 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
4873 </p>
4874
4875 <p>
4876 If you'd like some whitespace between endnotes, just invoke
4877 ENDNOTE_SPACING with the amount of space you want, eg
4878 <br/>
4879 <span class="pre-in-pp">
4880   .ENDNOTE_SPACING 6p
4881 </span>
4882 which inserts 6 points of lead between endnotes.  Be aware, though,
4883 that inserting space between endnotes means that the bottoms of
4884 endnotes pages will most likely not align.
4885 </p>
4886
4887 <p>
4888 Mom&#8217;s default is not to insert any whitespace between endnotes.
4889 </p>
4890
4891 <!-- -SINGLESPACE_ENDNOTES- -->
4892
4893 <h5 id="singlespace-endnotes" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Singlespace endnotes (TYPEWRITE only)</h5>
4894
4895 <div class="box-macro-args">
4896 Macro: <b>SINGLESPACE_ENDNOTES</b> <kbd class="macro-args">&lt;toggle&gt;</kbd>
4897 </div>
4898
4899 <p>
4900 If your
4901 <a href="docprocessing.html#printstyle">PRINTSTYLE</a>
4902 is <kbd>TYPEWRITE</kbd> and you use TYPEWRITE&#8217;s default
4903 double-spacing, endnotes are double-spaced.  If your document is
4904 single-spaced, endnotes are single-spaced.
4905 </p>
4906
4907 <p>
4908 If, for some reason, you&#8217;d prefer that endnotes be
4909 single-spaced in an otherwise double-spaced document (including
4910 double-spaced
4911 <a href="rectoverso.html#collate">collated</a>
4912 documents), invoke
4913 <br/>
4914 <span class="pre-in-pp">
4915   .SINGLESPACE_ENDNOTES
4916 </span>
4917 with no argument.  And if, god help you, you want to change endnote
4918 single-spacing back to double-spacing for different spacing of
4919 endnotes output at the ends of separate documents in a collated
4920 document, invoke <kbd>.SINGLESPACE_ENDNOTES</kbd> with any argument
4921 (<kbd>OFF, QUIT, Q, X</kbd>...).
4922 </p>
4923
4924 <!-- -ENDNOTE_PARA_INDENT- -->
4925
4926 <h5 id="endnote-para-indent" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Paragraph indenting</h5>
4927
4928 <div class="box-macro-args">
4929 Macro: <b>ENDNOTE_PARA_INDENT</b> <kbd class="macro-args">&lt;amount to indent first line of paragraphs in endnotes&gt;</kbd>
4930 </div>
4931
4932 <p class="requires">
4933 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
4934 </p>
4935
4936 <p>
4937 ENDNOTE_PARA_INDENT works exactly the same way as
4938 <a href="#para-indent">PARA_INDENT</a>,
4939 except that the indent given is the amount by which to indent the
4940 first lines of endnote paragraphs, not document body paragraphs.
4941 </p>
4942
4943 <p>
4944 The default is 1.5
4945 <a href="definitions.html#em">ems</a>
4946 for
4947 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>;
4948 1/2 inch for
4949 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>.
4950 </p>
4951
4952 <div class="box-tip">
4953 <p class="tip">
4954 <span class="note">Note:</span>
4955 The first line of the first paragraph of endnotes (the one attached
4956 immediately to the identifying endnote number) is never indented.
4957 Only subsequent paragraphs are affected by ENDNOTE_PARA_INDENT.
4958 </p>
4959 </div>
4960
4961 <!-- -ENDNOTE_PARA_SPACE- -->
4962
4963 <h5 id="endnote-para-space" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Inter-paragraph spacing</h5>
4964
4965 <div class="box-macro-args">
4966 Macro: <b>ENDNOTE_PARA_SPACE</b> <kbd class="macro-args">&lt;toggle&gt;</kbd>
4967 </div>
4968
4969 <p>
4970 ENDNOTE_PARA_SPACE works exactly the same way as
4971 <a href="#pp-space">PARA_SPACE</a>,
4972 except that it inserts a blank line between endnote paragraphs, not
4973 document body paragraphs.
4974 </p>
4975
4976 <p>
4977 The default is not to insert a blank line between paragraphs in
4978 endnotes.
4979 </p>
4980
4981 <!-- -ENDNOTES_NO_COLUMNS- -->
4982
4983 <h5 id="endnotes-no-columns" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Turning off column mode during endnotes output</h5>
4984
4985 <div class="box-macro-args">
4986 Macro: <b>ENDNOTES_NO_COLUMNS</b> <kbd class="macro-args">&lt;toggle&gt;</kbd>
4987 </div>
4988
4989 <p>
4990 By default, if your document is set in
4991 <a href="docprocessing.html#columns">columns</a>,
4992 mom sets the endnotes in columns, too.  However, if your document
4993 is set in columns and you&#8217;d like the endnotes not to be,
4994 just invoke <kbd>.ENDNOTES_NO_COLUMNS</kbd> with no argument.
4995 The endnotes pages will be set to the full page measure of your
4996 document.
4997 </p>
4998
4999 <p>
5000 If you output endnotes at the end of each document in a
5001 <a href="rectoverso.html#collate">collated</a>
5002 document set in columns, column mode will automatically be
5003 reinstated for each document, even with ENDNOTES_NO_COLUMNS turned
5004 on.  In such circumstances, you must re-enable ENDNOTES_NO_COLUMNS
5005 for each separate collated document.
5006 </p>
5007
5008 <h4 id="endnotes-pagination" class="docs" style="margin-bottom: .5em;">2. Pagination of endnotes</h4>
5009
5010 <!-- -ENDNOTES_PAGENUM_STYLE- -->
5011
5012 <h5 id="endnotes-pagenum-style" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Page numbering style</h5>
5013
5014 <div class="box-macro-args">
5015 Macro: <b>ENDNOTES_PAGENUM_STYLE</b> <kbd class="macro-args">DIGIT | ROMAN | roman | ALPHA | alpha</kbd>
5016 </div>
5017
5018 <p>
5019 Use this macro to set the page numbering style of endnotes pages.
5020 The arguments are identical to those for
5021 <a href="headfootpage.html#pagenum-style">PAGENUM_STYLE</a>.
5022 The default is <kbd>digit</kbd>.  You may want to change it to, say,
5023 <kbd>alpha</kbd>, which you would do with
5024 <br/>
5025 <span class="pre-in-pp">
5026   .ENDNOTES_PAGENUM_STYLE alpha
5027 </span>
5028 </p>
5029
5030 <!-- -ENDNOTES_FIRST_PAGENUMBER- -->
5031
5032 <h5 id="endnotes-first-pagenumber" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Setting the first page number of endnotes</h5>
5033
5034 <div class="box-macro-args">
5035 Macro: <b>ENDNOTES_FIRST_PAGENUMBER</b> <kbd class="macro-args">&lt;page # that appears on page 1 of endnotes&gt;</kbd>
5036 </div>
5037
5038 <p>
5039 Use this macro with caution.  If all endnotes for several
5040 <a href="rectoverso.html#collate">collated</a>
5041 documents are to be output at once, ie not at the end of each
5042 separate doc, ENDNOTES_FIRST_PAGENUMBER tells mom what page number
5043 to put on the first page of the endnotes.
5044 </p>
5045
5046 <p>
5047 However, if you set ENDNOTES_FIRST_PAGENUMBER in collated documents
5048 in which the endnotes are output after each section (chapter,
5049 article, etc), you have to reset every section&#8217;s first page
5050 number after
5051 <a href="rectoverso.html#collate">COLLATE</a>
5052 and before
5053 <a href="docprocessing.html#start">START</a>
5054 with
5055 <a href="headfootpage.html#pagenumber">PAGENUMBER</a>.
5056 </p>
5057
5058 <!-- -ENDNOTES_NO_FIRST_PAGENUN- -->
5059
5060 <h5 id="endnotes-no-first-pagenum" class="docs" style="margin-top: -.25em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Omitting a page number on the first page of endnotes</h5>
5061
5062 <div class="box-macro-args">
5063 Macro: <b>ENDNOTES_NO_FIRST_PAGENUM</b> <kbd class="macro-args">&lt;toggle&gt;</kbd>
5064 </div>
5065
5066 <p>
5067 This macro is for use only if
5068 <a href="headfootpage.html#footers">FOOTERS</a>
5069 are on.  It tells
5070 <a href="#endnotes">ENDNOTES</a>
5071 not to print a page number on the first endnotes page.  Mom&#8217;s
5072 default is to print the page number.
5073 </p>
5074
5075 <!-- -SUSPEND_PAGINATION- -->
5076
5077 <h5 id="suspend-pagination" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Suspending pagination during endnotes output</h5>
5078
5079 <div class="box-macro-args" style="margin-bottom: 1em;">
5080 Macro: <b>SUSPEND_PAGINATION</b>
5081 </div>
5082
5083 <div class="box-macro-args">
5084 Macro: <b>RESTORE_PAGINATION</b>
5085 </div>
5086
5087 <p>
5088 SUSPEND_PAGINATION doesn&#8217;t take an argument.  Invoked
5089 immediately prior to
5090 <a href="#endnotes">ENDNOTES</a>,
5091 it turns off endnotes pages pagination.  Mom continues, however to
5092 increment page numbers silently.
5093 </p>
5094
5095 <p>
5096 To restore normal document pagination after endnotes, invoke
5097 <kbd>.RESTORE_PAGINATION</kbd> (again, with no argument) immediately
5098 after <kbd>.ENDNOTES</kbd>.
5099 </p>
5100
5101 <h4 id="endnotes-header-control" class="docs" style="margin-bottom: .5em;">3. Header/footer control</h4>
5102
5103 <h5 id="endnotes-modify-hdrftr" class="docs" style="margin-top: 0; margin-bottom: -.75em; margin-left: .5em;">&bull;&nbsp;Modifying what goes in the endnotes header/footer</h5>
5104
5105 <p>
5106 If you wish to modify what appears in the header/footer that appears
5107 on endnotes page(s), make the changes before you invoke
5108 <a href="#endnotes"><kbd>.ENDNOTES</kbd></a>,
5109 not afterwards.
5110 </p>
5111
5112 <p>
5113 Except in the case of
5114 <a href="docprocessing.html#doctype">DOCTYPE <kbd>CHAPTER</kbd></a>,
5115 mom prints the same header or footer used throughout the document
5116 on the endnotes page(s).  Chapters get treated differently in that,
5117 by default, mom does not print the header/footer centre string
5118 (normally the chapter number or chapter title.)  In most cases, this
5119 is what you want.  However, should you not want mom to remove
5120 the centre string from the endnotes page(s) headers/footers, invoke
5121 <kbd><a href="#endnotes-hdrftr-center">.ENDNOTES_HEADER_CENTER</a></kbd>
5122 with no argument.
5123 </p>
5124
5125 <p>
5126 An important change you may want to make is to put the word
5127 &#8220;Endnotes&#8221; in the header/footer centre position.  To do
5128 so, invoke
5129 <br/>
5130 <span class="pre-in-pp" style="margin-bottom: -1em;">
5131   .HEADER_CENTER "Endnotes"
5132 </span>
5133 or
5134 <span class="pre-in-pp" style="margin-top: -.5em;">
5135   .FOOTER_CENTER "Endnotes"
5136 </span>
5137 prior to invoking <kbd>.ENDNOTES</kbd>.
5138 </p>
5139
5140 <div class="box-tip">
5141 <p class="tip">
5142 <span class="note">Note:</span>
5143 If your
5144 <a href="docprocessing.html#doctype">DOCTYPE</a>
5145 is <kbd>CHAPTER</kbd>, you must also invoke
5146 <a href="#endnotes-hdrftr-center">ENDNOTES_HEADER_CENTER</a>
5147 for the ENDNOTES_HEADER_CENTER to appear.
5148 </p>
5149 </div>
5150
5151 <h5 id="endnotes-hdrftr-center" class="docs" style="margin-top: 0; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Header/footer centre string when doctype is CHAPTER</h5>
5152
5153 <div class="box-macro-args">
5154 Macro: <b>ENDNOTES_HEADER_CENTER</b> <kbd class="macro-args">toggle</kbd>
5155 </div>
5156
5157 <p>
5158 If your
5159 <a href="docprocessing.html#doctype">DOCTYPE</a>
5160 is <kbd>CHAPTER</kbd> and you want mom to include a centre
5161 string in the headers/footers that appear on endnotes
5162 pages, invoke <kbd>.ENDNOTES_HEADER_CENTER</kbd> (or
5163 <kbd>.ENDNOTES_FOOTER_CENTER</kbd>) with no argument.  Mom&#8217;s
5164 default is not to print the centre string.
5165 </p>
5166
5167 <p>
5168 If, for some reason, having enabled the header/footer centre string
5169 on endnotes pages, you wish to disable it, invoke the same macro
5170 with any argument (<kbd>OFF, QUIT, Q, X</kbd>...).
5171 </p>
5172
5173 <h5 id="endnotes-allows-headers" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Allow headers on endnotes pages</h5>
5174
5175 <div class="box-macro-args">
5176 Macro: <b>ENDNOTES_ALLOWS_HEADERS</b> <kbd class="macro-args">&lt;none&gt; | ALL</kbd>
5177 </div>
5178
5179 <p>
5180 By default, if HEADERS are on, mom prints page headers on all
5181 endnotes pages except the first.  If you don&#8217;t want her to
5182 print headers on endnotes pages, do
5183 <br/>
5184 <span class="pre-in-pp">
5185   .ENDNOTES_ALLOWS_HEADERS OFF
5186 </span>
5187 If you want headers on every page including the first, do
5188 <br/>
5189 <span class="pre-in-pp">
5190   .ENDNOTES_ALLOWS_HEADERS ALL
5191 </span>
5192 </p>
5193
5194 <div class="box-tip">
5195 <p class="tip">
5196 <span class="note">Note:</span>
5197 If FOOTERS are on, mom prints footers on every endnotes page.
5198 This is a style convention.  In mom, there is no such beast as
5199 ENDNOTES_ALLOWS_FOOTERS OFF.
5200 </p>
5201 </div>
5202
5203 <h4 id="endnotes-main-title" class="docs">4. Endnotes' first-page title control</h4>
5204
5205 <!-- -ENDNOTE_STRING- -->
5206
5207 <h5 id="endnote-string" class="docs" style="margin-top: 1em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Title string</h5>
5208
5209 <div class="box-macro-args">
5210 Macro: <b>ENDNOTE_STRING</b> <kbd class="macro-args">&quot;&lt;head to print at the top of endnotes&gt;&quot;</kbd>
5211 </div>
5212
5213 <p>
5214 By default, mom prints the word &#8220;ENDNOTES&#8221; as a head
5215 at the top of the first page of endnotes.  If you want her to
5216 print something else, invoke <kbd>.ENDNOTE_STRING</kbd> with the
5217 endnotes-page head you want, surrounded by double-quotes.  If you
5218 don&#8217;t want a head at the top of the first endnotes-page,
5219 invoke <kbd>.ENDNOTE_STRING</kbd> with a blank argument (either two
5220 double-quotes side by side&mdash;<kbd>&quot;&quot;</kbd>&mdash;or no
5221 argument at all).
5222 </p>
5223
5224 <!-- -ENDNOTE_STRING_CONTROL- -->
5225
5226 <h5 id="endnote-string-control" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Title control macros and defaults</h5>
5227
5228 <div class="defaults-container" style="padding-bottom: 8px;">
5229 <p class="defaults" style="padding-top: 6px;">
5230 See
5231 <a href="#control-macro-args">Arguments to the control macros</a>.
5232 </p>
5233 <span class="pre defaults">
5234 .ENDNOTE_STRING_FAMILY  default = prevailing document family
5235 .ENDNOTE_STRING_FONT    default = bold
5236 .ENDNOTE_STRING_SIZE*   default = +1
5237 .ENDNOTE_STRING_QUAD    default = centred
5238 .ENDNOTE_STRING_COLOR   default = black
5239
5240 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
5241 </span>
5242 </div>
5243
5244 <!-- -ENDNOTE_STRING_ADVANCE- -->
5245
5246 <h5 id="endnote-string-placement" class="docs" style="margin-top: -1em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Title string placement</h5>
5247
5248 <div class="box-macro-args">
5249 Macro: <b>ENDNOTE_STRING_ADVANCE</b> <kbd class="macro-args">&lt;distance from top of page&gt;</kbd>
5250 </div>
5251
5252 <p class="requires">
5253 &bull;&nbsp;Argument requires a <a href="definitions.html#unitofmeasure">unit of measusure</a>
5254 </p>
5255
5256 <p>
5257 By default, mom places the title (the docheader, as it were) of
5258 endnotes pages (typically "ENDNOTES") on the same
5259 <a href="definitions.html#baseline">baseline</a>
5260 that is used for the start of
5261 <a href="definitions.html#running">running text</a>.
5262 If you&#8217;d prefer another location, higher or lower on the page
5263 (thereby also raising or lowering the starting position of the
5264 endnotes themselves), invoke <kbd>.ENDNOTE_STRING_ADVANCE</kbd> with
5265 an argument stating the distance from the top edge of the page at
5266 which you&#8217;d like the title placed.
5267 </p>
5268
5269 <p>
5270 The argument requires a unit of measure, so if you&#8217;d like the title
5271 to appear 1-1/2 inches from the top edge of the page, you&#8217;d tell
5272 mom about it like this:
5273 <br/>
5274 <span class="pre-in-pp">
5275   .ENDNOTE_STRING_ADVANCE 1.5i
5276 </span>
5277 </p>
5278
5279 <!-- -ENDNOTE_STRING_UNDERLINE- -->
5280
5281 <h5 id="endnote-string-underline" class="docs" style="margin-top: -1em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Title string underscoring</h5>
5282
5283 <div class="box-macro-args">
5284 Macro: <b>ENDNOTE_STRING_UNDERSCORE</b> <kbd class="macro-args">[DOUBLE] [&lt;underscore weight&gt; [&lt;underscore gap&gt; [&lt;distance between double rules]]] | &lt;none&gt; | &lt;anything&gt;</kbd>
5285 </div>
5286
5287 <p class="alias" style="margin-bottom: 0;">
5288 <i>Alias:</i> <b>ENDNOTE_STRING_UNDERLINE</b>
5289 </p>
5290
5291 <p class="requires">
5292 &bull;&nbsp;The argument
5293 <span style="font-style: normal"><kbd>&lt;underscore weight&gt;</kbd></span>
5294 must not have the
5295 <a href="definitions.html#unitofmeasure">unit of measure</a>,
5296 <span style="font-style: normal;"><kbd>p</kbd></span>,
5297 appended to it; all other arguments require a unit of measure
5298 </p>
5299
5300 <p>
5301 Invoked without an argument, <kbd>.ENDNOTE_STRING_UNDERSCORE</kbd>
5302 will place a single rule underneath the endnotes page title.  Invoked
5303 with the argument, <kbd>DOUBLE</kbd>, ENDNOTE_STRING_UNDERSCORE will
5304 double-underscore the title.  Invoked with any other non-numeric
5305 argument, (eg <kbd>OFF, NO, X</kbd>, etc.) the macro disables
5306 underscoring of the title.
5307 </p>
5308
5309 <p>
5310 In addition, you can use ENDNOTE_STRING_UNDERSCORE to control the
5311 weight of the underscore rule(s), the gap between the title and the
5312 underscore, and, in the case of double-underscores, the distance
5313 between the two rules.
5314 </p>
5315
5316 <p>
5317 Some examples:
5318 <br/>
5319 <span class="pre-in-pp">
5320   .ENDNOTE_STRING_UNDERSCORE 1
5321       - turn underscoring on; set the rule weight to 1 point
5322
5323   .ENDNOTE_STRING_UNDERSCORE 1 3p
5324       - turn underscoring on; set the rule weight to 1 point; set
5325         the gap between the title and the underscore to 3 points
5326
5327   .ENDNOTE_STRING_UNDERSCORE DOUBLE .75 3p
5328       - turn double-underscoring on; set the rule weight to 3/4 of
5329         a point; set the gap between the title and the upper
5330         underscore to 3 points; leave the gap between the upper
5331         and the lower underunderscore at the default
5332
5333   .ENDNOTE_STRING_UNDERSCORE DOUBLE 1.5 1.5p 1.5p
5334       - turn double-underscoring on; set the rule weight to 1-1/2
5335         points; set the gap between the title and the upper
5336         underscore to 1-1/2 points; set the gap between the upper
5337         and the lower underscore to 1-1/2 points
5338 </span>
5339 Note, from the above, that in all instances, underscoring (single
5340 or double) is enabled whenever ENDNOTE_STRING_UNDERSCORE is used in
5341 this way.
5342 </p>
5343
5344 <p>
5345 Mom&#8217;s default is to double-underscore the title with 1/2-point
5346 rules placed 2 points apart and 2 points below the baseline of the
5347 title.
5348 </p>
5349
5350 <!-- -ENDNOTE_STRING_CAPS- -->
5351
5352 <h5 id="endnote-string-caps" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Title string capitalization</h5>
5353
5354 <div class="box-macro-args">
5355 Macro: <b>ENDNOTE_STRING_CAPS</b> <kbd class="macro-args">toggle</kbd>
5356 </div>
5357
5358 <p>
5359 Invoked by itself, <kbd>.ENDNOTE_STRING_CAPS</kbd> will
5360 automatically capitalize the endnotes-page title.  Invoked with any
5361 other argument, the macro disables automatic capitalization of the
5362 title.
5363 </p>
5364
5365 <p>
5366 If you&#8217;re generating a table of contents, you may want the
5367 endnotes pages title to be in caps, but the toc entry in caps/lower
5368 case.  If the argument to
5369 <kbd><a href="#endnote-string">ENDNOTE_STRING</a></kbd>
5370 is in caps/lower case and ENDNOTE_STRING_CAPS is on, this is exactly
5371 what will happen.
5372 </p>
5373
5374 <p>
5375 Mom&#8217;s default is to capitalize the endnotes pages title string.
5376 </p>
5377
5378 <!-- -ENDNOTE_TITLE- -->
5379
5380 <h4 id="endnotes-doc-title" class="docs" style="margin-top: -.25em;">5. Endnotes document-identification title control</h4>
5381
5382 <h5 id="endnote-title" class="docs" style="margin-top: 1em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Document-identification title string(s)</h5>
5383
5384 <div class="box-macro-args">
5385 Macro: <b>ENDNOTE_TITLE</b> <kbd class="macro-args">&quot;&lt;title to identify a document in endnotes&gt;&quot;</kbd>
5386 </div>
5387
5388 <p>
5389 By default, mom identifies the document(s) to which endnotes belong
5390 by the document title(s) given to the
5391 <a href="docprocessing.html#title">TITLE</a>
5392 macro.  If you&#8217;d like her to identify the document(s) another
5393 way, simply invoke <kbd>.ENDNOTE_TITLE</kbd> prior to
5394 <a href="docprocessing.html#start">START</a>
5395 with the identifying title you want, surrounded by double-quotes.
5396 </p>
5397
5398 <p>
5399 If you don&#8217;t want any identifying title, invoke
5400 <kbd>.ENDNOTE_TITLE</kbd> with a blank argument, either two
5401 double-quotes side by side (<kbd>&quot;&quot;</kbd>) or no argument
5402 at all.  This is particularly useful if you have a single (ie
5403 non-collated) document and find having the document&#8217;s title
5404 included in the endnotes redundant.
5405 </p>
5406
5407 <!-- -ENDNOTE_TITLE_CONTROL- -->
5408
5409 <h5 id="endnote-title-control" class="docs" style="margin-top: .75em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Document-identification string control macros and defaults</h5>
5410
5411 <div class="defaults-container" style="padding-bottom: 8px;">
5412 <p class="defaults" style="padding-top: 6px;">
5413 See
5414 <a href="#control-macro-args">Arguments to the control macros</a>.
5415 </p>
5416 <span class="pre defaults">
5417 .ENDNOTE_TITLE_FAMILY  default = prevailing document family; default is Times Roman
5418 .ENDNOTE_TITLE_FONT    default = bold
5419 .ENDNOTE_TITLE_SIZE*   default = 0
5420 .ENDNOTE_TITLE_QUAD    default = left
5421
5422 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
5423 </span>
5424 </div>
5425
5426 <!-- -ENDNOTE_TITLE_UNDERLINE- -->
5427
5428 <h5 id="endnote-title-underscore" class="docs" style="margin-top: -1.25em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Endnotes document-identification underscoring</h5>
5429
5430 <div class="box-macro-args">
5431 Macro: <b>ENDNOTE_TITLE_UNDERSCORE</b> <kbd class="macro-args">[DOUBLE] [&lt;underline weight&gt; [&lt;underline gap&gt; [&lt;distance between double rules]]] | &lt;none&gt; | &lt;anything&gt;</kbd>
5432 </div>
5433
5434 <p class="alias" style="margin-bottom: 0;">
5435 <i>Alias:</i> <b>ENDNOTE_TITLE_UNDERLINE</b>
5436 </p>
5437
5438 <p class="requires">
5439 &bull;&nbsp;The argument
5440 <span style="font-style: normal"><kbd>&lt;underscore weight&gt;</kbd></span>
5441 must not have the
5442 <a href="definitions.html#unitofmeasure">unit of measure</a>,
5443 <span style="font-style: normal;"><kbd>p</kbd></span>,
5444 appended to it; all other arguments require a unit of measure
5445 </p>
5446
5447 <p>
5448 Invoked without an argument, <kbd>.ENDNOTE_TITLE_UNDERSCORE</kbd>
5449 will place a single rule underneath the document identification
5450 string.  Invoked with the argument <kbd>DOUBLE</kbd>,
5451 ENDNOTE_TITLE_UNDERSCORE will double-underscore the string.  Invoked
5452 with any other non-numeric argument, (eg <kbd>OFF, NO, X</kbd>,
5453 etc.) the macro disables underscoring of the string.
5454 </p>
5455
5456 <p>
5457 In addition, you can use ENDNOTE_TITLE_UNDERSCORE to control the
5458 weight of the underscore rule(s), the gap between the title and the
5459 underscore, and, in the case of double-underscores, the distance
5460 between the two rules.
5461 </p>
5462
5463 <p>
5464 Some examples:
5465 <br/>
5466 <span class="pre-in-pp">
5467   .ENDNOTE_TITLE_UNDERSCORE 1
5468       - turn underscoring on; set the rule weight to 1 point
5469
5470   .ENDNOTE_TITLE_UNDERSCORE 1 3p
5471       - turn underscoring on; set the rule weight to 1 point; set
5472         the gap between the string and the underscore to 3 points
5473
5474   .ENDNOTE_TITLE_UNDERSCORE DOUBLE .75 3p
5475       - turn double-underscoring on; set the rule weight to 3 points
5476
5477   .ENDNOTE_TITLE_UNDERSCORE DOUBLE 1.5 1.5p 1.5p
5478       - turn double-underscoring on; set the rule weight to 1-1/2
5479         points; set the gap between the string and the upper
5480         underscore to 1-1/2 points; set the gap between the upper
5481         and the lower underscore to 1-1/2 points
5482 </span>
5483 </p>
5484
5485 <p>
5486 Note, from the above, that in all instances, underscoring (single or
5487 double) is enabled whenever ENDNOTE_TITLE_UNDERSCORE is used in this
5488 way.
5489 </p>
5490
5491 <p>
5492 Mom&#8217;s default is to single-underscore the string with a
5493 1/2-point rule placed 2 points below its baseline.
5494 </p>
5495
5496 <!-- -ENDNOTE_NUMBERING- -->
5497
5498 <h4 id="endnotes-numbering" class="docs" style="margin-top: -.25em;">6. Endnotes referencing style</h4>
5499
5500 <h5 id="endnote-marker-style" class="docs" style="margin-top: 1em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Endnote marker style</h5>
5501
5502 <div class="box-macro-args">
5503 Macro: <b>ENDNOTE_MARKER_STYLE</b> <kbd class="macro-args"><a href="#line">LINE</a> | <a href="#number">NUMBER</a> | <a href="#superscript">SUPERSCRIPT</a></kbd>
5504 </div>
5505
5506 <p id="line">
5507 <span style="display: block; margin-bottom: .25em;">&bull;&nbsp;<i>Argument:</i> <kbd>LINE</kbd></span>
5508 By default, mom places superscript numbers in
5509 <a href="definitions.html#running">running text</a>
5510 to identify endnotes.  However, if you have
5511 <a href="#number-lines">linenumbering</a>
5512 turned on, you may instruct mom not to put superscript numbers in
5513 the running text, but rather to reference endnotes by line number.
5514 The command to do this is
5515 <br/>
5516 <span class="pre-in-pp">
5517   .ENDNOTE_MARKER_STYLE LINE
5518 </span>
5519 With ENDNOTE_MARKER_STYLE <kbd>LINE</kbd>, mom will identify
5520 endnotes either by single line numbers or by line ranges.  If
5521 what you want is a single line number, you need only invoke
5522 <kbd>.ENDNOTE</kbd> at the appropriate place in running
5523 text <i>without the terminating</i> <kbd>\c</kbd>.  Input lines
5524 after the endnote has been terminated (eg with <kbd>.ENDNOTE
5525 OFF</kbd>) must begin at the left margin.
5526 </p>
5527
5528 <p>
5529 (Should you wish to revert to mom&#8217;s default behaviour of
5530 placing a superscript number in the text to identify an endnote,
5531 you can invoke <kbd>.ENDNOTE_MARKER_STYLE</kbd> with the argument,
5532 <kbd>NUMBER</kbd>.  It is not advisable to switch marker styles
5533 within a single document, for aesthetic reasons, but there is
5534 nothing to prevent you from doing so.)
5535 </p>
5536
5537 <p id="en-mark">
5538 If you want a range of line numbers (eg&nbsp;[5-11]&nbsp;),
5539 insert, directly into the first line of the range you want, the
5540 <a href="definitions.html#inlines">inline escape</a>,
5541 <kbd>\*[EN-MARK]</kbd>.  For the terminating line number of the
5542 range, you need only invoke <kbd>.ENDNOTE</kbd> (again, without the
5543 terminating <kbd>\c</kbd>).  Mom is smart enough to figure out that
5544 where <kbd>.ENDNOTE</kbd> is invoked represents the terminating line
5545 number.
5546 </p>
5547
5548 <div id="endnote-linenumbers-note" class="box-tip">
5549 <p class="tip-top">
5550 <span class="note">Note:</span>
5551 By default, mom reserves a fixed amount of space, equal to 8
5552 placeholders, for the linenumbers of linenumbered endnotes.  Within
5553 that space, the numbers are flush right with each other.  The
5554 reserved space is enough to print a range of linenumbers of the form
5555 <kbd>[nnnn-nnnn]</kbd>, but may be more than you need.
5556 </p>
5557
5558 <p>
5559 The goal with linenumbered endnotes is to ensure that the longest
5560 linenumber or range of lines is flush with the left margin of the
5561 page.  Adjusting the reserved space is done with the macro
5562 <a href="docelement.html#endnote-numbers-align">ENDNOTE_NUMBERS_ALIGN</a>,
5563 and the rules for getting it right are simple.
5564 </p>
5565
5566 <p class="tip-bottom">
5567 If your document runs to less than 100 lines, invoke
5568 <br/>
5569 <span class="pre-in-pp">
5570   .ENDNOTE_NUMBERS_ALIGN RIGHT 0
5571 </span>
5572 If your document has between 100 and 999 lines
5573 <br/>
5574 <span class="pre-in-pp">
5575   .ENDNOTE_NUMBERS_ALIGN RIGHT 1
5576 </span>
5577 If your document has between 1000 and 9999 lines
5578 <br/>
5579 <span class="pre-in-pp">
5580   .ENDNOTE_NUMBERS_ALIGN RIGHT 2
5581 </span>
5582 etc.
5583 </p>
5584 </div>
5585
5586 <p id="number" style="margin-top: -.5em;">
5587 <span style="display: block; margin-bottom: .25em;">&bull;&nbsp;<i>Argument:</i> <kbd>NUMBER</kbd></span>
5588 With the argument <kbd>NUMBER</kbd>, mom places superscript numbers
5589 in running text, but identifies endnotes in the endnotes section
5590 of your document with normal-sized, base-aligned numbers.
5591 </p>
5592
5593 <p id="superscript" style="margin-top: -.5em;">
5594 <span style="display: block; margin-bottom: .25em;">&bull;&nbsp;<i>Argument:</i> <kbd>SUPERSCRIPT</kbd></span>
5595 With the argument <kbd>SUPERSCRIPT</kbd>, mom places superscript
5596 numbers in running text, and identifies endnotes in the endnotes
5597 section of your document with superscript numbers as well.  This is
5598 mom&#8217;s default.
5599 </p>
5600
5601 <div id="endnote-superscript-note" class="box-tip">
5602 <p class="tip-top">
5603 <span class="note">Note:</span>
5604 By default, mom reserves a fixed amount of space, equal to 2
5605 placeholders, for the superscript numbers identifying endnotes in
5606 the endnotes section of your document.  Within that space, the
5607 numbers are flush right with each other.
5608 </p>
5609
5610 <p class="tip-bottom">
5611 If you need less space (the total number of endnotes is less than 10) or
5612 more (the total number of endnotes is greater than 99), use the
5613 macro,
5614 <a href="docelement.html#endnote-numbers-align">ENDNOTE_NUMBERS_ALIGN</a>,
5615 to set the desired amount of reserved space, eg
5616 <br/>
5617 <span class="pre-in-pp">
5618   .ENDNOTE_NUMBERS_ALIGN RIGHT 1
5619 </span>
5620 or
5621 <br/>
5622 <span class="pre-in-pp">
5623   .ENDNOTE_NUMBERS_ALIGN RIGHT 3
5624 </span>
5625 </p>
5626 </div>
5627
5628 <h5 id="endnote-linenumber-gap" class="docs" style="margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Spacing between line-numbered endnotes and the endnote text</h5>
5629
5630 <div class="box-macro-args">
5631 Macro: <b>ENDNOTE_LINENUMBER_GAP</b> <kbd class="macro-args">&lt;size of gap&gt;</kbd>
5632 </div>
5633
5634 <p class="requires">
5635 &bull;&nbsp;Requires a <a href="definitions.html#unitofmeasure">unit of measure</a>
5636 </p>
5637
5638 <p>
5639 When your
5640 <a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
5641 is <kbd>LINE</kbd>, mom, by default, inserts a space equal to
5642 1/2-<a href="definitions.html#em">en</a>
5643 between the linenumber and the text of an endnote.  For aesthetic reasons, you may want
5644 to change the size of the gap, which is done with the macro,
5645 ENDNOTE_LINENUMBER_GAP.
5646 </p>
5647
5648 <p>
5649 ENDNOTE_LINENUMBER_GAP takes as its single argument the size
5650 of the gap.  The argument requires a
5651 <a href="definitions.html#unitofmeasure">unit of measure</a>,
5652 so, for example, to change the gap to 2
5653 <a href="definitions.html#picaspoints">picas</a>,
5654 you&#8217;d do
5655 <br/>
5656 <span class="pre-in-pp">
5657   .ENDNOTE_LINENUMBER_GAP 2P
5658 </span>
5659 </p>
5660
5661 <h5 id="endnote-linenumber-brackets" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Brackets around endnote line numbers</h5>
5662
5663 <div class="box-macro-args">
5664 Macro: <b>ENDNOTE_LINENUMBER_BRACKETS</b> <kbd class="macro-args">PARENS | SQUARE | BRACES | ( | [ | {</kbd>
5665 </div>
5666
5667 <p>
5668 By default, mom puts endnote line numbers inside square brackets.
5669 The style of the brackets may be changed with the macro,
5670 ENDNOTE_LINENUMBER_BRACKETS, which takes one of three possible
5671 arguments: <kbd>PARENS</kbd> (&#8220;round&#8221; brackets),
5672 <kbd>SQUARE</kbd> (the default) or <kbd>BRACES</kbd> (curly braces).
5673 If you prefer a shortform, the arguments, <kbd>(</kbd>, <kbd>[</kbd>
5674 or <kbd>{</kbd> may be used instead.
5675 </p>
5676
5677 <h5 id="endnote-linenumber-separator" class="docs" style="margin-top: -.5em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Separator after endnote line numbers instead of brackets</h5>
5678
5679 <div class="box-macro-args">
5680 Macro: <b>ENDNOTE_LINENUMBER_SEPARATOR</b> <kbd class="macro-args">&lt;character&gt;</kbd>
5681 </div>
5682
5683 <p>
5684 If you don&#8217;t want the numbers enclosed in brackets, you may tell
5685 mom to use a separator instead.  A common
5686 separator would be the colon, but it can be anything you like.
5687 </p>
5688
5689 <p>
5690 ENDNOTE_LINENUMBER_SEPARATOR takes as its single argument the
5691 separator you want.  (If the argument contains spaces, don&#8217;t
5692 forget to enclose the argument in double-quotes.)  The separator
5693 can be composed of any valid groff character, or any combination of
5694 characters.  For example, to get a colon separator after the line
5695 number in line-numbered endnotes, you&#8217;d do
5696 <br/>
5697 <span class="pre-in-pp">
5698   .ENDNOTE_LINENUMBER_SEPARATOR :
5699 </span>
5700 </p>
5701
5702 <h5 id="endnote-number-control" class="docs" style="margin-top: -1em; margin-bottom: .5em; margin-left: .5em;">&bull;&nbsp;Endnote numbering style control</h5>
5703
5704 <div class="defaults-container" style="padding-bottom: 8px;">
5705 <p class="defaults" style="padding-top: 6px;">
5706 See
5707 <a href="#control-macro-args">Arguments to the control macros</a>.
5708 </p>
5709
5710 <p class="defaults">
5711 Please note that the control macros for endnote numbering affect only
5712 the numbers that appear on the endnotes pages themselves, not the
5713 endnote numbers that appear in the body of a document.
5714 </p>
5715 <span class="pre defaults">
5716 Numbered endnotes
5717 .ENDNOTE_NUMBER_FAMILY default = prevailing document family; default Times Roman
5718 .ENDNOTE_NUMBER_FONT   default = bold
5719 .ENDNOTE_NUMBER_SIZE*  default = 0
5720 Linenumbered endnotes
5721 .ENDNOTE_LINENUMBER_FAMILY default = prevailing document family; default Times Roman
5722 .ENDNOTE_LINENUMBER_FONT   default = bold
5723 .ENDNOTE_LINENUMBER_SIZE*  default = 0
5724
5725 *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
5726 </span>
5727 </div>
5728
5729 <h5 id="endnote-number-alignment" class="docs" style="margin-top: -1.25em; margin-bottom: -.5em; margin-left: .5em;">&bull;&nbsp;Endnote numbering alignment</h5>
5730
5731 <p style="margin-top: .75em;">
5732 By default, when your
5733 <a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
5734 is <kbd>NUMBER</kbd>, mom hangs the numbers on endnotes pages,
5735 aligned right to two placeholders, producing this:
5736 <br/>
5737 <span id="endnote-numbering-alignment-example" class="pre-in-pp">
5738    9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
5739       sed diam nonumy eirmod tempor invidunt ut labore et
5740       dolore magna aliquyam erat, sed diam voluptua.
5741
5742   10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
5743       sed diam nonumy eirmod tempor invidunt ut labore et
5744       dolore magna aliquyam erat, sed diam voluptua.
5745 </span>
5746 If you wish to change either the alignment or the number of
5747 placeholders, the macro to use is ENDNOTE_NUMBERS_ALIGN.
5748 </p>
5749
5750 <!-- -ENDNOTE_NUMBERS_ALIGN- -->
5751
5752 <div id="endnote-numbers-align" class="box-macro-args">
5753 Macro: <b>ENDNOTE_NUMBERS_ALIGN</b> <kbd class="macro-args">LEFT | RIGHT &lt;number of placeholders&gt;</kbd>
5754 </div>
5755
5756 <p>
5757 ENDNOTE_NUMBERS_ALIGN determines how endnote numbers are aligned.  If you invoke
5758 <br/>
5759 <span class="pre-in-pp">
5760   .ENDNOTE_NUMBERS_ALIGN RIGHT 2
5761 </span>
5762 the periods (dots) after the numbers will align, like this
5763 <span class="pre-in-pp">
5764    9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
5765       sed diam nonumy eirmod tempor invidunt ut labore et
5766       dolore magna aliquyam erat, sed diam voluptua.
5767
5768   10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
5769       sed diam nonumy eirmod tempor invidunt ut labore et
5770       dolore magna aliquyam erat, sed diam voluptua.
5771 </span>
5772 If you invoke
5773 <span class="pre-in-pp">
5774   .ENDNOTE_NUMBERS_ALIGN LEFT 2
5775 </span>
5776 the first digits of the numbers will line up flush left, like this
5777 <span class="pre-in-pp">
5778   9.  Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
5779       sed diam nonumy eirmod tempor invidunt ut labore et
5780       dolore magna aliquyam erat, sed diam voluptua.
5781
5782   10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
5783       sed diam nonumy eirmod tempor invidunt ut labore et
5784       dolore magna aliquyam erat, sed diam voluptua.
5785 </span>
5786 The argument <kbd>&lt;number of placeholders&gt;</kbd> represents
5787 the maximum size of the numbers, expressed as the number of
5788 digits in the largest number.  Numbers in the range 0-9 require
5789 1 placeholder; in the range 10-99, 2 placeholders; in the range
5790 100-999 3 placeholders, and so on.
5791 </p>
5792
5793 <p>
5794 Therefore, if you have fewer than ten endnotes,
5795 <br/>
5796 <span class="pre-in-pp">
5797   .ENDNOTE_NUMBERS_ALIGN RIGHT 1
5798 </span>
5799 would ensure proper right alignment of endnote numbers.
5800 </p>
5801
5802 <p>
5803 Mom&#8217;s default for endnote number alignment is to align the
5804 numbers right to two placeholders.
5805 </p>
5806
5807 <div class="box-tip">
5808 <p class="tip">
5809 <span class="note">Note:</span>
5810 ENDNOTE_NUMBERS_ALIGN can also be used to establish the alignment
5811 and number of placeholders when your
5812 <a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
5813 is <kbd>SUPERSCRIPT</kbd>.  Furthermore, it can be used to establish
5814 the number of placeholders to reserve when your ENDNOTE_MARKER_STYLE
5815 is <kbd>LINE</kbd>, even though, in such an instance, the numbers
5816 themselves are always aligned right.  See
5817 <a href="#endnote-linenumbers-note">here</a>
5818 for examples.
5819 </p>
5820 </div>
5821
5822 <div class="rule-short"><hr/></div>
5823
5824 <!-- ==================================================================== -->
5825
5826 <h2 id="margin-notes-intro" class="macro-group">Margin notes</h2>
5827
5828 <ul style="margin-left: -.5em;">
5829   <li><a href="#margin-notes-behaviour">Margin notes behaviour</a>
5830   <ul style="margin-left: -.5em;">
5831     <li><a href="#margin-notes-vertical">Adjusting the vertical position of margin notes</a></li>
5832   </ul></li>
5833   <li><a href="#mn-init">Macro: <b>MN_INIT</b></a> &ndash; set margin notes parameters</li>
5834   <li><a href="#mn">Tag: MN</a></li>
5835 </ul>
5836
5837 <p>
5838 Margin notes are short annotations that appear in either the left
5839 or right margin of a document.  Sometimes they comment on the text.
5840 Sometimes they assist in following the &#8220;flow&#8221; of a
5841 document by summarizing the subject of a portion of text.  Sometimes
5842 they&#8217;re comments to yourself in a draft copy.
5843 </p>
5844
5845 <p>
5846 The margin notes macros and routines in om.tmac (mom) are
5847 &#8220;mommified&#8221; versions of the margin notes macros and
5848 routines written by Werner Lemberg and patched by Gaius Mulley.
5849 </p>
5850
5851 <h3 id="margin-notes-behaviour" class="docs">Margin notes behaviour</h3>
5852
5853 <p>
5854 First things first: before you enter your first margin note, you
5855 must &#8220;initialize&#8221; margin notes with
5856 <a href="#mn-init">MN_INIT</a>.
5857 MN_INIT sets up the style parameters for margin notes, including
5858 things like
5859 <a href="definitions.html#font">font</a>,
5860 <a href="definitions.html#family">family</a>
5861 and
5862 <a href="definitions.html#leading">leading</a>.
5863 MN_INIT may be called before or after
5864 <a href="docprocessing.html#start">START</a>.
5865 </p>
5866
5867 <p>
5868 After initializing margin notes, you create margin notes with the
5869 <a href="#mn">MN</a>
5870 macro.  Based on the argument you pass MN, your margin note will go
5871 in either the left or the right margin.
5872 </p>
5873
5874 <p>
5875 Margin notes are tricky from a typographic standpoint with respect
5876 to vertical placement.  Since the leading of margin notes may differ
5877 from that of
5878 <a href="definitions.html#running">running text</a>,
5879 it&#8217;s impossible for mom to guess whether to align
5880 the first lines of margin notes with a document
5881 <a href="definitions.html#baseline">baseline</a>,
5882 whether to align the last lines of margin notes with a document
5883 baseline, or whether to center them, vertically, so that neither
5884 first nor last line aligns with anything!
5885 </p>
5886
5887 <p>
5888 Given this difficulty, mom always aligns the first line of any
5889 margin note with a document baseline.  If you want a different
5890 behaviour, you must adjust the position(s) of margin notes yourself,
5891 on a note by note basis.  (See
5892 <a href="#margin-notes-vertical">Adjusting the vertical position of margin notes</a>.)
5893 </p>
5894
5895 <p>
5896 Generally speaking, mom tries to place margin notes at the point
5897 where you invoke
5898 <a href="#mn">MN</a>.
5899 However, in the event that a margin note runs deep, she may not be
5900 able to place a subsequent margin note exactly where you want.  In
5901 such an instance, mom will &#8220;shift&#8221; the margin note down
5902 on the page, placing it one (margin note) linespace beneath the
5903 previous margin note (plus whatever vertical space is required to
5904 get the first line to line up with a baseline of running text).  A
5905 warning will be issued, letting you know this has happened, and
5906 where.
5907 </p>
5908
5909 <p>
5910 Sometimes, if a margin note has to be shifted down, there simply
5911 isn&#8217;t enough room to start the margin note on the page on
5912 which <kbd>.MN</kbd> is invoked.  In that case, mom ignores the
5913 margin note entirely and issues a warning, letting you know what
5914 she&#8217;s done, and where. </p>
5915
5916 <p>
5917 In the event that a margin note, sucessfully begun on a page, runs
5918 past your bottom margin (or the last line before footnotes begin),
5919 the margin note will &#8220;flow&#8221; onto the next page.  If
5920 it is a &#8220;left&#8221; margin note, it will continue in the
5921 left margin.  If it is a &#8220;right&#8221; margin note, it will
5922 continue in the right margin.
5923 </p>
5924
5925 <p>
5926 If your document is being set in two columns, mom will sensibly and
5927 automatically set all margin notes pertaining to the left column in
5928 the left margin, and all margin notes pertaining to the right column
5929 in the right margin, regardless of the &#8220;direction&#8221;
5930 argument you give the MN tag.  If you try to use MN in documents of
5931 more than two columns, mom will ignore all margin notes, and issue
5932 a warning for each.
5933 </p>
5934
5935 <h3 id="margin-notes-vertical" class="docs">Adjusting the vertical position of margin notes</h3>
5936
5937 <p>
5938 When the
5939 <a href="definitions.html#term-leading">leading</a>
5940 of margin notes differs from the leading used throughout a document,
5941 you may want to adjust the vertical position of individual margin
5942 notes.  This is most often going to be the case with margin notes
5943 that end near the bottom of the page, where you want the last line
5944 of the margin note to line up with the last line of text on the
5945 page.
5946 </p>
5947
5948 <p>
5949 Adjustments to the vertical position of margin notes must be done
5950 inside the margin note (ie after <kbd>.MN</kbd>), at the top,
5951 before entering text.  The commands to use are
5952 <kbd>\!<a href="typesetting.html#ald">.ALD</a></kbd>
5953 (to lower the margin note) and
5954 <kbd>\!<a href="typesetting.html#rld">.RLD</a></kbd>
5955 (to raise it).
5956
5957 The <kbd>\!</kbd> must precede the macros, or they
5958 won&#8217;t have any effect.
5959 </p>
5960
5961 <!-- -MN_INIT- -->
5962
5963 <div class="macro-id-overline">
5964 <h3 id="mn-init" class="macro-id">MN_INIT</h3>
5965 </div>
5966
5967 <div class="box-macro-args">
5968 Macro: <b>MN_INIT</b> <kbd class="macro-args">&lt;arguments&gt; (see list)</kbd>
5969 </div>
5970
5971 <h4 style="margin-top: .75em; margin-left: .5em; font-style: normal; font-weight: bold: font-size: 105%; color: #6f614a;">Argument list:</h4>
5972
5973 <span class="pre" style="margin-top: -1.5em; margin-left: .5em;">
5974 RAGGED | SYMMETRIC
5975 &lt;L_WIDTH&gt;   &lt;value&gt;
5976 &lt;R_WIDTH&gt;   &lt;value&gt;
5977 &lt;GUTTER&gt;    &lt;value&gt;
5978 &lt;FONTSTYLE&gt; &lt;value&gt;
5979 &lt;SIZE&gt;      &lt;value&gt;
5980 &lt;LEAD&gt;      &lt;value&gt;
5981 &lt;COLOR&gt;     &lt;value&gt;
5982 &lt;HY&gt;        &lt;value&gt;
5983 </span>
5984
5985 <p style="margin-top: 1.25em;">
5986 Before you enter your first margin note, you must initialize
5987 the style parameters associated with margin notes using MN_INIT.
5988 If you forget to do so, mom will issue a warning and abort.
5989 </p>
5990
5991 <p>
5992 The arguments may be entered in any order, and since the list is
5993 long, use of the backslash character ( <kbd>\</kbd> ) to put each on
5994 a separate line is recommended, eg.
5995 <br/>
5996 <span class="pre-in-pp">
5997   .MN_INIT \
5998   SYMMETRIC \
5999   L_WIDTH 4P \
6000   SIZE 8 \
6001   LEAD 9 \
6002   HY 14
6003 </span>
6004 All arguments are optional, but since mom requires you to run
6005 MN_INIT before entering margin notes, you should, at a minimum, set
6006 the <kbd>RAGGED</kbd> or <kbd>SYMMETRIC</kbd> parameter.
6007 You will almost certainly want to set <kbd>L_WIDTH</kbd>, <kbd>R_WIDTH</kbd>,
6008 <kbd>SIZE</kbd> and <kbd>LEAD</kbd> as well.
6009 </p>
6010
6011 <h4 class="docs arg-list"><kbd>RAGGED | SYMMETRIC</kbd></h4>
6012
6013 <p>
6014 If the argument <kbd>RAGGED</kbd> is given, both left and
6015 right margin notes will be flush left.  If the argument
6016 <kbd>SYMMETRIC</kbd> is given, left margin notes will be set flush
6017 <i>right</i>, and right margin notes flush <i>left</i>.  The effect
6018 is something like this:
6019 <br/>
6020 <span class="pre-in-pp">
6021          A left    This is a meaningless batch        A right
6022     margin note    of text whose sole purpose is      margin note
6023       with just    to demonstrate how the sym-        with just
6024     a few words    metric argument to MN sets left    a few words
6025          in it.    and right margin notes.            in it.
6026 </span>
6027 </p>
6028
6029 <p>
6030 If the argument is omitted, both left and right margin notes will
6031 be set justified.  (Justified is usually not a good idea, since the
6032 narrow measure of margin notes makes pleasing justification a near
6033 impossibility.)
6034 </p>
6035
6036 <h4 class="docs arg-list"><kbd>L_WIDTH &lt;value&gt;</kbd></h4>
6037
6038 <p>
6039 The width of left margin notes.  A
6040 <a href="definitions.html#unitofmeasure">unit of measure</a>
6041 must be appended directly onto the argument.  The default is to set
6042 left margin notes right out to the edge of the page, which is almost
6043 certainly not what you want, so you should give a value for this
6044 argument if using left margin notes.
6045 </p>
6046
6047 <h4 class="docs arg-list"><kbd>R_WIDTH &lt;value&gt;</kbd></h4>
6048
6049 <p>
6050 The width of right margin notes.  A
6051 <a href="definitions.html#unitofmeasure">unit of measure</a>
6052 must be appended directly onto the argument.  The default is to
6053 set right margin notes right out to the edge of the page, which is
6054 almost certainly not what you want, so you should give a value for
6055 this argument if using right margin notes.
6056 </p>
6057
6058 <h4 class="docs arg-list"><kbd>GUTTER &lt;value&gt;</kbd></h4>
6059
6060 <p>
6061 The
6062 <a href="definitions.html#gutter">gutter</a>
6063 between margin notes and
6064 <a href="definitions.html#running">running text</a>.
6065 A
6066 <a href="definitions.html#unitofmeasure">unit of measure</a>
6067 must be appended directly onto the argument.  The gutter applies to
6068 both left and right margin notes. The default is 1
6069 <a href="definitions.html#em">em</a>.
6070 </p>
6071
6072 <h4 class="docs arg-list"><kbd>FONTSTYLE &lt;value&gt;</kbd></h4>
6073
6074 <p>
6075 The family+font for margin notes.  Yes, that&#8217;s right: the
6076 family <i>plus</i> font combo.  For example, if you want Times
6077 Roman Medium, the argument must be <kbd>TR</kbd>.  If you want Palatino
6078 Medium Italic, the argument must be <kbd>PI</kbd>.  The default is the same
6079 family+font combo used for a document&#8217;s paragraph text.
6080 </p>
6081
6082 <h4 class="docs arg-list"><kbd>SIZE &lt;value&gt;</kbd></h4>
6083
6084 <p>
6085 The point size of type for margin notes.  There is no need to append a
6086 <a href="definitions.html#unitofmeasure">unit of measure</a>
6087 to the argument;
6088 <a href="definitions.html#picaspoints">points</a>
6089 is assumed (although there&#8217;s nothing preventing you from
6090 appending an alternative unit of measure directly to the argument).
6091 The default is for margin notes to use the same point size of type
6092 as is used in document paragraphs.
6093 </p>
6094
6095 <h4 class="docs arg-list"><kbd>LEAD &lt;value&gt;</kbd></h4>
6096
6097 <p>
6098 The
6099 <a href="definitions.html#leading">leading</a>
6100 of margin notes.  <kbd>&lt;LEAD&gt;</kbd> takes
6101 <a href="definitions.html#picaspoints">points</a>
6102 as its unit of measure, so don&#8217;t tack a unit of measure onto
6103 the end of the argument.  The default lead is the same as paragraph
6104 text (ie the document&#8217;s base leading).
6105 </p>
6106
6107 <h4 class="docs arg-list"><kbd>COLOR &lt;value&gt;</kbd></h4>
6108
6109 <p>
6110 The colour of margin notes.  The colour must be pre-initialized
6111 with
6112 <a href="color.html#newcolor">NEWCOLOR</a>
6113 or
6114 <a href="color.html#xcolor">XCOLOR</a>.
6115 The default is black.
6116 </p>
6117
6118 <h4 class="docs arg-list"><kbd>HY &lt;value&gt;</kbd></h4>
6119
6120 <p>
6121 <kbd>&lt;value&gt;</kbd> is a digit telling groff how you want margin
6122 notes hyphenated.
6123 <br/>
6124 <span class="pre-in-pp">
6125   0 = do not hyphenate
6126   1 = hyphenate without restrictions
6127   2 = do not hyphenate the last word on the page
6128   4 = do not hyphenate the last two characters of a word
6129   8 = do not hyphenate the first two characters of a word
6130 </span>
6131 The values can be added together, so, for example, if you want
6132 neither the first two nor the last two characters of words
6133 hyphenated, the hyphenation-flag would be 12.  The default value is
6134 14 (ie 2+4+8).
6135 </p>
6136
6137 <!-- -MN- -->
6138
6139 <div class="macro-id-overline">
6140 <h3 id="mn" class="macro-id">MN</h3>
6141 </div>
6142
6143 <div class="box-macro-args">
6144 Macro: <b>MN</b> <kbd class="macro-args">LEFT | RIGHT</kbd>
6145 </div>
6146
6147 <p>
6148 Once you&#8217;ve initialized margin notes with
6149 <kbd><a href="#mn-init">.MN_INIT</a></kbd>,
6150 you can enter margin notes any time you like with <kbd>.MN</kbd>.
6151 An argument of <kbd>LEFT</kbd> will set a left margin note.  An
6152 argument of <kbd>RIGHT</kbd> will set a right margin note.
6153 </p>
6154
6155 <p>
6156 Any argument, such as <kbd>OFF</kbd> (or <kbd>QUIT, END, X</kbd>,
6157 etc) exits the current margin note.
6158 </p>
6159
6160 <div class="rule-short"><hr/></div>
6161
6162 <!-- ==================================================================== -->
6163
6164 <!-- -FINIS- -->
6165
6166 <h2 id="finis-intro" class="macro-group">Document termination string</h2>
6167
6168 <ul style="margin-left: -.5em;">
6169   <li><a href="#finis">Tag: FINIS</a></li>
6170   <li>FINIS control macros
6171   <ul style="margin-left: -1.25em;">
6172     <li><a href="#finis-string">Changing the FINIS string</a></li>
6173     <li><a href="#finis-string-caps">Automatic capitalization of the FINIS string</a></li>
6174     <li><a href="#finis-color">Changing the FINIS colour</a></li>
6175   </ul></li>
6176 </ul>
6177
6178 <p>
6179 The use of FINIS is optional.  If you invoke it at the end of a
6180 document (before
6181 <kbd><a href="#endnotes">.ENDNOTES</a></kbd>,
6182 <kbd><a href="refer.html#bibliography">.BIBLIOGRAPHY</a></kbd>
6183 or
6184 <kbd><a href="tables-of-contents.html#toc">.TOC</a></kbd>)
6185 mom deposits the word, <b>END</b>, centred after a blank line,
6186 beneath the last line of the document. <b>END</b> is enclosed
6187 between
6188 <a href="definitions.html#em">em-dashes</a>,
6189 like this:
6190 <br/>
6191 <span class="pre-in-pp">
6192   ...and they all lived happily ever after.
6193
6194                   &mdash; END &mdash;
6195 </span>
6196 If there is insufficient room for FINIS on the last page of a
6197 document, mom will alert you on stderr.
6198 </p>
6199
6200 <p>
6201 If you&#8217;re writing in a language other than English, you can
6202 change what mom prints for END with the control macro,
6203 <a href="#finis-string">FINIS_STRING</a>.
6204 </p>
6205
6206 <div class="macro-id-overline">
6207 <h3 id="finis" class="macro-id">FINIS</h3>
6208 </div>
6209
6210 <div class="box-macro-args">
6211 Macro: <b>FINIS</b>
6212 </div>
6213
6214 <p>
6215 The use of FINIS is optional, but if you use it, it should be the
6216 last macro you invoke in a document before
6217 <kbd><a href="#endnotes">.ENDNOTES</a></kbd>,
6218 <kbd><a href="refer.html#bibliography">.BIBLIOGRAPHY</a></kbd>
6219 or
6220 <kbd><a href="tables-of-contents.html#toc">.TOC</a></kbd>.
6221 See
6222 <a href="#finis-intro">above</a>
6223 for a description of how FINIS behaves.
6224 </p>
6225
6226 <div class="box-tip">
6227 <p class="tip">
6228 <span class="note">Note:</span>
6229 If you don&#8217;t use FINIS, and you don&#8217;t want
6230 <a href="definitions.html#footer">footers</a>
6231 (if they&#8217;re on) or a page number at the bottom of the last
6232 page of a document, you have to turn them off manually, as the last
6233 two lines of your document file, like this:
6234 <br/>
6235 <span class="pre-in-pp">
6236   .FOOTERS OFF
6237   .PAGINATE OFF
6238 </span>
6239 </p>
6240 </div>
6241
6242 <!-- -FINIS STRING- -->
6243
6244 <h3 id="finis-control" class="docs" style="margin-bottom: -1em">Finis contol macros</h3>
6245
6246 <h4 id="finis-string" class="docs">Changing the FINIS string</h4>
6247
6248 <p>
6249 By default, FINIS prints the word, END, between
6250 <a href="definitions.html#em">em-dashes</a>.
6251 If you&#8217;d like mom to print something else between the dashes,
6252 use the FINIS_STRING macro (anywhere in the document prior to
6253 FINIS).
6254 </p>
6255
6256 <p>
6257 For example, if your document&#8217;s in French, you&#8217;d do
6258 <br/>
6259 <span class="pre-in-pp">
6260     .FINIS_STRING "FIN"
6261 </span>
6262 Double-quotes must enclose the macro&#8217;s argument.
6263 </p>
6264
6265 <div class="box-tip">
6266 <p class="tip">
6267 <span class="note">Note:</span>
6268 If you pass FINIS_STRING a blank string, ie
6269 <br/>
6270 <span class="pre-in-pp">
6271     .FINIS_STRING ""
6272 </span>
6273 mom will still print the em-dashes when you invoke
6274 <kbd>.FINIS</kbd>.  This, in effect, produces a short, centred
6275 horizontal rule that terminates the document.  (In
6276 <a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>,
6277 it&#8217;s a short, dashed line composed of four hyphens.)
6278 </p>
6279 </div>
6280
6281 <!-- -FINIS STRING CAPS- -->
6282
6283 <h4 id="finis-string-caps" class="docs">Automatic capitalization of the FINIS string</h4>
6284
6285 <p>
6286 By default, mom sets the string you pass to FINIS all-caps.
6287 If you&#8217;d prefer that she not do so, but rather respect
6288 the FINIS string exactly as you enter it, invoke the macro,
6289 <kbd>.FINIS_STRING_CAPS</kbd> with the <kbd>OFF</kbd> argument, like
6290 this:
6291 <br/>
6292 <span class="pre-in-pp">
6293     .FINIS_STRING_CAPS OFF
6294 </span>
6295 <kbd>OFF</kbd>, above, could be anything, eg <kbd>NO</kbd> or
6296 <kbd>X</kbd>.
6297 </p>
6298
6299 <!-- -FINIS COLOR- -->
6300
6301 <h4 id="finis-color" class="docs">Changing the FINIS colour</h4>
6302
6303 <p>
6304 Invoking the control macro, <kbd>.FINIS_COLOR</kbd>, with a
6305 pre-defined (or &#8220;initalized&#8221;) colour changes the colour
6306 of both the FINIS string and the em-dashes that surround it.  If you
6307 use the
6308 <a href="definitions.html#inline">inline escape</a>,
6309 <a href="color.html#color-inline"><kbd>\*[&lt;colourname&gt;]</kbd></a>,
6310 in the argument passed to FINIS, only the text will be in the
6311 new colour; the em-dashes will be in the default document colour
6312 (usually black).
6313 </p>
6314
6315 <div class="rule-long"><hr/></div>
6316
6317 <!-- Navigation links -->
6318 <table style="width: 100%; margin-top: 12px;">
6319 <tr>
6320   <td style="width: 33%;"><a href="toc.html">Back to Table of Contents</a></td>
6321   <td style="width: 33%; text-align: center;"><a href="#top">Top</a></td>
6322   <td style="width: 33%; text-align: right;"><a href="images.html#top">Next: Graphics, floats, and preprocessor support</a></td>
6323 </tr>
6324 </table>
6325
6326 </div>
6327
6328 <div class="bottom-spacer"><br/></div>
6329
6330 </body>
6331 </html>
6332 <!-- vim: fileencoding=utf-8: nomodified: -->