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

Re: citadel templates



Quoting Michael Meskes (meskes@debian.org):
> Hi,
> 
> could you please have a look at the attached template file and review
> it? The citadel package has been worked on for about 3 years no without
> a native speaker having a look at the templates. I'd guess it's about
> time now. :-)


Here's my (non native speaker) reeview.

--- citadel-server.templates	2008-04-03 17:47:10.921209533 +0200
+++ citadel-server.templates.new	2008-04-03 17:57:13.977208634 +0200
@@ -1,34 +1,40 @@
 Template: citadel/ServerIPAddress
 Type: string
 Default: 0.0.0.0
-_Description: Listen IP for Citadel:
- Specify the IP address on which your server will run. If you
- specify 0.0.0.0, Citadel will listen on all addresses.
- You can usually skip this unless you are running multiple 
+_Description: Listening address for the Citadel server:
+ Please specify the IP address which the server should be listening to. If you
+ specify 0.0.0.0, the server will listen on all addresses.
+ You can usually skip this unless you want to run multiple 
  instances of Citadel on the same computer.

There is nothing like "an IP". Hence rewriting and completing the
template for a more "formal" style.

s/your server/the server: there is no reason to assume this is "my" server...

 
 Template: citadel/LoginType
 Type: boolean
 Default: false
 _Description: Enable external authentication mode?
- Specify the way authentication is done, either host based or Citadel internal.
- Host based authentication could be /etc/passwd or an LDAP directory.
- WARNING: do not change this setting once your system is installed.
- Answer "no" unless you completely understand this option.
+ Please choose whether you want to use an external authentication
+ method such as the /etc/passwd file or an LDAP directory.
+ .
+ If you do not choose this option, authentication will be internal
+ to Citadel.
+ .
+ This setting should not be changed later. Choosing external authentication
+ should be done with great care.

Complete rewrite.

I think that the term "host based" is pretty confusing and add no real
value. We ask about "external authentication" so just stick with it.

I discourage "WARNING" as much as possible


I'm not entirely happy with my rewrite, though. A native speaker would
do better.
 
 Template: citadel/Administrator
 Type: string
 Default: Administrator
-_Description: Citadel administrator:
- Enter the name of the Citadel administrator (which is probably
- you). When an account is created with this name, it will
- automatically be given administrator-level access.
+_Description: Citadel administrator username:
+ Please enter the username of the Citadel administrator.
+ Any account created with this name will be granted
+ administrator-level access to the server.

What are we asking for? That's apparently a login name, so just say it..:-)
 


 Template: citadel/Installnote
 Type: note
-_Description: Citadel/UX
- For post configuring your Citadel Server, use citadel-webcit with your 
- browser, log in as the user you specified as the Administrator, and
- review the Points under the Administration menu. If you have further
- questions review www.citadel.org, especially the FAQ and Documentation
- section.
+_Description: Citadel post-installation instructions
+ In order to complete the configuration of the Citadel server, you
+ should use citadel-webcit with a web
+ browser, log in with the administrator's username and
+ review items in the Administration menu.
+ .
+ More detailed information can be found on www.citadel.org, particularly
+ in the FAQ and Documentation sections.


That note is debconf abuse, imho. I still rewrote it to
complly with our usual style recommendations but I'm not really happy
with it. This should go to README.Debian

Template: citadel/ServerIPAddress
Type: string
Default: 0.0.0.0
_Description: Listening address for the Citadel server:
 Please specify the IP address which the server should be listening to. If you
 specify 0.0.0.0, the server will listen on all addresses.
 You can usually skip this unless you want to run multiple 
 instances of Citadel on the same computer.

Template: citadel/LoginType
Type: boolean
Default: false
_Description: Enable external authentication mode?
 Please choose whether you want to use an external authentication
 method such as the /etc/passwd file or an LDAP directory.
 .
 If you do not choose this option, authentication will be internal
 to Citadel.
 .
 This setting should not be changed later. Choosing external authentication
 should be done with great care.

Template: citadel/Administrator
Type: string
Default: Administrator
_Description: Citadel administrator username:
 Please enter the username of the Citadel administrator.
 Any account created with this name will be granted
 administrator-level access to the server.

Template: citadel/Installnote
Type: note
_Description: Citadel post-installation instructions
 In order to complete the configuration of the Citadel server, you
 should use citadel-webcit with a web
 browser, log in with the administrator's username and
 review items in the Administration menu.
 .
 More detailed information can be found on www.citadel.org, particularly
 in the FAQ and Documentation sections.
--- citadel-server.templates	2008-04-03 17:47:10.921209533 +0200
+++ citadel-server.templates.new	2008-04-03 18:00:23.609214563 +0200
@@ -1,34 +1,40 @@
 Template: citadel/ServerIPAddress
 Type: string
 Default: 0.0.0.0
-_Description: Listen IP for Citadel:
- Specify the IP address on which your server will run. If you
- specify 0.0.0.0, Citadel will listen on all addresses.
- You can usually skip this unless you are running multiple 
+_Description: Listening address for the Citadel server:
+ Please specify the IP address which the server should be listening to. If you
+ specify 0.0.0.0, the server will listen on all addresses.
+ You can usually skip this unless you want to run multiple 
  instances of Citadel on the same computer.
 
 Template: citadel/LoginType
 Type: boolean
 Default: false
 _Description: Enable external authentication mode?
- Specify the way authentication is done, either host based or Citadel internal.
- Host based authentication could be /etc/passwd or an LDAP directory.
- WARNING: do not change this setting once your system is installed.
- Answer "no" unless you completely understand this option.
+ Please choose whether you want to use an external authentication
+ method such as the /etc/passwd file or an LDAP directory.
+ .
+ If you do not choose this option, authentication will be internal
+ to Citadel.
+ .
+ This setting should not be changed later. Choosing external authentication
+ should be done with great care.
 
 Template: citadel/Administrator
 Type: string
 Default: Administrator
-_Description: Citadel administrator:
- Enter the name of the Citadel administrator (which is probably
- you). When an account is created with this name, it will
- automatically be given administrator-level access.
+_Description: Citadel administrator username:
+ Please enter the username of the Citadel administrator.
+ Any account created with this name will be granted
+ administrator-level access to the server.
 
 Template: citadel/Installnote
 Type: note
-_Description: Citadel/UX
- For post configuring your Citadel Server, use citadel-webcit with your 
- browser, log in as the user you specified as the Administrator, and
- review the Points under the Administration menu. If you have further
- questions review www.citadel.org, especially the FAQ and Documentation
- section.
+_Description: Citadel post-installation instructions
+ In order to complete the configuration of the Citadel server, you
+ should use citadel-webcit with a web
+ browser, log in with the administrator's username and
+ review items in the Administration menu.
+ .
+ More detailed information can be found on www.citadel.org, particularly
+ in the FAQ and Documentation sections.

Attachment: signature.asc
Description: Digital signature


Reply to: