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

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



Christian PERRIER wrote:
>  Template: hoteldruid/configure-apache
[...]
> + HotelDruid runs on any web server supporting PHP, but automatic
> + configuration can only be performed for Apache.
> 
> Better English? (Justin, do you confirm? I may very well have turned
> it into Frenglish)

They're both unremarkable as English sentences, but yours says what we
want it to.

[...]
> + Once configured, HotelDruid can be accessed locally at
> + http://localhost/hoteldruid.
> + .
> + Please choose whether you wish the automatic configuration to be
> + performed now.

Maybe I've read too many fantasy stories, but I always feel nervous
when something asks me to choose a wish - just make it:

    Please choose whether automatic configuration should be performed now.
 
>  Template: hoteldruid/restrict-localhost
[...]
> + The Apache web server can be configured to allow HotelDruid connections
> + only from this computer (localhost).

There's a possible problem with making it clear exactly what it is the
"only" applies to; for people who haven't fully understood how
HotelDruid works, it might even be saying "Apache will restrict
outgoing connections from this computer to use only the HotelDruid
port".  Maybe:
       
    The Apache web server can be configured to forbid HotelDruid
    connections from other computers.

> + Additionnal access control can be enabled by setting the 
> + HotelDruid administrator password from the "users management" 
> + page. User logins will then become mandatory.

Typo: additional.

(I would have expected "user management", but if the page title says
"users" I suppose we'd better keep it.)

>  Template: hoteldruid/purgedata
>  Type: boolean
>  Default: false
> +_Description: Purge HotelDuid data when purging the package?
> + HotelDruid data are stored in /var/lib/hoteldruid.

"Data" is normally treated as a non-count noun, so it "is" stored.  Or
to avoid annoying elderly English teachers we can say:

    HotelDruid stores its data in /var/lib/hoteldruid.

> + If you choose this option, these data files will be removed when
> + the package is purged.
> + .
> + You should deny this option if you have operational information which
> + you wish to keep after HotelDruid is removed.

I would also suggest s/deny/refuse/, since "deny" makes it sound
vaguely as if you're lying about which option you accepted...
 
> -Description: Web-based property management system for your hotel or B&B
> +Description: web-based property management system for hotels or B&B
> 
> Synopsis should never start uppercase.

Unless there's a reason, anyway - if it was "Internet", for instance.
 
> I hesitated about "B&B" but I think it's quite a widely well-known
> abbreviation.

Oh, but it needs to be plural "or B&Bs".

>   HotelDruid is designed to manage hotel rooms, bed and breakfast apartments
> + or any other kind of daily rental, from a web browser.

(There's also room for a Harvard comma.)
 
> Unpersonnalize.

The trouble is, now it sounds as if HotelDruid is managing things from
*its* web browser!  We could fix that by saying "HotelDruid is
designed to allow X, Y, and Z to be managed from a web browser", but
I'd prefer to avoid That Word and say

    HotelDruid is designed to make hotel rooms, bed and breakfast apartments,
    or any other kind of daily rental easy to manage from a web browser.

>   .
> - Reservations can be assigned to rooms automatically with user defined 
> - rules. You can create website pages to display and check availability. 
> - Includes point of sale and statistics reports. Multi-user with groups and 
> - privileges system. Supports printing, saving and emailing of documents and
> - invoices.
> + Main features:
> +  * automatic reservation assignment to rooms with user-defined 
> +    rules;
> +  * web site pages creation and maintenance, including room
> +    availability;
> +  * point of sale;
> +  * statistics reports

I originally read it as "includes POS reports and statistics reports".
If it's actually saying that HotelDruid functions as an Electronic
Point of Sale it should probably make a bigger deal of it... but the
short version at http://freecode.com/projects/php-residence doesn't
even mention it.

> +  * multi-user capabilities, including groups and privileges
> +    management;
> +  * printing, saving and emailing of documents and invoices.

Reshuffling a little and trying to move it in the general direction of
the other upstream versions:

    Main features:
     * automatic assignment of reservations to rooms by user-defined rules;
     * creation of public web pages displaying room availability, etc.;
     * generation of statistical reports;
     * management of groups and privileges for multi-user operation;
     * saving, printing, and emailing of documents and invoices.

(I've spent too long fiddling with this - I'm losing any sense of what
would be an improvement.  Alternative opinions welcome.)

> + It uses an SQLite database by default but can be configured for use
> + with MySQL or PostgreSQL.

Looks good.

ObWhyTheName: it's obvious as long as you're familiar with the concept
of a "druid" as an Open Source parallel to "wizard™".  They deserve
some sort of backronym involving User Interface Design...
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
Template: hoteldruid/configure-apache
Type: boolean
Default: true
_Description: Automatically configure the Apache web server for HotelDruid?
 HotelDruid runs on any web server supporting PHP, but automatic
 configuration can only be performed for Apache.
 .
 Once configured, HotelDruid can be accessed locally at
 http://localhost/hoteldruid.
 .
 Please choose whether automatic configuration should be performed now.

Template: hoteldruid/restrict-localhost
Type: boolean
Default: true
_Description: Restrict HotelDruid access to this computer?
 The Apache web server can be configured to forbid HotelDruid
 connections from other computers.
 .
 It is recommended to activate this setting if HotelDruid is
 going to be used from this computer.
 .
 Additional access control can be enabled by setting the
 HotelDruid administrator password from the "users management" 
 page. User logins will then become mandatory.

Template: hoteldruid/restart-webserver
Type: boolean
Default: true
_Description: Restart the web server after HotelDruid configuration?
 In order to activate the new configuration for HotelDruid,
 the web server has to be restarted.

Template: hoteldruid/purgedata
Type: boolean
Default: false
_Description: Purge HotelDuid data when purging the package?
 HotelDruid stores its data in /var/lib/hoteldruid.
 .
 If you choose this option, these data files will be removed when
 the package is purged.
 .
 You should refuse this option if you have operational information which
 you wish to keep after HotelDruid is removed.
Source: hoteldruid
Section: web
Priority: optional
Maintainer: Marco Maria Francesco De Santis <marco@digitaldruid.net>
Build-Depends: debhelper (>= 8.0.0), po-debconf
Standards-Version: 3.9.3
Homepage: http://www.hoteldruid.com/

Package: hoteldruid
Architecture: all
Depends: ${misc:Depends}, ucf, apache2 | httpd, libapache2-mod-php5 | php5-cgi | php5,
 php5-sqlite (>= 5.3.3)
Suggests: iceweasel | www-browser, php5-mysql | php5-pgsql
Description: web-based property management system for hotels or B&Bs
 HotelDruid is designed to make hotel rooms, bed and breakfast apartments,
 or any other kind of daily rental easy to manage from a web browser.
 .
 Main features:
  * automatic assignment of reservations to rooms by user-defined rules;
  * creation of public web pages displaying room availability, etc.;
  * generation of statistical reports;
  * management of groups and privileges for multi-user operation;
  * saving, printing, and emailing of documents and invoices.
 .
 It uses an SQLite database by default but can be configured for use
 with MySQL or PostgreSQL.
diff -ru old/control new/control
--- old/control	2012-07-29 15:28:36.215713293 +0100
+++ new/control	2012-07-31 20:30:59.727392394 +0100
@@ -11,15 +11,16 @@
 Depends: ${misc:Depends}, ucf, apache2 | httpd, libapache2-mod-php5 | php5-cgi | php5,
  php5-sqlite (>= 5.3.3)
 Suggests: iceweasel | www-browser, php5-mysql | php5-pgsql
-Description: Web-based property management system for your hotel or B&B
- HotelDruid is designed to manage hotel rooms, bed and breakfast apartments
- or any other kind of daily rental, from your browser.
+Description: web-based property management system for hotels or B&Bs
+ HotelDruid is designed to make hotel rooms, bed and breakfast apartments,
+ or any other kind of daily rental easy to manage from a web browser.
  .
- Reservations can be assigned to rooms automatically with user defined 
- rules. You can create website pages to display and check availability. 
- Includes point of sale and statistics reports. Multi-user with groups and 
- privileges system. Supports printing, saving and emailing of documents and
- invoices.
+ Main features:
+  * automatic assignment of reservations to rooms by user-defined rules;
+  * creation of public web pages displaying room availability, etc.;
+  * generation of statistical reports;
+  * management of groups and privileges for multi-user operation;
+  * saving, printing, and emailing of documents and invoices.
  .
- Written in PHP, by default uses SQLite as its database, with possibility 
- to migrate to MySQL or PostgreSQL.
+ It uses an SQLite database by default but can be configured for use
+ with MySQL or PostgreSQL.
diff -ru old/templates new/templates
--- old/templates	2012-07-29 15:28:35.355393427 +0100
+++ new/templates	2012-07-31 19:25:29.603725572 +0100
@@ -1,48 +1,44 @@
 Template: hoteldruid/configure-apache
 Type: boolean
 Default: true
-_Description: Configure automatically the Apache web server?
- HotelDruid runs on any web server supporting PHP, but only the
- Apache web server can be configured automatically.
- .
- With automatic configuration you should be able to access
- HotelDruid with any web browser at http://localhost/hoteldruid
- from this computer.
+_Description: Automatically configure the Apache web server for HotelDruid?
+ HotelDruid runs on any web server supporting PHP, but automatic
+ configuration can only be performed for Apache.
  .
- Please select if Apache should now be configured automatically 
- for HotelDruid.
+ Once configured, HotelDruid can be accessed locally at
+ http://localhost/hoteldruid.
+ .
+ Please choose whether automatic configuration should be performed now.
 
 Template: hoteldruid/restrict-localhost
 Type: boolean
 Default: true
-_Description: Deny access from other computers?
- Apache web server can be configured to allow connections only
- from this computer (localhost).
- .
- This is always a good idea if you are not going to use HotelDruid
- over the network. Otherwise, once HotelDruid is installed, to
- protect your data it is strongly recommended to enable the 
- HotelDruid administrator password from the "users management" 
- page, this will make a login required.
+_Description: Restrict HotelDruid access to this computer?
+ The Apache web server can be configured to forbid HotelDruid
+ connections from other computers.
+ .
+ It is recommended to activate this setting if HotelDruid is
+ going to be used from this computer.
  .
- Please select if access should be restricted only to connections
- originating from this computer.
+ Additional access control can be enabled by setting the
+ HotelDruid administrator password from the "users management" 
+ page. User logins will then become mandatory.
 
 Template: hoteldruid/restart-webserver
 Type: boolean
 Default: true
-_Description: Should the web server be restarted now?
- In order to activate the new configuration, the reconfigured web
- server has to be restarted.
+_Description: Restart the web server after HotelDruid configuration?
+ In order to activate the new configuration for HotelDruid,
+ the web server has to be restarted.
 
 Template: hoteldruid/purgedata
 Type: boolean
 Default: false
-_Description: Purge also application data now?
- By default, HotelDruid stores all its data in some files in
- /var/lib/hoteldruid.
- .
- Accepting this option will remove all this data and leave you with a
- tidier system once the HotelDruid package has been removed, but
- may cause information loss if you have operational data in those
- files.
+_Description: Purge HotelDuid data when purging the package?
+ HotelDruid stores its data in /var/lib/hoteldruid.
+ .
+ If you choose this option, these data files will be removed when
+ the package is purged.
+ .
+ You should refuse this option if you have operational information which
+ you wish to keep after HotelDruid is removed.

Reply to: