Merge branch 'master' of ssh://git.indexdata.com:222/home/git/pub/pazpar2

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

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 2e294bd..b3a6281 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -9,7 +9,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: pazpar2_conf.xml,v 1.30 2007-08-01 11:48:26 quinn Exp $ -->
 <refentry id="pazpar2_conf">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -103,11 +102,11 @@
     </varlistentry>
     
     <varlistentry>
-     <term>icu_chain</term>
+     <term>relevance</term>
      <listitem>
       <para>
-       Definition of ICU tokenization and normalization rules
-       are used if ICU support is compiled in.  The 'id'
+       Specifies ICU tokenization and normalization rules
+       for tokens that are used in Pazpar2's relevance ranking.  The 'id'
        attribute is currently not used, and the 'locale'
        attribute must be set to one of the locale strings
        defined in ICU. The child elements listed below can be
@@ -167,6 +166,28 @@
       </variablelist>
      </listitem>
     </varlistentry>
+
+    <varlistentry>
+     <term>sort</term>
+     <listitem>
+      <para>
+       Specifies ICU tokenization and normalization rules
+       for tokens that are used in Pazpar2's sorting. The contents
+       is similar to that of <literal>relevance</literal>.
+      </para>
+     </listitem>
+    </varlistentry>
+    
+    <varlistentry>
+     <term>mergekey</term>
+     <listitem>
+      <para>
+       Specifies ICU tokenization and normalization rules
+       for tokens that are used in Pazpar2's mergekey. The contents
+       is similar to that of <literal>relevance</literal>.
+      </para>
+     </listitem>
+    </varlistentry>
     
     <varlistentry>
      <term>service</term>
@@ -568,7 +589,6 @@
 <settings target="*">
 
   <!-- This file introduces default settings for pazpar2 -->
-  <!-- $Id: pazpar2_conf.xml,v 1.30 2007-08-01 11:48:26 quinn Exp $ -->
 
   <!-- mapping for unqualified search -->
   <set name="pz:cclmap:term" value="u=1016 t=l,r s=al"/>
@@ -583,7 +603,10 @@
   <!-- Retrieval settings -->
 
   <set name="pz:requestsyntax" value="marc21"/>
-  <!-- <set name="pz:elements" value="F"/> NOT YET IMPLEMENTED -->
+  <set name="pz:elements" value="F"/>
+
+  <!-- Query encoding -->
+  <set name="pz:queryencoding" value="iso-8859-1"/>
 
   <!-- Result normalization settings -->
 
@@ -663,7 +686,7 @@
      <listitem>
       <para>
        The element set name to be used when retrieving records from a
-       server (not yet implemented).
+       server.
       </para>
      </listitem>
     </varlistentry>
@@ -691,8 +714,24 @@
        For iso2709, can also specify a native character set, e.g. "iso2709;latin-1".
        If no character set is provided, MARC-8 is assumed.
       </para>
+      <para>
+        If pz:nativesyntax is not specified, pazpar2 will attempt to determine
+       the value based on the response from the server.
+      </para>
      </listitem>
     </varlistentry>
+
+    <varlistentry>
+     <term>pz:queryencoding</term>
+     <listitem>
+      <para>
+        The encoding of the search terms that a target accepts. Most
+        targets do not honor UTF-8 in which case this needs to be specified.
+        Each term in a query will be converted if this setting is given.
+      </para>
+     </listitem>
+    </varlistentry>
+
     <varlistentry>
      <term>pz:xslt</term>
      <listitem>
@@ -727,7 +766,7 @@
      <listitem>
       <para>
        Controls the maximum number of records to be retrieved from a
-       server. The default is 100 (not yet implemented).
+       server. The default is 100.
       </para>
      </listitem>
     </varlistentry>
@@ -762,6 +801,42 @@
       </para>
      </listitem>
     </varlistentry>
+
+    <varlistentry>
+      <term>pz:sru</term>
+      <listitem>
+        <para>
+         This setting enables SRU/SRW support. It has three possible settings.
+         'get', enables SRU access through GET requests. 'post' enables SRU/POST
+         support, less commonly supported, but useful if very large requests are
+         to be submitted. 'srw' enables the SRW variation of the protocol.
+       </para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term>pz:sru_version</term>
+      <listitem>
+        <para>
+         This allows SRU version to be specified. If unset Pazpar2
+         will the default of YAZ (currently 1.2). Should be set
+         to 1.1 or 1.2.
+       </para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term>pz:pqf_prefix</term>
+      <listitem>
+        <para>
+         Allows you to specify an arbitrary PQF query language substring. The provided
+         string is prefixed the user's query after it has been normalized to PQF
+         internally in pazpar2. This allows you to attach complex 'filters' to
+         queries for a gien target, sometimes necessary to select sub-catalogs
+         in union catalog systems, etc.
+       </para>
+      </listitem>
+    </varlistentry>
    </variablelist>
   </refsect2>