KinoSearch1::HighlightUsergContributed PKinoSearch1::Highlight::Highlighter(3)NAMEKinoSearch1::Highlight::Highlighter - create and highlight excerpts
SYNOPSIS
my $highlighter = KinoSearch1::Highlight::Highlighter->new(
excerpt_field => 'bodytext',
);
$hits->create_excerpts( highlighter => $highlighter );
DESCRIPTION
KinoSearch1's Highlighter can be used to select a relevant snippet from
a document, and to surround search terms with highlighting tags. It
handles both stems and phrases correctly and efficiently, using
special-purpose data generated at index-time.
METHODS
new
my $highlighter = KinoSearch1::Highlight::Highlighter->new(
excerpt_field => 'bodytext', # required
excerpt_length => 150, # default: 200
formatter => $formatter, # default: SimpleHTMLFormatter
encoder => $encoder, # default: SimpleHTMLEncoder
);
Constructor. Takes hash-style parameters:
· excerpt_field - the name of the field from which to draw the
excerpt. This field must be "vectorized".
· excerpt_length - the length of the excerpt, in bytes. This should
probably use characters as a unit instead of bytes, and the
behavior is likely to change in the future.
· formatter - an object which subclasses
KinoSearch1::Highlight::Formatter, used to perform the actual
highlighting.
· encoder - an object which subclasses
KinoSearch1::Highlight::Encoder. All excerpt text gets passed
through the encoder, including highlighted terms. By default, this
is a SimpleHTMLEncoder, which encodes HTML entities.
· pre_tag - deprecated.
· post_tag - deprecated.
COPYRIGHT
Copyright 2005-2010 Marvin Humphrey
LICENSE, DISCLAIMER, BUGS, etc.
See KinoSearch1 version 1.01.
perl v5.14.12011-0KinoSearch1::Highlight::Highlighter(3)
