OpenGuides::Utils - General utility methods for OpenGuides scripts.
Provides general utility methods for OpenGuides scripts. Distributed and installed as part of the OpenGuides project, not intended for independent installation. This documentation is probably only useful to OpenGuides developers.
use CGI::Wiki; use Config::Tiny; use OpenGuides::Utils; my $config = Config::Tiny->read( "wiki.conf" ); my $wiki = OpenGuides::Utils->make_wiki_object( config => $config );
my $config = Config::Tiny->read( "wiki.conf" ); my $wiki = OpenGuides::Utils->make_wiki_object( config => $config );
Croaks unless a Config::Tiny object is supplied. Returns a CGI::Wiki object made from the given config file on success, croaks if any other error occurs.
Config::Tiny
CGI::Wiki
The config file needs to define at least the following variables:
dbtype - one of postgres, mysql and sqlite
postgres
mysql
sqlite
dbname
indexing_directory - for the Search::InvertedIndex files to go
The OpenGuides Project (openguides-dev@openguides.org)
Copyright (C) 2003 The OpenGuides Project. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install OpenGuides, copy and paste the appropriate command in to your terminal.
cpanm
cpanm OpenGuides
CPAN shell
perl -MCPAN -e shell install OpenGuides
For more information on module installation, please visit the detailed CPAN module installation guide.