[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6100] remove node name quoting explanation
From: |
Gavin D. Smith |
Subject: |
[6100] remove node name quoting explanation |
Date: |
Fri, 06 Feb 2015 16:58:56 +0000 |
Revision: 6100
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6100
Author: gavin
Date: 2015-02-06 16:58:56 +0000 (Fri, 06 Feb 2015)
Log Message:
-----------
remove node name quoting explanation
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/texinfo.texi
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-02-06 15:34:53 UTC (rev 6099)
+++ trunk/ChangeLog 2015-02-06 16:58:56 UTC (rev 6100)
@@ -1,5 +1,10 @@
2015-02-06 Gavin Smith <address@hidden>
+ * doc/texinfo.texi (Info Format Specification): Remove mention
+ of quoting for certain characters in node names.
+
+2015-02-06 Gavin Smith <address@hidden>
+
* util/README: Remove mention of texindex.
2015-02-05 Karl Berry <address@hidden>
Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi 2015-02-06 15:34:53 UTC (rev 6099)
+++ trunk/doc/texinfo.texi 2015-02-06 16:58:56 UTC (rev 6100)
@@ -23806,10 +23806,10 @@
We specify literal parentheses (those that are part of the Info
format) with @t{<lparen>} and @t{<rparen>}, meaning the single
-characters @samp{(} and @samp{)} respectively. We specify the
address@hidden character (character number 127) with @t{<del>}.
-
-Finally, the two-character sequence @address@hidden means the single
+characters @samp{(} and @samp{)} respectively.
address@hidden We specify the @samp{CTRL-?} character (character number 127)
address@hidden with @t{<del>}. Finally,
+The two-character sequence @address@hidden means the single
character @address@hidden, for any @var{x}.
@menu
@@ -24047,7 +24047,8 @@
following format:
@example
- <id> = (<lparen><infofile><rparen>)?(<del>?<nodename><del>?)?
address@hidden <id> = (<lparen><infofile><rparen>)?(<del>?<nodename><del>?)?
+ <id> = (<lparen><infofile><rparen>)?(<nodename>)?
@end example
This @t{<node>} defines @t{<id1>} in file @t{<fn>}, which is typically
@@ -24069,9 +24070,13 @@
Node names containing periods, commas, colons or parentheses
(including @@-commands which produce any of these) can confuse
-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
address@hidden<del>} characters. @xref{Node Line Requirements}.
+Info readers.
address@hidden --- comment out the discussion of node name quoting here and
address@hidden elsewhere while it has limited implementation. - gavin,
2014-02-06.
address@hidden If it is necessary to refer to a node whose name contains any of
address@hidden these, the @t{<nodename>} should be surrounded by a pair of
@t{<del>}
address@hidden characters.
address@hidden 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
@@ -24117,7 +24122,7 @@
The parts of a @t{<menu entry>} are also described in @ref{Menu
Parts}. They have the same syntax as cross-references (@pxref{Info
-Format Cross Reference}). Indices extend menu format to specify the
+Format Cross Reference}). Indices extend the menu format to specify the
destination line; @pxref{Info Format Printindex}.
A @t{<menu comment>} is any line not beginning with @samp{*} that
@@ -24215,9 +24220,11 @@
@example
<cross-reference> =
* (N|n)ote <id>::
-| * (N|n)ote <label>:<id>(.|,)?
address@hidden| * (N|n)ote <label>:<id>(.|,)?
+| * (N|n)ote <label>:<id>(.|,)
- <id> = (<lparen><infofile><rparen>)?(<del>?<nodename><del>?)?
address@hidden <id> = (<lparen><infofile><rparen>)?(<del>?<nodename><del>?)?
+ <id> = (<lparen><infofile><rparen>)?(<nodename>)?
<label> = <del>?<label text><del>?
@end example
@@ -24235,14 +24242,15 @@
node or anchor within that manual,
The second form has a descriptive label. A cross-reference in this form
-should usually be terminated with a comma or period, to make it
address@hidden should usually be terminated with a comma or period, to make it
+should be terminated with a comma or period, to make it
feasible to find the end of the @t{<id>}.
-If @t{<label>} contains a colon character (@t{:}), it should be
-surrounded with a pair of @t{<del>} characters. Likewise, if
address@hidden<nodename>} contains problematic characters (such as commas or
-periods), it should be surrounded by a pair of @t{<del>} characters;
-then a terminating comma or period is not needed.
address@hidden If @t{<label>} contains a colon character (@t{:}), it should be
address@hidden surrounded with a pair of @t{<del>} characters. Likewise, if
address@hidden @t{<nodename>} contains problematic characters (such as commas or
address@hidden periods), it should be surrounded by a pair of @t{<del>}
characters;
address@hidden then a terminating comma or period is not needed.
The format does not prescribe how to find other manuals to resolve
such references.
@@ -24253,8 +24261,8 @@
*note GNU Free Documentation License::
*note Tag table: Info Format Tag Table, for details.
*Note Overview: (make)Top.
-*Note ^?:^?: (bash)Bourne Shell Builtins.
-*Note alloca.h: (gnulib)^?alloca.h^?.
address@hidden *Note ^?:^?: (bash)Bourne Shell Builtins.
address@hidden *Note alloca.h: (gnulib)^?alloca.h^?.
@end example
The first shows a reference to a node in the current manual using the
@@ -24268,8 +24276,8 @@
The third example refers to the node `Top' in another manual, namely
@samp{make}, with `Overview' being the label for this cross reference.
-The fourth example shows a colon character being quoted in a label, and
-the fifth example shows a period being quoted in a node name.
address@hidden The fourth example shows a colon character being quoted in a
label, and
address@hidden the fifth example shows a period being quoted in a node name.
@xref{Cross References}.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6100] remove node name quoting explanation,
Gavin D. Smith <=