Added several FIXMEs to mark places that need attention
<chapter id="administration">
<chapter id="administration">
- <!-- $Id: administration.xml,v 1.4 2002-04-09 19:20:22 adam Exp $ -->
+ <!-- $Id: administration.xml,v 1.5 2002-04-10 14:47:48 heikki Exp $ -->
<title>Administrating Zebra</title>
<para>
<title>Administrating Zebra</title>
<para>
+ FIXME - Didn't Adam make something to have multiple databases in multiple dirs...
+ </para>
+
+ <para>
<variablelist>
<varlistentry>
<variablelist>
<varlistentry>
<listitem>
<para>
Specifies the Z39.50 database name.
<listitem>
<para>
Specifies the Z39.50 database name.
+ FIXME - now we can have multiple databases in one server. -H
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
+ FIXME - There must be a simpler way to do this with Adams string tags -H
+ </para>
+
+ <para>
For example, to update records of group <literal>esdd</literal>
located below
<literal>/data1/records/</literal> you should type:
For example, to update records of group <literal>esdd</literal>
located below
<literal>/data1/records/</literal> you should type:
each directory in the order specified and use the next specified
directories as needed.
The <emphasis>size</emphasis> is an integer followed by a qualifier
each directory in the order specified and use the next specified
directories as needed.
The <emphasis>size</emphasis> is an integer followed by a qualifier
- code, <literal>M</literal> for megabytes,
+ code,
+ <literal>b</literal> for bytes,
<literal>k</literal> for kilobytes.
<literal>k</literal> for kilobytes.
+ <literal>M</literal> for megabytes,
+ <literal>G</literal> for gigabytes.
</para>
<para>
For instance, if you have allocated two disks for your register, and
the first disk is mounted
</para>
<para>
For instance, if you have allocated two disks for your register, and
the first disk is mounted
- on <literal>/d1</literal> and has 200 MB of free space and the
- second, mounted on <literal>/d2</literal> has 300 MB, you could
+ on <literal>/d1</literal> and has 2GB of free space and the
+ second, mounted on <literal>/d2</literal> has 3.6 GB, you could
put this entry in your configuration file:
<screen>
put this entry in your configuration file:
<screen>
- register: /d1:200M /d2:300M
+ register: /d1:2G /d2:3600M
<appendix id="indexdata">
<appendix id="indexdata">
- <!-- $Id: indexdata.xml,v 1.3 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: indexdata.xml,v 1.4 2002-04-10 14:47:49 heikki Exp $ -->
<title>About Index Data and the Zebra Server</title>
<para>
<title>About Index Data and the Zebra Server</title>
<para>
Phone <phone>+45 3341 0100</phone>
Fax <fax>+45 3341 0101</fax>
Email <email>info@indexdata.dk</email>
Phone <phone>+45 3341 0100</phone>
Fax <fax>+45 3341 0101</fax>
Email <email>info@indexdata.dk</email>
+ <otheraddr><ulink url="http://www.indexdata.dk">www.indexdata.dk</ulink></otheraddr>
</address>
</para>
<para>
</address>
</para>
<para>
<chapter id="installation">
<chapter id="installation">
- <!-- $Id: installation.xml,v 1.3 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: installation.xml,v 1.4 2002-04-10 14:47:49 heikki Exp $ -->
<title>Installation</title>
<para>
An ANSI C compiler is required to compile the Zebra
<title>Installation</title>
<para>
An ANSI C compiler is required to compile the Zebra
<screen>
CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
</screen>
<screen>
CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
</screen>
+
+ The configure script takes a number of arguments, you can see
+ them all with
+ <screen>
+ ./configure --help
+ </screen>
+ <para>
+ You can now use Zebra. If you wish to install it system-wide, type
+ <screen>
+ make install
+ </screen>
+ By default this will install the Zebra executables in
+ <filename>/usr/local/bin</filename>,
+ and the standard configuration files in
+ <filename>/usr/local/share/zebra</filename>
+ You can override this with the <literal>--prefix</literal> option
+ to configure.
+ </para>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
<chapter id="introduction">
<chapter id="introduction">
- <!-- $Id: introduction.xml,v 1.4 2002-04-09 19:20:22 adam Exp $ -->
+ <!-- $Id: introduction.xml,v 1.5 2002-04-10 14:47:49 heikki Exp $ -->
<title>Introduction</title>
<sect1>
<title>Overview</title>
<para>
<title>Introduction</title>
<sect1>
<title>Overview</title>
<para>
- The Zebra system is a fielded free-text indexing and retrieval engine with a
- Z39.50 front-end. You can use any commercial or free-ware Z39.50 client
- to access data stored in Zebra.
+ The
+ <ulink url="http://www.indexdata.dk/zebra/">
+ Zebra</ulink>
+ system is a fielded free-text indexing and retrieval engine with a
+ Z39.50 front-end. You can use our various toolkits or any commercial
+ or free-ware Z39.50 client to access data stored in Zebra.
+ </para>
+
+ <para>
+ FIXME - not a "first step" but a part of a complete system! -H
- If you find the software interesting, you should join the support
- mailing-list by sending email to
- <literal>zebra-request@indexdata.dk</literal>.
+
+ If you find the software interesting, you should visit the
+ <ulink url="http://www.indexdata.dk/zebra/">
+ Zebra web site</ulink>, where you can join the
+ <ulink url="http://www.indexdata.dk/mailman/listinfo/zebralist">
+ mailing-list</ulink>
+ by sending email to
- <listitem>
- <para>
- Supports updating - records can be added and deleted without
- rebuilding the index from scratch.
- The update procedure is tolerant to crashes or hard interrupts
- during register updating - registers can be reconstructed following
- a crash.
- Registers can be safely updated even while users are accessing
- the server.
- </para>
- </listitem>
+ Robust updating - records can be added and deleted without
+ rebuilding the index from scratch.
+ The update procedure is tolerant to crashes or hard interrupts
+ during register updating - registers can be reconstructed following
+ a crash.
+ Registers can be safely updated even while users are accessing
+ the server.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
Supports random storage formats. A system of input filters driven by
regular expressions allows you to easily process most ASCII-based
data formats. SGML, XML, ISO2709 (MARC), and raw text are also
Supports random storage formats. A system of input filters driven by
regular expressions allows you to easily process most ASCII-based
data formats. SGML, XML, ISO2709 (MARC), and raw text are also
+ <para>
+ Can import the data into Zebras own storage, or just refer to
+ external files (html pages).
+ </para>
+ </listitem>
+
+ <listitem>
<para>
Supports multiple concrete syntaxes
for record exchange (depending on the configuration): GRS-1, SUTRS,
<para>
Supports multiple concrete syntaxes
for record exchange (depending on the configuration): GRS-1, SUTRS,
+ <listitem>
+ <para>
+ 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.
+ </para>
+ </listitem>
+
<listitem>
<para>
Protocol facilities: Init, Search, Retrieve, Delete, Browse and Sort.
<listitem>
<para>
Protocol facilities: Init, Search, Retrieve, Delete, Browse and Sort.
+ FIXME - Itemupdate. (Remove delete until that time, confuses people) -H
<listitem>
<para>
Some variant support (not fully implemented yet).
<listitem>
<para>
Some variant support (not fully implemented yet).
+ FIXME - Test if complete enough - is it worth mentioning at all -H
- <listitem>
- <para>
- Zebra runs on most Unix-like systems as well as Windows NT - a binary
- distribution for Windows NT is available.
- </para>
- </listitem>
-
Items marked with an
asterisk will be implemented before the
last beta release.
Items marked with an
asterisk will be implemented before the
last beta release.
+ FIXME - What are the current plans?
<listitem>
<para>
*Complete the support for variants.
<listitem>
<para>
*Complete the support for variants.
- <!-- $Id: license.xml,v 1.3 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: license.xml,v 1.4 2002-04-10 14:47:49 heikki Exp $ -->
<title>License</title>
<para>
<title>License</title>
<para>
+ FIXME - Need to change this to GPL
+ Should also mention something about other licenses
+ being available on commercial terms.
+ </para>
+
+ <para>
All rights reserved.
</para>
All rights reserved.
</para>
<chapter id="quick-start">
<chapter id="quick-start">
- <!-- $Id: quickstart.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: quickstart.xml,v 1.2 2002-04-10 14:47:49 heikki Exp $ -->
<title>Quick Start </title>
<para>
<title>Quick Start </title>
<para>
+ FIXME - Start with the new improved example scripts that run
+ without any configuration file changes!
+ </para>
+
+ <para>
In this section, we will test the system by indexing a small set of sample
GILS records that are included with the software distribution. Go to the
<literal>test/gils</literal> subdirectory of the distribution archive.
In this section, we will test the system by indexing a small set of sample
GILS records that are included with the software distribution. Go to the
<literal>test/gils</literal> subdirectory of the distribution archive.
<chapter id="record-model">
<chapter id="record-model">
- <!-- $Id: recordmodel.xml,v 1.2 2002-04-09 19:20:23 adam Exp $ -->
+ <!-- $Id: recordmodel.xml,v 1.3 2002-04-10 14:47:49 heikki Exp $ -->
<title>The Record Model</title>
<para>
<title>The Record Model</title>
<para>
structured
record type <literal>grs</literal> as introduced in
<xref linkend="record-types"/>.
structured
record type <literal>grs</literal> as introduced in
<xref linkend="record-types"/>.
+ FIXME - Need to describe the simple string-tag model, or at least
+ refer to it here. -H
- Documentation needs extension here about types of nodes - numerical,
+ FIXME! Documentation needs extension here about types of nodes - numerical,
textual, etc., plus the various types of inclusion notes.
</para>
</note>
textual, etc., plus the various types of inclusion notes.
</para>
</note>
+ FIXME - Need a diagram here, or a simple explanation how it all hangs together -H
+ </para>
+
+ <para>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
- <emphasis>NOTE: The schema-mapping functions are so far limited to a
+ <emphasis>NOTE: FIXME! The schema-mapping functions are so far limited to a
straightforward mapping of elements. This should be extended with
mechanisms for conversions of the element contents, and conditional
mappings of elements based on the record contents.</emphasis>
straightforward mapping of elements. This should be extended with
mechanisms for conversions of the element contents, and conditional
mappings of elements based on the record contents.</emphasis>
- <emphasis>NOTE: This will be described better. We're in the process of
+ <emphasis>NOTE: FIXME! This will be described better. We're in the process of
re-evaluating and most likely changing the way that MARC records are
handled by the system.</emphasis>
</para>
re-evaluating and most likely changing the way that MARC records are
handled by the system.</emphasis>
</para>
is used to show the hierarchical structure of the record. All
"GRS" type records support both the GRS-1 and SUTRS
representations.
is used to show the hierarchical structure of the record. All
"GRS" type records support both the GRS-1 and SUTRS
representations.
+ FIXME - What is SUTRS - should be expanded here
abstract syntaxes can be mapped to the SOIF format, although nested
elements are represented by concatenation of the tag names at each
level.
abstract syntaxes can be mapped to the SOIF format, although nested
elements are represented by concatenation of the tag names at each
level.
+ FIXME - Is this used anywhere ? What is SOIF anyway? -H
- <!-- $Id: server.xml,v 1.2 2002-04-09 19:20:23 adam Exp $ -->
+ <!-- $Id: server.xml,v 1.3 2002-04-10 14:47:49 heikki Exp $ -->
<title>The Z39.50 Server</title>
<sect1 id="zebrasrv">
<title>Running the Z39.50 Server (zebrasrv)</title>
<para>
<title>The Z39.50 Server</title>
<sect1 id="zebrasrv">
<title>Running the Z39.50 Server (zebrasrv)</title>
<para>
+ FIXME - We need to be consistent here, zebraidx had the options at the
+ end, and lots of explaining text before them. Same for zebrasvr! -H
+ FIXME - At least we need a small intro, what is zebrasvr, and how it
+ can be run (inetd, nt service, stand-alone program, daemon...) -H
+ </para>
+
+ <para>
<emphasis remap="bf">Syntax</emphasis>
<screen>
<emphasis remap="bf">Syntax</emphasis>
<screen>
<term>-z</term>
<listitem>
<para>
<term>-z</term>
<listitem>
<para>
- Use the Z39.50 protocol (default). These two options complement
- each other. You can use both multiple times on the same command
- line, between listener-specifications (see below). This way, you
- can set up the server to listen for connections in both protocols
- concurrently, on different local ports.
+ Use the Z39.50 protocol. Currently the only protocol supported.
+ The option is retained for historical reasons, and for future
+ extensions.
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
- A <replaceable>listener-address</replaceable> consists of a transport
- mode followed by a colon (:) followed by a listener address.
+ A <replaceable>listener-address</replaceable> consists of an optional
+ transport mode followed by a colon (:) followed by a listener address.
The transport mode is either <literal>ssl</literal> or
The transport mode is either <literal>ssl</literal> or
- <literal>tcp</literal>.
+ <literal>tcp</literal> (default).
- The port number defaults to 210 (standard Z39.50 port).
+ The port number defaults to 210 (standard Z39.50 port) for
+ privileged users (root), and 9999 for normal users.
- zebrasrv -u daemon tcp:@
<title>Search</title>
<para>
<title>Search</title>
<para>
+ FIXME - Need to explain the string tag stuff before people get bogged
+ down with all these attribute numbers. Perhaps in its own
+ chapter? -H
+ </para>
+
+ <para>
The supported query type are 1 and 101. All operators are currently
supported with the restriction that only proximity units of type "word"
are supported for the proximity operator.
The supported query type are 1 and 101. All operators are currently
supported with the restriction that only proximity units of type "word"
are supported for the proximity operator.
<listitem>
<para>
Matches <emphasis>x</emphasis> once or twice. Priority: high.
<listitem>
<para>
Matches <emphasis>x</emphasis> once or twice. Priority: high.
+ FIXME Is this right? Std regexp has '?' meaning zero or one -H
</para>
</listitem>
</varlistentry>
</para>
</listitem>
</varlistentry>
<!ENTITY app-license SYSTEM "license.xml">
<!ENTITY app-indexdata SYSTEM "indexdata.xml">
]>
<!ENTITY app-license SYSTEM "license.xml">
<!ENTITY app-indexdata SYSTEM "indexdata.xml">
]>
-<!-- $Id: zebra.xml,v 1.2 2002-04-09 19:20:23 adam Exp $ -->
+<!-- $Id: zebra.xml,v 1.3 2002-04-10 14:47:49 heikki Exp $ -->
<book id="zebra">
<bookinfo>
<book id="zebra">
<bookinfo>
- <title>Zebra Server - Administrators's Guide and Reference</title>
+ <title>Zebra Server - Administrators' Guide and Reference</title>
<author>
<firstname>Sebastian</firstname><surname>Hammer</surname>
</author>
<author>
<firstname>Sebastian</firstname><surname>Hammer</surname>
</author>
<abstract>
<simpara>
The Zebra information server combines a versatile fielded/free-text
<abstract>
<simpara>
The Zebra information server combines a versatile fielded/free-text
- search engine with a Z39.50-1995 frontend to provide a powerful and
+ search engine with a Z39.50-1995 front-end to provide a powerful and
flexible information management system.
This document explains the procedure for installing and
configuring the system, and outlines the possibilities for
flexible information management system.
This document explains the procedure for installing and
configuring the system, and outlines the possibilities for
<!ENTITY app-license SYSTEM "license.xml">
<!ENTITY app-indexdata SYSTEM "indexdata.xml">
]>
<!ENTITY app-license SYSTEM "license.xml">
<!ENTITY app-indexdata SYSTEM "indexdata.xml">
]>
-<!-- $Id: zebra.xml.in,v 1.5 2002-04-09 19:20:23 adam Exp $ -->
+<!-- $Id: zebra.xml.in,v 1.6 2002-04-10 14:47:49 heikki Exp $ -->
<book id="zebra">
<bookinfo>
<title>Zebra Server - Administrators' Guide and Reference</title>
<author>
<firstname>Sebastian</firstname><surname>Hammer</surname>
</author>
<book id="zebra">
<bookinfo>
<title>Zebra Server - Administrators' Guide and Reference</title>
<author>
<firstname>Sebastian</firstname><surname>Hammer</surname>
</author>
<firstname>Adam</firstname><surname>Dickmeiss</surname>
<firstname>Adam</firstname><surname>Dickmeiss</surname>
+ </author>
+ <author>
+ <firstname>Heikki</firstname><surname>Levanto</surname>
+ </author>
<copyright>
<year>1995-2002</year>
<holder>Index Data</holder>
<copyright>
<year>1995-2002</year>
<holder>Index Data</holder>
<abstract>
<simpara>
The Zebra information server combines a versatile fielded/free-text
<abstract>
<simpara>
The Zebra information server combines a versatile fielded/free-text
- search engine with a Z39.50-1995 front-end to provide a powerful and
+ search engine with a Z39.50 v3 front-end to provide a powerful and
flexible information management system.
This document explains the procedure for installing and
flexible information management system.
This document explains the procedure for installing and
- configuring the system, and outlines the possibilities for
- managing data and providing Z39.50 services with the software.
+ configuring the system, managing data and providing Z39.50
+ services with the software.
</simpara>
<simpara>
This manual covers version @VERSION@ of Zebra.
</simpara>
<simpara>
This manual covers version @VERSION@ of Zebra.
- <!-- $Id: zebraidx.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: zebraidx.xml,v 1.2 2002-04-10 14:47:49 heikki Exp $ -->
<title>Running the Maintenance Interface (zebraidx)</title>
<para>
<title>Running the Maintenance Interface (zebraidx)</title>
<para>
<term>-m <replaceable>mbytes</replaceable></term>
<listitem>
<para>
<term>-m <replaceable>mbytes</replaceable></term>
<listitem>
<para>
- Use <replaceable>mbytes</replaceable> of megabytes before flushing
+ Use <replaceable>mbytes</replaceable> of memory before flushing
keys to background storage. This setting affects performance when
updating large databases.
</para>
keys to background storage. This setting affects performance when
updating large databases.
</para>
projects / idzebra-moved-to-github.git / commitdiff