The diagrams-builder package

[Tags:bsd3, library]

diagrams-builder provides backend-agnostic tools for dynamically turning code into rendered diagrams, using the hint wrapper to the GHC API. It supports conditional recompilation using hashing of diagrams source code, to avoid recompiling code that has not changed. It is useful for creating tools which compile diagrams code embedded in other documents. For example, it is used by the BlogLiterately-diagrams package (a plugin for BlogLiterately) to compile diagrams embedded in Markdown-formatted blog posts.

Executables specific to the cairo, SVG, postscript, and rasterific backends are included (more executables specific to other backends may be included in the future). All take an input file and an expression to render, and output an image file. If you want these executables you must explicitly enable the -fcairo, -fsvg, -fpostscript, or -frasterific flags.

A LaTeX package, diagrams-latex.sty, is also provided in the latex/ directory of the source distribution, which renders diagrams code found within diagram environments. Note that diagrams-latex.sty is licensed under the GPL.


[Skip to Readme]

Properties

Versions 0.2.0.0, 0.2.1.0, 0.3, 0.3.0.1, 0.4, 0.4.0.1, 0.4.0.2, 0.4.0.3, 0.4.0.4, 0.4.0.5, 0.4.0.6, 0.4.1, 0.4.2, 0.5, 0.5.0.1, 0.5.0.2, 0.5.0.3, 0.5.0.4, 0.5.0.5, 0.5.0.6, 0.5.0.7, 0.5.0.8, 0.5.0.9, 0.5.0.10, 0.5.0.11, 0.6, 0.6.0.1, 0.6.0.2, 0.6.0.3, 0.6.0.4, 0.7.0.0, 0.7.0.1, 0.7.0.2, 0.7.0.3, 0.7.0.4, 0.7.1, 0.7.1.1, 0.7.2.0, 0.7.2.1, 0.7.2.2, 0.7.2.3 (info)
Change log CHANGES.markdown
Dependencies base (>=4.2 && <4.9), base-orphans (>=0.3 && <0.6), cmdargs (>=0.6 && <0.11), diagrams-lib (==1.3.*), directory, exceptions (>=0.3 && <0.9), filepath, hashable (>=1.1 && <1.3), haskell-src-exts (>=1.16 && <1.18), hint (>=0.4 && <0.6), lens (>=4.0 && <4.14), mtl (>=2.1 && <2.3), split (==0.2.*), transformers (>=0.3 && <0.5) [details]
License BSD3
Author Brent Yorgey
Maintainer diagrams-discuss@googlegroups.com
Stability Unknown
Category Graphics
Home page http://projects.haskell.org/diagrams
Bug tracker https://github.com/diagrams/diagrams-builder/issues
Source repository head: git clone https://github.com/diagrams/diagrams-builder
Uploaded Sat Mar 19 20:12:39 UTC 2016 by bergey
Distributions LTSHaskell:0.7.2.3, NixOS:0.7.2.3
Downloads 7240 total (133 in the last 30 days)
Votes
0 []
Status Docs pending
Build status unknown [no reports yet]

Modules

  • Diagrams
    • Diagrams.Builder
      • Diagrams.Builder.CmdLine
      • Diagrams.Builder.Modules
      • Diagrams.Builder.Opts

Flags

NameDescriptionDefaultType
cairoinstall cairo-specific builder toolDisabledManual
svginstall svg-specific builder toolDisabledManual
psinstall postscript-specific builder toolDisabledManual
postscriptinstall postscript-specific builder toolDisabledManual
rasterificinstall rasterific-specific builder toolDisabledManual
pgfinstall PGF-specific builder toolDisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for diagrams-builder

Readme for diagrams-builder-0.7.2.3

Build Status

diagrams-builder provides backend-agnostic tools for dynamically turning code into rendered diagrams, using the hint wrapper to the GHC API. It supports conditional recompilation using hashing of diagrams source code, to avoid recompiling code that has not changed. It is useful for creating tools which compile diagrams code embedded in other documents. For example, it is used by the BlogLiterately-diagrams package (a plugin for BlogLiterately) to compile diagrams embedded in Markdown-formatted blog posts, and by the diagrams-latex.sty package for embedding diagrams in LaTeX documents (see below).

Executables specific to the cairo, svg, postscript, rasterific, and PGF backends are included. Each takes an input file and an expression to render and outputs an image file using the appropriate backend. You must explicitly enable whichever executables you want using flags like -fcairo, -fsvg, and so on.

A LaTeX package, diagrams-latex.sty, is also provided in the latex/ directory of the source distribution, which renders diagrams code found within diagram environments. It can make use of any of the diagrams-builder-cairo, diagrams-builder-postscript, or diagrams-builder-pgf executables, so if you want to use diagrams-latex.sty you should install diagrams-builder with the appropriate option. Note that diagrams-latex.sty is licensed under the GPL. For more information on using diagrams-latex.sty, see this tutorial.