DITA metadata
Metadata can be applied in both DITA topics and DITA maps. Metadata that is assigned
in
DITA topics can be supplemented or overridden by metadata that is assigned in a DITA
map; this
design facilitates the reuse of DITA topics in different DITA maps and use-specific
contexts.
In this section:
- Metadata elementsThe metadata elements, many of which map to Dublin core metadata, are available in topics and DITA maps. This design enables authors and information architects to use identical metadata markup in both topics and maps.
- Metadata attributesCertain attributes are common across most DITA elements. These attributes support content referencing, conditional processing, application of metadata, and globalization and localization.
- Metadata in maps and topicsTopic metadata can be specified in a DITA map as well as in the topics that the map references. By default, metadata in the map supplements or overrides metadata that is specified at the topic level, unless the @lockmeta attribute of the <topicmeta> element is set to "no".
- Cascading of metadata attributes in a DITA mapCertain map-level attributes cascade throughout a map, which facilitates attribute and metadata management. When attributes cascade, they apply to the elements that are children of the element where the attributes were specified. Cascading applies to a containment hierarchy, as opposed to a element-type hierarchy.
- Reconciling topic and map metadata elementsThe <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.
- Map-to-map cascading behaviorsWhen a DITA map (or branch of a DITA map) is referenced by another DITA map, by default, certain rules apply. These rules pertain to the cascading behaviors of attributes, metadata elements, and roles assigned to content (for example, the role of "Chapter" assigned by a <chapter> element). Attributes and elements that cascade within a map generally follow the same rules when cascading from one map to another map, but there are some exceptions and additional rules that apply.
- Context hooks and window metadata for user assistanceContext hook information specified in the <resourceid> element in the DITA map or in a DITA topic enables processors to generate the header, map, alias and other types of support files that are required to integrate the user assistance with the application. Some user assistance topics might need to be displayed in a specific window or viewport, and this windowing metadata can be defined in the DITA map within the <ux-window> element.
Parent topic: DITA markup