Commit 857c6026 authored by robcast's avatar robcast

small doc improvements.

parent 9e36e619
...@@ -54,9 +54,6 @@ configuration options use the source: ...@@ -54,9 +54,6 @@ configuration options use the source:
is first in list. --> is first in list. -->
<parameter name="basedir-list" value="/docuserver/images:/docuserver/scaled/small" /> <parameter name="basedir-list" value="/docuserver/images:/docuserver/scaled/small" />
<!-- mimimum amount of scaling done with antialiasing -->
<parameter name="subsample-minimum" value="2"/>
<!-- default interpolation quality (0=worst) --> <!-- default interpolation quality (0=worst) -->
<parameter name="default-quality" value="2"/> <parameter name="default-quality" value="2"/>
...@@ -88,7 +85,7 @@ configuration options use the source: ...@@ -88,7 +85,7 @@ configuration options use the source:
<!-- use mapping of "virtual directories" to real directories on the server --> <!-- use mapping of "virtual directories" to real directories on the server -->
<parameter name="use-mapping" value="false"/> <parameter name="use-mapping" value="false"/>
<!-- location of XML mapping file --> <!-- location of XML name mapping file -->
<parameter name="mapping-file" value="digilib-map.xml"/> <parameter name="mapping-file" value="digilib-map.xml"/>
<!-- location of logger config file --> <!-- location of logger config file -->
......
...@@ -48,15 +48,12 @@ The [Scaler API](scaler-api.html) is documented on the digilib.sourceforge.net ...@@ -48,15 +48,12 @@ The [Scaler API](scaler-api.html) is documented on the digilib.sourceforge.net
pages. Here is a minimal version: pages. Here is a minimal version:
The Scaler servlet takes parameters in the HTTP request format: The Scaler servlet takes parameters in the HTTP request format:
`Scaler/request\_path/?param1=value1&param2=value2&...` Unknown parameters `Scaler?param1=value1&param2=value2&...` Unknown parameters
will be silently ignored. will be silently ignored.
Recognised parameters: Recognised parameters:
- `request_path` path to file or directory. - `fn` path to file or directory. All paths are relative to the configured base directory
- `fn` path to file or directory. This path will be added to the
`request_path` behind the servlet name. Either parameter can be
empty. All paths are relative to the configured base directory
(digilib-config parameter `basedir-list`). (digilib-config parameter `basedir-list`).
- `pn` page number. Index into the (alphabetically sorted) - `pn` page number. Index into the (alphabetically sorted)
directory given by the path. Starts with 1. Ignored if the path directory given by the path. Starts with 1. Ignored if the path
...@@ -73,8 +70,7 @@ Recognised parameters: ...@@ -73,8 +70,7 @@ Recognised parameters:
<= 1). Default: 1. <= 1). Default: 1.
- `wh` relative height of the image area to be sent (0 <= `wh` - `wh` relative height of the image area to be sent (0 <= `wh`
<= 1). Default: 1. <= 1). Default: 1.
- The image to be loaded can be specified by the `request_path` - The image to be loaded can be specified by `fn` parameter and the optional
(deprecated) or the `fn` (preferred) parameter and the optional
index `pn` index `pn`
- if `fn` points to a directory then the file with the index `pn` - if `fn` points to a directory then the file with the index `pn`
(in alphabetical order according to ASCII) will be loaded (in alphabetical order according to ASCII) will be loaded
...@@ -88,7 +84,7 @@ only the given parameter. The size of the resulting image in the other ...@@ -88,7 +84,7 @@ only the given parameter. The size of the resulting image in the other
parameter is determined by the aspect ratio of the image. parameter is determined by the aspect ratio of the image.
An example for a Scaler URL is: An example for a Scaler URL is:
`http://digilib.mpiwg-berlin.mpg.de/digitallibrary/servlet/Scaler?fn=experimental/digilib-test/images&wh=0.1712&ww=0.1282&wy=0.1681&wx=0.6895&dw=862&dh=904` `http://digilib.mpiwg-berlin.mpg.de/digitallibrary/Scaler?fn=experimental/digilib-test/images&wh=0.1712&ww=0.1282&wy=0.1681&wx=0.6895&dw=862&dh=904`
such a URL can be used as src attribute to an img element in the such a URL can be used as src attribute to an img element in the
frontend HTML. frontend HTML.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment