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.
Tip
Learn more about available user types in Paligo, see User Types.
When a Paligo author creates an assignment or Share Content (without assignments), the assignee receives an email invite to review, translate or contribute to the documentation.
The Assignment Types and User Types determine which view is opened, see Review View Features, Edit View Features and Translation View.
Note
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, see Choose Profile Settings and Favorite Profiles.
An assignment can be opened in different ways:
-
Select the link in the email invite.
-
Select the assignment in the Assignments Panel.
As an Author or Admin, you can access the assignments in the full Paligo editor to view feedback comments, review, edit or translate content. To find out how to view feedback comments, see Comments in the Full Editor. After a contribution assignment, it is a good idea to use the validation features in the full Paligo editor to check the structure of the content is valid, see Validation.
-
Select the Dotted Menu (...) for the topic in Content Manager
-
Select Edit and choose Review, Contribute or Translate to open the assignment.
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 Profile Settings prepared for the assignment. It can either be preset by the author or selected from the Favorites tab in the Settings.
-
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.
-
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.
-
From the Settings menu you choose Profile settings and Share documents.
-
Variables are shown with dark gray highlights.
-
From the Comments menu you set your Notification preferences, Show or hide archived comments and Archive all comments.
-
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.
-
Content that has a feedback comment is highlighted in yellow.
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 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.
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.
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:
-
Open the assignment with the link in the assignment invitation email or via the Assignments Panel on the Dashboard.
-
Hover the cursor over any part of the content and then select the View in context icon.
When you select the icon, the page reloads.
-
Select Show / Hide table of contents (TOC) to the left of the content.
The TOC highlights the publication in blue and the currently viewed topic in dark blue, with a gold star.
When working on a review assignment in Contributor Editor, you can compare the live content to any previous made snapshot of the content.
A snapshot is an archived version of the content at a particular point in time and useful when you compare different versions. 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.
The Single Panel Comparison highlights the changes in a combination of the current version and the snapshot. To be able to choose a snapshot, there must be snapshots automatically or manually created from a previous version.
When comparing reviews, you can Add, Edit or Reply to Comments in Review View. To be able to edit the live content while comparing, you need to enter Edit View. Learn more about User Types.
Tip
To turn off the comparison and only see the latest version:
-
Select Settings in the top-right corner.
-
Select Compare snapshots and choose Show current revision.
-
Display Review View from the assignment link or via the Assignments Panel.
-
Select Settings.
-
Select Compare snapshots.
-
Select the snapshot version that you want to compare with the current version of the content.
The page reloads to show you a combination of both versions and highlights the changes that have taken place.
-
Table of Contents shows all subtopics from snapshot version and latest version.
-
Blue bold topic means that the topic has been Added in the latest version.
-
Italic topic means that the topic has been Deleted in the latest version.
-
Bold topic means that the topic has been Changed in the latest version.
-
-
Text colors show changes in the topic or publication content.
-
Red strikethrough is content that has been Deleted in the latest version.
-
Blue text is is content that has been Added in the latest version.
-
-
Colored vertical change bars show if entire topics, block elements, tables or images are different in the latest version.
-
Red bar to the right of the content show that the topic has been Deleted in the latest version.
If the red bar is positioned to the left it visualizes that a block element, table or image has been deleted.
-
Blue bar to the right of the content show that the topic has been Added in the latest version.
If the blue bar is positioned to the left it visualizes that a block element, table or image has been added.
-
Orange bar show that the topic has Changed in the latest version.
-
-
When an assignment is sent out, any settings needed should be saved as a Favorite Profilesby the author. You should also be advised which favorite profile to choose. This information could be included as a comment in the assignment email.
If 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, because if there are profiles designed to show or hide information, you may see content that is not intended for you.
Tip
If you are an author and need to set up a favorite profile, see Favorite Profiles.
To choose the profile settings for your assignments
-
Select Settings.
-
Select Profile settings.
-
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.
-
Select Apply.
-
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.
To provide feedback in your review or contribution, use comments. You can view any existing comments in the comments sidebar, and you can add new comments and reply to comments.
You can also set up notifications so that Paligo emails you when new comments are made. For old comments, there is an archiving feature, which lets you save and hide those comments that have been dealt with.
Tip
You can use "mentions" to notify other people of your comments directly, just like on social media. To send a mention notification to another Paligo user, use the @ symbol and then start typing their name. You can select the person you want to notify from the dropdown menu.
To add a new comment:
-
In the main body of the topic, select the content block that you want to comment on.
Paligo adds a new comment box to the comments sidebar.
-
Add your feedback to the box and select Save.
Paligo adds a yellow highlight to the selected content, so that other users know that a comment has been made.
If you want to change a comment you have made, you can edit it:
-
In the comments sidebar, select the comment you want to edit.
Note
If the comment has been archived, you will need to restore it before you can edit it.
-
Select the Edit option, make your changes, and then select Save.
To reply to a comment that someone else has made:
The comments sidebar shows all comments by default. If you prefer, you can filter the comments sidebar so that it only shows comments that meet certain criteria based on date, user and / or the status of the comments. For example, you could filter the comments sidebar so that it only shows the comments from one specific reviewer, made between January and March, and with a status of Rejected.
To filter the comments:
-
Select the filter icon at the top of the Comments sidebar.
The filter settings appear in an extra section. By default, the filter settings remain on show, so that you can see there are filters in place.
-
Enter the filter settings you want to use.
-
Select the Start Date and End Date fields to display calendars. Use the calendars to set the date of the filter.
-
Select the names of the users whose comments you want to see. Check the box next to a user's name to see their comments or clear it to hide their comments.
-
Select the Status of the comments that you want to see. Check the box next to the status name to see comments with that status. Clear the box to hide comments with that status.
Paligo applies the filters and displays the comments that meet the filter criteria. It hides any comments that do not meet the criteria.
-
You can set Paligo to send you an update notification when there is a new comment or when you are "mentioned" in a comment. The notification is sent to you via email, using the address that is associated with your Paligo user account.
To set comment notifications:
-
Select the menu icon in the top corner of the comments sidebar.
-
Use the Comment Notifications options to set your preference:
-
Mentions only - you will only receive a notification email when your username is mentioned in a comment.
-
All comments - you will receive an email each time there is a comment on this topic.
If you choose All comments, you are "following" the comments. Paligo will send you a notification either immediately or at a regular interval, and you can control this by setting the notification frequency in your user profile. You can change the frequency if required, see My Profile.
-
This section only applies to authors who are responsible for addressing any issues that come up in the reviewers' or contributors' feedback. It is important to update the status of comments that you have dealt with, as this lets other users know which comments still need to be looked at.
When you see comments that are left by other users, you can update the comment to show that you have:
-
Read the comment
-
Rejected the comment, perhaps because the comment is incorrect or irrelevant to the topic
-
Made the changes that were suggested in the comment.
To change the state of a comment:
-
In the comments sidebar, select the comment that you want to change.
-
Update the status of the comment by:
-
Selecting the Status option for a specific comment and do not affect the state of any other comments in the paragraph.
-
Selecting the settings icon in the bottom corner of the comment box to apply it to all of the comments in the current paragraph.
To the left - change status for an individual comment. To the right - change the status for all comments in the current paragraph.
-
-
Select a status:
-
Done - Use if you have completed the work suggested in the comment.
-
Rejected - Use if you think the comment is incorrect or is suggesting inappropriate changes.
-
Mark as read - Use if you have read the comment , but have not taken action on it.
-
Unset status - Use if you want to cancel the comment's current status so that other users know the comment needs to be looked at again.
-
Archived comments are old comments that have been accepted or are automatically archived when an assignment ends or begins. By default, they are not shown in the comments sidebar, but you can choose to display them if you want, and they appear as monochrome (no color).
Typically, you will only use the archive comments features to view or hide old archived comments. But there may be times where you need to make a change to an archived comment or need to revert it back to a regular comment, in which case, you will need to restore it.
If your Paligo is not set up to archive comments automatically, the comments will always be "regular" comments. In this case, you can archive comments manually, if needed.
Note
To find out how to set up automatic archiving, see Automatically Archive Comments.
Archived comments are not shown in the comments sidebar by default. But you have the option to display them if you want.
If a topic has archived comments, you can choose to restore all of the comments within a selected time range, such as a day. When you restore archived comments, they become regular comments again, and so can be edited.
-
In the comments sidebar, make sure the Show or Hide Archived Comments.
-
Select the archived comment that you want to restore and then select the Restore option.
-
Choose the date range. Paligo will restore all of the archived comments that were made in the date range you specify.
-
Select Restore.
If your Paligo assignments are not set up to archive content automatically, the comments will remain as "regular" comments. However, you can archive comments manually if needed.
To archive a comment:
Comments
0 comments
Article is closed for comments.