X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=blobdiff_plain;f=doc%2Frecordmodel-alvisxslt.xml;h=c633022cae14edd6c4b1ec81959c4c68d4403eaa;hp=e64bb840dc92a6221853a122a25a4a51529028cb;hb=693a0db94b4b3ac9aee7722572a6b81a86a12e13;hpb=e6ff84c71e457ff668dce640382fc1ad88c37d6d diff --git a/doc/recordmodel-alvisxslt.xml b/doc/recordmodel-alvisxslt.xml index e64bb84..c633022 100644 --- a/doc/recordmodel-alvisxslt.xml +++ b/doc/recordmodel-alvisxslt.xml @@ -1,15 +1,21 @@ - - - ALVIS XML Record Model and Filter Module - + + ALVIS &acro.xml; Record Model and Filter Module + + + + The functionality of this record model has been improved and + replaced by the DOM &acro.xml; record model, see + . The Alvis &acro.xml; record + model is considered obsolete, and will eventually be removed + from future releases of the &zebra; software. + + The record model described in this chapter applies to the fundamental, - structured XML + structured &acro.xml; record type alvis, introduced in - . The ALVIS XML record model - is experimental, and it's inner workings might change in future - releases of the Zebra Information Server. + . This filter has been developed under the @@ -22,7 +28,7 @@
ALVIS Record Filter - The experimental, loadable Alvis XML/XSLT filter module + The experimental, loadable Alvis &acro.xml;/&acro.xslt; filter module mod-alvis.so is packaged in the GNU/Debian package libidzebra1.4-mod-alvis. It is invoked by the zebra.cfg configuration statement @@ -31,12 +37,12 @@ In this example on all data files with suffix *.xml, where the - Alvis XSLT filter configuration file is found in the + Alvis &acro.xslt; filter configuration file is found in the path db/filter_alvis_conf.xml. - 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): + The Alvis &acro.xslt; filter configuration file must be + valid &acro.xml;. It might look like this (This example is + used for indexing and display of &acro.oai; harvested records): <?xml version="1.0" encoding="UTF-8"?> <schemaInfo> @@ -57,47 +63,47 @@ names defined in the name attributes must be unique, these are the literal schema or element set names used in - SRW, - SRU and - Z39.50 protocol queries. + &acro.srw;, + &acro.sru; and + &acro.z3950; protocol queries. The paths in the stylesheet attributes are relative to zebras working directory, or absolute to file system root. The <split level="2"/> decides where the - XML Reader shall split the + &acro.xml; Reader shall split the collections of records into individual records, which then are - loaded into DOM, and have the indexing XSLT stylesheet applied. + loaded into &acro.dom;, and have the indexing &acro.xslt; stylesheet applied. - There must be exactly one indexing XSLT stylesheet, which is + There must be exactly one indexing &acro.xslt; stylesheet, which is defined by the magic attribute identifier="http://indexdata.dk/zebra/xslt/1".
ALVIS Internal Record Representation - 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 + When indexing, an &acro.xml; Reader is invoked to split the input + files into suitable record &acro.xml; pieces. Each record piece is then + transformed to an &acro.xml; &acro.dom; structure, which is essentially the + record model. Only &acro.xslt; transformations can be applied during 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 libxslt1 running with EXSLT support, + restricted to whatever &acro.xslt; can deliver from the record &acro.xml; + structure, be it other &acro.xml; formats, HTML, or plain text. In case + you have libxslt1 running with E&acro.xslt; support, you can use this functionality inside the Alvis - filter configuration XSLT stylesheets. + filter configuration &acro.xslt; stylesheets.
ALVIS Canonical Indexing Format - The output of the indexing XSLT stylesheets must contain + The output of the indexing &acro.xslt; stylesheets must contain certain elements in the magic xmlns:z="http://indexdata.dk/zebra/xslt/1" - namespace. The output of the XSLT indexing transformation is then - parsed using DOM methods, and the contained instructions are + namespace. The output of the &acro.xslt; indexing transformation is then + parsed using &acro.dom; methods, and the contained instructions are performed on the magic elements and their subtrees. @@ -111,8 +117,7 @@ <?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:rank="47896"> <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> @@ -127,13 +132,13 @@ </z:record> - This means the following: From the original XML file - one-record.xml (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 + This means the following: From the original &acro.xml; file + one-record.xml (or from the &acro.xml; record &acro.dom; of the + same form coming from a split input file), the indexing + stylesheet produces an indexing &acro.xml; record, which is defined by the record element in the magic namespace xmlns:z="http://indexdata.dk/zebra/xslt/1". - Zebra uses the content of + &zebra; uses the content of z:id="oai:JTRS:CP-3290---Volume-I" as internal record ID, and - in case static ranking is set - the content of z:rank="47896" as static rank. Following the @@ -141,10 +146,10 @@ we see that this records is internally ordered lexicographically according to the value of the string oai:JTRS:CP-3290---Volume-I47896. - The type of action performed during indexing is defined by + In this example, the following literal indexes are constructed: @@ -161,7 +166,7 @@ file default.idx will do). Finally, any text() node content recursively contained inside the index will be filtered through the - appropriate charmap for character normalization, and will be + appropriate char map for character normalization, and will be inserted in the index. @@ -174,7 +179,7 @@ will be inserted using the w character normalization defined in default.idx into the index dc:creator (that is, after character - normalization the index will keep the inidividual words + normalization the index will keep the individual words kumar, krishen, and, calvin, burnham, and editors), and @@ -187,8 +192,8 @@ the same character normalization map w. - 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 &acro.pqf; + queries, either transported by &acro.z3950;, (here using a yaz-client) open localhost:9999 @@ -203,23 +208,23 @@ ]]> or the proprietary - extentions x-pquery and + extensions x-pquery and x-pScanClause to - SRU, and SRW + &acro.sru;, and &acro.srw; - See for more information on SRU/SRW - configuration, and or the YAZ - CQL section - for the details or the YAZ frontend server. + See for more information on &acro.sru;/&acro.srw; + configuration, and or the &yaz; + &acro.cql; section + for the details or the &yaz; frontend server. Notice that there are no *.abs, - *.est, *.map, or other GRS-1 + *.est, *.map, or other &acro.grs1; filter configuration files involves in this process, and that the literal index names are used during search and retrieval. @@ -236,40 +241,40 @@ 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 &acro.xslt; stylesheet which produces &acro.xml; output containing the magic elements discussed in . 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. + our Padawan's on the right track to the good side of the force. Stylesheets can be written in the pull or the push style: pull - 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 pulled out and inserted - into the right spots of the output XML structure. On the other - side, push XSLT stylesheets are recursavly + means that the output &acro.xml; structure is taken as starting point of + the internal structure of the &acro.xslt; stylesheet, and portions of + the input &acro.xml; are pulled out and inserted + into the right spots of the output &acro.xml; structure. On the other + side, push &acro.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 &acro.xml; structure, and are triggered to produce some output &acro.xml; + whenever some special conditions in the input stylesheets are met. The pull type is well-suited for input - XML with strong and well-defined structure and semantcs, like the - following OAI indexing example, whereas the + &acro.xml; with strong and well-defined structure and semantics, like the + following &acro.oai; indexing example, whereas the push type might be the only possible way to - sort out deeply recursive input XML formats. + sort out deeply recursive input &acro.xml; formats. A pull stylesheet example used to index - OAI harvested records could use some of the following template + &acro.oai; harvested records could use some of the following template definitions: @@ -280,14 +285,13 @@ - - + + - + @@ -312,17 +316,17 @@ Notice also, that the names and types of the indexes can be defined in the - indexing XSLT stylesheet dynamically according to - content in the original XML records, which has - opportunities for great power and wizardery as well as grande + indexing &acro.xslt; stylesheet dynamically according to + content in the original &acro.xml; records, which has + opportunities for great power and wizardry as well as grande disaster. The following excerpt of a push stylesheet might - be a good idea according to your strict control of the XML - input format (due to rigerours checking against well-defined and - tight RelaxNG or XML Schema's, for example): + be a good idea according to your strict control of the &acro.xml; + input format (due to rigorous checking against well-defined and + tight RelaxNG or &acro.xml; Schema's, for example): @@ -333,11 +337,11 @@ ]]> 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 &acro.xml; file, and assigns a '1' to the index. The example query find @attr 1=xyz 1 finds all files which contain at least one - xyz XML element. In case you can not control + xyz &acro.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. @@ -348,7 +352,7 @@ - + @@ -365,9 +369,9 @@ ]]> Don't be tempted to cross - the line to the dark side of the force, paduan; this leads + the line to the dark side of the force, Padawan; this leads to suffering and pain, and universal - disentigration of your project schedule. + disintegration of your project schedule.
@@ -375,18 +379,18 @@ ALVIS Exchange Formats 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 + &acro.xslt; transformation, as far as the stylesheet is registered in + the main Alvis &acro.xslt; filter configuration file, see . - In principle anything that can be expressed in XML, HTML, and + In principle anything that can be expressed in &acro.xml;, HTML, and TEXT can be the output of a schema or element set directive during search, as long as the information comes from the - original input record XML DOM tree - (and not the transformed and indexed XML!!). + original input record &acro.xml; &acro.dom; tree + (and not the transformed and indexed &acro.xml;!!). - 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: @@ -421,15 +425,15 @@
- ALVIS Filter OAI Indexing Example + ALVIS Filter &acro.oai; Indexing Example - The sourcecode tarball contains a working Alvis filter example in + The source code tarball contains a working Alvis filter example in the directory examples/alvis-oai/, which should get you started. - More example data can be harvested from any OAI complient server, - see details at the OAI + More example data can be harvested from any &acro.oai; compliant server, + see details at the &acro.oai; http://www.openarchives.org/ web site, and the community links at @@ -448,72 +452,6 @@ - - - -