1 $Id: README,v 1.21 2007-05-09 16:48:31 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 Originally, this was used to validate both our own static
24 ZeeRex record and the records created by IRSpy, using:
25 xmllint --noout --schema zeerex-2.0.xsd zeerex.xml
26 However, it can no longer be used for this purpose, as the
27 records now carry IRSpy-specific extensions that the schema
28 does not understand. Eventually a new schema (most likely in
29 Relax NG Compact format) will be created for validation of the
32 pqf.properties -- The specification for how CQL queries are translated
33 into 39.50 Type-1 queries. This file is identical to the one
34 supplied in the YAZ distribution: we'd just use that if there
35 was a reliable way to discover where it is.
37 ezeerex2pqfproperties.pl -- An in-progress script to automatically
38 generate the pqf.properties file from an extended ZeeRex
39 record. Not yet in use. A Makefile controls the use of this
40 script to generate "terse.properties", which may be, but is
41 not, used in place of "pqf.properties".
43 zebra.cfg -- Zebra-specific configuration, including the location of
44 the register files, the location of the XSLT filter
45 configuration (filterconf.xml), etc.
47 htpasswd -- Password file for the "admin" user who has permission to
48 update the database remotely.
50 filterconf.xml -- Configuration of Zebra's XSLT filter, which uses
51 XSLT stylesheets to identify the indexable data in incoming
52 files and to transform records for presentation.
54 zeerex2index.xsl -- The indexing stylesheet for ZeeRex records. It's
55 possible to check what indexer will see as follows:
56 xsltproc zeerex2index.xsl zeerex.xml
58 zeerex2zeerex.xsl -- The "no-op" stylesheet for presenting ZeeRex
61 zeerex2dc.xsl -- A stylesheet for presenting Dublin Core records.
63 zeerex2id.xsl -- A trivial stylesheet that just yields the record
64 identifier (not as an XML document).
66 profile -- Notes on the indexes in the ZeeRex profile, with
67 indications of whether they are yet supported by the Zebra
68 configuration in this directory.
70 records-2007-05-01 or similar
71 records-2007-05-01.tar.gz or similar
72 -- A subdirectory containing ZeeRex records to be added to the
73 database, and the tarball from which they were unpacked.
74 The first version was harvested from Index Data's old
75 target-test database using
76 scp -r bagel.indexdata.dk:/home/perhans/targettest/xml records
77 processed to add the missing namespace. Subsequent versions
78 have been dumped from the evolving database on
81 db -- A subdirectory containing the actual database: register files,
82 dictionaries and suchlike.
84 form.html -- A simple HTML search form that submits SRU queries to a
85 server running on local port 8018.
87 init-script -- A startup/shutdown script for controlling the zebra
88 server according to "System V init" rules. Instructions can
89 be found in the script itself.
91 crontab -- An example file that can be used to automate periodic
92 running of a test or tests. This can be installed using:
94 But you probably want to edit it first.
98 The database can be interrogated with SRU URLs such as:
99 http://localhost:8018/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru
101 To create the database:
103 tar xzf records-2007-04-18.tar.gz
105 zebraidx-2.0 update zeerex.xml