X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fbook.xml;h=58e9ca6da36de1707880354a304f71bcf3972bb1;hb=c7f4f3051cc7215e8513a7ddeb765d7db64c8f11;hp=ef73ac9d160465b11e78cdb839d8265861e0c5e3;hpb=7a411fea2da77ae3b808a4c55deebdcf8e5dc857;p=pazpar2-moved-to-github.git diff --git a/doc/book.xml b/doc/book.xml index ef73ac9..58e9ca6 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -1,6 +1,6 @@ %local; @@ -59,10 +59,10 @@ - + Introduction - +
What Pazpar2 is @@ -78,8 +78,8 @@ other XML-structured response format -- XSLT is used to normalize and extract data from retrieval records for display and analysis. It can be used - against any server which supports the - Z39.50, SRU/SRW + against any server which supports the + Z39.50, SRU/SRW or SOLR protocol. Proprietary backend modules can function as connectors between these standard protocols and any non-standard API, including web-site scraping, to @@ -158,9 +158,9 @@ If you need to access commercial or open access resources that don't support Z39.50 or SRU, one approach would be to use a tool like SimpleServer to build a + url="&url.simpleserver;">SimpleServer to build a gateway. An easier option is to use Index Data's MasterKey Connect + url="&url.mkc;">MasterKey Connect service, which will expose virtually any resource through Z39.50/SRU, dead easy to integrate with Pazpar2. The service is hosted, so all you have to do is to let us @@ -218,12 +218,12 @@ Greek, Russian, German and French. Pazpar2 uses the ICU Unicode character conversions, Unicode normalization, case folding and other fundamental operations needed in - tokenization, normalization and ranking of records. + tokenization, normalization and ranking of records. Compiling, linking, and usage of the ICU libraries is optional, but strongly recommended for usage in an international - environment. + environment. @@ -244,7 +244,7 @@ For example, if Libxml2/libXSLT libraries are already installed as development packages, use these. - + Ensure that the development libraries and header files are available on your system before compiling Pazpar2. For installation @@ -264,13 +264,13 @@ The make install will install manpages as well as the - Pazpar2 server, pazpar2, + Pazpar2 server, pazpar2, in PREFIX/sbin. By default, PREFIX is /usr/local/ . This can be changed with configure option .
- +
Installation from source on Windows @@ -305,7 +305,7 @@ The Windows version of Pazpar2 is a console application. It may - be installed as a Windows Service by adding option + be installed as a Windows Service by adding option -install for the pazpar2 program. This will register Pazpar2 as a service and use the other options provided in the same invocation. For example: @@ -322,13 +322,13 @@
- +
Installation of test interfaces 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 + demonstrate some ways to use Pazpar2. (Note that Debian users can save time by just installing the package pazpar2-test1.) @@ -349,7 +349,7 @@ copy pazpar2.cfg.dist pazpar2.cfg ..\bin\pazpar2 -f pazpar2.cfg - This will start a Pazpar2 listener on port 9004. It will proxy + This will start a Pazpar2 listener on port 9004. It will proxy 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 file includes settings from the @@ -360,7 +360,7 @@ The test UIs are located in www. Ensure that this directory is available to the web server by copying - www to the document root, + 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 @@ -370,7 +370,7 @@ sudo ln -s `pwd`/www /var/www/pazpar2-demo - + This makes the test applications visible at @@ -387,7 +387,7 @@ accessed: test1, test2 and jsdemo are pure HTML+JavaScript setups, needing no server-side - intelligence; + intelligence; demo requires PHP on the server. @@ -398,7 +398,7 @@ In order to use Apache as frontend for the interface on port 80 - for public access etc., refer to + for public access etc., refer to .
@@ -415,11 +415,11 @@ . - +
Apache 2 Proxy - Apache 2 has a + Apache 2 has a proxy module @@ -428,7 +428,7 @@ based web service. The Apache 2 proxy must operate in the Reverse Proxy mode. - + On a Debian based Apache 2 system, the relevant modules can be enabled with: @@ -436,11 +436,11 @@ sudo a2enmod proxy_http proxy_balancer - + - Traditionally Pazpar2 interprets URL paths with suffix + Traditionally Pazpar2 interprets URL paths with suffix /search.pz2. - The + The ProxyPass @@ -468,13 +468,13 @@ ProxyRequests Off - + AddDefaultCharset off Order deny,allow Allow from all - + ProxyPass /myportal/search.pz2 http://localhost:8004/search.pz2 ProxyVia Off @@ -482,16 +482,16 @@
- + - + Using Pazpar2 This chapter provides a general introduction to the use and - deployment of Pazpar2. + deployment of Pazpar2. - +
Pazpar2 and your systems architecture @@ -522,7 +522,7 @@ with the server from which the enclosing HTML page or object originated, Pazpar2 is designed so that it can act as a transparent proxy in front of an existing webserver (see for details). + linkend="pazpar2_conf"/> for details). In this mode, all regular HTTP requests are transparently passed through to your webserver, while Pazpar2 only intercepts search-related webservice requests. @@ -585,23 +585,22 @@ The intermediate, internal representation of the record looks like this: + - The Shining + The Shining - King, Stephen + King, Stephen - ebook + ebook + + +]]> - - - ]]> - As you can see, there isn't much to it. There are really only a few important elements to this file. - + Elements should belong to the namespace http://www.indexdata.com/pazpar2/1.0. @@ -625,6 +624,31 @@ in the retrieval record ultimately drives merging, sorting, ranking, the extraction of browse facets, and display, all configurable. + + + Pazpar2 1.6.37 and later also allows already clustered records to + be ingested. Suppose a database already clusters for us and we would like + to keep that cluster for Pazpar2. In that case we can generate a + cluster wrapper element that holds individual + record elements. + + + Cluster record example: + + + The Shining + King, Stephen + ebook + + + The Shining + King, Stephen + audio + + + ]]> +
@@ -644,14 +668,14 @@ The webservice API of Pazpar2 is described in detail in . - + In brief, you use the 'init' command to create a session, a temporary workspace which carries information about the current search. You start a new search using the 'search' command. Once the search has been started, you can follow its progress using the 'stat', 'bytarget', 'termlist', or 'show' commands. Detailed records - can be fetched using the 'record' command. + can be fetched using the 'record' command.
@@ -678,7 +702,7 @@ In addition, the ICU tokenization and normalization rules must - be defined in the master configuration file described in + be defined in the master configuration file described in . @@ -698,7 +722,7 @@ module in your Apache2 installation. - + On a Debian based Apache 2 system, the relevant modules can be enabled with: @@ -729,7 +753,7 @@ could use the following Apache 2 configuration to expose a single pazpar2 'endpoint' on a standard (/pazpar2/search.pz2) location: - + AddDefaultCharset off @@ -746,12 +770,12 @@ BalancerMember http://localhost:8007 route=pz4 - # route is resent in the 'session' param which has the form: + # route is resent in the 'session' param which has the form: # 'sessid.serverid', understandable by the mod_proxy_load_balancer # this is not going to work if the client tampers with the 'session' param ProxyPass /pazpar2/search.pz2 balancer://pz2cluster lbmethod=byrequests stickysession=session nofailover=On ]]> - + The 'ProxyPass' line sets up a reverse proxy for request ‘/pazpar2/search.pz2’ and delegates all requests to the load balancer (virtual worker) with name ‘pz2cluster’. @@ -759,11 +783,11 @@ The ‘Proxy’ section lists all the servers (real workers) which the load balancer can use. - + - + - +
Relevance ranking @@ -792,7 +816,7 @@ fetched form the database. In this case, the rank weigth w, the and rank tweaks lead, follow and length. - + + + For controlling the ranking parameters, refer to the + rank element of the + service definition. + Refer to the rank attribute + of the metadata element for how to control ranking for individual + metadata fields. +
@@ -885,37 +917,37 @@ License - + Pazpar2, Copyright © ©right-year; Index Data. - + Pazpar2 is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. - + Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - + You should have received a copy of the GNU General Public License along with Pazpar2; see the file LICENSE. If not, write to the - Free Software Foundation, + Free Software Foundation, 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - + &gpl2; - +