X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fbook.xml;h=5826b16f2ea75f883a9ccd1841937e2291e037a0;hb=ab121ed083cfa1b57dd76d30da92bbebe656f226;hp=272c2d05f6ca8eac1b13684b1b591b6a43d7dce1;hpb=79c4233aa1c021a4458184cd2d4214f1587535da;p=mp-sparql-moved-to-github.git
diff --git a/doc/book.xml b/doc/book.xml
index 272c2d0..5826b16 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -19,6 +19,9 @@
HeikkiLevanto
+
+ JakubSkoczen
+
&version;
@@ -52,7 +55,7 @@
Introduction
MP-SPARQL is a Metaproxy module
- that converts Type-1/RPN queries to SPARQL.
+ that converts Type-1/RPN queries to SPARQL.
@@ -83,6 +86,14 @@
Install that package and you are ready to use filter "sparql" in your
setup.
+
+ mp-sparql depends on a number of packages created by Index Data and
+ system-provided ones, such as Libxml2. For external software Zorba, no
+ system package exist so Index Data has packaged that separately. This
+ package is called idzorba. All these dependences should
+ be automatically installed when the Index Data software repository is
+ set up.
+
Installing from source
@@ -94,8 +105,7 @@
make
sudo make install
- But consult the Metaproxy documentation for requirements and
- options.
+ Refer to the Metaproxy documentation for requirements and options.
We are now ready to build the MP-SPARQL module with:
@@ -128,6 +138,128 @@
+
+ Configuration
+
+ If you have installed mp-sparql as a package or have executed
+ make install from source, sample configuration
+ can be found in /usr/share/mp-sparql/bibframe or
+ /usr/local/share/mp-sparql/bibframe. In the
+ the following /usr/share prefix assumed. Adjust accordingly.
+ The directory contains these files:
+
+
+ triplestore.xml
+
+
+ A mature PQF to SPARQL configuration illustrating a lot of the
+ configuration facilities that are described in the manual
+ page of .
+
+
+
+
+ config-sparql.xml
+
+
+ A full metaproxy configuration file that includes
+ triplestore.xml cofiguration for the
+ mp-sparql filter, enables SRU and CQL to PQF conversion.
+
+
+
+
+ filter-sparql.xml
+
+
+ A partial metaproxy configuration suitable to be enabled in
+ /etc/metaproxy/filters-enabled.
+ This includes triplestore.xml as well.
+
+
+
+
+
+
+ If you want to use the package layout and modular configuration we
+ suggest you use filter-sparql.xml and perform something along the lines of:
+
+ cp /usr/share/mp-sparql/bibframe/filter-sparql.xml /etc/metaproxy/filters-available
+ cp /usr/share/mp-sparql/bibframe/triplestore.xml /etc/metaproxy
+ vi /etc/metaproxy/triplestore.xml
+ ln -s ../filters-available/filter-sparql.xml /etc/metaproxy/filters-enabled
+ service metaproxy restart
+
+ A copy of triplestore.xml is made. Adjust the
+ <defaults uri=.. value to the URI of your
+ triplestore.
+
+
+ If you want to create your own top-level configuration, you can copy
+ config-sparql.xml to any location you like and
+ run metaproxy with that. Something like this:
+
+ mkdir /etc/myconfig
+ cp /usr/share/mp-sparql/bibframe/* /etc/myconfig
+ sudo vi /etc/myconfig/triplestore.xml
+ metaproxy -c /etc/myconfig/config-sparql.xml
+
+ Again, a copy of triplestore.xml is made. Adjust the
+ <defaults uri=.. value to the URI of your
+ triplestore.
+
+
+
+ Do not edit files in /usr/share/mp-sparql/bibframe.
+ They are only samples and will be overwritten by a package update.
+ Instead copy the files away from there if you need to modify them.
+
+
+
+
+ Using the service
+
+ Either way, unless you have adjusted the metaproxy configuration,
+ Metaproxy can be reached on port 9000. Example using yaz-client and
+ PQF/Type-1:
+ f @attr 1=bf.anytitle water
+Sent searchRequest.
+Received SearchResponse.
+Search was a success.
+Number of hits: 1, setno 1
+records returned: 0
+Elapsed: 0.279441
+Z> s
+Sent presentRequest (1+1).
+Records: 1
+[work]Record type: XML
+
+
+
+ ...
+
+nextResultSetPosition = 0
+Elapsed: 0.256142
+]]>
+
+
+ Example using SRU:
+
+
+
Reference
@@ -165,7 +297,7 @@
along with Metaproxy; see the file LICENSE. If not, write to the
Free Software Foundation,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
+