Version 11 (modified by mitar, 16 months ago) (diff) |
---|

# TracMathJaxPlugin

#### Contents

## Description

A plugin for rendering math in Trac using MathJax. Unlike the TracMathPlugin, this plugin performs all rendering on the client side using web fonts.

See also: TracMathPlugin, LatexFormulaMacro, Trac2LatexPlugin, LatexMacro

## Download and Source

Download the 0.3 release in zip, gz, or bz2 format.

For the latest changes, check out the source using Hg, or browse it on Bitbucket.

## Installation

Unpack your download. Go to the top level directory of TracMathJax and type:

```
$ python setup.py bdist_egg
```

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 consult these trac plugin installation steps.

As of version 0.3 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 URL: https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML

### Configuration

To activate the component, edit your project's `trac.ini` file to include:

[components] tracmathjax.* = enabled

For additional customization of the display output, see the MathJax documentation.

## Bugs/Feature Requests

Existing bugs and feature requests for TracMathJaxPlugin are here.

If you have any issues, create a new ticket.

## Example

To display math inline, enter LaTeX equation in between a pair of `\(` and `\)` brackets:

Here is an inline equation: \( y = x^2 \)

To display a block of math, either enter it between a pair of `$$` characters:

Here is a block equation: $$ y = x^2 $$

or use the `latex` processor:

{{{ #!latex y = x ^ 2 }}}

## Release Notes

### 0.3

- Use the MathJax CDN to serve MathJax

### 0.2

- Fixed bugs with inline macro syntax (#8500)

### 0.1

- Initial release

## Alternative Implementation

There exist an alternative implementation which uses `math` keyword in wiki syntax so that it does conflicts with `TracMathPlugin` (which you could be using for real LaTeX rendering, including TikZ). Inline syntax is also different, simply using WikiMacros. Examples:

[[math(1+2=3)]] {{{ #!math x = \frac{1}{2} }}}

Otherwise, implementations should be functionally equivalent. If it is not so, please inform us.

### Bugs/Feature Requests

Please use GitHub for any issues you have with this implementation.

### Download

Download the zipped source from here.

### Source

You can clone this implementation from here using git, or the source on GitHub.

### Installation

pip install MathJaxPlugin

For more information, please follow documentation on how to install Trac's plugins.