Link the Slipstream wiki from the viewer: Help menu + visible entry point; stretch: per-window "?" opens the matching wiki page #420

New issue

Closed

opened 2026-10-05 10:41:26 +00:00 by sky_line · 0 comments

sky_line commented

2026-10-05 10:41:26 +00:00

Owner

Make the Slipstream wiki (https://slipstreamviewer.org/wiki, being expanded in #415) easy to find from inside the viewer.

Add "Slipstream Wiki" (and probably "Slipstream website" / "Report a bug" if not already prominent) at the top of the Help menu (skins/default/xui/en/menu_viewer.xml, the Help menu around line 2149). Today it only has LL's Guidebook, Tutorial, Knowledge Base, Wiki, Community Forums, Support portal and Blogs.
Consider renaming / grouping LL's items under a "Second Life help" submenu so ours comes first.

2. Somewhere else visible

Options (pick 1-2; don't clutter):

Login screen: a "Help & guides" link (the login panel / splash).
Preferences: a small "Help" link in the floater footer, opening the wiki's settings page.
First-run / welcome notice: a one-time notification after the first login, "New to Slipstream? See the guide", linking to the wiki's Slipstream-features page.
Toolbar: an optional "Help" toolbar button (available in the toolbox, not on by default).

3. Stretch: per-window help -> the right wiki page

The viewer already has per-window help:

216 XUI floaters / panels carry a help_topic; the "?" title-bar button and F1 call LLViewerHelp::showTopic(topic) (llviewerhelp.cpp).
The URL comes from HelpURLFormat = http://viewer-help.secondlife.com/[LANGUAGE]/[CHANNEL]/[VERSION]/[TOPIC][DEBUG_MODE], i.e. LL's help site.

Proposal:

Map help topics to wiki pages: a help_topic -> wiki URL table (e.g. app_settings/help_topics_wiki.xml, or front-matter help_topics: lists in each wiki page, generated into a JSON the viewer ships). showTopic opens the mapped wiki page (with an #anchor for sections); unmapped topics fall back to LL's help (or the wiki home), so nothing breaks.
Make sure the "?" button is visible on the floaters the wiki covers (some floaters hide it). Add help_topic to Slipstream-only floaters (Gesture Sets, Discord tab, VRAM readout area, sound cache, HUD zoom notes, etc.).
Version-aware links: include [VERSION] so a future wiki can serve per-version pages; until then, the latest.
Wiki side: each page lists the help topics it covers, and a script cross-checks that every help_topic in the XUI maps to a page (part of the #415 drift check).

Done when

Help menu has a prominent Slipstream Wiki entry (+ one other visible entry point).
(Stretch) "?" / F1 on documented windows opens the matching wiki page; undocumented ones fall back sensibly; a check flags unmapped topics.

Make the Slipstream wiki (https://slipstreamviewer.org/wiki, being expanded in #415) easy to find from inside the viewer. ## 1. Help menu link (main goal) - Add **"Slipstream Wiki"** (and probably "Slipstream website" / "Report a bug" if not already prominent) at the **top of the Help menu** (`skins/default/xui/en/menu_viewer.xml`, the `Help` menu around line 2149). Today it only has LL's Guidebook, Tutorial, Knowledge Base, Wiki, Community Forums, Support portal and Blogs. - Consider renaming / grouping LL's items under a "Second Life help" submenu so ours comes first. ## 2. Somewhere else visible Options (pick 1-2; don't clutter): - **Login screen:** a "Help & guides" link (the login panel / splash). - **Preferences:** a small "Help" link in the floater footer, opening the wiki's settings page. - **First-run / welcome notice:** a one-time notification after the first login, "New to Slipstream? See the guide", linking to the wiki's Slipstream-features page. - **Toolbar:** an optional "Help" toolbar button (available in the toolbox, not on by default). ## 3. Stretch: per-window help -> the right wiki page The viewer already has per-window help: - **216 XUI floaters / panels carry a `help_topic`**; the "?" title-bar button and F1 call `LLViewerHelp::showTopic(topic)` (`llviewerhelp.cpp`). - The URL comes from **`HelpURLFormat`** = `http://viewer-help.secondlife.com/[LANGUAGE]/[CHANNEL]/[VERSION]/[TOPIC][DEBUG_MODE]`, i.e. LL's help site. Proposal: - **Map help topics to wiki pages:** a `help_topic -> wiki URL` table (e.g. `app_settings/help_topics_wiki.xml`, or front-matter `help_topics:` lists in each wiki page, generated into a JSON the viewer ships). `showTopic` opens the mapped wiki page (with an `#anchor` for sections); **unmapped topics fall back** to LL's help (or the wiki home), so nothing breaks. - Make sure the "?" button is **visible on the floaters the wiki covers** (some floaters hide it). Add `help_topic` to Slipstream-only floaters (Gesture Sets, Discord tab, VRAM readout area, sound cache, HUD zoom notes, etc.). - **Version-aware links:** include `[VERSION]` so a future wiki can serve per-version pages; until then, the latest. - **Wiki side:** each page lists the help topics it covers, and a script cross-checks that every `help_topic` in the XUI maps to a page (part of the #415 drift check). ## Done when - [ ] Help menu has a prominent Slipstream Wiki entry (+ one other visible entry point). - [ ] (Stretch) "?" / F1 on documented windows opens the matching wiki page; undocumented ones fall back sensibly; a check flags unmapped topics.

sky_line added the

feature

labels

2026-10-05 10:41:26 +00:00

sky_line added this to the 1.1.0 milestone

2026-10-05 17:02:31 +00:00

sky_line referenced this issue from a commit

2026-10-05 19:39:02 +00:00

Help menu: Slipstream wiki and website at the top, LL's help in a submenu

sky_line closed this issue

2026-10-05 19:39:02 +00:00

sky_line referenced this issue from a commit