From:  Makyen <>
Date:  02 Mar 2017 08:43:45 Hong Kong Time

Re: Spellcheck on MDN


Adding to the browser context menu has issues:
   * Browser extension: Obviously, we can add to the browser context 
menu using a WebExtension (and similar extensions for other browsers). 
The primary disadvantage I see is that setting it up such that users 
need to install an add-on to get the full functionality of editing MDN 
is not usually a good a user experience choice.
   * In page HTML: An in-page solution would only be supported by 
Firefox, as adding to the browser context menu with  HTML elements 
is not supported in other browsers without, at least, the user setting a 
flag (e.g. Chrome).  I have no idea what percentage of MDN edits are 
done with non-Firefox browsers. If the usage of other browsers is 
sufficiently low, we could go with this solution.

   Either of those solutions for adding the CKEditor entries to the 
browser context menu requires a significant expenditure of software 
development resources.

Enable browser spellcheck and educate users to access it using 
   * You can use browser based spellchecking without disabling the 
CKEditor context menu. I use browser based spellcheck whenever I edit 
MDN. In Firefox, you can access the browser context menu using 
ctrl-right-click,  or shift-right-click. I just tested editing MDN with 
browser based spellcheck enabled on Chrome. Only ctrl-right-click works 
in Chrome . (1)

   The things required to implement this are to enable browser 
spellcheck in the DOM and educate users to use the Ctrl key with their 
right-click.  Enabling spellcheck can, obviously, be done server side by 
small changes to the HTML. At the moment, I do it client side with a 
user script. User education could be done, for example, by having a note 
at the top of the page,  an unobtrusive note shown when the CKEditor 
context menu is used, and/or a note at the bottom of the CKEditor 
context menu.

   The development cost of this should be minimal to small, depending on 
how the information is shown to users. There may be increased CS cost, 
but there would be increased CS cost for the various solutions which put 
the CKEditor entries into the browser context menu.

Just enabling browser spellcheck (the "spellcheck" attribute set to 
"true"), while educating users with text in the page or CKEditor context 
menu, looks to me like it might give the best of both worlds (have both 
the CKEditor context menu and browser spellcheck), while doing so with 
lower cost than implementing a method to get the CKEditor entries into 
the browser context menu. Educating users is always a pain, but with 
appropriately placed information text (and maybe the ability for the 
user to disable spellcheck), I think it might work.

I don't see a truly good option here. None of the available solutions 
are perfect.


1. I don't use Chrome much, so I'm not familiar with its normal 
spellcheck UI in "contenteditable" divs. When briefly testing, I found 
that it only spellchecked the paragraph in which I focused, not the 
whole MDN page I was editing. I don't know if this is normal, but I 
assume it is normal for "contenteditable" portions of the DOM.

On 3/1/2017 2:28 PM, Eric Shepherd wrote:
> Yeah, I figured we’d wind up here. I use the context menu pretty extensively (that’s why I’ve got bugs on file about adding more stuff to it). I’ll get over it eventually, I suppose, but it’s a bummer.
> I bet we could do a CKEditor add-on pretty easily that would add the context menu items to the standard HTML menu, generating the appropriate events to activate the corresponding functions when chosen. It could be a WebExtension even, but it shouldn’t be necessary.
>> On Mar 1, 2017, at 4:52 PM, wrote:
>> My recommendation is to disable SCAYT and replace it with browser-based spell check.  This may require disabling the integrated context menu as well, which gives CKEditor-specific options when you right-click.  I'm looking for feedback on this recommendation, especially from those who are regular users of spell check and / or the context menu.  I suspect that very few MDN users use either feature, and switching to browser-based spellcheck would be an improvement for almost everyone.
> Eric Shepherd
> Senior Technical Writer
> Mozilla Developer Network 
> Blog:
> Twitter:
> _______________________________________________
> dev-mdc mailing list
> MDN contributor guide: