| Revision History | |
|---|---|
| Revision 0.2.1 | 2009-01-19 |
|
The initial version of the document for the ETL framework version 0.2.1. | |
Abstract
This document describes how to install utility scripts that come with ETL.
Table of Contents
Firstly, you need to download and unpack archive with the parser in any directory. You could do it by going to the project page on the SourceForge: http://sf.net/projects/etl .
The parser is contained in the library
etl-parser.jar
and it does not needs any additional configuration. Just copy it to
your projects.
There is a number of the scripts in the subdirectory
scripts
that allow converting the ETL files into different XML forms. While
these scripts could be used from this directory if you add the
directory to the path, but if you already have a directory that
contains different utility scripts like
c:\util\bin
or
~/bin
you could create scripts there using the script
etl-install.cmd
(Windows) or
etl-install.sh
(UNIX). This installation scripts takes a the target directory as
argument. The script also support "." as argument when it is run from
directory different from where it is located. On UNIX it creates
symbolic links and on Windows it creates
.cmd
files that act like symlink.
You could check that scripts are installed correctly by running the
command
etl2html *.etl c:\temp\etl-test\*.html
[Windows] or
etl2html \*.etl /tmp/\*.html
[UNIX] (instead of
c:\temp\etl-test
or
/tmp
you could use any existing temporary directory) in the directory
ETL_HOME/samples/events
. It should create a bunch of html files that contain pretty
formatted text of the processed files.
There are four scripts installed
This script creates an html from presentation xml formatted
according the provided stylesheet. All files according to the
{sourcemask}
are processed and converted to
{targetmask}
files. In the masks you can use a single
*
that matches non zero sequence of characters. On UNIX platforms it
should be escaped. If
{targetmask}
is missing, the
{sourcemask}
.html files are generated. If {style-sheet} is missing, the
default stylesheet is used.
The functionality is almost the same as before, but outline stylesheet is used.
This script generates structural xml that represents AST for the source.
This script generates presentational xml that represents that is
basically dump of all events produced by the parser. This xml is
used to generate html by
etl2html
and
etl2ohtml
scripts.
If you have downloaded a zip file, you might need to run
chmod +x *.sh lib/*.sh
in the ETL_ROOT/scripts directory before scripts will start working.
These scripts understand
CATLOG_PATH
environment variable. It points to the directory where
CatalogManager.properties
file reside. By default the
ETL_ROOT/scripts/lib
directory is used. You can configure this variable to point to your
catalog file. For format of this property file see
the description of resolver library
.