FRODO RDFSViz Tool 28-May-01
			----------------------------

The FRODO RDFSViz tool provides a visualization service for ontologies 
represented in RDF Schema.

The following directories/files are included in this distribution:

   apidoc/     		javadoc generated documentation
   classes/    		class files of the visualization tool
   lib/        		executable jar file
               		(includes the class files from the import dir)
   src/			complete sources
   import/              contains:
                           rdf-api-2001-01-19.jar provided by Segey Melnik
                           xerces-1_4_0.jar XML stuff from www.apache.org 
   data/                template directory for servlet version

   README               this file
   README.txt           this file (Windows)
   RDFSchemaGrapher.jpr  JBuilder 3.5 project file
                         (you only need to fix the library paths
			 / Project properties -> Required libraries tab) 
   config/              example XML config file


INSTALLATION

Download the RDFSViz-<version>.tar.gz file from

	http://www.dfki.uni-kl.de/frodo/RDFSViz/

Unpack the RDFSViz-<version>.tar.gz file in a direcory of your
choice (on Windows, WinZip does the job). You also need to download 
the Graphviz graph drawing program for your platform from

	http://www.research.att.com/sw/tools/graphviz/download.html

and install it.


 COMMAND LINE VERSION

To invoke the command line version, simply type
(you will need JDK 1.2.x or higher):

        java -jar lib/RDFSchemaGrapher.jar

The tool will then print out a list of acceptable options
including a short description and their default values, if any. 
You can choose to write the generated output directly
to a given file (-o option) or to print it to stdout.
The command line tool will only generate output in the Graphviz
dot file format.

Example:

     java -jar lib/RDFSchemaGrapher.jar \
          -rdfs http://www.dfki.uni-kl.de/frodo/RDFSViz/newspaper.rdfs

 will print the generated dot file for our newspaper example to stdout  

     java -jar lib/RDFSchemaGrapher.jar \
           -rdfs http://www.dfki.uni-kl.de/frodo/RDFSViz/newspaper.rdfs\
           -NodeColor red -IsAEdgeColor green\
           -o outfile.dot

 will generate a file 'outfile.dot' for the same graph but with red
 nodes and green 'subClassOf' edges.

 You can put the grapher settings into a XML file:

     java -jar lib/RDFSchemaGrapher.jar \
    	   -rdfs http://www.dfki.uni-kl.de/frodo/RDFSViz/newspaper.rdfs\
           -config config/config.xml

 will read grapher settings from config/config.xml. Options given via
 command line override settings in the XML file. 
 (grapher properties can be found in
  dfki.tools.rdf_schema_grapher.RDFSchemaGrapher.Property)
 

The generated dot files can either be directly viewed with the
Graphviz 'dotty' tool (which also allows manipulation of the graphs)
or transformed into gif or ps files with the Graphviz 'dot' tool, e.g.:

        dot -Tgif <dot-file> -o <gif-file>

Note that on some UNIXes the environment variable DOTFONTPATH must point
to a directory that contains the Arial.ttf file (e.g.,
/usr/openwin/lib/X11/fonts/TrueType on Solaris).


SERVLET VERSION

The servlet version of the RDFSViz tool can be found in the
'dfki.frodo.tools.rdf_schema_grapher.servlet' package.

Detailed installation instructions are subject of current work.

To learn more about (initialization) parameters,
please consult the api documentation and source file itself.


BUGS, IMPROVEMENTS

Please report bugs and improvements to

	Andreas Lauer   lauer@dfki.uni-kl.de
	Michael Sintek  sintek@dfki.uni-kl.de