X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Frecordmodel.xml;h=3d5afb8cdfc00cc999041057ba53f1be4bdb16a9;hb=291f3ed7fc3e5d55e7993ae4e5c19e0bb0158d3d;hp=b438f33a51c3e678833fce486a27a640ac8e288a;hpb=49f49aa27c8d63cea66dfb5a9e06e5735c835509;p=idzebra-moved-to-github.git

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>