4.2.2 Cross referencing: the link tag

To refer to another point in the documentation (a related function, class or whatever), a link tag exists. The link tag takes as a sole attribute a target id attribute. The link tag usually encloses a piece of text. In the HTML version of the documentation, this piece of text will function as a hyperlink. In the latex version, a page number reference will be printed.

The id attribute contains the name of an element to which the link refers. The name is not case sensitive, but it must be a fully qualified name.

An example of the link type would be:

The <link id="MyEnum">MyEnum</link> type is a simple type.

The link attribute also has a short form:

The <link id="MyEnum"/> type is a simple type.

In the short form, the value of the id attribute will be used as the text which will be hyperlinked. This is especially useful in the seealso tag.

To refer to a type in another unit, the unit name must be prepended to the id attribute:

<link id="myunit.myenum"/>

will link to the myenum type in a unit named myunit.

To refer to a node in the documentation of another package, the package name should be prepended to the id attribute, and it should be prepended with the hash symbol (#):

<link id="#fcl.classes.sofrombeginning"/>

will link to the constant sofrombeginning in the classes unit of the FCL reference documentation. Note that for this to work correctly, the contents file which was created when generating the documentation of the type must be imported correctly (see the import option).