RSS Macro
Last modified by Admin on 2024/07/05 17:47
 | Displays the contents of a RSS feed |
| Type | JAR |
| Category | Macro |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Compatibility | Removed from XWiki Standard in 15.6 (moved as a contrib extension and released as 15.5). |
Table of contents
Description
Usage
{{rss feed="<feed>" /}}
Parameters definition
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| feed | no | URL | none | The RSS feed's URL |
| content | yes | "true" or "false" | "false" | If "true" displays the feed contents in addition to the feed item link |
| count | yes | an integer | undefined (i.e. all items) | The number of feed items to display |
| css | yes | "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 |
| image | yes | "true" or "false" | "false" | If "true" and if the feed has an image, display it |
| width | yes | a string | 30% | The width, in px or %, of the box containing the RSS output |
| decoration | yes | "true" or "false" | "true" | If "true" displays UI decorations around feed and feed entries (RSS feed icon, feed items in boxes) |
| encoding | yes | a string | Guessed | If 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. |
Simple Example
{{rss feed="http://feeds.feedburner.com/massol" content="true" image="true" count="2" /}}
Result
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):
- rome:rome 1.0
- org.jdom:jdom 1.1.3
- org.xwiki.rendering:xwiki-rendering-macro-box 14.10
- org.xwiki.commons:xwiki-commons-xml 14.10
- org.xwiki.platform:xwiki-platform-bridge 14.10
