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

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index a8dd4f5..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>