<author>
<firstname>Jakub</firstname><surname>Skoczen</surname>
</author>
+ <author>
+ <firstname>Mike</firstname><surname>Taylor</surname>
+ </author>
<releaseinfo>&version;</releaseinfo>
<copyright>
<year>©right-year;</year>
merging, relevance ranking, record sorting,
and faceted results.
It is middleware: it has no user interface of its own, but can be
- configured and controlled by a REST-like web-service to provide
+ configured and controlled by an XML-over-HTTP web-service to provide
metasearching functionality behind any user interface.
</simpara>
<simpara>
<chapter id="introduction">
<title>Introduction</title>
+
+ <section id="what.pazpar2.is">
+ <title>What Pazpar2 is</title>
<para>
Pazpar2 is a stand-alone metasearch engine with a web-service API, designed
to be used either from a browser-based client (JavaScript, Flash,
Additional functionality such as
user management and attractive displays are expected to be implemented by
applications that use Pazpar2. Pazpar2 itself is user-interface independent.
- Its functionality is exposed through a simple REST-style web-service API,
- designed to be easy to use from an AJAX-enabled browser, Flash
+ Its functionality is exposed through a simple XML-based web-service API,
+ designed to be easy to use from an Ajax-enabled browser, Flash
animation, Java applet, etc., or from a higher-level server-side language
like PHP, Perl or Java. Because session information can be shared between
browser-based logic and server-side scripting, there is tremendous
usability and let Pazpar2 do what it does best -- metasearch.
</para>
<para>
- If you wish to connect to commercial or other databases which do not
- support open standards, please contact Index Data on
- <email>info@indexdata.com</email>. We have a
- proprietary framework for building connectors that enable Pazpar2
- to access
- thousands of online databases, in addition to the vast number of catalogs
- and online services that support the Z39.50/SRU/SRW protocols.
- </para>
- <para>
Pazpar2 is our attempt to re-think the traditional paradigms for
implementing and deploying metasearch logic, with an uncompromising
approach to performance, and attempting to make maximum use of the
Pazpar2 is covered by the GNU General Public License (GPL) version 2.
See <xref linkend="license"/> for further information.
</para>
+ </section>
+
+ <section id="connectors">
+ <title>Connectors to non-standard databases</title>
+ <para>
+ If you wish to connect to commercial or other databases which do not
+ support open standards, please contact Index Data on
+ <email>info@indexdata.com</email>. We have a
+ proprietary framework for building connectors that enable Pazpar2
+ to access
+ thousands of online databases, in addition to the vast number of catalogs
+ and online services that support the Z39.50/SRU/SRW protocols.
+ </para>
+ </section>
<section id="name">
<title>A note on the name Pazpar2</title>
<chapter id="installation">
<title>Installation</title>
<para>
- The Pazpar2 package is very small. It includes documentation as well
+ The Pazpar2 package includes documentation as well
as the Pazpar2 server. The package also includes a simple user
- interface test1 which consists of a single HTML page and a single
+ interface called "test1", which consists of a single HTML page and a single
JavaScript file to illustrate the use of Pazpar2.
</para>
<para>
</para>
<section id="installation.unix">
- <title>Installation on Unix (from Source)</title>
+ <title>Installation from source on Unix (including Linux, MacOS, etc.)</title>
<para>
The latest source code for Pazpar2 is available from
<ulink url="&url.pazpar2.download;"/>.
- Only few systems have none of the required
- tools binary packages.
- If, for example, Libxml2/libXSLT libraries
- are already installed as development packages use these.
+ Most Unix-based operating systems have the required
+ tools available as binary packages.
+ For example, if Libxml2/libXSLT libraries
+ are already installed as development packages, use these.
</para>
<para>
- Ensure that the development libraries + header files are
+ Ensure that the development libraries and header files are
available on your system before compiling Pazpar2. For installation
- of YAZ, refer to the YAZ installation chapter.
+ of YAZ, refer to the Installation chapter of the YAZ manual at
+ <ulink url="&url.yaz.install;"/>.
+ </para>
+ <para>
+ Once the dependencies are in place, Pazpar2 can be unpacked and
+ installed as follows:
</para>
<screen>
- gunzip -c pazpar2-version.tar.gz|tar xf -
- cd pazpar2-version
+ tar xzf pazpar2-VERSION.tar.gz
+ cd pazpar2-VERSION
./configure
make
- su
- make install
+ sudo make install
</screen>
<para>
The <literal>make install</literal> will install manpages as well as the
</section>
<section id="installation.win32">
- <title>Installation on Windows (from Source)</title>
+ <title>Installation from source on Windows</title>
<para>
Pazpar2 can be built for Windows using
<ulink url="&url.vstudio;">Microsoft Visual Studio</ulink>.
processed by the NMAKE utility part of Visual Studio.
</para>
<para>
- Ensure that the development libraries + header files are
+ Ensure that the development libraries and header files are
available on your system before compiling Pazpar2. For installation
- of YAZ, refer to the YAZ installation chapter.
+ of YAZ, refer to
+ the Installation chapter of the YAZ manual at
+ <ulink url="&url.yaz.install;"/>.
It is easiest if YAZ and Pazpar2 are unpacked in the same
directory (side-by-side).
</para>
<para>
The compilation is tuned by editing the makefile of Pazpar2.
The process is similar to YAZ. Adjust the various directories
- <literal>YAZ_DIR</literal>, <literal>ZLIB_DIR</literal>, ..
+ <literal>YAZ_DIR</literal>, <literal>ZLIB_DIR</literal>, etc.,
+ as required.
</para>
<para>
Compile Pazpar2 by invoking <application>nmake</application> in
possible to combine Pazpar2 either with your server-side dynamic
website scripting, with scripting or code running in the browser, or
with any combination of the two. Pazpar2 is an excellent tool for
- building advanced, AJAX-based user interfaces for metasearch
+ building advanced, Ajax-based user interfaces for metasearch
functionality, but it isn't a requirement -- you can choose to use
Pazpar2 entirely as a backend to your regular server-side scripting.
When you do use Pazpar2 in conjunction
- with browser scripting (JavaScript/AJAX, Flash, applets,
+ with browser scripting (JavaScript/Ajax, Flash, applets,
etc.), there are special considerations.
</para>
<para>
You can use Pazpar2 from any environment that allows you to use
webservices. The initial goal of the software was to support
- AJAX-based applications, but there literally are no limits to what
+ Ajax-based applications, but there literally are no limits to what
you can do. You can use Pazpar2 from Javascript, Flash, Java, etc.,
on the browser side, and from any development environment on the
server side, and you can pass session tokens and record IDs freely
projects / pazpar2-moved-to-github.git / blobdiff