Quoting Francois Marier (francois@debian.org): > (Please CC me on your replies) > > Hello, > > Please review the following template. I have attached the current template > file. Here's my review. As, apparently, Justin did also a review, I'll send both the diff and the new templates file. Up to you to take the best out of our work..:-) Rationale: --- templates 2008-03-27 06:31:46.728757286 +0100 +++ templates.new 2008-03-27 06:36:58.016759369 +0100 @@ -1,33 +1,36 @@ Template: email-reminder/send_reminders Type: boolean Default: true -_Description: Send emails out? - Email-reminder normally sends emails out every night. +_Description: Send daily reminder emails? + Email-reminder is generally setup to send out daily email reminders. + . + Please choose whether you want to activate this feature. Be more specific. These templates may come in the middle of the installation of many packages. The long description I propose keeps some kind of link with the synopsis....but should be readable also *without* the synopsis. That was the weakness of your version, imho. So, I propose a wording which we generally propose in such situations. Template: email-reminder/smtp_server Type: string Default: localhost _Description: SMTP server: - Enter the SMTP server to be used to send the emails out. + Please enter the outgoing mail server to use. Usual wording for such prompts. Template: email-reminder/smtp_username Type: string Default: _Description: SMTP username: - If your SMTP server needs a username, enter it here, otherwise - leave this blank. + Please enter the username to use on the SMTP server. + . + Leave this blank if the SMTP server doesn't require authentication. "username to use" is not the best....anyway. This is not "my" SMTP server, I could be the junior admin on a big corporate server.. Make it clearer why an SMTP server would require a username. Template: email-reminder/smtp_password Type: password Default: _Description: SMTP password: - If your SMTP server needs a password, enter it here, otherwise - leave this blank. + Please enter the password to use on the SMTP server. + . + Leave this blank if the SMTP server doesn't require authentication. Parallel to the previous template....and sharing one string with it. Template: email-reminder/mail_from Type: string Default: root@localhost -_Description: Sending email address: - Emails will appear to come from this address. Some SMTP servers - require that this be a valid address. Otherwise, the default - value should be fine. +_Description: Reminder mails originating address: + Please enter the email address to use as origin address in reminder + mails. Some SMTP servers require that this be a valid address. I prefer saying that this address is the originating address for reminder mails rather than a pretty vague "sending email address". "The default should be fine" is a pleonasm. Default values should always be fine..:-) Don't use double spaces after dots. This is a controversial issue among English native speakers but we try to suggest some standardization on single spacing.
--- templates 2008-03-27 06:31:46.728757286 +0100 +++ templates.new 2008-03-27 06:36:58.016759369 +0100 @@ -1,33 +1,36 @@ Template: email-reminder/send_reminders Type: boolean Default: true -_Description: Send emails out? - Email-reminder normally sends emails out every night. +_Description: Send daily reminder emails? + Email-reminder is generally setup to send out daily email reminders. + . + Please choose whether you want to activate this feature. Template: email-reminder/smtp_server Type: string Default: localhost _Description: SMTP server: - Enter the SMTP server to be used to send the emails out. + Please enter the outgoing mail server to use. Template: email-reminder/smtp_username Type: string Default: _Description: SMTP username: - If your SMTP server needs a username, enter it here, otherwise - leave this blank. + Please enter the username to use on the SMTP server. + . + Leave this blank if the SMTP server doesn't require authentication. Template: email-reminder/smtp_password Type: password Default: _Description: SMTP password: - If your SMTP server needs a password, enter it here, otherwise - leave this blank. + Please enter the password to use on the SMTP server. + . + Leave this blank if the SMTP server doesn't require authentication. Template: email-reminder/mail_from Type: string Default: root@localhost -_Description: Sending email address: - Emails will appear to come from this address. Some SMTP servers - require that this be a valid address. Otherwise, the default - value should be fine. +_Description: Reminder mails originating address: + Please enter the email address to use as origin address in reminder + mails. Some SMTP servers require that this be a valid address.
Template: email-reminder/send_reminders Type: boolean Default: true _Description: Send daily reminder emails? Email-reminder is generally setup to send out daily email reminders. . Please choose whether you want to activate this feature. Template: email-reminder/smtp_server Type: string Default: localhost _Description: SMTP server: Please enter the outgoing mail server to use. Template: email-reminder/smtp_username Type: string Default: _Description: SMTP username: Please enter the username to use on the SMTP server. . Leave this blank if the SMTP server doesn't require authentication. Template: email-reminder/smtp_password Type: password Default: _Description: SMTP password: Please enter the password to use on the SMTP server. . Leave this blank if the SMTP server doesn't require authentication. Template: email-reminder/mail_from Type: string Default: root@localhost _Description: Reminder mails originating address: Please enter the email address to use as origin address in reminder mails. Some SMTP servers require that this be a valid address.
Attachment:
signature.asc
Description: Digital signature