Mercurial > hg > digilib

comparison build-maven.html @ 1666:1beeb9319d78

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Creating site for 2.5-SNAPSHOT
author Robert Casties <casties@mpiwg-berlin.mpg.de>
date Tue, 21 Nov 2017 19:34:58 +0000
parents fe8300fdcd9d
children 8a9c66abb57c
comparison
equal deleted inserted replaced
1659:fe8300fdcd9d 1666:1beeb9319d78
1 <!DOCTYPE html> 1 <!DOCTYPE html>
2 <!-- 2 <!--
3 | Generated by Apache Maven Doxia at 2017-11-20 3 | Generated by Apache Maven Doxia at 2017-11-21
4 | Rendered using Apache Maven Fluido Skin 1.3.0 4 | Rendered using Apache Maven Fluido Skin 1.3.0
5 --> 5 -->
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> 6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head> 7 <head>
8 <meta charset="UTF-8" /> 8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
10 <meta name="Date-Revision-yyyymmdd" content="20171120" /> 10 <meta name="Date-Revision-yyyymmdd" content="20171121" />
11 <meta http-equiv="Content-Language" content="en" /> 11 <meta http-equiv="Content-Language" content="en" />
12 <title>digilib - The Digital Image Library &#x2013; Building digilib with Maven</title> 12 <title>digilib - The Digital Image Library &#x2013; Building digilib with Maven</title>
13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> 13 <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
14 <link rel="stylesheet" href="./css/site.css" /> 14 <link rel="stylesheet" href="./css/site.css" />
15 <link rel="stylesheet" href="./css/print.css" media="print" /> 15 <link rel="stylesheet" href="./css/print.css" media="print" />
39 39
40 <div id="breadcrumbs"> 40 <div id="breadcrumbs">
41 <ul class="breadcrumb"> 41 <ul class="breadcrumb">
42 42
43 43
44 <li id="publishDate">Last Published: 2017-11-20</li> 44 <li id="publishDate">Last Published: 2017-11-21</li>
45 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li> 45 <li class="divider">|</li> <li id="projectVersion">Version: 2.5-SNAPSHOT</li>
46 46
47 47
48 48
49 49
281 <h2><a name="Configuring_digilib"></a>Configuring digilib</h2> 281 <h2><a name="Configuring_digilib"></a>Configuring digilib</h2>
282 <p>To change the configuration of digilib just create and edit the file <tt>digilib-config.xml</tt> in the web application WEB-INF directory (<tt>webapp/src/main/webapp/WEB-INF/digilib-config.xml</tt>). You can copy and rename the sample file <tt>digilib-config.xml.template</tt> to get some default options to start with. Please check the <a href="digilib-config.html">documentation of the configuration options</a>.</p> 282 <p>To change the configuration of digilib just create and edit the file <tt>digilib-config.xml</tt> in the web application WEB-INF directory (<tt>webapp/src/main/webapp/WEB-INF/digilib-config.xml</tt>). You can copy and rename the sample file <tt>digilib-config.xml.template</tt> to get some default options to start with. Please check the <a href="digilib-config.html">documentation of the configuration options</a>.</p>
283 <p>You can see a summary of your running digilib configuration at the URL <a class="externalLink" href="http://localhost:8080/digilib/server/dlConfig.jsp">http://localhost:8080/digilib/server/dlConfig.jsp</a></p></div> 283 <p>You can see a summary of your running digilib configuration at the URL <a class="externalLink" href="http://localhost:8080/digilib/server/dlConfig.jsp">http://localhost:8080/digilib/server/dlConfig.jsp</a></p></div>
284 <div class="section"> 284 <div class="section">
285 <h2><a name="Additional_Maven_build_options"></a>Additional Maven build options</h2> 285 <h2><a name="Additional_Maven_build_options"></a>Additional Maven build options</h2>
286 <p>Some build options have to be activated as Maven profiles with the <tt>-P</tt> command line option when building digilib. For example, to build digilib with the Manifester servlet (&#x201c;iiif-presentation&#x201d;) use:</p>
287
288 <div class="source">
289 <div class="source">
290 <pre>mvn -Piiif-presentation package
291 </pre></div></div>
292 <p>You can add multiple profiles at the same time if necessary.</p>
286 <div class="section"> 293 <div class="section">
287 <h3><a name="servlet2"></a>servlet2</h3> 294 <h3><a name="servlet2"></a>servlet2</h3>
288 <p>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 <tt>-Pservlet2</tt> to the Maven command line above.</p></div></div> 295 <p>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.</p>
296 <p><tt>-Pservlet2</tt> builds a servlet with the the old non-Asynchronous Servlet API (2.3).</p>
297 <p>This creates a WAR file with the postfix &#x201c;-srv2&#x201d;. The build process uses the file <tt>webapp/src/main/webapp/WEB-INF/web-2.4.xml</tt> as <tt>web.xml</tt> file.</p></div>
298 <div class="section">
299 <h3><a name="servlet3"></a>servlet3</h3>
300 <p><tt>-Pservlet3</tt> 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.</p>
301 <p>This creates a WAR file with the postfix &#x201c;-srv3&#x201d;. The build process uses the file <tt>webapp/src/main/webapp/WEB-INF/web-3.0.xml</tt> as <tt>web.xml</tt> file. </p></div>
302 <div class="section">
303 <h3><a name="iiif-presentation"></a>iiif-presentation</h3>
304 <p><tt>-Piiif-presentation</tt> builds digilib with the &#x201c;Manifester&#x201d; servlet for IIIF Presentation API support (see <a href="iiif-api.html">digilib IIIF support documentation</a>). </p>
305 <p>This creates a WAR file with the postfix &#x201c;-srv3p&#x201d;. The build process uses the file <tt>webapp/src/main/webapp/WEB-INF/web-iiif-pres.xml</tt> as <tt>web.xml</tt> file.</p></div>
306 <div class="section">
307 <h3><a name="text"></a>text</h3>
308 <p><tt>-Ptext</tt> builds digilib with the &#x201c;Texter&#x201d; servlet to download plain text or XML files (see <a class="externalLink" href="https://github.com/robcast/digilib/tree/master/text">the source</a>). You have to add <tt>-Pservlet3</tt> or <tt>-Pservlet2</tt> as well.</p>
309 <p>You also have to copy the mapping for the &#x201c;Texter&#x201d; servlet from <tt>web-additional.xml</tt> into the <tt>web.xml</tt> file used by the selected servlet API like <tt>web-3.0.xml</tt>.</p></div>
310 <div class="section">
311 <h3><a name="pdf"></a>pdf</h3>
312 <p><tt>-Ppdf</tt> builds digilib with the &#x201c;PDFCache&#x201d; servlet to generate and download PDF files from images. (see <a class="externalLink" href="https://github.com/robcast/digilib/tree/master/pdf">the source</a>).</p>
313 <p>You also have to copy the mapping for the &#x201c;PDFCache&#x201d; servlet from <tt>web-additional.xml</tt> into the <tt>web.xml</tt> file used by the selected servlet API like <tt>web-3.0.xml</tt>.</p></div></div>
314 <div class="section">
315 <h2><a name="create-sprites"></a>create-sprites</h2>
316 <p><tt>-Pcreate-sprites</tt> re-creates the image sprite file (<tt>webapp/src/main/webapp/jquery/img/dl-buttons-full-32-sprite.png</tt>) 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.</p></div>
317 <div class="section">
318 <h2><a name="running_tests"></a>running tests</h2>
319 <p><tt>-DskipTests=false</tt> enables some functional tests. The tests are run as part of the normal build process. You can also run just the tests with <tt>mvn -DskipTests=false test</tt>.</p></div>
289 </div> 320 </div>
290 </div> 321 </div>
291 </div> 322 </div>
292 323
293 <hr/> 324 <hr/>