X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/69e35d3c515cd30c9baf82468008d0b0643e1e1f..c7bdebaaf134729356852918b387071c92f85e72:/doc/plugins/teximg.mdwn?ds=sidebyside diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn index 07ebb6d99..98f01faaa 100644 --- a/doc/plugins/teximg.mdwn +++ b/doc/plugins/teximg.mdwn @@ -1,32 +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. +You will need LaTeX installed for this to work, specifically something +providing `latex` in the path. You will also need either `dvipng` or a +combination of `dvips` and `convert` from ImageMagick/GraphicsMagick. -## 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}" ]] - -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. +On Debian systems, the relevant package names are `texlive-latex-base` +and either `dvipng` or `graphicsmagick-imagemagick-compat`. ## configuration