【Asciidoc】ダイアグラム ー PlantUMLを外出しに ー

今回は「PlantUML」を外出しにしてみます。
「谷崎純一郎」風に頭から尻尾まで一気に書くと言う人たちも一定数存在しているとは思いますが・・・。
「Asciidoc」において本文と補助項目を別に管理できるのは一つの利点です。
自分は「引用文」、「ソースコード」、「表データ」そしてこの「ダイアグラム図」を良く外出しして利用しています。
まず、先日利用したUMLダイアグラムを別ファイルにします。

@startuml
skinparam defaultFontName VL Gothic

:利用者: --> (Use)
"管理者" as Admin
"ユーザー用画面" as (Use)
Admin --> (管理者画面)

@enduml

「umltest.pu」という名前で保存しておきます。

ここからの利用法は２つ考えられます。
一つは「PlantUML」パーサーを利用して画像にしてから
　「image::umltest.png[]」構文で
「Asciidoc」ファイル内に結合する。

もう一つは
　「include::umltest.pu[]」構文で
ファイル結合インクルードを行う方法です。

自分は後者を中心に利用しています。

[plantuml,test,svg]
....
include::umltest.pu[]
....

この様な形ですね。
変換すると

インクルード例

普通に変換できます。

ファイルを外出しして結合する方法は図の部分と文章を意識して管理でき、変更時、他方に影響を与えにくいというメリットがあります。
自分は好んでファイル結合インクルードを利用していますが勿論、前者にも利点はあります。
　・ 後者の方法より手数が少ない。
　・ 作図者と文を書く人間が別人である場合、作業しやすい。
　・ 「draw.io」等を併用する場合、管理方法を一元化しやすい。
特に「作図者」は「画像」を提出するので彼の意図した通り表現されるというメリットは大きいと思います。
なお、「PlantUML」の変換は「VScode」の拡張機能を初めとして色々存在しています。このパーサーを用意するのが面倒なので自分は後者を利用しています。また、一般イメージとUMLイメージをファイル名で区分しなければならないので一人で作業する場合は後者のほうが管理しやすいように思います。

さて、今回はこのあたりまで・・・・・・

次回は「PlantUML」を使っていくつか図を書いてみます。
…ではまた。

当Noteは下記の「AsciiDoc Language Documentation」の文法に従っています。

AsciiDoc - AsciiDoc Language Documentation