Documentation becomes part of the release rather than a job afterwards.
docs/manual is now the only place teacher instructions are written, and
tools/build-manual produces both versions from it:
classroom-manual.html installed on every machine, showing only the
features THAT device has
classroom-manual.pdf the universal printed manual, every feature,
with a conditional sentence above each
optional page so it stays true in a room that
does not have them all
They cannot drift apart because neither is written by hand, and
build-release.sh builds and checks them on every release: a page that
declares a feature with no printed-if fails the build, because that is
exactly how the printed manual comes to state an optional feature as
though every room had it. So does a page naming a feature device.conf
does not have, and an optional feature with no page at all.
WHAT REACHES THE CLASSROOM ACCOUNT. Only a list of setting NAMES, and
only ones the package already defines as optional applications.
classroom-desktop-layout — already the one place that decides what a
device offers — writes them to /run/ekklesia-classroom/features.json,
and classroom-manual filters that against FEATURES before using it. No
values from device.conf, no broker password, no addresses. With no
manifest at all every page is shown, which is the printed manual and is
never wrong, only less specific.
Help is a Quick Launch button beside Parent Call, deliberately not in
the row with the applications: putting it there would move buttons
teachers reach for without looking. Every room gets it, because a
teacher who needs the manual is by definition one who does not know
where to look.
The PDF is written directly rather than converted. A manual is
headings, paragraphs, bullets, steps and one table; writing that with
the standard fonts is a couple of hundred lines and no dependency, so a
release can be built on any machine with Python. Pictures are embedded
in the digital manual as data URIs so it stays one file that works
wherever it is copied and with the network unplugged; the printed
manual names them instead, which is the one thing this builder does not
do and is noted where somebody would look for it.
Two defects found building it, both of which hung or corrupted the
output rather than failing: a paragraph opening with a bold word
matched the bullet guard but not the bullet rule, so nothing consumed
it and the build spun; and a list item wrapped across two source lines
ended the list, so a three-step procedure printed as three steps all
numbered 1.
Also adds the 0.2.6 physical checklist to docs/testing.md and the
release validator's checks for the Wi-Fi regression, the conversion
pipeline on a real Debian, the fonts, the manual and the dock order.
Co-Authored-By: Claude Opus 5 <[email protected]>
25 KiB
Classroom test checklist
Run against the exact artifact published to canary, on the real endpoint,
before promoting to stable with ./update_stable.sh.
Boot
- Cold boot reaches the classroom shell with no terminal or window junk
- Reboot does the same
- Wallpaper appears
- Dock appears, centred
- Clock appears, bottom right
Provisioning
journalctl -u ekklesia-classroom-provisionshows a clean run- Google Chrome is installed on a machine that never had it
- A second boot does not reinstall anything
- A machine with no network still boots to a working shell, and provisioning succeeds at a later boot once it is online
Networking
nmtuiis installed andNetworkManager.serviceis enabled- An Ethernet interface declared in
/etc/network/interfacesremains managed by ifupdown and keeps its existing address sudo nmtuican save and activate a Wi-Fi connection- The saved Wi-Fi connection reconnects after reboot
- A machine with no Wi-Fi adapter reaches the classroom normally without an online-wait delay or NetworkManager failure
- Ethernet-only operation is unchanged
Printing
cups.serviceis enabled andlpstat -rreports that the scheduler runslpinfo -mcontains the generic color PCL 6/PCL XL driver documented in printing.mdsudo classroom-printer-setupcreates onlyElmer, enables it, and makes it the system default- Provisioning creates Elmer automatically at
socket://10.10.0.155:9100with descriptionElmer lpoptions -p Elmer -lshows*NormalforPrintoutModeand*ColorforColorModel- An upgrade removes the old
Classroom_Colorqueue - Repeating provisioning reports Elmer already configured and does not rewrite the queue
- Chrome opens the system print dialog and shows only Elmer
lpstat -eprints onlyElmer; neither the Brother label printer nor a discovered duplicate Ricoh appearsavahi-daemon.serviceandavahi-daemon.socketare masked- The CUPS test page prints in color on the Ricoh MP C3502
- With the Ricoh powered off, the classroom still boots normally and a job simply remains queued
Secondary Chrome windows
- The first Chrome top-level remains maximised, tiled and borderless
- A second
google-chrometop-level floats instead of splitting the main browser - It is centred at roughly three quarters of the logical display
- Its red Close button is visible and mouse-accessible
- Close removes only the secondary and reveals the untouched main browser
- Changing either page title does not change the main/secondary roles
- A third Chrome top-level also floats and Close targets the newest one
- Chrome minimise/restore and the dock Browser button still behave normally
UI scale
UI_SCALE sets sway's output scale, so it scales the whole session.
Change it, then sudo systemctl restart getty@tty1.
UI_SCALE=1.0is identical to a session with no scalingswaymsg -t get_outputsshows the mode still 1920x1080 at every scale, with only the logical size changing- At 1.25 and 1.5, Chrome grows: tabs, omnibox, toolbar icons, menus and page content
- Chrome's buttons are still easy to hit with the mouse
- Dock, clock, notifications and the DVD bar grow by the same amount — once, not twice
- Dock icons stay crisp at 1.25 and 1.5 on a normal-density monitor, not just from across the room: compare an icon against the clock text beside it
- DVD control bar icons are crisp at the same scales
UI_SCALE=0.8shrinks everything together- A nonsense value (
UI_SCALE=banana) still gives a working shell - An extreme value (
UI_SCALE=9) is clamped, not obeyed journalctlor the sway log showsclassroom-scale: session scale N
Reserved bottom shell (regression)
The bottom strip is one full-width layer-shell surface with a 76px exclusive zone. Dock and clock live inside it. Do not split them back into separate layer-shell windows.
- A maximised Chrome window stops above the bottom strip
- The clock does not float over Chrome
- Dock stays centred, clock stays bottom right
- Wallpaper shows through the unused parts of the strip
- Every dock button still responds to clicks
- A fullscreen application covers the whole display, dock included
Browser
- First Browser click launches Chrome
- Chrome opens on Wonder Ink (https://app.wonderink.org/)
- Clicking Browser while Chrome is focused minimises it
- Clicking Browser again restores it maximised, not floating or draggable
- Clicking Browser while Chrome is running but unfocused focuses it
Super+Mminimises the focused windowSuper+Shift+Mrestores the most recently minimised window- Normal navigation to any other site works
- The Home button returns to Wonder Ink
- Fullscreen YouTube video uses the whole display
- Leaving fullscreen restores the correct geometry above the dock
- The main Chrome window has no sway title bar — it starts at Chrome's own tab strip, and Chrome's tabs and address bar are still there
- Chrome still maximises and minimises as before
- After a reboot, no "Restore pages? Chrome didn't shut down correctly" bubble
- Chrome does not offer to save passwords
- Chrome shows no way to sign into the browser itself
- No "Add profile" and no Guest entry in the profile menu
- No profile picker at startup
- Wonder Ink signs in normally during a session
- After closing Chrome fully and reopening, Wonder Ink is signed out (see browser.md — this is the unverified one)
- YouTube is still signed into the church account after that
chrome://policylists PasswordManagerEnabled as an applied managed policy- Website logins still persist across a reboot
- Clicking Browser when Chrome is closed shows a throbber on the dock button until the window appears
- Clicking Browser when Chrome is already open feels immediate, with no throbber
- The pointer shows a busy cursor while it is over the dock
- No first-run, default-browser or sign-in nag appears
chrome://policylists the Ekklesia policies as applied, with no "unknown policy" entries- Chrome does not start by itself at boot
- After a reboot, cookies and site logins are still there
- After an OTA update, cookies and site logins are still there
Known limitation: Chrome's own minimise button in its title bar does
nothing. Sway ignores the Wayland minimise request and gives no event to
hook. Minimising is the dock's Browser button or Super+M.
Notifications
classroom-notify-testrenders with the classroom styling: dark translucent, rounded, white text, top rightclassroom-notify-test --critical "Parent Call" "Room 3 needs a parent."renders in the critical style and does not time out- Notifications appear over a fullscreen video
Over SSH from an administrator account, run it with sudo:
sudo classroom-notify-test --dry-run # show the session it resolved
sudo classroom-notify-test # send into the classroom desktop
The classroom desktop belongs to the classroom user, and mako sits on that user's D-Bus session. A plain notify-send from an SSH session lands in the administrator's own session, where nothing owns org.freedesktop.Notifications, so D-Bus tries to start a second mako with no display and the call times out with NoReply. The script finds the running sway process for the classroom user and delivers into its session instead. It never starts mako.
sudo classroom-notify-testfrom an SSH session displays on the classroom screensudo classroom-notify-test --dry-runreports the resolved XDG_RUNTIME_DIR, bus address and Wayland display- Running it as an unprivileged admin account explains it needs sudo
tests/test-classroom-notify-test.shpasses (also run by the build)
Audio
The room prefers the television. AUDIO_OUTPUT in device.conf decides:
auto (prefer a connected HDMI or DisplayPort set, fall back to the
jack), hdmi, or analog. A machine with no digital output at all — a
laptop, when one arrives — is correct on auto without any change here.
Two test suites cover this, and both run in the build:
tests/test-classroom-audio.sh— the decision itself, against the shapes real pactl emitstests/test-classroom-audio-daemon.sh— the real daemon driven through every situation a room gets into, against a pactl that answers the way PipeWire does
On a machine:
classroom-audio showlists the outputs, what it chose, the profile it would set and whether it issettledjournalctl --user -u ekklesia-classroom-audioshows oneoutput is ...line per real change and nothing in between- Leaving the room alone for an hour adds no further lines and no measurable CPU time
The television switched on after the computer
This is the scenario that silenced River Kids on 0.2.2 and the one no lab can produce: ALSA reports a television through the HDMI port's availability, and no loopback or dummy sound driver has such a port. The suites above play it through a mock, and the mock is faithful to the real server as far as it was measured — but a mock cannot prove the real ALSA jack change arrives. Do not take a passing build as evidence that this works. It has to be done at a machine, once, per release:
- Switch the television off at the set, not the remote.
- Reboot the computer and let it reach the classroom desktop.
- Leave it at least two minutes, so any startup settling is over.
journalctl --user -u ekklesia-classroom-audio— expect oneoutput is ...line. In a room with nothing in the analog jack it names the HDMI port even now, which is right: there is nowhere better for the sound to go, and the set is then already correct when it comes on.- Open Wonder Ink and Chrome and start something playing.
- Switch the television on.
- Sound should arrive within about a minute, in both applications, without closing or reopening either one.
wpctl statusshould show the HDMI sink as default, andclassroom-audio showshould saysettled=True.- Switch the television off and on again. Sound should come back.
- Check the volume is where the teacher left it, and that an output muted on purpose is still muted.
If step 7 fails, the jack change is not reaching PipeWire at all; capture
pactl subscribe and classroom-audio show with the set off and then on,
which is what distinguishes that from a policy fault.
Device features
Every optional application is its own setting in device.conf, and
DEVICE_TYPE decides none of them. A laptop can take children's church
and a tower can be a Bible study.
DEVICE_TYPE=desktop|laptop what the hardware IS
WONDERINK_ENABLED=true|false
DVD_ENABLED=true|false a drive is still required as well
PARENT_CALL_ENABLED=true|false
NETWORK_PREFERENCE=wired|wifi
DISPLAY_MODE=all|external-only
All default to the classroom's existing behaviour, so an upgrade changes
nothing until somebody edits the file. classroom-desktop-layout writes
the answers into the packaged layout; the bar is rebuilt from it at the
next login.
tests/test-classroom-desktop-layout.shpasses (also run by the build)- After changing a setting,
classroom-desktop-layoutthen a logout/login shows the new bar - A disabled application leaves no gap: the remaining launchers close up
- The launcher order is the same on two machines with the same features enabled
- The order survives launching and closing applications, logout/login
and a reboot — run
tools/lab/order-checkagainst a live session, which opens real windows and reads the bar off the screen - Right-clicking a launcher offers no Pin or Unpin
Two things the bar cannot do at once
Stock Plasma 6.3 ties them together, and this is the trade the classroom makes. Both halves are measured, not inferred:
main.qml:153 hideActivatedLaunchers: tasks.iconsOnly || ...
main.qml:155 launchInPlace: tasks.iconsOnly && sortingStrategy === 1
MouseHandler.qml:74 accepts a reordering drop only when
sortMode === SortManual
For an icons-only bar the launcher is ALWAYS hidden once its application
starts. Only sortingStrategy = 1 puts the running window back in the
launcher's place — and 1 is also the only value at which a drag can
reorder anything.
sortingStrategy = 0— no dragging, but the browser jumps behind the disc player when it opens. That was 0.2.4, and it is the bug.sortingStrategy = 1— the order holds through every open and close, and a teacher who knows to drag can rearrange the bar within a session. This is what ships.
There is no third value and no Kiosk key that separates them.
classroom-desktop-reset rebuilds the bar from the package at every
login, so a drag never outlives the session.
- KNOWN: a drag can still rearrange the bar until the next login
- After logging out and back in, the packaged order is back
The configuration escape (unresolved)
Right-clicking a launcher offers Configure Icons-Only Task Manager…,
and that dialog opens and reaches the sorting setting. Measured on the
lab session with the desktop locked: plasma/plasmashell/unlockedDesktop
reads false, evaluateScript answers "Widgets are locked", Pin and Unpin
are correctly hidden — and Configure is not gated by any of it. There is
no allow_configure_when_locked key in Plasma 6.3; it was searched for
in the shipped libraries and does not exist.
Closing it means overriding stock ContextMenu.qml, which is a fork of a
file that changes between Plasma releases. Not done.
- KNOWN: a teacher who opens that dialog can change the sorting, and the next login puts it back
- The bar is right at 1080p/100% and 4K/200%
The Bible study laptop
A laptop installed as a fixed appliance: AC power, battery out, lid shut, one television on HDMI, Wi-Fi.
DEVICE_TYPE=laptop
DISPLAY_MODE=external-only
NETWORK_PREFERENCE=wifi
WONDERINK_ENABLED=false
PARENT_CALL_ENABLED=false
DVD_ENABLED=false
Nothing about DEVICE_TYPE=laptop turns those applications off; they are
off because those lines say so.
Physical verification — the Wi-Fi hand-over
No lab can do this one: it needs the laptop's radio. Over SSH, watching, with a way back into the room if it goes wrong:
classroom-wifi --check— expect it to name the interface and say ifupdown owns it. Changes nothing.classroom-wifi --adopt --dry-run— expect the three "would" lines. Changes nothing./etc/network/interfacesmust still be identical.classroom-wifi --adopt. It prints each step. Expect it to end with "is NetworkManager's now, and the room is online". If it fails it puts ifupdown back by itself and says so; the machine should still be reachable.classroom-wifi --rollbackundoes it later.nmcli device status— the Wi-Fi device must no longer sayunmanaged.nmcli networking connectivity— must sayfull, notnone.nmcli device wifi list— must now list networks.- Log out and back in. The panel must show the Wi-Fi connection.
- Reboot. It must reconnect on its own, with nobody typing a password.
- As the classroom account, confirm the password is still
unreachable:
nmcli -s -g 802-11-wireless-security.psk connection show <name>must be empty- the applet's Show Network's QR Code must not produce one
/etc/NetworkManager/system-connections/*.nmconnectionmust be unreadable
- As tech, confirm maintenance still works:
sudo nmcli -s ...returns the key.
Physical verification — a real lid and a real television
The lab has no lid and no HDMI hotplug, so none of this is proven by a passing build. Do it once at the machine:
- With the lid open and the television on, check
classroom-display-modereports the panel switched off and the television on, and that only the television is lit. - Close the lid. The machine must keep running: the television stays on,
audio keeps playing, SSH stays up.
systemctl is-system-runningstill answers, andloginctlshows the session active. - Leave it closed for ten minutes. It must not suspend, hibernate, log
out or lock.
journalctl -b | grep -i -E "suspend|hibernate|lid"should show nothing acting. - With the lid still closed, switch the television off and on again. The picture must come back. Known limitation of 0.2.4: the display mode is applied at login, not continuously, so if KWin re-enables the internal panel on that power cycle it stays enabled until the next login. Check whether it does, and report it — that decides whether the follow-up needs an event-driven applier like the audio policy's.
- Unplug and replug HDMI, lid closed. Same check.
- Reboot with the lid closed and the television on. It must come back to the classroom desktop on the television.
- Confirm Wi-Fi reconnects on its own, with nobody typing a password.
- Confirm the HDMI audio policy still works (see Audio, above).
Messaging
- With
MQTT_ENABLED=false,journalctl -u ekklesia-classroom-mqttshows one line and the service is inactive — and the room is completely normal - With a broker configured, the service connects and
mosquitto_sub -t 'classroom/status/#' -vshows the room online - A published notification appears on the classroom screen in the classroom styling
urgency: criticalrenders in the critical style- Killing the broker leaves the room entirely usable
- The service reconnects on its own when the broker returns
- Rebooting with the broker down boots normally to the dock
- A retained notification left on the broker does not appear at boot
DVD
With DVD_ENABLED=false:
- No DVD button in the dock
With DVD_ENABLED=true:
- Drive unplugged: button present, icon held back, friendly notification on click
- Drive present, no disc: friendly notification on click, nothing crashes
- Inserting a disc produces one DVD Ready notification
- The DVD icon comes up to full strength while a disc is in
- Nothing plays until the button is pressed
- Clicking plays the disc
- Menus work
- Audio works
- Chapter navigation works
- Fullscreen works
Super+Mminimises the player, the DVD button restores it- Closing the player works
- Ejecting is detected, the icon goes back
- Reinserting is detected again
- Commercial CSS disc plays without anyone having run codec setup by hand
Sanctuary LIVE capability
With LIVE_ENABLED=false:
- No LIVE button or spacing hole appears in the dock
- No live-specific service or process starts
With LIVE_ENABLED=true:
- LIVE appears after DVD when DVD is enabled, and after Browser otherwise
- Clicking it shows the existing placeholder notification
- No live playback is attempted
DVD mode
- Pressing DVD covers the whole display immediately, dock and clock included — no wallpaper visible anywhere, at any point
- A spinner and "Loading DVD…" show while the disc spins up
- No partial VLC window is ever visible against the wallpaper
- The loading surface stays up until the disc menu is actually showing — VLC's tiled black startup window is never visible
- Video or the disc menu replaces the loading surface when ready
- A disc that never opens still gives the desktop back (20s)
- No VLC chrome anywhere: no menu bar, no fullscreen controller, no cone, no sway title bar
- Wallpaper is never visible around VLC
- Moving the mouse to the bottom slides the classroom bar up
- It hides again shortly after the mouse leaves it
- While hidden, clicking a disc menu item near the bottom still reaches the menu
- Play/pause toggles and the icon follows the actual state
- Previous and next chapter work
- The menu button returns to the disc menu
- Space pauses; arrow keys and Enter navigate the disc menu
- Arrow keys do not change volume, and no key reaches crop, aspect ratio, subtitles, audio tracks or deinterlacing
- Esc leaves DVD mode cleanly, with no black window left behind
- Close leaves DVD mode cleanly
- Eject leaves DVD mode and opens the tray
- Killing VLC by hand also returns to the classroom desktop
- Pressing DVD twice quickly does not start two sessions
- The bar is sized by UI_SCALE like the dock
OTA
./update_canary.shpublishes package first, manifest last- The endpoint on the canary channel picks the update up
- SHA-256 verification passes
- Install succeeds and the endpoint reboots
- Everything above still works after the update
- Upgrade from 0.1.36 preserves every existing
device.confvalue LIVE_ENABLED=falseis appended exactly once on upgrade and remains single after reinstalltools/validate-trixie-release.shpasses against the 0.1.37 package and the 0.1.36 package
Presentations — 0.2.6, the prayer-room laptop
Everything here needs the real television, the real keyboard and the pastor's own session files. The automated tests and the Plasma lab cover the logic and the windows; none of them can tell you that Session 7's text is the right size from the back of the room.
Enable it first, and reboot:
sudo sed -i 's/^PRESENTATIONS_ENABLED=.*/PRESENTATIONS_ENABLED=true/' \
/etc/ekklesia-classroom/device.conf
sudo reboot
Download
- The bar has a Presentations button, after the Browser
- Wonder Ink and Parent Call are still absent from this laptop
- Download tonight's session in ordinary Chrome
- It does not appear in the library while it is still downloading
- It appears by itself within a few seconds of the download finishing
- The title is readable — not a hash, not a long filename
- The original download is still in Chrome's downloads, untouched
- Download the PDF and the PPTX of the same session: two cards,
the second titled
(2), neither overwriting the other
Quick Look
- Quick Look opens and shows slide 1
- Next and Previous move through every slide
- The text and layout are right — check a slide with a Bible verse
- Go to the session-number slide, usually slide 2
- Use this slide as the picture changes the card
- Back to Presentations returns without presenting
- Close the library, open it again: the chosen picture is still there
- Reboot, open it again: still there
classroom-presentation-import --statusshowspresented never
That last line is the one that matters. Quick Look, browsing every slide and changing the picture must not have counted as a presentation.
Present
- Present from the card fills the external television
- It starts at slide 1, not at the slide chosen for the picture
- Present from inside Quick Look does the same
- Space, the arrow keys and Page Up/Page Down all move slides
- The presentation remote's forward and back buttons work
- Fonts and layout are right on the television, from the back
- Esc returns to the library — not the Impress editor, not a terminal, not a blank screen
- Going past the last slide does the same
--statusnow shows a presentation time and a count- Present it again: the count rises and the expiry moves out 30 days
- Unplug the network and present again: it still works
The awkward ones
- A PDF and a PPTX of the same session look the same on screen
- A deliberately broken file gives a short message and only Remove — no editor, no terminal
- A long session (40+ slides) opens without the library freezing
- Download a Wonder Ink worksheet: it does not appear in the library
Remove
Use a test copy. Not tomorrow's session.
- Remove asks first
- The card goes, and its slides and pictures go with it
- The original download in Chrome is untouched
- It does not come back on the next scan or after a reboot
The manual
- Help is on the bar, bottom left
- It opens with no address bar and no tabs
- It shows Browser, Presentations, sound and the common pages
- It does not mention Wonder Ink, Parent Call or the DVD
- It works with the network unplugged
- On a children's classroom machine it shows the opposite set
- Print
/usr/local/share/ekklesia-classroom/manual/classroom-manual.pdfand check the conditional wording reads sensibly in a room that does not have every feature - The revision date is on the printed copy
Wi-Fi — look, do not touch
The laptop's Wi-Fi is already working through NetworkManager and its
ifupdown stanza is already gone. Do not run --adopt on it.
classroom-wifi --checksays there is no wireless interface under ifupdown's controlclassroom-wifi --adoptsays "nothing to adopt" and changes nothingnmcli -g 802-11-wireless.hidden connection show "ROGC Classroom"still reportsyes- The laptop still reconnects after a reboot