X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/0708bb8aecaa6f4edcb60d84ed6555d61f83a2bc..8f8959c96ecc69ecc75b5e5c76b52345afce94d8:/doc/plugins/aggregate.mdwn diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn index fe17199e3..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 @@ -14,8 +19,8 @@ aggregated feeds. Make sure that you have the [[html]] plugin enabled, as the created pages are in html format. The [[meta]] and [[tag]] plugins are also recommended. The -[[htmltidy]] plugin is suggested, since feeds can easily contain invalid -html which tidy can fix. +[[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 @@ -50,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]]