Why the Webel HelpF` & HelpO` registries?

Gallery
Tutorial
[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.
Section
SECTION: The Webel Doc` package and the HelpF, HelpO`& HelpM` help registry packages
Mathematica keywords
Association
Webel Mathematica keywords
W`Base`
HelpF`
HelpO`
Keywords
Click on the image to view it full size
For reference, some associated Policy Notes (you don't need to visit these links yet):
Webel: Mathematica: The Method syntax for the user contributed MTools does not seem to support Method-specific ::usage. The Webel libraries offer method documentation support (including arguments and options) via the HelpO` class/method registry.
Mathematica: Webel ADT pseudo classes: There does not seem to be a way to register ::usage specific to a Webel ADT-Method (TagSetDelayed UpValue). The Webel libraries offer method documentation support via the HelpO` class/method registry.
The HelpF` package function registry and the HelpO` class/method registry use the same rich help registration format for arguments and options for functions and class methods respectively. The HelpO` package is introduced in more detail in slides later in this section. For MTools class methods the encapsulating MMethod class from the HelpM` package can also be used.
HelpO`: addClass: Register an MTools class by fully qualified package name
HelpO`: addMethod: MTools method registration example for the Webel MAll class and an object
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
Up next
The Webel HelpF` function registry
Notes
[CONVENTION, NAMING, POLICY]{SUGGESTED} Webel: Mathematica: CONVENTION: A '$doc$' prefix indicates a formatted documentation String helper. A '$doc$arg$' is for an argument, a '$doc$opt$' is for an option. A '$doc$ String may be used to create ::usage documentation via docF.
[CONVENTION, NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: A function's description (but not its signature, arguments, or options) may be captured as an '$info$f$' Stringhelp holder for use by the Doc` package for ::usage generation and the HelpF`& HelpO` help registry packages.
[CONVENTION, NAMING, POLICY]{SUGGESTED} Webel: Mathematica: CONVENTION: A '$sig$f$' prefix indicates a String signature helper for a function (or for a "method" of an MTools class or a Webel Abstract Data Type (ADT) pseudo class).
[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: Argument help holders use a String variable with the prefix '$arg$', a related '$info$arg$' String, a 'def$arg$' default value expression and/or 'req$arg$', and optional '$warn$arg$', '$tip$arg$, '$lab$arg$', 'type$arg$'..
[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: Option help holders use a String variable with the prefix '$opt$', a related '$info$opt$' String, a 'def$opt$' default value expression, and optional '$warn$opt$', '$tip$opt$', '$lab$opt$', and 'type$opt$' indicator ...
[POLICY]{SUBJECT-TO-CHANGE} Webel: Mathematica: The Method syntax for the user contributed MTools does not seem to support Method-specific ::usage. The Webel libraries offer method documentation support (including arguments and options) via the HelpO` class/method registry.
[CAPABILITY]{SUBJECT-TO-CHANGE} Mathematica: Webel ADT pseudo classes: There does not seem to be a way to register ::usage specific to a Webel ADT-Method (TagSetDelayed UpValue). The Webel libraries offer method documentation support via the HelpO` class/method registry.
Snippets (quotes/extracts)
Visit also
Visit also (backlinks)
Related slides (includes other tutorials)
Webel ‘$info$f$’ prefix convention for function help holder Strings
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
Related slides (backlinks, includes other tutorials)
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: helpPackage[$pac$HelpF]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset
HelpF`: Pull Mathematica Options[] for a function registered with addFunction
The HelpF` & TestF` packages: General query based help
HelpF`: packageFunctionTree[$pac]: Function ::usage help and signatures within a package
TestF`: Function search by argument number/kind to aid testing automation (1)
TestF`: Function search by argument number/kind to aid testing automation (2)
TestF`: Simple package function DownValues vs ::usage checker
HelpF`: Simple function DownValues inspector GUI: gui$helpDownStrings
HelpF`: gui$helpDownStrings signature display modes
The Webel HelpO`package class and method registry
HelpO`: addClass: Register an MTools class by fully qualified package name
HelpO`: addMethod: MTools method registration example for the Webel MAll class and an object
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
HelpO`: Find help on a method of a Webel MAll universal class object
HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
HelpM`: Using the Webel MClass helper with the MMethod helper and the HelpO` help registry
Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`
HelpM`: Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help registries
Generate shared option groups using ‘$opt$’ helpers: wl$optsFromOpts, docsFromOpts, rulesFromOpts, and odrMap triplet
HelpF`: OptionsPattern groups as SysML shared between functions
Webel ODR (Options, Docs, Rules) as SysML
HelpF`: usageF for ::usage generation example
HelpF`: UsageF ::usage generation: Example helpClass::usage
HelpF`: DownValues: sigsDown[f]: Signature(s) from ExpressionTree
The Webel HelpF` function registry