doc/book.xml

   1 <?xml version="1.0" standalone="no"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
   3     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   4 [
   5      <!ENTITY % local SYSTEM "local.ent">
   6      %local;
   7      <!ENTITY % entities SYSTEM "entities.ent">
   8      %entities;
   9      <!ENTITY % common SYSTEM "common/common.ent">
  10      %common;
  11 ]>
  12 <!-- $Id: book.xml,v 1.3 2007-01-12 15:31:30 adam Exp $ -->
  13 <book id="book">
  14  <bookinfo>
  15   <title>Pazpar2 - User's Guide and Reference</title>
  16   <author>
  17    <firstname>Sebastian</firstname><surname>Hammer</surname>
  18   </author>
  19   <copyright>
  20    <year>&copyright-year;</year>
  21    <holder>Index Data</holder>
  22   </copyright>
  23   <abstract>
  24    <simpara>
  25     Pazpar2 - High-performance, user-interface
  26     user-interface independtent metasearching middleware.
  27    </simpara>
  28    <simpara>
  29     This document is a guide and reference to Pazpar version &version;.
  30    </simpara>
  31    <simpara>
  32     <inlinemediaobject>
  33      <imageobject>
  34       <imagedata fileref="common/id.png" format="PNG"/>
  35      </imageobject>
  36      <imageobject>
  37       <imagedata fileref="common/id.eps" format="EPS"/>
  38      </imageobject>
  39     </inlinemediaobject>
  40    </simpara>
  41   </abstract>
  42  </bookinfo>
  43
  44  <chapter id="introduction">
  45   <title>Introduction</title>
  46
  47   <para>
  48    <ulink url="&url.pazpar2;">Pazpar2</ulink> is.. To be written.
  49   </para>
  50  </chapter>
  51
  52  <chapter id="license">
  53   <title>Pazpar2 License</title>
  54   <para>To be decided and written.</para>
  55  </chapter>
  56
  57  <chapter id="installation">
  58   <title>Installation</title>
  59   <para>
  60    Pazpar2 depends on the following tools/libraries:
  61    <variablelist>
  62     <varlistentry><term><ulink url="&url.yaz;">YAZ</ulink></term>
  63      <listitem>
  64       <para>
  65        The popular Z39.50 toolkit for the C language. YAZ must be
  66        compiled with Libxml2/Libxslt support.
  67       </para>
  68      </listitem>
  69     </varlistentry>
  70    </variablelist>
  71   </para>
  72   <para>
  73    In order to compile Pazpar2 an ANSI C compiler is
  74    required. The requirements should be the same as for YAZ.
  75   </para>
  76
  77   <section id="installation.unix">
  78    <title>Installation on Unix (from Source)</title>
  79    <para>
  80     Here is a quick step-by-step guide on how to compile the
  81     tools that Pazpar2 uses. Only few systems have none of the required
  82     tools binary packages. If, for example, Libxml2/libxslt are already
  83     installed as development packages use these.
  84    </para>
  85
  86    <para>
  87     Ensure that the development libraries + header files are
  88     available on your system before compiling Pazpar2. For installation
  89     of YAZ, refer to the YAZ installation chapter.
  90    </para>
  91    <screen>
  92     gunzip -c pazpar2-version.tar.gz|tar xf -
  93     cd pazpar2-version
  94     ./configure
  95     make
  96     su
  97     make install
  98    </screen>
  99   </section>
 100
 101   <section id="installation.debian">
 102    <title>Installation on Debian GNU/Linux</title>
 103    <para>
 104     All dependencies for Pazpar2 are available as
 105     <ulink url="&url.debian;">Debian</ulink>
 106     packages for the sarge (stable in 2005) and etch (testing in 2005)
 107     distributions.
 108    </para>
 109    <para>
 110     The procedures for Debian based systems, such as
 111     <ulink url="&url.ubuntu;">Ubuntu</ulink> is probably similar
 112    </para>
 113    <screen>
 114     apt-get install libyaz-dev
 115    </screen>
 116    <para>
 117     With these packages installed, the usual configure + make
 118     procedure can be used for Pazpar2 as outlined in
 119     <xref linkend="installation.unix"/>.
 120    </para>
 121   </section>
 122  </chapter>
 123
 124  <reference id="reference">
 125   <title>Reference</title>
 126   <partintro>
 127    <para>
 128     The material in this chapter is drawn directly from the individual
 129     manual entries.
 130    </para>
 131   </partintro>
 132   &manref;
 133  </reference>
 134 </book>
 135
 136  <!-- Keep this comment at the end of the file
 137  Local variables:
 138  mode: sgml
 139  sgml-omittag:t
 140  sgml-shorttag:t
 141  sgml-minimize-attributes:nil
 142  sgml-always-quote-attributes:t
 143  sgml-indent-step:1
 144  sgml-indent-data:t
 145  sgml-parent-document: nil
 146  sgml-local-catalogs: nil
 147  sgml-namecase-general:t
 148  End:
 149  -->