X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/54d5308cd83c67e7e9c32450c776ef0dac63549f..0dc0d8e3b5f2db006ac83d0d7f336c2fda51b4bb:/IkiWiki/Plugin/skeleton.pm diff --git a/IkiWiki/Plugin/skeleton.pm b/IkiWiki/Plugin/skeleton.pm index e8d3db0cc..1201d055c 100644 --- a/IkiWiki/Plugin/skeleton.pm +++ b/IkiWiki/Plugin/skeleton.pm @@ -1,19 +1,104 @@ #!/usr/bin/perl # Ikiwiki skeleton plugin. Replace "skeleton" with the name of your plugin -# in the lines below, and flesh out the methods 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; use strict; +use IkiWiki; sub import { #{{{ - IkiWiki::register_plugin("preprocess", "skeleton", \&preprocess); + IkiWiki::hook(type => "getopt", id => "skeleton", + call => \&getopt); + IkiWiki::hook(type => "checkconfig", id => "skeleton", + call => \&checkconfig); + IkiWiki::hook(type => "preprocess", id => "skeleton", + call => \&preprocess); + IkiWiki::hook(type => "filter", id => "skeleton", + call => \&filter); + IkiWiki::hook(type => "htmlize", id => "skeleton", + call => \&htmlize); + IkiWiki::hook(type => "sanitize", id => "skeleton", + call => \&sanitize); + IkiWiki::hook(type => "pagetemplate", id => "skeleton", + call => \&pagetemplate); + IkiWiki::hook(type => "delete", id => "skeleton", + call => \&delete); + IkiWiki::hook(type => "change", id => "skeleton", + call => \&change); + IkiWiki::hook(type => "cgi", id => "skeleton", + call => \&cgi); + IkiWiki::hook(type => "savestate", id => "savestate", + call => \&savestate); } # }}} +sub getopt () { #{{{ + IkiWiki::debug("skeleton plugin getopt"); +} #}}} + +sub checkconfig () { #{{{ + IkiWiki::debug("skeleton plugin checkconfig"); +} #}}} + sub preprocess (@) { #{{{ my %params=@_; return "skeleton plugin result"; } # }}} +sub filter (@) { #{{{ + my %params=@_; + + IkiWiki::debug("skeleton plugin running as filter"); + + return $params{content}; +} # }}} + +sub htmlize ($) { #{{{ + my $content=shift; + + IkiWiki::debug("skeleton plugin running as htmlize"); + + return $content; +} # }}} + +sub sanitize ($) { #{{{ + my $content=shift; + + IkiWiki::debug("skeleton plugin running as a sanitizer"); + + return $content; +} # }}} + +sub pagetemplate (@) { #{{{ + my %params=@_; + my $page=$params{page}; + my $template=$params{template}; + + IkiWiki::debug("skeleton plugin running as a pagetemplate hook"); +} # }}} + +sub delete (@) { #{{{ + my @files=@_; + + IkiWiki::debug("skeleton plugin told that files were deleted: @files"); +} #}}} + +sub change (@) { #{{{ + my @files=@_; + + IkiWiki::debug("skeleton plugin told that changed files were rendered: @files"); +} #}}} + +sub cgi ($) { #{{{ + my $cgi=shift; + + IkiWiki::debug("skeleton plugin running in cgi"); +} #}}} + +sub savestate () { #{{{ + IkiWiki::debug("skeleton plugin running in savestate"); +} #}}} + 1