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;
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 => "checkcontent", id => "skeleton", call => \&checkcontent);
34 hook(type => "editcontent", id => "skeleton", call => \&editcontent);
35 hook(type => "formbuilder_setup", id => "skeleton", call => \&formbuilder_setup);
36 hook(type => "formbuilder", id => "skeleton", call => \&formbuilder);
37 hook(type => "savestate", id => "skeleton", call => \&savestate);
41 debug("skeleton plugin getopt");
53 description => "example option",
60 debug("skeleton plugin checkconfig");
64 debug("skeleton plugin refresh");
68 debug("skeleton plugin needsbuild");
74 return "skeleton plugin result";
80 debug("skeleton plugin running as filter");
82 return $params{content};
88 debug("skeleton plugin running as linkify");
90 return $params{content};
96 debug("skeleton plugin running as scan");
102 debug("skeleton plugin running as htmlize");
104 return $params{content};
110 debug("skeleton plugin running as a sanitizer");
112 return $params{content};
118 debug("skeleton plugin running as postscan");
124 debug("skeleton plugin running as a formatter");
126 return $params{content};
129 sub pagetemplate (@) {
131 my $page=$params{page};
132 my $template=$params{template};
134 debug("skeleton plugin running as a pagetemplate hook");
137 sub templatefile (@) {
139 my $page=$params{page};
141 debug("skeleton plugin running as a templatefile hook");
147 debug("skeleton plugin told that files were deleted: @files");
153 debug("skeleton plugin told that changed files were rendered: @files");
159 debug("skeleton plugin running in cgi");
166 debug("skeleton plugin running in auth");
169 sub sessioncgi ($$) {
173 debug("skeleton plugin running in sessioncgi");
181 debug("skeleton plugin running in canedit");
184 sub checkcontent (@) {
187 debug("skeleton plugin running in checkcontent");
190 sub editcontent ($$$) {
193 debug("skeleton plugin running in editcontent");
195 return $params{content};
198 sub formbuilder_setup (@) {
201 debug("skeleton plugin running in formbuilder_setup");
204 sub formbuilder (@) {
207 debug("skeleton plugin running in formbuilder");
211 debug("skeleton plugin running in savestate");