Merge branch 'nigiri'

[irspy-moved-to-github.git] / zebra / README

diff --git a/zebra/README b/zebra/README
index b51c69b..2898e93 100644 (file)
--- a/zebra/README
+++ b/zebra/README
@@ -1,4 +1,4 @@
-$Id: README,v 1.14 2006-11-30 12:40:44 mike Exp $
+$Id: README,v 1.21 2007-05-09 16:48:31 mike Exp $
 
 What's what in this directory:
 
@@ -44,6 +44,9 @@ zebra.cfg -- Zebra-specific configuration, including the location of
        the register files, the location of the XSLT filter
        configuration (filterconf.xml), etc.
 
+htpasswd -- Password file for the "admin" user who has permission to
+       update the database remotely.
+
 filterconf.xml -- Configuration of Zebra's XSLT filter, which uses
        XSLT stylesheets to identify the indexable data in incoming
        files and to transform records for presentation.
@@ -55,6 +58,8 @@ zeerex2index.xsl -- The indexing stylesheet for ZeeRex records.  It's
 zeerex2zeerex.xsl -- The "no-op" stylesheet for presenting ZeeRex
        records.
 
+zeerex2dc.xsl -- A stylesheet for presenting Dublin Core records.
+
 zeerex2id.xsl -- A trivial stylesheet that just yields the record
        identifier (not as an XML document).
 
@@ -62,33 +67,47 @@ profile -- Notes on the indexes in the ZeeRex profile, with
        indications of whether they are yet supported by the Zebra
        configuration in this directory.
 
-records -- A subdirectory containing ZeeRex records to be added to the
-       database.  These were harvested from Index Data's existing
+records-2007-05-01 or similar
+records-2007-05-01.tar.gz or similar
+     -- A subdirectory containing ZeeRex records to be added to the
+       database, and the tarball from which they were unpacked.
+       The first version was harvested from Index Data's old
        target-test database using
                scp -r bagel.indexdata.dk:/home/perhans/targettest/xml records
-       processed to add the missing namespace, and archived into a
-       single file records.tar.gz, which needs to be unpacked:
-               tar xfz records.tar.gz
+       processed to add the missing namespace.  Subsequent versions
+       have been dumped from the evolving database on
+       irspy.indexdata.com.
 
 db -- A subdirectory containing the actual database: register files,
        dictionaries and suchlike.
 
-form.html -- a simple HTML search form that submits SRU queries to a
-       server running on local port 3313.
+form.html -- A simple HTML search form that submits SRU queries to a
+       server running on local port 8018.
+
+init-script -- A startup/shutdown script for controlling the zebra
+       server according to "System V init" rules.  Instructions can
+       be found in the script itself.
+
+crontab -- An example file that can be used to automate periodic
+       running of a test or tests.  This can be installed using:
+               sudo crontab crontab
+       But you probably want to edit it first.
 
 --
 
-To create the database and start the server:
+The database can be interrogated with SRU URLs such as:
+       http://localhost:8018/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru
 
-zebraidx-2.0 init # Remove any existing database records
-zebraidx-2.0 update zeerex.xml # The single record describe this DB, or:
-zebraidx-2.0 update records # The many records harvested from Index Data
-zebraidx-2.0 commit
-zebrasrv-2.0 -f yazserver.xml
+To create the database:
+
+$ make newdb
 
-To run all these commands, use:
-sed -n '/^zebraidx/,+3p' README | while read line; do eval $line; done
+or:
 
-Then interrogate the database with SRU URLs such as:
-       http://localhost:3313/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru
+tar xzf records-2007-04-18.tar.gz
+zebraidx-2.0 init
+zebraidx-2.0 update zeerex.xml
+zebraidx-2.0 update record-2010-04-06
+zebraidx-2.0 commit
 
+zebrasrv-2.0 -f yazserver.xml