Note: You are currently viewing documentation for Moodle 3.4. Up-to-date documentation for the latest stable version of Moodle is likely available here: MathJax filter.

MathJax filter: Difference between revisions

From MoodleDocs
(→‎See also: MOBILE-1611)
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Filters}}
{{Filters}}
{{New features}}
The MathJax filter parses Moodle texts and displays some TeX expressions appearing within specific tokens within Moodle texts as a  Mathematics.


=On Moodle.org=
The MathJax filter parses Moodle texts and will fully render TeX expressions that it finds appearing within specific tokens.
==Forums vs Moodle Docs==
For those who don't know, Moodle.org employes mediawiki for documentation, and employs Moodle for the forums. MathJax will not as yet be used for Moodle Docs, so there may be differences between what Maths look like on the forums and what they look like on Moodle Docs. No, there really is not adequate documentation on the usage of Tex on the Docs side either ;-)
==Setting of Filter on Forums==
MathJax has the capability to use a variety of tokens, to display inline and display math, and to display ASCIIMathML.  Unfortunately,  there is no indication as yet as to how MathJax for Moodle.org will be configured
==Extensions==
There is no indication of how extensions will be address on Moodle.org==


=Generally=
The Mathjax filter also improves the look of buttons and preview within the equation editor that is part of the Atto [[Text editor|text editor]].
If the default [[Text editor|text editor]] (Atto) is used, it provides an equation editor for creating Mathematical expressions in TeX format within Moodle texts.  


== Site administration settings ==
== Site administration settings ==
Line 22: Line 13:
MathJax has a setting for "TeX filter compatibility" that changes the behaviour to match as closely as possible, the "Tex filter". This means it will support all the different delimiters of the Tex filter, and display all equations as "inline". It is only recommended to enable this setting if you have existing equations written manually using a variety of delimiters supported by the old filter. It may be hard to determine if this is the case except by searching the database for equations of the form:
MathJax has a setting for "TeX filter compatibility" that changes the behaviour to match as closely as possible, the "Tex filter". This means it will support all the different delimiters of the Tex filter, and display all equations as "inline". It is only recommended to enable this setting if you have existing equations written manually using a variety of delimiters supported by the old filter. It may be hard to determine if this is the case except by searching the database for equations of the form:
<pre>
<pre>
  [tex] equation [/tex], <tex> equation </tex> or \( equation \)
  $$ equation $$, [tex] equation [/tex], <tex> equation </tex> or \( equation \)
</pre>
</pre>


The [http://www.mathjax.org/ MathJax project] is large and detailed with many options, which a Moodle admin can make use of with the MathJax filter.
The [http://www.mathjax.org/ MathJax project] is large and detailed with many options, which a Moodle admin can make use of with the MathJax filter.
Note: If the MathJax filter is used instead of the Tex filter for rendering equations, the drag math (plugin for the TinyMCE text editor) setting "require tex" should be set to "off". If this is not done, TinyMCE users will not be able to use any equation editor.


==See also==
==See also==
Line 32: Line 25:
* [[Using TeX Notation]]
* [[Using TeX Notation]]
* [https://moodle.org/mod/forum/view.php?id=752 Mathematics tools forum] on moodle.org
* [https://moodle.org/mod/forum/view.php?id=752 Mathematics tools forum] on moodle.org
* MOBILE-1611 - Mobile app doesn't show embedded math TeX or MathJax in Quizzes


[[Category:Site administration]]
[[Category:Site administration]]
Line 37: Line 31:


[[es:Filtro MathJax]]
[[es:Filtro MathJax]]
[[de:MathJax-Filter]]

Latest revision as of 08:07, 10 October 2016


The MathJax filter parses Moodle texts and will fully render TeX expressions that it finds appearing within specific tokens.

The Mathjax filter also improves the look of buttons and preview within the equation editor that is part of the Atto text editor.

Site administration settings

The MathJax filter is enabled by default in Administration > Site administration > Plugins > Filters > Manage filters. Normally, the MathJax filter should be at the top of the list of filters.

The MathJax filter works without any additional configuration (using the MathJax Content Delivery Network). However, MathJax may also be installed locally if desired, to save on bandwidth or because of local proxy restrictions. See Administration > Site administration > Plugins > Filters > MathJax for further details and configuration settings.

MathJax has a setting for "TeX filter compatibility" that changes the behaviour to match as closely as possible, the "Tex filter". This means it will support all the different delimiters of the Tex filter, and display all equations as "inline". It is only recommended to enable this setting if you have existing equations written manually using a variety of delimiters supported by the old filter. It may be hard to determine if this is the case except by searching the database for equations of the form:

 $$ equation $$, [tex] equation [/tex], <tex> equation </tex> or \( equation \)

The MathJax project is large and detailed with many options, which a Moodle admin can make use of with the MathJax filter.

Note: If the MathJax filter is used instead of the Tex filter for rendering equations, the drag math (plugin for the TinyMCE text editor) setting "require tex" should be set to "off". If this is not done, TinyMCE users will not be able to use any equation editor.

See also