OpenGu...::Lucy(3pm)

💖 NAME 💖

OpenGuides::Search::Lucy — bestie, this is the module that runs Lucy-backed text searches for OpenGuides. that's the whole name, that's the whole job 💅

---

✨ DESCRIPTION ✨

okay so. this little icon does search stuff for OpenGuides. that's it, that's the vibe 🦋

big important heads up tho: it's distributed and installed as part of the OpenGuides project, and it is not meant to be installed on its own, like ever, no cap. so this documentation is probably only useful to OpenGuides developers. if that's not you, you're kinda just vibing in the wrong group chat, bestie 😭 (no shade!! you're still welcome!!)

---

🌸 SYNOPSIS 🌸

the way you summon it:

use OpenGuides::Config;
use OpenGuides::Search::Lucy;

my $config = OpenGuides::Config->new( file => "wiki.conf" );
my $search = OpenGuides::Search::Lucy->new( config => $config );
$search->run_text_search( search_string => "wombat defenestration" );

yeah. "wombat defenestration". iconic search string, whoever wrote this ate 🔥

---

🎀 METHODS 🎀

💜 new

constructs the whole thing. you hand it a config object, it hands you back a search object. main character energy:

my $config = OpenGuides::Config->new( file => "wiki.conf" );
my $search = OpenGuides::Search::Lucy->new( config => $config );

🫶 run_text_search

this is the one that actually does the searching. pass it your search_string and let it cook 🍓:

my $config = OpenGuides::Config->new( file => "wiki.conf" );
my $search = OpenGuides::Search::Lucy->new( config => $config );
$search->run_text_search( search_string => "wombat defenestration" );

---

👑 AUTHOR 👑

The OpenGuides Project — hit them up at openguides-dev@lists.openguides.org 💌

---

🌈 COPYRIGHT 🌈

 Copyright (C) 2013 The OpenGuides Project.  All Rights Reserved.

The OpenGuides distribution is free software; you can redistribute it and/or modify it under the same terms as Perl itself. slay 💅

---

⭐ SEE ALSO ⭐

• OpenGuides

---

and that's the whole page, bestie!! this was perl v5.32.0, dated 2021-01-30, and it's the manual for OpenGu...::Lucy(3pm) 🎀 go forth and defenestrate those wombats, ily 🫶💖