Edit online

Selecting a Root Map

Oxygen XML Author Eclipse plugin allows you to select a root map (a main DITA map) that defines a hierarchical structure of submaps and establishes a key space that defines the keys used in all the other DITA maps and topics in the project. Specifying the correct root map helps to prevent validation problems when you work with keyrefs and also acts as the foundation for content completion. All the keys that are defined in a root map are available in the submaps that are contained within the root map.

There are several ways to select or change the root map:
  • The easiest method is to use the Context drop-down menu on the DITA Maps Manager toolbar to select the appropriate context root map that Oxygen XML Author Eclipse plugin uses to define a hierarchical structure of submaps and to establish a key space that defines the keys that are propagated throughout the entire map structure.
  • You can use the Choose context root map drop-down on the DITA Maps Manager toolbar to browse or search for root maps with the following choices:
    • Browse for local file - Opens a local file browser dialog box, allowing you to select a local root map.
    • Browse workspace - Allows you to select a root map from the local workspace.
    • Browse for remote file - Displays the Open using FTP/SFTP dialog box that allows you to select a remotely stored root map.
    • Browse for archived file - Displays the Archive Browser that allows you to browse the content of an archive and choose a root map.
    • Browse Data Source Explorer - Opens the Data Source Explorer that allows you to browse the data sources defined in the Data Sources preferences page.
      Tip: You can open the Data Sources preferences page by using the Configure Database Sources shortcut from the Open URL dialog box.
    • Search for file - Displays the Find Resource dialog box to search for a root map.
    • Choose context from main files - Allows you to choose a context root map from the DITA maps and the DITA-OT project files that are set in the Main Files folder.
  • If you insert a key reference using the Cross Reference action from the Link drop-down menu (from the toolbar or Link submenu of the contextual menu) and keys are not gathered from the expected DITA map, you can change the root map by using the Change Root Map link in the Choose Key dialog box that is opened when you click the Choose Key Reference button.
  • If you insert a content key reference or key reference using the Reuse Content action (from the toolbar, DITA menu, or Reuse submenu of the contextual menu) and keys are not gathered from the expected DITA map, you can change the root map by using the Change Root Map link in the Choose Key dialog box that is opened when you click the Choose Key Reference button.