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

[RFR] templates://foomatic-filters/{foomatic-filters.templates}



Please find, for review, the debconf templates and packages descriptions for the foomatic-filters source package.

This review will last from Sunday, September 16, 2007 to Wednesday, September 26, 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:
--- ../foomatic-filters.old/debian/foomatic-filters.templates	2007-09-07 06:08:23.344377743 +0200
+++ debian/foomatic-filters.templates	2007-09-14 07:49:16.584826016 +0200
@@ -2,11 +2,11 @@
 Type: boolean
 Default: false
 _Description: Enable logging debug output into a logfile (INSECURE)?
- The logfile will be named /tmp/foomatic-rip.log.
+ If you choose this option, the logfile will be named /tmp/foomatic-rip.log.

The original sentence assumed that it comes *after* the short
description which is not guaranteed. So re-link the statement with the
queston.

  .
- WARNING: This logfile is a security hole; do not use in production.
- However, if you are having trouble printing, you should enable this option
- and include this logfile in any bug reports.
+ This option is a potential security issue and should not be used
+ in production. However, if you are having trouble printing, you should
+ enable it and include the logfile in bug reports.

I tend to discourage proeminent "WARNING", "NOTE" and the
like. Separating the warning in a paragraph is usually enough.

The logfile by itself is not the security issue. It's having it and
the software logging to it that is a risk.

 
 Template: foomatic-filters/textfilter
 Type: select
@@ -14,7 +14,7 @@
 __Choices: Automagic, a2ps, mpage, enscript, Custom
 Default: Automagic
 _Description: Command for converting text files to PostScript:
- If you select ``Automagic'', Foomatic will search for one of a2ps,
+ If you select 'Automagic', Foomatic will search for one of a2ps,
  mpage, and enscript (in that order) each time the filter script is executed.

Use consistent quoting all along the package (we usually recommend
single quotes).

  .
  Please make sure that the selected command is actually available; otherwise
@@ -28,7 +28,7 @@
 Template: foomatic-filters/custom_textfilter
 Type: string
 _Description: Command to convert standard input to PostScript:
- This should be the full command line of a command that converts text from
+ Please enter the full command line of a command that converts text from

Here as well, avoid assumign that the long descripton comes after the
short. So use the common way we recommend ("Please enter")

  standard input to PostScript on standard output.
  .
  Please note that entering an invalid command line here may result in lost
@@ -38,12 +38,13 @@
 Type: boolean
 Default: false
 _Description: Enable PostScript accounting for CUPS?
- Insert PostScript code for accounting into each print job.  This currently
- only works with CUPS.
- .
- Note: When used with generic PostScript printers (and under certain
- conditions with other printers also) this causes an extra page to be
- printed after each job, so this is off by default.
+ You should choose this option if you want to insert PostScript code
+ for accounting into each print job. This is currently only useful
+ with CUPS.

About the same rationale again.


+ .
+ When used with generic PostScript printers (and under certain
+ conditions with other printers) this causes an extra page to be
+ printed after each job.

And here again.
 
 Template: foomatic-filters/gspath
 Type: select
@@ -52,25 +53,26 @@
 Default: gs
 _Description: Ghostscript interpreter to be used by Foomatic:
  For non-PostScript printers, print jobs are usually translated from
- PostScript to your printer's command language using the free
+ PostScript to the printer's command language using the free
  Ghostscript interpreter.

Unpersonnalize: s/your printer/the printer

  .
  There are a number of different versions of the Ghostscript
- interpreter available on Debian systems.  Normally, Foomatic will
- use the default version (configured by the `gs' alternative, which
- can be changed with `update-alternatives --config gs').  However,
+ interpreter available. Normally, Foomatic will
+ use the default version (configured by the 'gs' alternative, which
+ can be changed with 'update-alternatives --config gs').  However,

Unbranding (ie remove "Debian"). That makes life easier for derived
distributions where it is often weird to see references to "Debian
systems" while users are indeed installing "Debian-Edu", "Skolelinux",
"Linex" or...."Ubuntu".


  you may want to use a different Ghostscript for screen display than
  for printing; 'gs-esp' is usually a good choice for printing.
- (You should use the Custom option if you have a locally-installed
- Ghostscript interpreter.)
  .
- If in doubt, you should simply accept the default option (gs).
+ You should use the Custom option if you have a locally-installed
+ Ghostscript interpreter.

Move explanations about Custom on its own paragraph. Remove the "if in
doubt, choose the default" as this is always what users do..:-)

 
 Template: foomatic-filters/custom_gspath
 Type: string
 _Description: Custom Ghostscript interpreter path:
- You should enter the full path to your preferred Ghostscript
- interpreter; e.g. `/opt/artifex.com-ghostscript/bin/gs'.
+ Please enter the full path to the custom Ghostscript
+ interpreter.
+ .
+ Example: /opt/artifex.com-ghostscript/bin/gs

Again, "Please enter".

Move the example on its own paragraph.

 
 Template: foomatic-filters/spooler
 Type: select
@@ -78,14 +80,14 @@
 Default: direct
 _Description: Printer spooler backend for Foomatic:
  Foomatic normally requires a printer spooler (like CUPS or LPRng) to
- handle communication with the printer and manage print jobs.  If you
- don't have a spooler installed, you can use the "direct" backend, but
+ handle communication with the printer and manage print jobs. If
+ no spooler is installed, you can use the 'direct' backend, but

Remove double space after the sentence dot (debated issue but this is
what we usually recommend).

Unpersonnalize and replace "you don't have" by "there is no"


  this is only recommended for single-user systems.
  .
  The installation process may have already detected the correct
- spooler; however, if this is the first time you are installing
- Debian, or you somehow have more than one spooler installed on your
- system, the detected spooler may be incorrect.
+ spooler; however, if this is the first installation of this system,
+ or if more than one spooler is installed,
+ the detected spooler may be incorrect.

Unbranding.

 
 Template: foomatic-filters/config_parsed
 Type: boolean
--- ../foomatic-filters.old/debian/control	2007-09-07 06:08:23.344377743 +0200
+++ debian/control	2007-09-14 07:41:56.607687132 +0200
@@ -15,10 +15,9 @@
 Replaces: foomatic-bin (<< 2.9), cupsomatic-ppd
 Description: linuxprinting.org printer support - filters
  Foomatic is a printer database designed to make it easier to set up
- common printers for use with Debian (and other operating systems).
+ common printers for use with UNIX-like operating systems.

Unbranding. I propose this as I suppose that foomatic-filters works
with any UNIX-like system


  It provides the "glue" between a print spooler (like CUPS or lpr) and
- your actual printer, by telling your computer how to process files
- sent to the printer.
+ the printer, by processing files sent to the printer.

Unpersonnalize...

  .
  This package consists of filter scripts used by the printer spoolers
  to convert the incoming PostScript data into the printer's native
@@ -29,4 +28,4 @@
  For use with CUPS, you will need both the cupsys and cupsys-client
  packages installed on your system.
  .
- Home Page: http://www.linuxprinting.org/
+  Homepage: http://www.linuxprinting.org/

Common method to specify upstream's home page, waiting for full
support of a "Homepage:" field in debian/control

-- 


Template: foomatic-filters/filter_debug
Type: boolean
Default: false
_Description: Enable logging debug output into a logfile (INSECURE)?
 If you choose this option, the logfile will be named /tmp/foomatic-rip.log.
 .
 This option is a potential security issue and should not be used
 in production. However, if you are having trouble printing, you should
 enable it and include the logfile in bug reports.

Template: foomatic-filters/textfilter
Type: select
#flag:translate:1,5
__Choices: Automagic, a2ps, mpage, enscript, Custom
Default: Automagic
_Description: Command for converting text files to PostScript:
 If you select 'Automagic', Foomatic will search for one of a2ps,
 mpage, and enscript (in that order) each time the filter script is executed.
 .
 Please make sure that the selected command is actually available; otherwise
 print jobs may get lost.
 .
 This setting is ignored when foomatic-filters is used with CUPS;
 instead, the texttops program included in the cupsys package is
 always used to convert jobs submitted as plain text to PostScript for
 printing to raster devices.

Template: foomatic-filters/custom_textfilter
Type: string
_Description: Command to convert standard input to PostScript:
 Please enter the full command line of a command that converts text from
 standard input to PostScript on standard output.
 .
 Please note that entering an invalid command line here may result in lost
 print jobs.

Template: foomatic-filters/ps_accounting
Type: boolean
Default: false
_Description: Enable PostScript accounting for CUPS?
 You should choose this option if you want to insert PostScript code
 for accounting into each print job. This is currently only useful
 with CUPS.
 .
 When used with generic PostScript printers (and under certain
 conditions with other printers) this causes an extra page to be
 printed after each job.

Template: foomatic-filters/gspath
Type: select
#flag:translate:5
__Choices: gs, gs-gnu, gs-esp, gs-afpl, Custom
Default: gs
_Description: Ghostscript interpreter to be used by Foomatic:
 For non-PostScript printers, print jobs are usually translated from
 PostScript to the printer's command language using the free
 Ghostscript interpreter.
 .
 There are a number of different versions of the Ghostscript
 interpreter available. Normally, Foomatic will
 use the default version (configured by the 'gs' alternative, which
 can be changed with 'update-alternatives --config gs').  However,
 you may want to use a different Ghostscript for screen display than
 for printing; 'gs-esp' is usually a good choice for printing.
 .
 You should use the Custom option if you have a locally-installed
 Ghostscript interpreter.

Template: foomatic-filters/custom_gspath
Type: string
_Description: Custom Ghostscript interpreter path:
 Please enter the full path to the custom Ghostscript
 interpreter.
 .
 Example: /opt/artifex.com-ghostscript/bin/gs

Template: foomatic-filters/spooler
Type: select
Choices: cups, lpd, lprng, pdq, ppr, direct
Default: direct
_Description: Printer spooler backend for Foomatic:
 Foomatic normally requires a printer spooler (like CUPS or LPRng) to
 handle communication with the printer and manage print jobs. If
 no spooler is installed, you can use the 'direct' backend, but
 this is only recommended for single-user systems.
 .
 The installation process may have already detected the correct
 spooler; however, if this is the first installation of this system,
 or if more than one spooler is installed,
 the detected spooler may be incorrect.

Template: foomatic-filters/config_parsed
Type: boolean
Default: false
Description: (for internal use only)
--- ../foomatic-filters.old/debian/foomatic-filters.templates	2007-09-07 06:08:23.344377743 +0200
+++ debian/foomatic-filters.templates	2007-09-14 07:49:16.584826016 +0200
@@ -2,11 +2,11 @@
 Type: boolean
 Default: false
 _Description: Enable logging debug output into a logfile (INSECURE)?
- The logfile will be named /tmp/foomatic-rip.log.
+ If you choose this option, the logfile will be named /tmp/foomatic-rip.log.
  .
- WARNING: This logfile is a security hole; do not use in production.
- However, if you are having trouble printing, you should enable this option
- and include this logfile in any bug reports.
+ This option is a potential security issue and should not be used
+ in production. However, if you are having trouble printing, you should
+ enable it and include the logfile in bug reports.
 
 Template: foomatic-filters/textfilter
 Type: select
@@ -14,7 +14,7 @@
 __Choices: Automagic, a2ps, mpage, enscript, Custom
 Default: Automagic
 _Description: Command for converting text files to PostScript:
- If you select ``Automagic'', Foomatic will search for one of a2ps,
+ If you select 'Automagic', Foomatic will search for one of a2ps,
  mpage, and enscript (in that order) each time the filter script is executed.
  .
  Please make sure that the selected command is actually available; otherwise
@@ -28,7 +28,7 @@
 Template: foomatic-filters/custom_textfilter
 Type: string
 _Description: Command to convert standard input to PostScript:
- This should be the full command line of a command that converts text from
+ Please enter the full command line of a command that converts text from
  standard input to PostScript on standard output.
  .
  Please note that entering an invalid command line here may result in lost
@@ -38,12 +38,13 @@
 Type: boolean
 Default: false
 _Description: Enable PostScript accounting for CUPS?
- Insert PostScript code for accounting into each print job.  This currently
- only works with CUPS.
- .
- Note: When used with generic PostScript printers (and under certain
- conditions with other printers also) this causes an extra page to be
- printed after each job, so this is off by default.
+ You should choose this option if you want to insert PostScript code
+ for accounting into each print job. This is currently only useful
+ with CUPS.
+ .
+ When used with generic PostScript printers (and under certain
+ conditions with other printers) this causes an extra page to be
+ printed after each job.
 
 Template: foomatic-filters/gspath
 Type: select
@@ -52,25 +53,26 @@
 Default: gs
 _Description: Ghostscript interpreter to be used by Foomatic:
  For non-PostScript printers, print jobs are usually translated from
- PostScript to your printer's command language using the free
+ PostScript to the printer's command language using the free
  Ghostscript interpreter.
  .
  There are a number of different versions of the Ghostscript
- interpreter available on Debian systems.  Normally, Foomatic will
- use the default version (configured by the `gs' alternative, which
- can be changed with `update-alternatives --config gs').  However,
+ interpreter available. Normally, Foomatic will
+ use the default version (configured by the 'gs' alternative, which
+ can be changed with 'update-alternatives --config gs').  However,
  you may want to use a different Ghostscript for screen display than
  for printing; 'gs-esp' is usually a good choice for printing.
- (You should use the Custom option if you have a locally-installed
- Ghostscript interpreter.)
  .
- If in doubt, you should simply accept the default option (gs).
+ You should use the Custom option if you have a locally-installed
+ Ghostscript interpreter.
 
 Template: foomatic-filters/custom_gspath
 Type: string
 _Description: Custom Ghostscript interpreter path:
- You should enter the full path to your preferred Ghostscript
- interpreter; e.g. `/opt/artifex.com-ghostscript/bin/gs'.
+ Please enter the full path to the custom Ghostscript
+ interpreter.
+ .
+ Example: /opt/artifex.com-ghostscript/bin/gs
 
 Template: foomatic-filters/spooler
 Type: select
@@ -78,14 +80,14 @@
 Default: direct
 _Description: Printer spooler backend for Foomatic:
  Foomatic normally requires a printer spooler (like CUPS or LPRng) to
- handle communication with the printer and manage print jobs.  If you
- don't have a spooler installed, you can use the "direct" backend, but
+ handle communication with the printer and manage print jobs. If
+ no spooler is installed, you can use the 'direct' backend, but
  this is only recommended for single-user systems.
  .
  The installation process may have already detected the correct
- spooler; however, if this is the first time you are installing
- Debian, or you somehow have more than one spooler installed on your
- system, the detected spooler may be incorrect.
+ spooler; however, if this is the first installation of this system,
+ or if more than one spooler is installed,
+ the detected spooler may be incorrect.
 
 Template: foomatic-filters/config_parsed
 Type: boolean
--- ../foomatic-filters.old/debian/control	2007-09-07 06:08:23.344377743 +0200
+++ debian/control	2007-09-14 07:41:56.607687132 +0200
@@ -15,10 +15,9 @@
 Replaces: foomatic-bin (<< 2.9), cupsomatic-ppd
 Description: linuxprinting.org printer support - filters
  Foomatic is a printer database designed to make it easier to set up
- common printers for use with Debian (and other operating systems).
+ common printers for use with UNIX-like other operating systems.
  It provides the "glue" between a print spooler (like CUPS or lpr) and
- your actual printer, by telling your computer how to process files
- sent to the printer.
+ the printer, by processing files sent to the printer.
  .
  This package consists of filter scripts used by the printer spoolers
  to convert the incoming PostScript data into the printer's native
@@ -29,4 +28,4 @@
  For use with CUPS, you will need both the cupsys and cupsys-client
  packages installed on your system.
  .
- Home Page: http://www.linuxprinting.org/
+  Homepage: http://www.linuxprinting.org/
Source: foomatic-filters
Section: text
Priority: optional
Maintainer: Chris Lawrence <lawrencc@debian.org>
Build-Depends: debhelper (>> 4)
Build-Depends-Indep: po-debconf
Standards-Version: 3.7.2

Package: foomatic-filters
Architecture: all
Pre-Depends: bash (>= 2.05)
Depends: ${perl:Depends}, ${misc:Depends}, ucf (>= 0.30)
Recommends: cupsys-client | lpr | lprng | pdq | rlpr, gs-esp | gs, cupsys | enscript | a2ps | mpage, foomatic-db-engine
Conflicts: foomatic-bin (<< 2.9), cupsomatic-ppd (<< 20030507), gs (<< 8.0), gs-aladdin (<< 8.0)
Replaces: foomatic-bin (<< 2.9), cupsomatic-ppd
Description: linuxprinting.org printer support - filters
 Foomatic is a printer database designed to make it easier to set up
 common printers for use with UNIX-like operating systems.
 It provides the "glue" between a print spooler (like CUPS or lpr) and
 the printer, by processing files sent to the printer.
 .
 This package consists of filter scripts used by the printer spoolers
 to convert the incoming PostScript data into the printer's native
 format using a printer-specific, but spooler-independent PPD file.
 You will need to install the foomatic-db-engine package and its
 dependencies for this package to be useful.
 .
 For use with CUPS, you will need both the cupsys and cupsys-client
 packages installed on your system.
 .
  Homepage: http://www.linuxprinting.org/

Attachment: signature.asc
Description: Digital signature


Reply to: