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 Tags and keywords Mathematica keywords MTools MTools::Class Webel Mathematica keywords help holder MArg '$opt$' 'rule$opt$' makeOpt MAll.methodsTree MAll.asAssoc MOpt.asRule Keywords Wolfram Wolfram Language Mathematica Webel IT Australia Click on the image to view it full size Up next HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help Notes [NAMING, PATTERN, POLICY]{STRICT} Webel: Mathematica: CONVENTION: Argument help holders use a String variable with the prefix '$arg$', a related '$info$arg$' String, a 'def$arg$' default value expression and/or 'req$arg$', and optional '$warn$arg$', '$tip$arg$, '$lab$arg$', 'type$arg$'.. [PATTERN, TIP, TOOL]{INFORMATIVE} Webel + Mathematica + MTools + SysML [TIP]{INFORMATIVE} Mathematica: TIPS for living with the user-contributed MTools for Object-Orientation (until a vendor-supported OO solution is eventually provided) Snippets (quotes/extracts) Visit also The Webel SysML4Mathematica recipe for modelling Wolfram Language code in Systems Modeling Language (SysML) for Model-Based Systems Engineering Visit also (backlinks) Related slides (includes other tutorials) The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders" The Webel '$opt$' option "help holder" convention Make a Webel option help Rule relying on ‘$opt$’ naming conventions Why not just generate all the '$arg$' and '$opt$' help holders (using ToExpression)? Easier ‘$arg$’ and ‘$opt$’ help Rules using the Webel MArg and MOpt helper classes and MTools for OO Webel ‘$opt$’ help is much easier with the MOpt class using MTools! Related slides (backlinks, includes other tutorials) HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help Doc` package ::usage help generation using the docV and docF functions (2) HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO` HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF` HelpM`: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries) 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 Flags Book traversal links for Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt! Previous Up Next
