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

Enable collapsing markdown elements #15260

Merged
merged 10 commits into from
Jan 9, 2023
Merged

Conversation

guerler
Copy link
Contributor

@guerler guerler commented Dec 25, 2022

Mentioned in: #15088. Allows to optionally collapse/expand all existing markdown elements by declaring shared element attributes. This feature can be used with any markdown element by adding the collapse="[TITLE]" attribute. Additionally this PR adds client tests, unfortunately the client test coverage of markdown elements is still limited.

Screen.Recording.2023-01-04.at.1.49.57.PM.mov

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

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

@guerler guerler changed the title Enable collapsing markdown elements in Pages Enable collapsing markdown elements Dec 25, 2022
@guerler guerler force-pushed the collapse_markdown branch from 22c3326 to 4d67d55 Compare January 4, 2023 18:20
@guerler guerler marked this pull request as ready for review January 4, 2023 18:45
@github-actions github-actions bot added this to the 23.0 milestone Jan 4, 2023
@dannon dannon merged commit 8f7c657 into galaxyproject:dev Jan 9, 2023
@galaxyproject galaxyproject deleted a comment from github-actions bot Jan 9, 2023
@hexylena hexylena added the highlight/power-user Included at bottom of user-facing release notes (please use either this or highlight, but not both) label Jan 10, 2023
@guerler guerler deleted the collapse_markdown branch January 10, 2023 15:26
@hexylena
Copy link
Member

hexylena commented Mar 7, 2024

I am trying to use this now and cannot figure out how one should add an attribute. I looked through the test case, but there's no markdown I as a user can recognised there, and the video only shows the output. So I've tried the kramdown style attributes

*something*
{: collapse="title"}

but that doesn't seem to work. The ? button on pages doesn't document it either (I think this is the only attribute that can be added?), but links to CommonMark tutorial which also doesn't document it. Looking through the common mark spec, they don't support that flavour of attributes.

I've tried html, but that doesn't work either. Any tips here would be welcome! :)

@guerler
Copy link
Contributor Author

guerler commented Mar 8, 2024

Sorry for not having documented that well enough. The attribute is supposed to be added as shown here:

```galaxy
history_dataset_type(history_dataset_id=3108c91feeb505da, collapse="[TITLE]")
```

@hexylena
Copy link
Member

thanks so much! I'll add it to a tutorial!

@hexylena
Copy link
Member

I think i was just mislead by

This feature can be used with any markdown element by adding the collapse="[TITLE]"

which meant galaxy markdown, not the rest, but it makes sense now, also why there wasn't any markdown in the test cases either! i'm adding it as an FAQ to the workflow reports tutorial so it'll be easy for learners to discover :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/UI-UX feature-request highlight/power-user Included at bottom of user-facing release notes (please use either this or highlight, but not both) kind/enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants