KinoSearch::Highlight::SimpleHTMLFormatter(3pm)

KinoSearch::Highlight::SimpleHTMLFormatter3pm

Surround highlight bits with tags

Usage

    my $formatter = KinoSearch::Highlight::SimpleHTMLFormatter->new(
        pre_tag  => '<i>',
        post_tag => '</i>',
    );
    # returns "<i>foo</i>"
    my $highlighted = $formatter->highlight("foo");

Overview

This subclass of KinoSearch::Highlight::Formatter highlights text by surrounding it with HTML "strong" tags.

Methods

new

Constructor. Takes hash-style params.

    my $formatter = KinoSearch::Highlight::SimpleHTMLFormatter->new(
        pre_tag =>  '*', # default: '<strong>'
        post_tag => '*', # default: '</strong>'
    );

•: pre_tag - a string which will be inserted immediately prior to the highlightable text, typically to accentuate it. If you don't want highlighting, set both "pre_tag" and "post_tag" to ''.

•: post_tag - a string which will be inserted immediately after the highlightable text.

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch version 0.165.