X-Git-Url: http://git.indexdata.com/?p=irspy-moved-to-github.git;a=blobdiff_plain;f=zebra%2FREADME;h=af38aa6b697a53783617a7090543a889bbd501c9;hp=cfa8a2e1a620a39d2f74fe4edb88aab9c98bbd26;hb=ec6ec60b93f0dd96858adbe76b38d4968c407931;hpb=878788c1ec348d811684e2decacb412d468fca8d diff --git a/zebra/README b/zebra/README index cfa8a2e..af38aa6 100644 --- a/zebra/README +++ b/zebra/README @@ -1,4 +1,3 @@ -$Id: README,v 1.10 2006-06-16 14:25:32 mike Exp $ What's what in this directory: @@ -20,8 +19,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 @@ -30,21 +35,30 @@ pqf.properties -- The specification for how CQL queries are translated ezeerex2pqfproperties.pl -- An in-progress script to automatically generate the pqf.properties file from an extended ZeeRex - record. Not yet in use. + 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. +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). @@ -52,32 +66,48 @@ 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 1313. +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 + +To create the database: + +$ make newdb + +or: -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 +tar xzf records-2007-04-18.tar.gz +zebraidx-2.0 init +zebraidx-2.0 update zeerex.xml +zebraidx-2.0 update records-2010-04-06 +zebraidx-2.0 commit -Then interrogate the database with SRU URLs such as: - http://localhost:1313/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru +zebrasrv-2.0 -f yazserver.xml