Skip to content

Commit

Permalink
Mention Mirador where appropriate. (#2188)
Browse files Browse the repository at this point in the history
  • Loading branch information
rosiel authored Nov 8, 2022
1 parent bcc9218 commit e73c35b
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 9 deletions.
6 changes: 5 additions & 1 deletion docs/contributing/releasing-islandora.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,17 @@ Release the `jsonld` module by creating a new release for it in Github.

Release the `openseadragon` module by creating a new release for it in Github.

### Release Islandora Mirador

Release the `islandora_mirador` module by creating a new release for it in Github.

### Release migrate_islandora_csv

Release the `migrate_islandora_csv` module by creating a new release for it in Github.

### Release Chullo

Release chullo by creating a new release for it in Github.
Release `chullo` by creating a new release for it in Github.

### Release Crayfish-Commons

Expand Down
1 change: 1 addition & 0 deletions docs/technical-documentation/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The following Islandora components use semantic versioning:
* [islandora](https://github.com/Islandora/islandora/tree/8.x-1.x) (Drupal module)
* [jsonld](https://github.com/Islandora/jsonld) (Drupal module)
* [openseadragon](https://github.com/Islandora/openseadragon) (Drupal module)
* [islandora\_mirador](https://github.com/Islandora/islandora_mirador) (Drupal module)

Drupal submodules, which are included in several of the above modules, share versions with their parents.

Expand Down
5 changes: 3 additions & 2 deletions docs/user-documentation/file_viewers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ In Drupal, a common way to implement a viewer is through a [module](glossary.md#

Viewers that are known to work with Islandora include:

* [OpenSeadragon](https://openseadragon.github.io/), via the Drupal module [OpenSeadragon](https://github.com/Islandora/openseadragon) (maintained by the Islandora Foundation).
* [OpenSeadragon](https://openseadragon.github.io/), via the Drupal module [OpenSeadragon](https://github.com/Islandora/openseadragon) (maintained by the Islandora community).
* [Mirador](https://projectmirador.org/), via the Drupal module [Islandora Mirador](https://github.com/Islandora/islandora_mirador/) (maintained by the Islandora community).
* [pdf.js](https://github.com/mozilla/pdf.js), via the Drupal contrib module [PDF](https://www.drupal.org/project/pdf)

Both are included with the Islandora Starter Site.
OpenSeadragon and pdf.js are included with the Islandora Starter Site.


## How are viewers configured?
Expand Down
22 changes: 16 additions & 6 deletions docs/user-documentation/iiif.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

At a practical level, because Islandora supports several of the IIIF specifications, we can:

- Zoom, pan, and rotate images within OpenSeadragon
- Zoom, pan, and rotate images within a IIIF-compliant [viewer](../file_viewers) like OpenSeadragon or Mirador
- Islandora uses an IIIF-compliant image server (by default, [Cantaloupe](https://cantaloupe-project.github.io/)) that utilizes the [IIIF Image API](https://iiif.io/api/image/2.1/). This capability is similar to what Islandora 7.x users experience when they view a Large Image.
- Display thumbnails for all pages of a book or newspaper issue within image viewers
- IIIF-compliant image viewers such as OpenSeadragon or Mirador can display a "collection" of images such as all the pages of a book or newspaper issue using the [IIIF Presentation API](https://iiif.io/api/presentation/2.1/). For example, here is a screenshot of OpenSeadragon rendering all the pages of a book:
Expand All @@ -13,11 +13,21 @@ At a practical level, because Islandora supports several of the IIIF specificati

## Using IIIF in Islandora

Implementation of the IIIF Presentation API is new in Islandora, and using it is as simple as configuring a Context (in fact, you don't even need to configure it; the Context, OpenSeadragon Block, already exists by default).
<!-- todo: Put a link to paged-content.md below when it exists. -->
To use this Context, all that is required is for your book or newspaper (or other paged content) to be given a model of "Paged Content" or "Publication Issue". Then, in the Open Seadragon Block Context, make sure the term used in the "Node has term" condition (you can register more than one term there). Now, when you view a paged content Islandora object, you will see thumbnails of all of its child pages (assuming you have added some child pages to the object) in the OpenSeadragon viewer as illustrated above.
If you're not using one of our provisioning tools, you will need to:
* install and configure the Cantaloupe (or another IIIF-compliant) image server
* install a [viewer](../file-viewers) module and configure it to point to the IIIF Image server location
* if using the viewer to show single images, configure it as a file formatter in one of the display modes for your media.
* if using the viewer to show multi-paged content, install the [Islandora IIIF](https://github.com/Islandora/islandora/tree/2.x/modules/islandora_iiif) module and create a IIIF view (see the one in the Starter Site as an example), then configure the viewer's _block_ to show up where desired (see below for details on how it could be configured)

You can change how the paged content thumbnails are arranged in the OpenSeadragon viewport by doing the following:

## Using IIIF in the Islandora Starter Site

The Islandora Starter Site uses a Context to automatically use the IIIF Presentation API for showing [paged content](../paged-content).


To use this Context, give your book or newspaper (or other paged content) a model of "Paged Content" or "Publication Issue". Then, in the _Paged Content - Openseadragon_ Context, make sure the term used is in the "Node has term" condition (you can register more than one term there). Now, when you view a paged content Islandora node, you will see service files of all of its child pages (assuming you have added some child pages to the object) in the OpenSeadragon viewer as illustrated above.

You can change how the paged content images are arranged in the OpenSeadragon viewport by doing the following:

1. Visit `admin/config/media/openseadragon`
1. Scroll to the bottom, where you will see the "Collection Mode" options.
Expand All @@ -37,4 +47,4 @@ You can change how the paged content thumbnails are arranged in the OpenSeadrago
* [The Biblissima Project](http://demos.biblissima-condorcet.fr/mirador/) - brings together related content from different repositories.
* [diva.js](https://ddmal.music.mcgill.ca/diva.js/try/iiif-external.html) - select a source from the drop-down list at the top.

These two examples have nothing to do with Islandora, but illustrate the potential for IIIF to build tools that extend beyond a given repository platform.
These two examples have nothing to do with Islandora, but illustrate the potential for IIIF to build tools that extend beyond a given repository platform.

0 comments on commit e73c35b

Please sign in to comment.