PICTURES.toml
the record of what each picture shows
PICTURES.toml holds one table for each picture in the wiki's images folder, naming the files in the
project that the picture shows.[1] How the check uses it is described on Pictures,
and how a changed picture is cleared on wiki bless.
Location
The file sits in the images folder inside the wiki folder, and is read as TOML; without it, no page can
show a picture.[1]
Keys
Each table is named for a picture's file name, such as ["refund-flow.svg"].[1]
| Key | Type | Default | Meaning |
|---|---|---|---|
depicts |
list of paths | none | the files or folders the picture shows, relative to the project; with none, the picture is never checked[2] |
digest |
string | none | the fingerprint of those files, written by wiki bless; with none, the picture is never checked[3][2] |
blessed |
string | none | the reason last given to wiki bless[3] |
made |
string | none | kept when wiki bless rewrites the file, and read by nothing else[4] |
wiki bless rewrites the whole file, keeping only these four keys and replacing every comment with its
own header.[4]
Validation
Every problem below stops the build or the check, except a changed subject, which wiki check lists with
the rest.[5]
| Condition | Message |
|---|---|
| a page shows a picture with no table | wiki: refunds/ shows flow.svg, which has no entry in PICTURES.toml[5] |
a table names a file that is not in images |
wiki: PICTURES.toml lists refund-flow.svg, which is not in /path/to/notes/docs/wiki/images[5] |
depicts names a path that is not in the project |
wiki: a picture says it shows src/gone.py, which is not in this project[5] |
depicts names a folder holding no files |
wiki: a picture says it shows src/empty, which holds no files[5] |
the depicted files changed since digest was written |
wiki: refund-flow.svg shows src/refunds.py, which has changed since the picture was made; re-render it, or `wiki bless refund-flow.svg "<why the picture is still true>"` [6] |
Example
The record of the picture on Pages, as wiki bless last wrote it.[7]
["page-anatomy.svg"]
digest = "sha256:257c739ae1004fbd84a9d5b1b56221597d3b86ebb29f2b1ccaa20a82eb20917e"
depicts = ["src/builder/assets/template.html"]
blessed = "The template's subtitle placeholder was renamed from kicker; the parts of a page and their places are unchanged."