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

Re: [RFR] templates://ocsinventory-agent/ocsinventory-agent.templates



Quoting James Westby (jw+debian@jameswestby.net):
> Please find, for review, the debconf templates of mysql-dfsg-5.0.

:-) Bug in the scripts?

Here's my proposal (diffs attached):

templates:

 Template: ocsinventory-agent/method
 Type: select
-_Choices: local, http
-Default: local
+__Choices: Local, HTTP
+Default: Local

That would require changes to the config script but having choices
that start with a capital letter looks nicer in a select template.

Also, protocol names should IMHO be capitalised, so s/http/HTTP


 _Description: Method used to generate the inventory:
- Choose the local method if you do not have a network connection.
+ Choose the 'Local' method if no network connection is available.

What is the typographically correct way to quote words in English?
Is this:
- 'Local'
- `Local'
- "Local"

...or anything else?


  .
- Choose the http method if you have an OCS Inventory server set up (you
- will be asked the name of the server in the next question).
+ Choose the HTTP method if an OCS Inventory server is set up.

I suggest to never make direct or indirect references to the way
debconf questions are shown. This may vary from one interface to
another.

I also suggest avoiding "you have" things. Ultra-nautral style...:-)

 
 Template: ocsinventory-agent/server
 Type: string
-_Description: name of the OCS Inventory server:
+_Description: OCS Inventory server host name:
+ Please enter the host name of the OCS inventory server.

Matter of taste but "Foo host name:" is more common among other
packages. Anyay a capital letter would be required here.

The long description obviously slightly repeats the short one so that
is really optional....I just prefer debcofn templates that are
wreitten this way.

 
 Template: ocsinventory-agent/tag
 Type: string
 _Description: Tag for the generated inventory:
- Each inventory can have an associated tag. Enter the tag you would like for
- the new inventory here. You can leave the field blank to have no tag.
+ Each inventory can have an associated tag. Please enter the tag you would like for
+ the new inventory.
+ .
+ This field can be left blank to continue without setting a tag for the
+ inventory.


The "Please enter" is more common and it makes the imperative form
slightly softer.

I omit the "here". Again, this is an indirect reference to thedebconf
interface.

Splitting paragraphs to make them easier to read and rewording
slightly to avoid the "You can leave".

control:

I just removed the hard-formatting in the last line as it is useless.

--- /home/bubulle/travail/debian/rewrite/relecture/ocsinventory-agent-ocsinventory-agent.templates-20070414	2007-04-14 07:54:50.325390605 +0200
+++ /home/bubulle/travail/debian/rewrite/relecture/ocsinventory-agent-ocsinventory-agent.templates-20070414.bubulle	2007-04-14 08:09:18.304952907 +0200
@@ -1,19 +1,22 @@
 Template: ocsinventory-agent/method
 Type: select
-_Choices: local, http
-Default: local
+__Choices: Local, HTTP
+Default: Local
 _Description: Method used to generate the inventory:
- Choose the local method if you do not have a network connection.
+ Choose the 'Local' method if no network connection is available.
  .
- Choose the http method if you have an OCS Inventory server set up (you
- will be asked the name of the server in the next question).
+ Choose the HTTP method if an OCS Inventory server is set up.
 
 Template: ocsinventory-agent/server
 Type: string
-_Description: name of the OCS Inventory server:
+_Description: OCS Inventory server host name:
+ Please enter the host name of the OCS inventory server.
 
 Template: ocsinventory-agent/tag
 Type: string
 _Description: Tag for the generated inventory:
- Each inventory can have an associated tag. Enter the tag you would like for
- the new inventory here. You can leave the field blank to have no tag.
+ Each inventory can have an associated tag. Please enter the tag you would like for
+ the new inventory.
+ .
+ This field can be left blank to continue without setting a tag for the
+ inventory.
--- /home/bubulle/travail/debian/rewrite/relecture/ocsinventory-agent-control-20070414	2007-04-14 07:58:48.339473381 +0200
+++ /home/bubulle/travail/debian/rewrite/relecture/ocsinventory-agent-control-20070414.bubulle	2007-04-14 07:59:37.959906687 +0200
@@ -16,4 +16,4 @@
  .
  This package contains the client part.
  .
-  Homepage: http://ocsinventory.sourceforge.net
+ Homepage: http://ocsinventory.sourceforge.net

Attachment: signature.asc
Description: Digital signature


Reply to: