X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=b74e42b2f18e5e7a00fd6afa9d0218acd96b24a4;hb=669d1bc07e61c81e0d931409c4160404628fb236;hp=009635b61d66dc74f38ae6ffe824f3a043f378a2;hpb=f5fe92a40046dd1142edd3714dc3c6c708c26492;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 009635b..b74e42b 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;
@@ -13,10 +13,12 @@
  <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>
@@ -32,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>
@@ -41,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:
@@ -190,6 +194,16 @@
       </listitem>
      </varlistentry>
      <varlistentry>
+      <term>limit</term>
+      <listitem>
+       <para>
+	Narrows the search by one or more facet fields. The limit is
+	sequence of one or more field=value pairs separate by comma.
+	A value that contains a comma should be escaped by backslash (\).
+       </para>
+      </listitem>
+     </varlistentry>
+     <varlistentry>
       <term>startrecs</term>
       <listitem>
        <para>
@@ -486,6 +500,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>