Deb: idzebra-2.0-utils includes init.d script
[idzebra-moved-to-github.git] / doc / recordmodel-domxml.xml
index 914f866..5aab33e 100644 (file)
@@ -1,5 +1,4 @@
 <chapter id="record-model-domxml">
-  <!-- $Id: recordmodel-domxml.xml,v 1.14 2007-05-24 13:44:09 adam Exp $ -->
   <title>&acro.dom; &acro.xml; Record Model and Filter Module</title>
   
   <para>
         <xmlreader level="1"/>
         <!-- <marc inputcharset="marc-8"/> -->
       </input>
-      <extrac>
+      <extract>
          <xslt stylesheet="common2index.xsl"/>
       </extract>
       <store>
    <para>
      The root &acro.xml; element <literal>&lt;dom&gt;</literal> and all other &acro.dom;
      &acro.xml; filter elements are residing in the namespace 
-     <literal>xmlns="http://indexdata.dk/zebra-2.0"</literal>.
+     <literal>xmlns="http://indexdata.com/zebra-2.0"</literal>.
    </para>
    <para>
     All pipeline definition elements - i.e. the
      similar to the Alvis filter indexing format - &acro.xml; documents
      containing &acro.xml; <literal>&lt;record&gt;</literal> and
      <literal>&lt;index&gt;</literal> instructions from the magic
-     namespace <literal>xmlns:z="http://indexdata.dk/zebra-2.0"</literal>.
+     namespace <literal>xmlns:z="http://indexdata.com/zebra-2.0"</literal>.
     </para>
 
    <section id="record-model-domxml-canonical-index-pi">
    
     <para>The output of the indexing &acro.xslt; stylesheets must contain
     certain elements in the magic 
-     <literal>xmlns:z="http://indexdata.dk/zebra-2.0"</literal>
+     <literal>xmlns:z="http://indexdata.com/zebra-2.0"</literal>
     namespace. The output of the &acro.xslt; indexing transformation is then
     parsed using &acro.dom; methods, and the contained instructions are
     performed on the <emphasis>magic elements and their
          processing instructions named
          <literal>zebra-2.0</literal> or
          elements contained in the namespace
-         <literal>xmlns:z="http://indexdata.dk/zebra-2.0"</literal>.
+         <literal>xmlns:z="http://indexdata.com/zebra-2.0"</literal>.
          </para>
        </listitem>
        <listitem>
               <listitem>
                <para>
                 The record is deleted. If the record does not already exist,
-                it is skipped (i.e. nothing is deleted).
+                a warning issued and rest of records are skipped in
+                from the input stream.
                </para>
               </listitem>
              </varlistentry>
                </para>
               </listitem>
              </varlistentry>
+             <varlistentry>
+              <term><literal>adelete</literal></term>
+              <listitem>
+               <para>
+                The record is deleted. If the record does not already exist,
+                it is skipped (i.e. nothing is deleted).
+               </para>
+               <note>
+                <para>
+                 Requires version 2.0.54 or later.
+                </para>
+               </note>
+              </listitem>
+             </varlistentry>
             </variablelist>
           Note that the value of <literal>type</literal> is only used to
           determine the action if and only if the Zebra indexer is running
          found. Therefore,
          invalid document processing is aborted, and any content of
          the <literal>&lt;extract&gt;</literal> and 
-         <literal>&lt;store&gt;</literal> pipelines is discarted.
+         <literal>&lt;store&gt;</literal> pipelines is discarded.
           A warning is issued in the logs. 
          </para>
        </listitem>
      <screen>
       <![CDATA[
       <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-       xmlns:z="http://indexdata.dk/zebra-2.0"
+       xmlns:z="http://indexdata.com/zebra-2.0"
        xmlns:oai="http://www.openarchives.org/&acro.oai;/2.0/" 
        xmlns:oai_dc="http://www.openarchives.org/&acro.oai;/2.0/oai_dc/" 
        xmlns:dc="http://purl.org/dc/elements/1.1/"
    <title>Debuggig &acro.dom; Filter Configurations</title>
    <para>
     It can be very hard to debug a &acro.dom; filter setup due to the many
-    sucessive &acro.marc; syntax translations, &acro.xml; stream splitting and 
+    successive &acro.marc; syntax translations, &acro.xml; stream splitting and 
     &acro.xslt; transformations involved. As an aid, you have always the
     power of the <literal>-s</literal> command line switch to the 
     <literal>zebraidz</literal> indexing command at your hand: 
      <screen>
       <![CDATA[  
       <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
-       xmlns:z="http://indexdata.dk/zebra/xslt/1"
+       xmlns:z="http://indexdata.com/zebra-2.0"
        version="1.0">
 
        <!- - register internal zebra parameters - ->