groff-commit
[Top][All Lists]
Advanced

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

[groff] 08/15: [docs]: Migrate terminology.


From: G. Branden Robinson
Subject: [groff] 08/15: [docs]: Migrate terminology.
Date: Mon, 6 Jun 2022 22:26:12 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit 99d5c7ca4626b8028409efd04daea55ef47d0c82
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sat Jun 4 19:41:13 2022 -0500

    [docs]: Migrate terminology.
    
    ...from horizontal/vertical "resolution" to "motion quantum".  Devices
    already have a "resolution", which applies to both axes.
---
 NEWS                              |  6 +++---
 doc/groff.texi                    | 44 ++++++++++++++++++++++++---------------
 doc/ms.ms                         |  4 ++--
 doc/webpage.ms                    |  6 +++---
 man/groff.7.man                   |  2 +-
 man/groff_diff.7.man              |  6 +++---
 man/groff_font.5.man              |  4 ++--
 man/groff_out.5.man               |  2 +-
 src/preproc/eqn/pile.cpp          |  4 ++--
 src/preproc/tbl/tbl.1.man         |  2 +-
 src/roff/troff/TODO               |  2 +-
 src/utils/xtotroff/xtotroff.1.man |  2 +-
 tmac/groff_ms.7.man               |  4 ++--
 13 files changed, 49 insertions(+), 39 deletions(-)

diff --git a/NEWS b/NEWS
index fd512073..6ac0f35e 100644
--- a/NEWS
+++ b/NEWS
@@ -1437,9 +1437,9 @@ o In groff versions 1.18 and 1.18.1, \D'f ...' didn't 
move the current
   reverted for backwards compatibility.  Consequently, the intermediate
   output command `Df' also moves the position horizontally again.
 
-  \D'f ...' is deprecated since it depends on the horizontal resolution
-  of the output device (given with the `hor' parameter in the DESC
-  file).  Use the new \D'Fg ...' escape instead.
+  \D'f ...' is deprecated since it depends on the horizontal motion
+  quantum of the output device (given with the `hor' parameter in the
+  DESC file).  Use the new \D'Fg ...' escape instead.
 
 o For orthogonality, new \D subcommands to change the fill color are
   available:
diff --git a/doc/groff.texi b/doc/groff.texi
index c496c778..384b4531 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -7255,10 +7255,12 @@ This read-only string-valued register stores the name 
of the file being
 formatted.
 
 @item \n[.H]
+@cindex horizontal motion quantum register (@code{.H})
+@cindex motion quantum, horizontal, register (@code{.H})
 @cindex horizontal resolution register (@code{.H})
 @cindex resolution, horizontal, register (@code{.H})
 @vindex .H
-Number of basic units in a unit of horizontal resolution of the output
+Number of basic units in the horizontal motion quantum of the output
 device.  @xref{Measurements}.
 
 @item \n[.R]
@@ -7279,10 +7281,12 @@ as many registers as required.} it exists for backward 
compatibility.
 to activate unsafe mode, and zero otherwise.  @xref{Groff Options}.
 
 @item \n[.V]
+@cindex vertical motion quantum register (@code{.V})
+@cindex motion quantum, vertical, register (@code{.V})
 @cindex vertical resolution register (@code{.V})
 @cindex resolution, vertical, register (@code{.V})
 @vindex .V
-Number of basic units in a unit of vertical resolution of the output
+Number of basic units in the vertical motion quantum of the output
 device.  @xref{Measurements}.
 
 @item \n[seconds]
@@ -11257,7 +11261,7 @@ reset to the previous value before the last call to 
@code{vs}.
 @cindex @code{.V} register, and @code{vs}
 @code{gtroff} creates a warning in category @samp{range} if @var{space}
 is negative; the vertical spacing is then set to smallest positive
-value, the vertical resolution (as given in the @code{.V} register).
+value, the vertical motion quantum (as given in the @code{.V} register).
 
 @w{@samp{.vs 0}} isn't saved in a diversion since it doesn't result in
 a vertical motion.  You explicitly have to repeat this command before
@@ -12168,7 +12172,7 @@ same positions, so the comparands are equal.  If 
@samp{.ft@tie{}I} had
 been added before the @samp{.ie}, they would differ: the first @samp{|}
 would produce an italic @samp{|}, not a roman one.  Motions must match
 in orientation and magnitude to within the applicable horizontal or
-vertical resolution of the device, after rounding.  @samp{.if
+vertical motion quantum of the device, after rounding.  @samp{.if
 "\u\d"\v'0'"} is false even though both comparands result in zero net
 motion, because motions are not interpreted or optimized but sent as-is
 to the output.@footnote{Because formatting of the comparands takes place
@@ -13611,11 +13615,11 @@ default, a level of 1000 is used.
 Nonintuitively, the current point is moved horizontally to the
 right by@tie{}@var{n}.
 
-@cindex @samp{\D'f @dots{}'} and horizontal resolution
+@cindex @samp{\D'f @dots{}'} and horizontal motion quantum
 Don't use this command!  It has the serious drawback that it is always
-rounded to the next integer multiple of the horizontal resolution (the
-value of the @code{hor} keyword in the @file{DESC} file).  Use @code{\M}
-(@pxref{Colors}) or @samp{\D'Fg @dots{}'} instead.
+rounded to the next integer multiple of the horizontal motion quantum
+(the value of the @code{hor} keyword in the @file{DESC} file).  Use
+@code{\M} (@pxref{Colors}) or @samp{\D'Fg @dots{}'} instead.
 
 @item \D'p @var{dx1} @var{dy1} @var{dx2} @var{dy2} @dots{}'
 @cindex drawing a polygon (@samp{\D'p @dots{}'})
@@ -13840,7 +13844,7 @@ body text in multiple columns, and footnotes.
 @noindent
 The location parameter used in vertical position traps has a default
 scaling unit of @samp{v}, and its value is rounded to a multiple of the
-vertical resolution (found in the register @code{.V}).
+vertical motion quantum (found in the register @code{.V}).
 
 @DefreqList {vpt, [@Var{flag}]}
 @DefregListEndx {.vpt}
@@ -16931,11 +16935,11 @@ arguments).  The first glyph should be printed at the 
current position,
 the current horizontal position should then be increased by the width of
 the first glyph, and so on for each glyph.  The widths of the glyphs are
 read from the font file, scaled for the current type size, and rounded
-to a multiple of the horizontal resolution.  Special characters cannot
-be printed using this command (use the @samp{C} command for special
-characters).  This command is a @code{gtroff} extension; it is only used
-for devices whose @file{DESC} file contains the @code{tcommand} keyword
-(@pxref{DESC File Format}).
+to a multiple of the horizontal motion quantum.  Special characters
+cannot be printed using this command (use the @samp{C} command for
+special characters).  This command is a @code{gtroff} extension; it is
+only used for devices whose @file{DESC} file contains the
+@code{tcommand} keyword (@pxref{DESC File Format}).
 
 @item u @var{n} @var{xxx}@angles{whitespace}
 Print word with track kerning.  This is the same as the @samp{t} command
@@ -17565,10 +17569,13 @@ corresponding position.
 
 @item hor @var{n}
 @kindex hor
+@cindex horizontal motion quantum
+@cindex motion quantum, horizontal
+@cindex quantum, horizontal motion
 @cindex horizontal resolution
 @cindex resolution, horizontal
-The horizontal resolution is @var{n}@tie{}basic units.  All horizontal
-quantities are rounded to multiples of@tie{}@var{n}.
+The horizontal motion quantum is @var{n}@tie{}basic units.  All
+horizontal quantities are rounded to multiples of@tie{}@var{n}.
 
 @item image_generator @var{program}
 @kindex image_generator
@@ -17699,9 +17706,12 @@ uses this directive.
 
 @item vert @var{n}
 @kindex vert
+@cindex vertical motion quantum
+@cindex motion quantum, vertical
+@cindex quantum, vertical motion
 @cindex vertical resolution
 @cindex resolution, vertical
-The vertical resolution is @var{n}@tie{}basic units.  All vertical
+The vertical motion quantum is @var{n}@tie{}basic units.  All vertical
 quantities are rounded to multiples of@tie{}@var{n}.
 
 @item charset
diff --git a/doc/ms.ms b/doc/ms.ms
index 987bbcaf..018bcbb0 100644
--- a/doc/ms.ms
+++ b/doc/ms.ms
@@ -402,8 +402,8 @@ The
 .CW PD
 and
 .CW DD
-registers use the larger value if the vertical resolution of the output
-device is too coarse for the smaller one;
+registers use the larger value if the vertical motion quantum of the
+output device is too coarse for the smaller one;
 usually,
 this is the case only for output to terminals and emulators thereof.
 .
diff --git a/doc/webpage.ms b/doc/webpage.ms
index 38cfb0d0..80d29e25 100644
--- a/doc/webpage.ms
+++ b/doc/webpage.ms
@@ -1568,9 +1568,9 @@ compatibility.
 Consequently, the intermediate output command `Df' also moves the
 position horizontally again.
 
-\eD'f\~.\|.\|.\&' is deprecated since it depends on the horizontal resolution
-of the output device (given with the `hor' parameter in the DESC file).
-Use the new \eD'Fg\~.\|.\|.\&' escape instead.
+\eD'f\~.\|.\|.\&' is deprecated since it depends on the horizontal
+motion quanum of the output device (given with the `hor' parameter in
+the DESC file).  Use the new \eD'Fg\~.\|.\|.\&' escape instead.
 
 .LI
 For orthogonality, new \eD subcommands to change the fill color are
diff --git a/man/groff.7.man b/man/groff.7.man
index d8478ef1..e067ca52 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -1330,7 +1330,7 @@ but not necessarily the requests and/or escape sequences 
used to obtain
 them.
 .
 Motions must match in orientation and magnitude to within the applicable
-horizontal or vertical resolution of the device,
+horizontal or vertical motion quantum of the device,
 after rounding.
 .
 .\" TODO: Uncomment and add forward reference when we add a "GNU troff
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index a75a4951..743a506b 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -4517,7 +4517,7 @@ and so on for each character.
 .
 The width of the glyph is that given in the font file,
 appropriately scaled for the current type size,
-and rounded so that it is a multiple of the horizontal resolution.
+and rounded so that it is a multiple of the horizontal motion quantum.
 .
 Special characters cannot be printed using this command.
 .
@@ -4628,8 +4628,8 @@ changing this.
 The corresponding
 .BR \[rs]D\[aq]f .\|.\|.\& \[aq]
 command shouldn't be used since its argument is always rounded to an
-integer multiple of the horizontal resolution which can lead to
-surprising results.
+integer multiple of the horizontal motion quantum,
+which can lead to surprising results.
 .
 .TP
 \f[B]DC \f[I]\/d\f[R]\*[ic]\[rs]n
diff --git a/man/groff_font.5.man b/man/groff_font.5.man
index 1551ae7f..74c1e858 100644
--- a/man/groff_font.5.man
+++ b/man/groff_font.5.man
@@ -168,7 +168,7 @@ causes no font to be mounted at the corresponding position.
 .
 .TP
 .BI hor\~ n
-The horizontal resolution is
+The horizontal motion quantum is
 .IR n \~basic
 units.
 .
@@ -468,7 +468,7 @@ driver uses this directive.
 .
 .TP
 .BI vert\~ n
-The vertical resolution is
+The vertical motion quantum is
 .IR n \~basic
 units.
 .
diff --git a/man/groff_out.5.man b/man/groff_out.5.man
index 0f9cd7fd..3e22d95c 100644
--- a/man/groff_out.5.man
+++ b/man/groff_out.5.man
@@ -769,7 +769,7 @@ and the position is then advanced horizontally by the 
glyph's width.
 .
 A glyph's width is read from its metrics in the font description file,
 scaled to the current type size,
-and rounded to a multiple of the horizontal resolution.
+and rounded to a multiple of the horizontal motion quantum.
 .
 Only ordinary characters can be set using this command;
 use the
diff --git a/src/preproc/eqn/pile.cpp b/src/preproc/eqn/pile.cpp
index b94dff76..bd4b5e0a 100644
--- a/src/preproc/eqn/pile.cpp
+++ b/src/preproc/eqn/pile.cpp
@@ -38,7 +38,7 @@ int pile_box::compute_metrics(int style)
   for (i = 1; i < col.len; i++)
     printf(">?(\\n[" DEPTH_FORMAT "]+\\n[" HEIGHT_FORMAT "]+%dM)",
           col.p[i-1]->uid, col.p[i]->uid, default_rule_thickness*5);
-  // round it so that it's a multiple of the vertical resolution
+  // round it so that it's a multiple of the vertical motion quantum
   printf("+(\\n(.V/2)/\\n(.V*\\n(.V\n");
 
   printf(".nr " SUP_RAISE_FORMAT " \\n[" BASELINE_SEP_FORMAT "]*%d/2"
@@ -165,7 +165,7 @@ int matrix_box::compute_metrics(int style)
     for (j = 1; j < p[i]->len; j++)
       printf(">?(\\n[" DEPTH_FORMAT "]+\\n[" HEIGHT_FORMAT "]+%dM)",
           p[i]->p[j-1]->uid, p[i]->p[j]->uid, default_rule_thickness*5);
-  // round it so that it's a multiple of the vertical resolution
+  // round it so that it's a multiple of the vertical motion quantum
   printf("+(\\n(.V/2)/\\n(.V*\\n(.V\n");
   printf(".nr " SUP_RAISE_FORMAT " \\n[" BASELINE_SEP_FORMAT "]*%d/2"
         "+%dM\n",
diff --git a/src/preproc/tbl/tbl.1.man b/src/preproc/tbl/tbl.1.man
index e52a412f..c2882aa5 100644
--- a/src/preproc/tbl/tbl.1.man
+++ b/src/preproc/tbl/tbl.1.man
@@ -1227,7 +1227,7 @@ the default length of the text block
 the line length used to process the text block diversion)
 is computed as
 .IR L \[tmu] C /( N +1),
-.\" ...and rounded to the horizontal resolution of the output device
+.\" ...and rounded to the horizontal motion quantum of the output device
 where
 .I L
 is the current line length,
diff --git a/src/roff/troff/TODO b/src/roff/troff/TODO
index 60fe79c7..db726cf8 100644
--- a/src/roff/troff/TODO
+++ b/src/roff/troff/TODO
@@ -97,7 +97,7 @@ The pm request could print where the macro was defined.  Also 
could
 optionally print the contents of a macro.
 
 Provide some way to round numbers to multiples of the current
-horizontal or vertical resolution.
+horizontal or vertical motion quantum.
 
 Better string-processing support (search).
 
diff --git a/src/utils/xtotroff/xtotroff.1.man 
b/src/utils/xtotroff/xtotroff.1.man
index 8b84d616..6b7b704c 100644
--- a/src/utils/xtotroff/xtotroff.1.man
+++ b/src/utils/xtotroff/xtotroff.1.man
@@ -152,7 +152,7 @@ rather than the current working directory.
 Set the resolution for all font patterns in
 .IR font-map .
 .
-The value is used for both the horizontal and vertical resolution.
+The value is used for both the horizontal and vertical motion quanta.
 .
 If not specified,
 a resolution of 75dpi is assumed.
diff --git a/tmac/groff_ms.7.man b/tmac/groff_ms.7.man
index d76c150c..e1497fa6 100644
--- a/tmac/groff_ms.7.man
+++ b/tmac/groff_ms.7.man
@@ -389,8 +389,8 @@ The
 .B PD
 and
 .B DD
-registers use the larger value if the vertical resolution of the output
-device is too coarse for the smaller one;
+registers use the larger value if the vertical motion quantum of the
+output device is too coarse for the smaller one;
 usually,
 this is the case only for output to terminals and emulators thereof.
 .



reply via email to

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