Please find, for review, the debconf templates and packages descriptions for the rtfm source package.
This review will last from Monday, October 22, 2007 to Thursday, November 01, 2007.
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:
--- ../rtfm.old/debian/templates 2007-10-19 07:50:33.343782503 +0200
+++ debian/templates 2007-10-22 07:36:43.725421943 +0200
@@ -1,34 +1,37 @@
Template: rt3.6-rtfm/modify-database-permission
Type: select
-_Choices: allow, prompt, deny
+__Choices: allow, prompt, deny
Split choices to make the translator's work easier
Default: allow
_Description: Permission to modify the database:
- RTFM needs some database modifications to be functional. If you want, the
- installation procedure can make these modifications automatically or
- prompt you when they are needed. Alternatively, you can run the necessary
- commands manually. See README.Debian.
+ RTFM needs some database modifications to be functional. These
+ modifications can be made automatically or
+ you may be prompted when they are needed. Alternatively, you can run the necessary
+ commands manually.
+ .
+ Please check the /usr/share/doc/rtfm/README.Debian file for more details.
Avoid the "if you want" style and just be factual.
Make a longer sentence than just "See README.Debian"
Template: rt3.6-rtfm/modify-database-prompt
Type: boolean
Default: true
+#flag:translate!:3
_Description: Modify the database?
- It looks like RTFM needs a database modification to be functional: ${modification}.
+ A database modification is required for RTFM to be functional:
+ .
+ ${modification}
Move the variable along in its own paragraph, then made non
translatable. Will avoid mistakes by translators.
Be factual: it does not "look like". We are bloody sure of this..:-)
Template: rt3.6-rtfm/modify-database-error
Type: select
-_Choices: abort, retry, ignore
+__Choices: abort, retry, ignore
Default: abort
-_Description: Error modifying the database. Solution:
- An error seems to have occurred while modifying the database. If it's of
- any help, this was the error encountered:
+#flag:translate!:3
+_Description: Action after database modification error:
+ An error occurred while modifying the database:
Respecting the advice from the Developer's Reference here is tricky.
I'm not entirely convinced by my proposed changes..:)...Better, imho,
than the original version (2 sentences in the synopsis is really discouraged).
.
${error}
.
The full output should be available in the RT log, most probably syslog.
.
- You can either retry, abort the installation or ignore the error. If you
- want to retry, another attempt will be made at performing the operation.
- If you abort, the operation will fail and you will need to downgrade,
- reinstall, reconfigure the package, or otherwise manually intervene to
- continue using it. If you choose to ignore the error, the operation will
+ You can either retry the modification, abort the installation or ignore the error.
+ If you abort the instalaltion, the operation will fail and you will need to downgrade,
+ reinstall, reconfigure the package, or manually apply the needed changes
+ to continue using RTFM. If you choose to ignore the error, the upgrade process will
continue.
Rephrase. Can be enhanced, still, imho.
--- ../rtfm.old/debian/control 2007-10-19 07:50:33.343782503 +0200
+++ debian/control 2007-10-22 07:38:36.219848905 +0200
@@ -13,15 +13,15 @@
libyaml-perl, libtree-simple-perl, ${misc:Depends}, ${perl:Depends},
debconf | debconf-2.0, ucf (>= 0.28)
Description: RT FAQ Manager
- RTFM is an enterprise-grade knowledge management tool that enables an
+ RTFM is an knowledge management tool that enables an
"enterprise-grade" sounds like advertising.
organization to easily capture and share its employees' knowledge and wisdom.
.
Just as you use RT (Request Tracker, the open-source ticketing system) to log
tickets and resolve issues, RTFM lets you open, categorize and search for
- "articles." Like RT, RTFM lets your users contribute additional information
- to existing articles and makes sure that each article's full history is
- preserved for future inspection. RTFM makes it easy to quickly search the
- knowledge base and find critical information.
+ "articles." Like RT, RTFM lets users contribute additional information
+ to existing articles. It guarantees that each article's full history is
+ preserved for future inspection. RTFM simplifies browsing in the
+ knowledge base and finding critical information.
Avoid "yours" users.
Replace "makes it easy" by "simplify". Right ?
.
RTFM is implemented as an add-on to RT. This package integrates with
RT 3.6, available in the request-tracker3.6 package.
--
Template: rt3.6-rtfm/modify-database-permission
Type: select
__Choices: allow, prompt, deny
Default: allow
_Description: Permission to modify the database:
RTFM needs some database modifications to be functional. These
modifications can be made automatically or
you may be prompted when they are needed. Alternatively, you can run the necessary
commands manually.
.
Please check the /usr/share/doc/rtfm/README.Debian file for more details.
Template: rt3.6-rtfm/modify-database-prompt
Type: boolean
Default: true
#flag:translate!:3
_Description: Modify the database?
A database modification is required for RTFM to be functional:
.
${modification}
Template: rt3.6-rtfm/modify-database-error
Type: select
__Choices: abort, retry, ignore
Default: abort
#flag:translate!:3
_Description: Action after database modification error:
An error occurred while modifying the database:
.
${error}
.
The full output should be available in the RT log, most probably syslog.
.
You can either retry the modification, abort the installation or ignore the error.
If you abort the instalaltion, the operation will fail and you will need to downgrade,
reinstall, reconfigure the package, or manually apply the needed changes
to continue using RTFM. If you choose to ignore the error, the upgrade process will
continue.
--- ../rtfm.old/debian/templates 2007-10-19 07:50:33.343782503 +0200
+++ debian/templates 2007-10-22 07:36:43.725421943 +0200
@@ -1,34 +1,37 @@
Template: rt3.6-rtfm/modify-database-permission
Type: select
-_Choices: allow, prompt, deny
+__Choices: allow, prompt, deny
Default: allow
_Description: Permission to modify the database:
- RTFM needs some database modifications to be functional. If you want, the
- installation procedure can make these modifications automatically or
- prompt you when they are needed. Alternatively, you can run the necessary
- commands manually. See README.Debian.
+ RTFM needs some database modifications to be functional. These
+ modifications can be made automatically or
+ you may be prompted when they are needed. Alternatively, you can run the necessary
+ commands manually.
+ .
+ Please check the /usr/share/doc/rtfm/README.Debian file for more details.
Template: rt3.6-rtfm/modify-database-prompt
Type: boolean
Default: true
+#flag:translate!:3
_Description: Modify the database?
- It looks like RTFM needs a database modification to be functional: ${modification}.
+ A database modification is required for RTFM to be functional:
+ .
+ ${modification}
Template: rt3.6-rtfm/modify-database-error
Type: select
-_Choices: abort, retry, ignore
+__Choices: abort, retry, ignore
Default: abort
-_Description: Error modifying the database. Solution:
- An error seems to have occurred while modifying the database. If it's of
- any help, this was the error encountered:
+_Description: Action after database modification error:
+ An error occurred while modifying the database:
.
${error}
.
The full output should be available in the RT log, most probably syslog.
.
- You can either retry, abort the installation or ignore the error. If you
- want to retry, another attempt will be made at performing the operation.
- If you abort, the operation will fail and you will need to downgrade,
- reinstall, reconfigure the package, or otherwise manually intervene to
- continue using it. If you choose to ignore the error, the operation will
+ You can either retry the modification, abort the installation or ignore the error.
+ If you abort the instalaltion, the operation will fail and you will need to downgrade,
+ reinstall, reconfigure the package, or manually apply the needed changes
+ to continue using RTFM. If you choose to ignore the error, the upgrade process will
continue.
--- ../rtfm.old/debian/control 2007-10-19 07:50:33.343782503 +0200
+++ debian/control 2007-10-22 07:38:36.219848905 +0200
@@ -13,15 +13,15 @@
libyaml-perl, libtree-simple-perl, ${misc:Depends}, ${perl:Depends},
debconf | debconf-2.0, ucf (>= 0.28)
Description: RT FAQ Manager
- RTFM is an enterprise-grade knowledge management tool that enables an
+ RTFM is an knowledge management tool that enables an
organization to easily capture and share its employees' knowledge and wisdom.
.
Just as you use RT (Request Tracker, the open-source ticketing system) to log
tickets and resolve issues, RTFM lets you open, categorize and search for
- "articles." Like RT, RTFM lets your users contribute additional information
- to existing articles and makes sure that each article's full history is
- preserved for future inspection. RTFM makes it easy to quickly search the
- knowledge base and find critical information.
+ "articles." Like RT, RTFM lets users contribute additional information
+ to existing articles. It guarantees that each article's full history is
+ preserved for future inspection. RTFM simplifies browsing in the
+ knowledge base and finding critical information.
.
RTFM is implemented as an add-on to RT. This package integrates with
RT 3.6, available in the request-tracker3.6 package.
Source: rtfm
Section: misc
Priority: optional
Maintainer: Debian Request Tracker Group <pkg-request-tracker-maintainers@lists.alioth.debian.org>
Uploaders: Niko Tyni <ntyni@iki.fi>
Build-Depends: quilt (>= 0.40-1), debhelper (>= 5)
Build-Depends-Indep: perl (>= 5.8.3), po-debconf
Standards-Version: 3.7.2.0
Package: rt3.6-rtfm
Architecture: all
Depends: request-tracker3.6, libhtml-tree-perl, libtime-modules-perl,
libyaml-perl, libtree-simple-perl, ${misc:Depends}, ${perl:Depends},
debconf | debconf-2.0, ucf (>= 0.28)
Description: RT FAQ Manager
RTFM is an knowledge management tool that enables an
organization to easily capture and share its employees' knowledge and wisdom.
.
Just as you use RT (Request Tracker, the open-source ticketing system) to log
tickets and resolve issues, RTFM lets you open, categorize and search for
"articles." Like RT, RTFM lets users contribute additional information
to existing articles. It guarantees that each article's full history is
preserved for future inspection. RTFM simplifies browsing in the
knowledge base and finding critical information.
.
RTFM is implemented as an add-on to RT. This package integrates with
RT 3.6, available in the request-tracker3.6 package.
Attachment:
signature.asc
Description: Digital signature