PlantUML Language specification Hyperlink

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

フォーマット定義

シンプルなリンク

• [[http://plantuml.com]]
• [[]] (空のリンク)

ラベル付きのリンク

ツールチップ付きのリンク

ツールチップのみ

ツールチップとラベルのみ

URL Authentication

Edit in DokuwikiEdit in AsciidocEdit in Markdown

波括弧を含むリンク

@startuml [[link{with_bracket}&id=10]]:Some activity\n(with link with brackets)\n""link{with_bracket}&id=10""; [["link{with_bracket}"{}]]:Some activity\n(with link with brackets and empy tooltip)\n"""link{with_bracket}"{}""; [["link{with_bracket}"{with tooltip}]]:Some activity\n(with link finished by brackets and tooltip)\n"""link{with_bracket}"{with tooltip}""; [["link{with_bracket}&id=10"{with tooltip}]]:Some activity\n(with link with brackets and tooltip)\n"""link{with_bracket}&id=10"{with tooltip}""; @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

シーケンス図におけるリンク

@startuml actor Bob [[http://plantuml.com/sequence]] actor "This is [[http://plantuml.com/sequence Alice]] actor" as Alice Bob -> Alice [[http://plantuml.com/start]] : hello note left [[http://plantuml.com/start]] a note with a link end note Alice -> Bob : hello with [[http://plantuml.com/start{Tooltip for message} some link]] note right [[http://plantuml.com/start]] : another note note left of Bob You can use [[http://plantuml.com/start links in notes]] also. end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

クラス図におけるリンク

@startuml class Car [[http://plantuml.com/link]] class Wheel [[http://plantuml.com/sequence]] note left [[http://plantuml.com]] foo end note Car *-- Wheel [[http://plantuml.com/class]] : has some @enduml

@startuml class Car { - Some field [[[http://plantuml.com]]] Some method() [[[http://plantuml.com/link]]] } @enduml

@startuml Object <|-- Foo class Foo { + Object[] [[[http://www.google.com]]] + methods1() [[[http://www.yahoo.com/A1{Some explainations about this method}]]] + methods2() [[[http://www.yahoo.com/A2]]] } class Foo2 { + methods1() [[[http://www.yahoo.com/B1]]] + methods2() [[[http://www.yahoo.com/B2]]] } class Object [[http://www.yahoo.com]] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

アクティビティ図におけるリンク

アクティビティのラベル上

@startuml start [[http://plantuml.com]]:Some activity; :Some [[http://plantuml.com link]]; end @enduml

パーティション上

@startuml start partition "[[http://plantuml.com partition_name]]" { :read doc. on [[http://plantuml.com plantuml_website]]; :test diagram; } end @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Link in State diagram

• local link on a word
• or link on the entire state shape

@startuml state state1 [[http://plantuml.com/link]] state state2 [[http://plantuml.com/state{this is a tooltip\nand a link to "plantuml/state"}]] state2 : a global link\nand a tooltip note left [[http://plantuml.com]] a note and a link to ""plantuml.com"" end note state3 : a local link to [[http://plantuml.com plantuml]] state1 --> state2 state2 --> state3 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ネットワーク図（nwdiag）におけるリンク

@startuml nwdiag { network Network { Server [description="A [[http://plantuml.com link]] on nwdiag"]; } } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

JSON/YAML図におけるリンク

JSON

@startjson { "@fruit": "Apple", "$size": "Large", "Appli.": "A [[http://plantuml.com link]] on JSON" } @endjson

YAML

@startyaml @fruit: Apple $size: Large Appli.: A [[http://plantuml.com link]] on YAML @endyaml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

ノートにおけるリンク

@startuml :Foo: note left of Foo [[http://www.google.com]] This is a note end note note right of Foo Yet another link to [[http://www.google.com]] as demo. You can also [[http://www.yahoo.fr specify a text]] for the link. And even [[http://www.yahoo.fr{This is a tooltip} add a tooltip]] to the link. end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

明示的URLディレクティブによるリンク

シーケンス図

@startuml Bob -> Alice : ok url of Bob is [[http://www.google.com]] @enduml

クラス図

@startuml skinparam topurl http://www.google.com Dog --|> Mammal url of Mammal is [[/search]] url of Dog is [[http://www.yahoo.com{This is Dog}]] Dog o-- Cat Cat --|> Mammal @enduml

ユースケース図

@startuml actor Mamal usecase Dog url of Mamal is [[http://www.google.com]] url of Dog is [[http://www.yahoo.com{This is Dog}]] @enduml

コンポーネント図、配置図

@startuml node Mamal component Dog url of Mamal is [[http://www.google.com]] url of Dog is [[http://www.yahoo.com{This is Dog}]] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

矢印におけるリンク（リンク、コネクションにおけるハイパーリンク）

クラス図

@startuml class Car Car *-- Wheel [[http://plantuml.com/class-diagram]] : has some @enduml

コンポーネント図、配置図

@startuml node Car Car *-- Wheel [[http://plantuml.com/deployment-diagram]] : has some @enduml

状態図

@startuml state Car state CarWithWheel Car -> CarWithWheel [[http://plantuml.com/state-diagram]] : Add wheel to car @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Specific SkinParameter for Link

hyperlinkColor

@startuml :hyperlinkColor setting, by default; :[[http://plantuml.com]]; @enduml

@startuml skinparam hyperlinkColor red :hyperlinkColor setting; :[[http://plantuml.com]]; @enduml

hyperlinkUnderline

@startuml skinparam hyperlinkUnderline false :hyperlinkColor setting; :[[http://plantuml.com]]; @enduml

@startuml skinparam hyperlinkUnderline 1 :hyperlinkColor setting; :[[http://plantuml.com]]; @enduml

@startuml skinparam hyperlinkUnderline 5 :hyperlinkColor setting; :[[http://plantuml.com]]; @enduml

topurl

@startmindmap skinparam topurl https://plantuml.com/ * [[index PlantUML website]] ** [[sequence-diagram Sequence]] ** [[mindmap-diagram MindMap]] ** [[wbs-diagram WBS]] ** ... @endmindmap

Other SkinParameter for Link

• Specific SkinParameter for SVG

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Using (global) style

Without style (by default)

@startuml title test on HyperlinkColor [[test link]] class test <<normal>> { * aaa + [[normal model]] - bb } class test_with_stereo AS "[[http://www.plantuml.com test]]" <<red>> { * aaa + [[red model]] - bb } @enduml

With style

@startuml <style> .red { HyperlinkColor #FF0000 } </style> title test on HyperlinkColor [[test link]] class test <<normal>> { * aaa + [[normal model]] - bb } class test_with_stereo AS "[[http://www.plantuml.com test]]" <<red>> { * aaa + [[red model]] - bb } @enduml