Annotating resources

ResourceSpace allows users to annotate directly on the resource preview. Generally, to use the annotations:

  • Go to view the resource
  • Hover over the bottom of the preview of the image and click on the annotation tool icon - 
  • To annotate, click and drag an area. Once you release the mouse, you should be presented with a window (for your input)
  • IF presented with a dropdown, select the annotation mode to use (comment or field bound). When the system is configured so there's only one mode without options (e.g. field bound with only one tagging field) then the dropdown will be hidden
  • Add your annotation content
  • Click Save

Comment (text) annotations

From version 10.7 the comment annotations capability was added and, by default, it's enabled.

annotate-create-comment

When users add text annotations the system will automatically link an annotation with a comment. Deleting either one of them will delete its counterpart.

Comments associated with an annotation will have the annotation tool icon () next to the date & time.

Access Control

Similar to the resource commenting functionality, text annotations can only be created or deleted (permission o).

Field bound annotations

This type of annotations get linked with a metadata field. It was originally done to support the facial recognition (OpenCV needed a training set and a field like "Named person(s)" was used for that purpose).

Only dynamic keyword lists and checkbox field types are supported due to their multiplicity nature (i.e. annotations can't bind to single value fields (e.g. text, dropdown).

The system can be configured to allow tagging multiple fields which will get displayed in the dropdown selector. Please note that field bound annotations can only be linked with one field at a time.

Usage workflow

Once you selected the field to tag, you'll type part or full field options (fuzzy search).

annotate-create-field-bound

Clicking on the suggested option(s) will apply the tag(s). This will also be indicated by the background color change to green.

annotate-field-bound-select-option

Access Control

This type of annotations will always require edit access to both the resource and field.

Admins (permission a) will be able to manage annotations owned by other users.

For non-admin users, the authorisation criteria is:

  • the user is just adding a new (field bound) annotation, or;
  • when editing/removing an existing annotation, created by the same user.

Configuration

From version 10.7 ResourceSpace administrators can configure the annotate functionality from the system configuration page.

annotate-system-config

From version 10.7 the annotate plugin has been removed and some functionality got moved to the code annotation feature (e.g. displaying the annotation author).