source: trunk/greenstone3-extensions/vishnu/README@ 8189

Vishnu package for ...

LINUX INSTALL:
The environment variable JAVA_HOEM needs to be set.

./configure [--prefix=...]
make
make install

WINDOWS INSTALL:


RUNNING THE SERVLET USING TOMCAT:

You need to run a servlet container for the server.

The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container. Edit the Makefile if need be.
The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.

COLLECTION BUILDING:

The directory where collection live is called collsHome. Inside this, create a new directory for your collection. The name of this directory is the collection identifier. Inside the collection directory create a new direcotry called import. Inside here put all the documents that you want in your collection. Documents must be plain text, xml or html.

Then you can build the collection:

Command line: 
java vishnu.builder.CollectionBuilder -collsHome (directory where collections live) -collection (directory name of collection) -name (descriptive name for collection) -description (collection description) -index ("mg" or "luc")

Using a GUI tool:
java vishnu.builder.IndexerGUI

Fill in the fields as appropriate, and click "Start indexing".

Once the collection is built, you need to rename the building directory to index. Collections are built into the building directory, but served from the index directory. This allows you to serve a built collection while rebuilding.


RUNNING THE APPLET:

Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
Open up the test.html file in a browser. Assuming you have collections available in the collectionsHome directory given to the servlet, you should be able to view them in the applet.