You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
106 lines
5.2 KiB
Plaintext
106 lines
5.2 KiB
Plaintext
' convert it with additional command line argument -DRELATIVE_INCLUDE="relative/absolute" to use locally
|
|
!if %variable_exists("RELATIVE_INCLUDE")
|
|
!include ./C4_Container.puml
|
|
!else
|
|
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
|
|
!endif
|
|
|
|
' Scope: A single container.
|
|
' Primary elements: Components within the container in scope.
|
|
' Supporting elements: Containers (within the software system in scope) plus people and software systems directly connected to the components.
|
|
' Intended audience: Software architects and developers.
|
|
|
|
' Colors
|
|
' ##################################
|
|
|
|
!$COMPONENT_FONT_COLOR ?= "#000000"
|
|
!$COMPONENT_BG_COLOR ?= "#85BBF0"
|
|
!$COMPONENT_BORDER_COLOR ?= "#78A8D8"
|
|
|
|
!$EXTERNAL_COMPONENT_LEGEND_TEXT ?= "external component"
|
|
!$EXTERNAL_COMPONENT_FONT_COLOR ?= $COMPONENT_FONT_COLOR
|
|
!$EXTERNAL_COMPONENT_BG_COLOR ?= "#CCCCCC"
|
|
!$EXTERNAL_COMPONENT_BORDER_COLOR ?= "#BFBFBF"
|
|
|
|
' New C4 style automatically swaps font and background colors, but with those settings the component/node background would be black.
|
|
' Therefore the colors should be displayed unchanged (the init colors have to be swapped too).
|
|
!$NEW_C4_USE_ORIGINAL_COMPONENT_COLORS ?= 1
|
|
!$componentColorsSwappedAlready ?= 0
|
|
!if (NEW_C4_STYLE == 1 && $NEW_C4_USE_ORIGINAL_COMPONENT_COLORS == 1 && $componentColorsSwappedAlready == 0)
|
|
!$swap=$COMPONENT_BG_COLOR
|
|
!$COMPONENT_BG_COLOR=$COMPONENT_FONT_COLOR
|
|
!$COMPONENT_FONT_COLOR=$swap
|
|
!$swap=$EXTERNAL_COMPONENT_BG_COLOR
|
|
!$EXTERNAL_COMPONENT_BG_COLOR=$EXTERNAL_COMPONENT_FONT_COLOR
|
|
!$EXTERNAL_COMPONENT_FONT_COLOR=$swap
|
|
' don't swap them again below if C4_... included again
|
|
!$componentColorsSwappedAlready=1
|
|
!endif
|
|
|
|
' Labels
|
|
' ##################################
|
|
|
|
!$COMPONENT_LEGEND_TEXT ?= "component"
|
|
!$EXTERNAL_COMPONENT_LEGEND_TEXT ?= "external component"
|
|
|
|
' Styling
|
|
' ##################################
|
|
|
|
UpdateElementStyle("component", $COMPONENT_BG_COLOR, $COMPONENT_FONT_COLOR, $COMPONENT_BORDER_COLOR, $shape=$DEFAULT_SHAPE, $legendText="$COMPONENT_LEGEND_TEXT")
|
|
UpdateElementStyle("external_component", $EXTERNAL_COMPONENT_BG_COLOR, $EXTERNAL_COMPONENT_FONT_COLOR, $EXTERNAL_COMPONENT_BORDER_COLOR, $shape=$DEFAULT_SHAPE, $legendText="$EXTERNAL_COMPONENT_LEGEND_TEXT")
|
|
|
|
' shortcuts with default colors
|
|
!unquoted procedure AddComponentTag($tagStereo, $bgColor="", $fontColor="", $borderColor="", $shadowing="", $shape="", $sprite="", $techn="", $legendText="", $legendSprite="", $borderStyle="", $borderThickness="")
|
|
$addElementTagInclReuse("component", $tagStereo, $bgColor, $fontColor, $borderColor, $shadowing, $shape, $sprite, $techn, $legendText, $legendSprite, $borderStyle, $borderThickness)
|
|
!endprocedure
|
|
!unquoted procedure AddExternalComponentTag($tagStereo, $bgColor="", $fontColor="", $borderColor="", $shadowing="", $shape="", $sprite="", $techn="", $legendText="", $legendSprite="", $borderStyle="", $borderThickness="")
|
|
$addElementTagInclReuse("external_component", $tagStereo, $bgColor, $fontColor, $borderColor, $shadowing, $shape, $sprite, $techn, $legendText, $legendSprite, $borderStyle, $borderThickness)
|
|
!endprocedure
|
|
|
|
' Layout
|
|
' ##################################
|
|
|
|
SetDefaultLegendEntries("person\nsystem\ncontainer\ncomponent\nexternal_person\nexternal_system\nexternal_container\nexternal_component\nenterprise_boundary\nsystem_boundary\ncontainer_boundary\nboundary")
|
|
|
|
!procedure LAYOUT_WITH_LEGEND()
|
|
hide stereotype
|
|
legend right
|
|
|<color:$LEGEND_TITLE_COLOR>**Legend**</color> |
|
|
|<$PERSON_BG_COLOR> person |
|
|
|<$SYSTEM_BG_COLOR> system |
|
|
|<$CONTAINER_BG_COLOR> container |
|
|
|<$COMPONENT_BG_COLOR> component |
|
|
|<$EXTERNAL_PERSON_BG_COLOR> external person |
|
|
|<$EXTERNAL_SYSTEM_BG_COLOR> external system |
|
|
|<$EXTERNAL_CONTAINER_BG_COLOR> external container |
|
|
|<$EXTERNAL_COMPONENT_BG_COLOR> external component |
|
|
endlegend
|
|
!endprocedure
|
|
|
|
' Elements
|
|
' ##################################
|
|
|
|
!unquoted procedure Component($alias, $label, $techn="", $descr="", $sprite="", $tags="", $link="", $baseShape="rectangle")
|
|
$getElementLine($baseShape, "component", $alias, $label, $techn, $descr, $sprite, $tags, $link)
|
|
!endprocedure
|
|
|
|
!unquoted procedure ComponentDb($alias, $label, $techn="", $descr="", $sprite="", $tags="", $link="")
|
|
$getElementLine("database", "component", $alias, $label, $techn, $descr, $sprite, $tags, $link)
|
|
!endprocedure
|
|
|
|
!unquoted procedure ComponentQueue($alias, $label, $techn="", $descr="", $sprite="", $tags="", $link="")
|
|
$getElementLine("queue", "component", $alias, $label, $techn, $descr, $sprite, $tags, $link)
|
|
!endprocedure
|
|
|
|
!unquoted procedure Component_Ext($alias, $label, $techn="", $descr="", $sprite="", $tags="", $link="", $baseShape="rectangle")
|
|
$getElementLine($baseShape, "external_component", $alias, $label, $techn, $descr, $sprite, $tags, $link)
|
|
!endprocedure
|
|
|
|
!unquoted procedure ComponentDb_Ext($alias, $label, $techn="", $descr="", $sprite="", $tags="", $link="")
|
|
$getElementLine("database", "external_component", $alias, $label, $techn, $descr, $sprite, $tags, $link)
|
|
!endprocedure
|
|
|
|
!unquoted procedure ComponentQueue_Ext($alias, $label, $techn="", $descr="", $sprite="", $tags="", $link="")
|
|
$getElementLine("queue", "external_component", $alias, $label, $techn, $descr, $sprite, $tags, $link)
|
|
!endprocedure
|