Skip to content

Reference Plugin Design Discussion

Jump to bottom Edit New page
Bridget Almas edited this page Sep 1, 2015 · 5 revisions

Background: Text Reuse User Stories

The main one we are dealing with for this plugin is "identify named-entities (people and places)"

The data model we want to support for persistence of such annotations is the Open Annotation data model

Examples of annotations of this type using this model are can be found here

A very basic workflow might be the following:

  1. User loads Virgil's Aeneid Book 1 to treebank in Arethusa
  2. While treebanking, user encounters the word Troiae, which is the name of a place
  3. User clicks on reference tab
  4. In a separate browser tab User opens the Pleiades Gazetteer
  5. User searches on Troia finds the Stable URI for Troy http://pleiades.stoa.org/places/550595#this
  6. User copies this into an input box on the Reference Tab and clicks Save
  7. Reference Plugin calls Open Annotation plugin (not yet written) to generate an Open Annotation for the annotation
  8. Reference Plugin calls persister to save the annotation

The Open Annotation Plugin would be responsible for generating a properly formatted Open Annotation. In turn, it would delegate to other plugins to generate the specific URIs and/or Selectors for the target and body, and user and other provenance data for the annotation.

Potential sequence of interactions on the save:

A more advanced workflow, using automated parsing/identification of places in the text:

  1. User loads a text to treebank in Arethusa
  2. Reference Plugin calls a Place Retriever passing it all the words in the current sentence
  3. Place Retriever returns the Pleiades URI for Troiae
  4. Reference plugin adds the URI to the token state for Troiae
  5. User clicks on reference tab
  6. Reference tab shows pre-populated URI for Troiae (maybe with additional description information retrieved from an Ajax call to the Pleiades URI) (and an option to supply a new one)
  7. Clicks a checkbox next to the URI to indicate that it is correct
  8. Reference plugin calls Open Annotation plugin to create the annotation
  9. Reference plugin calls persister to save the annotation
Add a custom footer
Add a custom sidebar
Clone this wiki locally