web commit by PatrickWinnertz: put in some documentation about the tex plugin
[ikiwiki.git] / doc / plugins / tex.mdwn
1 [[template id=plugin name=tex author="[[PatrickWinnertz]]"]]
2 [[tag type/chrome type/slow]]
3
4 This plugin renders LaTeX formulas into images, which are rendered automatically when you save this site. 
5
6 Scaling of this images is of course also possible, possible heights are:
7   8,9,10,11,12,14,17,20
8 But is also work if you pic e.g. another height. The best fitting height is then used to generate the image.
9
10 #Here are some examples how to use this plugin:
11
12         \[[tex code="\ce{[Cu(NH3)3]^{2+}}"]]
13         \[[tex code="\frac{1}{2}"]]
14         \[[tex code="E = - \frac{Z^2 \cdot  \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]]
15
16 in order to scale this images use height=x:
17
18         \[[tex code="\ce{[Cu(NH3)3]^{2+}}" height="17"]]
19         \[[tex code="\ce{[Cu(NH3)3]^{2+}}" height="8"]]
20
21 If no height is choosen the default height 12 is used.
22
23 See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images.