NAME¶

Tk::Pod::Search_db - 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,...);

DESCRIPTION¶

Module to search Pod documentation. Before you can use the module one should create the indices with "perlindex -index".

MISSING¶

Enable options like -maxhits (currently = 15). Solve PREFIX dependency. Interface for @stop and @unknown also as methods return lists for last searchWords call?

Lots more ...

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.

SEE ALSO¶

tkpod, perlindex, perlpod, Tk::Pod::Search

AUTHORS¶

Achim Bohnet <ach@mpe.mpg.de>

Most of the code here is borrowed from perlindex written by Ulrich Pfeifer <Ulrich.Pfeifer@de.uu.net>.

Current maintainer is Slaven Rezić <slaven@rezic.de>.

Copyright (c) 1997-1998 Achim Bohnet. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.