| 1 |
NAME |
| 2 |
Wiki::Toolkit - A toolkit for building Wikis. |
| 3 |
|
| 4 |
DESCRIPTION |
| 5 |
Helps you develop Wikis quickly by taking care of the boring bits |
| 6 |
for you. You will still need to write some code - this isn't an |
| 7 |
instant Wiki. |
| 8 |
|
| 9 |
Wiki::Toolkit used to be called CGI::Wiki. |
| 10 |
|
| 11 |
SEE ALSO |
| 12 |
Tom Insam's Wiki::Toolkit::Kwiki is however an instant wiki, running |
| 13 |
on a Wiki::Toolkit backend. |
| 14 |
|
| 15 |
SYNOPSIS |
| 16 |
|
| 17 |
# Set up a wiki object with an SQLite storage backend, and an |
| 18 |
# inverted index/DB_File search backend. This store/search |
| 19 |
# combination can be used on systems with no access to an actual |
| 20 |
# database server. |
| 21 |
|
| 22 |
my $store = Wiki::Toolkit::Store::SQLite->new( |
| 23 |
dbname => "/home/wiki/store.db" ); |
| 24 |
my $indexdb = Search::InvertedIndex::DB::DB_File_SplitHash->new( |
| 25 |
-map_name => "/home/wiki/indexes.db", |
| 26 |
-lock_mode => "EX" ); |
| 27 |
my $search = Wiki::Toolkit::Search::SII->new( |
| 28 |
indexdb => $indexdb ); |
| 29 |
|
| 30 |
my $wiki = Wiki::Toolkit->new( store => $store, |
| 31 |
search => $search ); |
| 32 |
|
| 33 |
|
| 34 |
MAJOR METHODS |
| 35 |
|
| 36 |
write_node |
| 37 |
$wiki->write_node($node_name, $content, $checksum); |
| 38 |
$wiki->write_node( |
| 39 |
"Calthorpe Arms", |
| 40 |
"A rather nice pub on Gray's Inn Road", |
| 41 |
$checksum, |
| 42 |
{ category => [ "Pub", "Pub Food", "Bloomsbury" ] } |
| 43 |
); |
| 44 |
|
| 45 |
format |
| 46 |
my $cooked = $wiki->format($raw); |
| 47 |
|
| 48 |
delete_node |
| 49 |
$wiki->delete_node($node_name); |
| 50 |
|
| 51 |
list_all_nodes |
| 52 |
my @node_names = $wiki->list_all_nodes; |
| 53 |
|
| 54 |
list_backlinks |
| 55 |
my @links_to_me = $wiki->list_backlinks($node_name); |
| 56 |
|
| 57 |
list_nodes_by_metadata |
| 58 |
my @pubs = $wiki->list_nodes_by_metadata( |
| 59 |
metadata_type => "category", |
| 60 |
metadata_value => "Pub" ); |
| 61 |
|
| 62 |
list_recent_changes |
| 63 |
my @last_week_edits = $wiki->list_recent_changes( days => 7 ); |
| 64 |
my @last_ten_changes = $wiki->list_recent_changes( |
| 65 |
last_n_changes => 10 ); |
| 66 |
|
| 67 |
node_exists |
| 68 |
print "Got wombats" if $wiki->node_exists("Wombats"); |
| 69 |
|
| 70 |
retrieve_node |
| 71 |
my $homepage_content = $wiki->retrieve_node("Home Page"); |
| 72 |
|
| 73 |
my %node_data = $wiki->retrieve_node( $node_name ); |
| 74 |
print "Last Modified: $node_data{last_modified}\n"; |
| 75 |
print "Current Version: $node_data{version}\n"; |
| 76 |
print "Current Checksum: $node_data{checksum}\n"; |
| 77 |
print "Current Content: $node_data{content}\n"; |
| 78 |
print "Categories: " |
| 79 |
. join(", ", @{$node_data{metadata}{category}}) . "\n"; |
| 80 |
|
| 81 |
verify_checksum |
| 82 |
my $as_i_left_it = $wiki->verify_checksum( $node_name, $checksum ); |
| 83 |
|
| 84 |
search_nodes |
| 85 |
my @nodes = $search->nodes( "camel" ); |
| 86 |
|