themerius/annodom

Javascript library for creating hovering annotation tags on text. Especially useful to show named entities.

AnnoDom

Create hovering annotation tags on text. Especially useful to show named entities.

• Example
• Documentation

Install

To install AnnoDom with bower:

bower install annodom

AnnoDom is also available as WebJar. Browse artifacts on Bintray. Here is the SBT dependency:

"org.webjars.bower" % "annodom" % "1.0.0"

Dependencies

You can load the dependencies with bower.

bower install --force

Generate docs

To generate the documentation:

npm install -g docco
docco -o ./docs js/*.js

Browse the documentation:

./docs/main.html

Similar work

• Annotator
• Annotorious

annodom's Issues

Refactor JSON format

Currently a text position JSON object looks like this:

    textPos = {
        "begin": 6,
        "end": 10,
        "attr": "sentence",
        "ref": "concept/ipsum"
   }

Include more (optional) informations on the (normalized) named entity. Similar to this:

    textPos = {
        "begin": 6,
        "end": 10,
        "onClass": "sentence",
        "concept": { "id": "0001", "source": "myDB", "label": "thing", "descr": "A thing is..." }
   }

Publish to bower and webjar

• Publish this project to bower https://bower.io/docs/creating-packages/
• Should be also available on webjars http://www.webjars.org/bower
• Create first release (plus release tag)