Sequenz Anwendungsfall Klasse Aktivität Komponente Zustand Objekt Einsatz Zeitverlauf Regex Network Wireframe Archimate Gantt MindMap WBS EBNF JSON YAML
PlantUML Language specification Hyperlink
🧩
New! Render PlantUML diagrams directly inside GitHub with our official browser extension — No server. No tokens. No tracking. Zero permissions but clipboard. — Try it out and let us know what you think!
Add to Chrome Add to Firefox

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Format definition

Simple link

Simple links are define using two square brackets (or three square brackets for field or method on class diagram).

Example:

Link with optional label

It 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 tooltip

Finally 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 tooltip

You can also have only a tooltip using round brackets.

Example: [[{A tooltip}]]

Only tooltip and label

You can also have only a tooltip using round brackets, and a label.

Example: [[{A tooltip} This label is printed]]

URL authentication

With URL authentication it is possible to provide an authentication method, credentials, and a proxy config to URL endpoints.

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links contained curly bracket

A link can contain some curly brackets.

[Ref. QA-13489]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links in sequence diagram

The following example lists some links features:

Edit in DokuwikiEdit in AsciidocEdit in Markdown
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:

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links in activity diagram

On activity label

On partition

[Ref. QA-542]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Link in State diagram

You can add link on State diagram:

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links in Network diagram (nwdiag)

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links in JSON/YAML diagram

JSON

YAML

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links in notes

It 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).

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links with explicit URL directive

You can use the url of|for XXX is [[yyy]] syntax:

On sequence diagram

On class diagram

On usecase diagram

On component or deployment diagram

[Ref. Incubation: URL in diagrams]

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Links in arrow (or Hyperlinks in link or connection)

Class diagram

You can use the same syntax as above in the arrow name. It makes an underlined link:

Or you can use this syntax. It doesn't underline the link, though it's still clickable:

Component or Deployment diagram

FIXME
🚩 See Wanted features QA-6397
FIXME

[Ref. QA-6397]

State diagram

FIXME
🚩 Same Issue
FIXME

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Specific SkinParameter for Link

hyperlinkColor

You can change the color value of the links with the hyperlinkColor setting.

[Ref. QA-2322]

hyperlinkUnderline

You can use hyperlinkUnderline to specify the presence and (in PNG only) thickness of hyperlink underlines.

[Ref. QA-2866, QA-15114, GH-1241, GH-1411]

topurl

You can use topurl setting, in order to define the prefix for all the links on a PlantUML diagram, as:

[Ref. QA-9016, QA-13179 ]

Other SkinParameter for Link

You can see also on:

Edit in DokuwikiEdit in AsciidocEdit in Markdown
Using (global) style

Without style (by default)

With style

You can use style to change rendering of elements.

[Ref. QA-8071]