---- 1.2.0 2002/04/05
+--- 1.2.0 2002/MM/DD
Multiple registers. New setting in resource 'root' that holds base
directory for register(s). A group a databases may be put in separate
<chapter id="administration">
- <!-- $Id: administration.xml,v 1.3 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: administration.xml,v 1.4 2002-04-09 19:20:22 adam Exp $ -->
<title>Administrating Zebra</title>
<para>
Indexing is a per-record process, in which either insert/modify/delete
will occur. Before a record is indexed search keys are extracted from
whatever might be the layout the original record (sgml,html,text, etc..).
- The Zebra system currently supports two fundamantal types of records:
+ The Zebra system currently supports two fundamental types of records:
structured and simple text.
To specify a particular extraction process, use either the
command line option <literal>-t</literal> or specify a
<para>
You can edit the configuration file with a normal text editor.
- parameter names and values are seperated by colons in the file. Lines
+ parameter names and values are separated by colons in the file. Lines
starting with a hash sign (<literal>#</literal>) are
treated as comments.
</para>
<title>Locating Records</title>
<para>
- The default behaviour of the Zebra system is to reference the
+ The default behavior of the Zebra system is to reference the
records from their original location, i.e. where they were found when you
ran <literal>zebraidx</literal>.
That is, when a client wishes to retrieve a record
disk space than simpler indexing methods, but it makes it easier for
you to keep the index in sync with a frequently changing set of data.
If you combine this system with the <emphasis>safe update</emphasis>
- facility (see below), you never have to take your server offline for
+ facility (see below), you never have to take your server off-line for
maintenance or register updating purposes.
</para>
<title>Indexing with General Record IDs</title>
<para>
- When using this method you construct an (almost) arbritrary, internal
+ When using this method you construct an (almost) arbitrary, internal
record key based on the contents of the record itself and other system
information. If you have a group of records that explicitly associates
an ID with each record, this method is convenient. For example, the
<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 200 MB of free space and the
+ second, mounted on <literal>/d2</literal> has 300 MB, you could
put this entry in your configuration file:
<screen>
your responsibility to ensure that enough space is available, and that
other applications do not attempt to use the free space. In a large
production system, it is recommended that you allocate one or more
- filesystem exclusively to the Zebra register files.
+ file system exclusively to the Zebra register files.
</para>
</sect1>
<chapter id="introduction">
- <!-- $Id: introduction.xml,v 1.3 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: introduction.xml,v 1.4 2002-04-09 19:20:22 adam Exp $ -->
<title>Introduction</title>
<sect1>
<para>
The Zebra system is a fielded free-text indexing and retrieval engine with a
- Z39.50 frontend. You can use any commercial or freeware Z39.50 client
+ Z39.50 front-end. You can use any commercial or free-ware Z39.50 client
to access data stored in Zebra.
</para>
<chapter id="record-model">
- <!-- $Id: recordmodel.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: recordmodel.xml,v 1.2 2002-04-09 19:20:23 adam Exp $ -->
<title>The Record Model</title>
<para>
<para>
This allows Zebra to read
records in the ISO2709 (MARC) encoding standard. In this case, the
- last paramemeter <emphasis>abstract syntax</emphasis> names the
+ last parameter <emphasis>abstract syntax</emphasis> names the
<literal>.abs</literal> file (see below)
which describes the specific MARC structure of the input record as
well as the indexing rules.
<note>
<para>
The indentation used above is used to illustrate how Zebra
- interprets the markup. The indentation, in itself, has no
+ interprets the mark-up. The indentation, in itself, has no
significance to the parser for the canonical input format, which
discards superfluous whitespace.
</para>
<term>FINISH</term>
<listitem>
<para>
- The expression asssociated with this pattern is evaluated
+ The expression associated with this pattern is evaluated
once, before the application terminates. It can be used to release
system resources - typically ones allocated in the
<emphasis>INIT</emphasis> step.
<term>record</term>
<listitem>
<para>
- Begin a new record. The followingparameter should be the
+ Begin a new record. The following parameter should be the
name of the schema that describes the structure of the record, eg.
<literal>gils</literal> or <literal>wais</literal> (see below).
The <literal>begin record</literal> call should precede
Generally, settings are characterized by a single
keyword, identifying the setting, followed by a number of parameters.
Some settings are repeatable (r), while others may occur only once in a
- file. Some settings are optional (o), whicle others again are
+ file. Some settings are optional (o), while others again are
mandatory (m).
</para>
The <emphasis>names</emphasis> parameter is a list of names
by which the tag should be recognized in the input file format.
The names should be separated by slashes (/).
- The <emphasis>type</emphasis> is th recommended datatype of
+ The <emphasis>type</emphasis> is the recommended data type of
the tag.
It should be one of the following:
(preceded by <literal>x</literal>).
In addition, the combinations
\\, \\r, \\n, \\t, \\s (space — remember that real
- space-characters may ot occur in the value definition), and
- \\ are recognised, with their usual interpretation.
+ space-characters may not occur in the value definition), and
+ \\ are recognized, with their usual interpretation.
</para>
</listitem>
<para>
Curly braces {} may be used to enclose ranges of single
characters (possibly using the escape convention described in the
- preceding point), eg. {a-z} to entroduce the
+ preceding point), eg. {a-z} to introduce the
standard range of ASCII characters.
Note that the interpretation of such a range depends on
the concrete representation in your local, physical character set.
<listitem>
<para>
- SUTRS. Again, the mapping is fairly straighforward. Indentation
+ SUTRS. Again, the mapping is fairly straightforward. Indentation
is used to show the hierarchical structure of the record. All
"GRS" type records support both the GRS-1 and SUTRS
representations.
<chapter id="server">
- <!-- $Id: server.xml,v 1.1 2002-04-09 13:26:26 adam Exp $ -->
+ <!-- $Id: server.xml,v 1.2 2002-04-09 19:20:23 adam Exp $ -->
<title>The Z39.50 Server</title>
<sect1 id="zebrasrv">
<listitem>
<para>
Use the Z39.50 protocol (default). These two options complement
- eachother. You can use both multiple times on the same command
+ 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.
<listitem>
<para>
Set the (approximate) maximum size of
- present response messages. Default is 1024 Kb (1 Mb).
+ present response messages. Default is 1024 KB (1 MB).
</para>
</listitem>
</varlistentry>
Z39.50 protocol, and the option bits for Search, Present, Scan,
NamedResultSets, and concurrentOperations will be set, if requested by
the client. The maximum PDU size is negotiated down to a maximum of
- 1Mb by default.
+ 1 MB by default.
</para>
</sect2>
<title>Sort</title>
<para>
- Z39.50 specifies three diffent types of sort criterias.
+ Z39.50 specifies three different types of sort criteria.
Of these Zebra supports the attribute specification type in which
case the use attribute specifies the "Sort register".
Sort registers are created for those fields that are of type "sort" in
<!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 $ -->
<book id="zebra">
-<bookinfo>
-
-<title>Zebra Server - Administrators's Guide and Reference</title>
-<author>
-<firstname>Sebastian</firstname><surname>Hammer</surname>
-</author>
-<editor>
-<firstname>Adam</firstname><surname>Dickmeiss</surname>
-</editor>
-<copyright>
-<year>1995-2002</year>
-<holder>Index Data</holder>
-
-</copyright>
-<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 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.
-</simpara>
-<simpara>
-This manual covers version 1.2.0 of Zebra.
-</simpara>
-</abstract>
-</bookinfo>
-
-&chap-introduction;
-&chap-installation;
-&chap-quickstart;
-&chap-administration;
-&chap-zebraidx;
-&chap-server;
-&chap-recordmodel;
-&app-license;
-&app-indexdata;
-
+ <bookinfo>
+ <title>Zebra Server - Administrators's Guide and Reference</title>
+ <author>
+ <firstname>Sebastian</firstname><surname>Hammer</surname>
+ </author>
+ <editor>
+ <firstname>Adam</firstname><surname>Dickmeiss</surname>
+ </editor>
+ <copyright>
+ <year>1995-2002</year>
+ <holder>Index Data</holder>
+ </copyright>
+ <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
+ 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.
+ </simpara>
+ <simpara>
+ This manual covers version 1.2.0 of Zebra.
+ </simpara>
+ </abstract>
+ </bookinfo>
+
+ &chap-introduction;
+ &chap-installation;
+ &chap-quickstart;
+ &chap-administration;
+ &chap-zebraidx;
+ &chap-server;
+ &chap-recordmodel;
+ &app-license;
+ &app-indexdata;
+
</book>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->
<!ENTITY app-license SYSTEM "license.xml">
<!ENTITY app-indexdata SYSTEM "indexdata.xml">
]>
-<!-- $Id: zebra.xml.in,v 1.4 2002-04-09 13:26:26 adam Exp $ -->
+<!-- $Id: zebra.xml.in,v 1.5 2002-04-09 19:20:23 adam Exp $ -->
<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>
<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
%description
Zebra is a fielded free-text indexing and retrieval engine with a Z39.50
-frontend. You can use any compatible, commercial or freeware Z39.50 client to
+front-end. You can use any compatible, commercial or freeware Z39.50 client to
access data stored in Zebra. Zebra may be used free-of-charge in non-profit
applications by non-commercial organisations.
projects / idzebra-moved-to-github.git / commitdiff