This plugin can be used to read a RSS feed (via the Google Feed API) and transform it into a custom piece of HTML.
<!DOCTYPE html>
<html>
<head>
<title>jquery.rss example</title>
<script src="lib/jquery-1.6.4.min.js"></script>
<script src="src/jquery.rss.js"></script>
<script>
jQuery(function($) {
$("#rss-feeds").rss("http://feeds.feedburner.com/premiumpixels")
})
</script>
</head>
<body>
<div id="rss-feeds"></div>
</body>
</html>
$("#rss-feeds").rss(
"http://feeds.feedburner.com/premiumpixels",
{
// how many entries do you want?
// default: 4
limit: 10,
// will request the API via https
// default: false
ssl: true,
// outer template for the html transformation
// default: "<ul>{entries}</ul>"
layoutTemplate: '<div class='feed-container'>{entries}</div>',
// inner template for each entry
// default: '<li><a href="{url}">[{author}@{date}] {title}</a><br/>{shortBodyPlain}</li>'
entryTemplate: '<p>{title}</p>',
// additional token definition for in-template-usage
// default: {}
tokens: {
foo: 'bar',
bar: function(entry, tokens) { return entry.title }
},
// output mode of google feed loader request
// default: 'json'
outputMode: 'json_xml'
},
// User callback function called after feeds are successfully loaded.
function callback() {}
)
As seen in the options, you can specify a template in order to transform the json objects into HTML. The basic format of that template is:
"<outer-html>{entry}<entry-html></entry-html>{/entry}</outer-html>"
Using such a format, you can specify the structure of the entry-wise HTML, as well as the surrounding one. If you specify a template, which has no "entry"-tokens, the templates gets treated as entry-wise template without surrounding stuff.
So, let's say you have specified a limit of 2. Using the upper pseudo html. This will result in the following:
<outer-html>
<entry-html></entry-html>
<entry-html></entry-html>
</outer-html>
In order to get values for each entry, you can do something like this:
"<div class='rss-feeds'><ul>{entry}<li>{title}</li>{/entry}</ul></div>"
The {title} token will get replaced by the actual title. So you will get this:
- Title 1
- Title 2
There are some predefined tokens:
- url: the url to the post
- author: the author of the post
- date: the publishing date
- title: the title of the post
- body: the complete content of the post
- shortBody: the shortened content of the post
- bodyPlain: the complete content of the post without html
- shortBodyPlain: the shortened content of the post without html
- teaserImage: the first image in the post's body
- teaserImageUrl: the url of the first image in the post's body
- index: the index of the current entry
- totalEntries: the total count of the entries
You can also define custom tokens using the tokens option:
$('#foo').rss(url, {
template: "{dynamic}, {static}, {re-use}",
tokens: {
dynamic: function(entry, tokens){ return "dynamic-stuff: " + entry.title },
"re-use": function(entry, tokens){ return encodeURIComponent(tokens.teaserImageUrl) },
static: "static"
}
})
Please make sure to NOT define infinite loops. The following example is really BAD:
$('#foo').rss(url, {
template: "{loop}",
tokens: {
whoops: function(entry, tokens) { return tokens.loop() }
loop: function(entry, tokens) { return tokens.whoops() }
}
})
The plugin also allows you to filter specific entries in order to only print them:
$("#foo").rss(url, {
limit: 100,
filterLimit: 10,
filter: function(entry, tokens) {
return tokens.title.indexOf('my filter') > -1
}
})
This will request 100 entries via the Feed API and renders the first 10 matching entries.
The source is minified via [http://jscompress.com].