Skip to content

Latest commit

 

History

History
108 lines (70 loc) · 3.12 KB

README.md

File metadata and controls

108 lines (70 loc) · 3.12 KB
Raw

domainstorytelling

Presentation

This package implements the notation provided in Domain Storytelling.

The current icons comes from Font Awesome. However, elements of all other packages (aws, fontawesome, material ...) can be simply included and used.

Activity

Domain Storytelling defines the artifacts between actors and work objects as activities. In PlantUML world, it basically the Arrow, i.e. -->, .l.>, ...

However, the text related to an activity must follow a specific format with an optional sequence number and a label. The procedure Activity can be used to follow the format. The procedure can be used according to two fashions.

The first one is when the sequence number and the label are parts of the Arrow's text.

Actor("consumer", "consumer")
Actor("stand", "concession stand attendant")
Shapes("popcorn")
consumer --> popcorn : Activity("01", "orders")
popcorn --> stand : Activity("", "from")

The second one is when the sequence number is set as a cardinality of the actor and the label is the Arrow's text.

Actor("consumer", "consumer")
Actor("stand", "concession stand attendant")
Shapes("popcorn")
consumer Activity("01") --> popcorn : orders
popcorn --> stand : from

Usage

Bootstrap

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

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

Full inclusion

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

' loads the bootstrap of `domainstorytelling` and all related items
include('domainstorytelling/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 `domainstorytelling` and all related items
!include https://raw.githubusercontent.com/tmorin/plantuml-libs/master/distribution/domainstorytelling/single.puml

Include locally the resources:

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

Modules

The package provides 3 modules.

Examples

The package provides 3 examples.

Introduction 1

Introduction 1
The source file.

Introduction 2

Introduction 2
The source file.

Groups

Groups
The source file.