Converting Macro Libraries to Confluence Plugins

Version Warning
This document concerns upgrading Macro libraries written for Confluence 1.1 or 1.2 to a macro plugin compatible with Confluence 1.3 or later. If you are not upgrading a Macro Library, you don't need these instructions.

XML based conversion of Macros to Plugins

From Confluence 1.3 and onwards Macros become 'Plugins.' When upgrading, the only conversion which must take place is XML based.

The example below uses the tasklist macro, which is bundled in Confluence 1.3 and used frequently in earlier versions.

From Confluence 1.3 and onwards the XML descriptor is called atlassian-plugin.xml used in Confluence 1.3

<atlassian-plugin name='Task List Macros' key='confluence.extra.tasklist'>
    <plugin-info>
        <description>Macros to generate simple task lists</description>
        <vendor name="Atlassian Software Systems" url="http://www.atlassian.com"/>
        <version>1.3</version>
    </plugin-info>

    <macro name='tasklist' class='com.atlassian.confluence.extra.tasklist.TaskListMacro' key='tasklist'>
        <description>Creates a very simple task list, with user checkable tasks</description>
    </macro>
</atlassian-plugin>

In Confluence 1.2 and earlier the XML descriptor is called macro-library.xml and looks like:

<macro-libraries>
    <macro-library name="Task List Macros" key="confluence.extra.tasklist"
        description="An example macro library which generates task lists.">
        <macro name="tasklist" class="com.atlassian.confluence.extra.tasklist.TaskListMacro"
            description="Creates a very simple task list, with user checkable tasks."/>
    </macro-library>
</macro-libraries>

Converting Macro Libraries to Confluence Plugins

XML based conversion of Macros to Plugins

Labels