ikiwiki/IkiWiki/Plugin/skeleton.pm

155 lines
3.5 KiB
Perl
Raw Normal View History

#!/usr/bin/perl
# Ikiwiki skeleton plugin. Replace "skeleton" with the name of your plugin
# 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;
use strict;
use IkiWiki 2.00;
sub import { #{{{
hook(type => "getopt", id => "skeleton", call => \&getopt);
hook(type => "checkconfig", id => "skeleton", call => \&checkconfig);
hook(type => "needsbuild", id => "skeleton", call => \&needsbuild);
hook(type => "preprocess", id => "skeleton", call => \&preprocess);
hook(type => "filter", id => "skeleton", call => \&filter);
hook(type => "htmlize", id => "skeleton", call => \&htmlize);
hook(type => "sanitize", id => "skeleton", call => \&sanitize);
hook(type => "format", id => "skeleton", call => \&format);
hook(type => "pagetemplate", id => "skeleton", call => \&pagetemplate);
hook(type => "templatefile", id => "skeleton", call => \&templatefile);
hook(type => "delete", id => "skeleton", call => \&delete);
hook(type => "change", id => "skeleton", call => \&change);
hook(type => "cgi", id => "skeleton", call => \&cgi);
hook(type => "auth", id => "skeleton", call => \&auth);
hook(type => "sessioncgi", id => "skeleton", call => \&sessioncgi);
hook(type => "canedit", id => "skeleton", call => \&canedit);
hook(type => "formbuilder_setup", id => "skeleton", call => \&formbuilder_setup);
hook(type => "formbuilder", id => "skeleton", call => \&formbuilder);
2007-07-28 22:53:51 +02:00
hook(type => "savestate", id => "skeleton", call => \&savestate);
} # }}}
sub getopt () { #{{{
debug("skeleton plugin getopt");
} #}}}
sub checkconfig () { #{{{
debug("skeleton plugin checkconfig");
} #}}}
sub needsbuild () { #{{{
debug("skeleton plugin needsbuild");
} #}}}
sub preprocess (@) { #{{{
my %params=@_;
return "skeleton plugin result";
} # }}}
sub filter (@) { #{{{
my %params=@_;
debug("skeleton plugin running as filter");
return $params{content};
} # }}}
sub htmlize (@) { #{{{
my %params=@_;
2006-07-04 00:42:11 +02:00
debug("skeleton plugin running as htmlize");
2006-07-04 00:42:11 +02:00
return $params{content};
2006-07-04 00:42:11 +02:00
} # }}}
sub sanitize (@) { #{{{
my %params=@_;
debug("skeleton plugin running as a sanitizer");
return $params{content};
} # }}}
sub format (@) { #{{{
my %params=@_;
2006-08-28 09:40:20 +02:00
debug("skeleton plugin running as a formatter");
2006-08-28 09:40:20 +02:00
return $params{content};
2006-08-28 09:40:20 +02:00
} # }}}
sub pagetemplate (@) { #{{{
my %params=@_;
my $page=$params{page};
my $template=$params{template};
debug("skeleton plugin running as a pagetemplate hook");
} # }}}
sub templatefile (@) { #{{{
my %params=@_;
my $page=$params{page};
debug("skeleton plugin running as a templatefile hook");
} # }}}
sub delete (@) { #{{{
my @files=@_;
debug("skeleton plugin told that files were deleted: @files");
} #}}}
sub change (@) { #{{{
my @files=@_;
debug("skeleton plugin told that changed files were rendered: @files");
} #}}}
sub cgi ($) { #{{{
my $cgi=shift;
debug("skeleton plugin running in cgi");
} #}}}
sub auth ($$) { #{{{
my $cgi=shift;
my $session=shift;
debug("skeleton plugin running in auth");
} #}}}
sub sessionncgi ($$) { #{{{
my $cgi=shift;
my $session=shift;
debug("skeleton plugin running in sessioncgi");
} #}}}
sub canedit ($$$) { #{{{
my $page=shift;
my $cgi=shift;
my $session=shift;
debug("skeleton plugin running in canedit");
} #}}}
sub formbuilder_setup (@) { #{{{
my %params=@_;
debug("skeleton plugin running in formbuilder_setup");
} # }}}
sub formbuilder (@) { #{{{
my %params=@_;
debug("skeleton plugin running in formbuilder");
} # }}}
sub savestate () { #{{{
debug("skeleton plugin running in savestate");
} #}}}
1