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 | |
| 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.
| -rw-r--r-- | contrib/mom/BUGS | 9 | ||||
| -rw-r--r-- | contrib/mom/ChangeLog | 21 | ||||
| -rw-r--r-- | contrib/mom/NEWS | 15 | ||||
| -rw-r--r-- | contrib/mom/TODO | 5 | ||||
| -rw-r--r-- | contrib/mom/examples/elvis_syntax.new | 1 | ||||
| -rw-r--r-- | contrib/mom/momdoc/appendices.html | 32 | ||||
| -rw-r--r-- | contrib/mom/momdoc/cover.html | 3 | ||||
| -rw-r--r-- | contrib/mom/momdoc/definitions.html | 41 | ||||
| -rw-r--r-- | contrib/mom/momdoc/docelement.html | 272 | ||||
| -rw-r--r-- | contrib/mom/momdoc/docprocessing.html | 141 | ||||
| -rw-r--r-- | contrib/mom/momdoc/goodies.html | 100 | ||||
| -rw-r--r-- | contrib/mom/momdoc/headfootpage.html | 152 | ||||
| -rw-r--r-- | contrib/mom/momdoc/inlines.html | 44 | ||||
| -rw-r--r-- | contrib/mom/momdoc/intro.html | 35 | ||||
| -rw-r--r-- | contrib/mom/momdoc/letters.html | 205 | ||||
| -rw-r--r-- | contrib/mom/momdoc/rectoverso.html | 33 | ||||
| -rw-r--r-- | contrib/mom/momdoc/reserved.html | 234 | ||||
| -rw-r--r-- | contrib/mom/momdoc/toc.html | 6 | ||||
| -rw-r--r-- | contrib/mom/momdoc/typemacdoc.html | 12 | ||||
| -rw-r--r-- | contrib/mom/momdoc/typesetting.html | 222 | ||||
| -rw-r--r-- | contrib/mom/momdoc/using.html | 16 | ||||
| -rw-r--r-- | contrib/mom/om.tmac | 482 |
22 files changed, 1223 insertions, 858 deletions
diff --git a/contrib/mom/BUGS b/contrib/mom/BUGS index 9fa7c77a..66cd839f 100644 --- a/contrib/mom/BUGS +++ b/contrib/mom/BUGS @@ -15,6 +15,15 @@ Also, please--no html email. That, too, gets nuked. ======================================================================== +Version 1.1.7 +============= + +When DOCHEADER OFF <distance> is given, if <distance> falls short +of the top margin of running text, <distance> is not respected and +bottom margin falls low. +---Fixed--- + + Version 1.1.6-e =============== diff --git a/contrib/mom/ChangeLog b/contrib/mom/ChangeLog index a8c4f4d6..c2898adb 100644 --- a/contrib/mom/ChangeLog +++ b/contrib/mom/ChangeLog @@ -1,3 +1,24 @@ +*Feb 20 2004 + +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. + *Jan 24 2004 o Added lists and associated macros. Mom now does (nested) lists. diff --git a/contrib/mom/NEWS b/contrib/mom/NEWS index 50cb5b10..04ce9abb 100644 --- a/contrib/mom/NEWS +++ b/contrib/mom/NEWS @@ -1,5 +1,16 @@ -Release 1.7 ------------ +Release 1.1.7-a +--------------- + +Increased the flexibility of SMARTQUOTES so that they handle quoting +styles by language, entered as a 2-digit language code argument to +SMARTQUOTES. See docs. + +Re-wrote the DOCTYPE LETTER macros so that DATE, TO and FROM can be +entered in any order the user wishes, with output that matches +input. (Should have done this in the first place.) + +Release 1.1.7 +------------- Finally got around to writing "list" macros. See the docs. diff --git a/contrib/mom/TODO b/contrib/mom/TODO index 4cff7e23..75e1ac09 100644 --- a/contrib/mom/TODO +++ b/contrib/mom/TODO @@ -1,3 +1,8 @@ +UNDERLINING +----------- +Explore "the ultimative underline macro" for possible inclusion +into mom. + NUMBERED HEADS, SUBHEADS and PARAHEADS -------------------------------------- Macros to set numbering style (roman, arabic, alpha, etc)? diff --git a/contrib/mom/examples/elvis_syntax.new b/contrib/mom/examples/elvis_syntax.new index aaf9d605..29726da2 100644 --- a/contrib/mom/examples/elvis_syntax.new +++ b/contrib/mom/examples/elvis_syntax.new @@ -33,6 +33,7 @@ color decimals normal color ellipsis normal color escapes like keyword color misc green +font args DA DE EN ES FR IT NL NO PT SV font args DEFAULT CHAPTER NAMED LETTER font args TYPESET TYPEWRITE font args FINAL DRAFT diff --git a/contrib/mom/momdoc/appendices.html b/contrib/mom/momdoc/appendices.html index 64d3b8f5..8e98b912 100644 --- a/contrib/mom/momdoc/appendices.html +++ b/contrib/mom/momdoc/appendices.html @@ -7,8 +7,10 @@ <!====================================================================> +<a href="reserved.html#TOP">Next</a> <a href="typemacdoc.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> +<p> <a name="TOP"></a> <a name="APPENDICES"> @@ -18,8 +20,8 @@ <ul> <li><a href="#MOREDOC">Further notes on this documentation</a> <li><a href="#CODENOTES">Some reflections on mom, with an apology</a> - <li><a href="reserved.html">List of reserved words</a> <li><a href="#CONTACT">Contact the author</a> + <li><a href="reserved.html">List of reserved words</a> </ul> <a name="MOREDOC"> @@ -58,7 +60,7 @@ basic (text only) html. I may have written <strong>mom</strong>, but I still regularly call on her documentation. Elvis, with its html capabilities, lets me write and format <strong>mom</strong> documents AND peruse her documentation, clicking on links as -necessary, without ever leaveing the comfy confines of my +necessary, without ever leaving the comfy confines of my text editor. <p> Not everyone, of course, uses an editor with html capabilities. @@ -73,7 +75,7 @@ frames, and (for the most part) tables in this documentation. The reason is simple: Lynx. People who, for whatever reason (choice or necessity), use Lynx to read the documentation must be able to make sense of it. All of it. Graphical examples of <strong>mom</strong> -in action might have made some parts of the documenation easier to +in action might have made some parts of the documentation easier to write, but would have excluded Lynx-only users. And it goes without saying that the documentation looks fine if you're reading it in a graphical browser. @@ -99,7 +101,7 @@ scratching a personal itch, then <strong>mom</strong> can truly be called open source, even if, a mere humble set of macros standing on the shoulders of a giant named troff, she isn't programming at all. <p> -As a writer living in a perpeptual state of penury, all the computers +As a writer living in a perpetual state of penury, all the computers I've ever owned have been hand-me-downs -- several generations out-of-date and "resource challenged". Disk space has always been an issue, as has processor speed and available RAM. @@ -132,6 +134,13 @@ ambiguity of groff's documentation. Making sense of certain primitives has often involved days of testing, interpreting the documentation instead of just using the primitive. <p> +(ADDENDUM to the previous two paragraphs: A tremendous amount of +effort has gone into creating a groff manual that can be read with +"info," as well as creating truly useful man pages. The info +manual is clear and well-written, so my comments are actually out +of date. I leave them in for the benefit of groff newbies, who may +still find the documents a bit intimidating.) +<p> For some time now, groff users and macro writers have had the option to use "long" names, yet have mostly chosen not to. With long names, it's possible to create macro sets that are humanly @@ -145,15 +154,11 @@ newbies and old hands alike. and a host of other groff goodies that have become part of the whole groff picture under the unflagging guidance of groff's current maintainer, Werner Lemberg. Nearly every macro, number register and -string is "recognisable" simply by its name. The file is +string is "recognizable" simply by its name. The file is heavily commented. A consistent, if idiosyncratic, indenting style is used as well, significantly improving readability. Anyone wanting to futz around with <strong>mom</strong>'s macros should be able to do so with a minimum of head scratching. -<p> -To all you groff-jocks out there who love the aracana of -groff-as-it-used-to-be, I apologise. To everyone else, I simply say: -Welcome, and enjoy. <br> <hr> @@ -171,13 +176,14 @@ groff mailing list at (subscription information available <a href="http://ffii.org/mailman/listinfo/groff/">here</a>) or contact me, Peter Schaffter, directly at +<i>df191@ncf.ca</i>. <p> -<address align="center"> - <a href="mailto:df191@ncf.ca">df191@ncf.ca</a> -</address> - +Please include the word "mom" or "groff" in the +Subject: line of any message sent to my personal address, or you +risk the wrath of my implacable spam filters. :) <p> <hr> +<a href="reserved.html#TOP">Next</a> <a href="typemacdoc.html#TOP">Prev</a> <a href="#TOP">Top</a> <a href="toc.html">Back to Table of Contents</a> diff --git a/contrib/mom/momdoc/cover.html b/contrib/mom/momdoc/cover.html index 11b6a854..4fa6c835 100644 --- a/contrib/mom/momdoc/cover.html +++ b/contrib/mom/momdoc/cover.html @@ -10,10 +10,11 @@ <a href="letters.html#TOP">Next</a> <a href="rectoverso.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> +<p> <a name="TOP"></a> <a name="COVER"> - <h2 align="center"><u>CREATING A COVER PAGE</u></h2> + <h1 align="center"><u>CREATING A COVER PAGE</u></h1> </a> <p> diff --git a/contrib/mom/momdoc/definitions.html b/contrib/mom/momdoc/definitions.html index 7d2d856a..2b52f6a4 100644 --- a/contrib/mom/momdoc/definitions.html +++ b/contrib/mom/momdoc/definitions.html @@ -10,7 +10,7 @@ <a href="using.html#TOP">Next</a> <a href="intro.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> - +<p> <a name="TOP"></a> <a name="TERMS"> <h1 align="center"><u>DEFINITIONS OF TERMS USED IN THIS MANUAL</u></h1> @@ -28,7 +28,7 @@ to <strong>mom</strong> herself. To make life easier, I'll explain them here. Refer back to this section should you encounter a word or concept you're not familiar with. Words in these definitions that are defined elsewhere in this section are marked with asterisks. -<br> +<p> <hr> <a name="TERMS_TYPESETTING"> @@ -121,15 +121,15 @@ letter until the bottom of the drop cap is reached, at which point text reverts to the left margin. <dt><a name="TERMS_EM"><em>Em/en</em></a> -<dd>A relative measurement equal to the width of the letter M at a -given <strong>*point size</strong> in a given <strong>*font</strong>. -Since most Ms are designed square, an em is usually (but sometimes -erroneously) considered to be the same size as the current point size -(i.e. if the point size of the type is 12, one em equals 12 points). -An en is equal to the width of a letter N (historically 2/3 of an em, -although groff treats an en as 1/2 of an em). Typically, ems and -ens are used to measure indents, or to define the length of dashes -(long hyphens). +<dd>An em is a relative measurement equal to the width of the +letter M at a given <strong>*point size</strong> in a given +<strong>*font</strong>. Since most Ms are designed square, an em is +usually (but sometimes erroneously) considered to be the same size +as the current point size (i.e. if the point size of the type is 12, +one em equals 12 points). An en is equal to the width of a letter +N (historically 2/3 of an em, although groff treats an en as 1/2 of +an em). Typically, ems and ens are used to measure indents, or to +define the length of dashes (long hyphens). <dt><a name="TERMS_FAMILY"><em>Family</em></a> <dd>The collective name by which a collection of @@ -187,7 +187,7 @@ whitespace between them. In the days before phototypesetting, type was set from small, rectangular blocks of wood or metal, each block having exactly one letter. Because the edge of each block determined the edge of each letter, certain letter combinations (TA, -for example) didn't fit together well and had to be morticed by hand +for example) didn't fit together well and had to be mortised by hand to bring them visually closer. Modern typesetting systems usually take care of kerning automatically, but they're far from perfect. Professional typesetters still devote a lot of time to fitting letters @@ -256,9 +256,9 @@ fractionally smaller than its point size. <dd>When only one margin of type is flush, lines of type are quadded in the direction of the flush margin. Therefore, quad left means the left margin is flush, the right isn't. Quad right means the right -margin is flush, the left isn't. Quad center means neither the left +margin is flush, the left isn't. Quad centre means neither the left nor the right margin is flush; rather, lines of type are quadded on -both sides so that type appears centered on the page. +both sides so that type appears centred on the page. <dt><a name="TERMS_RAG"><em>Rag</em></a> <dd>Describes a margin that isn't flush. Rag right means the right @@ -282,7 +282,8 @@ The correct term is letter spacing, but track kerning and line kerning <dd>Equal to <strong>*word space</strong>, however words separated by an unbreakable space will always be kept together on the same line. Expands and contracts like word space. Useful for proper names, which -should never be broken. In groff, unbreakable space is entered with +one should, whenever possibly, avoid splitting onto two lines. In +groff, unbreakable space is entered with <p> <pre> \~ @@ -300,6 +301,7 @@ the margins flush. point size. Generally used to mean the average height of the bowl of lower case letters. </dl> +<p> <hr> <a name="TERMS_GROFF"> @@ -378,7 +380,7 @@ appear in your text editor are ignored. Instead, words from adjoining <strong>*input lines</strong> are added one at a time to the output line until no more words fit. Then, depending whether text is to be <strong>*justified</strong> or <strong>*quadded</strong> (left, -right, or center), and depending on whether automatic hyphenation +right, or centre), and depending on whether automatic hyphenation is turned on, groff attempts to hyphenate the last word, or, barring that, spreads and breaks the line (when justification is turned on) or breaks and quads the line (when quadding is turned on). @@ -487,7 +489,7 @@ should use. Common valid units are: <tr><td><strong>i</strong><td> = <td>inches <tr><td><strong>p</strong><td> = <td>points <tr><td><strong>P</strong><td> = <td>picas -<tr><td><strong>c</strong><td> = <td>centimeters +<tr><td><strong>c</strong><td> = <td>centimetres <tr><td><strong>m</strong><td> = <td>ems <tr><td><strong>n</strong><td> = <td>ens <tr><td><strong>v</strong><td> = <td>the current leading (line space)</td></tr> @@ -539,11 +541,12 @@ of an input line as meaning that what follows is a <strong>*control line</strong>. In fill modes, groff treats a space at the beginning of an input line as meaning "start a new line and put a space at the beginning of it." If you want groff to interpret periods -and apostrophes at the beginning of input lines literally (ie. print +and apostrophes at the beginning of input lines literally (i.e. print them), or spaces at the beginning of input lines as just garden variety word spaces, you must start the line with the zero-width character. </dl> +<p> <hr> <a name="TERMS_MOM"> @@ -609,7 +612,7 @@ footers. <dd>A horizontal gap in <strong>*running text</strong>, frequently set off by typographic symbols such as asterisks or daggers. Used to indicate a shift in the content of a document (e.g. a scene change in a -short story). +short story). Also commonly called a scene break. <dt><a name="TERMS_PARAHEAD"><em>Paragraph head</em></a> <dd>A title joined to the body of a paragraph; hierarchically one 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> diff --git a/contrib/mom/momdoc/docprocessing.html b/contrib/mom/momdoc/docprocessing.html index 0e8505cd..98b2af51 100644 --- a/contrib/mom/momdoc/docprocessing.html +++ b/contrib/mom/momdoc/docprocessing.html @@ -10,21 +10,20 @@ <a href="docelement.html#TOP">Next</a> <a href="inlines.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> - +<p> <a name="TOP"></a> <a name="DOCPROCESSING"> - <h1 align="center"><u>DOCUMENT PROCESSING WITH MOM</u> -</h1> + <h1 align="center"><u>DOCUMENT PROCESSING WITH MOM</u></h1> </a> - <a href="#INTRO_MACROS_DOCPROCESSING">Introduction to document processing</a> <br> <a href="#DEFAULTS">Some document defaults</a> -<p> +<br> <a href="#LEADING_NOTE">* IMPORTANT NOTE on leading/spacing and bottom margins *</a> <br> - <a href="#SHIM">The SHIM macro</a> -<p> +<a href="#SHIM">The SHIM macro</a> +<br> +<h3><u>Table of Contents for document processing</u></h3> <ul> <li><a href="#SETUP"><strong>DOCUMENT SETUP</strong></a> <br> @@ -204,10 +203,11 @@ </ul> </ul> </ul> +<br> <hr> <h2><a name="INTRO_MACROS_DOCPROCESSING"><u>Introduction to document processing</u></a></h2> -<p> + As explained in <a href="intro.html#INTRO_DOCPROCESSING">Document processing with mom</a>, document processing uses markup tags to identify document elements @@ -227,13 +227,13 @@ Setting up a <strong>mom</strong> doc is a simple, four-part procedure. You begin by entering information about the document itself (title, subtitle, author, etc.). Next, you tell <strong>mom</strong> what kind of document you're creating (e.g. chapter, letter, abstract, -etc...) and what kind of output you want (typeset, typewrittten, +etc...) and what kind of output you want (typeset, typewritten, draft-style, etc). Thirdly, you make as many or as few changes to <strong>mom</strong>'s default behaviour as you wish. Lastly, you invoke the <a href="#START">START</a> macro. Voilà! You're ready to write. -<br> +<p> <hr> @@ -251,7 +251,7 @@ documentation. Just in case, here they are. <li>the left and right margins are 1-inch <li>the top and bottom margins for document text are plus/minus visually 1-inch - <li>pages are numbered; the number appears centered, at the + <li>pages are numbered; the number appears centred, at the bottom, surrounded by hyphens ( e.g. -6- ) <li>the first page of a document begins with a <a href="definitions.html#TERMS_DOCHEADER">document header</a> @@ -264,7 +264,7 @@ Another way to check up on document processing defaults is to have a look at the macro file (om.tmac). Each macro is preceded by a description that (generally) says what its default is (if it has one). -<br> +<p> <hr> <a name="LEADING_NOTE"> @@ -320,7 +320,7 @@ around with leading and/or spacing. The macro is called <strong>SHIM</strong> (like those little pieces of wood carpenters use to get their work even, level and snug), and it's described below. -<br> +<p> <!---SHIM---> @@ -338,7 +338,7 @@ need to get <strong>mom</strong>'s document leading back on track. <p> For example, say you want to insert a picture into a document with the special groff macro, <strong>PSPIC</strong> (see the -<strong>grops</strong> man page for useage). +<strong>grops</strong> man page for usage). <p> Pictures aren't usually conveniently sized in multiples of document leading, which means that when you insert the picture, you disrupt @@ -383,11 +383,10 @@ falls exactly where it's supposed to. <hr> <a name="SETUP"><h2><u>Document setup</u></h2></a> - +<p> <a name="DOCPROCESSING_TUT"> <h3><u>Tutorial -- Setting up a mom document</u></h3> </a> -<p> There are four "parts" to setting up a <strong>mom</strong> doc (three, actually, with one optional). Before we proceed, though, be reassured that something as simple as @@ -537,7 +536,7 @@ The setup for Joe Blow's story now looks like this: .FAMILY H .PT_SIZE 12 .LS 14 - .QUAD LEFT \"ie. rag right + .QUAD LEFT \"i.e. rag right .FOOTERS .LINEBREAK_CHAR * </pre> @@ -564,7 +563,7 @@ Here's the complete setup for <em>My Pulitzer Winner</em>: .FAMILY H .PT_SIZE 12 .LS 14 - .QUAD LEFT \"ie. rag right + .QUAD LEFT \"i.e. rag right .FOOTERS .LINEBREAK_CHAR * \# @@ -618,7 +617,7 @@ number of drafts already, J. Blow may very well decide his as well leave in the superfluous macros. That way, when draft 7, rev. 62 becomes draft 8, rev. 1, he'll be ready to tackle his Pulitzer winner again. -<br> +<p> <hr> <!========================================================================> @@ -634,7 +633,7 @@ and <a href="definitions.html#TERMS_HEADER">page headers</a>. They must go at the top of any file that uses <strong>mom</strong>'s document processing macros. - +<p> <a name="INDEX_REFERENCE"> <h3><u>Reference macros list</u></h3> </a> @@ -648,6 +647,7 @@ document processing macros. <li><a href="#DRAFT">DRAFT</a> <li><a href="#REVISION">REVISION</a> </ul> +<br> <!---TITLE---> @@ -676,7 +676,7 @@ the title always gets converted to caps. <a href="#DOCTYPE">DOCTYPE</a> is <strong>CHAPTER</strong>, <strong>TITLE</strong> should be the title of the opus, not "CHAPTER whatever". -<br> +<p> <!---DOCTITLE---> @@ -723,7 +723,8 @@ the doctitle always gets converted to caps. is <strong>CHAPTER</strong>, you don't need <strong>DOCTITLE</strong>. <strong>TITLE</strong> takes care of everything. -<br> +<p> + <!---SUBTITLE---> <hr width="66%" align="left"> @@ -738,7 +739,7 @@ The subtitle string can be caps or caps/lower-case. Since a document's subtitle appears only in the <a href="definitions.html#TERMS_DOCHEADER">docheader</a>, and the title is most likely in caps, I recommend caps/lower case. -<br> +<p> <!---AUTHOR---> @@ -770,7 +771,7 @@ authors), redefine the appropriate part of the header (see <p> The strings can be caps or caps/lower-case. I recommend caps/lower case. -<br> +<p> <!---CHAPTER---> @@ -796,9 +797,9 @@ no purpose and <strong>mom</strong> ignores it. <a name="CHAPTER_STRING"><strong>CHAPTER_STRING</strong></a> <p> If you're not writing in English, you can ask <strong>mom</strong> -to use the word for chapter in your own language by telling -her what it is with the <strong>CHAPTER_STRING</strong> macro, -like this: +to use the word for "chapter" in your own language by +telling her what it is with the <strong>CHAPTER_STRING</strong> +macro, like this: <p> <pre> .CHAPTER_STRING "Chapître" @@ -807,7 +808,7 @@ like this: You can also use <strong>CHAPTER_STRING</strong> if you want "CHAPTER" instead of "Chapter" in the doc- and page-headers. -<br> +<p> <!---CHAPTER_TITLE---> @@ -842,7 +843,7 @@ page headers, not "Chapter #". If you omit <strong>CHAPTER</strong> when setting up your reference macros, only the title will appear, both at the top of page one and in subsequent page headers. -<br> +<p> <!---DRAFT---> @@ -881,8 +882,8 @@ argument, in which case, no draft number will be printed beside <a name="DRAFT_STRING"><strong>DRAFT_STRING</strong></a> <p> If you're not writing in English, you can ask <strong>mom</strong> -to use the word for draft in your own language by telling -her what it is with the <strong>DRAFT_STRING</strong> macro, +to use the word for "draft" in your own language by +telling her what it is with the <strong>DRAFT_STRING</strong> macro, like this: <p> <pre> @@ -909,7 +910,7 @@ want, this is also the only way to do it. Simply leaving out <strong>.DRAFT</strong> and <strong>.DRAFT_STRING</strong> will result in <strong>mom</strong> using her default, which is to print "Draft 1". -<br> +<p> <!---REVISION---> @@ -948,8 +949,8 @@ argument, in which case, no revision number will be printed beside <a name="REVISION_STRING"><strong>REVISION_STRING</strong></a> <p> If you're not writing in English, you can ask <strong>mom</strong> -to use the word for revision, or a shortform therof, in -your own language by telling her what it is with the +to use the word for "revision," or a shortform +thereof, in your own language by telling her what it is with the <strong>REVISION_STRING</strong> macro, like this: <p> <pre> @@ -986,6 +987,7 @@ The above, naturally, has no draft information. If you want to roll your own <strong>.DRAFT</strong> and/or <strong>.DRAFT_STRING</strong> as well, simply supply arguments to either or both. +<p> <hr> <!========================================================================> @@ -1015,6 +1017,7 @@ draft and revision information in the headers) or a final copy. </ul> <li><a href="#COPYSTYLE">COPYSTYLE</a> </ul> +<br> <!---DOCTYPE---> @@ -1030,7 +1033,7 @@ in the and <a href="definitions.html#TERMS_HEADER">page headers</a>. <strong>LETTER</strong> tells her that you want to write a -lettter. +letter. <p> <strong>Mom</strong>'s default <strong>DOCTYPE</strong> is <strong>DEFAULT</strong>. If that's what you want, you don't @@ -1058,9 +1061,9 @@ underneath. If you omit the reference macro but supply a <a href="#CHAPTER_TITLE">CHAPTER_TITLE</a>, <strong>mom</strong> prints only the chapter title. <em>(*For -backward compatability with pre-1.1.5 versions of</em> +backward compatibility with pre-1.1.5 versions of</em> <strong>mom</strong><em>, you can also supply a chapter title by -ommitting the</em> <strong>CHAPTER</strong> <em>reference macro and +omitting the</em> <strong>CHAPTER</strong> <em>reference macro and supplying a chapter title with</em> <a href="#CHAPTER_STRING">CHAPTER_STRING</a>.) <p> @@ -1088,7 +1091,7 @@ for how <strong>mom</strong> outputs each part of the page header.) the section <a href="letters.html#INTRO">Writing Letters</a> for instructions on using <strong>mom</strong> to format letters. -<br> +<p> <!---PRINTSTYLE---> @@ -1182,7 +1185,7 @@ or singlespaced, the only way to get it is with the macro, and then ONLY if <strong>DOC_LEAD</strong> is set <strong>before</strong> you invoke the <strong>START</strong> macro. - +<p> <a name="TYPESET_DEFAULTS"><h3><u>TYPESET defaults</u></h3></a> <pre> Family = Times Roman @@ -1263,7 +1266,7 @@ headers/footers should they become crowded (quite likely to happen if the title of your document is long and your <a href="#COPYSTYLE">COPYSTYLE</a> is <strong>DRAFT</strong>). -<br> +<p> <!---COPYSTYLE---> @@ -1290,13 +1293,13 @@ you want to. <a href="#REVISION">REVISION</a> (see <a href="#REFERENCE_MACROS">reference macros</a>), - appear in the center part of + appear in the centre part of <a href="definitions.html#TERMS_HEADER">page headers</a> - (or footers, depending on which you'ves selected) along with + (or footers, depending on which you've selected) along with any other information that normally appears there. </ol> <p> -<strong>IMPORTANT:</strong> If you define your own center part for page +<strong>IMPORTANT:</strong> If you define your own centre part for page headers with <a href="headfootpage.html#HDRFTR_CENTER">HEADER_CENTER</a>, no draft and/or revision number will appear there. If you want draft @@ -1307,11 +1310,11 @@ and revision information in this circumstance, use <br> <ol> <li>it respects the starting page number you give the document - <li>page numbers are set in normal (arabic) digits + <li>page numbers are set in normal (Arabic) digits <li>no draft or revision number appears in the page headers </ol> <p> -<strong>NOTE:</strong> The center part of page headers can get crowded, +<strong>NOTE:</strong> The centre part of page headers can get crowded, especially with <a href="docprocessing.html#DOCTYPE">DOCTYPE CHAPTER</a> and @@ -1324,17 +1327,17 @@ Another, which only works with <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPESET</a>, is to reduce the size of the header's centre part only (with <a href="headfootpage.html#_SIZE">HEADER_CENTER_SIZE</a>). -And finally, you can elect to have the draft/revsion information -attached to page numbers instead of having it appear in the center +And finally, you can elect to have the draft/revision information +attached to page numbers instead of having it appear in the centre of page headers (see <a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a>). -<br> +<p> <hr> <!========================================================================> <a name="STYLE_BEFORE_START"><h2><u>Changing type/style parameters prior to START</u></h2></a> - +<p> In the third (optional) part of setting up a document (see <a href="#DOCPROCESSING_TUT">Tutorial -- setting up a mom document</a>), you can use the @@ -1363,10 +1366,11 @@ adjusted to fill pages fully to the bottom margin. <li><a href="#DOCHEADER_CONTROL">Docheader control</a> </ul> </ul> +<br> <hr width="66%" align="left"> <a name="TYPE_BEFORE_START"><h2><u>Using the typesetting macros prior to START</u></h2></a> - +<p> From time to time (or maybe frequently), you'll want the overall look of a document to differ from <strong>mom</strong>'s defaults. Perhaps you'd like her to use a different @@ -1404,7 +1408,7 @@ the equivalent to setting the right margin with R_MARGIN FAMILY The family of all type in the document PT_SIZE The point size of type in paragraphs; mom uses this - calculate automatic point size changes (eg. for heads, + calculate automatic point size changes (e.g. for heads, footnotes, quotes, headers, etc) **LS/AUTOLEAD The leading used in paragraphs; all leading and spacing of running text is calculated from this @@ -1425,7 +1429,7 @@ If you want to change any of the basic parameters (above) document globally (as if you'd entered them <em>before</em> <strong>START</strong>), you must use the macros listed in <a href="#DOC_PARAM_MACROS">Changing document-wide style parameters after START</a>. -<br> +<p> <!---DOC_LEAD_ADJUST---> @@ -1500,7 +1504,7 @@ adjust the leading of endnotes pages and toc pages. See and <a href="docelement.html#TOC_LEAD">TOC_LEAD</a> for an explanation of how to disable this default behaviour. -<br> +<p> <!---DOCHEADER---> @@ -1556,7 +1560,7 @@ like the way <strong>mom</strong> does things) and use to ensure that the body of your document starts where you want. You can even insert a PostScript file (with <strong>.PSPIC</strong>; see the <strong>grops</strong> man page for usage). - +<p> <a name="DOCHEADER_CONTROL"><h3><u>How to change the look of docheaders: docheader control macros</u></h3></a> <p> @@ -1610,6 +1614,7 @@ is the prevailing family of the whole document. </ol> <p> <a name="CHANGE_START"><h3><u>1. Change the starting position</u></h3></a> +<p> By default, a docheader starts on the same <a href="definitions.html#TERMS_BASELINE">baseline</a> as @@ -1641,9 +1646,10 @@ you might find the docheaders a bit high when headers are off. Use <a href="#CHANGE_START">DOCHEADER_ADVANCE</a> to place them where you want. - +<p> <a name="ADJUST_LEADING"><h3><u>2. Adjust the leading</u></h3></a> +<p> The <a href="definitions.html#TERMS_LEADING">leading</a> of docheaders is the same as running text (except when @@ -1664,8 +1670,10 @@ text, a + or - sign is required before the argument (how much to add or subtract from the lead of running text). No <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> is required; points is assumed. +<p> <a name="CHANGE_FAMILY"><h3><u>3. Change the family of docheader elements</u></h3></a> +<p> The following macros let you change the <a href="definitions.html#TERMS_FAMILY">family</a> of each docheader element separately: @@ -1682,8 +1690,10 @@ of each docheader element separately: Simply pass the appropriate macro the family you want, just as you would with <a href="typesetting.html#FAMILY">FAMILY</a>. +<p> <a name="CHANGE_FONT"><h3><u>4. Change the font of docheader elements</u></h3></a> +<p> The following macros let you change the <a href="definitions.html#TERMS_FONT">font</a> of each docheader element separately: @@ -1701,9 +1711,10 @@ Simply pass the appropriate macro the font you want. <strong>R, B, I</strong> and <strong>BI</strong> have the same meaning as they do for <a href="typesetting.html#FONT">FT</a>. - +<p> <a name="CHANGE_SIZE"><h3><u>5. Adjust the size of docheader elements</u></h3></a> +<p> The following macros let you adjust the point size of each docheader element separately. <p> @@ -1735,6 +1746,7 @@ default = +3 </ul> <p> Simply pass the appropriate macro the size adjustment you want. +<p> <a name="CHANGE_ATTRIBUTE"><h3><u>6. Change the attribution string ("by")</u></h3></a> <p> @@ -1771,7 +1783,7 @@ example, would set "by" in Helvetica bold italic, 2 points smaller than normal. -<br> +<p> <hr> <!---COLUMNS_INTRO---> @@ -1809,7 +1821,7 @@ and (and probably the <a href="docelement.html#PARA_INDENT">paragraph first-line indent</a> as well). -<br> +<p> <!---COLUMNS---> @@ -1846,7 +1858,6 @@ output in columns is just too ghastly for her to bear. <a name="BREAKING_COLUMNS"></a> <h3><u>Breaking columns manually</u></h3> -<p> <strong>Mom</strong> takes care of breaking columns when they reach the bottom margin of a page. However, there may be times you want to break the columns yourself. There are two macros for breaking columns @@ -1898,7 +1909,7 @@ merges it with her defaults, sets up headers and page numbering, and prepares <strong>mom</strong> to process your document using the document element tags. No document processing takes place until you invoke <strong>START</strong>. -<br> +<p> <!---START---> @@ -1919,7 +1930,7 @@ don't use <strong>START</strong>. At a barest minimum before <strong>START</strong>, you must enter a <a href="#PRINTSTYLE">PRINTSTYLE</a> command. -<br> +<p> <hr> <!========================================================================> @@ -1936,7 +1947,7 @@ using (<strong>L_MARGIN, FAMILY, PT_SIZE, LS,</strong> etc). After <strong>START</strong>, you must use the following macros to make global changes to the basic type parameters of a document. -<br> +<p> <a name="INDEX_DOC_PARAM"> <h3><u>Macro list</u></h3> @@ -1951,6 +1962,7 @@ global changes to the basic type parameters of a document. <li><a href="#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> <li><a href="#DOC_QUAD">DOC_QUAD</a> </ul> +<br> <hr width="66%" align="left"> <p> @@ -1967,7 +1979,6 @@ global changes to the basic type parameters of a document. <li>the line length remains the same (i.e. the right margin shifts when you change the left margin) </ul> - <br> <hr width="66%" align="left"> @@ -2086,7 +2097,7 @@ leading of endnotes pages and toc pages. See and <a href="docelement.html#TOC_LEAD">TOC_LEAD</a> for an explanation of how to disable this default behaviour. -<br> +<p> <hr width="66%" align="left"> <p> @@ -2100,8 +2111,8 @@ for an explanation of how to disable this default behaviour. <li>affects paragraphs, epigraphs and footnotes; does not affect blockquotes </ul> +<br> -<p> <hr> <a href="docelement.html#TOP">Next</a> <a href="inlines.html#TOP">Prev</a> diff --git a/contrib/mom/momdoc/goodies.html b/contrib/mom/momdoc/goodies.html index 54a33c3a..b152b50b 100644 --- a/contrib/mom/momdoc/goodies.html +++ b/contrib/mom/momdoc/goodies.html @@ -10,16 +10,16 @@ <a href="inlines.html#TOP">Next</a> <a href="typesetting.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> - +<p> <a name="TOP"></a> <a name="GOODIES"> - <h2><u>Goodies</u></h2> + <h1 align="center"><u>Goodies</u></h1> </a> - +<p> <a name="INTRO_GOODIES"></a> The macros in this section are a collection of useful (and sometimes -nearly indispensible) routines to simplify typesetting. - +nearly indispensable) routines to simplify typesetting. +<p> <a name="INDEX_GOODIES"> <h3><u>Goodies list</u></h3> </a> @@ -151,7 +151,7 @@ of your documents, please. <strong>EXPERTS:</strong> <strong>ALIAS</strong> is an alias of <code>.als</code>. You can use either, or mix 'n' match with impunity. -<br> +<p> <!---SILENT---> @@ -204,7 +204,7 @@ or to which you've passed the <strong>J</strong> or <strong>QUAD</strong> argument. You must insert <code>.BR</code> yourself, or risk a portion of your text disappearing into a black hole. -<br> +<p> <!---TRAP---> @@ -241,7 +241,7 @@ turns it off (i.e. suspends the trap), and no argument turns it Have a look at the <strong>IMPORTANT</strong> sections of <strong>EL</strong> and <strong>TN</strong> to see <strong>TRAP</strong> in action. -<br> +<p> <!---SMARTQUOTES---> @@ -249,15 +249,20 @@ of <strong>EL</strong> and <strong>TN</strong> to see <a name="SMARTQUOTES"><h3><u>Convert typewriter doublequotes to proper doublequotes</u></h3></a> <br> Macro: <strong>SMARTQUOTES</strong> <var>[<off>] [ ,, | >> | << ]</var> +<br> +or +<br> +Macro: <strong>SMARTQUOTES</strong> <var>DA | DE | EN | ES | FR | IT | NL | NO | PT | SV</var> <p> -If you <strong>SMARTQUOTES</strong> without an argument, +If you invoke <strong>SMARTQUOTES</strong> without an argument, <strong>mom</strong> converts all instances of the inch-mark, -(<kbd>"</kbd> --also called a "doublequote"), into -the appropriate instances of true Anglo-American open-and -close-doublequotes. (See the paragraphs on the meaning of the -optional arguments for how to get SMARTQUOTES to behave correctly -for non-English quoting styles.) +(<kbd>"</kbd> -- also called a "doublequote"), into +the appropriate instances of true Anglo-American open- and +close-doublequotes. (See +<a href="#SQ_INTERNATIONAL">Internationalization</a> +for how to get SMARTQUOTES to behave correctly for non-English +quoting styles.) <p> Typographically, there is a difference between the inch-mark and doublequotes -- a BIG difference. Sadly, typewriters and computer @@ -268,43 +273,59 @@ typeset copy. Failure to turn inches into quotes is the first thing a professional typesetter notices in documents prepared by amateurs. And you don't want to look like an amateur, do you? <p> +<a name="SQ_INTERNATIONAL"><h3>Internationalization</h3></a> +<p> If you invoke <strong>SMARTQUOTES</strong> with one of the optional -arguments <strong>,,</strong>, <strong>>></strong> or -<strong><<</strong>, you can use <kbd>"</kbd> as "cheap" +arguments (<kbd>,,</kbd> or <kbd>>></kbd> or +<kbd><<</kbd>) you can use <kbd>"</kbd> as "cheap" open- and close-quotes when inputting text in a language other than English, and have <strong>mom</strong> convert them, on output, into the chosen open- and close-quote style. <p> -<strong>,,</strong> -opens quotes with "lowered doublequotes" and closes them -with "raised doublequotes", as in this ascii +<kbd>,,</kbd> opens quotes with "lowered doublequotes" and +closes them with "raised doublequotes", as in this ascii approximation: <p> <pre> ,,Hilfe !`` </pre> -<strong>>></strong> -opens quotes with guillemets pointing to the right, and closes -them with guillemets pointing to the left, as in this ascii -approximation: +<kbd>>></kbd> opens quotes with guillemets pointing to the +right, and closes them with guillemets pointing to the left, as in +this ascii approximation: <p> <pre> >>Zurück !<< </pre> -<strong><<</strong> -opens quotes with guillemets pointing to the left, and closes -them with guillemets pointing to the right, as in this ascii -approximation: +<kbd><<</kbd> opens quotes with guillemets pointing to the +left, and closes them with guillemets pointing to the right, as in +this ascii approximation: <p> <pre> <<Mais monsieur! Je ne suis pas ce genre de fille!>> </pre> -Please note: the arguments to <strong>SMARTQUOTES</strong> are -literal ASCII characters. ,, is two commas, << is two -less-than signs and >> is two greater-than signs. +Please note: the above arguments to <strong>SMARTQUOTES</strong> +are literal ASCII characters. <kbd>,,</kbd> is two commas, +<kbd><<</kbd> is two less-than signs and <kbd>>></kbd> +is two greater-than signs. +<p> +Alternatively, you can pass <strong>SMARTQUOTES</strong> the +two-letter, ISO 639 abbreviation for the language you're writing in, +and <strong>mom</strong> will output the correct quotes. +<p> +<pre> + .SMARTQUOTES DA = Danish >>text<< + .SMARTQUOTES DE = German ,,text`` + .SMARTQUOTES ES = Spanish ``text´´ + .SMARTQUOTES FR = French << text >> + .SMARTQUOTES IT = Italian << text >> + .SMARTQUOTES NL = Dutch ´´text´´ + .SMARTQUOTES NO = Norwegian <<text>> + .SMARTQUOTES PT = Portuguese <<text>> + .SMARTQUOTES SV = Swedish >>text>> +</pre> <p> Turn <strong>SMARTQUOTES</strong> off by passing it any argument <em>not</em> in the argument list (e.g. <strong>OFF</strong>, @@ -349,7 +370,7 @@ the foot- and inch-marks, when you need them, with the <a href="definitions.html#TERMS_INLINES">inline escapes</a> <strong>\*[FOOT]</strong> and <strong>\*[INCH]</strong>, instead of <kbd>'</kbd> and <kbd>"</kbd>. -<br> +<p> <!---CAPS---> @@ -443,7 +464,7 @@ no solution to the occasional problems with justified copy. printed, looks fine. Generally, I recommend using <strong>gv</strong> to preview files anyway. See the section on <a href="#PREVIEWING">previewing</a>. -<br> +<p> <!---UNDERSCORE2---> @@ -487,7 +508,7 @@ to <strong>UNDERSCORE2</strong> as to <strong>UNDERSCORE</strong>. See the <a href="#NOTES_UNDERSCORE">NOTES</a> for <strong>UNDERSCORE</strong>. -<br> +<p> <!---UNDERLINE---> @@ -500,7 +521,7 @@ Macro: <strong>UNDERLINE</strong> <var>toggle</var> If your font is Courier, or you're using the document processing macro <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, <strong>UNDERLINE</strong> allows you to underline words and -passages that, in typeset copy, would be italicised. You invoke +passages that, in typeset copy, would be italicized. You invoke <strong>UNDERLINE</strong> as you do with all toggle macros -- by itself (i.e. with no argument) to initiate underlining, and with any argument to turn underlining off. @@ -513,7 +534,7 @@ readable copy than a solid underline. <a href="definitions.html#TERMS_INLINES">inline</a> with the escapes <a href="#UL">\*[UL]...\*[ULX].</a> -<br> +<p> <!---UL---> @@ -526,7 +547,7 @@ Inline: <strong>\*[UL]...\*[ULX]</strong> If your font is Courier, or you're using the document processing macro <a href="#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, <strong>\*[UL]...\*[ULX]</strong> underlines words and -passages that, in typeset copy, would be italicised. +passages that, in typeset copy, would be italicized. <p> <strong>\*[UL]</strong> underlines all letters, words and numbers following it, but not punctuation or spaces. This makes for more @@ -691,7 +712,7 @@ this is to use the groff <strong>\(lq</strong> and <strong>\(rq</strong> (leftquote and rightquote respectively) whenever double-quotes are required in the string passed to <strong>PAD</strong>. -<br> +<p> <!---PAD_MARKER---> @@ -717,7 +738,7 @@ Once you've changed the pad marker, the new marker remains in effect for every instance of <a href="#PAD">PAD</a> until you change it again (say, back to the pound sign). -<br> +<p> <!---\*[LEADER]---> @@ -921,7 +942,7 @@ e.g. <a href="definitions.html#TERMS_PICASPOINTS">points</a>, therefore do not append any <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a> -to the argument. And always be sure to preprend the plus or +to the argument. And always be sure to prepend the plus or minus sign, depending on whether you want the drop cap larger or smaller. @@ -975,7 +996,6 @@ I'm neither a mathematician nor a chemist, so I don't need them. Of course, anyone who wishes to contribute a subscript routine to <strong>mom</strong> will receive eternal blessings not only in this lifetime, but in all lifetimes to come. - <p> <hr> <a href="inlines.html#TOP">Next</a> diff --git a/contrib/mom/momdoc/headfootpage.html b/contrib/mom/momdoc/headfootpage.html index c101dad4..5ac3c083 100644 --- a/contrib/mom/momdoc/headfootpage.html +++ b/contrib/mom/momdoc/headfootpage.html @@ -10,10 +10,11 @@ <a href="rectoverso.html#TOP">Next</a> <a href="docelement.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> +<p> <a name="TOP"></a> <a name="HEADFOOTPAGE"> - <h2 align="center"><u>PAGE HEADERS, FOOTERS, AND PAGINATION</u></h2> + <h1 align="center"><u>PAGE HEADERS, FOOTERS, AND PAGINATION</u></h1> </a> <ul> @@ -68,7 +69,6 @@ <h2><u>Introduction</u></h2> </a> -<p> <a href="definitions.html#TERMS_HEADER">Headers</a> and <a href="definitions.html#TERMS_FOOTER">footers</a>, @@ -114,16 +114,17 @@ correspondingly dense at this point. above or below running text is technically a kind of header/footer, <strong>mom</strong> and this documentation treat it as a separate page element. +<p> <a name="DESCRIPTION_GENERAL"><h3><u>General description of headers/footers</u></h3></a> <p> -Headers comprise three distinct parts: a left part, a center part, +Headers comprise three distinct parts: a left part, a centre part, and a right part. Each part contains text (a "string") that identifies some aspect of the document as a whole. <p> The left part ("header left") lines up with the document's -left margin. The center part ("header center") is -centered on the document's line length. The right part ("header +left margin. The centre part ("header centre") is +centred on the document's line length. The right part ("header right") lines up with the document's right margin. Not all parts need contain a string, and if you don't want headers at all, you can turn them off completely. @@ -138,7 +139,7 @@ to the document type selected with <a href="docprocessing.html#DOCTYPE">DOCTYPE</a>. You can, however, supply whatever strings you like -- including page numbers -- to go in any part of headers. What's more, you can set the -family, font, size and capitalisation style (caps or caps/lower-case) +family, font, size and capitalization style (caps or caps/lower-case) for each header part individually. <p> By default, <strong>mom</strong> prints a horizontal rule beneath @@ -147,11 +148,12 @@ footers, the rule is <em>above</em> running text. You can increase or decrease the space between the header and the rule if you like (with <a href="#HDRFTR_RULE_GAP">HEADER_RULE_GAP</a>), or remove it completely. +<p> <a name="HEADER_STYLE"><h3><u>Default specs for headers/footers</u></h3></a> <p> <strong>Mom</strong> makes small type adjustments to each part of -the header (left, center, right) to achieve an aesthetically +the header (left, centre, right) to achieve an aesthetically pleasing result. The defaults are listed below. (The strings <strong>mom</strong> puts by default in each part are explained in <a href="docprocessing.html#DOCTYPE">DOCTYPE</a>.) @@ -179,7 +181,9 @@ up, <strong>mom</strong> has a special macro, that removes all type adjustments to headers. The straightforward type specs for paragraphs are used instead, providing a simple reference point for any alterations you want to make to the family, -font, size and capitalisation style of any header part. +font, size and capitalization style of any header part. +<p> + <a name="VERTICAL_SPACING"><h3><u>Vertical placement and spacing of headers/footers</u></h3></a> <p> As explained in the section on @@ -245,7 +249,7 @@ or the bottom of the page, is managed exactly as if the page numbers were headers (or footers), and are controlled by the same macros. See <a href="#PAGINATION">Pagination control</a>. -<br> +<p> <hr> <!========================================================================> @@ -279,7 +283,7 @@ automatically turned off. Equally, if footers are on, headers you'd prefer footers in a document, you need only invoke <a href="#FOOTERS">FOOTERS</a>; there's no need to turn headers off first. -<br> +<p> <!---HEADERS---> @@ -318,7 +322,7 @@ Explicitly invoking footers moves page numbering to the top of the page, where its placement and spacing are the same as for headers. (I.e. the top margin of running text remains 7.5 picas.) -<br> +<p> <!---FOOTERS---> @@ -349,7 +353,7 @@ page of a document, nor on first pages after <a href="rectoverso.html#COLLATE">COLLATE</a>. If you don't want this behaviour, you can change it with <a href="#PAGENUM_ON_FIRST_PAGE">PAGENUM_ON_FIRST_PAGE</a>. -<br> +<p> <!---FOOTER_ON_FIRST_PAGE---> @@ -366,7 +370,7 @@ first page of the document. (The <a href="definitions.html">docheader</a> on page makes it redundant.) However, should you wish a footer on page 1, invoke <strong>FOOTER_ON_FIRST_PAGE</strong> without any argument. -<br> +<p> <hr> <!---USERDEF_HDRFTR---> @@ -384,8 +388,8 @@ information contained in the headers/footers split over two pages, as is often the case with recto/verso documents. <p> Say, for example, you want recto page headers to contain a document's -author, centered, and verso page headers to contain the document's -title, also centered, like this: +author, centred, and verso page headers to contain the document's +title, also centred, like this: <p> <pre> +------------------------+ +------------------------+ @@ -410,17 +414,17 @@ With <strong>mom</strong>'s standard 3-part headers, this isn't possible, even when <a href="rectoverso.html#RECTO_VERSO">RECTO_VERSO</a> is enabled. <strong>RECTO_VERSO</strong> switches the left and -right parts of headers on alternate pages, but the center +right parts of headers on alternate pages, but the centre part remains unchanged. <p> -Anytime you need distinctly different headers on alternate +Any time you need distinctly different headers on alternate pages, <strong>mom</strong> has macros that let you manually design and determine what goes into headers on recto pages, and what goes into headers on verso pages. The macros are <a href="#HDRFTR_RECTO">HEADER_RECTO</a> and <a href="#HDRFTR_VERSO">HEADER_VERSO</a>. -Both allow you to state whether the header is flush left, centered, +Both allow you to state whether the header is flush left, centred, or flush right, and both take a single <a href="definitions.html#TERMS_STRINGARGUMENT">string argument</a> with which, by combining text and @@ -428,10 +432,10 @@ with which, by combining text and you can make the headers come out just about any way you want. Use of the <strong>\*[PAGE#]</strong> escape is permitted in the string argument (see -<a href="#PAGE_NUMBER_INCL">Including the page number in header-left, -center or -right</a>), +<a href="#PAGE_NUMBER_INCL">Including the page number in header-left, -centre or -right</a>), and as an added bonus, <strong>mom</strong> provides a special mechanism whereby it's possible to "pad" the string as well. -<br> +<p> <!---HDRFTR_RECTOVERSO---> @@ -479,9 +483,9 @@ inline escapes. <p> To include the current page number in the string, use the <strong>\*[PAGE#]</strong> inline. +<br> <h3><u>*Padding the HEADER_RECTO/HEADER_VERSO string</u></h3> -<p> You can "pad" the header-recto string, a convenience you'll appreciate in circumstances such as the following. <p> @@ -513,7 +517,7 @@ inserted. (If you're unsure what padding is, see <a href="goodies.html#PAD">Insert space into lines</a>.) Note that if you're padding the string, it doesn't matter what quad direction you give <strong>HEADER_RECTO</strong> since -padding, by it's nature, justifies text to the left and right +padding, by its nature, justifies text to the left and right margins. <p> The situation depicted above is accomplished like this: @@ -546,18 +550,18 @@ has no effect on the pad marker used in the have a literal pound sign in your <strong>HEADER_RECTO</strong> string, use the escape sequence <kbd>\N'35'</kbd> where you want the pound sign to go. -<br> +<p> <hr> <a name="HEADFOOT_CONTROL"> <h2><u>Control macros for headers/footers</u></h2> </a> -<p> Virtually every part of headers (see the paragraph on how <a href="#HEADERFOOTER">"headers" means "footers"</a> in the <a href="#HEADFOOTPAGE_INTRO">introduction to headers/footers</a>) can be designed to your own specifications. +<p> <a name="INDEX_REFERENCE"> <h3><u>Header/footer control macros</u></h3> @@ -569,11 +573,11 @@ can be designed to your own specifications. <li><a href="#HDRFTR_LEFT">HEADER_LEFT</a> <li><a href="#HDRFTR_CENTER">HEADER_CENTER</a> <ul> - <li><a href="#HDRFTR_CENTER_PAD">HEADER_CENTER_PAD</a> -- stick some space left of right of the center string + <li><a href="#HDRFTR_CENTER_PAD">HEADER_CENTER_PAD</a> -- stick some space left of right of the centre string </ul> <li><a href="#HDRFTR_RIGHT">HEADER_RIGHT</a> - <li><a href="#PAGE_NUMBER_SYMBOL">Replacing header left, center or right with the page number</a> - <li><a href="#PAGE_NUMBER_INCL">Including the page number in header left, center or right</a> + <li><a href="#PAGE_NUMBER_SYMBOL">Replacing header left, centre or right with the page number</a> + <li><a href="#PAGE_NUMBER_INCL">Including the page number in header left, centre or right</a> </ul> <li><a href="#HDRFTR_STYLE"><strong>STYLE</strong></a> <ul> @@ -584,10 +588,10 @@ can be designed to your own specifications. </ul> <ul> <li><a href="#HDRFTR_STYLE_PART"><strong>Part-by-part changes</strong></a> - <li><a href="#_FAMILY">_FAMILY</a> -- left, center or right family - <li><a href="#_FONT">_FONT</a> -- left, center or right font - <li><a href="#_SIZE">_SIZE</a> -- left, center or right size - <li><a href="#_CAPS">_CAPS</a> -- left, center or right all caps + <li><a href="#_FAMILY">_FAMILY</a> -- left, centre or right family + <li><a href="#_FONT">_FONT</a> -- left, centre or right font + <li><a href="#_SIZE">_SIZE</a> -- left, centre or right size + <li><a href="#_CAPS">_CAPS</a> -- left, centre or right all caps </ul> <li><a href="#HDRFTR_VERTICAL"><strong>VERTICAL PLACEMENT AND SPACING</strong></a> <ul> @@ -611,7 +615,7 @@ can be designed to your own specifications. </a> <br> <a name="HDRFTR_CENTER"> - Macro: <strong>HEADER_CENTER</strong> <var>"<text of header center>" | #</var> + Macro: <strong>HEADER_CENTER</strong> <var>"<text of header centre>" | #</var> </a> <br> <a name="HDRFTR_RIGHT"> @@ -619,8 +623,8 @@ can be designed to your own specifications. </a> <p> -To change the text (the "string") of the left, center, -or right part of headers, invoke the appopriate macro above with +To change the text (the "string") of the left, centre, +or right part of headers, invoke the appropriate macro above with the string you want. For example, <strong>mom</strong>, by default, prints the document's author in the header-left position. If your document has, say, two authors, and you want both their names to @@ -638,9 +642,9 @@ they must be enclosed in double-quotes. <strong>NOTE:</strong> Replace <strong>HEADER_</strong>, above, with <strong>FOOTER_</strong> to change the strings in footers. -<a name="HDRFTR_CENTER_PAD"><h3><u>*Padding the header/footer center string</u></h3></a> +<a name="HDRFTR_CENTER_PAD"><h3><u>*Padding the header/footer centre string</u></h3></a> <p> -Macro: <strong>HEADER_CENTER_PAD</strong> <var>LEFT | RIGHT <amount of space by which to pad center string left or right></var> +Macro: <strong>HEADER_CENTER_PAD</strong> <var>LEFT | RIGHT <amount of space by which to pad centre string left or right></var> <br> <em>*Requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a></em> <p> @@ -681,10 +685,10 @@ argument obviously puts the padding on the left side of the string. Most reassuring of all is that if you use <strong>HEADER_CENTER_PAD</strong> conjunction with <a href="rectoverso.html#RECTO_VERSO">RECTO_VERSO</a>, -<strong>mom</strong> will pad the center string appropriately left +<strong>mom</strong> will pad the centre string appropriately left OR right, depending on which page you're on, without you having to tell her to do so. -<br> +<p> <hr width="66%" align="left"> <p> @@ -701,9 +705,9 @@ along. A case where you might want to do this would be if you want to output endnotes at the end of each document in a series of <a href="rectoverso.html#COLLATE">collated</a> documents, and you want the word "Endnotes" to go in the header -center position of the endnotes, but want, say, the +centre position of the endnotes, but want, say, the <a href="docprocessing.html#TITLE">TITLE</a> -to go back into the center position for the next output document. +to go back into the centre position for the next output document. <p> In scenarios like the above, <strong>mom</strong> has a number of "reserved" strings that you can plug into the @@ -721,7 +725,7 @@ macros. They are: \*[$CHAPTER_TITLE] -- the argument passed to .CHAPTER_TITLE </pre> -Returning to the scenario above, first, you'd define a center +Returning to the scenario above, first, you'd define a centre string for the endnotes page: <p> <pre> @@ -742,7 +746,7 @@ Then, you'd prepare <strong>mom</strong> for the next document: .AUTHOR "Josephine Blough" </pre> -Then, you'd redefine the header center string using the reserved +Then, you'd redefine the header centre string using the reserved string \*[$TITLE], like this: <p> <pre> @@ -780,12 +784,13 @@ which, assuming a <strong>.CHAPTER_STRING</strong> of "Chapter" and a <strong>.CHAPTER</strong> of "2", would put "Chapter 2" in the header centre position. +<p> <a name="PAGE_NUMBER_SYMBOL"> - <h3><u>*Replacing header-left, -center or -right with the page number</u></h3> + <h3><u>*Replacing header-left, -CENTER or -right with the page number</u></h3> </a> If you would like to have the current page number to appear -header-left, -center, or -right <em>instead</em> of a text +header-left, -CENTER, or -right <em>instead</em> of a text string, invoke the appropriate macro, above, with the single argument <code>#</code> (the "number" or "pound" sign). Do <strong>NOT</strong> use @@ -795,11 +800,12 @@ double-quotes. For example, .HEADER_CENTER # </pre> -will print the current page number in the center part of +will print the current page number in the CENTER part of headers. +<p> <a name="PAGE_NUMBER_INCL"> - <h3><u>*Including the page number in header-left, -center or -right</u></h3> + <h3><u>*Including the page number in header-left, -CENTER or -right</u></h3> </a> If you would like to <em>include</em> the current page number in the string you pass to <strong>HEADER_LEFT, _CENTER,</strong> or @@ -818,7 +824,7 @@ invoke <strong>HEADER_RIGHT</strong> as follows: Header-right of page two will read "page 2 of 10", header-right of page three will read "page 3 of 10", and so on. -<br> +<p> <hr> <!---HDRFTR_STYLE---> @@ -858,7 +864,7 @@ typesetting macro <p> <strong>NOTE:</strong> Replace <strong>HEADER_</strong>, above, with <strong>FOOTER_</strong> to change the footer family. -<br> +<p> <hr width="33%" align="left"> <p> @@ -905,7 +911,7 @@ You'll most likely require this when the <a href="docprocessing.html#COPYSTYLE">COPYSTYLE</a> is <strong>DRAFT</strong>, since portions of the header may overprint if, say, the title of your document is very long. -<br> +<p> <hr width="33%" align="left"> <p> @@ -927,7 +933,7 @@ and point size as she uses in paragraphs. <strong>NOTE:</strong> Replace <strong>HEADER_</strong>, above, with <strong>FOOTER_</strong> to disable <strong>mom</strong>'s default behaviour for the various elements of footer style. -<br> +<p> <hr width="66%" align="left"> <p> @@ -959,7 +965,7 @@ for an explanation of how control macros ending in <p> <strong>NOTE:</strong> Replace <strong>HEADER_</strong>, above, with <strong>FOOTER_</strong> to change a footer part's family. -<br> +<p> <hr width="33%" align="left"> <p> @@ -976,7 +982,7 @@ for an explanation of how control macros ending in <p> <strong>NOTE:</strong> Replace <strong>HEADER_</strong>, above, with <strong>FOOTER_</strong> to change a footer part's font. -<br> +<p> <hr width="33%" align="left"> <p> @@ -993,7 +999,7 @@ for an explanation of how control macros ending in <p> <strong>NOTE:</strong> Replace <strong>HEADER_</strong>, above, with <strong>FOOTER_</strong> to change a footer part's size. -<br> +<p> <hr width="33%" align="left"> <p> @@ -1018,7 +1024,7 @@ QUIT, END, X...</strong>). <strong>NOTE:</strong> Replace <strong>HEADER_</strong>, above, with <strong>FOOTER_</strong> to change a footer part's capitalization style. -<br> +<p> <hr> <!---HDRFTR_VERTICAL---> @@ -1032,7 +1038,7 @@ See <a href="#VERTICAL_SPACING">Vertical placement and spacing of headers/footers</a> for an explanation of how <strong>mom</strong> deals with headers, footers, and top/bottom page margins. -<br> +<p> <!---HDRFTR_MARGIN---> @@ -1117,7 +1123,6 @@ as in these examples. </pre> <h3>A note on header/footer margins and page numbering</h3> -<p> <strong>Mom</strong> uses HEADER_MARGIN</strong> and <strong>FOOTER_MARGIN</strong> to establish the baseline position of page numbers in addition to the baseline position of @@ -1133,7 +1138,7 @@ there with <a href="#PAGENUM_POS">PAGENUM_POS</a>, you'd use <strong>HEADER_MARGIN</strong> to change their baseline placement. -<br> +<p> <!---HDRFTR_GAP---> @@ -1165,7 +1170,7 @@ top margin. <p> <strong>Mom</strong>'s default header gap is 3 <a href="definitions.html#TERMS_PICASPOINTS">picas</a>, -but if you want a different gap, say, 2 centimeters, do +but if you want a different gap, say, 2 centimetres, do <p> <pre> .HEADER_GAP 2c @@ -1202,7 +1207,7 @@ the last line of running text and a bottom page number, use <strong>FOOTER_GAP</strong>. If page numbers are at the top of the page, change the gap between the number and the first line of running text with <strong>HEADER_GAP</strong>. -<br> +<p> <hr> <!---HDRFTR_SEPARATOR---> @@ -1225,7 +1230,7 @@ footer), you can alter its placement. <ul> <li><a href="#HDRFTR_RULE">HEADER_RULE</a> -- on or off <li><a href="#HDRFTR_RULE_GAP">HEADER_RULE_GAP</a> -- distance of rule from header -</ul +</ul> <!---HDRFTR_RULE---> @@ -1251,7 +1256,7 @@ without any argument. with <strong>FOOTER_</strong> to enable/disable the printing of the footer separator rule. (Most likely, if you're using <a href="#FOOTERS">FOOTERS</a>, you'll want it off.) -<br> +<p> <!---HDRFTR_RULE_GAP---> @@ -1302,7 +1307,7 @@ footer or <strong>mom</strong> may not get the rule gap right. Inline changes to the size of type in <strong>FOOTER_RECTO</strong> and <strong>FOOTER_VERSO</strong> should always be negative (smaller) than the default. -<br> +<p> <hr> <a name="PAGINATION"> @@ -1311,11 +1316,11 @@ should always be negative (smaller) than the default. <p> By default, <strong>mom</strong> paginates documents. Page numbers -appear in the bottom margin of the page, centered between two hyphens. +appear in the bottom margin of the page, centred between two hyphens. As with all elements of <strong>mom</strong>'s document processing, most aspects of pagination style can be altered to suit your taste with control macros. -<br> +<p> <a name="INDEX_PAGINATION"> <h3><u>Pagination macros list</u></h3> @@ -1329,7 +1334,7 @@ with control macros. <li><a href="#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a> -- attach draft/revision information to page numbers <li><a href="#PAGINATE_CONTROL">Control macros</a> </ul> -<br> +<p> <!---PAGINATE---> @@ -1352,7 +1357,7 @@ NO, QUIT, END, X...</strong>), e.g. To (re)start pagination, invoke <strong>PAGINATE</strong> without any argument. -<br> +<p> <!---PAGENUMBER---> @@ -1372,7 +1377,7 @@ number on the first page of a document, invoke any time to tell <strong>mom</strong> what number you want a page to have. Subsequent page numbers will, of course, be incremented by 1 from that number. -<br> +<p> <!---PAGENUM_STYLE---> @@ -1386,13 +1391,13 @@ Macro: <strong>PAGENUM_STYLE</strong> <var>DIGIT | ROMAN | roman | ALPHA | alpha <strong>mom</strong> what kind of page numbering you want. <p> <table valign="baseline" summary="pagenumstyle"> -<tr><td>DIGIT<td align="center" width="15">=<td>arabic digits (1, 2, 3...) +<tr><td>DIGIT<td align="center" width="15">=<td>Arabic digits (1, 2, 3...) <tr><td>ROMAN<td align="center" width="15">=<td>upper case roman numerals (I, II, III...) <tr><td>roman<td align="center" width="15">=<td>lower case roman numerals (i, ii, iii...) <tr><td>ALPHA<td align="center" width="15">=<td>upper case letters (A, B, C...) <tr><td>alpha<td align="center" width="15">=<td>lower case letters (a, b, c...)</td></tr> </table> -<br> +<p> <!---PAGENUM_ON_FIRST_PAGE---> @@ -1422,7 +1427,7 @@ page of a document, but do want one on pages that appear after <a href="docprocessing.html#START">START</a> of the document, then invoke it either just before or after your first <strong>COLLATE</strong>. -<br> +<p> <!---DRAFT_WITH_PAGENUMBER---> @@ -1434,7 +1439,7 @@ Macro: <strong>DRAFT_WITH_PAGENUMBER</strong> <p> Sometimes, in <a href="docprocessing.html#COPYSTYLE">COPYSTYLE DRAFT</a>, -the center part of page headers gets overcrowded because of the draft +the CENTER part of page headers gets overcrowded because of the draft and revision information that go there by default. <strong>DRAFT_WITH_PAGENUMBER</strong> is one way to fix the problem. @@ -1451,7 +1456,7 @@ See the note in <a href="docprocessing.html#COPYSTYLE">COPYSTYLE DRAFT</a> for other ways of dealing with crowded page headers when formatting draft-style copy. -<br> +<p> <hr> <!---PAGINATE_CONTROL---> @@ -1498,6 +1503,7 @@ pages at the top right position, enter </pre> <a name="#PAGENUM_HYPHENS"><h3><u>3. Enclose page numbers with hyphens (on or off)</u></h3></a> +<p> By default, <strong>mom</strong> encloses page numbers between hyphens. If you don't want this behaviour, invoke the macro <strong>PAGENUM_HYPHENS</strong> with any argument (<strong>OFF, QUIT, END, X...</strong>), @@ -1509,8 +1515,8 @@ like this: If, for some reason, you want to turn page number hyphens back on, invoke the macro without an argument. - <p> + <hr> <a href="rectoverso.html#TOP">Next</a> <a href="docelement.html#TOP">Prev</a> diff --git a/contrib/mom/momdoc/inlines.html b/contrib/mom/momdoc/inlines.html index ef463703..dd486e45 100644 --- a/contrib/mom/momdoc/inlines.html +++ b/contrib/mom/momdoc/inlines.html @@ -12,14 +12,14 @@ <a href="toc.html">Back to Table of Contents</a> <a name="TOP"></a> -<h2> +<h1 align="center"> <a name="INLINE_ESCAPES"><u>Inline escapes</u></a> -</h2> - +</h1> +<p> <a href="#INLINE_ESCAPES_INTRO">Introduction to inline escapes</a> <br> <a href="#INDEX_INLINES">Index of inline escapes</a> -<br> +<p> <a name="INLINE_ESCAPES_INTRO"> <h2><u>Introduction to inline escapes</u></h2> @@ -52,14 +52,14 @@ backslash character as part of a line of text, simply enter it twice character." (You can also use <strong>\e</strong> to print a literal backslash.) <p> -Groff has a number of ways of recognising what constitutes a complete +Groff has a number of ways of recognizing what constitutes a complete escape sequence. This is both a boon and a curse; some escape sequences have no terminating delimiter and consequently become difficult to distinguish from real input text. Others require the use of an opening parenthesis with no corresponding closing parenthesis. Still others need to be enclosed in square brackets. <p> -<strong>Mom</strong> recognises that certain escapes get used more +<strong>Mom</strong> recognizes that certain escapes get used more often than others. For these, she has a consistent input style that takes the form \*[...], which makes them stand out well from the text of your documents. These escapes are the ones listed under @@ -100,6 +100,7 @@ that take <li><a href="#INLINE_CHARACTERS_GROFF">Special characters</a> </ul> </ul> +<p> <hr> <!---INLINE_FONTS_MOM---> @@ -129,7 +130,7 @@ for other ways to change fonts inline. <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>, inline font changes remain in effect only for the duration of the current macro. -<br> +<p> <!---INLINE_SIZE_MOM---> @@ -189,7 +190,7 @@ of the rest of the line. of handling inline size requests (<kbd>\sN, \s±N, \s(NN, \s±(NN, \s[NNN], \s±[NNN]</kbd>), feel free to continue with your old habits. <strong>Mom</strong> doesn't care. -<br> +<p> <!---INLINE_KERNING_MOM---> @@ -204,7 +205,7 @@ for more details). <p> <strong>Mom</strong> permits inline pairwise kerning through the use of the inline escapes -<p> +<br> <table valign="baseline" summary="inlinekerning"> <tr><td width="15"><td><pre>\*[BU #]</pre><td>Closes the space between letters (<strong>B</strong>ack <strong>U</strong>nits). <tr><td><td><pre>\*[FU #]</pre><td>Opens the space between letters (<strong>F</strong>orward <strong>U</strong>nits). @@ -212,8 +213,7 @@ kerning through the use of the inline escapes <br> "<strong>#</strong>" is the number of <a href="definitions.html#TERMS_KERNUNIT">kern units</a> -by which to close or open the space between letters. Decimal fractions -are allowed. +by which to close or open the space between letters. <p> For example, <p> @@ -244,7 +244,7 @@ up to a limit of 36). between characters pairs that are already automatically kerned disables the automatic kerning and uses the value you give to <strong>BU</strong> or <strong>FU</strong> instead. -<br> +<p> <!---INLINE_HORIZONTAL_MOM---> @@ -295,7 +295,7 @@ the unit of measure, hence no unit of measure required). Both accept quarter points, so it's possible to do, for example, <strong>\*[FP.5]</strong> or <strong>\*[BP1.25]</strong> up to a limit of 12.75 points. -<br> +<p> <!---INLINE_VERTICAL_MOM---> @@ -338,8 +338,8 @@ Reverse lead .5...12.75 points (move upward)</td></tr> <p> <p> Both <strong>\*[ALD]</strong> and <strong>\*[RLD]</strong> work in -points, hence you musn't use a unit of measure. -<br> +points, hence you mustn't use a unit of measure. +<p> <!---INLINE_RULE_MOM---> @@ -381,7 +381,7 @@ macro and See groff's <a href="#INLINE_LINEDRAWING_GROFF">Horizontal line drawing function</a> for more information on drawing horizontal rules. -<br> +<p> <hr> <!---INLINE_FONT_GROFF---> @@ -418,7 +418,7 @@ this: The Unix command "ls -l" will appear in Courier Bold Italic in a line that is otherwise in Times Roman. -<br> +<p> <!---INLINE_HORIZONTAL_GROFF---> @@ -449,7 +449,7 @@ position on the current moves you 1.25 inches to the left (backwards). <strong>\h'-<distance>'</strong> is exactly equivalent to <a href="#BCK"><strong>\*[BCK #<unit>]</strong></a>. -<br> +<p> <!---INLINE_VERTICAL_GROFF---> @@ -496,7 +496,7 @@ you've done what you want to do. Otherwise, the remaining type will be set too high (if you used <strong>\v</strong> with the minus sign) or too low (if you used <strong>\v</strong> without the minus sign). -<br> +<p> <!---INLINE_STRINGWIDTHL_GROFF---> @@ -524,7 +524,7 @@ argument.</em> Furthermore, if the string is composed of several words separated by spaces, you MUST surround the whole escape with double quotes, as in the example above. -<br> +<p> <!---INLINE_LINEDRAWING_GROFF---> @@ -567,8 +567,8 @@ the job," I prefer a vector drawing program (in my case, tgif) when I need to combine type with graphic elements (say, a complex ruled form). Inserting the results into a document is easy enough with <strong>.PSPIC</strong> (consult the <strong>grops</strong> -man page for information on this indispensible and easy-to-use macro). -<br> +man page for information on this indispensable and easy-to-use macro). +<p> <!---INLINE_CHARACTERS_GROFF---> diff --git a/contrib/mom/momdoc/intro.html b/contrib/mom/momdoc/intro.html index 91b4c279..2bbda4e0 100644 --- a/contrib/mom/momdoc/intro.html +++ b/contrib/mom/momdoc/intro.html @@ -50,7 +50,7 @@ She's aimed at three kinds of users: started. </ol> <p> -As might be infered from the above, <strong>mom</strong> is two macro +As might be inferred from the above, <strong>mom</strong> is two macro packages in one: a set of typesetting macros, and a set of document processing macros. The typesetting macros govern the physical aspects of page layout and provide sane, comprehensible control over @@ -72,6 +72,7 @@ read up on groff <a href="definitions.html#TERMS_PRIMITIVES">primitives</a> in order to accomplish what you want; the typesetting macros take care of that. +<p> <a name="INTRO_TYPESETTING"> <h2><u>Typesetting with mom</u></h2> @@ -107,7 +108,7 @@ way: one step at a time with complete control over every element on the page. <p> Years of reading various mailing lists dealing with computer -typesetting (groff, TeX, and friends) have convinced me that no progam +typesetting (groff, TeX, and friends) have convinced me that no program can ever replace the human eye and human input when it comes to high quality typesetting. As of this writing, a thread on the subject of "micro typography" in groff has been going on for nearly a @@ -124,7 +125,7 @@ so on. She merely tries to provide tools that allow knowledgeable typesetters to come up with solutions to these problems in ways that are somewhat easier and more intuitive than manipulating groff at the -<a href="definitions.html#TERMS_PRIMITIVES">primtive</a> +<a href="definitions.html#TERMS_PRIMITIVES">primitive</a> level. As a professional typesetter of more than two decades, and a writer, I have encountered few situations that cannot be handled by <strong>mom</strong>'s typesetting macros. @@ -136,7 +137,7 @@ account both word AND letter spacing when lines. At present, only word spacing is adjusted, requiring what I consider an unnecessary amount of user intervention whenever letter spacing is required. - +<p> <a name="INTRO_DOCPROCESSING"> <h2><u>Document processing with mom</u></h2> </a> @@ -149,7 +150,7 @@ differs is in the degree of control you have over the look and placement of the various elements of a document. For example, if you don't want your heads underlined, or you want them bigger/smaller, or you'd prefer them to be in a different font, or you'd rather they -were flush left instead of centered, you can make the changes easily +were flush left instead of centred, you can make the changes easily and have them apply to the whole document. Temporary and one-off changes are easy, too. <p> @@ -163,7 +164,7 @@ special macro -- high-school typing teacher proud. Footnotes, multiple columns, recto/verso printing and user designable headers and footers are also part of the fun. - +<p> <a name="INTRO_PHILOSOPHY"> <h2><u>Mom's philosophy</u></h2> </a> @@ -232,7 +233,7 @@ bottom of the page without some text underneath it), but in all cases where hanging bottom margins can be avoided, <strong>mom</strong> does avoid them, by clever adjustments to leading ("line spacing") and the spacing between different elements on the page. - +<p> <a name="INTRO_DOCUMENTATION"> <h2><u>A note on mom's documentation</u></h2> </a> @@ -271,25 +272,24 @@ are the groff <strong>info</strong> pages, available by typing </pre> at the command line (assuming you have <strong>info</strong> -istalled on your system). +installed on your system). <p> I've tried to avoid reiterating the information contained in these documents; however, in a few places, this has proved impossible. -But be forewarned: I have no qualms about sidestepping excrutiating -completeness about groff usage; I'm more concerned with getting +But be forewarned: I have no qualms about sidestepping excruciating +completeness concerning groff usage; I'm more interested in getting <strong>mom</strong> users up and running. <em>Mea culpa.</em> <p> <strong>Note:</strong> <strong>Mom</strong>'s macro file (om.tmac) is heavily commented. Each macro is preceded by a -description of its arguments, function, and usage, which may +description of its arguments, function and usage, which may give you information in addition to what's contained in this documentation. - +<p> <a name="MACRO_ARGS"> <h3><u>How to read macro arguments</u></h3> </a> -<p> The concise descriptions of macros in this documentation typically look like this: <blockquote> @@ -326,12 +326,14 @@ simply reads <blockquote> <var>toggle</var> </blockquote> +<br> <hr> <h3>Example 1: an argument requiring double-quotes</h3> <blockquote> Macro: <strong>TITLE</strong> <var>"<title of document>"</var> </blockquote> +<p> The required argument to <strong>TITLE</strong> is the title of your document. Since it's surrounded by double-quotes, you must include them in the argument, like this: @@ -344,6 +346,7 @@ include them in the argument, like this: <blockquote> Macro: <strong>TAB_SET</strong> <var><tab #> <indent> <length> [ L | R | C | J [ QUAD ] ]</var> </blockquote> +<p> The first required argument is a number that identifies the tab (say, "3"). The second required argument is an indent from the left margin (say, 6 picas). The third required argument is the length of the tab @@ -366,12 +369,12 @@ you could enter: .TAB_SET 3 6P 3P L QUAD </pre> -<a name="TOGGLE_EXAMPLE"><h3>Example 3: a sample toggle macro:</h3></a> - +<a name="TOGGLE_EXAMPLE"></a> +<h3>Example 3: a sample toggle macro:</h3> <blockquote> Macro: <strong>QUOTE</strong> <var>toggle</var> </blockquote> - +<p> <strong>QUOTE</strong> begins a section of quoted text in a document and doesn't require an argument. When the quote's finished, you have to tell <strong>mom</strong> it's done. diff --git a/contrib/mom/momdoc/letters.html b/contrib/mom/momdoc/letters.html index a344f4c6..8a1611e8 100644 --- a/contrib/mom/momdoc/letters.html +++ b/contrib/mom/momdoc/letters.html @@ -10,6 +10,7 @@ <a href="typemacdoc.html#TOP">Next</a> <a href="cover.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> +<p> <a name="TOP"></a> <a name="LETTERS"> @@ -33,11 +34,11 @@ to design correspondence to your own specifications. However, flexibility in the matter of letters, which are, after all, simple communicative documents whose only real style requirements are that they be neat and professional-looking. - +<p> <a name="TUTORIAL"><h2><u>Tutorial on writing letters</u></h2></a> - -<strong>Mom</strong> letters begin, like all <strong>mom</strong> -processed documents, with a +<p> +<strong>Mom</strong> letters begin, like all +<strong>mom</strong>-processed documents, with a <a href="docprocessing.html#REFERENCE_MACROS">reference macro</a> (in this case, <a href="docprocessing.html#AUTHOR">AUTHOR</a>), @@ -46,7 +47,8 @@ a (<strong>LETTER</strong>, obviously), the essential <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a> macro, and -<a href="docprocessing.html#START">START</a>. +<a href="docprocessing.html#START">START</a>, +like this: <p> <pre> .AUTHOR "Yannick P. Guique" @@ -58,30 +60,40 @@ macro, and <strong>PRINTSTYLE</strong>, above, could also be <strong>TYPEWRITE</strong>. <strong>Mom</strong> has no objection to creating letters that look like they were typed on an Underwood -by a shapely secretary with great gams back in the 1940s. +by a shapely secretary with 1940s gams. <p> -After the <strong>START</strong> macro, you enter data pertinent to +After the <strong>START</strong> macro, you enter headers pertinent to your letter: the date, the addressee (in business correspondence, -typically both name and address), the addressor (that's you; in +typically both name and address), the addresser (that's you; in business correspondence, typically both name and address), and a -greeting (in full, e.g. "Dear Mr. Smith,"). +greeting (in full, e.g. "Dear Mr. Smith," or "Dear +Mr. Smith:"). <p> -The macros for entering the data are simple (they're not even -<a href="definitions.html#TERMS_TOGGLE">toggles</a>) -and entered in an intuitive order. -<br> -<ol> - <li><code>.DATE</code> - <li><code>.TO</code> - <li><code>.FROM</code> - <li><code>.GREETING</code> -</ol> +The macros for entering the headers are simple (they're not even +<a href="definitions.html#TERMS_TOGGLE">toggles</a>): +<p> +<pre> + .DATE + .TO + .FROM + .GREETING +</pre> + +You may enter them in any order you like, except for +<strong>GREETING</strong>, which must come last. +<strong>Mom</strong> ignores any headers you omit and spaces the +letter's opening according to what you do include. See +<a href="#LETTERS_DEFAULTS">Default for letters</a> +to find out how <strong>mom</strong> formats the headers. <p> -<strong>Mom</strong> ignores any you omit and spaces the letter's -opening according to what you do include. +(In pre 1.1.7-a releases of <strong>mom</strong>, the order +of entry was fixed at the above. This has been changed, although +if you do follow the above order, <strong>mom</strong> will +continue to behave exactly as she did in pre 1.1.7-a.) <p> Once you've filled in what you need to get a letter started, simply -type the letter, introducing each and every paragraph with the +type the letter, introducing each and every paragraph, including +the first, with the <a href="docelement.html#PP">PP</a> macro. <p> @@ -132,19 +144,78 @@ here's what the complete letter looks like. .CLOSING Sincerely, </pre> + +This produces a letter with headers that follow the North American +standard for business correspondence. If you'd prefer another +style of correspondence, for example, British, you'd set up the +same letter like this: +<p> +<pre> + .AUTHOR "Yannick P. Guique" + .DOCTYPE LETTER + .PRINTSTYLE TYPESET + .START + .FROM + .RIGHT + Y.P. GUIQUE + 022 Umask Road + St-Sauveur-en-dehors-de-la-mappe, Québec + .TO + GUILLAUME BARRIÈRES + Minidoux Corporation + 5000 Pannes Drive + Redmond, Virginia + .DATE + .RIGHT + August 25, 2004 + .GREETING + Dear Mr. Barrières, +</pre> + +Notice the use of <strong>.RIGHT</strong> after +<strong>.FROM</strong> and <strong>.DATE</strong> in this example, +used to change the default quad for these macros. +<p> <hr> <a name="LETTERS_DEFAULTS"> <h2><u>Defaults for letters</u></h2> </a> -In letters, <strong>mom</strong> sets: +In letters, if the order of header macros is <p> +<pre> + .DATE + .TO + .FROM + .GREETING +</pre> + +<strong>mom</strong> sets +<br> <ol> - <li>the date flush right, page right, at the top of page one - <li>the addressee in a block flush left, page left - <li>the addressor in a block flush left, page left - <li>the greeting flush left + <li>the date flush right, page right, at the top of page one, +with a gap of two linespaces underneath + <li>the addressee in a block flush left, page left, with a gap of +one linespace underneath + <li>the addresser in a block flush left, page left, with a gap of +one linespace underneath + <li>the greeting flush left, with a gap of one linespace +underneath +</ol> +<p> +which is the standard for North American business correspondence. +<p> +If you switch the order of <strong>.DATE</strong>, +<strong>.TO</strong> and/or <strong>.FROM</strong>, +<strong>mom</strong> sets all the headers flush left, with a gap of +one linespace underneath. (The default left quad of any header can +be changed by invoking the <strong>.RIGHT</strong> macro, on a line +by itself, immediately before inputting the text of the header.) +<p> +Following the headers, <strong>mom</strong> sets +<p> +<ul> <li>the body of the letter justified <li>in multi-page letters: <ul> @@ -152,7 +223,7 @@ In letters, <strong>mom</strong> sets: <li>the page number at the top of every page after page one </ul> <li>the closing/signature line flush left, indented halfway across the page -</ol> +</ul> <p> Other important style defaults are listed below, and may be changed via the @@ -185,7 +256,7 @@ Spaced paragraphs yes no Footers* yes yes Footer margin 3 picas 3 picas Footer gap 3 picas 3 picas -Page numbers top, centered top, centered +Page numbers top, centred top, centred *Footers contain a "next page" number of the form .../# </pre> @@ -207,6 +278,7 @@ except <strong>NO_SUITE</strong>. <li><a href="#CLOSING">CLOSING</a> <li><a href="#NO_SUITE">NO_SUITE</a> -- "next page" number off </ul> +<br> <!---DATE---> @@ -224,6 +296,29 @@ underneath, like this: October 31, 2002 </pre> +If you wish to change the default quad direction for the date, +enter <kbd>.LEFT</kbd> or <kbd>.RIGHT</kbd>, on a line by itself, +immediately after <kbd>.DATE</kbd>. +<p> +If you wish to insert additional space between the date and any +letter header that comes after it, do so after inputting the date, +not at the top of the next header macro, like this: +<p> +<pre> + .DATE + October 31, 2002 + .SPACE \" Or, more simply, .SP +</pre> + +If you wish to remove the default space, +<p> +<pre> + .SPACE -1v \" Or, more simply, .SP -1v +</pre> + +will do the trick. +<p> + <!---TO---> <hr width="66%" align="left"> @@ -242,6 +337,31 @@ and address of the addressee underneath, like this: Bramladesh, Ont. </pre> +If you wish to change the default quad direction for the address, +enter <kbd>.LEFT</kbd> or <kbd>.RIGHT</kbd>, on a line by itself, +immediately after <kbd>.TO</kbd>. +<p> +If you wish to insert additional space between the address and +any letter header that comes after it, do so after inputting the +address, not at the top of the next header macro, like this: +<p> +<pre> + .TO + JOHN SMITH + 10 Roberts Crescent + Bramladesh, Ont. + .SPACE \" Or, more simply, .SP +</pre> + +If you wish to remove the default space, +<p> +<pre> + .SPACE -1v \" Or, more simply, .SP -1v +</pre> + +will do the trick. +<p> + <!---FROM---> <hr width="66%" align="left"> @@ -251,7 +371,7 @@ Macro: <strong>FROM</strong> <p> Invoke <strong>FROM</strong> on a line by itself, with the name -and address of the addressor underneath, like this: +and address of the addresser underneath, like this: <p> <pre> .FROM @@ -260,6 +380,31 @@ and address of the addressor underneath, like this: Ste-Vieille-Andouille, Québec </pre> +If you wish to change the default quad direction for the address, +enter <kbd>.LEFT</kbd> or <kbd>.RIGHT</kbd>, on a line by itself, +immediately after <kbd>.FROM</kbd>. +<p> +If you wish to insert additional space between the address and +any letter header that comes after it, do so after inputting the +address, not at the top of the next header macro, like this: +<p> +<pre> + .FROM + JOE BLOW + 15 Brunette Road + Ste-Vieille-Andouille, Québec + .SPACE \" Or, more simply, .SP +</pre> + +If you wish to remove the default space, +<p> +<pre> + .SPACE -1v \" Or, more simply, .SP -1v +</pre> + +will do the trick. +<p> + <!---GREETING---> <hr width="66%" align="left"> diff --git a/contrib/mom/momdoc/rectoverso.html b/contrib/mom/momdoc/rectoverso.html index 88e661ea..29279452 100644 --- a/contrib/mom/momdoc/rectoverso.html +++ b/contrib/mom/momdoc/rectoverso.html @@ -10,14 +10,12 @@ <a href="cover.html#TOP">Next</a> <a href="headfootpage.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> +<p> <a name="TOP"></a> +<a name="INDEX_RECTOVERSO"></a> <a name="RECTOVERSO"> - <h2 align="center"><u>RECTO/VERSO PRINTING and COLLATING</u></h2> -</a> - -<a name="INDEX_RECTOVERSO"> - <h3><u>Recto/verso and collating</u></h3> + <h1 align="center"><u>RECTO/VERSO PRINTING and COLLATING</u></h1> </a> <ul> @@ -57,7 +55,7 @@ of the following aspects of alternating page layout: if user-defined, single string recto/verso headers or footers are used in place of the default 3-part headers or footers - <li>switching the page number position (if page numbers are not centered) + <li>switching the page number position (if page numbers are not centred) </ul> <p> It is beyond the scope of this documentation to cover the different @@ -74,8 +72,7 @@ appropriately, put them back in your printer, and have work from the command line, check out the man pages for <strong>pstops</strong> and <strong>psbook</strong>. There are other programs out there as well to help with two-sided printing. -<br> - +<p> <a name="RECTOVERSO_LIST"> <h3><u>Recto/verso macros list</u></h3> @@ -85,6 +82,7 @@ programs out there as well to help with two-sided printing. <li><a href="#RECTO_VERSO">RECTO_VERSO</a> <li><a href="#SWITCH_HDRFTR">SWITCH_HEADERS (also FOOTERS)</a> </ul> +<p> <hr> <!---RECTO_VERSO---> @@ -92,7 +90,6 @@ programs out there as well to help with two-sided printing. <a name="RECTO_VERSO"> <h3><u>Recto/verso printing</u></h3> </a> -<br> Macro: <strong>RECTO_VERSO</strong> <p> @@ -122,11 +119,11 @@ and (before or after <strong>START</strong>). <p> Equally, recto/verso only switches the page number position if page -numbers aren't centered, which means you have to set the page +numbers aren't centred, which means you have to set the page number position with <a href="headfootpage.html#PAGENUM_POS">PAGENUM_POS</a> (before or after <strong>START</strong>). -<br> +<p> <!---SWITCH_HDRFTR---> @@ -134,7 +131,6 @@ number position with <a name="SWITCH_HDRFTR"> <h3><u>Switch header left part/right part</u></h3> </a> -<br> Macro: <strong>SWITCH_HEADERS</strong> <p> @@ -144,7 +140,7 @@ string (by default, the document title). If you don't like <strong>mom</strong>'s default placement of author and title, use <strong>SWITCH_HEADERS</strong> to reverse it. <p> -<strong>SWITCH_HEADERS</strong> can also be useful in conjuction +<strong>SWITCH_HEADERS</strong> can also be useful in conjunction with <a href="#RECTO_VERSO">RECTO_VERSO</a>. The assumption of <strong>RECTO_VERSO</strong> is that the first @@ -160,7 +156,7 @@ respect to headers) will come out as you want. <p> <strong>NOTE:</strong> Replace <strong>_HEADERS</strong>, above, with <strong>_FOOTERS</strong> if your document uses footers. -<br> +<p> <hr> <!=====================================================================> @@ -205,15 +201,14 @@ files, chances are the <strong>PRINTSTYLE</strong>'s already there. <ol> <li>Do not collate documents of differing <strong>PRINTSTYLES</strong> (i.e. don't try to - collate a TYPESET document and TYPEWRITE document -- - why would you want to do that anyway?) + collate a TYPESET document and TYPEWRITE document). <li>Use <strong>DOC_FAMILY</strong> instead of <strong>FAMILY</strong> if, for some reason, you want to change the family of all the document elements after <strong>COLLATE</strong>. <strong>FAMILY</strong>, by itself, will change the family of paragraph text only. </ol> -<br> +<p> <!---COLLATE---> @@ -221,7 +216,7 @@ files, chances are the <strong>PRINTSTYLE</strong>'s already there. <a name="COLLATE"> <h3><u>Collate document files</u></h3> </a> -<br> + Macro: <strong>COLLATE</strong> <p> @@ -246,7 +241,7 @@ that require their own titles, looks like this: <strong>NOTE:</strong> See the <a href="#CAUTION">two words of caution</a>, above. -<br> +<p> <hr> <a href="cover.html#TOP">Next</a> diff --git a/contrib/mom/momdoc/reserved.html b/contrib/mom/momdoc/reserved.html index 4e88da78..70202351 100644 --- a/contrib/mom/momdoc/reserved.html +++ b/contrib/mom/momdoc/reserved.html @@ -7,11 +7,26 @@ <!====================================================================> -<a href="appendices.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> <a name="TOP"></a> <a name="RESERVED"> <h2 align="center"><u>LIST OF RESERVED WORDS</u></h2> </a> <p> The following is a list of "reserved" words used by <strong>mom</strong>. Before changing the name of any macro or document element tag with <a href="goodies.html#ALIAS">ALIAS</a>, I strongly recommend doing a search of this page for your proposed new name. If you find it in the left hand column, DON'T USE IT. Choose something else instead. <p> +<a href="appendices.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> +<p> + +<a name="TOP"></a> +<a name="RESERVED"> +<h1 align="center"><u>LIST OF RESERVED WORDS</u></h1> +</a> +<p> The following is a list of "reserved" words used by +<strong>mom</strong>. Before changing the name of any macro or +document element tag with +<a href="goodies.html#ALIAS">ALIAS</a>, +I strongly recommend doing a search of this page for your proposed +new name. If you find it in the left hand column, DON'T USE IT. +Choose something else instead. +<p> Anyone interested in playing around inside <strong>mom</strong>'s macro file (om.tmac) will find this list useful as well since it lists all -(I hope) the macros, strings, and number registers <strong>mom</strong> -uses, along with brief descriptions of their functions. +(I hope) the macros, strings, diversions and number registers +<strong>mom</strong> uses, along with brief descriptions of their +functions. <p> <pre> TYPESETTING @@ -58,11 +73,11 @@ AUTOLEAD Always lead n points more than .PT_SIZE Flush ----- JUSTIFY Justified text -QUAD Filled text, left, right, or center +QUAD Filled text, left, right, or centre Quad ---- -CENTER Non-filled text, center +CENTER Non-filled text, centre LEFT Non-filled text, left RIGHT Non-filled text, right @@ -147,7 +162,7 @@ PAD Insert padding spaces at marked places PADMARKER Sets character to use instead of # in PAD PRINT Simply prints args passed to it; keeps my code indented nicely -RW Reduce white -- tighten overal line kern +RW Reduce white -- tighten overall line kern (character spacing) SILENT Don't print lines till SILENT OFF SIZESPECS Get cap-height, x-height and descender depth for @@ -165,10 +180,11 @@ TYPESIZE Diverts SIZESPECS routine so it doesn't print +++NUMBER REGISTERS+++ #ALD ALD value -#ARGS_TO_LIST Tells LIST whether LIST was invoked with a legal arg; - controls LIST OFF processing -#ARGS_TO_SQ Tells SMARTQUOTES whether it was invoked with a legal - arg; controls SMARTQUOTES OFF processing +#ARGS_TO_LIST Tells LIST whether LIST was invoked with a legal + arg; controls LIST OFF processing +#ARGS_TO_SQ Tells SMARTQUOTES whether it was invoked with a + legal arg; controls SMARTQUOTES OFF + processing #AUTOLEAD_FACTOR Using FACTOR arg to AUTOLEAD? (toggle) #AUTO_LEAD Using autolead? (toggle) #AUTO_LEAD_VALUE Auto leading value @@ -185,7 +201,7 @@ c column mark #CURRENT_TAB Current tab number #DC_GUT Width of dropcap gutter #DEGREES # of degrees slant for pseudo-italic -#ENUMERATOR<n> Number register enumerator for depth <n> in lists +#ENUMERATOR<n> Number register enumerator for depth <n> in lists #EXTEND Are we in pseudo-extend mode? (toggle) #EXT_WIDTH Width of pseudo-extended type (pointsize x $EXT_PERCENT) @@ -200,7 +216,7 @@ c column mark (toggle) #IN_TAB Are we in a tab? (toggle) Set in macro TAB; used in ST to determine - whether to add #ST_OFFSET to #ST<#>_OFFSETT + whether to add #ST_OFFSET to #ST<#>_OFFSET #INDENT_ACTIVE Indicates whether an indent is active (toggle) #INDENT_BOTH_ACTIVE Toggle #INDENT_LEFT_ACTIVE Toggle @@ -215,7 +231,7 @@ c column mark #LAST_TAB Last tab number set in multi-columns #LEAD Leading (alias) #LIGATURES Ligatures on? (toggle) -#LIST_INDENT<n> Left indent of list <n> +#LIST_INDENT<n> Left indent of list <n> #L_INDENT Value of left indent #L_LENGTH Line length #L_MARGIN Page offset if set with LMARGIN; @@ -229,7 +245,7 @@ c column mark p Output line horiz position at end of $PAD_STRING #PAD_COUNT Number of times # was included in arg to PAD -#PAD_LIST_DIGITS Pad list digits to the left? <toggle> +#PAD_LIST_DIGITS Pad list digits to the left? <toggle> #PAD_SPACE Size of padding space #PAGE_LENGTH Page length (alias) #PAGE_WIDTH Page width @@ -239,7 +255,8 @@ p Output line horiz position at end of #Q_AT_TOP Does a quote start at the top of a new page? (toggle) #QUAD In autoquad mode? (toggle) -#QUIT Tells LIST whether to exit lists completely <toggle> +#QUIT Tells LIST whether to exit lists completely + <toggle> #REMOVE Used in LIST OFF cleanup #RESTORE_LEAD Lead value in effect prior to AUTOLEAD #RESTORE_LINE_LENGTH Restores actual line length in RULE @@ -247,8 +264,8 @@ p Output line horiz position at end of to underscore #R_INDENT Value of right indent #R_MARGIN Right margin -#RESTORE_PREV_INDENT Tells LIST OFF what kind of indent was active prior to - first invocation of LIST +#RESTORE_PREV_INDENT Tells LIST OFF what kind of indent was active + prior to first invocation of LIST #RLD RLD value #SILENT Is silent on? (toggle) #SIZE_FOR_PAD Used to ensure that the size in effect prior @@ -261,14 +278,19 @@ p Output line horiz position at end of #ST<#>_MARK Page offset of autotab <#> at ST<#>X #ST_NUM Incrementing counter for autotab identification #ST_OFFSET Offset (from current tab) to add to #ST<#>_OFFSET - when calculating string indents set from within tabs + when calculating string indents set from within + tabs #ST<#>_OFFSET Indent of autotab <#> (page offset) #STORED_L_INDENT Current left indent at first invocation of LIST #STORED_R_INDENT Current right indent at first invocation of LIST -#STORED_BL_INDENT Current "both, left" indent at first invocation of LIST -#STORED_BR_INDENT Current "both, right" indent at first invocation of LIST -#STORED_HL_INDENT Current hanging indent at first invocation of LIST -#STORED_T_INDENT Current temporary indent at first invocation of LIST +#STORED_BL_INDENT Current "both, left" indent at first invocation + of LIST +#STORED_BR_INDENT Current "both, right" indent at first invocation + of LIST +#STORED_HL_INDENT Current hanging indent at first invocation + of LIST +#STORED_T_INDENT Current temporary indent at first invocation + of LIST t "mark" register set in T_MARGIN; recalled in LS and AUTOLEAD if #T_MARGIN_SET is 1 #T_INDENT Value of temporary indent @@ -291,7 +313,7 @@ $CURRENT_TAB Current tab number $DC_ADJUST +|- # of points to subtract from dropcap $DC_FAM Drop cap family $DC_FT Drop cap font -$ENUMERATOR<n> String enumerator for depth <n> in lists +$ENUMERATOR<n> String enumerator for depth <n> in lists $EXT_PERCENT Percentage by which to pseudo-extend type $FAMILY Family $FAMILY_FOR_PAD Used to ensure that the family in effect prior @@ -300,12 +322,12 @@ $FAMILY_FOR_PAD Used to ensure that the family in effect prior $FONT Font $PAD_MARKER Character to mark off padding in PAD $PAD_STRING Arg passed to PAD -$QUAD_VALUE Quad value (left, right, center, justify) +$QUAD_VALUE Quad value (left, right, centre, justify) $QUOTE0 `` $QUOTE1 '' $RESTORE_QUAD_VALUE Quad value for use in restoring L, R, C, J (after tabs) -$SEPARATOR<n> Separator for depth <n> in lists +$SEPARATOR<n> Separator for depth <n> in lists $SS_VAR Holds + or - sentence space value $ST<#>_FILL Always QUAD if QUAD passed to ST <#> $ST<#>_QUAD_DIR Quad direction supplied to ST for <#> @@ -483,7 +505,8 @@ COLUMNS Print in columns DOC_FAMILY Overall doc family DOCHEADER_ADVANCE Start position of docheader (relative to top of page) -DOCHEADER_LEAD +|- value applied to #DOC_LEAD to in/decrease leading of doc header +DOCHEADER_LEAD +|- value applied to #DOC_LEAD to in/decrease + leading of doc header DOC_HEADER Print doc header? DOC_LEAD_ADJUST Adjust #DOC_LEAD to fill page to #B_MARGIN DOC_LEAD Overall doc leading @@ -504,7 +527,7 @@ DO_QUOTE Print quote (invoked from QUOTE or BLOCKQUOTE) DRAFT_STRING What to print whenever the word "draft" is required DRAFT_WITH_PAGENUMBER Attach draft/revision info to page number - (instead of putting it HEADER center) + (instead of putting it HEADER centre) ENDNOTE_FAMILY Family for endnotes ENDNOTE_FONT Font for endnotes ENDNOTE_LEAD Leading for endnotes page @@ -534,9 +557,10 @@ ENDNOTE_NUMBERS_ALIGN_LEFT Don't hang endnote numbers and align left ENDNOTES_ALLOWS_HEADERS Page headers on endnotes pages? (toggle) ENDNOTES_FIRST_PAGENUMBER Page number to appear on page 1 of endnotes pages -ENDNOTES_HDRFTR_CENTER Print header/footer center string on endnotes pages? -ENDNOTES_HEADER_CENTER Print header center string on endnotes pages? -ENDNOTES_FOOTER_CENTER Print footer center string on endnotes pages? +ENDNOTES_HDRFTR_CENTER Print header/footer centre string on endnotes + pages? +ENDNOTES_HEADER_CENTER Print header centre string on endnotes pages? +ENDNOTES_FOOTER_CENTER Print footer centre string on endnotes pages? ENDNOTES_NO_COLUMNS Turn columnar mode off for endnotes pages ENDNOTES_NO_FIRST_PAGENUM Don't print a pagenumber on page 1 of endnotes. @@ -565,14 +589,14 @@ FOOTNOTE_RULE_LENGTH Length of footnote separator rule FOOTNOTE_RULE Turns printing of fn separator rule on or off; default is on FOOTNOTE_SIZE ps of footnotes -HDRFTR_CENTER String to go in center part of header/footer; +HDRFTR_CENTER String to go in centre part of header/footer; default doctype -HDRFTR_CENTER_CAPS Center part of header/footer in caps? (toggle) -HDRFTR_CENTER_FAMILY Family of center part of header/footer -HDRFTR_CENTER_FONT Font of center part of header/footer -HDRFTR_CENTER_PAD Pad hdrftr center left or right by specified +HDRFTR_CENTER_CAPS Centre part of header/footer in caps? (toggle) +HDRFTR_CENTER_FAMILY Family of centre part of header/footer +HDRFTR_CENTER_FONT Font of centre part of header/footer +HDRFTR_CENTER_PAD Pad hdrftr CENTER left or right by specified amount -HDRFTR_CENTER_SIZE ps in/decrease of center part of header/footer** +HDRFTR_CENTER_SIZE ps in/decrease of CENTER part of header/footer** HDRFTR_FAMILY Family to use in the headers/footers HDRFTR_GAP Distance from header/footer to running text HDRFTR_LEFT_CAPS Left part of header/footer in caps? (toggle) @@ -593,7 +617,8 @@ HDRFTR_RIGHT_FAMILY Family of right part of headers/footers HDRFTR_RIGHT_FONT Font of right part of headers/footers HDRFTR_RIGHT_SIZE Size of right part of headers/footers HDRFTR_RIGHT The header/footer right string -HDRFTR_RULE_GAP Space between header/footer and header/footer rule +HDRFTR_RULE_GAP Space between header/footer and header/footer + rule HDRFTR_RULE_INTERNAL Prints the header/footer rule HDRFTR_RULE Turns header/footer rule on or off HDRFTR_RULE Turns header/footer rule on or off. @@ -624,17 +649,19 @@ PAGENUM_HYPHENS Turns on/off hyphens surrounding page numbers PAGENUM_ON_FIRST_PAGE Print page number on first page when footers are on (toggle) PAGENUM_POS Controls placement of page numbers; - default=bottom/centered + default=bottom/centred PAGENUM_SIZE How much to in/decrease point size of page numbers* -PAGENUM_STYLE Page # in roman, arabic, or alphabetic +PAGENUM_STYLE Page # in roman, Arabic, or alphabetic PARAHEAD_FAMILY Family to use for paraheads PARAHEAD_FONT Font to use for paraheads -PARAHEAD_INDENT How mucht to indent paraheads +PARAHEAD_INDENT How much to indent paraheads PARAHEAD_SIZE Size of paraheads* PARA_INDENT Size of para indent PARA_SPACE Put a line space before paras PP_FONT Overall doc font +PROCESS_SHIM Calculates #SHIM when \n(.d is lower on the + page than #T_MARGIN QUOTE_FAMILY Family to use in pquotes QUOTE_FONT Font to use in pquotes QUOTE_INDENT Value by which to multiply PP_INDENT for @@ -711,33 +738,32 @@ UNDERLINE_SLANT In TYPEWRITE, render \*[SLANT] as underlined *relative to #DOC_PT_SIZE **relative to overall ps of headers as set by HEADER_SIZE - ***relative to overal ps of endnotes pages + ***relative to overall ps of endnotes pages ****relative to overall ps of toc pages +++LETTER MACROS+++ -CLOSING Closing (ie. Yours truly,) -DATE Date string for letters -FROM Addressor's name and address -GREETING Full salutation (eg. Dear John Smith,) +CLOSING Closing (i.e. Yours truly,) +DATE Date for letters +FROM Addresser's name and address +GREETING Full salutation (e.g. Dear John Smith,) NO_SUITE Remove suite page numbers from bottom of letter pages TO Addressee's name and address ALL_DONE .em (the "end macro") for letters +++DIVERSIONS+++ -B_QUOTE Block (indented) quote text -CLOSING Closing (ie. Yours truly,) -DATE Date string for letters -EPI_TEXT Epigraph text -END_NOTES Endnotes text -FN_OVERFLOW Excess footnotes when B_MARGIN is reached -FOOTNOTES Text of footnotes -FROM_ADDRESS Addressor's name and address -GREETING Full salutation (eg. Dear John Smith,) -P_QUOTE Line for line (poetic) quote text -TO_ADDRESS Addressee's name and address -TOC_ENTRIES TOC entries +B_QUOTE Block (indented) quote text +CLOSING Closing (i.e. Yours truly,) +EPI_TEXT Epigraph text +END_NOTES Endnotes text +FN_OVERFLOW Excess footnotes when B_MARGIN is reached +FOOTNOTES Text of footnotes +GREETING Full salutation (e.g. Dear John Smith,) +LETTERHEAD<n> Date, addresser, addressee or greeting; + <n> is from 1 to 4, supplied by #FIELD +P_QUOTE Line for line (poetic) quote text +TOC_ENTRIES TOC entries +++SUPPORT+++ @@ -785,7 +811,7 @@ TRAPS Sets hdrftr traps; optionally adjusts #DOC_LEAD over footer #CAPS_WAS_ON In HDRFTR, to re-enable running text CAPS (toggle) -#CENTER_CAP_HEIGHT Cap height of center string in +#CENTER_CAP_HEIGHT Cap height of CENTER string in headers/footers #CLOSING Is there a closing (for letters)? 1=yes #COL_L_LENGTH Line length of columns @@ -802,8 +828,9 @@ TRAPS Sets hdrftr traps; optionally adjusts #DOC_LEAD endnotes in no-columns mode #COPY_STYLE 1=draft, 2=final #CURRENT_V_POS \n(.d ; used in SHIM +#DATE_FIRST Was .DATE invoked as first letter + header after .START? (toggle) dc "mark" register for document columns -#DATE Is there a date (for letters)? 1=yes #DEFER_PAGINATION Tells COLLATE to restore pagination (from RESTORE_PAGINATION #DEPTH_1 Doc header depth with lead adjustment @@ -847,7 +874,8 @@ dc "mark" register for document columns (toggle) #EN_NUMBERS_ALIGN_LEFT Align endnote numbers with left margin? (toggle) -#EN_NUMBERS_PLACEHOLDERS Number of placeholders when endnote numbers hang and align right +#EN_NUMBERS_PLACEHOLDERS Number of placeholders when endnote numbers + hang and align right #EN_NUMBER_L_LENGTH Line length for endnote numbers when they're right aligned #EN_PP_INDENT First line indent of paras in multi-para @@ -855,7 +883,7 @@ dc "mark" register for document columns #EN_PP_SPACE Space multi-paras in endnotes? (toggle) #EN_PS ps of endnotes #EN_SINGLESPACE Single space endnotes pages? (toggle) -#EN_STRING_CAPS Should ENDNOTES capitalise the endnotes +#EN_STRING_CAPS Should ENDNOTES capitalize the endnotes string? (toggle) #EN_STRING_UNDERSCORE Underscore endnotes page head? (toggle) #EN_TITLE_UNDERSCORE Underscore endnotes document identifier? @@ -875,7 +903,8 @@ dc "mark" register for document columns #EPIGRAPH Did we have an epigraph? (toggle) #EPI_LEAD_DIFF Difference between #DOC_LEAD and #EPI_LEAD #EPI_LEAD Leading of epigraph; set by AUTOLEAD -#EPI_LINES_EVEN Even # of lines at end of epi crossing page in TYPEWRITE (d-spaced)? +#EPI_LINES_EVEN Even # of lines at end of epi crossing page in + TYPEWRITE (d-spaced)? #EPI_LINES Number of lines in the epigraph #EPI_LINES_TO_END Number of epigraph lines remaining after footer trap is sprung @@ -887,12 +916,15 @@ dc "mark" register for document columns #EPI_ON Are we in an epigraph? (toggle) #EPI_WHITESPACE Space after epigraph to compensate for epigraph leading +#FIELD Incrementing register tacked onto LETTERHEAD #FINIS Was FINIS invoked? (toggle) #FN_AUTOLEAD Autolead value of footnotes #FN_BL_INDENT Left indent of INDENT BOTH in footnotes #FN_BR_INDENT Right indent of INDENT BOTH in footnotes -#FN_COUNT_FOR_COLS Holds a separate footnote count for columns (so they don't reset to 0 1 until page break) -#FN_DEFER Defer footnote to next page/column? (toggle) If 0, don't defer. +#FN_COUNT_FOR_COLS Holds a separate footnote count for columns + (so they don't reset to 0 1 until page break) +#FN_DEFER Defer footnote to next page/column? (toggle) + If 0, don't defer. #FN_DEFER_SPACE Whether to deposit space before footnote 1 because there's a deferred footnote on the page @@ -902,31 +934,32 @@ dc "mark" register for document columns #FN_LEAD Lead in footnotes after FN_AUTOLEAD is applied #FN_L_INDENT Left indent of INDENT LEFT in footnotes -#FN_LINES Number of lines in fn; used to calculate fn depth +#FN_LINES Number of lines in fn; used to calculate + fn depth #FN_MARKERS Print footnote markers? (toggle) #FN_MARKER_STYLE 1=STAR; 2=NUMBER -#FN_NUMBER Running count of fn #; used to print fn marker numbers +#FN_NUMBER Running count of fn #; used to print fn marker + numbers #FN_R_INDENT Right indent of INDENT RIGHT in footnotes #FN_RULE_ADJ # of points to raise footnote separator from its baseline #FN_RULE_LENGTH Length of footnote separator rule #FN_RULE Print fn rule? (toggle) -#FN_WAS_DEFERED Tells HEADER about a defered footnote +#FN_WAS_DEFERED Tells HEADER about a deferred footnote #FOOTER_GAP Amount of space between end of text and page # #FOOTER_MARGIN Amount of space between page # and bottom of page #FOOTERS_ON Are we using footers? (toggle) -#FOOTERS_WERE_ON Were footers on? - used in FINIS and BLANKPAGE (toggle) -#FROM Is there an addressor (for letters)? 1=yes +#FOOTERS_WERE_ON Were footers on? - used in FINIS and BLANKPAGE + (toggle) #FULLSPACE_QUOTES Should we fullspace quotes? (toggle) -#GREETING Is there a greeting (for letters)? 1=yes #GUTTER Width of gutter between columns -#HDRFTR_CENTER_CAPS Center part of header/footer in caps? +#HDRFTR_CENTER_CAPS CENTER part of header/footer in caps? (toggle; default=off) -#HDRFTR_CTR_PAD_LEFT Amount of hdrftr center padding on the left -#HDRFTR_CTR_PAD_RIGHT Amount of hdrftr center padding on the right -#HDRFTR_CTR_PAD_TMP Temp storage of left hdrftr center padding +#HDRFTR_CTR_PAD_LEFT Amount of hdrftr CENTER padding on the left +#HDRFTR_CTR_PAD_RIGHT Amount of hdrftr CENTER padding on the right +#HDRFTR_CTR_PAD_TMP Temp storage of left hdrftr CENTER padding (for recto/verso switch) #HDRFTR_HEIGHT Cap height of $HDRFTR_RECTO/$HDRFTR_VERSO strings @@ -955,11 +988,11 @@ dc "mark" register for document columns #IGNORE Should we ignore this macro? Set to 1 in TYPEWRITE. #INDENT_FIRST_PARAS Indent first paras? (toggle) -#INDENT_FIRSTS Tells foonotes to leave INDENT_FIRST_PARAS +#INDENT_FIRSTS Tells footnotes to leave INDENT_FIRST_PARAS alone if it's on for running text. #ITALIC_MEANS_ITALIC For TYPEWRITE. 1=yes; 0=no #LEFT_CAP_HEIGHT Cap height of left string in headers/footers -#LEGAL_BASELINE Calculates vert. position of next legal +#LEGAL_BASELINE Calculates vet. position of next legal baseline in SHIM #LETTER_STYLE 1=BUSINESS 2=PERSONAL #LINEBREAK Did we have a linebreak? (toggle) @@ -973,22 +1006,27 @@ dc "mark" register for document columns #NEXT_AUTHOR Supplies correct digit to AUTHOR_<#> when printing authors in doc header #NO_TRAP_RESET Should we reset page traps? (toggle) -#NUM_AUTHORS # of authors mod 2 to test if odd or even # of authors +#NUM_AUTHORS # of authors mod 2 to test if odd or even + # of authors #NUMBER_HEAD Are heads numbered? (toggle) #NUMBER_PH Are paraheads numbered? (toggle) #NUMBER_SH Are subheads numbered? (toggle) #NUM_COLS Number of columns per page +#NUM_FIELDS Incrementing register used to match + #TOTAL_FIELDS #OK_PROCESS_LEAD Initial processing of TOC and endnote - leading is defered until OK_PROCESS_LEAD=1 + leading is deferred until OK_PROCESS_LEAD=1 #PAGE_NUM_ADJ What to add to n% to get #PAGENUMBER #PAGENUMBER The page number #PAGENUM_STYLE_SET Did we set pagenumber style? (toggle) -#PAGE_NUM_H_POS 1=left 2=center 3=right; default=2 +#PAGE_NUM_H_POS 1=left 2=CENTER 3=right; default=2 #PAGE_NUM_HYPHENS Print hyphens surrounding page numbers? (toggle) -#PAGE_NUM_HYPHENS_SET Did user set (or unset) hyphens around page numbers? (toggle) +#PAGE_NUM_HYPHENS_SET Did user set (or unset) hyphens around page + numbers? (toggle) #PAGE_NUM_POS_SET Did user set page number position? (toggle) -#PAGE_NUM_SET Test if PAGE_1_NUM was used to set 1st page number +#PAGE_NUM_SET Test if PAGE_1_NUM was used to set 1st page + number #PAGE_NUMS Print page numbers? (toggle) #PAGE_NUM_V_POS 1=top 2=bottom; default=2 #PAGE_TOP \n(nl after HEADER completes itself @@ -1063,14 +1101,13 @@ dc "mark" register for document columns PRINT_HDRFTR that START has been invoked, allowing PRINT_HDRFTR to decide whether or not to print a footer on page 1 +#STORED_PP_INDENT Temporarily holds value of #PP_INDENT #SUITE Current page number (for letters) #SUP_PT_SIZE Point size of superscript #SUSPEND_PAGINATION Suspend pagination prior to endnotes? #SWITCH_HDRFTR Switch HDRFTR_LEFT and HDRFTR_RIGHT? (toggle) #TAB_OFFSET# "#" at the end is from $CURRENT_TAB -#TO Is there an addressee (for letters)? - 1=yes #TOC_AUTHORS Whether to append author(s) to toc doc title entries (toggle) #TOC_ENTRY_PN Current page number when a toc entry is @@ -1090,6 +1127,7 @@ dc "mark" register for document columns #TOC_SH_SIZE_CHANGE ps in/decrease of toc subhead entries**** #TOC_TITLE_INDENT Indent of toc doc title entries #TOC_TITLE_SIZE_CHANGE ps in/decrease of toc doc title entries**** +#TOTAL_FIELDS Total number of letter header fields #UNDERLINE_ITALIC For TYPEWRITE. 1=yes; 0=no #UNDERLINE_QUOTE Underline pquotes? (toggle) #UNDERLINE_SLANT For TYPEWRITE. 1=yes; 0=no @@ -1097,13 +1135,13 @@ dc "mark" register for document columns UNDERLINE (toggle) #USERDEF_HDRFTR User defined single string recto/verso header/footer? (toggle) -#USERDEF_HDRFTR_RECTO_QUAD 1=left, 2=center, 3=right -#USERDEF_HDRFTR_VERSO_QUAD 1=left, 2=center, 3=right -#USER_DEF_HEADER_CENTER User defined center title? (1=yes); +#USERDEF_HDRFTR_RECTO_QUAD 1=left, 2=CENTER, 3=right +#USERDEF_HDRFTR_VERSO_QUAD 1=left, 2=CENTER, 3=right +#USER_DEF_HEADER_CENTER User defined CENTER title? (1=yes); used in COPYSTYLE -#USER_DEF_HEADER_LEFT User defined center title? (1=yes); +#USER_DEF_HEADER_LEFT User defined CENTER title? (1=yes); used in COPYSTYLE -#USER_DEF_HEADER_RIGHT User defined center title? (1=yes); +#USER_DEF_HEADER_RIGHT User defined CENTER title? (1=yes); used in COPYSTYLE #VARIABLE_FOOTER_POS Wandering trap position for processing footnotes and footers; pos depends on @@ -1137,9 +1175,9 @@ $DOC_FAM Predominant font family used in the $DOC_QUAD Quad used for body text (justified or left) $DOC_TITLE Overall doc title that gets printed in - headers/footers (mostly for use with collated - docs where each doc is an article with a - different title + headers/footers (mostly for use with + collated docs where each doc is an + article with a different title $DOC_TYPE Document type (default, chapter, named, letter) $DOCHEADER_LEAD_ADJ +|- value applied to #DOC_LEAD to @@ -1186,10 +1224,10 @@ $FN_FAM Family used in footnotes $FN_FT Font used in footnotes $FN_QUAD Quad used in footnotes $FN_SIZE_CHANGE ps in/decrease of footnotes* -$HDRFTR_CENTER What to put in center part of headers; +$HDRFTR_CENTER What to put in CENTER part of headers; default doctype -$HDRFTR_CENTER_FAM Family of center part of headers -$HDRFTR_CENTER_FT Font of center part of headers +$HDRFTR_CENTER_FAM Family of CENTER part of headers +$HDRFTR_CENTER_FT Font of centre part of headers $HDRFTR_CENTER_NEW HDRFTR_CENTER after the start of TOC; defined in HDRFTR_CENTER if HDRFTR_CENTER is called as @@ -1198,7 +1236,7 @@ $HDRFTR_CENTER_OLD HDRFTR_CENTER just prior to start of TOC; defined in HDRFTR_CENTER if HDRFTR_CENTER is called as FOOTER_CENTER -$HDRFTR_CENTER_SIZE_CHANGE ps in/decrease of center title in +$HDRFTR_CENTER_SIZE_CHANGE ps in/decrease of centre title in headers** $HDRFTR_FAM Family to use in headers $HDRFTR_LEFT_FAM Family of left part of headers @@ -1220,7 +1258,7 @@ $HDRFTR_TMP_SWITCH Temporarily holds HDRFTR_LEFT if #SWITCH_HDRFTRS=1 $HEAD_FAM Family to use for section titles $HEAD_FT Font to use for section titles -$HEAD_QUAD Quad valude of section titles +$HEAD_QUAD Quad value of section titles $HEAD_SIZE_CHANGE ps in/decrease of section titles* $LINEBREAK_CHAR Character that marks line breaks $LINEBREAK_CHAR_V_ADJ +|- amount by which to raise/lower @@ -1292,7 +1330,7 @@ $USERDEF_HDRFTR_VERSO User defined header/footer verso string *relative to #DOC_PT_SIZE **relative to overall ps of headers as set by HEADER_SIZE ***relative to overall ps of endnotes -****relative to overal ps of toc pages +****relative to overall ps of toc pages +++PREPROCESSOR KEYWORDS+++ @@ -1342,7 +1380,7 @@ CITE BLOCKQUOTE COL_BREAK COL_NEXT DOC_FAM DOC_FAMILY DOC_LLENGTH DOC_LINE_LENGTH -DOC_L_LENGTT DOC_LINE_LENGTH +DOC_L_LENGTH DOC_LINE_LENGTH DOC_L_MARGIN DOC_LEFT_MARGIN DOC_LMARGIN DOC_LEFT_MARGIN DOC_LS DOC_LEAD diff --git a/contrib/mom/momdoc/toc.html b/contrib/mom/momdoc/toc.html index ba3e73b8..420f2c97 100644 --- a/contrib/mom/momdoc/toc.html +++ b/contrib/mom/momdoc/toc.html @@ -12,13 +12,13 @@ <p> <hr> <h2>Quick Table of Contents Navigation</h2> -<a href="#INTRO">INTRODUCTORY STUFF</a> +<a href="#INTRO"><strong>INTRODUCTORY STUFF</strong></a> <ul> <li><a href="#WHAT">What is mom?</a> <li><a href="#DEFS">Definitions of terms used in this manual</a> <li><a href="#USING">Using mom</a> </ul> -<a href="#TYPESET">TYPESETTING WITH MOM</a> +<a href="#TYPESET"><strong>TYPESETTING WITH MOM</strong></a> <ul> <li><a href="#TYPE_INTRO">Intro to typesetting macros</a> <li><a href="#PAGE">Page setup</a> @@ -33,7 +33,7 @@ <li><a href="#GOODIES">Goodies</a> <li><a href="#ESCAPES">Inline escapes</a> </ul> -<a href="#DOCPROC">DOCUMENT PROCESSING WITH MOM</a> +<a href="#DOCPROC"><strong>DOCUMENT PROCESSING WITH MOM</strong></a> <ul> <li><a href="#DOCPROC_INTRO">Introduction to document processing</a> <li><a href="#PRELIM">Preliminary document setup</a> diff --git a/contrib/mom/momdoc/typemacdoc.html b/contrib/mom/momdoc/typemacdoc.html index e74ce877..d4dbbe68 100644 --- a/contrib/mom/momdoc/typemacdoc.html +++ b/contrib/mom/momdoc/typemacdoc.html @@ -10,6 +10,7 @@ <a href="appendices.html#TOP">Next</a> <a href="letters.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> +<p> <a name="TOP"></a> <a name="TYPESETTING"> @@ -115,9 +116,14 @@ LS *Changes line space for the duration of the current tag only. As soon as another document element tag is entered, the line space reverts to the current document default for the new - tag. Highly NOT recommended, since changes to - a document's leading interfere with mom's - ability to balance bottom margins. + tag. + + Using LS to temporarily change leading within a + document will almost certainly result in a bottom + margin that doesn't align with the bottom margin + of subsequent pages. You'll need to use the SHIM + macro to get mom back on track when you're ready + to return to the document's default leading. QUAD *Changes quad for the duration of the current tag only. As soon as another document diff --git a/contrib/mom/momdoc/typesetting.html b/contrib/mom/momdoc/typesetting.html index 184825ca..32f9d91d 100644 --- a/contrib/mom/momdoc/typesetting.html +++ b/contrib/mom/momdoc/typesetting.html @@ -10,7 +10,7 @@ <a href="goodies.html#TOP">Next</a> <a href="definitions.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> - +<p> <a name="TOP"></a> <a name="MACROS_TYPESETTING"> <h1 align="center"><u>THE TYPESETTING MACROS</u></h1> @@ -83,6 +83,7 @@ <li><a href="inlines.html#INDEX_INLINES">List of inline escapes</a> </ul> </ul> +<p> <hr> <h2><a name="INTRO_MACROS_TYPESETTING"><u>Introduction to the typesetting macros</u></a></h2> @@ -113,7 +114,7 @@ friend's résumé, a poster for a lost dog -- none of these requires structured document processing (page headers, paragraphs, heads, footnotes, etc). What they do demand is precise control over every element on the page. The typesetting macros give you that control. -<br> +<p> <hr> <!====================================================================> @@ -138,7 +139,7 @@ for a number of well-known, established paper sizes. The <a href="#PAGE">PAGE</a> macro provides a convenient way of setting the page dimensions and some or all of the page margins with a single macro. -<br> +<p> <a name="INDEX_SETUP"> <h3><u>Page setup macros list</u></h3> @@ -155,6 +156,7 @@ some or all of the page margins with a single macro. <li><a href="#PAGE">PAGE</a> (page dimensions and margins all in one fell swoop) <li><a href="#NEWPAGE">NEWPAGE</a> (start a new page) </ul> +<p> <!---PAGEWIDTH---> @@ -282,7 +284,7 @@ using the See <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a> for an explanation. -<br> +<p> <!---R_MARGIN---> @@ -356,7 +358,7 @@ when you're using the See <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a> for an explanation. -<br> +<p> <!---T_MARGIN---> @@ -371,7 +373,7 @@ Macro: <strong>T_MARGIN</strong> <var><top margin></var> <strong>T_MARGIN</strong> establishes the distance from the top of the printer sheet at which you want your type to start. It requires a unit of measure, and decimal fractions are allowed. To set a top -margin of 2-1/2 centimeters, you'd enter +margin of 2-1/2 centimetres, you'd enter <p> <pre> .T_MARGIN 2.5c @@ -408,7 +410,7 @@ slightly different when you're using the See <a href="typemacdoc.html#TB_MARGINS">Top and bottom margins in document processing</a> for an explanation. -<br> +<p> <!---B_MARGIN---> @@ -449,7 +451,7 @@ slightly different when you're using the document processing macros. See <a href="typemacdoc.html#TB_MARGINS">Top and bottom margins in document processing</a> for an explanation. -<br> +<p> <!---PAGE---> @@ -528,7 +530,7 @@ of the first line of text down by one linespace. To compensate, do immediately before entering any text, or, if it's feasible, make <strong>PAGE</strong> the last macro you invoke prior to entering text. -<br> +<p> <!---NEWPAGE---> @@ -547,7 +549,7 @@ processing the current page and move you to the top of a new one <strong>Experts:</strong> <strong>NEWPAGE</strong> is an alias of <strong>.bp</strong>. You can use either, or mix 'n' match with impunity. -<br> +<p> <hr> <!====================================================================> @@ -566,7 +568,7 @@ to the basic parameter macros remain in effect until you change them. The document processing macros handle things differently. See <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a> for an explanation. -<br> +<p> <a name="INDEX_BASIC"><h3><u>Basic parameter macros list</u></h3></a> <ul> @@ -632,7 +634,7 @@ GARAMOND then becomes a legal family name you can pass to <strong>FAMILY</strong>. (You could, of course, shorten GARAMOND to just G, or GD.) R, I, B, and BI after GARAMOND are the roman, italic, bold and bold-italic fonts respectively. -<br> +<p> <!---FT---> @@ -672,7 +674,7 @@ family and font separate. <p> Fonts can also be changed inline. See <a href="inlines.html#INLINE_FONTS_MOM">Inline Escapes, font control</a>. -<br> +<p> <!---PT_SIZE---> @@ -714,7 +716,7 @@ then later reset it to 12 with The size of type can also be changed inline. See <a href="inlines.html#INLINE_SIZE_MOM">Inline Escapes, changing point size</a>. -<br> +<p> <!---LS---> @@ -767,7 +769,7 @@ then later reset it to 14 points with <strong>ls</strong>. <strong>LS</strong> acts like <strong>vs</strong>. <strong>mom</strong> does not provide a macro analogous to <strong>ls</strong>. -<br> +<p> <!---AUTOLEAD---> @@ -822,7 +824,7 @@ to 14, the leading automatically changes to 15.75 (14 x 1.125). <strong>NOTE:</strong> There's no need to prepend a plus sign (+) to <strong>AUTOLEAD</strong>'s argument, although you may do so if you wish. -<br> +<p> <!---LL---> @@ -859,7 +861,7 @@ sets the line length to 4-1/2 inches. <strong>NOTE:</strong> The <a href="#R_MARGIN">right margin macro</a> (<strong>R_MARGIN</strong>) can also be used to set line length. -<br> +<p> <hr> <!====================================================================> @@ -873,7 +875,7 @@ length. The justification and quadding macros deal with how type aligns along the left and right margins. In a nutshell, type either aligns at the left margin, at the right margin, at both margins, or at neither margin -(centered). +(centred). <p> These macros also determine whether or not <a href="definitions.html#TERMS_INPUTLINE">input lines</a> are joined and @@ -889,18 +891,18 @@ You may encounter some words here that are unfamiliar. Refer to <a href="definitions.html#TERMS_GROFF">Groff terms</a> for an explanation. <a name="INDEX_JUST"><h3><u>Justification, quad, fill, and break macro list</u></h3></a> - +<p> <ul> <li><strong>Fill modes</strong> <ul> <li><a href="#JUSTIFY">JUSTIFY</a> (set lines justified) - <li><a href="#QUAD">QUAD</a> (set filled lines flush left, right or centered) + <li><a href="#QUAD">QUAD</a> (set filled lines flush left, right or centred) </ul> <li><strong>Nofill modes</strong> <ul> <li><a href="#LRC">LEFT</a> (set non-filled lines flush left) <li><a href="#LRC">RIGHT</a> (set non-filled lines flush right) - <li><a href="#LRC">CENTER</a> (set non-filled lines centered) + <li><a href="#LRC">CENTER</a> (set non-filled lines centred) </ul> <li><strong>Breaking lines</strong> <ul> @@ -935,12 +937,12 @@ upon output. To break lines and prevent them from being filled and justified, use the <a href="#BR">BR</a> macro. -<br> +<p> <!---QUAD---> <hr width="66%" align="left"> -<a name="QUAD"><h3><u>Quad lines left, right, or center</u></h3></a> +<a name="QUAD"><h3><u>Quad lines left, right, or centre</u></h3></a> <br> Macro: <strong>QUAD</strong> <var>L | LEFT | R | RIGHT | C | CENTER | J | JUSTIFY</var> <br> @@ -963,7 +965,7 @@ along the left margin. If <strong>R</strong> or <strong>RIGHT</strong>, type is set flush along the right margin. <p> -If <strong>C</strong> or <strong>CENTER</strong> type is set centered +If <strong>C</strong> or <strong>CENTER</strong> type is set centred on the current line length. <p> <strong>J</strong> and <strong>JUSTIFY</strong> justify text, @@ -974,12 +976,12 @@ href="#JUSTIFY">JUSTIFY</a>. <p> To break lines and prevent them from being filled, use the <a href="#BR">BR</a> macro. -<br> +<p> <!---LEFT, RIGHT, CENTER---> <hr width="66%" align="left"> -<a name="LRC"><h3><u>Set non-filled lines flush left, right, or centered</u></h3></a> +<a name="LRC"><h3><u>Set non-filled lines flush left, right, or centred</u></h3></a> <br> Macro: <strong>LEFT</strong> Macro: <strong>RIGHT</strong> @@ -1029,7 +1031,7 @@ modes, groff does not always respect the current line length. that run long may exceed it, or get broken in undesirable ways. Therefore, when using these three macros, you should preview your work to ensure that all lines fit as expected. -<br> +<p> <!---BR---> @@ -1069,7 +1071,7 @@ ALL macros cause a break. If a break is not desired, use the <p> <strong>Experts: BR</strong> is an alias for <strong>br</strong>. You can use either, or mix 'n' match with impunity. -<br> +<p> <!---EL---> @@ -1109,7 +1111,7 @@ get 24. To demonstrate: The next line of text. </pre> -may be more instuitive than +may be more intuitive than <p> <pre> .LS 12.5 @@ -1168,7 +1170,7 @@ If you hadn't turned the trap off for <kbd>.EL</kbd>, "3." would have appeared at the bottom of the page by itself, with "Establish, once and for all..." appearing at the top of the next page. -<br> +<p> <!---SP---> @@ -1226,7 +1228,7 @@ after a line. <p> <strong>Experts: SPACE</strong> is an alias of <strong>sp</strong>. You can use either, or mix 'n' match with impunity. -<br> +<p> <!---SPREAD---> @@ -1249,7 +1251,7 @@ and have it came out fully justified. <p> <strong>Experts: SPREAD</strong> is an alias for <strong>brp</strong>. You can use either, or mix 'n' match with impunity. -<br> +<p> <!---JOIN---> @@ -1301,7 +1303,7 @@ words of the output line would read Please also note that had the example been in one of the <a href="definitions.html#TERMS_FILLED">fill modes</a>, there'd have been no need for the <strong>\c</strong>. -<br> +<p> <hr> <!====================================================================> @@ -1319,7 +1321,6 @@ ensuring that your documents look typographically professional. <a name="INDEX_REFINEMENTS"> <h3><u>Typographic refinements macro list</u></h3> </a> - <ul> <li><strong>Word and sentence spacing</strong> <ul> @@ -1413,7 +1414,7 @@ its groff default by entering This can be particularly useful if you've been playing around with plus and minus values, and can't remember by how much you have to in/decrease the word space to get it back to normal. -<br> +<p> <!---SS---> @@ -1487,7 +1488,7 @@ school of typists that puts two spaces between sentences. If you ignore this advice and use <strong>SS</strong> when you habitually put only one space between sentences, you risk producing output where the space between sentences is not equal. -<br> +<p> <!---HY---> @@ -1515,8 +1516,6 @@ you can pass to <strong>HY</strong>, I've broken them down into separate sections. <h3><u>1. HY</u></h3> - -<p> <strong>HY</strong> by itself (i.e. with no argument) simply turns automatic hyphenation on. Any argument other than <strong>LINES, MARGIN, SPACE</strong> or <strong>DEFAULT</strong>, turns automatic @@ -1542,8 +1541,6 @@ you could turn <strong>HY</strong> off by entering </ol> <h3><u>2. HY LINES</u></h3> - -<p> <strong>HY LINES</strong> sets the maximum number of consecutive hyphenated lines that will appear in output copy. 2 is a very good choice, and you'd set it with @@ -1562,8 +1559,6 @@ count when groff is figuring out how many lines to hyphenate; explicit hyphens do not. <h3><u>3. HY MARGIN</u></h3> - -<p> <strong>HY MARGIN</strong> sets the amount of room allowed at the end of a line before hyphenation is tripped (e.g. if there's only 6 points left at the end of a line, groff won't try to hyphenate @@ -1586,8 +1581,6 @@ MARGIN</strong> requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. <h3><u>4. HY SPACE</u></h3> - -<p> <strong>HY SPACE</strong> sets an amount of extra interword space that groff will <em>try</em> to put between words on a line in order to PREVENT hyphenation. <strong>HY SPACE</strong> @@ -1607,19 +1600,15 @@ value might be half a point, or one point, which you'd set with SPACE</strong> requires a <a href="definitions.html#TERMS_UNITOFMEASURE">unit of measure</a>. -<h3><u>4. HY DEFAULT</u></h3> - -<p> +<h3><u>5. HY DEFAULT</u></h3> <strong>HY DEFAULT</strong> resets automatic hyphenation to its default behaviour, cancelling any changes made with <strong>LINES, MARGIN,</strong> and/or <strong>SPACE</strong>. <h3><u>A note on hyphenation in general</u></h3> - -<p> Hyphenation is a necessary evil. If it can be avoided, it should be. If it can't be, it should occur infrequently. That's the reason for -number of parameters you can set with <strong>HY</strong>. +the number of parameters you can set with <strong>HY</strong>. <p> Furthermore, hyphenation in @@ -1630,7 +1619,7 @@ on consecutive lines to achieve a pleasing, natural-looking rag. Since such adjustments are often too fussy for document processing, I recommend playing around with <strong>HY MARGIN</strong> a bit if your copy looks hyphen-heavy. -<br> +<p> <!---HY_SET---> @@ -1679,7 +1668,7 @@ copy, </pre> is how you'd do it. -<br> +<p> <!---RW---> @@ -1733,7 +1722,7 @@ cancel its effect (<code>.RW 0</code>) on those fonts, or reinvoked you can tell <strong>mom</strong> that's what you want by invoking the <a href="#BR_AT_LINE_KERN">BR_AT_LINE_KERN</a> toggle macro. -<br> +<p> <!---EW---> @@ -1773,7 +1762,7 @@ assess the effect of <strong>EW</strong>. you can tell <strong>mom</strong> that's what you want by invoking the <a href="#BR_AT_LINE_KERN">BR_AT_LINE_KERN</a> toggle macro. -<br> +<p> <!---BR_AT_LINE_KERN---> @@ -1820,7 +1809,7 @@ Kerning of individual character pairs can be controlled with the <a href="definitions.html#TERMS_INLINES">inline escapes</a> <strong>\*[BU #]</strong> and <strong>\*[FU #]</strong>. See <a href="inlines.html#INLINE_KERNING_MOM">Inline Escapes, kerning</a>. -<br> +<p> <!---LIGATURES---> @@ -1846,7 +1835,7 @@ Good Thing, hence <strong>mom</strong> has them on by default. ligature generation off. <p> <strong>NOTE:</strong> Not all fonts support ligatures. -<br> +<p> <hr> <!====================================================================> @@ -1877,8 +1866,8 @@ type in a faked font look typographically cheap. <ul> <li><strong>Pseudo italic</strong> <ul> - <li><a href="#SETSLANT">SETSLANT</a> -- degree of pseudo-italicising - <li><a href="#SLANT_INLINE">\*[SLANT]</a> -- inline escape for pseudo-italicising type + <li><a href="#SETSLANT">SETSLANT</a> -- degree of pseudo-italicizing + <li><a href="#SLANT_INLINE">\*[SLANT]</a> -- inline escape for pseudo-italicizing type </ul> <li><strong>Pseudo bold</strong> <ul> @@ -1900,12 +1889,12 @@ type in a faked font look typographically cheap. <!---SETSLANT---> <hr width="66%" align="left"> -<a name="SETSLANT"><h3><u>Set degree of slant for pseudo-italicising</u></h3></a> +<a name="SETSLANT"><h3><u>Set degree of slant for pseudo-italicizing</u></h3></a> <br> Macro: <strong>SETSLANT</strong> <var><degrees to slant type> | RESET</var> <p> -Pseudo-italicising of type is accomplished by slanting a roman font +Pseudo-italicizing of type is accomplished by slanting a roman font a certain number of degrees to the right. <strong>SETSLANT</strong> lets you fix the number of degrees. <strong>Mom</strong>'s default is 15, which produces an acceptable approximation of an @@ -1924,12 +1913,12 @@ to the <strong>mom</strong> default, do </pre> <strong>NOTE:</strong> By itself, <strong>SETSLANT</strong> -will not start pseudo-italicising type; it merely tells +will not start pseudo-italicizing type; it merely tells <strong>mom</strong> what degree of slant you want. To start -pseudo-italicising, use the +pseudo-italicizing, use the <a href="definitions.html#TERMS_INLINES">inline escape</a> <strong>\*[SLANT]</strong>. -<br> +<p> <!---\*[SLANT]---> @@ -1941,7 +1930,7 @@ Inline: <strong>\*[SLANT] -- turn pseudo-italic on</strong> Inline: <strong>\*[SLANTX] -- turn pseudo-italic off</strong> <p> -<strong>\*[SLANT]</strong> begins pseudo-italicising type. +<strong>\*[SLANT]</strong> begins pseudo-italicizing type. <strong>\*[SLANTX]</strong> turns the feature off. Both are <a href="definitions.html#TERMS_INLINES">inline escapes</a>, therefore they should not appear as separate lines, but rather @@ -1951,7 +1940,7 @@ be embedded in text lines, like this: Not \*[SLANT]everything\*[SLANTX] is as it seems. </pre> -Alternatively, if you wanted the whole line pseudo-italicised, +Alternatively, if you wanted the whole line pseudo-italicized, you'd do <p> <pre> @@ -1969,7 +1958,7 @@ with <strong>mom</strong> underlines pseudo-italics by default. To change this behaviour, use the special macro <a href="docprocessing.html#SLANT_MEANS_SLANT">SLANT_MEANS_SLANT</a>. -<br> +<p> <!---SETBOLDER---> @@ -2005,7 +1994,7 @@ will not start emboldening type; it merely tells To start emboldening, use the <a href="definitions.html#TERMS_INLINES">inline escape</a> <strong>\*[BOLDER]</strong>. -<br> +<p> <!---\*[BOLDER]---> @@ -2044,7 +2033,7 @@ with <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, <strong>mom</strong> ignores <strong>\*[BOLDER]</strong> requests. -<br> +<p> <!---CONDENSE---> @@ -2085,7 +2074,7 @@ is off (with <a href="#COND_INLINE">\*[CONDX]</a>) before before making any changes to the pseudo-condense percentage with <strong>CONDENSE</strong>. -<br> +<p> <!---\*[COND]---> @@ -2128,7 +2117,7 @@ with <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, <strong>mom</strong> ignores <strong>\*[COND]</strong> requests. -<br> +<p> <!---EXTEND---> @@ -2149,7 +2138,7 @@ to be extended. <strong>EXTEND</strong>, therefore you must set it before using the <a href="definitions.html#TERMS_INLINES">inline escape</a> <a href="#EXT_INLINE">\*[EXT]</a>. -120 percent of the normal character width is a good value, and +120% of the normal character width is a good value, and you'd set it like this: <p> <pre> @@ -2170,7 +2159,7 @@ pseudo-extending is off (with <a href="#EXT_INLINE">\*[EXTX]</a>) before before making any changes to the pseudo-extend percentage with <strong>EXTEND</strong>. -<br> +<p> <!---\*[EXT]---> @@ -2213,7 +2202,7 @@ with <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE TYPEWRITE</a>, <strong>mom</strong> ignores <strong>\*[EXT]</strong> requests. -<br> +<p> <hr> <!====================================================================> @@ -2292,7 +2281,7 @@ way if you have set a top margin with <a href="#T_MARGIN">T_MARGIN</a> or <a href="#PAGE">PAGE</a>. -<br> +<p> <!---RLD---> @@ -2329,7 +2318,7 @@ As the mnemonic (<strong>R</strong>dvance use <strong>RLD</strong> with <a href="definitions.html#TERMS_PICASPOINTS">points</a> of lead. -<br> +<p> <hr> <!====================================================================> @@ -2346,7 +2335,7 @@ do with the tab key on your keyboard, and both are utterly divorced from groff's notion of tabs. I recommend reading this section carefully in order to understand how <strong>mom</strong> handles tabs. - +<p> <a name="TYPESETTING_TABS"><h3><u>Typesetting tabs</u></h3></a> <p> Typesetting tabs are defined by both an indent from the left margin and @@ -2366,7 +2355,7 @@ a quad direction and fill mode. After tabs have been created with <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a> for information and advice on using tabs with the <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>. - +<p> <a name="TYPESETTING_TABS_TUT"><h3><u>Quickie tutorial on typesetting tabs</u></h3></a> <p> Say you want to set up three tabs to produce an employee evaluation @@ -2412,7 +2401,7 @@ You want the second tab ("EVALUATION") <ul> <li>to begin 8 picas from the left margin <li>to have a length of 9 picas - <li>to be set centered. + <li>to be set centred. </ul> <br> You set it up like this: @@ -2524,7 +2513,7 @@ tab 3 means you don't have to worry about the length of <strong>mom</strong> <a href="definitions.html#TERMS_FILLED">fills</a> the tab and sets the type flush left. - +<p> <a name="STRING_TABS"><h3><u>String tabs (autotabs)</u></h3></a> <p> String tabs let you mark off tab positions inline. Left indents @@ -2554,7 +2543,7 @@ macro and the groff inline escape <a href="inlines.html#INLINE_HORIZONTAL_MOM">\*[FWD <distance>]</a> (move forward) inline, string tabs provide tremendous flexibility in setting up complex tab structures. - +<p> <a name="STRING_TABS_TUT"><h3><u>Quickie tutorial on string tabs</u></h3></a> <p> Say you want to set up tabs for the @@ -2657,7 +2646,7 @@ just like typesetting tabs (see <a href="#TYPESETTING_TABS_TUT">typesetting tabs tutorial</a>). <p> Here's the complete setup and entry for the sample employee -evaluation form utilising string tabs. +evaluation form utilizing string tabs. <p> <pre> .PAGE 8.5i 11i 1i 1i 1i @@ -2722,7 +2711,7 @@ Now try increasing the gutters to 2 picas (put an additional <kbd>\*[FP12]</kbd> after each <kbd>\*[FP12]</kbd>). Preview the file again, and notice how the tab structure remains the same, but the gutters are wider. - +<p> <a name="INDEX_TABS"> <h3><u>Tabs macro list</u></h3> @@ -2740,7 +2729,7 @@ the gutters are wider. <!---TAB_SET---> <hr width="66%" align="left"> - <a name="TAB_SET"><h3><u>Set up typsetting tabs</u></h3></a> + <a name="TAB_SET"><h3><u>Set up typesetting tabs</u></h3></a> <br> Macro: <strong>TAB_SET</strong> <var><tab number> <indent> <length> L | R | C | J [ QUAD ]</var> <br> @@ -2762,7 +2751,7 @@ four required arguments: <li>a direction </ul> <br> -To set up a centered tab 6 picas long and 9 points from the left +To set up a centred tab 6 picas long and 9 points from the left margin, you'd enter <p> <pre> @@ -2775,7 +2764,7 @@ need to set up tabs in numerical sequence. <p> By default, tabs are in <a href="definitions.html#TERMS_NOFILL">nofill</a> -mode, meaning you can enter text in tabs on a line for line basis +mode, meaning you can enter text in tabs on a line-for-line basis without having to use the <a href="#BR">BR</a> macro. If you want a tab to be @@ -2817,7 +2806,7 @@ up a tab structure within the confines of an existing tab). <a href="#INDENTS">Indents</a>) before setting up tabs with <strong>TAB_SET</strong>, or <strong>mom</strong> may get confused. -<br> +<p> <!---INLINE_ST---> @@ -2871,7 +2860,7 @@ a line that is broken with <strong>Mom</strong> calculates string tab positions and lengths as she reads the input line, not after the line has undergone manipulations to the word spacing. -<br> +<p> <!---ST---> @@ -2912,7 +2901,7 @@ If you want it to be justified, enter See the <a href="#STRING_TABS_TUT">Quickie tutorial on string tabs</a> for a full explanation of setting up string tabs. -<br> +<p> <!---TAB---> @@ -2981,7 +2970,7 @@ If you were happily zipping down the page with a left indent of 2 picas turned on, and you call a tab whose indent from the left margin is 6 picas, your new distance from the left margin will be 6 picas, not 6 picas plus the 2 pica indent. -<br> +<p> <!---TN---> @@ -3055,7 +3044,7 @@ If you hadn't turned the trap off before <kbd>.TN</kbd>, "1." would have appeared as the last line on the page, with "The first rule of survival..." being the first line on the next page. -<br> +<p> <!---TQ---> @@ -3071,7 +3060,7 @@ advances 1 linespace, and restores the left margin, line length, quad direction and <a href="definitions.html#TERMS_FILLED">fill mode</a> that were in effect prior to invoking any tabs. -<br> +<p> <hr> <!====================================================================> @@ -3152,7 +3141,7 @@ the <a href="docprocessing.html#COLUMNS">COLUMNS</a> macro in the <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>. - +<p> <a name="INDEX_MULTI_COLUMNS"> <h3><u>Columns macro list</u></h3> </a> @@ -3187,7 +3176,7 @@ the <a href="docprocessing.html#COLUMNS">COLUMNS</a> macro in the <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>. -<br> +<p> <!---MCR---> @@ -3202,7 +3191,7 @@ Once you've turned multi-columns on (with <a href="#MCO">MCO</a>), <strong>MCR</strong>, at any time, returns you to the top of your columns. -<br> +<p> <!---MCX---> @@ -3227,7 +3216,7 @@ invoked.</em> <p> If you pass the <var><distance></var> argument to <strong>MCX</strong>, it advances 1 linespace below the longest -column (see above) PLUS the distance specified by the argumemnt. +column (see above) PLUS the distance specified by the argument. The argument requires a unit of measure; therefore, to advance an extra 6 points below where <strong>MCX</strong> would normally place you, you'd enter @@ -3252,7 +3241,7 @@ macro, like this: The above advances to precisely 24 points below the baseline of the longest column. -<br> +<p> <hr> <!====================================================================> @@ -3269,7 +3258,7 @@ provides temporary left indents (i.e. only one line is indented, as at the start of a paragraph) and "hanging" left indents (the reverse of a temporary indent; the first line isn't indented, subsequent lines are). - +<p> <a name="INDENTS_TUT"><h3><u>A brief explanation of how mom handles indents</u></h3></a> <p> <strong>Mom</strong> provides five kinds of indents: left, right, @@ -3402,7 +3391,7 @@ picas and control each separately, as in the following example. More text \"Text is still indented 4 picas left </pre> -If, at <kbd>.IRX</kbd>, you wanted the text afterward to have no +If, at <kbd>.IRX</kbd>, you wanted the text afterwards to have no indents (either left or right), you would enter <kbd>.IQ</kbd>, which exits all indent styles at once. <p> @@ -3417,9 +3406,9 @@ at which they excel. <p> <strong>NOTE:</strong> see the section <a href="typemacdoc.html#TYPESETTING">Typesetting Macros in Document Processing</a> -for information and advice on using idents with the +for information and advice on using indents with the <a href="docprocessing.html#DOCPROCESSING">document processing macros</a>. - +<p> <a name="INDEX_INDENTS"><h3><u>Indents macro list</u></h3> <ul> <li><a href="#IL">IL</a> (Indent left) @@ -3476,8 +3465,8 @@ for more details. automatically cancels any active indents. <p> <strong>ADDITIONAL NOTE:</strong> Invoking <strong>IL</strong> -automtically turns off <strong>IB</strong>. -<br> +automatically turns off <strong>IB</strong>. +<p> <!---IR---> @@ -3497,7 +3486,7 @@ measure. Subsequent invocations with a measure add to the previous indent measure. A minus sign may be prepended to the argument to subtract from the current indent measure. The <a href="inlines.html#INLINE_STRINGWIDTH_GROFF">\w</a> -<a href="definitions.html#TERMS_INLINES">inline esacpe</a> +<a href="definitions.html#TERMS_INLINES">inline escape</a> may be used to specify a text-dependent measure, in which case no unit of measure is required. For example, <p> @@ -3517,8 +3506,8 @@ for more details. automatically cancels any active indents. <p> <strong>ADDITIONAL NOTE:</strong> Invoking <strong>IR</strong> -automtically turns off <strong>IB</strong>. -<br> +automatically turns off <strong>IB</strong>. +<p> <!---IB---> @@ -3548,12 +3537,12 @@ save yourself a lot of grief. A minus sign may be prepended to the arguments to subtract from their current values. The <a href="inlines.html#INLINE_STRINGWIDTH_GROFF">\w</a> -<a href="definitions.html#TERMS_INLINES">inline esacpe</a> +<a href="definitions.html#TERMS_INLINES">inline escape</a> may be used to specify text-dependent measures, in which case no unit of measure is required. For example, <p> <pre> - .IB \w'margaraine' \w'jello' + .IB \w'margarine' \w'jello' </pre> left indents text by the width of the word "margarine" @@ -3569,9 +3558,9 @@ for more details. automatically cancels any active indents. <p> <strong>ADDITIONAL NOTE:</strong> Invoking <strong>IB</strong> -automtically turns off <strong>IL</strong> and +automatically turns off <strong>IL</strong> and <strong>IR</strong>. -<br> +<p> <!---TI---> @@ -3584,7 +3573,7 @@ Macro: <strong>TI</strong> <var>[ <measure> ]</var> <p> A temporary indent is one that applies only to the first line of -text that comes after it. It's chief use is indenting the first +text that comes after it. Its chief use is indenting the first line of paragraphs. (<strong>Mom</strong>'s <a href="docprocessing.html#PP">PP</a> macro, for example, uses a temporary indent.) @@ -3668,10 +3657,15 @@ prior to the line you want hung (i.e. without any intervening <a href="definitions.html#TERMS_CONTROLLINES">control lines</a>). And because hanging indents affect only one line, there's no need to turn them off. - +<p> <a name="NUM_LISTS"><h3><u>A recipe for numbered lists</u></h3></a> <p> -A common use for hanging indents is setting numbered lists. +<strong>PLEASE NOTE: mom</strong> now has macros for setting lists (see +<a href="docelement.html#LIST_INTRO">Nested lists</a>), +making this recipe superfluous. It remains here in the hope that +it will clarify the use of hanging indents generally, if no longer +specifically. +<p> Consider the following example: <p> <pre> @@ -3707,7 +3701,7 @@ of 2 plus a period (using the <a href="inlines.html#INLINE_STRINGWIDTH_GROFF">\w</a> inline escape). At this point, the left indent is active; text -afterward would normally be indented. However, we invoke a hanging +afterwards would normally be indented. However, we invoke a hanging indent of exactly the same width, which hangs the first line (and first line only!) to the left of the indent by the same distance (in this case, that means "out to the left margin"). @@ -3726,7 +3720,7 @@ Paste the example above into a file and preview it with <kbd>groff -mom -X <strong>IB</strong>, measures given to <strong>HI</strong> are NOT additive. Each time you pass a measure to <strong>HI</strong>, the measure is treated literally. -<br> +<p> <!---IX---> diff --git a/contrib/mom/momdoc/using.html b/contrib/mom/momdoc/using.html index 327e86ba..a2f65a64 100644 --- a/contrib/mom/momdoc/using.html +++ b/contrib/mom/momdoc/using.html @@ -10,7 +10,7 @@ <a href="typesetting.html#TOP">Next</a> <a href="definitions.html#TOP">Prev</a> <a href="toc.html">Back to Table of Contents</a> - +<p> <a name="TOP"></a> <a name="USING"> <h1 align="center"><u>USING MOM</u></h1> @@ -23,7 +23,7 @@ <a href="#USING_INVOKING">Invoking groff</a> <br> <a href="#USING_PREVIEWING">Previewing documents</a> -<br> +<p> <hr> <h2><a name="USING_INTRO"><u>Introduction</u></a></h2> @@ -50,7 +50,7 @@ nearly complete control over the look and feel of your documents. In addition, the typesetting macros, in combination with document processing, let you meet all sorts of typesetting needs that just can't be covered by "one macro fits all" markup tags. - +<p> <a name="USING_MACROS"> <h2><u>How to input mom's macros</u></h2> </a> @@ -67,9 +67,9 @@ following apply. rules for <strong>mom</strong>'s macros and <a href="definitions.html#TERMS_INLINES">inline escapes</a>. I use the vi clone called elvis, and find it a pure - joy in this regard. Simply colorizing macros and + joy in this regard. Simply colourizing macros and inlines to half-intensity can be enough to make text stand - out clearly from formattting commands. + out clearly from formatting commands. <li>All <strong>mom</strong>'s macros begin with a period (dot) and must be entered in upper case (capital) letters. @@ -120,12 +120,12 @@ Consider the following, which is a template for starting the chapter of a book. <p> <pre> - .TITLE "My Pulizter Novel" + .TITLE "My Pulitzer Novel" .AUTHOR "Joe Blow" .CHAPTER 1 \# .DOCTYPE CHAPTER - .PRINTSTYPE TYPESET + .PRINTSTYLE TYPESET \# .FAM P .PT_SIZE 10 @@ -171,7 +171,7 @@ option along with the other options you require. Theoretically, you only need <code>-U</code> with <code>.open, .opena, .pso, .sy,</code> and <code>.pi</code>, however reality seems, at times, to dictate otherwise. - +<p> <a name="USING_PREVIEWING"> <h2><u>How to preview documents</u></h2> </a> diff --git a/contrib/mom/om.tmac b/contrib/mom/om.tmac index 754565b1..bcbccccc 100644 --- a/contrib/mom/om.tmac +++ b/contrib/mom/om.tmac @@ -23,8 +23,8 @@ .\" .\" .\" -\# Version 1.1.7 -\# ------------- +\# Version 1.1.7-1 +\# --------------- \# .if (\n[.x]\n[.y] < 118) \ . ab You need GNU troff version 1.18 or higher to run this version of mom! @@ -55,7 +55,6 @@ .ALIAS PAGELENGTH pl .ALIAS NEWPAGE bp .ALIAS SPREAD brp -.ALIAS STRING ds .ALIAS ESC_CHAR ec \# \# ALIASES FOR NUMBER REGISTERS @@ -84,9 +83,9 @@ \# *Arguments: \# none \# *Function: -\# The .em macro executed at the end of letters. Turns footers and -\# pagination off, terminates and outputs diversion CLOSING, indented with -\# the author's name underneath. +\# The .em macro executed at the end of letters. Turns footers +\# and pagination off, terminates and outputs diversion CLOSING +\# (indented with the author's name underneath). \# .MAC ALL_DONE END . br @@ -121,7 +120,7 @@ \# PAGE WIDTH \# ---------- \# *Argument: -\# <width of printer sheet (ipPc)> +\# <width of printer sheet> \# *Function: \# Stores user supplied page width in register #PAGE_WIDTH. \# *Notes: @@ -139,7 +138,7 @@ \# L_MARGIN \# -------- \# *Argument: -\# <offset from page left (ipPc)> +\# <offset from page left> \# *Function: \# Stores user supplied page offset in register #L_MARGIN. \# Sets .po to user supplied offset. @@ -156,7 +155,7 @@ \# R_MARGIN \# -------- \# *Argument: -\# <width of right margin (ipPc)> +\# <width of right margin> \# *Function: \# Stores user supplied right margin in register #R_MARGIN. \# *Notes: @@ -180,7 +179,7 @@ \# T_MARGIN \# -------- \# *Argument: -\# <distance to advance from top of page (ipPcv)> +\# <distance to advance from top of page> \# *Function: \# Stores the user supplied top margin in register #T_MARGIN. \# Advances user supplied depth from the top of the page. @@ -202,7 +201,7 @@ \# B_MARGIN \# -------- \# *Argument: -\# <space to leave at the bottom of the page (ipPcv)> +\# <space to leave at the bottom of the page> \# *Function: \# Stores the user supplied bottom margin in register #B_MARGIN. \# *Notes: @@ -289,7 +288,7 @@ \# LINE LENGTH \# ----------- \# *Argument: -\# <line length (iPpc)> +\# <line length> \# *Function: \# Stores user supplied line length in register #L_LENGTH. \# Sets .ll to #L_LENGTHu @@ -371,6 +370,8 @@ .END \# \# +\# SIZE (inline) +\# ------------- \# *Arguments: \# <point size of type> \# *Function: @@ -496,7 +497,7 @@ \# turned on. \# \# In groff v. 1.17.2, it was not possible to pass arguments to macros that -\# were executed with inline escapes, nor thence to evaluate conditional +\# were called with inline escapes, nor thence to evaluate conditional \# expressions. Consequently, each pseudo-escape \[BU<n>] had to be defined \# separately with ".char". \# @@ -510,88 +511,26 @@ .ds BU \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*\\$1u)' .ds FU \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*\\$1u)' \# -.ds BU1 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*1u)' -.ds BU2 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*2u)' -.ds BU3 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*3u)' -.ds BU4 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*4u)' -.ds BU5 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*5u)' -.ds BU6 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*6u)' -.ds BU7 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*7u)' -.ds BU8 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*8u)' -.ds BU9 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*9u)' -.ds BU10 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*10u)' -.ds BU11 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*11u)' -.ds BU12 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*12u)' -.ds BU13 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*13u)' -.ds BU14 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*14u)' -.ds BU15 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*15u)' -.ds BU16 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*16u)' -.ds BU17 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*17u)' -.ds BU18 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*18u)' -.ds BU19 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*19u)' -.ds BU20 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*20u)' -.ds BU21 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*21u)' -.ds BU22 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*22u)' -.ds BU23 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*23u)' -.ds BU24 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*24u)' -.ds BU25 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*25u)' -.ds BU26 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*26u)' -.ds BU27 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*27u)' -.ds BU28 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*28u)' -.ds BU29 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*29u)' -.ds BU30 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*30u)' -.ds BU31 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*31u)' -.ds BU32 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*32u)' -.ds BU33 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*33u)' -.ds BU34 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*34u)' -.ds BU35 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*35u)' -.ds BU36 \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*36u)' -\# -\# -.ds FU1 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*1u)' -.ds FU2 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*2u)' -.ds FU3 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*3u)' -.ds FU4 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*4u)' -.ds FU5 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*5u)' -.ds FU6 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*6u)' -.ds FU7 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*7u)' -.ds FU8 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*8u)' -.ds FU9 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*9u)' -.ds FU10 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*10u)' -.ds FU11 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*11u)' -.ds FU12 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*12u)' -.ds FU13 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*13u)' -.ds FU14 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*14u)' -.ds FU15 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*15u)' -.ds FU16 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*16u)' -.ds FU17 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*17u)' -.ds FU18 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*18u)' -.ds FU19 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*19u)' -.ds FU20 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*20u)' -.ds FU21 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*21u)' -.ds FU22 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*22u)' -.ds FU23 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*23u)' -.ds FU24 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*24u)' -.ds FU25 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*25u)' -.ds FU26 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*26u)' -.ds FU27 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*27u)' -.ds FU28 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*28u)' -.ds FU29 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*29u)' -.ds FU30 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*30u)' -.ds FU31 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*31u)' -.ds FU32 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*32u)' -.ds FU33 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*33u)' -.ds FU34 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*34u)' -.ds FU35 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*35u)' -.ds FU36 \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*36u)' +\# Initialize strings for pre-1.1.3c-style BU and FU +\# +.nr #LOOP 0 1 +.while \n+[#LOOP]<37 \{\ +. ds BU\n[#LOOP] \h'-(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*\n[#LOOP]u)' +.\} +\# +.nr #LOOP 0 1 +.while \n+[#LOOP]<37 \{\ +. ds FU\n[#LOOP] \h'(\En[#PT_SIZE]u/\n[#KERN_UNIT]u*\n[#LOOP]u)' +.\} +.rr #LOOP \# \# \# *Horizontal movements \# BP1...12.75 and FP1...12.75 move backwards or forwards inline by the \# specified number of points. -\# Left in for backward compatibility with mom-1.1.3c, the preferred -\# methods for inline horizontal movements are now \*[BCK #<unit>] and -\# \*[FWD #<unit>]. +\# Left in for backward compatibility with mom-1.1.3c, the +\# preferred methods for inline horizontal movements are now +\# \*[BCK <n><unit>] and \*[FWD <n><unit>]. \# .ds BCK \h'-\\$1\\$2' .ds FWD \h'\\$1\\$2' @@ -780,7 +719,7 @@ \# *Arguments: \# <none> | <anything> | DEFAULT \# or -\# LINES <#> | MARGIN <#> | SPACE <#> +\# LINES <n> | MARGIN <n> | SPACE <n> \# *Function: \# Turns auto hyphenation on or off, resets the hyphenation style \# to default, or permits the setting of various hyphenation @@ -795,9 +734,9 @@ \# above) if that behaviour is desired after changes have been \# made to LINES, MARGIN, or SPACE. \# -\# HY LINES <#> sets the number of allowable consecutive hyphenated lines. +\# HY LINES <n> sets the number of allowable consecutive hyphenated lines. \# -\# HY MARGIN <#> sets the amount of space (ipPcm) allowed at the end +\# HY MARGIN <n> sets the amount of space (ipPcm) allowed at the end \# of a line in QUAD mode before hyphenation is tripped (e.g. if there's \# only 6 points left, groff won't try to hyphenate the next word). \# @@ -864,7 +803,7 @@ \# Creates or modifies register #ALD. Adds user supplied lead \# below current baseline. \# *Notes: -\# Requires unit of measure ipPcmv. +\# Requires a unit of measure. \# .MAC ALD END . nr #ALD (\\$1) @@ -880,7 +819,7 @@ \# Creates or modifies register #RLD. Reverses user supplied \# lead above current baseline. \# *Notes: -\# Requires unit of measure ipPcmv. +\# Requires a unit of measure. \# .MAC RLD END . nr #RLD (\\$1) @@ -889,10 +828,11 @@ \# \# ALD/RLD STRINGS \# --------------- -\# The strings \*[ALD.25]...\*[ALD12.75] and their corresponding \*[RLD] -\# forms have been left in for backward compatibility with documents -\# created using mom-1.1.3c or earlier. The prefered methods of advancing -\# and reversing on the page inline are \*[UP #<unit>] and \*[DOWN #<unit>]. +\# The strings \*[ALD.25]...\*[ALD12.75] and their corresponding +\# \*[RLD] forms have been left in for backward compatibility with +\# documents created using mom-1.1.3c or earlier. The prefered +\# methods of advancing and reversing on the page inline are \*[UP <n><unit>] +\# and \*[DOWN <n><unit>]. \# .ds DOWN \v'\\$1\\$2' .ds UP \v'-\\$1\\$2' @@ -1015,7 +955,7 @@ \# Ligatures may be supplied manually with \(fi, \(fl, etc. \# .MAC LIGATURES END -. ie '\\$1'' \{\ +. ie '\\$1'' \{\ . lg . nr #LIGATURES 1 . \} @@ -1029,9 +969,12 @@ \# SMARTQUOTES \# ----------- \# *Arguments: -\# <none> | <anything> +\# [ ,, ] | [ << ] | [ >> ] | <anything> +\# or +\# [ DA | DE | EN | ES | FR | IT | NL | NO | PT | SV ] | <anything> \# *Function: -\# Turns smartquotes on or off. +\# Turns smartquotes on (optionally with a quoting style from the +\# argument list, or off). \# *Notes: \# The " character is read outside the macro when mom is \# processed. The strings for open/close ($QUOTE<n>) are then @@ -1056,24 +999,71 @@ . \} . if '\\$1'<<' \{\ . nr #ARGS_TO_SQ 1 -. ds $QUOTE0 \\[Fo]\\ -. ds $QUOTE1 \\ \\[Fc] +. ds $QUOTE0 \\[Fo] +. ds $QUOTE1 \\[Fc] . \} . if '\\$1'>>' \{\ . nr #ARGS_TO_SQ 1 -. ds $QUOTE0 \\[Fc]\\| -. ds $QUOTE1 \\|\\[Fo] +. ds $QUOTE0 \\[Fc] +. ds $QUOTE1 \\[Fo] +. \} +. if '\\$1'DA' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[Fc] +. ds $QUOTE1 \\[Fo] +. \} +. if '\\$1'DE' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[Bq] +. ds $QUOTE1 \\[lq] +. \} +. if '\\$1'ES' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[lq] +. ds $QUOTE1 \\[rq] +. \} +. if '\\$1'FR' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[Fo]\\| +. ds $QUOTE1 \\|\\[Fc] +. \} +. if '\\$1'IT' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[Fo]\\| +. ds $QUOTE1 \\|\\[Fc] +. \} +. if '\\$1'NL' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[rq] +. ds $QUOTE1 \\[rq] +. \} +. if '\\$1'NO' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[Fo] +. ds $QUOTE1 \\[Fc] +. \} +. if '\\$1'PT' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[Fo] +. ds $QUOTE1 \\[Fc] +. \} +. if '\\$1'SV' \{\ +. nr #ARGS_TO_SQ 1 +. ds $QUOTE0 \\[Fc] +. ds $QUOTE1 \\[Fc] . \} . if !r#ARGS_TO_SQ \{\ -. ds $QUOTE0 \\[dq] -. ds $QUOTE1 \\[dq] +. ds $QUOTE0 \\[dq] +. ds $QUOTE1 \\[dq] . \} . \} .END \# .ds $QUOTE0 \[dq] .ds $QUOTE1 \[dq] +\# \# Strings for foot and inch marks +\# .ds FOOT \(fm .ds INCH \(fm\(fm \# @@ -1110,9 +1100,9 @@ \# *Argument: \# <none> \# *Function: -\# Turns fill on and sets .ad to b. +\# Turns fill on and sets .ad to b. \# *Notes: -\# Justifies text left and right. +\# Justifies text left and right. \# .MAC JUSTIFY END . if \\n[#TAB_ACTIVE]=0 \{\ @@ -1191,6 +1181,7 @@ . ce 0 . nf . nr #FILL 1 +. if '\\n(.z'LETTERHEAD1' \{ .rr #DATE_FIRST \} .END \# \# @@ -1271,46 +1262,21 @@ \# Strings for string tab inlines \# ------------------------------ \# -.ds ST1 \Ek[#ST1_OFFSET] -.ds ST2 \Ek[#ST2_OFFSET] -.ds ST3 \Ek[#ST3_OFFSET] -.ds ST4 \Ek[#ST4_OFFSET] -.ds ST5 \Ek[#ST5_OFFSET] -.ds ST6 \Ek[#ST6_OFFSET] -.ds ST7 \Ek[#ST7_OFFSET] -.ds ST8 \Ek[#ST8_OFFSET] -.ds ST9 \Ek[#ST9_OFFSET] -.ds ST10 \Ek[#ST10_OFFSET] -.ds ST11 \Ek[#ST11_OFFSET] -.ds ST12 \Ek[#ST12_OFFSET] -.ds ST13 \Ek[#ST13_OFFSET] -.ds ST14 \Ek[#ST14_OFFSET] -.ds ST15 \Ek[#ST15_OFFSET] -.ds ST16 \Ek[#ST16_OFFSET] -.ds ST17 \Ek[#ST17_OFFSET] -.ds ST18 \Ek[#ST18_OFFSET] -.ds ST19 \Ek[#ST19_OFFSET] -\# -.ds ST1X \Ek[#ST1_MARK] -.ds ST2X \Ek[#ST2_MARK] -.ds ST3X \Ek[#ST3_MARK] -.ds ST4X \Ek[#ST4_MARK] -.ds ST5X \Ek[#ST5_MARK] -.ds ST6X \Ek[#ST6_MARK] -.ds ST7X \Ek[#ST7_MARK] -.ds ST8X \Ek[#ST8_MARK] -.ds ST9X \Ek[#ST9_MARK] -.ds ST10X \Ek[#ST10_MARK] -.ds ST11X \Ek[#ST11_MARK] -.ds ST12X \Ek[#ST12_MARK] -.ds ST13X \Ek[#ST13_MARK] -.ds ST14X \Ek[#ST14_MARK] -.ds ST15X \Ek[#ST15_MARK] -.ds ST16X \Ek[#ST16_MARK] -.ds ST17X \Ek[#ST17_MARK] -.ds ST18X \Ek[#ST18_MARK] -.ds ST19X \Ek[#ST19_MARK] -\# Reserved ST numbers for internal use +\# Initialize string tab markers numbered 1 to 19. +\# +.nr #LOOP 0 1 +.while \n+[#LOOP]<20 \{\ +. ds ST\n[#LOOP] \Ek[#ST\n[#LOOP]_OFFSET] +.\} +\# +.nr #LOOP 0 1 +.while \n+[#LOOP]<20 \{\ +. ds ST\n[#LOOP]X \Ek[#ST\n[#LOOP]_MARK] +.\} +.rr #LOOP +\# +\# +\# These are reserved ST numbers for internal use .ds ST100 \Ek[#ST100_OFFSET] .ds ST100X \Ek[#ST100_MARK] .ds ST101 \Ek[#ST101_OFFSET] @@ -1348,7 +1314,7 @@ \# TAB SET \# ------- \# *Arguments: -\# <#> ident(ipPcm) length(ipPcm) [L | R | C | J [QUAD]] +\# <n> ident(ipPcm) length(ipPcm) [L | R | C | J [QUAD]] \# *Function: \# Creates macros TABn and TAB n, where "n" is any arbitrary number. \# TABn is a typesetting tab (i.e. a tab defined as an indent @@ -1390,12 +1356,12 @@ \# \# If you want tabs to line up bottom-line to bottom-line (most likely \# single line tabs), use .TN (provided the tabs are numbered sequentially). -\# Otherwise, you must use .EL then .TAB # if you want them to align. +\# Otherwise, you must use .EL then .TAB <n> if you want them to align. \# \# If you want to reset tabs, you must use .TQ before .TAB_SET. \# \# Note that indents are turned off automatically whenever a new -\# tab is called with TAB n. +\# tab is called with TAB <n>. \# \# Tabs themselves are user-invoked using the TAB macro with a numeric \# argument, e.g. TAB 1. @@ -2260,7 +2226,6 @@ . ds $DROPCAP \\$1 . nr #DC_LINES \\$2-1 . ds $RESTORE_COND \\*[$COND_PERCENT] -. ds $RESTORE_EXT \\*[$EXT_PERCENT] . if '\\$3'COND' \{ .CONDENSE \\$4 \} . if '\\$3'EXT' \{ .EXTEND \\$4 \} . if !r#DC_GUT \{ .nr #DC_GUT (3p) \} @@ -2421,11 +2386,12 @@ \# .IR means "indent right," and so on. \# \# The first time any of the indent macros is used, it requires an -\# argument--the size of the indent in ipPcm. The size may also -\# be entered using the \w'#' function--very useful for numbered -\# lists using HI). The unit of measure is required. Subsequent -\# invocations don't require the argument; the indent measure remains the -\# same until it's changed by invoking the macro with an argument again. +\# argument--the size of the indent (with a unit of measure). The +\# size may also be entered using the \w escape--very useful +\# for numbered lists using HI. The unit of measure is required. +\# Subsequent invocations don't require the argument; the indent +\# measure remains the same until it's changed by invoking the macro +\# with an argument again. \# \# If no indents are in effect, the arguments passed to indent macros are \# measured from the left and right margins of the page. If a left indent @@ -2435,7 +2401,7 @@ \# to it, its value will be the value last in effect, unless you pass \# it an argument. If you do pass an argument, it is added to the last \# value in effect, unless you cleared the indent with one of -\# .I<LRB>X macros. +\# .I<LRB>X/Q macros. \# \# Example \# ------- @@ -3420,7 +3386,7 @@ y\\R'#DESCENDER \\n[.cdp]' \\*[$CHAPTER_STRING] \\*[$CHAPTER], \ \\*[$REVISION_STRING] \\*[$REVISION] . \} -. el \{ +. el \{\ . ds $HDRFTR_CENTER \ \\*[$CHAPTER_STRING] \\*[$CHAPTER], \ \\*[$DRAFT_STRING]\\*[$DRAFT], \ @@ -3620,17 +3586,29 @@ y\\R'#DESCENDER \\n[.cdp]' \# \# +++LETTER MACROS+++ \# +\# First, create a register to hold incrementing numbers to be +\# appended to LETTERHEAD. +\# +.nr #FIELD 0 1 +\# \# DATE \# ---- \# *Arguments: -\# <date string> +\# <none> \# *Function: -\# Stores date string in string $DATE. +\# Stores date (entered on the line after .DATE) in diversion +\# LETTERHEAD<n> \# .MAC DATE END -. nr #DATE 1 -. di DATE -. RIGHT +. if !'\\n(.z'' \{ .di \} +. di LETTERHEAD\\n+[#FIELD] +. ie \\n[#FIELD]=1 \{\ +. nr #DATE_FIRST 1 +. RIGHT +. \} +. el \{\ +. LEFT +. \} .END \# \# @@ -3639,12 +3617,12 @@ y\\R'#DESCENDER \\n[.cdp]' \# *Arguments: \# <none> \# *Function: -\# Stores "to" info in diversion TO_ADDRESS. +\# Stores addressee address (entered on the line after .TO) in +\# diversion LETTERHEAD<n> \# .MAC TO END . if !'\\n(.z'' \{ .di \} -. nr #TO 1 -. di TO_ADDRESS +. di LETTERHEAD\\n+[#FIELD] . LEFT .END \# @@ -3654,12 +3632,12 @@ y\\R'#DESCENDER \\n[.cdp]' \# *Arguments: \# <none> \# *Function: -\# Stores "from" info in diversion FROM_ADDRESS. +\# Stores addresser address (entered on the line after .FROM) in +\# diversion LETTERHEAD<n> \# .MAC FROM END . if !'\\n(.z'' \{ .di \} -. nr #FROM 1 -. di FROM_ADDRESS +. di LETTERHEAD\\n+[#FIELD] . LEFT .END \# @@ -3667,14 +3645,14 @@ y\\R'#DESCENDER \\n[.cdp]' \# GREETING \# -------- \# *Arguments: -\# <greeting string> +\# <none> \# *Function: -\# Stores greeting in string $GREETING. +\# Stores greeting (entered on the line after .GREETING) in +\# diversion LETTERHEAD<n> \# .MAC GREETING END . if !'\\n(.z'' \{ .di \} -. nr #GREETING 1 -. di GREETING +. di LETTERHEAD\\n+[#FIELD] . LEFT .END \# @@ -3684,7 +3662,7 @@ y\\R'#DESCENDER \\n[.cdp]' \# *Arguments: \# <closing string> \# *Function: -\# Stores greeting in string $CLOSING. +\# Stores greeting in diversion CLOSING. \# .MAC CLOSING END . br @@ -4286,7 +4264,11 @@ y\\R'#DESCENDER \\n[.cdp]' . if \\n[#DOC_TYPE]=4 \{\ . if !'\\n(.z'' \{ .di \} . \} +. nr #STORED_PP_INDENT \\n[#PP_INDENT] +. PARA_INDENT 0 . PP +. PARA_INDENT \\n[#STORED_PP_INDENT]u +. rr #STORED_PP_INDENT . ie r#ADVANCE_FROM_TOP \{\ . sp |\\n[#ADVANCE_FROM_TOP]u-1v . SHIM @@ -4465,8 +4447,8 @@ y\\R'#DESCENDER \\n[.cdp]' . ie \\n[#SINGLE_SPACE] \{ .RLD \\n[#DOC_LEAD]u \} . el \{ .ALD \\n[#DOC_LEAD]u/2u \} . \} -. \} . vs \\n[#DOC_LEAD]u +. \} . el \{\ . ie !d$SUBTITLE \{\ . ie \\n[#SINGLE_SPACE] \{ .RLD \\n[#DOC_LEAD]u*2u \} @@ -4959,11 +4941,33 @@ y\\R'#DESCENDER \\n[.cdp]' \# perfectly flush bottom margins. Any time SHIM is used, it \# ensures that the next output line falls on a legal baseline. \# +\# First, a little convenience macro +\# +.MAC PROCESS_SHIM END +. while \\n+[#LEGAL_BASELINE]<\\n[#CURRENT_V_POS] \{\ +. +. \} +. nr #SHIM \\n[#LEGAL_BASELINE]-\\n[#CURRENT_V_POS] +.END +\# .MAC SHIM END . nr #CURRENT_V_POS \\n(.d -. nr #LEGAL_BASELINE \\n[#T_MARGIN] \\n[#DOC_LEAD] -. while \\n+[#LEGAL_BASELINE]<\\n[#CURRENT_V_POS] \{ . \} -. nr #SHIM \\n[#LEGAL_BASELINE]-\\n[#CURRENT_V_POS] +. nr #LEGAL_BASELINE \\n[#T_MARGIN]-1v \\n[#DOC_LEAD] +. ie r#ADVANCE_FROM_TOP \{\ +. ie \\n[#CURRENT_V_POS]<(\\n[#T_MARGIN]-1v) \{\ +. while \\n-[#LEGAL_BASELINE]>\\n[#CURRENT_V_POS] \{\ +. +. \} +. nr #LEGAL_BASELINE +\\n[#DOC_LEAD] +. nr #SHIM \\n[#LEGAL_BASELINE]-\\n[#CURRENT_V_POS] +. \} +. el \{\ +. PROCESS_SHIM +. \} +. \} +. el \{\ +. PROCESS_SHIM +. \} . ALD \\n[#SHIM]u .END \# @@ -5323,7 +5327,9 @@ y\\R'#DESCENDER \\n[.cdp]' . nr #EPI_LINES \\n[#EPI_DEPTH]/\\n[#EPI_LEAD] . ie \\n[#START] \{\ . nr #EPI_WHITESPACE (\\n[#DOC_LEAD]*\\n[#EPI_LINES])-\\n[#EPI_DEPTH] -. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{ .nr #EPI_WHITESPACE -\\n[#DOC_LEAD] \} +. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{\ +. nr #EPI_WHITESPACE -\\n[#DOC_LEAD] +. \} . if \\n[#PRINT_STYLE]=2 \{\ . RLD \\n[#DOC_LEAD]u . if \\n[#EPI_WHITESPACE]<\\n[#DOC_LEAD] \{\ @@ -5338,7 +5344,9 @@ y\\R'#DESCENDER \\n[.cdp]' . ie \\n[#EPI_DEPTH]<\\n[#TRAP_DISTANCE] \{\ . nr #EPI_FITS 1 . nr #EPI_WHITESPACE (\\n[#DOC_LEAD]*\\n[#EPI_LINES])-\\n[#EPI_DEPTH] -. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{ .nr #EPI_WHITESPACE -\\n[#DOC_LEAD] \} +. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{\ +. nr #EPI_WHITESPACE -\\n[#DOC_LEAD] +. \} . ie \\n[#PRINT_STYLE]=1 \{\ . if \\n[#EPI_WHITESPACE]=\\n[#DOC_LEAD] \{ .ALD \\n[#EPI_WHITESPACE]u/2u \} . \} @@ -5353,10 +5361,14 @@ y\\R'#DESCENDER \\n[.cdp]' . \} . el \{\ . nr #EPI_LINES_TO_TRAP 0 1 -. while \\n[#EPI_LEAD]*\\n+[#EPI_LINES_TO_TRAP]<\\n[#TRAP_DISTANCE] \{ .nr #LOOP 1 \} +. while \\n[#EPI_LEAD]*\\n+[#EPI_LINES_TO_TRAP]<\\n[#TRAP_DISTANCE] \{\ +. nr #LOOP 1 +. \} . nr #EPI_LINES_TO_TRAP -1 . nr #EPI_WHITESPACE (\\n[#EPI_LINES_TO_TRAP]*\\n[#DOC_LEAD])-(\\n[#EPI_LINES_TO_TRAP]*\\n[#EPI_LEAD]) -. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{ .nr #EPI_WHITESPACE -\\n[#DOC_LEAD] \} +. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{\ +. nr #EPI_WHITESPACE -\\n[#DOC_LEAD] +. \} . if \\n[#EPI_WHITESPACE]<\\n[#DOC_LEAD] \{ .ALD \\n[#EPI_WHITESPACE]u \} . if \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{ .ALD \\n[#EPI_WHITESPACE]u-\\n[#DOC_LEAD]u \} . \} @@ -5398,7 +5410,9 @@ y\\R'#DESCENDER \\n[.cdp]' . ie \\n[#FN_FOR_EPI] \{\ . nr #EPI_LINES_TO_END 1 . nr #EPI_WHITESPACE (\\n[#EPI_LINES_TO_END]*\\n[#DOC_LEAD])-(\\n[#EPI_LINES_TO_END]*\\n[#EPI_LEAD]) -. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{ .nr #EPI_WHITESPACE -\\n[#DOC_LEAD] \} +. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{\ +. nr #EPI_WHITESPACE -\\n[#DOC_LEAD] +. \} . ALD \\n[#EPI_WHITESPACE]u-(\\n[#DOC_LEAD]u-\\n[#EPI_LEAD]u) . \} . el \{\ @@ -5420,7 +5434,9 @@ y\\R'#DESCENDER \\n[.cdp]' . if \\n[#LOOP] \{. nr #EPI_LINES_TO_END +1 \} . rr #LOOP . nr #EPI_WHITESPACE (\\n[#EPI_LINES_TO_END]*\\n[#DOC_LEAD])-(\\n[#EPI_LINES_TO_END]*\\n[#EPI_LEAD]) -. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{ .nr #EPI_WHITESPACE -\\n[#DOC_LEAD] \} +. while \\n[#EPI_WHITESPACE]>\\n[#DOC_LEAD] \{\ +. nr #EPI_WHITESPACE -\\n[#DOC_LEAD] +. \} . ALD \\n[#EPI_WHITESPACE]u-(\\n[#DOC_LEAD]u-\\n[#EPI_LEAD]u) . if \\n[#PRINT_STYLE]=1 \{\ . if !\\n[#SINGLE_SPACE] \{\ @@ -6252,14 +6268,14 @@ y\\R'#DESCENDER \\n[.cdp]' . if \\n[#USERDEF_HDRFTR_VERSO_QUAD]=1 \{ .LEFT \} . if \\n[#USERDEF_HDRFTR_VERSO_QUAD]=2 \{ .CENTER \} . if \\n[#USERDEF_HDRFTR_VERSO_QUAD]=3 \{ .RIGHT \} -. \} -. PRINT \\*[$USERDEF_HDRFTR_VERSO] -. EL -. if \\n[#FOOTERS_ON] \{\ -. di NULL -. SIZESPECS -. nr #HDRFTR_HEIGHT \\n[#CAP_HEIGHT] -. di +. PRINT \\*[$USERDEF_HDRFTR_VERSO] +. EL +. if \\n[#FOOTERS_ON] \{\ +. di NULL +. SIZESPECS +. nr #HDRFTR_HEIGHT \\n[#CAP_HEIGHT] +. di +. \} . \} . el \{\ . if \\n[#USERDEF_HDRFTR_RECTO_QUAD]=1 \{ .LEFT \} @@ -7758,30 +7774,22 @@ y\\R'#DESCENDER \\n[.cdp]' . br . if \\n[#DOC_TYPE]=4 \{\ . if !'\\n(.z'' \{ .di \} -. if \\n[#DATE] \{\ -. nf -. DATE -. QUAD \\*[$DOC_QUAD] -. ALD \\n[#DOC_LEAD]u*2u -. rr #DATE -. \} -. if \\n[#TO] \{\ -. nf -. TO_ADDRESS -. ALD \\n[#DOC_LEAD]u -. rr #TO -. \} -. if \\n[#FROM] \{\ -. nf -. FROM_ADDRESS -. ALD \\n[#DOC_LEAD]u -. rr #FROM -. \} -. if \\n[#GREETING] \{\ -. nf -. GREETING -. ALD \\n[#DOC_LEAD]u -. rr #GREETING +. nr #TOTAL_FIELDS \\n[#FIELD] +. nr #FIELD 0 1 +. nr #NUM_FIELDS 0 1 +. if \\n[#TOTAL_FIELDS]>0 \{\ +. while \\n+[#NUM_FIELDS]<=\\n[#TOTAL_FIELDS] \{\ +. nf +. LETTERHEAD\\n+[#FIELD] +. QUAD \\*[$DOC_QUAD] +. ALD \\n[#DOC_LEAD]u +. if \\n[#DATE_FIRST]=1 \{ .ALD \\n[#DOC_LEAD]u \} +. rr #DATE_FIRST +. rm LETTERHEAD\\n[#FIELD] +. \} +. rr #FIELD +. rr #NUM_FIELDS +. rr #TOTAL_FIELDS . \} . \} . rr #PP_ACTIVE @@ -8990,8 +8998,8 @@ y\\R'#DESCENDER \\n[.cdp]' . if \\n[#PRINT_STYLE]=1 \{ .PRINT "(\\n[#FN_NUMBER])\c" \} . if \\n[#PRINT_STYLE]=2 \{ .PRINT "\*[SUP]\\n[#FN_NUMBER]\*[SUPX]\c" \} . \} -. \} -. \} +. \} +. \} . \} . el \{\ . ie '\\$1'INDENT' \{\ @@ -9047,16 +9055,16 @@ y\\R'#DESCENDER \\n[.cdp]' . \} . nr #VARIABLE_FOOTER_POS -\\n[#DIVER_DEPTH] . if \\n[#FN_COUNT]=1 \{ .nr #VARIABLE_FOOTER_POS -1v \} -. \} +. \} +. ch FOOTER \\n[#VARIABLE_FOOTER_POS]u +. if (\\n(nl+1v)>(\\n[#PAGE_LENGTH]+\\n[#VARIABLE_FOOTER_POS]) \{\ +. ch FOOTER \\n(nlu+1v +. \} +. if \\n[#FN_DEFER] \{\ +. nr #VARIABLE_FOOTER_POS 0-\\n[#B_MARGIN]u . ch FOOTER \\n[#VARIABLE_FOOTER_POS]u -. if (\\n(nl+1v)>(\\n[#PAGE_LENGTH]+\\n[#VARIABLE_FOOTER_POS]) \{\ -. ch FOOTER \\n(nlu+1v -. \} -. if \\n[#FN_DEFER] \{\ -. nr #VARIABLE_FOOTER_POS 0-\\n[#B_MARGIN]u -. ch FOOTER \\n[#VARIABLE_FOOTER_POS]u -. \} . \} +. \} . nr #NO_FN_MARKER 0 .END \# @@ -10629,7 +10637,7 @@ y\\R'#DESCENDER \\n[.cdp]' \# LIST \# ---- \# *Arguments: -\# [ BULLET | DASH | DIGIT | ALPHA | USER ] [ <separator> ] [ <off> ] +\# [ BULLET | DASH | DIGIT | ALPHA | USER ] [ <separator> ] [ <anything> ] \# *Function: \# Stores indent information in effect prior to invocation and \# initializes a list with the supplied enumerator (and separator). @@ -10640,7 +10648,7 @@ y\\R'#DESCENDER \\n[.cdp]' \# right of another list, every time, unless the default bullet is \# desired. \# -\# <off> moves back one list level intuitively, or exits lists +\# <anything> moves back one list level intuitively, or exits lists \# completely if the level at which it's invoked is the first. \# .MAC LIST END @@ -11106,9 +11114,13 @@ y\\R'#DESCENDER \\n[.cdp]' . nr #LINES_PER_PAGE 0 1 . nr #DOC_LEAD_ADJ 0 1 . nr #DEPTH_TO_B_MARGIN \\n[#PAGE_LENGTH]-\\n[#B_MARGIN]-1v -. while \\n[#T_MARGIN]+(\\n[#DOC_LEAD]*\\n+[#LINES_PER_PAGE])<\\n[#DEPTH_TO_B_MARGIN] \{ . \} +. while \\n[#T_MARGIN]+(\\n[#DOC_LEAD]*\\n+[#LINES_PER_PAGE])<\\n[#DEPTH_TO_B_MARGIN] \{\ +. +. \} . nr #LINES_PER_PAGE -1 -. while \\n[#T_MARGIN]+(\\n[#DOC_LEAD]+\\n+[#DOC_LEAD_ADJ]*\\n[#LINES_PER_PAGE])<\\n[#DEPTH_TO_B_MARGIN] \{ . \} +. while \\n[#T_MARGIN]+(\\n[#DOC_LEAD]+\\n+[#DOC_LEAD_ADJ]*\\n[#LINES_PER_PAGE])<\\n[#DEPTH_TO_B_MARGIN] \{\ +. +. \} . DOC_LEAD \\n[#DOC_LEAD]u+\\n[#DOC_LEAD_ADJ]u . \} \# *...or calculate new B_MARGIN based on # of lines (at #DOC_LEAD) that fit @@ -11116,7 +11128,9 @@ y\\R'#DESCENDER \\n[.cdp]' . el \{\ . nr #LINES_PER_PAGE 0 1 . nr #DEPTH_TO_B_MARGIN \\n[#PAGE_LENGTH]-\\n[#B_MARGIN]-1v -. while \\n[#T_MARGIN]+(\\n[#DOC_LEAD]*\\n+[#LINES_PER_PAGE])<\\n[#DEPTH_TO_B_MARGIN] \{ . \} +. while \\n[#T_MARGIN]+(\\n[#DOC_LEAD]*\\n+[#LINES_PER_PAGE])<\\n[#DEPTH_TO_B_MARGIN] \{\ +. +. \} . nr #B_MARGIN \\n[#PAGE_LENGTH]-(\\n[#T_MARGIN]+(\\n[#DOC_LEAD]*\\n[#LINES_PER_PAGE])) . \} \# *Set footer and footnote overflow traps |