texinfo-commits
[Top][All Lists]
Advanced

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

branch master updated: * doc/texinfo.texi (Cross Reference Parts): Remov


From: Gavin D. Smith
Subject: branch master updated: * doc/texinfo.texi (Cross Reference Parts): Remove examples to make the cross-reference parts more visible in this node. (There are similar examples later on in the chapter.)
Date: Tue, 16 Aug 2022 04:52:57 -0400

This is an automated email from the git hooks/post-receive script.

gavin pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new 29682e9825 * doc/texinfo.texi (Cross Reference Parts): Remove examples 
to make the cross-reference parts more visible in this node. (There are similar 
examples later on in the chapter.)
29682e9825 is described below

commit 29682e9825a1a6c8d2c1bf403d94af80f53ec99b
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Tue Aug 16 09:52:07 2022 +0100

    * doc/texinfo.texi (Cross Reference Parts): Remove examples
    to make the cross-reference parts more visible in this node.
    (There are similar examples later on in the chapter.)
---
 ChangeLog        |  6 ++++++
 doc/texinfo.texi | 66 +++++++-------------------------------------------------
 2 files changed, 14 insertions(+), 58 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 1ed99386b6..ad7594e90e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2022-08-16  Gavin Smith  <gavinsmith0123@gmail.com>
+
+       * doc/texinfo.texi (Cross Reference Parts): Remove examples
+       to make the cross-reference parts more visible in this node.
+       (There are similar examples later on in the chapter.)
+
 2022-08-15  Patrice Dumas  <pertusus@free.fr>
 
        Avoid node name quoting when not needed in menu with entry name
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 90d0eb29dd..a37590773f 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -4361,62 +4361,22 @@ Wide Web.
 @anchor{Reference Syntax} @c merged node
 
 A cross-reference command requires only one argument, which is
-the name of the node to which it refers.  Here is a simple example:
-
-@example
-@@xref@{Node name@}.
-@end example
-
-@noindent
-In Info output, this produces
+the name of the node to which it refers.  A cross-reference command
+may contain up to four additional arguments.
+The template for a full five argument cross-reference looks like
+this:
 
 @example
-*Note Node name::.
+@group
+@@xref@{@var{node-name}, @var{online-label}, @var{printed-label},
+@var{info-file-name}, @var{printed-manual-title}@}
+@end group
 @end example
 
-@noindent
-In a printed manual, the output is
-
-@quotation
-See Section @var{nnn} [Node name], page @var{ppp}.
-@end quotation
-
-A cross-reference command may contain up to four additional arguments.
-By using these arguments, you can provide a cross-reference name,
-a topic description or section title for the printed output, the name
-of a different manual file, and the name of a different printed manual.
 To refer to another manual as a whole, the manual file and/or the name
 of the printed manual are the only required arguments (@pxref{Referring
 to a Manual as a Whole}).
 
-@need 700
-Here is an example of a full five-part cross-reference:
-
-@example
-@group
-@@xref@{Node name, Online Label, Printed Label,
-info-file-name, A Printed Manual@}, for details.
-@end group
-@end example
-
-@noindent
-which produces
-
-@example
-*Note Online Label: (info-file-name)Node name,
-for details.
-@end example
-
-@noindent
-in Info and
-
-@quotation
-See section ``Printed Label'' in @i{A Printed Manual}, for details.
-@end quotation
-
-@noindent
-in a printed book.
-
 The five possible arguments for a cross-reference are:
 
 @enumerate
@@ -4452,16 +4412,6 @@ HTML.
 The name of a printed manual from a different Texinfo file.
 @end enumerate
 
-The template for a full five argument cross-reference looks like
-this:
-
-@example
-@group
-@@xref@{@var{node-name}, @var{online-label}, @var{printed-label},
-@var{info-file-name}, @var{printed-manual-title}@}
-@end group
-@end example
-
 Whitespace before and after the commas separating these arguments is
 ignored.  To include a comma in one of the arguments, use
 @code{@@comma@{@}} (@pxref{Inserting a Comma}).



reply via email to

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