help

The help browser, its pages and the help.* tasks.

Detailed description

Function documentation

openHelpPage

bool help::openHelpPage(QWidget *window, const std::function<StandaloneScreenHost *()> &host, const QString &page)

Open a published page in the help browser of an app.

The "Help" link of the settings window needs somewhere to open a page (config-ui §CFGP-5). Construct had the first opener, in libconstruct. It moved here, so that every app with a settings window opens its pages the same way: on the window's ActivityStack when there is one, else on the standalone screen host, which already raises "LLM settings" and "Conversation history" over a window with no stack (§OLID-5). libopal cannot build HelpActivity, because libhelp depends on libopal, so this file registers it with the host.

window is the window of the app, host gives the standalone screen host when window has no stack, and page is a path under content/doc/published with an optional anchor. Returns false when no page opened.

Classes