.\" -*- 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::SimpleHTMLFormatter 3pm"
.TH KinoSearch1::Highlight::SimpleHTMLFormatter 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::SimpleHTMLFormatter \- surround highlight bits with tags
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\& my $formatter = KinoSearch1::Highlight::SimpleHTMLFormatter\->new(
\& pre_tag => \*(Aq\*(Aq,
\& post_tag => \*(Aq\*(Aq,
\& );
\&
\& # returns "foo"
\& my $highlighted = $formatter\->highlight("foo");
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This subclass of
KinoSearch1::Highlight::Formatter
highlights text by surrounding it with HTML "strong" tags.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
Constructor. Takes hash-style params.
.PP
.Vb 4
\& my $formatter = KinoSearch1::Highlight::SimpleHTMLFormatter\->new(
\& pre_tag => \*(Aq*\*(Aq, # default: \*(Aq\*(Aq
\& post_tag => \*(Aq*\*(Aq, # default: \*(Aq\*(Aq
\& );
.Ve
.IP \(bu 4
\&\fBpre_tag\fR \- a string which will be inserted immediately prior to the
highlightable text, typically to accentuate it. If you don't want
highlighting, set both \f(CW\*(C`pre_tag\*(C'\fR and \f(CW\*(C`post_tag\*(C'\fR to \f(CW\*(Aq\*(Aq\fR.
.IP \(bu 4
\&\fBpost_tag\fR \- a string which will be inserted immediately after the
highlightable text.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2006\-2010 Marvin Humphrey
.SH "LICENSE, DISCLAIMER, BUGS, etc."
.IX Header "LICENSE, DISCLAIMER, BUGS, etc."
See KinoSearch1 version 1.01.