1Pod::Search_db(3)     User Contributed Perl Documentation    Pod::Search_db(3)
2
3
4

NAME

6       Tk::Pod::Search_db - dirty OO wrapper for "perlindex"'s search
7       functionality
8

SYNOPSIS

10           ** THIS IS ALPHA SOFTWARE everything may and should change **
11           **   stuff here is more a scratch pad than docomentation!  **
12
13           use Tk::Pod::Search_db;
14           ...
15           $idx = Tk::Pod::Search_db->new?(INDEXDIR)?;
16           ...
17           @hits = $idx->searchWords(WORD1,...); # @hits is a list of
18                                                    # relpath1,score1,...  where
19                                                    # score is increasing
20           $prefix = $idx->prefix();
21
22           @word = Tk::Pod::Search_db::normalize(STRING1,...);
23

DESCRIPTION

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

MISSING

29       Enable options like -maxhits (currently = 15).  Solve PREFIX
30       dependency.  Interface for @stop and @unknown also as methods return
31       lists for last searchWords call?
32
33       Lots more ...
34

METHODS

36       $idx = Tk::Pod::Search_db->new(INDEXDIR)
37           Interface may change to support options like -maxhits
38
39       $idx->seachWords(WORD1?,...?)
40           search for WORD(s). Return a list of
41
42             relpath1, score1, relpath2, score2, ...
43
44           or empty list if no match is found.
45
46       $pathprefix = $idx->pathprefix()
47           The return path prefix and $relpath give together the full path
48           name of the Pod documentation.
49
50                   $fullpath = $patchprefix . '/' . $relpath
51
52           Note: Should make it easy to use Tk::Pod::Search with perlindex but
53           index specific prefix handling is a mess up to know.
54

SEE ALSO

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

AUTHORS

59       Achim Bohnet  <ach@mpe.mpg.de>
60
61       Most of the code here is borrowed from perlindex written by Ulrich
62       Pfeifer <Ulrich.Pfeifer@de.uu.net>.
63
64       Current maintainer is Slaven Rezić <slaven@rezic.de>.
65
66       Copyright (c) 1997-1998 Achim Bohnet. All rights reserved.  This
67       program is free software; you can redistribute it and/or modify it
68       under the same terms as Perl itself.
69
70
71
72perl v5.38.0                      2023-07-21                 Pod::Search_db(3)
Impressum