]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/graphviz.mdwn
Added a comment
[git.ikiwiki.info.git] / doc / plugins / graphviz.mdwn
index 51b06ebab341d2c682d8769115ea1e919187563f..d57d7dc947c4c12486d235b35463e8e71ddef7c2 100644 (file)
@@ -1,7 +1,7 @@
 [[!template id=plugin name=graphviz author="[[JoshTriplett]]"]]
-[[!tag type/chrome type/format]]
+[[!tag type/widget]]
 
-This plugin implements the [[ikiwiki/directive/graph]] [[ikiwiki/directive]].
+This plugin provides the [[ikiwiki/directive/graph]] [[ikiwiki/directive]].
 This directive allows embedding [graphviz](http://www.graphviz.org/) graphs in a
 page.
 
@@ -15,4 +15,11 @@ already do these things with just the core of ikiwiki, but the graphviz plugin
 allows for an amplification attack, since users can send less data to use large
 amounts of processing time and disk usage.
 
-This plugin uses the [[!cpan Digest::SHA1]] perl module.
+[[!if test="enabled(graphviz)" then="""
+Some example graphs:
+
+[[!graph src="a -> b -> c; a -> b;"]]
+[[!graph src="a -- b -- c -- a;" prog="circo" type="graph"]]
+"""]]
+
+This plugin uses the [[!cpan Digest::SHA]] perl module.