cleaned up, updated and submitted for patch

[git.ikiwiki.info.git] / doc / plugins / pinger.mdwn

diff --git a/doc/plugins/pinger.mdwn b/doc/plugins/pinger.mdwn
index f747a9f0b5931e5d983d7ec4104b45dcb4950e37..00d83e1bb1ca68ccf6d74a3f0c12814437508743 100644 (file)
--- a/doc/plugins/pinger.mdwn
+++ b/doc/plugins/pinger.mdwn
@@ -1,5 +1,5 @@
-[[template id=plugin name=pinger author="[[Joey]]"]]
-[[tag type/special-purpose]]
+[[!template id=plugin name=pinger author="[[Joey]]"]]
+[[!tag type/special-purpose]]

 
 This plugin allows ikiwiki to be configured to hit a URL each time it
 updates the wiki. One way to use this is in conjunction with the [[pingee]]
 
 This plugin allows ikiwiki to be configured to hit a URL each time it
 updates the wiki. One way to use this is in conjunction with the [[pingee]]


@@ -7,18 +7,12 @@ plugin to set up a loosely coupled mirror network, or a branched version of
 a wiki. By pinging the mirror or branch each time the main wiki changes, it
 can be kept up-to-date.
 
 a wiki. By pinging the mirror or branch each time the main wiki changes, it
 can be kept up-to-date.
 

-        \[[!ping from="http://mywiki.com/"
-        to="http://otherwiki.com/ikiwiki.cgi?do=ping"]]
+To configure what URLs to ping, use the [[ikiwiki/directive/ping]]
+[[ikiwiki/directive]].

 
 

-The "from" parameter must be identical to the url of the wiki that is doing
-the pinging. This is used to prevent ping loops.
-
-The "to" parameter is the url to ping. The example shows how to ping
-another ikiwiki instance.
-
-The [[cpan LWP]] perl module is used for pinging. Or the [[cpan
+The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan

 LWPx::ParanoidAgent]] perl module is used if available, for added security.
 LWPx::ParanoidAgent]] perl module is used if available, for added security.

-Finally, the [[cpan Crypt::SSLeay]] perl module is needed to support pinging
+Finally, the [[!cpan Crypt::SSLeay]] perl module is needed to support pinging

 "https" urls.
 
 By default the pinger will try to ping a site for 15 seconds before timing
 "https" urls.
 
 By default the pinger will try to ping a site for 15 seconds before timing