Mercurial > hg > digilib-doc
changeset 8:de31af0ad401
more doc for the website.
| author | casties |
|---|---|
| date | Wed, 04 Sep 2013 09:08:17 +0200 |
| parents | cf3abd6ff312 |
| children | f035222e5010 38be9940e142 |
| files | pom.xml src/site/markdown/digilib-config.md src/site/markdown/index.md src/site/markdown/java-settings.md src/site/site.xml |
| diffstat | 5 files changed, 80 insertions(+), 56 deletions(-) [+] |
line wrap: on
line diff
--- a/pom.xml Mon Sep 02 19:32:44 2013 +0200 +++ b/pom.xml Wed Sep 04 09:08:17 2013 +0200 @@ -1,11 +1,17 @@ <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> - <groupId>digilib</groupId> + <parent> + <artifactId>digilib</artifactId> + <groupId>digilib</groupId> + <version>2.2-SNAPSHOT</version> + </parent> <artifactId>digilib-doc</artifactId> - <version>0.0.1-SNAPSHOT</version> - <packaging>war</packaging> + <packaging>pom</packaging> <name>digilib documentation</name> + <properties> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + </properties> <build> <plugins> <plugin> @@ -31,8 +37,12 @@ <reportSets> <reportSet> <reports> - <!-- <report>license</report> - <report>scm</report> --> + <report>project-team</report> + <report>mailing-list</report> + <report>scm</report> + <report>issue-tracking</report> + <!-- <report>cim</report> --> + <report>license</report> </reports> </reportSet> </reportSets>
--- a/src/site/markdown/digilib-config.md Mon Sep 02 19:32:44 2013 +0200 +++ b/src/site/markdown/digilib-config.md Wed Sep 04 09:08:17 2013 +0200 @@ -4,8 +4,8 @@ The main configuration for digilib is `digilib-config.xml` in the `WEB-INF` directory in the webapp. -(If you really need another location you can define it in the `config-file` -init-parameter to the servlet.) +(If you really need a different location you can define it in the `config-file` +init-parameter to the Servlet.) In the XML-based configuration file you can set several paths and options. @@ -14,7 +14,7 @@ path following the conventions of your operating system (a relative path is taken to be relative to the web application directory). -You need only one directory if you don't provide pre-scaled low resolution +You need only one directory if you don't want to provide pre-scaled low resolution versions of your images. If you have pre-scaled images the directory with the high-resolution images must be the first entry in the list. @@ -31,7 +31,12 @@ <parameter name="basedir-list" value="/docuserver/images" /> </digilib-config> -A more customized configuration may look like this: +A more customized configuration may look like this (for a full list of +configuration options use the source: +[1](http://hg.berlios.de/repos/digilib/file/default/common/src/main/java/digilib/conf/DigilibConfiguration.java) +[2](http://hg.berlios.de/repos/digilib/file/default/servlet/src/main/java/digilib/conf/DigilibServletConfiguration.java) +[3](http://hg.berlios.de/repos/digilib/file/default/servlet3/src/main/java/digilib/conf/DigilibServlet3Configuration.java) +): <!-- Digilib servlet config file --> <digilib-config> @@ -41,19 +46,19 @@ <!-- Image to be sent to indicate authorization failure. --> <parameter name="denied-image" value="/docuserver/images/icons/alert.red.gif" /> + <!-- Image to be sent to indicate file-not-found. --> + <parameter name="notfound-image" value="/docuserver/images/icons/notfound.gif" /> + <!-- List of directories where images are searched. The authoritative directory with the high-resolution images is first in list. --> <parameter name="basedir-list" value="/docuserver/images:/docuserver/scaled/small" /> - <!-- Java class to use for image operations --> - <parameter name="docuimage-class" value="digilib.image.ImageLoaderDocuImage" /> - <!-- mimimum amount of scaling done with antialiasing --> <parameter name="subsample-minimum" value="2"/> <!-- default interpolation quality (0=worst) --> - <parameter name="default-quality" value="1"/> + <parameter name="default-quality" value="2"/> <!-- is sending whole image files with mo=file allowed? --> <parameter name="sendfile-allowed" value="true" />
--- a/src/site/markdown/index.md Mon Sep 02 19:32:44 2013 +0200 +++ b/src/site/markdown/index.md Wed Sep 04 09:08:17 2013 +0200 @@ -1,30 +1,33 @@ -# About digilib + ## What is digilib? -* `digilib` is a web based client/server technology for images. The image +* `digilib` is a web based client/server technology for images. The image content is processed on-the-fly by a Java Servlet on the server side so that only the visible portion of the image is sent to the web browser on the client side. -* `digilib` supports a wide range of image formats and viewing options on - the server side while only requiring an internet browser with javascript and a +* `digilib` supports a wide range of image formats and viewing options on + the server side while only requiring an internet browser with Javascript and a low bandwidth internet connection on the client side. -* `digilib` enables very detailed work on an image as required by - scientists with elaborate zoom features like an option to show images on the +* `digilib` enables very detailed work on an image as required by + scholars with elaborate viewing features like an option to show images on the screen in their original size. -* `digilib` facilitates cooperation of scientists over the internet and +* `digilib` facilitates cooperation of scholars over the internet and novel uses of source material by image annotations and stable references that can be embedded in URLs. -* `digilib` is used in the [ALCATRAZ](http://penelope.unibe.ch/docuserver/echo/alcatraz/index3.html) - framework of image, text and annotation tools and many other projects. -* `digilib` is Open Source Software under the General Public License, - jointly developed by the [Max-Planck-Insitute - for the History of Science](http://www.mpiwg-berlin.mpg.de), the [University - of Bern](http://philoscience.unibe.ch) and others. +* `digilib` is Open Source Software under the Lesser General Public License, + jointly developed by the + [Max-Planck-Institute for the History of Science](http://www.mpiwg-berlin.mpg.de), + the [Bibliotheca Hertziana](http://www.biblhertz.it), + the [University of Bern](http://philoscience.unibe.ch) and others. ## Where can I get digilib? `digilib` source code, binaries and documentation can be found on the [digilib project pages](http://developer.berlios.de/projects/digilib/) -on [BerliOS](http://developer.berlios.de). - \ No newline at end of file +on [BerliOS](http://developer.berlios.de): + +* [Source code](http://hg.berlios.de/repos/digilib) +* Daily built [WAR files](http://digilib.berlios.de/downloads/daily-build/) +* Daily built [Javadoc](http://digilib.berlios.de/downloads/daily-build/javadoc/) +* [Maven repository](http://it-dev.mpiwg-berlin.mpg.de/maven-repo/)
--- a/src/site/markdown/java-settings.md Mon Sep 02 19:32:44 2013 +0200 +++ b/src/site/markdown/java-settings.md Wed Sep 04 09:08:17 2013 +0200 @@ -9,15 +9,15 @@ server. The amount of memory Tomcat (version 5.0) uses is configured by creating a -"setenv.sh" script with a line +`setenv.sh` (or `setenbv.bat`) script with a line CATALINA_OPTS="-Xmx512m" -in Tomcat's `bin` directory (giving 512MB in this case). +in Tomcat's `bin` directory (giving 512MB RAM in this case). You can check the amount of memory your digilib instance has available on the bottom of the web page `/server/dlConfig.jsp` in your digilib instance (e.g. -[http://digilib.mpiwg-berlin.mpg.de/digitallibrary/server/dlConfig.jsp](http://digilib.mpiwg-berlin.mpg.de/digitallibrary/server/dlConfig.jsp)). +<http://localhost:8080/digilib/server/dlConfig.jsp> # Installing JAI ImageIO @@ -29,34 +29,27 @@ You can see if the Jai-ImageIO plugin is active by checking for the availability of the TIFF image format under "Supported image types" on the -[`/server/dlConfig.jsp`](http://digilib.mpiwg-berlin.mpg.de/digitallibrary/server/dlConfig.jsp) +[`/server/dlConfig.jsp`](http://localhost:8080/digilib/server/dlConfig.jsp) status page. -But sometimes there are classloader issues. Newer versions of Tomcat refuse to load +Sometimes there are memory issues. Newer versions of Tomcat refuse to load the libraries and I found that in some cases digilib stopped reading TIFF files -after a period of running. - -In these cases it helped to install the JAI files in Tomcats `lib/` -directory or globally in the local Java JDK +after a period of running. In these cases it helped to install the JAI files in +Tomcats `lib/` directory or globally in the local Java JDK installation (i.e. in the Java's 'jre/lib/ext/' directory on linux). # Sample setup The current digilib setup at the MPIWG (as of December 2010): -* One frontend server running the lightweight web-multiplexer [pound](http://www.apsis.ch/pound/) - on port 80 that distributes requests to three servers runnning digilib -* the three servers run digilib under [Jetty](http://www.eclipse.org/jetty/) on port 8080 without Apache - - * one server is the frontend server (Linux 32bit, Dual - 2.4GHz Xeon, 2GB RAM) - * the other server is a separate, newer machine (Linux 64bit, Dual 1.8GHz - Opteron, 2GB RAM) - * the third server is a separate, newer machine (Linux 32bit, Dual 2.8GHz - Xeon, 4GB RAM) -* the digilib instances (digilib 2.0b1 as of 12.12.2011) run on Jetty 8.0.4 on Java - 1.6.0_26 with 1GB of [Java VM memory - for digilib](#vm_settings) (-Xmx1024m) with JAI (1.1.3) and JAI-ImageIO (1.1) [installed in the Jetty/lib/ext](#installing_jai)(!) -* both digilib servers access all image files over NFS (over GBit - Ethernet) from a central file server (Solaris 10, Sun Fire 240, multiple RAIDs - on Fibrechannel) \ No newline at end of file +* One frontend server running the lightweight web-multiplexer [pound](http://www.apsis.ch/pound/) + on port 80 that distributes requests to three servers runnning digilib +* the three servers run digilib under [Jetty](http://www.eclipse.org/jetty/) on port 8080 without Apache + * one server is the frontend server (Linux 32bit, Dual 2.4GHz Xeon, 2GB RAM) + * the other server is a separate, newer machine (Linux 64bit, Dual 1.8GHz Opteron, 2GB RAM) + * the third server is a separate, newer machine (Linux 32bit, Dual 2.8GHz Xeon, 4GB RAM) +* the digilib instances (digilib 2.0b1 as of 12.12.2011) run on Jetty 8.0.4 on Java + 1.6.0_26 with 1GB of Java VM memory for digilib (-Xmx1024m) with JAI (1.1.3) and JAI-ImageIO (1.1) + installed in `Jetty/lib/ext` +* both digilib servers access all image files over NFS (over GBit Ethernet) from a central file server + (Solaris 10, Sun Fire 240, multiple RAIDs on Fibrechannel) \ No newline at end of file
--- a/src/site/site.xml Mon Sep 02 19:32:44 2013 +0200 +++ b/src/site/site.xml Wed Sep 04 09:08:17 2013 +0200 @@ -18,10 +18,23 @@ <body> <menu name="Overview"> <item name="About digilib" href="index.html"/> - <item name="Building digilib" href="build-maven.html"/> - <item name="Configuring digilib" href="digilib-config.html"/> + <item name="How digilib works" href="digilib-short.html"/> <item name="Ancient history" href="history.html"/> </menu> - <!-- <menu ref="reports"/> --> + <menu name="Installation"> + <item name="Installing digilib" href="install-digilib.html"/> + <item name="Building digilib" href="build-maven.html"/> + </menu> + <menu name="Configuration"> + <item name="Configuring digilib" href="digilib-config.html"/> + <item name="Directory layout" href="image-directories.html"/> + <item name="Java settings" href="java-settings.html"/> + </menu> + <menu name="Development"> + <item name="The digilib Scaler API" href="scaler-api.html"/> + <!-- <item name="Integrating digilib into your page" href=""/> + <item name="Integrating digilib into your server" href=""/> --> + </menu> + <menu ref="reports"/> </body> </project>