topicmeta

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

The topicmeta element defines the metadata that applies to a topic when it appears in a map. When appropriate, that metadata also applies to the other topics in the map that are contained by the same element that contains the topicmeta element. When creating links, topicmeta content can also be used to override the title and short description that are used for the link. In addition, it can be used to add index entries to referenced content using the keywords element.

The metadata given in a topicmeta element is specific to a given context within a map. If a reference to a single resource appears more than once in a map or set of maps, unique metadata can be specified in each instance. For example, the two references to a single resource might specify different navigation titles or search titles, each of which is specific to a single context.
Note: The topic Cascading of metadata attributes in a DITA map in the DITA Architectural Specification provides more information about which metadata elements inside topicmeta cascade to other topicref elements. In addition, the topic Reconciling topic and map metadata elements provides more information about how metadata specified in the map interacts with metadata specified in each topic.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

- map/topicmeta

Example

In this example, the metadata defined by the topicmeta element applies to the associated topicref (bats.dita) and all of its children. The topicmeta element contains an audience definition that indicates that bats.dita and its children are of interest to experienced programmers who are troubleshooting.

<map>
  <topicref href="bats.dita">
    <topicmeta>
      <audience type="programmer" job="troubleshooting" experiencelevel="expert"/>
    </topicmeta>
    <topicref href="batcaring.dita"></topicref>
    <topicref href="batfeeding.dita"></topicref>
  </topicref>
</map>

Attributes

The following attributes are available on this element: Universal attribute group and the attribute defined below.

lockmeta

By default, metadata in the map supplements or overrides metadata that is specified at the topic level, unless the lockmeta attribute of the topicmeta element is set to "no". Allowable values are "yes", "no", and Using the -dita-use-conref-target value.