X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=c90c9319eafee4f8c727e7d03aaccaaeac0b8c56;hb=24ad8ea356d71c764af19897e2719670a94a3a05;hp=c6325f4efd578d9e5afa41d7fbbf0777a556a8e9;hpb=5a565a0b2437c614c026aba968d4024a0a06ea08;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index c6325f4..c90c931 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -73,6 +73,25 @@
     in main thread).
    </para>
   </refsect2>
+  <refsect2 id="config-sockets">
+   <title>sockets</title>
+   <para>
+    This section is optional and is supported for Pazpar2 version 1.13.0 and
+    later . It is identified by element "<literal>sockets</literal>" which
+    may include one attribute "<literal>max</literal>" which specifies
+    the maximum number of sockets to be used by Pazpar2.
+   </para>
+  </refsect2>
+  <refsect2 id="config-file">
+   <title>file</title>
+   <para>
+    This configuration takes one attribute <literal>path</literal> which
+    specifies a path to search for local files, such as XSLTs  and settings.
+    The path is a colon separated list of directories. Its default value
+    is "<literal>.</literal>" which is equivalent to the location of the
+    main configuration file (where indeed the file element is given).
+   </para>
+  </refsect2>
   <refsect2 id="config-server">
    <title>server</title>
    <para>
@@ -252,6 +271,11 @@
 	     articles), and 'no' (no sorting). The default value is
 	     'no'.
 	    </para>
+	    <para>
+	     When 'skiparticle' is used, some common articles from the
+	     English and German languages are ignored. At present the
+	     list is: 'the', 'den', 'der', 'die', 'des', 'an', 'a'.
+	    </para>
 	   </listitem>
 	  </varlistentry>
 
@@ -406,6 +430,29 @@
 	  </varlistentry>
 
 	  <varlistentry>
+	   <term id="icurule">icurule</term>
+	   <listitem>
+	    <para>
+	     Specifies the ICU rule set to be used for normalizing
+	     metadata text. The "display" part of the rule is kept
+	     in the returned metadata record (record+show commands), the
+	     end result - normalized text - is used for performing
+	     within-cluster merge (unique, longest, etc). If the icurule is
+	     omitted, type generic (text) is converted as follows:
+	     any of the characters "<literal> ,/.:([</literal>" are
+	     chopped of prefix and suffix of text content
+	     <emphasis>unless</emphasis> it includes the
+	     characters "<literal>://</literal>" (URL).
+	    </para>
+	    <note>
+	     <para>
+	      Requires Pazpar2 1.9.0 or later.
+	     </para>
+	    </note>
+	   </listitem>
+	  </varlistentry>
+
+	  <varlistentry>
 	   <term>setting</term>
 	   <listitem>
 	    <para>
@@ -730,7 +777,7 @@
 	</listitem>
        </varlistentry>
 
-       <varlistentry>
+       <varlistentry id="service-timeout">
 	<term>timeout</term>
 	<listitem>
 	 <para>
@@ -751,6 +798,10 @@
 	  z3950_operation (30) &lt; session (60) &lt; z3950_session (180) .
 	  The default values are given in parantheses.
 	 </para>
+	 <para>
+	  The Z39.50 operation timeout may be set per database. Refer to
+	  <xref linkend="pztimeout"/>.
+	 </para>
 	</listitem>
        </varlistentry>
       </variablelist>     <!-- Data elements in service directive -->
@@ -1142,11 +1193,12 @@
        <emphasis>user, password</emphasis>.
       </para>
       <para>
-       For HTTP based procotols, such as SRU and Solr, the authentication
-       string includes a username term and, optionally, a password term.
+       For HTTP based procotols, such as SRU and Apache Solr, the
+       authentication string includes a username term and, optionally,
+       a password term.
        Each term is separated by a single blank. The
        authentication information is passed either by HTTP basic
-       authentication or via URL parameters. The mode is operation is
+       authentication or via URL parameters. The mode of operation is
        determined by <literal>pz:authentication_mode</literal> setting.
       </para>
      </listitem>
@@ -1229,12 +1281,22 @@
        supports (native) facets. The value is the name of the
        field on the target.
       </para>
-      <note>
-       <para>
-	At this point only Solr targets have been tested with this
-	facility.
-       </para>
-      </note>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
+     <term>pz:facetmap:split:<replaceable>name</replaceable></term>
+     <listitem>
+      <para>
+       Like pz:facetmap, but makes Pazpar2 inspect the term value consisting
+       of two items separated by colon. First item is the raw ID to be
+       sent to database if limitmap on the field
+       <replaceable>name</replaceable> is used. The second item is
+       the display term.
+      </para>
+      <para>
+       This facility was added in Pazpar2 version 1.11.0.
+      </para>
      </listitem>
     </varlistentry>
 
@@ -1315,6 +1377,23 @@
     </varlistentry>
 
     <varlistentry>
+     <term>pz:redis</term>
+     <listitem>
+      <para>
+       If set and non-empty,
+       <ulink url="&url.redis;">redis</ulink> will
+       configured and enabled for the target.
+       The value of this setting is exactly as the redis option for
+       ZOOM C of YAZ.
+      </para>
+      <para>
+       This setting is honored in Pazpar2 1.6.43 or later. Pazpar2 must
+       be using YAZ version 5.2.0 or later.
+      </para>
+     </listitem>
+    </varlistentry>
+
+    <varlistentry>
      <term>pz:nativesyntax</term>
      <listitem>
       <para>
@@ -1415,16 +1494,17 @@
      <listitem>
       <para>
        Specifies that a target is preferred, e.g. possible local, faster
-       target. Using block=pref on show command will wait for all these
+       target. Using block=preferred on <link linkend="command-show">
+       show command</link> will wait for all these
        targets to return records before releasing the block.
-       If no target is preferred, the block=pref will identical to block=1,
-       which release when one target has returned records.
+       If no target is preferred, the block=preferred will identical to
+       block=1, which release when one target has returned records.
       </para>
      </listitem>
     </varlistentry>
 
     <varlistentry>
-     <term>pz:presentchunk</term>
+     <term>pz:present_chunk</term>
      <listitem>
       <para>
        Controls the chunk size in present requests. Pazpar2 will
@@ -1562,6 +1642,23 @@
      </listitem>
     </varlistentry>
 
+
+    <varlistentry id="pztimeout">
+     <term>pz:timeout</term>
+     <listitem>
+      <para>
+       Specifies timeout for operation (eg search, and fetch) for
+       a database. This overrides the z3650_operation timeout
+       that is given for a service. See <xref linkend="service-timeout"/>.
+      </para>
+      <note>
+       <para>
+	The timeout facility is supported for Pazpar2 version 1.8.4 and later.
+       </para>
+      </note>
+     </listitem>
+    </varlistentry>
+
     <varlistentry id="pzurl">
      <term>pz:url</term>
      <listitem>