From 2c0ee3249ef46031064a0e8e7d63bd400317f5e9 Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Thu, 16 Feb 2006 16:50:18 +0000 Subject: [PATCH] more info, some SRU examples, etc .. --- doc/Makefile.am | 6 +- doc/administration.xml | 86 ++++++++- doc/architecture.xml | 474 +++++------------------------------------------- doc/server.xml | 98 +++++++--- 4 files changed, 204 insertions(+), 460 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index 3e44826..285f271 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.38 2006-02-16 15:13:25 marc Exp $ +## $Id: Makefile.am,v 1.39 2006-02-16 16:50:18 marc Exp $ docdir=$(datadir)/doc/@PACKAGE@ SUPPORTFILES = \ @@ -30,7 +30,8 @@ XMLFILES = zebra.xml.in \ zebrasrv-virtual.xml -HTMLFILES = \ +HTMLFILES = \ + administration-cql-to-pqf.html \ administration-extended-services.html \ administration-ranking.html \ administration.html \ @@ -46,6 +47,7 @@ HTMLFILES = \ file-ids.html \ future.html \ generic-ids.html \ + gfs-config.html \ grs-exchange-formats.html \ grs-internal-representation.html \ indexdata.html \ diff --git a/doc/administration.xml b/doc/administration.xml index 34f938c..c0c0a99 100644 --- a/doc/administration.xml +++ b/doc/administration.xml @@ -1,5 +1,5 @@ - + Administrating Zebra + + + For example, using server-side CQL-to-PQF conversion, one might + query a zebra server like this: + + querytype cql + Z> find text=(plant and soil) + ]]> + + and - if properly configured - even static relevance ranking can + be performed using CQL query syntax: + + find text = /relevant (plant and soil) + ]]> + + + + + By the way, the same configuration can be used to + search using client-side CQL-to-PQF conversion: + (the only difference is querytype cql2rpn + instead of + querytype cql, and the call specifying a local + conversion file) + + querytype cql2rpn + Z> find text=(plant and soil) + ]]> + + + + + Exhaustive information can be found in the + Section "Specification of CQL to RPN mappings" in the YAZ manual. + + http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map, + and shall therefore not be repeated here. + + + + + diff --git a/doc/architecture.xml b/doc/architecture.xml index 0738242..1def20e 100644 --- a/doc/architecture.xml +++ b/doc/architecture.xml @@ -1,5 +1,5 @@ - + Overview of Zebra Architecture @@ -32,59 +32,6 @@ - - Indexing and Retrieval Workflow - - - Records pass through three different states during processing in the - system. - - - - - - - - - When records are accessed by the system, they are represented - in their local, or native format. This might be SGML or HTML files, - News or Mail archives, MARC records. If the system doesn't already - know how to read the type of data you need to store, you can set up an - input filter by preparing conversion rules based on regular - expressions and possibly augmented by a flexible scripting language - (Tcl). - The input filter produces as output an internal representation, - a tree structure. - - - - - - - When records are processed by the system, they are represented - in a tree-structure, constructed by tagged data elements hanging off a - root node. The tagged elements may contain data or yet more tagged - elements in a recursive structure. The system performs various - actions on this tree structure (indexing, element selection, schema - mapping, etc.), - - - - - - - Before transmitting records to the client, they are first - converted from the internal structure to a form suitable for exchange - over the network - according to the Z39.50 standard. - - - - - - - - - Main Components @@ -261,399 +208,62 @@ IDZebra filter grs.danbib (DBC DanBib records) - - - + The Z39.50 Server @@ -16,7 +16,7 @@ zebrasrv manpage --> - DESCRIPTION + Description Zebra is a high-performance, general-purpose structured text indexing and retrieval engine. It reads structured records in a variety of input formats (eg. email, XML, MARC) and allows access to them through exact @@ -36,12 +36,12 @@ - SYNOPSIS + Synopsis &zebrasrv-synopsis; - OPTIONS + Options The options for zebrasrv are the same @@ -52,19 +52,13 @@ &zebrasrv-options; - VIRTUAL HOSTS - - zebrasrv uses the YAZ server frontend and does - support multiple virtual servers behind multiple listening sockets. - - &zebrasrv-virtual; - - FILES + + Files zebra.cfg - SEE ALSO + See Also zebraidx @@ -76,18 +70,6 @@ - Section "The Z39.50 Server" in the Zebra manual. - http://www.indexdata.dk/zebra/doc/server.tkl - - - Section "Virtual Hosts" in the YAZ manual. - http://www.indexdata.dk/yaz/doc/server.vhosts.tkl - - - Section "Specification of CQL to RPN mappings" in the YAZ manual. - http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map - - The Zebra software is Copyright Index Data http://www.indexdata.dk and distributed under the @@ -762,6 +744,72 @@ and version-number specified) or with a simple HTTP GET at the server's basename. + + Unfortunately, the data found in the + CQL-to-PQF text file must be added by hand-craft into the explain + section of the YAZ Frontend Server configuration file to be able + to provide a suitable explain record. + Too bad, but this is all extreme + new alpha stuff, and a lot of work has yet to be done .. + + + There is no linkeage whatsoever between the Z39.50 explain model + and the SRU/SRW explain response (well, at least not implemented + in Zebra, that is ..). + + + + + Some SRU Examples + + Surf into http://localhost:9999 + to get an explain response, or use + + + + + + See number of hits for a query + + + + + + Fetch record 5-7 in Dublin Core format + + + + + + Even search using PQF queries using the extended naughty + verb x-pquery + + + + or scan indexes using the extended extremely naughty + verb x-pScanClause + + + + Don't do this in production code! + But it's a great fast debugging aid. + -- 1.7.10.4