mirador-annotations

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.

TODO Explain the evolution proposed by Tétras Libre fork

Install (local)

This method requires nvm, npm.

git clone gitlab@gitlab.tetras-libre.fr:iiif/mirador/mirador-annotations.git
cd mirador-annotations
nvm use
npm install

NPM Install throw two errors (#12 (closed)). To fix run :

./cli post_install

Run mirador and the plugin :

npm start

Install using docker

This method requires docker and docker-compose (or docker compose)

cp .env.sample .env
$EDITOR .env
# Change the variables you need
docker-compose up 

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.

You must use node v16.20.2. You can run nvm use at the racine of the project to set your node version to 16.20.2.

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.