×

Discover

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. mbstring extension must be installed and enabled in the server.
  2. Give execution right to the web server user on the PHP files contained at tiny_mce/plugins/tiny_mce_wiris/integration.
  3. 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. If you prefer, you can configure the location of these folders (see section 3).

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. For versions older than 3.50.0 you need to create the application at tiny_mce/plugins/tiny_mce_wiris/integration. If, given your project requirements or architecture, you need to have only one application move /tiny_mce_wiris/bin contents to the /bin directory of your project and copy the Web.config configuration to your project Web.config. If you use .NET 4.0 or above use the values of Web.config4.0.
  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. If you prefer, you can configure the location of these folders (see section 3).

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. If you prefer, you can configure the location of these folders (see section 3).

2.4 As Java servlet

  1. Install the pluginwiris_engine.war in your Java web applications server. For example, tomcat.
  2. Give write permissions to pluginwiris_engine/cache and to pluginwiris_engine/formulas directories to the web server user. Those folders will be used to store formula MathML codes and temporal images. If you prefer, you can configure the location of these folders (see section 3).

2.5 For Ruby on Rails

  1. Install wirispluginengine gem manually
  2. Specify wirispluginengine gem inside your application's Gemfile.
  3. Mount Wirispluginengine engine into your application's config/routes.rb file, adding the following line: mount Wirispluginengine::Engine => 'wirispluginengine'.
  4. Give write permissions to wirispluginengine-X.Y.Z/cache and to wirispluginengine-X.Y.Z/formulas directories to the web server user. Those folders will be used to store formula MathML codes and temporal images. If you prefer, you can configure the location of these folders (see section 3).

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.

For versions older than 3.50.0 it is essential to set the value of the parameters wiriscachedirectory and wirisformuladirectory.

3.3 On Ruby on Rails (RoR)

Edit configuration.ini file on wirispluginengine gem root directory. This table specifies all possible parameters.

4 Activate the WIRIS plugin for TinyMCE on your own platform

Note: This step may be specific for your platform (i.e: ILIAS).

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_formulaEditorChemistry
  • tiny_mce_wiris_CAS

5 WIRISpugins.js

Add WIRISplugin.js script. You can find more information here.

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

7 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'
});

8 Clean and backup your WIRIS plugin for TinyMCE

Check this page.