Tools

Installation

Unzip the jMetra.zip file into a directory. Your jMetra download will include all the needed supporting jars. They will be located in the jmetra/lib directory. See the Getting Started section regarding the organization of the files for jMetra.

System Requirements

The jMetra binary includes other supporting jars to operate. You may already have these installed on your system but should use the versions that are included in the jMetra download, in the jmetra\lib directory. The following is a complete list of requirements:

Java Development Kit - You must download and install a Java2 (version 1.2 or later) Java Development Kit implementation for your operating system platform. Refer to Java Development Kit distributions at http://java.sun.com/j2se.
XML Parser jars - jMetra requires the presence of an XML parser that is compatible with the Java API for XML Parsing (JAXP) specification, 1.0 or later. The download has included the interface standard v1.1, xml-apis.jar, and the Apache v1.1 implementation xercesImpl.jar.
Log4j jar - jMetra requires the presence of Apache Log4j v1.2.8 or later (log4j.jar). When using newer Log4j releases backward compatability should be verified.
FreeMarker jar - jMetra requires the presence of FreeMarker (TM) v2.1.5 (freemarker.jar). This open source package provides the template engine for assisting in the generation of jMetraDoc html pages. When using newer FreeMarker releases backward compatability should be verified. Please note that the new Freemarker v2.2.2 is not backward compatible with v2.1.5. There were several syntax changes made in the template language. Subsequent jMetra minor releases will be based on v2.2.2 .

jMetra Directory Structure The jMetra directory structure is composed of the following: /lib Includes jMetra jar and all supporting jars. /examples Includes small example projects. /bin Has helpful batch files to customize for projects. license.html, LICENSE.apache.html LICENSE.freemarker.html license stuff. /docs/jmetradoc.html Contains information needed about using jMetra. Classpath The jMetra distribution includes a .bat file located in the /bin that provides an example of setting up the classpath, setting the parameters for the command line interface, and showing the coordination of the three phases of using jMetra. This example .bat can easily be modified for other projects. The examples also include .bats that may be modified.