/openseadragon

Drupal 8 Field Formatter for OpenSeadragon

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

Mascot OpenSeadragon

Build Status Contribution Guidelines LICENSE

Introduction

Drupal 8 FieldFormatter to display an image or generic file using a IIIF Image server and OpenSeadragon.

Requirements

Installation

As a Drupal module, this module can be installed via composer and enabled via Drush, like:

  1. composer require islandora/openseadragon:dev-8.x-1.x
  2. download the version of OpenSeadragon that you want to install (i.e. download a release zip or tar from https://github.com/openseadragon/openseadragon/releases and unarchive it)
  3. place the version of OpenSeadragon in your drupal install in a location such as web/sites/all/assets/vendor/openseadragon
  4. drush pm-en openseadragon

If you are using the islandora-playbook, there is an Ansible role already built for installing OpenSeadragon.

Configuration

The module, once enabled will create a configuration page under Configuration > Media > Openseadragon Settings. There will be some default settings checked for you. The one setting which you will need to set as a required minimum is the IIIF Image Server Location, such as http://127.0.0.1:8080/cantaloupe/iiif/2 There are a myriad of other configuration settings available there. Additional OpenSeadragon documentation is available here

Config

Documentation

Further documentation for this module is available on the Islandora 8 documentation site.

Troubleshooting/Issues

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

Maintainers

Current maintainers:

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. If you want to pull down the submodules for development, don't forget to run git submodule update --init --recursive after cloning.

License

GPLv2