Version 1.0.13.
[pazpar2-moved-to-github.git] / doc / pazpar2_conf.xml
index 2e294bd..745cab4 100644 (file)
@@ -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>
     </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
       </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>
 <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"/>
   <!-- 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 -->
 
      <listitem>
       <para>
        The element set name to be used when retrieving records from a
-       server (not yet implemented).
+       server.
       </para>
      </listitem>
     </varlistentry>
       </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>