HelpO`

HelpO` A Wolfram Language package within the Webel libraries for Mathematica. Manages a help registry for classes and methods of MTools classes and Webel Abstract Data Type (ADT) pseudo classes. For a full description visit this detailed slide trail:

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

HelpO`: Options management for MTools methods (lookup replaces OptionValue[])

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)

The Webel MAll universal class for MTools integrates with the HelpO` method registry

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)

Mathematica: Webel ADT pseudo classes: There does not seem to be a way to register ::usage specific to a Webel ADT-Method (TagSetDelayed UpValue). The Webel libraries offer method documentation support via the HelpO` class/method registry.

Webel: Mathematica: The Method syntax for the user contributed MTools does not seem to support Method-specific ::usage. The Webel libraries offer method documentation support (including arguments and options) via the HelpO` class/method registry.

ADT`: helpADT[class]: help on methods registered with HelpO`: Example: XL$Cell

Gallery

Tutorial

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

Section

SECTION: The Webel Abstract Data Type (ADT) stateless pseudo-classes with inheritance (with SysMLv1 models)

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

HelpO`: addMethod: MTools method registration example for the Webel MAll class and an 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`: addClass: Register an MTools class by fully qualified package name

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 Webel HelpO`package class and method 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

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

Detailed overview of Webel utilities W`Base` packages with usages

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

Overview of Webel utilities W`Base` packages as SysML Usages

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: Mathematica: CONVENTION: A '$t$' prefix indicates a String help holder with a "pseudo type" indicator (for human friendly documentation only). Used by the Doc`, HelpF`, and HelpO` packages.

The Webel ‘$t$’ “pseudo type” indicator String convention (for optional additional documentation only)

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

Webel: Mathematica: CONVENTION: A function's description (but not its signature, arguments, or options) may be captured as an '$info$f$' Stringhelp holder for use by the Doc` package for ::usage generation and the HelpF`& HelpO` help registry packages.

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

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

Subscribe to HelpO`