X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_protocol.xml;h=f266fd7944bd7f8f9e7dcd1944840766d947479c;hb=0bb0ee0e00d750808e228b991c78cb4838bc989d;hp=e8985667782a1e2ba06d3ff86b9847207f17eebd;hpb=f2211b54b4e4254e1d96664ed4bf02513f7d85c2;p=pazpar2-moved-to-github.git

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index e898566..f266fd7 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -240,6 +240,31 @@ search.pz?command=settings&session=2044502273&pz:allow[search.com:210/db1]=1
 	</para>
       </listitem>
      </varlistentry>
+     <varlistentry>
+      <term>sort</term>
+      <listitem>
+       <para>
+	Specifies sort criteria. The argument is a comma-separated list
+	(no whitespace allowed) of sort fields, with the highest-priority
+	field first. A sort field may be followed by a colon followed by
+	the number '0' (decreasing) or '1' (increasing).  Default
+        sort order is decreasing.
+	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>
+       <para>
+	If not specified here or as <link linkend="sort-default">sort-default"</link>
+	in pazpar2.cfg, Pazpar2 will default to the built-in 'relevance' ranking. 
+       </para>
+       <para>
+	Having sort criteria at search is important for targets that 
+	supports native sorting in order to get best results. Pazpar2 
+	will trigger a new search if search criteria changes from Pazpar2 
+	to target-based sorting or visa-versa.
+	</para>
+      </listitem>
+     </varlistentry>
     </variablelist>
 
    </para>
@@ -348,12 +373,20 @@ search.pz2?session=2044502273&command=stat
 	Specifies sort criteria. The argument is a comma-separated list
 	(no whitespace allowed) of sort fields, with the highest-priority
 	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 number '0' (decreasing) or '1' (increasing).  Default
+        sort order is decreasing.
 	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'.
+
+	If not specified here or as <link linkend="sort-default">sort-default"</link> 
+	in pazpar2.cfg, pazpar2 will default to the built-in 'relevance' ranking. 
+
+	Having sort criteria at search is important for targets that 
+	supports native sorting in order to get best results. pazpar2 
+	will trigger a new search if search criteria changes from pazpar2 
+	to target-based sorting.
+
        </para>
        <para>
 	For targets where If <link linkend="pz:sortmap">pz:sortmap</link>
@@ -437,13 +470,36 @@ search.pz2?session=2044502273&command=show&start=0&num=2&sort=title:1
 	fetched as "raw" from ZOOM C (raw, original record).
        </para>
        <para>
-	When offset is not given, the Pazpar2 metadata for the record
+	When offset/checksum is not given, the Pazpar2 metadata for the record
+	is returned and with metadata for each targets' data specified
+	in a 'location' list.
+       </para>
+      </listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term>checksum</term>
+      <listitem>
+       <para>
+	This optional parameter is a string which, when given, makes
+	Pazpar2 return the original record for a specific target. The
+	checksum is returned as attribtue 'checksum' in element
+	'location' for show command and record command (when checksum
+	and offset is NOT given).
+	The nativesyntax setting, as usual, is used to determine how to
+	create XML from the original record - unless parameter
+	<literal>binary</literal> is given in which the record is
+	fetched as "raw" from ZOOM C (raw, original record).
+       </para>
+       <para>
+	When offset/checksum is not given, the Pazpar2 metadata for the record
 	is returned and with metadata for each targets' data specified
 	in a 'location' list.
        </para>
       </listitem>
      </varlistentry>
 
+
      <varlistentry>
       <term>nativesyntax</term>
       <listitem>