PlantUML Language specification Creole

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Créole

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Texte mis en évidence

@startuml Alice -> Bob : hello --there-- here ... Some ~~long delay~~ ... Bob -> Alice : ok note left This is **bold** This is //italics// This is ""monospaced"" This is --stricken-out-- This is __underlined__ This is ~~wave-underlined~~ end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Listes

@startuml object demo { * Bullet list * Second item } note left * Bullet list * Second item ** Sub item end note legend # Numbered list # Second item ## Sub item ## Another sub item * Can't quite mix * Numbers and bullets # Third item end legend @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Caractère d'échappement

@startuml object demo { This is not ~___underscored__. This is not ~""monospaced"". } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Entêtes

@startuml usecase UC1 as " = Extra-large heading Some text == Large heading Other text === Medium heading Information .... ==== Small heading" @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Emoji

@startuml Alice -> Bob : Hello <:1f600:> return <:innocent:> Alice -> Bob : Without color: <#0:sunglasses:> Alice -> Bob : Change color: <#green:sunny:> @enduml

@startuml
emoji <block>
@enduml

• Unicode block 26: 83 emoji
• Unicode block 27: 33 emoji
• Unicode block 1F3: 246 emoji
• Unicode block 1F4: 255 emoji
• Unicode block 1F5: 136 emoji
• Unicode block 1F6: 181 emoji
• Unicode block 1F9: 240 emoji

Unicode block 26

@startuml emoji 26 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Lignes horizontales

@startuml database DB1 as " You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. Enjoy! " note right This is working also in notes You can also add title in all these lines ==Title== --Another title-- end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Links

• [[http://plantuml.com]]
• [[http://plantuml.com This label is printed]]
• [[http://plantuml.com{Optional tooltip} This label is printed]]

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Code

@startuml Alice -> Bob : hello note right <code> main() { printf("Hello world"); } </code> end note @enduml

@startuml Alice -> Bob : hello note left <code> This is **bold** This is //italics// This is ""monospaced"" This is --stricken-out-- This is __underlined__ This is ~~wave-underlined~~ --test Unicode and icons-- This is <U+221E> long This is a <&code> icon </code> end note note right This is **bold** This is //italics// This is ""monospaced"" This is --stricken-out-- This is __underlined__ This is ~~wave-underlined~~ --test Unicode and icons-- This is <U+221E> long This is a <&code> icon end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Tableau

Créer un tableau

@startuml skinparam titleFontSize 14 title Example of simple table |= |= table |= header | | a | table | row | | b | table | row | end title [*] --> State1 @enduml

Ajouter une couleur sur les lignes ou les cellules

@startuml start :Here is the result |= |= table |= header | | a | table | row | |<#FF8080> red |<#80FF80> green |<#8080FF> blue | <#yellow>| b | table | row |; @enduml

Ajouter une couleur sur la bordure et le texte

@startuml title <#lightblue,#red>|= Step |= Date |= Name |= Status |= Link | <#lightgreen>| 1.1 | TBD | plantuml news |<#Navy><color:OrangeRed><b> Unknown | [[https://plantuml.com/news plantuml news]] | end title @enduml

Pas de bordure ou même couleur que le fond

@startuml node n note right of n <#FBFB77,#FBFB77>|= Husky / Yorkie |= Foo | | SourceTree1 | foo1 | | ST2 | foo2 | end note @enduml

En-tête en gras ou non

@startuml note as deepCSS0 |<#white> Husky / Yorkie | |=<#gainsboro> SourceTree0 | endnote note as deepCSS1 |= <#white> Husky / Yorkie |= Foo | |<#gainsboro><r> SourceTree1 | foo1 | endnote note as deepCSS2 |= Husky / Yorkie | |<#gainsboro> SourceTree2 | endnote note as deepCSS3 <#white>|= Husky / Yorkie |= Foo | |<#gainsboro> SourceTree1 | foo1 | endnote @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Arbre

@startuml skinparam titleFontSize 14 title Example of Tree |_ First line |_ **Bom (Model)** |_ prop1 |_ prop2 |_ prop3 |_ Last line end title [*] --> State1 @enduml

@startuml class Foo { **Bar (Model)** |_ prop |_ **Bom (Model)** |_ prop2 |_ prop3 |_ prop3.1 |_ prop4 :( -- } @enduml

@startuml [A] as A rectangle "Box B" { component B [ Level 1 |_ Level 2a |_ Level 3a |_ Level 3b |_ Level 3c |_ Level 4a |_ Level 3d |_ Level 2b |_ Level 3e ] } A -> B @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Caractères spéciaux

@startuml usecase direct as "this is ∞ long" usecase ampHash as "this is also &#8734; long" usecase angleBrackets as "this is also <U+221E> long" @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Tag HTML

• <b> pour du texte en gras
• <u> ou <u:#AAAAAA> ou <u:[[color|colorName]]> pour souligner
• <i> pour de l'italique
• <s> ou <s:#AAAAAA> ou <s:[[color|colorName]]> pour barrer du texte
• <w> ou <w:#AAAAAA> ou <w:[[color|colorName]]> pour souligner en vague
• <color:#AAAAAA> ou <color:[[color|colorName]]> pour la couleur
• <back:#AAAAAA> ou <back:[[color|colorName]]> pour la couleur de fond
• <size:nn> pour changer la taille des caractères
• <img:file> : le fichier doit être accessible sur le système de fichier
• <img:http://plantuml.com/logo3.png> : l'URL doit être accessible

@startuml :* You can change <color:red>text color</color> * You can change <back:cadetblue>background color</back> * You can change <size:18>size</size> * You use <u>legacy</u> <b>HTML <i>tag</i></b> * You use <u:red>color</u> <s:green>in HTML</s> <w:#0000FF>tag</w> ---- * Use image : <img:http://plantuml.com/logo3.png> ; @enduml

Common HTML element

@startuml hide footbox note over Source <code> This is <b>bold</b> This is <i>italics</i> This is <font:monospaced>monospaced</font> This is <s>stroked</s> This is <u>underlined</u> This is <w>waved</w> This is <s:green>stroked</s> This is <u:red>underlined</u> This is <w:#0000FF>waved</w> -- other examples -- This is <color:blue>Blue</color> This is <back:orange>Orange background</back> This is <size:20>big</size> </code> end note /note over Output This is <b>bold</b> This is <i>italics</i> This is <font:monospaced>monospaced</font> This is <s>stroked</s> This is <u>underlined</u> This is <w>waved</w> This is <s:green>stroked</s> This is <u:red>underlined</u> This is <w:#0000FF>waved</w> -- other examples -- This is <color:blue>Blue</color> This is <back:orange>Orange background</back> This is <size:20>big</size> end note @enduml

Subscript and Superscript element [sub, sup]

@startuml :<code> This is the "caffeine" molecule: C₈H₁₀N₄O₂ </code> This is the "caffeine" molecule: C₈H₁₀N₄O₂ ---- <code> This is the Pythagorean theorem: a² + b² = c² </code> This is the Pythagorean theorem: a² + b² = c²; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

OpenIconic

@startuml title: <size:20><&heart>Use of OpenIconic<&heart></size> class Wifi note left Click on <&wifi> end note @enduml

@startuml listopeniconic @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Annexe : Exemples de " liste créole " sur tous les diagrammes

Activité

@startuml start :**test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item ---- **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item; stop @enduml

Classe

• Sous-élément
• Sous-élément

@startuml class a { **test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item ---- **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item } a -- b @enduml

Composant, Déploiement, Cas d'utilisation

@startuml node n [ **test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item ---- **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item ] file f as " **test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item ---- **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item " @enduml

Planification de projet Gantt

Object

• Sous-élément
• Sous-élément

@startuml object user { **test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item ---- **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item } @enduml

MindMap

@startmindmap * root ** d1 **:**test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item ---- **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item; @endmindmap

Réseau (nwdiag)

Note

@startuml note as n **test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item ---- **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item end note @enduml

Sequence

State

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Annexe : Exemples de " lignes horizontales créoles " sur tous les diagrammes

Activité

@startuml start :You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. Or dotted title //and title... // ==Title== Or double-line title --Another title-- Or single-line title Enjoy!; stop @enduml

Classe

@startuml class a { You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. Or dotted title //and title... // ==Title== Or double-line title --Another title-- Or single-line title Enjoy! } a -- b @enduml

Composant, déploiement, cas d'utilisation

@startuml node n [ You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. //and title... // ==Title== --Another title-- Enjoy! ] file f as " You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. //and title... // ==Title== --Another title-- Enjoy! " @enduml

Planification de projet Gantt

Objet

@startuml object user { You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. //and title... // ==Title== --Another title-- Enjoy! } @enduml

MindMap

@startmindmap * root ** d1 **:You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. //and title... // ==Title== --Another title-- Enjoy!; @endmindmap

Réseau (nwdiag)

Note

@startuml note as n You can have horizontal line ---- Or double line ==== Or strong line ____ Or dotted line ..My title.. //and title... // ==Title== --Another title-- Enjoy! end note @enduml

Sequence

State

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Équivalence de style (entre le créole et le HTML)

@startmindmap * Style equivalent\n(between Creole and HTML) **:**Creole** ---- <#silver>|= code|= output| | \n This is ""~**bold**""\n | \n This is **bold** | | \n This is ""~//italics//""\n | \n This is //italics// | | \n This is ""~""monospaced~"" ""\n | \n This is ""monospaced"" | | \n This is ""~--stroked--""\n | \n This is --stroked-- | | \n This is ""~__underlined__""\n | \n This is __underlined__ | | \n This is ""<U+007E><U+007E>waved<U+007E><U+007E>""\n | \n This is ~~waved~~ |; **:<b>Legacy HTML like ---- <#silver>|= code|= output| | \n This is ""~<b>bold</b>""\n | \n This is <b>bold</b> | | \n This is ""~<i>italics</i>""\n | \n This is <i>italics</i> | | \n This is ""~<font:monospaced>monospaced</font>""\n | \n This is <font:monospaced>monospaced</font> | | \n This is ""~<s>stroked</s>""\n | \n This is <s>stroked</s> | | \n This is ""~<u>underlined</u>""\n | \n This is <u>underlined</u> | | \n This is ""~<w>waved</w>""\n | \n This is <w>waved</w> | And color as a bonus... <#silver>|= code|= output| | \n This is ""~<s:""<color:green>""green""</color>"">stroked</s>""\n | \n This is <s:green>stroked</s> | | \n This is ""~<u:""<color:red>""red""</color>"">underlined</u>""\n | \n This is <u:red>underlined</u> | | \n This is ""~<w:""<color:#0000FF>""#0000FF""</color>"">waved</w>""\n | \n This is <w:#0000FF>waved</w> |; @endmindmap

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Creole on Creole

@startcreole ==Creole This is **bold** This is //italics// This is ""monospaced"" This is --stricken-out-- This is __underlined__ This is ~~wave-underlined~~ test Unicode and icons This is <U+221E> long This is a <&code> icon Use image : <img:https://plantuml.com/logo3.png> <b>HTML Creole This is <b>bold</b> This is <i>italics</i> This is <font:monospaced>monospaced</font> This is <s>stroked</s> This is <u>underlined</u> This is <w>waved</w> This is <s:green>stroked</s> This is <u:red>underlined</u> This is <w:#0000FF>waved</w> other examples This is <color:blue>Blue</color> This is <back:orange>Orange background</back> This is <size:20>big</size> Creole list item **test list 1** * Bullet list * Second item ** Sub item *** Sub sub item * Third item **test list 2** # Numbered list # Second item ## Sub item ## Another sub item # Third item @endcreole