Add SOLR material for ZOOM and yaz-client
authorAdam Dickmeiss <adam@indexdata.dk>
Wed, 15 Sep 2010 12:30:09 +0000 (14:30 +0200)
committerAdam Dickmeiss <adam@indexdata.dk>
Wed, 15 Sep 2010 12:30:09 +0000 (14:30 +0200)
doc/introduction.xml
doc/yaz-client-commands.xml
doc/yaz-client-man.xml
doc/zoom.xml

index 1010413..1c54f74 100644 (file)
@@ -16,7 +16,7 @@
     <listitem><para>
       Supports 
       <ulink url="&url.sru;">SRU GET/POST/SOAP</ulink>
     <listitem><para>
       Supports 
       <ulink url="&url.sru;">SRU GET/POST/SOAP</ulink>
-      version 1.1 (over HTTP and HTTPS).
+      version 1.2 (over HTTP and HTTPS).
      </para></listitem>
     <listitem><para>
       Includes BER encoders/decoders for the 
      </para></listitem>
     <listitem><para>
       Includes BER encoders/decoders for the 
       protocol.
      </para></listitem>
     <listitem><para>
       protocol.
      </para></listitem>
     <listitem><para>
+      Supports 
+      <ulink url="&url.solr;">SOLR</ulink> Web Service (client side only)
+     </para></listitem>
+    <listitem><para>
       Supports the following transports: BER over TCP/IP
       (<ulink url="&url.ber.over.tcpip;">RFC1729</ulink>),
       BER over unix local socket, and 
       Supports the following transports: BER over TCP/IP
       (<ulink url="&url.ber.over.tcpip;">RFC1729</ulink>),
       BER over unix local socket, and 
@@ -38,8 +42,8 @@
      </para></listitem>
     <listitem><para>
       Offers 
      </para></listitem>
     <listitem><para>
       Offers 
-      <ulink url="&url.zoom;">ZOOM</ulink> C API implementing both
-      Z39.50 and SRU.
+      <ulink url="&url.zoom;">ZOOM</ulink> C API implementing
+      Z39.50, SRU and SOLR Web Service.
      </para></listitem>
     <listitem><para>
       The &yaz; library offers a set of useful utilities
      </para></listitem>
     <listitem><para>
       The &yaz; library offers a set of useful utilities
index 09f7dfc..a769ac4 100644 (file)
    <literal>sru</literal> <replaceable>method</replaceable> <replaceable>version</replaceable>
   </term>
   <listitem>
    <literal>sru</literal> <replaceable>method</replaceable> <replaceable>version</replaceable>
   </term>
   <listitem>
-   <para>Selects SRU method and version.
+   <para>Selects Web Service method and version.
     Must be one of <literal>POST</literal>,
     Must be one of <literal>POST</literal>,
-    <literal>GET</literal>, <literal>SOAP</literal> (default). Version
+    <literal>GET</literal>, <literal>SOAP</literal> (default)
+    or <literal>SOLR</literal>. Version
     should be either 1.1 or 1.2. Other versions are allowed - for testing
     purposes (version negotiation with SRU server).
    </para>
     should be either 1.1 or 1.2. Other versions are allowed - for testing
     purposes (version negotiation with SRU server).
    </para>
     See the
     <ulink
      url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
     See the
     <ulink
      url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
-     Z39.50 standard
+     Z39.50 standard on set bounds
     </ulink>
     for more details.
    </para>
     </ulink>
     for more details.
    </para>
     See the
     <ulink
      url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
     See the
     <ulink
      url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
-     Z39.50 standard
+     Z39.50 standard on set bounds
     </ulink> for more details.
    </para>
   </listitem>
     </ulink> for more details.
    </para>
   </listitem>
     See the
     <ulink
      url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
     See the
     <ulink
      url="http://www.loc.gov/z3950/agency/markup/04.html#3.2.2.1.6">
-     Z39.50 standard
+     Z39.50 standard on set bounds
     </ulink>
     for more details.
    </para>
     </ulink>
     for more details.
    </para>
     are registered. See
     <ulink
      url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
     are registered. See
     <ulink
      url="http://www.loc.gov/z3950/agency/defns/oids.html#5">
-     Z39.50 Standard
+     Z39.50 Record Syntax Identifiers
     </ulink>
     for more details. Commonly used records syntaxes include usmarc,
     </ulink>
     for more details. Commonly used records syntaxes include usmarc,
-    sutrs, grs1 and xml.
+    sutrs and xml.
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
index 3325fa5..578db2e 100644 (file)
   
  <refsect1><title>DESCRIPTION</title>
   <para>
   
  <refsect1><title>DESCRIPTION</title>
   <para>
-   <command>yaz-client</command> is a Z39.50/SRU client (origin) with a
-   simple command line interface that allows you to test behavior and
-   performance of Z39.50 targets and SRU servers.
+   <command>yaz-client</command> is a
+   <ulink url="&url.z39.50;">Z39.50</ulink>/<ulink url="&url.sru;">SRU</ulink>
+   client (origin) with a simple command line interface that allows
+   you to test behavior and performance of Z39.50 targets and SRU servers.
+  </para>
+  <para>
+   From YAZ version 4.0.13, <command>yaz-client</command> may also operate as a
+   <ulink url="&url.solr;">SOLR</ulink> Web Service
+   client.
   </para>
   <para>
    If the <replaceable>server-addr</replaceable> is specified, the client creates
   </para>
   <para>
    If the <replaceable>server-addr</replaceable> is specified, the client creates
index 3698ccf..9c32a15 100644 (file)
@@ -29,22 +29,22 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
    programming language or toolkit.
   </para>
 
    programming language or toolkit.
   </para>
 
-  <note>
-   <para>
-    A recent addition to &yaz; is SRU support. You can now make
-    SRU ZOOM connections by specifying scheme <literal>http://</literal>
-    for the hostname for a connection.  The dialect of SRU used is
-    specified by the value of the connection's <literal>sru</literal>
-    option, which may be SRU over HTTP GET (<literal>get</literal>),
-    SRU over HTTP POST (<literal>post</literal>) or SRW (SRU over
-    SOAP) (<literal>soap</literal>).  Using the facility for embedding
-    options in target strings, a connection can be forced to use SRU
-    rather the SRW (the default) by prefixing the target string with
-    <literal>sru=get,</literal>, like this:
+  <para>
+    From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
+    You can make SRU ZOOM connections by specifying scheme
+    <literal>http://</literal> for the hostname for a connection.
+    The dialect of SRU used is specified by the value of the
+    connection's <literal>sru</literal> option, which may be SRU over
+    HTTP GET (<literal>get</literal>),
+    SRU over HTTP POST (<literal>post</literal>), (SRU over
+    SOAP) (<literal>soap</literal>) or <literal>SOLR</literal>
+    (<ulink url="&url.solr;">SOLR</ulink> Web Service).
+    Using the facility for embedding options in target strings, a
+    connection can be forced to use SRU rather the SRW (the default) by
+    prefixing the target string with <literal>sru=get,</literal>, like this:
     <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
    </para>
     <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
    </para>
-  </note>
-
+  
   <para>
    The lack of a simple Z39.50 client API for &yaz; has become more
    and more apparent over time. So when the first &zoom; specification
   <para>
    The lack of a simple Z39.50 client API for &yaz; has become more
    and more apparent over time. So when the first &zoom; specification
@@ -277,7 +277,8 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
       <row><entry>
         sru</entry><entry>
        SRU transport type. Must be either <literal>soap</literal>,
       <row><entry>
         sru</entry><entry>
        SRU transport type. Must be either <literal>soap</literal>,
-       <literal>get</literal> or <literal>post</literal>.
+       <literal>get</literal>, <literal>post</literal>, or
+       <literal>solr</literal>.
        </entry><entry>soap</entry></row>
       <row><entry>
         sru_version</entry><entry>
        </entry><entry>soap</entry></row>
       <row><entry>
         sru_version</entry><entry>
@@ -289,9 +290,11 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn)
        </entry><entry>1.2</entry></row>
       <row><entry>
         facets</entry><entry>
        </entry><entry>1.2</entry></row>
       <row><entry>
         facets</entry><entry>
-       A FacetList is comma-separated list of facet, which is defined as <literal>AttributeList</literal> 
-       and a optional FacetTerm (a Term and a frequency). On request the terms is missing. 
-       On response the the list contains the terms that the target could collect. 
+       A FacetList is comma-separated list of facet, which is defined
+       as <literal>AttributeList</literal>  and a optional FacetTerm
+       (a Term and a frequency). On request the terms is missing. 
+       On response the the list contains the terms that the target
+       could collect. 
        </entry><entry>none</entry></row>
      </tbody>
     </tgroup>
        </entry><entry>none</entry></row>
      </tbody>
     </tgroup>