Related-linksThe related information links of a topic (<related-links> element) are
stored in a special section following the body of the topic. After a topic is
processed into its final output form, the related links are usually displayed at
the end of the topic, although some Web-based help systems might display them in
a separate navigation frame.
Processing notes:
1. Prerequisite links are an exception (that is, in which importance="required" and the role is compatible–not ancestor/parent/child/descendant/next). Implementations may (but need not) sort these after the <shortdesc> (all topics) or after the <prereq> section (for tasks).
2. PDF output typically ignores hierarchical links, for example ancestor/parent/child/descendant/next/previous/sibling, although it may include some child links to produce summaries at the start of chapters.
3. Links not in a <linklist> will be sorted on output based on type, role, and importance.
4. The value of the format attribute defaults to "dita" unless the attribute scope="external", when format is assumed to be not-dita.
[edit] Contains
| Doctype
| Content model
|
| ditabase, topic, task, reference, concept, glossary
| (link or
linklist or
linkpool) (one or more)
|
[edit] Contained by
[edit] Inheritance:
- topic/related-links
[edit] Attributes
| Name
| Description
| Data Type
| Default Value
| Required?
|
| type
| Describes the target of a cross-reference. See The type attribute for detailed information on supported values and processing implications.
| CDATA
| #IMPLIED (Processed as if the target were of type "topic", or inherited from an ancestor)
| 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. See The role attribute for information on supported values.
| child | sibling | friend | next | previous | cousin | ancestor
| sample | external | [deprecated] other | -dita-use-conref-target)
| #IMPLIED
| No
|
| otherrole
| Indicates an alternate role. This value is used when the role attribute
is set to other.
| CDATA
| #IMPLIED
| No
|
| format
| The format attribute identifies the format of the resource being
cross referenced. See The format attribute for details
on supported values.
| CDATA
| #IMPLIED
| No
|
| scope
| The scope attribute identifies the closeness of the relationship
between the current document and the target resource.
- Set scope to local when the resource is part of the current set of content.
- Set scope to peer when the resource is part of the current set of content but is not accessible at build time.
- Set scope to external when the resource is not part of the current information set and should open in a new browser window.
- See Using the -dita-use-conref-target value for more information on -dita-use-conref-target.
The processing default is local. If no value is
specified, but the attribute is specified on an ancestor within a map or within
the related-links section, the value will inherit from the closest ancestor.
| peer | external | -dita-use-conref-target)
| #IMPLIED
| No
|
| %univ-atts; (%select-atts;, %id-atts;, %localization-atts;)
| A set of related attributes, described at %univ-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| %global-atts; (xtrf, xtrc)
| A set of related attributes, described at %global-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| class, outputclass
| Common attributes described in Other common DITA attributes
|
|
|
|
TOC: Language Specification 1.1
Parent topic: Topic elements
Previous topic: example
|
|
