Page History
...
To enable IIIF, first edit modules/iiif.cfg
or your local.cfg
file and set iiif.enabled
to be "
true".
Code Block | ||
---|---|---|
| ||
iiif.enabled = true |
In addition, you need to provide the URL for your IIIF image server. e.g.:
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
event.dispatcher.default.consumers = versioning, discovery, eperson, iiif |
...
Property | Description |
---|---|
iiif.enabled | Enables the DSpace IIIF service. |
iiif.image.server | Base URL path for the IIIF image server. e.g. http://localhost:8182/iiif/2/ |
iiif.document.viewing.hint | Default 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-origins | Comma separated list of allowed CORS origins. The list must include the default value: ${dspace.ui.url}. |
iiif.metadata.item | Sets the Dublin Core metadata that will be added to the IIIF resource manifest. This property can be repeated. |
iiif.metadata.bitstream | Sets 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 | ||
---|---|---|
| ||
Note that the |
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.
...
Schema | Element | Qualifier | Scope | Description |
---|---|---|---|---|
dspace | iiif | enabled | Item or Collection | Stores a boolean text value (true or false) to indicate if the iiif feature is enabled or not |
iiif | label | Bitstream | Metadata field used to set the IIIF label associated with the canvas resource otherwise the system | |
iiif | description | Item | Metadata field used to set the IIIF description associated with the resource. | |
iiif | canvas | naming | Item | Metadata field used to set the base label used to name all the canvas in the Item. The canvas |
iiif | viewing | hint | Item | Metadata field used to set the viewing hint overriding the configuration value if any. Possible |
iiif | image | width | Item or Bitstream | Metadata field used to store the width of an image in pixels. Determines the canvas size. |
iiif | image | height | Item or Bitstream | Metadata field used to store the height of an image in pixels. Determines the canvas size. |
iiif | toc | Bitstream | Metadata field used to set the position of the iiif resource in the "table of contents" structure. | |
iiif | search | enabled | Item | Metadata field used to enable the IIIF Search service at the item level. This feature is |
...
title | Required |
---|
...
. |
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.
...