<metadata>

The <metadata> section of the <prolog> contains information about a topic such as audience and product information. Metadata can be used by computational processes to select particular topics or to prepare search indexes or to customize navigation. Elements inside of <metadata> provide information about the content and subject of a topic; <prolog> elements outside of <metadata> provide lifecycle information for the content unit (such as the author or copyright), which are unrelated to the subject.

Beginning with DITA 1.2, the <metadata> element is available inside <topicmeta> in maps, although the contents of <metadata> are still available directly inside <topicmeta>. As with the <prolog>, the <metadata> element within <topicmeta> allows you to group elements that describe the content or subject of the target. The primary purpose for enabling the <metadata> element within maps is to allow easier reuse between topics and maps.

Content models

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

Inheritance

- topic/metadata

Example

This section is non-normative.

Metadata within a topic:

<prolog>
  <metadata>
    <audience type="user" job="using" experiencelevel="novice"/>
  </metadata>
</prolog>

Metadata within a map:

<topicref href="metadata.dita" navtitle="metadata element">
  <topicmeta>
    <metadata>
      <keywords>
        <indexterm>metadata element</indexterm>
      </keywords>
    </metadata>
  </topicmeta>
</topicref>

Content model

<audience>*, <category>*, <keywords>*, <prodinfo>*, <othermeta>*, (<data> | <data-about> | <foreign> | <unknown>)*

Contained by

<prolog>

In order
  1. Zero or more <audience>
  2. Zero or more <category>
  3. Zero or more <keywords>
  4. Zero or more <prodinfo>
  5. Zero or more <othermeta>
  6. Zero or more of the following
    • <data>
    • <data-about>
    • <foreign>
    • <unknown>

Contained by

  • <prolog>

Inheritance

- topic/metadata

The <metadata> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: Universal attribute group and mapkeyref.