1*89a07cf8Schristos<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> 2*89a07cf8Schristos<html> 3*89a07cf8Schristos<head> 4*89a07cf8Schristos<meta http-equiv="content-type" content="text/html;charset=iso-8859-1"> 5*89a07cf8Schristos<title>Mom -- Document Processing, Introduction and Setup</title> 6*89a07cf8Schristos</head> 7*89a07cf8Schristos<body bgcolor="#dfdfdf"> 8*89a07cf8Schristos 9*89a07cf8Schristos<!====================================================================> 10*89a07cf8Schristos 11*89a07cf8Schristos<a href="typemacdoc.html#TOP">Next</a> 12*89a07cf8Schristos<a href="color.html#TOP">Prev</a> 13*89a07cf8Schristos<a href="toc.html">Back to Table of Contents</a> 14*89a07cf8Schristos<p> 15*89a07cf8Schristos<a name="TOP"></a> 16*89a07cf8Schristos<a name="DOCPROCESSING"> 17*89a07cf8Schristos <h1 align="center"><u>DOCUMENT PROCESSING WITH MOM</u></h1> 18*89a07cf8Schristos</a> 19*89a07cf8Schristos<a href="#INTRO_MACROS_DOCPROCESSING">Introduction to document processing</a> 20*89a07cf8Schristos<br> 21*89a07cf8Schristos<a href="#DEFAULTS">Some document defaults</a> 22*89a07cf8Schristos<br> 23*89a07cf8Schristos<a href="#LEADING_NOTE">* IMPORTANT NOTE on leading/spacing and bottom margins *</a> 24*89a07cf8Schristos<br> 25*89a07cf8Schristos<a href="#SHIM">The SHIM macro</a> 26*89a07cf8Schristos<br> 27*89a07cf8Schristos<h3><u>Table of Contents for document processing</u></h3> 28*89a07cf8Schristos<ul> 29*89a07cf8Schristos <li><a href="#SETUP"><strong>DOCUMENT SETUP</strong></a> 30*89a07cf8Schristos <br> 31*89a07cf8Schristos <a href="#DOCPROCESSING_TUT">Tutorial -- Setting up a mom document</a> 32*89a07cf8Schristos <br> 33*89a07cf8Schristos <ul> 34*89a07cf8Schristos <li><a href="#REFERENCE_MACROS"><strong>The Reference Macros</strong></a> 35*89a07cf8Schristos <ul> 36*89a07cf8Schristos <li><a href="#TITLE">TITLE</a> 37*89a07cf8Schristos <li><a href="#DOC_TITLE">DOCTITLE</a> 38*89a07cf8Schristos <li><a href="#SUBTITLE">SUBTITLE</a> 39*89a07cf8Schristos <li><a href="#AUTHOR">AUTHOR</a> 40*89a07cf8Schristos <li><a href="#CHAPTER">CHAPTER</a> 41*89a07cf8Schristos <li><a href="#CHAPTER_TITLE">CHAPTER_TITLE</a> 42*89a07cf8Schristos <li><a href="#DRAFT">DRAFT</a> 43*89a07cf8Schristos <li><a href="#REVISION">REVISION</a> 44*89a07cf8Schristos <li><a href="#COPYRIGHT">COPYRIGHT</a> 45*89a07cf8Schristos <li><a href="#MISC">MISC</a> 46*89a07cf8Schristos </ul> 47*89a07cf8Schristos <li><a href="#DOCSTYLE_MACROS"><strong>The Docstyle Macros</strong></a> 48*89a07cf8Schristos <ul> 49*89a07cf8Schristos <li><a href="#DOCTYPE">DOCTYPE</a> 50*89a07cf8Schristos <li><a href="#PRINTSTYLE">PRINTSTYLE</a> 51*89a07cf8Schristos <li><a href="#COPYSTYLE">COPYSTYLE</a> 52*89a07cf8Schristos </ul> 53*89a07cf8Schristos 54*89a07cf8Schristos <li><a href="#STYLE_BEFORE_START"><strong>Changing type/style parameters prior to START</strong></a> 55*89a07cf8Schristos <ul> 56*89a07cf8Schristos <li><a href="#TYPE_BEFORE_START">Using typesetting macros prior to START</a> 57*89a07cf8Schristos <ul> 58*89a07cf8Schristos <li><a href="#COLOR">Colour</a> 59*89a07cf8Schristos </ul> 60*89a07cf8Schristos <li><a href="#DOC_LEAD_ADJUST">Adjusting document leading to fill pages -- DOC_LEAD_ADJUST</a> 61*89a07cf8Schristos <li><a href="#DOCHEADER">Managing the document header</a> 62*89a07cf8Schristos <ul> 63*89a07cf8Schristos <li><a href="#DOCHEADER">DOCHEADER -- turning docheaders off</a> 64*89a07cf8Schristos <li><a href="#DOCHEADER_CONTROL">Docheader control</a> 65*89a07cf8Schristos </ul> 66*89a07cf8Schristos </ul> 67*89a07cf8Schristos 68*89a07cf8Schristos <li><a href="#COLUMNS_INTRO"><strong>Setting documents in columns</strong></a> 69*89a07cf8Schristos <ul> 70*89a07cf8Schristos <li><a href="#COLUMNS">COLUMNS</a> 71*89a07cf8Schristos <li><a href="#BREAKING_COLUMNS">Breaking columns manually</a> 72*89a07cf8Schristos <ul> 73*89a07cf8Schristos <li><a href="#COL_NEXT">COL_NEXT</a> 74*89a07cf8Schristos <li><a href="#COL_BREAK">COL_BREAK</a> 75*89a07cf8Schristos </ul> 76*89a07cf8Schristos 77*89a07cf8Schristos </ul> 78*89a07cf8Schristos 79*89a07cf8Schristos <li><a href="#START_MACRO"><strong>Initiate document processing</strong></a> 80*89a07cf8Schristos <ul> 81*89a07cf8Schristos <li><a href="#START">START</a> 82*89a07cf8Schristos </ul> 83*89a07cf8Schristos 84*89a07cf8Schristos <li><a href="#DOC_PARAM_MACROS"><strong>Changing document-wide typesetting parameters after START</strong></a> 85*89a07cf8Schristos <ul> 86*89a07cf8Schristos <li><a href="#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a> 87*89a07cf8Schristos <li><a href="#DOC_RIGHT_MARGIN">DOC_RIGHT_MARGIN</a> 88*89a07cf8Schristos <li><a href="#DOC_LINE_LENGTH">DOC_LINE_LENGTH</a> 89*89a07cf8Schristos <li><a href="#DOC_FAMILY">DOC_FAMILY</a> 90*89a07cf8Schristos <li><a href="#DOC_PT_SIZE">DOC_PT_SIZE</a> 91*89a07cf8Schristos <li><a href="#DOC_LEAD">DOC_LEAD</a> 92*89a07cf8Schristos <li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> 93*89a07cf8Schristos <li><a href="#DOC_QUAD">DOC_QUAD</a> 94*89a07cf8Schristos </ul> 95*89a07cf8Schristos <br> 96*89a07cf8Schristos <li><a href="docelement.html#DOCELEMENT"><strong>THE DOCUMENT ELEMENT MACROS (TAGS)</strong></a> 97*89a07cf8Schristos <ul> 98*89a07cf8Schristos <li><a href="docelement.html#DOCELEMENT_INTRO">Introduction to the document element tags</a> 99*89a07cf8Schristos <ul> 100*89a07cf8Schristos <li><a href="docelement.html#DOCELEMENT_CONTROL">Document element (tag) control macros</a> 101*89a07cf8Schristos <li><a href="docelement.html#CONTROL_MACRO_ARGS">Arguments to the control macros</a> 102*89a07cf8Schristos </ul> 103*89a07cf8Schristos <li><a href="docelement.html#EPIGRAPH_INTRO"><strong>Epigraphs</strong></a> 104*89a07cf8Schristos <ul> 105*89a07cf8Schristos <li><a href="docelement.html#EPIGRAPH">EPIGRAPH</a> 106*89a07cf8Schristos <li><a href="docelement.html#EPIGRAPH_CONTROL">Epigrah control</a> 107*89a07cf8Schristos </ul> 108*89a07cf8Schristos <li><a href="docelement.html#PP_INTRO"><strong>Paragraphs</strong></a> 109*89a07cf8Schristos <ul> 110*89a07cf8Schristos <li><a href="docelement.html#PP">PP</a> 111*89a07cf8Schristos <li><a href="docelement.html#PP_CONTROL">Paragraph control</a> 112*89a07cf8Schristos </ul> 113*89a07cf8Schristos <li><a href="docelement.html#HEAD_INTRO"><strong>Main heads</strong></a> 114*89a07cf8Schristos <ul> 115*89a07cf8Schristos <li><a href="docelement.html#HEAD">HEAD</a> 116*89a07cf8Schristos <li><a href="docelement.html#HEAD_CONTROL">Head control</a> 117*89a07cf8Schristos </ul> 118*89a07cf8Schristos <li><a href="docelement.html#SUBHEAD_INTRO"><strong>Subheads</strong></a> 119*89a07cf8Schristos <ul> 120*89a07cf8Schristos <li><a href="docelement.html#SUBHEAD">SUBHEAD</a> 121*89a07cf8Schristos <li><a href="docelement.html#SUBHEAD_CONTROL">Subhead control</a> 122*89a07cf8Schristos </ul> 123*89a07cf8Schristos <li><a href="docelement.html#PARAHEAD_INTRO"><strong>Paragraph heads</strong></a> 124*89a07cf8Schristos <ul> 125*89a07cf8Schristos <li><a href="docelement.html#PARAHEAD">PARAHEAD</a> 126*89a07cf8Schristos <li><a href="docelement.html#PARAHEAD_CONTROL">Parahead control</a> 127*89a07cf8Schristos </ul> 128*89a07cf8Schristos <li><a href="docelement.html#LINEBREAK_INTRO"><strong>Linebreaks (author linebreaks, also called section breaks)</strong></a> 129*89a07cf8Schristos <ul> 130*89a07cf8Schristos <li><a href="docelement.html#LINEBREAK">LINEBREAK</a> 131*89a07cf8Schristos <li><a href="docelement.html#LINEBREAK_CONTROL">Linebreak control</a> 132*89a07cf8Schristos </ul> 133*89a07cf8Schristos <li><a href="docelement.html#QUOTE_INTRO"><strong>Quotes (line for line poetic quotes)</strong></a> 134*89a07cf8Schristos <ul> 135*89a07cf8Schristos <li><a href="docelement.html#QUOTE">QUOTE</a> 136*89a07cf8Schristos <li><a href="docelement.html#QUOTE_CONTROL">Quote control</a> 137*89a07cf8Schristos </ul> 138*89a07cf8Schristos <li><a href="docelement.html#BLOCKQUOTE_INTRO"><strong>Blockquotes (cited material)</strong></a> 139*89a07cf8Schristos <ul> 140*89a07cf8Schristos <li><a href="docelement.html#BLOCKQUOTE">BLOCKQUOTE</a> 141*89a07cf8Schristos <li><a href="docelement.html#BLOCKQUOTE_CONTROL">Blockquote control</a> 142*89a07cf8Schristos </ul> 143*89a07cf8Schristos <li><a href="docelement.html#FOOTNOTE_INTRO"><strong>Footnotes</strong></a> 144*89a07cf8Schristos <ul> 145*89a07cf8Schristos <li><a href="docelement.html#FOOTNOTE">FOOTNOTE</a> 146*89a07cf8Schristos <li><a href="docelement.html#FOOTNOTE_CONTROL">Footnote control</a> 147*89a07cf8Schristos </ul> 148*89a07cf8Schristos <li><a href="docelement.html#ENDNOTE_INTRO"><strong>Endnotes</strong></a> 149*89a07cf8Schristos <ul> 150*89a07cf8Schristos <li><a href="docelement.html#ENDNOTE">ENDNOTE</a> 151*89a07cf8Schristos <li><a href="docelement.html#ENDNOTE_CONTROL">Endnote control</a> 152*89a07cf8Schristos </ul> 153*89a07cf8Schristos <li><a href="docelement.html#FINIS_INTRO"><strong>Document termination</strong></a> 154*89a07cf8Schristos <ul> 155*89a07cf8Schristos <li><a href="docelement.html#FINIS">FINIS</a> 156*89a07cf8Schristos <li><a href="docelement.html#FINIS_CONTROL">Finis control</a> 157*89a07cf8Schristos </ul> 158*89a07cf8Schristos </ul> 159*89a07cf8Schristos 160*89a07cf8Schristos <li><a href="headfootpage.html#HEADFOOTPAGE"><strong>HEADERS and FOOTERS</strong></a> 161*89a07cf8Schristos <br> 162*89a07cf8Schristos <ul> 163*89a07cf8Schristos <li><a href="headfootpage.html#HEADFOOTPAGE_INTRO">Introduction to headers/footers</a> 164*89a07cf8Schristos <li><a href="headfootpage.html#HEADFOOT_MANAGEMENT">Managing headers/footers</a> 165*89a07cf8Schristos <ul> 166*89a07cf8Schristos <li><a href="headfootpage.html#HEADERS">HEADERS</a> -- on or off 167*89a07cf8Schristos <li><a href="headfootpage.html#FOOTERS">FOOTERS</a> -- on or off 168*89a07cf8Schristos <li><a href="headfootpage.html#FOOTER_ON_FIRST_PAGE">FOOTER_ON_FIRST_PAGE</a> 169*89a07cf8Schristos </ul> 170*89a07cf8Schristos <li><a href="headfootpage.html#HEADFOOT_CONTROL">Header/footer control</a> 171*89a07cf8Schristos <ul> 172*89a07cf8Schristos <li><a href="headfootpage.html#HDRFTR_STRINGS">Header/footer strings</a> 173*89a07cf8Schristos <li><a href="headfootpage.html#HDRFTR_STYLE">Header/footer style</a> -- global and part-by-part 174*89a07cf8Schristos <li><a href="headfootpage.html#HDRFTR_VERTICAL">Header/footer placement and spacing</a> 175*89a07cf8Schristos <li><a href="headfootpage.html#HDRFTR_SEPARATOR">The header/footer separator rule</a> 176*89a07cf8Schristos </ul> 177*89a07cf8Schristos </ul> 178*89a07cf8Schristos <li><a href="headfootpage.html#PAGINATION"><strong>PAGINATION</strong></a> 179*89a07cf8Schristos <br> 180*89a07cf8Schristos <ul> 181*89a07cf8Schristos <li><a href="headfootpage.html#PAGINATE">PAGINATE</a> -- on or off 182*89a07cf8Schristos <li><a href="headfootpage.html#PAGENUMBER">PAGENUMBER</a> -- user supplied page number 183*89a07cf8Schristos <li><a href="headfootpage.html#PAGENUM_STYLE">PAGENUM_STYLE</a> -- digits, roman numerals, etc. 184*89a07cf8Schristos <li><a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a> -- attach draft/revision information to page numbers 185*89a07cf8Schristos <li><a href="headfootpage.html#PAGINATE_CONTROL">Pagination control</a> 186*89a07cf8Schristos </ul> 187*89a07cf8Schristos <br> 188*89a07cf8Schristos <li><a href="rectoverso.html#RECTOVERSO"><strong>RECTO_VERSO PRINTING and COLLATING</strong></a> 189*89a07cf8Schristos <br> 190*89a07cf8Schristos <ul> 191*89a07cf8Schristos <li><a href="rectoverso.html#RECTOVERSO_INTRO">Introduction to recto/verso</a> 192*89a07cf8Schristos <ul> 193*89a07cf8Schristos <li><a href="rectoverso.html#RECTO_VERSO">RECTO_VERSO</a> 194*89a07cf8Schristos <li><a href="rectoverso.html#SWITCH_HDRFTR">SWITCH_HEADERS</a> (also FOOTERS) 195*89a07cf8Schristos </ul> 196*89a07cf8Schristos <li><a href="rectoverso.html#COLLATE_INTRO">Introduction to collating</a> 197*89a07cf8Schristos <ul> 198*89a07cf8Schristos <li><a href="rectoverso.html#COLLATE">COLLATE</a> 199*89a07cf8Schristos </ul> 200*89a07cf8Schristos </ul> 201*89a07cf8Schristos 202*89a07cf8Schristos <li><a href="cover.html#TOP"><strong>CREATING A COVER PAGE</strong></a> 203*89a07cf8Schristos <br> 204*89a07cf8Schristos <li><a href="letters.html#LETTERS"><strong>WRITING LETTERS</strong></a> 205*89a07cf8Schristos <ul> 206*89a07cf8Schristos <li><a href="letters.html#LETTERS_INTRO">Introduction to writing letters</a> 207*89a07cf8Schristos <li><a href="letters.html#TUTORIAL">Tutorial on writing letters</a> 208*89a07cf8Schristos <li><a href="letters.html#LETTERS_DEFAULTS">Default style for letters</a> 209*89a07cf8Schristos <li><a href="letters.html#LETTERS_MACROS">The letter macros</a> 210*89a07cf8Schristos </ul> 211*89a07cf8Schristos </ul> 212*89a07cf8Schristos</ul> 213*89a07cf8Schristos<br> 214*89a07cf8Schristos<hr> 215*89a07cf8Schristos 216*89a07cf8Schristos<h2><a name="INTRO_MACROS_DOCPROCESSING"><u>Introduction to document processing</u></a></h2> 217*89a07cf8Schristos 218*89a07cf8SchristosAs explained in 219*89a07cf8Schristos<a href="intro.html#INTRO_DOCPROCESSING">Document processing with mom</a>, 220*89a07cf8Schristosdocument processing uses markup tags to identify document elements 221*89a07cf8Schristossuch as heads, paragraphs, and so on. The tags are, of course, macros, 222*89a07cf8Schristosbut with sensible, readable names that make them easy to grasp and 223*89a07cf8Schristoseasy to remember. (And don't forget: if you don't like the 224*89a07cf8Schristos"official" name of a tag -- too long, cumbersome 225*89a07cf8Schristosto type in, not "intuitive" enough -- you can change it 226*89a07cf8Schristoswith the 227*89a07cf8Schristos<a href="goodies.html#ALIAS">ALIAS</a> 228*89a07cf8Schristosmacro.) 229*89a07cf8Schristos<p> 230*89a07cf8SchristosIn addition to the tags themselves, <strong>mom</strong> has an 231*89a07cf8Schristosextensive array of macros that control how they look and behave. 232*89a07cf8Schristos<p> 233*89a07cf8SchristosSetting up a <strong>mom</strong> doc is a simple, four-part procedure. 234*89a07cf8SchristosYou begin by entering information about the document itself (title, 235*89a07cf8Schristossubtitle, author, etc.). Next, you tell <strong>mom</strong> what 236*89a07cf8Schristoskind of document you're creating (e.g. chapter, letter, abstract, 237*89a07cf8Schristosetc...) and what kind of output you want (typeset, typewritten, 238*89a07cf8Schristosdraft-style, etc). Thirdly, you make as many or as few changes to 239*89a07cf8Schristos<strong>mom</strong>'s default behaviour as you wish. Lastly, you 240*89a07cf8Schristosinvoke the 241*89a07cf8Schristos<a href="#START">START</a> 242*89a07cf8Schristosmacro. Voil�! You're ready to write. 243*89a07cf8Schristos<p> 244*89a07cf8Schristos<hr> 245*89a07cf8Schristos 246*89a07cf8Schristos 247*89a07cf8Schristos<h2><a name="DEFAULTS"><u>Some document defaults</u></a></h2> 248*89a07cf8Schristos 249*89a07cf8SchristosAs is to be expected, <strong>mom</strong> has defaults for everything. 250*89a07cf8SchristosIf you want to know a particular default, read about it in the 251*89a07cf8Schristosdescription of the pertinent tag. 252*89a07cf8Schristos<p> 253*89a07cf8SchristosI fear the following may not be adequately covered in the 254*89a07cf8Schristosdocumentation. Just in case, here they are. 255*89a07cf8Schristos<p> 256*89a07cf8Schristos<ul> 257*89a07cf8Schristos <li>the paper size is 8.5x11 inches 258*89a07cf8Schristos <li>the left and right margins are 1-inch 259*89a07cf8Schristos <li>the top and bottom margins for document text are plus/minus 260*89a07cf8Schristos visually 1-inch 261*89a07cf8Schristos <li>pages are numbered; the number appears centred, at the 262*89a07cf8Schristos bottom, surrounded by hyphens ( e.g. -6- ) 263*89a07cf8Schristos <li>the first page of a document begins with a 264*89a07cf8Schristos <a href="definitions.html#TERMS_DOCHEADER">document header</a> 265*89a07cf8Schristos <li>subsequent pages have 266*89a07cf8Schristos <a href="definitions.html#TERMS_HEADER">page headers</a> 267*89a07cf8Schristos with a rule underneath 268*89a07cf8Schristos</ul> 269*89a07cf8Schristos<p> 270*89a07cf8SchristosAnother way to check up on document processing defaults is to have 271*89a07cf8Schristosa look at the macro file (om.tmac). Each macro is preceded by a 272*89a07cf8Schristosdescription that (generally) says what its default is (if it has 273*89a07cf8Schristosone). 274*89a07cf8Schristos<p> 275*89a07cf8Schristos<hr> 276*89a07cf8Schristos 277*89a07cf8Schristos<a name="LEADING_NOTE"> 278*89a07cf8Schristos <h2><u>IMPORTANT NOTE on leading/spacing and bottom margins</u></h2> 279*89a07cf8Schristos</a> 280*89a07cf8Schristos 281*89a07cf8Schristos<strong>Mom</strong> takes evenly-aligned bottom margins in 282*89a07cf8Schristos<a href="definitions.html#TERMS_RUNNING">running text</a> 283*89a07cf8Schristosvery seriously. Only under a very few (exceptional) circumstances 284*89a07cf8Schristoswill she allow a bottom margin to "hang" (i.e. to fall 285*89a07cf8Schristosshort). 286*89a07cf8Schristos<p> 287*89a07cf8SchristosIn order to ensure even bottom margins, <strong>mom</strong> 288*89a07cf8Schristosuses the "base" document 289*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 290*89a07cf8Schristosin effect <em>at the start of running text on each page</em> (i.e. 291*89a07cf8Schristosthe leading used in paragraphs) to calculate the spacing of every 292*89a07cf8Schristosdocument element. Prior to invoking 293*89a07cf8Schristos<a href="#START">START</a>, 294*89a07cf8Schristosthis is set with the 295*89a07cf8Schristos<a href="typesetting.html#MACROS_TYPESETTING">typesetting macro</a> 296*89a07cf8Schristos<a href="typesetting.html#LEADING">LS</a>, 297*89a07cf8Schristosafterwards with the document 298*89a07cf8Schristos<a href="definitions.html#TERMS_CONTROLMACRO">control macro</a> 299*89a07cf8Schristos<a href="#DOC_LEAD">DOC_LEAD</a>. 300*89a07cf8Schristos<p> 301*89a07cf8SchristosBecause <strong>mom</strong> relies so heavily on the base document 302*89a07cf8Schristosleading, any change to the leading or spacing on a page will almost 303*89a07cf8Schristoscertainly have undesirable consequences on that page's bottom margin 304*89a07cf8Schristosunless the change is fully compensated for elsewhere on the page. 305*89a07cf8Schristos<p> 306*89a07cf8SchristosIn other words, if you add a few points of space somewhere on a page, 307*89a07cf8Schristosyou must subtract the same number of points somewhere else on that 308*89a07cf8Schristossame page, and vice versa. 309*89a07cf8Schristos<p> 310*89a07cf8SchristosIf it's a question of adding or subtracting full line spaces between 311*89a07cf8Schristosor within document elements, you can do so by using the "v" 312*89a07cf8Schristos<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 313*89a07cf8Schristoswith whatever spacing macro you choose -- 314*89a07cf8Schristos<a href="typesetting.html#ALD">ALD</a>, 315*89a07cf8Schristos<a href="typesetting.html#RLD">RLD</a>, 316*89a07cf8Schristos<a href="typesetting.html#SPACE">SPACE</a> 317*89a07cf8Schristos-- and <strong>mom</strong> won't object. "v" means 318*89a07cf8Schristos"the current leading", so she isn't confused by it. And 319*89a07cf8Schristossince "v" accepts decimal fractions, you can add/subtract 320*89a07cf8Schristoshalf linespaces and quarter linespaces with "v" as well, 321*89a07cf8Schristos<em>provided you compensate for the fractional linespace somewhere 322*89a07cf8Schristoselse on the page</em>. 323*89a07cf8Schristos<p> 324*89a07cf8SchristosIf all this seems like too much work, <strong>mom</strong> 325*89a07cf8Schristosprovides a special macro to get you out of trouble if you've played 326*89a07cf8Schristosaround with leading and/or spacing. The macro is called 327*89a07cf8Schristos<strong>SHIM</strong> (like those little pieces of wood carpenters 328*89a07cf8Schristosuse to get their work even, level and snug), and it's described 329*89a07cf8Schristosbelow. 330*89a07cf8Schristos<p> 331*89a07cf8Schristos 332*89a07cf8Schristos<!---SHIM---> 333*89a07cf8Schristos 334*89a07cf8Schristos<hr width="66%" align="left"> 335*89a07cf8Schristos<p> 336*89a07cf8Schristos<a name="SHIM"></a> 337*89a07cf8SchristosMacro: <strong>SHIM</strong> 338*89a07cf8Schristos 339*89a07cf8Schristos<p> 340*89a07cf8Schristos<strong>SHIM</strong> doesn't take any argument. Use it whenever 341*89a07cf8Schristosyou've played around with the 342*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 343*89a07cf8Schristosor spacing on a page and you 344*89a07cf8Schristosneed to get <strong>mom</strong>'s document leading back on track. 345*89a07cf8Schristos<p> 346*89a07cf8SchristosFor example, say you want to insert a picture into a document with 347*89a07cf8Schristosthe special groff macro, <strong>PSPIC</strong> (see the 348*89a07cf8Schristos<strong>groff_tmac</strong> man page for usage). 349*89a07cf8Schristos<p> 350*89a07cf8SchristosPictures aren't usually conveniently sized in multiples of document 351*89a07cf8Schristosleading, which means that when you insert the picture, you disrupt 352*89a07cf8Schristos<strong>mom</strong>'s ordered placement of baselines on the page. 353*89a07cf8SchristosThis will certainly result in a bottom margin that doesn't match the 354*89a07cf8Schristosbottom margins of your document's other pages. 355*89a07cf8Schristos<p> 356*89a07cf8SchristosThe solution is to insert <strong>SHIM</strong> after the picture, 357*89a07cf8Schristoslike this: 358*89a07cf8Schristos<p> 359*89a07cf8Schristos<pre> 360*89a07cf8Schristos <some lines of text> 361*89a07cf8Schristos .PSPIC <full path to picture> 362*89a07cf8Schristos .SHIM 363*89a07cf8Schristos <more lines of text> 364*89a07cf8Schristos</pre> 365*89a07cf8Schristos<strong>SHIM</strong> instructs <strong>mom</strong> to insert as 366*89a07cf8Schristosmuch or a little space after the picture as is needed to ensure that 367*89a07cf8Schristosthe baseline of the next 368*89a07cf8Schristos<a href="definitions.html#TERMS_OUTPUTLINE">output line</a> 369*89a07cf8Schristosfalls where <strong>mom</strong> would have put it had you not 370*89a07cf8Schristosdisrupted the normal flow of output lines with the picture. 371*89a07cf8Schristos<p> 372*89a07cf8SchristosAnd say, on previewing the above example, you find that the picture 373*89a07cf8Schristosdoesn't centre nicely between the lines of text, you can always do 374*89a07cf8Schristos<p> 375*89a07cf8Schristos<pre> 376*89a07cf8Schristos <some lines of text> 377*89a07cf8Schristos .RLD 3p 378*89a07cf8Schristos .PSPIC <full path to picture> 379*89a07cf8Schristos .SHIM 380*89a07cf8Schristos <more lines of text> 381*89a07cf8Schristos</pre> 382*89a07cf8Schristos 383*89a07cf8Schristosto raise the picture slightly 384*89a07cf8Schristos(<strong>R</strong>everse <strong>L</strong>ea<strong>D</strong> 385*89a07cf8Schristos3 points; see 386*89a07cf8Schristos<a href="typesetting.html#RLD">RLD</a>), 387*89a07cf8Schristosand still have <strong>SHIM</strong> ensure that text underneath 388*89a07cf8Schristosfalls exactly where it's supposed to. 389*89a07cf8Schristos<p> 390*89a07cf8Schristos<hr> 391*89a07cf8Schristos 392*89a07cf8Schristos<a name="SETUP"><h2><u>Document setup</u></h2></a> 393*89a07cf8Schristos<p> 394*89a07cf8Schristos<a name="DOCPROCESSING_TUT"> 395*89a07cf8Schristos <h3><u>Tutorial -- Setting up a mom document</u></h3> 396*89a07cf8Schristos</a> 397*89a07cf8SchristosThere are four "parts" to setting up a <strong>mom</strong> 398*89a07cf8Schristosdoc (three, actually, with one optional). Before we proceed, though, 399*89a07cf8Schristosbe reassured that something as simple as 400*89a07cf8Schristos<p> 401*89a07cf8Schristos<pre> 402*89a07cf8Schristos .TITLE "By the Shores of Lake Attica" 403*89a07cf8Schristos .AUTHOR "Rosemary Winspeare" 404*89a07cf8Schristos .PRINTSTYLE TYPESET 405*89a07cf8Schristos .START 406*89a07cf8Schristos</pre> 407*89a07cf8Schristos 408*89a07cf8Schristosproduces a beautifully typeset 8.5x11 document, with a 409*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a> 410*89a07cf8Schristosat the top of page 1, 411*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a> 412*89a07cf8Schristoswith the title and author on subsequent 413*89a07cf8Schristospages, and page numbers at the bottom of each page. In the course 414*89a07cf8Schristosof the document, heads, subheads, citations, quotes, epigraphs, 415*89a07cf8Schristosand so on, all come out looking neat, trim, and professional. 416*89a07cf8Schristos<p> 417*89a07cf8SchristosFor the purposes of this tutorial, we're going to set up a short 418*89a07cf8Schristosstory -- <em>My Pulitzer Winner</em> by Joe Blow. Thankfully, 419*89a07cf8Schristoswe don't have to look at story itself, just the setup. 420*89a07cf8SchristosJoe wants the document 421*89a07cf8Schristos<p> 422*89a07cf8Schristos<ul> 423*89a07cf8Schristos <li>to be draft 7, revision 39; 424*89a07cf8Schristos <li>to use the "default" style of document formatting: 425*89a07cf8Schristos <li>to print as draft-style output (instead of "final" copy output); 426*89a07cf8Schristos <li>to be typeset, in Helvetica, 12 on 14, 427*89a07cf8Schristos <a href="definitions.html#TERMS_RAG">rag-right</a>; 428*89a07cf8Schristos <li>to have <a href="definitions.html#TERMS_FOOTER">footers</a> 429*89a07cf8Schristos instead of 430*89a07cf8Schristos <a href="definitions.html#TERMS_HEADER">headers</a>; 431*89a07cf8Schristos <li>to use a single asterisk for 432*89a07cf8Schristos <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>. 433*89a07cf8Schristos</ul> 434*89a07cf8Schristos<p> 435*89a07cf8SchristosJoe Blow has no taste in typography. His draft won't look pretty, 436*89a07cf8Schristosbut this is, after all, a tutorial; we're after examples, not beauty. 437*89a07cf8Schristos<h3><u>Step 1</u></h3> 438*89a07cf8Schristos 439*89a07cf8SchristosThe first step in setting up any document is giving <strong>mom</strong> 440*89a07cf8Schristossome reference information. The reference macros are: 441*89a07cf8Schristos<p> 442*89a07cf8Schristos<ul> 443*89a07cf8Schristos <li>TITLE 444*89a07cf8Schristos <li>DOCTITLE 445*89a07cf8Schristos <li>COVERTITLE 446*89a07cf8Schristos <li>SUBTITLE 447*89a07cf8Schristos <li>AUTHOR 448*89a07cf8Schristos <li>CHAPTER -- the chapter number 449*89a07cf8Schristos <li>DRAFT -- the draft number 450*89a07cf8Schristos <li>REVISION -- the revision number 451*89a07cf8Schristos <li>COPYRIGHT -- only used on cover pages 452*89a07cf8Schristos <li>MISC -- only used on cover pages 453*89a07cf8Schristos <li>COVER_TITLE -- only on cover pages; only if needed 454*89a07cf8Schristos <li>DOC_COVER_TITLE -- only on document cover pages; only if needed 455*89a07cf8Schristos</ul> 456*89a07cf8Schristos<p> 457*89a07cf8SchristosYou can use as many or as few as you wish, although at a minimum, 458*89a07cf8Schristosyou'll probably fill in <strong>TITLE</strong> (unless the document's 459*89a07cf8Schristosa letter) and <strong>AUTHOR</strong>. Order doesn't matter. 460*89a07cf8SchristosYou can separate the 461*89a07cf8Schristos<a href="definitions.html#TERMS_ARGUMENTS">arguments</a> 462*89a07cf8Schristosfrom the macros by any number of spaces. The following are 463*89a07cf8Schristoswhat you'd need to start Joe Blow's story. 464*89a07cf8Schristos<p> 465*89a07cf8Schristos<pre> 466*89a07cf8Schristos .TITLE "My Pulitzer Winner" 467*89a07cf8Schristos .AUTHOR "Joe Blow" 468*89a07cf8Schristos .DRAFT 7 469*89a07cf8Schristos .REVISION 39 470*89a07cf8Schristos</pre> 471*89a07cf8Schristos 472*89a07cf8Schristos<h3><u>Step 2</u></h3> 473*89a07cf8Schristos 474*89a07cf8SchristosOnce you've given <strong>mom</strong> the reference information she 475*89a07cf8Schristosneeds, you tell her how you want your document formatted. What kind 476*89a07cf8Schristosof document is it? Should it be typeset or typewritten? Is this 477*89a07cf8Schristosa "final" copy (for the world to see) or just a draft? 478*89a07cf8Schristos<strong>Mom</strong> calls the macros that answer these questions 479*89a07cf8Schristos"the docstyle macros." They are: 480*89a07cf8Schristos<p> 481*89a07cf8Schristos<ul> 482*89a07cf8Schristos <li>DOCTYPE -- the type of document (default, chapter, user-defined, letter) 483*89a07cf8Schristos <li>PRINTSTYLE -- typeset or typewritten 484*89a07cf8Schristos <li>COPYSTYLE -- draft or final copy 485*89a07cf8Schristos</ul> 486*89a07cf8Schristos<p> 487*89a07cf8Schristos<strong>Mom</strong> has defaults for <strong>DOCTYPE</strong> 488*89a07cf8Schristosand <strong>COPYSTYLE</strong>; if they're what you want, you 489*89a07cf8Schristosdon't need to include them here. However, <strong>PRINTSTYLE</strong> 490*89a07cf8Schristoshas no default and MUST be present in every formatted document. 491*89a07cf8SchristosIf you omit it, <strong>mom</strong> won't process the document AND 492*89a07cf8Schristosshe'll complain (both to stderr and as a single printed sheet with 493*89a07cf8Schristosa warning). Moms -- they can be so annoying sometimes. <sigh> 494*89a07cf8Schristos<p> 495*89a07cf8SchristosAdding to what we already have, the next bit of setup for Joe 496*89a07cf8SchristosBlow's story looks like this: 497*89a07cf8Schristos<p> 498*89a07cf8Schristos<pre> 499*89a07cf8Schristos .TITLE "My Pulitzer Winner" 500*89a07cf8Schristos .AUTHOR "Joe Blow" 501*89a07cf8Schristos .DRAFT 7 502*89a07cf8Schristos .REVISION 39 503*89a07cf8Schristos \# 504*89a07cf8Schristos .DOCTYPE DEFAULT \"Superfluous; mom uses DOCTYPE DEFAULT by default 505*89a07cf8Schristos .PRINTSTYLE TYPESET 506*89a07cf8Schristos .COPYSTYLE DRAFT 507*89a07cf8Schristos</pre> 508*89a07cf8Schristos 509*89a07cf8SchristosNotice the use of the 510*89a07cf8Schristos<a href="definitions.html#TERMS_COMMENTLINES">comment line</a> 511*89a07cf8Schristos( \# ), a handy way to keep groups of macros visually separated 512*89a07cf8Schristosfor easy reading in a text editor. 513*89a07cf8Schristos 514*89a07cf8Schristos<h3><u>Step 3</u></h3> 515*89a07cf8Schristos 516*89a07cf8SchristosThis step -- completely optional -- is where you, the user, take 517*89a07cf8Schristoscharge. <strong>Mom</strong> has defaults for <em>everything</em>, 518*89a07cf8Schristosbut who's ever satisfied with defaults? Use any of the <a 519*89a07cf8Schristoshref="typesetting.html#MACROS_TYPESETTING">typesetting macros</a> 520*89a07cf8Schristoshere to change <strong>mom</strong>'s document defaults (paper 521*89a07cf8Schristossize, margins, family, point size, line space, rag, etc), or 522*89a07cf8Schristosany of the document processing macros that set/change/control 523*89a07cf8Schristosthe appearance of document elements. Think of this as the 524*89a07cf8Schristos"style-sheet " section of a document. And please note: 525*89a07cf8Schristosyou MUST give <strong>mom</strong> a 526*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE</a> 527*89a07cf8Schristosdirective <strong>before</strong> making any such changes. 528*89a07cf8Schristos<p> 529*89a07cf8SchristosJoe Blow wants his story printed in Helvetica, 12 on 14, rag 530*89a07cf8Schristosright, with 531*89a07cf8Schristos<a href="definitions.html#TERMS_FOOTER">page footers</a> 532*89a07cf8Schristosinstead of 533*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a> 534*89a07cf8Schristosand a single asterisk for the 535*89a07cf8Schristos<a href="definitions.html#TERMS_LINEBREAK">linebreak</a> 536*89a07cf8Schristoscharacter. None of these requirements conforms 537*89a07cf8Schristosto <strong>mom</strong>'s defaults for the chosen 538*89a07cf8Schristos<strong>PRINTSTYLE</strong> (TYPESET), so we change them here. 539*89a07cf8SchristosThe setup for Joe Blow's story now looks like this: 540*89a07cf8Schristos<p> 541*89a07cf8Schristos<pre> 542*89a07cf8Schristos .TITLE "My Pulitzer Winner" 543*89a07cf8Schristos .AUTHOR "Joe Blow" 544*89a07cf8Schristos .DRAFT 7 545*89a07cf8Schristos .REVISION 39 546*89a07cf8Schristos \# 547*89a07cf8Schristos .DOCTYPE DEFAULT 548*89a07cf8Schristos .PRINTSTYLE TYPESET 549*89a07cf8Schristos .COPYSTYLE DRAFT 550*89a07cf8Schristos \# 551*89a07cf8Schristos .FAMILY H 552*89a07cf8Schristos .PT_SIZE 12 553*89a07cf8Schristos .LS 14 554*89a07cf8Schristos .QUAD LEFT \"i.e. rag right 555*89a07cf8Schristos .FOOTERS 556*89a07cf8Schristos .LINEBREAK_CHAR * 557*89a07cf8Schristos</pre> 558*89a07cf8Schristos 559*89a07cf8Schristos<h3><u>Step 4</u></h3> 560*89a07cf8SchristosThe final step in setting up a document is telling <strong>mom</strong> 561*89a07cf8Schristosto start document processing. It's a no-brainer, just the single macro 562*89a07cf8Schristos<strong>START</strong>. Other than <strong>PRINTSTYLE</strong>, it's 563*89a07cf8Schristosthe only macro required for document processing (although 564*89a07cf8SchristosI can't guarantee you'll like the results of using just the two). 565*89a07cf8Schristos<p> 566*89a07cf8SchristosHere's the complete setup for <em>My Pulitzer Winner</em>: 567*89a07cf8Schristos<p> 568*89a07cf8Schristos<pre> 569*89a07cf8Schristos .TITLE "My Pulitzer Winner" 570*89a07cf8Schristos .AUTHOR "Joe Blow" 571*89a07cf8Schristos .DRAFT 7 572*89a07cf8Schristos .REVISION 39 573*89a07cf8Schristos \# 574*89a07cf8Schristos .DOCTYPE DEFAULT 575*89a07cf8Schristos .PRINTSTYLE TYPESET 576*89a07cf8Schristos .COPYSTYLE DRAFT 577*89a07cf8Schristos \# 578*89a07cf8Schristos .FAMILY H 579*89a07cf8Schristos .PT_SIZE 12 580*89a07cf8Schristos .LS 14 581*89a07cf8Schristos .QUAD LEFT \"i.e. rag right 582*89a07cf8Schristos .FOOTERS 583*89a07cf8Schristos .LINEBREAK_CHAR * 584*89a07cf8Schristos \# 585*89a07cf8Schristos .START 586*89a07cf8Schristos</pre> 587*89a07cf8Schristos 588*89a07cf8SchristosAs pointed out earlier, Joe Blow is no typographer. Given that all he 589*89a07cf8Schristosneeds is a printed draft of his work, a simpler setup would have been: 590*89a07cf8Schristos<p> 591*89a07cf8Schristos<pre> 592*89a07cf8Schristos .TITLE "My Pulitzer Winner" 593*89a07cf8Schristos .AUTHOR "Joe Blow" 594*89a07cf8Schristos .DRAFT 7 595*89a07cf8Schristos .REVISION 39 596*89a07cf8Schristos \# 597*89a07cf8Schristos .PRINTSTYLE TYPEWRITE 598*89a07cf8Schristos .COPYSTYLE DRAFT 599*89a07cf8Schristos \# 600*89a07cf8Schristos .START 601*89a07cf8Schristos</pre> 602*89a07cf8Schristos 603*89a07cf8Schristos<kbd>.PRINTSTYLE TYPEWRITE</kbd>, above, means that Joe's work 604*89a07cf8Schristoswill come out "typewritten, double-spaced", making the 605*89a07cf8Schristosblue-pencilling he (or someone else) is sure to do much 606*89a07cf8Schristoseasier (which is why many publishers and agents still insist on 607*89a07cf8Schristostypewritten, double-spaced copy). 608*89a07cf8Schristos<p> 609*89a07cf8SchristosWhen J. Blow stops re-writing and decides to print off a final, 610*89a07cf8Schristostypeset copy of his work for the world to see, he need only 611*89a07cf8Schristosmake two changes to the (simplified) setup: 612*89a07cf8Schristos<p> 613*89a07cf8Schristos<pre> 614*89a07cf8Schristos .TITLE "My Pulitzer Winner" 615*89a07cf8Schristos .AUTHOR "Joe Blow" 616*89a07cf8Schristos .DRAFT 7 617*89a07cf8Schristos .REVISION 39 618*89a07cf8Schristos \# 619*89a07cf8Schristos .PRINTSTYLE TYPESET \"first change 620*89a07cf8Schristos .COPYSTYLE FINAL \"second change 621*89a07cf8Schristos \# 622*89a07cf8Schristos .START 623*89a07cf8Schristos</pre> 624*89a07cf8Schristos 625*89a07cf8SchristosIn the above, <kbd>.DRAFT 7, .REVISION 39,</kbd> and <kbd>.COPYSTYLE 626*89a07cf8SchristosFINAL</kbd> are actually superfluous. The draft and revision numbers 627*89a07cf8Schristosaren't used when <strong>COPYSTYLE</strong> is <strong>FINAL</strong>, 628*89a07cf8Schristosand <strong>COPYSTYLE FINAL</strong> is <strong>mom</strong>'s 629*89a07cf8Schristosdefault unless you tell her otherwise. BUT... to judge from the 630*89a07cf8Schristosnumber of drafts already, J. Blow may very well decide his 631*89a07cf8Schristos"final" version still isn't up to snuff. Hence, he might 632*89a07cf8Schristosas well leave in the superfluous macros. That way, when draft 7, 633*89a07cf8Schristosrev. 62 becomes draft 8, rev. 1, he'll be ready to tackle his Pulitzer 634*89a07cf8Schristoswinner again. 635*89a07cf8Schristos<p> 636*89a07cf8Schristos<hr> 637*89a07cf8Schristos 638*89a07cf8Schristos<!========================================================================> 639*89a07cf8Schristos 640*89a07cf8Schristos<a name="REFERENCE_MACROS"> 641*89a07cf8Schristos <h2><u>The Reference Macros</u></h2> 642*89a07cf8Schristos</a> 643*89a07cf8Schristos 644*89a07cf8SchristosThe reference macros give <strong>mom</strong> the information 645*89a07cf8Schristosshe needs to generate 646*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheaders</a>, 647*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>, 648*89a07cf8Schristosand 649*89a07cf8Schristos<a href="cover.html#COVER_TOP">covers</a>. 650*89a07cf8SchristosThey must go at the top of any file that uses <strong>mom</strong>'s 651*89a07cf8Schristosdocument processing macros. 652*89a07cf8Schristos<p> 653*89a07cf8Schristos<a name="INDEX_REFERENCE"> 654*89a07cf8Schristos <h3><u>Reference macros list</u></h3> 655*89a07cf8Schristos</a> 656*89a07cf8Schristos 657*89a07cf8Schristos<ul> 658*89a07cf8Schristos <li><a href="#TITLE">TITLE</a> 659*89a07cf8Schristos <li><a href="#DOC_TITLE">DOCTITLE</a> 660*89a07cf8Schristos <li><a href="#SUBTITLE">SUBTITLE</a> 661*89a07cf8Schristos <li><a href="#AUTHOR">AUTHOR</a> 662*89a07cf8Schristos <li><a href="#CHAPTER">CHAPTER</a> 663*89a07cf8Schristos <li><a href="#CHAPTER_TITLE">CHAPTER_TITLE</a> 664*89a07cf8Schristos <li><a href="#DRAFT">DRAFT</a> 665*89a07cf8Schristos <li><a href="#REVISION">REVISION</a> 666*89a07cf8Schristos <li><a href="#COPYRIGHT">COPYRIGHT</a> 667*89a07cf8Schristos <li><a href="#MISC">MISC</a> 668*89a07cf8Schristos <li><a href="#COVERTITLE">COVERTITLE</a> 669*89a07cf8Schristos</ul> 670*89a07cf8Schristos<br> 671*89a07cf8Schristos 672*89a07cf8Schristos<!---TITLE---> 673*89a07cf8Schristos 674*89a07cf8Schristos<hr width="66%" align="left"> 675*89a07cf8Schristos<p> 676*89a07cf8Schristos<a name="TITLE"></a> 677*89a07cf8Schristos<nobr>Macro: <strong>TITLE</strong> "<title>"</nobr> 678*89a07cf8Schristos<br> 679*89a07cf8Schristos<em>*Argument must be enclosed in double-quotes</em> 680*89a07cf8Schristos 681*89a07cf8Schristos<p> 682*89a07cf8SchristosThe title string can be caps or caps/lower-case; it's up to you. 683*89a07cf8SchristosIn 684*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>, 685*89a07cf8Schristosthe title will appear in the 686*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a> 687*89a07cf8Schristosexactly as you typed it. However, <strong>mom</strong> converts 688*89a07cf8Schristosthe title to all caps in 689*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a> 690*89a07cf8Schristosunless you turn that feature off (see 691*89a07cf8Schristos<a href="headfootpage.html#_CAPS">HEADER_<POSITION>_CAPS</a>). In 692*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 693*89a07cf8Schristosthe title always gets converted to caps. 694*89a07cf8Schristos<p> 695*89a07cf8Schristos<strong>NOTE:</strong> If your 696*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> 697*89a07cf8Schristosis <strong>CHAPTER</strong>, <strong>TITLE</strong> should be the 698*89a07cf8Schristostitle of the opus, not "CHAPTER whatever". 699*89a07cf8Schristos<p> 700*89a07cf8Schristos 701*89a07cf8Schristos<!---DOCTITLE---> 702*89a07cf8Schristos 703*89a07cf8Schristos<hr width="66%" align="left"> 704*89a07cf8Schristos<p> 705*89a07cf8Schristos<a name="DOCTITLE"></a> 706*89a07cf8Schristos<nobr>Macro: <strong>DOCTITLE</strong> "<overall document title>"</nobr> 707*89a07cf8Schristos<br> 708*89a07cf8Schristos<em>*Argument must be enclosed in double-quotes</em> 709*89a07cf8Schristos 710*89a07cf8Schristos<p> 711*89a07cf8Schristos<strong>NOTE:</strong> This macro should be used only if your 712*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> 713*89a07cf8Schristosis <strong>DEFAULT</strong> (which is <strong>mom</strong>'s 714*89a07cf8Schristosdefault). 715*89a07cf8Schristos<p> 716*89a07cf8SchristosWhen you're creating a single document, say, an essay or a short 717*89a07cf8Schristosstory, you have no need of this macro. 718*89a07cf8Schristos<a href="#TITLE">TITLE</a> 719*89a07cf8Schristostakes care of all your title needs. 720*89a07cf8Schristos<p> 721*89a07cf8SchristosHowever if you're 722*89a07cf8Schristos<a href="rectoverso.html#COLLATE">collating</a> 723*89a07cf8Schristosa bunch of documents together, say, to print out a report containing 724*89a07cf8Schristosmany articles with different titles, or a book of short stories, you 725*89a07cf8Schristosneed <strong>DOCTITLE</strong>. 726*89a07cf8Schristos<p> 727*89a07cf8Schristos<strong>DOCTITLE</strong> tells <strong>mom</strong> the title 728*89a07cf8Schristosof the complete document (as opposed to the title of each article 729*89a07cf8Schristosor entitled section). 730*89a07cf8Schristos<p> 731*89a07cf8SchristosThe doctitle string can be caps or caps/lower-case; it's up to you. 732*89a07cf8SchristosIn 733*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>, 734*89a07cf8Schristosby default, the doctitle appears in the rightmost position of 735*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>, 736*89a07cf8Schristosall in caps unless you turn that feature off (see 737*89a07cf8Schristos<a href="headfootpage.html#_CAPS">HEADER_<POSITION>_CAPS</a>). In 738*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 739*89a07cf8Schristosthe doctitle always gets converted to caps. 740*89a07cf8Schristos<p> 741*89a07cf8Schristos<strong>NOTE:</strong> If your 742*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> 743*89a07cf8Schristosis <strong>CHAPTER</strong>, you don't need 744*89a07cf8Schristos<strong>DOCTITLE</strong>. <strong>TITLE</strong> takes care of 745*89a07cf8Schristoseverything. 746*89a07cf8Schristos<p> 747*89a07cf8Schristos 748*89a07cf8Schristos<!---SUBTITLE---> 749*89a07cf8Schristos 750*89a07cf8Schristos<hr width="66%" align="left"> 751*89a07cf8Schristos<p> 752*89a07cf8Schristos<a name="SUBTITLE"></a> 753*89a07cf8Schristos<nobr>Macro: <strong>SUBTITLE</strong> "<subtitle>"</nobr> 754*89a07cf8Schristos<br> 755*89a07cf8Schristos<em>*Argument must be enclosed in double-quotes</em> 756*89a07cf8Schristos 757*89a07cf8Schristos<p> 758*89a07cf8SchristosThe subtitle string can be caps or caps/lower-case. Since a 759*89a07cf8Schristosdocument's subtitle appears only in the 760*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a>, 761*89a07cf8Schristosand the title is most likely in caps, I recommend caps/lower case. 762*89a07cf8Schristos<p> 763*89a07cf8Schristos 764*89a07cf8Schristos<!---AUTHOR---> 765*89a07cf8Schristos 766*89a07cf8Schristos<hr width="66%" align="left"> 767*89a07cf8Schristos<p> 768*89a07cf8Schristos<a name="AUTHOR"></a> 769*89a07cf8Schristos<nobr>Macro: <strong>AUTHOR</strong> "<author string>" [ "<author2 string>" "<author3 string>" ... ]</nobr> 770*89a07cf8Schristos<br> 771*89a07cf8Schristos<em>*Multiple arguments must all be enclosed in double-quotes</em> 772*89a07cf8Schristos 773*89a07cf8Schristos<p> 774*89a07cf8SchristosEach author string can hold as many names as you like, e.g. 775*89a07cf8Schristos<p> 776*89a07cf8Schristos<pre> 777*89a07cf8Schristos .AUTHOR "Joe Blow" 778*89a07cf8Schristos or 779*89a07cf8Schristos .AUTHOR "Joe Blow, Jane Doe" "John Hancock" 780*89a07cf8Schristos</pre> 781*89a07cf8Schristos 782*89a07cf8Schristos<strong>Mom</strong> prints each string that's enclosed in 783*89a07cf8Schristosdouble-quotes on a separate line in the 784*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a>, 785*89a07cf8Schristoshowever only the first string appears in 786*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>. 787*89a07cf8SchristosIf you want <strong>mom</strong> to put something else in the author 788*89a07cf8Schristospart of page headers (say, just the last names of a document's two 789*89a07cf8Schristosauthors), redefine the appropriate part of the header (see 790*89a07cf8Schristos<a href="headfootpage.html#HEADER_CONTROL">header/footer control</a>). 791*89a07cf8Schristos<p> 792*89a07cf8SchristosThe strings can be caps or caps/lower-case. I recommend caps/lower 793*89a07cf8Schristoscase. 794*89a07cf8Schristos<p> 795*89a07cf8Schristos 796*89a07cf8Schristos<!---CHAPTER---> 797*89a07cf8Schristos 798*89a07cf8Schristos<hr width="66%" align="left"> 799*89a07cf8Schristos<p> 800*89a07cf8Schristos<a name="CHAPTER"></a> 801*89a07cf8Schristos<nobr>Macro: <strong>CHAPTER</strong> <chapter number></nobr> 802*89a07cf8Schristos 803*89a07cf8Schristos<p> 804*89a07cf8SchristosThe chapter number can be in any form you like -- a digit, a roman 805*89a07cf8Schristosnumeral, a word. If you choose 806*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE CHAPTER</a>, 807*89a07cf8Schristos<strong>mom</strong> prints whatever argument you pass 808*89a07cf8Schristos<strong>CHAPTER</strong> beside the word "Chapter" as a 809*89a07cf8Schristossingle line 810*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a>. 811*89a07cf8SchristosShe also puts the same thing in the middle of 812*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>. 813*89a07cf8Schristos<p> 814*89a07cf8SchristosPlease note that if your argument to <strong>CHAPTER</strong> runs 815*89a07cf8Schristosto more than one word, you must enclose the argument in 816*89a07cf8Schristosdouble-quotes. 817*89a07cf8Schristos<p> 818*89a07cf8SchristosIf you're not using <strong>DOCTYPE CHAPTER</strong>, the macro serves 819*89a07cf8Schristosno purpose and <strong>mom</strong> ignores it. 820*89a07cf8Schristos<p> 821*89a07cf8Schristos<a name="CHAPTER_STRING"><strong>CHAPTER_STRING</strong></a> 822*89a07cf8Schristos<p> 823*89a07cf8SchristosIf you're not writing in English, you can ask <strong>mom</strong> 824*89a07cf8Schristosto use the word for "chapter" in your own language by 825*89a07cf8Schristostelling her what it is with the <strong>CHAPTER_STRING</strong> 826*89a07cf8Schristosmacro, like this: 827*89a07cf8Schristos<p> 828*89a07cf8Schristos<pre> 829*89a07cf8Schristos .CHAPTER_STRING "Chap�tre" 830*89a07cf8Schristos</pre> 831*89a07cf8Schristos 832*89a07cf8SchristosYou can also use <strong>CHAPTER_STRING</strong> if you want 833*89a07cf8Schristos"CHAPTER" instead of "Chapter" in the doc- and 834*89a07cf8Schristospage-headers. 835*89a07cf8Schristos<p> 836*89a07cf8Schristos 837*89a07cf8Schristos<!---CHAPTER_TITLE---> 838*89a07cf8Schristos 839*89a07cf8Schristos<hr width="66%" align="left"> 840*89a07cf8Schristos<p> 841*89a07cf8Schristos<a name="CHAPTER_TITLE"></a> 842*89a07cf8Schristos<nobr>Macro: <strong>CHAPTER_TITLE</strong> "<chapter title>"</nobr> 843*89a07cf8Schristos<br> 844*89a07cf8Schristos<em>*Argument must be enclosed in double-quotes</em> 845*89a07cf8Schristos 846*89a07cf8Schristos<p> 847*89a07cf8SchristosIf, either in addition to or instead of "Chapter #" appearing 848*89a07cf8Schristosat the top of chapters, you want your chapter to have a title, use 849*89a07cf8Schristos<strong>CHAPTER_TITLE</strong>, with your title enclosed in 850*89a07cf8Schristosdouble-quotes, like this: 851*89a07cf8Schristos<p> 852*89a07cf8Schristos<pre> 853*89a07cf8Schristos .CHAPTER_TITLE "The DMCA Nazis" 854*89a07cf8Schristos</pre> 855*89a07cf8Schristos 856*89a07cf8SchristosIf you've used 857*89a07cf8Schristos<a href="#CHAPTER">CHAPTER</a> to give the chapter a number, 858*89a07cf8Schristosboth "Chapter #" and the chapter title will appear at the 859*89a07cf8Schristostop of the chapter, like this: 860*89a07cf8Schristos<p> 861*89a07cf8Schristos<pre> 862*89a07cf8Schristos Chapter 1 863*89a07cf8Schristos The DMCA Nazis 864*89a07cf8Schristos</pre> 865*89a07cf8Schristos 866*89a07cf8SchristosIn such a case, by default, only the chapter's title will appear in the 867*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>, 868*89a07cf8Schristosnot "Chapter #". 869*89a07cf8Schristos<p> 870*89a07cf8SchristosIf you omit <strong>CHAPTER</strong> when setting up your reference 871*89a07cf8Schristosmacros, only the title will appear, both at the top of page one and in 872*89a07cf8Schristossubsequent page headers. 873*89a07cf8Schristos<p> 874*89a07cf8SchristosThe style of the chapter title can be altered by 875*89a07cf8Schristos<a href="docelement.html#DOCELEMENT_CONTROL">control macros</a>, 876*89a07cf8Schristose.g. <strong>CHAPTER_TITLE_FAMILY</strong>, 877*89a07cf8Schristos<strong>CHAPTER_TITLE_FONT</strong>, etc. The default family, 878*89a07cf8Schristosfont and point size are Times Roman, Bold Italic, 4 points larger 879*89a07cf8Schristosthan 880*89a07cf8Schristos<a href="definitions.html#TERMS_RUNNING">running text</a>. 881*89a07cf8Schristos<p> 882*89a07cf8Schristos 883*89a07cf8Schristos<!---DRAFT---> 884*89a07cf8Schristos 885*89a07cf8Schristos<hr width="66%" align="left"> 886*89a07cf8Schristos<p> 887*89a07cf8Schristos<a name="DRAFT"></a> 888*89a07cf8Schristos<nobr>Macro: <strong>DRAFT</strong> <draft #></nobr> 889*89a07cf8Schristos 890*89a07cf8Schristos<p> 891*89a07cf8Schristos<strong>DRAFT</strong> only gets used with 892*89a07cf8Schristos<a href="#COPYSTYLE">COPYSTYLE DRAFT</a>. 893*89a07cf8SchristosIf the <strong>COPYSTYLE</strong> is <strong>FINAL</strong> (the 894*89a07cf8Schristosdefault), <strong>mom</strong> ignores <strong>DRAFT</strong>. 895*89a07cf8Schristos<strong>DRAFT</strong> accepts both alphabetic and numeric 896*89a07cf8Schristosarguments, hence it's possible to do either 897*89a07cf8Schristos<p> 898*89a07cf8Schristos<pre> 899*89a07cf8Schristos .DRAFT 2 900*89a07cf8Schristos or 901*89a07cf8Schristos .DRAFT Two 902*89a07cf8Schristos</pre> 903*89a07cf8Schristos 904*89a07cf8Schristos<strong>Mom</strong> prints the argument to <strong>.DRAFT</strong> 905*89a07cf8Schristos(i.e. the draft number) beside the word "Draft" in the 906*89a07cf8Schristosmiddle part of 907*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>. 908*89a07cf8Schristos<p> 909*89a07cf8Schristos<strong>A small word of caution:</strong> If your argument to 910*89a07cf8Schristos<strong>.DRAFT</strong> is more than one word long, you must 911*89a07cf8Schristosenclose the argument in double-quotes. 912*89a07cf8Schristos<p> 913*89a07cf8SchristosYou may, if you wish, invoke <strong>.DRAFT</strong> without an 914*89a07cf8Schristosargument, in which case, no draft number will be printed beside 915*89a07cf8Schristos"Draft" in headers or footers. 916*89a07cf8Schristos<p> 917*89a07cf8Schristos<a name="DRAFT_STRING"><strong>DRAFT_STRING</strong></a> 918*89a07cf8Schristos<p> 919*89a07cf8SchristosIf you're not writing in English, you can ask <strong>mom</strong> 920*89a07cf8Schristosto use the word for "draft" in your own language by 921*89a07cf8Schristostelling her what it is with the <strong>DRAFT_STRING</strong> macro, 922*89a07cf8Schristoslike this: 923*89a07cf8Schristos<p> 924*89a07cf8Schristos<pre> 925*89a07cf8Schristos .DRAFT_STRING "Jet" 926*89a07cf8Schristos</pre> 927*89a07cf8Schristos 928*89a07cf8SchristosEqually, <strong>DRAFT_STRING</strong> can be used to roll your own 929*89a07cf8Schristossolution to something other than the word "Draft." For 930*89a07cf8Schristosexample, you might want "Trial run alpha-three" to appear 931*89a07cf8Schristosin the headers of a draft version. You'd accomplish this by doing 932*89a07cf8Schristos<p> 933*89a07cf8Schristos<pre> 934*89a07cf8Schristos .DRAFT alpha-three 935*89a07cf8Schristos .DRAFT_STRING "Trial run 936*89a07cf8Schristos</pre> 937*89a07cf8Schristos 938*89a07cf8Schristos<strong>.DRAFT</strong> without an argument, above, ensures that 939*89a07cf8Schristosonly the <strong>DRAFT_STRING</strong> gets printed. 940*89a07cf8Schristos<p> 941*89a07cf8Schristos<strong>NOTE:</strong> If you define both a blank <strong>.DRAFT</strong> 942*89a07cf8Schristosand a blank <strong>.DRAFT_STRING</strong>, <strong>mom</strong> 943*89a07cf8Schristosskips the draft field in headers entirely. If this is what you 944*89a07cf8Schristoswant, this is also the only way to do it. Simply leaving out 945*89a07cf8Schristos<strong>.DRAFT</strong> and <strong>.DRAFT_STRING</strong> will 946*89a07cf8Schristosresult in <strong>mom</strong> using her default, which is to print 947*89a07cf8Schristos"Draft 1". 948*89a07cf8Schristos<p> 949*89a07cf8Schristos 950*89a07cf8Schristos<!---REVISION---> 951*89a07cf8Schristos 952*89a07cf8Schristos<hr width="66%" align="left"> 953*89a07cf8Schristos<p> 954*89a07cf8Schristos<a name="REVISION"></a> 955*89a07cf8Schristos<nobr>Macro: <strong>REVISION</strong> <revision #></nobr> 956*89a07cf8Schristos 957*89a07cf8Schristos<p> 958*89a07cf8Schristos<strong>REVISION</strong> only gets used with 959*89a07cf8Schristos<a href="#COPYSTYLE">COPYSTYLE DRAFT</a>. 960*89a07cf8SchristosIf the <strong>COPYSTYLE</strong> is <strong>FINAL</strong> 961*89a07cf8Schristos(the default), <strong>mom</strong> ignores the 962*89a07cf8Schristos<strong>REVISION</strong> macro. <strong>REVISION</strong> accepts 963*89a07cf8Schristosboth alphabetic and numeric arguments, hence it's possible to do 964*89a07cf8Schristoseither 965*89a07cf8Schristos<p> 966*89a07cf8Schristos<pre> 967*89a07cf8Schristos .REVISION 2 968*89a07cf8Schristos or 969*89a07cf8Schristos .REVISION Two 970*89a07cf8Schristos</pre> 971*89a07cf8Schristos 972*89a07cf8Schristos<strong>Mom</strong> prints the revision number beside the shortform 973*89a07cf8Schristos"Rev." in the middle part of 974*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>. 975*89a07cf8Schristos<p> 976*89a07cf8Schristos<strong>A small word of caution:</strong> If your argument to 977*89a07cf8Schristos<strong>.REVISION</strong> is more than one word long, you must 978*89a07cf8Schristosenclose the argument in double-quotes. 979*89a07cf8Schristos<p> 980*89a07cf8SchristosYou may, if you wish, invoke <strong>.REVISION</strong> without an 981*89a07cf8Schristosargument, in which case, no revision number will be printed beside 982*89a07cf8Schristos"Rev." in headers or footers. 983*89a07cf8Schristos<p> 984*89a07cf8Schristos<a name="REVISION_STRING"><strong>REVISION_STRING</strong></a> 985*89a07cf8Schristos<p> 986*89a07cf8SchristosIf you're not writing in English, you can ask <strong>mom</strong> 987*89a07cf8Schristosto use the word for "revision," or a shortform 988*89a07cf8Schristosthereof, in your own language by telling her what it is with the 989*89a07cf8Schristos<strong>REVISION_STRING</strong> macro, like this: 990*89a07cf8Schristos<p> 991*89a07cf8Schristos<pre> 992*89a07cf8Schristos .REVISION_STRING "R�v." 993*89a07cf8Schristos</pre> 994*89a07cf8Schristos 995*89a07cf8SchristosAdditionally, you may sometimes want to make use of 996*89a07cf8Schristos<strong>mom</strong>'s 997*89a07cf8Schristos<a href="#COPYSTYLE">COPYSTYLE DRAFT</a> 998*89a07cf8Schristosbut not actually require any draft information. For example, you 999*89a07cf8Schristosmight like <strong>mom</strong> to indicate only the revision number 1000*89a07cf8Schristosof your document. The way to do that is to define an empty 1001*89a07cf8Schristos<strong>.DRAFT</strong> and <strong>.DRAFT_STRING</strong> in 1002*89a07cf8Schristosaddition to <strong>.REVISION</strong>, like this: 1003*89a07cf8Schristos<p> 1004*89a07cf8Schristos<pre> 1005*89a07cf8Schristos .DRAFT 1006*89a07cf8Schristos .DRAFT_STRING 1007*89a07cf8Schristos .REVISION 2 1008*89a07cf8Schristos</pre> 1009*89a07cf8Schristos 1010*89a07cf8Schristos<p> 1011*89a07cf8SchristosEqually, if you want to roll your own solution to what revision 1012*89a07cf8Schristosinformation appears in headers, you could do something like this: 1013*89a07cf8Schristos<pre> 1014*89a07cf8Schristos .DRAFT 1015*89a07cf8Schristos .DRAFT_STRING 1016*89a07cf8Schristos .REVISION "two-twenty-two" 1017*89a07cf8Schristos .REVISION_STRING "Revision" 1018*89a07cf8Schristos</pre> 1019*89a07cf8Schristos 1020*89a07cf8Schristos<p> 1021*89a07cf8SchristosThe above, naturally, has no draft information. If you want to 1022*89a07cf8Schristosroll your own <strong>.DRAFT</strong> and/or 1023*89a07cf8Schristos<strong>.DRAFT_STRING</strong> as well, simply supply arguments to 1024*89a07cf8Schristoseither or both. 1025*89a07cf8Schristos<p> 1026*89a07cf8Schristos 1027*89a07cf8Schristos<!---COPYRIGHT---> 1028*89a07cf8Schristos 1029*89a07cf8Schristos<hr width="66%" align="left"> 1030*89a07cf8Schristos<p> 1031*89a07cf8Schristos<a name="COPYRIGHT"></a> 1032*89a07cf8Schristos<nobr>Macro: <strong>COPYRIGHT</strong> "<copyright info>"</nobr> 1033*89a07cf8Schristos<br> 1034*89a07cf8Schristos<em>*Argument must be enclosed in double-quotes</em> 1035*89a07cf8Schristos 1036*89a07cf8Schristos<p> 1037*89a07cf8SchristosThe argument passed to <strong>COPYRIGHT</strong> is only used on 1038*89a07cf8Schristoscover or doc cover pages, and then only if the argument COPYRIGHT is 1039*89a07cf8Schristospassed to 1040*89a07cf8Schristos<a href="cover.html#COVER">COVER</a> 1041*89a07cf8Schristosor 1042*89a07cf8Schristos<a href="cover.html#DOC_COVER">DOC_COVER</a>. 1043*89a07cf8SchristosDo not include the copyright symbol in the argument passed to 1044*89a07cf8Schristos<strong>COPYRIGHT</strong>; <strong>mom</strong> puts it in for 1045*89a07cf8Schristosyou. 1046*89a07cf8Schristos<p> 1047*89a07cf8Schristos 1048*89a07cf8Schristos<!---MISC---> 1049*89a07cf8Schristos 1050*89a07cf8Schristos<hr width="66%" align="left"> 1051*89a07cf8Schristos<p> 1052*89a07cf8Schristos<a name="MISC"></a> 1053*89a07cf8Schristos<nobr>Macro: <strong>MISC</strong> "<argument 1>" ["<argument 2>" "<argument 3>" ...]</nobr> 1054*89a07cf8Schristos<br> 1055*89a07cf8Schristos<em>*Multliple arguments must all be enclosed in double-quotes</em> 1056*89a07cf8Schristos 1057*89a07cf8Schristos<p> 1058*89a07cf8SchristosThe argument(s) passed to <strong>MISC</strong> are only used on 1059*89a07cf8Schristoscover or doc cover pages, and then only if the argument MISC is 1060*89a07cf8Schristospassed to 1061*89a07cf8Schristos<a href="cover.html#COVER">COVER</a> 1062*89a07cf8Schristosor 1063*89a07cf8Schristos<a href="cover.html#DOC_COVER">DOC_COVER</a>. 1064*89a07cf8Schristos<strong>MISC</strong> can contain any information you like. Each 1065*89a07cf8Schristosargument appears on a separate line at the bottom of the cover or 1066*89a07cf8Schristosdoc cover page. 1067*89a07cf8Schristos<p> 1068*89a07cf8SchristosFor example, if you're submitting an essay where the prof has 1069*89a07cf8Schristosrequested that you include the course number, his name and the 1070*89a07cf8Schristosdate, you could do 1071*89a07cf8Schristos<p> 1072*89a07cf8Schristos<pre> 1073*89a07cf8Schristos .MISC "Music History 101" "Professor Hasbeen" "Dec. 24, 2006" 1074*89a07cf8Schristos</pre> 1075*89a07cf8Schristos 1076*89a07cf8Schristosand the information would appear on the essay's cover page. 1077*89a07cf8Schristos<p> 1078*89a07cf8Schristos 1079*89a07cf8Schristos<!---COVER_TITLE---> 1080*89a07cf8Schristos 1081*89a07cf8Schristos<hr width="66%" align="left"> 1082*89a07cf8Schristos<p> 1083*89a07cf8Schristos<a name="COVERTITLE"></a> 1084*89a07cf8Schristos<nobr>Macro: <strong>COVERTITLE</strong> "<user defined cover page title>"</nobr> 1085*89a07cf8Schristos<br> 1086*89a07cf8Schristos<nobr>Macro: <strong>DOC_COVERTITLE</strong> "<user defined document cover page title>"</nobr> 1087*89a07cf8Schristos<br> 1088*89a07cf8Schristos<em>*Argument must be enclosed in double-quotes</em> 1089*89a07cf8Schristos 1090*89a07cf8Schristos<p> 1091*89a07cf8SchristosThe argument passed to <strong>COVERTITLE</strong> or 1092*89a07cf8Schristos<strong>DOC_COVERTITLE</strong> is only used on cover or doc cover 1093*89a07cf8Schristospages, and then only if the argument COVERTITLE is passed to 1094*89a07cf8Schristos<a href="cover.html#COVER">COVER</a> 1095*89a07cf8Schristosor 1096*89a07cf8Schristos<a href="cover.html#DOC_COVER">DOC_COVER</a>. 1097*89a07cf8Schristos<p> 1098*89a07cf8SchristosThe only time you require a <strong>COVERTITLE</strong> or 1099*89a07cf8Schristos<strong>DOC_COVERTITLE</strong>is when none of the required first 1100*89a07cf8Schristosarguments to <strong>COVER</strong> or <strong>DOC_COVER</strong> 1101*89a07cf8Schristosfits your needs for the title you want to appear on cover (or doc 1102*89a07cf8Schristoscover) pages. 1103*89a07cf8Schristos 1104*89a07cf8Schristos<p> 1105*89a07cf8Schristos<hr> 1106*89a07cf8Schristos<!========================================================================> 1107*89a07cf8Schristos 1108*89a07cf8Schristos<a name="DOCSTYLE_MACROS"> 1109*89a07cf8Schristos <h2><u>The Docstyle Macros</u></h2> 1110*89a07cf8Schristos</a> 1111*89a07cf8Schristos 1112*89a07cf8SchristosThe docstyle macros tell <strong>mom</strong> what type of document you're 1113*89a07cf8Schristoswriting, whether you want the output typeset or 1114*89a07cf8Schristos"typewritten", and whether you want a draft copy (with 1115*89a07cf8Schristosdraft and revision information in the headers) or a final copy. 1116*89a07cf8Schristos 1117*89a07cf8Schristos<a name="INDEX_DOCSTYLE"> 1118*89a07cf8Schristos <h3><u>Docstyle macros list</u></h3> 1119*89a07cf8Schristos</a> 1120*89a07cf8Schristos 1121*89a07cf8Schristos<ul> 1122*89a07cf8Schristos <li><a href="#DOCTYPE">DOCTYPE</a> 1123*89a07cf8Schristos <li><a href="#PRINTSTYLE">PRINTSTYLE</a> 1124*89a07cf8Schristos <ul> 1125*89a07cf8Schristos <li><a href="#TYPESET_DEFAULTS">Defaults for PRINTSTYLE TYPESET</a> 1126*89a07cf8Schristos <li><a href="#TYPEWRITE_DEFAULTS">Defaults for PRINTSTYLE TYPEWRITE</a> 1127*89a07cf8Schristos <ul> 1128*89a07cf8Schristos <li><a href="#TYPEWRITE_CONTROL">TYPEWRITE control macros</a> 1129*89a07cf8Schristos </ul> 1130*89a07cf8Schristos </ul> 1131*89a07cf8Schristos <li><a href="#COPYSTYLE">COPYSTYLE</a> 1132*89a07cf8Schristos</ul> 1133*89a07cf8Schristos<br> 1134*89a07cf8Schristos 1135*89a07cf8Schristos<!---DOCTYPE---> 1136*89a07cf8Schristos 1137*89a07cf8Schristos<hr width="66%" align="left"> 1138*89a07cf8Schristos<p> 1139*89a07cf8Schristos<a name="DOCTYPE"></a> 1140*89a07cf8Schristos<nobr>Macro: <strong>DOCTYPE</strong> DEFAULT | CHAPTER | NAMED "<name>" | LETTER</nobr> 1141*89a07cf8Schristos<p> 1142*89a07cf8SchristosThe arguments <strong>DEFAULT, CHAPTER</strong> and 1143*89a07cf8Schristos<strong>NAMED</strong> tell <strong>mom</strong> what to put 1144*89a07cf8Schristosin the 1145*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a> 1146*89a07cf8Schristosand 1147*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">page headers</a>. 1148*89a07cf8Schristos<strong>LETTER</strong> tells her that you want to write a 1149*89a07cf8Schristosletter. 1150*89a07cf8Schristos<p> 1151*89a07cf8Schristos<strong>Mom</strong>'s default <strong>DOCTYPE</strong> is 1152*89a07cf8Schristos<strong>DEFAULT</strong>. If that's what you want, you don't 1153*89a07cf8Schristoshave to give a <strong>DOCTYPE</strong> command. 1154*89a07cf8Schristos<p> 1155*89a07cf8Schristos<strong>DEFAULT</strong> prints a 1156*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a> 1157*89a07cf8Schristoscontaining the title, subtitle and author information given to the 1158*89a07cf8Schristos<a href="#REFERENCE_MACROS">reference macros</a>, 1159*89a07cf8Schristosand page headers with the author and title. 1160*89a07cf8Schristos(See 1161*89a07cf8Schristos<a href="headfootpage.html#HEADER_STYLE">Default specs for headers</a> 1162*89a07cf8Schristosfor how <strong>mom</strong> outputs each part of the page header.) 1163*89a07cf8Schristos<p> 1164*89a07cf8Schristos<strong>CHAPTER</strong> prints "Chapter #" in place of a 1165*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a> 1166*89a07cf8Schristos(# is what you gave to the 1167*89a07cf8Schristos<a href="#REFERENCE_MACROS">reference macro</a> 1168*89a07cf8Schristos<a href="#CHAPTER">CHAPTER</a>). 1169*89a07cf8SchristosIf you give the chapter a title with 1170*89a07cf8Schristos<a href="#CHAPTER_TITLE">CHAPTER TITLE</a>, 1171*89a07cf8Schristos<strong>mom</strong> prints "Chapter #" and the title 1172*89a07cf8Schristosunderneath. If you omit the 1173*89a07cf8Schristos<a href="#CHAPTER">CHAPTER</a> 1174*89a07cf8Schristosreference macro but supply a 1175*89a07cf8Schristos<a href="#CHAPTER_TITLE">CHAPTER_TITLE</a>, 1176*89a07cf8Schristos<strong>mom</strong> prints only the chapter title. <em>(*For 1177*89a07cf8Schristosbackward compatibility with pre-1.1.5 versions of</em> 1178*89a07cf8Schristos<strong>mom</strong><em>, you can also supply a chapter title by 1179*89a07cf8Schristosomitting the</em> <strong>CHAPTER</strong> <em>reference macro and 1180*89a07cf8Schristossupplying a chapter title with</em> 1181*89a07cf8Schristos<a href="#CHAPTER_STRING">CHAPTER_STRING</a>.) 1182*89a07cf8Schristos<p> 1183*89a07cf8SchristosThe page headers in <strong>DOCTYPE CHAPTER</strong> contain the author, 1184*89a07cf8Schristosthe title of the book (which you gave with 1185*89a07cf8Schristos<a href="#TITLE">TITLE</a>), 1186*89a07cf8Schristosand "Chapter #" (or the chapter title). See 1187*89a07cf8Schristos<a href="headfootpage.html#HEADER_STYLE">Default Specs for Headers</a> 1188*89a07cf8Schristosfor <strong>mom</strong>'s default type parameters for each part of 1189*89a07cf8Schristosthe page header. 1190*89a07cf8Schristos<p> 1191*89a07cf8Schristos<strong>NAMED</strong> takes an additional argument: a name 1192*89a07cf8Schristosfor this particular kind of document (e.g. outline, synopsis, 1193*89a07cf8Schristosabstract, memorandum), enclosed in double-quotes. 1194*89a07cf8Schristos<strong>NAMED</strong> is identical to <strong>DEFAULT</strong> 1195*89a07cf8Schristosexcept that <strong>mom</strong> prints the argument to 1196*89a07cf8Schristos<strong>NAMED</strong> beneath the 1197*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a>, 1198*89a07cf8Schristosas well as in page headers. 1199*89a07cf8Schristos(See 1200*89a07cf8Schristos<a href="headfootpage.html#HEADER_STYLE">Default specs for headers</a> 1201*89a07cf8Schristosfor how <strong>mom</strong> outputs each part of the page header.) 1202*89a07cf8Schristos<p> 1203*89a07cf8SchristosAdditionally, if you wish the name of this particular kind of 1204*89a07cf8Schristosdocument to be coloured, you can pass <strong>DOCTYPE NAMED</strong> 1205*89a07cf8Schristosa third (optional) argument: the name of a colour pre-defined (or 1206*89a07cf8Schristos"initialized") with 1207*89a07cf8Schristos<a href="color.html#NEWCOLOR">NEWCOLOR</a> 1208*89a07cf8Schristosor 1209*89a07cf8Schristos<a href="color.html#XCOLOR">XCOLOR</a>. 1210*89a07cf8SchristosFor example, if you have a doctype named "Warning", and 1211*89a07cf8Schristosyou'd like "Warning" to be in red, assuming you've 1212*89a07cf8Schristospre-defined (or "initialized") the color, red, this is 1213*89a07cf8Schristoswhat the <strong>DOCTYPE</strong> entry would look like: 1214*89a07cf8Schristos<p> 1215*89a07cf8Schristos<pre> 1216*89a07cf8Schristos .DOCTYPE NAME "Warning" red 1217*89a07cf8Schristos</pre> 1218*89a07cf8Schristos 1219*89a07cf8Schristos<p> 1220*89a07cf8Schristos<strong>LETTER</strong> tells mom you're writing a letter. See 1221*89a07cf8Schristosthe section 1222*89a07cf8Schristos<a href="letters.html#INTRO">Writing Letters</a> 1223*89a07cf8Schristosfor instructions on using <strong>mom</strong> to format letters. 1224*89a07cf8Schristos<p> 1225*89a07cf8Schristos 1226*89a07cf8Schristos<!---PRINTSTYLE---> 1227*89a07cf8Schristos 1228*89a07cf8Schristos<hr width="66%" align="left"> 1229*89a07cf8Schristos<p> 1230*89a07cf8Schristos<a name="PRINTSTYLE"></a> 1231*89a07cf8Schristos<nobr>Macro: <strong>PRINTSTYLE</strong> TYPESET | TYPEWRITE [ SINGLESPACE ]</nobr> 1232*89a07cf8Schristos<br> 1233*89a07cf8Schristos<em>*Required for document processing.</em> 1234*89a07cf8Schristos<br> 1235*89a07cf8Schristos<em>*Must come before any changes to default document style</em> 1236*89a07cf8Schristos 1237*89a07cf8Schristos<p> 1238*89a07cf8Schristos<strong>PRINTSTYLE</strong> tells <strong>mom</strong> whether to typeset 1239*89a07cf8Schristosa document, or to print it out "typewritten, doubled-spaced". 1240*89a07cf8Schristos<p> 1241*89a07cf8Schristos<strong>THIS MACRO MAY NOT BE OMITTED.</strong> In order for 1242*89a07cf8Schristosdocument processing to take place, <strong>mom</strong> requires 1243*89a07cf8Schristosa <strong>PRINTSTYLE</strong>. If you don't give one, 1244*89a07cf8Schristos<strong>mom</strong> will warn you on stderr and print a single 1245*89a07cf8Schristospage with a nasty message. 1246*89a07cf8Schristos<p> 1247*89a07cf8SchristosFurthermore, <strong>PRINTSTYLE</strong> must come before any 1248*89a07cf8Schristoschanges to <strong>mom</strong>'s default typestyle parameters. 1249*89a07cf8Schristos(This applies primarily to, but is by no means restricted to, 1250*89a07cf8Schristos<strong>PRINTSTYLE TYPESET</strong>.) <strong>PRINTSTYLE</strong> 1251*89a07cf8Schristossets up complete "templates" that include default 1252*89a07cf8Schristospapersize, margins, family, fonts, point sizes, and so on. 1253*89a07cf8SchristosTherefore, changes to any aspect of document style must come 1254*89a07cf8Schristosafterwards. 1255*89a07cf8Schristos<p> 1256*89a07cf8Schristos<strong>TYPESET</strong>, as the argument implies, typesets documents 1257*89a07cf8Schristos(by default in Times Roman; see 1258*89a07cf8Schristos<a href="#TYPESET_DEFAULTS">TYPESET defaults</a>). 1259*89a07cf8SchristosYou have full access to all the 1260*89a07cf8Schristos<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a> 1261*89a07cf8Schristosas well as the 1262*89a07cf8Schristos<a href="definitions.html#STYLE_CONTROL">style control macros</a> 1263*89a07cf8Schristosof document processing. 1264*89a07cf8Schristos<p> 1265*89a07cf8SchristosAs mentioned above, <strong>PRINTSTYLE TYPESET</strong> must come 1266*89a07cf8Schristosbefore any changes to <strong>mom</strong>'s default typographic 1267*89a07cf8Schristossettings. For example, 1268*89a07cf8Schristos 1269*89a07cf8Schristos<pre> 1270*89a07cf8Schristos .PAPER A4 1271*89a07cf8Schristos .LS 14 1272*89a07cf8Schristos .PRINTSTYLE TYPESET 1273*89a07cf8Schristos</pre> 1274*89a07cf8Schristos 1275*89a07cf8Schristoswill not changes <strong>mom</strong>'s default paper size to A4, 1276*89a07cf8Schristosnor her default document leading 14 points, whereas 1277*89a07cf8Schristos 1278*89a07cf8Schristos<pre> 1279*89a07cf8Schristos .PRINTSTYLE TYPESET 1280*89a07cf8Schristos .PAPER A4 1281*89a07cf8Schristos .LS 14 1282*89a07cf8Schristos</pre> 1283*89a07cf8Schristos 1284*89a07cf8Schristoswill. 1285*89a07cf8Schristos<p> 1286*89a07cf8SchristosWith <strong>TYPEWRITE</strong>, <strong>mom</strong> does her best 1287*89a07cf8Schristosto reproduce the look and feel of typewritten, double-spaced copy (see 1288*89a07cf8Schristos<a href="#TYPEWRITE_DEFAULTS">TYPEWRITE defaults</a>). 1289*89a07cf8Schristos<a href="docelement.html#DOCELEMENT_CONTROL">Control macros</a> 1290*89a07cf8Schristosand 1291*89a07cf8Schristos<a href="typesetting.html#INTRO_MACROS_TYPESETTING">typesetting macros</a> 1292*89a07cf8Schristosthat alter family, font, point size, and 1293*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 1294*89a07cf8Schristosare (mostly) ignored. An important exception is 1295*89a07cf8Schristos<a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a> 1296*89a07cf8Schristos(and, by extension, <strong>FOOTER_SIZE</strong>), which allows 1297*89a07cf8Schristosyou to reduce the point size of headers/footers should they become 1298*89a07cf8Schristostoo crowded. Most of <strong>mom</strong>'s inlines affecting the 1299*89a07cf8Schristosappearance of type are also ignored (<strong>\*S</strong> is an 1300*89a07cf8Schristosexception; there may be a few others). 1301*89a07cf8Schristos<p> 1302*89a07cf8SchristosIn short, <strong>TYPEWRITE</strong> never produces effects other than 1303*89a07cf8Schristosthose available on a typewriter. Don't be fooled by how brainless 1304*89a07cf8Schristosthis sounds; <strong>mom</strong> is remarkably sophisticated when 1305*89a07cf8Schristosit comes to conveying the typographic sense of a document within the 1306*89a07cf8Schristosconfines of <strong>TYPEWRITE</strong>. 1307*89a07cf8Schristos<p> 1308*89a07cf8SchristosThe primary uses of <strong>TYPEWRITE</strong> are: outputting hard 1309*89a07cf8Schristoscopy drafts of your work (for editing), and producing documents 1310*89a07cf8Schristosfor submission to publishers and agents who (wisely) insist on 1311*89a07cf8Schristostypewritten, double-spaced copy. To get a nicely typeset version of 1312*89a07cf8Schristoswork that's in the submission phase of its life (say, to show fellow 1313*89a07cf8Schristoswriters for critiquing), simply change <strong>TYPEWRITE</strong> 1314*89a07cf8Schristosto <strong>TYPESET</strong> and print out a copy. 1315*89a07cf8Schristos<p> 1316*89a07cf8SchristosIf, for some reason, you would prefer the output of 1317*89a07cf8Schristos<strong>TYPEWRITE</strong> single-spaced, pass <strong>PRINTSTYLE 1318*89a07cf8SchristosTYPEWRITE</strong> the optional argument, <strong>SINGLESPACE</strong>. 1319*89a07cf8Schristos<p> 1320*89a07cf8SchristosIf you absolutely must have a leading other than typewriter double- 1321*89a07cf8Schristosor singlespaced, the only way to get it is with the 1322*89a07cf8Schristos<a href="#DOC_LEAD">DOC_LEAD</a> 1323*89a07cf8Schristosmacro, and then ONLY if <strong>DOC_LEAD</strong> is set 1324*89a07cf8Schristos<strong>before</strong> you invoke the <strong>START</strong> 1325*89a07cf8Schristosmacro. 1326*89a07cf8Schristos<p> 1327*89a07cf8Schristos<a name="TYPESET_DEFAULTS"><h3><u>TYPESET defaults</u></h3></a> 1328*89a07cf8Schristos<pre> 1329*89a07cf8Schristos Family = Times Roman 1330*89a07cf8Schristos Point size = 12.5 1331*89a07cf8Schristos Paragraph leading = 16 points, adjusted 1332*89a07cf8Schristos Fill mode = justified 1333*89a07cf8Schristos Hyphenation = enabled 1334*89a07cf8Schristos max. lines = 2 1335*89a07cf8Schristos margin = 36 points 1336*89a07cf8Schristos interword adjustment = 1 point 1337*89a07cf8Schristos Kerning = enabled 1338*89a07cf8Schristos Ligatures = enabled 1339*89a07cf8Schristos Smartquotes = enabled 1340*89a07cf8Schristos Word space = groff default 1341*89a07cf8Schristos Sentence space = 0 1342*89a07cf8Schristos</pre> 1343*89a07cf8Schristos 1344*89a07cf8Schristos<a name="TYPEWRITE_DEFAULTS"><h3><u>TYPEWRITE defaults</u></h3></a> 1345*89a07cf8Schristos<pre> 1346*89a07cf8Schristos Family = Courier 1347*89a07cf8Schristos Italics = underlined 1348*89a07cf8Schristos Point size = 12 1349*89a07cf8Schristos Paragraph leading = 24 points, adjusted; 12 points for SINGLESPACE 1350*89a07cf8Schristos Fill mode = left 1351*89a07cf8Schristos Hyphenation = disabled 1352*89a07cf8Schristos Kerning = disabled 1353*89a07cf8Schristos Ligatures = disabled 1354*89a07cf8Schristos Smartquotes = disabled 1355*89a07cf8Schristos Word space = groff default 1356*89a07cf8Schristos Sentence space = groff default 1357*89a07cf8Schristos Columns = ignored 1358*89a07cf8Schristos</pre> 1359*89a07cf8Schristos 1360*89a07cf8Schristos<a name="TYPEWRITE_CONTROL"><h3><u>PRINTSTYLE TYPEWRITE control macros</u></h3></a> 1361*89a07cf8Schristos<p> 1362*89a07cf8SchristosIn <strong>PRINTSTYLE TYPEWRITE</strong>, <strong>mom</strong>, 1363*89a07cf8Schristosby default, underlines anything that looks like italics. This 1364*89a07cf8Schristosincludes the 1365*89a07cf8Schristos<a href="typesetting.html#SLANT_INLINE">\*[SLANT]</a> 1366*89a07cf8Schristos<a href="definitions.html#TERMS_INLINES">inline escape</a> 1367*89a07cf8Schristosfor pseudo-italics. 1368*89a07cf8Schristos<p> 1369*89a07cf8SchristosIf you'd prefer that <strong>mom</strong> were 1370*89a07cf8Schristosless bloody-minded about pretending to be a typewriter (i.e. 1371*89a07cf8Schristosyou'd like italics and pseudo-italics to come out as italics), 1372*89a07cf8Schristosuse the control macros <strong>.ITALIC_MEANS_ITALIC</strong> and 1373*89a07cf8Schristos<strong>.SLANT_MEANS_SLANT</strong>. Neither requires an 1374*89a07cf8Schristosargument. 1375*89a07cf8Schristos<p> 1376*89a07cf8SchristosAlthough it's unlikely, should you wish to reverse the sense of 1377*89a07cf8Schristosthese macros in the midst of a document, 1378*89a07cf8Schristos<strong>.UNDERLINE_ITALIC</strong> and 1379*89a07cf8Schristos<strong>.UNDERLINE_SLANT</strong> restore underlining of 1380*89a07cf8Schristositalics and pseudo-italics. 1381*89a07cf8Schristos<p> 1382*89a07cf8Schristos<a name="UNDERLINE_QUOTES"></a> 1383*89a07cf8SchristosAdditionally, by default, <strong>mom</strong> underlines 1384*89a07cf8Schristos<a href="definitions.html#TERMS_QUOTES">quotes</a> 1385*89a07cf8Schristos(but not 1386*89a07cf8Schristos<a href="definitions.html#TERMS_BLOCKQUOTES">blockquotes</a>) 1387*89a07cf8Schristosin <strong>PRINTSTYLE TYPEWRITE</strong>. 1388*89a07cf8SchristosIf you don't like this behaviour, turn it off with 1389*89a07cf8Schristos<p> 1390*89a07cf8Schristos<pre> 1391*89a07cf8Schristos .UNDERLINE_QUOTES OFF 1392*89a07cf8Schristos</pre> 1393*89a07cf8Schristos 1394*89a07cf8SchristosTo turn underlining of quotes back on, use 1395*89a07cf8Schristos<strong>UNDERLINE_QUOTES</strong> without an argument. 1396*89a07cf8Schristos<p> 1397*89a07cf8SchristosWhile most of the 1398*89a07cf8Schristos<a href="docelement.html#DOCELEMENT_CONTROL">control macros</a> 1399*89a07cf8Schristoshave no effect on <strong>PRINTSTYLE TYPEWRITE</strong>, there 1400*89a07cf8Schristosis an important exception: 1401*89a07cf8Schristos<a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a> 1402*89a07cf8Schristos(and by extension, <strong>FOOTER_SIZE</strong>). This is 1403*89a07cf8Schristosparticularly useful for reducing the point size of 1404*89a07cf8Schristosheaders/footers should they become crowded (quite likely to 1405*89a07cf8Schristoshappen if the title of your document is long and your 1406*89a07cf8Schristos<a href="#COPYSTYLE">COPYSTYLE</a> 1407*89a07cf8Schristosis <strong>DRAFT</strong>). 1408*89a07cf8Schristos<p> 1409*89a07cf8Schristos 1410*89a07cf8Schristos<!---COPYSTYLE---> 1411*89a07cf8Schristos 1412*89a07cf8Schristos<hr width="66%" align="left"> 1413*89a07cf8Schristos<p> 1414*89a07cf8Schristos<a name="COPYSTYLE"></a> 1415*89a07cf8Schristos<nobr>Macro: <strong>COPYSTYLE</strong> DRAFT | FINAL</nobr> 1416*89a07cf8Schristos 1417*89a07cf8Schristos<p> 1418*89a07cf8Schristos<strong>Mom</strong>'s default <strong>COPYSTYLE</strong> is 1419*89a07cf8Schristos<strong>FINAL</strong>, so you don't have to use this macro unless 1420*89a07cf8Schristosyou want to. 1421*89a07cf8Schristos<p> 1422*89a07cf8Schristos<strong>COPYSTYLE DRAFT</strong> exhibits the following behaviour: 1423*89a07cf8Schristos<br> 1424*89a07cf8Schristos<ol> 1425*89a07cf8Schristos <li>documents start on page 1, whether or not you 1426*89a07cf8Schristos request a different starting page number with 1427*89a07cf8Schristos <a href="headfootpage.html#PAGENUMBER">PAGENUMBER</a> 1428*89a07cf8Schristos <li>page numbers are set in lower case roman numerals 1429*89a07cf8Schristos <li>the draft number supplied by 1430*89a07cf8Schristos <a href="#DRAFT">DRAFT</a> 1431*89a07cf8Schristos and a revision number, if supplied with 1432*89a07cf8Schristos <a href="#REVISION">REVISION</a> 1433*89a07cf8Schristos (see 1434*89a07cf8Schristos <a href="#REFERENCE_MACROS">reference macros</a>), 1435*89a07cf8Schristos appear in the centre part of 1436*89a07cf8Schristos <a href="definitions.html#TERMS_HEADER">page headers</a> 1437*89a07cf8Schristos (or footers, depending on which you've selected) along with 1438*89a07cf8Schristos any other information that normally appears there. 1439*89a07cf8Schristos</ol> 1440*89a07cf8Schristos<p> 1441*89a07cf8Schristos<strong>IMPORTANT:</strong> If you define your own centre part for page 1442*89a07cf8Schristosheaders with 1443*89a07cf8Schristos<a href="headfootpage.html#HDRFTR_CENTER">HEADER_CENTER</a>, 1444*89a07cf8Schristosno draft and/or revision number will appear there. If you want draft 1445*89a07cf8Schristosand revision information in this circumstance, use 1446*89a07cf8Schristos<a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a>. 1447*89a07cf8Schristos<p> 1448*89a07cf8Schristos<strong>COPYSTYLE FINAL</strong> differs from <strong>DRAFT</strong> in that: 1449*89a07cf8Schristos<br> 1450*89a07cf8Schristos<ol> 1451*89a07cf8Schristos <li>it respects the starting page number you give the document 1452*89a07cf8Schristos <li>page numbers are set in normal (Arabic) digits 1453*89a07cf8Schristos <li>no draft or revision number appears in the page headers 1454*89a07cf8Schristos</ol> 1455*89a07cf8Schristos<p> 1456*89a07cf8Schristos<strong>NOTE:</strong> The centre part of page headers can get crowded, 1457*89a07cf8Schristosespecially with 1458*89a07cf8Schristos<a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a> 1459*89a07cf8Schristosand 1460*89a07cf8Schristos<a href="docprocessing.html#DOCTYPE">DOCTYPE NAMED</a>, 1461*89a07cf8Schristoswhen the <strong>COPYSTYLE</strong> is <strong>DRAFT</strong>. 1462*89a07cf8SchristosThree mechanisms are available to overcome this problem. One is to 1463*89a07cf8Schristosreduce the overall size of headers (with 1464*89a07cf8Schristos<a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a>). 1465*89a07cf8SchristosAnother, which only works with 1466*89a07cf8Schristos<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, 1467*89a07cf8Schristosis to reduce the size of the header's centre part only (with 1468*89a07cf8Schristos<a href="headfootpage.html#_SIZE">HEADER_CENTER_SIZE</a>). 1469*89a07cf8SchristosAnd finally, you can elect to have the draft/revision information 1470*89a07cf8Schristosattached to page numbers instead of having it appear in the centre 1471*89a07cf8Schristosof page headers (see 1472*89a07cf8Schristos<a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a>). 1473*89a07cf8Schristos<p> 1474*89a07cf8Schristos<hr> 1475*89a07cf8Schristos 1476*89a07cf8Schristos<!========================================================================> 1477*89a07cf8Schristos 1478*89a07cf8Schristos<a name="STYLE_BEFORE_START"><h2><u>Changing type/style parameters prior to START</u></h2></a> 1479*89a07cf8Schristos<p> 1480*89a07cf8SchristosIn the third (optional) part of setting up a document (see 1481*89a07cf8Schristos<a href="#DOCPROCESSING_TUT">Tutorial -- setting up a mom document</a>), 1482*89a07cf8Schristosyou can use the 1483*89a07cf8Schristos<a href="typsetting.html">typesetting macros</a> 1484*89a07cf8Schristosto change <strong>mom</strong>'s document-wide defaults for margins, 1485*89a07cf8Schristosline length, family, base point size, 1486*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a>, 1487*89a07cf8Schristosand justification style. 1488*89a07cf8Schristos<p> 1489*89a07cf8SchristosTwo additional style concerns have to be addressed here (i.e. in 1490*89a07cf8Schristosmacros before 1491*89a07cf8Schristos<a href="#START">START</a>): 1492*89a07cf8Schristoschanges to the 1493*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a>, 1494*89a07cf8Schristosand whether you want you want the document's nominal leading 1495*89a07cf8Schristosadjusted to fill pages fully to the bottom margin. 1496*89a07cf8Schristos<p> 1497*89a07cf8Schristos<ul> 1498*89a07cf8Schristos <li><a href="#TYPE_BEFORE_START">Using typesetting macros prior to START</a> 1499*89a07cf8Schristos <p> 1500*89a07cf8Schristos <li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> 1501*89a07cf8Schristos -- adjusting linespacing for equal, accurate bottom margins 1502*89a07cf8Schristos <li><a href="#DOCHEADER">DOCHEADER</a> 1503*89a07cf8Schristos -- turning the docheader off 1504*89a07cf8Schristos <ul> 1505*89a07cf8Schristos <li><a href="#DOCHEADER_CONTROL">Docheader control</a> 1506*89a07cf8Schristos </ul> 1507*89a07cf8Schristos</ul> 1508*89a07cf8Schristos<br> 1509*89a07cf8Schristos 1510*89a07cf8Schristos<hr width="66%" align="left"> 1511*89a07cf8Schristos<a name="TYPE_BEFORE_START"><h2><u>Using the typesetting macros prior to START</u></h2></a> 1512*89a07cf8Schristos<p> 1513*89a07cf8SchristosFrom time to time (or maybe frequently), you'll want the overall 1514*89a07cf8Schristoslook of a document to differ from <strong>mom</strong>'s defaults. 1515*89a07cf8SchristosPerhaps you'd like her to use a different 1516*89a07cf8Schristos<a href="definitions.html#TERMS_FAMILY">family</a>, 1517*89a07cf8Schristosor a different overall 1518*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a>, 1519*89a07cf8Schristosor have different left and/or right page margins. 1520*89a07cf8Schristos<p> 1521*89a07cf8SchristosTo accomplish such alterations, use the appropriate 1522*89a07cf8Schristos<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a> 1523*89a07cf8Schristos(listed below) <strong>after</strong> 1524*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE</a> 1525*89a07cf8Schristosand <strong>before</strong> 1526*89a07cf8Schristos<a href="#START">START</a>. 1527*89a07cf8Schristos<p> 1528*89a07cf8SchristosMore than one user has, quite understandably, not fully grasped 1529*89a07cf8Schristosthe significance of the preceding sentence. The part they've missed 1530*89a07cf8Schristosis "<u>after <strong>PRINTSTYLE</strong></u>". 1531*89a07cf8Schristos<p> 1532*89a07cf8SchristosChanges to any aspect of the default look and/or formatting 1533*89a07cf8Schristosof a <strong>mom</strong> document must come after 1534*89a07cf8Schristos<strong>PRINTSTYLE</strong>. For example, it might seem natural to 1535*89a07cf8Schristosset up page margins at the very top of a document with 1536*89a07cf8Schristos<p> 1537*89a07cf8Schristos<pre> 1538*89a07cf8Schristos .L_MARGIN 1i 1539*89a07cf8Schristos .R_MARGIN 1.5i 1540*89a07cf8Schristos</pre> 1541*89a07cf8Schristos 1542*89a07cf8SchristosHowever, when you invoke <strong>.PRINTSTYLE</strong>, those 1543*89a07cf8Schristosmargins will be overridden. The correct place to set margins--and 1544*89a07cf8Schristosall other changes to the look of a document--is <strong>after 1545*89a07cf8SchristosPRINTSTYLE</strong>. 1546*89a07cf8Schristos 1547*89a07cf8Schristos<p> 1548*89a07cf8Schristos<strong>NOTE:</strong> Don't use the macros listed in <a 1549*89a07cf8Schristoshref="#DOC_PARAM_MACROS">Changing document-wide typesetting 1550*89a07cf8Schristosparameters after START</a> prior to <strong>START</strong>; they are 1551*89a07cf8Schristosexclusively for use afterwards. 1552*89a07cf8Schristos<p> 1553*89a07cf8SchristosWhen used before 1554*89a07cf8Schristos<strong>START</strong>, 1555*89a07cf8Schristosthe 1556*89a07cf8Schristos<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a> 1557*89a07cf8Schristos(below) have the following meanings: 1558*89a07cf8Schristos<p> 1559*89a07cf8Schristos<pre> 1560*89a07cf8Schristos L_MARGIN Left margin of pages, including headers/footers 1561*89a07cf8Schristos R_MARGIN Right margin of pages, including headers/footers 1562*89a07cf8Schristos T_MARGIN The point at which running text (i.e. not 1563*89a07cf8Schristos headers/footers or page numbers) starts on each page 1564*89a07cf8Schristos B_MARGIN* The point at which running text (i.e. not 1565*89a07cf8Schristos (see note) headers/footers or page numbers) ends on each page 1566*89a07cf8Schristos 1567*89a07cf8Schristos PAGE If you use PAGE, its final four arguments have the 1568*89a07cf8Schristos same meaning as L_ R_ T_ and B_MARGIN (above). 1569*89a07cf8Schristos 1570*89a07cf8Schristos LL The line length for everything on the page; 1571*89a07cf8Schristos equivalent to setting the right margin with R_MARGIN 1572*89a07cf8Schristos FAMILY The family of all type in the document 1573*89a07cf8Schristos PT_SIZE The point size of type in paragraphs; mom uses this 1574*89a07cf8Schristos to calculate automatic point size changes (e.g. for 1575*89a07cf8Schristos heads, footnotes, quotes, headers, etc) 1576*89a07cf8Schristos LS/AUTOLEAD** The leading used in paragraphs; all leading and spacing 1577*89a07cf8Schristos of running text is calculated from this 1578*89a07cf8Schristos 1579*89a07cf8Schristos QUAD/JUSTIFY Affects paragraphs only 1580*89a07cf8Schristos LEFT No effect*** 1581*89a07cf8Schristos RIGHT No effect*** 1582*89a07cf8Schristos CENTER No effect*** 1583*89a07cf8Schristos 1584*89a07cf8Schristos------ 1585*89a07cf8Schristos *See <a href="headfootpage.html#FOOTER_MARGIN">FOOTER MARGIN AND BOTTOM MARGIN</a> for an important warning 1586*89a07cf8Schristos **See <a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> 1587*89a07cf8Schristos***See <a href="#LRC_NOTE">Special note</a> 1588*89a07cf8Schristos</pre> 1589*89a07cf8Schristos 1590*89a07cf8SchristosOther macros that deal with type style, or refinements thereof 1591*89a07cf8Schristos(<strong>KERN, LIGATURES, HY, WS, SS,</strong> etc.), behave normally. 1592*89a07cf8SchristosIt is not recommended that you set up tabs or indents prior to 1593*89a07cf8Schristos<strong>START</strong>. 1594*89a07cf8Schristos<p> 1595*89a07cf8SchristosIf you want to change any of the basic parameters (above) 1596*89a07cf8Schristos<em>after</em> <strong>START</strong> and have them affect a 1597*89a07cf8Schristosdocument globally (as if you'd entered them <em>before</em> 1598*89a07cf8Schristos<strong>START</strong>), you must use the macros listed in 1599*89a07cf8Schristos<a href="#DOC_PARAM_MACROS">Changing document-wide style parameters after START</a>. 1600*89a07cf8Schristos 1601*89a07cf8Schristos<a name="LRC_NOTE"></a> 1602*89a07cf8Schristos<h3><u>Special note on .LEFT, .RIGHT and .CENTER prior to START</u></h3> 1603*89a07cf8SchristosIn a word, these three macros have no effect on document processing 1604*89a07cf8Schristoswhen invoked prior to <strong>START</strong>. 1605*89a07cf8Schristos<p> 1606*89a07cf8SchristosAll <strong>mom</strong>'s document element tags 1607*89a07cf8Schristos(<strong>PP</strong>, <strong>HEAD</strong>, 1608*89a07cf8Schristos<strong>BLOCKQUOTE</strong>, <strong>FOOTNOTE</strong>, etc.) 1609*89a07cf8Schristosexcept 1610*89a07cf8Schristos<a href="docelement.html#QUOTE">QUOTE</a> 1611*89a07cf8Schristosset a 1612*89a07cf8Schristos<a href="definitions.html#TERMS_FILLED">fill mode</a> 1613*89a07cf8Schristosas soon as they're invoked. If you wish to turn fill mode off for 1614*89a07cf8Schristosthe duration of any tag (with 1615*89a07cf8Schristos<a href="typesetting.html#LRC">.LEFT, .RIGHT or .CENTER</a>) 1616*89a07cf8Schristosyou must do so immediately after invoking the tag. Furthermore, 1617*89a07cf8Schristosthe change affects <em>only</em> the current invocation of the tag. 1618*89a07cf8SchristosSubsequent invocations of the same tag for which you want the same 1619*89a07cf8Schristoschange require that you invoke <strong>LEFT</strong>, 1620*89a07cf8Schristos<strong>RIGHT</strong> or <strong>CENTER</strong> immediately after 1621*89a07cf8Schristosevery invocation of the tag. 1622*89a07cf8Schristos<p> 1623*89a07cf8Schristos 1624*89a07cf8Schristos<!---COLOR---> 1625*89a07cf8Schristos<a name="COLOR"><h2><u>Colour</u></h2></a> 1626*89a07cf8Schristos<br> 1627*89a07cf8SchristosAlthough it doesn't really matter where you define/initialize 1628*89a07cf8Schristoscolours for use in document processing (see 1629*89a07cf8Schristos<a href="color.html#NEWCOLOR">NEWCOLOR</a> 1630*89a07cf8Schristosand 1631*89a07cf8Schristos<a href="color.html#XCOLOR">XCOLOR</a> 1632*89a07cf8Schristosin the section 1633*89a07cf8Schristos<a href="color.html#COLOR_INTRO">Coloured text</a>), 1634*89a07cf8SchristosI recommend doing so before you begin document processing with 1635*89a07cf8Schristos<a href="#START">START</a>. 1636*89a07cf8Schristos<p> 1637*89a07cf8SchristosThe macro, 1638*89a07cf8Schristos<a href="color.html#COLOR">COLOR</a>, 1639*89a07cf8Schristosand the 1640*89a07cf8Schristos<a href="definitions.html#TERMS_INLINES">inline escape</a>, 1641*89a07cf8Schristos<a href="color.html#COLOR_INLINE">\[<colorname>]</a>, 1642*89a07cf8Schristoscan be used at any time during document processing for occasional 1643*89a07cf8Schristoscolour effects. However, consistent and reliable colourizing of 1644*89a07cf8Schristosvarious document elements (the docheader, heads, linebreaks, 1645*89a07cf8Schristosfootnotes, pagenumbers, and so on) must be managed through the use 1646*89a07cf8Schristosof the 1647*89a07cf8Schristos<a href="docelement.html#DOCELEMENT_CONTROL">document element control macros</a>. 1648*89a07cf8Schristos<p> 1649*89a07cf8Schristos<strong>PLEASE NOTE:</strong> If you plan to have <strong>mom</strong> 1650*89a07cf8Schristosgenerate a 1651*89a07cf8Schristos<a href="docelement.html#TOC">table of contents</a>, 1652*89a07cf8Schristosdo NOT embed colour 1653*89a07cf8Schristos<a href="definitions.html#TERMS_INLINES">inline escapes</a> 1654*89a07cf8Schristos(<a href="color.html#COLOR_INLINE">\[<colorname>]</a>) 1655*89a07cf8Schristosin the 1656*89a07cf8Schristos<a href="definitions.html#TERMS_STRINGARGUMENT">string arguments</a> 1657*89a07cf8Schristosgiven to any of the 1658*89a07cf8Schristos<a href="docprocessing.html#REFERENCE_MACROS">reference macros</a>, 1659*89a07cf8Schristosnor in the string arguments given to 1660*89a07cf8Schristos<a href="docelement.html#HEAD">.HEAD</a>, 1661*89a07cf8Schristos<a href="docelement.html#SUBHEAD">.SUBHEAD</a> 1662*89a07cf8Schristosor 1663*89a07cf8Schristos<a href="docelement.html#PARAHEAD">.PARAHEAD</a>. 1664*89a07cf8SchristosUse, rather, the 1665*89a07cf8Schristos<a href="definitions.html#TERMS_CONTROLMACRO">control macros</a> 1666*89a07cf8Schristos<strong>mom</strong> provides to automatically colourize these 1667*89a07cf8Schristoselements. 1668*89a07cf8Schristos<br> 1669*89a07cf8Schristos 1670*89a07cf8Schristos<!---DOC_LEAD_ADJUST---> 1671*89a07cf8Schristos 1672*89a07cf8Schristos<hr width="66%" align="left"> 1673*89a07cf8Schristos<a name="DOC_LEAD_ADJUST"><h3><u>Adjusting document leading to fill pages</u></h3></a> 1674*89a07cf8Schristos<br> 1675*89a07cf8Schristos<nobr>Macro: <strong>DOC_LEAD_ADJUST</strong> toggle</nobr> 1676*89a07cf8Schristos<br> 1677*89a07cf8Schristos<em>*Must come after LS or AUTOLEAD and before START</em> 1678*89a07cf8Schristos 1679*89a07cf8Schristos<p> 1680*89a07cf8Schristos<strong>DOC_LEAD_ADJUST</strong> is a special macro to adjust 1681*89a07cf8Schristosdocument 1682*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 1683*89a07cf8Schristosso that bottom margins fall precisely where you expect. 1684*89a07cf8Schristos<p> 1685*89a07cf8SchristosIf you invoke <strong>DOC_LEAD_ADJUST</strong>, <strong>mom</strong> 1686*89a07cf8Schristostakes the number of lines that fit on the page at your requested 1687*89a07cf8Schristosleading, then incrementally adds 1688*89a07cf8Schristos<a href="definitions.html#TERMS_UNITS">machine units</a> 1689*89a07cf8Schristosto the leading until the maximum number of lines at the new leading 1690*89a07cf8Schristosmatches the bottom margin. In most instances, the difference 1691*89a07cf8Schristosbetween the requested lead and the adjusted lead is 1692*89a07cf8Schristosunnoticeable, and since in almost all cases adjusted leading is 1693*89a07cf8Schristoswhat you want, it's <strong>mom</strong>'s default. 1694*89a07cf8Schristos<p> 1695*89a07cf8SchristosShould you NOT want adjusted document leading, you MUST turn it 1696*89a07cf8Schristosoff manually, like this: 1697*89a07cf8Schristos<p> 1698*89a07cf8Schristos<pre> 1699*89a07cf8Schristos .DOC_LEAD_ADJUST OFF 1700*89a07cf8Schristos</pre> 1701*89a07cf8Schristos If you set the document leading prior to <strong>START</strong> 1702*89a07cf8Schristoswith 1703*89a07cf8Schristos<a href="typesetting.html#LS">LS</a> 1704*89a07cf8Schristosor 1705*89a07cf8Schristos<a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>, 1706*89a07cf8Schristos<strong>DOC_LEAD_ADJUST OFF</strong> must come afterwards, like 1707*89a07cf8Schristosthis: 1708*89a07cf8Schristos<p> 1709*89a07cf8Schristos<pre> 1710*89a07cf8Schristos .LS 12 1711*89a07cf8Schristos .DOC_LEAD_ADJUST OFF 1712*89a07cf8Schristos</pre> 1713*89a07cf8Schristos 1714*89a07cf8SchristosIn this scenario, the maximum number of lines that fit on a page at 1715*89a07cf8Schristosa 1716*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 1717*89a07cf8Schristosof 12 1718*89a07cf8Schristos<a href="definitions.html#TERMS_PICASPOINTS">points</a> 1719*89a07cf8Schristosdetermine where <strong>mom</strong> ends 1720*89a07cf8Schristosa page. The effect will be that last lines usually fall (slightly) 1721*89a07cf8Schristosshort of the "official" bottom margin. 1722*89a07cf8Schristos<p> 1723*89a07cf8SchristosIn 1724*89a07cf8Schristos<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a> 1725*89a07cf8Schristos<strong>TYPEWRITE</strong>, the leading is always adjusted and 1726*89a07cf8Schristoscan't be turned off. 1727*89a07cf8Schristos<p> 1728*89a07cf8Schristos<strong>NOTE:</strong> <strong>DOC_LEAD_ADJUST</strong>, if 1729*89a07cf8Schristosused, must be invoked after 1730*89a07cf8Schristos<a href="typesetting.html#LEADING">LS</a> 1731*89a07cf8Schristosor 1732*89a07cf8Schristos<a href="typesetting.html#AUTOLEAD">AUTOLEAD</a> 1733*89a07cf8Schristosand before 1734*89a07cf8Schristos<a href="#START">START</a> 1735*89a07cf8Schristos<p> 1736*89a07cf8Schristos<strong>ADDITIONAL NOTE:</strong> Even if you disable 1737*89a07cf8Schristos<strong>DOC_LEAD_ADJUST</strong>, <strong>mom</strong> will still 1738*89a07cf8Schristosadjust the leading of endnotes pages and toc pages. See 1739*89a07cf8Schristos<a href="docelement.html#ENDNOTE_LEAD">ENDNOTE_LEAD</a> 1740*89a07cf8Schristosand 1741*89a07cf8Schristos<a href="docelement.html#TOC_LEAD">TOC_LEAD</a> 1742*89a07cf8Schristosfor an explanation of how to disable this default behaviour. 1743*89a07cf8Schristos<p> 1744*89a07cf8Schristos 1745*89a07cf8Schristos<!---DOCHEADER---> 1746*89a07cf8Schristos 1747*89a07cf8Schristos<hr width="66%" align="left"> 1748*89a07cf8Schristos<a name="DOCHEADER"><h3><u>Managing the docheader</u></h3></a> 1749*89a07cf8Schristos<br> 1750*89a07cf8Schristos<nobr>Macro: <strong>DOCHEADER</strong> <toggle> [ distance to advance from top of page ]</nobr> 1751*89a07cf8Schristos<br> 1752*89a07cf8Schristos<em>*Must come before START; distance requires a <a href="#TERMS_UNITOFMEASURE">unit of measure</a></em> 1753*89a07cf8Schristos 1754*89a07cf8Schristos<p> 1755*89a07cf8SchristosBy default, <strong>mom</strong> prints a 1756*89a07cf8Schristos<a href="definitions.html#TERMS_DOCHEADER">docheader</a> 1757*89a07cf8Schristoson the first page of any document (see 1758*89a07cf8Schristos<a href="#DOCHEADER_DESC">below</a> 1759*89a07cf8Schristosfor a description of the docheader). If you don't want a docheader, 1760*89a07cf8Schristosturn it off with 1761*89a07cf8Schristos<p> 1762*89a07cf8Schristos<pre> 1763*89a07cf8Schristos .DOCHEADER OFF 1764*89a07cf8Schristos</pre> 1765*89a07cf8Schristos 1766*89a07cf8Schristos<strong>DOCHEADER</strong> is a toggle macro, so the argument doesn't 1767*89a07cf8Schristoshave to be <strong>OFF</strong>; it can be anything you like. 1768*89a07cf8Schristos<p> 1769*89a07cf8SchristosIf you turn the docheader off, <strong>mom</strong>, by default, starts 1770*89a07cf8Schristosthe running text of your document on the same top 1771*89a07cf8Schristos<a href="definitions.html#TERMS_BASELINE">baseline</a> 1772*89a07cf8Schristosas all subsequent pages. If you'd like her to start at a different 1773*89a07cf8Schristosvertical position, give her the distance you'd like as a second 1774*89a07cf8Schristosargument. 1775*89a07cf8Schristos<p> 1776*89a07cf8Schristos<pre> 1777*89a07cf8Schristos .DOCHEADER OFF 1.5i 1778*89a07cf8Schristos</pre> 1779*89a07cf8Schristos 1780*89a07cf8SchristosThis starts the document 1.5 inches from the top of the page PLUS 1781*89a07cf8Schristoswhatever spacing adjustment <strong>mom</strong> has to make in 1782*89a07cf8Schristosorder to ensure that the first baseline of running text falls on a 1783*89a07cf8Schristos"legal" baseline (i.e. one that ensures that the bottom 1784*89a07cf8Schristosmargin of the first page falls where it should). The distance is 1785*89a07cf8Schristosmeasured from the top edge of the paper to the 1786*89a07cf8Schristos<a href="definitions.html#TERMS_BASELINE">baseline</a> 1787*89a07cf8Schristosof the first line of type. 1788*89a07cf8Schristos<p> 1789*89a07cf8Schristos<strong>TIP:</strong> Since no document processing happens until 1790*89a07cf8Schristosyou invoke 1791*89a07cf8Schristos<a href="#START">START</a> 1792*89a07cf8Schristos-- including anything to do with docheaders -- you can typeset 1793*89a07cf8Schristosyour own docheader prior to <strong>START</strong> (if you don't 1794*89a07cf8Schristoslike the way <strong>mom</strong> does things) and use 1795*89a07cf8Schristos<strong>DOCHEADER OFF</strong> with its optional distance argument 1796*89a07cf8Schristosto ensure that the body of your document starts where you want. 1797*89a07cf8SchristosYou can even insert a PostScript file (with <strong>.PSPIC</strong>; 1798*89a07cf8Schristossee the <strong>groff_tmac</strong> man page for usage). 1799*89a07cf8Schristos<p> 1800*89a07cf8Schristos<a name="DOCHEADER_CONTROL"><h3><u>How to change the look of docheaders: docheader control macros</u></h3></a> 1801*89a07cf8Schristos 1802*89a07cf8Schristos<p> 1803*89a07cf8SchristosWith 1804*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, 1805*89a07cf8Schristosthe look of docheaders is carved in stone. 1806*89a07cf8SchristosIn 1807*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>, 1808*89a07cf8Schristoshowever, you can make a lot of changes. Macros that alter docheaders 1809*89a07cf8SchristosMUST come before 1810*89a07cf8Schristos<a href="#START">START</a>. 1811*89a07cf8Schristos<a name="DOCHEADER_DESC"></a> 1812*89a07cf8Schristos<p> 1813*89a07cf8SchristosA typeset docheader has the following characteristics. Note that 1814*89a07cf8Schristostitle, subtitle, author, and document type are what you supply 1815*89a07cf8Schristoswith the 1816*89a07cf8Schristos<a href="#REFERENCE_MACROS">reference macros</a>. 1817*89a07cf8SchristosAny you leave out will not appear; <strong>mom</strong> will 1818*89a07cf8Schristoscompensate: 1819*89a07cf8Schristos<p> 1820*89a07cf8Schristos<pre> 1821*89a07cf8Schristos TITLE bold, 3.5 points larger than running text (not necessarily caps) 1822*89a07cf8Schristos Subtitle medium, same size as running text 1823*89a07cf8Schristos by medium italic, same size as running text 1824*89a07cf8Schristos Author(s) medium italic, same size as running text 1825*89a07cf8Schristos 1826*89a07cf8Schristos (Document type) bold italic, underscored, 3 points larger than running text 1827*89a07cf8Schristos</pre> 1828*89a07cf8Schristos 1829*89a07cf8SchristosIf the 1830*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> 1831*89a07cf8Schristosis CHAPTER, 1832*89a07cf8Schristos<pre> 1833*89a07cf8Schristos Chapter # bold, 4 points larger than running text 1834*89a07cf8Schristos Chapter Title bold italic, 4 points larger than running text 1835*89a07cf8Schristos</pre> 1836*89a07cf8Schristos 1837*89a07cf8Schristos<p> 1838*89a07cf8SchristosThe 1839*89a07cf8Schristos<a href="definitions.html#TERMS_FAMILY">family</a> 1840*89a07cf8Schristosis the prevailing family of the whole document. 1841*89a07cf8Schristos<p> 1842*89a07cf8Schristos<strong>NOTE:</strong> If your <strong>DOCTYPE</strong> is 1843*89a07cf8Schristos<strong>CHAPTER</strong> and you have both "Chapter #" 1844*89a07cf8Schristosand a "Chapter Title" (as above), you may find the 1845*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 1846*89a07cf8Schristosa bit cramped (owing to <strong>mom</strong>'s default docheader 1847*89a07cf8Schristosleading). If this is the case, you can adjust the leading either 1848*89a07cf8Schristoswith 1849*89a07cf8Schristos<a href="#ADJUST_LEADING">DOCHEADER_LEAD</a> 1850*89a07cf8Schristosor by including the 1851*89a07cf8Schristos<a name="definitions.html#TERMS_INLINES">inline escape</a>, 1852*89a07cf8Schristos<a href="inlines.html#DOWN">\*[DOWN]</a>, 1853*89a07cf8Schristosin the argument you pass to 1854*89a07cf8Schristos<a href="#CHAPTER_TITLE">CHAPTER_TITLE</a>, like this: 1855*89a07cf8Schristos<p> 1856*89a07cf8Schristos<pre> 1857*89a07cf8Schristos .CHAPTER_TITLE "\*[DOWN 2p]Why Not Patent Calculus?" 1858*89a07cf8Schristos</pre> 1859*89a07cf8Schristos 1860*89a07cf8Schristos 1861*89a07cf8Schristos<a name="DOCHEADER_CONTROL_INDEX"><h3><u>The docheader macros to:</u></h3></a> 1862*89a07cf8Schristos<ol> 1863*89a07cf8Schristos <li><a href="#CHANGE_START">Change the starting position of the docheader</a> 1864*89a07cf8Schristos <li><a href="#DOCHEADER_FAMILY">Change the family of the entire docheader</a> 1865*89a07cf8Schristos <li><a href="#ADJUST_LEADING">Adjust the docheader leading</a> 1866*89a07cf8Schristos <li><a href="#CHANGE_FAMILY">Change the family of individual docheader elements</a> 1867*89a07cf8Schristos <li><a href="#CHANGE_FONT">Change the font of docheader elements</a> 1868*89a07cf8Schristos <li><a href="#CHANGE_COLOR">Change the colour of the docheader</a> 1869*89a07cf8Schristos <li><a href="#CHANGE_SIZE">Adjust the size of docheader elements</a> 1870*89a07cf8Schristos <li><a href="#CHANGE_ATTRIBUTE">Change the attribution string ("by")</a> 1871*89a07cf8Schristos</ol> 1872*89a07cf8Schristos<p> 1873*89a07cf8Schristos<a name="CHANGE_START"><h3><u>1. Change the starting position</u></h3></a> 1874*89a07cf8Schristos<p> 1875*89a07cf8SchristosBy default, a docheader starts on the same 1876*89a07cf8Schristos<a href="definitions.html#TERMS_BASELINE">baseline</a> 1877*89a07cf8Schristosas 1878*89a07cf8Schristos<a href="definitions.html#TERMS_RUNNING">running text</a>. 1879*89a07cf8SchristosIf you'd like it to start somewhere else, use the macro 1880*89a07cf8Schristos<kbd>.DOCHEADER_ADVANCE</kbd> and give it the distance you want 1881*89a07cf8Schristos(measured from the top edge of the paper to the first baseline 1882*89a07cf8Schristosof the docheader), like this: 1883*89a07cf8Schristos<p> 1884*89a07cf8Schristos<pre> 1885*89a07cf8Schristos .DOCHEADER_ADVANCE 4P 1886*89a07cf8Schristos</pre> 1887*89a07cf8Schristos 1888*89a07cf8SchristosA 1889*89a07cf8Schristos<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 1890*89a07cf8Schristosis required. 1891*89a07cf8Schristos<p> 1892*89a07cf8Schristos<strong>NOTE:</strong> If 1893*89a07cf8Schristos<a href="headfootpage.html#HEADERS">HEADERS</a> 1894*89a07cf8Schristosare <strong>OFF</strong>, <strong>mom</strong>'s normal top 1895*89a07cf8Schristosmargin for 1896*89a07cf8Schristos<a href="definitions.html#TERMS_RUNNING">running text</a> 1897*89a07cf8Schristos(7.5 1898*89a07cf8Schristos<a href="definitions.html#TERMS_PICASPOINTS">picas</a>) 1899*89a07cf8Schristoschanges to 6 picas (visually approx. 1 inch). Since the 1900*89a07cf8Schristosfirst baseline of the docheader falls on the same baseline 1901*89a07cf8Schristosas the first line of running text (on pages after page 1), 1902*89a07cf8Schristosyou might find the docheaders a bit high when headers are off. 1903*89a07cf8SchristosUse 1904*89a07cf8Schristos<a href="#CHANGE_START">DOCHEADER_ADVANCE</a> 1905*89a07cf8Schristosto place them where you want. 1906*89a07cf8Schristos<p> 1907*89a07cf8Schristos 1908*89a07cf8Schristos<a name="DOCHEADER_FAMILY"><h3><u>2. Change the family of the entire docheader</u></h3></a> 1909*89a07cf8Schristos<p> 1910*89a07cf8SchristosBy default, <strong>mom</strong> sets the docheader in the same 1911*89a07cf8Schristosfamily used for 1912*89a07cf8Schristos<a href="definitions.html#TERMS_RUNNING">running text</a>. 1913*89a07cf8SchristosIf you'd prefer to have your docheaders set in a different family, 1914*89a07cf8Schristosinvoke <strong>DOCHEADER_FAMILY</strong> with the family you want. 1915*89a07cf8SchristosThe argument for <strong>DOCHEADER_FAMILY</strong> is the same as 1916*89a07cf8Schristosfor 1917*89a07cf8Schristos<a href="typesetting.html#FAMILY">FAMILY</a>. 1918*89a07cf8Schristos<p> 1919*89a07cf8SchristosFor example, <strong>mom</strong>'s default family for running text 1920*89a07cf8Schristosis Times Roman. If you'd like to keep that default, but have the 1921*89a07cf8Schristosdocheaders set entirely in Helvetica, 1922*89a07cf8Schristos<p> 1923*89a07cf8Schristos<pre> 1924*89a07cf8Schristos .DOCHEADER_FAMILY H 1925*89a07cf8Schristos</pre> 1926*89a07cf8Schristos 1927*89a07cf8Schristosis how you'd do it. 1928*89a07cf8Schristos<p> 1929*89a07cf8SchristosPlease note that if you use <strong>DOCHEADER_FAMILY</strong>, 1930*89a07cf8Schristosyou can still alter the family of individual parts of the docheader 1931*89a07cf8Schristoswith the macros listed 1932*89a07cf8Schristos<a href="#CHANGE_FAMILY">here</a>. 1933*89a07cf8Schristos 1934*89a07cf8Schristos<a name="ADJUST_LEADING"><h3><u>3. Adjust the leading</u></h3></a> 1935*89a07cf8Schristos<p> 1936*89a07cf8SchristosThe 1937*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 1938*89a07cf8Schristosof docheaders is the same as running text (except when 1939*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> 1940*89a07cf8Schristosis <strong>CHAPTER</strong> <em>and</em> both a chapter number and a 1941*89a07cf8Schristoschapter title have been supplied, in which case the default is 4 points 1942*89a07cf8Schristosmore than running text.) 1943*89a07cf8Schristos<p> 1944*89a07cf8SchristosIf you'd like your docheaders to have a different leading, say, 2 1945*89a07cf8Schristospoints more than the lead of running text, use: 1946*89a07cf8Schristos<p> 1947*89a07cf8Schristos<pre> 1948*89a07cf8Schristos .DOCHEADER_LEAD +2 1949*89a07cf8Schristos</pre> 1950*89a07cf8Schristos 1951*89a07cf8SchristosSince the leading of docheaders is calculated from the lead of running 1952*89a07cf8Schristostext, a + or - sign is required before the argument (how much to add 1953*89a07cf8Schristosor subtract from the lead of running text). No 1954*89a07cf8Schristos<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> 1955*89a07cf8Schristosis required; points is assumed. 1956*89a07cf8Schristos<p> 1957*89a07cf8Schristos 1958*89a07cf8Schristos<a name="CHANGE_FAMILY"><h3><u>4. Change the family of docheader elements</u></h3></a> 1959*89a07cf8Schristos<p> 1960*89a07cf8SchristosThe following macros let you change the 1961*89a07cf8Schristos<a href="definitions.html#TERMS_FAMILY">family</a> 1962*89a07cf8Schristosof each docheader element separately: 1963*89a07cf8Schristos<p> 1964*89a07cf8Schristos<ul> 1965*89a07cf8Schristos<li><strong>TITLE_FAMILY</strong> <nobr><family></nobr> 1966*89a07cf8Schristos<li><strong>CHAPTER_TITLE_FAMILY</strong> <nobr><family></nobr> 1967*89a07cf8Schristos<li><strong>SUBTITLE_FAMILY</strong> <nobr><family></nobr> 1968*89a07cf8Schristos<li><strong>AUTHOR_FAMILY</strong> <nobr><family></nobr> 1969*89a07cf8Schristos<li><strong>DOCTYPE_FAMILY</strong> <nobr><family> (if</nobr> 1970*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> is NAMED) 1971*89a07cf8Schristos</ul> 1972*89a07cf8Schristos<p> 1973*89a07cf8SchristosSimply pass the appropriate macro the family you want, just as you 1974*89a07cf8Schristoswould with 1975*89a07cf8Schristos<a href="typesetting.html#FAMILY">FAMILY</a>. 1976*89a07cf8Schristos<p> 1977*89a07cf8Schristos 1978*89a07cf8Schristos<a name="CHANGE_FONT"><h3><u>5. Change the font of docheader elements</u></h3></a> 1979*89a07cf8Schristos<p> 1980*89a07cf8SchristosThe following macros let you change the 1981*89a07cf8Schristos<a href="definitions.html#TERMS_FONT">font</a> 1982*89a07cf8Schristosof each docheader element separately: 1983*89a07cf8Schristos<p> 1984*89a07cf8Schristos<ul> 1985*89a07cf8Schristos<li><strong>TITLE_FONT</strong> <nobr>R | B | I | BI</nobr> 1986*89a07cf8Schristos<li><strong>CHAPTER_TITLE_FONT</strong> <nobr>R | B | I | BI</nobr> 1987*89a07cf8Schristos<li><strong>SUBTITLE_FONT</strong> <nobr>R | B | I | BI</nobr> 1988*89a07cf8Schristos<li><strong>AUTHOR_FONT</strong> <nobr>R | B | I | BI</nobr> 1989*89a07cf8Schristos<li><strong>DOCTYPE_FONT</strong> <nobr>R | B | I | BI (if</nobr> 1990*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> is NAMED) 1991*89a07cf8Schristos</ul> 1992*89a07cf8Schristos<p> 1993*89a07cf8SchristosSimply pass the appropriate macro the font you want. <strong>R, 1994*89a07cf8SchristosB, I</strong> and <strong>BI</strong> have the same meaning as 1995*89a07cf8Schristosthey do for 1996*89a07cf8Schristos<a href="typesetting.html#FONT">FT</a>. 1997*89a07cf8Schristos<p> 1998*89a07cf8Schristos 1999*89a07cf8Schristos<a name="CHANGE_COLOR"><h3><u>6. Change the colour of the docheader elements individually</u></h3></a> 2000*89a07cf8Schristos<p> 2001*89a07cf8SchristosThe following macros let you change the color of each docheader 2002*89a07cf8Schristoselement separately. You must pre-define (or 2003*89a07cf8Schristos"initialize") the color with 2004*89a07cf8Schristos<a href="color.html#NEWCOLOR">NEWCOLOR</a> 2005*89a07cf8Schristosor 2006*89a07cf8Schristos<a href="color.html#XCOLOR">XCOLOR</a>. 2007*89a07cf8Schristos<p> 2008*89a07cf8Schristos<ul> 2009*89a07cf8Schristos <li><strong>TITLE_COLOR</strong> <nobr><colorname></nobr> 2010*89a07cf8Schristos <li><strong>CHAPTER_TITLE_COLOR</strong> <nobr><colorname></nobr> 2011*89a07cf8Schristos <ul> 2012*89a07cf8Schristos <li><strong>Note: CHAPTER_TITLE_COLOR</strong> is needed 2013*89a07cf8Schristos only if you enter both a <strong>CHAPTER</strong> 2014*89a07cf8Schristos reference macro AND a <strong>CHAPTER_TITLE</strong> 2015*89a07cf8Schristos macro. Otherwise, the macro, 2016*89a07cf8Schristos <strong>TITLE_COLOR</strong> takes care of colorizing 2017*89a07cf8Schristos the chapter header. 2018*89a07cf8Schristos </ul> 2019*89a07cf8Schristos <li><strong>SUBTITLE_COLOR</strong> <nobr><colorname></nobr> 2020*89a07cf8Schristos <li><strong>ATTRIBUTE_COLOR</strong> <nobr><colorname></nobr> 2021*89a07cf8Schristos (the "by" string that precedes the author[s] name[s]) 2022*89a07cf8Schristos <li><strong>AUTHOR_COLOR</strong> <nobr><colorname></nobr> 2023*89a07cf8Schristos <li><strong>DOCTYPE_COLOR</strong> <nobr><colorname> (if</nobr> 2024*89a07cf8Schristos <a href="#DOCTYPE">DOCTYPE</a> is NAMED) 2025*89a07cf8Schristos</ul> 2026*89a07cf8Schristos<p> 2027*89a07cf8SchristosIt is not recommended that you embed colour (with the 2028*89a07cf8Schristos<a href="definitions.html#TERMS_INLINES">inline escape</a>, 2029*89a07cf8Schristos<a href="color.html#COLOR_INLINE">\*[<colorname>]</a>) 2030*89a07cf8Schristosin the strings passed to 2031*89a07cf8Schristos<strong>TITLE</strong>, <strong>CHAPTER_TITLE</strong>, 2032*89a07cf8Schristos<strong>SUBTITLE</strong>, <strong>AUTHOR</strong> or the name you 2033*89a07cf8Schristosgive <strong>DOCTYPE NAMED</strong>. The strings passed to these 2034*89a07cf8Schristosmacros are used to generate page 2035*89a07cf8Schristos<a href="definitions.html#TERMS_HEADER">headers</a> 2036*89a07cf8Schristosand 2037*89a07cf8Schristos<a href="definitions.html#TERMS_FOOTER">footers</a>. 2038*89a07cf8SchristosAn embedded colour will cause the string to be colourized any time 2039*89a07cf8Schristosit appears in headers or footers. (If you want headers or footers 2040*89a07cf8Schristoscolourized, or parts thereof, use the header/footer control macros.) 2041*89a07cf8Schristos<p> 2042*89a07cf8Schristos<a name="DOCHEADER_COLOR"></a> 2043*89a07cf8SchristosIf you want to colourize the entire docheader, use the macro 2044*89a07cf8Schristos<p> 2045*89a07cf8Schristos<ul> 2046*89a07cf8Schristos<li><strong>DOCHEADER_COLOR</strong> <nobr><color name>.</nobr> 2047*89a07cf8Schristos</ul> 2048*89a07cf8Schristos 2049*89a07cf8Schristos<a name="CHANGE_SIZE"><h3><u>7. Adjust the size of docheader elements</u></h3></a> 2050*89a07cf8Schristos<p> 2051*89a07cf8SchristosThe following macros let you adjust the point size of each docheader 2052*89a07cf8Schristoselement separately. 2053*89a07cf8Schristos<p> 2054*89a07cf8Schristos<strong>Mom</strong> calculates the point size 2055*89a07cf8Schristosof docheader elements from the point size of paragraphs in running 2056*89a07cf8Schristostext, so you must prepend a + or - sign to the argument. Points is 2057*89a07cf8Schristosassumed as the 2058*89a07cf8Schristos<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>, 2059*89a07cf8Schristosso there's no need to append a unit to the argument. Fractional point 2060*89a07cf8Schristossizes are allowed. 2061*89a07cf8Schristos<p> 2062*89a07cf8Schristos<ul> 2063*89a07cf8Schristos<li><strong>TITLE_SIZE</strong> <nobr><+/-points></nobr> 2064*89a07cf8Schristos<br> 2065*89a07cf8Schristosdefault = +3.5 (+4 if docheader title is "Chapter #") 2066*89a07cf8Schristos<li><strong>CHAPTER_TITLE_SIZE</strong> <nobr><+/-points></nobr> 2067*89a07cf8Schristos<br> 2068*89a07cf8Schristosdefault = +4 2069*89a07cf8Schristos<li><strong>SUBTITLE_SIZE</strong> <nobr><+/-points></nobr> 2070*89a07cf8Schristos<br> 2071*89a07cf8Schristosdefault = +0 2072*89a07cf8Schristos<li><strong>AUTHOR_SIZE</strong> <nobr><+/-points></nobr> 2073*89a07cf8Schristos<br> 2074*89a07cf8Schristosdefault = +0 2075*89a07cf8Schristos<li><strong>DOCTYPE_SIZE</strong> <nobr><+/-points> (if</nobr> 2076*89a07cf8Schristos<a href="#DOCTYPE">DOCTYPE</a> is NAMED) 2077*89a07cf8Schristos<br> 2078*89a07cf8Schristosdefault = +3 2079*89a07cf8Schristos</ul> 2080*89a07cf8Schristos<p> 2081*89a07cf8SchristosSimply pass the appropriate macro the size adjustment you want. 2082*89a07cf8Schristos<p> 2083*89a07cf8Schristos 2084*89a07cf8Schristos<a name="CHANGE_ATTRIBUTE"><h3><u>8. Change the attribution string ("by")</u></h3></a> 2085*89a07cf8Schristos<p> 2086*89a07cf8SchristosIf you're not writing in English, you can change what 2087*89a07cf8Schristos<strong>mom</strong> prints where "by" appears in 2088*89a07cf8Schristosdocheaders. For example, 2089*89a07cf8Schristos<p> 2090*89a07cf8Schristos<pre> 2091*89a07cf8Schristos .ATTRIBUTE_STRING "par" 2092*89a07cf8Schristos</pre> 2093*89a07cf8Schristos 2094*89a07cf8Schristoschanges "by" to "par". If you 2095*89a07cf8Schristosdon't want an attribution string at all, simply pass 2096*89a07cf8Schristos<strong>ATTRIBUTE_STRING</strong> an empty argument, like this: 2097*89a07cf8Schristos<p> 2098*89a07cf8Schristos<pre> 2099*89a07cf8Schristos .ATTRIBUTE_STRING "" 2100*89a07cf8Schristos</pre> 2101*89a07cf8Schristos 2102*89a07cf8Schristos<strong>Mom</strong> will deposit a blank line where the 2103*89a07cf8Schristosattribution string normally appears. 2104*89a07cf8Schristos<p> 2105*89a07cf8Schristos<strong>NOTE:</strong> The type specs for the attribution line 2106*89a07cf8Schristosin docheaders are the same as for the author line. Although 2107*89a07cf8Schristosit's highly unlikely you'll want the attribution line in a 2108*89a07cf8Schristosdifferent family, font, or point size, you can do so by using 2109*89a07cf8Schristos<a href="definitions.html#TERMS_INLINES">inline escapes</a> 2110*89a07cf8Schristosin the argument to <strong>ATTRIBUTE_STRING</strong>. For 2111*89a07cf8Schristosexample, 2112*89a07cf8Schristos<p> 2113*89a07cf8Schristos<pre> 2114*89a07cf8Schristos .ATTRIBUTE_STRING "\f[HBI]\*[SIZE -2p] by \*[SIZE +2p]\*[PREV]" 2115*89a07cf8Schristos</pre> 2116*89a07cf8Schristos 2117*89a07cf8Schristoswould set "by" in Helvetica bold italic, 2 points 2118*89a07cf8Schristossmaller than normal. 2119*89a07cf8Schristos<p> 2120*89a07cf8Schristos<hr> 2121*89a07cf8Schristos 2122*89a07cf8Schristos<!---COLUMNS_INTRO---> 2123*89a07cf8Schristos 2124*89a07cf8Schristos<a name="COLUMNS_INTRO"><h2><u>Setting documents in columns</u></h2></a> 2125*89a07cf8Schristos 2126*89a07cf8Schristos<p> 2127*89a07cf8SchristosSetting documents in columns is easy with <strong>mom</strong>. (Of 2128*89a07cf8Schristoscourse she'd say that, but it's true!) All you have to do is is 2129*89a07cf8Schristossay how many columns you want and how much space you want 2130*89a07cf8Schristosbetween them (the 2131*89a07cf8Schristos<a href="definitions.html#TERMS_GUTTER">gutters</a>). 2132*89a07cf8SchristosThat's it. <strong>Mom</strong> takes care of everything else, from 2133*89a07cf8Schristossoup to nuts. 2134*89a07cf8Schristos<p> 2135*89a07cf8Schristos<strong>SOME WORDS OF ADVICE:</strong> 2136*89a07cf8Schristos<p> 2137*89a07cf8SchristosIf you want your type to achieve a pleasing 2138*89a07cf8Schristos<a href="definitions.html#TERMS_JUST">justification</a> 2139*89a07cf8Schristosor 2140*89a07cf8Schristos<a href="definitions.html#TERMS_RAG">rag</a> 2141*89a07cf8Schristosin columns, reduce the point size of type (and probably the 2142*89a07cf8Schristos<a href="definitions.html#TERMS_LEADING">leading</a> 2143*89a07cf8Schristosas well). <strong>Mom</strong>'s default document point 2144*89a07cf8Schristossize is 12.5, which works well across her default 39 2145*89a07cf8Schristos<a href="definitions.html#TERMS_PICASPOINTS">pica</a> 2146*89a07cf8Schristosfull page line length, but with even just two columns on a page, 2147*89a07cf8Schristosthe default point size is awkward to work with. 2148*89a07cf8Schristos<p> 2149*89a07cf8SchristosFurthermore, you'll absolutely need to reduce the indents for 2150*89a07cf8Schristos<a href="docelement.html#EPIGRAPH_CONTROL">epigraphs</a>, 2151*89a07cf8Schristos<a href="docelement.html#QUOTE_GENERAL">quotes</a>, 2152*89a07cf8Schristosand 2153*89a07cf8Schristos<a href="docelement.html#BLOCKQUOTE_GENERAL">blockquotes</a> 2154*89a07cf8Schristos(and probably the 2155*89a07cf8Schristos<a href="docelement.html#PARA_INDENT">paragraph first-line indent</a> 2156*89a07cf8Schristosas well). 2157*89a07cf8Schristos<p> 2158*89a07cf8Schristos 2159*89a07cf8Schristos<!---COLUMNS---> 2160*89a07cf8Schristos 2161*89a07cf8Schristos<hr width="66%" align="left"> 2162*89a07cf8Schristos<a name="COLUMNS"><h3><u>COLUMNS</u></h3></a> 2163*89a07cf8Schristos<br> 2164*89a07cf8Schristos<nobr>Macro: <strong>COLUMNS</strong> <number of columns> <width of gutters></nobr> 2165*89a07cf8Schristos<br> 2166*89a07cf8Schristos<em>*Should be the last macro before START 2167*89a07cf8Schristos<br> 2168*89a07cf8SchristosThe second argument requires a <a href="#TERMS_UNITOFMEASURE">unit of measure</a></em> 2169*89a07cf8Schristos 2170*89a07cf8Schristos<p> 2171*89a07cf8Schristos<strong>COLUMNS</strong> takes two arguments: the number of 2172*89a07cf8Schristoscolumns you want on document pages, and the width of the 2173*89a07cf8Schristos<a href="definitions.html#TERMS_GUTTER">gutter</a> 2174*89a07cf8Schristosbetween them. For example, to set up a page with two columns 2175*89a07cf8Schristosseparated by an 18 point gutter, you'd do 2176*89a07cf8Schristos<p> 2177*89a07cf8Schristos<pre> 2178*89a07cf8Schristos .COLUMNS 2 18p 2179*89a07cf8Schristos</pre> 2180*89a07cf8Schristos 2181*89a07cf8SchristosNothing to it, really. However, as noted above, 2182*89a07cf8Schristos<strong>COLUMNS</strong> should always be the last document 2183*89a07cf8Schristossetup macro prior to 2184*89a07cf8Schristos<a href="#START">START</a>. 2185*89a07cf8Schristos<p> 2186*89a07cf8Schristos<strong>NOTE:</strong> <strong>Mom</strong> ignores columns completely 2187*89a07cf8Schristoswhen the 2188*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE</a> 2189*89a07cf8Schristosis <strong>TYPEWRITE</strong>. The notion of typewriter-style 2190*89a07cf8Schristosoutput in columns is just too ghastly for her to bear. 2191*89a07cf8Schristos 2192*89a07cf8Schristos<h3><u>Using tabs when COLUMNS are enabled</u></h3> 2193*89a07cf8Schristos<strong>Mom</strong>'s tabs 2194*89a07cf8Schristos(both 2195*89a07cf8Schristos<a href="typesetting.html#TYPESETTING_TABS">typesetting tabs</a> 2196*89a07cf8Schristosand 2197*89a07cf8Schristos<a href="typesetting.html#STRING_TABS">string tabs</a>) 2198*89a07cf8Schristosbehave as you'd expect during document processing, even when 2199*89a07cf8Schristos<strong>COLUMNS</strong> are enabled. Tab structures set up 2200*89a07cf8Schristosduring document processing carry over from page to page and column 2201*89a07cf8Schristosto column. 2202*89a07cf8Schristos 2203*89a07cf8Schristos<a name="BREAKING_COLUMNS"></a> 2204*89a07cf8Schristos<h3><u>Breaking columns manually</u></h3> 2205*89a07cf8Schristos<strong>Mom</strong> takes care of breaking columns when they reach 2206*89a07cf8Schristosthe bottom margin of a page. However, there may be times you want to 2207*89a07cf8Schristosbreak the columns yourself. There are two macros for breaking columns 2208*89a07cf8Schristosmanually: <strong>COL_NEXT</strong> and <strong>COL_BREAK</strong>. 2209*89a07cf8Schristos 2210*89a07cf8Schristos<a name="COL_NEXT"></a> 2211*89a07cf8Schristos<p> 2212*89a07cf8Schristos<kbd>.COL_NEXT</kbd> breaks the line just before it, 2213*89a07cf8Schristos<a href="definitions.html#TERMS_QUAD">quads</a> 2214*89a07cf8Schristosit left (assuming the type is justified or quad left), and moves over 2215*89a07cf8Schristosto the top of the next column. If the column happens to be the last 2216*89a07cf8Schristos(rightmost) one on the page, <strong>mom</strong> starts a new page 2217*89a07cf8Schristosat the "column 1" position. This is the macro to use when 2218*89a07cf8Schristosyou want to start a new column after the end of a paragraph. 2219*89a07cf8Schristos 2220*89a07cf8Schristos<a name="COL_BREAK"></a> 2221*89a07cf8Schristos<p> 2222*89a07cf8Schristos<kbd>.COL_BREAK</kbd> is almost the same, except that 2223*89a07cf8Schristosinstead of breaking and quadding the line preceding it, 2224*89a07cf8Schristosshe breaks and spreads it (see 2225*89a07cf8Schristos<a href="typesetting.html#SPREAD">SPREAD</a>). 2226*89a07cf8SchristosUse this macro whenever you need to start a new column in the middle 2227*89a07cf8Schristosof a paragraph. 2228*89a07cf8Schristos<p> 2229*89a07cf8SchristosIf you need <strong>COL_BREAK</strong> in the middle of a blockquote 2230*89a07cf8Schristosor (god help us) an epigraph, you must do the following in order for 2231*89a07cf8Schristos<strong>COL_BREAK</strong> to work: 2232*89a07cf8Schristos<p> 2233*89a07cf8Schristos<pre> 2234*89a07cf8Schristos .SPREAD 2235*89a07cf8Schristos \!.COL_BREAK 2236*89a07cf8Schristos</pre> 2237*89a07cf8Schristos<hr> 2238*89a07cf8Schristos 2239*89a07cf8Schristos<!========================================================================> 2240*89a07cf8Schristos 2241*89a07cf8Schristos<a name="START_MACRO"> 2242*89a07cf8Schristos<h2><u>Start document processing</u></h2> 2243*89a07cf8Schristos</a> 2244*89a07cf8Schristos 2245*89a07cf8SchristosIn order to use <strong>mom</strong>'s document element macros 2246*89a07cf8Schristos(tags), you have to tell her you want them. The macro to do this 2247*89a07cf8Schristosis <strong>START</strong>. 2248*89a07cf8Schristos<p> 2249*89a07cf8Schristos<strong>START</strong> collects the information you gave 2250*89a07cf8Schristos<strong>mom</strong> in the setup section at the top of your file (see 2251*89a07cf8Schristos<a href="#DOCPROCESSING_TUT">Tutorial -- setting up a mom document</a>), 2252*89a07cf8Schristosmerges it with her defaults, sets up headers and page numbering, 2253*89a07cf8Schristosand prepares <strong>mom</strong> to process your document using 2254*89a07cf8Schristosthe document element tags. No document processing takes place until 2255*89a07cf8Schristosyou invoke <strong>START</strong>. 2256*89a07cf8Schristos<p> 2257*89a07cf8Schristos 2258*89a07cf8Schristos<!---START---> 2259*89a07cf8Schristos 2260*89a07cf8Schristos<hr width="66%" align="left"> 2261*89a07cf8Schristos<p> 2262*89a07cf8Schristos<a name="START"></a> 2263*89a07cf8SchristosMacro: <strong>START</strong> 2264*89a07cf8Schristos<br> 2265*89a07cf8Schristos<em>*Required for document processing.</em> 2266*89a07cf8Schristos 2267*89a07cf8Schristos<p> 2268*89a07cf8Schristos<strong>START</strong> takes no arguments. It simply instructs 2269*89a07cf8Schristos<strong>mom</strong> to begin document processing. If you don't 2270*89a07cf8Schristoswant document processing (i.e. you only want the 2271*89a07cf8Schristos<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>), 2272*89a07cf8Schristosdon't use <strong>START</strong>. 2273*89a07cf8Schristos<p> 2274*89a07cf8SchristosAt a barest minimum before <strong>START</strong>, you must enter a 2275*89a07cf8Schristos<a href="#PRINTSTYLE">PRINTSTYLE</a> 2276*89a07cf8Schristoscommand. 2277*89a07cf8Schristos<p> 2278*89a07cf8Schristos<hr> 2279*89a07cf8Schristos 2280*89a07cf8Schristos<!========================================================================> 2281*89a07cf8Schristos 2282*89a07cf8Schristos<a name="DOC_PARAM_MACROS"> 2283*89a07cf8Schristos<h2><u>Changing document-wide style parameters after START</u></h2> 2284*89a07cf8Schristos</a> 2285*89a07cf8Schristos 2286*89a07cf8SchristosIn the normal course of things, you change the basic type 2287*89a07cf8Schristosparameters of a document <em>before</em> 2288*89a07cf8Schristos<a href="#START">START</a>, 2289*89a07cf8Schristosusing 2290*89a07cf8Schristos<a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a> 2291*89a07cf8Schristos(<strong>L_MARGIN, FAMILY, PT_SIZE, LS,</strong> etc). After 2292*89a07cf8Schristos<strong>START</strong>, you MUST use the following macros to make 2293*89a07cf8Schristosglobal changes to the basic type parameters of a document. 2294*89a07cf8Schristos<p> 2295*89a07cf8Schristos 2296*89a07cf8Schristos<a name="INDEX_DOC_PARAM"> 2297*89a07cf8Schristos <h3><u>Macro list</u></h3> 2298*89a07cf8Schristos</a> 2299*89a07cf8Schristos<ul> 2300*89a07cf8Schristos <li><a href="#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a> 2301*89a07cf8Schristos <li><a href="#DOC_RIGHT_MARGIN">DOC_RIGHT_MARGIN</a> 2302*89a07cf8Schristos <li><a href="#DOC_LINE_LENGTH">DOC_LINE_LENGTH</a> 2303*89a07cf8Schristos <li><a href="#DOC_FAMILY">DOC_FAMILY</a> 2304*89a07cf8Schristos <li><a href="#DOC_PT_SIZE">DOC_PT_SIZE</a> 2305*89a07cf8Schristos <li><a href="#DOC_LEAD">DOC_LEAD</a> 2306*89a07cf8Schristos <li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> 2307*89a07cf8Schristos <li><a href="#DOC_QUAD">DOC_QUAD</a> 2308*89a07cf8Schristos</ul> 2309*89a07cf8Schristos<br> 2310*89a07cf8Schristos 2311*89a07cf8Schristos<hr width="66%" align="left"> 2312*89a07cf8Schristos<p> 2313*89a07cf8Schristos<a name="DOC_LEFT_MARGIN"> 2314*89a07cf8Schristos <nobr>Macro: <strong>DOC_LEFT_MARGIN</strong> <left margin></nobr> 2315*89a07cf8Schristos</a> 2316*89a07cf8Schristos<br> 2317*89a07cf8Schristos<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em> 2318*89a07cf8Schristos<p> 2319*89a07cf8Schristos<ul> 2320*89a07cf8Schristos <li>the argument is the same as for 2321*89a07cf8Schristos <a href="typesetting.html#L_MARGIN">L_MARGIN</a> 2322*89a07cf8Schristos <li>changes all left margins to the new value 2323*89a07cf8Schristos <li>the line length remains the same (i.e. the right margin 2324*89a07cf8Schristos shifts when you change the left margin) 2325*89a07cf8Schristos</ul> 2326*89a07cf8Schristos<br> 2327*89a07cf8Schristos 2328*89a07cf8Schristos<hr width="66%" align="left"> 2329*89a07cf8Schristos<p> 2330*89a07cf8Schristos<a name="DOC_RIGHT_MARGIN"> 2331*89a07cf8Schristos <nobr>Macro: <strong>DOC_RIGHT_MARGIN</strong> <right margin></nobr> 2332*89a07cf8Schristos</a> 2333*89a07cf8Schristos<br> 2334*89a07cf8Schristos<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em> 2335*89a07cf8Schristos<p> 2336*89a07cf8Schristos<ul> 2337*89a07cf8Schristos <li>the argument is the same as for 2338*89a07cf8Schristos <a href="typesetting.html#R_MARGIN">R_MARGIN</a> 2339*89a07cf8Schristos <li>changes all right margins, including 2340*89a07cf8Schristos <a href="definitions.html#TERMS_DOCHEADER">docheaders</a>, 2341*89a07cf8Schristos headers (or footers) and page numbering to the new value; 2342*89a07cf8Schristos for changing the right margin of 2343*89a07cf8Schristos <a href="definitions.html#TERMS_RUNNING">running text</a> 2344*89a07cf8Schristos only, use 2345*89a07cf8Schristos <a href="typesetting.html#R_MARGIN">R_MARGIN</a> 2346*89a07cf8Schristos (see 2347*89a07cf8Schristos <a href="typemacdoc.html#TOP">Using typesetting macros during 2348*89a07cf8Schristos document processing</a>, 2349*89a07cf8Schristos entry for <strong>R_MARGIN</strong>) 2350*89a07cf8Schristos <li>all mom commands that include a right indent calculate 2351*89a07cf8Schristos the indent from the new value 2352*89a07cf8Schristos</ul> 2353*89a07cf8Schristos<br> 2354*89a07cf8Schristos 2355*89a07cf8Schristos<hr width="66%" align="left"> 2356*89a07cf8Schristos<p> 2357*89a07cf8Schristos<a name="DOC_LINE_LENGTH"> 2358*89a07cf8Schristos <nobr>Macro: <strong>DOC_LINE_LENGTH</strong> <length></nobr> 2359*89a07cf8Schristos</a> 2360*89a07cf8Schristos<br> 2361*89a07cf8Schristos<em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em> 2362*89a07cf8Schristos<p> 2363*89a07cf8Schristos<ul> 2364*89a07cf8Schristos <li>the argument is the same as for 2365*89a07cf8Schristos <a href="typesetting.html#LINELENGTH">LL</a> 2366*89a07cf8Schristos <li>exactly equivalent to changing the right margin with 2367*89a07cf8Schristos DOC_RIGHT_MARGIN (see 2368*89a07cf8Schristos <a href="#DOC_RIGHT_MARGIN">above</a>); 2369*89a07cf8Schristos for changing the line length of 2370*89a07cf8Schristos <a href="definitions.html#TERMS_RUNNING">running text</a> 2371*89a07cf8Schristos only, use 2372*89a07cf8Schristos <a href="typesetting.html#LINELENGTH">LL</a> 2373*89a07cf8Schristos (see 2374*89a07cf8Schristos <a href="typemacdoc.html#TOP">Using typesetting macros during 2375*89a07cf8Schristos document processing</a>, 2376*89a07cf8Schristos entry for <strong>LL</strong>) 2377*89a07cf8Schristos</ul> 2378*89a07cf8Schristos<br> 2379*89a07cf8Schristos 2380*89a07cf8Schristos<hr width="66%" align="left"> 2381*89a07cf8Schristos<p> 2382*89a07cf8Schristos<a name="DOC_FAMILY"> 2383*89a07cf8Schristos <nobr>Macro: <strong>DOC_FAMILY</strong> <family></nobr> 2384*89a07cf8Schristos</a> 2385*89a07cf8Schristos<p> 2386*89a07cf8Schristos<ul> 2387*89a07cf8Schristos <li>the argument is the same as for 2388*89a07cf8Schristos <a href="typesetting.html#FAMILY">FAMILY</a> 2389*89a07cf8Schristos <li>globally changes the type family 2390*89a07cf8Schristos <li>any page elements (e.g. 2391*89a07cf8Schristos <a href="definitions.html#TERMS_HEADER">headers</a>, 2392*89a07cf8Schristos page numbers, footnotes) whose families you wish to remain 2393*89a07cf8Schristos at their old values must be reset with the appropriate 2394*89a07cf8Schristos <a href="docelement.html#DOCELEMENT_CONTROL">control macros</a> 2395*89a07cf8Schristos</ul> 2396*89a07cf8Schristos<br> 2397*89a07cf8Schristos 2398*89a07cf8Schristos<hr width="66%" align="left"> 2399*89a07cf8Schristos<p> 2400*89a07cf8Schristos<a name="DOC_PT_SIZE"> 2401*89a07cf8Schristos <nobr>Macro: <strong>DOC_PT_SIZE</strong> <point size></nobr> 2402*89a07cf8Schristos</a> 2403*89a07cf8Schristos<br> 2404*89a07cf8Schristos<em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em> 2405*89a07cf8Schristos<p> 2406*89a07cf8Schristos<ul> 2407*89a07cf8Schristos <li>the argument is the same as for 2408*89a07cf8Schristos <a href="typesetting.html#PS">PT_SIZE</a>, 2409*89a07cf8Schristos and refers to the point size of type in paragraphs 2410*89a07cf8Schristos <li>all automatic point size changes (heads, quotes, 2411*89a07cf8Schristos footnotes, headers, etc.) are affected by the new size; 2412*89a07cf8Schristos anything you do not want affected must be reset to 2413*89a07cf8Schristos its former value (see the Control Macros section of 2414*89a07cf8Schristos the pertinent document element for instructions on 2415*89a07cf8Schristos how to do this) 2416*89a07cf8Schristos</ul> 2417*89a07cf8Schristos<br> 2418*89a07cf8Schristos 2419*89a07cf8Schristos<hr width="66%" align="left"> 2420*89a07cf8Schristos<p> 2421*89a07cf8Schristos<a name="DOC_LEAD"> 2422*89a07cf8Schristos <nobr>Macro: <strong>DOC_LEAD</strong> <points> [ ADJUST ]</nobr> 2423*89a07cf8Schristos</a> 2424*89a07cf8Schristos<br> 2425*89a07cf8Schristos<em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em> 2426*89a07cf8Schristos<p> 2427*89a07cf8Schristos<ul> 2428*89a07cf8Schristos <li>the argument is the same as for 2429*89a07cf8Schristos <a href="typesetting.html#LS">LS</a>, 2430*89a07cf8Schristos and refers to the 2431*89a07cf8Schristos <a href="definitions.html#TERMS_LEAD">leading</a> 2432*89a07cf8Schristos of paragraphs 2433*89a07cf8Schristos <li>because paragraphs will have a new leading, the leading and 2434*89a07cf8Schristos spacing of most running text is influenced by the new value 2435*89a07cf8Schristos <li>epigraphs and footnotes remain unaffected; 2436*89a07cf8Schristos if you wish to change their leading, use 2437*89a07cf8Schristos <a href="docelement.html#EPIGRAPH_AUTOLEAD">EPIGRAPH_AUTOLEAD</a> 2438*89a07cf8Schristos and 2439*89a07cf8Schristos <a href="docelement.html#FOOTNOTE_AUTOLEAD">FOOTNOTE_AUTOLEAD</a>. 2440*89a07cf8Schristos <li>the optional argument <strong>ADJUST</strong> performs 2441*89a07cf8Schristos leading adjustment as explained in 2442*89a07cf8Schristos <a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> 2443*89a07cf8Schristos</ul> 2444*89a07cf8Schristos<p> 2445*89a07cf8Schristos<strong>IMPORTANT:</strong> Do not use <strong>DOC_LEAD</strong> 2446*89a07cf8Schristosin the middle of a page! It should always and only be invoked 2447*89a07cf8Schristosimmediately prior to a new page, like this: 2448*89a07cf8Schristos<p> 2449*89a07cf8Schristos<pre> 2450*89a07cf8Schristos .DOC_LEAD <new value> 2451*89a07cf8Schristos .NEWPAGE 2452*89a07cf8Schristos</pre> 2453*89a07cf8Schristos 2454*89a07cf8Schristos<strong>NOTE:</strong> Even if you don't pass 2455*89a07cf8Schristos<strong>DOC_LEAD</strong> the optional argument 2456*89a07cf8Schristos<strong>ADJUST</strong>, <strong>mom</strong> will still adjust the 2457*89a07cf8Schristosleading of endnotes pages and toc pages. See 2458*89a07cf8Schristos<a href="docelement.html#ENDNOTE_LEAD">ENDNOTE_LEAD</a> 2459*89a07cf8Schristosand 2460*89a07cf8Schristos<a href="docelement.html#TOC_LEAD">TOC_LEAD</a> 2461*89a07cf8Schristosfor an explanation of how to disable this default behaviour. 2462*89a07cf8Schristos<p> 2463*89a07cf8Schristos 2464*89a07cf8Schristos<hr width="66%" align="left"> 2465*89a07cf8Schristos<p> 2466*89a07cf8Schristos<a name="DOC_QUAD"> 2467*89a07cf8Schristos <nobr>Macro: <strong>DOC_QUAD</strong> L | R | C | J</nobr> 2468*89a07cf8Schristos</a> 2469*89a07cf8Schristos<p> 2470*89a07cf8Schristos<ul> 2471*89a07cf8Schristos <li>the arguments are the same as for 2472*89a07cf8Schristos <a href="typesetting.html#QUAD">QUAD</a> 2473*89a07cf8Schristos <li>affects paragraphs, epigraphs and footnotes; does not 2474*89a07cf8Schristos affect blockquotes 2475*89a07cf8Schristos</ul> 2476*89a07cf8Schristos<br> 2477*89a07cf8Schristos 2478*89a07cf8Schristos<hr> 2479*89a07cf8Schristos<a href="typemacdoc.html#TOP">Next</a> 2480*89a07cf8Schristos<a href="color.html#TOP">Prev</a> 2481*89a07cf8Schristos<a href="#TOP">Top</a> 2482*89a07cf8Schristos<a href="toc.html">Back to Table of Contents</a> 2483*89a07cf8Schristos</body> 2484*89a07cf8Schristos</html> 2485