A hardline is always laid out as a line break, even when 'grouped or when there is plenty of space. Note that it might still be simply discarded if it is part of a 'FlatAlt' inside a 'Group'.

LineOrSpace is a line-break, but behaves like Char(' ') if the line break is undone by Group

LineOrEmpty is a line-break, but behaves like Empty if the line break is undone by Group

softline behaves like space if the resulting output fits the page, otherwise like line

softline behaves like Empty if the resulting output fits the page, otherwise like line

Group tries laying out doc into a single line by removing the contained line breaks; if this does not fit the page, or when a 'hardline' within doc prevents it from being flattened, doc is laid out without any changes.

The 'group' function is key to layouts that adapt to available space nicely.

Align lays out the document with the nesting level set to the current column. It is used for example to implement 'hang'.

As an example, we will put a document right above another one, regardless of the current nesting level. Without alignment, the second line is put simply below everything we've had so far,

Text("lorem") + VertSep(["ipsum", "dolor"])

lorem ipsum dolor

If we add an Align to the mix, the VertSep contents all start in the same column,

Text("lorem") + Align (VertSep(["ipsum", "dolor"])) lorem ipsum dolor

Hang lays out the document with a nesting level set to the /current column/ plus offset. Negative values are allowed, and decrease the nesting level accordingly.

var doc = Reflow("Indenting these words with hang") PutDocW(24, ("prefix" + Hang(4, doc))) prefix Indenting these words with hang

This differs from Nest, which is based on the /current nesting level/ plus offset. When you're not sure, try the more efficient 'nest' first. In our example, this would yield

var doc = Reflow("Indenting these words with nest") PutDocW(24, "prefix" + Nest(4, doc)) prefix Indenting these words with nest

Indents document indent columns, starting from the current cursor position.

var doc = Reflow("The indent function indents these words!") PutDocW(24, ("prefix" + Indent(4, doc)) prefix The indent function indents these words!

Delimit and intersperse the documents with a separator

Delimit and intersperse the documents with a separator

Haskell-inspired array/list formatting

Haskell-inspired tuple formatting

Haskell-inspired array/list formatting

Haskell-inspired tuple formatting

Insert a number of spaces. Negative values count as 0.

HorizSep concatenates all documents horizontally with + i.e. it puts a space between all entries.

HorizSep does not introduce line breaks on its own, even when the page is too narrow:

For automatic line breaks, consider using 'fillSep' instead.

VertSep concatenates all documents above each other. If a Group undoes the line breaks inserted by VertSep, the documents are separated with a 'space' instead.

Grouping a VertSep separates the documents with a 'space' if it fits the page (and does nothing otherwise). See the Sep convenience function for this use case.

The Align function can be used to align the documents under their first element:

Since Grouping a VertSep is rather common, Sep is a built-in for doing that.

Intersperse the documents with a separator

Sep tries laying out the documents separated with 'space's, and if this does not fit the page, separates them with newlines. This is what differentiates it from VerSep, which always lays out its contents beneath each other.

FillSep concatenates the documents horizontally with + (inserting a space) as long as it fits the page, then inserts a Line and continues doing that for all documents in (Line means that if Grouped, the documents are separated with a Space instead of newlines. Use 'FillCat' if you do not want a 'space'.)

Hard line separator

HorizCat concatenates all documents horizontally with | (i.e. without any spacing).

It is provided only for consistency, since it is identical to 'Cat'.

VertCat vertically concatenates the documents. If it is Grouped, the line breaks are removed.

In other words VertCat is like VertSep, with newlines removed instead of replaced by spaces.

Width lays out the document 'doc', and makes the column width of it available to a function.

Fill lays out the document. It then appends spaces until the width is equal to width. If the width is already larger, nothing is appended.

Enclose

A hardline is always laid out as a line break, even when 'grouped or when there is plenty of space. Note that it might still be simply discarded if it is part of a 'FlatAlt' inside a 'Group'.

LineOrSpace is a line-break, but behaves like space if the line break is undone by Group

LineOrEmpty is a line-break, but behaves like Empty if the line break is undone by Group

softline behaves like space if the resulting output fits the page, otherwise like line

softline behaves like Empty if the resulting output fits the page, otherwise like line

Group tries laying out doc into a single line by removing the contained line breaks; if this does not fit the page, or when a 'hardline' within doc prevents it from being flattened, doc is laid out without any changes.

The 'group' function is key to layouts that adapt to available space nicely.

Align lays out the document with the nesting level set to the current column. It is used for example to implement 'hang'.

As an example, we will put a document right above another one, regardless of the current nesting level. Without alignment, the second line is put simply below everything we've had so far,

Text("lorem") + VertSep(["ipsum", "dolor"])

lorem ipsum dolor

If we add an 'Align' to the mix, the VertSep's contents all start in the same column,

Text("lorem") + Align (VertSep(["ipsum", "dolor"])) lorem ipsum dolor

Hang lays out the document with a nesting level set to the /current column/ plus offset. Negative values are allowed, and decrease the nesting level accordingly.

var doc = Reflow("Indenting these words with hang") PutDocW(24, ("prefix" + Hang(4, doc))) prefix Indenting these words with hang

This differs from Nest, which is based on the /current nesting level/ plus offset. When you're not sure, try the more efficient 'nest' first. In our example, this would yield

var doc = Reflow("Indenting these words with nest") PutDocW(24, "prefix" + Nest(4, doc)) prefix Indenting these words with nest

Indents document indent columns, starting from the current cursor position.

var doc = Reflow("The indent function indents these words!") PutDocW(24, ("prefix" + Indent(4, doc)) prefix The indent function indents these words!

Intersperse the documents with a separator

Delimit and intersperse the documents with a separator

Delimit and intersperse the documents with a separator

Haskell-inspired array/list formatting

Haskell-inspired tuple formatting

Haskell-inspired array/list formatting

Haskell-inspired tuple formatting

Insert a number of spaces. Negative values count as 0.

HorizSep concatenates all documents horizontally with + i.e. it puts a space between all entries.

HorizSep does not introduce line breaks on its own, even when the page is too narrow:

For automatic line breaks, consider using 'fillSep' instead.

VertSep concatenates all documents above each other. If a Group undoes the line breaks inserted by VertSep, the documents are separated with a 'space' instead.

Grouping a VertSep separates the documents with a 'space' if it fits the page (and does nothing otherwise). See the Sep convenience function for this use case.

The Align function can be used to align the documents under their first element:

Since Grouping a VertSep is rather common, Sep is a built-in for doing that.

Sep tries laying out the documents separated with 'space's, and if this does not fit the page, separates them with newlines. This is what differentiates it from VerSep, which always lays out its contents beneath each other.

FillSep concatenates the documents horizontally with + (inserting a space) as long as it fits the page, then inserts a Line and continues doing that for all documents in (Line means that if Grouped, the documents are separated with a Space instead of newlines. Use 'FillCat' if you do not want a 'space'.)

Hard line separator

HorizCat concatenates all documents horizontally with | (i.e. without any spacing).

It is provided only for consistency, since it is identical to 'Cat'.

VertCat vertically concatenates the documents. If it is Grouped, the line breaks are removed.

In other words VertCat is like VertSep, with newlines removed instead of replaced by spaces.

Width lays out the document 'doc', and makes the column width of it available to a function.

Fill lays out the document. It then appends spaces until the width is equal to width. If the width is already larger, nothing is appended.

Enclose