Space Blueprint Module

Applicable:

Confluence 5.3 and later

Purpose of this module

As a plugin developer, you can use a Space Blueprint module to add to the Create Space dialog in Confluence to help users bootstrap the space creation process. Note that you need to define a web-item referring to a space-blueprint module for it to appear in the Create Space dialog. This page only documents the space-blueprint module. See Space Blueprints for concepts and tutorials.

Configuration

The root element for the Space Blueprint module is space-blueprint

Element: space-blueprint

Attribute

Required

Description

Default

key

(tick)

The identifier of the plugin module. This key must be unique within your plugin.

None

i18n-name-key

(tick)

A i18n key for the name of this Space Blueprint.

None

category   A space label to apply to the spaces created via the Space Blueprint. None

A space-blueprint can optionally contain the following elements:

Element

Description

content-template

The content-template element allows you to define the default page structure for spaces created via your space blueprint. The root content-template element becomes the homepage for the space and you can nest them to create a hierarchy. These elements require a ref attribute referring to a content-template definition in your plugin.

promoted-blueprints

The promoted-blueprints element allows you to define a list of Blueprints to be promoted by default in your space. This means that if a user presses "Create", the "promoted" Blueprints will appear first for that space.

dialog-wizard

This is an optional element which allows you to easily create a dialog wizard for your space.

Example

Example of a Space Blueprint with a single page wizard and default page hierarchy; including a homepage and two child pages.

Example from Hello Blueprint
<content-template key="hierarchy-blueprint-content-template" i18n-name-key="confluence.hierarchy.blueprint.content.template.name">
    <description key="confluence.hierarchy.blueprint.content.template.description"/>
    <resource name="template" type="download" location="com/atlassian/confluence/plugins/hello_blueprint/xml/hierarchy-content-template.xml"/>
    <context-provider class="com.atlassian.confluence.plugins.hello_blueprint.HierarchyContextProvider"/>
</content-template>
<content-template key="hierarchy-child-a-content-template" i18n-name-key="confluence.hierarchy.child.a.blueprint.content.template.name">
        <description key="confluence.hierarchy.child.a.blueprint.content.template.description"/>
        <resource name="template" type="download" location="com/atlassian/confluence/plugins/hello_blueprint/xml/hierarchy-child-a-content-template.xml"/>
        <context-provider class="com.atlassian.confluence.plugins.hello_blueprint.HierarchyChildAContextProvider"/>
</content-template>
<content-template key="hierarchy-child-b-content-template" i18n-name-key="confluence.hierarchy.child.b.blueprint.content.template.name">
        <description key="confluence.hierarchy.child.b.blueprint.content.template.description"/>
        <resource name="template" type="download" location="com/atlassian/confluence/plugins/hello_blueprint/xml/hierarchy-child-b-content-template.xml"/>
</content-template>


<web-item key="hello-space-blueprint-item" i18n-name-key="confluence.hello.space.blueprint.name" section="system.create.space.dialog/content">
        <description key="confluence.hello.blueprint.description"/>
        <resource name="icon" type="download" location="com/atlassian/confluence/plugins/hello_blueprint/images/preview.png"/>
        <param name="blueprintKey" value="my-space-blueprint"/>
</web-item>

<space-blueprint key="my-space-blueprint" i18n-name-key="confluence.hello.space.blueprint.name">
        <content-template ref="hierarchy-blueprint-content-template">
            <content-template ref="hierarchy-child-a-content-template"/>
            <content-template ref="hierarchy-child-b-content-template"/>
        </content-template>
        <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