From 291f3ed7fc3e5d55e7993ae4e5c19e0bb0158d3d Mon Sep 17 00:00:00 2001
From: Mike Taylor <mike@indexdata.com>
Date: Tue, 3 Dec 2002 16:10:19 +0000
Subject: [PATCH] Remove documentation of tagsysno (bah!) and add
 documentation of systag, though I don't properly understand
 what it's doing. Tweak the .cvsignore files.

---
 doc/.cvsignore         |    1 +
 doc/administration.xml |   20 +-------------------
 doc/recordmodel.xml    |   47 ++++++++++++++++++++++++++++++++++++++++++++++-
 perl/.cvsignore        |    1 +
 recctrl/.cvsignore     |    1 +
 5 files changed, 50 insertions(+), 20 deletions(-)
 create mode 100644 perl/.cvsignore

diff --git a/doc/.cvsignore b/doc/.cvsignore
index 4fd6401..b430ac7 100644
--- a/doc/.cvsignore
+++ b/doc/.cvsignore
@@ -8,6 +8,7 @@ zebra.aux
 zebra.pdf
 manpage.links
 manpage.refs
+tkl.xsl
 *.8
 *.1
 *.html
diff --git a/doc/administration.xml b/doc/administration.xml
index be92e8e..7ab54c8 100644
--- a/doc/administration.xml
+++ b/doc/administration.xml
@@ -1,5 +1,5 @@
 <chapter id="administration">
- <!-- $Id: administration.xml,v 1.13 2002-12-02 15:10:58 mike Exp $ -->
+ <!-- $Id: administration.xml,v 1.14 2002-12-03 16:10:19 mike 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,24 +322,6 @@
      </listitem>
     </varlistentry>
 
-    <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 b438f33..3d5afb8 100644
--- a/doc/recordmodel.xml
+++ b/doc/recordmodel.xml
@@ -1,5 +1,5 @@
  <chapter id="record-model">
-  <!-- $Id: recordmodel.xml,v 1.13 2002-10-31 10:11:39 adam Exp $ -->
+  <!-- $Id: recordmodel.xml,v 1.14 2002-12-03 16:10:19 mike Exp $ -->
   <title>The Record Model</title>
   
   <para>
@@ -1052,6 +1052,51 @@
         </para>
        </listitem>
       </varlistentry>
+      <varlistentry>
+       <term>
+        systag
+        <replaceable>systemTag</replaceable>
+        <replaceable>actualTag</replaceable>
+       </term>
+       <listitem>
+	<para>
+	 Specifies what information, if any, Zebra should
+	 automatically include in retrieval records for the 
+	 ``system fields'' that it supports.
+	 <replaceable>systemTag</replaceable> may
+	 be any of the following:
+	 <variablelist>
+	  <varlistentry>
+	   <term><literal>rank</literal></term>
+	   <listitem><para>
+	    An integer indicating the relevance-ranking score
+	    assigned to the record.
+	   </para></listitem>
+	  </varlistentry>
+	  <varlistentry>
+	   <term><literal>sysno</literal></term>
+	   <listitem><para>
+	    An automatically generated identifier for the record,
+	    unique within this database.  It is represented by the
+	    <literal>&lt;localControlNumber&gt;</literal> element in
+	    XML and the <literal>(1,14)</literal> tag in GRS-1.
+	   </para></listitem>
+	  </varlistentry>
+	  <varlistentry>
+	   <term><literal>size</literal></term>
+	   <listitem><para>
+	    The size, in bytes, of the retrieved record.
+	   </para></listitem>
+	  </varlistentry>
+	 </variablelist>
+	</para>
+	<para>
+	 The <replaceable>actualTag</replaceable> parameter may be
+	 <literal>none</literal> to indicate that the named element
+	 should be omitted from retrieval records.
+	</para>
+       </listitem>
+      </varlistentry>
      </variablelist>
     </para>
     
diff --git a/perl/.cvsignore b/perl/.cvsignore
new file mode 100644
index 0000000..1ddabaa
--- /dev/null
+++ b/perl/.cvsignore
@@ -0,0 +1 @@
+Makefile.PL
diff --git a/recctrl/.cvsignore b/recctrl/.cvsignore
index e995588..67bc5ad 100644
--- a/recctrl/.cvsignore
+++ b/recctrl/.cvsignore
@@ -1,3 +1,4 @@
 .deps
 Makefile
 Makefile.in
+perlread.h
-- 
1.7.10.4