Adding Page Annotations adding-page-annotations

Creating content for your digital experience often requires discussion and feedback prior to publication. To aid this feedback process, AEM lets you add annotations to your content.

An annotation places a simple sketch or note (think real-world sticky-note) on the page. The annotation lets you leave comments or questions for other authors and reviewers.

Don’t forget that comments are also available for providing feedback on a page.

A special mode is used for creating and viewing annotations.

Depending on your requirements you can also develop a workflow to send notifications when annotations are added, updated, or deleted.

Annotation Indicator annotation-indicator

Annotations do not appear in Edit mode, but the badge at the top right of the toolbar shows how many annotations exist for the current page. The badge replaces the default Annotations icon, but still functions as a quick link that toggles to/from the Annotate mode:

Annotation indicator

Annotate Mode annotate-mode

Annotations are only visible in Annotate mode.

  1. You enter Annotate mode using the icon in the toolbar (top right) when editing a page:

    Annotation button

    You can now view any existing annotations.

    Annotation examples

  2. Select the annotation to open the annotation dialog and view its details.

    Annotation details

  3. To exit Annotate mode, and return to the mode previously used, select the x button at the right of the top toolbar.

Adding and Editing Annotations annotating-a-component

In addition to viewing the annotations, Annotate mode lets you create, edit, move, or delete annotations on your content

  1. Start Annotate mode on the page.

  2. Select the Add Annotation icon (plus symbol at the left of the toolbar) to start adding annotations.

  3. Select the required component (components that can be annotated are highlighted with a blue border) to add the annotation and open the dialog:

    Adding an Annotation

    Here you can use the appropriate field and/or icon to:

    • Enter the annotation text.

    • Create a sketch (lines and shapes) to highlight an area of the component.

      Annotation Sketch button

      The cursor will change to a crosshair when you are creating a sketch. You can draw multiple distinct lines. The sketch line reflects the annotation color and can be either an arrow, circle, or oval.

    • Choose or change the color:

      Annotation color swatch button

  4. You can close the annotation dialog by clicking or tapping outside the dialog. A truncated view of the annotation, together with any sketches, is shown:

    Annotation sketches

  5. After you have finished editing a specific annotation, you can:

    • Select the text marker to open the annotation. Once open you can view the full text, make changes, or delete the annotation.
    • Reposition the text marker.
    • Select a sketch line to select that sketch and drag it to the desired position.
    • Move or copy a component
      • Any related annotations and their sketches will also be moved or copied but their position in relation to the paragraph will remain the same.
Annotations cannot be added to a page that has been locked by another user.
The definition of an individual component type determines whether adding an annotation is possible (or not) on instances of that component.

Deleting Annotation and Sketches deleting-annotations

Annotations and their associated sketches can be deleted.

  1. Start Annotate mode on the page.

  2. Select the text marker to open the annotation.

  3. Select the Delete icon.

    Delete annotation

  4. The annotation and all associated sketches are deleted.

Deleting a component deletes all the annotations and sketches attached to that resource irrespective of their positions on the page as a whole.

Deleting Sketches Only deleting-sketches

You can delete only specific sketches instead of the entire annotation with all associated sketches.

  1. Start Annotate mode on the page.

  2. Select the sketch. AEM highlights it with a darker blue box.

    Select sketch for deletion

  3. Press the Delete key on your keyboard.

  4. The sketch is deleted, but the annotation remains.

Annotating Other Resources annotating-other-resources

Besides components, you can annotate a variety of resources: