Wiki::...lucene(3pm)

🦋 NAME 🦋

okay so this is the manual page for Wiki::Toolkit::Search::Plucene, and it's literally the module that lets you use Plucene to search your Wiki::Toolkit wiki. that's the whole ✨ name ✨ vibe.

---

💅 SYNOPSIS 💅

here's the quick little how-to, bestie:

         my $search = Wiki::Toolkit::Search::Plucene->new( path => "/var/plucene/wiki" );
         my %wombat_nodes = $search->search_nodes("wombat");

and yeah — it provides search-related methods for Wiki::Toolkit. slay.

---

✨ METHODS ✨

🔥 new 🔥

this is the constructor, main character energy. behold:

             my $search = Wiki::Toolkit::Search::Plucene->new(
                              path => "/var/plucene/wiki",
                              content_munger => sub {
                                  my $content = shift;
                                  $content =~ s/secretword//gs;
                                  return $content;
                              },
                              node_filter => sub {
                                  my %args = @_;
                                  return $args{content} =~ /REDIRECT/ ? 0 : 1;
                              },
             );

🎀 the parameters, decoded 🎀

• path — this one is mandatory, no cap. path must be a directory for storing the indexed data. it should exist and be writeable.
• content_munger — optional, bestie. it should be a reference to a subroutine. that sub takes the node content as a string and returns another string — and that returned string is what gets indexed in place of the original content.
• node_filter — also optional. it should be a reference to a subroutine. the sub gets the named arguments node and content, and returns either true (yes, index this node) or false (no, don't index this node).

the order that matters: content munging takes place BEFORE node filtering. munging first, filtering second — don't flip it, okay? 💖

---

🌈 SEE ALSO 🌈

• Wiki::Toolkit
• Wiki::Toolkit::Search::Base

---

that's the whole page! 💖 brought to you by perl v5.32.0, dated 2021-01-04, and filed under Wiki::...lucene(3pm) — mwah 💋