The servlet is built using Ant. Source files are formatted during the build using the stylesheets provided. The build process serializes the RefEntryBackEnd for the servlet so the servlet is completely self contained for initialization. Everything is in the servlet WAR file. Because it is self-contained, the servlet can be rebuilt from its own contents. Because it loads everything into memory at initialization time, the servlet is also less susceptible to file system corruption while it runs, though memory corruption could conceivably ruin it easily, and servlets containing many, many documents could use significant amounts of memory.
The servlet WAR file includes the following content.
Table 1. Servlet Content
|build.xml||Ant build file|
|docs/||Project documentation source and Javadoc|
|docs/README.txt||Read this first|
|docs/relnotes.txt||Release notes for this release|
|format.java||Wrapper for format utility|
|META-INF/||Servlet manifest files|
|src/||Project source files|
|src/conf/||Servlet configuration files|
|src/org/mcraig/cs445/refentry||Java source files for the servlet|
|src/refentry.dtd||DocBook-based DTD for RefEntry documents|
|src/test/||Test RefEntry documents|
|src/web.xml||Web application descriptor|
|src/xml/||RefEntry XML sources|
|Test*.java||System tests for finished servlet|
|WEB-INF/||Servlet generated files|
All content, except the documentation graphics and documentation build files, can be retrieved by unpacking the archive.