* Removed --sanitize and --no-sanitize, replaced with --plugin htmlscrubber
[ikiwiki.git] / IkiWiki / Plugin / skeleton.pm
1 #!/usr/bin/perl
2 # Ikiwiki skeleton plugin. Replace "skeleton" with the name of your plugin
3 # in the lines below, remove hooks you don't use, and flesh out the code to
4 # make it do something.
5 package IkiWiki::Plugin::skeleton;
6
7 use warnings;
8 use strict;
9 use IkiWiki;
10
11 sub import { #{{{
12         IkiWiki::hook(type => "checkconfig", id => "skeleton", 
13                 call => \&checkconfig);
14         IkiWiki::hook(type => "preprocess", id => "skeleton", 
15                 call => \&preprocess);
16         IkiWiki::hook(type => "filter", id => "skeleton", 
17                 call => \&filter);
18         IkiWiki::hook(type => "sanitize", id => "skeleton", 
19                 call => \&sanitize);
20         IkiWiki::hook(type => "delete", id => "skeleton", 
21                 call => \&delete);
22         IkiWiki::hook(type => "change", id => "skeleton", 
23                 call => \&change);
24         IkiWiki::hook(type => "cgi", id => "skeleton", 
25                 call => \&cgi);
26 } # }}}
27
28 sub checkconfig () { #{{{
29         IkiWiki::debug("skeleton plugin checkconfig");
30 } #}}}
31
32 sub preprocess (@) { #{{{
33         my %params=@_;
34
35         return "skeleton plugin result";
36 } # }}}
37
38 sub filter (@) { #{{{
39         my %params=@_;
40         
41         IkiWiki::debug("skeleton plugin running as filter");
42
43         return $params{content};
44 } # }}}
45
46 sub sanitize ($) { #{{{
47         my $content=shift;
48         
49         IkiWiki::debug("skeleton plugin running as a sanitizer");
50
51         return $content;
52 } # }}}
53
54 sub delete (@) { #{{{
55         my @files=@_;
56
57         IkiWiki::debug("skeleton plugin told that files were deleted: @files");
58 } #}}}
59
60 sub change (@) { #{{{
61         my @files=@_;
62
63         IkiWiki::debug("skeleton plugin told that changed files were rendered: @files");
64 } #}}}
65
66 sub cgi ($) { #{{{
67         my $cgi=shift;
68
69         IkiWiki::debug("skeleton plugin running in cgi");
70 } #}}}
71
72 1