Fix to describe new Zthes example instead of dinosauricon.

diff --git a/doc/examples.xml b/doc/examples.xml
index aefb286..0a77798 100644 (file)
--- a/doc/examples.xml
+++ b/doc/examples.xml
@@ -1,5 +1,5 @@
 <chapter id="examples">
- <!-- $Id: examples.xml,v 1.15 2002-10-30 14:45:42 adam Exp $ -->
+ <!-- $Id: examples.xml,v 1.16 2002-11-08 01:01:38 mike Exp $ -->
  <title>Example Configurations</title>
 
  <sect1>
@@ -59,16 +59,20 @@
    expressions to specify access points.
   </para>
   <para>
-   Go to the <literal>examples/dinosauricon</literal> subdirectory
+   Go to the <literal>examples/zthes</literal> subdirectory
    of the distribution archive.
-   There you will find a <literal>records</literal> subdirectory,
-   which contains some raw XML data to be added to the database: in
-   this case, as single file, <literal>genera.xml</literal>,
-   which contain information about all the known dinosaur genera as of
-   August 2002.
+   There you will find a <literal>Makefile</literal> that will
+   populate the <literal>records</literal> subdirectory with a file of
+   <ulink url="http://zthes.z3950.org/">Zthes</ulink>
+   records representing a taxonomic hierarchy of dinosaurs.  (The
+   records are generated from the family tree in the file
+   <literal>dino.tree</literal>.)
+   Type <literal>make records/dino.xml</literal>
+   to make the XML data file.
   </para>
   <para>
-   Now we need to create the Zebra database, which we do with the
+   Now we need to create a Zebra database to hold and index the XML
+   records.  We do this with the
    Zebra indexer, <literal>zebraidx</literal>, which is
    driven by the <literal>zebra.cfg</literal> configuration file.
    For our purposes, we don't need any
@@ -106,31 +110,27 @@
    <screen>
     $ yaz-client tcp:@:9999
     Connecting...Ok.
-    Z&gt; find @attr 1=/GENUS/SPECIES/AUTHOR/@name Wedel
+    Z&gt; find @attr 1=/Zthes/termName Sauroposeidon
     Number of hits: 1
     Z&gt; format xml
     Z&gt; show 1
-    &lt;GENUS name="Sauroposeidon" type="with"&gt;
-     &lt;MEANING&gt;lizard Poseidon &lt;LOW&gt;(Greek god of, among other things, earthquakes)&lt;/LOW&gt;&lt;/MEANING&gt;
-     &lt;SPECIES name="proteles"&gt;
-      &lt;AUTHOR type="vide" name="Franklin" year="2000"&gt;&lt;/AUTHOR&gt;
-      &lt;AUTHOR name="Wedel, Cifelli, Sanders"&gt;&lt;/AUTHOR&gt;
-     &lt;/SPECIES&gt;
-     &lt;PLACE name="Oklahoma"&gt;&lt;/PLACE&gt;
-     &lt;TIME value="Albian"&gt;&lt;/TIME&gt;
-     &lt;LENGTH value="30" q="1"&gt;&lt;/LENGTH&gt;
-     &lt;REMAINS content="rib, cervical vertebrae"&gt;&lt;/REMAINS&gt;
-     &lt;ESSAY&gt;
-      &lt;P&gt; This new &lt;NOMEN name="Brachiosaurus"&gt;&lt;/NOMEN&gt;-like &lt;LINK content="dinosaur"&gt;&lt;/LINK&gt;
-      was perhaps the tallest. With its head raised, it stood 60 feet (nearly
-      20 m) tall. &lt;/P&gt;
-     &lt;/ESSAY&gt;
+    &lt;Zthes&gt;
+     &lt;termId&gt;22&lt;/termId&gt;
+     &lt;termName&gt;Sauroposeidon&lt;/termName&gt;
+     &lt;termType&gt;PT&lt;/termType&gt;
+     &lt;relation&gt;
+      &lt;relationType&gt;BT&lt;/relationType&gt;
+      &lt;termId&gt;21&lt;/termId&gt;
+      &lt;termName&gt;Brachiosauridae&lt;/termName&gt;
+      &lt;termType&gt;PT&lt;/termType&gt;
+     &lt;/relation&gt;
+
       &lt;idzebra xmlns="http://www.indexdata.dk/zebra/"&gt;
-        &lt;size&gt;593&lt;/size&gt;
-        &lt;localnumber&gt;891&lt;/localnumber&gt;
-        &lt;filename&gt;records/genera.xml&lt;/filename&gt;
-     &lt;/idzebra&gt;
-    &lt;/GENUS&gt;
+       &lt;size&gt;245&lt;/size&gt;
+       &lt;localnumber&gt;23&lt;/localnumber&gt;
+       &lt;filename&gt;records/dino.xml&lt;/filename&gt;
+      &lt;/idzebra&gt;
+    &lt;/Zthes&gt;
    </screen>
   </para>
   <para>
@@ -145,30 +145,26 @@
   <para>
    The problem with the previous example is that you need to know the
    structure of the documents in order to find them.  For example,
-   when we wanted to know the genera for which Matt Wedel is an
-   author
-   (<foreignphrase role="taxon">Sauroposeidon proteles</foreignphrase>),
+   when we wanted to find the record for the taxon
+   <foreignphrase role="taxon">Sauroposeidon</foreignphrase>,
    we had to formulate a complex XPath 
-   <literal>1=/GENUS/SPECIES/AUTHOR/@name</literal>
-   which embodies the knowledge that author names are specified in the
-   <literal>name</literal> attribute of the
-   <literal>&lt;AUTHOR&gt;</literal> element,
-   which is inside the
-   <literal>&lt;SPECIES&gt;</literal> element,
-   which in turn is inside the top-level
-   <literal>&lt;GENUS&gt;</literal> element.
+   <literal>/Zthes/termName</literal>
+   which embodies the knowledge that taxon names are specified in a
+   <literal>&lt;termName&gt;</literal> element inside the top-level
+   <literal>&lt;Zthes&gt;</literal> element.
   </para>
   <para>
    This is bad not just because it requires a lot of typing, but more
    significantly because it ties searching semantics to the physical
    structure of the searched records.  You can't use the same search
    specification to search two databases if their internal
-   representations are different.  Consider an alternative dinosaur
-   database in which the records have author names specified
-   inside an <literal>&lt;authorName&gt;</literal> element directly
+   representations are different.  Consider an alternative taxonomy
+   database in which the records have taxon names specified
+   inside a <literal>&lt;name&gt;</literal> element nested within a
+   <literal>&lt;identification&gt;</literal> element
    inside a top-level <literal>&lt;taxon&gt;</literal> element: then
    you'd need to search for them using
-   <literal>1=/taxon/authorName</literal>
+   <literal>1=/taxon/identification/name</literal>
   </para>
   <para>
    How, then, can we build broadcasting Information Retrieval
@@ -200,28 +196,27 @@
    records in databases.
   </para>
   <para>
-   In the BIB-1 attribute set, an author search is represented by
-   access point 1003.  (See
+   In the BIB-1 attribute set, a taxon name is probably best
+   interpreted as a title - that is, a phrase that identifies the item
+   in question.  BIB-1 represents title searches by
+   access point 4.  (See
    <ulink url="###bib1-semantics"/>)
    So we need to configure our dinosaur database so that searches for
-   BIB-1 access point 1003 look the 
-   <literal>name</literal> attribute of the
-   <literal>&lt;AUTHOR&gt;</literal> element,
-   inside the
-   <literal>&lt;SPECIES&gt;</literal> element,
+   BIB-1 access point 4 look in the 
+   <literal>&lt;termName&gt;</literal> element,
    inside the top-level
-   <literal>&lt;GENUS&gt;</literal> element.
+   <literal>&lt;Zthes&gt;</literal> element.
   </para>
   <para>
    This is a two-step process.  First, we need to tell Zebra that we
    want to support the BIB-1 attribute set.  Then we need to tell it
-   which elements of its record pertain to access point 1003.
+   which elements of its record pertain to access point 4.
   </para>
   <para>
    We need to create an <link linkend="abs-file">Abstract Syntax
    file</link> named after the document element of the records we're
    working with, plus a <literal>.abs</literal> suffix - in this case,
-   <literal>GENUS.abs</literal> - as follows:
+   <literal>Zthes.abs</literal> - as follows:
   </para>
   <itemizedlist>
    <listitem>