2.1.2.3.6 Reconciling topic and map metadata
The <topicmeta> element in maps contains numerous
elements that can be used to declare metadata. These metadata elements
have an effect on the parent <topicref> element, any child <topicref>
elements, and – if a direct child of the <map> element –
on the map as a whole.
For each element that can be contained in the <topicmeta>
element, the following table addresses the following questions:
How does it apply to the topic?
This column describes how the metadata specified within
the <topicmeta> element interacts with the metadata specified in
the topic. In most cases, the properties are additive. For example, when
the <audience> element is set to "user" at the map level, the value
"user" is added during processing to any audience metadata that is specified
within the topic.
Does it cascade to other topics in the map?
This column indicates whether the specified metadata
value cascades to nested <topicref> elements. For example, when
an <audience> element is set to "user" at the map level, all child
<topicref> elements implicitly have an <audience> element
set to "user" also. Elements which can apply only to the specific <topicref>
element, such as <linktext>, do not cascade.
What is the purpose when specified on the <map>
element?
The map element allows metadata to be specified for
the entire map. This column describes what effect, if any, an element
has when specified at this level.
Table 2-2 Topicmeta elements
and their properties
<audience>
|
Add to the topic
|
Yes
|
Specify an audience for the entire map
|
<author>
|
Add to the topic
|
Yes
|
Specify an author for the entire map
|
<category>
|
Add to the topic
|
Yes
|
Specify a category for the entire map
|
<copyright>
|
Add to the topic
|
Yes
|
Specify a copyright for the entire map
|
<critdates>
|
Add to the topic
|
Yes
|
Specify critical dates for the entire map
|
<data>
|
Add to the topic
|
No, unless specialized for a purpose that cascades
|
No stated purpose, until the element is specified
|
<data-about>
|
Add the property to the specified target
|
No, unless specialized for a purpose that cascades
|
No stated purpose, until the element is specified
|
<foreign>
|
Add to the topic
|
No, unless specialized for a purpose that cascades
|
No stated purpose, until the element is specified
|
<keywords>
|
Add to the topic
|
No
|
No stated purpose
|
<linktext>
|
Not added to the topic; applies only to links created
based on this occurrence in the map
|
No
|
No stated purpose
|
<metadata>
|
Add to the topic
|
Yes
|
Specify metadata for the entire map
|
<navtitle>
|
Not added to the topic; applies only to navigation
that is created based on this occurrence in the map. The @locktitle attribute
of the parent <topicref> element must be set to "yes" in order
for the navigation title to be used.
|
No
|
No stated purpose
|
<othermeta>
|
Add to the topic
|
No
|
Define metadata for the entire map
|
<permissions>
|
Add to the topic
|
Yes
|
Specify permissions for the entire map
|
<prodinfo>
|
Add to the topic
|
Yes
|
Specify product info for the entire map
|
<publisher>
|
Add to the topic
|
Yes
|
Specify a publisher for the map
|
<resourceid>
|
Add to the topic
|
No
|
Specify a resource ID for the map
|
<searchtitle>
|
Replace the one in the topic. If multiple <searchtitle>
elements are specified for a singletarget, processors may choose to issue
a warning.
|
No
|
No stated purpose
|
<shortdesc>
|
Only added to the topic when the <topicref>
element specifies a @copy-to attribute. Otherwise, it applies only to
links created based on this occurrence in the map.
Processors may or may not implement this behavior.
|
No
|
Provide a description of the map
|
<source>
|
Add to the topic
|
No
|
Specify a source for the map
|
<unknown>
|
Add to the topic
|
No, unless specialized for a purpose that cascades
|
No stated purpose, until the element is specified
|
Previous Topic: 2.1.2.3.5
Map-to-map cascading behaviors
Next Topic: 2.1.3
DITA processing
Parent Topic: 2.1.2.3
DITA metadata
Sibling Topics:
2.1.2.3.1
Metadata elements
2.1.2.3.2
Metadata attributes
2.1.2.3.3
Metadata in maps and topics
2.1.2.3.4
Cascading of attributes and metadata in a DITA map
2.1.2.3.5
Map-to-map cascading behaviors