add plugin safe/rebuild info (part 3 of 3)
[ikiwiki.git] / IkiWiki / Plugin / skeleton.pm.example
index 1af8e4e9df3b0903cd1341327f606fd4599afcde..7878d7c2b09a7eda151d22f07e9da107a1b60154 100644 (file)
@@ -10,7 +10,9 @@ use IkiWiki 2.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);
@@ -38,10 +40,29 @@ 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");
 } #}}}