The <topicref> element identifies a topic (such as a concept, task, or reference) or other resource. A <topicref> can contain other <topicref> elements, allowing you to express navigation or table-of-contents hierarchies, as well as implying relationships between a containing (parent) <topicref> and its children. You can set the collection-type of a parent <topicref> to determine how its children are related to each other. You can also express relationships among <topicref> elements by using group and table structures (<topicgroup> and <reltable>). Relationships are expressed as links in the output; by default, each participant in a relationship has links to the other participants in that relationship.
You can fine tune the output from your map by setting different attributes on the <topicref> element. For example, the linking attribute controls how a topic's relationships to other topics are expressed as links, and the toc attribute controls whether the topic shows up in TOC or navigation output.
| Doctype | Content model |
|---|---|
| map (base), bookmap | ( (topicmeta) (optional) then (anchor or data or data-about or navref or topicref or anchorref or keydef or mapref or topicgroup or topichead or topicset or topicsetref) (any number) ) |
| map (technical content) | ( (topicmeta) (optional) then (anchor or data or data-about or navref or topicref or (anchorref or keydef or mapref or topicgroup or topichead or topicset or topicsetref) or (glossref) ) (any number) ) |
| classifyMap | ( (topicmeta) (optional) then (anchor or data or data-about or navref or topicref or (topicsubject or topicapply) or (anchorref or keydef or mapref or topicgroup or topichead or topicset or topicsetref) ) (any number) ) |
| subjectScheme | ( (topicmeta) (optional) then (anchor or data or data-about or navref or topicref or (anchorref or keydef or mapref or topicgroup or topichead or topicset or topicsetref) ) (any number) ) |
| learningBookmap, learningMap | ( (topicmeta) (optional) then (anchor or data or data-about or navref or topicref or anchorref or keydef or mapref or topicgroup or topichead or topicset or topicsetref or learningObject or learningGroup) (any number) ) |
| Doctype | Content model |
|---|---|
| map (base), map (technical content), learningMap | map, topicref, relcolspec, relcell, topichead, topicgroup, anchorref, topicset, topicsetref, keydef |
| bookmap, learningBookmap | map, topicref, relcolspec, relcell, frontmatter, backmatter, draftintro, preface, chapter, part, appendix, notices, glossarylist, topichead, topicgroup, anchorref, topicset, topicsetref, keydef |
| classifyMap | map, topicref, relcolspec, relcell, topichead, topicgroup, anchorref, topicset, topicsetref, keydef, topicsubject, topicapply, topicCell, subjectCell |
| subjectScheme | map, topicref, relcolspec, relcell, subjectScheme, hasNarrower, hasKind, hasPart, hasInstance, hasRelated, subjectdef, subjectHead, relatedSubjects, subjectRole, topichead, topicgroup, anchorref, topicset, topicsetref, keydef |
<map title="Bats"> <topicref href="bats.dita" type="topic"> <topicref href="batcaring.dita" type="task"></topicref> <topicref href="batfeeding.dita" type="task"></topicref> <topicref href="batsonar.dita" type="concept"></topicref> <topicref href="batguano.dita" type="reference"></topicref> <topicref href="bathistory.dita" type="reference"></topicref> </topicref> </map>
| Name | Description | Data Type | Default Value | Required? |
|---|---|---|---|---|
| navtitle | Specifies the title of the topic as it will appear in the navigation or tables of contents that are generated from the map. Beginning with DITA 1.2, the preferred way to specify the navigation title in a map is with the navtitle element, available inside the topicmeta element. | CDATA | #IMPLIED | No |
| href | A pointer to the resource represented by the <topicref>. See The href attribute for detailed information on supported values and processing implications. References to DITA content cannot be below the topic level: that is, you cannot reference individual elements inside a topic. References to content other than DITA topics should use the format attribute to identify the kind of resource being referenced. | CDATA | #IMPLIED | No |
| keys | Introduces one or more global identifiers for a resource referenced from a map. See The keys attribute for details on how to use the keys attribute. | NMTOKEN | #IMPLIED | No |
| keyref | Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. | CDATA | #IMPLIED | No |
| query | This attribute is deprecated. It may be removed in the future. | CDATA | #IMPLIED | No |
| copy-to | Use the copy-to attribute on the
<topicref> element to provide a different file name
for a particular instance of the topic in the map (for example, to separate out
the different versions of the topic, rather than combining them on output). The
links and navigation associated with that instance will point to a copy of the
topic with the file name you specified.
Use the <linktext> and <shortdesc> in the <topicref>'s <topicmeta> to provide a unique name and short description for the new copy. |
CDATA | #IMPLIED | No |
| topicref-atts attribute group (collection-type, processing-role, type, scope, locktitle, format, linking, toc, print, search, chunk) | A set of related attributes. See topicref-atts, topicref-atts-no-toc, and topicref-atts-without-format attribute groups. | |||
| 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 | |||
| class, outputclass | Common attributes described in Other common DITA attributes |
Return to main page.
OASIS DITA Version 1.2 -- OASIS Standard, 1 December 2010
Copyright © OASIS Open 2005, 2010. All Rights Reserved.