RSS Macro

Last modified by Admin on 2023/09/20 01:02

cogDisplays the contents of a RSS feed
TypeJAR
CategoryMacro
Developed by

Vincent Massol, XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Removed from XWiki Standard in 15.6 (moved as a contrib extension and released as 15.5).

Installable with the Extension Manager

Description

Usage

{{rss feed="<feed>" /}}

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
feednoURLnoneThe RSS feed's URL
contentyes"true" or "false""false"If "true" displays the feed contents in addition to the feed item link
countyesan integerundefined (i.e. all items)The number of feed items to display
cssyes"true" or "false""false"If "true" then adds class id elements (rssitem, rssitemtitle, rssitemdescription, rsschanneltitle, etc) which you can style by modifying your skin's CSS file
imageyes"true" or "false""false"If "true" and if the feed has an image, display it
widthyesa string30%The width, in px or %, of the box containing the RSS output
decorationyes"true" or "false""true"If "true" displays UI decorations around feed and feed entries (RSS feed icon, feed items in boxes)  Since XWiki 3.2
encodingyesa stringGuessedIf specified, then this encoding will be used to read the RSS feed's XML. Otherwise the encoding is guessed from a variety of places (XML header, BOM, XML Prolog, etc). To be used for cases when the guessed encoding is not correct. Since XWiki 9.6

Support for SSL (https) has been added in 8.1M2.

Simple Example

{{rss feed="http://feeds.feedburner.com/massol" content="true" image="true" count="2" /}}

Result

rssexample.png

Example with images

{{rss feed="http://api.flickr.com/services/feeds/photos_public.gne?format=rss_200&tags=xwiki" image="true" content="true" width="90%" count="3"/}}

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Dependencies

Dependencies for this extension (org.xwiki.contrib:rss-display 15.6):

Get Connected