• OctoMY API
  • OctoMY API Reference
  • C++ Classes
  • OctoMY
  • HelpOutlineTask
  • help::HelpOutlineTask Class

    class help::HelpOutlineTask

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

    Header: #include <HelpOutlineTask>
    Inherits: OpalTask

    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