blob: e8c1d8e10eb6cb135b1e0ee9462ff46b8091e115 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
The `aggregate` directive is supplied by the [[!iki plugins/aggregate]] plugin.
This directive allows content from other feeds to be aggregated into the wiki.
Aggregate a feed as follows:
\[[!aggregate name="example blog" dir="example"
feedurl="http://example.com/index.rss"
url="http://example.com/" updateinterval="15"]]
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.
You can then use ikiwiki's [[ikiwiki/blog]] support to create a blog of one or
more aggregated feeds. For example:
\[[!inline pages="internal(example/*)"]]
## usage
Here are descriptions of all the supported parameters to the `aggregate`
directive:
* `name` - A name for the feed. Each feed must have a unique name.
Required.
* `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. 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 `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 feed if they are older than
a specified number of days. Default is to never expire on age.
* `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 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.
* `template` - Template to use for creating the aggregated pages. Defaults to
aggregatepost.
Note that even if you are using subversion or another revision control
system, pages created by aggregation will *not* be checked into revision
control.
|