deployhelp('install')
deployhelp('install', verbose)
deployhelp('add', module_name, module_help_dir)
deployhelp('remove', module_name)
[status, message] = deployhelp('uninstall')
status = deployhelp('status')
[status, message] = deployhelp('refresh')
| Parameter | Description |
|---|---|
| 'install' | Install the local help system (all modules, all languages). Optional second argument verbose (logical) controls verbosity; default is true. |
| module_name | Name of the module to add or remove from the local help tree. |
| module_help_dir | Directory containing the module's help archive(s). |
| verbose | logical scalar (true/false). When provided to 'install' it controls whether install steps show verbose output. |
The function manages a local, versioned help directory under userdir()/Nelson/<version>/help/.
Actions:
install: creates and installs the local help system (calls docroot('.') and install locally). Use the optional verbose boolean to toggle output.
add: extracts per-language .nhz help archives found in module_help_dir/help/ into the versioned help/lang/<module_name> directories.
remove: removes the module help directory for each language.
refresh, uninstall, status: respectively refresh the help database, uninstall the local help system, or return whether the local help folder exists. Actions that can fail return [status, message].
| Version | Description |
|---|---|
| 1.15.0 | initial version |