diff options
| author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:05:51 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:51 -0400 |
| commit | c69a7f758590c91bd137a8d1cfa99f37bf28045a (patch) | |
| tree | 16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/teximg.mdwn | |
| parent | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff) | |
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/teximg.mdwn')
| -rw-r--r-- | doc/plugins/teximg.mdwn | 28 |
1 files changed, 3 insertions, 25 deletions
diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn index 07ebb6d99..cf9fb5c6d 100644 --- a/doc/plugins/teximg.mdwn +++ b/doc/plugins/teximg.mdwn @@ -1,32 +1,10 @@ [[!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. - -## 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. +Of course you will need LaTeX installed for this to work. ## configuration |