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

Re: [RFR] templates://prey/{templates}



Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.
[...]
>  Template: prey/active_modules
>  Type: multiselect
>  Choices: ${choices}
>  Default: alarm
> +_Description: Modules to activate:
> + Prey modules extend the application functionality either for
> + reports or actions.

If the distinction between reports and actions has no effect here,
why mention it?  Likewise we don't particularly need to be told
that the optional modules "extend the application functionality" -
that's pretty much the definition of modules, isn't it?

On the other hand I'm assuming that all of these following modules
are only triggered if Prey decides the machine has been stolen, but it
would help if that context was clearer - don't talk about activating
the modules, since that sounds as if they'll go off immediately!

> +  * network: collects information about the Internet connection;
> +  * session: takes a screenshot, collects information about modified
> +             files and running programs;
> +  * webcam : tries to take a picture using the webcam;
> +  * geo    : attempts to geolocate the device by using its internal
> +             GPS or the nearest WiFi access points as reference;
> +  * alarm  : plays a loud sound for 30 seconds;
> +  * alert  : shows the thier a short message and optionally change the
> +             wallpaper;

s/thier/thief/, s/change/changes/
The trouble with "optionally" is that it makes me imagine Prey
politely asking the thief "do you mind if I change the wallpaper?"

> +  * lock   : locks the laptop from being used and asks for a password;

s/laptop/device/ since you can install this on other things too.
s/from being used// (unidiomatic)

> +  * secure : deletes browser cookies and stored passwords.
>
> Make the enumeration consistent: verbs at third person, semi-colons, alignment

Unfortunately this trick for aligning colons is basically just not
allowed in English typography.  Also: sort the modules by name.

So that's:

   _Description: Modules to enable:
    Prey has many optional modules; if enabled they will be triggered
    automatically if the device is stolen.
    .
     * alarm:   plays a loud sound for 30 seconds;
     * alert:   shows the thief a short message (and may change the
                wallpaper);
     * geo:     attempts to geolocate the device by using its internal
                GPS or the nearest WiFi access points as reference;
     * lock:    locks the device and asks for a password;
     * network: collects information about the Internet connection;
     * secure:  deletes browser cookies and stored passwords;
     * session: takes a screenshot, collects information about modified
                files and running programs;
     * webcam:  tries to take a picture using the webcam.

>  Template: prey/edit_config
>  Type: note
> +_Description: Configuration finalization needed
> + In order to finalize the configuration, you need to choose Prey's
> + running mode.

In en_US "finalize" is widely seen as a pointless bureaucratic jargon
word for "complete" (it's okay in en_AU and spelled differently in
en_GB).

>   .
> + This must be done by editing the "/etc/prey/config" file and choosing
> + among:

You choose between options, not among them (especially when there are
only two).

> + .
> +  * Standalone   : reports are sent directly to the laptop's owner. This
> +                   requires the user to activate Prey by
> +                   generating/deleting a URL and setup either an scp,
> +                   sftp or mail server.
> +  * Control Panel: reports are sent to preyproject.com. After
> +                   the creation of an account at 
> +                   http://control.preyproject.com/signup, you need
> +                   to set "apt_key" and "device_key" properly in
> +                   the "/etc/prey/config" file.

s/laptop/device/ or just omit the word.
s/setup/setting up/

Generating/deleting a URL is something I do in my browser (or text
editor), not on a webserver.  Then "either of" three options is
unpopular with English teachers, but what's an scp server?  And do you
really need to set up a dedicated server just for Prey?

So basically I've just rewritten it.  I hope this is wasted effort!

   _Description: Configuration required
    To finish configuring Prey, you need to edit "/etc/prey/config" and
    choose its running mode. The options are:
    .
     * Control Panel: reports are sent to preyproject.com. Go to
                      http://control.preyproject.com/signup and create
		      an account, then set "apt_key" and "device_key"
                      appropriately in the configuration file.
     * Standalone:    reports are sent directly to the owner at a
                      specified mail or SSH (scp/sftp) server when
		      activated via a trigger URL under your control.

(Again in alphabetical order!)

> 
> --- prey.old/debian/control	2011-02-13 11:18:29.483538793 +0100
> +++ prey/debian/control	2011-02-21 07:52:44.199054803 +0100
> @@ -26,10 +26,10 @@
>  Recommends: python (>= 2.5),
>   python-gtk2
>  Description: utility for tracking stolen computers
> - Prey is a lightweight program that will help you track and find your laptop if
> + Prey is a lightweight program that will help tracking and finding a laptop if
>   it ever gets stolen.
> 
> Not only "you"..:)

This leaves it slightly awkward, but in the process of rephrasing it
I've slightly upgraded its claimed usefulness:

    Prey is a lightweight program to help track and recover a stolen laptop.

It can also run on a palmtop, or a mainframe if you insist, but I
suppose we're describing its original basic idea.  In principle we
could even leave out the "help", since even if it fails this is still
what it was there to do, but a weasel a day keeps the lawyer away.

On the topic of weasels, time for my Obligatory Why-The-Name Footnote:
as a country boy, "prey" makes me think of the awful screams rabbits
can produce when something's caught them - appropriate but maybe not
what Sales and Marketing intended.  Instead I gather the thirty second
alarm is just a police siren.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
diff -ur old/control new/control
--- old/control	2011-02-13 11:28:13.033258879 +0000
+++ new/control	2011-02-21 11:13:16.965260820 +0000
@@ -26,10 +26,9 @@
 Recommends: python (>= 2.5),
  python-gtk2
 Description: utility for tracking stolen computers
- Prey is a lightweight program that will help you track and find your laptop if
- it ever gets stolen.
+ Prey is a lightweight program to help track and recover a stolen laptop.
  .
- Prey comprises a shell script which calls out on a regular basis to
- either a server run by prey project, or a url nominated by the system
- administrator. A graphical configuration tool is also provided which is
- used to maintain the simple config file.
+ It comprises a shell script which calls out on a regular basis to
+ either a server run by the Prey project, or a URL defined by the system
+ administrator. A graphical configuration tool is also provided in
+ order to maintain the simple config file.
diff -ur old/templates new/templates
--- old/templates	2011-02-13 11:28:10.992925707 +0000
+++ new/templates	2011-02-21 10:57:44.105259137 +0000
@@ -1,34 +1,40 @@
 Template: prey/reporting_frequency
 Type: string
 Default: 20
-_Description: Frequency of reports and actions:
- Number of minutes to wait before waking up Prey. Control Panel users can
- change this settings later on the web.
+_Description: Frequency of Prey reports and actions (minutes):
+ Please enter the time to wait before waking up Prey. Control Panel users can
+ change this setting later through the web interface.
 
 Template: prey/active_modules
 Type: multiselect
 Choices: ${choices}
 Default: alarm
-_Description: Modules:
- Modules extend application functionality, there are two types of modules
- available: Report and Actions modules.
+_Description: Modules to enable:
+ Prey has many optional modules; if enabled they will be triggered
+ automatically if the device is stolen.
  .
-  * network: collect information about the Internet connection.
-  * session: take a screenshot, collect information about modified files and running programs.
-  * webcam: try to take a picture using the webcam.
-  * geo: attempt lo geolocate the device by using its interal GPS or the nearest WiFi access points as reference.
-  * alarm: play a loud sound for 30 seconds.
-  * alert: show the thier a short message and optionally change the wallpaper.
-  * lock: lock the laptop from being used and ask for a password.
-  * secure: delete browser cookies and stored passwords.
+  * alarm:   plays a loud sound for 30 seconds;
+  * alert:   shows the thief a short message (and may change the
+             wallpaper);
+  * geo:     attempts to geolocate the device by using its internal
+             GPS or the nearest WiFi access points as reference;
+  * lock:    locks the device and asks for a password;
+  * network: collects information about the Internet connection;
+  * secure:  deletes browser cookies and stored passwords;
+  * session: takes a screenshot, collects information about modified
+             files and running programs;
+  * webcam:  tries to take a picture using the webcam.
 
 Template: prey/edit_config
 Type: note
-_Description: Finalize the configuration
- In order to finalize the configuration, it needs to choose which mode Prey should run in.
- This can be achieved by editing the file `/etc/prey/config' by hand, according to own preferences:
+_Description: Configuration required
+ To finish configuring Prey, you need to edit "/etc/prey/config" and
+ choose its running mode. The options are:
  .
-  * Standalone: Reports are sent directly to the laptop's owner.
-    This requires user to activate Prey by generating/deleting a URL and set up a scp/sftp/mail server settings as well.
-  * Control Panel: Reports are sent to preyproject.com.
-    After obtaining an account at http://control.preyproject.com/signup users only need to set 'apt_key' and 'device_key' properly in the `/etc/prey/config' file.
+  * Control Panel: reports are sent to preyproject.com. Go to
+                   http://control.preyproject.com/signup and create
+                   an account, then set "apt_key" and "device_key"
+                   appropriately in the configuration file.
+  * Standalone:    reports are sent directly to the owner at a
+                   specified mail or SSH (scp/sftp) server when
+                   activated via a trigger URL under your control.
Template: prey/reporting_frequency
Type: string
Default: 20
_Description: Frequency of Prey reports and actions (minutes):
 Please enter the time to wait before waking up Prey. Control Panel users can
 change this setting later through the web interface.

Template: prey/active_modules
Type: multiselect
Choices: ${choices}
Default: alarm
_Description: Modules to enable:
 Prey has many optional modules; if enabled they will be triggered
 automatically if the device is stolen.
 .
  * alarm:   plays a loud sound for 30 seconds;
  * alert:   shows the thief a short message (and may change the
             wallpaper);
  * geo:     attempts to geolocate the device by using its internal
             GPS or the nearest WiFi access points as reference;
  * lock:    locks the device and asks for a password;
  * network: collects information about the Internet connection;
  * secure:  deletes browser cookies and stored passwords;
  * session: takes a screenshot, collects information about modified
             files and running programs;
  * webcam:  tries to take a picture using the webcam.

Template: prey/edit_config
Type: note
_Description: Configuration required
 To finish configuring Prey, you need to edit "/etc/prey/config" and
 choose its running mode. The options are:
 .
  * Control Panel: reports are sent to preyproject.com. Go to
                   http://control.preyproject.com/signup and create
                   an account, then set "apt_key" and "device_key"
                   appropriately in the configuration file.
  * Standalone:    reports are sent directly to the owner at a
                   specified mail or SSH (scp/sftp) server when
                   activated via a trigger URL under your control.
Source: prey
Section: utils
Priority: optional
Maintainer: Alessio Treglia <alessio@debian.org>
Build-Depends: debhelper (>= 7.0.50~),
 python (>= 2.5),
 python-support,
 po-debconf
Homepage: http://www.preyproject.com/
Standards-Version: 3.9.1
XS-Python-Version: >= 2.5
Vcs-Git: git://git.debian.org/git/collab-maint/prey.git
Vcs-Browser: http://git.debian.org/?p=collab-maint/prey.git

Package: prey
Architecture: all
Depends: openssl,
 imagemagick | scrot,
 bash (>= 4),
 curl,
 streamer,
 libio-socket-ssl-perl,
 libnet-ssleay-perl,
 ${perl:Depends},
 ${misc:Depends}
Recommends: python (>= 2.5),
 python-gtk2
Description: utility for tracking stolen computers
 Prey is a lightweight program to help track and recover a stolen laptop.
 .
 It comprises a shell script which calls out on a regular basis to
 either a server run by the Prey project, or a URL defined by the system
 administrator. A graphical configuration tool is also provided in
 order to maintain the simple config file.

Reply to: