The Create Page Tree Button macro creates a new Space from the template. Parameters that can be configured are explained in the next section.

How to use the PTC Button Macro

The Page Tree Creator Button can be inserted on any regular Confluence page. For more information visit Template Usage section.

Parameters

Parameter

Description

Type

Default Value

Button Name

Give your button a name, special characters and placeholders are allowed.

Text-Input

Create Space

Source Page

Specifies the root page of your template. This template is a normal confluence page. When the button is clicked, the root page and all its children are used as template for the new page tree.

  • This field is required.

  • @self uses the current page as root page. You can also use the final page name.

For all other pages, there are two ways in which to define the source page:

  1. Search for the page in the search box. Results are displayed as: PAGE_TITLE (SPACE_NAME). Select the desired page. After selection, the source page will be displayed as SPACE_KEY:PAGE_TITLE

  2. Search via Page ID. Whenever a Page ID is used as a search query, the corresponding page will be displayed as a search result.

  3. Input the desired Space Key and Page Title combination directly into the search box and click "Create INPUT_TEXT". The syntax for this is: SPACE_KEY:PAGE_TITLE.

  4. Input the desired page id directly into the search box and click Create

Text-Input

@self

Space Title Instruction

Set a Space Title instruction which is displayed below the Target space name* field in the Select a Target window when clicking the Button.

Text-Input

empty

Space Key Instruction

Set a Space Key instruction which is displayed below the Target space key* field in the Select a Target window when clicking the Button.

Text-Input

empty

Default Target Space Key

Set a Default Target Space Key which is displayed in the Target space key* field in the Select a Target window when clicking the Button. The key may only consist of ASCII letters or numbers (A-Z, a-z, 0-9), without any spaces.

Text-Input

empty

Disable Target Space Key Input

When unchecked, the Target Space Key* Input Field is disabled.

Checkbox

false

Top Page Labels

Labels which are applied to the root page of the new space. Separate multiple labels with commas.

Placeholders are also allowed, which you will be able to replace when using the button.

Text-Input

empty

Permitted Groups

Choose Groups which are allowed to use the Create Space Button.

Multi-Dropdown

empty

Hide Disabled Button

When checked, the button will only be displayed if the user is permitted to use it.

Checkbox

false

Page Selection

When checked, the User can select which pages in the Page Tree they want to copy.

Checkbox

true

Copy Attachments

When checked, the Attachments of the copied pages get copied as well.

Checkbox

true

Copy Space Favorite

When checked, the new Space will be added to My Spaces if the source Space was in My Spaces as well.

Checkbox

false

Copy Confluence Templates

When checked, the Confluence Page Templates will be copied to the new Space.

Checkbox

false

Copy Space Permissions

When checked, the Space Permissions set for this space will be applied to the newly created one. When unchecked, default Space Permissions apply.

Checkbox

false