Alexander O'Neill
bd327d98b5
|
10 months ago | |
---|---|---|
.. | ||
config | 11 months ago | |
src | 10 months ago | |
CONTRIBUTING.md | 3 years ago | |
LICENSE | 5 years ago | |
README.md | 1 year ago | |
islandora_iiif.info.yml | 2 years ago | |
islandora_iiif.install | 1 year ago | |
islandora_iiif.links.menu.yml | 5 years ago | |
islandora_iiif.module | 5 years ago | |
islandora_iiif.routing.yml | 5 years ago | |
islandora_iiif.services.yml | 1 year ago |
README.md
Islandora IIIF
Introduction
Provides IIIF manifests using views.
Requirements
islandora
andislandora_core_feature
- A IIIF image server (such as Cantaloupe)
Installation
For a full digital repository solution, see our installation documentation.
To download/enable just this module, use the following from the command line:
$ composer require islandora/islandora
$ drush en islandora_core_feature
$ drush mim islandora_tags
$ drush en islandora_iiif
Configuration
You can set the following configuration at admin/config/islandora/iiif
:
- IIIF Image server location
- The URL to your IIIF image server (without trailing slash).
Views Style Plugin
This module implements a Views Style plugin. It provides the following settings:
- Tile Source: A field that was added to the views list of fields with the image to be served. This should be a File or Image type field on a Media.
- Structured Text field: This lets you specify a file field where OCR text with positional data, e.g., hOCR can be found.
Media Attributes from IIIF Action
The module also provides an action that lets a site owner populate a TIFF or JP2 image's width and height attributes into fields so the IIIF server is not bogged down trying to generate a manifest if it doesn't have them.
To use it, either:
- Add it as a derivative reaction to a node with an Original FIle as its child, or
- Use it as a batch action, such as on a Paged Content object's list of child pages.
The action assumes the media type has fields with machine names of field_height and field_width. Making this configurable would mean they would not appear on entity list pages.
Documentation
Official documentation is available on the Islandora 8 documentation site.
Development
If you would like to contribute, please get involved by attending our weekly Tech Call. We love to hear from you!
If you would like to contribute code to the project, you need to be covered by an Islandora Foundation Contributor License Agreement or Corporate Contributor License Agreement. Please see the Contributors pages on Islandora.ca for more information.
We recommend using the islandora-playbook to get started.