| Applicable: | Confluence 5.1 and later. |
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.
The root element for the blueprint module is blueprint.
| Attributes | Description |
|---|---|
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 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 |
disable-index-page | Disables blueprint index page creation. This property is saved on first blueprint page creation. Default: |
The blueprint element can have the following child elements.
| Element | Description |
|---|---|
A blueprint must have at least one content template. Its `ref` attribute should match a key attribute of `content-template module`. Required. | |
| This is an optional element that allows you to easily create a dialog for your blueprint. |
1 2<blueprint key="myplugin-blueprint" index-key="myplugin-index"> <content-template ref="myplugin-template"/> </blueprint>
Rate this page: