@Name@

@name@ @version@
@copyright@

SEE LICENSE and AUTHORS for all Copyright holders.
All Rights Reserved.

---------
NZDIS-KIF realease:
 binary jar file, sources, documentation, grammar and related files.
 KIF parser and simple pattern matching utilities
-------------------------


Please read LICENSE before using this software.


1. Purpose
==========

 The nzdis-kif module provides the tools necessary to parse and
 process KIF:
     Knowledge Interchange Format
     draft proposed American National Standard       
     (dpANS KIF)  NCITS.T2/98-004
 It contains the full parser, together with simple pattern matching 
 utility for KIF based sentences. It does not support characters blocks
 and it does not support any semantic analysis. It can be used for 
 processing any arbitrary S-expression based sentences.



2. How to install it
====================

 The KIF parser and related utilities is distributed in binary form 
 as a JAR file, which should be simply placed in the classpath for
 your application. Refer to the javadoc generated API help files 
 for more information about the API to the library.

 To test the binary distribution type:
 
    java -jar nzdis-kif.jar --gui test.kif
   
 This will result in rendering in a graphical window the abstract
 syntax tree of a give kif testing example.
 
 

3. Building it from sources
===========================

 To build the library yourself you need to have customized 
 software packages, in particular:
 
 ANT installed. 
 ANT is a java-based build tool produced as a part of Jakarta 
 Apache project. You can download the ANT version from 
 http://nzdis.otago.ac.nz/download/software/ant.tar.gz
 Unpack it, and follow instructions how to install it.

 SableCC compiler compiler (parser generator) installed.
 SableCC is java-based object oriented parser generator,
 and you can download the SableCC version from:
 http://nzdis.otago.ac.nz/download/software/sablecc.zip
 Download it and put into your classpath.

 The above packages were modified by us, and the original
 software from SableCC or ANT effort might not work for you
 "out of the box" with our nzdis-kif module, 
 we suggest and encourage the use of our provided and 
 patched versions.


 Once you have ANT and SableCC installed and ready, simply type:

   ant parsers

 to generate the KIF and KIF pattern matcher parser, and then:

   ant jar

 to generate classes and pack them into a jar file. The jar file 
 by default will be placed inside lib directory, you can change it by
 invoking the building process with option:
   ant -Dlib.dir=/my_new_place_for/jars jar



4. Support and contact information
==================================

The end-user understands that the program was developed for
research purposes and is advised not to rely exclusively on the
program for any reason.

The paid support for this software is available.
For more information please contact:
  NZDIS Team, at nzdis@waitaki.otago.ac.nz or more directly
  Professor Martin Purvis mpurvis@infoscience.otago.ac.nz 

If you have any question, send an electronic message to 
 NZDIS Team <nzdis@waitaki.otago.ac.nz>,
 Mariusz Nowostawski <mariusz@rakiura.org> 
or write to:

Mariusz Nowostawski
University of Otago
Information Science Dep
PO BOX 56
Dunedin, New Zealand

To subscribe to the mailing-list check out
  http://lists.sourceforge.net/lists/listinfo/sablecc-nzdis

For more information visit the NZDIS web site:  
  http://nzdis.otago.ac.nz