JaxoDraw Source

You may download the source code of the latest JaxoDraw distribution from SourceForge.

Note that from version 2.0-0 on, the latex style file axodraw4j.sty is not distributed with the core JaxoDraw program. You have to download and install it separately.

Instructions

Please check the prerequisites before downloading the the source distribution.

If you have downloaded the source distribution of JaxoDraw, you may unpack the tar.gz archive with

tar -zxf jaxodraw-xxx_src.tar.gz

under Linux or with the unzip utility under Windows. This will create a directory named JaxoDraw-xxx (the JaxoDraw home directory) in the current directory. For the src distribution the JaxoDraw home directory has the following structure:

src/main/java/ Java source files
src/main/resources/ Resources (icons,User Guide, etc.)
src/test/java/ JUnit test files for JaxoDraw
src/test/resources/ Test resources
src/site/ The JaxoDraw web site (XML sources)
src/doc/ Documentation files
src/doc/colors/ Documentation on the use of colors
src/doc/legal/ License files

The following directories are not present in the original source distribution, they may be generated by the ant build script as described below:

build/ Compiled class files and resources
build/javadoc/ API specification
dist/ Distribution files

From version 2.0 on, you have to use the ant script build.xml in the JaxoDraw home directory to compile the program. Apache Ant is a build tool that is itself written in Java, which means that it can be used on any platform that has a Java Runtime Environment installed. Please refer to the Apache Ant home page for documentation on ant.

To compile the sources and create the binary .jar file, just type:

ant

To just compile the sources without creating the .jar file:

ant compile

To create the API specification (optional, see below):

ant javadoc

Note that you will need to edit the build.properties file, in order to indicate the location of the Java API that you want to link against. This could be the on-line version of Sun's Java documentation, or a local file if you have the API installed locally.

For general usage instructions, type 'ant usage', or 'ant -p' to get a list of other targets.

Creating the javadoc API specification

Note: This is only needed if you are interested in the structure of the JaxoDraw source code, it is not required in order to run the program. We recommend to use ant as described above.

To create the javadoc API:

javadoc -d build/javadoc/ -link . -sourcepath src/main/java/ -subpackages net.sf.jaxodraw

You could add an optional aditional link with the -link Java-API option, where Java-API could be http://java.sun.com/j2se/1.4/docs/api/ to link against the on-line Java documentation from SUN, or a local directory if you have the Java API installed locally.

In any case, the command has to be run twice in order to get the cross-references right. This will create the javadoc API specification in the build/javadoc/ sub-directory.

Running the program

If you compiled JaxoDraw yourself from sources, you can start the program with

java -cp build/ net.sf.jaxodraw.JaxoDraw

or with

java -jar jaxodraw-xxx.jar

if you want to use the binary .jar file.