From: Mike Taylor Date: Fri, 30 Aug 2002 01:17:10 +0000 (+0000) Subject: Revise and expand examples.xml based on experiments with minimal X-Git-Tag: ZEBRA.1.3.2~27 X-Git-Url: http://sru.miketaylor.org.uk/cgi-bin?a=commitdiff_plain;h=bffe964768496135023ab242d6b468558fa1c2be;p=idzebra-moved-to-github.git Revise and expand examples.xml based on experiments with minimal configuration. Fix automake stuff to recognise examples.xml --- diff --git a/doc/Makefile.am b/doc/Makefile.am index c59e78f..3950d94 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.10 2002-06-02 19:30:07 adam Exp $ +## $Id: Makefile.am,v 1.11 2002-08-30 01:17:10 mike Exp $ docdir=$(datadir)/doc/@PACKAGE@ doc_DATA = zebra.html zebra.pdf @@ -13,6 +13,7 @@ XMLFILES = \ introduction.xml \ installation.xml \ quickstart.xml \ + examples.xml \ administration.xml \ zebraidx.xml \ server.xml \ @@ -53,4 +54,4 @@ dist-hook: zebra.html clean-data-hook: rm -f [0-9]* *.bak - + diff --git a/doc/examples.xml b/doc/examples.xml index 3a49b6c..2735cb2 100644 --- a/doc/examples.xml +++ b/doc/examples.xml @@ -1,5 +1,5 @@ - + Example Configurations @@ -44,84 +44,54 @@ - First Example: Minimal Configuration + Example 1: Minimal Configuration - This example shows how Zebra can be used, with absolutely minimal - configuration, to index a body of XML documents, and search them + This example shows how Zebra can be used with absolutely minimal + configuration to index a body of XML documents, and search them using XPath expressions to specify access points. - Go to the - zebra/examples/dinosauricon - directory. There you will find two significant files: + Go to the zebra/examples/dinosauricon directory. + There you will find a records subdirectory, + which contains some raw XML data to be added to the database: in + this case, two files, genera.xml and + taxa.xml, which contain information about all + the known dinosaur genera as of August 2002. + + + Now we need to create the Zebra database, which we do with the + Zebra indexer, zebraidx. This program's + behaviour is driven by a configuration life, generally called + zebra.cfg, although this can be changed with the + -c option. For our purposes, we don't need any + special behaviour - we can use the defaults - so an empty + configuration will do just fine. We can either create an empty + zebra.cfg or specify the name of an existing + empty file using, for example, -c /dev/null. + + + In this case, we'll use an empty zebra.cfg so + we can add more configuration to it later. - - - - - The records subdirectory, which contains the - raw XML data to be added to the database: in this case, just one - file, genera.xml, which contains information - about all the known dinosaur genera as of October 2000. - - - - - - - The master configuration file, zebra.cfg, - which is as short and simple as it can be: - - - # $Header: /home/cvsroot/idis/doc/examples.xml,v 1.2 2002-08-29 16:30:22 mike Exp $ - # Bare-bones master configuration file for Zebra - profilePath: .:../../tab:../../../yaz/tab - - Apart from the comments, which are ignored, all this specifies is - that the server should recognise the attribute set described in - the file called - bib1.att. - - - - - - - That's all you need for a minimal Zebra configuration. Now you can roll the XML records into the database and build the indexes: zebraidx -t grs.sgml update records - - and start the server which, by default listens on port 9999: + (### What does "grs.sgml" actually mean?) + + + Now start the server. Like the indexer, its behaviour is + controlled by a configuration file, generally + zebra.cfg; and like the indexer, it works just + fine with an empty configuration. zebrasrv + By default, the server listens on IP port number 9999, although + this can easily be changed. Now you can use the Z39.50 client program of your choice to execute @@ -151,10 +121,81 @@ <idzebra:size>359</idzebra:size><idzebra:localnumber>447</idzebra:localnumber><idzebra:filename>records/genera.xml</idzebra:filename></GENUS> + + Now wasn't that easy? + + + Example 2: Adding Some Configuration + + + You may have noticed as zebraidx was building + the database that it issued several warnings, which we ignored at + the time: + +zebraidx -t grs.sgml update records +02:12:32-30/08: zebraidx(18151) [warn] default.idx [No such file or directory] +02:12:32-30/08: zebraidx(18151) [warn] Couldn't open explain.abs [No such file or directory] +02:12:32-30/08: zebraidx(18151) [warn] records/genera.xml:0 Couldn't open GENUS.abs [No such file or directory] +02:12:32-30/08: zebraidx(18151) [warn] records/genera.xml:0 Unknown register type: 0 +02:12:32-30/08: zebraidx(18151) [warn] records/genera.xml:0 Unknown register type: w +02:12:35-30/08: zebraidx(18151) [warn] records/taxa.xml:0 Couldn't open TAXON.abs [No such file or directory] + + And the server issued several more as the client connected to it, + then searched for and retrieved a record: + +02:17:10-30/08: zebrasrv(18165) [warn] default.idx [No such file or directory] +02:17:10-30/08: zebrasrv(18165) [warn] Couldn't open explain.abs [No such file or directory] +02:17:57-30/08: zebrasrv(18165) [warn] Unknown register type: w +02:18:42-30/08: zebrasrv(18165) [warn] Couldn't open GENUS.abs [No such file or directory] + + + + + + Introduction @@ -222,6 +222,62 @@ + + Various web indexes diff --git a/doc/zebra.xml.in b/doc/zebra.xml.in index e3032ce..d08de6f 100644 --- a/doc/zebra.xml.in +++ b/doc/zebra.xml.in @@ -1,10 +1,10 @@ + @@ -12,7 +12,7 @@ ]> - + Zebra - User's Guide and Reference @@ -50,10 +50,10 @@ - &chap-examples; &chap-introduction; &chap-installation; &chap-quickstart; + &chap-examples; &chap-administration; &chap-zebraidx; &chap-server; diff --git a/examples/dinosauricon/README b/examples/dinosauricon/README index 269c057..5bd1a48 100644 --- a/examples/dinosauricon/README +++ b/examples/dinosauricon/README @@ -12,3 +12,6 @@ always get the up-to-date version from http://dinosauricon.com/data/ (These were current at Thu Aug 29 17:11:27 BST 2002) + +Search in this database with XPath queries like: + @attr 1=/GENUS/MEANING bird