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.

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 which 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"></topciref>
 </topicref>
</map>

Contains

Doctype Content model
map ( ( 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) then ( data or data-about or foreign or unknown) (any number) )
bookmap ( ( linktext) (optional) then ( searchtitle) (optional) then ( shortdesc) (optional) then ( author or authorinformation) (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) then ( data or data-about or foreign or unknown) (any number) )

Contained by

Doctype Parents
bookmap map, topicref, reltable, relcolspec, draftintro, preface, chapter, part, appendix, notices, glossarylist, topichead, topicgroup
map map, topicref, reltable, relcolspec, topichead, topicgroup

Inheritance:

- map/topicmeta

Attributes

Name Description Data Type Default Value Required?
lockmeta Indicates whether any of the meta information should be replaced by meta information in the referenced topic. (yes | no | -dita-use-conref-target) #IMPLIED No
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class Common attribute described in Other common DITA attributes.      

Return to main page.

OASIS DITA Language Specification v1.1 -- Committee Draft 02, 8 May 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.