<chapter id="fields-and-charsets">
- <!-- $Id: field-structure.xml,v 1.1 2006-09-03 21:37:26 adam Exp $ -->
+ <!-- $Id: field-structure.xml,v 1.4 2006-11-13 14:53:40 marc Exp $ -->
<title>Field Structure and Character Sets
</title>
<variablelist>
<varlistentry>
- <term>index <emphasis>field type code</emphasis></term>
+ <term>index <replaceable>field type code</replaceable></term>
<listitem>
<para>
This directive introduces a new search index code.
The argument is a one-character code to be used in the
.abs files to select this particular index type. An index, roughly,
corresponds to a particular structure attribute during search. Refer
- to <xref linkend="search"/>.
+ to <xref linkend="zebrasrv-search"/>.
</para>
</listitem></varlistentry>
<varlistentry>
- <term>sort <emphasis>field code type</emphasis></term>
+ <term>sort <replaceable>field code type</replaceable></term>
<listitem>
<para>
This directive introduces a
</para>
</listitem></varlistentry>
<varlistentry>
- <term>completeness <emphasis>boolean</emphasis></term>
+ <term>completeness <replaceable>boolean</replaceable></term>
<listitem>
<para>
This directive enables or disables complete field indexing.
- The value of the <emphasis>boolean</emphasis> should be 0
+ The value of the <replaceable>boolean</replaceable> should be 0
(disable) or 1. If completeness is enabled, the index entry will
contain the complete contents of the field (up to a limit), with words
(non-space characters) separated by single space characters
search containing space characters as a word proximity search.
</para>
</listitem></varlistentry>
+
+ <varlistentry id="default.idx.firstinfield">
+ <term>firstinfield <replaceable>boolean</replaceable></term>
+ <listitem>
+ <para>
+ This directive enables or disables first-in-field indexing.
+ The value of the <replaceable>boolean</replaceable> should be 0
+ (disable) or 1.
+ </para>
+ </listitem></varlistentry>
+
+ <varlistentry id="default.idx.alwaysmatches">
+ <term>alwaysmatches <replaceable>boolean</replaceable></term>
+ <listitem>
+ <para>
+ This directive enables or disables alwaysmatches indexing.
+ The value of the <replaceable>boolean</replaceable> should be 0
+ (disable) or 1.
+ </para>
+ </listitem></varlistentry>
+
<varlistentry>
- <term>charmap <emphasis>filename</emphasis></term>
+ <term>charmap <replaceable>filename</replaceable></term>
<listitem>
<para>
This is the filename of the character
<variablelist>
<varlistentry>
- <term>lowercase <emphasis>value-set</emphasis></term>
+ <term>lowercase <replaceable>value-set</replaceable></term>
<listitem>
<para>
This directive introduces the basic value set of the field type.
</para>
</listitem></varlistentry>
<varlistentry>
- <term>uppercase <emphasis>value-set</emphasis></term>
+ <term>uppercase <replaceable>value-set</replaceable></term>
<listitem>
<para>
This directive introduces the
</para>
</listitem></varlistentry>
<varlistentry>
- <term>space <emphasis>value-set</emphasis></term>
+ <term>space <replaceable>value-set</replaceable></term>
<listitem>
<para>
This directive introduces the character
</para>
</listitem></varlistentry>
<varlistentry>
- <term>map <emphasis>value-set</emphasis>
- <emphasis>target</emphasis></term>
+ <term>map <replaceable>value-set</replaceable>
+ <replaceable>target</replaceable></term>
<listitem>
<para>
This directive introduces a mapping between each of the
would both produce the same results.
</para>
</section>
+ <section id="default-idx-debug">
+ <title>Field structure debugging using the special
+ <literal>zebra::</literal> element set</title>
+ <para>
+ At some time, it is very hard to figure out what exactly has been
+ indexed how and in which indexes. Using the indexing stylesheet of
+ the Alvis filter, one can at least see which portion of the record
+ went into which index, but a similar aid does not exist for all
+ other indexing filters.
+ </para>
+ <para>
+ Starting with <literal>Zebra</literal> version
+ <literal>2.0.4-2</literal> or newer, one has the possibility to
+ use the special
+ <literal>zebra::</literal> element set name, which is only defined for
+ the <literal>SUTRS</literal> and <literal>XML</literal> record
+ formats.
+ <screen>
+ Z> f @attr 1=dc_all minutter
+ Z> format sutrs
+ Z> elements zebra::
+ Z> s 1+1
+ </screen>
+ will display all indexed tokens from all indexed fields of the
+ first record, and it will display in <literal>SUTRS</literal>
+ record syntax, whereas
+ <screen>
+ Z> f @attr 1=dc_all minutter
+ Z> format xml
+ Z> elements zebra::dc_publisher
+ Z> s 1+1
+ Z> elements zebra::dc_publisher:p
+ Z> s 1+1
+ </screen>
+ displays in <literal>XML</literal> record syntax only the content
+ of the zebra string index <literal>dc_publisher</literal>, or
+ even only the type <literal>p</literal> phrase indexed part of it.
+ </para>
+ </section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables: