topicmeta

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

Contains

( (linktext) (optional) then (searchtitle) (optional) then (shortdesc) (optional) then (author) (any number) then (source) (optional) then (publisher) (optional) then (copyright) (any number) then (critdates) (optional) then (permissions) (optional) then (audience) (any number) then (category) (any number) then (keywords) (any number) then (prodinfo) (any number) then (othermeta) (any number) then (resourceid) (any number) )

Contained by

map, topicref, reltable, relcolspec, topichead, topicgroup

Inheritance

map/topicmeta

Attributes

Name Description Data Type Default Value Required?
lockmeta Currently unsupported. Defaults to "yes". (yes | no) #IMPLIED No
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class A common attribute described in Other common DITA attributes

Example

In this example, the metadata defined by the metadata element applies to the associated <topicref> (bats.xml) and all of its children. The <topicmeta> element contains an audience definition which indicates that bats.xml 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"></topciref>
 </topicref>
</map>

OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.