Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To enable IIIF, first edit modules/iiif.cfg or your local.cfg file and set iiif.enabled to be "true".




Code Block
languagetext
iiif.enabled = true


In addition, you need to provide the URL for your IIIF image server. e.g.:

Code Block
languagetext
iiif.image.server = http://localhost:8182/iiif/2/

Finally, update dspace.cfg or your local.cfg file by adding "iiif" to the default event dispatcher, as shown below:

Code Block
languagetext
event.dispatcher.default.consumers = versioning, discovery, eperson, iiif

...

PropertyDescription
iiif.enabledEnables the DSpace IIIF service.
iiif.image.serverBase URL path for the IIIF image server. e.g. http://localhost:8182/iiif/2/
iiif.document.viewing.hintDefault viewing hint. Can be overridden with the metadata setting described below.

iiif.logo.image

Optional URL for a small image. This will be included in all IIIF manifests.

iiif.cors.allowed-originsComma separated list of allowed CORS origins. The list must include the default value:  ${dspace.ui.url}.
iiif.metadata.itemSets the Dublin Core metadata that will be added to the IIIF resource manifest. This property can be repeated.
iiif.metadata.bitstreamSets the Bitstream metadata that will be added to the IIIF canvas metadata for individual images. This property can be repeated.
iiif.license.uri

Sets the metadata used for information about the resource usage rights.

iiif.attribution

The text to use as attribution in the iiif manifests. Defaults to:  ${dspace.name}

iiif.document.viewing.hint

Either "individuals", "paged" or "continuous". Can be overridden with the metadata setting described below.


Metadata Settings


Note
titleRequired

Note that the dspace.iiif.enabled metadata field MUST be added to the Item (or optionally to the parent Collection) and set to true. Otherwise, the Item display will use the default DSpace view.


IIIF behavior at the Item level is flexible and can be modified using metadata. Canvas sizes, image labels, ranges and and other settings are managed using the following fields.

...

SchemaElementQualifierScopeDescription
dspaceiiifenabledItem  or Collection

Stores a boolean text value (true or false) to indicate if the iiif feature is enabled or not
for the dspace object. If absent the value is derived from the parent dspace object.

iiiflabel
Bitstream

Metadata field used to set the IIIF label associated with the canvas resource otherwise the system
will derive one according to the configuration setting or the canvas.naming metadata field.

iiifdescription
Item

Metadata field used to set the IIIF description associated with the resource.

iiifcanvasnamingItem

Metadata field used to set the base label used to name all the canvas in the Item. The canvas
label will be generated using the value of this metadata as prefix and the canvas position.
e.g. Page 1, Page 2, etc.

iiifviewing hintItem

Metadata field used to set the viewing hint overriding the configuration value if any. Possible
values are "individuals" and "paged". Default value: individuals.

iiifimagewidthItem or Bitstream

Metadata field used to store the width of an image in pixels. Determines the canvas size.

iiif imageheightItem or Bitstream

Metadata field used to store the height of an image in pixels. Determines the canvas size.

iiiftoc
Bitstream

Metadata field used to set the position of the iiif resource in the "table of contents" structure.

iiifsearchenabled

Item

Metadata field used to enable the IIIF Search service at the item level. This feature is
experimental and requires additional setup.

...

titleRequired

...

.



Adding the Mirador Viewer

...

Finally, notice that the image server needs to retrieve the requested bitstream from DSpace. There are a number of ways to do this and the details vary with the image server chosen. The easiest approach is for the image server to request the bitstream via HTTP and the DSpace API, using a URL like http:/dspace.mycampus.edu:8080/server/api/core/bitstreams/4b415036-57a8-42f4-a971-c5e982f55f92/content

...

By default, the DSpace IIIF backend is configured to accept requests from the Angular client origin. To support the type of sharing that IIIF facilitates you can configure addtional CORS origins using the iiif.cors.allowed-origins property defined in iiif.cfg. Currently, DSpace does not support the "*" wildcard but you are free to add multiple, comma-separated origins to the list.

...