bug#21327: [PATCH] Use @sub and @sup in documentation

bug#21327: [PATCH] Use @sub and @sup in documentation

[Xue Fuqiao]

Use @sub and @sup instead of [0-9]+\^[0-9]+ or [0-9]+\*\*[0-9]+ for
inserting subscripts and superscripts in *.texi files.

From: Xue Fuqiao <xfq.free@gmail.com>
Date: Sun, 23 Aug 2015 18:22:55 +0800
Subject: [PATCH] Use @sub and @sup in documentation

* doc/lispref/modes.texi (%-Constructs):
* doc/lispref/help.texi (Describing Characters):
* doc/emacs/display.texi (Optional Mode Line): Use @sub and @sup
for subscripts and superscripts.
---
 doc/emacs/display.texi | 5 +++--
 doc/lispref/help.texi  | 6 +++---
 doc/lispref/modes.texi | 6 +++---
 3 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index 601a40b..9eac674 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -1279,8 +1279,9 @@ following the buffer percentage like this:

 @noindent
 Here @var{size} is the human readable representation of the number of
-characters in the buffer, which means that @samp{k} for 10^3, @samp{M}
-for 10^6, @samp{G} for 10^9, etc., are used to abbreviate.
+characters in the buffer, which means that @samp{k} for 10@sup{3},
+@samp{M} for 10@sup{6}, @samp{G} for 10@sup{9}, etc., are used to
+abbreviate.

 @cindex line number display
 @cindex display of line number
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi
index ab1696e..fa2de8c 100644
--- a/doc/lispref/help.texi
+++ b/doc/lispref/help.texi
@@ -494,9 +494,9 @@ standard Emacs notation for characters that appear
in text---like
 @code{single-key-description}, except that control characters are
 represented with a leading caret (which is how control characters in
 Emacs buffers are usually displayed).  Another difference is that
-@code{text-char-description} recognizes the 2**7 bit as the Meta
-character, whereas @code{single-key-description} uses the 2**27 bit
-for Meta.
+@code{text-char-description} recognizes the 2@sup{7} bit as the Meta
+character, whereas @code{single-key-description} uses the 2@sup{27}
+bit for Meta.

 @smallexample
 @group
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index a8b6bb1..ad3842f 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -2092,9 +2092,9 @@ The size of the accessible part of the current
buffer; basically
 @code{(- (point-max) (point-min))}.

 @item %I
-Like @samp{%i}, but the size is printed in a more readable way by using
-@samp{k} for 10^3, @samp{M} for 10^6, @samp{G} for 10^9, etc., to
-abbreviate.
+Like @samp{%i}, but the size is printed in a more readable way by
+using @samp{k} for 10@sup{3}, @samp{M} for 10@sup{6}, @samp{G} for
+10@sup{9}, etc., to abbreviate.

 @item %l
 The current line number of point, counting within the accessible portion
-- 
2.5.0

bug#21327: [PATCH] Use @sub and @sup in documentation

[Eli Zaretskii]

> Date: Sun, 23 Aug 2015 18:51:33 +0800
> From: Xue Fuqiao <xfq.free@gmail.com>
> 
> Use @sub and @sup instead of [0-9]+\^[0-9]+ or [0-9]+\*\*[0-9]+ for
> inserting subscripts and superscripts in *.texi files.

Thanks, but I don't think we can accept this as written.  These two
commands were introduced in Texinfo 6.0, released only 2 months ago.
We cannot possibly unsupport all the previous versions of Texinfo, in
effect preventing anyone with an older version from building the docs,
it would be to draconian to our users.

If you really think this is such an important feature to have, at the
very least condition its use by @ifset and let the interested users
specify the appropriate -DFOO switch to makeinfo.