root/other-projects/trunk/gs3-webservices-democlient/docs/HowToFiles/4InstallingFedoraGSearch.html @ 15338

Revision 15338, 3.5 KB (checked in by ak19, 12 years ago)

Documentation on how to run the demo-client, how to write and deploy web services and how to write web service clients

  • Property svn:executable set to *
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4<head>
5<title>Installing Fedora Generic Search</title>
6</head>
7<body>
8<a href="index.html">Back to index page</a>
9
10<h1>Installing Fedora Generic Search</h1>
11In this document,
12<ul>
13<li>$FEDORA_HOME refers to the full path to your Fedora installation directory.<br /> </li>
14<li>For a walkthrough on installing Fedora (and for links to the official Fedora instructions for installation) see <a href="3InstallingFedora.html">Installing Fedora</a>.</li>
15</ul>
16
17
18<ol>
19<li><a href="http://drama.ramp.org.au/cgi-bin/trac.cgi/wiki/InstallingFedoraGSearch">The detailed installation instructions</a> which I followed were written by the Muradora team.
20</li>
21
22<li>Once installed, the FedoraGSearch rest url will by default be at:
23<pre>http://localhost:8080/fedoragsearch/rest</pre>
24</li>
25
26<li>Next to the steps above, you will need to make some more changes in order to enable full-text indexing and searching of the Greenstone documents ingested into the Fedora repository.
27<ol style="list-style-type:lower-alpha"> 
28<li>Open the file:
29<pre>$FEDORAHOME/tomcat/webapps/fedoragsearch/WEB-INF/classes/config/index/demoFoxmlToLucene.xslt</pre>
30At present, Muradora's file allows all digital objects in your Fedora repository to be indexed and searchable. If you're alright with indexing just the Greenstone documents stored in Fedora's repository, then we'll add the following to the above file:
31<pre>   &lt;xsl:if test="starts-with($PID,'greenstone')"&gt;
32    ...
33    &lt;/xsl:if&gt;
34</pre>
35So that now the file contains:
36<pre>&lt;xsl:if test="foxml:digitalObject/foxml:objectProperties/foxml:property[@NAME='http://www.w3.org/1999/02/22-rdf-syntax-ns#type' and @VALUE='FedoraObject']"&gt;
37  <b>&lt;xsl:if test="starts-with($PID,'greenstone')"&gt; // ADDED THIS</b>
38     &lt;!--    filter out annotations: --&gt;
39     &lt;!--
40        &lt;xsl:choose&gt;
41        &lt;xsl:when test="foxml:digitalObject/foxml:datastream/foxml:datastreamVersion[last()]/foxml:xmlContent/rdf:RDF/rdf:Description/rel:isMemberOf[@rdf:resource='info:fedora/mura:annotations']"&gt;
42        &lt;/xsl:when&gt; // CORRECTED typo in this comment
43        &lt;xsl:otherwise&gt;
44     --&gt;
45    &lt;xsl:apply-templates mode="activeDemoFedoraObject"/&gt;
46     &lt;!--
47        &lt;/xsl:otherwise&gt;
48        &lt;/xsl:choose&gt;
49     --&gt;
50  <b>&lt;/xsl:if&gt; // ADDED THIS</b>
51&lt;/xsl:if&gt;
52</pre>
53</li>
54
55<li>In the file
56<pre>
57$FEDORAHOME/tomcat/webapps/fedoragsearch/WEB-INF/classes/config/index/index.properties</pre>
58we're going to add fulltext (and label) to the list of fields that are indexed and are therefore searchable. We do this by appending
59<pre>
60ds.fulltext ds.label
61</pre>
62So that it now becomes:
63<pre>fgsindex.defaultQueryFields = dc.description dc.title dc.creator dc.identifier ds.fulltext ds.label</pre>
64The field ds.label and a document's full-text can now be searched and will appear in the search results. (Only a customisable snippet-size of a document's full-text will present in the results of a search.)
65</li>
66
67<li>Finally, <b>an important note:</b> Fedora Generic Search only supports indexing and searching Fedora Digital Objects (Fedora repository contents) whose MIME-type is one of
68<ul>
69<li>text/html</li>
70<li>text/plain</li>
71<li>application/pdf</li>
72</ul>
73Text/xml is not accepted. (Therefore Greenstone documents exported to FedoraMETS and ingested into Fedora must be of one of the above MIME-types, else they will not be indexed by Fedora Generic Search.) 
74</li>
75</ol>
76</li>
77</ol>
78
79</body>
80</html>
Note: See TracBrowser for help on using the browser.