HomeDownloadsUser GuideDevelopmentLegal

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.

Build Tools Version Homepage
ant 1.6.5 http://ant.apache.org/
ant-contrib 1.0b2 http://ant-contrib.sourceforge.net/
ant-tools 1.2.0 http://mulifex.sourceforge.net/
dom4j 1.4 http://dom4j.org/
J2SE Tools - http://java.sun.com/
lightbox 2.03.1 http://www.huddletogether.com/projects/lightbox2/
murimages 2.0 http://www.orchaid.com/
prettify 20070329 http://code.google.com/p/google-code-prettify/
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.6.5
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.0b2
Homepage: http://ant-contrib.sourceforge.net/
License: Apache Software License, Version 1.1
Requires: ant 1.6.5

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.2.0
Homepage: http://mulifex.sourceforge.net/
License: BSD Style License
Requires: ant 1.6.5
dom4j 1.4

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

J2SE Tools

This tool provides a wrapper for the tools.jar shipped with the JDK.

According to the build settings in your env/site.xml or env/user.xml this wrapper copies the tools.jars of your J2SE 1.4 and J2SE 1.5 installation as well as its sources to the project environment.

Version: -
Homepage: http://java.sun.com/
License: Copyright (c) 2006 Sun Microsystems, Inc.

lightbox

Lightbox is a simple, unobtrusive script used to overlay images on the current page. It's a snap to setup and works on all modern browsers.

Fantastic tool and works perfect in combination with MurImages.

Version: 2.03.1
Homepage: http://www.huddletogether.com/projects/lightbox2/
License: Creative Commons Attribution 2.5 License

murimages

Photo Collage II aka Mur d'Images, collage and image map generator by Hervé Perez.

This is an enhanced version of Romain Guy's Photo Collage .

Includes a modified version of the High Performance JavaScript Vector Graphics Library by Walter Zorn.

The version included is a modified WebStart version that allows local execution using java -jar murimages.jar.

Version: 2.0
Homepage: http://www.orchaid.com/
License: Unknown

prettify

Prettify is embedded in JavaDoc generated to pretty print code tags such as {@source} or {@example}.

Google Code Prettify

Some functions for browser-side pretty printing of code contained in html.

The lexer should work on a number of languages including C and friends, Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles. It works passably on Ruby, PHP and Awk and a decent subset of Perl, but, because of commenting conventions, doesn't work on Smalltalk, Lisp-like, or CAML-like languages.

If there's a language not mentioned here, then I don't know it, and don't know whether it works. If it has a C-like, Bash-like, or XML-like syntax then it should work passably.

Usage:

  1. Include this source file in an html page via <script type="text/javascript" src="/path/to/prettify.js"></script>
  2. Add onload="prettyPrint();" to the document body tag.
  3. Define style rules. See the example page for examples.
  4. Mark the <pre> and <code> tags in your source with class=prettyprint.
Version: 20070329
Homepage: http://code.google.com/p/google-code-prettify/
License: Apache Software License, Version 2.0

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.6.5
ant-tools 1.2.0