Basic map elements
DITA maps are built from a few core elements that are used for referencing and organizing topics. The <topicmeta> element is also available to specify metadata for the map, for individual topics, or for groups of topics. Many elements inside <topicmeta> are also available inside the topic prolog.
In this section:
- <map>The <map> element describes the relationships among a set of resources, such as DITA topics. Maps consist of references to topics, maps, and other resources organized into hierarchies, groups, and tables. Maps express these relationships in a single common format that can be used for different outputs.
- <topicref>The <topicref> element identifies a topic (such as a concept, task, or reference) or other resource. A <topicref> can contain other <topicref> elements, allowing you to express navigation or table-of-contents hierarchies, as well as implying relationships between a containing (parent) <topicref> and its children. You can set the collection type of a parent <topicref> to determine how its children are related to each other. You can also express relationships among <topicref> elements by using group and table structures (such as <topicgroup> and <reltable>). Relationships are expressed as links in the output; by default, each participant in a relationship has links to the other participants in that relationship.
- <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.
- <anchor>The <anchor> element provides an integration point that another map can reference in order to insert its navigation into the referenced map's navigation tree. For those familiar with Eclipse help systems, this serves the same purpose as the <anchor> element in that system. It might not be supported for all output formats.
- <navref>The <navref> element represents a pointer to another map which is preserved as a transcluding link in the result deliverable rather than resolved when the deliverable is produced. Output formats that support such linking can integrate the referenced resource when displaying the referencing map to an end user.
- <reltable>The <reltable> element is a relationship table that specifies relationships among topics, based on the familiar table model of rows (<relrow>), columns (<relheader>), and cells (<relcell>).
- <relrow>The <relrow> element defines a row in the relationship table (<reltable>). It creates a relationship between the cells in the row, which is expressed in output as links between the topics or resources referenced in those cells.
- <relcell>The <relcell> element defines a cell in the relationship table (<reltable>). The <topicref> elements that it contains are related to the <topicref> elements in other cells of the same row. By default, topics or resources that are referenced in the same cell are not related to each other, unless you change the @collection-type attribute of the <relcell> to indicate that they are related.
- <relheader>The <relheader> element is a row in a relationship table that contains column definitions (<relcolspec> elements). Each table can have only one set of column definitions.
- <relcolspec>The <relcolspec> element is used to define a column in a relationship table. The <relcolspec> element can be used to set default attribute values for the <topicref> elements in the column.
- <ux-window>Use the <ux-window> element to provide specifications for a window or viewport in which a user assistance topic or Web page can be displayed. The window or viewport can be referenced by the <resourceid> element associated with a topic or <topicref> element.
Parent topic: Map elements