Skip to content

Commit

Permalink
more explicit docs for mandatory text parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
bernt-matthias committed Aug 10, 2023
1 parent 3841b31 commit caa1e9e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions lib/galaxy/tool_util/xsd/galaxy.xsd
Original file line number Diff line number Diff line change
Expand Up @@ -3248,6 +3248,19 @@ value of "V1".
<param name="xlab" type="text" value="V1" label="Label for x axis" />
```
Unlike other types of parameters, type="text" parameters are always optional, and tool
author need to restrict the input with validator elements. By using a profile of at
least 23.0 text parameters that set ``optional="false"`` or define a validator are
indicated as required, but without validator the tool can be executed in any case.
That is a mandatory text parameter should be implemented as:
```
<param name="mandatory" type="text" optional="false">
<validator type="empty_field"/>
</param>
```
The ``area`` boolean attribute can be used to change the ``text`` parameter to a
two-dimensional text area instead of a single line text box.
Expand Down

0 comments on commit caa1e9e

Please sign in to comment.