/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

Large files are truncated click here to view the full file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
  5. <title>Mom -- Document Processing, element tags</title>
  6. </head>
  7. <body bgcolor="#dfdfdf">
  8. <!====================================================================>
  9. <a href="headfootpage.html#TOP">Next</a>&nbsp;&nbsp;
  10. <a href="docprocessing.html#TOP">Prev</a>&nbsp;&nbsp;
  11. <a href="toc.html">Back to Table of Contents</a>
  12. <p>
  13. <a name="TOP"></a>
  14. <a name="DOCELEMENT">
  15. <h1 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h1>
  16. </a>
  17. <ul>
  18. <li><a href="#DOCELEMENT_INTRO">Introduction to the document element tags</a>
  19. <ul>
  20. <li><a href="#DOCELEMENT_CONTROL">Control macros -- changing defaults for document element tags</a>
  21. <li><a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
  22. </ul>
  23. <li><a href="#INDEX_DOCELEMENT">Index of document element tags</a>
  24. </ul>
  25. <a name="DOCELEMENT_INTRO">
  26. <h2><u>Introduction to the document element tags</u></h2>
  27. </a>
  28. Once you've completed the setup for a document (see
  29. <a href="docprocessing.html#DOCPROCESSING_TUT">Setting up a mom document</a>),
  30. formatting it is a snap. Simply invoke the appropriate tag for
  31. each document element as you need it. The tags are macros that
  32. tell <strong>mom</strong>, &quot;This is a paragraph, this
  33. is a subhead, this is a footnote,&quot; and so on.
  34. <p>
  35. The list of tags is actually quite small -- ideal for the users
  36. <strong>mom</strong> brought herself into being for (see
  37. <a href="intro.html#INTRO_INTRO">Who mom is meant for</a>).
  38. However, the list of macros that control the appearance of the
  39. tags upon output is extensive. Generally, for each tag,
  40. there are
  41. <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>
  42. for the tag's family, font and point size. Where appropriate, there
  43. are macros to control leading, indents, quad and special features
  44. as well.
  45. <p>
  46. <strong>Mom</strong> has tasteful defaults for all the tags, hence you
  47. only use the control macros when you want to change the way
  48. she does things. This is usually done prior to
  49. <a href="docprocessing.html#START">START</a>,
  50. but can, in fact, be done at any time in the course of a document.
  51. Any change to a tag's style affects all subsequent invocations of
  52. the tag.
  53. <p>
  54. <a name="DOCELEMENT_CONTROL"><h3><u>Control macros -- changing defaults</u></h3></a>
  55. <p>
  56. The control macros for document processing tags let you
  57. &quot;design&quot; the look of all the parts of your documents --
  58. should you wish. At a bare minimum, all tags have macros to change
  59. <strong>mom</strong>'s defaults for family, font, point size and
  60. colour. Where appropriate, there are macros to control leading,
  61. indents and quad as well.
  62. <p>
  63. In addition, many tags have special macros to control features that
  64. are pertinent to those tags alone. Have a look at the section dealing
  65. with any particular tag to find out what macros control the tag,
  66. and what <strong>mom</strong>'s defaults for the tag are.
  67. <p>
  68. The control macros may be used at any time during the course of
  69. a document (i.e. before or after
  70. <a href="docprocessing.html#START">START</a>). The changes you
  71. make alter all subsequent invocations of the affected tag until
  72. you make another change, either by passing new arguments to the
  73. tag's control macro, or toggling a particular feature of the tag on
  74. or off.
  75. <p>
  76. And don't forget: the
  77. <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
  78. can be used at any time, including inside
  79. <a href="definitions.html#TERMS_TOGGLE">toggle</a>
  80. tags (affecting only that particular invocation of the tag).
  81. Equally,
  82. <a href="definitions.html#TERMS_INLINES">inline escapes</a>
  83. can be used in tags that take
  84. <a href="definitions.html#TERMS_STRINGARGUMENT">string arguments.</a>
  85. <p>
  86. <strong>IMPORTANT NOTE:</strong> The family, font, point size,
  87. colour and leading control macros have no effect in
  88. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  89. which sets EVERYTHING in Courier roman, 12/24 (i.e. 12-point type on
  90. a linespace of 24 points).
  91. <p>
  92. Please also note that the defaults listed
  93. with the control macros apply only to
  94. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
  95. unless a default for <strong>TYPEWRITE</strong> is also given.
  96. <p>
  97. <strong>A WORD OF ADVICE:</strong> Get familiar with
  98. <strong>mom</strong> at her default settings before exploring the
  99. control macros. Put her through her paces. See how she behaves.
  100. Get to know what she feels like and how she looks, both in your text
  101. editor and on the printed page. Then, if you don't like something,
  102. use this documentation to find the precise macro you need to change it.
  103. There are tons of control macros. Reading up on them and trying to
  104. remember them all might lead you to think that <strong>mom</strong>
  105. is complex and unwieldy, which is not only untrue, but would offend
  106. her mightily.
  107. <p>
  108. <a name="CONTROL_MACRO_ARGS"><h3><u>Arguments to the control macros</u></h3></a>
  109. <h3>Family and font</h3>
  110. The arguments to the control macros that end in
  111. <strong>_FAMILY</strong> or <strong>_FONT</strong> are the same
  112. as for
  113. <a href="typesetting.html#FAMILY">FAMILY</a>
  114. and
  115. <a href="typesetting.html#FONT">FT</a>.
  116. <h3>Point size</h3>
  117. Control macros that end in <strong>_SIZE</strong> always take
  118. the form <kbd>+digit</kbd> or <kbd>-digit</kbd> where digit is
  119. the number of
  120. <a href="definitions.html#TERMS_PICASPOINTS">points</a>
  121. larger (+) or smaller (-) than the point size of paragraphs
  122. you want the document element to be. For example, to change
  123. subheads to 1-1/2 points larger than the type in paragraphs, do
  124. <p>
  125. <pre>
  126. .SUBHEAD_SIZE +1.5
  127. </pre>
  128. There's no need for a
  129. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
  130. with the <strong>_SIZE</strong> control macros; points is assumed.
  131. <h3>Colour</h3>
  132. Control macros that end in <strong>_COLOR</strong> take as their
  133. argument a colour name pre-defined (or &quot;initialized&quot;)
  134. with
  135. <a href="color.html#NEWCOLOR">NEWCOLOR</a>
  136. or
  137. <a href="color.html#XCOLOR">XCOLOR</a>.
  138. For example, if you want your heads to be red, once you've defined
  139. or initialized the color, red,
  140. <p>
  141. <pre>
  142. .HEAD_COLOR red
  143. </pre>
  144. will turn your heads red.
  145. <h3>Lead/linespacing</h3>
  146. Control macros that end in <strong>_AUTOLEAD</strong> take the
  147. same argument as
  148. <a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>,
  149. viz. a digit that represents the number of points to add to the
  150. tag's point size to arrive at its
  151. <a href="definitions.html#TERMS_LEADING">lead</a>.
  152. For example, to set footnotes
  153. <a href="definitions.html#TERMS_SOLID">solid</a>, do
  154. <p>
  155. <pre>
  156. .FOOTNOTE_AUTOLEAD 0
  157. </pre>
  158. To set footnotes with a 1-point lead (i.e. with the line spacing
  159. one point greater than the footnote's point size), do
  160. <p>
  161. <pre>
  162. .FOOTNOTE_AUTOLEAD 1
  163. </pre>
  164. <h3><a name="CONTROL_INDENTS">Indents</a></h3>
  165. Except for <strong>PARA_INDENT</strong>, the argument to the control
  166. macros that end
  167. in <strong>_INDENT</strong> is always a single digit (whole numbers
  168. only; no decimal fractions) with no
  169. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
  170. appended to it. The digit represents by how much you want the
  171. size of the paragraph first-line indent multiplied to achieve the
  172. correct indent for a particular tag.
  173. <h3>Quad/justification style</h3>
  174. Control macros that end in <strong>_QUAD</strong> take the same
  175. arguments as
  176. <a href="typesetting.html#QUAD">QUAD</a>.
  177. <p>
  178. <hr>
  179. <a name="INDEX_DOCELEMENT"><h3><u>Document element tags list</u></h3></a>
  180. <ul>
  181. <li><a href="#EPIGRAPH_INTRO">Epigraphs</a>
  182. <ul>
  183. <li><a href="#EPIGRAPH">EPIGRAPH</a>
  184. <li><a href="#EPIGRAPH_CONTROL">Epigrah control</a>
  185. </ul>
  186. <li><a href="#PP_INTRO">Paragraphs</a>
  187. <ul>
  188. <li><a href="#PP">PP</a>
  189. <li><a href="#PP_CONTROL">Paragraph control</a>
  190. </ul>
  191. <li><a href="#HEAD_INTRO">Main heads</a>
  192. <ul>
  193. <li><a href="#HEAD">HEAD</a>
  194. <li><a href="#HEAD_CONTROL">Head control</a>
  195. </ul>
  196. <li><a href="#SUBHEAD_INTRO">Subheads</a>
  197. <ul>
  198. <li><a href="#SUBHEAD">SUBHEAD</a>
  199. <li><a href="#SUBHEAD_CONTROL">Subhead control</a>
  200. </ul>
  201. <li><a href="#PARAHEAD_INTRO">Paragraph heads</a>
  202. <ul>
  203. <li><a href="#PARAHEAD">PARAHEAD</a>
  204. <li><a href="#PARAHEAD_CONTROL">Parahead control</a>
  205. </ul>
  206. <li><a href="#LINEBREAK_INTRO">Linebreaks (author linebreaks, section breaks)</a>
  207. <ul>
  208. <li><a href="#LINEBREAK">LINEBREAK</a>
  209. <li><a href="#LINEBREAK_CHAR">Linebreak character</a>
  210. <li><a href="#LINEBREAK_COLOR">Linebreak colour</a>
  211. </ul>
  212. <li><a href="#QUOTE_INTRO">Quotes (line for line)</a>
  213. <ul>
  214. <li><a href="#QUOTE">QUOTE</a>
  215. <li><a href="#QUOTE_CONTROL">Quote control</a>
  216. </ul>
  217. <li><a href="#BLOCKQUOTE_INTRO">Blockquotes (cited material)</a>
  218. <ul>
  219. <li><a href="#BLOCKQUOTE">BLOCKQUOTE</a>
  220. <li><a href="#BLOCKQUOTE_CONTROL">Blockquote control</a>
  221. </ul>
  222. <li><a href="#LIST_INTRO">Nested lists</a>
  223. <ul>
  224. <li><a href="#LIST">LIST</a>
  225. <ul>
  226. <li><a href="#ITEM">ITEM</a>
  227. </ul>
  228. <li><a href="#LIST_CONTROL">List control</a>
  229. </ul>
  230. <li><a href="#NUMBER_LINES_INTRO">Line numbering</a>
  231. <ul>
  232. <li><a href="#NUMBER_LINES">NUMBER_LINES</a>
  233. <li><a href="#NUMBER_LINES_CONTROL">Control macros</a> (for QUOTE and BLOCKQUOTE)
  234. </ul>
  235. <li><a href="#FOOTNOTE_INTRO">Footnotes</a>
  236. <ul>
  237. <li><a href="#FOOTNOTE">FOOTNOTE</a>
  238. <li><a href="#FOOTNOTE_CONTROL">Footnote control</a>
  239. </ul>
  240. <li><a href="#ENDNOTE_INTRO">Endnotes</a>
  241. <ul>
  242. <li><a href="#ENDNOTE">ENDNOTE</a>
  243. <li><a href="#ENDNOTE_CONTROL">Endnote control</a>
  244. </ul>
  245. <li><a href="#MARGIN_NOTES_INTRO">Margin notes</a>
  246. <ul>
  247. <li><a href="#MN_INIT">MN_INIT</a> -- initialize margin notes
  248. <li><a href="#MN">MN</a> -- start and end a margin note
  249. </ul>
  250. <li><a href="refer.html#TOP">Bibliographies and references</a>
  251. <ul>
  252. <li><a href="refer.html#REF">REF</a>
  253. <li><a href="refer.html#ENDNOTE_REFS">ENDNOTE_REFS</a>
  254. <li><a href="refer.html#FOOTNOTE_REFS">FOOTNOTE_REFS</a>
  255. <li><a href="refer.html#BRACKET_REFS">Embedded references</a>
  256. <li><a href="refer.html#BIBLIOGRAPHY">BIBLIOGRAPHY</a>
  257. <li><a href="refer.html#BIBLIOGRAPHY_TYPE">BIBLIOGRAPHY_TYPE</a>
  258. </ul>
  259. <li><a href="#BLANK_PAGE_TITLE">Blank pages</a>
  260. <li><a href="#TOC_INTRO">Table of contents</a>
  261. <ul>
  262. <li><a href="#TOC">TOC</a>
  263. <li><a href="#TOC_CONTROL">Table of contents control</a>
  264. </ul>
  265. <li><a href="#FINIS_INTRO">Document termination</a>
  266. <ul>
  267. <li><a href="#FINIS">FINIS (Document termination)</a>
  268. </ul>
  269. <ul>
  270. <li><a href="#FINIS_STRING">Changing the FINIS string</a>
  271. <li><a href="#FINIS_COLOR">Changing the FINIS colour</a>
  272. </ul>
  273. </ul>
  274. <hr>
  275. <!====================================================================>
  276. <a name="EPIGRAPH_INTRO"><h2><u>Epigraphs</u></h2></a>
  277. <ul>
  278. <li><a href="#EPIGRAPH">Tag: EPIGRAPH</a>
  279. <li><a href="#EPIGRAPH_CONTROL">Epigraph control macros</a>
  280. </ul>
  281. <p>
  282. <a href="definitions.html#TERMS_EPIGRAPH">Epigraphs</a>
  283. colour, flavour, or comment on the document they precede. Typically,
  284. they are centred at the top of a document's first page (underneath the
  285. title) and set in a smaller point size than that of paragraph text.
  286. <p>
  287. By default, <strong>mom</strong> sets epigraphs centred and
  288. <a href="definitions.html#TERMS_NOFILL">unfilled</a>;
  289. this lets you input them on a line for line basis. This behaviour
  290. can be changed to accomodate
  291. <a href="definitions.html#TERMS_FILLED">filled</a>
  292. epigraph &quot;blocks.&quot;
  293. <p>
  294. <!---EPIGRAPH--->
  295. <hr width="66%" align="left">
  296. <p>
  297. <a name="EPIGRAPH">
  298. <nobr>Macro: <strong>EPIGRAPH</strong> &lt;toggle&gt; | [ BLOCK ]</a></nobr>
  299. </a>
  300. <p>
  301. <strong>EPIGRAPH</strong> is a toggle, used like this:
  302. <p>
  303. <pre>
  304. .EPIGRAPH
  305. &lt;text of epigraph&gt;
  306. .EPIGRAPH OFF
  307. </pre>
  308. <strong>OFF</strong>, above, could be anything -- say, Q or X --
  309. since any argument other than <strong>BLOCK</strong> turns it off.
  310. <p>
  311. If given the argument <strong>BLOCK</strong>, <strong>EPIGRAPH</strong>
  312. sets epigraphs
  313. <a href="definitions.html#TERMS_FILLED">filled</a>,
  314. justified or quadded in the same direction as paragraphs, indented
  315. equally from both the left and right margins.
  316. <p>
  317. If a block-style epigraph runs to more than one paragraph (unlikely,
  318. but conceivable), you <strong>MUST</strong> introduce every paragraph
  319. -- <u>INCLUDING THE FIRST!!!</u> -- with the
  320. <a href="#PP">PP</a>
  321. tag.
  322. <p>
  323. <strong>NOTE:</strong> <strong>EPIGRAPH</strong> should only be
  324. used at the top of a document (i.e. just after
  325. <a href="docprocessing.html#START">START</a>)
  326. or after
  327. <a href="#HEAD_INTRO">heads</a>. The latter is not especially
  328. recommended, but it does work. In all other places where you
  329. want quotes or cited text, use
  330. <a href="#QUOTE">QUOTE</a>
  331. or
  332. <a href="#BLOCKQUOTE">BLOCKQUOTE</a>.
  333. <p>
  334. <a name="EPIGRAPH_CONTROL"><h3><u>Epigraph control macros</u></h3></a>
  335. <p>
  336. See
  337. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
  338. <p>
  339. <pre>
  340. .EPIGRAPH_FAMILY default = prevailing document family; default is Times Roman
  341. .EPIGRAPH_FONT default = roman
  342. .EPIGRAPH_SIZE default = -1.5 (points)
  343. .EPIGRAPH_COLOR default = black
  344. .EPIGRAPH_AUTOLEAD default = 2 points
  345. (The next two apply to &quot;block&quot; style epigraphs only)
  346. .EPIGRAPH_QUAD default = same as paragraphs
  347. .EPIGRAPH_INDENT* default = para indent x 3 (for typeset), x 2 (for typewrite)
  348. *Indent here refers to the indent from both the left and right margins
  349. that centres the block style epigraph on the page.
  350. </pre>
  351. <hr>
  352. <!====================================================================>
  353. <a name="PP_INTRO"><h2><u>Paragraphs</u></h2></a>
  354. <ul>
  355. <li><a href="#PP">Tag: PP</a>
  356. <li><a href="#PP_CONTROL">Paragraph control macros</a>
  357. </ul>
  358. <p>
  359. The paragraph macro is the one you use most often. Consequently,
  360. it's one of most powerful, yet simplest to use -- just the letters
  361. <strong>PP</strong>. No arguments, nothing. Just <kbd>.PP</kbd>
  362. on a line by itself any time, in any document element, tells
  363. <strong>mom</strong> you want to start a new paragraph. The spacing
  364. and indent appropriate to where you are in your document are taken
  365. care of automatically.
  366. <p>
  367. By default, <strong>mom</strong> does not indent the first paragraph
  368. of a document, nor paragraphs that fall immediately after
  369. <a href="#HEAD_INTRO">heads</a>
  370. or
  371. <a href="#SUBHEAD_INTRO">subheads</a>.
  372. The first paragraphs of blockquotes and block-style epigraphs are
  373. also not indented. This behaviour can be changed with the control
  374. macro
  375. <a href="#PARA_INDENT_FIRST">INDENT_FIRST_PARAS</a>.
  376. <p>
  377. In contrast to some other macro packages, <strong>mom</strong> does not
  378. deposit a blank line between paragraphs. If you want her to do so, use
  379. the control macro <strong>PARA_SPACE</strong>. (I don't recommend
  380. using this macro with
  381. <a href="typesetting.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.)
  382. <p>
  383. Note that <strong>mom</strong> does not provide &quot;orphan
  384. control&quot; for paragraphs (i.e. even if only one line of a paragraph
  385. fits at the bottom of a page, she will set it on that page). The
  386. reason for this is that writers of fiction often have single-line
  387. paragraphs (e.g. in dialogue). Groff's simplistic orphan control
  388. will break these one-liners -- if they fall at the bottom of the page
  389. -- to a new page, which is not what you want.
  390. <p>
  391. <strong>TIP:</strong> The last thing you want while you're writing
  392. and editing drafts of a document (particularly stories and chapters)
  393. is a text file cluttered up with <strong>PP</strong>'s. The visual
  394. interruption in the flow of text is a serious obstacle to creativity
  395. and critiquing.
  396. <p>
  397. I use the tab key on my keyboard to indent paragraphs when I'm writing,
  398. producing a text file that looks pretty much like what you see on
  399. a printed page. When it comes time to format and print the file,
  400. I run it through a sed script that (amongst other things) converts
  401. the character generated by the tab key (<kbd>^I</kbd>) into <code>.PP</code>
  402. (plus a new line), and pipe the output to groff for processing and
  403. printing.
  404. <p>
  405. Another solution is to insert a blank line between paragraphs.
  406. The blank lines can then be sedded out at print time as above, or,
  407. more conveniently, you can use the <code>.blm</code>
  408. <a href="definitions.html#TERMS_PRIMITIVES">primitive</a>
  409. (blank line macro) to instruct groff (and <strong>mom</strong>)
  410. that blank lines should be interpreted as <strong>PP</strong>'s.
  411. <p>
  412. <pre>
  413. .blm PP
  414. </pre>
  415. tells groff that all blank lines are really the macro <strong>PP</strong>.
  416. <p>
  417. <!---PP--->
  418. <hr width="66%" align="left">
  419. <p>
  420. <a name="PP">
  421. Macro: <strong>PP</strong>
  422. </a>
  423. <p>
  424. <strong>PP</strong> (on a line by itself, of course) tells mom to
  425. start a new paragraph. See
  426. <a href="#PP_INTRO">above</a>
  427. for more details. In addition to regular text paragraphs, you can
  428. use <strong>PP</strong> in
  429. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
  430. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
  431. and
  432. <a href="#FOOTNOTE_INTRO">footnotes</a>.
  433. <a name="PP_CONTROL"><h3><u>Paragraph control macros</u></h3></a>
  434. <p>
  435. The <strong>PP</strong> being so important, and representing, as
  436. it were, the basis of everything that goes on in a document, its
  437. control is managed in a manner somewhat different from other document
  438. element tags.
  439. <p>
  440. <ol>
  441. <li><a href="#PP_FAMILY">Family control</a>
  442. <li><a href="#PP_FONT">Font control</a>
  443. <li><a href="#PP_COLOR">Paragraph colour</a>
  444. <li><a href="#PP_LEADING">Leading/linespacing control</a>
  445. <li><a href="#PP_JUST_QUAD">Justification/quad control</a>
  446. <li><a href="#PARA_INDENT">First-line indent control</a>
  447. <li><a href="#PARA_INDENT_FIRST">Initial paragraphs indent control</a>
  448. <li><a href="#PP_SPACE">Paragraph spacing control</a>
  449. </ol>
  450. <a name="PP_FAMILY"><h3><u>1. Family</u></h3></a>
  451. <p>
  452. The paragraph
  453. <a href="definitions.html#TERMS_FAMILY">family</a>
  454. is set with
  455. <a href="typesetting.html#FAMILY">FAMILY</a>
  456. prior to
  457. <a href="docprocessing.html#START">START</a>,
  458. or
  459. <a href="docprocessing.html#DOC_FAMILY">DOC_FAMILY</a>
  460. afterwards. Please note that both globally affect the family of
  461. every element in the document.
  462. <p>
  463. If you wish to change the family for regular
  464. text paragraphs only, invoke <strong>FAMILY</strong> immediately
  465. after <strong>PP</strong> in EVERY paragraph whose family you wish
  466. to differ from the prevailing document family.
  467. <p>
  468. <strong>Mom</strong>'s default paragraph (and document) family
  469. is Times Roman.
  470. <p>
  471. <a name="PP_FONT"><h3><u>2. Font -- PP_FONT</u></h3></a>
  472. <p>
  473. To change the
  474. <a href="definitions.html#TERMS_FONT">font</a>
  475. used in regular text paragraphs, use <code>.PP_FONT</code>,
  476. which takes the same argument as
  477. <a href="typesetting.html#FONT">FT</a>.
  478. <strong>PP_FONT</strong> may be used before or after
  479. <a href="docprocessing.html#START">START</a>.
  480. Only regular text paragraphs are affected; paragraphs in
  481. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
  482. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
  483. and
  484. <a href="#FOOTNOTE_INTRO">footnotes</a>
  485. remain at their default setting (medium roman) unless you change them
  486. with the appropriate control macros.
  487. <p>
  488. <strong>Mom</strong>'s default paragraph font is medium roman.
  489. <p>
  490. <a name="PP_COLOR"><h3><u>3. Paragraph colour</u></h3></a>
  491. <p>
  492. <strong>Mom</strong> has no special control macro for colourizing
  493. paragraphs. If you wish a colourized paragraph, you must use the
  494. macro,
  495. <a href="color.html#COLOR">COLOR</a>,
  496. or the
  497. <a href="definitions.html#TERMS_INLINE">inline escape</a>,
  498. <a href="color.html#COLOR_INLINE">\*[&lt;colorname&gt;]</a>,
  499. <em>after</em> <strong>.PP</strong>. The colour must be one
  500. pre-defined (or &quot;initialized&quot;) with
  501. <a href="color.html#NEWCOLOR">NEWCOLOR</a>
  502. or
  503. <a href="color.html#XCOLOR">XCOLOR</a>.
  504. <p>
  505. Please note that unless you change the colour back to it's default
  506. (usually black) at the end of the paragraph, all subsequent
  507. paragraphs will be set in the new colour, although most other
  508. elements of your document will continue to be set in the default
  509. colour (usually black).
  510. <p>
  511. For example, assuming you have defined the colour, blue,
  512. <p>
  513. <pre>
  514. .PP
  515. .COLOR blue
  516. &lt;first paragraph&gt;
  517. .HEAD "Monty Python"
  518. .SUBHEAD "The Origins of Spam"
  519. .PP
  520. &lt;second paragraph&gt;
  521. </pre>
  522. the first paragraph will be blue, the head and subhead will be in
  523. the document's default colour (usually black), and the second
  524. paragraph will be in blue.
  525. <p>
  526. The one document element that is affected by changing the colour
  527. of paragraphs are
  528. <a href="#PARAHEAD">paraheads</a>,
  529. since they are attached directly to the body of paragraphs. In
  530. other words, if you change the colour of a paragraph and do not
  531. reset the paragraph colour back to its default, subsequent paraheads
  532. will appear in the same colour as your paragraphs unless you have
  533. explicitly told <strong>mom</strong> you want a pre-defined (or
  534. &quot;initialized&quot;) color (usually black) for your paraheads.
  535. <p>
  536. See the footnote to
  537. <a href="#PARAHEAD_COLOR">.PARAHEAD_COLOR</a>.
  538. <a name="PP_LEADING"><h3><u>4. Leading</u></h3></a>
  539. <p>
  540. The paragraph
  541. <a href="definitions.html#TERMS_LEADING">leading</a>
  542. is set with
  543. <a href="typesetting.html#LEADING">LS</a>
  544. prior to
  545. <a href="docprocessing.html#START">START</a>,
  546. or
  547. <a href="docprocessing.html#DOC_LEAD">DOC_LEAD</a>
  548. afterwards. Please note that either method globally affects the
  549. leading and spacing of every document element (except
  550. <a href="definitions.html#TERMS_HEADER">headers</a>
  551. and
  552. <a href="definitions.html#TERMS_FOOTER">footers</a>).
  553. <p>
  554. If you wish to change the leading of regular text paragraphs only,
  555. invoke <strong>LS</strong> immediately after <strong>PP</strong> in
  556. EVERY paragraph whose leading you wish to change.
  557. <p>
  558. <strong>HYPER-IMPORTANT NOTE:</strong> It is extremely unwise to change
  559. paragraph leading with <strong>LS</strong>, as it will, in all cases,
  560. screw up <strong>mom</strong>'s ability to balance the bottom margin
  561. of pages. Should you absolutely need to change paragraph leading
  562. with <strong>LS</strong>, and subsequently want <strong>mom</strong>
  563. to get back on the right leading track, use the
  564. <a href="docprocessing.html#SHIM">SHIM</a>
  565. macro.
  566. <p>
  567. <strong>Mom</strong>'s default paragraph leading (document leading)
  568. is 16 points, adjusted to fill the page.
  569. <p>
  570. <a name="PP_JUST_QUAD"><h3><u>5. Justification/quad</u></h3></a>
  571. <p>
  572. The justification/quad-direction of regular text paragraphs (i.e.
  573. <a href="definitions.html#TERMS_JUST">justified</a>,
  574. or
  575. <a href="definitions.html#TERMS_FILLED">filled</a>
  576. and
  577. <a href="definitions.html#TERMS_QUAD">quadded</a>
  578. left/right/centre) is set with
  579. <a href="typesetting.html#JUSTIFY">JUSTIFY</a>
  580. or
  581. <a href="typesetting.html#QUAD">QUAD</a>
  582. prior to
  583. <a href="docprocessing.html#START">START</a>,
  584. and with
  585. <a href="docprocessing.html#DOC_QUAD">DOC_QUAD</a>
  586. afterwards.
  587. <p>
  588. Please note that either method of setting the paragraph
  589. justification/quad-direction also affects
  590. <a href="#EPIGRAPH_INTRO">epigraphs</a>
  591. and
  592. <a href="#FOOTNOTE_INTRO">footnotes</a>,
  593. but not
  594. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
  595. (whose default is QUAD LEFT unless you change it with
  596. <a href="#BLOCKQUOTE">BLOCKQUOTE_QUAD</a>).
  597. The justification/quad-direction of epigraphs and footnotes may
  598. be changed with their own control macros.
  599. <p>
  600. If you wish to change the justification/quad-direction of
  601. individual paragraphs, use <strong>JUSTIFY</strong> or
  602. <strong>QUAD</strong> immediately after <strong>PP</strong>.
  603. Only the paragraph in question gets justified or quadded
  604. differently; subsequent paragraphs remain unaffected.
  605. <p>
  606. <strong>Mom</strong>'s default justification/quad-direction for
  607. paragraphs is
  608. <br>
  609. <ul>
  610. <li>justified, for
  611. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
  612. <li>quad left, for
  613. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>
  614. </ul>
  615. <p>
  616. <a name="PARA_INDENT"><h3><u>6. First-line indent -- PARA_INDENT</u></h3></a>
  617. <p>
  618. The first-line indent of paragraphs is controlled by
  619. <strong>PARA_INDENT</strong>, which takes one argument: the size
  620. of the indent. <strong>PARA_INDENT</strong> may be used before
  621. or after
  622. <a href="docprocessing.html#START">START</a>.
  623. A
  624. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
  625. is required; fractional sizes are allowed. Thus, to set the paragraph
  626. indent to 4-1/2
  627. <a href="definitions.html#TERMS_EM">ems</a>, do
  628. <p>
  629. <pre>
  630. .PARA_INDENT 4.5m
  631. </pre>
  632. In addition to establishing the basic first line-indent of
  633. paragraphs, <strong>PARA_INDENT</strong> also affects
  634. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
  635. <a href="#QUOTE_INTRO">quotes</a>
  636. and
  637. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>,
  638. whose overall indenting from the left and (where applicable) right
  639. margins is relative to <strong>PARA_INDENT</strong>. Furthermore, the
  640. first-line indent of paragraphs within these document elements (as well
  641. as footnotes) is also relative to <strong>PARA_INDENT</strong> (always
  642. 1/2 of <strong>PARA_INDENT)</strong>), hence they are also affected.
  643. <p>
  644. <strong>Mom</strong>'s default <strong>PARA_INDENT</strong> is 2
  645. ems for
  646. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
  647. and 3 picas (1/2 inch) for
  648. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>.
  649. <p>
  650. <a name="PARA_INDENT_FIRST"><h3><u>7. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a>
  651. <p>
  652. By default, <strong>mom</strong> does not indent the first paragraph
  653. of a document, nor the first paragraph after a head or
  654. subhead, nor the first paragraphs of
  655. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
  656. <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
  657. or
  658. <a href="#FOOTNOTE_INTRO">footnotes</a>
  659. that run to more than one paragraph.
  660. <a name="INDENT_FIRST_PARAS"></a>
  661. <p>
  662. If you wish to have first paragraphs indented, invoke the macro
  663. <strong>.INDENT_FIRST_PARAS</strong> with no argument, either
  664. before or after
  665. <a href="docprocessing.html#START">START</a>.
  666. <strong>INDENT_FIRST_PARAS</strong> is a toggle macro, therefore
  667. passing it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels
  668. its effect, meaning that first paragraphs will once again NOT be
  669. indented.
  670. <p>
  671. <a name="PP_SPACE"><h3><u>8. Spacing paragraphs -- PARA_SPACE</u></h3></a>
  672. <p>
  673. By default, <strong>mom</strong> does not insert a blank line
  674. between paragraphs. If you would like her to do so, invoke the
  675. macro <code>.PARA_SPACE</code> with no argument, either
  676. before or after
  677. <a href="docprocessing.html#START">START</a>.
  678. <strong>PARA_SPACE</strong> is a toggle macro, therefore passing
  679. it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels its
  680. effect, meaning that paragraphs will once again NOT be separated by
  681. a blank line.
  682. <p>
  683. <strong>NOTE:</strong> If <strong>PARA_SPACE</strong> is on,
  684. <strong>mom</strong> spaces only those paragraphs that come after
  685. an &quot;initial&quot; paragraph. Initial paragraphs are those
  686. that come immediately after the
  687. <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
  688. <a href="#EPIGRAPH_INTRO">epigraphs</a>,
  689. <a href="#HEAD_INTRO">heads</a>,
  690. <a href="#SUBHEAD_INTRO">subheads</a>
  691. and
  692. <a href="#LINEBREAK_INTRO">linebreaks</a>.
  693. (The first paragraph after these document elements requires no
  694. blank line to separate it from other paragraphs.)
  695. <p>
  696. Sometimes, you can be fairly deep into a document before using
  697. <strong>.PP</strong> for the first time, and when you do, because
  698. <strong>mom</strong> is still waiting for that &quot;initial&quot;
  699. paragraph, she doesn't space it with a blank line, even though
  700. you expect her to. The simple workaround for this is to invoke
  701. <strong>.PP</strong> <em>twice</em> (in succession) at the point you
  702. expect the blank line to appear.
  703. <br>
  704. <hr>
  705. <!====================================================================>
  706. <a name="HEAD_INTRO"><h2><u>Main heads</u></h2></a>
  707. <ul>
  708. <li><a href="#HEAD">Tag: HEAD</a>
  709. <li><a href="#HEAD_CONTROL">Head control macros</a>
  710. </ul>
  711. <p>
  712. Main heads -- or, in this documentation, just &quot;heads&quot;
  713. -- should be used any place you want titles to introduce major
  714. sections of a document. If you wish, <strong>mom</strong> can number
  715. your heads for you. Head numbers can also be included
  716. hierarchically in numbered
  717. <a href="#SUBHEAD_INTRO">subheads</a>
  718. and
  719. <a href="#PARAHEAD_INTRO">paraheads</a>.
  720. <p>
  721. By default, heads are centred on the page, underlined,
  722. all in caps. A double linespace precedes each head. In <a
  723. href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, heads
  724. are bold, slightly larger than paragraph text.
  725. <p>
  726. If these defaults don't suit you, you can change them with the
  727. head control macros.
  728. <p>
  729. <!---HEAD--->
  730. <hr width="66%" align="left">
  731. <p>
  732. <a name="HEAD">
  733. <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>
  734. </a>
  735. <p>
  736. The argument to <strong>HEAD</strong> is the text of the head,
  737. surrounded by double-quotes. If you need additional lines for a
  738. head, simply surround each line with double-quotes.
  739. <p>
  740. <strong>NOTE:</strong> If a head falls near the bottom of an output page
  741. and <strong>mom</strong> is unable to fit the head <em>plus at least
  742. one line of text underneath it</em>, she will set the head at the
  743. top of the next page.
  744. <p>
  745. <strong>ADDITIONAL NOTE:</strong> If an
  746. <a href="definitions.html#TERMS_INPUTLINE">input line</a>
  747. in a head (i.e. one of the lines surrounded by double-quotes) has
  748. to be broken by <strong>mom</strong> in order to fit the current
  749. line-length (say, a narrow column measure), the head underline
  750. (underscore) will not behave. You'll recognize the problem as soon
  751. as you preview your document. If you encounter a head that
  752. misbehaves with respect to underlining, the solution is to
  753. supply each line <em>as you want it</em> as a separate argument
  754. (surrounded by double-quotes) to the <strong>HEAD</strong> macro.
  755. <p>
  756. For example, if <strong>mom</strong> breaks
  757. <pre>
  758. .HEAD "This is a very, very, very long head"
  759. </pre>
  760. into
  761. <pre>
  762. This is a very, very, very
  763. long head
  764. </pre>
  765. you'll see the misbehaving underscore and should change the
  766. argument to <strong>HEAD</strong> to
  767. <pre>
  768. .HEAD "This is a very, very very" "long head"
  769. </pre>
  770. <a name="HEAD_CONTROL"><h3><u>Head control macros</u></h3></a>
  771. <p>
  772. There are, in addition to the usual family/font/size/quad control
  773. macros, a number of macros to manage head numbering, spacing,
  774. underlining, and so on. Check them out if you're unhappy with
  775. <strong>mom</strong>'s defaults.
  776. <p>
  777. <ol>
  778. <li><a href="#HEAD_GENERAL">Family/font/size/colour/quad</a>
  779. <li><a href="#HEAD_CAPS">Caps</a>
  780. <li><a href="#HEAD_SPACE">Pre-head space</a>
  781. <li><a href="#HEAD_UNDERLINE">Underlining</a>
  782. <li><a href="#NUMBER_HEADS">Numbering</a>
  783. <li><a href="#RESET_HEAD_NUMBER">Reset head numbering</a>
  784. <li><a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>
  785. </ol>
  786. <p>
  787. <a name="HEAD_GENERAL"><h3><u>1. Family/font/size/colour/quad</u></h3></a>
  788. <p>
  789. See
  790. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
  791. <p>
  792. <pre>
  793. .HEAD_FAMILY default = prevailing document family; default is Times Roman
  794. .HEAD_FONT default = bold
  795. .HEAD_SIZE default = +1 (point)
  796. .HEAD_COLOR default = black
  797. .HEAD_QUAD default = CENTER
  798. </pre>
  799. <a name="HEAD_CAPS"><h3><u>2. Capitalizing heads -- HEAD_CAPS</u></h3></a>
  800. <p>
  801. By default, <strong>mom</strong> sets heads in caps, regardless
  802. of the
  803. <a href="definitions.html#TERMS_STRINGARGUMENT">string(s)</a>
  804. you give to
  805. <a href="#HEAD">HEAD</a>.
  806. To change this behaviour, do
  807. <p>
  808. <pre>
  809. .HEAD_CAPS OFF
  810. </pre>
  811. <strong>HEAD_CAPS</strong> is a toggle macro, therefore you can use
  812. any argument you like instead of <strong>OFF</strong> (<strong>END,
  813. QUIT, Q, X</strong>...). To turn <strong>HEAD_CAPS</strong> back on,
  814. simply invoke it without an argument.
  815. <p>
  816. <a name="HEAD_SPACE"><h3><u>3. Space before heads -- HEAD_SPACE</u></h3></a>
  817. <p>
  818. By default, <strong>mom</strong> deposits 2 blank lines prior to every
  819. head. If you'd prefer just a single blank line, do
  820. <p>
  821. <pre>
  822. .HEAD_SPACE OFF
  823. </pre>
  824. <strong>HEAD_SPACE</strong> is a toggle macro, therefore you can use
  825. any argument you like instead of <strong>OFF</strong> (<strong>END,
  826. QUIT, Q, X</strong>...). To restore the space before heads to 2
  827. blank lines, invoke <strong>HEAD_SPACE</strong> without an argument.
  828. <p>
  829. <a name="HEAD_UNDERLINE"><h3><u>4. Underlining heads -- HEAD_UNDERLINE</u></h3></a>
  830. <p>
  831. By default, <strong>mom</strong> underlines heads. To change this
  832. behaviour, do
  833. <p>
  834. <pre>
  835. .HEAD_UNDERLINE OFF
  836. </pre>
  837. <strong>HEAD_UNDERLINE</strong> is a toggle macro, therefore you can
  838. use any argument you like instead of <strong>OFF</strong> (<strong>END,
  839. QUIT, Q, X</strong>...). To restore underlining of heads, invoke
  840. <strong>HEAD_UNDERLINE</strong> without an argument.
  841. <p>
  842. <a name="NUMBER_HEADS"><h3><u>5. Number heads -- NUMBER_HEADS</u></h3></a>
  843. <p>
  844. If you'd like your heads numbered, simply invoke
  845. <strong>NUMBER_HEADS</strong> with no argument. <strong>Mom</strong>
  846. will number all subsequent heads automatically (in ascending order,
  847. naturally).
  848. <p>
  849. If, in addition to numbering heads, you also request that
  850. <a href="#SUBHEAD_INTRO">subheads</a>
  851. and/or
  852. <a href="#PARAHEAD_INTRO">paraheads</a>
  853. be numbered, the head number will be included in their numbers
  854. (each number separated by a period [dot]).
  855. <p>
  856. Should you wish to stop head numbering, invoke
  857. <strong>NUMBER_HEADS</strong> with any argument (<strong>OFF, QUIT,
  858. END, X</strong>...). Head numbering will cease, and the head number
  859. will not be included in the numbering of subheads and/or paraheads.
  860. <p>
  861. <a name="RESET_HEAD_NUMBER"><h3><u>6. Reset head numbering -- RESET_HEAD_NUMBER</u></h3></a>
  862. <p>
  863. Should you wish to reset the head number to &quot;1&quot;, invoke
  864. <strong>RESET_HEAD_NUMBER</strong> with no argument. If, for some
  865. reason, you want <strong>mom</strong> to use a head number that is not
  866. the next in ascending order (i.e. the last head number + 1), invoke
  867. <strong>RESET_HEAD_NUMBER</strong> with the number you want, e.g.
  868. <p>
  869. <pre>
  870. .RESET_HEAD_NUMBER 6
  871. </pre>
  872. Your next head will be numbered &quot;6&quot; and subsequent heads will
  873. be numbered in ascending order from &quot;6&quot;.
  874. <p>
  875. <a name="HEAD_INLINES"><h3><u>7. Vertical inline escapes inside heads</u></h3></a>
  876. <p>
  877. If you need to adjust the
  878. <a href="definitions.html#TERMS_BASELINE">baseline</a>
  879. position of a head (e.g. the head falls at the top of a column and
  880. you want its
  881. <a href="definitions.html#TERMS_ASCENDER">ascenders</a>
  882. to line up with the ascenders of
  883. <a href="definitions.html#TERMS_RUNNING">running text</a>
  884. in other columns), you can embed a vertical motion
  885. <a href="definitions.html#TERMS_INLINES">inline escape</a>
  886. (either
  887. <a href="inlines.html#INLINE_VERTICAL_MOM">mom</a>'s
  888. or
  889. <a href="inlines.html#INLINE_VERTICAL_GROFF">groff</a>'s
  890. in the string(s) you pass to <strong>HEAD</strong>
  891. <p>
  892. For example,
  893. <p>
  894. <pre>
  895. .HEAD "\[ALD3]Text of head"
  896. or
  897. .HEAD "\[DOWN 3p]Text of head"
  898. </pre>
  899. will lower the baseline of the head by three points. Note that
  900. there's no need to reverse the sense of the inline escape.
  901. <p>
  902. In the case of heads that run to more than one line, you must embed
  903. the escape in the string for each line, like this:
  904. <p>
  905. <pre>
  906. .HEAD "\[ALD3]First line" "\[ALD3]Next line"
  907. or
  908. .HEAD "\[DOWN 3p]First line" "\[DOWN 3p]Next line"
  909. </pre>
  910. <hr>
  911. <!====================================================================>
  912. <a name="SUBHEAD_INTRO"><h2><u>Subheads</u></h2></a>
  913. <ul>
  914. <li><a href="#SUBHEAD">Tag: SUBHEAD</a>
  915. <li><a href="#SUBHEAD_CONTROL">Subhead control macros</a>
  916. </ul>
  917. <p>
  918. Subheads should be used any place you want titles to introduce
  919. sections of a document below heads. If you wish, <strong>mom</strong>
  920. can number subheads for you. Subhead numbers can also be included
  921. hierarchically in numbered
  922. <a href="#PARAHEAD_INTRO">paraheads</a>.
  923. <p>
  924. By default, subheads are flush left. In
  925. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
  926. they are set bold, slightly larger than paragraph text. In
  927. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  928. they are underlined. A single linespace precedes them in both
  929. printstyles, and a tiny space adjustment raises them slightly
  930. above text that comes afterwards for greater clarity in
  931. document structuring.
  932. <p>
  933. If these defaults don't suit you, you can change them with the
  934. subhead control macros.
  935. <p>
  936. <!---SUBHEAD--->
  937. <hr width="66%" align="left">
  938. <p>
  939. <a name="SUBHEAD">
  940. <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>
  941. </a>
  942. <p>
  943. The argument to <strong>SUBHEAD</strong> is the text of the subhead,
  944. surrounded by double-quotes. If you need additional lines for a
  945. subhead, simply surround each line with double-quotes.
  946. <p>
  947. <strong>NOTE:</strong> If a subhead falls near the bottom of an output
  948. page and <strong>mom</strong> is unable to fit the head <em>plus at
  949. least one line of text underneath it</em>, she will set the subhead
  950. at the top of the next page.
  951. <a name="SUBHEAD_CONTROL"><h3><u>Subhead control macros</u></h3></a>
  952. <p>
  953. In addition to the usual family/font/size/quad control
  954. macros, there are macros to manage subhead numbering.
  955. <p>
  956. <ol>
  957. <li><a href="#SUBHEAD_GENERAL">Family/font/size/colour/quad</a>
  958. <li><a href="#NUMBER_SUBHEADS">Numbering</a>
  959. <li><a href="#RESET_SUBHEAD_NUMBER">Reset subhead numbering</a>
  960. <li><a href="#SUBHEAD_INLINES">Vertical inline escapes inside subheads</a>
  961. </ol>
  962. <p>
  963. <a name="SUBHEAD_GENERAL"><h3><u>1. Family/font/size/quad</u></h3></a>
  964. <p>
  965. See
  966. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
  967. <p>
  968. <pre>
  969. .SUBHEAD_FAMILY default = prevailing document family; default is Times Roman
  970. .SUBHEAD_FONT default = bold
  971. .SUBHEAD_SIZE default = +.5 (point)
  972. .SUBHEAD_COLOR default = black
  973. .SUBHEAD_QUAD default = LEFT
  974. </pre>
  975. <a name="NUMBER_SUBHEADS"><h3><u>2. Number subheads -- NUMBER_SUBHEADS</u></h3></a>
  976. <p>
  977. If you'd like your subheads numbered, simply invoke
  978. <strong>.NUMBER_SUBHEADS</strong> with no argument.
  979. <strong>Mom</strong> will number all subsequent subheads automatically
  980. (in ascending order, naturally).
  981. <p>
  982. If, in addition to numbering subheads, you also request that
  983. <a href="#HEAD_INTRO">heads</a>
  984. be numbered, the head number will be included in the subhead number
  985. (separated by a period [dot]).
  986. <p>
  987. Should you wish to stop subhead numbering, invoke
  988. <strong>NUMBER_SUBHEADS</strong> with any argument (<strong>OFF, QUIT,
  989. END, X</strong>...). Subhead numbering will cease, and the subhead
  990. number will not be included in the numbering of paraheads.
  991. <p>
  992. <a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a>
  993. <p>
  994. Should you wish to reset the subhead number to &quot;1&quot;, invoke
  995. <strong>RESET_SUBHEAD_NUMBER</strong> with no argument. If, for some
  996. reason, you want <strong>mom</strong> to use a subhead number that is not
  997. the next in ascending order (i.e. the last subhead number + 1), invoke
  998. <strong>RESET_SUBHEAD_NUMBER</strong> with the number you want, e.g.
  999. <p>
  1000. <pre>
  1001. .RESET_SUBHEAD_NUMBER 4
  1002. </pre>
  1003. Your next subhead will be numbered &quot;4&quot; and subsequent
  1004. subheads will be numbered in ascending order from &quot;4&quot;.
  1005. <a name="SUBHEAD_INLINES"><h3><u>Vertical inline escapes inside subheads</u></h3></a>
  1006. See
  1007. <a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>.
  1008. The information there applies equally to subheads.
  1009. <p>
  1010. <hr>
  1011. <!====================================================================>
  1012. <a name="PARAHEAD_INTRO"><h2><u>Paragraph heads</u></h2></a>
  1013. <ul>
  1014. <li><a href="#PARAHEAD">Tag: PARAHEAD</a>
  1015. <li><a href="#PARAHEAD_CONTROL">Parahead control macros</a>
  1016. </ul>
  1017. <p>
  1018. Paragraph heads (paraheads) should be used any place you want titles
  1019. to introduce paragraphs below heads or subheads. If you wish,
  1020. <strong>mom</strong> can number paraheads for you.
  1021. <p>
  1022. By default, paraheads are joined to the body of a paragraph,
  1023. slightly indented (provided the paragraph is not a
  1024. &quot;first&quot; paragraph as defined in
  1025. <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>).
  1026. In
  1027. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
  1028. they are set bold italic, slightly larger than paragraph text. In
  1029. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  1030. they are underlined.
  1031. <p>
  1032. If these defaults don't suit you, you can change them with the
  1033. parahead control macros.
  1034. <p>
  1035. <!---PARAHEAD--->
  1036. <hr width="66%" align="left">
  1037. <p>
  1038. <a name="PARAHEAD">
  1039. <nobr>Macro: <strong>PARAHEAD</strong> &quot;&lt;text of parahead&gt;&quot;</nobr>
  1040. </a>
  1041. <p>
  1042. <strong>PARAHEAD</strong> must come AFTER
  1043. <a href="#PP">PP</a>
  1044. or it will not work!
  1045. <p>
  1046. The argument is the text of the parahead, surrounded by double-quotes.
  1047. Because paraheads are joined to the body of a paragraph, they accept
  1048. only one argument (see
  1049. <a href="#HEAD">HEAD</a>
  1050. and
  1051. <a href="#SUBHEAD">SUBHEAD</a>).
  1052. <p>
  1053. <a name="PARAHEAD_CONTROL"><h3><u>Parahead control macros</u></h3></a>
  1054. <p>
  1055. In addition to the family/font/size/colour/indent control macros,
  1056. there are macros to manage parahead numbering.
  1057. <p>
  1058. <ol>
  1059. <li><a href="#PARAHEAD_GENERAL">Family/font/size/color</a>
  1060. <li><a href="#PARAHEAD_INDENT">Indent</a>
  1061. <li><a href="#NUMBER_PARAHEADS">Numbering</a>
  1062. <li><a href="#RESET_PARAHEAD_NUMBER">Reset parahead numbering</a>
  1063. </ol>
  1064. <p>
  1065. <a name="PARAHEAD_GENERAL"><h3><u>1. Family/font/size/colour</u></h3></a>
  1066. <p>
  1067. See
  1068. <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
  1069. <p>
  1070. <pre>
  1071. .PARAHEAD_FAMILY default = prevailing document family; default is Times Roman
  1072. .PARAHEAD_FONT default = bold italic
  1073. .PARAHEAD_SIZE default = +.5 (point)
  1074. <a name="PARAHEAD_COLOR">.PARAHEAD_COLOR default = black*</a>
  1075. *If you colourize paragraph text, paraheads will appear in the same
  1076. colour as the text unless you explicitly tell mom to colour them
  1077. otherwise by invoking .PARAHEAD_COLOR. If you do want paraheads
  1078. that are coloured the same as paragraph text, it's generally a good
  1079. idea to invoke .PARAHEAD_COLOR anyway (with the same colour used
  1080. for paragraph text), just to let mom know.
  1081. </pre>
  1082. <a name="PARAHEAD_INDENT"><h3><u>2. Indent</u></h3></a>
  1083. <p>
  1084. Unlike other control macros that end in
  1085. <a href="#CONTROL_INDENTS"><strong>_INDENT</strong></a>,
  1086. the argument to the macro that controls indenting of paragraph heads
  1087. (<strong>PARAHEAD_INDENT</strong>) is NOT relative to the first-line
  1088. indent of normal paragraphs. In other words, it takes an absolute
  1089. value, and requires a
  1090. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
  1091. For example, to set the paragraph head indent to 2-1/2 picas, you
  1092. do:
  1093. <p>
  1094. <pre>
  1095. .PARAHEAD_INDENT 2.5P
  1096. </pre>
  1097. <strong>Mom</strong>'s default indent for paragraph heads is 1/2
  1098. the first-line indent of normal paragraphs (both printstyles).
  1099. However, as stated above, if you choose to change the indent, you
  1100. must give an absolute value (unless you're a groff expert and want
  1101. to manipulate the number register <code>\n[#PP_INDENT]u</code>
  1102. arithmetically as the argument to <strong>PARAHEAD_INDENT</strong>
  1103. for an indent that's relative to <strong>PP_INDENT</strong>.)
  1104. <p>
  1105. <strong>NOTE:</strong> Paragraph heads in &quot;first
  1106. paragraphs&quot;, as defined in
  1107. <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>,
  1108. are not indented unless you turn
  1109. <a href="#INDENT_FIRST_PARAS">INDENT_FIRST_PARAS</a>
  1110. on.
  1111. <p>
  1112. <a name="NUMBER_PARAHEADS"><h3><u>3. Number paraheads -- NUMBER_PARAHEADS</u></h3></a>
  1113. <p>
  1114. If you'd like your paraheads numbered, simply invoke
  1115. <strong>.NUMBER_PARAHEADS</strong> with no argument.
  1116. <strong>Mom</strong> will number all subsequent paraheads automatically
  1117. (in ascending order, naturally).
  1118. <p>
  1119. If, in addition to numbering paraheads, you also request that
  1120. <a href="#HEAD_INTRO">heads</a>
  1121. and
  1122. <a href="#SUBHEAD_INTRO">subheads</a>
  1123. be numbered, the head and/or subhead number will be included in the
  1124. parahead number (separated by a period [dot]).
  1125. <p>
  1126. Should you wish to stop parahead numbering, invoke
  1127. <strong>NUMBER_PARAHEADS</strong> with any argument (<strong>OFF,
  1128. QUIT, END, X</strong>...). Parahead numbering will cease.
  1129. <p>
  1130. <a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a>
  1131. <p>
  1132. Should you wish to reset the parahead number to &quot;1&quot;, invoke
  1133. <strong>RESET_PARAHEAD_NUMBER</strong> with no argument. If, for some
  1134. reason, you want <strong>mom</strong> to use a parahead number that is not
  1135. the next in ascending order (i.e. the last parahead number + 1), invoke
  1136. <strong>RESET_PARAHEAD_NUMBER</strong> with the number you want, e.g.
  1137. <p>
  1138. <pre>
  1139. .RESET_PARAHEAD_NUMBER 7
  1140. </pre>
  1141. Your next parahead will be numbered &quot;7&quot; and subsequent
  1142. paraheads will be numbered in ascending order from &quot;7&quot;.
  1143. <p>
  1144. <hr>
  1145. <!====================================================================>
  1146. <a name="LINEBREAK_INTRO"><h2><u>Author linebreaks</u></h2></a>
  1147. <ul>
  1148. <li><a href="#LINEBREAK">Tag: LINEBREAK</a>
  1149. <li><a href="#LINEBREAK_CHAR">Linebreak character control macro</a>
  1150. </ul>
  1151. <p>
  1152. By default, <strong>mom</strong> marks
  1153. <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>
  1154. with three centred asterisks. You can change this behaviour
  1155. with the linebreak character
  1156. <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>.
  1157. <p>
  1158. <!---LINEBREAK--->
  1159. <hr width="66%" align="left">
  1160. <p>
  1161. <a name="LINEBREAK">
  1162. Macro: <strong>LINEBREAK</strong>
  1163. </a>
  1164. <br>
  1165. Alias: <strong>SECTION</strong>
  1166. <p>
  1167. <strong>LINEBREAK</strong> takes no arguments. Simply invoke it
  1168. (on a line by itself, of course) whenever you want to insert an
  1169. author linebreak. The appearance of the linebreak is controlled
  1170. by the
  1171. <a href="#LINEBREAK_CHAR">LINEBREAK_CHAR</a>
  1172. macro.
  1173. <h3><u>Linebreak character control macro</u></h3>
  1174. <p>
  1175. <a name="LINEBREAK_CHAR">
  1176. <nobr>Macro: <strong>LINEBREAK_CHAR</strong> [ &lt;character&gt; ] [ &lt;iterations&gt; [ &lt;vertical adjustment&gt; ] ]</nobr>
  1177. </a>
  1178. <br>
  1179. Alias: <strong>SECTION_CHAR</strong>
  1180. <br>
  1181. <em>*The third optional argument requires a
  1182. <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>.
  1183. <p>
  1184. <strong>LINEBREAK_CHAR</strong> determines what <strong>mom</strong>
  1185. prints when <strong>LINEBREAK</strong> is invoked. It takes 3
  1186. optional arguments: the character you want deposited at the line
  1187. break, the number of times you want the character repeated, and a
  1188. vertical adjustment factor.
  1189. <p>
  1190. The first argument is any legal groff character (e.g. <kbd>*</kbd>
  1191. [an asterisk], <kbd>\(dg</kbd> [a dagger], <kbd>\f(ZD\N'141\fP</kbd>
  1192. [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd>
  1193. [a 4-pica long rule]). <strong>Mom</strong> sets the character
  1194. centred on the current line length. (See &quot;man groff_char&quot;
  1195. for a list of all legal groff characters.)
  1196. <p>
  1197. The second argument is the number of times to repeat the character.
  1198. <p>
  1199. The third argument is a +|- value by which to raise (+) or lower (-)
  1200. the character in order to make it appear visually centred between
  1201. sections of text. This lets you make vertical adjustments
  1202. to characters that don't sit on the
  1203. <a href="definitions.html#TERMS_BASELINE">baseline</a>
  1204. (such as asterisks). The argument must be preceded by a plus or
  1205. minus sign, and must include a unit of measure.
  1206. <p>
  1207. If you enter <strong>LINEBREAK_CHAR</strong> with no arguments,
  1208. sections of text will be separated by two blank lines when you invoke
  1209. <strong>LINEBREAK</strong>.
  1210. <p>
  1211. <strong>Mom</strong>'s default for <strong>LINEBREAK_CHAR</strong> is
  1212. <p>
  1213. <pre>
  1214. .LINEBREAK_CHAR * 3 -3p
  1215. </pre>
  1216. i.e. three asterisks, lowered 3 points from their normal vertical
  1217. position (for
  1218. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
  1219. the vertical adjustment is -2 points for
  1220. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>).
  1221. <h3><u>Linebreak colour control macro</u></h3>
  1222. <p>
  1223. <a name="LINEBREAK_COLOR">
  1224. <nobr>Macro: <strong>LINEBREAK_COLOR</strong> &lt;color name&gt;</nobr>
  1225. </a>
  1226. <p>
  1227. To change the colour of the linebreak character(s), simply invoke
  1228. <strong>LINBREAK_COLOR</strong> with the name of a pre-defined (or
  1229. &quot;initialized&quot;) colour.
  1230. <br>
  1231. <hr>
  1232. <!====================================================================>
  1233. <a name="QUOTE_INTRO"><h2><u>Quotes (line for line)</u></h2></a>
  1234. <ul>
  1235. <li><a href="#QUOTE">Tag: QUOTE</a>
  1236. <li><a href="#QUOTE_CONTROL">Quote control macros</a>
  1237. </ul>
  1238. <p>
  1239. <a href="definitions.html#TERMS_QUOTE">Quotes</a>
  1240. are always set in
  1241. <a href="definitions.html#TERMS_NOFILL">nofill mode</a>,
  1242. flush left. This permits entering quotes on a line for line basis in
  1243. your text editor and have them come out the same way on output copy.
  1244. (See
  1245. <a href="#BLOCKQUOTE_INTRO">Blockquotes</a>
  1246. for how quotes, in the present sense, differ from longer
  1247. passages of cited text.)
  1248. <p>
  1249. Since <strong>mom</strong> originally came into being to serve
  1250. the needs of creative writers (i.e. novelists, short story
  1251. writers, etc. -- not to cast aspersions on the creativity of
  1252. mathematicians and programmers), she sets quotes in italics
  1253. <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET)</a>
  1254. or underlined
  1255. <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPEWRITE)</a>,
  1256. indented from the left margin. Obviously, she's thinking
  1257. &quot;quotes from poetry or song lyrics&quot;, but with the
  1258. <a href="#QUOTE_CONTROL">quote control macros</a>
  1259. you can change her defaults so <strong>QUOTE</strong> serves other
  1260. needs, e.g. entering verbatim snippets of programming code, command
  1261. line instructions, and so on. (See the
  1262. <a href="#QUOTE_TIP">tip</a>
  1263. below for suggestions about including programming code snippets in
  1264. documents.)
  1265. <p>
  1266. <a name="QUOTE_SPACING"></a>
  1267. Besides indenting quotes, <strong>mom</strong> further sets them
  1268. off from
  1269. <a href="definitions.html#TERMS_RUNNING">running text</a>
  1270. with a small amount of vertical whitespace top and bottom. In
  1271. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
  1272. this is always one full linespace. In
  1273. <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
  1274. it's 1/2 of the prevailing
  1275. <a href="definitions.html#TERMS_LEADING">leading</a>
  1276. if the quote fits fully on the page (i.e. with running text above
  1277. and below it), otherwise it's a full linespace either above or below
  1278. as is necessary to balance the page to the bottom margin. This
  1279. behaviour