Liking cljdoc? Tell your friends :D

clj-string-layout.presets

Built-in layout configuration maps for common text, CSV/TSV, Markdown, and HTML tables.

Presets are plain layout config maps that can be passed to layout, layout-str, or layout-seq. They can also be assoc'ed with options such as :width, :display-width, :col-widths, or :raw?. Markup and separated-value presets emit cell contents verbatim; use clj-string-layout.escape for untrusted data.

Built-in layout configuration maps for common text, CSV/TSV, Markdown, and HTML tables.

Presets are plain layout config maps that can be passed to layout, layout-str,
or layout-seq. They can also be assoc'ed with options such as :width,
:display-width, :col-widths, or :raw?. Markup and separated-value presets emit
cell contents verbatim; use clj-string-layout.escape for untrusted data.
raw docstring

layout-ascii-box-centerclj

Unicode box-drawing table with centered cells.

Uses single-line box characters and sizes columns from the input data.

Unicode box-drawing table with centered cells.

Uses single-line box characters and sizes columns from the input data.
sourceraw docstring

layout-ascii-box-fill-centerclj

Width-filling Unicode box-drawing table with centered cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling Unicode box-drawing table with centered cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-ascii-box-fill-leftclj

Width-filling Unicode box-drawing table with left-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling Unicode box-drawing table with left-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-ascii-box-fill-rightclj

Width-filling Unicode box-drawing table with right-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling Unicode box-drawing table with right-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-ascii-box-leftclj

Unicode box-drawing table with left-aligned cells.

Uses single-line box characters and sizes columns from the input data.

Unicode box-drawing table with left-aligned cells.

Uses single-line box characters and sizes columns from the input data.
sourceraw docstring

layout-ascii-box-rightclj

Unicode box-drawing table with right-aligned cells.

Uses single-line box characters and sizes columns from the input data.

Unicode box-drawing table with right-aligned cells.

Uses single-line box characters and sizes columns from the input data.
sourceraw docstring

layout-ascii-grid-centerclj

ASCII +---+ grid table with centered cells.

Uses only +, -, and | characters and sizes columns from the input data.

ASCII +---+ grid table with centered cells.

Uses only +, -, and | characters and sizes columns from the input data.
sourceraw docstring

layout-ascii-grid-fill-centerclj

Width-filling ASCII +---+ grid table with centered cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling ASCII +---+ grid table with centered cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-ascii-grid-fill-leftclj

Width-filling ASCII +---+ grid table with left-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling ASCII +---+ grid table with left-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-ascii-grid-fill-rightclj

Width-filling ASCII +---+ grid table with right-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling ASCII +---+ grid table with right-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-ascii-grid-leftclj

ASCII +---+ grid table with left-aligned cells.

Uses only +, -, and | characters and sizes columns from the input data.

ASCII +---+ grid table with left-aligned cells.

Uses only +, -, and | characters and sizes columns from the input data.
sourceraw docstring

layout-ascii-grid-rightclj

ASCII +---+ grid table with right-aligned cells.

Uses only +, -, and | characters and sizes columns from the input data.

ASCII +---+ grid table with right-aligned cells.

Uses only +, -, and | characters and sizes columns from the input data.
sourceraw docstring

layout-csvclj

Comma-separated values with verbatim cell contents.

Escape arbitrary values with clj-string-layout.escape/csv-cell before rendering. The layout itself only inserts commas between cells.

Comma-separated values with verbatim cell contents.

Escape arbitrary values with clj-string-layout.escape/csv-cell before
rendering. The layout itself only inserts commas between cells.
sourceraw docstring

layout-html-tableclj

HTML table skeleton that emits compact rows with verbatim cell contents.

Produces <table>, one <tr> per input row, and </table>. Cell values are placed inside <td> elements without escaping; use clj-string-layout.escape/html for untrusted values.

HTML table skeleton that emits compact rows with verbatim cell contents.

Produces <table>, one <tr> per input row, and </table>. Cell values are placed
inside <td> elements without escaping; use clj-string-layout.escape/html for
untrusted values.
sourceraw docstring

layout-html-table-readableclj

HTML table skeleton with left-aligned cell contents in the generated source.

Produces the same tags as layout-html-table, but pads cells in the source for readability. Cell values are not escaped automatically.

HTML table skeleton with left-aligned cell contents in the generated source.

Produces the same tags as layout-html-table, but pads cells in the source for
readability. Cell values are not escaped automatically.
sourceraw docstring

layout-markdown-centerclj

Markdown pipe table with centered columns.

Cell contents are emitted verbatim; escape untrusted values with clj-string-layout.escape/markdown-cell before rendering.

Markdown pipe table with centered columns.

Cell contents are emitted verbatim; escape untrusted values with
clj-string-layout.escape/markdown-cell before rendering.
sourceraw docstring

layout-markdown-fill-centerclj

Width-filling Markdown pipe table with centered columns.

Fill markers expand cell padding toward :width. Escape untrusted values with clj-string-layout.escape/markdown-cell before rendering.

Width-filling Markdown pipe table with centered columns.

Fill markers expand cell padding toward :width. Escape untrusted values with
clj-string-layout.escape/markdown-cell before rendering.
sourceraw docstring

layout-markdown-fill-leftclj

Width-filling Markdown pipe table with left-aligned columns.

Fill markers expand cell padding toward :width. Escape untrusted values with clj-string-layout.escape/markdown-cell before rendering.

Width-filling Markdown pipe table with left-aligned columns.

Fill markers expand cell padding toward :width. Escape untrusted values with
clj-string-layout.escape/markdown-cell before rendering.
sourceraw docstring

layout-markdown-fill-rightclj

Width-filling Markdown pipe table with right-aligned columns.

Fill markers expand cell padding toward :width. Escape untrusted values with clj-string-layout.escape/markdown-cell before rendering.

Width-filling Markdown pipe table with right-aligned columns.

Fill markers expand cell padding toward :width. Escape untrusted values with
clj-string-layout.escape/markdown-cell before rendering.
sourceraw docstring

layout-markdown-leftclj

Markdown pipe table with left-aligned columns.

Cell contents are emitted verbatim; escape untrusted values with clj-string-layout.escape/markdown-cell before rendering.

Markdown pipe table with left-aligned columns.

Cell contents are emitted verbatim; escape untrusted values with
clj-string-layout.escape/markdown-cell before rendering.
sourceraw docstring

layout-markdown-rightclj

Markdown pipe table with right-aligned columns.

Cell contents are emitted verbatim; escape untrusted values with clj-string-layout.escape/markdown-cell before rendering.

Markdown pipe table with right-aligned columns.

Cell contents are emitted verbatim; escape untrusted values with
clj-string-layout.escape/markdown-cell before rendering.
sourceraw docstring

layout-norton-commander-centerclj

Norton Commander-style table with centered cells.

Uses double outer borders and single interior separators.

Norton Commander-style table with centered cells.

Uses double outer borders and single interior separators.
sourceraw docstring

layout-norton-commander-fill-centerclj

Width-filling Norton Commander-style table with centered cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling Norton Commander-style table with centered cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-norton-commander-fill-leftclj

Width-filling Norton Commander-style table with left-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling Norton Commander-style table with left-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-norton-commander-fill-rightclj

Width-filling Norton Commander-style table with right-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.

Width-filling Norton Commander-style table with right-aligned cells.

Column padding uses fill markers so the rendered table expands toward :width.
sourceraw docstring

layout-norton-commander-leftclj

Norton Commander-style table with left-aligned cells.

Uses double outer borders and single interior separators.

Norton Commander-style table with left-aligned cells.

Uses double outer borders and single interior separators.
sourceraw docstring

layout-norton-commander-rightclj

Norton Commander-style table with right-aligned cells.

Uses double outer borders and single interior separators.

Norton Commander-style table with right-aligned cells.

Uses double outer borders and single interior separators.
sourceraw docstring

layout-org-leftclj

Org mode table with left-aligned cells.

Inserts a separator row after the first data row, making the first input row act as a header.

Org mode table with left-aligned cells.

Inserts a separator row after the first data row, making the first input row
act as a header.
sourceraw docstring

layout-org-rightclj

Org mode table with right-aligned cells.

Inserts a separator row after the first data row, making the first input row act as a header.

Org mode table with right-aligned cells.

Inserts a separator row after the first data row, making the first input row
act as a header.
sourceraw docstring

layout-pipe-separatedclj

Pipe-separated values with verbatim cell contents and no padding.

This is useful for compact text protocols or quick human-readable dumps. It is not a Markdown table; use the Markdown presets when a header separator row is needed.

Pipe-separated values with verbatim cell contents and no padding.

This is useful for compact text protocols or quick human-readable dumps. It is
not a Markdown table; use the Markdown presets when a header separator row is
needed.
sourceraw docstring

layout-plain-centerclj

Plain whitespace-separated columns with centered cells.

Uses two spaces between columns and no virtual header or border rows.

Plain whitespace-separated columns with centered cells.

Uses two spaces between columns and no virtual header or border rows.
sourceraw docstring

layout-plain-leftclj

Plain whitespace-separated columns with left-aligned cells.

Uses two spaces between columns and no virtual header or border rows.

Plain whitespace-separated columns with left-aligned cells.

Uses two spaces between columns and no virtual header or border rows.
sourceraw docstring

layout-plain-rightclj

Plain whitespace-separated columns with right-aligned cells.

Uses two spaces between columns and no virtual header or border rows.

Plain whitespace-separated columns with right-aligned cells.

Uses two spaces between columns and no virtual header or border rows.
sourceraw docstring

layout-psql-leftclj

PostgreSQL psql-style table with left-aligned cells.

Inserts a separator row after the first data row, making the first input row act as a header.

PostgreSQL psql-style table with left-aligned cells.

Inserts a separator row after the first data row, making the first input row
act as a header.
sourceraw docstring

layout-psql-rightclj

PostgreSQL psql-style table with right-aligned cells.

Inserts a separator row after the first data row, making the first input row act as a header.

PostgreSQL psql-style table with right-aligned cells.

Inserts a separator row after the first data row, making the first input row
act as a header.
sourceraw docstring

layout-rst-simpleclj

reStructuredText simple table layout.

Inserts top, header separator, and bottom rules. The first input row acts as a header. The output follows the simple-table shape and is best for cells that do not contain embedded line breaks.

reStructuredText simple table layout.

Inserts top, header separator, and bottom rules. The first input row acts as a
header. The output follows the simple-table shape and is best for cells that
do not contain embedded line breaks.
sourceraw docstring

layout-tsvclj

Tab-separated values with verbatim cell contents.

This preset does not escape tabs or line breaks inside cells. It is intended for already-normalized data or callers that perform their own escaping.

Tab-separated values with verbatim cell contents.

This preset does not escape tabs or line breaks inside cells. It is intended
for already-normalized data or callers that perform their own escaping.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close