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