Complete a review assignment

In the Review Components pane, you can see a list of components you've been asked to review. From this list you can select a component to open in the Editor pane.

Make sure you get your work done on time by checking the Review Details pane. Here you'll find any due dates the coordinator set, as well as who the coordinator is in case you need more time to complete your review.

When you finish reviewing a component, come back to this pane to let the coordinator know you're done with your review. You use the Complete Review button to submit your comments and changes. This completes your review and you can't edit that component again.

When you open a component, you'll see the text you're reviewing in the Editor pane. Here you can add comments, make text changes, and view comments or changes from other reviewers.

If a review coordinator limits you to making comments, you won’t be able to edit the text directly. You can contact the review coordinator if you need this ability.

Depending on your reviewer permissions, you may see the different options in the Review editor toolbar.

If you have Comment Only permissions, you can:

If you have Track Changes permissions, you can also:

• Edit and format text
• Enter new text
• Delete text
• Filter profiling attributes
• Show and hide profiling attributes

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 referenced component from a link in the review.

• The icon that you use to open the topic with the reference () is only available when editing the topic.

  

• The icon that you use to open the topic with the reference () is not available in a review.

  

• The referenced content is shown with a grey background.
• You can't comment on the referenced content.

Authors can change the appearance of text in a component to show or hide content that they mark as conditional.

• Authors identify conditional text by adding profiling attributes.
• This lets them produce more than one version of a document when the versions differ in minor ways.
• For example, if one component contains content for both a repair technician and student, the author can apply different profiling attributes to the content for the different audiences. Then, if a reviewer only needs to see the repair tech content, the student content can be hidden using a filter for profiling attributes.

When you open a review, you may see:

• A yellow banner at the top of the screen.

  

• Blank spaces. This is where content is not being shown because it didn't have the profiling attribute applied that the review coordinator specified.

This tells you:

• An author has identified conditional text using profiling attributes.
• A review coordinator has filtered the component's content to show you text that matches specific profiling attributes.
• In the yellow banner, you see:
  • The name of the group of profiling attributes in bold. In the graphic above, this is Users.
  • The name of the specific profiling attribute in square brackets. In the graphic above, this is [Repair Tech].

Any text that does not have profiling attributes applied is always shown to reviewers.

If you don't want to see profiling attribute details in your review:

1. Above the editor toolbar, in the informational bar, click the close icon.

To find out who else is reviewing a component, look in the Collaboration pane.

• You can see if a reviewer has completed their review.
• You can send a reviewer an email
• You can use the Action menu to send them a notification in Inspire.

You can also start a discussion with all reviewers at once using the Discussions pane.

• You can continue a discussion no matter what state the review is in.
• Discussions are limited to 2000 characters, but you can create another one to keep the discussion going.

Inspire now supports concurrent editing so multiple Inspire users can edit the same component at the same time. This is useful when you need to have multiple team members complete a review simultaneously. For more information, read Share an editing session.

Now you can add topics to a review if they are in a map but not in the review.

In the example image above:

• A topic in the map called Chpt3_Install_battery_card is in the map that's being reviewed
• The Chpt3_Install_battery_card topic is not in the list of Review Components, which means it isn't included in the review.

If you're reviewing a map component, and you identify changes that need to be made in referenced component:

• You can add that component to the review and make changes, even if you aren't a review coordinator or administrator.
• You must be added to both of the following Collaborative Review module properties:

  • can_add_component_to_review

  • can_add_component_to_review_from_map

• The review must be in a State of Reviewing.
• The map containing the component must be included in the review.
• If review locks are configured, after you add the component to the review it is locked and included in the review.

For steps on adding a map component to a review, read Add map topics to a review.

If you want to allow a non-administrator user to add a component to the review by editing the review Details:

• The user only needs the following Collaborative Review module property: can_add_component_to_review.
• For more help, Admins can read Allow users to add a component to a review.
• Reviewers can read: Add a component to a review.

Completing a review assignment means you have referenced, commented on, or edited all topics in the Review Components list and selected the Complete Review button.

If you do any of the following, you haven't completed your review yet:

• Only review one component and save your changes.

  

• Review a few or all components and select Save for Later.
• Review all components, select the green circle in the list, and close the review tab or Inspire without selecting the Complete Review button.

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.