## `module::help` -- displays module online documentation

#### Introduction

`module::help``(mname)` displays plain text module online documentation.

#### Call(s)

`module::help(mname)`
`module::help(mname,fname)`

#### Parameters

`mname` | - | module name: character string
`fname` | - | function name: character string

#### Returns

the void object of type `DOM_NULL`.

#### Related Functions

`module::new`, `module::stat`

#### Details

- The online documentation of a dynamic module usually consists of a brief introduction page about the features of the module followed by help pages for all functions of the module.
- `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`.
- The online documentation of the module `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")`.

#### Example 1

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

#### Example 2

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

#### Background

- `module::help` uses the module function `stdmod::help` to find and read the module online documentation file.
- The search paths for the module online documentation is equal to those used for dynamic module files. Additional information are given with the kernel function `loadmod`.
- Reference: Dynamic Modules - User's Manual and Programming Guide for MuPAD 1.4, Andreas Sorgatz, Oct 1998, Springer Verlag, Heidelberg, with CD-ROM, ISBN 3-540-65043-1. Section 3.4 describes the file format of the module online documentation file.

Do you have questions or comments?
Copyright © SciFace Software GmbH & Co. KG 2000