@@ -1916,7 +1916,7 @@ parameter being described. All the attributes for the ``param`` element are
19161916documented below for completeness, but here are the common ones for each
19171917type are as follows:
19181918
1919- $attribute_list:name,type,optional,label,help,argument:4
1919+ $attribute_list:name,type,optional,label,help,argument,refresh_on_change :4
19201920
19211921### Parameter Types
19221922
@@ -1942,6 +1942,20 @@ rendered on the tool form as a text area instead of a single line text box.
19421942<param name="foo" type="text" area="True" size="5x25" />
19431943```
19441944
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+
19451959$attribute_list:value,size,area:5
19461960
19471961#### ``integer`` and ``float``
@@ -2236,6 +2250,11 @@ but not always the tool's input dataset).
22362250 <xs : documentation xml : lang =" en" ></xs : documentation >
22372251 </xs : annotation >
22382252 </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 >
22392258 <xs : attribute name =" force_select" type =" PermissiveBoolean" gxdocs : deprecated =" true" >
22402259 <xs : annotation >
22412260 <xs : documentation xml : lang =" en" >Used only if the ``type`` attribute
@@ -3260,7 +3279,7 @@ to the tool.
32603279```
32613280
32623281This 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)
32643283tool demonstrates using filters to sort a list and remove duplicate entries.
32653284
32663285```xml
@@ -3310,7 +3329,7 @@ tool demonstrates adding values to an option list using ``filter``s.
33103329</param>
33113330```
33123331
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.
33143333
33153334```xml
33163335<param name="species" type="select" label="Select additional species"
@@ -3375,7 +3394,7 @@ used with ``type`` of ``add_value``).</xs:documentation>
33753394 <xs : attribute name =" key" type =" xs:string" >
33763395 <xs : annotation >
33773396 <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 >
33793398 </xs : annotation >
33803399 </xs : attribute >
33813400 <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
34223441added to the end of the list.</xs : documentation >
34233442 </xs : annotation >
34243443 </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 >
34253451 </xs : complexType >
34263452 <xs : complexType name =" Outputs" >
34273453 <xs : annotation >
@@ -4802,7 +4828,7 @@ prepended with the warning ``Warning: Branch A was taken in execution``.
48024828 <xs : documentation xml : lang =" en" ><
48044830or 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)
48064832for simple examples of how this tag set is used in a tool. This tag set is
48074833optionally contained within the ``<data>`` tag set and is the container tag set
48084834for the following ``<when>`` tag set.]]> </xs : documentation >
@@ -4847,7 +4873,7 @@ in the ``<data>`` tag set with ``format="interval"``.
48474873See
48484874[extract_genomic_dna.xml](https://github.com/galaxyproject/tools-iuc/blob/master/tools/extract_genomic_dna/extract_genomic_dna.xml)
48494875or 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)
48514877for more examples.
48524878
48534879]]> </xs : documentation >
@@ -5057,6 +5083,7 @@ and ``bibtex`` are the only supported options.</xs:documentation>
50575083 <xs : enumeration value =" unique_value" />
50585084 <xs : enumeration value =" multiple_splitter" />
50595085 <xs : enumeration value =" add_value" />
5086+ <xs : enumeration value =" remove_value" />
50605087 <xs : enumeration value =" sort_by" />
50615088 </xs : restriction >
50625089 </xs : simpleType >
0 commit comments