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