reportist/visual/README.md

43 lines
1.8 KiB
Markdown

# Built-in color palettes
Both Reportist plugins read `themes.yaml`. The original `default`, `cic`, and
`eridani` palettes are unchanged. Seven additional color-only palettes were
adapted from [Ravenous `themes.typ`](https://proxy.dandaedre.com/gitea/Ravenous/ravenous_typst/raw/branch/candlelight/setup/theme/themes.typ):
| Name | Character |
| --- | --- |
| `warm` | parchment, oxblood, and muted gold |
| `steel` | cool gray and blue |
| `bw` | grayscale |
| `high-contrast` | white, dark blue, and red |
| `yon-sen` | warm paper, vermilion, and indigo |
| `steingrund` | cool gray, burgundy, and slate blue |
| `draan` | violet and mineral teal |
Only colors were adapted. The source file's fonts, heading numbering, symbols,
progress glyphs, attack categories, and layout rules are not part of these
Reportist themes. Existing plugins keep their document structure and font
choices. The source's `ink`, muted ink, border, light parchment, and heading
colors map to Reportist's `ink`, `muted`, `line`, `paper_soft`, and `accent`.
`info`, `warning`, `critical`, and `success` use legible colors chosen from the
same palette. Some monochrome or single-hue palettes intentionally reuse a hue
for more than one status; status text remains explicit.
An authored report selects a name in its YAML or JSON:
```yaml
theme: warm
```
A diagnostic selects the same catalog at render time:
```bash
./build.sh render diagnostic capture.json --output diagnostic.pdf --theme warm
```
The diagnostic plugin also reads `DIAGNOSTICS_THEME` when `--theme` is omitted.
The report plugin continues to accept a custom theme dictionary in its source.
Add new named palettes to `themes.yaml`, keep all required Reportist color keys,
and verify both plugins can render them. Existing palettes are regression
baselines; do not change their values casually.