Can DITA outputs include dynamic tables of contents (TOCs)?

DITA outputs can include dynamic tables of contents (TOCs) to help users navigate the content efficiently.

Dynamic tables of contents in DITA outputs are interactive navigation tools that allow users to explore the structure of a document, view the hierarchy of topics, and jump to specific sections of the content.

It is important to note that DITA content is not inherently interactive. Any interactive capabilities are provided post-publication by DITA publishing tools or other forms of content integration.

These dynamic TOCs involve automated generation, interactive navigation, real-time updates, and multi-level hierarchy.

Automated Generation:

DITA publishing tools automatically generate dynamic TOCs based on the structure of the DITA content. These TOCs reflect the hierarchy of topics, including sections, chapters, and subtopics, making it easier for users to grasp the document’s organization.

Interactive Navigation:

Dynamic TOCs are interactive. Users can click on TOC entries to navigate directly to the corresponding section of the document. This functionality enhances the user experience by providing quick access to specific content areas.

Real-Time Updates:

One of the key advantages of dynamic TOCs is that they update in real time. If content changes, such as new topics added or topics reordered, the TOC reflects these changes immediately. This ensures that the TOC always matches the current document structure.

Multi-Level Hierarchy:

Dynamic TOCs typically display content hierarchies with expandable and collapsible sections. Users can expand chapters or topics to see subtopics or collapse them for a cleaner view.

Example:

A DITA-based user manual for a software application incorporates a dynamic table of contents.


        <h3>Table of Contents</h3>

        <ol>
            <li>
                1. Introduction
                <ol>
                    <li>1.1. About the Software</li>
                    <li>1.2. Getting Started</li>
                </ol>
            </li>
            <li>
                2. User Guide
                <ol>
                    <li>2.1. Navigating the Interface</li>
                    <li>2.2. Creating New Documents</li>
                </ol>
            </li>
            <li>
                3. Advanced Features
                <ol>
                    <li>3.1. Data Analysis Tools</li>
                    <li>3.2. Customization Options
                        <ol>
                            <li>3.2.1. User Preferences</li>
                            <li>3.2.2. Advanced Settings</li>
                        </ol>
                    </li>
                </ol>
            </li>
            <li>
                4. Troubleshooting
                <ol>
                    <li>4.1. Common Issues</li>
                    <li>4.2. Contacting Support</li>
                </ol>
            </li>
        </ol>
    

In this example, users can interact with the dynamic TOC. For example, if they click on “Advanced Features,” the subtopics “Data Analysis Tools” and “Customization Options” will expand, revealing further content. If the document’s structure changes, such as adding a new section or reordering topics, the dynamic TOC will update to reflect these changes automatically.