projects / idzebra-moved-to-github.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Rolling commit. There's a little more prose in the developing
[idzebra-moved-to-github.git] / doc / recordmodel.xml
diff --git a/doc/recordmodel.xml b/doc/recordmodel.xml
index cdaf703..6ad60ed 100644 (file)
--- a/doc/recordmodel.xml
+++ b/doc/recordmodel.xml
@@ -1,5 +1,5 @@
  <chapter id="record-model">
  <chapter id="record-model">
-  <!-- $Id: recordmodel.xml,v 1.4 2002-08-22 14:58:22 adam Exp $ -->
+  <!-- $Id: recordmodel.xml,v 1.8 2002-10-17 08:10:08 mike Exp $ -->
   <title>The Record Model</title>
   
   <para>
   <title>The Record Model</title>
   
   <para>
@@ -8,7 +8,7 @@
    kind of structured data. Each record in the system is associated with
    a <emphasis>record schema</emphasis> which lends context to the data
    elements of the record.
    kind of structured data. Each record in the system is associated with
    a <emphasis>record schema</emphasis> which lends context to the data
    elements of the record.
-   Any number of record schema can coexist in the system.
+   Any number of record schemas can coexist in the system.
    Although it may be wise to use only a single schema within
    one database, the system poses no such restrictions.
   </para>
    Although it may be wise to use only a single schema within
    one database, the system poses no such restrictions.
   </para>
@@ -16,10 +16,12 @@
   <para>
    The record model described in this chapter applies to the fundamental,
    structured
   <para>
    The record model described in this chapter applies to the fundamental,
    structured
-   record type <literal>grs</literal> as introduced in
+   record type <literal>grs</literal>, introduced in
    <xref linkend="record-types"/>.
    <xref linkend="record-types"/>.
+   <!--
    FIXME - Need to describe the simple string-tag model, or at least 
    refer to it here. -H
    FIXME - Need to describe the simple string-tag model, or at least 
    refer to it here. -H
+   -->
   </para>
 
   <para>
   </para>
 
   <para>
@@ -183,29 +185,32 @@
 
      <screen>
       &#60;Distributor&#62;
 
      <screen>
       &#60;Distributor&#62;
-      &#60;Name&#62; USGS/WRD &#60;/Name&#62;
-      &#60;Organization&#62; USGS/WRD &#60;/Organization&#62;
-      &#60;Street-Address&#62;
-      U.S. GEOLOGICAL SURVEY, 505 MARQUETTE, NW
-      &#60;/Street-Address&#62;
-      &#60;City&#62; ALBUQUERQUE &#60;/City&#62;
-      &#60;State&#62; NM &#60;/State&#62;
-      &#60;Zip-Code&#62; 87102 &#60;/Zip-Code&#62;
-      &#60;Country&#62; USA &#60;/Country&#62;
-      &#60;Telephone&#62; (505) 766-5560 &#60;/Telephone&#62;
+        &#60;Name&#62; USGS/WRD &#60;/Name&#62;
+        &#60;Organization&#62; USGS/WRD &#60;/Organization&#62;
+        &#60;Street-Address&#62;
+          U.S. GEOLOGICAL SURVEY, 505 MARQUETTE, NW
+        &#60;/Street-Address&#62;
+        &#60;City&#62; ALBUQUERQUE &#60;/City&#62;
+        &#60;State&#62; NM &#60;/State&#62;
+        &#60;Zip-Code&#62; 87102 &#60;/Zip-Code&#62;
+        &#60;Country&#62; USA &#60;/Country&#62;
+        &#60;Telephone&#62; (505) 766-5560 &#60;/Telephone&#62;
       &#60;/Distributor&#62;
      </screen>
 
     </para>
 
       &#60;/Distributor&#62;
      </screen>
 
     </para>
 
-    <note>
-     <para>
+    <!-- There is no indentation in the example above!  -H
+    -note-
+     -para-
       The indentation used above is used to illustrate how Zebra
       interprets the mark-up. The indentation, in itself, has no
       significance to the parser for the canonical input format, which
       discards superfluous whitespace.
       The indentation used above is used to illustrate how Zebra
       interprets the mark-up. The indentation, in itself, has no
       significance to the parser for the canonical input format, which
       discards superfluous whitespace.
-     </para>
-    </note>
+     -/para-
+    -/note-
+    -->
+
     <para>
      The keywords surrounded by &lt;...&gt; are
      <emphasis>tags</emphasis>, while the sections of text
     <para>
      The keywords surrounded by &lt;...&gt; are
      <emphasis>tags</emphasis>, while the sections of text
@@ -215,7 +220,7 @@
      Each element is terminated by a closing tag - beginning
      with <literal>&#60;</literal>/, and containing the same symbolic
      tag-name as the corresponding opening tag.
      Each element is terminated by a closing tag - beginning
      with <literal>&#60;</literal>/, and containing the same symbolic
      tag-name as the corresponding opening tag.
-     The general closing tag - <literal>&#60;</literal>&gt;/ -
+     The general closing tag - <literal>&lt;</literal>/&gt; -
      terminates the element started by the last opening tag. The
      structuring of elements is significant.
      The element <emphasis>Telephone</emphasis>,
      terminates the element started by the last opening tag. The
      structuring of elements is significant.
      The element <emphasis>Telephone</emphasis>,
@@ -246,7 +251,7 @@
 
       <screen>
        &#60;gils&#62;
 
       <screen>
        &#60;gils&#62;
-       &#60;title&#62;Zen and the Art of Motorcycle Maintenance&#60;/title&#62;
+          &#60;title&#62;Zen and the Art of Motorcycle Maintenance&#60;/title&#62;
        &#60;/gils&#62;
       </screen>
 
        &#60;/gils&#62;
       </screen>
 
@@ -299,7 +304,7 @@
       tag with the same <emphasis>class</emphasis> and
       <emphasis>value</emphasis> settings, or by the
       appearance of another, normal tag. In other words, the end-tags for
       tag with the same <emphasis>class</emphasis> and
       <emphasis>value</emphasis> settings, or by the
       appearance of another, normal tag. In other words, the end-tags for
-      the variants used in the example above could have been saved.
+      the variants used in the example above could have been omitted.
      </para>
 
      <para>
      </para>
 
      <para>
@@ -603,9 +608,9 @@
    <para>
 
     <screen>
    <para>
 
     <screen>
-     TITLE     "Zen and the Art of Motorcycle Maintenance"
+        TITLE     "Zen and the Art of Motorcycle Maintenance"
      ROOT 
      ROOT 
-     AUTHOR    "Robert Pirsig"
+        AUTHOR    "Robert Pirsig"
     </screen>
 
    </para>
     </screen>
 
    </para>
@@ -618,11 +623,11 @@
    <para>
 
     <screen>
    <para>
 
     <screen>
-     TITLE     "Zen and the Art of Motorcycle Maintenance"
+        TITLE  "Zen and the Art of Motorcycle Maintenance"
      ROOT  
      ROOT  
-     FIRST-NAME "Robert"
-     AUTHOR
-     SURNAME    "Pirsig"
+           FIRST-NAME "Robert"
+        AUTHOR
+           SURNAME    "Pirsig"
     </screen>
 
    </para>
     </screen>
 
    </para>
@@ -702,12 +707,11 @@
      tree).
     </para>
 
      tree).
     </para>
 
-    <note>
-     <para>
+    <!--
       FIXME! Documentation needs extension here about types of nodes - numerical,
       textual, etc., plus the various types of inclusion notes.
      </para>
       FIXME! Documentation needs extension here about types of nodes - numerical,
       textual, etc., plus the various types of inclusion notes.
      </para>
-    </note>
+    -->
     
    </sect2>
 
     
    </sect2>
 
@@ -733,9 +737,9 @@
      or all of the following:
     </para>
 
      or all of the following:
     </para>
 
-    <para>
+    <!--
      FIXME - Need a diagram here, or a simple explanation how it all hangs together -H
      FIXME - Need a diagram here, or a simple explanation how it all hangs together -H
-    </para>
+    -->
 
     <para>
 
 
     <para>
 
@@ -1013,9 +1017,9 @@
        <listitem>
         <para>
          If this directive is followed by <literal>enable</literal>,
        <listitem>
         <para>
          If this directive is followed by <literal>enable</literal>,
-         then extra indexing is performed to allow for XPATH-like queries.
+         then extra indexing is performed to allow for XPath-like queries.
          If this directive is not specified - equivalent to 
          If this directive is not specified - equivalent to 
-         <literal>disable</literal> - no extra XPATH-indexing is performed.
+         <literal>disable</literal> - no extra XPath-indexing is performed.
         </para>
        </listitem>
       </varlistentry>
         </para>
        </listitem>
       </varlistentry>
@@ -1559,12 +1563,12 @@
      is assumed by the MARC family in Z39.50.
     </para>
 
      is assumed by the MARC family in Z39.50.
     </para>
 
-    <para>
+    <!--
      <emphasis>NOTE: FIXME! The schema-mapping functions are so far limited to a
       straightforward mapping of elements. This should be extended with
       mechanisms for conversions of the element contents, and conditional
       mappings of elements based on the record contents.</emphasis>
      <emphasis>NOTE: FIXME! The schema-mapping functions are so far limited to a
       straightforward mapping of elements. This should be extended with
       mechanisms for conversions of the element contents, and conditional
       mappings of elements based on the record contents.</emphasis>
-    </para>
+    -->
 
     <para>
      These are the directives of the schema mapping file format:
 
     <para>
      These are the directives of the schema mapping file format:
@@ -1614,11 +1618,11 @@
      header of the record.
     </para>
 
      header of the record.
     </para>
 
-    <para>
-     <emphasis>NOTE: FIXME! This will be described better. We're in the process of
+    <!--
+     NOTE: FIXME! This will be described better. We're in the process of
       re-evaluating and most likely changing the way that MARC records are
       handled by the system.</emphasis>
       re-evaluating and most likely changing the way that MARC records are
       handled by the system.</emphasis>
-    </para>
+    -->
 
    </sect2>
 
 
    </sect2>
 
@@ -1850,7 +1854,7 @@
        is used to show the hierarchical structure of the record. All
        "GRS" type records support both the GRS-1 and SUTRS
        representations.
        is used to show the hierarchical structure of the record. All
        "GRS" type records support both the GRS-1 and SUTRS
        representations.
-       FIXME - What is SUTRS - should be expanded here
+       <!-- FIXME - What is SUTRS - should be expanded here -->
       </para>
      </listitem>
 
       </para>
      </listitem>
 
@@ -1893,7 +1897,7 @@
        abstract syntaxes can be mapped to the SOIF format, although nested
        elements are represented by concatenation of the tag names at each
        level.
        abstract syntaxes can be mapped to the SOIF format, although nested
        elements are represented by concatenation of the tag names at each
        level.
-       FIXME - Is this used anywhere ? -H
+       <!-- FIXME - Is this used anywhere ? -H -->
       </para>
      </listitem>
 
       </para>
      </listitem>
 
Search Engine