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

Language.Drasil.Printing.LayoutObj

Description

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

Synopsis

Documentation

data Document Source #

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

Constructors

Document Title Author [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 Caption = Spec Source #

A caption is just a sentence (Spec).

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 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.