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

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



Christian PERRIER wrote:
> --- ejabberd.old/debian/templates	2015-06-24 09:13:56.949463781 +0200
> +++ ejabberd/debian/templates	2015-07-08 06:48:44.067323570 +0200
> @@ -1,41 +1,45 @@
>  Template: ejabberd/hostname
>  Type: string
>  Default: localhost
> +_Description: Host name for this Jabber server:
> + Please enter the host name of this Jabber server (lowercase).
> 
>  Template: ejabberd/user
>  Type: string
> +_Description: Jabber server administrator username:
>   Please provide the name of an account to administrate the ejabberd server.
>   After the installation of ejabberd you can use this account to log in with any
>   Jabber client to do administrative tasks or go to
>   http://${hostname}:5280/admin/ and log in with this account to enter the admin
> + interface.
>   .
> + You only need to enter the username part here (such as ${user}), but
> + need to use the full Jabber ID (such as ${user}@${hostname}) to
> + access the ejabberd web interface.

The explicit second person pronoun here makes sense, but the implicit
elided one ("but [you] need to use...") is a bit awkward and might be
worth avoiding - for a start in this case it needn't be you.

    You only need to enter the username part here (such as ${user}), but
    the full Jabber ID (such as ${user}@${hostname}) is required to
    access the ejabberd web interface.

> + .
> + Please leave this field empty if you don't want to create an
> + administrator account automatically.
> 
> First paragraph split in two paragraphs for readability. Drop the
> "otherwise it will fail" part, that seems useless to me (if you enter
> something wrong, the, yes things fail).

As usual there's a trace of ambiguity: is this *nominating* an
existing user in my standard user database, or *creating* an admin
account within a new, specialised user database?  The JID references
imply that the answer is the latter, but if I've guessed wrong then it
would be worth giving a clearer hint.
 
>  Template: ejabberd/password
>  Type: password
> +_Description: Jabber server administrator password:
>   Please enter the password for the administrative user.
> 
>  Template: ejabberd/verify
>  Type: password
> +_Description: Re-enter password to verify:
> + Please enter the same administrator password again to verify that you have typed it
> + correctly.
> 
>  Template: ejabberd/nomatch
>  Type: error
> +_Description: Password input error
> + The two passwords you entered were not the same. Please try again.
> 
>  Template: ejabberd/invaliduser
>  Type: error
> +_Description: Invalid administrator account username
>   The username you have typed contains forbidden characters. Please respect the 
>   JID syntax (http://tools.ietf.org/html/rfc6122#appendix-A.5). If you used
> + a full JID (e.g. user@hostname), you have to use the same host name
> + you typed into the host name configuration step.

(So Noël O'Neill isn't allowed to be a Jabber admin?)

In the control file:

> Package: ejabberd
> Description: distributed, fault-tolerant Jabber/XMPP server written in Erlang
                                                              ^^^^^^^^^^^^^^^^^
We really don't need "written in Erlang" here, even if it is a
WhyTheName hint.

>  ejabberd is a distributed, fault-tolerant Jabber/XMPP server written in Erlang.

Yes, you already said that.  The fact it's in Erlang is fairly obvious
from its dependencies, but okay, give it a namecheck here.  I notice
by the way that debtags now allows "implemented-in::erlang", so
ejabberd should probably update its "implemented-in::TODO".

>  Its features contain:

Not English.  I would suggest:

  Description: distributed, fault-tolerant Jabber/XMPP server
   ejabberd is a Jabber/XMPP server written in Erlang, featuring:

(after all, "distributed" and "fault-tolerant" are its two main
features, right?  Though oddly they're not listed first...)

>   - XMPP-compliant

The other features are expressed as noun phrases, so I'd suggest
standardising this to "XMPP compliance".

>   - Web based administration

Hyphenate - and if I'm going to be editing pretty much every line, use
the d-l-e house style for bulleted lists:

    * web-based administration;

>   - Load balancing: can run in a cluster of machines

This is effectively "distributed, and..."; but I'm not keen on the use
of an internal colon within a list that was introduced with one.
Maybe shift this to first place and make it

    * distributed operation with load-balancing across a cluster;

("of machines" doesn't add anything we hadn't already assumed.)

>   - Fault-tolerance: database can be replicated and stored on multiple
>     nodes (nodes can be added or replaced 'on the fly')

This is feature #2:

    * fault-tolerant database replication and storage on multiple nodes,
      which can be added or replaced "on the fly";

>   - Virtual hosting: several virtual domains can be served using single ejabberd
>     instance

This could stay where it is, but perhaps it fits better with the other
relatively longwinded features.

    * virtual hosting (several virtual domains can be served using a
      single ejabberd instance);

>   - SSL/TLS support

Fine.

>   - Multi-User Chat (MUC/conference)

Incoherent, but I think its trying to say:
   
    * conferencing via Multi-User Chat;

>   - IRC transport
>   - Jabber Users Directory, based on users vCards
                                            ^
Okay, the JUD is canonically so spelled and capitalised, but if the
vCards belong to users, you need an apostrophe there.

>   - Service Discovery

This on the other hand strikes me as Meaningless Capitalisation.

>   - Shared roster

This being the standard Jabberese for "friends list", I gather.

So the list is:

  * distributed operation with load-balancing across a cluster;
  * fault-tolerant database replication and storage on multiple nodes,
    allowing nodes to be added or replaced "on the fly";
  * virtual hosting (several virtual domains can be served using a single
    ejabberd instance);
  * XMPP compliance;
  * web-based administration;
  * SSL/TLS support;
  * conferencing via Multi-User Chat;
  * IRC transport;
  * Jabber Users Directory, based on users' vCards;
  * service discovery;
  * shared roster.

-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
diff -ru ejabberd-15.03.pristine/debian/control ejabberd-15.03/debian/control
--- ejabberd-15.03.pristine/debian/control	2015-06-22 18:12:24.000000000 +0100
+++ ejabberd-15.03/debian/control	2015-07-08 10:25:28.677712696 +0100
@@ -23,19 +23,18 @@
 Suggests: libunix-syslog-perl, imagemagick | graphicsmagick-imagemagick-compat
 Conflicts: ejabberd-mod-shared-roster-ldap
 Provides: xmpp-server
-Description: distributed, fault-tolerant Jabber/XMPP server written in Erlang
- ejabberd is a distributed, fault-tolerant Jabber/XMPP server written in Erlang.
- Its features contain:
-  - XMPP-compliant
-  - Web based administration
-  - Load balancing: can run in a cluster of machines
-  - Fault-tolerance: database can be replicated and stored on multiple
-    nodes (nodes can be added or replaced 'on the fly')
-  - Virtual hosting: several virtual domains can be served using single ejabberd
-    instance
-  - SSL/TLS support
-  - Multi-User Chat (MUC/conference)
-  - IRC transport
-  - Jabber Users Directory, based on users vCards
-  - Service Discovery
-  - Shared roster
+Description: distributed, fault-tolerant Jabber/XMPP server
+ ejabberd is a Jabber/XMPP server written in Erlang, featuring:
+  * distributed operation with load-balancing across a cluster;
+  * fault-tolerant database replication and storage on multiple nodes,
+    allowing nodes to be added or replaced "on the fly";
+  * virtual hosting (several virtual domains can be served using a single
+    ejabberd instance);
+  * XMPP compliance;
+  * web-based administration;
+  * SSL/TLS support;
+  * conferencing via Multi-User Chat;
+  * IRC transport;
+  * Jabber Users Directory, based on users' vCards;
+  * service discovery;
+  * shared roster.
diff -ru ejabberd-15.03.pristine/debian/templates ejabberd-15.03/debian/templates
--- ejabberd-15.03.pristine/debian/templates	2015-06-22 15:42:08.000000000 +0100
+++ ejabberd-15.03/debian/templates	2015-07-08 10:39:03.495499123 +0100
@@ -1,41 +1,45 @@
 Template: ejabberd/hostname
 Type: string
 Default: localhost
-_Description: The name of the host ejabberd will serve:
- Please enter the hostname of your Jabber server (in lowercase).
+_Description: Host name for this Jabber server:
+ Please enter the host name of this Jabber server (lowercase).
 
 Template: ejabberd/user
 Type: string
-_Description: The username of an admin account for ejabberd:
+_Description: Jabber server administrator username:
  Please provide the name of an account to administrate the ejabberd server.
  After the installation of ejabberd you can use this account to log in with any
  Jabber client to do administrative tasks or go to
  http://${hostname}:5280/admin/ and log in with this account to enter the admin
- interface. Enter the username part here (e.g. ${user}), but use the full Jabber
- ID (e.g. ${user}@${hostname}) to log into ejabberd web interface; otherwise it
- will fail.
+ interface.
  .
- Leave empty if you don't want to create an admin account automatically.
+ You only need to enter the username part here (such as ${user}), but
+ the full Jabber ID (such as ${user}@${hostname}) is required to
+ access the ejabberd web interface.
+ .
+ Please leave this field empty if you don't want to create an
+ administrator account automatically.
 
 Template: ejabberd/password
 Type: password
-_Description: The password for the admin account:
+_Description: Jabber server administrator password:
  Please enter the password for the administrative user.
 
 Template: ejabberd/verify
 Type: password
-_Description: The password for the admin account again for verification:
- Please reenter the password for the administrative user for verification.
+_Description: Re-enter password to verify:
+ Please enter the same administrator password again to verify that you have typed it
+ correctly.
 
 Template: ejabberd/nomatch
 Type: error
-_Description: The passwords do not match!
- The passwords you have typed do not match. Please try again.
+_Description: Password input error
+ The two passwords you entered were not the same. Please try again.
 
 Template: ejabberd/invaliduser
 Type: error
-_Description: The username of the admin account is invalid!
+_Description: Invalid administrator account username
  The username you have typed contains forbidden characters. Please respect the 
  JID syntax (http://tools.ietf.org/html/rfc6122#appendix-A.5). If you used
- a full JID (e.g. user@hostname), you have to use the same hostname
- you typed into the hostname configuration step.
+ a full JID (e.g. user@hostname), you have to use the same host name
+ you typed into the host name configuration step.
Template: ejabberd/hostname
Type: string
Default: localhost
_Description: Host name for this Jabber server:
 Please enter the host name of this Jabber server (lowercase).

Template: ejabberd/user
Type: string
_Description: Jabber server administrator username:
 Please provide the name of an account to administrate the ejabberd server.
 After the installation of ejabberd you can use this account to log in with any
 Jabber client to do administrative tasks or go to
 http://${hostname}:5280/admin/ and log in with this account to enter the admin
 interface.
 .
 You only need to enter the username part here (such as ${user}), but
 the full Jabber ID (such as ${user}@${hostname}) is required to
 access the ejabberd web interface.
 .
 Please leave this field empty if you don't want to create an
 administrator account automatically.

Template: ejabberd/password
Type: password
_Description: Jabber server administrator password:
 Please enter the password for the administrative user.

Template: ejabberd/verify
Type: password
_Description: Re-enter password to verify:
 Please enter the same administrator password again to verify that you have typed it
 correctly.

Template: ejabberd/nomatch
Type: error
_Description: Password input error
 The two passwords you entered were not the same. Please try again.

Template: ejabberd/invaliduser
Type: error
_Description: Invalid administrator account username
 The username you have typed contains forbidden characters. Please respect the 
 JID syntax (http://tools.ietf.org/html/rfc6122#appendix-A.5). If you used
 a full JID (e.g. user@hostname), you have to use the same host name
 you typed into the host name configuration step.
Source: ejabberd
Section: net
Priority: optional
Maintainer: Konstantin Khomoutov <flatworm@users.sourceforge.net>
Uploaders: Gerfried Fuchs <rhonda@debian.org>, Philipp Huebner <debalance@debian.org>
Build-Depends: debhelper (>= 9),
               erlang-asn1, erlang-base, erlang-crypto, erlang-dev (>= 1:15.b), erlang-eunit, erlang-inets, erlang-lager, erlang-jiffy, erlang-mnesia, erlang-parsetools,
               erlang-p1-cache-tab, erlang-p1-iconv, erlang-p1-mysql, erlang-p1-pam, erlang-p1-pgsql, erlang-p1-sip, erlang-p1-stringprep, erlang-p1-stun,
               erlang-p1-tls, erlang-p1-utils, erlang-p1-xml, erlang-p1-yaml, erlang-p1-zlib,
               erlang-redis-client, erlang-ssl, erlang-xmlrpc,
               hevea, po-debconf, rebar, texlive-latex-base, texlive-latex-recommended, texlive-latex-extra
Standards-Version: 3.9.6
Homepage: https://www.ejabberd.im
Vcs-Git: git://git.deb.at/pkg/ejabberd.git
Vcs-Browser: http://git.deb.at/w/pkg/ejabberd.git

Package: ejabberd
Architecture: any
Depends: adduser, erlang-base (>= 1:15.b) | ${erlang-abi:Depends}, ${erlang:Depends}, openssl, ucf, ${misc:Depends}, ${shlibs:Depends},
               erlang-lager, erlang-jiffy, erlang-p1-cache-tab, erlang-p1-iconv, erlang-p1-mysql, erlang-p1-pam, erlang-p1-pgsql, erlang-p1-sip, erlang-p1-stringprep,
               erlang-p1-stun, erlang-p1-tls, erlang-p1-utils, erlang-p1-xml, erlang-p1-yaml, erlang-p1-zlib, erlang-redis-client, erlang-xmlrpc
Recommends: ejabberd-contrib
Suggests: libunix-syslog-perl, imagemagick | graphicsmagick-imagemagick-compat
Conflicts: ejabberd-mod-shared-roster-ldap
Provides: xmpp-server
Description: distributed, fault-tolerant Jabber/XMPP server
 ejabberd is a Jabber/XMPP server written in Erlang, featuring:
  * distributed operation with load-balancing across a cluster;
  * fault-tolerant database replication and storage on multiple nodes,
    allowing nodes to be added or replaced "on the fly";
  * virtual hosting (several virtual domains can be served using a single
    ejabberd instance);
  * XMPP compliance;
  * web-based administration;
  * SSL/TLS support;
  * conferencing via Multi-User Chat;
  * IRC transport;
  * Jabber Users Directory, based on users' vCards;
  * service discovery;
  * shared roster.

Reply to: