Add comments to text in review

You can share your comments directly in the content of a component by selecting the text. You can view comments from other reviewers assigned to the review and reply to their comments. If you have comment-only permissions, you won't have access to the editing options on the toolbar.

Tips and Tricks

  • You can also add comments in the Component Discussions pane.

    Adding a comment outside of the review editor is helpful when:

    • A component has a Scope of Context Only.
    • There are too many comments in the component already. (Text added to the Component Discussions pane is not shown in the review editor.)
    • For steps on using this feature, read Add comments using the Component Discussions pane.

  • If you start on a review but need to stop before it's done and finish it later, you can:

    1. Save your changes .
    2. Do one of the following:
      • Close the tab
      • Click Save for Later

    Saving your changes and closing the review doesn't update the progress shown for the review on the Dashboard or the Review Management tab. This percent only changes when an entire task in the review is completed, such as when you click Complete Review.

  • Regardless of your permissions, if a topic contains a link (cross reference or key reference) to another component, when you click the link:

    • If the target component is not also included in the review, you can only open it in a read-only viewer from a review.
    • If the target component is also included in the review, you can open it to comment or edit it from a review.
  • Regardless of your permissions, if a topic contains a Content Reference, you cannot open the topic that contains the reference in a review.
    • The icon that you use to open the topic with the reference () is only available when editing the topic, and is not available in a review.
    • The referenced content is shown with a grey background.
    • You can't comment on the referenced content.
    • No matter your permissions, you cannot edit the referenced content.

To review a component using only comments in the Review editor:

  1. In the email notification, to open your review assignment, click the review link.
  2. In the Review Components pane, to open the component in the review editor, click a component title.
    Tips and tricks
    • component_state_approved You can track your progress through the list of review components using the green circle next to the component name. You can fill in the circle to mark a component as done when you complete it. Keep in mind this is for your own reference. Selecting or clearing the green circle does not trigger any action in Inspire.
    • If a component is Context Only and can't be commented on or edited you won't see a green circle.
    • If a component has an attachment you see a black paper clip. If it is an attachment you see a green paper clip.
    • If a component is checked out to you a user icon is shown .
    • You can tell if the component is a topic () or an image () by looking at the icon before the component name.
    • If you're participating in an interactive review, a component may be locked by another reviewer. To add comments to a locked component, follow the steps in Request to check out a component for review. You must wait until you the component is unlocked before continuing to the next step.
  3. To add a comment, select text or place your cursor at a location where you want to insert a comment.
  4. Click Add Comment or use the keyboard shortcut Ctrl + Alt + M.

    Text that has a comment is highlighted in purple. The Review panel on the right side of the editor shows the name of the user who added the comment, the date and time it was added, and the comment. You can select a comment by selecting the highlighted text in the editor or using the Review panel.

  5. To reply to a comment, in the Review panel, in the comment's box, click the reply arrow .
    1. On the Add Reply dialog, enter your text.
    2. Click OK.
  6. To edit a comment, in the Review panel, in the comment's box, click the pencil icon . You can also go to the toolbar and click Edit Comment.
    1. On the Edit Comment dialog, edit the text.
    2. Click OK.
  7. To fade out comment text to show you've resolved the issue in the comment, click the Mark as Done toggle .
    1. To re-activate the comment so you can reply or edit it, click the Mark as Done toggle again.
  8. To delete a comment that you created, it must have no replies. You can delete a comment in the following ways:
    • In the editing pane, place your cursor in the highlighted content. On the toolbar, click the Delete Comment button.
    • In the editing pane, hover your cursor over the highlighted content, and in the pop-up window click Remove.

    • In the Review panel, in the comment's box, click the Remove icon .

  9. If you need to undo a change, in the toolbar, use the Undo button. To redo a change use the Redo button.
  10. To scroll through next and previous comments, in the toolbar, use the arrow buttons
  11. To show and hide tags, in the toolbar, click the Tags display mode menu , and then select one of the following:
    1. Full tags
    2. Full tags with attributes
    3. No tags
  12. To change the size the font displays in, in the toolbar, click one of the following:
    1. Increase font size
    2. Decrease font size
    3. Reset font size
  13. To see different versions, in the toolbar, click the Track changes view menu , and the select one of the following:
    1. View all changes/comments
    2. View final
    3. View original
  14. To see only content that has profiling attributes attached to it, click and then on the Filter Profiling Attributes, select the checkboxes for the attributes you want to see.
  15. To display text with all types of associated attributes, click . To hide text with associated attributes, click .
  16. After you finish adding comments, click Save.
  17. To track your progress in the review, select the circle next to the component in the Review Components pane to mark items you have completed.
    A review coordinator might include components for context only. You can view these topics in the editor, but you can't add comments. Context-only components don't have a circle to track your progress.
  18. Repeat steps 2 through 17 for all components in the review.

    To stop and finish a review later, you can:

    1. Save your changes .
    2. Do one of the following:
      • Close the tab
      • Click Save for Later
  19. After you finish adding comments to all components in the review, click Complete Review.
  20. On the confirmation screen, click Yes.

    After you complete your review:

    • Your review is locked and you cannot make any other changes.
    • The Review Coordinator receives a message that you've completed your review.
    • On your Dashboard, in My Reviews, the completed review is no longer listed.

    If you want to re-open your review to make additional changes:

    • At least one other reviewer must still be working on their review.

      • To find out who else is reviewing components:

        1. Open the review from your email notification.
        2. On the right side, open the Collaboration panel.
        3. Look in the Reviewers list.

        You can see if a reviewer still has a review in progress (Reviewing).

    • Ask the Review Coordinator or an administrator to re-open your review.
      • To send email to the review Coordinator:
        1. Open the review from your email notification.
        2. Go to the left side panel.
        3. Look in the Review Details panel.
        4. Click on the name following the Coordinator label.
        5. In the email form that opens, fill out the fields to request that your Completed review be re-opened (the fields will vary depending on your email app).
        6. In the email form, click Send.