X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fexamples.xml;h=aefb286934d1da873a7d955d1f71b118883da494;hb=49f49aa27c8d63cea66dfb5a9e06e5735c835509;hp=86d8c5950b59fcff0a1c0d1058b10200ae0d7329;hpb=5243917e35bcd84925e89f609d291658a188e45b;p=idzebra-moved-to-github.git

diff --git a/doc/examples.xml b/doc/examples.xml
index 86d8c59..aefb286 100644
--- a/doc/examples.xml
+++ b/doc/examples.xml
@@ -1,5 +1,5 @@
 <chapter id="examples">
- <!-- $Id: examples.xml,v 1.9 2002-10-16 20:33:31 mike Exp $ -->
+ <!-- $Id: examples.xml,v 1.15 2002-10-30 14:45:42 adam Exp $ -->
  <title>Example Configurations</title>
 
  <sect1>
@@ -10,7 +10,7 @@
    driven by a master configuration file, which may refer to other
    subsidiary configuration files.  By default, they try to use
    <filename>zebra.cfg</filename> in the working directory as the
-   master file; but this can be changed using the <literal>-t</literal>
+   master file; but this can be changed using the <literal>-c</literal>
    option to specify an alternative master configuration file.
   </para>
   <para>
@@ -76,7 +76,7 @@
    minimal file that just tells <literal>zebraidx</literal> where to
    find the default indexing rules, and how to parse the records:
    <screen>
-    profilePath: .:../../tab:../../../yaz/tab
+    profilePath: .:../../tab
     recordType: grs.sgml
    </screen>
   </para>
@@ -125,12 +125,11 @@
       was perhaps the tallest. With its head raised, it stood 60 feet (nearly
       20 m) tall. &lt;/P&gt;
      &lt;/ESSAY&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;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;
    </screen>
   </para>
@@ -147,7 +146,9 @@
    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, we had to formulate a complex XPath 
+   author
+   (<foreignphrase role="taxon">Sauroposeidon proteles</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
@@ -182,8 +183,8 @@
    and well defined.
   </para>
   <para>
-   For convenience, access points are gathered into <define>attribute
-   sets</define>.  For example, the BIB-1 attribute set is supposed to
+   For convenience, access points are gathered into <firstterm>attribute
+   sets</firstterm>.  For example, the BIB-1 attribute set is supposed to
    contain bibliographic access points such as author, title, subject
    and ISBN; the GEO attribute set contains access points pertaining
    to geospatial information (bounding box, ###, etc.); the CIMI
@@ -216,64 +217,26 @@
    want to support the BIB-1 attribute set.  Then we need to tell it
    which elements of its record pertain to access point 1003.
   </para>
- </sect1>
-</chapter>
-
-
-<!--
   <para>
-   You may have noticed as <literal>zebraidx</literal> was building
-   the database that it issued a warning, which we ignored at the
-   time:
-   <screen>
-    $ zebraidx update records
-    00:45:46-08/10: ../../index/zebraidx(5016) [warn] records/genera.xml:0 Couldn't open GENUS.abs [No such file or directory]
-   </screen>
-   FIXME ### This needs more text
+   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:
   </para>
--->
-
-<!--
-
+  <itemizedlist>
    <listitem>
     <para>
-     The master configuration file, <literal>zebra.cfg</literal>,
-     which is as short and simple as it can be:
-     <screen>
-	# $Header: /home/cvsroot/idis/doc/examples.xml,v 1.9 2002-10-16 20:33:31 mike Exp $
-	# Bare-bones master configuration file for Zebra
-	profilePath: .:../../tab:../../../yaz/tab
-     </screen>
-     Apart from the comments, which are ignored, all this specifies is
-     that the server should recognise the attribute set described in
-     the file called
-     <literal>bib1.att</literal>.
-     ### What is an attribute set?
+     
     </para>
    </listitem>
-
    <listitem>
     <para>
-     The BIB-1 attribute set configuration file,
-     <literal>bib1.att</literal>, which is also as short as possible:
-     <screen>
-	# $Header: /home/cvsroot/idis/doc/examples.xml,v 1.9 2002-10-16 20:33:31 mike Exp $
-	# Bare-bones BIB-1 attribute set file for Zebra
-	reference Bib-1
-     </screen>
-     Apart from the comments, all this specifies is that reference of
-     the attribute set described by this file is
-     <literal>Bib-1</literal>, a name recognised by the system as
-     referring to a well-known opaque identifier that is transmitted
-     by clients as part of their searches.
-     ### Yeuch!  Surely we can say that better!
-    </para>
-    <para>
-     ### Can't we somehow say this trivial thing in the main
-     configuration file?
     </para>
    </listitem>
--->
+  </itemizedlist>
+ </sect1>
+</chapter>
+
 
 <!--
 	The simplest hello-world example could go like this:
@@ -326,7 +289,7 @@ How to include images:
 	  </caption>
 	</mediaobject>
 
-Whene the three <*object> thingies inside the top-level <mediaobject>
+Where the three <*object> thingies inside the top-level <mediaobject>
 are decreasingly preferred version to include depending on what the
 rendering engine can handle.  I generated the EPS version of the image
 by exporting a line-drawing done in TGIF, then converted that to the