TextAE

An embeddable, web-based visual editor of text annotation

homepage

http://textae.pubannotation.org/

Usage

parameters

This editor is customizable by html attributes.

source

Set the url of an annotations json.

Example:

<div class="textae-editor" source="./annotations.json" ></div>

config

Set the url of a config json.

Example:

<div class="textae-editor" config="./config.json" ></div>

autocompletion_ws

Set the url of the autocompletion web service.

Example:

<div class="textae-editor" autocompletion_ws="/autocomplete?order=desc"></div>

mode

Set default edit mode. values:

• view (default)
• edit

Example:

<div class="textae-editor" mode="edit"></div>

control

Show the control bar of the editor.

• auto (default) : Show the control bar in edit mode
• visible : Show the control bar always
• hidden : Do not show the control bar always

Example:

<div class="textae-editor" control="visible" ></div>

status_bar

Show the status bar of the editor. When the value is 'on', show the status bar. the status bar is not shown at default.

Example:

<div class="textae-editor" status_bar="on" ></div>

For development

Preparation

Node.js is required to be installed on your system.

• To clone the project and get into the directory

git clone git@github.com:pubannotation/textae.git
cd textae/

• To install the required npm packages (which are specified in 'package.json').

npm install

Development

• To open in your browser the file 'dev/development.html' through 'http://localhost:8000', for development

npm run watch

• If the file does not open automatically, click here.

• For development, your editions are supposed to be made to the files in the 'src' directory.

Build

• To compile the files for distribution into the dictionary 'dist'.

npm run dist

Contributors (so far)

• Jin-Dong Kim (DBCLS)
• Yue Wang (DBCLS)
• Shigeru Nakajima (Luxiar)
• Masahiro Nakashima (YouWorks)

License

Released under MIT license.