This plugin is part of the ImageGen family.
See the main page for usage, download and installation instructions.

The Graphviz layout programs take descriptions of graphs in a simple text language, and make diagrams in several useful formats such as images and SVG for web pages. Graphviz has many useful features for concrete diagrams, such as options for colors, fonts, tabular node layouts, line styles, hyperlinks, and custom shapes.

The package name for this plugin is org.nascif.jspwiki.plugin.imagegen.graphviz

NOTE: GraphViz is not a Java application, but an executable. It has to be downloaded and installed separately. After downloading, follow the instructions to install it in your web server machine.

NOTE: You need also to add the property graphviz.bin to your jspwiki.properties, pointing to the bin directory of your local GraphViz install.

For example in Windows you would have something like this (adjust to match your own GraphViz installation):

# GraphViz plugin
################################################################################
graphviz.bin=c:\\home\\bin\\graphviz\\Graphviz\\bin

title
required, the name of the graph, will be used as the root name for the file attachments generated by the plugin.
imap
optional, defaults to 'false', set to 'true' to have an image map generated (assuming the associated library supports it). In that case, node names will be interpreted as wiki page names.
tooltips
optional, defaults to 'false', set to 'true' to have tooltips generated (assuming the associated library supports it).
page
optional, defaults to the current page and is the page to which the generated data files are attached.
output
optional, defaults to 'png'. It indicates the image format generated. It must be a supported output type by the graphical application or library, and it must be displayable using the HTML img tag. In this context, png, jpg, and gif are the most useful.
source
optional, the name of the attachment file that contains the graph data.
_body
required, unless source is specified. The plugin body should contain the graph data, in the appropriate syntax for the specific plugin. It might contain nested plugin invocations; those are evaluated and the resulting data is used. Note that the plugin must return data in the expected graph data syntax, not in HTML. See this example for details.
filter
the Graphviz application used to convert the graph data into an image. The following values are supported as of Graphviz version 2.80:
  • dot - makes ``hierarchical or layered drawings of directed graphs. The layout algorithm aims edges in the same direction (top to bottom, or left to right) and then attempts to avoid edge crossings and reduce edge length.
  • neato and fdp - make ``spring model layouts. neato uses the Kamada-Kawai algorithm, which is equivalent to statistical multi-dimensional scaling. fdp implements the Fruchterman-Reingold heuristic including a multigrid solver that handles larger graphs and clustered undirected graphs.
  • twopi - radial layout, after Graham Wills 97.
  • circo - circular layout, after Six and Tollis 99, Kauffman and Wiese 02. Suitable for certain diagrams of multiple cyclic structures.
The graph data must be specified in the Dot syntax. A special construction supported is the string $(nodeAttributes); it can be put in the graph data to indicate where the special node attributes created by imap='true' are to be placed. If not specified the attribtues are put before your graph data.
[{org.nascif.jspwiki.plugin.imagegen.graphviz.GraphVizPlugin title='DotFilter' filter='dot' imap='true'

node [shape=box];

$(nodeAttributes)

g--a
a--b--c
d--e--f
b--e

}]

DotFilter.png

[{org.nascif.jspwiki.plugin.imagegen.graphviz.GraphVizPlugin title='NeatoFilter' filter='neato' 

g--a
a--b--c
d--e--f
b--e
}]

NeatoFilter.png

It seems like the file graphviz.bin does not exist in windows. Does this plugin support JSPWiki which is installed in windows box? -- Yong Ren, 14-Jun-2007

Yes it does - graphviz.bin is a property name, not a file name. I changed the documentation to make this clear. -- NascifAbousalhNeto, 16-Jun-2007

Add new attachment

Only authorized users are allowed to upload new attachments.

List of attachments

Kind Attachment Name Size Version Date Modified Author Change note
png
DotFilter.png 0.9 kB 2 08-Aug-2006 20:14 Nascif Abousalh-Neto
png
NeatoFilter.png 2.4 kB 1 08-Aug-2006 18:59 Nascif Abousalh-Neto
« This page (revision-11) was last changed on 15-Jun-2007 20:08 by NascifAbousalhNeto