From 25801551c8321842e7b0c2a65925692ccf63a9e4 Mon Sep 17 00:00:00 2001 From: Marc Cromme Date: Fri, 30 Jun 2006 14:36:12 +0000 Subject: [PATCH] multiple corrections from Heikki's suggestions, renaming of html file id's --- doc/Makefile.am | 8 ++++---- doc/architecture.xml | 43 ++++++++++++++++--------------------------- doc/installation.xml | 4 ++-- doc/introduction.xml | 9 +++++++-- doc/querymodel.xml | 18 +++++++++--------- doc/server.xml | 14 +++++++------- 6 files changed, 45 insertions(+), 51 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index 1ab03f1..96a44fd 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.53 2006-06-28 18:19:32 adam Exp $ +## $Id: Makefile.am,v 1.54 2006-06-30 14:36:12 marc Exp $ docdir=$(datadir)/doc/$(PACKAGE)$(PACKAGE_SUFFIX) SUBDIRS = common @@ -32,7 +32,6 @@ HTMLFILES = \ administration-extended-services.html \ administration-ranking.html \ administration.html \ - apps.html \ architecture-maincomponents.html \ architecture-workflow.html \ architecture.html \ @@ -49,10 +48,12 @@ HTMLFILES = \ grs-internal-representation.html \ index.html \ indexdata.html \ + installation-upgrade.html \ installation.debian.html \ installation.html \ installation.win32.html \ - installation-upgrade.html \ + introduction-apps.html \ + introduction-support.html \ introduction.html \ license.html \ locating-records.html \ @@ -72,7 +73,6 @@ HTMLFILES = \ server.html \ shadow-registers.html \ simple-indexing.html \ - support.html \ zebraidx.html \ htmlhelp.hhp \ toc.hhc diff --git a/doc/architecture.xml b/doc/architecture.xml index 7db023e..a4872f6 100644 --- a/doc/architecture.xml +++ b/doc/architecture.xml @@ -1,5 +1,5 @@ - + Overview of Zebra Architecture @@ -52,7 +52,7 @@ same main components, which are presented here. - The virtual Debian package idzebra1.4 + The virtual Debian package idzebra-2.0 installs all the necessary packages to start working with Zebra - including utility programs, development libraries, documentation and modules. @@ -122,11 +122,11 @@ - The Debian package libidzebra1.4 + The Debian package libidzebra-2.0 contains all run-time libraries for Zebra, the documentation in PDF and HTML is found in - idzebra1.4-doc, and - idzebra1.4-common + idzebra-2.0-doc, and + idzebra-2.0-common includes common essential Zebra configuration files. @@ -142,7 +142,7 @@ indexes according to the rules defined in the filter modules. - The Debian package idzebra1.4-utils contains + The Debian package idzebra-2.0-utils contains the zebraidx utility. @@ -155,7 +155,7 @@ great Information Retrieval server application. - The Debian package idzebra1.4-utils contains + The Debian package idzebra-2.0-utils contains the zebrasrv utility. @@ -204,17 +204,15 @@ The virtual Debian package - libidzebra1.4-modules installs all base filter + libidzebra-2.0-modules installs all base filter modules. + TEXT Record Model and Filter Module Plain ASCII text filter. TODO: add information here. - @@ -231,20 +229,12 @@ to the *.abs configuration file suffix. - The grs.danbib filter is developed for - DBC DanBib records. - DanBib is the Danish Union Catalogue hosted by DBC - (Danish Bibliographic Center). This filter is found in the - Debian package - libidzebra1.4-mod-grs-danbib. - - The grs.marc and grs.marcxml filters are suited to parse and index binary and XML versions of traditional library MARC records based on the ISO2709 standard. The Debian package for both filters is - libidzebra1.4-mod-grs-marc. + libidzebra-2.0-mod-grs-marc. GRS TCL scriptable filters for extensive user configuration come @@ -253,17 +243,17 @@ a general scriptable TCL filter called grs.tcl are both included in the - libidzebra1.4-mod-grs-regx Debian package. + libidzebra-2.0-mod-grs-regx Debian package. A general purpose SGML filter is called grs.sgml. This filter is not yet packaged, but planned to be in the - libidzebra1.4-mod-grs-sgml Debian package. + libidzebra-2.0-mod-grs-sgml Debian package. The Debian package - libidzebra1.4-mod-grs-xml includes the + libidzebra-2.0-mod-grs-xml includes the grs.xml filter which uses Expat to parse records in XML and turn them into IDZebra's internal GRS node @@ -309,20 +299,19 @@ . - The Debian package libidzebra1.4-mod-alvis + The Debian package libidzebra-2.0-mod-alvis contains the Alvis filter module. + + --> diff --git a/doc/installation.xml b/doc/installation.xml index 729743c..e4d3dbf 100644 --- a/doc/installation.xml +++ b/doc/installation.xml @@ -1,4 +1,4 @@ - + Installation @@ -239,7 +239,7 @@ - GNU/Debian and Ubuntu/Debian On Other Platforms + Ubuntu/Debian and GNU/Debian on other platforms These Zebra packages are specifically compiled for diff --git a/doc/introduction.xml b/doc/introduction.xml index 3cb8f1f..7f0374a 100644 --- a/doc/introduction.xml +++ b/doc/introduction.xml @@ -1,5 +1,5 @@ - + Introduction @@ -295,6 +295,11 @@ "We're taking the best from both worlds in our redesigned Koha 3.0. + + See also LibLime's newsletter article + + Koha Earns its Stripes. + @@ -525,7 +530,7 @@ - + Support You can get support for Zebra from at least three sources. diff --git a/doc/querymodel.xml b/doc/querymodel.xml index 1d2c8b5..6aa9db4 100644 --- a/doc/querymodel.xml +++ b/doc/querymodel.xml @@ -1,5 +1,5 @@ - + Query Model @@ -24,7 +24,7 @@ Since the type-1 (RPN) query structure has no direct, useful string - representation, every origin application needs to provide some + representation, every client application needs to provide some form of mapping from a local query notation or representation to it. @@ -152,7 +152,8 @@ The PQF grammar is documented in the YAZ manual, and shall not be repeated here. This textual PQF representation - is always during search mapped to the equivalent Zebra internal + is not transmistted to Zebra during search, but it is in the + client mapped to the equivalent Z39.50 binary query parse tree. @@ -445,7 +446,9 @@ Defining a named result set and re-using it in the next query, - using yaz-client. + using yaz-client. Notice that the client, not + the server, assigns the string '1' to the + named result set. Z> f @attr 1=4 mozart ... @@ -454,11 +457,6 @@ Z> f @and @set 1 @attr 1=4 amadeus ... Number of hits: 14, setno 2 - ... - Z> f @attr 1=1016 beethoven - ... - Number of hits: 26, setno 3 - ... @@ -2325,6 +2323,8 @@ The next plus character marks the end of the section. Currently Zebra only supports one specifier, the error tolerance, which consists one digit. + diff --git a/doc/server.xml b/doc/server.xml index dd0a9e9..af98f12 100644 --- a/doc/server.xml +++ b/doc/server.xml @@ -1,5 +1,5 @@ - + The Z39.50 Server @@ -502,16 +502,16 @@ Scan - Zebra does not support SRU's + Zebra supports SRU's scan operation, as described at - + . + Scanning using CQL syntax is the default, where the + standard scanClause parameter is used. - This is a rather embarrassing surprise as the pieces are all - there: Z39.50 scan is supported, and SRU scan requests are - recognised and diagnosed. To add further to the embarrassment, a - mutant form of SRU scan is supported, using + In addition, a + mutant form of SRU scan is supported, using the non-standard x-pScanClause parameter in place of the standard scanClause to scan on a PQF query clause. -- 1.7.10.4