X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9921a4a8a1a696ce69acce5e14943f0149d926ff..c3f86eaf97e6138626731a82c869e392a8f7f38b:/doc/ikiwiki/directive/aggregate.mdwn diff --git a/doc/ikiwiki/directive/aggregate.mdwn b/doc/ikiwiki/directive/aggregate.mdwn index f132c9746..ddfcd40b7 100644 --- a/doc/ikiwiki/directive/aggregate.mdwn +++ b/doc/ikiwiki/directive/aggregate.mdwn @@ -1,7 +1,6 @@ -The `aggregate` directive is supplied by the [[!iki plugins/aggregate]] plugin. - -This plugin requires extra setup, specifically, a cron job. -See the plugin documentation for details. +The `aggregate` directive is supplied by the [[!iki plugins/aggregate desc=aggregate]] plugin. +This plugin requires extra setup, specifically, a cron job. See the +plugin's documentation for details. This directive allows content from other feeds to be aggregated into the wiki. Aggregate a feed as follows: @@ -15,11 +14,16 @@ more frequently than once every 15 minutes (though possibly less frequently, if the cron job runs less frequently than that), and puts a page per post under the example/ directory in the wiki. -You can then use ikiwiki's [[ikiwiki/blog]] support to create a blog of one or +You can then use ikiwiki's [[inline]] directive to create a blog of one or more aggregated feeds. For example: \[[!inline pages="internal(example/*)"]] +Note the use of `internal()` in the [[ikiwiki/PageSpec]] to match +aggregated pages. By default, aggregated pages are internal pages, +which prevents them from showing up directly in the wiki, and so this +special [[PageSpec]] is needed to match them. + ## usage Here are descriptions of all the supported parameters to the `aggregate`