← Files ClaraARCHIVED FILE

skills/html-deck/references/structured-authoring.md

6.55 KB · Oct 5, 2026 · 00:02 UTC

↓ Download file

# Structured authoring contract

Use `deck-plan.json` as the editable narrative/layout contract and
`content-ledger.json` as the source/claim contract. The model chooses the
storyline, layout, claim classification, and visual type. The composer only
checks and renders the supplied choices.

For every production deck with quantitative content, also read and follow
[evidence-bindings.md](evidence-bindings.md). Use
`clara.html_deck_plan.v2` plus `clara.html_deck_ledger.v2`; values and prepared
visual series must resolve from a sealed evidence bundle. The v1 examples below
describe layout structure only. A v1 deck is always `not_verified`, and the
builder rejects its visible quantitative content unless the explicit
illustrative legacy escape hatch is used.

## Deck plan

The base layout schema is `clara.html_deck_plan.v1`:

```json
{
  "schema_version": "clara.html_deck_plan.v1",
  "allow_bespoke_html": false,
  "slides": [
    {
      "id": "decision-gap",
      "layout_id": "visual-takeaway",
      "title": "The decision gap is concentrated in one measure",
      "chapter": "evidence",
      "chapter_label": "Evidence",
      "tone": "light",
      "notes": "Explain the comparison basis before the implication.",
      "source_refs": ["source-workpaper"],
      "claim_refs": ["claim-gap"],
      "slots": {
        "eyebrow": "Observed difference",
        "title": "The decision gap is concentrated in one measure",
        "visual": {
          "renderer": "data_visual",
          "source_refs": ["source-workpaper"],
          "claim_refs": ["claim-gap"],
          "spec": {
            "schema_version": "clara.html_deck_visual.v1",
            "type": "table",
            "id": "decision-gap-chart",
            "title": "Observed posture by option",
            "columns": ["Option", "Observation"],
            "rows": [
              ["Option A", "Higher"],
              ["Option B", "Lower"]
            ],
            "source_ids": ["source-workpaper"],
            "source_note": "Same period and basis."
          }
        },
        "takeaway_label": "Implication",
        "takeaway": "The difference changes the governed next move.",
        "source_note": "Approved workpaper."
      }
    }
  ]
}
```

Read `assets/layout-library/registry.json` before selecting layouts. Each entry
defines narrative role, slots, density, typography, fragment limits, and tone.
Do not choose a layout by mechanically matching keywords; choose it for the
argument the slide must make.

The bundled data renderer supports `bar`, `line`, `scatter`, `bubble`,
`waterfall`, `timeline`, and `table`. Supply the already-selected period,
filters, records, labels, and visual type. The renderer deliberately does not
filter data or combine/split periods. Analytical preparation remains upstream.
In source-bound v2 work, `spec.data` or `spec.rows` must be a `raw` evidence
binding to a prepared view; do not copy values into the visual spec.

Every visual needs a safe stable `id`, at least one safe `source_ids` entry,
an audience-facing title, and an accessible label. Scatter and bubble specs
also require visible `x_axis_label` and `y_axis_label`; bubble specs require a
visible `size_axis_label`, positive sizes, and no more than a 25:1 size range.
Bubble radius is square-root scaled so circle area, rather than diameter,
represents the supplied size.

Mechanical legibility limits are enforced before rendering: bar/scatter/bubble/
waterfall data is capped at eight items, line at ten, timeline at six, and
tables at six columns by eight rows. Bar labels are capped at 16 characters;
line and waterfall label limits tighten as item count rises. Browser QA then
measures every SVG text bounding box and fails labels that leave the canvas or
overlap. These checks do not decide whether the selected data, period, visual,
or analytical interpretation is correct.

Set `allow_bespoke_html` to `true` only when no registered layout can express
the required mechanism. Bespoke markup is body markup only; scripts, event
handlers, remote/local resources, and executable URLs are rejected.

## Content ledger

The base schema is `clara.html_deck_ledger.v1`. Source-bound plans use the v2
ledger so numeric claim text can contain the same binding objects and templates
as the plan. Every deck slide appears exactly once. Every claim has an explicit
classification and basis.

For a deck generated inside a Clara advisory case, reuse the matching
`advisory_claim_register.json` claim ID as the content-ledger claim `id` when it
meets this ledger's safe-ID contract. After composition, add the exact deck and
slide appearance to that upstream claim. Keep `source_ids`, evidence-bundle
bindings, resolved ledgers, and evidence-ledger hashes unchanged: shared
advisory lineage connects workflows but never replaces HTML Deck's stricter
format and numeric-binding checks.

```json
{
  "schema_version": "clara.html_deck_ledger.v1",
  "sources": [
    {
      "id": "source-workpaper",
      "label": "Approved advisory workpaper",
      "kind": "workpaper",
      "locator": "/private/case/advisory_workpaper.md",
      "sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "publish_locator": false
    }
  ],
  "slides": [
    {
      "slide_id": "decision-gap",
      "basis_status": "source-backed",
      "basis_note": "",
      "claims": [
        {
          "id": "claim-gap",
          "statement": "The observed difference changes the decision on the agreed basis.",
          "classification": "fact",
          "basis_status": "source-backed",
          "basis_note": "",
          "source_ids": ["source-workpaper"],
          "qualification": "Illustrative labels replaced with approved values."
        }
      ]
    }
  ]
}
```

Classifications are `fact`, `assumption`, `target`, `forecast`, `probability`,
`illustrative`, `judgement`, and `open-question`. Basis statuses are
`source-backed`, `speaker-judgement`, and `not-applicable`. Facts must be
source-backed. A non-source-backed claim needs a basis note. Private locators
are stripped from the published HTML unless `publish_locator` is the JSON
boolean `true`.

## Compose

After editing both files:

```bash
python skills/html-deck/scripts/compose_html_deck.py \
  <work-dir>/deck-plan.json \
  --output-dir <work-dir> \
  --force
```

The bundled `data_visual` renderer is registered automatically. For v1, the
command replaces `slides.html` and `custom.css`. For source-bound v2, it also
writes `resolved-deck-plan.json`, `resolved-content-ledger.json`, and
`evidence-ledger.json`. It never invents evidence or rewrites the authored
ledger. Reconcile slide/source/claim IDs before building.

SHA-256: 536273cfba96d4b11639208eec5843eb61ee5673d10beb2b354c27b873b570a7