summaryrefslogtreecommitdiff
path: root/schema/dune
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukas@labunix.xyz>2026-08-19 10:32:33 +0200
committerLukasz Kasprzak <lukas@labunix.xyz>2026-08-19 10:32:44 +0200
commitb90678e560808dd788fa7d7eb319d93a83005db4 (patch)
tree73bbd6e35e3e99e5c6ad769ae0ceb02853fa5b2c /schema/dune
parent2760d43d695ba08fc33f65357590675707b6570d (diff)
downloadcolitur-b90678e560808dd788fa7d7eb319d93a83005db4.tar.gz
colitur-b90678e560808dd788fa7d7eb319d93a83005db4.zip
docs(render): template reference, install rules, typesetting check
colitur-templates.5 documents the four syntax forms, the six flavours and their escaping, and the full view-model field reference. It states plainly that there are no partials, no raw form and no expression evaluation -- a template is data, never a program. It documents two real hazards found during this build, not theoretical ones: the outward scope fallback silently shadowing an inner name/num key with an outer one of the same name (with the safe {{#name}}...{{^la}} idiom), and the engine's lack of host-comment awareness (a {{...}} inside a LaTeX %, groff .\" or HTML <!-- --> comment is still parsed as a tag). It also states the limitation rather than hiding it: AsciiDoc and Markdown are not escaped, so a feast name containing * or _ renders as emphasis. templates/ and schema/ now install into <prefix>/share/colitur/, matching data/ef/, via new install stanzas; colitur-templates.5 installs to man5 beside colitur-overlay.5. Verified against a scratch prefix: the installed binary resolves both from the prefix, not the source tree, when run from an unrelated working directory. make check-templates typesets every shipped template through pdflatex and groff when they are installed, and prints SKIPPED loudly when they are not. Golden tests prove templates render; only this proves they typeset. A silent skip would read as a pass. Fixed a real doc/help drift while here: bin/main.ml's --help still said --overlay was accepted on day and readings only, three commands out of date (emit, table/render and publish all accept it too), disagreeing with the man page's own OVERLAYS section, which carried the identical stale line. Both are corrected; --overlay's own behaviour is unchanged.
Diffstat (limited to 'schema/dune')
-rw-r--r--schema/dune16
1 files changed, 16 insertions, 0 deletions
diff --git a/schema/dune b/schema/dune
new file mode 100644
index 0000000..b3c7dfe
--- /dev/null
+++ b/schema/dune
@@ -0,0 +1,16 @@
+; The published contracts, installed into <prefix>/share/colitur/schema/ so
+; an installed `colitur` can find schema/day-v1.json from an arbitrary
+; working directory, not only a build-tree checkout -- bin/main.ml's own
+; [schema_path] (`colitur publish`) probes exactly this location as its
+; INSTALLED candidate, mirroring data/dune's own ef/ layout. Task 13.
+;
+; colitur-v1.xsd ships alongside it as the XML sibling contract (`colitur
+; emit --format xml`); nothing in colitur itself reads it at runtime -- only
+; `make check-schema`, via xmllint, and a template author who wants to
+; validate their own rendered XML by hand.
+(install
+ (section share)
+ (package colitur)
+ (files
+ (day-v1.json as schema/day-v1.json)
+ (colitur-v1.xsd as schema/colitur-v1.xsd)))