groff-commit
[Top][All Lists]
Advanced

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

[groff] 05/06: [docs]: Fix ms documentation nits.


From: G. Branden Robinson
Subject: [groff] 05/06: [docs]: Fix ms documentation nits.
Date: Wed, 6 Oct 2021 16:19:16 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 3e38de4087f5d9c5ac628ef311c098b40640acaa
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Oct 7 06:52:45 2021 +1100

    [docs]: Fix ms documentation nits.
    
    * doc/doc.ms:
      - Set our own TC-MARGIN in doc/ms.ms.
      - Stop using DY string as it's undocumented.  (Neither Lesk nor
        Tuthill bothered, but it's always been there; maybe we should.)
      - Fix spurious paragraph break (from inadvertent blank line).
    
    * doc/doc.ms:
    * tmac/groff_ms.7.man:
      - Note provenance of SN string.
      - Use nonbreakable space idiomatically.
      - Fix typos.
---
 doc/ms.ms           | 21 ++++++++++-----------
 tmac/groff_ms.7.man |  8 ++++----
 2 files changed, 14 insertions(+), 15 deletions(-)

diff --git a/doc/ms.ms b/doc/ms.ms
index fcff898..c4d7282 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -19,10 +19,11 @@
 .nr PS 11
 .nr VS 13
 .ds FR 1
+.nr TC-MARGIN \w'00' \" expect 2-digit page numbers at most
 .ie t .nr PI 3.5n
 .el   .nr PI 4n
 .ND October 2021
-.EH '%''\*[DY]'
+.EH '%''October 2021'
 .EF ''''
 .OH 'Using \f[I]groff\f[] with the \f[I]ms\f[] macros''%'
 .OF ''''
@@ -951,7 +952,7 @@ Further automatic numbering,
 if used,
 resumes using the specified heading level indices as their predecessors.
 .
-\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper...
+.\" Although undocumented in Tuthill's 4.2BSD ms.diffs paper...
 This feature is a Berkeley extension.
 T}
 .TE
@@ -1044,7 +1045,8 @@ following redefinition of the alias for
 .CW \[rs]*[SN\-STYLE] .
 .
 The formatted number of the current section is available in
-.CW \[rs]*[SN] ,
+.CW \[rs]*[SN]
+(a feature first documented by Berkeley),
 facilitating its inclusion in
 .CW .XS /\c
 .CW .XA /\c
@@ -2721,8 +2723,8 @@ Because
 formatters process their input in a single pass,
 material on page 50,
 for example,
-cannot influence what appears on page 1\[em]this poses a challenge for a
-table of contents at its traditional location in front matter,
+cannot influence what appears on page\~1\[em]this poses a challenge for
+a table of contents at its traditional location in front matter,
 if you wish to avoid manually maintaining it.
 .
 .I ms
@@ -2735,13 +2737,12 @@ document.
 The table of contents can then be resequenced to its desired location
 as part of post-processing\[em]with a PDF page relocation tool,
 or by physically rearranging the pages of a printed document,
-depending on the output format and cirumstances.
+depending on the output format and circumstances.
 .
 .
 .PP
 Define an entry to appear in the table of contents by bracketing its
-text between calls to
-the
+text between calls to the
 .CW XS
 and
 .CW XE
@@ -2854,7 +2855,7 @@ Emit the table of contents entries.
 T}
 _
 \&.TC \f[R][\f[]no\f[R]]       T{
-Set the page number to 1,
+Set the page number to\~1,
 the page number format to lowercase Roman numerals,
 and call
 .CW PX
@@ -3352,8 +3353,6 @@ Without these documents close at hand,
 writing this document would have been a
 much more difficult task.
 .\" ------------------------
-.\" Toc here at end...
-.\" We need to fix the headers...
 .TC
 .
 .
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index bce46a6..4715ebc 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -805,7 +805,8 @@ following redefinition of the alias for
 .BR \[rs]*[SN\-STYLE] .
 .
 The formatted number of the current section is available in
-.BR \[rs]*[SN] ,
+.B \[rs]*[SN]
+(a feature first documented by Berkeley),
 facilitating its inclusion in
 .BR .XS / .XA / .XE
 table of contents entries.
@@ -1826,8 +1827,7 @@ it is a GNU extension.
 .\" ====================================================================
 .
 Define an entry to appear in the table of contents by bracketing its
-text between calls to
-the
+text between calls to the
 .B XS
 and
 .B XE
@@ -1938,7 +1938,7 @@ Emit the table of contents entries.
 .
 .TP
 .BR .TC \~[ no ]
-Set the page number to 1,
+Set the page number to\~1,
 the page number format to lowercase Roman numerals,
 and call
 .B PX



reply via email to

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