gbranden pushed a commit to branch master
in repository groff.
commit 21a811c37f40ee61787420efffc5e0f289cc6730
Author: G. Branden Robinson <[email protected]>
AuthorDate: Fri Aug 11 20:50:40 2023 -0500
[ms]: Fix style nits in docs.
* Clarify that the "point size" is the "type size".
* Protect literal "allbox" from hyphenation in docs.
* [groff_ms(7)]: Apply poor man's keep.
* [groff_ms(7)]: Drop no longer needed poor man's keep.
* Tighten wording.
---
doc/groff.texi | 32 +++++++++++++++-----------------
doc/ms.ms | 24 +++++++++++-------------
tmac/groff_ms.7.man | 30 ++++++++++++++----------------
3 files changed, 40 insertions(+), 46 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index 3814ec6af..bd9188470 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3322,10 +3322,10 @@ Paragraphing macros @dfn{break}, or terminate, any
pending output line
so that a new paragraph can begin. Several paragraph types are
available, differing in how indentation applies to them: to left, right,
or both margins; to the first output line of the paragraph, all output
-lines, or all but the first. All paragraphing macro calls cause the
-insertion of vertical space in the amount stored in the @code{PD}
-register, except at page or column breaks. Alternatively, a blank input
-line breaks the output line and vertically spaces by one vee.
+lines, or all but the first. These calls insert vertical space in the
+amount stored in the @code{PD} register, except at page or column
+breaks. Alternatively, a blank input line breaks the output line and
+vertically spaces by one vee.
@Defmac {LP, , ms}
Set a paragraph without any (additional) indentation.
@@ -3827,9 +3827,9 @@ money
@node Indented regions in ms, ms keeps and displays, Lists in ms, ms Body Text
@subsubsection Indented regions
-You may need to indent a region of text while otherwise formatting it
-normally. Indented regions can be nested; you can change @code{\n[PI]}
-before each call to vary the amount of inset.
+You can indent a region of text while otherwise formatting it normally.
+Such indented regions can be nested; change @code{\n[PI]} before each
+call to vary the amount of inset.
@Defmac {RS, , ms}
Begin a region where headings, paragraphs, and displays are indented
@@ -3891,13 +3891,12 @@ figure adjacent to the item it discusses. @file{ms}
provides the
@code{KS} and @code{KE} macros for this purpose.
You can alternatively specify a @dfn{floating keep}:@: if a keep cannot
-fit on the current page, @file{ms} holds its contents and
-allows material following the keep (in the source document) to fill the
-remainder of the current page. When the page breaks, whether by
-reaching the end or @code{bp} request, @file{ms} puts the floating keep
-at the beginning of the next page. This is useful for placing large
-graphics or tables that do not need to appear exactly where they occur
-in the source document.
+fit on the current page, @file{ms} holds it, allowing material following
+the keep (in the source document) to fill the remainder of the current
+page. When the page breaks by reaching its bottom or by @code{bp}
+request, @file{ms} puts the floating keep at the beginning of the next
+page. Use floating keeps to house large graphics or tables that do not
+need to appear exactly where they occur in the source document.
@DefmacList {KS, , ms}
@DefmacItemx {KF, , ms}
@@ -3940,9 +3939,8 @@ speeds.
.B2
@endCartoucheExample
-If you want a boxed keep to float, you will need to enclose the
-@code{B1} and @code{B2} calls within a pair of @code{KF} and @code{KE}
-calls.
+If you want a boxed keep to float, enclose the @code{B1} and @code{B2}
+calls within a pair of @code{KF} and @code{KE} calls.
@cindex displays [@file{ms}]
@dfn{Displays} turn off filling; lines of verse or program code are
diff --git a/doc/ms.ms b/doc/ms.ms
index fa6e946c6..83dcc2fae 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -1042,8 +1042,7 @@ to the first output line of the paragraph,
all output lines,
or all but the first.
.
-All paragraphing macro calls cause the insertion of vertical space in
-the amount stored in the
+These calls insert vertical space in the amount stored in the
.CW PD
register,
except at page or column breaks.
@@ -2146,11 +2145,10 @@ Indented regions
.
.
.LP
-You may need to indent a region of text while otherwise formatting it
-normally.
+You can indent a region of text while otherwise formatting it normally.
.
-Indented regions can be nested;
-you can change
+Such indented regions can be nested;
+change
.CW \[rs]n[PI]
before each call to vary the amount of inset.
.
@@ -2264,19 +2262,19 @@ You can alternatively specify a
.I "floating keep:"
if a keep cannot fit on the current page,
.I ms
-holds its contents and allows material following the keep
+holds it,
+allowing material following the keep
(in the source document)
to fill the remainder of the current page.
.
-When the page breaks,
-whether by reaching the end or
+When the page breaks by reaching its bottom or by
.CW bp
request,
.I ms
puts the floating keep at the beginning of the next page.
.
-This is useful for placing large graphics or tables that do not need to
-appear exactly where they occur in the source document.
+Use floating keeps to house large graphics or tables that do not
+need to appear exactly where they occur in the source document.
.
.
.TS
@@ -2358,7 +2356,7 @@ Happy Fun Ball may suddenly accelerate to dangerous
speeds.
.
.LP
If you want a boxed keep to float,
-you will need to enclose the
+enclose the
.CW .B1
and
.CW .B2
@@ -2645,7 +2643,7 @@ Attempting to place a multi-page table inside a keep can
lead to
unpleasant results,
particularly if the
.I tbl
-.CW allbox
+.CW \%allbox
option is used.
.KE
.
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 50402d4e4..6d50de180 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -291,7 +291,7 @@ lf(CR) lx l lf(CR).
Text settings
Parameter Definition Effective Default
_
-\[rs]n[PS] Point size next paragraph 10p
+\[rs]n[PS] Point (type) size next paragraph 10p
\[rs]n[VS] Vertical spacing (leading) next paragraph 12p
\[rs]n[HY] Hyphenation mode next paragraph 6
\[rs]*[FAM] Font family next paragraph T
@@ -326,7 +326,7 @@ lf(CR) lx l lf(CR).
Heading settings
Parameter Definition Effective Default
_
-\[rs]n[PSINCR] Point size increment next heading 1p
+\[rs]n[PSINCR] Point (type) size increment next heading 1p
\[rs]n[GROWPS] Size increase depth limit next heading 0
\[rs]n[HORPHANS] # of following lines kept next heading 1
\[rs]*[SN\-STYLE] Numbering style (alias) next heading \[rs]*[SN\-DOT]
@@ -354,7 +354,7 @@ Parameter Definition Effective Default
_
\[rs]n[FI] Indentation next footnote 2n
\[rs]n[FF] Format next footnote 0
-\[rs]n[FPS] Point size next footnote \[rs]n[PS]\-2p
+\[rs]n[FPS] Point (type) size next footnote \[rs]n[PS]\-2p
\[rs]n[FVS] Vertical spacing (leading) next footnote \[rs]n[FPS]+2p
\[rs]n[FPD] Paragraph distance (spacing) next footnote \[rs]n[PD]/2
\[rs]*[FR] Line length ratio \f[I]special 11/12
@@ -490,7 +490,7 @@ If the optional
.B no\-\:\%repeat\-\:\%info
argument is given,
.I ms
-produces a cover page but does not repeat any of its information on
+produces a cover page but does not repeat any of its information
subsequently
(but see the
.B DA
@@ -718,8 +718,7 @@ to the first output line of the paragraph,
all output lines,
or all but the first.
.
-All paragraphing macro calls cause the insertion of vertical space in
-the amount stored in the
+These calls insert vertical space in the amount stored in the
.B PD
register,
except at page or column breaks,
@@ -1245,10 +1244,9 @@ respectively.
.SS "Indented regions"
.\" ====================================================================
.
-You may need to indent a region of text while otherwise formatting it
-normally.
+You can indent a region of text while otherwise formatting it normally.
.
-Indented regions can be nested.
+Such indented regions can be nested.
.
.
.TP
@@ -1284,12 +1282,12 @@ You can alternatively specify a
.I floating keep:
if a keep cannot fit on the current page,
.I ms
-holds its contents and allows text following the keep
+holds it,
+allowing text following the keep
(in the source document)
to fill in the remainder of the current page.
.
-When the page breaks,
-whether by reaching the end or
+When the page breaks by reaching its bottom or by
.B bp
request,
.I ms
@@ -1355,11 +1353,9 @@ and by adding a small amount of vertical space before
calling
.BR .B2 .
.
.
-.br
-.ne 2v
.P
If you want a boxed keep to float,
-you will need to enclose the
+enclose the
.B .B1
and
.B .B2
@@ -1600,6 +1596,8 @@ provides a comprehensive reference to the preprocessor
and the format of
its bibliographic database.
.
.
+.br
+.ne 2v
.P
When
.I @g@refer
@@ -1618,7 +1616,7 @@ Attempting to place a multi-page table inside a keep can
lead to
unpleasant results,
particularly if the
.I tbl \" generic
-.RB \[lq] allbox \[rq]
+.RB \%\[lq] allbox \[rq]
option is used.
.
.
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
