The BlogLiterately-diagrams package

[ Tags: bsd3, library, program, web ] [ Propose Tags ]

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:

Properties

Versions 0.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, 0.2, 0.2.0.1, 0.2.0.2, 0.2.0.3, 0.2.0.4, 0.2.0.5
Change log CHANGES
Dependencies base (>=4.3 && <4.7), BlogLiterately (==0.6.*), BlogLiterately-diagrams, containers, diagrams-builder (>=0.2 && <0.5), diagrams-cairo (>=0.6 && <0.8), diagrams-lib (>=0.6 && <0.8), directory, filepath, pandoc (>=1.9 && <1.12), safe (==0.3.*) [details]
License BSD3
Copyright Copyright 2012 Brent Yorgey
Author Brent Yorgey
Maintainer byorgey@cis.upenn.edu
Category Web
Bug tracker http://hub.darcs.net/byorgey/BlogLiterately-diagrams/issues
Source repository head: darcs get http://hub.darcs.net/byorgey/BlogLiterately-diagrams
Uploaded Fri Aug 9 01:30:49 UTC 2013 by BrentYorgey
Distributions LTSHaskell:0.2.0.5, NixOS:0.2.0.5, Tumbleweed:0.2.0.5
Executables BlogLiteratelyD
Downloads 6365 total (485 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees