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   </sect1>
  90   <sect1 id="installation.source">
  91    <title>Installing from source</title>
  92    <para>
  93     To build from source, you need metaproxy development
  94     packages. Metaproxy can be installed as follows:
  95     <screen>
  96      ./configure
  97      make
  98      sudo make install
  99     </screen>
 100     But consult the Metaproxy documentation for requirements and
 101     options.
 102    </para>
 103    <para>
 104     We are now ready to build the MP-SPARQL module with:
 105     <screen>
 106      cd mp-sparql-version
 107      make MP_CONFIG=/usr/local/bin/mp-config
 108     </screen>
 109     Adjust <literal>MP_CONFIG</literal> value
 110     above for the correct location of installed
 111     Metaproxy's mp-config. <literal>MP_CONFIG</literal> can be omitted
 112     if Metaproxy was installed in the system <filename>PATH</filename>.
 113    </para>
 114    <para>
 115     You can now install the <filename>metaproxy_filter_sparql.so</filename>
 116     in a directory searched by Metaproxy daemon.
 117     Specifically, that's the directories
 118     given by the <literal>dlpath</literal> configuration.
 119    </para>
 120    <para>
 121     If dlpath includes <filename>/usr/lib/metaproxy6/modules</filename>,
 122     the module can be installed with:
 123     <screen>
 124      cp src/metaproxy_filter_sparql.so /usr/lib/metaproxy6/modules
 125     </screen>
 126    </para>
 127    <note>
 128     <para>
 129      For RHEL/CentOS systems on 64-bit architectures, the correct paths is:
 130      <filename>/usr/lib64/metaproxy6/modules</filename>.
 131     </para>
 132    </note>
 133   </sect1>
 134  </chapter>
 135  <reference id="reference">
 136   <title>Reference</title>
 137    <partintro id="reference-introduction">
 138     <para>
 139      The material in this chapter is drawn directly from the individual
 140      manual entries.
 141     </para>
 142    </partintro>
 143    &manref;
 144  </reference>
 145
 146  <appendix id="license">
 147   <title>License</title>
 148   <para>
 149    Copyright (C) 2014-2015 Index Data
 150   </para>
 151
 152   <para>
 153    Metaproxy is free software; you can redistribute it and/or modify it under
 154    the terms of the GNU General Public License as published by the Free
 155    Software Foundation; either version 2, or (at your option) any later
 156    version.
 157    </para>
 158
 159   <para>
 160    Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
 161    WARRANTY; without even the implied warranty of MERCHANTABILITY or
 162    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 163    for more details.
 164   </para>
 165
 166   <para>
 167    You should have received a copy of the GNU General Public License
 168    along with Metaproxy; see the file LICENSE.  If not, write to the
 169    Free Software Foundation,
 170    51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 171    </para>
 172
 173  </appendix>
 174
 175  &gpl2;
 176 </book>
 177
 178 <!-- Keep this comment at the end of the file
 179 Local variables:
 180 mode: nxml
 181 nxml-child-indent: 1
 182 End:
 183 -->