Skip to main content

How-to guide: Adding annotations & replacing content

A quick step-by-step guide to adding annotations and replacing content with annotations

Robert Shough avatar
Written by Robert Shough
Updated this week

Introduction

This document is split into two quick guides and will break down ‘how to add annotations’ and ‘how to replace CybSafe content with annotations’.


How to add annotations

Step 1: Choose where to add the content

Find the 'anchor' for where you would like to add the annotation. Click on the "Annotate" link to the right of the content you wish to add detail to.

Step 2: Configure Annotation settings

Decide if you wish to have this annotation published immediately or not. By toggling "Publish" on, the annotation will be published as soon as you hit the 'Submit' button. You can leave this toggle off and come back to publish it at a later date.

If you toggle "Replace original" on, your annotation will completely replace the original content. When off, your annotation will display beneath the original content.

Use the "Annotation style" dropdown to select how your annotation should appear:

  • Pro Tip (default) - Uses the standard Pro Tip styling with icon

  • HTML - Allows you to use custom HTML formatting for more advanced customization

Step 3: Write the content

Give your annotation a relevant title and add the information you want users to see within the content box. Here's an example of advice for Kinsella Ltd. about in-person social engineering.

Quick tip: If you want to remove an annotation, simply make sure both these toggles are turned off.

Step 3: Write the content

Give your annotation a relevant title and add the information you want users to see within the content box. Here’s an example of advice for Kinsella Ltd. about in-person social engineering.

Step 4: Select groups

Select which groups will receive the annotation. By not selecting a group, everyone will be able to see this annotation when published.

Step 5: Publish

To publish your annotation (if the "Publish" toggle is on) click "Submit".

When an annotation is published, all users will be able to see it (assuming the annotation has not been restricted to individual groups only).

Published annotations will be displayed in a box with a CybSafe logo next to it just like the example below:

Please note: You will not be able to edit module titles or end of module quiz questions with this feature.


Additional resources

If just adding annotations isn't enough, CybSafe also has a Custom module builder. Speak to a member of the CybSafe team to see if you have access to this bolt-on package.

Did this answer your question?