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

[RFR] templates://emacspeak/{templates}



Please find, for review, the debconf templates and packages descriptions for the emacspeak source package.

This review will last from Sunday, November 23, 2008 to Wednesday, December 03, 2008.

Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.

Your review should be sent as an answer to this mail.

When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.

When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.

Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.

Rationale:
--- ../emacspeak.old/debian/templates	2008-11-23 12:10:26.428833058 +0100
+++ debian/templates	2008-11-23 12:36:48.928831903 +0100
@@ -1,7 +1,7 @@
 Template: shared/emacspeak/fake
 Type: select
 Choices: ${choices}
-Description: Which packages have installed speech servers?
+Description: for internal use
  This template is never shown to the user and does not require
  translation.

Will avoid a lintian warning
 
@@ -9,62 +9,59 @@
 Type: select
 Choices: ${choices}
 _Description: Default speech server:
- The file /etc/emacspeak.conf will be configured so that the command
- "/usr/bin/emacspeak" will start emacs with emacspeak support using
- this server.  You may change the selection later by running
- "dpkg-reconfigure emacspeak" as root, or temporarily override the
- selection by setting the environment variable DTK_PROGRAM.  If you
- want to use a server in a separate package, which does not appear in
- the list, just accept the default now, and you should be asked again
- when that other package is installed.
+ The /etc/emacspeak.conf file will be configured so that the command
+ '/usr/bin/emacspeak' will start Emacs with emacspeak support using
+ this server.
+ .
+ You may change the selection later by running
+ 'dpkg-reconfigure emacspeak' as root, or temporarily override the
+ selection by setting the environment variable DTK_PROGRAM.
 Default: DECtalk Express

The <foo> file...

Use single quotes (this is a practice we try to standardize over
packages)

Split in paragraphs for better readability.

I don't think that the last sentence is very useful. Also, making
reference to "the default setting" may be misleading and, anyway, it's
never recommended to make reference to things users are seeing (or hearing).
 
 Template: shared/emacspeak/port
 Type: string
-# "none" must remain in english
-_Description: hardware port:
- If a hardware device is used to generate speech, enter the Unix
- device file associated with it.  For example, "/dev/ttyS0" or
- "/dev/ttyUSB0" (but without the quotation marks).  For software
- generated speech, enter "none".
+#flag:comment:3
+# Translators, please do not translate "none"
+_Description: Hardware port of the speech generation device:
+ If a hardware device is used to generate speech, please enter the
+ Unix device file associated with it, such as' /dev/ttyS0' or
+ '/dev/ttyUSB0'
+ .
+ If you use a software method to generate speech, please enter 'none'.

Use the recommended way to put comments for translators (man
po-debconf)

Make it clearer what port we're talking about in the short
description.

Simplify the sentence with "such as". Drop the 'but without'
thing....users should figure this out by themselves.

Put the software method thing in its own paragraph for readability.
 
 Template: shared/emacspeak/invalidport
 Type: error
-_Description: ERROR: ${port} is not a character special device.
+_Description: ${port} is not a character special device

"error" templates make it clear this is an error. No need to
emphasize.

No final dot as short description should be taken as titles.
 
 Template: shared/emacspeak/groupies
 Type: string
 _Description: Users of speech server:
  Users must be members of group ${group} to access the speech server
- connected to ${port}.  Please review the following space-separated
- list of members, and add or remove usernames if needed.
- .
- For a user whose account doesn't exist yet, please reconfigure
- emacspeak after creating the account, with the command
+ connected to ${port}. Please review the space-separated list of
+ current members of that group, and add or remove usernames if needed.
  .
-   dpkg-reconfigure emacspeak
- .
- or manually enroll the user in ${group} with the command
- .
-   adduser ${group} mary
+ If you later add users to the system, you can either reconfigure
+ the emacspeak package afterwards, or enroll the user in ${group}
+ with 'adduser ${group} <user>'.
  .
  Group membership is checked at login time, so new members must log
  out and log in again before using the speech server.

Drop "following". This makes reference to interfaces and list might
not be "following".

Simplify the template (it will be shorted and will fit in one screen).

 
 Template: shared/emacspeak/invaliduser
 Type: error
-_Description: Skipping invalid username ${user}.
+_Description: Invalid username ${user}
  There is no user named ${user}, so no such user could be added to
  ${group}.

This is more in the spirit of "short description is a title"
 
 Template: shared/emacspeak/rootgroup
 Type: error
-_Description: ERROR: no normal user can use ${port}.
- Since the speech device is connected to ${port}, normal users must
- have permission to read and write that device.  Please change its
- mode with "chmod a+rw ${port}" or its group with "chown root.dialout
- ${port}", then configure emacspeak again with "dpkg-reconfigure
- emacspeak".
+_Description: ${port} non writable by unprivileged users
+ Since the speech device is connected to ${port}, unprivileged users must
+ have permission to read and write that device.
+ .
+ You should modify the device permissions with 'chmod a+rw ${port}'
+ or modify the device group with 'chown root.dialout ${port}',
+ then reconfigure emacspeak with 'dpkg-reconfigure emacspeak'.

Split in paragraphs for readability.

"write that device"? Shouldn't this be "write *on* that device"?

s/normal/unprivileged

rewrite the second sentence as an advice given to the local admin

 
 Template: shared/emacspeak/program
 Type: string
--- ../emacspeak.old/debian/control	2008-11-23 12:10:26.428833058 +0100
+++ debian/control	2008-11-23 12:35:14.400830720 +0100
@@ -14,11 +14,14 @@
 Suggests: emacspeak-ss, calc, psgml, xsltproc, eflite, espeak, w3-el-e21
 Description: speech output interface to Emacs
  Emacspeak is a speech output system that will allow someone who
- cannot see to work directly on a UNIX system.  Emacspeak is built on
- top of Emacs.  Once you start emacs with emacspeak loaded, you get
- spoken feedback for everything you do.  Your mileage will vary
- depending on how well you can use Emacs.  There is nothing that you
- cannot do inside Emacs :-).  This package includes speech servers
+ cannot see to work directly on a UNIX system.
+ .
+ Emacspeak is built on
+ top of Emacs.  Once Emacs is stared with emacspeak loaded, users get
+ spoken feedback for all actions.  As Emacs can do everything,
+ they get speech feedback for everything they do.
+ .
+ This package includes speech servers
  written in Tcl to support the DECtalk Express and DECtalk MultiVoice
  speech synthesizers.  For other synthesizers, look for separate
  speech server packages such as emacspeak-ss and eflite.

Split in paragraphs

Avoid adressing users directly and use neutral formualtion.

s/emacs/Emacs



-- 


Template: shared/emacspeak/fake
Type: select
Choices: ${choices}
Description: for internal use
 This template is never shown to the user and does not require
 translation.

Template: shared/emacspeak/device
Type: select
Choices: ${choices}
_Description: Default speech server:
 The /etc/emacspeak.conf file will be configured so that the command
 '/usr/bin/emacspeak' will start Emacs with emacspeak support using
 this server.
 .
 You may change the selection later by running
 'dpkg-reconfigure emacspeak' as root, or temporarily override the
 selection by setting the environment variable DTK_PROGRAM.
Default: DECtalk Express

Template: shared/emacspeak/port
Type: string
#flag:comment:3
# Translators, please do not translate "none"
_Description: Hardware port of the speech generation device:
 If a hardware device is used to generate speech, please enter the
 Unix device file associated with it, such as' /dev/ttyS0' or
 '/dev/ttyUSB0'
 .
 If you use a software method to generate speech, please enter 'none'.

Template: shared/emacspeak/invalidport
Type: error
_Description: ${port} is not a character special device

Template: shared/emacspeak/groupies
Type: string
_Description: Users of speech server:
 Users must be members of group ${group} to access the speech server
 connected to ${port}. Please review the space-separated list of
 current members of that group, and add or remove usernames if needed.
 .
 If you later add users to the system, you can either reconfigure
 the emacspeak package afterwards, or enroll the user in ${group}
 with 'adduser ${group} <user>'.
 .
 Group membership is checked at login time, so new members must log
 out and log in again before using the speech server.

Template: shared/emacspeak/invaliduser
Type: error
_Description: Invalid username ${user}
 There is no user named ${user}, so no such user could be added to
 ${group}.

Template: shared/emacspeak/rootgroup
Type: error
_Description: ${port} non writable by unprivileged users
 Since the speech device is connected to ${port}, unprivileged users must
 have permission to read and write that device.
 .
 You should modify the device permissions with 'chmod a+rw ${port}'
 or modify the device group with 'chown root.dialout ${port}',
 then reconfigure emacspeak with 'dpkg-reconfigure emacspeak'.

Template: shared/emacspeak/program
Type: string
Description: for internal use
 This template is never shown to the user and does not require
 translation.  This variable holds the path to the speech server,
 relative to /usr/share/<flavor>/site-lisp/emacspeak/servers.

Template: shared/emacspeak/tcl
Type: string
Description: for internal use
 This template is never shown to the user and does not require
 translation.  This variable holds the path to the interpreter if any
 used to run the speech server.

Template: shared/emacspeak/database
Type: select
Choices: ${choices}
Description: for internal use
 This template is never shown to the user and does not require
 translation.  This variable holds all the available choices for
 speech servers, and the corresponding values of "program", "tcl", and
 "device" for the above variables.
--- ../emacspeak.old/debian/templates	2008-11-23 12:10:26.428833058 +0100
+++ debian/templates	2008-11-23 12:36:48.928831903 +0100
@@ -1,7 +1,7 @@
 Template: shared/emacspeak/fake
 Type: select
 Choices: ${choices}
-Description: Which packages have installed speech servers?
+Description: for internal use
  This template is never shown to the user and does not require
  translation.
 
@@ -9,62 +9,59 @@
 Type: select
 Choices: ${choices}
 _Description: Default speech server:
- The file /etc/emacspeak.conf will be configured so that the command
- "/usr/bin/emacspeak" will start emacs with emacspeak support using
- this server.  You may change the selection later by running
- "dpkg-reconfigure emacspeak" as root, or temporarily override the
- selection by setting the environment variable DTK_PROGRAM.  If you
- want to use a server in a separate package, which does not appear in
- the list, just accept the default now, and you should be asked again
- when that other package is installed.
+ The /etc/emacspeak.conf file will be configured so that the command
+ '/usr/bin/emacspeak' will start Emacs with emacspeak support using
+ this server.
+ .
+ You may change the selection later by running
+ 'dpkg-reconfigure emacspeak' as root, or temporarily override the
+ selection by setting the environment variable DTK_PROGRAM.
 Default: DECtalk Express
 
 Template: shared/emacspeak/port
 Type: string
-# "none" must remain in english
-_Description: hardware port:
- If a hardware device is used to generate speech, enter the Unix
- device file associated with it.  For example, "/dev/ttyS0" or
- "/dev/ttyUSB0" (but without the quotation marks).  For software
- generated speech, enter "none".
+#flag:comment:3
+# Translators, please do not translate "none"
+_Description: Hardware port of the speech generation device:
+ If a hardware device is used to generate speech, please enter the
+ Unix device file associated with it, such as' /dev/ttyS0' or
+ '/dev/ttyUSB0'
+ .
+ If you use a software method to generate speech, please enter 'none'.
 
 Template: shared/emacspeak/invalidport
 Type: error
-_Description: ERROR: ${port} is not a character special device.
+_Description: ${port} is not a character special device
 
 Template: shared/emacspeak/groupies
 Type: string
 _Description: Users of speech server:
  Users must be members of group ${group} to access the speech server
- connected to ${port}.  Please review the following space-separated
- list of members, and add or remove usernames if needed.
- .
- For a user whose account doesn't exist yet, please reconfigure
- emacspeak after creating the account, with the command
+ connected to ${port}. Please review the space-separated list of
+ current members of that group, and add or remove usernames if needed.
  .
-   dpkg-reconfigure emacspeak
- .
- or manually enroll the user in ${group} with the command
- .
-   adduser ${group} mary
+ If you later add users to the system, you can either reconfigure
+ the emacspeak package afterwards, or enroll the user in ${group}
+ with 'adduser ${group} <user>'.
  .
  Group membership is checked at login time, so new members must log
  out and log in again before using the speech server.
 
 Template: shared/emacspeak/invaliduser
 Type: error
-_Description: Skipping invalid username ${user}.
+_Description: Invalid username ${user}
  There is no user named ${user}, so no such user could be added to
  ${group}.
 
 Template: shared/emacspeak/rootgroup
 Type: error
-_Description: ERROR: no normal user can use ${port}.
- Since the speech device is connected to ${port}, normal users must
- have permission to read and write that device.  Please change its
- mode with "chmod a+rw ${port}" or its group with "chown root.dialout
- ${port}", then configure emacspeak again with "dpkg-reconfigure
- emacspeak".
+_Description: ${port} non writable by unprivileged users
+ Since the speech device is connected to ${port}, unprivileged users must
+ have permission to read and write that device.
+ .
+ You should modify the device permissions with 'chmod a+rw ${port}'
+ or modify the device group with 'chown root.dialout ${port}',
+ then reconfigure emacspeak with 'dpkg-reconfigure emacspeak'.
 
 Template: shared/emacspeak/program
 Type: string
--- ../emacspeak.old/debian/control	2008-11-23 12:10:26.428833058 +0100
+++ debian/control	2008-11-23 12:35:14.400830720 +0100
@@ -14,11 +14,14 @@
 Suggests: emacspeak-ss, calc, psgml, xsltproc, eflite, espeak, w3-el-e21
 Description: speech output interface to Emacs
  Emacspeak is a speech output system that will allow someone who
- cannot see to work directly on a UNIX system.  Emacspeak is built on
- top of Emacs.  Once you start emacs with emacspeak loaded, you get
- spoken feedback for everything you do.  Your mileage will vary
- depending on how well you can use Emacs.  There is nothing that you
- cannot do inside Emacs :-).  This package includes speech servers
+ cannot see to work directly on a UNIX system.
+ .
+ Emacspeak is built on
+ top of Emacs.  Once Emacs is stared with emacspeak loaded, users get
+ spoken feedback for all actions.  As Emacs can do everything,
+ they get speech feedback for everything they do.
+ .
+ This package includes speech servers
  written in Tcl to support the DECtalk Express and DECtalk MultiVoice
  speech synthesizers.  For other synthesizers, look for separate
  speech server packages such as emacspeak-ss and eflite.
Source: emacspeak
Section: editors
Priority: extra
Maintainer: James R. Van Zandt <jrv@debian.org>
Build-Depends: debhelper (>= 5), po-debconf
Build-Depends-Indep: texi2html, lynx, texinfo, ghostscript
Standards-Version: 3.8.0
Homepage: http://emacspeak.sf.net

Package: emacspeak
Architecture: all
Depends: tclx8.4, tcl8.4, perl-5.6|perl, emacsen-common, make, emacs22|emacs21, w3-url-e21, adduser, debconf
Conflicts: emacspeak-dt (<= 0.30), emacspeak-ss (<< 1.12-2)
Suggests: emacspeak-ss, calc, psgml, xsltproc, eflite, espeak, w3-el-e21
Description: speech output interface to Emacs
 Emacspeak is a speech output system that will allow someone who
 cannot see to work directly on a UNIX system.
 .
 Emacspeak is built on
 top of Emacs.  Once Emacs is stared with emacspeak loaded, users get
 spoken feedback for all actions.  As Emacs can do everything,
 they get speech feedback for everything they do.
 .
 This package includes speech servers
 written in Tcl to support the DECtalk Express and DECtalk MultiVoice
 speech synthesizers.  For other synthesizers, look for separate
 speech server packages such as emacspeak-ss and eflite.

Attachment: signature.asc
Description: Digital signature


Reply to: