Documentation

Newline

nl == 'text' "\n"

text == 'ElText'

Wrap [BBCode] in ElDocument

Horizontal line

hr == 'ElVoid' 'HR'

Line break

br == 'ElVoid' 'BR'

clear == 'ElVoid' 'Clear'

Notice it is not a function, but a value.

listEl represents "[*]"

listEl == 'ElVoid' 'ListElement'

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

Code element contains plain text

Preformatted element contains plain text

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

Takes image URL

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

Each element of list is prepended with listElement, meaning you can't create list with contents but without elements

>>> list [bold "10", italic "15"]
ElSimple List (ElDocument [ElVoid ListElement,ElSimple Bold (ElText "10"),ElVoid ListElement,ElSimple Italic (ElText "15")])

Like box but with alignment argument

Like image but with alignment argument

Named quote

Named spoiler

Ordered list

>>> listFlavor LatinUpper [bold "I am bald", boxAlign BoxRight "get boxxxed"]
ElArg List "A" (ElDocument [ElVoid ListElement,ElSimple Bold (ElText "I am bald"),ElVoid ListElement,ElArg Box "right" (ElText "get boxxxed")])

Change color of inner BBCode First argument is either color name (e.g. blue) or hex color(e.g. #333 or #151515)

Create a hyperlink

first argument is expected to be valid URL

Change font size of inner bbcode

arg ∈ [10, 29] and arg is natural

Change font of inner BBCode

argument should be a valid font name

BBCode AST

Type of an element. BBCode declares three constructors for elements: ElVoid, ElSimple, ElArg. But El can be split into four cateogories: 1) void elements, 2) simple elements, 3) elements with optional argument, 4) element with one argument

There is no enforcement of combining BBCode constuctors and El values, that means you can create ElSimple HR (ElText "smth") but that would make no sense. pretty would emit a runtime error if you try to pass such value.

Used for building BBCode safely. Instead of passing Text to builder functions, you pass values of types that implement IsArgument. Then toArgument is used to convert that value to Text.

Argument to align

Argument to listFlavor

Argument to imageAlign

Argument to boxAlign

Serialize BBCode AST

Should be reversible by parsing, but it is not guaranteed

Can cause error at runtime if unrepresentable element is passed, e.g. >>> pretty $ ElSimple HR "abc" Prelude.undefined

Parse zero or more BBCode elements Doesn't necessarily return value wrapped in ElDocument, it returns (mempty :: BBCode) if it parses no elements, or just element if parses just one element. Otherwise it is ElDocument

parseMaybe specialized for Parser