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.

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

Basic Formatting

You can use usual formatting.

Style syntax Result
__Italic__ Italic
**Bold** Bold
**__Italic and bold__** Italic and bold
+++<u>underlined</u>+++ underlined
~~striked~~ striked
raw raw
PlantUML Team
Welcome !
All contributions made here are public.
Thanks for helping us to improve PlantUML documentation !

Lists

You can use ordered and unordered lists. Right now, you can only have one level of sub-list. If you need more, just tell us!

Unordered list

* First ordered list item
* Second ordered list item
* Third ordered list item

  • First ordered list item
  • Second ordered list item
  • Third ordered list item

Ordered list

. First ordered list item
.. A sublist
. Second ordered list item
. Third ordered list item

  1. First ordered list item
    1. A sublist
  2. Second ordered list item
  3. Third ordered list item
PlantUML Team
You can use this chat to ask questions or to give any feedback on Lists

Tables

Right now, only basic table is supported.

Just ask if you need more!

|===
| Parameter | Default | Description

| nbthread
| 1
| Number of thread for processing

| graphvizDot
|
| Path of the dot executable

|===

Parameter Default Description
nbthread 1 Number of thread for processing
graphvizDot Path of the dot executable
PlantUML Team
You can use this chat to ask questions or to give any feedback on Tables

UML diagrams

Image with source code

You have to use <plantuml> and </plantuml>.

<plantuml>
@startuml
Alice -> Bob : Hello
@enduml
</plantuml>

@startuml
Alice -> Bob : Hello
@enduml

Display only image

Use standard [plantuml] block:

[plantuml]
-​---
@startuml
Alice -> Bob : Hello
note right
Caution: there is an unicode invisible space 
in the ---- line.
end note
@enduml
-​---

PlantUML Team
You can use this chat to ask questions or to give any feedback on UML diagrams


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