SECTION: The Webel '$opt$' and '$arg$' help holder conventions for options and arguments in the Wolfram Language

Icon class
icon_class_computed
far fa-bookmark
Tutorial
[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.
Keywords
Please make sure you've read the intro page about this highly technical trail on the Webel libraries for the Wolfram Language and SysML4Mathematica.

This section is provided primarily for reference and may be skipped in favour of sections with application examples. Many examples of the use of the conventions explained in detail here appear in other slides. However, if you wish to understand why the Webel libraries for the Wolfram Language and Mathematica are coded as they are, this section is essential reading!

This trail section has many cross-links to the supporting Webel SysML4Mathematica (v1) policy and convention note pages.
The conventions of this section are supported by the conventions explained in this preceding trail section:
SECTION: Webel coding and naming conventions for the Wolfram Language
Start section here
The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"
The Webel '$opt$' option "help holder" convention
Webel ‘$opt$grp$’ with grouping qualifier (where ‘grp$’ could be a package nickname)
Webel '$opt$' options help by function: Example: tableFunctionOptions[f]
Cleaner Options declarations!
Webel '$arg$' and '$opt$' support via the Doc` package
Functions from the W`Base`Doc` package
Make a Webel option help Rule relying on ‘$opt$’ naming conventions
Webel ‘$arg$’, ‘def$arg$’, and ‘rule$arg$’ convention
Make a Webel help Rule for a required ‘$arg$’ argument + conventions
Make a Webel argument help Rule with a default by convention OR override
Webel $arg$ convention help consistency checks
Webel ‘rule$arg$’ convention help consistency checks
Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage
When to use explicit $arg$ help holders (in lower level utility packages)
Why not just generate all the '$arg$' and '$opt$' help holders (using ToExpression)?
Why not just use the Entity system for '$arg$' and '$opt$' help holders?
Association vs Class as SysML CASE: Webel $arg$ and $opt$ help
Association as SysML: CASE: Webel @RuleMap and @ArgsMap «pseudo» blocks. Very "fiddly" to represent in a SysML Block Definition Diagram!
Association as SysML: CASE: Webel @ArgMap «pseudo» block (slightly less "fiddly" as an Internal Block Diagram)
Easier ‘$arg$’ and ‘$opt$’ help Rules using the Webel MArg and MOpt helper classes and MTools for OO
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
Webel ‘$opt$’ help is much easier with the MOpt class using MTools!
Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt!
HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions
The AOR Map (Arguments, Options, Rules): Integrated ::usage, HelpF`/HelpO` registration, and Options[] (without MTools)
The AOR Map (Attributes, Options, Rules) Association: Example: aor$f$helpClass
The AOR Map as SysML Blocks with Rules
Next trail section
SECTION: A brief look at the Webel W`Base` utilities for Mathematica
The Webel ‘$t$’ “pseudo type” indicator String convention (for optional additional documentation only)