Skip to content

nakamura196/mirador-compare-plugin

Repository files navigation

mirador-compare-plugin

Node.js CI DOI

mirador-compare-plugin is a Mirador 3 plugin that adds functions to compare annotations.

🌐 Website

Visit the demo page to try it out.

📖 Data

Prepare a JSON file with following annotations.

{
  "annotations": [
    {
        "body": {
            "type": "TextualBody",
            "value": "施設: 図書館"
        },
        "id": "https://iiif.dl.itc.u-tokyo.ac.jp/repo/iiif/187cc82d-11e6-9912-9dd4-b4cca9b10970/canvas/p2#xywh=9628/9582/1352/1236",
        "type": "Annotation",
        "motivation": "commenting",
        "target": "https://iiif.dl.itc.u-tokyo.ac.jp/repo/iiif/187cc82d-11e6-9912-9dd4-b4cca9b10970/canvas/p2#xywh=9628,9582,1352,1236",
        "_compare": {
            "id": "t",
            "label": "図書館"
        }
    }
  ]
}

The JSON file used on the demo site is as follows.

https://raw.githubusercontent.com/nakamura196/mirador-compare-plugin/main/assets/json/agriculture.json

The _compare field is used to compare annotations. The _compare field has the following fields.

Field Description
id Common ID for comparing annotations.
label Label for comparing annotations.

📖 Installation

mirador-compare-plugin requires an instance of Mirador 3. See the Mirador wiki for examples of embedding Mirador within an application and additional information about plugins. See the live demo's index.js for an example of importing and configuring mirador-compare-plugin.

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.

Cite as

DOI

The above DOI corresponds to the latest versioned release as published to Zenodo, where you will find all earlier releases. To cite mirador-compare-plugin independent of version, use https://doi.org/10.5281/zenodo.10449856, which will always redirect to the latest release.