X-Git-Url: http://git.indexdata.com/?p=mp-xquery-moved-to-github.git;a=blobdiff_plain;f=doc%2Fbook.xml;h=90b2920524b7fbeed850f89ed3797a8dcecc871a;hp=4669bdd9ddfbbb5ad6131bb9c2a2060d54ece83f;hb=f8686bc1232c7f0aa67e9827a6bd0175450c2cde;hpb=b335d52a8220fc3623545f622aff883f1fbb77bd
diff --git a/doc/book.xml b/doc/book.xml
index 4669bdd..90b2920 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -31,7 +31,7 @@
using W3C's XQuery language.
- Metaproxy is covered by the GNU General Public License version 2.
+ MP-XQuery is covered by the GNU General Public License version 2.
@@ -45,21 +45,103 @@
-
Introduction
-
- MP-XQuery is a module for
- Metaproxy.
+ MP-XQuery is a Metaproxy module
+ that allows record conversion using
+ W3C XML XQuery.
+ The initial motivations for the module was to be able to
+ BIBFRAME records via SRU/Z39.50. By using the
+
+ marc2bibframe
+ utilities, this module can convert existing
+ MARCXML records to BIBFRAME records - on the fly - as part of retrieval.
-
Installation
-
+
+ MP-XQuery is available as packages for CentOS/RHEL 6 and most recent
+ Ubuntu/Debian versions. For other systems, the module must be build
+ from source.
+
+
+ Installing packages
+
+ You need to enable the relevant software repositories.
+ For setting up refer to one of:
+ CentOS 6
+ ,
+ Ubuntu
+ and
+ Debian
+
+
+ The package is called mp-sparql on RHEL/Debian systems.
+ Install that package and you are ready to use filter "xquery" in your
+ setup.
+
+
+
+ Installing from source
+
+ To build from source, you need zorba and metaproxy development
+ packages. Zorba might be installed in /opt/zorba
+ as follows:
+
+ tar zxf zorba-3.0.tar.gz
+ cd zorba-3.0
+ mkdir build
+ cd build
+ cmake -D -Wno-dev \
+ -D CMAKE_INSTALL_PREFIX=/opt/zorba \
+ -D ZORBA_SUPPRESS_SWIG:BOOL=ON \
+ ..
+ sudo make install
+
+ Consult the Zorba documentation for more information.
+
+
+ Metaproxy can be installed as follows:
+
+ ./configure
+ make
+ sudo make install
+
+ But consult the Metaproxy documentation for requirements and
+ options.
+
+
+ We are now ready to build the MP-XQuery module with:
+
+ cd mp-xquery-version
+ make ZORBA=/opt/zorba MP_CONFIG=/usr/local/bin/mp-config
+
+ Adjust ZORBA and MP_CONFIG values
+ above for the correct location of installed
+ Zorba and Metaproxy's mp-config respectively. MP_CONFIG can be omitted
+ if Metaproxy was installed in the system PATH.
+
+
+ You can now install the metaproxy_filter_xquery.so
+ in a directory searched by Metaproxy daemon.
+ Specifically, that's the directories
+ given by the dlpath configuration.
+
+
+ If dlpath includes /usr/lib/metaproxy6/modules,
+ the module can be installed with:
+
+ cp src/metaproxy_filter_xquery.so /usr/lib/metaproxy6/modules
+
+
+
-
Reference