DITA Maps Manager

Opening Maps in the DITA Maps Manager

The DITA Maps Manager view supports multiple open maps at the same time, with each one presented in its own tab. To open a DITA map in the DITA Maps Manager, use any of the following methods:

To open a sub-map in its own tab, simply double click it (or right-click it and select Open).
If you open a file with the .ditamap or .bookmap extension (from the Project view or a system browser), a dialog box is opened that offers you the choice of opening it in the DITA Maps Manager or the XML editor.
Note: If you select the Do not show the dialog again option, it will always be opened in the method that you choose and you will not be asked in the future. However, you can reset this by selecting Always ask for the When opening a map option in the DITA preferences page.
Right click a map file in the Project view and select Open with > DITA Maps Manager.
If you have a DITA map file open in the XML editor, you can right-click the title tab and select Open in DITA Maps Manager View.

If your map references other DITA maps, they will be shown, expanded, in the DITA Maps Manager view and you will be able to navigate their content. To edit the sub-maps and their content, you need to open each referenced map separately.

Note: You can choose to not expand referenced maps in the DITA Maps Manager view by disabling the Display referenced content option in the Author preferences page.

Drag and Drop in the DITA Maps Manager

You can move topics or nodes in the same map, or between different maps, by dragging and dropping them into the desired position. You can arrange the nodes by dragging and dropping one or more nodes at a time. You can arrange multiple topics by dragging them while pressing the Ctrl or Shift key. Drop operations can be performed before, after, or as child of the targeted node.

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. The mouse pointer changes to a symbol to indicate that a copy operation is being 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) and their availability depend on the nodes that are selected:

Note: If multiple nodes are selected, the availability of the actions depend on the nodes that are selected.

Open Drop-down Menu

You can use this drop-down menu to open new DITA maps or to reopen recently viewed maps. The drop-down menu contains the following:

List of recently viewed DITA maps that can be selected to reopen them.
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 menu:
- 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 box that allows you to open a remotely stored DITA map.
- Browse for archived file - Displays the Archive Browser dialog box 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 box.
- Search for file - Displays the Open/Find Resource dialog box that allows you to search for a DITA map.

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, 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 Drop-down Menu

This drop-down menu 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.

Browse Drop-down menu

You can use this drop-down menu to browse 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 for remote file - Displays the Open URL dialog box that allows you to select a remotely stored root map.
Browse for archived file - Displays the Archive Browser dialog box 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.

The following additional actions are displayed in the toolbar when the Show extended toolbar option is selected in the

Settings menu:

Insert Topic Reference: Opens the Insert Reference dialog box that allows you to insert references to targets such as anchors, topics, maps, topic sets, or key definitions.
Edit Properties: Opens the Edit Properties dialog box that allows you to configure the properties of a selected node. You can find more details about this dialog box in the Edit Properties in DITA Maps topic.
Edit Attributes: Opens a small in-place editor that allows you to edit the attributes of a selected node. You can find more details about this action in the Attributes View in Author Mode topic.
Delete: Deletes the selected node.
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.

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 Manager 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 Properties

Opens the Edit Properties dialog box that allows you to configure the properties of a selected node. You can find more details about this dialog box in the Edit Properties in DITA Maps topic.

Append Child submenu

Container sub-menu for a number of actions that create a map node as a child of the currently selected node:

New - Opens a dialog box that allows you to configure some options for inserting 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. You can find more details about this action in the Inserting References topic.
Key Reference - Opens an Insert Key Definition dialog box that allows you to insert a key reference.
Key Reference with Keyword - Opens a simplified Insert Key Definition dialog box that allows you to define a key and a value inside a keyword.
A set of actions that open the Insert Reference dialog box that allow you to insert various reference specializations (such as Anchor Reference, Glossary Reference, Map Reference, Navigation Reference, Topic Group, Topic Head, Topic Reference, Topic Set, Topic Set Reference).

Search References

Searches all references to the current topic in the entire DITA map.

Refactoring submenu

The following actions are available from this submenu:

Rename resource: Allows you to change the name of a resource linked in the edited DITA map.
Move resource: Allows you to change the location on disk of a resource linked in the edited DITA map.
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.

The following actions are available when the contextual menu is invoked from a node that is not an immediate child node of the root map:

Note: If multiple nodes are selected, the availability of the actions depend on the nodes that are selected.

Open

Opens in the editor the resources referenced by the nodes that you select.

Open Map in Editor (available when invoking on a sub-map)

Opens the currently selected DITA map in the editor.

Open parent DITA map (available when invoking on a topic reference or a sub-map reference)

Opens the parent DITA map of the currently selected reference in the DITA Maps Manager.

Edit Attributes (only available for relationship table nodes)

Opens a small in-place editor that allows you to edit the attributes of a selected node. You can find more details about this action in the Attributes View in Author Mode topic.

Edit Profiling Attributes (only available for relationship table nodes)

Allows you to change the profiling attributes defined on the selected node.

Search References

Searches all references to the current topic in the entire DITA map.

Refactoring submenu

The following actions are available from this submenu:

Rename resource: Allows you to change the name of a resource linked in the edited DITA map.
Move resource: Allows you to change the location on disk of a resource linked in the edited DITA map.
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.

Copy

Copies the currently selected node to the clipboard.

Expand All

Allows you to expand the entire DITA map structure.

Collapse All

Allows you to collapse the entire DITA map structure.

The following actions are available when the contextual menu is invoked on a child node of a DITA map (sub-maps need to be opened in the DITA Maps Manager to access these actions since they are in a read-only state in the parent map):

Note: If multiple nodes are selected, the availability of the actions depend on the nodes that are selected.

Open

Opens in the editor the resources referenced by the nodes that you select.

Edit Properties

Opens the Edit Properties dialog box that allows you to configure the properties of a selected node. You can find more details about this dialog box in the Edit Properties in DITA Maps topic.

Append Child submenu

Container sub-menu for a number of actions that create a map node as a child of the currently selected node:

New - Opens a dialog box that allows you to configure some options for inserting 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. You can find more details about this action in the Inserting References topic.
Key Reference - Opens an Insert Key Definition dialog box that allows you to insert a key reference.
Key Reference with Keyword - Opens a simplified Insert Key Definition dialog box that allows you to define a key and a value inside a keyword.
A set of actions that open the Insert Reference dialog box that allow you to insert various reference specializations (such as Anchor Reference, Glossary Reference, Map Reference, Navigation Reference, Topic Group, Topic Head, Topic Reference, Topic Set, Topic Set Reference).

Insert After submenu

Container sub-menus for a number of actions that create a map node as a sibling of the currently selected node:

New - Opens a dialog box that allows you to configure some options for inserting 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. You can find more details about this action in the Inserting References topic.
Key Reference - Opens an Insert Key Definition dialog box that allows you to insert a key reference.
Key Reference with Keyword - Opens a simplified Insert Key Definition dialog box that allows you to define a key and a value inside a keyword.
A set of actions that open the Insert Reference dialog box that allow you to insert various reference specializations (such as Anchor Reference, Glossary Reference, Map Reference, Navigation Reference, Topic Group, Topic Head, Topic Reference, Topic Set, Topic Set Reference).

Search References

Searches all references to the current topic in the entire DITA map.

Refactoring submenu

The following actions are available from this submenu:

Rename resource: Allows you to change the name of a resource linked in the edited DITA map.
Move resource: Allows you to change the location on disk of a resource linked in the edited DITA map.
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.

Cut

Deletes the currently selected node and copies it to the clipboard.

Copy

Copies the currently selected node to the clipboard.

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.

Delete

Deletes the currently selected node from 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.

Expand All

Allows you to expand the entire DITA map structure.

Collapse All

Allows you to collapse the entire DITA map structure.