Dominic Hargreaves > Wiki-Toolkit-Plugin-RSS-Reader-1.6 > Wiki::Toolkit::Plugin::RSS::Reader

Download:
Wiki-Toolkit-Plugin-RSS-Reader-1.6.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.6   Source  

NAME ^

Wiki::Toolkit::Plugin::RSS::Reader - retrieve RSS feeds for inclusion in Wiki::Toolkit nodes

DESCRIPTION ^

Use this Wiki::Toolkit plugin to retrieve an RSS feed from a given URL so that you can include it in a wiki node.

SYNOPSIS ^

    use Wiki::Toolkit::Plugin::RSS::Reader;

    my $rss = Wiki::Toolkit::Plugin::RSS::Reader->new(
      url   => 'http://example.com/feed.rss'
    );

    my @items = $rss->retrieve;

USAGE ^

This is a plugin for Wiki::Toolkit, a toolkit for building wikis; therefore please consult the documentation for Wiki::Toolkit for relevant information. This module can, however, be used standalone if you wish.

METHODS ^

new

    my $rss = Wiki::Toolkit::Plugin::RSS::Reader->new([options]);

Create a new RSS reader. Valid options are url or file (a path to an RSS file); only one can be specified.

retrieve

    my @items = $rss->retrieve;

retrieve will return an array of hashes, one for each item in the RSS feed. The hashes contain three items, title, link, and description.

If the URL or file you specified cannot be retrieved/read, retrieve will return undef rather than blowing up and surprising the person reading your wiki. If you want, you can specify debug to be 1 in the options to new, which will cause the module to croak instead of failing silently.

AUTHOR ^

Earle Martin (EMARTIN@cpan.org) The Wiki::Toolkit team, (http://www.wiki-toolkit.org/)

LEGAL ^

Copyright 2004 Earle Martin. Copyright 2006 the Wiki::Toolkit team.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: