HelpListTask

OpalTask that enumerates pages under a help-tree subfolder.

Inherits OpalTask

In the namespace help. Declared in src/libs/libhelp/help/opal/HelpListTask.hpp.

Detailed description

Parameters: - folder (optional, default = root): qrc-relative folder path - recursive (optional, default false): if true, walk the whole subtree

Outputs: - count: number of pages - pages: JSON array of path,title,depth

The tree is the one that the running app shows (white-label-docs §WLO-A3c): HelpTocModel::load() applies the portal filter.

See also HelpTocModel.

In this section