Changes between Version 95 and Version 96 of TracNotification

Timestamp:

Apr 3, 2017, 4:53:53 AM (7 years ago)

Author:

Ryan J Ollos

Comment:

Minor edits.

TracNotification

@@ -5 +5 @@
 Trac supports notification of ticket changes via email. 
 
-Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list. For example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list is set up.
-
-Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
+Email notification is useful to keep users up-to-date on tickets of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list.
+
+Disabled by default, notification can be activated and configured in [TracIni trac.ini].
 
 == Receiving Notification Mails
@@ -14 +14 @@
 === How to use your username to receive notification mails
 
-To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in the ''Preferences'' page. 
+To receive notification mails, you can either enter a full email address or your Trac username. To get notified with a simple username or login, you need to specify a valid email address in your [/prefs preferences]. 
 
 Alternatively, a default domain name ('''`smtp_default_domain`''') can be set in the TracIni file, see [#ConfigurationOptions Configuration Options] below. In this case, the default domain will be appended to the username, which can be useful for an "Intranet" kind of installation.
@@ -30 +30 @@
 == Configuring SMTP Notification
 
-'''Important:''' For TracNotification to work correctly, the `[trac] base_url` option must be set in [wiki:TracIni trac.ini]. 
+'''Important:''' For TracNotification to work correctly, the [[TracIni#trac-base_url-option|[trac] base_url]] option must be configured. 
 
 === Configuration Options
@@ -59 +59 @@
 
 === Subscriber Configuration
-The default subscriptions are configured in the `[notification-subscriber]` section in trac.ini:
+The default subscriptions are configured in the [TracIni#notification-subscriber-section "[notification-subscriber]"] section.
 
 [[TracIni(section=notification-subscriber)]]
 
-Each user can override these defaults in his ''Notifications'' preferences.
+Each user can override these defaults in their ''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.
@@ -106 +106 @@
 The following variables are available in the template:
 
- * `env`: The project environment (see [trac:source:/trunk/trac/env.py env.py]).
+ * `env`: The project environment object (see [trac:source:/trunk/trac/env.py env.py]).
  * `prefix`: The prefix defined in `smtp_subject_prefix`.
  * `summary`: The ticket summary, with the old value if the summary was edited.
@@ -113 +113 @@
 === Customizing the e-mail content
 
-The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default looks like this:
+The notification e-mail content is generated based on `ticket_notify_email.txt` in `trac/ticket/templates`. You can add your own version of this template by adding a `ticket_notify_email.txt` to the templates directory of your environment. The default is:
 
 {{{#!genshi
 ${ticket_body_hdr}
 ${ticket_props}
-{% choose ticket.new %}\
-{%   when True %}\
+# if ticket.new:
 ${ticket.description}
-{%   end %}\
-{%   otherwise %}\
-{%     if changes_body %}\
+# else:
+#   if changes_body:
 ${_('Changes (by %(author)s):', author=change.author)}
 
 ${changes_body}
-{%     end %}\
-{%     if changes_descr %}\
-{%       if not changes_body and not change.comment and change.author %}\
+#   endif
+#   if changes_descr:
+#     if not changes_body and not change.comment and change.author:
 ${_('Description changed by %(author)s:', author=change.author)}
-{%       end %}\
+#     endif
 ${changes_descr}
 --
-{%     end %}\
-{%     if change.comment %}\
-
-${changes_body and _('Comment:') or _('Comment (by %(author)s):', author=change.author)}
+#   endif
+#   if change.comment:
+
+${_('Comment:') if changes_body else
+  _('Comment (by %(author)s):', author=change.author)}
 
 ${change.comment}
-{%     end %}\
-{%   end %}\
-{% end %}\
-
--- 
+#   endif
+# endif
+--
 ${_('Ticket URL: <%(link)s>', link=ticket.link)}
 ${project.name} <${project.url or abs_href()}>
@@ -263 +260 @@
 == Troubleshooting
 
-If you cannot get the notification working, first make sure the log is activated and have a look at the log to find if an error message has been logged. See TracLogging for help about the log feature.
-
-Notification errors are not reported through the web interface, so the user who submits a change or a new ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace.
+If you cannot get the notification working inspect the [TracLogging log] for error messages.
+
+Notification errors are not reported through the web interface, so the user who submits a change or creates a ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace.
 
 === ''Permission denied'' error