Clarify role of XSD and zeerex2index.xsl

[irspy-moved-to-github.git] / zebra / README

diff --git a/zebra/README b/zebra/README
index 0f4d431..6d757e8 100644 (file)
--- a/zebra/README
+++ b/zebra/README
@@ -1,4 +1,4 @@
-$Id: README,v 1.7 2006-05-12 16:26:53 mike Exp $
+$Id: README,v 1.13 2006-10-10 12:53:29 mike Exp $

 
 What's what in this directory:
 
 
 What's what in this directory:
 

@@ -20,14 +20,26 @@ 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
 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
        supplied in the YAZ distribution: we'd just use that if there
        was a reliable way to discover where it is.
 
 
 pqf.properties -- The specification for how CQL queries are translated
        into 39.50 Type-1 queries.  This file is identical to the one
        supplied in the YAZ distribution: we'd just use that if there
        was a reliable way to discover where it is.
 

+ezeerex2pqfproperties.pl -- An in-progress script to automatically
+       generate the pqf.properties file from an extended ZeeRex
+       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.
 zebra.cfg -- Zebra-specific configuration, including the location of
        the register files, the location of the XSLT filter
        configuration (filterconf.xml), etc.

@@ -36,11 +48,20 @@ 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.
 
        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.
 
 
 zeerex2zeerex.xsl -- The "no-op" stylesheet for presenting ZeeRex
        records.
 

+zeerex2id.xsl -- A trivial stylesheet that just yields the record
+       identifier (not as an XML document).
+
+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
        target-test database using
 records -- A subdirectory containing ZeeRex records to be added to the
        database.  These were harvested from Index Data's existing
        target-test database using

@@ -53,20 +74,18 @@ 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
        dictionaries and suchlike.
 
 form.html -- a simple HTML search form that submits SRU queries to a

-       server running on local port 1313.
+       server running on local port 3313.

 
 --
 
 To create the database and start the server:
 
 
 --
 
 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 zeerex.xml # The single record describe this DB, or:
+zebraidx-2.0 update records # The many records harvested from Index Data
+zebraidx-2.0 commit
+zebrasrv-2.0 -f yazserver.xml

 
 Then interrogate the database with SRU URLs such as:
 
 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
+       http://localhost:3313/IR-Explain---1?version=1.1&operation=searchRetrieve&maximumRecords=10&recordSchema=zeerex&query=net.protocol=sru