Skip to content

Commit

Permalink
MDL-60209 mathjax: Update integration docs in readme_moodle.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
mudrd8mz committed Oct 9, 2017
1 parent 47cf945 commit b75eb84
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions filter/mathjaxloader/readme_moodle.txt
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
Description of MathJAX library integration in Moodle
=========================================================================================
====================================================

License: Apache 2.0
Source: http://www.mathjax.org
* Default MathJax version: 2.7.2
* License: Apache 2.0
* Source: https://www.mathjax.org/

Moodle maintainer: Damyon Wiese

=========================================================================================
This library is not shipped with Moodle, but this filter is provided, which can be used to
correctly load MathJax into a page from the CDN. Alternatively you can download the entire
library and install it locally, then use this filter to load that local version.

The only changes required to this filter to handle different MathJax versions is to update
the default CDN urls in settings.php - and update the list of language mappings - in filter.php.
Upgrading the default MathJax version
-------------------------------------

1. Update the default CDN URL in settings.php
2. Perform an upgrade step to change the configured URL if it matches the
previous default.
3. Check and eventually update the list of language mappings in filter.php.
Also see the unit test for the language mappings.

0 comments on commit b75eb84

Please sign in to comment.