Gretyl's Portal

Heretto Help

Show Page Sections

Comments and Suggestions

Add comments and suggestions to documents to leave feedback on the content. You can add comments and suggestions in the Content Editor and interact with them in the Review tab.

Comments

You can add comments to content when working in the Editing, Suggesting, and Commenting modes. Comments appear in the Review tab, where they are grouped by topic they belong to.

In the Review tab, you can interact with comments in the following ways:

  • Review comments

  • Reply to comments

  • Mention other users in comments so that they receive an email notification

  • Resolve and archive comments individually

  • Reopen resolved, unarchived comments

  • Bulk-resolve or archive all comments in a given topic

  • View archived comments

Figure 1. An Open Comment with a Mention in the Review tab
An open comment in the Review tab

Suggestions

Suggestions are also referred to as tracked changes. When working in the Suggesting mode, you can add suggestions to content. The Suggesting mode enables you to add both suggestions and comments. You can add suggestions to text and content structure. For example, you can suggest to replace a word with a different one or to remove a note. For easy tracking, suggestions appear as colored underlines for added content and strikethroughs for removed content. When multiple contributors add suggestions in one file, their suggestions are saved in different colors, one color per contributor.

Just like comments, suggestions appear in the Review tab and are grouped by topic they belong to.

In the Review tab, you can interact with suggestions in the following ways:

  • Review suggestions

  • Reply to suggestions, just like you reply to a comment

  • Mention other users in suggestions so that they receive an email notification

  • Accept or reject suggestions individually

  • Bulk-accept or reject all suggestions in a given topic

  • View archived suggestions

Figure 2. Suggestions in the Content Editor
Suggestions in the Content Editor

Processing Instructions

Heretto CCMS uses processing instructions (PIs) to keep track of comments and suggestions that you add to content. A PI always starts with <?ezd-review-start> and ends with <?ezd-review-end>. For example, this is a what a PI added to word close looks like in the Source Editor:

<?ezd-review-start ce679247-921e-4a41-bc73-8bff3f7d0652:comment:user@heretto.com:1662977062052?>close<?ezd-review-end ce679247-921e-4a41-bc73-8bff3f7d0652?>

When a processing instruction is removed before a comment or suggestion is resolved, for example, when you remove a sentence before resolving a comment it contained, the comment or suggestion card remains in the Review tab but doesn't take you anywhere in content. That is because without PIs in the content, it's virtually impossible. As a result, a comment or suggestion with no processing instructions is presented in a not-in-content card.

Figure 3. A Not-in-content Comment Card in the Review tab.

Not-in-content cards are slightly grayed out. A tooltip on the card explains that its processing instructions are not present in the content and that you can safely resolve and archive the card.

tracked change no longer being present in content

It can also happen that a processing instruction remains in content when the content it was added to no longer exists. That can happen, for example, when you move content around before resolving a comment or suggestion. As a result, you can see a comment icon image representing two comment boxes in line with text. The icon represents an empty processing instruction. You can remove the processing instruction in the Source Editor.

Figure 4. Empty Processing Instructions are Represented by the Comment Icon
Empty Processing Instructions are Represented by the Comment Icon

Add Comments

Use the Editing, Suggesting, or Commenting mode to leave a comment on a document.

  1. Access the content:
    • Open an assignment.
    • In the Content Library, double-click a topic or a map.
  2. Highlight the text that you're commenting on or place your cursor where you want the comment to appear.
  3. Add a comment:
    • Click the Add comment button that appears on the right margin of the Content Editor.

    • Click the Comment button in the Content Editor toolbar.

  4. In the Comment field, enter a comment.
    Tip:

    To mention a user, enter the ampersand @ symbol and search for a user. The user will receive an email notification and an Heretto CCMS Inbox notification.

  5. Click Save.

Add Suggestions

Use the Suggesting mode to add inline, colored tracked changes to a document.

  1. Access the content:
    • Open an assignment.
    • In the Content Library, double-click a topic or a map.
  2. In the top-right corner of the Content Editor, ensure that the Suggesting option is selected.
  3. Edit the document.

Your edits are saved as colored underlines for added content and strikethroughs for removed content. When multiple contributors add suggestions in one file, their suggestions are saved in different colors, one color per contributor.

Reply to Suggestions or Comments

You can reply to comments and suggestions in the Review tab. In your reply, you can mention a user. Mentioned users receive an email that notifies them about the mention.

  1. Access the content:
    • Open an assignment.
    • In the Content Library, double-click a topic or a map.
  2. Locate the comment or suggestion you want to reply to.
  3. Enter your reply in the Reply field.
    Tip:

    To mention a user, enter the ampersand @ symbol and search for a user. The user will receive an email notification and an Heretto CCMS Inbox notification.

  4. Click Reply.

Accept or Reject Suggestions

You can accept or reject a suggestion in the Review tab.

  1. Access the content:
    • Open an assignment.
    • In the Content Library, double-click a topic or a map.
  2. Click the highlighted text in the document to open the suggestion in the Review tab.
  3. Click the Accept button to accept the change.
  4. Click the Reject button to reject change.

Rejected and accepted suggestions are moved to the Archived view in the Review tab.

Resolve and Archive Comments

Resolve a comment to indicate that work on that comment is completed. A resolved comment can be archived. An archived comment is moved to the Archived view in the Review tab.

  1. Access the content:
    • Open an assignment.
    • In the Content Library, double-click a topic or a map.
  2. Click the comment or highlighted text in the document to open the Review tab.
  3. Optional: Enter a reply to the comment.
  4. Click Resolve.

    Two new options appear for the comment: Re-open and Archive. The comment remains visible in the Review tab.

  5. Click Archive.

    The comment is moved to the Archived view in the Review tab.

View Archived Comments and Suggestions

You can view all archived comments and suggestions in the Review tab.

  1. Access the content:
    • Open an assignment.
    • In the Content Library, double-click a topic or a map.
  2. In the top-right corner of the Review tab, click Archived.
    Figure 5. Archived Comments and Suggestions in the Review tab
    Archived Comments and Suggestions in the Review tab