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

Description

Defines types and functions to gather all the information needed for printing.

Synopsis

data PrintingInformation
data Notation
- = Scientific
- | Engineering
sysdb :: Lens' PrintingInformation ChunkDB
refTable :: Lens' PrintingInformation (Map UID Reference)
stg :: Lens' PrintingInformation Stage
notation :: Lens' PrintingInformation Notation
lbldCntnt :: Lens' PrintingInformation [LabelledContent]
piSys :: ChunkDB -> Map UID Reference -> Stage -> Notation -> [LabelledContent] -> PrintingInformation
refFind :: UID -> PrintingInformation -> Reference

Documentation

data PrintingInformation Source #

Printing information contains a database, a stage, and a printing configuration.

data Notation Source #

Notation can be scientific or for engineering.

Constructors

Scientific
Engineering

sysdb :: Lens' PrintingInformation ChunkDB Source #

refTable :: Lens' PrintingInformation (Map UID Reference) Source #

stg :: Lens' PrintingInformation Stage Source #

notation :: Lens' PrintingInformation Notation Source #

lbldCntnt :: Lens' PrintingInformation [LabelledContent] Source #

piSys :: ChunkDB -> Map UID Reference -> Stage -> Notation -> [LabelledContent] -> PrintingInformation Source #

Builds a document's printing information based on the system information.

refFind :: UID -> PrintingInformation -> Reference Source #