[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 14/16: [ms]: Tighten wording in docs.
From: |
G. Branden Robinson |
Subject: |
[groff] 14/16: [ms]: Tighten wording in docs. |
Date: |
Mon, 4 Sep 2023 13:31:28 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 781ac9cfcc6667f873945bc71c8e2eef388ef5d0
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Sep 4 10:29:41 2023 -0500
[ms]: Tighten wording in docs.
* doc/ms.ms: Tighten wording to make room on page for new language
responsive to Savannah #64531. Bump document date.
* doc/groff.texi (ms keeps and displays):
* tmac/groff_ms.7.man: Sync.
---
doc/groff.texi | 32 ++++++++++++++++----------------
doc/ms.ms | 27 ++++++++++++++-------------
tmac/groff_ms.7.man | 25 +++++++++++++------------
3 files changed, 43 insertions(+), 41 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index 5dfe465a5..50b8f8a79 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3932,13 +3932,13 @@ A @dfn{boxed keep} has a frame drawn around it.
boxed keep.
@endDefmac
-Boxed keep macros cause breaks; if you need to box a word or phrase
-within a line, see the @code{BX} macro in @ref{Typeface and decoration}.
-Box lines are drawn as close as possible to the text they enclose so
-that they are usable within paragraphs. If you wish to box one or more
-paragraphs, you may improve the appearance by calling @code{B1} after
-the first paragraphing macro, and by adding a small amount of vertical
-space before calling @code{B2}.
+Boxed keep macros cause breaks; to box words within a line, recall
+@code{BX} in @ref{Typeface and decoration}. Box lines are drawn as
+close as possible to the text they enclose so that they are usable
+within paragraphs. When boxing entire paragraphs thus, you may
+improve their appearance by calling @code{B1} after the first
+paragraphing macro, and invoking the @code{sp} request before calling
+@code{B2}.
@c Wrap example at 58 columns.
@CartoucheExample
@@ -3997,15 +3997,15 @@ extension.
End any display.
@endDefmac
-The distance stored in the @code{DD} register is inserted before and
-after each pair of display macros; this is a Berkeley extension. In
-@code{groff} @file{ms}, this distance replaces any adjacent
-inter-paragraph distance or subsequent spacing prior to a section
-heading. The @code{DI} register is a GNU extension; its value is an
-indentation applied to displays created with @samp{.DS} and @samp{.ID}
-without arguments, to @samp{.DS I} without an indentation argument, and
-to indented equations set with @samp{.EQ}. Changes to either register
-take effect at the next display boundary.
+@code{groff} @file{ms} inserts the distance stored in the @code{DD}
+register before and after each pair of display macros; this is a
+Berkeley extension. This distance replaces any adjacent inter-paragraph
+distance or subsequent spacing prior to a section heading. The
+@code{DI} register is a GNU extension; its value is an indentation
+applied to displays created with @samp{.DS} and @samp{.ID} without
+arguments, to @samp{.DS I} without an indentation argument, and to
+indented equations set with @samp{.EQ}. Changes to either register take
+effect at the next display boundary.
@c ---------------------------------------------------------------------
diff --git a/doc/ms.ms b/doc/ms.ms
index bc7b340d6..6eb757d49 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -36,8 +36,8 @@
.nr TC-MARGIN \w'00' \" expect 2-digit page numbers at most
.ie t .nr PI 3.5n
.el .nr PI 4n
-.ND July 2023
-.EH '%''July 2023'
+.ND September 2023
+.EH '%''September 2023'
.EF ''''
.OH 'Using \f[I]groff\f[] with the \f[I]ms\f[] macros''%'
.OF ''''
@@ -2326,19 +2326,21 @@ _
.KS
.LP
Boxed keep macros cause breaks;
-if you need to box a word or phrase within a line,
-see the
-.CW BX
-macro in section \[lq]Typeface and decoration\[rq] above.
+to box words within a line,
+recall
+.CW .BX
+in section \[lq]Typeface and decoration\[rq] above.
.
Box lines are drawn as close as possible to the text they enclose so
that they are usable within paragraphs.
.
-If you wish to place one or more paragraphs in a boxed keep,
+When boxing entire paragraphs thus,
you may improve their appearance by calling
.CW .B1
after the first paragraphing macro,
-and by adding a small amount of vertical space before calling
+and invoking the
+.CW sp
+request before calling
.CW .B2 .
.
.
@@ -2420,14 +2422,13 @@ cf(CR) s | lx .
.
.
.PP
-The distance stored in
+.I "groff ms"
+inserts the distance stored in
.CW \[rs]n[DD]
-is inserted before and after each pair of display macros;
+before and after each pair of display macros;
this is a Berkeley extension.
.
-In
-.I "groff ms" ,
-this distance replaces any adjacent inter-paragraph distance
+This distance replaces any adjacent inter-paragraph distance
or subsequent spacing prior to a section heading.
.
The
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 1a5ffc1d6..b1f492969 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1338,20 +1338,22 @@ End boxed keep.
.
.P
Boxed keep macros cause breaks;
-if you need to box a word or phrase within a line,
-see the
-.B BX
-macro in section \[lq]Highlighting\[rq] above.
+to box words within a line,
+recall
+.B .BX
+in section \[lq]Highlighting\[rq] above.
.
Box lines are drawn as close as possible to the text they enclose so
that they are usable within paragraphs.
.
-If you wish to place one or more paragraphs in a boxed keep,
+When boxing entire paragraphs thus,
you may improve their appearance by calling
.B .B1
after the first paragraphing macro,
-and by adding a small amount of vertical space before calling
-.BR .B2 .
+and invoking the
+.B sp
+request before calling
+.B .B2 .
.
.
.P
@@ -1451,14 +1453,13 @@ End any display.
.
.
.P
-The distance stored in
+.I "groff ms"
+inserts the distance stored in
.B \[rs]n[DD]
-is inserted before and after each pair of display macros;
+before and after each pair of display macros;
this is a Berkeley extension.
.
-In
-.IR "groff ms" ,
-this distance replaces any adjacent inter-paragraph distance
+This distance replaces any adjacent inter-paragraph distance
or subsequent spacing prior to a section heading.
.
The
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 14/16: [ms]: Tighten wording in docs.,
G. Branden Robinson <=