WordPress.org

Usage

First of all, you need to set up a preset in the options page. Each preset has:

• Name: a unique name for referencing the feed from your php or posts
• URL: where to fetch the feed from
• Options: optional arguments to affect output
• XSLT parameters: optional parameters to feed to any XSL transformations.

The most obvious application of this is to pull in a news feed and transform it nicely for placing on your site.

You can access the functionality via two methods, either by calling the DGE_InlineRSS method directly, or by using the inline filter method.

Filter method

This is the simplest method, and can be called from anywhere in a post or page without editing any PHP.

Just write !inlineRSS: followed by a preset name. So for example if you'd set one up for the latest BBC news with a name of 'bbcnews', you'd write this anywhere in your post:

!inlineRSS:bbcnews

Direct method

Still keeping it simple, you can call the DGE_InlineRSS function directly from your theme templates, just echoing the result:

echo DGE_InlineRSS('uniquename');

However, it can get quite complicated if you want to. You can call it from plugin code, supplying all the details without ever actually setting up a preset.

$xml = DGE_InlineRSS('davesplugin', $url,
                     // InlineRSS options in the first array
                     array('timeout'=>0,
                           'xslt'=>'davesplugin.xsl'),
                     // Your own options for the XSLT parameters
                     array('limit'=>10));

Options

timeout=<value>

• The time in minutes to cache the results for

xslt=<filename>

• An xsl file to use for translating the feed

xml=<string>

• Pass in the xml you want translated, bypassing the url.

html (on it's own)

• Tells the xslt processor to treat the input as html, rather than xml.

History

This is a fork, and subsequent development, of the Cal Demaine's inlineRSS plugin (v1.1). Cal put a lot of work into his plugin, and I'm very grateful for those foundations. However, I've decided to fork from v1.1 to meet my own needs. So far, I added some handy features and bug fixes. Cal, if you're listening/watching, feel free to incorporate any of this into your plugin.

Details of the initial changes, plus historical necessity for them are here.

Full changelog here

0.9

• Options panel in wordpress admin area
• Config file replaced by 'presets' in options page
• Configurable cache dir, cache file prefix, and xslt dir.
• Simplified php call down to an id, url, array of options, array of xslt params.
• Unix-like path searching for xslt files.

0.1

All original inlineRSS features, plus:

• Allows passing of parameters into XSL template.
• PHP 5 fixes.

Related plugins

• DGE_SlideShow uses this plugin to fetch photo streams from Zooomr or Flickr.

Copyright

Copyright (C) 2005 Cal Demaine (original work)

Copyright (C) 2006 Dave Elcock (further developments)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

The GNU General Public License is available here: http://www.gnu.org/copyleft/gpl.html