From 9921a4a8a1a696ce69acce5e14943f0149d926ff Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Thu, 11 Sep 2008 18:41:26 -0400 Subject: Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki. --- doc/ikiwiki/directive/ping.mdwn | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 doc/ikiwiki/directive/ping.mdwn (limited to 'doc/ikiwiki/directive/ping.mdwn') diff --git a/doc/ikiwiki/directive/ping.mdwn b/doc/ikiwiki/directive/ping.mdwn new file mode 100644 index 000000000..9eac60fd5 --- /dev/null +++ b/doc/ikiwiki/directive/ping.mdwn @@ -0,0 +1,18 @@ +The `ping` directive is supplied by the [[!iki plugins/pinger]] plugin. + +This directive 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 [[!iki plugins/pingee]] +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. + + \[[!ping from="http://mywiki.com/" + to="http://otherwiki.com/ikiwiki.cgi?do=ping"]] + +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. + +[[!meta robots="noindex, follow"]] -- cgit v1.2.3