This is a simple text input widget that lets users edit one line of input with superscripts and subscripts, for use in Moodle.
Install from the Moodle plugins database https://moodle.org/plugins/editor_ousupsub.
Or you can install using git. Type this commands in the root of your Moodle install git clone git://github.com/moodleou/moodle-editor_ousupsub.git lib/editor/ousupsub echo '/lib/editor/ousupsub/' >> .git/info/exclude
Then run the moodle update process Administration > site administration > notifications
This editor was created by Colin Chambers of the Open University http://www.open.ac.uk/.
The code for this editor was heavily inspired by the Atto editor built into Moodle.
It was created for use with several of our question types:
- https://moodle.org/plugins/qtype_pmatch
- https://moodle.org/plugins/qtype_varnumeric
- https://moodle.org/plugins/qtype_varnumericset
- https://moodle.org/plugins/qtype_varnumunit
The purpose of this editor is to make it as easy as possible for users to intput text with superscripts and/or subscripts, while keeping things as simple as possible and keeping the results HTML as clean as possible.
- Allow only alphanumeric text. No html tags except and
- Provide a superscript or subscript button or both along with related functionality
- Prevent nesting of superscript and subscript tags
- No text wrapping is allowed along with no paragraphs. Everything is on one line
- Configurable height and width of editor
- Editor can be placed where required including inline with text
If the editor is used inline, for example in a paragraph of text, then the text inside the text area should be baseline-aligned with the surrounding content. However, this only works if the surrounding text is styled not to extremely. We only support the alignment working if you are using with several of our question types:
- https://moodle.org/plugins/qtype_pmatch
- https://moodle.org/plugins/qtype_varnumeric
- https://moodle.org/plugins/qtype_varnumericset
- https://moodle.org/plugins/qtype_varnumunit
- https://moodle.org/plugins/qtype_combined (Only work if the surrounding text is styled not to extremely)
Automated testing is through behat and custom javascript unit tests.
The editor will work any where moodle editors work but it's designed to be used with specific OU question types The main places to test are:
- pattern match questions (OU specific question type)
- variable numeric questions (OU specific question type)
To understand exactly what this editor will and will not do it's best to understand the HTML it will or will not allow. That is described in the behat tests at tests/behat/ousupsub.feature. You do not need to understand web development to understand these tests and you don't have to be able to run them either.
Here is a simple example we tell the browser what to do. Select the whole of the word "subscript". In behat we write # Apply subscript When I select the range "'',16,'',25" in the "Description" ousupsub editor
Then we ask the brower to apply subscript to the word we have selected And I click on "Subscript" "button"
Then we check that subscript was applied correctly. Then I should see "Superscript and Subscript" in the "Description" ousupsub editor
That is how you read the behat tests and how you know what to expect the editor to do.