Applicable: | Confluence 5.2 and later |
Currently you can only use this module with a Space Blueprint or Blueprint definition. It allows you to easily create a wizard for users to input data in for your blueprint. Note that you must provide your wizard in the form of soy templates.
The root element for the Dialog Wizard module is dialog-wizard.
dialog-wizard
Attributes
|
Description
|
|---|---|
| A unique identifier of the dialog wizard. Required. |
The dialog-wizard element must have at least one dialog-page element.
dialog-page
Attributes*
|
Description
|
|---|---|
| A unique identifier of the dialog page Default: None |
template-key | A reference to the soy template for the dialog page to be rendered |
| An i18n key for the dialog page title |
| An i18n key for the title of the description section on the dialog page |
| An i18n key for the text of the description section on the dialog page |
| A Boolean that should have the value 'true' if it is the last dialog wizard page |
*id, template-key, and title-key are required
Note the description section refers to the right side panel, which should explain more about the blueprint.
The following example shows a Space Blueprint with a one page wizard defined. It will render a soy template provided already by Confluence for a create space form.
1 2<space-blueprint key="my-space-blueprint" i18n-name-key="confluence.hello.space.blueprint.name"> <dialog-wizard key="my-space-blueprint-wizard"> <dialog-page id="spaceBasicDetailsId" template-key="Confluence.Templates.Blueprints.CreateSpace.createSpaceForm" title-key="confluence.hello.blueprint.dialog.choose.title" description-header-key="confluence.hello.blueprint.dialog.choose.heading" description-content-key="confluence.hello.blueprint.dialog.choose.description"/> </dialog-wizard> ... </space-blueprint>
Rate this page: