PageRenderTime 53ms CodeModel.GetById 26ms RepoModel.GetById 0ms app.codeStats 1ms

/contrib/groff/contrib/mom/momdoc/docelement.html

https://bitbucket.org/freebsd/freebsd-head/
HTML | 5041 lines | 4616 code | 379 blank | 46 comment | 0 complexity | 94cb9ffdba54505b8afea218276b3f23 MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, BSD-3-Clause, LGPL-2.0, LGPL-2.1, BSD-2-Clause, 0BSD, JSON, AGPL-1.0, GPL-2.0 
    

  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, element tags</title>
    6. 

  6. </head>
    7. 

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

  8. 

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

  10. 

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

  12. <a href="docprocessing.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="DOCELEMENT">
    17. 

  17. 	<h1 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h1>
    18. 

  18. </a>
    19. 

  19. 

  20. <ul>
    21. 

  21. 	<li><a href="#DOCELEMENT_INTRO">Introduction to the document element tags</a>
    22. 

  22. 	<ul>
    23. 

  23. 		<li><a href="#DOCELEMENT_CONTROL">Control macros -- changing defaults for document element tags</a>
    24. 

  24. 		<li><a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
    25. 

  25. 	</ul>
    26. 

  26. 	<li><a href="#INDEX_DOCELEMENT">Index of document element tags</a>
    27. 

  27. </ul>
    28. 

  28. 

  29. <a name="DOCELEMENT_INTRO">
    30. 

  30. 	<h2><u>Introduction to the document element tags</u></h2>
    31. 

  31. </a>
    32. 

  32. 

  33. Once you've completed the setup for a document (see
    34. 

  34. <a href="docprocessing.html#DOCPROCESSING_TUT">Setting up a mom document</a>),
    35. 

  35. formatting it is a snap.  Simply invoke the appropriate tag for
    36. 

  36. each document element as you need it.  The tags are macros that
    37. 

  37. tell <strong>mom</strong>, &quot;This is a paragraph, this
    38. 

  38. is a subhead, this is a footnote,&quot; and so on.
    39. 

  39. <p>
    40. 

  40. The list of tags is actually quite small -- ideal for the users
    41. 

  41. <strong>mom</strong> brought herself into being for (see
    42. 

  42. <a href="intro.html#INTRO_INTRO">Who mom is meant for</a>).
    43. 

  43. However, the list of macros that control the appearance of the
    44. 

  44. tags upon output is extensive.  Generally, for each tag,
    45. 

  45. there are
    46. 

  46. <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>
    47. 

  47. for the tag's family, font and point size.  Where appropriate, there
    48. 

  48. are macros to control leading, indents, quad and special features
    49. 

  49. as well.
    50. 

  50. <p>
    51. 

  51. <strong>Mom</strong> has tasteful defaults for all the tags, hence you
    52. 

  52. only use the control macros when you want to change the way
    53. 

  53. she does things.  This is usually done prior to
    54. 

  54. <a href="docprocessing.html#START">START</a>,
    55. 

  55. but can, in fact, be done at any time in the course of a document.
    56. 

  56. Any change to a tag's style affects all subsequent invocations of
    57. 

  57. the tag.
    58. 

  58. <p>
    59. 

  59. 

  60. <a name="DOCELEMENT_CONTROL"><h3><u>Control macros -- changing defaults</u></h3></a>
    61. 

  61. 

  62. <p>
    63. 

  63. The control macros for document processing tags let you
    64. 

  64. &quot;design&quot; the look of all the parts of your documents --
    65. 

  65. should you wish.  At a bare minimum, all tags have macros to change
    66. 

  66. <strong>mom</strong>'s defaults for family, font, point size and
    67. 

  67. colour.  Where appropriate, there are macros to control leading,
    68. 

  68. indents and quad as well.
    69. 

  69. <p>
    70. 

  70. In addition, many tags have special macros to control features that
    71. 

  71. are pertinent to those tags alone.  Have a look at the section dealing
    72. 

  72. with any particular tag to find out what macros control the tag,
    73. 

  73. and what <strong>mom</strong>'s defaults for the tag are.
    74. 

  74. <p>
    75. 

  75. The control macros may be used at any time during the course of
    76. 

  76. a document (i.e. before or after
    77. 

  77. <a href="docprocessing.html#START">START</a>).  The changes you
    78. 

  78. make alter all subsequent invocations of the affected tag until
    79. 

  79. you make another change, either by passing new arguments to the
    80. 

  80. tag's control macro, or toggling a particular feature of the tag on
    81. 

  81. or off.
    82. 

  82. <p>
    83. 

  83. And don't forget: the
    84. 

  84. <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
    85. 

  85. can be used at any time, including inside
    86. 

  86. <a href="definitions.html#TERMS_TOGGLE">toggle</a>
    87. 

  87. tags (affecting only that particular invocation of the tag).
    88. 

  88. Equally,
    89. 

  89. <a href="definitions.html#TERMS_INLINES">inline escapes</a>
    90. 

  90. can be used in tags that take
    91. 

  91. <a href="definitions.html#TERMS_STRINGARGUMENT">string arguments.</a>
    92. 

  92. <p>
    93. 

  93. <strong>IMPORTANT NOTE:</strong> The family, font, point size,
    94. 

  94. colour and leading control macros have no effect in
    95. 

  95. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    96. 

  96. which sets EVERYTHING in Courier roman, 12/24 (i.e. 12-point type on
    97. 

  97. a linespace of 24 points).
    98. 

  98. <p>
    99. 

  99. Please also note that the defaults listed
    100. 

  100. with the control macros apply only to
    101. 

  101. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
    102. 

  102. unless a default for <strong>TYPEWRITE</strong> is also given.
    103. 

  103. <p>
    104. 

  104. <strong>A WORD OF ADVICE:</strong> Get familiar with
    105. 

  105. <strong>mom</strong> at her default settings before exploring the
    106. 

  106. control macros.  Put her through her paces.  See how she behaves.
    107. 

  107. Get to know what she feels like and how she looks, both in your text
    108. 

  108. editor and on the printed page.  Then, if you don't like something,
    109. 

  109. use this documentation to find the precise macro you need to change it.
    110. 

  110. There are tons of control macros.  Reading up on them and trying to
    111. 

  111. remember them all might lead you to think that <strong>mom</strong>
    112. 

  112. is complex and unwieldy, which is not only untrue, but would offend
    113. 

  113. her mightily.
    114. 

  114. <p>
    115. 

  115. 

  116. <a name="CONTROL_MACRO_ARGS"><h3><u>Arguments to the control macros</u></h3></a>
    117. 

  117. 

  118. <h3>Family and font</h3>
    119. 

  119. The arguments to the control macros that end in
    120. 

  120. <strong>_FAMILY</strong> or <strong>_FONT</strong> are the same
    121. 

  121. as for
    122. 

  122. <a href="typesetting.html#FAMILY">FAMILY</a>
    123. 

  123. and
    124. 

  124. <a href="typesetting.html#FONT">FT</a>.
    125. 

  125. 

  126. <h3>Point size</h3>
    127. 

  127. Control macros that end in <strong>_SIZE</strong> always take
    128. 

  128. the form <kbd>+digit</kbd> or <kbd>-digit</kbd> where digit is
    129. 

  129. the number of
    130. 

  130. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
    131. 

  131. larger (+) or smaller (-) than the point size of paragraphs
    132. 

  132. you want the document element to be.  For example, to change
    133. 

  133. subheads to 1-1/2 points larger than the type in paragraphs, do
    134. 

  134. <p>
    135. 

  135. <pre>
    136. 

  136. 	.SUBHEAD_SIZE +1.5
    137. 

  137. </pre>
    138. 

  138. 

  139. There's no need for a
    140. 

  140. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    141. 

  141. with the <strong>_SIZE</strong> control macros; points is assumed.
    142. 

  142. 

  143. <h3>Colour</h3>
    144. 

  144. Control macros that end in <strong>_COLOR</strong> take as their
    145. 

  145. argument a colour name pre-defined (or &quot;initialized&quot;)
    146. 

  146. with
    147. 

  147. <a href="color.html#NEWCOLOR">NEWCOLOR</a>
    148. 

  148. or
    149. 

  149. <a href="color.html#XCOLOR">XCOLOR</a>.
    150. 

  150. For example, if you want your heads to be red, once you've defined
    151. 

  151. or initialized the color, red,
    152. 

  152. <p>
    153. 

  153. <pre>
    154. 

  154. 	.HEAD_COLOR red
    155. 

  155. </pre>
    156. 

  156. 

  157. will turn your heads red.
    158. 

  158. 

  159. <h3>Lead/linespacing</h3>
    160. 

  160. Control macros that end in <strong>_AUTOLEAD</strong> take the
    161. 

  161. same argument as
    162. 

  162. <a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>,
    163. 

  163. viz. a digit that represents the number of points to add to the
    164. 

  164. tag's point size to arrive at its
    165. 

  165. <a href="definitions.html#TERMS_LEADING">lead</a>.
    166. 

  166. For example, to set footnotes
    167. 

  167. <a href="definitions.html#TERMS_SOLID">solid</a>, do
    168. 

  168. <p>
    169. 

  169. <pre>
    170. 

  170. 	.FOOTNOTE_AUTOLEAD 0
    171. 

  171. </pre>
    172. 

  172. 

  173. To set footnotes with a 1-point lead (i.e. with the line spacing
    174. 

  174. one point greater than the footnote's point size), do
    175. 

  175. <p>
    176. 

  176. <pre>
    177. 

  177. 	.FOOTNOTE_AUTOLEAD 1
    178. 

  178. </pre>
    179. 

  179. 

  180. <h3><a name="CONTROL_INDENTS">Indents</a></h3>
    181. 

  181. Except for <strong>PARA_INDENT</strong>, the argument to the control
    182. 

  182. macros that end
    183. 

  183. in <strong>_INDENT</strong> is always a single digit (whole numbers
    184. 

  184. only; no decimal fractions) with no
    185. 

  185. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    186. 

  186. appended to it.  The digit represents by how much you want the
    187. 

  187. size of the paragraph first-line indent multiplied to achieve the
    188. 

  188. correct indent for a particular tag.
    189. 

  189. 

  190. <h3>Quad/justification style</h3>
    191. 

  191. Control macros that end in <strong>_QUAD</strong> take the same
    192. 

  192. arguments as
    193. 

  193. <a href="typesetting.html#QUAD">QUAD</a>.
    194. 

  194. <p>
    195. 

  195. <hr>
    196. 

  196. 

  197. <a name="INDEX_DOCELEMENT"><h3><u>Document element tags list</u></h3></a>
    198. 

  198. <ul>
    199. 

  199. 	<li><a href="#EPIGRAPH_INTRO">Epigraphs</a>
    200. 

  200. 	<ul>
    201. 

  201. 		<li><a href="#EPIGRAPH">EPIGRAPH</a>
    202. 

  202. 		<li><a href="#EPIGRAPH_CONTROL">Epigrah control</a>
    203. 

  203. 	</ul>
    204. 

  204. 	<li><a href="#PP_INTRO">Paragraphs</a>
    205. 

  205. 	<ul>
    206. 

  206. 		<li><a href="#PP">PP</a>
    207. 

  207. 		<li><a href="#PP_CONTROL">Paragraph control</a>
    208. 

  208. 	</ul>
    209. 

  209. 	<li><a href="#HEAD_INTRO">Main heads</a>
    210. 

  210. 	<ul>
    211. 

  211. 		<li><a href="#HEAD">HEAD</a>
    212. 

  212. 		<li><a href="#HEAD_CONTROL">Head control</a>
    213. 

  213. 	</ul>
    214. 

  214. 	<li><a href="#SUBHEAD_INTRO">Subheads</a>
    215. 

  215. 	<ul>
    216. 

  216. 		<li><a href="#SUBHEAD">SUBHEAD</a>
    217. 

  217. 		<li><a href="#SUBHEAD_CONTROL">Subhead control</a>
    218. 

  218. 	</ul>
    219. 

  219. 	<li><a href="#PARAHEAD_INTRO">Paragraph heads</a>
    220. 

  220. 	<ul>
    221. 

  221. 		<li><a href="#PARAHEAD">PARAHEAD</a>
    222. 

  222. 		<li><a href="#PARAHEAD_CONTROL">Parahead control</a>
    223. 

  223. 	</ul>
    224. 

  224. 	<li><a href="#LINEBREAK_INTRO">Linebreaks (author linebreaks, section breaks)</a>
    225. 

  225. 	<ul>
    226. 

  226. 		<li><a href="#LINEBREAK">LINEBREAK</a>
    227. 

  227. 		<li><a href="#LINEBREAK_CHAR">Linebreak character</a>
    228. 

  228. 		<li><a href="#LINEBREAK_COLOR">Linebreak colour</a>
    229. 

  229. 	</ul>
    230. 

  230. 	<li><a href="#QUOTE_INTRO">Quotes (line for line)</a>
    231. 

  231. 	<ul>
    232. 

  232. 		<li><a href="#QUOTE">QUOTE</a>
    233. 

  233. 		<li><a href="#QUOTE_CONTROL">Quote control</a>
    234. 

  234. 	</ul>
    235. 

  235. 	<li><a href="#BLOCKQUOTE_INTRO">Blockquotes (cited material)</a>
    236. 

  236. 	<ul>
    237. 

  237. 		<li><a href="#BLOCKQUOTE">BLOCKQUOTE</a>
    238. 

  238. 		<li><a href="#BLOCKQUOTE_CONTROL">Blockquote control</a>
    239. 

  239. 	</ul>
    240. 

  240. 	<li><a href="#LIST_INTRO">Nested lists</a>
    241. 

  241. 	<ul>
    242. 

  242. 		<li><a href="#LIST">LIST</a>
    243. 

  243. 		<ul>
    244. 

  244. 			<li><a href="#ITEM">ITEM</a>
    245. 

  245. 		</ul>
    246. 

  246. 		<li><a href="#LIST_CONTROL">List control</a>
    247. 

  247. 	</ul>
    248. 

  248. 	<li><a href="#NUMBER_LINES_INTRO">Line numbering</a>
    249. 

  249. 	<ul>
    250. 

  250. 		<li><a href="#NUMBER_LINES">NUMBER_LINES</a>
    251. 

  251. 		<li><a href="#NUMBER_LINES_CONTROL">Control macros</a> (for QUOTE and BLOCKQUOTE)
    252. 

  252. 	</ul>
    253. 

  253. 	<li><a href="#FOOTNOTE_INTRO">Footnotes</a>
    254. 

  254. 	<ul>
    255. 

  255. 		<li><a href="#FOOTNOTE">FOOTNOTE</a>
    256. 

  256. 		<li><a href="#FOOTNOTE_CONTROL">Footnote control</a>
    257. 

  257. 	</ul>
    258. 

  258. 	<li><a href="#ENDNOTE_INTRO">Endnotes</a>
    259. 

  259. 	<ul>
    260. 

  260. 		<li><a href="#ENDNOTE">ENDNOTE</a>
    261. 

  261. 		<li><a href="#ENDNOTE_CONTROL">Endnote control</a>
    262. 

  262. 	</ul>
    263. 

  263. 	<li><a href="#MARGIN_NOTES_INTRO">Margin notes</a>
    264. 

  264. 	<ul>
    265. 

  265. 		<li><a href="#MN_INIT">MN_INIT</a> -- initialize margin notes
    266. 

  266. 		<li><a href="#MN">MN</a> -- start and end a margin note
    267. 

  267. 	</ul>
    268. 

  268.     <li><a href="refer.html#TOP">Bibliographies and references</a>
    269. 

  269.     <ul>
    270. 

  270.         <li><a href="refer.html#REF">REF</a>
    271. 

  271.         <li><a href="refer.html#ENDNOTE_REFS">ENDNOTE_REFS</a>
    272. 

  272.         <li><a href="refer.html#FOOTNOTE_REFS">FOOTNOTE_REFS</a>
    273. 

  273.         <li><a href="refer.html#BRACKET_REFS">Embedded references</a>
    274. 

  274.         <li><a href="refer.html#BIBLIOGRAPHY">BIBLIOGRAPHY</a>
    275. 

  275.         <li><a href="refer.html#BIBLIOGRAPHY_TYPE">BIBLIOGRAPHY_TYPE</a>
    276. 

  276.     </ul>
    277. 

  277. 	<li><a href="#BLANK_PAGE_TITLE">Blank pages</a>
    278. 

  278. 	<li><a href="#TOC_INTRO">Table of contents</a>
    279. 

  279. 	<ul>
    280. 

  280. 		<li><a href="#TOC">TOC</a>
    281. 

  281. 		<li><a href="#TOC_CONTROL">Table of contents control</a>
    282. 

  282. 	</ul>
    283. 

  283. 	<li><a href="#FINIS_INTRO">Document termination</a>
    284. 

  284. 	<ul>
    285. 

  285. 		<li><a href="#FINIS">FINIS (Document termination)</a>
    286. 

  286. 	</ul>
    287. 

  287. 	<ul>
    288. 

  288. 		<li><a href="#FINIS_STRING">Changing the FINIS string</a>
    289. 

  289. 		<li><a href="#FINIS_COLOR">Changing the FINIS colour</a>
    290. 

  290. 	</ul>
    291. 

  291. </ul>
    292. 

  292. <hr>
    293. 

  293. 

  294. 

  295. <!====================================================================>
    296. 

  296. 

  297. <a name="EPIGRAPH_INTRO"><h2><u>Epigraphs</u></h2></a>
    298. 

  298. <ul>
    299. 

  299. 	<li><a href="#EPIGRAPH">Tag: EPIGRAPH</a>
    300. 

  300. 	<li><a href="#EPIGRAPH_CONTROL">Epigraph control macros</a>
    301. 

  301. </ul>
    302. 

  302. <p>
    303. 

  303. <a href="definitions.html#TERMS_EPIGRAPH">Epigraphs</a>
    304. 

  304. colour, flavour, or comment on the document they precede.  Typically,
    305. 

  305. they are centred at the top of a document's first page (underneath the
    306. 

  306. title) and set in a smaller point size than that of paragraph text.
    307. 

  307. <p>
    308. 

  308. By default, <strong>mom</strong> sets epigraphs centred and
    309. 

  309. <a href="definitions.html#TERMS_NOFILL">unfilled</a>;
    310. 

  310. this lets you input them on a line for line basis.  This behaviour
    311. 

  311. can be changed to accomodate
    312. 

  312. <a href="definitions.html#TERMS_FILLED">filled</a>
    313. 

  313. epigraph &quot;blocks.&quot;
    314. 

  314. <p>
    315. 

  315. 

  316. <!---EPIGRAPH--->
    317. 

  317. 

  318. <hr width="66%" align="left">
    319. 

  319. <p>
    320. 

  320. <a name="EPIGRAPH">
    321. 

  321. 	<nobr>Macro: <strong>EPIGRAPH</strong> &lt;toggle&gt; | [ BLOCK ]</a></nobr>
    322. 

  322. </a>
    323. 

  323. 

  324. <p>
    325. 

  325. <strong>EPIGRAPH</strong> is a toggle, used like this:
    326. 

  326. <p>
    327. 

  327. <pre>
    328. 

  328. 	.EPIGRAPH
    329. 

  329. 	&lt;text of epigraph&gt;
    330. 

  330. 	.EPIGRAPH OFF
    331. 

  331. </pre>
    332. 

  332. 

  333. <strong>OFF</strong>, above, could be anything -- say, Q or X --
    334. 

  334. since any argument other than <strong>BLOCK</strong> turns it off.
    335. 

  335. <p>
    336. 

  336. If given the argument <strong>BLOCK</strong>, <strong>EPIGRAPH</strong>
    337. 

  337. sets epigraphs
    338. 

  338. <a href="definitions.html#TERMS_FILLED">filled</a>,
    339. 

  339. justified or quadded in the same direction as paragraphs, indented
    340. 

  340. equally from both the left and right margins.
    341. 

  341. <p>
    342. 

  342. If a block-style epigraph runs to more than one paragraph (unlikely,
    343. 

  343. but conceivable), you <strong>MUST</strong> introduce every paragraph
    344. 

  344. -- <u>INCLUDING THE FIRST!!!</u> -- with the
    345. 

  345. <a href="#PP">PP</a>
    346. 

  346. tag.
    347. 

  347. <p>
    348. 

  348. <strong>NOTE:</strong> <strong>EPIGRAPH</strong> should only be
    349. 

  349. used at the top of a document (i.e. just after
    350. 

  350. <a href="docprocessing.html#START">START</a>)
    351. 

  351. or after
    352. 

  352. <a href="#HEAD_INTRO">heads</a>.  The latter is not especially
    353. 

  353. recommended, but it does work.  In all other places where you
    354. 

  354. want quotes or cited text, use
    355. 

  355. <a href="#QUOTE">QUOTE</a>
    356. 

  356. or
    357. 

  357. <a href="#BLOCKQUOTE">BLOCKQUOTE</a>.
    358. 

  358. <p>
    359. 

  359. 

  360. <a name="EPIGRAPH_CONTROL"><h3><u>Epigraph control macros</u></h3></a>
    361. 

  361. <p>
    362. 

  362. See
    363. 

  363. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    364. 

  364. <p>
    365. 

  365. <pre>
    366. 

  366. .EPIGRAPH_FAMILY    default = prevailing document family; default is Times Roman
    367. 

  367. .EPIGRAPH_FONT      default = roman
    368. 

  368. .EPIGRAPH_SIZE      default = -1.5 (points)
    369. 

  369. .EPIGRAPH_COLOR     default = black
    370. 

  370. .EPIGRAPH_AUTOLEAD  default = 2 points
    371. 

  371. 

  372. (The next two apply to &quot;block&quot; style epigraphs only)
    373. 

  373. 

  374. .EPIGRAPH_QUAD      default = same as paragraphs
    375. 

  375. .EPIGRAPH_INDENT*   default = para indent x 3 (for typeset), x 2 (for typewrite)
    376. 

  376. 

  377. *Indent here refers to the indent from both the left and right margins
    378. 

  378.  that centres the block style epigraph on the page.
    379. 

  379. </pre>
    380. 

  380. <hr>
    381. 

  381. 

  382. <!====================================================================>
    383. 

  383. 

  384. <a name="PP_INTRO"><h2><u>Paragraphs</u></h2></a>
    385. 

  385. <ul>
    386. 

  386. 	<li><a href="#PP">Tag: PP</a>
    387. 

  387. 	<li><a href="#PP_CONTROL">Paragraph control macros</a>
    388. 

  388. </ul>
    389. 

  389. <p>
    390. 

  390. The paragraph macro is the one you use most often.  Consequently,
    391. 

  391. it's one of most powerful, yet simplest to use -- just the letters
    392. 

  392. <strong>PP</strong>.  No arguments, nothing.  Just <kbd>.PP</kbd>
    393. 

  393. on a line by itself any time, in any document element, tells
    394. 

  394. <strong>mom</strong> you want to start a new paragraph.  The spacing
    395. 

  395. and indent appropriate to where you are in your document are taken
    396. 

  396. care of automatically.
    397. 

  397. <p>
    398. 

  398. By default, <strong>mom</strong> does not indent the first paragraph
    399. 

  399. of a document, nor paragraphs that fall immediately after
    400. 

  400. <a href="#HEAD_INTRO">heads</a>
    401. 

  401. or
    402. 

  402. <a href="#SUBHEAD_INTRO">subheads</a>.
    403. 

  403. The first paragraphs of blockquotes and block-style epigraphs are
    404. 

  404. also not indented.  This behaviour can be changed with the control
    405. 

  405. macro
    406. 

  406. <a href="#PARA_INDENT_FIRST">INDENT_FIRST_PARAS</a>.
    407. 

  407. <p>
    408. 

  408. In contrast to some other macro packages, <strong>mom</strong> does not
    409. 

  409. deposit a blank line between paragraphs.  If you want her to do so, use
    410. 

  410. the control macro <strong>PARA_SPACE</strong>.  (I don't recommend
    411. 

  411. using this macro with
    412. 

  412. <a href="typesetting.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.)
    413. 

  413. <p>
    414. 

  414. Note that <strong>mom</strong> does not provide &quot;orphan
    415. 

  415. control&quot; for paragraphs (i.e. even if only one line of a paragraph
    416. 

  416. fits at the bottom of a page, she will set it on that page).  The
    417. 

  417. reason for this is that writers of fiction often have single-line
    418. 

  418. paragraphs (e.g. in dialogue).  Groff's simplistic orphan control
    419. 

  419. will break these one-liners -- if they fall at the bottom of the page
    420. 

  420. -- to a new page, which is not what you want.
    421. 

  421. <p>
    422. 

  422. <strong>TIP:</strong> The last thing you want while you're writing
    423. 

  423. and editing drafts of a document (particularly stories and chapters)
    424. 

  424. is a text file cluttered up with <strong>PP</strong>'s.  The visual
    425. 

  425. interruption in the flow of text is a serious obstacle to creativity
    426. 

  426. and critiquing.
    427. 

  427. <p>
    428. 

  428. I use the tab key on my keyboard to indent paragraphs when I'm writing,
    429. 

  429. producing a text file that looks pretty much like what you see on
    430. 

  430. a printed page.  When it comes time to format and print the file,
    431. 

  431. I run it through a sed script that (amongst other things) converts
    432. 

  432. the character generated by the tab key (<kbd>^I</kbd>) into <code>.PP</code>
    433. 

  433. (plus a new line), and pipe the output to groff for processing and
    434. 

  434. printing.
    435. 

  435. <p>
    436. 

  436. Another solution is to insert a blank line between paragraphs.
    437. 

  437. The blank lines can then be sedded out at print time as above, or,
    438. 

  438. more conveniently, you can use the <code>.blm</code>
    439. 

  439. <a href="definitions.html#TERMS_PRIMITIVES">primitive</a>
    440. 

  440. (blank line macro) to instruct groff (and <strong>mom</strong>)
    441. 

  441. that blank lines should be interpreted as <strong>PP</strong>'s.
    442. 

  442. <p>
    443. 

  443. <pre>
    444. 

  444. 	.blm PP
    445. 

  445. </pre>
    446. 

  446. tells groff that all blank lines are really the macro <strong>PP</strong>.
    447. 

  447. <p>
    448. 

  448. 

  449. <!---PP--->
    450. 

  450. 

  451. <hr width="66%" align="left">
    452. 

  452. <p>
    453. 

  453. <a name="PP">
    454. 

  454. 	Macro: <strong>PP</strong>
    455. 

  455. </a>
    456. 

  456. 

  457. <p>
    458. 

  458. <strong>PP</strong> (on a line by itself, of course) tells mom to
    459. 

  459. start a new paragraph.  See
    460. 

  460. <a href="#PP_INTRO">above</a>
    461. 

  461. for more details.  In addition to regular text paragraphs, you can
    462. 

  462. use <strong>PP</strong> in
    463. 

  463. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
    464. 

  464. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
    465. 

  465. and
    466. 

  466. <a href="#FOOTNOTE_INTRO">footnotes</a>.
    467. 

  467. 

  468. <a name="PP_CONTROL"><h3><u>Paragraph control macros</u></h3></a>
    469. 

  469. <p>
    470. 

  470. The <strong>PP</strong> being so important, and representing, as
    471. 

  471. it were, the basis of everything that goes on in a document, its
    472. 

  472. control is managed in a manner somewhat different from other document
    473. 

  473. element tags.
    474. 

  474. <p>
    475. 

  475. <ol>
    476. 

  476. 	<li><a href="#PP_FAMILY">Family control</a>
    477. 

  477. 	<li><a href="#PP_FONT">Font control</a>
    478. 

  478. 	<li><a href="#PP_COLOR">Paragraph colour</a>
    479. 

  479. 	<li><a href="#PP_LEADING">Leading/linespacing control</a>
    480. 

  480. 	<li><a href="#PP_JUST_QUAD">Justification/quad control</a>
    481. 

  481. 	<li><a href="#PARA_INDENT">First-line indent control</a>
    482. 

  482. 	<li><a href="#PARA_INDENT_FIRST">Initial paragraphs indent control</a>
    483. 

  483. 	<li><a href="#PP_SPACE">Paragraph spacing control</a>
    484. 

  484. </ol>
    485. 

  485. 

  486. <a name="PP_FAMILY"><h3><u>1. Family</u></h3></a>
    487. 

  487. <p>
    488. 

  488. The paragraph
    489. 

  489. <a href="definitions.html#TERMS_FAMILY">family</a>
    490. 

  490. is set with
    491. 

  491. <a href="typesetting.html#FAMILY">FAMILY</a>
    492. 

  492. prior to
    493. 

  493. <a href="docprocessing.html#START">START</a>,
    494. 

  494. or
    495. 

  495. <a href="docprocessing.html#DOC_FAMILY">DOC_FAMILY</a>
    496. 

  496. afterwards.  Please note that both globally affect the family of
    497. 

  497. every element in the document.
    498. 

  498. <p>
    499. 

  499. If you wish to change the family for regular
    500. 

  500. text paragraphs only, invoke <strong>FAMILY</strong> immediately
    501. 

  501. after <strong>PP</strong> in EVERY paragraph whose family you wish
    502. 

  502. to differ from the prevailing document family.
    503. 

  503. <p>
    504. 

  504. <strong>Mom</strong>'s default paragraph (and document) family
    505. 

  505. is Times Roman.
    506. 

  506. <p>
    507. 

  507. 

  508. <a name="PP_FONT"><h3><u>2. Font -- PP_FONT</u></h3></a>
    509. 

  509. <p>
    510. 

  510. To change the
    511. 

  511. <a href="definitions.html#TERMS_FONT">font</a>
    512. 

  512. used in regular text paragraphs, use <code>.PP_FONT</code>,
    513. 

  513. which takes the same argument as
    514. 

  514. <a href="typesetting.html#FONT">FT</a>.
    515. 

  515. <strong>PP_FONT</strong> may be used before or after
    516. 

  516. <a href="docprocessing.html#START">START</a>.
    517. 

  517. Only regular text paragraphs are affected; paragraphs in
    518. 

  518. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
    519. 

  519. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
    520. 

  520. and
    521. 

  521. <a href="#FOOTNOTE_INTRO">footnotes</a>
    522. 

  522. remain at their default setting (medium roman) unless you change them
    523. 

  523. with the appropriate control macros.
    524. 

  524. <p>
    525. 

  525. <strong>Mom</strong>'s default paragraph font is medium roman.
    526. 

  526. <p>
    527. 

  527. 

  528. <a name="PP_COLOR"><h3><u>3. Paragraph colour</u></h3></a>
    529. 

  529. <p>
    530. 

  530. <strong>Mom</strong> has no special control macro for colourizing
    531. 

  531. paragraphs.  If you wish a colourized paragraph, you must use the
    532. 

  532. macro,
    533. 

  533. <a href="color.html#COLOR">COLOR</a>,
    534. 

  534. or the
    535. 

  535. <a href="definitions.html#TERMS_INLINE">inline escape</a>,
    536. 

  536. <a href="color.html#COLOR_INLINE">\*[&lt;colorname&gt;]</a>,
    537. 

  537. <em>after</em> <strong>.PP</strong>.  The colour must be one
    538. 

  538. pre-defined (or &quot;initialized&quot;) with
    539. 

  539. <a href="color.html#NEWCOLOR">NEWCOLOR</a>
    540. 

  540. or
    541. 

  541. <a href="color.html#XCOLOR">XCOLOR</a>.
    542. 

  542. <p>
    543. 

  543. Please note that unless you change the colour back to it's default
    544. 

  544. (usually black) at the end of the paragraph, all subsequent
    545. 

  545. paragraphs will be set in the new colour, although most other
    546. 

  546. elements of your document will continue to be set in the default
    547. 

  547. colour (usually black).
    548. 

  548. <p>
    549. 

  549. For example, assuming you have defined the colour, blue,
    550. 

  550. <p>
    551. 

  551. <pre>
    552. 

  552. 	.PP
    553. 

  553. 	.COLOR blue
    554. 

  554. 	&lt;first paragraph&gt;
    555. 

  555. 	.HEAD "Monty Python"
    556. 

  556. 	.SUBHEAD "The Origins of Spam"
    557. 

  557. 	.PP
    558. 

  558. 	&lt;second paragraph&gt;
    559. 

  559. </pre>
    560. 

  560. 

  561. the first paragraph will be blue, the head and subhead will be in
    562. 

  562. the document's default colour (usually black), and the second
    563. 

  563. paragraph will be in blue.
    564. 

  564. <p>
    565. 

  565. The one document element that is affected by changing the colour
    566. 

  566. of paragraphs are
    567. 

  567. <a href="#PARAHEAD">paraheads</a>,
    568. 

  568. since they are attached directly to the body of paragraphs.  In
    569. 

  569. other words, if you change the colour of a paragraph and do not
    570. 

  570. reset the paragraph colour back to its default, subsequent paraheads
    571. 

  571. will appear in the same colour as your paragraphs unless you have
    572. 

  572. explicitly told <strong>mom</strong> you want a pre-defined (or
    573. 

  573. &quot;initialized&quot;) color (usually black) for your paraheads.
    574. 

  574. <p>
    575. 

  575. See the footnote to
    576. 

  576. <a href="#PARAHEAD_COLOR">.PARAHEAD_COLOR</a>.
    577. 

  577. 

  578. <a name="PP_LEADING"><h3><u>4. Leading</u></h3></a>
    579. 

  579. <p>
    580. 

  580. The paragraph
    581. 

  581. <a href="definitions.html#TERMS_LEADING">leading</a>
    582. 

  582. is set with
    583. 

  583. <a href="typesetting.html#LEADING">LS</a>
    584. 

  584. prior to
    585. 

  585. <a href="docprocessing.html#START">START</a>,
    586. 

  586. or
    587. 

  587. <a href="docprocessing.html#DOC_LEAD">DOC_LEAD</a>
    588. 

  588. afterwards.  Please note that either method globally affects the
    589. 

  589. leading and spacing of every document element (except
    590. 

  590. <a href="definitions.html#TERMS_HEADER">headers</a>
    591. 

  591. and
    592. 

  592. <a href="definitions.html#TERMS_FOOTER">footers</a>).
    593. 

  593. <p>
    594. 

  594. If you wish to change the leading of regular text paragraphs only,
    595. 

  595. invoke <strong>LS</strong> immediately after <strong>PP</strong> in
    596. 

  596. EVERY paragraph whose leading you wish to change.
    597. 

  597. <p>
    598. 

  598. <strong>HYPER-IMPORTANT NOTE:</strong> It is extremely unwise to change
    599. 

  599. paragraph leading with <strong>LS</strong>, as it will, in all cases,
    600. 

  600. screw up <strong>mom</strong>'s ability to balance the bottom margin
    601. 

  601. of pages.  Should you absolutely need to change paragraph leading
    602. 

  602. with <strong>LS</strong>, and subsequently want <strong>mom</strong>
    603. 

  603. to get back on the right leading track, use the
    604. 

  604. <a href="docprocessing.html#SHIM">SHIM</a>
    605. 

  605. macro.
    606. 

  606. <p>
    607. 

  607. <strong>Mom</strong>'s default paragraph leading (document leading)
    608. 

  608. is 16 points, adjusted to fill the page.
    609. 

  609. <p>
    610. 

  610. 

  611. <a name="PP_JUST_QUAD"><h3><u>5. Justification/quad</u></h3></a>
    612. 

  612. <p>
    613. 

  613. The justification/quad-direction of regular text paragraphs (i.e.
    614. 

  614. <a href="definitions.html#TERMS_JUST">justified</a>,
    615. 

  615. or
    616. 

  616. <a href="definitions.html#TERMS_FILLED">filled</a>
    617. 

  617. and
    618. 

  618. <a href="definitions.html#TERMS_QUAD">quadded</a>
    619. 

  619. left/right/centre) is set with
    620. 

  620. <a href="typesetting.html#JUSTIFY">JUSTIFY</a>
    621. 

  621. or
    622. 

  622. <a href="typesetting.html#QUAD">QUAD</a>
    623. 

  623. prior to
    624. 

  624. <a href="docprocessing.html#START">START</a>,
    625. 

  625. and with
    626. 

  626. <a href="docprocessing.html#DOC_QUAD">DOC_QUAD</a>
    627. 

  627. afterwards.
    628. 

  628. <p>
    629. 

  629. Please note that either method of setting the paragraph
    630. 

  630. justification/quad-direction also affects
    631. 

  631. <a href="#EPIGRAPH_INTRO">epigraphs</a>
    632. 

  632. and
    633. 

  633. <a href="#FOOTNOTE_INTRO">footnotes</a>,
    634. 

  634. but not
    635. 

  635. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
    636. 

  636. (whose default is QUAD LEFT unless you change it with
    637. 

  637. <a href="#BLOCKQUOTE">BLOCKQUOTE_QUAD</a>).
    638. 

  638. The justification/quad-direction of epigraphs and footnotes may
    639. 

  639. be changed with their own control macros.
    640. 

  640. <p>
    641. 

  641. If you wish to change the justification/quad-direction of
    642. 

  642. individual paragraphs, use <strong>JUSTIFY</strong> or
    643. 

  643. <strong>QUAD</strong> immediately after <strong>PP</strong>.
    644. 

  644. Only the paragraph in question gets justified or quadded
    645. 

  645. differently;  subsequent paragraphs remain unaffected.
    646. 

  646. <p>
    647. 

  647. <strong>Mom</strong>'s default justification/quad-direction for
    648. 

  648. paragraphs is
    649. 

  649. <br>
    650. 

  650. <ul>
    651. 

  651.     <li>justified, for
    652. 

  652.         <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
    653. 

  653.     <li>quad left, for
    654. 

  654.         <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>
    655. 

  655. </ul>
    656. 

  656. <p>
    657. 

  657. <a name="PARA_INDENT"><h3><u>6. First-line indent -- PARA_INDENT</u></h3></a>
    658. 

  658. <p>
    659. 

  659. The first-line indent of paragraphs is controlled by
    660. 

  660. <strong>PARA_INDENT</strong>, which takes one argument: the size
    661. 

  661. of the indent.  <strong>PARA_INDENT</strong> may be used before
    662. 

  662. or after
    663. 

  663. <a href="docprocessing.html#START">START</a>.
    664. 

  664. A
    665. 

  665. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    666. 

  666. is required; fractional sizes are allowed.  Thus, to set the paragraph
    667. 

  667. indent to 4-1/2
    668. 

  668. <a href="definitions.html#TERMS_EM">ems</a>, do
    669. 

  669. <p>
    670. 

  670. <pre>
    671. 

  671. 	.PARA_INDENT 4.5m
    672. 

  672. </pre>
    673. 

  673. 

  674. In addition to establishing the basic first line-indent of
    675. 

  675. paragraphs, <strong>PARA_INDENT</strong> also affects
    676. 

  676. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
    677. 

  677. <a href="#QUOTE_INTRO">quotes</a>
    678. 

  678. and
    679. 

  679. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>,
    680. 

  680. whose overall indenting from the left and (where applicable) right
    681. 

  681. margins is relative to <strong>PARA_INDENT</strong>.  Furthermore, the
    682. 

  682. first-line indent of paragraphs within these document elements (as well
    683. 

  683. as footnotes) is also relative to <strong>PARA_INDENT</strong> (always
    684. 

  684. 1/2 of <strong>PARA_INDENT)</strong>), hence they are also affected.
    685. 

  685. <p>
    686. 

  686. <strong>Mom</strong>'s default <strong>PARA_INDENT</strong> is 2
    687. 

  687. ems for
    688. 

  688. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
    689. 

  689. and 3 picas (1/2 inch) for
    690. 

  690. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>.
    691. 

  691. <p>
    692. 

  692. 

  693. <a name="PARA_INDENT_FIRST"><h3><u>7. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a>
    694. 

  694. <p>
    695. 

  695. By default, <strong>mom</strong> does not indent the first paragraph
    696. 

  696. of a document, nor the first paragraph after a head or
    697. 

  697. subhead, nor the first paragraphs of 
    698. 

  698. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
    699. 

  699. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
    700. 

  700. or
    701. 

  701. <a href="#FOOTNOTE_INTRO">footnotes</a>
    702. 

  702. that run to more than one paragraph.
    703. 

  703. <a name="INDENT_FIRST_PARAS"></a>
    704. 

  704. <p>
    705. 

  705. If you wish to have first paragraphs indented, invoke the macro
    706. 

  706. <strong>.INDENT_FIRST_PARAS</strong> with no argument, either
    707. 

  707. before or after
    708. 

  708. <a href="docprocessing.html#START">START</a>.
    709. 

  709. <strong>INDENT_FIRST_PARAS</strong> is a toggle macro, therefore
    710. 

  710. passing it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels
    711. 

  711. its effect, meaning that first paragraphs will once again NOT be
    712. 

  712. indented.
    713. 

  713. <p>
    714. 

  714. 

  715. <a name="PP_SPACE"><h3><u>8. Spacing paragraphs -- PARA_SPACE</u></h3></a>
    716. 

  716. <p>
    717. 

  717. By default, <strong>mom</strong> does not insert a blank line
    718. 

  718. between paragraphs.  If you would like her to do so, invoke the
    719. 

  719. macro <code>.PARA_SPACE</code> with no argument, either
    720. 

  720. before or after
    721. 

  721. <a href="docprocessing.html#START">START</a>.
    722. 

  722. <strong>PARA_SPACE</strong> is a toggle macro, therefore passing
    723. 

  723. it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels its
    724. 

  724. effect, meaning that paragraphs will once again NOT be separated by
    725. 

  725. a blank line.
    726. 

  726. <p>
    727. 

  727. <strong>NOTE:</strong> If <strong>PARA_SPACE</strong> is on,
    728. 

  728. <strong>mom</strong> spaces only those paragraphs that come after
    729. 

  729. an &quot;initial&quot; paragraph.  Initial paragraphs are those
    730. 

  730. that come immediately after the
    731. 

  731. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
    732. 

  732. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
    733. 

  733. <a href="#HEAD_INTRO">heads</a>,
    734. 

  734. <a href="#SUBHEAD_INTRO">subheads</a>
    735. 

  735. and
    736. 

  736. <a href="#LINEBREAK_INTRO">linebreaks</a>.
    737. 

  737. (The first paragraph after these document elements requires no
    738. 

  738. blank line to separate it from other paragraphs.)
    739. 

  739. <p>
    740. 

  740. Sometimes, you can be fairly deep into a document before using
    741. 

  741. <strong>.PP</strong> for the first time, and when you do, because
    742. 

  742. <strong>mom</strong> is still waiting for that &quot;initial&quot;
    743. 

  743. paragraph, she doesn't space it with a blank line, even though
    744. 

  744. you expect her to.  The simple workaround for this is to invoke
    745. 

  745. <strong>.PP</strong> <em>twice</em> (in succession) at the point you
    746. 

  746. expect the blank line to appear.
    747. 

  747. <br>
    748. 

  748. <hr>
    749. 

  749. 

  750. <!====================================================================>
    751. 

  751. 

  752. <a name="HEAD_INTRO"><h2><u>Main heads</u></h2></a>
    753. 

  753. <ul>
    754. 

  754. 	<li><a href="#HEAD">Tag: HEAD</a>
    755. 

  755. 	<li><a href="#HEAD_CONTROL">Head control macros</a>
    756. 

  756. </ul>
    757. 

  757. <p>
    758. 

  758. Main heads -- or, in this documentation, just &quot;heads&quot;
    759. 

  759. -- should be used any place you want titles to introduce major
    760. 

  760. sections of a document.  If you wish, <strong>mom</strong> can number
    761. 

  761. your heads for you.  Head numbers can also be included
    762. 

  762. hierarchically in numbered
    763. 

  763. <a href="#SUBHEAD_INTRO">subheads</a>
    764. 

  764. and
    765. 

  765. <a href="#PARAHEAD_INTRO">paraheads</a>.
    766. 

  766. <p>
    767. 

  767. By default, heads are centred on the page, underlined,
    768. 

  768. all in caps.  A double linespace precedes each head.  In <a
    769. 

  769. href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, heads
    770. 

  770. are bold, slightly larger than paragraph text.
    771. 

  771. <p>
    772. 

  772. If these defaults don't suit you, you can change them with the
    773. 

  773. head control macros.
    774. 

  774. <p>
    775. 

  775. 

  776. <!---HEAD--->
    777. 

  777. 

  778. <hr width="66%" align="left">
    779. 

  779. <p>
    780. 

  780. <a name="HEAD">
    781. 

  781. 	<nobr>Macro: <strong>HEAD</strong> &quot;&lt;text of head&gt;&quot; [ &quot;&lt;2nd line&gt;&quot; [ &quot;&lt;3rd line&gt;&quot; ... ] ]</nobr>
    782. 

  782. </a>
    783. 

  783. 

  784. <p>
    785. 

  785. The argument to <strong>HEAD</strong> is the text of the head,
    786. 

  786. surrounded by double-quotes.  If you need additional lines for a
    787. 

  787. head, simply surround each line with double-quotes.
    788. 

  788. <p>
    789. 

  789. <strong>NOTE:</strong> If a head falls near the bottom of an output page
    790. 

  790. and <strong>mom</strong> is unable to fit the head <em>plus at least
    791. 

  791. one line of text underneath it</em>, she will set the head at the
    792. 

  792. top of the next page.
    793. 

  793. <p>
    794. 

  794. <strong>ADDITIONAL NOTE:</strong> If an
    795. 

  795. <a href="definitions.html#TERMS_INPUTLINE">input line</a>
    796. 

  796. in a head (i.e. one of the lines surrounded by double-quotes) has
    797. 

  797. to be broken by <strong>mom</strong> in order to fit the current
    798. 

  798. line-length (say, a narrow column measure), the head underline
    799. 

  799. (underscore) will not behave.  You'll recognize the problem as soon
    800. 

  800. as you preview your document.  If you encounter a head that
    801. 

  801. misbehaves with respect to underlining, the solution is to
    802. 

  802. supply each line <em>as you want it</em> as a separate argument
    803. 

  803. (surrounded by double-quotes) to the <strong>HEAD</strong> macro.
    804. 

  804. <p>
    805. 

  805. For example, if <strong>mom</strong> breaks
    806. 

  806. <pre>
    807. 

  807. 	.HEAD "This is a very, very, very long head"
    808. 

  808. </pre>
    809. 

  809. into
    810. 

  810. <pre>
    811. 

  811. 	This is a very, very, very
    812. 

  812. 	        long head        
    813. 

  813. </pre>
    814. 

  814. 

  815. you'll see the misbehaving underscore and should change the
    816. 

  816. argument to <strong>HEAD</strong> to
    817. 

  817. <pre>
    818. 

  818. 	.HEAD "This is a very, very very" "long head"
    819. 

  819. </pre>
    820. 

  820. 

  821. <a name="HEAD_CONTROL"><h3><u>Head control macros</u></h3></a>
    822. 

  822. <p>
    823. 

  823. There are, in addition to the usual family/font/size/quad control
    824. 

  824. macros, a number of macros to manage head numbering, spacing,
    825. 

  825. underlining, and so on.  Check them out if you're unhappy with
    826. 

  826. <strong>mom</strong>'s defaults.
    827. 

  827. <p>
    828. 

  828. <ol>
    829. 

  829. 	<li><a href="#HEAD_GENERAL">Family/font/size/colour/quad</a>
    830. 

  830. 	<li><a href="#HEAD_CAPS">Caps</a>
    831. 

  831. 	<li><a href="#HEAD_SPACE">Pre-head space</a>
    832. 

  832. 	<li><a href="#HEAD_UNDERLINE">Underlining</a>
    833. 

  833. 	<li><a href="#NUMBER_HEADS">Numbering</a>
    834. 

  834. 	<li><a href="#RESET_HEAD_NUMBER">Reset head numbering</a>
    835. 

  835. 	<li><a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>
    836. 

  836. </ol>
    837. 

  837. <p>
    838. 

  838. <a name="HEAD_GENERAL"><h3><u>1. Family/font/size/colour/quad</u></h3></a>
    839. 

  839. <p>
    840. 

  840. See
    841. 

  841. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    842. 

  842. <p>
    843. 

  843. <pre>
    844. 

  844. .HEAD_FAMILY default = prevailing document family; default is Times Roman
    845. 

  845. .HEAD_FONT   default = bold
    846. 

  846. .HEAD_SIZE   default = +1 (point)
    847. 

  847. .HEAD_COLOR  default = black
    848. 

  848. .HEAD_QUAD   default = CENTER
    849. 

  849. </pre>
    850. 

  850. 

  851. <a name="HEAD_CAPS"><h3><u>2. Capitalizing heads -- HEAD_CAPS</u></h3></a>
    852. 

  852. <p>
    853. 

  853. By default, <strong>mom</strong> sets heads in caps, regardless
    854. 

  854. of the
    855. 

  855. <a href="definitions.html#TERMS_STRINGARGUMENT">string(s)</a>
    856. 

  856. you give to
    857. 

  857. <a href="#HEAD">HEAD</a>.
    858. 

  858. To change this behaviour, do
    859. 

  859. <p>
    860. 

  860. <pre>
    861. 

  861. 	.HEAD_CAPS OFF
    862. 

  862. </pre>
    863. 

  863. 

  864. <strong>HEAD_CAPS</strong> is a toggle macro, therefore you can use
    865. 

  865. any argument you like instead of <strong>OFF</strong> (<strong>END,
    866. 

  866. QUIT, Q, X</strong>...).  To turn <strong>HEAD_CAPS</strong> back on,
    867. 

  867. simply invoke it without an argument.
    868. 

  868. <p>
    869. 

  869. 

  870. <a name="HEAD_SPACE"><h3><u>3. Space before heads -- HEAD_SPACE</u></h3></a>
    871. 

  871. <p>
    872. 

  872. By default, <strong>mom</strong> deposits 2 blank lines prior to every
    873. 

  873. head.  If you'd prefer just a single blank line, do
    874. 

  874. <p>
    875. 

  875. <pre>
    876. 

  876. 	.HEAD_SPACE OFF
    877. 

  877. </pre>
    878. 

  878. 

  879. <strong>HEAD_SPACE</strong> is a toggle macro, therefore you can use
    880. 

  880. any argument you like instead of <strong>OFF</strong> (<strong>END,
    881. 

  881. QUIT, Q, X</strong>...).  To restore the space before heads to 2
    882. 

  882. blank lines, invoke <strong>HEAD_SPACE</strong> without an argument.
    883. 

  883. <p>
    884. 

  884. 

  885. <a name="HEAD_UNDERLINE"><h3><u>4. Underlining heads -- HEAD_UNDERLINE</u></h3></a>
    886. 

  886. <p>
    887. 

  887. By default, <strong>mom</strong> underlines heads.  To change this
    888. 

  888. behaviour, do
    889. 

  889. <p>
    890. 

  890. <pre>
    891. 

  891. 	.HEAD_UNDERLINE OFF
    892. 

  892. </pre>
    893. 

  893. 

  894. <strong>HEAD_UNDERLINE</strong> is a toggle macro, therefore you can
    895. 

  895. use any argument you like instead of <strong>OFF</strong> (<strong>END,
    896. 

  896. QUIT, Q, X</strong>...).  To restore underlining of heads, invoke
    897. 

  897. <strong>HEAD_UNDERLINE</strong> without an argument.
    898. 

  898. <p>
    899. 

  899. 

  900. <a name="NUMBER_HEADS"><h3><u>5. Number heads -- NUMBER_HEADS</u></h3></a>
    901. 

  901. <p>
    902. 

  902. If you'd like your heads numbered, simply invoke
    903. 

  903. <strong>NUMBER_HEADS</strong> with no argument.  <strong>Mom</strong>
    904. 

  904. will number all subsequent heads automatically (in ascending order,
    905. 

  905. naturally).
    906. 

  906. <p>
    907. 

  907. If, in addition to numbering heads, you also request that
    908. 

  908. <a href="#SUBHEAD_INTRO">subheads</a>
    909. 

  909. and/or
    910. 

  910. <a href="#PARAHEAD_INTRO">paraheads</a>
    911. 

  911. be numbered, the head number will be included in their numbers
    912. 

  912. (each number separated by a period [dot]).
    913. 

  913. <p>
    914. 

  914. Should you wish to stop head numbering, invoke
    915. 

  915. <strong>NUMBER_HEADS</strong> with any argument (<strong>OFF, QUIT,
    916. 

  916. END, X</strong>...).  Head numbering will cease, and the head number
    917. 

  917. will not be included in the numbering of subheads and/or paraheads.
    918. 

  918. <p>
    919. 

  919. 

  920. <a name="RESET_HEAD_NUMBER"><h3><u>6. Reset head numbering -- RESET_HEAD_NUMBER</u></h3></a>
    921. 

  921. <p>
    922. 

  922. Should you wish to reset the head number to &quot;1&quot;, invoke
    923. 

  923. <strong>RESET_HEAD_NUMBER</strong> with no argument.  If, for some
    924. 

  924. reason, you want <strong>mom</strong> to use a head number that is not
    925. 

  925. the next in ascending order (i.e. the last head number + 1), invoke
    926. 

  926. <strong>RESET_HEAD_NUMBER</strong> with the number you want, e.g.
    927. 

  927. <p>
    928. 

  928. <pre>
    929. 

  929. 	.RESET_HEAD_NUMBER 6
    930. 

  930. </pre>
    931. 

  931. 

  932. Your next head will be numbered &quot;6&quot; and subsequent heads will
    933. 

  933. be numbered in ascending order from &quot;6&quot;.
    934. 

  934. <p>
    935. 

  935. 

  936. <a name="HEAD_INLINES"><h3><u>7. Vertical inline escapes inside heads</u></h3></a>
    937. 

  937. <p>
    938. 

  938. If you need to adjust the
    939. 

  939. <a href="definitions.html#TERMS_BASELINE">baseline</a>
    940. 

  940. position of a head (e.g. the head falls at the top of a column and
    941. 

  941. you want its
    942. 

  942. <a href="definitions.html#TERMS_ASCENDER">ascenders</a>
    943. 

  943. to line up with the ascenders of
    944. 

  944. <a href="definitions.html#TERMS_RUNNING">running text</a>
    945. 

  945. in other columns), you can embed a vertical motion
    946. 

  946. <a href="definitions.html#TERMS_INLINES">inline escape</a>
    947. 

  947. (either
    948. 

  948. <a href="inlines.html#INLINE_VERTICAL_MOM">mom</a>'s
    949. 

  949. or
    950. 

  950. <a href="inlines.html#INLINE_VERTICAL_GROFF">groff</a>'s
    951. 

  951. in the string(s) you pass to <strong>HEAD</strong>
    952. 

  952. <p>
    953. 

  953. For example,
    954. 

  954. <p>
    955. 

  955. <pre>
    956. 

  956. 	.HEAD "\[ALD3]Text of head"
    957. 

  957. 	    or
    958. 

  958. 	.HEAD "\[DOWN 3p]Text of head"
    959. 

  959. </pre>
    960. 

  960. 

  961. will lower the baseline of the head by three points.  Note that
    962. 

  962. there's no need to reverse the sense of the inline escape.
    963. 

  963. <p>
    964. 

  964. In the case of heads that run to more than one line, you must embed
    965. 

  965. the escape in the string for each line, like this:
    966. 

  966. <p>
    967. 

  967. <pre>
    968. 

  968. 	.HEAD "\[ALD3]First line" "\[ALD3]Next line" 
    969. 

  969. 	    or
    970. 

  970. 	.HEAD "\[DOWN 3p]First line" "\[DOWN 3p]Next line" 
    971. 

  971. </pre>
    972. 

  972. <hr>
    973. 

  973. 

  974. <!====================================================================>
    975. 

  975. 

  976. <a name="SUBHEAD_INTRO"><h2><u>Subheads</u></h2></a>
    977. 

  977. <ul>
    978. 

  978. 	<li><a href="#SUBHEAD">Tag: SUBHEAD</a>
    979. 

  979. 	<li><a href="#SUBHEAD_CONTROL">Subhead control macros</a>
    980. 

  980. </ul>
    981. 

  981. <p>
    982. 

  982. Subheads should be used any place you want titles to introduce
    983. 

  983. sections of a document below heads.  If you wish, <strong>mom</strong>
    984. 

  984. can number subheads for you.  Subhead numbers can also be included
    985. 

  985. hierarchically in numbered
    986. 

  986. <a href="#PARAHEAD_INTRO">paraheads</a>.
    987. 

  987. <p>
    988. 

  988. By default, subheads are flush left.  In
    989. 

  989. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
    990. 

  990. they are set bold, slightly larger than paragraph text.  In
    991. 

  991. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    992. 

  992. they are underlined.  A single linespace precedes them in both
    993. 

  993. printstyles, and a tiny space adjustment raises them slightly
    994. 

  994. above text that comes afterwards for greater clarity in
    995. 

  995. document structuring.
    996. 

  996. <p>
    997. 

  997. If these defaults don't suit you, you can change them with the
    998. 

  998. subhead control macros.
    999. 

  999. <p>
    1000. 

  1000. 

  1001. <!---SUBHEAD--->
    1002. 

  1002. 

  1003. <hr width="66%" align="left">
    1004. 

  1004. <p>
    1005. 

  1005. <a name="SUBHEAD">
    1006. 

  1006. 	<nobr>Macro: <strong>SUBHEAD</strong> &quot;&lt;text of subhead&gt;&quot; [ &quot;&lt;2nd line&gt;&quot; [ &quot;&lt;3rd line&gt;&quot; ... ] ]</nobr>
    1007. 

  1007. </a>
    1008. 

  1008. <p>
    1009. 

  1009. The argument to <strong>SUBHEAD</strong> is the text of the subhead,
    1010. 

  1010. surrounded by double-quotes.  If you need additional lines for a
    1011. 

  1011. subhead, simply surround each line with double-quotes.
    1012. 

  1012. <p>
    1013. 

  1013. <strong>NOTE:</strong> If a subhead falls near the bottom of an output
    1014. 

  1014. page and <strong>mom</strong> is unable to fit the head <em>plus at
    1015. 

  1015. least one line of text underneath it</em>, she will set the subhead
    1016. 

  1016. at the top of the next page.
    1017. 

  1017. 

  1018. <a name="SUBHEAD_CONTROL"><h3><u>Subhead control macros</u></h3></a>
    1019. 

  1019. <p>
    1020. 

  1020. In addition to the usual family/font/size/quad control
    1021. 

  1021. macros, there are macros to manage subhead numbering.
    1022. 

  1022. <p>
    1023. 

  1023. <ol>
    1024. 

  1024. 	<li><a href="#SUBHEAD_GENERAL">Family/font/size/colour/quad</a>
    1025. 

  1025. 	<li><a href="#NUMBER_SUBHEADS">Numbering</a>
    1026. 

  1026. 	<li><a href="#RESET_SUBHEAD_NUMBER">Reset subhead numbering</a>
    1027. 

  1027. 	<li><a href="#SUBHEAD_INLINES">Vertical inline escapes inside subheads</a>
    1028. 

  1028. </ol>
    1029. 

  1029. <p>
    1030. 

  1030. <a name="SUBHEAD_GENERAL"><h3><u>1. Family/font/size/quad</u></h3></a>
    1031. 

  1031. <p>
    1032. 

  1032. See
    1033. 

  1033. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    1034. 

  1034. <p>
    1035. 

  1035. <pre>
    1036. 

  1036. .SUBHEAD_FAMILY default = prevailing document family; default is Times Roman
    1037. 

  1037. .SUBHEAD_FONT   default = bold
    1038. 

  1038. .SUBHEAD_SIZE   default = +.5 (point)
    1039. 

  1039. .SUBHEAD_COLOR  default = black
    1040. 

  1040. .SUBHEAD_QUAD   default = LEFT
    1041. 

  1041. </pre>
    1042. 

  1042. 

  1043. <a name="NUMBER_SUBHEADS"><h3><u>2. Number subheads -- NUMBER_SUBHEADS</u></h3></a>
    1044. 

  1044. <p>
    1045. 

  1045. If you'd like your subheads numbered, simply invoke
    1046. 

  1046. <strong>.NUMBER_SUBHEADS</strong> with no argument.
    1047. 

  1047. <strong>Mom</strong> will number all subsequent subheads automatically
    1048. 

  1048. (in ascending order, naturally).
    1049. 

  1049. <p>
    1050. 

  1050. If, in addition to numbering subheads, you also request that
    1051. 

  1051. <a href="#HEAD_INTRO">heads</a>
    1052. 

  1052. be numbered, the head number will be included in the subhead number
    1053. 

  1053. (separated by a period [dot]).
    1054. 

  1054. <p>
    1055. 

  1055. Should you wish to stop subhead numbering, invoke
    1056. 

  1056. <strong>NUMBER_SUBHEADS</strong> with any argument (<strong>OFF, QUIT,
    1057. 

  1057. END, X</strong>...).  Subhead numbering will cease, and the subhead
    1058. 

  1058. number will not be included in the numbering of paraheads.
    1059. 

  1059. <p>
    1060. 

  1060. 

  1061. <a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a>
    1062. 

  1062. <p>
    1063. 

  1063. Should you wish to reset the subhead number to &quot;1&quot;, invoke
    1064. 

  1064. <strong>RESET_SUBHEAD_NUMBER</strong> with no argument.  If, for some
    1065. 

  1065. reason, you want <strong>mom</strong> to use a subhead number that is not
    1066. 

  1066. the next in ascending order (i.e. the last subhead number + 1), invoke
    1067. 

  1067. <strong>RESET_SUBHEAD_NUMBER</strong> with the number you want, e.g.
    1068. 

  1068. <p>
    1069. 

  1069. <pre>
    1070. 

  1070. 	.RESET_SUBHEAD_NUMBER 4
    1071. 

  1071. </pre>
    1072. 

  1072. 

  1073. Your next subhead will be numbered &quot;4&quot; and subsequent
    1074. 

  1074. subheads will be numbered in ascending order from &quot;4&quot;.
    1075. 

  1075. 

  1076. <a name="SUBHEAD_INLINES"><h3><u>Vertical inline escapes inside subheads</u></h3></a>
    1077. 

  1077. See
    1078. 

  1078. <a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>.
    1079. 

  1079. The information there applies equally to subheads.
    1080. 

  1080. <p>
    1081. 

  1081. <hr>
    1082. 

  1082. 

  1083. <!====================================================================>
    1084. 

  1084. 

  1085. <a name="PARAHEAD_INTRO"><h2><u>Paragraph heads</u></h2></a>
    1086. 

  1086. <ul>
    1087. 

  1087. 	<li><a href="#PARAHEAD">Tag: PARAHEAD</a>
    1088. 

  1088. 	<li><a href="#PARAHEAD_CONTROL">Parahead control macros</a>
    1089. 

  1089. </ul>
    1090. 

  1090. <p>
    1091. 

  1091. Paragraph heads (paraheads) should be used any place you want titles
    1092. 

  1092. to introduce paragraphs below heads or subheads.  If you wish,
    1093. 

  1093. <strong>mom</strong> can number paraheads for you.
    1094. 

  1094. <p>
    1095. 

  1095. By default, paraheads are joined to the body of a paragraph,
    1096. 

  1096. slightly indented (provided the paragraph is not a
    1097. 

  1097. &quot;first&quot; paragraph as defined in
    1098. 

  1098. <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>).
    1099. 

  1099. In
    1100. 

  1100. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
    1101. 

  1101. they are set bold italic, slightly larger than paragraph text.  In
    1102. 

  1102. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    1103. 

  1103. they are underlined.
    1104. 

  1104. <p>
    1105. 

  1105. If these defaults don't suit you, you can change them with the
    1106. 

  1106. parahead control macros.
    1107. 

  1107. <p>
    1108. 

  1108. 

  1109. <!---PARAHEAD--->
    1110. 

  1110. 

  1111. <hr width="66%" align="left">
    1112. 

  1112. <p>
    1113. 

  1113. <a name="PARAHEAD">
    1114. 

  1114. 	<nobr>Macro: <strong>PARAHEAD</strong> &quot;&lt;text of parahead&gt;&quot;</nobr>
    1115. 

  1115. </a>
    1116. 

  1116. <p>
    1117. 

  1117. <strong>PARAHEAD</strong> must come AFTER
    1118. 

  1118. <a href="#PP">PP</a>
    1119. 

  1119. or it will not work!
    1120. 

  1120. <p>
    1121. 

  1121. The argument is the text of the parahead, surrounded by double-quotes.
    1122. 

  1122. Because paraheads are joined to the body of a paragraph, they accept
    1123. 

  1123. only one argument (see
    1124. 

  1124. <a href="#HEAD">HEAD</a>
    1125. 

  1125. and
    1126. 

  1126. <a href="#SUBHEAD">SUBHEAD</a>).
    1127. 

  1127. <p>
    1128. 

  1128. 

  1129. <a name="PARAHEAD_CONTROL"><h3><u>Parahead control macros</u></h3></a>
    1130. 

  1130. <p>
    1131. 

  1131. In addition to the family/font/size/colour/indent control macros,
    1132. 

  1132. there are macros to manage parahead numbering.
    1133. 

  1133. <p>
    1134. 

  1134. <ol>
    1135. 

  1135. 	<li><a href="#PARAHEAD_GENERAL">Family/font/size/color</a>
    1136. 

  1136. 	<li><a href="#PARAHEAD_INDENT">Indent</a>
    1137. 

  1137. 	<li><a href="#NUMBER_PARAHEADS">Numbering</a>
    1138. 

  1138. 	<li><a href="#RESET_PARAHEAD_NUMBER">Reset parahead numbering</a>
    1139. 

  1139. </ol>
    1140. 

  1140. <p>
    1141. 

  1141. <a name="PARAHEAD_GENERAL"><h3><u>1. Family/font/size/colour</u></h3></a>
    1142. 

  1142. <p>
    1143. 

  1143. See
    1144. 

  1144. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    1145. 

  1145. <p>
    1146. 

  1146. <pre>
    1147. 

  1147. .PARAHEAD_FAMILY default = prevailing document family; default is Times Roman
    1148. 

  1148. .PARAHEAD_FONT   default = bold italic
    1149. 

  1149. .PARAHEAD_SIZE   default = +.5 (point)
    1150. 

  1150. <a name="PARAHEAD_COLOR">.PARAHEAD_COLOR  default = black*</a>
    1151. 

  1151. 

  1152. *If you colourize paragraph text, paraheads will appear in the same
    1153. 

  1153. colour as the text unless you explicitly tell mom to colour them
    1154. 

  1154. otherwise by invoking .PARAHEAD_COLOR.  If you do want paraheads
    1155. 

  1155. that are coloured the same as paragraph text, it's generally a good
    1156. 

  1156. idea to invoke .PARAHEAD_COLOR anyway (with the same colour used
    1157. 

  1157. for paragraph text), just to let mom know.
    1158. 

  1158. </pre>
    1159. 

  1159. 

  1160. <a name="PARAHEAD_INDENT"><h3><u>2. Indent</u></h3></a>
    1161. 

  1161. <p>
    1162. 

  1162. Unlike other control macros that end in
    1163. 

  1163. <a href="#CONTROL_INDENTS"><strong>_INDENT</strong></a>,
    1164. 

  1164. the argument to the macro that controls indenting of paragraph heads
    1165. 

  1165. (<strong>PARAHEAD_INDENT</strong>) is NOT relative to the first-line
    1166. 

  1166. indent of normal paragraphs.  In other words, it takes an absolute
    1167. 

  1167. value, and requires a
    1168. 

  1168. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    1169. 

  1169. For example, to set the paragraph head indent to 2-1/2 picas, you
    1170. 

  1170. do:
    1171. 

  1171. <p>
    1172. 

  1172. <pre>
    1173. 

  1173. 	.PARAHEAD_INDENT 2.5P
    1174. 

  1174. </pre>
    1175. 

  1175. <strong>Mom</strong>'s default indent for paragraph heads is 1/2
    1176. 

  1176. the first-line indent of normal paragraphs (both printstyles).
    1177. 

  1177. However, as stated above, if you choose to change the indent, you
    1178. 

  1178. must give an absolute value (unless you're a groff expert and want
    1179. 

  1179. to manipulate the number register <code>\n[#PP_INDENT]u</code>
    1180. 

  1180. arithmetically as the argument to <strong>PARAHEAD_INDENT</strong>
    1181. 

  1181. for an indent that's relative to <strong>PP_INDENT</strong>.)
    1182. 

  1182. <p>
    1183. 

  1183. <strong>NOTE:</strong> Paragraph heads in &quot;first
    1184. 

  1184. paragraphs&quot;, as defined in
    1185. 

  1185. <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>,
    1186. 

  1186. are not indented unless you turn
    1187. 

  1187. <a href="#INDENT_FIRST_PARAS">INDENT_FIRST_PARAS</a>
    1188. 

  1188. on.
    1189. 

  1189. <p>
    1190. 

  1190. 

  1191. <a name="NUMBER_PARAHEADS"><h3><u>3. Number paraheads -- NUMBER_PARAHEADS</u></h3></a>
    1192. 

  1192. <p>
    1193. 

  1193. If you'd like your paraheads numbered, simply invoke
    1194. 

  1194. <strong>.NUMBER_PARAHEADS</strong> with no argument.
    1195. 

  1195. <strong>Mom</strong> will number all subsequent paraheads automatically
    1196. 

  1196. (in ascending order, naturally).
    1197. 

  1197. <p>
    1198. 

  1198. If, in addition to numbering paraheads, you also request that
    1199. 

  1199. <a href="#HEAD_INTRO">heads</a>
    1200. 

  1200. and
    1201. 

  1201. <a href="#SUBHEAD_INTRO">subheads</a>
    1202. 

  1202. be numbered, the head and/or subhead number will be included in the
    1203. 

  1203. parahead number (separated by a period [dot]).
    1204. 

  1204. <p>
    1205. 

  1205. Should you wish to stop parahead numbering, invoke
    1206. 

  1206. <strong>NUMBER_PARAHEADS</strong> with any argument (<strong>OFF,
    1207. 

  1207. QUIT, END, X</strong>...).  Parahead numbering will cease.
    1208. 

  1208. <p>
    1209. 

  1209. 

  1210. <a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a>
    1211. 

  1211. <p>
    1212. 

  1212. Should you wish to reset the parahead number to &quot;1&quot;, invoke
    1213. 

  1213. <strong>RESET_PARAHEAD_NUMBER</strong> with no argument.  If, for some
    1214. 

  1214. reason, you want <strong>mom</strong> to use a parahead number that is not
    1215. 

  1215. the next in ascending order (i.e. the last parahead number + 1), invoke
    1216. 

  1216. <strong>RESET_PARAHEAD_NUMBER</strong> with the number you want, e.g.
    1217. 

  1217. <p>
    1218. 

  1218. <pre>
    1219. 

  1219. 	.RESET_PARAHEAD_NUMBER 7
    1220. 

  1220. </pre>
    1221. 

  1221. 

  1222. Your next parahead will be numbered &quot;7&quot; and subsequent
    1223. 

  1223. paraheads will be numbered in ascending order from &quot;7&quot;.
    1224. 

  1224. <p>
    1225. 

  1225. <hr>
    1226. 

  1226. 

  1227. <!====================================================================>
    1228. 

  1228. 

  1229. <a name="LINEBREAK_INTRO"><h2><u>Author linebreaks</u></h2></a>
    1230. 

  1230. <ul>
    1231. 

  1231. 	<li><a href="#LINEBREAK">Tag: LINEBREAK</a>
    1232. 

  1232. 	<li><a href="#LINEBREAK_CHAR">Linebreak character control macro</a>
    1233. 

  1233. </ul>
    1234. 

  1234. <p>
    1235. 

  1235. By default, <strong>mom</strong> marks
    1236. 

  1236. <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>
    1237. 

  1237. with three centred asterisks.  You can change this behaviour
    1238. 

  1238. with the linebreak character
    1239. 

  1239. <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>.
    1240. 

  1240. <p>
    1241. 

  1241. 

  1242. <!---LINEBREAK--->
    1243. 

  1243. 

  1244. <hr width="66%" align="left">
    1245. 

  1245. <p>
    1246. 

  1246. <a name="LINEBREAK">
    1247. 

  1247. 	Macro: <strong>LINEBREAK</strong>
    1248. 

  1248. </a>
    1249. 

  1249. <br>
    1250. 

  1250. Alias: <strong>SECTION</strong>
    1251. 

  1251. 

  1252. <p>
    1253. 

  1253. <strong>LINEBREAK</strong> takes no arguments.  Simply invoke it
    1254. 

  1254. (on a line by itself, of course) whenever you want to insert an
    1255. 

  1255. author linebreak.  The appearance of the linebreak is controlled
    1256. 

  1256. by the
    1257. 

  1257. <a href="#LINEBREAK_CHAR">LINEBREAK_CHAR</a>
    1258. 

  1258. macro.
    1259. 

  1259. 

  1260. <h3><u>Linebreak character control macro</u></h3>
    1261. 

  1261. <p>
    1262. 

  1262. <a name="LINEBREAK_CHAR">
    1263. 

  1263. 	<nobr>Macro: <strong>LINEBREAK_CHAR</strong> [ &lt;character&gt; ] [ &lt;iterations&gt; [ &lt;vertical adjustment&gt; ] ]</nobr>
    1264. 

  1264. </a>
    1265. 

  1265. <br>
    1266. 

  1266. Alias: <strong>SECTION_CHAR</strong>
    1267. 

  1267. <br>
    1268. 

  1268. <em>*The third optional argument requires a
    1269. 

  1269. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>.
    1270. 

  1270. <p>
    1271. 

  1271. <strong>LINEBREAK_CHAR</strong> determines what <strong>mom</strong>
    1272. 

  1272. prints when <strong>LINEBREAK</strong> is invoked.  It takes 3
    1273. 

  1273. optional arguments: the character you want deposited at the line
    1274. 

  1274. break, the number of times you want the character repeated, and a
    1275. 

  1275. vertical adjustment factor.
    1276. 

  1276. <p>
    1277. 

  1277. The first argument is any legal groff character (e.g. <kbd>*</kbd>
    1278. 

  1278. [an asterisk], <kbd>\(dg</kbd> [a dagger], <kbd>\f(ZD\N'141\fP</kbd>
    1279. 

  1279. [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd>
    1280. 

  1280. [a 4-pica long rule]).  <strong>Mom</strong> sets the character
    1281. 

  1281. centred on the current line length.  (See &quot;man groff_char&quot;
    1282. 

  1282. for a list of all legal groff characters.)
    1283. 

  1283. <p>
    1284. 

  1284. The second argument is the number of times to repeat the character.
    1285. 

  1285. <p>
    1286. 

  1286. The third argument is a +|- value by which to raise (+) or lower (-)
    1287. 

  1287. the character in order to make it appear visually centred between
    1288. 

  1288. sections of text.  This lets you make vertical adjustments
    1289. 

  1289. to characters that don't sit on the
    1290. 

  1290. <a href="definitions.html#TERMS_BASELINE">baseline</a>
    1291. 

  1291. (such as asterisks).  The argument must be preceded by a plus or
    1292. 

  1292. minus sign, and must include a unit of measure.
    1293. 

  1293. <p>
    1294. 

  1294. If you enter <strong>LINEBREAK_CHAR</strong> with no arguments,
    1295. 

  1295. sections of text will be separated by two blank lines when you invoke
    1296. 

  1296. <strong>LINEBREAK</strong>.
    1297. 

  1297. <p>
    1298. 

  1298. <strong>Mom</strong>'s default for <strong>LINEBREAK_CHAR</strong> is
    1299. 

  1299. <p>
    1300. 

  1300. <pre>
    1301. 

  1301. 	.LINEBREAK_CHAR * 3 -3p
    1302. 

  1302. </pre>
    1303. 

  1303. 

  1304. i.e. three asterisks, lowered 3 points from their normal vertical
    1305. 

  1305. position (for
    1306. 

  1306. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
    1307. 

  1307. the vertical adjustment is -2 points for
    1308. 

  1308. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>).
    1309. 

  1309. 

  1310. <h3><u>Linebreak colour control macro</u></h3>
    1311. 

  1311. <p>
    1312. 

  1312. <a name="LINEBREAK_COLOR">
    1313. 

  1313. 	<nobr>Macro: <strong>LINEBREAK_COLOR</strong> &lt;color name&gt;</nobr>
    1314. 

  1314. </a>
    1315. 

  1315. <p>
    1316. 

  1316. To change the colour of the linebreak character(s), simply invoke
    1317. 

  1317. <strong>LINBREAK_COLOR</strong> with the name of a pre-defined (or
    1318. 

  1318. &quot;initialized&quot;) colour.
    1319. 

  1319. <br>
    1320. 

  1320. <hr>
    1321. 

  1321. 

  1322. <!====================================================================>
    1323. 

  1323. 

  1324. <a name="QUOTE_INTRO"><h2><u>Quotes (line for line)</u></h2></a>
    1325. 

  1325. <ul>
    1326. 

  1326. 	<li><a href="#QUOTE">Tag: QUOTE</a>
    1327. 

  1327. 	<li><a href="#QUOTE_CONTROL">Quote control macros</a>
    1328. 

  1328. </ul>
    1329. 

  1329. <p>
    1330. 

  1330. <a href="definitions.html#TERMS_QUOTE">Quotes</a>
    1331. 

  1331. are always set in
    1332. 

  1332. <a href="definitions.html#TERMS_NOFILL">nofill mode</a>,
    1333. 

  1333. flush left.  This permits entering quotes on a line for line basis in
    1334. 

  1334. your text editor and have them come out the same way on output copy.
    1335. 

  1335. (See
    1336. 

  1336. <a href="#BLOCKQUOTE_INTRO">Blockquotes</a>
    1337. 

  1337. for how quotes, in the present sense, differ from longer
    1338. 

  1338. passages of cited text.)
    1339. 

  1339. <p>
    1340. 

  1340. Since <strong>mom</strong> originally came into being to serve
    1341. 

  1341. the needs of creative writers (i.e. novelists, short story
    1342. 

  1342. writers, etc. -- not to cast aspersions on the creativity of
    1343. 

  1343. mathematicians and programmers), she sets quotes in italics
    1344. 

  1344. <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET)</a>
    1345. 

  1345. or underlined
    1346. 

  1346. <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPEWRITE)</a>,
    1347. 

  1347. indented from the left margin.  Obviously, she's thinking
    1348. 

  1348. &quot;quotes from poetry or song lyrics&quot;, but with the
    1349. 

  1349. <a href="#QUOTE_CONTROL">quote control macros</a>
    1350. 

  1350. you can change her defaults so <strong>QUOTE</strong> serves other
    1351. 

  1351. needs, e.g. entering verbatim snippets of programming code, command
    1352. 

  1352. line instructions, and so on.  (See the
    1353. 

  1353. <a href="#QUOTE_TIP">tip</a>
    1354. 

  1354. below for suggestions about including programming code snippets in
    1355. 

  1355. documents.)
    1356. 

  1356. <p>
    1357. 

  1357. <a name="QUOTE_SPACING"></a>
    1358. 

  1358. Besides indenting quotes, <strong>mom</strong> further sets them
    1359. 

  1359. off from
    1360. 

  1360. <a href="definitions.html#TERMS_RUNNING">running text</a>
    1361. 

  1361. with a small amount of vertical whitespace top and bottom.  In
    1362. 

  1362. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    1363. 

  1363. this is always one full linespace.  In
    1364. 

  1364. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
    1365. 

  1365. it's 1/2 of the prevailing
    1366. 

  1366. <a href="definitions.html#TERMS_LEADING">leading</a>
    1367. 

  1367. if the quote fits fully on the page (i.e. with running text above
    1368. 

  1368. and below it), otherwise it's a full linespace either above or below
    1369. 

  1369. as is necessary to balance the page to the bottom margin.  This
    1370. 

  1370. behaviour can be changed with the control macro
    1371. 

  1371. <a href="#ALWAYS_FULLSPACE_QUOTES">ALWAYS_FULLSPACE_QUOTES</a>.
    1372. 

  1372. <p>
    1373. 

  1373. <strong>NOTE:</strong> <strong>ALWAYS_FULLSPACE_QUOTES</strong>
    1374. 

  1374. applies to both
    1375. 

  1375. <a href="#QUOTE">QUOTE</a>
    1376. 

  1376. and
    1377. 

  1377. <a href="#BLOCKQUOTE">BLOCKQUOTE</a>,
    1378. 

  1378. as does the control macro
    1379. 

  1379. <a href="#QUOTE_INDENT">QUOTE_INDENT</a>.
    1380. 

  1380. <p>
    1381. 

  1381. <strong>Version 1.3: mom</strong>'s handling of the vertical
    1382. 

  1382. whitespace around quotes has changed slightly.  In versions prior
    1383. 

  1383. to 1.3, it was not possible to alter the
    1384. 

  1384. <a href="definitions.html#TERMS_LEADING">leading</a>
    1385. 

  1385. of quotes and blockquotes (which was the same as the document
    1386. 

  1386. leading), ensuring that the vertical whitespace remained consistent,
    1387. 

  1387. as described above.  In 1.3 and later, it is possible to change the
    1388. 

  1388. leading of quotes and blockquote via
    1389. 

  1389. the <strong>QUOTE_AUTOLEAD</strong> and
    1390. 

  1390. <strong>BLOCKQUOTE_AUTOLEAD</strong>macro.  Now, if your quote
    1391. 

  1391. (or blockquote) leading differs from the document leading,
    1392. 

  1392. <strong>mom</strong> attempts to observe the same rules for vertical
    1393. 

  1393. whitespace outlined above; however, she will also insert a small,
    1394. 

  1394. flexible amount of extra whitespace around the quotes to make sure
    1395. 

  1395. the whitespace is equal, top and bottom.  Since she does this on a
    1396. 

  1396. quote by quote basis, rather than by figuring out how much extra
    1397. 

  1397. whitespace is needed to adjust <em>all</em> quotes on a page,
    1398. 

  1398. the spacing around multiple quotes on the same page will differ
    1399. 

  1399. slightly, although each will be balanced between lines of normal
    1400. 

  1400. <a href="definitions.html#TERMS_RUNNING">running text</a>,
    1401. 

  1401. top and bottom.  (The inability to scan an entire page and insert
    1402. 

  1402. equalized whitespace at marked places is a limitation of groff,
    1403. 

  1403. which, by and large, works in a linear, line by line fashion.)
    1404. 

  1404. If you don't provide <strong>mom</strong> with a
    1405. 

  1405. <strong>QUOTE_AUTOLEAD</strong>, quotes are leaded at the default
    1406. 

  1406. for normal running text, meaning that multiple quotes on the same
    1407. 

  1407. page are all spaced identically.
    1408. 

  1408. <p>
    1409. 

  1409. <a name="QUOTE_TIP"><strong>TIP:</strong></a>
    1410. 

  1410. If you want to include snippets of programming code in
    1411. 

  1411. <strong>mom</strong> documents, you may come acropper of the fact
    1412. 

  1412. that groff (and <strong>mom</strong>'s) escape character is the
    1413. 

  1413. backslash.  In order for <strong>mom</strong> not to interpret
    1414. 

  1414. backslashes that occur in code snippets as escapes, you have to
    1415. 

  1415. tell <strong>mom</strong> that the backslash character is
    1416. 

  1416. (temporarily) no longer the escape character.  The easiest way
    1417. 

  1417. to do this is to set the escape character to something else for
    1418. 

  1418. the duration of the code snippet.  You accomplish this with
    1419. 

  1419. <strong>ESC_CHAR</strong>, like this:
    1420. 

  1420. <p>
    1421. 

  1421. <pre>
    1422. 

  1422. 	.ESC_CHAR c
    1423. 

  1423. </pre>
    1424. 

  1424. 

  1425. where &quot;c&quot;, above, is the alternate escape character
    1426. 

  1426. (which should be a character that does not appear in the code).  To
    1427. 

  1427. set the escape character back to the backslash, simply invoke
    1428. 

  1428. <strong>.ESC_CHAR</strong> by itself (i.e. with no argument).
    1429. 

  1429. <p>
    1430. 

  1430. Because <strong>mom</strong>, by default, sets the text after
    1431. 

  1431. <strong>.QUOTE</strong> in italic (for <strong>PRINTSTYLE
    1432. 

  1432. TYPESET</strong>) or underlined (for <strong>PRINTSTYLE
    1433. 

  1433. TYPEWRITE</strong>), you'll want to change that behaviour as
    1434. 

  1434. well.  Therefore, a recipe for setting verbatim code snippets using
    1435. 

  1435. <strong>QUOTE</strong> could be (assuming you want a fixed width
    1436. 

  1436. font like Courier):
    1437. 

  1437. <p>
    1438. 

  1438. <pre>
    1439. 

  1439. 	\# You only need the first two lines before the first invocation
    1440. 

  1440. 	\# of QUOTE.  They stay in effect for all subsequent invocations.
    1441. 

  1441. 	\#
    1442. 

  1442. 	.QUOTE_FONT       CR    \" Set quote font to Courier roman
    1443. 

  1443. 	.UNDERLINE_QUOTES OFF   \" Don't underline quotes in TYPEWRITE
    1444. 

  1444. 	.QUOTE
    1445. 

  1445. 	.ESC_CHAR ^             \" Change escape character to ^
    1446. 

  1446. 	&lt;code snippet&gt;
    1447. 

  1447. 	.ESC_CHAR               \" Restore escape character to \
    1448. 

  1448. 	.QUOTE OFF
    1449. 

  1449. 

  1450. </pre>
    1451. 

  1451. 

  1452. <!---QUOTE--->
    1453. 

  1453. 

  1454. <hr width="66%" align="left">
    1455. 

  1455. <p>
    1456. 

  1456. <a name="QUOTE">
    1457. 

  1457. 	<nobr>Macro: <strong>QUOTE</strong> toggle</nobr>
    1458. 

  1458. </a>
    1459. 

  1459. 

  1460. <p>
    1461. 

  1461. <strong>QUOTE</strong> is a toggle macro.  To begin a section of
    1462. 

  1462. quoted text, invoke it with no argument, then type in your quote.
    1463. 

  1463. When you're finished, invoke <strong>QUOTE</strong> with any
    1464. 

  1464. argument (e.g. OFF, END, X, Q...) to turn it off.  Example:
    1465. 

  1465. <p>
    1466. 

  1466. <pre>
    1467. 

  1467. 	.QUOTE
    1468. 

  1468. 	Nymphomaniacal Jill
    1469. 

  1469. 	Used a dynamite stick for a thrill
    1470. 

  1470. 	They found her vagina
    1471. 

  1471. 	In North Carolina
    1472. 

  1472. 	And bits of her tits in Brazil.
    1473. 

  1473. 	.QUOTE END
    1474. 

  1474. </pre>
    1475. 

  1475. 

  1476. <a name="QUOTE_CONTROL"><h3><u>Quote control macros</u></h3></a>
    1477. 

  1477. <ol>
    1478. 

  1478. 	<li><a href="#QUOTE_GENERAL">Family/font/size/leading/colour/indent</a>
    1479. 

  1479. 	<li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a>
    1480. 

  1480. 	<li><a href="#UNDERLINE_QUOTES">Underline quotes (typewrite only)</a>
    1481. 

  1481. 	<li><a href="#BREAK_QUOTE">Manually break a footnoted quote that crosses pages/columns</a>
    1482. 

  1482. </ol>
    1483. 

  1483. <p>
    1484. 

  1484. <a name="QUOTE_GENERAL"><h3><u>1. Family/font/size/colour/indent</u></h3></a>
    1485. 

  1485. <p>
    1486. 

  1486. See
    1487. 

  1487. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    1488. 

  1488. <p>
    1489. 

  1489. <pre>
    1490. 

  1490. .QUOTE_FAMILY   default = prevailing document family; default is Times Roman
    1491. 

  1491. .QUOTE_FONT     default = italic; underlined in TYPEWRITE
    1492. 

  1492. .QUOTE_SIZE     default = +0 (i.e. same size as paragraph text)
    1493. 

  1493. .QUOTE_AUTOLEAD default = none; leading of quotes is the same as paragraphs
    1494. 

  1494. .QUOTE_COLOR    default = black
    1495. 

  1495. <a name="QUOTE_INDENT">.QUOTE_INDENT   default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
    1496. 

  1496.                (note that this macro also sets the indents (left and right)
    1497. 

  1497.                 for blockquotes)
    1498. 

  1498. </pre>
    1499. 

  1499. 

  1500. <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
    1501. 

  1501. <p>
    1502. 

  1502. If you'd like <strong>mom</strong> always to put a full linespace above
    1503. 

  1503. and below quotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
    1504. 

  1504. with no argument.  If you wish to restore <strong>mom</strong>'s
    1505. 

  1505. default behaviour regarding the spacing of quotes (see
    1506. 

  1506. <a href="#QUOTE_SPACING">above</a>),
    1507. 

  1507. invoke the macro with any argument (<strong>OFF, QUIT, END,
    1508. 

  1508. X</strong>...)
    1509. 

  1509. <p>
    1510. 

  1510. <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
    1511. 

  1511. spacing policy for
    1512. 

  1512. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>.
    1513. 

  1513. <p>
    1514. 

  1514. 

  1515. <a name="UNDERLINE_QUOTES"><h3><u>3. Underlining -- UNDERLINE_QUOTES (typewrite only)</u></h3></a>
    1516. 

  1516. <p>
    1517. 

  1517. By default in
    1518. 

  1518. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    1519. 

  1519. <strong>mom</strong> underlines quotes.  If you'd rather she didn't,
    1520. 

  1520. invoke <strong>.UNDERLINE_QUOTES</strong> with any argument
    1521. 

  1521. (<strong>OFF, QUIT, END, X</strong>...) to disable the feature.
    1522. 

  1522. Invoke it without an argument to restore <strong>mom</strong>'s
    1523. 

  1523. default underlining of quotes.
    1524. 

  1524. <p>
    1525. 

  1525. If you not only wish that <strong>mom</strong> not underline
    1526. 

  1526. quotes, but also that she set them in italic, you must follow each
    1527. 

  1527. instance of <strong>QUOTE</strong> with the typesetting macro <a
    1528. 

  1528. href="typesetting.html#FONT">FT I</a>.
    1529. 

  1529. Furthermore, since <strong>mom</strong> underlines all instances
    1530. 

  1530. of italics by default in <strong>PRINTSTYLE TYPEWRITE</strong>,
    1531. 

  1531. you must also make sure that <strong>ITALIC_MEANS_ITALIC</strong>
    1532. 

  1532. is enabled (see
    1533. 

  1533. <a href="docprocessing.html#TYPEWRITE_CONTROL">PRINTSTYLE TYPEWRITE control macros</a>).
    1534. 

  1534. <p>
    1535. 

  1535. 

  1536. <a name="BREAK_QUOTE"><h3><u>4. Manually break a footnoted quote -- BREAK_QUOTE</u></h3></a>
    1537. 

  1537. <p>
    1538. 

  1538. <strong>NOTE:</strong> <em>As of version 1.1.9, the macro</em>
    1539. 

  1539. <strong>BREAK_QUOTE</strong> <em>has become obsolete (or, at least,
    1540. 

  1540. should have become obsolete.)  It remains here for backward
    1541. 

  1541. compatibility with documents created prior to 1.1.9, and just in
    1542. 

  1542. case, despite my efforts to make it obsolete, you still encounter the
    1543. 

  1543. problem it's supposed to fix.  Should you find yourself having to
    1544. 

  1544. use</em> <strong>BREAK_QUOTE</strong> <em>while running</em> <strong>mom</strong>
    1545. 

  1545. 1.1.9 <em>or higher, please notify me immediately.</em>
    1546. 

  1546. 

  1547. <p>
    1548. 

  1548. Exceptionally, a quote or blockquote containing a footnote may cross
    1549. 

  1549. a page or column.  When this happens, the footnote marker may not be
    1550. 

  1550. correct for its position relative to other footnotes on the page, and
    1551. 

  1551. the footnote itself may appear on the wrong page or at the bottom of
    1552. 

  1552. the wrong column.  When this happens, study your output to determine
    1553. 

  1553. the precise point at which the quote breaks (or at which you want
    1554. 

  1554. it to break), and add <code>.BREAK_QUOTE</code> on a line by itself
    1555. 

  1555. afterwards.  No other intervention is required, and the footnote(s)
    1556. 

  1556. will be marked correctly and appear on the correct page.
    1557. 

  1557. <p>
    1558. 

  1558. <strong>BREAK_QUOTE</strong> may be used with both quotes and
    1559. 

  1559. blockquotes, and hence is aliased as <strong>BREAK_BLOCKQUOTE,
    1560. 

  1560. BREAK_CITATION</strong> and <strong>BREAK_CITE</strong>.
    1561. 

  1561. <p>
    1562. 

  1562. <hr>
    1563. 

  1563. 

  1564. <!====================================================================>
    1565. 

  1565. 

  1566. <a name="BLOCKQUOTE_INTRO"><h2><u>Blockquotes (cited passages)</u></h2></a>
    1567. 

  1567. <ul>
    1568. 

  1568. 	<li><a href="#BLOCKQUOTE">Tag: BLOCKQUOTE (aliases: CITE, CITATION)</a>
    1569. 

  1569. 	<li><a href="#BLOCKQUOTE_CONTROL">BLOCKQUOTE control macros</a>
    1570. 

  1570. </ul>
    1571. 

  1571. <p>
    1572. 

  1572. <strong>BLOCKQUOTES</strong> are used to cite passages from another
    1573. 

  1573. author's work.  So that they stand out well from
    1574. 

  1574. <a href="definitions.html#TERMS_RUNNING">running text</a>,
    1575. 

  1575. <strong>mom</strong> indents them from both the left and right margins
    1576. 

  1576. and sets them in a different point size
    1577. 

  1577. <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET</a>
    1578. 

  1578. only).
    1579. 

  1579. <a href="definitions.html#TERMS_OUTPUTLINE">Output lines</a>
    1580. 

  1580. are
    1581. 

  1581. <a href="definitions.html#TERMS_FILLED">filled</a>,
    1582. 

  1582. and, by default,
    1583. 

  1583. <a href="definitions.html#TERMS_QUAD">quadded</a>
    1584. 

  1584. left.
    1585. 

  1585. <p>
    1586. 

  1586. Besides indenting blockquotes, <strong>mom</strong> further sets them
    1587. 

  1587. off from running text with a small amount of vertical whitespace top
    1588. 

  1588. and bottom.  (See
    1589. 

  1589. <a href="#QUOTE_SPACING">above</a>
    1590. 

  1590. for a complete explanation of how this is managed, and how to control it.
    1591. 

  1591. Be sure to read the section <strong>Version 1.3</strong>.)
    1592. 

  1592. <p>
    1593. 

  1593. 

  1594. <!---BLOCKQUOTE--->
    1595. 

  1595. 

  1596. <hr width="66%" align="left">
    1597. 

  1597. <p>
    1598. 

  1598. <a name="BLOCKQUOTE">
    1599. 

  1599. 	<nobr>Macro: <strong>BLOCKQUOTE</strong> toggle</nobr>
    1600. 

  1600. 	<br>
    1601. 

  1601. 	Aliases: <strong>CITE, CITATION</strong>
    1602. 

  1602. </a>
    1603. 

  1603. 

  1604. <p>
    1605. 

  1605. <strong>BLOCKQUOTE</strong> is a toggle macro.  To begin a
    1606. 

  1606. cited passage, invoke the tag with no argument, then type in your quote.
    1607. 

  1607. When you're finished, invoke <strong>BLOCKQUOTE</strong> with any
    1608. 

  1608. argument (e.g. OFF, END, X, Q...) to turn it off.  Example:
    1609. 

  1609. <p>
    1610. 

  1610. <pre>
    1611. 

  1611. 	.BLOCKQUOTE
    1612. 

  1612. 	Redefining the role of the United States from enablers to keep
    1613. 

  1613. 	the peace to enablers to keep the peace from peacekeepers is
    1614. 

  1614. 	going to be an assignment.
    1615. 

  1615. 	.RIGHT
    1616. 

  1616. 	\(emGeorge W. Bush
    1617. 

  1617. 	.BLOCKQUOTE END
    1618. 

  1618. </pre>
    1619. 

  1619. 

  1620. If the cited passage runs to more than one paragraph, you MUST
    1621. 

  1621. introduce each paragraph -- <em>including the first!</em> --
    1622. 

  1622. with
    1623. 

  1623. <a href="#PP">PP</a>.
    1624. 

  1624. <p>
    1625. 

  1625. <strong>NOTE:</strong> The aliases <strong>CITE</strong>
    1626. 

  1626. and <strong>CITATION</strong> may be used in place of the
    1627. 

  1627. <strong>BLOCKQUOTE</strong> tag, as well as in any of the control
    1628. 

  1628. macros that begin with <strong>BLOCKQUOTE_</strong> or end with
    1629. 

  1629. <strong>_BLOCKQUOTE</strong>.
    1630. 

  1630. 

  1631. <a name="BLOCKQUOTE_CONTROL"><h3><u>Blockquote control macros</u></h3></a>
    1632. 

  1632. <ol>
    1633. 

  1633. 	<li><a href="#BLOCKQUOTE_GENERAL">Family/font/size/leading/colour/quad/indent</a>
    1634. 

  1634. 	<li><a href="#ALWAYS_FULLSPACE_QUOTES">Spacing above and below (typeset only)</a>
    1635. 

  1635. 	<li><a href="#BREAK_QUOTE">Manually break a footnoted blockquote that crosses pages/columns</a>
    1636. 

  1636. </ol>
    1637. 

  1637. <p>
    1638. 

  1638. <a name="BLOCKQUOTE_GENERAL"><h3><u>1. Family/font/size/colour/quad/indent</u></h3></a>
    1639. 

  1639. <p>
    1640. 

  1640. See
    1641. 

  1641. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    1642. 

  1642. <p>
    1643. 

  1643. <pre>
    1644. 

  1644. .BLOCKQUOTE_FAMILY   default = prevailing document family; default is Times Roman
    1645. 

  1645. .BLOCKQUOTE_FONT     default = roman
    1646. 

  1646. .BLOCKQUOTE_SIZE     default = -1 (point)
    1647. 

  1647. .BLOCKQUOTE_AUTOLEAD default = none; leading of blockquotes is the same as paragraphs
    1648. 

  1648. .BLOCKQUOTE_COLOR    default = black
    1649. 

  1649. .BLOCKQUOTE_QUAD     default = left
    1650. 

  1650. .BLOCKQUOTE_INDENT   default = paragraph indent x 3 (typeset); x 2 (typewrite)</a>
    1651. 

  1651.                     (note that this macro also sets the left indent for quotes)
    1652. 

  1652. </pre>
    1653. 

  1653. 

  1654. <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a>
    1655. 

  1655. <p>
    1656. 

  1656. If you'd like <strong>mom</strong> always to put a full linespace above
    1657. 

  1657. and below blockquotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong>
    1658. 

  1658. with no argument.  If you wish to restore <strong>mom</strong>'s
    1659. 

  1659. default behaviour regarding the spacing of blockquotes (see
    1660. 

  1660. <a href="#QUOTE_SPACING">above</a>),
    1661. 

  1661. invoke the macro with any argument (<strong>OFF, QUIT, END,
    1662. 

  1662. X</strong>...).
    1663. 

  1663. <p>
    1664. 

  1664. <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s
    1665. 

  1665. spacing policy for
    1666. 

  1666. <a href="#QUOTE_INTRO">quotes</a>.
    1667. 

  1667. <p>
    1668. 

  1668. <hr>
    1669. 

  1669. 

  1670. <!====================================================================>
    1671. 

  1671. 

  1672. <a name="LIST_INTRO"><h2><u>Nested lists</u></h2></a>
    1673. 

  1673. <ul>
    1674. 

  1674. 	<li><a href="#LIST">Tag: LIST</a>
    1675. 

  1675. 	<li><a href="#ITEM">Tag: ITEM</a>
    1676. 

  1676. 	<li><a href="#LIST_CONTROL">LIST control macros</a>
    1677. 

  1677. </ul>
    1678. 

  1678. <p>
    1679. 

  1679. Lists are points or items of interest or importance that are
    1680. 

  1680. separated from
    1681. 

  1681. <a href="definitions.html#TERMS_RUNNING">running text</a>
    1682. 

  1682. by enumerators.  Some typical enumerators are
    1683. 

  1683. <a href="definitions.html#TERMS_EM">en-dashes</a>,
    1684. 

  1684. <a href="definitions.html#TERMS_BULLET">bullets</a>,
    1685. 

  1685. digits and letters.
    1686. 

  1686. <p>
    1687. 

  1687. Setting lists with <strong>mom</strong> is easy.  First, you
    1688. 

  1688. initialize a list with the <strong>LIST</strong> macro.  Then, for
    1689. 

  1689. every item in the list, you invoke the macro, <strong>ITEM</strong>,
    1690. 

  1690. followed by the text of the item.  When a list is finished, you
    1691. 

  1691. exit the list with <strong>LIST OFF</strong> (or
    1692. 

  1692. <strong>QUIT</strong>, <strong>END</strong>, <strong>BACK</strong>,
    1693. 

  1693. etc.)
    1694. 

  1694. <p>
    1695. 

  1695. By default <strong>mom</strong> starts each list with the enumerator
    1696. 

  1696. flush with the left margin of running text that comes before it,
    1697. 

  1697. like this:
    1698. 

  1698. <p>
    1699. 

  1699. <pre>
    1700. 

  1700. 	My daily schedule needs organizing.  I can't
    1701. 

  1701. 	seem to get everything done I want.
    1702. 

  1702. 	o an hour's worth of exercise
    1703. 

  1703. 	o time to prepare at least one healthy
    1704. 

  1704. 	  meal per day
    1705. 

  1705. 	o reading time
    1706. 

  1706. 	o work on mom
    1707. 

  1707. 	o writing
    1708. 

  1708. 	  - changes from publisher
    1709. 

  1709. 	  - current novel
    1710. 

  1710. 	o a couple of hours at the piano
    1711. 

  1711. </pre>
    1712. 

  1712. 

  1713. In other words, <strong>mom</strong> does not, by default, indent
    1714. 

  1714. entire lists.  Indenting a list is controlled by the macro,
    1715. 

  1715. <a href="#SHIFT_LIST">SHIFT_LIST</a>.
    1716. 

  1716. (This is a design decision; there are too many instances where a
    1717. 

  1717. default indent is not desirable.)  Equally, <strong>mom</strong>
    1718. 

  1718. does not add any extra space above or below lists.
    1719. 

  1719. <p>
    1720. 

  1720. Lists can be nested (as in the example above).  In other words, you
    1721. 

  1721. can set lists within lists, each with an enumerator (and possibly,
    1722. 

  1722. indent) of your choosing.  In nested lists, each invocation of
    1723. 

  1723. <strong>LIST OFF</strong> (you may prefer to use <strong>LIST
    1724. 

  1724. BACK</strong>) takes you back to the previous depth (or
    1725. 

  1725. level) of list, with that list's enumerator and indent intact.  The
    1726. 

  1726. final <strong>LIST OFF</strong> exits lists completely and returns
    1727. 

  1727. you to the left margin of running text.
    1728. 

  1728. <p>
    1729. 

  1729. Finally, lists can be used in documents created with either the
    1730. 

  1730. document processing macros or just the typesetting macros.
    1731. 

  1731. <p>
    1732. 

  1732. 

  1733. <!---LIST--->
    1734. 

  1734. 

  1735. <hr width="66%" align="left">
    1736. 

  1736. <p>
    1737. 

  1737. <a name="LIST">
    1738. 

  1738. 	<nobr>Macro: <strong>LIST</strong> [ BULLET | DASH | DIGIT | ALPHA | alpha | ROMAN&lt;n&gt; | roman&lt;n&gt; | USER &lt;string&gt;] [ &lt;separator&gt; | &lt;user-defined enumerator&gt; ] [ &lt;prefix&gt; ] [ &lt;off&gt; ]</a></nobr>
    1739. 

  1739. <p>
    1740. 

  1740. Invoked by itself (i.e. with no argument), <strong>LIST</strong>
    1741. 

  1741. initializes a list (with bullets as the default enumerator).
    1742. 

  1742. Afterwards, each block of input text preceded by
    1743. 

  1743. <a href="#ITEM">.ITEM</a>,
    1744. 

  1744. on a line by itself, is treated as a list item.
    1745. 

  1745. <p>
    1746. 

  1746. <strong>NOTE:</strong> Every time you invoke <strong>LIST</strong>
    1747. 

  1747. to start a list (as opposed to
    1748. 

  1748. <a href="#LIST_EXIT">exiting one</a>),
    1749. 

  1749. you must supply an enumerator (and optionally, a separator) for the
    1750. 

  1750. list, unless you want <strong>mom</strong>'s default enumerator,
    1751. 

  1751. which is a bullet.  Within nested lists, <strong>mom</strong>
    1752. 

  1752. stores the enumerator, separator and indent for any list you return
    1753. 

  1753. <em>backwards</em> to (i.e. with <strong>LIST OFF</strong>), but
    1754. 

  1754. does not store any information for lists you move <em>forward</em>
    1755. 

  1755. to.
    1756. 

  1756. <br>
    1757. 

  1757. 

  1758. <h3><u>The first argument--enumerator style</u></h3>
    1759. 

  1759. <p>
    1760. 

  1760. The optional arguments <strong>BULLET</strong>,
    1761. 

  1761. <strong>DASH</strong>, <strong>DIGIT</strong> (for
    1762. 

  1762. Arabic numerals), <strong>ALPHA</strong> (for uppercase
    1763. 

  1763. letters), <strong>alpha</strong> (for lowercase letters),
    1764. 

  1764. <strong>ROMAN&lt;n&gt;</strong> (for uppercase roman numerals),
    1765. 

  1765. <strong>roman&lt;n&gt;</strong> (for lowercase roman numerals) tell
    1766. 

  1766. <strong>mom</strong> what kind of enumerator to use for a given
    1767. 

  1767. list.
    1768. 

  1768. <p>
    1769. 

  1769. The arguments, <strong>ROMAN&lt;n&gt;</strong> and
    1770. 

  1770. <strong>roman&lt;n&gt;</strong>, are special.  You must append to
    1771. 

  1771. them a digit (arabic, e.g.  "1" or "9" or "17") saying how many items
    1772. 

  1772. a particular roman-numeralled <strong>LIST</strong> is going to
    1773. 

  1773. have. <strong>Mom</strong> requires this information in order to
    1774. 

  1774. align roman numerals sensibly, and will abort--with a message--if
    1775. 

  1775. you don't provide it.
    1776. 

  1776. <p>
    1777. 

  1777. A roman-numeralled list containing, say, five items, would be set
    1778. 

  1778. up like this:
    1779. 

  1779. <p>
    1780. 

  1780. <pre>
    1781. 

  1781. 	.LIST roman5        producing        i)   Item 1.
    1782. 

  1782. 	.ITEM                                ii)  Item 2.
    1783. 

  1783. 	Item 1.                              iii) Item 3.
    1784. 

  1784. 	.ITEM                                iv)  Item 4.
    1785. 

  1785. 	Item 2.                              v)   Item 5.
    1786. 

  1786. 	.ITEM
    1787. 

  1787. 	Item 3
    1788. 

  1788. 	.ITEM
    1789. 

  1789. 	Item 4
    1790. 

  1790. 	.ITEM
    1791. 

  1791. 	Item 5
    1792. 

  1792. </pre>
    1793. 

  1793. 

  1794. <p>
    1795. 

  1795. The argument, <strong>USER</strong>, lets you make up your own
    1796. 

  1796. enumerator, and must be followed by a second argument: what you'd
    1797. 

  1797. like the enumerator to look like.  For example, if you want a list
    1798. 

  1798. enumerated with
    1799. 

  1799. <strong>=&gt;</strong>,
    1800. 

  1800. <p>
    1801. 

  1801. <pre>
    1802. 

  1802. 	.LIST USER =&gt;
    1803. 

  1803. 	.ITEM
    1804. 

  1804. 	A list item
    1805. 

  1805. </pre>
    1806. 

  1806. 

  1807. will produce
    1808. 

  1808. <p>
    1809. 

  1809. <pre>
    1810. 

  1810. 	=&gt; A list item
    1811. 

  1811. </pre>
    1812. 

  1812. 

  1813. <strong>Please note:</strong> if the argument to
    1814. 

  1814. <strong>USER</strong> contains spaces, you must enclose the argument
    1815. 

  1815. in double quotes.
    1816. 

  1816. 

  1817. <br>
    1818. 

  1818. 

  1819. <h3><u>The second argument--separator style</u></h3>
    1820. 

  1820. <p>
    1821. 

  1821. If you choose <strong>DIGIT</strong>, <strong>ALPHA</strong>,
    1822. 

  1822. <strong>alpha</strong>, <strong>ROMAN&lt;n&gt;</strong>, or
    1823. 

  1823. <strong>roman&lt;n&gt;</strong>, you may enter the optional
    1824. 

  1824. argument, <strong>separator</strong>, to say what kind of separator
    1825. 

  1825. you want after the enumerator.  The separator can be anything you
    1826. 

  1826. like.  The default for <strong>DIGIT</strong> is a period (dot),
    1827. 

  1827. like this:
    1828. 

  1828. <p>
    1829. 

  1829. <pre>
    1830. 

  1830. 	1. A list item
    1831. 

  1831. </pre>
    1832. 

  1832. 

  1833. The default separator for <strong>ALPHA</strong>,
    1834. 

  1834. <strong>alpha</strong>, <strong>ROMAN&lt;n&gt;</strong> and
    1835. 

  1835. <strong>roman&lt;n&gt;</strong> is a right parenthesis, like this:
    1836. 

  1836. <p>
    1837. 

  1837. <pre>
    1838. 

  1838. 	a) An alpha-ed list item
    1839. 

  1839. 	b) A second alpha-ed list item
    1840. 

  1840. 

  1841. 	   or
    1842. 

  1842. 

  1843. 	i)  A roman-ed list item
    1844. 

  1844. 	ii) A second roman-ed item
    1845. 

  1845. </pre>
    1846. 

  1846. 

  1847. If you'd prefer, say, digits with right-parenthesis separators
    1848. 

  1848. instead of the default period, you'd do
    1849. 

  1849. <p>
    1850. 

  1850. <pre>
    1851. 

  1851. 	.LIST DIGIT )
    1852. 

  1852. 	.ITEM
    1853. 

  1853. 	A numberd list item
    1854. 

  1854. </pre>
    1855. 

  1855. 

  1856. which would produce
    1857. 

  1857. <p>
    1858. 

  1858. <pre>
    1859. 

  1859. 	1) A numbered list item
    1860. 

  1860. </pre>
    1861. 

  1861. 

  1862. <strong>Please note: BULLET</strong>, <strong>DASH</strong> and
    1863. 

  1863. <strong>USER</strong> do not take a separator.
    1864. 

  1864. <br>
    1865. 

  1865. 

  1866. <h3><u>The third argument--prefix style</u></h3>
    1867. 

  1867. <p>
    1868. 

  1868. Additionally, you may give a prefix (i.e. a character that comes
    1869. 

  1869. <em>before</em> the enumerator) when your enumerator style for a
    1870. 

  1870. particular list is <strong>DIGIT</strong>, <strong>ALPHA</strong>,
    1871. 

  1871. <strong>alpha</strong>, <strong>ROMAN&lt;n&gt;</strong>
    1872. 

  1872. or <strong>roman&lt;n&gt;</strong>.  In the arguments to
    1873. 

  1873. <strong>LIST</strong>, the prefix comes <em>after</em> the
    1874. 

  1874. separator, which may seem counter-intuitive, so please be careful.
    1875. 

  1875. <p>
    1876. 

  1876. A prefix can be anything you like.  Most likely, you'll want some
    1877. 

  1877. kind of open-bracket, such as a left parenthesis.  If, for example,
    1878. 

  1878. you want a <strong>DIGIT</strong> list with the numbers enclosed in
    1879. 

  1879. parentheses, you'd enter
    1880. 

  1880. <p>
    1881. 

  1881. <pre>
    1882. 

  1882. 	.LIST DIGIT ) (
    1883. 

  1883. 	.ITEM
    1884. 

  1884. 	The first item on the list.
    1885. 

  1885. 	.ITEM
    1886. 

  1886. 	The second item on the list.
    1887. 

  1887. </pre>
    1888. 

  1888. 

  1889. which would produce 
    1890. 

  1890. <p>
    1891. 

  1891. <pre>
    1892. 

  1892. 	(1) The first item on the list.
    1893. 

  1893. 	(2) The second item on the list.
    1894. 

  1894. </pre>
    1895. 

  1895. 

  1896. <strong>Please note: BULLET</strong>, <strong>DASH</strong> and
    1897. 

  1897. <strong>USER</strong> do not take a prefix.
    1898. 

  1898. <br>
    1899. 

  1899. 

  1900. <a name="LIST_EXIT"></a>
    1901. 

  1901. <h3><u>Exiting lists--.LIST OFF/BACK or .QUIT_LISTS</u></h3>
    1902. 

  1902. <p>
    1903. 

  1903. Any single argument to <strong>LIST</strong> other
    1904. 

  1904. than <strong>BULLET</strong>, <strong>DASH</strong>,
    1905. 

  1905. <strong>DIGIT</strong>, <strong>ALPHA</strong>,
    1906. 

  1906. <strong>alpha</strong>, <strong>ROMAN&lt;n&gt;</strong>,
    1907. 

  1907. <strong>roman&lt;n&gt;</strong> or <strong>USER</strong> (e.g.
    1908. 

  1908. <strong>LIST</strong> <kbd>OFF</kbd> or <strong>LIST</strong>
    1909. 

  1909. <kbd>BACK</kbd>) takes you out of the current list.
    1910. 

  1910. <p>
    1911. 

  1911. If you are at the first list-level (or "list-depth"),
    1912. 

  1912. <strong>mom</strong> returns you to the left margin of running text.
    1913. 

  1913. Any indents that were in effect prior to setting the list are fully
    1914. 

  1914. restored.
    1915. 

  1915. <p>
    1916. 

  1916. If you are in a nested list, <strong>mom</strong> moves you
    1917. 

  1917. <em>back one list-level</em> (i.e. does not take you out of the
    1918. 

  1918. list structure) and restores the enumerator, separator and indent
    1919. 

  1919. appropriate to that level.
    1920. 

  1920. <p>
    1921. 

  1921. Each invocation of <strong>LIST</strong> should be be matched by
    1922. 

  1922. a corresponding <strong>LIST OFF</strong> in order to fully exit
    1923. 

  1923. lists.  For example,
    1924. 

  1924. <p>
    1925. 

  1925. <pre>
    1926. 

  1926. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    1927. 

  1927. 	sed diam nonumy eirmod tempor invidunt ut labore.
    1928. 

  1928. 	o List item in level 1
    1929. 

  1929. 	o List item in level 1
    1930. 

  1930. 	  - List item in level 2
    1931. 

  1931. 	  - List item in level 2
    1932. 

  1932. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    1933. 

  1933. 	sed diam nonumy eirmod tempor invidunt ut labore.
    1934. 

  1934. </pre>
    1935. 

  1935. 

  1936. is created like this:
    1937. 

  1937. <p>
    1938. 

  1938. <pre>
    1939. 

  1939. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    1940. 

  1940. 	sed diam nonumy eirmod tempor invidunt ut labore.
    1941. 

  1941. 	.LIST BULLET
    1942. 

  1942. 	.ITEM
    1943. 

  1943. 	List item in level 1
    1944. 

  1944. 	.ITEM
    1945. 

  1945. 	List item in level 1
    1946. 

  1946. 	.LIST DASH
    1947. 

  1947. 	.ITEM
    1948. 

  1948. 	List item in level 2
    1949. 

  1949. 	.ITEM
    1950. 

  1950. 	List item in level 2
    1951. 

  1951. 	.LIST OFF    \" Turn level 2 list off
    1952. 

  1952. 	.LIST OFF    \" Turn level 1 list off
    1953. 

  1953. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    1954. 

  1954. 	sed diam nonumy eirmod tempor invidunt ut labore.
    1955. 

  1955. </pre>
    1956. 

  1956. 

  1957. Alternatively, you may use the single-purpose macro,
    1958. 

  1958. <strong>QUIT_LISTS</strong>, to get yourself out of a list
    1959. 

  1959. structure.  In the example above, the two <kbd>.LIST OFF</kbd>
    1960. 

  1960. lines could be replaced with a single <kbd>.QUIT_LISTS</kbd>.
    1961. 

  1961. <p>
    1962. 

  1962. 

  1963. <hr width="33%" align="left">
    1964. 

  1964. <p>
    1965. 

  1965. <a name="ITEM">
    1966. 

  1966. 	Macro: <strong>ITEM</strong>
    1967. 

  1967. <p>
    1968. 

  1968. After you've initialized a list with
    1969. 

  1969. <a href="#LIST">LIST</a>,
    1970. 

  1970. precede each item you want in the list with <strong>ITEM</strong>.
    1971. 

  1971. <strong>Mom</strong> takes care of everything else with respect to
    1972. 

  1972. setting the item appropriate to the list you're in.
    1973. 

  1973. <p>
    1974. 

  1974. In document processing, it is legal to have list items that contain
    1975. 

  1975. multiple paragraphs.  Simply issue a
    1976. 

  1976. <a href="#PP">PP</a>
    1977. 

  1977. request for each paragraph <em>following</em> the first item.
    1978. 

  1978. I.e., don't do this:
    1979. 

  1979. <p>
    1980. 

  1980. <pre>
    1981. 

  1981. 	.ITEM
    1982. 

  1982. 	.PP
    1983. 

  1983. 	Some text...
    1984. 

  1984. 	.PP
    1985. 

  1985. 	A second paragraph of text
    1986. 

  1986. </pre>
    1987. 

  1987. 

  1988. but rather
    1989. 

  1989. <p>
    1990. 

  1990. <pre>
    1991. 

  1991. 	.ITEM
    1992. 

  1992. 	Some text...
    1993. 

  1993. 	.PP
    1994. 

  1994. 	A second paragraph of text
    1995. 

  1995. </pre>
    1996. 

  1996. <hr width="33%" align="left">
    1997. 

  1997. 

  1998. <a name="LIST_CONTROL"><h3><u>List control macros</u></h3></a>
    1999. 

  1999. <ol>
    2000. 

  2000. 	<li><a href="#SHIFT_LIST">Indenting lists (SHIFT_LIST)</a>
    2001. 

  2001. 	<li><a href="#RESET_LIST">Resetting an initialized list's enumerator (RESET_LIST)</a>
    2002. 

  2002. 	<li><a href="#PAD_LIST_DIGITS">Padding digit enumerators (PAD_LIST_DIGITS)</a>
    2003. 

  2003. </ol>
    2004. 

  2004. 

  2005. <a name="SHIFT_LIST"><h3><u>1. Indenting lists -- SHIFT_LIST</u></h3></a>
    2006. 

  2006. <p>
    2007. 

  2007. If you want a list to be indented to the right of running text, or
    2008. 

  2008. indented to the right of a current list, use the macro
    2009. 

  2009. <strong>SHIFT_LIST</strong> immediately after
    2010. 

  2010. <a href="#LIST">LIST</a>.
    2011. 

  2011. <strong>SHIFT_LIST</strong> takes just one argument: the amount by
    2012. 

  2012. which you want the list shifted to the right.  The argument requires
    2013. 

  2013. a
    2014. 

  2014. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
    2015. 

  2015. <p>
    2016. 

  2016. <strong>SHIFT_LIST</strong> applies <em>only</em> to the list you
    2017. 

  2017. just initialized with <strong>LIST</strong>.  It does not carry
    2018. 

  2018. over from one invocation of <strong>LIST</strong> to the next.
    2019. 

  2019. However, the indent remains in effect when you <em>return</em> to a
    2020. 

  2020. list level in a nested list.
    2021. 

  2021. <p>
    2022. 

  2022. For example, if you want a 2-level list, with each list indented to
    2023. 

  2023. the right by 18
    2024. 

  2024. <a href="definitions.html#TERMS_PICASPOINTS">points</a>,
    2025. 

  2025. <p>
    2026. 

  2026. <pre>
    2027. 

  2027. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    2028. 

  2028. 	sed diam nonumy eirmod tempor invidunt ut labore.
    2029. 

  2029. 	.LIST           \" List 1
    2030. 

  2030. 	.SHIFT_LIST 18p \" Indent 18 points right of running text
    2031. 

  2031. 	.ITEM
    2032. 

  2032. 	List 1 item
    2033. 

  2033. 	.ITEM
    2034. 

  2034. 	List 1 item
    2035. 

  2035. 	.LIST DASH      \" List 2
    2036. 

  2036. 	.SHIFT_LIST 18p \" Indent 18 points right of list 1
    2037. 

  2037. 	.ITEM
    2038. 

  2038. 	List 2 item
    2039. 

  2039. 	.ITEM
    2040. 

  2040. 	List 2 item
    2041. 

  2041. 	.LIST OFF       \" Move back to list 1
    2042. 

  2042. 	.ITEM
    2043. 

  2043. 	List 1 item
    2044. 

  2044. 	.ITEM
    2045. 

  2045. 	List 1 item
    2046. 

  2046. 	.LIST OFF       \" Exit lists
    2047. 

  2047. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    2048. 

  2048. 	sed diam nonumy eirmod tempor invidunt ut labore.
    2049. 

  2049. </pre>
    2050. 

  2050. 

  2051. produces (approximately)
    2052. 

  2052. <p>
    2053. 

  2053. <pre>
    2054. 

  2054. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    2055. 

  2055. 	sed diam nonumy eirmod tempor invidunt ut labore.
    2056. 

  2056. 	    o List 1 item
    2057. 

  2057. 	    o List 1 item
    2058. 

  2058. 	        - List 2 item
    2059. 

  2059. 	        - List 2 item
    2060. 

  2060. 	    o List 1 item
    2061. 

  2061. 	    o List 1 item
    2062. 

  2062. 	Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    2063. 

  2063. 	sed diam nonumy eirmod tempor invidunt ut labore.
    2064. 

  2064. </pre>
    2065. 

  2065. 

  2066. <a name="RESET_LIST"><h3><u>2. Resetting an initialized list's enumerator -- RESET_LIST</u></h3></a>
    2067. 

  2067. <p>
    2068. 

  2068. In nested lists, if your choice of list enumerator for a given
    2069. 

  2069. level of list is <strong>DIGIT</strong>, <strong>ALPHA</strong>,
    2070. 

  2070. <strong>alpha</strong>, <strong>ROMAN</strong> or
    2071. 

  2071. <strong>roman</strong>, you may sometimes want to reset the list's
    2072. 

  2072. enumerator when you return to that list.  Consider the following:
    2073. 

  2073. <p>
    2074. 

  2074. <pre>
    2075. 

  2075. 	Things to do religiously each and every day:
    2076. 

  2076. 	1. Take care of the dog
    2077. 

  2077. 	   a) walk every day
    2078. 

  2078. 	   b) brush once a week
    2079. 

  2079. 	      - trim around the eyes every fourth brushing
    2080. 

  2080. 	      - don't forget to check nails
    2081. 

  2081. 	2. Feed the cat
    2082. 

  2082. 	   a) soft food on Mon., Wed. and Fri.
    2083. 

  2083. 	   b) dry food on Tues., Thurs. and Sat.
    2084. 

  2084. 	   c) canned tuna on Sunday
    2085. 

  2085. </pre>
    2086. 

  2086. 

  2087. Normally, within a nested list, when you return to an
    2088. 

  2088. incrementally-enumerated list, the enumerator continues incrementing
    2089. 

  2089. from where it left off.  That means, in the example above, the
    2090. 

  2090. normal state of affairs for the alpha'ed list under &quot;2.  Feed
    2091. 

  2091. the cat&quot; would be c), d) and e).  The solution, in such a case,
    2092. 

  2092. is simply to reset the enumerator --before <strong>ITEM</strong>!--
    2093. 

  2093. with the macro, <strong>RESET_LIST</strong>.
    2094. 

  2094. <p>
    2095. 

  2095. By default, with no argument, <strong>RESET_LIST</strong> resets the
    2096. 

  2096. enumerator to 1, A, a, I or i depending on the style of enumerator.
    2097. 

  2097. You may, if you wish, pass <strong>RESET_LISTS</strong> a numeric
    2098. 

  2098. argument representing the starting enumerator for the reset (if
    2099. 

  2099. different from "1"), although I can't at present think of a use for
    2100. 

  2100. this feature.
    2101. 

  2101. <p>
    2102. 

  2102. <a name="PAD_LIST_DIGITS"><h3><u>3. Padding digit enumerators (PAD_LIST_DIGITS)</a></u></h3></a>
    2103. 

  2103. <p>
    2104. 

  2104. <strong><u>Arabic digits</u></strong>
    2105. 

  2105. <p>
    2106. 

  2106. When your choice of enumerators is <strong>DIGIT</strong> AND the
    2107. 

  2107. number of items in the list exceeds nine (9), you have to make a
    2108. 

  2108. design decision: should <strong>mom</strong> leave room for the
    2109. 

  2109. extra numeral in two-numeral digits to the right or the left of
    2110. 

  2110. the single-numeral digits?
    2111. 

  2111. <p>
    2112. 

  2112. If you want the extra space to the right, invoke the macro,
    2113. 

  2113. <strong>.PAD_LIST_DIGITS</strong> (with no argument), after
    2114. 

  2114. <strong>LIST</strong> and before <strong>ITEM</strong>.  This will
    2115. 

  2115. produce something like
    2116. 

  2116. <p>
    2117. 

  2117. <pre>
    2118. 

  2118. 	8.  List item
    2119. 

  2119. 	9.  List item
    2120. 

  2120. 	10. List item
    2121. 

  2121. </pre>
    2122. 

  2122. 

  2123. If you want the extra space to the left, invoke
    2124. 

  2124. <strong>PAD_LIST_DIGITS</strong> with the single argument,
    2125. 

  2125. <strong>LEFT</strong>, which will produce
    2126. 

  2126. <p>
    2127. 

  2127. <pre>
    2128. 

  2128. 	 8. List item
    2129. 

  2129. 	 9. List item
    2130. 

  2130. 	10. List item
    2131. 

  2131. </pre>
    2132. 

  2132. 

  2133. Of course, if the number of items in the list is less than ten
    2134. 

  2134. (10), there's no need for <strong>PAD_LIST_DIGITS</strong>.
    2135. 

  2135. <p>
    2136. 

  2136. <strong><u>Roman numerals</u></strong>
    2137. 

  2137. <p>
    2138. 

  2138. By default, <strong>mom</strong> sets roman numerals in lists flush
    2139. 

  2139. left.  The <strong>&lt;n&gt;</strong> argument appended to
    2140. 

  2140. <strong>ROMAN&lt;n&gt;</strong> or <strong>roman&lt;n&gt;</strong>
    2141. 

  2141. allows her to calculate how much space to put after each numeral in
    2142. 

  2142. order to ensure that the text of items lines up properly.
    2143. 

  2143. <p>
    2144. 

  2144. If you'd like the roman numerals to line up flush right (i.e. be
    2145. 

  2145. padded "left"), simply invoke <strong>PAD_LIST_DIGITS</strong>
    2146. 

  2146. <kbd>LEFT</kbd> after <strong>LIST</strong> <kbd>ROMAN&lt;n&gt;</kbd>
    2147. 

  2147. or <strong>LIST</strong> <kbd>roman&lt;n&gt;</kbd> amd before
    2148. 

  2148. <strong>ITEM</strong>.
    2149. 

  2149. <p>
    2150. 

  2150. <hr>
    2151. 

  2151. 

  2152. <!---LINE NUMBERING--->
    2153. 

  2153. 

  2154. <a name="NUMBER_LINES_INTRO"><h2><u>Line numbering</u></h2></a>
    2155. 

  2155. <ul>
    2156. 

  2156. 	<li><a href="#NUMBER_LINES">Macro: NUMBER_LINES</a>
    2157. 

  2157. 	<li><a href="#NUMBER_LINES_CONTROL">Control macros</a> (for quotes and blockquotes)
    2158. 

  2158. </ul>
    2159. 

  2159. 

  2160. <p>
    2161. 

  2161. <strong>Mom</strong>'s line-numbering capabilities are not as flexible
    2162. 

  2162. as most of her other document processing macros.  The reason is
    2163. 

  2163. that groff's underlying line-numbering
    2164. 

  2164. <a href="definitions.html#TERMS_PRIMITIVEX">primitive</a>,
    2165. 

  2165. <kbd>.nm</kbd>, is, well...primtive.  It is not possible, for
    2166. 

  2166. example, to select a particular family or font for use exclusively
    2167. 

  2167. with line numbers.  Nor is it possible to set the
    2168. 

  2168. <a href="definitions.html#TERMS_GUTTER">gutter</a>
    2169. 

  2169. using any
    2170. 

  2170. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    2171. 

  2171. other than the
    2172. 

  2172. <a href="definitions.html#TERMS_FIGURESPACE">figure space</a>.
    2173. 

  2173. <p>
    2174. 

  2174. That said, when you turn line-numbering on, <strong>mom</strong>,
    2175. 

  2175. by default
    2176. 

  2176. <br>
    2177. 

  2177. <a name="NUMBER_LINES_DEFAULTS"></a>
    2178. 

  2178. <ul>
    2179. 

  2179.     <li>numbers every line of paragraph text; line-numbering is
    2180. 

  2180.         suspended for all other document processing tags (like
    2181. 

  2181.         docheaders, epigraphs, heads, subheads, etc.) and special
    2182. 

  2182.         pages (covers, endotes, bibliographies, etc.); be aware,
    2183. 

  2183.         though, that if you turn
    2184. 

  2184.         <a href="definitions.html#TERMS_DOCHEADER">docheaders</a>
    2185. 

  2185.     	off (with
    2186. 

  2186.     	<a href="docprocessing.html#DOCHEADER">DOCHEADER</a> <strong>OFF</strong>)
    2187. 

  2187.     	and create your own docheader, <strong>mom</strong>
    2188. 

  2188.     	<em>will</em> line-number your custom docheader
    2189. 

  2189.     <li>doesn't touch your line length; line numbers are hung
    2190. 

  2190.         outside your current left margin (as set with
    2191. 

  2191.         <a href="typesetting.html#L_MARGIN">L_MARGIN</a>,
    2192. 

  2192.         <a href="typesetting.html#PAGE">PAGE</a>
    2193. 

  2193.         or
    2194. 

  2194.         <a href="docprocessing.html#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a>),
    2195. 

  2195.         regardless of any indents that may be active
    2196. 

  2196.     <li>separates line numbers from running text by two
    2197. 

  2197.         <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>.
    2198. 

  2198. </ul>
    2199. 

  2199. <p>
    2200. 

  2200. Line numbering may be enabled and disabled for
    2201. 

  2201. <a href="#QUOTE">QUOTE</a>
    2202. 

  2202. and/or
    2203. 

  2203. <a href="#BLOCKQUOTE">BLOCKQUOTE</a>
    2204. 

  2204. in one of three styles.  See
    2205. 

  2205. <a href="#NUMBER_LINES_CONTROL">Line numbering control macros for quotes and blockquotes</a>.
    2206. 

  2206. <p>
    2207. 

  2207. The first time you invoke
    2208. 

  2208. <a href="#NUMBER_LINES">NUMBER_LINES</a>
    2209. 

  2209. you must, at a minimum, tell it what line number you want the
    2210. 

  2210. <em>next</em>
    2211. 

  2211. <a href="definitions.html#TERMS_OUTPUTLINE">output line</a>
    2212. 

  2212. to have.  Optional arguments allow you to state which lines should
    2213. 

  2213. be numbered (e.g. every five or every ten lines), and the gutter to
    2214. 

  2214. place between line numbers and
    2215. 

  2215. <a href="definitions.html#TERMS_RUNNING">running text</a>.
    2216. 

  2216. <p>
    2217. 

  2217. Subsequently, you can turn line-numbering off, either permanently,
    2218. 

  2218. or resume it later at a place of your choosing.  When you
    2219. 

  2219. resume line-numbering, the line numbers pick up where you left off.
    2220. 

  2220. <p>
    2221. 

  2221. 

  2222. <!---NUMBER_LINES--->
    2223. 

  2223. 

  2224. <hr width="66%" align="left">
    2225. 

  2225. <p>
    2226. 

  2226. <nobr>
    2227. 

  2227. <a name="NUMBER_LINES">
    2228. 

  2228. 	<nobr>Macro: <strong>NUMBER_LINES</strong> &lt;start number&gt; [ &lt;which lines to number&gt; [ &lt;gutter&gt; ] ]</nobr>
    2229. 

  2229.     <br>
    2230. 

  2230. 	<nobr>Macro: <strong>NUMBER_LINES</strong>  &lt;anything&gt; | RESUME</nobr>
    2231. 

  2231.     <br>
    2232. 

  2232. </a>
    2233. 

  2233. </nobr>
    2234. 

  2234. 

  2235. <p>
    2236. 

  2236. <strong>NUMBER_LINES</strong> does what it says: prints line
    2237. 

  2237. numbers, to the left of
    2238. 

  2238. <a href="definitions.html#TERMS_OUTPUTLINE">output lines</a>
    2239. 

  2239. of paragraph text.  One of the chief reasons for wanting numbered
    2240. 

  2240. lines is in order to identify footnotes or endnotes by line number
    2241. 

  2241. instead of by a marker in the text.  (See
    2242. 

  2242. <a href="#FOOTNOTE_LINENUMBERS">.FOOTNOTE_MARKER_STYLE LINE</a>
    2243. 

  2243. for instructions on line-numbered footnotes, and
    2244. 

  2244. <a href="#ENDNOTE_MARKER_STYLE">.ENDNOTE_MARKER_STYLE</a>
    2245. 

  2245. for instructions on line-numbered endnotes.)
    2246. 

  2246. <p>
    2247. 

  2247. Every time you invoke <strong>NUMBER_LINES</strong>, unless you are
    2248. 

  2248. using the arguments <strong>OFF</strong> (<strong>QUIT</strong>,
    2249. 

  2249. <strong>END</strong>, <strong>X</strong>, etc.) or
    2250. 

  2250. <strong>RESUME</strong> you must, at a minimum, pass it one
    2251. 

  2251. argument, namely the number (digit) you want the <em>next</em>
    2252. 

  2252. <a href="definitions.html#TERMS_OUTPUTLINE">output line</a>
    2253. 

  2253. to have.  For example,
    2254. 

  2254. <pre>
    2255. 

  2255. 	.NUMBER_LINES 3
    2256. 

  2256. </pre>
    2257. 

  2257. 

  2258. will prepend the number, 3, to the next output line.
    2259. 

  2259. <p>
    2260. 

  2260. Normally, of course, you will number lines of text starting at 1.
    2261. 

  2261. All you have to do in that case is ensure that
    2262. 

  2262. <pre>
    2263. 

  2263. 	.NUMBER_LINES 1
    2264. 

  2264. </pre>
    2265. 

  2265. 

  2266. precedes your first line of input text, which will also be the
    2267. 

  2267. first line of output text.
    2268. 

  2268. <p>
    2269. 

  2269. You can alter <strong>mom</strong>'s default line numbering
    2270. 

  2270. behaviour (see
    2271. 

  2271. <a href="#NUMBER_LINES_DEFAULT">above</a>)
    2272. 

  2272. with the optional arguments <strong>&lt;which lines to
    2273. 

  2273. number&gt;</strong> and <strong>&lt;gutter&gt;</strong>.
    2274. 

  2274. <p>
    2275. 

  2275. <strong>&lt;which lines to number&gt;</strong> instructs
    2276. 

  2276. <strong>NUMBER_LINES</strong> to number only certain lines, e.g.
    2277. 

  2277. every two lines or every five lines.  If you want, say, only every
    2278. 

  2278. five lines to have a prepended number, you'd do
    2279. 

  2279. <pre>
    2280. 

  2280. 	.NUMBER_LINES 1 5
    2281. 

  2281. </pre>
    2282. 

  2282. 

  2283. <strong>GOTCHA!</strong>  The argument to <strong>&lt;which
    2284. 

  2284. lines to number&gt;</strong> only numbers those lines that are
    2285. 

  2285. multiples of the argument.  Hence, in the above example, line
    2286. 

  2286. number "1" will <em>not</em> be numbered, since "1" is not a
    2287. 

  2287. multiple of "5".
    2288. 

  2288. <p>
    2289. 

  2289. If you wanted line number "1" to be numbered, you'd have to invoke
    2290. 

  2290. <kbd>.NUMBER_LINES 1 1</kbd> before the first output line, then
    2291. 

  2291. study your <em>output</em> copy and determine where best to insert
    2292. 

  2292. the following in your <em>input</em> copy:
    2293. 

  2293. <pre>
    2294. 

  2294. 	.NUMBER_LINES \n(ln 5
    2295. 

  2295. </pre>
    2296. 

  2296. 

  2297. (The escape, <kbd>\n(ln</kbd>, ensures that
    2298. 

  2298. <strong>NUMBER_LINES</strong> automatically supplies the correct
    2299. 

  2299. value for the first argument, <strong>&lt;start
    2300. 

  2300. number&gt;</strong>.)
    2301. 

  2301. <p>
    2302. 

  2302. Following this recipe, line number 1 will be numbered; subsequently,
    2303. 

  2303. only line numbers that are multiples of 5 will be numbered.  A
    2304. 

  2304. little experimentation may be required to determine the best place
    2305. 

  2305. for it.
    2306. 

  2306. <p>
    2307. 

  2307. The optional argument, <strong>&lt;gutter&gt;</strong>, tells
    2308. 

  2308. <strong>mom</strong> how much space to put between the line numbers
    2309. 

  2309. and the running text.
    2310. 

  2310. <p>
    2311. 

  2311. <strong>Note</strong>: when giving a value for
    2312. 

  2312. <strong>&lt;gutter&gt;</strong>, you cannot skip the
    2313. 

  2313. <strong>&lt;which lines to number&gt;</strong> argument.  Either
    2314. 

  2314. fill in the desired value, or use two double-quotes
    2315. 

  2315. (<strong>""</strong>) to have <strong>mom</strong> use the value
    2316. 

  2316. formerly in effect.
    2317. 

  2317. <p>
    2318. 

  2318. <strong>&lt;gutter&gt;</strong> does not require (or even accept) a
    2319. 

  2319. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    2320. 

  2320. The argument you pass to it is the number of
    2321. 

  2321. <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>
    2322. 

  2322. you want between line numbers and running text.
    2323. 

  2323. <strong>Mom</strong>'s default gutter is two figure spaces.  If
    2324. 

  2324. you'd like a wider gutter, say, four figures spaces, you'd do
    2325. 

  2325. <pre>
    2326. 

  2326. 	.NUMBER_LINES 1 1 4
    2327. 

  2327. 	                |
    2328. 

  2328. 	                +-- Notice you *must* supply a value
    2329. 

  2329. 	                    for the 2nd argument in order to supply
    2330. 

  2330. 	                    a value for the 3rd.
    2331. 

  2331. </pre>
    2332. 

  2332. 

  2333. <p>
    2334. 

  2334. After you've set up line-numbering, <strong>NUMBER_LINES</strong>
    2335. 

  2335. can be used to control line numbering.
    2336. 

  2336. <br>
    2337. 

  2337. <h3><u>Line-numbering control</u></h3>
    2338. 

  2338. <p>
    2339. 

  2339. <strong>NUMBER_LINES OFF</strong> (or <strong>END, QUIT, X,</strong> etc.)
    2340. 

  2340. turns line-numbering off.
    2341. 

  2341. <p>
    2342. 

  2342. Sometimes, you merely want to suspend line-numbering.  In that case,
    2343. 

  2343. turn line numbering off with <strong>NUMBER_LINES OFF</strong>.
    2344. 

  2344. Later, when you want it to resume, enter
    2345. 

  2345. <pre>
    2346. 

  2346. 	.NUMBER_LINES RESUME
    2347. 

  2347. </pre>
    2348. 

  2348. 

  2349. Line numbering will resume exactly where it left off.  If this is
    2350. 

  2350. not what you want--say you want to reset the line number to "1"--simply
    2351. 

  2351. invoke <strong>NUMBER_LINES</strong> with whatever arguments
    2352. 

  2352. are needed for the desired result.
    2353. 

  2353. <p>
    2354. 

  2354. <strong>Extra Notes:</strong>
    2355. 

  2355. <br>
    2356. 

  2356. <ol>
    2357. 

  2357.     <li>In document processing, you may invoke <strong>NUMBER_LINES</strong>
    2358. 

  2358.         either before or after <strong>START</strong>.
    2359. 

  2359.         <strong>Mom</strong> doesn't care.
    2360. 

  2360.     <li>If you're collating documents with
    2361. 

  2361.         <a href="rectoverso.html#COLLATE">COLLATE</a>,
    2362. 

  2362.         you should re-invoke, at a minimum, <kbd>.NUMBER_LINES
    2363. 

  2363.         1</kbd> for each collated document, in order to ensure that
    2364. 

  2364.         each begins with the number "1" prepended to the first line
    2365. 

  2365.         (unless, of course, that is not what you want).
    2366. 

  2366.     <li>Occasionally, you may want to change the current gutter
    2367. 

  2367.         between line numbers and running text without knowing
    2368. 

  2368.         what the next output line number should be.  Since
    2369. 

  2369.         <strong>NUMBER_LINES</strong> requires this number
    2370. 

  2370.         as its first argument, in such instances, pass
    2371. 

  2371.         <strong>NUMBER_LINES</strong> as its first argument the
    2372. 

  2372.         escape <kbd>\n(ln</kbd>.
    2373. 

  2373.         <p>
    2374. 

  2374.         For example, if you were numbering every 5 lines with a
    2375. 

  2375.         gutter of 2 (figure spaces) and you needed to change the
    2376. 

  2376.         gutter to 4 (figures spaces),
    2377. 

  2377.         <p>
    2378. 

  2378.         <kbd>&nbsp;&nbsp;&nbsp;&nbsp;.NUMBER_LINES \n(ln 5 4</kbd>
    2379. 

  2379.         <p>
    2380. 

  2380.         would do the trick.
    2381. 

  2381.     <li>If you're using margin notes in a document, be sure to set
    2382. 

  2382.         the gutter for margin notes wide enough to allow room for
    2383. 

  2383.         the line numbers.
    2384. 

  2384.     <li><strong>Mom</strong> (groff, actually), only numbers lines
    2385. 

  2385.         <em>to the left of text</em>.  For aesthetic reason,
    2386. 

  2386.         therefore, the use of line numbering when setting a document
    2387. 

  2387.         in columns is discouraged.  However, should you wish to
    2388. 

  2388.         number lines when setting in columns, make sure the
    2389. 

  2389.         <a href="definitions.html#TERMS_GUTTER">gutter(s)</a>
    2390. 

  2390.         between columns is wide enough to leave room for the
    2391. 

  2391.         numbers.
    2392. 

  2392. </ol>
    2393. 

  2393. <hr width="33%" align="left">
    2394. 

  2394. 

  2395. <a name="NUMBER_LINES_CONTROL"><h3><u>Line numbering control macros for QUOTE and BLOCKQUOTE</u></h3></a>
    2396. 

  2396. <ol>
    2397. 

  2397. 	<li><a href="#NUMBER_QUOTE_LINES">NUMBER_QUOTE_LINES</a>
    2398. 

  2398. 	<li><a href="#NUMBER_BLOCKQUOTE_LINES">NUMBER_BLOCKQUOTE_LINES</a>
    2399. 

  2399. 	<li><a href="#NUMBER_LINES_QUOTES">Setting up line numbering in quotes and blockquotes on a case by case basis</a>
    2400. 

  2400. </ol>
    2401. 

  2401. 

  2402. <a name="NUMBER_QUOTE_LINES"><h3><u>1. NUMBER_QUOTE_LINES</u></h3></a>
    2403. 

  2403. <p>
    2404. 

  2404. If you'd like <strong>mom</strong> to number lines of output text
    2405. 

  2405. in a
    2406. 

  2406. <a href="#QUOTE">QUOTE</a>
    2407. 

  2407. as part of the same order and sequence as paragraph text, simply
    2408. 

  2408. invoke <strong>NUMBER_QUOTE_LINES</strong> by itself.
    2409. 

  2409. <p>
    2410. 

  2410. There is a catch with numbering quotes, though.  Owing to groff's
    2411. 

  2411. restriction of accepting only the figure space as the line number
    2412. 

  2412. gutter's unit of measure, it is not possible for line numbers
    2413. 

  2413. in quotes to hang outside a document's overall left margin and
    2414. 

  2414. be reliably flush with the line numbers of paragraph text.
    2415. 

  2415. Conseqently, line numbers in quotes hang to the left of the quote,
    2416. 

  2416. separated from the quote by the <strong>&lt;gutter&gt;</strong>
    2417. 

  2417. argument.
    2418. 

  2418. <p>
    2419. 

  2419. If you'd like to change the gutter for quotes line-numbered in
    2420. 

  2420. this way, invoke <strong>NUMBER_QUOTE_LINES</strong> with a digit
    2421. 

  2421. representing the number of
    2422. 

  2422. <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>
    2423. 

  2423. you'd like between the line numbers and the quoted text, like this:
    2424. 

  2424. <pre>
    2425. 

  2425. 	.NUMBER_QUOTE_LINES 1
    2426. 

  2426. </pre>
    2427. 

  2427. 

  2428. With the above, line numbers in quotes (and only quotes) will have
    2429. 

  2429. a gutter of 1 figure space.
    2430. 

  2430. <p>
    2431. 

  2431. If you are using "line numbering style" for footnotes
    2432. 

  2432. (<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> <strong>LINE</strong>),
    2433. 

  2433. you may not wish to have quotes <em>visibly</em> line-numbered, but
    2434. 

  2434. still want to embed footnotes inside quotes.  In order to do that,
    2435. 

  2435. <strong>mom</strong> allows you to say <strong>NUMBER_QUOTE_LINES
    2436. 

  2436. SILENT</strong>.
    2437. 

  2437. <p>
    2438. 

  2438. When you invoke <strong>NUMBER_QUOTE_LINES</strong>
    2439. 

  2439. <kbd>SILENT</kbd>, <strong>mom</strong> continues to increment line
    2440. 

  2440. numbers while quotes are being output, but they won't appear in the
    2441. 

  2441. output copy.  (Compare this with <strong>mom</strong>'s default
    2442. 

  2442. behaviour of <em>suspending</em> incrementing of line numbers
    2443. 

  2443. during the output of quotes.)  This allows you to embed
    2444. 

  2444. line-numbered footnotes inside quotes and have the line number
    2445. 

  2445. "label" in the footnote come out sensibly.
    2446. 

  2446. <p>
    2447. 

  2447. Once having turned <strong>NUMBER_QUOTE_LINES</strong> on, you
    2448. 

  2448. may disable it with <strong>NUMBER_QUOTE_LINES OFF</strong> (or
    2449. 

  2449. <strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>,
    2450. 

  2450. etc).
    2451. 

  2451. <p>
    2452. 

  2452. 

  2453. <a name="NUMBER_BLOCKQUOTE_LINES"><h3><u>2. NUMBER_BLOCKQUOTE_LINES</u></h3></a>
    2454. 

  2454. <p>
    2455. 

  2455. If you'd like <strong>mom</strong> to number lines of output text
    2456. 

  2456. in a
    2457. 

  2457. <a href="#QUOTE">BLOCKQUOTE</a>
    2458. 

  2458. as part of the same order and sequence as paragraph text, simply
    2459. 

  2459. invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong> by itself.
    2460. 

  2460. <p>
    2461. 

  2461. There is a catch with numbering blockquotes, though.  Owing to
    2462. 

  2462. groff's restriction of accepting only the figure space as the
    2463. 

  2463. line number gutter's unit of measure, it is not possible for line
    2464. 

  2464. numbers in blockquotes to hang outside a document's overall left
    2465. 

  2465. margin and be reliably flush with the line numbers of paragraph
    2466. 

  2466. text.  Conseqently, line numbers in blockquotes hang to the
    2467. 

  2467. left of the blockquote, separated from the blockquote by the
    2468. 

  2468. <strong>&lt;gutter&gt;</strong> argument.
    2469. 

  2469. <p>
    2470. 

  2470. If you'd like to change the gutter for blockquotes line-numbered in
    2471. 

  2471. this way, invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong> with a digit
    2472. 

  2472. representing the number of
    2473. 

  2473. <a href="definitions.html#TERMS_FIGURESPACE">figure spaces</a>
    2474. 

  2474. you'd like between the line numbers and the blockquoted text, like
    2475. 

  2475. this:
    2476. 

  2476. <pre>
    2477. 

  2477. 	.NUMBER_BLOCKQUOTE_LINES 1
    2478. 

  2478. </pre>
    2479. 

  2479. 

  2480. With the above, line numbers in blockquotes (and only blockquotes)
    2481. 

  2481. will have a gutter of 1 figure space.
    2482. 

  2482. <p>
    2483. 

  2483. If you are using "line numbering style" for footnotes
    2484. 

  2484. (<a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> <strong>LINE</strong>),
    2485. 

  2485. you may not wish to have blockquotes <em>visibly</em> line-numbered,
    2486. 

  2486. but still want to embed footnotes inside blockquotes.  In
    2487. 

  2487. order to do that, <strong>mom</strong> allows you to say
    2488. 

  2488. <strong>NUMBER_BLOCKQUOTE_LINES SILENT</strong>.
    2489. 

  2489. <p>
    2490. 

  2490. When you invoke <strong>NUMBER_BLOCKQUOTE_LINES</strong>
    2491. 

  2491. <kbd>SILENT</kbd>, <strong>mom</strong> continues to increment line
    2492. 

  2492. numbers while blockquotes are being output, but they won't appear in
    2493. 

  2493. the output copy.  (Compare this with <strong>mom</strong>'s default
    2494. 

  2494. behaviour of <em>suspending</em> incrementing of line numbers during
    2495. 

  2495. the output of blockquotes.)  This allows you to embed line-numbered
    2496. 

  2496. footnotes inside blockquotes and have the line number "label" in the
    2497. 

  2497. footnote come out sensibly.
    2498. 

  2498. <p>
    2499. 

  2499. Once having turned <strong>NUMBER_BLOCKQUOTE_LINES</strong> on, you
    2500. 

  2500. may disable it with <strong>NUMBER_BLOCKQUOTE_LINES OFF</strong> (or
    2501. 

  2501. <strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>,
    2502. 

  2502. etc).
    2503. 

  2503. <p>
    2504. 

  2504. 

  2505. <a name="NUMBER_LINES_QUOTES"><h3><u>3. Setting up line numbering in quotes and blockquotes on a case by case basis</u></h3></a>
    2506. 

  2506. <p>
    2507. 

  2507. Sometimes, you may want quotes or blockquotes to have a different
    2508. 

  2508. line numbering scheme from the one used in the rest of the
    2509. 

  2509. document.  Or, you may want line numbering enabled only inside a
    2510. 

  2510. particular quote or blockquote.  A common reason for this would be
    2511. 

  2511. if you were using the
    2512. 

  2512. <a href="#QUOTE">QUOTE</a>
    2513. 

  2513. macro to insert lines of programming code into a document.  (See
    2514. 

  2514. <a href="#QUOTE_TIP">here</a>
    2515. 

  2515. for suggestions about including programming code snippets in
    2516. 

  2516. documents.)
    2517. 

  2517. <p>
    2518. 

  2518. To enable line numbering within quotes or blockquotes on a case by
    2519. 

  2519. case basis, simply invoke <strong>NUMBER_LINES</strong>, with the
    2520. 

  2520. arguments you need, immediately after entering <strong>QUOTE</strong>
    2521. 

  2521. or <strong>BLOCKQUOTE</strong>.  (<strong>NUMBER_QUOTE_LINES</strong>
    2522. 

  2522. and/or <strong>NUMBER_BLOCKQUOTE_LINES</strong> should be turned
    2523. 

  2523. off if you're doing this.)  The quote or blockquote will then be
    2524. 

  2524. line-numbered according to your specifications: the starting line
    2525. 

  2525. number of the quote or blockquote will be the one you give as a
    2526. 

  2526. first argument to <strong>NUMBER_LINES</strong>; which lines to
    2527. 

  2527. number will be the value you pass to <strong>&lt;which lines to
    2528. 

  2528. number&gt;</strong> (defaults to "1"); line numbers will hang
    2529. 

  2529. to the left of the quote or blockquote, separated from the quote or
    2530. 

  2530. blockquote by <strong>&lt;gutter&gt;</strong> (defaults to "2").
    2531. 

  2531. <p>
    2532. 

  2532. As soon as <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong> is
    2533. 

  2533. turned off, line numbering ceases, not only with respect to
    2534. 

  2534. subsequent paragraph text (if they are not being line-numbered),
    2535. 

  2535. but also for any subsequent invocation of <strong>QUOTE</strong> or
    2536. 

  2536. <strong>BLOCKQUOTE</strong>.  In other words, you must re-enable
    2537. 

  2537. quote or blockquote line-numbering inside every instance of
    2538. 

  2538. <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong> when
    2539. 

  2539. line-numbering either of them on a case by case basis.
    2540. 

  2540. <p>
    2541. 

  2541. <hr>
    2542. 

  2542. 

  2543. <!====================================================================>
    2544. 

  2544. 

  2545. <a name="FOOTNOTE_INTRO"><h2><u>Footnotes</u></h2></a>
    2546. 

  2546. <ul>
    2547. 

  2547. 	<li><a href="#FOOTNOTE_BEHAVIOUR">Footnote behaviour</a>
    2548. 

  2548. 	<ul>
    2549. 

  2549. 		<li><a href="#FN_AND_PUNCT">Footnote markers and punctuation in the running text</a>
    2550. 

  2550. 	</ul>
    2551. 

  2551. 	<li><a href="#FOOTNOTE">Tag: FOOTNOTE</a>
    2552. 

  2552. 	<li><a href="#FOOTNOTE_CONTROL">FOOTNOTE control macros</a>
    2553. 

  2553. </ul>
    2554. 

  2554. 

  2555. <p>
    2556. 

  2556. For something so complex behind the scenes, footnotes are easy to use.
    2557. 

  2557. You just type, for example
    2558. 

  2558. <p>
    2559. 

  2559. <a name="FOOTNOTE_EXAMPLE"></a>
    2560. 

  2560. <pre>
    2561. 

  2561. 	...the doctrines of Identity as urged by Schelling\c
    2562. 

  2562. 	.FOOTNOTE
    2563. 

  2563. 	&lt;footnote about who the hell is Schelling&gt;
    2564. 

  2564. 	.FOOTNOTE OFF
    2565. 

  2565. 	 were generally the points of discussion presenting the most
    2566. 

  2566. 	of beauty to the imaginative Morella.
    2567. 

  2567. </pre>
    2568. 

  2568. 

  2569. and be done with it.
    2570. 

  2570. <p>
    2571. 

  2571. (Note the obligatory use of the <strong>\c</strong>
    2572. 

  2572. <a href="definitions.html#TERMS_INLINES">inline escape</a>.
    2573. 

  2573. It is required when your
    2574. 

  2574. <a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a>
    2575. 

  2575. is either <strong>STAR</strong> [star/dagger footnotes] or
    2576. 

  2576. <strong>NUMBER</strong> [superscript numbers]; it is NOT to be used
    2577. 

  2577. when the <strong>FOOTNOTE_MARKER_STYLE</strong> is
    2578. 

  2578. <strong>LINE</strong>, or when footnote markers have been disabled
    2579. 

  2579. with
    2580. 

  2580. <a href="#FOOTNOTE_MARKERS">.FOOTNOTE_MARKERS</a>
    2581. 

  2581. <strong>OFF</strong>.)
    2582. 

  2582. <p>
    2583. 

  2583. <strong>***Version 1.3 change***</strong>
    2584. 

  2584. <p>
    2585. 

  2585. As of version 1.3, the manner of entering the line
    2586. 

  2586. <em>after</em> <strong>.FOOTNOTE OFF</strong> has changed
    2587. 

  2587. to accommodate users' differing wishes with respect to
    2588. 

  2588. the order of punctuation and footnote markers.  The
    2589. 

  2589. correct way to enter the line after <strong>.FOOTNOTE
    2590. 

  2590. OFF</strong>--<strong><em><u>ONLY</u></em></strong> if your
    2591. 

  2591. <a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a> is
    2592. 

  2592. <strong>STAR</strong> or <strong>NUMBER</strong>--is to input
    2593. 

  2593. it as if it's literally a continuation of the line before
    2594. 

  2594. <strong>.FOOTNOTE</strong>, and therefore begins with either a space
    2595. 

  2595. or a punctuation mark, as in the two following examples.
    2596. 

  2596. <p>
    2597. 

  2597. <pre>
    2598. 

  2598. 	   Example 1					  Example 2
    2599. 

  2599. 	   ---------                      ---------
    2600. 

  2600. 

  2601. 	A line of text,\c				A line of text\c
    2602. 

  2602. 	.FOOTNOTE						.FOOTNOTE
    2603. 

  2603. 	A footnote line.				A footnote line.
    2604. 

  2604. 	.FOOTNOTE OFF					.FOOTNOTE OFF
    2605. 

  2605. 	 broken up with a comma.		, broken up with a comma.
    2606. 

  2606. 

  2607. 	(last line begins with			(last line begins with
    2608. 

  2608. 	 a literal space)				 the comma and a space)
    2609. 

  2609. </pre>
    2610. 

  2610. 

  2611. If your <strong>FOOTNOTE_MARKER_STYLE</strong> is line, none of
    2612. 

  2612. this is a concern.
    2613. 

  2613. <p>
    2614. 

  2614. <strong>***End of version 1.3 change***</strong>
    2615. 

  2615. <p>
    2616. 

  2616. After you invoke <strong>FOOTNOTE</strong>, <strong>mom</strong>
    2617. 

  2617. takes care of everything: putting footnote markers in the body of
    2618. 

  2618. the document, keeping track of how many footnotes are on the page,
    2619. 

  2619. identifying the footnotes themselves appropriately, balancing them
    2620. 

  2620. properly with the bottom margin, deferring footnotes that don't fit
    2621. 

  2621. on the page...  Even if you're using
    2622. 

  2622. <a href="columns.html#COLUMNS">COLUMNS</a>,
    2623. 

  2623. <strong>mom</strong> knows what to do, and Does The Right Thing.
    2624. 

  2624. <p>
    2625. 

  2625. Footnotes can be sly little beasts, though.  If you're writing a
    2626. 

  2626. document that's footnote-heavy, you might want to read the following.
    2627. 

  2627. <p>
    2628. 

  2628. 

  2629. <a name="FOOTNOTE_BEHAVIOUR"><h3><u>Footnote behaviour</u></h3></a>
    2630. 

  2630. <p>
    2631. 

  2631. By default, <strong>mom</strong> marks footnotes with alternating
    2632. 

  2632. stars (asterisks), daggers, and double-daggers.  The first footnote
    2633. 

  2633. gets a star, the second a dagger, the third a double-dagger, the
    2634. 

  2634. fourth two stars, the fifth two daggers, etc.  If you prefer
    2635. 

  2635. numbered footnotes, rest assured <strong>mom</strong> is happy to
    2636. 

  2636. oblige.
    2637. 

  2637. <p>
    2638. 

  2638. A small amount of vertical whitespace and a short horizontal rule
    2639. 

  2639. separate footnotes from the document body.  The amount of whitespace
    2640. 

  2640. varies slightly from page to page depending on the number of lines
    2641. 

  2641. in the footnotes. <strong>Mom</strong> tries for a nice balance
    2642. 

  2642. between too little whitespace and too much, but when push comes to
    2643. 

  2643. shove, she'll usually opt for ample over cramped.  The last lines of
    2644. 

  2644. footnotes are always flush with the document's bottom margin.
    2645. 

  2645. <a name="FOOTNOTE_RULES"></a>
    2646. 

  2646. <p>
    2647. 

  2647. If <strong>mom</strong> sees that a portion of a footnote cannot
    2648. 

  2648. be fit on its page, she carries that portion over to the next
    2649. 

  2649. page.  If an entire footnote can't be fit on its page (i.e.
    2650. 

  2650. <strong>FOOTNOTE</strong> has been called too close to the bottom),
    2651. 

  2651. she defers the footnote to the next page, but sets it with the
    2652. 

  2652. appropriate marker from the previous page.
    2653. 

  2653. <p>
    2654. 

  2654. When footnotes occur within cited text, for example a
    2655. 

  2655. <a href="#QUOTE">QUOTE</a>
    2656. 

  2656. or a
    2657. 

  2657. <a href="#BLOCKQUOTE">BLOCKQUOTE</a>,
    2658. 

  2658. <strong>mom</strong> will usually opt for deferring the footnote
    2659. 

  2659. over to the next page if it allows her to complete the cited text
    2660. 

  2660. on one page.
    2661. 

  2661. <p>
    2662. 

  2662. In the unfortunate happenstance that a deferred footnote is the
    2663. 

  2663. only footnote on its page (i.e. it's marked in the document body with
    2664. 

  2664. a star) and the page it's deferred to has its own footnotes,
    2665. 

  2665. <strong>mom</strong> separates the deferred footnote from the page's
    2666. 

  2666. proper footnote(s) with a blank line.  This avoids the confusion that
    2667. 

  2667. might result from readers seeing two footnote entries on the same page
    2668. 

  2668. identified by a single star (or the number 1 if you've requested
    2669. 

  2669. numbered footnotes that begin at 1 on every page).  The blank line
    2670. 

  2670. makes it clear that the first footnote entry belongs to the previous
    2671. 

  2671. page.
    2672. 

  2672. <p>
    2673. 

  2673. In the circumstance where a deferred footnote is not the only one
    2674. 

  2674. on its page, and is consequently marked by something other than a
    2675. 

  2675. single star, there's no confusion and <strong>mom</strong> doesn't
    2676. 

  2676. bother with the blank line.  (By convention, the first footnote on
    2677. 

  2677. a page is always marked with a single star, so if readers see, say,
    2678. 

  2678. a dagger or double-dagger marking the first footnote entry, they'll
    2679. 

  2679. know the entry belongs to the previous page).
    2680. 

  2680. <p>
    2681. 

  2681. Very exceptionally, two footnotes may have to be deferred (e.g. one
    2682. 

  2682. occurs on the second to last line of a page, and another on the
    2683. 

  2683. last line).  In such a circumstance, <strong>mom</strong> does not
    2684. 

  2684. add a blank after the second deferred footnote.  If you'd like a
    2685. 

  2685. blank line separating both deferred footnotes from any footnotes
    2686. 

  2686. proper to the page the deferred ones were moved to, add the space
    2687. 

  2687. manually by putting a 
    2688. 

  2688. <a href="typesetting.html#SPACE">.SPACE</a>
    2689. 

  2689. command at the end of the footnote text, before
    2690. 

  2690. <strong>FOOTNOTE OFF</strong> (or <strong>FOOTNOTE X, QUIT,
    2691. 

  2691. EXIT, etc...</strong>).
    2692. 

  2692. <p>
    2693. 

  2693. Obviously, deferred footnotes aren't an issue if you request numbered
    2694. 

  2694. footnotes that increase incrementally throughout the whole document --
    2695. 

  2695. yet another convenience <strong>mom</strong> has thought of.
    2696. 

  2696. <p>
    2697. 

  2697. While <strong>mom</strong>'s handling of footnotes is
    2698. 

  2698. sophisticated, and tries to take nearly every imaginable situation
    2699. 

  2699. under which they might occur into account, some situations are
    2700. 

  2700. simply impossible from a typographic standpoint.  For example, if
    2701. 

  2701. you have a
    2702. 

  2702. <a href="#HEAD">HEAD</a>
    2703. 

  2703. near the bottom of the page AND that page has some footnotes on it,
    2704. 

  2704. <strong>mom</strong> may simply not have room to set any text under
    2705. 

  2705. the head (normally, she insists on having room for at least one line
    2706. 

  2706. of text beneath a head).  In such an instance, <strong>mom</strong>
    2707. 

  2707. will either set the head, with nothing under it but footnotes,
    2708. 

  2708. or transfer the head to the next page.  Either way, you'll have a
    2709. 

  2709. gaping hole at the bottom of the page.  It's a sort of typographic
    2710. 

  2710. Catch-22, and can only be resolved by you, the writer or formatter
    2711. 

  2711. of the document, adjusting the type on the offending page so as to
    2712. 

  2712. circumvent the problem.
    2713. 

  2713. <p>
    2714. 

  2714. <strong>NOTE:</strong> Exceptionally, you may encounter problems with footnotes inside
    2715. 

  2715. quotes and blockquotes that cross a page or column.  See <a
    2716. 

  2716. href="#BREAK_QUOTE">BREAK_QUOTE</a>
    2717. 

  2717. for a solution.
    2718. 

  2718. <p>
    2719. 

  2719. 

  2720. <h3><u><a name="FN_AND_PUNCT">Footnote markers and punctuation in the running text</a></u></h3>
    2721. 

  2721. 

  2722. <p>
    2723. 

  2723. As of version 1.3, the manner of entering the line <em>after</em>
    2724. 

  2724. <strong>.FOOTNOTE OFF</strong> has changed.  The correct way to
    2725. 

  2725. enter the line after <strong>.FOOTNOTE OFF</strong> now is to
    2726. 

  2726. input it as if it's literally a continuation of the line before
    2727. 

  2727. <strong>.FOOTNOTE</strong>, and therefore begins with either a space
    2728. 

  2728. or a punctuation mark, as in the two following examples.
    2729. 

  2729. <p>
    2730. 

  2730. <pre>
    2731. 

  2731. 	   Example 1					  Example 2
    2732. 

  2732. 	   ---------                      ---------
    2733. 

  2733. 

  2734. 	A line of text,\c				A line of text\c
    2735. 

  2735. 	.FOOTNOTE						.FOOTNOTE
    2736. 

  2736. 	A footnote line.				A footnote line.
    2737. 

  2737. 	.FOOTNOTE OFF					.FOOTNOTE OFF
    2738. 

  2738. 	 broken up with a comma.		, broken up with a comma.
    2739. 

  2739. 

  2740. 	(last line begins with			(last line begins with
    2741. 

  2741. 	 a literal space)				 the comma and a space)
    2742. 

  2742. </pre>
    2743. 

  2743. 

  2744. Care must be taken, though, if the punctuation mark that begins the
    2745. 

  2745. line after <strong>FOOTNOTE OFF</strong> is a period (dot).  You
    2746. 

  2746. <strong><em><u>must</u></em></strong> begin such lines with
    2747. 

  2747. <strong>\&.</strong>, like this:
    2748. 

  2748. <p>
    2749. 

  2749. <pre>
    2750. 

  2750. 	end of a sentence\c
    2751. 

  2751. 	.FOOTNOTE
    2752. 

  2752. 	A footnote line.
    2753. 

  2753. 	.FOOTNOTE OFF
    2754. 

  2754. 	\&.  A new sentence...
    2755. 

  2755. </pre>
    2756. 

  2756. 

  2757. If you omit the <strong>\&.</strong>, the line will vanish!
    2758. 

  2758. <p>
    2759. 

  2759. 

  2760. 

  2761. <!---FOOTNOTE--->
    2762. 

  2762. 

  2763. <hr width="66%" align="left">
    2764. 

  2764. <p>
    2765. 

  2765. <a name="FOOTNOTE">
    2766. 

  2766. 	<nobr>Tag: <strong>FOOTNOTE</strong> &lt;toggle&gt; | INDENT LEFT | RIGHT | BOTH &lt;indent value&gt;</nobr>
    2767. 

  2767. 	<br>
    2768. 

  2768. 	<em>*See <a href="#FOOTNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!</em>
    2769. 

  2769. 	<br>
    2770. 

  2770. 	&lt;indent value&gt; requires a
    2771. 

  2771. 	<a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
    2772. 

  2772. </a>
    2773. 

  2773. 

  2774. <p>
    2775. 

  2775. <strong>FOOTNOTE</strong> is a toggle macro, therefore invoking it
    2776. 

  2776. on a line by itself allows you to enter a footnote in the body of a
    2777. 

  2777. document.  Invoking it with any argument <em>other than INDENT</em>
    2778. 

  2778. (i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong>
    2779. 

  2779. you're finished.
    2780. 

  2780. <p>
    2781. 

  2781. Footnotes are the only element of
    2782. 

  2782. <a href="definitions.html#TERMS_RUNNING">running text</a>
    2783. 

  2783. that are not affected by the typesetting
    2784. 

  2784. <a href="typesetting.html#INDENTS">indent macros</a>.
    2785. 

  2785. In the unlikely event that you want a page's footnotes to line
    2786. 

  2786. up with a running indent, invoke <strong>FOOTNOTE</strong> with
    2787. 

  2787. the <strong>INDENT</strong> argument and pass it an indent
    2788. 

  2788. direction and indent value.  <strong>L, R,</strong> and
    2789. 

  2789. <strong>B</strong> may be used in place of <strong>LEFT,
    2790. 

  2790. RIGHT,</strong> and <strong>BOTH</strong>.
    2791. 

  2791. <strong>FOOTNOTE</strong> must be invoked with <strong>INDENT</strong>
    2792. 

  2792. for every footnote you want indented; <strong>mom</strong> does
    2793. 

  2793. not save any footnote indent information from invocation to
    2794. 

  2794. invocation.
    2795. 

  2795. <p>
    2796. 

  2796. <strong>NOTE:</strong> If a footnote runs to more than one
    2797. 

  2797. paragraph(!), <strong>DO NOT</strong> begin the footnote with
    2798. 

  2798. the
    2799. 

  2799. <a href="#PP">PP</a>
    2800. 

  2800. tag.  Use <strong>PP</strong> only to introduce subsequent paragraphs.
    2801. 

  2801. <p>
    2802. 

  2802. <a name="FOOTNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a>
    2803. 

  2803. The final word on the
    2804. 

  2804. <a href="definitions.html#TERMS_INPUTLINE">input line</a>
    2805. 

  2805. that comes immediately before <strong>FOOTNOTE</strong> MUST terminate
    2806. 

  2806. with a
    2807. 

  2807. <a href="typesetting.html#JOIN">\c</a>
    2808. 

  2808. inline escape if your
    2809. 

  2809. <a href="#FOOTNOTE_MARKER_STYLE">FOOTNOTE_MARKER_STYLE</a>
    2810. 

  2810. is either <strong>STAR</strong> or <strong>NUMBER</strong>.
    2811. 

  2811. See the
    2812. 

  2812. <a href="#FOOTNOTE_EXAMPLE">footnote example</a>
    2813. 

  2813. above.
    2814. 

  2814. <p>
    2815. 

  2815. Additionally, the line <em>after</em> a <strong>FOOTNOTE
    2816. 

  2816. OFF</strong> should be entered as if there were no interruption in
    2817. 

  2817. the input text, i.e. the line should begin with a literal space or
    2818. 

  2818. punctuation mark.  See
    2819. 

  2819. <a href="#FN_AND_PUNCT">above</a>.
    2820. 

  2820. <p>
    2821. 

  2821. Do NOT use the <strong>\c</strong> inline escape if your
    2822. 

  2822. <strong>FOOTNOTE_MARKER_STYLE</strong> is <strong>LINE</strong>, or
    2823. 

  2823. if you have disabled footnote markers with
    2824. 

  2824. <a href="#FOOTNOTE_MARKERS">.FOOTNOTE_MARKERS</a>
    2825. 

  2825. <strong>OFF</strong>.  As well, the line after
    2826. 

  2826. <strong>FOOTNOTE&nbsp;OFF</strong> should be entered normally.
    2827. 

  2827. 

  2828. <p>
    2829. 

  2829. <a name="FOOTNOTE_CONTROL"><h3><u>Footnote control macros</u></h3></a>
    2830. 

  2830. <ol>
    2831. 

  2831. 	<li><a href="#FOOTNOTE_GENERAL">Family/font/size/colour/lead/quad</a>
    2832. 

  2832. 	<li><a href="#FOOTNOTE_MARKERS">Footnote markers</a> -- on or off
    2833. 

  2833. 	<li><a href="#FOOTNOTE_MARKER_STYLE">Footnote marker style</a> -- star+dagger, numbered or by line number
    2834. 

  2834. 	<ul>
    2835. 

  2835. 		<li><a href="#FOOTNOTE_LINENUMBER_BRACKETS">FOOTNOTE_LINENUMBER_BRACKETS</a>
    2836. 

  2836. 		<li><a href="#FOOTNOTE_LINENUMBER_SEPARATOR">FOOTNOTE_LINENUMBER_SEPARATOR</a>
    2837. 

  2837. 		<li><a href="#FOOTNOTES_RUN_ON">FOOTNOTES_RUN_ON</a>--line-numbered footnotes only
    2838. 

  2838. 	</ul>
    2839. 

  2839. 	<li><a href="#RESET_FOOTNOTE_NUMBER">Reset footnote number</a> -- set footnote marker number to 1
    2840. 

  2840. 	<li><a href="#FOOTNOTE_SPACE">Inter-footnote spacing</a>
    2841. 

  2841. 	<li><a href="#FOOTNOTE_RULE">Footnote rule</a> -- on or off
    2842. 

  2842. 	<li><a href="#FOOTNOTE_RULE_LENGTH">Footnote rule length</a> -- length of footnote separator rule
    2843. 

  2843. 	<li><a href="#FOOTNOTE_RULE_ADJ">Adjust vertical position of footnote separator rule</a>
    2844. 

  2844. </ol>
    2845. 

  2845. <p>
    2846. 

  2846. <a name="FOOTNOTE_GENERAL"><h3><u>1. Family/font/size/colour/lead/quad</u></h3></a>
    2847. 

  2847. <p>
    2848. 

  2848. See
    2849. 

  2849. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    2850. 

  2850. <p>
    2851. 

  2851. <pre>
    2852. 

  2852. .FOOTNOTE_FAMILY    default = prevailing document family; default is Times Roman
    2853. 

  2853. .FOOTNOTE_FONT      default = roman
    2854. 

  2854. .FOOTNOTE_SIZE      default = -2 (points)
    2855. 

  2855. .FOOTNOTE_COLOR     default = black
    2856. 

  2856. .FOOTNOTE_AUTOLEAD  default = 2 points (typeset); single-spaced (typewrite)
    2857. 

  2857. .FOOTNOTE_QUAD      default = same as paragraphs
    2858. 

  2858. </pre>
    2859. 

  2859. 

  2860. <a name="FOOTNOTE_MARKERS"><h3><u>2. Footnote markers -- FOOTNOTE_MARKERS</u></h3></a>
    2861. 

  2861. <p>
    2862. 

  2862. If you don't want footnote markers, in either the body of
    2863. 

  2863. the document or beside footnote entries themselves, toggle
    2864. 

  2864. them off with <strong>.FOOTNOTE_MARKERS OFF</strong> (or
    2865. 

  2865. <strong>END, QUIT, X</strong>...).  This means, of course, that
    2866. 

  2866. you'll have to roll your own.  If you want them back on, invoke
    2867. 

  2867. <strong>.FOOTNOTE_MARKERS</strong> with no argument.  Footnote markers
    2868. 

  2868. are on by default.
    2869. 

  2869. <p>
    2870. 

  2870. If <strong>FOOTNOTE_MARKERS</strong> are disabled, do NOT use the
    2871. 

  2871. <strong>\c</strong> inline escape to terminate the line before
    2872. 

  2872. <strong>.FOOTNOTE</strong>.
    2873. 

  2873. <p>
    2874. 

  2874. 

  2875. <a name="FOOTNOTE_MARKER_STYLE"><h3><u>3. Footnote marker style -- FOOTNOTE_MARKER_STYLE</u></h3></a>
    2876. 

  2876. <p>
    2877. 

  2877. <strong>Mom</strong> gives you two choices of footnote marker style:
    2878. 

  2878. star+dagger (see 
    2879. 

  2879. <a href="#FOOTNOTE_BEHAVIOUR">footnote behaviour</a>
    2880. 

  2880. above), or numbered.
    2881. 

  2881. <p>
    2882. 

  2882. <strong>.FOOTNOTE_MARKER_STYLE STAR</strong> gives you star+dagger
    2883. 

  2883. (the default).  There is a limit of 10 footnotes per page with
    2884. 

  2884. this style.
    2885. 

  2885. <p>
    2886. 

  2886. <strong>.FOOTNOTE_MARKER_STYLE NUMBER</strong> gives you superscript
    2887. 

  2887. numbers, both in the document body and in the footnote entries
    2888. 

  2888. themselves.  By default, footnote numbers increase incrementally
    2889. 

  2889. (prev. footnote number + 1) throughout the whole document.  You can
    2890. 

  2890. ask <strong>mom</strong> to start each page's footnote numbers at 1
    2891. 

  2891. with <strong>.RESET_FOOTNOTE_NUMBER</strong>
    2892. 

  2892. (<a href="#RESET_FOOTNOTE_NUMBER">see below</a>.)
    2893. 

  2893. <a name="FOOTNOTE_LINENUMBERS"><p></a>
    2894. 

  2894. <p>
    2895. 

  2895. <strong>.FOOTNOTE_MARKER_STYLE LINE</strong> lets you have
    2896. 

  2896. footnotes which are identified by line number, rather than by a
    2897. 

  2897. marker in the text.  (Note that
    2898. 

  2898. <a href="#NUMBER_LINES">NUMBER_LINES</a>
    2899. 

  2899. must be enabled in order to use this marker style.)
    2900. 

  2900. <p>
    2901. 

  2901. With <strong>FOOTNOTE_MARKER_STYLE LINE</strong>, <strong>mom</strong>
    2902. 

  2902. will identify footnotes either by single line numbers, or line
    2903. 

  2903. ranges.  If what you want is a single line number, you need only
    2904. 

  2904. invoke <strong>.FOOTNOTE</strong>, <em>without terminating the text
    2905. 

  2905. line before it with</em> <strong>\c</strong>, at the appropriate
    2906. 

  2906. place in running text.
    2907. 

  2907. <p>
    2908. 

  2908. If you want a range of line numbers (e.g.&nbsp;[5-11]&nbsp;),
    2909. 

  2909. insert, directly into the first line of the range you want, the
    2910. 

  2910. <a href="definitions.html#TERMS_INLINES">inline escape</a>,
    2911. 

  2911. <strong>\*[FN-MARK]</strong>.  For the terminating line number of
    2912. 

  2912. the range, you need only invoke <strong>.FOOTNOTE</strong>, (again,
    2913. 

  2913. without attaching <strong>\c</strong> to the text line before it).
    2914. 

  2914. <strong>Mom</strong> is smart enough to figure out that where
    2915. 

  2915. <strong>FOOTNOTE</strong> was invoked represents the terminating
    2916. 

  2916. line number.  Range-numbered footnotes are always output on the page
    2917. 

  2917. where <strong>FOOTNOTE</strong> was invoked, not the page where
    2918. 

  2918. <strong>\*[FN-MARK]</strong> appears (subject, of course, to the
    2919. 

  2919. rules for footnotes that fall too close to the bottom of a page, as
    2920. 

  2920. outlined
    2921. 

  2921. <a href="#FOOTNOTE_RULES">here</a>).
    2922. 

  2922. <a name="FOOTNOTE_LINENUMBER_BRACKETS"></a>
    2923. 

  2923. <p>
    2924. 

  2924. <strong>Mom</strong>, by default, puts footnote line numbers inside
    2925. 

  2925. square brackets.  The style of the brackets may be changed with
    2926. 

  2926. the macro, <strong>FOOTNOTE_LINENUMBER_BRACKETS</strong>, which
    2927. 

  2927. takes one of three possible arguments: <strong>PARENS</strong>
    2928. 

  2928. ("round" brackets), <strong>SQUARE</strong> (the default) or
    2929. 

  2929. <strong>BRACES</strong> (curly braces).  If you prefer a
    2930. 

  2930. shortform, the arguments, <strong>(</strong>, <strong>[</strong> or
    2931. 

  2931. <strong>{</strong> may be used instead.
    2932. 

  2932. <a name="FOOTNOTE_LINENUMBER_SEPARATOR"></a>
    2933. 

  2933. <p>
    2934. 

  2934. If you don't want the numbers enclosed in brackets, you may tell
    2935. 

  2935. <strong>mom</strong> to use a "separator" instead.  A common
    2936. 

  2936. separator would be the colon, but it can be anything you like.  The
    2937. 

  2937. macro to do this is <strong>FOOTNOTE_LINENUMBER_SEPARATOR</strong>,
    2938. 

  2938. which takes, as its single argument, the separator you want.  For
    2939. 

  2939. safety and consistency's sake, ALWAYS enclose the argument in
    2940. 

  2940. double-quotes.
    2941. 

  2941. <p>
    2942. 

  2942. The separator can be composed of any legal groff character, or any
    2943. 

  2943. combination of characters. <strong>A word of caution:</strong> when
    2944. 

  2944. using a separator, <strong>mom</strong> doesn't insert a space
    2945. 

  2945. after the separator.  Hence, if you want the space (you probably
    2946. 

  2946. do), you must make the space part of the argument you pass to
    2947. 

  2947. <strong>FOOTNOTE_LINENUMBER_SEPARATOR</strong>.  For example,
    2948. 

  2948. to get a colon separator with a space after it, you'd do
    2949. 

  2949. <p>
    2950. 

  2950. <pre>
    2951. 

  2951. 	.FOOTNOTE_LINENUMBER_SEPARATOR ": "
    2952. 

  2952. </pre>
    2953. 

  2953. 

  2954. <a name="FOOTNOTES_RUN_ON"><strong><u>RUN-ON FOOTNOTES</u></strong></a>
    2955. 

  2955. <p>
    2956. 

  2956. Finally, if your footnote marker style is <strong>LINE</strong>, you
    2957. 

  2957. may instruct <strong>mom</strong> to do "run-on style" footnotes.
    2958. 

  2958. Run-on footnotes do not treat footnotes as discrete entities, i.e.
    2959. 

  2959. on a line by themselves.  Rather, each footnote is separated from
    2960. 

  2960. the footnote before it by a space, so that the footnotes on any
    2961. 

  2961. given page form a continuous block, like lines in a paragraph.  The
    2962. 

  2962. macro to get
    2963. 

  2963. <strong>mom</strong> to run footnotes on is
    2964. 

  2964. <strong>.FOOTNOTES_RUN_ON</strong>.  Invoked by itself, it turns
    2965. 

  2965. the feature on.  Invoked with any other argument
    2966. 

  2966. (<strong>OFF</strong>, <strong>NO</strong>, etc.), it turns the
    2967. 

  2967. feature off.  It is generally NOT a good idea to turn the feature
    2968. 

  2968. on and off during the course of a single document.  If you do,
    2969. 

  2969. <strong>mom</strong> will issue a warning if there's going to be a
    2970. 

  2970. problem.  However, it is always perfectly safe to enable/disable the
    2971. 

  2971. feature after
    2972. 

  2972. <a href="rectoverso.html#COLLATE">COLLATE</a>.
    2973. 

  2973. <p>
    2974. 

  2974. The usual reason for wanting run-on footnotes is that you're
    2975. 

  2975. using them to hold many, short references.  (See
    2976. 

  2976. <a href="refer.html#TOP">here</a>
    2977. 

  2977. for instructions on using the <strong>groff</strong> program,
    2978. 

  2978. <strong>refer</strong>, to set up references.)
    2979. 

  2979. 

  2980. <p>
    2981. 

  2981. 

  2982. <a name="RESET_FOOTNOTE_NUMBER"><h3><u>4. Reset footnote number -- RESET_FOOTNOTE_NUMBER</u></h3></a>
    2983. 

  2983. <p>
    2984. 

  2984. <strong>.RESET_FOOTNOTE_NUMBER</strong>, by itself, resets
    2985. 

  2985. footnote numbering so that the next footnote you enter is
    2986. 

  2986. numbered 1.
    2987. 

  2987. <p>
    2988. 

  2988. <strong>.RESET_FOOTNOTE_NUMBER PAGE</strong> tells
    2989. 

  2989. <strong>mom</strong> to start every page's footnote numbering at 1.
    2990. 

  2990. <p>
    2991. 

  2991. 

  2992. <a name="FOOTNOTE_SPACE"><h3><u>5. Inter-footnote spacing -- FOOTNOTE_SPACE</u></h3></a>
    2993. 

  2993. <p>
    2994. 

  2994. If you'd like a little extra space between footnotes, you can have
    2995. 

  2995. <strong>mom</strong> put it in for you by invoking
    2996. 

  2996. <strong>.FOOTNOTE_SPACE</strong> with an argument representing the
    2997. 

  2997. amount of extra space you'd like.  The argument to
    2998. 

  2998. <strong>FOOTNOTE_SPACE</strong> requires a
    2999. 

  2999. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    3000. 

  3000. <p>
    3001. 

  3001. In the following example, footnotes will be separated from each
    3002. 

  3002. other by 3
    3003. 

  3003. <a href="definitions.html#TERMS_PICASPOINTS">points</a>.
    3004. 

  3004. <pre>
    3005. 

  3005. 	.FOOTNOTE_SPACE 3p
    3006. 

  3006. </pre>
    3007. 

  3007. 

  3008. <a name="FOOTNOTE_RULE"><h3><u>6. Footnote rule -- FOOTNOTE_RULE</u></h3></a>
    3009. 

  3009. <p>
    3010. 

  3010. If you don't want a footnote separator rule, toggle it off with
    3011. 

  3011. <strong>.FOOTNOTE_RULE OFF</strong> (or <strong>END,
    3012. 

  3012. QUIT, X</strong>...).  Toggle it back on by invoking
    3013. 

  3013. <strong>.FOOTNOTE_RULE</strong> with no argument.  The default is to
    3014. 

  3014. print the rule.
    3015. 

  3015. <p>
    3016. 

  3016. 

  3017. <a name="FOOTNOTE_RULE_LENGTH"><h3><u>7. Footnote rule length -- FOOTNOTE_RULE_LENGTH</u></h3></a>
    3018. 

  3018. <p>
    3019. 

  3019. If you want to change the length of the footnote separator rule,
    3020. 

  3020. invoke <strong>.FOOTNOTE_RULE_LENGTH</strong> with a length, like
    3021. 

  3021. this,
    3022. 

  3022. <pre>
    3023. 

  3023. 	.FOOTNOTE_RULE_LENGTH 1i
    3024. 

  3024. </pre>
    3025. 

  3025. 

  3026. which sets the length to 1 inch.  Note that a
    3027. 

  3027. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    3028. 

  3028. is required.  The default is 4
    3029. 

  3029. <a href="definitions.html#TERMS_PICASPOINTS">picas</a>
    3030. 

  3030. for both
    3031. 

  3031. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLES</a>.
    3032. 

  3032. <p>
    3033. 

  3033. 

  3034. <a name="FOOTNOTE_RULE_ADJ"><h3><u>8. Adjust vertical position of footnote separator rule -- FOOTNOTE_RULE_ADJ</u></h3></a>
    3035. 

  3035. <p>
    3036. 

  3036. The footnote separator rule is actually a baseline rule that falls
    3037. 

  3037. on the
    3038. 

  3038. <a href="definitions.html#TERMS_BASELINE">baseline</a>
    3039. 

  3039. of the first line of a page's footnotes.  By default,
    3040. 

  3040. <strong>mom</strong> raises the rule 3
    3041. 

  3041. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
    3042. 

  3042. from the baseline so that the separator and the footnotes don't
    3043. 

  3043. look jammed together.  If you'd prefer a different vertical
    3044. 

  3044. adjustment, invoke <strong>.FOOTNOTE_RULE_ADJ</strong> with the
    3045. 

  3045. amount you'd like.  For example
    3046. 

  3046. <p>
    3047. 

  3047. <pre>
    3048. 

  3048. 	.FOOTNOTE_RULE_ADJ 4.25p
    3049. 

  3049. </pre>
    3050. 

  3050. 

  3051. raises the rule by 4-1/4 points.  Note that you can only raise
    3052. 

  3052. the rule, not lower it.  A
    3053. 

  3053. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    3054. 

  3054. is required.
    3055. 

  3055. <p>
    3056. 

  3056. <strong>Tip:</strong> If your document
    3057. 

  3057. <a href="definitions.html#TERMS_LEADING">leading</a>
    3058. 

  3058. is 2
    3059. 

  3059. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
    3060. 

  3060. or less (e.g your
    3061. 

  3061. <a href="definitions.html#TERMS_PS">point size</a>
    3062. 

  3062. is 10 and your linespacing is 10, 11, or 12, lowering
    3063. 

  3063. <strong>mom</strong>'s default footnote rule adjustment will
    3064. 

  3064. almost certainly give you nicer looking results than leaving
    3065. 

  3065. the adjustment at the default.  Furthermore, you can invoke
    3066. 

  3066. <strong>FOOTNOTE_RULE_ADJ</strong> on any page in which footnotes
    3067. 

  3067. appear, or in any column, so that the placement of the footnote rule
    3068. 

  3068. can be changed on-the-fly, should you wish to do so.
    3069. 

  3069. <p>
    3070. 

  3070. <hr>
    3071. 

  3071. 

  3072. <!====================================================================>
    3073. 

  3073. 

  3074. <a name="ENDNOTE_INTRO"><h2><u>Endnotes</u></h2></a>
    3075. 

  3075. <ul>
    3076. 

  3076. 	<li><a href="#ENDNOTE_BEHAVIOUR">Endnote behaviour</a>
    3077. 

  3077. 	<ul>
    3078. 

  3078. 		<li><a href="#ENDNOTE_SPACING">A Note on Endnote Spacing</a>
    3079. 

  3079. 		<li><a href="#ENDNOTE_COLUMNS">Endnotes and columnar documents</a>
    3080. 

  3080. 	</ul>
    3081. 

  3081. 	<li><a href="#ENDNOTE">Tag: ENDNOTE</a>
    3082. 

  3082. 	<li><a href="#ENDNOTES">Macro: ENDNOTES</a> -- tell <strong>mom</strong> to output endnotes
    3083. 

  3083. 	<li><a href="#ENDNOTE_CONTROL">ENDNOTES control macros</a>
    3084. 

  3084. </ul>
    3085. 

  3085. 

  3086. <p>
    3087. 

  3087. Embedding endnotes into <strong>mom</strong> documents is accomplished
    3088. 

  3088. the same way as embedding
    3089. 

  3089. <a href="#FOOTNOTE_INTRO">footnotes</a>.  The example below is
    3090. 

  3090. identical to the one shown in the
    3091. 

  3091. <a href="#FOOTNOTE_EXAMPLE">introduction to footnotes</a>,
    3092. 

  3092. except that <kbd>.FOOTNOTE</kbd> has been replaced with
    3093. 

  3093. <kbd>.ENDNOTE</kbd>.
    3094. 

  3094. <p>
    3095. 

  3095. <a name="ENDNOTE_EXAMPLE"></a>
    3096. 

  3096. <pre>
    3097. 

  3097. 	...the doctrines of Identity as urged by Schelling\c
    3098. 

  3098. 	.ENDNOTE
    3099. 

  3099. 	&lt;endnote about who the hell is Schelling&gt;
    3100. 

  3100. 	.ENDNOTE OFF
    3101. 

  3101. 	 were generally the points of discussion presenting the most
    3102. 

  3102. 	of beauty to the imaginative Morella.
    3103. 

  3103. </pre>
    3104. 

  3104. 

  3105. As with footnotes, note the obligatory use of the <strong>\c</strong>
    3106. 

  3106. <a href="definitions.html#TERMS_INLINES">inline escape</a>
    3107. 

  3107. when your
    3108. 

  3108. <a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a>
    3109. 

  3109. is <strong>NUMBER</strong> (which marks endnotes references in
    3110. 

  3110. <a href="definitions.html#TERMS_RUNNING">running text</a>
    3111. 

  3111. with superscript numbers).  When the marker style is
    3112. 

  3112. <strong>LINE</strong>, you must <em>not</em> use the
    3113. 

  3113. <strong>\c</strong> escape.
    3114. 

  3114. <p>
    3115. 

  3115. <strong>***Version 1.3 change***</strong>
    3116. 

  3116. <p>
    3117. 

  3117. As of version 1.3, the manner of entering the line <em>after</em>
    3118. 

  3118. <strong>.ENDNOTE OFF</strong> has changed to accommodate users'
    3119. 

  3119. differing wishes with respect to the order of punctuation and
    3120. 

  3120. endnote markers.  The correct way to enter the line after
    3121. 

  3121. <strong>.ENDNOTE OFF</strong>--but <strong><em><u>NOT</u></em></strong>
    3122. 

  3122. if your
    3123. 

  3123. <a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a>
    3124. 

  3124. is <strong>LINE</strong>--is to input it as if it's literally
    3125. 

  3125. a continuation of the line before <strong>.ENDNOTE</strong>, and
    3126. 

  3126. therefore begins with either a space or a punctuation mark, as in
    3127. 

  3127. the two following examples.
    3128. 

  3128. <p>
    3129. 

  3129. <a name="EN_PUNCT"></a>
    3130. 

  3130. <pre>
    3131. 

  3131. 	   Example 1					  Example 2
    3132. 

  3132. 	   ---------                      ---------
    3133. 

  3133. 

  3134. 	A line of text,\c				A line of text\c
    3135. 

  3135. 	.ENDNOTE						.ENDNOTE
    3136. 

  3136. 	A footnote line.				A footnote line.
    3137. 

  3137. 	.ENDNOTE OFF					.ENDNOTE OFF
    3138. 

  3138. 	 broken up with a comma.		, broken up with a comma.
    3139. 

  3139. 

  3140. 	(last line begins with			(last line begins with
    3141. 

  3141. 	 a literal space)				 the comma and a space)
    3142. 

  3142. </pre>
    3143. 

  3143. 

  3144. <strong>***End version 1.3 change***</strong>
    3145. 

  3145. <p>
    3146. 

  3146. Endnotes differ from footnotes in two ways (other than the fact that
    3147. 

  3147. endnotes come at the end of a document whereas footnotes appear in the
    3148. 

  3148. body of the document):
    3149. 

  3149. <br>
    3150. 

  3150. <ol>
    3151. 

  3151.     <li>When your <strong>ENDNOTE_MARKER_STYLE</strong> is
    3152. 

  3152.         <strong>NUMBER</strong>, endnotes are always numbered
    3153. 

  3153.         incrementally, starting at "1".
    3154. 

  3154. 	<li>Endnotes MUST be output explicitly; <strong>mom</strong> does
    3155. 

  3155. 		not output them for you.  In
    3156. 

  3156. 		<a href="rectoverso.html#COLLATE">collated</a>
    3157. 

  3157. 		documents, this allows you to choose whether you
    3158. 

  3158. 		want the endnotes to appear at the end of each chapter or
    3159. 

  3159.         article in a document, or grouped together at the very end
    3160. 

  3160.         of the document.
    3161. 

  3161. </ol>
    3162. 

  3162. <p>
    3163. 

  3163. Within endnotes, you may use the document element tags
    3164. 

  3164. <a href="#PP">PP</a>,
    3165. 

  3165. <a href="#QUOTE">QUOTE</a>
    3166. 

  3166. and
    3167. 

  3167. <a href="#BLOCKQUOTE">BLOCKQUOTE</a>.
    3168. 

  3168. This provides the flexibility to create endnotes that run to several
    3169. 

  3169. paragraphs, as well as to embed cited text within endnotes.
    3170. 

  3170. <p>
    3171. 

  3171. Should you wish to change the appearance of quotes or blockquotes that
    3172. 

  3172. appear within endnotes, you may do so with the
    3173. 

  3173. <a href="#QUOTE_CONTROL">quote control macros</a>
    3174. 

  3174. or
    3175. 

  3175. <a href="#BLOCKQUOTE_CONTROL">blockquote control macros</a>.
    3176. 

  3176. HOWEVER... you must make the changes <em>within</em> each endnote, prior
    3177. 

  3177. to invoking <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong>, and
    3178. 

  3178. undo them prior to terminating the endnote (i.e. before <strong>ENDNOTE
    3179. 

  3179. OFF</strong>), otherwise the changes will affect subsequent quotes and
    3180. 

  3180. blockquotes that appear in the document body as well.
    3181. 

  3181. <p>
    3182. 

  3182. 

  3183. <a name="ENDNOTE_BEHAVIOUR"><h3><u>Endnote behaviour</u></h3></a>
    3184. 

  3184. <br>
    3185. 

  3185. When you output endnotes (with
    3186. 

  3186. <a href="#ENDNOTES">ENDNOTES</a>),
    3187. 

  3187. <strong>mom</strong> finishes processing the last page of your document,
    3188. 

  3188. then breaks to a new page for printing the endnotes.  If the document
    3189. 

  3189. type is
    3190. 

  3190. <a href="docprocessing.html#DOCTYPE">CHAPTER</a>,
    3191. 

  3191. the centre part of the
    3192. 

  3192. <a href="definitions.html#TERMS_HEADER">header</a>
    3193. 

  3193. (or footer), which, by default, contains a chapter number or title, is
    3194. 

  3194. removed.
    3195. 

  3195. <p>
    3196. 

  3196. By default, <strong>mom</strong> starts the endnotes page with a
    3197. 

  3197. bold, centred, double-underscored head, &quot;ENDNOTES&quot;.
    3198. 

  3198. Underneath--flush left, bold, and underscored--she prints the document
    3199. 

  3199. title (or, in the case of chapters, the chapter number or title).  She
    3200. 

  3200. then prints the endnotes.  Each endnote is identified by its appropriate
    3201. 

  3201. number, in bold, right aligned to two placeholders.  The text of the
    3202. 

  3202. endnotes themselves is indented to the right of the numbers.
    3203. 

  3203. <p>
    3204. 

  3204. If the endnotes are grouped together at the end of a collated document,
    3205. 

  3205. each section of the document that contains endnotes is identified by its
    3206. 

  3206. own unique title (or chapter number or title), bold, flush left, and
    3207. 

  3207. underscored.
    3208. 

  3208. <p>
    3209. 

  3209. Of course, all the defaults, as well as the overall style of the
    3210. 

  3210. endnotes page, can be changed with the
    3211. 

  3211. <a href="#ENDNOTE_CONTROL">endnote control macros</a>.
    3212. 

  3212. The attentive will notice that endnotes have an awful lot of control
    3213. 

  3213. macros.  This is because endnotes are like a mini-document unto
    3214. 

  3214. themselves, and therefore need not be bound by the style parameters of
    3215. 

  3215. the body of the document.
    3216. 

  3216. <p>
    3217. 

  3217. 

  3218. <a name="ENDNOTE_SPACING">
    3219. 

  3219. 	<h3><u>A Note on Endnote Spacing</u></h3>
    3220. 

  3220. </a>
    3221. 

  3221. <br>
    3222. 

  3222. On the endnotes page(s), each new endnote is separated from the
    3223. 

  3223. previous endnote by a full line space.  This can result in a bottom
    3224. 

  3224. margin that hangs, and is the one instance, other than the use of
    3225. 

  3225. <a href="#PP_SPACE">PARA_SPACE</a>,
    3226. 

  3226. where <strong>mom</strong> allows unequal bottom alignment of pages.
    3227. 

  3227. Should you wish to correct this, by adding or subtracting small amounts
    3228. 

  3228. of space between endnotes that appear together on an endnotes page, make
    3229. 

  3229. the adjustment (with
    3230. 

  3230. <a href="typesetting.html#ALD">ALD</a>,
    3231. 

  3231. <a href="typesetting.html#RLD">RLD</a>
    3232. 

  3232. or
    3233. 

  3233. <a href="typesetting.html#SPACE">SPACE</a>)
    3234. 

  3234. <em>at the end of each endnote</em> (i.e. just before invoking
    3235. 

  3235. <a href="#ENDNOTE">ENDNOTE OFF</a>)
    3236. 

  3236. rather than at the top.
    3237. 

  3237. <p>
    3238. 

  3238. 

  3239. <a name="ENDNOTE_COLUMNS">
    3240. 

  3240. 	<h3><u>Endnotes and columnar documents</u></h3>
    3241. 

  3241. </a>
    3242. 

  3242. <br>
    3243. 

  3243. Formerly (pre 1.1.6), there was no way to set a document in columns
    3244. 

  3244. (see
    3245. 

  3245. <a href="docprocessing.html#COLUMNS">COLUMNS</a>)
    3246. 

  3246. and then turn off column mode for endnotes.  As of version 1.1.6,
    3247. 

  3247. you may now do so.  See
    3248. 

  3248. <a href="#ENDNOTES_NO_COLUMNS">ENDNOTES_NO_COLUMNS</a>.
    3249. 

  3249. <p>
    3250. 

  3250. <hr>
    3251. 

  3251. 

  3252. <!---ENDNOTE--->
    3253. 

  3253. 

  3254. <p>
    3255. 

  3255. <a name="ENDNOTE">
    3256. 

  3256. 	<nobr>Macro: <strong>ENDNOTE</strong> &lt;toggle&gt;</nobr>
    3257. 

  3257. 	<br>
    3258. 

  3258. 	<em>*See <a href="#ENDNOTE_NOTE">HYPER-IMPORTANT NOTE</a>!!!</em>
    3259. 

  3259. </a>
    3260. 

  3260. 

  3261. <p>
    3262. 

  3262. <strong>ENDNOTE</strong> is a toggle macro, therefore invoking it
    3263. 

  3263. on a line by itself allows you to enter an endnote in the body of a
    3264. 

  3264. document.  Invoking it with any other argument 
    3265. 

  3265. (i.e. <strong>OFF, QUIT, END, X...</strong>) tells <strong>mom</strong>
    3266. 

  3266. that you've finished the endnote.
    3267. 

  3267. <p>
    3268. 

  3268. <strong>NOTE:</strong> If an endnote runs to more than one paragraph,
    3269. 

  3269. <strong>DO NOT</strong> begin the endnote with the
    3270. 

  3270. <a href="#PP">PP</a>
    3271. 

  3271. tag.  Use <strong>PP</strong> only to introduce subsequent paragraphs.
    3272. 

  3272. <p>
    3273. 

  3273. <a name="ENDNOTE_NOTE"><strong>HYPER-IMPORTANT NOTE:</strong></a>
    3274. 

  3274. If your
    3275. 

  3275. <a href="#ENDNOTE_MARKER_STYLE">ENDNOTE_MARKER_STYLE</a>
    3276. 

  3276. is <strong>NUMBER</strong> (<strong>mom</strong>'s default), the
    3277. 

  3277. final word on the
    3278. 

  3278. <a href="definitions.html#TERMS_INPUTLINE">input line</a>
    3279. 

  3279. that comes immediately before <strong>ENDNOTE</strong> MUST terminate
    3280. 

  3280. with a
    3281. 

  3281. <a href="typesetting.html#JOIN">\c</a>
    3282. 

  3282. inline escape.  See the
    3283. 

  3283. <a href="#ENDNOTE_EXAMPLE">endnote example</a>
    3284. 

  3284. above.
    3285. 

  3285. <p>
    3286. 

  3286. Additionally, the line <em>after</em>
    3287. 

  3287. <strong>.ENDNOTE&nbsp;OFF</strong> should be entered as if there
    3288. 

  3288. were no interruption in the input text, i.e. the line should begin
    3289. 

  3289. with a literal space or punctuation mark.  See the two
    3290. 

  3290. <a href="#EN_PUNCT">examples</a>, 
    3291. 

  3291. above.
    3292. 

  3292. <p>
    3293. 

  3293. If your <strong>ENDNOTE_MARKER_STYLE</strong> is
    3294. 

  3294. <strong>LINE</strong>, do NOT use the <strong>\c</strong> escape,
    3295. 

  3295. and enter the line after <strong>.ENDNOTE&nbsp;OFF</strong>
    3296. 

  3296. normally.
    3297. 

  3297. <p>
    3298. 

  3298. 

  3299. <!---ENDNOTES--->
    3300. 

  3300. 

  3301. <hr width="66%" align="left">
    3302. 

  3302. <p>
    3303. 

  3303. <a name="ENDNOTES">Tag: <strong>ENDNOTES</strong></a>
    3304. 

  3304. 

  3305. <p>
    3306. 

  3306. Unlike footnotes, which <strong>mom</strong> automatically outputs at the
    3307. 

  3307. bottom of pages, endnotes must be explicitly output by you, the user.
    3308. 

  3308. <strong>ENDNOTES</strong>, by itself (i.e. without any argument), is
    3309. 

  3309. the macro to do this.
    3310. 

  3310. <p>
    3311. 

  3311. Typically, you'll use <strong>ENDNOTES</strong> at the end of
    3312. 

  3312. a document.  If it's a single (i.e. not collated) document,
    3313. 

  3313. <strong>mom</strong> will print the endnotes pertaining to it.  If it's
    3314. 

  3314. a collated document, <strong>mom</strong> will print all the endnotes
    3315. 

  3315. contained within all sections of the document (typically chapters),
    3316. 

  3316. appropriately identified and numbered.
    3317. 

  3317. <p>
    3318. 

  3318. Should you wish to output the endnotes for each section of a collated
    3319. 

  3319. document at the ends of the sections (instead of at the very end of the
    3320. 

  3320. document), simply invoke <strong>ENDNOTES</strong> immediately prior to
    3321. 

  3321. <a href="rectoverso.html#COLLATE">COLLATE</a>.
    3322. 

  3322. <strong>Mom</strong> will print the endnotes, identified and numbered
    3323. 

  3323. appropriately, on a separate page prior to starting the next section of
    3324. 

  3324. the document.  Each subsequent invocation of <strong>ENDNOTES</strong>
    3325. 

  3325. outputs only those endnotes that <strong>mom</strong> collected
    3326. 

  3326. after the previous invocation.
    3327. 

  3327. <p>
    3328. 

  3328. <hr width="66%" align="left">
    3329. 

  3329. 

  3330. <a name="ENDNOTE_CONTROL"><h3><u>Endnote control macros</u></h3></a>
    3331. 

  3331. <p>
    3332. 

  3332. <strong>VERY IMPORTANT NOTE!</strong>
    3333. 

  3333. <br>
    3334. 

  3334. Endnote control macros must always be invoked prior to the first
    3335. 

  3335. instance of
    3336. 

  3336. <a href="#ENDNOTE">ENDNOTE/ENDNOTE OFF</a>.
    3337. 

  3337. <p>
    3338. 

  3338. When you embed endnotes in the body of a document,
    3339. 

  3339. <strong>mom</strong> collects <em>and processes</em> them for later
    3340. 

  3340. outputting (when you invoke
    3341. 

  3341. <a href="#ENDNOTES">ENDNOTES</a>).
    3342. 

  3342. By the time you do invoke <strong>ENDNOTES</strong>, it's much too
    3343. 

  3343. late to change your mind about how you want them to look.
    3344. 

  3344. <p>
    3345. 

  3345. My advice?  If you're planning to change the default appearance of
    3346. 

  3346. endnotes pages, set them up prior to
    3347. 

  3347. <a href="docprocessing.html#START">START</a>.
    3348. 

  3348. <p>
    3349. 

  3349. <ol>
    3350. 

  3350. 	<li><a href="#ENDNOTES_GENERAL"><strong>General endnotes-pages style control</strong></a>
    3351. 

  3351. 		<ul>
    3352. 

  3352. 			<li><a href="#ENDNOTE_STYLE">Base family/font/quad for endnotes-pages</a>
    3353. 

  3353. 			<li><a href="#ENDNOTE_PT_SIZE">Base point size for the endnotes-pages</a>
    3354. 

  3354. 			<li><a href="#ENDNOTE_LEAD">Leading of endnotes-pages</a>
    3355. 

  3355. 			<li><a href="#SINGLESPACE_ENDNOTES">Singlespace endnotes (for TYPEWRITE only)</a>
    3356. 

  3356. 			<li><a href="#ENDNOTE_PARA_INDENT">Size of paragraph first line indent in multi-paragraph endnotes</a>
    3357. 

  3357. 			<li><a href="#ENDNOTE_PARA_SPACE">Inserting space between paragraphs of multi-paragraph endnotes</a>
    3358. 

  3358. 			<li><a href="#ENDNOTES_NO_COLUMNS">Turning off column mode during endnotes output</a>
    3359. 

  3359. 			<li>Pagination of endnotes:
    3360. 

  3360. 			<ul>
    3361. 

  3361. 				<li><a href="#ENDNOTES_PAGENUM_STYLE">Endnotes-pages page numbering style</a>
    3362. 

  3362. 				<li><a href="#ENDNOTES_FIRST_PAGENUMBER">Setting the first page number of endnotes pages</a>
    3363. 

  3363. 				<li><a href="#ENDNOTES_NO_FIRST_PAGENUM">Omitting a page number on the first page of endnotes</a>
    3364. 

  3364. 			</ul>
    3365. 

  3365. 			<li><a href="#SUSPEND_PAGINATION">Suspending pagination of endnotes pages</a>
    3366. 

  3366. 		</ul>
    3367. 

  3367. 	<li><a href="#ENDNOTES_HEADER_CONTROL"><strong>Endnotes-page header/footer control</strong></a>
    3368. 

  3368. 		<ul>
    3369. 

  3369. 			<li><a href="#ENDNOTES_MODIFY_HDRFTR">Modifying what goes in the endnotes-pages header/footer</a>
    3370. 

  3370. 			<li><a href="#ENDNOTES_HDRFTR_CENTER">Enabling a header/footer centre when doctype is CHAPTER</a>
    3371. 

  3371. 			<li><a href="#ENDNOTES_ALLOWS_HEADERS">Allow headers on endnotes-pages</a>
    3372. 

  3372. 		</ul>
    3373. 

  3373. 	<li><a href="#ENDNOTES_MAIN_TITLE"><strong>Endnotes-page head (i.e. the title at the top) control</strong></a>
    3374. 

  3374. 		<ul>
    3375. 

  3375. 			<li><a href="#ENDNOTE_STRING">Creating/modifying the endnotes-page head</a>
    3376. 

  3376. 			<li><a href="#ENDNOTE_STRING_CONTROL">Endnotes-page head control</a>
    3377. 

  3377. 			<li><a href="#ENDNOTE_STRING_UNDERSCORE">Endnotes-page head underscoring</a>
    3378. 

  3378. 			<li><a href="#ENDNOTE_STRING_CAPS">Endnotes-page head capitalization</a>
    3379. 

  3379. 		</ul>
    3380. 

  3380. 	<li><a href="#ENDNOTES_DOC_TITLE"><strong>Endnote document-identification title</strong></a>
    3381. 

  3381. 		<ul>
    3382. 

  3382. 			<li><a href="#ENDNOTE_TITLE">Creating/modifying the endnote document-identification title</a>
    3383. 

  3383. 			<li><a href="#ENDNOTE_TITLE_CONTROL">Document-identification title control</a>
    3384. 

  3384. 			<li><a href="#ENDNOTE_TITLE_UNDERSCORE">Document-identification title underscoring</a>
    3385. 

  3385. 		</ul>
    3386. 

  3386. 	<li><a href="#ENDNOTES_NUMBERING"><strong>Endnotes-pages endnote numbering style</strong></a>
    3387. 

  3387. 		<ul>
    3388. 

  3388. 			<li><a href="#ENDNOTE_MARKER_STYLE">Endnote marker style</a>--by numbers in the text, or by line number
    3389. 

  3389. 			<ul>
    3390. 

  3390. 				<li><a href="#ENDNOTE_LINENUMBER_GAP">ENDNOTE_LINENUMBER_GAP</a>
    3391. 

  3391. 				<li><a href="#ENDNOTE_LINENUMBER_BRACKETS">ENDNOTE_LINENUMBER_BRACKETS</a>
    3392. 

  3392. 				<li><a href="#ENDNOTE_LINENUMBER_SEPARATOR">ENDNOTE_LINENUMBER_SEPARATOR</a>
    3393. 

  3393. 			</ul>
    3394. 

  3394. 			<li><a href="#ENDNOTE_NUMBER_CONTROL">Endnotes-pages endnote numbering style control</a>
    3395. 

  3395. 			<li><a href="#ENDNOTE_NUMBER_ALIGNMENT">Endnote numbering alignment</a>
    3396. 

  3396. 			<ul>
    3397. 

  3397. 				<li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT">ENDNOTE_NUMBERS_ALIGN_RIGHT</a>
    3398. 

  3398. 				<li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT">ENDNOTE_NUMBERS_ALIGN_LEFT</a>
    3399. 

  3399. 			</ul>
    3400. 

  3400. 		</ul>
    3401. 

  3401. </ol>
    3402. 

  3402. <hr>
    3403. 

  3403. 

  3404. <a name="ENDNOTES_GENERAL"><h2><u>1. General endnotes page style control</u></h2>
    3405. 

  3405. 

  3406. <a name="ENDNOTE_STYLE"><h3><u>*Endnote family/font/quad</u></h3></a>
    3407. 

  3407. <p>
    3408. 

  3408. See
    3409. 

  3409. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    3410. 

  3410. <p>
    3411. 

  3411. <pre>
    3412. 

  3412. .ENDNOTE_FAMILY    default = prevailing document family; default is Times Roman
    3413. 

  3413. .ENDNOTE_FONT      default = roman
    3414. 

  3414. .ENDNOTE_QUAD*     default = justified
    3415. 

  3415. 

  3416. *Note: ENDNOTE_QUAD must be set to either L or J
    3417. 

  3417. </pre>
    3418. 

  3418. 

  3419. <!---ENDNOTE_PT_SIZE--->
    3420. 

  3420. 

  3421. <a name="ENDNOTE_PT_SIZE"><h3><u>*Endnote point size</u></h3></a>
    3422. 

  3422. <p>
    3423. 

  3423. <nobr>Macro: <strong>ENDNOTE_PT_SIZE</strong> &lt;base type size of endnotes&gt;</nobr>
    3424. 

  3424. 

  3425. <p>
    3426. 

  3426. Unlike most other control macros that deal with size of document
    3427. 

  3427. elements, <strong>ENDNOTE_PT_SIZE</strong> takes as its argument an
    3428. 

  3428. absolute value, relative to nothing.  Therefore, the argument represents
    3429. 

  3429. the size of endnote type in
    3430. 

  3430. <a href="definitions.html#TERMS_PICASPOINTS">points</a>,
    3431. 

  3431. unless you append an alternative
    3432. 

  3432. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    3433. 

  3433. For example,
    3434. 

  3434. <p>
    3435. 

  3435. <pre>
    3436. 

  3436. 	.ENDNOTE_PT_SIZE 12
    3437. 

  3437. </pre>
    3438. 

  3438. 

  3439. sets the base point size of type on the endnotes page to 12
    3440. 

  3440. points, whereas
    3441. 

  3441. <p>
    3442. 

  3442. <pre>
    3443. 

  3443. 	.ENDNOTE_PT_SIZE .6i
    3444. 

  3444. </pre>
    3445. 

  3445. 

  3446. sets the base point size of type on the endnotes page to 1/6 of an
    3447. 

  3447. inch.
    3448. 

  3448. <p>
    3449. 

  3449. The type size set with <strong>ENDNOTE_PT_SIZE</strong> is the size of
    3450. 

  3450. type used for the text of the endnotes, and forms the basis from which
    3451. 

  3451. the point size of other endnote page elements is calculated.
    3452. 

  3452. <p>
    3453. 

  3453. The default for
    3454. 

  3454. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
    3455. 

  3455. is 12.5 points (the same default size used in the body of the document).
    3456. 

  3456. <p>
    3457. 

  3457. 

  3458. <!---ENDNOTE_LEAD--->
    3459. 

  3459. 

  3460. <a name="ENDNOTE_LEAD"><h3><u>*Endnote lead</u></h3></a>
    3461. 

  3461. <p>
    3462. 

  3462. <nobr>Macro: <strong>ENDNOTE_LEAD</strong> &lt;base leading of endnotes&gt; [ ADJUST ] </nobr>
    3463. 

  3463. <br>
    3464. 

  3464. <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
    3465. 

  3465. 

  3466. <p>
    3467. 

  3467. Unlike most other control macros that deal with leading of document
    3468. 

  3468. elements, <strong>ENDNOTE_LEAD</strong> takes as its argument an
    3469. 

  3469. absolute value, relative to nothing.  Therefore, the argument represents
    3470. 

  3470. the
    3471. 

  3471. <a href="definitions.html#TERMS_LEADING">leading</a>
    3472. 

  3472. of endnotes in
    3473. 

  3473. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
    3474. 

  3474. unless you append an alternative
    3475. 

  3475. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    3476. 

  3476. For example,
    3477. 

  3477. <p>
    3478. 

  3478. <pre>
    3479. 

  3479. 	.ENDNOTE_LEAD 14
    3480. 

  3480. </pre>
    3481. 

  3481. 

  3482. sets the base leading of type on the endnotes page to 14
    3483. 

  3483. points, whereas
    3484. 

  3484. <p>
    3485. 

  3485. <pre>
    3486. 

  3486. 	.ENDNOTE_LEAD .5i
    3487. 

  3487. </pre>
    3488. 

  3488. 

  3489. sets the base leading of type on the endnotes page to 1/2 inch.
    3490. 

  3490. <p>
    3491. 

  3491. If you want the leading of endnotes adjusted to fill the page, pass
    3492. 

  3492. <strong>ENDNOTE_LEAD</strong> the optional argument
    3493. 

  3493. <strong>ADJUST</strong>.  (See
    3494. 

  3494. <a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
    3495. 

  3495. for an explanation of leading adjustment.)
    3496. 

  3496. <p>
    3497. 

  3497. The default for
    3498. 

  3498. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
    3499. 

  3499. is 14 points, adjusted.
    3500. 

  3500. <p>
    3501. 

  3501. <strong>NOTE:</strong> Even if you give <strong>mom</strong> a
    3502. 

  3502. <strong>DOC_LEAD_ADJUST OFF</strong> command, she will still, by
    3503. 

  3503. default, adjust endnote leading.  You MUST enter
    3504. 

  3504. <strong>ENDNOTE_LEAD &lt;lead&gt;</strong> with no
    3505. 

  3505. <strong>ADJUST</strong> argument to disable this default behaviour.
    3506. 

  3506. <p>
    3507. 

  3507. 

  3508. <!---SINGLESPACE_ENDNOTES--->
    3509. 

  3509. 

  3510. <a name="SINGLESPACE_ENDNOTES"><h3><u>*Singlespace endnotes (TYPEWRITE only)</u></h3></a>
    3511. 

  3511. <p>
    3512. 

  3512. <nobr>Macro: <strong>SINGLESPACE_ENDNOTES</strong> &lt;toggle&gt;</nobr>
    3513. 

  3513. 

  3514. <p>
    3515. 

  3515. If your 
    3516. 

  3516. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a>
    3517. 

  3517. is <strong>TYPEWRITE</strong> and you use TYPEWRITE's default
    3518. 

  3518. double-spacing, endnotes are double-spaced.  If your document is
    3519. 

  3519. single-spaced, endnotes are single-spaced.
    3520. 

  3520. <p>
    3521. 

  3521. If, for some reason, you'd prefer that endnotes be single-spaced
    3522. 

  3522. in an otherwise double-spaced document (including double-spaced
    3523. 

  3523. <a href="rectoverso.html#COLLATE">collated</a>
    3524. 

  3524. documents), invoke <strong>SINGLESPACE_ENDNOTES</strong> with
    3525. 

  3525. no argument.  And if, god help you, you want to change endnote
    3526. 

  3526. single-spacing back to double-spacing for different spacing of
    3527. 

  3527. endnotes output at the ends of separate documents in a collated
    3528. 

  3528. document, invoke <strong>SINGLESPACE_ENDNOTES</strong> with any
    3529. 

  3529. argument (<strong>OFF, QUIT, Q, X</strong>...).
    3530. 

  3530. <p>
    3531. 

  3531. 

  3532. <!---ENDNOTE_PARA_INDENT--->
    3533. 

  3533. 

  3534. <a name="ENDNOTE_PARA_INDENT"><h3><u>*Endnote paragraph indenting</u></h3></a>
    3535. 

  3535. <p>
    3536. 

  3536. <nobr>Macro: <strong>ENDNOTE_PARA_INDENT</strong> &lt;amount to indent first line of paragraphs in endnotes&gt;</nobr>
    3537. 

  3537. <br>
    3538. 

  3538. <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>
    3539. 

  3539. 

  3540. <p>
    3541. 

  3541. <strong>ENDNOTE_PARA_INDENT</strong> works exactly the same way as
    3542. 

  3542. <a href="#PARA_INDENT">PARA_INDENT</a>,
    3543. 

  3543. except that the indent given is the amount by which to indent the first
    3544. 

  3544. lines of endnote paragraphs, not document body paragraphs.
    3545. 

  3545. <p>
    3546. 

  3546. The default is 1.5
    3547. 

  3547. <a href="definitions.html#TERMS_EM">ems</a>
    3548. 

  3548. for
    3549. 

  3549. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
    3550. 

  3550. 1/2 inch for
    3551. 

  3551. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.
    3552. 

  3552. 

  3553. <p>
    3554. 

  3554. <strong>NOTE:</strong> The first line of the first paragraph of endnotes
    3555. 

  3555. (the one attached immediately to the identifying endnote number) is
    3556. 

  3556. never indented.  Only subsequent paragraphs are affected by
    3557. 

  3557. <strong>ENDNOTE_PARA_INDENT</strong>.  
    3558. 

  3558. <p>
    3559. 

  3559. 

  3560. <!---ENDNOTE_PARA_SPACE--->
    3561. 

  3561. 

  3562. <a name="ENDNOTE_PARA_SPACE"><h3><u>*Endnote paragraph spacing</u></h3></a>
    3563. 

  3563. <p>
    3564. 

  3564. <nobr>Macro: <strong>ENDNOTE_PARA_SPACE</strong> &lt;toggle&gt;</nobr>
    3565. 

  3565. 

  3566. <p>
    3567. 

  3567. <strong>ENDNOTE_PARA_SPACE</strong> works exactly the same way as
    3568. 

  3568. <a href="#PP_SPACE">PARA_SPACE</a>,
    3569. 

  3569. except that it inserts a blank line between endnote paragraphs, not
    3570. 

  3570. document body paragraphs.
    3571. 

  3571. <p>
    3572. 

  3572. The default is not to insert a blank line between paragraphs in
    3573. 

  3573. endnotes.
    3574. 

  3574. <p>
    3575. 

  3575. <strong>NOTE:</strong> Each endnote itself is always separated from any
    3576. 

  3576. previous endnote by a line space.  <strong>ENDNOTE_PARA_SPACE</strong>
    3577. 

  3577. refers only to paragraphs that appear within each discrete endnote.
    3578. 

  3578. <p>
    3579. 

  3579. 

  3580. <!---ENDNOTES_NO_COLUMNS--->
    3581. 

  3581. 

  3582. <a name="ENDNOTES_NO_COLUMNS"><h3><u>*Turning off column mode during endnotes output</u></h3></a>
    3583. 

  3583. <p>
    3584. 

  3584. <nobr>Macro: <strong>ENDNOTES_NO_COLUMNS</strong> &lt;toggle&gt;</nobr>
    3585. 

  3585. 

  3586. <p>
    3587. 

  3587. By default, if your document is
    3588. 

  3588. <a href="columns.html#COLUMNS">set in columns</a>,
    3589. 

  3589. <strong>mom</strong> sets the endnotes in columns, too.  However,
    3590. 

  3590. if your document is set in columns and you'd like the endnotes not
    3591. 

  3591. to be, just invoke <strong>ENDNOTES_NO_COLUMNS</strong> with no
    3592. 

  3592. argument.  The endnotes pages will be set to the full page measure
    3593. 

  3593. of your document.
    3594. 

  3594. <p>
    3595. 

  3595. If you output endnotes at the end of each document in a
    3596. 

  3596. <a href="rectoverso.html#COLLATE">collated</a>
    3597. 

  3597. document set in columns, column mode will automatically
    3598. 

  3598. be reinstated for each document, even with
    3599. 

  3599. <strong>ENDNOTES_NO_COLUMNS</strong> turned on.
    3600. 

  3600. <p>
    3601. 

  3601. 

  3602. <!---ENDNOTES_PAGENUM_STYLE--->
    3603. 

  3603. 

  3604. <a name="ENDNOTES_PAGENUM_STYLE"><h3><u>*Endnotes-pages page numbering style</u></h3></a>
    3605. 

  3605. <p>
    3606. 

  3606. <nobr>Macro: <strong>ENDNOTES_PAGENUM_STYLE</strong> DIGIT | ROMAN | roman | ALPHA | alpha</nobr>
    3607. 

  3607. 

  3608. <p>
    3609. 

  3609. Use this macro to set the page numbering style of endnotes pages.
    3610. 

  3610. The arguments are identical to those for
    3611. 

  3611. <a href="headfootpage.html#PAGENUM_STYLE">PAGENUM_STYLE</a>.
    3612. 

  3612. The default is <strong>digit</strong>.  You may want to change it
    3613. 

  3613. to, say, <strong>alpha</strong>, which you would do with
    3614. 

  3614. <p>
    3615. 

  3615. <pre>
    3616. 

  3616. 	.ENDNOTES_PAGENUM_STYLE alpha
    3617. 

  3617. </pre>
    3618. 

  3618. 

  3619. <!---ENDNOTES_FIRST_PAGENUMBER--->
    3620. 

  3620. 

  3621. <a name="ENDNOTES_FIRST_PAGENUMBER"><h3><u>*Setting the first page number of endnotes pages</u></h3></a>
    3622. 

  3622. <p>
    3623. 

  3623. <nobr>Macro: <strong>ENDNOTES_FIRST_PAGENUMBER</strong> &lt;page # that appears on page 1 of endnotes&gt;</nobr>
    3624. 

  3624. 

  3625. <p>
    3626. 

  3626. Use this macro with caution.  If all endnotes for several
    3627. 

  3627. <a href="rectoverso.html#COLLATE">collated</a>
    3628. 

  3628. documents are to be output at once, i.e. not at the end of each
    3629. 

  3629. separate doc, <strong>ENDNOTES_FIRST_PAGENUMBER</strong> tells
    3630. 

  3630. <strong>mom</strong> what page number to put on the first page of
    3631. 

  3631. the endnotes.
    3632. 

  3632. <p>
    3633. 

  3633. If you set <strong>ENDNOTES_FIRST_PAGENUMBER</strong> in collated
    3634. 

  3634. documents where the endnotes are output after each separate doc,
    3635. 

  3635. you have to reset every separate document's first page number after
    3636. 

  3636. <a href="rectoverso.html#COLLATE">COLLATE</a>
    3637. 

  3637. and before
    3638. 

  3638. <a href="docprocessing.html#START">START</a>.
    3639. 

  3639. <p>
    3640. 

  3640. 

  3641. <!---ENDNOTES_NO_FIRST_PAGENUN--->
    3642. 

  3642. 

  3643. <a name="ENDNOTES_NO_FIRST_PAGENUM"><h3><u>*Omitting a page number on the first page of endnotes</u></h3></a>
    3644. 

  3644. <p>
    3645. 

  3645. <nobr>Macro: <strong>ENDNOTES_NO_FIRST_PAGENUM</strong> &lt;toggle&gt;</nobr>
    3646. 

  3646. 

  3647. <p>
    3648. 

  3648. This macro is for use only if <strong>FOOTERS</strong> are on.  It
    3649. 

  3649. tells
    3650. 

  3650. <a href="#ENDNOTES">ENDNOTES</a>
    3651. 

  3651. not to print a page number on the first endnotes page.
    3652. 

  3652. <strong>Mom</strong>'s default is to print the page number.
    3653. 

  3653. <p>
    3654. 

  3654. 

  3655. <!---SUSPEND_PAGINATION--->
    3656. 

  3656. 

  3657. <a name="SUSPEND_PAGINATION"><h3><u>*Suspending pagination of endnotes pages</u></h3></a>
    3658. 

  3658. <p>
    3659. 

  3659. Macro: <strong>SUSPEND_PAGINATION</strong>
    3660. 

  3660. <br>
    3661. 

  3661. Macro: <strong>RESTORE_PAGINATION</strong>
    3662. 

  3662. 

  3663. <p>
    3664. 

  3664. <strong>SUSPEND_PAGINATION</strong> doesn't take an argument.
    3665. 

  3665. Invoked immediately prior to
    3666. 

  3666. <a href="#ENDNOTES">ENDNOTES</a>,
    3667. 

  3667. it turns off endnotes pages pagination.  <strong>Mom</strong>
    3668. 

  3668. continues, however to increment page numbers silently.
    3669. 

  3669. <p>
    3670. 

  3670. To restore normal document pagination after endnotes, invoke
    3671. 

  3671. <strong>RESTORE_PAGINATION</strong> (again, with no argument)
    3672. 

  3672. immediately after <strong>ENDNOTES</strong>.
    3673. 

  3673. 

  3674. <a name="ENDNOTES_HEADER_CONTROL"><h2><u>2. Endnotes-page header/footer control</u></h2></a>
    3675. 

  3675. <p>
    3676. 

  3676. <a name="ENDNOTES_MODIFY_HDRFTR"></a>
    3677. 

  3677. If you wish to modify what appears in the header/footer that appears
    3678. 

  3678. on endnotes page(s), make the changes before you invoke
    3679. 

  3679. <a href="#ENDNOTES">ENDNOTES</a>,
    3680. 

  3680. not afterwards.
    3681. 

  3681. <p>
    3682. 

  3682. Except in the case of
    3683. 

  3683. <a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a>,
    3684. 

  3684. <strong>mom</strong> prints the same header or footer used throughout
    3685. 

  3685. the document on the endnotes page(s).  Chapters get treated differently
    3686. 

  3686. in that, by default, <strong>mom</strong> does not print the
    3687. 

  3687. header/footer centre string (normally the chapter number or chapter
    3688. 

  3688. title.)  In most cases, this is what you want.  However, should you
    3689. 

  3689. <em>not</em> want <strong>mom</strong> to remove the centre string from
    3690. 

  3690. the endnotes page(s) headers/footers, invoke
    3691. 

  3691. <a href="#ENDNOTES_HDRFTR_CENTER">ENDNOTES_HEADER_CENTER</a>
    3692. 

  3692. with no argument. 
    3693. 

  3693. <p>
    3694. 

  3694. An important change you may want to make is to put the word
    3695. 

  3695. &quot;Endnotes&quot; in the header/footer centre position.
    3696. 

  3696. To do so, do
    3697. 

  3697. <p>
    3698. 

  3698. <pre>
    3699. 

  3699. 	.HEADER_CENTER "Endnotes"
    3700. 

  3700. 	           or
    3701. 

  3701. 	.FOOTER_CENTER "Endnotes"
    3702. 

  3702. </pre>
    3703. 

  3703. 

  3704. prior to invoking <strong>.ENDNOTES</strong>.  If your
    3705. 

  3705. <a href="docprocessing.html#DOCTYPE">DOCTYPE</a>
    3706. 

  3706. is <kbd>CHAPTER</kbd>, you must also invoke
    3707. 

  3707. <a href="#ENDNOTES_HDRFTR_CENTER">ENDNOTES_HEADER_CENTER</a>
    3708. 

  3708. for the <strong>HEADER_CENTER</strong> to appear.
    3709. 

  3709. <p>
    3710. 

  3710. 

  3711. <a name="ENDNOTES_HDRFTR_CENTER"><h3><u>*Endnotes page(s) header/footer centre string</u></h3></a>
    3712. 

  3712. <p>
    3713. 

  3713. <nobr>Macro: <strong>ENDNOTES_HEADER_CENTER</strong> toggle</nobr>
    3714. 

  3714. 

  3715. <p>
    3716. 

  3716. If your
    3717. 

  3717. <a href="docprocessing.html#DOCTYPE">DOCTYPE</a>
    3718. 

  3718. is <kbd>CHAPTER</kbd> and you want <strong>mom</strong> to include
    3719. 

  3719. a centre string in the headers/footers that appear on endnotes pages,
    3720. 

  3720. invoke <strong>ENDNOTES_HEADER_CENTER</strong> (or
    3721. 

  3721. <strong>ENDNOTES_FOOTER_CENTER</strong>) with no argument.
    3722. 

  3722. <strong>Mom</strong>'s default is NOT to print the centre string.
    3723. 

  3723. <p>
    3724. 

  3724. If, for some reason, having enabled the header/footer centre string
    3725. 

  3725. on endnotes pages, you wish to disable it, invoke the same macro
    3726. 

  3726. with any argument (<strong>OFF, QUIT, Q, X</strong>...).
    3727. 

  3727. <p>
    3728. 

  3728. 

  3729. <a name="ENDNOTES_ALLOWS_HEADERS"><h3><u>*Allow headers on endnotes-pages</u></h3></a>
    3730. 

  3730. <p>
    3731. 

  3731. <nobr>Macro: <strong>ENDNOTES_ALLOWS_HEADERS</strong> &lt;none&gt; | ALL</nobr>
    3732. 

  3732. 

  3733. <p>
    3734. 

  3734. By default, if <strong>HEADERS</strong> are on, <strong>mom</strong>
    3735. 

  3735. prints page headers on all endnotes pages except the first.  If you
    3736. 

  3736. don't want her to print headers on endnotes pages, do
    3737. 

  3737. <p>
    3738. 

  3738. <pre>
    3739. 

  3739. 	.ENDNOTES_ALLOWS_HEADERS OFF
    3740. 

  3740. </pre>
    3741. 

  3741. 

  3742. If you want headers on every page <em>including the first</em>, do
    3743. 

  3743. <p>
    3744. 

  3744. <pre>
    3745. 

  3745. 	.ENDNOTES_ALLOWS_HEADERS ALL
    3746. 

  3746. </pre>
    3747. 

  3747. 

  3748. <strong>NOTE:</strong> If <strong>FOOTERS</strong> are on,
    3749. 

  3749. <strong>mom</strong> prints footers on every endnotes page.  This is
    3750. 

  3750. a style convention.  In <strong>mom</strong>, there is no such beast
    3751. 

  3751. as <strong>ENDNOTES_ALLOWS_FOOTERS OFF</strong>.
    3752. 

  3752. <p>
    3753. 

  3753. 

  3754. <a name="ENDNOTES_MAIN_TITLE"><h2><u>3. Endnotes-page first page head (title) control</u></h2>
    3755. 

  3755. 

  3756. <!---ENDNOTE_STRING--->
    3757. 

  3757. 

  3758. <a name="ENDNOTE_STRING"><h3><u>*Endnotes-page first page head (title) string</u></h3></a>
    3759. 

  3759. <p>
    3760. 

  3760. <nobr>Macro: <strong>ENDNOTE_STRING</strong> &quot;&lt;head to print at the top of endnotes&gt;&quot;</nobr>
    3761. 

  3761. 

  3762. <p>
    3763. 

  3763. By default, <strong>mom</strong> prints the word &quot;ENDNOTES&quot;
    3764. 

  3764. as a head at the top of the first page of endnotes.  If you want her
    3765. 

  3765. to print something else, invoke <strong>ENDNOTE_STRING</strong> with
    3766. 

  3766. the endnotes-page head you want, surrounded by double-quotes.  If
    3767. 

  3767. you don't want a head at the top of the first endnotes-page, invoke
    3768. 

  3768. <strong>ENDNOTE_STRING</strong> with a blank argument (either two
    3769. 

  3769. double-quotes side by side -- <kbd>&quot;&quot;</kbd> -- or no argument
    3770. 

  3770. at all).
    3771. 

  3771. <p>
    3772. 

  3772. 

  3773. <!---ENDNOTE_STRING_CONTROL--->
    3774. 

  3774. 

  3775. <a name="ENDNOTE_STRING_CONTROL"><h3><u>*Endnotes-page first page head (title) control</u></h3></a>
    3776. 

  3776. <p>
    3777. 

  3777. See
    3778. 

  3778. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    3779. 

  3779. <p>
    3780. 

  3780. <pre>
    3781. 

  3781. .ENDNOTE_STRING_FAMILY    default = prevailing document family; default is Times Roman
    3782. 

  3782. .ENDNOTE_STRING_FONT      default = bold
    3783. 

  3783. .ENDNOTE_STRING_SIZE*     default = +1
    3784. 

  3784. .ENDNOTE_STRING_QUAD      default = centred
    3785. 

  3785. 

  3786. *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
    3787. 

  3787. </pre>
    3788. 

  3788. 

  3789. <!---ENDNOTE_STRING_UNDERSCORE--->
    3790. 

  3790. 

  3791. <a name="ENDNOTE_STRING_UNDERSCORE"><h3><u>*Endnotes-page head (title) underscoring</h3></u></a>
    3792. 

  3792. <p>
    3793. 

  3793. <nobr>Macro: <strong>ENDNOTE_STRING_UNDERSCORE</strong> toggle | 2</nobr>
    3794. 

  3794. 

  3795. <p>
    3796. 

  3796. Invoked by itself, <strong>ENDNOTE_STRING_UNDERSCORE</strong> will
    3797. 

  3797. underscore the endnotes-page head.  Invoked with the argument 2
    3798. 

  3798. (i.e. the digit 2), <strong>ENDNOTE_STRING_UNDERSCORE</strong> will
    3799. 

  3799. double-underscore the head.  Invoked with any other argument, the macro
    3800. 

  3800. disables underscoring of the head.
    3801. 

  3801. <p>
    3802. 

  3802. <strong>Mom</strong>'s default is to double-underscore the
    3803. 

  3803. head, therefore if you want no underscoring, you must insert
    3804. 

  3804. <kbd>.ENDNOTE_STRING_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO,
    3805. 

  3805. NONE,</kbd> etc.) into your document prior to outputting endnotes with
    3806. 

  3806. <a href="#ENDNOTES">ENDNOTES</a>.
    3807. 

  3807. 

  3808. <!---ENDNOTE_STRING_CAPS--->
    3809. 

  3809. 

  3810. <a name="ENDNOTE_STRING_CAPS"><h3><u>*Endnotes-page head (title) automatic capitalization</h3></u></a>
    3811. 

  3811. <p>
    3812. 

  3812. <nobr>Macro: <strong>ENDNOTE_STRING_CAPS</strong> toggle</nobr>
    3813. 

  3813. 

  3814. <p>
    3815. 

  3815. Invoked by itself, <strong>ENDNOTE_STRING_CAPS</strong> will
    3816. 

  3816. automatically capitalize the endnotes-page head.  Invoked with any
    3817. 

  3817. other argument, the macro disables automatic capitalization of the
    3818. 

  3818. head.
    3819. 

  3819. <p>
    3820. 

  3820. If you're generating a table of contents, you may want the
    3821. 

  3821. endnotes-pages head string in caps, but the toc entry in caps/lower
    3822. 

  3822. case.  If the argument to
    3823. 

  3823. <a href="#ENDNOTE_STRING">ENDNOTE_STRING</a>
    3824. 

  3824. is in caps/lower case and <strong>ENDNOTE_STRING_CAPS</strong> is
    3825. 

  3825. on, this is exactly what will happen.
    3826. 

  3826. <p>
    3827. 

  3827. <strong>Mom</strong>'s default is to capitalize the endnotes-pages
    3828. 

  3828. head string.
    3829. 

  3829. <p>
    3830. 

  3830. 

  3831. <!---ENDNOTE_TITLE--->
    3832. 

  3832. 

  3833. <a name="ENDNOTES_DOC_TITLE"><h2><u>4. Endnote document-identification title</u></h2>
    3834. 

  3834. <a name="ENDNOTE_TITLE"><h3><u>*Endnote document-identification title string</u></h3></a>
    3835. 

  3835. <p>
    3836. 

  3836. <nobr>Macro: <strong>ENDNOTE_TITLE</strong> &quot;&lt;title to identify a document in endnotes&gt;&quot;</nobr>
    3837. 

  3837. 

  3838. <p>
    3839. 

  3839. By default, <strong>mom</strong> identifies the document(s) to which
    3840. 

  3840. endnotes belong by the document title(s) given to the
    3841. 

  3841. <a href="docprocessing.html#TITLE">TITLE</a>
    3842. 

  3842. macro.  If you'd want her to identify the document(s) another way,
    3843. 

  3843. just invoke <strong>ENDNOTE_TITLE</strong> with the identifying
    3844. 

  3844. title you want, surrounded by double-quotes.
    3845. 

  3845. <p>
    3846. 

  3846. If you don't want any identifying title, invoke
    3847. 

  3847. <strong>ENDNOTE_TITLE</strong> with a blank argument (either two
    3848. 

  3848. double-quotes side by side -- <kbd>&quot;&quot;</kbd> -- or no
    3849. 

  3849. argument at all).  This is particularly useful if you have a single
    3850. 

  3850. (i.e. non-collated) document and find having the document's title
    3851. 

  3851. included in the endnotes redundant.
    3852. 

  3852. <p>
    3853. 

  3853. 

  3854. <!---ENDNOTE_TITLE_CONTROL--->
    3855. 

  3855. 

  3856. <a name="ENDNOTE_TITLE_CONTROL"><h3><u>*Endnote document-identification title control</u></h3></a>
    3857. 

  3857. <p>
    3858. 

  3858. See
    3859. 

  3859. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    3860. 

  3860. <p>
    3861. 

  3861. <pre>
    3862. 

  3862. .ENDNOTE_TITLE_FAMILY    default = prevailing document family; default is Times Roman
    3863. 

  3863. .ENDNOTE_TITLE_FONT      default = bold
    3864. 

  3864. .ENDNOTE_TITLE_SIZE*     default = 0
    3865. 

  3865. .ENDNOTE_TITLE_QUAD      default = left
    3866. 

  3866. 

  3867. *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
    3868. 

  3868. </pre>
    3869. 

  3869. 

  3870. <!---ENDNOTE_TITLE_UNDERSCORE--->
    3871. 

  3871. 

  3872. <a name="ENDNOTE_TITLE_UNDERSCORE"><h3><u>*Endnote document-identification title underscoring</h3></u></a>
    3873. 

  3873. <p>
    3874. 

  3874. <nobr>Macro: <strong>ENDNOTE_TITLE_UNDERSCORE</strong> toggle</nobr>
    3875. 

  3875. 

  3876. <p>
    3877. 

  3877. Invoked by itself, <strong>ENDNOTE_TITLE_UNDERSCORE</strong> will
    3878. 

  3878. underscore the endnote document-identification title(s).  Invoked with any
    3879. 

  3879. other argument, the macro disables underscoring of the title(s).
    3880. 

  3880. <p>
    3881. 

  3881. <strong>Mom</strong>'s default is to underscore the document-identification title, therefore if you want no underscoring, you must
    3882. 

  3882. insert <kbd>.ENDNOTE_TITLE_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO,
    3883. 

  3883. NONE,</kbd> etc.) into your document prior to outputting endnotes with
    3884. 

  3884. <a href="#ENDNOTES">ENDNOTES</a>.
    3885. 

  3885. <p>
    3886. 

  3886. 

  3887. <!---ENDNOTE_NUMBERING--->
    3888. 

  3888. 

  3889. <a name="ENDNOTES_NUMBERING"><h2><u>5. Endnotes-pages endnote numbering style</u></h2>
    3890. 

  3890. 

  3891. <a name="ENDNOTE_MARKER_STYLE"><h3><u>*Endnote marker style</u></h3></a>
    3892. 

  3892. <p>
    3893. 

  3893. The macro to control how endnotes are referenced is
    3894. 

  3894. <strong>ENDNOTE_MARKER_STYLE</strong>.
    3895. 

  3895. <p>
    3896. 

  3896. By default, <strong>mom</strong> places superscript numbers in
    3897. 

  3897. <a href="definitions.html#RUNNING">running text</a>
    3898. 

  3898. to identify endnotes.  However, if you have
    3899. 

  3899. <a href="#NUMBER_LINES">line-numbering</a>
    3900. 

  3900. turned on, you may instruct <strong>mom</strong> not to put
    3901. 

  3901. superscript numbers in the running text, but rather to reference
    3902. 

  3902. endnotes by line number.  The command to do this is
    3903. 

  3903. <p>
    3904. 

  3904. <pre>
    3905. 

  3905. 	.ENDNOTE_MARKER_STYLE LINE
    3906. 

  3906. </pre>
    3907. 

  3907. 

  3908. With <strong>ENDNOTE_MARKER_STYLE LINE</strong>, <strong>mom</strong>
    3909. 

  3909. will identify endnotes either by single line numbers, or line
    3910. 

  3910. ranges.  If what you want is a single line number, you need only
    3911. 

  3911. invoke <strong>.ENDNOTE</strong>, <em>without terminating the text
    3912. 

  3912. line before it with</em> <strong>\c</strong>, at the appropriate
    3913. 

  3913. place in running text.  (Should you wish to revert to
    3914. 

  3914. <strong>mom</strong>'s default behaviour of placing a superscript
    3915. 

  3915. number in the text to identify an endnote, you can invoke
    3916. 

  3916. <strong>ENDNOTE_MARKER_STYLE</strong> with the argument,
    3917. 

  3917. <strong>NUMBER</strong>.  It is not advisable to switch marker
    3918. 

  3918. styles within a single document, for aesthetic reasons, but there
    3919. 

  3919. is nothing to prevent you from doing so.)
    3920. 

  3920. <p>
    3921. 

  3921. If you want a range of line numbers (e.g.&nbsp;[5-11]&nbsp;),
    3922. 

  3922. insert, directly into the first line of the range you want, the
    3923. 

  3923. <a href="definitions.html#TERMS_INLINES">inline escape</a>,
    3924. 

  3924. <strong>\*[EN-MARK]</strong>.  For the terminating line number of
    3925. 

  3925. the range, you need only invoke <strong>.ENDNOTE</strong>, (again,
    3926. 

  3926. without attaching <strong>\c</strong> to the text line before it).
    3927. 

  3927. <strong>Mom</strong> is smart enough to figure out that where
    3928. 

  3928. <strong>ENDNOTE</strong> was invoked represents the terminating
    3929. 

  3929. line number.
    3930. 

  3930. <a name="ENDNOTE_LINENUMBER_GAP"></a>
    3931. 

  3931. <p>
    3932. 

  3932. Given the impossibility of knowing, in advance, the "string length"
    3933. 

  3933. of all the line numbers or ranges of line numbers that will be used
    3934. 

  3934. in endnotes (the string length of 12 is two; the string length
    3935. 

  3935. of 12-15 is 5), <strong>mom</strong> cannot "hang" line numbers
    3936. 

  3936. and guarantee that they, and the endnote text, will align in a
    3937. 

  3937. visually pleasing manner.  Consequently, <strong>mom</strong> sets
    3938. 

  3938. the entirety of line-numbered endnotes completely flush left,
    3939. 

  3939. <strong>including the line numbers themselves</strong>.  The line
    3940. 

  3940. numbers (by default, enclosed in square brackets) are separated from
    3941. 

  3941. the beginning of each endnote by a gap, so that a line-numbered
    3942. 

  3942. endnote looks approximately like this:
    3943. 

  3943. <p>
    3944. 

  3944. <pre>
    3945. 

  3945. 	[1-2]   Notwithstanding, Frye later asserts that Christianity
    3946. 

  3946. 	is "a ghost  with the chains of a foul historical record of
    3947. 

  3947. 	cruelty clanking behind it."
    3948. 

  3948. </pre>
    3949. 

  3949. 

  3950. The default gap for <strong>PRINTSTYLE TYPESET</strong> and
    3951. 

  3951. <strong>PRINSTYLE TYPEWRITE</strong> is 1.5
    3952. 

  3952. <a href="definitions.html#TERMS_EM">ems</a>.
    3953. 

  3953. You can change the size of the gap with the macro,
    3954. 

  3954. <strong>ENDNOTE_LINENUMBER_GAP</strong>, which takes, as its single
    3955. 

  3955. argument, the size of the gap.  The argument requires a
    3956. 

  3956. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>,
    3957. 

  3957. so, for example, to change the gap to 2
    3958. 

  3958. <a href="definitions.html#TERMS_PICASPOINTS">picas</a>,
    3959. 

  3959. you'd do
    3960. 

  3960. <p>
    3961. 

  3961. <pre>
    3962. 

  3962. 	.ENDNOTE_LINENUMBER_GAP 2P
    3963. 

  3963. </pre>
    3964. 

  3964. 

  3965. <a name="ENDNOTE_LINENUMBER_BRACKETS"></a>
    3966. 

  3966. By default, <strong>mom</strong> puts endnote line numbers inside
    3967. 

  3967. square brackets.  The style of the brackets may be changed with
    3968. 

  3968. the macro, <strong>ENDNOTE_LINENUMBER_BRACKETS</strong>, which
    3969. 

  3969. takes one of three possible arguments: <strong>PARENS</strong>
    3970. 

  3970. ("round" brackets), <strong>SQUARE</strong> (the default) or
    3971. 

  3971. <strong>BRACES</strong> (curly braces).  If you prefer a
    3972. 

  3972. shortform, the arguments, <strong>(</strong>, <strong>[</strong> or
    3973. 

  3973. <strong>{</strong> may be used instead.
    3974. 

  3974. <a name="ENDNOTE_LINENUMBER_SEPARATOR"></a>
    3975. 

  3975. <p>
    3976. 

  3976. If you don't want the numbers enclosed in brackets, you may tell
    3977. 

  3977. <strong>mom</strong> to use a "separator" instead.  A common
    3978. 

  3978. separator would be the colon, but it can be anything you like.  The
    3979. 

  3979. macro to do this is <strong>ENDNOTE_LINENUMBER_SEPARATOR</strong>,
    3980. 

  3980. which takes, as its single argument, the separator you want.
    3981. 

  3981. (If the argument contains spaces, don't forget to enclose the
    3982. 

  3982. argument in double-quotes.)  The separator can be composed of
    3983. 

  3983. any legal groff character, or any combination of characters.
    3984. 

  3984. For example, to get a colon separator after the line number in
    3985. 

  3985. line-numbered endnotes, you'd do
    3986. 

  3986. <p>
    3987. 

  3987. <pre>
    3988. 

  3988. 	.ENDNOTE_LINENUMBER_SEPARATOR :
    3989. 

  3989. </pre>
    3990. 

  3990. 

  3991. <a name="ENDNOTE_NUMBER_CONTROL"><h3><u>*Endnote numbering style control</u></h3></a>
    3992. 

  3992. <p>
    3993. 

  3993. See
    3994. 

  3994. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    3995. 

  3995. <p>
    3996. 

  3996. Please note that the control macros for endnote numbering affect only
    3997. 

  3997. the numbers that appear on the endnotes pages themselves, not the
    3998. 

  3998. endnote numbers that appear in the body of the document(s).
    3999. 

  3999. <p>
    4000. 

  4000. <pre>
    4001. 

  4001. .ENDNOTE_NUMBER_FAMILY    default = prevailing document family; default is Times Roman
    4002. 

  4002. .ENDNOTE_NUMBER_FONT      default = bold
    4003. 

  4003. .ENDNOTE_NUMBER_SIZE*     default = 0
    4004. 

  4004. 

  4005. *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE)
    4006. 

  4006. </pre>
    4007. 

  4007. 

  4008. <a name="ENDNOTE_NUMBER_ALIGNMENT"><h3><u>*Endnote numbering alignment</u></h3></a>
    4009. 

  4009. <p>
    4010. 

  4010. By default, <strong>mom</strong> hangs the numbers on endnotes pages,
    4011. 

  4011. aligned right to two placeholders, producing this:
    4012. 

  4012. <p>
    4013. 

  4013. <a name="ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE"></a>
    4014. 

  4014. <pre>
    4015. 

  4015. 	 9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    4016. 

  4016. 	    sed diam nonumy eirmod tempor invidunt ut labore et
    4017. 

  4017. 	    dolore magna aliquyam erat, sed diam voluptua.
    4018. 

  4018. 

  4019. 	10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    4020. 

  4020. 	    sed diam nonumy eirmod tempor invidunt ut labore et
    4021. 

  4021. 	    dolore magna aliquyam erat, sed diam voluptua.
    4022. 

  4022. </pre>
    4023. 

  4023. 

  4024. The macros to alter this behaviour are
    4025. 

  4025. <br>
    4026. 

  4026. <ul>
    4027. 

  4027. 	<li><a href="#ENDNOTE_NUMBERS_ALIGN_RIGHT"><strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong></a>
    4028. 

  4028. 	<li><a href="#ENDNOTE_NUMBERS_ALIGN_LEFT"><strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong></a>
    4029. 

  4029. </ul>
    4030. 

  4030. <br>
    4031. 

  4031. <hr width="66%" align="left">
    4032. 

  4032. 

  4033. <!---ENDNOTE_NUMBERS_ALIGN_RIGHT--->
    4034. 

  4034. 

  4035. <p>
    4036. 

  4036. <a name="ENDNOTE_NUMBERS_ALIGN_RIGHT">
    4037. 

  4037. 	<nobr>Macro: <strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> &lt;number of placeholders&gt;</nobr>
    4038. 

  4038. </a>
    4039. 

  4039. <p>
    4040. 

  4040. <strong>ENDNOTE_NUMBERS_ALIGN_RIGHT</strong> takes one (non-optional)
    4041. 

  4041. argument: the number of placeholders to reserve for right alignment of
    4042. 

  4042. endnote numbers.
    4043. 

  4043. <p>
    4044. 

  4044. For example, if you have fewer than ten endnotes, you might want to do
    4045. 

  4045. <p>
    4046. 

  4046. <pre>
    4047. 

  4047. 	.ENDNOTE_NUMBERS_ALIGN_RIGHT 1
    4048. 

  4048. </pre>
    4049. 

  4049. 

  4050. which would ensure that the endnote numbers hang, but are all flush
    4051. 

  4051. with the page's left margin.  If, god help you, you have over a hundred
    4052. 

  4052. endnotes, you'd want to do
    4053. 

  4053. <p>
    4054. 

  4054. <pre>
    4055. 

  4055. 	.ENDNOTE_NUMBERS_ALIGN_RIGHT 3
    4056. 

  4056. </pre>
    4057. 

  4057. 

  4058. to ensure that the numbers hang and are properly right-aligned.
    4059. 

  4059. <p>
    4060. 

  4060. 

  4061. <hr width="66%" align="left">
    4062. 

  4062. 

  4063. <!---ENDNOTE_NUMBERS_ALIGN_LEFT--->
    4064. 

  4064. 

  4065. <p>
    4066. 

  4066. <a name="ENDNOTE_NUMBERS_ALIGN_LEFT">
    4067. 

  4067. 	Macro: <strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong>
    4068. 

  4068. </a>
    4069. 

  4069. <p>
    4070. 

  4070. If you don't want the endnote numbers to hang and right-align, invoke
    4071. 

  4071. <strong>ENDNOTE_NUMBERS_ALIGN_LEFT</strong>, which doesn't require any
    4072. 

  4072. argument.  This disables hanging and right-alignment of endnote numbers,
    4073. 

  4073. so that the example
    4074. 

  4074. <a href="#ENDNOTE_NUMBERING_ALIGNMENT_EXAMPLE">above</a>
    4075. 

  4075. comes out like this:
    4076. 

  4076. <p>
    4077. 

  4077. <pre>
    4078. 

  4078. 	9. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    4079. 

  4079. 	sed diam nonumy eirmod tempor invidunt ut labore et
    4080. 

  4080. 	dolore magna aliquyam erat, sed diam voluptua.
    4081. 

  4081. 

  4082. 	10. Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
    4083. 

  4083. 	sed diam nonumy eirmod tempor invidunt ut labore et
    4084. 

  4084. 	dolore magna aliquyam erat, sed diam voluptua.
    4085. 

  4085. </pre>
    4086. 

  4086. <hr>
    4087. 

  4087. 

  4088. <!====================================================================>
    4089. 

  4089. 

  4090. <a name="MARGIN_NOTES_INTRO"><h2><u>Margin notes</u></h2></a>
    4091. 

  4091. <ul>
    4092. 

  4092. 	<li><a href="#MARGIN_NOTES_BEHAVIOUR">Margin notes behaviour
    4093. 

  4093. 	<ul>
    4094. 

  4094. 		<li><a href="#MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a>
    4095. 

  4095. 	</ul>
    4096. 

  4096. 	<li><a href="#MN_INIT">Macro: MN_INIT</a> -- initialize margin notes
    4097. 

  4097. 	<li><a href="#MN">Tag: MN</a>
    4098. 

  4098. </ul>
    4099. 

  4099. 

  4100. <p>
    4101. 

  4101. Margin notes are short annotations that appear in either the left
    4102. 

  4102. or right margin of a document.  Sometimes they comment on the text.
    4103. 

  4103. Sometimes they assist in following the "flow" of a document by
    4104. 

  4104. summarizing the subject of a portion of text.  Sometimes they're
    4105. 

  4105. comments to yourself in a draft copy.
    4106. 

  4106. <p>
    4107. 

  4107. The margin notes macros and routines in om.tmac
    4108. 

  4108. (<strong>mom</strong>) are "mommified" versions of the margin notes
    4109. 

  4109. macros and routines written by Werner Lemberg and patched by Gaius
    4110. 

  4110. Mulley.
    4111. 

  4111. <p>
    4112. 

  4112. 

  4113. <a name="MARGIN_NOTES_BEHAVIOUR"<h3><u>Margin notes behaviour</u></h3>
    4114. 

  4114. <p>
    4115. 

  4115. First things first: before you enter your first margin note, you
    4116. 

  4116. must "initialize" margin notes with
    4117. 

  4117. <a href="#MN_INIT">MN_INIT</a>.
    4118. 

  4118. <strong>MN_INIT</strong> sets up the style parameters for margin
    4119. 

  4119. notes, including things like
    4120. 

  4120. <a href="definitions.html#TERMS_FONT">font</a>,
    4121. 

  4121. <a href="definitions.html#TERMS_FAMILY">family</a>
    4122. 

  4122. and
    4123. 

  4123. <a href="definitions.html#TERMS_LEADING">leading</a>.
    4124. 

  4124. <p>
    4125. 

  4125. After initializing margin notes, you create margin notes with the
    4126. 

  4126. <a href="#MN">MN</a>
    4127. 

  4127. macro.  Based on the argument you pass <strong>MN</strong>, your
    4128. 

  4128. margin note will go in either the left or the right margin.
    4129. 

  4129. <p>
    4130. 

  4130. Margin notes are tricky from a typographic standpoint with respect
    4131. 

  4131. to vertical placement.  Since the leading of margin notes may
    4132. 

  4132. differ from that of
    4133. 

  4133. <a href="definitions.html#TERMS_RUNNING">running text</a>,
    4134. 

  4134. it's impossible for <strong>mom</strong> to guess whether to align
    4135. 

  4135. the first lines of margin notes with a document
    4136. 

  4136. <a href="definitions.html#TERMS_BASELINE">baseline</a>,
    4137. 

  4137. whether to align the last lines of margin notes with a document
    4138. 

  4138. baseline, or whether to center them, vertically, so that neither
    4139. 

  4139. first nor last line aligns with anything!
    4140. 

  4140. <p>
    4141. 

  4141. Given this difficulty, <strong>mom</strong> always aligns the first
    4142. 

  4142. line of any margin note with a document baseline.  If you want a
    4143. 

  4143. different behaviour, you must adjust the position(s) of margin
    4144. 

  4144. notes yourself, on a note by note basis.  (See
    4145. 

  4145. <a href="#MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a>.)
    4146. 

  4146. <p>
    4147. 

  4147. Generally speaking, <strong>mom</strong> tries to place margin
    4148. 

  4148. notes at the point where you invoke the tag,
    4149. 

  4149. <a href="#MN">MN</a>.
    4150. 

  4150. However, in the event that a margin note runs deep, she may not
    4151. 

  4151. be able to place a subsequent margin note exactly where you want.
    4152. 

  4152. In such an instance, <strong>mom</strong> will "shift" the margin
    4153. 

  4153. note down on the page, placing it one (margin note)
    4154. 

  4154. linespace beneath the previous margin note (plus whatever vertical
    4155. 

  4155. space is required to get the first line to line up with a baseline
    4156. 

  4156. of running text).  A warning will be issued, letting you know this
    4157. 

  4157. has happened, and where.
    4158. 

  4158. <p>
    4159. 

  4159. Sometimes, if a margin note has to be shifted down, there simply
    4160. 

  4160. isn't enough room to start the margin note on the page on which
    4161. 

  4161. <strong>MN</strong> is invoked.  In that case, <strong>mom</strong>
    4162. 

  4162. ignores the margin note entirely and issues a warning, letting you
    4163. 

  4163. know what she's done, and where.
    4164. 

  4164. <p>
    4165. 

  4165. In the event that a margin note, sucessfully begun on a page, 
    4166. 

  4166. runs past your bottom margin (or the last line before footnotes
    4167. 

  4167. begin), the margin note will "flow" onto the next page.  If it is a
    4168. 

  4168. "left" margin note, it will continue in the left margin.  If it is a
    4169. 

  4169. "right" margin note, it will continue in the right margin.
    4170. 

  4170. <p>
    4171. 

  4171. If your document is being set in two columns, <strong>mom</strong>
    4172. 

  4172. will sensibly and automatically set all margin notes pertaining
    4173. 

  4173. to the left column in the left margin, and all margin notes
    4174. 

  4174. pertaining to the right column in the right margin, regardless of
    4175. 

  4175. the "direction" argument you give the <strong>MN</strong> tag.  If
    4176. 

  4176. you try to use <strong>MN</strong> in documents of more than two
    4177. 

  4177. columns, <strong>mom</strong> will ignore all margin notes, and
    4178. 

  4178. issue warning for each.
    4179. 

  4179. <p>
    4180. 

  4180. <h3><u><a name="MARGIN_NOTES_VERTICAL">Adjusting the vertical position of margin notes</a></u></h3>
    4181. 

  4181. <p>
    4182. 

  4182. When the
    4183. 

  4183. <a href="definitions.html#TERM_LEADING">leading</a>
    4184. 

  4184. of margin notes differs from the leading used throughout a document,
    4185. 

  4185. you may want to adjust the vertical position of individual margin
    4186. 

  4186. notes.  This is most often going to be the case with margin notes
    4187. 

  4187. that end near the bottom of the page, where you want the last line of
    4188. 

  4188. the margin note to line up with the last line of text on the page.
    4189. 

  4189. <p>
    4190. 

  4190. Adjustments to the vertical position of margin notes must be done
    4191. 

  4191. inside the margin note (i.e. after <strong>MN</strong>), at the
    4192. 

  4192. top, before entering text.  The commands to use are
    4193. 

  4193. \!<a href="typesetting.html#ALD">.ALD</a>
    4194. 

  4194. (to lower the margin note), and
    4195. 

  4195. \!<a href="typesetting.html#RLD">.RLD</a>
    4196. 

  4196. (to raise it).  The <strong>\!</strong> <em>must</em> precede the
    4197. 

  4197. macros, or they won't have any effect.
    4198. 

    4199. 

  4199. <p>
    4200. 

  4200. <hr width="66%" align="left">
    4201. 

  4201. 

  4202. <!---MN_INIT--->
    4203. 

  4203. 

  4204. <p>
    4205. 

  4205. <a name="MN_INIT">
    4206. 

  4206. 	<nobr>Macro: <strong>MN_INIT</strong>&nbsp;[ ragged | symmetric ] &lt; left-width right-width gutter family+font point-size lead colour hyphenation-flags &gt;</nobr>
    4207. 

  4207. </a>
    4208. 

  4208. <p>
    4209. 

  4209. Before you enter your first margin note, you must initialize
    4210. 

  4210. all the parameters associated with margin notes with
    4211. 

  4211. <strong>MN_INIT</strong>.  If you forget to do so,
    4212. 

  4212. <strong>mom</strong> will issue a warning and abort.
    4213. 

  4213. <p>
    4214. 

  4214. The argument list is quite long; an
    4215. 

  4215. explanation of each argument follows.  Any argument whose value you
    4216. 

  4216. want to be the default must be entered as "" (i.e. two
    4217. 

  4217. double-quotes with no space between them).  Defaults for each
    4218. 

  4218. argument are given in the explanation below.
    4219. 

  4219. <p>
    4220. 

  4220. <strong>[ ragged | symmetric ]</strong>
    4221. 

  4221. <br>
    4222. 

  4222. If the first argument is "ragged", both left and right margin notes
    4223. 

  4223. will be flush left.  If the first argument is "symmetric", left
    4224. 

  4224. margin notes will be set flush <em>right</em>, and right margin
    4225. 

  4225. notes will be set flush <em>left</em>.  The effect is something
    4226. 

  4226. like this:
    4227. 

  4227. <p>
    4228. 

  4228. <pre>
    4229. 

  4229. 	     A left    This is a meaningless batch        A right
    4230. 

  4230. 	margin note    of text whose sole purpose is      margin note
    4231. 

  4231. 	  with just    to demonstrate how the sym-        with just
    4232. 

  4232. 	a few words    metric argument to MN sets left    a few words
    4233. 

  4233. 	     in it.    and right margin notes.            in it.
    4234. 

  4234. </pre>
    4235. 

  4235. 

  4236. 

  4237. If the argument is omitted,
    4238. 

  4238. or given as "", both left and right margin notes will be set
    4239. 

  4239. justified.  (Justified is usually not a good idea, since the narrow
    4240. 

  4240. measure of margin notes makes pleasing justification a near
    4241. 

  4241. impossibility.)
    4242. 

  4242. <p>
    4243. 

  4243. <strong>left-width</strong>
    4244. 

  4244. <br>
    4245. 

  4245. The width of left margin notes.  A
    4246. 

  4246. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    4247. 

  4247. must be appended directly onto the argument.  The default is to set
    4248. 

  4248. left margin notes right out to the edge of the page, which is
    4249. 

  4249. almost certainly not what you want, so you should give a value for
    4250. 

  4250. this argument if using left margin notes.
    4251. 

  4251. <p>
    4252. 

  4252. <strong>right-width</strong>
    4253. 

  4253. <br>
    4254. 

  4254. The width of right margin notes.  A
    4255. 

  4255. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    4256. 

  4256. must be appended directly onto the argument.  The default is to set
    4257. 

  4257. right margin notes right out to the edge of the page, which is
    4258. 

  4258. almost certainly not what you want, so you should give a value for
    4259. 

  4259. this argument if using right margin notes.
    4260. 

  4260. <p>
    4261. 

  4261. <strong>gutter</strong>
    4262. 

  4262. <br>
    4263. 

  4263. The
    4264. 

  4264. <a href="definitions.html#TERMS_GUTTER">gutter</a>
    4265. 

  4265. between margin notes and
    4266. 

  4266. <a href="definitions.html#TERMS_RUNNING">running text</a>.
    4267. 

  4267. A
    4268. 

  4268. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
    4269. 

  4269. must be appended directly onto the argument.  The gutter applies to
    4270. 

  4270. both left and right margin notes. The default is 1
    4271. 

  4271. <a href="definitions.html#TERMS_EM">em</a>.
    4272. 

  4272. <p>
    4273. 

  4273. <strong>font</strong>
    4274. 

  4274. <br>
    4275. 

  4275. The family+font for margin notes.  Yes, that's right: the family
    4276. 

  4276. PLUS font combo.  For example, if you want Times Roman Medium,
    4277. 

  4277. the argument must be TR.  If you want Palatino Medium Italic, the
    4278. 

  4278. argument must be PI.  The default is the same family+font combo used
    4279. 

  4279. for a document's paragraph text.
    4280. 

  4280. <p>
    4281. 

  4281. <strong>lead</strong>
    4282. 

  4282. <br>
    4283. 

  4283. The
    4284. 

  4284. <a href="definitions.html#TERMS_LEADING">leading</a>
    4285. 

  4285. of margin notes.  <strong>lead</strong> uses
    4286. 

  4286. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
    4287. 

  4287. as its unit of measure, so don't tack a unit of measure onto the
    4288. 

  4288. end of the argument.  The default lead is the same leading as
    4289. 

  4289. is used for paragraph text (i.e. the document's base leading).
    4290. 

  4290. For convenience and clarity, you may also give the word,
    4291. 

  4291. <strong>DOC</strong>, to this argument, which indicates that the
    4292. 

  4292. leading should be the same as the document's base leading.
    4293. 

  4293. <p>
    4294. 

  4294. <strong>colour</strong>
    4295. 

  4295. <br>
    4296. 

  4296. The colour of margin notes.  The colour must be pre-initialized
    4297. 

  4297. with
    4298. 

  4298. <a href="color.html#NEWCOLOR">NEWCOLOR</a>
    4299. 

  4299. or
    4300. 

  4300. <a href="color.html#XCOLOR">XCOLOR</a>.
    4301. 

  4301. The default is black.
    4302. 

  4302. <p>
    4303. 

  4303. <strong>hyphenation-flags</strong>
    4304. 

  4304. <br>
    4305. 

  4305. A number telling <strong>groff</strong> how you want margin notes
    4306. 

  4306. hyphenated.
    4307. 

  4307. <p>
    4308. 

  4308. <pre>
    4309. 

  4309. 	1 = hyphenate without restrictions
    4310. 

  4310. 	2 = do not hyphenate the last word on the page
    4311. 

  4311. 	4 = do not hyphenate the last two characters of a word
    4312. 

  4312. 	8 = do not hyphenate the first two characters of a word
    4313. 

  4313. </pre>
    4314. 

  4314. 

  4315. The values can be added together, so, for example, if you want
    4316. 

  4316. neither the first two nor the last two characters of words
    4317. 

  4317. hyphenated, the hyphenation-flag would be 12.  The default value is
    4318. 

  4318. 14 (i.e. 2+4+8).
    4319. 

  4319. 

  4320. <p>
    4321. 

  4321. <hr width="66%" align="left">
    4322. 

  4322. 

  4323. <!---MN_INIT--->
    4324. 

  4324. 

  4325. <p>
    4326. 

  4326. <a name="MN">
    4327. 

  4327. 	<nobr>Macro: <strong>MN</strong>&nbsp;LEFT|RIGHT | &lt;anything&gt;</nobr>
    4328. 

  4328. </a>
    4329. 

  4329. <p>
    4330. 

  4330. Once you've initialized margin notes with
    4331. 

  4331. <a href="#MN_INIT">MN_INIT</a>,
    4332. 

  4332. you can enter margin notes any time you like with
    4333. 

  4333. <strong>MN</strong>.  An argument of <strong>LEFT</strong> will set
    4334. 

  4334. a left margin note.  An argument of <strong>RIGHT</strong> will set
    4335. 

  4335. a right margin note.
    4336. 

  4336. <p>
    4337. 

  4337. Any argument, such as <strong>OFF</strong> (or
    4338. 

  4338. <strong>QUIT</strong>, <strong>END</strong>, <strong>X</strong>,
    4339. 

  4339. etc) exits the current margin note.
    4340. 

  4340. 

  4341. <p>
    4342. 

  4342. <hr>
    4343. 

  4343. 

  4344. <!====================================================================>
    4345. 

  4345. 

  4346. <a name="BLANK_PAGE_TITLE"><h2><u>Inserting a blank page into the document</u></h2></a>
    4347. 

  4347. <p>
    4348. 

  4348. <a name="BLANK_PAGE">
    4349. 

  4349. 	<nobr>Macro: <strong>BLANKPAGE</strong> &lt;# of blank pages to insert&gt;</nobr>
    4350. 

  4350. </a>
    4351. 

  4351. 

  4352. <p>
    4353. 

  4353. This one does exactly what you'd expect -- inserts a blank page into
    4354. 

  4354. the document. <strong>Mom</strong> silently increments the page
    4355. 

  4355. number of every blank page and keeps track of
    4356. 

  4356. <a href="rectoverso.html#RECTO_VERSO">recto/verso</a>
    4357. 

  4357. stuff, but otherwise, does nothing.  It's up to you, the user, to
    4358. 

  4358. figure out what to do with this feature.  However, it's worth
    4359. 

  4359. noting that without it, inserting completely blank pages, to use
    4360. 

  4360. a vernacular Québécois phrase, &quot;c'est pas évident&quot;
    4361. 

  4361. (somewhere between &quot;isn't easy&quot;, &quot;isn't
    4362. 

  4362. obvious&quot; and &quot;isn't fun&quot;).
    4363. 

  4363. <p>
    4364. 

  4364. The argument to <strong>BLANK_PAGE</strong> is the number of blank
    4365. 

  4365. pages to insert.  The argument is not optional, hence even if you
    4366. 

  4366. only want one blank page, you have to tell <strong>mom</strong>:
    4367. 

  4367. <p>
    4368. 

  4368. <pre>
    4369. 

  4369. 	.BLANKPAGE 1
    4370. 

  4370. </pre>
    4371. 

  4371. 

  4372. <a name="FINIS_INTRO"><h2><u>Terminate document processing</u></h2></a>
    4373. 

  4373. <ul>
    4374. 

  4374. 	<li><a href="#FINIS">Tag: FINIS</a>
    4375. 

  4375. 	<li><a href="#FINIS_STRING">Changing the FINIS string</a>
    4376. 

  4376. </ul>
    4377. 

  4377. 

  4378. <p>
    4379. 

  4379. The use of <strong>FINIS</strong> is optional.  If you invoke it
    4380. 

  4380. (at the end of a document before
    4381. 

  4381. <a href="#TOC">TOC</a>
    4382. 

  4382. or
    4383. 

  4383. <a href="#ENDNOTES">ENDNOTES</a>),
    4384. 

  4384. <strong>mom</strong>
    4385. 

  4385. deposits the word END, centred after a blank line, beneath the last
    4386. 

  4386. line of the document.  END is enclosed between
    4387. 

  4387. <a href="definitions.html#TERMS_EM">em-dashes</a>.
    4388. 

  4388. <p>
    4389. 

  4389. <strong>Please note</strong> that in versions of
    4390. 

  4390. <strong>mom</strong> prior to 1.1.9, <strong>FINIS</strong> used to
    4391. 

  4391. turn off
    4392. 

  4392. <a href="definitions.html#TERMS_FOOTER">footers</a>
    4393. 

  4393. (if they were on) and page numbering (if page numbers were at the
    4394. 

  4394. bottom of the page).  Damned if I can recall why I thought anyone
    4395. 

  4395. would want this behaviour, but it has been removed.
    4396. 

  4396. <p>
    4397. 

  4397. If you're writing in a language other than English, you can
    4398. 

  4398. change what <strong>mom</strong> prints for END with
    4399. 

  4399. the control macro <strong>FINIS_STRING</strong>.
    4400. 

  4400. <p>
    4401. 

  4401. <hr>
    4402. 

  4402. 

  4403. <!====================================================================>
    4404. 

  4404. 

  4405. <a name="TOC_INTRO"><h2><u>Table of contents</u></h2></a>
    4406. 

  4406. <ul>
    4407. 

  4407. 	<li><a href="#TOC_BEHAVIOUR">TOC behaviour</a>
    4408. 

  4408. 	<li><a href="#TOC">Macro: TOC</a> -- tell <strong>mom</strong> to output a table of contents
    4409. 

  4409. 	<li><a href="#TOC_CONTROL">TOC control macros</a>
    4410. 

  4410. </ul>
    4411. 

  4411. 

  4412. <p>
    4413. 

  4413. Want a table of contents for your document?  Easy.  Just enter
    4414. 

  4414. <p>
    4415. 

  4415. <pre>
    4416. 

  4416. 	.TOC
    4417. 

  4417. </pre>
    4418. 

  4418. 

  4419. as the very last macro of your document file. <strong>Mom</strong>
    4420. 

  4420. will have picked up all document titles (in
    4421. 

  4421. <a href="docprocessing.html#COLLATE">collated</a>
    4422. 

  4422. documents), all heads, subheads, and paragraph heads, as well as any
    4423. 

  4423. endnotes pages that have been output, and assigned them the
    4424. 

  4424. appropriate page number (and page numbering style).  Talk about a
    4425. 

  4425. no-brainer!
    4426. 

  4426. 

  4427. That said, tables of contents (tocs) have even more control macros
    4428. 

  4428. than endnotes.  As always, the reason for so many control macros is
    4429. 

  4429. so that if you want to change just about any aspect of the toc's
    4430. 

  4430. typographic appearance, you can.  <strong>Mom</strong> is all about
    4431. 

  4431. simplicity AND flexibility.
    4432. 

  4432. <p>
    4433. 

  4433. 

  4434. <a name="TOC_BEHAVIOUR"><h3><u>TOC behaviour</u></h3></a>
    4435. 

  4435. <p>
    4436. 

  4436. When you output a toc (with
    4437. 

  4437. <a href="#TOC">TOC</a>),
    4438. 

  4438. <strong>mom</strong> finishes processing the last page of your document,
    4439. 

  4439. then breaks to a new page for printing the toc.
    4440. 

  4440. <p>
    4441. 

  4441. <strong>Mom</strong> follows standard typesetting conventions for
    4442. 

  4442. tables of contents.  To this end, if
    4443. 

  4443. <a href="headfootpage.html#HEADERS">HEADERS</a>
    4444. 

  4444. are on for the document, the first page of the toc has no page
    4445. 

  4445. header, but does have a first page (roman numeral) number, always
    4446. 

  4446. &quot;1&quot;, in the bottom margin.  If
    4447. 

  4447. <a href="headfootpage.html#FOOTERS">FOOTERS</a>
    4448. 

  4448. are on for the document, the first page has neither a footer, nor a
    4449. 

  4449. page number in the top margin.  (If you absolutely must have a page
    4450. 

  4450. footer on the first page of the toc, simply invoke
    4451. 

  4451. <a href="headfootpage.html#FOOTER_ON_FIRST_PAGE">FOOTER_ON_FIRST_PAGE</a>
    4452. 

  4452. immediately before <strong>TOC</strong>.)  Subsequent toc pages have
    4453. 

  4453. both page headers or footers and a page number.
    4454. 

  4454. <p>
    4455. 

  4455. Entries in the toc are hierarchically indented, as you would
    4456. 

  4456. expect.  By default, each type of entry (e.g. a head or a subhead)
    4457. 

  4457. is set in a different font as well.  If any of heads, subheads or
    4458. 

  4458. paragraph heads are numbered in the body of the document, they are
    4459. 

  4459. also numbered in the toc.  Head numbering in the toc is NOT
    4460. 

  4460. concatenated as it is in the body of the document, which would be
    4461. 

  4461. visually redundant in a toc.
    4462. 

  4462. <p>
    4463. 

  4463. Tocs are never set in columns, regardless of whether the rest of
    4464. 

  4464. the document is.  Lastly, if
    4465. 

  4465. <a href="rectoverso.html#RECTO_VERSO">recto/verso</a>
    4466. 

  4466. printing is enabled, the toc respects it.  This sometimes leads to
    4467. 

  4467. tocs that begin with the wrong margins, but the margins can be
    4468. 

  4468. corrected either by outputting a
    4469. 

  4469. <a href="#BLANK_PAGE">BLANKPAGE</a>
    4470. 

  4470. or by using the toc control macro
    4471. 

  4471. <a href="#TOC_RV_SWITCH">TOC_RV_SWITCH</a>.
    4472. 

  4472. <p>
    4473. 

  4473. The overall toc
    4474. 

  4474. <a href="definitions.html#TERMS_FAMILY">family</a>,
    4475. 

  4475. <a href="definitions.html#TERMS_PS">point size</a>
    4476. 

  4476. and
    4477. 

  4477. <a href="definitions.html#TERMS_LEADING">lead</a>
    4478. 

  4478. can be altered with the toc 
    4479. 

  4479. <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>,
    4480. 

  4480. as can the family,
    4481. 

  4481. <a href="definitions.html#TERMS_FONT">font</a>,
    4482. 

  4482. point size and indent of each type of toc entry (i.e. title, head,
    4483. 

  4483. subhead, paragraph head).  Furthermore, the page numbering style
    4484. 

  4484. can be changed, as can the amount of visual space reserved for toc
    4485. 

  4485. entry page numbers.
    4486. 

  4486. <p>
    4487. 

  4487. 

  4488. <!---TOC--->
    4489. 

  4489. 

  4490. <hr width="66%" align="left">
    4491. 

  4491. <p>
    4492. 

  4492. <a name="TOC">Macro: <strong>TOC</strong></a>
    4493. 

  4493. 

  4494. <p>
    4495. 

  4495. If you want a toc, just put <strong>TOC</strong> as the last macro
    4496. 

  4496. in a document.  <strong>Mom</strong> takes care of the rest.
    4497. 

  4497. <p>
    4498. 

  4498. <hr width="66%" align="left">
    4499. 

  4499. 

  4500. <a name="TOC_CONTROL"><h3><u>TOC control macros</u></h3></a>
    4501. 

  4501. <p>
    4502. 

  4502. Toc entries are not actually processed when <strong>mom</strong>
    4503. 

  4503. collects them, so you can put any toc control macros anywhere you
    4504. 

  4504. like in your document.  Some may prefer to place them at the top of
    4505. 

  4505. the file.  Others may prefer to place them just before outputting
    4506. 

  4506. the toc.  The choice is yours.
    4507. 

  4507. <br>
    4508. 

  4508. <ol>
    4509. 

  4509. 	<li><a href="#TOC_GENERAL"><strong>General toc page style control</strong></a>
    4510. 

  4510. 		<ul>
    4511. 

  4511. 			<li><a href="#TOC_FAMILY">Base family for toc pages</a>
    4512. 

  4512. 			<li><a href="#TOC_PT_SIZE">Base point size for toc pages</a>
    4513. 

  4513. 			<li><a href="#TOC_LEAD">Leading of toc pages</a>
    4514. 

  4514. 		</ul>
    4515. 

  4515. 	<li><a href="#TOC_PAGENUMBERING"><strong>Toc page numbering</strong></a>
    4516. 

  4516. 		<ul>
    4517. 

  4517. 			<li><a href="#PAGINATE_TOC">Turn toc pagination on or off</a>
    4518. 

  4518. 			<li><a href="#TOC_PAGENUM_STYLE">Toc page numbering style</a>
    4519. 

  4519. 		</ul>
    4520. 

  4520. 	<li><a href="#TOC_HEADER"><strong>Changing the toc header (title), string and style</strong></a>
    4521. 

  4521. 		<ul>
    4522. 

  4522. 			<li><a href="#TOC_HEADER_STRING">Changing the string (title)</a>
    4523. 

  4523. 			<li><a href="#TOC_HEADER_STYLE">Changing the string (title) style</a>
    4524. 

  4524. 		</ul>
    4525. 

  4525. 	<li><a href="#TOC_STYLE"><strong>Changing the style for toc entries</strong></a>
    4526. 

  4526. 	    <ul>
    4527. 

  4527. 	        <li><a href="#TOC_INDENT">The toc _INDENT control macros</a>
    4528. 

  4528. 	        <li><a href="#TOC_TITLE">Changing the style for toc title entries</a>
    4529. 

  4529. 	        <li><a href="#TOC_HEAD">Changing the style for toc head entries</a>
    4530. 

  4530. 	        <li><a href="#TOC_SUBHEAD">Changing the style for toc subhead entries</a>
    4531. 

  4531. 	        <li><a href="#TOC_PARAHEAD">Changing the style for toc paragraph head entries</a>
    4532. 

  4532. 	        <li><a href="#TOC_PN">Changing the style for toc page number listings</a>
    4533. 

  4533. 	    </ul>
    4534. 

  4534. 	<li><a href="#TOC_ADDITIONAL"><strong>Additional toc control macros</strong></a>
    4535. 

  4535. 	    <ul>
    4536. 

  4536. 	        <li><a href="#TOC_TITLE_ENTRY">Change the wording of a toc title entry</a>
    4537. 

  4537. 	        <li><a href="#TOC_APPENDS_AUTHOR">Append author(s) to toc title entries</a>
    4538. 

  4538. 	        <li><a href="#TOC_RV_SWITCH">TOC_RV_SWITCH</a>
    4539. 

  4539. 	        <li><a href="#TOC_PADDING">TOC_PADDING</a>
    4540. 

  4540. 	    </ul>
    4541. 

  4541. </ol>
    4542. 

  4542. <hr>
    4543. 

  4543. 

  4544. <a name="TOC_GENERAL"><h2><u>1. General toc page style control</u></h2>
    4545. 

  4545. 

  4546. <a name="TOC_FAMILY"><h3><u>*Toc family</u></h3></a>
    4547. 

  4547. <p>
    4548. 

  4548. See
    4549. 

  4549. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
    4550. 

  4550. <p>
    4551. 

  4551. Set the family of toc pages with <strong>TOC_FAMILY</strong>, which
    4552. 

  4552. establishes the default family for every element of a toc page,
    4553. 

  4553. including the toc title (&quot;Contents&quot;) and the page number
    4554. 

  4554. in the top or bottom margin.  The default is the prevailing document
    4555. 

  4555. family.
    4556. 

  4556. <p>
    4557. 

  4557. All elements on a toc page also have their own _FAMILY
    4558. 

  4558. control macros, which override the default set by
    4559. 

  4559. <strong>TOC_FAMILY</strong>.
    4560. 

  4560. <p>
    4561. 

  4561. 

  4562. <!---TOC_PT_SIZE--->
    4563. 

  4563. 

  4564. <a name="TOC_PT_SIZE"><h3><u>*Toc point size</u></h3></a>
    4565. 

  4565. <p>
    4566. 

  4566. <nobr>Macro: <strong>TOC_PT_SIZE</strong> &lt;base type size of the toc&gt;</nobr>
    4567. 

  4567. 

  4568. <p>
    4569. 

  4569. Unlike most other control macros that deal with size of document
    4570. 

  4570. elements, <strong>TOC_PT_SIZE</strong> takes as its argument an
    4571. 

  4571. absolute value, relative to nothing.  Therefore, the argument
    4572. 

  4572. represents the size of toc type in
    4573. 

  4573. <a href="definitions.html#TERMS_PICASPOINTS">points</a>,
    4574. 

  4574. unless you append an alternative
    4575. 

  4575. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    4576. 

  4576. For example,
    4577. 

  4577. <p>
    4578. 

  4578. <pre>
    4579. 

  4579. 	.TOC_PT_SIZE 12
    4580. 

  4580. </pre>
    4581. 

  4581. 

  4582. sets the base point size of type for the toc to 12 points, whereas
    4583. 

  4583. <p>
    4584. 

  4584. <pre>
    4585. 

  4585. 	.TOC_PT_SIZE .6i
    4586. 

  4586. </pre>
    4587. 

  4587. 

  4588. sets the base point size of type for the toc to 1/6 of an inch.
    4589. 

  4589. <p>
    4590. 

  4590. The type size set with <strong>TOC_PT_SIZE</strong> forms the basis
    4591. 

  4591. from which the point size of other toc page elements are calculated.
    4592. 

  4592. <p>
    4593. 

  4593. The default for
    4594. 

  4594. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
    4595. 

  4595. is 12.5 points (the same default size used in the body of the
    4596. 

  4596. document).
    4597. 

  4597. <p>
    4598. 

  4598. 

  4599. <!---TOC_LEAD--->
    4600. 

  4600. 

  4601. <a name="TOC_LEAD"><h3><u>*Toc lead</u></h3></a>
    4602. 

  4602. <p>
    4603. 

  4603. <nobr>Macro: <strong>TOC_LEAD</strong> &lt;leading of the toc&gt; [ ADJUST ]</nobr>
    4604. 

  4604. <br>
    4605. 

  4605. <em>*Does not require a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>; points is assumed</em>
    4606. 

  4606. 

  4607. <p>
    4608. 

  4608. Unlike most other control macros that deal with leading of document
    4609. 

  4609. elements, <strong>TOC_LEAD</strong> takes as its argument an
    4610. 

  4610. absolute value, relative to nothing.  Therefore, the argument
    4611. 

  4611. represents the
    4612. 

  4612. <a href="definitions.html#TERMS_LEADING">leading</a>
    4613. 

  4613. of tocs in
    4614. 

  4614. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
    4615. 

  4615. unless you append an alternative
    4616. 

  4616. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    4617. 

  4617. For example,
    4618. 

  4618. <p>
    4619. 

  4619. <pre>
    4620. 

  4620. 	.TOC_LEAD 14
    4621. 

  4621. </pre>
    4622. 

  4622. 

  4623. sets the base leading of type on the endnotes page to 14
    4624. 

  4624. points, whereas
    4625. 

  4625. <p>
    4626. 

  4626. <pre>
    4627. 

  4627. 	.TOC_LEAD .5i
    4628. 

  4628. </pre>
    4629. 

  4629. 

  4630. sets the base leading of type on the endnotes page to 1/2 inch.
    4631. 

  4631. <p>
    4632. 

  4632. If you want the leading of toc pages adjusted to fill the
    4633. 

  4633. page, pass <strong>TOC_LEAD</strong> the optional argument
    4634. 

  4634. <strong>ADJUST</strong>.  (See
    4635. 

  4635. <a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a>
    4636. 

  4636. for an explanation of leading adjustment.)
    4637. 

  4637. <p>
    4638. 

  4638. The default for
    4639. 

  4639. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
    4640. 

  4640. is the prevailing document lead (16 by default), adjusted.
    4641. 

  4641. <p>
    4642. 

  4642. <strong>NOTE:</strong> Even if you give <strong>mom</strong> a
    4643. 

  4643. <strong>DOC_LEAD_ADJUST OFF</strong> command, she will still, by
    4644. 

  4644. default, adjust toc leading.  You MUST enter
    4645. 

  4645. <strong>TOC_LEAD &lt;lead&gt;</strong> with no
    4646. 

  4646. <strong>ADJUST</strong> argument to disable this default behaviour.
    4647. 

  4647. <p>
    4648. 

  4648. <strong>ADDITIONAL NOTE:</strong> Tocs are always double-spaced in
    4649. 

  4649. <strong>PRINTSTYLE TYPEWRITE</strong>, regardless of whether the
    4650. 

  4650. body of the document is single-spaced.
    4651. 

  4651. 

  4652. <a name="TOC_PAGENUMBERING"><h2><u>2. Toc page numbering</u></h2></a>
    4653. 

  4653. <p>
    4654. 

  4654. The page numbering of toc pages is controlled by the same macros
    4655. 

  4655. that control
    4656. 

  4656. <a href="headfootpage.html#PAGINATION">document page numbering</a>,
    4657. 

  4657. except
    4658. 

  4658. <a href="headfootpage.html#PAGENUM">PAGENUM</a>
    4659. 

  4659. (tocs always start on page 1).  The defaults are the same as the
    4660. 

  4660. rest of the document.
    4661. 

  4661. <p>
    4662. 

  4662. If you wish to change some aspect of toc pagination, use the
    4663. 

  4663. document pagination control macros immediately prior to
    4664. 

  4664. <strong>.TOC</strong>.
    4665. 

  4665. <p>
    4666. 

  4666. A special macro,
    4667. 

  4667. <a href="#TOC_PAGENUM_STYLE">TOC_PAGENUM_STYLE</a>
    4668. 

  4668. controls the style of toc pages page numbers.
    4669. 

  4669. <p>
    4670. 

  4670. 

  4671. <hr width="33%" align="left">
    4672. 

  4672. 

  4673. <!---PAGINATE_TOC--->
    4674. 

  4674. 

  4675. <p>
    4676. 

  4676. <a name="PAGINATE_TOC">
    4677. 

  4677. 	<nobr>Macro: <strong>PAGINATE_TOC</strong> &lt;toggle&gt;</nobr>
    4678. 

  4678. </a>
    4679. 

  4679. <p>
    4680. 

  4680. By default, <strong>mom</strong> paginates the toc.  If you'd like
    4681. 

  4681. her not to, do 
    4682. 

  4682. <p>
    4683. 

  4683. <pre>
    4684. 

  4684. 	.PAGINATE_TOC OFF
    4685. 

  4685. </pre>
    4686. 

  4686. 

  4687. <strong>NOTE:</strong> Simply invoking <strong>PAGINATION
    4688. 

  4688. OFF</strong> or <strong>PAGINATE OFF</strong> disables toc
    4689. 

  4689. pagination <em>for the first toc page only.</em> You MUST use
    4690. 

  4690. <strong>.PAGINATE_TOC OFF</strong> to disable toc pagination, even
    4691. 

  4691. if pagination is turned off elsewhere in your document.
    4692. 

  4692. <p>
    4693. 

  4693. 

  4694. <hr width="33%" align="left">
    4695. 

  4695. <p>
    4696. 

  4696. 

  4697. <!---TOC_PAGENUM_STYLE--->
    4698. 

  4698. 

  4699. <a name="TOC_PAGENUM_STYLE">
    4700. 

  4700. 	<nobr>Macro: <strong>TOC_PAGENUM_STYLE</strong> &lt;DIGIT | ROMAN | roman | ALPHA | alpha&gt;</nobr>
    4701. 

  4701. </a>
    4702. 

  4702. <p>
    4703. 

  4703. By default, <strong>mom</strong> uses roman numerals to number
    4704. 

  4704. toc pages.  Use <strong>TOC_PAGENUM_STYLE</strong> if you'd prefer
    4705. 

  4705. something else.  For example, to have standard digits instead of
    4706. 

  4706. roman numerals, do the following:
    4707. 

  4707. <p>
    4708. 

  4708. <pre>
    4709. 

  4709. 	.TOC_PAGENUM_STYLE DIGIT
    4710. 

  4710. </pre>
    4711. 

  4711. 

  4712. <hr width="33%" align="left">
    4713. 

  4713. 

  4714. <a name="TOC_HEADER"><h2><u>3. Changing the toc header (title) string and style</u></h2></a>
    4715. 

  4715. <p>
    4716. 

  4716. The toc header string is the title that appears at to top of the
    4717. 

  4717. toc.  By default, it's &quot;Contents&quot;.  If you'd like
    4718. 

  4718. something else, say, &quot;Table of Contents&quot;, do
    4719. 

  4719. <p>
    4720. 

  4720. <a name="TOC_HEADER_STRING"></a>
    4721. 

  4721. <pre>
    4722. 

  4722. 	.TOC_HEADER_STRING "Table of Contents"
    4723. 

  4723. </pre>
    4724. 

  4724. 

  4725. <a name="TOC_HEADER_STYLE"></a>
    4726. 

  4726. The style of the toc header (title) is managed by the usual control
    4727. 

  4727. macros (see
    4728. 

  4728. <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
    4729. 

  4729. <p>
    4730. 

  4730. <pre>
    4731. 

  4731. 	.TOC_HEADER_FAMILY  default = prevailing doc family (Times Roman in TYPEWRITE)
    4732. 

  4732. 	.TOC_HEADER_FONT    default = bold
    4733. 

  4733. 	.TOC_HEADER_SIZE    default = +4
    4734. 

  4734. 	.TOC_HEADER_QUAD    default = left
    4735. 

  4735. </pre>
    4736. 

  4736. 

  4737. <a name="TOC_STYLE"><h2><u>4. Changing the style for toc entries</u></h2></a>
    4738. 

  4738. <p>
    4739. 

  4739. &quot;Toc entries&quot; refers to titles, heads, subheads and
    4740. 

  4740. paragraph heads as they appear in the toc.  Their style is managed
    4741. 

  4741. by the usual
    4742. 

  4742. <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>,
    4743. 

  4743. starting with TOC_
    4744. 

  4744. <p>
    4745. 

  4745. 

  4746. <a name="TOC_INDENT"><h3><u>The toc _INDENT control macros</u></h3></a>
    4747. 

  4747. <p>
    4748. 

  4748. The toc control macros that end in _INDENT all take a single
    4749. 

  4749. argument that requires a
    4750. 

  4750. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
    4751. 

  4751. The argument is the distance to indent the entry, always measured
    4752. 

  4752. from the left margin.  For example,
    4753. 

  4753. <p>
    4754. 

  4754. <pre>
    4755. 

  4755. 	.TOC_HEAD_INDENT 2P
    4756. 

  4756. </pre>
    4757. 

  4757. 

  4758. indents head entries 2
    4759. 

  4759. <a href="definitions.html#TERMS_PICASPOINTS">picas</a>
    4760. 

  4760. from the left margin.
    4761. 

  4761. <p>
    4762. 

  4762. 

  4763. <a name="TOC_TITLE"><h3><u>*Changing the style for toc title entries</u></h3></a>
    4764. 

  4764. <p>
    4765. 

  4765. (See
    4766. 

  4766. <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
    4767. 

  4767. <p>
    4768. 

  4768. Toc title entries are the titles of documents that have been
    4769. 

  4769. <a href="rectoverso.html#COLLATE">collated</a>
    4770. 

  4770. together.
    4771. 

  4771. <p>
    4772. 

  4772. <pre>
    4773. 

  4773. 	.TOC_TITLE_FAMILY  default = prevailing doc family (Times Roman in TYPEWRITE)
    4774. 

  4774. 	.TOC_TITLE_FONT    default = bold italic
    4775. 

  4775. 	.TOC_TITLE_SIZE    default = +0
    4776. 

  4776. 	.TOC_TITLE_INDENT  default = 0 for TYPESET and TYPEWRITE
    4777. 

  4777. </pre>
    4778. 

  4778. 

  4779. <a name="TOC_HEAD"><h3><u>*Changing the style for toc head entries</u></h3></a>
    4780. 

  4780. <p>
    4781. 

  4781. (See
    4782. 

  4782. <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
    4783. 

  4783. <p>
    4784. 

  4784. Toc head entries are main heads that appear in the body of a
    4785. 

  4785. document.
    4786. 

  4786. <p>
    4787. 

  4787. <pre>
    4788. 

  4788. 	.TOC_HEAD_FAMILY  default = prevailing doc family (Times Roman in TYPEWRITE)
    4789. 

  4789. 	.TOC_HEAD_FONT    default = bold
    4790. 

  4790. 	.TOC_HEAD_SIZE    default = +.5
    4791. 

  4791. 	.TOC_HEAD_INDENT  default = 18p for TYPESET; 2m for TYPEWRITE
    4792. 

  4792. </pre>
    4793. 

  4793. 

  4794. <a name="TOC_SUBHEAD"><h3><u>*Changing the style for toc subhead entries</u></h3></a>
    4795. 

  4795. <p>
    4796. 

  4796. (See
    4797. 

  4797. <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
    4798. 

  4798. <p>
    4799. 

  4799. Toc subhead entries are subheads that appear in the body of a
    4800. 

  4800. document.
    4801. 

  4801. <p>
    4802. 

  4802. <pre>
    4803. 

  4803. 	.TOC_SUBHEAD_FAMILY  default = prevailing doc family (Times Roman in TYPEWRITE)
    4804. 

  4804. 	.TOC_SUBHEAD_FONT    default = roman
    4805. 

  4805. 	.TOC_SUBHEAD_SIZE    default = +0
    4806. 

  4806. 	.TOC_SUBHEAD_INDENT  default = 30p for TYPESET; 4m for TYPEWRITE
    4807. 

  4807. </pre>
    4808. 

  4808. 

  4809. <a name="TOC_PARAHEAD"><h3><u>*Changing the style for toc paragraph head entries</u></h3></a>
    4810. 

  4810. <p>
    4811. 

  4811. (See
    4812. 

  4812. <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
    4813. 

  4813. <p>
    4814. 

  4814. Toc paragraph head entries are paragraph heads that appear in the
    4815. 

  4815. body of a document.
    4816. 

  4816. <p>
    4817. 

  4817. <pre>
    4818. 

  4818. 	.TOC_PARAHEAD_FAMILY  default = prevailing doc family (Times Roman in TYPEWRITE)
    4819. 

  4819. 	.TOC_PARAHEAD_FONT    default = italic
    4820. 

  4820. 	.TOC_PARAHEAD_SIZE    default = +0
    4821. 

  4821. 	.TOC_PARAHEAD_INDENT  default = 42p for TYPESET; 6m for TYPEWRITE
    4822. 

  4822. </pre>
    4823. 

  4823. 

  4824. <a name="TOC_PN"><h3><u>*Changing the style for toc paragraph page number listings</u></h3></a>
    4825. 

  4825. <p>
    4826. 

  4826. (See
    4827. 

  4827. <a href="#CONTROL_MACRO_ARGS">arguments to the control macros</a>).
    4828. 

  4828. <p>
    4829. 

  4829. Toc paragraph head entries are paragraph heads that appear in the
    4830. 

  4830. body of a document.
    4831. 

  4831. <p>
    4832. 

  4832. <pre>
    4833. 

  4833. 	.TOC_PN_FAMILY  default = prevailing doc family (Times Roman in TYPEWRITE)
    4834. 

  4834. 	.TOC_PN_FONT    default = roman
    4835. 

  4835. 	.TOC_PN_SIZE    default = +0
    4836. 

  4836. </pre>
    4837. 

  4837. 

  4838. <a name="TOC_ADDITIONAL"><h2><u>5. Additional toc macros</u></h2></a>
    4839. 

  4839. <p>
    4840. 

  4840. The following macros allow you to switch page margins should
    4841. 

  4841. they be incorrect for recto/verso printing, to establish how
    4842. 

  4842. many placeholders to leave for page listings, and to have
    4843. 

  4843. <strong>mom</strong> append author(s) to toc title entries.
    4844. 

  4844. <p>
    4845. 

  4845. 

  4846. <hr width="33%" align="left">
    4847. 

  4847. 

  4848. <!---TOC_RV_SWITCH--->
    4849. 

  4849. 

  4850. <p>
    4851. 

  4851. <a name="TOC_RV_SWITCH">
    4852. 

  4852. 	Macro: <strong>TOC_RV_SWITCH</strong>
    4853. 

  4853. </a>
    4854. 

  4854. <p>
    4855. 

  4855. <strong>TOC_RV_SWITCH</strong> doesn't take an argument.  It simply
    4856. 

  4856. instructs <strong>mom</strong> to switch the left and right margins
    4857. 

  4857. of
    4858. 

  4858. <a href="rectoverso.html#RECTO_VERSO">recto/verso</a>
    4859. 

  4859. documents should the toc happen to begin on an even page when you
    4860. 

  4860. want an odd, or vice versa.
    4861. 

  4861. <p>
    4862. 

  4862. The same result can be accomplished by outputting a
    4863. 

  4863. <a href="#BLANK_PAGE">BLANKPAGE</a>.
    4864. 

  4864. <p>
    4865. 

  4865. 

  4866. <hr width="33%" align="left">
    4867. 

  4867. 

  4868. <!---TOC_TITLE_ENTRY--->
    4869. 

  4869. 

  4870. <p>
    4871. 

  4871. <a name="TOC_TITLE_ENTRY">
    4872. 

  4872. 	<nobr>Macro: <strong>TOC_TITLE_ENTRY</strong> &lt;&quot;alternate wording for a title entry in the toc&quot;&gt;</nobr>
    4873. 

  4873. </a>
    4874. 

  4874. <p>
    4875. 

  4875. In 
    4876. 

  4876. <a href="rectoverso.html#COLLATE">collated</a>
    4877. 

  4877. documents, the title of each separate document appears in the table
    4878. 

  4878. of contents.  It may sometimes happen that you don't want the title
    4879. 

  4879. as it appears in the toc to be the same as what appears in
    4880. 

  4880. the
    4881. 

  4881. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>.
    4882. 

  4882. You might, for example, want to shorten it.  Or, in the case of
    4883. 

  4883. chapters where the docheader contains both a chapter number and a
    4884. 

  4884. chapter title, like this
    4885. 

  4885. <p>
    4886. 

  4886. <pre>
    4887. 

  4887. 	           Chapter 6
    4888. 

  4888. 	Burning Bush -- Maybe God Was Right
    4889. 

  4889. </pre>
    4890. 

  4890. 

  4891. you might want only the chapter title, not the chapter number, to
    4892. 

  4892. show up in the toc.  (By default, <strong>TOC</strong> generates
    4893. 

  4893. both.)
    4894. 

  4894. <p>
    4895. 

  4895. If you want to change the wording of a title entry in the toc,
    4896. 

  4896. simply invoke <strong>TOC_TITLE_ENTRY</strong> with the desired
    4897. 

  4897. wording, enclosed in double-quotes.  Using the example, above,
    4898. 

  4898. <p>
    4899. 

  4899. <pre>
    4900. 

  4900. 	.CHAPTER 6
    4901. 

  4901. 	.CHAPTER_TITLE "Burning Bush -- Maybe God Was Right"
    4902. 

  4902. 	.TOC_TITLE_ENTRY "Burning Bush"
    4903. 

  4903. 	.DOCTYPE CHAPTER
    4904. 

  4904. </pre>
    4905. 

  4905. 

  4906. would identify chapter 6 in the toc simply as &quot;Burning
    4907. 

  4907. Bush&quot;.
    4908. 

  4908. 

  4909. <p>
    4910. 

  4910. 

  4911. <hr width="33%" align="left">
    4912. 

  4912. 

  4913. <!---TOC_APPENDS_AUTHOR--->
    4914. 

  4914. 

  4915. <p>
    4916. 

  4916. <a name="TOC_APPENDS_AUTHOR">
    4917. 

  4917. 	<nobr>Macro: <strong>TOC_APPENDS_AUTHOR</strong> &lt;none&gt; | &lt;&quot;name(s) of authors&quot;&gt;</nobr>
    4918. 

  4918. </a>
    4919. 

  4919. <p>
    4920. 

  4920. In certain kinds of collated documents, different authors are
    4921. 

  4921. responsible for the articles or stories contained within them.  In
    4922. 

  4922. such documents, you may wish to have the author or authors
    4923. 

  4923. appended to the toc's title entry for each story or article.
    4924. 

  4924. <p>
    4925. 

  4925. If you invoke <strong>TOC_APPENDS_AUTHOR</strong> with no argument,
    4926. 

  4926. <strong>mom</strong> appends the first argument you passed to
    4927. 

  4927. <a href="docprocessing.html#AUTHOR">AUTHOR</a>
    4928. 

  4928. to toc title entries, separated by a front-slash.
    4929. 

  4929. <p>
    4930. 

  4930. If you invoke <strong>TOC_APPENDS_AUTHOR</strong> with an argument
    4931. 

  4931. (surrounded by double-quotes), <strong>mom</strong> will append it
    4932. 

  4932. to the toc title entries instead.  This is useful if you have
    4933. 

  4933. multiple authors you wish to identify by last name only.  For
    4934. 

  4934. example, if three authors--Joe Blough, Jane Doe, and John
    4935. 

  4935. Deere--are responsible for a single article
    4936. 

  4936. <p>
    4937. 

  4937. <pre>
    4938. 

  4938. 	.TOC_APPENDS_AUTHOR "Blough et al."
    4939. 

  4939. </pre>
    4940. 

  4940. 

  4941. would be a good way to identify them in the toc.
    4942. 

  4942. <p>
    4943. 

  4943. 

  4944. <hr width="33%" align="left">
    4945. 

  4945. 

  4946. <!---TOC_PADDING--->
    4947. 

  4947. 

  4948. <p>
    4949. 

  4949. <a name="TOC_PADDING">
    4950. 

  4950. 	<nobr>Macro: <strong>TOC_PADDING</strong> &lt;# of placeholders to allow for page number listings&gt;</nobr>
    4951. 

  4951. </a>
    4952. 

  4952. <p>
    4953. 

  4953. By default, <strong>mom</strong> allows room for 3 digits in the
    4954. 

  4954. page number listings of tocs.  If you'd like some other number of
    4955. 

  4955. placeholders, say 2, do
    4956. 

  4956. <p>
    4957. 

  4957. <pre>
    4958. 

  4958. 	.TOC_PADDING 2
    4959. 

  4959. </pre>
    4960. 

  4960. 

  4961. <!---FINIS--->
    4962. 

  4962. 

  4963. <hr width="66%" align="left">
    4964. 

  4964. <p>
    4965. 

  4965. <a name="FINIS">
    4966. 

  4966. 	Macro: <strong>FINIS</strong>
    4967. 

  4967. </a>
    4968. 

  4968. 

  4969. <p>
    4970. 

  4970. The use of <strong>FINIS</strong> is optional, but if you use
    4971. 

  4971. it, it should be the last macro you invoke in a document (before
    4972. 

  4972. <a href="#ENDNOTES">ENDNOTES</a>
    4973. 

  4973. or
    4974. 

  4974. <a href="#TOC">TOC</a>).
    4975. 

  4975. See
    4976. 

  4976. <a href="#FINIS_INTRO">above</a>
    4977. 

  4977. for a description of how <strong>FINIS</strong> behaves.
    4978. 

  4978. <p>
    4979. 

  4979. <strong>NOTE:</strong> If you don't use <strong>FINIS</strong>,
    4980. 

  4980. and you don't want
    4981. 

  4981. <a href="definitions.html#TERMS_FOOTER">footers</a>
    4982. 

  4982. (if they're on) or a page number at the bottom of the last page of
    4983. 

  4983. a document, you have to turn them off manually, as the last two
    4984. 

  4984. lines of your document file, like this:
    4985. 

  4985. <p>
    4986. 

  4986. <pre>
    4987. 

  4987. 	.FOOTERS OFF
    4988. 

  4988. 	.PAGINATE OFF
    4989. 

  4989. </pre>
    4990. 

  4990. 

  4991. <a name="FINIS_STRING"><h3><u>Changing the FINIS string</u></h3></a>
    4992. 

  4992. 

  4993. <p>
    4994. 

  4994. By default, <strong>FINIS</strong> prints the word
    4995. 

  4995. END between
    4996. 

  4996. <a href="definitions.html#TERMS_EM">em-dashes</a>.
    4997. 

  4997. If you'd like <strong>mom</strong> to print something else
    4998. 

  4998. between the dashes, use the <strong>FINIS_STRING</strong> macro
    4999. 

  4999. (anywhere in the document prior to <strong>FINIS</strong>).
    5000. 

  5000. <p>
    5001. 

  5001. For example, if your document's in French, you'd do
    5002. 

  5002. <p>
    5003. 

  5003. <pre>
    5004. 

  5004. 	.FINIS_STRING "FIN"
    5005. 

  5005. </pre>
    5006. 

  5006. 

  5007. Double-quotes must enclose the macro's argument.
    5008. 

  5008. <p>
    5009. 

  5009. <strong>NOTE:</strong> If you pass <strong>FINIS_STRING</strong>
    5010. 

  5010. a blank string, i.e.
    5011. 

  5011. <p>
    5012. 

  5012. <pre>
    5013. 

  5013. 	.FINIS_STRING ""
    5014. 

  5014. </pre>
    5015. 

  5015. 

  5016. <strong>mom</strong> will still print the em-dashes if you
    5017. 

  5017. invoke <strong>FINIS</strong>.  This, in effect, produces a
    5018. 

  5018. short, centred horizontal rule that terminates the document.
    5019. 

  5019. (In
    5020. 

  5020. <a href="docprocessing.html.#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
    5021. 

  5021. it's a short, dashed line composed of four hyphens.)
    5022. 

    5023. 

  5023. <a name="FINIS_COLOR"><h3><u>Changing the FINIS colour</u></h3></a>
    5024. 

  5024. <p>
    5025. 

  5025. Invoking <strong>FINIS_COLOR</strong> with a pre-defined (or
    5026. 

  5026. &quot;initalized&quot;) color changes the colour of both the FINIS
    5027. 

  5027. string and the em-dashes that surround it.  If you use the
    5028. 

  5028. <a href="definitions.html#TERMS_INLINE">inline escape</a>,
    5029. 

  5029. <a href="color.html#COLOR_INLINE">\*[&lt;colorname&gt;]</a>,
    5030. 

  5030. in the argument passed to <strong>FINIS</strong>, only the text
    5031. 

  5031. will be in the new colour; the em-dashes will be in the default
    5032. 

  5032. document colour (usually black).
    5033. 

  5033. 

  5034. <p>
    5035. 

  5035. <hr>
    5036. 

  5036. <a href="headfootpage.html#TOP">Next</a>&nbsp;&nbsp;
    5037. 

  5037. <a href="docprocessing.html#TOP">Prev</a>&nbsp;&nbsp;
    5038. 

  5038. <a href="#TOP">Top</a>&nbsp;&nbsp;
    5039. 

  5039. <a href="toc.html">Back to Table of Contents</a>
    5040. 

  5040. </body>
    5041. 

  5041. </html>
    5042. 

  5042.