confusing TracNotification documentation

[yoav@…]

Hi there,

We've started using trac not too long ago and in the process of configuring the SMTP notification I noticed some confusing paragraphs in the TracNotification documentation.

First of all, the documentation says "When reporting a new ticket or adding a comment, enter a valid email address in the reporter, assigned to/owner or cc field. Trac will automatically send you an email when changes are made to the ticket"

But in fact it doesn't require an email address but a trac user (with an associated email address). What happened to me when trying it out was that a new user was linked to a ticket if I put the email address (our usernames don't have @domain)

Secondly, always_notify_reporter, always_notify_owner etc are very confusing names, because they actually mean notify_reporter, notify_owner…

Reading the guidelines I assumed if you just put the username it wouldn't send notification, but if you do then it will - regardless of the always_notify_xxx settings. i.e. Users can control whether they are notified on a ticket-by-ticket basis. I thought the alwyas_notify is used to FORCE notification even when an email is not typed in.

I think the documentation should be more clear about it. Maybe I'm the only one with reading difficulties ;-)

Thanks Yoav

[Emmanuel Blot]

The Trac documentation uses a Wiki, so you can edit the pages to make it better and improve the quality of the documentation.

To comment on your report: you can either enter a username or a full email address. To get notified with a simple username or login, the user should specify a valid email address in the "Settings" page or a default domain name should be set in the TracIni file. In the latter case, the default domain will be appended to the username, which can be useful for am "Intranet" kind of installation.

[sid]

adding documentation keyword to the ticket.

[Christian Boos]

The TracNotification should mention the need for the [trac] base_url to be set (see #4645).

[Gisbert Amm <gisbert.amm@…>]

I think I got all details mentioned here into the TracNotification page. Please review my changes if you got some spare five minutes.

[Remy Blank]

Replying to Gisbert Amm <gisbert.amm@…>:

I think I got all details mentioned here into the TracNotification page. Please review my changes if you got some spare five minutes.

Yes indeed, thanks for your contribution! I simplified one paragraph, but other than that, the changes are fine.

You may have noticed the "Preview Page" button at the bottom of the editor. It's a good way of checking your changes and catching e.g. formatting errors ;-)