Confluence 4.0 : RSS Feed Macro
This page last changed on Sep 08, 2011 by pwatson.
The RSS feed macro embeds an RSS feed on a page. It can display the contents of external feeds, or of internal feeds generated by Confluence. To display blog posts or to list recently updated pages in a space, use the Feed Builder to create an internal feed, then render it using this macro.
The RSS macro will only be available if it has been enabled by your Confluence administrator. Also, your Confluence Administrator can define a whitelist of trusted URLs. You will see an error message on the Confluence page, if the included URL is not in the whitelist. On this page:
Usage with the Macro BrowserTo insert the RSS feed macro into a page using the Macro Browser,
Once you've found the RSS feed macro and have added the required parameter values, click 'insert' to add it to your page. Usage with the Wiki Markup EditorUse the Wiki Markup editor to edit the page and insert the RSS macro. Replace the ' http://www.example.com/rss/' URL with your own feed link in this example: {rss:url=http://www.example.com/rss/} Parameters
When editing, you can click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser. Parameters are options that you can set for Confluence macros to control the content or format of the macro output. The table below lists parameters for this macro that can be set in the Macro Browser.
Examples1. Limit the number of entries displayed{rss:url=http://host.com/rss.xml|max=5} 2. Show only the RSS feed titles{rss:url=http://host.com/rss.xml|showTitlesOnly=true} 3. Hide the feeds titlebar{rss:url=http://host.com/rss.xml|titleBar=false} Working ExampleWhat you need to type: {rss:url=http://www.abc.net.au/news/feed/51120/rss.xml|max=5|showTitlesOnly=true} What you will get: Error rendering macro 'rss' : null How Up to Date is the Feed?By default, the RSS Feed macro caches the feed results for 60 minutes before fetching the data again. If you wish to change the default caching, use the {cache} macro to define how often the RSS Feed macro fetches the feed updates. You may want to set the cache to a longer period, so that your page loads faster. Or you may want to retrieve feed results more often, if you need to see the updates sooner. You will need to install the Cache plugin page onto your Confluence site. To enable caching:
What Happens to a Page Containing a Disallowed URL?Your Confluence Administrator can set up a whitelist of allowed URLs. If this is the case, you may see an error on the pages which contain the RSS macro.
A user can add the RSS macro or the HTML-include macro to a Confluence page. The macro code includes a URL from which the content is drawn. When the page is displayed, Confluence will check the URL against the whitelist. If the URL is not allowed, Confluence will display an error message on the page. The error message says that Confluence "could not access the content at the URL because it is not from an allowed source" and displays the offending URL. If the person viewing the page is a Confluence Administrator, they will also see a link to the Administration page where they can configure the URL whitelist. Here is an example of the error message, including the link shown only to Confluence Administrators: Here is an example of the error message, but without the link. AuthenticationPrivate Feeds from External SitesRSS feeds which require authentication cannot be accessed using the RSS Macro. Accessing Internal HTTPS FeedsThis applies only to Confluence instances which have enabled HTTPS for all content. If your site is fully HTTPS, the RSS macro cannot access internal feeds. To enable the RSS macro to access internal feeds without affecting your HTTPS setup, enable local-only HTTP access:
Related TopicsSubscribing to RSS Feeds within Confluence Return to the Confluence User's Guide. |
![]() |
Document generated by Confluence on Sep 19, 2011 02:36 |