Learn about Webel's comprehensive SysMLv2 Workshop Seminar course!
Webel now has a SysMLv2 Online Self-Study course with self-test Quizzes!
Learn about the Webel Q&A     online self-testing system for SysML v2/v1

HelpF`: Pull Mathematica Options[] for a function registered with addFunction

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
Rule
List
Options
Webel Mathematica keywords
W`Base`
HelpF`
opts Association
optionsAssocFor
wl$extractOptionsFor
Keywords

If a function as been added to the HelpF` registry using addFunction a Webel options Association or a List of Rules for use with Wolfram Language Options can be obtained easily via the registry:

Click on the image to view it full size
Up next
HelpF`: usageF for ::usage generation example
Notes
[NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: A help Rule 'rule$opt$' for an '$opt$' (option) accepts keys: '$k$help' (required), '$k$def' (required), and optional '$k$warn', '$k$tip', '$k$lab' (a label), '$k$type' (indicator only), '$k$mult' (SysML multiplicity), and '$k$pat'.
[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 ...
Snippets (quotes/extracts)
Related slides (includes other tutorials)
Why the Webel HelpF` & HelpO` registries?
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset
Related slides (backlinks, includes other tutorials)
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
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 MPackage helper with MFunction and MClass and the HelpF` and HelpO` help registries
HelpF`: DownValues: sigsDown[f]: Signature(s) from ExpressionTree
Visit also
Visit also (backlinks)