X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/d5e65e582a34ae2494fee493ddcb2b959e4a4bce..c69a7f758590c91bd137a8d1cfa99f37bf28045a:/doc/plugins/teximg.mdwn diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn index 1908cfb79..cf9fb5c6d 100644 --- a/doc/plugins/teximg.mdwn +++ b/doc/plugins/teximg.mdwn @@ -1,29 +1,15 @@ [[!template id=plugin name=teximg author="[[PatrickWinnertz]]"]] [[!tag type/chrome type/slow]] -This plugin renders LaTeX formulas into images. +This plugin implements the [[ikiwiki/directive/teximg]] [[ikiwiki/directive]]. +The directive 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. +Of course you will need LaTeX installed for this to work. -## examples +## configuration - \[[!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"]] - -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 -height is used. - -To add an alt text to the image, use alt="text": - - \[[!teximg code="\frac{1}{2}" alt="1/2"]] - -See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images. +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`.