Merge branch 'master' of ssh://git.kitenet.net/srv/git/ikiwiki.info

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

diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn
index 690904f73452e08dd635a2d6ff6c33139cbc750e..398da4b5e60a7ebf6448ee683bf281d188ebb4fc 100644 (file)
--- a/doc/plugins/aggregate.mdwn
+++ b/doc/plugins/aggregate.mdwn
@@ -1,9 +1,14 @@
-This plugin allows content from other blogs to be aggregated into the wiki.
-Aggregate a blog as follows:
+[[template id=plugin name=aggregate author="[[Joey]]"]]
+[[tag type/useful]]
+
+This plugin allows content from other feeds to be aggregated into the wiki.
+Aggregate a feed as follows
 
-       \[[aggregate name="example blog" feedurl="http://example.com/index.rss" url="http://example.com/" updateinterval="15" dir="example"]
+       \[[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
+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.
 
@@ -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
@@ -28,26 +35,23 @@ directive:
 
 * `name` - A name for the feed. Each feed must have a unique name.
   Required.
-* `url` - The url to the web page for the blog that's being aggregated.
+* `url` - The url to the web page for the feed that's being aggregated.
   Required.
-* `dir` - The directory in the wiki where pages should be saved. Required.
+* `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
+* `expireage` - Expire old items from this feed if they are older than
   a specified number of days. Default is to never expire on age.
-* `expirecount` - Expire old items from this blog if there are more than
+* `expirecount` - Expire old items from this feed if there are more than
   the specified number total. Oldest items will be expired first. Default
   is to never expire on count.
-* `tag` - A tag to tag each post from the blog with. A good tag to use is
-  the name of the blog. Can be repeated multiple times. The [[tag]] plugin
+* `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.
 
 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]]