Current Release
This documentation covers the latest release of Islandora 7.x. For the very latest in Islandora, we recommend Islandora 8.

Skip to end of metadata
Go to start of metadata

Introduction

A Islandora wrapper for the Internet Archive BookReader.

This module doesn't do much on its own, its assumed that it will be used in conjunction with a solution pack, where it will be provided as a viewer.

Islandora 7.x-1.13 have updated version of IA BookReader (v2) which improve view of books and have adapted version for mobile devices.

BookReader (Desktop view)        BookReader (Mobile view)

Requirements

This module requires the following modules/libraries:

And one (1) of the following Image Server options:

This module has the following as optional requirements for certain features:

Allows OCR based search using the Viewer's Search box.

Installation

Install as usual, see this for further information.

Download the 2.0.2 version of the Internet Archive BookReader to sites/all/libraries/bookreader, or run drush iabookreader-plugin. If you are upgrading from the 7.x-1.11 or older version of this module, you will need to replace your old copy of this library. (Newer versions than 2.0.2 may work but have not been tested.).

Internet Archive BookReader Developer documentation

This module requires that you set up either Djatoka or an IIIF Image API compliant Image Sever. For Djatoka please follow the steps outlined at here.

This module requires Colorbox and its dependant library Colorbox library. Depending on the version of the Colorbox module and library you are using, there can be some issues with Colorbox finding the library. This comment solves the issue.

Note: If you use the Drush command, it is advisable to Move (not copy) the install script to your .drush folder before running it.

Important: This version of IA BookReader was updated to version 2.0.2 and is downloaded from their Github repo. If you made some specific adaptation of BookReader for your Islandora will be lost in v2.

Configuration

Common settings

You can setup which 'Solr field relating pages to book PIDs' is used, the amount of 'Overlay Opacity', what content type is to be displayed to final users within the Internet Archive Book Reader Viewer, the 'Default page view' mode and the full screen behaviour for mobile users in Administration » Islandora » Islandora Viewers » Internet Archive BookReader (/admin/islandora/islandora_viewers/internet_archive_bookreader).

Image server selection

This module is able to use either Adore-djatoka or an IIIF Image API compliant Image Server as source for each book's page image.

Adore-djatoka

Djatoka specific options are:

  • Compression level (the larger the number, the lower the quality but also the smaller the file size)
  • Using an Object's JPG datastream as a backup in case Djatoka cannot return a JP2.

Note: The Adore-datoka Server URI (Open URL endpoint) must be set from Islandora Paged Content Solution Pack's admin settings.



IIIF

Any IIIF image server can be used as the IIIF tile source.

The IIIF Image Server Base URL needs to be setup here. This URL can be relative or absolute but needs to be openly accessible to a visiting user (Ajax).

This module provides Drupal tokens to allow highly configurable replacement patterns to be used for the IIIF identifier creation.

These IIIF identifier are send to the IIIF Image server where they are resolved back into URLs that can be accessed by it and used as Source for its tile creation.

This resolvers need to be properly configured at the Image server level. E.g, a Cantaloupe melon IIIF image server can be configured to resolve these identifiers using the HttpResolver with no prefix specified.

Islandora also uses temporary authentication tokens to give backend services limited time access to protected resources (Datastreams). You can select if those tokens are passed as part of a IIIF identifier or via an HTTP Header.




Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

Maintainers/Sponsors

Current maintainers:

Development

If you would like to contribute to this module, please check out CONTRIBUTING.md. In addition, we have helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.



  • No labels