Vishnu package for ...

LINUX INSTALL:
If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
If you want to run it standalone:

The environment variable JAVA_HOME needs to be set.
You need to have MG installed - this should be the version from Greenstone, and you need the mg.jar file in your classpath and the libmgjni.so in your ld_library_path.
You need the lucene 1.4 or higher jar file in your classpath.
Other jar files needed: xercesImpl.jar, servlet.jar.

The Makefiles may need modifying with respect to where things get installed to.

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

WINDOWS INSTALL:

Doesn't work on windows yet.

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.

For collections in the Greenstone 3 context, you will need to create the files etc/collectionConfig.xml and index/buildConfig.xml.
These should look like the following:

etc/collectionConfig.xml:
<collectionConfig>
  <metadataList>
    <metadata name="creator">creator's email address</metadata>
  </metadataList>
  <displayItemList>
    <displayItem name='name' lang='en'>Collection name</displayItem>
    <displayItem name='description' lang='en'>Collection description
    </displayItem>
  </displayItemList>
</collectionConfig>

index/buildConfig.xml:
<buildConfig>
  <metadataList/>
  <serviceRackList>
    <serviceRack name="Visualizer">
      <engineType name="MG"/> <!-- or LUCENE, depending on how you built the collection -->
    </serviceRack>
  </serviceRackList>
</buildConfig>


RUNNING THE SERVLET:

If you are running this standalone, you need to run a servlet container for VisServlet.

The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container. 
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.

RUNNING THE APPLET:

Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
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.