From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 30 Oct 2013 12:23:33 +0000 (+0100)
Subject: Beginnings of sorting chapter
X-Git-Tag: v5.0.3~13
X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=8010ebca66a1ba04c1e7517364d16be7434cc25c;p=yaz-moved-to-github.git

Beginnings of sorting chapter
---

diff --git a/doc/tools.xml b/doc/tools.xml
index d19faf9..7310987 100644
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -2511,6 +2511,45 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
     </para>
    </sect2>
   </sect1>
+  <sect1><title>Sorting</title>
+   <para>
+    This chapter describes sorting and how it is supported in YAZ.
+    Sorting applies to a result-set.
+    The <ulink url="http://www.loc.gov/z3950/agency/markup/05.html#3.2.7">
+     Z39.50 sorting facility
+    </ulink>
+    takes one or more input result-sets
+    and one result-set as output. The most simple case is that
+    the input-set is the same as the output-set.
+   </para>
+   <para>
+    Z39.50 sorting has a separate APDU (service) that is, thus, performed
+    following a search (two phases).
+   </para>
+   <para>
+    In SRU/Solr, however, the model is different. Here, sorting is specified
+    during the the search operation. Note, however, that SRU might
+    perform sort as separate search, by referring to an existing result-set
+    in the query (result-set reference).
+   </para>
+   <sect2><title>Using the Z39.50 sort service</title>
+    <para>
+     yaz-client and the ZOOM API supports the Z39.50 sort facility. In any
+     case the sort sequence or sort critiera is using a string notation.
+     This notation is a one-line notation suitable for being manually
+     entered or generated and allows for easy logging (one liner).
+     For the ZOOM API, the sort is specified in the call to ZOOM_query_sortby
+     function. For yaz-client the sort is performed and specified using
+     the sort and sort+ commands. For description of the sort criteria notation
+     refer to the <link linkend="sortspec">sort command</link> in the
+     yaz-client manual.
+    </para>
+    <para>
+     The ZOOM API might choose one of several sort strategies for
+     sorting. Refer to <xref linkend="zoom-sort-strategy"/>.
+    </para>
+   </sect2>
+  </sect1>
  </chapter>
 
  <!-- Keep this comment at the end of the file
diff --git a/doc/yaz-client-man.xml b/doc/yaz-client-man.xml
index 4916c61..a490576 100644
--- a/doc/yaz-client-man.xml
+++ b/doc/yaz-client-man.xml
@@ -353,8 +353,8 @@
       the integer before <literal>=</literal> is
       the attribute type and the integer following <literal>=</literal>
       is the attribute value.
-      If no <literal>=</literal> is in the criterion it is treated as a
-      sortfield of type InternationalString.
+      If no <literal>=</literal> character is in the criterion, it is treated
+      as a sortfield of type InternationalString.
       The flags word of each sort specification must consist of
       <literal>s</literal>
       for case sensitive or <literal>i</literal> for case insensitive, and