How to Get Help?

This document lists different methods to get help in MeVisLab.

Key F1

Pressing the F1 key opens help in MeVisLab and in MATE.

In MeVisLab, the Help Overview page is opened.
In MATE, the help page containing information about the item currently under the mouse cursor is shown. This is implemented for
- MDL related files (module GUI description)
- Python scripting files

Searching

MeVisLab and MATE offer Views that allow for searching in the installed offline documentation.

And because the help documents of MeVisLab are also available online, an online Google search with the term you are looking for and 'MeVisLab' might provide what you were looking for.

Modules in a Network

Each module in a network shows a tooltip after a short while if the mouse is placed above the module.

The tooltip text contains

information about the general use of the module
a list of related modules under 'seeAlso'

If the Module Inspector view is visible, its Related tab shows related modules, ranked by their relatedness.

The module's context menu has the helpful the entries

'Show Example Network' that opens a network where you can see the use of the module in context of other modules that are needed for a particular module to work
'Show Help' that opens the HTML help of the module with more information about the module and its fields

Module Fields

Most of the fields of modules have a tooltip that briefly explains the use of that field.

The field's context menu has the entry 'Show Field Help' that opens the module's HTML help and scrolls to the entry of that field's help.

GUI Examples

MeVisLab is shipped with a number of example macro modules that demonstrate the use of GUI controls, such as buttons, sliders, layouters, or even more complex controls like a GraphicsView or an ItemModelView.

Type 'Test' or 'Example' into MeVisLab's quick search or module search to get a list of available example macro modules.

Online User Forum

There is a user forum where you can register for free and ask questions concerning certain modules or networks, or the development of modules. You can also report bugs that you found or exchange experiences with other users. Make sure to use the forum's search before posting a question; your question might already have been answered!