c4nord

Presentation

This package implements elements and boundaries coming from the C4 Model but with the Nord Theme flavor.

Pre-requisite

The package c4k8s is just an extension of the c4model. Therefore, the c4model package must be bootstrapped before to include the resources provided by c4k8s.

With the atomic approach:

' load the c4model package
include('c4model/bootstrap')
' load the c4k8s package
include('c4k8s/bootstrap')
' load the c4k8s resource
include('c4k8s/Element/Cluster')

With the full approach:

' load the c4model package
include('c4model/full')
' load the c4k8s package
include('c4k8s/full')

Usage

Bootstrap

The bootstrap may provide PlantUML artifacts like constants, procedures or style statements.

' loads the c4nord bootstrap
include('c4nord/bootstrap')

Full inclusion

An additional include can be used to load all items in one shot.

' loads the bootstrap of `c4nord` and all related items
include('c4nord/full')

Single inclusion

Finally, another include can be used to load the library's bootstrap, the package's bootstrap and all items' resources in one !include statement.

Include remotely the resources:

' loads the library, the bootstrap of `c4nord` and all related items
!include https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution/c4nord/single.puml

Include locally the resources:

' configures the library
!global $INCLUSION_MODE="local"
' loads the library, the bootstrap of `c4nord` and all related items
!include <the relative path to the /distribution directory>/c4nord/single.puml