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

cleanup and add doc about Manifester servlet.
author robcast
date Fri, 02 Jun 2017 19:01:36 +0200
parents 1616ea719290
children b234dd84320d
line wrap: on
line diff
--- a/doc/src/site/markdown/iiif-api.md	Fri Jun 02 12:41:24 2017 +0200
+++ b/doc/src/site/markdown/iiif-api.md	Fri Jun 02 19:01:36 2017 +0200
@@ -1,8 +1,10 @@
 # The digilib IIIF API
 
+## IIIF Image API
+
 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.
 
-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),  
+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),  
 
 IIIF Image API URLs for an image request have the form:
 
@@ -23,3 +25,23 @@
 An info request URL for the same image looks like: 
 
     http://www.example.org/digilib/Scaler/IIIF/books!book1!page0002/info.json
+
+## IIIF Presentation API
+
+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.
+
+To build digilib with the Manifester servlet you need to add the `iiif-presentation` profile to your Maven build:
+
+    mvn -Piiif-presentation package
+
+(or use the digilib-webapp-X.X.X-srv3p.war file from the website)
+
+The Manifester servlet URLs have the form:
+
+    http[s]://{server}/{digilib-webapp}/Manifester/{iiif-prefix}/{identifier}
+
+So you can get a manifest for all images in the directory `/books/book1` with a URL like:
+
+    http://www.example.org/digilib/Manifester/IIIF/books!book1
+
+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.