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 2.00;
  10
  11 sub import { #{{{
  12         hook(type => "getopt", id => "skeleton",  call => \&getopt);
  13         hook(type => "checkconfig", id => "skeleton", call => \&checkconfig);
  14         hook(type => "needsbuild", id => "skeleton", call => \&needsbuild);
  15         hook(type => "preprocess", id => "skeleton", call => \&preprocess);
  16         hook(type => "filter", id => "skeleton", call => \&filter);
  17         hook(type => "htmlize", id => "skeleton", call => \&htmlize);
  18         hook(type => "sanitize", id => "skeleton", call => \&sanitize);
  19         hook(type => "format", id => "skeleton", call => \&format);
  20         hook(type => "pagetemplate", id => "skeleton", call => \&pagetemplate);
  21         hook(type => "templatefile", id => "skeleton", call => \&templatefile);
  22         hook(type => "delete", id => "skeleton", call => \&delete);
  23         hook(type => "change", id => "skeleton", call => \&change);
  24         hook(type => "cgi", id => "skeleton", call => \&cgi);
  25         hook(type => "auth", id => "skeleton", call => \&auth);
  26         hook(type => "sessioncgi", id => "skeleton", call => \&sessioncgi);
  27         hook(type => "canedit", id => "skeleton", call => \&canedit);
  28         hook(type => "formbuilder_setup", id => "skeleton", call => \&formbuilder_setup);
  29         hook(type => "formbuilder", id => "skeleton", call => \&formbuilder);
  30         hook(type => "savestate", id => "skeleton", call => \&savestate);
  31 } # }}}
  32
  33 sub getopt () { #{{{
  34         debug("skeleton plugin getopt");
  35 } #}}}
  36
  37 sub checkconfig () { #{{{
  38         debug("skeleton plugin checkconfig");
  39 } #}}}
  40
  41 sub needsbuild () { #{{{
  42         debug("skeleton plugin needsbuild");
  43 } #}}}
  44
  45 sub preprocess (@) { #{{{
  46         my %params=@_;
  47
  48         return "skeleton plugin result";
  49 } # }}}
  50
  51 sub filter (@) { #{{{
  52         my %params=@_;
  53
  54         debug("skeleton plugin running as filter");
  55
  56         return $params{content};
  57 } # }}}
  58
  59 sub htmlize (@) { #{{{
  60         my %params=@_;
  61
  62         debug("skeleton plugin running as htmlize");
  63
  64         return $params{content};
  65 } # }}}
  66
  67 sub sanitize (@) { #{{{
  68         my %params=@_;
  69
  70         debug("skeleton plugin running as a sanitizer");
  71
  72         return $params{content};
  73 } # }}}
  74
  75 sub format (@) { #{{{
  76         my %params=@_;
  77
  78         debug("skeleton plugin running as a formatter");
  79
  80         return $params{content};
  81 } # }}}
  82
  83 sub pagetemplate (@) { #{{{
  84         my %params=@_;
  85         my $page=$params{page};
  86         my $template=$params{template};
  87
  88         debug("skeleton plugin running as a pagetemplate hook");
  89 } # }}}
  90
  91 sub templatefile (@) { #{{{
  92         my %params=@_;
  93         my $page=$params{page};
  94
  95         debug("skeleton plugin running as a templatefile hook");
  96 } # }}}
  97
  98 sub delete (@) { #{{{
  99         my @files=@_;
 100
 101         debug("skeleton plugin told that files were deleted: @files");
 102 } #}}}
 103
 104 sub change (@) { #{{{
 105         my @files=@_;
 106
 107         debug("skeleton plugin told that changed files were rendered: @files");
 108 } #}}}
 109
 110 sub cgi ($) { #{{{
 111         my $cgi=shift;
 112
 113         debug("skeleton plugin running in cgi");
 114 } #}}}
 115
 116 sub auth ($$) { #{{{
 117         my $cgi=shift;
 118         my $session=shift;
 119
 120         debug("skeleton plugin running in auth");
 121 } #}}}
 122
 123 sub sessionncgi ($$) { #{{{
 124         my $cgi=shift;
 125         my $session=shift;
 126
 127         debug("skeleton plugin running in sessioncgi");
 128 } #}}}
 129
 130 sub canedit ($$$) { #{{{
 131         my $page=shift;
 132         my $cgi=shift;
 133         my $session=shift;
 134
 135         debug("skeleton plugin running in canedit");
 136 } #}}}
 137
 138 sub formbuilder_setup (@) { #{{{
 139         my %params=@_;
 140
 141         debug("skeleton plugin running in formbuilder_setup");
 142 } # }}}
 143
 144 sub formbuilder (@) { #{{{
 145         my %params=@_;
 146
 147         debug("skeleton plugin running in formbuilder");
 148 } # }}}
 149
 150 sub savestate () { #{{{
 151         debug("skeleton plugin running in savestate");
 152 } #}}}
 153
 154 1