Safe Haskell	None
Language	Haskell2010

Language.Drasil.Printers

Contents

Formats
DOT
- Types
- Functions
HTML
- Printer
- Helpers
Markdown
- Printer
- Section Printers
Plain
- Types
- Functions
TeX
Jupyter
Log
Printing Information and Options

Synopsis

data Format
- = TeX
- | HTML
- | JSON
data GraphInfo = GI {
- assumpNF :: NodeFamily
- ddNF :: NodeFamily
- gdNF :: NodeFamily
- tmNF :: NodeFamily
- imNF :: NodeFamily
- reqNF :: NodeFamily
- gsNF :: NodeFamily
- chgNF :: NodeFamily
- edgesAvsA :: [(UID, [UID])]
- edgesAvsAll :: [(UID, [UID])]
- edgesRefvsRef :: [(UID, [UID])]
- edgesAllvsR :: [(UID, [UID])]
- edgesAllvsAll :: [(UID, [UID])]
}
data NodeFamily = NF {
- nodeUIDs :: [UID]
- nodeLabels :: [Label]
- nfLabel :: Label
- nfColour :: Colour
}
outputDot :: FilePath -> GraphInfo -> IO ()
genHTML :: PrintingInformation -> String -> Document -> Doc
makeCSS :: Document -> Doc
makeMd :: [Doc] -> Doc
introInfo :: String -> [String] -> Doc
verInfo :: String -> String -> Doc
unsupOS :: Maybe String -> Doc
regularSec :: Doc -> Doc -> Doc
instDoc :: [String] -> Doc
extLibSec :: [(String, String)] -> [String] -> Doc
endNote :: [String] -> Doc
data Linearity
- = Linear
- | Nonlinear
sentenceDoc :: ChunkDB -> Stage -> Linearity -> Sentence -> Doc
exprDoc :: ChunkDB -> Stage -> Linearity -> Expr -> Doc
codeExprDoc :: ChunkDB -> Stage -> Linearity -> CodeExpr -> Doc
symbolDoc :: Symbol -> Doc
unitDoc :: Linearity -> USymb -> Doc
showSymb :: Symbol -> String
showHasSymbImpl :: HasSymbol x => x -> String
genTeX :: Document -> PrintingInformation -> Doc
genJSON :: PrintingInformation -> Document -> Doc
printAllDebugInfo :: PrintingInformation -> [Doc]
data PrintingInformation = PI {
- _ckdb :: ChunkDB
- _stg :: Stage
- _configuration :: PrintingConfiguration
}
piSys :: SystemInformation -> Stage -> PrintingConfiguration -> PrintingInformation
class HasPrintingOptions c where
- getSetting :: Lens' c Notation
data Notation
- = Scientific
- | Engineering
defaultConfiguration :: PrintingConfiguration

Formats

data Format Source #

Possible formats for printer output.

Constructors

TeX
HTML
JSON

DOT

Types

data GraphInfo Source #

Holds all important and relevant information for generating a traceability graph. Includes nodes, graph edges, and node family information.

Constructors

GI

Fields

assumpNF :: NodeFamily
Assumptions.
ddNF :: NodeFamily
Data definitions.
gdNF :: NodeFamily
General definitions.
tmNF :: NodeFamily
Theory models.
imNF :: NodeFamily
Instance models.
reqNF :: NodeFamily
Requirements (both functional and non-functional).
gsNF :: NodeFamily
Goal statement.
chgNF :: NodeFamily
Changes (both likely and unlikely).
edgesAvsA :: [(UID, [UID])]
Assumptions dependent on assumptions.
edgesAvsAll :: [(UID, [UID])]
Definitions, models, requirements, and changes dependent on assumptions.
edgesRefvsRef :: [(UID, [UID])]
Definitions and models that are dependent on other definitions and models.
edgesAllvsR :: [(UID, [UID])]
Goals and requirements dependent on definitions, models, and other requirements.
edgesAllvsAll :: [(UID, [UID])]
Definitions, models, requirements, goals, and changes that are dependent on one another.

data NodeFamily Source #

A node family contains a list of UIDs, their display labels, general subgraph label, and colour.

Constructors

NF
Fields nodeUIDs :: [UID] Node `UID`s. nodeLabels :: [Label] Display labels for nodes. We use the reference addresses from the `UID`s. nfLabel :: Label Individual subgraph labels. These labels do not show on the final generated pdf or png files. nfColour :: Colour Gives the ability to change colours of bubbles within the graph.

Functions

outputDot :: FilePath -> GraphInfo -> IO () Source #

Creates the directory for output, gathers all individual graph output functions and calls them.

HTML

Printer

genHTML :: PrintingInformation -> String -> Document -> Doc Source #

Generate an HTML document from a Drasil Document.

Helpers

makeCSS :: Document -> Doc Source #

Generates the CSS selectors necessary for a document.

Markdown

Printer

makeMd :: [Doc] -> Doc Source #

Combines a list of sentences into a final Doc, also appends end note.

Section Printers

introInfo :: String -> [String] -> Doc Source #

Example title and purpose section.

verInfo :: String -> String -> Doc Source #

Language version section.

unsupOS :: Maybe String -> Doc Source #

Invalid Operating Systems section, does not display unless atleast 1 invalid OS.

regularSec :: Doc -> Doc -> Doc Source #

Constructs regular section section from header and message.

instDoc :: [String] -> Doc Source #

Instruction section, contains 3 paragraphs, Running, Building and Config Files. The Config file section is only displayed if there are configuration files.

extLibSec :: [(String, String)] -> [String] -> Doc Source #

External Libraries section. The inputs are a list of name and version pairs and a list of the corresponding version numbers, these are first combined into a list of triplets, and then each printed on a new line.

endNote :: [String] -> Doc Source #

End section.

Plain

Types

data Linearity Source #

Data is either linear or not.

Constructors

Linear
Nonlinear

Functions

sentenceDoc :: ChunkDB -> Stage -> Linearity -> Sentence -> Doc Source #

Create sentences for a document in Doc format.

exprDoc :: ChunkDB -> Stage -> Linearity -> Expr -> Doc Source #

Create expressions for a document in Doc format.

codeExprDoc :: ChunkDB -> Stage -> Linearity -> CodeExpr -> Doc Source #

Create code expressions for a document in Doc format.

symbolDoc :: Symbol -> Doc Source #

Create symbols for a document in Doc format.

unitDoc :: Linearity -> USymb -> Doc Source #

Helper for printing units in Doc format.

showSymb :: Symbol -> String Source #

Helper for printing Symbols

showHasSymbImpl :: HasSymbol x => x -> String Source #

Helper for printing a HasSymbol in Implementation Stage

TeX

genTeX :: Document -> PrintingInformation -> Doc Source #

Generates a LaTeX document.

Jupyter

genJSON :: PrintingInformation -> Document -> Doc Source #

Generate a python notebook document (using json).

Log

printAllDebugInfo :: PrintingInformation -> [Doc] Source #

Gathers all printing functions and creates the debugging tables from them.

Printing Information and Options

data PrintingInformation Source #

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

Constructors

PI
Fields _ckdb :: ChunkDB _stg :: Stage _configuration :: PrintingConfiguration

Instances

Instances details

HasPrintingOptions PrintingInformation Source #	Finds the notation used for the `PrintingConfiguration` within the `PrintingInformation`.
Instance details Defined in Language.Drasil.Printing.PrintingInformation Methods getSetting :: Lens' PrintingInformation Notation Source #

piSys :: SystemInformation -> Stage -> PrintingConfiguration -> PrintingInformation Source #

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

class HasPrintingOptions c where Source #

Able to be printed.

Methods

getSetting :: Lens' c Notation Source #

Holds the printing notation.

Instances

Instances details

HasPrintingOptions PrintingConfiguration Source #	Finds the notation used for the `PrintingConfiguration`.
Instance details Defined in Language.Drasil.Printing.PrintingInformation Methods getSetting :: Lens' PrintingConfiguration Notation Source #
HasPrintingOptions PrintingInformation Source #	Finds the notation used for the `PrintingConfiguration` within the `PrintingInformation`.
Instance details Defined in Language.Drasil.Printing.PrintingInformation Methods getSetting :: Lens' PrintingInformation Notation Source #

data Notation Source #

Notation can be scientific or for engineering.

Constructors

Scientific
Engineering

defaultConfiguration :: PrintingConfiguration Source #

Default configuration is for engineering.