X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fexamples.xml;fp=doc%2Fexamples.xml;h=dc95e1209e282683562398be4d2d60677b984d0c;hb=c50b7223e10de52e713be64559129ea89e8ed601;hp=10cbeb58febd5ce8e0075633154ddf8cae541340;hpb=ab80ea375b1c9356f49b160a3b1ab76f468546b5;p=idzebra-moved-to-github.git diff --git a/doc/examples.xml b/doc/examples.xml index 10cbeb5..dc95e12 100644 --- a/doc/examples.xml +++ b/doc/examples.xml @@ -1,5 +1,5 @@ - + Example Configurations @@ -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. @@ -69,6 +81,10 @@ 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 a Zebra database to hold and index the XML @@ -76,7 +92,7 @@ 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: @@ -108,7 +124,7 @@ 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=/Zthes/termName Sauroposeidon Number of hits: 1 @@ -118,6 +134,7 @@ <termId>22</termId> <termName>Sauroposeidon</termName> <termType>PT</termType> + <termNote>The tallest known dinosaur (18m)</termNote> <relation> <relationType>BT</relationType> <termId>21</termId> @@ -126,7 +143,7 @@ </relation> <idzebra xmlns="http://www.indexdata.dk/zebra/"> - <size>245</size> + <size>300</size> <localnumber>23</localnumber> <filename>records/dino.xml</filename> </idzebra> @@ -134,7 +151,7 @@ - Now wasn't that easy? + Now wasn't that nice and easy? @@ -158,7 +175,7 @@ significantly because it ties searching semantics to the physical structure of the searched records. You can't use the same search specification to search two databases if their internal - representations are different. Consider an alternative taxonomy + representations are different. Consider an different taxonomy database in which the records have taxon names specified inside a <name> element nested within a <identification> element @@ -175,8 +192,8 @@ said about implementation: in a given database, an access point might be implemented as an index, a path into physical records, an algorithm for interrogating relational tables or whatever works. - The key point is that the semantics of an access point are fixed - and well defined. + The only important thing point is that the semantics of an access + point are fixed and well defined. For convenience, access points are gathered into attribute @@ -192,7 +209,7 @@ In practice, the BIB-1 attribute set has tended to be a dumping ground for all sorts of access points, so that, for example, it includes some geospatial access points as well as strictly - bibliographic ones. Nevertheless, the key point is that this model + bibliographic ones. Nevertheless, this model allows a layer of abstraction over the physical representation of records in databases. @@ -210,6 +227,11 @@ <Zthes> element. + ### Here's where it all goes to pieces. The current arrangement is + very awkward (and somewhat embarrassing) to describe, and the new + arrangement hasn't actually been implemented yet. + + This is a two-step process. First, we need to tell Zebra that we want to support the BIB-1 attribute set. Then we need to tell it which elements of its record pertain to access point 4.