Package: developers-reference Version: 3.3.7 Severity: minor Tags: patch Hi, Please find attached a patch with two fixes for the debconf templates writing guide: * the "error" type is now perfectly dealt with by debconf * the extended description should never include a question. It was initially restricted to the boolean templates because of the yes/no form, where it is more current to see a question, but maintainers tend to add questions everywhere. The prompting style should only be part of the short description. Cheers, -- Thomas Huriaux
Index: developers-reference.sgml =================================================================== RCS file: /cvs/debian-doc/ddp/manuals.sgml/developers-reference/developers-reference.sgml,v retrieving revision 1.315 diff -u -r1.315 developers-reference.sgml --- developers-reference.sgml 12 Nov 2006 11:05:22 -0000 1.315 +++ developers-reference.sgml 3 Dec 2006 11:41:45 -0000 @@ -4383,13 +4383,6 @@ <sect3>error: <p> -<strong>THIS TEMPLATE TYPE IS NOT HANDLED BY DEBCONF YET.</strong> - <p> -It has been added to cdebconf, the C version of debconf, first used in -the Debian Installer. - <p> -Please do not use it unless debconf supports it. - <p> This type is designed to handle error message. It is mostly similar to the "note" type. Frontends may present it differently (for instance, the dialog frontend of cdebconf draws a red screen instead of the @@ -4430,6 +4423,8 @@ because that means that in the classical dialog interface, people will need to scroll, and lot of people just don't do that. <p> +The extended description should <strong>not</strong> include a question. + <p> For specific rules depending on templates type (string, boolean, etc.), please read below. @@ -4482,8 +4477,6 @@ question is rather long (remember that translations are often longer than original versions) -<item> The extended description should <strong>not</strong> include a question. - <item> Again, please avoid referring to specific interface widgets. A common mistake for such templates is "if you answer Yes"-type constructions.
Description: Digital signature