Quickstart: your first audit

Installing and compiling

#import "@preview/colophon:0.1.0": *
#import "@preview/contexture:0.1.0": bundle

Unlike palimpsest and checkitoff, colophon asks for no per-passage markup at all — no check(), no passage(). The one thing it does need is a small wrapping step on the manuscript’s own template:, so it can find the manuscript’s real page span and, for the word count, its content before layout — where a citation is still a real, ignorable ref/cite node rather than the rendered bracket-and-number text citation resolution rewrites it into:

#show: contexture.bundle.with(
  template: instrument(template: my-journal-template),
  documents: (report(),),
)

#include "manuscript.typ"
typst compile --features bundle --format bundle main.typ

produces manuscript.pdf — completely unaffected, since nothing here touches the manuscript’s own rendering — and audit.pdf, the report.

A first, complete example

A short manuscript, two sections, one figure, one citation:

#import "../../lib.typ": *
#import "../../../typst-contexture/lib.typ" as contexture

#let my-template(body) = {
  set page(width: 16.6cm, height: auto, margin: 12pt)
  set text(size: 10.5pt)
  body
}

#show: contexture.bundle.with(
  template: instrument(template: my-template),
  documents: (report(),),
)

= Introduction

The purpose of this study was to evaluate a new intervention for a common
condition, building on prior work by Smith and colleagues @smith2020. We
hypothesized that the intervention would outperform standard care across
several outcome measures, and designed a trial to test this directly.

== Background

Prior studies have been limited by small sample sizes and short follow-up
periods, leaving important questions about long-term benefit unanswered.

= Methods

Participants were randomly assigned to one of two groups. The primary
outcome was assessed at twelve weeks by a rater blinded to group
assignment, using a validated instrument with well-established reliability.

#figure(
  rect(width: 3cm, height: 2cm, fill: luma(230)),
  caption: [A schematic overview of the study design, showing enrollment,
    randomisation, and the two follow-up visits.],
) <fig-design>

#bibliography("quickstart-basics-refs.bib")

manuscript.pdf — ordinary prose, with no visible trace of instrument() or report() at all:

audit.pdf, from the very same compile:

Three things are already visible in that report, and the rest of this manual is one chapter per thing:

  1. Total word count, reading time, page count — computed from the manuscript actually composed, not guessed from source text. Notice the citation @smith2020 contributed nothing to the count. Covered next, in Word counts.
  2. A figure/table inventory, with the real, resolved number and page — here just “Figure 1”, but the same mechanism holds under a template with its own exotic numbering scheme. Covered in Figure and table inventory.
  3. No anomalies to report here — every label this manuscript defines is either referenced or has none to begin with, and its one citation is used. What that section looks like with something to actually flag is its own chapter.
← colophon overviewWord counts →