Skip to main content

Working in Review View

Paligo has a review view for providing feedback on content. Before you start reviewing content, take some time to look at the Reviewer Instructions, so that you understand the process.

Both Reviewers and Contributors can be sent Review assignments, the difference is that Contributors can edit and add content. Authors and Administrators can also switch to Review Mode from another mode.

Content shown in review mode. The content is shown on the left and the comments are shown in a side-bar on the right.

Tip

Learn more about available user types in Paligo, see User Types.

When you open your assignment in Review View the functionality is limited to entering feedback comments. If the content contains filters and / or variables, you should Choose the Profile Settings prepared for the assignment. It can either be preset by the author or selected from the Favorites tab in the Settings.

Review_View_Interface_small.png
  1. Assignment_Button_ContributorEditor_small.png Use the Assignment button to end the assignment, either by approving it or suggesting changes. The author will not be notified until you end the assignment.

  2. View selector - It shows which view you have entered. If you have an author license, you can use it to switch between the different views available in Contributor Editor.

  3. Settings_small.png From the Settings menu you choose Profile settings and Share documents.

  4. Variables are shown with dark gray highlights.

  5. From the Comments menu you set your Notification preferences, Show or hide archived comments and Archive all comments.

  6. The comments sidebar is where you can see and add feedback comments. If you select a comment, it will flash to show its location it in the topic. You can also edit and delete your own comments if needed.

  7. Content that has a feedback comment is highlighted in yellow.

Note

If your user account has author permissions, you can enter Paligo's full editor.

When you are reviewing topics, you may find it helpful to display the table of contents (TOC). The TOC shows you the structure of the content you have been asked to review, and the topic you are viewing is highlighted.

To show and hide the TOC, select the menu icon to the left of the topic you are reviewing. The menu icon toggles the TOC between shown and hidden.

The review mode display. On the left is a sidebar. An arrow points to the sidebar's menu icon and another arrow points to a topic in the table of contents. The topic has a gray highlight. On the right-side of the display is the content.

The TOC is shown on the left side in review mode. A gray highlight shows the topic you are currently viewing.

When you view content in Contributor Editor, the table of contents (TOC) shows the changed topics in the assignment. The topic you are working on is highlighted. This is helpful when you need to know how a topic relates to other topics in the assignment, but sometimes you need more context - you need to know where a topic fits into the publication as a whole. For example, if you are sent a single topic for review, the TOC only shows that topic and so you have no idea where that topic fits into the overall structure of the published documentation.

topic-toc-no-context-update_small.png

An assignment for a single topic means that the TOC only shows that topic, with no context.

But with the view content in context feature, you can set the TOC to load the full publication and show where a topic is used. So even if the assignment is to edit one topic, the TOC will show the full publication and highlight the topic's location in the structure.

context-shown-update_small.png

With view content in context, the TOC loads the full publication and shows the location of the currently viewed topic.

Note

The view content in context feature only works if the assignment is created from a "fork" in a publication. To find out more, see Author Instructions for Review Assignments.

To use the view content in context feature:

  1. Open the assignment with the link in the assignment invitation email or via the Assignments Panel on the Dashboard.

  2. Hover the cursor over any part of the content and then select the View in context icon.

    Content in review shown. The content is highlighted and a toolbar is shown. The view in context option is highlighted.

    When you select the icon, the page reloads.

    Note

    If the Contributor Editor toolbar is visible, you have to close the topic with the X in the right corner of the toolbar, for the icons to appear when hovering over the content.

  3. Select Show / Hide table of contents (TOC) to the left of the content. TOC_ContributorEditor_small.png

    The TOC highlights the publication in blue and the currently viewed topic in dark blue, with a gold star.

    Table of contents shows context. Publication is highlighted in blue, the currently displayed topic is highlighted in dark blue with a gold star.

Tip

To exit the "In context" view, select Show / Hide table of contents. TOC_ContributorEditor_small.png.

Each time you select the view in context icon, it toggles the TOC's "in context" view on and off.

You can compare the current version of the content with an earlier revision, so that you can easily see what has changed. For example, you can compare the current version and the version for the previous review or the last major release.

Each version is called a snapshot and it is a record of the content at a specific point in time. Snapshots are made automatically at certain stages in the assignment workflow. We also recommend that you make some snapshots manually at certain stages in your work.

Note

The Single Panel Comparison highlights the changes in a combination of the current version and the snapshot. To be able to choose a snapshot, the content must have gone through reviews earlier and that snapshots have been created either automatically and / or manually.

Tip

To turn off the comparison and only see the latest version:

  1. Select Settings in the top-right corner. Settings_small.png

  2. Select Compare version and choose Show current revision.

  1. Display Review View from the assignment link or via the Assignments Panel.

    Paligo dashboard. The Assignments panel is highlighted, showing that the user has been assigned to review, contribute, and translate assignments.
  2. Select Settings in the top-right corner. Settings_small.png

  3. Select Compare versions. Compare_Versions_ContributorEditor_small.png

    Compare_Snapshots_ContributorEditor_small.png
  4. Select the snapshot version that you want to compare with the latest version of the content.

    The page reloads to show you a comparison of the snapshot and the latest version. It is a combination of both revisions and highlights the changes that have taken place.

When someone sends content for you to work on as an assignment, they should set up any profiles that are needed and save them as a favorite. They should also advise you which favorite to choose. This information should be included as a comment with the assignment email.

Note

If you are an author and you need to set up a favorite profile, see Favorite Profiles.

If the content uses filters and / or variables, the author should have created a favorite profile and provided you with information about which profile to use. If they have not provided this information, it is possible that the content does not use filters or variables and you can skip this step. You may want to double-check with the author first, as if there are profiles, they are designed to show / hide information, so you may see content that is not intended for you.

Cog menu in review mode / edit mode has a profile settings option.
profile-settings-review.jpg

On the profile settings dialog:

  1. Select the Favorites tab and then select the appropriate profile.

    If the author has not provided information about which profile to use, contact them to find out. The content you see in the assignment could change depending on which profile you use, so it is important to choose correctly. If there are no profiles saved as favorites, the author has not set up the profiling as recommended. They should refer to Author Instructions for Review Assignments.

  2. Select Apply.

  3. Close the profile settings dialog and start working on the content (see Working in Review View).

Note

The profile settings tell Paligo which variable values to use and which filters to apply.

Variable values are pieces of content that can show different terms in different scenarios. For example, a product name may change depending on which product the topic is for.

Filters are pieces of content that are included or excluded in different scenarios. For example, a paragraph may be included if the audience is experts but excluded if the audience is beginners.