JPlate Foundation 0.9

Summary

Welcome to the JPlate Foundation! This subproject of JPlate provides "core" Java functionality. Currently this documentation is a "work in progress" and will be enhanced when time permits.

Please note: This is an initial version and there is much missing (unit test cases, good Java documentation, etc).

Quick Start

To utilize the Foundation, include all jar files found in the release lib directory as part of the classpath. For example, assume the Foundation 0.9 has been downloaded and installed to /shared/jplate-foundation-0.9 on a Linux platform:

JPLATE_FOUNDATION_HOME=/shared/jplate-foundation-0.9
JPLATE_FOUNDATION_LIB_HOME=${JPLATE_FOUNDATION_HOME}/lib

JPLATE_FOUNDATION_CLASSPATH=${JPLATE_FOUNDATION_LIB_HOME}/commons-logging-1.1.jar:${JPLATE_FOUNDATION_CLASSPATH}
JPLATE_FOUNDATION_CLASSPATH=${JPLATE_FOUNDATION_LIB_HOME}/jplate-foundation-0.9.jar:${JPLATE_FOUNDATION_CLASSPATH}
JPLATE_FOUNDATION_CLASSPATH=${JPLATE_FOUNDATION_LIB_HOME}/log4j-1.2.15.jar:${JPLATE_FOUNDATION_CLASSPATH}

CLASSPATH=${JPLATE_FOUNDATION_CLASSPATH}:${CLASSPATH}

Please look to individual classes for more specific information on class utilization.

Building (if desired)

If you wish to build the Foundation from source, you will need access to a Subversion client and Ant 1.7.0+ (preferably 1.7.1 to simplify using the included libraries - please see the documentation on Environment 1.1 for more information).

Check out the source

Create a directory for checkout, change to this directory and execute:

svn co https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/environment
svn co https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/foundation

You will note two directories are created: environment and foundation.

Build the source

Build the source - change directories to the aforementioned foundation directory and execute the command:

ant

Results

After building, you should find a foundation/assembly/release directory containing various things such as a jar file (for example the Foundation 0.9 release produces jplate-foundation-0.9.jar) and other files normally associated with a Foundation release.

Dependencies

The Foundation has dependencies upon:

Environment 1.1(for building)
Ant 1.7.0+ (preferably 1.7.1 to simplify using the included libraries)
JDK 1.6.0_03 (for building - although 1.5x should work fine as well)

IRC Channel

There is an IRC channel on irc.freenode.net under the channel name #JPlate. The Project Manager is usually there most days under the name Flossy. He is more than happy to help or answer questions you may have.

Revision Information

Modifications:
    $Date: 2007-12-13 11:57:28 -0500 (Thu, 13 Dec 2007) $
    $Revision: 458 $
    $Author: sfloess $
    $HeadURL: https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/foundation/src/doc/index.html $