eu-eleysion-recogito-js
Version:
A JavaScript library for text annotation
78 lines (55 loc) • 2.17 kB
Markdown
<p align="center">
<br/>
<img width="270" src="https://raw.githubusercontent.com/bfour/recogito-js/master/recogitojs-logo-small.png" />
<br/><br/>
</p>
A JavaScript library for text annotation. Use it to add annotation functionality to a web page, or as a toolbox
for building your own, completely custom annotation apps. Try the [online demo](https://recogito.github.io/recogito-js/)
or see the [API reference](https://github.com/recogito/recogito-js/wiki/API-Reference).
<br/>
<br/>
## Installing
If you use npm, `npm install @recogito/recogito-js` and
```javascript
import { Recogito } from '@recogito/recogito-js';
import '@recogito/recogito-js/dist/recogito.min.css';
const r = new Recogito({ content: 'my-content' });
```
Otherwise download the [latest release](https://www.npmjs.com/package/eu-eleysion-recogito-js) and
include it in your web page.
```html
<link href="recogito.min.css" rel="stylesheet">
<script src="recogito.min.js"></script>
```
## Using
```html
<body>
<pre id="my-content">My text to annotate.</pre>
<script type="text/javascript">
(function() {
var r = Recogito.init({
content: document.getElementById('my-content') // ID or DOM element
});
// Add an event handler
r.on('createAnnotation', function(annotation) { /** **/ });
})();
</script>
</body>
```
## Changes from Original Recogito
### Multiple Targets Support
- Support for annotations with multiple targets as per [W3C Web Annotation Data Model](https://www.w3.org/TR/annotation-model/#cardinality-of-bodies-and-targets)
### UI Improvements
- Added rounded borders in body editor
- Improved visualization for overlapping annotations
### Bug Fixes
- Improved handling of nested annotations
- Better error handling and logging for invalid annotations
## License
[BSD 3-Clause](LICENSE) (= feel free to use this code in whatever way
you wish. But keep the attribution/license file, and if this code
breaks something, don't complain to us :-)
## How to publish
- Increase version in package.json.
- Check github action to validate, that package was released to npm registry.