.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "KinoSearch1::Highlight::Highlighter 3pm"
.TH KinoSearch1::Highlight::Highlighter 3pm 2024-03-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
KinoSearch1::Highlight::Highlighter \- create and highlight excerpts
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    my $highlighter = KinoSearch1::Highlight::Highlighter\->new(
\&        excerpt_field  => \*(Aqbodytext\*(Aq,
\&    );
\&    $hits\->create_excerpts( highlighter => $highlighter );
.Ve
.SH DESCRIPTION
.IX Header "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.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 6
\&    my $highlighter = KinoSearch1::Highlight::Highlighter\->new(
\&        excerpt_field  => \*(Aqbodytext\*(Aq, # required
\&        excerpt_length => 150,        # default: 200
\&        formatter      => $formatter, # default: SimpleHTMLFormatter
\&        encoder        => $encoder,   # default: SimpleHTMLEncoder
\&    );
.Ve
.PP
Constructor.  Takes hash-style parameters:
.IP \(bu 4
\&\fBexcerpt_field\fR \- the name of the field from which to draw the excerpt.  This
field \fBmust\fR be \f(CW\*(C`vectorized\*(C'\fR.
.IP \(bu 4
\&\fBexcerpt_length\fR \- the length of the excerpt, in \fIbytes\fR.  This should
probably use characters as a unit instead of bytes, and the behavior is likely
to change in the future.
.IP \(bu 4
\&\fBformatter\fR \- an object which subclasses KinoSearch1::Highlight::Formatter,
used to perform the actual highlighting.
.IP \(bu 4
\&\fBencoder\fR \- 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.
.IP \(bu 4
\&\fBpre_tag\fR \- deprecated.
.IP \(bu 4
\&\fBpost_tag\fR \- deprecated.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2005\-2010 Marvin Humphrey
.SH "LICENSE, DISCLAIMER, BUGS, etc."
.IX Header "LICENSE, DISCLAIMER, BUGS, etc."
See KinoSearch1 version 1.01.