[groff] 13/15: [docs]: Migrate to term "scaling indicator".

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit f95ae1bcc5485650c71084abb9e14ec3bd44daef
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Jul 21 06:20:57 2021 +1000

    [docs]: Migrate to term "scaling indicator".
    
    Our documentation used the terms "scale indicator" and "scaling
    indicator" variously and in an ad hoc manner.  Standardize on "scaling
    indicator"; according to a Google search, it's less common and,
    furthermore, a "scale indicator" is a real thing: it's the part of a
    weight-measuring device that communicates the measurement.
    
    * NEWS:
    * PROBLEMS:
    * doc/groff.texi:
    * man/groff_diff.7.man:
    * man/groff_out.5.man: Do it.
---
 NEWS                 |  2 +-
 PROBLEMS             |  2 +-
 doc/groff.texi       | 26 ++++++++++++++------------
 man/groff_diff.7.man | 38 +++++++++++++++++++-------------------
 man/groff_out.5.man  | 19 +++++++++++--------
 5 files changed, 46 insertions(+), 41 deletions(-)

diff --git a/NEWS b/NEWS
index 1211218..24b1d3a 100644
--- a/NEWS
+++ b/NEWS
@@ -2848,7 +2848,7 @@ VERSION 1.01
 
 The groff command now understands the gtroff `-a' and `-i' options.
 
-With the `m' and `n' scale indicators, the scale factor is rounded
+With the `m' and `n' scaling indicators, the scale factor is rounded
 horizontally before being applied.  This makes (almost) no difference
 for devices with `hor' equal to 1, but it makes groff with -Tascii or
 -Tlatin1 behave more like nroff in its treatment of these scale
diff --git a/PROBLEMS b/PROBLEMS
index c690dac..bc2cc34 100644
--- a/PROBLEMS
+++ b/PROBLEMS
@@ -253,7 +253,7 @@ and \n[rsb] registers: these are groff extensions.
   to break lines.  The problem seems to be caused by a line like:
   .TP \w'label'+2
 
-The -man documentation says that the default scale indicator for TP
+The -man documentation says that the default scaling indicator for TP
 macro is `n'.  The groff -man macros implement this correctly, so that
 the argument is evaluated as if it were
 
diff --git a/doc/groff.texi b/doc/groff.texi
index 0908311..53966c4 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -11077,14 +11077,14 @@ spacing; it is associated with the environment 
(@pxref{Environments}).
 @cindex @code{\s}, with fractional type sizes
 A @dfn{scaled point} is equal to @math{1/@var{sizescale}} points, where
 @var{sizescale} is specified in the device description file @file{DESC},
-and defaults to 1@tie{}.  A new scale indicator @samp{z} has has the
+and defaults to 1@tie{}.  A new scaling indicator @samp{z} has has the
 effect of multiplying by @var{sizescale}.  Requests and escape sequences
 in GNU @code{troff} interpret arguments that represent a point size as
 being in units of scaled points; that is, they evaluate each such
-argument using a default scale indicator of @samp{z}.  Arguments treated
-in this way comprise those to the escapes @code{\H} and @code{\s}, to
-the request @code{ps}, the third argument to the @code{cs} request, and
-the second and fourth arguments to the @code{tkf} request.
+argument using a default scaling indicator of @samp{z}.  Arguments
+treated in this way comprise those to the escapes @code{\H} and
+@code{\s}, to the request @code{ps}, the third argument to the @code{cs}
+request, and the second and fourth arguments to the @code{tkf} request.
 
 For example, if @var{sizescale} is@tie{}1000, then a scaled point
 is one one-thousandth of a point.  The request @samp{.ps 10.25} is
@@ -11094,14 +11094,14 @@ synonymous with @samp{.ps 10.25z} and sets the point 
size to
 Consequently, in GNU @code{troff}, the register @code{.s} can contain a
 non-integral point size.
 
-It makes no sense to use the @samp{z} scale indicator in a numeric
-expression whose default scale indicator is neither @samp{u} nor
+It makes no sense to use the @samp{z} scaling indicator in a numeric
+expression whose default scaling indicator is neither @samp{u} nor
 @samp{z}, so GNU @code{troff} disallows this.  Similarly, it is
 nonsensical to use a scaling indicator other than @samp{z} or @samp{u}
-in a numeric expression whose default scale indicator is @samp{z}, and
+in a numeric expression whose default scaling indicator is @samp{z}, and
 so GNU @code{troff} disallows this as well.
 
-Another new scale indicator @samp{s} multiplies by the number of basic
+Another new scaling indicator @samp{s} multiplies by the number of basic
 units in a scaled point.  For instance, @samp{\n[.ps]s} is equal to
 @samp{1m} by definition.  Do not confuse the @samp{s} and @samp{z} scale
 indicators.
@@ -11138,7 +11138,7 @@ fractional type sizes:
 @item \s[@var{n}]
 @itemx \s'@var{n}'
 Set the point size to @var{n}@tie{}scaled points; @var{n}@tie{}is a
-numeric expression with a default scale indicator of @samp{z}.
+numeric expression with a default scaling indicator of @samp{z}.
 
 @item \s[+@var{n}]
 @itemx \s[-@var{n}]
@@ -11150,7 +11150,7 @@ numeric expression with a default scale indicator of 
@samp{z}.
 @itemx \s-'@var{n}'
 Increase or decrease the point size by @var{n}@tie{}scaled points;
 @var{n}@tie{}is a numeric expression (which may start with a minus sign)
-with a default scale indicator of @samp{z}.
+with a default scaling indicator of @samp{z}.
 @end table
 
 @xref{Device and Font Files}.
@@ -16832,6 +16832,7 @@ following two sections describe their format.
 
 @c =====================================================================
 
+@c BEGIN TODO: Make parallel with groff_out(5).
 @node gtroff Output, Device and Font Files, File formats, File formats
 @section @code{gtroff} Output
 @cindex @code{gtroff}, output
@@ -16957,7 +16958,7 @@ can occur everywhere.  They are just ignored.
 Some commands take integer arguments that are assumed to represent
 values in a measurement unit, but the letter for the corresponding scale
 indicator is not written with the output command arguments.  Most
-commands assume the scale indicator @samp{u}, the basic unit of the
+commands assume the scaling indicator @samp{u}, the basic unit of the
 device, some use @samp{z}, the scaled point unit of the device, while
 others, such as the color commands, expect plain integers.
 
@@ -17718,6 +17719,7 @@ follow quite naturally.
 @end ignore
 
 @end itemize
+@c END TODO: Make parallel with groff_out(5).
 
 
 @c =====================================================================
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 3b0cc77..022a172 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -77,7 +77,7 @@ features identifiers of arbitrary length,
 supports non-integral point sizes,
 adds new escapes and requests,
 provides new conditional tests,
-recognizes additional scale indicators and numerical operators,
+recognizes additional scaling indicators and numerical operators,
 and extends the function of some escapes and requests already present in
 .RI AT&T\~ troff .
 .
@@ -109,7 +109,7 @@ within can be of arbitrary length.
 .
 .
 .\" ====================================================================
-.SS "Fractional point sizes and new scale indicators"
+.SS "Fractional point sizes and new scaling indicators"
 .\" ====================================================================
 .
 A
@@ -133,7 +133,7 @@ Requests and escapes in
 interpret arguments that represent a point size as being in units of
 scaled points;
 that is,
-they evaluate such arguments using an implied default scale indicator
+they evaluate such arguments using an implied default scaling indicator
 .RB of\~\[lq] z \[rq].
 .
 Arguments treated in this way comprise those to the escapes
@@ -181,7 +181,7 @@ returns the point size in scaled points.
 .P
 It makes no sense to use the
 .RB \[lq] z \[rq]\~scale
-indicator in a numeric expression whose default scale indicator is
+indicator in a numeric expression whose default scaling indicator is
 neither
 .RB \[lq] u \[rq]
 .RB nor\~\[lq] z \[rq],
@@ -193,7 +193,7 @@ Similarly,
 it is nonsensical to use a scaling indicator other
 .RB than\~\[lq] z \[rq]
 .RB or\~\[lq] u \[rq]
-in a numeric expression whose default scale indicator
+in a numeric expression whose default scaling indicator
 .RB is\~\[lq] z \[rq],
 so
 .I groff
@@ -201,7 +201,7 @@ disallows this as well.
 .
 .
 .P
-Another new scale indicator,
+Another new scaling indicator,
 .RB \[lq] s \[rq],
 multiplies by the number of basic units in a scaled point.
 .
@@ -215,7 +215,7 @@ Do not confuse the
 .RB \[lq] s \[rq]
 and
 .RB \[lq] z \[rq]
-scale indicators.
+scaling indicators.
 .
 .
 .P
@@ -662,8 +662,8 @@ Set the point size to
 .I n
 scaled points;
 .I n
-is a numeric expression with a default scale indicator of\~\c
-.BR z .
+is a numeric expression with a default scaling indicator
+.RB of\~\[lq] z \[rq].
 .
 .TP
 .BI \[rs]V x
@@ -1762,11 +1762,11 @@ internally multiplied by\~257), the latter in the range 
0\[en]65535.
 .
 Examples: #FFC0CB (pink), ##ffff0000ffff (magenta).
 .
-A new scaling indicator\~\c
-.B f
-has been introduced which multiplies its value by\~65536; this makes
-it convenient to specify color components as fractions in the range 0
-to\~1.
+A new scaling indicator,
+.RB \[lq] f \[rq]\~has
+has been introduced which multiplies its value by\~65536;
+this makes it convenient to specify color components as fractions in the
+range 0 to\~1.
 .
 Example:
 .
@@ -2766,8 +2766,8 @@ can affect the priority of subsequently planted traps.
 .BI .pvs \~\[+-]n
 Set the post-vertical line space to\~\c
 .IR n ;
-default scale indicator is\~\c
-.BR p .
+default scaling indicator
+.RB is\~\[lq] p \[rq].
 .
 This value is added to each line after it has been output.
 .
@@ -5032,15 +5032,15 @@ In
 .RI AT&T\~ troff
 the
 .B .ps
-request ignores scale indicators and thus
+request ignores scaling indicators and thus
 .RB \[lq] .ps\~10u \[rq]
 sets the point size to 10\~points,
 whereas in
 .I groff
 it sets the point size to 10\~scaled points.
 .
-See subsection \[lq]Fractional point sizes and new scale indicators\[rq]
-above.
+See subsection \[lq]Fractional point sizes and new scaling
+indicators\[rq] above.
 .
 .
 .P
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index 79a9aa7..f055ce4 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -4,6 +4,7 @@
 groff_out \- GNU roff intermediate output format
 .
 .
+.\" XXX: This page needs review and editing.
 .\" ====================================================================
 .\" Legal Terms
 .\" ====================================================================
@@ -343,7 +344,7 @@ They are just ignored.
 .
 Some commands take integer arguments that are assumed to represent
 values in a measurement unit, but the letter for the corresponding
-.I scale indicator
+.I scaling indicator
 is not written with the output command arguments;
 see
 .BR groff (@MAN7EXT@)
@@ -354,16 +355,18 @@ the
 Texinfo manual,
 for more on this topic.
 .
-Most commands assume the scale indicator\~\c
-.BR u ,
-the basic unit of the device, some use\~\c
-.BR z ,
+Most commands assume the scaling
+.RB indicator\~\[lq] u \[rq],
+the basic unit of the device, some
+.RB use\~\[lq] z \[rq],
 the
 .I scaled point unit
-of the device, while others, such as the color commands expect plain
-integers.
+of the device,
+while others,
+such as the color commands,
+expect plain integers.
 .
-Note that these scale indicators are relative to the chosen device.
+Note that these scaling indicators are relative to the chosen device.
 .
 They are defined by the parameters specified in the device's
 .I DESC