1 <?xml version="1.0" standalone="no"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
5 <!ENTITY % local SYSTEM "local.ent">
7 <!ENTITY manref SYSTEM "manref.xml">
8 <!ENTITY gpl2 SYSTEM "gpl-2.0.xml">
9 <!ENTITY % idcommon SYSTEM "common/common.ent">
14 <title>MP-XQuery - User's Guide and Reference</title>
17 <firstname>Adam</firstname><surname>Dickmeiss</surname>
20 <releaseinfo>&version;</releaseinfo>
22 <year>2014-2015</year>
23 <holder>Index Data</holder>
27 This manual is part of MP-XQuery version &version;.
30 MP-XQuery is a Metaproxy module that allows record conversion
31 using W3C's XQuery language.
34 MP-XQuery is covered by the GNU General Public License version 2.
39 <imagedata fileref="common/id.png" format="PNG"/>
42 <imagedata fileref="common/id.eps" format="EPS"/>
48 <chapter id="introduction">
49 <title>Introduction</title>
51 MP-XQuery is a <ulink url="&url.metaproxy;">Metaproxy</ulink> module
52 that allows record conversion using
53 <ulink url="http://www.w3.org/TR/xquery/">W3C XML XQuery</ulink>.
54 The initial motivations for the module was to be able to
55 BIBFRAME records via SRU/Z39.50. By using the
57 url="https://github.com/lcnetdev/marc2bibframe">
59 </ulink> utilities, this module can convert existing
60 MARCXML records to BIBFRAME records - on the fly - as part of retrieval.
63 <chapter id="installation">
64 <title>Installation</title>
66 MP-XQuery is available as packages for CentOS/RHEL 6 and most recent
67 Ubuntu/Debian versions. For other systems, the module must be build
70 <sect1 id="installation.packages">
71 <title>Installing packages</title>
73 You need to enable the relevant software repositories.
74 For setting up refer to one of:
76 url="http://ftp.indexdata.dk/pub/mp-xquery/redhat/centos/6/README">CentOS 6</ulink>
79 url="http://ftp.indexdata.dk/pub/mp-xquery/ubuntu/README">Ubuntu</ulink>
82 url="http://ftp.indexdata.dk/pub/mp-xquery/debian/README">Debian</ulink>
85 The package is called <literal>mp-sparql</literal> on RHEL/Debian systems.
86 Install that package and you are ready to use filter "xquery" in your
90 <sect1 id="installation.source">
91 <title>Installing from source</title>
93 To build from source, you need zorba and metaproxy development
94 packages. Zorba might be installed in <filename>/opt/zorba</filename>
97 tar zxf zorba-3.0.tar.gz
102 -D CMAKE_INSTALL_PREFIX=/opt/zorba \
103 -D ZORBA_SUPPRESS_SWIG:BOOL=ON \
107 Consult the Zorba documentation for more information.
110 Metaproxy can be installed as follows:
116 But consult the Metaproxy documentation for requirements and
120 We are now ready to build the MP-XQuery module with:
123 make ZORBA=/opt/zorba MP_CONFIG=/usr/local/bin/mp-config
125 Adjust <literal>ZORBA</literal> and <literal>MP_CONFIG</literal> values
126 above for the correct location of installed
127 Zorba and Metaproxy's mp-config respectively. MP_CONFIG can be omitted
128 if Metaproxy was installed in the system PATH.
131 You can now install the <filename>metaproxy_filter_xquery.so</filename>
132 in a directory searched by Metaproxy daemon.
133 Specifically, that's the directories
134 given by the <literal>dlpath</literal> configuration.
137 If dlpath includes <filename>/usr/lib/metaproxy6/modules</filename>,
138 the module can be installed with:
140 cp src/metaproxy_filter_xquery.so /usr/lib/metaproxy6/modules
145 <reference id="reference">
146 <title>Reference</title>
147 <partintro id="reference-introduction">
149 The material in this chapter is drawn directly from the individual
156 <appendix id="license">
157 <title>License</title>
159 Copyright (C) 2014-2015 Index Data
163 Metaproxy is free software; you can redistribute it and/or modify it under
164 the terms of the GNU General Public License as published by the Free
165 Software Foundation; either version 2, or (at your option) any later
170 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
171 WARRANTY; without even the implied warranty of MERCHANTABILITY or
172 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
177 You should have received a copy of the GNU General Public License
178 along with Metaproxy; see the file LICENSE. If not, write to the
179 Free Software Foundation,
180 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
188 <!-- Keep this comment at the end of the file