X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=doc%2Fbook.xml;h=656af8a3ef1a77b0884dd08665dd162062e5594d;hb=cea5d06318c86c9652cad5c4fefa39fa2e9745ac;hp=e71bc694eeef77de366ae069093a468a83ffeac7;hpb=14074ecf20d86518ccedc0c9617a49949ec19779;p=pazpar2-moved-to-github.git
diff --git a/doc/book.xml b/doc/book.xml
index e71bc69..656af8a 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -79,8 +79,9 @@
-- 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
- or SOLR protocol. Proprietary
+ 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
support a large number of other protocols.
@@ -205,25 +206,12 @@
The popular Z39.50 toolkit for the C language.
- YAZ must be compiled with Libxml2/Libxslt support.
-
-
-
- International
- Components for Unicode (ICU)
-
-
- ICU provides Unicode support for non-English languages with
- character sets outside the range of 7bit ASCII, like
- 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.
+ YAZ must be compiled with
+ Libxml2/Libxslt support.
- Compiling, linking, and usage of the ICU libraries is optional,
- but strongly recommended for usage in an international
- environment.
+ It is highly recommended that YAZ is also compiled with
+ ICU support.
@@ -293,7 +281,7 @@
The compilation is tuned by editing the makefile of Pazpar2.
The process is similar to YAZ. Adjust the various directories
- YAZ_DIR, ZLIB_DIR, etc.,
+ YAZ_DIR, ICU_DIR, etc.,
as required.
@@ -406,13 +394,20 @@
Installation on Debian GNU/Linux and Ubuntu
- 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
- .
+ Index Data provides Debian and Ubuntu packages for Pazpar2 and YAZ.
+ Refer to these directories:
+ and
+ .
+
+
+
+
+ Installation on RedHat / CentOS
+
+ Index Data provides CentOS packages for Pazpar2 and YAZ.
+ Refer to
+ for
+ CentOS packages.
@@ -585,18 +580,17 @@
The intermediate, internal representation of the record looks like
this:
-
- The Shining
+
- King, Stephen
+ The Shining
- ebook
+ King, Stephen
-
-
- ]]>
+ ebook
+
+
+]]>
As you can see, there isn't much to it. There are really only a few
important elements to this file.
@@ -625,6 +619,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
+
+
+ ]]>
+
@@ -651,7 +670,7 @@
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.
@@ -673,7 +692,7 @@
While noise from misbehaving targets can not be removed, it can
be reduced using truly Unicode based ranking. This is an
option which is available to the system administrator if ICU
- support is compiled into Pazpar2, see
+ support is compiled into YAZ, see
for details.
@@ -834,6 +853,14 @@
tf[i] = tf[i] / cluster_size;
relevance += 100000 * tf[i] / idf[i];
]]>
+
+ 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.
+