Skip to content
From Annotator JSON to Web Annotation...and back
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
.gitignore
CHANGES.md
README.md
annotatorjs.json
hypothesis-reply.json
hypothesis.json
index.html
package.json

README.md

Transforming Annotations

Ideally, this project could hold annotation transformation stuff for lots of formats to and from the Web Annotation Data Model.

Right now, it's just some early dayz code for transforming Annotator JSON into Web Annotation's JSON-LD with the most minimal, unsmart means (read: doesn't understand graphs) sort of way possible.

This is partly done as an experiment and partly with some hopes that bridging the worlds of "just JSON" and "smart JSON-LD" could be possible with a defined shape for the JSON-LD and some simple transformation code.

Only time will tell...and your issues and pull requests maybe. 😉

NOTE

This isn't doing what it should...yet...

Annotator doesn't generate "open world assuming" documents and has "out of band" data only known to the Annotator setup code (not to the output data) about how and where these annotations are made.

As such, the text ranges are all wrong, as they require that the XPath (which is not currently expressed in the Web Annotation output) be evaluated against an unknown-to-the-data starting element.

...stay tuned... 📻

Usage

$ npm install
$ npm run standalone
$ open index.html # to test some Annotator JSON conversion

You can use the npm run standalone (above) to create a dist/standalone.js file meant for use in a <script/> tag (as seen in index.html. This file will create a window.anno object with two functions: toWebAnnotation() and fromWebAnnotation().

You can use the npm run build to create a dist/bundle.js file suitable for use in a browserify world. You can then require whichever conversion function you need.

License

Apache License 2.0

You can’t perform that action at this time.