groff-commit
[Top][All Lists]
Advanced

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

[groff] 04/14: Fix up ms section heading documentation.


From: G. Branden Robinson
Subject: [groff] 04/14: Fix up ms section heading documentation.
Date: Thu, 18 Feb 2021 18:33:52 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit f40f74951adf0d930572be8abf820acc878545dc
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Feb 17 17:45:30 2021 +1100

    Fix up ms section heading documentation.
    
    * doc/groff.texi (Headings in ms):
      - Remove unnecessary cross reference to other note; the GROWPS and
        PSINCR are explained in the next paragraph.
      - Remove stray word.
      - Remove spurious paragraph break.
    
    * doc/groff.texi (Headings in ms):
    * doc/ms.ms (Headings):
    * tmac/groff_ms.7.man (Usage/Headings):
      - Qualify where a display or preprocessor region macro must occur to
        defeat HORPHANS application.
---
 doc/groff.texi      | 33 ++++++++++++++++-----------------
 doc/ms.ms           |  3 ++-
 tmac/groff_ms.7.man |  3 ++-
 3 files changed, 20 insertions(+), 19 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index 6f8ca0f..fa653b3 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -3203,17 +3203,17 @@ number indicating the level of the heading 
corresponding to the
 @var{level} argument to @code{NH}.  Its purpose is to match the point
 size at which the heading is printed to the size of a numbered heading
 at the same level when the @code{GROWPS} and @code{PSINCR} heading size
-adjustment mechanism is in effect.  @xref{ms Document Control Settings}.
+adjustment mechanism is in effect.
 @endDefmac
 
 If the @code{GROWPS} register is set to a value greater than the
 @var{level} argument to @code{NH} or @code{SH}, the point size of
-the a heading produced by these macros increases by @code{PSINCR} units
-over the size specified by @code{PS}, multiplied by the difference
-between @var{level} and @code{GROWPS}.  The value stored in
-@code{PSINCR} is interpreted in @code{groff} basic units; the @code{p}
-scaling factor should be employed when assigning a value specified in
-points.  For example, the sequence
+a heading produced by these macros increases by @code{PSINCR} units over
+the size specified by @code{PS}, multiplied by the difference between
+@var{level} and @code{GROWPS}.  The value stored in @code{PSINCR} is
+interpreted in @code{groff} basic units; the @code{p} scaling factor
+should be employed when assigning a value specified in points.  For
+example, the sequence
 
 @Example
 .nr PS 10
@@ -3236,16 +3236,15 @@ all more deeply nested heading levels will remain in 
the 10-point text
 specified by the @code{PS} register.  ``Machairodontinae'' is printed at
 11.5 points, since it corresponds to heading level\~2.
 
-The @code{HORPHANS} register (@pxref{ms Document Control Settings})
-operates in conjunction with the @code{NH} and @code{SH} macros to
-inhibit the printing of orphaned section headings at the bottom of a
-page; it specifies the minimum number of lines of an immediately
-subsequent paragraph 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.  Any display macro or
-@code{tbl}, @code{pic}, or @code{eqn} region suppresses this grouping.
+The @code{HORPHANS} register operates in conjunction with the @code{NH}
+and @code{SH} macros to inhibit the printing of orphaned section
+headings at the bottom of a page; it specifies the minimum number of
+lines of an immediately subsequent paragraph 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.  Any display
+macro or @code{tbl}, @code{pic}, or @code{eqn} region between the
+heading and the subsequent paragraph suppresses this grouping.
 
 @c ---------------------------------------------------------------------
 
diff --git a/doc/ms.ms b/doc/ms.ms
index 0cc64da..2a18c32 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -900,7 +900,8 @@ Any display macro or
 .I pic ,
 or
 .I eqn
-region suppresses this grouping.
+region between the heading and the subsequent paragraph suppresses this
+grouping.
 .
 .
 .KS
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index c17f1c7..5b0358f 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -615,7 +615,8 @@ Any display macro or
 .IR pic ,
 or
 .I eqn
-region suppresses this grouping.
+region between the heading and the subsequent paragraph suppresses this
+grouping.
 .
 .
 .\" ====================================================================



reply via email to

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