Next: @inforef: Cross-references to Info-only Material, Previous: @anchor: Defining Arbitrary Cross-reference Targets, Up: Cross-references   [Contents][Index]


5.12 @link: Plain, unadorned hyperlink ¶

@link produces a plain hyperlink in output formats that support it, including in HTML, DocBook, LaTeX and online PDF. The template is:

@link{node-name, label, manual-name}

node-name is the name of the target node or anchor. Either or both of label and manual-name can be omitted. label, if given, is the text to use for the link. manual-name is the name of the external manual that the target appears within; if not given, the reference is to the current manual.

@link has similar output to @ref, except that it does produce any extra text around the link label in Info or printed output that would mark it as a cross-reference.

Be careful about using @link to produce links that are necessary for a user to move around a manual, as these links will do nothing in these output formats. @link is best used to add convenience links that are nonetheless not essential for a reader to understand the text of the manual. For example, you might use @link in a code sample to reference documentation of a symbol in a programming library.