This repository is archived as of September 2020. The module was a custom module developed in 2015 before Islandora came with IIIF (https://www.slideshare.net/KellliBee/20150803-51261740). The module will not be updated as U of T Libraries is migrating off of Islandora. The module does not work with the IIIF infrastructure that is now built-in to current Islandora or ISLE versions.
This module implements Mirador open source IIIF image viewer for Islandora Book Solution Pack.
This module development was supported by the The Andrew W. Mellon Foundation for the [French Renaissance Paleography website] (https://paleography.library.utoronto.ca/).
- Drupal module Libraries
- Compiled Mirador javascript library
- Stable 2.0 version
- Sourcecode on Github You need to compile it; the 2.0.0 tag is identical as the release. The Master branch contains many experimental features that are not stable, but fun for testing.
- IIIF Image API server
- Loris works well.
- JSON SharedCanvas Manifest Fedora datastreams for Book Solution Pack objects
- You can generate them using the Islandora SC Manifest module
- Download compiled Mirador javascript library into Drupal's libraries directory, usually in
sites/all/libraries. Verify the file permission is web servable. - Clone and enable this module.
- Go to admin/islandora/solution_pack_config/book and choose Mirador BookReader under Book Viewers.
At this point, the viewer will show an example manuscript with an option to manually add SharedCanvas Manifests from URL.
In order for the viewer to automatically display the current page's book object, you must generate a SCManifest JSON datastream for the object and tell the viewer to use this datastream when loading the page.
Please read the instruction within the Islandora SC Manifest module module or the SharedCanvas Manifest API on how to generate such a datastream.
After you have generate the datastream, configure the viewer with the following:
- Open Mirador Bookreader configuration
admin/islandora/islandora_viewers/mirador_bookreader - Under Manfiest datastream ID enter the correct value. If you are using Islandora SC Manifest module, the default ID is SC.
This module adds the functionality of loading all the children book objects under a collection within the "Add New Object" in Mirador to allow for faster switching between objects, instead of navigating using the Drupal pages. This functionality is not required for this module to display the objects.
For this to work, first the PID of the parent collection must be specified in admin/islandora/islandora_viewers/mirador_bookreader
The module can then generate a JSON list of links to SCManifest datastreams at admin/islandora/islandora_viewers/mirador_bookreader/json_generate
The result is a JSON array of links to the SharedCanvas Manifest datastreams of Book Solution Pack object. The Mirador viewer will use AJAX to load all of the links upon loading of any Book object page.
Paleography does not use the default Mirador javascript library, instead, uses a modified version by Bryan Haberberger from Saint Louis University. This version is a fork of the official version 2.0 library, and includes image manipulation in the UI, improved error catching and other improvements. This version is actively maintained by Bryan.
The thumbnails do not appear unless the view changes. In $.ThumbnailsView's Handelbars the src attribute does not receive the value when first loading. To fix this, thumbUrl was placed into the src value.
When Mirador is initialized with an array of manifests, it can display any one of them automatically by setting the loadedManifest option in the windowObjects array. However, Mirador does not prioritize loading the loadedManifest, causing it to wait until the other manifests before it in the array have been loaded. If the current manifest is in low position in a large array, the wait could be long. The fix was to manually rearrange the loadedManifest's position to be at top before initializing Mirador.
In official release the annotation overlay "speech bubble" can be removed by setting annotationLayer to false in the windowObjects array. However, the setting could not be applied to subsequent windows. Instead, the overlay link is hidden from view via CSS.
Copyright 2016 University of Toronto Libraries
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.