Tk::Pod::Search_db 0.9936

Tk::Pod::Search_db is a dirty OO wrapper for perlindex's search functionality.

SYNOPSIS

** THIS IS ALPHA SOFTWARE everything may and should change **
** stuff here is more a scratch pad than docomentation! **

use Tk::Pod::Search_db;
...
$idx = Tk::Pod::Search_db->new?(INDEXDIR)?;
...
@hits = $idx->searchWords(WORD1,...); # @hits is a list of
# relpath1,score1,... where
# score is increasing
$prefix = $idx->prefix();

@word = Tk::Pod::Search_db::normalize(STRING1,...);

METHODS

$idx = Tk::Pod::Search_db->new(INDEXDIR)

Interface may change to support options like -maxhits

$idx->seachWords(WORD1?,...?)

search for WORD(s). Return a list of

relpath1, score1, relpath2, score2, ...

or empty list if no match is found.

$pathprefix = $idx->pathprefix()

The return path prefix and $relpath give together the full path name of the Pod documentation.

$fullpath = $patchprefix . '/' . $relpath

Note: Should make it easy to use Tk::Pod::Search with perlindex but index specific prefix handling is a mess up to know.

Product's homepage

Requirements:

· Perl