Difference between revisions of "Enable TinyMCE spellcheck module"

(Updated PHP Spellchecker documentation)
Line 11: Line 11:
 
* PHP5 must be enabled in your Apache configuration
 
* PHP5 must be enabled in your Apache configuration
  
= Enabling the TinyMCE Spellcheck module =
+
= Installation and Configuration of the TinyMCE Spellcheck module =
  
Please note that enabling the spellcheck module will require the modification of one javascript file of the Open-Xchange UI, and therefor every update will disable the spellcheck button, as the javascript file will be overwritten during the update. Also Open-Xchange cannot support the spellcheck module itself and the according infrastructure (aspell, PHP), as those modules won't be maintained and tracked by Open-Xchange.
+
Please note: Open-Xchange cannot support the spellcheck module itself and the according infrastructure (aspell, PHP), as those modules won't be maintained and tracked by Open-Xchange. On machines with lot of users this service may produce heavy load due to many request so we highly recommend to cluster it or, even better, to use the native spellcheck plugins of modern browsers.
  
 
== Installation of the TinyMCE spellchecker module ==
 
== Installation of the TinyMCE spellchecker module ==
  
Please visit the TinyMCE website and download the latest TinyMCE spellchecker module (at the bottom of the page) at http://tinymce.moxiecode.com/download.php. This article will use the following spellchecker module: http://prdownloads.sourceforge.net/tinymce/tinymce_spellchecker_php_2_0_2.zip?download
+
Please visit the TinyMCE website and download the latest TinyMCE "PHP Spellchecker"  plugin at http://www.tinymce.com/develop/changelog/?type=phpspell. This article will use Version 2.0.3.
  
 
Extract the downloaded archive and move the extracted directory "spellchecker" to the TinyMCE location on the Open-Xchange installation:
 
Extract the downloaded archive and move the extracted directory "spellchecker" to the TinyMCE location on the Open-Xchange installation:
Line 35: Line 35:
 
Finally we need to tell the spellchecker module which binary it should execute in order to get spelling suggestions. By default GoogleSpell is activated for remote suggestion, but as this would mean that every eMail which should be checked will be send to Google, we recommend to use a local aspell instance for this purpose. To do so, install aspell and the according dictionaries as we told you in the requirements section, and modify /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php to specify the aspell binary location. Please use the following example, and just replace [REPLACE_WITH_PATH_TO_ASPELL_BIN] with the location of the aspell binary (for example /usr/bin/aspell):
 
Finally we need to tell the spellchecker module which binary it should execute in order to get spelling suggestions. By default GoogleSpell is activated for remote suggestion, but as this would mean that every eMail which should be checked will be send to Google, we recommend to use a local aspell instance for this purpose. To do so, install aspell and the according dictionaries as we told you in the requirements section, and modify /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php to specify the aspell binary location. Please use the following example, and just replace [REPLACE_WITH_PATH_TO_ASPELL_BIN] with the location of the aspell binary (for example /usr/bin/aspell):
  
<?php
+
  <?php
 +
  /**
 +
  * config.php
 +
  *
 +
  * @package MCManager.includes
 +
  */
 
         // General settings
 
         // General settings
 
         //$config['general.engine'] = 'GoogleSpell';
 
         //$config['general.engine'] = 'GoogleSpell';
Line 43: Line 48:
 
   
 
   
 
         // PSpell settings
 
         // PSpell settings
         //$config['PSpell.mode'] = PSPELL_FAST;
+
         $config['PSpell.mode'] = PSPELL_FAST;
         //$config['PSpell.spelling'] = "";
+
         $config['PSpell.spelling'] = "";
         //$config['PSpell.jargon'] = "";
+
         $config['PSpell.jargon'] = "";
         //$config['PSpell.encoding'] = "";
+
         $config['PSpell.encoding'] = "";
 
   
 
   
 
         // PSpellShell settings
 
         // PSpellShell settings
 
         $config['PSpellShell.mode'] = PSPELL_FAST;
 
         $config['PSpellShell.mode'] = PSPELL_FAST;
         $config['PSpellShell.aspell'] = '[REPLACE_WITH_PATH_TO_ASPELL_BIN]';
+
         $config['PSpellShell.aspell'] = '[REPLACE_WITH_PATH_TO_ASPELL_BIN]'; // e.g. /usr/bin/aspell
 
         $config['PSpellShell.tmp'] = '/tmp';
 
         $config['PSpellShell.tmp'] = '/tmp';
 
   
 
   

Revision as of 09:26, 21 September 2011

Introduction

By default there is no spell check available in the Open-Xchange application itself because most of the modern browsers usually offer a spellcheck module. TinyMCE, the HTML editor which is used by Open-Xchange for HTML editing while writing an eMail, offers a wide set of functions and features which can be added to the HTML editor UI. This example will describe how you can enable the TinyMCE based spellcheck functionality within the Open-Xchange mail module.

Requirements

  • An installed Open-Xchange Server
  • ASpell with the according dictionaries needs to be installed
  • PHP5 must be enabled in your Apache configuration

Installation and Configuration of the TinyMCE Spellcheck module

Please note: Open-Xchange cannot support the spellcheck module itself and the according infrastructure (aspell, PHP), as those modules won't be maintained and tracked by Open-Xchange. On machines with lot of users this service may produce heavy load due to many request so we highly recommend to cluster it or, even better, to use the native spellcheck plugins of modern browsers.

Installation of the TinyMCE spellchecker module

Please visit the TinyMCE website and download the latest TinyMCE "PHP Spellchecker" plugin at http://www.tinymce.com/develop/changelog/?type=phpspell. This article will use Version 2.0.3.

Extract the downloaded archive and move the extracted directory "spellchecker" to the TinyMCE location on the Open-Xchange installation:

$ mv spellchecker /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/.

Enable the spellchecker button in the Open-Xchange HTML editor

This can be accomplished by adding a properties file to directory "/opt/open-xchange/etc/groupware/settings".

$ vim /opt/open-xchange/etc/groupware/settings/spellchecker.properties

modules/mail/spellcheck=true

Setup the backend communication

Finally we need to tell the spellchecker module which binary it should execute in order to get spelling suggestions. By default GoogleSpell is activated for remote suggestion, but as this would mean that every eMail which should be checked will be send to Google, we recommend to use a local aspell instance for this purpose. To do so, install aspell and the according dictionaries as we told you in the requirements section, and modify /var/www/ox6/3rdparty/tinymce/jscripts/tiny_mce/plugins/spellchecker/config.php to specify the aspell binary location. Please use the following example, and just replace [REPLACE_WITH_PATH_TO_ASPELL_BIN] with the location of the aspell binary (for example /usr/bin/aspell):

 <?php
 /**
  * config.php
  *
  * @package MCManager.includes
  */
        // General settings
        //$config['general.engine'] = 'GoogleSpell';
        //$config['general.engine'] = 'PSpell';
        $config['general.engine'] = 'PSpellShell';
        //$config['general.remote_rpc_url'] = 'http://some.other.site/some/url/rpc.php';

        // PSpell settings
        $config['PSpell.mode'] = PSPELL_FAST;
        $config['PSpell.spelling'] = "";
        $config['PSpell.jargon'] = "";
        $config['PSpell.encoding'] = "";

        // PSpellShell settings
        $config['PSpellShell.mode'] = PSPELL_FAST;
        $config['PSpellShell.aspell'] = '[REPLACE_WITH_PATH_TO_ASPELL_BIN]'; // e.g. /usr/bin/aspell
        $config['PSpellShell.tmp'] = '/tmp';

        // Windows PSpellShell settings
        //$config['PSpellShell.aspell'] = '"c:\Program Files\Aspell\bin\aspell.exe"';
        //$config['PSpellShell.tmp'] = 'c:/temp';
?>