From: Marc Cromme Date: Thu, 16 Feb 2006 12:32:31 +0000 (+0000) Subject: added new generated html files to makesystem X-Git-Tag: before.bug.529~238 X-Git-Url: http://git.indexdata.com/?p=idzebra-moved-to-github.git;a=commitdiff_plain;h=43b4d8d93cd567284f4e48731119f3da2a1daedf added new generated html files to makesystem --- diff --git a/doc/Makefile.am b/doc/Makefile.am index 5e189ab..c4c3fc2 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -## $Id: Makefile.am,v 1.36 2006-02-15 14:57:48 marc Exp $ +## $Id: Makefile.am,v 1.37 2006-02-16 12:32:31 marc Exp $ docdir=$(datadir)/doc/@PACKAGE@ SUPPORTFILES = \ @@ -70,6 +70,7 @@ HTMLFILES = administration-ranking.html \ zebraidx.html + PNGFILES=zebra.png EPSFILES=zebra.eps diff --git a/doc/recordmodel-alvisxslt.xml b/doc/recordmodel-alvisxslt.xml index a322f74..df73cb9 100644 --- a/doc/recordmodel-alvisxslt.xml +++ b/doc/recordmodel-alvisxslt.xml @@ -1,5 +1,5 @@ - + ALVIS XML Record Model and Filter Module @@ -15,27 +15,28 @@ This filter has been developed under the ALVIS project funded by the European Community under the "Information Society Technologies" - Programme (2002-2006). + Program (2002-2006). ALVIS Record Filter - The experimental, loadable Alvis XM/XSLT filter module + The experimental, loadable Alvis XML/XSLT filter module mod-alvis.so is packaged in the GNU/Debian package libidzebra1.4-mod-alvis. - It is invoked by the zebra configuration statement + It is invoked by the zebra.cfg configuration statement recordtype.xml: alvis.db/filter_alvis_conf.xml - on all data files with suffix .xml, where the - alvis XSLT filter config file is found in the - path db/filter_alvis_conf.xml + In this example on all data files with suffix + *.xml, where the + Alvis XSLT filter configuration file is found in the + path db/filter_alvis_conf.xml. - The alvis XSLT filter config file must be - valid XML. It might look like this (used for indexing and display - of OAI harvested records): + 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): <?xml version="1.0" encoding="UTF-8"?> <schemaInfo> @@ -59,7 +60,7 @@ SRW, SRU and Z39.50 protocol queries. - The pathes in the stylesheet attributes + The paths in the stylesheet attributes are relative to zebras working directory, or absolute to file system root. @@ -79,14 +80,14 @@ 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 structire, which is essentially the - record model. Only XSLT transfomations can be applied during + 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 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, - you can use this functionality inside the alvis - filter configuraiton XSLT stylesheets. + you can use this functionality inside the Alvis + filter configuration XSLT stylesheets. @@ -136,7 +137,8 @@ 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 - discussion in XXX we see that this records is internally ordered + discussion in + 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 @@ -144,7 +146,7 @@ insert, update, and delete. - Then the following literal indexes are constructed: + In this example, the following literal indexes are constructed: oai:identifier oai:datestamp @@ -154,21 +156,40 @@ dc:creator where the indexing type is defined in the - type attribute (any value from the standard config - filedefault.idx will do). Finally, any + type attribute + (any value from the standard configuration + 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 inserted in the index. - Notice that there are no .abs, - .est, .map, or other GRS-1 - filter configuration files involves in this process. 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 - oppertunities for great power and great disaster. + Specific to this example, we see that the single word + oai:JTRS:CP-3290---Volume-I will be literal, + byte for byte without any form of character normalization, + inserted into the index named oai:identifier, + the text + Kumar Krishen and *Calvin Burnham, Editors + 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 + kumar, krishen, + and, calvin, + burnham, and editors), and + finally both the texts + Proceedings of the 4th International Conference and Exhibition: + World Congress on Superconductivity - Volume I + and + Kumar Krishen and *Calvin Burnham, Editors + will be inserted into the index dc:all using + the same character normalization map w. + + + Notice that there are no *.abs, + *.est, *.map, or other GRS-1 + filter configuration files involves in this process. @@ -180,17 +201,191 @@ ALVIS Indexing Configuration - FIXME + + 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 + 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. - FIXME + + 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 + 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 + 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 + push type might be the only possible way to + sort out deeply recursive input XML formats. - FIXME + + A pull stylesheet example used to index + OAI harvested records could use some of the following template + definitions: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ]]> + + + + 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 + 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): + + + + + + + ]]> + + This template creates indexes which have the name of the working + node of any input 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 + which element names the input files contain, you might ask for + disaster and bad karma using this technique. + + + One variation over the theme dynamically created + indexes will definitely be unwise: + + + + + + + + + + + + + + + + + + ]]> + + 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. ALVIS Exchange Formats - FIXME + + 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 + . + In principle anything that can be expressed in 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!!). + + + In addition, internal administrative information from the Zebra + indexer can be accessed during record retrieval. The following + example is a summary of the possibilities: + + + + + + + + + + + + + + + + + + + + + + + ]]> + + + @@ -216,7 +411,7 @@ c) Main "alvis" XSLT filter config file: - the pathes are relative to the directory where zebra.init is placed + 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