Learn about reviewing content

When you are assigned content to review, Inspire sends you a notification. From the link in the notification you can open the content and see a list of components included in the review. You can use the list to see which components can be reviewed and which are for reference only. An administrator and review coordinator can configure if you can only add comments or also edit content with tracked changes.

Any kind of content can be added to a review, including:

  • DITA or DocBook components
  • Components attached to DITA or DocBook components
  • Binary components (images, PDF files, WORD files)
    • Binary components (images, PDF, WORD doc) open in a viewer regardless if the state is In Review or Context Only.
  • Map components

After a component is added to a review and a coordinator creates the review, all components in the review are locked in the Components browser, including binary components.

How do I know what I can review?

How you can review the content varies depending on the following factors:

  • ReviewCommentOnly. If an administrator restricts all Inspire reviews to accept comments only. (No editing is allowed.)
  • Tracked changes for editing. If the comment restriction is not set, an admin or review coordinator can allow Tracked Changes for an entire review. (Not at a component level.)
  • Component type
    • Components that are unlocked are added as In Review.
    • Components that are locked are added as Context Only.
  • Attachments
    • Components that are attached to a file in review will open as one of the following:
      • If the attachment is a binary component, it is added as In Review.

      • If the attachment is not locked, it is added as In Review.

    • Components that have attachments will open as one of the following:
      • If the attachment is a binary component, it is added in one of the following ways:

        • If the binary is unlocked, it is added as In Review.

        • If the binary is locked, it is added as Context Only.

      • If the attachment is not locked, it is added as In Review.

  • Lock state

    As a basic rule, if a component is locked, it opens in a read-only viewer.

    A components that is unlocked always open in the review editor.

    • Components with a red system lock always open in a read-only viewer.
    • Components that are locked by you always open in a read-only viewer.
    • Components that are locked by another user always open in a read-only viewer.
    • Components that are unlocked always open in the review editor.
    • Components that are approved and unlocked always open in the review editor.
    • Components that are approved and locked always open in a read-only viewer.

    Use the following table to see how you can review a component in all the various stages:

You can use the icons and the Review Scope column to tell whether a reviewer will be able to open a component and review it in the Oxygen editor or only refer to it in a read-only viewer.

On the Create Review screen, in the Review Scope column:

  • In Review. These components can be commented on by default. A review coordinator or administrator can add change tracking (editing) abilities per reviewer.
  • Context Only. These components are opened in a read-only viewer and reviewers can't comment on or edit the text in the Oxygen review editor.
    • Locked components can be added explicitly by you or automatically included by Inspire because they are attached to a component in the review.
      • If a component is an attachment, you see a green paper clip.
      • If a component has an attachment, you see a black paper clip.
    • These components are intended for reference to aid the reviewers.
    • You can see details about the binary file.
    • You can download the binary file.
    • You can open the left side Collaboration panel and use the Component Discussions pane to comment on components added as Context Only.

A review coordinator or administrator can change the Scope a component that is In Review to Context Only by clearing the checkbox in the Review column.

A review coordinator or administrator cannot change a component that has a scope of Context Only to In Review. Instead, unlock a component to include it as In Review.

Reviewing using comments

Any user who has access to a review can add comments.

  • If a component has a Scope of Context Only, comments must be added in the Collaboration panel.

Add comments directly to content

In the review editor, you can select the text and use the comment options in the toolbar.

You can manage comments in the right pane by clicking .

Add comments in the Component Discussions pane

Adding a comment outside of the component text 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.)

Each component in a review has its own Component Discussions pane. Select the component you want to discuss first, and then open the Collaboration panel, go to the Component Discussions pane, and add text.

This pane is always available in a review regardless of component type or user permissions.

Add comments for the entire review

If you have feedback that isn't specific to one component, you can start or join a discussion about the entire review.

Open the Collaboration panel, go to the Discussions pane, and add text.

This pane is always available in a review regardless of component type or user permissions.

Reviewing with tracked changes

When you're working in the Oxygen-based review editor, you can manage file options, customize your view, work with tags, and display profiling attributes.

You can access these options in the review editor's toolbar.

The options you see will depend on whether the review coordinator limits your review to comments only, or allows you to also edit text.