added acronyme entities

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

diff --git a/doc/examples.xml b/doc/examples.xml
index 9ceab4d..a2c2ab3 100644 (file)
--- a/doc/examples.xml
+++ b/doc/examples.xml
@@ -1,12 +1,13 @@
 <chapter id="examples">
- <!-- $Id: examples.xml,v 1.21 2006-04-25 12:26:26 marc Exp $ -->
+ <!-- $Id: examples.xml,v 1.25 2007-02-02 09:58:39 marc Exp $ -->
  <title>Example Configurations</title>
 
- <sect1>
+ <sect1 id="examples-overview">
   <title>Overview</title>
 
   <para>
-   <literal>zebraidx</literal> and <literal>zebrasrv</literal> are both
+   <command>zebraidx</command> and 
+   <command>zebrasrv</command> are both
    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
@@ -14,7 +15,7 @@
    option to specify an alternative master configuration file.
   </para>
   <para>
-   The master configuration file tells Zebra:
+   The master configuration file tells &zebra;:
    <itemizedlist>
 
     <listitem>
@@ -63,11 +64,11 @@
   <title>Example 1: XML Indexing And Searching</title>
 
   <para>
-   This example shows how Zebra can be used with absolutely minimal
+   This example shows how &zebra; can be used with absolutely minimal
    configuration to index a body of
-   <ulink url="http://www.w3.org/XML/">XML</ulink>
+   <ulink url="&url.xml;">XML</ulink>
    documents, and search them using
-   <ulink url="http://www.w3.org/TR/xpath">XPath</ulink>
+   <ulink url="&url.xpath;">XPath</ulink>
    expressions to specify access points.
   </para>
   <para>
@@ -87,13 +88,13 @@
    would you?  :-)
   </para>
   <para>
-   Now we need to create a Zebra database to hold and index the XML
+   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
+   &zebra; indexer, <command>zebraidx</command>, which is
    driven by the <literal>zebra.cfg</literal> configuration file.
    For our purposes, we don't need any
    special behaviour - we can use the defaults - so we can start with a
-   minimal file that just tells <literal>zebraidx</literal> where to
+   minimal file that just tells <command>zebraidx</command> where to
    find the default indexing rules, and how to parse the records:
    <screen>
     profilePath: .:../../tab
@@ -101,7 +102,7 @@
    </screen>
   </para>
   <para>
-   That's all you need for a minimal Zebra configuration.  Now you can
+   That's all you need for a minimal &zebra; configuration.  Now you can
    roll the XML records into the database and build the indexes:
    <screen>
     zebraidx update records
@@ -175,7 +176,7 @@
    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 different taxonomy
+   representations are different.  Consider a different 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
@@ -192,8 +193,8 @@
    said about implementation: in a given database, an access point
    might be implemented as an index, a path into physical records, an
    algorithm for interrogating relational tables or whatever works.
-   The only important thing point is that the semantics of an access
-   point are fixed and well defined.
+   The only important thing is that the semantics of an access
+   point is fixed and well defined.
   </para>
   <para>
    For convenience, access points are gathered into <firstterm>attribute
@@ -217,9 +218,9 @@
    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="ftp://ftp.loc.gov/pub/z3950/defs/bib1.txt"
-       >The BIB-1 Attribute Set Semantics</ulink>)
+   access point 4.  (See 
+   <ulink url="&url.z39.50.bib1.semantics;">The BIB-1 Attribute
+    Set Semantics</ulink>)
    So we need to configure our dinosaur database so that searches for
    BIB-1 access point 4 look in the 
    <literal>&lt;termName&gt;</literal> element,
@@ -227,7 +228,7 @@
    <literal>&lt;Zthes&gt;</literal> element.
   </para>
   <para>
-   This is a two-step process.  First, we need to tell Zebra that we
+   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 4.
    </para>
@@ -270,7 +271,7 @@ xelm /Zthes/termModifiedBy      termModifiedBy:w
     <callout arearefs="attset.attset">
      <para>
       Declare Bib-1 attribute set. See <filename>bib1.att</filename> in
-      Zebra's <filename>tab</filename> directory.
+      &zebra;'s <filename>tab</filename> directory.
      </para>
     </callout>
     <callout arearefs="termId">
@@ -374,7 +375,7 @@ 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
 GIF using a shell-script called "epstogif" which used an appallingly
 baroque sequence of conversions, which I would prefer not to pollute
-the Zebra build environment with:
+the &zebra; build environment with:
 
        #!/bin/sh