The BlogLiterately-diagrams package

[Tags: bsd3, library, program]

A plugin for BlogLiterately (http://hackage.haskell.org/package/BlogLiterately) which turns inline diagrams code into images. This library also provides an executable, BlogLiteratelyD, providing a standard instance of BlogLiterately extended with support for inline diagrams code. For most users it should suffice to simply use BlogLiteratelyD in place of BlogLiterately.

To use it, include code blocks with the dia or dia-def class (using pandoc's special extended Markdown syntax (http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html), or BlogLiterately's extended syntax for tagged code blocks (http://byorgey.wordpress.com/blogliterately/)), like so:

     [dia-def]
     -- This block produces no output but its
     -- declarations will be in scope in all the
     -- rest of the diagram blocks.

     gSq = square 1 # fc green

 NOTE: Square brackets below should be replaced
 by curly braces.  Haddock chokes on curly
 braces.

 Here is a green square:

 ```[.dia width='200']
 dia = gSq
 ```

 Green squares like `gSq`[.dia height='16']
 and blue circles like `circle 1 # fc blue`[.dia height='16']
 are extremely important.

Note that attributes like width and height can also be specified, but be sure to put the numbers in quotes or else they will not parse properly.

Running this through BlogLiteratelyD (after replacing square brackets with curly braces) should result in HTML that looks something like this:

In addition to simple diagrams, IO actions producing diagrams may also be used. In that case the IO action will simply be run, and the resulting diagram rendered. This can be useful, for example, when producing a diagram built from some external data or using randomness.


Properties

Versions0.1.0.0, 0.1.0.1, 0.1.1, 0.1.1.1, 0.1.1.2, 0.1.2, 0.1.2.1, 0.1.2.2, 0.1.2.3, 0.1.2.4, 0.1.3, 0.1.3.1, 0.1.4, 0.1.4.1, 0.1.4.2, 0.1.4.3
Dependenciesbase (>=4.3 && <4.8), BlogLiterately (>=0.6 && <0.8), BlogLiterately-diagrams, containers, diagrams-builder (>=0.5 && <0.7), diagrams-cairo (>=1.0.1 && <1.3), diagrams-lib (>=1.0.1 && <1.3), directory, filepath, pandoc (>=1.9 && <1.14), safe (==0.3.*)
LicenseBSD3
CopyrightCopyright 2012 Brent Yorgey
AuthorBrent Yorgey
Maintainerbyorgey@cis.upenn.edu
CategoryWeb
Bug trackerhttp://github.com/byorgey/BlogLiterately-diagrams/issues
Source repositoryhead: git clone git://github.com/byorgey/BlogLiterately-diagrams.git
ExecutablesBlogLiteratelyD
Upload dateWed Aug 27 02:13:42 UTC 2014
Uploaded byBrentYorgey
Downloads2017 total (241 in last 30 days)

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees