Next: , Previous: Top Node Naming, Up: Cross References


8.6 @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, see @ref{Hurricanes}.

produces (in Info):

     For more information, see *Note Hurricanes::.

and (in printed output):

For more information, see Section 8.2 [Hurricanes], page 123.

The @ref command sometimes tempts 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 will 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:

     Sea surges are described in *Note Hurricanes::.

As a general rule, you should write a period or comma immediately after an @ref command with two or more arguments.

If there is no such following punctuation, makeinfo will generate a (grammatically incorrect) period in the Info output; otherwise, the cross-reference would fail completely, due to the current syntax of Info format.