Mercurial > hg > digilib-doc

comparison src/site/markdown/digilib-config.md @ 8:de31af0ad401

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
more doc for the website.
author casties
date Wed, 04 Sep 2013 09:08:17 +0200
parents cf3abd6ff312
children
comparison
equal deleted inserted replaced
7:cf3abd6ff312 8:de31af0ad401
2 2
3 ## digilib-config.xml 3 ## digilib-config.xml
4 4
5 The main configuration for digilib is `digilib-config.xml` in the `WEB-INF` 5 The main configuration for digilib is `digilib-config.xml` in the `WEB-INF`
6 directory in the webapp. 6 directory in the webapp.
7 (If you really need another location you can define it in the `config-file` 7 (If you really need a different location you can define it in the `config-file`
8 init-parameter to the servlet.) 8 init-parameter to the Servlet.)
9 9
10 In the XML-based configuration file you can set several paths and options. 10 In the XML-based configuration file you can set several paths and options.
11 11
12 You have to adjust the **`basedir-list`** parameter to the directories 12 You have to adjust the **`basedir-list`** parameter to the directories
13 where your images are installed. The directory path has to be an absolute 13 where your images are installed. The directory path has to be an absolute
14 path following the conventions of your operating system (a relative path 14 path following the conventions of your operating system (a relative path
15 is taken to be relative to the web application directory). 15 is taken to be relative to the web application directory).
16 16
17 You need only one directory if you don't provide pre-scaled low resolution 17 You need only one directory if you don't want to provide pre-scaled low resolution
18 versions of your images. If you have pre-scaled images the directory with the 18 versions of your images. If you have pre-scaled images the directory with the
19 high-resolution images must be the first entry in the list. 19 high-resolution images must be the first entry in the list.
20 20
21 Documentation on the directory layout and on using pre-scaled images is 21 Documentation on the directory layout and on using pre-scaled images is
22 [here](image-directories.md). 22 [here](image-directories.md).
29 The authoritative directory with the high-resolution images 29 The authoritative directory with the high-resolution images
30 is first in list. --> 30 is first in list. -->
31 <parameter name="basedir-list" value="/docuserver/images" /> 31 <parameter name="basedir-list" value="/docuserver/images" />
32 </digilib-config> 32 </digilib-config>
33 33
34 A more customized configuration may look like this: 34 A more customized configuration may look like this (for a full list of
35 configuration options use the source:
36 [1](http://hg.berlios.de/repos/digilib/file/default/common/src/main/java/digilib/conf/DigilibConfiguration.java)
37 [2](http://hg.berlios.de/repos/digilib/file/default/servlet/src/main/java/digilib/conf/DigilibServletConfiguration.java)
38 [3](http://hg.berlios.de/repos/digilib/file/default/servlet3/src/main/java/digilib/conf/DigilibServlet3Configuration.java)
39 ):
35 40
36 <!-- Digilib servlet config file --> 41 <!-- Digilib servlet config file -->
37 <digilib-config> 42 <digilib-config>
38 <!-- Image to be sent to indicate general failure. --> 43 <!-- Image to be sent to indicate general failure. -->
39 <parameter name="error-image" value="/docuserver/images/icons/broken.gif" /> 44 <parameter name="error-image" value="/docuserver/images/icons/broken.gif" />
40 45
41 <!-- Image to be sent to indicate authorization failure. --> 46 <!-- Image to be sent to indicate authorization failure. -->
42 <parameter name="denied-image" value="/docuserver/images/icons/alert.red.gif" /> 47 <parameter name="denied-image" value="/docuserver/images/icons/alert.red.gif" />
43 48
49 <!-- Image to be sent to indicate file-not-found. -->
50 <parameter name="notfound-image" value="/docuserver/images/icons/notfound.gif" />
51
44 <!-- List of directories where images are searched. 52 <!-- List of directories where images are searched.
45 The authoritative directory with the high-resolution images 53 The authoritative directory with the high-resolution images
46 is first in list. --> 54 is first in list. -->
47 <parameter name="basedir-list" value="/docuserver/images:/docuserver/scaled/small" /> 55 <parameter name="basedir-list" value="/docuserver/images:/docuserver/scaled/small" />
48 56
49 <!-- Java class to use for image operations -->
50 <parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" />
51
52 <!-- mimimum amount of scaling done with antialiasing --> 57 <!-- mimimum amount of scaling done with antialiasing -->
53 <parameter name="subsample-minimum" value="2"/> 58 <parameter name="subsample-minimum" value="2"/>
54 59
55 <!-- default interpolation quality (0=worst) --> 60 <!-- default interpolation quality (0=worst) -->
56 <parameter name="default-quality" value="1"/> 61 <parameter name="default-quality" value="2"/>
57 62
58 <!-- is sending whole image files with mo=file allowed? --> 63 <!-- is sending whole image files with mo=file allowed? -->
59 <parameter name="sendfile-allowed" value="true" /> 64 <parameter name="sendfile-allowed" value="true" />
60 65
61 <!-- the a maximum size of any sent image. (0 means no limit) --> 66 <!-- the a maximum size of any sent image. (0 means no limit) -->