This documentation refers to an earlier version of Islandora. is current.

Skip to end of metadata
Go to start of metadata


The Islandora Image Annotation Solution Pack adds the ability to draw a shape over an image and then add a textual annotation to that portion of the image. When the annotation solution pack is enabled a new sub-tab is added to the View tab that includes the annotated view of the image, its annotations (if any), and the toolset needed to add/edit annotations. Annotations consist of three main parts including a category, title, and annotation and depending on configuration may also include a color picker and/or a setting for the stroke width. Any solution pack with an image datastream can be configured to use the image annotation solution pack; however, it only functions with datastreams that are .png or .jpeg.


 This module depends on an image handling solution pack such as Basic Image Solution Pack or Large Image Solution Pack.

This module requires the following modules/libraries:


Release Notes and Downloads


Install as usual, see this for further information.


There are a number of configuration panels available for the image annotation module. 

 To enable the annotation tab for a content model visit Administration » Islandora » Islandora Utility Modules » Image Annotation (admin/islandora/tools/image_annotation). From there you can configure the module for any available content model. The Taxonomy Column allows the annotation tool to use Drupal's taxonomy terms for categories, if the appropriate radio button is selected under the "Annotation Categories" section. 

If you want users to annotate books, do not check the book content model on the admin page. In order to annotate book pages, you must select a datastream in the paged content model.

Configure Content Models  

Administration » Islandora » Islandora Utility Modules » Image Annotation

This panel allows the user to enable the image annotation module for a particular content module.  The user can specify the Datastream's DSID to use for annotation (currently this must have the mimetype of png or jpg) and can alternately specify a Drupal based taxonomy to use for an annotation’s category. In the example above  

Configure Annotation Categories 

Each annotation has an optional "category" field. An administrator can allow users to determine their own categories at the time of annotation, or have the categories selected via a Drupal taxonomy.  Alternately administrators can define categories using an existing indexed solr field.  The Annotation Type Search Field contains the solr field to be used as for categories. 


Configure Annotation Colors 

Annotation Colors: By default the color of annotations are randomly derived by a set of standard colors (Optimized).  If User defined is selected a color picker is displayed and a specific color can be applied to the annotation.
Annotation Stroke Width: Administrators can define a list of stroke widths to be available to site users. 

Configure Controlled Vocabulary for Titles 


Included is an xslt designed for gsearch.  If this xslt is included in your existing  gsearch index xslt it will index the Annotation fields and make them searchable in solr.  You will also need to configure the Islandora Solr client so that it is aware of the new fields.  If you are using custom Solr request handlers you will have to update them as well.

If you have solr configured properly and have Annotation Categories set as user defined you will have a type ahead for the Annotations categories section


Q. Can I have annotations for a book?

A. If you want the annotations for book, do not check the book content model on the admin page. In order for annotations for book you check the paged content model.


  • No labels