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


Location: Defines an ID as referring to the location of the <location> element. The <location> element enables a portion of a topic to serve as a destination for a hyperlink using the <link> or <xref> element.


<location id=id>text<\location> 


<location id=id|text|



The identifier for the current location, which can be used as a destination for hyperlinks.


The block of text where you want to assign the ID.

The <location> element is not needed at locations where there is already an element (such as <hometopic> or <figure>) that has a built-in ID or accommodates an author-defined id parameter.

Cross-references created with the <xref> element substitute the text between the <location> start and end tag for the <xref> element.


The following markup names a location and elsewhere creates a hyperlink to the location.

<s1 id=ConfigTopic> Configuration
 <location id=ConfigTopicBody>some text<\location>
 <s1 id=UseTopic> Usage
 See <link ConfigTopicBody>Configuration<\link>
 for additional information.

The advantage of linking to the ID in the <location> element is that the help window automatically scrolls to the point where the <location> tag is entered. In contrast, a link to the topic's ID ("ConfigTopic" in this case), always goes to the top of the topic.

The <location> element can also reference a position in your file using the predefined entity, (&empty;), as a placeholder.

Adding this markup at a key position in your file, allows you to create a link to that specific location:

paragraph text
 <location id=pointA>&empty;<\location>

See Also