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

Bug#219633: netcfg: Debconf templates polishing



Package: netcfg
Severity: normal
Tags: patch d-i

This is the now usual debconf templates "polishing" process for this package.

Here, the most frequent change was to change the question-type short
description for string templates into a "prompt" (w/ ending colon).

This will make the templates look better with the new cdebconf interface.

This sometimes involved adding some stuff at the beginning of the extended
description just to clear up things and improve readability.

Detailed dationale:

 Template: netcfg/get_domain
 Type: string
-_Description: Choose the domain name.
+_Description: Domain name:
  The domain name is the part of your Internet address to the right of your
  host name.  It is often something that ends in .com, .net, .edu, or .org. 
  If you are setting up a home network, you can make something up, but make

s/Question/Prompt....

I here think that the word "choose" was really inappropriate. This could
lead users think that one can choose his/her network name randomly, which is
of course wrong...


 Template: netcfg/get_nameservers
 Type: string
-_Description: Choose the DNS Server Addresses
+_Description: Name servers addresses:
  Please enter the IP addresses (not host names) of up to 3 name servers,
  separated by spaces. Do not use commas. The servers will be queried in the
- order in which you enter them. If you don't want to use any name servers
+ order you mentioned. If you don't want to use any name server,
  just leave this field blank.

1) -->prompt
2) looks better to me

 Template: netcfg/choose_interface
 Type: select
 Choices: ${ifchoices}
-_Description: Choose an interface.
- The following interfaces were detected. Choose the type of your primary
- network interface that you will need for installing the Debian system (via
- NFS or HTTP).
+_Description: Interface:
+ Please choose the interface you want to configure. Below are shown
+ all currently detected interfaces on your system. Please choose the
+ type of your primary network interface. This interface will be used
+ for installing the Debian system (via NFS or HTTP).

1) -->prompt
2) Reformulation for more clarity

I hesitated here to write "will be used for installing the Debian system, if
you install via NFS or HTTP". 


 Template: netcfg/error_cfg
 Type: error
-_Description: An error occured.
- Something went wrong when I tried to activate your network.
+_Description: Error while activating the network
+ An error occurred while activating the network.

Well, I really disliked that one. "Something went wrong" is really vague and
a bit trivial language....and most of d-i people now know how much I like
trivial language (in our work.....in real life, ahem.....).

The extended description is maybe useless as it mostly repeats the short one
(which will be a title). There is not much to say as the program itself does
not seem to know what happened..:)

Maybe suggest users to look at the third console?

 Template: netcfg/get_hostname
 Type: string
 Default: debian
-_Description: Enter the system's hostname.
+_Description: Hostname:
+ Please enter the hostname for this system.
+ .
  The hostname is a single word that identifies your system to the network. 
  If you don't know what your hostname should be, consult your network
  administrator.  If you are setting up your own home network, you can make

Again a "prompt".

The extended description is enhanced so that users really know what we're
talking about.

@@ -38,23 +41,27 @@
 
 Template: netcfg/invalid_hostname
 Type: error
-_Description: The hostname "${hostname}" is invalid.
+_Description: Invalid hostname
+ The name "${hostname}" is invalid.
+ .
  A valid hostname may contain only alphanumeric characters and the minus
  sign, be between 2 and 63 characters long, and cannot begin or end with a
  minus sign.

Error template, so the short description is a title. Details are given in
the extended description.


 Template: netcfg/error
 Type: error
-_Description: An error occured and I cannot continue.
- Feel free to retry.
+_Description: Error
+ An error occured and the network configuration process had been aborted.
+ You may retry it from the installation main menu.

I also disliked that one...:)

First, as usual, the Debian installation system is a program which
shouldn't use first person talking..:)

The problem here is that we do not really seem to know what happened. So
let's be precise --> "Error"...

The extended description sgives facts : netcfg is stopped and the user may
retry it....


 Template: netcfg/no_interfaces
 Type: error
-_Description: No network interfaces were detected.
+_Description: No network interfaces detected
  No network interfaces were found.   That means that the installation
- system was unable to find a network device.  If you do have a network
- card, then it is possible that the module for it hasn't been selected
- yet.  Go back to 'Detect network hardware'.
+ system was unable to find a network device.  
+ . 
+ You may need to load a specific module for your network card, if you really
+ own one. For this, go back to the network hardware detection step.

Error template-->short description is a title and we avoid a full sentence.

My reformulation is maybe better (two paragraphs for readability) but may need correction for perfect English.

We shouldn't make reference to another step (module) title for the main menu
entry. This would make this package's templates depend on another package
templates. Bad.

 Template: netcfg/dhcp_hostname
 Type: string
-_Description: What is your dhcp hostname?
- You may need to supply a DHCP host name. If you are using
- a cable modem, you might need to specify an account number
- here.  Most other users can just leave this blank.
+_Description: DHCP hostname:
+ Supplying a DHCP host name is sometimes needed. If you are using
+ a cable modem, you might need to specify an account number here.  
+ .
+ Most other users can just leave this blank.

Again, short desc-->prompt

I reformulate the extended description for improving readability and make it
clearer that most people will leave the field blank.


 Template: netcfg/confirm_dhcp
 Type: boolean
 Default: true
-_Description: Is this information correct?
+_Description: Are these informations correct?
+ Currently configured network parameters:
+ .
   interface      = ${interface}
   hostname       = ${hostname}
   domain         = ${domain}

The original style looked very bad with the new cdebconf layout.

Above is a proposal....this may be enhanced. The two added strings are
identical with the similar ones in netcfg/confirm_static.


 Template: netcfg/no_dhcp_client
-Type: note
-_Description: No dhcp client found. I cannot continue.
- This package requires pump or dhcp-client.
+Type: error
+_Description: No DHCP client found
+ No DHCP client was found. This package requires pump or dhcp-client.
+ .
+ The DHCP configuration process will be aborted.

That one also was somewhat incorrect:

1) s/note/error
2) make the short desc a real title
3) explain things in the extended desc (and forget about "I")


 Template: netcfg/dhcp-title
 Type: text
@@ -36,4 +41,4 @@
 Template: debian-installer/netcfg-dhcp/title
 Type: text
 #  Item in the main menu to select this package
-_Description: Configure the network via DHCP
+_Description: Configure the network using dynamic addressing (DHCP)

Well, THIS IS A PROPOSAL. This may be more clear for newbies (maybe someday,
Debian will at least be recommended to newbies by "Linux for dummies"-type
books...:-))

However, this won't make the translators work easy, maybe.

 Template: netcfg/get_ipaddress
 Type: string
-_Description: IP address?
+_Description: IP address:
  The IP address is unique to your computer and consists of four numbers
  separated by periods.  If you don't know what to use here, consult your
  network administrator.

Prompt...blahblah....

 Template: netcfg/get_pointopoint
 Type: string
-_Description: Pointopoint address?
- The pointopoint address is used to determine the other endpoint of the
+_Description: Point-to-point address:
+ The point-to-point address is used to determine the other endpoint of the
  point to point network.  Consult your network administrator if you do not
- know the value.  The pointopoint address should be entered as four numbers
+ know the value.  The point-to-point address should be entered as four numbers
  separated by periods.

Is "pointopoint" really correct spelling? this looked strange to me, but I
may be wrong.


 Template: netcfg/get_gateway
 Type: string
-_Description: Gateway?
- This is an IP address (four numbers separated by periods) that indicates
- the gateway router, also known as the default router.  All traffic that
- goes outside your LAN (for instance, to the Internet) is sent through this
- router.  In rare circumstances, you may have no router; in that case, you
- can leave this blank.  If you don't know the proper answer to this
- question, consult your network administrator.
+_Description: Gateway:
+ The gateway is an IP address (four numbers separated by periods) that
+ indicates the gateway router, also known as the default router.  All
+ traffic that goes outside your LAN (for instance, to the Internet) is
+ sent through this router.  In rare circumstances, you may have no
+ router; in that case, you can leave this blank.  If you don't know
+ the proper answer to this question, consult your network
+ administrator.

The only change is by replacing "This is" by "The gateway is" as this
sentence will appear first in dialog-type interfaces.

 Template: netcfg/gateway_unreachable
-Type: note
-_Description: The gateway you entered is unreachable.
+Type: error
+_Description: Unreachable gateway
+ The gateway address you entered is unreachable.
+ .
  You may have made an error entering your IP address, netmask and/or
  gateway.

Error template. Short desc==title. More details.

 Template: netcfg/confirm_static
 Type: boolean
 Default: true
-_Description: Is this configuration correct?
+_Description: Are these informations correct?
+ Currently configured network parameters:
+ .
   interface     = ${interface}
   hostname      = ${hostname}
   domain        = ${domain}

See above for the similar template in DHCP configuration

@@ -59,4 +64,4 @@
 Template: debian-installer/netcfg-static/title
 Type: text
 #  Item in the main menu to select this package
-_Description: Configure a static network
+_Description: Configure a network using static addressing

See above also. This also seems more precise to me. The addressing is
static...not the network.


-- System Information:
Debian Release: testing/unstable
Architecture: i386
Kernel: Linux mykerinos 2.4.22 #2 Mon Sep 29 15:12:10 CEST 2003 i686
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (ignored: LC_ALL set to fr_FR.UTF-8)

diff -Nru netcfg.ori/debian/netcfg-common.templates netcfg/debian/netcfg-common.templates
--- netcfg.ori/debian/netcfg-common.templates	2003-11-07 17:56:03.000000000 +0100
+++ netcfg/debian/netcfg-common.templates	2003-11-07 18:18:39.000000000 +0100
@@ -1,6 +1,6 @@
 Template: netcfg/get_domain
 Type: string
-_Description: Choose the domain name.
+_Description: Domain name:
  The domain name is the part of your Internet address to the right of your
  host name.  It is often something that ends in .com, .net, .edu, or .org. 
  If you are setting up a home network, you can make something up, but make
@@ -8,29 +8,32 @@
 
 Template: netcfg/get_nameservers
 Type: string
-_Description: Choose the DNS Server Addresses
+_Description: Name servers addresses:
  Please enter the IP addresses (not host names) of up to 3 name servers,
  separated by spaces. Do not use commas. The servers will be queried in the
- order in which you enter them. If you don't want to use any name servers
+ order you mentioned. If you don't want to use any name server,
  just leave this field blank.
 
 Template: netcfg/choose_interface
 Type: select
 Choices: ${ifchoices}
-_Description: Choose an interface.
- The following interfaces were detected. Choose the type of your primary
- network interface that you will need for installing the Debian system (via
- NFS or HTTP).
+_Description: Interface:
+ Please choose the interface you want to configure. Below are shown
+ all currently detected interfaces on your system. Please choose the
+ type of your primary network interface. This interface will be used
+ for installing the Debian system (via NFS or HTTP).
 
 Template: netcfg/error_cfg
 Type: error
-_Description: An error occured.
- Something went wrong when I tried to activate your network.
+_Description: Error while activating the network
+ An error occurred while activating the network.
 
 Template: netcfg/get_hostname
 Type: string
 Default: debian
-_Description: Enter the system's hostname.
+_Description: Hostname:
+ Please enter the hostname for this system.
+ .
  The hostname is a single word that identifies your system to the network. 
  If you don't know what your hostname should be, consult your network
  administrator.  If you are setting up your own home network, you can make
@@ -38,23 +41,27 @@
 
 Template: netcfg/invalid_hostname
 Type: error
-_Description: The hostname "${hostname}" is invalid.
+_Description: Invalid hostname
+ The name "${hostname}" is invalid.
+ .
  A valid hostname may contain only alphanumeric characters and the minus
  sign, be between 2 and 63 characters long, and cannot begin or end with a
  minus sign.
 
 Template: netcfg/error
 Type: error
-_Description: An error occured and I cannot continue.
- Feel free to retry.
+_Description: Error
+ An error occured and the network configuration process had been aborted.
+ You may retry it from the installation main menu.
 
 Template: netcfg/no_interfaces
 Type: error
-_Description: No network interfaces were detected.
+_Description: No network interfaces detected
  No network interfaces were found.   That means that the installation
- system was unable to find a network device.  If you do have a network
- card, then it is possible that the module for it hasn't been selected
- yet.  Go back to 'Detect network hardware'.
+ system was unable to find a network device.  
+ . 
+ You may need to load a specific module for your network card, if you really
+ own one. For this, go back to the network hardware detection step.
 
 Template: netcfg/internal-none
 Type: text
diff -Nru netcfg.ori/debian/netcfg-dhcp.templates netcfg/debian/netcfg-dhcp.templates
--- netcfg.ori/debian/netcfg-dhcp.templates	2003-11-07 17:56:03.000000000 +0100
+++ netcfg/debian/netcfg-dhcp.templates	2003-11-07 18:08:46.000000000 +0100
@@ -1,14 +1,17 @@
 Template: netcfg/dhcp_hostname
 Type: string
-_Description: What is your dhcp hostname?
- You may need to supply a DHCP host name. If you are using
- a cable modem, you might need to specify an account number
- here.  Most other users can just leave this blank.
+_Description: DHCP hostname:
+ Supplying a DHCP host name is sometimes needed. If you are using
+ a cable modem, you might need to specify an account number here.  
+ .
+ Most other users can just leave this blank.
 
 Template: netcfg/confirm_dhcp
 Type: boolean
 Default: true
-_Description: Is this information correct?
+_Description: Are these informations correct?
+ Currently configured network parameters:
+ .
   interface      = ${interface}
   hostname       = ${hostname}
   domain         = ${domain}
@@ -24,9 +27,11 @@
 _Description: This may take a few minutes.
 
 Template: netcfg/no_dhcp_client
-Type: note
-_Description: No dhcp client found. I cannot continue.
- This package requires pump or dhcp-client.
+Type: error
+_Description: No DHCP client found
+ No DHCP client was found. This package requires pump or dhcp-client.
+ .
+ The DHCP configuration process will be aborted.
 
 Template: netcfg/dhcp-title
 Type: text
@@ -36,4 +41,4 @@
 Template: debian-installer/netcfg-dhcp/title
 Type: text
 #  Item in the main menu to select this package
-_Description: Configure the network via DHCP
+_Description: Configure the network using dynamic addressing (DHCP)
diff -Nru netcfg.ori/debian/netcfg-static.templates netcfg/debian/netcfg-static.templates
--- netcfg.ori/debian/netcfg-static.templates	2003-11-07 17:56:03.000000000 +0100
+++ netcfg/debian/netcfg-static.templates	2003-11-07 18:19:15.000000000 +0100
@@ -1,22 +1,22 @@
 Template: netcfg/get_ipaddress
 Type: string
-_Description: IP address?
+_Description: IP address:
  The IP address is unique to your computer and consists of four numbers
  separated by periods.  If you don't know what to use here, consult your
  network administrator.
 
 Template: netcfg/get_pointopoint
 Type: string
-_Description: Pointopoint address?
- The pointopoint address is used to determine the other endpoint of the
+_Description: Point-to-point address:
+ The point-to-point address is used to determine the other endpoint of the
  point to point network.  Consult your network administrator if you do not
- know the value.  The pointopoint address should be entered as four numbers
+ know the value.  The point-to-point address should be entered as four numbers
  separated by periods.
 
 Template: netcfg/get_netmask
 Type: string
 Default: 255.255.255.0
-_Description: Netmask?
+_Description: Netmask:
  The netmask is used to determine which machines are local to your
  network.  Consult your network administrator if you do not know the
  value.  The netmask should be entered as four numbers separated by
@@ -24,24 +24,29 @@
 
 Template: netcfg/get_gateway
 Type: string
-_Description: Gateway?
- This is an IP address (four numbers separated by periods) that indicates
- the gateway router, also known as the default router.  All traffic that
- goes outside your LAN (for instance, to the Internet) is sent through this
- router.  In rare circumstances, you may have no router; in that case, you
- can leave this blank.  If you don't know the proper answer to this
- question, consult your network administrator.
+_Description: Gateway:
+ The gateway is an IP address (four numbers separated by periods) that
+ indicates the gateway router, also known as the default router.  All
+ traffic that goes outside your LAN (for instance, to the Internet) is
+ sent through this router.  In rare circumstances, you may have no
+ router; in that case, you can leave this blank.  If you don't know
+ the proper answer to this question, consult your network
+ administrator.
 
 Template: netcfg/gateway_unreachable
-Type: note
-_Description: The gateway you entered is unreachable.
+Type: error
+_Description: Unreachable gateway
+ The gateway address you entered is unreachable.
+ .
  You may have made an error entering your IP address, netmask and/or
  gateway.
 
 Template: netcfg/confirm_static
 Type: boolean
 Default: true
-_Description: Is this configuration correct?
+_Description: Are these informations correct?
+ Currently configured network parameters:
+ .
   interface     = ${interface}
   hostname      = ${hostname}
   domain        = ${domain}
@@ -59,4 +64,4 @@
 Template: debian-installer/netcfg-static/title
 Type: text
 #  Item in the main menu to select this package
-_Description: Configure a static network
+_Description: Configure a network using static addressing

Reply to: