Files
klammertext/README.md
T
ack b80e823ab3 Tables in the plain-text target, with captions
A @table now renders to txt.  What it needed settled how plain text sets
a block off from the prose around it, which is by INDENTING it: that is
the only structural device the medium has, where html and LaTeX have
boxes, rules and space.  An indented block is one that has already been
laid out, and the target leaves its lines alone.

A caption is placed above a table or a listing and below a figure, in
every target rather than only in plain text.  A figure is taken in at a
glance, and the caption then names what the reader has already seen; a
table is read, and a reader who meets the rows before the subject has to
read them twice.

Also fixed, all three of them silent: an indented paragraph was dropped
from plain-text output rather than left as written; an @indent block was
re-flowed, so the indentation of its later lines appeared as gaps in the
middle of a line; and a table captioned with ":number false" lost the
rule under its caption, while an unnumbered table wrongly consumed a
number that a reader counting captions would then find missing.

(from dev 8173c371bba6)
2026-08-26 23:00:58 +02:00

2.3 KiB

Klammertext

Klammertext is a markup language that produces multiple output formats — HTML, LaTeX/PDF, and plain text — from a single source description. Its core engine, the Klammermachine, is written in C++; the Standard Klammer Set (SKS) adds a default library of formatting and document-structuring operators on top.

Installing

Installation guides are in doc/install/:

  • Linux, from source — doc/install/linux_source_install.md
  • macOS, from source — doc/install/macos_source_install.md
  • Linux, container — doc/install/linux_container_install.md
  • macOS, container — doc/install/macos_container_install.md

Building from source

With a C++20 compiler and KLAMMERTEXT_HOME set to this directory:

make -C com

This builds the Klammermachine library (into lib/), the SKS components, and the three commands — ktext, kdesc, kdiag (into bin/). See the source-install guide for prerequisites (TeX Live for PDF output, Python, and so on).

Working with an AI assistant

If you use a language model to help write Klammertext, give it doc/klammertext_for_llm.md. It is a dense reference written for a model rather than a person: the syntax, the things a model is most likely to assume wrongly about it (Klammertext is not LaTeX, Markdown, or Lisp, and reads oddly if you expect any of them), and how to ask the kdesc and kdiag commands for the current state of the machine instead of guessing.

Editor support

Editing support for Emacs, Sublime Text, Vim, and Visual Studio Code — syntax highlighting, delimiter matching, structural reindentation, table alignment, diagnostics — is in doc/edit/, together with the shared implementation and the Klammertext language server they build on.

Provenance

This repository is a curated snapshot of Klammertext's private development tree, assembled by a manifest-driven script. Its history is a series of release snapshots, not a mirror of the development history, and files here are regenerated on each release — patches cannot be merged directly. Report problems (or send patches) to the author; accepted changes are applied to the development tree and appear in a following snapshot.

This snapshot was assembled from development commit 8173c371bba6.

License

See LICENSE.md.