Graphalyze-0.4: Graph-Theoretic Analysis library. Source code Contents Index

Data.Graph.Analysis.Reporting Maintainer [email protected]

Contents Document representation Helper functions

Description

This module defines the report framework used.

Synopsis

data Document = Doc { rootDirectory :: FilePath fileFront :: String title :: DocInline author :: String date :: String content :: [DocElement] } class DocumentGenerator dg where createDocument :: dg -> Document -> IO (Maybe FilePath) docExtension :: dg -> String data Location = URL String | File FilePath data DocElement = Section DocInline [DocElement] | Paragraph [DocInline] | Enumeration [DocElement] | Itemized [DocElement] | Definition DocInline DocElement | DocImage DocInline Location | GraphImage DocGraph data DocInline = Text String | BlankSpace | Grouping [DocInline] | Bold DocInline | Emphasis DocInline | DocLink DocInline Location type DocGraph = (FilePath, DocInline, DotGraph) today :: IO String tryCreateDirectory :: FilePath -> IO Bool createGraph :: FilePath -> DocGraph -> IO (Maybe DocElement) maximumSize :: Attribute

Document representation

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 title :: DocInline Pre-matter author :: String date :: String content :: [DocElement] Main-matter

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 URL String File FilePath Instances Show Location

data DocElement Source

Elements of a document. Constructors Section DocInline [DocElement] Paragraph [DocInline] Enumeration [DocElement] Itemized [DocElement] Definition DocInline DocElement DocImage DocInline Location GraphImage DocGraph Instances Show DocElement

data DocInline Source

Constructors Text String BlankSpace Grouping [DocInline] Bold DocInline Emphasis DocInline DocLink DocInline Location Instances Show DocInline

type DocGraph = (FilePath, DocInline, DotGraph) Source

Helper functions

Utility functions to help with document creation.

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 -> DocGraph -> IO (Maybe DocElement) Source

Attempts to creates a png file (with the given filename in the given directory) and - if successful - returns a DocImage link.

maximumSize :: Attribute Source

The recommended maximum size for graphs.

Produced by Haddock version 2.1.0