Please find, for review, the debconf templates and packages descriptions for the jspwiki source package.
This review will last from Saturday, October 27, 2007 to Tuesday, November 06, 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:
--- ../jspwiki.old/debian/jspwiki.templates 2007-10-22 08:03:01.095575139 +0200
+++ debian/jspwiki.templates 2007-10-24 18:41:24.826766410 +0200
@@ -2,19 +2,20 @@
Type: string
Default: JSPWiki
_Description: Default application name:
- Which application name is used. It affects the HTML titles and logging.
- This is usually the same as the web name (http://www.example.com/JSPWiki)
- but can be different.
+ Please enter the application name. This name appears in HTML titles
+ and log files. Using the same name than the web site name is common but not
+ mandatory.
Make sentences...and, for doing so, use the standard way we adopted.
I'm not entirely happy with my rewrite, though.
Template: jspwiki/pageprovider
Type: select
Choices: FileSystemProvider, RCSFileProvider, VersioningFileProvider
Default: FileSystemProvider
-_Description: Which page provider JSPWiki should use
- Which page provider class to use. FileSystemProvider is a simple file
- based page storage, RCSFileProvider uses RCS as the page store, and
- VersioningFileProvider is a pure Java implementation of a versioning page
- store.
+_Description: Page provider to be used by JSPWiki:
+ Please choose the page provider class to use:
+ .
+ FileSystemProvider: simple file-based page storage;
+ RCSFileProvider: revision control system-based storage;
+ VersioningFileProvider: Java implementation of a versioning storage.
Again, make sentences...
Synopsis: do not use a pseudo-question.
Use an enumeration style.
"page provider" seems to be jargon to me. We should find a better and
simpler name for this.
Template: jspwiki/usepagecache
Type: boolean
@@ -25,80 +26,82 @@
Template: jspwiki/baseurl
Type: string
Default:
-_Description: JSPWiki base URL (http://www.example.com/JSPWiki/):
- Base URLs are used to rewrite all of JSPWiki's internal references. Don't
- forget the trailing slash. This must be used if the URL that JSPWiki
- sees through the servlet container is different from the real URL.
+_Description: JSPWiki base URL:
+ Base URLs are used to rewrite all of JSPWiki's internal references.
+ .
+ A trailing slash ('/') character is mandatory when then URL seen
+ by JSPWiki through the servlet container is different from the real URL.
Do not mention an example in the synopsis. Could maybe go in the long
description.
Template: jspwiki/encoding
Type: select
Choices: ISO-8859-1, UTF-8
Default: UTF-8
-_Description: Page encoding
- Determines which character encoding JSPWiki should use. UTF-8 may cause
- problems on some Tomcat 4 installations but is otherwise a good choice.
+_Description: Pages encoding:
+ Please choose which character encoding should be used by
+ JSPWiki. UTF-8 may cause problems on some Tomcat 4 installations but
+ is otherwise recommended.
I think there is more than one page....
Template: jspwiki/breaktitlewithspaces
Type: boolean
Default: false
_Description: Break at capitals in page names?
- Should page titles be rendered using an extra space after each capital
- letter. This causes 'RSSPage' to be shown as 'R S S Page'.
+ Please choose whether page titles should be rendered using an extra
+ space after each capital letter. This causes 'RSSPage' to be shown as
+ 'R S S Page'.
No double question
Template: jspwiki/matchenglishplurals
Type: boolean
Default: false
_Description: Match plural form to singular form in page names?
- Match "PageLinks" to "PageLink" if "PageLinks" is not found.
+ Choosing this option will cause JSPWiki to match 'PageLinks' to
+ 'PageLink' if 'PageLinks' is not found.
Rephrase, for the same reasons than above
Template: jspwiki/camelcaselinks
Type: boolean
Default: false
_Description: Use CamelCase links?
- Should JSPWiki consider traditional WikiNames (names of pages
- JustSmashedTogether without square brackets) as hyperlinks.
+ Please choose whether JSPWiki should consider traditional WikiNames
+ (names of pages JustSmashedTogether without square brackets) as
+ hyperlinks.
Ditto
Template: jspwiki/rss/generate
Type: boolean
Default: false
_Description: Generate RSS feed?
JSPWiki can generate a Rich Site Summary feed. This allows users to
- automatically find out if anything has changed on the site recently.
+ track changes on the site pages.
Simplify the sentence
Template: jspwiki/rss/refresh
Type: string
Default: 3600
_Description: RSS refresh time in seconds:
- How often the RSS feed should be refreshed. An hour (3600 seconds) is
- a good starting choice.
+ Please choose the delay between RSS feed refreshs.
Again, simplify.
Template: jspwiki/rss/channeldescription
Type: string
_Description: RSS channel description:
- This describes your RSS channel. Be as verbose as you want, there is
- no upper limit, and it helps the users.
+ Please choose the RSS channel description. It is recommended to give
+ as much details as possible (this setting has no size limit).
Same rewrite than above. Also avoid using "spoken language".
Template: jspwiki/rss/channellanguage
Type: string
Default: en-us
_Description: RSS channel language:
- This should match the language of your Wiki. It lets people know
- what language they should expect in the RSS feed.
+ Please choose the RSS feed language. This should match the language of the
+ Wiki.
Also avoids "spoken language".
Template: jspwiki/attachments/provider
Type: select
_Choices: BasicAttachmentProvider, nothing
Default: BasicAttachmentProvider
-_Description: Attachment provider to use
- BasicAttachmentProvider uses the same directory structure as the
+_Description: Attachment provider to use:
+ 'BasicAttachmentProvider' uses the same directory structure as the
selected page provider. It simply stores the attachments in a dedicated
directory for a page.
Use a colon. Quote the Choice name.
Template: jspwiki/purgewikifiles
Type: boolean
Default: false
-_Description: Should ALL wiki pages be deleted?
- If you don't have important information stored in your wiki and really
- want to get rid of the page data, the purge process can do this for
- you.
-
+_Description: Should all wiki pages be deleted on package purge?
+ Please choose whether you want all wiki pages to be removed when the
+ package is purged..
Again, avoid spoken language.
--- ../jspwiki.old/debian/control 2007-10-22 08:03:01.095575139 +0200
+++ debian/control 2007-10-24 18:42:34.323323511 +0200
@@ -6,16 +6,15 @@
Build-Depends-Indep: java-gcj-compat-dev, ant, libservlet2.3-java, wget, unzip
Build-Depends: dpatch, debhelper (>> 4.1.16)
Standards-Version: 3.7.2
+Homepage: http://www.jspwiki.org
Package: jspwiki
Architecture: all
Section: web
Priority: optional
Depends: tomcat5.5, debconf | debconf-2.0
-Description: WikiWikiWeb clone written in Java
+Description: wiki software written in Java
I think that using more generic is better. In the future years, maybe
noone will even remember what "WikiWikiWeb" is...
JSPWiki is a simple WikiWiki clone to be run in a Java servlet container
- (eg. Tomcat). It keeps all of its formatting in Java Server Pages (JSP)
+ such as Tomcat. It keeps all of its formatting in Java Server Pages (JSP)
One of our pet changes..:)
files, and uses a custom Java class called 'com.ecyrd.jspwiki.WikiEngine'
to all interfacing with the Wiki system.
- .
- Homepage: http://www.jspwiki.org
Moved to "Homepage:" field
--
Template: jspwiki/applicationname
Type: string
Default: JSPWiki
_Description: Default application name:
Please enter the application name. This name appears in HTML titles
and log files. Using the same name than the web site name is common but not
mandatory.
Template: jspwiki/pageprovider
Type: select
Choices: FileSystemProvider, RCSFileProvider, VersioningFileProvider
Default: FileSystemProvider
_Description: Page provider to be used by JSPWiki:
Please choose the page provider class to use:
.
FileSystemProvider: simple file-based page storage;
RCSFileProvider: revision control system-based storage;
VersioningFileProvider: Java implementation of a versioning storage.
Template: jspwiki/usepagecache
Type: boolean
Default: false
_Description: Should JSPWiki use a page cache?
Page caching usually improves performance but increases memory usage.
Template: jspwiki/baseurl
Type: string
Default:
_Description: JSPWiki base URL:
Base URLs are used to rewrite all of JSPWiki's internal references.
.
A trailing slash ('/') character is mandatory when then URL seen
by JSPWiki through the servlet container is different from the real URL.
Template: jspwiki/encoding
Type: select
Choices: ISO-8859-1, UTF-8
Default: UTF-8
_Description: Pages encoding:
Please choose which character encoding should be used by
JSPWiki. UTF-8 may cause problems on some Tomcat 4 installations but
is otherwise recommended.
Template: jspwiki/breaktitlewithspaces
Type: boolean
Default: false
_Description: Break at capitals in page names?
Please choose whether page titles should be rendered using an extra
space after each capital letter. This causes 'RSSPage' to be shown as
'R S S Page'.
Template: jspwiki/matchenglishplurals
Type: boolean
Default: false
_Description: Match plural form to singular form in page names?
Choosing this option will cause JSPWiki to match 'PageLinks' to
'PageLink' if 'PageLinks' is not found.
Template: jspwiki/camelcaselinks
Type: boolean
Default: false
_Description: Use CamelCase links?
Please choose whether JSPWiki should consider traditional WikiNames
(names of pages JustSmashedTogether without square brackets) as
hyperlinks.
Template: jspwiki/rss/generate
Type: boolean
Default: false
_Description: Generate RSS feed?
JSPWiki can generate a Rich Site Summary feed. This allows users to
track changes on the site pages.
Template: jspwiki/rss/refresh
Type: string
Default: 3600
_Description: RSS refresh time in seconds:
Please choose the delay between RSS feed refreshs.
Template: jspwiki/rss/channeldescription
Type: string
_Description: RSS channel description:
Please choose the RSS channel description. It is recommended to give
as much details as possible (this setting has no size limit).
Template: jspwiki/rss/channellanguage
Type: string
Default: en-us
_Description: RSS channel language:
Please choose the RSS feed language. This should match the language of the
Wiki.
Template: jspwiki/attachments/provider
Type: select
_Choices: BasicAttachmentProvider, nothing
Default: BasicAttachmentProvider
_Description: Attachment provider to use:
'BasicAttachmentProvider' uses the same directory structure as the
selected page provider. It simply stores the attachments in a dedicated
directory for a page.
Template: jspwiki/purgewikifiles
Type: boolean
Default: false
_Description: Should all wiki pages be deleted on package purge?
Please choose whether you want all wiki pages to be removed when the
package is purged..
--- jspwiki.old/debian/jspwiki.templates 2007-10-22 08:03:01.095575139 +0200
+++ jspwiki/debian/jspwiki.templates 2007-10-27 08:27:36.818955521 +0200
@@ -2,19 +2,20 @@
Type: string
Default: JSPWiki
_Description: Default application name:
- Which application name is used. It affects the HTML titles and logging.
- This is usually the same as the web name (http://www.example.com/JSPWiki)
- but can be different.
+ Please enter the application name. This name appears in HTML titles
+ and log files. Using the same name than the web site name is common but not
+ mandatory.
Template: jspwiki/pageprovider
Type: select
Choices: FileSystemProvider, RCSFileProvider, VersioningFileProvider
Default: FileSystemProvider
-_Description: Which page provider JSPWiki should use
- Which page provider class to use. FileSystemProvider is a simple file
- based page storage, RCSFileProvider uses RCS as the page store, and
- VersioningFileProvider is a pure Java implementation of a versioning page
- store.
+_Description: Page provider to be used by JSPWiki:
+ Please choose the page provider class to use:
+ .
+ FileSystemProvider: simple file-based page storage;
+ RCSFileProvider: revision control system-based storage;
+ VersioningFileProvider: Java implementation of a versioning storage.
Template: jspwiki/usepagecache
Type: boolean
@@ -25,80 +26,82 @@
Template: jspwiki/baseurl
Type: string
Default:
-_Description: JSPWiki base URL (http://www.example.com/JSPWiki/):
- Base URLs are used to rewrite all of JSPWiki's internal references. Don't
- forget the trailing slash. This must be used if the URL that JSPWiki
- sees through the servlet container is different from the real URL.
+_Description: JSPWiki base URL:
+ Base URLs are used to rewrite all of JSPWiki's internal references.
+ .
+ A trailing slash ('/') character is mandatory when then URL seen
+ by JSPWiki through the servlet container is different from the real URL.
Template: jspwiki/encoding
Type: select
Choices: ISO-8859-1, UTF-8
Default: UTF-8
-_Description: Page encoding
- Determines which character encoding JSPWiki should use. UTF-8 may cause
- problems on some Tomcat 4 installations but is otherwise a good choice.
+_Description: Pages encoding:
+ Please choose which character encoding should be used by
+ JSPWiki. UTF-8 may cause problems on some Tomcat 4 installations but
+ is otherwise recommended.
Template: jspwiki/breaktitlewithspaces
Type: boolean
Default: false
_Description: Break at capitals in page names?
- Should page titles be rendered using an extra space after each capital
- letter. This causes 'RSSPage' to be shown as 'R S S Page'.
+ Please choose whether page titles should be rendered using an extra
+ space after each capital letter. This causes 'RSSPage' to be shown as
+ 'R S S Page'.
Template: jspwiki/matchenglishplurals
Type: boolean
Default: false
_Description: Match plural form to singular form in page names?
- Match "PageLinks" to "PageLink" if "PageLinks" is not found.
+ Choosing this option will cause JSPWiki to match 'PageLinks' to
+ 'PageLink' if 'PageLinks' is not found.
Template: jspwiki/camelcaselinks
Type: boolean
Default: false
_Description: Use CamelCase links?
- Should JSPWiki consider traditional WikiNames (names of pages
- JustSmashedTogether without square brackets) as hyperlinks.
+ Please choose whether JSPWiki should consider traditional WikiNames
+ (names of pages JustSmashedTogether without square brackets) as
+ hyperlinks.
Template: jspwiki/rss/generate
Type: boolean
Default: false
_Description: Generate RSS feed?
JSPWiki can generate a Rich Site Summary feed. This allows users to
- automatically find out if anything has changed on the site recently.
+ track changes on the site pages.
Template: jspwiki/rss/refresh
Type: string
Default: 3600
_Description: RSS refresh time in seconds:
- How often the RSS feed should be refreshed. An hour (3600 seconds) is
- a good starting choice.
+ Please choose the delay between RSS feed refreshs.
Template: jspwiki/rss/channeldescription
Type: string
_Description: RSS channel description:
- This describes your RSS channel. Be as verbose as you want, there is
- no upper limit, and it helps the users.
+ Please choose the RSS channel description. It is recommended to give
+ as much details as possible (this setting has no size limit).
Template: jspwiki/rss/channellanguage
Type: string
Default: en-us
_Description: RSS channel language:
- This should match the language of your Wiki. It lets people know
- what language they should expect in the RSS feed.
+ Please choose the RSS feed language. This should match the language of the
+ Wiki.
Template: jspwiki/attachments/provider
Type: select
_Choices: BasicAttachmentProvider, nothing
Default: BasicAttachmentProvider
-_Description: Attachment provider to use
- BasicAttachmentProvider uses the same directory structure as the
+_Description: Attachment provider to use:
+ 'BasicAttachmentProvider' uses the same directory structure as the
selected page provider. It simply stores the attachments in a dedicated
directory for a page.
Template: jspwiki/purgewikifiles
Type: boolean
Default: false
-_Description: Should ALL wiki pages be deleted?
- If you don't have important information stored in your wiki and really
- want to get rid of the page data, the purge process can do this for
- you.
-
+_Description: Should all wiki pages be deleted on package purge?
+ Please choose whether you want all wiki pages to be removed when the
+ package is purged..
--- jspwiki.old/debian/control 2007-10-22 08:03:01.095575139 +0200
+++ jspwiki/debian/control 2007-10-24 18:42:34.323323511 +0200
@@ -6,16 +6,15 @@
Build-Depends-Indep: java-gcj-compat-dev, ant, libservlet2.3-java, wget, unzip
Build-Depends: dpatch, debhelper (>> 4.1.16)
Standards-Version: 3.7.2
+Homepage: http://www.jspwiki.org
Package: jspwiki
Architecture: all
Section: web
Priority: optional
Depends: tomcat5.5, debconf | debconf-2.0
-Description: WikiWikiWeb clone written in Java
+Description: wiki software written in Java
JSPWiki is a simple WikiWiki clone to be run in a Java servlet container
- (eg. Tomcat). It keeps all of its formatting in Java Server Pages (JSP)
+ such as Tomcat. It keeps all of its formatting in Java Server Pages (JSP)
files, and uses a custom Java class called 'com.ecyrd.jspwiki.WikiEngine'
to all interfacing with the Wiki system.
- .
- Homepage: http://www.jspwiki.org
Source: jspwiki Section: web Priority: optional Maintainer: Kalle Kivimaa <killer@debian.org> Uploaders: Michael Koch <konqueror@gmx.de> Build-Depends-Indep: java-gcj-compat-dev, ant, libservlet2.3-java, wget, unzip Build-Depends: dpatch, debhelper (>> 4.1.16) Standards-Version: 3.7.2 Homepage: http://www.jspwiki.org Package: jspwiki Architecture: all Section: web Priority: optional Depends: tomcat5.5, debconf | debconf-2.0 Description: wiki software written in Java JSPWiki is a simple WikiWiki clone to be run in a Java servlet container such as Tomcat. It keeps all of its formatting in Java Server Pages (JSP) files, and uses a custom Java class called 'com.ecyrd.jspwiki.WikiEngine' to all interfacing with the Wiki system.
Attachment:
signature.asc
Description: Digital signature