inception-project / inception-recogito-editor-plugin

INCEpTION RecogitoJS Editor Plugin

Note: This is an early access repository. The way that things work will likely be subject to regular changes for the time being.

This repository is an example based on the RecogitoJS JavaScript editor component of how to integrate a JavaScript-based annotation editor with INCEpTION.

Starting with INCEpTION v23, external editor plugins are supported. To use this editor, first create a folder named editors in your INCEpTION application home. By default, this is ~/.inception, but on server installations, you will usually have set it to something else such as /srv/inception.

Clone this repository as a sub-folder under the editors folder.

tl;dr:

$ cd ~/.inception
$ mkdir editors
$ cd editors
$ git clone https://github.com/inception-project/inception-recogito-editor-plugin.git

Finally, start INCEpTION. Early during start-up, you should see a message like this:

ExternalEditorLoader - Loading editor plugin: RecogitoJS (external)

Also, on the annotation page, you should be able to switch to that editor.

If a document was imported as a HTML file, the editor should display the HTML layout of the file.

inception-recogito-editor-plugin's Issues

Currently selected annotation should be highlighted

The currently selected annotation should be highlighted in some way to distinguish them visually from the other non-selected annotations.

Annotations should use colors determined by the server

The annotations currently have all the same color which is determined by the default RecogitoJS stylesheet. However, the server sends colors and they have different semantics, e.g. to distinguish layers from each other or recommendations from normal annotations. It would be good to be able to display these server-defined colors.

Info on hover

The built-in INCEpTION brat editor shows additional information when hovering over an annotation. It would be nice if this worked here too in some way.