@@ -1916,7 +1916,7 @@ parameter being described. All the attributes for the ``param`` element are
1916
1916
documented below for completeness, but here are the common ones for each
1917
1917
type are as follows:
1918
1918
1919
- $attribute_list:name,type,optional,label,help,argument:4
1919
+ $attribute_list:name,type,optional,label,help,argument,refresh_on_change :4
1920
1920
1921
1921
### Parameter Types
1922
1922
@@ -1942,6 +1942,20 @@ rendered on the tool form as a text area instead of a single line text box.
1942
1942
<param name="foo" type="text" area="True" size="5x25" />
1943
1943
```
1944
1944
1945
+ As of 17.01, ``text`` parameters can also supply a static list of preset
1946
+ defaults options. The user **may** be presented with the option to select one of
1947
+ these but will be allowed to supply an arbitrary text value.
1948
+
1949
+ ```xml
1950
+ <param name="foo" type="text" value="foo 1">
1951
+ <option value="foo 1">Foo 1 Display</option>
1952
+ <option value="foo 2">Foo 2 Display</option>
1953
+ </param>
1954
+ ```
1955
+
1956
+ See [param_text_option.xml](https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/param_text_option.xml)
1957
+ for a demonstration of this.
1958
+
1945
1959
$attribute_list:value,size,area:5
1946
1960
1947
1961
#### ``integer`` and ``float``
@@ -2236,6 +2250,11 @@ but not always the tool's input dataset).
2236
2250
<xs : documentation xml : lang =" en" ></xs : documentation >
2237
2251
</xs : annotation >
2238
2252
</xs : attribute >
2253
+ <xs : attribute name =" refresh_on_change" type =" PermissiveBoolean" >
2254
+ <xs : annotation >
2255
+ <xs : documentation xml : lang =" en" >Force a reload of the tool panel when the value of this parameter changes to allow ``code`` file processing. See deprecation-like notice for ``code`` blocks.</xs : documentation >
2256
+ </xs : annotation >
2257
+ </xs : attribute >
2239
2258
<xs : attribute name =" force_select" type =" PermissiveBoolean" gxdocs : deprecated =" true" >
2240
2259
<xs : annotation >
2241
2260
<xs : documentation xml : lang =" en" >Used only if the ``type`` attribute
@@ -3260,7 +3279,7 @@ to the tool.
3260
3279
```
3261
3280
3262
3281
This more advanced example, taken from Mothur's
3263
- [remove.linage .xml](https://github.com/galaxyproject/tools-iuc/blob/master/tools/mothur/remove.lineage.xml)
3282
+ [remove.lineage .xml](https://github.com/galaxyproject/tools-iuc/blob/master/tools/mothur/remove.lineage.xml)
3264
3283
tool demonstrates using filters to sort a list and remove duplicate entries.
3265
3284
3266
3285
```xml
@@ -3310,7 +3329,7 @@ tool demonstrates adding values to an option list using ``filter``s.
3310
3329
</param>
3311
3330
```
3312
3331
3313
- While this fragment from maf_to_interval.xml demonstrates removing items.
3332
+ While this fragment from [ maf_to_interval.xml](https://github.com/galaxyproject/galaxy/blob/dev/tools/maf/maf_to_interval.xml) demonstrates removing items.
3314
3333
3315
3334
```xml
3316
3335
<param name="species" type="select" label="Select additional species"
@@ -3375,7 +3394,7 @@ used with ``type`` of ``add_value``).</xs:documentation>
3375
3394
<xs : attribute name =" key" type =" xs:string" >
3376
3395
<xs : annotation >
3377
3396
<xs : documentation xml : lang =" en" >When ``type`` is ``data_meta``, ``param_value``,
3378
- or ``remove_value`` - this is the name of the metadata key of ref to filter by.</xs : documentation >
3397
+ or ``remove_value`` - this is the name of the metadata key to filter by.</xs : documentation >
3379
3398
</xs : annotation >
3380
3399
</xs : attribute >
3381
3400
<xs : attribute name =" multiple" type =" PermissiveBoolean" default =" false" >
@@ -3422,6 +3441,13 @@ is the index into the list to add the option to. If not set, the option will be
3422
3441
added to the end of the list.</xs : documentation >
3423
3442
</xs : annotation >
3424
3443
</xs : attribute >
3444
+ <xs : attribute name =" meta_ref" type =" xs:string" >
3445
+ <xs : annotation >
3446
+ <xs : documentation xml : lang =" en" >Only used when ``type`` is
3447
+ ``remove_value``. Dataset to look for the value of metadata ``key`` to remove
3448
+ from the list.</xs : documentation >
3449
+ </xs : annotation >
3450
+ </xs : attribute >
3425
3451
</xs : complexType >
3426
3452
<xs : complexType name =" Outputs" >
3427
3453
<xs : annotation >
@@ -4802,7 +4828,7 @@ prepended with the warning ``Warning: Branch A was taken in execution``.
4802
4828
<xs : documentation xml : lang =" en" ><
4804
4830
or the test tool
4805
- [output_action_change_format .xml](https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/output_action_change_format .xml)
4831
+ [output_format .xml](https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/output_format .xml)
4806
4832
for simple examples of how this tag set is used in a tool. This tag set is
4807
4833
optionally contained within the ``<data>`` tag set and is the container tag set
4808
4834
for the following ``<when>`` tag set.]]> </xs : documentation >
@@ -4847,7 +4873,7 @@ in the ``<data>`` tag set with ``format="interval"``.
4847
4873
See
4848
4874
[extract_genomic_dna.xml](https://github.com/galaxyproject/tools-iuc/blob/master/tools/extract_genomic_dna/extract_genomic_dna.xml)
4849
4875
or the test tool
4850
- [output_action_change_format .xml](https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/output_action_change_format .xml)
4876
+ [output_format .xml](https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/output_format .xml)
4851
4877
for more examples.
4852
4878
4853
4879
]]> </xs : documentation >
@@ -5057,6 +5083,7 @@ and ``bibtex`` are the only supported options.</xs:documentation>
5057
5083
<xs : enumeration value =" unique_value" />
5058
5084
<xs : enumeration value =" multiple_splitter" />
5059
5085
<xs : enumeration value =" add_value" />
5086
+ <xs : enumeration value =" remove_value" />
5060
5087
<xs : enumeration value =" sort_by" />
5061
5088
</xs : restriction >
5062
5089
</xs : simpleType >
0 commit comments