From 8d16f8a75221de7152eceb7d6be4d9e847d99e4f Mon Sep 17 00:00:00 2001
From: Adam Dickmeiss <adam@indexdata.dk>
Date: Tue, 3 Dec 2002 16:40:17 +0000
Subject: [PATCH] Description of systag. Adam's and Mike's versions both here.

---
 doc/administration.xml |   23 ++++++++++++++++++-
 doc/recordmodel.xml    |   57 +++++++++++++++++++++++++++++++++++++++++++++---
 2 files changed, 76 insertions(+), 4 deletions(-)

diff --git a/doc/administration.xml b/doc/administration.xml
index 7ab54c8..ff6410e 100644
--- a/doc/administration.xml
+++ b/doc/administration.xml
@@ -1,5 +1,5 @@
 <chapter id="administration">
- <!-- $Id: administration.xml,v 1.14 2002-12-03 16:10:19 mike Exp $ -->
+ <!-- $Id: administration.xml,v 1.15 2002-12-03 16:40:17 adam Exp $ -->
  <title>Administrating Zebra</title>
  <!-- ### It's a bit daft that this chapter (which describes half of
           the configuration-file formats) is separated from
@@ -322,6 +322,27 @@
      </listitem>
     </varlistentry>
 
+     <!--
+     no longer supported.
+    <varlistentry>
+     <term>tagsysno: 0|1</term>
+     <listitem>
+      <para>
+       Species whether Zebra should include system-number data in XML
+       and GRS-1 records returned to clients, represented by the
+       <literal>&lt;localControlNumber&gt;</literal> element in XML
+       and the <literal>(1,14)</literal> tag in GRS-1.
+       The content of these elements is an internally-generated
+       integer uniquely identifying the record within its database.
+       It is included by default but may be turned off, with
+       <literal>tagsysno: 0</literal> for databases in which a local
+       control number is explicitly specified in the input records
+       themselves.
+      </para>
+     </listitem>
+    </varlistentry>
+     -->
+     
    </variablelist>
   </para>
   
diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml
index 3d5afb8..ba72af1 100644
--- a/doc/recordmodel.xml
+++ b/doc/recordmodel.xml
@@ -1,5 +1,5 @@
  <chapter id="record-model">
-  <!-- $Id: recordmodel.xml,v 1.14 2002-12-03 16:10:19 mike Exp $ -->
+  <!-- $Id: recordmodel.xml,v 1.15 2002-12-03 16:40:17 adam Exp $ -->
   <title>The Record Model</title>
   
   <para>
@@ -1017,8 +1017,8 @@
          elm, this directive allows you to index attribute
          contents. The <replaceable>xpath</replaceable> uses
          a syntax similar to XPath. The <replaceable>attributes</replaceable>
-         have same syntax and meaning as directive elm, except that !
-         refers to the nodes selected by <replaceable>xpath</replaceable>.
+         have same syntax and meaning as directive elm, except that operator
+         ! refers to the nodes selected by <replaceable>xpath</replaceable>.
          <!--
          xelm   /         !:w                 default index
          xelm   //        !:w                 additional index
@@ -1052,6 +1052,57 @@
         </para>
        </listitem>
       </varlistentry>
+
+	<!-- Adam's version -->
+      <varlistentry>
+       <term>systag <replaceable>systemtag</replaceable> <replaceable>element</replaceable></term>
+       <listitem>
+        <para>
+         This directive maps system information to an element during
+         retrieval. This information is dynamically created. The
+         following system tags are defined
+         <variablelist>
+          <varlistentry>
+           <term>size</term>
+           <listitem>
+            <para>
+             Size of record in bytes. By default this
+             is mapped to element <literal>size</literal>.
+            </para>
+           </listitem>
+          </varlistentry>
+
+          <varlistentry>
+           <term>rank</term>
+           <listitem>
+            <para>
+             Score/rank of record. By default this
+             is mapped to element <literal>rank</literal>.
+             If no score was calculated for the record (non-ranked
+             searched) search this directive is ignored.
+            </para>
+           </listitem>
+          </varlistentry>
+          
+          <varlistentry>
+           <term>sysno</term>
+           <listitem> 
+            <para>
+             Zebra's system number (record ID) for the
+             record. By default this is mapped to element
+             <literal>localControlNumber</literal>.
+            </para>
+           </listitem>
+          </varlistentry>
+         </variablelist>
+         If you do not want a particular system tag to be applied,
+         then set the resulting element to something undefined in the
+         abs file (such as <literal>none</literal>).
+        </para>
+       </listitem>
+      </varlistentry>
+
+	<!-- Mike's version -->
       <varlistentry>
        <term>
         systag
-- 
1.7.10.4