Skip to content

Latest commit

 

History

History
70 lines (55 loc) · 2.66 KB

README.md

File metadata and controls

70 lines (55 loc) · 2.66 KB
Raw

Annotate.js (coffeescript)

Introduction

Annotate.js is the frontend widget for entity recognition back-end engines like Stanbol.

Features

  • Text-Enhancement support
  • Spell-checker - like interaction with annotation enhancements
  • Write RDFa into your content
  • Independent of any editor
  • One-line integration
  • Configurable Enhancement types

Options

  • 'vie': VIE instance to use. Default is a simple VIE instance with Stanbol service configured to connect http://dev.iks-project.eu:8080 which is the actual demo stable launcher.
  • 'vieServices': defines which services to use for the annotation. Default ['stanbol']
  • 'autoAnalyze': fire analyze on initialization
  • 'showTooltip': (don't) show a preview tooltip when mouseovering an already annotated word.
  • 'typeFilter': Annotation Type(s) to filter for. Default empty. Example: ["http://dbpedia.org/ontology/Place", "http://dbpedia.org/ontology/Organisation", "http://dbpedia.org/ontology/Person"]
  • 'debug': Shows console messages about what's happening
  • 'ns': map of relevant namespaces. Default is DBpedia and SKOS namespace definitions.
  • 'fallbackLanguage':

Methods

  • 'enable' gets enhancements from backend and visualizes them on the analized dom element.
  • 'disable' hides all the text enhancements that are not accepted by the user.
  • 'acceptAll' goes through all text enhancements and accepts the best candidate automatically.

Events

  • 'success': finished loading annotations
  • 'error': error loading annotations
  • 'select': User selected an annotation
  • 'decline': User declined a suggestion
  • 'remove': User removed a previously selected annotation

Goals

  • Provide Text enhancement directly in your content

  • Provide another open source (MIT license), flexibly usable, easy to integrate tool for (semi-)automatic and manual semantic enhancement.

  • A tool that's fun to integrate

      var stanbolConnector = new StanbolConnector();
  $('#content').annotate({
      connector: stanbolConnector
  });

Future features

  • Manual annotation - loosely coupled wysiwyg-editor enhancement?, needs selection-support
  • Connection to VIE - loosely coupled, easy integration
  • Clean up decoupling from the stanbol backend - schema mapping
  • Entity preview using client-side templating
  • Edit relationships

Dependencies

  • jQuery 1.5
  • jQuery UI 1.9m5
  • Backbone.js
  • a wysiwyg-editor with save() (here: hallo editor)
  • VIE, VIE^2 (optional)

Development guide

The widget development is done in CoffeeScript. Use the following command to automatically compile the script in the background whenever it's edited:

$ cake watch