Fixed bug #657: Problem with drop database and recordId: file.

[idzebra-moved-to-github.git] / doc / architecture.xml

diff --git a/doc/architecture.xml b/doc/architecture.xml
index ff840a6..307b828 100644 (file)
--- a/doc/architecture.xml
+++ b/doc/architecture.xml
@@ -1,11 +1,11 @@
  <chapter id="architecture">
  <chapter id="architecture">

-  <!-- $Id: architecture.xml,v 1.9 2006-06-13 09:27:01 marc Exp $ -->
+  <!-- $Id: architecture.xml,v 1.12 2006-09-03 21:37:26 adam Exp $ -->

   <title>Overview of Zebra Architecture</title>
   
 
   <title>Overview of Zebra Architecture</title>
   
 

-  <sect1 id="architecture-representation">
+  <section id="architecture-representation">

    <title>Local Representation</title>
    <title>Local Representation</title>

-
+   

    <para>
     As mentioned earlier, Zebra places few restrictions on the type of
     data that you can index and manage. Generally, whatever the form of
    <para>
     As mentioned earlier, Zebra places few restrictions on the type of
     data that you can index and manage. Generally, whatever the form of

@@ -30,9 +30,9 @@
     "grs" keyword, separated by "." characters.
     -->
    </para>
     "grs" keyword, separated by "." characters.
     -->
    </para>

-  </sect1>
+  </section>

 
 

-  <sect1 id="architecture-maincomponents">
+  <section id="architecture-maincomponents">

    <title>Main Components</title>
    <para>
     The Zebra system is designed to support a wide range of data management
    <title>Main Components</title>
    <para>
     The Zebra system is designed to support a wide range of data management

@@ -52,13 +52,13 @@
     same main components, which are presented here.
    </para>    
    <para>    
     same main components, which are presented here.
    </para>    
    <para>    

-    The virtual Debian package <literal>idzebra1.4</literal>
+    The virtual Debian package <literal>idzebra-2.0</literal>

     installs all the necessary packages to start
     working with Zebra - including utility programs, development libraries,
     documentation and modules. 
   </para>    
    
     installs all the necessary packages to start
     working with Zebra - including utility programs, development libraries,
     documentation and modules. 
   </para>    
    

-   <sect2 id="componentcore">
+   <section id="componentcore">

     <title>Core Zebra Libraries Containing Common Functionality</title>
     <para>
      The core Zebra module is the meat of the <command>zebraidx</command>
     <title>Core Zebra Libraries Containing Common Functionality</title>
     <para>
      The core Zebra module is the meat of the <command>zebraidx</command>

@@ -122,17 +122,17 @@
      </variablelist>
      </para>
     <para> 
      </variablelist>
      </para>
     <para> 

-     The Debian package <literal>libidzebra1.4</literal> 
+     The Debian package <literal>libidzebra-2.0</literal> 

      contains all run-time libraries for Zebra, the 
      documentation in PDF and HTML is found in 
      contains all run-time libraries for Zebra, the 
      documentation in PDF and HTML is found in 

-     <literal>idzebra1.4-doc</literal>, and
-     <literal>idzebra1.4-common</literal>
+     <literal>idzebra-2.0-doc</literal>, and
+     <literal>idzebra-2.0-common</literal>

      includes common essential Zebra configuration files.
     </para>
      includes common essential Zebra configuration files.
     </para>

-   </sect2>
+   </section>

    
 
    
 

-   <sect2 id="componentindexer">
+   <section id="componentindexer">

     <title>Zebra Indexer</title>
     <para>
      The  <command>zebraidx</command>
     <title>Zebra Indexer</title>
     <para>
      The  <command>zebraidx</command>

@@ -142,12 +142,12 @@
      indexes according to the rules defined in the filter modules.
     </para>    
     <para>    
      indexes according to the rules defined in the filter modules.
     </para>    
     <para>    

-     The Debian  package <literal>idzebra1.4-utils</literal> contains
+     The Debian  package <literal>idzebra-2.0-utils</literal> contains

      the  <command>zebraidx</command> utility.
     </para>
      the  <command>zebraidx</command> utility.
     </para>

-   </sect2>
+   </section>

 
 

-   <sect2 id="componentsearcher">
+   <section id="componentsearcher">

     <title>Zebra Searcher/Retriever</title>
     <para>
      This is the executable which runs the Z39.50/SRU/SRW server and
     <title>Zebra Searcher/Retriever</title>
     <para>
      This is the executable which runs the Z39.50/SRU/SRW server and

@@ -155,12 +155,12 @@
      great Information Retrieval server application. 
     </para>    
     <para>    
      great Information Retrieval server application. 
     </para>    
     <para>    

-     The Debian  package <literal>idzebra1.4-utils</literal> contains
+     The Debian  package <literal>idzebra-2.0-utils</literal> contains

      the  <command>zebrasrv</command> utility.
     </para>
      the  <command>zebrasrv</command> utility.
     </para>

-   </sect2>
+   </section>

 
 

-   <sect2 id="componentyazserver">
+   <section id="componentyazserver">

     <title>YAZ Server Frontend</title>
     <para>
      The YAZ server frontend is 
     <title>YAZ Server Frontend</title>
     <para>
      The YAZ server frontend is 

@@ -173,10 +173,10 @@
      as HTTP server, honoring
       <ulink url="http://www.loc.gov/standards/sru/srw/">SRW</ulink> 
      SOAP requests, and  
      as HTTP server, honoring
       <ulink url="http://www.loc.gov/standards/sru/srw/">SRW</ulink> 
      SOAP requests, and  

-     <ulink url="http://www.loc.gov/standards/sru/">SRU</ulink> 
+     <ulink url="&url.sru;">SRU</ulink> 

      REST requests. Moreover, it can
      translate incoming 
      REST requests. Moreover, it can
      translate incoming 

-     <ulink url="http://www.loc.gov/standards/sru/cql/">CQL</ulink>
+     <ulink url="&url.cql;">CQL</ulink>

      queries to
      <ulink url="http://indexdata.com/yaz/doc/tools.tkl#PQF">PQF</ulink>
       queries, if
      queries to
      <ulink url="http://indexdata.com/yaz/doc/tools.tkl#PQF">PQF</ulink>
       queries, if

@@ -190,9 +190,9 @@
      It is packaged in the Debian packages     
      <literal>yaz</literal> and <literal>libyaz</literal>.
     </para>
      It is packaged in the Debian packages     
      <literal>yaz</literal> and <literal>libyaz</literal>.
     </para>

-   </sect2>
+   </section>

    
    

-   <sect2 id="componentmodules">
+   <section id="componentmodules">

     <title>Record Models and Filter Modules</title>
     <para>
      The hard work of knowing <emphasis>what</emphasis> to index, 
     <title>Record Models and Filter Modules</title>
     <para>
      The hard work of knowing <emphasis>what</emphasis> to index, 

@@ -204,25 +204,23 @@
      </para>
      <para>
      The virtual Debian package
      </para>
      <para>
      The virtual Debian package

-     <literal>libidzebra1.4-modules</literal> installs all base filter
+     <literal>libidzebra-2.0-modules</literal> installs all base filter

      modules. 
     </para>
 
      modules. 
     </para>
 

-   <sect3 id="componentmodulestext">
+   
+   <section id="componentmodulestext">

     <title>TEXT Record Model and Filter Module</title>
     <para>
       Plain ASCII text filter. TODO: add information here.
     <title>TEXT Record Model and Filter Module</title>
     <para>
       Plain ASCII text filter. TODO: add information here.

-     <!--
-     <literal>text module missing as deb file<literal>
-     -->

     </para>
     </para>

-   </sect3>
+   </section>

 
 

-   <sect3 id="componentmodulesgrs">
+   <section id="componentmodulesgrs">

     <title>GRS Record Model and Filter Modules</title>
     <para>
     The GRS filter modules described in 
     <title>GRS Record Model and Filter Modules</title>
     <para>
     The GRS filter modules described in 

-    <xref linkend="record-model-grs"/>
+    <xref linkend="grs"/>

     are all based on the Z39.50 specifications, and it is absolutely
     mandatory to have the reference pages on BIB-1 attribute sets on
     you hand when configuring GRS filters. The GRS filters come in
     are all based on the Z39.50 specifications, and it is absolutely
     mandatory to have the reference pages on BIB-1 attribute sets on
     you hand when configuring GRS filters. The GRS filters come in

@@ -231,20 +229,12 @@
     to the <filename>*.abs</filename> configuration file suffix.
     </para>
     <para>
     to the <filename>*.abs</filename> configuration file suffix.
     </para>
     <para>

-     The <emphasis>grs.danbib</emphasis> filter is developed for 
-      DBC DanBib records.
-      DanBib is the Danish Union Catalogue hosted by DBC
-      (Danish Bibliographic Center). This filter is found in the
-      Debian package
-     <literal>libidzebra1.4-mod-grs-danbib</literal>.
-    </para>
-    <para>

       The <emphasis>grs.marc</emphasis> and 
       <emphasis>grs.marcxml</emphasis> filters are suited to parse and
       index binary and XML versions of traditional library MARC records 
       based on the ISO2709 standard. The Debian package for both
       filters is 
       The <emphasis>grs.marc</emphasis> and 
       <emphasis>grs.marcxml</emphasis> filters are suited to parse and
       index binary and XML versions of traditional library MARC records 
       based on the ISO2709 standard. The Debian package for both
       filters is 

-     <literal>libidzebra1.4-mod-grs-marc</literal>.
+     <literal>libidzebra-2.0-mod-grs-marc</literal>.

     </para>
     <para>
       GRS TCL scriptable filters for extensive user configuration come
     </para>
     <para>
       GRS TCL scriptable filters for extensive user configuration come

@@ -253,26 +243,26 @@
      a general scriptable TCL filter called 
      <emphasis>grs.tcl</emphasis>        
      are both included in the 
      a general scriptable TCL filter called 
      <emphasis>grs.tcl</emphasis>        
      are both included in the 

-     <literal>libidzebra1.4-mod-grs-regx</literal> Debian package.
+     <literal>libidzebra-2.0-mod-grs-regx</literal> Debian package.

     </para>
     <para>
       A general purpose SGML filter is called
      <emphasis>grs.sgml</emphasis>. This filter is not yet packaged,
      but planned to be in the  
     </para>
     <para>
       A general purpose SGML filter is called
      <emphasis>grs.sgml</emphasis>. This filter is not yet packaged,
      but planned to be in the  

-     <literal>libidzebra1.4-mod-grs-sgml</literal> Debian package.
+     <literal>libidzebra-2.0-mod-grs-sgml</literal> Debian package.

     </para>
     <para>
       The Debian  package 
     </para>
     <para>
       The Debian  package 

-      <literal>libidzebra1.4-mod-grs-xml</literal> includes the 
+      <literal>libidzebra-2.0-mod-grs-xml</literal> includes the 

       <emphasis>grs.xml</emphasis> filter which uses <ulink
       url="http://expat.sourceforge.net/">Expat</ulink> to 
       parse records in XML and turn them into IDZebra's internal GRS node
       trees. Have also a look at the Alvis XML/XSLT filter described in
       the next session.
     </para>
       <emphasis>grs.xml</emphasis> filter which uses <ulink
       url="http://expat.sourceforge.net/">Expat</ulink> to 
       parse records in XML and turn them into IDZebra's internal GRS node
       trees. Have also a look at the Alvis XML/XSLT filter described in
       the next session.
     </para>

-   </sect3>
+   </section>

 
 

-   <sect3 id="componentmodulesalvis">
+   <section id="componentmodulesalvis">

     <title>ALVIS Record Model and Filter Module</title>
      <para>
       The Alvis filter for XML files is an XSLT based input
     <title>ALVIS Record Model and Filter Module</title>
      <para>
       The Alvis filter for XML files is an XSLT based input

@@ -309,27 +299,26 @@
       <xref linkend="record-model-alvisxslt"/>.
       </para>
      <para>
       <xref linkend="record-model-alvisxslt"/>.
       </para>
      <para>

-      The Debian package <literal>libidzebra1.4-mod-alvis</literal>
+      The Debian package <literal>libidzebra-2.0-mod-alvis</literal>

       contains the Alvis filter module.
      </para>
       contains the Alvis filter module.
      </para>

-    </sect3>
+    </section>

 
 

-   <sect3 id="componentmodulessafari">
+    <!--
+   <section id="componentmodulessafari">

     <title>SAFARI Record Model and Filter Module</title>
     <para>
      SAFARI filter module TODO: add information here.
     <title>SAFARI Record Model and Filter Module</title>
     <para>
      SAFARI filter module TODO: add information here.

-     <!--
-     <literal>safari module missing as deb file<literal>
-     -->

     </para>
     </para>

-   </sect3>
+   </section>
+    -->

 
 

-   </sect2>
+   </section>

 
 

-  </sect1>
+  </section>

 
 
 
 

-  <sect1 id="architecture-workflow">
+  <section id="architecture-workflow">

    <title>Indexing and Retrieval Workflow</title>
 
   <para>
    <title>Indexing and Retrieval Workflow</title>
 
   <para>

@@ -379,9 +368,7 @@
    </itemizedlist>
 
   </para>
    </itemizedlist>
 
   </para>

-  </sect1>
-
-
+  </section>

 
  </chapter> 
 
 
  </chapter>