Editing Actions
Oxygen XML Web Author allows you to not only review documents, but to also make changes to them. On mobile devices, to activate the editing mode, tap or click the Edit button in the upper toolbar (or swipe left). A variety of editing actions are available on the toolbar, and on the desktop version, from the contextual menu.
Review Actions Toolbar
The Review toolbar contains actions to assist you with review tasks. On the desktop version, some of these actions are also available in the contextual menu. These actions include:
Toggle
Change Tracking- Toggles change tracking mode on or off.
Accept 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 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.
Edit Comment- Opens the Edit Comment dialog box that allows you to edit the selected comment.
Remove 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:
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 Toolbar Actions
Depending on the type of document you are editing, the toolbar and contextual menu contains a series of actions defined at framework level. On the desktop version, many of these actions are also available in the contextual menu. Oxygen XML Web Author includes built-in actions for DITA, DITA Map, DocBook, TEI, and XHTML document types. These actions include:
- Styling actions
- Most common styling actions, such as Bold, Italic, Underline.
- Insert actions
- Actions that allows you to insert 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.
- 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.
Choose DITA Map- For DITA documents, the toolbar includes a Choose DITA Map button that opens a
dialog box where you can enter a URL for the DITA Map that you want to be associated
with the current document.
Contextual Menu Actions (Desktop Version)
In a desktop web browser, the contextual menu also offers numerous editing actions, along with framework-specific actions. They include the following:
Copy (Ctrl + C (Command + C on
OS X))
- Copies the selected content to the clipboard. You can then use the Ctrl + V (Command + V on
OS X) keyboard shortcut to paste the
content (or use the
Paste
Special action from the contextual menu).
- 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.
Cut (Ctrl + X (Command + X on
OS X))
- Removes the selected content and copies it to the clipboard. You can then use the
Ctrl + V (Command + V on
OS X) keyboard shortcut to
paste the content (or use the Paste
Special action from the contextual menu).
Undo- This action is available after you make a change.
Redo- This action is available when you use the Undo action.
Insert Element- Inserts an element at current position.
Rename
Element- Renames the current element.
Surround
With- Allows you to choose a tag to enclose the selected content.
- Accept 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 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.
- Remove Comment
- Removes a selected comment.
- Reply
- 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
- Opens the Edit Comment dialog box that allows you to edit the selected comment.
- 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.
- 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 All option that instructs Oxygen XML Web Author to ignore all occurrences of the reported spelling error in the current document.
Framework-Specific Contextual Menu Actions (Desktop Version)
In a desktop web browser, the contextual menu also offers some editing actions that are specific to the type of document you are working with. Many of these actions are the same actions that are found on the Framework-Specific Toolbar. However, some of the frameworks include additional actions. They include the following:
- Generate IDs (DITA, DocBook, TEI)
-
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 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 anidattribute. - (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.