diff options
| author | wlemb <wlemb> | 2004-02-22 09:22:12 +0000 |
|---|---|---|
| committer | wlemb <wlemb> | 2004-02-22 09:22:12 +0000 |
| commit | 52911304ea8b0eaf55947013a6524abff547fa39 (patch) | |
| tree | e54b3d4c0eb43b23290f775bb0400c6e6722d5a7 /contrib/mom/momdoc/docelement.html | |
| parent | 0ca21c8d6c4931abca01f669e3215b7952827f2a (diff) | |
| download | groff-52911304ea8b0eaf55947013a6524abff547fa39.tar.gz | |
o Rewrote the macros associated with DOCTYPE LETTER so that the
user can enter DATE, TO and FROM in any order s/he likes. For
backward compatibility, if the older, fixed order (DATE-TO-FROM)
is used, the date goes flush right with two linespaces after
it, while the other fields go flush left with a single linespace
separating them.
o Fixed handling of DOCHEADER OFF <distance> when <distance> fell
short of the top margin of running text (the change is actually
in the SHIM macro, which is called by DOCHEADER).
o Added a selection of iso 639 two-letter language codes as
optional arguments to SMARTQUOTES, so that the use can enter
her/his language code to get language specific quoting styles
o Changed the way the strings for \*[ST<n>], \*[ST<n>X], \*[FU<n>
and \*[BU<n> are read. Formerly, they were entered literally.
Now they're entered as an array.
Diffstat (limited to 'contrib/mom/momdoc/docelement.html')
| -rw-r--r-- | contrib/mom/momdoc/docelement.html | 272 |
1 files changed, 174 insertions, 98 deletions
diff --git a/contrib/mom/momdoc/docelement.html b/contrib/mom/momdoc/docelement.html index 2413ead4..988963ff 100644 --- a/contrib/mom/momdoc/docelement.html +++ b/contrib/mom/momdoc/docelement.html @@ -10,10 +10,10 @@ <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"> - <h2 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h2> + <h1 align="center"><u>THE DOCUMENT ELEMENT TAGS</u></h1> </a> <ul> @@ -54,6 +54,7 @@ she does things. This is usually done prior to 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> @@ -101,7 +102,7 @@ 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. She how she behaves. +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. @@ -109,6 +110,7 @@ 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> @@ -158,7 +160,7 @@ one point greater than the footnote's point size), do .FOOTNOTE_AUTOLEAD 1 </pre> -<a name="CONTROL_INDENTS"><h3>Indents</h3></a> +<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 @@ -172,7 +174,8 @@ correct indent for a particular tag. 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> @@ -258,17 +261,17 @@ arguments as </ul> <p> <a href="definitions.html#TERMS_EPIGRAPH">Epigraphs</a> -color, flavour, or comment on the document they precede. Typically, -they are centered at the top of a document's first page (underneath the +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 centered and +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." -<br> +<p> <!---EPIGRAPH---> @@ -312,6 +315,7 @@ 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> @@ -375,7 +379,7 @@ 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 (particulary stories and chapters) +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. @@ -399,7 +403,7 @@ that blank lines should be interpreted as <strong>PP</strong>'s. .blm PP </pre> tells groff that all blank lines are really the macro <strong>PP</strong>. -<br> +<p> <!---PP---> @@ -433,11 +437,12 @@ element tags. <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">Intitial paragraphs 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 @@ -456,8 +461,10 @@ 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>, @@ -474,8 +481,10 @@ 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_LEADING"><h3><u>3. Leading</u></h3></a> +<p> The paragraph <a href="definitions.html#TERMS_LEADING">leading</a> is set with @@ -505,15 +514,17 @@ 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>4. 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/center) is set with +left/right/centre) is set with <a href="typesetting.html#JUSTIFY">JUSTIFY</a> or <a href="typesetting.html#QUAD">QUAD</a> @@ -542,12 +553,17 @@ 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 justified for -<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPESET</a> -and quad left for -<a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE_TYPEWRITE</a>. - +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>5. 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 @@ -569,7 +585,7 @@ paragraphs, <strong>PARA_INDENT</strong> also affects <a href="#QUOTE_INTRO">quotes</a> and <a href="#BLOCKQUOTE_INTRO">blockquotes</a>, -whose overal indenting from the left and (where applicable) right +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 @@ -580,8 +596,10 @@ 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>6. 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 @@ -600,8 +618,10 @@ before or after 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>7. 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 @@ -611,7 +631,7 @@ before or after 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. -<br> +<p> <hr> <!====================================================================> @@ -631,14 +651,14 @@ hierarchically in numbered and <a href="#PARAHEAD_INTRO">paraheads</a>. <p> -By default, heads are centered on the page, underlined, +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. -<br> +<p> <!---HEAD---> @@ -663,7 +683,7 @@ top of the next page. 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 recognise the problem as soon +(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 @@ -715,6 +735,7 @@ See </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> @@ -730,8 +751,10 @@ To change this behaviour, do 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> @@ -743,8 +766,10 @@ head. If you'd prefer just a single blank line, do 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> @@ -756,8 +781,10 @@ behaviour, do 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, @@ -774,8 +801,10 @@ 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 @@ -788,8 +817,10 @@ the next in ascending order (i.e. the last head number + 1), invoke 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 @@ -800,9 +831,9 @@ to line up with the ascenders of 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's</a> +<a href="inlines.html#INLINE_VERTICAL_MOM">mom</a>'s or -<a href="inlines.html#INLINE_VERTICAL_GROFF">groff's</a> +<a href="inlines.html#INLINE_VERTICAL_GROFF">groff</a>'s in the string(s) you pass to <strong>HEAD</strong> <p> For example, @@ -851,7 +882,7 @@ document structuring. <p> If these defaults don't suit you, you can change them with the subhead control macros. -<br> +<p> <!---SUBHEAD---> @@ -895,6 +926,7 @@ See </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 @@ -909,8 +941,10 @@ 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 @@ -928,9 +962,7 @@ subheads will be numbered in ascending order from "4". See <a href="#HEAD_INLINES">Vertical inline escapes inside heads</a>. The information there applies equally to subheads. - - -<br> +<p> <hr> <!====================================================================> @@ -957,7 +989,7 @@ they are underlined. <p> If these defaults don't suit you, you can change them with the parahead control macros. -<br> +<p> <!---PARAHEAD---> @@ -977,6 +1009,7 @@ 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> @@ -1002,6 +1035,7 @@ See </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 @@ -1029,8 +1063,10 @@ paragraphs", as defined in 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 @@ -1046,8 +1082,10 @@ parahead number (separated by a period [dot]). 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 @@ -1060,7 +1098,7 @@ the next in ascending order (i.e. the last parahead number + 1), invoke Your next parahead will be numbered "7" and subsequent paraheads will be numbered in ascending order from "7". -<br> +<p> <hr> <!====================================================================> @@ -1073,10 +1111,10 @@ paraheads will be numbered in ascending order from "7". <p> By default, <strong>mom</strong> marks <a href="definitions.html#TERMS_LINEBREAK">author linebreaks</a> -with three centered asterisks. You can change this behaviour +with three centred asterisks. You can change this behaviour with the linebreak character <a href="definitions.html#TERMS_CONTROLMACRO">control macro</a>. -<br> +<p> <!---LINEBREAK---> @@ -1114,12 +1152,13 @@ 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 -centered on the current line length. +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 centered between +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> @@ -1141,7 +1180,7 @@ 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>). -<br> +<p> <hr> <!====================================================================> @@ -1205,7 +1244,7 @@ as does the control macro <p> <a name="QUOTE_TIP"><strong>TIP:</strong></a> If you want to include snippets of programming code in -<strong>mom</strong> documents, you may come acropper of the fact +<strong>mom</strong> documents, you may come a cropper of the fact that groff (and <strong>mom</strong>'s) escape character is the backslash. In order for <strong>mom</strong> not to interpret backslashes that occur in code snippets as escapes, you have to @@ -1293,6 +1332,7 @@ See </pre> <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a> +<p> If you'd like <strong>mom</strong> always to put a full linespace above and below quotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong> with no argument. If you wish to restore <strong>mom</strong>'s @@ -1304,8 +1344,10 @@ X</strong>...) <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s spacing policy for <a href="#BLOCKQUOTE_INTRO">blockquotes</a>. +<p> <a name="UNDERLINE_QUOTES"><h3><u>3. Underlining -- UNDERLINE_QUOTES (typewrite only)</u></h3></a> +<p> By default in <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, <strong>mom</strong> underlines quotes. If you'd rather she didn't, @@ -1323,8 +1365,10 @@ of italics by default in <strong>PRINTSTYLE TYPEWRITE</strong>, you must also make sure that <strong>ITALIC_MEANS_ITALIC</strong> is enabled (see <a href="docprocessing.html#TYPEWRITE_CONTROL">PRINTSTYLE TYPEWRITE control macros</a>). +<p> <a name="BREAK_QUOTE"><h3><u>4. Manually break a footnoted quote -- BREAK_QUOTE</u></h3></a> +<p> Exceptionally, a quote or blockquote containing a footnote may cross a page or column. When this happens, the footnote marker may not be correct for its position relative to other footnotes on the page, and @@ -1338,7 +1382,7 @@ will be marked correctly and appear on the correct page. <strong>BREAK_QUOTE</strong> may be used with both quotes and blockquotes, and hence is aliased as <strong>BREAK_BLOCKQUOTE, BREAK_CITATION</strong> and <strong>BREAK_CITE</strong>. -<br> +<p> <hr> <!====================================================================> @@ -1380,7 +1424,7 @@ but know that there will be Bottom Margin Consequences unless you use the <a href="docprocessing.html#SHIM">SHIM</a> macro after you turn the blockquote off. -<br> +<p> <!---BLOCKQUOTE---> @@ -1440,6 +1484,7 @@ See </pre> <a name="ALWAYS_FULLSPACE_QUOTES"><h3><u>2. Spacing above and below -- ALWAYS_FULLSPACE_QUOTES (typeset only)</u></h3></a> +<p> If you'd like <strong>mom</strong> always to put a full linespace above and below blockquotes, invoke <strong>.ALWAYS_FULLSPACE_QUOTES</strong> with no argument. If you wish to restore <strong>mom</strong>'s @@ -1451,7 +1496,7 @@ X</strong>...). <strong>NOTE:</strong> This macro also sets <strong>mom</strong>'s spacing policy for <a href="#QUOTE_INTRO">quotes</a>. -<br> +<p> <hr> <!====================================================================> @@ -1514,7 +1559,7 @@ you to the left margin of running text. <p> Finally, lists can be used in documents created with either the document processing macros or just the typesetting macros. -<br> +<p> <!---LIST---> @@ -1531,7 +1576,7 @@ Afterwards, each block of input text preceded by on a line by itself, is treated as a list item. <p> The optional arguments <strong>BULLET</strong>, -<strong>DASH</strong>, <strong>DIGIT</strong> (for arabic +<strong>DASH</strong>, <strong>DIGIT</strong> (for Arabic numerals), <strong>ALPHA</strong> (for lowercase letters) and <strong>USER</strong> allow you to say what kind of enumerator you want for a given list. @@ -1643,7 +1688,7 @@ Within nested lists, <strong>mom</strong> stores the enumerator, separator and indent for any list you return <em>backwards</em> to (i.e. with <strong>LIST OFF</strong>), but does not store any information for lists you move <em>forward</em> to. -<br> +<p> <hr width="33%" align="left"> <p> @@ -1774,7 +1819,7 @@ digit-enumerated list, the enumerator continues incrementing from where it left off. That means, in the example above, the normal state of affairs for the alpha'ed list under "2. Feed the cat" would be c), d) and e). The solution, in such a case, is -simply to reset the enumerator --before <strong>ITEM</strong>! -- +simply to reset the enumerator --before <strong>ITEM</strong>!-- with the macro, <strong>RESET_LIST</strong>. <p> <strong>RESET_LIST</strong> does exactly what it says -- resets the @@ -1808,7 +1853,7 @@ If you want the extra space to the left, invoke Of course, if the number of items in the list is less than ten (10), there's no need for <strong>PAD_LIST_DIGITS</strong>. -<br> +<p> <hr> <!====================================================================> @@ -1840,7 +1885,7 @@ and be done with it. (Note the obligatory use of the <strong>Mom</strong> takes care of everything: putting footnote markers in the body of the document, keeping track of how many footnotes are on the page, identifying the footnotes -themeselves appropriately, balancing them properly with the botton +themselves appropriately, balancing them properly with the bottom margin, deferring footnotes that don't fit on the page... Even if you're using <a href="columns.html#COLUMNS">COLUMNS</a>, @@ -1848,6 +1893,7 @@ you're using <p> Footnotes can be sly little beasts, though. If you're writing a document that's footnote-heavy, you might want to read the following. +<p> <a name="FOOTNOTE_BEHAVIOUR"><h3><u>Footnote behaviour</u></h3></a> <p> @@ -1899,7 +1945,7 @@ Exceptionally, you may encounter problems with footnotes inside quotes and blockquotes that cross a page or column. See <a href="#BREAK_QUOTE">BREAK_QUOTE</a> for a solution. -<br> +<p> <!---FOOTNOTE---> @@ -1980,6 +2026,7 @@ See </pre> <a name="FOOTNOTE_MARKERS"><h3><u>2. Footnote markers -- FOOTNOTE_MARKERS</u></h3></a> +<p> If you don't want footnote markers, in either the body of the document or beside footnote entries themselves, toggle them off with <strong>.FOOTNOTE_MARKERS OFF</strong> (or @@ -1987,8 +2034,10 @@ them off with <strong>.FOOTNOTE_MARKERS OFF</strong> (or you'll have to roll your own. If you want them back on, invoke <strong>.FOOTNOTE_MARKERS</strong> with no argument. Footnote markers are on by default. +<p> <a name="FOOTNOTE_MARKER_STYLE"><h3><u>3. Footnote marker style -- FOOTNOTE_MARKER_STYLE</u></h3></a> +<p> <strong>Mom</strong> gives you two choices of footnote marker style: star+dagger (see <a href="#FOOTNOTE_BEHAVIOUR">footnote behaviour</a> @@ -2004,23 +2053,29 @@ themselves. By default, footnote numbers increase incrementally (prev. footnote number + 1) throughout the whole document. You can ask <strong>mom</strong> to start each page's footnote numbers at 1 with <strong>.RESET_FOOTNOTE_NUMBER</strong> (see below). +<p> <a name="RESET_FOOTNOTE_NUMBER"><h3><u>4. Reset footnote number -- RESET FOOTNOTE NUMBER</u></h3></a> +<p> <strong>.RESET_FOOTNOTE_NUMBER</strong>, by itself, resets footnote numbering so that the next footnote you enter is numbered 1. <p> <strong>.RESET_FOOTNOTE_NUMBER PAGE</strong> tells <strong>mom</strong> to start every page's footnote numbering at 1. +<p> <a name="FOOTNOTE_RULE"><h3><u>5. Footnote rule -- FOOTNOTE_RULE</u></h3></a> +<p> If you don't want a footnote separator rule, toggle it off with <strong>.FOOTNOTE_RULE OFF</strong> (or <strong>END, QUIT, X</strong>...). Toggle it back on by invoking <strong>.FOOTNOTE_RULE</strong> with no argument. The default is to print the rule. +<p> <a name="FOOTNOTE_RULE_LENGTH"><h3><u>6. Footnote rule length -- FOOTNOTE_RULE_LENGTH</u></h3></a> +<p> If you want to change the length of the footnote separator rule, invoke <strong>.FOOTNOTE_RULE_LENGTH</strong> with a length, like this, @@ -2035,7 +2090,10 @@ is required. The default is 4 <a href="definitions.html#TERMS_PICASPOINTS">picas</a> for both <a href="docprocessing.html#PRINTSTYLE">printstyles</a>. +<p> + <a name="FOOTNOTE_RULE_ADJ"><h3><u>7. Adjust vertical position of footnote separator rule -- FOOTNOTE_RULE_ADJ</u></h3></a> +<p> The footnote separator rule is actually a baseline rule that falls on the <a href="definitions.html#TERMS_BASELINE">baseline</a> @@ -2055,7 +2113,7 @@ raises the rule by 4-1/4 points. Note that you can only raise the rule, not lower it. A <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> is required. -<br> +<p> <hr> <!====================================================================> @@ -2076,14 +2134,14 @@ or <a href="definitions.html#TERMS_FOOTER">footers</a> (if they're on) and page numbering (if page numbers are at the bottom of the page) and deposits the word -END, centered after a blank line, beneath the last +END, centred after a blank line, beneath the last line of the document. END is enclosed between <a href="definitions.html#TERMS_EM">em-dashes</a>. <p> If you're writing in a language other than English, you can change what <strong>mom</strong> prints for END with the control macro <strong>FINIS_STRING</strong>. -<br> +<p> <!---FINIS---> @@ -2142,12 +2200,11 @@ a blank string, i.e. <strong>mom</strong> will still print the em-dashes if you invoke <strong>FINIS</strong>. This, in effect, produces a -short, centered horizontal rule that terminates the document. +short, centred horizontal rule that terminates the document. (In <a href="docprocessing.html.#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, it's a short, dashed line composed of four hyphens.) - -<br> +<p> <hr> <!====================================================================> @@ -2220,6 +2277,7 @@ to invoking <strong>QUOTE</strong> or <strong>BLOCKQUOTE</strong>, and undo them prior to terminating the endnote (i.e. before <strong>ENDNOTE OFF</strong>), otherwise the changes will affect subsequent quotes and blockquotes that appear in the document body as well. +<p> <a name="ENDNOTE_BEHAVIOUR"><h3><u>Endnote behaviour</u></h3></a> <p> @@ -2235,7 +2293,7 @@ the centre part of the removed. <p> By default, <strong>mom</strong> starts the endnotes page with a -bold, centered, double-underscored head, "ENDNOTES". +bold, centred, double-underscored head, "ENDNOTES". Underneath--flush left, bold, and underscored--she prints the document title (or, in the case of chapters, the chapter number or title). She then prints the endnotes. Each endnote is identified by its appropriate @@ -2254,11 +2312,11 @@ The attentive will notice that endnotes have an awful lot of control macros. This is because endnotes are like a mini-document unto themselves, and therefore need not be bound by the style parameters of the body of the document. +<p> <a name="ENDNOTE_SPACING"> <h3><u>A Note on Endnote Spacing</u></h3> </a> -<p> On the endnotes page(s), each new endnote is separated from the previous endnote by a full line space. This can result in a bottom margin that hangs, and is the one instance, other than the use of @@ -2274,18 +2332,18 @@ or <em>at the end of each endnote</em> (i.e. just before invoking <a href="#ENDNOTE">ENDNOTE OFF</a>) rather than at the top. +<p> <a name="ENDNOTE_COLUMNS"> <h3><u>Endnotes and columnar documents</u></h3> </a> -<p> Formerly (pre 1.1.6), there was no way to set a document in columns (see <a href="docprocessing.html#COLUMNS">COLUMNS</a>) and then turn off column mode for endnotes. As of version 1.1.6, you may now do so. See -<a href="#ENDNOTES_NO_COLUMNS">ENDNOTES_NO_COLUMS</a>. -<br> +<a href="#ENDNOTES_NO_COLUMNS">ENDNOTES_NO_COLUMNS</a>. +<p> <hr> <!---ENDNOTE---> @@ -2320,7 +2378,7 @@ it (i.e. <strong>mom</strong> will insert a word space between the word and the number). See the <a href="#ENDNOTE_EXAMPLE">endnote example</a> above. -<br> +<p> <!---ENDNOTES---> @@ -2350,7 +2408,7 @@ appropriately, on a separate page prior to starting the next section of the document. Each subsequent invocation of <strong>ENDNOTES</strong> outputs only those endnotes that <strong>mom</strong> collected after the previous invocation. -<br> +<p> <hr width="66%" align="left"> <a name="ENDNOTE_CONTROL"><h3><u>Endnote control macros</u></h3></a> @@ -2373,13 +2431,13 @@ to the first instance of <li><a href="#ENDNOTE_PARA_INDENT">Size of paragraph first line indent in multi-paragraph endnotes</a> <li><a href="#ENDNOTE_PARA_SPACE">Inserting space between paragraphs of multi-paragraph endnotes</a> <li><a href="#ENDNOTES_NO_COLUMNS">Turning off column mode during endnotes output</a> - <li>Pagination of endnotes + <li>Pagination of endnotes: <ul> <li><a href="#ENDNOTES_PAGENUM_STYLE">Endnotes-pages page numbering style</a> <li><a href="#ENDNOTES_FIRST_PAGENUMBER">Setting the first page number of endnotes pages</a> <li><a href="#ENDNOTES_NO_FIRST_PAGENUM">Omitting a page number on the first page of endnotes</a> </ul> - <li><a href="#SUSPEND_PAGINATION">Suspending pagination of endotes pages</a> + <li><a href="#SUSPEND_PAGINATION">Suspending pagination of endnotes pages</a> </ul> <li><a href="#ENDNOTES_HEADER_CONTROL"><strong>Endnotes-page header/footer control</strong></a> <ul> @@ -2392,7 +2450,7 @@ to the first instance of <li><a href="#ENDNOTE_STRING">Creating/modifying the endnotes-page head</a> <li><a href="#ENDNOTE_STRING_CONTROL">Endnotes-page head control</a> <li><a href="#ENDNOTE_STRING_UNDERSCORE">Endnotes-page head underscoring</a> - <li><a href="#ENDNOTE_STRING_CAPS">Endnotes-page head capitalisation</a> + <li><a href="#ENDNOTE_STRING_CAPS">Endnotes-page head capitalization</a> </ul> <li><a href="#ENDNOTES_DOC_TITLE"><strong>Endnote document-identification title</strong></a> <ul> @@ -2462,6 +2520,7 @@ the point size of other endnote page elements is calculated. The default for <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a> is 12.5 points (the same default size used in the body of the document). +<p> <!---ENDNOTE_LEAD---> @@ -2511,6 +2570,7 @@ is 14 points, adjusted. default, adjust endnote leading. You MUST enter <strong>ENDNOTE_LEAD <lead></strong> with no <strong>ADJUST</strong> argument to disable this default behaviour. +<p> <!---SINGLESPACE_ENDNOTES---> @@ -2527,13 +2587,14 @@ single-spaced, endnotes are single-spaced. <p> If, for some reason, you'd prefer that endnotes be single-spaced in an otherwise double-spaced document (including double-spaced -<a href="rectoverso.html#COLLATE">collated</a> documents), invoke -<strong>SINGLESPACE_ENDNOTES</strong> with no argument. And if, -god help you, you want to change endnote single-spacing back to -double-spacing for different spacing of endnotes output at the ends -of separate docs in a collated doc, invoke -<strong>SINGLESPACE_ENDNOTES</strong> with any argument(<strong>OFF, -QUIT, Q, X</strong>...). +<a href="rectoverso.html#COLLATE">collated</a> +documents), invoke <strong>SINGLESPACE_ENDNOTES</strong> with +no argument. And if, god help you, you want to change endnote +single-spacing back to double-spacing for different spacing of +endnotes output at the ends of separate documents in a collated +document, invoke <strong>SINGLESPACE_ENDNOTES</strong> with any +argument (<strong>OFF, QUIT, Q, X</strong>...). +<p> <!---ENDNOTE_PARA_INDENT---> @@ -2561,6 +2622,7 @@ for (the one attached immediately to the identifying endnote number) is never indented. Only subsequent paragraphs are affected by <strong>ENDNOTE_PARA_INDENT</strong>. +<p> <!---ENDNOTE_PARA_SPACE---> @@ -2580,6 +2642,7 @@ endnotes. <strong>NOTE:</strong> Each endnote itself is always separated from any previous endnote by a line space. <strong>ENDNOTE_PARA_SPACE</strong> refers only to paragraphs that appear within each discrete endnote. +<p> <!---ENDNOTES_NO_COLUMNS---> @@ -2601,6 +2664,7 @@ If you output endnotes at the end of each document in a document set in columns, column mode will automatically be reinstated for each document, even with <strong>ENDNOTES_NO_COLUMNS</strong> turned on. +<p> <!---ENDNOTES_PAGENUM_STYLE---> @@ -2639,6 +2703,7 @@ you have to reset every separate document's first page number after <a href="rectoverso.html#COLLATE">COLLATE</a> and before <a href="docprocessing.html#START">START</a>. +<p> <!---ENDNOTES_NO_FIRST_PAGENUN---> @@ -2652,6 +2717,7 @@ tells <a href="#ENDNOTES">ENDNOTES</a> not to print a page number on the first endnotes page. <strong>Mom</strong>'s default is to print the page number. +<p> <!---SUSPEND_PAGINATION---> @@ -2671,6 +2737,7 @@ continues, however to increment page numbers silently. To restore normal document pagination after endnotes, invoke <strong>RESTORE_PAGINATION</strong> (again, with no argument) immediately after <strong>ENDNOTES</strong>. +<p> <a name="ENDNOTES_HEADER_CONTROL"><h2><u>2. Endnotes-page header/footer control</u></h2></a> <p> @@ -2693,7 +2760,7 @@ the endnotes page(s) headers/footers, invoke with no argument. <p> An important change you may want to make is to put the word -"Endnotes" in the header/footer center position. +"Endnotes" in the header/footer centre position. To do so, do <p> <pre> @@ -2707,8 +2774,9 @@ prior to invoking <strong>.ENDNOTES</strong>. If your is <kbd>CHAPTER</kbd>, you must also invoke <a href="#ENDNOTES_HDRFTR_CENTER">ENDNOTES_HEADER_CENTER</a> for the <strong>HEADER_CENTER</strong> to appear. +<p> -<a name="ENDNOTES_HDRFTR_CENTER"><h3><u>*Endnotes page(s) header/footer center string</u></h3></a> +<a name="ENDNOTES_HDRFTR_CENTER"><h3><u>*Endnotes page(s) header/footer centre string</u></h3></a> <p> Macro: <strong>ENDNOTES_HEADER_CENTER</strong> <var>toggle</var> @@ -2719,11 +2787,12 @@ is <kbd>CHAPTER</kbd> and you want <strong>mom</strong> to include a centre string in the headers/footers that appear on endnotes pages, invoke <strong>ENDNOTES_HEADER_CENTER</strong> (or <strong>ENDNOTES_FOOTER_CENTER</strong>) with no argument. -<strong>Mom</strong>'s default is NOT to print the center string. +<strong>Mom</strong>'s default is NOT to print the centre string. <p> -If, for some reason, having enabled the header/footer center string +If, for some reason, having enabled the header/footer centre string on endnotes pages, you wish to disable it, invoke the same macro with any argument (<strong>OFF, QUIT, Q, X</strong>...). +<p> <a name="ENDNOTES_ALLOWS_HEADERS"><h3><u>*Allow headers on endnotes_pages</u></h3></a> <p> @@ -2748,6 +2817,7 @@ If you want headers on every page <em>including the first</em>, do <strong>mom</strong> prints footers on every endnotes page. This is a style convention. In <strong>mom</strong>, there is no such beast as <strong>ENDNOTES_ALLOWS_FOOTERS OFF</strong>. +<p> <a name="ENDNOTES_MAIN_TITLE"><h2><u>3. Endnotes-page first page head (title) control</u></h2> @@ -2766,6 +2836,7 @@ you don't want a head at the top of the first endnotes-page, invoke <strong>ENDNOTE_STRING</strong> with a blank argument (either two double-quotes side by side -- <kbd>""</kbd> -- or no argument at all). +<p> <!---ENDNOTE_STRING_CONTROL---> @@ -2778,7 +2849,7 @@ See .ENDNOTE_STRING_FAMILY default = prevailing document family; default is Times Roman .ENDNOTE_STRING_FONT* default = bold .ENDNOTE_STRING_SIZE default = +1 -.ENDNOTE_STRING_QUAD default = centered +.ENDNOTE_STRING_QUAD default = centred *Relative to the size of the endnotes text (set with ENDNOTE_PT_SIZE) </pre> @@ -2804,14 +2875,14 @@ NONE,</kbd> etc.) into your document prior to outputting endnotes with <!---ENDNOTE_STRING_CAPS---> -<a name="ENDNOTE_STRING_CAPS"><h3><u>*Endnotes-page head (title) automatic capitalisation</h3></u></a> +<a name="ENDNOTE_STRING_CAPS"><h3><u>*Endnotes-page head (title) automatic capitalization</h3></u></a> <p> Macro: <strong>ENDNOTE_STRING_CAPS</strong> <var>toggle</var> <p> Invoked by itself, <strong>ENDNOTE_STRING_CAPS</strong> will -automatically capitalise the endnotes-page head. Invoked with any -other argument, the macro disables automatic capitalisation of the +automatically capitalize the endnotes-page head. Invoked with any +other argument, the macro disables automatic capitalization of the head. <p> If you're generating a table of contents, you may want the @@ -2821,8 +2892,9 @@ case. If the argument to is in caps/lower case and <strong>ENDNOTE_STRING_CAPS</strong> is on, this is exactly what will happen. <p> -<strong>Mom</strong>'s default is to capitalise the endnotes-pages +<strong>Mom</strong>'s default is to capitalize the endnotes-pages head string. +<p> <!---ENDNOTE_TITLE---> @@ -2845,6 +2917,7 @@ double-quotes side by side -- <kbd>""</kbd> -- or no argument at all). This is particularly useful if you have a single (i.e. non-collated) document and find having the document's title included in the endnotes redundant. +<p> <!---ENDNOTE_TITLE_CONTROL---> @@ -2869,7 +2942,7 @@ See Macro: <strong>ENDNOTE_TITLE_UNDERSCORE</strong> <var>toggle</var> <p> -Inovked by itself, <strong>ENDNOTE_TITLE_UNDERSCORE</strong> will +Invoked by itself, <strong>ENDNOTE_TITLE_UNDERSCORE</strong> will underscore the endnote document-identification title(s). Invoked with any other argument, the macro disables underscoring of the title(s). <p> @@ -2877,6 +2950,7 @@ other argument, the macro disables underscoring of the title(s). insert <kbd>.ENDNOTE_TITLE_UNDERSCORE OFF</kbd> (or <kbd>QUIT, X, NO, NONE,</kbd> etc.) into your document prior to outputting endnotes with <a href="#ENDNOTES">ENDNOTES</a>. +<p> <!---ENDNOTE_NUMBERING---> @@ -2950,7 +3024,7 @@ endnotes, you'd want to do </pre> to ensure that the numbers hang and are properly right-aligned. -<br> +<p> <hr width="66%" align="left"> <!---ENDNOTE_NUMBERS_ALIGN_LEFT---> @@ -2976,8 +3050,6 @@ comes out like this: sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. </pre> - -<br> <hr> <!====================================================================> @@ -3009,6 +3081,7 @@ than endnotes. As always, the reason for so many control macros is so that if you want to change just about any aspect of the toc's typographic appearance, you can. <strong>Mom</strong> is all about simplicity AND flexibility. +<p> <a name="TOC_BEHAVIOUR"><h3><u>TOC behaviour</u></h3></a> <p> @@ -3062,7 +3135,7 @@ point size and indent of each type of toc entry (i.e. title, head, subhead, paragraph head). Furthermore, the page numbering style can be changed, as can the amount of visual space reserved for toc entry page numbers. -<br> +<p> <!---TOC---> @@ -3073,7 +3146,7 @@ entry page numbers. <p> If you want a toc, just put <strong>TOC</strong> as the last macro in a document. <strong>Mom</strong> takes care of the rest. -<br> +<p> <hr width="66%" align="left"> <a name="TOC_CONTROL"><h3><u>TOC control macros</u></h3></a> @@ -3135,6 +3208,8 @@ family. All elements on a toc page also have their own _FAMILY control macros, which override the default set by <strong>TOC_FAMILY</strong>. +<p> + <!---TOC_PT_SIZE---> <a name="TOC_PT_SIZE"><h3><u>*Toc point size</u></h3></a> @@ -3170,6 +3245,7 @@ The default for <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a> is 12.5 points (the same default size used in the body of the document). +<p> <!---TOC_LEAD---> @@ -3223,6 +3299,7 @@ default, adjust toc leading. You MUST enter <strong>ADDITIONAL NOTE:</strong> Tocs are always double-spaced in <strong>PRINTSTYLE TYPEWRITE</strong>, regardless of whether the body of the document is single-spaced. +<p> <a name="TOC_PAGENUMBERING"><h2><u>2. Toc page numbering</u></h2></a> <p> @@ -3241,7 +3318,7 @@ document pagination control macros immediately prior to A special macro, <a href="#TOC_PAGENUM_STYLE">TOC_PAGENUM_STYLE</a> controls the style of toc pages page numbers. -<br> +<p> <hr width="33%" align="left"> @@ -3264,8 +3341,8 @@ OFF</strong> or <strong>PAGINATE OFF</strong> disables toc pagination <em>for the first toc page only.</em> You MUST use <strong>.PAGINATE_TOC OFF</strong> to disable toc pagination, even if pagination is turned off elsewhere in your document. - <p> + <hr width="33%" align="left"> <p> @@ -3276,7 +3353,7 @@ if pagination is turned off elsewhere in your document. </a> <p> By default, <strong>mom</strong> uses roman numerals to number -toc pages. Use <strong>TOC_PAGENUM_STYLE</strong>if you'd prefer +toc pages. Use <strong>TOC_PAGENUM_STYLE</strong> if you'd prefer something else. For example, to have standard digits instead of roman numerals, do the following: <p> @@ -3284,9 +3361,8 @@ roman numerals, do the following: .TOC_PAGENUM_STYLE DIGIT </pre> -<br> <hr width="33%" align="left"> -<br> +<p> <a name="TOC_HEADER"><h2><u>3. Changing the toc header (title) string and style</u></h2></a> <p> @@ -3318,14 +3394,15 @@ paragraph heads as they appear in the toc. Their style is managed by the usual <a href="definitions.html#TERMS_CONTROLMACRO">control macros</a>, starting with TOC_ +<p> <a name="TOC_INDENT"><h3><u>The toc _INDENT control macros</u></h3></a> <p> The toc control macros that end in _INDENT all take a single argument that requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. -The argument is the distance to indent the entry from the left -margin. For example, +The argument is the distance to indent the entry, always measured +from the left margin. For example, <p> <pre> .TOC_HEAD_INDENT 2P @@ -3334,6 +3411,7 @@ margin. For example, indents head entries 2 <a href="definitions.html#TERMS_PICASPOINTS">picas</a> from the left margin. +<p> <a name="TOC_TITLE"><h3><u>*Changing the style for toc title entries</u></h3></a> <p> @@ -3416,8 +3494,8 @@ The following macros allow you to switch page margins should they be incorrect for recto/verso printing, to establish how many placeholders to leave for page listings, and to have <strong>mom</strong> append author(s) to toc title entries. +<p> -<br> <hr width="33%" align="left"> <!---TOC_RV_SWITCH---> @@ -3436,8 +3514,8 @@ want an odd, or vice versa. <p> The same result can be accomplished by outputting a <a href="#BLANK_PAGE">BLANKPAGE</a>. +<p> -<br> <hr width="33%" align="left"> <!---TOC_APPENDS_AUTHOR---> @@ -3469,8 +3547,8 @@ Deere--are responsible for a single article </pre> would be a good way to identify them in the toc. +<p> -<br> <hr width="33%" align="left"> <!---TOC_PADDING---> @@ -3488,7 +3566,6 @@ placeholders, say 2, do .TOC_PADDING 2 </pre> -<br> <hr> <!====================================================================> @@ -3518,9 +3595,8 @@ only want one blank page, you have to tell <strong>mom</strong>: <pre> .BLANKPAGE 1 </pre> - -<p> <hr> + <a href="headfootpage.html#TOP">Next</a> <a href="docprocessing.html#TOP">Prev</a> <a href="#TOP">Top</a> |