X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/297ff849b93e5a75074e321fe65500f0e091601c..62e16c41f54d764cc08dd4aa305d242a98b86052:/doc/plugins/teximg.mdwn?ds=sidebyside diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn index c866f17cc..866b1ee05 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]] +[[!tag type/widget type/slow]] -This plugin renders LaTeX formulas into images. +This plugin provides a [[ikiwiki/directive/teximg]] [[ikiwiki/directive]], +that 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`.