PageRenderTime 97ms CodeModel.GetById 31ms app.highlight 44ms RepoModel.GetById 0ms app.codeStats 2ms

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

Large files files are truncated, but you can click here to view the full file