Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.JSON.Helpers

Description

Defines helper functions for creating jupyter notebooks.

Synopsis

data Variation
- = Class
- | Id
tr :: Doc -> Doc
td :: Doc -> Doc
figure :: Doc -> Doc
li :: Doc -> Doc
pa :: Doc -> Doc
ba :: Doc -> Doc
ol :: [String] -> Doc -> Doc
ul :: [String] -> Doc -> Doc
table :: [String] -> Doc -> Doc
nbformat :: Doc -> Doc
escapeStringForJson :: String -> String
codeformat :: Doc -> Doc
wrap :: String -> [String] -> Doc -> Doc
wrap' :: String -> [String] -> Doc -> Doc
wrapGen' :: ([Doc] -> Doc) -> Variation -> String -> Doc -> [String] -> Doc -> Doc
refwrap :: Doc -> Doc -> Doc
refID :: Doc -> Doc
reflink :: String -> Doc -> Doc
reflinkURI :: String -> Doc -> Doc
image :: Doc -> Doc -> MaxWidthPercent -> Doc
h :: Int -> Doc
br :: Doc -> Doc
mkDiv :: String -> Doc -> Doc -> Doc
stripnewLine :: String -> Doc
markdownB :: Doc
markdownB' :: Doc
markdownE :: Doc
markdownE' :: Doc
codeB :: Doc
codeE :: Doc
markdownCell :: Doc -> Doc
codeCell :: Doc -> Doc
makeMetadata :: Doc

Documentation

data Variation Source #

Constructors

Class
Id

tr :: Doc -> Doc Source #

Table row tag wrapper

td :: Doc -> Doc Source #

Table cell tag wrapper

figure :: Doc -> Doc Source #

Figure tag wrapper

li :: Doc -> Doc Source #

List tag wrapper

pa :: Doc -> Doc Source #

Paragraph in list tag wrapper

ba :: Doc -> Doc Source #

Bring attention to element wrapper.

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

Ordered list tag wrapper

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

Unordered list tag wrapper

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

Table tag wrapper

nbformat :: Doc -> Doc Source #

escapeStringForJson :: String -> String Source #

codeformat :: Doc -> Doc Source #

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

wrap' :: String -> [String] -> Doc -> Doc Source #

wrapGen' :: ([Doc] -> Doc) -> Variation -> String -> Doc -> [String] -> Doc -> Doc Source #

refwrap :: Doc -> Doc -> Doc Source #

refID :: Doc -> Doc Source #

reflink :: String -> Doc -> Doc Source #

Helper for setting up links to references

reflinkURI :: String -> Doc -> Doc Source #

Helper for setting up links to external URIs

image :: Doc -> Doc -> MaxWidthPercent -> Doc Source #

Helper for setting up figures

h :: Int -> Doc Source #

br :: Doc -> Doc Source #

Curly braces.

mkDiv :: String -> Doc -> Doc -> Doc Source #

stripnewLine :: String -> Doc Source #

markdownB :: Doc Source #

Helper for building Markdown cells

markdownB' :: Doc Source #

Helper for building Markdown cells

markdownE :: Doc Source #

Helper for building Markdown cells

markdownE' :: Doc Source #

Helper for building Markdown cells

codeB :: Doc Source #

Helper for building code cells

codeE :: Doc Source #

Helper for building code cells

markdownCell :: Doc -> Doc Source #

Helper for generate a Markdown cell

codeCell :: Doc -> Doc Source #

Helper for generate a code cell

makeMetadata :: Doc Source #

Generate the metadata necessary for a notebook document.