small changes to format

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

diff --git a/doc/recordmodel-alvisxslt.xml b/doc/recordmodel-alvisxslt.xml
index e64bb84..8eee9b9 100644 (file)
--- a/doc/recordmodel-alvisxslt.xml
+++ b/doc/recordmodel-alvisxslt.xml
@@ -1,15 +1,20 @@
  <chapter id="record-model-alvisxslt">
  <chapter id="record-model-alvisxslt">

-  <!-- $Id: recordmodel-alvisxslt.xml,v 1.13 2007-02-01 21:26:30 marc Exp $ -->
-  <title>ALVIS XML Record Model and Filter Module</title>
-  
+  <!-- $Id: recordmodel-alvisxslt.xml,v 1.16 2007-02-20 14:28:31 marc Exp $ -->
+  <title>ALVIS &xml; Record Model and Filter Module</title>
+
+     <note>
+      <para>
+        The functionality of this record model has been improved and
+        replaced by the DOM &xml; record model. See 
+        <xref linkend="record-model-domxml"/>.
+      </para>
+     </note>  

 
   <para>
    The record model described in this chapter applies to the fundamental,
 
   <para>
    The record model described in this chapter applies to the fundamental,

-   structured XML
+   structured &xml;

    record type <literal>alvis</literal>, introduced in
    record type <literal>alvis</literal>, introduced in

-   <xref linkend="componentmodulesalvis"/>. The ALVIS XML record model
-   is experimental, and it's inner workings might change in future
-   releases of the Zebra Information Server.
+   <xref linkend="componentmodulesalvis"/>.

   </para>
 
   <para> This filter has been developed under the 
   </para>
 
   <para> This filter has been developed under the 

@@ -22,7 +27,7 @@
   <section id="record-model-alvisxslt-filter">
    <title>ALVIS Record Filter</title>
    <para>
   <section id="record-model-alvisxslt-filter">
    <title>ALVIS Record Filter</title>
    <para>

-    The experimental, loadable  Alvis XML/XSLT filter module
+    The experimental, loadable  Alvis &xml;/&xslt; filter module

    <literal>mod-alvis.so</literal> is packaged in the GNU/Debian package
     <literal>libidzebra1.4-mod-alvis</literal>.
     It is invoked by the <filename>zebra.cfg</filename> configuration statement
    <literal>mod-alvis.so</literal> is packaged in the GNU/Debian package
     <literal>libidzebra1.4-mod-alvis</literal>.
     It is invoked by the <filename>zebra.cfg</filename> configuration statement

@@ -31,12 +36,12 @@
     </screen>
     In this example on all data files with suffix 
     <filename>*.xml</filename>, where the
     </screen>
     In this example on all data files with suffix 
     <filename>*.xml</filename>, where the

-    Alvis XSLT filter configuration file is found in the
+    Alvis &xslt; filter configuration file is found in the

     path <filename>db/filter_alvis_conf.xml</filename>.
    </para>
     path <filename>db/filter_alvis_conf.xml</filename>.
    </para>

-   <para>The Alvis XSLT filter configuration file must be
-    valid XML. It might look like this (This example is
-    used for indexing and display of OAI harvested records):
+   <para>The Alvis &xslt; filter configuration file must be
+    valid &xml;. It might look like this (This example is
+    used for indexing and display of &oai; harvested records):

     <screen>
     &lt;?xml version="1.0" encoding="UTF-8"?&gt;
       &lt;schemaInfo&gt;
     <screen>
     &lt;?xml version="1.0" encoding="UTF-8"?&gt;
       &lt;schemaInfo&gt;

@@ -44,7 +49,7 @@
         &lt;schema name="index" identifier="http://indexdata.dk/zebra/xslt/1"
             stylesheet="xsl/oai2index.xsl" /&gt;
         &lt;schema name="dc" stylesheet="xsl/oai2dc.xsl" /&gt;
         &lt;schema name="index" identifier="http://indexdata.dk/zebra/xslt/1"
             stylesheet="xsl/oai2index.xsl" /&gt;
         &lt;schema name="dc" stylesheet="xsl/oai2dc.xsl" /&gt;

-        &lt;!-- use split level 2 when indexing whole OAI Record lists --&gt;
+        &lt;!-- use split level 2 when indexing whole &oai; Record lists --&gt;

         &lt;split level="2"/&gt;
       &lt;/schemaInfo&gt;
     </screen> 
         &lt;split level="2"/&gt;
       &lt;/schemaInfo&gt;
     </screen> 

@@ -57,47 +62,47 @@
     names defined in the <literal>name</literal> attributes must be
     unique, these are the literal <literal>schema</literal> or 
     <literal>element set</literal> names used in 
     names defined in the <literal>name</literal> attributes must be
     unique, these are the literal <literal>schema</literal> or 
     <literal>element set</literal> names used in 

-      <ulink url="http://www.loc.gov/standards/sru/srw/">SRW</ulink>,
-      <ulink url="&url.sru;">SRU</ulink> and
-    Z39.50 protocol queries.
+      <ulink url="http://www.loc.gov/standards/sru/srw/">&srw;</ulink>,
+      <ulink url="&url.sru;">&sru;</ulink> and
+    &z3950; protocol queries.

     The paths in the <literal>stylesheet</literal> attributes
     are relative to zebras working directory, or absolute to file
     system root.
    </para>
    <para>
     The <literal>&lt;split level="2"/&gt;</literal> decides where the
     The paths in the <literal>stylesheet</literal> attributes
     are relative to zebras working directory, or absolute to file
     system root.
    </para>
    <para>
     The <literal>&lt;split level="2"/&gt;</literal> decides where the

-    XML Reader shall split the
+    &xml; Reader shall split the

     collections of records into individual records, which then are
     collections of records into individual records, which then are

-    loaded into DOM, and have the indexing XSLT stylesheet applied.
+    loaded into &dom;, and have the indexing &xslt; stylesheet applied.

    </para>
    <para>
    </para>
    <para>

-    There must be exactly one indexing XSLT stylesheet, which is
+    There must be exactly one indexing &xslt; stylesheet, which is

     defined by the magic attribute  
     <literal>identifier="http://indexdata.dk/zebra/xslt/1"</literal>.
    </para>
 
    <section id="record-model-alvisxslt-internal">
     <title>ALVIS Internal Record Representation</title>   
     defined by the magic attribute  
     <literal>identifier="http://indexdata.dk/zebra/xslt/1"</literal>.
    </para>
 
    <section id="record-model-alvisxslt-internal">
     <title>ALVIS Internal Record Representation</title>   

-    <para>When indexing, an XML Reader is invoked to split the input
-    files into suitable record XML pieces. Each record piece is then
-    transformed to an XML DOM structure, which is essentially the
-    record model. Only XSLT transformations can be applied during
+    <para>When indexing, an &xml; Reader is invoked to split the input
+    files into suitable record &xml; pieces. Each record piece is then
+    transformed to an &xml; &dom; structure, which is essentially the
+    record model. Only &xslt; transformations can be applied during

     index, search and retrieval. Consequently, output formats are
     index, search and retrieval. Consequently, output formats are

-    restricted to whatever XSLT can deliver from the record XML
-    structure, be it other XML formats, HTML, or plain text. In case
-    you have <literal>libxslt1</literal> running with EXSLT support,
+    restricted to whatever &xslt; can deliver from the record &xml;
+    structure, be it other &xml; formats, HTML, or plain text. In case
+    you have <literal>libxslt1</literal> running with E&xslt; support,

     you can use this functionality inside the Alvis
     you can use this functionality inside the Alvis

-    filter configuration XSLT stylesheets.
+    filter configuration &xslt; stylesheets.

     </para>
    </section>
 
    <section id="record-model-alvisxslt-canonical">
     <title>ALVIS Canonical Indexing Format</title>   
     </para>
    </section>
 
    <section id="record-model-alvisxslt-canonical">
     <title>ALVIS Canonical Indexing Format</title>   

-    <para>The output of the indexing XSLT stylesheets must contain
+    <para>The output of the indexing &xslt; stylesheets must contain

     certain elements in the magic 
      <literal>xmlns:z="http://indexdata.dk/zebra/xslt/1"</literal>
     certain elements in the magic 
      <literal>xmlns:z="http://indexdata.dk/zebra/xslt/1"</literal>

-    namespace. The output of the XSLT indexing transformation is then
-    parsed using DOM methods, and the contained instructions are
+    namespace. The output of the &xslt; indexing transformation is then
+    parsed using &dom; methods, and the contained instructions are

     performed on the <emphasis>magic elements and their
     subtrees</emphasis>.
     </para>
     performed on the <emphasis>magic elements and their
     subtrees</emphasis>.
     </para>

@@ -127,13 +132,13 @@
      &lt;/z:record&gt;
      </screen>
     </para>
      &lt;/z:record&gt;
      </screen>
     </para>

-    <para>This means the following: From the original XML file 
-     <literal>one-record.xml</literal> (or from the XML record DOM of the
+    <para>This means the following: From the original &xml; file 
+     <literal>one-record.xml</literal> (or from the &xml; record &dom; of the

      same form coming from a splitted input file), the indexing
      same form coming from a splitted input file), the indexing

-     stylesheet produces an indexing XML record, which is defined by
+     stylesheet produces an indexing &xml; record, which is defined by

      the <literal>record</literal> element in the magic namespace
      <literal>xmlns:z="http://indexdata.dk/zebra/xslt/1"</literal>.
      the <literal>record</literal> element in the magic namespace
      <literal>xmlns:z="http://indexdata.dk/zebra/xslt/1"</literal>.

-     Zebra uses the content of 
+     &zebra; uses the content of 

      <literal>z:id="oai:JTRS:CP-3290---Volume-I"</literal> as internal
      record ID, and - in case static ranking is set - the content of 
      <literal>z:rank="47896"</literal> as static rank. Following the
      <literal>z:id="oai:JTRS:CP-3290---Volume-I"</literal> as internal
      record ID, and - in case static ranking is set - the content of 
      <literal>z:rank="47896"</literal> as static rank. Following the

@@ -187,8 +192,8 @@
      the same character normalization map <literal>w</literal>. 
     </para>
     <para>
      the same character normalization map <literal>w</literal>. 
     </para>
     <para>

-     Finally, this example configuration can be queried using PQF
-     queries, either transported by Z39.50, (here using a yaz-client) 
+     Finally, this example configuration can be queried using &pqf;
+     queries, either transported by &z3950;, (here using a yaz-client) 

      <screen>
       <![CDATA[
       Z> open localhost:9999
      <screen>
       <![CDATA[
       Z> open localhost:9999

@@ -205,21 +210,21 @@
      or the proprietary
      extentions <literal>x-pquery</literal> and
      <literal>x-pScanClause</literal> to
      or the proprietary
      extentions <literal>x-pquery</literal> and
      <literal>x-pScanClause</literal> to

-     SRU, and SRW
+     &sru;, and &srw;

      <screen>
       <![CDATA[
       http://localhost:9999/?version=1.1&operation=searchRetrieve&x-pquery=%40attr+1%3Ddc_creator+%40attr+4%3D6+%22the
       http://localhost:9999/?version=1.1&operation=scan&x-pScanClause=@attr+1=dc_date+@attr+4=2+a
       ]]>
      </screen>
      <screen>
       <![CDATA[
       http://localhost:9999/?version=1.1&operation=searchRetrieve&x-pquery=%40attr+1%3Ddc_creator+%40attr+4%3D6+%22the
       http://localhost:9999/?version=1.1&operation=scan&x-pScanClause=@attr+1=dc_date+@attr+4=2+a
       ]]>
      </screen>

-     See <xref linkend="zebrasrv-sru"/> for more information on SRU/SRW
-     configuration, and <xref linkend="gfs-config"/> or the YAZ
-     <ulink url="&url.yaz.cql;">CQL section</ulink>
-     for the details or the YAZ frontend server.
+     See <xref linkend="zebrasrv-sru"/> for more information on &sru;/&srw;
+     configuration, and <xref linkend="gfs-config"/> or the &yaz;
+     <ulink url="&url.yaz.cql;">&cql; section</ulink>
+     for the details or the &yaz; frontend server.

     </para>
     <para>
      Notice that there are no <filename>*.abs</filename>,
     </para>
     <para>
      Notice that there are no <filename>*.abs</filename>,

-     <filename>*.est</filename>, <filename>*.map</filename>, or other GRS-1
+     <filename>*.est</filename>, <filename>*.map</filename>, or other &grs1;

      filter configuration files involves in this process, and that the
      literal index names are used during search and retrieval.
     </para>
      filter configuration files involves in this process, and that the
      literal index names are used during search and retrieval.
     </para>

@@ -236,7 +241,7 @@
     <para>
      As mentioned above, there can be only one indexing
      stylesheet, and configuration of the indexing process is a synonym
     <para>
      As mentioned above, there can be only one indexing
      stylesheet, and configuration of the indexing process is a synonym

-     of writing an XSLT stylesheet which produces XML output containing the
+     of writing an &xslt; stylesheet which produces &xml; output containing the

      magic elements discussed in  
      <xref linkend="record-model-alvisxslt-internal"/>. 
      Obviously, there are million of different ways to accomplish this
      magic elements discussed in  
      <xref linkend="record-model-alvisxslt-internal"/>. 
      Obviously, there are million of different ways to accomplish this

@@ -246,30 +251,30 @@
     <para>
      Stylesheets can be written in the <emphasis>pull</emphasis> or
      the <emphasis>push</emphasis> style: <emphasis>pull</emphasis>
     <para>
      Stylesheets can be written in the <emphasis>pull</emphasis> or
      the <emphasis>push</emphasis> style: <emphasis>pull</emphasis>

-     means that the output XML structure is taken as starting point of
-     the internal structure of the XSLT stylesheet, and portions of
-     the input XML are <emphasis>pulled</emphasis> out and inserted
-     into the right spots of the output XML structure. On the other
-     side, <emphasis>push</emphasis> XSLT stylesheets are recursavly
+     means that the output &xml; structure is taken as starting point of
+     the internal structure of the &xslt; stylesheet, and portions of
+     the input &xml; are <emphasis>pulled</emphasis> out and inserted
+     into the right spots of the output &xml; structure. On the other
+     side, <emphasis>push</emphasis> &xslt; stylesheets are recursavly

      calling their template definitions, a process which is commanded
      calling their template definitions, a process which is commanded

-     by the input XML structure, and avake to produce some output XML
+     by the input &xml; structure, and avake to produce some output &xml;

      whenever some special conditions in the input styelsheets are
      met. The <emphasis>pull</emphasis> type is well-suited for input
      whenever some special conditions in the input styelsheets are
      met. The <emphasis>pull</emphasis> type is well-suited for input

-     XML with strong and well-defined structure and semantcs, like the
-     following OAI indexing example, whereas the
+     &xml; with strong and well-defined structure and semantcs, like the
+     following &oai; indexing example, whereas the

      <emphasis>push</emphasis> type might be the only possible way to
      <emphasis>push</emphasis> type might be the only possible way to

-     sort out deeply recursive input XML formats.
+     sort out deeply recursive input &xml; formats.

     </para>
     <para> 
      A <emphasis>pull</emphasis> stylesheet example used to index
     </para>
     <para> 
      A <emphasis>pull</emphasis> stylesheet example used to index

-     OAI harvested records could use some of the following template
+     &oai; harvested records could use some of the following template

      definitions:
      <screen>
       <![CDATA[
       <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        xmlns:z="http://indexdata.dk/zebra/xslt/1"
      definitions:
      <screen>
       <![CDATA[
       <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        xmlns:z="http://indexdata.dk/zebra/xslt/1"

-       xmlns:oai="http://www.openarchives.org/OAI/2.0/" 
-       xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" 
+       xmlns:oai="http://www.openarchives.org/&oai;/2.0/" 
+       xmlns:oai_dc="http://www.openarchives.org/&oai;/2.0/oai_dc/" 

        xmlns:dc="http://purl.org/dc/elements/1.1/"
        version="1.0">
 
        xmlns:dc="http://purl.org/dc/elements/1.1/"
        version="1.0">
 

@@ -282,12 +287,12 @@
          <xsl:template match="/">    
           <z:record z:id="{normalize-space(oai:record/oai:header/oai:identifier)}" 
            z:type="update">
          <xsl:template match="/">    
           <z:record z:id="{normalize-space(oai:record/oai:header/oai:identifier)}" 
            z:type="update">

-           <!-- you might want to use z:rank="{some XSLT function here}" --> 
+           <!-- you might want to use z:rank="{some &xslt; function here}" --> 

            <xsl:apply-templates/>
           </z:record>
          </xsl:template>
 
            <xsl:apply-templates/>
           </z:record>
          </xsl:template>
 

-         <!-- OAI indexing templates -->
+         <!-- &oai; indexing templates -->

          <xsl:template match="oai:record/oai:header/oai:identifier">
           <z:index name="oai_identifier" type="0">
            <xsl:value-of select="."/>
          <xsl:template match="oai:record/oai:header/oai:identifier">
           <z:index name="oai_identifier" type="0">
            <xsl:value-of select="."/>

@@ -312,17 +317,17 @@
     <para>
      Notice also,
      that the names and types of the indexes can be defined in the
     <para>
      Notice also,
      that the names and types of the indexes can be defined in the

-     indexing XSLT stylesheet <emphasis>dynamically according to
-     content in the original XML records</emphasis>, which has
+     indexing &xslt; stylesheet <emphasis>dynamically according to
+     content in the original &xml; records</emphasis>, which has

      opportunities for great power and wizardery as well as grande
      disaster.  
     </para>
     <para>
      The following excerpt of a <emphasis>push</emphasis> stylesheet
      <emphasis>might</emphasis> 
      opportunities for great power and wizardery as well as grande
      disaster.  
     </para>
     <para>
      The following excerpt of a <emphasis>push</emphasis> stylesheet
      <emphasis>might</emphasis> 

-     be a good idea according to your strict control of the XML
+     be a good idea according to your strict control of the &xml;

      input format (due to rigerours checking against well-defined and
      input format (due to rigerours checking against well-defined and

-     tight RelaxNG or XML Schema's, for example):
+     tight RelaxNG or &xml; Schema's, for example):

      <screen>
       <![CDATA[
       <xsl:template name="element-name-indexes">     
      <screen>
       <![CDATA[
       <xsl:template name="element-name-indexes">     

@@ -333,11 +338,11 @@
       ]]>
      </screen>
      This template creates indexes which have the name of the working 
       ]]>
      </screen>
      This template creates indexes which have the name of the working 

-     node of any input  XML file, and assigns a '1' to the index.
+     node of any input  &xml; file, and assigns a '1' to the index.

      The example query 
      <literal>find @attr 1=xyz 1</literal> 
      finds all files which contain at least one
      The example query 
      <literal>find @attr 1=xyz 1</literal> 
      finds all files which contain at least one

-     <literal>xyz</literal> XML element. In case you can not control
+     <literal>xyz</literal> &xml; element. In case you can not control

      which element names the input files contain, you might ask for
      disaster and bad karma using this technique.
     </para>
      which element names the input files contain, you might ask for
      disaster and bad karma using this technique.
     </para>

@@ -375,18 +380,18 @@
    <title>ALVIS Exchange Formats</title>
    <para>
      An exchange format can be anything which can be the outcome of an
    <title>ALVIS Exchange Formats</title>
    <para>
      An exchange format can be anything which can be the outcome of an

-     XSLT transformation, as far as the stylesheet is registered in
-     the main Alvis XSLT filter configuration file, see
+     &xslt; transformation, as far as the stylesheet is registered in
+     the main Alvis &xslt; filter configuration file, see

      <xref linkend="record-model-alvisxslt-filter"/>.
      <xref linkend="record-model-alvisxslt-filter"/>.

-     In principle anything that can be expressed in  XML, HTML, and
+     In principle anything that can be expressed in  &xml;, HTML, and

      TEXT can be the output of a <literal>schema</literal> or 
     <literal>element set</literal> directive during search, as long as
      the information comes from the 
      TEXT can be the output of a <literal>schema</literal> or 
     <literal>element set</literal> directive during search, as long as
      the information comes from the 

-     <emphasis>original input record XML DOM tree</emphasis>
-     (and not the transformed and <emphasis>indexed</emphasis> XML!!).
+     <emphasis>original input record &xml; &dom; tree</emphasis>
+     (and not the transformed and <emphasis>indexed</emphasis> &xml;!!).

     </para>
     <para>
     </para>
     <para>

-     In addition, internal administrative information from the Zebra
+     In addition, internal administrative information from the &zebra;

      indexer can be accessed during record retrieval. The following
      example is a summary of the possibilities:
      <screen>
      indexer can be accessed during record retrieval. The following
      example is a summary of the possibilities:
      <screen>

@@ -421,15 +426,15 @@
   </section>
 
   <section id="record-model-alvisxslt-example">
   </section>
 
   <section id="record-model-alvisxslt-example">

-   <title>ALVIS Filter OAI Indexing Example</title>
+   <title>ALVIS Filter &oai; Indexing Example</title>

    <para>
      The sourcecode tarball contains a working Alvis filter example in
      the directory <filename>examples/alvis-oai/</filename>, which
      should get you started.  
     </para>
     <para>
    <para>
      The sourcecode tarball contains a working Alvis filter example in
      the directory <filename>examples/alvis-oai/</filename>, which
      should get you started.  
     </para>
     <para>

-     More example data can be harvested from any OAI complient server,
-     see details at the  OAI 
+     More example data can be harvested from any &oai; complient server,
+     see details at the  &oai; 

      <ulink url="http://www.openarchives.org/">
       http://www.openarchives.org/</ulink> web site, and the community
       links at 
      <ulink url="http://www.openarchives.org/">
       http://www.openarchives.org/</ulink> web site, and the community
       links at 

@@ -450,7 +455,7 @@
 
 <!--
 
 
 <!--
 

-c)  Main "alvis" XSLT filter config file:
+c)  Main "alvis" &xslt; filter config file:

   cat db/filter_alvis_conf.xml 
 
   <?xml version="1.0" encoding="UTF8"?>
   cat db/filter_alvis_conf.xml 
 
   <?xml version="1.0" encoding="UTF8"?>

@@ -470,7 +475,7 @@ c)  Main "alvis" XSLT filter config file:
 
   The split level decides where the SAX parser shall split the
   collections of records into individual records, which then are
 
   The split level decides where the SAX parser shall split the
   collections of records into individual records, which then are

-  loaded into DOM, and have the indexing XSLT stylesheet applied.
+  loaded into &dom;, and have the indexing &xslt; stylesheet applied.

 
   The indexing stylesheet is found by it's identifier.
 
 
   The indexing stylesheet is found by it's identifier.
 

@@ -487,12 +492,12 @@ c)  Main "alvis" XSLT filter config file:
   and so on.
 
 - in db/ a cql2pqf.txt yaz-client config file 
   and so on.
 
 - in db/ a cql2pqf.txt yaz-client config file 

-  which is also used in the yaz-server <ulink url="&url.cql;">CQL</ulink>-to-PQF process
+  which is also used in the yaz-server <ulink url="&url.cql;">&cql;</ulink>-to-&pqf; process

 
    see: http://www.indexdata.com/yaz/doc/tools.tkl#tools.cql.map
 
 
    see: http://www.indexdata.com/yaz/doc/tools.tkl#tools.cql.map
 

-- in db/ an indexing XSLT stylesheet. This is a PULL-type XSLT thing,
-  as it constructs the new XML structure by pulling data out of the
+- in db/ an indexing &xslt; stylesheet. This is a PULL-type XSLT thing,
+  as it constructs the new &xml; structure by pulling data out of the

   respective elements/attributes of the old structure.
 
   Notice the special zebra namespace, and the special elements in this
   respective elements/attributes of the old structure.
 
   Notice the special zebra namespace, and the special elements in this

@@ -502,7 +507,7 @@ c)  Main "alvis" XSLT filter config file:
   indicates that a new record with given id and static rank has to be updated. 
 
   <z:index name="title" type="w">
   indicates that a new record with given id and static rank has to be updated. 
 
   <z:index name="title" type="w">

-   encloses all the text/XML which shall be indexed in the index named
+   encloses all the text/&xml; which shall be indexed in the index named

    "title" and of index type "w" (see  file default.idx in your zebra
    installation) 
 
    "title" and of index type "w" (see  file default.idx in your zebra
    installation)