module::help
-- displays module
online documentationmodule::help
(mname)
displays plain text
module online documentation.
module::help(mname)
module::help(mname,fname)
mname |
- | module name: character string |
fname |
- | function name: character string |
the void object of type DOM_NULL
.
module::help
(mname)
displays the
introduction page of the plain text online documentation of the dynamic
module mname
if it is available. This online documentation
may be provided with the file mname.mdh
which then must be
located in the same directory as the module file
mname.mdm
.module::help
(mname,fname)
displays the
plain text help page of the module function mname::fname
.
This online documentation may be provided with the file
mname.mdh
which must then be located in the same directory
as the module file mname.mdm
.mname
respectively of the module function mname::fname
can be
displayed in a more convenient way using the module function
mname::doc()
respectively
mname::doc("fname")
.The first command displays the introduction page of the
module stdmod
. The seconds command displays the help page
of the module function stdmod
::doc
.
>> module::help("stdmod")
MODULE stdmod - Extended Module Management INTRODUCTION This module provides functions for an extended module management and also includes a function ``help'' for reading online documentation files of dynamic modules. INTERFACE age, doc, help, max, stat, which
>> module::help("stdmod","doc")
NAME stdmod::doc - Display online documentation SYNOPSIS stdmod::doc() stdmod::doc( func ) PARAMETER func - string, function name without the prefix "stdmod::" DESCRIPTION Displays a description of the module 'stdmod' respectively the module function stdmod::'func'. EXAMPLES >> stdmod::doc( "doc" ); NAME stdmod::doc - Display online documentation [...] SEE ALSO info, module::help
The same information can be displayed more convenient
using the module function stdmod::doc()
respectively
stdmod::doc("doc")
.
>> stdmod::doc()
MODULE stdmod - Extended Module Management INTRODUCTION This module provides functions for an extended module management and also includes a function ``help'' for reading online documentation files of dynamic modules. INTERFACE age, doc, help, max, stat, which
module::help
uses the module function
stdmod::help
to find and read the module online
documentation file.loadmod
.