LinklistThe <linklist> element defines an author-arranged
group of links. Within <linklist>, the organization
of links on final output is in the same order as originally authored 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 <linklist>
are inherited by its descendants. For example, if you've got a <linklist>
that contains all external links, you can set scope="external" on
that outer<linklist> element and leave it off the
contained links.
[edit] Contains
| Doctype
| Content model
|
| ditabase, topic, task, reference, concept, glossary
| ( (
title) (optional) then (
desc) (optional) then (
linklist or
link) (any number) then (
linkinfo) (optional) )
|
[edit] Contained by
| Doctype
| Parents
|
| ditabase, topic, task, concept, reference, glossary
| related-links, linklist
|
[edit] Inheritance:
- topic/linklist
[edit] Attributes
| Name
| Description
| Data Type
| Default Value
| Required?
|
| collection-type
| Collection types describe how links relate to each other. A family
collection represents a tight grouping in which each of the referenced topics
not only relates to the current topic but also relate to each other. Sequence
indicates that the order of the child topics is significant; output processors
will typically link between them in order. Unordered indicates that the order
is not significant. Choice indicates that one of the children should be selected.
If no value is specified, processors should treat the default as "unordered",
although no default is specified in the DTD. See [[this
topic]] for more information on the conref value.
Usage of the collection-type attribute on <reltable> and
<relcolspec> is currently undefined, and reserved for future use.
| sequence | choice | family | -dita-use-conref-target)
| #IMPLIED
| 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.
| #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
|
| 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
|
| spectitle
| The specialized title attribute allows architects of specialized
types to define a fixed or default title for a specialized element. Not intended
for direct use by authors.
| 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: Related links elements
Previous topic: link
Next topic: linkpool
|
|
