Use example tag consistently

diff --git a/doc/soap.xml b/doc/soap.xml
index 33951f7..2a7ac96 100644 (file)
--- a/doc/soap.xml
+++ b/doc/soap.xml
@@ -1,4 +1,4 @@
-<!-- $Id: soap.xml,v 1.3 2003-02-23 14:24:09 adam Exp $ -->
+<!-- $Id: soap.xml,v 1.4 2003-11-03 10:47:24 adam Exp $ -->

 <chapter id="soap"><title>SOAP and SRW</title>
   <sect1 id="soap.introduction"><title>Introduction</title>
     <para>
 <chapter id="soap"><title>SOAP and SRW</title>
   <sect1 id="soap.introduction"><title>Introduction</title>
     <para>

@@ -168,7 +168,7 @@ int yaz_srw_codec(ODR o, void * pptr,
                   void *client_data, const char *ns);
       </synopsis>
       Here, <literal>Z_SRW_GDU</literal> is either
                   void *client_data, const char *ns);
       </synopsis>
       Here, <literal>Z_SRW_GDU</literal> is either

-      searchRetrieverequest or a searchRetrieveResponse. 
+      searchRetrieveRequest or a searchRetrieveResponse. 

     </para>
     <note>
       <para>
     </para>
     <note>
       <para>

diff --git a/doc/tools.xml b/doc/tools.xml
index accbb59..00d9fc7 100644 (file)
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -1,4 +1,4 @@
-<!-- $Id: tools.xml,v 1.30 2003-11-03 09:49:58 mike Exp $ -->
+<!-- $Id: tools.xml,v 1.31 2003-11-03 10:47:24 adam Exp $ -->

  <chapter id="tools"><title>Supporting Tools</title>
   
   <para>
  <chapter id="tools"><title>Supporting Tools</title>
   
   <para>

@@ -301,101 +301,111 @@
 
     <sect3 id="pqf-examples"><title>PQF queries</title>
 
 
     <sect3 id="pqf-examples"><title>PQF queries</title>
 

-     <para>Queries using simple terms.
-      <screen>
-      dylan
-      "bob dylan"
-      </screen>
-     </para>
-     <para>Boolean operators.
-      <screen>
-       @or "dylan" "zimmerman"
-       @and @or dylan zimmerman when
-       @and when @or dylan zimmerman
-      </screen>
-     </para>
-     <para>
-      Reference to result sets.
-      <screen>
-       @set Result-1
-       @and @set seta setb
-      </screen>
-     </para>
-     <para>
-      Attributes for terms.
-      <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>
-     <para>
-      Proximity.
-      <screen>
-       @prox 0 3 1 2 k 2 dylan zimmerman
-      </screen>
-      <note><para>
-      Here the parameters 0, 3, 1, 2, k and 2 represent exclusion,
-      distance, ordered, relation, which-code and unit-code, in that
-      order.  So:
-      <itemizedlist>
-        <listitem><para>
-         exclusion = 0: the proximity condition must hold
-        </para></listitem>
-        <listitem><para>
-         distance = 3: the terms must be three units apart
-        </para></listitem>
-        <listitem><para>
-         ordered = 1: they must occur in the order they are specified
-        </para></listitem>
-        <listitem><para>
-         relation = 2: lessThanOrEqual (to the distance of 3 units)
-        </para></listitem>
-        <listitem><para>
-         which-code is ``known'', so the standard unit-codes are used
-        </para></listitem>
-        <listitem><para>
-         unit-code = 2: word.
-        </para></listitem>
-      </itemizedlist>
-      So the whole proximity query means that the words
-      <literal>dylan</literal> and <literal>zimmerman</literal> must
-      both occur in the record, in that order, differing in position
-      by three or fewer words (i.e. with two or fewer words between
-      them.)  The query would find ``Bob Dylan, aka. Robert
-      Zimmerman'', but not ``Bob Dylan, born as Robert Zimmerman''
-      since the distance in this case is four.
-      </para></note>
-     </para>
-     <para>
-      Specifying term type.
-      <screen>
-       @term string "a UTF-8 string, maybe?"
-      </screen>
-     </para>
-     <para>Mixed queries
-      <screen>
-       @or @and bob dylan @set Result-1
-       
-       @attr 4=1 @and @attr 1=1 "bob dylan" @attr 1=4 "slow train coming"
-       
-       @and @attr 2=4 @attr gils 1=2038 -114 @attr 2=2 @attr gils 1=2039 -109
+     <example><title>PQF queries using simple terms</title>
+      <para>
+       <screen>
+       dylan
+       "bob dylan"
+       </screen>
+      </para>
+     </example>
+     <example><title>PQF boolean operators</title>
+      <para>
+       <screen>
+       @or "dylan" "zimmerman"
+       @and @or dylan zimmerman when
+       @and when @or dylan zimmerman
+       </screen>
+      </para>
+     </example>
+     <example><title>PQF references to result sets</title>
+      <para>
+       <screen>
+       @set Result-1
+       @and @set seta setb
+       </screen>
+      </para>
+     </example>
+     <example><title>Attributes for terms</title>
+      <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>
+     </example>
+     <example><title>PQF Proximity queries</title>
+      <para>
+       <screen>
+       @prox 0 3 1 2 k 2 dylan zimmerman
+       </screen>
+       <note><para>
+        Here the parameters 0, 3, 1, 2, k and 2 represent exclusion,
+        distance, ordered, relation, which-code and unit-code, in that
+        order.  So:
+        <itemizedlist>
+         <listitem><para>
+           exclusion = 0: the proximity condition must hold
+          </para></listitem>
+         <listitem><para>
+           distance = 3: the terms must be three units apart
+          </para></listitem>
+         <listitem><para>
+           ordered = 1: they must occur in the order they are specified
+          </para></listitem>
+         <listitem><para>
+           relation = 2: lessThanOrEqual (to the distance of 3 units)
+          </para></listitem>
+         <listitem><para>
+           which-code is ``known'', so the standard unit-codes are used
+          </para></listitem>
+         <listitem><para>
+           unit-code = 2: word.
+          </para></listitem>
+        </itemizedlist>
+        So the whole proximity query means that the words
+        <literal>dylan</literal> and <literal>zimmerman</literal> must
+        both occur in the record, in that order, differing in position
+        by three or fewer words (i.e. with two or fewer words between
+        them.)  The query would find ``Bob Dylan, aka. Robert
+        Zimmerman'', but not ``Bob Dylan, born as Robert Zimmerman''
+        since the distance in this case is four.
+       </para></note>
+      </para>
+     </example>
+     <example><title>PQF specification of search term</title>
+      <para>
+       <screen>
+       @term string "a UTF-8 string, maybe?"
+       </screen>
+      </para>
+     </example>
+     <example><title>PQF mixed queries</title>
+      <para>
+       <screen>
+       @or @and bob dylan @set Result-1
+       
+       @attr 4=1 @and @attr 1=1 "bob dylan" @attr 1=4 "slow train coming"
+       
+       @and @attr 2=4 @attr gils 1=2038 -114 @attr 2=2 @attr gils 1=2039 -109

       </screen>
       </screen>

-      <note>
+       <note>

        <para>
        <para>

-         The last of these examples is a spatial search: in
-         <ulink url="http://www.gils.net/prof_v2.html#sec_7_4"
+        The last of these examples is a spatial search: in
+        <ulink url="http://www.gils.net/prof_v2.html#sec_7_4"

          >the GILS attribute set</ulink>,
          >the GILS attribute set</ulink>,

-         access point
-         2038 indicates West Bounding Coordinate and
-         2030 indicates East Bounding Coordinate,
-         so the query is for areas extending from -114 degrees
-         to no more than -109 degrees.
+        access point
+        2038 indicates West Bounding Coordinate and
+        2030 indicates East Bounding Coordinate,
+        so the query is for areas extending from -114 degrees
+        to no more than -109 degrees.

        </para>
        </para>

-      </note>
-     </para>
+       </note>
+      </para>
+     </example>

     </sect3>
    </sect2>
    <sect2 id="CCL"><title>CCL</title>
     </sect3>
    </sect2>
    <sect2 id="CCL"><title>CCL</title>