FIXMEs in comments.
authorAdam Dickmeiss <adam@indexdata.dk>
Fri, 11 Oct 2002 09:05:09 +0000 (09:05 +0000)
committerAdam Dickmeiss <adam@indexdata.dk>
Fri, 11 Oct 2002 09:05:09 +0000 (09:05 +0000)
Fixed indentation of Zen and the..

doc/administration.xml
doc/introduction.xml
doc/quickstart.xml
doc/recordmodel.xml
doc/server.xml

index 51d3025..5e3b545 100644 (file)
@@ -1,5 +1,5 @@
 <chapter id="administration">
 <chapter id="administration">
- <!-- $Id: administration.xml,v 1.7 2002-10-10 14:27:18 heikki Exp $ -->
+ <!-- $Id: administration.xml,v 1.8 2002-10-11 09:05:09 adam Exp $ -->
  <title>Administrating Zebra</title>
  
  <para>
  <title>Administrating Zebra</title>
  
  <para>
    explained further in the following sections.
   </para>
   
    explained further in the following sections.
   </para>
   
-  <para>
+  <!--
    FIXME - Didn't Adam make something to have multiple databases in multiple dirs...
    FIXME - Didn't Adam make something to have multiple databases in multiple dirs...
-  </para>
+  -->
   
   <para>
    <variablelist>
   
   <para>
    <variablelist>
      <listitem>
       <para>
        Specifies the Z39.50 database name.
      <listitem>
       <para>
        Specifies the Z39.50 database name.
-       FIXME - now we can have multiple databases in one server. -H
+       <!-- FIXME - now we can have multiple databases in one server. -H -->
       </para>
      </listitem>
     </varlistentry>
       </para>
      </listitem>
     </varlistentry>
    in order to modify the indexes correctly at a later time.
   </para>
   
    in order to modify the indexes correctly at a later time.
   </para>
   
-   <!--FIXME - There must be a simpler way to do this with Adams string tags -H
+   <!--
+    FIXME - There must be a simpler way to do this with Adams string tags -H
      -->
 
   <para>
      -->
 
   <para>
index d93603c..5e51c1e 100644 (file)
@@ -1,5 +1,5 @@
 <chapter id="introduction">
 <chapter id="introduction">
- <!-- $Id: introduction.xml,v 1.15 2002-10-10 14:27:18 heikki Exp $ -->
+ <!-- $Id: introduction.xml,v 1.16 2002-10-11 09:05:09 adam Exp $ -->
  <title>Introduction</title>
  
  <sect1>
  <title>Introduction</title>
  
  <sect1>
       Zebra is written in portable C, so it runs on most Unix-like systems 
       as well as Windows NT.  A binary distribution for Windows NT is
       available at
       Zebra is written in portable C, so it runs on most Unix-like systems 
       as well as Windows NT.  A binary distribution for Windows NT is
       available at
-      <ulink url="http://ftp.indexdata.dk/pub/zebra/win32/">
+      <ulink url="http://ftp.indexdata.dk/pub/zebra/win32/"/>
      </para>
     </listitem>
     
      </para>
     </listitem>
     
index f962421..2fa7ad9 100644 (file)
@@ -1,11 +1,11 @@
 <chapter id="quick-start">
 <chapter id="quick-start">
- <!-- $Id: quickstart.xml,v 1.3 2002-10-08 08:09:43 mike Exp $ -->
+ <!-- $Id: quickstart.xml,v 1.4 2002-10-11 09:05:09 adam Exp $ -->
  <title>Quick Start </title>
  
  <title>Quick Start </title>
  
- <para>
+ <!--
   FIXME - Start with the new improved example scripts that run 
   without any configuration file changes!
   FIXME - Start with the new improved example scripts that run 
   without any configuration file changes!
- </para>
+ -->
 
  <para>
   In this section, we will test the system by indexing a small set of sample
 
  <para>
   In this section, we will test the system by indexing a small set of sample
index 87db1df..d067cfd 100644 (file)
@@ -1,5 +1,5 @@
  <chapter id="record-model">
  <chapter id="record-model">
-  <!-- $Id: recordmodel.xml,v 1.6 2002-10-10 14:27:18 heikki Exp $ -->
+  <!-- $Id: recordmodel.xml,v 1.7 2002-10-11 09:05:09 adam Exp $ -->
   <title>The Record Model</title>
   
   <para>
   <title>The Record Model</title>
   
   <para>
    structured
    record type <literal>grs</literal> as introduced in
    <xref linkend="record-types"/>.
    structured
    record type <literal>grs</literal> as introduced in
    <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>
 
       <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>
 
    <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>
     </screen>
-   <!-- FIXME That screen makes no sense! -H  -->
 
    </para>
 
 
    </para>
 
    <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>
     </screen>
-   <!-- FIXME That screen makes even less sense! -H  -->
 
    </para>
 
 
    </para>
 
      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>
 
      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>
 
      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:
      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>
 
        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>
 
        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>
 
index 8066c45..c56cff6 100644 (file)
@@ -1,16 +1,16 @@
 <chapter id="server">
 <chapter id="server">
- <!-- $Id: server.xml,v 1.3 2002-04-10 14:47:49 heikki Exp $ -->
+ <!-- $Id: server.xml,v 1.4 2002-10-11 09:05:09 adam Exp $ -->
  <title>The Z39.50 Server</title>
  
  <sect1 id="zebrasrv">
   <title>Running the Z39.50 Server (zebrasrv)</title>
 
  <title>The Z39.50 Server</title>
  
  <sect1 id="zebrasrv">
   <title>Running the Z39.50 Server (zebrasrv)</title>
 
-  <para>
+  <!--
    FIXME - We need to be consistent here, zebraidx had the options at the
            end, and lots of explaining text before them. Same for zebrasvr! -H
    FIXME - At least we need a small intro, what is zebrasvr, and how it
            can be run (inetd, nt service, stand-alone program, daemon...) -H
    FIXME - We need to be consistent here, zebraidx had the options at the
            end, and lots of explaining text before them. Same for zebrasvr! -H
    FIXME - At least we need a small intro, what is zebrasvr, and how it
            can be run (inetd, nt service, stand-alone program, daemon...) -H
-  </para>
+  -->
 
   <para>
    <emphasis remap="bf">Syntax</emphasis>
 
   <para>
    <emphasis remap="bf">Syntax</emphasis>
   <sect2 id="search">
    <title>Search</title>
 
   <sect2 id="search">
    <title>Search</title>
 
-   <para>
+   <!--
     FIXME - Need to explain the string tag stuff before people get bogged 
             down with all these attribute numbers. Perhaps in its own
             chapter? -H
     FIXME - Need to explain the string tag stuff before people get bogged 
             down with all these attribute numbers. Perhaps in its own
             chapter? -H
-   </para>
+   -->
 
    <para>
     The supported query type are 1 and 101. All operators are currently
 
    <para>
     The supported query type are 1 and 101. All operators are currently
        <term>x?</term>
        <listitem>
         <para>
        <term>x?</term>
        <listitem>
         <para>
-         Matches <emphasis>x</emphasis> once or twice. Priority: high.
-         FIXME Is this right? Std regexp has '?' meaning zero or one -H
+         Matches <emphasis>x</emphasis> zero or once. Priority: high.
         </para>
        </listitem>
       </varlistentry>
         </para>
        </listitem>
       </varlistentry>