HelpF`: OptionsPattern groups as SysML shared between functions

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
Topic level
ADVANCED
UML keywords
Generalization
SysML keywords
Block
value property
part property
Mathematica keywords
::usage
Join
Webel Mathematica keywords
W`Base`
HelpF`
addFunction
'$info$f$'
'$opt$'
'rule$opt$'
'$sig$f$'
odrMap
docsFromOpts
rulesFromOpts
wl$optsFromOpts
downStrings
upStrings
sigsUp
findUpStarts
optVars
ODR<||>
«M:Join»
«M:Opt»
Keywords
This content has been marked as discussing an ADVANCED topic!
If you aren't interested in complex Systems Modeling Language (SysMLv1) representations of Wolfram Language code by all means simply skip these slides and visit this slide instead for some more Mathematica-oriented examples!
Click on the image to view it full size
For reference, an associated Policy Note (you don't need to visit this link yet):
Webel: SysML4Mathematica: An OptionsPattern[] may be represented by an «M:OptionsPattern» SysMLv1 Block with «M:Opt» properties. An «M:Opt» property represents an Options[] Rule IMPLICITLY (an «M:Opt» does not use the Rule block modelling recipe).
There's a detailed discussion of the pros and cons of the options group strategy and the "Mathematica Join as SysML Generalization" strategy under this earlier slide:
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions
Up next
Webel ODR (Options, Docs, Rules) as SysML
Notes
[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 ...
[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'.
[CONVENTION, MODELLING, NAMING]{STRICT} Webel: SysML4Mathematica: An OptionsPattern[] may be represented by an «M:OptionsPattern» SysMLv1 Block with «M:Opt» properties. An «M:Opt» property represents an Options[] Rule IMPLICITLY (an «M:Opt» does not use the Rule block modelling recipe).
Snippets (quotes/extracts)
Visit also
Visit also (backlinks)
Related slides (includes other tutorials)
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions
Why the Webel HelpF` & HelpO` registries?
HelpF`example: helpFunction[$pac$HelpF, addFunction]
DRY not WET! "Don't Repeat Yourself!"
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage
The sigsUp function with OptionsPattern modelled as a SysML Activity (and with "pseudo functional" representation)
The sigsUp/Down functions as a SysML BDD: With Options Block and pseudo functional indicators
Extract Options from an OptionsPattern[] in a SysML Activity (1)
Extract Options from an OptionsPattern[] in a SysML Activity (2) DETAILED
Related slides (backlinks, includes other tutorials)
Webel ODR (Options, Docs, Rules) as SysML