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