Note that sort1() needs documented when I do sort()

[yaz-moved-to-github.git] / doc / zoom.xml

diff --git a/doc/zoom.xml b/doc/zoom.xml
index 8096140..476b44e 100644 (file)
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -1,4 +1,30 @@
-<!-- $Id: zoom.xml,v 1.38 2005-09-07 11:53:25 adam Exp $ -->
+<!--
+### Still to document:
+ZOOM_connection_option_getl(c, key, len)
+ZOOM_connection_option_setl(c, key, val, len)
+ZOOM_connection_errcode(c)
+ZOOM_connection_errmsg(c)
+ZOOM_connection_addinfo(c)
+ZOOM_diag_str(error)
+ZOOM_resultset_record_immediate(s, pos)
+ZOOM_resultset_cache_reset(r)
+ZOOM_connection_package(c, options)
+ZOOM_package_destroy(p)
+ZOOM_package_send(p, type)
+ZOOM_package_option_get(p, key)
+ZOOM_package_option_set(p, key, val)
+ZOOM_resultset_sort(r, sort_type, sort_spec)
+ZOOM_resultset_sort1(r, sort_type, sort_spec)
+ZOOM_options_set_callback(opt, function, handle)
+ZOOM_options_create_with_parent2(parent1, parent2)
+ZOOM_options_getl(opt, name, len)
+ZOOM_options_setl(opt, name, value, len)
+ZOOM_options_get_bool(opt, name, defa)
+ZOOM_options_get_int(opt, name, defa)
+ZOOM_options_set_int(opt, name, value)
+ZOOM_event(no, cs)
+-->
+<!-- $Id: zoom.xml,v 1.42 2005-11-08 17:12:55 mike Exp $ -->
  <chapter id="zoom"><title>ZOOM</title>
   <para>
     &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
@@ -416,6 +442,66 @@
      </tbody>
     </tgroup>
    </table>
+   <para>
+    For servers that support Search Info report, the following
+    options may be read using <function>ZOOM_resultset_get</function>.
+    This detailed information is read after a successful search has
+    completed.
+   </para>
+   <para>
+    This information is a list of of items, where each item is
+    information about a term or subquery. All items in the list 
+    are prefixed by 
+    <literal>SearchResult.</literal><replaceable>no</replaceable>
+    where no presents the item number (0=first, 1=second). 
+    Read <literal>searchresult.size</literal> to determine the
+    number of items.
+   </para>
+   <table frame="top"><title>Search Info Report options</title>
+    <tgroup cols="2">
+     <colspec colwidth="4*" colname="name"></colspec>
+     <colspec colwidth="7*" colname="description"></colspec>
+     <thead>
+      <row>
+       <entry>Option</entry>
+       <entry>Description</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>searchresult.size</entry>
+       <entry>
+       number of search result entries. This option is-nonexistant
+       if no entries are returned by the server.
+       </entry>
+      </row>
+      <row>
+       <entry>searchresult.<replaceable>no</replaceable>.id</entry>
+       <entry>sub query ID</entry>
+      </row>
+      <row>
+       <entry>searchresult.<replaceable>no</replaceable>.count</entry>
+       <entry>result count for item (number of hits)</entry>
+      </row>
+      <row>
+       <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
+       <entry>subquery term</entry>
+      </row>
+      <row>
+       <entry>
+       searchresult.<replaceable>no</replaceable>.interpretation.term
+       </entry>
+       <entry>interpretation term</entry>
+      </row>
+      <row>
+       <entry>
+       searchresult.<replaceable>no</replaceable>.recommendation.term
+       </entry>
+       <entry>recommendation term</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </table>
    <sect2>
     <title>Z39.50 Protocol behavior</title>
     <para>