DITA Maps Manager

Oxygen XML Editor provides a view for managing and editing DITA Maps. The DITA Maps Manager view presents a DITA map as a table-of-contents. It allows you to navigate to the topics and maps, make changes, and apply transformation scenarios to obtain various output formats.

Figure: The DITA Maps Manager View

The DITA Maps Manager view supports multiple open maps at the same time.

When your open a file with the extension.ditamap or .bookmap, Oxygen XML Editor offers you the choice of opening it in the XML editor or in the DITA Maps Manager. In addition, you can right click a map file in the Project view and select Open with. If you have a ditamap file open in the XML editor, you can open it in the DITA Maps Manager by right-clicking on the title tab and selecting the Open in DITA Maps Manager.

If your map references other DITA Maps, they will be shown, expanded, in the DITA Maps tree and you will be able to navigate their content. To edit them you need to open each referenced map in a separate editor. You can choose not to expand referenced maps in the DITA Maps Manager view, or referenced content in the opened editors, by unchecking the Display referenced content checkbox available in the Author preferences page.

Drag and Drop in the DITA Maps Manager

You can move topics in the same map, or between different maps, by dragging and dropping them into the desired position. Also, you can move multiple topics by dragging them while pressing the Ctrl (Command on OS X) key.

You can also arrange the nodes by dragging and dropping one or more nodes at a time. Drop operations can be performed before, after, or as child of the targeted node. The relative location of the drop is indicated while hovering the mouse over a node before releasing the mouse button for the drop.

Drag and drop operations include:

Copy
Select the nodes you want to copy and start dragging them. Before dropping them in the appropriate place, press and hold the Ctrl key (Meta key on Mac). The mouse pointer changes to indicate that a copy operation is performed.
Move
Select the nodes you want to move and drag and drop them in the appropriate place.
Promote (Alt Left Arrow)/Demote (Alt Right Arrow)
You can move nodes between child and parent nodes by using the Promote (Alt Left Arrow) and Demote (Alt Right Arrow) operations.

DITA Maps Manager Toolbar

The toolbar includes the following actions (also available in theDITA Maps menu):

Open
You can use this drop-down menu to reopen recently viewed DITA maps. The drop-down menu also contains the following actions:
  • Clear history - Clears the history list of the recently viewed DITA maps.
  • Open... - Allows you to open the map in the DITA Maps Manager view. You can also open a map by dragging it from the file system explorer and dropping it into the DITA Maps Manager view.
  • Open URL... - Displays the Open URL dialog box that allows you to access any resource identified through a URL (defined by a protocol, host, resource path, and an optional port). The following actions are available in this drop-down action list:
    • Browse for local file - Opens a local file browser dialog box, allowing you to select a local DITA map.
    • Browse for remote file - Displays the Open URL dialog that allows you to open a remotely stored DITA map.
    • Browse for archived file - Displays the Archive Browser dialog that allows you to browse the content of an archive and choose a DITA 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.
    • Search for file - Displays the Open/Find Resource dialog.
Save (Ctrl (Meta on Mac OS)+S)
Saves the current DITA map.
Validate and Check for Completeness
Checks the validity and integrity of the map.
Apply Transformation Scenario(s)
Applies the DITA Map transformation scenario that is associated with the current map.
Configure Transformation Scenario(s)
Allows you to associate a DITA Map transformation scenario with the current map.
Refresh References
You can use this action to manually trigger a refresh and update of all referenced documents. This action is useful when the referenced documents are modified externally. When they are modified and saved from the Oxygen XML Editor Author, the DITA map is updated automatically.
Open Map in Editor with Resolved Topics
Opens the DITA map in the main editor area with content from all topic references, expanded in-place. Content from the referenced topics is presented as read-only and you have to use the contextual menu action Edit Reference to open the topic for editing.
Tip: If you want to print the expanded content, you should consider changing the Styles drop-down to + Print ready.
Open Map in Editor
For complex operations that cannot be performed in the simplified DITA Maps Manager view (for instance, editing a relationship table) you can open the map in the main editing area.
Note: You can also use this action to open referenced DITA maps in the Editor.
Profiling/Conditional Text
This drop-down list contains the following actions:
  • Show Profiling Colors and Styles - Enable this option to turn on conditional styling. To configure the colors and styles open the Preferences dialog box and go to Editor > Edit modes > Author > Profiling/Conditional Text > Colors and Styles.
  • Show Profiling Attributes - Enable this options to display the values of the profiling attributes at the end of the titles of topic references. When enabled, the values of the profiling attributes are displayed in both the DITA Maps Manager view and in the Author view.
  • Show Excluded Content - Controls if the content filtered out by a particular condition set is hidden or greyed-out in the editor area and in the Outline and DITA Maps Manager views. When this option is enabled, the content filtered by the currently applied condition set is greyed-out. To show only the content that matches the currently applied condition set, disable this option.
  • Profiling Settings - Opens the preferences page for adding and editing the profiling conditions that you can apply in the DITA Maps Manager view and the Author view. When a profiling condition set is applied, the keys that are defined in the DITA map are gathered by filtering out the excluded content.
Link with Editor
Disables/Enables the synchronization between the file path of the current editor and the selected topic reference in the DITA Maps Manager view.
Note: This button is disabled automatically when you move to the Debugger perspective.
Settings
Allows you to choose whether or not to Show extended toolbar and Show root map toolbar.
Root map
Specifies a master DITA map that Oxygen XML Editor uses to establish a key space that you can use with any other DITA map that is contained by the master map.

Contextual Menu of the DITA Maps Manager

The following actions can be invoked from the contextual menu on the root map of an opened DITA Map:
Open Map in Editor
For complex operations that cannot be performed in the simplified DITA Maps view (for instance, editing a relationship table) you can open the map in the main editing area.
Open Map in Editor with Resolved Topics
Opens the DITA map in the main editor area with content from all topic references, expanded in-place. Content from the referenced topics is presented as read-only and you have to use the contextual menu action Edit Reference to open the topic for editing.
Export DITA Map...
Allows you to choose a destination for exporting the DITA map.
Find Unreferenced Resources...
Allows you to search for orphaned resources that are not referenced in the DITA maps.
Edit Attributes...
Allows you to edit all the attributes of a selected node. You can find more details about this action in the Attributes View topic.
Edit Profiling Attributes...
Allows you to change the profiling attributes defined on all selected elements.
Edit Properties...
Edit the properties of a selected node. You can find more details about this action in the Edit Properties in DITA Maps topic.
Append Child
Container sub-menus for a number of actions that create a map node as a child of the currently selected node, or as a sibling of the currently selected node:
  • New topic... - Inserts a new topic.
  • Reference... - Inserts a reference to a topic file. You can find more details about this action in the Inserting References topic.
  • Reference to the currently edited file... - Inserts a reference to the currently edited file.
  • A set of actions that allow you to insert various reference specializations (such as Anchor Reference, Key Definition, Map Reference, Topic Group, Topic Head, Topic Reference, Topic Set, Topic Set Reference).
  • Topic Heading... - Inserts a topic heading. You can find more details about this action in the Inserting Topic Headings topic.
  • Topic Group... - Inserts a topic group. You can find more details about this action in the Inserting Topic Groups topic.
Search References
Searches all references to the current topic in the entire ditamap.
Refactoring > Rename resource...
Allows you to change the name of a resource linked in the edited DITA map.
Refactoring > Move resource...
Allows you to change the location on disk of a resource linked in the edited DITA map.
Refactoring > XML Refactoring...
Opens the XML Refactoring tool wizard that presents refactoring operations to assist you with managing the structure of your XML documents.
Find/Replace in Files...
Allows you to find and replace content across multiple files.
Check Spelling in Files...
Allows you to spell check multiple files.
Paste
Allows you to paste content from the clipboard into the DITA map.
Paste Before
Pastes the content of the clipboard (only if it is a part of the DITA map) before the currently selected DITA map node.
Paste After
Pastes the content of the clipboard (only if it is a part of the DITA map) after the currently selected DITA map node.
Expand All
Allows you to expand the entire DITA map structure.
Collapse All
Allows you to collapse the entire DITA map structure.

In addition to those described above, the following actions are available when the contextual menu is invoked from child nodes of the root map:

Open
Opens in the editor the resources referenced by the nodes that you select.
Cut, Copy, Paste, Delete
Common edit actions that allow you to cut, copy, paste, and delete parts of the DITA map.
Organize
Allows you to organize the DITA map with the several submenu actions:
  • Move Up - moves the selected node up within the DITA map tree.
  • Move Down - moves the selected node down within the DITA map tree.
  • Promote (Alt Left Arrow) - moves the selected node up one level to the level of its parent node.
  • Demote (Alt Right Arrow) - moves the selected node down one level to the level of its child nodes.

To watch our video demonstrations about DITA editing and the DITA Maps Manager view, go to http://oxygenxml.com/demo/DITA_Editing.html and http://oxygenxml.com/demo/DITA_Maps_Manager.html, respectively.

Related information
Validating DITA Maps
DITA OT Transformation
DITA Map ANT Transformation Because it Cannot Connect to External Location
DITA Map Author Actions
Finding and Replacing Text in Multiple Files