Understand how you can insert topicref elements in a DITA map with Adobe FrameMaker.
You can add topics to a DITA map by using the <topicref> elements
in the Elements catalog. You can also add topics
using Insert Child in the Resource
Manager.
FrameMaker supports the following <topicref> elements
that you can insert in a DITA map:
- topicref
Identifies topics such as dita, topic, concept, task, reference, glossentry, and glossgroup. A topicref element can also contain other topicref elements to create a hierarchical structure.
See the DITA specifications on the topicref element.
- mapref
A convenience element that is equivalent to a
<topicref>element with the format attribute set to “ditamap”.See the DITA specifications on the mapref element.
- topicset
A set of
<topicref>elements that can be reused in DITA maps and other topicset elements.See the DITA specifications on the topicset element.
- keydef
A convenience element that is used to define keys without any of the other effects that occur when using a
<topicref>element: no content is included in output, no title is included in the table of contents, and no linking or other relationships are defined.See the DITA specifications on the keydef element.
- topicsetref
References a
<topicset>element.See the DITA specifications on the topicsetref element.
To insert a <topicref> element in a DITA map:
In the Structure View, place the insertion point after the book title and metadata elements of the
<bookmap>element.Choose .
If you select topicref, mapref, topicset, or keydef, the Insert Element dialog appears:
Figure 1. Inserting elements in a DITA map using the Insert Element dialog
To use the inserted topicref as a key reference, enter a Key Name.
In the HRef box, enter the location of the topic to reference. Or click Browse to navigate and select the topic. The topic is added as a direct reference.
Alternatively, if you have defined a keyspace for the current topic, you can select a key reference in the KeyRef drop-down list. The topic is added as an indirect reference.