Documentation

A document of height 1 containing a literal string. text satisfies the following laws:

• text s <> text t = text (s++t)

• text "" <> x = x, if x non-empty

The side condition on the last law is necessary because text "" has height 1, while empty has no height.

A TextDetails represents a fragment of text that will be output at some point in a Doc.

A document of height and width 1, containing a literal character.

Beside, separated by space, unless one of the arguments is empty. <+> is associative, with identity empty.

Above, except that if the last line of the first argument stops at least one position before the first line of the second begins, these two lines are overlapped. For example:

   text "hi" $$ nest 5 (text "there")

lays out as

   hi   there

rather than

   hi
        there

$$ is associative, with identity empty, and also satisfies

• (x $$ y) <> z = x $$ (y <> z), if y non-empty.

Rendering mode.

A rendering style. Allows us to specify constraints to choose among the many different rendering options.

The abstract type of documents. A Doc represents a set of layouts. A Doc with no occurrences of Union or NoDoc represents just one layout.

Same as text. Used to be used for Bytestrings.

Some text with any width. (text s = sizedText (length s) s)

Some text, but without any width. Use for non-printing text such as a HTML or Latex tags

List version of <>.

List version of $$.

Nest (or indent) a document by a given number of positions (which may also be negative). nest satisfies the laws:

• nest 0 x = x

• nest k (nest k' x) = nest (k+k') x

• nest k (x <> y) = nest k x <> nest k y

• nest k (x $$ y) = nest k x $$ nest k y

• nest k empty = empty

• x <> nest k y = x <> y, if x non-empty

The side condition on the last law is needed because empty is a left identity for <>.

hang d1 n d2 = sep [d1, nest n d2]

punctuate p [d1, ... dn] = [d1 <> p, d2 <> p, ... dn-1 <> p, dn]

Above, with no overlapping. $+$ is associative, with identity empty.

Either hsep or vcat.

Either hcat or vcat.

"Paragraph fill" version of cat.

"Paragraph fill" version of sep.

The default style (mode=PageMode, lineLength=100, ribbonsPerLine=1.5).

Render the Doc to a String using the given Style.

The general rendering interface. Please refer to the Style and Mode types for a description of rendering mode, line length and ribbons.

Render the Doc to a String using the default Style (see style).