Updated ICU config and adjusted description a little.

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

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index b75981d..931bc3f 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -105,14 +105,14 @@
      <term>relevance</term>
      <listitem>
       <para>
-       Specifies ICU tokenization and normalization rules
+       Specifies ICU tokenization and transformation 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
        in any order, except the 'index' element which logically
        belongs to the end of the list. The stated tokenization,
-       normalization and charmapping instructions are performed
+       transformation and charmapping instructions are performed
        in order from top to bottom. 
       </para>
       <variablelist> <!-- Level 2 -->
@@ -125,7 +125,7 @@
         </para>
        </listitem>
        </varlistentry>
-       <varlistentry><term>normalize</term>
+       <varlistentry><term>transform</term>
        <listitem>
         <para>
          Normalization and transformation of tokens follows
@@ -152,17 +152,6 @@
         </para>
        </listitem>
        </varlistentry>
-       <varlistentry><term>index</term>
-       <listitem>
-        <para>
-         Finally the 'index' element instruction - without
-         any 'rule' attribute - is used to store the tokens
-         after chain processing in the relevance ranking
-         unit of Pazpar2. It will always be the last
-         instruction in the chain.
-        </para>
-       </listitem>
-       </varlistentry>
       </variablelist>
      </listitem>
     </varlistentry>
@@ -171,7 +160,7 @@
      <term>sort</term>
      <listitem>
       <para>
-       Specifies ICU tokenization and normalization rules
+       Specifies ICU tokenization and transformation rules
        for tokens that are used in Pazpar2's sorting. The contents
        is similar to that of <literal>relevance</literal>.
       </para>
@@ -182,7 +171,7 @@
      <term>mergekey</term>
      <listitem>
       <para>
-       Specifies ICU tokenization and normalization rules
+       Specifies ICU tokenization and transformation rules
        for tokens that are used in Pazpar2's mergekey. The contents
        is similar to that of <literal>relevance</literal>.
       </para>
@@ -714,6 +703,10 @@
        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>
 
@@ -820,20 +813,33 @@
        </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>
 
  </refsect1>
  <refsect1><title>SEE ALSO</title>
   <para>
-   Pazpar2:
    <citerefentry>
     <refentrytitle>pazpar2</refentrytitle>
     <manvolnum>8</manvolnum>
    </citerefentry>
-  </para>
-  <para>
-   Pazpar2 protocol:
+   <citerefentry>
+    <refentrytitle>yaz-icu</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
    <citerefentry>
     <refentrytitle>pazpar2_protocol</refentrytitle>
     <manvolnum>7</manvolnum>