Please find, for review, the debconf templates and packages descriptions for the phamm source package.
This review will last from Monday, January 07, 2008 to Thursday, January 17, 2008.
Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.
Your review should be sent as an answer to this mail.
When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.
When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.
Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.
Rationale:
--- ../phamm.old/debian/phamm.templates 2007-12-29 08:25:51.425700293 +0100
+++ debian/phamm.templates 2008-01-03 07:51:24.369518977 +0100
@@ -1,51 +1,49 @@
Template: phamm/ldap-server
Type: string
-_description: LDAP server host address:
+Default: 127.0.0.1
+_Description: LDAP server host:
Please enter the host name or the address of the LDAP server you want to
connect to.
-Default: 127.0.0.1
Re-order fields in a more natural order. That is not mandatory, but
this is common practice for all other packages. For the same reason, I
propose capitalizing "Description"
Remove "address" as the user is also allowed to enter a host name.
Template: phamm/ldap-basedn
Type: string
-_description: Distinguished name of the search base:
+Default: dc=example,dc=tld
+_Description: Distinguished name of the search base:
Please enter the distinguished name of the LDAP search base. Many sites
use the components of their domain names for this purpose. For example,
- the domain "example.com" would use "dc=example,dc=com" as the
- distinguished name of the search base.
-Default: dc=example,dc=tld
+ the domain "example.com" would use "dc=example,dc=com".
Avoid repetition
Template: phamm/ldap-binddn
Type: string
-_description: Login dn for the LDAP server:
- Enter the name of the account that will be used to log in to the LDAP
+Default: cn=manager,dc=example,dc=tld
+_Description: Login DN for the LDAP server:
+ Please enter the name of the account that will be used to log in to the LDAP
server. If you chose a form based authentication this will be the default
- login dn. In this case you can also leave it empty, if you do not want a
+ login DN. In this case you can also leave it empty, if you do not want a
default one.
-Default: cn=manager,dc=example,dc=tld
"DN" is an acronym, so capitalized.
Template: phamm/ldap-bindpw
-Type: string
-_description: Login password for the LDAP server:
- Enter the password that will be used to log in to the LDAP server.
+Type: password
Default: secret
+_Description: Login password for the LDAP server:
+ Please enter the password that will be used to login to the LDAP server.
Common wording for such long description ("Please foo").
Template: phamm/plugins
Type: multiselect
-_description: Which plugins you want Phamm supports:
-_Choices: mail, alias, ftp, person, proxy
-Default: mail
+__Choices: mail, alias, ftp, person, proxy
+_Default: mail
+_Description: Plugins to be supported by Phamm:
Do not use a pseudo-question as prompt.
Split Choices in multiple strings to help translators (see "man po-debconf")
Template: phamm/reconfigure-webserver
Type: multiselect
-_description: Web server which will be reconfigured automatically:
+Choices: apache, apache-ssl, apache-perl, apache2
+Default: apache, apache-ssl, apache-perl, apache2
+_Description: Web server to reconfigure automatically:
Phamm supports any web server that PHP does, but this automatic
configuration process only supports Apache.
-_Choices: apache, apache-ssl, apache-perl, apache2
-Default: apache, apache-ssl, apache-perl, apache2
Choices are untranslatable.
That template is debatable: there are no longer "apache-perl",
"apache-ssl" packages. All packages that were doing such promprint
have removed it.
Template: phamm/restart-webserver
Type: boolean
-_description: Restart of your webserver(s)?
- Remember that in order to apply the changes your webserver(s) has/have to
- be restarted.
Default: true
+_Description: Restart the webserver(s)?
+ In order to apply the changes, the webserver(s) must be restarted.
Avoid "Remember that". The point is not the user remembering it, it is
about asking whether (s)he wants to do it.
--- ../phamm.old/debian/control 2007-12-29 08:25:51.425700293 +0100
+++ debian/control 2008-01-03 07:54:14.861058959 +0100
@@ -8,15 +8,21 @@
Package: phamm
Architecture: all
Depends: apache2 | httpd, php5-ldap | php4-ldap, libapache2-mod-php5 | libapache-mod-php5 | php5-cgi | php5 | libapache2-mod-php4 | libapache-mod-php4 | php4 (>= 4.1.0) | php4-cgi, debconf (>= 0.5) | debconf-2.0, ${misc:Depends}
-Description: a PHP front-end to manage virtual services using LDAP
+Description: PHP front-end to manage virtual services using LDAP - main package
Remove leading article.
Standardize on "common description - specific description"
format. Same change all over the binary packages.
Phamm provides an useful PHP front-end with multi-role access to manage
- virtual services using a LDAP backend. Phamm works with a plug-in system,
- the typical service is a mail server with virtual mail domain support
- but other plug-ins are available (ftp, proxy...). It is easy create or
- customize existing plug-ins for Phamm using XML descriptor files.
+ virtual services using a LDAP backend.
+ .
+ Phamm works with a plug-in system: the typical service is a mail
+ server with virtual mail domain support but other plug-ins are
+ available (ftp, proxy...). The creation of new plugins or the
+ customization of existing ones are made easy by the use of XML
+ descriptor files.
Split in two paragraphs (the first will be re-used in the other binary
package) and use better typography in the last one.
"It is easy create" was obviously incorrect and I reverted it to
active voice.
Package: phamm-ldap
Architecture: all
Depends: gnarwl
-Description: Phamm LDAP backend files
- Phamm backend require own phamm.schema and custom ACL.
+Description: PHP front-end to manage virtual services using LDAP - LDAP backend files
+ Phamm provides an useful PHP front-end with multi-role access to manage
+ virtual services using a LDAP backend.
+ .
+ This package provides Phamm's own LDAP schema file and custom ACL.
Add a common paragraph to explain what phamm is.
--
Template: phamm/ldap-server Type: string Default: 127.0.0.1 _Description: LDAP server host: Please enter the host name or the address of the LDAP server you want to connect to. Template: phamm/ldap-basedn Type: string Default: dc=example,dc=tld _Description: Distinguished name of the search base: Please enter the distinguished name of the LDAP search base. Many sites use the components of their domain names for this purpose. For example, the domain "example.com" would use "dc=example,dc=com". Template: phamm/ldap-binddn Type: string Default: cn=manager,dc=example,dc=tld _Description: Login DN for the LDAP server: Please enter the name of the account that will be used to log in to the LDAP server. If you chose a form based authentication this will be the default login DN. In this case you can also leave it empty, if you do not want a default one. Template: phamm/ldap-bindpw Type: password Default: secret _Description: Login password for the LDAP server: Please enter the password that will be used to login to the LDAP server. Template: phamm/plugins Type: multiselect __Choices: mail, alias, ftp, person, proxy _Default: mail _Description: Plugins to be supported by Phamm: Template: phamm/reconfigure-webserver Type: multiselect Choices: apache, apache-ssl, apache-perl, apache2 Default: apache, apache-ssl, apache-perl, apache2 _Description: Web server to reconfigure automatically: Phamm supports any web server that PHP does, but this automatic configuration process only supports Apache. Template: phamm/restart-webserver Type: boolean Default: true _Description: Restart the webserver(s)? In order to apply the changes, the webserver(s) must be restarted.
--- ../phamm.old/debian/phamm.templates 2007-12-29 08:25:51.425700293 +0100
+++ debian/phamm.templates 2008-01-03 07:51:24.369518977 +0100
@@ -1,51 +1,49 @@
Template: phamm/ldap-server
Type: string
-_description: LDAP server host address:
+Default: 127.0.0.1
+_Description: LDAP server host:
Please enter the host name or the address of the LDAP server you want to
connect to.
-Default: 127.0.0.1
Template: phamm/ldap-basedn
Type: string
-_description: Distinguished name of the search base:
+Default: dc=example,dc=tld
+_Description: Distinguished name of the search base:
Please enter the distinguished name of the LDAP search base. Many sites
use the components of their domain names for this purpose. For example,
- the domain "example.com" would use "dc=example,dc=com" as the
- distinguished name of the search base.
-Default: dc=example,dc=tld
+ the domain "example.com" would use "dc=example,dc=com".
Template: phamm/ldap-binddn
Type: string
-_description: Login dn for the LDAP server:
- Enter the name of the account that will be used to log in to the LDAP
+Default: cn=manager,dc=example,dc=tld
+_Description: Login DN for the LDAP server:
+ Please enter the name of the account that will be used to log in to the LDAP
server. If you chose a form based authentication this will be the default
- login dn. In this case you can also leave it empty, if you do not want a
+ login DN. In this case you can also leave it empty, if you do not want a
default one.
-Default: cn=manager,dc=example,dc=tld
Template: phamm/ldap-bindpw
-Type: string
-_description: Login password for the LDAP server:
- Enter the password that will be used to log in to the LDAP server.
+Type: password
Default: secret
+_Description: Login password for the LDAP server:
+ Please enter the password that will be used to login to the LDAP server.
Template: phamm/plugins
Type: multiselect
-_description: Which plugins you want Phamm supports:
-_Choices: mail, alias, ftp, person, proxy
-Default: mail
+__Choices: mail, alias, ftp, person, proxy
+_Default: mail
+_Description: Plugins to be supported by Phamm:
Template: phamm/reconfigure-webserver
Type: multiselect
-_description: Web server which will be reconfigured automatically:
+Choices: apache, apache-ssl, apache-perl, apache2
+Default: apache, apache-ssl, apache-perl, apache2
+_Description: Web server to reconfigure automatically:
Phamm supports any web server that PHP does, but this automatic
configuration process only supports Apache.
-_Choices: apache, apache-ssl, apache-perl, apache2
-Default: apache, apache-ssl, apache-perl, apache2
Template: phamm/restart-webserver
Type: boolean
-_description: Restart of your webserver(s)?
- Remember that in order to apply the changes your webserver(s) has/have to
- be restarted.
Default: true
+_Description: Restart the webserver(s)?
+ In order to apply the changes, the webserver(s) must be restarted.
--- ../phamm.old/debian/control 2007-12-29 08:25:51.425700293 +0100
+++ debian/control 2008-01-03 07:54:14.861058959 +0100
@@ -8,15 +8,21 @@
Package: phamm
Architecture: all
Depends: apache2 | httpd, php5-ldap | php4-ldap, libapache2-mod-php5 | libapache-mod-php5 | php5-cgi | php5 | libapache2-mod-php4 | libapache-mod-php4 | php4 (>= 4.1.0) | php4-cgi, debconf (>= 0.5) | debconf-2.0, ${misc:Depends}
-Description: a PHP front-end to manage virtual services using LDAP
+Description: PHP front-end to manage virtual services using LDAP - main package
Phamm provides an useful PHP front-end with multi-role access to manage
- virtual services using a LDAP backend. Phamm works with a plug-in system,
- the typical service is a mail server with virtual mail domain support
- but other plug-ins are available (ftp, proxy...). It is easy create or
- customize existing plug-ins for Phamm using XML descriptor files.
+ virtual services using a LDAP backend.
+ .
+ Phamm works with a plug-in system: the typical service is a mail
+ server with virtual mail domain support but other plug-ins are
+ available (ftp, proxy...). The creation of new plugins or the
+ customization of existing ones are made easy by the use of XML
+ descriptor files.
Package: phamm-ldap
Architecture: all
Depends: gnarwl
-Description: Phamm LDAP backend files
- Phamm backend require own phamm.schema and custom ACL.
+Description: PHP front-end to manage virtual services using LDAP - LDAP backend files
+ Phamm provides an useful PHP front-end with multi-role access to manage
+ virtual services using a LDAP backend.
+ .
+ This package provides Phamm's own LDAP schema file and custom ACL.
Source: phamm
Section: web
Priority: extra
Maintainer: Alessandro De Zorzi <lota@nonlontano.it>
Build-Depends: debhelper (>= 5), po-debconf
Standards-Version: 3.7.2
Package: phamm
Architecture: all
Depends: apache2 | httpd, php5-ldap | php4-ldap, libapache2-mod-php5 | libapache-mod-php5 | php5-cgi | php5 | libapache2-mod-php4 | libapache-mod-php4 | php4 (>= 4.1.0) | php4-cgi, debconf (>= 0.5) | debconf-2.0, ${misc:Depends}
Description: PHP front-end to manage virtual services using LDAP - main package
Phamm provides an useful PHP front-end with multi-role access to manage
virtual services using a LDAP backend.
.
Phamm works with a plug-in system: the typical service is a mail
server with virtual mail domain support but other plug-ins are
available (ftp, proxy...). The creation of new plugins or the
customization of existing ones are made easy by the use of XML
descriptor files.
Package: phamm-ldap
Architecture: all
Depends: gnarwl
Description: PHP front-end to manage virtual services using LDAP - LDAP backend files
Phamm provides an useful PHP front-end with multi-role access to manage
virtual services using a LDAP backend.
.
This package provides Phamm's own LDAP schema file and custom ACL.
Attachment:
signature.asc
Description: Digital signature