related-links

The 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 it 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.

Contains

Doctype Content model
ditabase, topic, task, reference, concept, glossary ( link or linklist or linkpool) (one or more)

Contained by

Doctype Parents
ditabase topic, concept, task, reference, glossentry
topic topic
task topic, task
concept topic, concept
reference topic, reference
glossary topic, concept, glossentry

Inheritance:

- topic/related-links

Return to main page.

OASIS DITA Language Specification v1.1 -- Committee Draft 02, 8 May 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.