Changes between Version 12 and Version 13 of TracNotification

Timestamp:

14/06/2017 12:47:23 (7 years ago)

Author:

trac

Comment:

--

TracNotification

@@ -34 +34 @@
 These are the available options for the `[notification]` section in trac.ini:
 
-[[TracIni(notification)]]
+[[TracIni(section=notification)]]
 
 === Example Configuration (SMTP)
@@ -60 +60 @@
 The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
 
-[[TracIni(notification-subscriber)]]
+[[TracIni(section=notification-subscriber)]]
 
 Each user can override these defaults in his ''Notifications'' preferences.
 
 For example to unsubscribe from notifications for one's own changes and comments, the rule "Never notify: I update a ticket" should be added above other subscription rules.
+
+The subscription rule name on the left side of the `=` can be anything, it has no meaning outside this configuration file. The subscriber name on the right side of the `=` must be one of the subscribers listed in the above table.
+
+The following attributes of default subscriptions can be configured:
+* `.distributor` (Default: `email`)
+  * Other values require plugins. For example `on-site` requires th:OnSiteNotificationsPlugin.
+* `.priority` (Default: `100`)
+  * Smaller values override larger values.
+  * If you use `0`, then users will not be able to override this rule.
+* `.adverb` (Default: `always`)
+  * `never` can be used to silence other subscription rules with higher values.
+* `.format` (Default: `text/plain`)
+  * Other values require plugins. For example `text/html` requires th:TracHtmlNotificationPlugin.
+
+=== Example Configuration (default subscriptions)
+{{{#!ini
+[notification-subscriber]
+always_notify_owner = TicketOwnerSubscriber
+always_notify_owner.distributor = email
+always_notify_owner.priority = 100
+always_notify_owner.adverb = always
+always_notify_owner.format = text/plain
+
+always_notify_previous_updater = TicketPreviousUpdatersSubscriber
+
+never_notify_updater = TicketUpdaterSubscriber
+never_notify_updater.adverb = never
+never_notify_updater.priority = 0
+
+notify_cc_html = CarbonCopySubscriber
+notify_cc_html.format = text/html
+}}}
 
 === Customizing the e-mail subject
 The e-mail subject can be customized with the `ticket_subject_template` option, which contains a [http://genshi.edgewall.org/wiki/Documentation/text-templates.html Genshi text template] snippet. The default value is:
 {{{#!genshi
-$prefix #$ticket.id: $summary
+${prefix} #${ticket.id}: ${summary}
 }}}
 The following variables are available in the template:
@@ -76 +108 @@
  * `prefix`: The prefix defined in `smtp_subject_prefix`.
  * `summary`: The ticket summary, with the old value if the summary was edited.
- * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `$ticket.milestone`.
+ * `ticket`: The ticket model object (see [trac:source:/trunk/trac/ticket/model.py model.py]). Individual ticket fields can be addressed by appending the field name separated by a dot, eg `${ticket.milestone}`.
 
 === Customizing the e-mail content
@@ -83 +115 @@
 
 {{{#!genshi
-$ticket_body_hdr
-$ticket_props
+${ticket_body_hdr}
+${ticket_props}
 {% choose ticket.new %}\
 {%   when True %}\
-$ticket.description
+${ticket.description}
 {%   end %}\
 {%   otherwise %}\
@@ -93 +125 @@
 ${_('Changes (by %(author)s):', author=change.author)}
 
-$changes_body
+${changes_body}
 {%     end %}\
 {%     if changes_descr %}\
@@ -99 +131 @@
 ${_('Description changed by %(author)s:', author=change.author)}
 {%       end %}\
-$changes_descr
+${changes_descr}
 --
 {%     end %}\
@@ -106 +138 @@
 ${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
 
-$change.comment
+${change.comment}
 {%     end %}\
 {%   end %}\
@@ -113 +145 @@
 -- 
 ${_('Ticket URL: <%(link)s>', link=ticket.link)}
-$project.name <${project.url or abs_href()}>
-$project.descr
+${project.name} <${project.url or abs_href()}>
+${project.descr}
 }}}
 
@@ -149 +181 @@
 Replace the following second row in the template:
 {{{
-$ticket_props
+${ticket_props}
 }}}