Next: , Previous: , Up: Cross-references   [Contents][Index]


5.7 @pxref

The parenthetical reference command, @pxref, is nearly the same as @xref, but it is best used within parentheses. The command differs from @xref in that TeX typesets the reference for the printed manual with a lowercase ‘see’ rather than an uppercase ‘See’.

With one argument, a parenthetical cross-reference looks like this:

… storms cause flooding (@pxref{Hurricanes}) …

which produces

… storms cause flooding (*note Hurricanes::) …

in Info and

… storms cause flooding (see Section 6.7 [Hurricanes], page 72) …

in a printed manual.

With two arguments, a parenthetical cross-reference has this template:

… (@pxref{node-name, cross-reference-name}) …

which produces

… (*note cross-reference-name: node-name.) …

in Info and

… (see Section nnn [node-name], page ppp) …

in a printed manual.

@pxref can be used with up to five arguments, just like @xref (see @xref).

In past versions of Texinfo, it was not allowed to write punctuation after a @pxref, so it could be used only before a right parenthesis. This is no longer the case. The effect of ‘@pxref{node-name}’ is similar to that of ‘see @ref{node-name}’. However, in many circumstance the latter is preferrable, as this makes it clear in the Info output that the word “see” should be present.