KinoSearch::Docs::Tutorial::Highlighter - Augment search results with highlighted excerpts.
Adding relevant excerpts with highlighted search terms to your search results display makes it much easier for end users to scan the page and assess which hits look promising, dramatically improving their search experience.
KinoSearch::Highlight::Highlighter uses information generated at index time. To save resources, highlighting is disabled by default and must be turned on for individual fields.
my $highlightable = KinoSearch::FieldType::FullTextType->new( analyzer => $polyanalyzer, highlightable => 1, ); $schema->spec_field( name => 'content', type => $highlightable );
To add highlighting and excerpting to the search.cgi sample app, create a $highlighter object outside the hits iterating loop...
$highlighter
my $highlighter = KinoSearch::Highlight::Highlighter->new( searchable => $searcher, query => $q, field => 'content' );
... then modify the loop and the per-hit display to generate and include the excerpt.
# Create result list. my $report = ''; while ( my $hit = $hits->next ) { my $score = sprintf( "%0.3f", $hit->get_score ); my $title = encode_entities( $hit->{title} ); my $excerpt = $highlighter->create_excerpt($hit); $report .= qq| <p> <a href="$hit->{url}"><strong>$title</strong></a> <em>$score</em> <br /> $excerpt <br /> <span class="excerptURL">$hit->{url}</span> </p> |; }
Our next tutorial chapter, KinoSearch::Docs::Tutorial::QueryObjects, illustrates how to build an "advanced search" interface using Query objects instead of query strings.
Copyright 2008-2009 Marvin Humphrey
See KinoSearch version 0.30.
To install KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm
cpanm KSx::Simple
CPAN shell
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.