Tags and keywords
To avoid any confusion about the previous two slides
The previous two slides using docF
with docFromArgRule
and docFromOptRule
to create ::usage
(in the 1st slide) and lots of 'rule$arg$' and 'rule$opt$' help Rules in options to addFunction
(in the 2nd slide) are merely a technical record of how to achieve DRY reuse in lower level packages only.
In other words, we are seeing how the integrated argument, options, and function help system is progressively "boot-strapped" with increasing degrees of reuse and automated convenience.
addFunction
is used by application packages in Webel projects!
Higher-level packages can instead use an AOR Map (Arguments, Options, Rules) Association generated using aorMap
, as we'll see in later slides, rather than dealing directly with low-level help Rules. Packages that use MTools can instead use MArg, MOpt, and MFunction from the HelpM` package as we'll also see in later slides.
But the HelpF` package can't itself use a full AOR Map (Arguments, Options, Rules) Association, and also does not use MTools, and is "upstream" from HelpM`. It can, however, at least use an ADR Map (Arguments, Docs, Rules) Association and/or ODR Map (Options, Docs, Rules) Association as shown in the next slide.