Preparing for Confluence 5.1
This documentation is intended for Confluence developers who want to ensure that their existing plugins and add-ons are compatible with Confluence 5.1, and to learn about the new features for developing add-ons in Confluence 5.1.
Confluence 5.1 introduces blueprints – add-ons which create different types of content.
What's changing in Confluence 5.1?
Introducing Confluence blueprints
In Confluence 5.0 we introduced the new Create experience. Add-on developers can make use of this create experience by creating add-ons which create different types of content. The goal of Confluence Blueprints is to:
- Show users what types of content they can create
- Guides them to be able to create the content
- Helps them structure the 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. Confluence Blueprints helps "bootstrap" the page creation process. It creates content that is consistently formatted, automatically organized, and easy to find.
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
- optionally include a wizard which helps pre-populate the template or macro with content
- 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.
To help you get started we have a few tutorials available. See Confluence Blueprints for details.
Instructional text in templates
Blueprints (and other add-ons) can make use of the new "Instructional Text" feature for templates. The purpose of instructional text is to:
- Make it easy for a template creator to include information on how to fill out the template.
- Make it easy for the template end-users to fill out a template by:
- automatically clearing all "instructional text" as the user types in a specific text block, or
- automatically triggering a @mention prompt for user selection.
Learn more about how to create instructional text.
Extending the image properties dialog
Confluence 5.1 also introduces a new pluggable image properties dialog. If you are building an add-on which extends an image in any way (such as an image map, image manipulation etc..) you should consider using the image properties dialog for this. See extending the Image Properties Dialog for details.
Labels tidied up
We have simplified and improved the labels code, and added some REST resources:
- We have deleted two Velocity (vm) files. Please adjust any plugins that use them:
label-listitems.vm– This provided a for-each loop over another template. You should be able to get the same functionality from
labels-dialog.vm– We now use the Soy version of this template.
- Labels now follow the ADG/AUI Labels guidelines. Your plugin should use these guidelines too, so that it automatically inherits AUI changes in future releases.
Atlassian UI updates
Following on from Confluence 5.0, this release includes further improvements to the Confluence UI. In Confluence 5.0, we introduced the new Atlassian Design Guidelines (ADG) which included a major upgrade of AUI (the Atlassian User Interface) and jQuery that Confluence supports.
- Labels now follow the ADG/AUI Labels guidelines.
Other note-worthy modifications
- 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.
Milestone releases for developers
Please watch the Development Releases page for pre-release versions of Confluence 5.1 that you can use for testing purposes.
Below are notices for future release consideration for plugin developers:
- The "Add" menu drop-down web item is hidden for the default theme in Confluence 5.0 and later, 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.1, 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.