Mercurial > hg > digilib
changeset 1663:a243eb5cc480
More documentation.
Added Maven build profiles. Changed WAR download links to GitHub.
author | Robert Casties <r0bcas7@gmail.com> |
---|---|
date | Tue, 21 Nov 2017 19:38:53 +0100 |
parents | 4ad90af7a242 |
children | 6420df6b213b |
files | README.md doc/src/site/markdown/build-maven.md doc/src/site/markdown/install-digilib.md |
diffstat | 3 files changed, 71 insertions(+), 15 deletions(-) [+] |
line wrap: on
line diff
--- a/README.md Tue Nov 21 17:57:34 2017 +0100 +++ b/README.md Tue Nov 21 19:38:53 2017 +0100 @@ -36,7 +36,7 @@ `digilib` documentation can be found on the [digilib documentation pages](https://robcast.github.io/digilib/) on GitHub -or on [SourceForge](http://digilib.sourceforge.net). +or on [SourceForge](https://sourceforge.net/projects/digilib/). ## How do I run digilib?
--- a/doc/src/site/markdown/build-maven.md Tue Nov 21 17:57:34 2017 +0100 +++ b/doc/src/site/markdown/build-maven.md Tue Nov 21 19:38:53 2017 +0100 @@ -86,10 +86,66 @@ ## Additional Maven build options +Some build options have to be activated as Maven profiles with the `-P` command line option +when building digilib. For example, to build digilib with the Manifester servlet ("iiif-presentation") +use: + + mvn -Piiif-presentation package + +You can add multiple profiles at the same time if necessary. + + ### servlet2 Digilib uses the Asynchronous Servlet API (3.0) by default. You will need Java version 6 or later and Tomcat version 7 or Jetty version 8 or later to use it. -If you want to use the old non-Asynchronous Servlet API (2.3) add `-Pservlet2` -to the Maven command line above. + +`-Pservlet2` builds a servlet with the the old non-Asynchronous Servlet API (2.3). + +This creates a WAR file with the postfix "-srv2". +The build process uses the file `webapp/src/main/webapp/WEB-INF/web-2.4.xml` as `web.xml` file. + +### servlet3 + +`-Pservlet3` builds digillib with the Asynchronous Servlet API (3.0). This is the default profile, it will be used +if you do not specify any profile. + +This creates a WAR file with the postfix "-srv3". +The build process uses the file `webapp/src/main/webapp/WEB-INF/web-3.0.xml` as `web.xml` file. + +### iiif-presentation + +`-Piiif-presentation` builds digilib with the "Manifester" servlet for IIIF Presentation API support +(see [digilib IIIF support documentation](iiif-api.html)). + +This creates a WAR file with the postfix "-srv3p". +The build process uses the file `webapp/src/main/webapp/WEB-INF/web-iiif-pres.xml` as `web.xml` file. + +### text +`-Ptext` builds digilib with the "Texter" servlet to download plain text or XML files +(see [the source](https://github.com/robcast/digilib/tree/master/text)). You have +to add `-Pservlet3` or `-Pservlet2` as well. + +You also have to copy the mapping for the "Texter" servlet from `web-additional.xml` into the `web.xml` file +used by the selected servlet API like `web-3.0.xml`. + +### pdf + +`-Ppdf` builds digilib with the "PDFCache" servlet to generate and download PDF files from images. +(see [the source](https://github.com/robcast/digilib/tree/master/pdf)). + +You also have to copy the mapping for the "PDFCache" servlet from `web-additional.xml` into the `web.xml` file +used by the selected servlet API like `web-3.0.xml`. + +## create-sprites + +`-Pcreate-sprites` re-creates the image sprite file (`webapp/src/main/webapp/jquery/img/dl-buttons-full-32-sprite.png`) +from the separate icon image files. This option only needs to be used if you are a developer and you want to +change the icon images. + +## running tests + +`-DskipTests=false` enables some functional tests. The tests are run as part of the normal build process. +You can also run just the tests with `mvn -DskipTests=false test`. +
--- a/doc/src/site/markdown/install-digilib.md Tue Nov 21 17:57:34 2017 +0100 +++ b/doc/src/site/markdown/install-digilib.md Tue Nov 21 19:38:53 2017 +0100 @@ -10,8 +10,8 @@ ## Start the Servlet Container Install and run the Servlet Container of your choice: -[Tomcat](http://tomcat.apache.org/tomcat-7.0-doc/setup.html) or -[Jetty](http://wiki.eclipse.org/Jetty/Howto/Run_Jetty). +[Tomcat](http://tomcat.apache.org/) or +[Jetty](http://wiki.eclipse.org/Jetty/). When the Servlet Container runs you should be able to access the start page on <http://localhost:8080/> @@ -35,7 +35,7 @@ Also you get the chance to always use the latest digilib version by updating the source code. You can also download a digilib WAR file with a default configuration from the -[SourceForge download page](https://sourceforge.net/projects/digilib/files/) +[GitHub release page](https://github.com/robcast/digilib/releases) or the latest digilib build from the [daily build page](https://it-dev.mpiwg-berlin.mpg.de/downloads/digilib/daily-build/). The default configuration will only show a set of sample images. If you want to show your own images @@ -47,12 +47,12 @@ 1. Get a digilib WAR file. 2. Rename the WAR file to `digilib.war`. 3. Deploy the WAR file by copying it into the `webapps` directory of your -Servlet Container. + Servlet Container. 4. Restart your Servlet Container (this may not be necessary). 5. Access your digilib instance at <http://localhost:8080/digilib/digilib.html>. You will now be able to see the sample images provided with the digilib -installation in the default configuration yor your own images +installation in the default configuration or your own images if you have updated the [configuration](digilib-config.html). In digilib you can view images by providing the directory and file @@ -68,14 +68,14 @@ ## Install digilib as a web application directory 1. Get a digilib web application directory. -2. Rename the WAR file to `digilib.war`. -3. Deploy the WAR file by copying it into the `webapps` directory of your -Servlet Container. +2. Rename the directory to `digilib`. +3. Deploy the directory by copying it into the `webapps` directory of your + Servlet Container. 4. Restart your Servlet Container (this may not be necessary). 5. Access your digilib instance at <http://localhost:8080/digilib/digilib.html> You will now be able to see the sample images provided with the digilib -installation in the default configuration yor your own images +installation in the default configuration or your own images if you have updated the [configuration](digilib-config.html). In digilib you can view images by providing the directory and file @@ -98,6 +98,6 @@ application directory called `digilib`. Then: 1. Make sure that your Servlet Container is not running and remove any -`digilib.war` files from the `webapps` directory. -2. Copy your `digilib` directory into the `webapps` directory of the -Servlet Container. + `digilib.war` files from the `webapps` directory. +2. Keep the `digilib` directory in the `webapps` directory of the + Servlet Container.