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