Mercurial > hg > digilib

comparison doc/src/site/markdown/iiif-api.md @ 1635:cd45d49f438d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cleanup and add doc about Manifester servlet.
author robcast
date Fri, 02 Jun 2017 19:01:36 +0200
parents 1616ea719290
children b234dd84320d
comparison
equal deleted inserted replaced
1632:5c81d249ccd0 1635:cd45d49f438d
1 # The digilib IIIF API 1 # The digilib IIIF API
2
3 ## IIIF Image API
2 4
3 The Scaler servlet provides not only its native [Scaler API](scaler-api.html) but also an API compliant to the standards of the International Image Interoperability Framework http://iiif.io. 5 The Scaler servlet provides not only its native [Scaler API](scaler-api.html) but also an API compliant to the standards of the International Image Interoperability Framework http://iiif.io.
4 6
5 As of version 2.3.7 digilib supports the [IIIF Image API version 2](http://iiif.io/api/image/2.0/) at [compliance level 2](http://iiif.io/api/image/2.0/compliance.html). You can switch between API version 1.1 and 2.0 support with the `iiif-api-version` parameter in [digilib-config](digilib-config.html), 7 As of version 2.3.7 digilib supports the [IIIF Image API version 2](http://iiif.io/api/image/2.1/) at [compliance level 2](http://iiif.io/api/image/2.0/compliance.html). You can switch between API version 1.1 and 2.0 support with the `iiif-api-version` parameter in [digilib-config](digilib-config.html),
6 8
7 IIIF Image API URLs for an image request have the form: 9 IIIF Image API URLs for an image request have the form:
8 10
9 http[s]://{server}/{digilib-webapp}/Scaler/{iiif-prefix}/{identifier}/{region}/{size}/{rotation}/{quality}.{format} 11 http[s]://{server}/{digilib-webapp}/Scaler/{iiif-prefix}/{identifier}/{region}/{size}/{rotation}/{quality}.{format}
10 12
21 http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/full/!150,75/0/default.jpg 23 http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/full/!150,75/0/default.jpg
22 24
23 An info request URL for the same image looks like: 25 An info request URL for the same image looks like:
24 26
25 http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/info.json 27 http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/info.json
28
29 ## IIIF Presentation API
30
31 As of version 2.5.3 digilib provides the optional Manifester servlet that generates simple [IIIF Presentation API version 2](http://iiif.io/api/presentation/2.1) manifests that can be used with any [IIIF viewer](http://iiif.io/apps-demos/#image-viewing-clients) to navigate a directory full of images with the functions of a book-reader or light-table.
32
33 To build digilib with the Manifester servlet you need to add the `iiif-presentation` profile to your Maven build:
34
35 mvn -Piiif-presentation package
36
37 (or use the digilib-webapp-X.X.X-srv3p.war file from the website)
38
39 The Manifester servlet URLs have the form:
40
41 http[s]://{server}/{digilib-webapp}/Manifester/{iiif-prefix}/{identifier}
42
43 So you can get a manifest for all images in the directory `/books/book1` with a URL like:
44
45 http://www.example.org/digilib/Manifester/IIIF/books!book1
46
47 To try out a viewer on your manifest you can go to the website of the Universal Viewer [http://universalviewer.io/](http://universalviewer.io/) and enter the URL of your manifest in the "view a manifest" box on the page. This will work even with a local digilib installation since the Javascript in your Browser reads and interprets the manifest.