doc/plugins/aggregate.mdwn

   1 [[!template id=plugin name=aggregate author="[[Joey]]"]]
   2 [[!tag type/useful]]
   3
   4 This plugin allows content from other feeds to be aggregated into the
   5 wiki. To specify feeds to aggregate, use the
   6 [[ikiwiki/directive/aggregate]] [[ikiwiki/directive]].
   7
   8 The [[meta]] and [[tag]] plugins are also recommended. Either the
   9 [[htmltidy]] or [[htmlbalance]] plugin is suggested, since feeds can easily
  10 contain html problems, some of which these plugins can fix.
  11
  12 You will need to run ikiwiki periodically from a cron job, passing it the
  13 --aggregate parameter, to make it check for new posts. Here's an example
  14 crontab entry:
  15
  16         */15 * * * * ikiwiki --setup my.wiki --aggregate --refresh
  17
  18 Alternatively, you can allow `ikiwiki.cgi` to trigger the aggregation. You
  19 should only need this if for some reason you cannot use cron, and instead
  20 want to use a service such as [WebCron](http://webcron.org). To enable
  21 this, turn on `aggregate_webtrigger` in your setup file. The url to
  22 visit is `http://whatever/ikiwiki.cgi?do=aggregate_webtrigger`. Anyone
  23 can visit the url to trigger an aggregation run, but it will only check
  24 each feed if its `updateinterval` has passed.
  25
  26 ## aggregated pages
  27
  28 This plugin creates a page for each aggregated item.
  29
  30 If the `aggregateinternal` option is enabled in the setup file (which is
  31 the default), aggregated pages are stored in the source directory with a
  32 "._aggregated" extension. These pages cannot be edited by web users, and
  33 do not generate first-class wiki pages. They can still be inlined into a
  34 blog, but you have to use `internal` in [[PageSpecs|IkiWiki/PageSpec]],
  35 like `internal(blog/*)`.
  36
  37 If `aggregateinternal` is disabled, you will need to enable the [[html]]
  38 plugin as well as aggregate itself, since feed entries will be stored as
  39 HTML, and as first-class wiki pages -- each one generates
  40 a separate HTML page in the output, and they can even be edited. This
  41 option is provided only for backwards compatability.