DITA Map Author Mode Actions
A variety of actions are available in the DITA Map framework that can be added to the DITA menu, the Author Custom Actions toolbar, the contextual menu, and the Content Completion Assistant.
DITA Map Toolbar and Menu Actions
When a DITA map is opened in Author mode, the following default actions are available on the DITA Map Author Custom Actions toolbar (by default, they are also available in the DITA menu and in various submenus of the contextual menu):
- Insert New Topic
- Opens a New DITA topic dialog box that allows you to create a new topic and inserts a reference to it at the cursor position.
- Insert Topic Reference
- Opens the Insert Reference dialog box that allows you to insert and configure a reference to a topic at the cursor position.
- Reuse Content
- Opens the Reuse Content dialog box that allows you to insert
and configure a content reference (
conref
), or a content key reference (conkeyref
) at the cursor position. - Insert Topic Heading
- Opens the Insert Reference dialog box that allows you to insert a topic heading at the cursor position.
- Insert Topic Group
- Opens the Insert Reference dialog box that allows you to insert a topic group at the cursor position.
- Insert Relationship Table
- Opens a dialog box that allows you to configure the relationship table to be inserted. The dialog box allows you to configure the number of rows and columns of the relationship table, if the header will be generated and if the title will be added.
- Relationship Table Properties
- Allows you to change the properties of rows in relationship tables.
- Insert Relationship Row
- Inserts a new table row with empty cells. The action is available when the cursor position is inside a 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 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(Alt + LeftArrow)
- Moves the selected node up one level to the level of its parent node.
- Demote(Alt + RightArrow)
- Moves the selected node down one level to the level of its child nodes.
DITA Menu Actions
In addition, the following default actions are available in the DITA menu when editing a DITA map in Author mode:
- Refresh References
- You can use this action to manually trigger a refresh and update of all referenced resources.
- Tags display mode Submenu
-
- Full Tags with Attributes
- Displays full tag names with attributes for both block level and in-line level elements.
- Full Tags
- Displays full tag names without attributes for both block level and in-line level elements.
- Block Tags
- Displays full tag names for block level elements and simple tags without names for in-line level elements.
- Inline Tags
- Displays full tag names for inline level elements, while block level elements are not displayed.
- Partial Tags
- Displays simple tags without names for in-line level elements, while block level elements are not displayed.
- No Tags
- No tags are displayed. This is the most compact mode and is as close as possible to a word-processor view.
- Configure Tags Display Mode
- Use this option to go to the Author preferences page where you can configure the Tags Display Mode options.
- Profiling/Conditional Text Submenu
-
- Edit Profiling Attributes
- Allows you to configure the profiling attributes and their values.
- Show Profiling Colors and Styles
- Select this option to turn on conditional styling.
- Show Profiling Attributes
- Select this option to turn on conditional text markers. They are displayed at the end of conditional text blocks, as a list of attribute name and their currently set values.
- Show Excluded Content
- When this option is enabled, the content filtered by the currently applied condition set is grayed-out. To show only the content that matches the currently applied condition set, disable this option.
- List of all profiling condition sets that match the current document type
- You can click a listed condition set to activate it.
- Profiling Settings
- Opens the profiling options preferences page, where you can manage profiling attributes and profiling conditions sets. You can also configure the profiling styles and colors options from the colors/styles preferences page and the attributes rendering preferences page.
- ID Options
- Opens the ID Options dialog box that allows you to configure
options for generating IDs in Author mode. The dialog box
includes the following:
- ID Pattern
- The pattern for the ID values that will be generated. This text field can be customized using constant strings or any of the Oxygen XML Editor Editor Variables.
- Element name or class value to generate ID for
- The elements for which ID values will be generated, specified using class attribute values. To customize the list, use the Add, Edit, or Remove buttons.
- Auto generate IDs for elements
- If enabled, Oxygen XML Editor will automatically generate unique IDs for the elements listed in this dialog box when they are created in Author mode.
- Remove IDs when copying content in the same document
- When copying and pasting content in the same document, this option allows you
to control whether or not pasted elements that are listed in this dialog box
should retain their existing IDs. To retain the element IDs, disable this
option.
Note
This option does not have an effect on content that is cut and pasted.
- Generate IDs
-
Oxygen XML Editor 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 and elements from the list in the ID Options dialog box that are found in the current selection.
Note
The Generate IDs action does not overwrite existing ID values. It only affects elements that do not already have anid
attribute.
DITA Map Contextual Menu Actions
In addition to many of the DITA Map toolbar actions and the general Author mode contextual menu actions, the following DITA map framework-specific actions are also available in the contextual menu when editing in Author mode:
- Edit Properties
- Opens the Edit Properties dialog box that allows you to configure the properties of a selected node. For more details about this dialog box, see Edit Properties Dialog Box.
- Generate IDs
-
Oxygen XML Editor 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 and elements from the list in the ID Options dialog box that are found in the current selection.
Note
The Generate IDs action does not overwrite existing ID values. It only affects elements that do not already have anid
attribute. - Search References
- Finds the references to the
href
orkeys
attribute value of the topic/map reference element at the current cursor position, in all the topics from the current DITA map (opened in the DITA Maps Manager view). The current topic/map reference element must have anhref
orkeys
attribute defined to complete the search. - Show Key Definition
- Available for elements that have a
conkeyref
orkeyref
attribute set (or elements with an ancestor element that has aconkeyref
orkeyref
attribute). It computes the key name and opens the DITA map that contains the definition of the key with the element that defines that key selected.
DITA Map Drag/Drop Actions
Dragging a file from the Project view or DITA Maps Manager view
and dropping it into a DITA map document that is edited in Author
mode creates a link to the dragged file (a topicref
element,
chapter
, part
, etc.) at the drop location.
Open Topic from DITA Map in Author Mode
When a DITA map is opened in Author mode, you can click the icon to the left of a topic to open that particular topic in the editor.