mirador-annotations

[![Travis][build-badge]][build]
[![npm package][npm-badge]][npm]
[![Coveralls][coveralls-badge]][coveralls]

mirador-annotations is a Mirador 3 plugin that adds annotation creation tools to the user interface. Users can create rectangle, oval, and polygon annotations and add text descriptors. A live demo that stores annotations in local storage is available for testing. See the issue queue for design proposals for additional functionality.

!annotation creation panel

Persisting Annotations

Persisting annotations requires implementing an a IIIF annotation server. Several examples of annotation servers are available on iiif-awesome.

mirador-annotations currently supports adapters for annotot and local storage. We welcome contributions of adapters for other annotation servers.

Installing mirador-annotations

mirador-annotations requires an instance of Mirador 3. See the Mirador wiki for examples of embedding Mirador within an application. See the live demo's index.js for an example of importing the mirador-annotations` plugin and configuring the adapter.

Contribute

Mirador's development, design, and maintenance is driven by community needs and ongoing feedback and discussion. Join us at our regularly scheduled community calls, on IIIF slack #mirador, or the mirador-tech and iiif-discuss mailing lists. To suggest features, report bugs, and clarify usage, please submit a GitHub issue.

[build-badge]: https://img.shields.io/travis/user/repo/master.png?style=flat-square
[build]: https://travis-ci.org/user/repo

[npm-badge]: https://img.shields.io/npm/v/mirador-annotations.png?style=flat-square
[npm]: https://www.npmjs.org/package/mirador-annotations

[coveralls-badge]: https://img.shields.io/coveralls/user/repo/master.png?style=flat-square
[coveralls]: https://coveralls.io/github/user/repo