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

Last change on this file since 8194 was 8194, checked in by kjdon, 19 years ago

more info

  • Property svn:keywords set to Author Date Id Revision
File size: 3.3 KB
Line 
1Vishnu package for ...
2
3LINUX INSTALL:
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.
13
14./configure [--prefix=...]
15make
16make install
17
18WINDOWS INSTALL:
19
20Doesn't work on windows yet.
21
22COLLECTION BUILDING:
23
24The 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.
25
26Then you can build the collection:
27
28Command line:
29java 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")
30
31Using a GUI tool:
32java vishnu.builder.IndexerGUI
33
34Fill in the fields as appropriate, and click "Start indexing".
35
36Once 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.
37
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.
71
72RUNNING THE APPLET:
73
74Edit 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.
76Open 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 TracBrowser for help on using the repository browser.