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