Add PlantUML Theme in S-CORE

[LittleHuba]

Assignee:
Andreas Kaluza @kalu-an

Spinx Needs integration: @hoe-jo https://sdvworkinggroup.slack.com/team/U08A65BRQJ3
For infrastructure questions: @AlexanderLanin https://sdvworkinggroup.slack.com/team/U08878XE0PK

[AlexanderLanin]

Open Point: how to integrate a custom theme into sphinx, sphinx-needs, and all auto generated images?

[kalu-an]

Description

This feature request is about introducing a theme for existing and future diagrams created with PlantUML

Reasons / Arguments

• same "look-and-feel"
• emphasize the branding of our project
• according to SCORE docs-as-code approach

Rational
What is a theme in context of PlantUML?

• A set of colors, styles, format options, shading applied to do dedicated elements used within the PlantUML diagram syntax
• The theme will overwrite default ones
• The diagram creator is not forced/limited to stay with the overrides by score theme, he/she could further adjust every styling element and/or skinparameter according to his/her needs.

Proposed solution

• Request Lead circle to judge the already existing theme "puml-theme-score.puml"

• Rework till all are happy with it

• Request infrastructure/tooling team

  • to find and place puml-theme-score.puml at a location accessible for all SCORE repositories and their tools
  • Modify / extend sphinx needs in a way that diagrams rendered with it also get the theme applied plantuml
    • {{ draw_feature(need(), needs) }} or
    • {{ draw_interface(need(), needs) }}

• Extend the SCORE docs-as-code documentation where needed Docs-As-Code

[AlexanderLanin]

Non exhaustive list of implementation ideas in docs-as-code tooling:

• monkeymatch/wrap uml directive and add an !include at the beginning of each diagram. But there is like 5-10 ways to generate diagrams.
• modify plantuml.jar file to always include a theme
• abandon sphinx default plantuml and use a custom extension
• inject custom (python) script as plantuml.jar binary (don't we do that already anyway?)

[AlexanderLanin]

Upon first discussion the goal is less clear as we may not be talking about docs-as-code tooling at all!

PlantUML is rendered:

• locally from puml files (e.g. VS Code extensions or PlantUML GUI)
• locally in markdown preview when embedded from puml / when embedded directly
• on github "normal source code view" in preview (e.g. README.md files)
• in rst preview when embedded from puml / when embedded directly
• in generated html pages on github pages

All of these require different solutions. Especially the combination of markdown and PlantUML is not addressed yet at all in S-CORE.

Next steps:

• @LittleHuba: me and @kalu-an discussed that the goal here is to write markdown with PlantUML. We currently do not yet support that with S-CORE tooling. Neither markdown at all, nor embedding PlantUML. What kind of markdown documents are we talking about? Shall they be rendered anywhere / where?
• @AlexanderLanin and @MaximilianSoerenPollak to discuss PlantUML in markdown in general. Do we want to support that? Which preview options (see above)?

[kalu-an]

@LittleHuba and @AlexanderLanin ,
1st look and feel available https://github.com/kalu-an/score_communication/blob/puml_theme/score/mw/com/design/runtime/README.md

!Attention! temporary solution with

• theme present in communication repo -> not what we want to have
• every puml diagram includes the theme -> not what we want to have
• puml diagram url pointing to my kalu-an fork -> not what we want to have