HelpReadTask
OpalTask that reads a help page's markdown.
| Inherits | OpalTask |
In the namespace help. Declared in src/libs/libhelp/help/opal/HelpReadTask.hpp.
Detailed description
Parameters: - path (required): qrc-relative .md path - anchor (optional): if set, returns only the section under the heading with that slug, ending at the next H2/H3 (whichever level the anchor's heading is at, or shallower).
Outputs: - path: the resolved page path - bytes: length of the returned markdown - truncated: "1" if the result was capped at the size limit, "0" otherwise - markdown: the markdown text (raw — no rendering)
The task reads the pages that the running app shows (white-label-docs §WLO-A3c). A page that the portal filter leaves out is "no help page", and a link into such a page is its plain text.