Image Annotation

Overview

The Islandora Image Annotation Solution Pack adds the ability to select portions of an image and add textual annotations to it. This solution pack extends other Islandora Drupal 7 solution packs that have digital objects with a jpeg or png mimetype datastream, such as basic_image and large_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.

Configuration

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 » Image Annotation (admin/islandora/image_annotation). From there you can choose which CModels you want to integrate the annotation tool with. You will need to tell it what datastream to use as well, You should choose a datastream with a mimetype of image/jpeg or image/png. The Taxonomy Column allows the annotation tool to use taxonomy terms for categories.

Annotation categories also depend on the selected radio button under Annotation Categories. If you want to depend on taxonomies choose administrator defined.

Configure Content Models  

Home > Administration > Islandora > Image annotation

This panel allows the user to enable the image annotation module for a particular content module.  The user can specify the 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 

A category field is part of an image annotation. The user can define those categories using Drupal’s taxonomy module (user defined). Alternately the user can populate the category field using an existing indexed solr field (Administrator defined).  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: Feature still in progress.

Configure Controlled Vocabulary for Titles 

Searching:
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  

Customization

Searching: 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.

FAQ

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.

Tutorials

Configure the Image Annotation Solution Pack

Dependencies

Needs an image handling solution pack such as Basic Image Solution Pack - Ready for Review (KS) or Large Image Solution Pack - Ready for Review (KS) for full functionality.