Hackage :: [Package]

flow2dot: Library and binary to generate sequence/flow diagrams from plain text source

[ bsd3, console, library, program, tool ] [ Propose Tags ] [ Report a vulnerability ]

Generates sequence diagrams from textual descriptions with help of Graphviz graph drawing tool.

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.2, 0.2.1, 0.3, 0.3.1, 0.4, 0.5, 0.5.1, 0.6, 0.6.1, 0.7, 0.8, 0.9, 0.9.0.1, 0.9.0.2, 0.9.0.3, 0.9.1, 0.9.2
Change log ChangeLog.md
Dependencies base (>=3 && <=5), containers, dotgen, flow2dot, mtl (>=1.0), parsec [details]
Tested with ghc ==6.10.4, ghc ==8.8.3
License BSD-3-Clause
Author Dmitry Astapov <[email protected]>
Maintainer Dmitry Astapov <[email protected]>
Category Tool, Console
Home page https://github.com/adept/flow2dot
Bug tracker https://github.com/adept/flow2dot/issues
Source repo head: git clone https://github.com/adept/flow2dot
Uploaded by DmitryAstapov at 2020-06-16T00:27:56Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Executables flow2dot
Downloads 12058 total (38 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2020-06-16 [all 1 reports]

Readme for flow2dot-0.9.1

[back to package description]

This is a tool to generate nice sequence (flow) diagrams from textual descriptions, written in Haskell.

This tool generates a diagram description, which could be made into a nice picture with help of Graphviz (www.graphviz.org)

To try it out, run: runhaskell flow2dot.hs sample.flow | dot -T png -o sample.png and view "sample.png" with your favorite picture viewer. If you dont get a nice picture and get something else (for example, ugly segfault from dot), try upgrading to latest Graphviz (2.12 or later)

If you want to use national alphabets, make sure that your .flow files are encoded in UTF-8. If you want to tweak the output - read Dot manual and use it for scaling, colors, pagination etc.

Latest version could be obtained via: darcs pull http://adept.linux.kiev.ua:8080/repos/flow2dot/

License : BSD-style (see the file LICENSE) Send patches to [email protected] (using "darcs send")

Thanks to Cale, quicksilver and roconnor from #haskell for suggestions on how to modularize this. Thanks to Dema from [email protected] for win32 testing. Gwern0 helped to adapt this to GHC 6.8.2. Radoslav Dorcik sent in parser improvements. Mike Shigorin and Denis Smirnov packaged for Alt Linux and provided feedback on compatibility with different GHC versions. Vasyl Vaskul reported bugs.

Known issues

  • Dot < 2.12 will most likely segfault on files generated by flow2dot

  • If your version of dot complains about "Error: lost n1 n2 edge", try using flow2dot-fix-dot-lost-edges in place of dot:

    runhaskell flow2dot your.flow | flow2dot-fix-dot-lost-edges -T png -o your.png

Trick is to remove 'constraint="false"' from all edges that dot reports as lost.