X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fexamples.xml;h=dc95e1209e282683562398be4d2d60677b984d0c;hb=d46ae7055fcdac3336decda8d8ed50eb5c25ffd9;hp=53f839da4673da6c05f084e3e9870b5168a13d66;hpb=528edc9943ba3311a40b4ab875c0bc9aca5caa87;p=idzebra-moved-to-github.git diff --git a/doc/examples.xml b/doc/examples.xml index 53f839d..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,23 +19,35 @@ - Where to find subsidiary configuration files, including - 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. - What attribute sets to recognise in searches. + 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.) - Policy details such as what record type to expect, what - low-level indexing algorithm to use, how to identify potential - duplicate records, etc. + 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. @@ -53,30 +65,38 @@ This example shows how Zebra can be used with absolutely minimal configuration to index a body of - XML + XML documents, and search them using - XPath + XPath expressions to specify access points. - Go to the examples/dinosauricon subdirectory + Go to the examples/zthes subdirectory of the distribution archive. - There you will find a records subdirectory, - which contains some raw XML data to be added to the database: in - this case, as single file, genera.xml, - which contain information about all the known dinosaur genera as of - August 2002. + 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? :-) - Now we need to create the Zebra database, which we do with the + 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 start with a + 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:../../../yaz/tab + profilePath: .:../../tab recordType: grs.sgml @@ -104,97 +124,138 @@ XPath-based boolean queries and fetch the XML records that satisfy them: - $ yaz-client tcp:@:9999 + $ yaz-client @:9999 Connecting...Ok. - Z> find @attr 1=/GENUS/MEANING @and lizard earthquakes + Z> find @attr 1=/Zthes/termName Sauroposeidon Number of hits: 1 Z> format xml Z> show 1 - <GENUS name="Sauroposeidon" type="with"> - <MEANING>lizard Poseidon <LOW>(Greek god of, among other things, earthquakes)</LOW></MEANING> - <SPECIES name="proteles"> - <AUTHOR type="vide" name="Franklin" year="2000"></AUTHOR> - <AUTHOR name="Wedel, Cifelli, Sanders"></AUTHOR> - </SPECIES> - <PLACE name="Oklahoma"></PLACE> - <TIME value="Albian"></TIME> - <LENGTH value="30" q="1"></LENGTH> - <REMAINS content="rib, cervical vertebrae"></REMAINS> - <ESSAY> - <P> This new <NOMEN name="Brachiosaurus"></NOMEN>-like <LINK content="dinosaur"></LINK> - was perhaps the tallest. With its head raised, it stood 60 feet (nearly - 20 m) tall. </P> - </ESSAY> + <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>593</size> - <localnumber>891</localnumber> - <filename>records/genera.xml</filename> + <size>300</size> + <localnumber>23</localnumber> + <filename>records/dino.xml</filename> </idzebra> - </GENUS> + </Zthes> - Now wasn't that easy? + Now wasn't that nice and easy? + - Example 2: Supporting Z39.50 Searches + Example 2: Supporting Interoperable Searches - You may have noticed as zebraidx was building - the database that it issued a warning, which we ignored at the - time: - - $ zebraidx update records - 00:45:46-08/10: ../../index/zebraidx(5016) [warn] records/genera.xml:0 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. - - - - + + + +