PlantUML の note 内で#や*をエスケープする方法

1540 ワード
plantuml puml uml uml テキストリンク

PlantUMLのnote/endnote内ではCreole記法が使用できるが、それによって行頭の#や*がリストと解釈されて、そのまま表示ができない。
私はBTSのチケットを書こうとして少し困った。

@startuml
Bob -> Alice : hello
note left
  # orderd list
  ## sub list
  * unorderd list
  ** sub list
  This is **bold**
  This is //italics//
  This is ""monospaced""
  This is --stroked--
  This is __underlined__
  This is ~~waved~~
endnote
@enduml

エスケープする方法

公式サイトに書かれている通り、前にチルダ(~)を置く。

@startuml
Bob -> Alice : hello
note left
  ~# orderd list
  ~## sub list
  ~* unorderd list
  ~** sub list
  This is ~**bold**
  This is ~//italics//
  This is ~""monospaced""
  This is ~--stroked--
  This is ~__underlined__
  This is ~~~waved~~
endnote
@enduml

波型の下線で修飾できることを初めて知ったが、チルダの役割が競合しているからかエスケープできないようだ。