Options

Webel: Mathematica: CONVENTION: A 'type$' indicator for an '$opt$' or '$arg$' is for documentation only. It may use a "pattern helper", a human-friendly String, or a SysML-similar short-hand type representation. It need not correspond to a valid Pattern.

Webel: Mathematica: The Method syntax for the user contributed MTools does not seem to support Wolfram Language Options[]. The Webel MTools extensions offer options support via a Webel Options Association in combination with the HelpO` method registry.

Mathematica: Webel ADT pseudo classes: Webel ADT-Methods support Wolfram Language Options[] as TagSetDelayed UpValues (but there are some pros and cons). Webel ADT-Methods work with the Webel HelpO` class/method registry, including rich help on options.

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

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)

SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions

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

Slide kind

SysML Block Definition Diagram (BDD)

Extract Options from an OptionsPattern[] in a SysML Activity (2) DETAILED

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

The sigsUp/Down functions as a SysML BDD: With Options Block and pseudo functional indicators

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

HelpF`: packageFunctionTree[$pac]: Function ::usage help and signatures within a package

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 HelpF` & TestF` packages: General query based help

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

Webel ManGUI` examples: man$bool and man$group$pane

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

The Webel ManGUI` package has some shorthand '$man$' option aliases

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

Utility`package: stripOpt and stripOpts Delegating subsets of Options

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

Extract Options from an OptionsPattern[] in a SysML Activity (1)

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

The sigsUp function with OptionsPattern modelled as a SysML Activity (and with "pseudo functional" representation)

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

Webel ‘def$’ DRY default capture! Applicable to arguments and options.

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

When to use explicit $arg$ help holders (in lower level utility packages)

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

Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage

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

Functions from the W`Base`Doc` package

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$' and '$opt$' support via the Doc` package

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

Cleaner Options declarations!

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 '$opt$' options help by function: Example: tableFunctionOptions[f]

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 ‘$opt$grp$’ with grouping qualifier (where ‘grp$’ could be a package nickname)

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

The Webel '$opt$' option "help holder" 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: 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 ...

Subscribe to Options