Skip to main content

Comments for Feedback in Review Mode

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.

Review interface with content on the left and the comments sidebar on the right.

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:

  1. 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.

    Comments section. A comment edit box is shown, ready for a user to enter a new comment.

    Note

    You can add comments for most types of content. However, comments for programlisting elements are not currently supported.

  2. 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:

  1. 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.

  2. Select the Edit option, make your changes, and then select Save.

    Comments section shows two comments. A callout arrow points at the Edit option below a comment.

To reply to a comment that someone else has made:

  1. In the comments sidebar, select the comment that you want to reply to.

  2. Select the Add option, and then enter your reply and select Save.

    Comments section. A callout arrow points to the Add option below a comment.
    Comments section. There is an existing comment and the current user is adding a reply in a comment box below.

To find the content that relates to a comment, select the comment speech bubble in the Comments sidebar. Paligo then shifts the focus to show the relevant piece of content, and a highlight on the content block flashes on and off briefly.

comments-question-answer-reply.jpg

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:

  1. Select the menu icon in the top corner of the comments sidebar.

    Comments section. A callout box highlights the menu in the top-right corner.
  2. 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.

    Comments menu has options for archiving and restoring comments

Note

This section only applies to Authors who are responsible for addressing any issues that come up in Reviewers' or Contributors' feedback. Reviewers and Contributors cannot set the state.

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 is irrelevant to the topic

  • Made the changes that were suggested in the comment.

It is important to set the status of comments that you have dealt with, as this lets other users know which comments still need to be looked at.

To change the state of a comment:

  1. In the comments sidebar, select the comment that you want to change.

  2. Select the cog icon on the bottom corner of the comment box.

    Either:

    • Select the cog icon on the bottom corner of the comment box. The options in this menu will apply to all of the comments in the current paragraph.

      Cog icon selected for a paragraph's comments. There is a menu with Done, Rejected, Mark as read, and Unset status.
    • Select the Status option for a specific comment. The options in this menu only apply to that specific comment and do not affect the state of any other comments in the paragraph.

      Status option selected for a specific comment. There is a menu with Done, Rejected, Mark as read, and Unset status.
  3. Select the state.

    • 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 state. For example, you could unset a done state 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).

Archived comments are shown in monochrome black and white.

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 for Assignments.

Show/Hide Archived Comments

Archived comments are not shown in the comments sidebar by default. But you have the option to display them if you want.

  1. In the comments sidebar, select the menu button in the top-corner to display a menu.

    Comments section. A callout box highlights the menu in the top-right corner.
  2. Select Show/hide archived comments to toggle the visibility of the archived comments on and off.

Restore Archived Comments

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.

  1. In the comments sidebar, make sure the archived comments are shown.

  2. Select the archived comment that you want to restore and then select the Restore option.

    Archived comments in the Comments sidebar. A callout arrow points to the Restore option.
  3. Choose the date range. Paligo will restore all of the archived comments that were made in the date range you specify.

    Restore archived comments dialog has date range settings
  4. Select Restore.

Tip

if you want to restore all archived comments in a topic, select the menu button in the top corner of the comments sidebar. Select the Restore all comments option, choose the date range and then select Restore.

Comments menu has options for archiving and restoring comments

Archive a Comment Manually

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:

  1. In the comments sidebar, select the comment that you want to archive.

  2. Select the archive button and confirm that you want to archive the comment at the prompt.

    Comments in the Comments side bar. A callout arrow points to the Archive option.

Tip

If you want to archive all comments in a topic, select the menu button in the top corner of the comments sidebar and then select Archive all comments.

Comments menu has options for archiving and restoring comments