ekklesiaandClaude Opus 5
f2942a2946
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]>
3.7 KiB
title, order, feature, printed-if
| title | order | feature | printed-if |
|---|---|---|---|
| Presentations | 40 | PRESENTATIONS_ENABLED | If your computer has a Presentations button on the bar |
Presentations holds the slides for your sessions. You download a presentation in the browser once, and from then on it is on this screen, ready to show on the television.
Getting a presentation onto the computer
- Click Browser and go to wherever the presentation is — your email, a shared folder, wherever it was sent to you.
- Download it the way you normally would.
- Wait until the download has finished.
That is all. It appears in Presentations by itself a few seconds later. You do not have to save it anywhere special, move it, or open it.
PowerPoint files and PDF files both work.
Your download stays in the browser exactly as it was. Nothing here changes it, moves it or deletes it.
Opening the library
Click Presentations on the bar.
Each session is a card with its name and a picture of one of its slides. Find tonight's by looking at the picture.
If a session has only just been downloaded, its card says it is being got ready. It will be ready in a moment.
Quick Look — checking the slides first
Quick Look lets you read through a session before you show it to anybody.
- Next and Previous move through the slides.
- Back to Presentations returns to the library.
- Present starts the slideshow straight away.
Looking through a session in Quick Look does not count as having presented it.
Changing the picture on the card
The first slide of a session is often the same opening slide as every other session, which makes the cards hard to tell apart. Use the slide that names the session instead — usually the second one.
- Click Quick Look.
- Press Next until you reach the slide you want.
- Click Use this slide as the picture.
The card changes straight away, and stays that way — after you close the library, and after the computer is switched off and on again.
Choosing the picture does not change where the slideshow starts. It always starts at the first slide.
Showing a presentation
Click Present, on the card or inside Quick Look.
The slides fill the whole screen. Nothing else is on it.
| To do this | Press |
|---|---|
| Next slide | Space, the right arrow, the down arrow or Page Down |
| Previous slide | The left arrow, the up arrow or Page Up |
| First slide | Home |
| Last slide | End |
| Finish | Esc |
A presentation remote works too — the forward and back buttons on the clicker are the same as Page Down and Page Up.
Finishing
Press Esc.
You come straight back to the library. Going past the last slide does the same thing.
Removing a presentation
Click Remove on its card, and confirm.
That takes it off this screen. Your download in the browser is not touched, so you can always get it back by downloading it again.
Presentations you no longer need
The computer tidies up after itself, so the library does not slowly fill up with old sessions.
A session you have shown is kept for a month after the last time you showed it. Showing it again starts that month over.
A session you downloaded but never showed is kept for six months.
You do not have to do anything about this, and nothing disappears while you are using it.
If a presentation will not open
Its card says so, and offers only Remove. Usually the file did not download properly.
Download it again. Your original download is still there either way.