Print version
  Products   wiris.com 
Products » Formula and CAS plugins » TinyMCE plugin


WIRIS Formula Editor
Formula and CAS plugins
WIRIS Desktop
WIRIS CAS
WIRIS Quizzes
 
tinyMCE WIRIS Plugin integration

1        tinyMCE WIRIS Plugin integration

1.1      Download files

Available packages:

 

Note: you should have a valid license to install the plugin in a production environment; otherwise, you can use the downloaded file just for demo purposes. To acquire the full rights license, please contact to info@wiris.com or visit www.wiris.com.

1.2      Copying 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).

1.2.1      For PHP servers

Because the plugin needs server scripting support, we provide a solution based on PHP (which could be rewritten to any desired scripting language). To use our PHP integration files, you must give execution right to the web server user on the PHP files contained at tiny_mce/plugins/tiny_mce_wiris/integration. Now, 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 (it will be used to store formula MathML codes and temporal images).

1.2.2      For ASP.NET servers

Because the plugin needs server scripting support, we provide a solution based on ASP.NET (which could be rewritten to any desired scripting language). To use our ASP.NET integration files, you must create an application through your IIS control panel with root directory at tiny_mce/plugins/tiny_mce_wiris/integration. Now, 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 (it will be used to store formula MathML codes and temporal images). How to create applications: http://support.microsoft.com/kb/172138

1.2.3      As Java servlet

Because the plugin needs server scripting support, we provide a solution based on Java servlets (which could be rewritten to any desired scripting language). To use our Java integration files, follow these steps:

  1. Install the pluginwiris_engine.war in your Java web applications server (tomcat).
  2. Edit the WEB-INF/web.xml and set the params cacheDirectory and formulaDirectory. cacheDirectory is the directory where your temporal formula images will be stored. formulaDirectory is the directory where your formula will be stored (as xml files). You must create both directories. The servlet should have write rights on both directories.
  3. 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.

1.3      Configure

1.3.1      On PHP and ASP.NET integrations

Edit tiny_mce/plugins/tiny_mce_wiris/configuration.ini to set your own values. The table below specifies all possible parameters.

1.3.2      On Java integration

Edit the WEB-INF/pluginwiris/configuration.ini file to set your own values. The table below specifies all possible parameters.

 

Key

Description

Default value

Possible values

wirisimageservicehost(1)

Specifies formula image server host.

services.wiris.net

 

wirisimageserviceport

Specifies formula image server port.

80

 

wirisimageservicepath

Specifies formula image server path.

/formula/render

 

wirisimagebgcolor

Specifies formula background color.

#FFFFFF

 

wiristransparency

Specifies whether formula background must be transparent.

true

true, false

wirisimagesymbolcolor

Specifies formula foreground color.

#000000

 

wirisimagefontsize

Specifies formula font size.

16

 

wirisformulaeditorcodebase(1)

Specifies where is your formula editor applet codebase.

http://services.wiris.net/formula/codebase/

 

wirisformulaeditorarchive

Specifies the formula editor applet file name.

wiriseditor.jar

 

wirisformulaeditorcode

Specifies main formula editor applet class.

WirisFormulaEditor

 

wirisformulaeditorlang

Specifies main formula editor language.

en

ar, ca, de, es, et, en, eu, fr, gl, it, nl, pt, zh

wiriscascodebase(1)

Specifies where is your CAS applet codebase.

http://www.wiris.net/wiris/wiris-codebase/

 

wiriscasarchive(1)

Specifies the CAS applet file name.

wrs_net_en.jar

 

wiriscasclass(1)

Specifies main CAS applet class.

WirisApplet_net_en

 

CAS_width

Specifies the default CAS applet width.

450

 

CAS_height

Specifies the default CAS applet height.

400

 

wirisproxy

Specifies if your server is using a proxy connection or not.

false

true, false

wirisproxy_host

If wirisproxy is true, this value specifies the proxy host.

 

 

wirisproxy_port

If wirisproxy is true, this value specifies the proxy port.

 

 

(1) The WIRIS plugin needs to access an external server to get additional resources (formula editor applet, image service and WIRIS CAS). See architecture for more information. The default configuration connects to services.wiris.com to get such services. However, you might consider acquiring a production access. Under certain circumstances it is possible to install all necessary services in the customer server (not only the plugin).

Advanced:

You can also modify other values in javascript environment. Open tiny_mce/plugins/tiny_mce_wiris/editor_plugin.js and read the first few lines.

1.4      Activate the tinyMCE WIRIS Plugin 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

1.5      Clean and backup your tinyMCE WIRIS Plugin installation

There are two important directories:

  • Cache directory: tiny_mce/plugins/tiny_mce_wiris/cache
  • Formula directory: tiny_mce/plugins/tiny_mce_wiris/formulas

 

On Java integration, these paths are provided by you on the WEB-INF/web.xml file.

1.5.1      Freeing disk space: cleaning the image cache folder

If you want to free your disk space, you can empty the cache directory (remember: don’t delete the directory, only remove its contents).

This directory will be repopulated when users view the formulas.

1.5.2      Migrating your web server

If you want to migrate your web server, and you want to backup your formula images, you must migrate also the formula directory.

This directory contains the MathML of your web site formula images. If these files are removed, you will lose your formulas. Note that the MathML is still stored in the <IMG> tag but it is useless.