"Create Search::InvertedIndex indexes easily for CGI::Wiki with this software." (12 words)
To use this module, users can follow the straightforward SYNOPSIS provided in the documentation. Simply add "use CGI::Wiki::Setup::SII" to your code, followed by creating the indexdb with Search::InvertedIndex::DB::Mysql->new(). Users can set the optional and mandatory parameters accordingly.
The module comes with one function, setup, which is mandatory to call. This function sets up Search::InvertedIndex indexes for use with CGI::Wiki. The only requirement of this function is to provide one mandatory argument, indexdb. It is mandatory to provide the Search::InvertedIndex::DB::* object to use as the backend for this function. Additionally, one can provide the optional argument, store, which is a CGI::Wiki::Store::* object that corresponds to existing data that users wish to (re-)index.
Users should note that any pre-existing CGI::Wiki indexes stored in indexdb will be cleared by this function. If users have existing data, they should use the store parameter to get it re-indexed. In conclusion, CGI::Wiki::Setup::SII is a reliable Perl module that website owners can use to set up an index database for their website's content efficiently.
Version 0.63: N/A