From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 12 Oct 2011 11:11:33 +0000 (+0200)
Subject: Document pz:sortmap
X-Git-Tag: v1.6.4~5^2~9
X-Git-Url: http://lists.indexdata.dk/?a=commitdiff_plain;h=14830963a2f89b0ce47d4b9d9549ce6a1aae3e5e;p=pazpar2-moved-to-github.git

Document pz:sortmap
---

diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml
index 1120185..e558c65 100644
--- a/doc/pazpar2_conf.xml
+++ b/doc/pazpar2_conf.xml
@@ -1253,9 +1253,30 @@
       </note>
      </listitem>
     </varlistentry>
+
+    <varlistentry id="pzsortmap">
+     <term>pz:sortmap:<replaceable>field</replaceable></term>
+     <listitem>
+      <para>
+       Specifies native sorting for a target where
+       <replaceable>field</replaceable> is a sort criteria (see command
+       show). The value has to components separated by colon: strategy and
+       native-field. Strategy is one of <literal>z3950</literal>,
+       <literal>type7</literal>, <literal>cql</literal>,
+       <literal>sru11</literal>, or <literal>embed</literal>.
+       The second component, native-field, is the field that is recognized
+       by the target.
+      </para>
+      <note>
+       <para>
+ 	Only supported for Pazpar2 1.6.4 and later.
+       </para>
+      </note>
+     </listitem>
+    </varlistentry>
     
    </variablelist>
-
+   
   </refsect2>
 
  </refsect1>
diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml
index a9e28b8..47314ac 100644
--- a/doc/pazpar2_protocol.xml
+++ b/doc/pazpar2_protocol.xml
@@ -355,6 +355,11 @@ search.pz2?session=2044502273&command=stat
         in the pazpar2.cfg file, or the special names 'relevance' and
 	'position'.
        </para>
+       <para>
+	For targets where If <link linkend="pz:sortmap">pz:sortmap</link>
+	is defined, a sort operation will be executed (possibly including
+	extending the search).
+       </para>
       </listitem>
      </varlistentry>