Edit online

Review View

The Review view is an independent panel, available both for built-in and custom XML document frameworks. It is designed to offer an enhanced way of monitoring all the changes that you make to a document. This means you can view and manage highlights, comments, and tracked changes using a single view.

The Review view is useful when you are working with documents that contain large number of edits. The edits are presented in a compact form, in the order they appear in the document. Each type of edit is marked with a specific icon. This view and the editing area are synchronized. When you select an edit listed in the Review view, its corresponding fragment of text is highlighted in the editing area and the reverse is also true. For example, when you place the cursor inside an area of text marked as inserted, its corresponding edit is selected in the list.

You can use this view to quickly navigate through changes and it includes some useful hover actions and contextual menu actions to help you manage changes, comments, and highlights. You can also search for specific changes or comments and it includes some filtering options (for example, you can filter it to only show certain types of edits or to only show edits for a particular author).

Activating the Review View

To activate the Review view, do one of the following:

Click the Manage reviews button on the toolbar.
Right-click anywhere in a document and select Review > Manage reviews.
Open it from the Window > Show View menu.

Review View Toolbar Actions and Settings

The upper part of the view contains a filtering area that allows you to search for specific edits. The filter field also includes a search history drop-down list. The toolbar also includes Previous and Next navigation buttons and a Settings menu button.

Previous

Use this button to navigate to the previous review item.

For DITA projects, as long as the Link with Editor toolbar button is enabled in the DITA Maps Manager, if you reach the first review item in the document, clicking this button will open a dialog box asking if you want to open the previous document (from the current DITA map hierarchy) that contains review items. This default behavior can be changed by choosing one of the options in the When navigating items in the Review view and you reach the last/first item section of the DITA preferences page.

Next

Use this button to navigate to the next review item.

For DITA projects, as long as the Link with Editor toolbar button is enabled in the DITA Maps Manager, if you reach the last review item in the document, clicking this button will open a dialog box asking if you want to open the next document (from the current DITA map hierarchy) that contains review items. This default behavior can be changed by choosing one of the options in the When navigating items in the Review view and you reach the last/first item section of the DITA preferences page.

Settings

The Settings menu includes the following options:

Show highlights: Controls whether or not the Review view displays the highlighting in your document.
Show comments: Controls whether or not the Review view displays the comments in the document you are editing.
Show track changes: Controls whether or not the Review view displays the inserted and deleted content in your document.
Show reviews in read-only content: Controls whether or not the Review view displays review items from content referenced with a @conref or @conkeyref attribute.
Show review time: Displays the time when the edits from the Review view were made.
Sort by date: Expands to offer the following sorting options: Oldest to newest, Newest to oldest, and No sorting.
Configure review options: Opens the Review preferences page where you can configure various options for review information.

Hover Actions in the Review View

You can use this view to easily manage changes, highlights, and comments that have been added by you or other users. The following actions are available when you hover over the changes in the Review view:

Remove: Available for highlights and comments presented in the Review view and it removes the particular highlight or comment from your document and moves to the next change.
Accept: Available for inserted and deleted content presented in the Review view and it accepts the particular change in your document and moves to the next change.
Reject: Available for inserted and deleted content presented in the Review view and it rejects the particular change in your document and moves to the next change.

Contextual Menu Actions in the Review View

Depending on the type of an edit, the following additional actions are available in the contextual menu of the Review view:

Reply: Opens the Reply dialog box where you can add a reply to comment or change. The replies are displayed with an indentation in this view.
Mark as Done: Toggles the comment or change as being done and grays it out. You can mark a whole discussion thread as being done by selecting the action on the first (parent) comment in the thread.
Show Comment: Available for comments added by other users and you can use this option to view it in a Show comment dialog box.
Edit Comment: Available for comments you have added and you can use this action to edit a comment.
Remove Comment: Use this action to remove the selected comment.
Show only Reviews by '<author name>': Use this action to filter the edits to only show them for a certain author.
Remove All Comments: Use this action to remove all the comments that appear in the edited document.
Change Color: Available for highlights and it opens a palette where you can choose a new color for the highlighted content.
Remove Highlight: Available for highlights and you can use this action to remove the selected highlight.
Remove Highlights with the Same Color: Available for highlights and you can use this action to remove all the highlights with the same color from the entire document.
Remove All Highlights: Available for highlights and you can use this action to remove all the highlights in your document.
Accept Change: Accepts the selected change and moves to the next change.
Reject change: Rejects the selected change and moves to the next change.
Comment change: Available for insertions or deletions and you can use this option to add a comment for the particular change.
Accept all changes: Accepts all the changes in the current document.
Reject all changes: Rejects all the changes in the current document.

Resources

For more information about the Review view, watch our video demonstration: