Common Desktop Environment: Help System Author's and Programmer's Guide


Cross-reference: Inserts text that identifies another location in the help volume and creates a hyperlink to that location.


<xref id> 


id is the identifier of the topic or location that is being cross-referenced.

Cross-references are translated into chapter or section titles, heads, figure captions, list items, or line numbers. The cross-reference text becomes a hyperlink that, when chosen by a user, jumps to the cross-referenced location.

To create a cross-reference, an id must be defined in the element that you intend to refer to. You use the id of the destination element as the id parameter in the <xref> tag. This creates a hyperlink from the <xref> element to the destination element. The id must be spelled exactly the same. Capitalization, however, is not significant.

The id parameter can appear with:

<s1>, <s2>,...<s9>

A cross-reference to an id that contains an underscore (such as "_abstract" or "_hometopic") is not allowed. Instead, use the <link> element.


To refer a reader to a chapter for more information, use the chapter's id to create a reference. For instance, to refer to a chapter titled "Window Management" whose id is windowmgr, you would write, "Refer to <xref windowmgr> for details."

In your online help volume, the result would be: "Refer to Window Management for details." The chapter title, "Window Management", is substituted for the id and is a hyperlink.

The following markup assigns an id named "analyzer" to a section element:

<s1 id=analyzer>Logic Analyzers

Here is markup that contains a cross-reference to this topic:

The DX16500A logic analysis system, described in
 <xref analyzer>, can be configured to a user's needs.

After processing, the <xref> element would be replaced by "Logic Analyzers" as shown here:


The text "Logic Analyzers" is a hyperlink that, when chosen by a user, jumps to the cross-referenced help topic.

See Also