You are here

README.txt in MathJax: LaTeX for Drupal 6

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7.2 README.txt
  3. 7 README.txt
  4. 3.0.x README.txt
DESCRIPTION
===========
MathJax is the up-to-date ajax framework to display math in HTML environment
using LaTeX and MathML syntax. This module allows to activate MathJax-based
LaTeX rendering on your drupal website. By default, MathJax source is loaded
automatically from the internet using MathJax Content Delivery Network (CDN).

Currently there is no settings available: MathJax is activated on all nodes and
profile pages. LaTeX inline formula can be entered as $formula$ or \(formula\),
and display formula as $$formula$$ or \[formula\].

Dollar signs in formulas can be escaped using \. < and > signs must be handled
with care as they may be interpreted as start and end of HTML tags: either use
spaces around (e.g. $< dx >$) or the HTML special chars &lt; and &gt; or their
MathJax LaTeX-like equivalents \lt and \gt. More details on MathJax TeX support
on http://www.mathjax.org/resources/docs/?tex.html


INSTALLATION
============

Using MathJax CDN - recommended
-------------------------------

1. Place the "mathjax" folder in your "modules" directory (e.g. sites/all/modules/mathjax).

2. Enable the MathJax module under Administer >> Site building >> Modules.

3. Test it by adding a LaTeX formula between '$' in any node body (e.g. $2 + 2 = 4$).


Using a local copy of mathjax (relies on libraries module)
----------------------------------------------------------

1. Download and install the "Libraries API" module: uncompress the "libraries"
folder, copy it to your "modules" directory, and enable it under
Administer >> Site building >> Modules.

http://drupal.org/project/libraries

2. Place the "mathjax" folder in your "modules" directory (e.g. sites/all/modules/mathjax).

3. Install third party MathJax software
     Download MathJax 1.1 source from MathJax website (e.g. https://github.com/mathjax/MathJax/zipball/v1.1a)
     Unarchive it into your "libraries" directory (e.g. sites/all/libraries).
     You may need to create the "libraries" directory first.
     Rename it to "mathjax" (lower case).
NB: Relying on libraries module to locate 'mathjax' folder allows you to place
it in a site specific (e.g. sites/mysite/libraries) or default folder
(e.g. sites/all/libraries). Site-specific versions are selected preferentially.

3. Enable the MathJax module under Administer >> Site building >> Modules.

4. Disable the "Use MathJax CDN" checkbox in Administer >> Site configuration >> MathJax

5. Test it by adding a LaTeX formula between '$' in any node body (e.g. $2 + 2 = 4$).



INSTALLATION USING DRUSH
========================

Using MathJax CDN - recommended
-------------------------------
drush en mathjax


Using a local copy of mathjax
------------------------------
drush dl libraries
drush en libraries mathjax
drush mathjax-download
drush vset --yes mathjax_use_cdn 0


AUTHOR
======
Module written by Thomas Julou.
http://drupal.org/user/273952

MathJax
http://www.mathjax.org/


TO DO
=====
- set mathjax parameters on admin page (size, source type, ...)
- show source code in lightbox-like modules (set link attribute)
- support MathML syntax

File

README.txt
View source
  1. DESCRIPTION
  2. ===========
  3. MathJax is the up-to-date ajax framework to display math in HTML environment
  4. using LaTeX and MathML syntax. This module allows to activate MathJax-based
  5. LaTeX rendering on your drupal website. By default, MathJax source is loaded
  6. automatically from the internet using MathJax Content Delivery Network (CDN).
  7. Currently there is no settings available: MathJax is activated on all nodes and
  8. profile pages. LaTeX inline formula can be entered as $formula$ or \(formula\),
  9. and display formula as $$formula$$ or \[formula\].
  10. Dollar signs in formulas can be escaped using \. < and > signs must be handled
  11. with care as they may be interpreted as start and end of HTML tags: either use
  12. spaces around (e.g. $< dx >$) or the HTML special chars < and > or their
  13. MathJax LaTeX-like equivalents \lt and \gt. More details on MathJax TeX support
  14. on http://www.mathjax.org/resources/docs/?tex.html
  15. INSTALLATION
  16. ============
  17. Using MathJax CDN - recommended
  18. -------------------------------
  19. 1. Place the "mathjax" folder in your "modules" directory (e.g. sites/all/modules/mathjax).
  20. 2. Enable the MathJax module under Administer >> Site building >> Modules.
  21. 3. Test it by adding a LaTeX formula between '$' in any node body (e.g. $2 + 2 = 4$).
  22. Using a local copy of mathjax (relies on libraries module)
  23. ----------------------------------------------------------
  24. 1. Download and install the "Libraries API" module: uncompress the "libraries"
  25. folder, copy it to your "modules" directory, and enable it under
  26. Administer >> Site building >> Modules.
  27. http://drupal.org/project/libraries
  28. 2. Place the "mathjax" folder in your "modules" directory (e.g. sites/all/modules/mathjax).
  29. 3. Install third party MathJax software
  30. Download MathJax 1.1 source from MathJax website (e.g. https://github.com/mathjax/MathJax/zipball/v1.1a)
  31. Unarchive it into your "libraries" directory (e.g. sites/all/libraries).
  32. You may need to create the "libraries" directory first.
  33. Rename it to "mathjax" (lower case).
  34. NB: Relying on libraries module to locate 'mathjax' folder allows you to place
  35. it in a site specific (e.g. sites/mysite/libraries) or default folder
  36. (e.g. sites/all/libraries). Site-specific versions are selected preferentially.
  37. 3. Enable the MathJax module under Administer >> Site building >> Modules.
  38. 4. Disable the "Use MathJax CDN" checkbox in Administer >> Site configuration >> MathJax
  39. 5. Test it by adding a LaTeX formula between '$' in any node body (e.g. $2 + 2 = 4$).
  40. INSTALLATION USING DRUSH
  41. ========================
  42. Using MathJax CDN - recommended
  43. -------------------------------
  44. drush en mathjax
  45. Using a local copy of mathjax
  46. ------------------------------
  47. drush dl libraries
  48. drush en libraries mathjax
  49. drush mathjax-download
  50. drush vset --yes mathjax_use_cdn 0
  51. AUTHOR
  52. ======
  53. Module written by Thomas Julou.
  54. http://drupal.org/user/273952
  55. MathJax
  56. http://www.mathjax.org/
  57. TO DO
  58. =====
  59. - set mathjax parameters on admin page (size, source type, ...)
  60. - show source code in lightbox-like modules (set link attribute)
  61. - support MathML syntax