/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
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
- <html>
- <head>
- <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
- <title>Mom -- Document Processing, element tags</title>
- </head>
- <body bgcolor="#dfdfdf">
- <!====================================================================>
- <a href="headfootpage.html#TOP">Next</a>
- <a href="docprocessing.html#TOP">Prev</a>
- <a href="toc.html">Back to Table of Contents</a>
- <p>
- <a name="TOP"></a>
- <a name="DOCELEMENT">
- <h1 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h1>
- </a>
- <ul>
- <li><a href="#DOCELEMENT_INTRO">Introduction to the document element tags</a>
- <ul>
- <li><a href="#DOCELEMENT_CONTROL">Control macros -- changing defaults for document element tags</a>
- <li><a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>
- </ul>
- <li><a href="#INDEX_DOCELEMENT">Index of document element tags</a>
- </ul>
- <a name="DOCELEMENT_INTRO">
- <h2><u>Introduction to the document element tags</u></h2>
- </a>
- Once you've completed the setup for a document (see
- <a href="docprocessing.html#DOCPROCESSING_TUT">Setting up a mom document</a>),
- formatting it is a snap. Simply invoke the appropriate tag for
- each document element as you need it. The tags are macros that
- tell <strong>mom</strong>, "This is a paragraph, this
- is a subhead, this is a footnote," and so on.
- <p>
- The list of tags is actually quite small -- ideal for the users
- <strong>mom</strong> brought herself into being for (see
- <a href="intro.html#INTRO_INTRO">Who mom is meant for</a>).
- However, the list of macros that control the appearance of the
- tags upon output is extensive. Generally, for each tag,
- there are
- <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>
- for the tag's family, font and point size. Where appropriate, there
- are macros to control leading, indents, quad and special features
- as well.
- <p>
- <strong>Mom</strong> has tasteful defaults for all the tags, hence you
- only use the control macros when you want to change the way
- she does things. This is usually done prior to
- <a href="docprocessing.html#START">START</a>,
- but can, in fact, be done at any time in the course of a document.
- Any change to a tag's style affects all subsequent invocations of
- the tag.
- <p>
- <a name="DOCELEMENT_CONTROL"><h3><u>Control macros -- changing defaults</u></h3></a>
- <p>
- The control macros for document processing tags let you
- "design" the look of all the parts of your documents --
- should you wish. At a bare minimum, all tags have macros to change
- <strong>mom</strong>'s defaults for family, font, point size and
- colour. Where appropriate, there are macros to control leading,
- indents and quad as well.
- <p>
- In addition, many tags have special macros to control features that
- are pertinent to those tags alone. Have a look at the section dealing
- with any particular tag to find out what macros control the tag,
- and what <strong>mom</strong>'s defaults for the tag are.
- <p>
- The control macros may be used at any time during the course of
- a document (i.e. before or after
- <a href="docprocessing.html#START">START</a>). The changes you
- make alter all subsequent invocations of the affected tag until
- you make another change, either by passing new arguments to the
- tag's control macro, or toggling a particular feature of the tag on
- or off.
- <p>
- And don't forget: the
- <a href="typesetting.html#MACROS_TYPESETTING">typesetting macros</a>
- can be used at any time, including inside
- <a href="definitions.html#TERMS_TOGGLE">toggle</a>
- tags (affecting only that particular invocation of the tag).
- Equally,
- <a href="definitions.html#TERMS_INLINES">inline escapes</a>
- can be used in tags that take
- <a href="definitions.html#TERMS_STRINGARGUMENT">string arguments.</a>
- <p>
- <strong>IMPORTANT NOTE:</strong> The family, font, point size,
- colour and leading control macros have no effect in
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
- which sets EVERYTHING in Courier roman, 12/24 (i.e. 12-point type on
- a linespace of 24 points).
- <p>
- Please also note that the defaults listed
- with the control macros apply only to
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>
- unless a default for <strong>TYPEWRITE</strong> is also given.
- <p>
- <strong>A WORD OF ADVICE:</strong> Get familiar with
- <strong>mom</strong> at her default settings before exploring the
- control macros. Put her through her paces. See how she behaves.
- Get to know what she feels like and how she looks, both in your text
- editor and on the printed page. Then, if you don't like something,
- use this documentation to find the precise macro you need to change it.
- There are tons of control macros. Reading up on them and trying to
- remember them all might lead you to think that <strong>mom</strong>
- is complex and unwieldy, which is not only untrue, but would offend
- her mightily.
- <p>
- <a name="CONTROL_MACRO_ARGS"><h3><u>Arguments to the control macros</u></h3></a>
- <h3>Family and font</h3>
- The arguments to the control macros that end in
- <strong>_FAMILY</strong> or <strong>_FONT</strong> are the same
- as for
- <a href="typesetting.html#FAMILY">FAMILY</a>
- and
- <a href="typesetting.html#FONT">FT</a>.
- <h3>Point size</h3>
- Control macros that end in <strong>_SIZE</strong> always take
- the form <kbd>+digit</kbd> or <kbd>-digit</kbd> where digit is
- the number of
- <a href="definitions.html#TERMS_PICASPOINTS">points</a>
- larger (+) or smaller (-) than the point size of paragraphs
- you want the document element to be. For example, to change
- subheads to 1-1/2 points larger than the type in paragraphs, do
- <p>
- <pre>
- .SUBHEAD_SIZE +1.5
- </pre>
- There's no need for a
- <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
- with the <strong>_SIZE</strong> control macros; points is assumed.
- <h3>Colour</h3>
- Control macros that end in <strong>_COLOR</strong> take as their
- argument a colour name pre-defined (or "initialized")
- with
- <a href="color.html#NEWCOLOR">NEWCOLOR</a>
- or
- <a href="color.html#XCOLOR">XCOLOR</a>.
- For example, if you want your heads to be red, once you've defined
- or initialized the color, red,
- <p>
- <pre>
- .HEAD_COLOR red
- </pre>
- will turn your heads red.
- <h3>Lead/linespacing</h3>
- Control macros that end in <strong>_AUTOLEAD</strong> take the
- same argument as
- <a href="typesetting.html#AUTOLEAD">AUTOLEAD</a>,
- viz. a digit that represents the number of points to add to the
- tag's point size to arrive at its
- <a href="definitions.html#TERMS_LEADING">lead</a>.
- For example, to set footnotes
- <a href="definitions.html#TERMS_SOLID">solid</a>, do
- <p>
- <pre>
- .FOOTNOTE_AUTOLEAD 0
- </pre>
- To set footnotes with a 1-point lead (i.e. with the line spacing
- one point greater than the footnote's point size), do
- <p>
- <pre>
- .FOOTNOTE_AUTOLEAD 1
- </pre>
- <h3><a name="CONTROL_INDENTS">Indents</a></h3>
- Except for <strong>PARA_INDENT</strong>, the argument to the control
- macros that end
- in <strong>_INDENT</strong> is always a single digit (whole numbers
- only; no decimal fractions) with no
- <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
- appended to it. The digit represents by how much you want the
- size of the paragraph first-line indent multiplied to achieve the
- correct indent for a particular tag.
- <h3>Quad/justification style</h3>
- Control macros that end in <strong>_QUAD</strong> take the same
- arguments as
- <a href="typesetting.html#QUAD">QUAD</a>.
- <p>
- <hr>
- <a name="INDEX_DOCELEMENT"><h3><u>Document element tags list</u></h3></a>
- <ul>
- <li><a href="#EPIGRAPH_INTRO">Epigraphs</a>
- <ul>
- <li><a href="#EPIGRAPH">EPIGRAPH</a>
- <li><a href="#EPIGRAPH_CONTROL">Epigrah control</a>
- </ul>
- <li><a href="#PP_INTRO">Paragraphs</a>
- <ul>
- <li><a href="#PP">PP</a>
- <li><a href="#PP_CONTROL">Paragraph control</a>
- </ul>
- <li><a href="#HEAD_INTRO">Main heads</a>
- <ul>
- <li><a href="#HEAD">HEAD</a>
- <li><a href="#HEAD_CONTROL">Head control</a>
- </ul>
- <li><a href="#SUBHEAD_INTRO">Subheads</a>
- <ul>
- <li><a href="#SUBHEAD">SUBHEAD</a>
- <li><a href="#SUBHEAD_CONTROL">Subhead control</a>
- </ul>
- <li><a href="#PARAHEAD_INTRO">Paragraph heads</a>
- <ul>
- <li><a href="#PARAHEAD">PARAHEAD</a>
- <li><a href="#PARAHEAD_CONTROL">Parahead control</a>
- </ul>
- <li><a href="#LINEBREAK_INTRO">Linebreaks (author linebreaks, section breaks)</a>
- <ul>
- <li><a href="#LINEBREAK">LINEBREAK</a>
- <li><a href="#LINEBREAK_CHAR">Linebreak character</a>
- <li><a href="#LINEBREAK_COLOR">Linebreak colour</a>
- </ul>
- <li><a href="#QUOTE_INTRO">Quotes (line for line)</a>
- <ul>
- <li><a href="#QUOTE">QUOTE</a>
- <li><a href="#QUOTE_CONTROL">Quote control</a>
- </ul>
- <li><a href="#BLOCKQUOTE_INTRO">Blockquotes (cited material)</a>
- <ul>
- <li><a href="#BLOCKQUOTE">BLOCKQUOTE</a>
- <li><a href="#BLOCKQUOTE_CONTROL">Blockquote control</a>
- </ul>
- <li><a href="#LIST_INTRO">Nested lists</a>
- <ul>
- <li><a href="#LIST">LIST</a>
- <ul>
- <li><a href="#ITEM">ITEM</a>
- </ul>
- <li><a href="#LIST_CONTROL">List control</a>
- </ul>
- <li><a href="#NUMBER_LINES_INTRO">Line numbering</a>
- <ul>
- <li><a href="#NUMBER_LINES">NUMBER_LINES</a>
- <li><a href="#NUMBER_LINES_CONTROL">Control macros</a> (for QUOTE and BLOCKQUOTE)
- </ul>
- <li><a href="#FOOTNOTE_INTRO">Footnotes</a>
- <ul>
- <li><a href="#FOOTNOTE">FOOTNOTE</a>
- <li><a href="#FOOTNOTE_CONTROL">Footnote control</a>
- </ul>
- <li><a href="#ENDNOTE_INTRO">Endnotes</a>
- <ul>
- <li><a href="#ENDNOTE">ENDNOTE</a>
- <li><a href="#ENDNOTE_CONTROL">Endnote control</a>
- </ul>
- <li><a href="#MARGIN_NOTES_INTRO">Margin notes</a>
- <ul>
- <li><a href="#MN_INIT">MN_INIT</a> -- initialize margin notes
- <li><a href="#MN">MN</a> -- start and end a margin note
- </ul>
- <li><a href="refer.html#TOP">Bibliographies and references</a>
- <ul>
- <li><a href="refer.html#REF">REF</a>
- <li><a href="refer.html#ENDNOTE_REFS">ENDNOTE_REFS</a>
- <li><a href="refer.html#FOOTNOTE_REFS">FOOTNOTE_REFS</a>
- <li><a href="refer.html#BRACKET_REFS">Embedded references</a>
- <li><a href="refer.html#BIBLIOGRAPHY">BIBLIOGRAPHY</a>
- <li><a href="refer.html#BIBLIOGRAPHY_TYPE">BIBLIOGRAPHY_TYPE</a>
- </ul>
- <li><a href="#BLANK_PAGE_TITLE">Blank pages</a>
- <li><a href="#TOC_INTRO">Table of contents</a>
- <ul>
- <li><a href="#TOC">TOC</a>
- <li><a href="#TOC_CONTROL">Table of contents control</a>
- </ul>
- <li><a href="#FINIS_INTRO">Document termination</a>
- <ul>
- <li><a href="#FINIS">FINIS (Document termination)</a>
- </ul>
- <ul>
- <li><a href="#FINIS_STRING">Changing the FINIS string</a>
- <li><a href="#FINIS_COLOR">Changing the FINIS colour</a>
- </ul>
- </ul>
- <hr>
- <!====================================================================>
- <a name="EPIGRAPH_INTRO"><h2><u>Epigraphs</u></h2></a>
- <ul>
- <li><a href="#EPIGRAPH">Tag: EPIGRAPH</a>
- <li><a href="#EPIGRAPH_CONTROL">Epigraph control macros</a>
- </ul>
- <p>
- <a href="definitions.html#TERMS_EPIGRAPH">Epigraphs</a>
- colour, flavour, or comment on the document they precede. Typically,
- they are centred at the top of a document's first page (underneath the
- title) and set in a smaller point size than that of paragraph text.
- <p>
- By default, <strong>mom</strong> sets epigraphs centred and
- <a href="definitions.html#TERMS_NOFILL">unfilled</a>;
- this lets you input them on a line for line basis. This behaviour
- can be changed to accomodate
- <a href="definitions.html#TERMS_FILLED">filled</a>
- epigraph "blocks."
- <p>
- <!---EPIGRAPH--->
- <hr width="66%" align="left">
- <p>
- <a name="EPIGRAPH">
- <nobr>Macro: <strong>EPIGRAPH</strong> <toggle> | [ BLOCK ]</a></nobr>
- </a>
- <p>
- <strong>EPIGRAPH</strong> is a toggle, used like this:
- <p>
- <pre>
- .EPIGRAPH
- <text of epigraph>
- .EPIGRAPH OFF
- </pre>
- <strong>OFF</strong>, above, could be anything -- say, Q or X --
- since any argument other than <strong>BLOCK</strong> turns it off.
- <p>
- If given the argument <strong>BLOCK</strong>, <strong>EPIGRAPH</strong>
- sets epigraphs
- <a href="definitions.html#TERMS_FILLED">filled</a>,
- justified or quadded in the same direction as paragraphs, indented
- equally from both the left and right margins.
- <p>
- If a block-style epigraph runs to more than one paragraph (unlikely,
- but conceivable), you <strong>MUST</strong> introduce every paragraph
- -- <u>INCLUDING THE FIRST!!!</u> -- with the
- <a href="#PP">PP</a>
- tag.
- <p>
- <strong>NOTE:</strong> <strong>EPIGRAPH</strong> should only be
- used at the top of a document (i.e. just after
- <a href="docprocessing.html#START">START</a>)
- or after
- <a href="#HEAD_INTRO">heads</a>. The latter is not especially
- recommended, but it does work. In all other places where you
- want quotes or cited text, use
- <a href="#QUOTE">QUOTE</a>
- or
- <a href="#BLOCKQUOTE">BLOCKQUOTE</a>.
- <p>
- <a name="EPIGRAPH_CONTROL"><h3><u>Epigraph control macros</u></h3></a>
- <p>
- See
- <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
- <p>
- <pre>
- .EPIGRAPH_FAMILY default = prevailing document family; default is Times Roman
- .EPIGRAPH_FONT default = roman
- .EPIGRAPH_SIZE default = -1.5 (points)
- .EPIGRAPH_COLOR default = black
- .EPIGRAPH_AUTOLEAD default = 2 points
- (The next two apply to "block" style epigraphs only)
- .EPIGRAPH_QUAD default = same as paragraphs
- .EPIGRAPH_INDENT* default = para indent x 3 (for typeset), x 2 (for typewrite)
- *Indent here refers to the indent from both the left and right margins
- that centres the block style epigraph on the page.
- </pre>
- <hr>
- <!====================================================================>
- <a name="PP_INTRO"><h2><u>Paragraphs</u></h2></a>
- <ul>
- <li><a href="#PP">Tag: PP</a>
- <li><a href="#PP_CONTROL">Paragraph control macros</a>
- </ul>
- <p>
- The paragraph macro is the one you use most often. Consequently,
- it's one of most powerful, yet simplest to use -- just the letters
- <strong>PP</strong>. No arguments, nothing. Just <kbd>.PP</kbd>
- on a line by itself any time, in any document element, tells
- <strong>mom</strong> you want to start a new paragraph. The spacing
- and indent appropriate to where you are in your document are taken
- care of automatically.
- <p>
- By default, <strong>mom</strong> does not indent the first paragraph
- of a document, nor paragraphs that fall immediately after
- <a href="#HEAD_INTRO">heads</a>
- or
- <a href="#SUBHEAD_INTRO">subheads</a>.
- The first paragraphs of blockquotes and block-style epigraphs are
- also not indented. This behaviour can be changed with the control
- macro
- <a href="#PARA_INDENT_FIRST">INDENT_FIRST_PARAS</a>.
- <p>
- In contrast to some other macro packages, <strong>mom</strong> does not
- deposit a blank line between paragraphs. If you want her to do so, use
- the control macro <strong>PARA_SPACE</strong>. (I don't recommend
- using this macro with
- <a href="typesetting.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>.)
- <p>
- Note that <strong>mom</strong> does not provide "orphan
- control" for paragraphs (i.e. even if only one line of a paragraph
- fits at the bottom of a page, she will set it on that page). The
- reason for this is that writers of fiction often have single-line
- paragraphs (e.g. in dialogue). Groff's simplistic orphan control
- will break these one-liners -- if they fall at the bottom of the page
- -- to a new page, which is not what you want.
- <p>
- <strong>TIP:</strong> The last thing you want while you're writing
- and editing drafts of a document (particularly stories and chapters)
- is a text file cluttered up with <strong>PP</strong>'s. The visual
- interruption in the flow of text is a serious obstacle to creativity
- and critiquing.
- <p>
- I use the tab key on my keyboard to indent paragraphs when I'm writing,
- producing a text file that looks pretty much like what you see on
- a printed page. When it comes time to format and print the file,
- I run it through a sed script that (amongst other things) converts
- the character generated by the tab key (<kbd>^I</kbd>) into <code>.PP</code>
- (plus a new line), and pipe the output to groff for processing and
- printing.
- <p>
- Another solution is to insert a blank line between paragraphs.
- The blank lines can then be sedded out at print time as above, or,
- more conveniently, you can use the <code>.blm</code>
- <a href="definitions.html#TERMS_PRIMITIVES">primitive</a>
- (blank line macro) to instruct groff (and <strong>mom</strong>)
- that blank lines should be interpreted as <strong>PP</strong>'s.
- <p>
- <pre>
- .blm PP
- </pre>
- tells groff that all blank lines are really the macro <strong>PP</strong>.
- <p>
- <!---PP--->
- <hr width="66%" align="left">
- <p>
- <a name="PP">
- Macro: <strong>PP</strong>
- </a>
- <p>
- <strong>PP</strong> (on a line by itself, of course) tells mom to
- start a new paragraph. See
- <a href="#PP_INTRO">above</a>
- for more details. In addition to regular text paragraphs, you can
- use <strong>PP</strong> in
- <a href="#EPIGRAPH_INTRO">epigraphs</a>,
- <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
- and
- <a href="#FOOTNOTE_INTRO">footnotes</a>.
- <a name="PP_CONTROL"><h3><u>Paragraph control macros</u></h3></a>
- <p>
- The <strong>PP</strong> being so important, and representing, as
- it were, the basis of everything that goes on in a document, its
- control is managed in a manner somewhat different from other document
- element tags.
- <p>
- <ol>
- <li><a href="#PP_FAMILY">Family control</a>
- <li><a href="#PP_FONT">Font control</a>
- <li><a href="#PP_COLOR">Paragraph colour</a>
- <li><a href="#PP_LEADING">Leading/linespacing control</a>
- <li><a href="#PP_JUST_QUAD">Justification/quad control</a>
- <li><a href="#PARA_INDENT">First-line indent control</a>
- <li><a href="#PARA_INDENT_FIRST">Initial paragraphs indent control</a>
- <li><a href="#PP_SPACE">Paragraph spacing control</a>
- </ol>
- <a name="PP_FAMILY"><h3><u>1. Family</u></h3></a>
- <p>
- The paragraph
- <a href="definitions.html#TERMS_FAMILY">family</a>
- is set with
- <a href="typesetting.html#FAMILY">FAMILY</a>
- prior to
- <a href="docprocessing.html#START">START</a>,
- or
- <a href="docprocessing.html#DOC_FAMILY">DOC_FAMILY</a>
- afterwards. Please note that both globally affect the family of
- every element in the document.
- <p>
- If you wish to change the family for regular
- text paragraphs only, invoke <strong>FAMILY</strong> immediately
- after <strong>PP</strong> in EVERY paragraph whose family you wish
- to differ from the prevailing document family.
- <p>
- <strong>Mom</strong>'s default paragraph (and document) family
- is Times Roman.
- <p>
- <a name="PP_FONT"><h3><u>2. Font -- PP_FONT</u></h3></a>
- <p>
- To change the
- <a href="definitions.html#TERMS_FONT">font</a>
- used in regular text paragraphs, use <code>.PP_FONT</code>,
- which takes the same argument as
- <a href="typesetting.html#FONT">FT</a>.
- <strong>PP_FONT</strong> may be used before or after
- <a href="docprocessing.html#START">START</a>.
- Only regular text paragraphs are affected; paragraphs in
- <a href="#EPIGRAPH_INTRO">epigraphs</a>,
- <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
- and
- <a href="#FOOTNOTE_INTRO">footnotes</a>
- remain at their default setting (medium roman) unless you change them
- with the appropriate control macros.
- <p>
- <strong>Mom</strong>'s default paragraph font is medium roman.
- <p>
- <a name="PP_COLOR"><h3><u>3. Paragraph colour</u></h3></a>
- <p>
- <strong>Mom</strong> has no special control macro for colourizing
- paragraphs. If you wish a colourized paragraph, you must use the
- macro,
- <a href="color.html#COLOR">COLOR</a>,
- or the
- <a href="definitions.html#TERMS_INLINE">inline escape</a>,
- <a href="color.html#COLOR_INLINE">\*[<colorname>]</a>,
- <em>after</em> <strong>.PP</strong>. The colour must be one
- pre-defined (or "initialized") with
- <a href="color.html#NEWCOLOR">NEWCOLOR</a>
- or
- <a href="color.html#XCOLOR">XCOLOR</a>.
- <p>
- Please note that unless you change the colour back to it's default
- (usually black) at the end of the paragraph, all subsequent
- paragraphs will be set in the new colour, although most other
- elements of your document will continue to be set in the default
- colour (usually black).
- <p>
- For example, assuming you have defined the colour, blue,
- <p>
- <pre>
- .PP
- .COLOR blue
- <first paragraph>
- .HEAD "Monty Python"
- .SUBHEAD "The Origins of Spam"
- .PP
- <second paragraph>
- </pre>
- the first paragraph will be blue, the head and subhead will be in
- the document's default colour (usually black), and the second
- paragraph will be in blue.
- <p>
- The one document element that is affected by changing the colour
- of paragraphs are
- <a href="#PARAHEAD">paraheads</a>,
- since they are attached directly to the body of paragraphs. In
- other words, if you change the colour of a paragraph and do not
- reset the paragraph colour back to its default, subsequent paraheads
- will appear in the same colour as your paragraphs unless you have
- explicitly told <strong>mom</strong> you want a pre-defined (or
- "initialized") color (usually black) for your paraheads.
- <p>
- See the footnote to
- <a href="#PARAHEAD_COLOR">.PARAHEAD_COLOR</a>.
- <a name="PP_LEADING"><h3><u>4. Leading</u></h3></a>
- <p>
- The paragraph
- <a href="definitions.html#TERMS_LEADING">leading</a>
- is set with
- <a href="typesetting.html#LEADING">LS</a>
- prior to
- <a href="docprocessing.html#START">START</a>,
- or
- <a href="docprocessing.html#DOC_LEAD">DOC_LEAD</a>
- afterwards. Please note that either method globally affects the
- leading and spacing of every document element (except
- <a href="definitions.html#TERMS_HEADER">headers</a>
- and
- <a href="definitions.html#TERMS_FOOTER">footers</a>).
- <p>
- If you wish to change the leading of regular text paragraphs only,
- invoke <strong>LS</strong> immediately after <strong>PP</strong> in
- EVERY paragraph whose leading you wish to change.
- <p>
- <strong>HYPER-IMPORTANT NOTE:</strong> It is extremely unwise to change
- paragraph leading with <strong>LS</strong>, as it will, in all cases,
- screw up <strong>mom</strong>'s ability to balance the bottom margin
- of pages. Should you absolutely need to change paragraph leading
- with <strong>LS</strong>, and subsequently want <strong>mom</strong>
- to get back on the right leading track, use the
- <a href="docprocessing.html#SHIM">SHIM</a>
- macro.
- <p>
- <strong>Mom</strong>'s default paragraph leading (document leading)
- is 16 points, adjusted to fill the page.
- <p>
- <a name="PP_JUST_QUAD"><h3><u>5. Justification/quad</u></h3></a>
- <p>
- The justification/quad-direction of regular text paragraphs (i.e.
- <a href="definitions.html#TERMS_JUST">justified</a>,
- or
- <a href="definitions.html#TERMS_FILLED">filled</a>
- and
- <a href="definitions.html#TERMS_QUAD">quadded</a>
- left/right/centre) is set with
- <a href="typesetting.html#JUSTIFY">JUSTIFY</a>
- or
- <a href="typesetting.html#QUAD">QUAD</a>
- prior to
- <a href="docprocessing.html#START">START</a>,
- and with
- <a href="docprocessing.html#DOC_QUAD">DOC_QUAD</a>
- afterwards.
- <p>
- Please note that either method of setting the paragraph
- justification/quad-direction also affects
- <a href="#EPIGRAPH_INTRO">epigraphs</a>
- and
- <a href="#FOOTNOTE_INTRO">footnotes</a>,
- but not
- <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
- (whose default is QUAD LEFT unless you change it with
- <a href="#BLOCKQUOTE">BLOCKQUOTE_QUAD</a>).
- The justification/quad-direction of epigraphs and footnotes may
- be changed with their own control macros.
- <p>
- If you wish to change the justification/quad-direction of
- individual paragraphs, use <strong>JUSTIFY</strong> or
- <strong>QUAD</strong> immediately after <strong>PP</strong>.
- Only the paragraph in question gets justified or quadded
- differently; subsequent paragraphs remain unaffected.
- <p>
- <strong>Mom</strong>'s default justification/quad-direction for
- paragraphs is
- <br>
- <ul>
- <li>justified, for
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
- <li>quad left, for
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>
- </ul>
- <p>
- <a name="PARA_INDENT"><h3><u>6. First-line indent -- PARA_INDENT</u></h3></a>
- <p>
- The first-line indent of paragraphs is controlled by
- <strong>PARA_INDENT</strong>, which takes one argument: the size
- of the indent. <strong>PARA_INDENT</strong> may be used before
- or after
- <a href="docprocessing.html#START">START</a>.
- A
- <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>
- is required; fractional sizes are allowed. Thus, to set the paragraph
- indent to 4-1/2
- <a href="definitions.html#TERMS_EM">ems</a>, do
- <p>
- <pre>
- .PARA_INDENT 4.5m
- </pre>
- In addition to establishing the basic first line-indent of
- paragraphs, <strong>PARA_INDENT</strong> also affects
- <a href="#EPIGRAPH_INTRO">epigraphs</a>,
- <a href="#QUOTE_INTRO">quotes</a>
- and
- <a href="#BLOCKQUOTE_INTRO">blockquotes</a>,
- whose overall indenting from the left and (where applicable) right
- margins is relative to <strong>PARA_INDENT</strong>. Furthermore, the
- first-line indent of paragraphs within these document elements (as well
- as footnotes) is also relative to <strong>PARA_INDENT</strong> (always
- 1/2 of <strong>PARA_INDENT)</strong>), hence they are also affected.
- <p>
- <strong>Mom</strong>'s default <strong>PARA_INDENT</strong> is 2
- ems for
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a>
- and 3 picas (1/2 inch) for
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>.
- <p>
- <a name="PARA_INDENT_FIRST"><h3><u>7. Indenting initial paragraphs -- INDENT_FIRST_PARAS</u></h3></a>
- <p>
- By default, <strong>mom</strong> does not indent the first paragraph
- of a document, nor the first paragraph after a head or
- subhead, nor the first paragraphs of
- <a href="#EPIGRAPH_INTRO">epigraphs</a>,
- <a href="#BLOCKQUOTE_INTRO">blockquotes</a>
- or
- <a href="#FOOTNOTE_INTRO">footnotes</a>
- that run to more than one paragraph.
- <a name="INDENT_FIRST_PARAS"></a>
- <p>
- If you wish to have first paragraphs indented, invoke the macro
- <strong>.INDENT_FIRST_PARAS</strong> with no argument, either
- before or after
- <a href="docprocessing.html#START">START</a>.
- <strong>INDENT_FIRST_PARAS</strong> is a toggle macro, therefore
- passing it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels
- its effect, meaning that first paragraphs will once again NOT be
- indented.
- <p>
- <a name="PP_SPACE"><h3><u>8. Spacing paragraphs -- PARA_SPACE</u></h3></a>
- <p>
- By default, <strong>mom</strong> does not insert a blank line
- between paragraphs. If you would like her to do so, invoke the
- macro <code>.PARA_SPACE</code> with no argument, either
- before or after
- <a href="docprocessing.html#START">START</a>.
- <strong>PARA_SPACE</strong> is a toggle macro, therefore passing
- it any argument (<strong>OFF, QUIT, Q, X</strong>...) cancels its
- effect, meaning that paragraphs will once again NOT be separated by
- a blank line.
- <p>
- <strong>NOTE:</strong> If <strong>PARA_SPACE</strong> is on,
- <strong>mom</strong> spaces only those paragraphs that come after
- an "initial" paragraph. Initial paragraphs are those
- that come immediately after the
- <a href="definitions.html#TERMS_DOCHEADER">docheader</a>,
- <a href="#EPIGRAPH_INTRO">epigraphs</a>,
- <a href="#HEAD_INTRO">heads</a>,
- <a href="#SUBHEAD_INTRO">subheads</a>
- and
- <a href="#LINEBREAK_INTRO">linebreaks</a>.
- (The first paragraph after these document elements requires no
- blank line to separate it from other paragraphs.)
- <p>
- Sometimes, you can be fairly deep into a document before using
- <strong>.PP</strong> for the first time, and when you do, because
- <strong>mom</strong> is still waiting for that "initial"
- paragraph, she doesn't space it with a blank line, even though
- you expect her to. The simple workaround for this is to invoke
- <strong>.PP</strong> <em>twice</em> (in succession) at the point you
- expect the blank line to appear.
- <br>
- <hr>
- <!====================================================================>
- <a name="HEAD_INTRO"><h2><u>Main heads</u></h2></a>
- <ul>
- <li><a href="#HEAD">Tag: HEAD</a>
- <li><a href="#HEAD_CONTROL">Head control macros</a>
- </ul>
- <p>
- Main heads -- or, in this documentation, just "heads"
- -- should be used any place you want titles to introduce major
- sections of a document. If you wish, <strong>mom</strong> can number
- your heads for you. Head numbers can also be included
- hierarchically in numbered
- <a href="#SUBHEAD_INTRO">subheads</a>
- and
- <a href="#PARAHEAD_INTRO">paraheads</a>.
- <p>
- By default, heads are centred on the page, underlined,
- all in caps. A double linespace precedes each head. In <a
- href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, heads
- are bold, slightly larger than paragraph text.
- <p>
- If these defaults don't suit you, you can change them with the
- head control macros.
- <p>
- <!---HEAD--->
- <hr width="66%" align="left">
- <p>
- <a name="HEAD">
- <nobr>Macro: <strong>HEAD</strong> "<text of head>" [ "<2nd line>" [ "<3rd line>" ... ] ]</nobr>
- </a>
- <p>
- The argument to <strong>HEAD</strong> is the text of the head,
- surrounded by double-quotes. If you need additional lines for a
- head, simply surround each line with double-quotes.
- <p>
- <strong>NOTE:</strong> If a head falls near the bottom of an output page
- and <strong>mom</strong> is unable to fit the head <em>plus at least
- one line of text underneath it</em>, she will set the head at the
- top of the next page.
- <p>
- <strong>ADDITIONAL NOTE:</strong> If an
- <a href="definitions.html#TERMS_INPUTLINE">input line</a>
- in a head (i.e. one of the lines surrounded by double-quotes) has
- to be broken by <strong>mom</strong> in order to fit the current
- line-length (say, a narrow column measure), the head underline
- (underscore) will not behave. You'll recognize the problem as soon
- as you preview your document. If you encounter a head that
- misbehaves with respect to underlining, the solution is to
- supply each line <em>as you want it</em> as a separate argument
- (surrounded by double-quotes) to the <strong>HEAD</strong> macro.
- <p>
- For example, if <strong>mom</strong> breaks
- <pre>
- .HEAD "This is a very, very, very long head"
- </pre>
- into
- <pre>
- This is a very, very, very
- long head
- </pre>
- you'll see the misbehaving underscore and should change the
- argument to <strong>HEAD</strong> to
- <pre>
- .HEAD "This is a very, very very" "long head"
- </pre>
- <a name="HEAD_CONTROL"><h3><u>Head control macros</u></h3></a>
- <p>
- There are, in addition to the usual family/font/size/quad control
- macros, a number of macros to manage head numbering, spacing,
- underlining, and so on. Check them out if you're unhappy with
- <strong>mom</strong>'s defaults.
- <p>
- <ol>
- <li><a href="#HEAD_GENERAL">Family/font/size/colour/quad</a>
- <li><a href="#HEAD_CAPS">Caps</a>
- <li><a href="#HEAD_SPACE">Pre-head space</a>
- <li><a href="#HEAD_UNDERLINE">Underlining</a>
- <li><a href="#NUMBER_HEADS">Numbering</a>
- <li><a href="#RESET_HEAD_NUMBER">Reset head numbering</a>
- <li><a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>
- </ol>
- <p>
- <a name="HEAD_GENERAL"><h3><u>1. Family/font/size/colour/quad</u></h3></a>
- <p>
- See
- <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
- <p>
- <pre>
- .HEAD_FAMILY default = prevailing document family; default is Times Roman
- .HEAD_FONT default = bold
- .HEAD_SIZE default = +1 (point)
- .HEAD_COLOR default = black
- .HEAD_QUAD default = CENTER
- </pre>
- <a name="HEAD_CAPS"><h3><u>2. Capitalizing heads -- HEAD_CAPS</u></h3></a>
- <p>
- By default, <strong>mom</strong> sets heads in caps, regardless
- of the
- <a href="definitions.html#TERMS_STRINGARGUMENT">string(s)</a>
- you give to
- <a href="#HEAD">HEAD</a>.
- To change this behaviour, do
- <p>
- <pre>
- .HEAD_CAPS OFF
- </pre>
- <strong>HEAD_CAPS</strong> is a toggle macro, therefore you can use
- any argument you like instead of <strong>OFF</strong> (<strong>END,
- QUIT, Q, X</strong>...). To turn <strong>HEAD_CAPS</strong> back on,
- simply invoke it without an argument.
- <p>
- <a name="HEAD_SPACE"><h3><u>3. Space before heads -- HEAD_SPACE</u></h3></a>
- <p>
- By default, <strong>mom</strong> deposits 2 blank lines prior to every
- head. If you'd prefer just a single blank line, do
- <p>
- <pre>
- .HEAD_SPACE OFF
- </pre>
- <strong>HEAD_SPACE</strong> is a toggle macro, therefore you can use
- any argument you like instead of <strong>OFF</strong> (<strong>END,
- QUIT, Q, X</strong>...). To restore the space before heads to 2
- blank lines, invoke <strong>HEAD_SPACE</strong> without an argument.
- <p>
- <a name="HEAD_UNDERLINE"><h3><u>4. Underlining heads -- HEAD_UNDERLINE</u></h3></a>
- <p>
- By default, <strong>mom</strong> underlines heads. To change this
- behaviour, do
- <p>
- <pre>
- .HEAD_UNDERLINE OFF
- </pre>
- <strong>HEAD_UNDERLINE</strong> is a toggle macro, therefore you can
- use any argument you like instead of <strong>OFF</strong> (<strong>END,
- QUIT, Q, X</strong>...). To restore underlining of heads, invoke
- <strong>HEAD_UNDERLINE</strong> without an argument.
- <p>
- <a name="NUMBER_HEADS"><h3><u>5. Number heads -- NUMBER_HEADS</u></h3></a>
- <p>
- If you'd like your heads numbered, simply invoke
- <strong>NUMBER_HEADS</strong> with no argument. <strong>Mom</strong>
- will number all subsequent heads automatically (in ascending order,
- naturally).
- <p>
- If, in addition to numbering heads, you also request that
- <a href="#SUBHEAD_INTRO">subheads</a>
- and/or
- <a href="#PARAHEAD_INTRO">paraheads</a>
- be numbered, the head number will be included in their numbers
- (each number separated by a period [dot]).
- <p>
- Should you wish to stop head numbering, invoke
- <strong>NUMBER_HEADS</strong> with any argument (<strong>OFF, QUIT,
- END, X</strong>...). Head numbering will cease, and the head number
- will not be included in the numbering of subheads and/or paraheads.
- <p>
- <a name="RESET_HEAD_NUMBER"><h3><u>6. Reset head numbering -- RESET_HEAD_NUMBER</u></h3></a>
- <p>
- Should you wish to reset the head number to "1", invoke
- <strong>RESET_HEAD_NUMBER</strong> with no argument. If, for some
- reason, you want <strong>mom</strong> to use a head number that is not
- the next in ascending order (i.e. the last head number + 1), invoke
- <strong>RESET_HEAD_NUMBER</strong> with the number you want, e.g.
- <p>
- <pre>
- .RESET_HEAD_NUMBER 6
- </pre>
- Your next head will be numbered "6" and subsequent heads will
- be numbered in ascending order from "6".
- <p>
- <a name="HEAD_INLINES"><h3><u>7. Vertical inline escapes inside heads</u></h3></a>
- <p>
- If you need to adjust the
- <a href="definitions.html#TERMS_BASELINE">baseline</a>
- position of a head (e.g. the head falls at the top of a column and
- you want its
- <a href="definitions.html#TERMS_ASCENDER">ascenders</a>
- to line up with the ascenders of
- <a href="definitions.html#TERMS_RUNNING">running text</a>
- in other columns), you can embed a vertical motion
- <a href="definitions.html#TERMS_INLINES">inline escape</a>
- (either
- <a href="inlines.html#INLINE_VERTICAL_MOM">mom</a>'s
- or
- <a href="inlines.html#INLINE_VERTICAL_GROFF">groff</a>'s
- in the string(s) you pass to <strong>HEAD</strong>
- <p>
- For example,
- <p>
- <pre>
- .HEAD "\[ALD3]Text of head"
- or
- .HEAD "\[DOWN 3p]Text of head"
- </pre>
- will lower the baseline of the head by three points. Note that
- there's no need to reverse the sense of the inline escape.
- <p>
- In the case of heads that run to more than one line, you must embed
- the escape in the string for each line, like this:
- <p>
- <pre>
- .HEAD "\[ALD3]First line" "\[ALD3]Next line"
- or
- .HEAD "\[DOWN 3p]First line" "\[DOWN 3p]Next line"
- </pre>
- <hr>
- <!====================================================================>
- <a name="SUBHEAD_INTRO"><h2><u>Subheads</u></h2></a>
- <ul>
- <li><a href="#SUBHEAD">Tag: SUBHEAD</a>
- <li><a href="#SUBHEAD_CONTROL">Subhead control macros</a>
- </ul>
- <p>
- Subheads should be used any place you want titles to introduce
- sections of a document below heads. If you wish, <strong>mom</strong>
- can number subheads for you. Subhead numbers can also be included
- hierarchically in numbered
- <a href="#PARAHEAD_INTRO">paraheads</a>.
- <p>
- By default, subheads are flush left. In
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
- they are set bold, slightly larger than paragraph text. In
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
- they are underlined. A single linespace precedes them in both
- printstyles, and a tiny space adjustment raises them slightly
- above text that comes afterwards for greater clarity in
- document structuring.
- <p>
- If these defaults don't suit you, you can change them with the
- subhead control macros.
- <p>
- <!---SUBHEAD--->
- <hr width="66%" align="left">
- <p>
- <a name="SUBHEAD">
- <nobr>Macro: <strong>SUBHEAD</strong> "<text of subhead>" [ "<2nd line>" [ "<3rd line>" ... ] ]</nobr>
- </a>
- <p>
- The argument to <strong>SUBHEAD</strong> is the text of the subhead,
- surrounded by double-quotes. If you need additional lines for a
- subhead, simply surround each line with double-quotes.
- <p>
- <strong>NOTE:</strong> If a subhead falls near the bottom of an output
- page and <strong>mom</strong> is unable to fit the head <em>plus at
- least one line of text underneath it</em>, she will set the subhead
- at the top of the next page.
- <a name="SUBHEAD_CONTROL"><h3><u>Subhead control macros</u></h3></a>
- <p>
- In addition to the usual family/font/size/quad control
- macros, there are macros to manage subhead numbering.
- <p>
- <ol>
- <li><a href="#SUBHEAD_GENERAL">Family/font/size/colour/quad</a>
- <li><a href="#NUMBER_SUBHEADS">Numbering</a>
- <li><a href="#RESET_SUBHEAD_NUMBER">Reset subhead numbering</a>
- <li><a href="#SUBHEAD_INLINES">Vertical inline escapes inside subheads</a>
- </ol>
- <p>
- <a name="SUBHEAD_GENERAL"><h3><u>1. Family/font/size/quad</u></h3></a>
- <p>
- See
- <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
- <p>
- <pre>
- .SUBHEAD_FAMILY default = prevailing document family; default is Times Roman
- .SUBHEAD_FONT default = bold
- .SUBHEAD_SIZE default = +.5 (point)
- .SUBHEAD_COLOR default = black
- .SUBHEAD_QUAD default = LEFT
- </pre>
- <a name="NUMBER_SUBHEADS"><h3><u>2. Number subheads -- NUMBER_SUBHEADS</u></h3></a>
- <p>
- If you'd like your subheads numbered, simply invoke
- <strong>.NUMBER_SUBHEADS</strong> with no argument.
- <strong>Mom</strong> will number all subsequent subheads automatically
- (in ascending order, naturally).
- <p>
- If, in addition to numbering subheads, you also request that
- <a href="#HEAD_INTRO">heads</a>
- be numbered, the head number will be included in the subhead number
- (separated by a period [dot]).
- <p>
- Should you wish to stop subhead numbering, invoke
- <strong>NUMBER_SUBHEADS</strong> with any argument (<strong>OFF, QUIT,
- END, X</strong>...). Subhead numbering will cease, and the subhead
- number will not be included in the numbering of paraheads.
- <p>
- <a name="RESET_SUBHEAD_NUMBER"><h3><u>3. Reset head numbering -- RESET_SUBHEAD_NUMBER</u></h3></a>
- <p>
- Should you wish to reset the subhead number to "1", invoke
- <strong>RESET_SUBHEAD_NUMBER</strong> with no argument. If, for some
- reason, you want <strong>mom</strong> to use a subhead number that is not
- the next in ascending order (i.e. the last subhead number + 1), invoke
- <strong>RESET_SUBHEAD_NUMBER</strong> with the number you want, e.g.
- <p>
- <pre>
- .RESET_SUBHEAD_NUMBER 4
- </pre>
- Your next subhead will be numbered "4" and subsequent
- subheads will be numbered in ascending order from "4".
- <a name="SUBHEAD_INLINES"><h3><u>Vertical inline escapes inside subheads</u></h3></a>
- See
- <a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>.
- The information there applies equally to subheads.
- <p>
- <hr>
- <!====================================================================>
- <a name="PARAHEAD_INTRO"><h2><u>Paragraph heads</u></h2></a>
- <ul>
- <li><a href="#PARAHEAD">Tag: PARAHEAD</a>
- <li><a href="#PARAHEAD_CONTROL">Parahead control macros</a>
- </ul>
- <p>
- Paragraph heads (paraheads) should be used any place you want titles
- to introduce paragraphs below heads or subheads. If you wish,
- <strong>mom</strong> can number paraheads for you.
- <p>
- By default, paraheads are joined to the body of a paragraph,
- slightly indented (provided the paragraph is not a
- "first" paragraph as defined in
- <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>).
- In
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
- they are set bold italic, slightly larger than paragraph text. In
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
- they are underlined.
- <p>
- If these defaults don't suit you, you can change them with the
- parahead control macros.
- <p>
- <!---PARAHEAD--->
- <hr width="66%" align="left">
- <p>
- <a name="PARAHEAD">
- <nobr>Macro: <strong>PARAHEAD</strong> "<text of parahead>"</nobr>
- </a>
- <p>
- <strong>PARAHEAD</strong> must come AFTER
- <a href="#PP">PP</a>
- or it will not work!
- <p>
- The argument is the text of the parahead, surrounded by double-quotes.
- Because paraheads are joined to the body of a paragraph, they accept
- only one argument (see
- <a href="#HEAD">HEAD</a>
- and
- <a href="#SUBHEAD">SUBHEAD</a>).
- <p>
- <a name="PARAHEAD_CONTROL"><h3><u>Parahead control macros</u></h3></a>
- <p>
- In addition to the family/font/size/colour/indent control macros,
- there are macros to manage parahead numbering.
- <p>
- <ol>
- <li><a href="#PARAHEAD_GENERAL">Family/font/size/color</a>
- <li><a href="#PARAHEAD_INDENT">Indent</a>
- <li><a href="#NUMBER_PARAHEADS">Numbering</a>
- <li><a href="#RESET_PARAHEAD_NUMBER">Reset parahead numbering</a>
- </ol>
- <p>
- <a name="PARAHEAD_GENERAL"><h3><u>1. Family/font/size/colour</u></h3></a>
- <p>
- See
- <a href="#CONTROL_MACRO_ARGS">Arguments to the control macros</a>.
- <p>
- <pre>
- .PARAHEAD_FAMILY default = prevailing document family; default is Times Roman
- .PARAHEAD_FONT default = bold italic
- .PARAHEAD_SIZE default = +.5 (point)
- <a name="PARAHEAD_COLOR">.PARAHEAD_COLOR default = black*</a>
- *If you colourize paragraph text, paraheads will appear in the same
- colour as the text unless you explicitly tell mom to colour them
- otherwise by invoking .PARAHEAD_COLOR. If you do want paraheads
- that are coloured the same as paragraph text, it's generally a good
- idea to invoke .PARAHEAD_COLOR anyway (with the same colour used
- for paragraph text), just to let mom know.
- </pre>
- <a name="PARAHEAD_INDENT"><h3><u>2. Indent</u></h3></a>
- <p>
- Unlike other control macros that end in
- <a href="#CONTROL_INDENTS"><strong>_INDENT</strong></a>,
- the argument to the macro that controls indenting of paragraph heads
- (<strong>PARAHEAD_INDENT</strong>) is NOT relative to the first-line
- indent of normal paragraphs. In other words, it takes an absolute
- value, and requires a
- <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>.
- For example, to set the paragraph head indent to 2-1/2 picas, you
- do:
- <p>
- <pre>
- .PARAHEAD_INDENT 2.5P
- </pre>
- <strong>Mom</strong>'s default indent for paragraph heads is 1/2
- the first-line indent of normal paragraphs (both printstyles).
- However, as stated above, if you choose to change the indent, you
- must give an absolute value (unless you're a groff expert and want
- to manipulate the number register <code>\n[#PP_INDENT]u</code>
- arithmetically as the argument to <strong>PARAHEAD_INDENT</strong>
- for an indent that's relative to <strong>PP_INDENT</strong>.)
- <p>
- <strong>NOTE:</strong> Paragraph heads in "first
- paragraphs", as defined in
- <a href="#PARA_INDENT_FIRST">Indenting initial paragraphs</a>,
- are not indented unless you turn
- <a href="#INDENT_FIRST_PARAS">INDENT_FIRST_PARAS</a>
- on.
- <p>
- <a name="NUMBER_PARAHEADS"><h3><u>3. Number paraheads -- NUMBER_PARAHEADS</u></h3></a>
- <p>
- If you'd like your paraheads numbered, simply invoke
- <strong>.NUMBER_PARAHEADS</strong> with no argument.
- <strong>Mom</strong> will number all subsequent paraheads automatically
- (in ascending order, naturally).
- <p>
- If, in addition to numbering paraheads, you also request that
- <a href="#HEAD_INTRO">heads</a>
- and
- <a href="#SUBHEAD_INTRO">subheads</a>
- be numbered, the head and/or subhead number will be included in the
- parahead number (separated by a period [dot]).
- <p>
- Should you wish to stop parahead numbering, invoke
- <strong>NUMBER_PARAHEADS</strong> with any argument (<strong>OFF,
- QUIT, END, X</strong>...). Parahead numbering will cease.
- <p>
- <a name="RESET_PARAHEAD_NUMBER"><h3><u>4. Reset head numbering -- RESET_PARAHEAD_NUMBER</u></h3></a>
- <p>
- Should you wish to reset the parahead number to "1", invoke
- <strong>RESET_PARAHEAD_NUMBER</strong> with no argument. If, for some
- reason, you want <strong>mom</strong> to use a parahead number that is not
- the next in ascending order (i.e. the last parahead number + 1), invoke
- <strong>RESET_PARAHEAD_NUMBER</strong> with the number you want, e.g.
- <p>
- <pre>
- .RESET_PARAHEAD_NUMBER 7
- </pre>
- Your next parahead will be numbered "7" and subsequent
- paraheads will be numbered in ascending order from "7".
- <p>
- <hr>
- <!====================================================================>
- <a name="LINEBREAK_INTRO"><h2><u>Author linebreaks</u></h2></a>
- <ul>
- <li><a href="#LINEBREAK">Tag: LINEBREAK</a>
- <li><a href="#LINEBREAK_CHAR">Linebreak character control macro</a>
- </ul>
- <p>
- By default, <strong>mom</strong> marks
- <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a>
- with three centred asterisks. You can change this behaviour
- with the linebreak character
- <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>.
- <p>
- <!---LINEBREAK--->
- <hr width="66%" align="left">
- <p>
- <a name="LINEBREAK">
- Macro: <strong>LINEBREAK</strong>
- </a>
- <br>
- Alias: <strong>SECTION</strong>
- <p>
- <strong>LINEBREAK</strong> takes no arguments. Simply invoke it
- (on a line by itself, of course) whenever you want to insert an
- author linebreak. The appearance of the linebreak is controlled
- by the
- <a href="#LINEBREAK_CHAR">LINEBREAK_CHAR</a>
- macro.
- <h3><u>Linebreak character control macro</u></h3>
- <p>
- <a name="LINEBREAK_CHAR">
- <nobr>Macro: <strong>LINEBREAK_CHAR</strong> [ <character> ] [ <iterations> [ <vertical adjustment> ] ]</nobr>
- </a>
- <br>
- Alias: <strong>SECTION_CHAR</strong>
- <br>
- <em>*The third optional argument requires a
- <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em>.
- <p>
- <strong>LINEBREAK_CHAR</strong> determines what <strong>mom</strong>
- prints when <strong>LINEBREAK</strong> is invoked. It takes 3
- optional arguments: the character you want deposited at the line
- break, the number of times you want the character repeated, and a
- vertical adjustment factor.
- <p>
- The first argument is any legal groff character (e.g. <kbd>*</kbd>
- [an asterisk], <kbd>\(dg</kbd> [a dagger], <kbd>\f(ZD\N'141\fP</kbd>
- [an arbitrary character from Zapf Dingbats], <kbd>\l'4P'</kbd>
- [a 4-pica long rule]). <strong>Mom</strong> sets the character
- centred on the current line length. (See "man groff_char"
- for a list of all legal groff characters.)
- <p>
- The second argument is the number of times to repeat the character.
- <p>
- The third argument is a +|- value by which to raise (+) or lower (-)
- the character in order to make it appear visually centred between
- sections of text. This lets you make vertical adjustments
- to characters that don't sit on the
- <a href="definitions.html#TERMS_BASELINE">baseline</a>
- (such as asterisks). The argument must be preceded by a plus or
- minus sign, and must include a unit of measure.
- <p>
- If you enter <strong>LINEBREAK_CHAR</strong> with no arguments,
- sections of text will be separated by two blank lines when you invoke
- <strong>LINEBREAK</strong>.
- <p>
- <strong>Mom</strong>'s default for <strong>LINEBREAK_CHAR</strong> is
- <p>
- <pre>
- .LINEBREAK_CHAR * 3 -3p
- </pre>
- i.e. three asterisks, lowered 3 points from their normal vertical
- position (for
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>;
- the vertical adjustment is -2 points for
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>).
- <h3><u>Linebreak colour control macro</u></h3>
- <p>
- <a name="LINEBREAK_COLOR">
- <nobr>Macro: <strong>LINEBREAK_COLOR</strong> <color name></nobr>
- </a>
- <p>
- To change the colour of the linebreak character(s), simply invoke
- <strong>LINBREAK_COLOR</strong> with the name of a pre-defined (or
- "initialized") colour.
- <br>
- <hr>
- <!====================================================================>
- <a name="QUOTE_INTRO"><h2><u>Quotes (line for line)</u></h2></a>
- <ul>
- <li><a href="#QUOTE">Tag: QUOTE</a>
- <li><a href="#QUOTE_CONTROL">Quote control macros</a>
- </ul>
- <p>
- <a href="definitions.html#TERMS_QUOTE">Quotes</a>
- are always set in
- <a href="definitions.html#TERMS_NOFILL">nofill mode</a>,
- flush left. This permits entering quotes on a line for line basis in
- your text editor and have them come out the same way on output copy.
- (See
- <a href="#BLOCKQUOTE_INTRO">Blockquotes</a>
- for how quotes, in the present sense, differ from longer
- passages of cited text.)
- <p>
- Since <strong>mom</strong> originally came into being to serve
- the needs of creative writers (i.e. novelists, short story
- writers, etc. -- not to cast aspersions on the creativity of
- mathematicians and programmers), she sets quotes in italics
- <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPESET)</a>
- or underlined
- <a href="docprocessing.html#PRINTSTYLE">(PRINTSTYLE TYPEWRITE)</a>,
- indented from the left margin. Obviously, she's thinking
- "quotes from poetry or song lyrics", but with the
- <a href="#QUOTE_CONTROL">quote control macros</a>
- you can change her defaults so <strong>QUOTE</strong> serves other
- needs, e.g. entering verbatim snippets of programming code, command
- line instructions, and so on. (See the
- <a href="#QUOTE_TIP">tip</a>
- below for suggestions about including programming code snippets in
- documents.)
- <p>
- <a name="QUOTE_SPACING"></a>
- Besides indenting quotes, <strong>mom</strong> further sets them
- off from
- <a href="definitions.html#TERMS_RUNNING">running text</a>
- with a small amount of vertical whitespace top and bottom. In
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>,
- this is always one full linespace. In
- <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>,
- it's 1/2 of the prevailing
- <a href="definitions.html#TERMS_LEADING">leading</a>
- if the quote fits fully on the page (i.e. with running text above
- and below it), otherwise it's a full linespace either above or below
- as is necessary to balance the page to the bottom margin. This
- behaviour…