From 91500c092797da8e769f1e63ff0c6bd67aad0fc8 Mon Sep 17 00:00:00 2001
From: Marc Cromme <marc@indexdata.dk>
Date: Mon, 13 Nov 2006 14:53:40 +0000
Subject: [PATCH] added section on special zebra:: elemset names, and updated
 docs to follow suit with changes alvis oai filter example

---
 doc/field-structure.xml       |   41 ++++++++++++++++++++++++++++++++++++++++-
 doc/recordmodel-alvisxslt.xml |   18 +++++++++---------
 2 files changed, 49 insertions(+), 10 deletions(-)

diff --git a/doc/field-structure.xml b/doc/field-structure.xml
index 67f3224..6eda6a5 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.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:
diff --git a/doc/recordmodel-alvisxslt.xml b/doc/recordmodel-alvisxslt.xml
index 564c7bf..f9ad320 100644
--- a/doc/recordmodel-alvisxslt.xml
+++ b/doc/recordmodel-alvisxslt.xml
@@ -1,5 +1,5 @@
  <chapter id="record-model-alvisxslt">
-  <!-- $Id: recordmodel-alvisxslt.xml,v 1.10 2006-09-22 12:34:45 adam Exp $ -->
+  <!-- $Id: recordmodel-alvisxslt.xml,v 1.11 2006-11-13 14:53:40 marc Exp $ -->
   <title>ALVIS XML Record Model and Filter Module</title>
   
 
@@ -113,15 +113,15 @@
            z:id="oai:JTRS:CP-3290---Volume-I" 
            z:rank="47896"
            z:type="update"&gt;
-       &lt;z:index name="oai:identifier" type="0"&gt;
+       &lt;z:index name="oai_identifier" type="0"&gt;
                 oai:JTRS:CP-3290---Volume-I&lt;/z:index&gt;
-       &lt;z:index name="oai:datestamp" type="0"&gt;2004-07-09&lt;/z:index&gt;
-       &lt;z:index name="oai:setspec" type="0"&gt;jtrs&lt;/z:index&gt;
-       &lt;z:index name="dc:all" type="w"&gt;
-          &lt;z:index name="dc:title" type="w"&gt;Proceedings of the 4th 
+       &lt;z:index name="oai_datestamp" type="0"&gt;2004-07-09&lt;/z:index&gt;
+       &lt;z:index name="oai_setspec" type="0"&gt;jtrs&lt;/z:index&gt;
+       &lt;z:index name="dc_all" type="w"&gt;
+          &lt;z:index name="dc_title" type="w"&gt;Proceedings of the 4th 
                 International Conference and Exhibition:
                 World Congress on Superconductivity - Volume I&lt;/z:index&gt;
-          &lt;z:index name="dc:creator" type="w"&gt;Kumar Krishen and *Calvin
+          &lt;z:index name="dc_creator" type="w"&gt;Kumar Krishen and *Calvin
                 Burnham, Editors&lt;/z:index&gt;
        &lt;/z:index&gt;
      &lt;/z:record&gt;
@@ -289,7 +289,7 @@
 
          <!-- OAI indexing templates -->
          <xsl:template match="oai:record/oai:header/oai:identifier">
-          <z:index name="oai:identifier" type="0">
+          <z:index name="oai_identifier" type="0">
            <xsl:value-of select="."/>
           </z:index>    
          </xsl:template>
@@ -298,7 +298,7 @@
 
          <!-- DC specific indexing templates -->
          <xsl:template match="oai:record/oai:metadata/oai_dc:dc/dc:title">
-          <z:index name="dc:title" type="w">
+          <z:index name="dc_title" type="w">
            <xsl:value-of select="."/>
           </z:index>
          </xsl:template>
-- 
1.7.10.4