/contrib/groff/contrib/mom/momdoc/docprocessing.html

https://bitbucket.org/freebsd/freebsd-head/ · HTML · 2484 lines · 2413 code · 63 blank · 8 comment · 0 complexity · ae70fc015e8d0d4392e8a452046265cf MD5 · raw file

Large files are truncated click here to view the full file

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
    5. 

  5. <title>Mom -- Document Processing, Introduction and Setup</title>
    6. 

  6. </head>
    7. 

  7. <body bgcolor="#dfdfdf">
    8. 

  8. 

  9. <!====================================================================>
    10. 

  10. 

  11. <a href="typemacdoc.html#TOP">Next</a>&nbsp;&nbsp;
    12. 

  12. <a href="color.html#TOP">Prev</a>&nbsp;&nbsp;
    13. 

  13. <a href="toc.html">Back to Table of Contents</a>
    14. 

  14. <p>
    15. 

  15. <a name="TOP"></a>
    16. 

  16. <a name="DOCPROCESSING">
    17. 

  17. 	<h1 align="center"><u>DOCUMENT PROCESSING WITH MOM</u></h1>
    18. 

  18. </a>
    19. 

  19. <a href="#INTRO_MACROS_DOCPROCESSING">Introduction to document processing</a>
    20. 

  20. <br>
    21. 

  21. <a href="#DEFAULTS">Some document defaults</a>
    22. 

  22. <br>
    23. 

  23. <a href="#LEADING_NOTE">* IMPORTANT NOTE on leading/spacing and bottom margins *</a>
    24. 

  24. <br>
    25. 

  25. <a href="#SHIM">The SHIM macro</a>
    26. 

  26. <br>
    27. 

  27. <h3><u>Table of Contents for document processing</u></h3>
    28. 

  28. <ul>
    29. 

  29. 	<li><a href="#SETUP"><strong>DOCUMENT SETUP</strong></a>
    30. 

  30. 	<br>
    31. 

  31. 	<a href="#DOCPROCESSING_TUT">Tutorial -- Setting up a mom document</a>
    32. 

  32. 	<br>
    33. 

  33. 	<ul>
    34. 

  34. 		<li><a href="#REFERENCE_MACROS"><strong>The Reference Macros</strong></a>
    35. 

  35. 		<ul>
    36. 

  36. 			<li><a href="#TITLE">TITLE</a>
    37. 

  37. 			<li><a href="#DOC_TITLE">DOCTITLE</a>
    38. 

  38. 			<li><a href="#SUBTITLE">SUBTITLE</a>
    39. 

  39. 			<li><a href="#AUTHOR">AUTHOR</a>
    40. 

  40. 			<li><a href="#CHAPTER">CHAPTER</a>
    41. 

  41. 			<li><a href="#CHAPTER_TITLE">CHAPTER_TITLE</a>
    42. 

  42. 			<li><a href="#DRAFT">DRAFT</a>
    43. 

  43. 			<li><a href="#REVISION">REVISION</a>
    44. 

  44. 			<li><a href="#COPYRIGHT">COPYRIGHT</a>
    45. 

  45. 			<li><a href="#MISC">MISC</a>
    46. 

  46. 		</ul>
    47. 

  47. 		<li><a href="#DOCSTYLE_MACROS"><strong>The Docstyle Macros</strong></a>
    48. 

  48. 		<ul>
    49. 

  49. 			<li><a href="#DOCTYPE">DOCTYPE</a>
    50. 

  50. 			<li><a href="#PRINTSTYLE">PRINTSTYLE</a>
    51. 

  51. 			<li><a href="#COPYSTYLE">COPYSTYLE</a>
    52. 

  52. 		</ul>
    53. 

  53. 		
    54. 

  54. 		<li><a href="#STYLE_BEFORE_START"><strong>Changing type/style parameters prior to START</strong></a>
    55. 

  55. 		<ul>
    56. 

  56. 			<li><a href="#TYPE_BEFORE_START">Using typesetting macros prior to START</a>
    57. 

  57. 			<ul>
    58. 

  58. 				<li><a href="#COLOR">Colour</a>
    59. 

  59. 			</ul>
    60. 

  60. 			<li><a href="#DOC_LEAD_ADJUST">Adjusting document leading to fill pages -- DOC_LEAD_ADJUST</a>
    61. 

  61. 			<li><a href="#DOCHEADER">Managing the document header</a>
    62. 

  62. 			<ul>
    63. 

  63. 				<li><a href="#DOCHEADER">DOCHEADER -- turning docheaders off</a>
    64. 

  64. 				<li><a href="#DOCHEADER_CONTROL">Docheader control</a>
    65. 

  65. 			</ul>
    66. 

  66. 		</ul>
    67. 

  67. 

  68. 		<li><a href="#COLUMNS_INTRO"><strong>Setting documents in columns</strong></a>
    69. 

  69. 		<ul>
    70. 

  70. 			<li><a href="#COLUMNS">COLUMNS</a>
    71. 

  71. 			<li><a href="#BREAKING_COLUMNS">Breaking columns manually</a>
    72. 

  72. 			<ul>
    73. 

  73. 			    <li><a href="#COL_NEXT">COL_NEXT</a>
    74. 

  74. 			    <li><a href="#COL_BREAK">COL_BREAK</a>
    75. 

  75. 			</ul>
    76. 

  76. 

  77. 		</ul>
    78. 

  78. 

  79. 		<li><a href="#START_MACRO"><strong>Initiate document processing</strong></a>
    80. 

  80. 		<ul>
    81. 

  81. 			<li><a href="#START">START</a>
    82. 

  82. 		</ul>
    83. 

  83. 	
    84. 

  84. 		<li><a href="#DOC_PARAM_MACROS"><strong>Changing document-wide typesetting parameters after START</strong></a>
    85. 

  85. 		<ul>
    86. 

  86. 			<li><a href="#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a>
    87. 

  87. 			<li><a href="#DOC_RIGHT_MARGIN">DOC_RIGHT_MARGIN</a>
    88. 

  88. 			<li><a href="#DOC_LINE_LENGTH">DOC_LINE_LENGTH</a>
    89. 

  89. 			<li><a href="#DOC_FAMILY">DOC_FAMILY</a>
    90. 

  90. 			<li><a href="#DOC_PT_SIZE">DOC_PT_SIZE</a>
    91. 

  91. 			<li><a href="#DOC_LEAD">DOC_LEAD</a>
    92. 

  92. 			<li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
    93. 

  93. 			<li><a href="#DOC_QUAD">DOC_QUAD</a>
    94. 

  94. 		</ul>
    95. 

  95. 		<br>
    96. 

  96. 		<li><a href="docelement.html#DOCELEMENT"><strong>THE DOCUMENT ELEMENT MACROS (TAGS)</strong></a>
    97. 

  97. 		<ul>
    98. 

  98. 			<li><a href="docelement.html#DOCELEMENT_INTRO">Introduction to the document element tags</a>
    99. 

  99. 			<ul>
    100. 

  100. 				<li><a href="docelement.html#DOCELEMENT_CONTROL">Document element (tag) control macros</a>
    101. 

  101. 				<li><a href="docelement.html#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
    102. 

  102. 			</ul>
    103. 

  103. 			<li><a href="docelement.html#EPIGRAPH_INTRO"><strong>Epigraphs</strong></a>
    104. 

  104. 			<ul>
    105. 

  105. 				<li><a href="docelement.html#EPIGRAPH">EPIGRAPH</a>
    106. 

  106. 				<li><a href="docelement.html#EPIGRAPH_CONTROL">Epigrah control</a>
    107. 

  107. 			</ul>
    108. 

  108. 			<li><a href="docelement.html#PP_INTRO"><strong>Paragraphs</strong></a>
    109. 

  109. 			<ul>
    110. 

  110. 				<li><a href="docelement.html#PP">PP</a>
    111. 

  111. 				<li><a href="docelement.html#PP_CONTROL">Paragraph control</a>
    112. 

  112. 			</ul>
    113. 

  113. 			<li><a href="docelement.html#HEAD_INTRO"><strong>Main heads</strong></a>
    114. 

  114. 			<ul>
    115. 

  115. 				<li><a href="docelement.html#HEAD">HEAD</a>
    116. 

  116. 				<li><a href="docelement.html#HEAD_CONTROL">Head control</a>
    117. 

  117. 			</ul>
    118. 

  118. 			<li><a href="docelement.html#SUBHEAD_INTRO"><strong>Subheads</strong></a>
    119. 

  119. 			<ul>
    120. 

  120. 				<li><a href="docelement.html#SUBHEAD">SUBHEAD</a>
    121. 

  121. 				<li><a href="docelement.html#SUBHEAD_CONTROL">Subhead control</a>
    122. 

  122. 			</ul>
    123. 

  123. 			<li><a href="docelement.html#PARAHEAD_INTRO"><strong>Paragraph heads</strong></a>
    124. 

  124. 			<ul>
    125. 

  125. 				<li><a href="docelement.html#PARAHEAD">PARAHEAD</a>
    126. 

  126. 				<li><a href="docelement.html#PARAHEAD_CONTROL">Parahead control</a>
    127. 

  127. 			</ul>
    128. 

  128. 			<li><a href="docelement.html#LINEBREAK_INTRO"><strong>Linebreaks (author linebreaks, also called section breaks)</strong></a>
    129. 

  129. 			<ul>
    130. 

  130. 				<li><a href="docelement.html#LINEBREAK">LINEBREAK</a>
    131. 

  131. 				<li><a href="docelement.html#LINEBREAK_CONTROL">Linebreak control</a>
    132. 

  132. 			</ul>
    133. 

  133. 			<li><a href="docelement.html#QUOTE_INTRO"><strong>Quotes (line for line poetic quotes)</strong></a>
    134. 

  134. 			<ul>
    135. 

  135. 				<li><a href="docelement.html#QUOTE">QUOTE</a>
    136. 

  136. 				<li><a href="docelement.html#QUOTE_CONTROL">Quote control</a>
    137. 

  137. 			</ul>
    138. 

  138. 			<li><a href="docelement.html#BLOCKQUOTE_INTRO"><strong>Blockquotes (cited material)</strong></a>
    139. 

  139. 			<ul>
    140. 

  140. 				<li><a href="docelement.html#BLOCKQUOTE">BLOCKQUOTE</a>
    141. 

  141. 				<li><a href="docelement.html#BLOCKQUOTE_CONTROL">Blockquote control</a>
    142. 

  142. 			</ul>
    143. 

  143. 			<li><a href="docelement.html#FOOTNOTE_INTRO"><strong>Footnotes</strong></a>
    144. 

  144. 			<ul>
    145. 

  145. 				<li><a href="docelement.html#FOOTNOTE">FOOTNOTE</a>
    146. 

  146. 				<li><a href="docelement.html#FOOTNOTE_CONTROL">Footnote control</a>
    147. 

  147. 			</ul>
    148. 

  148. 			<li><a href="docelement.html#ENDNOTE_INTRO"><strong>Endnotes</strong></a>
    149. 

  149. 			<ul>
    150. 

  150. 				<li><a href="docelement.html#ENDNOTE">ENDNOTE</a>
    151. 

  151. 				<li><a href="docelement.html#ENDNOTE_CONTROL">Endnote control</a>
    152. 

  152. 			</ul>
    153. 

  153. 			<li><a href="docelement.html#FINIS_INTRO"><strong>Document termination</strong></a>
    154. 

  154. 			<ul>
    155. 

  155. 				<li><a href="docelement.html#FINIS">FINIS</a>
    156. 

  156. 				<li><a href="docelement.html#FINIS_CONTROL">Finis control</a>
    157. 

  157. 			</ul>
    158. 

  158. 		</ul>
    159. 

  159. 		
    160. 

  160. 		<li><a href="headfootpage.html#HEADFOOTPAGE"><strong>HEADERS and FOOTERS</strong></a>
    161. 

  161. 		<br>
    162. 

  162. 		<ul>
    163. 

  163. 			<li><a href="headfootpage.html#HEADFOOTPAGE_INTRO">Introduction to headers/footers</a>
    164. 

  164. 			<li><a href="headfootpage.html#HEADFOOT_MANAGEMENT">Managing headers/footers</a>
    165. 

  165. 			<ul>
    166. 

  166. 				<li><a href="headfootpage.html#HEADERS">HEADERS</a> -- on or off
    167. 

  167. 				<li><a href="headfootpage.html#FOOTERS">FOOTERS</a> -- on or off
    168. 

  168. 				<li><a href="headfootpage.html#FOOTER_ON_FIRST_PAGE">FOOTER_ON_FIRST_PAGE</a>
    169. 

  169. 			</ul>
    170. 

  170. 			<li><a href="headfootpage.html#HEADFOOT_CONTROL">Header/footer control</a>
    171. 

  171. 			<ul>
    172. 

  172. 				<li><a href="headfootpage.html#HDRFTR_STRINGS">Header/footer strings</a>
    173. 

  173. 				<li><a href="headfootpage.html#HDRFTR_STYLE">Header/footer style</a> -- global and part-by-part
    174. 

  174. 				<li><a href="headfootpage.html#HDRFTR_VERTICAL">Header/footer placement and spacing</a>
    175. 

  175. 				<li><a href="headfootpage.html#HDRFTR_SEPARATOR">The header/footer separator rule</a>
    176. 

  176. 			</ul>
    177. 

  177. 		</ul>
    178. 

  178. 		<li><a href="headfootpage.html#PAGINATION"><strong>PAGINATION</strong></a>
    179. 

  179. 		<br>
    180. 

  180. 		<ul>
    181. 

  181. 			<li><a href="headfootpage.html#PAGINATE">PAGINATE</a> -- on or off
    182. 

  182. 			<li><a href="headfootpage.html#PAGENUMBER">PAGENUMBER</a> -- user supplied page number
    183. 

  183. 			<li><a href="headfootpage.html#PAGENUM_STYLE">PAGENUM_STYLE</a> -- digits, roman numerals, etc.
    184. 

  184. 			<li><a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a> -- attach draft/revision information to page numbers
    185. 

  185. 			<li><a href="headfootpage.html#PAGINATE_CONTROL">Pagination control</a>
    186. 

  186. 		</ul>
    187. 

  187. 		<br>
    188. 

  188. 		<li><a href="rectoverso.html#RECTOVERSO"><strong>RECTO_VERSO PRINTING and COLLATING</strong></a>
    189. 

  189. 		<br>
    190. 

  190. 		<ul>
    191. 

  191. 			<li><a href="rectoverso.html#RECTOVERSO_INTRO">Introduction to recto/verso</a>
    192. 

  192. 			<ul>
    193. 

  193. 				<li><a href="rectoverso.html#RECTO_VERSO">RECTO_VERSO</a>
    194. 

  194. 				<li><a href="rectoverso.html#SWITCH_HDRFTR">SWITCH_HEADERS</a> (also FOOTERS)
    195. 

  195. 			</ul>
    196. 

  196. 			<li><a href="rectoverso.html#COLLATE_INTRO">Introduction to collating</a>
    197. 

  197. 			<ul>
    198. 

  198. 				<li><a href="rectoverso.html#COLLATE">COLLATE</a>
    199. 

  199. 			</ul>
    200. 

  200. 		</ul>
    201. 

  201. 	
    202. 

  202. 		<li><a href="cover.html#TOP"><strong>CREATING A COVER PAGE</strong></a>
    203. 

  203. 		<br>
    204. 

  204. 		<li><a href="letters.html#LETTERS"><strong>WRITING LETTERS</strong></a>
    205. 

  205. 		<ul>
    206. 

  206. 			<li><a href="letters.html#LETTERS_INTRO">Introduction to writing letters</a>
    207. 

  207. 			<li><a href="letters.html#TUTORIAL">Tutorial on writing letters</a>
    208. 

  208. 			<li><a href="letters.html#LETTERS_DEFAULTS">Default style for letters</a>
    209. 

  209. 			<li><a href="letters.html#LETTERS_MACROS">The letter macros</a>
    210. 

  210. 		</ul>
    211. 

  211. 	</ul>
    212. 

  212. </ul>
    213. 

  213. <br>
    214. 

  214. <hr>
    215. 

  215. 

  216. <h2><a name="INTRO_MACROS_DOCPROCESSING"><u>Introduction to document processing</u></a></h2>
    217. 

  217. 

  218. As explained in
    219. 

  219. <a href="intro.html#INTRO_DOCPROCESSING">Document processing with mom</a>,
    220. 

  220. document processing uses markup tags to identify document elements
    221. 

  221. such as heads, paragraphs, and so on.  The tags are, of course, macros,
    222. 

  222. but with sensible, readable names that make them easy to grasp and
    223. 

  223. easy to remember.  (And don't forget: if you don't like the
    224. 

  224. &quot;official&quot; name of a tag -- too long, cumbersome
    225. 

  225. to type in, not &quot;intuitive&quot; enough -- you can change it
    226. 

  226. with the
    227. 

  227. <a href="goodies.html#ALIAS">ALIAS</a>
    228. 

  228. macro.)
    229. 

  229. <p>
    230. 

  230. In addition to the tags themselves, <strong>mom</strong> has an
    231. 

  231. extensive array of macros that control how they look and behave.
    232. 

  232. <p>
    233. 

  233. Setting up a <strong>mom</strong> doc is a simple, four-part procedure.
    234. 

  234. You begin by entering information about the document itself (title,
    235. 

  235. subtitle, author, etc.).  Next, you tell <strong>mom</strong> what
    236. 

  236. kind of document you're creating (e.g. chapter, letter, abstract,
    237. 

  237. etc...) and what kind of output you want (typeset, typewritten,
    238. 

  238. draft-style, etc).  Thirdly, you make as many or as few changes to
    239. 

  239. <strong>mom</strong>'s default behaviour as you wish.  Lastly, you
    240. 

  240. invoke the
    241. 

  241. <a href="#START">START</a>
    242. 

  242. macro.  Voilà!  You're ready to write.
    243. 

  243. <p>
    244. 

  244. <hr>
    245. 

  245. 

  246. 

  247. <h2><a name="DEFAULTS"><u>Some document defaults</u></a></h2>
    248. 

  248. 

  249. As is to be expected, <strong>mom</strong> has defaults for everything.
    250. 

  250. If you want to know a particular default, read about it in the
    251. 

  251. description of the pertinent tag.
    252. 

  252. <p>
    253. 

  253. I fear the following may not be adequately covered in the
    254. 

  254. documentation.  Just in case, here they are.
    255. 

  255. <p>
    256. 

  256. <ul>
    257. 

  257. 	<li>the paper size is 8.5x11 inches
    258. 

  258. 	<li>the left and right margins are 1-inch
    259. 

  259. 	<li>the top and bottom margins for document text are plus/minus
    260. 

  260. 		visually 1-inch
    261. 

  261. 	<li>pages are numbered; the number appears centred, at the
    262. 

  262. 		bottom, surrounded by hyphens ( e.g. -6- )
    263. 

  263. 	<li>the first page of a document begins with a
    264. 

  264. 		<a href="definitions.html#TERMS_DOCHEADER">document header</a>
    265. 

  265. 	<li>subsequent pages have
    266. 

  266. 		<a href="definitions.html#TERMS_HEADER">page headers</a>
    267. 

  267. 		with a rule underneath
    268. 

  268. </ul>
    269. 

  269. <p>
    270. 

  270. Another way to check up on document processing defaults is to have
    271. 

  271. a look at the macro file (om.tmac).  Each macro is preceded by a
    272. 

  272. description that (generally) says what its default is (if it has
    273. 

  273. one).
    274. 

  274. <p>
    275. 

  275. <hr>
    276. 

  276. 

  277. <a name="LEADING_NOTE">
    278. 

  278. 	<h2><u>IMPORTANT NOTE on leading/spacing and  bottom margins</u></h2>
    279. 

  279. </a>
    280. 

  280. 

  281. <strong>Mom</strong> takes evenly-aligned  bottom margins in
    282. 

  282. <a href="definitions.html#TERMS_RUNNING">running text</a>
    283. 

  283. very seriously.  Only under a very few (exceptional) circumstances
    284. 

  284. will she allow a bottom margin to &quot;hang&quot; (i.e. to fall
    285. 

  285. short).
    286. 

  286. <p>
    287. 

  287. In order to ensure even bottom margins, <strong>mom</strong>
    288. 

  288. uses the &quot;base&quot; document
    289. 

  289. <a href="definitions.html#TERMS_LEADING">leading</a>
    290. 

  290. in effect <em>at the start of running text on each page</em> (i.e.
    291. 

  291. the leading used in paragraphs) to calculate the spacing of every
    292. 

  292. document element.  Prior to invoking
    293. 

  293. <a href="#START">START</a>,
    294. 

  294. this is set with the
    295. 

  295. <a href="typesetting.html#MACROS_TYPESETTING">typesetting macro</a>
    296. 

  296. <a href="typesetting.html#LEADING">LS</a>,
    297. 

  297. afterwards with the document
    298. 

  298. <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>
    299. 

  299. <a href="#DOC_LEAD">DOC_LEAD</a>.
    300. 

  300. <p>
    301. 

  301. Because <strong>mom</strong> relies so heavily on the base document
    302. 

  302. leading, any change to the leading or spacing on a page will almost
    303. 

  303. certainly have undesirable consequences on that page's bottom margin
    304. 

  304. unless the change is fully compensated for elsewhere on the page.
    305. 

  305. <p>
    306. 

  306. In other words, if you add a few points of space somewhere on a page,
    307. 

  307. you must subtract the same number of points somewhere else on that
    308. 

  308. same page, and vice versa.
    309. 

  309. <p>
    310. 

  310. If it's a question of adding or subtracting full line spaces between
    311. 

  311. or within document elements, you can do so by using the &quot;v&quot;
    312. 

  312. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    313. 

  313. with whatever spacing macro you choose --
    314. 

  314. <a href="typesetting.html#ALD">ALD</a>,
    315. 

  315. <a href="typesetting.html#RLD">RLD</a>,
    316. 

  316. <a href="typesetting.html#SPACE">SPACE</a>
    317. 

  317. -- and <strong>mom</strong> won't object.  &quot;v&quot; means
    318. 

  318. &quot;the current leading&quot;, so she isn't confused by it.  And
    319. 

  319. since &quot;v&quot; accepts decimal fractions, you can add/subtract
    320. 

  320. half linespaces and quarter linespaces with &quot;v&quot; as well,
    321. 

  321. <em>provided you compensate for the fractional linespace somewhere
    322. 

  322. else on the page</em>.
    323. 

  323. <p>
    324. 

  324. If all this seems like too much work, <strong>mom</strong>
    325. 

  325. provides a special macro to get you out of trouble if you've played
    326. 

  326. around with leading and/or spacing.  The macro is called
    327. 

  327. <strong>SHIM</strong> (like those little pieces of wood carpenters
    328. 

  328. use to get their work even, level and snug), and it's described
    329. 

  329. below.
    330. 

  330. <p>
    331. 

  331. 

  332. <!---SHIM--->
    333. 

  333. 

  334. <hr width="66%" align="left">
    335. 

  335. <p>
    336. 

  336. <a name="SHIM"></a>
    337. 

  337. Macro: <strong>SHIM</strong>
    338. 

  338. 

  339. <p>
    340. 

  340. <strong>SHIM</strong> doesn't take any argument.  Use it whenever
    341. 

  341. you've played around with the
    342. 

  342. <a href="definitions.html#TERMS_LEADING">leading</a>
    343. 

  343. or spacing on a page and you
    344. 

  344. need to get <strong>mom</strong>'s document leading back on track.
    345. 

  345. <p>
    346. 

  346. For example, say you want to insert a picture into a document with
    347. 

  347. the special groff macro, <strong>PSPIC</strong> (see the
    348. 

  348. <strong>groff_tmac</strong> man page for usage).
    349. 

  349. <p>
    350. 

  350. Pictures aren't usually conveniently sized in multiples of document
    351. 

  351. leading, which means that when you insert the picture, you disrupt
    352. 

  352. <strong>mom</strong>'s ordered placement of baselines on the page.
    353. 

  353. This will certainly result in a bottom margin that doesn't match the
    354. 

  354. bottom margins of your document's other pages.
    355. 

  355. <p>
    356. 

  356. The solution is to insert <strong>SHIM</strong> after the picture,
    357. 

  357. like this:
    358. 

  358. <p>
    359. 

  359. <pre>
    360. 

  360. 	&lt;some lines of text&gt;
    361. 

  361. 	.PSPIC &lt;full path to picture&gt;
    362. 

  362. 	.SHIM
    363. 

  363. 	&lt;more lines of text&gt;
    364. 

  364. </pre>
    365. 

  365. <strong>SHIM</strong> instructs <strong>mom</strong> to insert as
    366. 

  366. much or a little space after the picture as is needed to ensure that
    367. 

  367. the baseline of the next
    368. 

  368. <a href="definitions.html#TERMS_OUTPUTLINE">output line</a>
    369. 

  369. falls where <strong>mom</strong> would have put it had you not
    370. 

  370. disrupted the normal flow of output lines with the picture.
    371. 

  371. <p>
    372. 

  372. And say, on previewing the above example, you find that the picture
    373. 

  373. doesn't centre nicely between the lines of text, you can always do
    374. 

  374. <p>
    375. 

  375. <pre>
    376. 

  376. 	&lt;some lines of text&gt;
    377. 

  377. 	.RLD 3p
    378. 

  378. 	.PSPIC &lt;full path to picture&gt;
    379. 

  379. 	.SHIM
    380. 

  380. 	&lt;more lines of text&gt;
    381. 

  381. </pre>
    382. 

  382. 

  383. to raise the picture slightly
    384. 

  384. (<strong>R</strong>everse <strong>L</strong>ea<strong>D</strong>
    385. 

  385. 3 points; see
    386. 

  386. <a href="typesetting.html#RLD">RLD</a>),
    387. 

  387. and still have <strong>SHIM</strong> ensure that text underneath
    388. 

  388. falls exactly where it's supposed to.
    389. 

  389. <p>
    390. 

  390. <hr>
    391. 

  391. 

  392. <a name="SETUP"><h2><u>Document setup</u></h2></a>
    393. 

  393. <p>
    394. 

  394. <a name="DOCPROCESSING_TUT">
    395. 

  395. 	<h3><u>Tutorial -- Setting up a mom document</u></h3>
    396. 

  396. </a>
    397. 

  397. There are four &quot;parts&quot; to setting up a <strong>mom</strong>
    398. 

  398. doc (three, actually, with one optional).  Before we proceed, though,
    399. 

  399. be reassured that something as simple as
    400. 

  400. <p>
    401. 

  401. <pre>
    402. 

  402. 	.TITLE     "By the Shores of Lake Attica"
    403. 

  403. 	.AUTHOR    "Rosemary Winspeare"
    404. 

  404. 	.PRINTSTYLE TYPESET
    405. 

  405. 	.START
    406. 

  406. </pre>
    407. 

  407. 

  408. produces a beautifully typeset 8.5x11 document, with a
    409. 

  409. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
    410. 

  410. at the top of page 1,
    411. 

  411. <a href="definitions.html#TERMS_HEADER">page headers</a>
    412. 

  412. with the title and author on subsequent
    413. 

  413. pages, and page numbers at the bottom of each page.  In the course
    414. 

  414. of the document, heads, subheads, citations, quotes, epigraphs,
    415. 

  415. and so on, all come out looking neat, trim, and professional.
    416. 

  416. <p>
    417. 

  417. For the purposes of this tutorial, we're going to set up a short
    418. 

  418. story -- <em>My Pulitzer Winner</em> by Joe Blow.  Thankfully,
    419. 

  419. we don't have to look at story itself, just the setup.
    420. 

  420. Joe wants the document
    421. 

  421. <p>
    422. 

  422. <ul>
    423. 

  423. 	<li>to be draft 7, revision 39;
    424. 

  424. 	<li>to use the &quot;default&quot; style of document formatting:
    425. 

  425. 	<li>to print as draft-style output (instead of &quot;final&quot; copy output);
    426. 

  426. 	<li>to be typeset, in Helvetica, 12 on 14,
    427. 

  427. 		<a href="definitions.html#TERMS_RAG">rag-right</a>;
    428. 

  428. 	<li>to have <a href="definitions.html#TERMS_FOOTER">footers</a>
    429. 

  429. 		instead of
    430. 

  430. 		<a href="definitions.html#TERMS_HEADER">headers</a>;
    431. 

  431. 	<li>to use a single asterisk for
    432. 

  432. 		<a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>.
    433. 

  433. </ul>
    434. 

  434. <p>
    435. 

  435. Joe Blow has no taste in typography.  His draft won't look pretty,
    436. 

  436. but this is, after all, a tutorial; we're after examples, not beauty.
    437. 

  437. <h3><u>Step 1</u></h3>
    438. 

  438. 

  439. The first step in setting up any document is giving <strong>mom</strong>
    440. 

  440. some reference information.  The reference macros are:
    441. 

  441. <p>
    442. 

  442. <ul>
    443. 

  443. 	<li>TITLE
    444. 

  444. 	<li>DOCTITLE
    445. 

  445. 	<li>COVERTITLE
    446. 

  446. 	<li>SUBTITLE
    447. 

  447. 	<li>AUTHOR
    448. 

  448. 	<li>CHAPTER -- the chapter number
    449. 

  449. 	<li>DRAFT -- the draft number
    450. 

  450. 	<li>REVISION -- the revision number
    451. 

  451. 	<li>COPYRIGHT -- only used on cover pages
    452. 

  452. 	<li>MISC -- only used on cover pages
    453. 

  453. 	<li>COVER_TITLE -- only on cover pages; only if needed
    454. 

  454. 	<li>DOC_COVER_TITLE -- only on document cover pages; only if needed
    455. 

  455. </ul>
    456. 

  456. <p>
    457. 

  457. You can use as many or as few as you wish, although at a minimum,
    458. 

  458. you'll probably fill in <strong>TITLE</strong> (unless the document's
    459. 

  459. a letter) and <strong>AUTHOR</strong>.  Order doesn't matter.
    460. 

  460. You can separate the
    461. 

  461. <a href="definitions.html#TERMS_ARGUMENTS">arguments</a>
    462. 

  462. from the macros by any number of spaces.  The following are
    463. 

  463. what you'd need to start Joe Blow's story.
    464. 

  464. <p>
    465. 

  465. <pre>
    466. 

  466. 	.TITLE    "My Pulitzer Winner"
    467. 

  467. 	.AUTHOR   "Joe Blow"
    468. 

  468. 	.DRAFT     7
    469. 

  469. 	.REVISION  39
    470. 

  470. </pre>
    471. 

  471. 

  472. <h3><u>Step 2</u></h3>
    473. 

  473. 

  474. Once you've given <strong>mom</strong> the reference information she
    475. 

  475. needs, you tell her how you want your document formatted.  What kind
    476. 

  476. of document is it?  Should it be typeset or typewritten?  Is this
    477. 

  477. a &quot;final&quot; copy (for the world to see) or just a draft?
    478. 

  478. <strong>Mom</strong> calls the macros that answer these questions
    479. 

  479. &quot;the docstyle macros.&quot;  They are:
    480. 

  480. <p>
    481. 

  481. <ul>
    482. 

  482. 	<li>DOCTYPE -- the type of document (default, chapter, user-defined, letter)
    483. 

  483. 	<li>PRINTSTYLE -- typeset or typewritten
    484. 

  484. 	<li>COPYSTYLE  -- draft or final copy
    485. 

  485. </ul>
    486. 

  486. <p>
    487. 

  487. <strong>Mom</strong> has defaults for <strong>DOCTYPE</strong>
    488. 

  488. and <strong>COPYSTYLE</strong>; if they're what you want, you
    489. 

  489. don't need to include them here.  However, <strong>PRINTSTYLE</strong>
    490. 

  490. has no default and MUST be present in every formatted document.
    491. 

  491. If you omit it, <strong>mom</strong> won't process the document AND
    492. 

  492. she'll complain (both to stderr and as a single printed sheet with
    493. 

  493. a warning).  Moms -- they can be so annoying sometimes. &lt;sigh&gt;
    494. 

  494. <p>
    495. 

  495. Adding to what we already have, the next bit of setup for Joe
    496. 

  496. Blow's story looks like this:
    497. 

  497. <p>
    498. 

  498. <pre>
    499. 

  499. 	.TITLE    "My Pulitzer Winner"
    500. 

  500. 	.AUTHOR   "Joe Blow"
    501. 

  501. 	.DRAFT     7
    502. 

  502. 	.REVISION  39
    503. 

  503. 	\#
    504. 

  504. 	.DOCTYPE     DEFAULT \"Superfluous; mom uses DOCTYPE DEFAULT by default
    505. 

  505. 	.PRINTSTYLE  TYPESET
    506. 

  506. 	.COPYSTYLE   DRAFT
    507. 

  507. </pre>
    508. 

  508. 

  509. Notice the use of the
    510. 

  510. <a href="definitions.html#TERMS_COMMENTLINES">comment line</a>
    511. 

  511. ( \# ), a handy way to keep groups of macros visually separated
    512. 

  512. for easy reading in a text editor.
    513. 

  513. 

  514. <h3><u>Step 3</u></h3>
    515. 

  515. 

  516. This step -- completely optional -- is where you, the user, take
    517. 

  517. charge.  <strong>Mom</strong> has defaults for <em>everything</em>,
    518. 

  518. but who's ever satisfied with defaults?  Use any of the <a
    519. 

  519. href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
    520. 

  520. here to change <strong>mom</strong>'s document defaults (paper
    521. 

  521. size, margins, family, point size, line space, rag, etc), or
    522. 

  522. any of the document processing macros that set/change/control
    523. 

  523. the appearance of document elements.  Think of this as the
    524. 

  524. &quot;style-sheet &quot; section of a document.  And please note:
    525. 

  525. you MUST give <strong>mom</strong> a
    526. 

  526. <a href="#PRINTSTYLE">PRINTSTYLE</a>
    527. 

  527. directive <strong>before</strong> making any such changes.
    528. 

  528. <p>
    529. 

  529. Joe Blow wants his story printed in Helvetica, 12 on 14, rag
    530. 

  530. right, with
    531. 

  531. <a href="definitions.html#TERMS_FOOTER">page footers</a>
    532. 

  532. instead of
    533. 

  533. <a href="definitions.html#TERMS_HEADER">page headers</a>
    534. 

  534. and a single asterisk for the
    535. 

  535. <a href="definitions.html#TERMS_LINEBREAK">linebreak</a>
    536. 

  536. character.  None of these requirements conforms
    537. 

  537. to <strong>mom</strong>'s defaults for the chosen
    538. 

  538. <strong>PRINTSTYLE</strong> (TYPESET), so we change them here.
    539. 

  539. The setup for Joe Blow's story now looks like this:
    540. 

  540. <p>
    541. 

  541. <pre>
    542. 

  542. 	.TITLE    "My Pulitzer Winner"
    543. 

  543. 	.AUTHOR   "Joe Blow"
    544. 

  544. 	.DRAFT     7
    545. 

  545. 	.REVISION  39
    546. 

  546. 	\#
    547. 

  547. 	.DOCTYPE     DEFAULT
    548. 

  548. 	.PRINTSTYLE  TYPESET
    549. 

  549. 	.COPYSTYLE   DRAFT
    550. 

  550. 	\#
    551. 

  551. 	.FAMILY  H
    552. 

  552. 	.PT_SIZE 12
    553. 

  553. 	.LS      14
    554. 

  554. 	.QUAD    LEFT    \"i.e. rag right
    555. 

  555. 	.FOOTERS
    556. 

  556. 	.LINEBREAK_CHAR *
    557. 

  557. </pre>
    558. 

  558. 

  559. <h3><u>Step 4</u></h3>
    560. 

  560. The final step in setting up a document is telling <strong>mom</strong>
    561. 

  561. to start document processing.  It's a no-brainer, just the single macro
    562. 

  562. <strong>START</strong>.  Other than <strong>PRINTSTYLE</strong>, it's
    563. 

  563. the only macro required for document processing (although
    564. 

  564. I can't guarantee you'll like the results of using just the two).
    565. 

  565. <p>
    566. 

  566. Here's the complete setup for <em>My Pulitzer Winner</em>:
    567. 

  567. <p>
    568. 

  568. <pre>
    569. 

  569. 	.TITLE    "My Pulitzer Winner"
    570. 

  570. 	.AUTHOR   "Joe Blow"
    571. 

  571. 	.DRAFT     7
    572. 

  572. 	.REVISION  39
    573. 

  573. 	\#
    574. 

  574. 	.DOCTYPE     DEFAULT
    575. 

  575. 	.PRINTSTYLE  TYPESET
    576. 

  576. 	.COPYSTYLE   DRAFT
    577. 

  577. 	\#
    578. 

  578. 	.FAMILY   H
    579. 

  579. 	.PT_SIZE  12
    580. 

  580. 	.LS       14
    581. 

  581. 	.QUAD     LEFT    \"i.e. rag right
    582. 

  582. 	.FOOTERS
    583. 

  583. 	.LINEBREAK_CHAR *
    584. 

  584. 	\#
    585. 

  585. 	.START
    586. 

  586. </pre>
    587. 

  587. 

  588. As pointed out earlier, Joe Blow is no typographer.  Given that all he
    589. 

  589. needs is a printed draft of his work, a simpler setup would have been:
    590. 

  590. <p>
    591. 

  591. <pre>
    592. 

  592. 	.TITLE    "My Pulitzer Winner"
    593. 

  593. 	.AUTHOR   "Joe Blow"
    594. 

  594. 	.DRAFT     7
    595. 

  595. 	.REVISION  39
    596. 

  596. 	\#
    597. 

  597. 	.PRINTSTYLE  TYPEWRITE
    598. 

  598. 	.COPYSTYLE   DRAFT
    599. 

  599. 	\#
    600. 

  600. 	.START
    601. 

  601. </pre>
    602. 

  602. 

  603. <kbd>.PRINTSTYLE TYPEWRITE</kbd>, above, means that Joe's work
    604. 

  604. will come out &quot;typewritten, double-spaced&quot;, making the
    605. 

  605. blue-pencilling he (or someone else) is sure to do much
    606. 

  606. easier (which is why many publishers and agents still insist on
    607. 

  607. typewritten, double-spaced copy).
    608. 

  608. <p>
    609. 

  609. When J. Blow stops re-writing and decides to print off a final,
    610. 

  610. typeset copy of his work for the world to see, he need only
    611. 

  611. make two changes to the (simplified) setup:
    612. 

  612. <p>
    613. 

  613. <pre>
    614. 

  614. 	.TITLE    "My Pulitzer Winner"
    615. 

  615. 	.AUTHOR   "Joe Blow"
    616. 

  616. 	.DRAFT     7
    617. 

  617. 	.REVISION  39
    618. 

  618. 	\#
    619. 

  619. 	.PRINTSTYLE  TYPESET  \"first change
    620. 

  620. 	.COPYSTYLE   FINAL    \"second change
    621. 

  621. 	\#
    622. 

  622. 	.START
    623. 

  623. </pre>
    624. 

  624. 

  625. In the above, <kbd>.DRAFT 7, .REVISION 39,</kbd> and <kbd>.COPYSTYLE
    626. 

  626. FINAL</kbd> are actually superfluous.  The draft and revision numbers
    627. 

  627. aren't used when <strong>COPYSTYLE</strong> is <strong>FINAL</strong>,
    628. 

  628. and <strong>COPYSTYLE FINAL</strong> is <strong>mom</strong>'s
    629. 

  629. default unless you tell her otherwise.  BUT... to judge from the
    630. 

  630. number of drafts already, J. Blow may very well decide his
    631. 

  631. &quot;final&quot; version still isn't up to snuff.  Hence, he might
    632. 

  632. as well leave in the superfluous macros.  That way, when draft 7,
    633. 

  633. rev. 62 becomes draft 8, rev. 1, he'll be ready to tackle his Pulitzer
    634. 

  634. winner again.
    635. 

  635. <p>
    636. 

  636. <hr>
    637. 

  637. 

  638. <!========================================================================>
    639. 

  639. 

  640. <a name="REFERENCE_MACROS">
    641. 

  641. 	<h2><u>The Reference Macros</u></h2>
    642. 

  642. </a>
    643. 

  643. 

  644. The reference macros give <strong>mom</strong> the information
    645. 

  645. she needs to generate
    646. 

  646. <a href="definitions.html#TERMS_DOCHEADER">docheaders</a>,
    647. 

  647. <a href="definitions.html#TERMS_HEADER">page headers</a>,
    648. 

  648. and
    649. 

  649. <a href="cover.html#COVER_TOP">covers</a>.
    650. 

  650. They must go at the top of any file that uses <strong>mom</strong>'s
    651. 

  651. document processing macros.
    652. 

  652. <p>
    653. 

  653. <a name="INDEX_REFERENCE">
    654. 

  654. 	<h3><u>Reference macros list</u></h3>
    655. 

  655. </a>
    656. 

  656. 

  657. <ul>
    658. 

  658. 	<li><a href="#TITLE">TITLE</a>
    659. 

  659. 	<li><a href="#DOC_TITLE">DOCTITLE</a>
    660. 

  660. 	<li><a href="#SUBTITLE">SUBTITLE</a>
    661. 

  661. 	<li><a href="#AUTHOR">AUTHOR</a>
    662. 

  662. 	<li><a href="#CHAPTER">CHAPTER</a>
    663. 

  663. 	<li><a href="#CHAPTER_TITLE">CHAPTER_TITLE</a>
    664. 

  664. 	<li><a href="#DRAFT">DRAFT</a>
    665. 

  665. 	<li><a href="#REVISION">REVISION</a>
    666. 

  666. 	<li><a href="#COPYRIGHT">COPYRIGHT</a>
    667. 

  667. 	<li><a href="#MISC">MISC</a>
    668. 

  668. 	<li><a href="#COVERTITLE">COVERTITLE</a>
    669. 

  669. </ul>
    670. 

  670. <br>
    671. 

  671. 

  672. <!---TITLE--->
    673. 

  673. 

  674. <hr width="66%" align="left">
    675. 

  675. <p>
    676. 

  676. <a name="TITLE"></a>
    677. 

  677. <nobr>Macro: <strong>TITLE</strong> &quot;&lt;title&gt;&quot;</nobr>
    678. 

  678. <br>
    679. 

  679. <em>*Argument must be enclosed in double-quotes</em>
    680. 

  680. 

  681. <p>
    682. 

  682. The title string can be caps or caps/lower-case; it's up to you.
    683. 

  683. In
    684. 

  684. <a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
    685. 

  685. the title will appear in the
    686. 

  686. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
    687. 

  687. exactly as you typed it.  However, <strong>mom</strong> converts
    688. 

  688. the title to all caps in
    689. 

  689. <a href="definitions.html#TERMS_HEADER">page headers</a>
    690. 

  690. unless you turn that feature off (see
    691. 

  691. <a href="headfootpage.html#_CAPS">HEADER_&lt;POSITION&gt;_CAPS</a>). In
    692. 

  692. <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    693. 

  693. the title always gets converted to caps.
    694. 

  694. <p>
    695. 

  695. <strong>NOTE:</strong> If your
    696. 

  696. <a href="#DOCTYPE">DOCTYPE</a>
    697. 

  697. is <strong>CHAPTER</strong>, <strong>TITLE</strong> should be the
    698. 

  698. title of the opus, not &quot;CHAPTER whatever&quot;.
    699. 

  699. <p>
    700. 

  700. 

  701. <!---DOCTITLE--->
    702. 

  702. 

  703. <hr width="66%" align="left">
    704. 

  704. <p>
    705. 

  705. <a name="DOCTITLE"></a>
    706. 

  706. <nobr>Macro: <strong>DOCTITLE</strong> &quot;&lt;overall document title&gt;&quot;</nobr>
    707. 

  707. <br>
    708. 

  708. <em>*Argument must be enclosed in double-quotes</em>
    709. 

  709. 

  710. <p>
    711. 

  711. <strong>NOTE:</strong> This macro should be used only if your
    712. 

  712. <a href="#DOCTYPE">DOCTYPE</a>
    713. 

  713. is <strong>DEFAULT</strong> (which is <strong>mom</strong>'s
    714. 

  714. default).
    715. 

  715. <p>
    716. 

  716. When you're creating a single document, say, an essay or a short
    717. 

  717. story, you have no need of this macro.
    718. 

  718. <a href="#TITLE">TITLE</a>
    719. 

  719. takes care of all your title needs.
    720. 

  720. <p>
    721. 

  721. However if you're 
    722. 

  722. <a href="rectoverso.html#COLLATE">collating</a>
    723. 

  723. a bunch of documents together, say, to print out a report containing
    724. 

  724. many articles with different titles, or a book of short stories, you
    725. 

  725. need <strong>DOCTITLE</strong>.
    726. 

  726. <p>
    727. 

  727. <strong>DOCTITLE</strong> tells <strong>mom</strong> the title
    728. 

  728. of the complete document (as opposed to the title of each article
    729. 

  729. or entitled section).
    730. 

  730. <p>
    731. 

  731. The doctitle string can be caps or caps/lower-case; it's up to you.
    732. 

  732. In
    733. 

  733. <a href="#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
    734. 

  734. by default, the doctitle appears in the rightmost position of
    735. 

  735. <a href="definitions.html#TERMS_HEADER">page headers</a>,
    736. 

  736. all in caps unless you turn that feature off (see
    737. 

  737. <a href="headfootpage.html#_CAPS">HEADER_&lt;POSITION&gt;_CAPS</a>). In
    738. 

  738. <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    739. 

  739. the doctitle always gets converted to caps.
    740. 

  740. <p>
    741. 

  741. <strong>NOTE:</strong> If your
    742. 

  742. <a href="#DOCTYPE">DOCTYPE</a>
    743. 

  743. is <strong>CHAPTER</strong>, you don't need
    744. 

  744. <strong>DOCTITLE</strong>.  <strong>TITLE</strong> takes care of
    745. 

  745. everything.
    746. 

  746. <p>
    747. 

  747. 

  748. <!---SUBTITLE--->
    749. 

  749. 

  750. <hr width="66%" align="left">
    751. 

  751. <p>
    752. 

  752. <a name="SUBTITLE"></a>
    753. 

  753. <nobr>Macro: <strong>SUBTITLE</strong> &quot;&lt;subtitle&gt;&quot;</nobr>
    754. 

  754. <br>
    755. 

  755. <em>*Argument must be enclosed in double-quotes</em>
    756. 

  756. 

  757. <p>
    758. 

  758. The subtitle string can be caps or caps/lower-case.  Since a
    759. 

  759. document's subtitle appears only in the
    760. 

  760. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
    761. 

  761. and the title is most likely in caps, I recommend caps/lower case.
    762. 

  762. <p>
    763. 

  763. 

  764. <!---AUTHOR--->
    765. 

  765. 

  766. <hr width="66%" align="left">
    767. 

  767. <p>
    768. 

  768. <a name="AUTHOR"></a>
    769. 

  769. <nobr>Macro: <strong>AUTHOR</strong> &quot;&lt;author string&gt;&quot; [ &quot;&lt;author2 string&gt;&quot; &quot;&lt;author3 string&gt;&quot; ... ]</nobr>
    770. 

  770. <br>
    771. 

  771. <em>*Multiple arguments must all be enclosed in double-quotes</em>
    772. 

  772. 

  773. <p>
    774. 

  774. Each author string can hold as many names as you like, e.g.
    775. 

  775. <p>
    776. 

  776. <pre>
    777. 

  777. 	.AUTHOR "Joe Blow"
    778. 

  778. 	    or
    779. 

  779. 	.AUTHOR "Joe Blow, Jane Doe" "John Hancock"
    780. 

  780. </pre>
    781. 

  781. 

  782. <strong>Mom</strong> prints each string that's enclosed in
    783. 

  783. double-quotes on a separate line in the
    784. 

  784. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
    785. 

  785. however only the first string appears in
    786. 

  786. <a href="definitions.html#TERMS_HEADER">page headers</a>.
    787. 

  787. If you want <strong>mom</strong> to put something else in the author
    788. 

  788. part of page headers (say, just the last names of a document's two
    789. 

  789. authors), redefine the appropriate part of the header (see
    790. 

  790. <a href="headfootpage.html#HEADER_CONTROL">header/footer control</a>).
    791. 

  791. <p>
    792. 

  792. The strings can be caps or caps/lower-case.  I recommend caps/lower
    793. 

  793. case.
    794. 

  794. <p>
    795. 

  795. 

  796. <!---CHAPTER--->
    797. 

  797. 

  798. <hr width="66%" align="left">
    799. 

  799. <p>
    800. 

  800. <a name="CHAPTER"></a>
    801. 

  801. <nobr>Macro: <strong>CHAPTER</strong> &lt;chapter number&gt;</nobr>
    802. 

  802. 

  803. <p>
    804. 

  804. The chapter number can be in any form you like -- a digit, a roman
    805. 

  805. numeral, a word.  If you choose
    806. 

  806. <a href="#DOCTYPE">DOCTYPE CHAPTER</a>,
    807. 

  807. <strong>mom</strong> prints whatever argument you pass
    808. 

  808. <strong>CHAPTER</strong> beside the word &quot;Chapter&quot; as a
    809. 

  809. single line
    810. 

  810. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>.
    811. 

  811. She also puts the same thing in the middle of
    812. 

  812. <a href="definitions.html#TERMS_HEADER">page headers</a>.
    813. 

  813. <p>
    814. 

  814. Please note that if your argument to <strong>CHAPTER</strong> runs
    815. 

  815. to more than one word, you must enclose the argument in
    816. 

  816. double-quotes.
    817. 

  817. <p>
    818. 

  818. If you're not using <strong>DOCTYPE CHAPTER</strong>, the macro serves
    819. 

  819. no purpose and <strong>mom</strong> ignores it.
    820. 

  820. <p>
    821. 

  821. <a name="CHAPTER_STRING"><strong>CHAPTER_STRING</strong></a>
    822. 

  822. <p>
    823. 

  823. If you're not writing in English, you can ask <strong>mom</strong>
    824. 

  824. to use the word for &quot;chapter&quot; in your own language by
    825. 

  825. telling her what it is with the <strong>CHAPTER_STRING</strong>
    826. 

  826. macro, like this:
    827. 

  827. <p>
    828. 

  828. <pre>
    829. 

  829. 	.CHAPTER_STRING "Chapître"
    830. 

  830. </pre>
    831. 

  831. 

  832. You can also use <strong>CHAPTER_STRING</strong> if you want
    833. 

  833. &quot;CHAPTER&quot; instead of &quot;Chapter&quot; in the doc- and
    834. 

  834. page-headers.
    835. 

  835. <p>
    836. 

  836. 

  837. <!---CHAPTER_TITLE--->
    838. 

  838. 

  839. <hr width="66%" align="left">
    840. 

  840. <p>
    841. 

  841. <a name="CHAPTER_TITLE"></a>
    842. 

  842. <nobr>Macro: <strong>CHAPTER_TITLE</strong> &quot;&lt;chapter title&gt;&quot;</nobr>
    843. 

  843. <br>
    844. 

  844. <em>*Argument must be enclosed in double-quotes</em>
    845. 

  845. 

  846. <p>
    847. 

  847. If, either in addition to or instead of &quot;Chapter #&quot; appearing
    848. 

  848. at the top of chapters, you want your chapter to have a title, use
    849. 

  849. <strong>CHAPTER_TITLE</strong>, with your title enclosed in
    850. 

  850. double-quotes, like this:
    851. 

  851. <p>
    852. 

  852. <pre>
    853. 

  853. 	.CHAPTER_TITLE "The DMCA Nazis"
    854. 

  854. </pre>
    855. 

  855. 

  856. If you've used
    857. 

  857. <a href="#CHAPTER">CHAPTER</a> to give the chapter a number,
    858. 

  858. both &quot;Chapter #&quot; and the chapter title will appear at the
    859. 

  859. top of the chapter, like this:
    860. 

  860. <p>
    861. 

  861. <pre>
    862. 

  862.                        Chapter 1
    863. 

  863.                     The DMCA Nazis
    864. 

  864. </pre>
    865. 

  865. 

  866. In such a case, by default, only the chapter's title will appear in the
    867. 

  867. <a href="definitions.html#TERMS_HEADER">page headers</a>,
    868. 

  868. not &quot;Chapter #&quot;.
    869. 

  869. <p>
    870. 

  870. If you omit <strong>CHAPTER</strong> when setting up your reference
    871. 

  871. macros, only the title will appear, both at the top of page one and in
    872. 

  872. subsequent page headers.
    873. 

  873. <p>
    874. 

  874. The style of the chapter title can be altered by
    875. 

  875. <a href="docelement.html#DOCELEMENT_CONTROL">control macros</a>,
    876. 

  876. e.g. <strong>CHAPTER_TITLE_FAMILY</strong>,
    877. 

  877. <strong>CHAPTER_TITLE_FONT</strong>, etc.  The default family,
    878. 

  878. font and point size are Times Roman, Bold Italic, 4 points larger
    879. 

  879. than
    880. 

  880. <a href="definitions.html#TERMS_RUNNING">running text</a>.
    881. 

  881. <p>
    882. 

  882. 

  883. <!---DRAFT--->
    884. 

  884. 

  885. <hr width="66%" align="left">
    886. 

  886. <p>
    887. 

  887. <a name="DRAFT"></a>
    888. 

  888. <nobr>Macro: <strong>DRAFT</strong> &lt;draft #&gt;</nobr>
    889. 

  889. 

  890. <p>
    891. 

  891. <strong>DRAFT</strong> only gets used with
    892. 

  892. <a href="#COPYSTYLE">COPYSTYLE DRAFT</a>.
    893. 

  893. If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong> (the
    894. 

  894. default), <strong>mom</strong> ignores <strong>DRAFT</strong>.
    895. 

  895. <strong>DRAFT</strong> accepts both alphabetic and numeric
    896. 

  896. arguments, hence it's possible to do either
    897. 

  897. <p>
    898. 

  898. <pre>
    899. 

  899. 	.DRAFT 2
    900. 

  900. 	   or
    901. 

  901. 	.DRAFT Two
    902. 

  902. </pre>
    903. 

  903. 

  904. <strong>Mom</strong> prints the argument to <strong>.DRAFT</strong>
    905. 

  905. (i.e. the draft number) beside the word &quot;Draft&quot; in the
    906. 

  906. middle part of
    907. 

  907. <a href="definitions.html#TERMS_HEADER">page headers</a>.
    908. 

  908. <p>
    909. 

  909. <strong>A small word of caution:</strong> If your argument to
    910. 

  910. <strong>.DRAFT</strong> is more than one word long, you must
    911. 

  911. enclose the argument in double-quotes.
    912. 

  912. <p>
    913. 

  913. You may, if you wish, invoke <strong>.DRAFT</strong> without an
    914. 

  914. argument, in which case, no draft number will be printed beside
    915. 

  915. &quot;Draft&quot; in headers or footers.
    916. 

  916. <p>
    917. 

  917. <a name="DRAFT_STRING"><strong>DRAFT_STRING</strong></a>
    918. 

  918. <p>
    919. 

  919. If you're not writing in English, you can ask <strong>mom</strong>
    920. 

  920. to use the word for &quot;draft&quot; in your own language by
    921. 

  921. telling her what it is with the <strong>DRAFT_STRING</strong> macro,
    922. 

  922. like this:
    923. 

  923. <p>
    924. 

  924. <pre>
    925. 

  925. 	.DRAFT_STRING "Jet"
    926. 

  926. </pre>
    927. 

  927. 

  928. Equally, <strong>DRAFT_STRING</strong> can be used to roll your own
    929. 

  929. solution to something other than the word &quot;Draft.&quot;  For
    930. 

  930. example, you might want &quot;Trial run alpha-three&quot; to appear
    931. 

  931. in the headers of a draft version.  You'd accomplish this by doing
    932. 

  932. <p>
    933. 

  933. <pre>
    934. 

  934. 	.DRAFT alpha-three
    935. 

  935. 	.DRAFT_STRING "Trial run
    936. 

  936. </pre>
    937. 

  937. 

  938. <strong>.DRAFT</strong> without an argument, above, ensures that
    939. 

  939. only the <strong>DRAFT_STRING</strong> gets printed.
    940. 

  940. <p>
    941. 

  941. <strong>NOTE:</strong> If you define both a blank <strong>.DRAFT</strong>
    942. 

  942. and a blank <strong>.DRAFT_STRING</strong>, <strong>mom</strong>
    943. 

  943. skips the draft field in headers entirely.  If this is what you
    944. 

  944. want, this is also the only way to do it.  Simply leaving out
    945. 

  945. <strong>.DRAFT</strong> and <strong>.DRAFT_STRING</strong> will
    946. 

  946. result in <strong>mom</strong> using her default, which is to print
    947. 

  947. &quot;Draft 1&quot;.
    948. 

  948. <p>
    949. 

  949. 

  950. <!---REVISION--->
    951. 

  951. 

  952. <hr width="66%" align="left">
    953. 

  953. <p>
    954. 

  954. <a name="REVISION"></a>
    955. 

  955. <nobr>Macro: <strong>REVISION</strong> &lt;revision #&gt;</nobr>
    956. 

  956. 

  957. <p>
    958. 

  958. <strong>REVISION</strong> only gets used with
    959. 

  959. <a href="#COPYSTYLE">COPYSTYLE DRAFT</a>.
    960. 

  960. If the <strong>COPYSTYLE</strong> is <strong>FINAL</strong>
    961. 

  961. (the default), <strong>mom</strong> ignores the
    962. 

  962. <strong>REVISION</strong> macro. <strong>REVISION</strong> accepts
    963. 

  963. both alphabetic and numeric arguments, hence it's possible to do
    964. 

  964. either
    965. 

  965. <p>
    966. 

  966. <pre>
    967. 

  967. 	.REVISION 2
    968. 

  968. 	   or
    969. 

  969. 	.REVISION Two
    970. 

  970. </pre>
    971. 

  971. 

  972. <strong>Mom</strong> prints the revision number beside the shortform
    973. 

  973. &quot;Rev.&quot; in the middle part of
    974. 

  974. <a href="definitions.html#TERMS_HEADER">page headers</a>.
    975. 

  975. <p>
    976. 

  976. <strong>A small word of caution:</strong> If your argument to
    977. 

  977. <strong>.REVISION</strong> is more than one word long, you must
    978. 

  978. enclose the argument in double-quotes.
    979. 

  979. <p>
    980. 

  980. You may, if you wish, invoke <strong>.REVISION</strong> without an
    981. 

  981. argument, in which case, no revision number will be printed beside
    982. 

  982. &quot;Rev.&quot; in headers or footers.
    983. 

  983. <p>
    984. 

  984. <a name="REVISION_STRING"><strong>REVISION_STRING</strong></a>
    985. 

  985. <p>
    986. 

  986. If you're not writing in English, you can ask <strong>mom</strong>
    987. 

  987. to use the word for &quot;revision,&quot; or a shortform
    988. 

  988. thereof, in your own language by telling her what it is with the
    989. 

  989. <strong>REVISION_STRING</strong> macro, like this:
    990. 

  990. <p>
    991. 

  991. <pre>
    992. 

  992. 	.REVISION_STRING "Rév."
    993. 

  993. </pre>
    994. 

  994. 

  995. Additionally, you may sometimes want to make use of
    996. 

  996. <strong>mom</strong>'s
    997. 

  997. <a href="#COPYSTYLE">COPYSTYLE DRAFT</a>
    998. 

  998. but not actually require any draft information.  For example, you
    999. 

  999. might like <strong>mom</strong> to indicate only the revision number
    1000. 

  1000. of your document.  The way to do that is to define an empty
    1001. 

  1001. <strong>.DRAFT</strong> and <strong>.DRAFT_STRING</strong> in
    1002. 

  1002. addition to <strong>.REVISION</strong>, like this:
    1003. 

  1003. <p>
    1004. 

  1004. <pre>
    1005. 

  1005. 	.DRAFT
    1006. 

  1006. 	.DRAFT_STRING
    1007. 

  1007. 	.REVISION 2
    1008. 

  1008. </pre>
    1009. 

  1009. 

  1010. <p>
    1011. 

  1011. Equally, if you want to roll your own solution to what revision
    1012. 

  1012. information appears in headers, you could do something like this:
    1013. 

  1013. <pre>
    1014. 

  1014. 	.DRAFT
    1015. 

  1015. 	.DRAFT_STRING
    1016. 

  1016. 	.REVISION "two-twenty-two"
    1017. 

  1017. 	.REVISION_STRING "Revision"
    1018. 

  1018. </pre>
    1019. 

  1019. 

  1020. <p>
    1021. 

  1021. The above, naturally, has no draft information.  If you want to
    1022. 

  1022. roll your own <strong>.DRAFT</strong> and/or
    1023. 

  1023. <strong>.DRAFT_STRING</strong> as well, simply supply arguments to
    1024. 

  1024. either or both.
    1025. 

  1025. <p>
    1026. 

  1026. 

  1027. <!---COPYRIGHT--->
    1028. 

  1028. 

  1029. <hr width="66%" align="left">
    1030. 

  1030. <p>
    1031. 

  1031. <a name="COPYRIGHT"></a>
    1032. 

  1032. <nobr>Macro: <strong>COPYRIGHT</strong> &quot;&lt;copyright info&gt;&quot;</nobr>
    1033. 

  1033. <br>
    1034. 

  1034. <em>*Argument must be enclosed in double-quotes</em>
    1035. 

  1035. 

  1036. <p>
    1037. 

  1037. The argument passed to <strong>COPYRIGHT</strong> is only used on
    1038. 

  1038. cover or doc cover pages, and then only if the argument COPYRIGHT is
    1039. 

  1039. passed to
    1040. 

  1040. <a href="cover.html#COVER">COVER</a>
    1041. 

  1041. or
    1042. 

  1042. <a href="cover.html#DOC_COVER">DOC_COVER</a>.
    1043. 

  1043. Do not include the copyright symbol in the argument passed to
    1044. 

  1044. <strong>COPYRIGHT</strong>; <strong>mom</strong> puts it in for
    1045. 

  1045. you.
    1046. 

  1046. <p>
    1047. 

  1047. 

  1048. <!---MISC--->
    1049. 

  1049. 

  1050. <hr width="66%" align="left">
    1051. 

  1051. <p>
    1052. 

  1052. <a name="MISC"></a>
    1053. 

  1053. <nobr>Macro: <strong>MISC</strong> &quot;&lt;argument 1&gt;&quot; [&quot;&lt;argument 2&gt;&quot; &quot;&lt;argument 3&gt;&quot; ...]</nobr>
    1054. 

  1054. <br>
    1055. 

  1055. <em>*Multliple arguments must all be enclosed in double-quotes</em>
    1056. 

  1056. 

  1057. <p>
    1058. 

  1058. The argument(s) passed to <strong>MISC</strong> are only used on
    1059. 

  1059. cover or doc cover pages, and then only if the argument MISC is
    1060. 

  1060. passed to
    1061. 

  1061. <a href="cover.html#COVER">COVER</a>
    1062. 

  1062. or
    1063. 

  1063. <a href="cover.html#DOC_COVER">DOC_COVER</a>.
    1064. 

  1064. <strong>MISC</strong> can contain any information you like.  Each
    1065. 

  1065. argument appears on a separate line at the bottom of the cover or
    1066. 

  1066. doc cover page.
    1067. 

  1067. <p>
    1068. 

  1068. For example, if you're submitting an essay where the prof has
    1069. 

  1069. requested that you include the course number, his name and the
    1070. 

  1070. date, you could do
    1071. 

  1071. <p>
    1072. 

  1072. <pre>
    1073. 

  1073. 	.MISC &quot;Music History 101&quot; &quot;Professor Hasbeen&quot; &quot;Dec. 24, 2006&quot;
    1074. 

  1074. </pre>
    1075. 

  1075. 

  1076. and the information would appear on the essay's cover page.
    1077. 

  1077. <p>
    1078. 

  1078. 

  1079. <!---COVER_TITLE--->
    1080. 

  1080. 

  1081. <hr width="66%" align="left">
    1082. 

  1082. <p>
    1083. 

  1083. <a name="COVERTITLE"></a>
    1084. 

  1084. <nobr>Macro: <strong>COVERTITLE</strong> &quot;&lt;user defined cover page title&gt;&quot;</nobr>
    1085. 

  1085. <br>
    1086. 

  1086. <nobr>Macro: <strong>DOC_COVERTITLE</strong> &quot;&lt;user defined document cover page title&gt;&quot;</nobr>
    1087. 

  1087. <br>
    1088. 

  1088. <em>*Argument must be enclosed in double-quotes</em>
    1089. 

  1089. 

  1090. <p>
    1091. 

  1091. The argument passed to <strong>COVERTITLE</strong> or
    1092. 

  1092. <strong>DOC_COVERTITLE</strong> is only used on cover or doc cover
    1093. 

  1093. pages, and then only if the argument COVERTITLE is passed to
    1094. 

  1094. <a href="cover.html#COVER">COVER</a>
    1095. 

  1095. or
    1096. 

  1096. <a href="cover.html#DOC_COVER">DOC_COVER</a>.
    1097. 

  1097. <p>
    1098. 

  1098. The only time you require a <strong>COVERTITLE</strong> or
    1099. 

  1099. <strong>DOC_COVERTITLE</strong>is when none of the required first
    1100. 

  1100. arguments to <strong>COVER</strong> or <strong>DOC_COVER</strong>
    1101. 

  1101. fits your needs for the title you want to appear on cover (or doc
    1102. 

  1102. cover) pages.
    1103. 

  1103. 

  1104. <p>
    1105. 

  1105. <hr>
    1106. 

  1106. <!========================================================================>
    1107. 

  1107. 

  1108. <a name="DOCSTYLE_MACROS">
    1109. 

  1109. 	<h2><u>The Docstyle Macros</u></h2>
    1110. 

  1110. </a>
    1111. 

  1111. 

  1112. The docstyle macros tell <strong>mom</strong> what type of document you're
    1113. 

  1113. writing, whether you want the output typeset or
    1114. 

  1114. &quot;typewritten&quot;, and whether you want a draft copy (with
    1115. 

  1115. draft and revision information in the headers) or a final copy.
    1116. 

  1116. 

  1117. <a name="INDEX_DOCSTYLE">
    1118. 

  1118. 	<h3><u>Docstyle macros list</u></h3>
    1119. 

  1119. </a>
    1120. 

  1120. 

  1121. <ul>
    1122. 

  1122. 	<li><a href="#DOCTYPE">DOCTYPE</a>
    1123. 

  1123. 	<li><a href="#PRINTSTYLE">PRINTSTYLE</a>
    1124. 

  1124. 	<ul>
    1125. 

  1125. 		<li><a href="#TYPESET_DEFAULTS">Defaults for PRINTSTYLE TYPESET</a>
    1126. 

  1126. 		<li><a href="#TYPEWRITE_DEFAULTS">Defaults for PRINTSTYLE TYPEWRITE</a>
    1127. 

  1127. 		<ul>
    1128. 

  1128. 			<li><a href="#TYPEWRITE_CONTROL">TYPEWRITE control macros</a>
    1129. 

  1129. 		</ul>
    1130. 

  1130. 	</ul>
    1131. 

  1131. 	<li><a href="#COPYSTYLE">COPYSTYLE</a>
    1132. 

  1132. </ul>
    1133. 

  1133. <br>
    1134. 

  1134. 

  1135. <!---DOCTYPE--->
    1136. 

  1136. 

  1137. <hr width="66%" align="left">
    1138. 

  1138. <p>
    1139. 

  1139. <a name="DOCTYPE"></a>
    1140. 

  1140. <nobr>Macro: <strong>DOCTYPE</strong> DEFAULT | CHAPTER | NAMED &quot;&lt;name&gt;&quot; | LETTER</nobr>
    1141. 

  1141. <p>
    1142. 

  1142. The arguments <strong>DEFAULT, CHAPTER</strong> and
    1143. 

  1143. <strong>NAMED</strong> tell <strong>mom</strong> what to put
    1144. 

  1144. in the
    1145. 

  1145. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
    1146. 

  1146. and
    1147. 

  1147. <a href="definitions.html#TERMS_HEADER">page headers</a>.
    1148. 

  1148. <strong>LETTER</strong> tells her that you want to write a
    1149. 

  1149. letter.
    1150. 

  1150. <p>
    1151. 

  1151. <strong>Mom</strong>'s default <strong>DOCTYPE</strong> is
    1152. 

  1152. <strong>DEFAULT</strong>.  If that's what you want, you don't
    1153. 

  1153. have to give a <strong>DOCTYPE</strong> command.
    1154. 

  1154. <p>
    1155. 

  1155. <strong>DEFAULT</strong> prints a
    1156. 

  1156. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
    1157. 

  1157. containing the title, subtitle and author information given to the
    1158. 

  1158. <a href="#REFERENCE_MACROS">reference macros</a>,
    1159. 

  1159. and page headers with the author and title.
    1160. 

  1160. (See
    1161. 

  1161. <a href="headfootpage.html#HEADER_STYLE">Default specs for headers</a>
    1162. 

  1162. for how <strong>mom</strong> outputs each part of the page header.)
    1163. 

  1163. <p>
    1164. 

  1164. <strong>CHAPTER</strong> prints &quot;Chapter #&quot; in place of a
    1165. 

  1165. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>
    1166. 

  1166. (# is what you gave to the
    1167. 

  1167. <a href="#REFERENCE_MACROS">reference macro</a>
    1168. 

  1168. <a href="#CHAPTER">CHAPTER</a>).
    1169. 

  1169. If you give the chapter a title with
    1170. 

  1170. <a href="#CHAPTER_TITLE">CHAPTER TITLE</a>,
    1171. 

  1171. <strong>mom</strong> prints &quot;Chapter #&quot; and the title
    1172. 

  1172. underneath.  If you omit the
    1173. 

  1173. <a href="#CHAPTER">CHAPTER</a>
    1174. 

  1174. reference macro but supply a
    1175. 

  1175. <a href="#CHAPTER_TITLE">CHAPTER_TITLE</a>,
    1176. 

  1176. <strong>mom</strong> prints only the chapter title. <em>(*For
    1177. 

  1177. backward compatibility with pre-1.1.5 versions of</em>
    1178. 

  1178. <strong>mom</strong><em>, you can also supply a chapter title by
    1179. 

  1179. omitting the</em> <strong>CHAPTER</strong> <em>reference macro and
    1180. 

  1180. supplying a chapter title with</em>
    1181. 

  1181. <a href="#CHAPTER_STRING">CHAPTER_STRING</a>.)
    1182. 

  1182. <p>
    1183. 

  1183. The page headers in <strong>DOCTYPE CHAPTER</strong> contain the author,
    1184. 

  1184. the title of the book (which you gave with
    1185. 

  1185. <a href="#TITLE">TITLE</a>),
    1186. 

  1186. and &quot;Chapter #&quot; (or the chapter title).  See
    1187. 

  1187. <a href="headfootpage.html#HEADER_STYLE">Default Specs for Headers</a>
    1188. 

  1188. for <strong>mom</strong>'s default type parameters for each part of
    1189. 

  1189. the page header.
    1190. 

  1190. <p>
    1191. 

  1191. <strong>NAMED</strong> takes an additional argument: a name
    1192. 

  1192. for this particular kind of document  (e.g. outline, synopsis,
    1193. 

  1193. abstract, memorandum), enclosed in double-quotes.
    1194. 

  1194. <strong>NAMED</strong> is identical to <strong>DEFAULT</strong>
    1195. 

  1195. except that <strong>mom</strong> prints the argument to
    1196. 

  1196. <strong>NAMED</strong> beneath the
    1197. 

  1197. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
    1198. 

  1198. as well as in page headers.
    1199. 

  1199. (See
    1200. 

  1200. <a href="headfootpage.html#HEADER_STYLE">Default specs for headers</a>
    1201. 

  1201. for how <strong>mom</strong> outputs each part of the page header.)
    1202. 

  1202. <p>
    1203. 

  1203. Additionally, if you wish the name of this particular kind of
    1204. 

  1204. document to be coloured, you can pass <strong>DOCTYPE NAMED</strong>
    1205. 

  1205. a third (optional) argument: the name of a colour pre-defined (or
    1206. 

  1206. &quot;initialized&quot;) with
    1207. 

  1207. <a href="color.html#NEWCOLOR">NEWCOLOR</a>
    1208. 

  1208. or
    1209. 

  1209. <a href="color.html#XCOLOR">XCOLOR</a>.
    1210. 

  1210. For example, if you have a doctype named &quot;Warning&quot;, and
    1211. 

  1211. you'd like &quot;Warning&quot; to be in red, assuming you've
    1212. 

  1212. pre-defined (or &quot;initialized&quot;) the color, red, this is
    1213. 

  1213. what the <strong>DOCTYPE</strong> entry would look like:
    1214. 

  1214. <p>
    1215. 

  1215. <pre>
    1216. 

  1216. 	.DOCTYPE NAME "Warning" red
    1217. 

  1217. </pre>
    1218. 

  1218. 

  1219. <p>
    1220. 

  1220. <strong>LETTER</strong> tells mom you're writing a letter.  See
    1221. 

  1221. the section
    1222. 

  1222. <a href="letters.html#INTRO">Writing Letters</a>
    1223. 

  1223. for instructions on using <strong>mom</strong> to format letters.
    1224. 

  1224. <p>
    1225. 

  1225. 

  1226. <!---PRINTSTYLE--->
    1227. 

  1227. 

  1228. <hr width="66%" align="left">
    1229. 

  1229. <p>
    1230. 

  1230. <a name="PRINTSTYLE"></a>
    1231. 

  1231. <nobr>Macro: <strong>PRINTSTYLE</strong> TYPESET | TYPEWRITE [ SINGLESPACE ]</nobr>
    1232. 

  1232. <br>
    1233. 

  1233. <em>*Required for document processing.</em>
    1234. 

  1234. <br>
    1235. 

  1235. <em>*Must come before any changes to default document style</em>
    1236. 

  1236. 

  1237. <p>
    1238. 

  1238. <strong>PRINTSTYLE</strong> tells <strong>mom</strong> whether to typeset
    1239. 

  1239. a document, or to print it out &quot;typewritten, doubled-spaced&quot;.
    1240. 

  1240. <p>
    1241. 

  1241. <strong>THIS MACRO MAY NOT BE OMITTED.</strong>  In order for
    1242. 

  1242. document processing to take place, <strong>mom</strong> requires
    1243. 

  1243. a <strong>PRINTSTYLE</strong>.  If you don't give one,
    1244. 

  1244. <strong>mom</strong> will warn you on stderr and print a single
    1245. 

  1245. page with a nasty message.
    1246. 

  1246. <p>
    1247. 

  1247. Furthermore, <strong>PRINTSTYLE</strong> must come before any
    1248. 

  1248. changes to <strong>mom</strong>'s default typestyle parameters.
    1249. 

  1249. (This applies primarily to, but is by no means restricted to,
    1250. 

  1250. <strong>PRINTSTYLE TYPESET</strong>.)  <strong>PRINTSTYLE</strong>
    1251. 

  1251. sets up complete &quot;templates&quot; that include default
    1252. 

  1252. papersize, margins, family, fonts, point sizes, and so on.
    1253. 

  1253. Therefore, changes to any aspect of document style must come
    1254. 

  1254. afterwards.
    1255. 

  1255. <p>
    1256. 

  1256. <strong>TYPESET</strong>, as the argument implies, typesets documents
    1257. 

  1257. (by default in Times Roman; see
    1258. 

  1258. <a href="#TYPESET_DEFAULTS">TYPESET defaults</a>).
    1259. 

  1259. You have full access to all the
    1260. 

  1260. <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
    1261. 

  1261. as well as the
    1262. 

  1262. <a href="definitions.html#STYLE_CONTROL">style control macros</a>
    1263. 

  1263. of document processing.
    1264. 

  1264. <p>
    1265. 

  1265. As mentioned above, <strong>PRINTSTYLE TYPESET</strong> must come
    1266. 

  1266. before any changes to <strong>mom</strong>'s default typographic
    1267. 

  1267. settings.  For example,
    1268. 

  1268. 

  1269. <pre>
    1270. 

  1270. 	.PAPER A4
    1271. 

  1271. 	.LS 14
    1272. 

  1272. 	.PRINTSTYLE TYPESET
    1273. 

  1273. </pre>
    1274. 

  1274. 

  1275. will not changes <strong>mom</strong>'s default paper size to A4,
    1276. 

  1276. nor her default document leading 14 points, whereas
    1277. 

  1277. 

  1278. <pre>
    1279. 

  1279. 	.PRINTSTYLE TYPESET
    1280. 

  1280. 	.PAPER A4
    1281. 

  1281. 	.LS 14
    1282. 

  1282. </pre>
    1283. 

  1283. 

  1284. will.
    1285. 

  1285. <p>
    1286. 

  1286. With <strong>TYPEWRITE</strong>, <strong>mom</strong> does her best
    1287. 

  1287. to reproduce the look and feel of typewritten, double-spaced copy (see
    1288. 

  1288. <a href="#TYPEWRITE_DEFAULTS">TYPEWRITE defaults</a>).
    1289. 

  1289. <a href="docelement.html#DOCELEMENT_CONTROL">Control macros</a>
    1290. 

  1290. and
    1291. 

  1291. <a href="typesetting.html#INTRO_MACROS_TYPESETTING">typesetting macros</a>
    1292. 

  1292. that alter family, font, point size, and
    1293. 

  1293. <a href="definitions.html#TERMS_LEADING">leading</a>
    1294. 

  1294. are (mostly) ignored.  An important exception is
    1295. 

  1295. <a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a>
    1296. 

  1296. (and, by extension, <strong>FOOTER_SIZE</strong>), which allows
    1297. 

  1297. you to reduce the point size of headers/footers should they become
    1298. 

  1298. too crowded.  Most of <strong>mom</strong>'s inlines affecting the
    1299. 

  1299. appearance of type are also ignored (<strong>\*S</strong> is an
    1300. 

  1300. exception; there may be a few others).
    1301. 

  1301. <p>
    1302. 

  1302. In short, <strong>TYPEWRITE</strong> never produces effects other than
    1303. 

  1303. those available on a typewriter.  Don't be fooled by how brainless
    1304. 

  1304. this sounds; <strong>mom</strong> is remarkably sophisticated when
    1305. 

  1305. it comes to conveying the typographic sense of a document within the
    1306. 

  1306. confines of <strong>TYPEWRITE</strong>.
    1307. 

  1307. <p>
    1308. 

  1308. The primary uses of <strong>TYPEWRITE</strong> are: outputting hard
    1309. 

  1309. copy drafts of your work (for editing), and producing documents
    1310. 

  1310. for submission to publishers and agents who (wisely) insist on
    1311. 

  1311. typewritten, double-spaced copy. To get a nicely typeset version of
    1312. 

  1312. work that's in the submission phase of its life (say, to show fellow
    1313. 

  1313. writers for critiquing), simply change <strong>TYPEWRITE</strong>
    1314. 

  1314. to <strong>TYPESET</strong> and print out a copy.
    1315. 

  1315. <p>
    1316. 

  1316. If, for some reason, you would prefer the output of
    1317. 

  1317. <strong>TYPEWRITE</strong> single-spaced, pass <strong>PRINTSTYLE
    1318. 

  1318. TYPEWRITE</strong> the optional argument, <strong>SINGLESPACE</strong>.
    1319. 

  1319. <p>
    1320. 

  1320. If you absolutely must have a leading other than typewriter double-
    1321. 

  1321. or singlespaced, the only way to get it is with the
    1322. 

  1322. <a href="#DOC_LEAD">DOC_LEAD</a>
    1323. 

  1323. macro, and then ONLY if <strong>DOC_LEAD</strong> is set
    1324. 

  1324. <strong>before</strong> you invoke the <strong>START</strong>
    1325. 

  1325. macro.
    1326. 

  1326. <p>
    1327. 

  1327. <a name="TYPESET_DEFAULTS"><h3><u>TYPESET defaults</u></h3></a>
    1328. 

  1328. <pre>
    1329. 

  1329. 	Family            = Times Roman
    1330. 

  1330. 	Point size        = 12.5
    1331. 

  1331. 	Paragraph leading = 16 points, adjusted
    1332. 

  1332. 	Fill mode         = justified
    1333. 

  1333. 	Hyphenation       = enabled
    1334. 

  1334. 	                    max. lines = 2
    1335. 

  1335. 	                    margin = 36 points
    1336. 

  1336. 	                    interword adjustment = 1 point
    1337. 

  1337. 	Kerning           = enabled
    1338. 

  1338. 	Ligatures         = enabled
    1339. 

  1339. 	Smartquotes       = enabled
    1340. 

  1340. 	Word space        = groff default
    1341. 

  1341. 	Sentence space    = 0
    1342. 

  1342. </pre>
    1343. 

  1343. 

  1344. <a name="TYPEWRITE_DEFAULTS"><h3><u>TYPEWRITE defaults</u></h3></a>
    1345. 

  1345. <pre>
    1346. 

  1346. 	Family            = Courier
    1347. 

  1347. 	Italics           = underlined
    1348. 

  1348. 	Point size        = 12
    1349. 

  1349. 	Paragraph leading = 24 points, adjusted; 12 points for SINGLESPACE
    1350. 

  1350. 	Fill mode         = left
    1351. 

  1351. 	Hyphenation       = disabled
    1352. 

  1352. 	Kerning           = disabled
    1353. 

  1353. 	Ligatures         = disabled
    1354. 

  1354. 	Smartquotes       = disabled
    1355. 

  1355. 	Word space        = groff default
    1356. 

  1356. 	Sentence space    = groff default
    1357. 

  1357. 	Columns           = ignored
    1358. 

  1358. </pre>
    1359. 

  1359. 

  1360. <a name="TYPEWRITE_CONTROL"><h3><u>PRINTSTYLE TYPEWRITE control macros</u></h3></a>
    1361. 

  1361. <p>
    1362. 

  1362. In <strong>PRINTSTYLE TYPEWRITE</strong>, <strong>mom</strong>,
    1363. 

  1363. by default, underlines anything that looks like italics.  This
    1364. 

  1364. includes the
    1365. 

  1365. <a href="typesetting.html#SLANT_INLINE">\*[SLANT]</a>
    1366. 

  1366. <a href="definitions.html#TERMS_INLINES">inline escape</a>
    1367. 

  1367. for pseudo-italics.
    1368. 

  1368. <p>
    1369. 

  1369. If you'd prefer that <strong>mom</strong> were
    1370. 

  1370. less bloody-minded about pretending to be a typewriter (i.e.
    1371. 

  1371. you'd like italics and pseudo-italics to come out as italics),
    1372. 

  1372. use the control macros <strong>.ITALIC_MEANS_ITALIC</strong> and
    1373. 

  1373. <strong>.SLANT_MEANS_SLANT</strong>.  Neither requires an
    1374. 

  1374. argument.
    1375. 

  1375. <p>
    1376. 

  1376. Although it's unlikely, should you wish to reverse the sense of
    1377. 

  1377. these macros in the midst of a document,
    1378. 

  1378. <strong>.UNDERLINE_ITALIC</strong> and
    1379. 

  1379. <strong>.UNDERLINE_SLANT</strong> restore underlining of
    1380. 

  1380. italics and pseudo-italics.
    1381. 

  1381. <p>
    1382. 

  1382. <a name="UNDERLINE_QUOTES"></a>
    1383. 

  1383. Additionally, by default, <strong>mom</strong> underlines
    1384. 

  1384. <a href="definitions.html#TERMS_QUOTES">quotes</a>
    1385. 

  1385. (but not
    1386. 

  1386. <a href="definitions.html#TERMS_BLOCKQUOTES">blockquotes</a>)
    1387. 

  1387. in <strong>PRINTSTYLE TYPEWRITE</strong>.
    1388. 

  1388. If you don't like this behaviour, turn it off with
    1389. 

  1389. <p>
    1390. 

  1390. <pre>
    1391. 

  1391. 	.UNDERLINE_QUOTES OFF
    1392. 

  1392. </pre>
    1393. 

  1393. 

  1394. To turn underlining of quotes back on, use
    1395. 

  1395. <strong>UNDERLINE_QUOTES</strong> without an argument.
    1396. 

  1396. <p>
    1397. 

  1397. While most of the
    1398. 

  1398. <a href="docelement.html#DOCELEMENT_CONTROL">control macros</a>
    1399. 

  1399. have no effect on <strong>PRINTSTYLE TYPEWRITE</strong>, there
    1400. 

  1400. is an important exception:
    1401. 

  1401. <a href="headfootpage.html#HDRFTR_GLOBAL_SIZE">HEADER_SIZE</a>
    1402. 

  1402. (and by extension, <strong>FOOTER_SIZE</strong>).  This is
    1403. 

  1403. particularly useful for reducing the point size of
    1404. 

  1404. headers/footers should they become crowded (quite likely to
    1405. 

  1405. happen if the title of your document is long and your
    1406. 

  1406. <a href="#COPYSTYLE">COPYSTYLE</a>
    1407. 

  1407. is <strong>DRAFT</strong>).
    1408. 

  1408. <p>
    1409. 

  1409. 

  1410. <!---COPYSTYLE--->
    1411. 

  1411. 

  1412. <hr width="66%" align="left">
    1413. 

  1413. <p>
    1414. 

  1414. <a name="COPYSTYLE"></a>
    1415. 

  1415. <nobr>Macro: <strong>COPYSTYLE</strong> D…
    1416.