Skip to content

malderete/jRss

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

    _ _____          
   (_)  __ \         
    _| |__) |___ ___ 
   | |  _  // __/ __|
   | | | \ \\__ \__ \
   | |_|  \_\___/___/
  _/ |               
 |__/       for jQuery         

                              

jRss README
==============

Author
=======

Martin N. Alderete ( malderete<at>gmail<dot>com )


Overview
========

Welcome to jRss a jQuery plugin.
It's a parser for Rss feeds, based on the specification version 2.0.
jRss has been implemented focused on jFeed by Jean-François Hovinne.


Dependencies
============

Now you know that jRss is a jQuery plugin, so you need jQuery to use jRss.
jRss was developed with jQuery version 1.3.2, I guess jRss could be used with new releases of jQuery.


Description
===========

$.jRss(settings)
    Main function to get the rss feed:

    *Settings
        url: The Url to get the rss feed.
        data: Data to the resource.
        no_standard_fields: Array of strings with names of every "NO STANDARD
            FIELDS" (this means fields not in RSS 2.0 specification)
        success(feed): 
            Callback function with the jRss object.

jRss object description:
    this.channel --> JChannel
    this.items --> [jRssItem, ...]

jChannel object description:
    All attributes in rss 2.0 version

JRssItem object description:
    All attributes in rss 2.0 version



Example
=======

See test.html

...
...
success: function(rss) {
    //Get the rss channel
    var channel = rss.channel;
    // Get the rss items
    var items = rss.items;
    //your render code HERE !!!
}

#EOF

About

jQuery Plugin to parse RSS (specification 2.0), it's based on jFeed.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published