Relational attributes (<%rel-atts;>) is a parameter entity declaration in the topic DTD that includes attributes whose values may be used for representing navigational relationships. These attributes occur only on elements that represent relationships between topics.
|Name||Description||Data Type||Default Value||Required?|
|type||Describes the target of a cross-reference and may generate cross-reference
text based on that description. Only the <xref> element can link to content
below the topic level: other types of linking can target whole topics, but
not parts of topics. Typically <xref> should also be limited to topic-level
targets, unless the output is primarily print-oriented. Web-based referencing
works best at the level of whole topics, rather than anchor locations within
When targetting DITA content, the type should match one of the values in the target's class attribute. For example, if type="topic", the link could be to a generic topic, or any specialization of topic, including concept, task, and reference.
Some possible values include:
Other values can be used to indicate other types of topics or elements as targets. Processing is only required to support the above list, or specializations of types in that list. Supporting additional types as targets may require the creation of processing overrides.
|CDATA||#IMPLIED (Processed as if the target were of type "topic.")||No|
|role||The role attribute defines the role the target topic plays in relationship
with the current topic. For example, in a parent/child relationship, the role
would be "parent" when the target is the parent of the current topic,
and "child" when the target is the child of the current topic. This
structure could be used to sort and classify links at display time.
Allowable values are:
|(parent | child | sibling | friend | next | previous | cousin | ancestor | descendant | sample | external | [deprecated] other)||"friend"||No|
|otherrole||Indicates an alternate role. This value is used when the role attribute is set to other.||CDATA||#IMPLIED||No|
The %rel-atts; parameter entity is used within the DITA dtds as a common definition for attributes available to elements that represent topic-to-topic relationships. Not all of these capabilities have been provided yet for DITA topic processing. Some typical examples include:
<link type="task" role="child" href="how2uninst.dita" scope="local"/>
OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.