X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ffield-structure.xml;h=67619d28db6f469a050220102a2c1b50f7359f9c;hb=5f9da49ae7414fbb37d999a389c8d39fd057f5c2;hp=758542b3ed84da1979baa1dcd1e15f414324f872;hpb=7b25277add2aae5caabee02213911aeeb65030c8;p=idzebra-moved-to-github.git

diff --git a/doc/field-structure.xml b/doc/field-structure.xml
index 758542b..67619d2 100644
--- a/doc/field-structure.xml
+++ b/doc/field-structure.xml
@@ -1,5 +1,5 @@
  <chapter id="fields-and-charsets">
-  <!-- $Id: field-structure.xml,v 1.2 2006-09-05 12:01:31 adam Exp $ -->
+  <!-- $Id: field-structure.xml,v 1.5 2006-11-17 14:54:00 marc Exp $ -->
   <title>Field Structure and Character Sets
   </title>
   
@@ -76,6 +76,27 @@
 	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 <replaceable>filename</replaceable></term>
       <listitem>
@@ -240,6 +261,45 @@
     would both produce the same results.
    </para>
   </section>
+  <section id="default-idx-debug">
+   <title>Field structure debugging using the special 
+          <literal>zebra::index::</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::index::</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::index::
+      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::index::dc_publisher
+      Z> s 1+1
+      Z> elements zebra::index::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: