Supported values for roleAllowable values for the role attribute are:
- parent
- Indicates a link to a topic that is a parent of the current topic.
- child
- Indicates a link to a direct child such as a directly nested or
dependent topic.
- sibling
- Iindicates a link between two children of the same parent topic.
- friend
- Indicates a link to a similar topic that is not necessarily part
of the same hierarchy.
- next
- Indicates a link to the next topic in a sequence.
- previous
- Indicates a link to the previous topic in a sequence.
- cousin
- Indicates a link to another topic in the same hierarchy that is
not a parent, child, sibling, next, or previous.
- ancestor
- Indicates a link to a topic above the parent topic.
- descendant
- Indicates a link to a topic below a child topic.
- sample
- Deprecated.
- external
- Deprecated--use the scope="external" attribute to indicate
external links.
- other
- Indicates any other kind of relationship or role. Enter that role as the value for the
otherrole attribute.
-
-
The otherrole attribute is available to specify an alternate
role that is not available in the list above, and should be used in conjunction with
role="other".