ikiwiki/IkiWiki/Plugin/skeleton.pm

103 lines
2.3 KiB
Perl

#!/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 '1.00';
sub import { #{{{
hook(type => "getopt", id => "skeleton", call => \&getopt);
hook(type => "checkconfig", id => "skeleton", call => \&checkconfig);
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 => "delete", id => "skeleton", call => \&delete);
hook(type => "change", id => "skeleton", call => \&change);
hook(type => "cgi", id => "skeleton", call => \&cgi);
hook(type => "savestate", id => "savestate", call => \&savestate);
} # }}}
sub getopt () { #{{{
debug("skeleton plugin getopt");
} #}}}
sub checkconfig () { #{{{
debug("skeleton plugin checkconfig");
} #}}}
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=@_;
debug("skeleton plugin running as htmlize");
return $params{content};
} # }}}
sub sanitize (@) { #{{{
my %params=@_;
debug("skeleton plugin running as a sanitizer");
return $params{content};
} # }}}
sub format (@) { #{{{
my %params=@_;
debug("skeleton plugin running as a formatter");
return $params{content};
} # }}}
sub pagetemplate (@) { #{{{
my %params=@_;
my $page=$params{page};
my $template=$params{template};
debug("skeleton plugin running as a pagetemplate 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 savestate () { #{{{
debug("skeleton plugin running in savestate");
} #}}}
1