Email notifications in Crucible can be customised to change their formatting, by editing template files. This page contains instructions for this process.
Editing Crucible email templates
Template files for Crucible are stored in the
folder.
/template/crucible/<Crucible home directory>
There are sets of templates for both HTML and plain-text emails. Note that these templates do not support embedding full diffs into notifications. They are only for changing the appearance and order of certain content inside the messages.
Editing the subject line
- Open the
crucible-notification-subject.ftl
template file from
in a text editor. This template is used as the subject template for all Crucible email notifications.
/template/crucible/<Crucible home directory>
- Type in new text for the email subject, ensuring that all of the content is contained within line 1 of the template.
- Save and close the file.
- Restart Crucible to activate the new templates.
Editing the header
Header information will be included at the beginning of the email body text.
- Open the 'crucible-notification-header.ftl' template file from
in a text editor. This template is used as the header template for all Crucible email notifications.
/template/<Crucible home directory>
- Add your new header content.
- Save and close the file.
- Restart Crucible to activate the new templates.
Editing the footer
Footer information will be included at the end of the email body text.
- Open the 'crucible-notification-footer.ftl' template file from
in a text editor. 'crucible-notification-footer.ftl' is used as the footer template for all Crucible email notifications.
/template/<Crucible home directory>
- Add your new footer content.
- Save and close the file.
- Restart Crucible to activate the new templates.
After an edit, the change to the email template will take place immediately. No restart is required.
Advanced editing of Crucible email templates
The email notification templates use the Freemarker format. Freemarker is a general templating engine enabling automated content.
If you are familiar with Freemarker, more advanced customisations can be made to the email notification templates. However, you make such adjustments at your own risk.
Crucible email template files
The following template files for Crucible notification are stored in the
folder.
/template/<Crucible home directory>
Template filename | Purpose |
---|---|
crucible-notification-subject.ftl | Subject template |
crucible-notification-header.ftl | Header template |
crucible-notification-footer.ftl | Footer template |
state-closed-notification.ftl | State Closed template |
all-completed-notification.ftl | All Completed template |
state-changed-notification.ftl | State Changed template |
completed-notification.ftl | Completed template |
general-notification.ftl | General notification template |
uncompleted-notification.ftl | 'Uncompleted' template |
all-no-longer-completed-notification.ftl | All-No-Longer-Completed template |
comment-notification.ftl | Comment template |
reply-notification.ftl | Reply template |
review-precis-plain.ftl | Precis template |
review-reminder-notification.ftl | Review Reminder template |
See also Customising FishEye Email Notifications.