= Support for LaTeX Math Formulas in Wiki Pages =
[[PageOutline()]]

== Description ==

Allow embedded equations in wiki pages. Basically a port of [http://www.amk.ca/python/code/mt-math mt-math] to trac.

See also tagged:LaTeX

== Download and Source == 

Download the 0.6 release in [https://bitbucket.org/kisielk/tracmathplugin/get/0.6.zip zip], [https://bitbucket.org/kisielk/tracmathplugin/get/0.6.tar.gz gz], or [https://bitbucket.org/kisielk/tracmathplugin/get/0.6.tar.bz2 bz2] format.

For the latest changes, check out the source [https://bitbucket.org/kisielk/tracmathplugin using Hg], or [https://bitbucket.org/kisielk/tracmathplugin/src browse it on Bitbucket].


== Installation ==

Unpack your download. Go to the top level directory of !TracMath and type:
{{{
#!sh
 $ 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 [t:wiki:TracPlugins trac plugin installation steps].

To activate the component, edit your project's `trac.ini` file to include:
{{{
#!ini
 [components] 
 tracmath.* = enabled
}}} 

The settings default to a linux environment where `pdflatex_cmd` is `/usr/bin/pdflatex` and `gs_cmd` is `/usr/bin/gs`, and `cache_dir` is `tmcache`, relative to project dir. You can override these settings by including in your `trac.ini` file settings such as:

{{{
#!ini
 [tracmath]
 pdflatex_cmd = <location of your pdflatex binary>
 gs_cmd = <location of your gs binary>
 cache_dir = <cache directory, relative to project dir or absolute>
 max_png = <max number of pngs in cache - defaults to 500>
 use_dollars = True
 invalid_commands = <list of invalid commands in LaTeX source>
 png_resolution = <PNG resolution when rendering - defaults to 110>
}}}

Note that if you have spaces in the location you should double double quote it. For example:

{{{
#!ini
 pdflatex_cmd = ""C:/Program Files/MiKTeX 2.7/miktex/bin/pdflatex.exe""
 gs_cmd = ""C:/Program Files/GhostScript/bin/gs.exe""
}}} 

== Additional Requirements ==
pdflatex and ghostscript

== Bugs/Feature Requests == 
Existing bugs and feature requests for TracMathPlugin are [query:status!=closed&component=TracMathPlugin&order=priority here]. If you have any issues, create a 
[/newticket?component=TracMathPlugin&owner=kisielk new ticket].


== Example ==

{{{
{{{
#!latex
$\mbox{Var}[\tau(X_p,X_d)] = \mbox{Var}[E(\tau(X_p,X_d)|X_p)] E[\mbox{Var}(\tau(X_p,X_d)|X_p)]$
}}}
}}}


would produce something akin to:

[[Image(test1.png)]]

'''Other features:'''
 * links for any `\label{}` that appears, i.e., `\label{eq1}` will allow you link to the output image via `SomeWikiPage#eq1`.
 * can use '$' latex syntax instead (if use_dollars is enabled in config)

== Release Notes ==

=== Version 0.6 (2013/01/10) ===
 * Updated for Trac 1.0 and 0.11 compatibility [thafreak]

=== Version 0.5 (2011/09/24) ===
 * Document template is now Trac template [mitar]
 * Validates input to prevent dangerous LaTeX commands [mitar]
 * Using pdflatex and gs to support wider number of LaTeX packages (like TikZ) [mitar]

=== Version 0.4 (2011/09/10) ===
 * Added `compression` option to control the png compression level. Set it to a number from 1 (lower) to 9 (higher) [kisielk]
 * FIxed #9066 [kisielk]
 * Added additional logging to help in future debugging [kisielk]
 * Fixed some error handling bits [kisielk]

=== Version 0.3 (2011/12/21) ===
 * General code refactoring / cleanup [kisielk]
 * Applied mag-factor patch from #6422 [kisielk]
 * Fixed sha module deprecation warnings (#7836) [kisielk]
 * Fixed cache implementation so cache management works correctly [kisielk]

== Author/Contributors ==

'''Author:''' [wiki:rlotun] [[BR]]
'''Maintainer:''' [wiki:kisielk] [[BR]]
'''Contributors''': [wiki:mitar], [wiki:thafreak] [[BR]]