contrib/mom/momdoc/docprocessing.html

   1 <html>
   2 <head>
   3 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
   4 <title>Mom -- Document Processing, Introduction and Setup</title>
   5 </head>
   6 <body bgcolor="#dfdfdf">
   7
   8 <!====================================================================>
   9
  10 <a href="docelement.html#TOP">Next</a>&nbsp;&nbsp;
  11 <a href="inlines.html#TOP">Prev</a>&nbsp;&nbsp;
  12 <a href="toc.html">Back to Table of Contents</a>
  13
  14 <a name="TOP"></a>
  15 <a name="DOCPROCESSING">
  16         <h1 align="center"><u>DOCUMENT PROCESSING WITH MOM</u>
  17 </h1>
  18 </a>
  19
  20 <a href="#INTRO_MACROS_DOCPROCESSING">Introduction to document processing</a>
  21 <br>
  22 <a href="#DEFAULTS">Some document defaults</a>
  23 <p>
  24 <a href="#LEADING_NOTE">* IMPORTANT NOTE on leading/spacing and bottom margins *</a>
  25 <p>
  26 <ul>
  27         <li><strong>DOCUMENT SETUP</strong>
  28         <br>
  29         <a href="#DOCPROCESSING_TUT">Tutorial -- Setting up a mom document</a>
  30         <br>
  31         <ul>
  32                 <li><a href="#REFERENCE_MACROS"><strong>The Reference Macros</strong></a>
  33                 <ul>
  34                         <li><a href="#TITLE">TITLE</a>
  35                         <li><a href="#SUBTITLE">SUBTITLE</a>
  36                         <li><a href="#AUTHOR">AUTHOR</a>
  37                         <li><a href="#CHAPTER">CHAPTER</a>
  38                         <li><a href="#DRAFT">DRAFT</a>
  39                         <li><a href="#REVISION">REVISION</a>
  40                 </ul>
  41                 <li><a href="#DOCSTYLE_MACROS"><strong>The Docstyle Macros</strong></a>
  42                 <ul>
  43                         <li><a href="#DOCTYPE">DOCTYPE</a>
  44                         <li><a href="#PRINTSTYLE">PRINTSTYLE</a>
  45                         <li><a href="#COPYSTYLE">COPYSTYLE</a>
  46                 </ul>
  47
  48                 <li><a href="#STYLE_BEFORE_START"><strong>Changing type/style parameters prior to START</strong></a>
  49                 <ul>
  50                         <li><a href="#TYPE_BEFORE_START">Using typesetting macros prior to START</a>
  51                         <li><a href="#DOC_LEAD_ADJUST">Adjusting document leading to fill pages -- DOC_LEAD_ADJUST</a>
  52                         <li><a href="#DOCHEADER">Managing the document header</a>
  53                         <ul>
  54                                 <li><a href="#DOCHEADER">DOCHEADER -- turning docheaders off</a>
  55                                 <li><a href="#DOCHEADER_CONTROL">Docheader control</a>
  56                         </ul>
  57                 </ul>
  58
  59                 <li><a href="#COLUMNS_INTRO"><strong>Setting documents in columns</strong></a>
  60                 <ul>
  61                         <li><a href="#COLUMNS">COLUMNS</a>
  62                         <li><a href="#COL_NEXT">COL_NEXT</a>
  63                         <li><a href="#COL_BREAK">COL_BREAK</a>
  64
  65                 </ul>
  66
  67                 <li><a href="#START_MACRO"><strong>START</strong> -- the macro to initiate document processing</a>
  68                 <ul>
  69                         <li><a href="#START">START</a>
  70                 </ul>
  71
  72                 <li><a href="#DOC_PARAM_MACROS"><strong>Changing document-wide typesetting parameters after START</strong></a>
  73                 <ul>
  74                         <li><a href="#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a>
  75                         <li><a href="#DOC_RIGHT_MARGIN">DOC_RIGHT_MARGIN</a>
  76                         <li><a href="#DOC_LINE_LENGTH">DOC_LINE_LENGTH</a>
  77                         <li><a href="#DOC_FAMILY">DOC_FAMILY</a>
  78                         <li><a href="#DOC_PT_SIZE">DOC_PT_SIZE</a>
  79                         <li><a href="#DOC_LEAD">DOC_LEAD</a>
  80                         <li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
  81                         <li><a href="#DOC_QUAD">DOC_QUAD</a>
  82                 </ul>
  83                 <br>
  84                 <li><strong>THE DOCUMENT ELEMENT MACROS (TAGS)</strong>
  85                 <ul>
  86                         <li><a href="docelement.html#DOCELEMENT_INTRO">Introduction to the document element tags</a>
  87                         <ul>
  88                                 <li><a href="docelement.html#DOCELEMENT_CONTROL">Document element (tag) control macros</a>
  89                         </ul>
  90                         <li><a href="docelement.html#EPIGRAPH_INTRO"><strong>Epigraphs</strong></a>
  91                         <ul>
  92                                 <li><a href="docelement.html#EPIGRAPH">EPIGRAPH</a>
  93                                 <li><a href="docelement.html#EPIGRAPH_CONTROL">Epigrah control</a>
  94                         </ul>
  95                         <li><a href="docelement.html#PP_INTRO"><strong>Paragraphs</strong></a>
  96                         <ul>
  97                                 <li><a href="docelement.html#PP">PP</a>
  98                                 <li><a href="docelement.html#PP_CONTROL">Paragraph control</a>
  99                         </ul>
 100                         <li><a href="docelement.html#HEAD_INTRO"><strong>Main heads</strong></a>
 101                         <ul>
 102                                 <li><a href="docelement.html#HEAD">HEAD</a>
 103                                 <li><a href="docelement.html#HEAD_CONTROL">Head control</a>
 104                         </ul>
 105                         <li><a href="docelement.html#SUBHEAD_INTRO"><strong>Subheads</strong></a>
 106                         <ul>
 107                                 <li><a href="docelement.html#SUBHEAD">SUBHEAD</a>
 108                                 <li><a href="docelement.html#SUBHEAD_CONTROL">Subhead control</a>
 109                         </ul>
 110                         <li><a href="docelement.html#PARAHEAD_INTRO"><strong>Paragraph heads</strong></a>
 111                         <ul>
 112                                 <li><a href="docelement.html#PARAHEAD">PARAHEAD</a>
 113                                 <li><a href="docelement.html#PARAHEAD_CONTROL">Parahead control</a>
 114                         </ul>
 115                         <li><a href="docelement.html#LINEBREAK_INTRO"><strong>Linebreaks (author linebreaks)</strong></a>
 116                         <ul>
 117                                 <li><a href="docelement.html#LINEBREAK">LINEBREAK</a>
 118                                 <li><a href="docelement.html#LINEBREAK_CONTROL">Linebreak control</a>
 119                         </ul>
 120                         <li><a href="docelement.html#QUOTE_INTRO"><strong>Quotes (line for line poetic quotes)</strong></a>
 121                         <ul>
 122                                 <li><a href="docelement.html#QUOTE">QUOTE</a>
 123                                 <li><a href="docelement.html#QUOTE_CONTROL">Quote control</a>
 124                         </ul>
 125                         <li><a href="docelement.html#BLOCKQUOTE_INTRO"><strong>Blockquotes (cited material)</strong></a>
 126                         <ul>
 127                                 <li><a href="docelement.html#BLOCKQUOTE">BLOCKQUOTE</a>
 128                                 <li><a href="docelement.html#BLOCKQUOTE_CONTROL">Blockquote control</a>
 129                         </ul>
 130                         <li><a href="docelement.html#FOOTNOTE_INTRO"><strong>Footnotes</strong></a>
 131                         <ul>
 132                                 <li><a href="docelement.html#FOOTNOTE">FOOTNOTE</a>
 133                                 <li><a href="docelement.html#FOOTNOTE_CONTROL">Footnote control</a>
 134                         </ul>
 135                         <li><a href="docelement.html#FINIS_INTRO"><strong>Document termination</strong></a>
 136                         <ul>
 137                                 <li><a href="docelement.html#FINIS">FINIS</a>
 138                                 <li><a href="docelement.html#FINIS_CONTROL">Finis control</a>
 139                         </ul>
 140                 </ul>
 141
 142                 <li><a href="headfootpage.html#HEADFOOTPAGE"><strong>HEADERS and FOOTERS</strong></a>
 143                 <br>
 144                 <ul>
 145                         <li><a href="headfootpage.html#HEADFOOTPAGE_INTRO">Introduction to headers/footers</a>
 146                         <li><a href="headfootpage.html#HEADFOOT_MANAGEMENT">Managing headers/footers</a>
 147                         <ul>
 148                                 <li><a href="headfootpage.html#HEADERS">HEADERS</a> -- on or off
 149                                 <li><a href="headfootpage.html#FOOTERS">FOOTERS</a> -- on or off
 150                                 <li><a href="headfootpage.html#FOOTER_ON_FIRST_PAGE">FOOTER_ON_FIRST_PAGE</a>
 151                         </ul>
 152                         <li><a href="headfootpage.html#HEADFOOT_CONTROL">Header/footer control</a>
 153                         <ul>
 154                                 <li><a href="headfootpage.html#HDRFTR_STRINGS">Header/footer strings</a>
 155                                 <li><a href="headfootpage.html#HDRFTR_STYLE">Header/footer style</a> -- global and part-by-part
 156                                 <li><a href="headfootpage.html#HDRFTR_VERTICAL">Header/footer placement and spacing</a>
 157                                 <li><a href="headfootpage.html#HDRFTR_SEPARATOR">The header/footer separator rule</a>
 158                         </ul>
 159                 </ul>
 160                 <li><a href="headfootpage.html#PAGINATION"><strong>PAGINATION</strong></a>
 161                 <br>
 162                 <ul>
 163                         <li><a href="headfootpage.html#PAGINATE">PAGINATE -- on or off</a>
 164                         <li><a href="headfootpage.html#PAGENUMBER">PAGENUMBER -- user supplied page number</a>
 165                         <li><a href="headfootpage.html#PAGENUM_STYLE">PAGENUM_STYLE -- digits, roman numerals, etc.</a>
 166                         <li><a href="headfootpage.html#PAGINATION_CONTROL">Pagination control</a>
 167                 </ul>
 168                 <br>
 169                 <li><a href="rectoverso.html#RECTOVERSO"><strong>RECTO_VERSO PRINTING and COLLATING</strong></a>
 170                 <br>
 171                 <ul>
 172                         <li><a href="rectoverso.html#RECTOVERSO_INTRO">Introduction to recto/verso</a>
 173                         <ul>
 174                                 <li><a href="rectoverso.html#RECTO_VERSO">RECTO_VERSO</a>
 175                                 <li><a href="rectoverso.html#SWITCH_HDRFTR">SWITCH_HEADERS</a> (also FOOTERS)
 176                         </ul>
 177                         <li><a href="rectoverso.html#COLLATE_INTRO">Introduction to collating</a>
 178                         <ul>
 179                                 <li><a href="rectoverso.html#COLLATE">COLLATE</a>
 180                         </ul>
 181                 </ul>
 182
 183                 <li><a href="cover.html#COVER"><strong>CREATING A COVER PAGE</strong></a>
 184                 <br>
 185                 <li><a href="letters.html#LETTERS"><strong>WRITING LETTERS</strong></a>
 186                 <ul>
 187                         <li><a href="letters.html#LETTERS_INTRO">Introduction to writing letters</a>
 188                         <li><a href="letters.html#TUTORIAL">Tutorial on writing letters</a>
 189                         <li><a href="letters.html#LETTERS_DEFAULTS">Default style for letters</a>
 190                         <li><a href="letters.html#LETTERS_MACROS">The letter macros</a>
 191
 192
 193
 194                 </ul>
 195         </ul>
 196 </ul>
 197 <br>
 198 <hr>
 199
 200 <h2><a name="INTRO_MACROS_DOCPROCESSING"><u>Introduction to document processing</u></a></h2>
 201 <p>
 202 As explained in
 203 <a href="intro.html#INTRO_DOCPROCESSING">Document processing with mom</a>,
 204 document processing uses markup tags to identify document elements
 205 like heads, paragraphs, and so on.  The tags are, of course, macros,
 206 but with sensible, readable names that make them easy to grasp and
 207 easy to remember.  (And don't forget: if you don't like the
 208 &quot;official&quot; name of a tag -- too long, cumbersome
 209 to type in, not &quot;intuitive&quot; enough -- you can change it
 210 with the
 211 <a href="goodies.html#ALIAS">ALIAS</a>
 212 macro.)
 213 <p>
 214 In addition to the tags themselves, <strong>mom</strong> has an
 215 extensive array of macros that control how they look and behave.
 216 <p>
 217 Setting up a <strong>mom</strong> doc is a simple, four-part procedure.
 218 You begin by entering information about the document itself (title,
 219 subtitle, author, etc.).  Next, you tell <strong>mom</strong> what
 220 kind of document you're creating (e.g. chapter, letter, abstract,
 221 etc...) and what kind of output you want (typeset, typewrittten,
 222 draft-style, etc).  Thirdly, you make as many or as few changes to
 223 <strong>mom</strong>'s default behaviour as you wish.  Lastly, you
 224 invoke the
 225 <a href="#START">START</a>
 226 macro.  Voilà!  You're ready to write.
 227 <br>
 228 <hr>
 229
 230
 231 <h2><a name="DEFAULTS"><u>Some document defaults</u></a></h2>
 232
 233 As is to be expected, <strong>mom</strong> has defaults for everything.
 234 If you want to know a particular default, read about it in the
 235 description of the pertinent tag.
 236 <p>
 237 I fear the following may not be adequately covered in the
 238 documentation.  Just in case, here they are.
 239 <p>
 240 <ul>
 241         <li>the paper size is 8.5x11 inches
 242         <li>the left and right margins are 1-inch
 243         <li>the top and bottom margins for document text are plus/minus
 244                 visually 1-inch
 245         <li>pages are numbered; the number appears centered, at the
 246                 bottom, surrounded by hyphens ( e.g. -6- )
 247         <li>the first page of a document begins with a
 248                 <a href="definitions.html#TERMS_DOCHEADER">document header</a>
 249         <li>subsequent pages have
 250                 <a href="definitions.html#TERMS_HEADER">page headers</a>
 251                 with a rule underneath
 252 </ul>
 253 <p>
 254 Another way to check up on document processing defaults is to have
 255 a look at the macro file (om.tmac).  Each macro is preceded by a
 256 description that (generally) says what its default is (if it has
 257 one).
 258 <br>
 259 <hr>
 260
 261 <a name="LEADING_NOTE">
 262         <h2><u>IMPORTANT NOTE on leading/spacing and  bottom margins</u></h2>
 263 </a>
 264
 265 <strong>Mom</strong> takes evenly-aligned  bottom margins in
 266 <a href="definitions.html#TERMS_RUNNING">running text</a>
 267 very seriously.  Only under a very few (exceptional) circumstances
 268 will she allow a bottom margin to &quot;hang&quot; (i.e. to fall
 269 short).
 270 <p>
 271 In order to ensure even bottom margins, <strong>mom</strong>
 272 uses the &quot;base&quot; document
 273 <a href="definitions.html#TERMS_LEADING">leading</a>
 274 in effect <em>at the start of each page</em> (i.e. the leading used
 275 in paragraphs) to calculate the spacing of every document element.
 276 Prior to invoking
 277 <a href="#START">START</a>,
 278 this is done with the
 279 <a href="typesetting.html#MACROS_TYPESETTING">typesetting macro</a>
 280 <a href="typesetting.html#LEADING">LS</a>,
 281 afterwards with the document
 282 <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>
 283 <a href="#DOC_LEAD">DOC_LEAD</a>.
 284 <p>
 285 Because <strong>mom</strong> relies so heavily on the base document
 286 leading, any change to the leading or spacing on a page will almost
 287 certainly have undesirable consequences on that page's bottom margin
 288 unless the change is fully compensated for elsewhere on the page.
 289 <p>
 290 In other words, if you add a few points of space somewhere on a page,
 291 you must subtract the same number of points somewhere else on that
 292 same page, and vice versa.
 293 <p>
 294 If it's a question of adding or subtracting full line spaces between
 295 or within document elements, you can do so by using the &quot;v&quot;
 296 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
 297 with whatever spacing macro you choose --
 298 <a href="typesetting.html#ALD">ALD</a>,
 299 <a href="typesetting.html#RLD">RLD</a>,
 300 <a href="typesetting.html#SPACE">SPACE</a>
 301 -- and <strong>mom</strong> won't object.  &quot;v&quot; means
 302 &quot;the current leading&quot;, so she isn't confused by it.  And
 303 since &quot;v&quot; accepts decimal fractions, you can add/subtract
 304 half linespaces and quarter linespaces with &quot;v&quot; as well,
 305 <em>provided you compensate for the fractional linespace somewhere
 306 else on the page</em>.
 307 <br>
 308 <hr>
 309
 310 <a name="SETUP"><h2><u>Document setup</u></h2></a>
 311
 312 <a name="DOCPROCESSING_TUT">
 313         <h3><u>Tutorial -- Setting up a mom document</u></h3>
 314 </a>
 315 <p>
 316 There are four &quot;parts&quot; to setting up a <strong>mom</strong>
 317 doc (three, actually, with one optional).  Before we proceed, though,
 318 be reassured that something as simple as
 319 <p>
 320 <pre>
 321         .TITLE     "By the Shores of Lake Attica"
 322         .AUTHOR    "Rosemary Winspeare"
 323         .PRINTSTYLE TYPESET
 324         .START
 325 </pre>
 326
 327 produces a beautifully typeset 8.5x11 document, with a
 328 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
 329 at the top of page 1,
 330 <a href="definitions.html#TERMS_HEADER">page headers</a>
 331 with the title and author on subsequent
 332 pages, and page numbers at the bottom of each page.  In the course
 333 of the document, heads, subheads, citations, quotes, epigraphs,
 334 and so on, all come out looking neat, trim, and professional.
 335 <p>
 336 For the purposes of this tutorial, we're going to set up a short
 337 story -- <em>My Pulitzer Winner</em> by Joe Blow.  Thankfully,
 338 we don't have to look at story itself, just the setup.
 339 Joe wants the document
 340 <p>
 341 <ul>
 342         <li>to be draft 7, revision 39;
 343         <li>to use the &quot;default&quot; style of document formatting:
 344         <li>to print as draft-style output (instead of &quot;final&quot; copy output);
 345         <li>to be typeset, in Helvetica, 12 on 14,
 346                 <a href="definitions.html#TERMS_RAG">rag-right</a>;
 347         <li>to have <a href="definitions.html#TERMS_FOOTER">footers</a>
 348                 instead of
 349                 <a href="definitions.html#TERMS_HEADER">headers</a>;
 350         <li>to use a single asterisk for
 351                 <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>.
 352 </ul>
 353 <p>
 354 Joe Blow has no taste in typography.  His draft won't look pretty,
 355 but this is, after all, a tutorial; we're after examples, not beauty.
 356 <h3><u>Step 1</u></h3>
 357
 358 The first step in setting up any document is giving <strong>mom</strong>
 359 some reference information.  The reference macros are:
 360 <p>
 361 <ul>
 362         <li>TITLE
 363         <li>SUBTITLE
 364         <li>AUTHOR
 365         <li>CHAPTER -- the chapter number
 366         <li>DRAFT -- the draft number
 367         <li>REVISION -- the revision number
 368 </ul>
 369 <p>
 370 You can use as many or as few as you wish, although at a minimum,
 371 you'll probably fill in <strong>TITLE</strong> (unless the document's
 372 a letter) and <strong>AUTHOR</strong>.  Order doesn't matter.
 373 You can separate the
 374 <a href="definitions.html#TERMS_ARGUMENTS">arguments</a>
 375 from the macros by any number of spaces.  The following are
 376 what you'd need to start Joe Blow's story.
 377 <p>
 378 <pre>
 379         .TITLE    "My Pulitzer Winner"
 380         .AUTHOR   "Joe Blow"
 381         .DRAFT     7
 382         .REVISION  39
 383 </pre>
 384
 385 <h3><u>Step 2</u></h3>
 386
 387 Once you've given <strong>mom</strong> the reference information she
 388 needs, you tell her how you want your document formatted.  What kind
 389 of document is it?  Should it be typeset or typewritten?  Is this
 390 a &quot;final&quot; copy (for the world to see) or just a draft?
 391 <strong>Mom</strong> calls the macros that answer these questions
 392 &quot;the docstyle macros.&quot;  They are:
 393 <p>
 394 <ul>
 395         <li>DOCTYPE -- the type of document (default, chapter, user-defined, letter)
 396         <li>PRINTSTYLE -- typeset or typewritten
 397         <li>COPYSTYLE  -- draft or final copy
 398 </ul>
 399 <p>
 400 <strong>Mom</strong> has defaults for <strong>DOCTYPE</strong>
 401 and <strong>COPYSTYLE</strong>; if they're what you want, you
 402 don't need to include them here.  However, <strong>PRINTSTYLE</strong>
 403 has no default and MUST be present in every formatted document.
 404 If you omit it, <strong>mom</strong> won't process the document AND
 405 she'll complain (both to stderr and as a single printed sheet with
 406 a warning).  Moms -- they can be so annoying sometimes. &lt;sigh&gt;
 407 <p>
 408 Adding to what we already have, the next bit of setup for Joe
 409 Blow's story looks like this:
 410 <p>
 411 <pre>
 412         .TITLE    "My Pulitzer Winner"
 413         .AUTHOR   "Joe Blow"
 414         .DRAFT     7
 415         .REVISION  39
 416         \#
 417         .DOCTYPE     DEFAULT \"Superfluous; mom uses DOCTYPE DEFAULT by default
 418         .PRINTSTYLE  TYPESET
 419         .COPYSTYLE   DRAFT
 420 </pre>
 421
 422 Notice the use of the
 423 <a href="definitions.html#TERMS_COMMENTLINES">comment line</a>
 424 ( \# ), a handy way to keep groups of macros visually separated
 425 for easy reading in a text editor.
 426
 427 <h3><u>Step 3</u></h3>
 428
 429 This step -- completely optional -- is where you, the user, take
 430 charge.  <strong>Mom</strong> has defaults for <em>everything</em>,
 431 but who's ever satisfied with defaults?  Use any of the <a
 432 href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
 433 here to change <strong>mom</strong>'s document defaults (paper
 434 size, margins, family, point size, line space, rag, etc), or
 435 any of the document processing macros that set/change/control
 436 the appearance of document elements.  Think of this as the
 437 &quot;style-sheet &quot; section of a document.
 438 <p>
 439 Joe Blow wants his story printed in Helvetica, 12 on 14, rag
 440 right, with
 441 <a href="definitions.html#TERMS_FOOTER">page footers</a>
 442 instead of
 443 <a href="definitions.html#TERMS_HEADER">page headers</a>
 444 and a single asterisk for the
 445 <a href="definitions.html#TERMS_LINEBREAK">linebreak</a>
 446 character.  None of these requirements conforms
 447 to <strong>mom</strong>'s defaults for the chosen
 448 <strong>PRINTSTYLE</strong> (TYPESET), so we change them here.
 449 The setup for Joe Blow's story now looks like this:
 450 <p>
 451 <pre>
 452         .TITLE    "My Pulitzer Winner"
 453         .AUTHOR   "Joe Blow"
 454         .DRAFT     7
 455         .REVISION  39
 456         \#
 457         .DOCTYPE     DEFAULT
 458         .PRINTSTYLE  TYPESET
 459         .COPYSTYLE   DRAFT
 460         \#
 461         .FAMILY  H
 462         .PS      12
 463         .LS      14
 464         .QUAD    LEFT    \"ie. rag right
 465         .FOOTERS
 466         .LINEBREAK_CHAR *
 467 </pre>
 468
 469 <h3><u>Step 4</u></h3>
 470 The final step in setting up a document is telling <strong>mom</strong>
 471 to start document processing.  It's a no-brainer, just the single macro
 472 <strong>START</strong>.  Other than <strong>PRINTSTYLE</strong>, it's
 473 the only macro required for document processing (although
 474 I can't guarantee you'll like the results of using just the two).
 475 <p>
 476 Here's the complete setup for <em>My Pulitzer Winner</em>:
 477 <p>
 478 <pre>
 479         .TITLE    "My Pulitzer Winner"
 480         .AUTHOR   "Joe Blow"
 481         .DRAFT     7
 482         .REVISION  39
 483         \#
 484         .DOCTYPE     DEFAULT
 485         .PRINTSTYLE  TYPESET
 486         .COPYSTYLE   DRAFT
 487         \#
 488         .FAMILY   H
 489         .PS       12
 490         .LS       14
 491         .QUAD     LEFT    \"ie. rag right
 492         .FOOTERS
 493         .LINEBREAK_CHAR *
 494         \#
 495         .START
 496 </pre>
 497
 498 As pointed out earlier, Joe Blow is no typographer.  Given that all he
 499 needs is a printed draft of his work, a simpler setup would have been:
 500 <p>
 501 <pre>
 502         .TITLE    "My Pulitzer Winner"
 503         .AUTHOR   "Joe Blow"
 504         .DRAFT     7
 505         .REVISION  39
 506         \#
 507         .PRINTSTYLE  TYPEWRITE
 508         .COPYSTYLE   DRAFT
 509         \#
 510         .START
 511 </pre>
 512
 513 <kbd>.PRINTSTYLE TYPEWRITE</kbd>, above, means that Joe's work
 514 will come out &quot;typewritten, double-spaced&quot;, making the
 515 blue-pencilling he (or someone else) is sure to do much
 516 easier (which is why many publishers and agents still insist on
 517 typewritten, double-spaced copy).
 518 <p>
 519 When J. Blow stops re-writing and decides to print off a final,
 520 typeset copy of his work for the world to see, he need only
 521 make two changes to the (simplified) setup:
 522 <p>
 523 <pre>
 524         .TITLE    "My Pulitzer Winner"
 525         .AUTHOR   "Joe Blow"
 526         .DRAFT     7
 527         .REVISION  39
 528         \#
 529         .PRINTSTYLE  TYPESET  \"first change
 530         .COPYSTYLE   FINAL    \"second change
 531         \#
 532         .START
 533 </pre>
 534
 535 In the above, <kbd>.DRAFT 7, .REVISION 39,</kbd> and <kbd>.COPYSTYLE
 536 FINAL</kbd> are actually superfluous.  The draft and revision numbers
 537 aren't used when <strong>COPYSTYLE</strong> is <strong>FINAL</strong>,
 538 and <strong>COPYSTYLE FINAL</strong> is <strong>mom</strong>'s
 539 default unless you tell her otherwise.  BUT... to judge from the
 540 number of drafts already, J. Blow may very well decide his
 541 &quot;final&quot; version still isn't up to snuff.  Hence, he might
 542 as well leave in the superfluous macros.  That way, when draft 7,
 543 rev. 62 becomes draft 8, rev. 1, he'll be ready to tackle his Pulitzer
 544 winner again.
 545 <br>
 546 <hr>
 547
 548 <!========================================================================>
 549
 550 <a name="REFERENCE_MACROS">
 551         <h2><u>The Reference Macros</u></h2>
 552 </a>
 553
 554 The reference macros give <strong>mom</strong> the information
 555 she needs to generate
 556 <a href="definitions.html#TERMS_DOCHEADER">docheaders</a>
 557 and
 558 <a href="definitions.html#TERMS_HEADER">page headers</a>.  They
 559 must go at the top of any file that uses <strong>mom</strong>'s
 560 document processing macros.
 561
 562 <a name="INDEX_REFERENCE">
 563         <h3><u>Reference macros list</u></h3>
 564 </a>
 565
 566 <ul>
 567         <li><a href="#TITLE">TITLE</a>
 568         <li><a href="#SUBTITLE">SUBTITLE</a>
 569         <li><a href="#AUTHOR">AUTHOR</a>
 570         <li><a href="#CHAPTER">CHAPTER</a>
 571         <li><a href="#DRAFT">DRAFT</a>
 572         <li><a href="#REVISION">REVISION</a>
 573 </ul>
 574
 575 <!---TITLE--->
 576
 577 <hr width="66%" align="left">
 578 <p>
 579 <a name="TITLE"></a>
 580 Macro: <strong>TITLE</strong> <var>&quot;&lt;title&gt;&quot;</var>
 581 <br>
 582 <em>*Argument must be enclosed in double-quotes</em>
 583
 584 <p>
 585 The title string can be caps or caps/lower-case; it's up to you.
 586 In
 587 <a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
 588 the title will appear in the
 589 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
 590 exactly as you typed it.  However, <strong>mom</strong> converts
 591 the title to all caps in
 592 <a href="definitions.html#TERMS_HEADER">page headers</a>
 593 unless you turn that feature off (see
 594 <a href="headfootpage.html#_CAPS">HEADER_&lt;POSITION&gt;_CAPS</a>). In
 595 <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
 596 the title always gets converted to caps.
 597 <p>
 598 <strong>NOTE:</strong> If your
 599 <a href="#DOCTYPE">DOCTYPE</a>
 600 is <strong>CHAPTER</strong>, <strong>TITLE</strong> should be the
 601 title of the opus, not &quot;CHAPTER whatever&quot;.
 602 <br>
 603
 604 <!---SUBTITLE--->
 605
 606 <hr width="66%" align="left">
 607 <p>
 608 <a name="SUBTITLE"></a>
 609 Macro: <strong>SUBTITLE</strong> <var>&quot;&lt;subtitle&gt;&quot;</var>
 610 <br>
 611 <em>*Argument must be enclosed in double-quotes</em>
 612
 613 <p>
 614 The subtitle string can be caps or caps/lower-case.  Since a
 615 document's subtitle appears only in the
 616 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
 617 and the title is most likely in caps, I recommend caps/lower case.
 618 <br>
 619
 620 <!---AUTHOR--->
 621
 622 <hr width="66%" align="left">
 623 <p>
 624 <a name="AUTHOR"></a>
 625 Macro: <strong>AUTHOR</strong> <var>&quot;&lt;author string&gt;&quot; [ &quot;&lt;author2 string&gt;&quot; &quot;&lt;author3 string&gt;&quot; ... ]</var>
 626 <br>
 627 <em>*Multiple arguments must be enclosed in double-quotes</em>
 628
 629 <p>
 630 Each author string can hold as many names as you like, e.g.
 631 <p>
 632 <pre>
 633         .AUTHOR "Joe Blow"
 634             or
 635         .AUTHOR "Joe Blow, Jane Doe" "John Hancock"
 636 </pre>
 637
 638 <strong>Mom</strong> prints each string that's enclosed in
 639 double-quotes on a separate line in the
 640 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
 641 however only the first string appears in
 642 <a href="definitions.html#TERMS_HEADER">page headers</a>.
 643 If you want <strong>mom</strong> to put something else in the author
 644 part of page headers (say, just the last names of a document's two
 645 authors), redefine the appropriate part of the header (see
 646 <a href="headfootpage.html#HEADER_CONTROL">header/footer control</a>).
 647 <p>
 648 The strings can be caps or caps/lower-case.  I recommend caps/lower
 649 case.
 650 <br>
 651
 652 <!---CHAPTER--->
 653
 654 <hr width="66%" align="left">
 655 <p>
 656 <a name="CHAPTER"></a>
 657 Macro: <strong>CHAPTER</strong> <var>&lt;chapter number&gt;</var>
 658
 659 <p>
 660 The chapter number can be in any form you like -- a digit, a roman
 661 numeral, a word.  If you choose
 662 <a href="#DOCTYPE">DOCTYPE CHAPTER</a>,
 663 <strong>mom</strong> prints whatever argument you pass
 664 <strong>CHAPTER</strong> beside the word &quot;Chapter&quot; as a
 665 single line
 666 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>.
 667 She also puts the same thing in the middle of
 668 <a href="definitions.html#TERMS_HEADER">page headers</a>.
 669 <p>
 670 If you're not using <strong>DOCTYPE CHAPTER</strong>, the macro serves
 671 no purpose and <strong>mom</strong> ignores it.
 672 <a name="CHAPTER_STRING"></a>
 673 <p>
 674 If you're not writing in English, you can ask <strong>mom</strong>
 675 to use the word for chapter in your own language by telling
 676 her what it is with the <strong>CHAPTER_STRING</strong> macro,
 677 like this:
 678 <p>
 679 <pre>
 680         .CHAPTER_STRING "Chapître"
 681 </pre>
 682
 683 You can also use <strong>CHAPTER_STRING</strong> if you want
 684 &quot;CHAPTER&quot; instead of &quot;Chapter&quot; in the doc- and
 685 page-headers.  (See also the
 686 <a href="#CHAPTER_NOTE">Special Note on CHAPTER</a>.)
 687 <br>
 688
 689 <!---DRAFT--->
 690
 691 <hr width="66%" align="left">
 692 <p>
 693 <a name="DRAFT"></a>
 694 Macro: <strong>DRAFT</strong> <var>&lt;draft #&gt;</var>
 695
 696 <p>
 697 <strong>DRAFT</strong> only gets used with
 698 <a href="#COPYSTYLE">COPYSTYLE DRAFT</a>.
 699 If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong> (the
 700 default), <strong>mom</strong> ignores <strong>DRAFT</strong>.
 701 <strong>DRAFT</strong> only accepts a
 702 <a href="definitions.html#TERMS_NUMERICARGUMENT">numeric argument</a>.
 703 <p>
 704 <strong>Mom</strong> prints the draft number beside the word
 705 &quot;Draft&quot; in the middle part of
 706 <a href="definitions.html#TERMS_HEADER">page headers</a>.
 707 If you're not writing in English, you can ask <strong>mom</strong>
 708 to use the word for draft in your own language by telling
 709 her what it is with the <strong>DRAFT_STRING</strong> macro,
 710 like this:
 711 <p>
 712 <pre>
 713         .DRAFT_STRING "Ébauche"
 714 </pre>
 715
 716 <!---REVISION--->
 717
 718 <hr width="66%" align="left">
 719 <p>
 720 <a name="REVISION"></a>
 721 Macro: <strong>REVISION</strong> <var>&lt;revision #&gt;</var>
 722
 723 <p>
 724 <strong>REVISION</strong> only gets used with
 725 <a href="#COPYSTYLE">COPYSTYLE DRAFT</a>.
 726 If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong>
 727 (the default), <strong>mom</strong> ignores the
 728 <strong>REVISION</strong> macro.  <strong>REVISION</strong> only
 729 accepts a
 730 <a href="definitions.html#TERMS_NUMERICARGUMENT">numeric argument</a>.
 731 <p>
 732 <strong>Mom</strong> prints the revision number beside the shortform
 733 &quot;Rev.&quot; in the middle part of
 734 <a href="definitions.html#TERMS_HEADER">page headers</a>.
 735 If you're not writing in English, you can ask <strong>mom</strong>
 736 to use the word for revision, or a shortform therof in your own language
 737 by telling her what it is with the <strong>REVISION_STRING</strong>
 738 macro, like this:
 739 <p>
 740 <pre>
 741         .REVISION_STRING "Rév."
 742 </pre>
 743 <hr>
 744
 745 <!========================================================================>
 746
 747 <a name="DOCSTYLE_MACROS">
 748         <h2><u>The Docstyle Macros</u></h2>
 749 </a>
 750
 751 The docstyle macros tell <strong>mom</strong> what type of document you're
 752 writing, whether you want the output typeset or
 753 &quot;typewritten&quot;, and whether you want a draft copy (with
 754 draft and revision information in the headers) or a final copy.
 755
 756 <a name="INDEX_DOCSTYLE">
 757         <h3><u>Docstyle macros list</u></h3>
 758 </a>
 759
 760 <ul>
 761         <li><a href="#DOCTYPE">DOCTYPE</a>
 762         <li><a href="#PRINTSTYLE">PRINTSTYLE</a>
 763         <ul>
 764                 <li><a href="#TYPESET_DEFAULTS">Defaults for PRINTSTYLE TYPESET</a>
 765                 <li><a href="#TYPEWRITE_DEFAULTS">Defaults for PRINTSTYLE TYPEWRITE</a>
 766                 <ul>
 767                         <li><a href="#TYPEWRITE_CONTROL">TYPEWRITE control macros</a>
 768                 </ul>
 769         </ul>
 770         <li><a href="#COPYSTYLE">COPYSTYLE</a>
 771 </ul>
 772
 773 <!---DOCTYPE--->
 774
 775 <hr width="66%" align="left">
 776 <p>
 777 <a name="DOCTYPE"></a>
 778 Macro: <strong>DOCTYPE</strong> <var>DEFAULT | CHAPTER | NAMED &quot;&lt;name&gt;&quot; | LETTER</var>
 779 <p>
 780 The arguments <strong>DEFAULT, CHAPTER</strong> and
 781 <strong>NAMED</strong> tell <strong>mom</strong> what to put
 782 in the
 783 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
 784 and
 785 <a href="definitions.html#TERMS_HEADER">page headers</a>.
 786 <strong>LETTER</strong> tells her that you want to write a
 787 lettter.
 788 <p>
 789 <strong>Mom</strong>'s default <strong>DOCTYPE</strong> is
 790 <strong>DEFAULT</strong>.  If that's what you want, you don't
 791 have to give a <strong>DOCTYPE</strong> command.
 792 <p>
 793 <strong>DEFAULT</strong> prints a
 794 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
 795 containing the title, subtitle and author information given to the
 796 <a href="#REFERENCE_MACROS">reference macros</a>,
 797 and page headers with the author and title.
 798 (See
 799 <a href="headfootpage.html#HEADER_STYLE">Default specs for headers</a>
 800 for how <strong>mom</strong>'s outputs each part of the page header.)
 801 <p>
 802 <strong>CHAPTER</strong> prints &quot;Chapter #&quot; in place of a
 803 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
 804 (# is what you gave to
 805 <a href="#CHAPTER">CHAPTER</a>).
 806 Page headers contain the author, the title of the book (which
 807 you gave with
 808 <a href="#TITLE">TITLE</a>),
 809 and &quot;Chapter #&quot;.  (See
 810 <a href="headfootpage.html#HEADER_STYLE">Default Specs for Headers</a>
 811 for <strong>mom</strong>'s default type parameters for each part of
 812 the page header.)
 813 <p>
 814 <em>*See the
 815 <a href="#CHAPTER_NOTE">Special Note on CHAPTER</a>
 816 below for how you can make CHAPTER print something
 817 other than &quot;Chapter #&quot; as its docheader.</em>
 818 <p>
 819 <strong>NAMED</strong> takes an additional argument: a name
 820 for this particular kind of document  (e.g. outline, synopsis,
 821 abstract, memorandum), enclosed in double-quotes.
 822 <strong>NAMED</strong> is identical to <strong>DEFAULT</strong>
 823 except that <strong>mom</strong> prints the argument to
 824 <strong>NAMED</strong> beneath the
 825 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
 826 as well as in page headers.
 827 (See
 828 <a href="headfootpage.html#HEADER_STYLE">Default specs for headers</a>
 829 for how <strong>mom</strong>'s outputs each part of the page header.)
 830 <p>
 831 <strong>LETTER</strong> tells mom you're writing a letter.  See
 832 the section
 833 <a href="letters.html#INTRO">Writing Letters</a>
 834 for instructions on using <strong>mom</strong> to format letters.
 835
 836 <a name="CHAPTER_NOTE"><h3><u>Special Note on CHAPTER</u></h3></a>
 837 In novels, new chapters are generally (but not always)
 838 introduced by &quot;Chapter #&quot;.  Other types of documents
 839 (reports and so on) often require specific titles for chapters.
 840 If your document is of this latter type, use <strong>DOCTYPE
 841 CHAPTER</strong> in the following way:
 842 <p>
 843 <ol>
 844         <li>Omit the
 845                 <a href="#REFERENCE_MACROS">reference macro</a>
 846                 <a href="#CHAPTER">CHAPTER</a>
 847         <li>Invoke
 848                 <a href="#CHAPTER_STRING"><code>.CHAPTER_STRING</code></a>
 849                 with the title you'd like the chapter to have (enclosed
 850                 in double-quotes, of course).
 851         <li>Optionally, if you'd like the chapter title to appear
 852                 in the the center part of
 853                 <a href="definitions.html#TERMS_HEADER">page headers</a>
 854                 (its default location), invoke
 855                 <a href="headfootpage.html#HDRFTR_CENTER"><code>.HEADER_CENTER</code></a>
 856                 with the same title you gave to <strong>CHAPTER_STRING</strong>.
 857
 858 </ol>
 859 <br>
 860
 861 <!---PRINTSTYLE--->
 862
 863 <hr width="66%" align="left">
 864 <p>
 865 <a name="PRINTSTYLE"></a>
 866 Macro: <strong>PRINTSTYLE</strong> <var>TYPESET | TYPEWRITE [ SINGLESPACE ]</var>
 867 <br>
 868 <em>*Required for document processing.</em>
 869
 870 <p>
 871 <strong>PRINTSTYLE</strong> tells <strong>mom</strong> whether to typeset
 872 a document, or to print it out &quot;typewritten, doubled-spaced&quot;.
 873 <p>
 874 <strong>THIS MACRO MAY NOT BE OMITTED.</strong>  In order for
 875 document processing to take place, <strong>mom</strong> requires
 876 a <strong>PRINTSTYLE</strong>.  If you don't give one,
 877 <strong>mom</strong> will warn you on stderr and print a single
 878 page with a nasty message.
 879 <p>
 880 <strong>TYPESET</strong>, as the argument implies, typesets documents
 881 (by default in Times Roman; see
 882 <a href="#TYPESET_DEFAULTS">TYPESET defaults</a>).
 883 You have full access to all the
 884 <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
 885 as well as the
 886 <a href="definitions.html#STYLE_CONTROL">style control macros</a>
 887 of document processing.
 888 <p>
 889 With <strong>TYPEWRITE</strong>, <strong>mom</strong> does her best
 890 to reproduce the look and feel of typewritten, double-spaced copy (see
 891 <a href="#TYPEWRITE_DEFAULTS">TYPEWRITE defaults</a>).
 892 <a href="docelement.html#DOCELEMENT_CONTROL">Control macros</a>
 893 and
 894 <a href="typesetting.html#INTRO_MACROS_TYPESETTING">typesetting macros</a>
 895 that alter family, font, point size, and
 896 <a href="definitions.html#TERMS_LEADING">leading</a>
 897 are (mostly) ignored.  An important exception is
 898 <a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a>
 899 (and, by extension, <strong>FOOTER_SIZE</strong>), which allows
 900 you to reduce the point size of headers/footers should they become
 901 too crowded.  Most of <strong>mom</strong>'s inlines affecting the
 902 appearance of type are also ignored (<strong>\*S</strong> is an
 903 exception; there may be a few others).
 904 <p>
 905 In short, <strong>TYPEWRITE</strong> never produces effects other than
 906 those available on a typewriter.  Don't be fooled by how brainless
 907 this sounds; <strong>mom</strong> is remarkably sophisticated when
 908 it comes to conveying the typographic sense of a document within the
 909 confines of <strong>TYPEWRITE</strong>.
 910 <p>
 911 The primary uses of <strong>TYPEWRITE</strong> are: outputting hard
 912 copy drafts of your work (for editing), and producing documents
 913 for submission to publishers and agents who (wisely) insist on
 914 typewritten, double-spaced copy. To get a nicely typeset version of
 915 work that's in the submission phase of its life (say, to show fellow
 916 writers for critiquing), simply change <strong>TYPEWRITE</strong>
 917 to <strong>TYPESET</strong> and print out a copy.
 918 <p>
 919 If, for some reason, you would prefer the output of
 920 <strong>TYPEWRITE</strong> single-spaced, pass <strong>PRINTSTYLE
 921 TYPEWRITE</strong> the optional argument, <strong>SINGLESPACE</strong>.
 922 <p>
 923 If you absolutely must have a leading other than typewriter double-
 924 or singlespaced, the only way to get it is with the
 925 <a href="#DOC_LEAD">DOC_LEAD</a>
 926 macro, and then ONLY if <strong>DOC_LEAD</strong> is set
 927 <strong>before</strong> you invoke the <strong>START</strong>
 928 macro.
 929
 930 <a name="TYPESET_DEFAULTS"><h3><u>TYPESET defaults</u></h3></a>
 931 <pre>
 932         Family            = Times Roman
 933         Point size        = 12.5
 934         Paragraph leading = 16 points, adjusted
 935         Fill mode         = justified
 936         Hyphenation       = enabled
 937                             max. lines = 2
 938                             margin = 36 points
 939                             interword adjustment = 1 point
 940         Kerning           = enabled
 941         Ligatures         = enabled
 942         Smartquotes       = enabled
 943         Word space        = groff default
 944         Sentence space    = 0
 945 </pre>
 946
 947 <a name="TYPEWRITE_DEFAULTS"><h3><u>TYPEWRITE defaults</u></h3></a>
 948 <pre>
 949         Family            = Courier
 950         Italics           = underlined
 951         Point size        = 12
 952         Paragraph leading = 24 points, adjusted; 12 points for SINGLESPACE
 953         Fill mode         = left
 954         Hyphenation       = disabled
 955         Kerning           = disabled
 956         Ligatures         = disabled
 957         Smartquotes       = disabled
 958         Word space        = groff default
 959         Sentence space    = groff default
 960         Columns           = ignored
 961 </pre>
 962
 963 <a name="TYPEWRITE_CONTROL"><h3><u>PRINTSTYLE TYPEWRITE control macros</u></h3></a>
 964 <p>
 965 In <strong>PRINTSTYLE TYPEWRITE</strong>, <strong>mom</strong>,
 966 by default, underlines anything that looks like italics.  This
 967 includes the
 968 <a href="typesetting.html#SLANT_INLINE">\*[SLANT]</a>
 969 <a href="definitions.html#TERMS_INLINES">inline escape</a>
 970 for pseudo-italics.
 971 <p>
 972 If you'd prefer that <strong>mom</strong> were
 973 less bloody-minded about pretending to be a typewriter (i.e.
 974 you'd like italics and pseudo-italics to come out as italics),
 975 use the control macros <strong>.ITALIC_MEANS_ITALIC</strong> and
 976 <strong>.SLANT_MEANS_SLANT</strong>.  Neither requires an
 977 argument.
 978 <p>
 979 Although it's unlikely, should you wish to reverse the sense of
 980 these macros in the midst of a document,
 981 <strong>.UNDERLINE_ITALIC</strong> and
 982 <strong>.UNDERLINE_SLANT</strong> restore underlining of
 983 italics and pseudo-italics.
 984 <p>
 985 Additionally, by default, <strong>mom</strong> underlines
 986 <a href="definitions.html#TERMS_QUOTES">quotes</a>
 987 (but not
 988 <a href="definitions.html#TERMS_BLOCKQUOTES">blockquotes</a>)
 989 in <strong>PRINTSTYLE TYPEWRITE</strong>.
 990 If you don't like this behaviour, turn it off with
 991 <p>
 992 <pre>
 993         .UNDERLINE_QUOTES OFF
 994 </pre>
 995
 996 To turn underlining of quotes back on, use
 997 <strong>UNDERLINE_QUOTES</strong> without an argument.
 998 <p>
 999 While most of the
1000 <a href="docelement.html#DOCELEMENT_CONTROL">control macros</a>
1001 have no effect on <strong>PRINTSTYLE TYPEWRITE</strong>, there
1002 is an important exception:
1003 <a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a>
1004 (and by extension, <strong>FOOTER_SIZE</strong>).  This is
1005 particularly useful for reducing the point size of
1006 headers/footers should they become crowded (quite likely to
1007 happen if the title of your document is long and your
1008 <a href="#COPYSTYLE">COPYSTYLE</a>
1009 is <strong>DRAFT</strong>).
1010 <br>
1011
1012 <!---COPYSTYLE--->
1013
1014 <hr width="66%" align="left">
1015 <p>
1016 <a name="COPYSTYLE"></a>
1017 Macro: <strong>COPYSTYLE</strong> <var>DRAFT | FINAL</var>
1018
1019 <p>
1020 <strong>Mom</strong>'s default <strong>COPYSTYLE</strong> is
1021 <strong>FINAL</strong>, so you don't have to use this macro unless
1022 you want to.
1023 <p>
1024 <strong>DRAFT</strong> starts your document on page 1, regardless
1025 of whether you've requested a different starting page number
1026 with
1027 <a href="headfootpage.html#PAGENUMBER">PAGENUMBER</a>.
1028 Page numbers are set in lower case roman numerals.
1029 <strong>Mom</strong> puts a draft and revision number (from the
1030 <a href="#DRAFT">DRAFT</a>
1031 and
1032 <a href="#REVISION">REVISION</a>
1033 <a href="#REFERENCE_MACROS">Reference Macros</a>)
1034 in
1035 <a href="definitions.html#TERMS_HEADER">page headers</a>
1036 along with all other information that normally appears there.
1037 <p>
1038 <strong>FINAL</strong> respects the starting page number you give
1039 your document.  Page numbers are set in normal (arabic) digits, and
1040 no draft or revision number appears in the page headers.
1041 <br>
1042 <hr>
1043
1044 <!========================================================================>
1045
1046 <a name="STYLE_BEFORE_START"><h2><u>Changing type/style parameters prior to START</u></h2></a>
1047
1048 In the third (optional) part of setting up a document (see
1049 <a href="#DOCPROCESSING_TUT">Tutorial -- setting up a mom document</a>),
1050 you can use the
1051 <a href="typsetting.html">typesetting macros</a>
1052 to change <strong>mom</strong>'s document-wide defaults for margins,
1053 line length, family, base point size,
1054 <a href="definitions.html#TERMS_LEADING">leading</a>,
1055 and justification style.
1056 <p>
1057 Two additional style concerns have to be addressed here (i.e. in
1058 macros before
1059 <a href="#START">START</a>):
1060 changes to the
1061 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
1062 and whether you want you want the document's nominal leading
1063 adjusted to fill pages fully to the bottom margin.
1064 <p>
1065 <ul>
1066         <li><a href="#TYPE_BEFORE_START">Using typesetting macros prior to START</a>
1067         <p>
1068         <li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
1069                 -- adjusting linespacing for equal, accurate bottom margins
1070         <li><a href="#DOCHEADER">DOCHEADER</a>
1071                 -- turning the docheader off
1072         <ul>
1073                 <li><a href="#DOCHEADER_CONTROL">Docheader control</a>
1074         </ul>
1075 </ul>
1076
1077 <hr width="66%" align="left">
1078 <a name="TYPE_BEFORE_START"><h2><u>Using typesetting macros prior to START</u></h2></a>
1079
1080 When used before the
1081 <a href="#START">START</a>
1082 macro, the following
1083 <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
1084 have these meanings:
1085 <p>
1086 <pre>
1087         L_MARGIN         Left margin of pages, including headers/footers
1088         R_MARGIN         Right margin of pages, including headers/footers
1089         T_MARGIN         The point at which running text (i.e. not
1090                          headers/footers or page numbers) starts on each page
1091         B_MARGIN         The point at which running text (i.e. not
1092                          headers/footers or page numbers) ends on each page
1093
1094         (PAGE            If you use PAGE, its first four arguments have the
1095                          same meaning as L_ R_ T_ and B_MARGIN above.)
1096
1097         LL               The line length for everything on the page;
1098                          equivalent to setting the right margin with R_MARGIN
1099         FAMILY           The family of all type in the document
1100         PS               The point size of type in paragraphs; mom uses this
1101                          calculate automatic point size changes (eg. for heads,
1102                          footnotes, quotes, headers, etc)
1103         *LS or AUTOLEAD  The leading used in paragraphs; all leading and spacing
1104                          of running text is calculated from this
1105         QUAD             Affects paragraphs only
1106
1107 ------
1108 *See <a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
1109 </pre>
1110
1111 Other macros that deal with type style, or refinements thereof
1112 (<strong>KERN, LIGATURES, HY, WS, SS,</strong> etc.), behave normally.
1113 It is not recommended that you set up tabs or indents prior to
1114 <strong>START</strong>.
1115 <p>
1116 If you want to change any of the basic parameters above
1117 <em>after</em> <strong>START</strong> and have them affect a
1118 document globally (as if you'd entered them <em>before</em>
1119 <strong>START</strong>), you must use the macros listed in
1120 <a href="#DOC_PARAM_MACROS">Changing document-wide style parameters after START</a>.
1121 <br>
1122
1123 <!---DOC_LEAD_ADJUST--->
1124
1125 <hr width="66%" align="left">
1126 <a name="DOC_LEAD_ADJUST"><h3><u>Adjusting document leading to fill pages</u></h3></a>
1127 <br>
1128 Macro: <strong>DOC_LEAD_ADJUST</strong> <var>toggle</var>
1129 <br>
1130 <em>*Must come after LS or AUTOLEAD and before START</em>
1131
1132 <p>
1133 <strong>DOC_LEAD_ADJUST</strong> is a special macro to adjust
1134 document
1135 <a href="definitions.html#TERMS_LEADING">leading</a>
1136 so that bottom margins fall precisely where you expect.
1137 <p>
1138 If you invoke <strong>DOC_LEAD_ADJUST</strong>, <strong>mom</strong>
1139 takes the number of lines that fit on the page at your requested
1140 leading, then incrementally adds
1141 <a href="definitions.html#TERMS_UNITS">machine units</a>
1142 to the leading until the maximum number of lines at the new leading
1143 matches the bottom margin.  In most instances, the difference
1144 between the requested lead and the adjusted lead is
1145 unnoticeable.
1146 <p>
1147 <strong>Mom</strong> uses <strong>DOC_LEAD_ADJUST</strong> with
1148 her default document settings, but if you invoke
1149 <a href="typesetting.html#LS">LS</a>
1150 or
1151 <a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>
1152 prior to
1153 <a href="#START">START</a>,
1154 you have to do
1155 <p>
1156 <pre>
1157         .DOC_LEAD_ADJUST
1158 </pre>
1159 in order to enable it.
1160 <p>
1161 If you don't like the idea of <strong>mom</strong> playing around
1162 with the leading by default, you can turn adjusting off with
1163 <p>
1164 <pre>
1165         .DOC_LEAD_ADJUST OFF
1166 </pre>
1167
1168 In this scenario, the maximum number of lines that fit on a page at
1169 the current document leading determine where <strong>mom</strong> ends
1170 a page.  The effect will be that last lines usually fall (slightly)
1171 short of your expected bottom margin.
1172 <p>
1173 <strong>NOTE:</strong> <strong>DOC_LEAD_ADJUST</strong>, if
1174 used, must be invoked after
1175 <a href="typesetting.html#LS">LS</a>
1176 or
1177 <a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>
1178 and before
1179 <a href="#START">START</a>
1180 <br>
1181
1182 <!---DOCHEADER--->
1183
1184 <hr width="66%" align="left">
1185 <a name="DOCHEADER"><h3><u>Managing the docheader</u></h3></a>
1186 <br>
1187 Macro: <strong>DOCHEADER</strong> <var>&lt;toggle&gt; [ distance to advance from top of page ]</var>
1188 <br>
1189 <em>*Must come before START; distance requires a <a href="#TERMS_UNITOFMEASURE">unit of measure</a></em>
1190
1191 <p>
1192 By default, <strong>mom</strong> prints a
1193 <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
1194 on the first page of any document (see
1195 <a href="#DOCHEADER_DESC">below</a>
1196 for a description of the docheader).  If you don't want a docheader,
1197 turn it off with
1198 <p>
1199 <pre>
1200         .DOCHEADER OFF
1201 </pre>
1202
1203 <strong>DOCHEADER</strong> is a toggle macro, so the argument doesn't
1204 have to be <strong>OFF</strong>; it can be anything you like.
1205 <p>
1206 If you turn the docheader off, <strong>mom</strong>, by default, starts
1207 your document in the same place she would if the docheader were there.
1208 If you'd like her to start at a different vertical position, give
1209 her the distance you'd like as a second argument.
1210 <p>
1211 <pre>
1212         .DOCHEADER OFF 1.5i
1213 </pre>
1214
1215 This starts the document 1.5 inches from the top of the page.
1216 The distance you give is measured from the top edge of the paper
1217 to the
1218 <a href="definitions.html#TERMS_BASELINE">baseline</a>
1219 of the first line of type.
1220 <p>
1221 <strong>TIP:</strong> Since no document processing happens until
1222 you invoke
1223 <a href="#START">START</a>
1224 -- including anything to do with docheaders -- you can typeset
1225 your own docheader prior to <strong>START</strong> (if you don't
1226 like the way <strong>mom</strong> does things) and use
1227 <strong>DOCHEADER OFF</strong> with its optional distance argument
1228 to ensure that the body of your document starts where you want.
1229 You can even insert a PostScript file (with <strong>.PSPIC</strong>;
1230 see the <strong>grops</strong> man page for usage).
1231
1232 <a name="DOCHEADER_CONTROL"><h3><u>How to change the look of docheaders: docheader control macros</u></h3></a>
1233
1234 <p>
1235 With
1236 <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
1237 the look of docheaders is carved in stone.
1238 In
1239 <a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
1240 however, you can make a lot of changes.  Macros that alter docheaders
1241 MUST come before
1242 <a href="#START">START</a>.
1243 <a name="DOCHEADER_DESC"></a>
1244 <p>
1245 A typeset docheader has the following characteristics.  Note that
1246 title, subtitle, author, and document type are what you supply
1247 with the
1248 <a href="#REFERENCE_MACROS">reference macros</a>.
1249 Any you leave out will not appear; <strong>mom</strong> will
1250 compensate:
1251 <p>
1252 <pre>
1253             TITLE         bold, 3.5 points larger than running text (not necessarily caps)
1254            Subtitle       medium, same size as running text
1255               by          medium italic, same size as running text
1256            Author(s)      medium italic, same size as running text
1257
1258         (Document type)   bold italic, underscored, 3 points larger than running text
1259 </pre>
1260
1261 The
1262 <a href="definitions.html#TERMS_FAMILY">family</a>
1263 is the prevailing family of the whole document.
1264
1265 <h3><u>The docheader macros to:</u></h3>
1266 <ol>
1267         <li><a href="#CHANGE_START">Change the starting position</a>
1268         <li><a href="#ADJUST_LEADING">Adjust the leading</a>
1269         <li><a href="#CHANGE_FAMILY">Change the family of docheader elements</a>
1270         <li><a href="#CHANGE_FONT">Change the font of docheader elements</a>
1271         <li><a href="#CHANGE_SIZE">Adjust the size of docheader elements</a>
1272         <li><a href="#CHANGE_ATTRIBUTE">Change the attribution string (&quot;by&quot;)</a>
1273 </ol>
1274 <p>
1275 <a name="CHANGE_START"><h3><u>1. Change the starting position</u></h3></a>
1276 By default, a docheader starts on the same
1277 <a href="definitions.html#TERMS_BASELINE">baseline</a>
1278 as
1279 <a href="definitions.html#TERMS_RUNNING">running text</a>.
1280 If you'd like it to start somewhere else, use the macro
1281 <kbd>.DOCHEADER_ADVANCE</kbd> and give it the distance you want
1282 (measured from the top edge of the paper to the first baseline
1283 of the docheader), like this:
1284 <p>
1285 <pre>
1286         .DOCHEADER_ADVANCE 4P
1287 </pre>
1288
1289 A
1290 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
1291 is required.
1292 <p>
1293 <strong>NOTE:</strong> If
1294 <a href="headfootpage.html#HEADERS">HEADERS</a>
1295 are <strong>OFF</strong>, <strong>mom</strong>'s normal top
1296 margin for
1297 <a href="definitions.html#TERMS_RUNNING">running text</a>
1298 (7.5
1299 <a href="definitions.html#TERMS_PICASPOINTS">picas</a>)
1300 changes to 6 picas (visually approx. 1 inch).  Since the
1301 first baseline of the docheader falls on the same baseline
1302 as the first line of running text (on pages after page 1),
1303 you might find the docheaders a bit high when headers are off.
1304 Use
1305 <a href="#CHANGE_START">DOCHEADER_ADVANCE</a>
1306 to place them where you want.
1307
1308
1309 <a name="ADJUST_LEADING"><h3><u>2. Adjust the leading</u></h3></a>
1310 The
1311 <a href="definitions.html#TERMS_LEADING">leading</a> of
1312 docheaders is the same as running text.  If you'd like a
1313 different leading, say, 2 points more than the lead of running
1314 text, use:
1315 <p>
1316 <pre>
1317         .DOCHEADER_LEAD +2p
1318 </pre>
1319
1320 Since the leading of docheaders is calculated from the lead of running
1321 text, a + or - sign is required before the argument (how much to add
1322 or subtract from the lead of running text).  The
1323 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
1324 is also required.
1325
1326 <a name="CHANGE_FAMILY"><h3><u>3. Change the family of docheader elements</u></h3></a>
1327 The following macros let you change the
1328 <a href="definitions.html#TERMS_FAMILY">family</a>
1329 of each docheader element separately:
1330 <p>
1331 <ul>
1332 <li><strong>TITLE_FAMILY</strong> <var>&lt;family&gt;</var>
1333 <li><strong>SUBTITLE_FAMILY</strong> <var>&lt;family&gt;</var>
1334 <li><strong>AUTHOR_FAMILY</strong> <var>&lt;family&gt;</var>
1335 <li><strong>DOCTYPE_FAMILY</strong> <var>&lt;family&gt;</var> (if
1336 <a href="#DOCTYPE">DOCTYPE</a> is NAMED)
1337 </ul>
1338 <p>
1339 Simply pass the appropriate macro the family you want.
1340
1341 <a name="CHANGE_FONT"><h3><u>4. Change the font of docheader elements</u></h3></a>
1342 The following macros let you change the
1343 <a href="definitions.html#TERMS_FONT">font</a>
1344 of each docheader element separately:
1345 <p>
1346 <ul>
1347 <li><strong>TITLE_FONT</strong> <var>R | B | I | BI</var>
1348 <li><strong>SUBTITLE_FONT</strong> <var>R | B | I | BI</var>
1349 <li><strong>AUTHOR_FONT</strong> <var>R | B | I | BI</var>
1350 <li><strong>DOCTYPE_FONT</strong> <var>R | B | I | BI</var> (if
1351 <a href="#DOCTYPE">DOCTYPE</a> is NAMED)
1352 </ul>
1353 <p>
1354 Simply pass the appropriate macro the font you want.  <strong>R,
1355 B, I</strong> and <strong>BI</strong> have the same meaning as
1356 they do for
1357 <a href="typesetting.html#FONT">FT</a>.
1358
1359
1360 <a name="CHANGE_SIZE"><h3><u>5. Adjust the size of docheader elements</u></h3></a>
1361 The following macros let you adjust the point size of each docheader
1362 element separately.
1363 <p>
1364 <strong>Mom</strong> calculates the point size
1365 of docheader elements from the point size of paragraphs, so you
1366 must prepend a + or - sign to the argument.  Points is
1367 assumed as the
1368 <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
1369 so there's no need to append a unit to the argument.  Fractional point
1370 sizes are allowed.
1371 <p>
1372 <ul>
1373 <li><strong>TITLE_SIZE</strong> <var>&lt;+/-points&gt;</var>
1374 <br>
1375 default = +3.5 (+4 if docheader title is &quot;Chapter #&quot;)
1376 <li><strong>SUBTITLE_SIZE</strong> <var>&lt;+/-points&gt;</var>
1377 <br>
1378 default = +0
1379 <li><strong>AUTHOR_SIZE</strong> <var>&lt;+/-points&gt;</var>
1380 <br>
1381 default = +0
1382 <li><strong>DOCTYPE_SIZE</strong> <var>&lt;+/-points&gt;</var> (if
1383 <a href="#DOCTYPE">DOCTYPE</a> is NAMED)
1384 <br>
1385 default = +3
1386 </ul>
1387 <p>
1388 Simply pass the appropriate macro the size adjustment you want.
1389
1390 <a name="CHANGE_ATTRIBUTE"><h3><u>6. Change the attribution string (&quot;by&quot;)</u></h3></a>
1391 If you're not writing in English, you can change what
1392 <strong>mom</strong> prints where &quot;by&quot; appears in
1393 docheaders.  For example,
1394 <p>
1395 <pre>
1396         .ATTRIBUTE_STRING "par"
1397 </pre>
1398
1399 changes &quot;by&quot; to &quot;par&quot;.  If you
1400 don't want an attribution string at all, simply pass
1401 <strong>ATTRIBUTE_STRING</strong> an empty argument, like this:
1402 <p>
1403 <pre>
1404         .ATTRIBUTE_STRING ""
1405 </pre>
1406
1407 <strong>Mom</strong> will deposit a blank line where the
1408 attribution string normally appears.
1409 <p>
1410 <strong>NOTE:</strong> The type specs for the attribution line
1411 in docheaders are the same as for the author line.  Although
1412 it's highly unlikely you'll want the attribution line in a
1413 different family, font, or point size, you can do so by using
1414 <a href="definitions.html#TERMS_INLINES">inline escapes</a>
1415 in the argument to <strong>ATTRIBUTE_STRING</strong>.  For
1416 example,
1417 <p>
1418 <pre>
1419         .ATTRIBUTE_STRING "\f[HBI]\*S[-2p] by \*S[+2p]\*[PREV]"
1420 </pre>
1421
1422 would set &quot;by&quot; in Helvetica bold italic, 2 points
1423 smaller than normal.
1424 <br>
1425 <hr>
1426
1427 <!---COLUMNS_INTRO--->
1428
1429 <a name="COLUMNS_INTRO"><h2><u>Setting documents in columns</u></h2></a>
1430
1431 <p>
1432 Setting documents in columns is easy with <strong>mom</strong>.  (Of
1433 course she'd say that, but it's true!)  All you have to do is is
1434 say how many columns you want and how much space you want
1435 between them (the
1436 <a href="definitions.html#TERMS_GUTTER">gutters</a>).
1437 That's it. <strong>Mom</strong> takes care of everything else, from
1438 soup to nuts.
1439 <p>
1440 <strong>SOME WORDS OF ADVICE:</strong>
1441 <p>
1442 If you want your type to achieve a pleasing
1443 <a href="definitions.html#TERMS_JUST">justification</a>
1444 or
1445 <a href="definitions.html#TERMS_RAG">rag</a>
1446 in columns, reduce the point size of type (and probably the
1447 <a href="definitions.html#TERMS_LEADING">leading</a>
1448 as well).  <strong>Mom</strong>'s default document point
1449 size is 12.5, which works well across her default 39
1450 <a href="definitions.html#TERMS_PICASPOINTS">pica</a>
1451 full page line length, but with even just two columns on a page,
1452 the default point size is awkward to work with.
1453 <p>
1454 Furthermore, you'll absolutely need to reduce the indents for
1455 <a href="docelement.html#EPIGRAPH_CONTROL">epigraphs</a>,
1456 <a href="docelement.html#QUOTE_GENERAL">quotes</a>,
1457 and
1458 <a href="docelement.html#BLOCKQUOTE_GENERAL">blockquotes</a>
1459 (and probably the
1460 <a href="docelement.html#PARA_INDENT">paragraph first-line indent</a>
1461 as well).
1462 <br>
1463
1464 <!---COLUMNS--->
1465
1466 <hr width="66%" align="left">
1467 <a name="COLUMNS"><h3><u>COLUMNS</u></h3></a>
1468 <br>
1469 Macro: <strong>COLUMNS</strong> <var>&lt;number of columns&gt; &lt;width of gutters&gt;</var>
1470 <br>
1471 <em>*Should be the last macro before START
1472 <br>
1473 The second argument requires a <a href="#TERMS_UNITOFMEASURE">unit of measure</a></em>
1474
1475 <p>
1476 <strong>COLUMNS</strong> takes two arguments: the number of
1477 columns you want on document pages, and the width of the
1478 <a href="definitions.html#TERMS_GUTTER">gutter</a>
1479 between them.  For example, to set up a page with two columns
1480 separated by an 18 point gutter, you'd do
1481 <p>
1482 <pre>
1483         .COLUMNS 2 18p
1484 </pre>
1485
1486 Nothing to it, really.  However, as noted above,
1487 <strong>COLUMNS</strong> should always be the last document
1488 setup macro prior to
1489 <a href="#START">START</a>.
1490 <p>
1491 <strong>NOTE:</strong> <strong>Mom</strong> ignores columns completely
1492 when the
1493 <a href="#PRINTSTYLE">PRINTSTYLE</a>
1494 is <strong>TYPEWRITE</strong>.  The notion of typewriter-style
1495 output in columns is just too ghastly for her to bear.
1496
1497 <h3><u>Breaking columns manually</u></h3>
1498 <p>
1499 <strong>Mom</strong> takes care of breaking columns when they reach
1500 the bottom margin of a page.  However, there may be times you want to
1501 break the columns yourself.  There are two macros for breaking columns
1502 manually: <strong>COL_NEXT</strong> and <strong>COL_BREAK</strong>.
1503
1504 <a name="COL_NEXT"></a>
1505 <p>
1506 <kbd>.COL_NEXT</kbd> breaks the line just before it,
1507 <a href="definitions.html#TERMS_QUAD">quads</a>
1508 it left (assuming the type is justified or quad left), and moves over
1509 to the top of the next column.  If the column happens to be the last
1510 (rightmost) one on the page, <strong>mom</strong> starts a new page
1511 at the &quot;column 1&quot; position.  This is the macro to use when
1512 you want to start a new column after the end of a paragraph.
1513
1514 <a name="COL_BREAK"></a>
1515 <p>
1516 <kbd>.COL_BREAK</kbd> is almost the same, except that
1517 instead of breaking and quadding the line preceding it,
1518 she breaks and spreads it (see
1519 <a href="typesetting.html#SPREAD">SPREAD</a>).
1520 Use this macro whenever you need to start a new column in the middle
1521 of a paragraph.
1522 <p>
1523 If you need <strong>COL_BREAK</strong> in the middle of a blockquote
1524 or (god help us) an epigraph, you must do the following in order for
1525 <strong>COL_BREAK</strong> to work:
1526 <p>
1527 <pre>
1528         .SPREAD
1529         \!.COL_BREAK
1530 </pre>
1531 <hr>
1532
1533 <!========================================================================>
1534
1535 <a name="START_MACRO">
1536 <h2><u>Initiate document processing</u></h2>
1537 </a>
1538
1539 In order to use <strong>mom</strong>'s document element macros
1540 (tags), you have to tell her you want them.  The macro to do this
1541 is <strong>START</strong>.
1542 <p>
1543 <strong>START</strong> collects the information you gave
1544 <strong>mom</strong> in the setup section at the top of your file (see
1545 <a href="#DOCPROCESSING_TUT">Tutorial -- setting up a mom document</a>),
1546 merges it with her defaults, sets up headers and page numbering,
1547 and prepares <strong>mom</strong> to process your document using
1548 the document element tags.  No document processing takes place until
1549 you invoke <strong>START</strong>.
1550 <br>
1551
1552 <!---START--->
1553
1554 <hr width="66%" align="left">
1555 <p>
1556 <a name="START"></a>
1557 Macro: <strong>START</strong>
1558 <br>
1559 <em>*Required for document processing.</em>
1560
1561 <p>
1562 <strong>START</strong> takes no arguments.  It simply instructs
1563 <strong>mom</strong> to begin document processing.  If you don't
1564 want document processing (i.e. you only want the
1565 <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>),
1566 don't use <strong>START</strong>.
1567 <p>
1568 At a barest minimum before <strong>START</strong>, you must enter a
1569 <a href="#PRINTSTYLE">PRINTSTYLE</a>
1570 command.
1571 <br>
1572 <hr>
1573
1574 <!========================================================================>
1575
1576 <a name="DOC_PARAM_MACROS">
1577 <h2><u>Changing document-wide style parameters after START</u></h2>
1578 </a>
1579
1580 In the normal course of things, you change the basic type
1581 parameters of a document <em>before</em>
1582 <a href="#START">START</a>,
1583 using
1584 <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
1585 (<strong>L_MARGIN, FAMILY, PS, LS,</strong> etc).  After
1586 <strong>START</strong>, you must use the following macros to make
1587 global changes to the basic type parameters of a document.
1588 <br>
1589
1590 <a name="INDEX_DOC_PARAM">
1591         <h3><u>Macro list</u></h3>
1592 </a>
1593 <ul>
1594         <li><a href="#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a>
1595         <li><a href="#DOC_RIGHT_MARGIN">DOC_RIGHT_MARGIN</a>
1596         <li><a href="#DOC_LINE_LENGTH">DOC_LINE_LENGTH</a>
1597         <li><a href="#DOC_FAMILY">DOC_FAMILY</a>
1598         <li><a href="#DOC_PT_SIZE">DOC_PT_SIZE</a>
1599         <li><a href="#DOC_LEAD">DOC_LEAD</a>
1600         <li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
1601         <li><a href="#DOC_QUAD">DOC_QUAD</a>
1602 </ul>
1603
1604 <hr width="66%" align="left">
1605 <p>
1606 <a name="DOC_LEFT_MARGIN">
1607         Macro: <strong>DOC_LEFT_MARGIN</strong> <var>&lt;left margin&gt;</var>
1608 </a>
1609 <br>
1610 <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
1611 <p>
1612 <ul>
1613         <li>the argument is the same as for
1614                 <a href="typesetting.html#L_MARGIN">L_MARGIN</a>
1615         <li>changes all left margins to the new value
1616         <li>the line length remains the same (i.e. the right margin
1617                 shifts when you change the left margin)
1618 </ul>
1619
1620 <br>
1621
1622 <hr width="66%" align="left">
1623 <p>
1624 <a name="DOC_RIGHT_MARGIN">
1625         Macro: <strong>DOC_RIGHT_MARGIN</strong> <var>&lt;right margin&gt;</var>
1626 </a>
1627 <br>
1628 <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
1629 <p>
1630 <ul>
1631         <li>the argument is the same as for
1632                 <a href="typesetting.html#R_MARGIN">R_MARGIN</a>
1633         <li>changes all right margins to the new value
1634         <li>all mom commands that include a right indent calculate
1635                 the indent from the new value
1636 </ul>
1637 <br>
1638
1639 <hr width="66%" align="left">
1640 <p>
1641 <a name="DOC_LINE_LENGTH">
1642         Macro: <strong>DOC_LINE_LENGTH</strong> <var>&lt;length&gt;</var>
1643 </a>
1644 <br>
1645 <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
1646 <p>
1647 <ul>
1648         <li>the argument is the same as for
1649                 <a href="typesetting.html#LL">LL</a>
1650         <li>equivalent to changing the right margin with DOC_RIGHT_MARGIN
1651 </ul>
1652 <br>
1653
1654 <hr width="66%" align="left">
1655 <p>
1656 <a name="DOC_FAMILY">
1657         Macro: <strong>DOC_FAMILY</strong> <var>&lt;family&gt;</var>
1658 </a>
1659 <p>
1660 <ul>
1661         <li>the argument is the same as for
1662                 <a href="typesetting.html#FAMILY">FAMILY</a>
1663         <li>globally changes the type family
1664         <li>if you wish the
1665                 <a href="definitions.html#TERMS_HEADER">header</a>
1666                 and/or page number families to remain at their old values,
1667                 you must reset them with
1668                 <a href="headfootpage.html#HEADER_FAMILY">HEADER_FAMILY</a>
1669                 and
1670                 <a href="headfootpage.html#PAGENUM_FAMILY">PAGENUM_FAMILY</a>
1671 </ul>
1672 <br>
1673
1674 <hr width="66%" align="left">
1675 <p>
1676 <a name="DOC_PT_SIZE">
1677         Macro: <strong>DOC_PT_SIZE</strong> <var>&lt;point size&gt;</var>
1678 </a>
1679 <br>
1680 <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
1681 <p>
1682 <ul>
1683         <li>the argument is the same as for
1684                 <a href="typesetting.html#PS">PS</a>,
1685                 and refers to the point size of type in paragraphs
1686         <li>all automatic point size changes (heads, quotes,
1687                 footnotes, headers, etc.) are affected by the new size;
1688                 anything you do not want affected must be reset to
1689                 its former value (see the Control Macros section of
1690                 the pertinent document element for instructions on
1691                 how to do this)
1692 </ul>
1693 <br>
1694
1695 <hr width="66%" align="left">
1696 <p>
1697 <a name="DOC_LEAD">
1698         Macro: <strong>DOC_LEAD</strong> <var>&lt;points&gt; [ ADJUST ]</var>
1699 </a>
1700 <br>
1701 <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
1702 <p>
1703 <ul>
1704         <li>the argument is the same as for
1705                 <a href="typesetting.html#LS">LS</a>,
1706                 and refers to the
1707                 <a href="definitions.html#TERMS_LEAD">leading</a>
1708                 of paragraphs
1709         <li>because paragraphs will have a new leading, the leading and
1710                 spacing of most running text is influenced by the new value
1711         <li>epigraphs and footnotes remain unaffected;
1712                 if you wish to change their leading, use
1713                 <a href="docelement.html#EPIGRAPH_AUTOLEAD">EPIGRAPH_AUTOLEAD</a>
1714                 and
1715                 <a href="docelement.html#FOOTNOTE_AUTOLEAD">FOOTNOTE_AUTOLEAD</a>.
1716         <li>the optional argument <strong>ADJUST</strong> performs
1717                 leading adjustment as explained in
1718                 <a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
1719 </ul>
1720 <p>
1721 <strong>IMPORTANT:</strong> Do not use <strong>DOC_LEAD</strong>
1722 in the middle of a page!  Always precede it with a manual break
1723 to a new page, like this:
1724 <p>
1725 <pre>
1726         .NEWPAGE
1727         .DOC_LEAD &lt;new value&gt;
1728 </pre>
1729
1730 <hr width="66%" align="left">
1731 <p>
1732 <a name="DOC_QUAD">
1733         Macro: <strong>DOC_QUAD</strong> <var>L | R | C | J</var>
1734 </a>
1735 <p>
1736 <ul>
1737         <li>the arguments are the same as for
1738                 <a href="typesetting.html#QUAD">QUAD</a>
1739         <li>affects paragraphs, epigraphs and footnotes; does not
1740                 affect blockquotes
1741 </ul>
1742
1743 <p>
1744 <hr>
1745 <a href="docelement.html#TOP">Next</a>&nbsp;&nbsp;
1746 <a href="inlines.html#TOP">Prev</a>&nbsp;&nbsp;
1747 <a href="#TOP">Top</a>&nbsp;&nbsp;
1748 <a href="toc.html">Back to Table of Contents</a>
1749 </body>
1750 </html>