X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Ftools.xml;h=73109875adcd989145c8b39c8e0326833316f4c3;hp=ec3bc1bbb21802714eaca269e1e08b52355e8f70;hb=8010ebca66a1ba04c1e7517364d16be7434cc25c;hpb=c13416878ec0afc9d91bdd20deb20c82425e67b6

diff --git a/doc/tools.xml b/doc/tools.xml
index ec3bc1b..7310987 100644
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -686,8 +686,8 @@
 
 	  <row><entry><literal>s=ag</literal></entry><entry>
 	    Tokens that appears as phrases (with blank in them) gets
-	    structure phrase attached. Tokens that appers as words
-	    gets structure phrase attached. Phrases and words are
+	    structure phrase attached (4=1). Tokens that appear to be words
+	    gets structure word attached (4=2). Phrases and words are
 	    ANDed. This is a variant of s=al and s=pw, with the main
 	    difference that words are not split (with operator AND)
 	    but instead kept in one RPN token. This facility appeared
@@ -868,7 +868,7 @@
 	 </row>
 	 <row>
 	  <entry>mask</entry>
-	  <entry>Masking character</entry>
+	  <entry>Masking character. Requires YAZ 4.2.58 or later</entry>
 	  <entry><literal>#</literal></entry>
 	 </row>
 	 <row>
@@ -2450,6 +2450,56 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
       </itemizedlist>
      </para>
     </example>
+
+    <example id="tools.retrieval.marcxml">
+     <title>MARCXML backend</title>
+     <para>
+      SRW/SRU and Solr backends returns records in XML.
+      If they return MARCXML or MarcXchange, the retrieval module
+      can convert those into ISO2709 formats, most commonly USMARC
+      (AKA MARC21).
+      In this example, the backend returns MARCXML for schema="marcxml".
+     </para>
+     <programlisting><![CDATA[
+     <retrievalinfo>
+       <retrieval syntax="usmarc">
+         <backend syntax="xml" name="marcxml">
+	   <marc inputformat="xml" outputformat="marc"
+		 outputcharset="marc-8"/>
+	 </backend>
+       </retrieval>
+       <retrieval syntax="xml" name="marcxml"
+		  identifier="info:srw/schema/1/marcxml-v1.1"/>
+       <retrieval syntax="xml" name="dc">
+         <backend syntax="xml" name="marcxml">
+           <xslt stylesheet="MARC21slim2DC.xsl"/>
+	 </backend>
+       </retrieval>
+     </retrievalinfo>
+]]>
+     </programlisting>
+     <para>
+      This means that our frontend supports:
+      <itemizedlist>
+       <listitem>
+        <para>
+         MARC21 records (any element set name) in MARC-8 encoding.
+        </para>
+       </listitem>
+       <listitem>
+        <para>
+         MARCXML records for element-set=marcxml
+        </para>
+       </listitem>
+       <listitem>
+        <para>
+         Dublin core records for element-set=dc.
+        </para>
+       </listitem>
+      </itemizedlist>
+     </para>
+    </example>
+
    </sect2>
    <sect2 id="tools.retrieval.api">
     <title>API</title>
@@ -2461,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