Make a Webel option help Rule relying on ‘$opt$’ naming conventions

Gallery

Tutorial

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.

Section

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

Tags and keywords

Mathematica keywords

Webel Mathematica keywords

Keywords

Click on the image to view it full size

Specifics of the function names and/or signatures shown may change.

The Doc` function makeOptRule creates a help Rule for a '$opt$' option with keys compatible for:

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'.

Please note that at this stage we are only examining use of the Webel '$opt$' help holders conventions in lower-level packages, which rely on "manual" naming conventions; in later slides we'll see how Webel extensions of MTools for OO such as the MOpt class can be used to encapsulate the help holders for the Webel options convention.

Up next

Webel ‘$arg$’, ‘def$arg$’, and ‘rule$arg$’ convention

Notes

[NAMING, OPTION, PATTERN, TIP]{OPTION} Mathematica: Webel: You CAN/MAY use $ in variable names and function names - just not as the first character before a Capital - and it's extremely useful. You won't get sent to Azkaban prison if do you use a $ character!

[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: CONVENTION: An '$opt$' (option) or '$arg$ (argument) help holder may be have an associated (typically short) '$lab$opt$' or '$lab$arg$' label help holder for use in GUIs and views.

[POLICY]{STRONG} About the Single Source of Truth (SSOT) and Don't Repeat Yourself (DRY) principles

[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'.

Snippets (quotes/extracts)

Visit also

The Webel SysML4Mathematica recipe for modelling Wolfram Language code in Systems Modeling Language (SysML) for Model-Based Systems Engineering

Visit also (backlinks)

Related slides (includes other tutorials)

The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"

The Webel '$opt$' option "help holder" convention

Related slides (backlinks, includes other tutorials)

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

Flags