Antの
build.xml
ファイルに、次のような内容を書く必要があります:
<project name="OwnTaskExample" default="main" basedir=".">
<!-- task definition -->
<taskdef name="plantuml" classname="net.sourceforge.plantuml.ant.PlantUmlTask" classpath="plantuml.jar" />
<!-- process ./src files -->
<target name="main">
<plantuml dir="./src" />
</target>
</project>
この
Antタスクは、与えられたディレクトリ(この例では
./src
)にある、すべての
.c、
.h、
.cpp、
.tex、
.html、
.htm、
.javaファイルから、
@startXYZ
を探して
.png
画像を生成します。
output
タグを使って、すべての生成された画像の出力先ディレクトリを指定することもできます。
<!-- Put images in c:/images directory -->
<target name="main">
<plantuml dir="./src" output="c:/images" />
</target>
Ant標準の
fileset や
filelistを使うこともできます。
例えば、
c:/src
とサブディレクトリに対して、
Test.java
で終わるファイルを除いて処理を行い、画像を
d:/images
に出力する場合、次のようにします:
<target name="main">
<plantuml output="d:/images" >
<fileset dir="c:/src">
<include name="**/*.java" />
<exclude name="**/*Test.java" />
</fileset>
</plantuml>
</target>
Antタスクの定義で
format="svg"
または
format="eps"
を使うことができます。
<target name="main">
<plantuml dir="./src" format="svg" />
</target>
設定ファイルを指定すると、それぞれの図の前にインクルードされます。
<target name="main">
<plantuml dir="./src" config="./config.cfg" />
</target>
パラメータ | デフォルト | 説明 |
nbthread | 1 | 処理を行うスレッド数 |
graphvizDot | | dot実行可能ファイルのパス |
format | png | 生成する画像の形式:xmi, xmi:argo, xmi:start, eps, svg, txt, utxt |
verbose | false | true で、詳細なログを出力 |
config | | すべての図の前にインクルードされる設定ファイル |
charset | | ファイル読み込み時に使用する文字コード |
output | | 生成した画像を出力するディレクトリ |
dir | | 処理対象の入力ディレクトリ(代わりに<fileset>/<filelist> を使うこともできます) |
failonerror | false | true で、文法エラー発生時に処理を停止する |
checkonly | false | true で、画像を生成せずにファイルの文法チェックのみを行う |
overwrite | false | true で、読み込み専用のファイルを上書きする |
enablestats | false | true で、統計情報を有効化する |
htmlstats | false | true で、統計情報をplantuml-stats.htmlに出力する |
xmlstats | false | true で、統計情報をplantuml-stats.xmlに出力する |
realtimestats | false | true で、統計情報を処理終了時ではなく、リアルタイムに生成する |