[groff] 05/18: [me]: Rename new `$x` register to `sx`.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit 3e9210e4a8b297766f1d9a41d0568e8cba2827a7
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Tue Dec 28 19:44:16 2021 +1100

    [me]: Rename new `$x` register to `sx`.
    
    Since we expect the user to set this register directly, it should not be
    named with a leading '$' per the "me Reference Manual".
    
    * tmac/e.tmac (initialization, {, }): Do it.
    
    * tmac/groff_me.7.man:
    * doc/meref.me.in:
    * NEWS: Update documentation.
    
    * doc/meintro.me.in:
    * doc/meintro_fr.me.in:
    * doc/meref.me.in: Sync with new register name.
    
    See <https://savannah.gnu.org/bugs/?61025>.  Thanks to Dave Kemper for
    the discussion in <https://savannah.gnu.org/bugs/?61710>.
---
 ChangeLog            | 20 ++++++++++++++++++++
 NEWS                 |  2 +-
 doc/meintro.me.in    |  2 +-
 doc/meintro_fr.me.in |  2 +-
 doc/meref.me.in      |  8 ++++----
 tmac/e.tmac          |  8 ++++----
 tmac/groff_me.7.man  |  2 +-
 7 files changed, 32 insertions(+), 12 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 9357fc07..b1fa3d2a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,23 @@
+2021-12-28  G. Branden Robinson <g.branden.robinson@gmail.com>
+
+       [me]: Rename new `$x` register to `sx`.  Since we expect the
+       user to set this register directly, it should not be named with
+       a leading '$' per the "me Reference Manual".
+
+       * tmac/e.tmac (initialization, {, }): Do it.
+
+       * tmac/groff_me.7.man:
+       * doc/meref.me.in:
+       * NEWS: Update documentation.
+
+       * doc/meintro.me.in:
+       * doc/meintro_fr.me.in:
+       * doc/meref.me.in: Sync with new register name.
+
+       See <https://savannah.gnu.org/bugs/?61025>.  Thanks to Dave
+       Kemper for the discussion in
+       <https://savannah.gnu.org/bugs/?61710>.
+
 2021-12-28  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        [troff]: Slightly refactor.
diff --git a/NEWS b/NEWS
index 437a2289..0deb1577 100644
--- a/NEWS
+++ b/NEWS
@@ -238,7 +238,7 @@ o The e (me) macro package has a new macro, `ld`, which 
"re-localizes
   also used internally to simplify the use of the package with languages
   other than English; it thus updates the `wa` and `wc` strings as well.
 
-o The e (me) macro package now has a register `$x` that eases the
+o The e (me) macro package now has a register `sx` that eases the
   configuration of space added to the line height above/below when
   super/subscripting is used.  It defaults to 0.2m, the value used
   literally in past definitions of the super/subscripting strings.
diff --git a/doc/meintro.me.in b/doc/meintro.me.in
index a71b1a49..1610feed 100644
--- a/doc/meintro.me.in
+++ b/doc/meintro.me.in
@@ -37,7 +37,7 @@
 .\"UC 7
 .if t .ll 6.5i
 .if t .lt 6.5i
-.nr $x 0
+.nr sx 0
 .ds MO @VERSION@
 .nr si 3n
 .he 'Using \f(BIgroff\fP and \f(BI\-me\fP''%'
diff --git a/doc/meintro_fr.me.in b/doc/meintro_fr.me.in
index 3974dda3..66fb2ddb 100644
--- a/doc/meintro_fr.me.in
+++ b/doc/meintro_fr.me.in
@@ -39,7 +39,7 @@
 .\"UC 7
 .if t .ll 6.5i
 .if t .lt 6.5i
-.nr $x 0
+.nr sx 0
 .ds MO @VERSION@
 .nr si 3n
 .he '\f(BIgroff\fP en option \f(BI\-me\fP''%'
diff --git a/doc/meref.me.in b/doc/meref.me.in
index 5d859069..2c2ecc5e 100644
--- a/doc/meref.me.in
+++ b/doc/meref.me.in
@@ -38,7 +38,7 @@
 .if t .lt 6.5i
 .nr pp 10
 .nr fi 1n
-.nr $x 0
+.nr sx 0
 .\"pn 0
 .ds MO @VERSION@
 .de TL                 \" *** title line
@@ -1852,7 +1852,7 @@ Delayed text number surrounded by square brackets:
 Begin superscripting:
 move upward and reduce the type size.
 The line height is increased above by
-.NR ($x
+.NR (sx
 [0.2m]
 to accommodate the superscript.
 In \*N mode,
@@ -1885,7 +1885,7 @@ output a right square bracket.
 Begin subscripting:
 move downward and reduce the type size.
 The line height is increased below by
-.NR ($x
+.NR (sx
 to accommodate the subscript.
 In \*N mode,
 output a left angle bracket.
@@ -2163,7 +2163,6 @@ and a square \(sq marks \*G extensions.
 \en($s R       column spacing (indentation)
 \&.$s  M\(dd   output footnote area separator
 \en($v R\(dd   vertical spacing of text (%)
-\en($x R\(dd   super/subscript line height increase
 \e%    F\(sc   control hyphenation
 \en%   R\(sc   current page number
 \e&    F\(sc   non-printing input break
@@ -2344,6 +2343,7 @@ and a square \(sq marks \*G extensions.
 \en(sp R       section title type size in points
 \en(ss R       section prespace
 \&.sx  M       change section depth
+\en(sx R\(sq   super/subscript line height increase
 \&.sz  M       set type size and vertical spacing
 \&.ta  M\(sc   set tab stops
 \&.tc  M\(sc   set tab repetition character
diff --git a/tmac/e.tmac b/tmac/e.tmac
index de65e068..1fcbd5d0 100644
--- a/tmac/e.tmac
+++ b/tmac/e.tmac
@@ -1987,7 +1987,6 @@
 .
 .nr $v \n(.v00+\n(.sp-1/\n(.sp \" vs as % of ps for .sz request
 .nr $V \n($v                   \" same for displays & footnotes
-.nr $x 0.2m                    \" super/subscript line height increase
 .nr hm 4v                      \" header margin
 .nr tm 7v                      \" top margin
 .nr bm 6v                      \" bottom margin
@@ -2008,6 +2007,7 @@
 .nr sp 10                      \" section title pointsize
 .nr ss 12p                     \" section prespacing
 .nr si 0                       \" section indent
+.nr sx 0.2m                    \" super/subscript x-height adjustment
 .
 .@R 0x\" set by GNU pic to _disable_ \x in super/scripting
 .
@@ -2021,10 +2021,10 @@
 .\" could be revisited.
 .\"
 .\" Adjust the line height with \x if the `0x` register is zero (a
-.\" pic(1) convention) by the amount in `$x` (a groff 1.23 extension).
+.\" pic(1) convention) by the amount in `sx` (a groff 1.23 extension).
 .ie t \
 \{\
-.ds { \v'-0.4m'\x'\\n(0x=0*-1u*\\n($xu'\s-3
+.ds { \v'-0.4m'\x'\\n(0x=0*-1u*\\n(sxu'\s-3
 .ds } \s+3\v'0.4m'
 .\}
 .el \
@@ -2045,7 +2045,7 @@
 .\}
 .ie t \
 \{\
-.ds < \v'0.4m'\x'\\n(0x=0*\\n($xu'\s-3
+.ds < \v'0.4m'\x'\\n(0x=0*\\n(sxu'\s-3
 .ds > \s+3\v'-0.4m'
 .\}
 .el \
diff --git a/tmac/groff_me.7.man b/tmac/groff_me.7.man
index d2a23dac..00e65f27 100644
--- a/tmac/groff_me.7.man
+++ b/tmac/groff_me.7.man
@@ -383,7 +383,6 @@ $m  number of available columns
 $p     numbered paragraph number
 $s     column spacing (indentation)
 $v     vertical spacing of text (as percentage)\fB*
-$x     super/subscript line height increase\fB*
 bi     display (block) indentation
 bm     distance from text area to page bottom
 bs     display (block) pre/post space
@@ -412,6 +411,7 @@ si  section indentation per level of depth
 so     additional section title offset
 sp     section title type size in points
 ss     section prespace
+sx     super/subscript line height increase\fB*
 tf     title font
 tm     distance from page top to text area
 tp     title type size in points