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


Notes

Here are some examples of notes on diagrams.

Appendice: Examples of "Note on link" on all diagrams

Activity

N/A

Class

@startuml
class a

a -> b: //link label//
note on link
  Link note
end note
@enduml

Component, Deployment

@startuml
node a
node b

a -> b: //link label//
note on link
  Link note
end note
@enduml

Gantt project planning

N/A

Object

@startuml
object a
object b

a -> b: //link label//
note on link
  Link note
end note
@enduml

MindMap

N/A

Network (nwdiag)

N/A

Sequence

N/A

State

@startuml
state a
state b

a -> b: //link label//
note on link
  Link note
end note
@enduml

Use-Case

@startuml
(a)
(b)

a -> b: //link label//
note on link
  Link note
end note
@enduml

Appendice: Examples of "Note [top|right|bottom|left] on link" on all diagrams

Activity

N/A

Class

@startuml
class a

a -> b: //link label//
note top on link
  Link note
end note
b ---> c: //link label//
note right on link
  Link note
end note
d <- c: //link label//
note bottom on link
  Link note
end note
a <--- d: //link label//
note left on link
  Link note
end note
@enduml

Component, Deployment

@startuml
node a
node b
node c
node d

a -> b: //link label//
note top on link
  Link note
end note
b ---> c: //link label//
note right on link
  Link note
end note
d <- c: //link label//
note bottom on link
  Link note
end note
a <--- d: //link label//
note left on link
  Link note
end note
@enduml

Gantt project planning

N/A

Object

@startuml
object a
object b
object c
object d

a -> b: //link label//
note top on link
  Link note
end note
b ---> c: //link label//
note right on link
  Link note
end note
d <- c: //link label//
note bottom on link
  Link note
end note
a <--- d: //link label//
note left on link
  Link note
end note
@enduml

MindMap

N/A

Network (nwdiag)

N/A

Sequence

N/A

State

@startuml
state a
state b
state c
state d

a -> b: //link label//
note top on link
  Link note
end note
b -down-> c: //link label//
note right on link
  Link note
end note
c -left-> d: //link label//
note bottom on link
  Link note
end note
d -up-> a: //link label//
note left on link
  Link note
end note
@enduml

Use-Case

@startuml
(a)
(b)
(c)
(d)

a -> b: //link label//
note top on link
  Link note
end note
b ---> c: //link label//
note right on link
  Link note
end note
d <- c: //link label//
note bottom on link
  Link note
end note
a <--- d: //link label//
note left on link
  Link note
end note
@enduml

Appendice: Examples of "Note [top|right|bottom|left] of link" on all diagrams

Test of the new feature "Note [top|right|bottom|left] of link" (from v1.2020.20):

  • OK for Component, Deployment, Use-case
  • KO for Class, Objet, State

FIXME
🚩 FIXME for Class, Objet, State
FIXME

Activity

N/A

Class

@startuml
class a

a -> b: //link label//
note top of link
  Link note
end note
b ---> c: //link label//
note right of link
  Link note
end note
d <- c: //link label//
note bottom of link
  Link note
end note
a <--- d: //link label//
note left of link
  Link note
end note
@enduml

FIXME
🚩 FIXME for Class
FIXME

Component, Deployment

@startuml
node a
node b
node c
node d

a -> b: //link label//
note top of link
  Link note
end note
b ---> c: //link label//
note right of link
  Link note
end note
d <- c: //link label//
note bottom of link
  Link note
end note
a <--- d: //link label//
note left of link
  Link note
end note
@enduml

Gantt project planning

N/A

Object

@startuml
object a
object b
object c
object d

a -> b: //link label//
note top of link
  Link note
end note
b ---> c: //link label//
note right of link
  Link note
end note
d <- c: //link label//
note bottom of link
  Link note
end note
a <--- d: //link label//
note left of link
  Link note
end note
@enduml

FIXME
🚩 FIXME for Objet
FIXME

MindMap

N/A

Network (nwdiag)

N/A

Sequence

N/A

State

@startuml
state a
state b
state c
state d

a -> b: //link label//
note top of link
  Link note
end note
b -down-> c: //link label//
note right of link
  Link note
end note
c -left-> d: //link label//
note bottom of link
  Link note
end note
d -up-> a: //link label//
note left of link
  Link note
end note
@enduml

FIXME
🚩 FIXME for State
FIXME

Use-Case

@startuml
(a)
(b)
(c)
(d)

a -> b: //link label//
note top of link
  Link note
end note
b ---> c: //link label//
note right of link
  Link note
end note
d <- c: //link label//
note bottom of link
  Link note
end note
a <--- d: //link label//
note left of link
  Link note
end note
@enduml


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