Safe Haskell	None
Language	GHC2024

Language.Drasil.Printers

Contents

Document
HTML
- Printer
- CSS
Plain
- Types
- Renderers
TeX
Jupyter
Markdown
Printing Information and Options

Synopsis

makeDocument :: PrintingInformation -> Document -> Document
makeProject :: PrintingInformation -> Document -> Project
genHTML :: HTMLGenOptions -> String -> Document -> HTML
newtype HTMLGenOptions = HTMLGO {
- mathJaxSrc :: Text
}
defaultHTMLGO :: HTMLGenOptions
renderHTML :: HTMLRenderOptions -> HTML -> Doc ann
genericCSS :: Doc ann
data SingleLine
- = OneLine
- | MultiLine
oneLineCodeSymbolDoc :: HasSymbol x => x -> String
oneLineSentenceDoc :: PrintingInformation -> Sentence -> Doc
oneLineExprDoc :: PrintingInformation -> Expr -> Doc
oneLineCodeExprDoc :: PrintingInformation -> CodeExpr -> Doc
oneLineUnitDoc :: USymb -> Doc
genTeX :: Document -> ShowTableOfContents -> PrintingInformation -> Doc
genJupyterLessonPlan :: Document -> Doc ann
genJupyterSRS :: Document -> Doc ann
genMDBook :: Project -> [FileLayout]
data PrintingInformation
piSys :: ChunkDB -> Stage -> Notation -> PrintingInformation
data Notation
- = Scientific
- | Engineering

Document

makeDocument :: PrintingInformation -> Document -> Document Source #

Translates from Document to a printable representation of Document.

makeProject :: PrintingInformation -> Document -> Project Source #

Translates from Document to a printable representation of Project.

HTML

Printer

genHTML :: HTMLGenOptions -> String -> Document -> HTML Source #

Generate an HTML document from a Drasil Document. Arguments: Rendering options, CSS file name, Document to be rendered

newtype HTMLGenOptions Source #

Options for converting layout objects (LayoutObjs) into HTML AST

Constructors

HTMLGO
Fields mathJaxSrc :: Text

defaultHTMLGO :: HTMLGenOptions Source #

Default HTMLGenOptions using the standard MathJax CDN URL.

renderHTML :: HTMLRenderOptions -> HTML -> Doc ann #

Render HTML to a Doc

CSS

genericCSS :: Doc ann Source #

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

Plain

Types

data SingleLine Source #

Data is either linear or not.

Constructors

OneLine
MultiLine

Renderers

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

Render a symbol to a String on one line.

oneLineSentenceDoc :: PrintingInformation -> Sentence -> Doc Source #

Creates a OneLine Implementation-stage sentenceDoc.

oneLineExprDoc :: PrintingInformation -> Expr -> Doc Source #

Creates a OneLine Implementation-stage exprDoc.

oneLineCodeExprDoc :: PrintingInformation -> CodeExpr -> Doc Source #

oneLineUnitDoc :: USymb -> Doc Source #

Creates a OneLine unitDoc.

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