WP-GraphViz

Description

GraphViz is a powerful tool for visualising network and tree structures that connect objects.

This WordPress plugin provides a shortcode mechanism to create GraphViz graphics within blogs, using the shortcode mechanism.

It’s working is based on the viz.js code as provided by Mike Daines:

https://github.com/mdaines/viz.js

Special thanks goes to chrisy as author of TFO Graphviz, e.g. for providing the inspiration for this readme:

https://wordpress.org/plugins/tfo-graphviz/

How to use WP GraphViz

The shortcode syntax is:

[wp_graphviz <options>]
 <DOT code>
[/wp_graphviz]

Where <options> is anything from this list. All are entirely optional:

• id="<id>"

  Provides the identifier used to link the generated image to an image map. If you use the simple option then it also provides the name of the generated DOT graph container (since GraphViz uses this to generate the image map). If not given then an identifier is generated with the form wp_graphviz_N where N is an integer that starts at one when the plugin is loaded and is incremented with use.

• output="<png|gif|jpg|svg>"

  Indicates the desired image format. Defaults to png.

• simple="yes|no"

  The simple option provides a very basic DOT wrapper around your code such that the following is possible:

  [wp_graphviz simple="yes"] a -> b -> c; [/wp_graphviz]
  

  The generated code would look like:

  digraph wp_graphviz_1 {
      a -> b -> c;
  }
  

  See the id option for a description of where the name of the digraph comes from. simple defaults to no.

• title="<title>"

  Indicates the title of the image. This is used in the alt and title attributes of the image reference. This defaults to an empty string. Note that image maps may indicate a title string which will appear in tool-tips.