Configuration table

Server configuration file (configuration.ini)

Each integration has the configuration.ini file in a different place depending on backend technology. Check this table to find your file.

Technology

Location

PHP

<pluginRoot>/configuration.ini

ASP.net

<pluginRoot>/configuration.ini

Java

<pluginwiris_engine.war>/WEB-INF/pluginwiris/configuration.ini

Ruby on Rails

<wirispluginengine gem path>/configuration.ini

configuration.ini table

Table 1. Connection properties

Key

Description

Default value

Possible values

wirisimageserviceprotocol

Specifies formula image server protocol. If left blank, it is computed automatically

https

http, https

wirisimageservicehost

Specifies formula image server host.

www.wiris.net

wirisimageserviceport

Specifies formula image server port. If left blank, it is computed automatically

(number)

wirisimageservicepath

Specifies formula image server path.

/demo/editor/render



Table 2. Proxy properties

Key

Description

Default value

Possible values

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.

wirisproxy_user

If wirisproxy is true, this value specifies the proxy user (if needed).

wirisproxy_password

If wirisproxy is true, this value specifies the proxy password (if needed).



Table 3. Folder properties

Key

Description

Default value

Possible values

wiriscachedirectory

Storage location for cache images

/var/cache/

wirisformuladirectory

Storage location for formula files

/var/formulas/



Table 4. Content properties

Key

Description

Default value

Possible values

wiriseditorsavemode

Specifies the format of the saved formulas

xml

xml, image, base64, safexml

wiriseditorparsexml

Specifies if the MathML should be parsed on non MathML modes (image or base64)

false

true,false

wiriseditorbase64savemode

Specifies if in base64 save mode, data should be stored as a base64 string or as an image

default

default, image

wirissavehandtraces

Specifies if the code of Hand traces should be stored

false

true,false

wiriseditorparselatex

If set to true, LaTeX is stored in the database as MathML with a LaTeX annotation.

true

true, false



Table 5. Image properties

Key

Description

Default value

Possible values

wirisimageformat

Specifies image format

svg

svg, png

wiriseditormathmlattribute

Specifies the image attribute to store mathml content

data-mathml

wirisaccessibilityenabled

Specifies if the accesibility should be included in generated images as "alt" attribute

true

true,false



Table 6. Editor properties

Key

Description

Default value

Possible values

wiriseditorenabled

Specifies if MathType is enabled

true

true, false

wirischemeditorenabled

Specifies if ChemType is enabled

true

true, false

wiriseditorwindowattributes

Specifies the editor size

width=570, height=450, scroll=no, resizable=yes

wiriseditormodalwindowfullscreen

Specifies if the modal window should be opened in full-screen mode

false

true, false

wiriseditorparameters

MathType can be initialized with different variables, in JSON format.

{}

See list of parameters



Table 7. Cross-Domain policies

Key

Description

Default value

Possible values

wiriscorsenabled

Enables CORS

false

true, false

wirisexternalplugin

Specifies if the plugin is an external plugin

false

true, false



Table 8. Performance settings

Key

Description

Default value

Possible values

wirispluginperformance

Specifies if the image service response should be a JSON instead of a binary, which allows for requests to be cached

true

true, false



Table 9. Cache settings

Key

Description

Default value

Possible values

wiriscleancachegui

Specifies if the delete cache GUI is enabled.

false

true, false

wiriscleancachetoken

Specifies the token to delete the cache using the GUI



Table 10. Class overridables

Key

Description

Default value

Possible values

wirisstorageclass

Specifies the name of the class that manages the storage of formulas

com.wiris.plugin.storage.CustomStorageAndCache

wirisconfigurationclass

Specifies the name of the class that updates the loaded configuration

com.wiris.plugin.configuration.CustomConfiguration

wirisaccessproviderenabled

Specifies if the access provider class is enabled

false

true, false

wirisaccessproviderclass

Specifies the name of the class that manages the Access provider



Configuration using .NET Web.config

From version 3.50.0 you can alternatively add your custom configuration using your project Web.config file instead of creating a configuration.ini file using the following format:

  <appSettings>
    <add key="com.wiris.plugin.<configuration-key>" value="<configuration-value>"/>
  </appSettings>

Configuration using Java web.xml

From version 3.50.0 you can alternatively add your custom configuration using your project web.xml file instead of creating a configuration.ini file using the following format:

  <context-param>
    <param-name>com.wiris.plugin.<configuration-key></param-name>
    <param-value><configuration-value></param-value>
  </context-param>