This is an old revision of the document!
Table of Contents
Feed Plugin
Compatible with DokuWiki
Hrun
This plugin creates feeds with content from other plugins. To let you show your wiki users they can use the RSS feed, it includes a syntax for displaying an link to your feed with nice RSS-icon.
The feed is cached. The caching respects the general rss update interval time.
Syntax
Print a link to your feed with RSS icon.
{{[component]feed>[namespace]?[option]|[title]}}
[component] | plugin component for which the feed is destined | required |
---|---|---|
[namespace] | the namespace for which you want a discussion thread list;: is the top namespace,. is the same namespace as the page lies in,* the whole wiki | required |
[option] | depends on plugin / component, see supported feeds below | mostly optional |
[title] | Title shown in the RSS-Link on the wiki page | optional |
Supported Feeds
Plugin | Component | Option | |
---|---|---|---|
Blog | blog | Number of blog entries to include in feed (deprecated, see discussion below) | optional; default is $conf['recent'] |
Discussion | comments | Number of comments to include in feed | optional; default is $conf['recent'] |
Discussion | threads | Number of discussion thread pages to include in feed | optional; default is $conf['recent'] |
Editor | editor | User ID, user group or IP address as in Editor Plugin | required |
Tag | topic | Tag as in topic component of Tag Plugin | required |
Task | tasks | View filter as in tasks component of Task Plugin | optional; default is open |
Examples
Including the syntax will print an url to your RSS-feed. This url can be used by visitors in their RSS-reader to follow your feed.
Possible usage of the syntax:
{{blogfeed>blog|Blog Entries}} {{blogfeed>blog?20|Blog Entries}} {{commentsfeed>mynamespace|Individual Comments}} {{commentsfeed>mynamespace?25|Individual Comments}} {{threadsfeed>namespace|Recent discussion threads}} {{threadsfeed>namespace?15|Recent discussion threads}} {{editorfeed>.?user|Pages edited by 'user'}} {{topicfeed>*?cloud|Tagged «Cloud»}} {{tasksfeed>projects|Open tasks}} {{tasksfeed>projects?overdue|Late tasks}}
Bugs / Feature Requests
Please report bugs or feature requests at the Bug tracker.
Changes
- Version upped (2020-11-09 11:39)
- Merge pull request #11 from cosmocode/master (2020-11-01 20:04)
- Hogfather compatibility updates. fixes #10 (2020-10-26 12:15)
- Upped version. (2018-04-27 21:09)
- Compatibility fix for "Greebo" (2018-04-27 21:01)
- Upped version. (2017-08-25 18:59)
- Plugin cleanup: deleted VERSION file. (2016-04-27 19:06)
- Merge pull request #5 from Klap-in/branch (2014-11-16 12:08)
Discussion
As of DokuWiki 2008-04-11 DokuWiki has its own full HTML feed and we recommend to use it instead of this plugin to generate the blog feed. This component will be removed from the plugin a in couple of months from now
— Michael Klier 2008/04/20 21:20
It has not been removed and there are likely no plans to do so. Besides DokuWiki's HTML feed is still lacking in some ways (cf. 2765). — Andreas Schamanek 2013/04/21 11:55
Please don't remove the blogging feed just yet. It works better for blog articles that are nested in many namespaces — Drye Kindrew 2008/11/13 08:00