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"
5 <!ENTITY % local SYSTEM "local.ent">
7 <!ENTITY % entities SYSTEM "entities.ent">
9 <!ENTITY % common SYSTEM "common/common.ent">
12 <!-- $Id: book.xml,v 1.4 2007-01-13 05:48:41 quinn Exp $ -->
15 <title>Pazpar2 - User's Guide and Reference</title>
17 <firstname>Sebastian</firstname><surname>Hammer</surname>
20 <year>©right-year;</year>
21 <holder>Index Data</holder>
25 Pazpar2 - High-performance, user-interface independent, metasearching
26 middleware featuring record merging, relevance ranking, and faceted search
30 This document is a guide and reference to Pazpar version &version;.
35 <imagedata fileref="common/id.png" format="PNG"/>
38 <imagedata fileref="common/id.eps" format="EPS"/>
45 <chapter id="introduction">
46 <title>Introduction</title>
48 Pazpar2 is a stand-alone package which implements
49 the best we know to do in terms of the core metasearching
50 functionality; that is, searching a number of databases in parallel,
51 merging, and analyzing the results. Additional functionality such as
52 user management, attractive displays are expected to be implemented by
53 applications that use pazpar2. Pazpar2 is user interface independent.
54 Its functionality is exposed through a simple REST-style webservice API,
55 designed to be simple to use from an Ajax-anbled browser, from a
56 higher-level server-side language like PHP or Java, or even from a Flash
60 Once you launch a search in pazpar2, the operation continues behind the
61 scenes. Pazpar2 connects to servers, carries out searches, and
62 retrieves, deduplicates, and stores results internally. Your application
63 code may periodically inquire about the status of an ongoing operation,
64 and ask to see records or other result set facets.
67 Pazpar2 is designed to be highly configurable. Incoming records are
68 normalized to XML/UTF-8, and then further normalized using XSLT to a
69 simple internal representation that is suitable for analysis. By
70 providing XSLT stylesheets for different kinds of result records, you
71 can tune pazpar2 to work against different kinds of information
72 retrieval servers. Finally, metadata is extracted, in a configurable
73 way, from this internal record, to support display, merging, ranking,
74 result set facets, and sorting. Pazpar2 is not bound to a specific model
75 of metadata, such as DublinCore or MARC -- by providing the right
76 configuration, it can work with a number of different kinds of data in
77 support of many different applications.
80 Pazpar2 is designed to be efficient and scalable. You can set it up to
81 search several hundred targets in parallel, or you can use it to support
82 hundreds of concurrent users. It is implemented with the same attention
83 to performance and economy that we use in our indexing engines, so that
84 you can focus on building your application. You can devote all of your
85 attention to usability and let pazpar2 do what it does best -- search.
89 <chapter id="license">
90 <title>Pazpar2 License</title>
91 <para>To be decided and written.</para>
94 <chapter id="installation">
95 <title>Installation</title>
97 Pazpar2 depends on the following tools/libraries:
99 <varlistentry><term><ulink url="&url.yaz;">YAZ</ulink></term>
102 The popular Z39.50 toolkit for the C language. YAZ must be
103 compiled with Libxml2/Libxslt support.
110 In order to compile Pazpar2 an ANSI C compiler is
111 required. The requirements should be the same as for YAZ.
114 <section id="installation.unix">
115 <title>Installation on Unix (from Source)</title>
117 Here is a quick step-by-step guide on how to compile the
118 tools that Pazpar2 uses. Only few systems have none of the required
119 tools binary packages. If, for example, Libxml2/libxslt are already
120 installed as development packages use these.
124 Ensure that the development libraries + header files are
125 available on your system before compiling Pazpar2. For installation
126 of YAZ, refer to the YAZ installation chapter.
129 gunzip -c pazpar2-version.tar.gz|tar xf -
138 <section id="installation.debian">
139 <title>Installation on Debian GNU/Linux</title>
141 All dependencies for Pazpar2 are available as
142 <ulink url="&url.debian;">Debian</ulink>
143 packages for the sarge (stable in 2005) and etch (testing in 2005)
147 The procedures for Debian based systems, such as
148 <ulink url="&url.ubuntu;">Ubuntu</ulink> is probably similar
151 apt-get install libyaz-dev
154 With these packages installed, the usual configure + make
155 procedure can be used for Pazpar2 as outlined in
156 <xref linkend="installation.unix"/>.
161 <reference id="reference">
162 <title>Reference</title>
165 The material in this chapter is drawn directly from the individual
173 <!-- Keep this comment at the end of the file
178 sgml-minimize-attributes:nil
179 sgml-always-quote-attributes:t
182 sgml-parent-document: nil
183 sgml-local-catalogs: nil
184 sgml-namecase-general:t