IkiWiki/Plugin/skeleton.pm.example

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