<topicmeta>

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

Usage information

The metadata specified 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, when the parent <topicref> element results in a link, elements within the <topicmeta> element can be used to provide context-specific information about the link, such as link text, a short description, or a navigation title.

Content model

<keytext> ?, ( <titlealt> | <navtitle> | <searchtitle> | <linktitle> | <subtitle> | <titlehint> )*, <shortdesc> ?, <author> *, <source> ?, <publisher> ?, <copyright> *, <critdates> ?, <permissions> ?, <metadata> *, <audience> *, <category> *, <keywords> *, <prodinfo> *, <othermeta> *, <resourceid> *, <ux-window> *, ( <data> | <foreign> )*

In order
  1. Optional <keytext>
  2. Zero or more
  3. Optional <shortdesc>
  4. Zero or more <author>
  5. Optional <source>
  6. Optional <publisher>
  7. Zero or more <copyright>
  8. Optional <critdates>
  9. Optional <permissions>
  10. Zero or more <metadata>
  11. Zero or more <audience>
  12. Zero or more <category>
  13. Zero or more <keywords>
  14. Zero or more <prodinfo>
  15. Zero or more <othermeta>
  16. Zero or more <resourceid>
  17. Zero or more <ux-window>
  18. Zero or more

Attributes

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

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

Example

This section is non-normative.

The following code sample shows how the <topicmeta> element can contain a link title and short description:

<map>
  <title>Indexing elements</title>        
  <topicref href="indexing.dita">
    <topicmeta>
      <linktitle>Indexing for company specialists</linktitle>
      <shortdesc>Guidelines for indexing company materials</shortdesc>
    </topicmeta>
    <!-- Additional topic references -->
  </topicref>
</map>

When link previews for indexing.dita are generated, the link title and short description provided within the <topicmeta> element are used.