urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/doc/plugins/aggregate.mdwn

55 lines
2.2 KiB
Plaintext
Raw Normal View History

* ikiwiki can now download and aggregate feeds with its new aggregate plugin, so it's possible to implement a Planet using ikiwiki! * --setup --refresh no longer rebuilds wrappers. Use --setup --refresh --wrappers to do that. * Add %IkiWiki::forcerebuild to provide a way for plugins like aggregate to update pages that haven't changed on disk.
2006-07-30 06:31:08 +02:00
This plugin allows content from other blogs to be aggregated into the wiki.
Aggregate a blog as follows:
fixes, and make dir optional
2006-07-30 07:14:35 +02:00
\[[aggregate name="example blog" feedurl="http://example.com/index.rss" url="http://example.com/" updateinterval="15"]
* ikiwiki can now download and aggregate feeds with its new aggregate plugin, so it's possible to implement a Planet using ikiwiki! * --setup --refresh no longer rebuilds wrappers. Use --setup --refresh --wrappers to do that. * Add %IkiWiki::forcerebuild to provide a way for plugins like aggregate to update pages that haven't changed on disk.
2006-07-30 06:31:08 +02:00
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
the example/ directory in the wiki.
You can then use ikiwiki's [[blog]] support to create a blog of one or more
aggregated feeds.
## setup
Make sure that you have the [[html]] plugin enabled, as the created pages are
* Change meta tags to use html entity-escaped text for values, so that quotes and such can be represented in title tags. * Depend and build-depend on HTML::Parser for HTML::Entities which is used for the above. * Make --rebuild also cause --aggregate to re-download and write aggregated pages. * Avoid outputting duplicate meta info. * Include title metadata on aggregated posts for capitalised and un-munged titles.
2006-07-31 00:58:48 +02:00
in html format. The [[meta]] and [[tag]] plugins are also recommended.
* ikiwiki can now download and aggregate feeds with its new aggregate plugin, so it's possible to implement a Planet using ikiwiki! * --setup --refresh no longer rebuilds wrappers. Use --setup --refresh --wrappers to do that. * Add %IkiWiki::forcerebuild to provide a way for plugins like aggregate to update pages that haven't changed on disk.
2006-07-30 06:31:08 +02:00
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
crontab entry:
*/15 * * * * ikiwiki --setup my.wiki --aggregate --refresh
## 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 blog that's being aggregated.
Required.
fixes, and make dir optional
2006-07-30 07:14:35 +02:00
* `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.
* ikiwiki can now download and aggregate feeds with its new aggregate plugin, so it's possible to implement a Planet using ikiwiki! * --setup --refresh no longer rebuilds wrappers. Use --setup --refresh --wrappers to do that. * Add %IkiWiki::forcerebuild to provide a way for plugins like aggregate to update pages that haven't changed on disk.
2006-07-30 06:31:08 +02:00
* `feedurl` - The url to the feed. Optional, if it's not specified ikiwiki
fix
2006-07-30 08:15:04 +02:00
will look for feeds on the `url`. RSS and atom feeds are supported.
* ikiwiki can now download and aggregate feeds with its new aggregate plugin, so it's possible to implement a Planet using ikiwiki! * --setup --refresh no longer rebuilds wrappers. Use --setup --refresh --wrappers to do that. * Add %IkiWiki::forcerebuild to provide a way for plugins like aggregate to update pages that haven't changed on disk.
2006-07-30 06:31:08 +02:00
* `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
a specified number of days. Default is to never expire on age.
* `expirecount` - Expire old items from this blog 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
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]]