Error handling improvement for preprocess hooks. It's now safe to call error() from...

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

diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn
index a3ef105d696eee6151053d346221b62d67df9244..574c8b125e9486e3433a89711eddd4ebbab03fb0 100644 (file)
--- a/doc/plugins/aggregate.mdwn
+++ b/doc/plugins/aggregate.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=aggregate included=1 author="[[Joey]]"]]
+[[template id=plugin name=aggregate author="[[Joey]]"]]

 [[tag type/useful]]
 
 This plugin allows content from other feeds to be aggregated into the wiki.
 [[tag type/useful]]
 
 This plugin allows content from other feeds to be aggregated into the wiki.


@@ -8,12 +8,12 @@ Aggregate a feed as follows
        feedurl="http://example.com/index.rss"
        url="http://example.com/" updateinterval="15"]]
 
        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.
 
 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
 
 
 ## setup
 


@@ -28,6 +28,14 @@ crontab entry:
 
        */15 * * * * ikiwiki --setup my.wiki --aggregate --refresh
 
 
        */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`
 ## 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.
 * `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
 
 Note that even if you are using subversion or another revision control
 system, pages created by aggregation will *not* be checked into revision