Manual installation of WIRIS plugin for Moodle

DOWNLOAD

This installation should used by advanced users or if the automatic installation doesn’t work.

These instructions are also valid to perform an update.

1 Requirements

• Moodle 1.6 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 Uncompressing the package

Unzip WIRIS Plugin package outside the moodle root directory.

3 Copy files

Copy wiris directory from pluginwiris/install/filter/ to [moodle root]/filter/.

4 Edit files

If the WIRIS plugin is already installed and you are updating it, overwrite the file [moodle root]/lib/weblib.php and name it [moodle root]/lib/weblib.php with the content of the file [moodle root]/lib/weblib.php and name it [moodle root]/lib/weblib.php.old.

If you are performing a new installation, make a copy of  the file [moodle root]/lib/weblib.php and name it [moodle root]/lib/weblib.php.old.

Open [moodle root]/lib/weblib.php and make two changes; one is common, and the other is version dependent.

4.0 Common change

Search this string:

echo print_editor_config($editorhidebuttons);

Then, add after this line the next code:

/**** begin WIRIS Plugin ****/
echo "\nWiris.register(config);\n";
/**** end WIRIS Plugin ****/

Example:

Before:

echo print_editor_config($editorhidebuttons);

if (empty($name)) {

After:

echo print_editor_config($editorhidebuttons);

/**** begin WIRIS Plugin ****/
echo "\nWiris.register(config);\n";
/**** end WIRIS Plugin ****/

if (empty($name)) {

4.1 On moodle 1.6 and 1.7

Now search this string:

$scriptcount++;

Then, add before this line the next code:

/**** start WIRIS plugin ****/
$str .= ($scriptcount < 1) ? '<script type="text/javascript" src="' . $CFG->wwwroot . '/filter/wiris/editor/wrs_plugin.js.php"></script>' . "\n" : '';
/**** end WIRIS Plugin ****/

Example:

Before:

$str .= ($scriptcount < 1) ? '<script type="text/javascript src="' . $CFG->wwwroot . '/lib/editor/htmlarea/lang/en.php"></script>' . "\n" : '';
$scriptcount++;

After:

$str .= ($scriptcount < 1) ? '<script type="text/javascript src="' . $CFG->wwwroot . '/lib/editor/htmlarea/lang/en.php"></script>' . "\n" : '';

/**** start WIRIS plugin ****/
$str .= ($scriptcount < 1) ? '<script type="text/javascript" src="' . $CFG->wwwroot . '/filter/wiris/editor/wrs_plugin.js.php"></script>' . "\n" : '';
/**** end WIRIS Plugin ****/

$scriptcount++;

4.2 On moodle 1.8 or higher

Now search this string:

$scriptcount++;

Then, add before this line the next code:

/**** start WIRIS plugin ****/
$str .= ($scriptcount < 1) ? '<script type="text/javascript" src="' . $CFG->httpswwwroot . '/filter/wiris/editor/wrs_plugin.js.php"></script>' . "\n" : '';
/**** end WIRIS Plugin ****/

Example:

Before:

$str .= ($scriptcount < 1) ? '<script type=”text/javascript src="' . $CFG->httpswwwroot. '/lib/editor/htmlarea/lang/en.php"></script>' . "\n" : '';
$scriptcount++;

After:

$str .= ($scriptcount < 1) ? '<script type=”text/javascript src="' . $CFG->httpswwwroot. '/lib/editor/htmlarea/lang/en.php"></script>' . "\n" : '';

/**** start WIRIS plugin ****/
$str .= ($scriptcount < 1) ? '<script type="text/javascript" src="' . $CFG->httpswwwroot. '/filter/wiris/editor/wrs_plugin.js.php"></script>' . "\n" : '';
/**** end WIRIS Plugin ****/

$scriptcount++;

5 Activate the filter

5.1 On moodle 1.6

On moodle administration block, click on “Configuration”. Then, click on “Filters”. Finally, activate “Wiris” filter as this image:

5.2 On moodle 1.7 or higher

On moodle administration block, click on “Modules” >> “Filters”. Then, activate “Wiris” filter as this image:

6 Configure WIRIS Plugin

Now you can enable or disable WIRIS editor and WIRIS cas from the "Settings" page of the WIRIS plugin.

Also, you can set WIRIS Plugin configuration editing [moodle root]/filter/wiris/wrs_config.php file. This table specifies each parameter:

⁽¹⁾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 de demonstration services at www.wiris.net/demo/ . It is possible to install all necessary services in the customer server (not only the plugin).

7 Clean data

If you want to free your disk space, you can empty the cache directory (remember: don’t delete the directory, only remove its contents). The path to that directory is [moodle data]/filter/wiris

This directory will be repopulated when users view the formulas.