docs: one manual, the pages a device has and a printable copy of all of them
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]>
This commit is contained in:
co-authored by
Claude Opus 5
parent
55f4c183c7
commit
f2942a2946
+59
-3
@@ -52,6 +52,15 @@ done
|
||||
find "$ROOT/scripts" "$ROOT/lib" "$ROOT/tests" \
|
||||
-name '__pycache__' -type d -prune -exec rm -rf {} + 2>/dev/null || true
|
||||
|
||||
# THE MANUAL IS PART OF THE RELEASE, NOT A JOB FOR AFTERWARDS.
|
||||
#
|
||||
# Built from docs/manual before the tests run, so that the test which
|
||||
# checks the digital and printed versions against each other is checking
|
||||
# what this package is about to ship rather than whatever was built last.
|
||||
# A page that would make the printed manual wrong fails the build here.
|
||||
echo "Building the teacher's manual"
|
||||
"$ROOT/tools/build-manual"
|
||||
|
||||
for test in "$ROOT"/tests/test-*.sh; do
|
||||
[[ -x "$test" ]] || continue
|
||||
|
||||
@@ -348,9 +357,10 @@ install -Dm644 \
|
||||
"$ROOT/config/dbus/org.kde.LogoutPrompt.service" \
|
||||
"$STAGE/usr/local/share/dbus-1/services/org.kde.LogoutPrompt.service"
|
||||
|
||||
# Two marks the classroom draws itself, because nothing in Breeze says
|
||||
# either thing: a lesson, and fetching a child's grown-up.
|
||||
for icon in ekklesia-wonderink ekklesia-parent-call; do
|
||||
# Three marks the classroom draws itself, because nothing in Breeze says
|
||||
# any of them: a lesson, fetching a child's grown-up, and tonight's
|
||||
# slides.
|
||||
for icon in ekklesia-wonderink ekklesia-parent-call ekklesia-presentations; do
|
||||
install -Dm644 \
|
||||
"$ROOT/config/icons/${icon}.svg" \
|
||||
"$STAGE/usr/share/icons/hicolor/scalable/apps/${icon}.svg"
|
||||
@@ -374,6 +384,50 @@ install -Dm755 \
|
||||
"$ROOT/scripts/classroom-wonderink" \
|
||||
"$STAGE/usr/local/bin/classroom-wonderink"
|
||||
|
||||
# PRESENTATIONS.
|
||||
#
|
||||
# The library a teacher sees, and the watcher that fills it from their
|
||||
# downloads. Both are installed on every machine; PRESENTATIONS_ENABLED
|
||||
# in device.conf is what decides whether either ever runs, and it
|
||||
# defaults to false so an existing classroom upgrades unchanged.
|
||||
# THE MANUAL.
|
||||
#
|
||||
# One HTML file carrying every page, and the command that opens it with
|
||||
# the pages this device has no use for taken out. Installed on every
|
||||
# machine including ones with no optional features at all, because the
|
||||
# common pages — the bar, the browser, the volume, what to do when
|
||||
# something is wrong — are the ones a new teacher needs most.
|
||||
install -Dm644 \
|
||||
"$ROOT/docs/manual/build/classroom-manual.html" \
|
||||
"$STAGE/usr/local/share/ekklesia-classroom/manual/classroom-manual.html"
|
||||
|
||||
# The printable one goes on the machine too. A room whose printed copy has
|
||||
# gone missing can print another without anybody fetching a file from a
|
||||
# laptop, and its revision date is the same one the digital manual shows.
|
||||
install -Dm644 \
|
||||
"$ROOT/docs/manual/build/classroom-manual.pdf" \
|
||||
"$STAGE/usr/local/share/ekklesia-classroom/manual/classroom-manual.pdf"
|
||||
|
||||
install -Dm755 \
|
||||
"$ROOT/scripts/classroom-manual" \
|
||||
"$STAGE/usr/local/bin/classroom-manual"
|
||||
|
||||
install -Dm755 \
|
||||
"$ROOT/scripts/classroom-presentations" \
|
||||
"$STAGE/usr/local/bin/classroom-presentations"
|
||||
|
||||
install -Dm755 \
|
||||
"$ROOT/scripts/classroom-presentation-import" \
|
||||
"$STAGE/usr/local/bin/classroom-presentation-import"
|
||||
|
||||
install -Dm644 \
|
||||
"$ROOT/lib/classroom_presentations.py" \
|
||||
"$STAGE/usr/local/lib/ekklesia-classroom/classroom_presentations.py"
|
||||
|
||||
install -Dm644 \
|
||||
"$ROOT/systemd/user/ekklesia-classroom-presentations.service" \
|
||||
"$STAGE/etc/systemd/user/ekklesia-classroom-presentations.service"
|
||||
|
||||
install -Dm755 \
|
||||
"$ROOT/scripts/classroom-audio" \
|
||||
"$STAGE/usr/local/bin/classroom-audio"
|
||||
@@ -482,6 +536,8 @@ install -Dm644 \
|
||||
"$ROOT/lib/classroom_icons.py" \
|
||||
"$STAGE/usr/local/lib/ekklesia-classroom/classroom_icons.py"
|
||||
|
||||
# The palette and the overlay measurements. The DVD control bar, Parent
|
||||
# Call and the Presentations library all draw themselves from this.
|
||||
install -Dm644 \
|
||||
"$ROOT/lib/classroom_style.py" \
|
||||
"$STAGE/usr/local/lib/ekklesia-classroom/classroom_style.py"
|
||||
|
||||
Reference in New Issue
Block a user