more 3.0 docs, changelog

[git.ikiwiki.info.git] / IkiWiki / Plugin / pinger.pm

diff --git a/IkiWiki/Plugin/pinger.pm b/IkiWiki/Plugin/pinger.pm
index 89b4365abf1c1393d24d254748b387f247efb554..4a808866164d7e2f1e6e185b97b37e50cf0c307b 100644 (file)
--- a/IkiWiki/Plugin/pinger.pm
+++ b/IkiWiki/Plugin/pinger.pm
@@ -3,31 +3,35 @@ package IkiWiki::Plugin::pinger;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 my %pages;
 my $pinged=0;
 
-sub import { #{{{
+sub import {
        hook(type => "getsetup", id => "pinger", call => \&getsetup);
        hook(type => "needsbuild", id => "pinger", call => \&needsbuild);
        hook(type => "preprocess", id => "ping", call => \&preprocess);
        hook(type => "delete", id => "pinger", call => \&ping);
        hook(type => "change", id => "pinger", call => \&ping);
-} # }}}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
+               plugin => {
+                       safe => 1,
+                       rebuild => 0,
+               },
                pinger_timeout => {
-                       type => "int",
-                       default => 15,
+                       type => "integer",
+                       example => 15,
                        description => "how many seconds to try pinging before timing out",
                        safe => 1,
                        rebuild => 0,
                },
-} #}}}
+}
 
-sub needsbuild (@) { #{{{
+sub needsbuild (@) {
        my $needsbuild=shift;
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{pinger}) {
@@ -41,9 +45,9 @@ sub needsbuild (@) { #{{{
                        }
                }
        }
-} # }}}
+}
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        my %params=@_;
        if (! exists $params{from} || ! exists $params{to}) {
                error gettext("requires 'from' and 'to' parameters");
@@ -56,7 +60,7 @@ sub preprocess (@) { #{{{
        else {
                return sprintf(gettext("Ignoring ping directive for wiki %s (this wiki is %s)"), $params{from}, $config{url});
        }
-} # }}}
+}
 
 sub ping {
        if (! $pinged && %pages) {