Use 'description' as help text for job parameters if the plug-in hasn't set any help text in the RequestInformation

[Johan Vallon-Christersson]

The 'Run analysis plugin' pop-up dialogue can contain a useful plugin help-text for the selected plugin definition/configuration. When the user clicks 'Next' (to set parameter) the help text is no longer available, i.e., in the 'configure job' dialogue.

It would be useful to have the possibility to open a separate window with the help text (from the 'Run analysis plugin' pop-up) so that the information is readily at hand when setting parameters and configuring the job, e.g., by clicking a button in the dialogue (see figure).

[Johan Vallon-Christersson]

The possibility to get a help-text pop-up from the 'configure job' dialogue would also be nice.

[Nicklas Nordborg]

The text you are referring to was not intended to be used as help text. In fact, help text for the parameters can be assigned to each parameter definition and will be displayed when that parameter is selected in the second step in the wizard.

Now, it seems like the plug-in you are referring to is a BASE 1 plug-in. I don't know if BASE 1 could have per-parameter help texts or if all information has to be given as one text that ends up in the description field of the plug-in configuration.

Most BASE 2 core plug-ins or other BASE 2 plug-ins doesn't contain help text in that field.

I don't think that a button in the first window will help very much, since no one will miss it until they get to the second step and then it is not possible to go back and open it. The text should be available on the second page and all following pages if it is a multi-step wizard.

[Johan Vallon-Christersson]

Replying to nicklas:
You are right. The text I'm referring to is the plugin definition/configuration description text. The particular featured example is a BASE2 plugin without configuration.

Completely agree that a button in the first window doesn't make sense. If made available it should be in the subsequent window(s). The pop up should contain the text in the description field of the plug-in definition and configuration.

[Nicklas Nordborg]

Ahh... yes it is a BASE 2 plug-in... But, then I think it is the plug-in that should be fixed. The BASE 2 API has designated fields for help texts that will show up in the parameter input window. See for example:

• ​RequestInformation.getDescription() for general help information
• ​PluginParameter.getDescription() for per-parameter help information

For BASE 1 plug-ins it may be a bit different since I think all information ends up in the 'description' field of the configuration.

Hmmm... may we can look for help text in the following order:

1. RequestInformation.getDescription()
2. The 'description' field of the configuration (if one is used)
3. The 'description' filed of the plug-in definition

I think that would cover all cases and would work with both BASE 2 plug-ins and BASE 1 plug-ins.

[Johan Vallon-Christersson]

Replying to nicklas:
Sounds like a good strategy

[Nicklas Nordborg]

(In [5159]) Fixes #1405: Use 'description' as help text for job parameters if the plug-in hasn't set any help text in the RequestInformation

Removed the generic (not so helpful) help text that the Base1PluginExecuter sets in the RequestInformation.