X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=ae18a8faa513a171e5af5aa73ae1a738941f5f85;hb=d508100e993ab5c9a415bd1826b939875dcfe91c;hp=d86933085432a9b4f43308223c9a3427894d2bb4;hpb=1ec3ab1ba223a0ed562a079474866e33102a4a65;p=yazpp-moved-to-github.git

diff --git a/doc/zoom.xml b/doc/zoom.xml
index d869330..ae18a8f 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -1,25 +1,24 @@
 <chapter id="zoom">
- <!-- $Id: zoom.xml,v 1.15 2006-04-25 12:37:05 marc Exp $ -->
+ <!-- $Id: zoom.xml,v 1.17 2006-10-10 21:59:43 adam Exp $ -->
  <title>ZOOM-C++</title>
 
 
  <sect1 id="zoom-introduction">
   <title>Introduction</title>
   <para>
-   <ulink url="http://zoom.z3950.org/">ZOOM</ulink>
+   <ulink url="&url.zoom;">ZOOM</ulink>
    is the emerging standard API for information retrieval programming
    using the Z39.50 protocol.  ZOOM's
-   <ulink url="http://zoom.z3950.org/api/">Abstract API</ulink>
+   <ulink url="&url.zoom.api;">Abstract API</ulink>
    specifies semantics for classes representing key IR concepts such as
    connections, queries, result sets and records; and there are various
-   <ulink url="http://zoom.z3950.org/bind/">bindings</ulink>
+   <ulink url="&url.zoom.bind;">bindings</ulink>
    specifying how those concepts should be represented in various
    programming languages.
   </para>
   <para>
    The YAZ++ library includes an implementation of the <ulink
-   url="http://zoom.z3950.org/bind/cplusplus/"
-	>C++ binding</ulink>
+   url="&url.zoom.bind.cplusplus;">C++ binding</ulink>
    for ZOOM, enabling quick, easy development of client applications.
   </para>
   <para>
@@ -56,7 +55,7 @@
    implementation of the C binding.  For information on the supported
    options and other such details, see the ZOOM-C documentation, which
    can be found on-line at
-   <ulink url="http://www.indexdata.dk/yaz/doc/zoom.tkl"/>
+   <ulink url="&url.yaz.zoom;"/>
   </para>
   <para>
    All of the classes defined by ZOOM-C++ are in the
@@ -146,24 +145,24 @@
    (links below).
   </para>
 
-  <sect2>
+  <sect2 id="connection.references">
    <title>References</title>
    <itemizedlist>
     <listitem>
      <para>
       <ulink url="http://zoom.z3950.org/api/zoom-1.3.html#3.2"
 	>Section 3.2 (Connection) of the ZOOM Abstract API</ulink>
-     </para>
-    </listitem>
-    <listitem>
-     <para>
-      <ulink url="http://www.indexdata.dk/yaz/doc/zoom.tkl#zoom.connections"
-	>The Connections section of the ZOOM-C documentation</ulink>
-     </para>
-    </listitem>
-   </itemizedlist>
-  </sect2>
- </sect1>
+      </para>
+     </listitem>
+     <listitem>
+      <para>
+       <ulink url="&url.yaz.zoom.connections;"
+	>The Connections section f the ZOOM-C documentation</ulink>
+      </para>
+     </listitem>
+    </itemizedlist>
+   </sect2>
+  </sect1>
 
 
  <sect1 id="zoom-query">
@@ -175,7 +174,7 @@
    a specific query notation.
   </para>
 
-  <sect2>
+  <sect2 id="ZOOM::prefixQuery">
    <title><literal>ZOOM::prefixQuery</literal></title>
    <synopsis>
     class prefixQuery : public query {
@@ -184,15 +183,14 @@
       ~prefixQuery ();
     };
    </synopsis>
-   <para>
-    This class enables a query to be created by compiling YAZ's
-    cryptic but powerful
-    <ulink url="http://www.indexdata.dk/yaz/doc/tools.tkl#PQF"
-	>Prefix Query Notation (PQN)</ulink>.
-   </para>
-  </sect2>
-
-  <sect2>
+    <para>
+     This class enables a query to be created by compiling YAZ's
+     cryptic but powerful
+     <ulink url="&url.yaz.pqf;">Prefix Query Notation (PQN)</ulink>.
+    </para>
+   </sect2>
+   
+  <sect2 id="ZOOM::CCLQuery">
    <title><literal>ZOOM::CCLQuery</literal></title>
    <synopsis>
     class CCLQuery : public query {
@@ -204,8 +202,7 @@
    <para>
     This class enables a query to be created using the simpler but
     less expressive
-    <ulink url="http://www.indexdata.dk/yaz/doc/tools.tkl#CCL"
-	>Common Command Language (CCL)</ulink>.
+    <ulink url="&url.yaz.ccl;">Common Command Language (CCL)</ulink>.
     The qualifiers recognised by the CCL parser are specified in an
     external configuration file in the format described by the YAZ
     documentation.
@@ -219,7 +216,7 @@
    </para>
   </sect2>
 
-  <sect2>
+  <sect2 id="queries.discussion">
    <title>Discussion</title>
    <para>
     It will be readily recognised that these objects have no methods
@@ -246,7 +243,7 @@
    </screen>
   </sect2>
 
-  <sect2>
+  <sect2 id="query.references">
    <title>References</title>
    <itemizedlist>
     <listitem>
@@ -257,7 +254,7 @@
     </listitem>
     <listitem>
      <para>
-      <ulink url="http://www.indexdata.dk/yaz/doc/zoom.query.tkl"
+       <ulink url="&url.yaz.zoom.query;"
 	>The Queries section of the ZOOM-C documentation</ulink>
      </para>
     </listitem>
@@ -328,7 +325,7 @@
    <link linkend="zoom-exception"><literal>exception</literal></link>.
   </para>
 
-  <sect2>
+  <sect2 id="resultset.references">
    <title>References</title>
    <itemizedlist>
     <listitem>
@@ -339,7 +336,7 @@
     </listitem>
     <listitem>
      <para>
-      <ulink url="http://www.indexdata.dk/yaz/doc/zoom.resultsets.tkl"
+      <ulink url="&url.yaz.zoom.resultsets;"
 	>The Result Sets section of the ZOOM-C documentation</ulink>
      </para>
     </listitem>
@@ -420,7 +417,7 @@
    it apart ``by hand''.
   </para>
 
-  <sect2>
+  <sect2 id="zoom.memory.management">
    <title>Memory Management</title>
    <para>
     The <literal>record</literal> objects returned from
@@ -458,7 +455,7 @@
    </programlisting>
   </sect2>
 
-  <sect2>
+  <sect2 id="record.references">
    <title>References</title>
    <itemizedlist>
     <listitem>
@@ -469,7 +466,7 @@
     </listitem>
     <listitem>
      <para>
-      <ulink url="http://www.indexdata.dk/yaz/doc/zoom.records.tkl"
+      <ulink url="&url.yaz.zoom.records;"
 	>The Records section of the ZOOM-C documentation</ulink>
      </para>
     </listitem>
@@ -510,7 +507,7 @@
    It has three concrete subclasses:
   </para>
 
-  <sect2>
+  <sect2 id="ZOOM::systemException">
    <title><literal>ZOOM::systemException</literal></title>
    <synopsis>
     class systemException: public exception {
@@ -531,7 +528,7 @@
    </para>
   </sect2>
 
-  <sect2>
+  <sect2 id="ZOOM::bib1Exception">
    <title><literal>ZOOM::bib1Exception</literal></title>
    <synopsis>
     class bib1Exception: public exception {
@@ -560,7 +557,7 @@
    </para>
   </sect2>
 
-  <sect2>
+  <sect2 id="ZOOM::queryException">
    <title><literal>ZOOM::queryException</literal></title>
    <synopsis>
     class queryException: public exception {
@@ -643,7 +640,7 @@
    </para>
   </sect2>
 
-  <sect2>
+  <sect2 id="exception.references">
    <title>References</title>
    <itemizedlist>
     <listitem>
@@ -654,10 +651,8 @@
     </listitem>
     <listitem>
      <para>
-      <ulink url="http://lcweb.loc.gov/z3950/agency/defns/bib1diag.html"
-	>Bib-1 Diagnostics</ulink> on the
-      <ulink url="http://lcweb.loc.gov/z3950/agency/"
-	>Z39.50 Maintenance Agency</ulink> site.
+      <ulink url="&url.z39.50.diagnostics;">Bib-1 Diagnostics</ulink> on the
+      <ulink url="&url.z39.50;">Z39.50 Maintenance Agency</ulink> site.
      </para>
     </listitem>
    </itemizedlist>
@@ -667,7 +662,7 @@
     <literal>exception</literal> class and its subclasses.  The
     closest thing is the <literal>ZOOM_connection_error</literal>
     function described in
-    <ulink url="http://www.indexdata.dk/yaz/doc/zoom.tkl#zoom.connections"
+     <ulink url="&url.yaz.zoom.connections;"
 	>The Connections section</ulink> of the documentation.
    </para>
   </sect2>