https://github.com/zooniverse/iiif-annotations
A proof-of-concept, annotating a IIIF manifest with Zooniverse classification data.
https://github.com/zooniverse/iiif-annotations
Last synced: 4 months ago
JSON representation
A proof-of-concept, annotating a IIIF manifest with Zooniverse classification data.
- Host: GitHub
- URL: https://github.com/zooniverse/iiif-annotations
- Owner: zooniverse
- License: apache-2.0
- Created: 2022-03-07T11:32:50.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-29T10:41:50.000Z (over 2 years ago)
- Last Synced: 2025-11-20T07:02:57.304Z (7 months ago)
- Language: JavaScript
- Homepage: https://zooniverse.github.io/iiif-annotations/README/
- Size: 985 KB
- Stars: 4
- Watchers: 8
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-iiif - iiif-annotations - A proof-of-concept, annotating a IIIF manifest with Zooniverse classification data. See also [Importing images into Zooniverse with a IIIF manifest: introducing an experimental feature](https://blogs.bl.uk/digital-scholarship/2022/04/importing-images-into-zooniverse-with-a-iiif-manifest-introducing-an-experimental-feature.html) and [Fun with IIIF](https://blog.zooniverse.org/2022/04/20/fun-with-iiif/) on the ability to use IIIF to import media into the Zooniverse project builder. (Crowdsourcing / Annotation Clients)
README
# iiif-annotations
A proof-of-concept, annotating a IIIF manifest with Zooniverse classification data.
Generates [IIIF Annotation Collections](https://iiif.io/api/presentation/3.0/#58-annotation-collection) from Zooniverse project builder data exports, and publishes them on GitHub Pages.
Run it locally with
```
npm install
npx eleventy --serve
```
Or browse work in progress at
- https://zooniverse.github.io/iiif-annotations/annotations/dates.json (individual dates entered by volunteers.)
- https://zooniverse.github.io/iiif-annotations/annotations/titles.json (individual titles and rectangles drawn by volunteers.)
- https://zooniverse.github.io/iiif-annotations/annotations/consensusDates.json (consensus dates, one per playbill.)
## Publishing annotations
The workflow subjects must have been created from an IIIF manifest (see https://github.com/zooniverse/Panoptes-Front-End/pull/6095.) Currently, only [In The Spotlight](https://frontend.preview.zooniverse.org/projects/bldigital/in-the-spotlight) uses that feature, so the code here is specific to its two workflows.
You will need to download classifications exports for the In The Spotlight workflows from the ['Data Exports' page](https://frontend.preview.zooniverse.org/lab/16535/data-exports) in the Project Builder.
1. Clone this repo so that you can edit it locally.
2. Edit `_data/config.js` and make sure that the manifest URL points to the correct manifest.
3. If you're only interested in publishing consensus data for your manifest, you can skip this step. Strip the dates and titles workflow classification exports of volunteers' personal information and save them to `_data/dates.csv` and`_data/titles.csv`.
4. Run [offline aggregation](https://aggregation-caesar.zooniverse.org/README.html#installing-for-offline-use) to generate consensus results from the downloaded classifications. Version 2 drawing tools aren't currently supported, but you can aggregate the dates workflow. Save the consensus results as `_data/consensusDates.csv`.
5. Commit your changes to the `_data/` directory and push to GitHub.
6. Wait a couple of minutes and your new annotations should have been published as [annotation collections](https://iiif.io/api/presentation/3.0/#58-annotation-collection) at the URLs given above.
## How it works
Builds are run by [Eleventy](https://1ty.dev) and managed by GitHub Actions. Merging a change to the data files in the `_data` directory will build a new collection of JSON files.
`_data` contains the source data files:
- `config.json`: the URL of the source manifest, and the dimensions of the Zooniverse images, which are needed to scale annotations back up to the original canvas.
- `consensusDates.csv`: CSV output from the Caesar text reducer for the Dates workflow.
- `dates.csv`: a workflow classifications export for the Dates workflow, stripped of volunteers' personal data.
- `titles.csv`: a workflow classifications export for the Titles workflow, stripped of volunteers' personal data.
Output templates are in the `annotations` directory:
- `annotations/consensusDates`
- `index.11ty.js`: publishes an [annotation collection](https://iiif.io/api/presentation/3.0/#58-annotation-collection) at `/annotations/consensusDates.json`
- `dates.11tydata.js`: parse the CSV text annotations into an array of date annotations, with IDs.
- `dates.11ty.js`: loops over the default sequence of canvases in the manifest (`manifest.sequences[0].canvases`), printing out a JSON [`AnnotationPage`](https://iiif.io/api/presentation/3.0/#55-annotation-page) with one date annotation item for each canvas.
- `annotations/dates`
- `index.11ty.js`: publishes an [annotation collection](https://iiif.io/api/presentation/3.0/#58-annotation-collection) at `/annotations/dates.json`
- `dates.11tydata.js`: parse the CSV classifications into an array of date annotations, with IDs.
- `dates.11ty.js`: loops over the default sequence of canvases in the manifest (`manifest.sequences[0].canvases`), printing out a JSON [`AnnotationPage`](https://iiif.io/api/presentation/3.0/#55-annotation-page) with date annotation items for each canvas.
- `annotations/titles`
- `index.11ty.js`: publishes an [annotation collection](https://iiif.io/api/presentation/3.0/#58-annotation-collection) at `/annotations/titles.json`
- `titles.11tydata.js`: parse the CSV classifications into an array of title annotations, with IDs. Each classification contains multiple drawings, so the final result is flattened into a single array of performance titles.
- `titles.11ty.js`: loops over the default sequence of canvases in the manifest (`manifest.sequences[0].canvases`), printing out a JSON [`AnnotationPage`](https://iiif.io/api/presentation/3.0/#55-annotation-page) with title annotation items for each canvas.