Association

The Webel HelpF` function registry

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

Var` package: e$var$table[] filtering by package

Gallery

Tutorial

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

Section

SECTION: The Webel Var` package Entity-based variable registry

Var` package: Demo variables in e$var$table[] view

Gallery

Tutorial

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

Section

SECTION: The Webel Var` package Entity-based variable registry

Var` package: Extracted Associations

Gallery

Tutorial

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

Section

SECTION: The Webel Var` package Entity-based variable registry

An MOptSet can also be used in function Options[]

Gallery

Tutorial

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

Section

SECTION: The Webel MAll & MOptsSet classes MTools extensions (with SysMLv1 models)

Slide kind

SysML Activity Diagram

SysML Block Definition Diagram (BDD)

HelpF`: UsageF ::usage generation: Example helpClass::usage

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

HelpF`: usageF for ::usage generation example

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

The AOR Map as SysML Blocks with Rules

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

Slide kind

SysML Block Definition Diagram (BDD)

The AOR Map (Attributes, Options, Rules) Association: Example: aor$f$helpClass

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

Slide kind

SysML Block Definition Diagram (BDD)

The AOR Map (Arguments, Options, Rules): Integrated ::usage, HelpF`/HelpO` registration, and Options[] (without MTools)

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

Slide kind

SysML Block Definition Diagram (BDD)

About «pseudo» blocks (always prefixed with ‘@’)

This content has been marked as discussing an ADVANCED topic!

Gallery

Tutorial

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

Section

SECTION: Modelling the Wolfram Language in SysMLv1 and related Webel coding conventions

HelpM`: Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help 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

Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`

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

HelpM`: Using the Webel MClass helper with the MMethod helper and the HelpO` help registry

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

HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and 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

HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`

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

HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`

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

HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt

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

HelpO`: Find help on a method of a Webel MAll universal class object

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

HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods

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

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

HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset

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

HelpF`example: helpPackage[$pac$HelpF]

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

HelpF`example: helpFunction[$pac$HelpF, 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

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

Some Webel Utility` package functions

Gallery

Tutorial

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

Section

SECTION: A brief look at the Webel W`Base` utilities for Mathematica

Webel ‘$opt$’ help is much easier with the MOpt class using MTools!

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

Webel ‘$arg$’ help is much easier with the MArg class using MTools!

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

Easier ‘$arg$’ and ‘$opt$’ help Rules using the Webel MArg and MOpt helper classes and MTools for OO

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

Association as SysML: CASE: Webel @ArgMap «pseudo» block (slightly less "fiddly" as an Internal Block Diagram)

This content has been marked as discussing an ADVANCED topic!

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

Association as SysML: CASE: Webel @RuleMap and @ArgsMap «pseudo» blocks. Very "fiddly" to represent in a SysML Block Definition Diagram!

This content has been marked as discussing an ADVANCED topic!

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

Association vs Class as SysML CASE: Webel $arg$ and $opt$ help

This content has been marked as discussing an ADVANCED topic!

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

Webel ‘rule$arg$’ convention help consistency checks

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

Make a Webel argument help Rule with a default by convention OR override

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

Make a Webel help Rule for a required ‘$arg$’ argument + 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

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

Webel: Mathematica: A help Rule 'rule$arg' for an '$arg$' (argument) accepts keys: '$k$help' (required), '$k$def' (required if $k$req = True not given), '$k$req' (True if $k$def not given), '$k$warn', '$k$tip', '$k$lab', '$k$type', '$k$mult' and '$k$pat'

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

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

Webel: Mathematica: CONVENTION: Where keys of Associations are Strings they are encapsulated as variables prefixed with '$k$' (promotes DRY and has many advantages, such as IDE prompting). Direct use of "Strings" as keys is WET and strongly discouraged!

The Webel $k$ prefix convention for Association String keys

Gallery

Tutorial

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

Section

SECTION: Webel coding and naming conventions for the Wolfram Language

Concise {} for List and <||> for Association

Gallery

Tutorial

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

Section

SECTION: Modelling the Wolfram Language in SysMLv1 and related Webel coding conventions

Webel: SysML4Mathematica: An Association used as the Type of an argument or return is represented by a Block '<||>'. A List used as as the Type of an argument or return is represented by a Block '{}'. (Extending types may adapt the notation.)

Subscribe to Association