2026-07-18 18:48:23 +02:00
|
|
|
# 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/`](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).
|
|
|
|
|
|
|
|
|
|
## Editor support
|
|
|
|
|
|
Editor support generalized: shared core, language server, Vim and VS Code (from dev eb5baf9cbe59)
doc/edit/ now holds a shared Python implementation of the language's
structural layer (klammertext_edit.py) and a dependency-free language
server (klammertext_ls.py), with integrations for Emacs, Sublime Text,
Vim, and Visual Studio Code. The editor test suite in tst/ covers the
core's API and CLI, the language server protocol, the VS Code
extension, headless Vim, and Emacs byte-equality.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-27 15:01:49 +02:00
|
|
|
Editing support for Emacs, Sublime Text, Vim, and Visual Studio Code —
|
|
|
|
|
syntax highlighting, delimiter matching, structural reindentation, table
|
|
|
|
|
alignment, diagnostics — is in [`doc/edit/`](doc/edit/), together with the
|
|
|
|
|
shared implementation and the Klammertext language server they build on.
|
2026-07-18 18:48:23 +02:00
|
|
|
|
2026-07-26 01:07:52 +02:00
|
|
|
## 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.
|
|
|
|
|
|
An output policy for the three commands, and @cond as a true special form
A snapshot of the development tree. The substantial changes since the last one:
COMMAND OUTPUT POLICY. The three commands display text in exactly three cases,
and each owns a stream: LOGGING under "-v" greater than 0 and an ERROR before
termination go to STDERR; OUTPUT THE USER ASKED FOR goes to STDOUT. For ktext
that output is a document, so "ktext doc.kt -d | ..." is now safe -- logging
used to share the stream and land inside the document. A bare command prints
its usage and succeeds rather than failing. Colour is emitted only to a
terminal, per stream, and NO_COLOR is honoured.
"-v 1" reports every decision whose outcome you could not have read off your own
input: the klammerset that was loaded and from which file, a font's directory, a
":files" name's file, how "-o" was expanded. Higher levels are the trace.
The commands no longer warn and continue: an anomaly is an error, described with
its location. Two exceptions remain, each for a stated reason -- a condition
that is expected and temporary by design, and a judgment that is a heuristic
rather than exact.
@cond IS NOW A TRUE SPECIAL FORM, resolved at APPLICATION time rather than when
the file is read. Two consequences for a writer:
* a state variable reaches the predicate. "@@@state Flag :value true @@@
@cond *Flag* | T | F @" renders "T"; it used to see the literal "*Flag*" and
silently take the false branch. The document now behaves like a klammer
body, whose arguments are bound before its conditionals are decided.
* nothing in a discarded branch happens -- it is not read, not evaluated, not
expanded. An @eval in the branch not taken used to run anyway.
Its predicate relation is total and strict: true, True, 1; false, False, 0, and
empty; anything else is an error at the @cond rather than silently false.
@eval REACHING OUTSIDE. ":shell" and ":haskell" now keep the command's standard
error out of the document (it appears under "-v 1") and treat a nonzero exit as
an error naming what the command reported. A command that exits nonzero on
purpose -- "grep" finding no match -- says so with "|| true".
KLAMMER SETS. Several combine: "--klammersets a b c" loads all three in the
order given, sharing one namespace, with the definition modes deciding
collisions. "none" means none and may not be combined with other symbols. A
klammerset with symbol X is declared in a file X/X.k, which is what lets two
sets require the same third set without loading it twice.
TESTS. Four new suites: the kdiag command's interface, the @eval primitive's
contract with the outside world, and verbosity at both tiers. Three suites
that could not run on macOS at all now do.
Assembled from dev commit 6c8ee6c22fca.
2026-08-16 01:37:59 +02:00
|
|
|
This snapshot was assembled from development commit `6c8ee6c22fca`.
|
2026-07-26 01:07:52 +02:00
|
|
|
|
2026-07-18 18:48:23 +02:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
See [`LICENSE.md`](LICENSE.md).
|