Edit online

DITA Map Tree Editor (Experimental)

Oxygen XML Web Author offers experimental support to edit DITA map documents with a specialized tree editor in the main editing area instead of the default visual editor.

To enable the tree editor, add the &loadMapAsTree=true loading option. By default, the referenced submaps are loaded as read-only and highlighted with a gray background but they can be made editable by using the &editReferencesInPlace=true loading option.
Notice:
Enabling this editing mode may require additional integration with custom file servers or connectors (e.g. overriding the default save action).

The specialized DITA Map Tree Editor includes the following features:

  • Drag and drop actions can be used to move topic references and organize DITA map content.
  • An external link can be dragged and dropped within the editable DITA map to quickly insert a reference.
  • Hovering over a topic reference displays a tooltip with information about the reference, such as the path of the file, any defined key name, key reference, key scope, processing role, or profiling attributes that are set on the topic reference or inherited by it. If the referenced topic is missing or not well-formed XML, the tooltip presents details about the problem.
  • The type of DITA resource for each reference can be quickly identified by looking at the icons displayed on the left side of each topic or map reference. For example, a DITA Map is displayed with the DITA map icon, a DITA Topic is displayed with DITA topic, a DITA Task is displayed with DITA task, etc. If the referenced topic is missing or not well-formed XML, an error icon is presented instead.
  • The title of each topic is displayed, by default.

Toolbar

The following actions are available on the toolbar:
  • Undo/Redo - Undo/redo the most recent changes.
  • Save - Saves changes.
  • More > Download - Downloads the currently edited DITA map.
  • Switch to Author Mode - Switches to the Author visual editing mode.
  • Edit Properties - Opens a dialog box where you can change the reference type or edit attributes for the currently selected topic reference.
  • Edit Profiling Attributes - Opens a dialog box where you can edit profiling attributes for the currently selected topic reference.
  • Topic Reference - Inserts a new topic reference at the specified location.
  • Remove Reference - Deletes the selected topic reference.
  • Move Up/Down/Promote/Demote - Moves topic references up, down, promotes them, or demotes them using the toolbar actions or their corresponding shortcuts.
  • Show Profiling Attributes - Displays profiling information directly on the topic reference.

Contextual Menu

The following contextual menu actions are available:
  • Edit Properties - Opens a dialog box where you can edit attributes/properties for the currently selected topic reference.
  • Edit Profiling Attributes - Opens a dialog box where you can change the reference type or edit profiling attributes for the currently selected topic reference.
  • Append child/Insert before/Insert after > New - Creates a new DITA topic or map in the connected document storage and inserts a reference to it.
  • Append child/Insert before/Insert after > Topic Reference - Inserts a new topic reference at the specified location.
  • Append child/Insert before/Insert after > Key Definition For Topic Reference - Opens a dialog box where you can configure a new key name and browse for an associated topic reference. A key definition containing the defined key/topic reference combination will be inserted.
  • Append child/Insert before/Insert after > Key Definition with Keyword (Variable) - Opens a dialog box where you can configure a new key name with an associated keyword value that will be inserted as a key definition containing the defined key/value combination.
  • Append child/Insert before/Insert after > Mapref - Inserts a reference to a DITA map.
  • Append child > Frontmatter, Chapter, Part, Appendix, Backmatter - Inserts a specific type of bookmap topic reference inside an opened bookmap.
  • Insert before/Insert after > Chapter, Part - Inserts a chapter or part topic reference before or after an existing chapter or part inside an opened bookmap.
  • Append child/Insert before/Insert after > Topic Head - Inserts a topic heading with a specified title.
  • Cut/Copy/Paste/Paste before/Paste after - Cut or copy one or multiple selected topic references, then paste them inside, before, or after the selected topic reference.
  • Remove Reference - Deletes the selected topic reference.
  • Undo/Redo - Undo/redo changes using the available actions or the regular keyboard shortcuts.
  • Move Up/Down/Promote/Demote - Moves topic references up, down, promotes them, or demotes them using the actions from the Organize contextual menu or their corresponding shortcuts.
  • Show profiling attributes - Displays profiling information directly on the topic reference.
  • Collapse all - Collapses all levels on the currently selected reference.