<html>
<head>
<meta content="text/html; charset=windows-1252"
http-equiv="Content-Type">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<div class="moz-cite-prefix">On 08/15/2015 10:32 PM, DM Smith wrote:<br>
</div>
<blockquote
cite="mid:2822019A-4DEE-4621-BC3C-D3AA84B0D31F@crosswire.org"
type="cite">
<meta http-equiv="Content-Type" content="text/html;
charset=windows-1252">
As a matter of style, Description should be the “title” of the
work, not an actual description. That is, it should be short.</blockquote>
<font face="FreeSerif">As a reference, modules' Description in
Crosswire </font><font face="FreeSerif"><font face="FreeSerif">main</font>
repo:<br>
250 modules length > 32 (roughly half of those are Freedict
Abcdef to Uvwxyz Glossary)<br>
48 length > 48<br>
12 length > 64<br>
<br>
By comparison, eBible has:<br>
270 length > 64<br>
121 length > 80<br>
54 length > 96<br>
30 length > 112<br>
20 length > 128</font><br>
<blockquote
cite="mid:2822019A-4DEE-4621-BC3C-D3AA84B0D31F@crosswire.org"
type="cite">
<div class="">The [name] of the module should be the appropriate
english abbreviation for the module. It has to be ASCII letters
and digits. We’ve recently added Abbreviation as a means of
providing internationalization of the name. I don’t know how
many applications show the Abbreviation instead of the module
name.</div>
</blockquote>
<font face="FreeSerif">I'm of two minds about this. Certainly it is
straightforward to give a direct and proper name.<br>
<br>
However, the longer we go with more modules produced, the more
likely it is that name collisions will occur, especially unnoticed
ones in separate repos, when selecting names from a limited 3- or
4-letter combinatoric. eBible has its own BBE, ASV, KJV, and WEB;
how shall these be named, if not to distinguish them from
previously-created modules in other repos, including Crosswire
main? This is exactly a use of Abbreviation (e.g. eng_kjv2006
=> KJV) that provides the necessary distinction. In Xiphos,
module manager provides both names (in the form "Abbrev
(RealName)") but elsewhere displays just abbreviation</font><font
face="FreeSerif"><font face="FreeSerif">, especially always-visible
tabs.</font> How do others implement this?<br>
<br>
Making the module name be rather precise gives a fair bit of
value, as long as Abbreviation support is present and works well.
Since adding Abbreviation support to Xiphos, I've noticed that IBT
modules use Abbreviation particularly well, though they are
especially for i18n purposes (see attached mod.mgr screenshot),
not for simplified naming of a complex-named module. So I see
some reason why "engwmb2015" with abbreviation "WMBB" can be seen
as appropriate.<br>
<br>
But the big question is indeed whether enough applications support
Abbreviation. Xiphos has it since 4.0.1, (newest) BibleDesktop
has it, xulsword has for a long time. Do any others? If not, I
would say that we have a problem.</font><br>
<blockquote
cite="mid:2822019A-4DEE-4621-BC3C-D3AA84B0D31F@crosswire.org"
type="cite">
<div class="">Many applications in laying out their UI assume that
the name is very short.</div>
</blockquote>
<font face="FreeSerif">That is very true. For example, Xiphos
expects module names or abbreviations to fit usefully into the
tabs of its interface.<br>
<br>
DM, you should update the Choosing a Sword Program wiki page when
your new BD is released, to include mentions of things like
Abbreviation support.</font><br>
</body>
</html>