[Debian-med-packaging] Bug#653825: [RFR] templates://biomaj-watcher/{templates}

Justin B Rye jbr at edlug.org.uk
Thu Jan 12 12:19:38 UTC 2012 

Christian PERRIER wrote:
[...]
>  Template: biomaj/ldap
>  Type: boolean
> -_Description: Want to configure LDAP now ?
> +_Description: Configure LDAP authentication?
> + Please choose whether you want to enter parameters for
> + the LDAP authentication for BioMAJ.

Or to make it less about "you":

    Please choose whether LDAP authentication for BioMAJ should be
    set up now.

[...]
>  Template: biomaj/ldap_filter
>  Type: string
> -_Description: Enter LDAP filter (empty if not needed):
> +_Description: LDAP filter (empty if not needed):
> 
> Indeed, I have no idea about what this stands for. Maintainer input
> needed, here.

Explanations will need to go in the long description, so the "empty
if not needed" can be demoted to there too:

   _Description: LDAP search filter:
    Please specify the LDAP search filter for biomaj-watcher. It can be
    left empty if no filter is required.

My addition of the word "search" here is inspired by
http://biomaj.genouest.org/wp-content/uploads/2011/01/BW_userguide.pdf
though that's about as much extra information as it gives.

> --- biomaj-watcher.old/debian/control	2011-12-31 10:13:08.842651005 +0100
> +++ biomaj-watcher/debian/control	2012-01-08 08:12:39.517959100 +0100
> @@ -18,13 +18,19 @@
>  Depends: ${misc:Depends}, openjdk-6-jdk|default-jdk|java6-sdk, tomcat6 (>=6.0.32-3), biomaj (>= 1.2), debconf,
>   liblog4j1.2-java, libjsch-java (>= 0.1.42),libjdom1-java (>= 1.1), libcommons-lang-java (>=2.4),
>   libcommons-logging-java (>=1.1),libquartz-java(>=1.6),libxerces2-java, unzip, zip, libgnumail-java
> -Description: BioMAJ web interface
> +Description: web interface for BioMAJ
> 
> preferred way to write things...;and avoids a leading capital letter

Or we could base it on the one for biomaj:

   Description: biological data-bank updater - web interface

[...]
>   BioMAJ watcher provide a management interface for the Biomaj tool.
                          s                                  MAJ
> + It runs in a web container (Tomcat) and is accessible at address:
                                                          under the URL
>   http://myhost:myport/BmajWatcher
Avoid advertising MyHost:
    http://hostname:portnumber/BmajWatcher

>   The web interface calls the biomaj binary, and can run bank updates,
> + removal and list. A cron manager is integrated to schedule bank updates.
> + It also provides a bank properties editor to define or modify banks.
> + The interface administrator has special privileges while anonymous users
>   can get an overview of available data.

"Removal" and "list" are also strange in the singular, and there are
no banks involved...  Reading the guide I got a bit carried away with
reorganising this paragraph:

    The web interface can give anonymous users an overview of available
    data. Administrators can also use it to manage data-banks, schedule
    updates via cron, view error logs, or use the integrated data-bank
    properties editor.

-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
-------------- next part --------------
diff -ru biomaj-watcher.old/control biomaj-watcher.new/control
--- biomaj-watcher.old/control	2012-01-04 17:06:40.599696185 +0000
+++ biomaj-watcher.new/control	2012-01-12 12:17:21.407695459 +0000
@@ -18,13 +18,18 @@
 Depends: ${misc:Depends}, openjdk-6-jdk|default-jdk|java6-sdk, tomcat6 (>=6.0.32-3), biomaj (>= 1.2), debconf,
  liblog4j1.2-java, libjsch-java (>= 0.1.42),libjdom1-java (>= 1.1), libcommons-lang-java (>=2.4),
  libcommons-logging-java (>=1.1),libquartz-java(>=1.6),libxerces2-java, unzip, zip, libgnumail-java
-Description: BioMAJ web interface
- BioMAJ watcher provide a management interface for the Biomaj tool.
- It runs in a web container (tomcat) and is accessible at address:
- http://myhost:myport/BmajWatcher
+Description: biological data-bank updater - web interface
+ BioMAJ downloads remote data banks, checks their status and applies
+ transformation workflows, with consistent state, to provide ready-to-use
+ data for biologists and bioinformaticians. For example, it can transform
+ original FASTA files into BLAST indexes. It is very flexible and its
+ post-processing facilities can be extended very easily.
  .
- The web interface calls the biomaj binary, and can run bank updates,
- removal and list. A cron manager is integrated to schedule bank update.
- At last, it integrates a bank properties editor to define or modify banks.
- The intterface administrator has special priviledges while anonymous user
- can get an overview of available data.
+ BioMAJ watcher provides a management interface for the BioMAJ tool.
+ It runs in a web container (Tomcat) and is accessible under the URL
+ http://hostname:portnumber/BmajWatcher
+ .
+ The web interface can give anonymous users an overview of available
+ data. Administrators can also use it to manage data-banks, schedule
+ updates via cron, view error logs, or use the integrated data-bank
+ properties editor.
diff -ru biomaj-watcher.old/templates biomaj-watcher.new/templates
--- biomaj-watcher.old/templates	2012-01-04 17:06:39.371362284 +0000
+++ biomaj-watcher.new/templates	2012-01-12 12:17:26.379695610 +0000
@@ -1,25 +1,36 @@
 Template: biomaj/login
 Type: string
 Default: admin
-_Description: Administration interface admin login:
+_Description: Login for administration interface of BioMAJ:
+ Please enter the login to use when connecting to the
+ web administration interface of BioMAJ.
 
 #Template: biomaj/password
 #Type: password
-#_Description: Administration interface admin password:
+#_Description: Password for administration interface of BioMAJ:
+# Please enter the password to use when connecting to the
+# web administration interface of BioMAJ.
 
 Template: biomaj/ldap
 Type: boolean
-_Description: Want to configure LDAP now ?
+_Description: Configure LDAP authentication?
+ Please choose whether LDAP authentication for BioMAJ should be
+ set up now.
 
 Template: biomaj/ldap_server
 Type: string
-_Description: Enter LDAP server:
+_Description: LDAP server:
+ Please enter the host name or IP address of the
+ LDAP server to use for authentication.
 
 Template: biomaj/ldap_dn
 Type: string
-_Description: Enter LDAP DN:
+_Description: LDAP DN:
+ Please enter the Distinguished Name to use for
+ LDAP authentication.
 
 Template: biomaj/ldap_filter
 Type: string
-_Description: Enter LDAP filter (empty if not needed):
-
+_Description: LDAP search filter:
+ Please specify the LDAP search filter for biomaj-watcher. It can be
+ left empty if no filter is required.
-------------- next part --------------
Template: biomaj/login
Type: string
Default: admin
_Description: Login for administration interface of BioMAJ:
 Please enter the login to use when connecting to the
 web administration interface of BioMAJ.

#Template: biomaj/password
#Type: password
#_Description: Password for administration interface of BioMAJ:
# Please enter the password to use when connecting to the
# web administration interface of BioMAJ.

Template: biomaj/ldap
Type: boolean
_Description: Configure LDAP authentication?
 Please choose whether LDAP authentication for BioMAJ should be
 set up now.

Template: biomaj/ldap_server
Type: string
_Description: LDAP server:
 Please enter the host name or IP address of the
 LDAP server to use for authentication.

Template: biomaj/ldap_dn
Type: string
_Description: LDAP DN:
 Please enter the Distinguished Name to use for
 LDAP authentication.

Template: biomaj/ldap_filter
Type: string
_Description: LDAP search filter:
 Please specify the LDAP search filter for biomaj-watcher. It can be
 left empty if no filter is required.
-------------- next part --------------
Source: biomaj-watcher
Section: contrib/science
Priority: optional
Maintainer: Debian Med Packaging Team <debian-med-packaging at lists.alioth.debian.org>
Uploaders: Olivier Sallou <olivier.sallou at irisa.fr>
DM-Upload-Allowed: yes
Vcs-Svn: svn://svn.debian.org/svn/debian-med/trunk/packages/biomaj-watcher/trunk/
Vcs-Browser: http://svn.debian.org/wsvn/debian-med/trunk/packages/biomaj-watcher/trunk/?rev=0&sc=0
Homepage: http://biomaj.genouest.org
Build-Depends: debhelper (>= 8),ant(>=1.7), zip, unzip
Build-Depends-Indep: openjdk-6-jdk|default-jdk|java6-sdk, debconf, po-debconf, liblog4j1.2-java, libcommons-lang-java,
 libcommons-logging-java, libjsch-java, libjdom1-java, libquartz-java(>=1.6),libgnumail-java,
 libxerces2-java, javahelper (>=0.25), biomaj (>= 1.2)
Standards-Version: 3.9.2

Package: biomaj-watcher
Architecture: all
Depends: ${misc:Depends}, openjdk-6-jdk|default-jdk|java6-sdk, tomcat6 (>=6.0.32-3), biomaj (>= 1.2), debconf,
 liblog4j1.2-java, libjsch-java (>= 0.1.42),libjdom1-java (>= 1.1), libcommons-lang-java (>=2.4),
 libcommons-logging-java (>=1.1),libquartz-java(>=1.6),libxerces2-java, unzip, zip, libgnumail-java
Description: biological data-bank updater - web interface
 BioMAJ downloads remote data banks, checks their status and applies
 transformation workflows, with consistent state, to provide ready-to-use
 data for biologists and bioinformaticians. For example, it can transform
 original FASTA files into BLAST indexes. It is very flexible and its
 post-processing facilities can be extended very easily.
 .
 BioMAJ watcher provides a management interface for the BioMAJ tool.
 It runs in a web container (Tomcat) and is accessible under the URL
 http://hostname:portnumber/BmajWatcher
 .
 The web interface can give anonymous users an overview of available
 data. Administrators can also use it to manage data-banks, schedule
 updates via cron, view error logs, or use the integrated data-bank
 properties editor.

More information about the Debian-med-packaging mailing list