Dialog Wizard Module

Applicable:

Confluence 5.2 and later

Purpose of this module

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. 

Configuration

The root element for the Dialog Wizard module is dialog-wizard

Element: dialog-wizard

Attributes
Required
Description
Default

key

(tick)

A unique identifier of the dialog wizard

None

The dialog-wizard element must have at least one dialog-page element.

Element: dialog-page

Attributes
Required
Description
Default

id

(tick)

A unique identifier of the dialog page

None
template-key (tick) A reference to the soy template for the dialog page to be rendered  
title-key
(tick) An i18n key for the dialog page title  
description-header-key
  An i18n key for the title of the description section on the dialog page  
description-content-key
  An i18n key for the text of the description section on the dialog page  
last
  A Boolean that should have the value 'true' if it is the last dialog wizard page  

Note the description section refers to the right side panel, which should explain more about the blueprint. 

Example

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.

<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>
Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport