The Main Manual Page Dynamic API Documentation CD-ROM API Documentation About Onix Types About Onix Errors Onix's Web Site at Lextek International Lextek International Onix Full Text Indexing and Retrieval Toolkit

ixCreateHighlightMatcher

NAME

ixCreateHighlightMatcher -- Create a matcher to help with query term highlighting.

SYNOPSIS

ixCreateHighlightMatcher(StatusCodeT *Status);

ARGUMENTS

Status -- A pointer to a value of type StatusCodeT.  If an error occurs, Status will be set to an error value.

RETURNS

HighlightMatcherT -- A matcher which can be used with query term highlighting.

DESCRIPTION

If you are interested in highlighting the terms in a piece of text which match a query, the HighlightMatcher is the best tool for the job.  Simply create the highlight matcher, add the terms to the matcher which are in the query using ixAddWildCardPatternToHighlightMatcher(). To highlight the query terms in the text which match your query, you will need to reparse the text and then test the words against the HighlightMatcher using ixHighlightMatcherMatch().  If the word matches, then you may highlight it.  Another alternative for query term highlighting is to use word level indexes.  You will still need to reparse the text but the query term numbers are stored in the Query Vector instead.  (Which lets you avoid the matching process.)

SEE ALSO

ixDeleteHighlightMatcher, ixAddWildCardPatternToHighlightMatcher, ixHighlightMatcherMatch