Collapsible Rss Macro

Name Collapsible Rss Plugin
Vendor Atlassian Software Systems (Website)
Authors Shannon Krebs
Homepage http://confluence.atlassian.com/display/CONFEXT/Collapsible+Rss+Macro
Issue Management http://developer.atlassian.com/jira/browse/CRSS
Continuous Integration n/a
Categories Macros
Most Recent Version 0.8
Availability Confluence v2.5 to v2.10
State Stable
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Collapsible+Rss+Macro
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/collapsiblerss-plugin/tags/0.8/
Download JAR collapsibleRssPlugin-0.8.jar

The collapsible rss macro allows you to insert an rss feed into a page (just like the normal rss macro) that each user can selectively hide until there is a new feed item to display.

This macro was originally developed to be able to display a small number of rss feed news items on the Confluence dashboard, however it can be used within any page.

Usage

This {collapsiblerss} macro will display an rss feed within the page. Each user can click on the close button to hide the display until there is something new to display.

  • url The url of the feed to display (this must be retrievable from the server that Confluence is running on.)
  • maxItems (Optional) The maximum number of items to display
  • showTitlesOnly (Optional) if true only the title of each feed entry will be displayed.
  • hideRssErrors (Optional) if true any errors encountered while downloading or parsing the feed will be ignored and the macro will return an empty string. Default is false and any errors encountered will be displayed.

Custom Rss Feed Action

The normal html formatting of Confluence rss feeds is too verbose for the original use case this plugin was designed for (displaying news items on the dashboard). Therefore an additional action has been created in this plugin to customise the format of Confluence rss feeds. (If there is enough demand/interest it could be split into its own plugin, but for now it lives here...)

Usage

Create you Confluence rss feed as you normally would using the feedbuilder. (Note the custom render currently only supports Page content (normal pages and blog posts), other content won't be rendered).

In the url for your feed replace the normal createrssfeed action with the one defined in this plugin.
ie.
Your nomal feed like this:
http://<confluencehost>/createrssfeed.action?types=page&types=blogpost.....
Will become this:
http://<confluencehost>/plugins/customrss/customcreaterssfeed.action?types=page&types=blogpost.....

As the custom rss action extends the original create rss action within Confluence it should take all the same parameters that the normal action takes.

Labels

rss rss Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Feb 24, 2008

    Damian Fawkner says:

    Very handy macro. One thing though - like the rss macro, it doesn't handle feed...

    Very handy macro. One thing though - like the rss macro, it doesn't handle feeds from https sources. Any chance of building this in?

    1. Feb 24, 2008

      Shannon Krebs - Adaptavist says:

      The plugin extends the BaseHttpRetrievalMacro in Confluence to get the feed, if ...

      The plugin extends the BaseHttpRetrievalMacro in Confluence to get the feed, if there is a problem with https I think it should probably be fixed there :-\

      What is the error your seeing with https, is there a Jira issue for the normal rss plugin and https?

      1. Feb 24, 2008

        David Peterson [CustomWare] says:

        My bet is that it's a problem with an SSL certificate which is not verifiable. I...

        My bet is that it's a problem with an SSL certificate which is not verifiable. I seem to recall that there were some issues with connecting to servers with such certificates, but I don't know the solution.

        1. Jun 28

          Andy Brook says:

          My 2p, Ive had several certs, even verisign certs, that are signed by an intermi...

          My 2p, Ive had several certs, even verisign certs, that are signed by an intermiediary CA certificate for whatever reason. You have to import the signer CA into your JRE_HOME/lib/security/cacerts file using keytool.

          SSL works fine, if and only if Java can verify the chain of trust of the target servers cert.

  2. Feb 26, 2008

    Eric Bardoux says:

    Hi, I would like to use this macro for rss feeds coming from confluence. Unfor...

    Hi,

    I would like to use this macro for rss feeds coming from confluence.

    Unfortunately, just like the basic rss macro, it does not work... When i try to use a url from confluence, because the feed needs authentication, it does not work. Any idea?

    Eric

    1. Feb 26, 2008

      Shannon Krebs - Adaptavist says:

      In the feed builder there is an option to specify anonymous feeds so authenticat...

      In the feed builder there is an option to specify anonymous feeds so authentication is not required, this obviously means you won't get any protected content though.

      1. Feb 26, 2008

        Eric Bardoux says:

        Well, my issue is that i am in an enterprise context, and anonymous access is no...

        Well, my issue is that i am in an enterprise context, and anonymous access is not allowed in the admin interface, so i don't have this option...

  3. Feb 26, 2008

    Guy Fraser says:

    Does this macro use cookies or store it's user-level settings on the user object...

    Does this macro use cookies or store it's user-level settings on the user object/profile? If cookies, I imagine it would suffer the same fate as deck/card macros whereby you could end up with too many cookies and thus truncation of them?

    1. Feb 26, 2008

      Shannon Krebs - Adaptavist says:

      the last read date value is stored in the user profile for each rss feed url, th...

      the last read date value is stored in the user profile for each rss feed url, therefore this macro doesn't work for anonymous users.

  4. May 19, 2008

    Tomi Strugar says:

    I got the macro working but when I clicked the X in the right-hand corner the fe...

    I got the macro working but when I clicked the X in the right-hand corner the feed disappeared. Now there is no way I can see to make it reappear. What can I do?

    Also, an example of the syntax of the macro,or at least a link back to the std rss macro doc page that has these, might be helpful to wiki newbies.

    1. May 19, 2008

      Shannon Krebs - Adaptavist says:

      I got the macro working but when I clicked the X in the right-hand corner the f...

      I got the macro working but when I clicked the X in the right-hand corner the feed disappeared. Now there is no way I can see to make it reappear. What can I do?

      When a new item is posted to that rss feed the macro should reappear with the new item only.

  5. Jun 28

    Andy Brook says:

    I just installed this, using a BBC newsfeed, and it does what it says on the tin...

    I just installed this, using a BBC newsfeed, and it does what it says on the tin, however, I dont get the X. The nature of Confluence pages are that they get viewed time and again, I thought clicking X might make the current values 'go away' , but persist through page refreshes. If a user has clicked X once already, it will become very tedious very quickly, if they ahve to do this every time they go to pages with this in. Just my 2p