Data.Graph.Analysis.Reporting

Document is the simplified representation of a document. Note that this just specifies a document layout, and not an implementation. To actually create a "physical" document, you must use an instance of DocumentGenerator.

data Document

Source

Representation of a document. The document is to be stored in the directory rootDirectory, and the main file is to have a filename of fileFront <.> (docExtension dg), where dg is an instance of DocumentGenerator.

Constructors

Doc

rootDirectory :: FilePath	Document location
fileFront :: String
graphDirectory :: FilePath	The sub-directory of `rootDirectory`, where graphs are to be created.
title :: DocInline	Pre-matter
author :: String
date :: String
legend :: [(DocGraph, DocInline)]	Main-matter
content :: [DocElement]

class DocumentGenerator dg where

Source

Represents the class of document generators.

Methods

createDocument :: dg -> Document -> IO (Maybe FilePath)

Source

Convert idealised Document values into actual documents, returning the document file created.

docExtension :: dg -> String

Source

The extension of all document-style files created. Note that this doesn't preclude the creation of other files, e.g. images.

Instances

DocumentGenerator PandocDocument

data Location

Source

Representation of a location, either on the internet or locally.

Constructors

Web String
File FilePath

Instances

Show Location

data DocElement

Source

Elements of a document.

Constructors

Section DocInline [DocElement]
Paragraph [DocInline]
Enumeration [DocElement]
Itemized [DocElement]
Definitions [(DocInline, DocInline)]
GraphImage DocGraph

data DocInline

Source

Inline elements of a document.

Constructors

Text String
BlankSpace
Grouping [DocInline]
Bold DocInline
Emphasis DocInline
DocLink DocInline Location
DocImage DocInline Location

data GraphSize

Source

Specify the size the DotGraph should be at.

Constructors

GivenSize Point	Specify the size to use.
DefaultSize	Let GraphViz choose an appropriate size.

type DocGraph = (FilePath, DocInline, DotGraph Node)

Source

Specify the DotGraph to turn into an image, its filename (sans extension) and its caption. The DotGraph should not have a Size set.

Helper functions

Utility functions to help with document creation.

addLegend :: FilePath -> FilePath -> Document -> IO Document

Source

Create the legend section and add it to the document proper.

today :: IO String

Source

Return today's date as a string, e.g. "Monday 1 January, 2000". This arbitrary format is chosen as there doesn't seem to be a way of determining the correct format as per the user's locale settings.

tryCreateDirectory :: FilePath -> IO Bool

Source

Attempts to create the specified directly, returning True if successful (or if the directory already exists), False if an error occurred.

createGraph :: FilePath -> FilePath -> GraphSize -> Maybe GraphSize -> DocGraph -> IO (Maybe DocElement)

Source

Attempts to creates a png file (with the given filename in the given directory) from the graph using the given attributes. If the second set of attributes is not Nothing, then the first image links to the second. The whole result is wrapped in a Paragraph.

createSize :: Double -> GraphSize

Source

Using a 6:4 ratio, create the given Point representing width,height from the width.

unDotPath :: FilePath -> FilePath

Source

Replace all . with - in the given FilePath, since some output formats (e.g. LaTeX) don't like extraneous .'s in the filename.

Produced by Haddock version 2.4.2