X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/8c31a01efa05c4fb821e1364b8792b89852619a3..53453ebdb2c6624abcbb56a2f9605fffcd326c77:/doc/plugins/teximg.mdwn

diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn
index 5c35aa2e8..07ebb6d99 100644
--- a/doc/plugins/teximg.mdwn
+++ b/doc/plugins/teximg.mdwn
@@ -1,18 +1,22 @@
-[[template id=plugin name=teximg author="[[PatrickWinnertz]]"]]
-[[tag type/chrome type/slow]]
+[[!template id=plugin name=teximg author="[[PatrickWinnertz]]"]]
+[[!tag type/chrome type/slow]]
 
 This plugin renders LaTeX formulas into images.
 
+Of course you will need LaTeX installed for this to work. The plugin
+also uses mhchem.sty, which in Debian is in the texlive-science package and
+may not be part of a regular texlive installation.
+
 ## examples
 
-	\[[teximg code="\ce{[Cu(NH3)3]^{2+}}"]]
-	\[[teximg code="\frac{1}{2}"]]
-	\[[teximg code="E = - \frac{Z^2 \cdot  \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]]
+	\[[!teximg code="\ce{[Cu(NH3)3]^{2+}}"]]
+	\[[!teximg code="\frac{1}{2}"]]
+	\[[!teximg code="E = - \frac{Z^2 \cdot  \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]]
 
 To scale the image, use height=x:
 
-	\[[teximg code="\ce{[Cu(NH3)3]^{2+}}" height="17"]]
-	\[[teximg code="\ce{[Cu(NH3)3]^{2+}}" height="8"]]
+	\[[!teximg code="\ce{[Cu(NH3)3]^{2+}}" height="17"]]
+	\[[!teximg code="\ce{[Cu(NH3)3]^{2+}}" height="8"]]
 
 If no height is choosen the default height 12 is used. Valid heights are: 8, 9,
 10, 11, 12, 14, 17, 20. If another height is entered, the closest available
@@ -20,6 +24,14 @@ height is used.
 
 To add an alt text to the image, use alt="text":
 
-	\[[teximg code="\frac{1}{2}" alt="1/2"]]
+	\[[!teximg code="\frac{1}{2}" alt="1/2"]]
 
 See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images.
+
+## configuration
+
+There are several configuration directives that can be used in the setup
+file. `teximg_prefix` can be set to change the LaTeX preamble, and
+`teximg_postfix` to change the LaTeX postfix. The `teximg_dvipng` setting
+can be set to 0 to disable use of `dvipng`, and instead force use of `dvips`
+and `convert`.