Topic metadata

Topic metadata is metadata that applies to a topic based on its context in a map.

Syntax

Authoring format Syntax and example
XDITA

<topicmeta>

<map>
  <topicmeta>
    <navtitle>Configuring the ACME Test Suite</navtitle>
    <data name="goal" value="configuring"/>
  </topicmeta>
  <!-- ... -->
</map
HDITA

There is no equivalent to <topicmeta>.
MDITA

There is no equivalent to <topicmeta>.

Usage information

The metadata specified in a topic metadata component 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, when the parent topic reference results in a link, components within the topic metadata component can be used to provide context-specific information about the link, such as link text or a navigation title.

Attributes

The following attributes are available on this element: localization attributes and universal attributes.

Example

This section is non-normative.

The following code sample shows how the <topicmeta> element can be used to both specify metadata for the entire map and for a specific topic

<map>
  <!-- 1. Applies a title and metadata to the entire map -->
  <topicmeta>
    <navtitle>Configuring the ACME Test Suite</navtitle>
    <data name="goal" value="configuring"/>
  </topicmeta>
  <topicref keyref="configuring-test-suite">
    <topicref keyref="setting-preferences"/>
    <topicref keyref="testing-parameters">
      <!-- 2. Applies metadata to the specific topic-->
      <topicmeta>
        <data name="parameters" value="test-suite-set"/>
      </topicmeta>
    </topicref>
    <topicref keyref="setting-options"/>
    <!-- … -->
  </topicref>
</map>

In the above code sample, a <topicmeta> element appears twice:

  1. Specifies a navigation title for the map and indicates that all topics in the map are about the user goal of "configuring".
  2. Specifies specific metadata for the topic defined by the key "test-suite-set".