Installation instructions: WIRIS plugin for TinyMCE

DOWNLOAD

1 Requirements

  • TinyMCE 2.0 or higher installed.
  • 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 tinyMCE WIRIS Plugin and copy the tiny_mce_wiris directory into your tinyMCE plugins directory. For example, you will have tiny_mce/plugins/tiny_mce_wiris . The name of the WIRIS plugin directory must be tiny_mce_wiris).

2.1 For PHP servers

  1. Give execution right to the web server user on the PHP files contained at tiny_mce/plugins/tiny_mce_wiris/integration.
  2. Give write permissions to tiny_mce/plugins/ tiny_mce_wiris/cache and tiny_mce/plugins/tiny_mce_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 tiny_mce/plugins/tiny_mce_wiris/integration.
  2. Give write permissions to tiny_mce/plugins/ tiny_mce_wiris/cache and tiny_mce/plugins/tiny_mce_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 tiny_mce/plugins/ tiny_mce_wiris/cache and tiny_mce/plugins/tiny_mce_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 tiny_mce/plugins/tiny_mce_wiris/editor_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 tiny_mce/plugins/tiny_mce_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 Activate the WIRIS plugin for TinyMCE on your own platform

You must activate tiny_mce_wiris on your tinyMCE plugin list (see tinyMCE documentation). You can also include these buttons on your tinyMCE button list:

  • tiny_mce_wiris_formulaEditor
  • tiny_mce_wiris_CAS

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 Custom WIRIS properties

The parameters used when creating formulas (font color, background color, transparency...) are defined in the configuration.ini file. However, it is possible, in specific cases, that these values must be overriden ​​at runtime or that there must be two editors with different configurations running at once.

To solve the problem, it offers the possibility to specify settings for the plugin in the TinyMCE initialization.

The following snippet of Javascript code shows the available
parameters and how to set their values​​:

tinyMCE.init({
    ...

    wirisimagebgcolor: '#FFFFFF',
    wirisimagesymbolcolor: '#000000',
    wiristransparency: 'true',
    wirisimagefontsize: '16',
    wirisimagenumbercolor: '#000000',
    wirisimageidentcolor: '#000000',
    wirisformulaeditorlang: 'es'
});

7 Clean and backup your WIRIS plugin for TinyMCE

Check this page.