Preparing for Confluence 5.0
This documentation is intended for Confluence developers who want to ensure that their existing plugins and add-ons are compatible with Confluence 5.0, and to learn about the new features for developing add-ons in Confluence 5.0.
Confluence 5.0 introduces a modernised look and feel that is consistent with other Atlassian applications and delivers a number of improvements to the way users create and navigate content.
What's changing in Confluence 5.0?
Atlassian UI updates
Confluence 5.0 will include a major upgrade of AUI (the Atlassian User Interface) to AUI 5.0. This will also update the version of jQuery that Confluence supports.
There will be visual changes to the appearance of Atlassian UI. Your plugin will look different if it uses AUI. If it does not yet use AUI, your plugin will look out of place in Confluence 5.0. We recommend that you follow the new Atlassian Design Guidelines (ADG). We also added a tutorial explaining how to maintain ADG resources in a plugin that has to stay backwards-compatible.
We will be incrementally upgrading AUI in each of our 5.0 EAP releases, starting with Confluence 5.0-m3 available in early November 2012.
To see specific changes in this and future milestone releases, please view the Atlassian UI Updates in Confluence 5.0 page.
Confluence 5.0 introduces a new header that is consistent with the headers of the other Atlassian products. The goal of the header is to give users quicker access to global objects and operations, to introduce a common navigation pattern across all Atlassian applications, and to modernise Confluence's look and feel.
The new header became available in Confluence 5.0-m3 and has been available to Confluence Cloud customers since October 2012. Confluence 5.0-m9 included a new 'Create' option and a new space sidebar, replacing the 'Browse' menu item. See the Confluence 5.0-m9 release notes for information on enabling the EAP features in the release.
- Global menu items (
system.browse) have moved into the help menu. It is important for you to reassess your global menu items, and if you believe they should be top-level menu items, switch this to
Note: Please only consider this for global menu items, and use with caution.
New default space navigation
We have changed the design of the default theme to include a collapsible left-hand navigation panel, called the sidebar.
The sidebar will make it easier for your users to navigate your space hierarchy and access important links within the space and other related applications. Administrators will be able to add arbitrary links to the sidebar and modify space settings from the sidebar.
Plugin developers can check out the tutorial: Adding Space Shortcut Links.
Sidebar impact on themes
The default theme will include the sidebar, so your theme may be impacted if you base it on the default theme. In future releases of Confluence 5.x we plan to combine this with the Documentation theme. Confluence 5.0-m9 included the new sidebar, replacing the 'Browse' menu item. See the Confluence 5.0-m9 release notes for information on enabling the EAP features in the release. We will have more information about the new sidebar in later EAP releases.
Theme developers can check out the tutorial: Adapting a theme for Confluence 5.0 and add-on developers please read Browse Menu and Space Tools changes in Confluence 5.0.
Example: Confluence Page with New Sidebar Navigation
Note: If you use the Plugin SDK to start Confluence 5.0-m9 (EAP release), it will be loaded with a default database configured with the Documentation Theme, which doesn't have the new sidebar. To visualize the new Space IA sidebar, switch your space to use the default theme.
Sidebar top-level web-ui items
For the sidebar we also have a new web-ui module: system.space.sidebar/main-links (learn more).
A new 'Create' experience
Confluence 5.0 ships with a new Create experience. Add-on developers can make use of this create experience by creating add-ons which create different types of content. We know that Confluence is awesome for building 'mini applications', like meeting notes, release notes, image galleries, even lists of documents and files. But customers don’t always know how to create these things. We're working on a new way to package and deliver the functionality to customers so they can get more value out of Confluence.
In a future release of 5.0.x, we will bundle a number of content-centric applications in side Confluence. We are calling these Blueprints. A Blueprint is a collection of plugin-modules in Confluence, that when combined together:
- Show users what types of content they can create
- Guides them to be able to create the content
- Helps them structure the content
A typical Blueprint would
- extend the Confluence create experience to possibly include a "wizard-like" interface to creating a page
- could come bundled with one or more templates or macros
- can provide an "index" page: a page that lists all content for a particular label/type.
Calling all add-on developers! Confluence Blueprints means that you can build these as well and exchange them through the Atlassian Marketplace, either as an enhancement to your existing plugin or as a standalone plugin.
Pluggable Admin Tasks
Plugins sometimes want to notify administrators about licenses, new features or alerts. UPM has a plugin point for post-install and post-update screens. When this is not enough, we've made Admin Tasks pluggable (CONF-23261). See Creating an Admin Task.
New Render Mode for Mobile Macros
- Modified Breadcrumb Interface
We've modified the
Breadcrumbinterface. If you use Breadcrumbs and implement the
Breadcrumbinterface you will need to extend the
AbstractBreadcrumbclass or implement the new methods, otherwise you will run into compilation issues.
Milestone releases for developers
Please watch the Development Releases page for pre-release versions of Confluence 5.0 that you can use for testing purposes.
Below are notices for future release consideration for plugin developers:
- The Creating a Template Bundle plugin point will be removed for Confluence 5.1. This will be replaced the new pluggable create experience mentioned above.
- The "Add" menu drop-down web item is hidden for the default theme in Confluence 5.0 and will probably be removed from other theme in future versions of Confluence. The new "Create" experience (see above) will replace the need for the Add button on the view page, consolidating all types of content in one place. There will be no migration path for the old Add drop-down.
If you have any questions about preparing for Confluence 5.0, please register for an account on Atlassian Answers, our community Q&A resource, and ask a question. We'll be keeping an eye on things to help out as soon as possible.