X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fexamples.xml;h=dc95e1209e282683562398be4d2d60677b984d0c;hb=c50b7223e10de52e713be64559129ea89e8ed601;hp=0341fd599890ba004f9d7b045f34e01ccaadc883;hpb=dda755973378f66f8f7880ac77dbacb351f02a42;p=idzebra-moved-to-github.git diff --git a/doc/examples.xml b/doc/examples.xml index 0341fd5..dc95e12 100644 --- a/doc/examples.xml +++ b/doc/examples.xml @@ -1,5 +1,5 @@ - + Example Configurations @@ -10,7 +10,7 @@ driven by a master configuration file, which may refer to other subsidiary configuration files. By default, they try to use zebra.cfg in the working directory as the - master file; but this can be changed using the -t + master file; but this can be changed using the -c option to specify an alternative master configuration file. @@ -19,182 +19,243 @@ - Where to find the default indexing rules (### default.idx) + Where to find subsidiary configuration files, including both + those that are named explicitly and a few ``magic'' files such + as default.idx, + which specifies the default indexing rules. - ### Something to do with explain.abs?! + What record schemas to support. (Subsidiary files specifiy how + to index the contents of records in those schemas, and what + format to use when presenting records in those schemas to client + software.) - ### Where to find other configuration files, e.g. searches using - BIB-1 attributes require a bib1.att configuration file (even if - the access point is actually an XPath expression). These are - searched for in the working directory unless otherwise - specified. + What attribute sets to recognise in searches. (Subsidiary files + specify how to interpret the attributes in terms + of the indexes that are created on the records.) + + + + + + Policy details such as what type of input format to expect when + adding new records, what low-level indexing algorithm to use, + how to identify potential duplicate records, etc. + + Now let's see what goes in the zebra.cfg file + for some example configurations. + - - Example 1: Minimal Configuration + + Example 1: XML Indexing And Searching This example shows how Zebra can be used with absolutely minimal - configuration to index a body of XML documents, and search them - using XPath expressions to specify access points. - - - Go to the zebra/examples/dinosauricon directory. - There you will find a records subdirectory, - which contains some raw XML data to be added to the database: in - this case, two files, genera.xml and - taxa.xml, which contain information about all - the known dinosaur genera as of August 2002. + configuration to index a body of + XML + documents, and search them using + XPath + expressions to specify access points. - Now we need to create the Zebra database, which we do with the - Zebra indexer, zebraidx. This program's - behaviour is driven by a configuration life, generally called - zebra.cfg, although this can be changed with the - -c option. For our purposes, we don't need any - special behaviour - we can use the defaults - so an empty - configuration will do just fine. We can either create an empty - zebra.cfg or specify the name of an existing - empty file using, for example, -c /dev/null. + Go to the examples/zthes subdirectory + of the distribution archive. + There you will find a Makefile that will + populate the records subdirectory with a file of + Zthes + records representing a taxonomic hierarchy of dinosaurs. (The + records are generated from the family tree in the file + dino.tree.) + Type make records/dino.xml + to make the XML data file. + (Or you could just type make to build the XML + data file, create the database and populate it with the taxonomic + records all in one shot - but then you wouldn't learn anything, + would you? :-) - In this case, we'll use an empty zebra.cfg so - we can add more configuration to it later. + Now we need to create a Zebra database to hold and index the XML + records. We do this with the + Zebra indexer, zebraidx, which is + driven by the zebra.cfg configuration file. + For our purposes, we don't need any + special behaviour - we can use the defaults - so we can start with a + minimal file that just tells zebraidx where to + find the default indexing rules, and how to parse the records: + + profilePath: .:../../tab + recordType: grs.sgml + That's all you need for a minimal Zebra configuration. Now you can roll the XML records into the database and build the indexes: - zebraidx -t grs.sgml update records + zebraidx update records - (### What does "grs.sgml" actually mean?) Now start the server. Like the indexer, its behaviour is - controlled by a configuration file, generally - zebra.cfg; and like the indexer, it works just - fine with an empty configuration. + controlled by the + zebra.cfg file; and like the indexer, it works + just fine with this minimal configuration. zebrasrv By default, the server listens on IP port number 9999, although - this can easily be changed. + this can easily be changed - see + . Now you can use the Z39.50 client program of your choice to execute XPath-based boolean queries and fetch the XML records that satisfy them: - Z> open tcp:@:9999 - Connecting...Ok. - Z> find @attr 1=/GENUS/MEANING @or vertebra jaw - Number of hits: 1 - Z> format xml - Z> show 1 - Z> show 1 - <GENUS name="Hudiesaurus" type="with" xmlns:idzebra="http://www.indexdata.dk/zebra/"> - <MEANING> - butterfly <LOW>vertebra</LOW> lizard - </MEANING> - <LENGTH value="30"></LENGTH> - <PLACE name="China"></PLACE> - <REMAINS content="4 teeth, forelimb, first dorsal vertebra"></REMAINS> - <SPECIES name="sinojapanorum" status="nudum"> - <AUTHOR name="Dong" year="1997"></AUTHOR> - <MEANING> - Chinese-Japanese - </MEANING> - </SPECIES> - <idzebra:size>359</idzebra:size><idzebra:localnumber>447</idzebra:localnumber><idzebra:filename>records/genera.xml</idzebra:filename></GENUS> + $ yaz-client @:9999 + Connecting...Ok. + Z> find @attr 1=/Zthes/termName Sauroposeidon + Number of hits: 1 + Z> format xml + Z> show 1 + <Zthes> + <termId>22</termId> + <termName>Sauroposeidon</termName> + <termType>PT</termType> + <termNote>The tallest known dinosaur (18m)</termNote> + <relation> + <relationType>BT</relationType> + <termId>21</termId> + <termName>Brachiosauridae</termName> + <termType>PT</termType> + </relation> + + <idzebra xmlns="http://www.indexdata.dk/zebra/"> + <size>300</size> + <localnumber>23</localnumber> + <filename>records/dino.xml</filename> + </idzebra> + </Zthes> - Now wasn't that easy? + Now wasn't that nice and easy? - - Example 2: Adding Some Configuration + + + Example 2: Supporting Interoperable Searches - You may have noticed as zebraidx was building - the database that it issued several warnings, which we ignored at - the time: - -zebraidx -t grs.sgml update records -02:12:32-30/08: zebraidx(18151) [warn] default.idx [No such file or directory] -02:12:32-30/08: zebraidx(18151) [warn] Couldn't open explain.abs [No such file or directory] -02:12:32-30/08: zebraidx(18151) [warn] records/genera.xml:0 Couldn't open GENUS.abs [No such file or directory] -02:12:32-30/08: zebraidx(18151) [warn] records/genera.xml:0 Unknown register type: 0 -02:12:32-30/08: zebraidx(18151) [warn] records/genera.xml:0 Unknown register type: w -02:12:35-30/08: zebraidx(18151) [warn] records/taxa.xml:0 Couldn't open TAXON.abs [No such file or directory] - - And the server issued several more as the client connected to it, - then searched for and retrieved a record: - -02:17:10-30/08: zebrasrv(18165) [warn] default.idx [No such file or directory] -02:17:10-30/08: zebrasrv(18165) [warn] Couldn't open explain.abs [No such file or directory] -02:17:57-30/08: zebrasrv(18165) [warn] Unknown register type: w -02:18:42-30/08: zebrasrv(18165) [warn] Couldn't open GENUS.abs [No such file or directory] - + The problem with the previous example is that you need to know the + structure of the documents in order to find them. For example, + when we wanted to find the record for the taxon + Sauroposeidon, + we had to formulate a complex XPath + /Zthes/termName + which embodies the knowledge that taxon names are specified in a + <termName> element inside the top-level + <Zthes> element. - - - - + + + + + +