[RFR] templates://zope-common/{templates}

Justin B Rye jbr at edlug.org.uk
Wed Jul 4 18:12:35 UTC 2007 

Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

(Incorporating some material from Kevin.)

> + Zope offers an extensible, modular structure that allows for an
> + easy addition of extra components (products) or features. Each product or feature
> + is usually provided by packages whose name starts with a 'zope-'
> + prefix. Each Zope instance needs to be restarted to
> + use any new add-on.
> 
> Be less verbose.

Furthermore, we can skip the repeated products-or-features:

    Zope offers an extensible, modular structure that allows for the
    easy addition of extra components (products) or features. These are
    provided as packages with names that start with a 'zope-' prefix.
    Each Zope instance needs to be restarted to use any new add-on.

> +_Description: Action on old/incomplete zope instance '${instance}':
...
> + An old/incomplete ${instance} instance was found in
> + /var/lib/zope${zver}/instance/${instance}, with no Data.fs file Data.fs.

Repetition; "no Data.fs file".

>  Template: zope-common/keep-data-on-purge
...
> + Purging the data files of a Zope instance on package purge
> + results in loss of all data of that instance. These data
> + files are stored in

Kevin suggests:

    when purging the package, the data files for a Zope instance will   
    also be purged, resulting in the loss of all data for that instance.
    These data files are stored in

But that doesn't quite work - for a start the "when purging" sets
off my dangling-participle alarms (the subject of this sentence
isn't the sysadmin, it's the files).  I'd prefer

    Purging the data files of a Zope instance on package purge will
    result in the loss of all data for that instance. These data
    files are stored in

>  Template: zope-common/admin-user
...
> + A valid login name starts with a letter, followed by letters and digits.

Instead of going into the details of it requiring a letter followed
by zero to N letters and/or digits and/or (presumably) underscores,
I think it should just say:

   Valid names must start with a letter.

> + This will only be used for the instance creation. To later change the
> + administrative user login name and password, please use the following
> + command:

Adopting Kevin's:
    This will only be used for instance creation.  Please use the
    following command to change the administrative user login name and
    password at a later time:         
(And again below.)

>  Template: zope-common/admin-password
...
> + Please enter a password for the administrative user. The password
> + must not be empty.  The password is deleted from the configuration
> + database, once the instance is sucessfully created and cannot be
> + recoverd.

Plagiarising again:
    database once the instance is successfully created and cannot be
    recovered.

>  Template: zope-common/admin-automatic-password
...
> +_Description: Automatically generated user and password for this instance
> + No administrative user login name and a password were provided for
                                      or password
> + this instance. They have been automatically generated.
> 
> Remove personnalization. Again, that means a switch to passive form
> unless someone finds a better solution.

There's always "this instance lacked an administrative user login
name and password, so it will automatically generate one", but I
prefer passivisation.

> - Use these values to log in the Zope${zver} instance ${instance}:
> + Please use the following values to log in the ${instance} Zope${zver} instance:
                                             ^to

But that makes me slightly queasy.  How about just:

   For ${instance} Zope${zver} logins, use the following values:
-- 
JBR
Ankh kak! (Ancient Egyptian blessing)
-------------- next part --------------
--- ../zope-common.old/debian/templates	2007-07-04 18:45:44.000000000 +0100
+++ debian/templates	2007-07-04 19:11:25.000000000 +0100
@@ -3,103 +3,98 @@
 _Choices: configuring, end, manually
 Default: end
 _Description: Automatic restart of Zope instances:
- Zope has an extensible, modular structure that allows you to easily
- add extra components (products) or features. Each product or feature
- can usually be found in packages whose name starts with a 'zope-'
- prefix. Unfortunately, each Zope instance needs to be restarted to
- use any new add-on. Here you can choose the default behaviour of
- Zope instances in any installed Zope version when Zope needs to be
- restarted. Each instance, however, is allowed to overwrite this
- setting:
- .
-  * configuring: restart instances after each product configuration.
-  * end:         restart instances only once at the end of the whole
-                 installation/upgrading process.
-  * manually:    no restart, it is your responsibility to restart
-                 Zope instances.
+ Zope offers an extensible, modular structure that allows for the
+ easy addition of extra components (products) or features. These are
+ provided as packages with names that start with a 'zope-' prefix.
+ Each Zope instance needs to be restarted to use any new add-on.
+ .
+ Please choose the default behaviour of Zope instances when Zope needs
+ to be restarted:
+ .
+  - configuring: restart instances after each product configuration;
+  - end:         restart instances only once at the end of the whole
+                 installation/upgrading process;
+  - manually:    no automated restart.
 
 Template: zope-common/remove-instance-without-data
 Type: select
 _Choices: abort, remove and continue
 Default: abort
-_Description: Found an old/incomplete zope instance '${instance}':
- Found an old/incomplete ${instance} instance in
- /var/lib/zope${zver}/instance/${instance}. No data file Data.fs was found
- for the instance, meaning that the installation was not completed
- for some reason, or the installation was incompletely removed.
- Aborting the installation will allow you to inspect the state of the
- instance, continuing will remove /var/lib/zope${zver}/instance/${instance}
- and reinstall the ${instance}. Existing logfiles in
+_Description: Action on old/incomplete zope instance '${instance}':
+ An old/incomplete ${instance} instance was found in
+ /var/lib/zope${zver}/instance/${instance}, with no Data.fs file.
+ This installation is either incomplete or incompletely removed.
+ .
+ Choosing 'abort' will allow you to inspect the state of the
+ instance.
+ .
+ Choosing 'remove and continue' will remove /var/lib/zope${zver}/instance/${instance}
+ and reinstall ${instance}. Existing logfiles in
  /var/log/zope${zver}/${instance} and configuration files in
- /etc/zope${zver}/${instance} are preserved.
+ /etc/zope${zver}/${instance} will be preserved.
 
 Template: zope-common/keep-data-on-purge
 Type: boolean
 Default: true
 _Description: Keep data for ${instance} on package purge?
- Purging the data files of a zope instance on package purge
- results in loss of all data of the zope instance. The data
- files for this instance are stored in
+ Purging the data files of a Zope instance on package purge will
+ result in the loss of all data for that instance. These data
+ files are stored in
  /var/lib/zope${zver}/instance/${instance}.
 
 Template: zope-common/admin-user
 Type: string
 Default: admin
-_Description: Admin user for zope instance '${instance}':
- Please enter an admin user for the zope instance '${instance}'.
- A valid user name starts with a letter, followed by letters and digits.
- .
- NOTE: Once the instance has been created, the parameter entered
- here isn't relevant anymore.  To change the admin user (and password)
- later on, call:
+_Description: Administrative user for '${instance}' Zope instance:
+ Please enter the login name of the administrative user for the
+ '${instance}' Zope instance. Valid names must start with a letter.
+ .
+ This will only be used for instance creation.  Please use the
+ following command to change the administrative user login name and
+ password at a later time:
  .
  /var/lib/zope${zver}/instance/${instance}/bin/zopectl adduser <user> <password>
 
 
 Template: zope-common/admin-password
 Type: password
-_Description: Password for the admin user:
- Please enter a password for the admin user. The password must not be empty.
- The password is deleted from the configuration database, once the
- instance is sucessfully created and cannot be recoverd.
- .
- NOTE: Once the instance has been created, the parameter entered
- here isn't relevant anymore.  To change the admin user (and password)
- later on, call:
+_Description: Password for the administrative user:
+ Please enter a password for the administrative user. The password
+ must not be empty.  The password is deleted from the configuration
+ database once the instance is successfully created and cannot be
+ recovered.
+ .
+ This will only be used for instance creation.  Please use the
+ following command to change the administrative user login name and
+ password at a later time:
  .
  /var/lib/zope${zver}/instance/${instance}/bin/zopectl adduser <user> <password>
 
 Template: zope-common/admin-password-confirmation
 Type: password
-_Description: Same password:
- Please enter again the password for the admin user.
- .
- NOTE: Once the instance has been created, the parameter entered
- here isn't relevant anymore.  To change the admin user (and password)
- later on, call:
- .
- /var/lib/zope${zver}/instance/${instance}/bin/zopectl adduser <user> <password>
+_Description: Password confirmation:
+ Please confirm the administrative user's password.
 
 Template: zope-common/instance-http-port
 Type: string
 _Description: HTTP port for this instance:
- Please enter the HTTP port for the instance ${instance}.
+ Please enter the HTTP port number for the ${instance} instance.
  .
  Other services (e.g. FTP, WebDAV, debug) will be disabled by default.
- You can enable them editing /etc/zope${zver}/${instance}/zope.conf.
+ They can be enabled by editing /etc/zope${zver}/${instance}/zope.conf.
 
 Template: zope-common/instance-zeo-port
 Type: string
 _Description: TCP port for the ZEO instance:
- Please enter the TCP port for the ZEO instance ${instance}.
+ Please enter the TCP port number for the ${instance} ZEO instance.
 
 Template: zope-common/admin-automatic-password
 Type: note
-_Description: Automatically generated user and password for your instance
- You haven't provided a user and a password for your instance, so these 
- values have been automatically generated.
+_Description: Automatically generated user and password for this instance
+ No administrative user login name or password were provided for
+ this instance. They have been automatically generated.
  .
- Use these values to log in the Zope${zver} instance ${instance}:
+ For ${instance} Zope${zver} logins, use the following values:
  .
-  * User     : ${user}
-  * Password : ${password}
+  - User     : ${user}
+  - Password : ${password}
--- ../zope-common.old/debian/control	2007-07-04 18:45:45.000000000 +0100
+++ debian/control	2007-07-04 18:46:37.000000000 +0100
@@ -11,5 +11,5 @@
 Package: zope-common
 Architecture: all
 Depends: adduser, python2.4, ${misc:Depends}
-Description: common settings and scripts for zope installations
- The package contains common settings and scripts for zope installations.
+Description: common settings and scripts for Zope installations
+ This package contains common settings and scripts for Zope installations.
-------------- next part --------------
Template: shared/zope/restart
Type: select
_Choices: configuring, end, manually
Default: end
_Description: Automatic restart of Zope instances:
 Zope offers an extensible, modular structure that allows for the
 easy addition of extra components (products) or features. These are
 provided as packages with names that start with a 'zope-' prefix.
 Each Zope instance needs to be restarted to use any new add-on.
 .
 Please choose the default behaviour of Zope instances when Zope needs
 to be restarted:
 .
  - configuring: restart instances after each product configuration;
  - end:         restart instances only once at the end of the whole
                 installation/upgrading process;
  - manually:    no automated restart.

Template: zope-common/remove-instance-without-data
Type: select
_Choices: abort, remove and continue
Default: abort
_Description: Action on old/incomplete zope instance '${instance}':
 An old/incomplete ${instance} instance was found in
 /var/lib/zope${zver}/instance/${instance}, with no Data.fs file.
 This installation is either incomplete or incompletely removed.
 .
 Choosing 'abort' will allow you to inspect the state of the
 instance.
 .
 Choosing 'remove and continue' will remove /var/lib/zope${zver}/instance/${instance}
 and reinstall ${instance}. Existing logfiles in
 /var/log/zope${zver}/${instance} and configuration files in
 /etc/zope${zver}/${instance} will be preserved.

Template: zope-common/keep-data-on-purge
Type: boolean
Default: true
_Description: Keep data for ${instance} on package purge?
 Purging the data files of a Zope instance on package purge will
 result in the loss of all data for that instance. These data
 files are stored in
 /var/lib/zope${zver}/instance/${instance}.

Template: zope-common/admin-user
Type: string
Default: admin
_Description: Administrative user for '${instance}' Zope instance:
 Please enter the login name of the administrative user for the
 '${instance}' Zope instance. Valid names must start with a letter.
 .
 This will only be used for instance creation.  Please use the
 following command to change the administrative user login name and
 password at a later time:
 .
 /var/lib/zope${zver}/instance/${instance}/bin/zopectl adduser <user> <password>


Template: zope-common/admin-password
Type: password
_Description: Password for the administrative user:
 Please enter a password for the administrative user. The password
 must not be empty.  The password is deleted from the configuration
 database once the instance is successfully created and cannot be
 recovered.
 .
 This will only be used for instance creation.  Please use the
 following command to change the administrative user login name and
 password at a later time:
 .
 /var/lib/zope${zver}/instance/${instance}/bin/zopectl adduser <user> <password>

Template: zope-common/admin-password-confirmation
Type: password
_Description: Password confirmation:
 Please confirm the administrative user's password.

Template: zope-common/instance-http-port
Type: string
_Description: HTTP port for this instance:
 Please enter the HTTP port number for the ${instance} instance.
 .
 Other services (e.g. FTP, WebDAV, debug) will be disabled by default.
 They can be enabled by editing /etc/zope${zver}/${instance}/zope.conf.

Template: zope-common/instance-zeo-port
Type: string
_Description: TCP port for the ZEO instance:
 Please enter the TCP port number for the ${instance} ZEO instance.

Template: zope-common/admin-automatic-password
Type: note
_Description: Automatically generated user and password for this instance
 No administrative user login name or password were provided for
 this instance. They have been automatically generated.
 .
 For ${instance} Zope${zver} logins, use the following values:
 .
  - User     : ${user}
  - Password : ${password}
-------------- next part --------------
Source: zope-common
Section: web
Priority: optional
Maintainer: Debian/Ubuntu Zope Team <pkg-zope-developers at lists.alioth.debian.org>
Uploaders: Fabio Tranchitella <kobold at debian.org>, Andrea Mennucci <mennucc1 at debian.org>, martin f. krafft <madduck at debian.org>, Matthias Klose <doko at debian.org>, Jonas Meurer <mejo at debian.org>, Bernd Zeimetz <bernd at bzed.de>
Build-Depends: debhelper (>= 5.0.0), po-debconf, lsb-release
Build-Depends-Indep: docbook-to-man
Standards-Version: 3.7.2
XS-Vcs-Svn: svn://svn.debian.org/pkg-zope/zope-common/trunk

Package: zope-common
Architecture: all
Depends: adduser, python2.4, ${misc:Depends}
Description: common settings and scripts for Zope installations
 This package contains common settings and scripts for Zope installations.

More information about the pkg-zope-developers mailing list