texinfo-commits
[Top][All Lists]
Advanced

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

[no subject]


From: Gavin D. Smith
Date: Mon, 15 Aug 2022 09:00:27 -0400 (EDT)

branch: master
commit a2ef1b43e8a5918b752524d919e986c7f3f49095
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Mon Aug 15 14:00:05 2022 +0100

    * doc/texinfo.texi (Info Format Regular Nodes): Define
    <node-spec> including DEL-quoting so it can be used later
    on in the appendix.
    
    (Info Format Cross Reference, Info Format Regular Nodes):
    Do not say that support for quoting mechanism is "limited"
    but do say that it isn't supported everywhere.  Do not recommend
    against its use.
    (Node Line Requirements): Be more hopeful that DEL-quoting will be
    supported by removing word "ever".
---
 ChangeLog        | 13 +++++++++++++
 doc/texinfo.texi | 29 ++++++++++++-----------------
 2 files changed, 25 insertions(+), 17 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index ed9b31e57d..dadb17e21d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,16 @@
+2022-08-15  Gavin Smith  <gavinsmith0123@gmail.com>
+
+       * doc/texinfo.texi (Info Format Regular Nodes): Define
+       <node-spec> including DEL-quoting so it can be used later
+       on in the appendix.
+
+       (Info Format Cross Reference, Info Format Regular Nodes):
+       Do not say that support for quoting mechanism is "limited"
+       but do say that it isn't supported everywhere.  Do not recommend
+       against its use.
+       (Node Line Requirements): Be more hopeful that DEL-quoting will be
+       supported by removing word "ever".
+
 2022-08-15  Gavin Smith  <gavinsmith0123@gmail.com>
 
        * doc/texinfo.texi (Info Format Specification):
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 4e1d3b9f1c..3f7dedb65d 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -3024,7 +3024,7 @@ within a node name; these can confuse the Info reader.  
Also, a node
 name may not start with a left parenthesis preceding a right
 parenthesis, as in @code{(not)allowed}, since this syntax is used to
 specify an external manual.  These limitations will be removed if
-Info-reading programs that recognize quoting of node names ever
+Info-reading programs that recognize quoting of node names
 become common (@pxref{INFO_SPECIAL_CHARS_QUOTE}).
 
 @command{makeinfo} warns about such problematic usage in node names,
@@ -23901,8 +23901,8 @@ but any number of spaces are ignored.  The @t{<id>} 
node identifiers have
 following format:
 
 @example
-   <id> = (<lparen><infofile><rparen>)?(<del>?<nodename><del>?)?
-|  <id> = (<lparen><infofile><rparen>)?(<nodename>)?
+   <id> = (<lparen><infofile><rparen>)?<node-spec>?
+   <node-spec> = <nodename> | <del><nodename><del>
 @end example
 
 This @t{<node>} defines @t{<id1>} in file @t{<fn>}, which is typically
@@ -23928,10 +23928,8 @@ Info readers.
 If it is necessary to refer to a node whose name contains any of
 these, the @t{<nodename>} should be surrounded by a pair of @t{<del>}
 characters.  There is support in @command{makeinfo} for adding these
-characters (@pxref{INFO_SPECIAL_CHARS_QUOTE}); however, we don't 
-recommend you make use of this support until such time as Info-reading 
-programs that recognize this syntax are common.  @xref{Node Line 
-Requirements}.
+characters (@pxref{INFO_SPECIAL_CHARS_QUOTE}).  Note that not all Info
+readers recognize this syntax.  @xref{Node Line Requirements}.
 
 The use of non-ASCII characters in the names of nodes is permitted,
 but can cause problems in cross-references between nodes in Info files
@@ -24029,7 +24027,7 @@ the entries occurs in the text:
 
 @example
     <index entry> =
-* <entry text>: <entry node>. <line-spec>
+* <entry text>: <node-spec>. <line-spec>
 
     <line-spec> =
 <lparen>line <lineno><rparen>
@@ -24043,8 +24041,7 @@ single line.  The @t{<entry text>} is the index term.
 Even though @t{<entry text>} is followed by a colon, it may itself
 contain colons, so Info readers should try to include as much of the
 line as possible in the @t{<entry text>}.  (However, @t{<entry text>}
-may not contain the @t{<del>} characters that may occur
-around @t{<entry-node>}.)
+may not contain the @t{<del>} characters that may occur in @t{<node-spec>}.)
 
 @t{<lineno>} is an unsigned integer, given relative to the start
 of the @t{<entry node>}.  An optional line break may occur before
@@ -24076,9 +24073,8 @@ A general cross-reference in Info format has one of the 
following two forms:
 @c| * (N|n)ote <label>:<id>(.|,)?
 | * (N|n)ote <label>:<id>(.|,)
 
-     <id> = (<lparen><infofile><rparen>)?(<del>?<nodename><del>?)?
-|    <id> = (<lparen><infofile><rparen>)?(<nodename>)?
-    <label> = <del>?<label text><del>?
+    <id> = (<lparen><infofile><rparen>)?<node-spec>?
+    <label> = <label text> | <del><label text><del>
 @end example
 
 No space should occur between the @samp{*} character and the following
@@ -24091,7 +24087,7 @@ text>} is descriptive text.
 In both forms the @t{<id>} refers to a node or anchor, in the same way
 as a reference in the node information line does (@pxref{Info Format
 Regular Nodes}).  The optional parenthesized @samp{<infofile>} is the
-name of the manual being referenced, and the @t{<nodename>} is the
+name of the manual being referenced, and @t{<node-spec>} gives the
 node or anchor within that manual,
 
 The second form has a descriptive label.  A cross-reference in this form
@@ -24104,9 +24100,8 @@ surrounded with a pair of @t{<del>} characters.  
Likewise, if
 periods), it should be surrounded by a pair of @t{<del>} characters;
 then a terminating comma or period is not needed.
 
-As with node names, this quoting mechanism has as of the time of 
-writing limited support in Info-reading programs; hence we do not 
-recommend using it until this changes.
+As with node names, this quoting mechanism is not supported in all
+Info-reading programs.
 
 The format does not prescribe how to find other manuals to resolve
 such references.



reply via email to

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