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 Tags and keywords Mathematica keywords MTools MTools::Class MTools::method Association Webel Mathematica keywords W`Base` HelpO` MMethod MOpt MArg MFunction Keywords Wolfram Wolfram Language Mathematica Webel::SysML4Mathematica Webel IT Australia Abstract Data Types Webel:ADT Click on the image to view it full size Overview of the Webel HelpM` package with MTools-based help helper classes Up next HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF` Notes [TIP]{INFORMATIVE} Mathematica: TIPS for living with the user-contributed MTools for Object-Orientation (until a vendor-supported OO solution is eventually provided) [PATTERN, TIP, TOOL]{INFORMATIVE} Webel + Mathematica + MTools + SysML [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. Snippets (quotes/extracts) Visit also Visit also (backlinks) Related slides (includes other tutorials) Why the Webel HelpF` & HelpO` registries? The Webel HelpO`package class and method registry HelpO`: addClass: Register an MTools class by fully qualified package name HelpO`: addClass: Register an MTools class by fully qualified package name HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help Webel ‘$arg$’ help is much easier with the MArg class using MTools! HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help Webel ‘$opt$’ help is much easier with the MOpt class using MTools! Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt! Related slides (backlinks, includes other tutorials) HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF` HelpM`: Using the Webel MClass helper with the MMethod helper and the HelpO` help registry Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM` HelpM`: Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help registries Basic SysMLv1 example: The HelpM` package MTools classes as Blocks About «pseudo» blocks (always prefixed with ‘@’) SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions Convention-based MDemoConfig with fields for ‘$opt$’ options (works with any MTools class but prefer MOptsSet or MOpt) Flags Book traversal links for HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt Previous Up Next
