×

Documentation page

28 Mar 2017

Some rich text editors, such as CKeditor or TinyMCE, allow you to specify a URL based location of plugins outside of the normal plugins directory.

This option is useful when loading the rich text editor from a CDN or when you want to have the editor directory separate from your custom plugins. In case you are using your a programing language for which WIRIS plugins are not available this is also a good option.

You can install WIRIS plugin as an external plugin in CKeditor and TinyMCE. Using this option you do not need to install any WIRIS component on your servers. You only need to add one line to your CKeditor or TinyMCE configuration.

CKeditor

  • CKEDITOR.plugins.addExternal('ckeditor_wiris', 'https://www.wiris.net/demo/plugins/ckeditor/', 'plugin.js');
     
  • Include WIRIS EDITOR buttons in CKEditor's toolbar:  
    • config.toolbar_Full.push({ name: 'wiris', items : [ 'ckeditor_wiris_formulaEditor','ckeditor_wiris_formulaEditorChemistry']);

TinyMCE

  • external_plugins: { tiny_mce_wiris: 'https://www.wiris.net/demo/plugins/tiny_mce/plugin.js' }
     
  • Include WIRIS EDITOR buttons in your TinyMCE button list, the button keys are the following:
    • tiny_mce_wiris_formulaEditor
    • tiny_mce_wiris_formulaEditorChemistry
20 Mar 2017

DOWNLOAD

1 Requirements

  • Fraoala Editor v.2.0.0 or higher instaled.
  • Froala Image plugin should be enabled.
  • 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 Froala WIRIS Plugin and copy the wiris directory into your Froala plugins directory. For example, you will have froala/js/plugins/wiris. The name of the WIRIS plugin directory must be wiris.

2.1 For PHP servers

  1. Give execution rights to the web server user on the PHP files contained at to froala/js/plugins/wiris/integration.
  2. Give write permissions to froala/js/plugins/wiris/integration/cache and to cfroala/js/plugins/wiris/integration/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 froala/js/plugins/wiris. If, given your project requirements or architecture, you need to have only one application move /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 froala/js/plugins/wiris/integration/cache and to froala/js/plugins/wiris/integration/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 froala/js/plugins/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 Include WIRIS plugin for FROALA on your own platform

  • Include wiris.js javascript file: $('head').append('<script src="froala/js/plugins/wiris/wiris.js"></script>');
  • Add WIRIS EDITOR Math and WIRIS EDITOR chemistry buttons to toolbar: toolbarButtons: [''wirisEditor', 'wirisChemistry'].
  • Add WIRIS EDITOR Math and WIRIS EDITOR chemistry buttons to image toolbar: imageEditButtons: ['wirisEditor', 'wirisChemistry'].
  • Modify Froala allowed tags: htmlAllowedTags:   ['.*']

4.1 Integration example:

('#example').froalaEditor({
      iframe: true,
       // Add WIRIS EDITOR buttons to Image Toolbar.
      imageEditButtons: ['wirisEditor', 'wirisChemistry', 'imageDisplay', 'imageAlign', 'imageInfo', 'imageRemove'],
       // Add WIRIS EDITOR buttons to Toolbar.
      toolbarButtons: ['undo', 'redo' , 'bold', '|', 'wirisEditor', 'wirisChemistry','clear', 'insert'],
      // Allowed tags
      htmlAllowedTags:   ['.*'],
      htmlAllowedAttrs: ['.*'], 
    });

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.

27 Oct 2015

DOWNLOAD

Oxygen XML Web Author 19.x

1 Requierements

  1. Oxygen XML Web Author 19.x Installed
  2. A valid license to install the plugin in a production environment; otherwise, you can use the downloaded file just for demo purposes.

2 Install WIRIS plugin adding it to the Oxygen XML Web author (method 1)

  1. Go to your Oxygen's Administration Page.
  2. Select Plugins.
  3. Click Add Plugin and choose a plugin file to upload.
  4. Click OK to upload a file. The plugin should appear in the list on this page.
  5. Restart the server.
  6. Enable the plugin on Plugins Oxygen's Administration Page.
  7. For further information see Oxygen's Documentation.

3 Install WIRIS plugin copying the files (method 2)

  1. Stop the Java server.
  2. Unzip Wiris plugin for Oxygen XML inside Oxygen XML plugins.zip file. By default plugins.zip file are on your oxygenwebapp/WEB-INF directory.
  3. Restart the Java sever.

Compatible documents with WIRIS plugin.

Currently WIRIS Plugin for Oxygen is compatible with DITA documents, as well as xhtml, DocBook and JATS. If you want WIRIS Plugin working with another type of document please contact us at support@wiris.com

11 Aug 2015

The WIRIS cas - server components - daemon kernel engine has a few parameters that can be configured which are described here.

A  configuration file named server.ini can be created and placed in the folder server (there is another file under server\com\wiris\server\server.ini that should be kept unmodified because contains the default values). The possible value entries are:

Alignment properties
Key Description Values Default
param.server.
limit_omega_kernels
The maximum number of concurrent processes launched by the daemon. numeric 10
param.server.timeout The maximum number of milliseconds by calculation. The actual invested time by computation depends on the load of the server. numeric 10000
param.server.port The network port where the daemon listens. numeric 31415
param.server.port.
limit_omega_memory_
per_kernel_MiB
Limit of memory consumed by a single kernel process in megabytes. numeric 30