../../../../inc/ie-header.html

inlineRSS Plugin

AuthorCal Demaine, Jan Wessely
Version0.0.1
Required DokuWiki Versiondevel
Downloadinlinerss-0.0.1.zip
Main PageinlineRSS Plugin at jawe.net

Description

A DokuWiki plugin to pull an RSS feed and return an HTML-formatted string

Syntax

:!: Note: I will change the syntax to the more common form of {{inlineRSS>feedname}} in the next release

!inlineRSS:feedname

Configuration

Open lib/plugins/inlinerss/inlineRSS.conf with a text editor.

This file contains one line per different feed entry, containing the following comma-separated parameters:

  • casualname: What you will call your feed, such as “myfeed”
  • url: The complete path, including http:// to the feed
  • cache time: The minimum number of minutes between fetching the feed. This is optional and defaults to 30
  • xslt file: The alternate xslt file to use, instead of inlineRSS.xslt. This is optional and defaults to inlineRSS.xslt. Additionally, you can use the following keywords in place of an xslt file:
    • skipxslt - This will pull the file in without attempting to translate it, so any source can be inserted.
    • eval - This will evaluate the file as a PHP script, and use whatever is returned using “return” as what is to be inserted. It does not support <?php ?> - those are HTML exclusion tags used by the web server.

A sample feed to read from www.iconophobia.com is below. It can be called from:

A DokuWiki page using:

!inlineRSS:iconophobia

or from a template (.php) in one of the two ways:

tpl_inlineRSS('iconophobia');
tpl_inlineRSS('iconophobia', 'http://www.iconophobia.com/wordpress/?feed=rss2,30', 'inlineRSS.xslt');

In the second method, the last two parameters are optional, and this file is not scanned at all. Not even one character. It's primarily oriented towards automating or building other plugins.

Source code

TODO publish here

You can obtain the latest version of the source code using SVN from http://inlinerss-plugin.googlecode.com/svn/trunk/

Demo