The <linkpool> element defines
a group of links that have common characteristics, such as type or
audience or source. When links 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 within a topic. First, you can add them
all in no particular order, either by using <linkpool> elements
or by placing <link> elements directly within <related-links>,
in which case the rendering is implementation dependent. For example,
tools may choose to sort all links based on the role or type; tools
may also move or remove links to fit the context (for example, moving
a prerequisite link to the top of a browser window, or removing links
to the next topic if it is rendered on the same page in a PDF). These
behaviors are examples only and are not required.
may be grouped using one or more <linklist> elements. When you
group them using <linklist>, then the order of the links within
each <linklist> is preserved when rendered. You may also use a
combination of the two approaches, which will allow some links to
be automatically sorted while the others are left as-is.
set on the <linkpool> and <linklist> elements are inherited
by their descendants. For example, if you have a <linklist>
element that contains all external links, you can set scope="external" on
that outer <linklist> element and leave it off the <link>
elements within that <linklist>.
Note: These models represent only the default document types distributed by OASIS.
Actual content models will differ with each new document type.
|topic, concept, ditabase, glossary, glossentry, glossgroup, reference, task, machineryTask, learningAssessment, learningContent, learningOverview, learningPlan, learningSummary
|| (linkpool or link) (any number)
|topic (base), topic (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), machineryTask, learningAssessment, learningContent, learningOverview, learningPlan, learningSummary
<link href="czez.dita#czez" role="next"></link>
<link format="html" href="czover.htm#sqljsupp" role="parent">
<linktext>Overview of the CZ</linktext>
<link format="html" href="czesqlj.htm#sqljemb">
<linktext>Working with CZESQLJ</linktext>
<desc>When you work with CZESQLJ, you need to know...</desc>
||Collection types describe how links relate to each other.
The processing default is "unordered", although no default is specified in the
DTD or Schema.
- Indicates that the order of the child topics is not
- Indicates that the order of the child topics is
significant; output processors will typically link between them in order.
- Indicates that one of the children should be selected.
- Represents a tight grouping in which each of the referenced
topics not only relates to the current topic but also relate to each other.
Using the -dita-use-conref-target value for more
Usage of the collection-type attribute on <reltable> and
<relcolspec> is currently undefined and reserved for future use.
|(unordered | sequence | choice | family |
||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.
||The attribute value is currently ignored, but should default
to yes for links in linklists and no for all other links.
||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.
Note that this attribute is not related to the
keyref attribute, and is not used for key based processing.
||Describes the target of a reference. See
The type attribute for detailed information
on supported values and processing implications.
||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.
The role attribute for information on
The role attribute values
external are deprecated.
|(parent | child | sibling | friend | next | previous |
cousin | ancestor | descendant |
external | other | -dita-use-conref-target)
||Indicates an alternate role. This value is used when the
role attribute is set to other.
||The format attribute identifies the format of the resource
being referenced. See
The format attribute for details on
||The scope attribute identifies the closeness of the
relationship between the current document and the target resource. See
The scope attribute for more information on
||(local | peer | external |
|univ-atts attribute group (includes select-atts, id-atts,
and localization-atts groups)
||A set of related attributes, described in
univ-atts attribute group
|global-atts attribute group (xtrf, xtrc)
||A set of related attributes, described in
global-atts attribute group
||Common attributes described in
Other common DITA attributes