complex help for conditional param
Hi all, In the conditional param, when sub-element allows you to write specific parameters for a particular value selected. I am wondering how to write the help context according to the value selection. For example, if there is a conditional param called blast_type, when "blastn" is selected, the help context will be "blast dna against dna" and when "blastp" is selected, the help context will be "blast protein against protein". Basically this selection-based help text provides a general description of the selection, which could help to set up the corresponding parameters. By the way, is there any document about formatting text in the help element? Best regards! Jun
On Tue, May 27, 2014 at 4:32 PM, Jun Fan <j.fan@qmul.ac.uk> wrote:
Hi all,
In the conditional param, when sub-element allows you to write specific parameters for a particular value selected. I am wondering how to write the help context according to the value selection. For example, if there is a conditional param called blast_type, when “blastn” is selected, the help context will be “blast dna against dna” and when “blastp” is selected, the help context will be “blast protein against protein”. Basically this selection-based help text provides a general description of the selection, which could help to set up the corresponding parameters.
By the way, is there any document about formatting text in the help element?
Best regards!
Jun
You can do this kind of thing with one-line Cheetah syntax within the output XML tag, but it quickly gets very complicated. e.g. https://github.com/peterjc/pico_galaxy/commit/3991893c6ee2cc69c33aaa391bbed4... Peter
Hi Peter, I am afraid that the link you gave me could not solve the problem. The question I asked is about the help element, not the label attribute for data element. To clarify my question, here is the code which does not work, but shows what I intend to do: <conditional name="blast"> <param name="type" type="select" label="BLAST type"> <option value="blastn">BLASTN</option> <option value="blastp">BLASTP</option> </param> <when value="blastn"> <help>BLAST DNA against DNA</help> <param...> </when> <when value="blastp"> <help>BLAST protein against protein</help> <param...> </when> </conditional> I tried to set the help content according to the selected type, which works like a section header to the following param list. Obviously this does not work. Then I tried a less-fancy way by providing static help context by adding <help> under select param like <param name="type" type="select" label="BLAST type"> <help>BLASTN: BLAST DNA against DNA, BLASTP: BLAST protein against protein</help> <option value="blastn">BLASTN</option> Of course it works but in an ugly formatting text. Is there any document to format it nicely, e.g. a list? Best regards! Jun -----Original Message----- From: Peter Cock [mailto:p.j.a.cock@googlemail.com] Sent: Tuesday, May 27, 2014 4:40 PM To: Jun Fan Cc: galaxy-dev@lists.bx.psu.edu Subject: Re: [galaxy-dev] complex help for conditional param On Tue, May 27, 2014 at 4:32 PM, Jun Fan <j.fan@qmul.ac.uk> wrote:
Hi all,
In the conditional param, when sub-element allows you to write specific parameters for a particular value selected. I am wondering how to write the help context according to the value selection. For example, if there is a conditional param called blast_type, when “blastn” is selected, the help context will be “blast dna against dna” and when “blastp” is selected, the help context will be “blast protein against protein”. Basically this selection-based help text provides a general description of the selection, which could help to set up the corresponding parameters.
By the way, is there any document about formatting text in the help element?
Best regards!
Jun
You can do this kind of thing with one-line Cheetah syntax within the output XML tag, but it quickly gets very complicated. e.g. https://github.com/peterjc/pico_galaxy/commit/3991893c6ee2cc69c33aaa391bbed4... Peter
Hi Jun, Thanks for the clarification - I did not read your question carefully enough, sorry. I don't think this is possible. What I would use is just: <param name="type" type="select" label="BLAST type"> <option value="blastn">BLASTN, for DNA against DNA</option> <option value="blastp">BLASTP, for protein against protein</option> </param> Regards, Peter On Tue, May 27, 2014 at 10:29 PM, Jun Fan <j.fan@qmul.ac.uk> wrote:
Hi Peter,
I am afraid that the link you gave me could not solve the problem. The question I asked is about the help element, not the label attribute for data element. To clarify my question, here is the code which does not work, but shows what I intend to do: <conditional name="blast"> <param name="type" type="select" label="BLAST type"> <option value="blastn">BLASTN</option> <option value="blastp">BLASTP</option> </param> <when value="blastn"> <help>BLAST DNA against DNA</help> <param...> </when> <when value="blastp"> <help>BLAST protein against protein</help> <param...> </when> </conditional> I tried to set the help content according to the selected type, which works like a section header to the following param list. Obviously this does not work. Then I tried a less-fancy way by providing static help context by adding <help> under select param like <param name="type" type="select" label="BLAST type"> <help>BLASTN: BLAST DNA against DNA, BLASTP: BLAST protein against protein</help> <option value="blastn">BLASTN</option> Of course it works but in an ugly formatting text. Is there any document to format it nicely, e.g. a list?
Best regards! Jun
participants (2)
-
Jun Fan -
Peter Cock