The <toc> element indicates to the processing software that the author wants a table of contents generated at the particular location. If no href attribute is specified on the <toc> element, an external processor may generate table of contents at this location. If the href attribute references a topic or map, that topic or map should contain a manually created table of contents.
| Doctype | Content model |
|---|---|
| bookmap, learningBookmap | no content |
| 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 | Points to a manual listing for the current element. See The href attribute for detailed information on supported values and processing implications. If no href is specified, processors may choose to generate an appropriate listing for this element. All of the book listings operate in a similar manner; for example, <toc href="toc.dita"/> points to a topic which contains a manual table of contents, while <toc/> indicates that a processor should generate the table of contents. References to content other than DITA topics should use the format attribute to identify the kind of resource being referenced. | 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, keyref | Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. Class and outputclass are described in Other common DITA attributes |
Return to main page.
DITA v1.2 CD 03
Copyright © OASIS Open 2005, 2010. All Rights Reserved.