Making Changes to Uploaded Files
Edit online

As the Reviewer, you can click on any of the files attached to the task to open it in a visual editor. This is where you can proofread, make changes, and add comments in the files.

Figure 1: Content Fusion Editor Interface

Left-Side Task Management Panel

The resizeable left panel lists all the files and messages that are attached to the task. You can switch files simply by clicking on the file in this left panel. You can use the Add Message button to add a new message for the Content Author or other Reviewers and the Finalize Review button can be used to indicate that you are finished reviewing all files. Keep in mind that all messages in this panel are attached to the task and not to individual files (to annotate individual files, use the Add Comment button in the editor). All files attached to the task should be reviewed before using the Finalize Review button.

For DITA projects, if the Content Author specified a context DITA map, this panel shows the hierarchy of all the attached files as they appear in the specified DITA map. The topic title hierarchy from the DITA map is also displayed underneath each topic and if part of it is not shown, you can hover over it to see the entire title hierarchy in a tooltip.

Visual Editor

This visual editor allows you to review and edit content similar to common word processors. In most cases, the tracked changes feature will always be on so you and the Content Author can see exactly what was changed and the Content Author will be able to easily accept or reject the changes.

Toolbar Actions

The editor also includes a toolbar with some common actions as well as others that are specific to the type of document (framework). Most Reviewers will only be interested in the buttons located in the first two sections of toolbar actions. These actions include:

Undo
This action is available after you make a change.
Redo
This action is available when you use the Undo action.
Search
Opens a popup window that helps you find and replace content in the current document.
More drop-down menu
Gives you access to additional general actions, such as options to save, download, or print the document. The Preferences option allows you to select a Tags Display Mode to control the amount of XML markup that is displayed, and you can change the interface language or enable automatic spell checking.
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 for the Tracked 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
Depending on the type of document you are editing, the final section of buttons on the toolbar include a series of actions defined at framework level. Many of these actions are also available in the contextual menu. Oxygen Content Fusion includes built-in actions for DITA, DITA Map, DocBook, TEI, and XHTML document types.
Figure 2: Example: DITA Toolbar Actions
The framework-specific actions include:
Choose DITA Map (DITA only)
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.
Styling actions
Most common styling actions, such as Bold, Italic, Underline.
Insert actions
Actions that allow 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.

Right Side Panel (Review View, Attributes View, Validation View)

The editor also includes a menu panel on the right side with some helper views. If the menu panel is not displayed, click the arrow button () on the far right side of the editor. Most Reviewers will only be interested in the Review view. It displays the tracked changes and comments that have been added in the document and each change or comment includes actions such as Reply, Mark as Done, Edit, or Remove.

Advanced users might find the Attributes or Validation views helpful. The Attributes view allows you to see and edit the attributes of a selected element and their values. The Validation view provides information about validation problems and offers proposals for resolving them (if a Quick Fix is available).

Referenced Content

If a DITA document contains references to other content (for example, through a conref or conkeyref), as long as the Content Author specified a Context DITA Map when creating the task, the referenced content will be displayed in the document but it will be displayed in with a gray background and cannot be edited directly in the document. It can only be edited from the source document. To edit the source of the referenced content, click the icon at the beginning of the referenced content. This will display the source document above the task files on the left side of the interface and automatically open it in the editor, but in read-only mode. To work with the content of this source document, click the Start editing link at the top-right corner of the editor. Once you start editing the source document, it becomes part of the task files and the Content Author will see your changes and comments in this document along with any changes or comments in the rest of the task files.

Saving Files

All of your changes are saved automatically on the Oxygen Content Fusion server. If you want to save a file manually, use the Ctrl + S (Command + S on OS X) key shortcut. You can also download the file to your local file system by selecting More / Download.

Unlocking Files

While your editing a file, the file remains locked and others cannot edit it. The file will be unlocked when you close the editor by navigating back to the Task Details page or close the browser. Using the Finalize Review button will also automatically navigate back to the Task Details page and unlock the file.

If you remain inactive for more than a few minutes, the editor switches to read-only mode and the file is unlocked, which means other users have access to edit it. If other users do not start editing the file, or once they are finished and it becomes unlocked, a Resume Editing button will be displayed that can be used to switch back to editing mode. Note that the lock status is automatically refreshed every minute, so if another user unlocks a file, you may not see the status change for a minute unless you refresh the page manually.

Finalizing Your Changes

Once you are done reviewing all files attached to the task, click the Finalize Review button in the left panel. Using this button is a quick and easy way to let the Content Author know that you are finished with review process. Keep in mind that all files attached to the task should be reviewed before using the Finalize Review button because it applies to the whole task and not to individual files.

For more advanced information about using the visual editor, see the Editing Documents section of the Oxygen XML Web Author online user manual, but keep in mind that this version of the editor is slightly different than the full, licensed version of Oxygen XML Web Author.