3.1.2.1.3 topicmeta

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

The metadata given 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 may be specified in each instance. For example, the two references to a single resource may specify different navigation titles or search titles, each of which is specific to a single context.

The topic Cascading of attributes and metadata in a DITA map in the DITA Architectural Specification provides more information about which metadata elements inside <topicmeta> cascade to other <topicref> elements. In addition, the topic Reconciling topic and map metadata provides more information about how metadata specified in the map interacts with metadata specified in each topic.

Contains

Doctype

Content model

map, classifyMap

( (navtitle) (optional) then (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 (metadata) (any number) then (audience) (any number) then (category) (any number) then (keywords or exportanchors) (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

( (navtitle) (optional) then (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 (metadata) (any number) then (audience) (any number) then (category) (any number) then (keywords or exportanchors) (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) )

subjectScheme

( (navtitle) (optional) then (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 (metadata) (any number) 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) )

learningBookmap

( (navtitle) (optional) then (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 (metadata or lcLom) (any number) then (audience) (any number) then (category) (any number) then (keywords or exportanchors) (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) )

learningMap

( (navtitle) (optional) then (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 (metadata or lcLom) (any number) then (audience) (any number) then (category) (any number) then (keywords or exportanchors) (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

Content model

map (base)

map, topicref, reltable, relcolspec, topichead, topicgroup, anchorref, mapref, topicset, topicsetref, keydef

map (technical content)

map, topicref, reltable, relcolspec, topichead, topicgroup, anchorref, mapref, topicset, topicsetref, keydef, glossref

bookmap

map, topicref, reltable, relcolspec, draftintro, preface, chapter, part, appendix, appendices, notices, glossarylist, topichead, topicgroup, anchorref, mapref, topicset, topicsetref, keydef

classifyMap

map, topicref, reltable, relcolspec, topichead, topicgroup, anchorref, mapref, topicset, topicsetref, keydef, topicsubject, topicapply, subjectref, topicSubjectTable

subjectScheme

map, topicref, reltable, relcolspec, subjectScheme, schemeref, hasNarrower, hasKind, hasPart, hasInstance, hasRelated, subjectdef, subjectRelTable, topichead, topicgroup, anchorref, mapref, topicset, topicsetref, keydef

learningBookmap

map, topicref, reltable, relcolspec, draftintro, preface, chapter, part, appendix, appendices, notices, glossarylist, topichead, topicgroup, anchorref, mapref, topicset, topicsetref, keydef, learningGroup, learningObject, learningPlanRef, learningOverviewRef, learningSummaryRef, learningContentRef, learningContentComponentRef, learningPreAssessmentRef, learningPostAssessmentRef

learningMap

map, topicref, reltable, relcolspec, topichead, topicgroup, anchorref, mapref, topicset, topicsetref, keydef, learningGroup, learningObject, learningPlanRef, learningOverviewRef, learningSummaryRef, learningContentRef, learningContentComponentRef, learningPreAssessmentRef, learningPostAssessmentRef

Inheritance

- map/topicmeta

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>
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. If the value is yes, the information inside <topicmeta> should not be replaced with information from the topic.

(yes | no | -dita-use-​conref-​target)

#IMPLIED

No

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class

A common attribute described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.1.2.1.2 topicref

Next Topic:  3.1.2.1.4 anchor

Parent Topic:  3.1.2.1 Basic map elements

Sibling Topics:

3.1.2.1.1 map

3.1.2.1.2 topicref

3.1.2.1.4 anchor

3.1.2.1.5 navref

3.1.2.1.6 reltable

3.1.2.1.7 relrow

3.1.2.1.8 relcell

3.1.2.1.9 relheader

3.1.2.1.10 relcolspec