Documentation page

27 Oct 2015


Oxygen XML Web Author 18.x

1 Requierements

  1. Oxygen XML Web Author 18.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 file. By default 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 and DocBook. If you want WIRIS Plugin working with another type of document please contact us at

2 Sep 2015

WIRIS hand improves greatly the user experience when using touch devices like tablets and mobiles. With WIRIS hand, you can handwrite the answers of the math exercises writing numbers and formulas easily.

Note. WIRIS hand will be enabled by default in the near future releases of WIRIS quizzes for Moodle and will make this documentation obsolete.

Installing the latest version of WIRIS quizzes

WIRIS hand for Moodle is only available from WIRIS quizzes plugin release 3.35 and further. Download the latest version of WIRIS quizzes for Moodle.

Enabling WIRIS hand at administrator level

These guidelines assume you have WIRIS quizzes and WIRIS plugin for Moodle correctly installed. If not, ask to your Moodle administrator to install such plugins.

To enable WIRIS hand, you would need to have access to the file system where Moodle is copied and installed.

  1. Ensure you have the very last release of WIRIS quizzes.
  2. Go to folder <moodle-files>/question/type/WIRIS QUIZZES/quizzes and rename configuration.ini.dist to configuration.ini.
  3. Then add the following line to the end of configuration.ini
    quizzes.hand.enabled = "true"
  4. To check that WIRIS hand is working, follow the instructions of the next section: using WIRIS hand.

Using WIRIS hand

WIRIS hand is available from the WIRIS short answer question type. At present, you can enable and disable WIRIS hand at question level. There are plans of a smart mode where hand is enabled by default in touch devices.

  1. To create a WRIS short answer question type, select

  2. After filling some fields of the short answer form, press the button to open WIRIS quizzes studio

  3. You will see “WIRIS hand embedded”. Enable it

  4. Now, when you preview the question, you will see WIRIS hand.
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
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
Limit of memory consumed by a single kernel process in megabytes. numeric 30
16 Jul 2015

WIRIS quizzes admits the possibility to add parameters to question algorithms. This may be useful if we want to do several questions about the same mathematical expression, if we want to chain some questions (in the sense that some output from a question is used in the algorithm of the following one) or other uses. It is also useful to translate strings in the algorithm and therefore have a multilanguage question.

This feature is available through the WIRIS quizzes generic integration library. Therefore the author will be able to use this feature only if the platform integration provides a way to do it. And the way it must be used will heavily depend on the integration.

Parameters must be defined in algorithms using the keyword parameter.

For example:

WIRIS CAS algorithm using parameters

Then, once instantiated the question, the platform integration may use the API function QuestionInstance.setParameter to overwrite the values of the parameters. The integration needs to manage where to store and find the actual parameter values for each question instance.

Following the same example, we could have the code in the platform integration:


QuizzesBuilder builder = QuizzesBuilder.getInstance();

Question question = ...

QuestionInstance instance = builder.neWIRIS QUIZZESuestionInstance(question);

instance.setParameter("p1", "<ms>Polinomio lineal</ms>");

instance.setParameter("p2", "<ms>Polinomio no lineal</ms>");

instance.setParameter("p3", "<mrow><mi>x</mi><mo>+</mo><mn>1</mn></mrow>");


When the algorithm evaluates, the values of the parameters defined in the algorithm will be overriden by the values specified by the integration. If some parameters are not specified, the values deined in the algorithm will be used.