Re: [RFR] templates://jspwiki/{jspwiki.templates}
Christian Perrier wrote:
> + 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.
It's "same foo as bar", not "same foo than bar", but isn't the
application name "JSPWiki"? And is a "web site name" the FQDN or
what? Judging from the example, they mean the wiki's URL.
Please enter the name of the wiki. This name appears in HTML titles
and log files, and is usually the same as the top level URL (for
instance 'http://www.example.org/JSPWiki').
> Template: jspwiki/pageprovider
[...]
> +_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.
[...]
> "page provider" seems to be jargon to me. We should find a better and
> simpler name for this.
Agreed - the whole concept of a "Provider class" is originally .NET
jargon, and OOP design patterns are hardly the kind of thing random
users can be expected to be familiar with.
_Description: Page storage mechanism to be used by JSPWiki:
Please choose the mechanism that should be used for storing pages:
.
FileSystemProvider: simply storing pages as files;
RCSFileProvider: using an external Revision Control System;
VersioningFileProvider: versioning storage implemented in Java.
But if RCSFileProvider invokes /usr/bin/rcs, shouldn't jspwiki have
a "Suggests: rcs" (with an explanatory note in the description)?
> Template: jspwiki/encoding
[...]
> -_Description: Page encoding
[...]
> +_Description: Pages encoding:
[...]
>
> I think there is more than one page....
Nonetheless, "Page encoding" is correct; when a noun is used as a
modifier like this it normally has to be the base form (hence "tooth
brush" not "teeth brush").
Wait a minute...
> + Please choose which character encoding should be used by
> + JSPWiki. UTF-8 may cause problems on some Tomcat 4 installations but
> + is otherwise recommended.
Tomcat 4 was last seen as a Sarge contrib package, and JSPWiki has a
hard dependency on Tomcat 5.5! This template is pointless, or
should at least say:
Please choose which character encoding should be used by
JSPWiki. UTF-8 is strongly recommended.
> Template: jspwiki/rss/generate
[...]
> 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
Simplifying further by throwing out the "allows":
JSPWiki can generate a Rich Site Summary feed so that users can
track changes to the wiki.
> Template: jspwiki/rss/refresh
[...]
> + Please choose the delay between RSS feed refreshs.
Three syllables, "refreshes".
> Template: jspwiki/rss/channeldescription
[...]
> + 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".
All the Google hits for the phrase "RSS channel description" are for
things like "rss/channel/description", so we probably can't assume
that normal users are familiar with the idea:
Please give a channel description for the RSS feed, to be shown in
channel catalogs. There is no maximum length, so include whatever
details users may find helpful.
> Template: jspwiki/rss/channellanguage
[...]
> + Please choose the RSS feed language. This should match the language of the
> + Wiki.
For consistency, uncapitalised "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.
_Description: Attachment storage mechanism to use:
'BasicAttachmentProvider' uses the same directory structure as the
selected page storage mechanism. It simply stores the attachments in a
dedicated directory for a page.
However, I'm translating this "blind"; I don't understand what it's
trying to say will happen if the page storage mechanism I selected was
(say) RCSFileProvider, or what happens if I pick "nothing" here, or
indeed why I should care.
The package description:
> +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.
Problems:
* JSPWiki isn't a direct clone of WikiWiki(Web).
* The dependencies say it's tomcat5.5 or nothing.
* "Java Server PageS files" is another teeth brush.
* It insists on talking internals instead of functionality. Why
would anyone care about the class name of the WikiEngine?
And what way of interacting with it would anyone expect
there to be that *didn't* go through that?
So really it might as well be:
Description: wiki written in Java
JSPWiki is a simple wiki engine which runs in a Java servlet container
and keeps all of its formatting in flat JSP (Java Server Page) files.
--
JBR
Ankh kak! (Ancient Egyptian blessing)
--- ../jspwiki.old/debian/jspwiki.templates 2007-10-23 08:34:37.000000000 +0100
+++ debian/jspwiki.templates 2007-10-27 15:06:57.000000000 +0100
@@ -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 name of the wiki. This name appears in HTML titles
+ and log files, and is usually the same as the top level URL (for
+ instance 'http://www.example.org/JSPWiki').
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 storage mechanism to be used by JSPWiki:
+ Please choose the mechanism that should be used for storing pages:
+ .
+ FileSystemProvider: simply storing pages as files;
+ RCSFileProvider: using an external Revision Control System;
+ VersioningFileProvider: versioning storage implemented in Java.
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: Page encoding:
+ Please choose which character encoding should be used by JSPWiki.
+ UTF-8 is strongly 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.
+ JSPWiki can generate a Rich Site Summary feed so that users can
+ track changes to the wiki.
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 refreshes.
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 give a channel description for the RSS feed, to be shown in
+ channel catalogs. There is no maximum length, so include whatever
+ details users may find helpful.
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
- selected page provider. It simply stores the attachments in a dedicated
- directory for a page.
+_Description: Attachment storage mechanism to use:
+ 'BasicAttachmentProvider' uses the same directory structure as the
+ selected page storage mechanism. 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-23 08:34:37.000000000 +0100
+++ debian/control 2007-10-27 14:57:36.000000000 +0100
@@ -6,16 +6,13 @@
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
- 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)
- files, and uses a custom Java class called 'com.ecyrd.jspwiki.WikiEngine'
- to all interfacing with the Wiki system.
- .
- Homepage: http://www.jspwiki.org
+Description: wiki written in Java
+ JSPWiki is a simple wiki engine which runs in a Java servlet container
+ and keeps all of its formatting in flat JSP (Java Server Page) files.
Template: jspwiki/applicationname
Type: string
Default: JSPWiki
_Description: Default application name:
Please enter the name of the wiki. This name appears in HTML titles
and log files, and is usually the same as the top level URL (for
instance 'http://www.example.org/JSPWiki').
Template: jspwiki/pageprovider
Type: select
Choices: FileSystemProvider, RCSFileProvider, VersioningFileProvider
Default: FileSystemProvider
_Description: Page storage mechanism to be used by JSPWiki:
Please choose the mechanism that should be used for storing pages:
.
FileSystemProvider: simply storing pages as files;
RCSFileProvider: using an external Revision Control System;
VersioningFileProvider: versioning storage implemented in Java.
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: Page encoding:
Please choose which character encoding should be used by JSPWiki.
UTF-8 is strongly 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 so that users can
track changes to the wiki.
Template: jspwiki/rss/refresh
Type: string
Default: 3600
_Description: RSS refresh time in seconds:
Please choose the delay between RSS feed refreshes.
Template: jspwiki/rss/channeldescription
Type: string
_Description: RSS channel description:
Please give a channel description for the RSS feed, to be shown in
channel catalogs. There is no maximum length, so include whatever
details users may find helpful.
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 storage mechanism to use:
'BasicAttachmentProvider' uses the same directory structure as the
selected page storage mechanism. 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..
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 written in Java
JSPWiki is a simple wiki engine which runs in a Java servlet container
and keeps all of its formatting in flat JSP (Java Server Page) files.
Reply to: