Products » WIRIS Plugins » Documentation

Installation instructions: WIRIS plugin for NicEdit

 

 

DOWNLOAD

1 Requirements

  • NicEdit 0.9 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 NicEdit WIRIS Plugin and copy the nicedit_wiris directory in any directory of your web server. For example, in nicedit/nicedit_wiris.

2.1 For PHP servers

  1. Give execution right to the web server user on the PHP files contained at nicedit/nicedit_wiris/integration.
  2. Give write permissions to nicedit/nicedit_wiris/cache and nicedit/nicedit_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 nicedit/nicedit_wiris/integration.
  2. Give write permissions to nicedit/nicedit_wiris/cache and nicedit/nicedit_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 nicedit/nicedit_wiris/cache and nicedit/nicedit_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 nicedit/nicedit_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 nicedit/nicedit_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 NicEdit on your own platform

In order to use WIRIS in NicEdit, you only have to add this HTML code after including the NicEdit script:

<script type="text/javascript">var nicedit_wiris_path = '[nicedit_wiris path]';</script>
<script type="text/javascript" src="[nicedit_wiris path]/core/core.js"></script>
<script type="text/javascript" src="[nicedit_wiris path]/nicedit_wiris.js"></script>

For example:

<script type="text/javascript" src="nicedit/nicEdit.js"></script>
<script type="text/javascript">var nicedit_wiris_path = 'nicedit/nicedit_wiris';</script>
<script type="text/javascript" src="nicedit/nicedit_wiris/core/core.js"></script>
<script type="text/javascript" src="nicedit/nicedit_wiris/nicedit_wiris.js"></script>

Finally, you have to instantiate the NicEdit editors with the fullPanel parameter setted to true.

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 NicEdit

Check this page.