Additional features in the Map Editor id1942D0T0HUI
Some common features in the Map Editor are:
Resolve key references id176GD01H05Z
A DITA content key reference, or conkeyref is a mechanism for inserting a part of content from one topic into another. This mechanism uses key to locate the content to reuse rather than the direct content referencing mechanism. For more information about direct and indirect referencing in DITA, view DITA addressing in OASIS DITA Language Specification.
If the DITA topic has associated key references, then they need to be resolved before previewing, editing or reviewing a topic.
The key references are resolved on the basis of the root map set in the following order of priority:
- User Preferences
- Map View panel
- Folder Profile
The root map selected in the User Preferences takes the highest precedence to resolve key references followed by Map View panel and the Folder Profile root map. So, if no map is set in the User Preferences, then the map opened in the Map View panel is used. If no map is opened in the Map View panel then the map set in the Folder Profiles is used to resolve the key references.
The key references can be stored within a DITA map file or a separate DITA file. In Experience Manager Guides, you can specify key references either at the project level or a session level. If a root map is already defined for the user session, then it is used for resolving the keys. Else, the default root map for that folder is used. In case a default root map is not configured, then the missing key references are highlighted to the user.
There are several ways to resolve key references in a DITA topic by defining the DITA map to be used at the following locations:
Project properties - You can define a root map for resolving key references while creating a Project in the Project Properties section.
This root map will be applicable for all assets (folders and sub-folders) associated with that project. For content that is referenced in multiple projects, an alphabetical list of projects is maintained and the default root map associated with the first project is used. You can also choose the DITA map to be used from the list for resolving key references.
Topic preview - In the topic preview mode, select the Key Resolution icon in the toolbar and select the DITA file to be used for key references.
Topic edit view - Select the Key Resolution icon while editing a DITA topic and select the DITA file to use for resolving the key references.
Add navigation references
The navref element is used inside a DITA map to include navigation references from another DITA map. This allows authors to reuse navigation structure, such as shared menus or links, without merging the actual content of the referenced map into the output.
navref element is intended solely for navigation purposes within the map structure. It does not contribute to the generated DITA map output and is excluded from processing and display in the Map view, Reports, Baseline, Translation, and Preview.To add navigation references to a map, perform the followin steps:
-
Open the DITA map file where you want to add a navigation reference.
The map file opens in the Map Editor.
-
Switch to the Author view and place the cursor at a valid location for a navigation reference.
-
Select the Element option from the toolbar.
-
In the Insert element dialog, select navref.
-
The Select path dialog is displyed. Select a map file you want to include as navigation reference in your map, and choose Select.
A navigation reference of the selected map file is added at the specified location. Also, the title of referenced map is displayed in both Author view and Layout view.
Author view
Layout view
Parent topic:Introduction to the Map Editor