manpagez: man pages & more
info texinfo
Home | html | info | man
[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.4.3 @xref with Two Arguments

With two arguments, the second is used as the name of the cross reference, while the first is still the name of the node to which the cross reference points.

The template is like this:

@xref{node-name, cross-reference-name}.

For example,

@xref{Electrical Effects, Lightning}.

produces:

*Note Lightning: Electrical Effects.

in Info and

See Section 5.2 [Electrical Effects], page 57.

in a printed manual. (Note that in the preceding example the closing brace is followed by a period; and that the node name is printed, not the cross reference name.)

You can write a clause after the cross reference, like this:

@xref{Electrical Effects, Lightning}, for more info.

which produces

*Note Lightning: Electrical Effects, for more info.

in Info and

See Section 5.2 [Electrical Effects], page 57, for more info.

in a printed manual. (Note that in the preceding example the closing brace is followed by a comma, and then by the clause, which is followed by a period.)

The second argument to cross references must observe some of the restrictions for node names (see section @node Line Requirements). The most common issue is that colons cannot be used, since that interferes with the parsing of the Info file.


[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

This document was generated on October 2, 2013 using texi2html 5.0.

© manpagez.com 2000-2017
Individual documents may contain additional copyright information.