1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Sat Jan 14 19:00:46 2012 +0100
1.3 @@ -0,0 +1,65 @@
1.4 +Basic Usage
1.5 +-----------
1.6 +
1.7 +Embed a visualization of a graph in a wiki page:
1.8 +
1.9 +{{{#!graphviz
1.10 +digraph G {
1.11 + A -> B;
1.12 +};
1.13 +}}}
1.14 +
1.15 +Advanced Usage
1.16 +--------------
1.17 +
1.18 +This parser will check the first lines of the Graphviz data for C++ style
1.19 +comments instructing it to use a different filter (dot, neato, twopi, circo,
1.20 +or fdp - see http://graphviz.org/ for more info), use a different format for
1.21 +the output (see the FORMATS list in the Parser class), or to generate and pass
1.22 +a client-side image map.
1.23 +
1.24 +Options:
1.25 +
1.26 +filter - the filter to use (see Parser.FILTERS)
1.27 +format - the output format (see Parser.FORMATS)
1.28 +cmapx - the map name to use for the client-side image map; this must match
1.29 + the graph name in the graph definition and shouldn't conflict with
1.30 + any other graphs that are used on the same page; for SVG images, the
1.31 + cmapx option is superfluous since SVG supports linking natively and
1.32 + Graphviz converts "href" attributes appropriately
1.33 +
1.34 +Embed a visualization of a graph in a wiki page, using the dot filter and
1.35 +providing a client-side image map (the filter=dot and format=png options are
1.36 +redundant since those are the defaults for this parser):
1.37 +
1.38 +{{{#!graphviz
1.39 +//filter=dot
1.40 +//format=png
1.41 +//cmapx=DocumentationMap
1.42 +digraph DocumentationMap {
1.43 + FrontPage [href="FrontPage", root=true];
1.44 + HelpOnEditing [href="HelpOnEditing"];
1.45 + SyntaxReference [href="SyntaxReference"];
1.46 + WikiSandBox [href="WikiSandBox", color="grey"];
1.47 + MoinMoin [href="http://moinmo.in"];
1.48 + FrontPage -> WikiSandBox;
1.49 + FrontPage -> MoinMoin;
1.50 + WikiSandBox -> HelpOnEditing;
1.51 + WikiSandBox -> SyntaxReference;
1.52 + SyntaxReference -> FrontPage;
1.53 +};
1.54 +}}}
1.55 +
1.56 +Known Bugs
1.57 +----------
1.58 +
1.59 + - Hasn't been thoroughly checked for potential methods of injecting
1.60 + arbitrary HTML into the output.
1.61 + - Only compatible with HTML rendering
1.62 + - May not use all of the MoinMoin interfaces properly - this is a
1.63 + quick hack based on looking at an example and digging through the
1.64 + MoinMoin source. The MoinMoin development docs haven't been
1.65 + consulted (yet).
1.66 + - Comments must start at the beginning of the graphviz block, and at the
1.67 + beginning of their respective lines. They must also not contain
1.68 + any extra whitespace surrounding the = sign.