X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c5b02885e934e5a1f8c5a8753ed47eaf4cce8b9f..89fccafa57ea93bbce5f0c1b5a0e275fd9911fa1:/doc/plugins/aggregate.mdwn diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn index 95c8534b0..0e5ba855f 100644 --- a/doc/plugins/aggregate.mdwn +++ b/doc/plugins/aggregate.mdwn @@ -1,7 +1,12 @@ +[[template id=plugin name=aggregate included=1 author="[[Joey]]"]] +[[tag type/useful]] + This plugin allows content from other blogs to be aggregated into the wiki. Aggregate a blog as follows: - \[[aggregate name="example blog" feedurl="http://example.com/index.rss" url="http://example.com/" updateinterval="15"] + \[[aggregate name="example blog" + feedurl="http://example.com/index.rss" + url="http://example.com/" updateinterval="15"]] That example aggregates posts from the expecified RSS feed, updating no more frequently than once every 15 minutes, and puts a page per post under @@ -13,7 +18,9 @@ aggregated feeds. ## setup Make sure that you have the [[html]] plugin enabled, as the created pages are -in html format. The [[tag]] plugin is also recommended. +in html format. The [[meta]] and [[tag]] plugins are also recommended. The +[[htmltidy]] plugin is suggested, since feeds can easily contain html +problems, some of which tidy can fix. You will need to run ikiwiki periodically from a cron job, passing it the --aggregate parameter, to make it check for new posts. Here's an example @@ -33,7 +40,7 @@ directive: * `dir` - The directory in the wiki where pages should be saved. Optional, if not specified, the directory is based on the name of the feed. * `feedurl` - The url to the feed. Optional, if it's not specified ikiwiki - will look for feeds on the `blogurl`. RSS and atom feeds are supported. + will look for feeds on the `url`. RSS and atom feeds are supported. * `updateinterval` - How often to check for new posts, in minutes. Default is 15 minutes. * `expireage` - Expire old items from this blog if they are older than @@ -48,7 +55,3 @@ directive: Note that even if you are using subversion or another revision control system, pages created by aggregation will *not* be checked into revision control. - -This plugin is not enabled by default. - -[[tag type/useful]]