Note: You are currently viewing documentation for Moodle 2.0. Up-to-date documentation for the latest stable version is available here: DragMath equation editor.

DragMath equation editor: Difference between revisions

From MoodleDocs
m (Text replacement - "class="nicetable"" to "class="wikitable"")
 
(81 intermediate revisions by 6 users not shown)
Line 1: Line 1:
=== WARNING ===
<p class="note">As of Moodle 2.x DragMath is now in Moodle core (you need not install the code if you are running Moodle 2.x.) To use DragMath, you are required to activate the TeX filter and ensure that you have Java installed.</p>
You may want to look in the Math Forum for the latest discussion of SEE (Super Equation Editor, an initial nickname for this effort though the product has far outgrown just an equation editor). SEE is a comprehensive set of Math Plugins Mauno Korpelainen has been developing and are discussed here [[Advanced Maths Tools]] - an "alpha" version of docs for installation and use. If these tools are to your liking they will largely eliminate your need to wrestle with TeX (unless you wish so to do.) And, if you want a full distro of TeX, consider doing a local install of TexLive and cobbling your code to eliminate the need for convert.
===Introduction===
===Introduction===
To quote the W3C [http://www.w3.org/Math/Software/mathml_software_cat_editors.html]:
To quote the W3C [http://www.w3.org/Math/Software/mathml_software_cat_editors.html]:
Line 13: Line 19:
You can see a demo of the DragMath editor [http://www.dragmath.bham.ac.uk/ here].  The DragMath interface is highly intuitive and anyone can be using it productively after a few minutes of trial-and-error.  If you have questions about the editor, there is a short manual [http://www.dragmath.bham.ac.uk/doc/index.html here].
You can see a demo of the DragMath editor [http://www.dragmath.bham.ac.uk/ here].  The DragMath interface is highly intuitive and anyone can be using it productively after a few minutes of trial-and-error.  If you have questions about the editor, there is a short manual [http://www.dragmath.bham.ac.uk/doc/index.html here].


===How the DragMath editor has been integrated with Moodle===
===Using DragMath===
 
DragMath is based on the simple idea that the User who does not know a lot of TeX (pronounced Tech) can still create mathematical formula for publishing. In this case, Moodle is the dispaly agent so the TeX formulae are then rendered to a Moodle screen. This essentially means that with little experience, any Junior High Maths teacher can generate all the formulae they need for most aspects of Maths in Moodle.
[[Category:Mathematics]]
DragMath is integrated with Moodle through a new button on the editor toolbar.  This way, the DragMath editor is available everywhere that you or your students are called upon to enter text.  '''Please note:''' The DragMath editor does not come supplied with Moodle.  You (or your administrator) will have to install it. The following comments are targeted at the single file install,  which has retained the beloved smileys.
 
====Getting Started====
Suppose that you're entering text in the HTML editor and you reach a point where you want to insert a mathematical expression. You want to be able to show the tedxt expression you would use to create an equations as well as the equations itself. Pushing the DragMath button launches the DragMath editor in a small popup window (Note: the first time you do this, there will be a delay of a few seconds due to applet initialization). 
 
====Create the math expression in DragMath====
Drag the various graphic constituents of your equation into the construction area until the equation is to your satisfaction.
 
====Save the expression====
From the Menu Bar click File->Save As or click on the floppy icon.  Provide a local location where you want to save the equation and the applet stores the equation there in a .dgrm file.
 
====Select Export Format====
From the Menu Bar click Options->Set Export Format.  If you want to insert the text expression for a tex formula,  select LaTex. If you wish to insert the text expression with the doubledollar toeksn so that the expression will be converted by the moodle tex filter,  select MoodleTex (this will likely be the default choice in your applet).  If you have replaced your tex filter with the ASCIIMathML filter,  select ASCIIMathML.
 
====Insert the expression====
Click the "Insert button" and you're done.  The editor will disappear and the output you selected will be inserted. If you chose MoodleTex, the LaTeX expression (with $$ delimiters added at both ends) will be inserted into your text at the current cursor position. Note the screen shot below. This demonstrates the results when you have selected MoodleTex to insert the equation in your work. '''Note ASCIIMathML users:'''  the ASCIIMathML.xml file currently has backtics set as tokens.  You can edit that file to use the auto nomenclature if you choose
 
====Altering Applet Parameters====
In the case of HTMLarea, the applet parameters are set in dlg_ins_dragmath.php which can be found in moodleroot/lib/editor/htmlarea/popups . Should you wish to change the default export format or implement additional parameters after reviewing the DragMath documentation,  please remember to back up a copy of your original file. The various XML export formats,  which you can customize (with care) can be found at moodleroot/lib/editor/htmlarea/plugins/applet/classes/formats and the xml configuration file, Config.xml, in classes.
 
[[Image:Dragmath_instructions.png|DragMath instructions]]
 
===Installing DragMath===
 
Initially, DragMath required separate installation of both the Moodle Integration package and the DragMath package. DragMath has become so popular,  that it is now offered in a simgle zip that includes not only the integration files (at least for htmlarea for the present) but the integration files as well. For the user this means that one can simply download one zip file, place it in the moodle root and unzip.
 
However,  in as much as there are innumerable installations of DragMath based on the separate install,  installation documents and source information will remain published here for the short term.
 
====Installing DragMath From the Moodle CVS====


This could not be easier.  If you are running verion 1.9.+  [http://download.moodle.org/patches19/dragmath.zip click here] or if you are running Moodle version 1.8.4 or greater but not 1.9.x [http://download.moodle.org/patches18/dragmath.zip click here]
===Creating simple expressions===
and you will start the download of the zip file (at present there are no differences between the two versions.
At this point you can unzip on your workstation and then you can upload the included files to their appropriate locations. This version retains the smileys and includes all integration files and all DragMath files (demos, docs, and  all export formats)  '''Warning:''' At present the zip file includes a version of adminlib.php that should  '''NOT''' be used with Moodle 1.8.2  If you are using 1.8 '''DO NOT''' over write your adminlib.php. Install the rest of the files (other than adminlib.php) and DragMath will work without a problem.


Apparently the Moodle automagically creates the zip with a parent directory of "dragmath".  Should you wish you can unzip the files and then rezip with the top level directory being /lib, and this will allow you to simply upload the zip you just created to your moodle root and unzip there,  and the files will be placed in their appropriate locations. However, please make sure all files are backed up,  and in as much as there are only a few files you may want to manually install even if a zip with  /lib as top directory were provided here just to ensure each file is backed up before installation.
To begin, click on the DragMath insertion button. This opens The DragMath interface.  
Upload the zip file to your Moodle root and unzip.


====Installing DragMath Integration and DragMath Applet Separately====
[[Image:dragmath02.png|thumb|200px|center|Opening Dragmath]]


You install DragMath in two steps
The toolbar is different than you may expect, we are used to nice neat rows of buttons, but Dragmath has to use tabs. Each tab is tab is a collection of "templates", that is each symbol is a "template" and can be dragged and dropped onto the work space.
#Install the DragMath package
#Install the DragMath integration package


'''=====Install the DragMath package ====='''
[[Image:dragmath01.png|thumb|200px|center|The DragMath Interface]]


Download the latest DragMath package from [http://sourceforge.net/projects/dragmath sourceforge] and unzip it in the <code>$CFG->dirroot/lib/editor/htmlarea/popups</code> directory (where <code>$CFG->dirroot</code> is your "moodle" directory as defined in <code>config.php</code>. NOTE there is also a <code>popups</code> directory directly in the editor directory. Don't use that one!).  This will create a new directory under <code>popups</code> called <code>DragMath</code> containing all the necessary DragMath components.
To end editing and insert the script into the Moodle page, click the Insert button. This simple, but not simplistic, interface is a strength of DragMath. It make it easy for even novices to create complex formulae.


'''=====Install the DragMath integration package====='''


'''Important Note:''' These instructions will REPLACE the smiley button on the HTML editor toolbar with the DragMath editor button. This was done to keep the installation instructions simple. If you want to keep your smiley button, see the section at the end of this article.
{| class="wikitable" align="center"
|-
| colspan="4"|'''A sequence for DragMath - click an image to enlarge'''
|-
|[[Image:dragmath04f.png|thumb|150px|Select the Tab with the symbols required]]
|[[Image:dragmath03.png|thumb|150px|Click, hold then drag'n'drop a symbol]]
|[[Image:dragmath04.png|thumb|150px|Enter the values, select an operation symbol]]
|[[Image:dragmath04a.png|thumb|150px|Select another symbol and drag'n'drop]]
|-
|[[Image:dragmath04b.png|thumb|150px|Add an equal (or other) sign]]
|[[Image:dragmath04c.png|thumb|150px|Add in a variable, (chi in this case) ]]
|[[Image:dragmath04d.png|thumb|150px|Click Insert]]
|[[Image:dragmath04e.png|thumb|150px|See the encoded result in the editing dialog.]]
|}


Download the latest DragMath integration package from the [http://moodle.org/mod/data/view.php?id=6009 modules and plugins database].  In the zip archive, you will find two files.
This same sequence of operations apply equally for all formulae, all insertions, no matter how complex they become.  
* <code>dlg_ins_smile.php</code>  -- Copy this file to your <code>$CFG->dirroot/lib/editor/htmlarea/popups</code> directory, overwriting the existing file (you may want to make a copy of the original file before overwriting it)
* <code>em.icon.smile.gif</code> -- Copy this file to your <code>$CFG->dirroot/lib/editor/htmlarea/images</code> directory, overwriting the existing file (you may want to make a copy of the original file before overwriting it)


You must also change two lines in the file <code>$CFG->dirroot/lib/editor/htmlarea/dialog.js</code>
You can insert a template from the toolbar by drag and drop or by a click on the template in the tab, then clicking in the workspace.
* around line 34 you will see the line:
: <code>case "dlg_ins_smile": x = 330; y = 320; break;</code>
Change this line to
: <code>case "dlg_ins_smile": x = 540; y = 340; break;</code>
* around line 47, you will see a line that begins
: <code>var dlg = window.open(url, "ha_dialog", "toolbar=no, menubar=no, ...</code>
Modify this line, changing
: <code>resizable=no</code>
to
: <code>resizable=yes</code>


You might also want to change the mouse over popup from "Insert Smiley" to "Insert Equation".  to do this you need to edit the file
===Creating more complex expressions===
<code>$CFG->dirroot/lib/editor/htmlarea/htmlarea.php </code>
* around line 275 you will see the line:
: <code>case "insertsmile: ["Insert Smiley", "em.icon.smile.gif", false, ...</code>
Change this line to
: <code>case "insertsmile: ["Insert Equation", "em.icon.smile.gif", false, ...</code>


Finally, make sure that the new files and directories you create in the above steps are readable by the Web server. For example, make sure that the em.icon.smile.gif file has the same permissions as other gif files in the images directory.
More complex expressions are pretty much more of the same as above. Creating a simple multiplication table matrix, for example, seems complex,but in DragNath, it is actually simple:


'''=====If you want to keep your smiley button...====='''
{| class="wikitable" align="center"
 
|-
For those users who want to keep their smiley button, there are postings in [http://moodle.org/mod/forum/discuss.php?d=78683 this discussion] that explain how to do it. You may also download a special version of the DragMath integration package [http://educity.hk/dragmath.zip here]. Unzip it in your moodle root directory.
| colspan="4"|'''A sequence for a simple Multiplication Matrice in DragMath - click an image to enlarge'''
|-
|[[Image:dragmath05.png|thumb|150px|Select the Tab and add in the multiplier]]
|[[Image:dragmath05a.png|thumb|150px|Click, hold then drag'n'drop the Matrix symbol]]
|[[Image:dragmath05b.png|thumb|150px|Enter the values, select a equal symbol]]
|[[Image:dragmath05c.png|thumb|150px|Add in the rows required]]
|-
|[[Image:dragmath05d.png|thumb|150px|Add in the columns required]]
|[[Image:dragmath05e.png|thumb|150px|Edit the Matrice ]]
|[[Image:dragmath05f.png|thumb|150px|Add the equal symbol]]
|[[Image:dragmath05g.png|thumb|150px|Add and edit in the second Matrice.]]
|}


===Locally saving and restoring a DragMath expression===
===Locally saving and restoring a DragMath expression===
Line 107: Line 84:


A .drgm file contains three-dimensional representation of your mathematical expression.  It is a binary file that can only be opened by DragMath.
A .drgm file contains three-dimensional representation of your mathematical expression.  It is a binary file that can only be opened by DragMath.
===Additional Editing===
There are times when '''DragMath''' is not going to have a symbol or something you might want. Or perhaps you left something out of the DragMath constuctor, so you want to include it manually. Most likely, for something like the matrix created earlier, I want to go to 15, which means I have to change the structure of the matrix, and edit in some numbers. This is easily done with a little forethought. Copy and paste and delete or edit what you want and do not want.
{| class="wikitable" align="center"
|-
| colspan="4"|'''Manually editing a DragMath construction  - click an image to enlarge'''
|-
|[[Image:dragmath06a.png|thumb|150px|Select, copy and paste the original matrix]]
|[[Image:dragmath06b.png|thumb|150px|Edit to what is actually required]]
|[[Image:dragmath06c.png|thumb|150px|Delete the original matrix]]
|}
Sometimes however, you just want to include something you forgot, or rather, add something that was not there in the first place.
{| class="wikitable" align="center"
|-
| colspan="4"|'''Accurately editing a DragMath construction manually  - click an image to enlarge'''
|-
|[[Image:dragmath06d.png|thumb|150px|Construct the original equation]]
|[[Image:dragmath06e.png|thumb|150px|Copy, then edit to what is actually required]]
|[[Image:dragmath06f.png|thumb|150px|Return to the edited page]]
|}
===See Also===
* [[Advanced Maths Tools]] For an explanation of the SEE tools
* [[Using TeX Notation]] Some ideas and syntax
* [[TeX notation filter]] Turning TeX on
* [http://www.youtube.com/watch?v=mfc7umQ2xLA| A simple YouTube video] Constructing a simple equation.


===Development===
====Square brackets====
Use of text expressions in the Moodle Wiki can create problems when the text expression includes square brackets,  which is how TeX expresses the nth root. Pending a simple wiki based solution users may want to use the ASCIIMathML filter and the ASCIIMathML export format as this combination avoids the use of square brackets. 


====Consistent integration with all html editors====
The Moodle discussion regarding html editors suggests that it will be important for DragMath to have consistent integration with a variety of html editors as htmlarea passes into obsolescence. Plugins for tinyMCE, Xinha and FCKEditor with a similar structure and common codebase are ready and compatible with all browsers that support javascript and Java.


====Additional formats====
Discussion of the transition of DragMath to Moodle core: http://moodle.org/mod/forum/discuss.php?d=125977&parent=551794
There are quite a few options now available for creating text expressions to for displaying equations and moodle functionality can only be increased if tools were able to create and parse expressions created by the tools a user is most comfortable with.  ASCIIMathML is one tool now available as a filter for Moodle that allows the parsing of both TeX and its own ASCIIMathML text expression syntax. Microsoft has now launched its OMML initiative in Office 2007 (see footnotes on  http://en.wikipedia.org/wiki/Office_Open_XML  and OpenOffice employs its own text expression syntax (the OOo syntax is described at http://documentation.openoffice.org/manuals/oooauthors2/0216WG-MathObjects.pdf).
The ability to have DragMath create text expressions that can be used in native documents as well as parsed by filters such as ASCIIMathML will help make use of equations on-line more transparent for everyone.


[[ca:DragMath_editor_d%27equacions]]
[[ca:DragMath_editor_d%27equacions]]

Latest revision as of 15:21, 10 August 2021

WARNING

As of Moodle 2.x DragMath is now in Moodle core (you need not install the code if you are running Moodle 2.x.) To use DragMath, you are required to activate the TeX filter and ensure that you have Java installed.


You may want to look in the Math Forum for the latest discussion of SEE (Super Equation Editor, an initial nickname for this effort though the product has far outgrown just an equation editor). SEE is a comprehensive set of Math Plugins Mauno Korpelainen has been developing and are discussed here Advanced Maths Tools - an "alpha" version of docs for installation and use. If these tools are to your liking they will largely eliminate your need to wrestle with TeX (unless you wish so to do.) And, if you want a full distro of TeX, consider doing a local install of TexLive and cobbling your code to eliminate the need for convert.

Introduction

To quote the W3C [1]:

This is an open-source drag and drop equation editor written in Java.
Once an expression is created the user can convert it into a variety 
of different linear syntax for mathematics, including MathML, LaTeX,
Maple, Maxima or any user defined style.

Created by Christoper Sangwin and Alexander Billingsley at the University of Birmingham as part of the STACK project, DragMath allows students to build mathematical expressions using a graphical drag-and-drop interface similar in appearance to that available in a number of office productivity suites.

Initially integrated with Moodle to be used with Moodle's Tex filter, the export feature available with DragMath has now allowed an integration that supports the creation of LaTex text expressions with and without the doubledollar signs used to signal parsing by the filter as well as AsciiMathML text expressions.

To use DragMath, users must have the Java Runtime Environment (JRE) version 1.5 or higher installed on their desktop computers. Most systems come with the JRE as standard equipment, so you may not have to do anything. If you need to install the JRE manually, you can download it from here. Note that the JRE is variously known as Java software for your computer, Java Runtime Environment, the Java Runtime, Runtime Environment, Runtime, Java Virtual Machine, Virtual Machine, Java VM, JVM, VM, or Java download.

You can see a demo of the DragMath editor here. The DragMath interface is highly intuitive and anyone can be using it productively after a few minutes of trial-and-error. If you have questions about the editor, there is a short manual here.

Using DragMath

DragMath is based on the simple idea that the User who does not know a lot of TeX (pronounced Tech) can still create mathematical formula for publishing. In this case, Moodle is the dispaly agent so the TeX formulae are then rendered to a Moodle screen. This essentially means that with little experience, any Junior High Maths teacher can generate all the formulae they need for most aspects of Maths in Moodle.

Creating simple expressions

To begin, click on the DragMath insertion button. This opens The DragMath interface.

Opening Dragmath

The toolbar is different than you may expect, we are used to nice neat rows of buttons, but Dragmath has to use tabs. Each tab is tab is a collection of "templates", that is each symbol is a "template" and can be dragged and dropped onto the work space.

The DragMath Interface

To end editing and insert the script into the Moodle page, click the Insert button. This simple, but not simplistic, interface is a strength of DragMath. It make it easy for even novices to create complex formulae.


A sequence for DragMath - click an image to enlarge
Select the Tab with the symbols required
Click, hold then drag'n'drop a symbol
Enter the values, select an operation symbol
Select another symbol and drag'n'drop
Add an equal (or other) sign
Add in a variable, (chi in this case)
Click Insert
See the encoded result in the editing dialog.

This same sequence of operations apply equally for all formulae, all insertions, no matter how complex they become.

You can insert a template from the toolbar by drag and drop or by a click on the template in the tab, then clicking in the workspace.

Creating more complex expressions

More complex expressions are pretty much more of the same as above. Creating a simple multiplication table matrix, for example, seems complex,but in DragNath, it is actually simple:

A sequence for a simple Multiplication Matrice in DragMath - click an image to enlarge
Select the Tab and add in the multiplier
Click, hold then drag'n'drop the Matrix symbol
Enter the values, select a equal symbol
Add in the rows required
Add in the columns required
Edit the Matrice
Add the equal symbol
Add and edit in the second Matrice.

Locally saving and restoring a DragMath expression

When you press the Insert button, DragMath inserts the export string into your text and the DragMath window closes. The exported string can no longer be manipulated using DragMath. If you decide to change the string, you have two options:

  • delete the string (including the dollar signs or other token) and completely recreate it using DragMath
  • edit the expression by hand

You can not tell DragMath to re-read the expression and show it again in two dimensions. This is a theoretical limitation, not a limitation of DragMath.

But suppose the expression is very complicated. It would be impractical to start over just to make a simple change. Before you Insert the expression, you can save a copy of the expression (a .drgm file) to your local disk using the Save button (see screenshot). Later, if you need to make a change, you open the saved .drgm file.

DragMath instructions

A .drgm file contains three-dimensional representation of your mathematical expression. It is a binary file that can only be opened by DragMath.

Additional Editing

There are times when DragMath is not going to have a symbol or something you might want. Or perhaps you left something out of the DragMath constuctor, so you want to include it manually. Most likely, for something like the matrix created earlier, I want to go to 15, which means I have to change the structure of the matrix, and edit in some numbers. This is easily done with a little forethought. Copy and paste and delete or edit what you want and do not want.

Manually editing a DragMath construction - click an image to enlarge
Select, copy and paste the original matrix
Edit to what is actually required
Delete the original matrix

Sometimes however, you just want to include something you forgot, or rather, add something that was not there in the first place.

Accurately editing a DragMath construction manually - click an image to enlarge
Construct the original equation
Copy, then edit to what is actually required
Return to the edited page

See Also



Discussion of the transition of DragMath to Moodle core: http://moodle.org/mod/forum/discuss.php?d=125977&parent=551794