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