Mercurial > hg > digilib

comparison doc/src/site/markdown/digilib-short.md @ 1402:7770ac493446

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
small doc improvements.
author robcast
date Mon, 12 Oct 2015 15:07:25 +0200
parents 828b6c8b1b19
children
comparison
equal deleted inserted replaced
1401:4b4973a9f34a 1402:7770ac493446
46 46
47 The [Scaler API](scaler-api.html) is documented on the digilib.sourceforge.net 47 The [Scaler API](scaler-api.html) is documented on the digilib.sourceforge.net
48 pages. Here is a minimal version: 48 pages. Here is a minimal version:
49 49
50 The Scaler servlet takes parameters in the HTTP request format: 50 The Scaler servlet takes parameters in the HTTP request format:
51 `Scaler/request\_path/?param1=value1&param2=value2&...` Unknown parameters 51 `Scaler?param1=value1&param2=value2&...` Unknown parameters
52 will be silently ignored. 52 will be silently ignored.
53 53
54 Recognised parameters: 54 Recognised parameters:
55 55
56 - `request_path` path to file or directory. 56 - `fn` path to file or directory. All paths are relative to the configured base directory
57 - `fn` path to file or directory. This path will be added to the
58 `request_path` behind the servlet name. Either parameter can be
59 empty. All paths are relative to the configured base directory
60 (digilib-config parameter `basedir-list`). 57 (digilib-config parameter `basedir-list`).
61 - `pn` page number. Index into the (alphabetically sorted) 58 - `pn` page number. Index into the (alphabetically sorted)
62 directory given by the path. Starts with 1. Ignored if the path 59 directory given by the path. Starts with 1. Ignored if the path
63 points to a file. Default: 1. 60 points to a file. Default: 1.
64 - `dw` destination image width (pixels). If omitted the image is 61 - `dw` destination image width (pixels). If omitted the image is
71 `wy` <= 1). Default: 0. 68 `wy` <= 1). Default: 0.
72 - `ww` relative width of the image area to be sent (0 <= `ww` 69 - `ww` relative width of the image area to be sent (0 <= `ww`
73 <= 1). Default: 1. 70 <= 1). Default: 1.
74 - `wh` relative height of the image area to be sent (0 <= `wh` 71 - `wh` relative height of the image area to be sent (0 <= `wh`
75 <= 1). Default: 1. 72 <= 1). Default: 1.
76 - The image to be loaded can be specified by the `request_path` 73 - The image to be loaded can be specified by `fn` parameter and the optional
77 (deprecated) or the `fn` (preferred) parameter and the optional
78 index `pn` 74 index `pn`
79 - if `fn` points to a directory then the file with the index `pn` 75 - if `fn` points to a directory then the file with the index `pn`
80 (in alphabetical order according to ASCII) will be loaded 76 (in alphabetical order according to ASCII) will be loaded
81 - if `fn` points to a file (with or without extension) then this 77 - if `fn` points to a file (with or without extension) then this
82 file will be loaded 78 file will be loaded
86 If only either height or width is given the image is scaled to match 82 If only either height or width is given the image is scaled to match
87 only the given parameter. The size of the resulting image in the other 83 only the given parameter. The size of the resulting image in the other
88 parameter is determined by the aspect ratio of the image. 84 parameter is determined by the aspect ratio of the image.
89 85
90 An example for a Scaler URL is: 86 An example for a Scaler URL is:
91 `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` 87 `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`
92 such a URL can be used as src attribute to an img element in the 88 such a URL can be used as src attribute to an img element in the
93 frontend HTML. 89 frontend HTML.
94 90
95 [1]: https://sourceforge.net/p/digilib/code/ci/default/tree/webapp/src/main/webapp 91 [1]: https://sourceforge.net/p/digilib/code/ci/default/tree/webapp/src/main/webapp
96 92