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 3.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 => "indexhtml", id => "skeleton", call => \&indexhtml);
  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 => "pageactions", id => "skeleton", call => \&pageactions);
  28         hook(type => "delete", id => "skeleton", call => \&delete);
  29         hook(type => "change", id => "skeleton", call => \&change);
  30         hook(type => "cgi", id => "skeleton", call => \&cgi);
  31         hook(type => "auth", id => "skeleton", call => \&auth);
  32         hook(type => "sessioncgi", id => "skeleton", call => \&sessioncgi);
  33         hook(type => "canedit", id => "skeleton", call => \&canedit);
  34         hook(type => "canremove", id => "skeleton", call => \&canremove);
  35         hook(type => "canrename", id => "skeleton", call => \&canrename);
  36         hook(type => "checkcontent", id => "skeleton", call => \&checkcontent);
  37         hook(type => "editcontent", id => "skeleton", call => \&editcontent);
  38         hook(type => "formbuilder_setup", id => "skeleton", call => \&formbuilder_setup);
  39         hook(type => "formbuilder", id => "skeleton", call => \&formbuilder);
  40         hook(type => "renamepage", id => "skeleton", call => \&renamepage);
  41         hook(type => "rename", id => "skeleton", call => \&rename);
  42         hook(type => "savestate", id => "skeleton", call => \&savestate);
  43         hook(type => "genwrapper", id => "skeleton", call => \&genwrapper);
  44         hook(type => "disable", id => "skeleton", call => \&disable);
  45 }
  46
  47 sub getopt () {
  48         debug("skeleton plugin getopt");
  49 }
  50
  51 sub getsetup () {
  52         return
  53                 plugin => {
  54                         safe => 1,
  55                         rebuild => undef,
  56                         section => "misc",
  57                 },
  58                 skeleton => {
  59                         type => "boolean",
  60                         example => 0,
  61                         description => "example option",
  62                         safe => 0,
  63                         rebuild => 0,
  64                 },
  65 }
  66
  67 sub checkconfig () {
  68         debug("skeleton plugin checkconfig");
  69 }
  70
  71 sub refresh () {
  72         debug("skeleton plugin refresh");
  73 }
  74
  75 sub needsbuild ($) {
  76         my $needsbuild=shift;
  77
  78         debug("skeleton plugin needsbuild");
  79
  80         return $needsbuild;
  81 }
  82
  83 sub preprocess (@) {
  84         my %params=@_;
  85
  86         return "skeleton plugin result";
  87 }
  88
  89 sub filter (@) {
  90         my %params=@_;
  91
  92         debug("skeleton plugin running as filter");
  93
  94         return $params{content};
  95 }
  96
  97 sub linkify (@) {
  98         my %params=@_;
  99
 100         debug("skeleton plugin running as linkify");
 101
 102         return $params{content};
 103 }
 104
 105 sub scan (@) {
 106         my %params=@_;
 107
 108         debug("skeleton plugin running as scan");
 109 }
 110
 111 sub htmlize (@) {
 112         my %params=@_;
 113
 114         debug("skeleton plugin running as htmlize");
 115
 116         return $params{content};
 117 }
 118
 119 sub sanitize (@) {
 120         my %params=@_;
 121
 122         debug("skeleton plugin running as a sanitizer");
 123
 124         return $params{content};
 125 }
 126
 127 sub indexhtml (@) {
 128         my %params=@_;
 129
 130         debug("skeleton plugin running as indexhtml");
 131 }
 132
 133 sub format (@) {
 134         my %params=@_;
 135
 136         debug("skeleton plugin running as a formatter");
 137
 138         return $params{content};
 139 }
 140
 141 sub pagetemplate (@) {
 142         my %params=@_;
 143         my $page=$params{page};
 144         my $template=$params{template};
 145
 146         debug("skeleton plugin running as a pagetemplate hook");
 147 }
 148
 149 sub templatefile (@) {
 150         my %params=@_;
 151         my $page=$params{page};
 152
 153         debug("skeleton plugin running as a templatefile hook");
 154 }
 155
 156 sub pageactions (@) {
 157         my %params=@_;
 158         my $page=$params{page};
 159
 160         debug("skeleton plugin running as a pageactions hook");
 161         return ();
 162 }
 163
 164 sub delete (@) {
 165         my @files=@_;
 166
 167         debug("skeleton plugin told that files were deleted: @files");
 168 }
 169
 170 sub change (@) {
 171         my @files=@_;
 172
 173         debug("skeleton plugin told that changed files were rendered: @files");
 174 }
 175
 176 sub cgi ($) {
 177         my $cgi=shift;
 178
 179         debug("skeleton plugin running in cgi");
 180 }
 181
 182 sub auth ($$) {
 183         my $cgi=shift;
 184         my $session=shift;
 185
 186         debug("skeleton plugin running in auth");
 187 }
 188
 189 sub sessioncgi ($$) {
 190         my $cgi=shift;
 191         my $session=shift;
 192
 193         debug("skeleton plugin running in sessioncgi");
 194 }
 195
 196 sub canedit ($$$) {
 197         my $page=shift;
 198         my $cgi=shift;
 199         my $session=shift;
 200
 201         debug("skeleton plugin running in canedit");
 202 }
 203
 204 sub canremove (@) {
 205         my %params=@_;
 206
 207         debug("skeleton plugin running in canremove");
 208 }
 209
 210 sub canrename (@) {
 211         my %params=@_;
 212
 213         debug("skeleton plugin running in canrename");
 214 }
 215
 216 sub checkcontent (@) {
 217         my %params=@_;
 218
 219         debug("skeleton plugin running in checkcontent");
 220 }
 221
 222 sub editcontent ($$$) {
 223         my %params=@_;
 224
 225         debug("skeleton plugin running in editcontent");
 226
 227         return $params{content};
 228 }
 229
 230 sub formbuilder_setup (@) {
 231         my %params=@_;
 232
 233         debug("skeleton plugin running in formbuilder_setup");
 234 }
 235
 236 sub formbuilder (@) {
 237         my %params=@_;
 238
 239         debug("skeleton plugin running in formbuilder");
 240 }
 241
 242 sub renamepage (@) {
 243         my %params=@_;
 244
 245         debug("skeleton plugin running in renamepage");
 246 }
 247
 248 sub rename (@) {
 249         my %params=@_;
 250
 251         debug("skeleton plugin running in rename");
 252 }
 253
 254 sub savestate () {
 255         debug("skeleton plugin running in savestate");
 256 }
 257
 258 sub genwrapper () {
 259         debug("skeleton plugin running in genwrapper");
 260 }
 261
 262 sub disable () {
 263         debug("skeleton plugin running in disable");
 264 }
 265
 266 1