HomeDownloadsUser GuideDevelopment

Development: Build-time Tools Used

Build Tools Overview

This project makes use of a number of build-time tools.

The following table lists these tools along with the versions, homepages and licensing information.

List of Tools

Tool Version Homepage
ant 1.7.1 http://ant.apache.org/
ant-contrib 1.0b3 http://ant-contrib.sourceforge.net/
ant-count 1.2 http://antcount.sourceforge.net/
ant-tools 1.3.0 http://mulifex.sourceforge.net/
dom4j 1.4 http://dom4j.org/
jgoodies forms 1.1.0 http://www.jgoodies.com/
taglets 2.0.3 http://taglets.sourceforge.net/index.html
tigris-style 1.1 http://style.tigris.org/
tooldoc 1.0.3 http://mulifex.sourceforge.net/

Build Tools Details

The following section lists detail information for each of the libraries.

Please refer to the corresponding tool.xml description in the tool directory for further information.

ant

Java-based build tool similar to the Unix make tool.

Version: 1.7.1
Homepage: http://ant.apache.org/
License: Apache Software License, Version 1.1

ant-contrib

A collection of tasks and utilities for Apache Ant.

Version: 1.0b3
Homepage: http://ant-contrib.sourceforge.net/
License: Apache Software License, Version 1.1
Requires: ant 1.7.1

ant-count

Statistics tool to parse files for Apache Ant.

Version: 1.2
Homepage: http://antcount.sourceforge.net/
License: GNU Lesser General Public License, Version 2.1, February 1999
Requires: ant 1.7.1

ant-tools

Custom MuliFex Ant Tool Tasks.

Currently the following tasks are included:

toollist
Helper task for the tooldoc project tool.
xsltdoc
Extended xslt task that automatically passes in some parameters (like generation source, timestamp, etc.). This task is mainly to prevent cluttered build files that have the same copy/pasted lines all over the place.
webdoc
Documentation build task that builds webpages for the tigris-style. It takes a couple of HTML files as well as a site description file as input and creates the whole webpage including navigation, breadcrumbs, etc. pp. Take a look at build.xml on how it is used for MuliFex.
Version: 1.3.0
Homepage: http://mulifex.sourceforge.net/
License: BSD Style License
Requires: ant 1.7.1
dom4j 1.4 dom4j 1.6.1

dom4j

dom4j is an Open Source XML framework for Java.

dom4j allows you to read, write, navigate, create and modify XML documents. It integrates with DOM and SAX and is seamlessly integrated with full XPath support.

Version: 1.4
Homepage: http://dom4j.org/
License: BSD Style License

jgoodies forms

Build better screens faster.

The JGoodies Forms framework helps you lay out and implement elegant Swing panels quickly and consistently. It makes simple things easy and the hard stuff possible, the good design easy and the bad difficult.

Version: 1.1.0
Homepage: http://www.jgoodies.com/
License: BSD Style License

taglets

The Taglets Collection is a utility suite around the JavaDoc tool. It offers:

Preconfigured Tags
A suite of preconfigured extended tags for like formatting the text of JavaDoc comments.
Built-in Generator Tags
Support for well-known generator tags like e.g. for XDoclet or EMF tags.
Custom Tags
A set of easy to configure taglets that allow pattern-based definition of custom JavaDoc tags.
Simple Taglet API
It also provides an interface similar to the standard Taglet API which aims to be more powerful while still simpler to use.
Version: 2.0.3
Homepage: http://taglets.sourceforge.net/index.html
License: BSD Style License

tigris-style

Cascading stylesheets for web applications.

The project webpage as well as the user guide and the developer documentation make use of the tigris style.

This "build tool" therefore consists of resources used unmodified as well as some driver scripts to generate the documentation.

Customizations to the tigris style are stored in the documentation resource folder of the project.

Version: 1.1
Homepage: http://style.tigris.org/
License: Apache Software License, Version 1.1

tooldoc

Ant task and XSLT documentation drivers for tool descriptions.

Each tool used resides in its own folder and is described by a simple XML file (take a look at some of the tool.xml files in the /tool/<toolgroup>/<toolname> subfolders.

Groups of tools (such as build tools, libraries, etc.) are also grouped in a folder and there is an overview description file called tools.xml which describes the tool group. Take a look e.g. at /tool/build/tools.xml.

Generation of tool information webpages is a two-step process:

  1. Generation of a unified tool information XML file using the toollist ant task (have a look at the ant driver file /tool/build/toodoc/ant.xml on how to invoke toollist).
  2. Generation of the a single webpage for each tool group using the tooldoc style sheets (used in build.xml to build pages like the one you're currently viewing).

There is not much documentation about tooldoc but most of what's here should be self-explanatory -- and of course there's also the source :-).

Version: 1.0.3
Homepage: http://mulifex.sourceforge.net/
License: BSD Style License
Requires: ant 1.7.1
ant-tools 1.3.0