Building the jar file
Not all required libraries are included in the source distribution. To build sqlworkbench.jar from the source distribution, unpack the source archive into a directory. Alternatively you can also checkout the sources from the subversion repository.
This directory will be referenced as ${wbroot} in this description.
To prepare your environment to build SQL Workbench/J from source you will need to
- Download and install a Java6 JDK. The Java runtime (JRE) does not contain a compiler, therefor the JDK is required.
- Download and install Ant 1.7 from http://ant.apache.org
-
Download the JarBundler Ant task. As the jarbundler library is referenced from within build.xml,
the jar file is needed even when you don't want to build the Mac release. Then copy the
files jarbundler-2.1.0.jar and JavaApplicationStub to ${wbroot}/etc/jarbundler.
- Download Apache POI from http://poi.apache.org unzip the distribution to ${wbroot}/etc/poi
- Download Apache Log4J 1.2.x from http://logging.apache.org/log4j/ and copy the jar file (e.g. Log4J-1.2.24.jar) into the directory ${wbroot}/etc/log4j
- Download HSQLDB from http://www.hsqldb.org (Required to run the JUnit test. Not needed if you get everything from the SVN repository)
- Download H2 Database from http://www.h2database.com (Required to run the JUnit test. Not needed if you get everything from the SVN repository)
- Download the Jemmy library from http://java.net/projects/jemmy (Required to run the GUI tests. Not needed if you get everything from the SVN repository)
- Create the directory ${wbroot}/junit and copy the files hsqldb.jar, h2.jar and jemmy.jar into that directory (Not needed if you get everything from the SVN repository)
If you check out the subversion repository, the junit directory will be available automatically.
Now you can build the jar file by typing ant while the scripts directory is your current directory. If the build is successful, ${wbroot}/dist/sqlworkbench.jar will be created.
The default Ant target make-dev-jar does not build the manual.
Building the manual
To build the manual you need to download Docbook XSL package
(Version 1.72) and FOP (fop-0.94-bin-jdk1.4.zip).
- Copy the Docbook distribution to ${wbroot}/doc/docbook
- Copy the FOP distribution to ${wbroot}/etc/fop
Now you can build the PDF manual by typing ant pdf or HTML manual by typing ant publish-dev.