Document the adjustable colours, and record the design and the plan

Both manuals get the Colours tab in full: the six roles, that a change applies at
once but survives a restart only after Save settings, the three ways back with their
keyboard shortcuts, what each provenance label means, and the readability notice that
warns without refusing.

Two things an operator would otherwise have to discover. The reset button is always
drawn in the shipped colours and works when nothing else can be read -- the risk
section of the design says plainly that a keyboard path only helps whoever knows it,
so the manual is where this has to be written down. And the root profile already has
both stylesheet files, because KST4Contest has been writing them at startup for
years, so most of its roles report "from file" rather than "shipped" with identical
values.

PROJECT_CONTEXT.md records the decisions that outlive this stage: the three sources
and their precedence, that a role is a selector and a property, that the theme must
read the store's state rather than remember, where the contrast pairs come from, why
the root profile's file layer always exists, and why the lifeline refuses the active
palette. Also corrects its claim that CSS stays global -- a profile now owns its
stylesheets.

The design document and the implementation plan are kept as they were written,
including the plan's own corrections where measuring the code contradicted it.
This commit is contained in:
Rsclub2_2 committed 2026-10-05 22:36:01 +02:00
1 parent 12b2d37ce2
commit da8a28d250
5 files changed
+2582 -1

No files matched your search

+44 -1
View File
@@ -70,7 +70,7 @@ A batch of changes belongs in one `SimpleRoster.mutate(...)`, not one call per e
## Operator Profiles and Per-Profile Persistence
- One operator profile owns one `preferences.xml` and one worked-station database. Everything else under `~/.praktiKST/` stays global: CSS, audio files, DEM and terrain packages, the error log and the version-info feed.
- One operator profile owns one `preferences.xml`, one worked-station database and, since release 1.50, its own pair of stylesheets. Everything else under `~/.praktiKST/` stays global: audio files, DEM and terrain packages, the error log and the version-info feed.
- The **root profile** is the historic flat installation: `preferences.xml` and `praktiKST.db` directly below the application directory. It is never moved, and it always uses the common station database, because that database is the installation's own.
- Additional profiles live under `profiles/<profileId>/`. `profileId` is a stable, file-system-safe slug assigned once; renaming a profile changes only its display name and never moves a directory.
- The registry `profiles.xml` is created lazily. An installation that has only the flat layout gets no registry and no `profiles/` directory; the root profile is synthesised in memory. Startup with no or exactly one profile therefore asks nothing and writes nothing, and a downgrade to an older release is a no-op.
@@ -270,6 +270,49 @@ section records only the durable architecture and operational boundaries.
## Important Decisions and Workarounds
- **The palette has three sources, and the later one wins role by role** (release 1.50): the
shipped stylesheet from the classpath, then the profile's own stylesheet file if present,
then the six role overrides stored in that profile's preferences. `resolvePalette` is a pure
function and reports the provenance of every role, which the colours tab shows per field --
with two sources able to decide the same colour, that is the only thing that keeps "why is
this colour what it is" answerable, and it is not optional.
- **A role is a selector and a property, not a property alone.** Three of the six are stated
outside `.root` (text on `.label`, the separator on `.separator *.line`), and
`-fx-background-color` alone appears a dozen times in the evening sheet. `JavaFxStylesheet.read`
returns a complete palette with Modena fallbacks and is right for layer 1;
`declaredRoles` returns only what a sheet actually names and is the only thing correct for
layer 2. Measured: the shipped daylight sheet states no colour at all, the evening sheet five.
- **The root profile's layer 2 always exists, and that is not a bug.** `copyResourceIfRequired`
writes `KST4ContestDefaultDay.css` and `…Evening.css` at every startup, and those are exactly
the paths `paletteRelativeFileName(rootProfile, …)` resolves to — reading them is what fixes
the long-standing defect that the copies were written and never read. Consequence to keep in
mind: on the default installation most roles report *from file*, not *shipped*, with the same
values. Anything keyed on provenance rather than on a colour's value will therefore misfire
there; `textAccent` did, and repainted the evening accent on upgrade.
- **A file stating `-fx-base` and no `-fx-background` states the derived window surface too**,
because that is what JavaFX does with it. The settings tab keeps the two roles independent —
the spec separates them so an operator can set one without the other — but a hand-edited
sheet follows the stylesheet language, or `-fx-base: #303030` would leave every window the
shipped light grey.
- **The contrast guard's pairs come from `Theme.kt`'s Material mapping, not from the role
names.** `background` and `surface` are both `windowBackground` with `labelTextFill` on them,
and `primary` is `textAccent`, not `accent`; `base` reaches the screen only through the menu
strip and the selection tint. Measuring text against `base` alone let an operator black out
every window and hear nothing.
- **`Kst4ContestTheme` must read the palette from the `PaletteStore`'s state, never from
`remember`.** That read is what makes a colour change recompose every open window;
`remember(darkMode)` held the palette until someone toggled day/evening, so a change reached
nothing. `ThemeReadsPaletteStoreTest` pins it.
- **The contrast guard is relative to the shipped sheet, not an absolute WCAG floor.** Measured:
the shipped sheets have three pairs under 4.5 themselves (daylight accent 2.86, evening accent
2.26, evening text-in-field about 2.9), so an absolute rule would warn on an untouched client
and teach the operator to ignore warnings. It reports a pair only when it is both under the
floor and worse than shipped, so the shipped state and any improvement never warn.
- **The "reset to the shipped colours" button never takes the active palette.** It receives the
shipped palette as a required parameter and reads no composition local, so it has no path to
the resolved one. An operator who sets text and surface to the same black cannot see any
other control, this one included, unless it refuses their palette.
- Preserve full callsign/category identity while applying base-call normalisation only to specifically defined features.
- Keep canonical worker-thread domain state separate from the row lists the user interface draws from.
- The station map is a Compose canvas that fetches its own tiles. The JavaFX WebView, the bundled Leaflet resources, the CSS-3D-transform workaround and the `TileProxyServer` were removed with JavaFX; offline DEM, terrain packages and the profile cache are unaffected and must stay that way.
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,240 @@
# Entwurf — die Farben pro Operateurprofil anpassbar machen
Vertieft: `docs/superpowers/specs/2026-09-25-compose-migration-design.md`, Etappe 8.
Dieser Entwurf ersetzt den dortigen Abschnitt. Er ist im September geschrieben worden, und
zwei seiner Annahmen stimmen nicht mehr.
## Ziel
Der Operateur bestimmt die Farben seines Clients, ohne Dateien im Installationsverzeichnis
anfassen zu müssen. Erfolg ist nachprüfbar:
- Eine geänderte Palette überlebt den Neustart.
- Sie gilt in **allen offenen Fenstern gleichzeitig**, nicht erst nach einem Fensterneubau.
- Sie ist **pro Profil** verschieden.
- Das Zurücksetzen stellt **exakt** die ausgelieferten Farben her — nicht etwas, das ihnen
gleicht.
## Was sich gegenüber dem Ursprungsabschnitt geändert hat
**Die Voraussetzung ist entfallen.** Er schreibt: „Ab Etappe 6 gibt es kein JavaFX mehr, das
dagegenhält — vorher muss beides dieselbe Datei lesen." Es gibt kein JavaFX mehr. Und der
`derive`-Pin, auf den er ausdrücklich wartet, ist seit Etappe 3 eine JavaFX-freie Umsetzung,
gegen eingecheckte Referenzwerte geprüft. Diese Etappe ist frei.
**Ein Befund kommt hinzu, den er nicht hatte.** `Kst4ContestTheme` liest die Palette als
`remember(darkMode)` (`Theme.kt:32`). Eine Palettenänderung erreicht die Fenster damit **gar
nicht**, bis jemand Tag/Abend umschaltet. Das Abnahmekriterium „gilt für alle Fenster
gleichzeitig" hängt also nicht an der Speicherung, sondern hier. Der Weg dafür existiert
bereits: `applyTheme` (`Kst4ContestApplication`) ruft `applyDarkMode` auf sechs Fenster-Wirten,
jeder hält einen `mutableStateOf` — nur trägt der heute bloß ein Boolean.
**Der Defektbefund bleibt richtig.** `copyResourceIfRequired` legt beim Start Kopien von
`KST4ContestDefaultDay.css` und `KST4ContestDefaultEvening.css` nach
`~/.kst4contest/` (`Kst4ContestApplication:2138`–`:2139`). Geprüft: **nichts liest sie.** Wer
seine Kopie bearbeitet, sieht keinerlei Wirkung.
## Die Quelle der Farben: drei Schichten
| | Schicht | Woher | Vorrang |
|---|---|---|---|
1 | **Auslieferung** | die Vorlage aus dem Klassenpfad | Boden, immer vorhanden |
2 | **Datei** | die CSS-Datei im Profilverzeichnis, falls vorhanden | überschreibt 1 |
3 | **Geändert** | die sechs Rollen aus den Einstellungen des Profils | überschreibt 1 und 2 |
**Die spätere Schicht gewinnt, Rolle für Rolle.** Eine Datei, die nur `-fx-base` nennt, ändert
nur diese Rolle; die übrigen kommen weiter aus der Auslieferung.
### Warum drei und nicht eine
Abgewogen wurden zwei Wege.
**Nur die CSS-Datei maßgeblich**, wie der Ursprungsabschnitt es wörtlich sagt, wurde
verworfen: eine Farbänderung müsste `-fx-base` in die 6,4-KB-Vorlage zurückschreiben, und das
braucht einen Serialisierer, der jede übrige Regel unverändert durchträgt. Ein Rundlauf, der
eine Regel verliert, zerstört das Aussehen still. `JavaFxStylesheet` ist ein Leser; ein
Schreiber daneben wäre die risikoreichste Stelle dieser Etappe, und die Anforderung — „ohne
Dateien anfassen zu müssen" — verlangt ihn nicht.
**Nur die Einstellungen** wäre das Einfachste und wurde bewusst nicht gewählt: es nimmt dem
Operateur den Handweg, den er heute zu haben *glaubt* (die Kopie liegt ja da), und der
Defektbefund würde gelöscht statt behoben.
**Gewählt: beide, mit ausdrücklichem Vorrang.** Der Preis ist benannt und wird im nächsten
Abschnitt bezahlt: bei zwei Quellen ist später nicht mehr ersichtlich, warum eine Farbe so
ist, wie sie ist.
### Was diesen Preis bezahlt
**Jede der sechs Rollen zeigt in der Oberfläche, woher ihr geltender Wert kommt** —
*Auslieferung*, *Datei* oder *geändert*. Die Auflösung weiß das ohnehin, es kostet nichts, und
ohne das ist die Frage „warum ist diese Farbe so?" unbeantwortbar. Das ist keine Zierde,
sondern die Bedingung, unter der die Dreischicht-Lösung vertretbar ist.
## Die sechs Rollen
Die, die `JavaFxPalette` benennt. Der Ursprungsabschnitt zählt fünf auf; es sind sechs,
weil `base` und `windowBackground` getrennt geführt werden — siehe unter der Tabelle.
| Rolle | im Palettenobjekt |
|---|---|
Fläche | `base` |
Fensterfläche | `windowBackground` |
Feldinneres | `controlInnerBackground` |
Text | `labelTextFill` |
Akzent | `accent` |
Trennlinie | `separatorLine` |
`base` und `windowBackground` sind getrennt, weil die Vorlagen sie getrennt führen und die
Fensterfläche aus der Fläche abgeleitet wird (`derive(base, 26.4%)`) — wer nur eine davon
setzen könnte, bekäme die andere ungefragt mitgezogen.
**Nicht anpassbar** bleiben `textAccent`, `buttonHoverGradient` und `buttonPressedBorder`. Sie
sind abgeleitete Werte, keine Rollen, die jemand einzeln wählen will; sie folgen dem Akzent.
`fontSizePx` ist eine bestehende Einstellung und wird hier nicht angefasst.
**Tag und Abend sind zwei Paletten.** Jede Rolle existiert zweimal, und eine Änderung am
Abendentwurf lässt den Tagentwurf unberührt.
## Die Wirkung ist sofort, und es gibt drei Wege zurück
**Eine Änderung gilt unmittelbar in allen offenen Fenstern.** Kein Musterfeld, kein
„noch nicht gespeichert"-Zustand.
Der Grund gegen ein Musterfeld ist die Geschichte dieses Projekts: die Fehlerklassen, die hier
wiederholt mit grünem Bau auslieferten, waren „sah einzeln richtig aus und war an seinem Platz
falsch". Ein zweihundert Pixel breites Muster ist genau diese Isolation. Es sagt nichts
darüber, wie die Stationsliste mit 22 Spalten in einer Palette liest. Das Einstellungsfenster
selbst ist die bessere Vorschau: es färbt sich mit und enthält Beschriftungen, Felder, Knöpfe
und Trennlinien — alles, was die sechs Rollen betrifft.
Weil es keinen Zwischenzustand gibt, sind die Rückwege keine Bequemlichkeit, sondern der
Ersatz dafür:
- **„Zurück zum Stand von vorher"** — beim Öffnen des Reiters wird die geltende Palette
gemerkt; dieser Knopf stellt sie wieder her. Das ist der Rückweg für den Normalfall: eine
Farbe im echten Fenster ausprobiert, gefällt nicht, weg damit.
- **„Meine Änderungen verwerfen"** — leert Schicht 3. Es gilt wieder Datei oder Auslieferung,
je nachdem, was da ist.
- **„Auf Auslieferung zurücksetzen"** — setzt alle Rollen auf die ausgelieferten Werte, als
ausdrückliche Änderung der Schicht 3. Damit spielt eine vorhandene Datei keine Rolle mehr.
**Das ist die Aktion, die das Abnahmekriterium erfüllt**, und sie erfüllt es auch dann, wenn
eine Datei im Spiel ist.
Mit einer Datei zwischen Auslieferung und Änderung kann **ein** Knopf nicht alle drei Fälle
abdecken: löscht er nur die Änderungen, gilt wieder die Datei und nicht die Auslieferung.
### „Auf Auslieferung zurücksetzen" wird immer in den ausgelieferten Farben gezeichnet
**Dieser eine Knopf nimmt die aktive Palette nicht an.** Er wird in den ausgelieferten Farben
gezeichnet, ganz gleich, was der Operateur eingestellt hat — Fläche, Text und Rahmen aus
Schicht 1, nicht aus der Auflösung.
Der Grund ist die Fehlerart, die sich sonst selbst einschließt: wer Text und Fläche auf
dasselbe Schwarz stellt, sieht die Knöpfe nicht mehr, mit denen er es zurücknehmen könnte. Ein
Tastaturweg allein hilft dann nur, wer ihn kennt. Ein Knopf, der die kaputte Palette nicht
annimmt, hilft immer.
Dass er dadurch bei einer stark angepassten Palette **fremd aussieht, ist beabsichtigt.** Er ist
eine Rettungsleine, keine Zierde; dass er sich nicht einfügt, macht ihn auffindbar.
Die anderen zwei Rückwege nehmen die aktive Palette an. Sie sind Bequemlichkeit für den
Normalfall; die Rettungsleine ist diese eine, und genau eine ist leichter zu merken als drei.
Ein Tastaturweg kommt zusätzlich, für alle drei. Er ist jetzt die zweite Absicherung, nicht
mehr die einzige.
## Die Datei im Profilverzeichnis
**Für das Wurzelprofil existiert sie schon:** `~/.kst4contest/KST4ContestDefaultDay.css` und
`…Evening.css`, von `copyResourceIfRequired` geschrieben. Sie wird jetzt **gelesen**. Das
behebt den dokumentierten Defekt, statt seine Spuren zu beseitigen, und gibt dem Operateur den
Handweg, den die Datei ihm die ganze Zeit versprochen hat.
**Für andere Profile wird nicht ungefragt kopiert.** Der Pfad folgt dem Muster, das
`OperatorProfilePaths` für Einstellungen und Datenbank schon benutzt: Wurzelprofil flach, sonst
`profiles/<id>/<datei>`. Eine Datei, die ungefragt entsteht und niemand braucht, ist dieselbe
Falle wie die bisherige ungelesene Kopie. Stattdessen schreibt ein Knopf im Reiter die Vorlage
ins Profilverzeichnis, wenn der Operateur von Hand bearbeiten will.
**Eine unlesbare oder fehlerhafte Datei darf den Start nicht verhindern.** Sie wird
übersprungen, die Rolle fällt auf die Auslieferung zurück, und der Reiter sagt es. Ein Client,
der wegen einer kaputten Farbdatei nicht startet, ist schlimmer als einer in den falschen
Farben.
## Dass es alle Fenster erreicht
Ein **`PaletteStore`** hält die Palette beider Entwürfe für das aktive Profil als
Compose-Zustand. `Kst4ContestTheme` liest daraus statt aus `remember(darkMode)`. Damit zeichnet
eine Änderung jedes offene Fenster neu — über denselben Weg, den der Tag/Abend-Wechsel schon
benutzt, und ohne dass `applyTheme` oder die sechs Fenster-Wirte etwas Neues lernen müssen.
Der Store wird beim Profilwechsel neu gebildet, wie jeder andere profilgebundene Zustand.
## Der Kontrastwächter
Eine frei gewählte Textfarbe auf einer frei gewählten Fläche kann unlesbar werden. Die
Oberfläche **sagt es, speichert aber trotzdem**: ein Funker, der im Contest bewusst eine harte
Kombination will, bekommt sie. Das Maß ist das WCAG-Kontrastverhältnis aus relativer
Leuchtdichte — eine reine Funktion, und damit der Teil, der falsch sein kann, ohne dass es
auffällt.
Geprüft werden die Paare, die tatsächlich übereinanderliegen: Text auf Fläche, Text auf
Feldinnerem, und Akzent auf Fläche.
## Prüfung
Das Wertvolle hier sind die Regeln, nicht die Oberfläche. Alle ohne Bildschirm prüfbar:
- **Die Dreischicht-Auflösung** samt Vorrang und Herkunftsangabe, einschließlich: Datei fehlt;
Datei nennt nur eine Rolle; Datei ist unlesbar; Änderung und Datei widersprechen sich.
- **Die drei Rückwege** — besonders, dass „auf Auslieferung" auch bei vorhandener Datei exakt
die ausgelieferten Werte ergibt, und dass „zum Stand von vorher" die Palette herstellt, die
beim Öffnen des Reiters galt, einschließlich einer damals schon vorhandenen Änderung.
- **Dass der Auslieferungs-Knopf die ausgelieferten Farben benutzt und nicht die aufgelöste
Palette** — geprüft mit einer Palette, in der jede Rolle auf etwas anderes gesetzt ist. Das
ist der Test, der die Rettungsleine davor bewahrt, still an der Palette zu hängen, die sie
retten soll.
- **Das Kontrastverhältnis**, gegen von Hand nachgerechnete Werte.
- **Dass Tag und Abend getrennt bleiben.**
- Dazu die Rückfalltests aus Etappe 7: Klasse 4 prüft, dass die Farben aus der Stilvorlage
kommen, und muss mit dieser Etappe weiter gelten.
## Was unverändert bleibt
- Die ausgelieferten Vorlagen selbst.
- `JavaFxStylesheet` als **Leser**. Kein CSS-Schreiber, nirgends.
- Der `derive`-Pin samt eingecheckter Referenztabelle und `JavaFxStylesheetTest`.
- Die Speicherung pro Profil über `ChatPreferences` — dieselbe wie jede andere Einstellung.
- `fontSizePx` und die bestehende Schriftgrößeneinstellung.
- Die Invarianten aus `AGENTS.md`.
## Risiken
**Die zweite Quelle ist der Preis dieser Etappe.** Zwei Schichten, die dasselbe bestimmen
können, sind eine Stelle, an der später niemand weiß, warum eine Farbe so ist. Die
Herkunftsangabe pro Rolle ist die einzige Gegenmaßnahme, und sie ist deshalb nicht optional.
**Eine Änderung, die alle Fenster erreicht, erreicht sie auch alle falsch.** Der `PaletteStore`
ist eine Stelle, an der ein Fehler sich überall gleichzeitig zeigt. Dafür zeigt er sich
wenigstens sofort und nicht erst nach einem Fensterneubau.
**Der Kontrastwächter warnt nur.** Ein Operateur kann sich einen unlesbaren Client bauen. Das
ist die Entscheidung, die hier bewusst bei ihm liegt, und der Ausweg ist der Knopf, der die
kaputte Palette nicht annimmt.
**Die Warnung des Wächters hat dieselbe Angreifbarkeit wie die Knöpfe** und ist nicht
ausgenommen: in einer unlesbaren Palette ist auch sie unlesbar. Sie auszunehmen wäre
folgerichtig, würde aber den Reiter mit zwei fremd aussehenden Flächen besetzen statt mit
einer. Ich lasse es bei der einen Rettungsleine und halte den Punkt hier fest, statt ihn
stillschweigend auszuweiten.
## Zwei Festlegungen, die sonst im Bau beliebig würden
**Die Wirkung ist sofort, der Rückweg gemerkt.** Kein Musterfeld — die Begründung steht unter
„Die Wirkung ist sofort". Beurteilt wird im echten Fenster, zurück geht es über eine beim
Öffnen des Reiters gemerkte Palette.
**Alle drei Rückwege bleiben.** Ohne Zwischenzustand sind sie der einzige Weg zurück, und alle
drei müssen ohne Farbwahrnehmung erreichbar sein — also auch über die Tastatur.