Issue Details (XML | Word | Printable)

Key: CONF-1212
Type: New Feature New Feature
Status: Open Open
Priority: Major Major
Assignee: Unassigned
Reporter: Brandon Philips
Votes: 218
Watchers: 91
Operations

Add/Edit UI Mockup to this issue
If you were logged in you would be able to see more operations.
Confluence

Spell Checker

Created: 11/May/04 02:46 PM   Updated: Thursday 06:17 AM
Component/s: Editing, Usability
Affects Version/s: 1.1
Fix Version/s: None

Time Tracking:
Not Specified

File Attachments: 1. Microsoft Word JSpell Evolution and Confluence Integration.doc (149 kB)

Image Attachments:

1. ScreenHunter_2.jpg
(72 kB)
Issue Links:
Duplicate
 
Reference
 

Participants: Alaa Alwani, Audra Eng [Atlassian], Barry Gray, Bijan Marjan, Brandon Philips, Brendan Patterson [Atlassian], Brendan Patterson [Atlassian], Brian Duff, Cheryl Lesser, Corey Hampton, David Aldrich, David Soul [Atlassian], Douglas Ko, Ed Letifov, Egor Pervuninski, Eliot Hariton, Ernest Mueller, Helene McElroy, James Woest, Jens Schumacher [Atlassian], John Preval, Karen Huffman, Martin Skopp, Matt Ryall [Atlassian], Michael Spoonauer, Mitchell Starnes, Nicholas Kerzman, Octavian Petre, Patrick Payette , Per Fragemann [Atlassian], Peter Raymond, Phillippa Kassover, Rick Hadsall, Roger Symonds [CustomWare], Ronald Schwarz, Russell Warren, Ryan Ackley, Sally Weston, Scott Farquhar [Atlassian], Sean Kennedy, Sinan O. Karasulu, Stacy shenker, Steve Hadfield, Subhash Mathur, Sulka Haro, Yaniv Shaya and Yao Ge
Since last comment: 1 week, 3 days ago
PM Reviewed: 22/Jan/09
PM Value: 2.25
Labels:
Support reference count: 3


 Description  « Hide
A spell checker would be really nice.

 All   Comments   Work Log   Change History      Sort Order: Ascending order - Click to sort in descending order
Sulka Haro added a comment - 17/May/04 07:57 AM
Quick tip for all Mac OS X users out there: right click (or ctrl click) on the Confluence text editing box and choose Spelling -> Check spelling as you type. Tada - you now have spelling enabled in Confluence!

Jens Schumacher [Atlassian] added a comment - 06/Jun/05 03:20 AM
Another quick tip for all Firefox users:

Spellbound is a nice spell checker which nicely integrates with your browser and allows for spell checking in forms.

http://spellbound.sourceforge.net/

Cheers,
Jens


Sulka Haro added a comment - 20/Oct/05 03:01 AM
The Google Toolbar also supports spelling on the client side:

http://toolbar.google.com/

With this many client side options for spelling, I'd personally rather see Atlassian implement something else than this.


Egor Pervuninski added a comment - 18/Jan/06 12:45 AM
I'd also prefer Atlassian's implemention. Something like GMail's spell checker.

Yaniv Shaya added a comment - 08/Jul/06 11:20 AM
I actually tried both Spellbound and Google toolbar.

Both weren't able to spell check on Confluence, either the rich text editor or the markup editor.

They do seem to work with other web forms.

Did you actually try it before commenting about those as potential solutions?


Patrick Payette added a comment - 21/Jul/06 10:18 AM
Google toolbar does work really nice for me: running on IE7 and Confluence 2.2.6.
(But yes, a built in feature would make things easier for some users)

Brian Duff added a comment - 10/Sep/06 06:52 PM
Worth noting: the Firefox 2.0 beta supports spell checking, and it appeared to work for me in both the rich and wiki edit boxes in confluence. It seemed a bit unstable when I tried it (crashed most of the time), but certainly looks promising...

Brendan Patterson [Atlassian] added a comment - 26/Oct/06 10:21 PM
Firefox 2.0 is now officially released and from my early testing the spell checking seems pretty rock solid both in Confluence's Wiki Markup Tab and Confluence' Rich Text Editor Tab.

Brendan Patterson [Atlassian] added a comment - 26/Oct/06 10:34 PM
JSpell is a good product I've used in the past. Knowing that spell checking is a highly voted for feature I decided to ping TheSolutionCafe.com and see if they thought JSpell would work with Confluence's rich text editor.

Cliff went one better and within an hour both integrated it with Confluence and wrote up the attached integration guide.

JSPell is a product (not free), but if you want to give your users spell checking this might be one good option until Atlassian implements it. JSpell and related products can enable spell checking on all your web apps.

I asked Cliff for some guidance around which licensed made the most sense for a customer of Confluence. Here is what he wrote:

"The JSpell Evolution server is licensed on a per server/domain basis. JSpell Evolution is currently in "late" Early Access release at discounted pricing and these prices are subject to change when we go 'gold' (probably about a 30% increase)... But, presently, to use JSpell Evolution on a single server you would need the JSpell Evolution Single Server License at $269.95. For a company with a single physical location and multiple servers then they would probably choose the JSpell Evolution Single Site License at $795.00. If they have multiple locations (cities) then they'd choose JSpell Evolution Global Site License at $1,695.00. These can be ordered online at http://www.thesolutioncafe.com/jspellorder.html or through a number of resellers including Software House International www.shi.com or Software Spectrum www.softwarespectrum.com."

So this is just one option.


David Aldrich added a comment - 27/Oct/06 02:23 AM
Using JSpell, is it possible for the user to turn spell-checking on and off at the browser?

i.e. How does one activate the manual spell check (I may not want to see all those wiggly red lines).


Brendan Patterson [Atlassian] added a comment - 27/Oct/06 07:56 AM
Good questions. I'm going to try to integrate JSPell into my Confluence site hopefully today or tomorrow so anyone interested can play. I wanted to do that before sending the comment out above, but got busy with other stuff and decided to just pull the trigger

I'll comment again (hopefully soon) when it's up.


Brendan Patterson [Atlassian] added a comment - 27/Oct/06 11:31 AM
Here is JSpell integrated with Confluence.
http://www.artemissoftware.biz/site/display/jspell/Home

What I've seen with it so far:

  • Seems to work well with FireFox on WinXP and Win 2K (left click for JSpell corrections, right click for FireFox corrections)
  • Seems to work well with IE on WinXP
  • Does not work with my IE6 on Win 2K (I tried 2 computers) but this is probably one of many alpha version bugs/quirks or it could be something about my system.

By the way my Confluence instance is not built for speed It's a small slice of a VPS server without much memory also running JIRA. So if it's a bit slow that's why.


Sean Kennedy added a comment - 30/Oct/06 02:07 PM
With spell check coming out as part of Firefox2.0 & being an easy add on to most other browsers, I think we should drop this issue. I've finally "unvoted" for it.

Russell Warren added a comment - 30/Oct/06 03:18 PM
I haven't installed Firefox 2.0 yet (for fear of breaking my zillion extensions), but... what does the spellcheck do with lots of in-page macros? Google spellcheck never worked for any decent pages because it choked and crapped out once it found too many spelling "mistakes".

David Soul [Atlassian] added a comment - 31/Oct/06 12:36 AM
Individuals who would like spell checking in Confluence now have the option of upgrading their browser to Firefox 2 ( www.mozilla.com ), which offers an inbuilt spell checker. First impressions of the Firefox spell checker are that it works very well for both wiki markup and rich text editing. This doesn't reduce the priority of implementing inbuilt spell checking to Confluence itself.

Yaniv Shaya added a comment - 31/Oct/06 02:36 AM
To all those who offer to use FireFox or addons for other browser:

When you are in an Enterprise environment with a couple of thousands business users, who aren't updated with addons and firefox, and IT constraints that don't allow you to install whatever you want on your machine, spell checking provided by the server is a must.

You simply can't expect the the user to install stuff on their client machines (sometimes multiple machines) - if you could, you could use a fat client application instead of a web based application and get much better user experience.

I can tell you I keep getting requests here for this functionality and the firefox/other addons answer isn't accpetable, especially when so many web applications (including wikis) include this functionality.

My 2 cents.


David Aldrich added a comment - 31/Oct/06 02:37 AM
Hi Brendan, thanks for making available the demo of JSpell. I think it needs an option to turn spell checking on and off (although 'Ignore All' will turn off spell checking per visit to the page).

Brendan Patterson [Atlassian] added a comment - 31/Oct/06 11:52 AM
re: resolving this issue.

I don't think this issue can be resolved at present. FireFox spell check functionality (which seems quite good) is still used by less than 30% of people. If you google 'web browser usage' you'll see that over 60% of people still use IE. As stated above this is often mandated by large corporations and there isn't necessarily another option. Or even when there is another option many of the users are non-technical and have no interest in downloading/installing anything.

If the majority of your users are technical and/or already use FireFox then I agree you're set.

The JSpell route is just one option. There has also been talk of integrating one of the open source spell checkers into Confluence (though it would have to be non-GPL) to ever be distributed by Atlassian.

The lowest level license costs around half and average developer's day of time or less so it seems like a decent solution if you want your users to have universal spell check.

  • Just looking for easy solutions and quick wins

Martin Skopp added a comment - 28/Mar/07 09:21 AM
Amazingly this issue has more votes than CONF-2079 and CONF-1031 (Page Ordering and More Control on PDF Export)...
Spell checking might be a nice feature, but PDF Export Control + Page Ordering really is a must.
Just my 2 cents.

Douglas Ko added a comment - 28/Mar/07 06:14 PM
Given the built-in spell checker in the new FireFox 2.0 browser I would vote down the priority of this issue a notch. However, given many organizations are still tied to Internet Explorer this should not be dropped completely.

Sally Weston added a comment - 30/Mar/07 06:58 AM
Hi Douglas,

I get the point but I think that many large corporates (such as us) are
still using Internet Explorer. As Confluence is the leading commercial wiki
tool, and as a result has a large corporate community, I would expect that a
spell checker remains a high priority.

Cheers,

Sally


James Woest added a comment - 24/Apr/07 02:44 PM
Agree with Sally above - an integrated spell checker is a must for those of us working in a large corporate environment, where systems are locked down, IE is a mandate, and/or the technical expertise of the users cannot be guaranteed.

Bijan Marjan added a comment - 12/Jun/07 10:00 AM
Other good lightweight products include RapidSpell and XMLmind which could be integrated into confluence.

Scott Farquhar [Atlassian] added a comment - 02/Jul/07 07:31 PM
From Steve Burden (Merryl Lynch):

Here are some web-based spell checkers:


Mitchell Starnes added a comment - 18/Jul/07 09:10 AM
I agree with Yaniv, Sally, and James. In the corporate environment, we need an integrated spellchecker that works with IE.

Ryan Ackley added a comment - 26/Jul/07 05:35 PM
I just wrote a plugin that allows you to edit Confluence pages in Word. That means you can just use Word's integrated spell checker. It's a really good spell checker and if you own a copy of Word, chances are it will do spell checking in your native language.

http://confluence.atlassian.com/display/CONFEXT/Word.DAV+plugin


Octavian Petre added a comment - 29/Aug/07 04:39 AM
I disagree having a spellchecker in confluence. There are already proven solutions.

It would be a pity that developers would have to write again the same piece of code while this is FREELY available.

If you think like an engineer you might agree with me.
If you put on the manager hat (do you remember this quote?) then you would request a spell checker.

Regards,
Octavian

P.S. In the past IE had > 90% of the market. Now is down to < 60%... (http://www.w3schools.com/browsers/browsers_stats.asp)


Nicholas Kerzman added a comment - 06/Sep/07 09:34 AM
The ongoing discussion here is interesting. It is a dichotomy between "developer/techy view" and "corporate view " users. I know those are blanket statements... but the point I'm trying to make is that if Atlassian is truly seeking to develop the leading enterprise wiki solution, then an integrated spell checker is a vital piece in supporting corporate adoption and use. I have to side with Yaniv, Sally, James, and Mitchell.

I'm supporting the implementation and adoption of Confluence in our organization (Fortune 1000) and see spell checking as an important feature for the average end user. Our corporate standard browser installation is IE and this will likely not change. Firefox is also approved for use, and I myself use FF almost exclusively leveraging some of the plugins mentioned. But I'm not your average user.

Great discussion, but I definitely have to support the request of adding spell checking capability in the application. Maybe Atlassian could consider developing it as a feature/plugin that could be enabled or disabled depending on the preference of the business installation. Then you could please the corporate users, and those who have other freely available means of spell checking could choose not to leverage this feature.

You can't make everybody happy... but I think Atlassian does need to look at who their target is and do their best to appeal to this audience.

Thanks,

Nicholas


Peter Raymond added a comment - 06/Sep/07 02:05 PM
Nicholas,

From another Fortune 100 company wishing to broaden Confluence's internal appeal: "Well said."

Peter


Roger Symonds [CustomWare] added a comment - 29/Oct/07 05:59 PM - edited
Hi Guys,

I am trying to integrate JSpell with Confluence however aren't having much luck, as the instructions above don't apply to Confluence 2.6.0 (latest version of Confluence), I'm sure the instructions work for older instances of Confluence though.

The problem I have is that the TinyMceEditor has now been made a plugin, and these instructions relate to the TinyMceEditor when was a core part of Confluence.

In my opinion (and this is only my opinion), for the corporate environment to really embrace Confluence (a great well rounded product, which is already highly successful) I think this spell checking is a key feature that needs to be implemented.

For the value it adds to the product vs implementation time, perhaps it should be re-considered as a must have for Confluence.

Roger


Matt Ryall [Atlassian] added a comment - 01/Nov/07 08:30 PM
Roger, these instructions are still able to be followed, but you need to apply the changes to the editor Javascript inside a JAR which is found in our bundled-plugins ZIP file. You can try the following steps:

1. Shut down Confluence.
2. Back up your Confluence application directory, home directory and database.
3. Find the file 'atlassian-bundled-plugins.zip' in confluence/WEB-INF/classes/com/atlassian/confluence/setup/.
4. Extract this file using your favourite zip tool, such as WinZip.
5. Contained in the zip file is a jar file called atlassian-tinymce-plugin, with a particular version. Unzip this file to a new directory, again using your zip tool like WinZip. (A jar file is just a zip file which contains Java-related stuff.)
6. Apply the tinymce changes mentioned in the document above.
7. Zip up the contents of the new directory into a new atlassian-tinymce-plugin jar file.
8. In atlassian-bundled-plugins.zip, you need to replace the existing atlassian-tinymce-plugin jar file with your custom one. Do this by either zipping up the modified contents, or just modifying the existing file in place.

Please note that Atlassian didn't write these instructions, and doesn't currently provide support for integration with JSpell. Please ensure you back up Confluence before making any changes.

The reason this complexity exists is that is now possible to create plugin which includes a customised version of the Confluence rich-text editor or override the rich-text editor entirely. Some customers might wish to investigate this option for integrating a spell-checker. The first example of this new feature is a forthcoming Ephox EditLive editor plugin for Confluence which should include spell-checking. Please follow up with Ephox for more information about this, which I understand will be a commercial (i.e. paid) plugin.


Roger Symonds [CustomWare] added a comment - 01/Nov/07 09:42 PM
Hi Matt,

Thanks for your reply. I worked out another way to get it working.
You can edit the file template\notable\wiki-textarea.vm and this seems to get the same effect, rather than unzipping, making changes, and re-zipping the jar file. I'm not sure which is the best way to do it though from a perspective of upgrading etc.

I added the 2 lines below to the function "showRichText":
// The below line was added for JSpell Evolution
setTimeout(jspellInit,500);

Please see the example below.
I hope this helps,
Roger

function showRichText(show)
{
#if ($action.useWysiwyg)
if(show)

{ // The below line was added for JSpell Evolution setTimeout(jspellInit,500); $('wysiwyg').style.display = 'block'; $('wysiwygTab').className = 'current'; onShowEditor(); // now we are in rich text mode, and may change the content, so any value in lastKnownGoodContent is obsolete lastKnownGoodContent = null; }

else

{ onHideEditor(); $('wysiwyg').style.display = 'none'; $('wysiwygTab').className = ''; }

#end
}


Steve Hadfield added a comment - 02/Nov/07 01:57 PM
Matt:

I was able to independently validate your instructions in the standalone. Although, it doesn't work with out apache-tomcat configuration yet.


John Preval added a comment - 18/Nov/07 02:31 AM
Team,

I don't know if I could get a better result if I followed Matt Ryalls instructions, however I followed Roger's and thought it was OK, however I have now found that I don't get spell checking in a "News" page or in a "Comment" so it's probably back to the drawing board.


Per Fragemann [Atlassian] added a comment - 25/Nov/07 04:13 AM
Added proper component to this issue.

Phillippa Kassover added a comment - 04/Dec/07 06:52 PM
I'm not a software engineer or IT professional, just an administrator and user of the wiki in an academic environment. We are trying to use the wiki as our primary method of comunication and project management. A spell checker is essential, and should be integral. If Confluence and use of wiki's is to become ubiquitous, the functionality must be complete and full functionality must be accessible to all, not just the IT community.

Cheryl Lesser added a comment - 15/Feb/08 05:15 PM
In January we soft-launched Confluence to our company of 30,000+ employees. Even though awareness is still quite low, I've been getting several questions a week about spellchecking. I definitely think that an integrated, easy-to-use spellchecker would improve the perception of the tool and help adoption efforts at our organization.

Ernest Mueller added a comment - 16/Mar/08 11:03 PM
I am also launching Confluence to an entire organization, and integrated spell-checking is a necessity. I will note that WordPress has had it for 2 years now.

Rick Hadsall added a comment - 20/Mar/08 05:46 PM

Extremely large financial services company here... we're standardized on IE, we're looking to roll Confluence out to our largest division... the pilot users have already asked about spell checking. It's a must-have feature.

(that, and, expansion of functionality in the rich text editor itself to include more "MS Word-like" options that would result in macros in wiki markup or html wrapped in html macro)


Alaa Alwani added a comment - 27/Mar/08 04:22 AM
Ok Guys, I managed to run JSpellEvolution on the latest (2.7) Confluence release and here is how:

1- template\notable\wiki-textarea.vm does not exist if u are using the latest version of confluence.
2- You have to follow Matt's instructions above.
3- make sure when changing web.xml of jspell to write the correct path for lexicons folder.
4- make sure when changing editpage-form.vm to write the correct path of the .js files:
SRC="/jspellEvolution/jspellSettings.js" means that the file is under <webserver folder>/Webapps/jspellEvolution web application
3- after doing your tinymce changes make sure u shutdown confluence, then make sure to DELETE "atlassian-tinymce-plugin-2.9.jar" from the folder u set as home for confluence.
4- restart confluence, you should find the modified version of "atlassian-tinymce-plugin-2.9.jar" inside the home directory again.
5- Everything should work fine when you edit a page.
6- Please note that in order to make JSpell work when adding a New Page you should add the same script added in editpage-form.vm to createpage-form.vm (just copy and paste at the top)
7- didnt try to look for the file needed to add jspell to comments (i think comments shouldnt be checked for spelling anyways).

Hope this helps and good luck...


Helene McElroy added a comment - 23/May/08 09:44 AM
If the spell checker was a plugin, those who didn't want to use it because they have a preferred solution wouldn't be forced to, while the other 159 of use who are in corporate situations which tie our hand a bit more could have the functionality we require. I'd love to use firefox at work, but its more or less viewed as contraband.

Octavian Petre added a comment - 26/May/08 03:01 AM
Helene, then you have to educate them and change the "contraband" view. Or better, leave the company, some of them refuse to be educated.

Sincerely yours,
Octavian


Rick Hadsall added a comment - 27/May/08 05:10 PM
Octavian,

That simply isn't realistic.

I want to note to the Atlassian folks that it appears the latest version of TinyMCE ships with a spell check plugin in the distribution - it requires some small tooling to be present on the server side (GoogleSpell I think) and that might be something to look at to provide this functionality.


Michael Spoonauer added a comment - 28/Jul/08 11:22 AM
I completely understand where everyone who is able to use Firefox as their browser at work is coming from. For them, this is a non-issue.

However, because at some large companies such as mine, some Intranet applications were actually built to take advantage of IE-only features, and end-users not in the IT community do not have permission to download software onto their PCs, spell check is still a major issue for us, as it will take a considerable amount of time to migrate from IE to Firefox across the company.

Are there really not enough large companies in this kind of environment to justify trying to provide a plug-in for Confluence that enables spell check for Pages, News and Comments?

Thanks,
Mike


Stacy shenker added a comment - 29/Sep/08 10:31 AM
I have followed all the instructions to get jspell to work with tomcat. My issue is that we use IIS to had off the site to tomcat. I cant get jspell to work under iis. Can anyone help with this. I ran the install and for some reason it does not work. ASP in enabled.

My vote is to have a spell checker. Because of the large number of people we will have using this, and our security requirements before adding or installing anyting to a PC, it is not as simple as installing an IE plugin.


Brendan Patterson [Atlassian] added a comment - 29/Sep/08 05:10 PM
In terms of getting JSPell working under IIS I'd suggest reaching out to the maker of JSpell maybe starting at this link and then click on contact

Stacy shenker added a comment - 01/Oct/08 10:43 AM
Brendan,
I have actually seen that document. We decided to just use Tomcat. I have been able to get the spell check working for the create or edit pages and news. The issue I have discovered is that if you go to add a comment, you cannot switch from the Rich Text tab to either the wiki markup or preview tab.
Has anyone else gotten this issue or know of a fix. I am using Confluence 2.8
thanks

Ronald Schwarz added a comment - 19/Nov/08 08:52 AM
I need a spell checker for new material I add to my company's wiki. I usually check it offliine in a separate text editor - an awkard procedure.

Brendan Patterson [Atlassian] added a comment - 01/Dec/08 12:15 PM
Ronald,

In your case using FireFox would probably work out well since it sounds like you're mainly looking for a solution for just yourself as opposed to your whole company.

thanks,
Brendan


Ed Letifov added a comment - 15/Dec/08 01:39 AM - edited
For those interested in integrating JSpell Evolution with Confluence 2.9.2
http://techtime.co.nz/display/TECHTIME/2008/12/15/Integrating+JSpell+into+Confluence+2.9.2

Karen Huffman added a comment - 22/Jan/09 10:43 AM
I'd like to see spell check integrated in Confluence/part of it's essential offerings. Karen

Yao Ge added a comment - 22/Jan/09 10:52 AM
Totally aggree Karen, I'd rather paid to have integral Confluence package with spell-checking enabled than spending the effort to integrate a third party one.

Corey Hampton added a comment - 18/Mar/09 09:29 AM
An integrated spell checker is a necessity for corporate environment where users can not install Firefox on their PC. Internet Explorer is used company-wide. I know you can edit in Word with spell check, but that doesn't benefit those users who don't use word. A fair amount of our employees will not use Word to edit a Wiki Page.

I feel that this is an extremely important feature that needs to be added to Confluence.


Subhash Mathur added a comment - 27/Mar/09 12:03 PM
It is most important to take this up . . . so many users have voted for it.
With MS-Office apps integrated in the Wiki, it would be almost a given that users would expect it.
BTW, please note that PBWiki announced theirs in their blog on march 18, 2009.

Barry Gray added a comment - 30/Apr/09 09:29 PM
Hi all,

A number of comments here mention the use of Firefox and its plug-in spell checkers being a solution, e.g. from Brendan Patterson [Atlassian] . I agree that this was a solution, but this 'feature' is now broken for the WYSIWYG editor in Confluence.
Please see CONF-15001 for details.

If you have an interest in this please vote up CONF-15001, as I think it is only a setting that needs to be set to TRUE - so easy to fix for the 30% of us that use Firefox.

Thanks


Eliot Hariton added a comment - 25/May/09 11:19 AM
This features seems like a no-brainer.

Sinan O. Karasulu added a comment - 23/Jun/09 08:46 AM
Hi .

I'm currently working with Confluence 2.8.2 and our company requires that we integrate JSpell. Everything seems to be working. I am able to toggle between RT and WM modes without problems.

Not sure if anyone spotted this bug. In Rich text mode if I make any change and then click Undo, a left-click no longer brings up the pop-up box .

has anyone encountered this problem? and if so , what was the solution.

thanks

Sam