[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: Mostly grammar fixes to docs (restrictive and non-restric
|
From: |
Peter Schaffter |
|
Subject: |
[groff] 01/01: Mostly grammar fixes to docs (restrictive and non-restrictive apposites). |
|
Date: |
Fri, 19 Jan 2018 13:44:47 -0500 (EST) |
PTPi pushed a commit to branch master
in repository groff.
commit 42544e45265a891ca2b821407ae8748f37554e0a
Author: Peter Schaffter <address@hidden>
Date: Fri Jan 19 13:42:14 2018 -0500
Mostly grammar fixes to docs (restrictive and non-restrictive apposites).
---
contrib/mom/momdoc/color.html | 8 +-
contrib/mom/momdoc/cover.html | 8 +-
contrib/mom/momdoc/docelement.html | 121 ++++++++++++++++++++---------
contrib/mom/momdoc/docprocessing.html | 18 ++---
contrib/mom/momdoc/goodies.html | 8 +-
contrib/mom/momdoc/graphical.html | 9 ++-
contrib/mom/momdoc/headfootpage.html | 20 ++---
contrib/mom/momdoc/images.html | 28 +++++--
contrib/mom/momdoc/inlines.html | 8 +-
contrib/mom/momdoc/letters.html | 2 +-
contrib/mom/momdoc/macrolist.html | 19 ++---
contrib/mom/momdoc/refer.html | 4 +-
contrib/mom/momdoc/tables-of-contents.html | 6 +-
contrib/mom/momdoc/typesetting.html | 8 +-
contrib/mom/momdoc/version-2.html | 8 +-
15 files changed, 169 insertions(+), 106 deletions(-)
diff --git a/contrib/mom/momdoc/color.html b/contrib/mom/momdoc/color.html
index 4af38e5..39e0bfe 100644
--- a/contrib/mom/momdoc/color.html
+++ b/contrib/mom/momdoc/color.html
@@ -58,8 +58,8 @@ Afterward, 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>,
+or <kbd>\*[blue]</kbd>) or invoke the macro
+<kbd><a href="#color">COLOR</a></kbd>
with the name of the colour you want.
</p>
@@ -228,7 +228,7 @@ After you've told mom about a colour, you can then get her
to set
text in that colour either with the
<a href="definitions.html#inlines">inline escape</a>,
<a href="#color-inline"><kbd>\*[<colorname>]</kbd></a>,
-or the macro,
+or the macro
<a href="#color">COLOR</a>.
(See the
<a href="#color-example">example</a>,
@@ -442,7 +442,7 @@ Once you've told mom about a colour (via
<a href="#newcolor">NEWCOLOR</a>
or
<a href="#xcolor">XCOLOR</a>,
-you use either the macro, COLOR, or the
+you use either the macro COLOR or the
<a href="definitions.html#inlines">inline escape</a>,
<kbd>\*[<colorname>]</kbd>, to cause mom to
set subsequent text in that colour. See the
diff --git a/contrib/mom/momdoc/cover.html b/contrib/mom/momdoc/cover.html
index 65c67f3..fdfa092 100644
--- a/contrib/mom/momdoc/cover.html
+++ b/contrib/mom/momdoc/cover.html
@@ -171,8 +171,8 @@ COVER_ADVANCE).
<p>
If you request copyright information (and have already given mom the
-reference macro,
-<a href="docprocessing.html#copyright">COPYRIGHT</a>),
+reference macro
+<a href="docprocessing.html#copyright">COPYRIGHT</a>)
she sets it, by default, in a smaller
<a href="definitions.html#ps">point size</a>
in the bottom right hand corner of the cover or doc-cover. The
@@ -182,8 +182,8 @@ altered via control macros.
<p>
Similarly, if you request miscellaneous information (and have
-already given mom the reference macro,
-<a href="docprocessing.html#misc">MISC</a>),
+already given mom the reference macro
+<a href="docprocessing.html#misc">MISC</a>)
she sets it, by default, in a smaller point size in the bottom left
hand corner of the cover or doc-cover. As with the copyright, the
position and type specs can be altered via control macros.
diff --git a/contrib/mom/momdoc/docelement.html
b/contrib/mom/momdoc/docelement.html
index 5c32883..0c03c2b 100644
--- a/contrib/mom/momdoc/docelement.html
+++ b/contrib/mom/momdoc/docelement.html
@@ -813,8 +813,8 @@ italic. Neither persists past the end of the paragraph.
<p>
Mom has no special control macro for colourizing paragraphs. If you
-wish a colourized paragraph, you must use the macro,
-<a href="color.html#color">COLOR</a>,
+wish a colourized paragraph, you must use the macro
+<a href="color.html#color">COLOR</a>
or the
<a href="definitions.html#inline">inline escape</a>,
<a href="color.html#color-inline"><kbd>\*[<colourname>]</kbd></a>,
@@ -1019,8 +1019,8 @@ that first paragraphs will once again not be indented.
<p>
By default, mom does not insert a blank line between
-paragraphs. If you would like her to do so, invoke the macro,
-<kbd>.PARA_SPACE</kbd>, without an argument, either before or after
+paragraphs. If you would like her to do so, invoke the macro
+<kbd>.PARA_SPACE</kbd> without an argument, either before or after
<a href="docprocessing.html#start">START</a>.
PARA_SPACE is a toggle macro, therefore passing it any argument
(<b>OFF, QUIT, Q, X</b>...) cancels its effect, meaning that
@@ -1106,7 +1106,7 @@ expect the blank line to appear.
<p>
Heads, subheads, and deeper levels of section headings are handled by
-a single macro, HEADING, to which you pass an argument stating the
+a single macro HEADING to which you pass an argument stating the
desired level. <kbd>.HEADING 1 "<text>"</kbd>, for
example, would be a main head; <kbd>.HEADING 2
"<text>"</kbd> would be a subhead; etc.
@@ -1302,7 +1302,7 @@ A single blank line precedes all levels of heading.
<h4 id="heading-style" class="docs" style="margin-bottom: -.5em">The
HEADING_STYLE macro</h4>
<p>
-Styling heads is accomplished with a single macro,
+Styling heads is accomplished with a single macro
<br/>
<span class="pre-in-pp">
.HEADING_STYLE <level>
@@ -1527,8 +1527,8 @@ the chapter number, it’s use need not be restricted
to
You can use it with any document type. Furthermore, even if
your doctype isn’t <kbd>CHAPTER</kbd>, you can identify
the document as a chapter for the purposes of numbering head
-elements by invoking the macro,
-<a href="docprocessing.html#chapter"><kbd>.CHAPTER</kbd></a>,
+elements by invoking the macro
+<a href="docprocessing.html#chapter"><kbd>.CHAPTER</kbd></a>
with a
<a href="definitions.html#numericargument">numeric argument</a>
in your document setup.
@@ -1592,7 +1592,7 @@ otherwise kept mom's settings, you need only do
<div id="parahead" class="box-important">
<p class="tip-top">
<span class="important">Important:</span>
-The macro, PARAHEAD, is no longer available. You must create paragraph
+The macro PARAHEAD is no longer available. You must create paragraph
heads using the
<a href="#heading">HEADING</a>
macro. Mom will abort with an informational message whenever she
@@ -1717,7 +1717,7 @@ The former style defaults for HEAD were:
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
-The macro, NUMBER_HEADS, from pre-2.0 versions of mom, can still be
+The macro NUMBER_HEADS from pre-2.0 versions of mom, can still be
used, though it is now a wrapper for
<br/>
<span class="pre-in-pp">
@@ -1758,7 +1758,7 @@ The former style defaults for SUBHEAD were:
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
-The macro, NUMBER_SUBHEADS, from pre-2.0 versions of mom, can still be
+The macro NUMBER_SUBHEADS from pre-2.0 versions of mom, can still be
used, though it is now a wrapper for
<br/>
<span class="pre-in-pp">
@@ -1800,7 +1800,7 @@ The former style defaults for SUBSUBHEAD were:
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
-The macro, NUMBER_SUBSUBHEADS, from pre-2.0 versions of mom, can still be
+The macro NUMBER_SUBSUBHEADS from pre-2.0 versions of mom, can still be
used, though it is now a wrapper for
<br/>
<span class="pre-in-pp">
@@ -2491,7 +2491,7 @@ Inline escape: <b><kbd>\*[CODE]</kbd></b>
</p>
<p>
-When you invoke the macro, <kbd>.CODE</kbd>, or insert <kbd>\*[CODE]</kbd> into
+When you invoke the macro <kbd>.CODE</kbd> or insert <kbd>\*[CODE]</kbd> into
running text, mom switches to a
<a href="definitions.html#fixedwidthfont">fixed-width font</a>
(Courier, by default) and turns
@@ -2502,7 +2502,7 @@ off.
<p>
If your code includes the backslash character, which is
groff’s escape character, you will have to change the
-escape character temporarily to something else with the macro,
+escape character temporarily to something else with the macro
<a href="goodies.html#esc-char">ESC_CHAR</a>.
Mom has no way of knowing what special characters you’re going
to use in code snippets, therefore she cannot automatically replace
@@ -2722,7 +2722,7 @@ digits and letters.
<p>
Setting lists with mom is easy. First, you initialize a list with
the LIST macro. Then, for every item in the list, you invoke
-the macro, <kbd>.ITEM</kbd>, followed by the text of the item.
+the macro <kbd>.ITEM</kbd> followed by the text of the item.
When a list is finished, you exit the list with
<kbd>.LIST OFF</kbd> (or <kbd>QUIT, END, BACK,</kbd> etc.)
</p>
@@ -2745,7 +2745,7 @@ left margin of running text that comes before it, like
this:
o a couple of hours at the piano
</span>
In other words, mom does not, by default, indent entire lists.
-Indenting a list is controlled by the macro,
+Indenting a list is controlled by the macro
<a href="#shift-list">SHIFT_LIST</a>.
(This is a design decision; there are too many instances where a
default indent is not desirable.) Equally, mom does not add any
@@ -2764,6 +2764,21 @@ and returns you to the left margin of running text.
</p>
<p>
+If
+<kbd><a href="typesetting.html#quad">QUAD CENTER</a></kbd>
+is in effect when LIST is invoked, the list is set quad left but
+centered on the page as a block, based on the longest line of list
+text. Equally, if <kbd>QUAD RIGHT</kbd> in in effect, the list is
+set flush left but quadded right as a block. If you want a centered
+or right-quadded list in an otherwise left-quadded or justified
+document, simply invoke <kbd>.QUAD <direction></kbd>
+before the list and reset it afterwards. Do not use
+<kbd><a href="typesetting.html#lrc">CENTER</a></kbd>
+or
+<kbd><a href="typesetting.html#lrc">RIGHT</a></kbd>
+</p>
+
+<p>
Finally, lists can be used in documents created with either the
<a href="docprocessing.html#top">document processing macros</a>
or the
@@ -2777,7 +2792,7 @@ or the
</div>
<div class="box-macro-args">
-Macro: <b>LIST</b> <kbd class="macro-args">[ BULLET | DASH | DIGIT | ALPHA |
alpha | ROMAN<n> | roman<n> | USER <user-defined enumerator>
| PLAIN ] [ <separator> ] [ <prefix> ] [ <anything> ]</kbd>
+Macro: <b>LIST</b> <kbd class="macro-args">[ BULLET | DASH | DIGIT | ALPHA |
alpha | ROMAN<n> | roman<n> | USER <user-defined enumerator>
| PLAIN | VARIABLE <character>] [ <separator> ] [ <prefix> ]
[ <anything> ]</kbd>
</div>
<p>
@@ -2849,13 +2864,41 @@ up like this:
</p>
<p>
-The argument, <kbd>USER</kbd>, lets you make up your own enumerator,
-and must be followed by a second argument: what you’d like the
-enumerator to look like.
+The argument <kbd>VARIABLE <character></kbd> lets
+you choose different enumerators for the items in a list.
+<kbd><character></kbd> is the widest enumerator to
+be used. Thus, if you have a list enumerated by both bullets
+and em-dashes, you’d set it up with
+<br/>
+<span class="pre-in-pp">
+ .LIST VARIABLE \[em]
+</span>
+and select the enumerator you want with
+<br/>
+<span class="pre-in-pp">
+ .ITEM \[em]
+</span>
+or
+<br/>
+<span class="pre-in-pp">
+ .ITEM \[bu]
+</span>
+If your enumerator contains spaces, you must enclose the
+<kbd><character></kbd> argument in both LIST and ITEM in
+double-quotes,
+e.g.
+<br/>
+<span class="pre-in-pp">
+ .LIST VARIABLE "\*[UP 1p]\[bu]\*[DOWN 1p]"
+ .ITEM "\*[UP 1p]\[bu]\*[DOWN 1p]"
+</span>
</p>
<p>
-For example, if you want a list enumerated with <kbd>=></kbd>,
+The argument <kbd>USER</kbd> lets you make up your own enumerator,
+and must be followed by a second argument: what you’d like the
+enumerator to look like. For example, if you want a list enumerated
+with <kbd>=></kbd>,
<br/>
<span class="pre-in-pp">
.LIST USER =>
@@ -2885,10 +2928,14 @@ of <kbd>\[sq]</kbd> slightly, you might do
<span class="pre-in-pp">
.LIST USER "\*[UP .25p]\[sq]\*[DOWN .25p]"
or
- .LIST USER \v'-.25p]\[sq]\[\v'.25p']
+ .LIST USER \v'-.25p'\[sq]\v'.25p'
</span>
</p>
+<p>
+The argument <kbd>PLAIN</kbd> initializes a list with no enumerator.
+</p>
+
<div class="box-tip">
<p class="tip">
<span class="note">Note:</span>
@@ -3040,7 +3087,7 @@ is created like this:
Lorem ipsum dolor sit amet, consetetur sadipscing elitr,
sed diam nonumy eirmod tempor invidunt ut labore.
</span>
-Alternatively, you may use the single-purpose macro,
+Alternatively, you may use the single-purpose macro
<kbd>.QUIT_LISTS</kbd>, to get yourself out of a list structure. In
the example above, the two <kbd>.LIST OFF</kbd> lines could be
replaced with a single <kbd>.QUIT_LISTS</kbd>.
@@ -3051,7 +3098,7 @@ replaced with a single <kbd>.QUIT_LISTS</kbd>.
</div>
<div class="box-macro-args">
-Macro: <b>ITEM</b>
+Macro: <b>ITEM</b> <kbd class="macro-args">[<enumerator>]</kbd>
</div>
<p>
@@ -3059,7 +3106,9 @@ After you’ve initialized a list with
<a href="#list">LIST</a>,
precede each item you want in the list with <kbd>.ITEM</kbd>. Mom
takes care of everything else with respect to setting the item
-appropriate to the list you’re in.
+appropriate to the list you’re in. If you’ve chosen the
+<kbd>VARIABLE</kbd> argument when invoking LIST, ITEM must be
+followed by an enumerator character.
</p>
<p>
@@ -3199,7 +3248,7 @@ normal state of affairs for the alpha'ed list under
</span>
would be d), e) and f). The solution, in such a case, is simply
to reset the enumerator—before <kbd>.ITEM</kbd>—with
-the macro, <kbd>.RESET_LIST</kbd>. By default, with no argument,
+the macro <kbd>.RESET_LIST</kbd>. By default, with no argument,
<kbd>.RESET_LIST</kbd> resets the enumerator to 1, A, a, I or i
depending on the style of enumerator. You may, if you wish, pass
<kbd>.RESET_LIST</kbd> a
@@ -3221,7 +3270,7 @@ the right or the left of the single-numeral digits?
</p>
<p>
-If you want the extra space to the right, invoke the macro,
+If you want the extra space to the right, invoke the macro
<kbd>.PAD_LIST_DIGITS</kbd> (with no argument), after
<kbd>.LIST</kbd> and before <kbd>.ITEM</kbd>. This will produce
something like
@@ -4352,7 +4401,7 @@ macros:
<p style="margin-left: .5em;">
Mom, by default, surrounds footnote line numbers with square
-brackets. The style of the brackets may be changed with the macro,
+brackets. The style of the brackets may be changed with the macro
<br/>
<span class="pre-in-pp">
.FOOTNOTE_LINENUMBER_BRACKETS
@@ -5772,7 +5821,7 @@ numbers are flush right with each other.
<p class="tip-bottom">
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,
+macro
<a href="docelement.html#endnote-numbers-align">ENDNOTE_NUMBERS_ALIGN</a>,
to set the desired amount of reserved space, e.g.,
<br/>
@@ -5802,9 +5851,9 @@ When your
<a href="#endnote-marker-style">ENDNOTE_MARKER_STYLE</a>
is <kbd>LINE</kbd>, mom, by default, inserts a space equal to
1/2-<a href="definitions.html#em">en</a>
-between the linenumber and the text of an endnote. For aesthetic reasons, you
may want
-to change the size of the gap, which is done with the macro,
-ENDNOTE_LINENUMBER_GAP.
+between the linenumber and the text of an endnote. For aesthetic
+reasons, you may want to change the size of the gap, which is done
+with the macro ENDNOTE_LINENUMBER_GAP.
</p>
<p>
@@ -5828,7 +5877,7 @@ Macro: <b>ENDNOTE_LINENUMBER_BRACKETS</b> <kbd
class="macro-args">PARENS | SQUAR
<p>
By default, mom puts endnote line numbers inside square brackets.
-The style of the brackets may be changed with the macro,
+The style of the brackets may be changed with the macro
ENDNOTE_LINENUMBER_BRACKETS, which takes one of three possible
arguments: <kbd>PARENS</kbd> (“round” brackets),
<kbd>SQUARE</kbd> (the default) or <kbd>BRACES</kbd> (curly braces).
@@ -6362,7 +6411,7 @@ document, mom will alert you on stderr.
<p>
If you’re writing in a language other than English, you can
-change what mom prints for END with the control macro,
+change what mom prints for END with the control macro
<a href="#finis-string">FINIS_STRING</a>.
</p>
@@ -6456,7 +6505,7 @@ it’s a short, dashed line composed of four hyphens.)
<p>
By default, mom sets the string you pass to FINIS all-caps.
If you’d prefer that she not do so, but rather respect
-the FINIS string exactly as you enter it, invoke the macro,
+the FINIS string exactly as you enter it, invoke the macro
<kbd>.FINIS_STRING_CAPS</kbd> with the <kbd>OFF</kbd> argument, like
this:
<br/>
@@ -6472,7 +6521,7 @@ this:
<h4 id="finis-color" class="docs">Changing the FINIS colour</h4>
<p>
-Invoking the control macro, <kbd>.FINIS_COLOR</kbd>, with a
+Invoking the control macro <kbd>.FINIS_COLOR</kbd> with a
pre-defined (or “initalized”) colour changes the colour
of both the FINIS string and the em-dashes that surround it. If you
use the
diff --git a/contrib/mom/momdoc/docprocessing.html
b/contrib/mom/momdoc/docprocessing.html
index 9c4ff30..d4e8cf3 100644
--- a/contrib/mom/momdoc/docprocessing.html
+++ b/contrib/mom/momdoc/docprocessing.html
@@ -667,7 +667,7 @@ tell her how you want your document formatted. What kind of
document is it? Should it be typeset or typewritten? Is this a
final copy (for the world to see) or just a draft? Mom calls
the macros that answer these questions “the docstyle
-macros.”, and they're essentially templates.
+macros”, and they're essentially templates.
</p>
<ul style="margin-top: -.5em; margin-bottom: -.5em;">
<li>PRINTSTYLE—typeset or typewritten</li>
@@ -760,7 +760,7 @@ here. The setup for Joe Blow’s story now looks like
this:
<p>
The final step in setting up a document is telling mom to start
document processing. It’s a no-brainer, just the single
-macro, START. Other than PRINTSTYLE, it’s the only macro
+macro START. Other than PRINTSTYLE, it’s the only macro
required for document processing.
</p>
@@ -2378,7 +2378,7 @@ 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
+macro INCLUDE. The right place for such style sheets is after
<a href="#printstyle">PRINTSTYLE</a>
and before
<a href="#start">START</a>.
@@ -2469,11 +2469,11 @@ I recommend doing so before you begin document
processing with
</p>
<p>
-The macro,
-<a href="color.html#color">COLOR</a>,
+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>\[<colorname>]</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,
@@ -2786,8 +2786,8 @@ By default, a docheader starts on the same
<a href="definitions.html#baseline">baseline</a>
as
<a href="definitions.html#running">running text</a>.
-If you’d like it to start somewhere else, use the macro,
-DOCHEADER_ADVANCE, and give it the distance you want (measured from
+If you’d like it to start somewhere else, use the macro
+DOCHEADER_ADVANCE and give it the distance you want (measured from
the top edge of the paper to the first baseline of the docheader),
like this:
<br/>
@@ -3536,7 +3536,7 @@ first.
</p>
<p>
-If you need the space, you must use the macro, ADD_SPACE, in
+If you need the space, you must use the macro ADD_SPACE in
conjunction with
<a href="typesetting.html#newpage">NEWPAGE</a>.
</p>
diff --git a/contrib/mom/momdoc/goodies.html b/contrib/mom/momdoc/goodies.html
index 63f95a1..b3d90f2 100644
--- a/contrib/mom/momdoc/goodies.html
+++ b/contrib/mom/momdoc/goodies.html
@@ -166,7 +166,7 @@ precedes the macro when it’s a
<div class="box-tip">
<p class="tip">
<span class="tip">Tip:</span>
-A particularly good candidate for ALIAS is the macro,
+A particularly good candidate for ALIAS is the macro
<a href="typesetting.html#ps">PT_SIZE</a>.
A more natural name for it would simply be PS, but PS conflicts
with the <b>eqn</b> equation preprocessor and thus mom uses the
@@ -741,7 +741,7 @@ as appropriate, reverting to the original nofill mode
afterwards.
<h3 id="underscore-weight" class="docs">Controlling the weight of
underscores</h3>
<p>
The weight (thickness) of underscores may be controlled with the
-macro, UNDERSCORE_WEIGHT. Thus, if you want underscores with a
+macro UNDERSCORE_WEIGHT. Thus, if you want underscores with a
weight of 1-1/2 points, you’d invoke:
<br/>
<span class="pre-in-pp">
@@ -883,8 +883,8 @@ 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
-there’s a special macro,
-<a href="#underline-specs">UNDERLINE_SPECS</a>,
+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
<br/>
diff --git a/contrib/mom/momdoc/graphical.html
b/contrib/mom/momdoc/graphical.html
index 059e5ad..15eac68 100644
--- a/contrib/mom/momdoc/graphical.html
+++ b/contrib/mom/momdoc/graphical.html
@@ -102,7 +102,7 @@ box.
<p>
Here’s the same box, drawn with mom’s box drawing
-macro,
+macro
<kbd><a href="#dbx">DBX</a></kbd>:
<br/>
<span class="pre-in-pp">
@@ -195,8 +195,8 @@ 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>,
+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>
@@ -260,7 +260,8 @@ arguments.
DRH is the only graphical object macro that may be invoked
without arguments. The weight (“thickness”) of
the rule is determined by the argument you last gave the
-macro, <a href="inlines.html#rule-weight">RULE_WEIGHT</a>.
+macro
+<a href="inlines.html#rule-weight">RULE_WEIGHT</a>.
DRH, used this way, is exactly equivalent to entering the
<a href="definitions.html#inlines">inline escape</a>, <a
href="inlines.html#inline-rule-mom"><kbd>\*[RULE]</kbd></a>.
diff --git a/contrib/mom/momdoc/headfootpage.html
b/contrib/mom/momdoc/headfootpage.html
index c6ea468..fc6e7cf 100644
--- a/contrib/mom/momdoc/headfootpage.html
+++ b/contrib/mom/momdoc/headfootpage.html
@@ -249,8 +249,8 @@ Size* -.5 (points) -.5 (points) -2
(points)
<p style="margin-top: -1.5em;">
You can, of course, change any of the defaults using the appropriate
control macros. And should you wish to design headers from the
-ground up, mom has a special macro,
-<a href="#hdrftr-plain">HEADER_PLAIN</a>,
+ground up, mom has a special macro
+<a href="#hdrftr-plain">HEADER_PLAIN</a>
that removes all type adjustments to headers. The
type specs for running text are used instead, providing a simple
reference point for any alterations you want to make to the family,
@@ -287,9 +287,9 @@ page.
<p>
The distance between headers and the start
-of running text can be controlled with the macro,
-<a href="#hdrftr-gap">HEADER_GAP</a>
-(effectively making HEADER_MARGIN + HEADER_GAP the top margin of
+of running text can be controlled with the macro
+<a href="#hdrftr-gap">HEADER_GAP</a>,
+effectively making HEADER_MARGIN + HEADER_GAP the top margin of
running text unless you give mom a literal top margin (with
<a href="typesetting.html#t-margin">T_MARGIN</a>)
or
@@ -384,8 +384,8 @@ there’s no need to turn headers off first.
</div>
<p style="margin-top: -.5em">
-If you need both headers and footers, there’s a special macro,
-<a href="#headers-and-footers">HEADERS_AND_FOOTERS</a>,
+If you need both headers and footers, there’s a special macro
+<a href="#headers-and-footers">HEADERS_AND_FOOTERS</a>
that allows you to set it up.
</p>
@@ -1802,13 +1802,13 @@ string, use the escape sequence for the pound sign
<p>
Normally, mom prints either a header or a footer, but not both, depending on
whether
-<a href="docprocessing.html#header">HEADERS</a>
+<a href="#headers">HEADERS</a>
or
-<a href="docprocessing.html#footer">FOOTERS</a>
+<a href="#footers">FOOTERS</a>
is enabled. (Page numbering, whether in the top margin
or the bottom, is not considered a header or a footer.)
Should you need both headers and footers on the same page, the
-single macro, HEADERS_AND_FOOTERS, is the way to set it up.
+single macro HEADERS_AND_FOOTERS is the way to set it up.
</p>
<div id="headers-and-footers" class="box-macro-args">
diff --git a/contrib/mom/momdoc/images.html b/contrib/mom/momdoc/images.html
index 301d5bf..affa76d 100644
--- a/contrib/mom/momdoc/images.html
+++ b/contrib/mom/momdoc/images.html
@@ -290,6 +290,22 @@ optical centering between surrounding blocks of type. A
unit of
measure is required.
</p>
+<div class="box-tip">
+<p class="tip-top">
+<span class="note">Tip:</span>
+You may sometimes find that a PDF_IMAGE at the bottom of a page
+doesn’t sit flush on the bottom margin, however attempts to lower it
+by adding space beforehand result in it being deferred to the next
+page.
+</p>
+
+<p class="tip-bottom">
+The solution is to introduce <i>negative</i> space before the image
+so that it displays on the page, then lower it to the bottom margin
+with PDF_IMAGE’s ADJUST argument.
+</p>
+</div>
+
<h5 class="docs" style="margin-top: 1em; text-transform: none">'NO_SHIM'</h5>
<p>
@@ -1675,7 +1691,7 @@ fit, if any, are output in order immediately after the
first.
<p>
Lastly, if your diagrams contain text, you may set all the type
parameters for the text (family, font, size, leading) separately
-from the <b>pic</b> block with the macro,
+from the <b>pic</b> block with the macro
<a href="#pic-text-style">PIC_TEXT_STYLE</a>.
If you need to change the type parameters within the block
on-the-fly, you must use <b>pic</b>’s native facilities for
@@ -2179,7 +2195,7 @@ pdf images) and tables. This behaviour may be modified
with the
macro
<a href="#caption-after-label">CAPTION_AFTER_LABEL</a>.
Equations always have their captions set underneath. All aspects of
-the text style for captions may be set with the macro,
+the text style for captions may be set with the macro
<a href="#captions-labels-sources">CAPTIONS</a>.
</p>
@@ -2191,10 +2207,10 @@ above the table, per MLA style, and the source for the
table, if
any, appears underneath. Labels for figures are set underneath.
Equation labels, by default, are set on the same baseline as the
last line of the equation. Like captions, all aspects of text style
-for labels may be established with a single macro,
-<a href="#labels">LABELS</a>. Furthermore, mom can autolabel
-figures, tables, and equations, with or without a prefixed chapter
-number.
+for labels may be established with a single macro
+<a href="#labels">LABELS</a>.
+Furthermore, mom can autolabel figures, tables, and equations, with
+or without a prefixed chapter number.
</p>
<div class="macro-id-overline">
diff --git a/contrib/mom/momdoc/inlines.html b/contrib/mom/momdoc/inlines.html
index 1ea67d3..2711f8f 100644
--- a/contrib/mom/momdoc/inlines.html
+++ b/contrib/mom/momdoc/inlines.html
@@ -388,7 +388,7 @@ up to a limit of 36).
<p id="kernunit">
The default size of a kern unit is 1/36 of the current point size;
-this may be changed by invoking the macro, <kbd>.KERN_UNIT</kbd>,
+this may be changed by invoking the macro <kbd>.KERN_UNIT</kbd>
with the desired value, which represents a fraction of the current
point size. For example, to change the kern unit to 1/54 of the
current point size,
@@ -578,9 +578,9 @@ e.g., <kbd>\E*[ALD.5]</kbd>.
<h3 id="inline-b-mom" class="docs">Terminate a line without advancing on the
page</h3>
<p>
Sometimes, you want mom to break a line but not advance on the page.
-This can be accomplished with the macro,
+This can be accomplished with the macro
<a href="typesetting.html#el">EL</a>
-or with the escape, <kbd>\*[B]</kbd>. Simply attach <kbd>\*[B]</kbd>
+or with the escape <kbd>\*[B]</kbd>. Simply attach <kbd>\*[B]</kbd>
to the end of any input line. Using the example given in the
document entry for EL, you'd use <kbd>\*[B]</kbd> like this:
<br/>
@@ -636,7 +636,7 @@ example:
</span>
The above draws a rule the full measure of the 6-pica line length.
-For another way to draw full measure rules, see the macro,
+For another way to draw full measure rules, see the macro
<a href="graphical.html#drh">DRH</a>.
</p>
diff --git a/contrib/mom/momdoc/letters.html b/contrib/mom/momdoc/letters.html
index 687c824..b5a112e 100644
--- a/contrib/mom/momdoc/letters.html
+++ b/contrib/mom/momdoc/letters.html
@@ -141,7 +141,7 @@ macro.
<p>
At the end of the letter, should you wish a closing (“Yours
truly,” “Sincerely,” “Hugs and
-kisses”), invoke the macro, <kbd>.CLOSING</kbd>, on a line
+kisses”), invoke the macro <kbd>.CLOSING</kbd> on a line
by itself, and follow it with the text of the closing. <b>N.B.</b>
Don’t put your name here; mom supplies it automatically from
<a href="docprocessing.html#author">AUTHOR</a>),
diff --git a/contrib/mom/momdoc/macrolist.html
b/contrib/mom/momdoc/macrolist.html
index 809f7b8..130ffc3 100644
--- a/contrib/mom/momdoc/macrolist.html
+++ b/contrib/mom/momdoc/macrolist.html
@@ -1378,28 +1378,28 @@ elsewhere in the documentation.
<a href="cover.html#cover-intro">+++ Document and section cover (title)
pages</a></th>
</tr>
<tr>
-<td><a href="cover.html#cover">COVER</a></td><td>-- information to include in
a section cover</td>
-</tr>
-<tr>
<td><a href="cover.html#cover">DOC_COVER</a></td><td>-- information to include
in a document cover</td>
</tr>
<tr>
-<td><a href="cover.html#on-off">COVERS</a></td><td>-- printing of section
covers on/off</td>
+<td><a href="cover.html#cover">COVER</a></td><td>-- information to include in
a section cover</td>
</tr>
<tr>
<td><a href="cover.html#on-off">DOC_COVERS</a></td><td>-- printing of document
covers on/off</td>
</tr>
<tr>
-<td><a href="cover.html#covertext">DOC_COVERTEXT</a></td><td>-- printing of
document covers on/off</td>
+<td><a href="cover.html#on-off">COVERS</a></td><td>-- printing of section
covers on/off</td>
+</tr>
+<tr>
+<td><a href="cover.html#covertext">DOC_COVERTEXT</a></td><td>-- user-added
text for document covers</td>
</tr>
<tr>
-<td><a href="cover.html#covertext">COVERTEXT</a></td><td>-- printing of
document covers on/off</td>
+<td><a href="cover.html#covertext">COVERTEXT</a></td><td>-- user-added text
for section covers</td>
</tr>
<tr>
-<td><a href="cover.html#coverimage">DOC_COVER_IMAGE</a></td><td>-- printing of
document covers on/off</td>
+<td><a href="cover.html#coverimage">DOC_COVER_IMAGE</a></td><td>-- add images
to document covers</td>
</tr>
<tr>
-<td><a href="cover.html#coverimage">COVER_IMAGE</a></td><td>-- printing of
document covers on/off</td>
+<td><a href="cover.html#coverimage">COVER_IMAGE</a></td><td>-- add images to
document covers</td>
</tr>
<tr>
<td><a href="cover.html#cover-control">Control macros</a></td><td>-- change
style defaults for covers</td>
@@ -1425,9 +1425,6 @@ elsewhere in the documentation.
<tr>
<td><a href="rectoverso.html#collate">COLLATE</a></td><td>-- join documents
(chapters/sections)</td>
</tr>
-<tr>
-<td><a href="docprocessing.html#shim">SHIM</a></td><td>-- advance to next
valid baseline</td>
-</tr>
</table>
<div class="rule-long"><hr/></div>
diff --git a/contrib/mom/momdoc/refer.html b/contrib/mom/momdoc/refer.html
index 8d25629..962e1b4 100644
--- a/contrib/mom/momdoc/refer.html
+++ b/contrib/mom/momdoc/refer.html
@@ -353,7 +353,7 @@ for how to output the collected references.
<p>
For outputting an entire <kbd>refer</kbd> database, or
generating a comprehensive reading list from a database, see the
-macro,
+macro
<a href="#bibliography">BIBLIOGRAPHY</a>.
</p>
@@ -1099,7 +1099,7 @@ Macro: <b>REF</b>
</div>
<p>
-The macro, REF, tells mom that what follows is
+The macro REF tells mom that what follows is
<kbd>refer</kbd>-specific, a keyword-identified reference to a
<kbd>refer</kbd> database record. Depending on whether you’ve issued
a
diff --git a/contrib/mom/momdoc/tables-of-contents.html
b/contrib/mom/momdoc/tables-of-contents.html
index 89cbea2..efa9aee 100644
--- a/contrib/mom/momdoc/tables-of-contents.html
+++ b/contrib/mom/momdoc/tables-of-contents.html
@@ -181,8 +181,8 @@ desirable for others.
<p>
When
<a href="using.html#pdfmom" style="font-weight: bold">pdfmom</a>
-is used to process files with a table of contents, the macro,
-<kbd>.AUTO_RELOCATE_TOC</kbd>, can be used to reposition the table
+is used to process files with a table of contents, the macro
+<kbd>.AUTO_RELOCATE_TOC</kbd> can be used to reposition the table
of contents to the top of the output document, with the presence
of a cover and/or title page sensibly taken into account. Full
AUTO_RELOCATE_TOC usage is described in the manual,
@@ -517,7 +517,7 @@ immediately prior to <kbd>.TOC</kbd>.
</p>
<p>
-A special macro,
+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
table of contents pages' numbers, not the page number references of
diff --git a/contrib/mom/momdoc/typesetting.html
b/contrib/mom/momdoc/typesetting.html
index b5e455b..329d1c5 100644
--- a/contrib/mom/momdoc/typesetting.html
+++ b/contrib/mom/momdoc/typesetting.html
@@ -197,7 +197,7 @@ have to worry about them.
<p>
Mom documents processed directly with <strong>groff</strong>, or with
-<strong>pdfroff</strong>, or with <strong>pdfmom -Tps</strong>, require
+<strong>pdfroff</strong>, or with <strong>pdfmom ‑Tps</strong>,
require
that the papersize be given on the command line as well if the
papersize is different from the default on your system. You can
verify—or change—the default papersize by inspecting the
@@ -1359,8 +1359,8 @@ a period. Notice that you must append the
<div class="box-tip">
<p class="tip">
-<span class="note">Note:</span> The right margin macro,
-<a href="#r-margin">(R_MARGIN)</a>,
+<span class="note">Note:</span> The right margin macro
+<a href="#r-margin">(R_MARGIN)</a>
can also be used to set line length.
</p>
</div>
@@ -2320,7 +2320,7 @@ Macro: <b>RW</b> <kbd class="macro-args"><amount of
whitespace reduction betw
<p>
RW (<span style="text-decoration: underline;">R</span>educe <span
style="text-decoration: underline;">W</span>hitespace)
-and its corresponding macro,
+and its corresponding macro
EW (<span style="text-decoration: underline;">E</span>xpand <span
style="text-decoration: underline;">W</span>hitespace),
allow you to tighten (or loosen)
<a href="definitions.html#outputline">output lines</a>
diff --git a/contrib/mom/momdoc/version-2.html
b/contrib/mom/momdoc/version-2.html
index 94fe12f..df83c11 100644
--- a/contrib/mom/momdoc/version-2.html
+++ b/contrib/mom/momdoc/version-2.html
@@ -102,7 +102,7 @@ if their 1.x defaults are not desired.
In conjunction with the changes to nested heads, Table of Contents
generation has also been rethought. Greater flexibility in the
inclusion of toc entry numbering been added. Like nested heads,
-there’s a new macro, <kbd>TOC_ENTRY_STYLE</kbd>, that permits
+there’s a new macro <kbd>TOC_ENTRY_STYLE</kbd> that permits
styling of each level in the toc hierarchy separately. The default
overall layout has also been significantly improved, achieving a
level of typographical elegance formerly lacking. Best of all, the
@@ -214,7 +214,7 @@ The 1.x macros
<span class="pre-in-pp">
HEAD SUBHEAD SUBSUBHEAD
</span>
-are now deprecated and have been replaced by a single macro,
+are now deprecated and have been replaced by a single macro
<br/>
<span class="pre-in-pp">
<a href="docelement.html#heading"><kbd>HEADING <n></kbd></a>
@@ -229,7 +229,7 @@ destination.
</p>
<p>
-Styling of headings is managed by a single macro,
+Styling of headings is managed by a single macro
<br/>
<span class="pre-in-pp">
<a href="docelement.html#heading"><kbd>HEADING_STYLE <n></kbd></a>
@@ -334,7 +334,7 @@ Version 2.1 adds these features:
<li>the ability to style every element appearing in docheaders and
automatically-generated cover/title pages separately</li>
<li>macros to place images on cover/title pages</li>
- <li>a new macro, COVERTEXT, that allows adding text (e.g. an
+ <li>a new macro COVERTEXT that allows adding text (e.g. an
Abstract) to automatically-generated cover/title pages or to
create cover/title pages entirely by hand</li>
<li>separate indent control macros for QUOTES and BLOCKQUOTES</li>
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: Mostly grammar fixes to docs (restrictive and non-restrictive apposites).,
Peter Schaffter <=