Pod::Search_db(3pm)

πŸ“¦
version 0.9943 Β· 6 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ¦‹ Pod::Search_db πŸ¦‹

okay so real talk, bestie: this page comes from the User Contributed Perl Documentation section of the manual, and it is chaotic in the most charming way. Let's get into it πŸ’…

✨ NAME ✨

Tk::Pod::Search_db β€” a dirty OO wrapper for perlindex's search functionality 🌸

(yes, "dirty". they said it. i'm just the messenger 🫢)

✨ SYNOPSIS ✨

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

no but fr, that's verbatim, and it's giving "do not ship this" energy πŸ™ˆ

** 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 ✨

It's a module to search Pod documentation. But before you can even use it, you gotta create the indices with perlindex -index first. Like, that's the prerequisite, no shortcuts, that's the assignment πŸ’–

✨ MISSING ✨

the to-do list, and it is long:

  • 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 ...

(iconic of them to publish the wishlist tbh 😭)

✨ 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.

ngl the spelling is literally like that in the source. i'm not touching it, that's canon now πŸ‘‘
  • $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.

and that's the whole page, bestie πŸ’œ shoutout to the perl v5.34.0 toolchain and the 2022-06-28 date stamp for keeping it real β€” that's the footer, we ate it, no crumbs left. slay πŸŽ€βœ¨

πŸ“¦ where this page comes from