-
-
29 Jun 2009 22:37:41 UTC
- Development release
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues (5)
- Testers (27 / 1 / 6)
- Kwalitee
Bus factor: 0- License: perl_5
- Activity
24 month- Tools
- Download (609.56KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- Marvin Humphrey <marvin at rectangular dot com>
- Dependencies
- JSON::XS
- Lingua::Stem::Snowball
- Lingua::StopWords
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
KinoSearch::Docs::Tutorial::Highlighter - Augment search results with highlighted excerpts.
DESCRIPTION
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.
Adaptations to indexer.pl
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 );
Adaptations to search.cgi
To add highlighting and excerpting to the search.cgi sample app, create a
$highlighter
object outside the hits iterating loop...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> |; }
Next chapter: Query objects
Our next tutorial chapter, KinoSearch::Docs::Tutorial::QueryObjects, illustrates how to build an "advanced search" interface using Query objects instead of query strings.
COPYRIGHT
Copyright 2008-2009 Marvin Humphrey
LICENSE, DISCLAIMER, BUGS, etc.
See KinoSearch version 0.30.
Module Install Instructions
To install KSx::Simple, copy and paste the appropriate command in to your terminal.
cpanm KSx::Simple
perl -MCPAN -e shell install KSx::Simple
For more information on module installation, please visit the detailed CPAN module installation guide.