aboutsummaryrefslogtreecommitdiff
path: root/IkiWiki/Plugin/skeleton.pm.example
blob: 573510191c5c92507fbf0dc68615f9246f3b3437 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
#!/usr/bin/perl
# Ikiwiki skeleton plugin. Replace "skeleton" with the name of your plugin
# in the lines below, remove hooks you don't use, and flesh out the code to
# make it do something.
package IkiWiki::Plugin::skeleton;

use warnings;
use strict;
use IkiWiki 3.00;

sub import {
	hook(type => "getopt", id => "skeleton",  call => \&getopt);
	hook(type => "getsetup", id => "skeleton",  call => \&getsetup);
	hook(type => "checkconfig", id => "skeleton", call => \&checkconfig);
	hook(type => "refresh", id => "skeleton", call => \&refresh);
	hook(type => "needsbuild", id => "skeleton", call => \&needsbuild);
	hook(type => "preprocess", id => "skeleton", call => \&preprocess);
	hook(type => "filter", id => "skeleton", call => \&filter);
	hook(type => "linkify", id => "skeleton", call => \&linkify);
	hook(type => "scan", id => "skeleton", call => \&scan);
	hook(type => "htmlize", id => "skeleton", call => \&htmlize);
	hook(type => "sanitize", id => "skeleton", call => \&sanitize);
	hook(type => "postscan", id => "skeleton", call => \&postscan);
	hook(type => "format", id => "skeleton", call => \&format);
	hook(type => "pagetemplate", id => "skeleton", call => \&pagetemplate);
	hook(type => "templatefile", id => "skeleton", call => \&templatefile);
	hook(type => "delete", id => "skeleton", call => \&delete);
	hook(type => "change", id => "skeleton", call => \&change);
	hook(type => "cgi", id => "skeleton", call => \&cgi);
	hook(type => "auth", id => "skeleton", call => \&auth);
	hook(type => "sessioncgi", id => "skeleton", call => \&sessioncgi);
	hook(type => "canedit", id => "skeleton", call => \&canedit);
	hook(type => "canremove", id => "skeleton", call => \&canremove);
	hook(type => "canrename", id => "skeleton", call => \&canrename);
	hook(type => "checkcontent", id => "skeleton", call => \&checkcontent);
	hook(type => "editcontent", id => "skeleton", call => \&editcontent);
	hook(type => "formbuilder_setup", id => "skeleton", call => \&formbuilder_setup);
	hook(type => "formbuilder", id => "skeleton", call => \&formbuilder);
	hook(type => "renamepage", id => "skeleton", call => \&renamepage);
	hook(type => "rename", id => "skeleton", call => \&rename);
	hook(type => "savestate", id => "skeleton", call => \&savestate);
}

sub getopt () {
	debug("skeleton plugin getopt");
}

sub getsetup () {
	return
		plugin => {
			safe => 1,
			rebuild => undef,
		},
		skeleton => {
			type => "boolean",
			example => 0,
			description => "example option",
			safe => 0,
			rebuild => 0,
		},
}

sub checkconfig () {
	debug("skeleton plugin checkconfig");
}

sub refresh () {
	debug("skeleton plugin refresh");
}

sub needsbuild () {
	debug("skeleton plugin needsbuild");
}

sub preprocess (@) {
	my %params=@_;

	return "skeleton plugin result";
}

sub filter (@) {
	my %params=@_;
	
	debug("skeleton plugin running as filter");

	return $params{content};
}

sub linkify (@) {
	my %params=@_;
	
	debug("skeleton plugin running as linkify");

	return $params{content};
}

sub scan (@) {
	my %params=@_;

	debug("skeleton plugin running as scan");
}

sub htmlize (@) {
	my %params=@_;

	debug("skeleton plugin running as htmlize");

	return $params{content};
}

sub sanitize (@) {
	my %params=@_;
	
	debug("skeleton plugin running as a sanitizer");

	return $params{content};
}

sub postscan (@) {
	my %params=@_;
	
	debug("skeleton plugin running as postscan");
}

sub format (@) {
	my %params=@_;
	
	debug("skeleton plugin running as a formatter");

	return $params{content};
}

sub pagetemplate (@) {
	my %params=@_;
	my $page=$params{page};
	my $template=$params{template};
	
	debug("skeleton plugin running as a pagetemplate hook");
}

sub templatefile (@) {
	my %params=@_;
	my $page=$params{page};
	
	debug("skeleton plugin running as a templatefile hook");
}

sub delete (@) {
	my @files=@_;

	debug("skeleton plugin told that files were deleted: @files");
}

sub change (@) {
	my @files=@_;

	debug("skeleton plugin told that changed files were rendered: @files");
}

sub cgi ($) {
	my $cgi=shift;

	debug("skeleton plugin running in cgi");
}

sub auth ($$) {
	my $cgi=shift;
	my $session=shift;

	debug("skeleton plugin running in auth");
}

sub sessioncgi ($$) {
	my $cgi=shift;
	my $session=shift;

	debug("skeleton plugin running in sessioncgi");
}

sub canedit ($$$) {
	my $page=shift;
	my $cgi=shift;
	my $session=shift;

	debug("skeleton plugin running in canedit");
}

sub canremove (@) {
	my %params=@_;

	debug("skeleton plugin running in canremove");
}

sub canrename (@) {
	my %params=@_;

	debug("skeleton plugin running in canrename");
}

sub checkcontent (@) {
	my %params=@_;

	debug("skeleton plugin running in checkcontent");
}

sub editcontent ($$$) {
	my %params=@_;

	debug("skeleton plugin running in editcontent");

	return $params{content};
}

sub formbuilder_setup (@) {
	my %params=@_;
	
	debug("skeleton plugin running in formbuilder_setup");
}

sub formbuilder (@) {
	my %params=@_;
	
	debug("skeleton plugin running in formbuilder");
}

sub renamepage (@) {
	my %params=@_;
	
	debug("skeleton plugin running in renamepage");
}

sub rename (@) {
	my %params=@_;
	
	debug("skeleton plugin running in rename");
}

sub savestate () {
	debug("skeleton plugin running in savestate");
}

1