The <linkpool> element defines a group of links that have common characteristics, such as type or audience or source. When links are not in a <linklist> (that is, they are in <related-links> or <linkpool> elements), the organization of links on final output is determined by the output process, not by the order that the links actually occur in the DITA topic.

There are two ways to organize related information links: add them all in no particular order, using the <linkpool> or <related-links> elements, and let the output formatting processor sort them; or pre-group them using one or more <linklist> elements. When you pre-group them using <linklist>, then the order of the links as you created them is preserved during the output formatting process.

Attributes set on <linkpool> are inherited by its descendants. For example, if you've got a <linkpool> that contains all external links, you can set scope="external" on that outer<linkpool> element and leave it off the links it contains.


(linkpool or link) (any number)

Contained by

related-links, linkpool




Name Description Data Type Default Value Required?
collection-type Collection types describe how links relate to each other. A family represents a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other. (unordered | sequence | choice | family) "unordered" No
duplicates Specifies whether or not duplicate links will be filtered out of a linklist. Allowable values are: "yes" (allow duplicate links), or "no" (filter out duplicate links). In general, duplicate links in linklists are preserved.. Note that links are regarded as duplicates only if their content plus all attributes match. Currently not supported in DITA processing. #IMPLIED The attribute value is currently ignored, but should default to yes for links in linklists and no for all other links. No
mapkeyref Identifies the map, if any, from which the contained links are derived. This value is automatically generated by the same process that creates the links from the map, as a way to identify which map the links came from. If the <linklist> or <linkpool> is manually created by the author, there is no need to use this attribute. CDATA #IMPLIED No
%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:

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."
The format of the linked-to resource is HTML or XHTML.
The format of the linked-to resource is PDF (opens a new window).
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)

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


<linkpool type="task">
<link href="generalfaq.html#installing" role="parent"/>
<link href="register.html#newuser" role="sibling"/>

OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.