| 7 | | This is a plugin for rendering mathematical expressions in Trac using [http://www.mathjax.org MathJax]. MathJax is issued by the MathJax Consortium, which is a joint venture of the American Mathematical Society (AMS) and the Society for Industrial and Applied Mathematics (SIAM) to advance mathematical and scientific content on the web. MathJax works across a wide range of browsers. Unlike the TracMathPlugin, this plugin performs all rendering on the client side using web fonts. |
| 8 | | |
| 9 | | It exists in two implementations, each with a different syntax: inline or block. |
| 10 | | |
| 11 | | To display a mathematical expression inline, enter the LaTeX equation between a pair of `\(` and `\)` brackets: |
| 12 | | |
| 13 | | {{{ |
| 14 | | Here is an inline equation: \( y = x^2 \) |
| 15 | | }}} |
| 16 | | |
| 17 | | To display a mathematical expression in a block, either enter it between a pair of `$$` characters: |
| 18 | | |
| 19 | | {{{ |
| 20 | | Here is a block equation: $$ y = x^2 $$ |
| 21 | | }}} |
| 22 | | |
| 23 | | or use the `latex` preprocessor: |
| 24 | | |
| 25 | | {{{ |
| 26 | | {{{ |
| 27 | | #!latex |
| 28 | | y = x^2 |
| 29 | | }}} |
| 30 | | }}} |
| 31 | | |
| 32 | | Each of these examples will be displayed as follows: |
| 33 | | |
| 34 | | [[Image(mathjaxexample.gif)]] |
| 35 | | |
| 36 | | See also: TracMathPlugin, LatexFormulaMacro, Trac2LatexPlugin, LatexMacro or below for an [th:TracMathJaxPlugin#AlternativeImplementation alternative implementation] and which may be more up to date. |
| 37 | | |
| 38 | | == Bugs/Feature Requests |
| 39 | | |
| 40 | | Existing bugs and feature requests for TracMathJaxPlugin are |
| 41 | | [report:9?COMPONENT=TracMathJaxPlugin here]. |
| 42 | | |
| 43 | | If you have any issues, create a |
| 44 | | [/newticket?component=TracMathJaxPlugin new ticket]. |
| 45 | | |
| 46 | | [[TicketQuery(component=TracMathJaxPlugin&group=type,format=progress)]] |
| 47 | | |
| 48 | | == Download |
| 49 | | |
| 50 | | Download the latest release in [https://bitbucket.org/kisielk/tracmathjaxplugin/get/0.4.zip zip], [https://bitbucket.org/kisielk/tracmathjaxplugin/get/0.4.tar.gz gz], or [https://bitbucket.org/kisielk/tracmathjaxplugin/get/0.4.tar.bz2 bz2] format. |
| 51 | | |
| 52 | | == Source |
| 53 | | |
| 54 | | For the latest changes, check out the source [https://bitbucket.org/kisielk/tracmathjaxplugin using Hg], or [https://bitbucket.org/kisielk/tracmathjaxplugin/src browse it on Bitbucket]. |
| 55 | | |
| 56 | | == Installation |
| 57 | | |
| 58 | | Unpack your download. Go to the top level directory of !TracMathJax and type: |
| 59 | | {{{#!sh |
| 60 | | python setup.py bdist_egg |
| 61 | | }}} |
| 62 | | |
| 63 | | This should create an egg file under the `dist` subdirectory of your current directory. Copy the egg to the `plugins` directory of your Trac project. If you have any difficulties installing, then consult these [TracPlugins trac plugin installation steps]. |
| 64 | | |
| 65 | | As of version 0.4 of this plugin you no longer need to download !MathJax to your web server. The plugin will use version of !MathJax from their secure CDN. |
| 66 | | |
| 67 | | == Configuration |
| 68 | | |
| 69 | | To activate the component, edit your project's `trac.ini` file to include: |
| 70 | | {{{#!ini |
| 71 | | [components] |
| 72 | | tracmathjax.* = enabled |
| 73 | | }}} |
| 74 | | |
| 75 | | {{{#!comment |
| 76 | | Dont understand why [components] is highlighted in an incorrect color. |
| 77 | | }}} |
| 78 | | |
| 79 | | For additional customization of the display output, see the [https://www.mathjax.org/#docs MathJax documentation]. |
| 80 | | |
| 81 | | == Release Notes |
| 82 | | |
| 83 | | '''0.4''': Update CDN URL |
| 84 | | |
| 85 | | '''0.3''': Use the !MathJax CDN to serve !MathJax |
| 86 | | |
| 87 | | '''0.2''': Fixed bugs with inline macro syntax (#8500) |
| 88 | | |
| 89 | | '''0.1''': Initial release |
| 90 | | |
| 91 | | == Alternative Implementation |
| 92 | | |
| 93 | | There exist an alternative implementation which uses `math` keyword in wiki syntax so that it does '''not''' conflict with `TracMathPlugin`. This could be used for real LaTeX rendering, including [http://www.texample.net/tikz/ TikZ]. This alternative implementation is AGPL-licensed. |
| 94 | | |
| 95 | | Inline syntax is also different, simply using WikiMacros. Examples: |
| | 7 | Inline syntax uses WikiMacros. Examples: |
