Blueprint module

Applicable:Confluence 5.1 and later.

Purpose of this module

As a plugin developer, you can use a blueprint module to add to the Create dialog in Confluence to help users speed up the page creation process. Note that you need to define a web-item referring to blueprint module for it to appear in the Create dialog.

This page only documents the blueprint module. For concepts and tutorials, see Confluence blueprints.

Configuration

The root element for the blueprint module is blueprint

AttributesDescription

key

A unique identifier of the blueprint.

Required.

index-key

Specifies the label added to all pages created from this blueprint. It is used to locate all pages created with this template from an Index page.

Required.

create-result

Defines the screen to go to when creating this type of blueprint. A value of create-result="view" causes Confluence to bypass the page Editor and automatically create the page content. The user lands in the view of the created page. When create-result="edit", the user is sent to the editor that is prefilled with the template content.

Default: edit.

index-template-key

Optionally defines an Index page template for your blueprint. It must refer to a content-template defined in your plugin.

i18n-index-title-key

The i18n key for the title of Index page.

Default: Defaults to the i18n-name-key specified by the Create dialog web-item module.

disable-index-page

Disables blueprint index page creation. This property is saved on first blueprint page creation.

Default: false

The blueprint element can have the following child elements.

ElementDescription

content-template

A blueprint must have at least one content template. Its `ref` attribute should match a key attribute of `content-template module`.

Required.

dialog-wizard

This is an optional element that allows you to easily create a dialog for your blueprint.

Example

1
2
3
<blueprint key="myplugin-blueprint" index-key="myplugin-index">
   <content-template ref="myplugin-template"/>
</blueprint>