[ You are here:
XTF ->
Tag Reference ->
textIndexer -> Pre-Filter Output Attributes ]
Pre-Filter Output Attributes
This section summarizes the attributes defined for the
Pre-Filter stylesheet to output which have meaning for the textIndexer tool.
Index/No-index Attribute
<xsl:attribute name="xtf:index" select="'TrueOrFalse'"/>
<xsl:attribute name="xtf:noindex" select="'TrueOrFalse'"/>
This attribute is used to turn on/off indexing for a tag in a source document. The noindex variant is simply a logical inverse of the index variant. Both are provided as a convenience to the programmer.
The value for either of these tags should be set to either the string '
true' or the string '
false'. (Note: If not explicitly set, nested sub-tags for a document inherit the index/noindex state from the closest parent tag for which an index state is defined.)
This attribute can be used for normal text blocks, and also on blocks marked as metadata using the
xtf:meta attribute below. In both cases, it controls whether the given block of text, or meta-data field, is added to the index. In the case of meta-data, a field that isn't added to the index will still be made available to the
Result Formatter stylesheet when crossQuery results are displayed.
Meta-Data Attribute
<xsl:attribute name="xtf:meta" select="'TrueOrFalse'"/>
This attribute is used to mark the contents of a tag as being part of the meta-data for a document rather than main-body text for the document.
The select value for this tag should be set to either the string '
true' (text in tag is meta data) or the string '
false' (text in tag
is not meta data.)
The entire tag and its contents will be treated as meta-data and will be added to the index using the element name as the name of the meta-data field. That is, the tag will be indexed separately from the full text of the document.
Other attributes of the tag, and any embedded element tags, will be stored in the index and will be passed verbatim to the
Result Formatter stylesheet to be used for output purposes. Of course the text of the element and any sub-elements will be searchable, but the actual attributes and element tags themselves cannot be searched for.
Note: If you mark a section of text with the
xtf:meta attribute, it will
not be included in the full text index of that document (accessed by querying the text field). If you want a given piece of text to appear in both the meta-data and full-text indexes, make two copies of it, marking one with
xtf:meta and not marking the other.
Store Attribute
<xsl:attribute name="xtf:store" select="'TrueOrFalse'"/>
This attribute is used to turn on/off whether to store the contents of a meta-data field in the index, and make them available to the
Result Formatter stylesheet.
The value for either of these tags should be set to either the string '
true' or the string '
false'. If not specified, this attribute defaults to '
true'.
This attribute can only be used on meta-data blocks that also have the
xtf:meta attribute set. Setting xtf:store to '
false' can make the final index smaller, and can also speed up processing by the
Result Formatter stylesheet, since it will have less data to process. A field can be indexed and stored, indexed and not stored, or stored and not indexed; all of these combinations can be useful in certain circumstances.
Tokenize Attribute
<xsl:attribute name="xtf:tokenize" select="'YesOrNo'"/>
This attribute is used to indicate whether a meta-data field should be tokenized or not. By default, meta-data fields are tokenized so they can be searched. If you intend to use a meta-data field for sorting query results instead, set this attribute to '
no' .
Proximity Break Attribute
<xsl:attribute name="xtf:proximitybreak" select="'TrueOrFalse'"/>
This attribute introduces a proximity break into a document. A tag marked with a proximity break attribute is considered to be infinitely far away from the previous or containing tag. Using this tag prevents proximity matches that span two adjacent tags from being counted as a valid match.
The select value for this tag should be set to either the string '
true' (introduce a proximity break) or the string '
false' (
do not introduce a proximity break.)
To de-emphasize rather than disallow proximity matches across sections, use the sectionBump attribute instead (see below).
Sentence Bump Attribute
<xsl:attribute name="xtf:sentenceBump" select="BumpInWords"/>
This attribute de-emphasizes proximity searches that span multiple sentences by introducing extra virtual spacing between adjacent sentences. The amount of virtual spacing to add between the end of the previous sentence and the beginning of the current one is specified as a number of virtual words by the BumpInWords argument. This value, if not specified, defaults to five words of added spacing.
(Note: If not explicitly set, nested sub-tags for a document inherit the sentence bump value from the closest parent tag for which a sentence bump value is defined.)
Section Type Attribute
<xsl:attribute name="xtf:sectionType" select="'TypeName'"/>
This attribute assigns a section type name to a tag, with the TypeName parameter identifying the section name to use. Assigning a section name to a tag allows grouped searches to be performed on tags that have the same section names, by inserting a
Section Type Tag into a query.
(Note: If not explicitly set, nested sub-tags for a document inherit the section type name from the closest parent tag for which a section name is defined.)
Section Type Add Attribute
<xsl:attribute name="xtf:sectionTypeAdd" select="'TypeName'"/>
This attribute appends a section type name to the section type already associated with a tag (or one of its ancestors which has a section type), with the TypeName parameter identifying the section name to append. Assigning a section name to a tag allows grouped searches to be performed on tags that have the same section names, by inserting a
Section Type Tag into a query. And appending a section type allows child tags to inherit their parent's
sectionType and then add additional type information. This can be very useful for representing hierarchical information using section types.
(Note: If not explicitly set, nested sub-tags for a document inherit the section type name from the closest parent tag for which a section name is defined, including any section type which has been appended to that parent tag.)
Section Bump Attribute
<xsl:attribute name="xtf:sectionBump" select="BumpInWords"/>
This attribute de-emphasizes proximity searches that span multiple sections by introducing extra virtual spacing between adjacent sections. The amount of virtual spacing added between the end of the previous section and the beginning of the current one is specified as a number of virtual words by the BumpInWords argument. This value, if not specified, defaults to zero words of added spacing.
Word Boost Attribute
<xsl:attribute name="xtf:wordBoost" select="BoostValue"/>
This attribute boosts or de-emphasizes the relevance of text found within a particular tag. To boost the relevance of text in a tag, set the BoostValue parameter to a floating-point number greater than 1.0. To de-emphasis the relevance of a tag's text, set the BoostValue parameter to a floating-point number between 0.0 and 1.0.
(Note: If not explicitly set, nested sub-tags for a document inherit the boost value from the closest parent tag for which a boost value is defined.)