X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=fd10f677a20351bde429eb2884f159092f91477a;hb=22ae3398d1153b29cdba238f1a5f21e7b3cf35e3;hp=1de2ec2eba447bc3b81df35909289eb13f4c06b4;hpb=5cdddaf1ba96608fcbd221421503b609ded909bf;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index 1de2ec2..fd10f67 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -26,7 +26,8 @@
   <refpurpose>The webservice protocol of Pazpar2</refpurpose>
  </refnamediv>
 
- <refsect1><title>DESCRIPTION</title>
+ <refsect1>
+  <title>DESCRIPTION</title>
   <para>
    Webservice requests are any that refer to filename "search.pz2". Arguments
    are GET-style parameters. Argument 'command' is always required and specifies
@@ -34,13 +35,15 @@
    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
-   scripting environment) to interact with the search logic in Pazpar2. 
+   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>
    Each command is described in sub sections to follow.
   </para>
-  <refsect2 id="command-init"><title>init</title>
+  <refsect2 id="command-init">
+   <title>init</title>
    <para>
     Initializes a session.
     Returns session ID to be used in subsequent requests. If
@@ -63,9 +66,9 @@
     </init>
 ]]></screen>
    <para>
-     The init command may take a number of setting parameters, similar to
-     the 'settings' command described below. These settings are immediately
-     applied to the new session. Other parameters for init are:
+    The init command may take a number of setting parameters, similar to
+    the 'settings' command described below. These settings are immediately
+    applied to the new session. Other parameters for init are:
     <variablelist>
      <varlistentry>
       <term>clear</term>
@@ -92,7 +95,8 @@
    </para>
   </refsect2>
   
-  <refsect2 id="command-ping"><title>ping</title>
+  <refsect2 id="command-ping">
+   <title>ping</title>
    <para>
     Keeps a session alive. An idle session will time out after one minute.
     The ping command can be used to keep the session alive absent other
@@ -145,7 +149,7 @@
    <para>
     Example:
     <screen><![CDATA[
-       search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
+search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
       ]]></screen>
     Response:
    <screen><![CDATA[
@@ -153,13 +157,14 @@
   <status>OK</status>
 </settings>
 ]]></screen>
-    </para>
-
+   </para>
+   
   </refsect2>
-  <refsect2 id="command-search"><title>search</title>
+  <refsect2 id="command-search">
+   <title>search</title>
    <para>
     Launches a search, parameters:
-    
+
     <variablelist>
      <varlistentry>
       <term>session</term>
@@ -297,7 +302,7 @@ search.pz2?session=2044502273&command=stat
       <listitem>
        <para>
 	Session ID
-	</para>
+       </para>
       </listitem>
      </varlistentry>
      
@@ -321,8 +326,8 @@ search.pz2?session=2044502273&command=stat
       <term>block</term>
       <listitem>
        <para>
-	If block is set to 1, the command will hang until there are records ready
-	to display. Use this to show first records rapidly without
+	If block is set to 1, the command will hang until there are records
+	ready to display. Use this to show first records rapidly without
 	requiring rapid polling.
        </para>
       </listitem>
@@ -337,8 +342,10 @@ 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. Sort field names can be any field name designated as a sort field
-        in the pazpar2.cfg file, or the special name 'relevance'.
+	the default.
+	Sort field names can be any field name designated as a sort field
+        in the pazpar2.cfg file, or the special names 'relevance' and
+	'position'.
        </para>
       </listitem>
      </varlistentry>
@@ -382,7 +389,7 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
     Retrieves a detailed record. Unlike the 
     <link linkend="command-show">show</link> command, this command 
     returns metadata records before merging takes place. Parameters:
-
+    
     <variablelist>
      <varlistentry>
       <term>session</term>
@@ -518,7 +525,7 @@ search.pz2?session=605047297&command=record&id=3
     <screen><![CDATA[
 search.pz2?session=2044502273&command=termlist&name=author,subject
 ]]></screen>
-Output:
+    Output:
     <screen><![CDATA[
 <termlist>
   <activeclients>3</activeclients>
@@ -540,8 +547,8 @@ Output:
   </list>
 </termlist>
 ]]></screen>
-    </para>
-
+   </para>
+   
    <para>
     For the special termlist name "xtargets", results
     are returned about the targets which have returned the most hits.
@@ -560,9 +567,9 @@ Output:
   <diagnostic>0</diagnostic>           -- Z39.50 diagnostic codes
 </term>
 ]]></screen>
-    </para>
+   </para>
   </refsect2>
-
+  
 
   <refsect2 id="command-bytarget">
    <title>bytarget</title>
@@ -585,7 +592,7 @@ Output:
     <screen><![CDATA[
 search.pz2?session=605047297&command=bytarget&id=3
 ]]></screen>
-
+    
     Example output:
     
     <screen><![CDATA[
@@ -610,7 +617,8 @@ search.pz2?session=605047297&command=bytarget&id=3
   </refsect2>
 
  </refsect1>
- <refsect1><title>SEE ALSO</title>
+ <refsect1>
+  <title>SEE ALSO</title>
   <para>
    Pazpar2:
    <citerefentry>
@@ -630,15 +638,7 @@ search.pz2?session=605047297&command=bytarget&id=3
 
 <!-- Keep this comment at the end of the file
 Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
 End:
 -->