Ditaa

Ditaa (DIagrams Through Ascii Art) est un projet Open Source qui permet de générer des diagrammes généraux à partir de descriptions textuelles. L'idée est proche de PlantUML, et il peut être utile pour la documentation de générer d'autres diagrammes qu'UML.

Alors PlantUML permet cela :

🎉 Copied!

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

Il n'est plus possible d'utiliser Ditaa avec @startuml en utilisant le mot clé ditaa sur la toute première ligne de votre description. Vous devez maintenant utiliser @startditaa et @endditaa.

⚠ Sur PlantUML, seule la génération PNG est supportée.

Généralisation (de la balise @start/@end)

À l'origine, les descriptions de diagrammes devaient commencer avec @startuml et finir avec @enduml. PlantUML accepte maintenant de générer d'autres diagrammes que l'UML, et dans ce cas, @startuml n'a plus aucun sens.

Donc, la convention générale est de laisser les descriptions de diagrammes commencer avec @startXYZ et de finir avec @endXYZ, où XYZ doit changer selon le type de diagrammes.

Remarquez que XYZ peut être n'importe quelle chaîne de caractères (espaces incluses).

Ceci veut dire que les développeurs de plugins sont encouragés à changer leur code afin de reconnaître @start au lieu de @startuml.

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

🎉 Copied!

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

Remove separator

🎉 Copied!

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

Remove shadow or scale diagram

🎉 Copied!

@startditaa < --no-shadows, scale=0.7
+---------+  /--------\   +-------+
| cBLU    +--+cAAA    +---+Version|
|         |  |  Data  |   |   V3  |
|    +----+  |  Base  |   |cRED{d}|
|    |cPNK|  |     {s}|   +-------+
|    |    |  \---+----/
+----+----+    
@endditaa

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

🎉 Copied!

@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:


Privacy Policy      Advertise