Merge branch 'fancypodcast' of github.com:schmonz/ikiwiki into fancypodcast

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

diff --git a/doc/plugins/graphviz.mdwn b/doc/plugins/graphviz.mdwn
index c8844d0d663aaa0149a1b00972f5b660a1862ccf..d57d7dc947c4c12486d235b35463e8e71ddef7c2 100644 (file)
--- a/doc/plugins/graphviz.mdwn
+++ b/doc/plugins/graphviz.mdwn
@@ -1,13 +1,8 @@
-[[template id=plugin name=graphviz author="[[JoshTriplett]]"]]
-[[tag type/chrome type/format]]
+[[!template id=plugin name=graphviz author="[[JoshTriplett]]"]]
+[[!tag type/widget]]

 
 

-This plugin allows embedding [graphviz](http://www.graphviz.org/) graphs in a
-page.  Example usage:
-
-       \[[graph src="a -> b -> c; a -> c;"]]
-
-Note that graphs will only show up in previews if your browser has
-[[wikipedia data: URI]] support, or if the same graph already exists on that
+This plugin provides the [[ikiwiki/directive/graph]] [[ikiwiki/directive]].
+This directive allows embedding [graphviz](http://www.graphviz.org/) graphs in a

 page.
 
 Security implications: graphviz does not seem to have any syntax exploitable to
 page.
 
 Security implications: graphviz does not seem to have any syntax exploitable to


@@ -20,20 +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.
 

-The `graph` directive supports the following parameters:
-
-- `src` - The graphviz source to render.
-- `type` - The type of graph to render: `graph` or `digraph`.  Defaults to
-  `digraph`.
-- `prog` - The graphviz program to render with: `dot`, `neato`, `fdp`, `twopi`,
-  or `circo`.  Defaults to `dot`.
-- `height`, `width` - Limit the size of the graph to a given height and width,
-  in inches. You must specify both to limit the size; otherwise, graphviz will
-  choose a size, without any limit.
-
-[[if test="enabled(graphviz)" then="""
+[[!if test="enabled(graphviz)" then="""

 Some example graphs:
 
 Some example graphs:
 

-[[graph src="a -> b -> c; a -> b;"]]
-[[graph src="a -- b -- c -- a;" prog="circo" type="graph"]]
+[[!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.