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