Edit Notification Templates
You can customize the templates that are used for email and Jabber notifications on a per-project basis. Project-level customizations overwrite changes that have been applied to notification templates at the global level.
A list of templates that are used for notifications in your project are shown on the Notification Templates tab of the project profile.
You can expand each item in the list to view and edit the template components. The template components are actual Freemarker Template Language files that are used as building blocks for messages.
Prerequisites
Before you modify the notification templates for your project, check the following prerequisites:
Your administrator has enabled notifications for either email or Jabber in your YouTrack server.
If you want to modify the appearance of the notification templates, you should be familiar with the syntax that is used in Freemarker Template Language files.
Edit a Notification Template
If you only want to modify the message text, you can easily update the notification templates that are used for your project. If you want to make more radical changes, refer to the Custom Notifications Language Reference.
To edit a notification template:
tip
Requires permissions: Update Project
Expand the item in the Notifications list.
Open a template component (an <component_name>.ftl file)
Make the desired changes.
The following controls are available for editing notification templates:
Control | Description |
|---|---|
Available Variables | Lists the variables that can be used in this template. For more information, see Custom Notifications Language Reference. |
Save changes | Saves the current changes. |
Undo | Reverts the most recent change. |
Redo | Restores the most recently reverted change. |
Reset to global | Discards all current and previously saved changes and restores the default notification. |
Preview and Test Changes
To view how your changes affect a template or a template component, select an issue in the Issue selected for preview dropdown list. When you select a notification from the list, a preview that contains data from the selected issue is shown in the Details sidebar.
Along with the preview that shows changes in the browser window, you can also see your changes in your email or jabber client. Select the Email or Jabber branch of a template and click the Send test email or Send test Jabber button in the toolbar.