seqdiag の概要

機能

  • テキストファイルからシーケンス図を生成

  • 日本語(UTF-8)対応

  • Sphinx 文書への埋め込み (sphinxcontrib-seqdiag パッケージの利用)

インストール

Install with pip:

$ pip install seqdiag

Or with easy_install:

$ easy_install seqdiag

Copy and modify ini file. example

$ cp <seqdiag installed path>/seqdiag/examples/simple.diag .
$ vi simple.diag

書式の詳細については Sample diagrams を参照してください。

実行方法

コマンドラインで seqdiag コマンドを実行します。

$ seqdiag simple.diag
$ ls simple.png
simple.png

SVG 形式で出力したい場合は -T オプションを利用します。

$ seqdiag -Tsvg simple.diag
$ ls simple.svg
simple.svg

フォント設定

seqdiag は文字の描画に TrueType フォントを利用します。指定がない場合 seqdiag は自動的にフォントを検索しますが、見つからない場合もしくはフォントを指定したい場合は -f (–font) オプションを利用します。

$ seqdiag -f /usr/share/fonts/truetype/ttf-dejavu/DejaVuSerif.ttf simple.diag

もし常に同じ設定を利用する場合は $HOME/.blockdiagrc に以下の記述をするとよいでしょう。

$ cat $HOME/.blockdiagrc
[seqdiag]
fontpath = /usr/share/fonts/truetype/ttf-dejavu/DejaVuSerif.ttf

事前に入れておくべきソフトウェア

  • Python 2.6, 2.7, 3.2 および 3.3 以降

  • Pillow 2.2.1 以降

  • funcparserlib 0.3.6 以降

  • setuptools もしくは distribute

ライセンス

Apache License 2.0