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