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

Versions0.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 (info)
Change logCHANGES.markdown
Dependenciesbase (>=4.2 && <4.9), base-orphans (>=0.3 && <0.5), bytestring (>=0.9.2 && <0.11), cmdargs (>=0.6 && <0.11), diagrams-builder, diagrams-cairo (==1.3.*), diagrams-lib (==1.3.*), diagrams-pgf, diagrams-postscript (>=0.6 && <1.4), diagrams-rasterific (==1.3.*), diagrams-svg (>=0.8.0.1 && <1.4), directory, exceptions (>=0.3 && <0.9), filepath, hashable (>=1.1 && <1.3), haskell-src-exts (==1.16.*), hint (==0.4.*), JuicyPixels (>=3.1.5 && <3.3), lens (>=4.0 && <4.13), lucid-svg, mtl (>=2.1 && <2.3), split (==0.2.*), transformers (>=0.3 && <0.5) [details]
LicenseBSD3
AuthorBrent Yorgey
Maintainerdiagrams-discuss@googlegroups.com
CategoryGraphics
Home pagehttp://projects.haskell.org/diagrams
Bug trackerhttps://github.com/diagrams/diagrams-builder/issues
Source repositoryhead: git clone https://github.com/diagrams/diagrams-builder
Executablesdiagrams-builder-pgf, diagrams-builder-rasterific, diagrams-builder-ps, diagrams-builder-svg, diagrams-builder-cairo
UploadedSun Jul 19 18:28:14 UTC 2015 by bergey
DistributionsNixOS:0.7.1.1, Stackage:0.7.1.1
Downloads5105 total (315 in last 30 days)
Votes
0 []
StatusDocs not available [build log]
Last success reported on 2015-07-19 [all 1 reports]

Modules

Flags

NameDescriptionDefault
cairoinstall cairo-specific builder toolDisabled
svginstall svg-specific builder toolDisabled
psinstall postscript-specific builder toolDisabled
postscriptinstall postscript-specific builder toolDisabled
rasterificinstall rasterific-specific builder toolDisabled
pgfinstall PGF-specific builder toolDisabled

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

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for diagrams-builder-0.7.1.1

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.