-## $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
administration-extended-services.html \
administration-ranking.html \
administration.html \
- apps.html \
architecture-maincomponents.html \
architecture-workflow.html \
architecture.html \
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 \
server.html \
shadow-registers.html \
simple-indexing.html \
- support.html \
zebraidx.html \
htmlhelp.hhp \
toc.hhc
<chapter id="architecture">
- <!-- $Id: architecture.xml,v 1.10 2006-06-13 13:45:08 marc Exp $ -->
+ <!-- $Id: architecture.xml,v 1.11 2006-06-30 14:36:12 marc Exp $ -->
<title>Overview of Zebra Architecture</title>
same main components, which are presented here.
</para>
<para>
- The virtual Debian package <literal>idzebra1.4</literal>
+ The virtual Debian package <literal>idzebra-2.0</literal>
installs all the necessary packages to start
working with Zebra - including utility programs, development libraries,
documentation and modules.
</variablelist>
</para>
<para>
- The Debian package <literal>libidzebra1.4</literal>
+ The Debian package <literal>libidzebra-2.0</literal>
contains all run-time libraries for Zebra, the
documentation in PDF and HTML is found in
- <literal>idzebra1.4-doc</literal>, and
- <literal>idzebra1.4-common</literal>
+ <literal>idzebra-2.0-doc</literal>, and
+ <literal>idzebra-2.0-common</literal>
includes common essential Zebra configuration files.
</para>
</sect2>
indexes according to the rules defined in the filter modules.
</para>
<para>
- The Debian package <literal>idzebra1.4-utils</literal> contains
+ The Debian package <literal>idzebra-2.0-utils</literal> contains
the <command>zebraidx</command> utility.
</para>
</sect2>
great Information Retrieval server application.
</para>
<para>
- The Debian package <literal>idzebra1.4-utils</literal> contains
+ The Debian package <literal>idzebra-2.0-utils</literal> contains
the <command>zebrasrv</command> utility.
</para>
</sect2>
</para>
<para>
The virtual Debian package
- <literal>libidzebra1.4-modules</literal> installs all base filter
+ <literal>libidzebra-2.0-modules</literal> installs all base filter
modules.
</para>
+
<sect3 id="componentmodulestext">
<title>TEXT Record Model and Filter Module</title>
<para>
Plain ASCII text filter. TODO: add information here.
- <!--
- <literal>text module missing as deb file<literal>
- -->
</para>
</sect3>
to the <filename>*.abs</filename> configuration file suffix.
</para>
<para>
- The <emphasis>grs.danbib</emphasis> 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
- <literal>libidzebra1.4-mod-grs-danbib</literal>.
- </para>
- <para>
The <emphasis>grs.marc</emphasis> and
<emphasis>grs.marcxml</emphasis> 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
- <literal>libidzebra1.4-mod-grs-marc</literal>.
+ <literal>libidzebra-2.0-mod-grs-marc</literal>.
</para>
<para>
GRS TCL scriptable filters for extensive user configuration come
a general scriptable TCL filter called
<emphasis>grs.tcl</emphasis>
are both included in the
- <literal>libidzebra1.4-mod-grs-regx</literal> Debian package.
+ <literal>libidzebra-2.0-mod-grs-regx</literal> Debian package.
</para>
<para>
A general purpose SGML filter is called
<emphasis>grs.sgml</emphasis>. This filter is not yet packaged,
but planned to be in the
- <literal>libidzebra1.4-mod-grs-sgml</literal> Debian package.
+ <literal>libidzebra-2.0-mod-grs-sgml</literal> Debian package.
</para>
<para>
The Debian package
- <literal>libidzebra1.4-mod-grs-xml</literal> includes the
+ <literal>libidzebra-2.0-mod-grs-xml</literal> includes the
<emphasis>grs.xml</emphasis> filter which uses <ulink
url="http://expat.sourceforge.net/">Expat</ulink> to
parse records in XML and turn them into IDZebra's internal GRS node
<xref linkend="record-model-alvisxslt"/>.
</para>
<para>
- The Debian package <literal>libidzebra1.4-mod-alvis</literal>
+ The Debian package <literal>libidzebra-2.0-mod-alvis</literal>
contains the Alvis filter module.
</para>
</sect3>
+ <!--
<sect3 id="componentmodulessafari">
<title>SAFARI Record Model and Filter Module</title>
<para>
SAFARI filter module TODO: add information here.
- <!--
- <literal>safari module missing as deb file<literal>
- -->
</para>
</sect3>
+ -->
</sect2>
-<!-- $Id: installation.xml,v 1.26 2006-06-30 10:45:09 marc Exp $ -->
+<!-- $Id: installation.xml,v 1.27 2006-06-30 14:36:12 marc Exp $ -->
<chapter id="installation">
<title>Installation</title>
<para>
</sect2>
<sect2 id="installation.debianother">
- <title>GNU/Debian and Ubuntu/Debian On Other Platforms</title>
+ <title>Ubuntu/Debian and GNU/Debian on other platforms</title>
<para>
These <ulink url="http://indexdata.dk/zebra/">Zebra</ulink>
packages are specifically compiled for
<chapter id="introduction">
- <!-- $Id: introduction.xml,v 1.36 2006-06-30 14:00:34 marc Exp $ -->
+ <!-- $Id: introduction.xml,v 1.37 2006-06-30 14:36:12 marc Exp $ -->
<title>Introduction</title>
<sect1>
"We're taking the best from both worlds in our redesigned Koha
3.0.
</para>
+ <para>
+ See also LibLime's newsletter article
+ <ulink url="http://www.liblime.com/newsletter/2006/01/features/koha-earns-its-stripes/">
+ Koha Earns its Stripes</ulink>.
+ </para>
</sect2>
<sect2>
</sect1>
- <sect1 id="support">
+ <sect1 id="introduction-support">
<title>Support</title>
<para>
You can get support for Zebra from at least three sources.
<chapter id="querymodel">
- <!-- $Id: querymodel.xml,v 1.18 2006-06-29 16:02:12 heikki Exp $ -->
+ <!-- $Id: querymodel.xml,v 1.19 2006-06-30 14:36:12 marc Exp $ -->
<title>Query Model</title>
<sect1 id="querymodel-overview">
<para>
Since the <literal>type-1 (RPN)</literal>
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.
</para>
The <ulink url="&url.yaz.pqf;">PQF grammar</ulink>
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.
</para>
<para>
Defining a named result set and re-using it in the next query,
- using <literal>yaz-client</literal>.
+ using <literal>yaz-client</literal>. Notice that the client, not
+ the server, assigns the string <literal>'1'</literal> to the
+ named result set.
<screen>
Z> f @attr 1=4 mozart
...
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
- ...
</screen>
</para>
The next plus character marks the end of the section.
Currently Zebra only supports one specifier, the error tolerance,
which consists one digit.
+ <!-- TODO Nice thing, but what does
+ that error tolerance digit *mean*? Maybe an example would be nice? -->
</para>
<para>
<chapter id="server">
- <!-- $Id: server.xml,v 1.24 2006-06-13 13:45:08 marc Exp $ -->
+ <!-- $Id: server.xml,v 1.25 2006-06-30 14:36:12 marc Exp $ -->
<title>The Z39.50 Server</title>
<sect1 id="zebrasrv">
<sect2>
<title>Scan</title>
<para>
- Zebra does <emphasis>not</emphasis> support SRU's
+ Zebra supports SRU's
<literal>scan</literal>
operation, as described at
- <ulink url="http://www.loc.gov/standards/sru/scan/"/>
+ <ulink url="http://www.loc.gov/standards/sru/scan/"/>.
+ Scanning using CQL syntax is the default, where the
+ standard <literal>scanClause</literal> parameter is used.
</para>
<para>
- 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 <emphasis>is</emphasis> supported, using
+ In addition, a
+ mutant form of SRU scan is supported, using
the non-standard <literal>x-pScanClause</literal> parameter in
place of the standard <literal>scanClause</literal> to scan on a
PQF query clause.
projects / idzebra-moved-to-github.git / commitdiff