FR-UI-4 — The bundled manual cannot be opened from the Flatpak #66

Open
opened 2026-09-25 03:30:09 +00:00 by dtourolle · 0 comments
Owner

The Flatpak build does not install the bundled manual, so its Help sheet's "See it" links and the Settings "Open the manual" row show an error.

Why

Since 1021635–150e53e the manual ships as docs/manual/index.html plus media/ on Arch (/usr/share/darkroom/manual), Windows (manual\ beside the exe) and Android (APK assets opened in ManualActivity). The desktop route hands the system opener a redirect page that points at index.html#anchor. Inside a Flatpak, the page would sit under /app, which a browser outside the sandbox cannot read, so installing the files alone is not enough.

Deliverable

A route that lets a Flatpak user reach the same page at the same anchor. Two candidates:

  • install under /app/share/darkroom/manual and copy the manual into the app's exported data dir (~/.var/app/<id>/data/) on first use, then open it via the OpenURI portal;
  • show it in-app, the way Android does.

Acceptance

  • "See it" on a gesture opens the manual at that gesture's section from the Flatpak build
  • the Settings "Open the manual" row works from the Flatpak build
  • dr_ui::manual::page() finds it through dr_plat dirs, never a raw path
**The Flatpak build does not install the bundled manual, so its Help sheet's "See it" links and the Settings "Open the manual" row show an error.** ## Why Since 1021635–150e53e the manual ships as `docs/manual/index.html` plus `media/` on Arch (`/usr/share/darkroom/manual`), Windows (`manual\` beside the exe) and Android (APK assets opened in `ManualActivity`). The desktop route hands the system opener a redirect page that points at `index.html#anchor`. Inside a Flatpak, the page would sit under `/app`, which a browser outside the sandbox cannot read, so installing the files alone is not enough. ## Deliverable A route that lets a Flatpak user reach the same page at the same anchor. Two candidates: - install under `/app/share/darkroom/manual` and copy the manual into the app's exported data dir (`~/.var/app/<id>/data/`) on first use, then open it via the OpenURI portal; - show it in-app, the way Android does. ## Acceptance - [ ] "See it" on a gesture opens the manual at that gesture's section from the Flatpak build - [ ] the Settings "Open the manual" row works from the Flatpak build - [ ] `dr_ui::manual::page()` finds it through `dr_plat` dirs, never a raw path
dtourolle added the size:Sdocs labels 2026-09-25 03:30:10 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: dtourolle/DarkRoom#66