Home
DITA map files
Topic hierarchy
In DITA, the sequence and hierarchy of the topics to be published are defined in the ditamap through nested topicref elements.
Excluding topics from the output TOC
When generating an output which includes a TOC, you may want to generate a topic from your ditamap but not have it appear in the output TOC. This is achieved through the toc and linking attributes of the topicref.

Introduction
Information types and topics
Topics are the building blocks of modular documents, and organising topics by semantic information types is one of the architectural features of DITA.
DITA map files
- Purpose of ditamap files
  DITA map files are used for defining the topics of a publication, specifying the topic sequence, and controlling linking between topics.
- Topic manifest
  Any topics referenced anywhere in the ditamap will be processed into the output publication.
- Topic hierarchy
  In DITA, the sequence and hierarchy of the topics to be published are defined in the ditamap through nested topicref elements.
  - Designing a topic hierarchy
    A well-designed topic hierarchy will make the reader's task of finding information in a publication easier.
  - Heading levels and ditamaps
    The topic hierarchy in the ditamap is used to generate heading levels and styles in page layout outputs.
  - Controlling the top node (default topic)
    DITA publishing tools sometimes process the hierarchy of a ditamap slightly differently for different target output formats. A workaround can be used to achieve greater consistency between different outputs to avoid confusing readers.
  - Excluding topics from the output TOC
    When generating an output which includes a TOC, you may want to generate a topic from your ditamap but not have it appear in the output TOC. This is achieved through the toc and linking attributes of the topicref.
  - Creating a Glossary of Terms
    A Glossary of Terms is defined in a ditamap using either standard topicref elements to glossary entry topics, or using glossref elements (introduced in DITA 1.2).
- Relationship tables
  Relationship tables are used to store linking relationships between topics in a collection in the ditamap, rather than in individual topics. Linking relationships are defined in a table-like structure, with rows in the table determining which topics are linked to which.
- Linking relationships
  DITA encourages the linking relationships to be stored outside the topic content. Links can be generated from topic hierarchies, relationship tables, and related-links section links.
- Inheritance and cascades in ditamaps
  Properties in ditamaps sometimes cascade from parent elements to child elements. Some values in ditamaps also override the equivalent values in referenced topics.
- Embedded (or nested) ditamaps
  The technique of using embedded, or nested, ditamaps can make it easier to manage documents by separating complex collections of topics into a number of smaller, simpler collections.
- DITA map vocabulary
- The bookmap feature
  Bookmaps are a specialisation of the base DITA map information type. Like ditamaps, bookmaps are containers for structure and context metadata, and do not contain any content. Bookmaps are used to describe page layout publishing outputs such as books, articles, manuals and research papers. They contain information structures that are specific to linear publications, such as tables of figures, title pages, chapters, sections and parts.
Syntax and mark-up
Language and punctuation
Graphics and figures
Cross-referencing
Cross-references are a means of binding individual topics into a coherent and navigable document.
Content re-use
Metadata, conditional processing, and indexing
The DITA documentation process
DITA authoring concepts
Moving from style-based authoring to a structured authoring methodology such as DITA requires a radically different approach to writing.

Excluding topics from the output TOC

When generating an output which includes a TOC, you may want to generate a topic from your ditamap but not have it appear in the output TOC. This is achieved through the toc and linking attributes of the topicref.

By default, every topic referenced in the ditamap will be included in the output, regardless of whether it is referenced in the hierarchy section of the map or the reltable section of the map.

There will be cases where a topic in your collection should not appear in the output TOC. An example may be where you have a topic containing an example, which you will reference from a concept topic. You may arrange the topic hierarchy so that the example topic is a child of the concept topic. You want a link to be automatically generated from parent to child, based on the hierarchy, but you don't want the example topic to appear as the sole child of the concept topic in the TOC.

To exclude the topic from the output TOC, you must set the relevant topicref element's toc attribute to no.

An example of the mark-up is:

<topicref
  format="dita"
  href="Reference/FeatureComparisonTable.dita"
  navtitle="Features in different versions of World Time Pro"
  scope="local"
  type="reference"
  linking="yes"
  toc="no" />

If you do not want the parent-child link to automatically generate (because you want to link manually, or through a reltable relationship), you must set the hierarchy topicref element's linking attribute to none.

Note:

If you want to entirely exclude a topic included in a ditamap from the output, you should delete from the ditamap all topicref elements linking to that topic, including any in the relationship table. If you are using conditional publishing, you can set the filtering metadata attributes (such as <topicref audience="administrator"... />) on all topicref elements linking to the topic to be filtered during the publishing process.