1 $Id: README,v 1.12 2006-09-20 13:19:54 mike Exp $
3 What's what in this directory:
7 yazserver.xml -- The primary configuration file that controls how
8 Zebra runs (as a YAZ GFS application) in order to serve the
9 ZeeRex database. This specifies where to find this database's
10 own ZeeRex record (zeerex.xml), the configuration for
11 translating CQL queries into Z39.50 Type-1 (pqf.properties),
12 and the Zebra-specific configuration (zebra.cfg).
14 zeerex.xml -- The static ZeeRex record for this database of ZeeRex
15 records. It describes what a ZeeRex database looks like, and
16 how it behaves. (Life would be better if Zebra could at least
17 partially work this out for itself, but for now we have to go
20 zeerex-2.0.xsd -- The XML Schema describing ZeeRex records, as
21 downloaded from the official ZeeRex site at:
22 http://explain.z3950.org/dtd/zeerex-2.0.xsd
23 This can be used to validate both our own static ZeeRex record
24 and the records created by IRSpy.
26 pqf.properties -- The specification for how CQL queries are translated
27 into 39.50 Type-1 queries. This file is identical to the one
28 supplied in the YAZ distribution: we'd just use that if there
29 was a reliable way to discover where it is.
31 ezeerex2pqfproperties.pl -- An in-progress script to automatically
32 generate the pqf.properties file from an extended ZeeRex
33 record. Not yet in use. A Makefile controls the use of this
34 script to generate "terse.properties", which may be, but is
35 not, used in place of "pqf.properties".
37 zebra.cfg -- Zebra-specific configuration, including the location of
38 the register files, the location of the XSLT filter
39 configuration (filterconf.xml), etc.
41 filterconf.xml -- Configuration of Zebra's XSLT filter, which uses
42 XSLT stylesheets to identify the indexable data in incoming
43 files and to transform records for presentation.
45 zeerex2index.xsl -- The indexing stylesheet for ZeeRex records.
47 zeerex2zeerex.xsl -- The "no-op" stylesheet for presenting ZeeRex
50 zeerex2id.xsl -- A trivial stylesheet that just yields the record
51 identifier (not as an XML document).
53 profile -- Notes on the indexes in the ZeeRex profile, with
54 indications of whether they are yet supported by the Zebra
55 configuration in this directory.
57 records -- A subdirectory containing ZeeRex records to be added to the
58 database. These were harvested from Index Data's existing
59 target-test database using
60 scp -r bagel.indexdata.dk:/home/perhans/targettest/xml records
61 processed to add the missing namespace, and archived into a
62 single file records.tar.gz, which needs to be unpacked:
63 tar xfz records.tar.gz
65 db -- A subdirectory containing the actual database: register files,
66 dictionaries and suchlike.
68 form.html -- a simple HTML search form that submits SRU queries to a
69 server running on local port 3313.
73 To create the database and start the server:
75 xmllint --noout --schema zeerex-2.0.xsd zeerex.xml # Verify
76 xsltproc zeerex2index.xsl zeerex.xml # Check what indexer will see
77 zebraidx init # Remove any existing database records
78 zebraidx update zeerex.xml # The single record describe this DB, or:
79 zebraidx update records # The many records harvested from Index Data
81 zebrasrv -f yazserver.xml
83 Then interrogate the database with SRU URLs such as:
84 http://localhost:3313/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru