From 25a37c9be836f891281688788a7a1f967ea2b2cb Mon Sep 17 00:00:00 2001 From: Mike Taylor Date: Thu, 17 Oct 2002 08:10:08 +0000 Subject: [PATCH] Rolling commit. There's a little more prose in the developing "examples" chapter, and minor tweaks here and there to the other files, mostly just fixing typos and suchlike. --- doc/administration.xml | 19 ++++++++++++++----- doc/examples.xml | 41 +++++++++++++++-------------------------- doc/introduction.xml | 27 ++++++++++++++++++++++----- doc/recordmodel.xml | 30 +++++++++++++++--------------- doc/server.xml | 5 +++-- doc/zebraidx.xml | 3 ++- 6 files changed, 71 insertions(+), 54 deletions(-) diff --git a/doc/administration.xml b/doc/administration.xml index 5e3b545..1c8df0e 100644 --- a/doc/administration.xml +++ b/doc/administration.xml @@ -1,7 +1,13 @@ - + Administrating Zebra - + + Unlike many simpler retrieval systems, Zebra supports safe, incremental updates to an existing index. @@ -203,6 +209,7 @@ group of records. If you plan to update/delete this type of records later this should be specified as 1; otherwise it should be 0 (default), to save register space. + See . @@ -222,6 +229,7 @@ + register: register-location @@ -253,7 +261,7 @@ keyTmpDir: directory - Directory in which temporary files used during zebraidx' update + Directory in which temporary files used during zebraidx's update phase are stored. @@ -329,8 +337,9 @@ That is, when a client wishes to retrieve a record following a search operation, the files are accessed from the place where you originally put them - if you remove the files (without - running zebraidx again, the client - will receive a diagnostic message. + running zebraidx again, the server will return + diagnostic number 14 (``System error in presenting records'') to + the client. diff --git a/doc/examples.xml b/doc/examples.xml index 86d8c59..ab8b64a 100644 --- a/doc/examples.xml +++ b/doc/examples.xml @@ -1,5 +1,5 @@ - + Example Configurations @@ -182,8 +182,8 @@ and well defined. - For convenience, access points are gathered into attribute - sets. For example, the BIB-1 attribute set is supposed to + For convenience, access points are gathered into attribute + sets. For example, the BIB-1 attribute set is supposed to contain bibliographic access points such as author, title, subject and ISBN; the GEO attribute set contains access points pertaining to geospatial information (bounding box, ###, etc.); the CIMI @@ -216,6 +216,17 @@ want to support the BIB-1 attribute set. Then we need to tell it which elements of its record pertain to access point 1003. + + + + + + + + + + + @@ -240,7 +251,7 @@ The master configuration file, zebra.cfg, which is as short and simple as it can be: - # $Header: /home/cvsroot/idis/doc/examples.xml,v 1.9 2002-10-16 20:33:31 mike Exp $ + # $Header: /home/cvsroot/idis/doc/examples.xml,v 1.10 2002-10-17 08:10:08 mike Exp $ # Bare-bones master configuration file for Zebra profilePath: .:../../tab:../../../yaz/tab @@ -251,28 +262,6 @@ ### What is an attribute set? - - - - The BIB-1 attribute set configuration file, - bib1.att, which is also as short as possible: - - # $Header: /home/cvsroot/idis/doc/examples.xml,v 1.9 2002-10-16 20:33:31 mike Exp $ - # Bare-bones BIB-1 attribute set file for Zebra - reference Bib-1 - - Apart from the comments, all this specifies is that reference of - the attribute set described by this file is - Bib-1, a name recognised by the system as - referring to a well-known opaque identifier that is transmitted - by clients as part of their searches. - ### Yeuch! Surely we can say that better! - - - ### Can't we somehow say this trivial thing in the main - configuration file? - - --> + Introduction @@ -109,7 +109,13 @@ Zebra is written in portable C, so it runs on most Unix-like systems as well as Windows NT. A binary distribution for Windows NT is available at - + , + and pre-built packages are available for some Linux + distributions: + Red Hat 7.x RPMs at + + and Debian packages at + @@ -127,7 +133,17 @@ Protocol facilities: Init, Search, Present (retrieval), Segmentation (support for very large records), Delete, Scan - (index browsing), Sort, Close and some Extended Services. + (index browsing), Sort, Close and support for the ``update'' + Extended Service to add or replace an existing XML record. + @@ -315,14 +331,15 @@ announcements from the authors (new releases, bug fixes, etc.) and general discussion. You are welcome to seek support there. Join by sending email to - zebra-request@indexdata.dk. Put the word 'subscribe' - in the body of the message. + zebra-request@indexdata.dk. Put the word + subscribe in the body of the message. Third, it's possible to buy a commercial support contract, with well defined service levels and response times, from Index Data. See + for details. diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml index d067cfd..6ad60ed 100644 --- a/doc/recordmodel.xml +++ b/doc/recordmodel.xml @@ -1,5 +1,5 @@ - + The Record Model @@ -8,7 +8,7 @@ kind of structured data. Each record in the system is associated with a record schema which lends context to the data elements of the record. - Any number of record schema can coexist in the system. + Any number of record schemas can coexist in the system. Although it may be wise to use only a single schema within one database, the system poses no such restrictions. @@ -16,7 +16,7 @@ The record model described in this chapter applies to the fundamental, structured - record type grs as introduced in + record type grs, introduced in . + The Z39.50 Server @@ -235,7 +235,7 @@ - The server has full support for piggy-backed present requests (see + The server has full support for piggy-backed retrieval (see also the following section). @@ -258,6 +258,7 @@ A phrase register is created for those fields in the .abs file that contains a p-specifier. + diff --git a/doc/zebraidx.xml b/doc/zebraidx.xml index 9cad1f5..9c1c0ce 100644 --- a/doc/zebraidx.xml +++ b/doc/zebraidx.xml @@ -1,5 +1,5 @@ - + Running the Maintenance Interface (zebraidx) @@ -17,6 +17,7 @@ Options: &zebraidx-options; + Commands -- 1.7.10.4