<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=UTF-8" http-equiv="Content-Type">
<title></title>
</head>
<body bgcolor="#ffffff" text="#000000">
<font size="+1"><font face="Arial Unicode MS">I may be missing
something too :), but in my experience the "About" field is the more
verbose field which helps people choose modules they want to use (from
the wiki: "</font></font>A lengthier description and may include
copyright, source, etc. information, possibly duplicating information
in other elements.<font size="+1"><font face="Arial Unicode MS">"). The
"About" functions much more like back cover or flap copy that you read
to find out more. <br>
<br>
It does seem that the two terms are easily confused and overlapping in
meaning. Perhaps instead of "Description" it should be called "Title"
or "ModuleTitle" or something like that. After all, the wiki defines
the "Description" as "</font></font>a short (1 line) title of the
module." Why not have the "Title" field and then an "Author" field. I
mean, if you have more than just Bibles then authors become an
important piece of information. Just a thought.<br>
<br>
Daniel<br>
<br>
Daniel Blake wrote:
<blockquote cite="mid:48A2B784.9020003@tcdr.com" type="cite">
<pre wrap="">I may be missing something here, but the "Description" field was
included so an actual description of a module could be added.
Descriptions are very important for people to choose which modules they
want to use/look at. Many times the name of a module just isn't enough
to tell people what the module is about. Similar to the front and back
cover of books for review before purchasing them.
Wouldn't it be better to add a field for the localized name and use the
description field for it's intended purpose?
Daniel Blake
Daniel Owens wrote:
</pre>
<blockquote type="cite">
<pre wrap="">DM Smith wrote:
</pre>
<blockquote type="cite">
<pre wrap="">On Aug 12, 2008, at 8:22 PM, Jonathan Morgan wrote:
</pre>
<blockquote type="cite">
<pre wrap="">On Wed, Aug 13, 2008 at 2:48 AM, Eeli Kaikkonen
<a class="moz-txt-link-rfc2396E" href="mailto:eekaikko@mail.student.oulu.fi"><eekaikko@mail.student.oulu.fi></a> wrote:
</pre>
<blockquote type="cite">
<pre wrap="">On Mon, 11 Aug 2008, Chris Little wrote:
</pre>
<blockquote type="cite">
<pre wrap="">2) The module name is intended for use by developers, not
necessarily
for display to users. That's why the constraint is iscsym--to
facilitate use within code. If you want to suggest the addition of a
short abbreviation .conf tag, that's a different matter.
</pre>
</blockquote>
<pre wrap="">People seem to get used to those short abbreviations but still they
are
not very user friendly. Actually I would like to have two extra
tags: a
short abbreviation in the language of the module and a description in
the language of the module. In internationalized and localized
environments it's important to have both English and native language
information available. As a user and as a developer I want to see
information which I can understand even if I can't read the module.
Therefore English short description is important. But I would like to
have also a short Finnish abbreviation in Finnish modules. It's quite
stupid to for example copy a quote which have "FinPR" attached while
no-one uses that in Finnish - it's usually "KR 38" or something like
that.
</pre>
</blockquote>
<pre wrap="">A lot of what we do happens for the convenience of developers rather
than users. This should probably change, but it's not an easy thing
to change. I think you are right that localised book names and
abbreviations are appropriate.
</pre>
</blockquote>
<pre wrap="">I think two fields make sense. One as an alternate for [name] and one
for Description=
It might be better to use Description for a localized name. If you
can't read it, you probably cannot read the module:)
</pre>
</blockquote>
<pre wrap="">This is a very good (and important) discussion. I agree that the
Description field should be used for a localized name, and perhaps a
recommended character length should be added to the module creation
wiki to give module developers a better idea of how long that field
should be.
However, not all UTF8 Description fields are readable in all
front-ends, though off the top of my head this only really affects
BibleCS. It would be fantastic if all front-ends supported UTF8
Descriptions AND used the Description field for the selection of
modules by the user. BPBible is a hybrid of the abbreviation and the
Description. In any case, the display of a module for selection ought
to be in a form that the end-user can recognize immediately.
</pre>
<blockquote type="cite">
<blockquote type="cite">
<pre wrap="">
</pre>
<blockquote type="cite">
<pre wrap="">It has occurred to my mind that a frontend could offer a UI for
giving
the abbreviation. User could give whatever string he wanted and it
could
be used in module lists and in other places. It would of course be
stored separately, not in the module conf.
</pre>
</blockquote>
<pre wrap="">I don't necessarily mind that as an extra, but the problems with it
are:
1. Most users won't want to do it. As much as possible it should be a
thing that just works, which means a good, localised name and
abbreviation should come with the module.
2. It is unlikely to be supported by other applications, meaning you
have to do it on a per application basis or not bother.
</pre>
</blockquote>
<pre wrap="">IMHO, It would be good for the engine to give write capabilities to a
conf, with critical fields being write protected (at least with a
warning.)
Then it would be straight forward for all front-ends to provide the
ability.
In Him,
DM
</pre>
</blockquote>
</blockquote>
<pre wrap=""><!---->
_______________________________________________
sword-devel mailing list: <a class="moz-txt-link-abbreviated" href="mailto:sword-devel@crosswire.org">sword-devel@crosswire.org</a>
<a class="moz-txt-link-freetext" href="http://www.crosswire.org/mailman/listinfo/sword-devel">http://www.crosswire.org/mailman/listinfo/sword-devel</a>
Instructions to unsubscribe/change your settings at above page
</pre>
</blockquote>
<br>
<pre class="moz-signature" cols="72">--
PMBX license 1502
</pre>
</body>
</html>