Next: @pxref
, Previous: Referring to a Manual as a Whole, Up: Cross References [Contents][Index]
@ref
@ref
is nearly the same as @xref
except that it does
not generate a ‘See’ in the printed output, just the reference itself.
This makes it useful as the last part of a sentence.
For example,
For more information, @pxref{This}, and @ref{That}.
produces in Info:
For more information, *note This::, and *note That::.
and in printed output:
For more information, see Section 1.1 [This], page 1, and Section 1.2 [That], page 2.
The @ref
command can tempt writers to express themselves in a
manner that is suitable for a printed manual but looks awkward in the
Info format. Bear in mind that your audience could be using both the
printed and the Info format. For example:
Sea surges are described in @ref{Hurricanes}.
looks ok in the printed output:
Sea surges are described in Section 6.7 [Hurricanes], page 72.
but is awkward to read in Info, “note” being a verb:
Sea surges are described in *note Hurricanes::.