drasil-printers-0.1.10.0: A framework for code and document generation for scientific software - Printers SubPackage

Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.Printing.LayoutObj

Description

Defines types similar to content types in Language.Drasil but better suited for printing.

Synopsis

data Document = Document Title Author [LayoutObj]
data Project = Project Title Author RefMap [File]
data File = File Title Filename Depth [LayoutObj]
type Author = Spec
type Contents = Spec
type Items = [LayoutObj]
type Tags = [String]
type Depth = Int
type Width = Float
type Height = Float
type Filepath = String
type Filename = String
type Caption = Spec
type RefMap = Map String Filename
data LayoutObj
- = Table Tags [[Spec]] Label Bool Caption
- | Header Depth Title Label
- | Paragraph Contents
- | EqnBlock Contents
- | Definition DType [(String, [LayoutObj])] Label
- | List ListType
- | Figure Label (Maybe Caption) Filepath MaxWidthPercent
- | Graph [(Spec, Spec)] (Maybe Width) (Maybe Height) Caption Label
- | CodeBlock Contents
- | HDiv Tags [LayoutObj] Label
- | Cell [LayoutObj]
- | Bib BibRef

Documentation

data Document Source #

A document must contain a title, author, and contents (as LayoutObjs).

Constructors

Document Title Author [LayoutObj]

data Project Source #

A Project must contain a title, author, RefMap, and Files.

Constructors

Project Title Author RefMap [File]

data File Source #

A File must contain a title, filename, depth, and contents (as LayoutObjs).

Constructors

File Title Filename Depth [LayoutObj]

type Author = Spec Source #

An author is just a sentence (Spec).

type Contents = Spec Source #

Contents are just a sentence (Spec).

type Items = [LayoutObj] Source #

A group of layout objects.

type Tags = [String] Source #

Tags.

type Depth = Int Source #

Depth of a header.

type Width = Float Source #

Horizontal dimension of a graph.

type Height = Float Source #

Vertical dimension of a graph.

type Filepath = String Source #

Holds a file path.

type Filename = String Source #

Holds a file name.

type Caption = Spec Source #

A caption is just a sentence (Spec).

type RefMap = Map String Filename Source #

A mapping of refs to the file that contains them.

data LayoutObj Source #

Constructors

Table Tags [[Spec]] Label Bool Caption	Holds all information needed for a table.
Header Depth Title Label	Holds all information needed for a header.
Paragraph Contents	Paragraph.
EqnBlock Contents	Equation block.
Definition DType [(String, [LayoutObj])] Label	Definition. Holds the type, contents, and a label.
List ListType	List.
Figure Label (Maybe Caption) Filepath MaxWidthPercent	Holds all information needed for a figure.
Graph [(Spec, Spec)] (Maybe Width) (Maybe Height) Caption Label	Holds all information needed for a graph.
CodeBlock Contents	Code block.
HDiv Tags [LayoutObj] Label	Holds tags, more contents, and a label.
Cell [LayoutObj]
Bib BibRef	Bibliography section.