diff options
author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:04:23 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:19 -0400 |
commit | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (patch) | |
tree | 725f523faeb8e8db0efd81be4024257799c93ef8 /underlays/basewiki/directive/graph.mdwn | |
parent | 595b0359157d1f57ee5a87c63e665dfa1d2130ec (diff) |
add underlay files for listdirectives
As was noted, 'listdirectives' didn't include the underlay files that make
it really worthwhile. I've just gone through all the plugin
documentation, modified it to remove installation information and renamed
the files to match the directives rather than the plugins. This can now
serve as useful underlay.
I've only gone through plugins in the 'plugins' dir. I did not go through
the 'contrib' dir.
Diffstat (limited to 'underlays/basewiki/directive/graph.mdwn')
-rw-r--r-- | underlays/basewiki/directive/graph.mdwn | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/graph.mdwn b/underlays/basewiki/directive/graph.mdwn new file mode 100644 index 000000000..f45af3e04 --- /dev/null +++ b/underlays/basewiki/directive/graph.mdwn @@ -0,0 +1,28 @@ +The `graph` directive is supplied by the [[!iki plugins/graphviz]] plugin. + +This directive 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 +page. + +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=""" +Some example graphs: + +[[!graph src="a -> b -> c; a -> b;"]] +[[!graph src="a -- b -- c -- a;" prog="circo" type="graph"]] +"""]] |