X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/19c58ac7c139eb3509f190e9ce746bd9f6237c90..8d9ec24232ede981face0c3eafbce71b74c4725a:/doc/plugins/aggregate.mdwn?ds=sidebyside diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn index 8b1abcd61..574c8b125 100644 --- a/doc/plugins/aggregate.mdwn +++ b/doc/plugins/aggregate.mdwn @@ -8,12 +8,12 @@ Aggregate a feed as follows feedurl="http://example.com/index.rss" url="http://example.com/" updateinterval="15"]] -That example aggregates posts from the expecified RSS feed, updating no +That example aggregates posts from the specified RSS feed, updating no more frequently than once every 15 minutes, and puts a page per post under the example/ directory in the wiki. -You can then use ikiwiki's [[blog]] support to create a blog of one or more -aggregated feeds. +You can then use ikiwiki's [[ikiwiki/blog]] support to create a blog of one or +more aggregated feeds. ## setup @@ -28,6 +28,14 @@ crontab entry: */15 * * * * ikiwiki --setup my.wiki --aggregate --refresh +Alternatively, you can allow `ikiwiki.cgi` to trigger the aggregation. You +should only need this if for some reason you cannot use cron, and instead +want to use a service such as [WebCron](http://webcron.org). To enable +this, enable on `aggregate_webtrigger` in your setup file. The url to +visit is `http://whatever/ikiwiki.cgi?do=aggregate_webtrigger`. Anyone +can visit the url to trigger an aggregation run, but it will only check +each feed if its `updateinterval` has passed. + ## usage Here are descriptions of all the supported parameters to the `aggregate` @@ -51,6 +59,8 @@ directive: * `tag` - A tag to tag each post from the feed with. A good tag to use is the name of the feed. Can be repeated multiple times. The [[tag]] plugin must be enabled for this to work. +* `template` - Template to use for creating the html pages. Defaults to + aggregatepost. Note that even if you are using subversion or another revision control system, pages created by aggregation will *not* be checked into revision