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

    class help::HelpOpenTask

    OpalTask that opens the help browser on a specific page. More...

    Header: #include <HelpOpenTask>
    Inherits: OpalTask

    Detailed Description

    Use this when the user asks to *see*, *show*, *open*, or *navigate to* a topic in the help — not for read-only research from chat, which is what help.read is for.

    Parameters: - path (required): qrc-relative .md path (e.g. "howto/pairing/index.md") - anchor (optional): heading slug, without the leading #

    Outputs: - path: the path opened - anchor: the anchor opened (empty if none)