Skip to content

theme-usage.md

Latest commit

 

History

History
143 lines (102 loc) · 4.57 KB

theme-usage.md

File metadata and controls

143 lines (102 loc) · 4.57 KB

Theme usage & specialized bundles

Beyond the universal gen2 bundle, specialized entry points exist for diagrams that benefit from extra tweaks.

!!! info "Source files" Theme .puml sources live under doubleslash/ in this repository.

System / C4-style diagrams

!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/doubleslash/puml-theme-gen2-system.puml

Architectural levels via stereotypes

The system theme recognises stereotypes for layering:

rectangle "Online Shop System" <<context>> {
    rectangle "Web Application" <<container>> {
        rectangle "Order Management" <<component>> {
            rectangle "Order Service" <<module>> {
                rectangle "OrderController.java" <<code>>
            }
        }
    }
}
Stereotype Typical C4 lens
<<context>> System context
<<container>> Containers
<<component>> Components
<<module>> Modules / subsystems
<<code>> Code-level artefacts
<<external>> External systems / third parties

Full sample: systemmodel_with_levels.puml (mirror under remote_testing/ with raw URLs).

Gantt diagrams

Wrap with @startgantt … @endgantt and include the Gantt-oriented theme:

@startgantt
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/doubleslash/puml-theme-gen2-gantt.puml
' ...your tasks...
@endgantt

Legacy themes (deprecated)

Older per-diagram URLs under the repo root (e.g. puml-theme-doubleslash-*.puml, pgantt-theme-doubleslash.puml) still resolve but are deprecated—prefer gen2 URLs from getting-started.md.

Legacy include snippets (collapse)

Use case

!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-usecase.puml

Activity

!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-activity.puml

System (C4 L1/L2 legacy)

!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-system.puml

Class / ER-oriented

!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-class.puml

Sequence

!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-sequence.puml

Gantt legacy

@startgantt
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/pgantt-theme-doubleslash.puml
...
@endgantt

Mind map

@startmindmap
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-mindmap.puml
...
@endmindmap

Padding & PlantUML ≥ 1.2026.3

Legacy bundles under the repo root include doubleslash/padding-eval-gate.puml through puml-theme-doubleslash-general.puml: same behaviour as gen2 (CSS <style> on new JARs, skinparam fallback on older ones).

Migration cheat sheet

  1. Swap legacy includes for the universal gen2 line or light/dark as needed:

    // Old (deprecated)
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/puml-theme-doubleslash-[type].puml

// New (gen2)
!include https://raw.githubusercontent.com/doubleSlashde/umltheme/main/doubleslash/doubleslash-gen2.puml

  2. Choose light (doubleslash/light.puml), dark (doubleslash/dark.puml), or universal (doubleslash/doubleslash-gen2.puml).

Consumption from MkDocs (mkdocs_puml)

Integrate themes in your documentation project using mkdocs_puml:

plugins:
  - search
  - plantuml:
      puml_url: https://www.plantuml.com/plantuml/
      theme:
        url: https://raw.githubusercontent.com/doubleSlashde/umltheme/main/
        light: doubleslash/light
        dark: doubleslash/dark

This uses the official PlantUML server for rendering and follows your MkDocs / Material palette for light vs dark skins.