Doc: more on pz:extendrecs and spell fix

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

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index cbad09d..74f778e 100644 (file)
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -322,6 +322,11 @@
             all elements), or 'no' (don't merge; this is the
             default);
            </para>
+           <para>
+            Pazpar 1.6.24 also offers a new value for merge, 'first', which
+            is like 'all' but only takes all from first database that returns
+            the particular metadata field.
+           </para>
           </listitem>
          </varlistentry>
          
@@ -361,6 +366,22 @@
          </varlistentry>
          
          <varlistentry>
+          <term id="limitcluster">limitcluster</term>
+          <listitem>
+           <para>
+            Allow a limit on merged metadata. The value of this attribute
+            is the name of actual metadata content to be used for matching
+            (most often same name as metadata name).
+           </para>
+           <note>
+            <para>
+             Requires Pazpar2 1.6.23 or later.
+            </para>
+           </note>
+          </listitem>
+         </varlistentry>
+         
+         <varlistentry>
           <term id="metadata_limitmap">limitmap</term>
           <listitem>
            <para>
@@ -661,7 +682,7 @@
         <para>
          Customization of ranking algorithm was introduced with
          Pazpar2 1.6.18. The semantics of some of the fields changed
-         in versions up to 1.6.21.
+         in versions up to 1.6.22.
         </para>
        </listitem>
        </varlistentry>
@@ -780,7 +801,7 @@
   <para>
    The XML configuration may be partitioned into multiple files by using
    the <literal>include</literal> element which takes a single attribute,
-   <literal>src</literal>. The of the <literal>src</literal> attribute is
+   <literal>src</literal>. The <literal>src</literal> attribute is
    regular Shell like glob-pattern. For example,
    <screen><![CDATA[
    <include src="/etc/pazpar2/conf.d/*.xml"/>
@@ -1253,6 +1274,26 @@
      </listitem>
     </varlistentry>
     <varlistentry>
+     <term>pz:extendrecs</term>
+     <listitem>
+      <para>
+       If a show command goes to the boundary of a result set for a
+       database - depends on sorting - and pz:extendrecs is set to a positive
+       value. then Pazpar2 wait for show to fetch pz:extendrecs more
+       records. This setting is best used if a database does native
+       sorting, because the result set otherwise may be completely
+       re-sorted during extended fetch.
+       The default value of pz:extendrecs is 0 (no extended fetch).
+      </para>
+      <warning>
+       <para>
+       The pz:extendrecs setting appeared in Pazpar2 version 1.6.26.
+       But the bahavior changed with the release of Pazpar2 1.6.29.
+       </para>
+      </warning>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
      <term>pz:presentchunk</term>
      <listitem>
       <para>
@@ -1474,6 +1515,12 @@
        by a field a metadata field (default is to use the name of the 
        limitmap itself).
       </para>
+      <para>
+       For Pazpar2 version 1.6.23 and later the limitmap may include multiple
+       specifications, separated by <literal>,</literal> (comma).
+       For example:
+       <literal>ccl:title,local:ltitle,rpn:@attr 1=4</literal>.
+      </para>
       <note>
        <para>
        The limitmap facility is supported for Pazpar2 version 1.6.0.