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.

Prerequisite links are an exception (that is, in which importance="required" and the role is compatible–not ancestor/parent/child/descendant/next). These get sorted after the <shortdesc> (all topics) or after the <prereq> section (for tasks).

Processing notes:

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.
Links not in a <linklist> will be sorted on output based on type, role, and importance.
The value of the format attribute defaults to "dita" unless the attribute scope="external", when format is assumed to be not-dita.

Contains

(link or linklist or linkpool) (one or more)

Contained by

topic, concept, task, reference

Inheritance

topic/related-links

Attributes

Name	Description	Data Type	Default Value	Required?
%rel-atts; (type, role, otherrole)	A set of related attributes, described at %rel-atts;	parameter entity	PE not applicable	Not applicable
%select-atts; (platform, product, audience, otherprops, importance, rev, status)	A set of related attributes, described at %select-atts;	parameter entity	PE not applicable	Not applicable
format	The format attribute identifies the format of the resource being cross referenced. The default format is "dita". Possible values include: dita The destination uses DITA topic markup, or markup specialized from a DITA topic. Unless otherwise specified, the corresponding default type will be treated as "topic." html The format of the linked-to resource is HTML or XHTML. pdf The format of the linked-to resource is PDF (opens a new window). ditamap The linked-to resource is a DITA map. It represents a referenced hierarchy at a position within referencing hierarchy, and a referenced relationship table included outside the referencing hierarchy (no value) Defaults to "dita" For other formats, you can use the file extension without the "." (for example, in a link to file "readme.txt", use "txt" as the value)	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, and should be accessed and copied to the output directory. 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. The default is `local`.	(local \| peer \| external)	#IMPLIED	No
%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

Example

<task id="sqlj">
 <title>Creating an SQLJ file</title>
 <taskbody>...</taskbody>
 <related-links>
  <link href="#concept"><linktext>Some little concept</linktext></link>
 </related-links>
</task>