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