topicgroup

The <topicgroup> element is for creating groups of <topicref> elements without affecting the hierarchy, as opposed to nested <topicref> elements within a <topicref>, which does imply a structural hierarchy. It is typically used outside a hierarchy to identify groups for linking without affecting the resulting toc/navigation output.

Contains

( (topicmeta) (optional) then (topicref or (topichead or topicgroup) or navref or anchor) (any number) )

Contained by

map, topicref, relcell, topichead, topicgroup

Inheritance

map/topicref, mapgroup-d/topicgroup

Attributes

Name	Description	Data Type	Default Value	Required?
id	This ID is the target for references by conref attributes, to allow build-time integration of maps.	ID	#IMPLIED	No
conref	References an equivalent element in the same map or another map, which will be copied into the current element's location when the conref is resolved. The syntax uses the target's file name and element ID; it does not require the map ID for scoping since there is only ever one map per target file: Local target: conref="#elementID" In different file: conref="othermap.ditamap#elementID"	CDATA	#IMPLIED	No
%topicref-atts; (collection-type, type, scope, locktitle, format, linking, toc, print, search, chunk)	A set of related attributes. See %topicref-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
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class	A common attribute described in Other common DITA attributes

Example

The following <topicgroup> adds a set of related links among the members of the family it defines using collection-type="family", but does not affect generated navigation files or tables of contents since the group is set to toc="no"

<map title="DITA Reference">
 <topicref href="anchor.dita" type="topic"></topicref>
 <topicref href="apiname.dita" type="topic"></topicref>
 <topicref href="audience.dita" type="topic"></topicref>
 <topicref href="author.dita" type="topic"></topicref>
 <topicgroup  collection-type="family" toc="no">
  <topicref href="global-atts.dita" type="topic"></topicref>
  <topicref href="select-atts.dita" type="topic"></topicref>
  <topicref href="univ-atts.dita" type="topic"></topicref>
  <topicref href="topicref-atts.dita" type="topic"></topicref>
 </topicgroup>
</map>