Doc: update information about ID packages for Pazpar2

[pazpar2-moved-to-github.git] / doc / book.xml

diff --git a/doc/book.xml b/doc/book.xml
index 9df32a5..4a460b5 100644 (file)
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -79,8 +79,9 @@
     -- <ulink url="&url.xslt;">XSLT</ulink> is used to normalize and extract
     data from retrieval records for display and analysis. It can be used
     against any server which supports the
-    <ulink url="&url.z39.50;">Z39.50</ulink>, <ulink url="&url.sru;">SRU/SRW</ulink>
-    or <ulink url="&url.solr;">SOLR</ulink> protocol. Proprietary
+    <ulink url="&url.z39.50;">Z39.50</ulink>,
+    <ulink url="&url.sru;">SRU/SRW</ulink>
+    or <ulink url="&url.solr;">Solr</ulink> 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 @@
     <listitem>
      <para>
       The popular Z39.50 toolkit for the C language.
-      YAZ <emphasis>must</emphasis> be compiled with Libxml2/Libxslt support.
-     </para>
-    </listitem>
-    </varlistentry>
-    <varlistentry><term><ulink url="&url.icu;">International
-    Components for Unicode (ICU)</ulink></term>
-    <listitem>
-     <para>
-      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 <emphasis>must</emphasis> be compiled with
+      <ulink url="&url.libxml2;">Libxml2</ulink>/<ulink url="&url.libxslt;">Libxslt</ulink> support.
      </para>
      <para>
-      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
+      <ulink url="&url.icu;">ICU</ulink> support.
      </para>
     </listitem>
     </varlistentry>
@@ -406,13 +394,20 @@
   <section id="installation.debian">
    <title>Installation on Debian GNU/Linux and Ubuntu</title>
    <para>
-    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
-    <ulink url="&url.pazpar2.download.debian;"/> and
-    <ulink url="&url.pazpar2.download.ubuntu;"/>.
+    Index Data provides Debian and Ubuntu packages for Pazpar2 and YAZ.
+    Refer to these directories:
+    <ulink url="&url.pazpar2.download;debian/"/> and
+    <ulink url="&url.pazpar2.download;ubuntu/"/>.
+   </para>
+  </section>
+
+  <section id="installation.centos">
+   <title>Installation on RedHat / CentOS</title>
+   <para>
+    Index Data provides CentOS packages for Pazpar2 and YAZ.
+    Refer to
+    <ulink url="&url.pazpar2.download;redhat/centos"/> for
+    CentOS packages.
    </para>
   </section>
 
@@ -585,18 +580,17 @@
     The intermediate, internal representation of the record looks like
     this:
     <screen><![CDATA[
-     <record   xmlns="http://www.indexdata.com/pazpar2/1.0"
-     mergekey="title The Shining author King, Stephen">
-
-     <metadata type="title" rank="2">The Shining</metadata>
+     <record xmlns="http://www.indexdata.com/pazpar2/1.0"
+       mergekey="title The Shining author King, Stephen">
 
-     <metadata type="author">King, Stephen</metadata>
+       <metadata type="title" rank="2">The Shining</metadata>
 
-     <metadata type="kind">ebook</metadata>
+       <metadata type="author">King, Stephen</metadata>
 
-     <!-- ... and so on -->
-    </record>
-     ]]></screen>
+       <metadata type="kind">ebook</metadata>
+       <!-- ... and so on -->
+     </record>
+]]></screen>
 
     As you can see, there isn't much to it. There are really only a few
     important elements to this file.
@@ -630,12 +624,13 @@
     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
-    pz:cluster wrapper element that holds individual pz:record elements.
+    <literal>cluster</literal> wrapper element that holds individual
+    <literal>record</literal> elements.
    </para>
    <para>
     Cluster record example:
     <screen><![CDATA[
-     <cluster  xmlns="http://www.indexdata.com/pazpar2/1.0">
+     <cluster xmlns="http://www.indexdata.com/pazpar2/1.0">
        <record>
          <metadata type="title" rank="2">The Shining</metadata>
         <metadata type="author">King, Stephen</metadata>
@@ -646,8 +641,7 @@
         <metadata type="author">King, Stephen</metadata>
         <metadata type="kind">audio</metadata>
        </record>
-       <!-- ... and so on -->
-    </record>
+    </cluster>
      ]]></screen>
    </para>
   </section>
@@ -698,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
     <xref linkend="installation"/> for details.
    </para>
    <para>
@@ -859,6 +853,14 @@
           tf[i] = tf[i] / cluster_size;
        relevance += 100000 * tf[i] / idf[i];
        ]]></screen>
+   <para>
+    For controlling the ranking parameters, refer to the
+    <link linkend="service-rank">rank</link> element of the 
+    service definition.
+    Refer to the <link linkend="metadata-rank">rank</link> attribute
+    of the metadata element for how to control ranking for individual
+    metadata fields.
+   </para>
   </section> <!-- relevance_ranking -->
 
   <section id="masterkey_connect">