[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] English debconf template review : debian/mantis.templates



Quoting sils (sils@powered-by-linux.com):
> Hi team,
> 
> I would appreciate if you have any time to review the new debconf
> template for mantis package (which is not released yet).
> 
> I attach the new template.

Here's my review.

Some rationale:

--- mantis.templates	2011-05-24 06:56:39.656680627 +0200
+++ mantis.templates.bubulle	2011-05-24 07:05:35.682710609 +0200
@@ -1,63 +1,66 @@
 Template: mantis/webserver
 Type: select
-Choices: apache2
+__Choices: apache2
 Default: apache2
 _Description: Webserver to configure for Mantis:
  Please choose the web server that should be automatically configured
- to run Mantis on your system.
+ to run Mantis on this system.

__Choices because some teams like "translating" webserver names. For
instance, in French translations, I put "Apache 2".

s/your/this because the system is not necessarily "mine". This is a
common change we propose in reviews. 
 
 Template: mantis/htaccess_user
 Type: string
 Default: admin
-_Description: Set the username for Webserver protection:
- For security reasons the shipped /admin directory needs to be
- protected with .htaccess file. The installation process is
- about to create this file automatically.
+_Description: Mantis server administration user name:
+ For security reasons, Mantis administration directory needs to be
+ restricted to a user name defined in an .htaccess file.
  .
- Please enter the desired username for Webserver protection.
+ Please enter the desired user name.
 
This one, I revamped completely..:-)

First of all "user name" vs "username" is often debated. I personnally
prefer two words but I'm OK with one...

Indeed, what's setup here is the "login name" for Mantis admin. So
let's make this clear and leave the gory details (.htaccess) as details.

 
 Template: mantis/htaccess_passwd
 Type: password
-_Description: Set a password for Webserver protection:
- Please enter the desired password for Webserver protection.
+_Description: Mantis server administration password:
+ Please enter the desired password for Mantis administration.

Parallel with the former template
 
 
 Template: mantis/htaccess_passwd_verification
 Type: password
-_Description: Retype the password for Webserver protection:
- Please retype the same password you previously entered.
+_Description: Re-enter password to verify:
+ Please enter the same user password again to verify you have typed it
+ correctly.
 

This template has been taken directly from D-I. Very common template
when asking for password confirmation. It will allow lazy translators
to steal D-I translations (getting it back from our translation
software, with translation memory features).

 
 Template: mantis/htaccess_password_invalid
 Type: note
-_Description: Provided password is invalid:
- Password mismatch or is blank. Please enter again the password.
+_Description: Password input error
+ The two passwords you entered were empty or not the same. Please try again.

Nearly identical to the same template in D-I.
 
 
 Template: mantis/reload_webserver
 Type: boolean
-_Description: Webserver restart:
- Do you want to restart the webserver after installation?
+_Description: Restart web server after Mantis installation?
+ In order to activate Mantis, the web server should be
+ restarted. Please choose whether you want to do this now or if you
+ prefer restarting it manually.

Revamped. Indeed some other packages have similar debconf
templates. We might want to re-use them
 
 
 Template: mantis/installation_summary
 Type: note
-_Description: Installation complete:
- Mantis software has been installed on your system but still may
+_Description: Installation complete
+ Mantis has been installed on this system but still may
  require further configuration.
  .
- Please, read /usr/share/doc/mantis/README.Debian file carefully. 
+ Please read /usr/share/doc/mantis/README.Debian carefully. 
  .
- Point your browser to  http://<yourhost>/mantis/admin/install.php
- in order to install or update your database and follow the instructions. 
+ You should point your browser to
+ http://<yourhost>/mantis/admin/install.php in order to install or
+ update the Mantis database.

Oh. This one is (IMHO) a no-no. This is one of those bad bad bad
debconf notes that should NOT be used. See debconf-devel(7). In case
you insist, I reworded it but I'd prefer recommeding dropping
it. Debconf notes are Evil..:-)
 
 
 Template: mantis/uninstall_note
 Type: note
-_Description: Important uninstall note:
- Mantis database is no longer automatically removed.
+_Description: Mantis database no longer removed when uninstalling
+ The Mantis database is no longer automatically removed when the
+ package is removed.
  .
- Remember to manually remove your database and user privileges.
-
+ If you want to drop this database, you have to do it manually later on.

And that one is debatable, too. Though a little bit less.


Template: mantis/webserver
Type: select
__Choices: apache2
Default: apache2
_Description: Webserver to configure for Mantis:
 Please choose the web server that should be automatically configured
 to run Mantis on this system.


Template: mantis/htaccess_user
Type: string
Default: admin
_Description: Mantis server administration user name:
 For security reasons, Mantis administration directory needs to be
 restricted to a user name defined in an .htaccess file.
 .
 Please enter the desired user name.


Template: mantis/htaccess_passwd
Type: password
_Description: Mantis server administration password:
 Please enter the desired password for Mantis administration.


Template: mantis/htaccess_passwd_verification
Type: password
_Description: Re-enter password to verify:
 Please enter the same user password again to verify you have typed it
 correctly.


Template: mantis/htaccess_password_invalid
Type: note
_Description: Password input error
 The two passwords you entered were empty or not the same. Please try again.


Template: mantis/reload_webserver
Type: boolean
_Description: Restart web server after Mantis installation?
 In order to activate Mantis, the web server should be
 restarted. Please choose whether you want to do this now or if you
 prefer restarting it manually.


Template: mantis/installation_summary
Type: note
_Description: Installation complete
 Mantis has been installed on this system but still may
 require further configuration.
 .
 Please read /usr/share/doc/mantis/README.Debian carefully. 
 .
 You should point your browser to
 http://<yourhost>/mantis/admin/install.php in order to install or
 update the Mantis database.


Template: mantis/uninstall_note
Type: note
_Description: Mantis database no longer removed when uninstalling
 The Mantis database is no longer automatically removed when the
 package is removed.
 .
 If you want to drop this database, you have to do it manually later on.
--- mantis.templates	2011-05-24 06:56:39.656680627 +0200
+++ mantis.templates.bubulle	2011-05-24 07:05:35.682710609 +0200
@@ -1,63 +1,66 @@
 Template: mantis/webserver
 Type: select
-Choices: apache2
+__Choices: apache2
 Default: apache2
 _Description: Webserver to configure for Mantis:
  Please choose the web server that should be automatically configured
- to run Mantis on your system.
+ to run Mantis on this system.
 
 
 Template: mantis/htaccess_user
 Type: string
 Default: admin
-_Description: Set the username for Webserver protection:
- For security reasons the shipped /admin directory needs to be
- protected with .htaccess file. The installation process is
- about to create this file automatically.
+_Description: Mantis server administration user name:
+ For security reasons, Mantis administration directory needs to be
+ restricted to a user name defined in an .htaccess file.
  .
- Please enter the desired username for Webserver protection.
+ Please enter the desired user name.
 
 
 Template: mantis/htaccess_passwd
 Type: password
-_Description: Set a password for Webserver protection:
- Please enter the desired password for Webserver protection.
+_Description: Mantis server administration password:
+ Please enter the desired password for Mantis administration.
 
 
 Template: mantis/htaccess_passwd_verification
 Type: password
-_Description: Retype the password for Webserver protection:
- Please retype the same password you previously entered.
+_Description: Re-enter password to verify:
+ Please enter the same user password again to verify you have typed it
+ correctly.
 
 
 Template: mantis/htaccess_password_invalid
 Type: note
-_Description: Provided password is invalid:
- Password mismatch or is blank. Please enter again the password.
+_Description: Password input error
+ The two passwords you entered were empty or not the same. Please try again.
 
 
 Template: mantis/reload_webserver
 Type: boolean
-_Description: Webserver restart:
- Do you want to restart the webserver after installation?
+_Description: Restart web server after Mantis installation?
+ In order to activate Mantis, the web server should be
+ restarted. Please choose whether you want to do this now or if you
+ prefer restarting it manually.
 
 
 Template: mantis/installation_summary
 Type: note
-_Description: Installation complete:
- Mantis software has been installed on your system but still may
+_Description: Installation complete
+ Mantis has been installed on this system but still may
  require further configuration.
  .
- Please, read /usr/share/doc/mantis/README.Debian file carefully. 
+ Please read /usr/share/doc/mantis/README.Debian carefully. 
  .
- Point your browser to  http://<yourhost>/mantis/admin/install.php
- in order to install or update your database and follow the instructions. 
+ You should point your browser to
+ http://<yourhost>/mantis/admin/install.php in order to install or
+ update the Mantis database.
 
 
 Template: mantis/uninstall_note
 Type: note
-_Description: Important uninstall note:
- Mantis database is no longer automatically removed.
+_Description: Mantis database no longer removed when uninstalling
+ The Mantis database is no longer automatically removed when the
+ package is removed.
  .
- Remember to manually remove your database and user privileges.
-
+ If you want to drop this database, you have to do it manually later on.

Attachment: signature.asc
Description: Digital signature


Reply to: