https://github.com/bigbluehat/to-web-annotation

From Annotator JSON to Web Annotation...and back
https://github.com/bigbluehat/to-web-annotation

Last synced: 2 months ago
JSON representation

From Annotator JSON to Web Annotation...and back

• Host: GitHub
• URL: https://github.com/bigbluehat/to-web-annotation
• Owner: BigBlueHat
• Created: 2015-07-30T14:01:39.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-05T22:06:14.000Z (about 9 years ago)
• Last Synced: 2024-10-04T17:59:54.677Z (3 months ago)
• Language: JavaScript
• Homepage: http://bigbluehat.github.io/to-web-annotation/
• Size: 184 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md

Awesome Lists containing this project

README

        
# Transforming Annotations

Ideally, this project could hold annotation transformation stuff for lots of

formats to and from the

[Web Annotation Data Model](http://w3.org/TR/annotation-model).

Right now, it's just some early dayz code for transforming

[Annotator](http://annotatorjs.org/) JSON into

[Web Annotation's JSON-LD](http://www.w3.org/TR/annotation-model/#json-ld-context)

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. :wink:

## 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... :radio:

## 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 `` 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