Merge commit 'upstream/master' into pub/master

[git.ikiwiki.info.git] / doc / plugins / graphviz.mdwn

diff --git a/doc/plugins/graphviz.mdwn b/doc/plugins/graphviz.mdwn
index 51b06ebab341d2c682d8769115ea1e919187563f..b89f16b59512092fb9512462bd5bd2e1c09d1a6e 100644 (file)
--- a/doc/plugins/graphviz.mdwn
+++ b/doc/plugins/graphviz.mdwn
@@ -1,7 +1,7 @@
 [[!template id=plugin name=graphviz author="[[JoshTriplett]]"]]
 [[!tag type/chrome type/format]]
 
 [[!template id=plugin name=graphviz author="[[JoshTriplett]]"]]
 [[!tag type/chrome type/format]]
 

-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.
 
 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.
 
 allows for an amplification attack, since users can send less data to use large
 amounts of processing time and disk usage.
 

+[[!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::SHA1]] perl module.
 This plugin uses the [[!cpan Digest::SHA1]] perl module.