1 CKEditor WIRIS Plugin integration

1.1 Download files

Available packages:

CKEditor WIRIS Plugin (for PHP servers, for ASP.NET servers, as Java servlet): a CKEditor plugin ready to be installed on your CKEditor. It provides WIRIS Formula Editor and WIRIS CAS.
Live demo (running on a PHP server, running on an ASP.NET server, running as Java servlet): small demonstration of the plugin installation.
Live demo package (for PHP servers, for ASP.NET servers, as Java servlet): the live demo package ready to be downloaded.

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

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 rights to the web server user on the PHP files contained at to ckeditor/plugins/ckeditor_wiris/integration. Now, give write permissions to ckeditor/plugins/ckeditor_wiris/cache and to ckeditor/plugins/ckeditor_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 to ckeditor/plugins/ckeditor_wiris/integration. Now, give write permissions to ckeditor/plugins/ckeditor_wiris/cache and to ckeditor/plugins/ckeditor_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:

Install the pluginwiris_engine.war in your Java web applications server (tomcat).
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.
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.

Open ckeditor/plugins/ckeditor_wiris/plugin.js.
Change the variables _wrs_conf_editorPath, _wrs_conf_CASPath, _wrs_conf_createimagePath and _wrs_conf_createcasimagePath with your preferred values.
Save changes.

1.3 Configure

1.3.1 On PHP and ASP.NET integrations

Open to ckeditor/plugins/ckeditor_wiris/configuration.ini to set your own values. This table 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⁽¹⁾	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⁽¹⁾	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⁽¹⁾	Specifies where is your CAS applet codebase.	http://www.wiris.net/wiris/wiris-codebase/
wiriscasarchive⁽¹⁾	Specifies the CAS applet file name.	wrs_net_en.jar
wiriscasclass⁽¹⁾	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.

⁽¹⁾ 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 to ckeditor/plugins/ckeditor_wiris/plugin.js and read the first few lines.

1.4 Include CKEditor WIRIS Plugin on your own platform

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

The result should be like this (new content is marked in green):

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(['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).

1.5 Clean and backup your CKEditor WIRIS Plugin installation

There are two important directories:

Cache directory: ckeditor/plugins/ckeditor_wiris/cache
Formula directory: ckeditor/plugins/ckeditor_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.