Changeset 8194


Ignore:
Timestamp:
2004-09-30T15:18:32+12:00 (20 years ago)
Author:
kjdon
Message:

more info

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/greenstone3-extensions/vishnu/README

    r8189 r8194  
    22
    33LINUX INSTALL:
    4 The environment variable JAVA_HOEM needs to be set.
     4If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
     5If you want to run it standalone:
     6
     7The environment variable JAVA_HOME needs to be set.
     8You 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.
     9You need the lucene 1.4 or higher jar file in your classpath.
     10Other jar files needed: xercesImpl.jar, servlet.jar.
     11
     12The Makefiles may need modifying with respect to where things get installed to.
    513
    614./configure [--prefix=...]
     
    1018WINDOWS INSTALL:
    1119
    12 
    13 RUNNING THE SERVLET USING TOMCAT:
    14 
    15 You need to run a servlet container for the server.
    16 
    17 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.
    18 The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
    19 The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
     20Doesn't work on windows yet.
    2021
    2122COLLECTION BUILDING:
     
    3536Once 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.
    3637
     38For collections in the Greenstone 3 context, you will need to create the files etc/collectionConfig.xml and index/buildConfig.xml.
     39These should look like the following:
     40
     41etc/collectionConfig.xml:
     42<collectionConfig>
     43  <metadataList>
     44    <metadata name="creator">creator's email address</metadata>
     45  </metadataList>
     46  <displayItemList>
     47    <displayItem name='name' lang='en'>Collection name</displayItem>
     48    <displayItem name='description' lang='en'>Collection description
     49    </displayItem>
     50  </displayItemList>
     51</collectionConfig>
     52
     53index/buildConfig.xml:
     54<buildConfig>
     55  <metadataList/>
     56  <serviceRackList>
     57    <serviceRack name="Visualizer">
     58      <engineType name="MG"/> <!-- or LUCENE, depending on how you built the collection -->
     59    </serviceRack>
     60  </serviceRackList>
     61</buildConfig>
     62
     63
     64RUNNING THE SERVLET:
     65
     66If you are running this standalone, you need to run a servlet container for VisServlet.
     67
     68The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container.
     69The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
     70The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
    3771
    3872RUNNING THE APPLET:
    3973
    4074Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
     75create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
    4176Open 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.
  • trunk/gsdl3/extensions/vishnu/README

    r8189 r8194  
    22
    33LINUX INSTALL:
    4 The environment variable JAVA_HOEM needs to be set.
     4If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
     5If you want to run it standalone:
     6
     7The environment variable JAVA_HOME needs to be set.
     8You 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.
     9You need the lucene 1.4 or higher jar file in your classpath.
     10Other jar files needed: xercesImpl.jar, servlet.jar.
     11
     12The Makefiles may need modifying with respect to where things get installed to.
    513
    614./configure [--prefix=...]
     
    1018WINDOWS INSTALL:
    1119
    12 
    13 RUNNING THE SERVLET USING TOMCAT:
    14 
    15 You need to run a servlet container for the server.
    16 
    17 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.
    18 The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
    19 The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
     20Doesn't work on windows yet.
    2021
    2122COLLECTION BUILDING:
     
    3536Once 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.
    3637
     38For collections in the Greenstone 3 context, you will need to create the files etc/collectionConfig.xml and index/buildConfig.xml.
     39These should look like the following:
     40
     41etc/collectionConfig.xml:
     42<collectionConfig>
     43  <metadataList>
     44    <metadata name="creator">creator's email address</metadata>
     45  </metadataList>
     46  <displayItemList>
     47    <displayItem name='name' lang='en'>Collection name</displayItem>
     48    <displayItem name='description' lang='en'>Collection description
     49    </displayItem>
     50  </displayItemList>
     51</collectionConfig>
     52
     53index/buildConfig.xml:
     54<buildConfig>
     55  <metadataList/>
     56  <serviceRackList>
     57    <serviceRack name="Visualizer">
     58      <engineType name="MG"/> <!-- or LUCENE, depending on how you built the collection -->
     59    </serviceRack>
     60  </serviceRackList>
     61</buildConfig>
     62
     63
     64RUNNING THE SERVLET:
     65
     66If you are running this standalone, you need to run a servlet container for VisServlet.
     67
     68The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container.
     69The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
     70The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
    3771
    3872RUNNING THE APPLET:
    3973
    4074Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
     75create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
    4176Open 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.
  • trunk/gsdl3/packages/vishnu/README

    r8189 r8194  
    22
    33LINUX INSTALL:
    4 The environment variable JAVA_HOEM needs to be set.
     4If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
     5If you want to run it standalone:
     6
     7The environment variable JAVA_HOME needs to be set.
     8You 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.
     9You need the lucene 1.4 or higher jar file in your classpath.
     10Other jar files needed: xercesImpl.jar, servlet.jar.
     11
     12The Makefiles may need modifying with respect to where things get installed to.
    513
    614./configure [--prefix=...]
     
    1018WINDOWS INSTALL:
    1119
    12 
    13 RUNNING THE SERVLET USING TOMCAT:
    14 
    15 You need to run a servlet container for the server.
    16 
    17 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.
    18 The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
    19 The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
     20Doesn't work on windows yet.
    2021
    2122COLLECTION BUILDING:
     
    3536Once 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.
    3637
     38For collections in the Greenstone 3 context, you will need to create the files etc/collectionConfig.xml and index/buildConfig.xml.
     39These should look like the following:
     40
     41etc/collectionConfig.xml:
     42<collectionConfig>
     43  <metadataList>
     44    <metadata name="creator">creator's email address</metadata>
     45  </metadataList>
     46  <displayItemList>
     47    <displayItem name='name' lang='en'>Collection name</displayItem>
     48    <displayItem name='description' lang='en'>Collection description
     49    </displayItem>
     50  </displayItemList>
     51</collectionConfig>
     52
     53index/buildConfig.xml:
     54<buildConfig>
     55  <metadataList/>
     56  <serviceRackList>
     57    <serviceRack name="Visualizer">
     58      <engineType name="MG"/> <!-- or LUCENE, depending on how you built the collection -->
     59    </serviceRack>
     60  </serviceRackList>
     61</buildConfig>
     62
     63
     64RUNNING THE SERVLET:
     65
     66If you are running this standalone, you need to run a servlet container for VisServlet.
     67
     68The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container.
     69The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
     70The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
    3771
    3872RUNNING THE APPLET:
    3973
    4074Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
     75create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
    4176Open 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.
Note: See TracChangeset for help on using the changeset viewer.