<chapter id="architecture">
- <!-- $Id: architecture.xml,v 1.9 2006-06-13 09:27:01 marc Exp $ -->
+ <!-- $Id: architecture.xml,v 1.13 2006-09-22 12:34:45 adam Exp $ -->
<title>Overview of Zebra Architecture</title>
- <sect1 id="architecture-representation">
+ <section id="architecture-representation">
<title>Local Representation</title>
-
+
<para>
As mentioned earlier, Zebra places few restrictions on the type of
data that you can index and manage. Generally, whatever the form of
"grs" keyword, separated by "." characters.
-->
</para>
- </sect1>
+ </section>
- <sect1 id="architecture-maincomponents">
+ <section id="architecture-maincomponents">
<title>Main Components</title>
<para>
The Zebra system is designed to support a wide range of data management
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.
</para>
- <sect2 id="componentcore">
+ <section id="componentcore">
<title>Core Zebra Libraries Containing Common Functionality</title>
<para>
The core Zebra module is the meat of the <command>zebraidx</command>
</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>
+ </section>
- <sect2 id="componentindexer">
+ <section id="componentindexer">
<title>Zebra Indexer</title>
<para>
The <command>zebraidx</command>
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>
+ </section>
- <sect2 id="componentsearcher">
+ <section id="componentsearcher">
<title>Zebra Searcher/Retriever</title>
<para>
This is the executable which runs the Z39.50/SRU/SRW server and
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>
+ </section>
- <sect2 id="componentyazserver">
+ <section id="componentyazserver">
<title>YAZ Server Frontend</title>
<para>
The YAZ server frontend is
<para>
In addition to Z39.50 requests, the YAZ server frontend acts
as HTTP server, honoring
- <ulink url="http://www.loc.gov/standards/sru/srw/">SRW</ulink>
- SOAP requests, and
- <ulink url="http://www.loc.gov/standards/sru/">SRU</ulink>
- REST requests. Moreover, it can
+ <ulink url="&url.srw;">SRU SOAP</ulink>
+ requests, and
+ <ulink url="&url.sru;">SRU REST</ulink>
+ requests. Moreover, it can
translate incoming
- <ulink url="http://www.loc.gov/standards/sru/cql/">CQL</ulink>
+ <ulink url="&url.cql;">CQL</ulink>
queries to
- <ulink url="http://indexdata.com/yaz/doc/tools.tkl#PQF">PQF</ulink>
+ <ulink url="&url.yaz.pqf;">PQF</ulink>
queries, if
correctly configured.
</para>
<para>
- <ulink url="http://www.indexdata.com/yaz">YAZ</ulink>
+ <ulink url="&url.yaz;">YAZ</ulink>
is an Open Source
toolkit that allows you to develop software using the
ANSI Z39.50/ISO23950 standard for information retrieval.
It is packaged in the Debian packages
<literal>yaz</literal> and <literal>libyaz</literal>.
</para>
- </sect2>
+ </section>
- <sect2 id="componentmodules">
+ <section id="componentmodules">
<title>Record Models and Filter Modules</title>
<para>
The hard work of knowing <emphasis>what</emphasis> to index,
</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">
+
+ <section 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>
+ </section>
- <sect3 id="componentmodulesgrs">
+ <section id="componentmodulesgrs">
<title>GRS Record Model and Filter Modules</title>
<para>
The GRS filter modules described in
- <xref linkend="record-model-grs"/>
+ <xref linkend="grs"/>
are all based on the Z39.50 specifications, and it is absolutely
mandatory to have the reference pages on BIB-1 attribute sets on
you hand when configuring GRS filters. The GRS filters come in
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
+ url="&url.expat;">Expat</ulink> 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.
</para>
- </sect3>
+ </section>
- <sect3 id="componentmodulesalvis">
+ <section id="componentmodulesalvis">
<title>ALVIS Record Model and Filter Module</title>
<para>
The Alvis filter for XML files is an XSLT based input
<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>
+ </section>
- <sect3 id="componentmodulessafari">
+ <!--
+ <section 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>
+ </section>
+ -->
- </sect2>
+ </section>
- </sect1>
+ </section>
- <sect1 id="architecture-workflow">
+ <section id="architecture-workflow">
<title>Indexing and Retrieval Workflow</title>
<para>
</itemizedlist>
</para>
- </sect1>
-
-
+ </section>
</chapter>
projects / idzebra-moved-to-github.git / blobdiff