webcoords - README

TABLE OF CONTENTS
- FILE DESCRIPTIONS
- webcoords SYSTEM REQUIREMENTS
- INSTALLATION
- EXECUTION (UNIX/Linux)
- EXECUTION (Windows)
- BASIC USAGE

-----------------------------------------------
webcoords FILE DESCRIPTIONS

Here is a breakdown of the file structure we have included in this distribution

webcoords/bin
- This directory contains the setup scripts that need to be run in order to setup your environment for executing webcoords.  Please see the installation portion of this document for further instructions.

webcoords/code/edu/uiuc/webcoord
- This directory contains all of the source code that was developed as part of the webcoords project.  These files are all a part of the edu.uiuc.webcoord package.

webcoords/class/edu/uiuc/webcoord
- This directory contains the compiled class files from the source code.  The same structure as above under code is maintained here

webcoords/lib
- The lib directory contains the doc and unittests subfolders and also the jar files that are needed as part of this project.
- The htmllexer.jar and htmlparser.jar are used to parse the html files.  This is an open source project we found on sourceforge.
- The jtidy.jar is an html validation tool also found on sourceforge.
- Junit.jar is a popular tool used for java unit testing.  We used it for this project.
- xstream-1.1.1.jar was used to convert our output to xml format.

webcoords/lib/doc
- This directory contains miscellaneous project documentation including various test html files, the initial project proposal, etc...
- This also contains FinalReport.doc with an elaborate flow chart and in depth documentation on usage of webcoords.

webcoords/lib/unittests
- contained in here are all the unit tests we have written using junit for unit testing of webcoords.  The compiled class files can be found under webcoords/class.


-----------------------------------------------

webcoords SYSTEM REQUIREMENTS
- These are the minimum requirements for using what we gave you

- 64MB RAM free
- Java v1.5.0 or newer

-----------------------------------------------

INSTALLATION
- No further installation is required after untarring this into a directory of your choice.

-----------------------------------------------

EXECUTION (on UNIX/Linux)

- This project was developed and tested on java version 1.5.  Please use at your own risk if you choosed to use 
  a version earlier than 1.5.
- In webcoords/bin, you must edit the usersetup.csh file so it knows where you
  installed Java and unpacked webcoords.
- After editing the userSetup.csh file please do the following three steps to run webcoords
- Make sure you are in the c shell for these scripts to work.  You are free to work in the shell of your choice as 
  long as you are aware of how to properly setup your environment


1.  cd webcoords/bin
2.  source setup.csh
3.  java edu.uiuc.webcoord.FetchHTML 

Usage:
        java FetchHTML [-U url | -F filename] [-I] [-O outputfilename]

        ex: java FetchHTML -U http://www.uiuc.edu
        ex: java FetchHTML -F test.html -I

-----------------------------------------------


EXECUTION (on Windows)
- This project was developed and tested on java version 1.5.  Please use at your own risk if you choosed to use 
  a version earlier than 1.5.
- In webcoords\bin, you must edit the usersetup.bat file so it knows where you
  installed Java and unpacked webcoords.

- After editing the userSetup.bat file please do the following four steps to run webcoords

1.  open a command prompt and to the installation directory (you should see a webcoords folder)
2.  cd webcoords\bin
3.  setup
4.  webcoords [-U url | -F filename]

Usage:
        java FetchHTML [-U url | -F filename] [-I] [-O outputfilename]

        ex: java FetchHTML -U http://www.uiuc.edu
        ex: java FetchHTML -F test.html -I

-----------------------------------------------

BASIC USAGE

Usage:
        java FetchHTML [-U url | -F filename] [-I] [-O outputfilename]

        ex: java FetchHTML -U http://www.uiuc.edu
        ex: java FetchHTML -F test.html -I
        
- See FinalReport.doc for a more elaborate explanation under the webcoords/lib/doc folder.
