Overview Work in Progress!
Table of contents
Glossary
| IIIF Manifest | The primary unit for IIIF: a JSON file that bundles metadata with item structure to allow frictionless re-use. |
| Batch | A discrete collection of image-based items that are similar enough to be described in a single spreadsheet. |
| Item | A single IIIF thing (e.g., a book, front and back of a poster, a scanned photograph). An item can comprise many image assets. |
| Asset | A single image file (e.g., .jpg, .tif) belonging to an item. |
| Record | Metadata for a single item (not collection-wide, not asset-specific). Processed as a single spreadsheet row. |
Relevant repositories
- aperitiiif-cli : ruby gem for processing batches
- aperitiiif-batch-template : template repository for creating batches; includes github actions workflows, gem configs, and project scaffolding.
- aperitiiif : documentation for the project; publishes to this site on github pages
Service architecture
Diagram
Scoped components (1 per batch)
| Name | Type/Tool | Purpose |
|---|---|---|
| Batch repo | GitHub repository | Stores batch image data, metadata, and configuration |
| YAML Workflows | GitHub Actions | Reusable processes to lint and publish batch data |
| Catalog site | GitHub Pages | For graphical batch reuse & discovery |
Shared components (1 per service)
| Name | Type/Tool | Purpose |
|---|---|---|
| IIIF Presentation API | AWS S3 Bucket | Where the IIIF Presentation API manifests for all batches are published |
| IIIF Source Image API S3 Bucket | AWS S3 Bucket | Where the source images for all batches are stored (in jpg format) |
| Serverless-IIIF implementation | AWS Lambda | The "serverless" image server that produces IIIF Image API-compliant derivatives |
| Organization Secrets | GitHub secrets store | Where AWS credentials are managed and stored |