texinfo ChangeLog doc/texinfo.txi

[karl]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     karl <karl>     13/01/07 18:36:39

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        (Cross References): use @ in node names

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1502&r2=1.1503
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.513&r2=1.514

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1502
retrieving revision 1.1503
diff -u -b -r1.1502 -r1.1503
--- ChangeLog   6 Jan 2013 23:18:56 -0000       1.1502
+++ ChangeLog   7 Jan 2013 18:36:38 -0000       1.1503
@@ -1,3 +1,8 @@
+2013-01-07  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (Cross References): node names with @
+       throughout chapter.
+
 2013-01-06  Karl Berry  <address@hidden>
 
        * install-info/install-info.c (open_possibly_compressed_file):

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.513
retrieving revision 1.514
diff -u -b -r1.513 -r1.514
--- doc/texinfo.txi     6 Jan 2013 22:57:57 -0000       1.513
+++ doc/texinfo.txi     7 Jan 2013 18:36:39 -0000       1.514
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.513 2013/01/06 22:57:57 karl Exp $
address@hidden $Id: texinfo.txi,v 1.514 2013/01/07 18:36:39 karl Exp $
 @c Ordinarily, Texinfo files have the extension .texi.  But texinfo.texi
 @c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
 
@@ -314,13 +314,13 @@
 * References::                  What cross references are for.
 * Cross Reference Commands::    A summary of the different commands.
 * Cross Reference Parts::       A cross reference has several parts.
-* xref::                        Begin a reference with `See' @dots{}
+* @code{@@xref}::                       Begin a reference with `See' @dots{}
 * Top Node Naming::             How to refer to the beginning of another file.
-* ref::                         A reference for the last part of a sentence.
-* pxref::                       How to write a parenthetical cross reference.
-* inforef::                     How to refer to an Info-only file.
-* uref::                        How to refer to a uniform resource locator.
-* cite::                        How to refer to books not in the Info system.
+* @code{@@ref}::                        A reference for the last part of a 
sentence.
+* @code{@@pxref}::                      How to write a parenthetical cross 
reference.
+* @code{@@inforef}::                    How to refer to an Info-only file.
+* @code{@@url}::                        How to refer to a uniform resource 
locator.
+* @code{@@cite}::                       How to refer to books not in the Info 
system.
 
 @code{@@xref}
 
@@ -5395,13 +5395,15 @@
 (@pxref{Node Line Requirements}).
 
 @cindex Nodes, deleting or renaming
-Because of this duality, when you delete or rename a node, it can be
-useful to retain an @code{@@anchor} with the old name.  That way, any
-links to the old node, whether from other Texinfo manuals or general
-web pages, will still work.  You can also do this with the
address@hidden feature of @command{makeinfo} (@pxref{HTML
-Xref Link Preservation}).  There is no effective difference between
-the two approaches.
+Because of this duality, when you delete or rename a node, it is
+usually a good idea to define an @code{@@anchor} with the old name.
+That way, any links to the old node, whether from other Texinfo
+manuals or general web pages, keep working.  You can also do this with
+the @file{RENAMED_NODES_FILE} feature of @command{makeinfo}
+(@pxref{HTML Xref Link Preservation}).  Both methods keep links
+on the web working; the only substantive difference is that defining
+anchors also makes the old node names available when reading the
+document in Info.
 
 
 @node Node Menu Illustration
@@ -5844,13 +5846,13 @@
 * References::                  What cross references are for.
 * Cross Reference Commands::    A summary of the different commands.
 * Cross Reference Parts::       A cross reference has several parts.
-* xref::                        Begin a reference with `See' @dots{}
+* @code{@@xref}::                       Begin a reference with `See' @dots{}
 * Top Node Naming::             How to refer to the beginning of another file.
-* ref::                         A reference for the last part of a sentence.
-* pxref::                       How to write a parenthetical cross reference.
-* inforef::                     How to refer to an Info-only file.
-* uref::                        How to refer to a uniform resource locator.
-* cite::                        How to refer to books not in the Info system.
+* @code{@@ref}::                        A reference for the last part of a 
sentence.
+* @code{@@pxref}::                      How to write a parenthetical cross 
reference.
+* @code{@@inforef}::                    How to refer to an Info-only file.
+* @code{@@url}::                        How to refer to a uniform resource 
locator.
+* @code{@@cite}::                       How to refer to books not in the Info 
system.
 @end menu
 
 @node References
@@ -5924,7 +5926,7 @@
 @noindent
 The @code{@@cite} command is used to make references to books and
 manuals for which there is no corresponding Info file and, therefore,
-no node to which to point.   @xref{cite, , @code{@@cite}}.
+no node to which to point.  @address@hidden@@cite}}.
 
 
 @node Cross Reference Parts
@@ -6040,8 +6042,10 @@
 formatters may not find the reference.
 
 
address@hidden xref
address@hidden @code{@@xref}
 @section @code{@@xref}
+
address@hidden@c old name
 @findex xref
 @cindex Cross references using @code{@@xref}
 @cindex References using @code{@@xref}
@@ -6096,7 +6100,7 @@
 the cross reference automatically.  You must write that period or
 comma yourself; otherwise, Info will not recognize the end of the
 reference.  (The @code{@@pxref} command works differently;
address@hidden,,@code{@@pxref}}.)
address@hidden@code{@@pxref}}.)
 
 @quotation Caution
 A period or comma @emph{must} follow the closing brace of an
@@ -6567,11 +6571,13 @@
 third argument in whole-manual cross references is preferable.
 
 
address@hidden ref
address@hidden @code{@@ref}
 @section @code{@@ref}
+
address@hidden@c old name
address@hidden ref
 @cindex Cross references using @code{@@ref}
 @cindex References using @code{@@ref}
address@hidden ref
 
 @code{@@ref} is nearly the same as @code{@@xref} except that it does
 not generate a `See' in the printed output, just the reference itself.
@@ -6634,11 +6640,13 @@
 ``See'') is ok, @code{@@xref} and @code{@@pxref} are preferable.
 
 
address@hidden pxref
address@hidden @code{@@pxref}
 @section @code{@@pxref}
+
address@hidden@c old name
address@hidden pxref
 @cindex Cross references using @code{@@pxref}
 @cindex References using @code{@@pxref}
address@hidden pxref
 
 The parenthetical reference command, @code{@@pxref}, is nearly the
 same as @code{@@xref}, but it is best used at the end of a sentence or
@@ -6717,7 +6725,7 @@
 in a printed manual.
 
 @code{@@pxref} can be used with up to five arguments, just like
address@hidden@@xref} (@pxref{xref, , @code{@@xref}}).
address@hidden@@xref} (@address@hidden@@xref}}).
 
 In past versions of Texinfo, it was not allowed to write punctuation
 after an @code{@@pxref}, so it could be used @emph{only} before a
@@ -6747,11 +6755,13 @@
 that location breaks up the flow of reading.
 
 
address@hidden inforef
address@hidden @code{@@inforef}
address@hidden @code{@@inforef}
address@hidden @code{@@inforef}: Cross References to Info-only Material
+
address@hidden@c old name
address@hidden inforef
 @cindex Cross references using @code{@@inforef}
 @cindex References using @code{@@inforef}
address@hidden inforef
 
 @code{@@inforef} is used for making cross references to Info
 documents---even from a printed manual.  This might be because you
@@ -6821,12 +6831,14 @@
 know of any extant Info-only manuals.)
 
 The converse of @code{@@inforef} is @code{@@cite}, which is used to
-refer to printed works for which no Info form exists.  @xref{cite, ,
address@hidden@@cite}}.
+refer to printed works for which no Info form exists.
address@hidden@code{@@cite}}.
 
 
address@hidden uref
address@hidden @code{@@url}
 @section @code{@@url}, @code{@@address@hidden@var{url}[, @var{text}][, 
@address@hidden
+
address@hidden@c old name
 @findex uref
 @cindex Uniform resource locator, referring to
 @cindex URL, referring to
@@ -6957,8 +6969,10 @@
 @code{@@indicateurl} (@pxref{indicateurl, @code{@@indicateurl}}).
 
 
address@hidden cite
address@hidden @code{@@cite}
 @section @code{@@address@hidden@address@hidden
+
address@hidden@c old name
 @findex cite
 
 Use the @code{@@cite} command for the name of a book that lacks a
@@ -6967,7 +6981,7 @@
 
 If a book is written in Texinfo, it is better to use a cross reference
 command since a reader can easily follow such a reference in Info.
address@hidden, , @code{@@xref}}.
address@hidden@code{@@xref}}.
 
 
 @node Marking Text
@@ -7085,8 +7099,7 @@
 @xref{dfn,,@code{@@dfn}}.
 
 @item @@address@hidden@address@hidden
-Indicate the name of a book.
address@hidden,,@code{@@cite}}.
+Indicate the name of a book.  @address@hidden@@cite}}.
 
 @item @@address@hidden@address@hidden
 Indicate an abbreviation, such as `Comput.'.
@@ -7098,7 +7111,7 @@
 @item @@address@hidden@address@hidden
 Indicate an example (that is, nonfunctional) uniform resource locator.
 @xref{indicateurl,,@code{@@indicateurl}}.  (Use @code{@@url}
-(@pxref{uref,,@code{@@url}}) for live urls.)
+(@address@hidden@@url}}) for live urls.)
 
 @item @@address@hidden@var{email-address}[, @address@hidden
 Indicate an electronic mail address.
@@ -7793,7 +7806,7 @@
 Use the @code{@@indicateurl} command to indicate a uniform resource
 locator on the World Wide Web.  This is purely for markup purposes and
 does not produce a link you can follow (use the @code{@@url} or
address@hidden@@uref} command for that, @pxref{uref,,@code{@@uref}}).
address@hidden@@uref} command for that, @address@hidden@@url}}).
 @code{@@indicateurl} is useful for urls which do not actually exist.
 For example:
 
@@ -12075,7 +12088,7 @@
 @end example
 
 The @code{@@/} command can often be useful within urls
-(@pxref{uref,,@code{@@uref}}), which tend to be long and are otherwise
+(@address@hidden@@url}}), which tend to be long and are otherwise
 unbreakable.  For example:
 
 @example
@@ -19983,7 +19996,7 @@
 
 @item @@address@hidden@address@hidden
 Highlight the name of a book or other reference that has no companion
-Info file.  @xref{cite, , @code{@@cite}}.
+Info file.  @address@hidden@@cite}}.
 
 @item @@clear @var{flag}
 Unset @var{flag}, preventing the Texinfo formatting commands from
@@ -20508,7 +20521,7 @@
 
 @item @@address@hidden@var{node-name}, address@hidden, @address@hidden
 Make a cross reference to an Info file for which there is no printed
-manual.  @xref{inforef,, Cross references using @code{@@inforef}}.
+manual.  @address@hidden@@inforef}}.
 
 @item @@address@hidden@var{fmt}, @address@hidden
 @itemx @@address@hidden@var{fmt}, @address@hidden
@@ -20697,7 +20710,7 @@
 @item @@address@hidden@var{node}, address@hidden, address@hidden, 
address@hidden, address@hidden@}
 Make a reference that starts with a lowercase `see' in a printed
 manual.  Use within parentheses only.  Only the first argument is
-mandatory.  @xref{pxref, , @code{@@pxref}}.
+mandatory.  @address@hidden@@pxref}}.
 
 @item @@address@hidden@}
 Generate an upside-down question mark.  @xref{Inserting Accents}.
@@ -20735,7 +20748,7 @@
 @item @@address@hidden@var{node}, address@hidden, address@hidden, 
address@hidden, address@hidden@}
 Make a plain reference that does not start with any special text.
 Follow command with a punctuation mark.  Only the first argument is
-mandatory.  @xref{ref, , @code{@@ref}}.
+mandatory.  @address@hidden@@ref}}.
 
 @item @@refill
 @findex refill
@@ -21022,12 +21035,12 @@
 @item @@address@hidden@var{url}[, @var{displayed-text}][, @address@hidden
 @itemx @@address@hidden@var{url}[, @var{displayed-text}][, @address@hidden
 Define a cross reference to an external uniform resource locator,
-e.g., for the World Wide Web.  @xref{uref, , @code{@@uref}}.
+e.g., for the World Wide Web.  @address@hidden@@url}}.
 
 @item @@urefbreakstyle @var{style}
 Specify how @code{@@uref}/@code{@@url} should break at special
 characters: @code{after}, @code{before}, @code{none}.
address@hidden,, @code{@@uref}}.
address@hidden@code{@@url}}.
 
 @item @@address@hidden@address@hidden
 Generate check accent over the character @var{c}, as in @v{o}.
@@ -21084,7 +21097,7 @@
 @item @@address@hidden@var{node}, address@hidden, address@hidden, 
address@hidden, address@hidden@}
 Make a reference that starts with `See' in a printed manual.  Follow
 command with a punctuation mark.  Only the first argument is
-mandatory.  @xref{xref, , @code{@@xref}}.
+mandatory.  @address@hidden@@xref}}.
 
 @item @@xrefautomaticsectiontitle @var{on-off}
 By default, use the section title instead of the node name in cross
@@ -21758,7 +21771,7 @@
 as:
 
 @example
-$Id: texinfo.txi,v 1.513 2013/01/06 22:57:57 karl Exp $
+$Id: texinfo.txi,v 1.514 2013/01/07 18:36:39 karl Exp $
 @end example
 
 (This is potentially useful in all sources that use version control,