Mercurial > hg > digilib

comparison doc/src/site/markdown/build-maven.md @ 1663:a243eb5cc480

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 28df291d4e26
children
comparison
equal deleted inserted replaced
1662:4ad90af7a242 1663:a243eb5cc480
84 You can see a summary of your running digilib configuration at the URL 84 You can see a summary of your running digilib configuration at the URL
85 http://localhost:8080/digilib/server/dlConfig.jsp 85 http://localhost:8080/digilib/server/dlConfig.jsp
86 86
87 ## Additional Maven build options 87 ## Additional Maven build options
88 88
89 Some build options have to be activated as Maven profiles with the `-P` command line option
90 when building digilib. For example, to build digilib with the Manifester servlet ("iiif-presentation")
91 use:
92
93 mvn -Piiif-presentation package
94
95 You can add multiple profiles at the same time if necessary.
96
97
89 ### servlet2 98 ### servlet2
90 99
91 Digilib uses the Asynchronous Servlet API (3.0) by default. You will need Java version 6 or later 100 Digilib uses the Asynchronous Servlet API (3.0) by default. You will need Java version 6 or later
92 and Tomcat version 7 or Jetty version 8 or later to use it. 101 and Tomcat version 7 or Jetty version 8 or later to use it.
93 If you want to use the old non-Asynchronous Servlet API (2.3) add `-Pservlet2`
94 to the Maven command line above.
95 102
103 `-Pservlet2` builds a servlet with the the old non-Asynchronous Servlet API (2.3).
104
105 This creates a WAR file with the postfix "-srv2".
106 The build process uses the file `webapp/src/main/webapp/WEB-INF/web-2.4.xml` as `web.xml` file.
107
108 ### servlet3
109
110 `-Pservlet3` builds digillib with the Asynchronous Servlet API (3.0). This is the default profile, it will be used
111 if you do not specify any profile.
112
113 This creates a WAR file with the postfix "-srv3".
114 The build process uses the file `webapp/src/main/webapp/WEB-INF/web-3.0.xml` as `web.xml` file.
115
116 ### iiif-presentation
117
118 `-Piiif-presentation` builds digilib with the "Manifester" servlet for IIIF Presentation API support
119 (see [digilib IIIF support documentation](iiif-api.html)).
120
121 This creates a WAR file with the postfix "-srv3p".
122 The build process uses the file `webapp/src/main/webapp/WEB-INF/web-iiif-pres.xml` as `web.xml` file.
123
124 ### text
125
126 `-Ptext` builds digilib with the "Texter" servlet to download plain text or XML files
127 (see [the source](https://github.com/robcast/digilib/tree/master/text)). You have
128 to add `-Pservlet3` or `-Pservlet2` as well.
129
130 You also have to copy the mapping for the "Texter" servlet from `web-additional.xml` into the `web.xml` file
131 used by the selected servlet API like `web-3.0.xml`.
132
133 ### pdf
134
135 `-Ppdf` builds digilib with the "PDFCache" servlet to generate and download PDF files from images.
136 (see [the source](https://github.com/robcast/digilib/tree/master/pdf)).
137
138 You also have to copy the mapping for the "PDFCache" servlet from `web-additional.xml` into the `web.xml` file
139 used by the selected servlet API like `web-3.0.xml`.
140
141 ## create-sprites
142
143 `-Pcreate-sprites` re-creates the image sprite file (`webapp/src/main/webapp/jquery/img/dl-buttons-full-32-sprite.png`)
144 from the separate icon image files. This option only needs to be used if you are a developer and you want to
145 change the icon images.
146
147 ## running tests
148
149 `-DskipTests=false` enables some functional tests. The tests are run as part of the normal build process.
150 You can also run just the tests with `mvn -DskipTests=false test`.
151