X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fbook.xml;h=ff1b58b5e3834a3b6d33c6480613f48999909036;hb=88f96194d5a63278eb57b32c814019dab51da9ff;hp=c39b44c7b184ad3a35e97e179547c014926d0f1f;hpb=42ba0835e366886165fb2bcf44d0f1e59b0005eb;p=pazpar2-moved-to-github.git diff --git a/doc/book.xml b/doc/book.xml index c39b44c..ff1b58b 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -24,6 +24,9 @@ JakubSkoczen + + MikeTaylor + &version; ©right-year; @@ -56,6 +59,9 @@ Introduction + +
+ What Pazpar2 is Pazpar2 is a stand-alone metasearch engine with a web-service API, designed to be used either from a browser-based client (JavaScript, Flash, @@ -121,15 +127,6 @@ usability and let Pazpar2 do what it does best -- metasearch. - If you wish to connect to commercial or other databases which do not - support open standards, please contact Index Data on - info@indexdata.com. 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. - - 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 @@ -151,6 +148,20 @@ Pazpar2 is covered by the GNU General Public License (GPL) version 2. See for further information. +
+ +
+ Connectors to non-standard databases + + If you wish to connect to commercial or other databases which do not + support open standards, please contact Index Data on + info@indexdata.com. 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. + +
A note on the name Pazpar2 @@ -170,9 +181,9 @@ Installation - 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. @@ -212,28 +223,32 @@
- Installation on Unix (from Source) + Installation from source on Unix (including Linux, MacOS, etc.) The latest source code for Pazpar2 is available from . - 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. - 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 + . + + + Once the dependencies are in place, Pazpar2 can be unpacked and + installed as follows: - 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 The make install will install manpages as well as the @@ -245,7 +260,7 @@
- Installation on Windows (from Source) + Installation from source on Windows Pazpar2 can be built for Windows using Microsoft Visual Studio. @@ -255,16 +270,19 @@ processed by the NMAKE utility part of Visual Studio. - 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 + . It is easiest if YAZ and Pazpar2 are unpacked in the same directory (side-by-side). The compilation is tuned by editing the makefile of Pazpar2. The process is similar to YAZ. Adjust the various directories - YAZ_DIR, ZLIB_DIR, .. + YAZ_DIR, ZLIB_DIR, etc., + as required. Compile Pazpar2 by invoking nmake in @@ -294,14 +312,15 @@
- Installation of test1 interface + Installation of test interfaces - In this section we outline how to install a simple interface that - is part of the Pazpar2 source package. Note that Debian users can - save time by just installing package pazpar2-test1. + In this section we show how to make available the set of simple + interfaces that are part of the Pazpar2 source package, and which + demonstrate some ways to use Pazpar2. (Note that Debian users can + save time by just installing the package pazpar2-test1.) - A web server must be installed and running on the system, such as Apache. + A web server, such as Apache, must be installed and running on the system. @@ -319,31 +338,51 @@ ..\bin\pazpar2 -f pazpar2.cfg This will start a Pazpar2 listener on port 9004. It will proxy - HTTP requests to localhost - port 80, which we assume will be the regular + HTTP requests to port 80 on localhost, which we assume will be the regular HTTP server on the system. Inspect and modify pazpar2.cfg as needed - if this is to be changed. The pazpar2.cfg includes settings from the + if this is to be changed. The pazpar2.cfg file includes settings from the file settings/edu.xml to use for searches. + - Make a new console and move to the other stuff. - For more information about pazpar2 options refer to the manpage. + The test UIs are located in www. Ensure that this + directory is available to the web server by copying + www to the document root, + using Apache's Alias directive, or + creating a symbolic link: for example, on a Debian or Ubuntu + system with Apache2 installed from the standard package, you might + make the link as follows: + + cd .../pazpar2 + sudo ln -s `pwd`/www /var/www/pazpar2-demo + - + - The test1 UI is located in www/test1. Ensure this - directory is available to the web server by either copying - test1 to the document root, create a symlink or - use Apache's Alias directive. + This makes the test applications visible at + + but they can not be run successfully from that URL, as they submit + search requests back to the server form which they were served, + and Apache2 doesn't know how to handle them. Instead, the test + applications must be accessed from Pazpar2 itself, acting as a + proxy to Apache2, at the URL + - The interface test1 interface should now be available on port 8004. + From here, the demo applications can be + accessed: test1, test2 and + jsdemo + are pure HTML+JavaScript setups, needing no server-side + intelligence; + demo + requires PHP on the server. - If you don't see the test1 interface. See if test1 is really available - on the same URL but on port 80. If it's not, the Apache configuration - (or other) is not correct. + If you don't see the test interfaces, check whether they are available + on port 80 (i.e. directly from the Apache2 server). If not, the + Apache configuration is incorrect. In order to use Apache as frontend for the interface on port 80 @@ -353,12 +392,15 @@
- Installation on Debian GNU/Linux + Installation on Debian or Ubuntu GNU/Linux - Index Data provides Debian packages for Pazpar2. These are prepared - for Debian versions Etch and Lenny (as of 2007). - These packages are available at - . + Index Data provides Debian and Ubuntu packages for Pazpar2. + As of February 2010, these + are prepared for Debian versions Etch, Lenny and Squeeze; and for + Ubuntu versions 8.04 (hardy), 8.10 (intrepid), 9.04 (jaunty) and + 9.10 (karmic). These packages are available at + and + .
@@ -377,7 +419,7 @@ On a Debian based Apache 2 system, the relevant modules can be enabled with: - sudo a2enmod proxy_http + sudo a2enmod proxy_http proxy_balancer