The igpp-docgen tool is a document generator based on Apache Velocity. The tool can process template documents written in Velocity Template Language (VTL). It can read PDS3 labels, text files containing keyword=value pairs, spreadsheets in CSV or TAB format and metadata in CDF files. The content of each processed files are assigned to variables in separate Velocity contexts (namespaces) and can be referenced in the Velocity template file. The output format can be text files, including well-formed PDS3 or XML.
The igpp.docgen tool was developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The software was specifically developed under Java version 1.6 and has only been tested with this version. You can determine which version of Java you are running with the command:
% java -version
java version "1.6.0_26"
Java(TM) SE Runtime Environment (build 1.6.0_26-b03-384-10M3425)
Java HotSpot(TM) 64-Bit Server VM (build 20.1-b02-384, mixed mode)
Download the igpp.docgen package from the IGPP web site site. The binary distribution is available in identical zip or tar/gzip packages. The installation directory may vary from environment to environment but in UNIX-based environments it is typical to install software packages in the /usr/local directory and in Windows-based environments it is typical to install software packages in the C:\Program Files directory. Unpack the selected binary distribution file with the following command:
% unzip igpp-docgen-1.0.23.zip
The unzip will result in the creation of the igpp-docgen-1.0.23 directory with the following directory structure:
A README file directing the user to the available documentation for the project.
The copyright notice from the Regents of the University of California detailing the restrictions regarding the use and distribution of this software. Although the license is strictly worded, the software has been classified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.
This directory contains batch and shell scripts for executing the tool.
This directory contains a local web site with documentation, api javadoc, and other related information. Just point the desired web browser to the index.html file in this directory.
This directory contains examples of using the tool.
This directory contains the dependent jar files for the tool along with the executable jar file (igpp-docgen-1.3.0.jar) containing the igpp.docgen tool software.
Shell scripts to run the tool are in the "bin" directory in the distribution. You can run the tool on a Linux system with the command: