Instruction text in blueprints
Including Instructional Text in Blueprints
Blueprints (and other add-ons) can make use of the new "Instructional Text" feature for templates. The purpose of instructional text is to:
- Make it easy for a template creator to include information on how to fill out the template.
- Make it easy for the template end-users to fill out a template. This is achieved by:
- automatically clearing all "instructional text" as the user types in a specific text block, or
- automatically triggering a @mention prompt for user selection.
- automatically triggering the JIRA Issues macro dialog to enable the user to search for or create an issue.
Instructional text can be inserted into a blueprint or template using the
<ac:placeholder>instruction text</ac:placeholder> notation in the storage format.
There is also an optional
ac:type attribute that can specify the type of instructional text that the placeholder represents. Confluence provides support for the following types:
mention- this type will activate the user search autocomplete to insert a user mention into the page.
jira- this type will launch the JIRA Issues macro dialog and allow the user to search for or create an issue.
Example storage format for instructional text.
Adding Instruction Text Types
It is possible to add support for additional types of instructional text via a plugin.
This can be achieved by adding a tiny_mce plugin inside your plugin as follows.
The following is a skeleton file to add support for another type of instructional text.