summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/graph.mdwn
blob: 4f02a9c46914ae6363645f2e1ac5082e6b6f72a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
[[!if test="enabled(graph)"
  then="In diesem Wiki ist die Direktive: graph **aktiviert**."
 else="In diesem Wiki ist die Direktive: graph **nicht aktiv**; falls dies gewünscht wird, den Admin benachrichtigen."]]

---
The `graph` directive is supplied by the [[!iki plugins/graphviz desc=graphviz]] plugin.

This directive allows embedding [graphviz](http://www.graphviz.org/)
graphs in a page.  Example usage:

	\[[!graph src="a -> b -> c; a -> c;"]]

Nodes on the graph can link to external urls using regular graphviz syntax,
and a clickable imagemap will be created. As a special extension for
ikiwiki, [[WikiLinks|ikiwiki/wikilink]] can also be used. For example:

	\[[!graph src="""
	google [ href="http://google.com/" ]
	sandbox [ href=\[[SandBox]] ]
	help [ href=\[[ikiwiki/formatting]] ]
	newpage [ href=\[[NewPage]] ]
	
	google -> sandbox -> help -> newpage -> help -> google;
	"""]]

The `graph` directive supports the following parameters:

- `src` - The graphviz source to render.
* `file` - A file in the wiki containing the graphviz source.
- `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.

[[!meta robots="noindex, follow"]]