Create a cross-reference

To create a cross-reference from one DITA topic in another topic or map, you first need to Set up reference content in the target topics or maps.

Next, you create a direct or indirect cross-reference to the target DITA content.

1)Place the insertion point at the location to insert the cross-reference in a topic or map.

A cross-reference is an inline DITA element. This implies that you need to insert the element inline with an existing element. You can insert a cross-reference in elements such as the para­graph (p) or list item (li).

2)From the Elements catalog, choose the xref element.

The DITA Cross-Reference dialog is displayed.

3)You can choose to add a cross-reference as a direct or indirect reference to the target content. For details, see DITA referencing.

To create a direct reference to the target content:

a)Check Refer to File.

b)In the drop-down list, choose from the available DITA topics that contain cross-refer­ence elements.

If the topic is not available in the list, browse for the topic.

note:    To open the selected topic in the drop-down list, click Edit.

c)After you select the DITA topic, the Element Tag list displays the elements to which unique identifiers are assigned.

If an element is not assigned a unique ID, you can Assign a unique ID to an element. Alternatively, check Show All to display all elements of the element type.

d)Select an element to insert as a cross-reference in the current doc.

The elements in the DITA topic of the selected element type that are assigned a unique identifier are displayed in the Element Data list.

The list also displays the ID and the contents (in the case of text elements) of the elements.

e)Select the cross-reference element.

If you make changes to a cross-reference element in the source topic, you will need to save the source topic and update the container topic to view the updates.

To create an indirect reference to the target content:

a)Check Refer to Key and click Edit.

b)In the Key References dialog, select the required key from the Key drop-down list.

For details on how to add key references, see Using keyspaces to manage DITA key refer­ences.

After you select the key, the Element Tags list displays the DITA topic types included in the keyspace. You can read more on how to Create a keyspace.

c)Select an element tag.

The elements in the DITA topic of the selected element type that are assigned a unique identifier are displayed in the Element Data list. If an element is not assigned a unique ID, you can Assign a unique ID to an element or check Show All to display all elements of the element type.

d)Select an element to insert as a cross-reference and click OK.

4)Choose the link element to use.

5)Choose the element to display the link text.

6)In the Display Using section, specify the text or format to display in the link.

7)Click Insert.


September 30, 2016

Legal Notices | Online Privacy Policy