Author image Marvin Humphrey
and 1 contributors


KinoSearch::Docs::Tutorial::Highlighter - Augment search results with highlighted excerpts.


The KinoSearch code base has been assimilated by the Apache Lucy project. The "KinoSearch" namespace has been deprecated, but development continues under our new name at our new home:


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

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::Plan::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(
        searcher => $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 $excerpt = $highlighter->create_excerpt($hit);
        $report .= qq|
              <a href="$hit->{url}"><strong>$hit->{title}</strong></a>
              <br />
              <br />
              <span class="excerptURL">$hit->{url}</span>

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 2008-2011 Marvin Humphrey

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.