summaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive/teximg.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
commit9921a4a8a1a696ce69acce5e14943f0149d926ff (patch)
tree926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/teximg.mdwn
parent7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff)
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/teximg.mdwn')
-rw-r--r--doc/ikiwiki/directive/teximg.mdwn23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/teximg.mdwn b/doc/ikiwiki/directive/teximg.mdwn
new file mode 100644
index 000000000..bd040c9cf
--- /dev/null
+++ b/doc/ikiwiki/directive/teximg.mdwn
@@ -0,0 +1,23 @@
+The `teximg` directive is supplied by the [[!iki plugins/teximg]] plugin.
+
+This directive renders LaTeX formulas into images.
+
+## examples
+
+ \[[!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="\frac{1}{2}" height="17"]]
+ \[[!teximg code="\frac{1}{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"]]
+
+[[!meta robots="noindex, follow"]]