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

[RFR] templates://roxen4/{templates}



Please find, for review, the debconf templates and packages descriptions for the roxen4 source package.

This review will last from Wednesday, December 05, 2007 to Saturday, December 15, 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.

Rationale:
--- ../roxen4.old/debian/templates	2007-11-24 13:43:11.766273058 +0530
+++ debian/templates	2007-11-29 12:16:56.003576019 +0530
@@ -1,123 +1,114 @@
 Template: roxen4/server_name
 Type: string
 Default: Administration Interface
-_Description: Server Configuration Name:
- What name to give to the server?
+_Description: Server name:
+ Please enter the name that should be given to the Roxen server.

Avoid questions in long descriptions (lintian warns about
this...). So, use the wording we standardized over packages.

 
 Template: roxen4/server_url
 Type: string
 _Description: Administration page URL:
- What URL should roxen4 listen to for the administration server. Should be
- something like:
+ Please enter the URL that should be used to access Roxen's administration
+ server. Example:

Ditto

  .
- http://*:1234/
+ http://www.example.com:<port>/

Use the common example.com example domain. Use <port> instead of
arbitrary "1234" as example.

  .
- where '1234' is the port to listen to. A random port has been created
- for you to accept. The likelihood of it being occupied is slim, but
- make sure you want this port before pressing ENTER.
+ where '<port>' is the port to listen to. A random port is proposed
+ by default. It is very probably free for use but you should check this
+ before validating that choice.

The port hasn't been created, indeed.

Reword for (hopefully) slightly better English.

 
 Template: roxen4/admin_user
 Type: string
 Default: administrator
 _Description: Administrator username:
- The name of the administrator.
+ Please enter the username for the Roxen server administrator.

Ditto (here, there was even no sentence in the long description)
 
 Template: roxen4/admin_password
 Type: password
+# Translators: do not translate ${SERVER_ADMIN}
 _Description: Administrator password:
- Please enter a password for the server administrator
- user (which is ${SERVER_ADMIN}).
+ Please choose a password for the Roxen server administrator
+ (${SERVER_ADMIN}).

Mention *what* server admin we're talking about. The password is
"choosen" so let's make it clear that it's up to the suer to decide on
one.
 
 Template: roxen4/admin_password_verification
 Type: password
-_Description: Administrator password verification:
- Please enter the administration password again.
+_Description: Administrator password confirmation:

Standard wording in such case. No real need to repeat the very same
thing in the long description.
 
 Template: roxen4/admin_password_missing
-Type: note
+Type: error
 _Description: Empty administrator password
- Unable to accept an empty password!

Avoid exclam mark in descriptions. Anyway, the title and the style
switched to "error" should make it clear that empty passwords are not
an option.
 
 Template: roxen4/update_system
 Type: boolean
 Default: false
 _Description: Enable built-in update system?
- You may enable the automatic update system. This requires an account in the Roxen
- Community.
+ Roxen offers an automatic update system. To use this feature, you need
+ an account in the Roxen Community.

Repeat what automated update we're talking about. May be useful if roxen4 is installed along with other packages.
 
 Template: roxen4/update_system_proxy
 Type: boolean
 Default: false
 _Description: Access update server through proxy?
- This option allows you to access the update server through an HTTP proxy.
+ Please choose whether the update server should be accessed through
+ an HTTP proxy.

Standard wording
 
 Template: roxen4/proxy_host
 Type: string
-_Description: Proxy host:
- Host to use as proxy for the connection to the Roxen Community.
+_Description: Proxy server hostname:
 
 Template: roxen4/proxy_port
 Type: string
-_Description: Proxy port:
- Port for the HTTP proxy
+_Description: Proxy server port:

Again, the long description adds no value here
 
 Template: roxen4/proxy_value_missing
-Type: note
-_Description: Missing proxy host/port value
- If you specify that you want to use a HTTP proxy to connect via when
- connecting to the Roxen Community, you MUST specify a value! Do over.
+Type: error
+_Description: Empty proxy host or port

The former long description was using a non neutral wording (refer to
user actions). As the added value is low, I think it can be removed.
 
 Template: roxen4/community_identity
 Type: string
 _Description: Roxen Community identity:
- Give your Roxen Community identity (your e-mail).
+ Please enter your Roxen Community identity (e-mail address).
  .
- Enter 'none' to disable the automatic update system.
+ Entering 'none' will disable the automatic update system.

Standardize, again.

 
 Template: roxen4/community_identity_missing
-Type: note
+Type: error
 _Description: Missing community identity
- You MUST give a community id to be able to use the automatic update
- facility. Do over.
+ A community identity is mandatory to be able to use the automatic update
+ facility.

More neutral wording.

 
 Template: roxen4/community_password
 Type: password
 _Description: Roxen Community password:
- Password for the Roxen Community.

Same than above.
 
 Template: roxen4/community_password_verification
 Type: password
-_Description: Roxen Community password verification:
- Please enter the Community password again.
+_Description: Roxen Community password confirmation:
 
 Template: roxen4/password_missmatch
-Type: note
-_Description: Passwords don't match
+Type: error
+_Description: Passwords mismatch
+ The password and its confirmation do not match.

Standard "password mismatch" template.
 
 Template: roxen4/previous_installation_roxen2
 Type: note
-_Description: Previous installation (Roxen2) detected
- Roxe 2 seems to be installed. As many values as possible will be taken from
- this configuration, but you still have to give SOME your self. Mostly
- passwords, since they are encrypted and can't be decrypted easily...
- .
- You still have to MANUALLY move any configurations you have for Roxen2 to
- your new Roxen4 server (they CAN coexist as long as you don't use the
- same ports)...
+_Description: Roxen 2 installation detected
+ Roxen 2 appears to be installed on this host. As many values as
+ possible will be taken from this configuration, but some will need
+ manual intervention, such as passwords.
+ .
+ Both Roxen 2 and Roxen 4 can coexist on the same server as long as
+ they use different ports.
  .
- The administration port is the same as the Roxen2 installation but plus
- one (ie, ${SERVER_URL}).
+ Roxen 4 is the port that immediately follows Roxen 2 port (${SERVER_URL}).

More neutral wording (no caps, no direct reference to user's actions, etc.)

 
 Template: roxen4/previous_installation_roxen3
 Type: note
-_Description: Previous installation (Roxen3) detected
- Roxen3 seems to be installed. As many values as possible will be taken from
- this configuration, but you still have to give SOME your self. Mostly
- passwords, since they are encrypted and can't be decrypted easily...
- .
- You still have to MANUALLY move any configurations you have for Roxen 3 to
- your new Roxen 4 server (they CAN coexist as long as you don't use the
- same ports)...
+_Description: Roxen 3 installation detected
+ Roxen 3 appears to be installed on this host. As many values as
+ possible will be taken from this configuration, but some will need
+ manual intervention, such as passwords.
+ .
+ Both Roxen 3 and Roxen 4 can coexist on the same server as long as
+ they use different ports.
  .
- The administration port is the same as the Roxen2 installation but plus
- one (ie, ${SERVER_URL}).
+ Roxen 4 is the port that immediately follows Roxen 3 port (${SERVER_URL}).

Same changes

--- ../roxen4.old/debian/control	2007-11-24 13:43:11.766273058 +0530
+++ debian/control	2007-11-29 12:21:09.490432436 +0530
@@ -13,29 +13,24 @@
 Provides: httpd, httpd-cgi, roxen3
 Replaces: roxen3
 Conflicts: roxen3
-Description: The Roxen Challenger Webserver
+Description: Roxen Challenger web server - binaries

Standard "Common description - specific description" style

  The Roxen Challenger is a very powerful and easy to maintain web
  server. The server is written in Pike which is C-like but interpreted
- at runtime. Roxen may be configured comfortable via any web browser.
+ at runtime. Roxen may be configured via any web browser.

Sounds like incorrect English. Anyway "comfortable" is not really
neutral and factual so can be ommitted.

  .
  The Roxen Challenger server is the foundation of a powerful
  information and communication environment. Challenger is a secure and
- competent web server. If your intention is minimizing your Total Cost
- of Ownership, Challenger is entirely in line. Challenger offers a
- smorgasbord of features, and on top of that, a whole suite of
- commercial and tightly integrated extensions. Challenger is just as
- suitable for powering an any-sized web site, as for an intranet
+ competent web server. Challenger offers
+ numerous features including a whole suite of
+ commercial and tightly integrated extensions. Challenger is also
+ suitable for powering any web site or intranet
  application.

I'm unsure about "competent"....

Again, "neutralize" the wording.

  .
- This is the official version of the new 'Roxen WebServer' (the new
- name of the webserver). This is still a beta release and the old
- configuration files of the server is not fully compatible with this
- version. There will be a conversion script in a later version, but
- until then I'm installing in .../roxen4/ without any automatic config
- transference. You will have to configure the server manually... You
- can still have both the stable (1.3 and 2.1) versions, since they
- don't clash (at least not filesystem wise), but make sure they don't
- try to talk/listen on the same ports!
+ This package provides the official version of 'Roxen WebServer'.
+ Configuration files for older server versions are not fully compatible
+ with this version. Several parts of the server must be configured or
+ migrated manually. The new version can coexist with former versions on
+ the same host.

Many parts of the former descriptions were not really suitable for a
package description but more for a README.Debian file. Removing them.
 
 Package: roxen4-doc
 Architecture: all
@@ -44,5 +39,17 @@
 Replaces: roxen3-doc
 Conflicts: roxen3-doc
 Depends: roxen4
-Description: Roxen 4.0 documentation
- Documentation for the Roxen Webserver, v4.0.
+Description: Roxen Challenger web server - documentation
+ The Roxen Challenger is a very powerful and easy to maintain web
+ server. The server is written in Pike which is C-like but interpreted
+ at runtime. Roxen may be configured via any web browser.
+ .
+ The Roxen Challenger server is the foundation of a powerful
+ information and communication environment. Challenger is a secure and
+ competent web server. Challenger offers
+ numerous features including a whole suite of
+ commercial and tightly integrated extensions. Challenger is also
+ suitable for powering any web site or intranet
+ application.

Add descriptions of Roxen to that package, too. That helps users who
could come on this package without reference to the binaries package

+ .
+ This package provides the server's documentation.

-- 


Template: roxen4/server_name
Type: string
Default: Administration Interface
_Description: Server name:
 Please enter the name that should be given to the Roxen server.

Template: roxen4/server_url
Type: string
_Description: Administration page URL:
 Please enter the URL that should be used to access Roxen's administration
 server. Example:
 .
 http://www.example.com:<port>/
 .
 where '<port>' is the port to listen to. A random port is proposed
 by default. It is very probably free for use but you should check this
 before validating that choice.

Template: roxen4/admin_user
Type: string
Default: administrator
_Description: Administrator username:
 Please enter the username for the Roxen server administrator.

Template: roxen4/admin_password
Type: password
# Translators: do not translate ${SERVER_ADMIN}
_Description: Administrator password:
 Please choose a password for the Roxen server administrator
 (${SERVER_ADMIN}).

Template: roxen4/admin_password_verification
Type: password
_Description: Administrator password confirmation:

Template: roxen4/admin_password_missing
Type: error
_Description: Empty administrator password

Template: roxen4/update_system
Type: boolean
Default: false
_Description: Enable built-in update system?
 Roxen offers an automatic update system. To use this feature, you need
 an account in the Roxen Community.

Template: roxen4/update_system_proxy
Type: boolean
Default: false
_Description: Access update server through proxy?
 Please choose whether the update server should be accessed through
 an HTTP proxy.

Template: roxen4/proxy_host
Type: string
_Description: Proxy server hostname:

Template: roxen4/proxy_port
Type: string
_Description: Proxy server port:

Template: roxen4/proxy_value_missing
Type: error
_Description: Empty proxy host or port

Template: roxen4/community_identity
Type: string
_Description: Roxen Community identity:
 Please enter your Roxen Community identity (e-mail address).
 .
 Entering 'none' will disable the automatic update system.

Template: roxen4/community_identity_missing
Type: error
_Description: Missing community identity
 A community identity is mandatory to be able to use the automatic update
 facility.

Template: roxen4/community_password
Type: password
_Description: Roxen Community password:

Template: roxen4/community_password_verification
Type: password
_Description: Roxen Community password confirmation:

Template: roxen4/password_missmatch
Type: error
_Description: Passwords mismatch
 The password and its confirmation do not match.

Template: roxen4/previous_installation_roxen2
Type: note
_Description: Roxen 2 installation detected
 Roxen 2 appears to be installed on this host. As many values as
 possible will be taken from this configuration, but some will need
 manual intervention, such as passwords.
 .
 Both Roxen 2 and Roxen 4 can coexist on the same server as long as
 they use different ports.
 .
 Roxen 4 is the port that immediately follows Roxen 2 port (${SERVER_URL}).

Template: roxen4/previous_installation_roxen3
Type: note
_Description: Roxen 3 installation detected
 Roxen 3 appears to be installed on this host. As many values as
 possible will be taken from this configuration, but some will need
 manual intervention, such as passwords.
 .
 Both Roxen 3 and Roxen 4 can coexist on the same server as long as
 they use different ports.
 .
 Roxen 4 is the port that immediately follows Roxen 3 port (${SERVER_URL}).
--- ../roxen4.old/debian/templates	2007-11-24 13:43:11.766273058 +0530
+++ debian/templates	2007-11-29 12:16:56.003576019 +0530
@@ -1,123 +1,114 @@
 Template: roxen4/server_name
 Type: string
 Default: Administration Interface
-_Description: Server Configuration Name:
- What name to give to the server?
+_Description: Server name:
+ Please enter the name that should be given to the Roxen server.
 
 Template: roxen4/server_url
 Type: string
 _Description: Administration page URL:
- What URL should roxen4 listen to for the administration server. Should be
- something like:
+ Please enter the URL that should be used to access Roxen's administration
+ server. Example:
  .
- http://*:1234/
+ http://www.example.com:<port>/
  .
- where '1234' is the port to listen to. A random port has been created
- for you to accept. The likelihood of it being occupied is slim, but
- make sure you want this port before pressing ENTER.
+ where '<port>' is the port to listen to. A random port is proposed
+ by default. It is very probably free for use but you should check this
+ before validating that choice.
 
 Template: roxen4/admin_user
 Type: string
 Default: administrator
 _Description: Administrator username:
- The name of the administrator.
+ Please enter the username for the Roxen server administrator.
 
 Template: roxen4/admin_password
 Type: password
+# Translators: do not translate ${SERVER_ADMIN}
 _Description: Administrator password:
- Please enter a password for the server administrator
- user (which is ${SERVER_ADMIN}).
+ Please choose a password for the Roxen server administrator
+ (${SERVER_ADMIN}).
 
 Template: roxen4/admin_password_verification
 Type: password
-_Description: Administrator password verification:
- Please enter the administration password again.
+_Description: Administrator password confirmation:
 
 Template: roxen4/admin_password_missing
-Type: note
+Type: error
 _Description: Empty administrator password
- Unable to accept an empty password!
 
 Template: roxen4/update_system
 Type: boolean
 Default: false
 _Description: Enable built-in update system?
- You may enable the automatic update system. This requires an account in the Roxen
- Community.
+ Roxen offers an automatic update system. To use this feature, you need
+ an account in the Roxen Community.
 
 Template: roxen4/update_system_proxy
 Type: boolean
 Default: false
 _Description: Access update server through proxy?
- This option allows you to access the update server through an HTTP proxy.
+ Please choose whether the update server should be accessed through
+ an HTTP proxy.
 
 Template: roxen4/proxy_host
 Type: string
-_Description: Proxy host:
- Host to use as proxy for the connection to the Roxen Community.
+_Description: Proxy server hostname:
 
 Template: roxen4/proxy_port
 Type: string
-_Description: Proxy port:
- Port for the HTTP proxy
+_Description: Proxy server port:
 
 Template: roxen4/proxy_value_missing
-Type: note
-_Description: Missing proxy host/port value
- If you specify that you want to use a HTTP proxy to connect via when
- connecting to the Roxen Community, you MUST specify a value! Do over.
+Type: error
+_Description: Empty proxy host or port
 
 Template: roxen4/community_identity
 Type: string
 _Description: Roxen Community identity:
- Give your Roxen Community identity (your e-mail).
+ Please enter your Roxen Community identity (e-mail address).
  .
- Enter 'none' to disable the automatic update system.
+ Entering 'none' will disable the automatic update system.
 
 Template: roxen4/community_identity_missing
-Type: note
+Type: error
 _Description: Missing community identity
- You MUST give a community id to be able to use the automatic update
- facility. Do over.
+ A community identity is mandatory to be able to use the automatic update
+ facility.
 
 Template: roxen4/community_password
 Type: password
 _Description: Roxen Community password:
- Password for the Roxen Community.
 
 Template: roxen4/community_password_verification
 Type: password
-_Description: Roxen Community password verification:
- Please enter the Community password again.
+_Description: Roxen Community password confirmation:
 
 Template: roxen4/password_missmatch
-Type: note
-_Description: Passwords don't match
+Type: error
+_Description: Passwords mismatch
+ The password and its confirmation do not match.
 
 Template: roxen4/previous_installation_roxen2
 Type: note
-_Description: Previous installation (Roxen2) detected
- Roxe 2 seems to be installed. As many values as possible will be taken from
- this configuration, but you still have to give SOME your self. Mostly
- passwords, since they are encrypted and can't be decrypted easily...
- .
- You still have to MANUALLY move any configurations you have for Roxen2 to
- your new Roxen4 server (they CAN coexist as long as you don't use the
- same ports)...
+_Description: Roxen 2 installation detected
+ Roxen 2 appears to be installed on this host. As many values as
+ possible will be taken from this configuration, but some will need
+ manual intervention, such as passwords.
+ .
+ Both Roxen 2 and Roxen 4 can coexist on the same server as long as
+ they use different ports.
  .
- The administration port is the same as the Roxen2 installation but plus
- one (ie, ${SERVER_URL}).
+ Roxen 4 is the port that immediately follows Roxen 2 port (${SERVER_URL}).
 
 Template: roxen4/previous_installation_roxen3
 Type: note
-_Description: Previous installation (Roxen3) detected
- Roxen3 seems to be installed. As many values as possible will be taken from
- this configuration, but you still have to give SOME your self. Mostly
- passwords, since they are encrypted and can't be decrypted easily...
- .
- You still have to MANUALLY move any configurations you have for Roxen 3 to
- your new Roxen 4 server (they CAN coexist as long as you don't use the
- same ports)...
+_Description: Roxen 3 installation detected
+ Roxen 3 appears to be installed on this host. As many values as
+ possible will be taken from this configuration, but some will need
+ manual intervention, such as passwords.
+ .
+ Both Roxen 3 and Roxen 4 can coexist on the same server as long as
+ they use different ports.
  .
- The administration port is the same as the Roxen2 installation but plus
- one (ie, ${SERVER_URL}).
+ Roxen 4 is the port that immediately follows Roxen 3 port (${SERVER_URL}).
--- ../roxen4.old/debian/control	2007-11-24 13:43:11.766273058 +0530
+++ debian/control	2007-11-29 12:21:09.490432436 +0530
@@ -13,29 +13,24 @@
 Provides: httpd, httpd-cgi, roxen3
 Replaces: roxen3
 Conflicts: roxen3
-Description: The Roxen Challenger Webserver
+Description: Roxen Challenger web server - binaries
  The Roxen Challenger is a very powerful and easy to maintain web
  server. The server is written in Pike which is C-like but interpreted
- at runtime. Roxen may be configured comfortable via any web browser.
+ at runtime. Roxen may be configured via any web browser.
  .
  The Roxen Challenger server is the foundation of a powerful
  information and communication environment. Challenger is a secure and
- competent web server. If your intention is minimizing your Total Cost
- of Ownership, Challenger is entirely in line. Challenger offers a
- smorgasbord of features, and on top of that, a whole suite of
- commercial and tightly integrated extensions. Challenger is just as
- suitable for powering an any-sized web site, as for an intranet
+ competent web server. Challenger offers
+ numerous features including a whole suite of
+ commercial and tightly integrated extensions. Challenger is also
+ suitable for powering any web site or intranet
  application.
  .
- This is the official version of the new 'Roxen WebServer' (the new
- name of the webserver). This is still a beta release and the old
- configuration files of the server is not fully compatible with this
- version. There will be a conversion script in a later version, but
- until then I'm installing in .../roxen4/ without any automatic config
- transference. You will have to configure the server manually... You
- can still have both the stable (1.3 and 2.1) versions, since they
- don't clash (at least not filesystem wise), but make sure they don't
- try to talk/listen on the same ports!
+ This package provides the official version of 'Roxen WebServer'.
+ Configuration files for older server versions are not fully compatible
+ with this version. Several parts of the server must be configured or
+ migrated manually. The new version can coexist with former versions on
+ the same host.
 
 Package: roxen4-doc
 Architecture: all
@@ -44,5 +39,17 @@
 Replaces: roxen3-doc
 Conflicts: roxen3-doc
 Depends: roxen4
-Description: Roxen 4.0 documentation
- Documentation for the Roxen Webserver, v4.0.
+Description: Roxen Challenger web server - documentation
+ The Roxen Challenger is a very powerful and easy to maintain web
+ server. The server is written in Pike which is C-like but interpreted
+ at runtime. Roxen may be configured via any web browser.
+ .
+ The Roxen Challenger server is the foundation of a powerful
+ information and communication environment. Challenger is a secure and
+ competent web server. Challenger offers
+ numerous features including a whole suite of
+ commercial and tightly integrated extensions. Challenger is also
+ suitable for powering any web site or intranet
+ application.
+ .
+ This package provides the server's documentation.
Source: roxen4
Section: web
Priority: optional
Maintainer: Turbo Fredriksson <turbo@debian.org>
Build-Depends: debhelper (>= 4.0.2)
Standards-Version: 3.7.2

Package: roxen4
Architecture: any
Section: web
Depends: procps, hostname (>= 2.04), pike7.4-mysql | pike7.6-mysql, pike7.4-image | pike7.6-image, debconf (>= 0.5.00) | debconf-2.0, mysql-server, net-tools
Suggests: roxen4-doc, www-browser, php3-cgi, roxen-fonts-iso8859-1 | roxen-fonts-iso8859-2
Provides: httpd, httpd-cgi, roxen3
Replaces: roxen3
Conflicts: roxen3
Description: Roxen Challenger web server - binaries
 The Roxen Challenger is a very powerful and easy to maintain web
 server. The server is written in Pike which is C-like but interpreted
 at runtime. Roxen may be configured via any web browser.
 .
 The Roxen Challenger server is the foundation of a powerful
 information and communication environment. Challenger is a secure and
 competent web server. Challenger offers
 numerous features including a whole suite of
 commercial and tightly integrated extensions. Challenger is also
 suitable for powering any web site or intranet
 application.
 .
 This package provides the official version of 'Roxen WebServer'.
 Configuration files for older server versions are not fully compatible
 with this version. Several parts of the server must be configured or
 migrated manually. The new version can coexist with former versions on
 the same host.

Package: roxen4-doc
Architecture: all
Section: doc
Provides: roxen3-doc
Replaces: roxen3-doc
Conflicts: roxen3-doc
Depends: roxen4
Description: Roxen Challenger web server - documentation
 The Roxen Challenger is a very powerful and easy to maintain web
 server. The server is written in Pike which is C-like but interpreted
 at runtime. Roxen may be configured via any web browser.
 .
 The Roxen Challenger server is the foundation of a powerful
 information and communication environment. Challenger is a secure and
 competent web server. Challenger offers
 numerous features including a whole suite of
 commercial and tightly integrated extensions. Challenger is also
 suitable for powering any web site or intranet
 application.
 .
 This package provides the server's documentation.

Attachment: signature.asc
Description: Digital signature


Reply to: