Reference Guides

• 1: c4 package (main)
• 1.1: #C1
• 1.2: #color
• 1.3: #Container
• 1.4: #ElementTag
• 1.5: #id
• 1.6: #Person
• 1.7: #Relation
• 1.8: #RelationTag
• 1.9: #Sprite
• 1.10: #System
• 1.11: #Technology
• 1.12: #Type
• 1.13: #url
• 2: Technology
• 2.1: dev
• 2.2: gcp
• 2.3: stdlib

1 - c4 package (main)

import "github.com/owulveryck/cue4puml4c4:c4"

1.1 - #C1

Example

C1: c4.#C1 & {
        Systems: [{id: "sample", label: "my sample"}]
}

Definition

_#def
_#def: {
	title?:      string
	elementTags: #FoundElementTags & {
		#in: Systems
	}
	relationTags: {
		a: {
			if relations != _|_ // explicit error (_|_ literal) in source
			{
				#FoundRelationTags & {
					#in: relations
				}
			}
		}
		b: #FoundRelationTags & {
			#in: Systems
		}
	}
	Technologies: #FoundTechs & {
		#in: Systems
	}
	Persons?: [...#Person]
	Systems: [...#System]
	SystemsExt?: [...#System]
	Container?: [...#Container]
	relations?: [...#Relation]
	layout:         *"top-down" | "left-right" | "landscape"
	hideStereotype: bool | *true
}

Usage

• title?: string
• elementTags: #FoundElementTags & { #in: Systems }
• relationTags: { a: { if relations != | // explicit error (| literal) in source { #FoundRelationTags & { #in: relations } } } b: #FoundRelationTags & { #in: Systems } }
• Technologies: #FoundTechs & { #in: Systems }
• Persons?: […#Person]
• Systems: […#System]
• SystemsExt?: […#System]
• Container?: […#Container]
• relations?: […#Relation]
• layout: *“top-down” | “left-right” | “landscape”
• hideStereotype: bool | *true

1.2 - #color

Definition

=~"#[0-9a-f]{6}"

Usage

=~"#[0-9a-f]{6}"

1.3 - #Container

Definition

import "strings"

_#def
_#def: {
	id:           #id
	label:        *id | string
	technology:   #Technology | *_noTech
	description?: string
	desc:         "" | *strings.Replace(description, """


		""", "\\n", -1)
	tags?: [...#ElementTag]
	link?: #url
}

Usage

• id: #id
• label: *id | string
• technology: #Technology | *_noTech
• description?: string
• desc: "" | *strings.Replace(description, """ “”", “\n”, -1)
• tags?: […#ElementTag]
• link?: #url

1.4 - #ElementTag

Definition

_#def
_#def: {
	id:           string
	bgColor?:     #color
	fontColor?:   #color
	borderColor?: #color
	legendText?:  string
	technology?:  #Technology
	shadowing?:   bool
	shape?:       "rounded" | "eightsided"
}

Usage

• id: string
• bgColor?: #color
• fontColor?: #color
• borderColor?: #color
• legendText?: string
• technology?: #Technology
• shadowing?: bool
• shape?: “rounded” | “eightsided”

1.5 - #id

Definition

=~"^[a-zA-Z][a-zA-Z_]*"

Usage

=~"^[a-zA-Z][a-zA-Z_]*"

1.6 - #Person

Definition

_#def
_#def: {
	id:    #id
	label: *id | string
}

Usage

• id: #id
• label: *id | string

1.7 - #Relation

Definition

import "strings"

_#def
_#def: {
	source:      #System | #Container | #Person
	dest:        #System | #Container | #Person
	description: string | *""
	desc:        "" | *strings.Replace(description, """


		""", "\\n", -1)
	protocol?:   string
	link?:       #url
	tags?: [...#RelationTag]
}

Usage

• source: #System | #Container | #Person
• dest: #System | #Container | #Person
• description: string | *""
• desc: "" | *strings.Replace(description, """ “”", “\n”, -1)
• protocol?: string
• link?: #url
• tags?: […#RelationTag]

1.8 - #RelationTag

Definition

_#def
_#def: {
	id:            string
	textColor?:    #color
	lineColor?:    #color
	lineStyle?:    "dash" | "dot" | "bold"
	technology?:   #Technology
	legendText?:   string
	legendSprite?: "\(technology)"
}

Usage

• id: string
• textColor?: #color
• lineColor?: #color
• lineStyle?: “dash” | “dot” | “bold”
• technology?: #Technology
• legendText?: string
• legendSprite?: “(technology)”

1.9 - #Sprite

Definition

_#def
_#def: {
	name: string
	url:  #url
}

Usage

• name: string
• url: #url

1.10 - #System

Definition

import "strings"

_#def
_#def: {
	id:           #id
	label:        *id | string
	description?: string
	desc:         "" | *strings.Replace(description, """


		""", "\\n", -1)
	isBoundary:   bool | *false
	technology?:  #Technology
	type?:        #Type
	containers?: [...#Container]
	relations?: [...#Relation]
	systems?: [...#System]
	link?: #url
	tags?: [...#ElementTag]
}

Usage

• id: #id
• label: *id | string
• description?: string
• desc: "" | *strings.Replace(description, """ “”", “\n”, -1)
• isBoundary: bool | *false
• technology?: #Technology
• type?: #Type
• containers?: […#Container]
• relations?: […#Relation]
• systems?: […#System]
• link?: #url
• tags?: […#ElementTag]

1.11 - #Technology

Definition

_#def
_#def: {
	name: string
	type: *"" | "Db" | "Queue"
	sprite?: {
		id:  string | *"\(name)"
		url: string
	}
}

Usage

• name: string
• type: *"" | “Db” | “Queue”
• sprite?: { id: string | *"(name)" url: string }

1.12 - #Type

Definition

_#def
_#def: {
	name: string
}

Usage

• name: string

1.13 - #url

Definition

string

Usage

2 - Technology

2.1 - dev

Import

import "github.com/owulveryck/technology/dev"

Content

2.2 - gcp

Import

import "github.com/owulveryck/technology/gcp"

Content

2.3 - stdlib

Import

import "github.com/owulveryck/technology/stdlib"

Content