mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-11-01 11:14:34 +08:00
John Chilton
701c6f552d
- Allow tools to declare markdown help. - Allow tools to reference help terms from their Markdown tools. - Auto generate help terms for each datatype from values in datatypes_conf.xml - Add permenant links for each help term - both the auto generated ones and the YAML specified ones. - Add some initial help terms for collection operations. - Use new help term for "map over" from tool form.
81 lines
1.2 KiB
XML
81 lines
1.2 KiB
XML
<tool id="help_features_rst" name="help_features_rst" version="1.0.0">
|
|
<command>
|
|
cp '$input.file_name' '$output'
|
|
</command>
|
|
<inputs>
|
|
<param name="input" type="data" format="txt" />
|
|
</inputs>
|
|
<outputs>
|
|
<data name="output" format="txt" />
|
|
</outputs>
|
|
<help><![CDATA[
|
|
Header
|
|
-------
|
|
|
|
SubHeader
|
|
---------
|
|
|
|
SubSubHeader
|
|
~~~~~~~~~~
|
|
|
|
Some text here....
|
|
|
|
----
|
|
|
|
.. class:: warningmark
|
|
|
|
'''TIP''' This tool requires *txt* format.
|
|
|
|
----
|
|
|
|
.. class:: infomark
|
|
|
|
Here is some extra info....
|
|
|
|
----
|
|
|
|
Example Table from RST Docs....
|
|
|
|
|
|
.. list-table:: Title of the table.
|
|
:widths: 25 25 50
|
|
:header-rows: 1
|
|
|
|
* - Heading row 1, column 1
|
|
- Heading row 1, column 2
|
|
- Heading row 1, column 3
|
|
* - Row 1, column 1
|
|
-
|
|
- Row 1, column 3
|
|
* - Row 2, column 1
|
|
- Row 2, column 2
|
|
- Row 2, column 3
|
|
|
|
----
|
|
|
|
**negative example**
|
|
|
|
.. code-block::
|
|
:caption: Doesn't work in Galaxy
|
|
|
|
Code with captions doesn't seem to work.
|
|
|
|
|
|
----
|
|
|
|
.. code-block::
|
|
|
|
The output of this line has no spaces at the beginning.
|
|
|
|
----
|
|
|
|
Static path images...
|
|
|
|
.. image:: ${static_path}/images/tools/collection_ops/zip.svg
|
|
:width: 500
|
|
:alt: Zipping operation
|
|
|
|
|
|
]]></help>
|
|
</tool>
|