mhoennig
3310cab7be
Werkbaum hat kein Backend, und das eigentlich Schwere an gemeinsamem Bearbeiten ist das Zusammenführen gleichzeitiger Änderungen — im Plan als `[!] Merging simultaneous edits` markiert. Etherpad hat das gelöst. Also geliehen statt nachgebaut: das Pad ist die Schreibfläche, Werkbaum die Ansicht. Nachgemessen an pad.hostsharing.net, bevor irgendwas gebaut wurde: - der Klartext-Export sendet `Access-Control-Allow-Origin: *`, - das kanonische Beispiel (SPEC §10) kommt byte-identisch zurück, - der HTML-Export zeigt kein Listen-Markup — Etherpad deutet `-` nicht zur Aufzählung um und behält die führenden Leerzeichen. Das war das Risiko, das die Idee hätte erledigen können. Nicht geprüft ist das Tippen im Etherpad-Editor selbst (Tab-Einrückung, mögliches Auto-Bullet); dafür braucht es einen echten Browser. Eigener Parameter statt `?sourceUrl=`: Die URL, die ein Mensch in der Hand hat, ist die Pad-URL — `/export/txt` hängt Werkbaum selbst an. Vor allem aber lizenziert der eigene Parameter das andere Verhalten, sodass D23 unangetastet bleibt: `sourceUrl` heißt weiter „statische Datei, einmal pro Laden geholt", bestehende Links bekommen kein Polling. Name und id sind die vollständige Pad-URL (Pad-Namen sind nur pro Instanz eindeutig). Textfeld schreibgeschützt, Knopf öffnet das Pad: ohne das verschwände getippter Text beim nächsten Abruf. Schrift bleibt Tinte statt grau — hier wird gelesen, der Plantext ist der Hauptinhalt. Drei Riegel im Takt, jeder aus einem echten Fehler: - `padBusy` — im Netzwerk-Mitschnitt stapelten sich die Abrufe, weil die Gegenseite langsamer war als der Takt; eine spät eintreffende alte Antwort hätte neueren Text überschrieben, - Abbruch nach 10 s — sonst bliebe der Riegel bei hängender Gegenseite für immer zu, - `visibilityState` + `visibilitychange` — nicht im Hintergrund abrufen, aber bei Rückkehr sofort. Der Stabilitätstakt übernimmt erst beim zweiten gleichen Abruf, sonst sieht man die anderen mitten im Tippen. Die Normalisierung der Pad-Adresse liegt headless in `remote.js`, damit sie testbar ist (23 neue Tests, 60 -> 83). Im Vorschau-Browser meldet `visibilityState` „hidden" und HMR lädt bei jeder Quelländerung neu — ein Reload sieht wie eine geglückte Übernahme aus; nachgewiesen wurde die Übernahme deshalb mit einem Marker auf `window`, der einen Reload nicht überlebt. SPEC §9 zuerst, dann D31, dann Code. Der Plan bekommt den Knoten nach D30 mit `[x]`, nicht `[^]`.
105 lines
4.6 KiB
Plaintext
105 lines
4.6 KiB
Plaintext
%% Werkbaum, planned with Werkbaum — what exists today and where it could go.
|
|
%% Distilled from docs/ROADMAP.md, docs/TASKS.md and docs/DECISIONS.md.
|
|
|
|
[~] Werkbaum (XXL) https://github.com/mhoennig/werkbaum
|
|
- [^] Notation (L)
|
|
- [^] Line format (M)
|
|
- [^] Status box, eight states (S)
|
|
- [^] T-shirt size and the "decompose from M" rule (S)
|
|
- [^] People tags, bare URLs, %% comments (XS)
|
|
- [^] And/or decomposition (S)
|
|
- [x] Optional nodes — neither required nor an alternative (S)
|
|
- [-] A separate storage format for the structure (L) %% the text is the format
|
|
- [ ] Ticket references #123 (S)
|
|
- [?] Benefit per node, not only cost (M)
|
|
| [?] Another sigil next to the size (S)
|
|
| [?] Story points behind the T-shirt sizes (M)
|
|
- [~] Editor (XL) https://werkbaum.javagil.de
|
|
- [^] Live diagram from text (M)
|
|
- [^] Parser (S)
|
|
- [^] Renderer, three layout modes (M)
|
|
- [^] Horizontal fan (S)
|
|
- [^] Vertical, transposed (S)
|
|
- [^] Compact (S)
|
|
- [^] Cheapest path (M)
|
|
- [^] Cost model, missing size counts as M (S)
|
|
- [^] Metro-map line through the leaves (S)
|
|
- [^] Export (M)
|
|
- [^] SVG and PNG download (S)
|
|
- [^] PNG to the clipboard (S)
|
|
+ [^] Print stylesheet (XS)
|
|
- [^] Nine interface languages (M)
|
|
- [^] Translations (S)
|
|
- [^] Default taken from the browser (XS)
|
|
- [^] Accessibility: aria labels, focus order (S)
|
|
- [^] Works on a phone (S)
|
|
- [^] Several documents in one editor (M)
|
|
- [^] Switcher in the editor title bar (S)
|
|
- [^] Load a document from ?sourceUrl= (S)
|
|
- [^] Jump between diagram and text (S)
|
|
- [ ] Open and save .werkbaum files (S)
|
|
+ [x] Show what is new since your last visit (S)
|
|
+ [?] A pastel colour per person (S)
|
|
- [?] Dates and milestones (M)
|
|
| [?] An attribute in the line (S)
|
|
| [?] A separate timeline view (L)
|
|
- [^] Build and delivery (M)
|
|
- [^] One self-contained file, bundled by Vite (S)
|
|
- [^] Unit tests (S)
|
|
- [^] Published on every push (S)
|
|
- [-] Deploy through a gh-pages branch (S) %% GitHub Actions instead
|
|
- [-] Fonts from Google (XS) %% self-hosted, no third-party request
|
|
- [ ] Backend (XL)
|
|
- [ ] Kotlin and Spring Boot scaffold (M)
|
|
- [ ] Gradle Kotlin DSL, JDK 21 (S)
|
|
- [ ] Health endpoint and CI (S)
|
|
- [ ] Documents on the server (L)
|
|
- [ ] Text plus metadata, no structure format (M)
|
|
- [ ] REST endpoints (S)
|
|
- [ ] Persistence (S)
|
|
- [ ] Share by link (S)
|
|
- [?] Accounts and permissions (L)
|
|
| [?] Single user, one token (S)
|
|
| [?] Log in with OIDC (L)
|
|
- [~] Working together on one plan (XL)
|
|
- [x] Watch a shared Etherpad — it merges, we render (S)
|
|
- [x] Load the pad's plain-text export (XS)
|
|
- [x] Keep up while the others type (XS)
|
|
+ [?] Embed the pad beside the diagram (M) %% costs the jump to the line
|
|
- [ ] Git as the shared store (L)
|
|
| [ ] A file in a repository, changed by pull request (S) %% works today, no code
|
|
| [?] The backend commits every change (L)
|
|
- [?] History and restore (M)
|
|
- [?] Diff between two versions (S)
|
|
- [?] Who changed this line (S)
|
|
- [?] A branch per scenario (S)
|
|
- [?] Live editing, several people at once (XL)
|
|
- [ ] Transport over a websocket (S) %% the easy half
|
|
- [!] Merging simultaneous edits (L) %% the actual work
|
|
| [?] Text CRDT — the plan is plain text, so it fits (L)
|
|
| [?] Operational transformation (XL)
|
|
- [?] Cursors and who else is here (S)
|
|
- [-] A merge algorithm of our own (XL) %% solved problem, do not reinvent
|
|
- [?] Mermaid plugin (XL)
|
|
- [!] A layout engine of its own (XL) %% measure, place, route — the real work
|
|
- [ ] Measure node sizes (M)
|
|
- [ ] Text metrics without a browser (S)
|
|
- [ ] Badges and tags inside the box (S)
|
|
- [ ] Place nodes and route connectors (L)
|
|
- [ ] All-of fan (M)
|
|
- [ ] Horizontal (S)
|
|
- [ ] Transposed (S)
|
|
- [ ] Any-of rail (S)
|
|
- [?] Registration with Mermaid (M)
|
|
| [?] External diagram, self-hosted pages only (M)
|
|
| [?] Pull request into Mermaid itself (L)
|
|
- [?] Tracker integration (XL)
|
|
| [?] Taiga (L) https://taiga.io
|
|
- [ ] Resolve #123 over the REST API (M)
|
|
- [ ] Read title, link and status (S)
|
|
- [ ] Map the workflow onto the states (S)
|
|
- [?] Write the status back (M)
|
|
- [-] A plugin inside Taiga itself (L) %% legacy frontend, self-hosted only
|
|
| [?] Tenzu, the successor (XXL) https://tenzu.net
|
|
| [ ] No tracker, plain text is enough (XS)
|