|
3
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
3 <html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
4 <head>
|
|
|
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
6 <title>digilib -- Digital Image Library</title>
|
|
|
7 </head>
|
|
|
8 <body>
|
|
|
9
|
|
|
10 <table border="0" cellspacing="0" cellpadding="10">
|
|
|
11 <tr>
|
|
|
12 <td bgcolor="#a0a0a0"> </td>
|
|
|
13 <td>
|
|
|
14 <img src="images/digilib-logo-big.png" align="left" />
|
|
|
15 <h1>
|
|
|
16 <code>digilib</code> -- a versatile image viewing environment for the internet
|
|
|
17 </h1>
|
|
|
18 </td>
|
|
|
19 </tr>
|
|
|
20 <tr>
|
|
|
21 <td bgcolor="#a0a0a0" valign="top" align="right">
|
|
|
22 <p>
|
|
|
23 <b><a href="index.html">Info</a></b>
|
|
|
24 </p>
|
|
|
25 <p>
|
|
|
26 <b><a href="http://developer.berlios.de/projects/digilib/">Project</a></b>
|
|
|
27 </p>
|
|
|
28 <p>
|
|
|
29 <b><a href="http://developer.berlios.de/project/showfiles.php?group_id=251">Download</a></b>
|
|
|
30 </p>
|
|
|
31 <p>
|
|
|
32 <b><a href="docs.html">Docs</a></b>
|
|
|
33 <br />
|
|
|
34 <a href="build-maven.html">Building</a>
|
|
|
35 <br />
|
|
|
36 <a href="digilib-config.html">Configuring</a>
|
|
|
37 <br />
|
|
|
38 <a href="http://developer.berlios.de/docman/?group_id=251">...more</a>
|
|
|
39 </p>
|
|
|
40 <p>
|
|
|
41 <b><a href="tips.html">Tips</a></b>
|
|
|
42 </p>
|
|
|
43 <p>
|
|
|
44 <b><a href="http://hg.berlios.de/repos/digilib">Source</a></b>
|
|
|
45 </p>
|
|
|
46 </td>
|
|
|
47 <td>
|
|
|
48
|
|
|
49 <h1>Building digilib with Maven</h1>
|
|
|
50
|
|
|
51 <p>
|
|
|
52 The easiest way to get the latest and greatest digilib is the <a
|
|
|
53 href="http://maven.apache.org/">Maven</a> build tool. It will download,
|
|
|
54 compile, and install the latest digilib version and all required libraries.
|
|
|
55 </p>
|
|
|
56
|
|
|
57 <h2>What you need</h2>
|
|
|
58 <ul>
|
|
|
59 <li>
|
|
|
60 <a href="http://www.java.com/">Java</a> (1.5 or higher)
|
|
|
61 </li>
|
|
|
62 <li>
|
|
|
63 <a href="http://maven.apache.org/">Maven</a>
|
|
|
64 </li>
|
|
|
65 <li>
|
|
|
66 <a href="http://mercurial.selenic.com/">Mercurial</a>
|
|
|
67 </li>
|
|
|
68 <li>
|
|
|
69 The digilib project file <a
|
|
|
70 href="http://hg.berlios.de/repos/digilib/raw-file/tip/pom.xml">pom.xml</a>
|
|
|
71 (download and save it)
|
|
|
72 </li>
|
|
|
73 <li>
|
|
|
74 A Servlet container like <a href="http://tomcat.apache.org/">Tomcat</a> or <a
|
|
|
75 href="http://www.eclipse.org/jetty/">Jetty</a> to run the web application.
|
|
|
76 </li>
|
|
|
77 </ul>
|
|
|
78
|
|
|
79 <h2>Quick build</h2>
|
|
|
80
|
|
|
81 <p>
|
|
|
82 The fastest way to build the digilib web application is to run
|
|
|
83 <pre>mvn scm:bootstrap -N</pre>
|
|
|
84 in the same directory as the <code>pom.xml</code> file you downloaded.
|
|
|
85 </p>
|
|
|
86 <p>
|
|
|
87 This will create a web application directory <code>digilib-webapp-2.0-SNAPSHOT</code>
|
|
|
88 and a WAR file <code>digilib-webapp-2.0-SNAPSHOT-srv2.war</code> (or similar) in
|
|
|
89 the subdirectory <code>target/checkout/webapp/target/</code>
|
|
|
90 </p>
|
|
|
91 <p>
|
|
|
92 If you want to use the new-and-better Asynchronous Servlet API add <code>-Psrv3</code>
|
|
|
93 to the Maven command line above. You will need Java version 6 and Tomcat version 7 or Jetty version
|
|
|
94 8 or later to use the asynchronous Servlet.
|
|
|
95 </p>
|
|
|
96
|
|
|
97 <h2>Deploying the web application by hand</h2>
|
|
|
98
|
|
|
99 <p>
|
|
|
100 To deploy digilib just copy the web application directory into the <code>webapp</code>
|
|
|
101 directory of the Servlet container.
|
|
|
102 </p>
|
|
|
103
|
|
|
104 <p>
|
|
|
105 Since the URL of your digilib server starts with the name of the web application
|
|
|
106 and the name of the web application is derived from the name of the web
|
|
|
107 application directory <b>please rename the web application directory to <code>digitallibrary</code>
|
|
|
108 before you start
|
|
|
109 </b>
|
|
|
110 </p>
|
|
|
111 <p>
|
|
|
112 Then you should see your digilib running at the URL <a
|
|
|
113 href="http://localhost:8080/digitallibrary/jquery/digilib.html">http://localhost:8080/digitallibrary/jquery/digilib.html</a>
|
|
|
114 </p>
|
|
|
115
|
|
|
116 <h2>Configuring digilib</h2>
|
|
|
117
|
|
|
118 <p>
|
|
|
119 To change the configuration of digilib just edit the file <code>digilib-config.xml</code>
|
|
|
120 in the web application directory (<code>digitallibrary/WEB-INF/digilib-config.xml</code>).
|
|
|
121 Documentation of the configuration options is <a href="digilib-config.html">here</a>.
|
|
|
122 </p>
|
|
|
123
|
|
|
124 <p>
|
|
|
125 You can see a summary of your running digilib configuration at the URL <a
|
|
|
126 href="http://localhost:8080/digitallibrary/server/dlConfig.jsp">http://localhost:8080/digitallibrary/server/dlConfig.jsp</a>
|
|
|
127 </p>
|
|
|
128
|
|
|
129
|
|
|
130 <h2>Developer build</h2>
|
|
|
131
|
|
|
132 <p>If you are developing with digilib it is helpful to check out the source
|
|
|
133 code separately so you can keep it around, modify it or change the configuration
|
|
|
134 before you deploy.</p>
|
|
|
135 <p>
|
|
|
136 To check out the latest source code into the directory <code>digilib</code> run
|
|
|
137 <pre>mvn scm:checkout -N -DcheckoutDirectory=digilib</pre>
|
|
|
138 in the same directory as the <code>pom.xml</code> file you downloaded.
|
|
|
139 </p>
|
|
|
140 <p>
|
|
|
141 The digilib configuration files are now in <code>webapp/src/main/webapp/WEB-INF/</code>
|
|
|
142 </p>
|
|
|
143 <p>
|
|
|
144 To build the resulting source code, change into the <code>digilib</code>
|
|
|
145 directory you checked out above and run
|
|
|
146 <pre>mvn package</pre>
|
|
|
147 This will create a web application directory <code>digilib-webapp-2.0-SNAPSHOT</code>
|
|
|
148 and a WAR file <code>digilib-webapp-2.0-SNAPSHOT-srv2.war</code> (or similar) in
|
|
|
149 the subdirectory <code>webapp/target/</code> .
|
|
|
150 </p>
|
|
|
151 <p>
|
|
|
152 If you want to use the new-and-better Asynchronous Servlet API add <code>-Psrv3</code>
|
|
|
153 to the Maven command line above. You will need Java version 6 and Tomcat version 7 or Jetty version
|
|
|
154 8 or later to use the asynchronous Servlet.
|
|
|
155 </p>
|
|
|
156 </td>
|
|
|
157 </tr>
|
|
|
158 <tr>
|
|
|
159 <td style="padding: 0px" align="left">
|
|
|
160 <a href="http://developer.berlios.de"> <img
|
|
|
161 src="http://developer.berlios.de/bslogo.php?group_id=0&type=1" width="124"
|
|
|
162 height="32" border="0" alt="BerliOS Logo" />
|
|
|
163 </a>
|
|
|
164 </td>
|
|
|
165 <td></td>
|
|
|
166 </tr>
|
|
|
167 </table>
|
|
|
168
|
|
|
169 </body>
|
|
|
170 </html>
|
