Showing images in README.rst on Tool Shed
Hi all, Thanks to Bjoern's recent enhancement, most of the Tool Shed pages now render a repository's README file as reStructuredText if the filename ends *.rst [I've noticed a bug where during repository installation the README file is just shown as plain test - I'm not sure if this a Galaxy bug or a Tool Shed bug though.] What I wanted to ask today is can we include images in the rendered README file? For instance a small PNG showing sample output, or any other kind of documentation: http://docutils.sourceforge.net/docs/ref/rst/directives.html#image I've tried it here but it fails: http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow/2dfe8b788f... Assuming I want to show a local image included within the Tool Shed repository, I presume this would require tweaks to get the image served by the Tool Shed at the appropriate relative URL? I can work-around this by using a full http URL to a publicly hosted image, but that may raise privacy concerns: http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow/d893133128... Thoughts? Peter
Hi Peter, I made this work for images defined in tool help sections - see http://wiki.galaxyproject.org/ToolShedToolFeatures#Properly_defining_the_loc... It shouldn't be too difficult to enhace the repository readme display feature to use the same approach. Ive created the following Trello card fvor this request. https://trello.com/c/nTArHl8J/1064-toolshed-handle-image-display-in-reposito... Thanks! Greg Von Kuster On Aug 19, 2013, at 1:29 PM, Peter Cock <p.j.a.cock@googlemail.com> wrote:
Hi all,
Thanks to Bjoern's recent enhancement, most of the Tool Shed pages now render a repository's README file as reStructuredText if the filename ends *.rst
[I've noticed a bug where during repository installation the README file is just shown as plain test - I'm not sure if this a Galaxy bug or a Tool Shed bug though.]
What I wanted to ask today is can we include images in the rendered README file? For instance a small PNG showing sample output, or any other kind of documentation: http://docutils.sourceforge.net/docs/ref/rst/directives.html#image
I've tried it here but it fails: http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow/2dfe8b788f...
Assuming I want to show a local image included within the Tool Shed repository, I presume this would require tweaks to get the image served by the Tool Shed at the appropriate relative URL?
I can work-around this by using a full http URL to a publicly hosted image, but that may raise privacy concerns: http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow/d893133128...
Thoughts?
Peter ___________________________________________________________ Please keep all replies on the list by using "reply all" in your mail client. To manage your subscriptions to this and other Galaxy lists, please use the interface at: http://lists.bx.psu.edu/
To search Galaxy mailing lists use the unified search at: http://galaxyproject.org/search/mailinglists/
On Mon, Aug 19, 2013 at 6:40 PM, Greg Von Kuster <greg@bx.psu.edu> wrote:
Hi Peter,
I made this work for images defined in tool help sections - see http://wiki.galaxyproject.org/ToolShedToolFeatures#Properly_defining_the_loc...
It shouldn't be too difficult to enhace the repository readme display feature to use the same approach. Ive created the following Trello card fvor this request.
https://trello.com/c/nTArHl8J/1064-toolshed-handle-image-display-in-reposito...
Thanks!
Greg Von Kuster
Thanks Greg, That looks reasonable although for README files it would be slightly more useful if rather than handling this via an explicit $PATH_TO_IMAGES entry in the image URL, relative image URLs could be detected automatically. I appreciate that would be much more complex/fragile, but it would allow the README.rst file to be rendered with images outside of the Tool Shed, e.g. on BitBucket or GitHub, e.g. https://github.com/peterjc/picobio/blob/769e4a77194587207f50707939db42b9f04b... For now it seems to be working OK on both using a full https link to the GitHub hosted image, https://github.com/peterjc/picobio/blob/05e741c51095e362ffeeb184ec2c1bbf6ea4... http://testtoolshed.g2.bx.psu.edu/view/peterjc/rxlr_venn_workflow/a24a1614ef... However, this is not encouraged by GitHub: https://help.github.com/articles/relative-links-in-readmes Thanks, Peter
participants (2)
-
Greg Von Kuster
-
Peter Cock