doc/book.xml

   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"
   4 [
   5      <!ENTITY % local SYSTEM "local.ent">
   6      %local;
   7      <!ENTITY manref SYSTEM "manref.xml">
   8      <!ENTITY gpl2 SYSTEM "gpl-2.0.xml">
   9      <!ENTITY % idcommon SYSTEM "common/common.ent">
  10      %idcommon;
  11 ]>
  12 <book>
  13  <bookinfo>
  14   <title>MP-SPARQL - User's Guide and Reference</title>
  15   <authorgroup>
  16    <author>
  17     <firstname>Adam</firstname><surname>Dickmeiss</surname>
  18    </author>
  19    <author>
  20     <firstname>Heikki</firstname><surname>Levanto</surname>
  21    </author>
  22    <author>
  23     <firstname>Jakub</firstname><surname>Skoczen</surname>
  24    </author>
  25   </authorgroup>
  26   <releaseinfo>&version;</releaseinfo>
  27   <copyright>
  28    <year>2014-2015</year>
  29    <holder>Index Data</holder>
  30   </copyright>
  31   <abstract>
  32    <simpara>
  33     This manual is part of MP-SPARQL version &version;.
  34     </simpara>
  35    <simpara>
  36     MP-XQuery is a Metaproxy module that converts Type-1/RPN Queries
  37     to SPARQL.
  38    </simpara>
  39    <simpara>
  40     MP-SPARQL is covered by the GNU General Public License version 2.
  41    </simpara>
  42    <simpara>
  43     <inlinemediaobject>
  44      <imageobject>
  45       <imagedata fileref="common/id.png" format="PNG"/>
  46      </imageobject>
  47      <imageobject>
  48       <imagedata fileref="common/id.eps" format="EPS"/>
  49      </imageobject>
  50     </inlinemediaobject>
  51    </simpara>
  52   </abstract>
  53  </bookinfo>
  54  <chapter id="introduction">
  55   <title>Introduction</title>
  56   <para>
  57    MP-SPARQL is a <ulink url="&url.metaproxy;">Metaproxy</ulink> module
  58    that converts Type-1/RPN queries to <ulink url="http://www.w3.org/TR/rdf-sparql-query/">SPARQL</ulink>.
  59   </para>
  60  </chapter>
  61  <chapter id="installation">
  62   <title>Installation</title>
  63   <para>
  64    MP-SPARQL is available as packages for CentOS/RHEL 5+6 and most
  65    recent Ubuntu/Debian versions. For other systems, the module must be build
  66    from source.
  67   </para>
  68   <sect1 id="installation.packages">
  69    <title>Installing packages</title>
  70    <para>
  71     You need to enable the relevant software repositories.
  72     For setting up refer to one of:
  73     <ulink
  74         url="http://ftp.indexdata.dk/pub/mp-sparql/redhat/centos/5.5/README">CentOS 5</ulink>,
  75     <ulink
  76         url="http://ftp.indexdata.dk/pub/mp-sparql/redhat/centos/6/README">CentOS 6</ulink>
  77     ,
  78     <ulink
  79         url="http://ftp.indexdata.dk/pub/mp-sparql/ubuntu/README">Ubuntu</ulink>
  80     and
  81     <ulink
  82         url="http://ftp.indexdata.dk/pub/mp-sparql/debian/README">Debian</ulink>
  83    </para>
  84    <para>
  85     The package is called <literal>mp-sparql</literal> on RHEL/Debian systems.
  86     Install that package and you are ready to use filter "sparql" in your
  87     setup.
  88    </para>
  89    <para>
  90     mp-sparql depends on a number of packages created by Index Data and
  91     system-provided ones, such as Libxml2. For external software Zorba, no
  92     system package exist so Index Data has packaged that separately. This
  93     package is called <literal>idzorba</literal>. All these dependences should
  94     be automatically installed when the Index Data software repository is
  95     set up.
  96    </para>
  97   </sect1>
  98   <sect1 id="installation.source">
  99    <title>Installing from source</title>
 100    <para>
 101     To build from source, you need metaproxy development
 102     packages. Metaproxy can be installed as follows:
 103     <screen>
 104      ./configure
 105      make
 106      sudo make install
 107     </screen>
 108     Refer to the Metaproxy documentation for requirements and options.
 109    </para>
 110    <para>
 111     We are now ready to build the MP-SPARQL module with:
 112     <screen>
 113      cd mp-sparql-version
 114      make MP_CONFIG=/usr/local/bin/mp-config
 115     </screen>
 116     Adjust <literal>MP_CONFIG</literal> value
 117     above for the correct location of installed
 118     Metaproxy's mp-config. <literal>MP_CONFIG</literal> can be omitted
 119     if Metaproxy was installed in the system <filename>PATH</filename>.
 120    </para>
 121    <para>
 122     You can now install the <filename>metaproxy_filter_sparql.so</filename>
 123     in a directory searched by Metaproxy daemon.
 124     Specifically, that's the directories
 125     given by the <literal>dlpath</literal> configuration.
 126    </para>
 127    <para>
 128     If dlpath includes <filename>/usr/lib/metaproxy6/modules</filename>,
 129     the module can be installed with:
 130     <screen>
 131      cp src/metaproxy_filter_sparql.so /usr/lib/metaproxy6/modules
 132     </screen>
 133    </para>
 134    <note>
 135     <para>
 136      For RHEL/CentOS systems on 64-bit architectures, the correct paths is:
 137      <filename>/usr/lib64/metaproxy6/modules</filename>.
 138     </para>
 139    </note>
 140   </sect1>
 141  </chapter>
 142  <reference id="reference">
 143   <title>Reference</title>
 144    <partintro id="reference-introduction">
 145     <para>
 146      The material in this chapter is drawn directly from the individual
 147      manual entries.
 148     </para>
 149    </partintro>
 150    &manref;
 151  </reference>
 152
 153  <appendix id="license">
 154   <title>License</title>
 155   <para>
 156    Copyright (C) 2014-2015 Index Data
 157   </para>
 158
 159   <para>
 160    Metaproxy is free software; you can redistribute it and/or modify it under
 161    the terms of the GNU General Public License as published by the Free
 162    Software Foundation; either version 2, or (at your option) any later
 163    version.
 164    </para>
 165
 166   <para>
 167    Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
 168    WARRANTY; without even the implied warranty of MERCHANTABILITY or
 169    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 170    for more details.
 171   </para>
 172
 173   <para>
 174    You should have received a copy of the GNU General Public License
 175    along with Metaproxy; see the file LICENSE.  If not, write to the
 176    Free Software Foundation,
 177    51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 178    </para>
 179
 180  </appendix>
 181
 182  &gpl2;
 183 </book>
 184
 185 <!-- Keep this comment at the end of the file
 186 Local variables:
 187 mode: nxml
 188 nxml-child-indent: 1
 189 End:
 190 -->