plantuml / plantuml

Generate diagrams from textual description
https://plantuml.com
Other
9.73k stars 881 forks source link

Theme Gallery is broken (https://plantuml.com/theme-gallery) #700

Closed kkweon closed 1 year ago

kkweon commented 2 years ago

Current

Expected

Related issues

The-Lum commented 2 years ago

Hello @kkweon,

The Theme Gallery is on beta-version (or only 🚧 under construction). I initiate the page with a perl script. And then I will to automatize this with a github page (without directly calls to plantuml online server, because this page solicits the server a lot and it often goes in 503 - Service unavailable code). 💡 With the main goal to share or fork them, in the future, on the plantuml page.

As mentioned on the forum:

Awaiting the publication; You can see under construction page here:

If that can help, Regards,

🔗 https://forum.plantuml.net/14600/the-theme-gallery-page-seems-to-be-down?show=14611#a14611

This is a works in progress... Sharing news ASAP... Regards.

bschwarz commented 2 years ago

If it helps, here are some references to what I used to generate the gallery. Might be helpful:

Script to generate images for one theme and script to generate for all themes.

Main github page to display gallery

Example puml files that are used to generate the images:

Hope that helps...

arnaudroques commented 2 years ago

Hope that helps...

Yes, it does. Many thanks.

Since this theme gallery seems very popular, we have to find a way to implement it properly...

We are still thinking about it, so it may take some times :-)

The-Lum commented 2 years ago

Yes. that helps: Thanks a lot @bschwarz.

But for wiki or alphadoc, the parameter -config <theme_name> or -theme <theme_name> of the CLI is not possible. We must use instead the !theme <theme_name> command. That the fact I created a little Perl script for that. But I can mix the better...

I go to the script... (and to home also...) SYL

The-Lum commented 2 years ago

Hello all,

After this time... (Before a real announcement) Here is my WIP for first public release 🎉... on this page:

Don't hesitate to post questions/remarks on the discussion page.

And special credit to @arnaudroques, @bschwarz and @matthew16550 (and all the others for the future works to do together...)

arnaudroques commented 2 years ago

Hello @The-Lum Your gallery is really great and far better than our own. So your page is now referenced here.

Some suggestion: you should make all images clickable (and redirect to the source code of the diagram).

The-Lum commented 2 years ago

Thanks a lot @arnaudroques,

For your request I had a task on the project.

I go back to my code... Regards.

bschwarz commented 2 years ago

Looks good, thanks for your work.

A few comments/observations:

  1. +1 on the link to source
  2. I need to update my themes for mindmap, wbs, gnatt, timing, wireframe, network diagrams. I will try to update soon.
  3. Question @arnaudroques https://github.com/arnaudroques: for gnatt, timing, wireframe, network diagrams, is there theming for these now?
  4. Some of my themes are meant for dark backgrounds. These are: black-knight, cyborg, cyborg-outline, hacker, superhero, superhero-outline. It would be nice if your gallery could put a dark background for these.
  5. You have resume-light theme in there. That should be removed. I will remove it from the plantuml repo as well.
  6. For the future, I think it would be nice to have brief summaries of the themes, so people can browse quickly. Kind of like what I did here https://bschwarz.github.io/puml-themes/gallery.html.

Cheers, Brett

On Mon, Nov 1, 2021 at 9:05 AM The-Lum @.***> wrote:

Thanks a lot @arnaudroques https://github.com/arnaudroques,

For your request I had a task https://github.com/The-Lum/puml-themes-gallery/projects/1#card-71991180 on the project https://github.com/The-Lum/puml-themes-gallery/projects/1 .

I go back to my code... Regards.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/plantuml/plantuml/issues/700#issuecomment-956363732, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGYBCJRGTWOL355KCLCYGTUJ23EFANCNFSM5FV7CAJQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

arnaudroques commented 2 years ago
  1. Question @arnaudroques https://github.com/arnaudroques: for gantt, timing, wireframe, network diagrams, is there theming for these now?

About style for gantt, timing, network diagrams, this is quite beta, some features are probably missing or not working. We are waiting for user requests or reports to fix them :-)

Regards, Arnaud

The-Lum commented 2 years ago

Hello all,

@bschwarz: Thanks for your comments/observations.

  1. OK, I create the task to add source link to the diagram ↪️But I have no idea for to do that. [Hints: as on real-world-plantuml site: I need some help ;), or as in the PlantUML doc. site]
  2. OK, good job...
  3. See above answer; And: For Network (nwdiag) diagrams see: QA-14478 for Wireframe or salt see: QA-14752 :zany_face:
  4. OK; As it is auto-generated, it is difficult to add some additional info... But I understand, they are initially design for dark background, even if the background will be transparent. (Perhaps I must add an exception (to impose a dark background) for those theme: black-knight, cyborg, cyborg-outline, hacker, superhero, superhero-outline)
  5. Ok, as you want.
  6. Task Add Brief summaries of the themes added But as it is auto-generated, it is difficult to add some additional info. Perhaps add this directly on the theme (as the $THEME variable), _[Hints: why not on a variable like $THEME_DESC or other?...]_ Or I create a table with those additional info. only for few themes...

@arnaudroques:

About style for gantt, timing, network diagrams, this is quite beta, some features are probably missing or not working. We are waiting for user requests or reports to fix them :-)

bschwarz commented 2 years ago

4) Yeah, I add a tag to the themes that are dark mode, but I am using

Jekyll on Github pages, and read in a config file.

6) What I mean by this is, just have a "gallery" page. On the gallery

page, just put one diagram for each theme, so the user has an idea on the theme. If they like the theme, they can click on that to take them to get all the diagrams for that theme.

On Sun, Nov 7, 2021 at 1:22 PM The-Lum @.***> wrote:

Hello all,

@bschwarz https://github.com/bschwarz: Thanks for your comments/observations.

  1. OK, I create the task to add source link to the diagram https://github.com/The-Lum/puml-themes-gallery/projects/1#card-71991180 ↪️But I have no idea for to do that. [Hints: as on real-world-plantuml site https://real-world-plantuml.com: I need some help ;), or as in the PlantUML doc. site]
  2. OK, good job...
  3. See above answer; And: For Network (nwdiag) diagrams see: QA-14478 https://forum.plantuml.net/14478/applying-themes-on-nwdiag-has-no-effect?show=14577#a14577 for Wireframe or salt see: QA-14752 https://forum.plantuml.net/14752 🤪
  4. OK; As it is auto-generated, it is difficult to add some additional info... But I understand, they are initially design for dark background, even if the background will be transparent. (Perhaps I must add an exception (to impose a dark background) for those theme: black-knight, cyborg, cyborg-outline, hacker, superhero, superhero-outline)
  5. Ok, as you want.
  6. Task Add Brief summaries of the themes https://github.com/The-Lum/puml-themes-gallery/projects/1#card-72378497 added But as it is auto-generated, it is difficult to add some additional info. Perhaps add this directly on the theme (as the $THEME variable), [Hints: why not on a variable like $THEME_DESC or other?...] Or I create a table with those additional info. only for few themes...

@arnaudroques https://github.com/arnaudroques:

About style for gantt, timing, network diagrams, this is quite beta, some features are probably missing or not working. We are waiting for user requests or reports to fix them :-)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/plantuml/plantuml/issues/700#issuecomment-962682783, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGYBCJW5TAW5TRKBM5PS3TUK3UYJANCNFSM5FV7CAJQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

arnaudroques commented 2 years ago
  • JSON and YAML diagram Then the big issue is for JSON and YAML diagram... They accept style... but no include <path_to_theme> or !theme directive... See QA-14131...

It's a hack, but you can now have !theme with JSONand YAML. This is really dirty coding here.

The-Lum commented 2 years ago

Thanks for your hack. I can go to the test. Then I will create template for JSON and YAML for the next Gallery...

The-Lum commented 2 years ago

Sorry, but here is a first counter example ... (Just on testing diagram to adding title...)

@startuml
node n [
{{yaml
!theme amiga
fruit: Apple
size: Large
color:
 - Red
 - Green
}}
]
@enduml

And all unhappy... 😢 I will also use title on JSON or YAML diagram... (as on Wire diagram! cf. QA-14924)

It may be too much... I ask maybe a little too much... Thanks for your works. Regards.

bschwarz commented 2 years ago

Ok, latest pull request, https://github.com/plantuml/plantuml/pull/753 I updated so that mindmap, wbs diagrams will render in theme colors. It also partially renders the network diagrams, gnatt and timing

I also removed the resume-light theme

On Sun, Nov 7, 2021 at 10:21 AM Brett Schwarz @.***> wrote:

Looks good, thanks for your work.

A few comments/observations:

  1. +1 on the link to source
  2. I need to update my themes for mindmap, wbs, gnatt, timing, wireframe, network diagrams. I will try to update soon.
  3. Question @arnaudroques https://github.com/arnaudroques: for gnatt, timing, wireframe, network diagrams, is there theming for these now?
  4. Some of my themes are meant for dark backgrounds. These are: black-knight, cyborg, cyborg-outline, hacker, superhero, superhero-outline. It would be nice if your gallery could put a dark background for these.
  5. You have resume-light theme in there. That should be removed. I will remove it from the plantuml repo as well.
  6. For the future, I think it would be nice to have brief summaries of the themes, so people can browse quickly. Kind of like what I did here https://bschwarz.github.io/puml-themes/gallery.html.

Cheers, Brett

On Mon, Nov 1, 2021 at 9:05 AM The-Lum @.***> wrote:

Thanks a lot @arnaudroques https://github.com/arnaudroques,

For your request I had a task https://github.com/The-Lum/puml-themes-gallery/projects/1#card-71991180 on the project https://github.com/The-Lum/puml-themes-gallery/projects/1.

I go back to my code... Regards.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/plantuml/plantuml/issues/700#issuecomment-956363732, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAGYBCJRGTWOL355KCLCYGTUJ23EFANCNFSM5FV7CAJQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

arnaudroques commented 2 years ago

And all unhappy... 😢

Thanks for the feedback. This is fixed in last beta!

You can go on with you tests :-)

The-Lum commented 2 years ago

Thanks a lot @arnaudroques,

In fact now the problem, for tonight, is !pragma layout smetana:

@startyaml
!pragma layout smetana
fruit: Apple
size: Large
color:
 - Red
 - Green
@endyaml

But that doesn't make too much sense !!! (because YAML is already layouted by smetana, with or without this directive!) I will manage otherwise... I'm going step by step ...

Regards.

The-Lum commented 1 year ago

Hi all,

[This is an Issue Review] This is now answered.

Regards.