Merge pull request #59 from jeanmarc-contrib/master

Add support for ArchiMate elements in Sequence Diagrams

Author: jeanmarc

CHANGES.md

@@ -0,0 +1,94 @@
+## 3.2.1 (not yet released)
+
+### What's changed
+* Added support for ArchiMate shapes in sequence diagrams in [#59](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/59)
+* Special shapes can be used for some elements in [#58](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/58)
+* Bugfix: use `%true()` and `%false()` instead of `true` and `false` (included in #58)
+
+## Release v1.2.0 ➡️ v3.2.0
+### tag [v1.2.0](https://github.com/plantuml-stdlib/Archimate-PlantUML/tree/v1.2.0) (2025-10-01)
+### tag [v3.2.0](https://github.com/plantuml-stdlib/Archimate-PlantUML/tree/v3.2.0) (2025-10-01)
+
+[Full Changelog](https://github.com/plantuml-stdlib/Archimate-PlantUML/compare/v1.0.0...v3.2.0)
+
+> [!IMPORTANT]
+> This release has been tagged with both `v1.2.0` (the next minor version in line for Archimate-PlantUML) and `v3.2.0` (aligned to the current version of Archimate).
+> 
+> Moving forward, the versioning of Archimate-PlantUML will follow that of Archimate.
+> 
+> Defining a version as MAJOR.MINOR.PATCH, the MAJOR.MINOR will follow Archimate versions, with PATCH being incremented for feature changes and bugfixes.
+
+### What's changed
+
+* chore:minor typo by [@somejeff](https://github.com/somejeff) in [#44](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/44)
+* Upgrade macros to new specs and add theme support by [@ebbypeter](https://github.com/ebbypeter) in [#45](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/45)
+* Fix: $BUSINESS_FILLCOLOR missing made nesting Business_Service incorrect by [@jmanteau](https://github.com/jmanteau) in [#48](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/48)
+* Fix spelling of implementation by [@joelparkerhenderson](https://github.com/joelparkerhenderson) in [#49](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/49)
+* Update to ArchiMate 3.2 specifications and reorganize folders to assist plantuml build by [@jeanmarc](https://github.com/jeanmarc) in [#54](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/54)
+
+### New Contributors
+* [@somejeff](https://github.com/somejeff) made their first contribution in [#44](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/44)
+* [@jmanteau](https://github.com/jmanteau) made their first contribution in [#48](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/48)
+* [@joelparkerhenderson](https://github.com/joelparkerhenderson) made their first contribution in [#49](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/49)
+* [@jeanmarc](https://github.com/jeanmarc) made their first contribution in [#54](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/54)
+
+
+## Release v1.1.0
+### tag [v1.1.0](https://github.com/plantuml-stdlib/Archimate-PlantUML/tree/v1.1.0) (2021-09-07)
+
+[Full Changelog](https://github.com/plantuml-stdlib/Archimate-PlantUML/compare/v1.0.0...v1.1.0)
+
+#### Implemented enhancements:
+* Non standart Assignment relation looking [#33](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/33)
+* Change arrow tail for Assignment from ◯ to ⬤. [#35](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/35) ([@Potherca](https://github.com/Potherca))
+
+#### Fixed Bugs:
+* Solid line instead of dotted line with Rel_Access_rw [#31](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/31)
+* Change line for Read/Write relationship arrows from solid to dotted. [#32](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/32) ([@Potherca](https://github.com/Potherca))
+
+#### Closed Issues:
+
+* Minor request - flat Technology_Node [#37](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/37)
+* stdLib references non existing url (...ebbypeter...) [#36](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/36)
+* "realisation" sprite name instead of "realization" [#34](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/34)
+* Join https://github.com/plantuml-stdlib and/or migrate there? [#29](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/29)
+* Feedback [#28](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/28)
+* Multiple regressions after last PRs [#24](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/24)
+* a couple of minor errors in the readme file [#22](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/22)
+* Add directed association relationship, and thicken the association arrow line [#20](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/20)
+* some arrow lines and heads are wrong [#18](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/18)
+* change the shape of 2 physical elements [#16](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/16)
+* missing element Strategy_ValueStream [#14](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/14)
+* Change Shape of technology Artifact [#13](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/13)
+* Unfiled arrow for access relationships [#12](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/12)
+* Typo Influnce -> Influence [#8](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/8)
+* permission to use [#7](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/7)
+* Technology Process - Missing Sprite [#5](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/5)
+ 
+#### Merged pull requests:
+* Change URLs in README file to plantuml-stdlib org. [#30](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/30) ([@Potherca](https://github.com/Potherca))
+* Update all images [#26](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/26) ([@joseluis](https://github.com/joseluis))
+* Fix [#24](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/24) Multiple regressions after last PRs [#25](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/25) ([@joseluis](https://github.com/joseluis))
+* fix Readme [#23](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/23) ([@joseluis](https://github.com/joseluis))
+* Add directed association rel. & thicken arrow line [#21](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/21) ([@joseluis](https://github.com/joseluis))
+* Fixes some arrow lines and heads according to spec [#19](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/19) ([@joseluis](https://github.com/joseluis))
+* make equipment and facility be Nodes [#17](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/17) ([@joseluis](https://github.com/joseluis))
+* Add missing element Strategy_ValueStream [#15](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/15) ([@joseluis](https://github.com/joseluis))
+* Added business location [#11](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/11) ([@tradesage](https://github.com/tradesage))
+* Some examples improvements [#10](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/10) ([@smeagol74](https://github.com/smeagol74))
+* [#8](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/8) fixed typoes Influnce -> Influence, Specilization -> Specialization [#9](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/9) ([@smeagol74](https://github.com/smeagol74))
+* Update Technology_Process Macro - per Issue [#5](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/5) [#6](https://github.com/plantuml-stdlib/Archimate-PlantUML/pull/6) ([@zimchaa](https://github.com/zimchaa))
+
+## Archmate-PlantUML v1.0.0
+### tag [v1.0.0](https://github.com/plantuml-stdlib/Archimate-PlantUML/tree/v1.0.0) (2019-01-23)
+
+[Full Changelog](https://github.com/plantuml-stdlib/Archimate-PlantUML/compare/53432f0cf64fd015c226b8082807fcd37c18cc8a...v1.0.0)
+
+Closed issues:
+
+* Cannot generate an Archimate image according to the manual: 'syntax error' [#4](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/4)
+* Update the ReadMe.md file [#1](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/1)
+
+Merged pull requests:
+* Updated ReadMe.md and minor fixes on samples [#3](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/3) ([ebbypeter](https://github.com/ebbypeter))
+* Archimate spec & samples [#2](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/2) ([ebbypeter](https://github.com/ebbypeter))

README.md

@@ -9,12 +9,16 @@ PlantUML macros and includes for creating Archimate Diagrams easily.
    - [PlantUML](#plantuml)
    - [ArchiMate](#archimate)
 2. [Getting Started](#getting-started)
+   - [Using built-in support](#using-built-in-support) 
+   - [Using a version available on the internet](#using-a-version-available-on-the-internet)
 3. [Usage](#usage)
    - [ArchiMate Elements](#archimate-elements)
    - [ArchiMate Relationships](#archimate-relationships)
    - [ArchiMate Groups](#archimate-groups)
+   - [Special shapes](#special-shapes)
    - [Nesting of Components](#nesting-of-components)
    - [Theme Support](#theme-support)
+   - [Sequence Diagrams using Archimate elements](#sequence-diagrams-using-archimate-elements)
 4. [Example](#example)
 5. [Contributing](#contributing)
 6. [License](#license)
@@ -306,6 +310,130 @@ Theme can be enabled by adding the following line.
 | archimate-lowsaturation  | ![low saturation](./images/theme-lowsaturation.png)   |
 | archimate-handwriting    | ![handwriting](./images/theme-handwriting.png)        |
 
+### Sequence Diagrams using Archimate elements
+Additional support for using ArchiMate elements in sequence diagrams is provided by setting a global variable prior to activating ArchiMate support:
+
+```puml
+!global $ARCH_SEQUENCE_SUPPORT = %true()
+!include <archimate/Archimate>
+```
+Alternatively, you can choose to only include the sequence support file directly:
+```puml
+!include <archimate/ArchimateSequenceDiagramSupport>
+```
+
+Both methods define additional procedures that can be used to create participants in sequence diagrams using Archimate elements.
+For example:
+
+```puml
+@startuml
+!global $ARCH_SEQUENCE_SUPPORT = %true()
+!include <archimate/Archimate>
+
+title Archi Print Usage
+
+' Define Elements
+$businessActor("Architect","architect")
+$applicationComponent("Archi","archi")
+$applicationFunction("Update\nModel","update")
+$applicationFunction("Print\nView","print")
+$systemSoftware("Windows\nPrint\nService","windowsPrint")
+$equipment("Printer", "printer")
+
+' Define Sequence
+architect->archi ++
+archi->update ++ : Make changes
+$document("Not exactly correct!\nBut you get the idea.","right","update")
+return Updated Model
+archi ->print ++ : Click print
+print -\windowsPrint ++
+print –> archi -–: Sent to printer
+windowsPrint -> printer ++
+return Complete
+archi –> architect --
+
+@enduml
+```
+
+Output:
+
+![Sequence Diagram using Archimate elements](./images/Archimate-Sequence-Diagram.png)
+
+Call the procedure with a label, and if the label is not unique within the diagram also provide an ID to refer to the participant.
+```puml
+$elementType("Label")
+$elementType("Label", ID)
+```
+
+The supported elements for sequence diagrams are listed in the table below.
+
+<details>
+
+<summary>Click to show the table</summary>
+
+| Aspect                       | Type                  | Procedure                   |
+|------------------------------|-----------------------|-----------------------------|
+| Application                  | Component             | `$applicationComponent`     |
+| Application                  | Collaboration         | `$applicationCollaboration` |
+| Application                  | Data Object           | `$dataObject`               |
+| Application                  | Event                 | `$applicationEvent`         |
+| Application                  | Function              | `$applicationFunction`      |
+| Application                  | Interaction           | `$applicationInteraction`   |
+| Application                  | Interface             | `$applicationInterface`     |
+| Application                  | Process               | `$applicationProcess`       |
+| Application                  | Service               | `$applicationService`       |
+| Business                     | Actor                 | `$actor`                    |
+| Business                     | Collaboration         | `$businessCollaboration`    |
+| Business                     | Contract              | `$contract`                 |
+| Business                     | Event                 | `$businessEvent`            |
+| Business                     | Function              | `$businessFunction`         |
+| Business                     | Interaction           | `$businessInteraction`      |
+| Business                     | Interface             | `$businessInterface`        |
+| Business                     | Object                | `$businessObject`           |
+| Business                     | Process               | `$businessProcess`          |
+| Business                     | Product               | `$product`                  |
+| Business                     | Role                  | `$role`                     |
+| Business                     | Service               | `$businessService`          |
+| Business                     | Representation        | `$representation`           |
+| Implementation and Migration | Deliverable           | `$deliverable`              |
+| Implementation and Migration | Gap                   | `$gap`                      |
+| Implementation and Migration | Implementation Event  | `$implementationEvent`      |
+| Implementation and Migration | Plateau               | `$plateau`                  |
+| Implementation and Migration | Work Package          | `$workPackage`              |
+| Motivation                   | Assessment            | `$assessment`               |
+| Motivation                   | Constraint            | `$constraint`               |
+| Motivation                   | Driver                | `$driver`                   |
+| Motivation                   | Goal                  | `$goal`                     |
+| Motivation                   | Meaning               | `$meaning`                  |
+| Motivation                   | Outcome               | `$outcome`                  |
+| Motivation                   | Principle             | `$principle`                |
+| Motivation                   | Requirement           | `$requirement`              |
+| Motivation                   | Stakeholder           | `$stakeholder`              |
+| Motivation                   | Value                 | `$value`                    |
+| Strategy                     | Capability            | `$capability`               |
+| Strategy                     | Course Of Action      | `$courseOfAction`           |
+| Strategy                     | Resource              | `$resource`                 |
+| Strategy                     | Value Stream          | `$valueStream`              |
+| Technology                   | Artifact              | `$artifact`                 |
+| Technology                   | Collaboration         | `$technologyCollaboration`  |
+| Technology                   | Communication Network | `$communicationNetwork`     |
+| Technology                   | Device                | `$device`                   |
+| Technology                   | Event                 | `$technologyEvent`          |
+| Technology                   | Function              | `$technologyFunction`       |
+| Technology                   | Interaction           | `$technologyInteraction`    |
+| Technology                   | Interface             | `$technologyInterface`      |
+| Technology                   | Node                  | `$node`                     |
+| Technology                   | Path                  | `$path`                     |
+| Technology                   | Process               | `$technologyProcess`        |
+| Technology                   | Service               | `$technologyService`        |
+| Technology                   | System Software       | `$systemSoftware`           |
+| Technology - Physical        | Distribution Network  | `$distributionNetwork`      |
+| Technology - Physical        | Equipment             | `$equipment`                |
+| Technology - Physical        | Facility              | `$facility`                 |
+| Technology - Physical        | Material              | `$material`                 |
+
+</details>
+
 ## Example
 ```plantuml
 @startuml
@@ -338,7 +466,7 @@ Rel_Composition_Up(ACSAP, ACSAPFin)
 ```
 
 Output:  
-![Archimate-PlantUML Sample image - Requirement & Application Services](./images/Archimate%20Sample%20-%20Requirement%20%26%20Application%20Services.png) 
+![Archimate-PlantUML Sample image - Requirement & Application Services](./images/Archimate%20Sample%20-%20Requirement%20%26%20Application%20Services.png)
 
 ## Contributing
 If you have any ideas, [open an issue](https://github.com/plantuml-stdlib/Archimate-PlantUML/issues/new) or fork the repository and submit a pull request.
@@ -351,3 +479,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 * [Archimate 3.1 Specification](http://pubs.opengroup.org/architecture/archimate3-doc/) - Archimate Specifications
 * [Plant UML Archimate Specifications](http://plantuml.com/archimate-diagram) - for archimate spec in PlantUML
 * [C4-PlantUML](https://github.com/plantuml-stdlib/C4-PlantUML) - for inspiration, base structure and scripts idea
+* Steven Mileham, for allowing inclusion of his [Sequence Diagram support for Archimate elements](https://smileham.co.uk/2019/04/23/archimate-plantuml-sequence-diagram-joy/)

dist/plantuml-stdlib/stdlib/archimate/Archimate.puml

@@ -20,11 +20,18 @@
 
 !global $ARCH_DEBUG ?= %false()
 !global $ARCH_LOCAL ?= %false()
+!global $ARCH_SEQUENCE_SUPPORT ?= %false()
 
 !if ($ARCH_LOCAL == %true())
     !include themes/shared_style.puml
+    !if ($ARCH_SEQUENCE_SUPPORT == %true())
+        !include ArchimateSequenceDiagramSupport.puml
+    !endif
 !else
     !include <archimate/themes/shared_style>
+    !if ($ARCH_SEQUENCE_SUPPORT == %true())
+        !include <archimate/ArchimateSequenceDiagramSupport>
+    !endif
 !endif
 
 !if ($ARCH_DEBUG == %true())