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

Language.Drasil.Printers

Synopsis

HTML

Printer

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

Generate an HTML document from a Drasil Document.

CSS

genericCSS :: Doc Source #

Generic CSS used for stylizing the LayoutObj language when outputted in HTML format.

Markdown

Printer

Section Printers

Plain

Types

data SingleLine Source #

Data is either linear or not.

Constructors

OneLine 
MultiLine 

Functions

sentenceDoc :: SingleLine -> Spec -> Doc Source #

Create sentences for a document in Doc format.

exprDoc :: SingleLine -> Expr -> Doc Source #

Create expressions for a document in Doc format.

codeExprDoc :: SingleLine -> Expr -> Doc Source #

Create code expressions for a document in Doc format. assumes someone has already makde the code expression into an expression

symbolDoc :: Symbol -> Doc Source #

Create symbols for a document in Doc format.

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

Helper for printing units in Doc format.

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

Helper for printing a HasSymbol in Implementation Stage

TeX

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

Generates a LaTeX document.

Jupyter

genJupyterLessonPlan :: Document -> Doc ann Source #

Build the general Jupyter Notebook document.

genJupyterSRS :: Document -> Doc ann Source #

Build an SRS document in JSON format.

Markdown

genMDBook :: Project -> [FileLayout] Source #

Generate a mdBook SRS

Printing Information and Options

data PrintingInformation Source #

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

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

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

data Notation Source #

Notation can be scientific or for engineering.

Constructors

Scientific 
Engineering