KinoSearch::Highlight::SimpleHTMLFormatter.3pm

Langue: en

Autres versions - même langue

Version: 2010-05-02 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

KinoSearch::Highlight::SimpleHTMLFormatter - surround highlight bits with tags

SYNOPSIS

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

DESCRIPTION

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.
Copyright 2006-2009 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch version 0.165.