Under maintenance

Heretto Help

Title Element (title)

The title element is essential for identifying the subject of a topic, map, or other structural elements. It acts as a descriptive heading that provides the primary label for topics and their subdivisions as well as navigation and search results.

The title element serves these primary purposes:

  • Identifies topics, sections, figures, tables, and other content components

  • Creates navigation labels in topic maps, TOCs, and content collections

  • Appears in search results as the primary content identifier

Key characteristics of the title element:

  • The first required element within every DITA topic (concept, task, reference, and so on)

  • Available and optional in elements like section, example, figure, table

  • Provides the text used in navigation structures and tables of contents

  • When used in topics, typically appears as the main heading of the rendered content

  • When used in maps, controls how the topic appears in navigation

  • While the title attribute exists on the map element, the title element within the map is the preferred way to title a map beginning with DITA 1.1

  • When an element containing a title is linked, its title becomes the default link text

Content within the title element generally follows these output formatting rules:

  • Topic titles typically render as H1 headings in output formats

  • The content of the title element is often used by processors as the base sort phrase for sorting elements, especially for topics

  • Section titles usually appear as subheadings (H2, H3, an so on)

  • Map titles may may be ignored in specific publishing contexts

  • Specialized titles (like navtitle in topicmeta of topicref) override the default title in specific contexts

  • Translation and reuse considerations apply to title content

Use title to:

  • Create a consistent identity for every DITA topic in your documentation

  • Establish logical divisions within content through section titles

  • Provide identifying labels for tables, figures, and examples

The title element used in a concept topic with nested section titles in the Heretto CCMS Content Editor.

Layer 1

The DITA source of the title element used in a concept topic with nested section titles and the surrounding context of a concept:

<concept id="coffee-brewing-methods" xml:lang="en-us">
    <shortdesc>Coffee brewing methods control extraction variables to produce beverages with distinct flavor clarity, body, and strength based on their fundamental preparation principles.</shortdesc>
    <prolog>
        <author translate="no" type="creator">Heretto User &lt;user@heretto.com&gt;</author>
    </prolog>
    <conbody>
        <section>
            <title>Immersion Methods</title>
            <p>Immersion brewing submerges coffee grounds directly in water, enabling full extraction over time. Popular immersion methods include French press, cold brew, and AeroPress, each producing coffee with different body characteristics and flavor profiles. This brewing approach typically results in a fuller body and richer mouthfeel as more oils remain in the final cup.</p>
        </section>
        <section>
            <title>Percolation Methods</title>
            <p>Percolation methods pass water through coffee grounds, typically using gravity or pressure. These methods include pour-over devices, automatic drip machines, and espresso, with each offering different levels of control over brewing variables. Percolation brewing often highlights clarity and brightness in coffee, as paper filters trap oils and fine particles.</p>
        </section>
    </conbody>
</concept>