In an attempt to improve PlantUML documentation...
Wiki Toc Recent changes View page history Add new chapter Reorder page Raw
![]() |
![]() |
|
Upgrading note (about Links and Hyperlinks)Hyperlinks have been introduced in iterative mode so there have been some slight syntax changes with different versions. Starting with version 8058, syntax about hyperlink is now clearly defined and stable. Unfortunately, there are some tiny changes from previous legacy syntax, so you may have to update your existing source diagrams. This is something we do not like, because we try to guarantee ascending compatibility as far as possible. But in some cases, we have to move forward. The good news is that older legacy diagrams will still be generated by newer versions of PlantUML. The only impact is that some links may be displayed differently, so we think it is an acceptable change. |
|
Format definition
Simple linkSimple links are define using two square brackets (or three square brackets for field or method on class diagram). Example:
Link with optional labelIt is possible to give an optional label that will be printed instead of the link itself. A space is used as separator after the URL itself. Example:[[http://plantuml.com This label is printed]]
Link with optional tooltipFinally you can also have an optional tooltip using round brackets, just after the URL and before the optional label. Example:[[http://plantuml.com{Optional tooltip} This label is printed]]
Only tooltipYou can also have only a tooltip using round brackets. Example:[[{A tooltip}]]
Only tooltip and labelYou can also have only a tooltip using round brackets, and a label. Example:[[{A tooltip} This label is printed]]
|
|
Links in sequence diagramThe following example lists some links features:
|
|
Links in class diagram
There is a special syntax with 3 square brackets in class definition when you want to define a link on field or method. For example:
|
|
Links in activity diagram
|
|
Links in notesIt is also possible to specify a link at the beginning of a note (the link applies to the full note), or inside a note (for a portion of the note).
[Ref. Incubation: URL in diagrams] |
|
Links with explicit URL directiveYou can use theurl of XXX is [[yyy]] syntax:
On sequence diagram
On class diagram
On usecase diagram
On component or deployment diagram
[Ref. Incubation: URL in diagrams] |
|
Links in arrow (or Hyperlinks in link or connection)Class diagram
Component or Deployment diagramFIXME 🚩
See Wanted features QA-6397
FIXME
[Ref. QA-6397] State diagramFIXME 🚩
Same Issue
FIXME
|