Currently, when zooming on a large image, the annotation label and label box do not adjust in proportion with the zoom level in large-image.

Ideally, we want annotations to be displayed as add-ons to existing objects such as an image, video, audio or pdf.

We need to look at ways to manipulate an object's display without having a custom content model or custom viewer. We also want to add controls to the object that user can interact with.

@MarcusBarnes pointed out that https://github.com/mjordan/islandora_context could be useful. This ticket is to review that module and see if it can be used for the above stated purposes.

HPIC view has Title Team Name and Text of annotations, currently annotations are numbered and the block shows the annotations according to that number. Is it a nice to have or a necessary feature to have annotations that can be organized by Team Name? See http://digitalscholarship.utsc.utoronto.ca/projects/hpic/node/1

The URL parameter in the AJAX calls in base.js needs to be updated so as to not assume localhost as the domain. For example, see https://github.com/digitalutsc/islandora_web_annotations/blob/master/js/base/base.js#L242.

Create islandora_web_annotations.drush.inc to add basic drush support such as disable and enable.

Consider creating a pull request template like that used for Islandora: https://github.com/Islandora/islandora/blob/7.x/.github/PULL_REQUEST_TEMPLATE.md

GitHub Help documentation: https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

Tasks:

1. Create admin form
2. Provide option for a verbose (debug) notification text that will include verbose output for confirmation messages. Default to simple, non-verbose messages.
3. Check for flag and change alert box text on annotation creation, save (and edit) appropriately.

When the goes over an existing annotation to edit, the edit window is shown off to the right and bottom.

Create a wiki page that details how to set up permissions for using Islandora Web Annotations for various known and anticipated use cases.

Implement basic drupal based permissions:

• Edit all annotations

• Create annotations

• View annotations

• Delete all annotations

• Delete own annotations

• Edit own annotations

Also need to review how these interact with Islandora permissions like view datastream.

Change the functionality of the load annotation button (as appropriate) to toggle annotations on/off. This would currently affect the following content models:

• basic image
• large image
• page content

Enable the user to update a single annotation. Save the changes to fedora.
Enable the user to delete a single annotation. Save the changes to fedora.

• Re-factor to extract constants
• Add UUID to annotation and annotationContainer
• Add error handling
• Improve return json to conform more to the Annotation Protocol
• Add comments
• Add a Util class to handle static methods
• Clean up controller and method signatures

Extract steps in pull-request #24 which describe how to get basic indexing of annotations in Solr.

Review open source annotations libraries for Video.js and decide on a library that be used for UI.

*github.com/CtrHellenicStudies/OpenVideoAnnotation

Create php interfaces that confirms to Web Annotation Protocol to do CRUD operations.

• interfaceAnnotation
• interfaceAnnotationContainer

The annotations models need WADCContainer and WADC Content Models to be in the fedora to work. These need to be installed when the module gets installed, similar to how Oral Histories module installs WADC Content Model.

Update the .info file to include context, islandora_context and context_addassets as dependencies. This will help when users are trying to do a basic install.

Tested on 7.x-1.8 VM
../../lib/css/hypothesis/fonts/h.woff is being recognized as

css/lib/css/hypothesis/fonts/h.woff
This works:
../../../lib/css/hypothesis/fonts/h.woff'

Taken from:
http://localhost:8000/sites/all/modules/islandora_web_annotations/css//base/base.css

As currently written, the module allows roles that have the appropriate web annotation permissions to perform CRUD operations on annotations. The only currently required Islandora permission is "View repository objects." This means that, using the Web Annotation model, users can perform CRUD operations on annotations (which are Islandora objects). This means users can "Add datastreams to repository objects, Edit metadata, Create new repository objects, Permanently remove objects from the repository" (language from Islandora core permissions) without having been granted these permissions explicitly. There is a use case for this, as administrators may wish to grant only the option to create web annotations. However, will it cause a problem if we wish to contribute this module to core Islandora? Kirsta to raise -

Created an annotation and blue box with number exceeds box drawn for annotation. Firefox 50.1.0. Seems to happen when an annotation is created with the image zoomed. All the blue boxes seem to be the same size.

Currently annotations are uniquely identified by PID. Does this need to be shown in the front end so users can reference the annotations externally?

When the Islandora Simple Workflow utility module is enabled, new objects (including AnnotationContainers) have an Inactive state in Fedora, which causes issues with the annotation creation workflow.

Create documentation for the workaround (see comment #58 (comment)).

Currently, the initial prototype has the create, update, delete and load/get ajax calls in the large_image.js. These ajax calls will be similar or same for other content types as well. These calls can be abstracted out into its own js so it can be used by other content types to interact with the backend.

We have to which namespace is appropriate for annotation objects. We have 3 options:

• use default islandora namespace
• use the object's namespace (could be difficult to determine!)
• provide config option to specify a namespace

Display all annotations as a list in a block or div. A specific annotation text in the list and the cross-ponding annotation needs to be related.

• Number the annotation boxes and the cross-ponding texts in the list
• If the user hover over a text in the list, highlight that annotation box

Sometimes the order in which JS files are loaded are important, but indicating the order is not yet possible in Context.

Description: Experiencing interface issues if JS files for video are loaded in the order they are presented in Islandora context.
Steps to reproduce: Add context JS from modules and select all of the JS files required
Platform: php 5.5.9, islandora 7.x-1.7 on firefox and chrome
Actual: Error message that says undefined variables, like openvideoannotation and annotator, interface for video annotations does not load correctly
Expected behaviour: No error dialogs, interface loads and you're able to add annotations

This context works:

$context = new stdClass();
$context->disabled = FALSE; /* Edit this to true to make a default context disabled initially */
$context->api_version = 3;
$context->name = 'video4';
$context->description = '';
$context->tag = '';
$context->conditions = array(
'islandora_context_condition_collection_member' => array(
'values' => array(
0 => TRUE,
),
'options' => array(
'islandora_collection_membership' => array(
'islandora:audio_collection' => 'islandora:audio_collection',
'islandora:video_collection' => 'islandora:video_collection',
'islandora:testing1' => 'islandora:testing1',
'islandora:entity_collection' => 0,
'islandora:bookCollection' => 0,
'islandora:sp_disk_image_collection' => 0,
'islandora:newspaper_collection' => 0,
'islandora:compound_collection' => 0,
'islandora:sp_large_image_collection' => 0,
'islandora:sp_web_archive_collection' => 0,
'islandora:sp_basic_image_collection' => 0,
'islandora:sp_pdf_collection' => 0,
'ir:citationCollection' => 0,
'islandora:kim' => 0,
'crudmix:collection' => 0,
),
),
),
);
$context->reactions = array(
'css_module' => array(
'sites/all/modules/islandora_web_annotations' => array(
'sites/all/modules/islandora_web_annotations/lib/css/video-js/video-js.css' => 'sites/all/modules/islandora_web_annotations/lib/css/video-js/video-js.css',
'sites/all/modules/islandora_web_annotations/lib/css/annotator.min.css' => 'sites/all/modules/islandora_web_annotations/lib/css/annotator.min.css',
'sites/all/modules/islandora_web_annotations/lib/css/ova.css' => 'sites/all/modules/islandora_web_annotations/lib/css/ova.css',
'sites/all/modules/islandora_web_annotations/lib/css/rangeslider.min.css' => 'sites/all/modules/islandora_web_annotations/lib/css/rangeslider.min.css',
'sites/all/modules/islandora_web_annotations/lib/css/richText-annotator.min.css' => 'sites/all/modules/islandora_web_annotations/lib/css/richText-annotator.min.css',
),
),
'js_module' => array(
'sites/all/modules/islandora_web_annotations' => array(
'sites/all/modules/islandora_web_annotations/lib/js/annotator-full.min.js' => 'sites/all/modules/islandora_web_annotations/lib/js/annotator-full.min.js',
'sites/all/modules/islandora_web_annotations/js/video/video.js' => 'sites/all/modules/islandora_web_annotations/js/video/video.js',
),
),
'js_path' => array(
'sites/all/modules/islandora_web_annotations/lib/js' => array(
'sites/all/modules/islandora_web_annotations/lib/js/ova.js' => 'sites/all/modules/islandora_web_annotations/lib/js/ova.js',
'sites/all/modules/islandora_web_annotations/lib/js/tinymce.min.js' => 'sites/all/modules/islandora_web_annotations/lib/js/tinymce.min.js',
'sites/all/modules/islandora_web_annotations/lib/js/richText-annotator.min.js' => 'sites/all/modules/islandora_web_annotations/lib/js/richText-annotator.min.js',
'sites/all/modules/islandora_web_annotations/lib/js/rangeslider.min.js' => 'sites/all/modules/islandora_web_annotations/lib/js/rangeslider.min.js',
),
),
);
$context->condition_mode = 0;

File path to add: sites/all/modules/islandora_web_annotations/lib/js

Review open source annotations libraries for OpenSeaDragon and decide on a library that be used for UI.

• http://annotorious.github.io/ (preferred)
• https://github.com/Emigre/openseadragon-annotations
• https://github.com/ProjectMirador/mirador
• https://github.com/DigitalSlideArchive/openseadragon-annotations

Annotation Container should be deleted if all annotations are deleted.

Test coverage for

• CRUD operations for annotation and annotation container

Move documentation to the Wiki. For this issue, update the setup for adding annotation capabilities to basic image collections.

AnnotatorJs is a generic solution for web annotations. Well supported projects such as Hypothesis use AnnotatorJs. Annotorious can plugin to AnnotatorJs: http://annotorious.github.io/plug-outs/okfn-annotator.html.

Additional features could be implemented by using Annotorious as a plugin for AnnotatorJs. We also want to consider using Hypothesis for the front end. This ticket is to review the pros and cons of using Annotorious as plugin for AnnotatorJs.

Review the architecture of islandora_image_annotation: https://github.com/Islandora-Labs/islandora_image_annotation

Is it using any annotations libraries?
Does it confirm to any annotation standard (ex WADM)?

If an annotation with a lot of text is created (entire first page from here) then the edit and delete tools become unavailable to the user.

As pointed out in a comment, once one clicks the [ + ] icon, it goes back to the default feather icon for basic_images. For consistency sake, it might be worthwhile replacing the default feather icon with the [ + ] icon (or whatever icon is chosen for adding annotations across content models and solution packs).

Steps to Reproduce:

• Go to a basic image
• (Don't click the load annotations button)
• Add annotations
• The annotation block does not show

Expected:

• The annotation block should show the newly added annotations.

Actual

• The annotation block does not show

1. Created a new large image object as admin
2. Masqueraded as an authenticated user with permission to create web annotations (user has been successfully used to create annotations in this instance) and created an annotation. I received confirmation that annotation was created. (I did not check to see if the block underneath was updated. I'm sorry for that.)
3. Switched to a different authenticated user and attempt to load annotations. Annotation does not load.
4. Switched to admin account and verified that annotation won't load for this user either. Also verify that the annotation and annotation container was created (by directly navigating to expected PID via URL)
5. As Admin, created an annotation successfully. Other test users can load the annotation.
6. Navigate to expected PID using the browser URL as admin. Discover that a second annotation container has been created at expected PID. Verified that two annotation containers were created for a single islandora object.

#s are a little arbitrary here - criticize my reporting technique! Happy to provide additional details/reformat.

Move documentation to the Wiki. For this issue, update the setup for adding annotation capabilities to large image collections.

If you navigate directly to an annotation using a known PID in the Drupal interface (A URL such as http://localhost:8000/islandora/object/annotation:13) and purge the object using the manage tab, you will lose the ability to view or load all other annotations from the web annotation/sea dragon interface.

Please let me know if I can provide additional details.

Paged Content model uses openseadragon viewer. Extend web annotations to support Paged Content model.

Add a content model specific configuration section to the admin form.

For large image, add a configuration option to record a zoom level at which to hide the blue box and or label (value strictly between 0 and 1). Default would be to keep the blue box and label.

Depends on creation of admin form step in issue #66.

Feature request: indicating the parent in an Annotation object, having that be an indexable field

Solr currently indexes an annotation value and annotation title (which has the parent PID listed in the title). Although the annotation currently indicates the parent, you cannot easily navigate back to the parent in the search results.

If we isolate the parent pid and index that, when we do a search for annotations we can link back to the parent by configuring the display Solr settings.

@kstapelfeldt let me know what you think of this as an additional task for development
@Natkeeran how long do you think this would take in terms of development time?

Steps to reproduce:
Some times, when navigating to a basic image and click to load the annotations. Those annotations do not get loaded. If you refresh the page and load it, it will.

Expected result:
It should load the basic image annotations.

Create a module to do a proof of concept for image annotations using https://annotorious.github.io/.

Modules and Libs involved:

• https://annotorious.github.io/
• Context
• islandora_context
• context_addassets.

Create a test plan with sanity and extended test cases for manual end to end testing. This test plan should cover range of common use cases.

A typical format for test case is as below:

• Test Case Info: #, Name/Description, System, Subsystem, Executed By, Executed Date,
• Use Cases/Requirements Tested
• Steps
• Expected Results
• Actual Results or Pass/Fail

A sample template: https://images.template.net/wp-content/uploads/2015/12/29053639/Test-Case-Template-PDF.pdf

Web Annotation Protocol requires an ETag to be checked before updating or deleting an annotation. ETag is generated by the server (https://tools.ietf.org/html/rfc7232#section-2.3.1). Checksum, version or timestamp could be used an as ETag. The request must include the ETag in the "If-Match" header parameter when making the request. Example from https://www.w3.org/TR/annotation-protocol/#update-an-existing-annotation.

PUT /annotations/anno1 HTTP/1.1
Host: example.org
Accept: application/ld+json; profile="http://www.w3.org/ns/anno.jsonld"
Content-Type: application/ld+json; profile="http://www.w3.org/ns/anno.jsonld"
Content-Length: 294
If-Match: "_87e52ce126126"

{
  "@context": "http://www.w3.org/ns/anno.jsonld",
  "id": "http://example.org/annotations/anno1",
  "type": "Annotation",
  "created": "2015-02-01T10:13:40Z",
  "body": {
    "type": "TextualBody",
    "value": "I REALLY like this page!"
  },
  "target": "http://www.example.com/index.html"
}

If the ETag has changed, then the request should not be processed. An appropriate message should be returned tot the user. User can choose to reload all annotations and try to preform the operation again.

When a save request is prompted create a annotationContainer, save it with reference to the object. When a load request is received, return the annotationContainer.

Annotations are fedora objects with WADM Content Model. Currently, they are being created as JsonLD data-stream with application/ld+json MIME type. GSearch does not support indexing of application/ld+json datastreams. We have two options:

• Change the Annotation MIME type to xml for storage purposes. Use that for indexing. When, retrieving, convert it back to json-ld.
• Create a derivative xml for search purposes.

Steps to reproduce:

1. Go to a large image page
2. Scroll down on the page
3. Create an annotation

Actual:
The annotations are positioned below the selected selection area.

Expected:
The annotations should be positioned in the selected selection area.

Developer Notes:
It appears that when the user scrolls, the annotations are placed down the image at a distance proportional to the scrolling distance.

When the content models are ingested for the Web Annotation solution pack, they become available in a number of default locations (including the collection management interface). Using this, it is possible to select the content models in the collection policy and ingest objects. One can ingest an annotation without an annotation container. Explore options for removing the content models from the collection policy list.

Let me know if you guys want more details/steps to reproduce