Scribe

Component ID

2178573

Component name

Scribe

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Component created

Component changed

Component body

Scribe

Scribe is a system for annotating documents inside of Drupal. Utilizing various Javascript library, Scribe is able to store annotations on various types of content.

Using scribe, particular fields are configured to be annotated. This is done via user configuration.

The base scribe module does the following things:

  • Creates configuration system allowing fields to be configured as annotatable.
  • Stores basic annotation information such as creation date, the field instance the annotation is related to, and annotation text.
  • Allows for the creation of new attachers so that annotations can be attached to new types of content.

Annotator

Scribe is built on the Annotator Javascript library. While it isn't strictly necessary to build additional annotation features on this, it will allow you to leverage all of the power of Scribe that has been built to work using the annotator library. This includes easy integration with permissions, conversation threading and more.

Attacher

An attacher is a collection of javascript, css and some code responsible for storing metadata about an annotation. In particular, it handles the following things

  • Associating Javascript and CSS for any annotation libraries to particular fields.
  • Setting up necessary storage for annotation metadata.
  • Describing data properties in annotation metadata so they can be accessed through web services.
  • Interfacing javascript with web services to load and store annotations.

Installation Steps

  1. Download and install module as per Drupal instructions
  2. More to come...