How To Use Variables In Confluence Template

Looking for new Confluence templates? A huge range of templates are now available in Confluence Cloud. Learn more about templates in Confluence Cloud.

These templates are not available for Confluence Server or Data Center.

The template editor

When you create or edit a template, you'll be using the editor in much the same way as when you edit a page or blog post. In addition you can add variables, which will produce a form for data collection when anyone adds a page based on the template.

Screenshot: The template editor with an image, table, text, and variables

Screenshot: The form displayed when you create a page based on the template

Template variables

When you add variables to your template, they will act as form fields. When you create a page based on a template, you'll see a text entry box for each field. Enter data into each field, and it'll be added to the page.

You can add the same variable more than once in the same template, which is useful if you need the same information in more than one place on the page.

To insert a variable into a template:

Create a new template or Edit a template.
From the editor toolbar, select then chooseNew Variable (or choose an existing variable to add it to the page).
Enter a name for the variable.
PressEnter (by default this will create a single-line text input field).

To change the variable type, click the variable placeholder and the variable's property panel will appear. Choose one of the variable types:Text,Multi-line Text, orList.

You can change the number of lines and width in characters of aMulti-line Text field. If you chooseList, enter each of the items in your list, separated by commas.

Hint:Type$ and the variable name, then pressEnter to add a new variable or to select an existing variable from a list of suggestions. The suggestions dialog shows variables already defined in this template.

Labels

If you'd like all pages created using this template to have one or more labels, choosethe labels icon next to the breadcrumbs at the top of the page to add them.

Note: Currently, it's not possible to edit the labels of blueprint templates.

Images and other attachments

You can't upload an image or other file into a template directly. First you'll need to upload the file to a page in your site, then in your template, chooseInsert > Files > Search on other pages to embed the file or image.

Instructional text

Instructional text is placeholder content in a template, and is only visible while you're editing the page. Use it to give guidance to whoever is creating a page from the template.

To insert instructional text:

Create a new template or Edit a template.
From the editor toolbar, select then choose Instructional text.
Type in your instructional text (for example, Insert an image of the interface here.)

Instructional text appears in italics with a shaded background, to distinguish it from normal paragraph text.

You can also change the placeholder type from Text to either:

User mention – Opens the user mention dialog.
Jira Macro – Opens a dialog that allows you to create a new Jira issue, or search for one or more Jira issues to include on the page.

Add a description to your template

The template description displays in the 'Create' dialog, and is useful for explaining the purpose of your template to other users.

To add a description to a template:

Go to the space or global templates page (as described above)
Choose the Edit icon in the 'Description' column
Enter your description and choose Save

Edit: use the pencil icon to edit your template's description.

Edit or delete a template

If you need to change anything about your template, or want to delete it, navigate to either your space or global template (as described above) and choose eitherEdit orDelete.

Notes

Page templates are used only when adding a page. It is not possible to apply a template to an already-existing page. Once a page has been added using a template, the template is no longer linked to the page. All further editing is performed as if the template was never used. Some Marketplace apps provide enhanced template functionality. You can search the Atlassian Marketplace for template apps.
When you use a Table of Contents macro in a template, you'll see an error when you preview the template, but the Table of Contents macro works on the pages that people create from the template.
The editor for templates is available only in Confluence 4.3 and later. Please refer to the earlier documentation for a description of the wiki markup editor templates.
Confluence also provides 'system templates' containing content like the site welcome message and default space content. See Administering Site Templates.