The hang combinator implements hanging indentation. The document (hang i x y) either x and y concatenated with <+> or y below x with an additional indentation of i.

The hang combinator implements hanging indentation. The document (hang separator i x y) either x and y concatenated with <> text separator <> or y below x with an additional indentation of i.

The document (enclosure l r sep xs) concatenates the documents xs separated by sep and encloses the resulting document by l and r. The documents are rendered horizontally if that fits the page. Otherwise they are aligned vertically. All separators are put in front of the elements. For example, the combinator list can be defined with enclosure:

list xs = enclosure lbracket rbracket comma xs
test    = text "list" <+> (list (map int [10,200,3000]))

Which is layed out with a page width of 20 as:

list [10,200,3000]

But when the page width is 15, it is layed out as:

list [10
     ,200
     ,3000]

The document (list xs) comma separates the documents xs and encloses them in square brackets. The documents are rendered horizontally if that fits the page. Otherwise they are aligned vertically. All comma separators are put in front of the elements.

The document (tupled xs) comma separates the documents xs and encloses them in parenthesis. The documents are rendered horizontally if that fits the page. Otherwise they are aligned vertically. All comma separators are put in front of the elements.

The document (semiBraces xs) separates the documents xs with semi colons and encloses them in braces. The documents are rendered horizontally if that fits the page. Otherwise they are aligned vertically. All semi colons are put in front of the elements.

The document (x <+> y) concatenates document x and y with a space in between. (infixr 6)

The document (x $$> y) concatenates document x and y with a linebreak in between. (infixr 5)

The document (x </> y) puts x and y either next to each other (with a space in between) or underneath each other. (infixr 5)

The document (x <//> y) puts x and y either right next to each other (if x fits on a single line) or underneath each other. (infixr 5)

The document (x <$$> y) concatenates document x and y with a linebreak in between. (infixr 5)

The document (hsep xs) concatenates all documents xs horizontally with (<+>).

The document (sep xs) concatenates all documents xs either horizontally with (<+>), if it fits the page, or vertically with (<$$>). Documents on the left of horizontal concatenation must fit on a single line.

The document (hcat xs) concatenates all documents xs horizontally with (<>).

The document (vcat xs) concatenates all documents xs vertically with ($$).

The document (cat xs) concatenates all documents xs either horizontally with (<>), if it fits the page, or vertically with (<$$>).

(punctuate p xs) concatenates all documents in xs with document p except for the last document.

someText = map text ["words","in","a","tuple"]
test     = parens (align (cat (punctuate comma someText)))

This is layed out on a page width of 20 as:

(words,in,a,tuple)

But when the page width is 15, it is layed out as:

(words,
 in,
 a,
 tuple)

(If you want put the commas in front of their elements instead of at the end, you should use tupled or, in general, encloseSep.)

The document (enclose l r x) encloses document x between documents l and r using (<>).

Document (squotes x) encloses document x with single quotes "'".

Document (dquotes x) encloses document x with double quotes '"'.

Document (parens x) encloses document x in parenthesis, "(" and ")".

Document (angles x) encloses document x in angles, "<" and ">".

Document (braces x) encloses document x in braces, "{" and "}".

Document (brackets x) encloses document x in square brackets, "[" and "]".

The document lparen contains a left parenthesis, "(".

The document rparen contains a right parenthesis, ")".

The document langle contains a left angle, "<".

The document rangle contains a right angle, ">".

The document lbrace contains a left brace, "{".

The document rbrace contains a right brace, "}".

The document lbracket contains a left square bracket, "[".

The document rbracket contains a right square bracket, "]".

The document squote contains a single quote, "'".

The document dquote contains a double quote, '"'.

The document semi contains a semi colon, ";".

The document colon contains a colon, ":".

The document comma contains a comma, ",".

The document dot contains a single dot, ".".

The document backslash contains a back slash, "\".

The document equals contains an equal sign, "=".

The document (string s) concatenates all characters in s using line for newline characters and char for all other characters. It is used instead of text whenever the text contains newline characters.

The document (int i) shows the literal integer i using text.

The document (integer i) shows the literal integer i using text.

The document (float f) shows the literal float f using text.

The document (double d) shows the literal double d using text.

The document (rational r) shows the literal rational r using text.

Render the Doc into String omitting all annotations.

<> new annotation to the Doc.

Example: 'Any True' annotation will transform the rendered Doc into uppercase:

>>> let r = putStrLn . renderWith defaultOptions { optsAnnotate = \a x -> if a == Any True then map toUpper x else x }
>>> r $ text "hello" <$$> annotate (Any True) (text "world")
hello
WORLD