added section on special zebra:: elemset names, and updated docs to follow suit with...

[idzebra-moved-to-github.git] / doc / field-structure.xml

diff --git a/doc/field-structure.xml b/doc/field-structure.xml
index 67f3224..6eda6a5 100644 (file)
--- 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.3 2006-09-22 12:34:45 adam Exp $ -->
+  <!-- $Id: field-structure.xml,v 1.4 2006-11-13 14:53:40 marc Exp $ -->
   <title>Field Structure and Character Sets
   </title>
   
@@ -261,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::</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: