Bug 68357 - [spell checking][preferences] Dictionary is missing
Summary: [spell checking][preferences] Dictionary is missing
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Text (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows XP
: P2 normal (vote)
Target Milestone: 3.3 M7   Edit
Assignee: JDT-Text-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: polish
Depends on:
Blocks:
 
Reported: 2004-06-23 14:44 EDT by Pratik Shah CLA
Modified: 2007-05-02 10:29 EDT (History)
10 users (show)

See Also:


Attachments
Thunderbird spelling preferences screenshot (15.91 KB, image/gif)
2007-04-25 04:56 EDT, Mik Kersten CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Pratik Shah CLA 2004-06-23 14:44:24 EDT
When spell-check is enabled, every word is marked as having been misspelt.  I 
suppose that's because the dictionary is missing (or empty).
Comment 1 Pratik Shah CLA 2004-06-23 14:44:39 EDT
This was in RC3
Comment 2 Dani Megert CLA 2004-06-23 15:53:45 EDT
We do not provide a dictionary out of the box. For 3.0 we should add this to the
README.

Post 3.0: the preference page should not be OK if spell checking is enabled
without a dictionary.
Comment 3 Dani Megert CLA 2006-05-12 06:16:41 EDT
Added to the 3.2 README.
Comment 4 Mik Kersten CLA 2006-11-20 18:26:12 EST
Has the mechanism for doing this been decided yet?  Mozialla Firefox is now redistributing one (e.g. Program Files/Mozialla Firefox/en-US.dic) and I wonder what license that's under.  There's also: http://wiki.mozilla.org/index.php?title=L10n:Dictionaries&redirect=no
Comment 5 Dani Megert CLA 2006-11-21 02:31:42 EST
>I wonder what license that's under.
From comment 4 I assume it is installed on your machine, so why not take a look and report here what license it uses? ;-)
Comment 6 Mik Kersten CLA 2006-11-21 13:07:08 EST
I would like to use that one, but I'm not since I need to follow the instructions that we're giving to Mylar users ;)  Those currently have them installing this one: http://wordlist.sourceforge.net/

FAQ entry on setup is: http://wiki.eclipse.org/index.php/Mylar_FAQ#Spell_Checking

I just did a bit of investigation and it looks like Firefox is now redistributing that very dictionary, created by Kevin Atkinson, modified and licensed under LGPL: https://addons.mozilla.org/firefox/3497/

In the case of redistributing the dictionary, is the LGPL a showstopper?  If so, perhaps we could ask Kevin to create a web link that users could easily retrieve the dictionary from in order to install it into their Eclipse workspace?
Comment 7 Dani Megert CLA 2006-11-21 13:26:15 EST
>In the case of redistributing the dictionary, is the LGPL a showstopper? 
I'm not a lawyer ;-) With everything which is not EPL we have to go and ask one. It might be easier when giving instructions on how to setup the workspace instead of either fetching or repackaging it.
Comment 8 Dani Megert CLA 2006-11-21 13:29:35 EST
I plan to write up an e-mail for our lawyer to see what we can do. I agree that the current solution needs improvement.
Comment 9 Gunnar Wagenknecht CLA 2006-11-21 15:09:51 EST
(In reply to comment #6)
> In the case of redistributing the dictionary, is the LGPL a showstopper?

Janet Campbell gave a talk at the Eclipse Summit Europe about legal issues. One statement was that the LGPL is a show stopper for distributing from Eclipse.org servers. It would be much easier if it would be EPL or the Apache License. But GPL and LGPL are almost impossible to be distributed from Eclipse.org.

AFAIK the ECF guys have a similar problem. They have a plug-in that requires a LGPL library. They solved it by providing the plug-in from an update site not located on the Eclipse.org servers.

Comment 10 Mik Kersten CLA 2006-11-21 15:40:56 EST
We use the same update site dependency mechanism for a tigris.org jira WS wrapper.  But this doesn't work well for bundles/zipped installs, only for update manager based installs.

If redistributing the LGPL is a showstopper, I wonder if we can consider asking Kevin Atkinson to contribute his word list under the EPL, and have us use work from a fork of that?  Then we could also add patches with our own Eclipse-specific jargon (e.g. I'm tired of "Bugzilla" always being underlined in red).  But I don't know if forking an LGPL word list into an EPL list is a legal operation, so writing that letter to the lawyer seems worthwhile :)

Then there's also the out-of-the-box solution that WTP uses for retrieving non EPL XML schemas and such: put a button and field on the spelling page that says "download dictionary from: [url]", make the default URL be the SourceForge project as long as he agrees to maintain that URL now and forever, and have the user click through the license for the dictionary (also a URL).
Comment 11 Dani Megert CLA 2006-11-22 02:51:43 EST
Not all dictionaries are plain word lists i.e. some use a special format that we'd need to know in order to use the dictionary. In such cases letting the user accept the license would not be sufficient because we'd need to implement the specific code to interpret the dictionary.
Comment 12 Mik Kersten CLA 2006-11-22 10:36:31 EST
Right, but the accepted formats could be specified by Eclipse and documented, plain word list being the obvious one.  My meta-point is that just as Eclipse currently allows the user to select a dictionary via local path, it could allow similar access to an URL-based path, with the legal caveat that the user should click through a license if this dictionary is to be cached locally.
Comment 13 Dani Megert CLA 2007-03-17 08:23:56 EDT
This is in progress. Legal is currently investigating what we can do here given that we're under EPL.
Comment 14 Dani Megert CLA 2007-04-04 15:37:41 EDT
CQ has been sent to the EMO: http://dev.eclipse.org/ipzilla/show_bug.cgi?id=1415
Comment 15 Mik Kersten CLA 2007-04-04 19:45:15 EDT
Great to see this in motion.  For users adding their own words I guess we'll rely on them editing a custom full-dictionary file directly rather than their having an additional user-specific dictionary file?  The former is usable but in the long-run I think the latter would be preferred because it would allow storage of the custom dictionary with the workspace data while the main dictionary file comes from a plug-in.  Let me know if I should file a separate bug for that.
Comment 16 Dani Megert CLA 2007-04-10 04:44:40 EDT
The user can choose one of the installed dictionaries and have a list with his additions.
Comment 17 Dani Megert CLA 2007-04-23 12:16:01 EDT
Fixed in HEAD.
Available in builds > N20070423-0010.
Comment 18 Mik Kersten CLA 2007-04-23 16:00:48 EDT
Fantastic.  Since this will make spell checking readily available to way more people, we can expect Javadoc comments and bug reports to become easier to read :)

I assume that it isn't time yet to enable spell checking by default, since the list is English only.  I wonder if it would be a good idea to give the preference page a hyperlink along the lines of "Browse for other dictionaries online" and have that point to a wiki page where people can link them.
Comment 19 Dani Megert CLA 2007-04-23 16:19:23 EDT
Mik, actually I enabled spell checking. Ideally, the language packs would contain dictionaries too.

Did you get legal clearance for the things your refernce in Mylar? If so, we could maybe also use that in the SDK.
Comment 20 Mik Kersten CLA 2007-04-23 16:41:23 EDT
 (In reply to comment #19)
> Mik, actually I enabled spell checking. Ideally, the language packs would
> contain dictionaries too.

Great.  I definitely agree that having it enabled by default is better and if it is enabled and the language is wrong it is easy for the person to discover how to fix that.

> Did you get legal clearance for the things your refernce in Mylar? If so, we
> could maybe also use that in the SDK.

I'm not sure what you mean... Mylar has no spelling requirements beyond having spelling in the SDK.  We just have a big need for it to be readily available because users of Mylar spend considerable amount time writing natural language with Eclipse (e.g. bug reports).  The only additional spelling words I could think of having shipped with the Eclipse SDK are programming-specific and an Eclipse-specific words.  For example, it would be nice if every Eclipse project name and if words like Bugzilla and Eclipsepedia did not get underlined.  But I guess if we go down that road we should probably add them to an additional SDK-specific dictionary and not the Platform one.
Comment 21 Dani Megert CLA 2007-04-24 03:05:33 EDT
>I'm not sure what you mean... 
I thought you had a guide, wiki or help doc that referred to some dictionaries but I might be wrong here.
Comment 22 Dani Megert CLA 2007-04-24 05:49:43 EDT
Removed README entry.
Comment 23 Mik Kersten CLA 2007-04-25 03:35:52 EDT
 (In reply to comment #21)
> I thought you had a guide, wiki or help doc that referred to some dictionaries
> but I might be wrong here.

We have the following FAQ entry: http://wiki.eclipse.org/index.php/Mylar_User_Guide#Spell_checking

However, to include anything pointed to there we would likely need separate IP approval.  Also, I'm not sure how much benefit there would be over the dictionary that we have now.  If after using the new dictionary I find it lacking I'll post here.
Comment 24 Dani Megert CLA 2007-04-25 03:39:26 EDT
I was rather thinking of those that like to install a dictionary for a non-English language. For those we probably add a link to http://wordlist.sourceforge.net/ to the doc.
Comment 25 Mik Kersten CLA 2007-04-25 04:54:14 EDT
That's a good idea.  Since I'm somewhat disillusioned about users referring to the documentation, I still think it would be much more useful to put this link on the preference page itself (for stability it should point to an eclipse.org page with a link).  I realize that the SDK does not have external preference page links of this sort and it could be good to indicate that it won't work unless connected to the Internet (e.g. with a browser icon).  However, such links are now commonplace in OS's like Vista and they really are helpful.  I just checked Thunderbird 2.0 and it does exactly that (attaching screenshot).
Comment 26 Mik Kersten CLA 2007-04-25 04:56:27 EDT
Created attachment 64835 [details]
Thunderbird spelling preferences screenshot

Resolves to: https://addons.mozilla.org/en-US/thunderbird/browse/type:3
Comment 27 Karsten Becker CLA 2007-05-02 10:15:32 EDT
Verified in I20070502-0010
Comment 28 Martin Aeschlimann CLA 2007-05-02 10:29:50 EDT
.