text annotation editor
npm install @pubann/textaeTextAE
======
An embeddable, web-based visual editor of text annotation
homepage
--------
http://textae.pubannotation.org/
Usage
-----
You can also use textae as an npm package in your project.
#### Installation
To install the package, run the following command:
``bash`
npm install @pubann/textae
#### How to Use in HTML
To use TextAE in your HTML, follow these steps:
1. Include the stylesheet and script
Add the following lines to your
section to load the TextAE CSS and JS from your node_modules directory:`html
`
Note:
Replace with the actual version number you have installed.2. Prepare the container
Add a
element with the class textae-editor to your HTML.
This is the element where the TextAE editor will be rendered.`html
`#### Example HTML
Here is an example of how to use textae in an HTML file:
html
TextAE Example
`parameters
This editor is customizable by html attributes.
$3
Set the url of an annotations json.
Example:
html
`$3
Set the url of a config json.
Example:
html
`$3
Set the url of the autocompletion web service.
Example:
html
`$3
Set default edit mode.
values:
- view (default)
- edit
Example:
html
`$3
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:
html
`$3
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:
html
`For development
$3
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
$3
* 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.
$3
* 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.