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

Bug#309502: marked as done (developers-reference: Additional information for the debconf templates style guide part and debconf l10n handling)

Your message dated Sun, 09 Apr 2006 10:47:09 -0700
with message-id <E1FSe0D-00075P-10@spohr.debian.org>
and subject line Bug#309502: fixed in developers-reference 3.3.7
has caused the attached Bug report to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what I am
talking about this indicates a serious mail system misconfiguration
somewhere.  Please contact me immediately.)

Debian bug tracking system administrator
(administrator, Debian Bugs database)
--- Begin Message --- 
Package: developers-reference
Version: 3.3.6
Severity: wishlist
Tags: patch

Back in March, Andreas Barth suggested me to propose some additional
information about the recommended practices to properly handle changes in
debconf templates when they're about spelling errors or typo corrections,
especially how to deal with translations.

This came after a thread in debian-i18n where I pointed a few methods to
handle this nicely for translators.

Later, in #308234, Joey Hess made some comments about the write style of
some templates in a package, recommending to avoid referring to debconf
interfaces in templates wording. This also seemed to be a nice addition to
make to the chapter about debconf in the DR.

Please find attached a patch which adds this information. I also defined a
new entity for the debian-i18n mailing list and made the few existing
references to it use that entity.

-- System Information:
Debian Release: 3.1
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'testing')
Architecture: i386 (i686)
Shell:  /bin/sh linked to /bin/bash
Kernel: Linux 2.6.8-2-686
Locale: LANG=C, LC_CTYPE=C (charmap=ANSI_X3.4-1968)

-- no debconf information

diff -Nru manuals.sgml.ori/developers-reference/common.ent manuals.sgml/developers-reference/common.ent
--- manuals.sgml.ori/developers-reference/common.ent	2005-05-13 23:29:16.775936670 +0200
+++ manuals.sgml/developers-reference/common.ent	2005-05-13 23:31:10.640776699 +0200
@@ -137,6 +137,7 @@
 <!ENTITY email-debian-devel-announce "<email>debian-devel-announce@&lists-host;</email>">
 <!ENTITY email-debian-devel-changes "<email>debian-devel-changes@lists.debian.org</email>">
 <!ENTITY email-debian-devel-req "<email>debian-devel-REQUEST@&lists-host;</email>">
+<!ENTITY email-debian-i18n "<email>debian-i18n@&lists-host;</email>">
 <!ENTITY email-debian-mentors "<email>debian-mentors@&lists-host;</email>">
 <!ENTITY email-debian-private "<email>debian-private@&lists-host;</email>">
 <!ENTITY email-debian-project "<email>debian-project@&lists-host;</email>">
diff -Nru manuals.sgml.ori/developers-reference/developers-reference.sgml manuals.sgml/developers-reference/developers-reference.sgml
--- manuals.sgml.ori/developers-reference/developers-reference.sgml	2005-05-13 23:29:17.045905468 +0200
+++ manuals.sgml/developers-reference/developers-reference.sgml	2005-05-13 23:36:59.000514894 +0200
@@ -4092,7 +4092,7 @@
 Most Debian package maintainers are not native English speakers. So,
 writing properly phrased templates may not be easy for them.
 	<p>
-Please use (and abuse) debian-l10n-english@lists.debian.org mailing
+Please use (and abuse) &email-debian-l10n-english; mailing
 list. Have your templates proofread.
 	<p>
 Badly written templates give a poor image of your package, of your
@@ -4106,10 +4106,10 @@
 	<sect2>Be kind to translators
 	<p>
 Debconf templates may be translated. Debconf, along with its sister
-package po-debconf offers a simple framework for getting
+package <prgn>po-debconf</prgn> offers a simple framework for getting
 templates translated by translation teams or even individuals.
 	<p>
-Please use gettext-based templates. Install po-debconf on your
+Please use gettext-based templates. Install <package>po-debconf</package> on your
 development system and read its documentation ("man po-debconf" is a
 good start).
 	<p>
@@ -4122,10 +4122,57 @@
 translator's name and e-mail addresses are mentioned in the po files
 headers.
 	<p>
+The use of the <prgn>podebconf-report-po</prgn> from the
+po-debconf package is highly recommended to warn translators which
+have incomplete translations and request them for updates.
+	<p>
 If in doubt, you may also contact the translation team for a given
 language (debian-l10n-xxxxx@lists.debian.org), or the
-debian-i18n@lists.debian.org mailing list.
-
+&email-debian-i18n; mailing list.
+	<p>
+Calls for translations posted to
+&email-debian-i18n; with the <file>debian/po/templates.pot</file> file
+attached or referenced in a URL are encouraged. Be sure to mentions in
+these calls for new translations which languages you have existing
+translations for, in order to avoid duplicate work.
+	<sect2>Unfuzzy complete translations when correcting typos and spelling
+	<p>
+
+When the text of a debconf template is corrected and you are
+<strong>sure</strong> that the change does <strong>not</strong> affect
+translations, please be kind to translators and unfuzzy their
+translations.
+	<p>
+If you don't do so, the whole template will not be translated as long
+as a translator will send you an update.
+	<p>
+To <strong>unfuzzy</strong> translations, you can proceed the following way:
+	<enumlist>
+	<item>
+Put all incomplete PO files out of the way. You can check the
+completeness by using (needs the <package>gettext</package> package installed):
+<example>for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null
+--statistics $i; done</example>
+	<item>
+move all files which report either fuzzy strings to a temporary
+place. Files which report no fuzzy strings (only translated and
+untranslated) will be kept in place.
+	<item>
+now <strong>and now only</strong>, modify the template for the typos
+and check again that translation are not impacted (typos, spelling
+errors, sometimes typographical corrections are usually OK)
+	<item>
+run <prgn>debconf-updatepo</prgn>. This will fuzzy all strings
+you modified in translations. You can see this by running the above
+again
+	<item>
+use the following command:
+<example>for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done</example>
+	<item>
+move back to debian/po the files which showed fuzzy strings in the first step
+	<item>
+run <prgn>debconf-updatepo</prgn> again
+	</enumlist>
 	<sect2>Do not make assumptions about interfaces
 	<p>
 Templates text should not make reference to widgets belonging to some
@@ -4133,6 +4180,12 @@
 meaning for users of graphical interfaces which use checkboxes for
 boolean questions.
 	<p>
+String templates should also avoid mentioning the default values in
+their description. First, because this is redundant with the values
+seen by the users. Also, because these default values may be different
+from the maintainer choices (for instance, when the debconf database
+was preseeded).
+	<p>
 More generally speaking, try to avoid referring to user actions.
 Just give facts.
 
diff -Nru manuals.sgml.ori/developers-reference/dynamic.ent manuals.sgml/developers-reference/dynamic.ent
--- manuals.sgml.ori/developers-reference/dynamic.ent	1970-01-01 01:00:00.000000000 +0100
+++ manuals.sgml/developers-reference/dynamic.ent	2005-05-13 23:33:03.556726396 +0200
@@ -0,0 +1 @@
+<!entity % htmltext "IGNORE">

--- End Message ---
--- Begin Message --- 
Source: developers-reference
Source-Version: 3.3.7

We believe that the bug you reported is fixed in the latest version of
developers-reference, which is due to be installed in the Debian FTP archive:

developers-reference-fr_3.3.7_all.deb
  to pool/main/d/developers-reference/developers-reference-fr_3.3.7_all.deb
developers-reference_3.3.7.dsc
  to pool/main/d/developers-reference/developers-reference_3.3.7.dsc
developers-reference_3.3.7.tar.gz
  to pool/main/d/developers-reference/developers-reference_3.3.7.tar.gz
developers-reference_3.3.7_all.deb
  to pool/main/d/developers-reference/developers-reference_3.3.7_all.deb



A summary of the changes between this version and the previous one is
attached.

Thank you for reporting the bug, which will now be closed.  If you
have further comments please address them to 309502@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.

Debian distribution maintenance software
pp.
Andreas Barth <aba@not.so.argh.org> (supplier of updated developers-reference package)

(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@debian.org)


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Format: 1.7
Date: Sun, 09 Apr 2006 11:31:52 -0600
Source: developers-reference
Binary: developers-reference-fr developers-reference
Architecture: source all
Version: 3.3.7
Distribution: unstable
Urgency: low
Maintainer: Debian Documentation Project <debian-doc@lists.debian.org>
Changed-By: Andreas Barth <aba@not.so.argh.org>
Description: 
 developers-reference - guidelines and information for Debian developers
 developers-reference-fr - guidelines and information for Debian developers, in French
Closes: 295483 297069 298016 299217 302000 305947 306120 306630 308103 309502 317411 320981 326857 327682 334820 336146 338660 339826 340024 341195 341197 341568 344303 347229 348160 349493 351255 351944 352749 353447
Changes: 
 developers-reference (3.3.7) unstable; urgency=low
 .
   * Andreas Barth:
     - adjust information about distributions with reality.
     - add note on alioth accounts. Thanks, Phillip Kern. Closes: #306630
     - correct manpage section of dpkg-scanpackages. Closes: #297069
     - fix RFC 2440 URL. Closes: #308103
     - add $arch@buildd information. Closes: #295483
     - link to keyring.d.o for key replacement. Thanks, Martin Michlmayr.
       Closes: #298016
     - add information about Packages-arch-specific. Thanks, Frank Küster.
       Closes: #302000
     - add hint about LWN subscription. Thanks, Martin Michlmayr.
       Closes: #299217
     - more about debconf-style translation. Thanks, Christian Perrier.
       Closes: #309502
     - non-us discontinued.
     - document nmu changes wrt version tracking. Thanks, Justin Pryzby.
       Closes: #341197
     - fix spelling issues. Thanks to various people.
       Closes: #336146, #326857, #338660
     - update menu policy helpers. Thanks, Florian Ernst. Closes: #340024
     - send mia-mail to mia@qa. Thanks, Adam D. Barratt. Closes: #341568
     - Joerg Jaspert is now freenode contact. Closes: #344303
     - give a clearer description of the gpg v4-key issues. Thanks,
       Martin Michlmayr and Peter Palfrader. Closes: #317411
     - more verbose about Homepage. Closes: #339826
     - add sarge and etch. Closes: #327682
     - document severity of RoM-request bugs. Closes: #305947
     - update FSF address. Closes: #334820
     - fix P-a-s link. Closes: #341195
     - reflect binNMU changes. Closes: #349493
     - new security upload queue. Closes: #352749
     - fix experimental's sources.list entry. Closes: #347229
     - remove deprecated "Closes:..." to ACK NMU bug fixes. Closes: #353447
     - when resigning, gpg-sign your mail. Closes: #348160
     - make pristine source and repackaged origtargz anchors work.
       Closes: #351255
     - same number of RC bugs is ok. Closes: #351944
     - dpkg-source doesn't keep permissions. Thanks, Enrico Zini.
       Closes: #306120
     - also mention aspell. Closes: #320981
 .
   * Frédéric Bothamy
     - French translation updated to version 3.3.7, proofread by Bernard Adrian
Files: 
 1fa3306d313ef71c320b29fc65de5a73 687 doc optional developers-reference_3.3.7.dsc
 a5ebba2123818aa47c897654ac1352c0 272598 doc optional developers-reference_3.3.7.tar.gz
 075ee8db80660b21d2d1b51ca29e79c4 589522 doc optional developers-reference_3.3.7_all.deb
 43eeb36aeb4ed2ff90bf3d2934867239 231352 doc optional developers-reference-fr_3.3.7_all.deb

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (GNU/Linux)

iD8DBQFEOUZDmdOZoew2oYURAurBAKCxZGWku01W9/y4hgoovvanK/0S4ACdHkMA
U767wyMyp3Imd76flAehRNs=
=2Xb4
-----END PGP SIGNATURE-----

--- End Message ---
Reply to: