Chapter 3. Content of the distribution

After installation, the following directories should be found in the installed Qizx directory:

docs/

Root of the documentation and samples.

index.html

Dispatches to the different parts of the documentation.

release-notes.html

change list, similar to the one in Qizx web site.

manual.pdf

Qizx manual in PDF form.

manual/

Qizx manual in browsable HTML form.

javadoc/

Java documentation of the API and utility classes.

samples/

Examples (documents, queries, Java code, DTD and catalogs) used by the chapters "Getting started" and "Programming with the Qizx API" of the manual.

bin/

Contains executable scripts:

qizx, qizx.bat

Scripts for running the command-line tool, respectively on Unix-like platforms (Linux, Mac OS X, others), and MS Windows.

qizxstudio, qizxstudio.bat

Scripts for running the graphic interface Qizx Studio, respectively on Unix-like platforms (Linux, Mac OS X, others), and MS Windows.

qizx-xl*, qizxstudio-xl*

(Not in Qizx Free Engine): equivalent scripts for running the "XL" version (using jars lib/qizxxl.jar and lib/qizxxlstudio.jar). This experimental version is capable of managing XML documents of size larger than 2 Gb.

xrepo, xrepo.bat

Scripts for running the EXPath Packaging management tool, respectively on Unix-like platforms (Linux, Mac OS X, others), and MS Windows.

lib/

Contains the run-time jars used by Qizx:

qizx.jar

Core Qizx engine.

qizxstudio.jar, qizxstudio_help.jar

Qizx Studio application.

qizxxl.jar, qizxxlstudio.jar

(Not in Qizx Free Engine): build of Qizx capable of managing XML documents of size larger than 2 Gb.

resolver.jar

Apache XML Catalogs resolver for catalog-based entity resolution.

jhall.jar

Standard Java Help engine.

legal/

Contains licenses and information for Qizx/db and third-party components used in Qizx.

server/

Material for creating a Qizx Server, inside a J2EE application server, or as a standalone server.

qizx

Template J2EE Web Application for Qizx Server. Also used by the standalone server (see below).

root

Template server configuration.

standalone

standalone server with a control application to configure, start and stop Qizx Server. Uses the previous two directories as templates..

src.zip

Source code provided with the distribution.

This source code is provided as example and for documentation purpose only. Only applications, utilities and API are included here.

Included packages:

com.qizx.api

Source code of the API interfaces and classes.

com.qizx.api.util

Utility classes such as XMLSerializer.

com.qizx.api.util.accesscontrol

Sample implementation of AccessControl.

com.qizx.api.util.text

Base implementations of Sieves for indexing.

com.qizx.apps

Implementation of the command line tool.

com.qizx.apps.studio

Implementation of Qizx Studio.

Rebuilding the Qizx Studio application should be possible using this source code and qizx.jar. However, no support is provided for modified applications.