Liking cljdoc? Tell your friends :D

clj-string-layout.layout

Compatibility namespace that re-exports the historical public API.

Earlier versions exposed both predicates and built-in layout maps from this namespace. New code should require clj-string-layout.predicates and clj-string-layout.presets directly for clearer intent. Existing code can continue to use the aliases below.

Each alias is generated programmatically from the corresponding source var so the file stays small as new presets are added.

Compatibility namespace that re-exports the historical public API.

Earlier versions exposed both predicates and built-in layout maps from this
namespace. New code should require clj-string-layout.predicates and
clj-string-layout.presets directly for clearer intent. Existing code can
continue to use the aliases below.

Each alias is generated programmatically from the corresponding source var so
the file stays small as new presets are added.
raw docstring

all-cols?clj

Compatibility alias for clj-string-layout.predicates/all-cols?.

Returns true for every data column.

Compatibility alias for clj-string-layout.predicates/all-cols?.

Returns true for every data column.
sourceraw docstring

all-rows?clj

Compatibility alias for clj-string-layout.predicates/all-rows?.

Returns true for every virtual row.

Compatibility alias for clj-string-layout.predicates/all-rows?.

Returns true for every virtual row.
sourceraw docstring

first-col?clj

Compatibility alias for clj-string-layout.predicates/first-col?.

Returns true for the first data column.

Use with :repeat-for in column layout specs. Receives [idx last-idx] and matches idx 0.

Compatibility alias for clj-string-layout.predicates/first-col?.

Returns true for the first data column.

  Use with :repeat-for in column layout specs. Receives [idx last-idx] and
  matches idx 0.
sourceraw docstring

first-row?clj

Compatibility alias for clj-string-layout.predicates/first-row?.

Returns true for the virtual row before the first data row.

Use with :apply-for in row layout specs. Receives [idx last-idx] and matches idx 0.

Compatibility alias for clj-string-layout.predicates/first-row?.

Returns true for the virtual row before the first data row.

  Use with :apply-for in row layout specs. Receives [idx last-idx] and matches
  idx 0.
sourceraw docstring

interior-col?clj

Compatibility alias for clj-string-layout.predicates/interior-col?.

Returns true for data columns that are neither first nor last.

Compatibility alias for clj-string-layout.predicates/interior-col?.

Returns true for data columns that are neither first nor last.
sourceraw docstring

interior-row?clj

Compatibility alias for clj-string-layout.predicates/interior-row?.

Returns true for virtual rows between data rows.

Does not match the first or last virtual row.

Compatibility alias for clj-string-layout.predicates/interior-row?.

Returns true for virtual rows between data rows.

  Does not match the first or last virtual row.
sourceraw docstring

last-col?clj

Compatibility alias for clj-string-layout.predicates/last-col?.

Returns true for the last data column.

Compatibility alias for clj-string-layout.predicates/last-col?.

Returns true for the last data column.
sourceraw docstring

last-row?clj

Compatibility alias for clj-string-layout.predicates/last-row?.

Returns true for the virtual row after the last data row.

Use with :apply-for for bottom borders and footers.

Compatibility alias for clj-string-layout.predicates/last-row?.

Returns true for the virtual row after the last data row.

  Use with :apply-for for bottom borders and footers.
sourceraw docstring

layout-ascii-box-centerclj

Compatibility alias for clj-string-layout.presets/layout-ascii-box-center.

Unicode box-drawing table with centered cells.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-center.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-fill-center.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-fill-center.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-fill-left.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-fill-left.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-fill-right.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-fill-right.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-left.

Unicode box-drawing table with left-aligned cells.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-left.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-right.

Unicode box-drawing table with right-aligned cells.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-box-right.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-center.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-center.

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

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

layout-ascii-grid-fill-centerclj

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-fill-center.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-fill-center.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-fill-left.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-fill-left.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-fill-right.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-fill-right.

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-left.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-left.

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

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

layout-ascii-grid-rightclj

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-right.

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

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

Compatibility alias for clj-string-layout.presets/layout-ascii-grid-right.

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

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

layout-csvclj

Compatibility alias for clj-string-layout.presets/layout-csv.

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.

Compatibility alias for clj-string-layout.presets/layout-csv.

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

Compatibility alias for clj-string-layout.presets/layout-html-table.

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.

Compatibility alias for clj-string-layout.presets/layout-html-table.

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

Compatibility alias for clj-string-layout.presets/layout-html-table-readable.

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.

Compatibility alias for clj-string-layout.presets/layout-html-table-readable.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-center.

Markdown pipe table with centered columns.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-center.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-fill-center.

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.

Compatibility alias for clj-string-layout.presets/layout-markdown-fill-center.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-fill-left.

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.

Compatibility alias for clj-string-layout.presets/layout-markdown-fill-left.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-fill-right.

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.

Compatibility alias for clj-string-layout.presets/layout-markdown-fill-right.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-left.

Markdown pipe table with left-aligned columns.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-left.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-right.

Markdown pipe table with right-aligned columns.

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

Compatibility alias for clj-string-layout.presets/layout-markdown-right.

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

Compatibility alias for clj-string-layout.presets/layout-norton-commander-center.

Norton Commander-style table with centered cells.

Uses double outer borders and single interior separators.

Compatibility alias for clj-string-layout.presets/layout-norton-commander-center.

Norton Commander-style table with centered cells.

  Uses double outer borders and single interior separators.
sourceraw docstring

layout-norton-commander-fill-centerclj

Compatibility alias for clj-string-layout.presets/layout-norton-commander-fill-center.

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

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

Compatibility alias for clj-string-layout.presets/layout-norton-commander-fill-center.

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

Compatibility alias for clj-string-layout.presets/layout-norton-commander-fill-left.

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

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

Compatibility alias for clj-string-layout.presets/layout-norton-commander-fill-left.

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

Compatibility alias for clj-string-layout.presets/layout-norton-commander-fill-right.

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

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

Compatibility alias for clj-string-layout.presets/layout-norton-commander-fill-right.

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

Compatibility alias for clj-string-layout.presets/layout-norton-commander-left.

Norton Commander-style table with left-aligned cells.

Uses double outer borders and single interior separators.

Compatibility alias for clj-string-layout.presets/layout-norton-commander-left.

Norton Commander-style table with left-aligned cells.

  Uses double outer borders and single interior separators.
sourceraw docstring

layout-norton-commander-rightclj

Compatibility alias for clj-string-layout.presets/layout-norton-commander-right.

Norton Commander-style table with right-aligned cells.

Uses double outer borders and single interior separators.

Compatibility alias for clj-string-layout.presets/layout-norton-commander-right.

Norton Commander-style table with right-aligned cells.

  Uses double outer borders and single interior separators.
sourceraw docstring

layout-org-leftclj

Compatibility alias for clj-string-layout.presets/layout-org-left.

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.

Compatibility alias for clj-string-layout.presets/layout-org-left.

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

Compatibility alias for clj-string-layout.presets/layout-org-right.

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.

Compatibility alias for clj-string-layout.presets/layout-org-right.

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

Compatibility alias for clj-string-layout.presets/layout-pipe-separated.

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.

Compatibility alias for clj-string-layout.presets/layout-pipe-separated.

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

Compatibility alias for clj-string-layout.presets/layout-plain-center.

Plain whitespace-separated columns with centered cells.

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

Compatibility alias for clj-string-layout.presets/layout-plain-center.

Plain whitespace-separated columns with centered cells.

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

layout-plain-leftclj

Compatibility alias for clj-string-layout.presets/layout-plain-left.

Plain whitespace-separated columns with left-aligned cells.

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

Compatibility alias for clj-string-layout.presets/layout-plain-left.

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

Compatibility alias for clj-string-layout.presets/layout-plain-right.

Plain whitespace-separated columns with right-aligned cells.

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

Compatibility alias for clj-string-layout.presets/layout-plain-right.

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

Compatibility alias for clj-string-layout.presets/layout-psql-left.

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.

Compatibility alias for clj-string-layout.presets/layout-psql-left.

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

Compatibility alias for clj-string-layout.presets/layout-psql-right.

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.

Compatibility alias for clj-string-layout.presets/layout-psql-right.

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

Compatibility alias for clj-string-layout.presets/layout-rst-simple.

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.

Compatibility alias for clj-string-layout.presets/layout-rst-simple.

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

Compatibility alias for clj-string-layout.presets/layout-tsv.

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.

Compatibility alias for clj-string-layout.presets/layout-tsv.

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

not-first-col?clj

Compatibility alias for clj-string-layout.predicates/not-first-col?.

Returns true for every data column except the first.

Compatibility alias for clj-string-layout.predicates/not-first-col?.

Returns true for every data column except the first.
sourceraw docstring

not-first-row?clj

Compatibility alias for clj-string-layout.predicates/not-first-row?.

Returns true for every virtual row except the first.

Use with :apply-for in row layout specs.

Compatibility alias for clj-string-layout.predicates/not-first-row?.

Returns true for every virtual row except the first.

  Use with :apply-for in row layout specs.
sourceraw docstring

not-interior-col?clj

Compatibility alias for clj-string-layout.predicates/not-interior-col?.

Returns true for first and last data columns.

Compatibility alias for clj-string-layout.predicates/not-interior-col?.

Returns true for first and last data columns.
sourceraw docstring

not-interior-row?clj

Compatibility alias for clj-string-layout.predicates/not-interior-row?.

Returns true for first and last virtual rows.

Useful when the top and bottom borders share a layout.

Compatibility alias for clj-string-layout.predicates/not-interior-row?.

Returns true for first and last virtual rows.

  Useful when the top and bottom borders share a layout.
sourceraw docstring

not-last-col?clj

Compatibility alias for clj-string-layout.predicates/not-last-col?.

Returns true for every data column except the last.

Compatibility alias for clj-string-layout.predicates/not-last-col?.

Returns true for every data column except the last.
sourceraw docstring

not-last-row?clj

Compatibility alias for clj-string-layout.predicates/not-last-row?.

Returns true for every virtual row except the last.

Compatibility alias for clj-string-layout.predicates/not-last-row?.

Returns true for every virtual row except the last.
sourceraw docstring

second-col?clj

Compatibility alias for clj-string-layout.predicates/second-col?.

Returns true for the second data column.

Compatibility alias for clj-string-layout.predicates/second-col?.

Returns true for the second data column.
sourceraw docstring

second-row?clj

Compatibility alias for clj-string-layout.predicates/second-row?.

Returns true for the virtual row after the first data row.

This is commonly used for Markdown header separator rows.

Compatibility alias for clj-string-layout.predicates/second-row?.

Returns true for the virtual row after the first data row.

  This is commonly used for Markdown header separator rows.
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