Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow several Galaxy Markdown directives to be embedded. #19086

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

jmchilton
Copy link
Member

First step toward implementing #17522.

Reserving a whole block of HTML makes sense for the display of an image or table but for some of the directives it is a bulky thing that really breaks up reports. These are things you'd want to use in legends or headers or footers or in explanatory text.

Here is a before and after demonstrating using the directive to not waste so much space describing the name and type of a dataset in a report.

Screenshot 2024-10-30 at 4 08 39 PM

Screenshot 2024-10-30 at 4 08 48 PM

The page content demonstrating the embedded Markdown syntax.

Screenshot 2024-10-30 at 4 11 08 PM

I've been planning this syntax for years and many of the directives that don't make a lot of sense on their own - links, names, types, etc... were designed with this in mind some day. The tool reports #19054 & #19067 have a bunch of obvious use cases things you'd want to include (and that would also make sense in a workflow) that would benefit from this work. Two being - the tool name and the tool parameter name or text. Rendering all that dynamically would keep the report and the XML in syntax automatically.

How to test the changes?

(Select all options that apply)

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@jmchilton jmchilton force-pushed the markdown_embedded_directives branch from 1783e52 to 4a9d11e Compare November 13, 2024 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant