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

[RFR] templates://webcalendar/{webcalendar.templates}



Please find, for review, the debconf templates of webcalendar.

This review will last from Saturday, April 21, 2007 to Tuesday, May 01, 2007.

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.

Some rationale:

General: I have a doubt about "multiuser" vs "multi-user". I would
personnally prefer "multi-user" if English uses the same conventions
than French for such constructions of words (use a hyphen between two
vowels but no hyphens between a vowel and a consonant).

 _Description: Use persistent connections?
- Using persistent connections can improve performance on heavily loaded
- websites by using a previously opened sql connection.
+ Using persistent connections can improve the performance on heavily loaded
+ websites by using a previously opened SQL connection.

Acronym, thus capitals.
 
 Template: webcalendar/conf/use_http_auth
 Type: boolean
 Default: false
-_Description: Use HTTP auth?
- Webcalendar by default uses the database's webcal_user table for
- authenticating users.  You can use HTTP auth logins instead and use Apache
- to manage logins but will still have to add users to webcalendar.
+_Description: Use HTTP authentication?
+ WebCalendar by default uses the database's webcal_user table for
+ authenticating users. You can use HTTP authentication logins
+ instead and use Apache to manage logins. That will still require adding
+ the users to WebCalendar.

s/auth/authentication: avoid "jargon"

"WebCalendar" spelled this way everywhere for consistency.

Split the sentence in two....well, I feel this sounds better..:-)

 
 Template: webcalendar/conf/single_user_mode
 Type: boolean
 Default: false
-_Description: Should webcalendar be installed in single user mode?
- Webcalendar can be installed in single user mode or multiuser mode. If it
- is installed in single user mode, you won't need to login.  It isn't
- recommended that you install in single user mode unless you are running
- this on a personal server protected by a firewall.
+_Description: Should WebCalendar be installed in single user mode?
+ WebCalendar can be installed in single user mode or multiuser mode. If it
+ is installed in single user mode, no login will be required.
+ . 
+ Using the single user mode is not recommended unless the software runs
+ on a personal server protected by a firewall.

Split paragraphs for readability.

Change the "you won't need to login" to something more neutral

 
 Template: webcalendar/conf/single_user_login
 Type: string
-_Description: Name of the webcalendar user:
- If you have installed webcalendar in single user mode, you need to specify
+_Description: Name of the WebCalendar user:
+ If WebCalendar is installed in single user mode, you need to specify
  the name of the user to connect as.

Again, neutral wording..:)
 
 Template: webcalendar/status/debconf_managed
 Type: boolean
 Default: true
-_Description: Allow debconf to manage settings.conf?
- You can allow debconf to manage your settings.conf or you can manage your
- settings manually.
+_Description: Manage settings.conf automatically?
+ The configuration program for the package can manage the settings.conf
+ file but you may prefer managing your settings yourself.

Avoid a specific reference to debconf (users are not necessarily aware
that the tool asking them the questions is named "debconf").

 
 Template: webcalendar/note/admin_user
 Type: note
-_Description: Webcalendar administrative user
- After installing the tables for your sql database you will have access to
- webcalendar using the standard admin user.  It is STRONGLY suggested that
- you change the password after logging in. The default login and password
- is admin:admin.
+_Description: Password change needed for the WebCalendar administrative user
+ After installing the tables for the SQL database you will have access
+ to WebCalendar using the standard administrative user. It is STRONGLY
+ suggested that you change the password after logging in.
+ .
+ The default login and password are 'admin:admin'.

More precise short description.

I generally don't like debconf notes (IIRC, Raphaël knows about
this..:-))

This is "the" SQL database not necessarily "your"...

Split paragraphs to make the important information more visible

 
@@ -57,8 +60,8 @@
 Type: boolean
 Default: false
 _Description: Should ${webserver} be restarted?
- Remember that in order to activate the new configuration, ${webserver} has
- to be restarted. You can also restart ${webserver} by manually executing
+ In order to activate the new configuration, ${webserver} has to be
+ restarted. You can also restart ${webserver} by manually executing
  'invoke-rc.d ${webserver} restart'.

"Remember that" seems useless to me.

 
 Template: webcalendar/store/webservers_to_be_restarted
--- /home/bubulle/travail/debian/rewrite/INTENT/webcalendar/webcalendar.old/debian/control	2007-04-18 08:07:37.349652306 +0200
+++ /home/bubulle/travail/debian/rewrite/INTENT/webcalendar/webcalendar/debian/control	2007-04-21 11:35:52.803016501 +0200
@@ -18,4 +18,4 @@
  WebCalendar is a PHP-based calendar application that can be configured
  as a single-user calendar, a multi-user calendar for groups of users,
  or as an event calendar viewable by visitors. MySQL, PostgreSQL, Oracle,
- DB2, Interbase, or ODBC is required.
+ DB2, Interbase, or ODBC are required.


I hope that I'm correct here...


Template: webcalendar/conf/db_persistent
Type: boolean
Default: false
_Description: Use persistent connections?
 Using persistent connections can improve the performance on heavily loaded
 websites by using a previously opened SQL connection.

Template: webcalendar/conf/use_http_auth
Type: boolean
Default: false
_Description: Use HTTP authentication?
 WebCalendar by default uses the database's webcal_user table for
 authenticating users. You can use HTTP authentication logins
 instead and use Apache to manage logins. That will still require adding
 the users to WebCalendar.

Template: webcalendar/conf/single_user_mode
Type: boolean
Default: false
_Description: Should WebCalendar be installed in single user mode?
 WebCalendar can be installed in single user mode or multiuser mode. If it
 is installed in single user mode, no login will be required.
 . 
 Using the single user mode is not recommended unless the software runs
 on a personal server protected by a firewall.

Template: webcalendar/conf/single_user_login
Type: string
_Description: Name of the WebCalendar user:
 If WebCalendar is installed in single user mode, you need to specify
 the name of the user to connect as.

Template: webcalendar/status/debconf_managed
Type: boolean
Default: true
_Description: Manage settings.conf automatically?
 The configuration program for the package can manage the settings.conf
 file but you may prefer managing your settings yourself.

Template: webcalendar/note/admin_user
Type: note
_Description: Password change needed for the WebCalendar administrative user
 After installing the tables for the SQL database you will have access
 to WebCalendar using the standard administrative user. It is STRONGLY
 suggested that you change the password after logging in.
 .
 The default login and password are 'admin:admin'.

Template: webcalendar/conf/httpd_conf
Type: multiselect
_Choices: apache2, apache, apache-ssl, apache-perl, other
Default: apache2
_Description: Web server to configure:
 Apache can be automatically configured to use WebCalendar by creating links in
 /etc/{apache-version}/conf.d/. Select all the versions of Apache you would
 like to automatically configure or 'other' if you don't use Apache or plan on
 configuring Apache yourself.

Template: webcalendar/conf/restart_webserver
Type: boolean
Default: false
_Description: Should ${webserver} be restarted?
 In order to activate the new configuration, ${webserver} has to be
 restarted. You can also restart ${webserver} by manually executing
 'invoke-rc.d ${webserver} restart'.

Template: webcalendar/store/webservers_to_be_restarted
Type: string
Description: Webservers to be restarted:
 (This is for internal use only)

--- ../webcalendar.old/debian/webcalendar.templates	2007-04-18 08:07:37.349652306 +0200
+++ debian/webcalendar.templates	2007-04-21 11:35:35.294865312 +0200
@@ -2,54 +2,57 @@
 Type: boolean
 Default: false
 _Description: Use persistent connections?
- Using persistent connections can improve performance on heavily loaded
- websites by using a previously opened sql connection.
+ Using persistent connections can improve the performance on heavily loaded
+ websites by using a previously opened SQL connection.
 
 Template: webcalendar/conf/use_http_auth
 Type: boolean
 Default: false
-_Description: Use HTTP auth?
- Webcalendar by default uses the database's webcal_user table for
- authenticating users.  You can use HTTP auth logins instead and use Apache
- to manage logins but will still have to add users to webcalendar.
+_Description: Use HTTP authentification?
+ WebCalendar by default uses the database's webcal_user table for
+ authenticating users. You can use HTTP authentification logins
+ instead and use Apache to manage logins. That will still require adding
+ the users to WebCalendar.
 
 Template: webcalendar/conf/single_user_mode
 Type: boolean
 Default: false
-_Description: Should webcalendar be installed in single user mode?
- Webcalendar can be installed in single user mode or multiuser mode. If it
- is installed in single user mode, you won't need to login.  It isn't
- recommended that you install in single user mode unless you are running
- this on a personal server protected by a firewall.
+_Description: Should WebCalendar be installed in single user mode?
+ WebCalendar can be installed in single user mode or multiuser mode. If it
+ is installed in single user mode, no login will be required.
+ . 
+ Using the single user mode is not recommended unless the software runs
+ on a personal server protected by a firewall.
 
 Template: webcalendar/conf/single_user_login
 Type: string
-_Description: Name of the webcalendar user:
- If you have installed webcalendar in single user mode, you need to specify
+_Description: Name of the WebCalendar user:
+ If WebCalendar is installed in single user mode, you need to specify
  the name of the user to connect as.
 
 Template: webcalendar/status/debconf_managed
 Type: boolean
 Default: true
-_Description: Allow debconf to manage settings.conf?
- You can allow debconf to manage your settings.conf or you can manage your
- settings manually.
+_Description: Manage settings.conf automatically?
+ The configuration program for the package can manage the settings.conf
+ file but you may prefer managing your settings yourself.
 
 Template: webcalendar/note/admin_user
 Type: note
-_Description: Webcalendar administrative user
- After installing the tables for your sql database you will have access to
- webcalendar using the standard admin user.  It is STRONGLY suggested that
- you change the password after logging in. The default login and password
- is admin:admin.
+_Description: Password change needed for the WebCalendar administrative user
+ After installing the tables for the SQL database you will have access
+ to WebCalendar using the standard administrative user. It is STRONGLY
+ suggested that you change the password after logging in.
+ .
+ The default login and password are 'admin:admin'.
 
 Template: webcalendar/conf/httpd_conf
 Type: multiselect
 _Choices: apache2, apache, apache-ssl, apache-perl, other
 Default: apache2
 _Description: Web server to configure:
- Apache can be automatically configured to use webcalendar by creating links in
- /etc/{apache-version}/conf.d/.  Select all the versions of Apache you would
+ Apache can be automatically configured to use WebCalendar by creating links in
+ /etc/{apache-version}/conf.d/. Select all the versions of Apache you would
  like to automatically configure or 'other' if you don't use Apache or plan on
  configuring Apache yourself.
 
@@ -57,8 +60,8 @@
 Type: boolean
 Default: false
 _Description: Should ${webserver} be restarted?
- Remember that in order to activate the new configuration, ${webserver} has
- to be restarted. You can also restart ${webserver} by manually executing
+ In order to activate the new configuration, ${webserver} has to be
+ restarted. You can also restart ${webserver} by manually executing
  'invoke-rc.d ${webserver} restart'.
 
 Template: webcalendar/store/webservers_to_be_restarted
--- ../webcalendar.old/debian/control	2007-04-18 08:07:37.349652306 +0200
+++ debian/control	2007-04-21 11:35:52.803016501 +0200
@@ -18,4 +18,4 @@
  WebCalendar is a PHP-based calendar application that can be configured
  as a single-user calendar, a multi-user calendar for groups of users,
  or as an event calendar viewable by visitors. MySQL, PostgreSQL, Oracle,
- DB2, Interbase, or ODBC is required.
+ DB2, Interbase, or ODBC are required.
Source: webcalendar
Section: web
Priority: optional
Maintainer: Elizabeth Bevilacqua <lyz@princessleia.com>
Uploaders: Rafael Laboissiere <rafael@debian.org>
Build-Depends: debhelper (>= 4.1.16), po-debconf, dpatch
Build-Depends-Indep: html2text
Standards-Version: 3.7.2
XS-Vcs-Svn: svn://svn.debian.org/svn/collab-maint/ext-maint/webcalendar/
XS-Vcs-Browser: http://svn.debian.org/wsvn/collab-maint/ext-maint/webcalendar/

Package: webcalendar
Architecture: all
Depends: ${misc:Depends}, libapache-mod-php4 | libapache2-mod-php4, php4-mysql | php4-pgsql, apache | apache2 | apache-ssl | apache-perl, ucf (>= 0.28), dbconfig-common
Suggests: php4-cli
Recommends: mysql-client | postgresql-client, mysql-server | postgresql
Description: PHP-Based multi-user calendar
 WebCalendar is a PHP-based calendar application that can be configured
 as a single-user calendar, a multi-user calendar for groups of users,
 or as an event calendar viewable by visitors. MySQL, PostgreSQL, Oracle,
 DB2, Interbase, or ODBC are required.

Attachment: signature.asc
Description: Digital signature


Reply to: