1 $Id: README,v 1.2 2006-04-18 23:50:33 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 zebra.cfg -- Zebra-specific configuration, including the location of
32 the register files, the location of the XSLT filter
33 configuration (filterconf.xml), etc.
35 filterconf.xml -- Configuration of Zebra's XSLT filter, which uses
36 XSLT stylesheets to identify the indexable data in incoming
37 files and to transform records for presentation.
39 zeerex2index.xsl -- The indexing stylesheet for ZeeRex records.
41 zeerex2zeerex.xsl -- The "no-op" stylesheet for presenting ZeeRex
44 db -- A subdirectory containing the actual database: register files,
45 dictionaries and suchlike.
49 To create the database and start the server:
51 xmllint --noout --schema zeerex-2.0.xsd zeerex.xml # Verify
52 xsltproc zeerex2index.xsl zeerex.xml # Check what indexer will see
53 zebraidx init # Remove any existing database records
54 zebraidx update zeerex.xml # Our only record!
56 zebrasrv -f yazserver.xml
58 Then interrogate the database with SRU URLs such as:
59 http://localhost:1313/IR-Explain--1?version=1.1&operation=searchRetrieve&x-pquery=@attr%201=net:host%20localhost