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

Re: [RFR2] templates://ufw/{templates}



Quoting Jonathan Wiltshire (debian@jwiltshire.org.uk):
> On Thu, May 21, 2009 at 11:14:41AM +0100, Justin B Rye wrote:
> > Agreed.  ("Found X" is active, with the subject omitted; "X found"
> > makes it passive, and can do that vagueness more naturally.)
> 
> What he said ;)


Here comes my review, with comments:

--- templates.ori	2009-05-21 21:19:48.033471804 +0200
+++ templates	2009-05-21 21:24:17.141217830 +0200
@@ -1,33 +1,38 @@
 Template: ufw/existing_configuration
 Type: error
 _Description: Existing configuration found
- You must adjust your existing rules by hand. See the 'man ufw' command
- for details.
+ An existing configuration file for ufw has been found.
+ Existing rules must by adapted manually. 
+ .
+ You should read the ufw(1) manpage for details about ufw
+ configuration.

I'm not enthusiast about the "Existing configuration found" but I find
nothing better.

On the other hand, I really suggest that the long description not be
"linked" to the synopsis (as I wrte elsewhere, both are not always
shown together).

So, I recommend a reformulation of what's said in the synopsis before
suggesting whet should be done.

The second paragraph uses our common wording in such case, when we
need to reference a manpage.

I personnally prefer "manually" over "by hand".

 
 Template: ufw/enable
 Type: boolean
 Default: false
 _Description: Start ufw automatically?
- If enabled, the rules you are about to set will take immediate
+ If you shoose this option, the rules you are about to set will take immediate
  effect, and will be enabled during startup so that this host is protected
- as early as possible. Alternatively, you may start ufw manually but this host
+ as early as possible.
+ .
+ Alternatively, you may start ufw manually but this host
  will not be protected until you do so.

"If you choose this option"....is now commonly accepted.

I suggest splitting the alternative in a separate paragraph to
separate ideas.

 
 Template: ufw/allow_known_ports
 Type: multiselect
-_Choices: Cups, DNS, Imap (Secure), Pop3 (Secure), SSH, Samba, Smtp, WWW, WWW (Secure)
-_Description: Allow the following services:
- The appropriate ports will be opened for each service you select in this list.
+__Choices: Cups, DNS, Imap (Secure), Pop3 (Secure), SSH, Samba, Smtp, WWW, WWW (Secure)
+_Description: Authorized ervices:
+ Please choose the incoming services which you want to keep active.
+ The appropriate ports will be opened for each selected service.
  .
- If you want to allow a service that is not in this list, you will have an
- opportunity to specify it shortly.
+ Other services may be specified in the next configuration step.

"__Choices" : very important. It will make translators' life *much*
easier.

We could refine this by using something like:

#flag:translate:3,4,9
__Choices: Cups, DNS, Imap (Secure), Pop3 (Secure), SSH, Samba, Smtp, WWW, WWW (Secure)

...as only 3 choices are translatable stuff...but I indeed would avoid
it because it will be harder to maintain for the maintainer is (s)he
changes the list of choices.

Again, my proposal avoids "linking" the synopsis and the long description.
"this list" is also something to avoid, imho.

"shortly": nothing guarantees this will happen "shortly". It will
happen in the next step, this is the only thing we're sure about...:-)

"Allow the following services": they are not necessarily "following"
and we conventionnally avoid sentences for synopsis. So "Authorized
services" seems simpler to me.
 
 Template: ufw/allow_custom_ports
 Type: string
-_Description: Additional services to be allowed:
+_Description: Additional authorized services:
  Please enter a space separated list of any additional ports you would like to
  open. You may use a service name (as found in /etc/services), a
  port number, or a port number with protocol.
  .
  Example: to allow a web server, port 53
- and tcp port 22, enter 'www 53 22/tcp'.
+ and tcp port 22, you should enter "www 53 22/tcp".


About the same suggestion for synopsis.

Use double quotes.

Avoid imperative form (we don't give orders to our users...:-))


--- templates.ori	2009-05-21 21:19:48.033471804 +0200
+++ templates	2009-05-21 21:31:24.514222080 +0200
@@ -1,33 +1,38 @@
 Template: ufw/existing_configuration
 Type: error
 _Description: Existing configuration found
- You must adjust your existing rules by hand. See the 'man ufw' command
- for details.
+ An existing configuration file for ufw has been found.
+ Existing rules must by adapted manually. 
+ .
+ You should read the ufw(1) manpage for details about ufw
+ configuration.
 
 Template: ufw/enable
 Type: boolean
 Default: false
 _Description: Start ufw automatically?
- If enabled, the rules you are about to set will take immediate
+ If you shoose this option, the rules you are about to set will take immediate
  effect, and will be enabled during startup so that this host is protected
- as early as possible. Alternatively, you may start ufw manually but this host
+ as early as possible.
+ .
+ Alternatively, you may start ufw manually but this host
  will not be protected until you do so.
 
 Template: ufw/allow_known_ports
 Type: multiselect
-_Choices: Cups, DNS, Imap (Secure), Pop3 (Secure), SSH, Samba, Smtp, WWW, WWW (Secure)
-_Description: Allow the following services:
- The appropriate ports will be opened for each service you select in this list.
+__Choices: Cups, DNS, Imap (Secure), Pop3 (Secure), SSH, Samba, Smtp, WWW, WWW (Secure)
+_Description: Authorized ervices:
+ Please choose the incoming services which you want to keep active.
+ The appropriate ports will be opened for each selected service.
  .
- If you want to allow a service that is not in this list, you will have an
- opportunity to specify it shortly.
+ Other services may be specified in the next configuration step.
 
 Template: ufw/allow_custom_ports
 Type: string
-_Description: Additional services to be allowed:
+_Description: Additional authorized services:
  Please enter a space separated list of any additional ports you would like to
  open. You may use a service name (as found in /etc/services), a
  port number, or a port number with protocol.
  .
  Example: to allow a web server, port 53
- and tcp port 22, enter 'www 53 22/tcp'.
+ and tcp port 22, you should enter "www 53 22/tcp".

Attachment: signature.asc
Description: Digital signature


Reply to: