[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: mom 2.5: general doc cleanup
From: |
Peter Schaffter |
Subject: |
[groff] 01/01: mom 2.5: general doc cleanup |
Date: |
Mon, 4 Oct 2021 15:17:26 -0400 (EDT) |
PTPi pushed a commit to branch master
in repository groff.
commit dc00e88a59bfe92bb705c40b91c007deca45335f
Author: Peter Schaffter <peter@schaffter.ca>
AuthorDate: Mon Oct 4 15:11:32 2021 -0400
mom 2.5: general doc cleanup
Update toc.html and macrolist.html for BOX and PAGE_COLOR.
Correct spelling, typos, thinkos.
Harmonise e.g. and i.e.; both get two periods, comma
afterwards only if what follows is a subordinate clause.
Standardise colour/color. "Colour" is used in text, "color" is used
for macro names, arguments, and X-color.
---
contrib/mom/momdoc/appendices.html | 16 +-
contrib/mom/momdoc/color.html | 25 ++--
contrib/mom/momdoc/cover.html | 6 +-
contrib/mom/momdoc/definitions.html | 40 ++---
contrib/mom/momdoc/docelement.html | 190 ++++++++++++------------
contrib/mom/momdoc/docprocessing.html | 107 +++++++-------
contrib/mom/momdoc/goodies.html | 34 +++--
contrib/mom/momdoc/graphical.html | 226 ++++++++++++++++++-----------
contrib/mom/momdoc/headfootpage.html | 44 +++---
contrib/mom/momdoc/inlines.html | 28 ++--
contrib/mom/momdoc/intro.html | 12 +-
contrib/mom/momdoc/letters.html | 8 +-
contrib/mom/momdoc/macrolist.html | 17 ++-
contrib/mom/momdoc/rectoverso.html | 8 +-
contrib/mom/momdoc/refer.html | 35 ++---
contrib/mom/momdoc/tables-of-contents.html | 20 +--
contrib/mom/momdoc/toc.html | 94 +++++++-----
contrib/mom/momdoc/typesetting.html | 52 +++----
contrib/mom/momdoc/using.html | 13 +-
contrib/mom/momdoc/version-2.html | 29 ++--
20 files changed, 551 insertions(+), 453 deletions(-)
diff --git a/contrib/mom/momdoc/appendices.html
b/contrib/mom/momdoc/appendices.html
index 9bdab31..70f9556 100644
--- a/contrib/mom/momdoc/appendices.html
+++ b/contrib/mom/momdoc/appendices.html
@@ -439,7 +439,7 @@ possibilities, merely one.
<p>
GNU/Linux distributions being what they are, directory locations
-may differ and the presence of some executables can’t be
+may differ and the presence of some executable can’t be
guaranteed. I run a Debian-based system. The instructions reflect
that. Users of other distros may have to interpret them according
to the way their distro operates.
@@ -636,7 +636,7 @@ of the form
<span class="pre-in-pp">
internalname <name>
</span>
-Usually, the internal name is helpfully descriptive, e.g.,
+Usually, the internal name is helpfully descriptive, e.g.
<br/>
<span class="pre-in-pp">
internalname Optima-Bold
@@ -833,23 +833,13 @@ helpful to everyone, groff newbies and old hands alike.
Mom’s macro file, om.tmac, uses long names, aliases, and a
host of other groff goodies that have become part of the whole groff
picture. The function of nearly every macro, number register and
-string can be infered simply from its name. The file is heavily
+string can be inferred simply from 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 mom’s macros should be able to do so with a
minimum of head scratching.
</p>
-<div class="box-tip">
-<p class="tip">
-<span class="note">Note:</span>
-The main macro file, <strong>om.tmac</strong>, is stripped of
-comments when groff is built from sources. <strong>om.tmac</strong>,
-in the sources themselves, still contains the comments, as do the
-tarballs posted on mom’s homepage.
-</p>
-</div>
-
<div class="rule-medium"><hr/></div>
<!-- ===================================================================== -->
diff --git a/contrib/mom/momdoc/color.html b/contrib/mom/momdoc/color.html
index 020a36c..debb6a4 100644
--- a/contrib/mom/momdoc/color.html
+++ b/contrib/mom/momdoc/color.html
@@ -51,15 +51,15 @@ FDL in the main directory of the groff source package.
<p>
Mom’s support for coloured text is straightforward. You begin
by telling mom about the colours you want with
-<kbd><a href="#newcolor">NEWCOLOR</a></kbd>
+<a href="#newcolor">NEWCOLOR</a>
or
-<kbd><a href="#xcolor">XCOLOR</a></kbd>.
-Afterward, any time you want text to be coloured, you either colour
+<a href="#xcolor">XCOLOR</a>.
+Afterwards, any time you want text to be coloured, you either colour
it with an
<a href="definitions.html#inlines">inline escape</a>
that contains the colour name (e.g. <kbd>\*[red]</kbd>
or <kbd>\*[blue]</kbd>) or invoke the macro
-<kbd><a href="#color">COLOR</a></kbd>
+<a href="#color">COLOR</a>
with the name of the colour you want.
</p>
@@ -68,9 +68,9 @@ For example, say you want to have the name “Jack”
in the
sentence “All work and no play makes Jack a dull boy”
appear in yellow. You’d begin by telling mom about the colour,
yellow. There are two ways of doing this; see
-<kbd><a href="#newcolor">NEWCOLOR</a></kbd>
+<a href="#newcolor">NEWCOLOR</a>
and
-<kbd><a href="#xcolor">XCOLOR</a></kbd>
+<a href="#xcolor">XCOLOR</a>
for a full explanation of the difference between the two.
</p>
@@ -88,15 +88,14 @@ If you use NEWCOLOR, you might enter:
</p>
<p id="color-example2" style="margin-top: -1em;">
-After “defining” (or “initializing”) the
-colour “yellow”, you’d colourize the name, Jack,
-either with an inline escape
+After defining or initializing the colour yellow you’d
+colourize the name, Jack, either with an inline escape
<br/>
<span class="pre-in-pp">
All work and no play makes \*[yellow]Jack\*[black] a dull boy.
</span>
or with the
-<kbd><a href="#color">COLOR</a></kbd>
+<a href="#color">COLOR</a>
macro
<br/>
<span class="pre-in-pp">
@@ -107,8 +106,8 @@ macro
a dull boy.
</span>
Notice, in both examples, that a) you have to set the colour back
-to black after “Jack”, and b) you don’t have to
-define or intialize the colour, black. Mom predefines it for you.
+to black after “Jack,” and b) you don’t have to
+define or initialize the colour, black. Mom predefines it for you.
</p>
<p>
@@ -310,7 +309,7 @@ policy, it must be entered in lower case.
</p>
<p>
-For example, if you want to intialize the X colour, coral, all you
+For example, if you want to initialize the X colour, coral, all you
have to do is enter
<br/>
<span class="pre-in-pp">
diff --git a/contrib/mom/momdoc/cover.html b/contrib/mom/momdoc/cover.html
index ad4ea16..a855615 100644
--- a/contrib/mom/momdoc/cover.html
+++ b/contrib/mom/momdoc/cover.html
@@ -100,7 +100,7 @@ first cover page.
<p>
A cover is what you’d use for pages that separate sections
-of a collated document, ie title pages. A cover page (but not a
+of a collated document, i.e. title pages. A cover page (but not a
doc-cover) in a collated document could, for example, simply read:
”PART 1”.
</p>
@@ -154,7 +154,7 @@ arguments you pass to
and/or
<a href="#cover">COVER</a>.
Provided you have already given mom the appropriate reference macros
-(e.g.,
+(e.g.
<a href="docprocessing.html#title">TITLE</a>
or
<a href="docprocessing.html#author">AUTHOR</a>),
@@ -618,7 +618,7 @@ image on the cover, perhaps a company logo.
DOC_COVER_IMAGE and COVER_IMAGE take the same arguments
as PDF_IMAGE, and in the same order. Consult
<a href="images.html#pdf-image">PDF_IMAGE</a>
-for a desciption.
+for a description.
</p>
<p>
diff --git a/contrib/mom/momdoc/definitions.html
b/contrib/mom/momdoc/definitions.html
index e5e9b88..b545760 100644
--- a/contrib/mom/momdoc/definitions.html
+++ b/contrib/mom/momdoc/definitions.html
@@ -198,7 +198,7 @@ or concept you’re not familiar with.
Discretionary hyphens make sure it does. In the event that the
word doesn’t need to be hyphenated at all, groff leaves them
alone. In groff, the discretionary hyphen is entered with
- <kbd>\%</kbd> (ie, a backslash followed by the percent sign).
+ <kbd>\%</kbd> (i.e. a backslash followed by the percent sign).
</dd>
<dt id="dropcap">Drop cap</dt>
@@ -221,7 +221,7 @@ or concept you’re not familiar with.
<a href="#font">font</a>.
Since most Ms are designed square, an em is usually (but
sometimes erroneously) considered to be the same size as the
- current point size (ie if the point size of the type is 12,
+ 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
@@ -232,7 +232,7 @@ or concept you’re not familiar with.
<dd>
The collective name by which a collection of
<a href="#font">fonts</a>
- are known, e.g., Helvetica, Times Roman, Garamond.
+ are known, e.g. Helvetica, Times Roman, Garamond.
</dd>
<dt id="figurespace">Figure space/Digit space</dt>
@@ -241,7 +241,7 @@ or concept you’re not familiar with.
<a href="#fixedwidthspace">fixed width space</a>
that has the width of one digit. Used for aligning numerals in,
say, columns or numbered lists. In groff, the figure space is
- entered with <kbd>\0</kbd> (ie a backslash followed by a zero)
+ entered with <kbd>\0</kbd> (i.e. a backslash followed by a zero)
</dd>
<dt id="fixedwidthfont">Fixed-width font</dt>
@@ -258,7 +258,7 @@ or concept you’re not familiar with.
but does not expand or contract when text is
<a href="#just">justified</a>.
In groff, fixed width space is entered with
- <kbd>\<space></kbd> (ie a backslash followed by a space)
+ <kbd>\<space></kbd> (i.e. a backslash followed by a space)
</span>
</dd>
@@ -270,7 +270,7 @@ or concept you’re not familiar with.
<a href="#shape">shape</a>
of type within a
<a href="#family">family</a>,
- e.g., light, medium, bold (which are weights), and roman, italic,
+ e.g. light, medium, bold (which are weights), and roman, italic,
condensed (which are shapes). By default, groff knows of four
fonts within its default set of families: R (medium roman), I
(medium italic), B (bold roman) and BI (bold italic).
@@ -459,7 +459,7 @@ or concept you’re not familiar with.
<dd>
When no
<a href="#leading">lead</a>
- is added between lines of type (ie the
+ is added between lines of type (i.e., the
<a href="#ps">point size</a>
and linespacing are the same), the lines are said to be “set
solid.”
@@ -483,7 +483,7 @@ or concept you’re not familiar with.
kept together on the same line. Expands and contracts like word
space. Useful for proper names, which one should, whenever
possible, avoid splitting onto two lines. In groff, unbreakable
- space is entered with <kbd>\~</kbd> (ie a backslash followed by a
+ space is entered with <kbd>\~</kbd> (i.e. a backslash followed by a
tilde)
</dd>
@@ -557,7 +557,7 @@ or concept you’re not familiar with.
<dt id="commentlines">Comment Lines</dt>
<dd>
<a href="#inputline">Input lines</a>
- introduced with the comment character <kbd>\#</kbd> (ie a
+ introduced with the comment character <kbd>\#</kbd> (i.e. a
backslash followed by the pound sign). When processing output,
groff silently ignores everything on a line that begins with the
comment character.
@@ -593,7 +593,7 @@ or concept you’re not familiar with.
justification is turned on) or breaks and quads the line (when
quadding is turned on).
- <p>
+ <p id="no-fill">
Nofill mode (non-filled text) means that groff respects the ends
of lines exactly as they appear in your text editor.
</p>
@@ -767,7 +767,7 @@ or concept you’re not familiar with.
<p style="margin-top: -1em;">
Units of measure must come immediately after the numeric
- argument (ie with no space between the argument and the unit
+ argument (i.e. with no space between the argument and the unit
of measure), like this:
<span class="pre" style="margin-bottom: -2em;">
@@ -796,7 +796,7 @@ or concept you’re not familiar with.
<p>
You can enter decimal values for any unit of measure. Different
- units may be combined by adding them together (e.g., 1.5i+2m,
+ units may be combined by adding them together (e.g. 1.5i+2m,
which gives a measure of 1-1/2 inches plus 2 ems).
</p>
@@ -824,7 +824,7 @@ or concept you’re not familiar with.
It looks like this:
<span class="pre" style="margin-bottom: -2em;">
- \& (ie a backslash followed by an ampersand)
+ \& <span style="font-family: arial, sans-serif; font-weight:
normal">(i.e. a backslash followed by an ampersand)</span>
</span>
Normally, groff interprets a period (or an apostrophe) at the
@@ -833,8 +833,8 @@ or concept you’re not familiar with.
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 them), or spaces at the beginning of input lines as just
+ and apostrophes at the beginning of input lines literally (i.e.
+ to 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.
</dd>
@@ -855,7 +855,7 @@ or concept you’re not familiar with.
<dd>
Macros used in
<a href="docprocessing.html#docprocessing">document processing</a>
- to control/alter the appearance of document elements (e.g.,
+ to control/alter the appearance of document elements (e.g.
headings, quotes, footnotes,
<a href="#header">headers</a>,
etc.).
@@ -920,7 +920,7 @@ or concept you’re not familiar with.
<a href="#running">running text</a>,
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). Also commonly called a
+ (e.g. a scene change in a short story). Also commonly called a
scene break or a section break.
</dd>
@@ -940,14 +940,14 @@ or concept you’re not familiar with.
<dt id="pdfoutline">PDF outline</dt>
<dd>
The hierarchically-arranged navigation outline provided by most PDF
- viewers (e.g., Okular, Evince), typically in a panel to the left of
- the document window, and usually labeled “Contents”.
+ viewers (e.g. Okular, Evince), typically in a panel to the left of
+ the document window, and usually labelled “Contents”.
</dd>
<dt id="quote">Quote</dt>
<dd>
A quote, to mom, is a line-for-line setting
- of quoted material (e.g., poetry, song lyrics, or a snippet of
+ of quoted material (e.g. poetry, song lyrics, or a snippet of
programming code). You don’t have to use
<a href="typesetting.html#br"><kbd>BR</kbd></a>
with quotes.
diff --git a/contrib/mom/momdoc/docelement.html
b/contrib/mom/momdoc/docelement.html
index 7db22d9..8ef8a89 100644
--- a/contrib/mom/momdoc/docelement.html
+++ b/contrib/mom/momdoc/docelement.html
@@ -183,7 +183,7 @@ tag, and what mom’s defaults for the tag are.
<p>
The control macros may be used at any time during the course of a
-document (ie before or after
+document (i.e. before or after
<a href="docprocessing.html#start">START</a>).
The changes you make alter all subsequent invocations of the
affected tag until you make another change, either by passing new
@@ -298,7 +298,7 @@ For example, to set footnotes
<span class="pre-in-pp">
.FOOTNOTE_AUTOLEAD 0
</span>
-To set footnotes with a 1-point lead (ie with the line spacing
+To set footnotes with a 1-point lead (i.e. with the line spacing
one point greater than the footnote’s point size), do
<br/>
<span class="pre-in-pp">
@@ -389,7 +389,7 @@ skip over any of them, which means that if you only wish to
change
<p>
Page elements that are separated from
<a href="definitions.html#running">running text</a>
-by a rule (ie page headers, page footers and footnotes) are
+by a rule (i.e. page headers, page footers and footnotes) are
controlled by macros that end in _RULE_WEIGHT.
</p>
@@ -480,7 +480,7 @@ paragraph text.
By default, mom sets epigraphs centred and
<a href="definitions.html#filled">unfilled</a>;
this lets you input them on a line for line basis. This behaviour
-can be changed to accomodate
+can be changed to accommodate
<a href="definitions.html#filled">filled</a>
epigraph “blocks.”
</p>
@@ -526,7 +526,7 @@ tag.
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
-EPIGRAPH should only be used at the top of a document (ie just
+EPIGRAPH should only be used at the top of a document (i.e. just
after
<a href="docprocessing.html#start">START</a>)
or after headings. The latter is not especially recommended, but it
@@ -609,7 +609,7 @@ precisely the amount specified.
</p>
<p>
-Please also note that if your PARA_INDENT is <kbd>0</kbd> (ie
+Please also note that if your PARA_INDENT is <kbd>0</kbd> (i.e.
no indenting of the first line of paragraphs), you must set an
EPIGRAPH_INDENT yourself, with a unit of measure appended to the
argument. Mom has no default for EPIGRAPH_INDENT if paragraph first
@@ -662,10 +662,10 @@ her to do so, use the control macro
<p>
Note that mom does not provide widow or orphan control for
-paragraphs (ie even if only one line of a paragraph fits at the
+paragraphs (i.e., even if only one line of a paragraph fits at the
bottom of a page, she will set it on that page). The reason for
this is that writers of fiction often have single-line paragraphs
-(e.g., in dialogue). Groff’s simplistic orphan control will
+(e.g. in dialogue). Groff’s simplistic orphan control will
break these one-liners—if they fall at the bottom of the
page—to a new page, which is not what you want.
</p>
@@ -750,7 +750,7 @@ If you wish to change the family for regular text
paragraphs only,
invoke <kbd>.FAMILY</kbd> immediately after <kbd>.PP</kbd> in every
paragraph whose family you wish to differ from the prevailing
document family. Alternatively, set the family and font for
-paragraphs with PP_FONT, giving it a complete family+font name, e.g.,
+paragraphs with PP_FONT, giving it a complete family+font name, e.g.
<br/>
<span class="pre-in-pp">
PP_FONT TI
@@ -877,7 +877,7 @@ paragraph whose leading you wish to change.
<div class="box-tip">
<p class="tip">
<span class="note">Warning:</span>
-Changing a paragraph’s leading will almost certaininly screw
+Changing a paragraph’s leading will almost certainly screw
up mom’s ability to balance the bottom margin of pages.
Should you absolutely require a change of paragraph’s leading and
need to get mom back on track leading-wise afterwards, use the
@@ -898,7 +898,7 @@ is 16 points, adjusted to fill the page.
<h4 id="pp-just-quad" class="docs" style="margin-top: -.25em;">5.
Justification/quad</h4>
<p>
-The justification/quad-direction of regular text paragraphs (ie
+The justification/quad-direction of regular text paragraphs (i.e.
<a href="definitions.html#just">justified</a>,
or
<a href="definitions.html#filled">filled</a>
@@ -1065,7 +1065,7 @@ If PARA_SPACE is on, mom spaces only those paragraphs
that come
after an initial paragraph. Initial paragraphs are those that come
immediately after the
<a href="definitions.html#docheader">docheader</a>
-(ie the start of a document),
+(i.e. the start of a document),
<a href="#epigraph-intro">epigraphs</a>,
<a href="#heading-intro">headings</a>,
and
@@ -1124,7 +1124,7 @@ bookmark for
<p>
Headings can also be numbered on a per-heading-level basis,
-hierarchically and concatenatively, e.g.,
+hierarchically and concatenatively, e.g.
<br/>
<span class="pre-in-pp">
1.
@@ -1194,8 +1194,8 @@ subsequent paragraphs.
</p>
<p>
-The optional third argument, <kbd>NAMED <id></kbd>, gives the
-heading a unique, non-printing identifier that allows it to
+The optional third argument, <kbd>NAMED <id></kbd>, gives
+the heading a unique, non-printing identifier that allows it to be
referenced from anywhere in the final PDF document with the PDF_LINK
macro, provided the mom file is processed with
<a href="using.html#pdfmom" style="font-weight: bold">pdfmom</a>.
@@ -1269,7 +1269,7 @@ This results in slightly less whitespace than normal, but
the
difference is usually not apparent. Alternatively, you may pass the
<kbd>NO_SHIM</kbd> or <kbd>NO_FLEX</kbd> argument to
<a href="#heading-style">HEADING_STYLE</a>
-to prevent shimming or flex-spacing of any particlar heading level
+to prevent shimming or flex-spacing of any particular heading level
either globally or selectively. If shimming/flex-spacing is
disabled selectively with
<br/>
@@ -1384,7 +1384,7 @@ appended to it.
<p class="defaults" style="margin-bottom: 1em">
<kbd>NEEDS</kbd> lets you reserve the number of lines of text
-required beneath a heading, including fractions thereof (e.g.,
+required beneath a heading, including fractions thereof (e.g.
“1.5” for one line of text plus half a linespace).
If a heading falls near the bottom margin and there isn’t
sufficient room for both the heading and the reserved space, mom
@@ -1531,7 +1531,7 @@ numbered head element of each collated document).
<p>
PREFIX_CHAPTER_NUMBER can be disabled by passing it any argument
-other than a digit (e.g., <b>OFF, QUIT, END, X</b>, etc), although,
+other than a digit (e.g. <b>OFF, QUIT, END, X</b>, etc), although,
as noted above, mom will keep, and—in the case of collated
documents—increment the chapter number, allowing you to turn
prefixing of chapter numbers to numbered head elements off and on
@@ -1769,7 +1769,7 @@ The former style defaults for SUBHEAD were:
<br/>
<span class="pre-in-pp">
FAMILY = prevailing document family
- FONT = bold (TYPESET); italic, ie underlined (TYPEWRITE)
+ FONT = bold (TYPESET); italic, i.e. underlined (TYPEWRITE)
SIZE = +.5 (TYPESET); +0 (TYPEWRITE)
QUAD = L
BASELINE_ADJUST = 1/8 the current leading
@@ -1845,7 +1845,7 @@ Mom will alert you to this on stderr.
<p>
Linebreaks (“author linebreaks”, “section
breaks”) are gaps in the vertical flow of running text that
-indicate a shift in content (e.g., a scene change in story). They
+indicate a shift in content (e.g. a scene change in story). They
are frequently set off by typographic symbols, sometimes whimsical
in nature.
</p>
@@ -1905,7 +1905,7 @@ and a vertical adjustment factor.
</p>
<p>
-The first argument is any valid groff character (e.g., <kbd>*</kbd>
+The first argument is any valid 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]). Mom sets the character centred on the current
@@ -2000,7 +2000,7 @@ cited text.)
<p>
Since mom originally came into being to serve the needs of creative
-writers (ie novelists, short story writers, etc.—not
+writers (i.e. novelists, short story writers, etc.—not
to cast aspersions on the creativity of mathematicians and
programmers), she sets quotes in italics
<a href="docprocessing.html#printstyle">(PRINTSTYLE <kbd>TYPESET</kbd>)</a>
@@ -2009,7 +2009,7 @@ or underlined
indented from the left margin. Obviously, she’s thinking
“quotes from poetry or song lyrics”, but with the
<a href="#quote-control">QUOTE control macros</a>
-you can change her defaults so QUOTE serves other needs, e.g.,
+you can change her defaults so QUOTE serves other needs, e.g.
entering verbatim snippets of programming code, command-line
instructions, and so on. (See the
<a href="#code">CODE</a>
@@ -2028,7 +2028,7 @@ this is always one full linespace. In
<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPESET</kbd></a>,
it’s 1/2 of the prevailing
<a href="definitions.html#leading">leading</a>
-if the quote fits fully on the page (ie with running text above
+if the quote fits fully on the page (i.e. with running text above
and below it), otherwise it’s a full linespace either above
or below as is necessary to balance the page to the bottom margin.
This behaviour can be changed with the control macro
@@ -2054,10 +2054,10 @@ differently.
<p class="tip-bottom">
If you don’t want the behaviour
-described above (ie you don’t want mom putting additional shim
+described above (i.e., you don’t want mom putting additional shim
or flex-spacing around quotes and
blockquotes), put <kbd>.NO_SHIM</kbd> or/and <kbd>.NO_FLEX</kbd>
-in the style sheet section of your document (ie after PRINTSTYLE
+in the style sheet section of your document (i.e. after PRINTSTYLE
but before START), which will disable shimming or/and flex-spacing
globally for all tags, or disable shimming/flex-spacing
on a per-instance basis prior to <kbd>.QUOTE</kbd> or
@@ -2122,7 +2122,7 @@ Macro: <b>QUOTE</b> <kbd class="macro-args">[ ADJUST
+|-<space> ] | <an
<p>
QUOTE is a toggle macro. To begin a section of quoted text, invoke
it with no argument, then type in your quote. When you’re
-finished, invoke <kbd>.QUOTE</kbd> with any argument (e.g., <kbd>OFF,
+finished, invoke <kbd>.QUOTE</kbd> with any argument (e.g. <kbd>OFF,
END, X, Q</kbd>...) to turn it off. Example:
<br/>
<span class="pre-in-pp">
@@ -2185,7 +2185,7 @@ and <kbd>QUOTE_RIGHT</kbd> must be entered as:
<span class="pre defaults">
.QUOTE_FAMILY default = prevailing document family; default is Times Roman
.QUOTE_FONT default = italic; underlined in TYPEWRITE
-.QUOTE_SIZE default = +0 (ie same size as paragraph text)
+.QUOTE_SIZE default = +0 (i.e. same size as paragraph text)
<a id="quote-autolead">.QUOTE_AUTOLEAD default = none; leading of quotes is
the same as paragraphs </a>
.QUOTE_COLOR default = black
.QUOTE_INDENT (see below, "Quote indent")
@@ -2207,8 +2207,19 @@ for TYPESET, 3
<a href="definitions.html#picaspoints">picas</a>
for TYPEWRITE) to arrive at the quote indent, or a distance with a
<a href="definitions.html#unitofmesaure">unit of measure</a>
-appended. Both result in quotes being indented equally from the
-left and right margins.
+appended.
+</p>
+
+<p>
+Be careful when using QUOTE. If a quote is set flush left (the
+default), the QUOTE_INDENT applies only to the left margin. Because
+quote lines are output as-is (see
+<a href="definitions.html#no-fill">no-fill mode</a>),
+they do not respect line length and may extend beyond a document's
+right margin. Similarly, if a quote is being set flush right, the
+indent applies only to the right margin; long lines may extend into
+the left margin. Centered quotes are never indented, so long lines
+may extend beyond both the left and right margins.
</p>
<p>
@@ -2221,7 +2232,7 @@ and 1 (for
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
-If your PARA_INDENT is 0 (ie no indenting of the first line of
+If your PARA_INDENT is 0 (i.e. no indenting of the first line of
paragraphs), you <i>must</i> set a QUOTE_INDENT yourself, with a
unit of measure appended to the argument. Mom has no default for
QUOTE_INDENT if paragraph first lines are not being indented.
@@ -2343,7 +2354,7 @@ Macro: <b>BLOCKQUOTE</b> <kbd class="macro-args">[
ADJUST +|-<space> ] |
BLOCKQUOTE is a toggle macro. To begin a cited passage, invoke
the tag with no argument, then type in your blockquote. When
you’re finished, invoke <kbd>.BLOCKQUOTE</kbd> with any
-argument (e.g., <kbd>OFF, END, X, Q</kbd>...) to turn it off.
+argument (e.g. <kbd>OFF, END, X, Q</kbd>...) to turn it off.
Example:
<br/>
<span class="pre-in-pp">
@@ -2448,7 +2459,7 @@ and 1 (for
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
-If your PARA_INDENT is 0 (ie no indenting of the first line of
+If your PARA_INDENT is 0 (i.e. no indenting of the first line of
paragraphs), you <i>must</i> set a BLOCKQUOTE_INDENT yourself, with
a unit of measure appended to the argument. Mom has no default for
BLOCKQUOTE_INDENT if paragraph first lines are not being indented.
@@ -2504,7 +2515,7 @@ using mom’s document processing macros; it can be
used for
</div>
<div class="box-macro-args">
-Macro: <b>CODE</b> <kbd class="macro-args">[BR | BREAK | SPREAD] toggle</kbd>
+Macro: <b>CODE</b> <kbd class="macro-args">[BR | BREAK | SPREAD]
<anything></kbd>
</div>
<p class="requires" style="font-style: normal">
@@ -2537,7 +2548,7 @@ The correct order for changing the escape character inside
.CODE
.ESC_CHAR character
<code>
- .ESC_CHAR .
+ .ESC_CHAR \
.CODE OFF
</span>
Be aware that changing the escape character prevents subsequent
@@ -2559,7 +2570,7 @@ to print a literal backslash.
<kbd>.CODE</kbd> does not cause a line break when
you’re in a
<a href="definitions.html#filled">fill mode</a>
-(ie
+(i.e.
<a href="typesetting.html#justify">JUSTIFY</a>
or
<a href="typesetting.html#quad">QUAD</a>
@@ -2574,12 +2585,12 @@ it as well, invoke <kbd>.CODE</kbd> with the argument,
you want a break afterwards, you must supply it manually with
<a href="typesetting.html#br">BR</a>
unless what follows immediately is a macro that automatically causes
-a break (e.g.,
+a break (e.g.
<a href="#pp">PP</a>).
</p>
-<p class="tip-bottom">
-In all likelihood, if you want the situation described above (ie a
+<p id="quote-code" class="tip-bottom">
+In all likelihood, if you want the situation described above (i.e. a
break before and after CODE), what you probably want is to use
<a href="quote">QUOTE</a>
in conjunction with CODE, like this:
@@ -2602,7 +2613,7 @@ introducing unwanted vertical whitespace.
<p>
Passing any argument other than <kbd>BR</kbd>, <kbd>BREAK</kbd> or
-<kbd>SPREAD</kbd> to CODE (e.g., <kbd>OFF, QUIT, END, X,</kbd> etc.)
+<kbd>SPREAD</kbd> to CODE (e.g. <kbd>OFF, QUIT, END, X,</kbd> etc.)
turns CODE off and returns the family, font, and smartquotes back to
their former state.
</p>
@@ -2712,7 +2723,7 @@ meaning that they frequently look bigger (or, in some
cases,
smaller) than the type surrounding them, even if they’re
technically the same point size. CODE_SIZE lets you choose a
percentage of the prevailing point size for your fixed-width
-CODE font so it doesn’t look gangly or miniscule in relation
+CODE font so it doesn’t look gangly or minuscule in relation
to the type around it. All invocations of <kbd>.CODE</kbd> or
<kbd>\*[CODE]</kbd> will use this size, so that if you decide to
change the prevailing point size of your document, the CODE font
@@ -2806,7 +2817,7 @@ or
Mom centres lists over the entire line length, disregarding
<a href="typesetting.html#ib">IB</a>
if it is in effect. If there are lines in the list that exceed
-the the margins of IB, they must be broken manually with
+the margins of IB, they must be broken manually with
<kbd>.BR</kbd> if you wish to keep them within the indented margins.
</p>
</div>
@@ -2829,9 +2840,9 @@ Macro: <b>LIST</b> <kbd class="macro-args">[ BULLET |
DASH | DIGIT | ALPHA | alp
</div>
<p>
-Invoked by itself (ie with no argument), LIST
+Invoked by itself (i.e. with no argument), LIST
initializes a list with bullets as the default enumerator.
-Afterward,s each block of input text preceded by
+Afterwards, each block of input text preceded by
<kbd><a href="#item">.ITEM</a></kbd>,
on a line by itself, is treated as a list item.
</p>
@@ -2844,7 +2855,7 @@ Every time you invoke <kbd>.LIST</kbd> to start a list
(as opposed to
you must supply an enumerator (and optionally, a separator) for the
list, unless you want mom’s default enumerator, which is a
bullet. Within nested lists, mom stores the enumerator, separator
-and indent for any list you return <i>backwards</i> to (ie with
+and indent for any list you return <i>backwards</i> to (i.e. with
<kbd>.LIST OFF</kbd>), but does not store any information for lists
you move <i>forward</i> to.
</p>
@@ -2868,8 +2879,8 @@ uppercase letters), <kbd>alpha</kbd> (for lowercase
letters),
<p>
The arguments, <kbd>ROMAN<n></kbd> and
<kbd>roman<n></kbd>, are special. You must append to them
-a digit (arabic, e.g., "1" or "9" or "17") saying how many items a
-particular roman-numeralled LIST is going to have. Mom requires this
+a digit (arabic, e.g. "1" or "9" or "17") saying how many items a
+particular roman-numeraled LIST is going to have. Mom requires this
information in order to align roman numerals sensibly, and will
abort—with a message — if you don’t provide it.
(For setting roman numeral and digit lists with the enumerators
@@ -2878,7 +2889,7 @@ aligned flush right—the default is flush
left—see
</p>
<p>
-A roman-numeralled list containing, say, five items, would be set
+A roman-numeraled list containing, say, five items, would be set
up like this:
<br/>
<span class="pre-in-pp">
@@ -2918,8 +2929,7 @@ or
</span>
If your enumerator contains spaces, you must enclose the
<kbd><character></kbd> argument in both LIST and ITEM in
-double-quotes,
-e.g.
+double-quotes, e.g.
<br/>
<span class="pre-in-pp">
.LIST VARIABLE "\*[UP 1p]\[bu]\*[DOWN 1p]"
@@ -3024,7 +3034,7 @@ separator.
<h3 class="docs">The third argument – prefix style</h3>
<p>
-Additionally, you may give a prefix (ie a character
+Additionally, you may give a prefix (i.e. a character
that comes <i>before</i> the enumerator) when your
enumerator style for a particular list is <kbd>DIGIT</kbd>,
<kbd>ALPHA</kbd>, <kbd>alpha</kbd>, <kbd>ROMAN<n></kbd> or
@@ -3068,7 +3078,7 @@ which would produce
Any single argument to <kbd>LIST</kbd> other than
<kbd>BULLET</kbd>, <kbd>DASH</kbd>, <kbd>DIGIT</kbd>,
<kbd>ALPHA</kbd>, <kbd>alpha</kbd>, <kbd>ROMAN<n></kbd>,
-<kbd>roman<n></kbd> or <kbd>USER</kbd> (e.g.,
+<kbd>roman<n></kbd> or <kbd>USER</kbd> (e.g.
<kbd>LIST OFF</kbd> or <kbd>LIST BACK</kbd>) takes you out
of the current list.
</p>
@@ -3081,7 +3091,7 @@ prior to setting the list are fully restored.
<p>
If you are in a nested list, mom moves you back one list-level
-(ie does not take you out of the list structure) and restores the
+(i.e., does not take you out of the list structure) and restores the
enumerator, separator and indent appropriate to that level.
</p>
@@ -3354,7 +3364,7 @@ lines up properly.
<p>
If you’d like the roman numerals to line
-up flush right (ie be padded "left"), simply
+up flush right (i.e. be padded "left"), simply
invoke <kbd>.PAD_LIST_DIGITS LEFT</kbd> after
<kbd>.LIST ROMAN<n></kbd> or
<kbd>.LIST roman<n></kbd> and before <kbd>.ITEM</kbd>.
@@ -3468,7 +3478,7 @@ you must, at a minimum, tell it what line number you want
the
<a href="definitions.html#outputline">output line</a>
to have. The optional arguments <kbd>which lines to number</kbd>
and <kbd>gutter</kbd> allow you to state which lines should
-be numbered (e.g., every five or every ten lines), and the gutter to
+be numbered (e.g. every five or every ten lines), and the gutter to
place between line numbers and
<a href="definitions.html#running">running text</a>.
</p>
@@ -3695,7 +3705,7 @@ or
.NUMBER_BLOCKQUOTE_LINES
</span>
either before or after <kbd>NUMBER_LINES</kbd>. Both behave
-identically with respect to the affected macro (ie <kbd>QUOTE</kbd>
+identically with respect to the affected macro (i.e. <kbd>QUOTE</kbd>
or <kbd>BLOCKQUOTE</kbd>).
</p>
@@ -3708,7 +3718,7 @@ selectively for quotes and blockquotes <i>only</i>, enable
first, followed by <kbd>NUMBER_LINES <n></kbd>, where
<kbd><n></kbd> is the first line number of the quote
or blockquote. Afterwards, enter your <kbd>QUOTE</kbd> or
-<kbd>BLOCKQUOTE</kbd>. When the quote or blockquote is finished (ie
+<kbd>BLOCKQUOTE</kbd>. When the quote or blockquote is finished (i.e.
after <kbd>QUOTE OFF</kbd> or <kbd>BLOCKQUOTE OFF</kbd>),
turn line numbering off. Each subsequent quote or blockquote you
want line numbered requires only <kbd>NUMBER_LINES <n></kbd>
@@ -3747,7 +3757,7 @@ space as the line number
unit of measure, it is not possible for line numbers in quotes
or blockquotes to hang outside a document’s overall left
margin and be reliably flush with the line numbers of paragraph
-text. Conseqently, line numbers in quotes or blockquotes hang
+text. Consequently, line numbers in quotes or blockquotes hang
to the left of the quote, separated by the currently active
gutter for <kbd>NUMBER_LINES</kbd>.
</p>
@@ -3894,7 +3904,7 @@ first footnote is always the same.
<p>
If mom sees that a portion of a footnote cannot be fit on its page,
she carries that portion over to the next page. If an entire
-footnote can’t be fit on its page (ie FOOTNOTE has been
+footnote can’t be fit on its page (i.e., FOOTNOTE has been
called too close to the bottom), she defers the footnote to the next
page, but sets it with the appropriate marker from the previous
page.
@@ -3911,7 +3921,7 @@ page if it allows her to complete the cited text on one
page.
<p>
In the unfortunate happenstance that a deferred footnote is the
-only footnote on its page (ie it’s marked in the document
+only footnote on its page (i.e., it’s marked in the document
body with a star) and the page it’s deferred to has its own
footnotes, mom separates the deferred footnote from the page’s
proper footnote(s) with a blank line. This avoids the confusion
@@ -4167,7 +4177,7 @@ See <span style="font-style: normal"><a
href="#footnote-note">HYPER-IMPORTANT NO
<p>
FOOTNOTE is a toggle macro, therefore invoking it on a line by
itself allows you to enter a footnote in the body of a document.
-Invoking it with any argument other than INDENT (ie <kbd>OFF,
+Invoking it with any argument other than INDENT (i.e. <kbd>OFF,
QUIT, END, X...</kbd>) tells mom you’re finished.
</p>
@@ -4218,7 +4228,7 @@ modes
or
<a href="typesetting.html#quad">QUAD</a>),
the line <i>after</i> a <kbd>.FOOTNOTE OFF</kbd> should be
-entered as if there were no interruption in the input text, ie
+entered as if there were no interruption in the input text, i.e.,
the line should begin with a literal space or punctuation mark (see
explanation and examples
<a href="#fn-and-punct">here</a>).
@@ -4412,12 +4422,12 @@ footnotes either by single line numbers, or line
ranges. If
what you want is a single line number, you need only invoke
<kbd>.FOOTNOTE</kbd>, <i>without the terminating</i> <kbd>\c</kbd>,
at the appropriate place in running text. Input lines after the
-footnote has been terminated (e.g., with <kbd>.FOOTNOTE OFF</kbd>)
+footnote has been terminated (e.g. with <kbd>.FOOTNOTE OFF</kbd>)
must begin at the left margin.
</p>
<p>
-If you want a range of line numbers (e.g., [5-11] ),
+If you want a range of line numbers (e.g. [5-11] ),
insert, directly into the first line of the range you want,
the <a href="definitions.html#inlines">inline escape</a>,
<kbd>\*[FN_MARK]</kbd>. For the terminating line number of the
@@ -4506,7 +4516,7 @@ separator with a space after it, you’d do
<p style="margin-left: .5em;">
Finally, if your footnote marker style is <kbd>LINE</kbd>, you may
instruct mom to do “run-on style” footnotes. Run-on
-footnotes do not treat footnotes as discrete entities, ie each
+footnotes do not treat footnotes as discrete entities, i.e. each
beginning on a new line. Rather, each footnote is separated from
the footnote before it by horizontal space in the running line, so
that the footnotes on any given page form a continuous block, like
@@ -4596,7 +4606,7 @@ which sets the length to 1 inch. Note that a
is required. The default is 4
<a href="definitions.html#picaspoints">picas</a>
for both
-<a href="docprocessing.html#printstyle">PRINTSTYLES</a>.
+<a href="docprocessing.html#printstyle">PRINTSTYLE</a>s.
</p>
<h4 id="footnote-rule-weight" class="docs" style="margin-top: -.25em;">9.
Footnote rule weight – FOOTNOTE_RULE_WEIGHT</h4>
@@ -4753,7 +4763,7 @@ or
<a href="#blockquote-control">blockquote control macros</a>.
However, you must make the changes <i>within</i> each endnote,
prior to invoking <kbd>.QUOTE</kbd> or <kbd>.BLOCKQUOTE</kbd>,
-and undo them prior to terminating the endnote (ie before
+and undo them prior to terminating the endnote (i.e. before
<kbd>.ENDNOTE OFF</kbd>), otherwise the changes will affect
subsequent quotes and blockquotes that appear in the document body
as well.
@@ -4787,7 +4797,7 @@ is removed.
By default, mom starts the endnotes page with a bold, centred head,
“ENDNOTES”. Subsequently, for each section in a
<a href="rectoverso.html#collate-intro">collated</a>
-document (e.g., chapters in a book), she identifies the section in bold
+document (e.g. chapters in a book), she identifies the section in bold
type, flush left and underscored, followed by one-half linespace.
Endnotes pertaining to the section are output underneath, identified
by superscript numbers. The text of the endnotes themselves is
@@ -4840,7 +4850,7 @@ See <span style="font-style: normal"><a
href="#endnote-note">HYPER-IMPORTANT NOT
<p>
ENDNOTE is a toggle macro, therefore invoking it on a line by itself
allows you to enter an endnote in the body of a document. Invoking
-it with any other argument (ie <kbd>OFF, QUIT, END, X...</kbd>)
+it with any other argument (i.e. <kbd>OFF, QUIT, END, X...</kbd>)
tells mom that you’ve finished the endnote.
</p>
@@ -4880,7 +4890,7 @@ modes
or
<a href="typesetting.html#quad">QUAD</a>,
the line after <kbd>.ENDNOTE OFF</kbd> should be
-entered as if there were no interruption in the input text, ie
+entered as if there were no interruption in the input text, i.e.,
the line should begin with a literal space or punctuation mark (see
explanation and examples for footnotes, which apply equally to
endnotes,
@@ -4919,13 +4929,13 @@ Macro: <b>ENDNOTES</b>
<p>
Unlike footnotes, which mom automatically outputs at the bottom
of pages, endnotes must be explicitly output by you, the
-user. ENDNOTES, by itself (ie without any argument), is the macro
+user. ENDNOTES, by itself (i.e. without any argument), is the macro
to do this.
</p>
<p>
Typically, you’ll use ENDNOTES at the end of a document. If
-it’s a single (ie not collated) document, mom will print
+it’s a single (i.e. not collated) document, mom will print
the endnotes pertaining to it. If it’s a collated document,
mom will print all the endnotes contained within all sections of
the document (typically chapters), appropriately identified and
@@ -5163,7 +5173,7 @@ Macro: <b>ENDNOTE_SPACING</b> <kbd
class="macro-args"><space to insert betwee
<p>
If you’d like some whitespace between endnotes, just invoke
-ENDNOTE_SPACING with the amount of space you want, e.g.,
+ENDNOTE_SPACING with the amount of space you want, e.g.
<br/>
<span class="pre-in-pp">
.ENDNOTE_SPACING 6p
@@ -5327,7 +5337,7 @@ Macro: <b>ENDNOTES_FIRST_PAGENUMBER</b> <kbd
class="macro-args"><page # that
<p>
Use this macro with caution. If all endnotes for several
<a href="rectoverso.html#collate">collated</a>
-documents are to be output at once, ie not at the end of each
+documents are to be output at once, i.e. not at the end of each
separate doc, ENDNOTES_FIRST_PAGENUMBER tells mom what page number
to put on the first page of the endnotes.
</p>
@@ -5558,7 +5568,7 @@ Macro: <b>ENDNOTES_HEADER_V_POS</b> <kbd
class="macro-args"><distance from to
</div>
<p class="requires">
-• Argument requires a <a href="definitions.html#unitofmeasure">unit
of measusure</a>
+• Argument requires a <a href="definitions.html#unitofmeasure">unit
of measure</a>
</p>
<p class="alias" style="margin-top: -1em; margin-bottom: 0;">
@@ -5588,7 +5598,7 @@ mom about it like this:
</span>
</p>
-<!--- ENDNOTES_HEADER_UNDERSCORE --->
+<!-- -ENDNOTES_HEADER_UNDERSCORE- -->
<h5 id="endnotes-header-underscore" class="docs" style="margin-top: -1em;
margin-bottom: .5em; margin-left: .5em;">• Header (first-page title)
underscoring</h5>
@@ -5617,7 +5627,7 @@ Invoked without an argument,
<kbd>.ENDNOTES_HEADER_UNDERSCORE</kbd>
will place a single rule underneath the endnotes page title. Invoked
with the argument, <kbd>DOUBLE</kbd>, ENDNOTES_HEADER_UNDERSCORE will
double-underscore the title. Invoked with any other non-numeric
-argument, (e.g., <kbd>OFF, NO, X</kbd>, etc.) the macro disables
+argument, (e.g. <kbd>OFF, NO, X</kbd>, etc.) the macro disables
underscoring of the title.
</p>
@@ -5718,7 +5728,7 @@ with the identifying title you want, surrounded by
double-quotes.
If you don’t want any identifying title, invoke
<kbd>.ENDNOTE_TITLE</kbd> with a blank argument, either two
double-quotes side by side (<kbd>""</kbd>) or no argument
-at all. This is particularly useful if you have a single (ie
+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>
@@ -5778,7 +5788,7 @@ endnotes either by single line numbers or by line ranges.
If
what you want is a single line number, you need only invoke
<kbd>.ENDNOTE</kbd> at the appropriate place in running
text <i>without the terminating</i> <kbd>\c</kbd>. Input lines
-after the endnote has been terminated (e.g., with <kbd>.ENDNOTE
+after the endnote has been terminated (e.g. with <kbd>.ENDNOTE
OFF</kbd>) must begin at the left margin.
</p>
@@ -5792,7 +5802,7 @@ nothing to prevent you from doing so.)
</p>
<p id="en-mark">
-If you want a range of line numbers (e.g., [5-11] ),
+If you want a range of line numbers (e.g. [5-11] ),
insert, directly into the first line of the range you want, the
<a href="definitions.html#inlines">inline escape</a>,
<kbd>\*[EN-MARK]</kbd>. For the terminating line number of the
@@ -5869,7 +5879,7 @@ If you need less space (the total number of endnotes is
less than 10) or
more (the total number of endnotes is greater than 99), use the
macro
<a href="docelement.html#endnote-numbers-align">ENDNOTE_NUMBERS_ALIGN</a>,
-to set the desired amount of reserved space, e.g.,
+to set the desired amount of reserved space, e.g.
<br/>
<span class="pre-in-pp">
.ENDNOTE_NUMBERS_ALIGN RIGHT 1
@@ -6171,7 +6181,7 @@ margin note entirely and issues a warning, letting you
know what
she’s done, and where. </p>
<p>
-In the event that a margin note, sucessfully begun on a page, runs
+In the event that a margin note, successfully begun on a page, runs
past your bottom margin (or the last line before footnotes begin),
the margin note will “flow” onto the next page. If
it is a “left” margin note, it will continue in the
@@ -6204,7 +6214,7 @@ page.
<p>
Adjustments to the vertical position of margin notes must be done
-inside the margin note (ie after <kbd>.MN</kbd>), at the top,
+inside the margin note (i.e. after <kbd>.MN</kbd>), at the top,
before entering text. The commands to use are
<kbd>\!<a href="typesetting.html#ald">.ALD</a></kbd>
(to lower the margin note) and
@@ -6248,7 +6258,7 @@ If you forget to do so, mom will issue a warning and
abort.
<p>
The arguments may be entered in any order, and since the list is
long, use of the backslash character ( <kbd>\</kbd> ) to put each on
-a separate line is recommended, e.g.,
+a separate line is recommended, e.g.
<br/>
<span class="pre-in-pp">
.MN_INIT \
@@ -6358,7 +6368,7 @@ of margin notes. <kbd><LEAD></kbd> takes
<a href="definitions.html#picaspoints">points</a>
as its unit of measure, so don’t tack a unit of measure onto
the end of the argument. The default lead is the same as paragraph
-text (ie the document’s base leading).
+text (i.e. the document’s base leading).
</p>
<h4 class="docs arg-list"><kbd>COLOR <value></kbd></h4>
@@ -6388,7 +6398,7 @@ notes hyphenated.
The values can be added together, so, for example, if you want
neither the first two nor the last two characters of words
hyphenated, the hyphenation-flag would be 12. The default value is
-14 (ie 2+4+8).
+14 (i.e. 2+4+8).
</p>
<!-- -MN- -->
@@ -6499,7 +6509,7 @@ two lines of your document file, like this:
<!-- -FINIS STRING- -->
-<h3 id="finis-control" class="docs" style="margin-bottom: -1em">Finis contol
macros</h3>
+<h3 id="finis-control" class="docs" style="margin-bottom: -1em">Finis control
macros</h3>
<p>
Since FINIS is only used once in a document, it has few control
@@ -6531,7 +6541,7 @@ Double-quotes must enclose the macro’s argument.
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
-If you pass FINIS_STRING a blank string, ie
+If you pass FINIS_STRING a blank string,
<br/>
<span class="pre-in-pp">
.FINIS_STRING ""
@@ -6558,7 +6568,7 @@ this:
<span class="pre-in-pp">
.FINIS_STRING_CAPS OFF
</span>
-<kbd>OFF</kbd>, above, could be anything, e.g., <kbd>NO</kbd> or
+<kbd>OFF</kbd>, above, could be anything, e.g. <kbd>NO</kbd> or
<kbd>X</kbd>.
</p>
@@ -6568,7 +6578,7 @@ this:
<p>
Invoking the control macro <kbd>.FINIS_COLOR</kbd> with a
-pre-defined (or “initalized”) colour changes the colour
+pre-defined (or “initialized”) colour changes the colour
of both the FINIS string and the em-dashes that surround it. If you
use the
<a href="definitions.html#inline">inline escape</a>,
diff --git a/contrib/mom/momdoc/docprocessing.html
b/contrib/mom/momdoc/docprocessing.html
index 63655f6..d3442a2 100644
--- a/contrib/mom/momdoc/docprocessing.html
+++ b/contrib/mom/momdoc/docprocessing.html
@@ -130,7 +130,7 @@ FDL in the main directory of the groff source package.
<h3 class="toc toc-docproc-header"><a class="header-link"
href="#style-after-start">Changing basic type and formatting<br/><span
style="display: block; margin-top: -.3em;">parameters after
START</span></a></h3>
<ul class="toc-docproc" style="margin-top: .5em;">
<li><a href="#behaviour"><b>Behaviour of the typesetting macros during
document processing</b></a></li>
- <li><a href="docprocessing.html#intro-doc-param"><b>Changing document-wide
style parameters after START</b></a>
+ <li><a href="docprocessing.html#intro-doc-param"><b>Changing document-wide
typesetting parameters after START</b></a>
<ul class="toc-docproc">
<li><a href="docprocessing.html#index-doc-param">Post-START global style
change macros</a>
<ul class="toc-docproc">
@@ -176,7 +176,7 @@ macros that control how they look and behave.
Setting up a mom doc is a simple, four-part procedure. You
begin by entering metadata about the document itself (title,
subtitle, author, etc.). Next, you tell mom what kind of document
-you’re creating (e.g., chapter, letter, abstract, etc...) and
+you’re creating (e.g. a chapter, letter, abstract, etc...) and
what kind of output you want (typeset, typewritten, draft-style,
etc) — essentially, templates. Thirdly, you make as many
or as few changes to the templates as you wish; in other words,
@@ -206,7 +206,7 @@ documentation, so just in case:
visually 1-inch
</li>
<li>pages are numbered; the number appears centred, at the
- bottom, surrounded by hyphens ( e.g., -6- )
+ bottom, surrounded by hyphens (e.g. -6- )
</li>
<li>the first page of a document begins with a
<a href="definitions.html#docheader">document header</a>
@@ -233,7 +233,7 @@ documentation, so just in case:
Mom takes evenly-aligned bottom margins in
<a href="definitions.html#running">running text</a>
very seriously. Only under a very few, exceptional circumstances
-will she allow a bottom margin to “hang” (ie to fall
+will she allow a bottom margin to “hang” (i.e. to fall
short).
</p>
@@ -242,7 +242,7 @@ Mom offers two modes of operation for ensuring flush bottom
margins:
shimming and flex-spacing. Shimming means that mom nudges the
next line after a significant break in running text back onto the
<a href="definitions.html#baseline-grid">baseline grid</a>
-(e.g., after the insertion of a graphic). Flex-spacing means that any
+(e.g. after the insertion of a graphic). Flex-spacing means that any
vertical whitespace remaining between the end of running text and
the bottom margin is distributed equally at logical points on the
page.
@@ -266,7 +266,7 @@ afterwards with the document
<p>
What this means is that documents whose paragraphs are not separated
-by whitepace and which do not contain graphics or
+by whitespace and which do not contain graphics or
<a href="definitions.html#pre-processor">pre-processor material</a>
will fill the page completely to the bottom margin.
However, if your paragraphs are spaced, or if there are any leading
@@ -414,7 +414,7 @@ suppresses the SHIM macro, and enables flex-spacing.
</p>
<p>
-NO_SHIM with any argument (e.g., <b>OFF, QUIT, END, X</b>, etc)
+NO_SHIM with any argument (e.g. <b>OFF, QUIT, END, X</b>, etc)
re-enables shimming if it has been disabled and disables
flex-spacing.
</p>
@@ -450,8 +450,8 @@ flex-spacing
Near the bottom of some pages, you may find that
<a href="definitions.html#float">floated</a>
or
-<a href="definitions.html#preprocessor">pre-proccesor material</a>,
-including images, or a single line of text afterward, is not flush
+<a href="definitions.html#preprocessor">pre-processor material</a>,
+including images, or a single line of text afterwards, is not flush
with the bottom margin. This is a result of mom flex-spacing
<i>after</i> such material but not before. The solution to is
insert <kbd>.FLEX</kbd> immediately beforehand.
@@ -522,7 +522,7 @@ is a
<p>
It is typographically acceptable for there to be space between
-insertions in running text (e.g., an image) and the bottom margin when
+insertions in running text (e.g. an image) and the bottom margin when
the next page begins with a paragraph. If you’d like to
nudge the insertion a little closer to the bottom margin—not
all the way; that isn’t possible without pushing it to the
@@ -559,7 +559,7 @@ shimmed.
</p>
<p>
-NO_FLEX with any argument (e.g., <b>OFF, QUIT, END, X</b>, etc)
+NO_FLEX with any argument (e.g. <b>OFF, QUIT, END, X</b>, etc)
re-enables flex-spacing if it has been disabled.
</p>
@@ -678,7 +678,7 @@ macros”, and they’re essentially templates.
</p>
<ul style="margin-top: -.5em; margin-bottom: -.5em;">
<li>PRINTSTYLE—typeset or typewritten</li>
- <li>DOCTYPE—the type of document (default, chapter, user-defined,
letter)</li>
+ <li>DOCTYPE—the type of document (default, chapter, user-defined,
letter, slide)</li>
<li>COPYSTYLE —draft or final copy</li>
</ul>
@@ -1024,7 +1024,7 @@ the title of each article or entitled section), and
appears
</p>
<ol style="list-style-type: lower-alpha">
- <li>as the window title in PDF viewers (e.g., Okular or Evince)</li>
+ <li>as the window title in PDF viewers (e.g. Okular or Evince)</li>
<li>in the initial rightmost position of page headers in the document</li>
</ol>
@@ -1142,7 +1142,7 @@ Macro: <b>AUTHOR</b> <kbd class="macro-args">[COVER |
DOC_COVER] "<autho
</p>
<p>
-Each author string can hold as many names as you like, e.g.,
+Each author string can hold as many names as you like, e.g.
<br/>
<span class="pre-in-pp" style="margin-bottom: -1em;">
.AUTHOR "Joe Blow"
@@ -1315,7 +1315,7 @@ page headers.
<p>
The style of the chapter title can be altered by
<a href="docelement.html#docelement-control">control macros</a>,
-e.g., CHAPTER_TITLE_FAMILY, CHAPTER_TITLE_FONT, etc. The default
+e.g. CHAPTER_TITLE_FAMILY, CHAPTER_TITLE_FONT, etc. The default
family, font and point size are Times Roman, Bold Italic, 4 points
larger than
<a href="definitions.html#running">running text</a>.
@@ -1346,7 +1346,7 @@ possible to do either
</p>
<p>
-Mom prints the argument to <kbd>.DRAFT</kbd> (ie the draft number)
+Mom prints the argument to <kbd>.DRAFT</kbd> (i.e. the draft number)
beside the word “Draft” in the middle part of
<a href="definitions.html#header">page headers</a>.
</p>
@@ -1563,7 +1563,7 @@ or
Style parameters for the copyright line may be
entered as individual macros or
<a href="docelement.html#grouping">grouped</a>,
-e.g.,
+e.g.
<br/>
<span class="pre-in-pp">
.COPYRIGHT_FAMILY H
@@ -1744,7 +1744,7 @@ Mom generates tables of contents automatically (see
<a href="tables-of-contents.html#toc">TOC</a>).
You may sometimes want to insert a line of text into the table of
contents without it referring to a page number, for example to
-identify a “Part I” and a “Part II”.
+identify a “Part I” and a “Part II.”
</p>
<p>
@@ -1779,7 +1779,7 @@ TOC_HEADING_STYLE accepts as many or as few arguments as
you need:
FAMILY <family> \
FONT <font> \
SIZE <+|-n> \
- COLOR <color name>* \
+ COLOR <colorname>* \
QUAD L | C | R \
SPACE_ABOVE <n>** \
SPACE_BENEATH <n>**
@@ -1913,7 +1913,7 @@ the page header.
<p>
<kbd>NAMED</kbd> takes an additional argument: a name for this
-particular kind of document (e.g., outline, synopsis, abstract,
+particular kind of document (e.g. outline, synopsis, abstract,
memorandum), enclosed in double-quotes. <kbd>NAMED</kbd> is
identical to <kbd>DEFAULT</kbd> except that mom prints the argument
to <kbd>NAMED</kbd> beneath the
@@ -2093,7 +2093,7 @@ of modes and parameters.
</p>
<p>
-If you pass SLIDES the <kbd>TRANSTION</kbd> argument, you must
+If you pass SLIDES the <kbd>TRANSITION</kbd> argument, you must
at a minimum follow it with a mode. Afterwards, you may give as
many or as few parameters as you wish. Parameters are, in order,
<span class="pre-in-pp">
@@ -2158,7 +2158,7 @@ Macro: <b>NEWSLIDE</b> <kbd
class="macro-args">["<transition mode and paramet
Unless you want material from one slide to flow onto the next, you
need to tell mom when to start a new slide with the macro NEWSLIDE.
Without any arguments, the new slide will appear with the default
-TRANSTION you gave to DOCTYPE SLIDES.
+TRANSITION you gave to DOCTYPE SLIDES.
</p>
<p>
@@ -2404,12 +2404,15 @@ In PRINTSTYLE <kbd>TYPEWRITE</kbd>, mom, by default,
underlines
anything that looks like italics. This includes the
<a href="typesetting.html#slant-inline"><kbd>\*[SLANT]</kbd></a>
<a href="definitions.html#inlines">inline escape</a>
-for pseudo-italics.
+for pseudo-italics. (See
+<a href="goodies.html#underline">UNDERLINE</a>
+for a note on how to process TYPEWRITE files that underline
+italics.)
</p>
<p id="printstyle-italics">
If you’d prefer that mom were less bloody-minded
-about pretending to be a typewriter (ie you’d like italics and
+about pretending to be a typewriter (i.e., you’d like italics and
pseudo-italics to come out as italics), use the control macros
<br/>
<span class="pre-in-pp">
@@ -2461,15 +2464,6 @@ happen if the title of your document is long and your
is <kbd>DRAFT</kbd).
</p>
-<p>
-Please note that colour is disabled if your
-<a href="#printstyle">PRINTSTYLE</a>
-is <kbd>TYPEWRITE</kbd>. If you would like it enabled, for example
-so PDF links are colourzed, invoke the groff
-<a href="definitions.html#primitives">primitive</a>
-'<kbd>.color</kbd>' after PRINTSTYLE.
-</p>
-
<p class="tip-bottom">
Finally, note that colour is disabled for <kbd>TYPEWRITE</kbd>. If
you would like it enabled, for example so PDF links are colourized,
@@ -2596,7 +2590,7 @@ Macro: <b>START</b>
<p>
START takes no arguments. It simply instructs mom to begin document
-processing. If you don’t want document processing (ie you
+processing. If you don’t want document processing (i.e., you
only want the
<a href="typesetting.html#macros-typesetting">typesetting macros</a>),
don’t use START.
@@ -2627,7 +2621,7 @@ and justification style.
</p>
<p>
-Two additional style concerns have to be addressed here (ie in
+Two additional style concerns have to be addressed here (i.e. in
macros before
<a href="#start">START</a>):
changes to the
@@ -2644,7 +2638,7 @@ adjusted to fill pages fully to the bottom margin.
<li><a href="#meanings">List of meanings</a></li>
<li><a href="#lrc-note">Special note on LEFT, RIGHT and CENTER</a></li>
<li><a href="#include">Including (sourcing) style sheets and files</a></li>
- <li><a href="#color">Initializing colors</a></li>
+ <li><a href="#color">Initializing colours</a></li>
</ul></li>
<li><a href="#doc-lead-adjust">DOC_LEAD_ADJUST</a> – adjust
linespacing to fill pages and align bottom margins</li>
<li><a href="#docheader">DOCHEADER</a>
@@ -2705,7 +2699,7 @@ PRINTSTYLE.
<p class="tip">
<span class="important">Important:</span>
Do not use the macros listed in
-<a href="#doc-param-macros">Changing document-wide typesetting parameters
after START</a>
+<a href="#intro-doc-param">Changing document-wide typesetting parameters after
START</a>
prior to START; they are exclusively for use afterwards.
</p>
</div>
@@ -2720,10 +2714,10 @@ below have the following meanings:
<span class="pre">
L_MARGIN Left margin of pages, including headers/footers
R_MARGIN Right margin of pages, including headers/footers
- T_MARGIN The point at which running text (ie not
+ T_MARGIN The point at which running text (i.e. not
headers/footers or page numbers) starts on each
page
- B_MARGIN* The point at which running text (ie not
+ B_MARGIN* The point at which running text (i.e. not
(see note) headers/footers or page numbers) ends on each page
PAGE If you use PAGE, its final four arguments have the
@@ -2735,7 +2729,7 @@ below have the following meanings:
FAMILY The family of all type in the document
PT_SIZE The point size of type in paragraphs; mom uses
this to calculate automatic point size changes
- (e.g., for heads, footnotes, quotes, headers, etc)
+ (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
@@ -2764,7 +2758,7 @@ If you want to change any of the basic parameters (above)
<i>after</i> START and have them affect a document globally (as if
you’d entered them <i>before</i> START), you must use the macros
listed in
-<a href="#doc-param-macros">Changing document-wide style parameters after
START</a>.
+<a href="#intro-doc-param">Changing document-wide typesetting parameters after
START</a>.
</p>
<h4 id="lrc-note" class="docs">Special note on LEFT, RIGHT and CENTER prior to
START</h4>
@@ -2798,8 +2792,9 @@ or <kbd>.CENTER</kbd> immediately after every invocation
of the tag.
If you routinely make the same changes to mom’s defaults in
order to create similar documents in a similar style—in other
words, you need a template— you can create style-sheet files
-and include, or "source", them into your mom documents with the
-macro INCLUDE. The right place for such style sheets is after
+and include, or “source”, them into your mom documents
+with the macro INCLUDE. The right place for such style sheets is
+after
<a href="#printstyle">PRINTSTYLE</a>
and before
<a href="#start">START</a>.
@@ -2894,7 +2889,7 @@ The macro
<a href="color.html#color">COLOR</a>
and the
<a href="definitions.html#inlines">inline escape</a>,
-<a href="color.html#color-inline"><kbd>\*[<colourname>]</kbd></a>
+<a href="color.html#color-inline"><kbd>\*[<colorname>]</kbd></a>
can be used at any time during document processing for occasional
colour effects. However, consistent and reliable colourizing of
various document elements (the docheader, heads, linebreaks,
@@ -3077,7 +3072,7 @@ argument.
This starts the document 1.5 inches from the top of the page PLUS
whatever spacing adjustment mom has to make in order to ensure that
the first baseline of running text falls on a “valid”
-baseline (ie one that ensures that the bottom margin of the first
+baseline (i.e. one that ensures that the bottom margin of the first
page falls where it should). The distance is measured from the top
edge of the paper to the
<a href="definitions.html#baseline">baseline</a>
@@ -3251,7 +3246,7 @@ to place them where you want.
<p>
By default, mom centres the docheader. If you’d prefer to
have your docheaders set flush left or right, or need to restore
-the default centreing, invoke <kbd>.DOCHEADER_QUAD</kbd> with the
+the default centering, invoke <kbd>.DOCHEADER_QUAD</kbd> with the
quad direction you want, either <kbd>LEFT</kbd> (or <kbd>L</kbd>),
<kbd>RIGHT</kbd> (or <kbd>R</kbd>) or <kbd>CENTER</kbd> (or
<kbd>C</kbd>).
@@ -3316,7 +3311,7 @@ by which to make the adjustment.
Whenever you want to change the style parameters for any part of
the docheader, simply join the name of the part to the parameter
you wish to change using an underscore, then supply any necessary
-arguments. The subitle double-underlined? No problem.
+arguments. The subtitle double-underlined? No problem.
<br/>
<span class="pre-in-pp">
.SUBTITLE_UNDERLINE DOUBLE
@@ -3360,7 +3355,7 @@ as the name for the string passed to <kbd>DOCTYPE
NAMED "string"</kbd>.
<dt class="params">_COLOR</dt>
<dd>
Takes the same argument as <a href="color.html#color">COLOR</a>.
- Colors should be pre-initialized with
+ Colours should be pre-initialized with
<a href="color.html#xcolor">XCOLOR</a>
or
<a href="color.html#newcolor">NEWCOLOR</a>.
@@ -3892,7 +3887,7 @@ the tops of pages after the first.)
<a id="autolead" style="margin-top: -1em">AUTOLEAD</a> •Invoked
before START, sets the overall document
leading as a function of the overall document
- point size (ie the point size used in paragraphs);
+ point size (i.e. the point size used in paragraphs);
subsequently disabled after START, except for calls
to DOC_PT_SIZE
@@ -3902,7 +3897,7 @@ the tops of pages after the first.)
•Invoked after START, remains in effect for all
subsequent point size changes made with PT_SIZE,
but does not affect the leading of the document
- element tags (e.g., HEADING, PP, QUOTE...), or calls
+ element tags (e.g. HEADING, PP, QUOTE...), or calls
to DOC_PT_SIZE
QUAD •Changes quad for the duration of the
@@ -3992,7 +3987,7 @@ If your
<a href="#doctype">DOCTYPE</a>
is DEFAULT, CHAPTER, NAMED, or LETTER, ADD_SPACE takes as its
single argument the distance you want mom to advance from the normal
-baseline position at the top of any page <i>after the first</i> (ie
+baseline position at the top of any page <i>after the first</i> (i.e.
the one on which the docheader is normally printed). A
<a href="definitions.html#unitofmeasure">unit of measure</a> is
required.
@@ -4049,7 +4044,7 @@ RESTORE_SPACE before issuing the spacing command.
<!-- *** -->
-<h2 id="intro-doc-param" class="macro-group">Changing document-wide style
parameters after START</h2>
+<h2 id="intro-doc-param" class="macro-group">Changing document-wide
typesetting parameters after START</h2>
<p>
In the normal course of things, you establish the basic type style
@@ -4118,7 +4113,7 @@ Macro: <b>DOC_LEFT_MARGIN</b> <kbd
class="macro-args"><left margin></kbd>
<li>any document elements that use a left indent calculate
the indent from the new value
</li>
- <li>the line length remains the same (ie the right margin
+ <li>the line length remains the same (i.e., the right margin
shifts when you change the left margin)
</li>
</ul>
@@ -4208,7 +4203,7 @@ Macro: <b>DOC_FAMILY</b> <kbd
class="macro-args"><family></kbd>
<li><a href="docelement.html#endnote-intro">endnotes pages</a></li>
<li><a href="docelement.html#toc-intro">table of contents</a></li>
</ul></li>
- <li>any page elements (e.g., headers page numbers, footnotes) whose
+ <li>any page elements (e.g. headers page numbers, footnotes) whose
families you wish to remain at their old values must be
reset with the appropriate
<a href="docelement.html#docelement-control">control macros</a>
@@ -4335,7 +4330,7 @@ You need do nothing special to terminate a document.
When groff
finishes processing the last
<a href="definitions.html#inputline">input line</a>
of a file, the page is ejected, subject to whatever routines are
-needed to complete it (e.g., printing footnotes or adding the page
+needed to complete it (e.g. printing footnotes or adding the page
number).
</p>
@@ -4349,7 +4344,7 @@ page at the end of the formatted document.
<p>
The situation is rare, generally occurring only when some additional
-macro is required after the input text, e.g., to exit a
+macro is required after the input text, e.g. to exit a
<a href="docelement.html#list-intro">list</a>
or terminate a
<a href="docelement.html#quote">quote</a>.
diff --git a/contrib/mom/momdoc/goodies.html b/contrib/mom/momdoc/goodies.html
index 6bf3a5d..ce0c6c5 100644
--- a/contrib/mom/momdoc/goodies.html
+++ b/contrib/mom/momdoc/goodies.html
@@ -64,7 +64,7 @@ nearly indispensable) routines to simplify typesetting.
<li class="list-head-goodies text-color"><a
href="#underscore">UNDERSCORE</a> <span class="normal-smaller">– single
underscore</span>
<ul class="sublist sub">
<li class="list-head-goodies text-color"><a
href="#underscore-weight">Controlling the weight of underscores</a></li>
- <li class="list-head-goodies text-color"><a
href="#underscore-color">Colorizing underscores</a></li>
+ <li class="list-head-goodies text-color"><a
href="#underscore-color">Colourising underscores</a></li>
</ul></li>
<li class="list-head-goodies text-color"><a
href="#underscore2">UNDERSCORE2</a> <span class="normal-smaller">– double
underscore</span></li>
<li class="list-head-goodies text-color"><a href="#underline">UNDERLINE</a>
@@ -289,7 +289,7 @@ disappearing into a black hole.
<!-- -TRAP- -->
<div class="macro-id-overline">
-<h3 id="trap" class="macro-id">Suspend/re-invoke traps</h3>
+<h3 id="trap" class="macro-id">Suspend / re-invoke traps</h3>
</div>
<div class="box-macro-args">
@@ -313,7 +313,7 @@ happens, surround just the offending macros and input lines
with
...
.TRAP
</span>
-TRAP is a toggle, therefore any argument turns it off (ie suspends
+TRAP is a toggle, therefore any argument turns it off (i.e., suspends
the trap), and no argument turns it (back) on.
</p>
@@ -359,7 +359,7 @@ And you don’t want to look like an amateur, do you?
If you invoke SMARTQUOTES with one of the optional arguments
(<kbd>,,</kbd> or <kbd>>></kbd>
or <kbd><<</kbd>) you can use
-<kbd>"</kbd> (ie the inch-mark/doublequotes key)
+<kbd>"</kbd> (i.e. the inch-mark/doublequotes key)
as “cheap” open-and close-quotes when inputting text in
a language other than English, and have mom convert them, on output,
into the chosen open-and close-quote style.
@@ -789,7 +789,7 @@ UNDERSCORE_WEIGHT also sets the weight of
</p>
</div>
-<h3 id="underscore-color" class="docs">Colorizing underscored text</h3>
+<h3 id="underscore-color" class="docs">Colourising underscored text</h3>
<p>
If you want underscored text to be in a different colour from the
text around it, use the
@@ -852,7 +852,7 @@ If you wish to change the distance of the double underscore
from the
<a href="definitions.html#baseline">baseline</a>,
use the optional argument
<kbd><distance below baseline></kbd>
-(with a unit of measure), e.g.,
+(with a unit of measure), e.g.
<br/>
<span class="pre-in-pp">
.UNDERSCORE2 3p "Unmonitored monopolies breed high prices and poor products."
@@ -907,20 +907,32 @@ Macro: <b>UNDERLINE</b> <kbd
class="macro-args">toggle</kbd>
The distinction between underscoring and underlining is that
underscoring is suitable for occasional effects (a word here,
a phrase there), whereas underlining underlines whole passages
-of type. Furthermore, you cannot colorize underlining, and
+of type. Furthermore, you cannot colourise underlining, and
there’s a special macro
<a href="#underline-specs">UNDERLINE_SPECS</a>
to control the weight and distance from the baseline of the
-underline. Lastly, files that use UNDERLINE must be processed with
+underline.
+
+<p>
+Lastly, files that use UNDERLINE must be processed with
<br/>
<span class="pre-in-pp">
pdfmom -Tps filename.mom | ps2pdf - filename.pdf
</span>
-since groff’s native pdf driver does not recognize UNDERLINE.
+since groff’s pdf driver does not recognize UNDERLINE.
+</p>
+Note that
+<a href="docprocessing.html#printstyle">PRINTSTYLE TYPEWRITE</a>
+uses UNDERLINE to underline italics
+and pseudo-italics (<a href="typesetting.html#slant-inline">SLANT</a>)
+by default. The default may be changed (see
+<a href="docprocessing.html#printstyle-italics">Underlining of italics</a>)
+but if it's what you want, you must process your document as shown
+above.
</p>
<p>
-UNDERLINE is a toggle macro, therefore you invoke it by itself (ie
+UNDERLINE is a toggle macro, therefore you invoke it by itself (i.e.
with no argument) to initiate underlining, and with any argument
(<kbd>OFF, QUIT, X,</kbd> etc) to turn it off.
</p>
@@ -1340,7 +1352,7 @@ When using the
DROPCAP only works
</p>
<ul style="margin-top: -1em; margin-bottom: 0;">
- <li>with initial paragraphs (ie at the start of the document,
+ <li>with initial paragraphs (i.e. at the start of the document,
or after
<a href="docelement.html#head">HEAD</a>),</li>
<li>when <kbd>.DROPCAP</kbd> comes immediately after <kbd>.PP</kbd>,</li>
diff --git a/contrib/mom/momdoc/graphical.html
b/contrib/mom/momdoc/graphical.html
index 0fb5f6e..6216f12 100644
--- a/contrib/mom/momdoc/graphical.html
+++ b/contrib/mom/momdoc/graphical.html
@@ -173,34 +173,19 @@ The order of arguments to the graphical object macros is
the same
for every macro:
</p>
<ul style="margin-top: -.5em; margin-bottom: -.5em;">
- <li>the <kbd><span style="text-decoration: underline">W</span></kbd>eight of
the rule
+ <li>the rule weight
<ul style="margin-left: -.75em;">
- <li>if the object is enclosed (i.e. is a box or circle), the
- weight of the rule if you want the object outlined</li>
- <li>the single word, <kbd>SOLID</kbd>, may be used in place
- of the <b>weight</b> argument if you want the
- object filled</li>
+ <li>the single word <kbd>SOLID</kbd> may be used in place
+ of <kbd>weight</kbd> if you want boxes or circles filled</li>
</ul></li>
- <li>the <kbd><span style="text-decoration: underline">I</span></kbd>ndent
from the current left margin at
- which to begin the object</li>
- <li>the <kbd><span style="text-decoration: underline">L</span></kbd>ength of
the object, if applicable</li>
- <li>the <kbd><span style="text-decoration: underline">D</span></kbd>epth of
the object, if applicable</li>
- <li>the <kbd><span style="text-decoration: underline">C</span></kbd>olour of
the object (optional)</li>
+ <li>the indent from the current left margin at which to begin
+ the object
+ </li>
+ <li>the width of the object if applicable</li>
+ <li>the depth of the object if applicable</li>
+ <li>the colour of the object (optional)</li>
</ul>
-<p>
-A simple mnemonic for the order of arguments is “<b>WILD
-C</b>ard”. If you fix the mnemonic in your brain and apply
-a little judicious reasoning, you’ll always remember how to
-draw graphical objects. The “judicious reasoning” means
-that, for example, horizontal rules don’t require a depth and
-vertical rules don’t require a length. Thus, in the case of
-drawing a horizontal rule, you supply the macro
-<kbd><a href="#drh">DRH</a></kbd>
-with only the arguments (from the mnemonic) that apply: <b>W-I-L</b> (and
-possibly <b>C</b>).
-</p>
-
<div class="macro-list-container">
<h3 id="index-graphical" class="macro-list">Graphical objects macros</h3>
@@ -223,7 +208,7 @@ possibly <b>C</b>).
</div>
<div class="box-macro-args">
-Macro: <b>DRH</b> <kbd class="macro-args"><none> | <weight>
<indent> <length> [<colour>]</kbd>
+Macro: <b>DRH</b> <kbd class="macro-args"><none> | <weight>
<indent> <width> [<colour>]</kbd>
</div>
<p class="requires">
@@ -237,14 +222,14 @@ but do <span class="normal">NOT</span> append the
•
<kbd class="normal"><indent></kbd>
and
-<kbd class="normal"><length></kbd>
+<kbd class="normal"><width></kbd>
require a unit of measure
<br/>
•
arithmetic expressions to
<kbd class="normal"><indent></kbd>
and
-<kbd class="normal"><length></kbd>
+<kbd class="normal"><width></kbd>
must be surrounded by parentheses
</p>
@@ -269,19 +254,19 @@
href="inlines.html#inline-rule-mom"><kbd>\*[RULE]</kbd></a>.
</div>
<p style="margin-top: -.5em;">
-To draw horizontal rules of a specified length, you must, at
+To draw horizontal rules of a specified width, you must, at
a minimum, supply DRH with the arguments <kbd>weight,</kbd>
<kbd>indent</kbd> (measured from the current left margin) and
-<kbd>length</kbd>.
+<kbd>width</kbd>.
</p>
<p>
-Optionally, you may give a <kbd>colour</kbd> argument. The colour
+Optionally, you may give a <kbd>color</kbd> argument. The colour
may be either one defined with
<a href="color.html#newcolor">NEWCOLOR</a>,
-or a named X-colour inititialized with
+or a named X-color initialized with
<a href="color.html#xcolor">XCOLOR</a>,
-or an X-colour alias (again, initialized with XCOLOR).
+or an X-color alias (again, initialized with XCOLOR).
</p>
<p>
@@ -290,7 +275,7 @@ that starts 2 picas from the current left margin and runs
for 3
inches. To do so, you’d invoke <kbd>.DRH</kbd> like this:
<br/>
<span class="pre-in-pp">
- weight length
+ weight width
| |
.DRH 1.25 2P 3i
|
@@ -357,25 +342,25 @@ must be surrounded by parentheses
</p>
<p>
-To draw vertical rules of a specified length, you must, at
+To draw vertical rules of a specified depth, you must, at
a minimum, supply DRV with the arguments <kbd>weight,</kbd>
<kbd>indent</kbd> (measured from the current left margin) and
<kbd>depth</kbd>.
</p>
<p>
-Optionally, you may give a <kbd>colour</kbd> argument. The colour
+Optionally, you may give a <kbd>color</kbd> argument. The colour
may be either one defined with
<a href="color.html#newcolor">NEWCOLOR</a>,
-or a named X-colour inititialized with
+or a named X-color initialized with
<a href="color.html#xcolor">XCOLOR</a>,
-or an X-colour alias (again, initialized with XCOLOR).
+or an X-color alias (again, initialized with XCOLOR).
</p>
<p>
Say, for example, you want to draw a 3/4-point vertical rule that
starts 19-1/2 picas from the current left margin and has a depth of
-6 centimeters. To do so, you’d invoke <kbd>.DRV</kbd> like
+6 centimetres. To do so, you’d invoke <kbd>.DRV</kbd> like
this:
<br/>
<span class="pre-in-pp">
@@ -403,7 +388,7 @@ If, in addition, you want the rule red:
Vertical rules are drawn from the baseline down, and from left to
right. "Left to right" means that if you request a rule
with a weight of four points, the four points of rule fall entirely
-to the left of the indent given to DRV.
+to the right of the indent given to DRV.
</p>
<p>
@@ -420,7 +405,7 @@ either horizontal or vertical.
</div>
<div class="box-macro-args">
-Macro: <b>DBX</b> <kbd class="macro-args">< <weight> | SOLID >
<indent> <length> <depth> [<colour>]</kbd>
+Macro: <b>DBX</b> <kbd class="macro-args"><weight>|SOLID <indent>
<width>|FULL_MEASURE <depth> [<color>]</kbd>
</div>
<p class="requires">
@@ -432,7 +417,7 @@ but do <span class="normal">NOT</span> append the
<kbd class="normal">p</kbd>
<br/>
• <kbd class="normal"><indent></kbd>,
-<kbd class="normal"><length></kbd>,
+<kbd class="normal"><width></kbd>,
and
<kbd class="normal"><depth></kbd>
require a unit of measure
@@ -440,26 +425,60 @@ require a unit of measure
•
arithmetic expressions to
<kbd class="normal"><indent></kbd>,
-<kbd class="normal"><length></kbd>,
+<kbd class="normal"><width></kbd>,
and
<kbd class="normal"><depth></kbd>
-must be surrounded by parentheses
+must be enclosed in parentheses.
+</p>
+
+<p>
+To draw boxes you must, at a minimum, supply DBX with the arguments
+<kbd>weight</kbd> or <kbd>SOLID</kbd>, <kbd>indent</kbd>,
+<kbd>width</kbd> or <kbd>FULL_MEASURE</kbd>, and <kbd>depth</kbd>.
+</p>
+
+<p>
+<kbd>weight</kbd> is the rule weight of outlined boxes, given in
+points but without the unit of measure
+<a href="definitions.html#unitsofmeasure">unit of measure</a>
+<kbd>p</kbd> appended.
+</p>
+
+<p>
+If <kbd>SOLID</kbd> is given as the first argument, the box is
+filled rather than outlined and no <kbd>weight</kbd> argument should
+be supplied.
+</p>
+
+<p>
+<kbd>indent</kbd> is measured from the current left margin. If
+<kbd>FULL_MEASURE</kbd> is given, <kbd>indent</kbd> should be set to
+“0”.
+</p>
+
+<p>
+<kbd>width</kbd> is the width of the box with a
+<a href="definitions.html#unitsofmeasure">unit of measure</a>
+appended, caclculated from <kbd>indent</kbd> argument.
</p>
<p>
-To draw boxes of specified dimensions, you must, at a minimum,
-supply DBX with the arguments <kbd>weight</kbd> or <kbd>SOLID</kbd>,
-<kbd>indent</kbd> (measured from the current left margin),
-<kbd>length</kbd> and <kbd>depth</kbd>.
+If <kbd>FULL_MEASURE</kbd> is given instead of <kbd>width</kbd>,
+it circumvents having to calculate the width when left and/or right
+indents are in effect; mom draws the box from the current left
+margin to the current right margin. When no indents are in effect,
+<kbd>FULL_MEASURE</kbd> or <kbd>\n[.l]u</kbd>—the groff
+way of saying “the current line length”—have the
+same effect.
</p>
<p>
-Optionally, you may give a <kbd>colour</kbd> argument. The colour
+Optionally, you may give a <kbd>color</kbd> argument. The colour
may be either one defined with
<a href="color.html#newcolor">NEWCOLOR</a>,
-or a named X-colour inititialized with
+or a named X-color initialized with
<a href="color.html#xcolor">XCOLOR</a>,
-or an X-colour alias (again, initialized with XCOLOR).
+or an X-color alias (again, initialized with XCOLOR).
</p>
<p>
@@ -473,7 +492,7 @@ like this:
| |
.DBX .5 1i 12P 6P
| |
- weight length
+ weight width
</span>
(Note that the box weight argument, which is expressed in points,
must NOT have the unit of measure <kbd>p</kbd> appended to it.)
@@ -490,7 +509,9 @@ Additionally, if you want the box green:
<br/>
<span class="pre-in-pp">
.DBX .5 1i 12P 6P green
- or
+</span>
+or
+<span class="pre-in-pp">
.DBX SOLID 1i 12P 6P green
</span>
</p>
@@ -519,20 +540,19 @@ either horizontal or vertical.
</div>
<div class="box-macro-args">
-Macro: <b>DCL</b> <kbd class="macro-args">< <weight> | SOLID >
<indent> <length> <depth> [<colour>]</kbd>
+Macro: <b>DCL</b> <kbd class="macro-args"><weight>|SOLID <indent>
<width>|FULL_MEASURE <depth> [<color>]</kbd>
</div>
<p class="requires">
-• the argument to <kbd class="normal"><weight></kbd> is in
+•
+the argument to <kbd class="normal"><weight></kbd> is in
<a href="definitions.html#picaspoints" class="normal">points</a>,
but do <span class="normal">NOT</span> append the
-<a href="definitions.html#unitsofmeasure">unit of measure</a>,
+<a href="definitions.html#unitsofmeasure">unit of measure</a>
<kbd class="normal">p</kbd>
<br/>
-•
-the arguments
-<kbd class="normal"><indent></kbd>,
-<kbd class="normal"><length></kbd>
+• <kbd class="normal"><indent></kbd>,
+<kbd class="normal"><width></kbd>,
and
<kbd class="normal"><depth></kbd>
require a unit of measure
@@ -540,62 +560,98 @@ require a unit of measure
•
arithmetic expressions to
<kbd class="normal"><indent></kbd>,
-<kbd class="normal"><length></kbd>
+<kbd class="normal"><width></kbd>,
and
<kbd class="normal"><depth></kbd>
-must be surrounded by parentheses
+must be enclosed in parentheses.
+</p>
+
+<p>
+To draw circles you must, at a minimum, supply DCL with the arguments
+<kbd>weight</kbd> or <kbd>SOLID</kbd>, <kbd>indent</kbd>,
+<kbd>width</kbd> or <kbd>FULL_MEASURE</kbd>, and <kbd>depth</kbd>.
+</p>
+
+<p>
+<kbd>weight</kbd> is the rule weight of outlined circles, given in
+points but without the unit of measure
+<a href="definitions.html#unitsofmeasure">unit of measure</a>
+<kbd>p</kbd> appended.
</p>
<p>
-To draw circles of specified dimensions, you must, at a minimum,
-supply DCL with the arguments <kbd>weight</kbd> or <kbd>SOLID</kbd>,
-<kbd>indent</kbd> (measured from the current left margin),
-<kbd>length</kbd> and <kbd>depth</kbd>.
+If <kbd>SOLID</kbd> is given as the first argument, the circle is
+filled rather than outlined and no <kbd>weight</kbd> argument should
+be supplied.
+</p>
+
+<p>
+<kbd>indent</kbd> is measured from the current left margin. If
+<kbd>FULL_MEASURE</kbd> is given, <kbd>indent</kbd> should be set to
+“0”.
+</p>
+
+<p>
+<kbd>width</kbd> is the width of the circle with a
+<a href="definitions.html#unitsofmeasure">unit of measure</a>
+appended, caclculated from <kbd>indent</kbd> argument.
</p>
<p>
-Optionally, you may give a <kbd>colour</kbd> argument. The colour
+If <kbd>FULL_MEASURE</kbd> is given instead of <kbd>width</kbd>,
+it circumvents having to calculate the width when left and/or right
+indents are in effect; mom draws the circle from the current left
+margin to the current right margin. When no indents are in effect,
+<kbd>FULL_MEASURE</kbd> or <kbd>\n[.l]u</kbd>—the groff
+way of saying “the current line length”—have the
+same effect.
+</p>
+
+<p>
+Optionally, you may give a <kbd>color</kbd> argument. The colour
may be either one defined with
<a href="color.html#newcolor">NEWCOLOR</a>,
-or a named X-colour inititialized with
+or a named X-color initialized with
<a href="color.html#xcolor">XCOLOR</a>,
-or an X-colour alias (again, initialized with XCOLOR).
+or an X-color alias (again, initialized with XCOLOR).
</p>
<p>
-Say, for example, you want to draw a 1/2 point outline circle
-(ellipse, actually, in this case) that starts one inch from the
-current left margin and has the dimensions 6 centimeters x 3
-centimeters. To do so, you’d invoke <kbd>.DCL</kbd> like
-this:
+Say, for example, you want to draw a 1/2 point outline circle that
+starts one inch from the current left margin and has the dimensions
+12 picas x 6 picas. To do so, you’d invoke <kbd>.DCL</kbd>
+like this:
<br/>
<span class="pre-in-pp">
- indent depth
- | |
- .DCL .5 1i 6c 3c
- | |
- weight length
+ indent depth
+ | |
+ .DCL .5 1i 12P 6P
+ | |
+ weight width
</span>
-(Note that the box weight argument, which is expressed in points,
+(Note that the circle weight argument, which is expressed in points,
must NOT have the unit of measure <kbd>p</kbd> appended to it.)
</p>
<p>
-If you want the same box, but solid (“filled”) rather
+If you want the same circle, but solid (“filled”) rather
than drawn as an outline:
<br/>
<span class="pre-in-pp">
- .DCL SOLID 1i 6c 3c
+ .DCL SOLID 1i 12P 6P
</span>
-Additionally, if you want the circle yellow:
+Additionally, if you want the circle green:
<br/>
<span class="pre-in-pp">
- .DCL .5 1i 6c 3c yellow
- or
- .DCL SOLID 1i 6c 3c yellow
+ .DCL .5 1i 12P 6P green
+</span>
+or
+<span class="pre-in-pp">
+ .DCL SOLID 1i 12P 6P green
</span>
</p>
+
<h3 class="docs">How mom handles the positioning of circles (ellipses)</h3>
<p>
diff --git a/contrib/mom/momdoc/headfootpage.html
b/contrib/mom/momdoc/headfootpage.html
index 3d60c15..6e2d014 100644
--- a/contrib/mom/momdoc/headfootpage.html
+++ b/contrib/mom/momdoc/headfootpage.html
@@ -161,7 +161,7 @@ page element.
<div id="author-note" class="box-tip">
<p class="tip">
<span class="note">Author’s note:</span>
-Left to their own devices (ie if you’re happy with the way
+Left to their own devices (i.e. if you’re happy with the way
mom does things by default), headers are something you never have to
worry about. You can skip reading this section entirely. But if
you want to change them, be advised that headers have more macros to
@@ -199,12 +199,14 @@ nor based upon it. <kbd>.tl</kbd> is not used at all in
mom.
<p>
Normally, mom fills headers with strings appropriate 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, colour and capitalization style
-(caps, caps/lower-case, or smallcaps) for each header part individually.
+type selected by
+<a href="docprocessing.html#doctype">DOCTYPE</a>,
+with the author left, the document title right, and chapter or
+document type information in the centre. 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, colour and capitalization style (caps, caps/lower-case,
+or smallcaps) for each header part individually.
</p>
<p>
@@ -426,7 +428,7 @@ Macro: <b>HEADERS</b> <kbd class="macro-args">toggle</kbd>
<a href="definitions.html#header">Page headers</a>
are on by default. If you don’t want them, turn them off by
invoking <kbd>.HEADERS</kbd> with any argument (<b>OFF, QUIT,
-END, X...</b>), e.g.,
+END, X...</b>), e.g.
<br/>
<span class="pre-in-pp">
.HEADERS OFF
@@ -473,7 +475,7 @@ Macro: <b>FOOTERS</b> <kbd class="macro-args">toggle</kbd>
are off by default. If you want them instead of
<a href="definitions.html#header">headers</a>,
turn them on by invoking
-<kbd>.FOOTERS</kbd> without an argument, e.g.,
+<kbd>.FOOTERS</kbd> without an argument, e.g.
<br/>
<span class="pre-in-pp">
.FOOTERS
@@ -543,7 +545,7 @@ to headers/footers) can be designed to your own
specifications.
</ul></li>
<li><a href="#hdrftr-right">HEADER_RIGHT</a></li>
<li><a href="#reserved-strings">Using mom’s reserved strings in
header/footer definitions</a>
- (e.g., <kbd>\E*[$TITLE]</kbd> when you want
+ (e.g. <kbd>\E*[$TITLE]</kbd> when you want
the title, <kbd>\E*[$AUTHOR]</kbd> when you want the author, etc.)
</li>
<li><a href="#page-number-symbol">Replacing header-left, centre or right
with the page number</a></li>
@@ -724,7 +726,7 @@ are:
\E*[$AUTHOR_1...9] —the current arguments passed to .AUTHOR
\E*[$AUTHORS] —a comma-separated concatenated string
of all the current arguments passed to .AUTHOR
- (ie a list of authors)
+ (i.e. a list of authors)
\E*[$CHAPTER_STRING] —the current argument passed to .CHAPTER_STRING,
if invoked, otherwise, "Chapter"
\E*[$CHAPTER] —the current argument (typically a number) passed
@@ -1047,7 +1049,7 @@ or as defined by you with the
simply invoke this macro (using the appropriate position) with no
argument. If you wish to turn capitalization off (say, for the
header-right string that mom capitalizes by default), invoke the
-macro with any argument (e.g., <kbd>OFF, QUIT, END, X</kbd>...).
+macro with any argument (e.g. <kbd>OFF, QUIT, END, X</kbd>...).
</p>
<p>
@@ -1065,7 +1067,7 @@ HEADER_<POSITION>_SMALLCAPS is a
If you want any part of headers to be set in smallcaps, simply
invoke this macro (using the appropriate position) with no argument.
If you wish to turn the smallcaps off, invoke the macro with any
-argument (e.g., <kbd>OFF, QUIT, END, X</kbd>...).
+argument (e.g. <kbd>OFF, QUIT, END, X</kbd>...).
</p>
<p>
@@ -1232,7 +1234,7 @@ you’d use HEADER_MARGIN to change their baseline
placement.
<p class="tip-top">
<span class="important" style="display: block; margin-bottom: -1em;">Important
– FOOTER_MARGIN and bottom margins</span>
<br/>
-Mom requires a footer margin (ie the distance from the bottom of
+Mom requires a footer margin (i.e. the distance from the bottom of
the page at which to place footers) for proper operation, hence she
sets one, even if you don’t. As stated above, her default
footer margin is 3-picas.
@@ -1419,7 +1421,7 @@ Macro: <b>HEADER_RULE</b> <kbd
class="macro-args">toggle</kbd>
By default, mom prints a header separator rule underneath headers
(or above footers). If you don’t want the rule, turn it off by
invoking <kbd>.HEADER_RULE</kbd> with any argument (<kbd>OFF, QUIT,
-END, X...</kbd>), e.g.,
+END, X...</kbd>), e.g.
<br/>
<span class="pre-in-pp">
.HEADER_RULE OFF
@@ -1502,7 +1504,7 @@ to the bottom edge of the rule.) A unit of measure is
required, and
decimal fractions are allowed. Please note that HEADER_RULE_GAP has
no effect on
<a href="#hdrftr-gap">HEADER_GAP</a>
-(ie HEADER_RULE_GAP is NOT added to HEADER_GAP when mom calculates
+(i.e., HEADER_RULE_GAP is NOT added to HEADER_GAP when mom calculates
the space between headers and the start of
<a href="definitions.html#running">running text</a>).
</p>
@@ -1782,7 +1784,7 @@ Notice that the quad argument, <kbd>LEFT</kbd>, is used
in both
cases. When padding a header, it doesn’t matter which
quad argument you use, although you must be sure to supply
one. Also note that mom does not interpret the <kbd>#</kbd> in
-<kbd>\*[PAGE#]</kbd> as a padding marker (ie as a place to insert
+<kbd>\*[PAGE#]</kbd> as a padding marker (i.e. as a place to insert
whitespace).
</p>
@@ -1902,7 +1904,7 @@ to the style shown above to keep things manageable.
<p>
If you want to disable having both headers and footers on the same
page, invoke <kbd>.HEADERS_AND_FOOTERS</kbd> with any argument
-you want (e.g., <kbd>OFF, QUIT, END, X...</kbd>). Mom will restore
+you want (e.g. <kbd>OFF, QUIT, END, X...</kbd>). Mom will restore
her default behaviour of setting automatically generated page
headers, with the page number, centered, at the bottom of the
page. If you would prefer footers instead of headers after turning
@@ -2023,7 +2025,7 @@ Macro: <b>PAGINATE</b> <kbd
class="macro-args">toggle</kbd>
By default, mom paginates documents (in the bottom margin). If
you’d prefer she not paginate, turn pagination off by invoking
<kbd>.PAGINATE</kbd> with any argument (<kbd>OFF, NO, QUIT, END,
-X...</kbd>), e.g.,
+X...</kbd>), e.g.
<br/>
<span class="pre-in-pp">
.PAGINATE NO
@@ -2196,7 +2198,7 @@ using PAGENUMBER_STYLE.*
<span class="pre defaults">
.PAGENUM_FAMILY default = prevailing document family
.PAGENUM_FONT default = roman
-.PAGENUM_SIZE default = +0 (ie same size as paragraph text)
+.PAGENUM_SIZE default = +0 (i.e. same size as paragraph text)
.PAGENUM_COLOR default = black
</span>
</div>
@@ -2287,7 +2289,7 @@ one blank page, you have to tell mom:
</span>
The optional argument, <kbd>DIVIDER</kbd>, must be given if
you’re inserting a blank page before the start of any new
-document section (ie a new chapter, or endnotes, a bibliography,
+document section (i.e. a new chapter, or endnotes, a bibliography,
or table of contents). Without the <kbd>DIVIDER</kbd> argument, mom
simply inserts the blank pages and prepares the next page to receive
<a href="definitions.html#running">running text</a>.
diff --git a/contrib/mom/momdoc/inlines.html b/contrib/mom/momdoc/inlines.html
index 39efd3a..ad77e63 100644
--- a/contrib/mom/momdoc/inlines.html
+++ b/contrib/mom/momdoc/inlines.html
@@ -211,7 +211,7 @@ and/or
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you must enter the inlines beginning with <kbd>\E*</kbd>
-rather than just <kbd>\*</kbd>, e.g., <kbd>\E*[BD]</kbd>.
+rather than just <kbd>\*</kbd>, e.g. <kbd>\E*[BD]</kbd>.
</p>
</div>
@@ -382,7 +382,7 @@ For backward compatibility, the forms
\*[BU1]...\*[BU36] Move backward 1...36 <a
href="definitions.html#kernunit">kern units</a>
\*[FU1]...\*[FU36] Move forward 1...36 <a
href="definitions.html#kernunit">kern units</a>
</span>
-also exist (ie with no space before the number of kern units desired,
+also exist (i.e. with no space before the number of kern units desired,
up to a limit of 36).
</p>
@@ -416,9 +416,9 @@ and/or
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you <i>must</i> use the forms <kbd>\E*[BU<n>]</kbd>
-and <kbd>\E*[FU<n>]</kbd> (ie with no space), and enter the
+and <kbd>\E*[FU<n>]</kbd> (i.e. with no space), and enter the
inline beginning with <kbd>\E*</kbd> rather than just <kbd>\*</kbd>,
-e.g., <kbd>\E*[BU4]</kbd>.
+e.g. <kbd>\E*[BU4]</kbd>.
</p>
<p class="tip-bottom">
@@ -476,7 +476,7 @@ For backward compatibility, the forms
\*[BP.25]...\*[BP12.75] Move backward .25...12.75 points
\*[FP.25]...\*[FP12.75] Move forward .25...12.75 points
</span>
-also exist (ie with no space before the digit and points being
+also exist (i.e. with no space before the digit and points being
the unit of measure, hence no unit of measure required). Both
accept quarter points, so it’s possible to do, for example,
<kbd>\*[FP.5]</kbd> or <kbd>\*[BP1.25]</kbd> up to a limit
@@ -499,9 +499,9 @@ and/or
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you <i>must</i> use the forms <kbd>\E*[BP<n>]</kbd>
-and <kbd>\E*[FP<n>]</kbd> (ie with no space), and enter the
+and <kbd>\E*[FP<n>]</kbd> (i.e. with no space), and enter the
inline beginning with <kbd>\E*</kbd> rather than just <kbd>\*</kbd>,
-e.g., <kbd>\E*[BP.75]</kbd>.
+e.g. <kbd>\E*[BP.75]</kbd>.
</p>
</div>
@@ -567,9 +567,9 @@ and/or
HEADERS or FOOTERS, or in the strings passed to
<a href="headfootpage.html#headers-and-footers">HEADERS_AND_FOOTERS</a>,
you <i>must</i> use the forms <kbd>\E*[ALD<n>]</kbd>
-and <kbd>\E*[RLD<n>]</kbd> (ie with no space), and enter the
+and <kbd>\E*[RLD<n>]</kbd> (i.e. with no space), and enter the
inline beginning with <kbd>\E*</kbd> rather than just <kbd>\*</kbd>,
-e.g., <kbd>\E*[ALD.5]</kbd>.
+e.g. <kbd>\E*[ALD.5]</kbd>.
</p>
</div>
@@ -600,7 +600,7 @@ document entry for EL, you’d use <kbd>\*[B]</kbd>
like this:
<h3 id="tb-plus-mom" class="docs">Call the next sequential tab without
advancing on the page</h3>
<p>
-Sometimes, you want mom to move to the next tab in sequence (e.g.,
+Sometimes, you want mom to move to the next tab in sequence (e.g.
from TAB 1 to TAB 2, or TAB 8 to TAB 9) without mom advancing on the
page. (See the NOTE
<a href="typesetting.html#note-tn">here</a>
@@ -914,7 +914,7 @@ you used <kbd>\v</kbd> with the minus sign) or too low (if
you used
<p>
In the context of mom, the string width inline
<kbd>\w'<string>'</kbd> primarily serves to let you establish the
-horizontal measure of something (e.g., indents) based on the length
+horizontal measure of something (e.g. indents) based on the length
of a bit of text. For example, if you want a left indent the length
of the word “Examples:” plus a space, you can set it with
the <kbd>\w</kbd> inline escape:
@@ -986,7 +986,7 @@ for directions concerning their use. The drawing escapes
can be a
bit unwieldy, so mom provides “user-friendly” macros for
the
<a href="graphical.html#top">graphical objects</a>
-most commonly enountered in typesetting: horizontal and vertical
+most commonly encountered in typesetting: horizontal and vertical
rules, boxes, and circles (ellipses).
</p>
@@ -1023,7 +1023,7 @@ meaning of some of these characters, consult the
</p>
<p>
-For a complete list of special characters and glyphs (ie just
+For a complete list of special characters and glyphs (i.e. just
about anything you’d ever want to appear on the printed
page, including mathematical symbols, accented characters, unusual
ligatures and letters unique to various European languages), consult
@@ -1034,7 +1034,7 @@ ligatures and letters unique to various European
languages), consult
CHARACTER ESCAPE SEQUENCE
--------- ---------------
Comment line \# or .\"
- Fixed-width space \<space> (ie backslash followed by a space)
+ Fixed-width space \<space> (i.e. backslash followed by a
space)
Unbreakable space \~
Digit-width (figure) space \0
Zero-width character \&
diff --git a/contrib/mom/momdoc/intro.html b/contrib/mom/momdoc/intro.html
index b8feca2..f7e6bc7 100644
--- a/contrib/mom/momdoc/intro.html
+++ b/contrib/mom/momdoc/intro.html
@@ -64,8 +64,8 @@ PostScript (.ps). She’s aimed at three kinds of users:
</p>
<ol style="margin-top: -.5em; margin-bottom: -.5em;">
- <li>Typesetters who suspect groff might be “the right
- tool for the job” but who are frustrated,
+ <li>Typesetters who suspect groff might be the right
+ tool for the job but who are frustrated,
intimidated, or puzzled by groff’s terse,
not-always-typographically-intuitive
<a href="definitions.html#primitives">primitives</a>;
@@ -113,7 +113,7 @@ access to groff’s primitives in a way that’s
consistent,
sensible, and easy to use. With them, you can create individual
pages designed from the ground up. Provided you have not signalled
to mom that you want document processing (via the
-<kbd><a href="docprocessing.html#start">START</a></kbd>
+<a href="docprocessing.html#start">START</a>
macro; see below), every typesetting macro is a literal command
that remains in effect until you modify it or turn it off. This
means that if you want to create flyers, surveys, tabulated forms,
@@ -159,7 +159,7 @@ example, you can switch between draft-style and final-copy
output.
If you regularly make submissions to publishers and editors who
insist on "typewritten, double-spaced," there’s a special
macro—
-<a href="docprocessing.html#printstyle"><kbd>PRINTSTYLE
TYPEWRITE</kbd></a>—
+<a href="docprocessing.html#printstyle">PRINTSTYLE
<kbd>TYPEWRITE</kbd></a>—
that changes typeset documents into ones that would make an
old-school typing teacher proud. Footnotes, endnotes, tables of
contents, multiple columns, nested lists, recto/verso printing and
@@ -233,8 +233,8 @@ Mom does not try to be all things to all people. In
contrast to
the normal groff philosophy, she does not try to produce output
that looks good no matter where it’s displayed. She’s
designed for primarily for PDF or PostScript output, although
-with <a href="docprocessing.html#printstyle"><kbd>PRINTSTYLE
-TYPEWRITE</kbd></a>
+with
+<a href="docprocessing.html#printstyle">PRINTSTYLE <kbd>TYPEWRITE</kbd></a>
she produces acceptable terminal copy. No attempt is made to be
compatible with older versions of troff.
</p>
diff --git a/contrib/mom/momdoc/letters.html b/contrib/mom/momdoc/letters.html
index ed90e7e..bb98ce9 100644
--- a/contrib/mom/momdoc/letters.html
+++ b/contrib/mom/momdoc/letters.html
@@ -109,7 +109,7 @@ After the START macro, you enter headers pertinent to your
letter:
the date, the addressee (in business correspondence, 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,” or “Dear
+(in full, e.g. “Dear Mr. Smith,” or “Dear
Mr. Smith:”).
</p>
@@ -303,7 +303,7 @@ or
Family Times Roman Courier
Font roman roman
Point size 12 12
- Line space 13.5 12 (ie singlespaced)
+ Line space 13.5 12 (i.e. singlespaced)
Paragraph indent 3 ems 3 picas
Spaced paragraphs yes no
Footers* yes yes
@@ -486,7 +486,7 @@ Macro: <b>CLOSING</b>
<p>
Invoke <kbd>.CLOSING</kbd> on a line by itself after the body of
-the letter, with the closing you’d like (e.g., “Yours
+the letter, with the closing you’d like (e.g. “Yours
truly,”) underneath, like this:
<br/>
<span class="pre-in-pp">
@@ -515,7 +515,7 @@ and must have a
<a href="definitions.html#unitofmeasure">unit of measure</a>
appended to it, unless you want an indent of 0 (zero). Mom’s
default is one half the width of the letter’s line length
-(ie halfway across the page). If you wanted, instead, an indent of
+(i.e. halfway across the page). If you wanted, instead, an indent of
6
<a href="definitions.html#picaspoints">picas</a>,
you’d do it like this:
diff --git a/contrib/mom/momdoc/macrolist.html
b/contrib/mom/momdoc/macrolist.html
index 3770563..e7f257f 100644
--- a/contrib/mom/momdoc/macrolist.html
+++ b/contrib/mom/momdoc/macrolist.html
@@ -85,7 +85,7 @@ elsewhere in the documentation.
<li><a href="#qr-24">Initiate document processing</a></li>
</ul>
</div>
-<ul style="margin-top: 2.75em; margin-left: 0; padding-left: 0;
list-style-type: none;">
+<ul style="margin-top: 1.75em; margin-left: 0; padding-left: 0;
list-style-type: none;">
<li><a href="#qr-42">Global print style changes after START</a></li>
<li><a href="#qr-43">Managing the docheader</a></li>
<li><a href="#qr-25">Epigraphs</a></li>
@@ -101,6 +101,7 @@ elsewhere in the documentation.
<li><a href="#qr-38">Margin notes</a></li>
<li><a href="#qr-49">Floats</a></li>
<li><a href="#qr-53">Images and graphics</a></li>
+ <li><a href="#qr-60">Shaded backgrounds, frames, page colour</a></li>
<li><a href="#qr-51">eqn support</a></li>
<li><a href="#qr-52">pic support</a></li>
<li><a href="#qr-58">grap support</a></li>
@@ -115,7 +116,6 @@ elsewhere in the documentation.
<li><a href="#qr-46">Pagination</a></li>
<li><a href="#qr-48">Utilities</a></li>
</ul>
-<br/>
</div>
<h2 class="docs">Quick reference guide</h2>
@@ -897,6 +897,19 @@ elsewhere in the documentation.
<table class="quick-ref">
<tr>
+<th id="qr-60" class="quick-ref" colspan="2">
+<a href="images.html#box-intro">+++ Shaded backgrounds, frames, page
colour</a></th>
+</tr>
+<tr>
+<td style="vertical-align: top"><a
href="images.html#box-macro">BOX</a> -- shaded backgrounds and frames
+</tr>
+<tr>
+<td style="vertical-align: top"><a
href="images.html#page-color">PAGE_COLOR</a></td><td>
+</tr>
+
+</table>
+<table class="quick-ref">
+<tr>
<th id="qr-51" class="quick-ref" colspan="2">
<a href="images.html#eqn">+++ eqn support</a></th>
</tr>
diff --git a/contrib/mom/momdoc/rectoverso.html
b/contrib/mom/momdoc/rectoverso.html
index 27b7f2b..38e1f3e 100644
--- a/contrib/mom/momdoc/rectoverso.html
+++ b/contrib/mom/momdoc/rectoverso.html
@@ -182,7 +182,7 @@ placement of author and title, use SWITCH_HEADERS to
reverse it.
SWITCH_HEADERS can also be useful in conjunction with
<a href="#recto-verso">RECTO_VERSO</a>.
The assumption of RECTO_VERSO is that the first page of a document
-(ie recto/odd) represents the norm for header-left and header-right,
+(i.e. recto/odd) represents the norm for header-left and header-right,
meaning that the second (and all subsequent verso/even) pages of the
document will reverse the order of header-left and header-right.
</p>
@@ -219,7 +219,7 @@ together. You need only concatenate chapters into a single
file
(most likely with the <kbd>cat</kbd> command), put <kbd>.COLLATE</kbd> at the
end of each
concatenated chapter, follow it with the
<a href="docprocessing.html#reference-macros">reference macros</a>
-(metadata) needed for the new chapter, e.g.,
+(metadata) needed for the new chapter, e.g.
<a href="docprocessing.html#chapter">CHAPTER</a>
or
<a href="docprocessing.html#chapter-string">CHAPTER_STRING</a>,
@@ -254,7 +254,7 @@ PRINTSTYLE’s already there.
</p>
<ol style="margin-top: -1.25em; padding-bottom: .5em;">
<li>Do not collate documents of differing
- PRINTSTYLES (ie don’t try to
+ PRINTSTYLES (i.e., don’t try to
collate a <kbd>TYPESET</kbd> document and <kbd>TYPEWRITE</kbd>
document).
</li>
@@ -301,7 +301,7 @@ that require their own titles, looks like this:
<span class="tip">Tip:</span>
If the last line of text before <kbd>.COLLATE</kbd>
falls too close to the bottom margin, or if the line is followed
-by a macro likely to cause a linebreak (e.g., <kbd>.LIST OFF</kbd> or
+by a macro likely to cause a linebreak (e.g. <kbd>.LIST OFF</kbd> or
<kbd>.IQ</kbd>), mom may output a superfluous blank page before
the start of the following document.
</p>
diff --git a/contrib/mom/momdoc/refer.html b/contrib/mom/momdoc/refer.html
index 2b26d06..24dd532 100644
--- a/contrib/mom/momdoc/refer.html
+++ b/contrib/mom/momdoc/refer.html
@@ -66,9 +66,6 @@ FDL in the main directory of the groff source package.
<li><a href="#database-rules">Rules</a></li>
<li><a href="#fields-quick">Quick guide to field identifiers (%A for
author, %T for title, etc)</a></li>
<li><a href="#fields-specifics">Field identifiers: specifics, usage and
examples</a>
- <ul style="margin-left: -.5em; list-style-type: square;">
- <li><a href="#ibid">avoiding ibid, idem and their ilk</a></li>
- </ul></li>
</ul></li>
<li><a href="#index-ref">The bibliography and reference macros</a>
<ul style="margin-left: -.5em; list-style-type: disc;">
@@ -172,7 +169,7 @@ are separated from each other by a single, blank line. The
records
themselves are composed of single lines (“fields”) with
no blank lines between them. Each field begins with a percent
sign and a single letter (the "field identifier")
-e.g., <kbd>%A</kbd> or <kbd>%T</kbd>. The letter identifies
+e.g. <kbd>%A</kbd> or <kbd>%T</kbd>. The letter identifies
what part of a bibliographic entry the field refers to: Author,
Title, Publisher, Date, etc. After the field identifier comes
a single space, followed by the information appropriate to
@@ -253,7 +250,7 @@ database <full path to database>
</div>
<p style="margin-top: .5em; font-size: 95%; line-height: 120%;">
<kbd><full path to the database></kbd>
-means the full path including the filename, e.g.,
+means the full path including the filename, e.g.
<kbd>/home/user/refer/my-database-file</kbd>.
</p>
@@ -282,7 +279,7 @@ database <full path to database>
</div>
<p style="margin-top: .5em; font-size: 95%; line-height: 120%;">
<kbd><full path to the database></kbd>
-means the full path including the filename, e.g.,
+means the full path including the filename, e.g.
<kbd>/home/user/refer/my-database-file</kbd>.
</p>
@@ -313,7 +310,7 @@ database <full path to database>
<p style="margin-top: .5em; font-size: 95%; line-height: 120%;">
<kbd><full path to the database></kbd>
-means the full path including the filename, e.g.,
+means the full path including the filename, e.g.
<kbd>/home/user/refer/my-database</kbd>.
</p>
@@ -718,7 +715,7 @@ produces
<p style="margin-top: .5em;">
The heart and soul of <kbd>refer</kbd> is the bibliographic
-database. Knowing how to create records (ie. the entries for works
+database. Knowing how to create records (i.e. the entries for works
cited in a document) is largely a question matching data (author,
title, publisher, etc) with the correct field identifier. For
example, if you’re citing from a scholarly journal, you need to know
@@ -752,7 +749,7 @@ are very few rules, and those there are make sense. In a
nutshell:
escapes <kbd>\*[IT]</kbd> and <kbd>\*[PREV]</kbd>; if the italicized
portion concludes the field, omit <kbd>\*[PREV]</kbd></li>
<li>if you require characters with accents, ligatures or special
- symbols, use groff’s “named” glyphs (e.g.,
+ symbols, use groff’s “named” glyphs (e.g.
<kbd>\['e]</kbd> for <kbd>é</kbd>); a full list can be found in
<kbd>man groff_char</kbd></li>
</ul>
@@ -763,11 +760,11 @@ are very few rules, and those there are make sense. In a
nutshell:
<span class="pre">
<a class="quick" href="#A">%A</a> author – records may contain
multiple authors,
one per line
-<a class="quick" href="#Q">%Q</a> non-human author – corporate author,
e.g., National Geographic;
+<a class="quick" href="#Q">%Q</a> non-human author – corporate author,
e.g. National Geographic;
may also be used for exceptional reference types
<a class="quick" href="#m">%m</a> multiple authors – whenever "et al."
is desirable
<a class="quick" href="#i">%i</a> idem – multiple works by
the same author
-<a class="quick" href="#p">%p</a> post-author – post-author
information (e.g., appendix,
+<a class="quick" href="#p">%p</a> post-author – post-author
information (e.g. appendix,
foreword, letter)
%T title – primary title (of a book) or the
title of an article (within a scholarly
@@ -788,7 +785,7 @@ are very few rules, and those there are make sense. In a
nutshell:
newspaper
%J journal – when %T contains the title of an article
%e edition – number or name of an edition
- (e.g., Second, 2nd, Collector's, etc.)
+ (e.g. Second, 2nd, Collector's, etc.)
%S series – series name of books or journals
%V volume – volume number (of books)
%N journal number – journal or magazine number
@@ -805,7 +802,7 @@ are very few rules, and those there are make sense. In a
nutshell:
<a class="quick" href="#n">%n</a> annotation – annotation to the
reference
%s site name – for internet references, the website name
%c content – for internet references, the source of
- the material (e.g., Web or Email); for websites,
+ the material (e.g. Web or Email); for websites,
the content, if unclear
%o organization – for internet sites, the organization, group
or sponsor of the site
@@ -930,7 +927,7 @@ like this:
<p>
Use this only if the author and the editor are not one in the same,
-e.g.,
+e.g.
<br/>
<span class="pre-in-pp">
%A Geoffrey Chaucer
@@ -1197,7 +1194,7 @@ argument.
</p>
<p>
-When FOOTNOTE_REFS is in effect, regular footnotes, (ie
+When FOOTNOTE_REFS is in effect, regular footnotes, (i.e.
those introduced with <kbd>.FOOTNOTE</kbd> and terminated with
<kbd>.FOOTNOTE OFF</kbd>) continue to behave normally.
</p>
@@ -1211,7 +1208,7 @@ at any time.
<p>
By default, FOOTNOTE_REFS sets the
<a href="docelement.html#footnote-marker-style">FOOTNOTE_MARKER_STYLE</a>
-to <kbd>NUMBER</kbd> (ie superscript numbers). You may change
+to <kbd>NUMBER</kbd> (i.e. superscript numbers). You may change
change that if you wish by invoking FOOTNOTE_MARKER_STYLE, with the
argument you want after FOOTNOTE_REFS.
</p>
@@ -1243,7 +1240,7 @@ macro to endnotes.” You invoke it by itself, with
no argument.
<p>
When ENDNOTE_REFS is in effect, mom continues to format regular
-endnotes, (ie those introduced with <kbd>.ENDNOTE</kbd> and
+endnotes, (i.e. those introduced with <kbd>.ENDNOTE</kbd> and
terminated with <kbd>.ENDNOTE OFF</kbd>) in the normal way.
</p>
@@ -1459,7 +1456,7 @@ The two optional arguments,
<kbd><list separator></kbd>
and <kbd><list prefix></kbd> have the same meaning as the
equivalent arguments to
<a href="docelement.html#list">LIST</a>
-(ie <kbd><separator></kbd> and <kbd><prefix></kbd>).
+(i.e. <kbd><separator></kbd> and <kbd><prefix></kbd>).
</p>
<p>
@@ -2038,7 +2035,7 @@ Invoked without an argument,
underneath the bibliography’s first-page title. Invoked with the
argument, <kbd>DOUBLE</kbd>, BIBLIOGRAPHY_STRING_UNDERSCORE will
double-underscore the title. Invoked with any other non-numeric
-argument, (e.g., <kbd>OFF, NO, X</kbd>, etc.) the macro disables
+argument, (e.g. <kbd>OFF, NO, X</kbd>, etc.) the macro disables
underlining of the title.
</p>
diff --git a/contrib/mom/momdoc/tables-of-contents.html
b/contrib/mom/momdoc/tables-of-contents.html
index e6863f6..f3013d1 100644
--- a/contrib/mom/momdoc/tables-of-contents.html
+++ b/contrib/mom/momdoc/tables-of-contents.html
@@ -71,7 +71,7 @@ Want a table of contents for your document? Easy. Just enter
<span class="pre-in-pp">
.TOC
</span>
-as the very last macro of your document file. Mom will have picked
+as the very last macro of your input file. Mom will have picked
up all document titles (in
<a href="rectoverso.html#collate">collated</a>
documents) and headings, as well as the endnotes section and
@@ -196,7 +196,7 @@ AUTO_RELOCATE_TOC usage is described in the manual,
In order to take advantage of automatic table of contents
repositioning, you must use
<a href="using.html#pdfmom" style="font-weight: bold">pdfmom</a>
-with groff’s native PDF driver (ie without the
+with groff’s native PDF driver (i.e. without the
<strong>-Tps</strong> flag). Files that need to be processed with
the <strong>-Tps</strong> flag require you to reposition the table
of contents yourself with <strong>psselect</strong>, described
@@ -248,9 +248,9 @@ The <kbd>-p</kbd> option instructs <kbd>psselect</kbd> that
what
follows is a comma-separated list of the order in which you want
pages of a document rearranged. The underscore character means
"counting backwards from the end of the document". Thus, the above
-says: "Put the last page first (ie the table of contents), followed
+says: "Put the last page first (i.e. the table of contents), followed
by all pages from the original first page up to the second to last
-(ie the last page before the table of contents)."
+(i.e. the last page before the table of contents)."
</p>
<p>
@@ -309,7 +309,7 @@ invoke <kbd>.TOC</kbd> with <kbd>INCLUDE_TITLE</kbd>.
<span class="note">Note:</span>
If the last line of text in a document, before <kbd>.TOC</kbd>,
falls too close to the bottom margin, or if the line is followed
-by a macro likely to cause a linebreak (e.g., <kbd>.LIST OFF</kbd> or
+by a macro likely to cause a linebreak (e.g. <kbd>.LIST OFF</kbd> or
<kbd>.IQ</kbd>), mom may output a superfluous blank page before the
Table of Contents.
</p>
@@ -395,7 +395,7 @@ themselves (overall family, headers/footers, pagination,
etc).
<li><a href="#paginate-toc">PAGINATE_TOC</a> – turn table of
contents pagination on or off</li>
<li><a href="#toc-pagenum-style">TOC_PAGENUM_STYLE</a> – table of
contents page numbering style</li>
</ul></li>
- <li><a href="#toc-header">Header string (e.g., “Contents”) and
style</a>
+ <li><a href="#toc-header">Header string (e.g. “Contents”) and
style</a>
<ul style="margin-left: -.5em;">
<li><a href="#toc-header-string">Changing the header string</a></li>
<li><a href="#toc-header-v-pos">Header string vertical placement</a></li>
@@ -563,7 +563,7 @@ immediately prior to <kbd>.TOC</kbd>.
<p>
A special macro
<kbd><a href="#toc-pagenum-style">TOC_PAGENUM_STYLE</a></kbd>
-controls the style of table of contents pagination (ie the actual
+controls the style of table of contents pagination (i.e. the actual
table of contents pages’ numbers, not the page number
references of entries).
</p>
@@ -624,7 +624,7 @@ the following:
<h4 id="toc-header" class="docs" style="margin-top: -.5em;">3. Header string
and style</h4>
<p>
-The table of contents header string is the title that appears at to top of the
+The table of contents header string is the title that appears at the top of the
table of contents. By default, it’s “Contents”.</p>
<div id="toc-header-string" class="box-macro-args">
@@ -698,7 +698,7 @@ documents) and headings as they appear in the table of
contents:
Head level 3
...
</span>
-The style for title entries (e.g., chapter numbers or titles) and
+The style for title entries (e.g. chapter numbers or titles) and
heading levels is controlled by
<a href="#toc-title-style">TOC_TITLE_STYLE </a>
and
@@ -1198,7 +1198,7 @@ set/change the footer gap, see
<p>
TOC_PAGE_SETTINGS can be put in the stylesheet section of a document
-(ie after
+(i.e. after
<a href="docprocessing.html#printstyle">PRINTSTYLE</a>
and before
<a href="docprocessing.html#start">START</a>)
diff --git a/contrib/mom/momdoc/toc.html b/contrib/mom/momdoc/toc.html
index ed0b645..a276bd3 100644
--- a/contrib/mom/momdoc/toc.html
+++ b/contrib/mom/momdoc/toc.html
@@ -20,7 +20,7 @@ FDL in the main directory of the groff source package.
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
- <title>Mom, version 2.4-4_e -- Table of Contents</title>
+ <title>Mom, version 2.5 -- Table of Contents</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" />
</head>
@@ -31,7 +31,7 @@ FDL in the main directory of the groff source package.
<div class="page">
<div class="version">
- mom, version 2.4-4_e
+ mom, version 2.5
</div>
<h1 class="toc" style="margin-top: 9px;">Table of Contents</h1>
@@ -44,11 +44,15 @@ FDL in the main directory of the groff source package.
<br/>
which will take you to the corresponding entry in the
<br/>
- <a href="#full-toc">Full Table of Contents</a>.
+ <a href="#detailed-toc">Detailed Table of Contents</a>.
<br/>
If you’ve been using mom for a while, you may prefer the
<br/>
- <a href="macrolist.html#top">Quick Reference Guide</a>.
+ <a href="macrolist.html#top">Quick Reference Guide</a>,
+ <br/>
+ which gives a convenient, categorized list of mom’s
+ user-space macros with links to corresponding entries in the
+ documentation.
</p>
<div class="rule-medium"><hr/></div>
@@ -98,8 +102,9 @@ FDL in the main directory of the groff source package.
<li><a href="#vert-ws">Vertical whitespace management</a></li>
<li><a href="#prelim">Preliminary document setup</a></li>
<li><a href="#typemacdoc">Behaviour of the typesetting macros during
document processing</a></li>
- <li><a href="#tags">The document element tags</a> – headings,
paragraphs, quotes, footnotes, etc.</li>
+ <li><a href="#tags">The document element tags</a> – headings,
paragraphs, quotes, etc.</li>
<li><a href="#images">Graphics, floats, and preprocessor support</a></li>
+ <li><a href="#box">Shaded backgrounds and frames</a></li>
<li><a href="#hdrftr">Page headers and footers</a></li>
<li><a href="#paginate">Pagination</a></li>
<li><a href="#rv">Recto/verso printing and collating</a></li>
@@ -119,7 +124,7 @@ FDL in the main directory of the groff source package.
<!-- -FULL TABLE OF CONTENTS- -->
- <h2 id="full-toc" class="toc" style="margin-top: 24px; text-align:
center;">Full Table of Contents</h2>
+ <h2 id="detailed-toc" class="toc" style="margin-top: 24px; text-align:
center;">Detailed Table of Contents</h2>
<div style="margin-left: 12px;">
<h3 id="v2-notes" class="toc"><a style="color: #6e70cc"
href="version-2.html#top">VERSION 2.0 NOTES</a></h3>
@@ -364,6 +369,7 @@ FDL in the main directory of the groff source package.
<li><a href="images.html#tbl">5.5.6.1 tbl support</a></li>
<li><a href="images.html#eqn">5.5.6.2 eqn support</a></li>
<li><a href="images.html#pic">5.5.6.3 pic support</a>
+ <li><a href="images.html#grap">5.5.6.4 grap support</a>
<ul style="list-style-type: disc">
<li><a href="images.html#pic-text-style">5.5.6.3.1
PIC_TEXT_STYLE</a></li>
</ul></li>
@@ -386,57 +392,65 @@ FDL in the main directory of the groff source package.
</ul></li>
</ul></li>
</ul></li>
- <li><a id="hdrftr" class="highlight" href="headfootpage.html#top">5.6
PAGE HEADERS AND FOOTERS</a>
+ <li><a id="box" class="highlight" href="headfootpage.html#top">5.6
SHADED BACKGROUNDS AND FRAMES</a>
+ <ul>
+ <li><a href="images.html#box-intro">5.6.1 Introduction</a></li>
+ <li><a href="images.html#box-macro">5.6.2 The BOX macro</a></li>
+ <li><a href="images.html#box-notes">5.6.3 Additional notes on BOX
usage and behaviour</a></li>
+ <li><a href="images.html#page-color">5.6.4 PAGE_COLOR</a></li>
+ </ul>
+ </li>
+ <li><a id="hdrftr" class="highlight" href="headfootpage.html#top">5.7
PAGE HEADERS AND FOOTERS</a>
<ul>
- <li><a href="headfootpage.html#headfootpage-intro">5.6.1
Introduction</a></li>
- <li><a href="headfootpage.html#description-general">5.6.2 General
description of headers/footers</a></li>
- <li><a href="headfootpage.html#header-style">5.6.3 Default specs for
headers/footers</a></li>
- <li><a href="headfootpage.html#vertical-spacing">5.6.4 Vertical
placement and spacing of headers/footers</a></li>
- <li><a href="headfootpage.html#headfoot-management">5.6.5 Managing
page headers and footers</a></li>
- <li><a href="headfootpage.html#headfoot-control">5.6.6 Control
macros for headers/footers</a></li>
- <li><a href="headfootpage.html#userdef-hdrftr-rv">5.6.7
User-defined, single string recto/verso headers/footers</a>
+ <li><a href="headfootpage.html#headfootpage-intro">5.7.1
Introduction</a></li>
+ <li><a href="headfootpage.html#description-general">5.7.2 General
description of headers/footers</a></li>
+ <li><a href="headfootpage.html#header-style">5.7.3 Default specs for
headers/footers</a></li>
+ <li><a href="headfootpage.html#vertical-spacing">5.7.4 Vertical
placement and spacing of headers/footers</a></li>
+ <li><a href="headfootpage.html#headfoot-management">5.7.5 Managing
page headers and footers</a></li>
+ <li><a href="headfootpage.html#headfoot-control">5.7.6 Control
macros for headers/footers</a></li>
+ <li><a href="headfootpage.html#userdef-hdrftr-rv">5.7.7
User-defined, single string recto/verso headers/footers</a>
<ul>
- <li><a href="headfootpage.html#userdef-hdrftr">5.6.7.1
User-defined, single string headers/footers (no recto/verso)</a></li>
+ <li><a href="headfootpage.html#userdef-hdrftr">5.7.7.1
User-defined, single string headers/footers (no recto/verso)</a></li>
</ul></li>
- <li><a href="headfootpage.html#headers-and-footers-intro">5.6.8
Headers and footers on the same page</a></li>
+ <li><a href="headfootpage.html#headers-and-footers-intro">5.7.8
Headers and footers on the same page</a></li>
</ul></li>
- <li><a id="paginate" class="highlight"
href="headfootpage.html#pagination-intro">5.7 PAGINATION</a>
+ <li><a id="paginate" class="highlight"
href="headfootpage.html#pagination-intro">5.8 PAGINATION</a>
<ul>
- <li><a href="headfootpage.html#pagination">5.7.1
Introduction</a></li>
- <li><a href="headfootpage.html#index-pagination">5.7.2 Pagination
macros list</a></li>
- <li><a href="headfootpage.html#blank-pages">5.7.3 Blank
pages</a></li>
+ <li><a href="headfootpage.html#pagination">5.8.1
Introduction</a></li>
+ <li><a href="headfootpage.html#index-pagination">5.8.2 Pagination
macros list</a></li>
+ <li><a href="headfootpage.html#blank-pages">5.8.3 Blank
pages</a></li>
</ul></li>
- <li><a id="rv" class="highlight" href="rectoverso.html#top">5.8
RECTO/VERSO PRINTING, COLLATING</a>
+ <li><a id="rv" class="highlight" href="rectoverso.html#top">5.9
RECTO/VERSO PRINTING, COLLATING</a>
<ul>
- <li><a href="rectoverso.html#rectoverso-intro">5.8.1 Introduction to
recto/verso printing</a>
+ <li><a href="rectoverso.html#rectoverso-intro">5.9.1 Introduction to
recto/verso printing</a>
<ul>
- <li><a href="rectoverso.html#rectoverso-list">5.8.1.1 Macro
list</a></li>
+ <li><a href="rectoverso.html#rectoverso-list">5.9.1.1 Macro
list</a></li>
</ul></li>
- <li><a href="rectoverso.html#collate-intro">5.8.2 Introduction to
collating</a>
+ <li><a href="rectoverso.html#collate-intro">5.9.2 Introduction to
collating</a>
<ul>
- <li><a href="rectoverso.html#collate">5.8.2.1 The COLLATE
macro</a></li>
+ <li><a href="rectoverso.html#collate">5.9.2.1 The COLLATE
macro</a></li>
</ul></li>
</ul></li>
- <li><a id="cover" class="highlight" href="cover.html#top">5.9 COVER
PAGES</a></li>
- <li><a id="tocs" class="highlight"
href="tables-of-contents.html#top">5.10 TABLES OF CONTENTS</a>
+ <li><a id="cover" class="highlight" href="cover.html#top">5.10 COVER
PAGES</a></li>
+ <li><a id="tocs" class="highlight"
href="tables-of-contents.html#top">5.11 TABLES OF CONTENTS</a>
<ul>
- <li><a href="tables-of-contents.html#toc-intro">5.10.1
Introduction</a> – the TOC macro</li>
- <li><a href="tables-of-contents.html#toc-appearance">5.10.2 Table of
contents appearance and behaviour</a></li>
- <li><a href="tables-of-contents.html#pdf-output">5.10.3 PDF
output</a></li>
- <li><a href="tables-of-contents.html#positioning">5.10.4 Positioning
the table of contents</a>
+ <li><a href="tables-of-contents.html#toc-intro">5.11.1
Introduction</a> – the TOC macro</li>
+ <li><a href="tables-of-contents.html#toc-appearance">5.11.2 Table of
contents appearance and behaviour</a></li>
+ <li><a href="tables-of-contents.html#pdf-output">5.11.3 PDF
output</a></li>
+ <li><a href="tables-of-contents.html#positioning">5.11.4 Positioning
the table of contents</a>
<ul>
- <li><a href="tables-of-contents.html#auto-relocate-toc">5.10.2
Automatic PDF relocation of the Table of Contents</a></li>
- <li><a href="tables-of-contents.html#psselect">5.10.2 Using
psselect to relocate the TOC in PostScript documents</a></li>
+ <li><a href="tables-of-contents.html#auto-relocate-toc">5.11.2
Automatic PDF relocation of the Table of Contents</a></li>
+ <li><a href="tables-of-contents.html#psselect">5.11.2 Using
psselect to relocate the TOC in PostScript documents</a></li>
</ul></li>
- <li><a href="tables-of-contents.html#index-toc-control">5.10.5 Table
of contents control macros</a></li>
+ <li><a href="tables-of-contents.html#index-toc-control">5.11.5 Table
of contents control macros</a></li>
</ul></li>
- <li><a id="ref" class="highlight" href="refer.html#top">5.11
BIBLIOGRAPHIES AND REFERENCES</a></li>
- <li><a id="letter" class="highlight" href="letters.html#top">5.12
WRITING LETTERS</a>
+ <li><a id="ref" class="highlight" href="refer.html#top">5.12
BIBLIOGRAPHIES AND REFERENCES</a></li>
+ <li><a id="letter" class="highlight" href="letters.html#top">5.13
WRITING LETTERS</a>
<ul>
- <li><a href="letters.html#letters-intro">5.11.1 Introduction to
writing letters</a></li>
- <li><a href="letters.html#letters-tutorial">5.11.2 Tutorial on
writing letters</a></li>
- <li><a href="letters.html#letters-defaults">5.11.3 Default letter
style</a></li>
- <li><a href="letters.html#index-letters-macros">5.11.4 The letter
macros</a></li>
+ <li><a href="letters.html#letters-intro">5.13.1 Introduction to
writing letters</a></li>
+ <li><a href="letters.html#letters-tutorial">5.13.2 Tutorial on
writing letters</a></li>
+ <li><a href="letters.html#letters-defaults">5.13.3 Default letter
style</a></li>
+ <li><a href="letters.html#index-letters-macros">5.13.4 The letter
macros</a></li>
</ul></li>
</ul>
<h3 id="quick" class="toc highlight"><a style="color: #6e70cc"
href="macrolist.html#top">6. QUICK REFERENCE GUIDE</a></h3>
diff --git a/contrib/mom/momdoc/typesetting.html
b/contrib/mom/momdoc/typesetting.html
index 1960efa..b137a5e 100644
--- a/contrib/mom/momdoc/typesetting.html
+++ b/contrib/mom/momdoc/typesetting.html
@@ -236,7 +236,7 @@ or
or
<a href="#page">PAGE</a>),
you must include <kbd>-P-p<papersize></kbd> on whichever
-command line you use, e.g.,
+command line you use, e.g.
<br/>
<span class="pre-in-pp">
pdfmom -Tps -mom -P-plegal
@@ -504,7 +504,7 @@ and right margin, like this:
That way, you don’t have to worry about calculating the line
length. On the other hand, if you know the line length for a patch
of type should be 17 picas and 3 points, entering the line length
-with LL is much easier than calculating the right margin, e.g.,
+with LL is much easier than calculating the right margin, e.g.
<br/>
<span class="pre-in-pp">
.LL 17P+3p
@@ -1022,7 +1022,7 @@ Macro: <b>FALLBACK_FONT</b> <kbd
class="macro-args"><fallback font> [ ABOR
<p>
In the event that you pass an invalid argument to
<a href="#font">.FAMILY</a>
-(ie a non-existent family), mom, by default, uses the fallback
+(i.e. a non-existent family), mom, by default, uses the fallback
font, Courier Medium Roman (CR), in order to continue processing
your file.
</p>
@@ -1119,7 +1119,7 @@ is measured in points. Therefore, to change the type
size to, say,
<span class="pre-in-pp">
.PT_SIZE 11
</span>
-Point sizes may be fractional (e.g., 10.25 or 12.5).
+Point sizes may be fractional (e.g. 10.25 or 12.5).
</p>
<p>
@@ -1183,7 +1183,7 @@ Macro: <b>LS</b> <kbd class="macro-args"><distance
between lines></kbd>
<p>
LS (Line Space) takes one argument: the distance you want, typically
in points, from baseline to baseline of type. The argument may be
-fractional (e.g., 12.25 or 14.5). Like PT_SIZE, LS does not require
+fractional (e.g. 12.25 or 14.5). Like PT_SIZE, LS does not require
a unit of measure, since
<a href="definitions.html#leading">leading</a>
is most often given in points. Therefore, to set the linespace to
@@ -1254,7 +1254,7 @@ requests automatically update the linespacing by the
autolead amount.
Used in this way, AUTOLEAD does not require a unit of measure;
points is assumed. However, you may use an alternate unit of
measure by appending it to the argument. The argument may be a
-decimal fraction (e.g., .5 or 2.75).
+decimal fraction (e.g. .5 or 2.75).
</p>
<p>
@@ -2039,7 +2039,7 @@ Like
<a href="#ws">WS</a>,
increasing the sentence space by a value of 1 or 2 produces a
difference that in many cases is scarcely visible; increasing by a
-value of 5 or so produces a subtle but noticeable difference (ie
+value of 5 or so produces a subtle but noticeable difference (i.e.,
the space between double-spaced input sentences will be slightly but
visibly greater than the space between words); and increasing by a
value greater than 10 is always apparent. You should preview your
@@ -2065,7 +2065,7 @@ at the top of your files.
If you do use SS for something other than ensuring that you
don’t get unwanted sentence spaces in output copy, you can set
or reset the sentence space to the groff default (the same width
-as a word space, ie double-spaced input sentences will appear
+as a word space, i.e., double-spaced input sentences will appear
double-spaced on output as well) with
<br/>
<span class="pre-in-pp">
@@ -2122,7 +2122,7 @@ to HY, I’ve broken them down into separate sections.
<h3 class="docs">1. HY</h3>
<p>
-HY by itself (ie with no argument) simply turns automatic
+HY by itself (i.e. with no argument) simply turns automatic
hyphenation on. Any argument other than LINES, MARGIN, SPACE or
DEFAULT, turns automatic hyphenation off. For example, as explained
in
@@ -2148,7 +2148,7 @@ LINES, MARGIN, or SPACE that were formerly in effect (see
below).
HY observes the following default hyphenation rules:
</p>
<ul style="margin-top: -.5em; margin-left: 18px;">
- <li>Last lines (ie ones that will spring a trap—typically
+ <li>Last lines (i.e. ones that will spring a trap—typically
the last line on a page) will not be hyphenated.
</li>
<li>The first and last two characters of a word are never
@@ -2175,7 +2175,7 @@ limit to the number of consecutive hyphenated lines.
<span class="note">Note:</span>
<a href="definitions.html#discretionaryhyphen">Discretionary hyphens</a>
count when groff is figuring out how many lines to hyphenate;
-explicit hyphens (ie the actual hyphen character) do not.
+explicit hyphens (i.e. the actual hyphen character) do not.
</p>
</div>
@@ -2366,7 +2366,7 @@ recommend previewing your work to assess the effect of RW.
<a href="#br">break</a>
when it’s invoked if you’re in one of the
<a href="definitions.html#fill">fill</a>
-modes (ie
+modes (i.e.
<a href="#quad">QUAD</a>
L, R, C, J or
<a href="#justify">JUSTIFY</a>).
@@ -2429,7 +2429,7 @@ assess the effect of EW.
<a href="#br">break</a>
when it’s invoked if you’re in one of the
<a href="definitions.html#fill">fill</a>
-modes (ie
+modes (i.e.
<a href="#quad">QUAD</a>
L, R, C, J or
<a href="#justify">JUSTIFY</a>).
@@ -2466,7 +2466,7 @@ Macro: <b>BR_AT_LINE_KERN</b> <kbd
class="macro-args">toggle</kbd>
<p>
By default, in
<a href="definitions.html#filled">fill</a>
-modes (ie
+modes (i.e.
<a href="#quad">QUAD</a>
L, R, C, J or
<a href="#justify">JUSTIFY</a>)
@@ -2505,9 +2505,9 @@ Macro: <b>KERN</b> <kbd class="macro-args">toggle</kbd>
</div>
<p>
-By itself (ie with no argument), KERN turns automatic pairwise
+By itself (i.e. with no argument), KERN turns automatic pairwise
<a href="definitions.html#kern">kerning</a>
-on. With any argument (e.g., OFF, Q, X), pairwise kerning is turned
+on. With any argument (e.g. OFF, Q, X), pairwise kerning is turned
off.
</p>
@@ -2855,7 +2855,7 @@ off before making any changes to the point size of your
type, either
via the
<a href="#ps">PT_SIZE</a>
macro or with the <kbd>\s</kbd> inline escape. If you wish
-the new point size to be pseudo-condensed, simply reinvoke
+the new point size to be pseudo-condensed, simply re-invoke
<kbd>\*[COND]</kbd> afterwards. Equally, <kbd>\*[COND]</kbd> must
be turned off before changing the condense percentage with
<kbd><a href="#condense">.CONDENSE</a></kbd>.
@@ -2952,7 +2952,7 @@ embedded in text lines, like this:
of your type, either via the
<a href="#ps">PT_SIZE</a>
macro or with the <kbd>\s</kbd> inline escape. If you wish the new
-point size to be pseudo-extended, simply reinvoke <kbd>\*[EXT]</kbd>
+point size to be pseudo-extended, simply re-invoke <kbd>\*[EXT]</kbd>
afterwards. Equally, <kbd>\*[EXT]</kbd> must be turned off before
changing the extend percentage with
<a href="#extend">EXTEND</a>.
@@ -3138,7 +3138,7 @@ of lead.
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span> if you want to use ALD at the top
-of a page (ie to advance to the starting position of type on a
+of a page (i.e. to advance to the starting position of type on a
page), combine the value you want with <kbd>-1v</kbd> (minus one
line space), like this:
<br/>
@@ -3333,7 +3333,7 @@ Once the tabs are set up, you can call them in one of two
ways:
advances one linespace and calls the tab.</li>
<li>with <kbd><a href="#tn">.TN</a></kbd> (Tab Next), which keeps
you on the current line and moves over to the next
- tab in sequence (ie from 1 to 2, 2 to 3, etc.), or, more
+ tab in sequence (i.e. from 1 to 2, 2 to 3, etc.), or, more
conveniently, with the
<kbd><a href="#tn">\*[TB+]</a></kbd>
<a href="definitions.html#inlines">inline escape</a></li>
@@ -3804,7 +3804,7 @@ string tab markers.
</span>
String tab 1 begins at the start of the line and ends after the word
“time”. String tab 2 starts at “good” and
-ends after “men”. Inline escapes (e.g., font or point
+ends after “men”. Inline escapes (e.g. font or point
size changes, or horizontal movements, including
<a href="goodies.html#pad">padding</a>)
are taken into account when mom determines the position and length
@@ -3827,7 +3827,7 @@ after which they may be called, by number, with
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span> Lines with string tabs marked off
-in them are normal input lines, ie they get printed, just like
+in them are normal input lines, i.e., they get printed, just like
any input line. If you want to set up string tabs without the line
printing, use the
<a href="goodies.html#silent">SILENT</a>
@@ -4337,7 +4337,7 @@ of the longest column.
<p>
With mom’s indents, you can indent from the left, the right,
or both margins. In addition, mom provides temporary left indents
-(ie only one line is indented, as at the start of a paragraph)
+(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>
@@ -4418,12 +4418,12 @@ IL, IR and IB are additive. Consider the following:
A second block of text...
...
...
- .IR 2P \"Indent right by an additional 2 picas (ie 4 picas)
+ .IR 2P \"Indent right by an additional 2 picas (i.e. 4 picas)
A third block of text...
...
...
</span>
-The first block of text is right indented by 2 picas (ie the line
+The first block of text is right indented by 2 picas (i.e. the line
length is shortened by 2 picas to 18 picas). The second block of
text, after IQ, is, as you’d expect, set to the full measure.
The third block of text—the one to pay attention to—is
@@ -4803,7 +4803,7 @@ mom keeps track of the last measure you gave it.
<p>
Generally speaking, you should invoke HI immediately prior to the
-line you want hung (ie without any intervening
+line you want hung (i.e. without any intervening
<a href="definitions.html#controllines">control lines</a>).
And because hanging indents affect only one line, there’s no
need to turn them off.
diff --git a/contrib/mom/momdoc/using.html b/contrib/mom/momdoc/using.html
index ea90294..d58aaf0 100644
--- a/contrib/mom/momdoc/using.html
+++ b/contrib/mom/momdoc/using.html
@@ -73,8 +73,8 @@ operations automatically.
<p>
You tell mom that you want to use the document processing macros
with the
-<a href="docprocessing.html#start"><kbd>START</kbd></a>
-macro. After <kbd>START</kbd>, mom determines the appearance of
+<a href="docprocessing.html#start">START</a>
+macro. After START, mom determines the appearance of
text following the markup tags automatically, although you, the
user, can easily change how the tags are interpreted.
</p>
@@ -98,7 +98,10 @@ flyer for your lost dog, the following apply.
Simply colourizing macros and inlines to half-intensity can be
enough to make text stand out clearly from formatting commands.
Mom herself comes with a complete set of syntax highlighting
- rules for the vim editor.
+ rules for the vim editor. A number of freely available editors
+ come with groff syntax highlighting rules, which are sufficient
+ for mom files, though not as colourful or complete as the vim
+ rules that ship with mom.
</span>
</li>
<li>
@@ -154,7 +157,7 @@ flyer for your lost dog, the following apply.
<li>
<a href="definitions.html#stringargument">String arguments</a>,
in the sense of this manual, must be surrounded by double-quotes
- (e.g., <kbd>"text"</kbd>). Multiple
+ (e.g. <kbd>"text"</kbd>). Multiple
string arguments are separated from each other by spaces (with
each argument surrounded by double-quotes).
<br/>
@@ -286,7 +289,7 @@ metadata, notably the document window title set with
PDF_TITLE.
<p>
Most PDF viewers have a “Watch File” option, which
-automaticaly updates a displayed document whenever there’s
+automatically updates a displayed document whenever there’s
a change. This is useful when preparing documents that require
judgment calls. I recommend creating a keymapping in your
text editor that both saves the mom file and processes it with
diff --git a/contrib/mom/momdoc/version-2.html
b/contrib/mom/momdoc/version-2.html
index 3d65ff2..0569ac0 100644
--- a/contrib/mom/momdoc/version-2.html
+++ b/contrib/mom/momdoc/version-2.html
@@ -58,6 +58,7 @@ FDL in the main directory of the groff source package.
</ul></li>
<li><a href="#v2.1-changes">Version 2.1 changes</a></li>
<li><a href="#v2.2-changes">Version 2.2 changes</a></li>
+ <li><a href="#v2.5-changes">Version 2.5 changes</a></li>
<li><a href="#pdfmom">The <strong>pdfmom</strong> wrapper around
groff</a></li>
<li><a href="#install-font">The <strong>install-font.sh</strong>
script</a></li>
</ol>
@@ -124,7 +125,7 @@ papersize within the source file without the corresponding
need for
<p>
Lastly, while not strictly part of mom, a bash script,
<strong>install-font.sh</strong>, has been posted at the
-<a href="http://www.schaffter.ca/mom/">mom site</a>.
+<a href="https://www.schaffter.ca/mom/">mom site</a>.
The script significantly eases the installation of new
groff families and fonts, with conversion to .pfa
and .t42 being performed by <strong>fontforge</strong>.
@@ -296,7 +297,7 @@ and
</span>
where <kbd><n></kbd> corresponds to a <kbd>HEADING</kbd>
level. Both macros permit setting any or all of the style
-parameters for TOC titles (ie chapters or major sections/divisions
+parameters for TOC titles (i.e. chapters or major sections/divisions
of a collated document) and TOC entries (nested heading levels) at
once. Documents created with 1.x that contain TOCs will need to
have their TOC style updated if the new defaults are unsatisfactory.
@@ -324,11 +325,7 @@ the mom source file is processed with
</p>
<h2 id="v2.1-changes" class="docs">3. Version 2.1 changes</h2>
-
-<p>
-Version 2.1 adds these features:
-</p>
-<ul style="margin-top: -.5em; width: 90%">
+<p> Version 2.1 adds these features: </p> <ul style="margin-top: -.5em; width:
90%">
<li>expansion of cover, docheader, page header, and heading
control macros to permit caps, smallcaps, color, and
underscoring</li>
@@ -382,11 +379,21 @@ Version 2.2 adds these features:
vertical whitespace management</a>
</li>
<li>improvements to auto-labelling, such that it is now possible
- to link symbollically to auto-labelled preprocessor material and
- PDF images</li>
+ to link symbolically to auto-labelled preprocessor material and
+ PDF images (note that you must be running groff 1.22.4 or higher
+ for this feature)
+ </li>
</ul>
-<h2 id="pdfmom" class="docs">5. pdfmom</h2>
+<h2 id="v2.2-changes" class="docs">5. Version 2.5 changes</h2>
+
+<p>
+Version 2.5 adds shaded backgrounds and frames that span pages
+appropriately when necessary, and a macro to set page or slide
+bacground colour.
+</p>
+
+<h2 id="pdfmom" class="docs">6. pdfmom</h2>
<p>
Deri James has provided <strong>pdfmom</strong>, a wrapper around
@@ -404,7 +411,7 @@ recognizes PDF images that have been embedded with
<a href="images.html#pdf-image"><kbd>PDF_IMAGE</kbd></a>.
</p>
-<h2 id="install-font" class="docs">6. install-font.sh</h2>
+<h2 id="install-font" class="docs">7. install-font.sh</h2>
<p>
A bash script, <strong>install-font.sh</strong>, has been posted at the
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: mom 2.5: general doc cleanup,
Peter Schaffter <=