The <topicgroup> element groups <topicref>
elements for common treatment without affecting the structural hierarchy
of the map, as opposed to nesting <topicref>
elements, which does imply a structural hierarchy. The <topicgroup>
element can provide linking relationships and shared, inherited attributes
to the set of elements that it contains without affecting the resulting
table of contents or navigation.
Beginning with DITA 1.2, you are able to specify
a <navtitle> element within the <topicmeta> element inside of
a <topicgroup>. The <topicgroup> element is meant as a non-titled
grouping element, so adding a <navtitle> element to the <topicgroup>
element has no defined purpose, and processors must ignore the title.
Processors may (but need not) issue a message when ignoring the title.
Contains
Note: These models represent only the default document types distributed by OASIS.
Actual content models will differ with each new document type.
Contained by
| 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 |
Inheritance
+
map/topicref mapgroup-d/topicgroup
Example
Each <topicref>
element in the following example inherits the audience and linking
attributes. In this way the common attributes are set for the entire
group of <topicref> elements without affecting the navigation hierarchy.
<topicgroup audience="novice" linking="none">
<topicref href="this.dita"/>
<topicref href="that.dita"/>
<topicref href="theother.dita"/>
</topicgroup>
Attributes
| Name |
Description |
Data Type |
Default Value |
Required? |
| 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 |
|
|
|