colophon
Documents colophon version 0.1.0.
A short manuscript, compiled normally | The generated audit.pdf |
colophon audits your manuscript as actually composed — word count (total and per section), reading time, page count, a figure/table inventory, labels never referenced, bibliography entries never cited — in a companion PDF, produced from the same compile as the manuscript itself. Unlike its sibling packages, it needs no per-passage markup: no check(), no passage() — an auditor, not an annotator.
The problem
“How many words is this?”, “does this figure have a caption?”, “did I ever reference that equation I labelled?” — a word count taken from source text is wrong the moment a citation resolves into a bracketed number, and a page count doesn’t exist at all until the document has actually been laid out. colophon audits the same, real compile that produces the manuscript, not a stale copy.
Key features
- Word count, total and by section, with citation/reference machinery already stripped out.
- Works through
palimpsest’s own marks — reads their metadata directly, so the count matches exactly what the clean, submitted manuscript shows. - An abstract, counted on its own —
abstract(body), an invisible marker placed once wherever you already write your abstract. - A figure/table inventory with the real numbering — via
ref(...), correct even for a template with its own exotic numbering scheme. - Labels never referenced, and bibliography entries never cited.
- Reports facts, never enforces them — no per-journal limits, no
strictdiagnostics: an orphan label is often deliberate.
Installation
#import "@preview/colophon:0.1.0": *
#import "@preview/contexture:0.1.0": bundleRequires Typst 0.15 or later, specifically its --features bundle export (still experimental).
Full guide
The complete, progressive guide — a first audit, word counts, the abstract, the figure/table inventory, orphan labels and uncited references, wiring a real project, and colophon in the contexture ecosystem — starts at Quickstart: your first audit.
Examples
Two complete, working projects live under examples/ — the same two full-length fake articles palimpsest uses for its own examples, each with colophon added alongside its reviewer letter:
fridge-study/— against@preview/unequivocal-ams, with real figures built from@preview/lilaq. (⇒ pdf: manuscript, response, audit)emoji-email/— against@preview/charged-ieee’s two-column layout, same real-figure treatment. (⇒ pdf: manuscript, response, audit)
Combining with other packages
colophon’s report(...) combines cleanly with palimpsest’s letter(...) and checkitoff’s checklist(...) in the same compile. See Combining packages.