# HG changeset patch
# User robcast
# Date 1497276284 -7200
# Node ID 248c7df143cf77083b8042843bf0d2afbe137d67
# Parent ba6e93840f38c594b4ddc4b74eee9acb7a0990ec# Parent 3972535c1146ebfb4619eb99daab73a656bdb534
Merge from HEAD
3972535c1146ebfb4619eb99daab73a656bdb534
diff -r ba6e93840f38 -r 248c7df143cf common/doc/Scaler.html
--- a/common/doc/Scaler.html Fri Jun 02 12:44:58 2017 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,157 +0,0 @@
-
-
-
-
-Scaler servlet
-
-
-Scaler
-
-A Servlet for scaling images. (Version 1.5.2)
-
-Web API
-
-The Scaler servlet takes parameters in the http request format:
-Scaler/request_path/?param1=value1¶m2=value2&...
-Unknown parameters will be silently ignored.
-
-Recognised parameters:
-
- - request_path path to file or directory.
-
- - fn path to file or directory below
/docuserver/images
- (or other configured image directory).
- This path will be added to the request_path behind the servlet name.
- Either parameter can be empty.
-
- - pn page number. Index into the (alphabetically sorted) directory
- given by the path. Starts with 1. Ignored if the path points to a file.
- Default: 1.
-
- - dw destination image width (pixels). If omitted the image is scaled to fit
- dh.
-
- - dh destination image height (pixels). If omitted the image is scaled to fit
- dw.
-
- - wx relative x offset of the image area to be sent (0 <= wx <= 1).
- Default: 0.
-
- - wy relative y offset of the image area to be sent (0 <= wy <= 1).
- Default: 0.
-
- - ww relative width of the image area to be sent (0 <= ww <= 1).
- Default: 1.
-
- - wh relative height of the image area to be sent (0 <= wh <= 1).
- Default: 1.
-
- - ws additional scaling factor. The resulting image will have the size
-
[ws*dw,ws*dh]. Default: 1.
-
- - mo flags for the mode of operation separated by ",".
-
- - fit: always scale the image to fit
-
[dw,dh] (default).
-
- clip: send the file in its
- original resolution, cropped to fit [dw,dh].
-
-
- osize: scale to original size based on the image resolution
- (from the image metadata) and display resolution (from parameter
- ddpi). Fails if either resolution is unknown.
-
-
- -
- file: send the file as-is (may
- be very large and all sorts of image types!). If configuration
- doesn't allow sending files
- (
sendfile-allowed=false) revert to
- clip.
-
- rawfile: send the file as-is with a mime-type of
- application/octet-stream so it can be downloaded with
- the browser.
-
-
- - errtxt: send error response as HTML.
- errimg: response as image (default).
-
- - q0-q2: quality of interpolation in scaling
- (
q0: worst, default).
-
- - lores: try to use scaled image (default)
-
- hires: always use unscaled image.
-
- If the image is zoomed (ww, wh < 1) the use of the scaled
- image files depends on the requested resolution.
-
- - vmir: mirror image vertically.
-
- hmir: mirror image horizontally.
-
- - jpg: the resulting image is always sent as JPEG
- (otherwise TIFF and PNG images are sent as PNG).
-
-
-
-
- - cont: change contrast of the image. Negative value
- reduces contrast, positive value enhances contrast. Pixel value is
- multiplied by 2^cont. Default: 0
-
- - brgt: change brightness of image. Negative value reduces
- brightness, positive value enhances brightness. The value brgt is
- added to the pixel value. Default: 0
-
- - rot: rotate image. Rotation angle is given in
- degrees. Default: 0
-
- - rgbm: modify color by multiplication. The contrast of the
- red green and blue components of the image can be reduced or
- enhanced similar to the
cont parameter. The factors for
- red, green and blue are separated by slashes (for example
- 0.86/0/-0.5). Default: 0/0/0
-
- - rgba: modify color by addition. The brightness of the red
- green and blue components of the image can be reduced or enhanced
- similar to the
brgt parameter. The factors for red,
- green and blue are separated by slashes (for example
- 100/0/25). Default: 0/0/0
-
- - ddpi: resolution of client display for
osize mode.
- Either ddpi or ddpix and ddpiy must
- be set to use osize mode.
-
- - ddpix: resolution of client display in x direction for
-
osize mode.
-
- - ddpiy: resolution of client display in y direction for
-
osize mode.
-
-
-
- The image to be loaded can be specified by the
- request_path (deprecated) or the fn
- (preferred) parameter and the optional index pn
-
- - if
fn points to a directory then the file with
- the index pn (in alphabetical order according to
- ASCII) will be loaded
-
- - if
fn points to a file (with or without
- extension) then this file will be loaded
-
-
- The image will be scaled equally in horizontal and vertical
- direction such that the resulting image does not exceed the rectangle
- [dw,dh]. If only either height or width is given the
- image is scaled to match only the given parameter. The size of the
- resulting image in the other parameter is determined by the aspect
- ratio of the image.
-
-
-
-
diff -r ba6e93840f38 -r 248c7df143cf common/src/main/java/digilib/conf/DigilibRequest.java
--- a/common/src/main/java/digilib/conf/DigilibRequest.java Fri Jun 02 12:44:58 2017 +0200
+++ b/common/src/main/java/digilib/conf/DigilibRequest.java Mon Jun 12 16:04:44 2017 +0200
@@ -355,7 +355,7 @@
/*
* parse sequence of parameters as IIIF image API
*/
- String identifier = null;
+ String identifier = ""; // empty name means image root directory
String region = null;
String size = null;
String rotation = null;
diff -r ba6e93840f38 -r 248c7df143cf doc/src/site/markdown/iiif-api.md
--- a/doc/src/site/markdown/iiif-api.md Fri Jun 02 12:44:58 2017 +0200
+++ b/doc/src/site/markdown/iiif-api.md Mon Jun 12 16:04:44 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.
diff -r ba6e93840f38 -r 248c7df143cf iiif-presentation/src/main/java/digilib/servlet/Manifester.java
--- a/iiif-presentation/src/main/java/digilib/servlet/Manifester.java Fri Jun 02 12:44:58 2017 +0200
+++ b/iiif-presentation/src/main/java/digilib/servlet/Manifester.java Mon Jun 12 16:04:44 2017 +0200
@@ -202,11 +202,9 @@
return;
}
// get identifier (first parameter)
- String identifier = iiifParams.get(0);
- if (identifier == null) {
- logger.error("IIIF identifier missing");
- response.sendError(HttpServletResponse.SC_BAD_REQUEST, "IIIF identifier missing.");
- return;
+ String identifier = ""; // allow empty identifier for image root dir
+ if (iiifParams.size() > 0) {
+ identifier = iiifParams.get(0);
}
// decode identifier to file path
dlRequest.setValueFromString("fn", dlRequest.decodeIiifIdentifier(identifier));
diff -r ba6e93840f38 -r 248c7df143cf webapp/src/main/webapp/WEB-INF/digilib-config.xml.off
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/webapp/src/main/webapp/WEB-INF/digilib-config.xml.off Mon Jun 12 16:04:44 2017 +0200
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+