groff-commit
[Top][All Lists]
Advanced

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

[groff] 11/40: doc/ms.ms, groff_ms(7): Fix style nits.


From: G. Branden Robinson
Subject: [groff] 11/40: doc/ms.ms, groff_ms(7): Fix style nits.
Date: Wed, 10 Feb 2021 01:32:14 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit ac1064c6371543afa0d0f2b8bc1f8f1d36e99d7b
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Feb 6 14:49:28 2021 +1100

    doc/ms.ms, groff_ms(7): Fix style nits.
    
    * Rename subsection "Document control registers" to "Document control
      settings" since strings are also used for document parameterization.
      Update internal references.
    * Say simply "register" instead of "number register".
    * Use an empty request between sentences and where a break is expected.
    * Use two empty requests where vertical space is expected.
    * Break input lines at semicolons.
    * Set multi-word parentheticals on their own input lines.
    * Tighten wording.
    
    * tmac/groff_ms.7.man: Remove spurious quoting of arguments to .I
      request.
---
 doc/ms.ms           | 20 ++++++++++++++------
 tmac/groff_ms.7.man | 44 +++++++++++++++++++++++---------------------
 2 files changed, 37 insertions(+), 27 deletions(-)

diff --git a/doc/ms.ms b/doc/ms.ms
index 1fdac2e..d28fe6d 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -102,8 +102,9 @@ Basic information
 .XE
 .LP
 Most
-.I "number registers"
+.I registers
 have a default unit of measurement.
+.
 Specifying a unit explicitly does not cause any problems,
 and can avoid problems in complex situations.
 The following are typical units:
@@ -121,10 +122,12 @@ n width of a letter ``n'' in the current font
 m      width of a letter ``M'' in the current font
 P      pica (1/6\[sd])
 .TE
+.
+.
 .LP
-You set number registers by using the
+Set registers with using the
 .CW .nr
-request; for example:
+request.
 .RS
 .CW
 \&.nr PS 12
@@ -177,9 +180,11 @@ or Berkeley, and are not supported in
 By setting number registers,
 you can change your document's type (font and size),
 margins, spacing, headers and footers, and footnotes.
-See 
-.I "Document control registers"
+.
+See
+.I "Document control settings"
 below for more details.
+.
 .IP "\fBCover page\fP"
 A cover page consists of a title, the author's name and institution,
 an abstract, and the date.\**
@@ -1289,8 +1294,11 @@ Margins
 .XS
        Margins
 .XE
+.
+.
 .LP
-You control margins using a set of number registers.
+Control margins using registers.
+.
 The following table lists the register names and defaults:
 .TS
 box expand;
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index a2e7939..0625f74 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -105,13 +105,13 @@ are specific to AT&T or Berkeley, and are not supported in
 .
 .TP
 .B "Format and layout"
-By setting number registers,
+By setting registers and strings,
 you can change your document's
 margins, spacing, headers and footers, footnotes,
 and the base point size for the text.
 .
 See
-.I "Document control registers"
+.I "Document control settings"
 below for more details.
 .
 .TP
@@ -138,14 +138,13 @@ macro at the end of your document.
 .
 .
 .\" ====================================================================
-.SS "Document control registers"
+.SS "Document control settings"
 .\" ====================================================================
 .
-The following table lists the document control
-number registers.
+The following table lists the document control registers and strings.
 .
 For the sake of consistency,
-set registers related to margins at the beginning of your document,
+set parameters related to margins at the beginning of your document,
 or just after the
 .B RP
 macro.
@@ -917,7 +916,9 @@ The
 is usually a bullet character
 .B \[rs](bu
 for unordered lists,
-a number (or auto-incrementing number register) for numbered lists,
+a number
+(or auto-incrementing register)
+for numbered lists,
 or a word or phrase for indented (glossary-style) lists.
 .
 .IP
@@ -1301,7 +1302,7 @@ after printing the header
 .SS Margins
 .\" ====================================================================
 .
-You control margins using a set of number registers.
+Control margins using registers.
 .
 The following table lists the register names and defaults:
 .RS
@@ -1370,7 +1371,7 @@ is the space between columns.
 .
 The
 .B MINGW
-number register is the default gutter width.
+register is the default gutter width.
 .
 .
 .\" ====================================================================
@@ -1561,10 +1562,10 @@ documentation says that the
 .B CW
 and
 .B GW
-number registers can be used to control the column width and
-gutter width, respectively.
+registers can be used to control the column width and gutter width,
+respectively.
 .
-These number registers are not used in
+These registers are not used in
 .IR "groff ms" .
 .
 .IP \[bu]
@@ -1587,10 +1588,10 @@ and
 macros.
 .
 .IP \[bu]
-The number register
+The register
 .B GS
 is set to\~1 by the
-.I "groff ms"
+.I groff ms
 macros,
 but is not used by the Unix
 .I ms
@@ -1600,8 +1601,8 @@ Documents that need to determine whether they are being 
formatted with
 Unix
 .I ms
 or
-.I "groff ms"
-should use this number register.
+.I groff ms
+should use this register.
 .
 .IP \[bu]
 To make
@@ -1609,7 +1610,7 @@ To make
 use the default page offset (which also specifies the left margin),
 the
 .B PO
-number register must stay undefined until the first
+register must stay undefined until the first
 .B ms
 macro is evaluated.
 .
@@ -1686,7 +1687,7 @@ it is set to Times.
 .
 .LP
 The point size, vertical spacing, and inter-paragraph spacing for
-footnotes are controlled by the number registers
+footnotes are controlled by the registers
 .BR FPS ,
 .BR FVS ,
 and
@@ -1732,11 +1733,12 @@ produces an n with a tilde over it.
 .SH "Naming Conventions"
 .\" ====================================================================
 .
-The following conventions are used for names of macros, strings, and
-number registers.
+The following conventions are used for names of macros,
+strings,
+and registers.
 .
 External names available to documents that use the
-.I "groff ms"
+.I groff ms
 macros contain only uppercase letters and digits.
 .
 .



reply via email to

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