Add keydef example

This topic shows an example of unresolved keyrefs and how the system would deal with them.

The image below shows the Add All Undefined Keys dialog when the system has found four unresolved keyrefs.
Figure 1. The Add All Undefined Keys dialog
Keyref dialog

The left-hand panel (Keyref Target Found) shows that there are two keyrefs that could be resolved by topics in the Content Store i.e., the keyref attribute value corresponds to an existing topic's file name. You can see the topic titles displayed there.

The right-hand panel (Unresolved Keyrefs) shows two keyrefs that will need to be resolved manually.

When you click OK, the system will write <keydef> elements into the map file to define the missing keys. You can see how these example statements will appear in the DITA Map view, in the image shown below.

Figure 2. Keydef statements in the DITA Map view
Keyref dialog
This image shows how the keydef elements display in the DITA map view. The entries from the Keyref Target Found panel display with black icons. These entries have been automatically resolved.

The entries that were in the Unresolved Keyref panel display with red icons. These keydef statements will need to be manually resolved. See Edit keydef actions.

The code block below shows the underlying XML.
<keydef href="mal1311976516135.xml" keys="mal1311976516135"/>
<keydef href="mal1234494279734.xml" keys="mal1234494279734"/>
<keydef   keys="mal6666666666666"/>
<keydef keys="foo" />