JSON support for show in pz2.js

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

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index a622601..eeb0d7d 100644 (file)
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -32,7 +32,7 @@
    request is forwarded to the HTTP server specified in the configuration
    using the proxy setting.
    This way, a regular webserver can host the user interface (itself dynamic
-   or static HTML), and AJAX-style calls can be used from JS (or any other client-based
+   or static HTML), and Ajax-style calls can be used from JS (or any other client-based
    scripting environment) to interact with the search logic in Pazpar2. 
   </para>
   <para>
@@ -41,7 +41,9 @@
   <refsect2 id="command-init"><title>init</title>
    <para>
     Initializes a session.
-    Returns session ID to be used in subsequent requests.
+    Returns session ID to be used in subsequent requests. If
+    a server ID is given in the Pazpar2 server section, then a
+    period (.) and the server ID is appended to the session ID.
    </para>
    <para>
     Example:
@@ -78,9 +80,9 @@
       <term>service</term>
       <listitem>
        <para>
-       Makes the session use the service with the given ID. If
-       this is setting is omitted, the session will use the
-       unnamed service in the Pazpar2 configuration.
+        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>
@@ -177,7 +179,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>