Skip to main content
drupalreleases

Use direct release data with your AI assistant.

Learn more

Annotation with Recogito

No security coverage Under active development

This module integrates the Recogito JS library to allow users to create and tag text and image annotations directly within Drupal. It supports storing annotations and their tags as Drupal nodes and taxonomy terms, respectively, with customizable permissions and appearance.

Incorporates the Recogito JS library into web pages for easy creation and tagging of textual annotations. Further support is provided for Image Annotation (annotorious) using the Open Sea Dragon viewer.

This project is sponsored by the University of Toronto Scarborough Library's Digital Scholarship Unit.

Access a demo video here.

Features

  • Annotate text in Drupal entities
  • Annotation images using Open Sea Dragon
  • Integration with Drupal roles and permissions
  • Control appearance of text-based annotations
  • Annotation tagging integration with Taxonomy
  • Storage of annotation data as Drupal nodes
  • Configurable location of text that may be annotated
  • Creating, Reading, Updating, & Deleting Permissions
  • Storage of tags as Drupal taxonomy terms & ability to autocomplete from a vocabulary

Configuration

Upon installation, visit the module's configuration form at /admin/config/development/recogito_integration. Locate the html tag that contains page content you wish to annotate (This tag depends on your site). Set the DOM element type and name accordingly - for example, to enable annotation for all site content within a div with class "content", set element type to "class" and element name to "content". To enable the storage of annotation tags as Drupal taxonomy terms, set the annotation vocabulary name to the name of a site vocabulary.

Caveats

If you change the text that you are annotating, the position of annotations will not behave as expected. Text edits should be kept to a minimum to preserve positioning of annotations. To avoid this issue, ensure that annotations are created on content that is not actively updated.

Additionally, it is possible for the locations of annotations to spontaneously change due to differences in the DOM between page reloads. The occurrence of this issue can be minimized by choosing a target element (see Configuration section) that contains as little external elements (elements other than text) as possible.

If using the taxonomy term storage feature, be aware that terms in the specified vocabulary that are not actual tags belonging to any annotation will be deleted - ensure to create an empty vocabulary for this feature.

Ask your assistant about Annotation with Recogito

Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
4
Tracked since
Apr 2024
Latest release
7 months ago
Releases (12 mo)
2 ▲ from 0
Maintenance
Active

Release Timeline

Releases

Version Type Core PHP Release date
2.0.0-alpha1 Pre-release 8–11 Apr 16, 2026
2.x-dev Dev 8–11 Apr 9, 2026
2.0.x-dev Dev 8–11 Apr 17, 2024
10.x-dev Dev 8–10 Apr 17, 2024