DITA Map Document Type
Edit online

Oxygen XML Web Author includes a variety of features that were designed specifically for DITA Map document types. Most of these features can be accessed through actions available on the DITA Map framework-specific toolbar or from the contextual menu.

DITA Map New Document Templates

Oxygen XML Web Author includes a variety of predefined new document templates that make it easy to create various types of DITA documents with some of the document structure already present. When you use the New button in the Dashboard for your particular file repository, a dialog box is displayed where you can choose from various types of new document templates, including Map, Bookmap, Subject Scheme, and other types of DITA maps.

Figure: New Document Template Wizard

DITA Map Toolbar Actions

The following default actions are readily available on the toolbar when editing a DITA map document in Oxygen XML Web Author:

DITA Map Display Mode Drop-Down Menu
This drop-down menu offers three possibilities for choosing how the DITA map is displayed:
View Topic References
Display the map with the topic references shown.
View Topic Titles
Displays the map with both titles and topic references shown.
View Topic Content
Displays the map with all of the topic content expanded in one document without having to open each topic individually to see their content. This mode is helpful for previewing the entire content of a DITA map.
Restriction: By default, to prevent performance issues, the View Topic Content mode is not available if the DITA map contains more than 50 references. This amount can be configured with the topic.content.refs.limit option.
Insert New Topic
Opens a new document template wizard where you can choose the type of DITA document to insert at the current position.
Insert Topic Reference
Opens a dialog box where you can select a file to insert as a topic reference at the current position.
Insert Relationship Table
Inserts an empty relationship table at the current position.
Insert Relationship Row
Inserts a new table row with empty cells. The action is available when the cursor position is inside a relationship table.
Insert Relationship Column
Inserts a new table column with empty cells after the current column. The action is available when the cursor position is inside a relationship table.
Delete Relationship Column
Deletes the table column where the cursor is located.
Delete Relationship Row
Deletes the table row where the cursor is located.
Move Up
Moves the selected node up one position on its same level.
Move Down
Moves the selected node down one position on its same level.
Promote
Moves the selected node up one level to the level of its parent node.
Demote
Moves the selected node down one level to the level of its child nodes.
Insert Special Character
Opens a dialog box that allows you to select from a large variety of special characters to insert at the current cursor position. The various types of characters include symbols, emoticons, punctuation, and many more.

DITA Contextual Menu Actions

There are various actions that are available in the contextual menu when editing DITA map documents in Oxygen XML Web Author:

Add Comment
Opens a dialog box where you can type a comment to insert at the cursor position. The commented text is highlighted and you can see the comment in the Review panel or when hovering over the highlighted text.
Surround With
Allows you to choose a tag to enclose selected content.
Insert submenu
This submenu includes the following insert actions that are specific to the DITA Map framework:
Insert New Topic
Opens a new document template wizard where you can choose the type of DITA document to insert at the current position.
Insert Topic Reference
Opens a dialog box where you can select a file to insert as a topic reference at the current position.
Insert Element
Opens a content completion window where you can choose an element to insert at the current position.
Relationship Table submenu (Available when invoked on a relationship table)
Presents various actions for configuring the relationship table, such as adding or deleting rows and columns.
Generate IDs
Oxygen XML Web Author generates unique IDs for the current element (or elements), depending on how the action is invoked:
  • When invoked on a single selection, an ID is generated for the selected element at the cursor position.
  • When invoked on a block of selected content, IDs are generated for all top-level elements.
Note: The Generate IDs action does not overwrite existing ID values. It only affects elements that do not already have an id attribute.
Paste Special
Opens a dialog box that allows you to choose how to paste copied content. You have to use the Ctrl + V (Command + V on OS X) keyboard shortcut (or select Paste from the contextual menu) to paste the copied content into the preview window in this Paste Special dialog box and then you can choose to paste it into your document with one of the following choices:
  • Smart Paste - Oxygen XML Web Author will paste the copied content while trying to preserve its structure and if the current location is invalid, Oxygen XML Web Author will attempt to find a possible solution.
  • Paste as Text - The copied content will be pasted as text content.
  • Paste as XML - Copied content that is considered to be valid XML will be pasted with its XML structure preserved.
Folding Submenu
Toggle Fold (or simply click on the / arrow in the editing panel)
Toggles the state of the current fold.
Collapse Other Folds
Folds all the elements except the current element.
Collapse Child Folds
Folds the child elements that are indented one level inside the current element.
Expand Child Folds
Unfolds all child elements of the currently selected element.
Expand All
Unfolds all elements in the current document.
Rename Element
Opens a content completion window where you can choose an element to rename the element at the current position.

Special Icons

There are a few special icons that are displayed in DITA maps next to topic references that contain certain attributes set to no:
  • - This icon is displayed if a topic reference has the @toc attribute set to no.
  • - This icon is displayed if a topic reference has the @print attribute set to no.