Note: You are currently viewing documentation for Moodle 3.7. Up-to-date documentation for the latest stable version of Moodle may be available here: plugins/filter wiris.

plugins/filter wiris: Difference between revisions

From MoodleDocs
No edit summary
Line 14: Line 14:
==Description ==
==Description ==


If you install the WIRIS Plugin for Moodle you will add to the Moodle editor ( Atto or TinyMCE depending on the Moodle version you are using) a fully WYSIWYG for scientific expressions (WIRIS EDITOR) and, optionally, an advanced calculator tool (WIRIS CAS). Enabled editing to STEM related topics (Science, Technology, Engineering and Mathematics).  
If you install the WIRIS Plugin for Moodle you will add to the Moodle editor (Atto or TinyMCE depending on the Moodle version you are using) a fully WYSIWYG editor for scientific expressions (WIRIS EDITOR) and, optionally, an advanced calculator tool (WIRIS CAS). Enabled editing to STEM related topics (Science, Technology, Engineering and Mathematics).  


WIRIS plugin for Moodle 2.X & Moodle 3.X contains two different components that '''should''' be separately downloaded and installed:  
WIRIS plugin for Moodle 2.X & Moodle 3.X contains two different components that '''should''' be separately downloaded and installed:  
Line 20: Line 20:
1- The [https://moodle.org/plugins/filter_wiris WIRIS filter] (this filter must be enabled at the end of the process)  
1- The [https://moodle.org/plugins/filter_wiris WIRIS filter] (this filter must be enabled at the end of the process)  


2- The [https://moodle.org/plugins/atto_wiris WIRIS plugin for Atto] / [https://moodle.org/plugins/tinymce_tiny_mce_wiris WIRIS plugin for TinyMCE] - Depending on your Moodle version and configuration you may install the WIRIS plugin for ATTO editor or a configured version of the WIRIS plugin for TinyMCE
2- The [https://moodle.org/plugins/atto_wiris WIRIS plugin for Atto] / [https://moodle.org/plugins/tinymce_tiny_mce_wiris WIRIS plugin for TinyMCE] - Depending on your Moodle version and configuration you may install the WIRIS plugin for ATTO editor or a configured version of the WIRIS plugin for TinyMCE




Line 32: Line 32:


[https://moodle.org/plugins/filter_wiris WIRIS plugin filter ] for Moodle is a Moodle filter.
[https://moodle.org/plugins/filter_wiris WIRIS plugin filter ] for Moodle is a Moodle filter.
First of all It is '''necessary''' to have it installed to use the WIRIS Editor.  
To begin, it is '''necessary''' to have it installed to use the WIRIS Editor.  


Filter Installation:
Filter Installation:
*[https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip Download the filter package]
*https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip Download the filter package]
*copy the content of the [https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip package ] into the folder 'filter' under the root of Moodle.
*copy the contents of [https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip package ] into the folder 'filter' under the root of Moodle.


==WIRIS plugin installation for Atto (Moodle 2.7 and higher)==
==WIRIS plugin installation for Atto (Moodle 2.7 and higher)==
Line 43: Line 43:


*[https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip Download the WIRIS plugin package]
*[https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip Download the WIRIS plugin package]
*Copy the content of the [https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip package] into lib\editor\atto\plugins, under the root of Moodle.
*Copy the contents of [https://moodle.org/plugins/download.php/12503/atto_wiris_moodle31_2016102800.zip package] into lib\editor\atto\plugins, under the root of Moodle.


If everything is working properly, once you access your Moodle as Administrator, you will see something similar as the following image - both complements, the filter and the plugin, ready to be installed.   
If everything is working properly, once you access your Moodle as Administrator, you will see something similar to the following image - both components, the filter and the plugin, are ready to be installed.   




[[{{ns:file}}:upgrade database.png|800px|Plugins to be updated]]
[[{{ns:file}}:upgrade database.png|800px|Plugins to be updated]]


Once we click on "Upgrade Moodle database now", automatically the following page will appear, where you will be able to enable the Chemistry editor and the Calculator ( the Math editor is always enabled by default).
Once we click on "Upgrade Moodle database now", the following page will appear automatically, where you will be able to activate the Chemistry editor and the Calculator (the Math editor is always enabled by default).


[[{{ns:file}}:new settings.png|800px|enable page]]
[[{{ns:file}}:new settings.png|800px|enable page]]




=== Enable/disable Chemistry editor ad Calc===
=== Enable/disable Chemistry editor and Calc===
 
There is a Settings section of the plugin where you can enable/disable each editor. Login as administrator and go to '''Settings>Site administration>Plugins>Filters>Math & Science by WIRIS'''. Here you could enable or disable the components.


There is a Settings section of the plugin where you can enable/disable each editor. Login as administrator and go to '''Settings>Site administration>Plugins>Filters>Math & Science by WIRIS'''. Here you can enable or disable the components.


[[{{ns:file}}:enable_disable.png|800px|Enable components]]
[[{{ns:file}}:enable_disable.png|800px|Enable components]]
Line 69: Line 68:




{{Note|This is VERY IMPORTANT, use the arrow in the "order" column to place the filter in the first position of the list. In order to prevent problems, WIRIS filter must be the first in the list. It must be, at least, placed before "Convert URLs into links and images"!}}
{{Note|This is VERY IMPORTANT, use the arrow in the "order" column to place the filter in the first position of the list. In order to prevent problems, WIRIS filter should be the first in the list. In any case it must be, at least, placed before "Convert URLs into links and images"!}}
If you have followed the steps, you'll see something similar to the following image.  
If you have followed the steps, you'll see something similar to the following image.  


Line 79: Line 78:
The best way to check that all is OK is just to create a formula, save and display it.
The best way to check that all is OK is just to create a formula, save and display it.


Additionally there is an info page at http://<moodle>/filter/wiris/info.php. In any issue, please send screenshots of that to support.
Additionally there is an info page at http://<moodle>/filter/wiris/info.php. In case of any issue, please send screenshots and a description to support.




Line 91: Line 90:




Starting from Moodle 2.4 WIRIS plugin for TinyMCE is a standard Moodle plugin. To install it just copy the tiny_mce_wiris directory into lib\editor\tinymce\plugins under the root of moodle.
Starting from Moodle 2.4, WIRIS plugin for TinyMCE is a standard Moodle plugin. To install it just copy the tiny_mce_wiris directory into lib\editor\tinymce\plugins under the root of moodle.

Revision as of 16:15, 3 November 2016


Description

If you install the WIRIS Plugin for Moodle you will add to the Moodle editor (Atto or TinyMCE depending on the Moodle version you are using) a fully WYSIWYG editor for scientific expressions (WIRIS EDITOR) and, optionally, an advanced calculator tool (WIRIS CAS). Enabled editing to STEM related topics (Science, Technology, Engineering and Mathematics).

WIRIS plugin for Moodle 2.X & Moodle 3.X contains two different components that should be separately downloaded and installed:

1- The WIRIS filter (this filter must be enabled at the end of the process)

2- The WIRIS plugin for Atto / WIRIS plugin for TinyMCE - Depending on your Moodle version and configuration you may install the WIRIS plugin for ATTO editor or a configured version of the WIRIS plugin for TinyMCE


Requirements

  • mbstring extension must be installed and enabled in the server.
  • There must be no errors in http://<moodle>/admin/environment.php


WIRIS filter installation (required)

WIRIS plugin filter for Moodle is a Moodle filter. To begin, it is necessary to have it installed to use the WIRIS Editor.

Filter Installation:

WIRIS plugin installation for Atto (Moodle 2.7 and higher)

Plugin Installation:

If everything is working properly, once you access your Moodle as Administrator, you will see something similar to the following image - both components, the filter and the plugin, are ready to be installed.


Plugins to be updated

Once we click on "Upgrade Moodle database now", the following page will appear automatically, where you will be able to activate the Chemistry editor and the Calculator (the Math editor is always enabled by default).

enable page


Enable/disable Chemistry editor and Calc

There is a Settings section of the plugin where you can enable/disable each editor. Login as administrator and go to Settings>Site administration>Plugins>Filters>Math & Science by WIRIS. Here you can enable or disable the components.

Enable components

Enable WIRIS Filter

To enable the WIRIS plugin for Moodle, login as administrator and enable the filter:

  • go to Settings>Site administration>Plugins>Filters>Manage filters. You will see the WIRIS filter at the end of the list.
  • Open the drop down menu on the "Active?" column and select "ON"


Note: This is VERY IMPORTANT, use the arrow in the "order" column to place the filter in the first position of the list. In order to prevent problems, WIRIS filter should be the first in the list. In any case it must be, at least, placed before "Convert URLs into links and images"!


If you have followed the steps, you'll see something similar to the following image.


Enable filter

Check that everything is OK

The best way to check that all is OK is just to create a formula, save and display it.

Additionally there is an info page at http://<moodle>/filter/wiris/info.php. In case of any issue, please send screenshots and a description to support.


Info WIRIS installation

WIRIS plugin INSTALLATION for TinyMCE (until Moodle 2.6)

Note: This is VERY IMPORTANT, you only need to follow this step if you have a Moodle 2.6 or below or if for some reason you are using a TinyMCE Editor in a new version of Moodle. In this case you must follow the first and second steps of this documentation and jump here


For Moodle 2.4 and higher

Starting from Moodle 2.4, WIRIS plugin for TinyMCE is a standard Moodle plugin. To install it just copy the tiny_mce_wiris directory into lib\editor\tinymce\plugins under the root of moodle.