XTF Tag Reference

This page provides a reference for the tags, parameters, and utilities usable in XSLT stylesheets in various parts of the eXtensible Text Framework (XTF). This document assumes that you are familiar with the general organization of the XTF system as described in the XTF Programmer's Guide. Here are the available sections:

textIndexer

return to top This section details the XTF specific tags for the textIndexer stylesheets. There are two kinds of tags: 1) Document Selector tags and 2) PreFilter tags.

1. Document Selector

The following input and output tags make up the XML input for the Document Selector stylesheet. They constitute a simple XML representation files found in one (sub-) directory of the document library.

2. Pre-Filter

crossQuery

return to top This section details the parameters, input tags, output tags, and utilities used in programming the crossQuery servlet.

1. Common to crossQuery and dynaXML

Query Router and Query Parser Tags

Search Result Formatter

Error Generator

The purpose of the Error Generator stylesheet is to generate a web-page that displays user friendly messages when crossQuery errors occur. Since this stylesheet works the same way in both dynaXML and crossQuery, it is documented in the common Error Generator Stylesheets section.

dynamXML

return to top

Document Request Parser

Document Formatter

The following tags and attributes are added by the dynaXML servlet to the original XML tags that make up the requested XML document, which are then passed to the Document Formatter stylesheet for output formatting.

Document Formatter Attributes

xtf:hitCount="NumberOfHitsBelowThisTag"
xtf:firstHit="FirstHitNumberBelowThisTag"
These attributes are added to XML documents to indicate where matched text hits are located. By providing these tags, the dynaXML servlet allows the Document Formatter stylesheet to quickly determine if a section of a document needs any special highlighting or not. If the requested document has no hits, these attributes will appear once in the outermost tag for the document with both the attributes set to zero. If the document has one or more hits, these attributes will appear for any XML tag that has a hit inside it or inside its child tags.

Document Formatter Tags

<xtf:snippets> <xtf:snippet> <xtf:hit> <xtf:more> <xtf:term>

Error Generator

The purpose of the Error Generator stylesheet is to generate a web-page that displays user friendly messages when dynaXML errors occur. Since this stylesheet works the same way in both dynaXML and crossQuery, it is documented on the common Error Generator Stylesheets page.