X-Git-Url: http://git.indexdata.com/?p=irspy-moved-to-github.git;a=blobdiff_plain;f=zebra%2FREADME;h=115052675d6ba54abe5aef903e6d28771c3e5f20;hp=fff099faaf10c97405e8875f862bca898a3443dc;hb=c3b677b486231af13e176e4469a0178fdb1898fa;hpb=7997cc43ead24da7f35ce3d12fe3a07589bcbc41 diff --git a/zebra/README b/zebra/README index fff099f..1150526 100644 --- a/zebra/README +++ b/zebra/README @@ -1,4 +1,4 @@ -$Id: README,v 1.12 2006-09-20 13:19:54 mike Exp $ +$Id: README,v 1.18 2007-03-29 17:13:23 mike Exp $ What's what in this directory: @@ -20,8 +20,14 @@ zeerex.xml -- The static ZeeRex record for this database of ZeeRex zeerex-2.0.xsd -- The XML Schema describing ZeeRex records, as downloaded from the official ZeeRex site at: http://explain.z3950.org/dtd/zeerex-2.0.xsd - This can be used to validate both our own static ZeeRex record - and the records created by IRSpy. + Originally, this was used to validate both our own static + ZeeRex record and the records created by IRSpy, using: + xmllint --noout --schema zeerex-2.0.xsd zeerex.xml + However, it can no longer be used for this purpose, as the + records now carry IRSpy-specific extensions that the schema + does not understand. Eventually a new schema (most likely in + Relax NG Compact format) will be created for validation of the + extendd records. pqf.properties -- The specification for how CQL queries are translated into 39.50 Type-1 queries. This file is identical to the one @@ -38,15 +44,22 @@ 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. -zeerex2index.xsl -- The indexing stylesheet for ZeeRex records. +zeerex2index.xsl -- The indexing stylesheet for ZeeRex records. It's + possible to check what indexer will see as follows: + xsltproc zeerex2index.xsl zeerex.xml 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). @@ -65,21 +78,31 @@ records -- A subdirectory containing ZeeRex records to be added to the 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: -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 # The single record describe this DB, or: -zebraidx update records # The many records harvested from Index Data -zebraidx commit -zebrasrv -f yazserver.xml +zebraidx-2.0 init # Remove any existing database records +zebraidx-2.0 update records2 # The many records harvested from Index Data +zebraidx-2.0 update records3 # Extra records supplied by Per +zebraidx-2.0 commit +zebrasrv-2.0 -f yazserver.xml + +To run all these commands, use: +sed -n '/^zebraidx/,+3p' README | while read line; do eval $line; done 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 + http://localhost:8018/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru