概要
plantumlは,PlantUMLをLaTeXで利用するためのLuaLaTeXパッケージである1.本稿では,plantumlの紹介ページにあるMinimal Exampleを出力できるようにすることを目指す.
PlantUMLとは
UMLダイアグラムを作成するための,テキストベースの言語である.例えば,Qiitaでは
```plantuml
participant "ユーザー" as user
participant "チャットボット" as chatbot
user -> chatbot : 文章を入力
chatbot -> chatbot : 回答生成
chatbot -> user : 回答を返信
```
と記述すると,以下のような表示になる.
準備
- 本稿ではTeX Liveがインストールされていることを前提とする.
- ディレクトリなど,OSにより異なる箇所は適宜読み替えること.
plantumlパッケージの確認
plantumlパッケージは最初からインストールされているはずである.
C:\Users\denkiuo604> tlmgr install plantuml
tlmgr.pl: package repository https://ftp.yz.yamagata-u.ac.jp/pub/CTAN/systems/texlive/tlnet (verified)
tlmgr.pl install: package already present: plantuml
もしインストールされていなければ,tlmgr install plantuml
を実行するなどしてインストールする.
plantuml.jarを用意しよう
以下のURLにアクセスしてしばらく待つと,自動でダウンロードが始まる.
https://sourceforge.net/projects/plantuml/files/plantuml.jar/download
ダウンロードが完了したら,plantuml.jar
を適当な場所に配置する.本稿では C:\PlantUML\plantuml.jar
に置くことにする.
Graphvizを用意しよう
以下のURLからGraphvizをダウンロード,インストールする.
https://graphviz.org/download/
環境変数を設定しよう
次の2つの環境変数を設定する.
-
PLANTUML_JAR
:plantuml.jar
を配置したパス- 本稿では
C:\PlantUML\plantuml.jar
- 本稿では
-
GRAPHVIZ_DOT
:Graphvizに含まれるdot.exe
のパス- 例:
C:\Program Files (x86)\Graphviz2.38\bin\dot.exe
- 例:
plantumlパッケージを使ってみよう
plantumlの紹介ページにあるMinimal Exampleを記述したTeXファイルを作成する.本稿では,作成したTeXファイルをデスクトップ C:\Users\denkiuo604\Desktop\example-minimal.tex
に配置した.
\documentclass{scrartcl}
\usepackage{plantuml}
\begin{document}
\begin{plantuml}
@startuml
Alice -> Bob: test
@enduml
\end{plantuml}
\end{document}
そして,コマンド lualatex -shell-escape example-minimal
を実行すれば,PDFファイルが出力される.
C:\Users\denkiuo604\Desktop>lualatex -shell-escape example-minimal
This is LuaHBTeX, Version 1.17.0 (TeX Live 2023)
system commands enabled.
(./example-minimal.tex
LaTeX2e <2022-11-01> patch level 1
L3 programming layer <2023-05-22>
(c:/texlive/2023/texmf-dist/tex/latex/koma-script/scrartcl.cls
Document Class: scrartcl 2023/04/24 v3.40 KOMA-Script document class (article)
~~~中略~~~
Output written on example-minimal.pdf (1 page, 4494 bytes).
Transcript written on example-minimal.log.
成功していれば,PDFファイルに以下のような図が出力される.
参考文献
-
紹介ページにもあるように,本稿執筆時点ではLuaLaTeXのみで利用可能である. ↩