The Webel HelpO`package class and method registry

Note that whilst the HelpO` package can be used for MTools classes and methods, it does not itself depend on MTools. This is so that it can be used also by the Webel Abstract Data Type (ADT) packages without any dependency on MTools. There is an additional supporting package HelpM` for MTools-specific aspects as we'll see in later slides.

The Webel HelpO` registry is not a priority topic for this slide trail, the next slides just show the basic idea. There are many examples throughout the later slides where applications of MTools and Webel ADTs are shown. Longer term, “built-in” Wolfram Language object orientation with code-based help and IDE integration would make the HelpO` registry largely redundant for the substantial object-oriented development used on Webel projects.

Recall that Webel IT Australia has a particular need for object-orientation with the Wolfram Language because of projects combining Systems Modeling Language (SysML) with Mathematica! Some Webel projects have many dozens of classes each with many methods.

Up next

HelpO`: addClass: Register an MTools class by fully qualified package name

Notes

[POLICY]{SUBJECT-TO-CHANGE} 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.

[CAPABILITY]{SUBJECT-TO-CHANGE} 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.

[CAPABILITY]{INFORMATIVE} 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.

[POLICY]{SUBJECT-TO-CHANGE} 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.

Snippets (quotes/extracts)

Visit also

Mathematica: POLICY NOTES for the Webel Abstract Data Type (ADT) pseudo classes with inheritance for the Wolfram Language

Visit also (backlinks)

Related slides (includes other tutorials)