Skip to content

Commit 4b55ecd

Browse files
committed
Update documentation on staging_path_and_source_path
1 parent 2bfd283 commit 4b55ecd

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

lib/galaxy/tool_util/xsd/galaxy.xsd

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ A generalisation for macro tokens, templates and xml macros, i.e.
364364
`<macro name="a_template" type="template">` is identical to `<template name="a_template">`, and
365365
`<macro name="a_token" type="xml">` is identical to `<token name="a_token">`.
366366
367-
Note that
367+
Note that
368368
]]></xs:documentation>
369369
</xs:annotation>
370370
</xs:element>
@@ -5778,7 +5778,7 @@ More information can be found on Planemo's documentation for
57785778
<xs:documentation xml:lang="en"><![CDATA[
57795779
A string `[reverse_][SORT_COMP_]SORTBY` describing the desired sort order of the collection elements.
57805780
`SORTBY` can be `filename`, `name`, `designation`, `dbkey` and the optional `SORT_COMP` can be either
5781-
`lexical` or `numeric`. Default is lexical sorting by filename.
5781+
`lexical` or `numeric`. Default is lexical sorting by filename.
57825782
Note that lexical sorting is case sensitive, i.e. upper case characters come before lower case characters (e.g. "Apple" < "Banana" < "apple" < "banana").
57835783
]]></xs:documentation>
57845784
</xs:annotation>
@@ -6563,8 +6563,10 @@ paths for data or collection inputs set the ``data_style`` attribute to ``paths`
65636563
To include a dictionary with element identifiers, datatypes, staging paths, paths and metadata files set the ``data_style`` attribute to ``staging_path_and_source_path`` (element identifiers and datatypes are available since 24.0).
65646564
An example tool that uses ``staging_path_and_source_path`` is [inputs_as_json_with_staging_path_and_source_path.xml](https://github.com/galaxyproject/galaxy/blob/dev/test/functional/tools/inputs_as_json_with_staging_path_and_source_path.xml)
65656565
6566-
Note that the element identifiers are stored as lists, where the last element is the actual element identifier of the dataset
6567-
and the other elements the identifiers of the collections containing the dataset.
6566+
Note that the ``element_identifier`` field matches the type of input, which means for simple data inputs ``element_identifier`` is a string,
6567+
for multiple="true" data inputs ``element_identifier`` is a list of strings corresponding to the element identifiers of each dataset passed to the input.
6568+
For dataset collections the element identifier is a list of strings with as many items in the list as the nesting level of the collection (i.e. 1 for list, 2 for list:list, 3 for list:list:list etc),
6569+
where the first item represents the outermost element identifier and the innermost item represents the innermost element identifier of the collection.
65686570
65696571
For tools with profile >= 20.05 a select with ``multiple="true"`` is rendered as an array which is empty if nothing is selected. For older profile versions select lists are rendered as comma separated strings or a literal ``null`` in case nothing is selected.
65706572
]]></xs:documentation>

0 commit comments

Comments
 (0)