No reference to yaz/tab in manual or zebra.cfg's.

[idzebra-moved-to-github.git] / doc / examples.xml

diff --git a/doc/examples.xml b/doc/examples.xml
index ab8b64a..4805c29 100644 (file)
--- a/doc/examples.xml
+++ b/doc/examples.xml
@@ -1,5 +1,5 @@
 <chapter id="examples">
- <!-- $Id: examples.xml,v 1.10 2002-10-17 08:10:08 mike Exp $ -->
+ <!-- $Id: examples.xml,v 1.14 2002-10-30 13:59: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>
@@ -147,7 +147,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
@@ -216,6 +218,12 @@
    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>
+  <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:
+  </para>
   <itemizedlist>
    <listitem>
     <para>
@@ -232,39 +240,6 @@
 
 
 <!--
-  <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
-  </para>
--->
-
-<!--
-
-   <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.10 2002-10-17 08:10:08 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>
--->
-
-<!--
        The simplest hello-world example could go like this:
        
        Index the document
@@ -315,7 +290,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