groff-commit
[Top][All Lists]
Advanced

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

[groff] 48/48: doc/ms.ms: Fix style and markup nits.


From: G. Branden Robinson
Subject: [groff] 48/48: doc/ms.ms: Fix style and markup nits.
Date: Thu, 15 Aug 2024 13:15:39 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 4e539c7889a3a6c87f554506a6b0a28752bbf1ed
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Aug 15 11:10:13 2024 -0500

    doc/ms.ms: Fix style and markup nits.
    
    * Define a string `date` for the document date, for DRY's sake.
    * Use singular unit names in scaling unit table.
    * Favor active voice over passive.
    * Recast descriptions of pic(1)- and eqn(1)-related macros to
      incorporate man page cross references.
    * Fix font style selections when naming registers and macros in section
      describing differences from AT&T ms.
    
    * tmac/groff_ms.7.man: Sync.
---
 doc/ms.ms           | 56 ++++++++++++++++++++++++++++++-----------------------
 tmac/groff_ms.7.man | 33 ++++++++++++++++++-------------
 2 files changed, 52 insertions(+), 37 deletions(-)

diff --git a/doc/ms.ms b/doc/ms.ms
index b30150724..784923bf5 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -36,8 +36,9 @@
 .nr TC-MARGIN \w'00' \" expect 2-digit page numbers at most
 .ie t .nr PI 3.5n
 .el   .nr PI 4n
-.ND September 2023
-.EH '%''September 2023'
+.ds date August 2024\"
+.ND \*[date]
+.EH '%''\*[date]'
 .EF ''''
 .OH 'Using \f[I]groff\f[] with the \f[I]ms\f[] macros''%'
 .OF ''''
@@ -251,13 +252,13 @@ cb cb
 cf(CR) l .
 Scaling unit   Description
 _
-i      inches (\[sd])
-c      centimeters
-p      points (1/72\[sd])
-P      picas (1/6\[sd])
-v      \[lq]vees\[rq]; current vertical spacing
-m      \[lq]ems\[rq]; width of an \[lq]M\[rq] in the current font
-n      \[lq]ens\[rq]; one-half em
+i      inch (\[sd])
+c      centimeter
+p      point (1/72\[sd])
+P      pica (1/6\[sd])
+v      \[lq]vee\[rq]; current vertical spacing
+m      \[lq]em\[rq]; width of an \[lq]M\[rq] in the current font
+n      \[lq]en\[rq]; one-half em
 .TE
 .
 .
@@ -1061,11 +1062,12 @@ register defines the minimum number of initial lines of 
any paragraph
 that must be kept together to avoid isolated lines at the bottom of a
 page.
 .
-If a new paragraph is started close to the bottom of a page,
+If a new paragraph starts close to the bottom of a page,
 and there is insufficient space to accommodate
 .CW \[rs]n[PORPHANS]
 lines before an automatic page break,
-then a page break is forced before the start of the paragraph.
+.I ms
+forces a page break before formatting the paragraph.
 .
 This is a GNU extension.
 .
@@ -1527,7 +1529,8 @@ that must be kept on the same page as the heading.
 .
 If insufficient space remains on the current page to accommodate the
 heading and this number of lines of paragraph text,
-a page break is forced before the heading is printed.
+.I ms
+forces a page break before setting the heading.
 .
 Any display macro call or
 .I tbl ,
@@ -2503,9 +2506,10 @@ T{
 \&.PF
 T}     T{
 .CW .PS
-begins a picture to be processed by the
-.I pic
-preprocessor;
+marks the start of a
+.I pic (1)
+preprocessor
+diagram;
 either of
 .CW .PE
 or
@@ -2535,11 +2539,12 @@ T{
 .br
 \&.EN
 T}     T{
-Demarcate an equation to be processed by the
+Demarcate mathematics to be processed by the
 .I eqn
 preprocessor.
 .
-The equation is centered by default;
+.I ms
+centers the equation by default;
 .I align
 can be
 .CW C ,
@@ -2552,9 +2557,12 @@ or indent it by
 .CW \[rs]n[DI] ,
 respectively.
 .
-If specified,
-.I label
-is set right-aligned.
+.I ms
+right-aligns any
+.I label .
+.
+See
+.I eqn (1).
 T}
 _
 T{
@@ -3987,8 +3995,8 @@ rather than to ignore them silently.
 .PP
 Research Tenth Edition \" possibly 9th
 Unix supported
-.B P1 /\c
-.B P2
+.CW P1 /\c
+.CW P2
 macros to bracket code examples;
 .I "groff ms"
 does not.
@@ -4130,13 +4138,13 @@ To make
 use the default page offset
 (which also specifies the left margin),
 the
-.B PO
+.CW PO
 register must stay undefined until the first
 .I ms
 macro is called.
 .
 This implies that
-.B \[rs]n[PO]
+.CW \[rs]n[PO]
 should not be used early in the document,
 unless it is changed also:
 accessing an undefined register automatically defines it.
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index 39520cfba..b8937cb1a 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -10,7 +10,7 @@ manuscript macro package for formatting documents
 .\" Legal Terms
 .\" ====================================================================
 .\"
-.\" Copyright (C) 1989-2023 Free Software Foundation, Inc.
+.\" Copyright (C) 1989-2024 Free Software Foundation, Inc.
 .\"
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
@@ -734,11 +734,12 @@ register defines the minimum number of initial lines of 
any paragraph
 that must be kept together to avoid isolated lines at the bottom of a
 page.
 .
-If a new paragraph is started close to the bottom of a page,
+If a new paragraph starts close to the bottom of a page,
 and there is insufficient space to accommodate
 .B \[rs]n[PORPHANS]
 lines before an automatic page break,
-then a page break is forced before the start of the paragraph.
+.I ms
+forces a page break before formatting the paragraph.
 .
 This is a GNU extension.
 .
@@ -1039,7 +1040,8 @@ that must be kept on the same page as the heading.
 .
 If insufficient space remains on the current page to accommodate the
 heading and this number of lines of paragraph text,
-a page break is forced before the heading is printed.
+.I ms
+forces a page break before setting the heading.
 .
 Any display macro call or
 .IR tbl ,
@@ -1544,9 +1546,10 @@ examples of its use.
 .TQ
 .B .PF
 .B .PS
-begins a picture to be processed by the
-.I pic
-preprocessor;
+marks the start of a
+.MR @g@pic @MAN1EXT@
+preprocessor
+diagram;
 either of
 .B .PE
 or
@@ -1568,11 +1571,12 @@ supplies them automatically.
 .IR label ]]
 .TQ
 .B .EN
-Demarcate an equation to be processed by the
-.I eqn
+Demarcate mathematics to be processed by the
+.I @g@eqn
 preprocessor.
 .
-The equation is centered by default;
+.I ms
+centers the equation by default;
 .I align
 can be
 .BR C ,
@@ -1584,9 +1588,12 @@ or indent it by
 .BR \[rs]n[DI] ,
 respectively.
 .
-If specified,
-.I label
-is set right-aligned.
+.I ms
+right-aligns any
+.IR label .
+.
+See
+.MR @g@eqn @MAN1EXT@ .
 .
 .
 .br



reply via email to

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