<chapter id="record-model-domxml">
- <!-- $Id: recordmodel-domxml.xml,v 1.7 2007-02-21 14:15:07 marc Exp $ -->
+ <!-- $Id: recordmodel-domxml.xml,v 1.13 2007-03-21 19:37:00 adam Exp $ -->
<title>&dom; &xml; Record Model and Filter Module</title>
-
+
<para>
The record model described in this chapter applies to the fundamental,
structured &xml;
- record type <literal>dom</literal>, introduced in
+ record type <literal>&dom;</literal>, introduced in
<xref linkend="componentmodulesdom"/>. The &dom; &xml; record model
is experimental, and it's inner workings might change in future
releases of the &zebra; Information Server.
<para>
The &dom; &xml; filter uses a standard &dom; &xml; structure as
internal data model, and can therefore parse, index, and display
- any &xml; document type. It is wellsuited to work on
+ any &xml; document type. It is well suited to work on
standardized &xml;-based formats such as Dublin Core, MODS, METS,
MARCXML, OAI-PMH, RSS, and performs equally well on any other
non-standard &xml; format.
<para>
The &dom; filter architecture consists of four
- different pipelines, each being a chain of arbitraily many sucessive
+ different pipelines, each being a chain of arbitrarily many successive
&xslt; transformations of the internal &dom; &xml;
representations of documents.
</para>
<para>
The root &xml; element <literal><dom></literal> and all other &dom;
&xml; filter elements are residing in the namespace
- <literal>http://indexdata.com/zebra-2.0</literal>.
+ <literal>xmlns="http://indexdata.dk/zebra-2.0"</literal>.
</para>
<para>
All pipeline definition elements - i.e. the
<literal><input></literal>,
- <literal><extact></literal>,
+ <literal><extract></literal>,
<literal><store></literal>, and
<literal><retrieve></literal> elements - are optional.
Missing pipeline definitions are just interpreted
do-nothing identity pipelines.
</para>
<para>
- All pipeine definition elements may contain zero or more
+ All pipeline definition elements may contain zero or more
<literal><![CDATA[<xslt stylesheet="path/file.xsl"/>]]></literal>
&xslt; transformation instructions, which are performed
sequentially from top to bottom.
<literal><![CDATA[<xslt stylesheet="path/file.xsl"/>]]></literal>
&xslt; transformations. At the end of this pipeline, the documents
are in the common format, used to feed both the
- <literal><extact></literal> and
+ <literal><extract></literal> and
<literal><store></literal> pipelines.
</para>
</section>
<section id="record-model-domxml-pipeline-extract">
<title>Extract pipeline</title>
<para>
- The <literal><extact></literal> pipeline takes documents
+ The <literal><extract></literal> pipeline takes documents
from any common &dom; &xml; format to the &zebra; specific
indexing &dom; &xml; format.
It may consist of zero ore more
<literal><![CDATA[<xslt stylesheet="path/file.xsl"/>]]></literal>
&xslt; transformations, and the outcome is handled to the
- &zebra; core to drive the proces of building the inverted
+ &zebra; core to drive the process of building the inverted
indexes. See
<xref linkend="record-model-domxml-canonical-index"/> for
details.
<section id="record-model-domxml-pipeline-store">
<title>Store pipeline</title>
The <literal><store></literal> pipeline takes documents
- from any common &dom; &xml; format to the &zebra; specific
- storage &dom; &xml; format.
+ from any common &dom; &xml; format to the &zebra; specific
+ storage &dom; &xml; format.
It may consist of zero ore more
<literal><![CDATA[<xslt stylesheet="path/file.xsl"/>]]></literal>
&xslt; transformations, and the outcome is handled to the
<section id="record-model-domxml-canonical-index">
- <title>Canonical Indexing Format</title>
+ <title>Canonical Indexing Format</title>
+
+ <para>
+ &dom; &xml; indexing comes in two flavors: pure
+ processing-instruction governed plain &xml; documents, and - very
+ similar to the Alvis filter indexing format - &xml; documents
+ containing &xml; <literal><record></literal> and
+ <literal><index></literal> instructions from the magic
+ namespace <literal>xmlns:z="http://indexdata.dk/zebra-2.0"</literal>.
+ </para>
+
+ <section id="record-model-domxml-canonical-index-pi">
+ <title>Processing-instruction governed indexing format</title>
+
+ <para>The output of the processing instruction driven
+ indexing &xslt; stylesheets must contain
+ processing instructions named
+ <literal>zebra-2.0</literal>.
+ The output of the &xslt; indexing transformation is then
+ parsed using &dom; methods, and the contained instructions are
+ performed on the <emphasis>elements and their
+ subtrees directly following the processing instructions</emphasis>.
+ </para>
+ <para>
+ For example, the output of the command
+ <screen>
+ xsltproc dom-index-pi.xsl marc-one.xml
+ </screen>
+ might look like this:
+ <screen>
+ <![CDATA[
+ <?xml version="1.0" encoding="UTF-8"?>
+ <?zebra-2.0 record id=11224466 rank=42?>
+ <record>
+ <?zebra-2.0 index control:0?>
+ <control>11224466</control>
+ <?zebra-2.0 index any:w title:w title:p title:s?>
+ <title>How to program a computer</title>
+ </record>
+ ]]>
+ </screen>
+ </para>
+ </section>
+
+ <section id="record-model-domxml-canonical-index-element">
+ <title>Magic element governed indexing format</title>
+
<para>The output of the indexing &xslt; stylesheets must contain
certain elements in the magic
<literal>xmlns:z="http://indexdata.dk/zebra-2.0"</literal>
</para>
<para>
For example, the output of the command
- <screen>
- xsltproc xsl/oai2index.xsl one-record.xml
+ <screen>
+ xsltproc dom-index-element.xsl marc-one.xml
</screen>
might look like this:
<screen>
- <?xml version="1.0" encoding="UTF-8"?>
- <z:record xmlns:z="http://indexdata.dk/zebra/xslt/1"
- z:id="oai:JTRS:CP-3290---Volume-I"
- z:rank="47896"
- z:type="update">
- <z:index name="oai_identifier" type="0">
- oai:JTRS:CP-3290---Volume-I</z:index>
- <z:index name="oai_datestamp" type="0">2004-07-09</z:index>
- <z:index name="oai_setspec" type="0">jtrs</z:index>
- <z:index name="dc_all" type="w">
- <z:index name="dc_title" type="w">Proceedings of the 4th
- International Conference and Exhibition:
- World Congress on Superconductivity - Volume I</z:index>
- <z:index name="dc_creator" type="w">Kumar Krishen and *Calvin
- Burnham, Editors</z:index>
- </z:index>
- </z:record>
+ <![CDATA[
+ <?xml version="1.0" encoding="UTF-8"?>
+ <z:record xmlns:z="http://indexdata.com/zebra-2.0"
+ z:id="11224466" z:rank="42">
+ <z:index name="control:0">11224466</z:index>
+ <z:index name="any:w title:w title:p title:s">
+ How to program a computer</z:index>
+ </z:record>
+ ]]>
</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
- same form coming from a splitted input file), the indexing
- 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>.
+ </section>
+
+
+ <section id="record-model-domxml-canonical-index-semantics">
+ <title>Semantics of the indexing formats</title>
+
+ <para>
+ Both indexing formats are defined with equal semantics and
+ behavior in mind:
+ <itemizedlist>
+ <listitem>
+ <para>&zebra; specific instructions are either
+ processing instructions named
+ <literal>zebra-2.0</literal> or
+ elements contained in the namespace
+ <literal>xmlns:z="http://indexdata.dk/zebra-2.0"</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>There must be exactly one <literal>record</literal>
+ instruction, which sets the scope for the following,
+ possibly nested <literal>index</literal> instructions.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ The unique <literal>record</literal> instruction
+ may have additional attributes <literal>id</literal>,
+ <literal>rank</literal> and <literal>type</literal>.
+ Attribute <literal>id</literal> is the value of the opaque ID
+ and may be any string not containing the whitespace character
+ <literal>' '</literal>.
+ The <literal>rank</literal> attribute value must be a
+ non-negative integer. See
+ <xref linkend="administration-ranking"/> .
+ The <literal>type</literal> attribute specifies how the record
+ is to be treated. The following values may be given for
+ <literal>type</literal>:
+ <variablelist>
+ <varlistentry>
+ <term><literal>insert</literal></term>
+ <listitem>
+ <para>
+ The record is inserted. If the record already exists, it is
+ skipped (i.e. not replaced).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>replace</literal></term>
+ <listitem>
+ <para>
+ The record is replaced. If the record does not already exist,
+ it is skipped (i.e. not inserted).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>delete</literal></term>
+ <listitem>
+ <para>
+ The record is deleted. If the record does not already exist,
+ it is skipped (i.e. nothing is deleted).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>update</literal></term>
+ <listitem>
+ <para>
+ The record is inserted or replaced depending on whether the
+ record exists or not. This is the default behavior but may
+ be effectively changed by "outside" the scope of the DOM
+ filter by zebraidx commands or extended services updates.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ Note that the value of <literal>type</literal> is only used to
+ determine the action if and only if the Zebra indexer is running
+ in "update" mode (i.e zebraidx update) or if the specialUpdate
+ action of the
+ <link linkend="administration-extended-services-z3950">Extended
+ Service Update</link> is used.
+ For this reason a specialUpdate may end up deleting records!
+ </para>
+ </listitem>
+ <listitem>
+ <para> Multiple and possible nested <literal>index</literal>
+ instructions must contain at least one
+ <literal>indexname:indextype</literal>
+ pair, and may contain multiple such pairs separated by the
+ whitespace character <literal>' '</literal>. In each index
+ pair, the name and the type of the index is separated by a
+ colon character <literal>':'</literal>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Any index name consisting of ASCII letters, and following the
+ standard &zebra; rules will do, see
+ <xref linkend="querymodel-pqf-apt-mapping-accesspoint"/>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Index types are restricted to the values defined in
+ the standard configuration
+ file <filename>default.idx</filename>, see
+ <xref linkend="querymodel-bib1"/> and
+ <xref linkend="fields-and-charsets"/> for details.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ &dom; input documents which are not resulting in both one
+ unique valid
+ <literal>record</literal> instruction and one or more valid
+ <literal>index</literal> instructions can not be searched and
+ found. Therefore,
+ invalid document processing is aborted, and any content of
+ the <literal><extract></literal> and
+ <literal><store></literal> pipelines is discarted.
+ A warning is issued in the logs.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>The examples work as follows:
+ From the original &xml; file
+ <literal>marc-one.xml</literal> (or from the &xml; record &dom; of the
+ same form coming from an <literal><input></literal>
+ pipeline),
+ the indexing
+ pipeline <literal><extract></literal>
+ produces an indexing &xml; record, which is defined by
+ the <literal>record</literal> instruction
&zebra; uses the content of
- <literal>z:id="oai:JTRS:CP-3290---Volume-I"</literal> as internal
+ <literal>z:id="11224466"</literal>
+ or
+ <literal>id=11224466</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
- discussion in <xref linkend="administration-ranking"/>
- we see that this records is internally ordered
- lexicographically according to the value of the string
- <literal>oai:JTRS:CP-3290---Volume-I47896</literal>.
- The type of action performed during indexing is defined by
- <literal>z:type="update"></literal>, with recognized values
- <literal>insert</literal>, <literal>update</literal>, and
- <literal>delete</literal>.
+ <literal>rank=42</literal>
+ or
+ <literal>z:rank="42"</literal>
+ as static rank.
</para>
- <para>In this example, the following literal indexes are constructed:
+
+
+ <para>In these examples, the following literal indexes are constructed:
<screen>
- oai_identifier
- oai_datestamp
- oai_setspec
- dc_all
- dc_title
- dc_creator
+ any:w
+ control:0
+ title:w
+ title:p
+ title:s
</screen>
- where the indexing type is defined in the
- <literal>type</literal> attribute
- (any value from the standard configuration
- file <filename>default.idx</filename> will do). Finally, any
+ where the indexing type is defined after the
+ literal <literal>':'</literal> character.
+ Any value from the standard configuration
+ file <filename>default.idx</filename> will do.
+ Finally, any
<literal>text()</literal> node content recursively contained
- inside the <literal>index</literal> will be filtered through the
- appropriate charmap for character normalization, and will be
- inserted in the index.
- </para>
- <para>
- Specific to this example, we see that the single word
- <literal>oai:JTRS:CP-3290---Volume-I</literal> will be literal,
- byte for byte without any form of character normalization,
- inserted into the index named <literal>oai:identifier</literal>,
- the text
- <literal>Kumar Krishen and *Calvin Burnham, Editors</literal>
- will be inserted using the <literal>w</literal> character
- normalization defined in <filename>default.idx</filename> into
- the index <literal>dc:creator</literal> (that is, after character
- normalization the index will keep the inidividual words
- <literal>kumar</literal>, <literal>krishen</literal>,
- <literal>and</literal>, <literal>calvin</literal>,
- <literal>burnham</literal>, and <literal>editors</literal>), and
- finally both the texts
- <literal>Proceedings of the 4th International Conference and Exhibition:
- World Congress on Superconductivity - Volume I</literal>
- and
- <literal>Kumar Krishen and *Calvin Burnham, Editors</literal>
- will be inserted into the index <literal>dc:all</literal> using
- the same character normalization map <literal>w</literal>.
+ inside the <literal><z:index></literal> element, or any
+ element following a <literal>index</literal> processing instruction,
+ will be filtered through the
+ appropriate char map for character normalization, and will be
+ inserted in the named indexes.
</para>
<para>
Finally, this example configuration can be queried using &pqf;
Z> elem dc
Z> form xml
Z>
- Z> f @attr 1=dc_creator Kumar
- Z> scan @attr 1=dc_creator adam
+ Z> find @attr 1=control @attr 4=3 11224466
+ Z> scan @attr 1=control @attr 4=3 ""
+ Z>
+ Z> find @attr 1=title program
+ Z> scan @attr 1=title ""
Z>
- Z> f @attr 1=dc_title @attr 4=2 "proceeding congress superconductivity"
- Z> scan @attr 1=dc_title abc
+ Z> find @attr 1=title @attr 4=2 "How to program a computer"
+ Z> scan @attr 1=title @attr 4=2 ""
]]>
</screen>
or the proprietary
- extentions <literal>x-pquery</literal> and
+ extensions <literal>x-pquery</literal> and
<literal>x-pScanClause</literal> to
&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
+ http://localhost:9999/?version=1.1&operation=searchRetrieve&x-pquery=@attr 1=title program
+ http://localhost:9999/?version=1.1&operation=scan&x-pScanClause=@attr 1=title ""
]]>
</screen>
See <xref linkend="zebrasrv-sru"/> for more information on &sru;/&srw;
filter configuration files involves in this process, and that the
literal index names are used during search and retrieval.
</para>
+ <para>
+ In case that we want to support the usual
+ <literal>bib-1</literal> &z3950; numeric access points, it is a
+ good idea to choose string index names defined in the default
+ configuration file <filename>tab/bib1.att</filename>, see
+ <xref linkend="attset-files"/>
+ </para>
+
+ </section>
+
</section>
</section>
<section id="record-model-domxml-index">
<title>&dom; Indexing Configuration</title>
<para>
- As mentioned above, there can be only one indexing
- stylesheet, and configuration of the indexing process is a synonym
+ As mentioned above, there can be only one indexing pipeline,
+ and configuration of the indexing process is a synonym
of writing an &xslt; stylesheet which produces &xml; output containing the
- magic elements discussed in
- <xref linkend="record-model-domxml-internal"/>.
+ magic processing instructions or elements discussed in
+ <xref linkend="record-model-domxml-canonical-index"/>.
Obviously, there are million of different ways to accomplish this
- task, and some comments and code snippets are in order to lead
- our paduans on the right track to the good side of the force.
+ task, and some comments and code snippets are in order to
+ enlighten the wary.
</para>
<para>
Stylesheets can be written in the <emphasis>pull</emphasis> or
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
+ into the right spots of the output &xml; structure.
+ On the other
+ side, <emphasis>push</emphasis> &xslt; stylesheets are recursively
calling their template definitions, a process which is commanded
- by the input &xml; structure, and avake to produce some output &xml;
- whenever some special conditions in the input styelsheets are
+ by the input &xml; structure, and is triggered to produce
+ some output &xml;
+ whenever some special conditions in the input stylesheets are
met. The <emphasis>pull</emphasis> type is well-suited for input
- &xml; with strong and well-defined structure and semantcs, like the
+ &xml; with strong and well-defined structure and semantics, like the
following &oai; indexing example, whereas the
<emphasis>push</emphasis> type might be the only possible way to
sort out deeply recursive input &xml; formats.
<screen>
<![CDATA[
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- xmlns:z="http://indexdata.dk/zebra/xslt/1"
+ xmlns:z="http://indexdata.dk/zebra-2.0"
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">
+ <!-- Example pull and magic element style Zebra indexing -->
<xsl:output indent="yes" method="xml" version="1.0" encoding="UTF-8"/>
<!-- disable all default text node output -->
<xsl:template match="text()"/>
- <!-- match on oai xml record root -->
+ <!-- disable all default recursive element node transversal -->
+ <xsl:template match="node()"/>
+
+ <!-- match only on oai xml record root -->
<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}" -->
+ <z:record z:id="{normalize-space(oai:record/oai:header/oai:identifier)}">
+ <!-- you may use z:rank="{some XSLT; function here}" -->
+
+ <!-- explicetly calling defined templates -->
<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">
+ <z:index name="oai_identifier:0">
<xsl:value-of select="."/>
</z:index>
</xsl:template>
<!-- DC specific indexing templates -->
<xsl:template match="oai:record/oai:metadata/oai_dc:dc/dc:title">
- <z:index name="dc_title" type="w">
+ <z:index name="dc_any:w dc_title:w dc_title:p dc_title:s ">
<xsl:value-of select="."/>
</z:index>
</xsl:template>
]]>
</screen>
</para>
+ </section>
+
+
+ <section id="record-model-domxml-index-marc">
+ <title>&dom; Indexing &marcxml;</title>
<para>
- Notice also,
- that the names and types of the indexes can be defined in the
+ The &dom; filter allows indexing of both binary &marc; records
+ and &marcxml; records, depending on it's configuration.
+ A typical &marcxml; record might look like this:
+ <screen>
+ <![CDATA[
+ <record xmlns="http://www.loc.gov/MARC21/slim">
+ <rank>42</rank>
+ <leader>00366nam 22001698a 4500</leader>
+ <controlfield tag="001"> 11224466 </controlfield>
+ <controlfield tag="003">DLC </controlfield>
+ <controlfield tag="005">00000000000000.0 </controlfield>
+ <controlfield tag="008">910710c19910701nju 00010 eng </controlfield>
+ <datafield tag="010" ind1=" " ind2=" ">
+ <subfield code="a"> 11224466 </subfield>
+ </datafield>
+ <datafield tag="040" ind1=" " ind2=" ">
+ <subfield code="a">DLC</subfield>
+ <subfield code="c">DLC</subfield>
+ </datafield>
+ <datafield tag="050" ind1="0" ind2="0">
+ <subfield code="a">123-xyz</subfield>
+ </datafield>
+ <datafield tag="100" ind1="1" ind2="0">
+ <subfield code="a">Jack Collins</subfield>
+ </datafield>
+ <datafield tag="245" ind1="1" ind2="0">
+ <subfield code="a">How to program a computer</subfield>
+ </datafield>
+ <datafield tag="260" ind1="1" ind2=" ">
+ <subfield code="a">Penguin</subfield>
+ </datafield>
+ <datafield tag="263" ind1=" " ind2=" ">
+ <subfield code="a">8710</subfield>
+ </datafield>
+ <datafield tag="300" ind1=" " ind2=" ">
+ <subfield code="a">p. cm.</subfield>
+ </datafield>
+ </record>
+ ]]>
+ </screen>
+ </para>
+
+ <para>
+ It is easily possible to make string manipulation in the &dom;
+ filter. For example, if you want to drop some leading articles
+ in the indexing of sort fields, you might want to pick out the
+ &marcxml; indicator attributes to chop of leading substrings. If
+ the above &xml; example would have an indicator
+ <literal>ind2="8"</literal> in the title field
+ <literal>245</literal>, i.e.
+ <screen>
+ <![CDATA[
+ <datafield tag="245" ind1="1" ind2="8">
+ <subfield code="a">How to program a computer</subfield>
+ </datafield>
+ ]]>
+ </screen>
+ one could write a template taking into account this information
+ to chop the first <literal>8</literal> characters from the
+ sorting index <literal>title:s</literal> like this:
+ <screen>
+ <![CDATA[
+ <xsl:template match="m:datafield[@tag='245']">
+ <xsl:variable name="chop">
+ <xsl:choose>
+ <xsl:when test="not(number(@ind2))">0</xsl:when>
+ <xsl:otherwise><xsl:value-of select="number(@ind2)"/></xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+
+ <z:index name="title:w title:p any:w">
+ <xsl:value-of select="m:subfield[@code='a']"/>
+ </z:index>
+
+ <z:index name="title:s">
+ <xsl:value-of select="substring(m:subfield[@code='a'], $chop)"/>
+ </z:index>
+
+ </xsl:template>
+ ]]>
+ </screen>
+ The output of the above &marcxml; and &xslt; excerpt would then be:
+ <screen>
+ <![CDATA[
+ <z:index name="title:w title:p any:w">How to program a computer</z:index>
+ <z:index name="title:s">program a computer</z:index>
+ ]]>
+ </screen>
+ and the record would be sorted in the title index under 'P', not 'H'.
+ </para>
+ </section>
+
+
+ <section id="record-model-domxml-index-wizzard">
+ <title>&dom; Indexing Wizardry</title>
+ <para>
+ 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
- opportunities for great power and wizardery as well as grande
+ opportunities for great power and wizardry 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;
- input format (due to rigerours checking against well-defined and
+ input format (due to rigorous checking against well-defined and
tight RelaxNG or &xml; Schema's, for example):
<screen>
<![CDATA[
<xsl:template name="element-name-indexes">
- <z:index name="{name()}" type="w">
+ <z:index name="{name()}:w">
<xsl:value-of select="'1'"/>
</z:index>
</xsl:template>
<![CDATA[
<!-- match on oai xml record root -->
<xsl:template match="/">
- <z:record z:type="update">
+ <z:record>
<!-- create dynamic index name from input content -->
<xsl:variable name="dynamic_content">
</xsl:variable>
<!-- create zillions of indexes with unknown names -->
- <z:index name="{$dynamic_content}" type="w">
+ <z:index name="{$dynamic_content}:w">
<xsl:value-of select="oai:record/oai:metadata/oai_dc:dc"/>
</z:index>
</z:record>
</xsl:template>
]]>
</screen>
- Don't be tempted to cross
- the line to the dark side of the force, paduan; this leads
- to suffering and pain, and universal
- disentigration of your project schedule.
+ Don't be tempted to play too smart tricks with the power of
+ &xslt;, the above example will create zillions of
+ indexes with unpredictable names, resulting in severe &zebra;
+ index pollution..
</para>
</section>
+ <section id="record-model-domxml-debug">
+ <title>Debuggig &dom; Filter Configurations</title>
+ <para>
+ It can be very hard to debug a &dom; filter setup due to the many
+ sucessive &marc; syntax translations, &xml; stream splitting and
+ &xslt; transformations involved. As an aid, you have always the
+ power of the <literal>-s</literal> command line switch to the
+ <literal>zebraidz</literal> indexing command at your hand:
+ <screen>
+ zebraidx -s -c zebra.cfg update some_record_stream.xml
+ </screen>
+ This command line simulates indexing and dumps a lot of debug
+ information in the logs, telling exactly which transformations
+ have been applied, how the documents look like after each
+ transformation, and which record ids and terms are send to the indexer.
+ </para>
+ </section>
+
+ <!--
<section id="record-model-domxml-elementset">
<title>&dom; Exchange Formats</title>
<para>
xmlns:z="http://indexdata.dk/zebra/xslt/1"
version="1.0">
- <!-- register internal zebra parameters -->
+ <!- - register internal zebra parameters - ->
<xsl:param name="id" select="''"/>
<xsl:param name="filename" select="''"/>
<xsl:param name="score" select="''"/>
<xsl:output indent="yes" method="xml" version="1.0" encoding="UTF-8"/>
- <!-- use then for display of internal information -->
+ <!- - use then for display of internal information - ->
<xsl:template match="/">
<z:zebra>
<id><xsl:value-of select="$id"/></id>
</para>
</section>
+ -->
+ <!--
<section id="record-model-domxml-example">
<title>&dom; Filter &oai; Indexing Example</title>
<para>
- The sourcecode tarball contains a working &dom; filter example in
+ The source code tarball contains a working &dom; filter example in
the directory <filename>examples/dom-oai/</filename>, which
should get you started.
</para>
<para>
- More example data can be harvested from any &oai; complient server,
+ More example data can be harvested from any &oai; compliant server,
see details at the &oai;
<ulink url="http://www.openarchives.org/">
http://www.openarchives.org/</ulink> web site, and the community
http://www.oaforum.org/tutorial/</ulink>.
</para>
</section>
+ -->
</section>
</chapter>
-<!--
-
-c) Main "dom" &xslt; filter config file:
- cat db/filter_dom_conf.xml
-
- <?xml version="1.0" encoding="UTF8"?>
- <schemaInfo>
- <schema name="dom" stylesheet="db/dom2dom.xsl" />
- <schema name="index" identifier="http://indexdata.dk/zebra/xslt/1"
- stylesheet="db/dom2index.xsl" />
- <schema name="dc" stylesheet="db/dom2dc.xsl" />
- <schema name="dc-short" stylesheet="db/dom2dc_short.xsl" />
- <schema name="snippet" snippet="25" stylesheet="db/dom2snippet.xsl" />
- <schema name="help" stylesheet="db/dom2help.xsl" />
- <split level="1"/>
- </schemaInfo>
-
- the paths are relative to the directory where zebra.init is placed
- and is started up.
-
- 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.
-
- The indexing stylesheet is found by it's identifier.
-
- All the other stylesheets are for presentation after search.
-
-- in data/ a short sample of harvested carnivorous plants
- ZEBRA_INDEX_DIRS=data/carnivor_20050118_2200_short-346.xml
-
-- in root also one single data record - nice for testing the xslt
- stylesheets,
-
- xsltproc db/dom2index.xsl carni*.xml
-
- 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
-
- 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
- respective elements/attributes of the old structure.
-
- Notice the special zebra namespace, and the special elements in this
- namespace which indicate to the zebra indexer what to do.
-
- <z:record id="67ht7" rank="675" type="update">
- 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
- "title" and of index type "w" (see file default.idx in your zebra
- installation)
-
-
- </para>
-
- <para>
--->
-
-
-
<!-- Keep this comment at the end of the file
Local variables:
projects / idzebra-moved-to-github.git / blobdiff