Edit online

Toolbar, Contextual Menu, and Shortcut Actions

Oxygen XML Web Author includes a variety of editing actions that are available on the toolbar and from the contextual menu (on desktop devices).

Review Actions Toolbar

The Review toolbar contains actions to assist you with review tasks. On a desktop device, some of these actions are also available in the contextual menu.

Figure 1. Review Actions
The actions include:
Toggle Change Tracking
Toggles Change Tracking mode on or off.
Accept Change (Available when invoked on a change)
Available on changes when Change Tracking is enabled. It accepts the tracked change located at the cursor position. For an insert change, it means keeping the inserted text and for a delete change, it means removing the content from the document.
Reject Change (Available when invoked on a change)
Available on changes when Change Tracking is enabled. Rejects the tracked change located at the cursor position. For an insert change, it means removing the inserted text and for a delete change, it means preserving the original content from the document.
Highlight
Allows you to mark fragments in your document using various colors. This is especially useful when you want to mark sections that need additional editing or to draw the attention of others to particular content. To use it, select the color you want from the drop-down menu, then hold the left mouse button and use the mouse to highlight the content in the editor. When finished, click anywhere in the editor and continue editing. To turn the highlighter off, select Stop highlighting from the drop-down menu.
Add Comment
Allows you to insert a comment on a selected fragment of text. After you add a comment, the content where the comment was added is highlighted in the document and you can see the comment by hovering over the highlighted content or in the Review view.
Edit Comment (Available when invoked on a comment)
Opens the Edit Comment dialog box that allows you to edit the selected comment.
Remove Comment (Available when invoked on a comment)
Removes a selected comment.
Previous Marker
Navigates to the previous change or comment.
Next Marker
Navigates to the next change or comment.
Track Changes Visualization Modes Drop-down Menu
This drop-down menu includes specialized actions that allow you to switch between the following visualization modes for the Track Changes feature:
  • View All Changes/Comments - This mode is active by default. When you use this mode, all tracked changes are represented.
  • View Final - This mode offers a preview of the document as if all tracked changes (both inserted and deleted) were accepted.
  • View Original - This mode offers a preview of the document as if all tracked changes (both inserted and deleted) were rejected. If you attempt to edit the document in this mode, the view mode will switch to View All Changes/Comments.

Framework-Specific Actions Toolbar

Depending on the type of document you are editing, the toolbar and contextual menu contains a series of actions defined at framework level. Oxygen XML Web Author includes built-in actions for DITA, DITA Map, DocBook, TEI, and XHTML document types. On a desktop device, many of these actions are also available in the contextual menu. On mobile devices, the framework-specific toolbar is only available in Edit mode ().

Figure 2. Example: DITA Toolbar
The actions include:
Styling actions
Most common styling actions, such as Bold, Italic, Underline.
Insert actions
Actions for inserting a variety of framework-specific objects, such as images, equations, tables, paragraphs, links (for example, cross references, file references, or web links in DITA), topic references (DITA map), reusable content references (DITA), relationship tables (DITA map), and others.
List actions
Actions that allow you to create ordered and unordered lists, and add new items in them. These list buttons can also be used to convert an existing list to another type (for example, an unordered list to an ordered list) or to convert the current paragraph to a list.
Table actions
Actions that allow you to create a table and manage its structure (insert and delete rows and columns).
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.

For a complete list of toolbar actions for DITA Topic document types, see DITA Toolbar Actions.

Contextual Menu Actions (Desktop Devices)

In a desktop web browser, the contextual menu also offers numerous editing actions, along with framework-specific actions. For a complete list of actions available for DITA documents, see DITA Contextual Menu Actions or DITA Map Contextual Menu Actions.

The contextual menu includes the following actions:
Remove Highlight
Removes the colored highlight at the cursor location.
Accept Change (Available when invoked on a change)
Available on changes when Change Tracking is enabled. It accepts the tracked change located at the cursor position. For an insert change, it means keeping the inserted text and for a delete change, it means removing the content from the document.
Reject Change (Available when invoked on a change)
Available on changes when Change Tracking is enabled. Rejects the tracked change located at the cursor position. For an insert change, it means removing the inserted text and for a delete change, it means preserving the original content from the document.
Add Comment
Allows you to insert a comment on a selected fragment of text. After you add a comment, the content where the comment was added is highlighted in the document and you can see the comment by hovering over the highlighted content or in the Review view.
Reply (Available when invoked on a comment or change)
Opens a dialog box that allows you to add a reply to a comment or tracked change. After a reply is added, it is displayed with an indentation in the tooltip when hovering over the comment or change, and in the Review view.
Edit Comment (Available when invoked on a comment)
Opens the Edit Comment dialog box that allows you to edit the selected comment.
Remove Comment (Available when invoked on a comment)
Removes a selected comment.
Edit Attributes (Alt+Enter)
Opens the Attributes tab in the panel on the right side of the screen where you can add or edit attributes.
Edit Profiling Attributes

Opens the Edit Profiling Attributes dialog box where you can configure profiling attribute values for the current XML element. By default, the action appears for open DITA XML topics and maps and can be configured to also appear for other vocabularies using the WEBAPP_ALLOW_EDIT_PROFILING_ATTRIBUTES server-side option. Profiling attribute values can be configured using a Subject Scheme Map that is referenced in the context DITA map or by configuring the values in the Options > Preferences > Attributes and Condition Sets preferences page within an Oxygen XML Editor/Author desktop version and then exporting the options to be used with the Oxygen XML Web Author server. Profiling attribute groups are also supported.

For DITA XML documents, the Edit Profiling Attributes dialog box can also be shown by using the Edit Profiling Attributes button located at the end of the profiling attributes label shown after each element that contains profiling attributes and by using the Edit Profiling Attributes button in the Attributes side pane (it appears when editing the value for a profiling attribute).

Show/Hide Excluded Content
Controls whether content that is excluded by a DITAVAL context filter is shown as grayed out or hidden.
Surround With
Allows you to choose a tag to enclose selected content.
Insert Submenu
Provides various framework-specific actions for inserting a variety of objects, such as Insert Table, Insert Image, Insert Equation (for inserting MathML equations), Insert Element, and more.
Style Submenu
Provides various framework-specific styling actions, such as Bold, Italic, Underline, Subscript, Superscript, and more.
Section Submenu (DocBook)
Includes actions for promoting or demoting sections.
Link Submenu
Provides various framework-specific actions for inserting types of links (e.g. Cross Reference, File Reference, Web Link).
Select Submenu
Includes actions for selecting an Element, its Content, or its Parent element.
Generate IDs (DITA, DocBook, TEI)
Oxygen 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 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 an @id attribute.
Reuse Submenu (DITA)
Provides various DITA-specific actions for reusing content.
Cut (Ctrl + X (Command + X on macOS))
Removes the selected content and copies it to the clipboard. You can then use the Ctrl + V (Command + V on macOS) keyboard shortcut to paste the content (or use the Paste Special action from the contextual menu).
Copy (Ctrl + C (Command + C on macOS))
Copies the selected content to the clipboard. You can then use the Ctrl + V (Command + V on macOS) keyboard shortcut to paste the content (or use the Paste Special action from the contextual menu).
Paste Special
Opens the Paste Special dialog box where you to choose how to paste copied content. There is a preview pane inside the dialog box where you have to paste the copied content either by using the Ctrl + V (Command + V on macOS) keyboard shortcut or by selecting Paste from the contextual menu. 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.

To perform the paste operation, click the Paste button at the bottom of the dialog box.

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.
Collapse All
Folds all elements in the current document.
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.
Delete Element Tags (Alt+Shift+X)
Deletes the tags of the closest element at the current cursor position.
About Element Submenu
Browse DITA Style Guide (DITA only)
Opens the DITA Style Guide Best Practices for Authors in a preview window and displays a topic that is relevant to the element at the cursor position. You can use the Open in new tab button at the bottom of the preview window to open the guide in a separate browser tab.
Browse Reference Manual (DITA only)
Opens the documentation for the current element in the Oasis reference manual.
Inspect Styles
Opens the CSS Inspector pane that displays information about the CSS styles that are applied to the currently selected element.
Spelling Errors
For spelling errors, the contextual menu includes a list of suggestions that you can select from to replace the word and an Ignore option that instructs Oxygen XML Web Author to ignore all occurrences of that particular spelling error in the current document.
Table-Related Actions (Available when invoked on a table item)
A variety of table editing actions are available in the contextual menu when it is invoked on a table (depending on the context, the table-related actions are promoted to the top level of the contextual menu and the Other Actions submenu provides access to the other actions).

Common Shortcut Actions

Oxygen XML Web Author includes numerous shortcut keys that are assigned to actions to help you edit content.

Table 1. Frequently Used Shortcut Keys in Oxygen XML Web Author
Action Shortcut Keys Description
Beginning Ctrl + Home Navigates to the beginning of the document
Check Spelling F7 Opens the spell checking dialog box
End Ctrl + End Navigates to the end of the document
Copy Ctrl + C Copies selected content to the clipboard
Cut Ctrl + X Cuts selected content to the clipboard
Find Ctrl + F Opens Find/Replace dialog box
Print Ctrl + P Opens a Print Preview dialog box
Help F1 Opens help documentation
Open Link Ctrl + Click (on links) Opens the current link in a new browser tab
Paste Ctrl + V Pastes content from the clipboard
Redo Ctrl + Y Re-applies the last editing action
Reload F5 Reloads the current document
Save Ctrl + S Saves the current document
Underline Ctrl + U Underlines selected content
Undo Ctrl + Z Reverses last editing action