From 3792780712898860435acfb9bf38c00f98cee037 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Fri, 22 Sep 2006 12:34:45 +0000 Subject: [PATCH] Updates for first-in-field support + alwaysmathces searches. Refer to native query support as RPN rather than PQF. --- doc/architecture.xml | 16 ++-- doc/examples.xml | 19 ++--- doc/field-structure.xml | 23 +++++- doc/indexdata.xml | 81 ++++++++++---------- doc/installation.xml | 10 +-- doc/introduction.xml | 122 +++++++++++------------------ doc/license.xml | 8 +- doc/querymodel.xml | 169 ++++++++++++++++++++--------------------- doc/recordmodel-alvisxslt.xml | 12 +-- 9 files changed, 220 insertions(+), 240 deletions(-) diff --git a/doc/architecture.xml b/doc/architecture.xml index 307b828..b139038 100644 --- a/doc/architecture.xml +++ b/doc/architecture.xml @@ -1,5 +1,5 @@ - + Overview of Zebra Architecture @@ -171,19 +171,19 @@ In addition to Z39.50 requests, the YAZ server frontend acts as HTTP server, honoring - SRW - SOAP requests, and - SRU - REST requests. Moreover, it can + SRU SOAP + requests, and + SRU REST + requests. Moreover, it can translate incoming CQL queries to - PQF + PQF queries, if correctly configured. - YAZ + YAZ is an Open Source toolkit that allows you to develop software using the ANSI Z39.50/ISO23950 standard for information retrieval. @@ -255,7 +255,7 @@ The Debian package libidzebra-2.0-mod-grs-xml includes the grs.xml filter which uses Expat to + url="&url.expat;">Expat to parse records in XML and turn them into IDZebra's internal GRS node trees. Have also a look at the Alvis XML/XSLT filter described in the next session. diff --git a/doc/examples.xml b/doc/examples.xml index 298df4b..d37463f 100644 --- a/doc/examples.xml +++ b/doc/examples.xml @@ -1,12 +1,13 @@ - + Example Configurations Overview - zebraidx and zebrasrv are both + zebraidx and + zebrasrv are both 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 @@ -65,9 +66,9 @@ 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. @@ -89,11 +90,11 @@ 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 + 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 + minimal file that just tells zebraidx where to find the default indexing rules, and how to parse the records: profilePath: .:../../tab @@ -217,9 +218,9 @@ In the BIB-1 attribute set, a taxon name is probably best interpreted as a title - that is, a phrase that identifies the item in question. BIB-1 represents title searches by - access point 4. (See - The BIB-1 Attribute Set Semantics) + access point 4. (See + The BIB-1 Attribute + Set Semantics) So we need to configure our dinosaur database so that searches for BIB-1 access point 4 look in the <termName> element, diff --git a/doc/field-structure.xml b/doc/field-structure.xml index 758542b..67f3224 100644 --- a/doc/field-structure.xml +++ b/doc/field-structure.xml @@ -1,5 +1,5 @@ - + Field Structure and Character Sets @@ -76,6 +76,27 @@ search containing space characters as a word proximity search. + + + firstinfield boolean + + + This directive enables or disables first-in-field indexing. + The value of the boolean should be 0 + (disable) or 1. + + + + + alwaysmatches boolean + + + This directive enables or disables alwaysmatches indexing. + The value of the boolean should be 0 + (disable) or 1. + + + charmap filename diff --git a/doc/indexdata.xml b/doc/indexdata.xml index 0843dd1..9433231 100644 --- a/doc/indexdata.xml +++ b/doc/indexdata.xml @@ -1,48 +1,47 @@ - - About Index Data and the Zebra Server - - - Index Data is a consulting and software-development enterprise that - specializes in library and information management systems. Our - interests and expertise span a broad range of related fields, and one - of our primary, long-term objectives is the development of a powerful - information management - system with open network interfaces and hyper-media capabilities. - - We make this software available free of charge, on a fairly unrestrictive - license; as a service to the networking community, and to further the - development of quality software for open network communication. - - We'll be happy to answer questions about the software, and about ourselves - in general. - - -
- Index Data ApS - Købmagergade 43, 2. - 1150 Copenhagen K - Denmark - Phone +45 3341 0100 - Fax +45 3341 0101 - Email info@indexdata.dk - - indexdata.dk -
- - - The Random House College Dictionary, 1975 edition - offers this definition of the - word "Zebra": - - - - + + About Index Data and the Zebra Server + + + Index Data is a consulting and software-development enterprise that + specializes in library and information management systems. Our + interests and expertise span a broad range of related fields, and one + of our primary, long-term objectives is the development of a powerful + information management + system with open network interfaces and hyper-media capabilities. + + We make this software available free of charge, on a fairly unrestrictive + license; as a service to the networking community, and to further the + development of quality software for open network communication. + + We'll be happy to answer questions about the software, and about ourselves + in general. + + +
+ Index Data ApS + Købmagergade 43, 2. + 1150 Copenhagen K + Denmark + Phone +45 3341 0100 + Fax +45 3341 0101 + Email info@indexdata.dk + + + +
+ + + The Random House College Dictionary, 1975 edition + offers this definition of the + word "Zebra": + + + Zebra, n., any of several horselike, African mammals of the genus Equus, having a characteristic pattern of black or dark-brown stripes on a whitish background. - - + + Installation @@ -15,7 +15,7 @@ SuSE Linux, FreeBSD (i386), MAC OSX, - SunOS 5.8 + SunOS 5.9 (sparc), Windows 2000. @@ -91,8 +91,8 @@ These tools are only required if you're writing documentation for Zebra. You need the following - Debian packages: jadetex, docbook, docbook-dsssl, - docbook-xml, docbook-utils. + Debian packages: docbook, docbook-xml, docbook-xsl, + docbook-utils, xsltproc. @@ -267,7 +267,7 @@
WIN32 The easiest way to install Zebra on Windows is by downloading an installer from - here. + here. The installer comes with source too - in case you wish to compile Zebra with different Compiler options. diff --git a/doc/introduction.xml b/doc/introduction.xml index 947b4a8..ae5df92 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,5 +1,5 @@ - + Introduction
@@ -23,8 +23,8 @@ programs and toolkits, both commercial and free, which understand this protocol. Application libraries are available to allow bespoke clients to be written in Perl, C, C++, Java, Tcl, Visual - Basic, Python, PHP and more - see - the ZOOM web site + Basic, Python, PHP and more - see the + ZOOM web site for more information on some of these client toolkits. @@ -106,9 +106,9 @@ 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 - , + as well as Windows (NT/2000/2003). A binary distribution for Windows + is available at + , and pre-built packages are available for GNU/Debian Linux at - . + . @@ -215,13 +215,12 @@ alvis filter module. - - - Additional PQF query syntax for - searchRetrieve - and scan operations is supported. + + + Extended RPN queries for search/retrieve and scan are supported, + for controlling approximate hit counts, etc. - + @@ -528,37 +527,37 @@
- - -
- Support - - You can get support for Zebra from at least three sources. - - - First, there's the Zebra web site at - , - which always has the most recent version available for download. - If you have a problem with Zebra, the first thing to do is see - whether it's fixed in the current release. - - - Second, there's the Zebra mailing list. Its home page at - - includes a complete archive of all messages that have ever been - posted on the list. The Zebra mailing list is used both for - announcements from the authors (new - releases, bug fixes, etc.) and general discussion. You are welcome - to seek support there. Join by filling the form on the list home page. - - - Third, it's possible to buy a commercial support contract, with - well defined service levels and response times, from Index Data. - See - - for details. - -
+ + +
+ Support + + You can get support for Zebra from at least three sources. + + + First, there's the Zebra web site at + , + which always has the most recent version available for download. + If you have a problem with Zebra, the first thing to do is see + whether it's fixed in the current release. + + + Second, there's the Zebra mailing list. Its home page at + + includes a complete archive of all messages that have ever been + posted on the list. The Zebra mailing list is used both for + announcements from the authors (new + releases, bug fixes, etc.) and general discussion. You are welcome + to seek support there. Join by filling the form on the list home page. + + + Third, it's possible to buy a commercial support contract, with + well defined service levels and response times, from Index Data. + See + + for details. + +
@@ -586,35 +585,13 @@ XSLT transformations during indexing and record retrieval. Work on this filter has been sponsored by the ALVIS EU project . We expect this filter to - mature soon, as it is planned to be included in the version 1.4 + mature soon, as it is planned to be included in the version 2.0 release of Zebra. - Access to the search engine through SOAP/RPC API to allow the - construction of applications without requiring Z39.50 tools. - - Experimental support of the - Search/Retrieve Via URL ( SRU) - - REST webservice, and the - Search/Retrieve Web Service ( SRW) - - SOAP Web Service have recently been added to the YAZ/Zebra - combo - including server side Common Query Language (CQL) - parsing - and configuration. It remains to find a sponsor for further testing, - documentation and packaging of this exiting component. - - - - - Finalisation and documentation of Zebra's C programming API, allowing updates, database management and other functions not readily expressed in Z39.50. We will also consider @@ -624,17 +601,6 @@ - Support for the use of Perl both for access to the Zebra API - and for building extension ``plug-ins'' such as input filters. - The code for this has been contributed to the source tree by - Peter Popovics - pop@technomat.hu, - and is in the process of being integrated and tested. - - - - - Improved free-text searching. We're first and foremost octet jockeys and we're actively looking for organisations or people who'd like to contribute experience in relevance ranking and text diff --git a/doc/license.xml b/doc/license.xml index fae0454..6625d47 100644 --- a/doc/license.xml +++ b/doc/license.xml @@ -1,5 +1,5 @@ - + License @@ -24,8 +24,8 @@ You should have received a copy of the GNU General Public License along with Zebra; see the file LICENSE.zebra. If not, write to the - Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA - 02111-1307, USA. + Free Software Foundation, + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA @@ -36,7 +36,7 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies +w Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble diff --git a/doc/querymodel.xml b/doc/querymodel.xml index bbadb28..6c12214 100644 --- a/doc/querymodel.xml +++ b/doc/querymodel.xml @@ -1,5 +1,5 @@ - + Query Model
@@ -41,7 +41,7 @@ parties developing Z39.50 software, and is often referred to as Prefix Query Notation, or in short PQN. See - for further explanations and + for further explanations and descriptions of Zebra's capabilities.
@@ -144,8 +144,8 @@
-
- Prefix Query Format syntax and semantics +
+ RPN queries and semantics The PQF grammar is documented in the YAZ manual, and shall not be @@ -155,10 +155,10 @@ query parse tree. -
- PQF tree structure +
+ RPN tree structure - The PQF parse tree - or the equivalent textual representation - + The RPN parse tree - or the equivalent textual representation in PQF - may start with one specification of the attribute set used. Following is a query tree, which @@ -184,7 +184,7 @@ Attribute set - Short hand + PQF notation (Short hand) Status Notes @@ -192,7 +192,7 @@ - Explain + Explain exp-1 Special attribute set used on the special automagic IR-Explain-1 database to gain information on @@ -201,7 +201,7 @@ predefined - Bib1 + Bib-1 bib-1 Standard PQF query language attribute set which defines the semantics of Z39.50 searching. In addition, all of the @@ -211,14 +211,14 @@ default - GILS + GILS gils - Extension to the Bib1 attribute set. + Extension to the Bib-1 attribute set. predefined - - - Experimental and buggy. Definitely not to be used in production code. - -
@@ -2475,19 +2474,17 @@ 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. + , + and shall therefore not be repeated here.
diff --git a/doc/recordmodel-alvisxslt.xml b/doc/recordmodel-alvisxslt.xml index d067622..564c7bf 100644 --- a/doc/recordmodel-alvisxslt.xml +++ b/doc/recordmodel-alvisxslt.xml @@ -1,5 +1,5 @@ - + ALVIS XML Record Model and Filter Module @@ -213,13 +213,9 @@ ]]> See for more information on SRU/SRW - configuration, and or - - the YAZ manual CQL section - for the details - of the YAZ frontend server - CQL - configuration. + configuration, and or the YAZ + CQL section + for the details or the YAZ frontend server. Notice that there are no *.abs, -- 1.7.10.4