groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 06/14: [ms]: Fix documentation style nits.


From: G. Branden Robinson
Subject: [groff] 06/14: [ms]: Fix documentation style nits.
Date: Thu, 15 Jul 2021 15:41:15 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 68f932b0ec098bdcac7f914d04a1ce1ed99e4f5e
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Jul 12 21:02:25 2021 +1000

    [ms]: Fix documentation style nits.
    
    * doc/ms.ms: Set FR register to "1" for full-length footnotes.
    
    * doc/groff.texi (Adjustment, Tab Stops in ms, ms Headers and Footers):
    * doc/ms.ms (Tab stops, Headers and footers):
    * tmac/groff_ms.7.man (Tab stops, Headers and footers): Tighten wording.
    
    * doc/groff.texi (Differences from AT&T ms):
    * doc/ms.ms (Differences from AT&T ms):
    * tmac/groff_ms.7.man (Differences from AT&T ms):
      Fix inappropriately nonparallel grammar in conjunctive structure.
    
    * doc/ms.ms (Tab stops): Document `TA` with boxed table.
    * tmac/groff_ms.7.man (Tab stops): Document `TA` with tagged paragraph.
---
 doc/groff.texi      | 21 ++++++++++-----------
 doc/ms.ms           | 27 ++++++++++++++++++---------
 tmac/groff_ms.7.man | 21 +++++++++++----------
 3 files changed, 39 insertions(+), 30 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 62c5691..26a06cf 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3916,8 +3916,8 @@ There are multiple ways to produce headers and footers.  
One is to
 define the strings @code{LH}, @code{CH}, and @code{RH} to set the left,
 center, and right headers, respectively; and @code{LF}, @code{CF}, and
 @code{RF} to set the left, center, and right footers similarly.  This
-approach works best for documents that do not distinguish between odd
-and even pages.
+approach works best for documents that do not distinguish odd and even
+pages.
 
 Another method is to call macros with arguments that set headers or
 footers for odd or even pages; these variables produce four
@@ -3967,9 +3967,8 @@ Use the @code{ta} request to define tab stops as needed.  
@xref{Tabs and
 Fields}.
 
 @Defmac {TA, , ms}
-Use this macro to reset the tab stops to the default for @file{ms}
-(every 5 ens).  Redefine the @code{TA} macro to create a different set
-of default tab stops.
+Reset the tab stops to the @file{ms} default (every 5 ens).
+Redefine this macro to create a different set of default tab stops.
 @endDefmac
 
 @c ---------------------------------------------------------------------
@@ -4315,10 +4314,10 @@ in the center footer (the @code{CF} string).
 Macros that cause @code{groff} @file{ms} to internally reset its
 paragraph rendering parameters (paragraphs, headings, and displays,
 among others) may change the indentation; they do so not by incrementing
-or decrementing it, but set it absolutely.  This can cause problems for
-documents that define additional macros of their own that try to
-manipulate indentation.  The solution is to use, not the @code{in}
-request, but the @file{ms} @code{RS} and @code{RE} macros.
+or decrementing it, but by setting it absolutely.  This can cause
+problems for documents that define additional macros of their own that
+try to manipulate indentation.  The solution is to use, not the
+@code{in} request, but the @file{ms} @code{RS} and @code{RE} macros.
 
 @item
 To make @code{groff} @file{ms} use the default page offset (which also
@@ -4854,8 +4853,8 @@ After GNU @code{troff} performs an automatic line break, 
it then tries
 to @dfn{adjust} the line: inter-word spaces are widened until the text
 reaches the right margin.  Extra spaces between words are preserved.
 Leading and trailing spaces are handled as noted above.  Text can be
-adjusted to the left or right margins only (instead of both), or
-centered; see @ref{Manipulating Filling and Adjustment}.
+aligned to the left or right margins or centered; see @ref{Manipulating
+Filling and Adjustment}.
 
 @c ---------------------------------------------------------------------
 
diff --git a/doc/ms.ms b/doc/ms.ms
index 4ceadc7..05e75aa 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -18,6 +18,7 @@
 .nr LT \n[LL]
 .nr PS 11
 .nr VS 13
+.ds FR 1
 .ie t .nr PI 3.5n
 .el   .nr PI 4n
 .ND July 2021
@@ -2408,8 +2409,8 @@ to set the left,
 center,
 and right footers similarly.
 .
-This approach works best for documents that do not distinguish between
-odd and even pages.
+This approach works best for documents that do not distinguish odd and
+even pages.
 .
 .
 .PP
@@ -2532,14 +2533,22 @@ Use the
 .CW ta
 request to set tab stops as needed.
 .
-Use the
-.CW TA
-macro to reset tabs to the default
+.
+.TS
+box;
+lb lb
+lf(CR) lx.
+Macro  Description
+_
+\&.TA  T{
+Reset the tab stops to the
+.I ms
+default
 (every 5 ens).
 .
-Redefine
-.CW .TA
-to create a different set of default tab stops.
+Redefine this macro to create a different set of default tab stops.
+T}
+.TE
 .KE
 .
 .
@@ -2768,7 +2777,7 @@ and displays,
 among others)
 may change the indentation;
 they do so not by incrementing or decrementing it,
-but set it absolutely.
+but by setting it absolutely.
 .
 This can cause problems for documents that define additional macros of
 their own that try to manipulate indentation.
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 791df59..43d8e2c 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -1451,8 +1451,8 @@ to set the left,
 center,
 and right footers similarly.
 .
-The approach works best for documents that do not distinguish between
-odd and even pages.
+The approach works best for documents that do not distinguish odd and
+even pages.
 .
 .
 .P
@@ -1561,14 +1561,15 @@ Use the
 .B ta
 request to set tab stops as needed.
 .
-Use the
-.B TA
-macro to reset tabs to the default
-(every 5n).
 .
-You can redefine the
-.B TA
-macro to create a different set of default tab stops.
+.TP
+.B .TA
+Reset the tab stops to the
+.I ms
+default
+(every 5 ens).
+.
+Redefine this macro to create a different set of default tab stops.
 .
 .
 .\" ====================================================================
@@ -1827,7 +1828,7 @@ and displays,
 among others)
 may change the indentation;
 they do so not by incrementing or decrementing it,
-but set it absolutely.
+but by setting it absolutely.
 .
 This can cause problems for documents that define additional macros of
 their own that try to manipulate indentation.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]