最終更新日: 2019-01-26 土 17:26
ホーム | 文書トップ | 目次

PlantUML

Table of Contents

概要

テキスト記述からUML図を生成するツール。

変更履歴を見ると2009年4月に最初の公式リリースがされたようだ。

設計文書への活用方法

MarkDown(.md)に記述し、ローカルでは VS Code の Markdown Preview Enhanced (https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) で図をPreview、

gitlab上では、PlantUMLサーバーとの連携により、図が見られる、という使い方がよいのではないか。

配布元

Windows

インストール

Java(JRE)

Java(JRE)のインストールが必要。

Graphviz

また、シーケンス図以外を生成する場合は Graphviz のインストールが必要。

plantuml

配布元から plantuml.jar をダウンロードし、パスの通っているディレクトリに置く。

同ディレクトリに plantuml.bat を置き、下記のような内容にする。

java -jar %~dp0\plantuml.jar %*

使い方

変換

plantuml.bat ファイル名

svgへ変換

plantuml.bat -tsvg ファイル名

記述方法

シーケンス図の色を白黒にする

skinparam sequenceLifeLineBorderColor                black
skinparam stateArrowColor                            black
skinparam sequenceParticipantBackgroundColor         white
skinparam sequenceParticipantBorderColor             black

MarkDown

# テスト文書

```plantuml
Bob -> Alice : hello
Alice -> Bob : Go Away
```

連携

plantuml-mode

;---- plantuml ----
(when (locate-library "plantuml-mode")
  (require 'plantuml-mode)
  (setq plantuml-jar-path "C:/path/to/plantuml.jar")
  (setq auto-mode-alist
        (append '(
                  ("\\.pu$" . plantuml-mode)
                  ("\\.puml$" . plantuml-mode)
                  ) auto-mode-alist))
  )

PlantUML Server

参考

ホーム | 文書トップ | 目次
Created by Emacs 26.2 (Org mode 9.1.9)