You are here

Home » API reference » Wysiwyg SpellCheck 6

INSTALL.txt in Wysiwyg SpellCheck 6

Same filename and directory in other branches
  1. 7 INSTALL.txt
Wysiwyg SpellCheck Module Installation

To enable this module, follow these instructions:

1. Upload the "Wysiwyg SpellCheck" module to your sites/all/modules folder.

2. Enable the "Wysiwyg SpellCheck" module on the admin/build/modules page.

3. Install spellchecker plugin
In order to use Spell Checker, you will need to download and install spellchecker plugin appropriate for your editor.

TinyMCE spellchecker plugin
===========================

Browser-side TinyMCE spellchecker plugin (steps numbered BST#):
NOTE:
TinyMCE ver 3.4.4 has the default option for browser-side spellchecker on supported browsers,
but it is not yet supported by this module. It might work on some browsers, but was not tested.
BST1. Instructions TBD.

Server-side TinyMCE spellchecker plugin (steps numbered SST#):
(These instructions explain how to install and enable server-side spellchecker)

SST1. Download, extract and copy spellchecker plugin from
from http://www.tinymce.com/download/download.php
(Once you are on the download page, download "PHP Spellchecker" 2.x which is listed in the "Other components" section)

into
sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/
(overwrite files that came with TinyMCE)

After installation it should be found in sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/spellchecker/

As a quick check, the following files should be present in the above path:
- editor_plugin.js
- config.php

SST2. Edit sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php

Uncomment one of the lines that select which spellchecker to use:

*It comes with defaults using Google spellchecker.

*Other options: TBD

SST3. Visit http://YOURSITE/admin/reports/status, verify that Wysiwyg TinyMCE spellchecker reports "Installed correctly".

SST4. Visit http://YOURSITE/sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/spellchecker/rpc.php,
you should see a string in curly braces {"result":null,...}.
If you don't see the expected {"result":null,...}, you will have to figure out access permissions or other problems with your webserver or ISP.

SST5. Configure one of your WYSIWYG profiles to show TinyMCE spellcheck button

SST6. Verify that TinyMCE shows the new button when you edit a page using your WYSISWYG profile, and this button works.


CKEditor ASpell plugin
======================

Browser-side CKEditor spellchecker plugin (steps numbered BSC#):
NOTE:
CKEditor has the default option for browser-side spellchecker on supported browsers,
but it is not yet supported by this module. It might work on some browsers, but was not tested.
BSC1. Instructions TBD.

Server-side CKEditor spellchecker plugin (steps numbered SSC#):
(These instructions explain how to install and enable server-side spellchecker)

SSC1. Aspell library (http://aspell.net) must be installed and working on the server. Do not proceed until it works.

SSC2. Download CKEditor aspell plugin from http://cksource.com/forums/download/file.php?id=512&sid=5cc3ef8ceca1432ebc4459b4241c84aa

SSC3. Unzip the contents of the zip file into sites/all/libraries/ckeditor/plugins so that you have sites/all/libraries/ckeditor/plugins/aspell directory

SSC4. Visit http://YOURSITE/admin/reports/status, verify that Wysiwyg CKEditor spellchecker reports "Installed correctly".

SSC5. Visit http://YOURSITE/sites/all/libraries/ckeditor/plugins/aspell/spellerpages/server-scripts/spellchecker.php,
you should see an empty page. If you inspect source, it should have "function init_spell() {..." inside the head section.
If you don't see the expected "function init_spell() {", you will have to figure out access permissions or other problems with your webserver or ISP.

SSC6. If you aren't using PHP for server-side script (this is rarely needed), edit aspell/dialogs/aspell.js, locate oSpeller.spellCheckScript and change it as appropriate. Redo step #SSC5 for selected script.

SST7. Configure one of your WYSIWYG profiles to show CKEditor spellcheck button (checkbox "Server Side Spell Check")

SST8. Verify that CKEditor shows the new button when you edit a page using your WYSISWYG profile, and this button works.

File

INSTALL.txt
View source 
  1. Wysiwyg SpellCheck Module Installation

  2. 

  3. To enable this module, follow these instructions:

  4. 

  5. 1. Upload the "Wysiwyg SpellCheck" module to your sites/all/modules folder.

  6. 

  7. 2. Enable the "Wysiwyg SpellCheck" module on the admin/build/modules page.

  8. 

  9. 3. Install spellchecker plugin

  10. In order to use Spell Checker, you will need to download and install spellchecker plugin appropriate for your editor.

  11. 

  12. TinyMCE spellchecker plugin

  13. ===========================

  14. 

  15. Browser-side TinyMCE spellchecker plugin (steps numbered BST#):

  16. NOTE:

  17. TinyMCE ver 3.4.4 has the default option for browser-side spellchecker on supported browsers,

  18. but it is not yet supported by this module. It might work on some browsers, but was not tested.

  19. BST1. Instructions TBD.

  20. 

  21. Server-side TinyMCE spellchecker plugin (steps numbered SST#):

  22. (These instructions explain how to install and enable server-side spellchecker)

  23. 

  24. SST1. Download, extract and copy spellchecker plugin from

  25. from http://www.tinymce.com/download/download.php

  26. (Once you are on the download page, download "PHP Spellchecker" 2.x which is listed in the "Other components" section)

  27. 

  28. into

  29. sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/

  30. (overwrite files that came with TinyMCE)

  31. 

  32. After installation it should be found in sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/spellchecker/

  33. 

  34. As a quick check, the following files should be present in the above path:

  35. - editor_plugin.js

  36. - config.php

  37. 

  38. SST2. Edit sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php

  39. 

  40. Uncomment one of the lines that select which spellchecker to use:

  41. 

  42. *It comes with defaults using Google spellchecker.

  43. 

  44. *Other options: TBD

  45. 

  46. SST3. Visit http://YOURSITE/admin/reports/status, verify that Wysiwyg TinyMCE spellchecker reports "Installed correctly".

  47. 

  48. SST4. Visit http://YOURSITE/sites/all/libraries/tinymce/jscripts/tiny_mce/plugins/spellchecker/rpc.php,

  49. you should see a string in curly braces {"result":null,...}.

  50. If you don't see the expected {"result":null,...}, you will have to figure out access permissions or other problems with your webserver or ISP.

  51. 

  52. SST5. Configure one of your WYSIWYG profiles to show TinyMCE spellcheck button

  53. 

  54. SST6. Verify that TinyMCE shows the new button when you edit a page using your WYSISWYG profile, and this button works.

  55. 

  56. 

  57. CKEditor ASpell plugin

  58. ======================

  59. 

  60. Browser-side CKEditor spellchecker plugin (steps numbered BSC#):

  61. NOTE:

  62. CKEditor has the default option for browser-side spellchecker on supported browsers,

  63. but it is not yet supported by this module. It might work on some browsers, but was not tested.

  64. BSC1. Instructions TBD.

  65. 

  66. Server-side CKEditor spellchecker plugin (steps numbered SSC#):

  67. (These instructions explain how to install and enable server-side spellchecker)

  68. 

  69. SSC1. Aspell library (http://aspell.net) must be installed and working on the server. Do not proceed until it works.

  70. 

  71. SSC2. Download CKEditor aspell plugin from http://cksource.com/forums/download/file.php?id=512&sid=5cc3ef8ceca1432ebc4459b4241c84aa

  72. 

  73. SSC3. Unzip the contents of the zip file into sites/all/libraries/ckeditor/plugins so that you have sites/all/libraries/ckeditor/plugins/aspell directory

  74. 

  75. SSC4. Visit http://YOURSITE/admin/reports/status, verify that Wysiwyg CKEditor spellchecker reports "Installed correctly".

  76. 

  77. SSC5. Visit http://YOURSITE/sites/all/libraries/ckeditor/plugins/aspell/spellerpages/server-scripts/spellchecker.php,

  78. you should see an empty page. If you inspect source, it should have "function init_spell() {..." inside the head section.

  79. If you don't see the expected "function init_spell() {", you will have to figure out access permissions or other problems with your webserver or ISP.

  80. 

  81. SSC6. If you aren't using PHP for server-side script (this is rarely needed), edit aspell/dialogs/aspell.js, locate oSpeller.spellCheckScript and change it as appropriate. Redo step #SSC5 for selected script.

  82. 

  83. SST7. Configure one of your WYSIWYG profiles to show CKEditor spellcheck button (checkbox "Server Side Spell Check")

  84. 

  85. SST8. Verify that CKEditor shows the new button when you edit a page using your WYSISWYG profile, and this button works.

  86.