HelpF`

HelpF` A Wolfram Language package within the Webel libraries for Mathematica. Manages a help registry for functions and their arguments and options. For a full description visit this detailed slide trail:

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

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

HelpF`: DownValues: sigsDown[f]: Signature(s) from ExpressionTree

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: Mathematica: Packages that import the Webel HelpF` package (but not MTools and the Webel HelpM` package) should use the 'usageF' function for ::usage String generation (rather than the 'docF' and 'docV' functions) and an AOR Map.

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

Webel ODR (Options, Docs, Rules) as SysML

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 Doc` package and the HelpF, HelpO`& HelpM` help registry packages

HelpF`: OptionsPattern groups as SysML shared between 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 Doc` package and the HelpF, HelpO`& HelpM` help registry packages

Generate shared option groups using ‘$opt$’ helpers: wl$optsFromOpts, docsFromOpts, rulesFromOpts, and odrMap triplet

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

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

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

HelpF`: gui$helpDownStrings signature display modes

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`: Simple function DownValues inspector GUI: gui$helpDownStrings

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

HelpF`example: addFunction (2)

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: addFunction (1)

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

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

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

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.

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

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