doc:annotations [Knowledge Commons]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
//part of the [[start|GtC documentation]]//

====== Annotations ======

We have added a "plugin" for annotation in our DokuWiki, to allow people to make comments and suggestions without actually editing the text itself.

The official documentation is here: [[doku>plugin:annotations]] but you are **not** expected to read that! Here we will give you the basics in, hopefully, a straightforward, easy-to-follow way.

As for all editing, you can try it out in the [[playground:playground]]. So, let's try it!

----

===== Making an annotation =====
Any reader can easily create an annotation on any piece of text on a wiki page here.
  - First, in reading mode (not editing!) highlight/select the text you wish either to comment on, or to suggest something related about.
  - An "Annotate" button {{annotate-button.png}} pops up, usually below the text you have highlighted.
  - Click on that button. A dialogue box pops up in front of the page.{{annotate-popup.png}}
  - Fill in your comment or suggestion, and click on "Annotate" — or if you've changed your mind, "Cancel".
  - The dialogue box vanishes, and the text you selected will get an orange background\\ The text you entered will only pop up if you mouse-over that highlighted text.\\ The orange highlight means that it has not yet been resolved.

===== Following up on the annotation =====
  - Next, you or anyone can revisit the annotation, simply by clicking on the highlighted text.
  - The annotation box reappears, with an option to reply.
  - If you wrote the annotation, these buttons will appear: {{resolve-buttons.png}}
  - So (only) you can edit or delete your own annotation.
  - Anyone can "resolve" the annotation: that means, it stays visible, but turns green.
  - Anyone can also reply, with the text box and its own button below.\\ Both original annotations and replies can be replied to.
  - Close the annotation box by clicking on the "x" in the top right corner.
  - You can also open or close the annotation box by clicking on the appropriate {{annotate-icon.png}} icon on the left.

===== Teamwork on annotations =====
This gives a way for two or more curators to come to agreement on potential edits to a page. 
  * When agreement has been reached, delete any replies that are no longer helpful, if you can. 
  * Anyone who has permissions to edit the page can then go ahead and edit it accordingly.
  * If no one in your team is comfortable editing, just ask anyone with Admin permissions.
  * Once the desired edit is done, the annotation and replies can be deleted.
  * If your team members can't, again, just ask someone with Admin permissions.\\ We'll be happy to do that for you: current Admins are [[user:asimong]], [[user:dave]], [[user:dil]] and [[user:katja]].