Remove mergekey declaration

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

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 006aab1..009635b 100644 (file)
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -9,7 +9,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: pazpar2_protocol.xml,v 1.16 2007-10-08 13:19:22 adam Exp $ -->
 <refentry id="pazpar2_protocol">
  <refentryinfo>
   <productname>Pazpar2</productname>
@@ -74,6 +73,17 @@
        </para>
       </listitem>
      </varlistentry>
+
+     <varlistentry>
+      <term>service</term>
+      <listitem>
+       <para>
+        If this is defined it specifies a service ID. Makes the session use
+        the service with this ID. If this is setting is omitted, the
+        session will use the unnamed service in the Pazpar2 configuration.
+       </para>
+      </listitem>
+     </varlistentry>
     </variablelist>
    </para>
   </refsect2>
@@ -167,7 +177,36 @@
       <term>filter</term>
       <listitem>
        <para>
-       Filtering.
+       Limits the search to a given set of targets specified by the
+       filter. The filter consists a comma separated list of
+       setting+operator+args pairs. The setting is a Pazpar2 setting
+       (such as <literal>pz:id</literal>).
+       The operator is either = (string match)
+       or ~ (substring match). The args is a list of values separated
+       by | (or , one of the values). The idea is that only targets
+       with a setting matching one of the values given will be included
+       in the search.
+       </para>
+      </listitem>
+     </varlistentry>
+     <varlistentry>
+      <term>startrecs</term>
+      <listitem>
+       <para>
+       Specifies the first record to retrieve from each target.
+       The first record in a result set for a target is numbered 0, next
+       record is numbered 2. By default maxrecs is 0.
+       </para>
+      </listitem>
+     </varlistentry>
+     <varlistentry>
+      <term>maxrecs</term>
+      <listitem>
+       <para>
+       Specifies the maximum number of records to retrieve from each
+       target. The default value is 100. This setting has same meaning
+       as per-target setting pz:maxrecs . If pz:maxrecs is set, it takes
+       precedence over argument maxrecs.
        </para>
       </listitem>
      </varlistentry>
@@ -281,7 +320,8 @@ search.pz2?session=2044502273&command=stat
        field first. A sort field may be followed by a colon followed by
        the number '0' or '1', indicating whether results should be sorted in
        increasing or decreasing order according to that field. 0==Decreasing is
-       the default.
+       the default. Sort field names can be any field name designated as a sort field
+        in the pazpar2.cfg file, or the special name 'relevance'.
        </para>
       </listitem>
      </varlistentry>