summaryrefslogtreecommitdiff
path: root/IkiWiki/Plugin/skeleton.pm
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-03 21:50:39 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-03 21:50:39 +0000
commitaf9566ff1ae55d273ff96c7ca39e34265623a55d (patch)
treebe91c4464b174b72efbd6453068e8f7308c49e02 /IkiWiki/Plugin/skeleton.pm
parentb0952742b29373bd762cf13c258cfd4559a680ad (diff)
rather a lot of changes to make hyperestraier search be a plugin, allowing
for other types of search engine plugins if wanted, and also opening up a lot of new possibilities for other kinds of plugins later some notable changes along the way: - lots of new hook types: cgi, render, delete - wrapper files fixed to support config strings with newlines in them - HEADERCONTENT in page template useful for plugins. Probably needs to be expanded to more such for other places plugins might want to add content. - remove unnecessary wrappers field from config info stored in wrappers
Diffstat (limited to 'IkiWiki/Plugin/skeleton.pm')
-rw-r--r--IkiWiki/Plugin/skeleton.pm33
1 files changed, 32 insertions, 1 deletions
diff --git a/IkiWiki/Plugin/skeleton.pm b/IkiWiki/Plugin/skeleton.pm
index 89308c45f..d6d8cc0ed 100644
--- a/IkiWiki/Plugin/skeleton.pm
+++ b/IkiWiki/Plugin/skeleton.pm
@@ -1,6 +1,7 @@
#!/usr/bin/perl
# Ikiwiki skeleton plugin. Replace "skeleton" with the name of your plugin
-# in the lines below, and flesh out the code to make it do something.
+# in the lines below, remove hooks you don't use, and flesh out the code to
+# make it do something.
package IkiWiki::Plugin::skeleton;
use warnings;
@@ -8,14 +9,44 @@ use strict;
use IkiWiki;
sub import { #{{{
+ IkiWiki::hook(type => "checkconfig", id => "skeleton",
+ call => \&checkconfig);
IkiWiki::hook(type => "preprocess", id => "skeleton",
call => \&preprocess);
+ IkiWiki::hook(type => "delete", id => "skeleton",
+ call => \&delete);
+ IkiWiki::hook(type => "render", id => "skeleton",
+ call => \&render);
+ IkiWiki::hook(type => "cgi", id => "skeleton",
+ call => \&cgi);
} # }}}
+sub checkconfig () { #{{{
+ IkiWiki::debug("skeleton plugin checkconfig");
+} #}}}
+
sub preprocess (@) { #{{{
my %params=@_;
return "skeleton plugin result";
} # }}}
+sub delete (@) { #{{{
+ my @files=@_;
+
+ IkiWiki::debug("skeleton plugin told that files were deleted: @files");
+} #}}}
+
+sub render (@) { #{{{
+ my @files=@_;
+
+ IkiWiki::debug("skeleton plugin told that files were rendered: @files");
+} #}}}
+
+sub cgi ($) { #{{{
+ my $cgi=shift;
+
+ IkiWiki::debug("skeleton plugin running in cgi");
+} #}}}
+
1