X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=e90b5c4835ae19ba9a0970e4b90417c3086099e0;hb=1fc1b045b89c4122c305aa0127c06dde4dc4d0a8;hp=969093c6555e3d05e592ba37846e820d1d7ed803;hpb=d7ba48e5055825167973cfa42ac76a7003f987bc;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 969093c..e90b5c4 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
@@ -9,15 +9,16 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: pazpar2_protocol.xml,v 1.15 2007-09-20 08:13:26 adam Exp $ -->
 <refentry id="pazpar2_protocol">
  <refentryinfo>
   <productname>Pazpar2</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
  <refmeta>
   <refentrytitle>Pazpar2 protocol</refentrytitle>
   <manvolnum>7</manvolnum>
+  <refmiscinfo class="manual">Conventions and miscellaneous</refmiscinfo>
  </refmeta>
 
  <refnamediv>
@@ -33,7 +34,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>
@@ -42,7 +43,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:
@@ -74,6 +77,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 +181,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 +324,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>
@@ -389,6 +433,18 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
       </listitem>
      </varlistentry>
 
+     <varlistentry>
+      <term>binary</term>
+      <listitem>
+       <para>
+	This optional parameter enables "binary" response for retrieval
+	of a raw record (i.e. when offset is specified). For binary
+	responses the record is <emphasis>not</emphasis> converted to
+	XML and the HTTP content type is application/octet-stream.
+       </para>
+      </listitem>
+     </varlistentry>
+
     </variablelist>
    </para>
    <para> 
@@ -434,6 +490,14 @@ search.pz2?session=605047297&command=record&id=3
        </para>
       </listitem>
      </varlistentry>
+     <varlistentry>
+      <term>num</term>
+      <listitem>
+       <para>
+	maximum number of entries to return - default is 15.
+       </para>
+      </listitem>
+     </varlistentry>
     </variablelist>
    </para>
    <para>