Mention SRU rather than SRW (where appropriate).

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

diff --git a/doc/tools.xml b/doc/tools.xml
index f10bdc0..d47683f 100644 (file)
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -1,4 +1,4 @@
-<!-- $Id: tools.xml,v 1.45 2005-03-14 11:12:16 adam Exp $ -->
+<!-- $Id: tools.xml,v 1.50 2006-06-13 16:01:51 adam Exp $ -->
  <chapter id="tools"><title>Supporting Tools</title>
   
   <para>
@@ -225,7 +225,7 @@
         <literal>@and</literal>.  Its semantics are described in 
        section 3.7.2 (Proximity) of Z39.50 the standard itself, which
         can be read on-line at
-       <ulink url="http://lcweb.loc.gov/z3950/agency/markup/09.html"/>
+       <ulink url="&url.z39.50.proximity;"/>
       </para>
       <para>
        In PQF, the proximity operation is represented by a sequence
@@ -294,7 +294,7 @@
        </itemizedlist>
        (The numeric values of the relation and well-known unit-code
        parameters are taken straight from
-       <ulink url="http://lcweb.loc.gov/z3950/agency/asn1.html#ProximityOperator"
+       <ulink url="&url.z39.50.proximity.asn1;"
        >the ASN.1</ulink> of the proximity structure in the standard.)
       </para>
     </sect3>
@@ -305,6 +305,7 @@
       <para>
        <screen>
        dylan
+
        "bob dylan"
        </screen>
       </para>
@@ -313,7 +314,9 @@
       <para>
        <screen>
        @or "dylan" "zimmerman"
+
        @and @or dylan zimmerman when
+
        @and when @or dylan zimmerman
        </screen>
       </para>
@@ -322,7 +325,8 @@
       <para>
        <screen>
        @set Result-1
-       @and @set seta setb
+
+       @and @set seta @set setb
        </screen>
       </para>
      </example>
@@ -330,9 +334,13 @@
       <para>
        <screen>
        @attr 1=4 computer
+
        @attr 1=4 @attr 4=1 "self portrait"
+
        @attrset exp1 @attr 1=1 CategoryList
+
        @attr gils 1=2008 Copenhagen
+
        @attr 1=/book/title computer
        </screen>
       </para>
@@ -632,10 +640,8 @@
        </table>
       </para>
       <para>
-       The complete list of Bib-1 attributes can be found 
-       <ulink url="http://lcweb.loc.gov/z3950/agency/defns/bib1.html">
-       here
-       </ulink>.
+       Refer to the complete
+       <ulink url="&url.z39.50.attset.bib1;">list of Bib-1 attributes</ulink>
       </para>
       <para>
        It is also possible to specify non-numeric attribute values, 
@@ -932,20 +938,18 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str,
    </sect2>
    <sect2 id="tools.cql"><title>CQL</title>
     <para>
-     <ulink url="http://www.loc.gov/z3950/agency/zing/cql/">CQL</ulink>
+     <ulink url="&url.cql;">CQL</ulink>
       - Common Query Language - was defined for the
-     <ulink url="http://www.loc.gov/z3950/agency/zing/srw/">SRW</ulink>
-     protocol.
+     <ulink url="&url.sru;">SRU</ulink> protocol.
      In many ways CQL has a similar syntax to CCL.
      The objective of CQL is different. Where CCL aims to be
      an end-user language, CQL is <emphasis>the</emphasis> protocol
-     query language for SRW.
+     query language for SRU.
     </para>
     <tip>
      <para>
       If you are new to CQL, read the 
-      <ulink url="http://zing.z3950.org/cql/intro.html">Gentle
-       Introduction</ulink>.
+      <ulink url="&url.cql.intro;">Gentle Introduction</ulink>.
      </para>
     </tip>
     <para>
@@ -965,17 +969,16 @@ struct ccl_rpn_node *ccl_find_str (CCL_bibset bibset, const char *str,
       <listitem>
        <para>
         The parser converts a valid CQL query to PQF, thus providing a
-        way to use CQL for both SRW/SRU servers and Z39.50 targets at the
+        way to use CQL for both SRU servers and Z39.50 targets at the
         same time.
        </para>
       </listitem>
       <listitem>
        <para>
         The parser converts CQL to
-        <ulink url="http://www.loc.gov/z3950/agency/zing/cql/xcql.html">
-         XCQL</ulink>.
+        <ulink url="&url.xcql;">XCQL</ulink>.
         XCQL is an XML representation of CQL.
-        XCQL is part of the SRW specification. However, since SRU
+        XCQL is part of the SRU specification. However, since SRU
         supports CQL only, we don't expect XCQL to be widely used.
         Furthermore, CQL has the advantage over XCQL that it is
         easy to read.
@@ -1081,6 +1084,8 @@ struct cql_node {
          If an index is unspecified for a search term,
          <literal>index</literal> will be NULL.
         </para>
+       </listitem>
+       <listitem>
         <para>
          <literal>index_uri</literal>: index URi for search term
         or NULL if none could be resolved for the index.
@@ -1136,7 +1141,7 @@ struct cql_node {
       Conversion to PQF (and Z39.50 RPN) is tricky by the fact
       that the resulting RPN depends on the Z39.50 target
       capabilities (combinations of supported attributes). 
-      In addition, the CQL and SRW operates on index prefixes
+      In addition, the CQL and SRU operates on index prefixes
       (URI or strings), whereas the RPN uses Object Identifiers
       for attribute sets.
      </para>
@@ -1171,10 +1176,10 @@ int cql_transform_buf(cql_transform_t ct,
      </para>
      <para>
       If conversion failed, <function>cql_transform_buf</function>
-      returns a non-zero SRW error code; otherwise zero is returned
+      returns a non-zero SRU error code; otherwise zero is returned
       (conversion successful).  The meanings of the numeric error
-      codes are listed in the SRW specifications at
-      <ulink url="http://www.loc.gov/srw/diagnostic-list.html"/>
+      codes are listed in the SRU specifications at
+      <ulink url="&url.sru.diagnostics.list;"/>
      </para>
      <para>
       If conversion fails, more information can be obtained by calling
@@ -1190,7 +1195,7 @@ int cql_transform_error(cql_transform_t ct, char **addinfop);
       context set that was not recognised.
      </para>
      <para>
-      The SRW error-codes may be translated into brief human-readable
+      The SRU error-codes may be translated into brief human-readable
       error messages using
       <synopsis>
 const char *cql_strerror(int code);
@@ -1598,7 +1603,7 @@ typedef struct oident
    <para>
     again, corresponding to the specific OIDs defined by the standard.
     Refer to the
-    <ulink url="http://lcweb.loc.gov/z3950/agency/defns/oids.html">
+    <ulink url="&url.z39.50.oids;">
      Registry of Z39.50 Object Identifiers</ulink> for the
      whole list.
    </para>