This is a really simple library to aid creation of Example Mapping diagrams with PlantUML. Notation is derived from seminal work by Matt Wyne in "Introducing Example Mapping".
To get started, include the ExampleMappingCommon.puml file from the directory in each .puml file or PlantUML diagram. This can be referenced by a URL directly to this repository, or by including the file locally.
This references the latest GitHub release version of the referenced file from GitHub when an Internet connection is available. It is recommended not to use the main branch, but instead a specific release version. The example below references the current 0.1.0 release.
!include https://raw.githubusercontent.com/axcosta/example-mapping-plantuml-library/0.1.0/ExampleMappingCommon.pumlYou can also define the URL and include de definition:
!define ExampleMappingPuml https://raw.githubusercontent.com/axcosta/example-mapping-plantuml-library/0.1.0
!include ExampleMappingPuml/ExampleMappingCommon.puml!include path/to/ExampleMappingCommon.pumlThese are the objects that can be defined:
- UserStory
- Rule
- Example
- Question
Each object can be created with two properties:
- Label
- Description
These properties are optional but at least the label should be specified.
Recomendation is to create one Plant UML file per User Story and group Rules, Examples and Questions by User Story.
Below, there is the examples/ProcessFreeShipping.puml diagram code:
@startuml Process Free Shipping (examples/ProcessFreeShipping.puml)
!define ExampleMappingPuml https://raw.githubusercontent.com/axcosta/example-mapping-plantuml-library/main/ExampleMappingCommon.puml
!include ExampleMappingPuml/ExampleMappingCommon.puml
left to right direction
title Process Free Shipping from [[https://draft.io/example/example-mapping]]
UserStory("Process Free Shipping", "Give free shipping based on certain conditions") {
Question("What if customer lives in France?")
Question("What if customer wants a fast delivery?")
Question("What if customer uses fidelity points?")
Rule("Free shipping from $25 with certain category of products") {
Example("Free shipping from $25 picture closed to concerned products")
}
Rule("Free shipping marketing banner in product page") {
Example("Show banner when limit is not reached")
Example("Showcase free shipping when limit is exceeded")
}
Rule("Minimum of $50 in Shopping Cart") {
Example("Greater than $50 items get free delivery")
Example("All products are allowed in shopping cart")
Example("Show shipping costs while the limit is not reached")
}
}
@endumlThis code generates the following diagram:
You can customize this library by setting the following variables in your Plant UML file:
| Variable | Description | Default value |
|---|---|---|
| default_text_alignment | Text alignment of objects labels and descriptions | left |
| default_user_story_color | Background color of User Story object (see PlantUML colors) | Business |
| default_rule_color | Background color of Rule object (see PlantUML colors) | LightBlue |
| default_example_color | Background color of Example object (see PlantUML colors) | YellowGreen |
| default_question_color | Background color of Question object (see PlantUML colors) | LightPink |
| default_description_font_size | Font size of object description | 12 |
| default_spacing | Spacing between object label and description | "\n\n" |
| default_max_characters_per_line | Maximum characters per line for object labels and descriptions (this only applies when variable limit_max_characters_per_line is equal to true) |
30 |
| limit_max_characters_per_line | Enable/Disable limit of maxixum characters per line | "true" |
| show_map_stereotypes | Enable/Disable showing of object stereotypes | "false" |
| log_enabled | Enable/Disable logging (for debug purposes) | "false" |
For example, for showing the objects stereotypes in your diagram, set in your code (remember to include !$ in the beggining of variable definition):
!$show_map_stereotypes = "true"
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent