X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fbook.xml;h=994e3d1f272b4da3594897c044fb296d1a88cd1d;hb=refs%2Fheads%2Fmaster;hp=390f5dbdc8fe1131738f035529e4ed172911bc7a;hpb=ef8908147a9de5b5a4514d8e93e339ea9b8b605b;p=mp-xquery-moved-to-github.git
diff --git a/doc/book.xml b/doc/book.xml
index 390f5db..994e3d1 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -52,7 +52,8 @@
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
+ BIBFRAME records
+ via SRU/Z39.50. By using the
marc2bibframe
@@ -76,13 +77,16 @@
url="http://ftp.indexdata.dk/pub/mp-xquery/redhat/centos/6/README">CentOS 6
,
CentOS 7
+ ,
+ Ubuntu
and
Debian
- The package is called mp-sparql on RHEL/Debian systems.
+ The package is called mp-xquery on RHEL/Debian systems.
Install that package and you are ready to use filter "xquery" in your
setup.
@@ -91,14 +95,14 @@
Installing from source
To build from source, you need zorba and metaproxy development
- packages. Zorba might be installed in /opt/zorba
- as follows:
+ 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 \
+ cmake -Wno-dev \
-D CMAKE_INSTALL_PREFIX=/opt/zorba \
-D ZORBA_SUPPRESS_SWIG:BOOL=ON \
..
@@ -107,6 +111,14 @@
Consult the Zorba documentation for more information.
+ Some parts of Zorba require C++ 11 features. If the local C++
+ compiler does not offer this by default, you might have to add:
+
+ -D CMAKE_CXX_FLAGS=-std=c++11
+
+ to the cmake invokation. This is the case on MAC OS X with MacPorts.
+
+
Metaproxy can be installed as follows:
./configure
@@ -147,6 +159,80 @@
+
+ BIBFRAME
+
+ The MARC to BIBFRAME was the primary purpose of the XQuery
+ module for Metaproxy, but generally the module is a just an alternative
+ to record_transform filter of Metaproxy which primarily performs XSLT.
+
+
+ The bibframe directory of the source tar
+ contains sample file for performing MARC to BIBFRAME conversions.
+ Upon make install these are installed to directory
+ /usr/share/mp-xquery/bibframe and they are also
+ part of the package mp-xquery.
+
+
+ config.xml is a complete Metaproxy configuration file.
+ It includes a standalone configuration that makes Metaproxy offe
+ Z39.50 and SRU support on port 9070. The modules in use are http_file
+ (to serve XSL files), sru_z3950 (SRU service), cql_rpn (CQL to RPN
+ conversion), xquery (to convert MARCXML to BIBFRAME), record_transform
+ (to convert MARC21 to MARCXML), virt_db (for database rewrite), log
+ (to perform backend logging) and, finally, z3950_client to interface
+ a Z39.50 target.
+
+
+ It is important that the XQuery module comes before the
+ "record_transform" so that the XQuery module sees XML
+ only and not ISO2709-records.
+ If it does, they will be ignored (passed through) by the XQuery module.
+
+
+ The XQuery module script name points to the full path of
+ zorba3-0.xqy part
+ of marc2bibframe . Do not move zorba3-0.xqy
+ from its place within the
+ marc2bibframe directory as other files are referred to and their relative
+ location must be preserved.
+
+
+ File cql2pqf.txt contains a simple DC/CQL profile
+ for driving a CQL to RPN conversion.
+ It is referred to from the cql_rpn filter in config.xml .
+
+
+ File explain.xml is SRU explain configuration.
+ It is referred to from the sru_z3950 filter in config.xml .
+
+
+ Directory xsl/.. is client side XSL for brief -
+ and full display. These must be located so that the http_file filter
+ can fetch them. For example, if these files are located in
+ /usr/share/mp-xquery/bibframe/xsl , then
+ http_file would hold
+
+
+ /usr/share/mp-xquery/bibframe/xsl
+
+ true
+
+
+]]>
+
+
+
+
+ Do not modify the files below /usr/share/mp-xquery.
+ They will be overwritten by a package update and if
+ make install is executed.
+ Use them if they can be used as-is but copy them away if you want to
+ modify them (such as config.xml).
+
+
+
Reference