Annotations Application

The Annotations Application allows users to annotate text in an XWiki document.

Create Annotations

To annotate a piece of text you just need to select it, hit Ctrl + M or Meta + M and enter the text you want to associate with the selection in the dialog window. Next, click on "Add annotation" and you are done.

AddAnnotation.png

Edit Annotations

In order to be able to edit your annotations, you need to have edit rights on the page containing them. Also, only an administrator has the privileges to edit other users' annotations, whereas normal users can only edit their own.

There are two ways of editing an annotation:

  • Straight from the page by clicking the annotation, then on the yellow pen icon. Once you are done with the changes, click on "Update".

    EditAnnotation.png

  • In the "Comments" tab, click the pen icon, change the text, then click on "Save comment".

    EditAnnotationTab.png

Reply to an Annotation

Annotations have been merged with comments by default which means that you can reply to an annotation. This is the reason why the "Annotations" tab has been removed and annotations are displayed in the "Comments" tab. To add a comment to an annotation, click on the "Comments" tab at the bottom of the page, then on the "Reply" icon.

ReplyAnnotationFromTab.png

In addition to plain text you may also use the XWiki syntax.  

AddReplyToAnnotation.png

To preview your comment click on the "Preview" button after you have entered the content.

PreviewReplyToAnnotation.png

To discard the comment click on "Cancel" or, if you are ready to submit it, click on "Add Comment".

ReplyAddedToAnnotation.png

More details about the steps to create a permanent link or to edit/delete your reply are available in the documentation page about "Comments".

Display Annotations

By default annotations are not shown within the page. In order to display the annotated items highlighted, click the PageActionsMenuButton.png button and choose "Annotate" in the "Actions" section, 

AnnotationsFromMenu.png

then check the "Show annotations" option. The annotation for a text item will appear when hovering the yellow icon next to it.

ShowAnnotations.png

By default, annotations are listed in the "Comments" tab because they have been merged. In order to display all the replies to a given annotation, just hover the yellow icon next to the annotated text and click on "See thread". You will be redirected to the bottom of the page where the corresponding annotation will be highlighted. 

SeeThread.png

Filter Annotations by Author

Filtering annotations by user means you will be able to see the annotations authored by a specific user. To do so, click the PageActionsMenuButton.png button and choose "Annotate", then check "Show annotations". Next, click the "Refine the display criteria" link and check the user for whom you want to see the annotations. By doing so, only the annotations of this specific user will be highlighted in the page content.

FilterAnnotations.png

Delete Annotations

To be able to delete your annotations, you need to have edit rights on the page containing them. Also, only an administrator has the privileges to delete other users' annotations, whereas normal users can only delete their own.

There are two ways of deleting an annotation:

  • hover the annotation and click on the red X button

    DeleteAnnotations.png

  • go to the "Comments" tab at the bottom of the page and click on the X button next to the annotation

    DeleteAnnotationCommentsTab.png

Deleting an annotation won't remove the associated replies.

Configure Annotations

Annotations can be customized from the wiki administration page, provided you log in with an user having administration rights. To know more, check the "Configure Annotations" documentation page listed in the "Related Pages" section.

  

Related Pages

Search this space

 

Most popular tags

Failed to execute the [groovy] macro
  1. access rights
  2. activity stream
  3. annotation
  4. attachment
  5. comment
  6. Document Tree Macro
  7. export
  8. Extension Manager
  9. Flamingo skin
  10. global user
  11. Groovy event listener
  12. group
  13. nested page
  14. search
  15. skin
  16. syntax
  17. user
  18. user profile
  19. velocity macros
  20. wiki
  21. wysiwyg
  22. XWiki Applications
  23. xwikiattachment_archive table
  24. xwikiattachment table
  25. xwikiattrecyclebin table
  26. xwikiproperties table

[Display all tags from this space]