Enhance input UI

You may customize the script view using additional GUI-related options. Most of them are hints to improve the interface for your scripts. You should list options in curly braces in corresponding header lines. The order of the hints makes no difference. All options are optional.

Add captions and hints

You can add a custom caption for an input parameter. Proper caption helps the user to understand the meaning of the parameter. Caption will be rendered in the script input form.

Additinally, you can add a hint. To do that, place the hint text in the square brackets after the parameter annotation.

Result

Code

#input: double V1 { caption: Initial volume of liquid } [Used to calculate the initial concentration and the volume change]

Add units

You can add a proper unit label for an input parameter. The unit label will appear in the input form next to the input field.

Result

Code

#input: double initialTemp { units: °С }

Group inputs into categories

You can group script inputs into categories using the category tag.

Result

Short sample

#input: double initialPressure { caption: Initial pressure; category: Experimental data }
#input: double desiredPressure { caption: Goal pressure; category: Goals }

Full sample

#name: InputGroupingDemo
#language: python
#input: dataframe tempData { caption: Temperature data; category: Experimental data }
#input: double initialPressure { caption: Initial pressure; category: Experimental data }
#input: double desiredPressure { caption: Goal pressure; category: Goals }
#input: double desiredHumidity { caption: Goal humidity; category: Goals }