texinfo: Reference Syntax

@xref

One Argument

Back to Software Index

8.4.1 What a Reference Looks Like and Requires
----------------------------------------------

Most often, an Info cross reference looks like this:

     Note: NODE-NAME.

or like this

     Note: CROSS-REFERENCE-NAME.

In TeX, a cross reference looks like this:

     See Section SECTION-NUMBER [NODE-NAME], page PAGE.

or like this

     See Section SECTION-NUMBER [TITLE-OR-TOPIC], page PAGE.

  The '@xref' command does not generate a period or comma to end the
cross reference automatically.  You must write that period or comma
yourself; otherwise, Info will not recognize the end of the reference.
(The '@pxref' command works differently; Note: @pxref.)

     Caution: A period or comma _must_ follow the closing brace of an
     '@xref'.  It is required to terminate the cross reference.  This
     period or comma will appear in the output.

  '@xref' must refer to a node by name.  Use '@node' to define the node
(Note: Writing a Node), or '@anchor' (Note: @anchor).

  '@xref' is followed by several arguments inside braces, separated by
commas.  Whitespace before and after these commas is ignored.

  A cross reference to a node within the current file requires only the
name of a node; but it may contain up to four additional arguments.
Each of these variations produces a cross reference that looks somewhat
different.  A cross reference to another manual as a whole only requires
the fourth or fifth argument.

     Note: Commas separate arguments in a cross reference, so you must
     not include a comma in the title or any other part lest the
     formatters mistake them for separators.  '@comma{}' may be used to
     protect such commas (Note: Inserting a Comma).