From: Dennis Schafroth <dennis@indexdata.com>
Date: Thu, 20 Sep 2012 13:53:08 +0000 (+0200)
Subject: Document the sort parameter to search. Identical to same parameter to sort
X-Git-Tag: v1.6.20~5
X-Git-Url: http://jsfdemo.indexdata.com/cgi-bin?a=commitdiff_plain;h=dec24591aae7f790e456b70e3c367918843505b3;p=pazpar2-moved-to-github.git

Document the sort parameter to search. Identical to same parameter to sort
---

diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index e6763e2..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>
@@ -353,6 +378,15 @@ search.pz2?session=2044502273&command=stat
 	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>