Mercurial > hg > digilib-doc
diff website/build-maven.html @ 3:9a472dab7e09
more new documentation
| author | robcast |
|---|---|
| date | Mon, 12 Dec 2011 20:37:53 +0100 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/website/build-maven.html Mon Dec 12 20:37:53 2011 +0100 @@ -0,0 +1,170 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title>digilib -- Digital Image Library</title> +</head> +<body> + + <table border="0" cellspacing="0" cellpadding="10"> + <tr> + <td bgcolor="#a0a0a0"> </td> + <td> + <img src="images/digilib-logo-big.png" align="left" /> + <h1> + <code>digilib</code> -- a versatile image viewing environment for the internet + </h1> + </td> + </tr> + <tr> + <td bgcolor="#a0a0a0" valign="top" align="right"> + <p> + <b><a href="index.html">Info</a></b> + </p> + <p> + <b><a href="http://developer.berlios.de/projects/digilib/">Project</a></b> + </p> + <p> + <b><a href="http://developer.berlios.de/project/showfiles.php?group_id=251">Download</a></b> + </p> + <p> + <b><a href="docs.html">Docs</a></b> + <br /> + <a href="build-maven.html">Building</a> + <br /> + <a href="digilib-config.html">Configuring</a> + <br /> + <a href="http://developer.berlios.de/docman/?group_id=251">...more</a> + </p> + <p> + <b><a href="tips.html">Tips</a></b> + </p> + <p> + <b><a href="http://hg.berlios.de/repos/digilib">Source</a></b> + </p> + </td> + <td> + + <h1>Building digilib with Maven</h1> + + <p> + The easiest way to get the latest and greatest digilib is the <a + href="http://maven.apache.org/">Maven</a> build tool. It will download, + compile, and install the latest digilib version and all required libraries. + </p> + + <h2>What you need</h2> + <ul> + <li> + <a href="http://www.java.com/">Java</a> (1.5 or higher) + </li> + <li> + <a href="http://maven.apache.org/">Maven</a> + </li> + <li> + <a href="http://mercurial.selenic.com/">Mercurial</a> + </li> + <li> + The digilib project file <a + href="http://hg.berlios.de/repos/digilib/raw-file/tip/pom.xml">pom.xml</a> + (download and save it) + </li> + <li> + A Servlet container like <a href="http://tomcat.apache.org/">Tomcat</a> or <a + href="http://www.eclipse.org/jetty/">Jetty</a> to run the web application. + </li> + </ul> + + <h2>Quick build</h2> + + <p> + The fastest way to build the digilib web application is to run + <pre>mvn scm:bootstrap -N</pre> + in the same directory as the <code>pom.xml</code> file you downloaded. + </p> + <p> + This will create a web application directory <code>digilib-webapp-2.0-SNAPSHOT</code> + and a WAR file <code>digilib-webapp-2.0-SNAPSHOT-srv2.war</code> (or similar) in + the subdirectory <code>target/checkout/webapp/target/</code> + </p> + <p> + If you want to use the new-and-better Asynchronous Servlet API add <code>-Psrv3</code> + to the Maven command line above. You will need Java version 6 and Tomcat version 7 or Jetty version + 8 or later to use the asynchronous Servlet. + </p> + + <h2>Deploying the web application by hand</h2> + + <p> + To deploy digilib just copy the web application directory into the <code>webapp</code> + directory of the Servlet container. + </p> + + <p> + Since the URL of your digilib server starts with the name of the web application + and the name of the web application is derived from the name of the web + application directory <b>please rename the web application directory to <code>digitallibrary</code> + before you start + </b> + </p> + <p> + Then you should see your digilib running at the URL <a + href="http://localhost:8080/digitallibrary/jquery/digilib.html">http://localhost:8080/digitallibrary/jquery/digilib.html</a> + </p> + + <h2>Configuring digilib</h2> + + <p> + To change the configuration of digilib just edit the file <code>digilib-config.xml</code> + in the web application directory (<code>digitallibrary/WEB-INF/digilib-config.xml</code>). + Documentation of the configuration options is <a href="digilib-config.html">here</a>. + </p> + + <p> + You can see a summary of your running digilib configuration at the URL <a + href="http://localhost:8080/digitallibrary/server/dlConfig.jsp">http://localhost:8080/digitallibrary/server/dlConfig.jsp</a> + </p> + + + <h2>Developer build</h2> + + <p>If you are developing with digilib it is helpful to check out the source + code separately so you can keep it around, modify it or change the configuration + before you deploy.</p> + <p> + To check out the latest source code into the directory <code>digilib</code> run + <pre>mvn scm:checkout -N -DcheckoutDirectory=digilib</pre> + in the same directory as the <code>pom.xml</code> file you downloaded. + </p> + <p> + The digilib configuration files are now in <code>webapp/src/main/webapp/WEB-INF/</code> + </p> + <p> + To build the resulting source code, change into the <code>digilib</code> + directory you checked out above and run + <pre>mvn package</pre> + This will create a web application directory <code>digilib-webapp-2.0-SNAPSHOT</code> + and a WAR file <code>digilib-webapp-2.0-SNAPSHOT-srv2.war</code> (or similar) in + the subdirectory <code>webapp/target/</code> . + </p> + <p> + If you want to use the new-and-better Asynchronous Servlet API add <code>-Psrv3</code> + to the Maven command line above. You will need Java version 6 and Tomcat version 7 or Jetty version + 8 or later to use the asynchronous Servlet. + </p> + </td> + </tr> + <tr> + <td style="padding: 0px" align="left"> + <a href="http://developer.berlios.de"> <img + src="http://developer.berlios.de/bslogo.php?group_id=0&type=1" width="124" + height="32" border="0" alt="BerliOS Logo" /> + </a> + </td> + <td></td> + </tr> + </table> + +</body> +</html>