Describe auto-genewration of PQF config.

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

diff --git a/zebra/README b/zebra/README
index 19a13db..bdb8d51 100644 (file)
--- a/zebra/README
+++ b/zebra/README
@@ -1,4 +1,4 @@
-$Id: README,v 1.2 2006-04-18 23:50:33 mike Exp $
+$Id: README,v 1.11 2006-09-13 15:36:12 mike Exp $
 
 What's what in this directory:
 
@@ -28,6 +28,12 @@ pqf.properties -- The specification for how CQL queries are translated
        supplied in the YAZ distribution: we'd just use that if there
        was a reliable way to discover where it is.
 
+ezeerex2pqfproperties.pl -- An in-progress script to automatically
+       generate the pqf.properties file from an extended ZeeRex
+       record.  Not yet in use.  A Makefile controls the use of this
+       script to generate "terse.properties", which may be, but is
+       not, used in place of "pqf.properties".
+
 zebra.cfg -- Zebra-specific configuration, including the location of
        the register files, the location of the XSLT filter
        configuration (filterconf.xml), etc.
@@ -41,9 +47,27 @@ zeerex2index.xsl -- The indexing stylesheet for ZeeRex records.
 zeerex2zeerex.xsl -- The "no-op" stylesheet for presenting ZeeRex
        records.
 
+zeerex2id.xsl -- A trivial stylesheet that just yields the record
+       identifier (not as an XML document).
+
+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
+       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
+
 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 1313.
+
 --
 
 To create the database and start the server:
@@ -51,9 +75,11 @@ To create the database and start the server:
 xmllint --noout --schema zeerex-2.0.xsd zeerex.xml # Verify
 xsltproc zeerex2index.xsl zeerex.xml # Check what indexer will see
 zebraidx init # Remove any existing database records
-zebraidx update zeerex.xml # Our only record!
+zebraidx update zeerex.xml # The single record describe this DB, or:
+zebraidx update records # The many records harvested from Index Data
 zebraidx commit
 zebrasrv -f yazserver.xml
 
 Then interrogate the database with SRU URLs such as:
-       http://localhost:1313/IR-Explain--1?version=1.1&operation=searchRetrieve&x-pquery=@attr%201=net:host%20localhost
\ No newline at end of file
+       http://localhost:1313/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru
+