IIIF Server

By Daniel Berthereau, Omeka S port by BibLibre Integrates the IIIF specifications to allow to process and share instantly images of any size and medias (pdf, audio, video, 3D…) in the desired formats.
Download 3.6.0-beta.2

IIIF Server (module for Omeka S)

Build Status

IMPORTANT: This readme is for the development version of IIIF Server. See stable version here. This new version is working, but requires the module Image Server.

IIIF Server is a module for Omeka S that integrates the IIIF specifications to allow to process and share instantly images of any size and medias (pdf, audio, video, 3D…) in the desired formats. It requires an image server, like the module Image Server.

The full specifications of the International Image Interoperability Framework standard are supported (level 2), so any widget that supports it can use it. Rotation, zoom, inside search, etc. may be managed too. Dynamic lists of records may be created, for example for browse pages.

This Omeka S module is a rewrite of the Universal Viewer plugin for Omeka by BibLibre with the same features as the original plugin, but separated into two modules (the IIIF server and the widget Universal Viewer). It integrates the tiler Zoomify that was used the plugin OpenLayers Zoom for Omeka Classic and another tiler to support the Deep Zoom Image tile format.

The IIIF manifests can be displayed with many viewers, the integrated OpenSeadragon, the Universal Viewer, the advanced Mirador, or the ligher and themable Diva, or any other IIIF compatible viewer.

The search is provided by the module Iiif Search for common xml formats.

Installation

PHP should be installed with the extension exif in order to get the size of images. This is the case for all major distributions and providers. At least one of the php extensions [GD] or [Imagick] are recommended. They are installed by default in most servers. If not, the image server will use the command line ImageMagick tool convert.

Note: To keep old options from Universal Viewer, upgrade it to version 3.4.3 before enabling of IiifServer. Else, simply set them in the config form.

  • From the zip

Download the last release [IiifServer.zip] from the list of releases (the master does not contain the dependencies), uncompress it in the modules directory, and rename the module folder IiifServer.

  • From the source and for development:

If the module was installed from the source, check if the name of the folder of the module is IiifServer, go to the root of the module, and run either:

    composer install

Then install it like any other Omeka module.

Notes

  • Using externally supplied IIIF manifest and images

If you are harvesting data (via OAI-PMH, for instance) from another system where images are hosted and exposed via IIIF, you can use a configurable metadata field to supply the manifest to the viewer (Universal Viewer, Mirador or Diva). In this case, no images are hosted in the Omeka record, but one of the metadata fields has the URL of the manifest hosted on another server.

For example, you could set the alternative manifest element to "Dublin Core:Has Format" in the module configuration, and then put a URL like "https://example.com/iiif/HI-SK20161207-0009/manifest" in the specified element of a record. The viewer included on that record’s display page will use that manifest URL to retrieve images and metadata for the viewer.

  • Customize data of manifests

The module creates manifests with all the metadata of each record. The event iiifserver.manifest can be used to modify the exposed data of a manifest for items, collections, collection lists (search results) and media (info.json). So, it is possible, for example, to modify the citation, to remove or to add some metadata or to change the thumbnail.

Note: with a collection list, the parameter resource is an array of resources.

IIIF Server

All routes of the IIIF server are defined in config/module.config.php. They follow the recommandations of the IIIF specifications.

To view the json-ld manifests created for each resources of Omeka S, simply try these urls (replace :id by a true id):

  • https://example.org/iiif/collection/:id for item sets;
  • https://example.org/iiif/collection/:id,:id,:id,:id… for multiple resources;
  • https://example.org/iiif/:id/manifest for items;
  • https://example.org/iiif-img/:id/info.json for images files;
  • https://example.org/iiif-img/:id/:region/:size/:rotation/:quality.:format for images, for example: https://example.org/iiif-img/1/full/full/270/gray.png;
  • https://example.org/ixif-media/:id/info.json for other files;
  • https://example.org/ixif-media/:id.:format for the files.

By default, ids are the internal ids of Omeka S, but it is recommended to use your own single and permanent identifiers that don’t depend on an internal pointer in a database. The term Dublin Core Identifier is designed for that and a record can have multiple single identifiers. There are many possibilities: named number like in a library or a museum, isbn for books, or random id like with ark, noid, doi, etc. They can be displayed in the public url with the modules Ark and/or Clean Url.

3D models

The creation of manifests for 3D models is fully supported by the widget and natively managed since the release 2.3 of Universal Viewer via the threejs library. The other viewers integrated in Omeka doesn’t support 3D.

  • Possible requirement

The module Archive Repertory must be installed when the json files that represent the 3D models use files that are identified by a basename and not a full url. This is generally the case, because the model contains an external image for texture. Like Omeka hashes filenames when it ingests files, the file can’t be retrieved by the Universal Viewer.

This module is not required when there is no external images or when these images are referenced in the json files with a full url.

To share the json with other IIIF servers, the server may need to allow CORS (see above).

  • Example

  • Allow the extension json and the media type application/json in the global settings.

  • Install the module Archive Repertory.
  • Download (or add via urls) the next three files from the official examples:
    • http://files.universalviewer.io/manifests/foundobjects/thekiss/thumb.jpg
    • http://files.universalviewer.io/manifests/foundobjects/thekiss/thekiss.jpg
    • http://files.universalviewer.io/manifests/foundobjects/thekiss/thekiss.json
  • Add a new item with these three files, in this order, and the following metadata:
    • Title: The Kiss
    • Date: 2015-11-27
    • Description: Soap stone statuette of Rodin’s The Kiss. Found at Snooper’s Paradise in Brighton UK.
    • Rights: 3D model produced by Sophie Dixon
    • License (or Rights): by-nc-nd
  • Go to the public page of the item and watch it!

Important: When using Archive Repertory and when two files have the same base name (here "thekiss.jpg" and "thekiss.json"), the image, that is referenced inside the json, must be uploaded before the json. Furthermore, the name of the thumbnail must be thumb.jpg and it is recommended to upload it first.

Finally, note that 3D models are often heavy, so the user has to wait some seconds that the browser loads all files and prepares them to be displayed.

TODO / Bugs

  • Implements ArrayObject to all classes to simplify events.
  • When a item set contains non image items, the left panel with the index is displayed only when the first item contains an image (UV).

See module Image Server.

Warning

Use it at your own risk.

It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.

Troubleshooting

See online issues on the module issues page on GitHub.

License

This module is published under the CeCILL v2.1 licence, compatible with GNU/GPL and approved by FSF and OSI.

In consideration of access to the source code and the rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors only have limited liability.

In this respect, the risks associated with loading, using, modifying and/or developing or reproducing the software by the user are brought to the user’s attention, given its Free Software status, which may make it complicated to use, with the result that its use is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the suitability of the software as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions of security.

This Agreement may be freely reproduced and published, provided it is not altered, and that no provisions are either added or removed herefrom.

Copyright

  • Copyright Daniel Berthereau, 2015-2020 (see Daniel-KM)
  • Copyright BibLibre, 2016-2017

First version of this plugin was built for the Bibliothèque patrimoniale of Mines ParisTech.

Version Released Minimum Omeka version
3.6.0-beta.2April 19, 2020 [info]^1.3.0 || ^2.0.0
3.5.16February 09, 2020 [info]^1.2.0 || ^2.0.0
3.5.15October 27, 2019 [info]^1.2.0 || ^2.0.0
3.5.15-betaJuly 21, 2019 [info]^1.2.0
3.5.14March 03, 2019 [info]^1.2.0
3.5.13February 17, 2019 [info]^1.2.0
3.5.12February 03, 2019 [info]^1.2.0
3.5.11October 28, 2018 [info]^1.1.0
3.5.10May 06, 2018 [info]^1.0.0
3.5.9November 26, 2017 [info]^1.0.0
3.5.8October 29, 2017 [info]^1.0.0-rc.1
3.5.7October 15, 2017 [info]^1.0.0-rc.1
3.5.6August 06, 2017 [info]^1.0.0-beta4
3.5.5June 25, 2017 [info]^1.0.0-beta4
3.5.4June 11, 2017 [info]^1.0.0-beta4
3.5.3March 26, 2017 [info]^1.0.0-beta