GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  DANCER::PLUGIN::FEED (3)

.ds Aq ’

NAME

Dancer::Plugin::Feed - Easy to generate feed rss or atom for Dancer applications.

CONTENTS

VERSION

version 1.131470

SYNOPSIS



    use Dancer;
    use Dancer::Plugin::Feed;
    use Try::Tiny;

    get /feed/:format => sub {
        my $feed;
        try {
            $feed = create_feed(
                format  => params->{format},
                title   => my great feed,
                entries => [ map { title => "entry $_" }, 1 .. 10 ],
            );
        }
        catch {
            my ( $exception ) = @_;

            if ( $exception->does(FeedInvalidFormat) ) {
                return $exception->message;
            }
            elsif ( $exception->does(FeedNoFormat) ) {
                return $exception->message;
            }
            else {
                $exception->rethrow;
            }
        };

        return $feed;
    };

    dance;



DESCRIPTION

Provides an easy way to generate RSS or Atom feed. This module relies on XML::Feed. Please, consult the documentation of XML::Feed and XML::Feed::Entry.

CONFIGURATION



 plugins:
   Feed:
     title: my great feed
     format: Atom



FUNCTIONS

    create_feed

This function returns a XML feed. All parameters can be define in the configuration

AcceptEd parameters are:
format (required) The <B>Content-TypeB> header will be set to the appropriate value
entries An arrayref containing a list of entries. Each item will be transformed to an XML::Feed::Entry object. Each entry is an hashref. Some common attributes for these hashrefs are title, link, summary, content, author, issued and modified. Check XML::Feed::Entry for more details.
title
base
link
tagline
description
author
language
copyright
self_link
modified

    create_atom_feed

This method call <B>create_feedB> by setting the format to Atom.

    create_rss_feed

This method call <B>create_feedB> by setting the format to RSS.

Exception

FeedNoFormat
FeedInvalidFormat

CONTRIBUTING

This module is developed on Github at:

<http://github.com/hobbestigrou/Dancer-Plugin-Feed>

Feel free to fork the repo and submit pull requests

ACKNOWLEDGEMENTS

Alexis Sukrieh and Franck Cuny

BUGS

Please report any bugs or feature requests in github.

SUPPORT

You can find documentation for this module with the perldoc command.



    perldoc Dancer::Plugin::Feed



SEE ALSO

Dancer XML::Feed XML::Feed::Entry

AUTHOR

Natal Nge\k:'\h |\n:utal

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Natal Nge\k:'\h |\n:utal.

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 DANCER::PLUGIN::FEED (3) 2013-05-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.