itom.pluginHelp¶
-
itom.
pluginHelp
(pluginName[, dictionary = False]) → generates an online help for the specified plugin.¶ Gets (also print to console) the initialisation parameters of the plugin specified pluginName (str, as specified in the plugin window). If dictionary == True, a dict with all plugin parameters is returned and nothing is printed to the console.
Parameters: pluginName : {str}
is the fullname of a plugin as specified in the plugin window.
dictionary : {bool}, optional
if dictionary == True, function returns a dict with plugin parameters and does not print anything to the console (default: False)
Returns: out : {None or dict}
Returns None or a dict depending on the value of parameter dictionary.