<chapter id="administration">
- <!-- $Id: administration.xml,v 1.13 2002-12-02 15:10:58 mike Exp $ -->
+ <!-- $Id: administration.xml,v 1.14 2002-12-03 16:10:19 mike Exp $ -->
<title>Administrating Zebra</title>
<!-- ### It's a bit daft that this chapter (which describes half of
the configuration-file formats) is separated from
</listitem>
</varlistentry>
- <varlistentry>
- <term>tagsysno: 0|1</term>
- <listitem>
- <para>
- Species whether Zebra should include system-number data in XML
- and GRS-1 records returned to clients, represented by the
- <literal><localControlNumber></literal> element in XML
- and the <literal>(1,14)</literal> tag in GRS-1.
- The content of these elements is an internally-generated
- integer uniquely identifying the record within its database.
- It is included by default but may be turned off, with
- <literal>tagsysno: 0</literal> for databases in which a local
- control number is explicitly specified in the input records
- themselves.
- </para>
- </listitem>
- </varlistentry>
-
</variablelist>
</para>
<chapter id="record-model">
- <!-- $Id: recordmodel.xml,v 1.13 2002-10-31 10:11:39 adam Exp $ -->
+ <!-- $Id: recordmodel.xml,v 1.14 2002-12-03 16:10:19 mike Exp $ -->
<title>The Record Model</title>
<para>
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>
+ systag
+ <replaceable>systemTag</replaceable>
+ <replaceable>actualTag</replaceable>
+ </term>
+ <listitem>
+ <para>
+ Specifies what information, if any, Zebra should
+ automatically include in retrieval records for the
+ ``system fields'' that it supports.
+ <replaceable>systemTag</replaceable> may
+ be any of the following:
+ <variablelist>
+ <varlistentry>
+ <term><literal>rank</literal></term>
+ <listitem><para>
+ An integer indicating the relevance-ranking score
+ assigned to the record.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>sysno</literal></term>
+ <listitem><para>
+ An automatically generated identifier for the record,
+ unique within this database. It is represented by the
+ <literal><localControlNumber></literal> element in
+ XML and the <literal>(1,14)</literal> tag in GRS-1.
+ </para></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>size</literal></term>
+ <listitem><para>
+ The size, in bytes, of the retrieved record.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>
+ The <replaceable>actualTag</replaceable> parameter may be
+ <literal>none</literal> to indicate that the named element
+ should be omitted from retrieval records.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>