This server will be upgraded at 3pm Sydney time on December 3rd (December 2nd, 8pm PST) and will be down for up to 30 minutes.

OPML Plugin

Added by David Peterson [CustomWare], last edited by James Mortimer on Nov 19, 2006  (view change) show comment
Name OPML Plugin
Vendor ARC Centre of Excellence for Creative Industries & Innovation (Website)
Authors David Peterson
Homepage http://confluence.atlassian.com/display/CONFEXT/OPML+Plugin
Issue Management http://developer.atlassian.com/jira/browse/OPML
Continuous Integration n/a
Categories Content Macros
Most Recent Version 1.2.1
Availability Confluence v2.3 to v2.10
State Stable
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/OPML+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/confluence/opml-plugin/tags/1.2.1/
Download JAR opml-plugin-1.2.1.jar
This plugin is now accessable through the Confluence Repository Client.

Description

This plugin displays an OPML file in Confluence. Extra data can be listed in customisable columns and subsections are expandable on demand.

Downloading & Installing

Confluence 2.2.1a+

Option 1

The recommended way of installing is to use the Confluence Repository Client. This will not only make it easier to install, but it will help keep you up to date with this and other plugins.

  1. Open the repository client screen.
  2. Select 'Install' for the OPML Plugin entry.

Option 2

Alternately, you can install it manually:

  1. Download opml-plugin-1.1.jar
  2. Upload it using Confluence's administration console.

Screenshots

An example of an OPML file in action.
OPML file showing the first level expanded
A typical OMPL file displayed with multiple columns and the outlines collapsed
Unicode problems with OPML plugin

Macros

{opml:source=^attachment.opml}

Details: Displays an OPML file.
Parameters:

Name Required Description
source The location of the OPML file. May be an attachment (^attachment.opml) or a URL (http://server/file.opml).
width Sets the width of the displayed table. Eg. '100%', '400px'.
class An additional CSS class to apply to the generated table.
showTitle If 'true', display the title listed in the OPML file. Defaults to 'false'.
iconType Specifies the type of icon to display, either 'image' (the default), 'wiki', or 'text'.
expandIcon The icon to display when the section can be expanded.
collapseIcon The icon to display when the section can be collapsed.
singleIcon The icon to display when the section has no subsections.

{opml-column:name=attribute}

Details: Configures a column to display based on <outline> attributes.
Parameters:

Name Required Description
name The name of the attribute to display in the column.
title The title to display for the column. If not specified, the name is used. This may be wiki text, and alternately the macro body may specify the title if the wiki markup is too complex for a macro parameter.
type The type of data in the column. This allows for customised formatting of the data. This may be one of the following:
  • text - (default) Plain text.
  • html - HTML text.
  • number - A number. The columns may only contain digits. Eg. '9.5' is good, '$9.50' is bad.
  • date - A date. You will probably need to specify the sourceFormat, as described below.
  • url - A linkable URL. A hyperlink will be generated for the column.
sourceFormat Only used if type is 'date'. Allows you to specify how the date is described in the OPML file. Eg. 'dd-MM-yyyy' will understand '01-Jan-1970'.
displayFormat Only used if type is 'number' or 'date'. Allows you to specify how the value is displayed.
  • number - A combination of '#' (optional digit), '0' (required digit) and other standar characters. Eg. '$#0.00' will display '9.5' as '$9.50'. See here for details.
  • date - A combination of various characters to describe the date. Eg. 'MMM dd, yyyy' will display the date as '01 Jan, 1970'. See here for more details.
width The width of the column. Eg. '50%', '200px'.

Examples

  1. Attach an OPML file to your page. You can get one to try it out here.
  2. Add something like this to your page: 
    {opml:source=^playlist.opml|width=100%}
{opml-column:name=text|title=Song Title}
{opml-column:name=f|title=Filename}
{opml-column:name=duration|title=Duration|type=number|displayFormat=#0 sec}
{opml-column:name=lastPlayed|title=Last Played|type=date|sourceFormat=dd-MMM-yyy, HH:mm:ss|displayFormat=MMM dd, yyyy @ hh:mm a}
{opml}
  3. View your page. You should get something that looks like this:

Open Issues

Release History

Version Date State License Price
Show description 1.2.1 (#3) 12 Apr 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues
Type Key Priority Summary Updated Reporter Status
Bug OPML-4 Major Confluence 2.3 compatibility Apr 11, 2007 David Peterson Closed

Contributors

  • David Peterson — Developer

Show description 1.1 (#2) 20 Nov 2006 Stable Freeware / Open Source (BSD) Free

Release Notes

Jira Issues
Type Key Priority Summary Updated Reporter Status
Bug OPML-3 Major URL typed columns are escaped incorrectly Nov 19, 2006 David Peterson Closed
New Feature OPML-1 Major Add some way to 'expand all' Nov 19, 2006 David Peterson Closed

Contributors

  • David Peterson — Developer

Show description 1.0 (#1) 14 Sep 2006 Stable Freeware / Open Source (BSD) Free

Release Notes

  • Initial version.

Contributors

  • David Peterson — Developer

Labels

plugin plugin Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (6)

 

  1. Sep 28, 2006

    Frankenstein says:

    looks likeexactly what I need. But wouldn't you know it? I get this error: stdo...

    looks likeexactly what I need. But wouldn't you know it? I get this error:

    stdout.log:Caused by: java.lang.ClassNotFoundException: au.edu.cci.confluence.opml.OpmlMacro [java.lang.ClassNotFoundException: au.edu.cci.confluence.opml.OpmlMacro [java.lang.NoClassDefFoundError: org/randombits/confluence/support/ConfluenceMacro]]
    stdout.log:2006-09-27 20:22:24,147 ERROR [atlassian.plugin.loaders.AbstractXmlPluginLoader] configurePlugin There were errors loading the plugin 'OPML Plugin'. The plugin has been disabled.
    stdout.log:2006-09-27 22:59:45,320 ERROR [atlassian.plugin.loaders.AbstractXmlPluginLoader] createModuleDescriptor There was a problem loading the descriptor for module 'macro' in plugin 'OPML Plugin'
    stdout.log:com.atlassian.plugin.PluginParseException: Error retrieving dependency of class: au.edu.cci.confluence.opml.OpmlMacro. Missing class: org/randombits/confluence/support/ConfluenceMacro
    stdout.log:2006-09-27 22:59:45,323 ERROR [atlassian.plugin.loaders.AbstractXmlPluginLoader] configurePlugin There were errors loading the plugin 'OPML Plugin'. The plugin has been disabled.

    I am using Confluence 2.2.6a running Resin 2. I don't see the macro in the Plugin Repository so I downloaded the jar to my desktop and manually tried to install it via 'browse' - select jar file and upload from the Plugins page.

    Any help would be appreciated.

    Thanks

    -J

    1. Sep 28, 2006

      David Peterson [CustomWare] says:

      Hmm...very odd behaviour. I'm not sure why it wouldn't be showing up in the repo...

      Hmm...very odd behaviour. I'm not sure why it wouldn't be showing up in the repository in the first place, but it should definitely be uploadable.

      One possibility is that the jar file you have downloaded is corrupted. Internet Explorer has a bad habbit of renaming 'jar' files to be 'zip' files when downloading from the Atlassian SVN repository. When that happens, unpredictable stuff happens. If you're using IE, could you try downloading by right-clicking and selecting 'Save As', and manually enter 'opml-plugin-1.0.jar' as the file name. Then try uploading it.

      Let me know if this helps...

  2. Mar 17, 2007

    Yann Doussot says:

    Does the plugin really works with Confluence 2.4.2 as stated ? I've juste update...

    Does the plugin really works with Confluence 2.4.2 as stated ? I've juste update our installation to 2.4.2 and it breaks:

    2007-03-17 12:38:35,065 ERROR [http-8081-Processor19] [renderer.v2.components.MacroRendererComponent] processMacro Unexpected error formatting macro: opml
    - url: /confluence/display/RB/Mes+blogs | userName: doussot | action: viewpage | page: 5201 java.lang.NoClassDefFoundError: bucket/core/EntityObject
    at au.edu.cci.confluence.opml.OpmlMacro.getIOSource(OpmlMacro.java:430)
    at au.edu.cci.confluence.opml.OpmlMacro.execute(OpmlMacro.java:170)
    at org.randombits.confluence.support.ConfluenceMacro.execute(ConfluenceMacro.java:55)
    at com.atlassian.renderer.v2.macro.ResourceAwareMacroDecorator.execute(ResourceAwareMacroDecorator.java:45)

    Any idea ? Thanks. 

  3. Apr 11, 2007

    James Hines says:

    I too am having difficulty with this plugin.  I see the following error mes...

    I too am having difficulty with this plugin.  I see the following error message when rendering an OPML file when this plugin is installed in 2.3.1.  (Note: This works fine on 2.2.10)

    1. Apr 11, 2007

      David Peterson [CustomWare] says:

      I've added a 2.3+ compatible version. You can download it here or get it from th...

      I've added a 2.3+ compatible version. You can download it here or get it from the repository in the next 20 minutes or so.

  4. May 23, 2007

    Pascal Robert says:

    I just tried with an OPML file (exported from OmniGraffle), and the accented cha...

    I just tried with an OPML file (exported from OmniGraffle), and the accented characters (é, à, è, etc.) are all messed up.  The OPML file is in UTF-8 (without BOM).  Output in Confluence :
     
    The last line should display " Dernière étape ", and it's correct in the OPML file :

    <outline text="Dernière étape">