Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    View page history    Add new chapter    Reorder page    Raw


Antタスクを書く

Writing an Ant Task

Antbuild.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画像を生成します。
You must have something like this into your Ant build.xml file:

<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>

The Ant task processes all .c, .h, .cpp, .tex, .html, .htm or .java of the provided directory (./src in this example). It looks for @startXYZ and generates .png images.

出力ディレクトリ

Output Directory

outputタグを使って、すべての生成された画像の出力先ディレクトリを指定することもできます。

<!-- Put images in c:/images directory -->
<target name="main">
<plantuml dir="./src" output="c:/images" />
</target>

You can also specify a output directory for all generated images, using output tag.

<!-- Put images in c:/images directory -->
<target name="main">
<plantuml dir="./src" output="c:/images" />
</target>

ディレクトリを再帰的に処理する

Recurse through directories

Ant標準のfilesetfilelistを使うこともできます。

例えば、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>

You can also use Ant standard fileset or filelist.

For example, if you want to process all java file in c:/src and subdirectories, (except files ending by Test.java), and generate images into d:/images, you can use:

<target name="main">
<plantuml output="d:/images" >
<fileset dir="c:/src">
<include name="**/*.java" />
<exclude name="**/*Test.java" />
</fileset>
</plantuml>
</target>

SVG、EPSのサポート

SVG or EPS Support

Antタスクの定義でformat="svg"またはformat="eps"を使うことができます。

<target name="main">
<plantuml dir="./src" format="svg" />
</target>

You can also use format="svg" or format="eps" in the Ant task definition.

<target name="main">
<plantuml dir="./src" format="svg" />
</target>

設定ファイル

Configuration file

設定ファイルを指定すると、それぞれの図の前にインクルードされます。

<target name="main">
<plantuml dir="./src" config="./config.cfg" />
</target>

You can also provide a configuration file which will be included before each diagram.

<target name="main">
<plantuml dir="./src" config="./config.cfg" />
</target>

その他のパラメータ

Other parameters

パラメータ デフォルト 説明
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で、統計情報を処理終了時ではなく、リアルタイムに生成する

Parameter Default Description
nbthread 1 Number of thread for processing
graphvizDot Path of the dot executable
format png Format for image generation: xmi, xmi:argo, xmi:start, eps, svg, txt, utxt
verbose false true for more logs
config File config to include before all diagrams
charset Charset to use when reading files
output Output directory for generated images
dir Input directory to process (You can use <fileset>/<filelist> instead)
failonerror false true to fail the build if some syntax error occurs
checkonly false true if you want to only check the syntax of files without generating images
overwrite false true if you want overwrite read-only files
enablestats false true to enable statistics
htmlstats false true to output general statistics in file plantuml-stats.html
xmlstats false true to output general statistics in file plantuml-stats.xml
realtimestats false true to generate statistics on the fly rather than at the end


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.