Files
DarkRoom/tools/manual
dtourolle f0e7b8e11c Re-record the manual on the keyboard layout, and stop the zoom caption promising blocks
Every scene was recorded again on a build of this branch rebased onto the
keyboard work and TD-1, since nearly every scene depends on files those
changed: the develop top bar now carries a star strip and Pick/Reject, the
roll shows flags and stars, and the grid's selection bar gains Label and
Flag. `--changed` could not be trusted to find them, because the rebase
made each picture's commit newer than the sources it was recorded from.

The develop-zoom caption said the wheel goes on "until the pixels are
blocks". On Xvfb the deepest frames come out smooth even though the app
draws past 1:1 nearest-neighbour on a real display (confirmed by eye on
the desktop), and a GIF shrunk to 960 wide could not show 3-pixel blocks
anyway. The caption now says what the clip shows; the prose above it,
which describes what the app does, stays.
2026-09-25 07:26:37 -04:00
..

tools/manual — the pictures in docs/manual

record.sh drives the desktop build on a private X server and records the scenes in scenes.py into docs/manual/media/:

tools/manual/record.sh /var/tmp/dr-demo/library              # every scene
tools/manual/record.sh /var/tmp/dr-demo/library develop_zoom # one, and what it needs
tools/manual/record.sh --changed /var/tmp/dr-demo/library    # those whose sources moved
tools/manual/record.sh --check                               # the manual and the scenes agree
tools/manual/record.sh --list

Set DR_LIBRARY_SNAPSHOT to a pristine copy of the library: a recording rates, files and merges, and the snapshot is copied over the library first. Each run starts from a fresh profile under DR_HOME.

Controls by name

The binary is built with --features automation, which lets the app answer "where is the control labelled Exposure?" over the Unix socket named by DR_AUTOMATION (ui/dr-ui/src/automation.rs). No other build has the feature, and a build that has it listens only when the variable is set. The names are the accessible labels a screen reader reads, so a scene says click_on('Select@Button') or slide('Exposure', 24) rather than a pixel, and survives a panel that moves. The pointer itself is still xdotool.

DR_HOME=/var/tmp/x tools/manual/drive.py launch /some/folder   # a feature build in DR_BIN
tools/manual/drive.py labels                 # every name on screen
tools/manual/drive.py click-on 'Settings@Button'
tools/manual/drive.py ids canvas             # things with no name: id:canvas-image
tools/manual/drive.py stop

Grid cells are named by file (_MG_8393@ListItem), rating stars 1 star to 5 stars. What a scene cannot name — a point on the photograph, the crop rectangle's corner — it places relative to something it can (drive.photo(fx, fy), id:move-area).

Scenes and the manual

Each scene in scenes.py declares the pictures it makes, as the manual names them, and the globs of the sources that could change them. --check fails when the manual shows a picture no scene makes, or a scene makes one the manual does not show; it reads two files and runs in CI. --changed re-records a scene when one of its sources, or its own code, has changed since the commit that last touched its pictures.

Two things the scripts know that are not obvious: a Slint TouchArea wants a held press, not xdotool's click; and the app is driven on Xvfb rather than the desktop because under XWayland at scale 2 a pointer warp lands at twice the coordinate asked for.