The Create from Template macro displays a button on a page, linked to a specific template. When someone clicks the button, the macro opens the editor, ready to add a new page, and adds content to the page based on the given template.
When adding the macro to the page, you can specify a blueprint or a user-created template in the macro. You will also specify the name of the button displayed, and the space in which the new page will appear.
Screenshot: A page with three buttons, all displayed by the 'Create from Template' macro
To add the Create from Template macro to a page:
Parameter | Required | Default | Description |
|---|---|---|---|
| Button Text | 'Create from Template' | The description that people will see when viewing this macro on the page. | |
| Template Name | None | Select the template or blueprint to base the new page on. Only global and user-created templates for the current space appear (unless you have specified a different space in the 'Space Key' field). | |
Template Title | Blank | Specify a default title for pages created using this macro (optional). You can include @currentDate, @spaceName and @spaceKey variables in the title. | |
| Space Key | The space where the current page is located | Supply the unique space identifier (space key), to determine where the new page will be created when someone uses this macro to create a page. |
The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page.
Macro name: create-from-template
Macro body: None.
Parameters for storage format differ from those available in the macro browser as follows.
| Parameter name | Required | Default | Parameter description and accepted values |
|---|---|---|---|
| Required for user-created templates | (None) | The ID of a user-created template. This is the unique identifier that Confluence assigns when you create a template. For example, 299630593. To find the ID of a template, edit the template and look at the URL in your browser. The template ID is given in the URL parameter named entityId. |
blueprintModuleCompleteKey | Required for blueprints | (None) | |
| Yes | (None) | The ID of a user-created template (for example, 299630593) or the qualified name of the add-on that defines the blueprint (for example, com.atlassian.confluence.plugins.confluence-shared-files-plugin:file-list-blueprint). |
buttonLabel | Yes | 'Create from Template' | The description that people will seeing when viewing this macro on the page. |
spaceKey | Yes | The space where the current page is located | The unique space identifier, to determine where the new page will be created when someone uses this macro to create a page. |
Title | No | (None) | The title for pages created using this macro. You can include @currentDate, @spaceName and @spaceKey variables in the title. This title will override any title specified in a blueprint template. |
This example specifies a user-created template:
<ac:structured-macro ac:name="create-from-template">
<ac:parameter ac:name="templateId">299630593</ac:parameter>
<ac:parameter ac:name="buttonLabel">Blitz test</ac:parameter>
<ac:parameter ac:name="spaceKey">
<ri:space ri:space-key="DOCTHEME"/>
</ac:parameter>
<ac:parameter ac:name="templateName">299630593</ac:parameter>
</ac:structured-macro> |
This example uses a blueprint:
<ac:structured-macro ac:name="create-from-template">
<ac:parameter ac:name="blueprintModuleCompleteKey">com.atlassian.confluence.plugins.confluence-shared-files-plugin:file-list-blueprint</ac:parameter>
<ac:parameter ac:name="buttonLabel">Shared files</ac:parameter>
<ac:parameter ac:name="spaceKey">
<ri:space ri:space-key="DOCTHEME"/>
</ac:parameter>
<ac:parameter ac:name="templateName">com.atlassian.confluence.plugins.confluence-shared-files-plugin:file-list-blueprint</ac:parameter>
</ac:structured-macro> |