Installation instructions: WIRIS plugin for CKEditor

DOWNLOAD

1 Requirements

• CKEditor 3.0 or higher installed.
• CKEditor 4.0 or higher must be in Stardard editor mode. Inline editing mode support will be available soon.
• A valid license to install the plugin in a production environment; otherwise, you can use the downloaded file just for demo purposes.

2 Copy files

Unzip the CKEditor WIRIS Plugin and copy the ckeditor_wiris directory into your CKEditor plugins directory. For example, you will have ckeditor/plugins/ckeditor_wiris . The name of the WIRIS plugin directory must be ckeditor_wiris.

2.1 For PHP servers

1. Give execution rights to the web server user on the PHP files contained at to ckeditor/plugins/ckeditor_wiris/integration.
2. Give write permissions to ckeditor/plugins/ckeditor_wiris/cache and to ckeditor/plugins/ckeditor_wiris/formulas directories to the web server user. Those folders will be used to store formula MathML codes and temporal images.

2.2 For ASP.NET servers

1. Create an application through your IIS control panel with root directory at to ckeditor/plugins/ckeditor_wiris/integration.
2. Give write permissions to ckeditor/plugins/ckeditor_wiris/cache and to ckeditor/plugins/ckeditor_wiris/formulas directories to the web server user. Those folders will be used to store formula MathML codes and temporal images.

2.3 For ASP servers

1. Give write permissions to ckeditor/plugins/ckeditor_wiris/cache and to ckeditor/plugins/ckeditor_wiris/formulas directories to the web server user. Those folders will be used to store formula MathML codes and temporal images.

2.4 As Java servlet

1. Install the pluginwiris_engine.war in your Java web applications server. For example, tomcat.
2. By default, the javascript code loads the pluginwiris_engine from the root of web application server (/pluginwiris_engine/app). However, if you want to store the pluginwiris_engine in another path, you should edit these javascript codes.
   1. Open ckeditor/plugins/ckeditor_wiris/plugin.js.
   2. Change the variables _wrs_conf_editorPath, _wrs_conf_CASPath, _wrs_conf_createimagePath and _wrs_conf_createcasimagePath with your preferred values.
   3. Save changes.

3 Configure

3.1 On PHP, ASP.NET and ASP integrations

Edit ckeditor/plugins/ckeditor_wiris/configuration.ini to set your own values. This table specifies all possible parameters.

3.2 On Java integration

Edit WEB-INF/pluginwiris/configuration.ini to set your own values. This table specifies all possible parameters.

It is essential to establish the value of the parameters wiriscachedirectory and wirisformuladirectory.

4 Include WIRIS plugin for CKEditor on your own platform

You must include some content on your CKEditor configuration file ckeditor/config.js (see CKEditor documentation).

4.1 For CKEditor 3

The result should be like this:

/*
Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
For licensing, see LICENSE.html or http://ckeditor.com/license
*/
CKEDITOR.editorConfig = function( config )
{
    // Add WIRIS to the plugin list
    config.extraPlugins += (config.extraPlugins.length == 0 ? '' : ',') + 'ckeditor_wiris';

    // Add WIRIS buttons to the "Full toolbar"
    // Optionally, you can remove the following line and follow
    // http://docs.cksource.com/CKEditor_3.x/Developers_Guide/Toolbar
    config.toolbar_Full.push({ name: 'wiris', 
    items : [ 'ckeditor_wiris_formulaEditor', 'ckeditor_wiris_CAS' ]});
};

Note: if you have a configured custom toolbar, you must add ['ckeditor_wiris_formulaEditor', 'ckeditor_wiris_CAS'] buttons where you want (see http://docs.cksource.com/CKEditor_3.x/Developers_Guide/Toolbar).

4.2 For CKEditor 4

The result should be like this:

/*
Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
For licensing, see LICENSE.html or http://ckeditor.com/license
*/
CKEDITOR.editorConfig = function( config )
{
    // Add WIRIS to the plugin list
    config.extraPlugins += (config.extraPlugins.length == 0 ? '' : ',') + 'ckeditor_wiris';
};

5 Check that the plugin works correctly

In order to check if the plugin is installed correctly, there is a page that makes some tests on your server. Open this link to see where is your test page.

6 Clean and backup your WIRIS plugin for CKEditor

Check this page.