Enable TinyMCE spellcheck module

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

Enabling 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.

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

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

Version >= 6.14:

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

This file should contain a single property of the format:

<path-in-config-tree> '=' ("true" | "false")

E.g.:

# A short description of this property
modules/mail/spellcheck=true

The file "/opt/open-xchange/etc/groupware/settings/themes.properties" for example is a good choice as a template.

Version <= 6.12:

Now as we have installed the spellcheker plugin, we need to modify the Open-Xchange HTML editor, so that the spellchecker button will be displayed. To do so, edit /var/www/ox6/concat_mailnew.js and change the following lines:

Replace

plugins : "inlinepopups",

with

plugins : "inlinepopups,spellchecker",

Replace:

theme_advanced_buttons2 : (editorEnabled ? "cut,copy,paste,|,bullist,numlist,|,outdent,indent,|,undo,redo,|,image,link,unlink,|,hr,|,charmap" : "") ,

with

theme_advanced_buttons2 : (editorEnabled ? "cut,copy,paste,|,bullist,numlist,|,outdent,indent,|,undo,redo,|,image,link,unlink,|,hr,|,charmap,|,spellchecker" : "") ,

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
        // 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]';
        $config['PSpellShell.tmp'] = '/tmp';

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