Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw


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.

Generalisation

PlantUML now can generate diagrams other than UML. In such cases the usual @startuml does not make sense anymore. So now we allow diagrams start with @startXYZ and finish with @endXYZ, where XYZ can change with the type of diagram and can be any characters (including spaces).

This means that plugin developers are encouraged to change their code to recognize @start instead of @startuml.

DITAA diagrams are usually formatted as @startditaa...@endditaa.

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

Ditaa

Ditaa (DIagrams Through Ascii Art) is an Open Source project that allows to generate general diagrams from a text descriptions. The idea is close to PlantUML, and it may be useful for documentation to generate other diagrams than UML.

So last version of PlantUML allows this :

@startuml
ditaa
+--------+   +-------+    +-------+
|        +---+ ditaa +--> |       |
|  Text  |   +-------+    |diagram|
|Document|   |!magic!|    |       |
|     {d}|   |       |    |       |
+---+----+   +-------+    +-------+
    :                         ^
    |       Lots of work      |
    +-------------------------+
@enduml

You will find the complete documentation about ditaa on:

If your plugin does not support @startditaa yet, a temporary feature has been set up : it is also possible to use Ditaa with @startuml by using ditaa keyword on the very first line of your description.

⚠ On PlantUML, only PNG generation is supported.

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:


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.