PlantUMLAdvanced usageDitaa diagram

Verallgemeinerung

Ursprünglich mussten Diagrammbeschreibungen mit @startuml eingeleitet und mit @enduml abgeschlossen werden. PlantUML lässt nun aber auch andere Formate als UML zu, weswegen in diesen Fällen @startuml keinen Sinn mehr ergibt.

Also lautet nun die allgemeine Übereinkunft, dass die Methode XYZ zur Diagrammbeschreibung mit @startXYZ beginnen und mit @endXYZ enden soll.

Man beachte, dass die Zeichenkette XYZ jede Art von Zeichen enthalten kann, insbesondere auch Leerzeichen.

Das bedeutet auch, dass plugin Entwickler angespornt werden sollen, ihren Kode auf die Erkennung von @start anstatt auf @startuml scharf zu stellen.

Ditaa

Ditaa ist Open Source und freie Software und benutzt 'ASCII Graphik', i.e. Zeichnungen die linien-ähnliche Symbole wie |, / oder - benutzen. Der Autor vergleicht dies mit einer diagram markup language.

Die Idee gleicht der von PlantUML, und mag zur Dokumentation darüber beitragen, wie man Diagramme erzeugt, die nur umständlich mit UML beschrieben werden können.

Die jüngste Version von PlantUML erlaubt z.B. Konstruktionen wie: 

@startuml
ditaa
+--------+   +-------+    +-------+
|        +---+ ditaa +--> |       |
|  Text  |   +-------+    |Diagram|
|Dokument|   |!Magie!|    |       |
|     {d}|   |       |    |       |
+---+----+   +-------+    +-------+
    :                         ^
    |    Ein Haufen Arbeit    |
    +-------------------------+
@enduml

Eine anschauliche Beschreibung ist auf sourceforge.net zu finden.

Sollte Ihr plugin @startditaa noch nicht unterstützen, können Sie die vorübergehende Behelfslösung nutzen: man umhüllt den Ditaa Kode mit @startuml und @enduml und beginnt den Kode mit ditaa als erstes Wort auf der ersten darauffolgenden Zeile. Dahinter, in runden Klammern, eventuelle Optionen.

You can also use some option, after the @startditaa or @ditaa keyword:

  • -E or --no-separation to remove separator
  • -S or --no-shadows to remove shadow
  • scale=XYZ to scale up or down the diagram

@startuml
ditaa(--no-shadows, scale=0.8)
/--------\   +-------+
|cAAA    +---+Version|
|  Data  |   |   V3  |
|  Base  |   |cRED{d}|
|     {s}|   +-------+
\---+----/
@enduml

Only PNG generation is supported. ⚠ On PlantUML, only PNG generation is supported.
WARNING
 This translation need to be updated. 
WARNING

Option supported by PlantUML

You can also use some option, after the @startditaa or ditaa keyword:

  • -E or --no-separation to remove separator
  • -S or --no-shadows to remove shadow
  • scale=<XYZ> to scale up or down the diagram

Without option

@startditaa
+---------+  /--------\   +-------+
| cBLU    +--+cAAA    +---+Version|
|         |  |  Data  |   |   V3  |
|    +----+  |  Base  |   |cRED{d}|
|    |cPNK|  |     {s}|   +-------+
|    |    |  \---+----/
+----+----+    
@endditaa

Remove separator

@startditaa -E
+---------+  /--------\   +-------+
| cBLU    +--+cAAA    +---+Version|
|         |  |  Data  |   |   V3  |
|    +----+  |  Base  |   |cRED{d}|
|    |cPNK|  |     {s}|   +-------+
|    |    |  \---+----/
+----+----+    
@endditaa

Remove shadow or scale diagram

@startuml
ditaa(--no-shadows, scale=0.7)
+---------+  /--------\   +-------+
| cBLU    +--+cAAA    +---+Version|
|         |  |  Data  |   |   V3  |
|    +----+  |  Base  |   |cRED{d}|
|    |cPNK|  |     {s}|   +-------+
|    |    |  \---+----/
+----+----+    
@enduml

Tags

Tag Description
{c} Choice or Decision
{d} Document - Symbol representing a document
{io} Input/Output - Symbol representing input/output
{mo} Manual operation
{o} Ellipse
{s} Storage - Symbol representing a form of storage, like a database or a hard disk.
{tr} Trapezoid 

@startditaa
+------+------+------+------+------+------+------+
| c {c}|d {d} |io{io}|mo{mo}|o{o}  |s{s}  |tr{tr}|
+------+------+------+------+------+------+------+
@endditaa

More documentation

You will find the complete documentation about ditaa on: