HelpOutlineTask

OpalTask that returns the H2/H3 outline of a help page.

Inherits OpalTask

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

Detailed description

Cheap pre-read: lets Opal pick an anchor to slice into via help.read.

Parameters: - path (required): qrc-relative .md path

Outputs: - title: page title from toc.json - count: number of headings - headings: JSON array of anchor,text,level

A page that the running app does not show is "no help page" (white-label-docs §WLO-A3c).

In this section