[groff] 16/22: [ms]: Relocate, recast, and sync "text settings".

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 5c3c1c15e6d04b8c44f2c2dbb2f00fa68001a3ef
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Jul 28 10:10:28 2021 +1000

    [ms]: Relocate, recast, and sync "text settings".
    
    Some basic information was introduced fairly late in groff_ms(7).  Pull
    it forward, distributing it among existing relevant sections where
    possible.  Recast.  Synchronize among our 3 ms manuals (sigh).
---
 doc/groff.texi      |  43 ++++++++++++--------
 doc/ms.ms           |  68 ++++++++++++++++++++-----------
 tmac/groff_ms.7.man | 112 ++++++++++++++++++++++++++--------------------------
 3 files changed, 128 insertions(+), 95 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index e1bde81..f24ed0a 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -2589,13 +2589,10 @@ Set string @var{name} to @var{contents}.  If @var{name} 
exists, it is
 removed first.
 @endDefreq
 
-For consistent document rendering, set registers related to margins at
-the beginning of your document, or just after the @code{RP} macro.  You
-can set other registers later in your document, but keeping them
-together at the beginning makes them easy to find and edit as necessary.
-
 A list of document control registers and strings follows.  They are
-presented in the syntax used to interpolate them.
+presented in the syntax used to interpolate them.  For any parameter
+whose default is unsatisfactory, define its register or string before
+calling any @file{ms} macro other than @code{RP}.
 
 @unnumberedsubsubsec Margin Settings
 
@@ -3071,6 +3068,15 @@ A variety of macros, registers, and strings can be used 
to structure and
 style the body of your document.  Examples include paragraphs, headings,
 footnotes, and inclusions of material such as tables and figures.
 
+The @code{FAM} string sets the font family for body text.  If this
+string is undefined at initialization, it is set to @samp{T} (Times).
+Setting the @code{FAM} string before the first call of a sectioning,
+paragraphing, or (non-date) document description macro also applies it
+to headers, footers, and footnotes (as well as the body text).
+
+The hyphenation flags (as used by the @code{hy} request) are set using
+the @code{HY} register.
+
 @menu
 * Paragraphs in ms::
 * Headings in ms::
@@ -3408,13 +3414,10 @@ Rather than calling the @code{CW} macro, in 
@code{groff} @file{ms} you
 might prefer to change the font family to Courier---a monospaced
 typeface---by setting the @code{FAM} string to @samp{C}.  You can then
 use all four style macros above, returning to the default family (Times)
-with @samp{.ds FAM T}.  If you set @code{FAM} before the first call of a
-sectioning, paragraphing, or (non-date) document description macro, it
-also applies to headers, footers, and footnotes (as well as the body
-text).  Because @code{FAM} takes effect at the next paragraph, @code{CW}
-remains useful to ``inline'' a change to the font family, similarly to
-the practice of this document in noting syntactical elements of
-@file{ms} and @code{groff}.
+with @samp{.ds FAM T}.  Because @code{FAM} takes effect at the next
+paragraph, @code{CW} remains useful to ``inline'' a change to the font
+family, similarly to the practice of this document in noting syntactical
+elements of @file{ms} and @code{groff}.
 
 @c ---------------------------------------------------------------------
 
@@ -3870,10 +3873,16 @@ can place a second @code{\**} interpolation between a 
@code{\**} and its
 corresponding @code{FS} call as long as each @code{FS} call occurs
 @emph{after} the corresponding @code{\**} and the occurrences of
 @code{FS} are in the same order as the corresponding occurrences of
-@code{\**}.  You can control how @file{ms} presents footnotes by
-changing the values of the @code{FI}, @code{FF}, @code{FPS}, @code{FVS},
-and @code{FPD} registers; and the @code{FR} string.  @xref{ms Document
-Control Settings}.
+@code{\**}.
+
+Footnote text is formatted as paragraphs are, using analogous
+parameters.  The registers @code{FI}, @code{FPD}, @code{FPS}, and
+@code{FVS} correspond to @code{PI}, @code{PD}, @code{PS}, and @code{CS},
+respectively.
+
+The @code{FF} register controls the formatting of automatically numbered
+footnotes and those for which @code{FS} is given a marker argument.
+@xref{ms Document Control Settings}.
 
 The default footnote line length is 11/12ths of the normal line length
 for compatibility with the expectations of historical @file{ms}
diff --git a/doc/ms.ms b/doc/ms.ms
index e4308c1..bce8f06 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -295,21 +295,16 @@ Document control settings
 .
 .
 .LP
-For consistent document rendering,
-set registers related to margins at the beginning of your document,
-or just after calling
-.CW .RP .
-.
-You can set other registers later in your document,
-but keeping them together at the beginning makes them easy to find and
-edit as necessary.
-.
-.
-.PP
 A list of document control registers and strings follows.
 .
 They are presented in the syntax used to interpolate them.
 .
+For any parameter whose default is unsatisfactory,
+define its register or string before calling any
+.I ms
+macro other than
+.CW RP .
+.
 .
 .TS H
 box;
@@ -661,6 +656,45 @@ and inclusions of material such as tables and figures.
 .
 .KS
 .NH 2
+Text settings
+.XS
+       Text settings
+.XE
+.
+.
+.LP
+The
+.CW FAM
+string sets the font family for body text.
+.
+If this string is undefined at initialization,
+it is set to
+.CW T \[rq] \[lq]
+(Times).
+.
+Setting
+.CW \[rs]*[FAM]
+before the first call of a sectioning,
+paragraphing,
+or (non-date) document description macro also applies it to headers,
+footers,
+and footnotes
+(as well as the body text).
+.
+.
+.PP
+The hyphenation flags
+(as used by the
+.CW hy
+request)
+are set using the
+.CW HY
+register.
+.KE
+.
+.
+.KS
+.NH 2
 Paragraphs
 .XS
        Paragraphs
@@ -1355,16 +1389,6 @@ You can then use all four style macros above,
 returning to the default family (Times) with
 .CW ".ds FAM T" \[rq]. \[lq]
 .
-If you set
-.CW \[rs]*[FAM]
-before the first call of a sectioning,
-paragraphing,
-or (non-date) document description macro,
-it also applies to headers,
-footers,
-and footnotes
-(as well as the body text).
-.
 Because
 .CW \[rs]*[FAM]
 takes effect at the next paragraph,
@@ -2268,8 +2292,6 @@ and
 .CW VS ,
 respectively.
 .
-See section \[lq]Document control settings\[rq] above.
-.
 .
 .KS
 .PP
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index fa7529b..68f6b29 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -175,11 +175,11 @@ macro at the end of your document.
 .
 The following tables list the document control registers and strings.
 .
-For the sake of consistency,
-set parameters related to margins at the beginning of your document,
-or just after the
-.B RP
-macro.
+For any parameter whose default is unsatisfactory,
+define its register or string before calling any
+.I ms
+macro other than
+.BR RP .
 .
 .
 .LP
@@ -537,6 +537,39 @@ End the abstract.
 .
 .
 .\" ====================================================================
+.SS "Text settings"
+.\" ====================================================================
+.
+The
+.B FAM
+string sets the font family for body text.
+.
+If this string is undefined at initialization,
+it is set to
+.RB \[lq] T \[rq]
+(Times).
+.
+Setting
+.B \[rs]*[FAM]
+before the first call of a sectioning,
+paragraphing,
+or (non-date) document description macro also applies it to headers,
+footers,
+and footnotes
+(as well as the body text).
+.
+.
+.P
+The hyphenation flags
+(as used by the
+.B hy
+request)
+are set using the
+.B HY
+register.
+.
+.
+.\" ====================================================================
 .SS Paragraphs
 .\" ====================================================================
 .
@@ -1404,6 +1437,25 @@ End footnote text.
 .
 .
 .P
+Footnote text is formatted as paragraphs are,
+using analogous parameters.
+.
+The registers
+.BR FI ,
+.BR FPD ,
+.BR FPS ,
+and
+.B FVS
+correspond to
+.BR PI ,
+.BR PD ,
+.BR PS ,
+and
+.BR VS ,
+respectively.
+.
+.
+.P
 The
 .B FF
 register controls the formatting of automatically numbered footnotes,
@@ -2056,56 +2108,6 @@ includes font style escapes to set the word in italics.
 .\".IR nroff ).
 .
 .
-.\" ====================================================================
-.SS "Text settings"
-.\" ====================================================================
-.
-The
-.B FAM
-string sets the font family for body text.
-.
-If this string is undefined at initialization,
-it is set to
-.RB \[lq] T \[rq]
-(Times).
-.
-Setting
-.B \[rs]*[FAM]
-before the first call of a sectioning,
-paragraphing,
-or (non-date) document description macro also applies it to headers,
-footers,
-and footnotes
-(as well as the body text).
-.
-.
-.LP
-The point size, vertical spacing, and inter-paragraph spacing for
-footnotes are controlled by the registers
-.BR FPS ,
-.BR FVS ,
-and
-.BR FPD ;
-at initialization these are set to
-.BR \[rs]n(PS\-2 ,
-.BR \[rs]n[FPS]+2 ,
-and
-.BR \[rs]n(PD/2 ,
-respectively.
-.
-If any of these registers are defined before initialization,
-the initialization macro does not change them.
-.
-.
-.LP
-The hyphenation flags (as set by the
-.B hy
-request) are set from the
-.B HY
-register;
-the default is\~6.
-.
-.
 .\" TODO: Put this in a legacy feature support section, alongside AT&T
 .\" accent marks and the \*-, \*Q, \*U strings.
 .\".PP